@aztec/blob-lib 0.0.0-test.1 → 0.0.1-commit.0b941701

package/src/blob.ts

@@ -1,257 +1,173 @@
-import { poseidon2Hash, sha256 } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { FIELDS_PER_BLOB } from '@aztec/constants';
+import { BLS12Fr } from '@aztec/foundation/curves/bls12';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
-// Importing directly from 'c-kzg' does not work, ignoring import/no-named-as-default-member err:
-import cKzg from 'c-kzg';
-import type { Blob as BlobBuffer } from 'c-kzg';
-
-import { deserializeEncodedBlobToFields, extractBlobFieldsFromBuffer } from './encoding.js';
-import { BlobDeserializationError } from './errors.js';
+import { computeBlobCommitment, computeChallengeZ, computeEthVersionedBlobHash } from './hash.js';
 import type { BlobJson } from './interface.js';
+import { BYTES_PER_BLOB, BYTES_PER_COMMITMENT, getKzg } from './kzg_context.js';
 
-/* eslint-disable import/no-named-as-default-member */
-const { BYTES_PER_BLOB, FIELD_ELEMENTS_PER_BLOB, blobToKzgCommitment, computeKzgProof, verifyKzgProof } = cKzg;
-
-// The prefix to the EVM blobHash, defined here: https://eips.ethereum.org/EIPS/eip-4844#specification
-export const VERSIONED_HASH_VERSION_KZG = 0x01;
+export { FIELDS_PER_BLOB };
 
 /**
  * A class to create, manage, and prove EVM blobs.
+ *
+ * @dev Note: All methods in this class do not check the encoding of the given data. It's the responsibility of other
+ * components to ensure that the blob data (which might spread across multiple blobs) was created following the protocol
+ * and is correctly encoded.
  */
 export class Blob {
   constructor(
-    /** The blob to be broadcast on L1 in bytes form. */
-    public readonly data: BlobBuffer,
-    /** The hash of all tx effects inside the blob. Used in generating the challenge z and proving that we have included all required effects. */
-    public readonly fieldsHash: Fr,
-    /** Challenge point z (= H(H(tx_effects), kzgCommmitment). Used such that p(z) = y. */
-    public readonly challengeZ: Fr,
-    /** Evaluation y = p(z), where p() is the blob polynomial. BLS12 field element, rep. as BigNum in nr, bigint in ts. */
-    public readonly evaluationY: Buffer,
-    /** Commitment to the blob C. Used in compressed BLS12 point format (48 bytes). */
+    /**
+     * The data to be broadcast on L1 in bytes form.
+     */
+    public readonly data: Uint8Array,
+    /**
+     * Commitment to the blob data. Used in compressed BLS12 point format (48 bytes).
+     */
     public readonly commitment: Buffer,
-    /** KZG opening proof for y = p(z). The commitment to quotient polynomial Q, used in compressed BLS12 point format (48 bytes). */
-    public readonly proof: Buffer,
-  ) {}
+  ) {
+    if (data.length !== BYTES_PER_BLOB) {
+      throw new Error(`Blob data must be ${BYTES_PER_BLOB} bytes. Got ${data.length}.`);
+    }
+    if (commitment.length !== BYTES_PER_COMMITMENT) {
+      throw new Error(`Blob commitment must be ${BYTES_PER_COMMITMENT} bytes. Got ${commitment.length}.`);
+    }
+  }
 
   /**
-   * The encoded version of the blob will determine the end of the blob based on the transaction encoding.
-   * This is required when the fieldsHash of a blob will contain trailing zeros.
-   *
-   * See `./encoding.ts` for more details.
-   *
-   * This method is used to create a Blob from a buffer.
-   * @param blob - The buffer to create the Blob from.
-   * @param multiBlobFieldsHash - The fields hash to use for the Blob.
+   * Create a Blob from a buffer.
+   * @param data - The buffer of the Blob.
    * @returns A Blob created from the buffer.
    *
-   * @throws If unable to deserialize the blob.
+   * @throws If data does not match the expected length (BYTES_PER_BLOB).
    */
-  static fromEncodedBlobBuffer(blob: BlobBuffer, multiBlobFieldsHash?: Fr): Promise<Blob> {
-    try {
-      const fields: Fr[] = deserializeEncodedBlobToFields(blob);
-      return Blob.fromFields(fields, multiBlobFieldsHash);
-    } catch (err) {
-      throw new BlobDeserializationError(
-        `Failed to create Blob from encoded blob buffer, this blob was likely not created by us`,
-      );
-    }
+  static fromBlobBuffer(data: Uint8Array): Blob {
+    const commitment = computeBlobCommitment(data);
+    return new Blob(data, commitment);
   }
 
   /**
    * Create a Blob from an array of fields.
    *
+   * @dev This method pads 0s to the data, extending it to the size of a full blob.
+   *
    * @param fields - The array of fields to create the Blob from.
-   * @param multiBlobFieldsHash - The fields hash to use for the Blob.
    * @returns A Blob created from the array of fields.
    */
-  static async fromFields(fields: Fr[], multiBlobFieldsHash?: Fr): Promise<Blob> {
-    if (fields.length > FIELD_ELEMENTS_PER_BLOB) {
-      throw new Error(
-        `Attempted to overfill blob with ${fields.length} elements. The maximum is ${FIELD_ELEMENTS_PER_BLOB}`,
-      );
+  static fromFields(fields: Fr[]): Blob {
+    if (fields.length > FIELDS_PER_BLOB) {
+      throw new Error(`Attempted to overfill blob with ${fields.length} fields. The maximum is ${FIELDS_PER_BLOB}.`);
     }
 
     const data = Buffer.concat([serializeToBuffer(fields)], BYTES_PER_BLOB);
+    const commitment = computeBlobCommitment(data);
+    return new Blob(data, commitment);
+  }
 
-    // This matches the output of SpongeBlob.squeeze() in the blob circuit
-    const fieldsHash = multiBlobFieldsHash ? multiBlobFieldsHash : await poseidon2Hash(fields);
-    const commitment = Buffer.from(blobToKzgCommitment(data));
-    const challengeZ = await poseidon2Hash([fieldsHash, ...commitmentToFields(commitment)]);
-    const res = computeKzgProof(data, challengeZ.toBuffer());
-    if (!verifyKzgProof(commitment, challengeZ.toBuffer(), res[1], res[0])) {
-      throw new Error(`KZG proof did not verify.`);
-    }
-    const proof = Buffer.from(res[0]);
-    const evaluationY = Buffer.from(res[1]);
-
-    return new Blob(data, fieldsHash, challengeZ, evaluationY, commitment, proof);
+  /**
+   * Get the fields from the blob data.
+   *
+   * @dev WARNING: this method returns all fields
+   *
+   * @returns The fields from the blob.
+   */
+  toFields(): Fr[] {
+    const reader = BufferReader.asReader(this.data);
+    const numTotalFields = this.data.length / Fr.SIZE_IN_BYTES;
+    return reader.readArray(numTotalFields, Fr);
   }
 
   /**
    * Create a Blob from a JSON object.
    *
-   * Blobs will be in this form when requested from the blob sink, or from
+   * Blobs will be in this form when requested from the blob client, or from
    * the beacon chain via `getBlobSidecars`
    * https://ethereum.github.io/beacon-APIs/?urls.primaryName=dev#/Beacon/getBlobSidecars
    *
-   * @dev WARNING: by default json deals with encoded buffers
-   *
    * @param json - The JSON object to create the Blob from.
    * @returns A Blob created from the JSON object.
    */
-  static async fromJson(json: BlobJson): Promise<Blob> {
+  static fromJson(json: BlobJson): Blob {
     const blobBuffer = Buffer.from(json.blob.slice(2), 'hex');
-
-    const blob = await Blob.fromEncodedBlobBuffer(blobBuffer);
+    const blob = Blob.fromBlobBuffer(blobBuffer);
 
     if (blob.commitment.toString('hex') !== json.kzg_commitment.slice(2)) {
       throw new Error('KZG commitment does not match');
     }
 
-    // We do not check the proof, as it will be different if the challenge is shared
-    // across multiple blobs
-
     return blob;
   }
 
   /**
    * Get the JSON representation of the blob.
    *
-   * @dev WARNING: by default json deals with encoded buffers
-   * @param index - optional - The index of the blob in the block.
    * @returns The JSON representation of the blob.
    */
-  toJson(index?: number): BlobJson {
+  toJSON(): BlobJson {
     return {
       blob: `0x${Buffer.from(this.data).toString('hex')}`,
-      index,
       // eslint-disable-next-line camelcase
       kzg_commitment: `0x${this.commitment.toString('hex')}`,
-      // eslint-disable-next-line camelcase
-      kzg_proof: `0x${this.proof.toString('hex')}`,
     };
   }
 
-  /**
-   * Get the fields from the blob.
-   *
-   * @dev WARNING: this method does not take into account trailing zeros
-   *
-   * @returns The fields from the blob.
-   */
-  toFields(): Fr[] {
-    return extractBlobFieldsFromBuffer(this.data);
+  getEthVersionedBlobHash(): Buffer {
+    return computeEthVersionedBlobHash(this.commitment);
   }
 
   /**
-   * Get the encoded fields from the blob.
-   *
-   * @dev This method takes into account trailing zeros
-   *
-   * @returns The encoded fields from the blob.
-   *
-   * @throws If unable to deserialize the blob.
+   * Challenge point z (= H(H(tx_effects), kzgCommitment)).
+   * Used such that p(z) = y for a single blob, used as z_i in batching (see ./blob_batching.ts).
    */
-  toEncodedFields(): Fr[] {
-    try {
-      return deserializeEncodedBlobToFields(this.data);
-    } catch (err) {
-      throw new BlobDeserializationError(
-        `Failed to deserialize encoded blob fields, this blob was likely not created by us`,
-      );
-    }
+  async computeChallengeZ(blobFieldsHash: Fr): Promise<Fr> {
+    return await computeChallengeZ(blobFieldsHash, this.commitment);
   }
 
   /**
-   * Get the encoded fields from multiple blobs.
+   * Evaluate the blob at a given challenge and return the evaluation and KZG proof.
    *
-   * @dev This method takes into account trailing zeros
+   * @param challengeZ - The challenge z at which to evaluate the blob.
+   * @param verifyProof - Whether to verify the KZG proof.
    *
-   * @returns The encoded fields from the blobs.
+   * @returns
+   *  y: BLS12Fr -  Evaluation y = p(z), where p() is the blob polynomial. BLS12 field element, rep. as BigNum in nr, bigint in ts.
+   *  proof: Buffer - KZG opening proof for y = p(z). The commitment to quotient polynomial Q, used in compressed BLS12 point format (48 bytes).
    */
-  static toEncodedFields(blobs: Blob[]): Fr[] {
-    try {
-      return deserializeEncodedBlobToFields(Buffer.concat(blobs.map(b => b.data)));
-    } catch (err) {
-      throw new BlobDeserializationError(
-        `Failed to deserialize encoded blob fields, this blob was likely not created by us`,
-      );
+  evaluate(challengeZ: Fr, verifyProof = false) {
+    const kzg = getKzg();
+    const res = kzg.computeKzgProof(this.data, challengeZ.toBuffer());
+    if (verifyProof && !kzg.verifyKzgProof(this.commitment, challengeZ.toBuffer(), res[1], res[0])) {
+      throw new Error(`KZG proof did not verify.`);
     }
-  }
-
-  /**
-   * Get the commitment fields from the blob.
-   *
-   * The 48-byte commitment is encoded into two field elements:
-   * +------------------+------------------+
-   * | Field Element 1  | Field Element 2  |
-   * | [bytes 0-31]     | [bytes 32-47]   |
-   * +------------------+------------------+
-   * |     32 bytes     |     16 bytes    |
-   * +------------------+------------------+
-   * @returns The commitment fields from the blob.
-   */
-  commitmentToFields(): [Fr, Fr] {
-    return commitmentToFields(this.commitment);
-  }
-
-  // Returns ethereum's versioned blob hash, following kzg_to_versioned_hash: https://eips.ethereum.org/EIPS/eip-4844#helpers
-  getEthVersionedBlobHash(): Buffer {
-    const hash = sha256(this.commitment);
-    hash[0] = VERSIONED_HASH_VERSION_KZG;
-    return hash;
-  }
 
-  static getEthVersionedBlobHash(commitment: Buffer): Buffer {
-    const hash = sha256(commitment);
-    hash[0] = VERSIONED_HASH_VERSION_KZG;
-    return hash;
+    const proof = Buffer.from(res[0]);
+    const y = BLS12Fr.fromBuffer(Buffer.from(res[1]));
+    return { y, proof };
   }
 
   /**
    * Get the buffer representation of the ENTIRE blob.
    *
-   * @dev WARNING: this buffer contains all metadata aswell as the data itself
+   * @dev WARNING: this buffer contains all metadata as well as the data itself.
    *
    * @returns The buffer representation of the blob.
    */
   toBuffer(): Buffer {
-    return Buffer.from(
-      serializeToBuffer(
-        this.data.length,
-        this.data,
-        this.fieldsHash,
-        this.challengeZ,
-        this.evaluationY.length,
-        this.evaluationY,
-        this.commitment.length,
-        this.commitment,
-        this.proof.length,
-        this.proof,
-      ),
-    );
+    return Buffer.from(serializeToBuffer(this.data.length, this.data, this.commitment.length, this.commitment));
   }
 
   /**
    * Create a Blob from a buffer.
    *
-   * @dev WARNING: this method contains all metadata aswell as the data itself
+   * @dev WARNING: this method contains all metadata as well as the data itself.
    *
    * @param buf - The buffer to create the Blob from.
    * @returns A Blob created from the buffer.
    */
   static fromBuffer(buf: Buffer | BufferReader): Blob {
     const reader = BufferReader.asReader(buf);
-    return new Blob(
-      reader.readUint8Array(),
-      reader.readObject(Fr),
-      reader.readObject(Fr),
-      reader.readBuffer(),
-      reader.readBuffer(),
-      reader.readBuffer(),
-    );
+    return new Blob(reader.readUint8Array(), reader.readBuffer());
   }
 
   /**
@@ -261,69 +177,15 @@ export class Blob {
     return this.data.length;
   }
 
-  /**
-   * Returns a proof of opening of the blob to verify on L1 using the point evaluation precompile:
-   *
-   * input[:32]     - versioned_hash
-   * input[32:64]   - z
-   * input[64:96]   - y
-   * input[96:144]  - commitment C
-   * input[144:192] - proof (a commitment to the quotient polynomial q(X))
-   *
-   * See https://eips.ethereum.org/EIPS/eip-4844#point-evaluation-precompile
-   */
-  getEthBlobEvaluationInputs(): `0x${string}` {
-    const buf = Buffer.concat([
-      this.getEthVersionedBlobHash(),
-      this.challengeZ.toBuffer(),
-      this.evaluationY,
-      this.commitment,
-      this.proof,
-    ]);
-    return `0x${buf.toString('hex')}`;
-  }
-
-  static getEthBlobEvaluationInputs(blobs: Blob[]): `0x${string}` {
-    let buf = Buffer.alloc(0);
-    blobs.forEach(blob => {
-      buf = Buffer.concat([
-        buf,
-        blob.getEthVersionedBlobHash(),
-        blob.challengeZ.toBuffer(),
-        blob.evaluationY,
-        blob.commitment,
-        blob.proof,
-      ]);
-    });
-    // For multiple blobs, we prefix the number of blobs:
-    const lenBuf = Buffer.alloc(1);
-    lenBuf.writeUint8(blobs.length);
-    buf = Buffer.concat([lenBuf, buf]);
-    return `0x${buf.toString('hex')}`;
-  }
-
   static getViemKzgInstance() {
+    const kzg = getKzg();
     return {
-      blobToKzgCommitment: cKzg.blobToKzgCommitment,
-      computeBlobKzgProof: cKzg.computeBlobKzgProof,
+      blobToKzgCommitment: kzg.blobToKzgCommitment.bind(kzg),
+      computeBlobKzgProof: kzg.computeBlobKzgProof.bind(kzg),
+      computeCellsAndKzgProofs: (b: Uint8Array): [Uint8Array[], Uint8Array[]] => {
+        const result = kzg.computeCellsAndKzgProofs(b);
+        return [result.cells, result.proofs];
+      },
     };
   }
-
-  // Returns as many blobs as we require to broadcast the given fields
-  // Assumes we share the fields hash between all blobs
-  static async getBlobs(fields: Fr[]): Promise<Blob[]> {
-    const numBlobs = Math.max(Math.ceil(fields.length / FIELD_ELEMENTS_PER_BLOB), 1);
-    const multiBlobFieldsHash = await poseidon2Hash(fields);
-    const res = [];
-    for (let i = 0; i < numBlobs; i++) {
-      const end = fields.length < (i + 1) * FIELD_ELEMENTS_PER_BLOB ? fields.length : (i + 1) * FIELD_ELEMENTS_PER_BLOB;
-      res.push(await Blob.fromFields(fields.slice(i * FIELD_ELEMENTS_PER_BLOB, end), multiBlobFieldsHash));
-    }
-    return res;
-  }
-}
-
-// 48 bytes encoded in fields as [Fr, Fr] = [0->31, 31->48]
-function commitmentToFields(commitment: Buffer): [Fr, Fr] {
-  return [new Fr(commitment.subarray(0, 31)), new Fr(commitment.subarray(31, 48))];
 }