@aztec/simulator 0.87.5 → 0.87.6

package/dest/private/circuit_recording/file_circuit_recorder.js

@@ -0,0 +1,135 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { CircuitRecorder } from './circuit_recorder.js';
+export class FileCircuitRecorder extends CircuitRecorder {
+    recordDir;
+    constructor(recordDir){
+        super(), this.recordDir = recordDir;
+    }
+    async start(input, circuitBytecode, circuitName, functionName = 'main') {
+        await super.start(input, circuitBytecode, circuitName, functionName);
+        const recordingStringWithoutClosingBracket = JSON.stringify({
+            ...this.recording,
+            isFirstCall: undefined,
+            parent: undefined,
+            oracleCalls: undefined,
+            filePath: undefined
+        }, null, 2).slice(0, -2);
+        try {
+            // Check if the recording directory exists and is a directory
+            const stats = await fs.stat(this.recordDir);
+            if (!stats.isDirectory()) {
+                throw new Error(`Recording path ${this.recordDir} exists but is not a directory`);
+            }
+        } catch (err) {
+            if (err.code === 'ENOENT') {
+                // The directory does not exist so we create it
+                await fs.mkdir(this.recordDir, {
+                    recursive: true
+                });
+            } else {
+                throw err;
+            }
+        }
+        this.recording.isFirstCall = true;
+        this.recording.filePath = await FileCircuitRecorder.#computeFilePathAndStoreInitialRecording(this.recordDir, this.recording.circuitName, this.recording.functionName, recordingStringWithoutClosingBracket);
+    }
+    /**
+   * Computes a unique file path for the recording by trying different counter values.
+   * This is needed because multiple recordings of the same circuit could be happening simultaneously or an older
+   * recording might be present.
+   * @param recordDir - Directory to store the recording
+   * @param circuitName - Name of the circuit
+   * @param functionName - Name of the circuit function
+   * @param recordingContent - Initial recording content
+   * @returns A unique file path for the recording
+   */ static async #computeFilePathAndStoreInitialRecording(recordDir, circuitName, functionName, recordingContent) {
+        let counter = 0;
+        while(true){
+            try {
+                const filePath = getFilePath(recordDir, circuitName, functionName, counter);
+                // Write the initial recording content to the file
+                await fs.writeFile(filePath, recordingContent + ',\n  "oracleCalls": [\n', {
+                    flag: 'wx'
+                });
+                return filePath;
+            } catch (err) {
+                if (err.code === 'EEXIST') {
+                    counter++;
+                    continue;
+                }
+                throw err;
+            }
+        }
+    }
+    /**
+   * Records a single oracle/foreign call with its inputs and outputs.
+   * @param name - Name of the call
+   * @param inputs - Input arguments
+   * @param outputs - Output results
+   */ async recordCall(name, inputs, outputs, time, stackDepth) {
+        const entry = await super.recordCall(name, inputs, outputs, time, stackDepth);
+        try {
+            const prefix = this.recording.isFirstCall ? '    ' : '    ,';
+            this.recording.isFirstCall = false;
+            await fs.appendFile(this.recording.filePath, prefix + JSON.stringify(entry) + '\n');
+        } catch (err) {
+            this.logger.error('Failed to log circuit call', {
+                error: err
+            });
+        }
+        return entry;
+    }
+    /**
+   * Finalizes the recording file by adding closing brackets. Without calling this method, the recording file is
+   * incomplete and it fails to parse.
+   */ async finish() {
+        // Finish sets the recording to undefined if we are at the topmost circuit,
+        // so we save the current file path before that
+        const filePath = this.recording.filePath;
+        const result = await super.finish();
+        try {
+            await fs.appendFile(filePath, '  ]\n}\n');
+        } catch (err) {
+            this.logger.error('Failed to finalize recording file', {
+                error: err
+            });
+        }
+        return result;
+    }
+    /**
+   * Finalizes the recording file by adding the error and closing brackets. Without calling this method or `finish`,
+   * the recording file is incomplete and it fails to parse.
+   * @param error - The error that occurred during circuit execution
+   */ async finishWithError(error) {
+        // Finish sets the recording to undefined if we are at the topmost circuit,
+        // so we save the current file path before that
+        const filePath = this.recording.filePath;
+        const result = await super.finishWithError(error);
+        try {
+            await fs.appendFile(filePath, '  ],\n');
+            await fs.appendFile(filePath, `  "error": ${JSON.stringify(error)}\n`);
+            await fs.appendFile(filePath, '}\n');
+        } catch (err) {
+            this.logger.error('Failed to finalize recording file with error', {
+                error: err
+            });
+        }
+        return result;
+    }
+}
+/**
+ * Generates a file path for storing circuit recordings. The format of the filename is:
+ * `circuit_name_circuit_function_name_YYYY-MM-DD_N.json` where N is a counter to ensure unique filenames.
+ * @param recordDir - Base directory for recordings
+ * @param circuitName - Name of the circuit
+ * @param functionName - Name of the circuit function
+ * @param counter - Counter to ensure unique filenames. This is expected to be incremented in a loop until there is no
+ * existing file with the same name.
+ * @returns A file path for the recording.
+ */ function getFilePath(recordDir, circuitName, functionName, counter) {
+    const date = new Date();
+    const formattedDate = date.toISOString().split('T')[0];
+    const filename = `${circuitName}_${functionName}_${formattedDate}_${counter}.json`;
+    return path.join(recordDir, filename);
+}

package/dest/private/circuit_recording/memory_circuit_recorder.d.ts

@@ -0,0 +1,5 @@
+import { CircuitRecorder } from './circuit_recorder.js';
+export declare class MemoryCircuitRecorder extends CircuitRecorder {
+    constructor();
+}
+//# sourceMappingURL=memory_circuit_recorder.d.ts.map

package/dest/private/circuit_recording/memory_circuit_recorder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory_circuit_recorder.d.ts","sourceRoot":"","sources":["../../../src/private/circuit_recording/memory_circuit_recorder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAMxD,qBAAa,qBAAsB,SAAQ,eAAe;;CAIzD"}

package/dest/private/circuit_recording/memory_circuit_recorder.js

@@ -0,0 +1,9 @@
+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
+ */ export class MemoryCircuitRecorder extends CircuitRecorder {
+    constructor(){
+        super();
+    }
+}

package/dest/private/{providers/circuit_recording/simulation_provider_recorder_wrapper.d.ts → circuit_recording/simulator_recorder_wrapper.d.ts}

@@ -1,19 +1,21 @@
 import type { ForeignCallHandler } from '@aztec/noir-protocol-circuits-types/types';
 import type { FunctionArtifactWithContractName } from '@aztec/stdlib/abi';
 import type { NoirCompiledCircuitWithName } from '@aztec/stdlib/noir';
-import type { ACIRCallback, ACIRExecutionResult } from '../../acvm/acvm.js';
-import type { ACVMWitness } from '../../acvm/acvm_types.js';
+import type { ACIRCallback, ACIRExecutionResult } from '../acvm/acvm.js';
+import type { ACVMWitness } from '../acvm/acvm_types.js';
 import type { ACVMSuccess } from '../acvm_native.js';
-import type { SimulationProvider } from '../simulation_provider.js';
+import type { CircuitSimulator } from '../circuit_simulator.js';
+import type { CircuitRecorder } from './circuit_recorder.js';
 /**
- * Takes a simulation provider and wraps it in a circuit recorder. See CircuitRecorder for more details on how circuit
+ * Takes a circuit simulator and wraps it in a circuit recorder. See CircuitRecorder for more details on how circuit
  * recording works.
  */
-export declare class SimulationProviderRecorderWrapper implements SimulationProvider {
+export declare class SimulatorRecorderWrapper implements CircuitSimulator {
     #private;
     private simulator;
-    constructor(simulator: SimulationProvider);
+    private recorder;
+    constructor(simulator: CircuitSimulator, recorder: CircuitRecorder);
     executeProtocolCircuit(input: ACVMWitness, artifact: NoirCompiledCircuitWithName, callback: ForeignCallHandler | undefined): Promise<ACVMSuccess>;
     executeUserCircuit(input: ACVMWitness, artifact: FunctionArtifactWithContractName, callback: ACIRCallback): Promise<ACIRExecutionResult>;
 }
-//# sourceMappingURL=simulation_provider_recorder_wrapper.d.ts.map
+//# sourceMappingURL=simulator_recorder_wrapper.d.ts.map

package/dest/private/circuit_recording/simulator_recorder_wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulator_recorder_wrapper.d.ts","sourceRoot":"","sources":["../../../src/private/circuit_recording/simulator_recorder_wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AACpF,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAEtE,OAAO,KAAK,EAAE,YAAY,EAAqB,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;GAGG;AACH,qBAAa,wBAAyB,YAAW,gBAAgB;;IAE7D,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,QAAQ;gBADR,SAAS,EAAE,gBAAgB,EAC3B,QAAQ,EAAE,eAAe;IAGnC,sBAAsB,CACpB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,2BAA2B,EACrC,QAAQ,EAAE,kBAAkB,GAAG,SAAS,GACvC,OAAO,CAAC,WAAW,CAAC;IAavB,kBAAkB,CAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,gCAAgC,EAC1C,QAAQ,EAAE,YAAY,GACrB,OAAO,CAAC,mBAAmB,CAAC;CAiDhC"}

package/dest/private/{providers/circuit_recording/simulation_provider_recorder_wrapper.js → circuit_recording/simulator_recorder_wrapper.js}

@@ -1,11 +1,12 @@
-import { CircuitRecorder } from './circuit_recorder.js';
 /**
- * Takes a simulation provider and wraps it in a circuit recorder. See CircuitRecorder for more details on how circuit
+ * Takes a circuit simulator and wraps it in a circuit recorder. See CircuitRecorder for more details on how circuit
  * recording works.
- */ export class SimulationProviderRecorderWrapper {
+ */ export class SimulatorRecorderWrapper {
     simulator;
-    constructor(simulator){
+    recorder;
+    constructor(simulator, recorder){
         this.simulator = simulator;
+        this.recorder = recorder;
     }
     executeProtocolCircuit(input, artifact, callback) {
         const bytecode = Buffer.from(artifact.bytecode, 'base64');
@@ -15,25 +16,29 @@ import { CircuitRecorder } from './circuit_recorder.js';
         return this.#simulate((wrappedCallback)=>this.simulator.executeUserCircuit(input, artifact, wrappedCallback), input, artifact.bytecode, artifact.contractName, artifact.name, callback);
     }
     async #simulate(simulateFn, input, bytecode, contractName, functionName, callback) {
-        const recordDir = process.env.CIRCUIT_RECORD_DIR;
-        if (!recordDir) {
-            // Recording is not enabled so we just execute the circuit
-            return simulateFn(callback);
-        }
         // Start recording circuit execution
-        const recorder = await CircuitRecorder.start(recordDir, input, bytecode, contractName, functionName);
+        await this.recorder.start(input, bytecode, contractName, functionName);
         // If callback was provided, we wrap it in a circuit recorder callback wrapper
-        const wrappedCallback = recorder.wrapCallback(callback);
+        const wrappedCallback = this.recorder.wrapCallback(callback);
         let result;
         try {
             result = await simulateFn(wrappedCallback);
         } catch (error) {
             // If an error occurs, we finalize the recording file with the error
-            await recorder.finishWithError(error);
+            await this.recorder.finishWithError(error);
             throw error;
         }
         // Witness generation is complete so we finish the circuit recorder
-        await recorder.finish();
+        const recording = await this.recorder.finish();
+        result.oracles = recording.oracleCalls?.reduce((acc, { time, name })=>{
+            if (!acc[name]) {
+                acc[name] = {
+                    times: []
+                };
+            }
+            acc[name].times.push(time);
+            return acc;
+        }, {});
         return result;
     }
 }

package/dest/private/{providers/simulation_provider.d.ts → circuit_simulator.d.ts}

@@ -1,13 +1,13 @@
 import type { ExecutionError, ForeignCallHandler } from '@aztec/noir-acvm_js';
 import type { FunctionArtifactWithContractName } from '@aztec/stdlib/abi';
 import type { NoirCompiledCircuit, NoirCompiledCircuitWithName } from '@aztec/stdlib/noir';
-import { type ACIRCallback, type ACIRExecutionResult } from '../acvm/acvm.js';
-import type { ACVMWitness } from '../acvm/acvm_types.js';
+import { type ACIRCallback, type ACIRExecutionResult } from './acvm/acvm.js';
+import type { ACVMWitness } from './acvm/acvm_types.js';
 import type { ACVMSuccess } from './acvm_native.js';
 /**
  * Low level simulation interface
  */
-export interface SimulationProvider {
+export interface CircuitSimulator {
     /**
      * Execute a protocol circuit/generate a witness
      * @param input - The initial witness map defining all of the inputs to `circuit`.
@@ -32,4 +32,4 @@ export type DecodedError = ExecutionError & {
     noirCallStack?: string[];
 };
 export declare function enrichNoirError(artifact: NoirCompiledCircuit, originalError: ExecutionError): DecodedError;
-//# sourceMappingURL=simulation_provider.d.ts.map
+//# sourceMappingURL=circuit_simulator.d.ts.map

package/dest/private/circuit_simulator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit_simulator.d.ts","sourceRoot":"","sources":["../../src/private/circuit_simulator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAG9E,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAE3F,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,mBAAmB,EAAoB,MAAM,gBAAgB,CAAC;AAC/F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;OAOG;IACH,sBAAsB,CACpB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,2BAA2B,EACrC,QAAQ,EAAE,kBAAkB,GAAG,SAAS,GACvC,OAAO,CAAC,WAAW,CAAC,CAAC;IAExB;;;;;;;OAOG;IACH,kBAAkB,CAChB,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,gCAAgC,EAC1C,QAAQ,EAAE,YAAY,GACrB,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACjC;AAED,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG;IAAE,uBAAuB,CAAC,EAAE,GAAG,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAIxG,wBAAgB,eAAe,CAAC,QAAQ,EAAE,mBAAmB,EAAE,aAAa,EAAE,cAAc,GAAG,YAAY,CA0C1G"}

package/dest/private/{providers/simulation_provider.js → circuit_simulator.js}

@@ -1,6 +1,6 @@
 import { abiDecodeError } from '@aztec/noir-noirc_abi';
 import { parseDebugSymbols } from '@aztec/stdlib/abi';
-import { extractCallStack } from '../acvm/acvm.js';
+import { extractCallStack } from './acvm/acvm.js';
 // Payload parsing taken from noir/noir-repo/tooling/noir_js/src/witness_generation.ts.
 // TODO: import this in isolation without having to import noir_js in its entirety.
 export function enrichNoirError(artifact, originalError) {

package/dest/private/factory.d.ts

@@ -0,0 +1,12 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { CircuitSimulator } from './circuit_simulator.js';
+export type SimulatorConfig = {
+    acvmBinaryPath?: string;
+    acvmWorkingDirectory?: string;
+};
+export declare function getSimulatorConfigFromEnv(): {
+    acvmWorkingDirectory: string | undefined;
+    acvmBinaryPath: string | undefined;
+};
+export declare function createSimulator(config: SimulatorConfig, logger?: Logger): Promise<CircuitSimulator>;
+//# sourceMappingURL=factory.d.ts.map

package/dest/private/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/private/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAMlE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,wBAAgB,yBAAyB;;;EAMxC;AAED,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,EACvB,MAAM,GAAE,MAAkC,GACzC,OAAO,CAAC,gBAAgB,CAAC,CAa3B"}

package/dest/private/{providers/factory.js → factory.js}

@@ -2,14 +2,14 @@ import { createLogger } from '@aztec/foundation/log';
 import { promises as fs } from 'fs';
 import { NativeACVMSimulator } from './acvm_native.js';
 import { WASMSimulator } from './acvm_wasm.js';
-export function getSimulationProviderConfigFromEnv() {
+export function getSimulatorConfigFromEnv() {
     const { ACVM_BINARY_PATH, ACVM_WORKING_DIRECTORY } = process.env;
     return {
         acvmWorkingDirectory: ACVM_WORKING_DIRECTORY ? ACVM_WORKING_DIRECTORY : undefined,
         acvmBinaryPath: ACVM_BINARY_PATH ? ACVM_BINARY_PATH : undefined
     };
 }
-export async function createSimulationProvider(config, logger = createLogger('simulator')) {
+export async function createSimulator(config, logger = createLogger('simulator')) {
     if (config.acvmBinaryPath && config.acvmWorkingDirectory) {
         try {
             await fs.access(config.acvmBinaryPath, fs.constants.R_OK);

package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts

@@ -31,5 +31,6 @@ export declare abstract class BaseAvmSimulationTester {
     registerFeeJuiceContract(): Promise<ContractInstanceWithAddress>;
     addContractInstance(contractInstance: ContractInstanceWithAddress, skipNullifierInsertion?: boolean): Promise<void>;
     private insertContractAddressNullifier;
+    insertNullifier(contractThatEmitted: AztecAddress, nullifier: Fr): Promise<void>;
 }
 //# sourceMappingURL=base_avm_simulation_tester.d.ts.map

package/dest/public/avm/fixtures/base_avm_simulation_tester.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base_avm_simulation_tester.d.ts","sourceRoot":"","sources":["../../../../src/public/avm/fixtures/base_avm_simulation_tester.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAI9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAE1E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAGjF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AAG9F;;;;;;;;;;GAUG;AACH,8BAAsB,uBAAuB;IAIlC,kBAAkB,EAAE,wBAAwB;IAC5C,WAAW,EAAE,yBAAyB;IAC7C,OAAO,CAAC,sBAAsB;IALzB,MAAM,yCAAyC;gBAG7C,kBAAkB,EAAE,wBAAwB,EAC5C,WAAW,EAAE,yBAAyB,EACrC,sBAAsB,KAAmB;IAG7C,kBAAkB,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,KAA8B;IAMhF,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE;IAOjE;;;OAGG;IACG,yBAAyB,CAC7B,eAAe,EAAE,GAAG,EAAE,EACtB,QAAQ,EAAE,YAAY,EACtB,gBAAgB,EAAE,gBAAgB,EAClC,sBAAsB,UAAQ,EAC9B,IAAI,SAAI,EACR,uBAAuB,CAAC,EAAE,EAAE,GAC3B,OAAO,CAAC,2BAA2B,CAAC;IAiBjC,wBAAwB,IAAI,OAAO,CAAC,2BAA2B,CAAC;IAWhE,mBAAmB,CAAC,gBAAgB,EAAE,2BAA2B,EAAE,sBAAsB,UAAQ;YAOzF,8BAA8B;CAO7C"}
+{"version":3,"file":"base_avm_simulation_tester.d.ts","sourceRoot":"","sources":["../../../../src/public/avm/fixtures/base_avm_simulation_tester.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAI9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAE1E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAGjF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AAG9F;;;;;;;;;;GAUG;AACH,8BAAsB,uBAAuB;IAIlC,kBAAkB,EAAE,wBAAwB;IAC5C,WAAW,EAAE,yBAAyB;IAC7C,OAAO,CAAC,sBAAsB;IALzB,MAAM,yCAAyC;gBAG7C,kBAAkB,EAAE,wBAAwB,EAC5C,WAAW,EAAE,yBAAyB,EACrC,sBAAsB,KAAmB;IAG7C,kBAAkB,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,KAA8B;IAMhF,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE;IAOjE;;;OAGG;IACG,yBAAyB,CAC7B,eAAe,EAAE,GAAG,EAAE,EACtB,QAAQ,EAAE,YAAY,EACtB,gBAAgB,EAAE,gBAAgB,EAClC,sBAAsB,UAAQ,EAC9B,IAAI,SAAI,EACR,uBAAuB,CAAC,EAAE,EAAE,GAC3B,OAAO,CAAC,2BAA2B,CAAC;IAiBjC,wBAAwB,IAAI,OAAO,CAAC,2BAA2B,CAAC;IAWhE,mBAAmB,CAAC,gBAAgB,EAAE,2BAA2B,EAAE,sBAAsB,UAAQ;YAOzF,8BAA8B;IAQtC,eAAe,CAAC,mBAAmB,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE;CAIvE"}

package/dest/public/avm/fixtures/base_avm_simulation_tester.js

@@ -75,4 +75,10 @@ import { createContractClassAndInstance } from './index.js';
             contractAddressNullifier.toBuffer()
         ]);
     }
+    async insertNullifier(contractThatEmitted, nullifier) {
+        const siloedNullifier = await siloNullifier(contractThatEmitted, nullifier);
+        await this.merkleTrees.sequentialInsert(MerkleTreeId.NULLIFIER_TREE, [
+            siloedNullifier.toBuffer()
+        ]);
+    }
 }

package/dest/public/public_tx_simulator/apps_tests/amm_test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"amm_test.d.ts","sourceRoot":"","sources":["../../../../src/public/public_tx_simulator/apps_tests/amm_test.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAKpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AAIzF;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,iBAoG7E"}
+{"version":3,"file":"amm_test.d.ts","sourceRoot":"","sources":["../../../../src/public/public_tx_simulator/apps_tests/amm_test.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAKpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AAIzF;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,iBAoG7E"}

package/dest/public/public_tx_simulator/apps_tests/amm_test.js

@@ -1,3 +1,5 @@
+import { GeneratorIndex } from '@aztec/constants';
+import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto';
 import { Fr } from '@aztec/foundation/fields';
 import { AMMContractArtifact } from '@aztec/noir-contracts.js/AMM';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
@@ -69,6 +71,14 @@ async function addLiquidity(tester, sender, amm, token0, token1, liquidityToken,
     const liquidityPartialNote = {
         commitment: new Fr(99)
     };
+    const refundToken0PartialNoteValidityCommitment = await computePartialNoteValidityCommitment(refundToken0PartialNote, amm.address);
+    const refundToken1PartialNoteValidityCommitment = await computePartialNoteValidityCommitment(refundToken1PartialNote, amm.address);
+    const liquidityPartialNoteValidityCommitment = await computePartialNoteValidityCommitment(liquidityPartialNote, amm.address);
+    // We need to inject the validity commitments into the nullifier tree as that would be performed by the private token
+    // functions that are not invoked in this test.
+    await tester.insertNullifier(token0.address, refundToken0PartialNoteValidityCommitment);
+    await tester.insertNullifier(token1.address, refundToken1PartialNoteValidityCommitment);
+    await tester.insertNullifier(liquidityToken.address, liquidityPartialNoteValidityCommitment);
     return await tester.simulateTxWithLabel(/*txLabel=*/ 'AMM/add_liquidity', /*sender=*/ sender, /*setupCalls=*/ [], /*appCalls=*/ [
         // token0.transfer_to_public enqueues a call to _increase_public_balance
         {
@@ -80,15 +90,6 @@ async function addLiquidity(tester, sender, amm, token0, token1, liquidityToken,
             ],
             address: token0.address
         },
-        // token0.prepare_private_balance_increase enqueues a call to _store_balances_set_partial_note
-        {
-            sender: token0.address,
-            fnName: '_store_balances_set_partial_note',
-            args: [
-                refundToken0PartialNote
-            ],
-            address: token0.address
-        },
         // token1.transfer_to_public enqueues a call to _increase_public_balance
         {
             sender: token1.address,
@@ -99,24 +100,6 @@ async function addLiquidity(tester, sender, amm, token0, token1, liquidityToken,
             ],
             address: token1.address
         },
-        // token1.prepare_private_balance_increase enqueues a call to _store_balances_set_partial_note
-        {
-            sender: token1.address,
-            fnName: '_store_balances_set_partial_note',
-            args: [
-                refundToken1PartialNote
-            ],
-            address: token1.address
-        },
-        // liquidityToken.prepare_private_balance_increase enqueues a call to _store_balances_set_partial_note
-        {
-            sender: liquidityToken.address,
-            fnName: '_store_balances_set_partial_note',
-            args: [
-                liquidityPartialNote
-            ],
-            address: liquidityToken.address
-        },
         // amm.add_liquidity enqueues a call to _add_liquidity
         {
             sender: amm.address,
@@ -142,8 +125,12 @@ async function addLiquidity(tester, sender, amm, token0, token1, liquidityToken,
 }
 async function swapExactTokensForTokens(tester, sender, amm, tokenIn, tokenOut, amountIn, amountOutMin, _nonce) {
     const tokenOutPartialNote = {
-        commitment: new Fr(66)
+        commitment: new Fr(166)
     };
+    const tokenOutPartialNoteValidityCommitment = await computePartialNoteValidityCommitment(tokenOutPartialNote, amm.address);
+    // We need to inject the validity commitment into the nullifier tree as that would be performed by the private token
+    // function that is not invoked in this test.
+    await tester.insertNullifier(tokenOut.address, tokenOutPartialNoteValidityCommitment);
     return await tester.simulateTxWithLabel(/*txLabel=*/ 'AMM/swap_exact_tokens_for_tokens', /*sender=*/ sender, /*setupCalls=*/ [], /*appCalls=*/ [
         // tokenIn.transfer_to_public enqueues a call to _increase_public_balance
         {
@@ -155,15 +142,6 @@ async function swapExactTokensForTokens(tester, sender, amm, tokenIn, tokenOut,
             ],
             address: tokenIn.address
         },
-        // tokenOut.prepare_private_balance_increase enqueues a call to _store_balances_set_partial_note
-        {
-            sender: tokenOut.address,
-            fnName: '_store_balances_set_partial_note',
-            args: [
-                tokenOutPartialNote
-            ],
-            address: tokenOut.address
-        },
         {
             sender: amm.address,
             fnName: '_swap_exact_tokens_for_tokens',
@@ -185,6 +163,12 @@ async function removeLiquidity(tester, sender, amm, token0, token1, liquidityTok
     const token1PartialNote = {
         commitment: new Fr(222)
     };
+    const token0PartialNoteValidityCommitment = await computePartialNoteValidityCommitment(token0PartialNote, amm.address);
+    const token1PartialNoteValidityCommitment = await computePartialNoteValidityCommitment(token1PartialNote, amm.address);
+    // We need to inject the validity commitments into the nullifier tree as that would be performed by the private token
+    // functions that are not invoked in this test.
+    await tester.insertNullifier(token0.address, token0PartialNoteValidityCommitment);
+    await tester.insertNullifier(token1.address, token1PartialNoteValidityCommitment);
     return await tester.simulateTxWithLabel(/*txLabel=*/ 'AMM/remove_liquidity', /*sender=*/ sender, /*setupCalls=*/ [], /*appCalls=*/ [
         // liquidityToken.transfer_to_public enqueues a call to _increase_public_balance
         {
@@ -196,24 +180,6 @@ async function removeLiquidity(tester, sender, amm, token0, token1, liquidityTok
             ],
             address: liquidityToken.address
         },
-        // token0.prepare_private_balance_increase enqueues a call to _store_balances_set_partial_note
-        {
-            sender: token0.address,
-            fnName: '_store_balances_set_partial_note',
-            args: [
-                token0PartialNote
-            ],
-            address: token0.address
-        },
-        // token1.prepare_private_balance_increase enqueues a call to _store_balances_set_partial_note
-        {
-            sender: token1.address,
-            fnName: '_store_balances_set_partial_note',
-            args: [
-                token1PartialNote
-            ],
-            address: token1.address
-        },
         // amm.remove_liquidity enqueues a call to _remove_liquidity
         {
             sender: amm.address,
@@ -235,3 +201,9 @@ async function removeLiquidity(tester, sender, amm, token0, token1, liquidityTok
         }
     ]);
 }
+async function computePartialNoteValidityCommitment(partialNote, completer) {
+    return await poseidon2HashWithSeparator([
+        partialNote.commitment,
+        completer
+    ], GeneratorIndex.PARTIAL_NOTE_VALIDITY_COMMITMENT);
+}

package/dest/server.d.ts

@@ -1,6 +1,9 @@
 export * from './public/index.js';
-export { WASMSimulatorWithBlobs } from './private/providers/acvm_wasm_with_blobs.js';
-export { NativeACVMSimulator } from './private/providers/acvm_native.js';
-export { type SimulationProvider } from './private/providers/simulation_provider.js';
+export * from './private/acvm/index.js';
+export { WASMSimulatorWithBlobs } from './private/acvm_wasm_with_blobs.js';
+export { NativeACVMSimulator } from './private/acvm_native.js';
+export { SimulatorRecorderWrapper } from './private/circuit_recording/simulator_recorder_wrapper.js';
+export { MemoryCircuitRecorder } from './private/circuit_recording/memory_circuit_recorder.js';
+export { type CircuitSimulator, type DecodedError } from './private/circuit_simulator.js';
 export * from './common/index.js';
 //# sourceMappingURL=server.d.ts.map

package/dest/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AACrF,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,2DAA2D,CAAC;AACrG,OAAO,EAAE,qBAAqB,EAAE,MAAM,wDAAwD,CAAC;AAC/F,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC1F,cAAc,mBAAmB,CAAC"}

package/dest/server.js

@@ -1,4 +1,7 @@
 export * from './public/index.js';
-export { WASMSimulatorWithBlobs } from './private/providers/acvm_wasm_with_blobs.js';
-export { NativeACVMSimulator } from './private/providers/acvm_native.js';
+export * from './private/acvm/index.js';
+export { WASMSimulatorWithBlobs } from './private/acvm_wasm_with_blobs.js';
+export { NativeACVMSimulator } from './private/acvm_native.js';
+export { SimulatorRecorderWrapper } from './private/circuit_recording/simulator_recorder_wrapper.js';
+export { MemoryCircuitRecorder } from './private/circuit_recording/memory_circuit_recorder.js';
 export * from './common/index.js';

package/dest/testing.d.ts

@@ -1,2 +1,2 @@
-export { SimulationProviderRecorderWrapper } from './private/providers/circuit_recording/simulation_provider_recorder_wrapper.js';
+export { FileCircuitRecorder } from './private/circuit_recording/file_circuit_recorder.js';
 //# sourceMappingURL=testing.d.ts.map

package/dest/testing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iCAAiC,EAAE,MAAM,+EAA+E,CAAC"}
+{"version":3,"file":"testing.d.ts","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAC"}

package/dest/testing.js

@@ -1 +1 @@
-export { SimulationProviderRecorderWrapper } from './private/providers/circuit_recording/simulation_provider_recorder_wrapper.js';
+export { FileCircuitRecorder } from './private/circuit_recording/file_circuit_recorder.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/simulator",
-  "version": "0.87.5",
+  "version": "0.87.6",
   "type": "module",
   "exports": {
     "./server": "./dest/server.js",
@@ -58,25 +58,25 @@
     ]
   },
   "dependencies": {
-    "@aztec/constants": "0.87.5",
-    "@aztec/foundation": "0.87.5",
-    "@aztec/noir-acvm_js": "0.87.5",
-    "@aztec/noir-noirc_abi": "0.87.5",
-    "@aztec/noir-protocol-circuits-types": "0.87.5",
-    "@aztec/noir-types": "0.87.5",
-    "@aztec/protocol-contracts": "0.87.5",
-    "@aztec/stdlib": "0.87.5",
-    "@aztec/telemetry-client": "0.87.5",
-    "@aztec/world-state": "0.87.5",
+    "@aztec/constants": "0.87.6",
+    "@aztec/foundation": "0.87.6",
+    "@aztec/noir-acvm_js": "0.87.6",
+    "@aztec/noir-noirc_abi": "0.87.6",
+    "@aztec/noir-protocol-circuits-types": "0.87.6",
+    "@aztec/noir-types": "0.87.6",
+    "@aztec/protocol-contracts": "0.87.6",
+    "@aztec/stdlib": "0.87.6",
+    "@aztec/telemetry-client": "0.87.6",
+    "@aztec/world-state": "0.87.6",
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@aztec/kv-store": "0.87.5",
-    "@aztec/merkle-tree": "0.87.5",
-    "@aztec/noir-contracts.js": "0.87.5",
-    "@aztec/noir-test-contracts.js": "0.87.5",
+    "@aztec/kv-store": "0.87.6",
+    "@aztec/merkle-tree": "0.87.6",
+    "@aztec/noir-contracts.js": "0.87.6",
+    "@aztec/noir-test-contracts.js": "0.87.6",
     "@jest/globals": "^29.5.0",
     "@types/jest": "^29.5.0",
     "@types/lodash.clonedeep": "^4.5.7",

package/src/client.ts

@@ -1,4 +1,6 @@
-export * from './private/index.js';
-export { WASMSimulator } from './private/providers/acvm_wasm.js';
-export { type SimulationProvider, type DecodedError } from './private/providers/simulation_provider.js';
+export * from './private/acvm/index.js';
+export { WASMSimulator } from './private/acvm_wasm.js';
+export { SimulatorRecorderWrapper } from './private/circuit_recording/simulator_recorder_wrapper.js';
+export { MemoryCircuitRecorder } from './private/circuit_recording/memory_circuit_recorder.js';
+export { type CircuitSimulator, type DecodedError } from './private/circuit_simulator.js';
 export * from './common/index.js';

package/src/private/acvm/acvm.ts

@@ -10,12 +10,13 @@ import type { NoirCallStack } from '@aztec/stdlib/errors';
 
 import { resolveOpcodeLocations, traverseCauseChain } from '../../common/errors.js';
 import type { ACVMWitness } from './acvm_types.js';
-import type { ORACLE_NAMES } from './oracle/index.js';
 
 /**
  * The callback interface for the ACIR.
  */
-export type ACIRCallback = Record<ORACLE_NAMES, (...args: ForeignCallInput[]) => Promise<ForeignCallOutput[]>>;
+export type ACIRCallback = Record<string, (...args: ForeignCallInput[]) => Promise<ForeignCallOutput[]>>;
+
+export type ACIRCallbackStats = { times: number[] };
 
 /**
  * The result of executing an ACIR.
@@ -28,6 +29,7 @@ export interface ACIRExecutionResult {
    */
   partialWitness: ACVMWitness;
   returnWitness: ACVMWitness;
+  oracles?: Record<string, ACIRCallbackStats>;
 }
 
 /**
@@ -51,7 +53,7 @@ export async function acvm(
     (name: string, args: ForeignCallInput[]) => {
       try {
         logger.debug(`Oracle callback ${name}`);
-        const oracleFunction = callback[name as ORACLE_NAMES];
+        const oracleFunction = callback[name];
         if (!oracleFunction) {
           throw new Error(`Oracle callback ${name} not found`);
         }