@aztec/foundation 0.32.1 → 0.34.0

package/src/log/logger.ts

@@ -4,8 +4,7 @@ import { isatty } from 'tty';
 
 import { type LogData, type LogFn } from './log_fn.js';
 
-// Matches a subset of Winston log levels
-const LogLevels = ['silent', 'error', 'warn', 'info', 'verbose', 'debug', 'trace'] as const;
+const LogLevels = ['silent', 'error', 'warn', 'info', 'verbose', 'debug'] as const;
 const DefaultLogLevel = process.env.NODE_ENV === 'test' ? ('silent' as const) : ('info' as const);
 
 /**
@@ -28,7 +27,7 @@ export type Logger = { [K in LogLevel]: LogFn } & { /** Error log function */ er
  * 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 = LogFn & Logger;
+export type DebugLogger = Logger;
 
 /**
  * Creates a new DebugLogger for the current module, defaulting to the LOG_LEVEL env var.
@@ -50,7 +49,6 @@ export function createDebugLogger(name: string): DebugLogger {
     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),
-    trace: (msg: string, data?: LogData) => logWithDebug(debugLogger, 'trace', msg, data),
   };
   return Object.assign((msg: string, data?: LogData) => logWithDebug(debugLogger, 'debug', msg, data), logger);
 }
@@ -112,7 +110,8 @@ function getPrefix(debugLogger: debug.Debugger, level: LogLevel) {
  * @param msg - What to log.
  */
 function printLog(msg: string) {
-  process.stderr.write(msg + '\n');
+  // eslint-disable-next-line no-console
+  isNode ? process.stderr.write(msg + '\n') : console.error(msg);
 }
 
 /**

package/src/retry/index.ts

@@ -63,7 +63,7 @@ export async function retry<Result>(
       if (s === undefined) {
         throw err;
       }
-      log(`${name} failed. Will retry in ${s}s...`);
+      log.verbose(`${name} failed. Will retry in ${s}s...`);
       !failSilently && log.error(err);
       await sleep(s * 1000);
       continue;

package/src/sleep/index.ts

@@ -67,8 +67,9 @@ export class InterruptibleSleep {
  * The sleep function can be interrupted by the 'interrupt' method of the InterruptibleSleep class.
  *
  * @param ms - The duration in milliseconds for which the sleep operation should last.
+ * @param returnValue - The return value of the promise.
  * @returns A Promise that resolves after the specified duration, allowing the use of 'await' to pause execution.
  */
-export function sleep(ms: number) {
-  return new Promise(resolve => setTimeout(resolve, ms));
+export function sleep<T>(ms: number, returnValue?: T): Promise<T | undefined> {
+  return new Promise(resolve => setTimeout(() => resolve(returnValue), ms));
 }

package/src/transport/dispatch/create_dispatch_fn.ts

@@ -23,13 +23,13 @@ export interface DispatchMsg {
  * the method to be called ('fn') and an array of arguments to be passed to the method ('args').
  *
  * @param targetFn - A function that returns the target object containing the methods to be dispatched.
- * @param debug - Optional logging function for debugging purposes.
+ * @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 function createDispatchFn(targetFn: () => any, debug = createDebugLogger('aztec:foundation:dispatch')) {
+export function createDispatchFn(targetFn: () => any, log = createDebugLogger('aztec:foundation:dispatch')) {
   return async ({ fn, args }: DispatchMsg) => {
     const target = targetFn();
-    debug(format(`dispatching to ${target}: ${fn}`, args));
+    log.debug(format(`dispatching to ${target}: ${fn}`, args));
     return await target[fn](...args);
   };
 }

package/src/transport/transport_client.ts

@@ -6,7 +6,7 @@ import { type EventMessage, type ResponseMessage, isEventMessage } from './dispa
 import { type Connector } from './interface/connector.js';
 import { type Socket } from './interface/socket.js';
 
-const debug = createDebugLogger('aztec:transport_client');
+const log = createDebugLogger('aztec:transport_client');
 
 /**
  * Represents a pending request in the TransportClient.
@@ -92,7 +92,7 @@ export class TransportClient<Payload> extends EventEmitter {
     }
     const msgId = this.msgId++;
     const msg = { msgId, payload };
-    debug(format(`->`, msg));
+    log.debug(format(`->`, msg));
     return new Promise<any>((resolve, reject) => {
       this.pendingRequests.push({ resolve, reject, msgId });
       this.socket!.send(msg, transfer).catch(reject);
@@ -112,7 +112,7 @@ export class TransportClient<Payload> extends EventEmitter {
       this.close();
       return;
     }
-    debug(format(`<-`, msg));
+    log.debug(format(`<-`, msg));
     if (isEventMessage(msg)) {
       this.emit('event_msg', msg.payload);
       return;

package/src/types/index.ts

@@ -4,5 +4,11 @@ export type FieldsOf<T> = {
   [P in keyof T as T[P] extends Function ? never : P]: T[P];
 };
 
+/** Extracts methods of a type. */
+export type FunctionsOf<T> = {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  [P in keyof T as T[P] extends Function ? P : never]: T[P];
+};
+
 /** Marks a set of properties of a type as optional. */
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/src/worker/worker_pool.ts

@@ -1,7 +1,7 @@
 import { createDebugLogger } from '../log/index.js';
 import { type WasmWorker } from './wasm_worker.js';
 
-const debug = createDebugLogger('bb:worker_pool');
+const log = createDebugLogger('bb:worker_pool');
 
 /**
  * Type of a worker factory.
@@ -53,7 +53,7 @@ export class WorkerPool {
    * @param maxMem - Max memory pages.
    */
   public async init(createWorker: CreateWorker, poolSize: number, maxMem = WorkerPool.MAX_PAGES) {
-    debug(`creating ${poolSize} workers...`);
+    log.debug(`creating ${poolSize} workers...`);
     const start = new Date().getTime();
     this.workers = await Promise.all(
       Array(poolSize)
@@ -61,7 +61,7 @@ export class WorkerPool {
         .map((_, i) => createWorker(`${i}`, i === 0 ? Math.min(WorkerPool.MAX_PAGES, maxMem) : 768, maxMem)),
     );
 
-    debug(`created workers: ${new Date().getTime() - start}ms`);
+    log.debug(`created workers: ${new Date().getTime() - start}ms`);
   }
 
   /**