@aztec/foundation 0.0.0-test.0 → 0.0.1-commit.0208eb9

package/src/branded-types/epoch.ts

@@ -0,0 +1,88 @@
+import { z } from 'zod';
+
+import type { Branded } from './types.js';
+
+/**
+ * A branded type representing an epoch number.
+ * Epochs are used in the Aztec protocol to group slots and manage validator committees.
+ *
+ * This is a nominal type backed by a number, but TypeScript will treat it as
+ * incompatible with plain numbers and other branded numeric types (like Slot, BlockNumber, etc.).
+ *
+ * @example
+ * ```ts
+ * const epoch = EpochNumber(5);
+ * const plainNumber: number = epoch; // OK - EpochNumber is assignable to number
+ * const epochFromNumber: EpochNumber = 5;  // ERROR - number is not assignable to EpochNumber
+ * ```
+ */
+export type EpochNumber = Branded<number, 'EpochNumber'>;
+
+/**
+ * Creates an EpochNumber from a number.
+ * @param value - The epoch number (must be a non-negative integer)
+ * @returns The branded EpochNumber value
+ * @throws If the value is negative or not an integer
+ */
+export function EpochNumber(value: number): EpochNumber {
+  if (!Number.isInteger(value)) {
+    throw new Error(`EpochNumber must be an integer, got ${value}`);
+  }
+  if (value < 0) {
+    throw new Error(`EpochNumber must be non-negative, got ${value}`);
+  }
+  return value as EpochNumber;
+}
+
+/**
+ * Creates an EpochNumber from a bigint.
+ * @param value - The epoch number as bigint (must be a non-negative integer within safe integer range)
+ * @returns The branded EpochNumber value
+ * @throws If the value is negative or exceeds Number.MAX_SAFE_INTEGER
+ */
+EpochNumber.fromBigInt = function (value: bigint): EpochNumber {
+  if (value < 0n) {
+    throw new Error(`EpochNumber must be non-negative, got ${value}`);
+  }
+  if (value > BigInt(Number.MAX_SAFE_INTEGER)) {
+    throw new Error(`EpochNumber ${value} exceeds MAX_SAFE_INTEGER`);
+  }
+  return Number(value) as EpochNumber;
+};
+
+/**
+ * Creates an EpochNumber from a string.
+ * @param value - The epoch number as a string
+ * @returns The branded EpochNumber value
+ * @throws If the string cannot be parsed as a valid epoch
+ */
+EpochNumber.fromString = function (value: string): EpochNumber {
+  const parsed = parseInt(value, 10);
+  if (isNaN(parsed)) {
+    throw new Error(`Cannot parse EpochNumber from string: ${value}`);
+  }
+  return EpochNumber(parsed);
+};
+
+/**
+ * Type guard to check if a value is a valid EpochNumber.
+ * Note: At runtime, an EpochNumber is just a number, so this checks if the value
+ * is a non-negative integer.
+ */
+EpochNumber.isValid = function (value: unknown): value is EpochNumber {
+  return typeof value === 'number' && Number.isInteger(value) && value >= 0;
+};
+
+/**
+ * The zero epoch value.
+ */
+EpochNumber.ZERO = EpochNumber(0);
+
+/**
+ * Zod schema for parsing and validating EpochNumber values.
+ * Accepts numbers, bigints, or strings and coerces them to EpochNumber.
+ */
+export const EpochNumberSchema = z
+  .union([z.number(), z.bigint(), z.string()])
+  .pipe(z.coerce.number().int().min(0))
+  .transform(value => EpochNumber(value));

package/src/branded-types/index.ts

@@ -0,0 +1,7 @@
+export { BlockNumber, BlockNumberSchema, BlockNumberPositiveSchema } from './block_number.js';
+export { CheckpointNumber, CheckpointNumberSchema, CheckpointNumberPositiveSchema } from './checkpoint_number.js';
+export { EpochNumber, EpochNumberSchema } from './epoch.js';
+export { IndexWithinCheckpoint, IndexWithinCheckpointSchema } from './index_within_checkpoint.js';
+export { SlotNumber, SlotNumberSchema } from './slot.js';
+
+export type { Branded } from './types.js';

package/src/branded-types/index_within_checkpoint.ts

@@ -0,0 +1,88 @@
+import { z } from 'zod';
+
+import type { Branded } from './types.js';
+
+/**
+ * A branded type representing the index of a block within a checkpoint.
+ * The first block in a checkpoint has index 0, the second has index 1, etc.
+ *
+ * This is a nominal type backed by a number, but TypeScript will treat it as
+ * incompatible with plain numbers and other branded numeric types.
+ *
+ * @example
+ * ```ts
+ * const index = IndexWithinCheckpoint(0);
+ * const plainNumber: number = index; // OK - IndexWithinCheckpoint is assignable to number
+ * const indexFromNumber: IndexWithinCheckpoint = 0;  // ERROR - number is not assignable to IndexWithinCheckpoint
+ * ```
+ */
+export type IndexWithinCheckpoint = Branded<number, 'IndexWithinCheckpoint'>;
+
+/**
+ * Creates an IndexWithinCheckpoint from a number.
+ * @param value - The index (must be a non-negative integer)
+ * @returns The branded IndexWithinCheckpoint value
+ * @throws If the value is negative or not an integer
+ */
+export function IndexWithinCheckpoint(value: number): IndexWithinCheckpoint {
+  if (!Number.isInteger(value)) {
+    throw new Error(`IndexWithinCheckpoint must be an integer, got ${value}`);
+  }
+  if (value < 0) {
+    throw new Error(`IndexWithinCheckpoint must be non-negative, got ${value}`);
+  }
+  return value as IndexWithinCheckpoint;
+}
+
+/**
+ * Creates an IndexWithinCheckpoint from a bigint.
+ * @param value - The index as bigint (must be a non-negative integer within safe integer range)
+ * @returns The branded IndexWithinCheckpoint value
+ * @throws If the value is negative or exceeds Number.MAX_SAFE_INTEGER
+ */
+IndexWithinCheckpoint.fromBigInt = function (value: bigint): IndexWithinCheckpoint {
+  if (value < 0n) {
+    throw new Error(`IndexWithinCheckpoint must be non-negative, got ${value}`);
+  }
+  if (value > BigInt(Number.MAX_SAFE_INTEGER)) {
+    throw new Error(`IndexWithinCheckpoint ${value} exceeds MAX_SAFE_INTEGER`);
+  }
+  return Number(value) as IndexWithinCheckpoint;
+};
+
+/**
+ * Creates an IndexWithinCheckpoint from a string.
+ * @param value - The index as a string
+ * @returns The branded IndexWithinCheckpoint value
+ * @throws If the string cannot be parsed as a valid index
+ */
+IndexWithinCheckpoint.fromString = function (value: string): IndexWithinCheckpoint {
+  const parsed = parseInt(value, 10);
+  if (isNaN(parsed)) {
+    throw new Error(`Cannot parse IndexWithinCheckpoint from string: ${value}`);
+  }
+  return IndexWithinCheckpoint(parsed);
+};
+
+/**
+ * Type guard to check if a value is a valid IndexWithinCheckpoint.
+ * Note: At runtime, an IndexWithinCheckpoint is just a number, so this checks if the value
+ * is a non-negative integer.
+ */
+IndexWithinCheckpoint.isValid = function (value: unknown): value is IndexWithinCheckpoint {
+  return typeof value === 'number' && Number.isInteger(value) && value >= 0;
+};
+
+/**
+ * The zero index value (first block in checkpoint).
+ */
+IndexWithinCheckpoint.ZERO = IndexWithinCheckpoint(0);
+
+/**
+ * Zod schema for parsing and validating IndexWithinCheckpoint values.
+ * Accepts numbers, bigints, or strings and coerces them to IndexWithinCheckpoint.
+ */
+export const IndexWithinCheckpointSchema = z
+  .union([z.number(), z.bigint(), z.string()])
+  .pipe(z.coerce.number().int().min(0))
+  .transform(value => IndexWithinCheckpoint(value));

package/src/branded-types/slot.ts

@@ -0,0 +1,88 @@
+import { z } from 'zod';
+
+import type { Branded } from './types.js';
+
+/**
+ * A branded type representing a slot number.
+ * Slots are the fundamental time unit in the Aztec protocol, with multiple slots comprising an epoch.
+ *
+ * This is a nominal type backed by a number, but TypeScript will treat it as
+ * incompatible with plain numbers and other branded numeric types (like EpochNumber, BlockNumber, etc.).
+ *
+ * @example
+ * ```ts
+ * const slot = SlotNumber(5);
+ * const plainNumber: number = slot; // OK - SlotNumber is assignable to number
+ * const slotFromNumber: SlotNumber = 5;  // ERROR - number is not assignable to SlotNumber
+ * ```
+ */
+export type SlotNumber = Branded<number, 'SlotNumber'>;
+
+/**
+ * Creates a SlotNumber from a number.
+ * @param value - The slot number (must be a non-negative integer)
+ * @returns The branded SlotNumber value
+ * @throws If the value is negative or not an integer
+ */
+export function SlotNumber(value: number): SlotNumber {
+  if (!Number.isInteger(value)) {
+    throw new Error(`SlotNumber must be an integer, got ${value}`);
+  }
+  if (value < 0) {
+    throw new Error(`SlotNumber must be non-negative, got ${value}`);
+  }
+  return value as SlotNumber;
+}
+
+/**
+ * Creates a SlotNumber from a bigint.
+ * @param value - The slot number as bigint (must be a non-negative integer within safe integer range)
+ * @returns The branded SlotNumber value
+ * @throws If the value is negative or exceeds Number.MAX_SAFE_INTEGER
+ */
+SlotNumber.fromBigInt = function (value: bigint): SlotNumber {
+  if (value < 0n) {
+    throw new Error(`SlotNumber must be non-negative, got ${value}`);
+  }
+  if (value > BigInt(Number.MAX_SAFE_INTEGER)) {
+    throw new Error(`SlotNumber ${value} exceeds MAX_SAFE_INTEGER`);
+  }
+  return Number(value) as SlotNumber;
+};
+
+/**
+ * Creates a SlotNumber from a string.
+ * @param value - The slot number as a string
+ * @returns The branded SlotNumber value
+ * @throws If the string cannot be parsed as a valid slot
+ */
+SlotNumber.fromString = function (value: string): SlotNumber {
+  const parsed = parseInt(value, 10);
+  if (isNaN(parsed)) {
+    throw new Error(`Cannot parse SlotNumber from string: ${value}`);
+  }
+  return SlotNumber(parsed);
+};
+
+/**
+ * Type guard to check if a value is a valid SlotNumber.
+ * Note: At runtime, a SlotNumber is just a number, so this checks if the value
+ * is a non-negative integer.
+ */
+SlotNumber.isValid = function (value: unknown): value is SlotNumber {
+  return typeof value === 'number' && Number.isInteger(value) && value >= 0;
+};
+
+/**
+ * The zero slot value.
+ */
+SlotNumber.ZERO = SlotNumber(0);
+
+/**
+ * Zod schema for parsing and validating SlotNumber values.
+ * Accepts numbers, bigints, or strings and coerces them to SlotNumber.
+ */
+export const SlotNumberSchema = z
+  .union([z.number(), z.bigint(), z.string()])
+  .pipe(z.coerce.number().int().min(0))
+  .transform(value => SlotNumber(value));

package/src/branded-types/types.ts

@@ -0,0 +1,2 @@
+/** Adds a branding to a type for nominal typing. */
+export type Branded<T, Brand> = T & { _branding: Brand };

package/src/buffer/buffer16.ts

@@ -0,0 +1,133 @@
+import { randomBytes } from '@aztec/foundation/crypto/random';
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import { BufferReader, deserializeBigInt, serializeBigInt } from '@aztec/foundation/serialize';
+
+import { inspect } from 'util';
+
+import { bufferToHex } from '../string/index.js';
+
+/**
+ * A class representing a 16 byte Buffer.
+ */
+export class Buffer16 {
+  /**
+   * The size of the hash in bytes.
+   */
+  public static SIZE = 16;
+
+  /**
+   * Buffer16 with value zero.
+   */
+  public static ZERO = new Buffer16(Buffer.alloc(Buffer16.SIZE));
+
+  constructor(
+    /**
+     * The buffer containing the hash.
+     */
+    public buffer: Buffer,
+  ) {
+    if (buffer.length !== Buffer16.SIZE) {
+      throw new Error(`Expected buffer to have length ${Buffer16.SIZE} but was ${buffer.length}`);
+    }
+  }
+
+  /**
+   * Returns the raw buffer of the hash.
+   * @returns The buffer containing the hash.
+   */
+  public toBuffer() {
+    return this.buffer;
+  }
+
+  /**
+   * Creates a Buffer16 from a buffer.
+   * @param buffer - The buffer to create from.
+   * @returns A new Buffer16 object.
+   */
+  public static fromBuffer(buffer: Buffer | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new Buffer16(reader.readBytes(Buffer16.SIZE));
+  }
+
+  /**
+   * Checks if this hash and another hash are equal.
+   * @param hash - A hash to compare with.
+   * @returns True if the hashes are equal, false otherwise.
+   */
+  public equals(hash: Buffer16): boolean {
+    return this.buffer.equals(hash.buffer);
+  }
+
+  /**
+   * Returns true if this hash is zero.
+   * @returns True if this hash is zero.
+   */
+  public isZero(): boolean {
+    return this.buffer.equals(Buffer.alloc(16, 0));
+  }
+
+  /**
+   * Convert this hash to a hex string.
+   * @returns The hex string.
+   */
+  public toString() {
+    return bufferToHex(this.buffer);
+  }
+
+  [inspect.custom]() {
+    return `Buffer16<${this.toString()}>`;
+  }
+
+  toJSON() {
+    return this.toString();
+  }
+
+  /**
+   * Convert this hash to a big int.
+   * @returns The big int.
+   */
+  public toBigInt() {
+    return deserializeBigInt(this.buffer, 0, Buffer16.SIZE).elem;
+  }
+
+  /**
+   * Creates a Buffer16 from a bigint.
+   */
+  public static fromBigInt(hash: bigint) {
+    return new Buffer16(serializeBigInt(hash, Buffer16.SIZE));
+  }
+
+  public static fromField(hash: Fr) {
+    return new Buffer16(serializeBigInt(hash.toBigInt()));
+  }
+
+  /**
+   * Converts a hex string into a Buffer16 object.
+   */
+  public static fromString(str: string): Buffer16 {
+    if (str.startsWith('0x')) {
+      str = str.slice(2);
+    }
+    if (str.length !== this.SIZE * 2) {
+      throw new Error(`Expected string to be ${this.SIZE * 2} characters long, but was ${str.length}`);
+    }
+    return new Buffer16(Buffer.from(str, 'hex'));
+  }
+
+  /**
+   * Converts a number into a Buffer16 object.
+   * @param num - The number to convert.
+   * @returns A new Buffer16 object.
+   */
+  public static fromNumber(num: number): Buffer16 {
+    return new Buffer16(serializeBigInt(BigInt(num), Buffer16.SIZE));
+  }
+
+  /**
+   * Generates a random Buffer16.
+   * @returns A new Buffer16 object.
+   */
+  public static random(): Buffer16 {
+    return new Buffer16(Buffer.from(randomBytes(Buffer16.SIZE)));
+  }
+}

package/src/buffer/buffer32.ts

@@ -1,7 +1,9 @@
-import { randomBytes } from '@aztec/foundation/crypto';
-import type { Fr } from '@aztec/foundation/fields';
+import { randomBytes } from '@aztec/foundation/crypto/random';
+import type { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, deserializeBigInt, serializeBigInt } from '@aztec/foundation/serialize';
 
+import { inspect } from 'util';
+
 import { bufferToHex } from '../string/index.js';
 
 /**
@@ -72,6 +74,10 @@ export class Buffer32 {
     return bufferToHex(this.buffer);
   }
 
+  [inspect.custom]() {
+    return `Buffer32<${this.toString()}>`;
+  }
+
   toJSON() {
     return this.toString();
   }
@@ -85,8 +91,6 @@ export class Buffer32 {
   }
   /**
    * Creates a Buffer32 from a bigint.
-   * @param hash - The tx hash as a big int.
-   * @returns The Buffer32.
    */
   public static fromBigInt(hash: bigint) {
     return new Buffer32(serializeBigInt(hash, Buffer32.SIZE));
@@ -112,15 +116,13 @@ export class Buffer32 {
 
   /**
    * Converts a string into a Buffer32 object.
-   * @param str - The TX hash in string format.
-   * @returns A new Buffer32 object.
    */
   public static fromString(str: string): Buffer32 {
     if (str.startsWith('0x')) {
       str = str.slice(2);
     }
-    if (str.length !== 64) {
-      throw new Error(`Expected string to be 64 characters long, but was ${str.length}`);
+    if (str.length !== this.SIZE * 2) {
+      throw new Error(`Expected string to be ${this.SIZE * 2} characters long, but was ${str.length}`);
     }
     return new Buffer32(Buffer.from(str, 'hex'));
   }

package/src/buffer/index.ts

@@ -1 +1,2 @@
 export * from './buffer32.js';
+export * from './buffer16.js';

package/src/collection/array.ts

@@ -89,6 +89,17 @@ export async function timesAsync<T>(n: number, fn: (i: number) => Promise<T>): P
   return results;
 }
 
+/**
+ * Filters an array with an async predicate. Fires all predicate promises in parallel.
+ * @param arr - The array to filter.
+ * @param fn - The async function to determine if an item should be included.
+ * @returns A promise that resolves to the filtered array.
+ */
+export async function filterAsync<T>(arr: T[], fn: (item: T) => Promise<boolean>): Promise<T[]> {
+  const results = await Promise.all(arr.map(fn));
+  return arr.filter((_, i) => results[i]);
+}
+
 /**
  * Executes the given async function n times in parallel and returns the results in an array.
  * @param n - How many times to repeat.
@@ -157,7 +168,7 @@ export function areArraysEqual<T>(a: T[], b: T[], eq: (a: T, b: T) => boolean =
  * @param arr - The array.
  * @param fn - The function to get the value to compare.
  */
-export function maxBy<T>(arr: T[], fn: (x: T) => number): T | undefined {
+export function maxBy<T>(arr: T[], fn: (x: T) => number | bigint): T | undefined {
   return arr.reduce((max, x) => (fn(x) > fn(max) ? x : max), arr[0]);
 }
 
@@ -167,13 +178,25 @@ export function sum(arr: number[]): number {
 }
 
 /** Computes the median of a numeric array. Returns undefined if array is empty. */
-export function median(arr: number[]) {
+export function median(arr: number[]): number | undefined;
+/** Computes the median of a bigint array. Returns undefined if array is empty. */
+export function median(arr: bigint[]): bigint | undefined;
+export function median(arr: number[] | bigint[]): number | bigint | undefined {
   if (arr.length === 0) {
     return undefined;
   }
-  const sorted = [...arr].sort((a, b) => a - b);
+
+  // Handle number array
+  if (typeof arr[0] === 'number') {
+    const sorted = [...(arr as number[])].sort((a, b) => a - b);
+    const mid = Math.floor(sorted.length / 2);
+    return sorted.length % 2 !== 0 ? sorted[mid] : (sorted[mid - 1] + sorted[mid]) / 2;
+  }
+
+  // Handle bigint array
+  const sorted = [...(arr as bigint[])].sort((a, b) => (a < b ? -1 : a > b ? 1 : 0));
   const mid = Math.floor(sorted.length / 2);
-  return sorted.length % 2 !== 0 ? sorted[mid] : (sorted[mid - 1] + sorted[mid]) / 2;
+  return sorted.length % 2 !== 0 ? sorted[mid] : (sorted[mid - 1] + sorted[mid]) / 2n;
 }
 
 /** Computes the mean of a numeric array. Returns undefined if the array is empty. */
@@ -201,3 +224,94 @@ export function stdDev(values: number[]) {
   }
   return Math.sqrt(variance(values)!);
 }
+
+/** Counts how many items from the beginning of the array match the given predicate. */
+export function countWhile<T>(collection: T[], predicate: (x: T) => boolean): number {
+  let count = 0;
+  for (const item of collection) {
+    if (predicate(item)) {
+      count++;
+    } else {
+      break;
+    }
+  }
+  return count;
+}
+
+/** Splits the given iterable into chunks of the given size. Last chunk may be of smaller than the requested size. */
+export function chunk<T>(items: T[], chunkSize: number): T[][] {
+  if (chunkSize <= 0) {
+    throw new Error('Chunk size must be greater than 0');
+  }
+  const chunks: T[][] = [];
+  for (let i = 0; i < items.length; i += chunkSize) {
+    chunks.push(items.slice(i, i + chunkSize));
+  }
+  return chunks;
+}
+
+/**
+ * Splits the given array into chunks of the given size, wrapping around to the beginning
+ * if the last chunk would be smaller than the requested size.
+ * Returns empty array for empty input. Returns single chunk with all items if chunkSize <= 0.
+ */
+export function chunkWrapAround<T>(items: T[], chunkSize: number): T[][] {
+  if (items.length === 0) {
+    return [];
+  }
+  if (chunkSize <= 0 || items.length <= chunkSize) {
+    return [items];
+  }
+  const remainder = items.length % chunkSize;
+  if (remainder === 0) {
+    return chunk(items, chunkSize);
+  }
+  const wrapAroundCount = chunkSize - remainder;
+  const wrappedItems = [...items, ...items.slice(0, wrapAroundCount)];
+  return chunk(wrappedItems, chunkSize);
+}
+
+const UNINITIALIZED = Symbol('uninitialized');
+
+/**
+ * Splits the given iterable into chunks based on the key returned by the given function.
+ * Items must be contiguous to be included in the same chunk.
+ */
+export function chunkBy<T, U>(items: T[], fn: (item: T) => U): T[][] {
+  const chunks: T[][] = [];
+  let currentChunk: T[] = [];
+  let currentKey: U | typeof UNINITIALIZED = UNINITIALIZED;
+
+  for (const item of items) {
+    const key = fn(item);
+    if (currentKey === UNINITIALIZED || key !== currentKey) {
+      if (currentChunk.length > 0) {
+        chunks.push(currentChunk);
+      }
+      currentChunk = [item];
+      currentKey = key;
+    } else {
+      currentChunk.push(item);
+    }
+  }
+
+  if (currentChunk.length > 0) {
+    chunks.push(currentChunk);
+  }
+
+  return chunks;
+}
+
+/** Partitions the given iterable into two arrays based on the predicate. */
+export function partition<T>(items: T[], predicate: (item: T) => boolean): [T[], T[]] {
+  const pass: T[] = [];
+  const fail: T[] = [];
+  for (const item of items) {
+    if (predicate(item)) {
+      pass.push(item);
+    } else {
+      fail.push(item);
+    }
+  }
+  return [pass, fail];
+}

package/src/collection/object.ts

@@ -50,3 +50,40 @@ export function omit<T extends object>(object: T, ...props: string[]): Partial<T
   }
   return obj;
 }
+
+/** Equivalent to Object.keys but preserves types. */
+export function getKeys<T extends object>(obj: T): (keyof T)[] {
+  return Object.keys(obj) as (keyof T)[];
+}
+
+/** Equivalent to Object.entries but preserves types. */
+export function getEntries<T extends Record<PropertyKey, unknown>>(obj: T): { [K in keyof T]: [K, T[K]] }[keyof T][] {
+  // See https://stackoverflow.com/a/76176570
+  return Object.entries(obj) as { [K in keyof T]: [K, T[K]] }[keyof T][];
+}
+
+/** Equivalent to Object.fromEntries but preserves types. */
+export function fromEntries<const T extends ReadonlyArray<readonly [PropertyKey, unknown]>>(
+  entries: T,
+): { [K in T[number] as K[0]]: K[1] } {
+  // See https://stackoverflow.com/a/76176570
+  return Object.fromEntries(entries) as { [K in T[number] as K[0]]: K[1] };
+}
+
+/** Asserts all values in object are not undefined. */
+export function assertRequired<T extends object>(obj: T): Required<T> {
+  for (const key in obj) {
+    if (obj[key] === undefined) {
+      throw new Error(`Missing property ${key}`);
+    }
+  }
+  return obj as Required<T>;
+}
+
+/** Returns the result of merging two objects ignoring properties with undefined values. */
+export function merge<T extends object, U extends object>(
+  obj1: T,
+  obj2: U | undefined,
+): T & { [P in keyof U]+?: Exclude<U[P], undefined> } {
+  return { ...obj1, ...compact(obj2 ?? {}) };
+}