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

package/dest/public/public_tx_simulator/public_tx_simulator.d.ts

@@ -1,15 +1,19 @@
-import type { AvmProvingRequest, RevertCode } from '@aztec/stdlib/avm';
+import { Fr } from '@aztec/foundation/fields';
+import { type Logger } from '@aztec/foundation/log';
+import { type AvmProvingRequest, type RevertCode } from '@aztec/stdlib/avm';
 import { SimulationError } from '@aztec/stdlib/errors';
-import type { GasUsed } from '@aztec/stdlib/gas';
-import type { MerkleTreeReadOperations } from '@aztec/stdlib/interfaces/server';
-import { type GlobalVariables, NestedProcessReturnValues, Tx, TxExecutionPhase } from '@aztec/stdlib/tx';
-import { type TelemetryClient, type Tracer } from '@aztec/telemetry-client';
-import { ExecutorMetrics } from '../executor_metrics.js';
-import type { WorldStateDB } from '../public_db_sources.js';
+import type { Gas, GasUsed } from '@aztec/stdlib/gas';
+import type { DebugLog } from '@aztec/stdlib/logs';
+import type { MerkleTreeWriteOperations } from '@aztec/stdlib/trees';
+import { type GlobalVariables, NestedProcessReturnValues, PublicCallRequestWithCalldata, Tx, TxExecutionPhase } from '@aztec/stdlib/tx';
+import type { AvmFinalizedCallResult } from '../avm/avm_contract_call_result.js';
+import { type PublicContractsDB } from '../public_db_sources.js';
+import type { PublicPersistableStateManager } from '../state_manager/state_manager.js';
 import { PublicTxContext } from './public_tx_context.js';
+import type { PublicTxSimulatorInterface } from './public_tx_simulator_interface.js';
 export type ProcessedPhase = {
     phase: TxExecutionPhase;
-    durationMs: number;
+    durationMs?: number;
     returnValues: NestedProcessReturnValues[];
     reverted: boolean;
     revertReason?: SimulationError;
@@ -22,57 +26,43 @@ export type PublicTxResult = {
     /** Revert reason, if any */
     revertReason?: SimulationError;
     processedPhases: ProcessedPhase[];
+    logs: DebugLog[];
 };
-export declare class PublicTxSimulator {
-    private db;
-    private worldStateDB;
-    private globalVariables;
-    private doMerkleOperations;
-    private skipFeeEnforcement;
-    metrics: ExecutorMetrics;
-    private log;
-    constructor(db: MerkleTreeReadOperations, worldStateDB: WorldStateDB, globalVariables: GlobalVariables, doMerkleOperations?: boolean, skipFeeEnforcement?: boolean, telemetryClient?: TelemetryClient);
-    get tracer(): Tracer;
+export type PublicTxSimulatorConfig = {
+    proverId: Fr;
+    doMerkleOperations: boolean;
+    skipFeeEnforcement: boolean;
+    clientInitiatedSimulation: boolean;
+    maxDebugLogMemoryReads: number;
+};
+export declare class PublicTxSimulator implements PublicTxSimulatorInterface {
+    protected merkleTree: MerkleTreeWriteOperations;
+    protected contractsDB: PublicContractsDB;
+    protected globalVariables: GlobalVariables;
+    protected log: Logger;
+    private config;
+    constructor(merkleTree: MerkleTreeWriteOperations, contractsDB: PublicContractsDB, globalVariables: GlobalVariables, config?: Partial<PublicTxSimulatorConfig>);
     /**
      * Simulate a transaction's public portion including all of its phases.
      * @param tx - The transaction to simulate.
      * @returns The result of the transaction's public execution.
      */
     simulate(tx: Tx): Promise<PublicTxResult>;
+    protected computeTxHash(tx: Tx): import("@aztec/stdlib/tx").TxHash;
     /**
      * Simulate the setup phase of a transaction's public execution.
      * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
      * @returns The phase result.
      */
-    private simulateSetupPhase;
-    /**
-     * Simulate the app logic phase of a transaction's public execution.
-     * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
-     * @returns The phase result.
-     */
-    private simulateAppLogicPhase;
-    /**
-     * Simulate the teardown phase of a transaction's public execution.
-     * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
-     * @returns The phase result.
-     */
-    private simulateTeardownPhase;
-    /**
-     * Simulate a phase of a transaction's public execution.
-     * @param phase - The current phase
-     * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
-     * @returns The phase result.
-     */
-    private simulatePhase;
+    protected simulatePhase(phase: TxExecutionPhase, context: PublicTxContext): Promise<ProcessedPhase>;
     /**
      * Simulate an enqueued public call.
      * @param phase - The current phase of public execution
      * @param context - WILL BE MUTATED. The context of the currently executing public transaction portion
-     * @param callRequest - The enqueued call to execute
-     * @param executionRequest - The execution request (includes args)
+     * @param callRequest - The public function call request, including the calldata.
      * @returns The result of execution.
      */
-    private simulateEnqueuedCall;
+    protected simulateEnqueuedCall(phase: TxExecutionPhase, context: PublicTxContext, callRequest: PublicCallRequestWithCalldata): Promise<AvmFinalizedCallResult>;
     /**
      * Simulate an enqueued public call, without modifying the context (PublicTxContext).
      * Resulting modifications to the context can be applied by the caller.
@@ -81,22 +71,30 @@ export declare class PublicTxSimulator {
      * while still simulating phases and generating a proving request.
      *
      * @param stateManager - The state manager for AvmSimulation
-     * @param context - The context of the currently executing public transaction portion
-     * @param executionRequest - The execution request (includes args)
+     * @param callRequest - The public function call request, including the calldata.
      * @param allocatedGas - The gas allocated to the enqueued call
      * @param fnName - The name of the function
      * @returns The result of execution.
      */
-    private simulateEnqueuedCallInternal;
+    protected simulateEnqueuedCallInternal(stateManager: PublicPersistableStateManager, { request, calldata }: PublicCallRequestWithCalldata, allocatedGas: Gas, transactionFee: Fr, fnName: string): Promise<AvmFinalizedCallResult>;
     /**
      * Insert the non-revertible accumulated data from private into the public state.
      */
-    insertNonRevertiblesFromPrivate(context: PublicTxContext): Promise<void>;
+    protected insertNonRevertiblesFromPrivate(context: PublicTxContext, tx: Tx): Promise<void>;
     /**
      * Insert the revertible accumulated data from private into the public state.
-     * Start by forking state so we can rollback to the end of setup if app logic or teardown reverts.
+     * Throws TxSimRevertibleInsertionsRevert if there is some checked error during revertible insertions.
+     * This function checks for the following errors:
+     * - NullifierLimitReachedError
+     * - NullifierCollisionError
+     * - NoteHashLimitReachedError
+     * - L2ToL1MessageLimitReachedError
      */
-    insertRevertiblesFromPrivate(context: PublicTxContext): Promise<boolean>;
+    protected insertRevertiblesFromPrivate(context: PublicTxContext, tx: Tx): Promise<void>;
     private payFee;
+    /**
+     * Generate the proving request for the AVM circuit.
+     */
+    private static generateProvingRequest;
 }
 //# sourceMappingURL=public_tx_simulator.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"public_tx_simulator.d.ts","sourceRoot":"","sources":["../../../src/public/public_tx_simulator/public_tx_simulator.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAO,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAGhF,OAAO,EACL,KAAK,eAAe,EACpB,yBAAyB,EAEzB,EAAE,EACF,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAc,KAAK,eAAe,EAAE,KAAK,MAAM,EAAiC,MAAM,yBAAyB,CAAC;AAQvH,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,yBAAyB,EAAE,CAAC;IAC1C,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,eAAe,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,UAAU,CAAC;IACvB,4BAA4B;IAC5B,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,eAAe,EAAE,cAAc,EAAE,CAAC;CACnC,CAAC;AAEF,qBAAa,iBAAiB;IAM1B,OAAO,CAAC,EAAE;IACV,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,kBAAkB;IAC1B,OAAO,CAAC,kBAAkB;IAT5B,OAAO,EAAE,eAAe,CAAC;IAEzB,OAAO,CAAC,GAAG,CAAS;gBAGV,EAAE,EAAE,wBAAwB,EAC5B,YAAY,EAAE,YAAY,EAC1B,eAAe,EAAE,eAAe,EAChC,kBAAkB,GAAE,OAAe,EACnC,kBAAkB,GAAE,OAAe,EAC3C,eAAe,GAAE,eAAsC;IAMzD,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD;;;;OAIG;IACU,QAAQ,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IA0FtD;;;;OAIG;YACW,kBAAkB;IAIhC;;;;OAIG;YACW,qBAAqB;IAkBnC;;;;OAIG;YACW,qBAAqB;IAoBnC;;;;;OAKG;YACW,aAAa;IA0C3B;;;;;;;OAOG;YAOW,oBAAoB;IAoClC;;;;;;;;;;;;;OAaG;YAOW,4BAA4B;IAgD1C;;OAEG;IACU,+BAA+B,CAAC,OAAO,EAAE,eAAe;IAkBrE;;;OAGG;IACU,4BAA4B,CAAC,OAAO,EAAE,eAAe,GAAgB,OAAO,CAAC,OAAO,CAAC;YA+BpF,MAAM;CA+BrB"}
+{"version":3,"file":"public_tx_simulator.d.ts","sourceRoot":"","sources":["../../../src/public/public_tx_simulator/public_tx_simulator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAGlE,OAAO,EAIL,KAAK,iBAAiB,EAEtB,KAAK,UAAU,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EACL,KAAK,eAAe,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,EAAE,EACF,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAI1B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAIjF,OAAO,EAAE,KAAK,iBAAiB,EAAiB,MAAM,yBAAyB,CAAC;AAOhF,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAErF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,yBAAyB,EAAE,CAAC;IAC1C,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,eAAe,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,UAAU,CAAC;IACvB,4BAA4B;IAC5B,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,eAAe,EAAE,cAAc,EAAE,CAAC;IAClC,IAAI,EAAE,QAAQ,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,EAAE,CAAC;IACb,kBAAkB,EAAE,OAAO,CAAC;IAC5B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,yBAAyB,EAAE,OAAO,CAAC;IACnC,sBAAsB,EAAE,MAAM,CAAC;CAChC,CAAC;AAqCF,qBAAa,iBAAkB,YAAW,0BAA0B;IAKhE,SAAS,CAAC,UAAU,EAAE,yBAAyB;IAC/C,SAAS,CAAC,WAAW,EAAE,iBAAiB;IACxC,SAAS,CAAC,eAAe,EAAE,eAAe;IAN5C,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,MAAM,CAA0B;gBAG5B,UAAU,EAAE,yBAAyB,EACrC,WAAW,EAAE,iBAAiB,EAC9B,eAAe,EAAE,eAAe,EAC1C,MAAM,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC;IAY3C;;;;OAIG;IACU,QAAQ,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAqItD,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE;IAI9B;;;;OAIG;cACa,aAAa,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAqCzG;;;;;;OAMG;cACa,oBAAoB,CAClC,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,eAAe,EACxB,WAAW,EAAE,6BAA6B,GACzC,OAAO,CAAC,sBAAsB,CAAC;IA6BlC;;;;;;;;;;;;OAYG;cACa,4BAA4B,CAC1C,YAAY,EAAE,6BAA6B,EAC3C,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,6BAA6B,EACpD,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,EAAE,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,sBAAsB,CAAC;IAwBlC;;OAEG;cACa,+BAA+B,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE;IA0BhF;;;;;;;;OAQG;cACa,4BAA4B,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,EAAE;YA0E/D,MAAM;IA+BpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,sBAAsB;CAStC"}