@aztec/simulator 0.0.1-commit.2ed92850 → 0.0.1-commit.2f68f620

package/src/private/acvm/acvm.ts

@@ -1,4 +1,4 @@
-import { createLogger } from '@aztec/foundation/log';
+import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
 import {
   type ExecutionError,
   type ForeignCallInput,
@@ -37,6 +37,7 @@ export interface ACIRExecutionResult {
  * @param acir - The ACIR circuit bytecode to execute.
  * @param initialWitness - The initial witness map defining all of the inputs to `circuit`.
  * @param callback - A callback to process any foreign calls from the circuit.
+ * @param logger - Optional logger for ACVM execution logs.
  * @returns The solved witness calculated by executing the circuit on the provided inputs, as well as the return
  * witness indices as specified by the circuit.
  */
@@ -44,9 +45,9 @@ export async function acvm(
   acir: Buffer,
   initialWitness: ACVMWitness,
   callback: ACIRCallback,
+  loggerOrBindings?: Logger | LoggerBindings,
 ): Promise<ACIRExecutionResult> {
-  const logger = createLogger('simulator:acvm');
-
+  const logger = resolveLogger('simulator:acvm', loggerOrBindings);
   const solvedAndReturnWitness = await executeCircuitWithReturnWitness(
     acir,
     initialWitness,

package/src/private/acvm_native.ts

@@ -1,5 +1,5 @@
 import { runInDirectory } from '@aztec/foundation/fs';
-import { createLogger } from '@aztec/foundation/log';
+import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import type { ForeignCallHandler, WitnessMap } from '@aztec/noir-acvm_js';
 import type { FunctionArtifactWithContractName } from '@aztec/stdlib/abi';
@@ -12,8 +12,6 @@ import type { ACIRCallback, ACIRExecutionResult } from './acvm/acvm.js';
 import type { ACVMWitness } from './acvm/acvm_types.js';
 import type { CircuitSimulator } from './circuit_simulator.js';
 
-const logger = createLogger('simulator:acvm-native');
-
 export enum ACVM_RESULT {
   SUCCESS,
   FAILURE,
@@ -64,7 +62,9 @@ export async function executeNativeCircuit(
   workingDirectory: string,
   pathToAcvm: string,
   outputFilename?: string,
+  loggerOrBindings?: Logger | LoggerBindings,
 ): Promise<ACVMResult> {
+  const logger = resolveLogger('simulator:acvm-native', loggerOrBindings);
   const bytecodeFilename = 'bytecode';
   const witnessFilename = 'input_witness.toml';
 
@@ -145,11 +145,16 @@ export async function executeNativeCircuit(
 }
 
 export class NativeACVMSimulator implements CircuitSimulator {
+  private logger: Logger;
+
   constructor(
     private workingDirectory: string,
     private pathToAcvm: string,
     private witnessFilename?: string,
-  ) {}
+    loggerOrBindings?: Logger | LoggerBindings,
+  ) {
+    this.logger = resolveLogger('simulator:acvm-native', loggerOrBindings);
+  }
 
   async executeProtocolCircuit(
     input: ACVMWitness,
@@ -172,6 +177,7 @@ export class NativeACVMSimulator implements CircuitSimulator {
         directory,
         this.pathToAcvm,
         this.witnessFilename,
+        this.logger,
       );
 
       if (result.status == ACVM_RESULT.FAILURE) {
@@ -181,7 +187,7 @@ export class NativeACVMSimulator implements CircuitSimulator {
       return result;
     };
 
-    return await runInDirectory(this.workingDirectory, operation, false, logger);
+    return await runInDirectory(this.workingDirectory, operation, false, this.logger);
   }
 
   executeUserCircuit(

package/src/private/acvm_wasm.ts

@@ -1,4 +1,4 @@
-import { createLogger } from '@aztec/foundation/log';
+import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import initACVM, { type ExecutionError, type ForeignCallHandler, executeCircuit } from '@aztec/noir-acvm_js';
 import initAbi from '@aztec/noir-noirc_abi';
@@ -10,8 +10,14 @@ import type { ACVMWitness } from './acvm/acvm_types.js';
 import type { ACVMSuccess } from './acvm_native.js';
 import { type CircuitSimulator, enrichNoirError } from './circuit_simulator.js';
 
+let wasmInitPromise: Promise<unknown> | undefined;
+
 export class WASMSimulator implements CircuitSimulator {
-  constructor(protected log = createLogger('wasm-simulator')) {}
+  protected log: Logger;
+
+  constructor(loggerOrBindings?: Logger | LoggerBindings) {
+    this.log = resolveLogger('wasm-simulator', loggerOrBindings);
+  }
 
   async init(): Promise<void> {
     // If these are available, then we are in the
@@ -19,7 +25,8 @@ export class WASMSimulator implements CircuitSimulator {
     // is a no-op.
     if (typeof initAbi === 'function') {
       /** @ts-expect-error The node bundle doesn't include these default imports, so TS complains */
-      await Promise.all([initAbi(), initACVM()]);
+      wasmInitPromise ??= Promise.all([initAbi(), initACVM()]);
+      await wasmInitPromise;
     }
   }
 
@@ -67,6 +74,6 @@ export class WASMSimulator implements CircuitSimulator {
     callback: ACIRCallback,
   ): Promise<ACIRExecutionResult> {
     await this.init();
-    return acvm(artifact.bytecode, input, callback);
+    return acvm(artifact.bytecode, input, callback, this.log.createChild('acvm'));
   }
 }

package/src/private/circuit_recording/circuit_recorder.ts

@@ -1,5 +1,5 @@
 import { sha512 } from '@aztec/foundation/crypto/sha512';
-import { createLogger } from '@aztec/foundation/log';
+import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import type { ForeignCallHandler, ForeignCallInput, ForeignCallOutput } from '@aztec/noir-acvm_js';
 
@@ -89,14 +89,16 @@ export class CircuitRecording {
  * ```
  */
 export class CircuitRecorder {
-  protected readonly logger = createLogger('simulator:acvm:recording');
+  protected readonly logger: Logger;
 
   protected recording?: CircuitRecording;
 
   private stackDepth: number = 0;
   private newCircuit: boolean = true;
 
-  protected constructor() {}
+  protected constructor(loggerOrBindings?: Logger | LoggerBindings) {
+    this.logger = resolveLogger('simulator:acvm:recording', loggerOrBindings);
+  }
 
   /**
    * Initializes a new circuit recording session.
@@ -159,11 +161,11 @@ export class CircuitRecorder {
         throw new Error(`Oracle method ${name} not found when setting up recording callback`);
       }
 
-      const isExternalCall = (name as keyof ACIRCallback) === 'privateCallPrivateFunction';
+      const isExternalCall = (name as keyof ACIRCallback) === 'aztec_prv_callPrivateFunction';
 
       recordingCallback[name as keyof ACIRCallback] = (...args: ForeignCallInput[]): ReturnType<typeof fn> => {
         const timer = new Timer();
-        // If we're entering another circuit via `privateCallPrivateFunction`, we increase the stack depth and set the
+        // If we're entering another circuit via `aztec_prv_callPrivateFunction`, we increase the stack depth and set the
         // newCircuit variable to ensure we are creating a new recording object.
         if (isExternalCall) {
           this.stackDepth++;

package/src/private/circuit_recording/file_circuit_recorder.ts

@@ -1,3 +1,5 @@
+import type { Logger } from '@aztec/foundation/log';
+
 import fs from 'fs/promises';
 import path from 'path';
 
@@ -7,8 +9,11 @@ import { CircuitRecorder, type CircuitRecording } from './circuit_recorder.js';
 export class FileCircuitRecorder extends CircuitRecorder {
   declare recording?: CircuitRecording & { filePath: string; isFirstCall: boolean };
 
-  constructor(private readonly recordDir: string) {
-    super();
+  constructor(
+    private readonly recordDir: string,
+    logger?: Logger,
+  ) {
+    super(logger);
   }
 
   override async start(

package/src/private/circuit_recording/memory_circuit_recorder.ts

@@ -1,11 +1,13 @@
+import type { Logger } from '@aztec/foundation/log';
+
 import { CircuitRecorder } from './circuit_recorder.js';
 
-/*
+/**
  * In memory circuit recorder uses the default implementation. This is kept
- * while we decide the fate of the FileCircuitRecorder
+ * while we decide the fate of the FileCircuitRecorder.
  */
 export class MemoryCircuitRecorder extends CircuitRecorder {
-  constructor() {
-    super();
+  constructor(logger?: Logger) {
+    super(logger);
   }
 }

package/src/private/factory.ts

@@ -1,4 +1,4 @@
-import { type Logger, createLogger } from '@aztec/foundation/log';
+import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
 
 import { promises as fs } from 'fs';
 
@@ -21,18 +21,21 @@ export function getSimulatorConfigFromEnv() {
 
 export async function createSimulator(
   config: SimulatorConfig,
-  logger: Logger = createLogger('simulator'),
+  loggerOrBindings?: Logger | LoggerBindings,
 ): Promise<CircuitSimulator> {
+  const logger = resolveLogger('simulator', loggerOrBindings);
   if (config.acvmBinaryPath && config.acvmWorkingDirectory) {
     try {
       await fs.access(config.acvmBinaryPath, fs.constants.R_OK);
       await fs.mkdir(config.acvmWorkingDirectory, { recursive: true });
       logger.info(`Using native ACVM at ${config.acvmBinaryPath} and working directory ${config.acvmWorkingDirectory}`);
-      return new NativeACVMSimulator(config.acvmWorkingDirectory, config.acvmBinaryPath);
+      const acvmLogger = logger.createChild('acvm-native');
+      return new NativeACVMSimulator(config.acvmWorkingDirectory, config.acvmBinaryPath, undefined, acvmLogger);
     } catch {
       logger.warn(`Failed to access ACVM at ${config.acvmBinaryPath}, falling back to WASM`);
     }
   }
   logger.info('Using WASM ACVM simulation');
-  return new WASMSimulator();
+  const wasmLogger = logger.createChild('wasm');
+  return new WASMSimulator(wasmLogger);
 }