@aztec/simulator 0.42.0 → 0.43.0

package/src/public/public_db_sources.ts

@@ -1,10 +1,11 @@
 import { MerkleTreeId, NullifierMembershipWitness, type Tx } from '@aztec/circuit-types';
+import { type PublicDBAccessStats } from '@aztec/circuit-types/stats';
 import {
   type AztecAddress,
   ContractClassRegisteredEvent,
   ContractInstanceDeployedEvent,
   Fr,
-  type FunctionSelector,
+  FunctionSelector,
   type L1_TO_L2_MSG_TREE_HEIGHT,
   type NULLIFIER_TREE_HEIGHT,
   type NullifierLeafPreimage,
@@ -12,7 +13,8 @@ import {
 } from '@aztec/circuits.js';
 import { computeL1ToL2MessageNullifier, computePublicDataTreeLeafSlot } from '@aztec/circuits.js/hash';
 import { createDebugLogger } from '@aztec/foundation/log';
-import { getCanonicalClassRegistererAddress } from '@aztec/protocol-contracts/class-registerer';
+import { Timer } from '@aztec/foundation/timer';
+import { ClassRegistererAddress } from '@aztec/protocol-contracts/class-registerer';
 import {
   type CommitmentsDB,
   MessageLoadOracleInputs,
@@ -45,7 +47,7 @@ export class ContractsDataSourcePublicDB implements PublicContractsDB {
   public addNewContracts(tx: Tx): Promise<void> {
     // Extract contract class and instance data from logs and add to cache for this block
     const logs = tx.unencryptedLogs.unrollLogs();
-    ContractClassRegisteredEvent.fromLogs(logs, getCanonicalClassRegistererAddress()).forEach(e => {
+    ContractClassRegisteredEvent.fromLogs(logs, ClassRegistererAddress).forEach(e => {
       this.log.debug(`Adding class ${e.contractClassId.toString()} to public execution contract cache`);
       this.classCache.set(e.contractClassId.toString(), e.toContractClassPublic());
     });
@@ -68,7 +70,7 @@ export class ContractsDataSourcePublicDB implements PublicContractsDB {
     // Let's say we have two txs adding the same contract on the same block. If the 2nd one reverts,
     // wouldn't that accidentally remove the contract added on the first one?
     const logs = tx.unencryptedLogs.unrollLogs();
-    ContractClassRegisteredEvent.fromLogs(logs, getCanonicalClassRegistererAddress()).forEach(e =>
+    ContractClassRegisteredEvent.fromLogs(logs, ClassRegistererAddress).forEach(e =>
       this.classCache.delete(e.contractClassId.toString()),
     );
     ContractInstanceDeployedEvent.fromLogs(logs).forEach(e => this.instanceCache.delete(e.address.toString()));
@@ -94,6 +96,22 @@ export class ContractsDataSourcePublicDB implements PublicContractsDB {
     }
     return contractClass.publicFunctions.find(f => f.selector.equals(selector))?.bytecode;
   }
+
+  public async getDebugFunctionName(address: AztecAddress, selector: FunctionSelector): Promise<string | undefined> {
+    const artifact = await this.db.getContractArtifact(address);
+    if (!artifact) {
+      return Promise.resolve(undefined);
+    }
+
+    const f = artifact.functions.find(f =>
+      FunctionSelector.fromNameAndParameters(f.name, f.parameters).equals(selector),
+    );
+    if (!f) {
+      return Promise.resolve(undefined);
+    }
+
+    return Promise.resolve(`${artifact.name}:${f.name}`);
+  }
 }
 
 /**
@@ -196,11 +214,14 @@ export class WorldStatePublicDB implements PublicStateDB {
  * Implements WorldState db using a world state database.
  */
 export class WorldStateDB implements CommitmentsDB {
+  private log = createDebugLogger('aztec:sequencer:world-state-db');
+
   constructor(private db: MerkleTreeOperations) {}
 
   public async getNullifierMembershipWitnessAtLatestBlock(
     nullifier: Fr,
   ): Promise<NullifierMembershipWitness | undefined> {
+    const timer = new Timer();
     const index = await this.db.findLeafIndex(MerkleTreeId.NULLIFIER_TREE, nullifier.toBuffer());
     if (!index) {
       return undefined;
@@ -218,6 +239,12 @@ export class WorldStateDB implements CommitmentsDB {
       return undefined;
     }
 
+    this.log.debug(`[DB] Fetched nullifier membership`, {
+      eventName: 'public-db-access',
+      duration: timer.ms(),
+      operation: 'get-nullifier-membership-witness-at-latest-block',
+    } satisfies PublicDBAccessStats);
+
     return new NullifierMembershipWitness(BigInt(index), leafPreimage as NullifierLeafPreimage, siblingPath);
   }
 
@@ -232,6 +259,7 @@ export class WorldStateDB implements CommitmentsDB {
 
     // We iterate over messages until we find one whose nullifier is not in the nullifier tree --> we need to check
     // for nullifiers because messages can have duplicates.
+    const timer = new Timer();
     do {
       messageIndex = (await this.db.findLeafIndexAfter(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, messageHash, startIndex))!;
       if (messageIndex === undefined) {
@@ -249,18 +277,45 @@ export class WorldStateDB implements CommitmentsDB {
       messageIndex,
     );
 
+    this.log.debug(`[DB] Fetched L1 to L2 message membership`, {
+      eventName: 'public-db-access',
+      duration: timer.ms(),
+      operation: 'get-l1-to-l2-message-membership-witness',
+    } satisfies PublicDBAccessStats);
+
     return new MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT>(messageIndex, siblingPath);
   }
 
   public async getL1ToL2LeafValue(leafIndex: bigint): Promise<Fr | undefined> {
-    return await this.db.getLeafValue(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, leafIndex);
+    const timer = new Timer();
+    const leafValue = await this.db.getLeafValue(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, leafIndex);
+    this.log.debug(`[DB] Fetched L1 to L2 message leaf value`, {
+      eventName: 'public-db-access',
+      duration: timer.ms(),
+      operation: 'get-l1-to-l2-message-leaf-value',
+    } satisfies PublicDBAccessStats);
+    return leafValue;
   }
 
   public async getCommitmentIndex(commitment: Fr): Promise<bigint | undefined> {
-    return await this.db.findLeafIndex(MerkleTreeId.NOTE_HASH_TREE, commitment);
+    const timer = new Timer();
+    const index = await this.db.findLeafIndex(MerkleTreeId.NOTE_HASH_TREE, commitment);
+    this.log.debug(`[DB] Fetched commitment index`, {
+      eventName: 'public-db-access',
+      duration: timer.ms(),
+      operation: 'get-commitment-index',
+    } satisfies PublicDBAccessStats);
+    return index;
   }
 
   public async getNullifierIndex(nullifier: Fr): Promise<bigint | undefined> {
-    return await this.db.findLeafIndex(MerkleTreeId.NULLIFIER_TREE, nullifier.toBuffer());
+    const timer = new Timer();
+    const index = await this.db.findLeafIndex(MerkleTreeId.NULLIFIER_TREE, nullifier.toBuffer());
+    this.log.debug(`[DB] Fetched nullifier index`, {
+      eventName: 'public-db-access',
+      duration: timer.ms(),
+      operation: 'get-nullifier-index',
+    } satisfies PublicDBAccessStats);
+    return index;
   }
 }

package/src/public/public_processor.ts

@@ -3,6 +3,7 @@ import {
   type FailedTx,
   NestedProcessReturnValues,
   type ProcessedTx,
+  PublicKernelType,
   type PublicProvingRequest,
   type SimulationError,
   Tx,
@@ -32,11 +33,7 @@ import {
 import { type ContractDataSource } from '@aztec/types/contracts';
 import { type MerkleTreeOperations } from '@aztec/world-state';
 
-import {
-  type AbstractPhaseManager,
-  PublicKernelPhase,
-  publicKernelPhaseToKernelType,
-} from './abstract_phase_manager.js';
+import { type AbstractPhaseManager } from './abstract_phase_manager.js';
 import { PhaseManagerFactory } from './phase_manager_factory.js';
 import { ContractsDataSourcePublicDB, WorldStateDB, WorldStatePublicDB } from './public_db_sources.js';
 import { RealPublicKernelCircuitSimulator } from './public_kernel.js';
@@ -231,8 +228,8 @@ export class PublicProcessor {
     const gasUsed: ProcessedTx['gasUsed'] = {};
     while (phase) {
       const output = await phase.handle(tx, publicKernelPublicInput);
-      gasUsed[publicKernelPhaseToKernelType(phase.phase)] = output.gasUsed;
-      if (phase.phase === PublicKernelPhase.APP_LOGIC) {
+      gasUsed[phase.phase] = output.gasUsed;
+      if (phase.phase === PublicKernelType.APP_LOGIC) {
         returnValues = output.returnValues;
       }
       publicProvingRequests.push(...output.publicProvingRequests);

package/src/public/setup_phase_manager.ts

@@ -3,7 +3,7 @@ import { type GlobalVariables, type Header, type PublicKernelCircuitPublicInputs
 import { type PublicExecutor, type PublicStateDB } from '@aztec/simulator';
 import { type MerkleTreeOperations } from '@aztec/world-state';
 
-import { AbstractPhaseManager, PublicKernelPhase, makeAvmProvingRequest } from './abstract_phase_manager.js';
+import { AbstractPhaseManager, makeAvmProvingRequest } from './abstract_phase_manager.js';
 import { type ContractsDataSourcePublicDB } from './public_db_sources.js';
 import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
 
@@ -19,7 +19,7 @@ export class SetupPhaseManager extends AbstractPhaseManager {
     historicalHeader: Header,
     protected publicContractsDB: ContractsDataSourcePublicDB,
     protected publicStateDB: PublicStateDB,
-    phase: PublicKernelPhase = PublicKernelPhase.SETUP,
+    phase: PublicKernelType = PublicKernelType.SETUP,
   ) {
     super(db, publicExecutor, publicKernel, globalVariables, historicalHeader, phase);
   }

package/src/public/tail_phase_manager.ts

@@ -13,7 +13,7 @@ import {
 import { type PublicExecutor, type PublicStateDB } from '@aztec/simulator';
 import { type MerkleTreeOperations } from '@aztec/world-state';
 
-import { AbstractPhaseManager, PublicKernelPhase } from './abstract_phase_manager.js';
+import { AbstractPhaseManager } from './abstract_phase_manager.js';
 import { type ContractsDataSourcePublicDB } from './public_db_sources.js';
 import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
 
@@ -26,7 +26,7 @@ export class TailPhaseManager extends AbstractPhaseManager {
     historicalHeader: Header,
     protected publicContractsDB: ContractsDataSourcePublicDB,
     protected publicStateDB: PublicStateDB,
-    phase: PublicKernelPhase = PublicKernelPhase.TAIL,
+    phase: PublicKernelType = PublicKernelType.TAIL,
   ) {
     super(db, publicExecutor, publicKernel, globalVariables, historicalHeader, phase);
   }

package/src/public/teardown_phase_manager.ts

@@ -11,7 +11,7 @@ import { type MerkleTreeOperations } from '@aztec/world-state';
 
 import { inspect } from 'util';
 
-import { AbstractPhaseManager, PublicKernelPhase, makeAvmProvingRequest } from './abstract_phase_manager.js';
+import { AbstractPhaseManager, makeAvmProvingRequest } from './abstract_phase_manager.js';
 import { type ContractsDataSourcePublicDB } from './public_db_sources.js';
 import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
 
@@ -27,7 +27,7 @@ export class TeardownPhaseManager extends AbstractPhaseManager {
     historicalHeader: Header,
     protected publicContractsDB: ContractsDataSourcePublicDB,
     protected publicStateDB: PublicStateDB,
-    phase: PublicKernelPhase = PublicKernelPhase.TEARDOWN,
+    phase: PublicKernelType = PublicKernelType.TEARDOWN,
   ) {
     super(db, publicExecutor, publicKernel, globalVariables, historicalHeader, phase);
   }

package/src/public/transitional_adaptors.ts

@@ -1,6 +1,16 @@
 // All code in this file needs to die once the public executor is phased out in favor of the AVM.
 import { UnencryptedFunctionL2Logs } from '@aztec/circuit-types';
-import { CallContext, type Gas, type GasSettings, type GlobalVariables, type Header } from '@aztec/circuits.js';
+import {
+  AvmContractInstanceHint,
+  AvmExecutionHints,
+  AvmExternalCallHint,
+  AvmKeyValueHint,
+  CallContext,
+  Gas,
+  type GasSettings,
+  type GlobalVariables,
+  type Header,
+} from '@aztec/circuits.js';
 import { Fr } from '@aztec/foundation/fields';
 
 import { promisify } from 'util';
@@ -9,6 +19,8 @@ import { gunzip } from 'zlib';
 import { type AvmContext } from '../avm/avm_context.js';
 import { AvmExecutionEnvironment } from '../avm/avm_execution_environment.js';
 import { type AvmContractCallResults } from '../avm/avm_message_call_result.js';
+import { type PartialPublicExecutionResult } from '../avm/journal/journal.js';
+import { type WorldStateAccessTrace } from '../avm/journal/trace.js';
 import { Mov } from '../avm/opcodes/memory.js';
 import { createSimulationError } from '../common/errors.js';
 import { type PublicExecution, type PublicExecutionResult } from './execution.js';
@@ -67,6 +79,34 @@ export function createPublicExecution(
   return execution;
 }
 
+function computeHints(trace: WorldStateAccessTrace, executionResult: PartialPublicExecutionResult): AvmExecutionHints {
+  return new AvmExecutionHints(
+    trace.publicStorageReads.map(read => new AvmKeyValueHint(read.counter, read.value)),
+    trace.noteHashChecks.map(check => new AvmKeyValueHint(check.counter, new Fr(check.exists ? 1 : 0))),
+    trace.nullifierChecks.map(check => new AvmKeyValueHint(check.counter, new Fr(check.exists ? 1 : 0))),
+    trace.l1ToL2MessageChecks.map(check => new AvmKeyValueHint(check.counter, new Fr(check.exists ? 1 : 0))),
+    executionResult.nestedExecutions.map(nested => {
+      const gasUsed = new Gas(
+        nested.startGasLeft.daGas - nested.endGasLeft.daGas,
+        nested.startGasLeft.l2Gas - nested.endGasLeft.l2Gas,
+      );
+      return new AvmExternalCallHint(/*success=*/ new Fr(nested.reverted ? 0 : 1), nested.returnValues, gasUsed);
+    }),
+    trace.gotContractInstances.map(
+      instance =>
+        new AvmContractInstanceHint(
+          instance.address,
+          new Fr(instance.exists ? 1 : 0),
+          instance.salt,
+          instance.deployer,
+          instance.contractClassId,
+          instance.initializationHash,
+          instance.publicKeysHash,
+        ),
+    ),
+  );
+}
+
 export function convertAvmResultsToPxResult(
   avmResult: AvmContractCallResults,
   startSideEffectCounter: number,
@@ -95,7 +135,7 @@ export function convertAvmResultsToPxResult(
     transactionFee: endAvmContext.environment.transactionFee,
     bytecode: bytecode,
     calldata: endAvmContext.environment.calldata,
-    avmHints: endPersistableState.trace.toHints(),
+    avmHints: computeHints(endPersistableState.trace, endPersistableState.transitionalExecutionResult),
   };
 }
 

package/dest/public/utils.d.ts

@@ -1,8 +0,0 @@
-import { type PublicKernelCircuitPublicInputs } from '@aztec/circuits.js';
-/**
- * Looks at the side effects of a transaction and returns the highest counter
- * @param tx - A transaction
- * @returns The highest side effect counter in the transaction so far
- */
-export declare function lastSideEffectCounter(inputs: PublicKernelCircuitPublicInputs): number;
-//# sourceMappingURL=utils.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/public/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,+BAA+B,EAAE,MAAM,oBAAoB,CAAC;AAE1E;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,+BAA+B,GAAG,MAAM,CA+BrF"}

package/dest/public/utils.js

@@ -1,38 +0,0 @@
-/**
- * Looks at the side effects of a transaction and returns the highest counter
- * @param tx - A transaction
- * @returns The highest side effect counter in the transaction so far
- */
-export function lastSideEffectCounter(inputs) {
-    const sideEffectCounters = [
-        ...inputs.endNonRevertibleData.newNoteHashes,
-        ...inputs.endNonRevertibleData.newNullifiers,
-        ...inputs.endNonRevertibleData.noteEncryptedLogsHashes,
-        ...inputs.endNonRevertibleData.encryptedLogsHashes,
-        ...inputs.endNonRevertibleData.unencryptedLogsHashes,
-        ...inputs.endNonRevertibleData.publicCallStack,
-        ...inputs.endNonRevertibleData.publicDataUpdateRequests,
-        ...inputs.end.newNoteHashes,
-        ...inputs.end.newNullifiers,
-        ...inputs.end.noteEncryptedLogsHashes,
-        ...inputs.end.encryptedLogsHashes,
-        ...inputs.end.unencryptedLogsHashes,
-        ...inputs.end.publicCallStack,
-        ...inputs.end.publicDataUpdateRequests,
-    ];
-    let max = 0;
-    for (const sideEffect of sideEffectCounters) {
-        if ('startSideEffectCounter' in sideEffect) {
-            // look at both start and end counters because for enqueued public calls start > 0 while end === 0
-            max = Math.max(max, sideEffect.startSideEffectCounter.toNumber(), sideEffect.endSideEffectCounter.toNumber());
-        }
-        else if ('counter' in sideEffect) {
-            max = Math.max(max, sideEffect.counter);
-        }
-        else {
-            throw new Error('Unknown side effect type');
-        }
-    }
-    return max;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcHVibGljL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUscUJBQXFCLENBQUMsTUFBdUM7SUFDM0UsTUFBTSxrQkFBa0IsR0FBRztRQUN6QixHQUFHLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQyxhQUFhO1FBQzVDLEdBQUcsTUFBTSxDQUFDLG9CQUFvQixDQUFDLGFBQWE7UUFDNUMsR0FBRyxNQUFNLENBQUMsb0JBQW9CLENBQUMsdUJBQXVCO1FBQ3RELEdBQUcsTUFBTSxDQUFDLG9CQUFvQixDQUFDLG1CQUFtQjtRQUNsRCxHQUFHLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQyxxQkFBcUI7UUFDcEQsR0FBRyxNQUFNLENBQUMsb0JBQW9CLENBQUMsZUFBZTtRQUM5QyxHQUFHLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQyx3QkFBd0I7UUFDdkQsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLGFBQWE7UUFDM0IsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLGFBQWE7UUFDM0IsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLHVCQUF1QjtRQUNyQyxHQUFHLE1BQU0sQ0FBQyxHQUFHLENBQUMsbUJBQW1CO1FBQ2pDLEdBQUcsTUFBTSxDQUFDLEdBQUcsQ0FBQyxxQkFBcUI7UUFDbkMsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLGVBQWU7UUFDN0IsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLHdCQUF3QjtLQUN2QyxDQUFDO0lBRUYsSUFBSSxHQUFHLEdBQUcsQ0FBQyxDQUFDO0lBQ1osS0FBSyxNQUFNLFVBQVUsSUFBSSxrQkFBa0IsRUFBRSxDQUFDO1FBQzVDLElBQUksd0JBQXdCLElBQUksVUFBVSxFQUFFLENBQUM7WUFDM0Msa0dBQWtHO1lBQ2xHLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsc0JBQXNCLENBQUMsUUFBUSxFQUFFLEVBQUUsVUFBVSxDQUFDLG9CQUFvQixDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDaEgsQ0FBQzthQUFNLElBQUksU0FBUyxJQUFJLFVBQVUsRUFBRSxDQUFDO1lBQ25DLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDMUMsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLElBQUksS0FBSyxDQUFDLDBCQUEwQixDQUFDLENBQUM7UUFDOUMsQ0FBQztJQUNILENBQUM7SUFFRCxPQUFPLEdBQUcsQ0FBQztBQUNiLENBQUMifQ==

package/src/public/utils.ts

@@ -1,39 +0,0 @@
-import { type PublicKernelCircuitPublicInputs } from '@aztec/circuits.js';
-
-/**
- * Looks at the side effects of a transaction and returns the highest counter
- * @param tx - A transaction
- * @returns The highest side effect counter in the transaction so far
- */
-export function lastSideEffectCounter(inputs: PublicKernelCircuitPublicInputs): number {
-  const sideEffectCounters = [
-    ...inputs.endNonRevertibleData.newNoteHashes,
-    ...inputs.endNonRevertibleData.newNullifiers,
-    ...inputs.endNonRevertibleData.noteEncryptedLogsHashes,
-    ...inputs.endNonRevertibleData.encryptedLogsHashes,
-    ...inputs.endNonRevertibleData.unencryptedLogsHashes,
-    ...inputs.endNonRevertibleData.publicCallStack,
-    ...inputs.endNonRevertibleData.publicDataUpdateRequests,
-    ...inputs.end.newNoteHashes,
-    ...inputs.end.newNullifiers,
-    ...inputs.end.noteEncryptedLogsHashes,
-    ...inputs.end.encryptedLogsHashes,
-    ...inputs.end.unencryptedLogsHashes,
-    ...inputs.end.publicCallStack,
-    ...inputs.end.publicDataUpdateRequests,
-  ];
-
-  let max = 0;
-  for (const sideEffect of sideEffectCounters) {
-    if ('startSideEffectCounter' in sideEffect) {
-      // look at both start and end counters because for enqueued public calls start > 0 while end === 0
-      max = Math.max(max, sideEffect.startSideEffectCounter.toNumber(), sideEffect.endSideEffectCounter.toNumber());
-    } else if ('counter' in sideEffect) {
-      max = Math.max(max, sideEffect.counter);
-    } else {
-      throw new Error('Unknown side effect type');
-    }
-  }
-
-  return max;
-}