@aztec/foundation 0.24.0 → 0.26.1

package/src/aztec-address/index.ts

@@ -1,5 +1,7 @@
-import { Fr } from '../fields/index.js';
-import { FieldReader } from '../serialize/index.js';
+import { inspect } from 'util';
+
+import { Fr, fromBuffer } from '../fields/index.js';
+import { BufferReader, FieldReader } from '../serialize/index.js';
 
 /**
  * AztecAddress represents a 32-byte address in the Aztec Protocol.
@@ -16,6 +18,20 @@ export class AztecAddress extends Fr {
     super(buffer);
   }
 
+  [inspect.custom]() {
+    return `AztecAddress<${this.toString()}>`;
+  }
+
+  static ZERO = new AztecAddress(Buffer.alloc(32));
+
+  static zero(): AztecAddress {
+    return AztecAddress.ZERO;
+  }
+
+  static fromBuffer(buffer: Buffer | BufferReader) {
+    return fromBuffer(buffer, AztecAddress);
+  }
+
   static fromField(fr: Fr) {
     return new AztecAddress(fr.toBuffer());
   }
@@ -33,4 +49,8 @@ export class AztecAddress extends Fr {
     const buffer = Buffer.from(buf.replace(/^0x/i, ''), 'hex');
     return new AztecAddress(buffer);
   }
+
+  static random() {
+    return new AztecAddress(super.random().toBuffer());
+  }
 }

package/src/crypto/index.ts

@@ -4,6 +4,7 @@ export * from './keccak/index.js';
 export * from './random/index.js';
 export * from './sha256/index.js';
 export * from './pedersen/index.js';
+export * from './poseidon/index.js';
 
 /**
  * Init the bb singleton. This constructs (if not already) the barretenberg sync api within bb.js itself.

package/src/crypto/pedersen/pedersen.wasm.ts

@@ -1,4 +1,6 @@
-import { BarretenbergSync, Fr } from '@aztec/bb.js';
+import { BarretenbergSync, Fr as FrBarretenberg } from '@aztec/bb.js';
+
+import { Fr } from '../../fields/fields.js';
 
 /**
  * Create a pedersen commitment (point) from an array of input fields.
@@ -9,7 +11,7 @@ export function pedersenCommit(input: Buffer[]) {
     throw new Error('All Pedersen Commit input buffers must be <= 32 bytes.');
   }
   input = input.map(i => (i.length < 32 ? Buffer.concat([Buffer.alloc(32 - i.length, 0), i]) : i));
-  const point = BarretenbergSync.getSingleton().pedersenCommit(input.map(i => new Fr(i)));
+  const point = BarretenbergSync.getSingleton().pedersenCommit(input.map(i => new FrBarretenberg(i)));
   // toBuffer returns Uint8Arrays (browser/worker-boundary friendly).
   // TODO: rename toTypedArray()?
   return [Buffer.from(point.x.toBuffer()), Buffer.from(point.y.toBuffer())];
@@ -19,18 +21,20 @@ export function pedersenCommit(input: Buffer[]) {
  * Create a pedersen hash (field) from an array of input fields.
  * Left pads any inputs less than 32 bytes.
  */
-export function pedersenHash(input: Buffer[], index = 0) {
+export function pedersenHash(input: Buffer[], index = 0): Fr {
   if (!input.every(i => i.length <= 32)) {
     throw new Error('All Pedersen Hash input buffers must be <= 32 bytes.');
   }
   input = input.map(i => (i.length < 32 ? Buffer.concat([Buffer.alloc(32 - i.length, 0), i]) : i));
-  return Buffer.from(
-    BarretenbergSync.getSingleton()
-      .pedersenHash(
-        input.map(i => new Fr(i)),
-        index,
-      )
-      .toBuffer(),
+  return Fr.fromBuffer(
+    Buffer.from(
+      BarretenbergSync.getSingleton()
+        .pedersenHash(
+          input.map(i => new FrBarretenberg(i)),
+          index,
+        )
+        .toBuffer(),
+    ),
   );
 }
 

package/src/crypto/poseidon/index.ts

@@ -0,0 +1,17 @@
+import { BarretenbergSync, Fr as FrBarretenberg } from '@aztec/bb.js';
+
+import { Fr } from '../../fields/fields.js';
+
+/**
+ * Create a poseidon hash (field) from an array of input fields.
+ * Left pads any inputs less than 32 bytes.
+ */
+export function poseidonHash(input: Buffer[]): Fr {
+  return Fr.fromBuffer(
+    Buffer.from(
+      BarretenbergSync.getSingleton()
+        .poseidonHash(input.map(i => new FrBarretenberg(i)))
+        .toBuffer(),
+    ),
+  );
+}

package/src/eth-address/index.ts

@@ -1,3 +1,5 @@
+import { inspect } from 'util';
+
 import { keccak256String } from '../crypto/keccak/index.js';
 import { randomBytes } from '../crypto/random/index.js';
 import { Fr } from '../fields/index.js';
@@ -158,6 +160,10 @@ export class EthAddress {
     return `0x${this.buffer.toString('hex')}` as `0x${string}`;
   }
 
+  [inspect.custom]() {
+    return `EthAddress<${this.toString()}>`;
+  }
+
   /**
    * Returns the Ethereum address as a checksummed string.
    * The output string will have characters in the correct upper or lowercase form, according to EIP-55.
@@ -184,7 +190,6 @@ export class EthAddress {
    *
    * @returns A 32-byte Buffer containing the padded Ethereum address.
    */
-  // TODO(#3938): nuke this
   public toBuffer32() {
     const buffer = Buffer.alloc(32);
     this.buffer.copy(buffer, 12);

package/src/fields/fields.ts

@@ -1,3 +1,5 @@
+import { inspect } from 'util';
+
 import { toBigIntBE, toBufferBE } from '../bigint-buffer/index.js';
 import { randomBytes } from '../crypto/random/index.js';
 import { BufferReader } from '../serialize/buffer_reader.js';
@@ -137,7 +139,7 @@ abstract class BaseField {
  * Constructs a field from a Buffer of BufferReader.
  * It maybe not read the full 32 bytes if the Buffer is shorter, but it will padded in BaseField constructor.
  */
-function fromBuffer<T extends BaseField>(buffer: Buffer | BufferReader, f: DerivedField<T>) {
+export function fromBuffer<T extends BaseField>(buffer: Buffer | BufferReader, f: DerivedField<T>) {
   const reader = BufferReader.asReader(buffer);
   return new f(reader.readBytes(BaseField.SIZE_IN_BYTES));
 }
@@ -185,6 +187,10 @@ export class Fr extends BaseField {
     super(value);
   }
 
+  [inspect.custom]() {
+    return `Fr<${this.toString()}>`;
+  }
+
   protected modulus() {
     return Fr.MODULUS;
   }
@@ -251,6 +257,10 @@ export class Fq extends BaseField {
   private static HIGH_SHIFT = BigInt((BaseField.SIZE_IN_BYTES / 2) * 8);
   private static LOW_MASK = (1n << Fq.HIGH_SHIFT) - 1n;
 
+  [inspect.custom]() {
+    return `Fq<${this.toString()}>`;
+  }
+
   get low(): Fr {
     return new Fr(this.toBigInt() & Fq.LOW_MASK);
   }

package/src/json-rpc/client/json_rpc_client.ts

@@ -77,7 +77,7 @@ export function makeFetch(retries: number[], noRetry: boolean, log?: DebugLogger
   return async (host: string, rpcMethod: string, body: any, useApiEndpoints: boolean) => {
     return await retry(
       () => defaultFetch(host, rpcMethod, body, useApiEndpoints, noRetry),
-      `JsonRpcClient request to ${host}`,
+      `JsonRpcClient request ${rpcMethod} to ${host}`,
       makeBackoff(retries),
       log,
       true,

package/src/serialize/buffer_reader.ts

@@ -153,6 +153,29 @@ export class BufferReader {
     return result;
   }
 
+  /**
+   * Reads a vector of fixed size from the buffer and deserializes its elements using the provided itemDeserializer object.
+   * The 'itemDeserializer' object should have a 'fromBuffer' method that takes a BufferReader instance and returns the deserialized element.
+   * The method first reads the size of the vector (a number) from the buffer, then iterates through its elements,
+   * deserializing each one using the 'fromBuffer' method of 'itemDeserializer'.
+   *
+   * @param itemDeserializer - Object with 'fromBuffer' method to deserialize vector elements.
+   * @returns An array of deserialized elements of type T.
+   */
+  public readVectorUint8Prefix<T>(itemDeserializer: {
+    /**
+     * A method to deserialize data from a buffer.
+     */
+    fromBuffer: (reader: BufferReader) => T;
+  }): T[] {
+    const size = this.readUInt8();
+    const result = new Array<T>(size);
+    for (let i = 0; i < size; i++) {
+      result[i] = itemDeserializer.fromBuffer(this);
+    }
+    return result;
+  }
+
   /**
    * Read an array of a fixed size with elements of type T from the buffer.
    * The 'itemDeserializer' object should have a 'fromBuffer' method that takes a BufferReader instance as input,

package/src/serialize/serialize.ts

@@ -4,13 +4,22 @@ import { numToUInt32BE } from './free_funcs.js';
 
 /**
  * For serializing an array of fixed length buffers.
- * TODO move to foundation pkg.
- * @param arr - Array of buffers.
+ * @param arr - Array of bufferable.
+ * @param prefixLength - The length of the prefix (denominated in bytes).
  * @returns The serialized buffers.
  */
-export function serializeBufferArrayToVector(arr: Buffer[]): Buffer {
-  const lengthBuf = Buffer.alloc(4);
-  lengthBuf.writeUInt32BE(arr.length, 0);
+export function serializeArrayOfBufferableToVector(objs: Bufferable[], prefixLength = 4): Buffer {
+  const arr = serializeToBufferArray(objs);
+  let lengthBuf: Buffer;
+  if (prefixLength === 1) {
+    lengthBuf = Buffer.alloc(1);
+    lengthBuf.writeUInt8(arr.length, 0);
+  } else if (prefixLength === 4) {
+    lengthBuf = Buffer.alloc(4);
+    lengthBuf.writeUInt32BE(arr.length, 0);
+  } else {
+    throw new Error(`Unsupported prefix length. Got ${prefixLength}, expected 1 or 4`);
+  }
   return Buffer.concat([lengthBuf, ...arr]);
 }
 
@@ -37,8 +46,6 @@ type DeserializeFn<T> = (
  * @param vector - The vector to deserialize.
  * @param offset - The position in the vector to start deserializing from.
  * @returns Deserialized array and how many bytes we advanced by.
- *
- * TODO: move to foundation pkg.
  */
 export function deserializeArrayFromVector<T>(
   deserialize: DeserializeFn<T>,