@aztec/blob-lib 3.0.0-devnet.5 → 3.0.0-devnet.6-patch.1

package/src/kzg_context.ts

@@ -2,4 +2,15 @@ import { DasContextJs } from '@crate-crypto/node-eth-kzg';
 
 export * from '@crate-crypto/node-eth-kzg';
 
-export const kzg = DasContextJs.create({ usePrecomp: true });
+let kzgInstance: DasContextJs | undefined;
+
+/**
+ * Returns the lazily-initialized KZG context.
+ * The first call takes ~3 seconds to initialize the precomputation tables.
+ */
+export function getKzg(): DasContextJs {
+  if (!kzgInstance) {
+    kzgInstance = DasContextJs.create({ usePrecomp: true });
+  }
+  return kzgInstance;
+}

package/src/sponge_blob.ts

@@ -1,7 +1,7 @@
-import { TWO_POW_64 } from '@aztec/constants';
+import { BLOBS_PER_CHECKPOINT, FIELDS_PER_BLOB, TWO_POW_64 } from '@aztec/constants';
 import { type FieldsOf, makeTuple } from '@aztec/foundation/array';
-import { poseidon2Permutation } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { poseidon2Permutation } from '@aztec/foundation/crypto/poseidon';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import {
   BufferReader,
   FieldReader,
@@ -15,18 +15,28 @@ import {
  * See noir-projects/noir-protocol-circuits/crates/types/src/abis/sponge_blob.nr.
  */
 export class SpongeBlob {
+  static MAX_FIELDS = BLOBS_PER_CHECKPOINT * FIELDS_PER_BLOB;
+
   constructor(
     /** Sponge with absorbed fields that will go into one or more blobs. */
     public readonly sponge: Poseidon2Sponge,
     /** Number of effects absorbed so far. */
     public numAbsorbedFields: number,
-    /** Number of effects that will be absorbed. */
-    public readonly numExpectedFields: number,
   ) {}
 
+  /**
+   * Initialize the sponge blob to absorb data for a checkpoint.
+   */
+  static init(): SpongeBlob {
+    // This must match the implementation in noir-projects/noir-protocol-circuits/types/src/abis/sponge_blob.nr
+    const iv = new Fr(BigInt(SpongeBlob.MAX_FIELDS) * TWO_POW_64);
+    const sponge = Poseidon2Sponge.init(iv);
+    return new SpongeBlob(sponge, 0);
+  }
+
   static fromBuffer(buffer: Buffer | BufferReader): SpongeBlob {
     const reader = BufferReader.asReader(buffer);
-    return new SpongeBlob(reader.readObject(Poseidon2Sponge), reader.readNumber(), reader.readNumber());
+    return new SpongeBlob(reader.readObject(Poseidon2Sponge), reader.readNumber());
   }
 
   toBuffer() {
@@ -34,7 +44,7 @@ export class SpongeBlob {
   }
 
   static getFields(fields: FieldsOf<SpongeBlob>) {
-    return [fields.sponge, fields.numAbsorbedFields, fields.numExpectedFields];
+    return [fields.sponge, fields.numAbsorbedFields];
   }
 
   toFields(): Fr[] {
@@ -43,11 +53,7 @@ export class SpongeBlob {
 
   static fromFields(fields: Fr[] | FieldReader): SpongeBlob {
     const reader = FieldReader.asReader(fields);
-    return new SpongeBlob(
-      reader.readObject(Poseidon2Sponge),
-      reader.readField().toNumber(),
-      reader.readField().toNumber(),
-    );
+    return new SpongeBlob(reader.readObject(Poseidon2Sponge), reader.readField().toNumber());
   }
 
   clone() {
@@ -55,9 +61,9 @@ export class SpongeBlob {
   }
 
   async absorb(fields: Fr[]) {
-    if (this.numAbsorbedFields + fields.length > this.numExpectedFields) {
+    if (this.numAbsorbedFields + fields.length > SpongeBlob.MAX_FIELDS) {
       throw new Error(
-        `Attempted to fill spongeBlob with ${this.numAbsorbedFields + fields.length}, but it has a max of ${this.numExpectedFields}`,
+        `Attempted to fill spongeBlob with ${this.numAbsorbedFields + fields.length}, but it has a max of ${SpongeBlob.MAX_FIELDS}`,
       );
     }
     await this.sponge.absorb(fields);
@@ -65,29 +71,11 @@ export class SpongeBlob {
   }
 
   async squeeze(): Promise<Fr> {
-    // If the blob sponge is not 'full', we append 1 to match Poseidon2::hash_internal()
-    // NB: There is currently no use case in which we don't 'fill' a blob sponge, but adding for completeness
-    if (this.numAbsorbedFields != this.numExpectedFields) {
-      await this.sponge.absorb([Fr.ONE]);
-    }
-    return this.sponge.squeeze();
+    return await this.sponge.squeeze();
   }
 
   static empty(): SpongeBlob {
-    return new SpongeBlob(Poseidon2Sponge.empty(), 0, 0);
-  }
-
-  /**
-   * Initialize the sponge blob with the number of expected fields in the checkpoint and absorb it as the first field.
-   * Note: `numExpectedFields` includes the first field absorbed in this method.
-   */
-  static async init(numExpectedFields: number): Promise<SpongeBlob> {
-    // This must match what the checkpoint root rollup circuit expects.
-    // See noir-projects/noir-protocol-circuits/types/src/abis/sponge_blob.nr -> init_for_checkpoint.
-    const sponge = Poseidon2Sponge.init(numExpectedFields);
-    await sponge.absorb([new Fr(numExpectedFields)]);
-    const numAbsorbedFields = 1;
-    return new SpongeBlob(sponge, numAbsorbedFields, numExpectedFields);
+    return new SpongeBlob(Poseidon2Sponge.empty(), 0);
   }
 }
 
@@ -141,8 +129,7 @@ export class Poseidon2Sponge {
     );
   }
 
-  static init(numExpectedFields: number): Poseidon2Sponge {
-    const iv = new Fr(numExpectedFields).mul(new Fr(TWO_POW_64));
+  static init(iv: Fr): Poseidon2Sponge {
     const sponge = Poseidon2Sponge.empty();
     sponge.state[3] = iv;
     return sponge;

package/src/testing.ts

@@ -1,15 +1,15 @@
-import { FIELDS_PER_BLOB } from '@aztec/constants';
 import { makeTuple } from '@aztec/foundation/array';
-import { randomInt } from '@aztec/foundation/crypto';
-import { BLS12Fr, BLS12Point, Fr } from '@aztec/foundation/fields';
+import { BLS12Fq, BLS12Fr, BLS12Point, BLSPointNotOnCurveError } from '@aztec/foundation/curves/bls12';
+import { Fr } from '@aztec/foundation/curves/bn254';
 
 import { Blob } from './blob.js';
-import { BatchedBlobAccumulator } from './blob_batching.js';
-import { getBlobsPerL1Block } from './blob_utils.js';
-import { FinalBlobBatchingChallenges } from './circuit_types/index.js';
-import { createBlockEndMarker, encodeTxStartMarker } from './encoding.js';
+import { BlobAccumulator } from './circuit_types/blob_accumulator.js';
+import { FinalBlobAccumulator } from './circuit_types/final_blob_accumulator.js';
+import { FinalBlobBatchingChallenges } from './circuit_types/final_blob_batching_challenges.js';
 import { Poseidon2Sponge, SpongeBlob } from './sponge_blob.js';
 
+export * from './encoding/fixtures.js';
+
 /**
  * Makes arbitrary poseidon sponge for blob inputs.
  * Note: will not verify inside the circuit.
@@ -25,87 +25,61 @@ export function makeSpongeBlob(seed = 1): SpongeBlob {
       false,
     ),
     seed,
-    seed + 1,
   );
 }
 
+/**
+ * Makes an arbitrary but valid BLS12 point. The value is deterministic for a given seed.
+ * @param seed - The seed to use for generating the point.
+ * @returns A BLS12 point instance.
+ */
+function makeBLS12Point(seed = 1): BLS12Point {
+  let accum = 0;
+  while (true) {
+    try {
+      const x = new BLS12Fq(seed + accum);
+      const y = BLS12Point.YFromX(x);
+      if (y) {
+        return new BLS12Point(x, y, false);
+      }
+      accum++;
+    } catch (e: any) {
+      if (!(e instanceof BLSPointNotOnCurveError)) {
+        throw e;
+      }
+      // The point is not on the curve - try again
+    }
+  }
+}
+
 /**
  * Makes arbitrary blob public accumulator.
  * Note: will not verify inside the circuit.
  * @param seed - The seed to use for generating the blob accumulator.
  * @returns A blob accumulator instance.
  */
-export function makeBatchedBlobAccumulator(seed = 1): BatchedBlobAccumulator {
-  return new BatchedBlobAccumulator(
+export function makeBlobAccumulator(seed = 1): BlobAccumulator {
+  return new BlobAccumulator(
     new Fr(seed),
-    new Fr(seed + 1),
-    new BLS12Fr(seed + 2),
-    BLS12Point.random(),
-    BLS12Point.random(),
-    new Fr(seed + 3),
-    new BLS12Fr(seed + 4),
-    new FinalBlobBatchingChallenges(new Fr(seed + 5), new BLS12Fr(seed + 6)),
+    new Fr(seed + 0x10),
+    new BLS12Fr(seed + 0x20),
+    makeBLS12Point(seed + 0x30),
+    new Fr(seed + 0x50),
+    new BLS12Fr(seed + 0x60),
   );
 }
 
-export function makeEncodedTxBlobFields(length: number): Fr[] {
-  const txStartMarker = {
-    numBlobFields: length,
-    // The rest of the values don't matter. The test components using it do not try to deserialize everything.
-    // Only `checkBlobFieldsEncoding` is used and it only looks at `numBlobFields`. This might change in the future
-    // when we add more thorough checks to `checkBlobFieldsEncoding`.
-    revertCode: 0,
-    numNoteHashes: 0,
-    numNullifiers: 0,
-    numL2ToL1Msgs: 0,
-    numPublicDataWrites: 0,
-    numPrivateLogs: 0,
-    publicLogsLength: 0,
-    contractClassLogLength: 0,
-  };
-
-  return [
-    encodeTxStartMarker(txStartMarker),
-    ...Array.from({ length: length - 1 }, () => new Fr(randomInt(Number.MAX_SAFE_INTEGER))), // -1 to account for the tx start marker.
-  ];
-}
-
-export function makeEncodedBlockBlobFields(...lengths: number[]): Fr[] {
-  return [
-    ...(lengths.length > 0 ? makeEncodedTxBlobFields(lengths[0] - 1) : []), // -1 to account for the block end marker.
-    ...lengths.slice(1).flatMap(length => makeEncodedTxBlobFields(length)),
-    createBlockEndMarker(lengths.length),
-  ];
-}
-
-// Create blob fields for a checkpoint with a single block.
-export function makeEncodedBlobFields(length: number): Fr[] {
-  if (length <= 2) {
-    throw new Error('Encoded blob fields length must be greater than 2');
-  }
-
-  const checkpointPrefix = new Fr(length);
-  return [checkpointPrefix, ...makeEncodedBlockBlobFields(length - 1)]; // -1 to account for the checkpoint prefix.
-}
-
-/**
- * Make an encoded blob with the given length
- *
- * This will deserialise correctly in the archiver
- * @param length
- * @returns
- */
-export function makeEncodedBlob(length: number): Blob {
-  if (length > FIELDS_PER_BLOB) {
-    throw new Error(`A single encoded blob must be less than ${FIELDS_PER_BLOB} fields`);
-  }
-
-  return Blob.fromFields(makeEncodedBlobFields(length));
+export function makeFinalBlobAccumulator(seed = 1) {
+  return new FinalBlobAccumulator(
+    new Fr(seed),
+    new Fr(seed + 0x10),
+    new BLS12Fr(seed + 0x20),
+    makeBLS12Point(seed + 0x30),
+  );
 }
 
-export function makeEncodedBlobs(length: number): Blob[] {
-  const fields = makeEncodedBlobFields(length);
-  return getBlobsPerL1Block(fields);
+export function makeFinalBlobBatchingChallenges(seed = 1) {
+  return new FinalBlobBatchingChallenges(new Fr(seed), new BLS12Fr(seed + 0x10));
 }
 
 /**

package/src/types.ts

@@ -1,3 +1,4 @@
+export * from './batched_blob.js';
 export * from './circuit_types/index.js';
 export * from './interface.js';
 export * from './sponge_blob.js';

package/dest/deserialize.d.ts

@@ -1,14 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-/**
- * Deserializes a buffer into an array of field elements.
- *
- * This function returns the fields that were actually added in a checkpoint. The number of fields is specified by the
- * first field.
- *
- * @param buf - The buffer to deserialize.
- * @param checkEncoding - Whether to check if the encoding is correct. If false, it will still check the checkpoint
- * prefix and throw if there's not enough fields.
- * @returns An array of field elements.
- */
-export declare function deserializeEncodedBlobToFields(buf: Uint8Array, checkEncoding?: boolean): Fr[];
-//# sourceMappingURL=deserialize.d.ts.map

package/dest/deserialize.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deserialize.d.ts","sourceRoot":"","sources":["../src/deserialize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAM9C;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,UAAQ,GAAG,EAAE,EAAE,CAoB3F"}

package/dest/deserialize.js

@@ -1,33 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
-import { checkBlobFieldsEncoding } from './encoding.js';
-import { BlobDeserializationError } from './errors.js';
-/**
- * Deserializes a buffer into an array of field elements.
- *
- * This function returns the fields that were actually added in a checkpoint. The number of fields is specified by the
- * first field.
- *
- * @param buf - The buffer to deserialize.
- * @param checkEncoding - Whether to check if the encoding is correct. If false, it will still check the checkpoint
- * prefix and throw if there's not enough fields.
- * @returns An array of field elements.
- */ export function deserializeEncodedBlobToFields(buf, checkEncoding = false) {
-    const reader = BufferReader.asReader(buf);
-    const firstField = reader.readObject(Fr);
-    // Use toBigInt instead of toNumber so that we can catch it and throw a more descriptive error below if the first
-    // field is larger than a javascript integer.
-    const numFields = firstField.toBigInt();
-    const totalFieldsInBuffer = BigInt(buf.length / Fr.SIZE_IN_BYTES);
-    if (numFields > totalFieldsInBuffer) {
-        throw new BlobDeserializationError(`Failed to deserialize blob fields, this blob was likely not created by us`);
-    }
-    const numFieldsWithoutPrefix = Number(numFields) - 1;
-    const blobFields = [
-        firstField
-    ].concat(reader.readArray(numFieldsWithoutPrefix, Fr));
-    if (checkEncoding && !checkBlobFieldsEncoding(blobFields)) {
-        throw new BlobDeserializationError(`Incorrect encoding of blob fields, this blob was likely not created by us`);
-    }
-    return blobFields;
-}

package/dest/encoding.d.ts

@@ -1,26 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-export interface TxStartMarker {
-    prefix: bigint;
-    numBlobFields: number;
-    revertCode: number;
-    numNoteHashes: number;
-    numNullifiers: number;
-    numL2ToL1Msgs: number;
-    numPublicDataWrites: number;
-    numPrivateLogs: number;
-    publicLogsLength: number;
-    contractClassLogLength: number;
-}
-export declare function encodeTxStartMarker(txStartMarker: Omit<TxStartMarker, 'prefix'>): Fr;
-export declare function decodeTxStartMarker(field: Fr): TxStartMarker;
-export declare function getNumBlobFieldsFromTxStartMarker(field: Fr): number;
-export declare function isValidTxStartMarker(txStartMarker: TxStartMarker): boolean;
-export declare function createBlockEndMarker(numTxs: number): Fr;
-export declare function getNumTxsFromBlockEndMarker(field: Fr): number;
-export declare function isBlockEndMarker(field: Fr): boolean;
-/**
- * Check that the fields are emitted from the circuits and conform to the encoding.
- * @param blobFields - The concatenated fields from all blobs of an L1 block.
- */
-export declare function checkBlobFieldsEncoding(blobFields: Fr[]): boolean;
-//# sourceMappingURL=encoding.d.ts.map

package/dest/encoding.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../src/encoding.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAa9C,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAGD,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,MAqB/E;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,EAAE,GAAG,aAAa,CAmC5D;AAED,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,EAAE,UAE1D;AAED,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,aAAa,WAEhE;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,MAGlD;AAED,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,EAAE,UAEpD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,EAAE,WAIzC;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,EAAE,EAAE,WAsCvD"}

package/src/deserialize.ts

@@ -1,38 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
-
-import { checkBlobFieldsEncoding } from './encoding.js';
-import { BlobDeserializationError } from './errors.js';
-
-/**
- * Deserializes a buffer into an array of field elements.
- *
- * This function returns the fields that were actually added in a checkpoint. The number of fields is specified by the
- * first field.
- *
- * @param buf - The buffer to deserialize.
- * @param checkEncoding - Whether to check if the encoding is correct. If false, it will still check the checkpoint
- * prefix and throw if there's not enough fields.
- * @returns An array of field elements.
- */
-export function deserializeEncodedBlobToFields(buf: Uint8Array, checkEncoding = false): Fr[] {
-  const reader = BufferReader.asReader(buf);
-  const firstField = reader.readObject(Fr);
-
-  // Use toBigInt instead of toNumber so that we can catch it and throw a more descriptive error below if the first
-  // field is larger than a javascript integer.
-  const numFields = firstField.toBigInt();
-  const totalFieldsInBuffer = BigInt(buf.length / Fr.SIZE_IN_BYTES);
-  if (numFields > totalFieldsInBuffer) {
-    throw new BlobDeserializationError(`Failed to deserialize blob fields, this blob was likely not created by us`);
-  }
-
-  const numFieldsWithoutPrefix = Number(numFields) - 1;
-  const blobFields = [firstField].concat(reader.readArray(numFieldsWithoutPrefix, Fr));
-
-  if (checkEncoding && !checkBlobFieldsEncoding(blobFields)) {
-    throw new BlobDeserializationError(`Incorrect encoding of blob fields, this blob was likely not created by us`);
-  }
-
-  return blobFields;
-}