@aztec/simulator 0.22.0

package/dest/avm/avm_message_call_result.js

@@ -0,0 +1,21 @@
+/**
+ * Results of an contract call's execution in the AVM.
+ */
+export class AvmContractCallResults {
+    constructor(reverted, output, revertReason) {
+        this.reverted = reverted;
+        this.output = output;
+        this.revertReason = revertReason;
+    }
+    /**
+     * Generate a string representation of call results.
+     */
+    toString() {
+        let resultsStr = `reverted: ${this.reverted}, output: ${this.output}`;
+        if (this.revertReason) {
+            resultsStr += `, revertReason: ${this.revertReason}`;
+        }
+        return resultsStr;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXZtX21lc3NhZ2VfY2FsbF9yZXN1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXZtL2F2bV9tZXNzYWdlX2NhbGxfcmVzdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBOztHQUVHO0FBQ0gsTUFBTSxPQUFPLHNCQUFzQjtJQU9qQyxZQUFZLFFBQWlCLEVBQUUsTUFBWSxFQUFFLFlBQW9CO1FBQy9ELElBQUksQ0FBQyxRQUFRLEdBQUcsUUFBUSxDQUFDO1FBQ3pCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO1FBQ3JCLElBQUksQ0FBQyxZQUFZLEdBQUcsWUFBWSxDQUFDO0lBQ25DLENBQUM7SUFFRDs7T0FFRztJQUNILFFBQVE7UUFDTixJQUFJLFVBQVUsR0FBRyxhQUFhLElBQUksQ0FBQyxRQUFRLGFBQWEsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ3RFLElBQUksSUFBSSxDQUFDLFlBQVksRUFBRSxDQUFDO1lBQ3RCLFVBQVUsSUFBSSxtQkFBbUIsSUFBSSxDQUFDLFlBQVksRUFBRSxDQUFDO1FBQ3ZELENBQUM7UUFDRCxPQUFPLFVBQVUsQ0FBQztJQUNwQixDQUFDO0NBQ0YifQ==

package/dest/avm/avm_simulator.d.ts

@@ -0,0 +1,22 @@
+import type { AvmContext } from './avm_context.js';
+import { AvmContractCallResults } from './avm_message_call_result.js';
+import type { Instruction } from './opcodes/index.js';
+export declare class AvmSimulator {
+    private context;
+    private log;
+    constructor(context: AvmContext);
+    /**
+     * Fetch the bytecode and execute it in the current context.
+     */
+    execute(): Promise<AvmContractCallResults>;
+    /**
+     * Executes the provided instructions in the current context.
+     * This method is useful for testing and debugging.
+     */
+    executeInstructions(instructions: Instruction[]): Promise<AvmContractCallResults>;
+    /**
+     * Fetch contract bytecode from world state and decode into executable instructions.
+     */
+    private fetchAndDecodeBytecode;
+}
+//# sourceMappingURL=avm_simulator.d.ts.map

package/dest/avm/avm_simulator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"avm_simulator.d.ts","sourceRoot":"","sources":["../../src/avm/avm_simulator.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAEtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGtD,qBAAa,YAAY;IAGX,OAAO,CAAC,OAAO;IAF3B,OAAO,CAAC,GAAG,CAAyD;gBAEhD,OAAO,EAAE,UAAU;IAEvC;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAKvD;;;OAGG;IACU,mBAAmB,CAAC,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAyC9F;;OAEG;YACW,sBAAsB;CAgBrC"}

package/dest/avm/avm_simulator.js

@@ -0,0 +1,74 @@
+import { FunctionSelector } from '@aztec/circuits.js';
+import { createDebugLogger } from '@aztec/foundation/log';
+import { strict as assert } from 'assert';
+import { AvmContractCallResults } from './avm_message_call_result.js';
+import { AvmExecutionError, InvalidProgramCounterError, NoBytecodeForContractError } from './errors.js';
+import { decodeFromBytecode } from './serialization/bytecode_serialization.js';
+export class AvmSimulator {
+    constructor(context) {
+        this.context = context;
+        this.log = createDebugLogger('aztec:avm_simulator');
+    }
+    /**
+     * Fetch the bytecode and execute it in the current context.
+     */
+    async execute() {
+        const instructions = await this.fetchAndDecodeBytecode();
+        return this.executeInstructions(instructions);
+    }
+    /**
+     * Executes the provided instructions in the current context.
+     * This method is useful for testing and debugging.
+     */
+    async executeInstructions(instructions) {
+        assert(instructions.length > 0);
+        try {
+            // Execute instruction pointed to by the current program counter
+            // continuing until the machine state signifies a halt
+            while (!this.context.machineState.halted) {
+                const instruction = instructions[this.context.machineState.pc];
+                assert(!!instruction); // This should never happen
+                this.log(`Executing PC=${this.context.machineState.pc}: ${instruction.toString()}`);
+                // Execute the instruction.
+                // Normal returns and reverts will return normally here.
+                // "Exceptional halts" will throw.
+                await instruction.execute(this.context);
+                if (this.context.machineState.pc >= instructions.length) {
+                    this.log('Passed end of program!');
+                    throw new InvalidProgramCounterError(this.context.machineState.pc, /*max=*/ instructions.length);
+                }
+            }
+            // Return results for processing by calling context
+            const results = this.context.machineState.getResults();
+            this.log(`Context execution results: ${results.toString()}`);
+            return results;
+        }
+        catch (e) {
+            this.log('Exceptional halt');
+            if (!(e instanceof AvmExecutionError)) {
+                this.log(`Unknown error thrown by avm: ${e}`);
+                throw e;
+            }
+            // Return results for processing by calling context
+            // Note: "exceptional halts" cannot return data
+            const results = new AvmContractCallResults(/*reverted=*/ true, /*output=*/ [], /*revertReason=*/ e);
+            this.log(`Context execution results: ${results.toString()}`);
+            return results;
+        }
+    }
+    /**
+     * Fetch contract bytecode from world state and decode into executable instructions.
+     */
+    async fetchAndDecodeBytecode() {
+        // NOTE: the following is mocked as getPublicBytecode does not exist yet
+        const selector = new FunctionSelector(0);
+        const bytecode = await this.context.worldState.hostStorage.contractsDb.getBytecode(this.context.environment.address, selector);
+        // This assumes that we will not be able to send messages to accounts without code
+        // Pending classes and instances impl details
+        if (!bytecode) {
+            throw new NoBytecodeForContractError(this.context.environment.address);
+        }
+        return decodeFromBytecode(bytecode);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXZtX3NpbXVsYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hdm0vYXZtX3NpbXVsYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUN0RCxPQUFPLEVBQWUsaUJBQWlCLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUV2RSxPQUFPLEVBQUUsTUFBTSxJQUFJLE1BQU0sRUFBRSxNQUFNLFFBQVEsQ0FBQztBQUcxQyxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUN0RSxPQUFPLEVBQUUsaUJBQWlCLEVBQUUsMEJBQTBCLEVBQUUsMEJBQTBCLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFFeEcsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sMkNBQTJDLENBQUM7QUFFL0UsTUFBTSxPQUFPLFlBQVk7SUFHdkIsWUFBb0IsT0FBbUI7UUFBbkIsWUFBTyxHQUFQLE9BQU8sQ0FBWTtRQUYvQixRQUFHLEdBQWdCLGlCQUFpQixDQUFDLHFCQUFxQixDQUFDLENBQUM7SUFFMUIsQ0FBQztJQUUzQzs7T0FFRztJQUNJLEtBQUssQ0FBQyxPQUFPO1FBQ2xCLE1BQU0sWUFBWSxHQUFHLE1BQU0sSUFBSSxDQUFDLHNCQUFzQixFQUFFLENBQUM7UUFDekQsT0FBTyxJQUFJLENBQUMsbUJBQW1CLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDaEQsQ0FBQztJQUVEOzs7T0FHRztJQUNJLEtBQUssQ0FBQyxtQkFBbUIsQ0FBQyxZQUEyQjtRQUMxRCxNQUFNLENBQUMsWUFBWSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQztRQUVoQyxJQUFJLENBQUM7WUFDSCxnRUFBZ0U7WUFDaEUsc0RBQXNEO1lBQ3RELE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxNQUFNLEVBQUUsQ0FBQztnQkFDekMsTUFBTSxXQUFXLEdBQUcsWUFBWSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQyxDQUFDO2dCQUMvRCxNQUFNLENBQUMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsMkJBQTJCO2dCQUVsRCxJQUFJLENBQUMsR0FBRyxDQUFDLGdCQUFnQixJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxFQUFFLEtBQUssV0FBVyxDQUFDLFFBQVEsRUFBRSxFQUFFLENBQUMsQ0FBQztnQkFDcEYsMkJBQTJCO2dCQUMzQix3REFBd0Q7Z0JBQ3hELGtDQUFrQztnQkFDbEMsTUFBTSxXQUFXLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztnQkFFeEMsSUFBSSxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxFQUFFLElBQUksWUFBWSxDQUFDLE1BQU0sRUFBRSxDQUFDO29CQUN4RCxJQUFJLENBQUMsR0FBRyxDQUFDLHdCQUF3QixDQUFDLENBQUM7b0JBQ25DLE1BQU0sSUFBSSwwQkFBMEIsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxFQUFFLEVBQUUsUUFBUSxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztnQkFDbkcsQ0FBQztZQUNILENBQUM7WUFFRCxtREFBbUQ7WUFDbkQsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDdkQsSUFBSSxDQUFDLEdBQUcsQ0FBQyw4QkFBOEIsT0FBTyxDQUFDLFFBQVEsRUFBRSxFQUFFLENBQUMsQ0FBQztZQUM3RCxPQUFPLE9BQU8sQ0FBQztRQUNqQixDQUFDO1FBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztZQUNYLElBQUksQ0FBQyxHQUFHLENBQUMsa0JBQWtCLENBQUMsQ0FBQztZQUM3QixJQUFJLENBQUMsQ0FBQyxDQUFDLFlBQVksaUJBQWlCLENBQUMsRUFBRSxDQUFDO2dCQUN0QyxJQUFJLENBQUMsR0FBRyxDQUFDLGdDQUFnQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO2dCQUM5QyxNQUFNLENBQUMsQ0FBQztZQUNWLENBQUM7WUFFRCxtREFBbUQ7WUFDbkQsK0NBQStDO1lBQy9DLE1BQU0sT0FBTyxHQUFHLElBQUksc0JBQXNCLENBQUMsYUFBYSxDQUFDLElBQUksRUFBRSxXQUFXLENBQUMsRUFBRSxFQUFFLGlCQUFpQixDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ3BHLElBQUksQ0FBQyxHQUFHLENBQUMsOEJBQThCLE9BQU8sQ0FBQyxRQUFRLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDN0QsT0FBTyxPQUFPLENBQUM7UUFDakIsQ0FBQztJQUNILENBQUM7SUFFRDs7T0FFRztJQUNLLEtBQUssQ0FBQyxzQkFBc0I7UUFDbEMsd0VBQXdFO1FBQ3hFLE1BQU0sUUFBUSxHQUFHLElBQUksZ0JBQWdCLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDekMsTUFBTSxRQUFRLEdBQUcsTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQUMsV0FBVyxDQUFDLFdBQVcsQ0FDaEYsSUFBSSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsT0FBTyxFQUNoQyxRQUFRLENBQ1QsQ0FBQztRQUVGLGtGQUFrRjtRQUNsRiw2Q0FBNkM7UUFDN0MsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQ2QsTUFBTSxJQUFJLDBCQUEwQixDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ3pFLENBQUM7UUFFRCxPQUFPLGtCQUFrQixDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ3RDLENBQUM7Q0FDRiJ9

package/dest/avm/errors.d.ts

@@ -0,0 +1,30 @@
+import { AztecAddress } from '@aztec/circuits.js';
+/**
+ * Avm-specific errors should derive from this
+ */
+export declare abstract class AvmExecutionError extends Error {
+    constructor(message: string, ...rest: any[]);
+}
+export declare class NoBytecodeForContractError extends AvmExecutionError {
+    constructor(contractAddress: AztecAddress);
+}
+/**
+ * Error is thrown when the program counter goes to an invalid location.
+ * There is no instruction at the provided pc
+ */
+export declare class InvalidProgramCounterError extends AvmExecutionError {
+    constructor(pc: number, max: number);
+}
+/**
+ * Error thrown during an instruction's execution (during its execute()).
+ */
+export declare class InstructionExecutionError extends AvmExecutionError {
+    constructor(message: string);
+}
+/**
+ * Error thrown on failed AVM memory tag check.
+ */
+export declare class TagCheckError extends AvmExecutionError {
+    constructor(offset: number, gotTag: string, expectedTag: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dest/avm/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/avm/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,8BAAsB,iBAAkB,SAAQ,KAAK;gBACvC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;CAI5C;AAED,qBAAa,0BAA2B,SAAQ,iBAAiB;gBACnD,eAAe,EAAE,YAAY;CAI1C;AAED;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,iBAAiB;gBACnD,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;CAIpC;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,iBAAiB;gBAClD,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;gBACtC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;CAIhE"}

package/dest/avm/errors.js

@@ -0,0 +1,44 @@
+/**
+ * Avm-specific errors should derive from this
+ */
+export class AvmExecutionError extends Error {
+    constructor(message, ...rest) {
+        super(message, ...rest);
+        this.name = 'AvmInterpreterError';
+    }
+}
+export class NoBytecodeForContractError extends AvmExecutionError {
+    constructor(contractAddress) {
+        super(`No bytecode found at: ${contractAddress}`);
+        this.name = 'NoBytecodeFoundInterpreterError';
+    }
+}
+/**
+ * Error is thrown when the program counter goes to an invalid location.
+ * There is no instruction at the provided pc
+ */
+export class InvalidProgramCounterError extends AvmExecutionError {
+    constructor(pc, max) {
+        super(`Invalid program counter ${pc}, max is ${max}`);
+        this.name = 'InvalidProgramCounterError';
+    }
+}
+/**
+ * Error thrown during an instruction's execution (during its execute()).
+ */
+export class InstructionExecutionError extends AvmExecutionError {
+    constructor(message) {
+        super(message);
+        this.name = 'InstructionExecutionError';
+    }
+}
+/**
+ * Error thrown on failed AVM memory tag check.
+ */
+export class TagCheckError extends AvmExecutionError {
+    constructor(offset, gotTag, expectedTag) {
+        super(`Memory offset ${offset} has tag ${gotTag}, expected ${expectedTag}`);
+        this.name = 'TagCheckError';
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2F2bS9lcnJvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUE7O0dBRUc7QUFDSCxNQUFNLE9BQWdCLGlCQUFrQixTQUFRLEtBQUs7SUFDbkQsWUFBWSxPQUFlLEVBQUUsR0FBRyxJQUFXO1FBQ3pDLEtBQUssQ0FBQyxPQUFPLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztRQUN4QixJQUFJLENBQUMsSUFBSSxHQUFHLHFCQUFxQixDQUFDO0lBQ3BDLENBQUM7Q0FDRjtBQUVELE1BQU0sT0FBTywwQkFBMkIsU0FBUSxpQkFBaUI7SUFDL0QsWUFBWSxlQUE2QjtRQUN2QyxLQUFLLENBQUMseUJBQXlCLGVBQWUsRUFBRSxDQUFDLENBQUM7UUFDbEQsSUFBSSxDQUFDLElBQUksR0FBRyxpQ0FBaUMsQ0FBQztJQUNoRCxDQUFDO0NBQ0Y7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLE9BQU8sMEJBQTJCLFNBQVEsaUJBQWlCO0lBQy9ELFlBQVksRUFBVSxFQUFFLEdBQVc7UUFDakMsS0FBSyxDQUFDLDJCQUEyQixFQUFFLFlBQVksR0FBRyxFQUFFLENBQUMsQ0FBQztRQUN0RCxJQUFJLENBQUMsSUFBSSxHQUFHLDRCQUE0QixDQUFDO0lBQzNDLENBQUM7Q0FDRjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxPQUFPLHlCQUEwQixTQUFRLGlCQUFpQjtJQUM5RCxZQUFZLE9BQWU7UUFDekIsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQ2YsSUFBSSxDQUFDLElBQUksR0FBRywyQkFBMkIsQ0FBQztJQUMxQyxDQUFDO0NBQ0Y7QUFFRDs7R0FFRztBQUNILE1BQU0sT0FBTyxhQUFjLFNBQVEsaUJBQWlCO0lBQ2xELFlBQVksTUFBYyxFQUFFLE1BQWMsRUFBRSxXQUFtQjtRQUM3RCxLQUFLLENBQUMsaUJBQWlCLE1BQU0sWUFBWSxNQUFNLGNBQWMsV0FBVyxFQUFFLENBQUMsQ0FBQztRQUM1RSxJQUFJLENBQUMsSUFBSSxHQUFHLGVBQWUsQ0FBQztJQUM5QixDQUFDO0NBQ0YifQ==

package/dest/avm/fixtures/index.d.ts

@@ -0,0 +1,28 @@
+import { GlobalVariables } from '@aztec/circuits.js';
+import { AvmContext } from '../avm_context.js';
+import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
+import { AvmMachineState } from '../avm_machine_state.js';
+import { AvmWorldStateJournal } from '../journal/journal.js';
+/**
+ * Create a new AVM context with default values.
+ */
+export declare function initContext(overrides?: {
+    worldState?: AvmWorldStateJournal;
+    env?: AvmExecutionEnvironment;
+    machineState?: AvmMachineState;
+}): AvmContext;
+/** Creates an empty world state with mocked storage. */
+export declare function initMockWorldStateJournal(): AvmWorldStateJournal;
+/**
+ * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
+ */
+export declare function initExecutionEnvironment(overrides?: Partial<AvmExecutionEnvironment>): AvmExecutionEnvironment;
+/**
+ * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
+ */
+export declare function initGlobalVariables(overrides?: Partial<GlobalVariables>): GlobalVariables;
+/**
+ * Create an empty instance of the Machine State where all values are zero, unless overridden in the overrides object
+ */
+export declare function initMachineState(overrides?: Partial<AvmMachineState>): AvmMachineState;
+//# sourceMappingURL=index.d.ts.map

package/dest/avm/fixtures/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/avm/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAQrD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;GAEG;AACH,wBAAgB,WAAW,CAAC,SAAS,CAAC,EAAE;IACtC,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,GAAG,CAAC,EAAE,uBAAuB,CAAC;IAC9B,YAAY,CAAC,EAAE,eAAe,CAAC;CAChC,GAAG,UAAU,CAMb;AAED,wDAAwD;AACxD,wBAAgB,yBAAyB,IAAI,oBAAoB,CAGhE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,uBAAuB,CAgB9G;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe,CAOzF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe,CAMtF"}

package/dest/avm/fixtures/index.js

@@ -0,0 +1,44 @@
+import { GlobalVariables } from '@aztec/circuits.js';
+import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { Fr } from '@aztec/foundation/fields';
+import { mock } from 'jest-mock-extended';
+import { AvmContext } from '../avm_context.js';
+import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
+import { AvmMachineState } from '../avm_machine_state.js';
+import { HostStorage } from '../journal/host_storage.js';
+import { AvmWorldStateJournal } from '../journal/journal.js';
+/**
+ * Create a new AVM context with default values.
+ */
+export function initContext(overrides) {
+    return new AvmContext(overrides?.worldState || initMockWorldStateJournal(), overrides?.env || initExecutionEnvironment(), overrides?.machineState || initMachineState());
+}
+/** Creates an empty world state with mocked storage. */
+export function initMockWorldStateJournal() {
+    const hostStorage = new HostStorage(mock(), mock(), mock());
+    return new AvmWorldStateJournal(hostStorage);
+}
+/**
+ * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
+ */
+export function initExecutionEnvironment(overrides) {
+    return new AvmExecutionEnvironment(overrides?.address ?? AztecAddress.zero(), overrides?.storageAddress ?? AztecAddress.zero(), overrides?.origin ?? AztecAddress.zero(), overrides?.sender ?? AztecAddress.zero(), overrides?.portal ?? EthAddress.ZERO, overrides?.feePerL1Gas ?? Fr.zero(), overrides?.feePerL2Gas ?? Fr.zero(), overrides?.feePerDaGas ?? Fr.zero(), overrides?.contractCallDepth ?? Fr.zero(), overrides?.globals ?? GlobalVariables.empty(), overrides?.isStaticCall ?? false, overrides?.isDelegateCall ?? false, overrides?.calldata ?? []);
+}
+/**
+ * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
+ */
+export function initGlobalVariables(overrides) {
+    return new GlobalVariables(overrides?.chainId ?? Fr.zero(), overrides?.version ?? Fr.zero(), overrides?.blockNumber ?? Fr.zero(), overrides?.timestamp ?? Fr.zero());
+}
+/**
+ * Create an empty instance of the Machine State where all values are zero, unless overridden in the overrides object
+ */
+export function initMachineState(overrides) {
+    return AvmMachineState.fromState({
+        l1GasLeft: overrides?.l1GasLeft ?? 0,
+        l2GasLeft: overrides?.l2GasLeft ?? 0,
+        daGasLeft: overrides?.daGasLeft ?? 0,
+    });
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXZtL2ZpeHR1cmVzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUNyRCxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDL0QsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLCtCQUErQixDQUFDO0FBQzNELE9BQU8sRUFBRSxFQUFFLEVBQUUsTUFBTSwwQkFBMEIsQ0FBQztBQUU5QyxPQUFPLEVBQUUsSUFBSSxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFHMUMsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBQy9DLE9BQU8sRUFBRSx1QkFBdUIsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQzFFLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUMxRCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFDekQsT0FBTyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFFN0Q7O0dBRUc7QUFDSCxNQUFNLFVBQVUsV0FBVyxDQUFDLFNBSTNCO0lBQ0MsT0FBTyxJQUFJLFVBQVUsQ0FDbkIsU0FBUyxFQUFFLFVBQVUsSUFBSSx5QkFBeUIsRUFBRSxFQUNwRCxTQUFTLEVBQUUsR0FBRyxJQUFJLHdCQUF3QixFQUFFLEVBQzVDLFNBQVMsRUFBRSxZQUFZLElBQUksZ0JBQWdCLEVBQUUsQ0FDOUMsQ0FBQztBQUNKLENBQUM7QUFFRCx3REFBd0Q7QUFDeEQsTUFBTSxVQUFVLHlCQUF5QjtJQUN2QyxNQUFNLFdBQVcsR0FBRyxJQUFJLFdBQVcsQ0FBQyxJQUFJLEVBQWlCLEVBQUUsSUFBSSxFQUFxQixFQUFFLElBQUksRUFBaUIsQ0FBQyxDQUFDO0lBQzdHLE9BQU8sSUFBSSxvQkFBb0IsQ0FBQyxXQUFXLENBQUMsQ0FBQztBQUMvQyxDQUFDO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLFVBQVUsd0JBQXdCLENBQUMsU0FBNEM7SUFDbkYsT0FBTyxJQUFJLHVCQUF1QixDQUNoQyxTQUFTLEVBQUUsT0FBTyxJQUFJLFlBQVksQ0FBQyxJQUFJLEVBQUUsRUFDekMsU0FBUyxFQUFFLGNBQWMsSUFBSSxZQUFZLENBQUMsSUFBSSxFQUFFLEVBQ2hELFNBQVMsRUFBRSxNQUFNLElBQUksWUFBWSxDQUFDLElBQUksRUFBRSxFQUN4QyxTQUFTLEVBQUUsTUFBTSxJQUFJLFlBQVksQ0FBQyxJQUFJLEVBQUUsRUFDeEMsU0FBUyxFQUFFLE1BQU0sSUFBSSxVQUFVLENBQUMsSUFBSSxFQUNwQyxTQUFTLEVBQUUsV0FBVyxJQUFJLEVBQUUsQ0FBQyxJQUFJLEVBQUUsRUFDbkMsU0FBUyxFQUFFLFdBQVcsSUFBSSxFQUFFLENBQUMsSUFBSSxFQUFFLEVBQ25DLFNBQVMsRUFBRSxXQUFXLElBQUksRUFBRSxDQUFDLElBQUksRUFBRSxFQUNuQyxTQUFTLEVBQUUsaUJBQWlCLElBQUksRUFBRSxDQUFDLElBQUksRUFBRSxFQUN6QyxTQUFTLEVBQUUsT0FBTyxJQUFJLGVBQWUsQ0FBQyxLQUFLLEVBQUUsRUFDN0MsU0FBUyxFQUFFLFlBQVksSUFBSSxLQUFLLEVBQ2hDLFNBQVMsRUFBRSxjQUFjLElBQUksS0FBSyxFQUNsQyxTQUFTLEVBQUUsUUFBUSxJQUFJLEVBQUUsQ0FDMUIsQ0FBQztBQUNKLENBQUM7QUFFRDs7R0FFRztBQUNILE1BQU0sVUFBVSxtQkFBbUIsQ0FBQyxTQUFvQztJQUN0RSxPQUFPLElBQUksZUFBZSxDQUN4QixTQUFTLEVBQUUsT0FBTyxJQUFJLEVBQUUsQ0FBQyxJQUFJLEVBQUUsRUFDL0IsU0FBUyxFQUFFLE9BQU8sSUFBSSxFQUFFLENBQUMsSUFBSSxFQUFFLEVBQy9CLFNBQVMsRUFBRSxXQUFXLElBQUksRUFBRSxDQUFDLElBQUksRUFBRSxFQUNuQyxTQUFTLEVBQUUsU0FBUyxJQUFJLEVBQUUsQ0FBQyxJQUFJLEVBQUUsQ0FDbEMsQ0FBQztBQUNKLENBQUM7QUFFRDs7R0FFRztBQUNILE1BQU0sVUFBVSxnQkFBZ0IsQ0FBQyxTQUFvQztJQUNuRSxPQUFPLGVBQWUsQ0FBQyxTQUFTLENBQUM7UUFDL0IsU0FBUyxFQUFFLFNBQVMsRUFBRSxTQUFTLElBQUksQ0FBQztRQUNwQyxTQUFTLEVBQUUsU0FBUyxFQUFFLFNBQVMsSUFBSSxDQUFDO1FBQ3BDLFNBQVMsRUFBRSxTQUFTLEVBQUUsU0FBUyxJQUFJLENBQUM7S0FDckMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyJ9

package/dest/avm/journal/host_storage.d.ts

@@ -0,0 +1,13 @@
+import { CommitmentsDB, PublicContractsDB, PublicStateDB } from '../../index.js';
+/**
+ * Host storage
+ *
+ * A wrapper around the node dbs
+ */
+export declare class HostStorage {
+    readonly publicStateDb: PublicStateDB;
+    readonly contractsDb: PublicContractsDB;
+    readonly commitmentsDb: CommitmentsDB;
+    constructor(publicStateDb: PublicStateDB, contractsDb: PublicContractsDB, commitmentsDb: CommitmentsDB);
+}
+//# sourceMappingURL=host_storage.d.ts.map

package/dest/avm/journal/host_storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"host_storage.d.ts","sourceRoot":"","sources":["../../../src/avm/journal/host_storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEjF;;;;GAIG;AACH,qBAAa,WAAW;IACtB,SAAgB,aAAa,EAAE,aAAa,CAAC;IAE7C,SAAgB,WAAW,EAAE,iBAAiB,CAAC;IAE/C,SAAgB,aAAa,EAAE,aAAa,CAAC;gBAEjC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa;CAKvG"}

package/dest/avm/journal/host_storage.js

@@ -0,0 +1,13 @@
+/**
+ * Host storage
+ *
+ * A wrapper around the node dbs
+ */
+export class HostStorage {
+    constructor(publicStateDb, contractsDb, commitmentsDb) {
+        this.publicStateDb = publicStateDb;
+        this.contractsDb = contractsDb;
+        this.commitmentsDb = commitmentsDb;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaG9zdF9zdG9yYWdlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2F2bS9qb3VybmFsL2hvc3Rfc3RvcmFnZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7OztHQUlHO0FBQ0gsTUFBTSxPQUFPLFdBQVc7SUFPdEIsWUFBWSxhQUE0QixFQUFFLFdBQThCLEVBQUUsYUFBNEI7UUFDcEcsSUFBSSxDQUFDLGFBQWEsR0FBRyxhQUFhLENBQUM7UUFDbkMsSUFBSSxDQUFDLFdBQVcsR0FBRyxXQUFXLENBQUM7UUFDL0IsSUFBSSxDQUFDLGFBQWEsR0FBRyxhQUFhLENBQUM7SUFDckMsQ0FBQztDQUNGIn0=

package/dest/avm/journal/index.d.ts

@@ -0,0 +1,3 @@
+export * from './host_storage.js';
+export * from './journal.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/avm/journal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/avm/journal/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC"}

package/dest/avm/journal/index.js

@@ -0,0 +1,3 @@
+export * from './host_storage.js';
+export * from './journal.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYXZtL2pvdXJuYWwvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxtQkFBbUIsQ0FBQztBQUNsQyxjQUFjLGNBQWMsQ0FBQyJ9

package/dest/avm/journal/journal.d.ts

@@ -0,0 +1,95 @@
+import { Fr } from '@aztec/foundation/fields';
+import { HostStorage } from './host_storage.js';
+/**
+ * Data held within the journal
+ */
+export type JournalData = {
+    newNoteHashes: Fr[];
+    newNullifiers: Fr[];
+    newL1Messages: Fr[][];
+    newLogs: Fr[][];
+    /** contract address -\> key -\> value */
+    currentStorageValue: Map<bigint, Map<bigint, Fr>>;
+    /** contract address -\> key -\> value[] (stored in order of access) */
+    storageWrites: Map<bigint, Map<bigint, Fr[]>>;
+    /** contract address -\> key -\> value[] (stored in order of access) */
+    storageReads: Map<bigint, Map<bigint, Fr[]>>;
+};
+/**
+ * A cache of the current state of the AVM
+ * The interpreter should make any state queries through this object
+ *
+ * When a nested context succeeds, it's journal is merge into the parent
+ * When a call fails, it's journal is discarded and the parent is used from this point forward
+ * When a call succeeds's we can merge a child into its parent
+ */
+export declare class AvmWorldStateJournal {
+    /** Reference to node storage */
+    readonly hostStorage: HostStorage;
+    private storageReads;
+    private storageWrites;
+    private newNoteHashes;
+    private newNullifiers;
+    private newL1Messages;
+    private newLogs;
+    private currentStorageValue;
+    private parentJournal;
+    constructor(hostStorage: HostStorage, parentJournal?: AvmWorldStateJournal);
+    /**
+     * Create a new world state journal forked from this one
+     */
+    fork(): AvmWorldStateJournal;
+    /**
+     * Write storage into journal
+     *
+     * @param contractAddress -
+     * @param key -
+     * @param value -
+     */
+    writeStorage(contractAddress: Fr, key: Fr, value: Fr): void;
+    /**
+     * Read storage from journal
+     * Read from host storage on cache miss
+     *
+     * @param contractAddress -
+     * @param key -
+     * @returns current value
+     */
+    readStorage(contractAddress: Fr, key: Fr): Promise<Fr>;
+    /**
+     * We want to keep track of all performed reads in the journal
+     * This information is hinted to the avm circuit
+  
+     * @param contractAddress -
+     * @param key -
+     * @param value -
+     */
+    journalUpdate(map: Map<bigint, Map<bigint, Fr[]>>, contractAddress: Fr, key: Fr, value: Fr): void;
+    private journalRead;
+    private journalWrite;
+    writeNoteHash(noteHash: Fr): void;
+    writeL1Message(message: Fr[]): void;
+    writeNullifier(nullifier: Fr): void;
+    writeLog(log: Fr[]): void;
+    /**
+     * Accept nested world state, merging in its journal, and accepting its state modifications
+     * - Utxo objects are concatenated
+     * - Public state changes are merged, with the value in the incoming journal taking precedent
+     * - Public state journals (r/w logs), with the accessing being appended in chronological order
+     */
+    acceptNestedWorldState(nestedJournal: AvmWorldStateJournal): void;
+    /**
+     * Reject nested world state, merging in its journal, but not accepting its state modifications
+     * - Utxo objects are concatenated
+     * - Public state changes are dropped
+     * - Public state journals (r/w logs) are maintained, with the accessing being appended in chronological order
+     */
+    rejectNestedWorldState(nestedJournal: AvmWorldStateJournal): void;
+    /**
+     * Access the current state of the journal
+     *
+     * @returns a JournalData object
+     */
+    flush(): JournalData;
+}
+//# sourceMappingURL=journal.d.ts.map

package/dest/avm/journal/journal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"journal.d.ts","sourceRoot":"","sources":["../../../src/avm/journal/journal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,EAAE,EAAE,EAAE,CAAC;IACpB,aAAa,EAAE,EAAE,EAAE,CAAC;IACpB,aAAa,EAAE,EAAE,EAAE,EAAE,CAAC;IACtB,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC;IAEhB,yCAAyC;IACzC,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;IAElD,uEAAuE;IACvE,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9C,uEAAuE;IACvE,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,oBAAoB;IAC/B,gCAAgC;IAChC,SAAgB,WAAW,EAAE,WAAW,CAAC;IAIzC,OAAO,CAAC,YAAY,CAA6C;IACjE,OAAO,CAAC,aAAa,CAA6C;IAGlE,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,aAAa,CAAY;IAGjC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,OAAO,CAAc;IAG7B,OAAO,CAAC,mBAAmB,CAA2C;IAEtE,OAAO,CAAC,aAAa,CAAmC;gBAE5C,WAAW,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,oBAAoB;IAK1E;;OAEG;IACI,IAAI;IAIX;;;;;;OAMG;IACI,YAAY,CAAC,eAAe,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE;IAY3D;;;;;;;OAOG;IACU,WAAW,CAAC,eAAe,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;IAkBnE;;;;;;;OAOG;IACH,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI;IAgBjG,OAAO,CAAC,WAAW,CAAoD;IAEvE,OAAO,CAAC,YAAY,CAAqD;IAElE,aAAa,CAAC,QAAQ,EAAE,EAAE;IAI1B,cAAc,CAAC,OAAO,EAAE,EAAE,EAAE;IAI5B,cAAc,CAAC,SAAS,EAAE,EAAE;IAI5B,QAAQ,CAAC,GAAG,EAAE,EAAE,EAAE;IAIzB;;;;;OAKG;IACI,sBAAsB,CAAC,aAAa,EAAE,oBAAoB;IAejE;;;;;OAKG;IACI,sBAAsB,CAAC,aAAa,EAAE,oBAAoB;IAMjE;;;;OAIG;IACI,KAAK,IAAI,WAAW;CAW5B"}