@aztec/foundation 0.0.1-commit.24de95ac → 0.0.1-commit.2606882

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<string | number | bigint>().int().min(0))
+  .transform(value => EpochNumber(value));

package/src/branded-types/index.ts

@@ -0,0 +1,8 @@
+export { BlockNumber, BlockNumberSchema, BlockNumberPositiveSchema } from './block_number.js';
+export { BlockProposalHash, CheckpointProposalHash } from './buffer32_hash.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<string | number | bigint>().int().min(0))
+  .transform(value => IndexWithinCheckpoint(value));

package/src/branded-types/slot.ts

@@ -0,0 +1,93 @@
+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;
+};
+
+/** Increments a SlotNumber by a given value. */
+SlotNumber.add = function (sn: SlotNumber, increment: number): SlotNumber {
+  return SlotNumber(sn + increment);
+};
+
+/**
+ * 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<string | number | bigint>().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

@@ -1,5 +1,5 @@
-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';
@@ -10,6 +10,9 @@ import { bufferToHex } from '../string/index.js';
  * A class representing a 16 byte Buffer.
  */
 export class Buffer16 {
+  /** Branding for nominal typing. */
+  declare private readonly _branding: 'Buffer16';
+
   /**
    * The size of the hash in bytes.
    */

package/src/buffer/buffer32.ts

@@ -1,5 +1,5 @@
-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';
@@ -7,69 +7,39 @@ import { inspect } from 'util';
 import { bufferToHex } from '../string/index.js';
 
 /**
- * A class representing a 32 byte Buffer.
+ * Abstract unbranded base class for 32-byte buffers.
+ * Extend this instead of Buffer32 when defining a branded subtype
+ * to avoid inheriting Buffer32's `_branding`.
  */
-export class Buffer32 {
-  /**
-   * The size of the hash in bytes.
-   */
+export abstract class BaseBuffer32 {
+  /** The size of the buffer in bytes. */
   public static SIZE = 32;
 
-  /**
-   * Buffer32 with value zero.
-   */
-  public static ZERO = new Buffer32(Buffer.alloc(Buffer32.SIZE));
-
   constructor(
-    /**
-     * The buffer containing the hash.
-     */
+    /** The buffer containing the data. */
     public buffer: Buffer,
   ) {
-    if (buffer.length !== Buffer32.SIZE) {
-      throw new Error(`Expected buffer to have length ${Buffer32.SIZE} but was ${buffer.length}`);
+    if (buffer.length !== BaseBuffer32.SIZE) {
+      throw new Error(`Expected buffer to have length ${BaseBuffer32.SIZE} but was ${buffer.length}`);
     }
   }
 
-  /**
-   * Returns the raw buffer of the hash.
-   * @returns The buffer containing the hash.
-   */
+  /** Returns the raw buffer. */
   public toBuffer() {
     return this.buffer;
   }
 
-  /**
-   * Creates a Buffer32 from a buffer.
-   * @param buffer - The buffer to create from.
-   * @returns A new Buffer32 object.
-   */
-  public static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new Buffer32(reader.readBytes(Buffer32.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: Buffer32): boolean {
+  /** Checks if this and another buffer are equal. */
+  public equals(hash: BaseBuffer32): boolean {
     return this.buffer.equals(hash.buffer);
   }
 
-  /**
-   * Returns true if this hash is zero.
-   * @returns True if this hash is zero.
-   */
+  /** Returns true if all bytes are zero. */
   public isZero(): boolean {
     return this.buffer.equals(Buffer.alloc(32, 0));
   }
 
-  /**
-   * Convert this hash to a hex string.
-   * @returns The hex string.
-   */
+  /** Convert to a hex string. */
   public toString() {
     return bufferToHex(this.buffer);
   }
@@ -82,16 +52,27 @@ export class Buffer32 {
     return this.toString();
   }
 
-  /**
-   * Convert this hash to a big int.
-   * @returns The big int.
-   */
+  /** Convert to a big int. */
   public toBigInt() {
-    return deserializeBigInt(this.buffer, 0, Buffer32.SIZE).elem;
+    return deserializeBigInt(this.buffer, 0, BaseBuffer32.SIZE).elem;
   }
-  /**
-   * Creates a Buffer32 from a bigint.
-   */
+}
+
+/** A branded 32-byte buffer. */
+export class Buffer32 extends BaseBuffer32 {
+  /** Branding for nominal typing. */
+  declare private readonly _branding: 'Buffer32';
+
+  /** Buffer32 with value zero. */
+  public static ZERO = new Buffer32(Buffer.alloc(Buffer32.SIZE));
+
+  /** Creates a Buffer32 from a buffer. */
+  public static fromBuffer(buffer: Buffer | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new Buffer32(reader.readBytes(Buffer32.SIZE));
+  }
+
+  /** Creates a Buffer32 from a bigint. */
   public static fromBigInt(hash: bigint) {
     return new Buffer32(serializeBigInt(hash, Buffer32.SIZE));
   }
@@ -101,8 +82,7 @@ export class Buffer32 {
   }
 
   /**
-   * Converts this hash from a buffer of 28 bytes.
-   * Verifies the input is 28 bytes.
+   * Converts from a buffer of 28 bytes.
    * @param buffer - The 28 byte buffer to construct from.
    * @returns A Buffer32 created from the input buffer with 4 bytes 0 padding at the front.
    */
@@ -110,36 +90,27 @@ export class Buffer32 {
     if (buffer.length != 28) {
       throw new Error(`Expected Buffer32 input buffer to be 28 bytes`);
     }
-    const padded = Buffer.concat([Buffer.alloc(this.SIZE - 28), buffer]);
+    const padded = Buffer.concat([Buffer.alloc(Buffer32.SIZE - 28), buffer]);
     return new Buffer32(padded);
   }
 
-  /**
-   * Converts a string into a Buffer32 object.
-   */
+  /** Converts a string into a Buffer32 object. */
   public static fromString(str: string): Buffer32 {
     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}`);
+    if (str.length !== Buffer32.SIZE * 2) {
+      throw new Error(`Expected string to be ${Buffer32.SIZE * 2} characters long, but was ${str.length}`);
     }
     return new Buffer32(Buffer.from(str, 'hex'));
   }
 
-  /**
-   * Converts a number into a Buffer32 object.
-   * @param num - The number to convert.
-   * @returns A new Buffer32 object.
-   */
+  /** Converts a number into a Buffer32 object. */
   public static fromNumber(num: number): Buffer32 {
     return new Buffer32(serializeBigInt(BigInt(num), Buffer32.SIZE));
   }
 
-  /**
-   * Generates a random Buffer32.
-   * @returns A new Buffer32 object.
-   */
+  /** Generates a random Buffer32. */
   public static random(): Buffer32 {
     return new Buffer32(Buffer.from(randomBytes(Buffer32.SIZE)));
   }

package/src/buffer/index.ts

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

package/src/buffer/utils.ts

@@ -0,0 +1,8 @@
+/** Returns the number of bytes in the buffer, excluding any trailing zero bytes. */
+export function trimmedBytesLength(buf: Uint8Array): number {
+  let end = buf.length;
+  while (end > 0 && buf[end - 1] === 0) {
+    end--;
+  }
+  return end;
+}

package/src/collection/array.ts

@@ -138,6 +138,26 @@ export function unique<T>(arr: T[]): T[] {
   return [...new Set(arr)];
 }
 
+/**
+ * Removes duplicates from the given array using a key function. The first occurrence of each key is kept.
+ * @param arr - The array.
+ * @param keyFn - A function that returns a primitive key for each element. Elements with the same key are
+ *               considered duplicates.
+ * @returns A new array.
+ */
+export function uniqueBy<T, K extends string | number | bigint>(arr: T[], keyFn: (item: T) => K): T[] {
+  const seen = new Set<K>();
+  const result: T[] = [];
+  for (const item of arr) {
+    const key = keyFn(item);
+    if (!seen.has(key)) {
+      seen.add(key);
+      result.push(item);
+    }
+  }
+  return result;
+}
+
 /**
  * Removes all undefined elements from the array.
  * @param arr - The array.
@@ -250,6 +270,58 @@ export function chunk<T>(items: T[], chunkSize: number): T[][] {
   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[] = [];
@@ -263,3 +335,17 @@ export function partition<T>(items: T[], predicate: (item: T) => boolean): [T[],
   }
   return [pass, fail];
 }
+
+/** Partitions the given iterable into two arrays based on the predicate. */
+export async function partitionAsync<T>(items: T[], predicate: (item: T) => Promise<boolean>): Promise<[T[], T[]]> {
+  const pass: T[] = [];
+  const fail: T[] = [];
+  for (const item of items) {
+    if (await predicate(item)) {
+      pass.push(item);
+    } else {
+      fail.push(item);
+    }
+  }
+  return [pass, fail];
+}

package/src/collection/index.ts

@@ -1,2 +1,4 @@
 export * from './array.js';
+export * from './lru_map.js';
+export * from './lru_set.js';
 export * from './object.js';