@aztec/simulator 0.0.0-test.0 → 0.0.1-commit.24de95ac

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/circuit_recording/simulator_recorder_wrapper.d.ts

@@ -0,0 +1,21 @@
+import type { ForeignCallHandler } from '@aztec/noir-acvm_js';
+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 { ACVMSuccess } from '../acvm_native.js';
+import type { CircuitSimulator } from '../circuit_simulator.js';
+import type { CircuitRecorder } from './circuit_recorder.js';
+/**
+ * Takes a circuit simulator and wraps it in a circuit recorder. See CircuitRecorder for more details on how circuit
+ * recording works.
+ */
+export declare class SimulatorRecorderWrapper implements CircuitSimulator {
+    #private;
+    private simulator;
+    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=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,qBAAqB,CAAC;AAC9D,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/circuit_recording/simulator_recorder_wrapper.js

@@ -0,0 +1,44 @@
+/**
+ * Takes a circuit simulator and wraps it in a circuit recorder. See CircuitRecorder for more details on how circuit
+ * recording works.
+ */ export class SimulatorRecorderWrapper {
+    simulator;
+    recorder;
+    constructor(simulator, recorder){
+        this.simulator = simulator;
+        this.recorder = recorder;
+    }
+    executeProtocolCircuit(input, artifact, callback) {
+        const bytecode = Buffer.from(artifact.bytecode, 'base64');
+        return this.#simulate((wrappedCallback)=>this.simulator.executeProtocolCircuit(input, artifact, wrappedCallback), input, bytecode, artifact.name, 'main', callback);
+    }
+    executeUserCircuit(input, artifact, callback) {
+        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) {
+        // Start recording circuit execution
+        await this.recorder.start(input, bytecode, contractName, functionName);
+        // If callback was provided, we wrap it in a circuit recorder callback wrapper
+        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 this.recorder.finishWithError(error);
+            throw error;
+        }
+        // Witness generation is complete so we finish the circuit recorder
+        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/circuit_simulator.d.ts

@@ -0,0 +1,35 @@
+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 { ACVMSuccess } from './acvm_native.js';
+/**
+ * Low level simulation interface
+ */
+export interface CircuitSimulator {
+    /**
+     * Execute a protocol circuit/generate a witness
+     * @param input - The initial witness map defining all of the inputs to `circuit`.
+     * @param artifact - ACIR circuit bytecode and its metadata.
+     * @param callback - A callback to process any foreign calls from the circuit. Can be undefined as for native
+     * ACVM simulator we don't process foreign calls.
+     * @returns The solved witness calculated by executing the circuit on the provided inputs.
+     */
+    executeProtocolCircuit(input: ACVMWitness, artifact: NoirCompiledCircuitWithName, callback: ForeignCallHandler | undefined): Promise<ACVMSuccess>;
+    /**
+     * Execute a user circuit (smart contract function)/generate a witness
+     * @param input - The initial witness map defining all of the inputs to `circuit`.
+     * @param artifact - Contract function ACIR circuit bytecode and its metadata.
+     * @param callback - A callback to process any foreign calls from the circuit.
+     * @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.
+     */
+    executeUserCircuit(input: ACVMWitness, artifact: FunctionArtifactWithContractName, callback: ACIRCallback): Promise<ACIRExecutionResult>;
+}
+export type DecodedError = ExecutionError & {
+    decodedAssertionPayload?: any;
+    noirCallStack?: string[];
+};
+export declare function enrichNoirError(artifact: NoirCompiledCircuit, originalError: ExecutionError): DecodedError;
+//# 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/circuit_simulator.js

@@ -0,0 +1,43 @@
+import { abiDecodeError } from '@aztec/noir-noirc_abi';
+import { parseDebugSymbols } from '@aztec/stdlib/abi';
+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) {
+    const enrichedError = originalError;
+    if (originalError.rawAssertionPayload) {
+        try {
+            // Decode the payload
+            const decodedPayload = abiDecodeError(artifact.abi, originalError.rawAssertionPayload);
+            if (typeof decodedPayload === 'string') {
+                // If it's a string, just add it to the error message
+                enrichedError.message = `Circuit execution failed: ${decodedPayload}`;
+            } else {
+                // If not, attach the payload to the original error
+                enrichedError.decodedAssertionPayload = decodedPayload;
+            }
+        } catch  {
+        // Ignore errors decoding the payload
+        }
+    }
+    try {
+        // Decode the callstack
+        const callStack = extractCallStack(originalError, {
+            // TODO(https://github.com/AztecProtocol/aztec-packages/issues/5813)
+            // We only support handling debug info for the circuit entry point.
+            // So for now we simply index into the first debug info.
+            debugSymbols: parseDebugSymbols(artifact.debug_symbols)[0],
+            files: artifact.file_map
+        });
+        enrichedError.noirCallStack = callStack?.map((errorLocation)=>{
+            if (typeof errorLocation === 'string') {
+                return `at opcode ${errorLocation}`;
+            } else {
+                return `at ${errorLocation.locationText} (${errorLocation.filePath}:${errorLocation.line}:${errorLocation.column})`;
+            }
+        });
+    } catch  {
+    // Ignore errors resolving the callstack
+    }
+    return enrichedError;
+}

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/avm_context.d.ts

@@ -1,16 +1,16 @@
 import type { Fr } from '@aztec/foundation/fields';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { PublicPersistableStateManager } from '../state_manager/state_manager.js';
 import type { AvmExecutionEnvironment } from './avm_execution_environment.js';
 import { type Gas } from './avm_gas.js';
 import { AvmMachineState } from './avm_machine_state.js';
-import type { AvmSimulator } from './avm_simulator.js';
-import type { AvmPersistableStateManager } from './journal/journal.js';
+import type { AvmSimulatorInterface } from './avm_simulator_interface.js';
 /**
  * An execution context includes the information necessary to initiate AVM
  * execution along with all state maintained by the AVM throughout execution.
  */
 export declare class AvmContext {
-    persistableState: AvmPersistableStateManager;
+    persistableState: PublicPersistableStateManager;
     environment: AvmExecutionEnvironment;
     machineState: AvmMachineState;
     /**
@@ -20,8 +20,8 @@ export declare class AvmContext {
      * @param machineState - VM state that is modified on an instruction-by-instruction basis
      * @returns new AvmContext instance
      */
-    constructor(persistableState: AvmPersistableStateManager, environment: AvmExecutionEnvironment, machineState: AvmMachineState);
-    provideSimulator?: (ctx: this) => Promise<AvmSimulator>;
+    constructor(persistableState: PublicPersistableStateManager, environment: AvmExecutionEnvironment, machineState: AvmMachineState);
+    provideSimulator?: (context: AvmContext) => Promise<AvmSimulatorInterface>;
     /**
      * Prepare a new AVM context that will be ready for an external/nested call
      * - Fork the world state journal

package/dest/public/avm/avm_context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"avm_context.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,KAAK,GAAG,EAAgB,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAEvE;;;GAGG;AACH,qBAAa,UAAU;IASZ,gBAAgB,EAAE,0BAA0B;IAC5C,WAAW,EAAE,uBAAuB;IACpC,YAAY,EAAE,eAAe;IAVtC;;;;;;OAMG;gBAEM,gBAAgB,EAAE,0BAA0B,EAC5C,WAAW,EAAE,uBAAuB,EACpC,YAAY,EAAE,eAAe;IAK/B,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAE/D;;;;;;;;;;;;;OAaG;IACU,+BAA+B,CAC1C,OAAO,EAAE,YAAY,EACrB,QAAQ,EAAE,EAAE,EAAE,EACd,YAAY,EAAE,GAAG,EACjB,QAAQ,EAAE,MAAM,GAAG,YAAY,GAC9B,OAAO,CAAC,UAAU,CAAC;CAUvB"}
+{"version":3,"file":"avm_context.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,KAAK,GAAG,EAAgB,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAE1E;;;GAGG;AACH,qBAAa,UAAU;IASZ,gBAAgB,EAAE,6BAA6B;IAC/C,WAAW,EAAE,uBAAuB;IACpC,YAAY,EAAE,eAAe;IAVtC;;;;;;OAMG;gBAEM,gBAAgB,EAAE,6BAA6B,EAC/C,WAAW,EAAE,uBAAuB,EACpC,YAAY,EAAE,eAAe;IAK/B,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElF;;;;;;;;;;;;;OAaG;IACU,+BAA+B,CAC1C,OAAO,EAAE,YAAY,EACrB,QAAQ,EAAE,EAAE,EAAE,EACd,YAAY,EAAE,GAAG,EACjB,QAAQ,EAAE,MAAM,GAAG,YAAY,GAC9B,OAAO,CAAC,UAAU,CAAC;CAUvB"}

package/dest/public/avm/avm_contract_call_result.d.ts

@@ -11,7 +11,8 @@ export declare class AvmContractCallResult {
     output: Fr[];
     gasLeft: AvmGas;
     revertReason?: AvmRevertReason | undefined;
-    constructor(reverted: boolean, output: Fr[], gasLeft: AvmGas, revertReason?: AvmRevertReason | undefined);
+    totalInstructions: number;
+    constructor(reverted: boolean, output: Fr[], gasLeft: AvmGas, revertReason?: AvmRevertReason | undefined, totalInstructions?: number);
     toString(): string;
     finalize(): AvmFinalizedCallResult;
 }
@@ -24,7 +25,8 @@ export declare class AvmFinalizedCallResult {
     output: Fr[];
     gasLeft: Gas;
     revertReason?: SimulationError | undefined;
-    constructor(reverted: boolean, output: Fr[], gasLeft: Gas, revertReason?: SimulationError | undefined);
+    totalInstructions: number;
+    constructor(reverted: boolean, output: Fr[], gasLeft: Gas, revertReason?: SimulationError | undefined, totalInstructions?: number);
     toString(): string;
 }
 //# sourceMappingURL=avm_contract_call_result.d.ts.map

package/dest/public/avm/avm_contract_call_result.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"avm_contract_call_result.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_contract_call_result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAKxC,OAAO,KAAK,EAAE,GAAG,IAAI,MAAM,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD;;GAEG;AACH,qBAAa,qBAAqB;IAEvB,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,EAAE,EAAE;IACZ,OAAO,EAAE,MAAM;IACf,YAAY,CAAC;gBAHb,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,EAAE,EAAE,EACZ,OAAO,EAAE,MAAM,EACf,YAAY,CAAC,6BAAiB;IAGvC,QAAQ,IAAI,MAAM;IAQlB,QAAQ,IAAI,sBAAsB;CAInC;AAED;;;GAGG;AACH,qBAAa,sBAAsB;IAExB,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,EAAE,EAAE;IACZ,OAAO,EAAE,GAAG;IACZ,YAAY,CAAC;gBAHb,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,EAAE,EAAE,EACZ,OAAO,EAAE,GAAG,EACZ,YAAY,CAAC,6BAAiB;IAGvC,QAAQ,IAAI,MAAM;CAOnB"}
+{"version":3,"file":"avm_contract_call_result.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_contract_call_result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAKxC,OAAO,KAAK,EAAE,GAAG,IAAI,MAAM,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD;;GAEG;AACH,qBAAa,qBAAqB;IAEvB,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,EAAE,EAAE;IACZ,OAAO,EAAE,MAAM;IACf,YAAY,CAAC,EAAE,eAAe;IAC9B,iBAAiB,EAAE,MAAM;gBAJzB,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,EAAE,EAAE,EACZ,OAAO,EAAE,MAAM,EACf,YAAY,CAAC,EAAE,eAAe,YAAA,EAC9B,iBAAiB,GAAE,MAAU;IAGtC,QAAQ,IAAI,MAAM;IAUlB,QAAQ,IAAI,sBAAsB;CAUnC;AAED;;;GAGG;AACH,qBAAa,sBAAsB;IAExB,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,EAAE,EAAE;IACZ,OAAO,EAAE,GAAG;IACZ,YAAY,CAAC,EAAE,eAAe;IAC9B,iBAAiB,EAAE,MAAM;gBAJzB,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,EAAE,EAAE,EACZ,OAAO,EAAE,GAAG,EACZ,YAAY,CAAC,EAAE,eAAe,YAAA,EAC9B,iBAAiB,GAAE,MAAU;IAGtC,QAAQ,IAAI,MAAM;CASnB"}

package/dest/public/avm/avm_contract_call_result.js

@@ -8,22 +8,24 @@ import { createSimulationError } from '../../common/errors.js';
     output;
     gasLeft;
     revertReason;
-    constructor(reverted, output, gasLeft, revertReason){
+    totalInstructions;
+    constructor(reverted, output, gasLeft, revertReason, totalInstructions = 0){
         this.reverted = reverted;
         this.output = output;
         this.gasLeft = gasLeft;
         this.revertReason = revertReason;
+        this.totalInstructions = totalInstructions;
     }
     toString() {
-        let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}`;
+        let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}, totalInstructions: ${this.totalInstructions}`;
         if (this.revertReason) {
-            resultsStr += `, revertReason: ${this.revertReason}`;
+            resultsStr += `, revertReason: ${this.revertReason.message}`;
         }
         return resultsStr;
     }
     finalize() {
         const revertReason = this.revertReason ? createSimulationError(this.revertReason, this.output) : undefined;
-        return new AvmFinalizedCallResult(this.reverted, this.output, Gas.from(this.gasLeft), revertReason);
+        return new AvmFinalizedCallResult(this.reverted, this.output, Gas.from(this.gasLeft), revertReason, this.totalInstructions);
     }
 }
 /**
@@ -34,16 +36,18 @@ import { createSimulationError } from '../../common/errors.js';
     output;
     gasLeft;
     revertReason;
-    constructor(reverted, output, gasLeft, revertReason){
+    totalInstructions;
+    constructor(reverted, output, gasLeft, revertReason, totalInstructions = 0){
         this.reverted = reverted;
         this.output = output;
         this.gasLeft = gasLeft;
         this.revertReason = revertReason;
+        this.totalInstructions = totalInstructions;
     }
     toString() {
-        let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}`;
+        let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}, totalInstructions: ${this.totalInstructions}`;
         if (this.revertReason) {
-            resultsStr += `, revertReason: ${this.revertReason}`;
+            resultsStr += `, revertReason: ${this.revertReason.message}`;
         }
         return resultsStr;
     }

package/dest/public/avm/avm_execution_environment.d.ts

@@ -13,7 +13,9 @@ export declare class AvmExecutionEnvironment {
     readonly globals: GlobalVariables;
     readonly isStaticCall: boolean;
     readonly calldata: Fr[];
-    constructor(address: AztecAddress, sender: AztecAddress, contractCallDepth: Fr, transactionFee: Fr, globals: GlobalVariables, isStaticCall: boolean, calldata: Fr[]);
+    readonly clientInitiatedSimulation: boolean;
+    readonly maxDebugLogMemoryReads: number;
+    constructor(address: AztecAddress, sender: AztecAddress, contractCallDepth: Fr, transactionFee: Fr, globals: GlobalVariables, isStaticCall: boolean, calldata: Fr[], clientInitiatedSimulation?: boolean, maxDebugLogMemoryReads?: number);
     private deriveEnvironmentForNestedCallInternal;
     deriveEnvironmentForNestedCall(targetAddress: AztecAddress, calldata: Fr[]): AvmExecutionEnvironment;
     deriveEnvironmentForNestedStaticCall(targetAddress: AztecAddress, calldata: Fr[]): AvmExecutionEnvironment;

package/dest/public/avm/avm_execution_environment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"avm_execution_environment.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_execution_environment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;GAGG;AACH,qBAAa,uBAAuB;aAEhB,OAAO,EAAE,YAAY;aACrB,MAAM,EAAE,YAAY;aACpB,iBAAiB,EAAE,EAAE;aACrB,cAAc,EAAE,EAAE;aAClB,OAAO,EAAE,eAAe;aACxB,YAAY,EAAE,OAAO;aACrB,QAAQ,EAAE,EAAE,EAAE;gBANd,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,YAAY,EACpB,iBAAiB,EAAE,EAAE,EACrB,cAAc,EAAE,EAAE,EAClB,OAAO,EAAE,eAAe,EACxB,YAAY,EAAE,OAAO,EACrB,QAAQ,EAAE,EAAE,EAAE;IAGhC,OAAO,CAAC,sCAAsC;IAYvC,8BAA8B,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,uBAAuB;IAIpG,oCAAoC,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,uBAAuB;CAGlH"}
+{"version":3,"file":"avm_execution_environment.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_execution_environment.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;GAGG;AACH,qBAAa,uBAAuB;aAEhB,OAAO,EAAE,YAAY;aACrB,MAAM,EAAE,YAAY;aACpB,iBAAiB,EAAE,EAAE;aACrB,cAAc,EAAE,EAAE;aAClB,OAAO,EAAE,eAAe;aACxB,YAAY,EAAE,OAAO;aACrB,QAAQ,EAAE,EAAE,EAAE;aACd,yBAAyB,EAAE,OAAO;aAClC,sBAAsB,EAAE,MAAM;gBAR9B,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,YAAY,EACpB,iBAAiB,EAAE,EAAE,EACrB,cAAc,EAAE,EAAE,EAClB,OAAO,EAAE,eAAe,EACxB,YAAY,EAAE,OAAO,EACrB,QAAQ,EAAE,EAAE,EAAE,EACd,yBAAyB,GAAE,OAAe,EAC1C,sBAAsB,GAAE,MAA2C;IAGrF,OAAO,CAAC,sCAAsC;IAkBvC,8BAA8B,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,uBAAuB;IAIpG,oCAAoC,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,uBAAuB;CAGlH"}

package/dest/public/avm/avm_execution_environment.js

@@ -1,3 +1,4 @@
+import { DEFAULT_MAX_DEBUG_LOG_MEMORY_READS } from '@aztec/constants';
 import { Fr } from '@aztec/foundation/fields';
 /**
  * Contains variables that remain constant during AVM execution
@@ -10,7 +11,9 @@ import { Fr } from '@aztec/foundation/fields';
     globals;
     isStaticCall;
     calldata;
-    constructor(address, sender, contractCallDepth, transactionFee, globals, isStaticCall, calldata){
+    clientInitiatedSimulation;
+    maxDebugLogMemoryReads;
+    constructor(address, sender, contractCallDepth, transactionFee, globals, isStaticCall, calldata, clientInitiatedSimulation = false, maxDebugLogMemoryReads = DEFAULT_MAX_DEBUG_LOG_MEMORY_READS){
         this.address = address;
         this.sender = sender;
         this.contractCallDepth = contractCallDepth;
@@ -18,9 +21,11 @@ import { Fr } from '@aztec/foundation/fields';
         this.globals = globals;
         this.isStaticCall = isStaticCall;
         this.calldata = calldata;
+        this.clientInitiatedSimulation = clientInitiatedSimulation;
+        this.maxDebugLogMemoryReads = maxDebugLogMemoryReads;
     }
     deriveEnvironmentForNestedCallInternal(targetAddress, calldata, isStaticCall) {
-        return new AvmExecutionEnvironment(/*address=*/ targetAddress, /*sender=*/ this.address, this.contractCallDepth.add(Fr.ONE), this.transactionFee, this.globals, isStaticCall, calldata);
+        return new AvmExecutionEnvironment(/*address=*/ targetAddress, /*sender=*/ this.address, this.contractCallDepth.add(Fr.ONE), this.transactionFee, this.globals, isStaticCall, calldata, this.clientInitiatedSimulation, this.maxDebugLogMemoryReads);
     }
     deriveEnvironmentForNestedCall(targetAddress, calldata) {
         return this.deriveEnvironmentForNestedCallInternal(targetAddress, calldata, /*isStaticCall=*/ false);

package/dest/public/avm/avm_gas.d.ts

@@ -36,25 +36,9 @@ export declare const EmptyGas: Gas;
 export declare const GAS_DIMENSIONS: readonly ["l2Gas", "daGas"];
 /** Returns the fixed base gas cost for a given opcode. */
 export declare function getBaseGasCost(opcode: Opcode): Gas;
+export declare function computeAddressingCost(indirectOperandsCount: number, relativeOperandsCount: number): Gas;
 export declare function getDynamicGasCost(opcode: Opcode): Gas;
-/** Returns the gas cost associated with the memory operations performed. */
-export declare function getMemoryGasCost(args: {
-    reads?: number;
-    writes?: number;
-    indirect?: number;
-}): {
-    l2Gas: number;
-    daGas: number;
-};
-/** Constants used in base cost calculations. */
-export declare const GAS_COST_CONSTANTS: {
-    MEMORY_READ: number;
-    MEMORY_INDIRECT_READ_PENALTY: number;
-    MEMORY_WRITE: number;
-};
-/** Returns gas cost for an operation on a given type tag based on the base cost per byte. */
-export declare function getGasCostForTypeTag(tag: TypeTag, baseCost: Gas): {
-    l2Gas: number;
-    daGas: number;
-};
+/** Returns a multiplier based on the byte size of the type represented by the integer tag.
+ * Used to account for necessary rows in the bitwise trace. Throws on invalid. */
+export declare function getBitwiseDynamicGasMultiplier(tag: TypeTag): 0 | 1 | 2 | 8 | 4 | 16;
 //# sourceMappingURL=avm_gas.d.ts.map

package/dest/public/avm/avm_gas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"avm_gas.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_gas.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,OAAO,EAAE,MAAM,EAAE,MAAM,8CAA8C,CAAC;AAEtE,sCAAsC;AACtC,MAAM,MAAM,GAAG,GAAG;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,+CAA+C;AAC/C,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG;;;EAEpC;AAED,+CAA+C;AAC/C,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;;;EAE7E;AAED,8EAA8E;AAC9E,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC;;;EAE5C;AAED,+CAA+C;AAC/C,wBAAgB,MAAM,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,OAQ9C;AAED,6CAA6C;AAC7C,wBAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM;;;EAEvD;AAED,0CAA0C;AAC1C,eAAO,MAAM,QAAQ,EAAE,GAGtB,CAAC;AAMF,+CAA+C;AAC/C,eAAO,MAAM,cAAc,6BAA8B,CAAC;AAuF1D,0DAA0D;AAC1D,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAElD;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAErD;AAED,4EAA4E;AAC5E,wBAAgB,gBAAgB,CAAC,IAAI,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE;;;EAQ5F;AAED,gDAAgD;AAChD,eAAO,MAAM,kBAAkB;;;;CAI9B,CAAC;AAEF,6FAA6F;AAC7F,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG;;;EAE/D"}
+{"version":3,"file":"avm_gas.d.ts","sourceRoot":"","sources":["../../../src/public/avm/avm_gas.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,8CAA8C,CAAC;AAEtE,sCAAsC;AACtC,MAAM,MAAM,GAAG,GAAG;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,+CAA+C;AAC/C,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG;;;EAEpC;AAED,+CAA+C;AAC/C,wBAAgB,YAAY,CAAC,OAAO,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;;;EAE7E;AAED,8EAA8E;AAC9E,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC;WAfpC,MAAM;WACN,MAAM;EAgBd;AAED,+CAA+C;AAC/C,wBAAgB,MAAM,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,OAQ9C;AAED,6CAA6C;AAC7C,wBAAgB,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM;;;EAEvD;AAED,0CAA0C;AAC1C,eAAO,MAAM,QAAQ,EAAE,GAGtB,CAAC;AAMF,+CAA+C;AAC/C,eAAO,MAAM,cAAc,6BAA8B,CAAC;AAyF1D,0DAA0D;AAC1D,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAElD;AAED,wBAAgB,qBAAqB,CAAC,qBAAqB,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,GAAG,GAAG,CAOvG;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAErD;AAED;iFACiF;AACjF,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,OAAO,0BAmB1D"}