@aztec/blob-lib 0.0.1-commit.21caa21 → 0.0.1-commit.21ecf947b

package/src/encoding/block_blob_data.ts

@@ -1,4 +1,4 @@
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { FieldReader } from '@aztec/foundation/serialize';
 
 import { BlobDeserializationError } from '../errors.js';
@@ -17,6 +17,18 @@ import { type TxBlobData, decodeTxBlobData, encodeTxBlobData } from './tx_blob_d
 
 // Must match the implementation in `noir-protocol-circuits/crates/types/src/blob_data/block_blob_data.nr`.
 
+export const NUM_BLOCK_END_BLOB_FIELDS = 6;
+export const NUM_FIRST_BLOCK_END_BLOB_FIELDS = 7;
+export const NUM_CHECKPOINT_END_MARKER_FIELDS = 1;
+
+/**
+ * Returns the number of blob fields used for block end data.
+ * @param isFirstBlockInCheckpoint - Whether this is the first block in a checkpoint.
+ */
+export function getNumBlockEndBlobFields(isFirstBlockInCheckpoint: boolean): number {
+  return isFirstBlockInCheckpoint ? NUM_FIRST_BLOCK_END_BLOB_FIELDS : NUM_BLOCK_END_BLOB_FIELDS;
+}
+
 export interface BlockEndBlobData {
   blockEndMarker: BlockEndMarker;
   blockEndStateField: BlockEndStateField;
@@ -46,7 +58,7 @@ export function encodeBlockEndBlobData(blockEndBlobData: BlockEndBlobData): Fr[]
 export function decodeBlockEndBlobData(fields: Fr[] | FieldReader, isFirstBlock: boolean): BlockEndBlobData {
   const reader = FieldReader.asReader(fields);
 
-  const numBlockEndData = isFirstBlock ? 7 : 6;
+  const numBlockEndData = getNumBlockEndBlobFields(isFirstBlock);
   if (numBlockEndData > reader.remainingFields()) {
     throw new BlobDeserializationError(
       `Incorrect encoding of blob fields: not enough fields for block end data. Expected ${numBlockEndData} fields, only ${reader.remainingFields()} remaining.`,

package/src/encoding/block_end_marker.ts

@@ -1,5 +1,6 @@
 import { BLOCK_END_PREFIX } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
 
 import { BlobDeserializationError } from '../errors.js';
 
@@ -11,12 +12,12 @@ const NUM_TXS_BIT_SIZE = 16n;
 
 export interface BlockEndMarker {
   timestamp: bigint;
-  blockNumber: number;
+  blockNumber: BlockNumber;
   numTxs: number;
 }
 
 export function encodeBlockEndMarker(blockEndMarker: BlockEndMarker) {
-  let value = BLOCK_END_PREFIX;
+  let value = BigInt(BLOCK_END_PREFIX);
   value <<= TIMESTAMP_BIT_SIZE;
   value += blockEndMarker.timestamp;
   value <<= BLOCK_NUMBER_BIT_SIZE;
@@ -30,13 +31,13 @@ export function decodeBlockEndMarker(field: Fr): BlockEndMarker {
   let value = field.toBigInt();
   const numTxs = Number(value & (2n ** NUM_TXS_BIT_SIZE - 1n));
   value >>= NUM_TXS_BIT_SIZE;
-  const blockNumber = Number(value & (2n ** BLOCK_NUMBER_BIT_SIZE - 1n));
+  const blockNumber = BlockNumber(Number(value & (2n ** BLOCK_NUMBER_BIT_SIZE - 1n)));
   value >>= BLOCK_NUMBER_BIT_SIZE;
   const timestamp = value & (2n ** TIMESTAMP_BIT_SIZE - 1n);
   value >>= TIMESTAMP_BIT_SIZE;
 
   const prefix = value;
-  if (prefix !== BLOCK_END_PREFIX) {
+  if (prefix !== BigInt(BLOCK_END_PREFIX)) {
     throw new BlobDeserializationError(`Incorrect encoding of blob fields: invalid block end marker.`);
   }
 
@@ -50,5 +51,5 @@ export function decodeBlockEndMarker(field: Fr): BlockEndMarker {
 // Check if a field is a block end marker. Used before decoding to check if it has reached the end of the block.
 export function isBlockEndMarker(field: Fr): boolean {
   const prefix = field.toBigInt() >> (NUM_TXS_BIT_SIZE + BLOCK_NUMBER_BIT_SIZE + TIMESTAMP_BIT_SIZE);
-  return prefix === BLOCK_END_PREFIX;
+  return prefix === BigInt(BLOCK_END_PREFIX);
 }

package/src/encoding/block_end_state_field.ts

@@ -4,7 +4,7 @@ import {
   NULLIFIER_TREE_HEIGHT,
   PUBLIC_DATA_TREE_HEIGHT,
 } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 
 import { BlobDeserializationError } from '../errors.js';
 

package/src/encoding/checkpoint_blob_data.ts

@@ -1,8 +1,15 @@
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, FieldReader } from '@aztec/foundation/serialize';
 
 import { BlobDeserializationError } from '../errors.js';
-import { type BlockBlobData, decodeBlockBlobData, encodeBlockBlobData } from './block_blob_data.js';
+import {
+  type BlockBlobData,
+  NUM_BLOCK_END_BLOB_FIELDS,
+  NUM_CHECKPOINT_END_MARKER_FIELDS,
+  NUM_FIRST_BLOCK_END_BLOB_FIELDS,
+  decodeBlockBlobData,
+  encodeBlockBlobData,
+} from './block_blob_data.js';
 import {
   type CheckpointEndMarker,
   decodeCheckpointEndMarker,
@@ -25,7 +32,7 @@ export function encodeCheckpointBlobData(checkpointBlobData: CheckpointBlobData)
 
 export function encodeCheckpointBlobDataFromBlocks(blocks: BlockBlobData[]): Fr[] {
   const blocksBlobFields = blocks.map(block => encodeBlockBlobData(block)).flat();
-  const numBlobFields = blocksBlobFields.length + 1; // +1 for the checkpoint end marker.
+  const numBlobFields = blocksBlobFields.length + NUM_CHECKPOINT_END_MARKER_FIELDS;
   return blocksBlobFields.concat(encodeCheckpointEndMarker({ numBlobFields }));
 }
 
@@ -87,9 +94,9 @@ export function getTotalNumBlobFieldsFromTxs(txsPerBlock: TxStartMarker[][]): nu
   }
 
   return (
-    (numBlocks ? 1 : 0) + // l1ToL2Messages root in the first block
-    numBlocks * 6 + // 6 fields for each block end blob data.
+    (numBlocks ? NUM_FIRST_BLOCK_END_BLOB_FIELDS - NUM_BLOCK_END_BLOB_FIELDS : 0) + // l1ToL2Messages root in the first block
+    numBlocks * NUM_BLOCK_END_BLOB_FIELDS + // 6 fields for each block end blob data.
     txsPerBlock.reduce((total, txs) => total + txs.reduce((total, tx) => total + tx.numBlobFields, 0), 0) +
-    1 // checkpoint end marker
+    NUM_CHECKPOINT_END_MARKER_FIELDS // checkpoint end marker
   );
 }

package/src/encoding/checkpoint_end_marker.ts

@@ -1,5 +1,5 @@
 import { CHECKPOINT_END_PREFIX } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 
 import { BlobDeserializationError } from '../errors.js';
 
@@ -12,7 +12,7 @@ export interface CheckpointEndMarker {
 }
 
 export function encodeCheckpointEndMarker(checkpointEndMarker: CheckpointEndMarker) {
-  let value = CHECKPOINT_END_PREFIX;
+  let value = BigInt(CHECKPOINT_END_PREFIX);
   value <<= NUM_BLOB_FIELDS_BIT_SIZE;
   value += BigInt(checkpointEndMarker.numBlobFields);
   return new Fr(value);
@@ -24,7 +24,7 @@ export function decodeCheckpointEndMarker(field: Fr): CheckpointEndMarker {
   value >>= NUM_BLOB_FIELDS_BIT_SIZE;
 
   const prefix = value;
-  if (prefix !== CHECKPOINT_END_PREFIX) {
+  if (prefix !== BigInt(CHECKPOINT_END_PREFIX)) {
     throw new BlobDeserializationError(`Incorrect encoding of blob fields: invalid checkpoint end marker.`);
   }
 
@@ -36,5 +36,5 @@ export function decodeCheckpointEndMarker(field: Fr): CheckpointEndMarker {
 // Check if a field is a checkpoint end marker. Used to check if it has reached the end of the blob fields.
 export function isCheckpointEndMarker(field: Fr): boolean {
   const prefix = field.toBigInt() >> NUM_BLOB_FIELDS_BIT_SIZE;
-  return prefix === CHECKPOINT_END_PREFIX;
+  return prefix === BigInt(CHECKPOINT_END_PREFIX);
 }

package/src/encoding/fixtures.ts

@@ -9,7 +9,8 @@ import {
   PRIVATE_LOG_SIZE_IN_FIELDS,
 } from '@aztec/constants';
 import { makeTuple } from '@aztec/foundation/array';
-import { Fr } from '@aztec/foundation/fields';
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
 
 import type { BlockBlobData, BlockEndBlobData } from './block_blob_data.js';
 import type { BlockEndMarker } from './block_end_marker.js';
@@ -109,7 +110,7 @@ export function makeBlockEndMarker({
 }: { seed?: number } & Partial<BlockEndMarker> = {}): BlockEndMarker {
   return {
     numTxs: seed,
-    blockNumber: seed + 1,
+    blockNumber: BlockNumber(seed + 1),
     timestamp: BigInt(seed + 2),
     ...overrides,
   };

package/src/encoding/tx_blob_data.ts

@@ -1,5 +1,5 @@
 import { chunk } from '@aztec/foundation/collection';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { FieldReader } from '@aztec/foundation/serialize';
 
 import { BlobDeserializationError } from '../errors.js';

package/src/encoding/tx_start_marker.ts

@@ -1,5 +1,5 @@
 import { TX_START_PREFIX } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 
 import { BlobDeserializationError } from '../errors.js';
 
@@ -30,7 +30,7 @@ export interface TxStartMarker {
 }
 
 export function encodeTxStartMarker(txStartMarker: TxStartMarker): Fr {
-  let value = TX_START_PREFIX;
+  let value = BigInt(TX_START_PREFIX);
   value <<= NUM_NOTE_HASH_BIT_SIZE;
   value += BigInt(txStartMarker.numNoteHashes);
   value <<= NUM_NULLIFIER_BIT_SIZE;
@@ -78,7 +78,7 @@ export function decodeTxStartMarker(field: Fr): TxStartMarker {
   value >>= NUM_NOTE_HASH_BIT_SIZE;
 
   const prefix = value;
-  if (prefix !== TX_START_PREFIX) {
+  if (prefix !== BigInt(TX_START_PREFIX)) {
     throw new BlobDeserializationError(`Incorrect encoding of blob fields: invalid tx start marker.`);
   }
 

package/src/hash.ts

@@ -1,7 +1,9 @@
-import { poseidon2Hash, sha256, sha256ToField } from '@aztec/foundation/crypto';
-import { BLS12Fr, Fr } from '@aztec/foundation/fields';
+import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
+import { sha256, sha256ToField } from '@aztec/foundation/crypto/sha256';
+import { BLS12Fr } from '@aztec/foundation/curves/bls12';
+import { Fr } from '@aztec/foundation/curves/bn254';
 
-import { BYTES_PER_BLOB, BYTES_PER_COMMITMENT, kzg } from './kzg_context.js';
+import { BYTES_PER_BLOB, BYTES_PER_COMMITMENT, getKzg } from './kzg_context.js';
 import { SpongeBlob } from './sponge_blob.js';
 
 const VERSIONED_HASH_VERSION_KZG = 0x01;
@@ -47,7 +49,7 @@ export function computeBlobCommitment(data: Uint8Array): Buffer {
     throw new Error(`Expected ${BYTES_PER_BLOB} bytes per blob. Got ${data.length}.`);
   }
 
-  return Buffer.from(kzg.blobToKzgCommitment(data));
+  return Buffer.from(getKzg().blobToKzgCommitment(data));
 }
 
 /**

package/src/index.ts

@@ -7,3 +7,4 @@ export * from './encoding/index.js';
 export * from './hash.js';
 export * from './interface.js';
 export * from './sponge_blob.js';
+export * from './kzg_context.js';

package/src/interface.ts

@@ -3,6 +3,5 @@
  */
 export interface BlobJson {
   blob: string;
-  index: string;
   kzg_commitment: string;
 }

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 { 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,

package/src/testing.ts

@@ -1,5 +1,6 @@
 import { makeTuple } from '@aztec/foundation/array';
-import { BLS12Fq, BLS12Fr, BLS12Point, BLSPointNotOnCurveError, 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 { BlobAccumulator } from './circuit_types/blob_accumulator.js';