@aztec/foundation 0.56.0 → 0.58.0

package/src/collection/array.ts

@@ -100,3 +100,18 @@ export function unique<T>(arr: T[]): T[] {
 export function compactArray<T>(arr: (T | undefined)[]): T[] {
   return arr.filter((x: T | undefined): x is T => x !== undefined);
 }
+
+/**
+ * Returns whether two arrays are equal. The arrays are equal if they have the same length and all elements are equal.
+ */
+export function areArraysEqual<T>(a: T[], b: T[], eq: (a: T, b: T) => boolean = (a: T, b: T) => a === b): boolean {
+  if (a.length !== b.length) {
+    return false;
+  }
+  for (let i = 0; i < a.length; i++) {
+    if (!eq(a[i], b[i])) {
+      return false;
+    }
+  }
+  return true;
+}

package/src/config/env_var.ts

@@ -1,132 +1,141 @@
 export type EnvVar =
-  | 'AZTEC_PORT'
+  | 'ACVM_BINARY_PATH'
+  | 'ACVM_WORKING_DIRECTORY'
+  | 'API_KEY'
+  | 'API_PREFIX'
+  | 'ARCHIVER_MAX_LOGS'
+  | 'ARCHIVER_POLLING_INTERVAL_MS'
+  | 'ARCHIVER_URL'
+  | 'ARCHIVER_VIEM_POLLING_INTERVAL_MS'
   | 'ASSUME_PROVEN_THROUGH_BLOCK_NUMBER'
-  | 'TEST_ACCOUNTS'
+  | 'AZTEC_NODE_URL'
+  | 'AZTEC_PORT'
+  | 'BB_BINARY_PATH'
+  | 'BB_SKIP_CLEANUP'
+  | 'BB_WORKING_DIRECTORY'
+  | 'BOOTSTRAP_NODES'
+  | 'BOT_DA_GAS_LIMIT'
+  | 'BOT_FEE_PAYMENT_METHOD'
+  | 'BOT_FLUSH_SETUP_TRANSACTIONS'
+  | 'BOT_FOLLOW_CHAIN'
+  | 'BOT_L2_GAS_LIMIT'
+  | 'BOT_MAX_PENDING_TXS'
+  | 'BOT_NO_START'
+  | 'BOT_NO_WAIT_FOR_TRANSFERS'
+  | 'BOT_PRIVATE_KEY'
+  | 'BOT_PRIVATE_TRANSFERS_PER_TX'
+  | 'BOT_PUBLIC_TRANSFERS_PER_TX'
+  | 'BOT_PXE_URL'
+  | 'BOT_RECIPIENT_ENCRYPTION_SECRET'
+  | 'BOT_SKIP_PUBLIC_SIMULATION'
+  | 'BOT_TOKEN_CONTRACT'
+  | 'BOT_TOKEN_SALT'
+  | 'BOT_TX_INTERVAL_SECONDS'
+  | 'BOT_TX_MINED_WAIT_SECONDS'
+  | 'COINBASE'
+  | 'DATA_DIRECTORY'
+  | 'DEBUG'
+  | 'DEPLOY_AZTEC_CONTRACTS_SALT'
+  | 'DEPLOY_AZTEC_CONTRACTS'
   | 'ENABLE_GAS'
-  | 'API_PREFIX'
+  | 'ENFORCE_FEES'
   | 'ETHEREUM_HOST'
-  | 'L1_CHAIN_ID'
-  | 'MNEMONIC'
-  | 'ROLLUP_CONTRACT_ADDRESS'
-  | 'REGISTRY_CONTRACT_ADDRESS'
-  | 'INBOX_CONTRACT_ADDRESS'
-  | 'OUTBOX_CONTRACT_ADDRESS'
   | 'FEE_JUICE_CONTRACT_ADDRESS'
   | 'FEE_JUICE_PORTAL_CONTRACT_ADDRESS'
-  | 'ARCHIVER_URL'
-  | 'DEPLOY_AZTEC_CONTRACTS'
-  | 'DEPLOY_AZTEC_CONTRACTS_SALT'
+  | 'FEE_RECIPIENT'
+  | 'INBOX_CONTRACT_ADDRESS'
+  | 'L1_CHAIN_ID'
   | 'L1_PRIVATE_KEY'
   | 'L2_QUEUE_SIZE'
-  | 'WS_BLOCK_CHECK_INTERVAL_MS'
-  | 'P2P_ENABLED'
+  | 'LOG_JSON'
+  | 'LOG_LEVEL'
+  | 'MNEMONIC'
+  | 'NETWORK_NAME'
+  | 'NETWORK'
+  | 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT'
+  | 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'
+  | 'OTEL_SERVICE_NAME'
+  | 'OUTBOX_CONTRACT_ADDRESS'
   | 'P2P_BLOCK_CHECK_INTERVAL_MS'
-  | 'P2P_PEER_CHECK_INTERVAL_MS'
-  | 'P2P_L2_QUEUE_SIZE'
-  | 'TCP_LISTEN_ADDR'
-  | 'UDP_LISTEN_ADDR'
-  | 'P2P_TCP_ANNOUNCE_ADDR'
-  | 'P2P_UDP_ANNOUNCE_ADDR'
-  | 'PEER_ID_PRIVATE_KEY'
-  | 'BOOTSTRAP_NODES'
-  | 'P2P_TX_PROTOCOL'
-  | 'P2P_MIN_PEERS'
-  | 'P2P_MAX_PEERS'
-  | 'DATA_DIRECTORY'
-  | 'TX_GOSSIP_VERSION'
-  | 'P2P_QUERY_FOR_IP'
-  | 'P2P_TX_POOL_KEEP_PROVEN_FOR'
-  | 'P2P_GOSSIPSUB_INTERVAL_MS'
+  | 'P2P_ENABLED'
   | 'P2P_GOSSIPSUB_D'
-  | 'P2P_GOSSIPSUB_DLO'
   | 'P2P_GOSSIPSUB_DHI'
-  | 'P2P_GOSSIPSUB_MCACHE_LENGTH'
+  | 'P2P_GOSSIPSUB_DLO'
+  | 'P2P_GOSSIPSUB_INTERVAL_MS'
   | 'P2P_GOSSIPSUB_MCACHE_GOSSIP'
-  | 'P2P_SEVERE_PEER_PENALTY_BLOCK_LENGTH'
-  | 'P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS'
-  | 'P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS'
-  | 'P2P_GOSSIPSUB_TX_TOPIC_WEIGHT'
-  | 'P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_WEIGHT'
+  | 'P2P_GOSSIPSUB_MCACHE_LENGTH'
   | 'P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_DECAY'
+  | 'P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_WEIGHT'
+  | 'P2P_GOSSIPSUB_TX_TOPIC_WEIGHT'
+  | 'P2P_L2_QUEUE_SIZE'
+  | 'P2P_MAX_PEERS'
+  | 'P2P_MIN_PEERS'
+  | 'P2P_PEER_CHECK_INTERVAL_MS'
   | 'P2P_PEER_PENALTY_VALUES'
-  | 'TELEMETRY'
-  | 'OTEL_SERVICE_NAME'
-  | 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT'
-  | 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'
-  | 'NETWORK_NAME'
-  | 'NETWORK'
-  | 'API_KEY'
-  | 'AZTEC_NODE_URL'
-  | 'ARCHIVER_POLLING_INTERVAL_MS'
-  | 'ARCHIVER_VIEM_POLLING_INTERVAL_MS'
-  | 'ARCHIVER_MAX_LOGS'
-  | 'SEQ_TX_POLLING_INTERVAL_MS'
-  | 'SEQ_MAX_TX_PER_BLOCK'
-  | 'SEQ_MIN_TX_PER_BLOCK'
-  | 'SEQ_MIN_SECONDS_BETWEEN_BLOCKS'
-  | 'SEQ_MAX_SECONDS_BETWEEN_BLOCKS'
-  | 'COINBASE'
-  | 'FEE_RECIPIENT'
-  | 'ACVM_WORKING_DIRECTORY'
-  | 'ACVM_BINARY_PATH'
-  | 'SEQ_ALLOWED_SETUP_FN'
-  | 'SEQ_ALLOWED_TEARDOWN_FN'
-  | 'SEQ_MAX_BLOCK_SIZE_IN_BYTES'
-  | 'ENFORCE_FEES'
-  | 'SEQ_PUBLISHER_PRIVATE_KEY'
-  | 'SEQ_REQUIRED_CONFIRMATIONS'
-  | 'SEQ_PUBLISH_RETRY_INTERVAL_MS'
-  | 'VERSION'
-  | 'SEQ_DISABLED'
-  | 'PROVER_DISABLED'
-  | 'PROVER_REAL_PROOFS'
+  | 'P2P_QUERY_FOR_IP'
+  | 'P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS'
+  | 'P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS'
+  | 'P2P_SEVERE_PEER_PENALTY_BLOCK_LENGTH'
+  | 'P2P_TCP_LISTEN_ADDR'
+  | 'P2P_TCP_ANNOUNCE_ADDR'
+  | 'P2P_TX_POOL_KEEP_PROVEN_FOR'
+  | 'P2P_TX_PROTOCOL'
+  | 'P2P_UDP_ANNOUNCE_ADDR'
+  | 'P2P_UDP_LISTEN_ADDR'
+  | 'PEER_ID_PRIVATE_KEY'
+  | 'PROOF_VERIFIER_L1_START_BLOCK'
+  | 'PROOF_VERIFIER_POLL_INTERVAL_MS'
+  | 'PROVER_AGENT_CONCURRENCY'
   | 'PROVER_AGENT_ENABLED'
   | 'PROVER_AGENT_POLL_INTERVAL_MS'
-  | 'PROVER_AGENT_CONCURRENCY'
-  | 'PROVER_JOB_TIMEOUT_MS'
-  | 'PROVER_JOB_POLL_INTERVAL_MS'
+  | 'PROVER_COORDINATION_NODE_URL'
+  | 'PROVER_DISABLED'
   | 'PROVER_ID'
-  | 'WS_L2_BLOCK_QUEUE_SIZE'
-  | 'WS_PROVEN_BLOCKS_ONLY'
+  | 'PROVER_JOB_POLL_INTERVAL_MS'
+  | 'PROVER_JOB_TIMEOUT_MS'
+  | 'PROVER_JOB_SOURCE_URL'
+  | 'PROVER_NODE_POLLING_INTERVAL_MS'
+  | 'PROVER_NODE_MAX_PENDING_JOBS'
   | 'PROVER_PUBLISH_RETRY_INTERVAL_MS'
   | 'PROVER_PUBLISHER_PRIVATE_KEY'
+  | 'PROVER_REAL_PROOFS'
   | 'PROVER_REQUIRED_CONFIRMATIONS'
   | 'PROVER_TEST_DELAY_MS'
-  | 'TX_PROVIDER_NODE_URL'
-  | 'TXE_PORT'
-  | 'LOG_JSON'
-  | 'BOT_PXE_URL'
-  | 'BOT_PRIVATE_KEY'
-  | 'BOT_RECIPIENT_ENCRYPTION_SECRET'
-  | 'BOT_TOKEN_SALT'
-  | 'BOT_TX_INTERVAL_SECONDS'
-  | 'BOT_PRIVATE_TRANSFERS_PER_TX'
-  | 'BOT_PUBLIC_TRANSFERS_PER_TX'
-  | 'BOT_FEE_PAYMENT_METHOD'
-  | 'BOT_NO_START'
-  | 'BOT_TX_MINED_WAIT_SECONDS'
-  | 'BOT_NO_WAIT_FOR_TRANSFERS'
-  | 'BOT_MAX_PENDING_TXS'
-  | 'BOT_SKIP_PUBLIC_SIMULATION'
-  | 'BOT_L2_GAS_LIMIT'
-  | 'BOT_DA_GAS_LIMIT'
   | 'PXE_BLOCK_POLLING_INTERVAL_MS'
-  | 'PXE_L2_STARTING_BLOCK'
   | 'PXE_DATA_DIRECTORY'
-  | 'BB_BINARY_PATH'
-  | 'BB_WORKING_DIRECTORY'
-  | 'BB_SKIP_CLEANUP'
+  | 'PXE_L2_STARTING_BLOCK'
   | 'PXE_PROVER_ENABLED'
-  | 'BOT_FOLLOW_CHAIN'
-  | 'BOT_FLUSH_SETUP_TRANSACTIONS'
-  | 'BOT_TOKEN_CONTRACT'
-  | 'VALIDATOR_PRIVATE_KEY'
-  | 'VALIDATOR_DISABLED'
-  | 'VALIDATOR_ATTESTATIONS_WAIT_TIMEOUT_MS'
+  | 'QUOTE_PROVIDER_BASIS_POINT_FEE'
+  | 'QUOTE_PROVIDER_BOND_AMOUNT'
+  | 'QUOTE_PROVIDER_URL'
+  | 'PROVER_TARGET_ESCROW_AMOUNT'
+  | 'PROVER_MINIMUM_ESCROW_AMOUNT'
+  | 'REGISTRY_CONTRACT_ADDRESS'
+  | 'ROLLUP_CONTRACT_ADDRESS'
+  | 'SEQ_ALLOWED_SETUP_FN'
+  | 'SEQ_ALLOWED_TEARDOWN_FN'
+  | 'SEQ_MAX_BLOCK_SIZE_IN_BYTES'
+  | 'SEQ_MAX_SECONDS_BETWEEN_BLOCKS'
+  | 'SEQ_MAX_TX_PER_BLOCK'
+  | 'SEQ_MIN_SECONDS_BETWEEN_BLOCKS'
+  | 'SEQ_MIN_TX_PER_BLOCK'
+  | 'SEQ_PUBLISH_RETRY_INTERVAL_MS'
+  | 'SEQ_PUBLISHER_PRIVATE_KEY'
+  | 'SEQ_REQUIRED_CONFIRMATIONS'
+  | 'SEQ_TX_POLLING_INTERVAL_MS'
+  | 'TELEMETRY'
+  | 'TEST_ACCOUNTS'
+  | 'TX_GOSSIP_VERSION'
+  | 'TXE_PORT'
   | 'VALIDATOR_ATTESTATIONS_POOLING_INTERVAL_MS'
-  | 'PROVER_NODE_DISABLE_AUTOMATIC_PROVING'
-  | 'PROVER_NODE_MAX_PENDING_JOBS'
-  | 'PROOF_VERIFIER_POLL_INTERVAL_MS'
-  | 'PROOF_VERIFIER_L1_START_BLOCK'
-  | 'LOG_LEVEL'
-  | 'DEBUG';
+  | 'VALIDATOR_ATTESTATIONS_WAIT_TIMEOUT_MS'
+  | 'VALIDATOR_DISABLED'
+  | 'VALIDATOR_PRIVATE_KEY'
+  | 'VERSION'
+  | 'WS_BLOCK_CHECK_INTERVAL_MS'
+  | 'WS_PROVEN_BLOCKS_ONLY'
+  | 'WS_BLOCK_REQUEST_BATCH_SIZE'
+  | 'VERIFIER_VIEM_POLLING_INTERVAL_MS'
+  | 'L1_READER_VIEM_POLLING_INTERVAL_MS'
+  | 'PROVER_VIEM_POLLING_INTERVAL_MS'
+  | 'SEQ_VIEM_POLLING_INTERVAL_MS';

package/src/config/index.ts

@@ -67,6 +67,18 @@ export function numberConfigHelper(defaultVal: number): Pick<ConfigMapping, 'par
   };
 }
 
+/**
+ * Generates parseEnv and default values for a numerical config value.
+ * @param defaultVal - The default numerical value to use if the environment variable is not set or is invalid
+ * @returns Object with parseEnv and default values for a numerical config value
+ */
+export function bigintConfigHelper(defaultVal?: bigint): Pick<ConfigMapping, 'parseEnv' | 'defaultValue'> {
+  return {
+    parseEnv: (val: string) => BigInt(val),
+    defaultValue: defaultVal,
+  };
+}
+
 /**
  * Generates parseEnv for an optional numerical config value.
  */

package/src/crypto/keccak/index.ts

@@ -1,12 +1,17 @@
 import { Keccak } from 'sha3';
 
+import { Buffer32 } from '../../buffer/buffer32.js';
+
 /**
  * Computes the Keccak-256 hash of the given input buffer.
  *
  * @param input - The input buffer to be hashed.
  * @returns The computed Keccak-256 hash as a Buffer.
  */
-export function keccak256(input: Buffer) {
+export function keccak256(input: Buffer | Buffer32) {
+  if (input instanceof Buffer32) {
+    input = input.buffer;
+  }
   const hash = new Keccak(256);
   return hash.update(input).digest();
 }

package/src/decorators/index.ts

@@ -0,0 +1 @@
+export * from './memoize.js';

package/src/decorators/memoize.ts

@@ -0,0 +1,11 @@
+export function memoize<This extends object, Result>(fn: () => Result, context: ClassMethodDecoratorContext) {
+  return function (this: This) {
+    const key = `__${String(context.name)}_value`;
+    const thisWithKey = this as { [key: string]: Result };
+    if (!(key in this)) {
+      const result = fn.call(this);
+      thisWithKey[key] = result;
+    }
+    return thisWithKey[key];
+  };
+}

package/src/error/index.ts

@@ -3,14 +3,20 @@
  * This custom error class extends the built-in Error class in JavaScript and
  * can be used to handle cases where a process or task is terminated before completion.
  */
-export class InterruptError extends Error {}
+export class InterruptError extends Error {
+  public override readonly name = 'InterruptError';
+}
 
 /**
  * An error thrown when an action times out.
  */
-export class TimeoutError extends Error {}
+export class TimeoutError extends Error {
+  public override readonly name = 'TimeoutError';
+}
 
 /**
  * Represents an error thrown when an operation is aborted.
  */
-export class AbortError extends Error {}
+export class AbortError extends Error {
+  public override readonly name = 'AbortError';
+}

package/src/eth-signature/eth_signature.ts

@@ -19,6 +19,9 @@ export type ViemSignature = {
  * Contains a signature split into it's primary components (r,s,v)
  */
 export class Signature {
+  // Cached values
+  private size: number | undefined;
+
   constructor(
     /** The r value of the signature */
     public readonly r: Buffer32,
@@ -53,13 +56,17 @@ export class Signature {
 
     const r = reader.readObject(Buffer32);
     const s = reader.readObject(Buffer32);
-    const v = reader.readUInt8();
+    const v = parseInt(sig.slice(2 + 64 * 2), 16);
 
     const isEmpty = r.isZero() && s.isZero();
 
     return new Signature(r, s, v, isEmpty);
   }
 
+  static random(): Signature {
+    return new Signature(Buffer32.random(), Buffer32.random(), Math.floor(Math.random() * 2), false);
+  }
+
   static empty(): Signature {
     return new Signature(Buffer32.ZERO, Buffer32.ZERO, 0, true);
   }
@@ -69,7 +76,19 @@ export class Signature {
   }
 
   toBuffer(): Buffer {
-    return serializeToBuffer([this.r, this.s, this.v]);
+    const buffer = serializeToBuffer([this.r, this.s, this.v]);
+    this.size = buffer.length;
+    return buffer;
+  }
+
+  getSize(): number {
+    // We cache size to avoid recalculating it
+    if (this.size) {
+      return this.size;
+    }
+
+    this.size = this.toBuffer().length;
+    return this.size;
   }
 
   to0xString(): `0x${string}` {

package/src/fields/fields.ts

@@ -47,7 +47,7 @@ abstract class BaseField {
   }
 
   protected constructor(value: number | bigint | boolean | BaseField | Buffer) {
-    if (value instanceof Buffer) {
+    if (Buffer.isBuffer(value)) {
       if (value.length > BaseField.SIZE_IN_BYTES) {
         throw new Error(`Value length ${value.length} exceeds ${BaseField.SIZE_IN_BYTES}`);
       }

package/src/fields/point.ts

@@ -258,7 +258,7 @@ export class Point {
    * Check this is consistent with how bb is encoding the point at infinity
    */
   public get inf() {
-    return this.x.isZero() && this.y.isZero() && this.isInfinite;
+    return this.isInfinite;
   }
 
   isOnGrumpkin() {

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

@@ -56,10 +56,11 @@ export async function defaultFetch(
     throw new Error(`Failed to parse body as JSON: ${resp.text()}`);
   }
   if (!resp.ok) {
+    const errorMessage = `(JSON-RPC PROPAGATED) (host ${host}) (method ${rpcMethod}) (code ${resp.status}) ${responseJson.error.message}`;
     if (noRetry || (resp.status >= 400 && resp.status < 500)) {
-      throw new NoRetryError('(JSON-RPC PROPAGATED) ' + responseJson.error.message);
+      throw new NoRetryError(errorMessage);
     } else {
-      throw new Error('(JSON-RPC PROPAGATED) ' + responseJson.error.message);
+      throw new Error(errorMessage);
     }
   }
 

package/src/json-rpc/convert.ts

@@ -130,7 +130,7 @@ export function convertToJsonObj(cc: ClassConverter, obj: any): any {
   }
 
   // Is this a Node buffer?
-  if (obj instanceof Buffer) {
+  if (Buffer.isBuffer(obj)) {
     return { type: 'Buffer', data: obj.toString('base64') };
   }
 

package/src/log/logger.ts

@@ -4,15 +4,20 @@ import { inspect } from 'util';
 import { type LogData, type LogFn } from './log_fn.js';
 
 const LogLevels = ['silent', 'error', 'warn', 'info', 'verbose', 'debug'] as const;
-const DefaultLogLevel = process.env.NODE_ENV === 'test' ? ('silent' as const) : ('info' as const);
 
 /**
  * A valid log severity level.
  */
 export type LogLevel = (typeof LogLevels)[number];
 
-const envLogLevel = process.env.LOG_LEVEL?.toLowerCase() as LogLevel;
-export let currentLevel = LogLevels.includes(envLogLevel) ? envLogLevel : DefaultLogLevel;
+function getLogLevel() {
+  const envLogLevel = process.env.LOG_LEVEL?.toLowerCase() as LogLevel;
+  const defaultNonTestLogLevel = process.env.DEBUG === undefined ? ('info' as const) : ('debug' as const);
+  const defaultLogLevel = process.env.NODE_ENV === 'test' ? ('silent' as const) : defaultNonTestLogLevel;
+  return LogLevels.includes(envLogLevel) ? envLogLevel : defaultLogLevel;
+}
+
+export let currentLevel = getLogLevel();
 
 const namespaces = process.env.DEBUG ?? 'aztec:*';
 debug.enable(namespaces);
@@ -36,22 +41,31 @@ export type DebugLogger = Logger;
  * If DEBUG="[module]" env is set, will enable debug logging if the module matches.
  * Uses npm debug for debug level and console.error for other levels.
  * @param name - Name of the module.
+ * @param fixedLogData - Additional data to include in the log message.
+ * @usage createDebugLogger('aztec:validator', {validatorAddress: '0x1234...'});
+ * // will always add the validator address to the log labels
  * @returns A debug logger.
  */
-export function createDebugLogger(name: string): DebugLogger {
+
+export function createDebugLogger(name: string, fixedLogData?: LogData): DebugLogger {
   const debugLogger = debug(name);
 
+  const attatchFixedLogData = (data?: LogData) => ({ ...fixedLogData, ...data });
+
   const logger = {
     silent: () => {},
-    error: (msg: string, err?: unknown, data?: LogData) => logWithDebug(debugLogger, 'error', fmtErr(msg, err), data),
-    warn: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'warn', msg, data),
-    info: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'info', msg, data),
-    verbose: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'verbose', msg, data),
-    debug: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'debug', msg, data),
+    error: (msg: string, err?: unknown, data?: LogData) =>
+      logWithDebug(debugLogger, 'error', fmtErr(msg, err), attatchFixedLogData(data)),
+    warn: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'warn', msg, attatchFixedLogData(data)),
+    info: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'info', msg, attatchFixedLogData(data)),
+    verbose: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'verbose', msg, attatchFixedLogData(data)),
+    debug: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'debug', msg, attatchFixedLogData(data)),
   };
-  return Object.assign((msg: string, data?: LogData) => logWithDebug(debugLogger, 'debug', msg, data), logger);
+  return Object.assign(
+    (msg: string, data?: LogData) => logWithDebug(debugLogger, 'debug', msg, attatchFixedLogData(data)),
+    logger,
+  );
 }
-
 /** A callback to capture all logs. */
 export type LogHandler = (level: LogLevel, namespace: string, msg: string, data?: LogData) => void;
 
@@ -101,7 +115,7 @@ function fmtErr(msg: string, err?: Error | unknown): string {
  * Formats structured log data as a string for console output.
  * @param data - Optional log data.
  */
-function fmtLogData(data?: LogData): string {
+export function fmtLogData(data?: LogData): string {
   return Object.entries(data ?? {})
     .map(([key, value]) => `${key}=${typeof value === 'object' && 'toString' in value ? value.toString() : value}`)
     .join(' ');

package/src/promise/running-promise.ts

@@ -1,4 +1,5 @@
 import { InterruptibleSleep } from '../sleep/index.js';
+import { type PromiseWithResolvers, promiseWithResolvers } from './utils.js';
 
 /**
  * RunningPromise is a utility class that helps manage the execution of an asynchronous function
@@ -9,6 +10,7 @@ export class RunningPromise {
   private running = false;
   private runningPromise = Promise.resolve();
   private interruptibleSleep = new InterruptibleSleep();
+  private requested: PromiseWithResolvers<void> | undefined = undefined;
 
   constructor(private fn: () => void | Promise<void>, private pollingIntervalMS = 10000) {}
 
@@ -20,8 +22,19 @@ export class RunningPromise {
 
     const poll = async () => {
       while (this.running) {
+        const hasRequested = this.requested !== undefined;
         await this.fn();
-        await this.interruptibleSleep.sleep(this.pollingIntervalMS);
+
+        // If an immediate run had been requested *before* the function started running, resolve the request.
+        if (hasRequested) {
+          this.requested!.resolve();
+          this.requested = undefined;
+        }
+
+        // If no immediate run was requested, sleep for the polling interval.
+        if (this.requested === undefined) {
+          await this.interruptibleSleep.sleep(this.pollingIntervalMS);
+        }
       }
     };
     this.runningPromise = poll();
@@ -45,6 +58,24 @@ export class RunningPromise {
     return this.running;
   }
 
+  /**
+   * Triggers an immediate run of the function, bypassing the polling interval.
+   * If the function is currently running, it will be allowed to continue and then called again immediately.
+   */
+  public async trigger() {
+    if (!this.running) {
+      return this.fn();
+    }
+
+    let requested = this.requested;
+    if (!requested) {
+      requested = promiseWithResolvers<void>();
+      this.requested = requested;
+      this.interruptibleSleep.interrupt();
+    }
+    await requested!.promise;
+  }
+
   /**
    * Updates the polling interval. The new interval will take effect after the next poll.
    * @param pollingIntervalMS The polling interval in milliseconds.

package/src/queue/base_memory_queue.ts

@@ -24,6 +24,14 @@ export abstract class BaseMemoryQueue<T> {
     return this.items.length;
   }
 
+  /**
+   * Returns next item within the queue, or undefined if the queue is empty. Does not block.
+   * @returns The next item in the queue.
+   */
+  public getImmediate(): T | undefined {
+    return this.items.get();
+  }
+
   /**
    * Returns next item within the queue, or blocks until an item has been put into the queue.
    *

package/src/testing/test_data.ts

@@ -8,7 +8,7 @@ const testData: { [key: string]: unknown[] } = {};
 
 /** Returns whether test data generation is enabled */
 export function isGenerateTestDataEnabled() {
-  return process.env.AZTEC_GENERATE_TEST_DATA === '1' && typeof expect !== 'undefined';
+  return ['1', 'true'].includes(process.env.AZTEC_GENERATE_TEST_DATA ?? '') && typeof expect !== 'undefined';
 }
 
 /** Pushes test data with the given name, only if test data generation is enabled. */

package/src/types/index.ts

@@ -15,3 +15,8 @@ export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
 /** Removes readonly modifiers for a type. */
 export type Writeable<T> = { -readonly [P in keyof T]: T[P] };
+
+/** Removes readonly modifiers for an object. */
+export function unfreeze<T>(obj: T): Writeable<T> {
+  return obj as Writeable<T>;
+}