@aztec/foundation 0.0.1-commit.b655e406 → 0.0.1-commit.c0b82b2

package/src/branded-types/checkpoint_number.ts

@@ -0,0 +1,115 @@
+import { z } from 'zod';
+
+import type { BlockNumber } from './block_number.js';
+import type { Branded } from './types.js';
+
+/**
+ * A branded type representing an checkpoint number.
+ * Checkpoints are used in the Aztec protocol to group L2 blocks.
+ *
+ * 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 checkpoint = CheckpointNumber(5);
+ * const plainNumber: number = checkpoint; // OK - CheckpointNumber is assignable to number
+ * const checkpointFromNumber: CheckpointNumber = 5;  // ERROR - number is not assignable to CheckpointNumber
+ * ```
+ */
+export type CheckpointNumber = Branded<number, 'CheckpointNumber'>;
+
+/**
+ * Creates an CheckpointNumber from a number.
+ * @param value - The checkpoint number (must be a non-negative integer)
+ * @returns The branded CheckpointNumber value
+ * @throws If the value is negative or not an integer
+ */
+export function CheckpointNumber(value: number): CheckpointNumber {
+  if (!Number.isInteger(value)) {
+    throw new Error(`CheckpointNumber must be an integer, got ${value}`);
+  }
+  if (value < 0) {
+    throw new Error(`CheckpointNumber must be non-negative, got ${value}`);
+  }
+  return value as CheckpointNumber;
+}
+
+/**
+ * @param value - The block number
+ * @returns The branded CheckpointNumber value
+ *
+ * @deprecated Checkpoint number and block number should no longer convert to each other once we support multiple blocks
+ * per checkpoint everywhere.
+ */
+CheckpointNumber.fromBlockNumber = function (value: BlockNumber): CheckpointNumber {
+  return CheckpointNumber(value);
+};
+
+/**
+ * Creates an CheckpointNumber from a bigint.
+ * @param value - The checkpoint number as bigint (must be a non-negative integer within safe integer range)
+ * @returns The branded CheckpointNumber value
+ * @throws If the value is negative or exceeds Number.MAX_SAFE_INTEGER
+ */
+CheckpointNumber.fromBigInt = function (value: bigint): CheckpointNumber {
+  if (value < 0n) {
+    throw new Error(`CheckpointNumber must be non-negative, got ${value}`);
+  }
+  if (value > BigInt(Number.MAX_SAFE_INTEGER)) {
+    throw new Error(`CheckpointNumber ${value} exceeds MAX_SAFE_INTEGER`);
+  }
+  return Number(value) as CheckpointNumber;
+};
+
+/**
+ * Creates an CheckpointNumber from a string.
+ * @param value - The checkpoint number as a string
+ * @returns The branded CheckpointNumber value
+ * @throws If the string cannot be parsed as a valid checkpoint
+ */
+CheckpointNumber.fromString = function (value: string): CheckpointNumber {
+  const parsed = parseInt(value, 10);
+  if (isNaN(parsed)) {
+    throw new Error(`Cannot parse CheckpointNumber from string: ${value}`);
+  }
+  return CheckpointNumber(parsed);
+};
+
+/**
+ * Type guard to check if a value is a valid CheckpointNumber.
+ * Note: At runtime, an CheckpointNumber is just a number, so this checks if the value
+ * is a non-negative integer.
+ */
+CheckpointNumber.isValid = function (value: unknown): value is CheckpointNumber {
+  return typeof value === 'number' && Number.isInteger(value) && value >= 0;
+};
+
+/** The zero checkpoint value. */
+CheckpointNumber.ZERO = CheckpointNumber(0);
+
+/** Initial checkpoint. */
+CheckpointNumber.INITIAL = CheckpointNumber(1);
+
+/**
+ * Zod schema for parsing and validating CheckpointNumber values.
+ * Accepts numbers, bigints, or strings and coerces them to CheckpointNumber.
+ */
+function makeCheckpointNumberSchema(minValue: number) {
+  return z
+    .union([z.number(), z.bigint(), z.string()])
+    .pipe(z.coerce.number().int().min(minValue))
+    .transform(value => CheckpointNumber(value));
+}
+
+/**
+ * Zod schema for parsing and validating Checkpoint values.
+ * Accepts numbers, bigints, or strings and coerces them to CheckpointNumber.
+ */
+export const CheckpointNumberSchema = makeCheckpointNumberSchema(0);
+
+/**
+ * Zod schema for parsing and validating CheckpointNumber values that are strictly positive.
+ * Accepts numbers, bigints, or strings and coerces them to CheckpointNumber.
+ */
+export const CheckpointNumberPositiveSchema = makeCheckpointNumberSchema(1);

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

@@ -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';

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';

package/src/collection/array.ts

@@ -250,6 +250,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[] = [];