@aztec/foundation 0.74.0 → 0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2

package/src/blob/encoding.ts

@@ -1,98 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader, FieldReader } from '@aztec/foundation/serialize';
-
-import type { Blob as BlobBuffer } from 'c-kzg';
-
-// This will appear as 0x74785f7374617274 in logs
-export const TX_START_PREFIX = 8392562855083340404n;
-// These are helper constants to decode tx effects from blob encoded fields
-export const TX_START_PREFIX_BYTES_LENGTH = TX_START_PREFIX.toString(16).length / 2;
-// 7 bytes for: | 0 | txlen[0] | txlen[1] | 0 | REVERT_CODE_PREFIX | 0 | revertCode |
-export const TX_EFFECT_PREFIX_BYTE_LENGTH = TX_START_PREFIX_BYTES_LENGTH + 7;
-
-/**
- * Deserializes a blob buffer into an array of field elements.
- *
- * Blobs are converted into BN254 fields to perform a poseidon2 hash on them (fieldHash).
- * This method is sparse, meaning it does not include trailing zeros at the end of the blob.
- *
- * However, we cannot simply trim the zero's from the end of the blob, as some logs may include zero's
- * within them.
- * If we end on a set of zeros, such as the log below:
- * length 7: [ a, b, c, d, e, 0, 0]
- *
- * we will end up with the incorrect hash if we trim the zeros from the end.
- *
- * Each transactions logs contains a TX start prefix, which includes a string followed
- * by the length ( in field elements ) of the transaction's log.
- *
- * This function finds the end of the last transaction's logs, and returns the array up to this point.
- *
- * We search for a series of Tx Prefixes progressing the cursor in the field reader until we hit
- * a field that is not a Tx Prefix, this indicates that we have reached the end of the last transaction's logs.
- *
- * +------------------+------------------+------------------+------------------+
- * | TX1 Start Prefix | TX1 Log Fields   | TX2 Start Prefix | Padded zeros     |
- * | [3 a,b,c]        | [3, a, b, c]     | [5 d,e,f,0,0]    | [0, 0, 0, .., 0] |
- * +------------------+------------------+------------------+------------------+
- *                                                          ^
- *                                                          |
- * Function reads until here --------------------------------
- *
- * @param blob - The blob buffer to deserialize.
- * @returns An array of field elements.
- */
-export function deserializeEncodedBlobToFields(blob: BlobBuffer): Fr[] {
-  // Convert blob buffer to array of field elements
-  const reader = BufferReader.asReader(blob);
-  const array = reader.readArray(blob.length >> 5, Fr); // >> 5 = / 32 (bytes per field)
-  const fieldReader = FieldReader.asReader(array);
-
-  // Read fields until we hit zeros at the end
-  while (!fieldReader.isFinished()) {
-    const currentField = fieldReader.peekField();
-
-    // Stop when we hit a zero field
-    if (!currentField || currentField.isZero()) {
-      break;
-    }
-
-    // Skip the remaining fields in this transaction
-    const len = getLengthFromFirstField(currentField);
-    fieldReader.skip(len);
-  }
-
-  // Return array up to last non-zero field
-  return array.slice(0, fieldReader.cursor);
-}
-
-export function getLengthFromFirstField(firstField: Fr): number {
-  const buf = firstField.toBuffer().subarray(-TX_EFFECT_PREFIX_BYTE_LENGTH);
-  return new Fr(buf.subarray(TX_START_PREFIX_BYTES_LENGTH + 1, TX_START_PREFIX_BYTES_LENGTH + 3)).toNumber();
-}
-
-/**
- * Extract the fields from a blob buffer, but do not take into account encoding
- * that will include trailing zeros.
- *
- * +------------------+------------------+------------------+------------------+
- * |                  |                  |                  | Padded zeros     |
- * | [3 a,b,c]        | [3, a, b, c]     | [5 d,e,f,0,0]    | [0, 0, 0, .., 0] |
- * +------------------+------------------+------------------+------------------+
- *                                                ^
- *                                                |
- * Function reads until here ----------------------
- */
-export function extractBlobFieldsFromBuffer(blob: BlobBuffer): Fr[] {
-  const reader = BufferReader.asReader(blob);
-  const array = reader.readArray(blob.length >> 5, Fr);
-
-  // Find the index of the last non-zero field
-  let lastNonZeroIndex = array.length - 1;
-  while (lastNonZeroIndex >= 0 && array[lastNonZeroIndex].isZero()) {
-    lastNonZeroIndex--;
-  }
-
-  // Return the trimmed array
-  return array.slice(0, lastNonZeroIndex + 1);
-}

package/src/blob/errors.ts

@@ -1,6 +0,0 @@
-export class BlobDeserializationError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = 'BlobDeserializationError';
-  }
-}

package/src/blob/index.ts

@@ -1,22 +0,0 @@
-import cKzg from 'c-kzg';
-
-/* eslint-disable import/no-named-as-default-member */
-const { loadTrustedSetup } = cKzg;
-
-export * from './blob.js';
-export * from './mocks.js';
-export * from './encoding.js';
-export * from './interface.js';
-export * from './errors.js';
-
-try {
-  loadTrustedSetup();
-} catch (error: any) {
-  if (error.message.includes('trusted setup is already loaded')) {
-    // NB: The c-kzg lib has no way of checking whether the setup is loaded or not,
-    // and it throws an error if it's already loaded, even though nothing is wrong.
-    // This is a rudimentary way of ensuring we load the trusted setup if we need it.
-  } else {
-    throw new Error(error);
-  }
-}

package/src/blob/interface.ts

@@ -1,11 +0,0 @@
-/**
- * The relevant parts of a response from https://ethereum.github.io/beacon-APIs/?urls.primaryName=dev#/Beacon/getBlobSidecars
- */
-export interface BlobJson {
-  blob: string;
-  index?: number;
-  // eslint-disable-next-line camelcase
-  kzg_commitment: string;
-  // eslint-disable-next-line camelcase
-  kzg_proof: string;
-}

package/src/blob/mocks.ts

@@ -1,48 +0,0 @@
-import { toBufferBE } from '@aztec/foundation/bigint-buffer';
-import { Fr } from '@aztec/foundation/fields';
-
-import { Blob } from './blob.js';
-import { TX_START_PREFIX, TX_START_PREFIX_BYTES_LENGTH } from './encoding.js';
-
-// TODO: copied form circuit-types tx effect
-function encodeFirstField(length: number): Fr {
-  const lengthBuf = Buffer.alloc(2);
-  lengthBuf.writeUInt16BE(length, 0);
-  return new Fr(
-    Buffer.concat([
-      toBufferBE(TX_START_PREFIX, TX_START_PREFIX_BYTES_LENGTH),
-      Buffer.alloc(1),
-      lengthBuf,
-      Buffer.alloc(1),
-      Buffer.from([1]),
-      Buffer.alloc(1),
-      Buffer.alloc(1),
-    ]),
-  );
-}
-
-/**
- * Make an encoded blob with the given length
- *
- * This will deserialise correctly in the archiver
- * @param length
- * @returns
- */
-export function makeEncodedBlob(length: number): Promise<Blob> {
-  return Blob.fromFields([encodeFirstField(length + 1), ...Array.from({ length: length }, () => Fr.random())]);
-}
-
-/**
- * Make an unencoded blob with the given length
- *
- * This will fail deserialisation in the archiver
- * @param length
- * @returns
- */
-export function makeUnencodedBlob(length: number): Promise<Blob> {
-  return Blob.fromFields([...Array.from({ length: length }, () => Fr.random())]);
-}
-
-export function makeEncodedBlobFields(fields: Fr[]): Promise<Blob> {
-  return Blob.fromFields([encodeFirstField(fields.length + 1), ...fields]);
-}