@aztec/foundation 0.65.2 → 0.66.0

package/dest/queue/bounded_serial_queue.d.ts

@@ -6,7 +6,7 @@ export declare class BoundedSerialQueue {
     private log;
     private readonly queue;
     private semaphore;
-    constructor(maxQueueSize: number, log?: import("../log/logger.js").Logger);
+    constructor(maxQueueSize: number, log?: import("../log/pino-logger.js").Logger);
     /**
      * Initializes the underlying SerialQueue instance, allowing items to be processed from the queue.
      * The start method should be called before using the BoundedSerialQueue to ensure proper functionality.

package/dest/queue/bounded_serial_queue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bounded_serial_queue.d.ts","sourceRoot":"","sources":["../../src/queue/bounded_serial_queue.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,qBAAa,kBAAkB;IAIK,OAAO,CAAC,GAAG;IAH7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAC3C,OAAO,CAAC,SAAS,CAAY;gBAEjB,YAAY,EAAE,MAAM,EAAU,GAAG,oCAA6D;IAI1G;;;OAGG;IACI,KAAK;IAIZ;;;;;OAKG;IACI,MAAM;IAIb;;;;;OAKG;IACI,MAAM;IAIb;;;;;;;OAOG;IACI,GAAG;IAIV;;;;;OAKG;IACU,GAAG,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAexD;;;;OAIG;IACU,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAWtD;;OAEG;IACU,SAAS;CAGvB"}
+{"version":3,"file":"bounded_serial_queue.d.ts","sourceRoot":"","sources":["../../src/queue/bounded_serial_queue.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,qBAAa,kBAAkB;IAIK,OAAO,CAAC,GAAG;IAH7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;IAC3C,OAAO,CAAC,SAAS,CAAY;gBAEjB,YAAY,EAAE,MAAM,EAAU,GAAG,yCAA6D;IAI1G;;;OAGG;IACI,KAAK;IAIZ;;;;;OAKG;IACI,MAAM;IAIb;;;;;OAKG;IACI,MAAM;IAIb;;;;;;;OAOG;IACI,GAAG;IAIV;;;;;OAKG;IACU,GAAG,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAexD;;;;OAIG;IACU,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAWtD;;OAEG;IACU,SAAS;CAGvB"}

package/dest/queue/fifo_memory_queue.d.ts

@@ -1,4 +1,4 @@
-import { type DebugLogger } from '../log/logger.js';
+import { type DebugLogger } from '../log/index.js';
 import { BaseMemoryQueue } from './base_memory_queue.js';
 /**
  * A simple fifo queue. It can grow unbounded. It can have multiple producers and consumers.

package/dest/queue/fifo_memory_queue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fifo_memory_queue.d.ts","sourceRoot":"","sources":["../../src/queue/fifo_memory_queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC,CAAE,SAAQ,eAAe,CAAC,CAAC,CAAC;IACxD,OAAO,CAAC,SAAS,CAAsB;gBAE3B,GAAG,CAAC,EAAE,WAAW;IAI7B,cAAuB,KAAK,iBAE3B;CACF;AAED,cAAM,SAAS,CAAC,CAAC;IACf,OAAO,CAAC,KAAK,CAAW;IAEjB,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI;IAIlB,GAAG,IAAI,CAAC,GAAG,SAAS;IAI3B,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,KAAK;CAGb"}
+{"version":3,"file":"fifo_memory_queue.d.ts","sourceRoot":"","sources":["../../src/queue/fifo_memory_queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC,CAAE,SAAQ,eAAe,CAAC,CAAC,CAAC;IACxD,OAAO,CAAC,SAAS,CAAsB;gBAE3B,GAAG,CAAC,EAAE,WAAW;IAI7B,cAAuB,KAAK,iBAE3B;CACF;AAED,cAAM,SAAS,CAAC,CAAC;IACf,OAAO,CAAC,KAAK,CAAW;IAEjB,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI;IAIlB,GAAG,IAAI,CAAC,GAAG,SAAS;IAI3B,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,KAAK;CAGb"}

package/dest/retry/index.d.ts

@@ -28,7 +28,7 @@ export declare function makeBackoff(retries: number[]): Generator<number, void,
  * @returns A Promise that resolves with the successful result of the provided function, or rejects if backoff generator ends.
  * @throws If `NoRetryError` is thrown by the `fn`, it is rethrown.
  */
-export declare function retry<Result>(fn: () => Promise<Result>, name?: string, backoff?: Generator<number, void, unknown>, log?: import("../log/logger.js").Logger, failSilently?: boolean): Promise<Result>;
+export declare function retry<Result>(fn: () => Promise<Result>, name?: string, backoff?: Generator<number, void, unknown>, log?: import("../log/pino-logger.js").Logger, failSilently?: boolean): Promise<Result>;
 /**
  * Retry an asynchronous function until it returns a truthy value or the specified timeout is exceeded.
  * The function is retried periodically with a fixed interval between attempts. The operation can be named for better error messages.

package/dest/retry/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/retry/index.ts"],"names":[],"mappings":"AAIA,wEAAwE;AACxE,qBAAa,YAAa,SAAQ,KAAK;CAAG;AAE1C;;;;;;;GAOG;AACH,wBAAiB,gBAAgB,qCAMhC;AAED;;;;GAIG;AACH,wBAAiB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,oCAI7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,KAAK,CAAC,MAAM,EAChC,EAAE,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACzB,IAAI,SAAc,EAClB,OAAO,mCAAqB,EAC5B,GAAG,oCAA8C,EACjD,YAAY,UAAQ,mBAoBrB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,IAAI,SAAK,EAAE,OAAO,SAAI,EAAE,QAAQ,SAAI,oCAczG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/retry/index.ts"],"names":[],"mappings":"AAIA,wEAAwE;AACxE,qBAAa,YAAa,SAAQ,KAAK;CAAG;AAE1C;;;;;;;GAOG;AACH,wBAAiB,gBAAgB,qCAMhC;AAED;;;;GAIG;AACH,wBAAiB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,oCAI7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,KAAK,CAAC,MAAM,EAChC,EAAE,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACzB,IAAI,SAAc,EAClB,OAAO,mCAAqB,EAC5B,GAAG,yCAA8C,EACjD,YAAY,UAAQ,mBAoBrB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,IAAI,SAAK,EAAE,OAAO,SAAI,EAAE,QAAQ,SAAI,oCAczG"}

package/dest/transport/dispatch/create_dispatch_fn.d.ts

@@ -21,5 +21,5 @@ export interface DispatchMsg {
  * @param log - Optional logging function for debugging purposes.
  * @returns A dispatch function that accepts a DispatchMsg object and calls the target's method with provided arguments.
  */
-export declare function createDispatchFn(targetFn: () => any, log?: import("../../log/logger.js").Logger): ({ fn, args }: DispatchMsg) => Promise<any>;
+export declare function createDispatchFn(targetFn: () => any, log?: import("../../log/pino-logger.js").Logger): ({ fn, args }: DispatchMsg) => Promise<any>;
 //# sourceMappingURL=create_dispatch_fn.d.ts.map

package/dest/transport/dispatch/create_dispatch_fn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create_dispatch_fn.d.ts","sourceRoot":"","sources":["../../../src/transport/dispatch/create_dispatch_fn.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,EAAE,GAAG,uCAAiD,kBAC5E,WAAW,kBAKxC"}
+{"version":3,"file":"create_dispatch_fn.d.ts","sourceRoot":"","sources":["../../../src/transport/dispatch/create_dispatch_fn.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,EAAE,GAAG,4CAAiD,kBAC5E,WAAW,kBAKxC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/foundation",
-  "version": "0.65.2",
+  "version": "0.66.0",
   "packageManager": "yarn@3.4.1",
   "type": "module",
   "main": "./dest/index.js",
@@ -11,6 +11,7 @@
     "./prettier": "./.prettierrc.json",
     "./abi": "./dest/abi/index.js",
     "./async-map": "./dest/async-map/index.js",
+    "./async-pool": "./dest/async-pool/index.js",
     "./aztec-address": "./dest/aztec-address/index.js",
     "./collection": "./dest/collection/index.js",
     "./config": "./dest/config/index.js",
@@ -98,10 +99,11 @@
     ]
   },
   "dependencies": {
-    "@aztec/bb.js": "0.65.2",
+    "@aztec/bb.js": "0.66.0",
     "@koa/cors": "^5.0.0",
     "@noble/curves": "^1.2.0",
     "bn.js": "^5.2.1",
+    "colorette": "^2.0.20",
     "debug": "^4.3.4",
     "detect-node": "^2.1.0",
     "elliptic": "^6.5.4",
@@ -116,6 +118,8 @@
     "lodash.clonedeepwith": "^4.5.0",
     "memdown": "^6.1.1",
     "pako": "^2.1.0",
+    "pino": "^9.5.0",
+    "pino-pretty": "^13.0.0",
     "sha3": "^2.1.4",
     "zod": "^3.23.8"
   },

package/src/async-pool/index.ts

@@ -0,0 +1,50 @@
+/*
+ * Adapted from https://github.com/rxaviers/async-pool/blob/1.x/lib/es6.js
+ *
+ * Copyright (c) 2017 Rafael Xavier de Souza http://rafael.xavier.blog.br
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/** Executes the given async function over the iterable, up to a determined number of promises in parallel. */
+export function asyncPool<T, R>(poolLimit: number, iterable: T[], iteratorFn: (item: T, iterable: T[]) => Promise<R>) {
+  let i = 0;
+  const ret: Promise<R>[] = [];
+  const executing: Set<Promise<R>> = new Set();
+  const enqueue = (): Promise<any> => {
+    if (i === iterable.length) {
+      return Promise.resolve();
+    }
+    const item = iterable[i++];
+    const p = Promise.resolve().then(() => iteratorFn(item, iterable));
+    ret.push(p);
+    executing.add(p);
+    const clean = () => executing.delete(p);
+    p.then(clean).catch(clean);
+    let r: Promise<any> = Promise.resolve();
+    if (executing.size >= poolLimit) {
+      r = Promise.race(executing);
+    }
+    return r.then(() => enqueue());
+  };
+  return enqueue().then(() => Promise.all(ret));
+}

package/src/collection/array.ts

@@ -75,6 +75,20 @@ export function times<T>(n: number, fn: (i: number) => T): T[] {
   return [...Array(n).keys()].map(i => fn(i));
 }
 
+/**
+ * Executes the given async function n times and returns the results in an array. Awaits each execution before starting the next one.
+ * @param n - How many times to repeat.
+ * @param fn - Mapper from index to value.
+ * @returns The array with the result from all executions.
+ */
+export async function timesAsync<T>(n: number, fn: (i: number) => Promise<T>): Promise<T[]> {
+  const results: T[] = [];
+  for (let i = 0; i < n; i++) {
+    results.push(await fn(i));
+  }
+  return results;
+}
+
 /**
  * Returns the serialized size of all non-empty items in an array.
  * @param arr - Array
@@ -121,3 +135,13 @@ export function areArraysEqual<T>(a: T[], b: T[], eq: (a: T, b: T) => boolean =
   }
   return true;
 }
+
+/**
+ * Returns the element of the array that has the maximum value of the given function.
+ * In case of a tie, returns the first element with the maximum value.
+ * @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 {
+  return arr.reduce((max, x) => (fn(x) > fn(max) ? x : max), arr[0]);
+}

package/src/config/env_var.ts

@@ -8,6 +8,7 @@ export type EnvVar =
   | 'ARCHIVER_POLLING_INTERVAL_MS'
   | 'ARCHIVER_URL'
   | 'ARCHIVER_VIEM_POLLING_INTERVAL_MS'
+  | 'ARCHIVER_BATCH_SIZE'
   | 'ASSUME_PROVEN_THROUGH_BLOCK_NUMBER'
   | 'AZTEC_NODE_URL'
   | 'AZTEC_PORT'
@@ -91,6 +92,7 @@ export type EnvVar =
   | 'P2P_TCP_LISTEN_ADDR'
   | 'P2P_TCP_ANNOUNCE_ADDR'
   | 'P2P_TX_POOL_KEEP_PROVEN_FOR'
+  | 'P2P_ATTESTATION_POOL_KEEP_FOR'
   | 'P2P_TX_PROTOCOL'
   | 'P2P_UDP_ANNOUNCE_ADDR'
   | 'P2P_UDP_LISTEN_ADDR'
@@ -115,6 +117,7 @@ export type EnvVar =
   | 'PROVER_JOB_TIMEOUT_MS'
   | 'PROVER_NODE_POLLING_INTERVAL_MS'
   | 'PROVER_NODE_MAX_PENDING_JOBS'
+  | 'PROVER_NODE_MAX_PARALLEL_BLOCKS_PER_EPOCH'
   | 'PROVER_PUBLISH_RETRY_INTERVAL_MS'
   | 'PROVER_PUBLISHER_PRIVATE_KEY'
   | 'PROVER_REAL_PROOFS'
@@ -143,6 +146,7 @@ export type EnvVar =
   | 'SEQ_REQUIRED_CONFIRMATIONS'
   | 'SEQ_TX_POLLING_INTERVAL_MS'
   | 'SEQ_ENFORCE_TIME_TABLE'
+  | 'STAKING_ASSET_CONTRACT_ADDRESS'
   | 'REWARD_DISTRIBUTOR_CONTRACT_ADDRESS'
   | 'TELEMETRY'
   | 'TEST_ACCOUNTS'
@@ -168,4 +172,14 @@ export type EnvVar =
   | 'AZTEC_SLOT_DURATION'
   | 'AZTEC_EPOCH_DURATION'
   | 'AZTEC_TARGET_COMMITTEE_SIZE'
-  | 'AZTEC_EPOCH_PROOF_CLAIM_WINDOW_IN_L2_SLOTS';
+  | 'AZTEC_EPOCH_PROOF_CLAIM_WINDOW_IN_L2_SLOTS'
+  | 'L1_GAS_LIMIT_BUFFER_PERCENTAGE'
+  | 'L1_GAS_LIMIT_BUFFER_FIXED'
+  | 'L1_GAS_PRICE_MIN'
+  | 'L1_GAS_PRICE_MAX'
+  | 'L1_PRIORITY_FEE_BUMP_PERCENTAGE'
+  | 'L1_PRIORITY_FEE_RETRY_BUMP_PERCENTAGE'
+  | 'L1_TX_MONITOR_MAX_ATTEMPTS'
+  | 'L1_TX_MONITOR_CHECK_INTERVAL_MS'
+  | 'L1_TX_MONITOR_STALL_TIME_MS'
+  | 'L1_TX_MONITOR_TX_TIMEOUT_MS';

package/src/crypto/random/randomness_singleton.ts

@@ -1,4 +1,4 @@
-import { createDebugLogger } from '../../log/logger.js';
+import { createDebugLogger } from '../../log/pino-logger.js';
 
 /**
  * A number generator which is used as a source of randomness in the system. If the SEED env variable is set, the

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

@@ -1,6 +1,6 @@
 import { format } from 'util';
 
-import { createDebugLogger } from '../../log/logger.js';
+import { createDebugLogger } from '../../log/pino-logger.js';
 import { type ApiSchema, type ApiSchemaFor, schemaHasMethod } from '../../schemas/api.js';
 import { defaultFetch } from './fetch.js';
 

package/src/log/index.ts

@@ -1,5 +1,5 @@
 export * from './console.js';
 export * from './debug.js';
-export * from './logger.js';
+export * from './pino-logger.js';
 export * from './log_history.js';
 export * from './log_fn.js';

package/src/log/log-filters.ts

@@ -0,0 +1,49 @@
+import { type LogLevel, LogLevels } from './log-levels.js';
+
+export type LogFilters = [string, LogLevel][];
+
+export function getLogLevelFromFilters(filters: LogFilters, module: string): LogLevel | undefined {
+  for (const [filterModule, level] of filters) {
+    if (module.startsWith(filterModule)) {
+      return level as LogLevel;
+    }
+  }
+  return undefined;
+}
+
+export function assertLogLevel(level: string): asserts level is LogLevel {
+  if (!LogLevels.includes(level as LogLevel)) {
+    throw new Error(`Invalid log level: ${level}`);
+  }
+}
+
+export function parseEnv(env: string | undefined, defaultLevel: LogLevel): [LogLevel, LogFilters] {
+  if (!env) {
+    return [defaultLevel, []];
+  }
+  const [level] = env.split(';', 1);
+  assertLogLevel(level);
+  return [level, parseFilters(env.slice(level.length + 1))];
+}
+
+export function parseFilters(definition: string | undefined): LogFilters {
+  if (!definition) {
+    return [];
+  }
+
+  const statements = definition.split(';');
+  const filters: LogFilters = [];
+  for (const statement of statements) {
+    const [level] = statement.split(':', 1);
+    const modules = statement.slice(level.length + 1);
+    if (!modules || !level) {
+      throw new Error(`Invalid log filter statement: ${statement}`);
+    }
+    const sanitizedLevel = level.trim().toLowerCase();
+    assertLogLevel(sanitizedLevel);
+    for (const module of modules.split(',')) {
+      filters.push([module.trim().toLowerCase(), sanitizedLevel as LogLevel | 'silent']);
+    }
+  }
+  return filters.reverse();
+}

package/src/log/log-levels.ts

@@ -0,0 +1,3 @@
+export const LogLevels = ['silent', 'fatal', 'error', 'warn', 'info', 'verbose', 'debug', 'trace'] as const;
+
+export type LogLevel = (typeof LogLevels)[number];

package/src/log/pino-logger.ts

@@ -0,0 +1,196 @@
+import { createColors } from 'colorette';
+import isNode from 'detect-node';
+import { pino, symbols } from 'pino';
+import pretty from 'pino-pretty';
+import { type Writable } from 'stream';
+import { inspect } from 'util';
+
+import { compactArray } from '../collection/array.js';
+import { getLogLevelFromFilters, parseEnv } from './log-filters.js';
+import { type LogLevel } from './log-levels.js';
+import { type LogData, type LogFn } from './log_fn.js';
+
+// TODO(palla/log): Rename to createLogger
+export function createDebugLogger(module: string): DebugLogger {
+  // TODO(palla/log): Rename all module names to remove the aztec prefix
+  const pinoLogger = logger.child(
+    { module: module.replace(/^aztec:/, '') },
+    { level: getLogLevelFromFilters(logFilters, module) },
+  );
+
+  // We check manually for isLevelEnabled to avoid calling processLogData unnecessarily.
+  // Note that isLevelEnabled is missing from the browser version of pino.
+  const logFn = (level: LogLevel, msg: string, data?: LogData) =>
+    isLevelEnabled(pinoLogger, level) && pinoLogger[level](processLogData(data ?? {}), msg);
+
+  return {
+    silent: () => {},
+    // TODO(palla/log): Should we move err to data instead of the text message?
+    /** Log as fatal. Use when an error has brought down the system. */
+    fatal: (msg: string, err?: unknown, data?: LogData) => logFn('fatal', formatErr(msg, err), data),
+    /** Log as error. Use for errors in general. */
+    error: (msg: string, err?: unknown, data?: LogData) => logFn('error', formatErr(msg, err), data),
+    /** Log as warn. Use for when we stray from the happy path. */
+    warn: (msg: string, data?: LogData) => logFn('warn', msg, data),
+    /** Log as info. Use for providing an operator with info on what the system is doing. */
+    info: (msg: string, data?: LogData) => logFn('info', msg, data),
+    /** Log as verbose. Use for when we need additional insight on what a subsystem is doing. */
+    verbose: (msg: string, data?: LogData) => logFn('verbose', msg, data),
+    /** Log as debug. Use for when we need debugging info to troubleshoot an issue on a specific component. */
+    debug: (msg: string, data?: LogData) => logFn('debug', msg, data),
+    /** Log as trace. Use for when we want to denial-of-service any recipient of the logs. */
+    trace: (msg: string, data?: LogData) => logFn('trace', msg, data),
+    level: pinoLogger.level as LogLevel,
+    isLevelEnabled: (level: LogLevel) => isLevelEnabled(pinoLogger, level),
+  };
+}
+
+// Allow global hooks for processing log data.
+// Used for injecting OTEL trace_id in telemetry client.
+type LogDataHandler = (data: LogData) => LogData;
+const logDataHandlers: LogDataHandler[] = [];
+
+export function addLogDataHandler(handler: LogDataHandler): void {
+  logDataHandlers.push(handler);
+}
+
+function processLogData(data: LogData): LogData {
+  return logDataHandlers.reduce((accum, handler) => handler(accum), data);
+}
+
+// Patch isLevelEnabled missing from pino/browser.
+function isLevelEnabled(logger: pino.Logger<'verbose', boolean>, level: LogLevel): boolean {
+  return typeof logger.isLevelEnabled === 'function'
+    ? logger.isLevelEnabled(level)
+    : logger.levels.values[level] >= logger.levels.values[logger.level];
+}
+
+// Load log levels from environment variables.
+const defaultLogLevel = process.env.NODE_ENV === 'test' ? 'silent' : 'info';
+const [logLevel, logFilters] = parseEnv(process.env.LOG_LEVEL, defaultLogLevel);
+
+// Transport options for pretty logging to stderr via pino-pretty.
+const useColor = true;
+const { bold, reset } = createColors({ useColor });
+const pinoPrettyOpts = {
+  destination: 2,
+  sync: true,
+  colorize: useColor,
+  ignore: 'module,pid,hostname,trace_id,span_id,trace_flags',
+  messageFormat: `${bold('{module}')} ${reset('{msg}')}`,
+  customLevels: 'fatal:60,error:50,warn:40,info:30,verbose:25,debug:20,trace:10',
+  customColors: 'fatal:bgRed,error:red,warn:yellow,info:green,verbose:magenta,debug:blue,trace:gray',
+  minimumLevel: 'trace' as const,
+};
+const prettyTransport: pino.TransportSingleOptions = {
+  target: 'pino-pretty',
+  options: pinoPrettyOpts,
+};
+
+// Transport for vanilla stdio logging as JSON.
+const stdioTransport: pino.TransportSingleOptions = {
+  target: 'pino/file',
+  options: { destination: 2 },
+};
+
+// Define custom logging levels for pino.
+const customLevels = { verbose: 25 };
+const pinoOpts = { customLevels, useOnlyCustomLevels: false, level: logLevel };
+
+export const levels = {
+  labels: { ...pino.levels.labels, ...Object.fromEntries(Object.entries(customLevels).map(e => e.reverse())) },
+  values: { ...pino.levels.values, ...customLevels },
+};
+
+// Transport for OpenTelemetry logging. While defining this here is an abstraction leakage since this
+// should live in the telemetry-client, it is necessary to ensure that the logger is initialized with
+// the correct transport. Tweaking transports of a live pino instance is tricky, and creating a new instance
+// would mean that all child loggers created before the telemetry-client is initialized would not have
+// this transport configured. Note that the target is defined as the export in the telemetry-client,
+// since pino will load this transport separately on a worker thread, to minimize disruption to the main loop.
+const otlpEndpoint = process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT;
+const otelOpts = { levels };
+const otelTransport: pino.TransportSingleOptions = {
+  target: '@aztec/telemetry-client/otel-pino-stream',
+  options: otelOpts,
+};
+
+function makeLogger() {
+  if (!isNode) {
+    // We are on the browser
+    return pino({ ...pinoOpts, browser: { asObject: false } });
+  } else if (process.env.JEST_WORKER_ID) {
+    // We are on jest, so we need sync logging. We stream to stderr with pretty.
+    return pino(pinoOpts, pretty(pinoPrettyOpts));
+  } else {
+    // Regular nodejs with transports on worker thread, using pino-pretty for console logging if LOG_JSON
+    // is not set, and an optional OTLP transport if the OTLP endpoint is provided.
+    const targets: pino.TransportSingleOptions[] = compactArray([
+      ['1', 'true', 'TRUE'].includes(process.env.LOG_JSON ?? '') ? stdioTransport : prettyTransport,
+      otlpEndpoint ? otelTransport : undefined,
+    ]);
+    return pino(pinoOpts, pino.transport({ targets }));
+  }
+}
+
+const logger = makeLogger();
+
+// Log the logger configuration.
+logger.verbose(
+  {
+    module: 'logger',
+    ...logFilters.reduce((accum, [module, level]) => ({ ...accum, [`log.${module}`]: level }), {}),
+  },
+  isNode
+    ? `Logger initialized with level ${logLevel}` + (otlpEndpoint ? ` with OTLP exporter to ${otlpEndpoint}` : '')
+    : `Browser console logger initialized with level ${logLevel}`,
+);
+
+/**
+ * Registers an additional destination to the pino logger.
+ * Use only when working with destinations, not worker transports.
+ */
+export function registerLoggingStream(stream: Writable): void {
+  logger.verbose({ module: 'logger' }, `Registering additional logging stream`);
+  const original = (logger as any)[symbols.streamSym];
+  const destination = original
+    ? pino.multistream(
+        [
+          // Set streams to lowest logging level, and control actual logging from the parent logger
+          // otherwise streams default to info and refuse to log anything below that.
+          { level: 'trace', stream: original },
+          { level: 'trace', stream },
+        ],
+        { levels: levels.values },
+      )
+    : stream;
+  (logger as any)[symbols.streamSym] = destination;
+}
+
+/** Log function that accepts an exception object */
+type ErrorLogFn = (msg: string, err?: Error | unknown, data?: LogData) => void;
+
+/**
+ * Logger that supports multiple severity levels.
+ */
+export type Logger = { [K in LogLevel]: LogFn } & { /** Error log function */ error: ErrorLogFn } & {
+  level: LogLevel;
+  isLevelEnabled: (level: LogLevel) => boolean;
+};
+
+/**
+ * Logger that supports multiple severity levels and can be called directly to issue a debug statement.
+ * Intended as a drop-in replacement for the debug module.
+ * TODO(palla/log): Remove this alias
+ */
+export type DebugLogger = Logger;
+
+/**
+ * Concatenates a log message and an exception.
+ * @param msg - Log message
+ * @param err - Error to log
+ * @returns A string with both the log message and the error message.
+ */
+function formatErr(msg: string, err?: Error | unknown): string {
+  return err ? `${msg}: ${inspect(err)}` : msg;
+}

package/src/queue/fifo_memory_queue.ts

@@ -1,4 +1,4 @@
-import { type DebugLogger } from '../log/logger.js';
+import { type DebugLogger } from '../log/index.js';
 import { BaseMemoryQueue } from './base_memory_queue.js';
 
 /**

package/dest/log/logger.d.ts

@@ -1,57 +0,0 @@
-import { type LogData, type LogFn } from './log_fn.js';
-declare const LogLevels: readonly ["silent", "error", "warn", "info", "verbose", "debug"];
-/**
- * A valid log severity level.
- */
-export type LogLevel = (typeof LogLevels)[number];
-export declare let currentLevel: "silent" | "error" | "warn" | "info" | "verbose" | "debug";
-/** Log function that accepts an exception object */
-type ErrorLogFn = (msg: string, err?: Error | unknown, data?: LogData) => void;
-/**
- * Logger that supports multiple severity levels.
- */
-export type Logger = {
-    [K in LogLevel]: LogFn;
-} & {
-    error: ErrorLogFn;
-};
-/**
- * Logger that supports multiple severity levels and can be called directly to issue a debug statement.
- * Intended as a drop-in replacement for the debug module.
- */
-export type DebugLogger = Logger;
-/**
- * Creates a new DebugLogger for the current module, defaulting to the LOG_LEVEL env var.
- * 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');
- * // will always add the validator address to the log labels
- * @returns A debug logger.
- */
-export declare function createDebugLogger(name: string): DebugLogger;
-/**
- * A function to create a logger that automatically includes fixed data in each log entry.
- * @param debugLogger - The base DebugLogger instance to which we attach fixed log data.
- * @param fixedLogData - The data to be included in every log entry.
- * @returns A DebugLogger with log level methods (error, warn, info, verbose, debug) that
- * automatically attach `fixedLogData` to every log message.
- */
-export declare function attachedFixedDataToLogger(debugLogger: DebugLogger, fixedLogData: LogData): DebugLogger;
-/** A callback to capture all logs. */
-export type LogHandler = (level: LogLevel, namespace: string, msg: string, data?: LogData) => void;
-/**
- * Registers a callback for all logs, whether they are emitted in the current log level or not.
- * @param handler - Callback to be called on every log.
- */
-export declare function onLog(handler: LogHandler): void;
-/** Overrides current log level. */
-export declare function setLevel(level: LogLevel): void;
-/**
- * Formats structured log data as a string for console output.
- * @param data - Optional log data.
- */
-export declare function fmtLogData(data?: LogData): string;
-export {};
-//# sourceMappingURL=logger.d.ts.map

package/dest/log/logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/log/logger.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,aAAa,CAAC;AAEvD,QAAA,MAAM,SAAS,kEAAmE,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAelD,eAAO,IAAI,YAAY,4DAAgB,CAAC;AAwBxC,oDAAoD;AACpD,KAAK,UAAU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;KAAG,CAAC,IAAI,QAAQ,GAAG,KAAK;CAAE,GAAG;IAA4B,KAAK,EAAE,UAAU,CAAA;CAAE,CAAC;AAElG;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;;;;;;;;GASG;AAEH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAqB3D;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,GAAG,WAAW,CActG;AAED,sCAAsC;AACtC,MAAM,MAAM,UAAU,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAInG;;;GAGG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,UAAU,QAExC;AAED,mCAAmC;AACnC,wBAAgB,QAAQ,CAAC,KAAK,EAAE,QAAQ,QAEvC;AAkCD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAIjD"}