@aztec/simulator 0.0.0-test.0

package/dest/public/avm/test_utils.js

@@ -0,0 +1,52 @@
+import { Fr } from '@aztec/foundation/fields';
+import { computePublicBytecodeCommitment } from '@aztec/stdlib/contract';
+import { mock } from 'jest-mock-extended';
+export async function mockGetBytecode(worldStateDB, bytecode) {
+    const commitment = await computePublicBytecodeCommitment(bytecode);
+    worldStateDB.getBytecodeCommitment.mockResolvedValue(commitment);
+}
+export function mockTraceFork(trace, nestedTrace) {
+    trace.fork.mockReturnValue(nestedTrace ?? mock());
+}
+export function mockStorageRead(worldStateDB, value) {
+    worldStateDB.storageRead.mockResolvedValue(value);
+}
+export function mockNoteHashCount(mockedTrace, count) {
+    mockedTrace.getNoteHashCount.mockReturnValue(count);
+}
+export function mockStorageReadWithMap(worldStateDB, mockedStorage) {
+    worldStateDB.storageRead.mockImplementation((_address, slot)=>Promise.resolve(mockedStorage.get(slot.toBigInt()) ?? Fr.ZERO));
+}
+export function mockGetBytecodeCommitment(worldStateDB, commitment) {
+    worldStateDB.getBytecodeCommitment.mockResolvedValue(commitment);
+}
+export function mockNoteHashExists(worldStateDB, _leafIndex, value) {
+    worldStateDB.getCommitmentValue.mockImplementation((index)=>{
+        if (index == _leafIndex.toBigInt()) {
+            return Promise.resolve(value);
+        } else {
+            // This is ok for now since the traceing functions handle it
+            return Promise.resolve(undefined);
+        }
+    });
+}
+export function mockGetNullifierIndex(worldStateDB, leafIndex, _ignoredValue) {
+    worldStateDB.getNullifierIndex.mockResolvedValue(leafIndex.toBigInt());
+}
+export function mockL1ToL2MessageExists(worldStateDB, leafIndex, value, valueAtOtherIndices) {
+    worldStateDB.getL1ToL2LeafValue.mockImplementation((index)=>{
+        if (index == leafIndex.toBigInt()) {
+            return Promise.resolve(value);
+        } else {
+            // any indices other than mockAtLeafIndex will return a different value
+            // (or undefined if no value is specified for other indices)
+            return Promise.resolve(valueAtOtherIndices);
+        }
+    });
+}
+export function mockGetContractInstance(worldStateDB, contractInstance) {
+    worldStateDB.getContractInstance.mockResolvedValue(contractInstance);
+}
+export function mockGetContractClass(worldStateDB, contractClass) {
+    worldStateDB.getContractClass.mockResolvedValue(contractClass);
+}

package/dest/public/bytecode_errors.d.ts

@@ -0,0 +1,4 @@
+export declare class ContractClassBytecodeError extends Error {
+    constructor(contractAddress: string);
+}
+//# sourceMappingURL=bytecode_errors.d.ts.map

package/dest/public/bytecode_errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytecode_errors.d.ts","sourceRoot":"","sources":["../../src/public/bytecode_errors.ts"],"names":[],"mappings":"AAAA,qBAAa,0BAA2B,SAAQ,KAAK;gBACvC,eAAe,EAAE,MAAM;CAIpC"}

package/dest/public/bytecode_errors.js

@@ -0,0 +1,6 @@
+export class ContractClassBytecodeError extends Error {
+    constructor(contractAddress){
+        super(`Failed to get bytecode for contract at address ${contractAddress}`);
+        this.name = 'ContractClassBytecodeError';
+    }
+}

package/dest/public/execution.d.ts

@@ -0,0 +1,108 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { Fr } from '@aztec/foundation/fields';
+import { type AvmExecutionHints, type ContractStorageRead, type ContractStorageUpdateRequest, type PublicDataUpdateRequest, PublicInnerCallRequest } from '@aztec/stdlib/avm';
+import type { SimulationError } from '@aztec/stdlib/errors';
+import { Gas } from '@aztec/stdlib/gas';
+import type { NoteHash, Nullifier, ReadRequest, TreeLeafReadRequest } from '@aztec/stdlib/kernel';
+import type { PublicLog } from '@aztec/stdlib/logs';
+import type { L2ToL1Message, ScopedL2ToL1Message } from '@aztec/stdlib/messaging';
+import type { PublicExecutionRequest } from '@aztec/stdlib/tx';
+export interface PublicSideEffects {
+    /** The contract storage update requests performed. */
+    publicDataWrites: PublicDataUpdateRequest[];
+    /** The new note hashes to be inserted into the note hashes tree. */
+    noteHashes: NoteHash[];
+    /** The new nullifiers to be inserted into the nullifier tree. */
+    nullifiers: Nullifier[];
+    /** The new l2 to l1 messages generated to be inserted into the messages tree. */
+    l2ToL1Messages: ScopedL2ToL1Message[];
+    /** Public logs emitted during execution. */
+    publicLogs: PublicLog[];
+}
+export interface EnqueuedPublicCallExecutionResult {
+    /** How much gas was left after this public execution. */
+    endGasLeft: Gas;
+    /** The side effect counter after execution */
+    endSideEffectCounter: Fr;
+    /** The return values of the function. */
+    returnValues: Fr[];
+    /** Whether the execution reverted. */
+    reverted: boolean;
+    /** The revert reason if the execution reverted. */
+    revertReason?: SimulationError;
+}
+export interface EnqueuedPublicCallExecutionResultWithSideEffects {
+    /** How much gas was left after this public execution. */
+    endGasLeft: Gas;
+    /** The side effect counter after execution */
+    endSideEffectCounter: Fr;
+    /** The return values of the function. */
+    returnValues: Fr[];
+    /** Whether the execution reverted. */
+    reverted: boolean;
+    /** The revert reason if the execution reverted. */
+    revertReason?: SimulationError;
+    /** The public side effects of the function. */
+    sideEffects: PublicSideEffects;
+}
+/**
+ * The public function execution result.
+ */
+export interface PublicFunctionCallResult {
+    /** The execution request that triggered this result. */
+    executionRequest: PublicExecutionRequest;
+    /** The side effect counter at the start of the function call. */
+    startSideEffectCounter: Fr;
+    /** The side effect counter after executing this function call */
+    endSideEffectCounter: Fr;
+    /** How much gas was available for this public execution. */
+    startGasLeft: Gas;
+    /** How much gas was left after this public execution. */
+    endGasLeft: Gas;
+    /** Transaction fee set for this tx. */
+    transactionFee: Fr;
+    /** Bytecode used for this execution. */
+    bytecode?: Buffer;
+    /** Calldata used for this execution. */
+    calldata: Fr[];
+    /** The return values of the function. */
+    returnValues: Fr[];
+    /** Whether the execution reverted. */
+    reverted: boolean;
+    /** The revert reason if the execution reverted. */
+    revertReason?: SimulationError;
+    /** The contract storage reads performed by the function. */
+    contractStorageReads: ContractStorageRead[];
+    /** The contract storage update requests performed by the function. */
+    contractStorageUpdateRequests: ContractStorageUpdateRequest[];
+    /** The new note hashes to be inserted into the note hashes tree. */
+    noteHashes: NoteHash[];
+    /** The new l2 to l1 messages generated in this call. */
+    l2ToL1Messages: L2ToL1Message[];
+    /** The new nullifiers to be inserted into the nullifier tree. */
+    nullifiers: Nullifier[];
+    /** The note hash read requests emitted in this call. */
+    noteHashReadRequests: TreeLeafReadRequest[];
+    /** The nullifier read requests emitted in this call. */
+    nullifierReadRequests: ReadRequest[];
+    /** The nullifier non existent read requests emitted in this call. */
+    nullifierNonExistentReadRequests: ReadRequest[];
+    /** L1 to L2 message read requests emitted in this call. */
+    l1ToL2MsgReadRequests: TreeLeafReadRequest[];
+    /**
+     * The public logs emitted in this call.
+     * Note: PublicLog has no counter - unsure if this is needed bc this struct is unused
+     */
+    publicLogs: PublicLog[];
+    /** The requests to call public functions made by this call. */
+    publicCallRequests: PublicInnerCallRequest[];
+    /** The results of nested calls. */
+    nestedExecutions: this[];
+    /** Hints for proving AVM execution. */
+    avmCircuitHints: AvmExecutionHints;
+    /** The name of the function that was executed. Only used for logging. */
+    functionName: string;
+}
+export declare function resultToPublicCallRequest(result: PublicFunctionCallResult): Promise<PublicInnerCallRequest>;
+//# sourceMappingURL=execution.d.ts.map

package/dest/public/execution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution.d.ts","sourceRoot":"","sources":["../../src/public/execution.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EAEjC,KAAK,uBAAuB,EAC5B,sBAAsB,EAEvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAExC,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAClF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE/D,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,gBAAgB,EAAE,uBAAuB,EAAE,CAAC;IAC5C,oEAAoE;IACpE,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,iEAAiE;IACjE,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,iFAAiF;IACjF,cAAc,EAAE,mBAAmB,EAAE,CAAC;IACtC,4CAA4C;IAC5C,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC;IAChD,yDAAyD;IACzD,UAAU,EAAE,GAAG,CAAC;IAChB,8CAA8C;IAC9C,oBAAoB,EAAE,EAAE,CAAC;IAEzB,yCAAyC;IACzC,YAAY,EAAE,EAAE,EAAE,CAAC;IACnB,sCAAsC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,YAAY,CAAC,EAAE,eAAe,CAAC;CAChC;AAED,MAAM,WAAW,gDAAgD;IAC/D,yDAAyD;IACzD,UAAU,EAAE,GAAG,CAAC;IAChB,8CAA8C;IAC9C,oBAAoB,EAAE,EAAE,CAAC;IAEzB,yCAAyC;IACzC,YAAY,EAAE,EAAE,EAAE,CAAC;IACnB,sCAAsC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,YAAY,CAAC,EAAE,eAAe,CAAC;IAE/B,+CAA+C;IAC/C,WAAW,EAAE,iBAAiB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,wDAAwD;IACxD,gBAAgB,EAAE,sBAAsB,CAAC;IAEzC,iEAAiE;IACjE,sBAAsB,EAAE,EAAE,CAAC;IAC3B,iEAAiE;IACjE,oBAAoB,EAAE,EAAE,CAAC;IACzB,4DAA4D;IAC5D,YAAY,EAAE,GAAG,CAAC;IAClB,yDAAyD;IACzD,UAAU,EAAE,GAAG,CAAC;IAChB,uCAAuC;IACvC,cAAc,EAAE,EAAE,CAAC;IAEnB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,QAAQ,EAAE,EAAE,EAAE,CAAC;IACf,yCAAyC;IACzC,YAAY,EAAE,EAAE,EAAE,CAAC;IACnB,sCAAsC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,YAAY,CAAC,EAAE,eAAe,CAAC;IAE/B,4DAA4D;IAC5D,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C,sEAAsE;IACtE,6BAA6B,EAAE,4BAA4B,EAAE,CAAC;IAC9D,oEAAoE;IACpE,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,wDAAwD;IACxD,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,iEAAiE;IACjE,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,wDAAwD;IACxD,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;IAC5C,wDAAwD;IACxD,qBAAqB,EAAE,WAAW,EAAE,CAAC;IACrC,qEAAqE;IACrE,gCAAgC,EAAE,WAAW,EAAE,CAAC;IAChD,2DAA2D;IAC3D,qBAAqB,EAAE,mBAAmB,EAAE,CAAC;IAC7C;;;OAGG;IACH,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,+DAA+D;IAC/D,kBAAkB,EAAE,sBAAsB,EAAE,CAAC;IAC7C,mCAAmC;IACnC,gBAAgB,EAAE,IAAI,EAAE,CAAC;IAEzB,uCAAuC;IACvC,eAAe,EAAE,iBAAiB,CAAC;IAEnC,yEAAyE;IACzE,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,wBAAsB,yBAAyB,CAAC,MAAM,EAAE,wBAAwB,mCAa/E"}

package/dest/public/execution.js

@@ -0,0 +1,9 @@
+import { PublicCallStackItemCompressed, PublicInnerCallRequest, RevertCode } from '@aztec/stdlib/avm';
+import { Gas } from '@aztec/stdlib/gas';
+import { computeVarArgsHash } from '@aztec/stdlib/hash';
+export async function resultToPublicCallRequest(result) {
+    const request = result.executionRequest;
+    const item = new PublicCallStackItemCompressed(request.callContext.contractAddress, request.callContext, await computeVarArgsHash(request.args), await computeVarArgsHash(result.returnValues), // TODO(@just-mitch): need better mapping from simulator to revert code.
+    result.reverted ? RevertCode.APP_LOGIC_REVERTED : RevertCode.OK, Gas.from(result.startGasLeft), Gas.from(result.endGasLeft));
+    return new PublicInnerCallRequest(item, result.startSideEffectCounter.toNumber());
+}

package/dest/public/executor_metrics.d.ts

@@ -0,0 +1,13 @@
+import { type TelemetryClient, type Tracer } from '@aztec/telemetry-client';
+export declare class ExecutorMetrics {
+    readonly tracer: Tracer;
+    private fnCount;
+    private fnDuration;
+    private manaPerSecond;
+    private privateEffectsInsertions;
+    constructor(client: TelemetryClient, name?: string);
+    recordFunctionSimulation(durationMs: number, manaUsed: number, fnName: string): void;
+    recordFunctionSimulationFailure(): void;
+    recordPrivateEffectsInsertion(durationUs: number, type: 'revertible' | 'non-revertible'): void;
+}
+//# sourceMappingURL=executor_metrics.d.ts.map

package/dest/public/executor_metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor_metrics.d.ts","sourceRoot":"","sources":["../../src/public/executor_metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,eAAe,EACpB,KAAK,MAAM,EAGZ,MAAM,yBAAyB,CAAC;AAEjC,qBAAa,eAAe;IAC1B,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,wBAAwB,CAAY;gBAEhC,MAAM,EAAE,eAAe,EAAE,IAAI,SAAmB;IA2B5D,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAe7E,+BAA+B;IAM/B,6BAA6B,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,gBAAgB;CAKxF"}

package/dest/public/executor_metrics.js

@@ -0,0 +1,54 @@
+import { Attributes, Metrics, ValueType } from '@aztec/telemetry-client';
+export class ExecutorMetrics {
+    tracer;
+    fnCount;
+    fnDuration;
+    manaPerSecond;
+    privateEffectsInsertions;
+    constructor(client, name = 'PublicExecutor'){
+        this.tracer = client.getTracer(name);
+        const meter = client.getMeter(name);
+        this.fnCount = meter.createUpDownCounter(Metrics.PUBLIC_EXECUTOR_SIMULATION_COUNT, {
+            description: 'Number of functions executed'
+        });
+        this.fnDuration = meter.createHistogram(Metrics.PUBLIC_EXECUTOR_SIMULATION_DURATION, {
+            description: 'How long it takes to execute a function',
+            unit: 'ms',
+            valueType: ValueType.INT
+        });
+        this.manaPerSecond = meter.createHistogram(Metrics.PUBLIC_EXECUTOR_SIMULATION_MANA_PER_SECOND, {
+            description: 'Mana used per second',
+            unit: 'mana/s',
+            valueType: ValueType.INT
+        });
+        this.privateEffectsInsertions = meter.createHistogram(Metrics.PUBLIC_EXECUTION_PRIVATE_EFFECTS_INSERTION, {
+            description: 'Private effects insertion time',
+            unit: 'us',
+            valueType: ValueType.INT
+        });
+    }
+    recordFunctionSimulation(durationMs, manaUsed, fnName) {
+        this.fnCount.add(1, {
+            [Attributes.OK]: true,
+            [Attributes.APP_CIRCUIT_NAME]: fnName,
+            [Attributes.MANA_USED]: manaUsed
+        });
+        this.fnDuration.record(Math.ceil(durationMs));
+        if (durationMs > 0 && manaUsed > 0) {
+            const manaPerSecond = Math.round(manaUsed * 1000 / durationMs);
+            this.manaPerSecond.record(manaPerSecond, {
+                [Attributes.APP_CIRCUIT_NAME]: fnName
+            });
+        }
+    }
+    recordFunctionSimulationFailure() {
+        this.fnCount.add(1, {
+            [Attributes.OK]: false
+        });
+    }
+    recordPrivateEffectsInsertion(durationUs, type) {
+        this.privateEffectsInsertions.record(Math.ceil(durationUs), {
+            [Attributes.REVERTIBILITY]: type
+        });
+    }
+}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/public/fixtures/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,YAAY,CAAC"}

package/dest/public/fixtures/index.js

@@ -0,0 +1,2 @@
+export * from './public_tx_simulation_tester.js';
+export * from './utils.js';

package/dest/public/fixtures/public_tx_simulation_tester.d.ts

@@ -0,0 +1,32 @@
+import { Fr } from '@aztec/foundation/fields';
+import { type ContractArtifact } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server';
+import { type Tx } from '@aztec/stdlib/tx';
+import { GlobalVariables } from '@aztec/stdlib/tx';
+import { BaseAvmSimulationTester } from '../avm/fixtures/base_avm_simulation_tester.js';
+import { SimpleContractDataSource } from '../avm/fixtures/simple_contract_data_source.js';
+import { WorldStateDB } from '../public_db_sources.js';
+import { type PublicTxResult } from '../public_tx_simulator/public_tx_simulator.js';
+export declare const DEFAULT_BLOCK_NUMBER = 42;
+export type TestEnqueuedCall = {
+    address: AztecAddress;
+    fnName: string;
+    args: any[];
+    isStaticCall?: boolean;
+    contractArtifact?: ContractArtifact;
+};
+/**
+ * A test class that extends the BaseAvmSimulationTester to enable real-app testing of the PublicTxSimulator.
+ * It provides an interface for simulating one transaction at a time and maintains state between subsequent
+ * transactions.
+ */
+export declare class PublicTxSimulationTester extends BaseAvmSimulationTester {
+    private worldStateDB;
+    private txCount;
+    constructor(worldStateDB: WorldStateDB, contractDataSource: SimpleContractDataSource, merkleTrees: MerkleTreeWriteOperations);
+    static create(): Promise<PublicTxSimulationTester>;
+    createTx(sender: AztecAddress, setupCalls?: TestEnqueuedCall[], appCalls?: TestEnqueuedCall[], teardownCall?: TestEnqueuedCall, feePayer?: AztecAddress, firstNullifier?: Fr): Promise<Tx>;
+    simulateTx(sender: AztecAddress, setupCalls?: TestEnqueuedCall[], appCalls?: TestEnqueuedCall[], teardownCall?: TestEnqueuedCall, feePayer?: AztecAddress, firstNullifier?: Fr, globals?: GlobalVariables): Promise<PublicTxResult>;
+}
+//# sourceMappingURL=public_tx_simulation_tester.d.ts.map

package/dest/public/fixtures/public_tx_simulation_tester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public_tx_simulation_tester.d.ts","sourceRoot":"","sources":["../../../src/public/fixtures/public_tx_simulation_tester.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,KAAK,gBAAgB,EAAqC,MAAM,mBAAmB,CAAC;AAC7F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAA0B,KAAK,EAAE,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAe,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AAExF,OAAO,EAAE,wBAAwB,EAAE,MAAM,gDAAgD,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,KAAK,cAAc,EAAqB,MAAM,+CAA+C,CAAC;AAKvG,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,uBAAuB;IAIjE,OAAO,CAAC,YAAY;IAHtB,OAAO,CAAC,OAAO,CAAK;gBAGV,YAAY,EAAE,YAAY,EAClC,kBAAkB,EAAE,wBAAwB,EAC5C,WAAW,EAAE,yBAAyB;WAKpB,MAAM,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAOlD,QAAQ,CACnB,MAAM,EAAE,YAAY,EACpB,UAAU,GAAE,gBAAgB,EAAO,EACnC,QAAQ,GAAE,gBAAgB,EAAO,EACjC,YAAY,CAAC,EAAE,gBAAgB,EAC/B,QAAQ,GAAE,YAAqB,EAE/B,cAAc,KAAkC,GAC/C,OAAO,CAAC,EAAE,CAAC;IAiED,UAAU,CACrB,MAAM,EAAE,YAAY,EACpB,UAAU,GAAE,gBAAgB,EAAO,EACnC,QAAQ,GAAE,gBAAgB,EAAO,EACjC,YAAY,CAAC,EAAE,gBAAgB,EAC/B,QAAQ,GAAE,YAAqB,EAE/B,cAAc,KAAkC,EAChD,OAAO,kBAAmB,GACzB,OAAO,CAAC,cAAc,CAAC;CAc3B"}

package/dest/public/fixtures/public_tx_simulation_tester.js

@@ -0,0 +1,93 @@
+import { PUBLIC_DISPATCH_SELECTOR } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/fields';
+import { FunctionSelector, encodeArguments } from '@aztec/stdlib/abi';
+import { GasFees } from '@aztec/stdlib/gas';
+import { PublicExecutionRequest } from '@aztec/stdlib/tx';
+import { CallContext, GlobalVariables } from '@aztec/stdlib/tx';
+import { NativeWorldStateService } from '@aztec/world-state';
+import { BaseAvmSimulationTester } from '../avm/fixtures/base_avm_simulation_tester.js';
+import { getContractFunctionArtifact, getFunctionSelector } from '../avm/fixtures/index.js';
+import { SimpleContractDataSource } from '../avm/fixtures/simple_contract_data_source.js';
+import { WorldStateDB } from '../public_db_sources.js';
+import { PublicTxSimulator } from '../public_tx_simulator/public_tx_simulator.js';
+import { createTxForPublicCalls } from './index.js';
+const TIMESTAMP = new Fr(99833);
+const DEFAULT_GAS_FEES = new GasFees(2, 3);
+export const DEFAULT_BLOCK_NUMBER = 42;
+/**
+ * A test class that extends the BaseAvmSimulationTester to enable real-app testing of the PublicTxSimulator.
+ * It provides an interface for simulating one transaction at a time and maintains state between subsequent
+ * transactions.
+ */ export class PublicTxSimulationTester extends BaseAvmSimulationTester {
+    worldStateDB;
+    txCount;
+    constructor(worldStateDB, contractDataSource, merkleTrees){
+        super(contractDataSource, merkleTrees), this.worldStateDB = worldStateDB, this.txCount = 0;
+    }
+    static async create() {
+        const contractDataSource = new SimpleContractDataSource();
+        const merkleTrees = await (await NativeWorldStateService.tmp()).fork();
+        const worldStateDB = new WorldStateDB(merkleTrees, contractDataSource);
+        return new PublicTxSimulationTester(worldStateDB, contractDataSource, merkleTrees);
+    }
+    async createTx(sender, setupCalls = [], appCalls = [], teardownCall, feePayer = sender, /* need some unique first nullifier for note-nonce computations */ firstNullifier = new Fr(420000 + this.txCount++)) {
+        const setupExecutionRequests = [];
+        for(let i = 0; i < setupCalls.length; i++){
+            const address = setupCalls[i].address;
+            const contractArtifact = setupCalls[i].contractArtifact || await this.contractDataSource.getContractArtifact(address);
+            if (!contractArtifact) {
+                throw new Error(`Contract artifact not found for address: ${address}`);
+            }
+            const req = await executionRequestForCall(contractArtifact, sender, address, setupCalls[i].fnName, setupCalls[i].args, setupCalls[i].isStaticCall);
+            setupExecutionRequests.push(req);
+        }
+        const appExecutionRequests = [];
+        for(let i = 0; i < appCalls.length; i++){
+            const address = appCalls[i].address;
+            const contractArtifact = appCalls[i].contractArtifact || await this.contractDataSource.getContractArtifact(address);
+            if (!contractArtifact) {
+                throw new Error(`Contract artifact not found for address: ${address}`);
+            }
+            const req = await executionRequestForCall(contractArtifact, sender, address, appCalls[i].fnName, appCalls[i].args, appCalls[i].isStaticCall);
+            appExecutionRequests.push(req);
+        }
+        let teardownExecutionRequest = undefined;
+        if (teardownCall) {
+            const address = teardownCall.address;
+            const contractArtifact = teardownCall.contractArtifact || await this.contractDataSource.getContractArtifact(address);
+            if (!contractArtifact) {
+                throw new Error(`Contract artifact not found for address: ${address}`);
+            }
+            teardownExecutionRequest = await executionRequestForCall(contractArtifact, sender, address, teardownCall.fnName, teardownCall.args, teardownCall.isStaticCall);
+        }
+        return await createTxForPublicCalls(firstNullifier, setupExecutionRequests, appExecutionRequests, teardownExecutionRequest, feePayer);
+    }
+    async simulateTx(sender, setupCalls = [], appCalls = [], teardownCall, feePayer = sender, /* need some unique first nullifier for note-nonce computations */ firstNullifier = new Fr(420000 + this.txCount++), globals = defaultGlobals()) {
+        const tx = await this.createTx(sender, setupCalls, appCalls, teardownCall, feePayer, firstNullifier);
+        await this.setFeePayerBalance(feePayer);
+        const simulator = new PublicTxSimulator(this.merkleTrees, this.worldStateDB, globals, /*doMerkleOperations=*/ true);
+        const startTime = performance.now();
+        const avmResult = await simulator.simulate(tx);
+        const endTime = performance.now();
+        this.logger.debug(`Public transaction simulation took ${endTime - startTime}ms`);
+        return avmResult;
+    }
+}
+async function executionRequestForCall(contractArtifact, sender, address, fnName, args = [], isStaticCall = false) {
+    const fnSelector = await getFunctionSelector(fnName, contractArtifact);
+    const fnAbi = getContractFunctionArtifact(fnName, contractArtifact);
+    const encodedArgs = encodeArguments(fnAbi, args);
+    const calldata = [
+        fnSelector.toField(),
+        ...encodedArgs
+    ];
+    const callContext = new CallContext(sender, address, /*selector=*/ new FunctionSelector(PUBLIC_DISPATCH_SELECTOR), isStaticCall);
+    return new PublicExecutionRequest(callContext, calldata);
+}
+function defaultGlobals() {
+    const globals = GlobalVariables.empty();
+    globals.timestamp = TIMESTAMP;
+    globals.gasFees = DEFAULT_GAS_FEES; // apply some nonzero default gas fees
+    globals.blockNumber = new Fr(DEFAULT_BLOCK_NUMBER);
+    return globals;
+}

package/dest/public/fixtures/utils.d.ts

@@ -0,0 +1,13 @@
+import { Fr } from '@aztec/foundation/fields';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { ContractClassPublic, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import { Gas } from '@aztec/stdlib/gas';
+import { type PublicExecutionRequest, Tx } from '@aztec/stdlib/tx';
+/**
+ * Craft a carrier transaction for some public calls for simulation by PublicTxSimulator.
+ */
+export declare function createTxForPublicCalls(firstNullifier: Fr, setupExecutionRequests: PublicExecutionRequest[], appExecutionRequests: PublicExecutionRequest[], teardownExecutionRequest?: PublicExecutionRequest, feePayer?: AztecAddress, gasUsedByPrivate?: Gas): Promise<Tx>;
+export declare function createTxForPrivateOnly(feePayer?: AztecAddress, gasUsedByPrivate?: Gas): Tx;
+export declare function addNewContractClassToTx(tx: Tx, contractClass: ContractClassPublic, skipNullifierInsertion?: boolean): Promise<void>;
+export declare function addNewContractInstanceToTx(tx: Tx, contractInstance: ContractInstanceWithAddress, skipNullifierInsertion?: boolean): Promise<void>;
+//# sourceMappingURL=utils.d.ts.map

package/dest/public/fixtures/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/public/fixtures/utils.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAI9C,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EAAE,GAAG,EAAwB,MAAM,mBAAmB,CAAC;AAW9D,OAAO,EAAE,KAAK,sBAAsB,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAKnE;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,cAAc,EAAE,EAAE,EAClB,sBAAsB,EAAE,sBAAsB,EAAE,EAChD,oBAAoB,EAAE,sBAAsB,EAAE,EAC9C,wBAAwB,CAAC,EAAE,sBAAsB,EACjD,QAAQ,eAAsB,EAC9B,gBAAgB,GAAE,GAAiB,GAClC,OAAO,CAAC,EAAE,CAAC,CAkDb;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,eAAsB,EAAE,gBAAgB,GAAE,GAAqB,GAAG,EAAE,CAoBlH;AAED,wBAAsB,uBAAuB,CAC3C,EAAE,EAAE,EAAE,EACN,aAAa,EAAE,mBAAmB,EAClC,sBAAsB,UAAQ,iBAiC/B;AAED,wBAAsB,0BAA0B,CAC9C,EAAE,EAAE,EAAE,EACN,gBAAgB,EAAE,2BAA2B,EAC7C,sBAAsB,UAAQ,iBA0C/B"}

package/dest/public/fixtures/utils.js

@@ -0,0 +1,126 @@
+import { CONTRACT_CLASS_LOG_DATA_SIZE_IN_FIELDS, DEFAULT_GAS_LIMIT, DEPLOYER_CONTRACT_ADDRESS, MAX_L2_GAS_PER_TX_PUBLIC_PORTION, PRIVATE_LOG_SIZE_IN_FIELDS, REGISTERER_CONTRACT_ADDRESS, REGISTERER_CONTRACT_CLASS_REGISTERED_MAGIC_VALUE } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/fields';
+import { assertLength } from '@aztec/foundation/serialize';
+import { DEPLOYER_CONTRACT_INSTANCE_DEPLOYED_TAG } from '@aztec/protocol-contracts';
+import { bufferAsFields } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { Gas, GasFees, GasSettings } from '@aztec/stdlib/gas';
+import { siloNullifier } from '@aztec/stdlib/hash';
+import { PartialPrivateTailPublicInputsForPublic, PartialPrivateTailPublicInputsForRollup, PrivateKernelTailCircuitPublicInputs, RollupValidationRequests, ScopedLogHash, countAccumulatedItems } from '@aztec/stdlib/kernel';
+import { ContractClassLog, PrivateLog } from '@aztec/stdlib/logs';
+import { Tx } from '@aztec/stdlib/tx';
+import { BlockHeader, TxConstantData, TxContext } from '@aztec/stdlib/tx';
+import { strict as assert } from 'assert';
+/**
+ * Craft a carrier transaction for some public calls for simulation by PublicTxSimulator.
+ */ export async function createTxForPublicCalls(firstNullifier, setupExecutionRequests, appExecutionRequests, teardownExecutionRequest, feePayer = AztecAddress.zero(), gasUsedByPrivate = Gas.empty()) {
+    assert(setupExecutionRequests.length > 0 || appExecutionRequests.length > 0 || teardownExecutionRequest !== undefined, "Can't create public tx with no enqueued calls");
+    const setupCallRequests = await Promise.all(setupExecutionRequests.map((er)=>er.toCallRequest()));
+    const appCallRequests = await Promise.all(appExecutionRequests.map((er)=>er.toCallRequest()));
+    // use max limits
+    const gasLimits = new Gas(DEFAULT_GAS_LIMIT, MAX_L2_GAS_PER_TX_PUBLIC_PORTION);
+    const forPublic = PartialPrivateTailPublicInputsForPublic.empty();
+    // TODO(#9269): Remove this fake nullifier method as we move away from 1st nullifier as hash.
+    forPublic.nonRevertibleAccumulatedData.nullifiers[0] = firstNullifier;
+    // We reverse order because the simulator expects it to be like a "stack" of calls to pop from
+    for(let i = setupCallRequests.length - 1; i >= 0; i--){
+        forPublic.nonRevertibleAccumulatedData.publicCallRequests[i] = setupCallRequests[i];
+    }
+    for(let i = appCallRequests.length - 1; i >= 0; i--){
+        forPublic.revertibleAccumulatedData.publicCallRequests[i] = appCallRequests[i];
+    }
+    if (teardownExecutionRequest) {
+        forPublic.publicTeardownCallRequest = await teardownExecutionRequest.toCallRequest();
+    }
+    const maxFeesPerGas = feePayer.isZero() ? GasFees.empty() : new GasFees(10, 10);
+    const teardownGasLimits = teardownExecutionRequest ? gasLimits : Gas.empty();
+    const gasSettings = new GasSettings(gasLimits, teardownGasLimits, maxFeesPerGas, GasFees.empty());
+    const txContext = new TxContext(Fr.zero(), Fr.zero(), gasSettings);
+    const constantData = new TxConstantData(BlockHeader.empty(), txContext, Fr.zero(), Fr.zero());
+    const txData = new PrivateKernelTailCircuitPublicInputs(constantData, RollupValidationRequests.empty(), /*gasUsed=*/ gasUsedByPrivate, feePayer, forPublic);
+    const tx = Tx.newWithTxData(txData, teardownExecutionRequest);
+    // Reverse order because the simulator expects it to be like a "stack" of calls to pop from.
+    // Also push app calls before setup calls for this reason.
+    for(let i = appExecutionRequests.length - 1; i >= 0; i--){
+        tx.enqueuedPublicFunctionCalls.push(appExecutionRequests[i]);
+    }
+    for(let i = setupExecutionRequests.length - 1; i >= 0; i--){
+        tx.enqueuedPublicFunctionCalls.push(setupExecutionRequests[i]);
+    }
+    return tx;
+}
+export function createTxForPrivateOnly(feePayer = AztecAddress.zero(), gasUsedByPrivate = new Gas(10, 10)) {
+    // use max limits
+    const gasLimits = new Gas(DEFAULT_GAS_LIMIT, MAX_L2_GAS_PER_TX_PUBLIC_PORTION);
+    const forRollup = PartialPrivateTailPublicInputsForRollup.empty();
+    const maxFeesPerGas = feePayer.isZero() ? GasFees.empty() : new GasFees(10, 10);
+    const gasSettings = new GasSettings(gasLimits, Gas.empty(), maxFeesPerGas, GasFees.empty());
+    const txContext = new TxContext(Fr.zero(), Fr.zero(), gasSettings);
+    const constantData = new TxConstantData(BlockHeader.empty(), txContext, Fr.zero(), Fr.zero());
+    const txData = new PrivateKernelTailCircuitPublicInputs(constantData, RollupValidationRequests.empty(), /*gasUsed=*/ gasUsedByPrivate, feePayer, /*forPublic=*/ undefined, forRollup);
+    return Tx.newWithTxData(txData);
+}
+export async function addNewContractClassToTx(tx, contractClass, skipNullifierInsertion = false) {
+    const contractClassLogFields = [
+        new Fr(REGISTERER_CONTRACT_CLASS_REGISTERED_MAGIC_VALUE),
+        contractClass.id,
+        new Fr(contractClass.version),
+        new Fr(contractClass.artifactHash),
+        new Fr(contractClass.privateFunctionsRoot),
+        ...bufferAsFields(contractClass.packedBytecode, Math.ceil(contractClass.packedBytecode.length / 31) + 1)
+    ];
+    const contractClassLog = ContractClassLog.fromFields([
+        new Fr(REGISTERER_CONTRACT_ADDRESS),
+        ...contractClassLogFields.concat(new Array(CONTRACT_CLASS_LOG_DATA_SIZE_IN_FIELDS - contractClassLogFields.length).fill(Fr.ZERO))
+    ]);
+    const contractClassLogHash = ScopedLogHash.fromFields([
+        await contractClassLog.hash(),
+        new Fr(7),
+        new Fr(contractClassLog.getEmittedLength()),
+        new Fr(REGISTERER_CONTRACT_ADDRESS)
+    ]);
+    const accumulatedData = tx.data.forPublic ? tx.data.forPublic.revertibleAccumulatedData : tx.data.forRollup.end;
+    if (!skipNullifierInsertion) {
+        const nextNullifierIndex = countAccumulatedItems(accumulatedData.nullifiers);
+        accumulatedData.nullifiers[nextNullifierIndex] = contractClass.id;
+    }
+    const nextLogIndex = countAccumulatedItems(accumulatedData.contractClassLogsHashes);
+    accumulatedData.contractClassLogsHashes[nextLogIndex] = contractClassLogHash;
+    tx.contractClassLogs.push(contractClassLog);
+}
+export async function addNewContractInstanceToTx(tx, contractInstance, skipNullifierInsertion = false) {
+    // can't use publicKeys.toFields() because it includes isInfinite which
+    // is not broadcast in such private logs
+    const publicKeysAsFields = [
+        contractInstance.publicKeys.masterNullifierPublicKey.x,
+        contractInstance.publicKeys.masterNullifierPublicKey.y,
+        contractInstance.publicKeys.masterIncomingViewingPublicKey.x,
+        contractInstance.publicKeys.masterIncomingViewingPublicKey.y,
+        contractInstance.publicKeys.masterOutgoingViewingPublicKey.x,
+        contractInstance.publicKeys.masterOutgoingViewingPublicKey.y,
+        contractInstance.publicKeys.masterTaggingPublicKey.x,
+        contractInstance.publicKeys.masterTaggingPublicKey.y
+    ];
+    const fields = [
+        DEPLOYER_CONTRACT_INSTANCE_DEPLOYED_TAG,
+        contractInstance.address.toField(),
+        new Fr(contractInstance.version),
+        new Fr(contractInstance.salt),
+        contractInstance.currentContractClassId,
+        contractInstance.initializationHash,
+        ...publicKeysAsFields,
+        contractInstance.deployer.toField(),
+        new Fr(0),
+        new Fr(0),
+        new Fr(0)
+    ];
+    const contractInstanceLog = new PrivateLog(assertLength(fields, PRIVATE_LOG_SIZE_IN_FIELDS));
+    const contractAddressNullifier = await siloNullifier(AztecAddress.fromNumber(DEPLOYER_CONTRACT_ADDRESS), contractInstance.address.toField());
+    const accumulatedData = tx.data.forPublic ? tx.data.forPublic.revertibleAccumulatedData : tx.data.forRollup.end;
+    if (!skipNullifierInsertion) {
+        const nextNullifierIndex = countAccumulatedItems(accumulatedData.nullifiers);
+        accumulatedData.nullifiers[nextNullifierIndex] = contractAddressNullifier;
+    }
+    const nextLogIndex = countAccumulatedItems(accumulatedData.privateLogs);
+    accumulatedData.privateLogs[nextLogIndex] = contractInstanceLog;
+}

package/dest/public/index.d.ts

@@ -0,0 +1,10 @@
+export * from '../common/db_interfaces.js';
+export * from './public_tx_simulator/public_tx_simulator.js';
+export { type EnqueuedPublicCallExecutionResult, type PublicFunctionCallResult } from './execution.js';
+export * from './public_db_sources.js';
+export { PublicProcessor, PublicProcessorFactory } from './public_processor/public_processor.js';
+export { SideEffectTrace } from './side_effect_trace.js';
+export { getExecutionRequestsByPhase } from './utils.js';
+export { PublicTxSimulationTester } from './fixtures/index.js';
+export * from './avm/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/public/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/public/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8CAA8C,CAAC;AAC7D,OAAO,EAAE,KAAK,iCAAiC,EAAE,KAAK,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AACvG,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AACjG,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,cAAc,gBAAgB,CAAC"}

package/dest/public/index.js

@@ -0,0 +1,8 @@
+export * from '../common/db_interfaces.js';
+export * from './public_tx_simulator/public_tx_simulator.js';
+export * from './public_db_sources.js';
+export { PublicProcessor, PublicProcessorFactory } from './public_processor/public_processor.js';
+export { SideEffectTrace } from './side_effect_trace.js';
+export { getExecutionRequestsByPhase } from './utils.js';
+export { PublicTxSimulationTester } from './fixtures/index.js';
+export * from './avm/index.js';