@aztec/simulator 0.43.0 → 0.45.0

package/src/public/execution.ts

@@ -18,18 +18,39 @@ import { type Gas } from '../avm/avm_gas.js';
  * The public function execution result.
  */
 export interface PublicExecutionResult {
-  /** The execution that triggered this result. */
-  execution: PublicExecution;
+  /** 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. */
   newNoteHashes: NoteHash[];
   /** The new l2 to l1 messages generated in this call. */
   newL2ToL1Messages: L2ToL1Message[];
-  /** The side effect counter at the start of the function call. */
-  startSideEffectCounter: Fr;
-  /** The side effect counter after executing this function call */
-  endSideEffectCounter: Fr;
   /** The new nullifiers to be inserted into the nullifier tree. */
   newNullifiers: Nullifier[];
   /** The note hash read requests emitted in this call. */
@@ -40,12 +61,6 @@ export interface PublicExecutionResult {
   nullifierNonExistentReadRequests: ReadRequest[];
   /** L1 to L2 message read requests emitted in this call. */
   l1ToL2MsgReadRequests: ReadRequest[];
-  /** The contract storage reads performed by the function. */
-  contractStorageReads: ContractStorageRead[];
-  /** The contract storage update requests performed by the function. */
-  contractStorageUpdateRequests: ContractStorageUpdateRequest[];
-  /** The results of nested calls. */
-  nestedExecutions: this[];
   /**
    * The hashed logs with side effect counter.
    * Note: required as we don't track the counter anywhere else.
@@ -61,28 +76,27 @@ export interface PublicExecutionResult {
    * Useful for maintaining correct ordering in ts.
    */
   allUnencryptedLogs: UnencryptedFunctionL2Logs;
-  /** Whether the execution reverted. */
-  reverted: boolean;
-  /** The revert reason if the execution reverted. */
-  revertReason?: SimulationError;
-  /** 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[];
+
+  // TODO(dbanks12): add contract instance read requests
+
+  /** The results of nested calls. */
+  nestedExecutions: this[];
+
   /** Hints for proving AVM execution. */
-  avmHints: AvmExecutionHints;
+  avmCircuitHints: AvmExecutionHints;
+
+  /** The name of the function that was executed. Only used for logging. */
+  functionName: string;
 }
 
 /**
- * The execution of a public function.
+ * The execution request of a public function.
+ * A subset of PublicCallRequest
  */
-export type PublicExecution = Pick<PublicCallRequest, 'contractAddress' | 'functionSelector' | 'callContext' | 'args'>;
+export type PublicExecutionRequest = Pick<
+  PublicCallRequest,
+  'contractAddress' | 'functionSelector' | 'callContext' | 'args'
+>;
 
 /**
  * Returns if the input is a public execution result and not just a public execution.
@@ -90,9 +104,9 @@ export type PublicExecution = Pick<PublicCallRequest, 'contractAddress' | 'funct
  * @returns Whether the input is a public execution result and not just a public execution.
  */
 export function isPublicExecutionResult(
-  input: PublicExecution | PublicExecutionResult,
+  input: PublicExecutionRequest | PublicExecutionResult,
 ): input is PublicExecutionResult {
-  return 'execution' in input && input.execution !== undefined;
+  return 'executionRequest' in input && input.executionRequest !== undefined;
 }
 
 /**

package/src/public/executor.ts

@@ -1,23 +1,24 @@
 import { type AvmSimulationStats } from '@aztec/circuit-types/stats';
-import { Fr, type Gas, type GlobalVariables, type Header, type Nullifier, type TxContext } from '@aztec/circuits.js';
+import { Fr, Gas, type GlobalVariables, type Header, type Nullifier, type TxContext } from '@aztec/circuits.js';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 
 import { AvmContext } from '../avm/avm_context.js';
+import { AvmExecutionEnvironment } from '../avm/avm_execution_environment.js';
 import { AvmMachineState } from '../avm/avm_machine_state.js';
 import { AvmSimulator } from '../avm/avm_simulator.js';
 import { HostStorage } from '../avm/journal/host_storage.js';
 import { AvmPersistableStateManager } from '../avm/journal/index.js';
 import { type CommitmentsDB, type PublicContractsDB, type PublicStateDB } from './db_interfaces.js';
-import { type PublicExecution, type PublicExecutionResult, checkValidStaticCall } from './execution.js';
-import { convertAvmResultsToPxResult, createAvmExecutionEnvironment } from './transitional_adaptors.js';
+import { type PublicExecutionRequest, type PublicExecutionResult } from './execution.js';
+import { PublicSideEffectTrace } from './side_effect_trace.js';
 
 /**
  * Handles execution of public functions.
  */
 export class PublicExecutor {
   constructor(
-    private readonly stateDb: PublicStateDB,
+    private readonly publicStorageDB: PublicStateDB,
     private readonly contractsDb: PublicContractsDB,
     private readonly commitmentsDb: CommitmentsDB,
     private readonly header: Header,
@@ -27,54 +28,56 @@ export class PublicExecutor {
 
   /**
    * Executes a public execution request.
-   * @param execution - The execution to run.
+   * @param executionRequest - The execution to run.
    * @param globalVariables - The global variables to use.
-   * @returns The result of the run plus all nested runs.
+   * @param availableGas - The gas available at the start of this enqueued call.
+   * @param txContext - Transaction context.
+   * @param pendingSiloedNullifiers - The pending nullifier set from earlier parts of this TX.
+   * @param transactionFee - Fee offered for this TX.
+   * @param startSideEffectCounter - The counter of the first side-effect generated by this simulation.
+   * @returns The result of execution, including the results of all nested calls.
    */
   public async simulate(
-    execution: PublicExecution,
+    executionRequest: PublicExecutionRequest,
     globalVariables: GlobalVariables,
     availableGas: Gas,
-    txContext: TxContext,
-    pendingNullifiers: Nullifier[],
+    _txContext: TxContext,
+    pendingSiloedNullifiers: Nullifier[],
     transactionFee: Fr = Fr.ZERO,
     startSideEffectCounter: number = 0,
   ): Promise<PublicExecutionResult> {
-    const address = execution.contractAddress;
-    const selector = execution.functionSelector;
-    const startGas = availableGas;
-    const fnName = await this.contractsDb.getDebugFunctionName(address, selector);
+    const address = executionRequest.contractAddress;
+    const selector = executionRequest.functionSelector;
+    const fnName = (await this.contractsDb.getDebugFunctionName(address, selector)) ?? `${address}:${selector}`;
 
     PublicExecutor.log.verbose(`[AVM] Executing public external function ${fnName}.`);
     const timer = new Timer();
 
-    // Temporary code to construct the AVM context
-    // These data structures will permeate across the simulator when the public executor is phased out
-    const hostStorage = new HostStorage(this.stateDb, this.contractsDb, this.commitmentsDb);
-
-    const worldStateJournal = new AvmPersistableStateManager(hostStorage);
-    for (const nullifier of pendingNullifiers) {
-      worldStateJournal.nullifiers.cache.appendSiloed(nullifier.value);
-    }
-    worldStateJournal.trace.accessCounter = startSideEffectCounter;
+    const hostStorage = new HostStorage(this.publicStorageDB, this.contractsDb, this.commitmentsDb);
+    const trace = new PublicSideEffectTrace(startSideEffectCounter);
+    const avmPersistableState = AvmPersistableStateManager.newWithPendingSiloedNullifiers(
+      hostStorage,
+      trace,
+      pendingSiloedNullifiers.map(n => n.value),
+    );
 
-    const executionEnv = createAvmExecutionEnvironment(
-      execution,
+    const avmExecutionEnv = createAvmExecutionEnvironment(
+      executionRequest,
       this.header,
       globalVariables,
-      txContext.gasSettings,
       transactionFee,
     );
 
-    const machineState = new AvmMachineState(startGas);
-    const avmContext = new AvmContext(worldStateJournal, executionEnv, machineState);
+    const avmMachineState = new AvmMachineState(availableGas);
+    const avmContext = new AvmContext(avmPersistableState, avmExecutionEnv, avmMachineState);
     const simulator = new AvmSimulator(avmContext);
     const avmResult = await simulator.execute();
-    const bytecode = simulator.getBytecode();
+    const bytecode = simulator.getBytecode()!;
 
-    // Commit the journals state to the DBs since this is a top-level execution.
+    // Commit the public storage state to the DBs since this is a top-level execution.
     // Observe that this will write all the state changes to the DBs, not only the latest for each slot.
     // However, the underlying DB keep a cache and will only write the latest state to disk.
+    // TODO(dbanks12): this should be unnecessary here or should be exposed by state manager
     await avmContext.persistableState.publicStorage.commitToDB();
 
     PublicExecutor.log.verbose(
@@ -83,33 +86,52 @@ export class PublicExecutor {
       }.`,
       {
         eventName: 'avm-simulation',
-        appCircuitName: fnName ?? 'unknown',
+        appCircuitName: fnName,
         duration: timer.ms(),
         bytecodeSize: bytecode!.length,
       } satisfies AvmSimulationStats,
     );
 
-    const executionResult = convertAvmResultsToPxResult(
-      avmResult,
-      startSideEffectCounter,
-      execution,
-      startGas,
-      avmContext,
+    const publicExecutionResult = trace.toPublicExecutionResult(
+      avmExecutionEnv,
+      /*startGasLeft=*/ availableGas,
+      /*endGasLeft=*/ Gas.from(avmContext.machineState.gasLeft),
       bytecode,
+      avmResult,
+      fnName,
+      /*requestSideEffectCounter=*/ executionRequest.callContext.sideEffectCounter,
+      // NOTE: startSideEffectCounter is not the same as the executionRequest's sideEffectCounter
+      // (which counts the request itself)
     );
 
-    // TODO(https://github.com/AztecProtocol/aztec-packages/issues/5818): is this really needed?
-    // should already be handled in simulation.
-    if (execution.callContext.isStaticCall) {
-      checkValidStaticCall(
-        executionResult.newNoteHashes,
-        executionResult.newNullifiers,
-        executionResult.contractStorageUpdateRequests,
-        executionResult.newL2ToL1Messages,
-        executionResult.unencryptedLogs,
-      );
-    }
-
-    return executionResult;
+    return publicExecutionResult;
   }
 }
+
+/**
+ * Convert a PublicExecutionRequest object to an AvmExecutionEnvironment
+ *
+ * @param executionRequest
+ * @param globalVariables
+ * @returns
+ */
+function createAvmExecutionEnvironment(
+  executionRequest: PublicExecutionRequest,
+  header: Header,
+  globalVariables: GlobalVariables,
+  transactionFee: Fr,
+): AvmExecutionEnvironment {
+  return new AvmExecutionEnvironment(
+    executionRequest.contractAddress,
+    executionRequest.callContext.storageContractAddress,
+    executionRequest.callContext.msgSender,
+    executionRequest.functionSelector,
+    /*contractCallDepth=*/ Fr.zero(),
+    transactionFee,
+    header,
+    globalVariables,
+    executionRequest.callContext.isStaticCall,
+    executionRequest.callContext.isDelegateCall,
+    executionRequest.args,
+  );
+}

package/src/public/index.ts

@@ -1,6 +1,6 @@
 export * from './abstract_phase_manager.js';
 export * from './db_interfaces.js';
-export { isPublicExecutionResult, type PublicExecution, type PublicExecutionResult } from './execution.js';
+export { isPublicExecutionResult, type PublicExecutionRequest, type PublicExecutionResult } from './execution.js';
 export { PublicExecutor } from './executor.js';
 export * from './fee_payment.js';
 export { HintsBuilder } from './hints_builder.js';

package/src/public/public_kernel.ts

@@ -21,8 +21,9 @@ import {
   convertSimulatedPublicTeardownInputsToWitnessMap,
   convertSimulatedPublicTeardownOutputFromWitnessMap,
 } from '@aztec/noir-protocol-circuits-types';
-import { type SimulationProvider, WASMSimulator } from '@aztec/simulator';
 
+import { WASMSimulator } from '../providers/acvm_wasm.js';
+import { type SimulationProvider } from '../providers/simulation_provider.js';
 import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
 
 /**

package/src/public/public_processor.ts

@@ -30,6 +30,7 @@ import {
   computeFeePayerBalanceLeafSlot,
   computeFeePayerBalanceStorageSlot,
 } from '@aztec/simulator';
+import { Attributes, type TelemetryClient, type Tracer, trackSpan } from '@aztec/telemetry-client';
 import { type ContractDataSource } from '@aztec/types/contracts';
 import { type MerkleTreeOperations } from '@aztec/world-state';
 
@@ -47,6 +48,7 @@ export class PublicProcessorFactory {
     private merkleTree: MerkleTreeOperations,
     private contractDataSource: ContractDataSource,
     private simulator: SimulationProvider,
+    private telemetryClient: TelemetryClient,
   ) {}
 
   /**
@@ -74,6 +76,7 @@ export class PublicProcessorFactory {
       historicalHeader,
       publicContractsDB,
       worldStatePublicDB,
+      this.telemetryClient,
     );
   }
 }
@@ -83,6 +86,7 @@ export class PublicProcessorFactory {
  * any public function calls in them. Txs with private calls only are unaffected.
  */
 export class PublicProcessor {
+  public readonly tracer: Tracer;
   constructor(
     protected db: MerkleTreeOperations,
     protected publicExecutor: PublicExecutor,
@@ -91,9 +95,11 @@ export class PublicProcessor {
     protected historicalHeader: Header,
     protected publicContractsDB: ContractsDataSourcePublicDB,
     protected publicStateDB: PublicStateDB,
-
+    telemetryClient: TelemetryClient,
     private log = createDebugLogger('aztec:sequencer:public-processor'),
-  ) {}
+  ) {
+    this.tracer = telemetryClient.getTracer('PublicProcessor');
+  }
 
   /**
    * Run each tx through the public circuit and the public kernel circuit if needed.
@@ -208,6 +214,9 @@ export class PublicProcessor {
     return finalPublicDataUpdateRequests;
   }
 
+  @trackSpan('PublicProcessor.processTxWithPublicCalls', tx => ({
+    [Attributes.TX_HASH]: tx.getTxHash().toString(),
+  }))
   private async processTxWithPublicCalls(tx: Tx): Promise<[ProcessedTx, NestedProcessReturnValues[]]> {
     let returnValues: NestedProcessReturnValues[] = [];
     const publicProvingRequests: PublicProvingRequest[] = [];