-
Notifications
You must be signed in to change notification settings - Fork 962
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Encapsulate all kzg functionality for PeerDAS into the kzg pac…
…kage (#14136) * chore: move all ckzg related functionality into kzg package * refactor code to match * run: bazel run //:gazelle -- fix * chore: add some docs and stop copying large objects when converting between types * fixes * manually add kzg.go dep to Build.Hazel * move kzg methods to kzg.go * chore: add RecoverCellsAndProofs method * bazel run //:gazelle -- fix * use BytesPerBlob constant * chore: fix some deepsource issues * one declaration for commans and blobs
- Loading branch information
1 parent
913e84d
commit b8f43c0
Showing
12 changed files
with
220 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| package kzg | ||
|
|
||
| import ( | ||
| "errors" | ||
|
|
||
| ckzg4844 "github.com/ethereum/c-kzg-4844/bindings/go" | ||
| "github.com/ethereum/go-ethereum/crypto/kzg4844" | ||
| ) | ||
|
|
||
| // Blob represents a serialized chunk of data. | ||
| type Blob [BytesPerBlob]byte | ||
|
|
||
| // Commitment represent a KZG commitment to a Blob. | ||
| type Commitment [48]byte | ||
|
|
||
| // Proof represents a KZG proof that attests to the validity of a Blob or parts of it. | ||
| type Proof [48]byte | ||
|
|
||
| // Bytes48 is a 48-byte array. | ||
| type Bytes48 = ckzg4844.Bytes48 | ||
|
|
||
| // Bytes32 is a 32-byte array. | ||
| type Bytes32 = ckzg4844.Bytes32 | ||
|
|
||
| // BytesPerCell is the number of bytes in a single cell. | ||
| const BytesPerCell = ckzg4844.FieldElementsPerCell * ckzg4844.BytesPerFieldElement | ||
|
|
||
| // BytesPerBlob is the number of bytes in a single blob. | ||
| const BytesPerBlob = ckzg4844.BytesPerBlob | ||
|
|
||
| // FieldElementsPerCell is the number of field elements in a single cell. | ||
| // TODO: This should not be exposed. | ||
| const FieldElementsPerCell = ckzg4844.FieldElementsPerCell | ||
|
|
||
| // CellsPerExtBlob is the number of cells that we generate for a single blob. | ||
| // This is equivalent to the number of columns in the data matrix. | ||
| const CellsPerExtBlob = ckzg4844.CellsPerExtBlob | ||
|
|
||
| // Cell represents a chunk of an encoded Blob. | ||
| // TODO: This is not correctly sized in c-kzg | ||
| // TODO: It should be a vector of bytes | ||
| // TODO: Note that callers of this package rely on `BytesPerCell` | ||
| type Cell ckzg4844.Cell | ||
|
|
||
| func BlobToKZGCommitment(blob *Blob) (Commitment, error) { | ||
| comm, err := kzg4844.BlobToCommitment(kzg4844.Blob(*blob)) | ||
| if err != nil { | ||
| return Commitment{}, err | ||
| } | ||
| return Commitment(comm), nil | ||
| } | ||
|
|
||
| func ComputeBlobKZGProof(blob *Blob, commitment Commitment) (Proof, error) { | ||
| proof, err := kzg4844.ComputeBlobProof(kzg4844.Blob(*blob), kzg4844.Commitment(commitment)) | ||
| if err != nil { | ||
| return [48]byte{}, err | ||
| } | ||
| return Proof(proof), nil | ||
| } | ||
|
|
||
| func ComputeCellsAndKZGProofs(blob *Blob) ([ckzg4844.CellsPerExtBlob]Cell, [ckzg4844.CellsPerExtBlob]Proof, error) { | ||
| ckzgBlob := ckzg4844.Blob(*blob) | ||
| _cells, _proofs, err := ckzg4844.ComputeCellsAndKZGProofs(&ckzgBlob) | ||
| if err != nil { | ||
| return [ckzg4844.CellsPerExtBlob]Cell{}, [ckzg4844.CellsPerExtBlob]Proof{}, err | ||
| } | ||
|
|
||
| // Convert Cells and Proofs to types defined in this package | ||
| var cells [ckzg4844.CellsPerExtBlob]Cell | ||
| for i := range _cells { | ||
| cells[i] = Cell(_cells[i]) | ||
| } | ||
|
|
||
| var proofs [ckzg4844.CellsPerExtBlob]Proof | ||
| for i := range _proofs { | ||
| proofs[i] = Proof(_proofs[i]) | ||
| } | ||
|
|
||
| return cells, proofs, nil | ||
| } | ||
|
|
||
| // VerifyCellKZGProof is unused. TODO: We can check when the batch size for `VerifyCellKZGProofBatch` is 1 | ||
| // and call this, though I think its better if the cryptography library handles this. | ||
| func VerifyCellKZGProof(commitmentBytes Bytes48, cellId uint64, cell *Cell, proofBytes Bytes48) (bool, error) { | ||
| return ckzg4844.VerifyCellKZGProof(commitmentBytes, cellId, ckzg4844.Cell(*cell), proofBytes) | ||
| } | ||
|
|
||
| func VerifyCellKZGProofBatch(commitmentsBytes []Bytes48, rowIndices, columnIndices []uint64, _cells []Cell, proofsBytes []Bytes48) (bool, error) { | ||
| // Convert `Cell` type to `ckzg4844.Cell` | ||
| ckzgCells := make([]ckzg4844.Cell, len(_cells)) | ||
| for i := range _cells { | ||
| ckzgCells[i] = ckzg4844.Cell(_cells[i]) | ||
| } | ||
|
|
||
| return ckzg4844.VerifyCellKZGProofBatch(commitmentsBytes, rowIndices, columnIndices, ckzgCells, proofsBytes) | ||
| } | ||
|
|
||
| func RecoverAllCells(cellIds []uint64, _cells []Cell) ([ckzg4844.CellsPerExtBlob]Cell, error) { | ||
| // Convert `Cell` type to `ckzg4844.Cell` | ||
| ckzgCells := make([]ckzg4844.Cell, len(_cells)) | ||
| for i := range _cells { | ||
| ckzgCells[i] = ckzg4844.Cell(_cells[i]) | ||
| } | ||
|
|
||
| recoveredCells, err := ckzg4844.RecoverAllCells(cellIds, ckzgCells) | ||
| if err != nil { | ||
| return [ckzg4844.CellsPerExtBlob]Cell{}, err | ||
| } | ||
|
|
||
| // This should never happen, we return an error instead of panicking. | ||
| if len(recoveredCells) != ckzg4844.CellsPerExtBlob { | ||
| return [ckzg4844.CellsPerExtBlob]Cell{}, errors.New("recovered cells length is not equal to CellsPerExtBlob") | ||
| } | ||
|
|
||
| // Convert `ckzg4844.Cell` type to `Cell` | ||
| var ret [ckzg4844.CellsPerExtBlob]Cell | ||
| for i := range recoveredCells { | ||
| ret[i] = Cell(recoveredCells[i]) | ||
| } | ||
| return ret, nil | ||
| } | ||
|
|
||
| // RecoverCellsAndKZGProofs recovers the cells and compute the KZG Proofs associated with the cells. | ||
| // | ||
| // This method will supersede the `RecoverAllCells` and `CellsToBlob` methods. | ||
| func RecoverCellsAndKZGProofs(cellIds []uint64, _cells []Cell) ([ckzg4844.CellsPerExtBlob]Cell, [ckzg4844.CellsPerExtBlob]Proof, error) { | ||
| // First recover all of the cells | ||
| recoveredCells, err := RecoverAllCells(cellIds, _cells) | ||
| if err != nil { | ||
| return [ckzg4844.CellsPerExtBlob]Cell{}, [ckzg4844.CellsPerExtBlob]Proof{}, err | ||
| } | ||
|
|
||
| // Extract the Blob from all of the Cells | ||
| blob, err := CellsToBlob(&recoveredCells) | ||
| if err != nil { | ||
| return [ckzg4844.CellsPerExtBlob]Cell{}, [ckzg4844.CellsPerExtBlob]Proof{}, err | ||
| } | ||
|
|
||
| // Compute all of the cells and KZG proofs | ||
| return ComputeCellsAndKZGProofs(&blob) | ||
| } | ||
|
|
||
| func CellsToBlob(_cells *[ckzg4844.CellsPerExtBlob]Cell) (Blob, error) { | ||
| // Convert `Cell` type to `ckzg4844.Cell` | ||
| var ckzgCells [ckzg4844.CellsPerExtBlob]ckzg4844.Cell | ||
| for i := range _cells { | ||
| ckzgCells[i] = ckzg4844.Cell(_cells[i]) | ||
| } | ||
|
|
||
| blob, err := ckzg4844.CellsToBlob(ckzgCells) | ||
| if err != nil { | ||
| return Blob{}, err | ||
| } | ||
|
|
||
| return Blob(blob), nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.