crypto/kzg4844: update docs

Author: MariusVanDerWijden

crypto/kzg4844/kzg4844.go

@@ -149,6 +149,17 @@ func VerifyBlobProof(blob *Blob, commitment Commitment, proof Proof) error {
 	return gokzgVerifyBlobProof(blob, commitment, proof)
 }
 
+// ComputeCells returns the KZG cell proofs that are used to verify the blob against
+// the commitment.
+//
+// This method does not verify that the commitment is correct with respect to blob.
+func ComputeCells(blob *Blob) ([]Proof, error) {
+	if useCKZG.Load() {
+		return ckzgComputeCells(blob)
+	}
+	return gokzgComputeCells(blob)
+}
+
 // CalcBlobHashV1 calculates the 'versioned blob hash' of a commitment.
 // The given hasher must be a sha256 hash instance, otherwise the result will be invalid!
 func CalcBlobHashV1(hasher hash.Hash, commit *Commitment) (vh [32]byte) {
@@ -166,10 +177,3 @@ func CalcBlobHashV1(hasher hash.Hash, commit *Commitment) (vh [32]byte) {
 func IsValidVersionedHash(h []byte) bool {
 	return len(h) == 32 && h[0] == 0x01
 }
-
-func ComputeCells(blob *Blob) ([]Proof, error) {
-	if useCKZG.Load() {
-		return ckzgComputeCells(blob)
-	}
-	return gokzgComputeCells(blob)
-}

crypto/kzg4844/kzg4844_ckzg_cgo.go

@@ -132,6 +132,10 @@ func ckzgVerifyBlobProof(blob *Blob, commitment Commitment, proof Proof) error {
 	return nil
 }
 
+// ckzgComputeCells returns the KZG cell proofs that are used to verify the blob against
+// the commitment.
+//
+// This method does not verify that the commitment is correct with respect to blob.
 func ckzgComputeCells(blob *Blob) ([]Proof, error) {
 	ckzgIniter.Do(ckzgInit)
 

crypto/kzg4844/kzg4844_ckzg_nocgo.go

@@ -61,7 +61,10 @@ func ckzgVerifyBlobProof(blob *Blob, commitment Commitment, proof Proof) error {
 	panic("unsupported platform")
 }
 
-// ckzgComputeCells.
+// ckzgComputeCells returns the KZG cell proofs that are used to verify the blob against
+// the commitment.
+//
+// This method does not verify that the commitment is correct with respect to blob.
 func ckzgComputeCells(blob *Blob) ([]Proof, error) {
 	panic("unsupported platform")
 }

crypto/kzg4844/kzg4844_gokzg.go

@@ -97,6 +97,10 @@ func gokzgVerifyBlobProof(blob *Blob, commitment Commitment, proof Proof) error
 	return context.VerifyBlobKZGProof((*gokzg4844.Blob)(blob), (gokzg4844.KZGCommitment)(commitment), (gokzg4844.KZGProof)(proof))
 }
 
+// gokzgComputeCells returns the KZG cell proofs that are used to verify the blob against
+// the commitment.
+//
+// This method does not verify that the commitment is correct with respect to blob.
 func gokzgComputeCells(blob *Blob) ([]Proof, error) {
 	gokzgIniter.Do(gokzgInit)