@aztec/simulator 0.66.0 → 0.67.1-devnet

package/src/avm/opcodes/misc.ts

@@ -1,4 +1,4 @@
-import { applyStringFormatting, createDebugLogger } from '@aztec/foundation/log';
+import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
 
 import { type AvmContext } from '../avm_context.js';
 import { TypeTag } from '../avm_memory_types.js';
@@ -9,7 +9,7 @@ import { Instruction } from './instruction.js';
 export class DebugLog extends Instruction {
   static type: string = 'DEBUGLOG';
   static readonly opcode: Opcode = Opcode.DEBUGLOG;
-  static readonly logger = createDebugLogger('aztec:avm_simulator:debug_log');
+  static readonly logger = createLogger('simulator:avm:debug_log');
 
   // Informs (de)serialization. See Instruction.deserialize.
   static readonly wireFormat: OperandType[] = [

package/src/avm/test_utils.ts

@@ -28,6 +28,10 @@ export function mockStorageRead(worldStateDB: WorldStateDB, value: Fr) {
   (worldStateDB as jest.Mocked<WorldStateDB>).storageRead.mockResolvedValue(value);
 }
 
+export function mockNoteHashCount(mockedTrace: PublicSideEffectTraceInterface, count: number) {
+  (mockedTrace as jest.Mocked<PublicSideEffectTraceInterface>).getNoteHashCount.mockReturnValue(count);
+}
+
 export function mockStorageReadWithMap(worldStateDB: WorldStateDB, mockedStorage: Map<bigint, Fr>) {
   (worldStateDB as jest.Mocked<WorldStateDB>).storageRead.mockImplementation((_address, slot) =>
     Promise.resolve(mockedStorage.get(slot.toBigInt()) ?? Fr.ZERO),

package/src/client/client_execution_context.ts

@@ -11,9 +11,9 @@ import {
   type UnencryptedL2Log,
 } from '@aztec/circuit-types';
 import {
+  type BlockHeader,
   CallContext,
   FunctionSelector,
-  type Header,
   PRIVATE_CONTEXT_INPUTS_LENGTH,
   PUBLIC_DISPATCH_SELECTOR,
   PrivateContextInputs,
@@ -23,7 +23,7 @@ import { computeUniqueNoteHash, siloNoteHash } from '@aztec/circuits.js/hash';
 import { type FunctionAbi, type FunctionArtifact, type NoteSelector, countArgumentsSize } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
-import { applyStringFormatting, createDebugLogger } from '@aztec/foundation/log';
+import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
 
 import { type NoteData, toACVMWitness } from '../acvm/index.js';
 import { type PackedValuesCache } from '../common/packed_values_cache.js';
@@ -66,7 +66,7 @@ export class ClientExecutionContext extends ViewDataOracle {
     private readonly txContext: TxContext,
     private readonly callContext: CallContext,
     /** Header of a block whose state is used during private execution (not the block the transaction is included in). */
-    protected readonly historicalHeader: Header,
+    protected readonly historicalHeader: BlockHeader,
     /** List of transient auth witnesses to be used during this simulation */
     authWitnesses: AuthWitness[],
     private readonly packedValuesCache: PackedValuesCache,
@@ -74,7 +74,7 @@ export class ClientExecutionContext extends ViewDataOracle {
     db: DBOracle,
     private node: AztecNode,
     protected sideEffectCounter: number = 0,
-    log = createDebugLogger('aztec:simulator:client_execution_context'),
+    log = createLogger('simulator:client_execution_context'),
     scopes?: AztecAddress[],
   ) {
     super(callContext.contractAddress, authWitnesses, db, node, log, scopes);
@@ -247,9 +247,10 @@ export class ClientExecutionContext extends ViewDataOracle {
 
     notes.forEach(n => {
       if (n.index !== undefined) {
-        const uniqueNoteHash = computeUniqueNoteHash(n.nonce, n.noteHash);
-        const siloedNoteHash = siloNoteHash(n.contractAddress, uniqueNoteHash);
-        this.noteHashLeafIndexMap.set(siloedNoteHash.toBigInt(), n.index);
+        const siloedNoteHash = siloNoteHash(n.contractAddress, n.noteHash);
+        const uniqueNoteHash = computeUniqueNoteHash(n.nonce, siloedNoteHash);
+
+        this.noteHashLeafIndexMap.set(uniqueNoteHash.toBigInt(), n.index);
       }
     });
 
@@ -419,7 +420,14 @@ export class ClientExecutionContext extends ViewDataOracle {
     const args = this.packedValuesCache.unpack(argsHash);
 
     this.log.verbose(
-      `Created PublicExecutionRequest to ${targetArtifact.name}@${targetContractAddress}, of type [${callType}], side-effect counter [${sideEffectCounter}]`,
+      `Created ${callType} public execution request to ${targetArtifact.name}@${targetContractAddress}`,
+      {
+        sideEffectCounter,
+        isStaticCall,
+        functionSelector,
+        targetContractAddress,
+        callType,
+      },
     );
 
     const request = PublicExecutionRequest.from({
@@ -537,7 +545,7 @@ export class ClientExecutionContext extends ViewDataOracle {
   }
 
   public override debugLog(message: string, fields: Fr[]) {
-    this.log.verbose(`debug_log ${applyStringFormatting(message, fields)}`);
+    this.log.verbose(`${applyStringFormatting(message, fields)}`, { module: `${this.log.module}:debug_log` });
   }
 
   public getDebugFunctionName() {
@@ -557,5 +565,7 @@ export class ClientExecutionContext extends ViewDataOracle {
     for (const [recipient, taggedLogs] of taggedLogsByRecipient.entries()) {
       await this.db.processTaggedLogs(taggedLogs, AztecAddress.fromString(recipient));
     }
+
+    await this.db.removeNullifiedNotes(this.contractAddress);
   }
 }

package/src/client/db_oracle.ts

@@ -8,9 +8,9 @@ import {
   type TxScopedL2Log,
 } from '@aztec/circuit-types';
 import {
+  type BlockHeader,
   type CompleteAddress,
   type ContractInstance,
-  type Header,
   type IndexedTaggingSecret,
   type KeyValidationRequest,
 } from '@aztec/circuits.js';
@@ -138,7 +138,7 @@ export interface DBOracle extends CommitmentsDB {
    *
    * @returns A Promise that resolves to a Header object.
    */
-  getHeader(): Promise<Header>;
+  getBlockHeader(): Promise<BlockHeader>;
 
   /**
    * Fetch the index of the leaf in the respective tree
@@ -198,21 +198,21 @@ export interface DBOracle extends CommitmentsDB {
   getBlockNumber(): Promise<number>;
 
   /**
-   * Returns the tagging secret for a given sender and recipient pair. For this to work, the ivpsk_m of the sender must be known.
+   * Returns the tagging secret for a given sender and recipient pair. For this to work, the ivsk_m of the sender must be known.
    * Includes the next index to be used used for tagging with this secret.
    * @param contractAddress - The contract address to silo the secret for
    * @param sender - The address sending the note
    * @param recipient - The address receiving the note
    * @returns A tagging secret that can be used to tag notes.
    */
-  getAppTaggingSecretAsSender(
+  getIndexedTaggingSecretAsSender(
     contractAddress: AztecAddress,
     sender: AztecAddress,
     recipient: AztecAddress,
   ): Promise<IndexedTaggingSecret>;
 
   /**
-   * Increments the tagging secret for a given sender and recipient pair. For this to work, the ivpsk_m of the sender must be known.
+   * Increments the tagging secret for a given sender and recipient pair. For this to work, the ivsk_m of the sender must be known.
    * @param contractAddress - The contract address to silo the secret for
    * @param sender - The address sending the note
    * @param recipient - The address receiving the note
@@ -242,4 +242,9 @@ export interface DBOracle extends CommitmentsDB {
    * @param recipient - The recipient of the logs.
    */
   processTaggedLogs(logs: TxScopedL2Log[], recipient: AztecAddress): Promise<void>;
+
+  /**
+   * Removes all of a contract's notes that have been nullified from the note database.
+   */
+  removeNullifiedNotes(contractAddress: AztecAddress): Promise<void>;
 }

package/src/client/execution_note_cache.ts

@@ -1,6 +1,6 @@
 import { computeNoteHashNonce, computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/circuits.js/hash';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
-import { type Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/fields';
 
 import { type NoteData } from '../acvm/index.js';
 
@@ -51,11 +51,11 @@ export class ExecutionNoteCache {
     // The nonces will be used to create the "complete" nullifier.
     const updatedNotes = this.notes.map(({ note, counter }, i) => {
       const nonce = computeNoteHashNonce(this.txHash, i);
-      const uniqueNoteHash = computeUniqueNoteHash(nonce, note.noteHash);
+      const uniqueNoteHash = computeUniqueNoteHash(nonce, siloNoteHash(note.contractAddress, note.noteHash));
       return {
         counter,
         note: { ...note, nonce },
-        noteHashForConsumption: siloNoteHash(note.contractAddress, uniqueNoteHash),
+        noteHashForConsumption: uniqueNoteHash,
       };
     });
     // Rebuild the data.
@@ -146,4 +146,14 @@ export class ExecutionNoteCache {
     notes.push(note);
     this.noteMap.set(note.note.contractAddress.toBigInt(), notes);
   }
+
+  getAllNotes(): PendingNote[] {
+    return this.notes;
+  }
+
+  getAllNullifiers(): Fr[] {
+    return [...this.nullifierMap.values()].flatMap(nullifierArray =>
+      [...nullifierArray.values()].map(val => new Fr(val)),
+    );
+  }
 }

package/src/client/index.ts

@@ -3,3 +3,4 @@ export * from './db_oracle.js';
 export * from './pick_notes.js';
 export * from './execution_note_cache.js';
 export { extractPrivateCircuitPublicInputs } from './private_execution.js';
+export { WASMSimulator } from '../providers/acvm_wasm.js';

package/src/client/private_execution.ts

@@ -8,7 +8,7 @@ import {
 } from '@aztec/circuits.js';
 import { type FunctionArtifact, type FunctionSelector, countArgumentsSize } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 
 import { fromACVMField, witnessMapToFields } from '../acvm/deserialize.js';
@@ -24,10 +24,10 @@ export async function executePrivateFunction(
   artifact: FunctionArtifact,
   contractAddress: AztecAddress,
   functionSelector: FunctionSelector,
-  log = createDebugLogger('aztec:simulator:private_execution'),
+  log = createLogger('simulator:private_execution'),
 ): Promise<PrivateExecutionResult> {
   const functionName = await context.getDebugFunctionName();
-  log.verbose(`Executing external function ${functionName}@${contractAddress}`);
+  log.verbose(`Executing private function ${functionName}@${contractAddress}`);
   const acir = artifact.bytecode;
   const initialWitness = context.getInitialWitness(artifact);
   const acvmCallback = new Oracle(context);

package/src/client/simulator.ts

@@ -10,7 +10,7 @@ import {
 } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
-import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
+import { type Logger, createLogger } from '@aztec/foundation/log';
 
 import { createSimulationError } from '../common/errors.js';
 import { PackedValuesCache } from '../common/packed_values_cache.js';
@@ -25,10 +25,10 @@ import { ViewDataOracle } from './view_data_oracle.js';
  * The ACIR simulator.
  */
 export class AcirSimulator {
-  private log: DebugLogger;
+  private log: Logger;
 
   constructor(private db: DBOracle, private node: AztecNode) {
-    this.log = createDebugLogger('aztec:simulator');
+    this.log = createLogger('simulator');
   }
 
   /**
@@ -57,7 +57,7 @@ export class AcirSimulator {
       );
     }
 
-    const header = await this.db.getHeader();
+    const header = await this.db.getBlockHeader();
 
     // reserve the first side effect for the tx hash (inserted by the private kernel)
     const startSideEffectCounter = 1;

package/src/client/unconstrained_execution.ts

@@ -1,7 +1,7 @@
 import { type AbiDecoded, type FunctionArtifact, type FunctionSelector, decodeFromAbi } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { type Fr } from '@aztec/foundation/fields';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 
 import { witnessMapToFields } from '../acvm/deserialize.js';
 import { Oracle, acvm, extractCallStack, toACVMWitness } from '../acvm/index.js';
@@ -18,7 +18,7 @@ export async function executeUnconstrainedFunction(
   contractAddress: AztecAddress,
   functionSelector: FunctionSelector,
   args: Fr[],
-  log = createDebugLogger('aztec:simulator:unconstrained_execution'),
+  log = createLogger('simulator:unconstrained_execution'),
 ): Promise<AbiDecoded> {
   log.verbose(`Executing unconstrained function ${contractAddress}:${functionSelector}(${artifact.name})`);
 

package/src/client/view_data_oracle.ts

@@ -8,15 +8,15 @@ import {
   type PublicDataWitness,
 } from '@aztec/circuit-types';
 import {
+  type BlockHeader,
   type ContractInstance,
-  type Header,
   type IndexedTaggingSecret,
   type KeyValidationRequest,
 } from '@aztec/circuits.js';
 import { siloNullifier } from '@aztec/circuits.js/hash';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
-import { applyStringFormatting, createDebugLogger } from '@aztec/foundation/log';
+import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
 
 import { type NoteData, TypedOracle } from '../acvm/index.js';
 import { type DBOracle } from './db_oracle.js';
@@ -33,7 +33,7 @@ export class ViewDataOracle extends TypedOracle {
     protected readonly authWitnesses: AuthWitness[],
     protected readonly db: DBOracle,
     protected readonly aztecNode: AztecNode,
-    protected log = createDebugLogger('aztec:simulator:client_view_context'),
+    protected log = createLogger('simulator:client_view_context'),
     protected readonly scopes?: AztecAddress[],
   ) {
     super();
@@ -139,7 +139,7 @@ export class ViewDataOracle extends TypedOracle {
    * @param blockNumber - The number of a block of which to get the block header.
    * @returns Block extracted from a block with block number `blockNumber`.
    */
-  public override async getHeader(blockNumber: number): Promise<Header | undefined> {
+  public override async getBlockHeader(blockNumber: number): Promise<BlockHeader | undefined> {
     const block = await this.db.getBlock(blockNumber);
     if (!block) {
       return undefined;
@@ -290,23 +290,22 @@ export class ViewDataOracle extends TypedOracle {
   }
 
   public override debugLog(message: string, fields: Fr[]): void {
-    const formattedStr = applyStringFormatting(message, fields);
-    this.log.verbose(`debug_log ${formattedStr}`);
+    this.log.verbose(`${applyStringFormatting(message, fields)}`, { module: `${this.log.module}:debug_log` });
   }
 
   /**
    * Returns the tagging secret for a given sender and recipient pair, siloed to the current contract address.
    * Includes the next index to be used used for tagging with this secret.
-   * For this to work, the ivpsk_m of the sender must be known.
+   * For this to work, the ivsk_m of the sender must be known.
    * @param sender - The address sending the note
    * @param recipient - The address receiving the note
    * @returns A tagging secret that can be used to tag notes.
    */
-  public override async getAppTaggingSecretAsSender(
+  public override async getIndexedTaggingSecretAsSender(
     sender: AztecAddress,
     recipient: AztecAddress,
   ): Promise<IndexedTaggingSecret> {
-    return await this.db.getAppTaggingSecretAsSender(this.contractAddress, sender, recipient);
+    return await this.db.getIndexedTaggingSecretAsSender(this.contractAddress, sender, recipient);
   }
 
   public override async syncNotes() {
@@ -315,8 +314,11 @@ export class ViewDataOracle extends TypedOracle {
       await this.aztecNode.getBlockNumber(),
       this.scopes,
     );
+
     for (const [recipient, taggedLogs] of taggedLogsByRecipient.entries()) {
       await this.db.processTaggedLogs(taggedLogs, AztecAddress.fromString(recipient));
     }
+
+    await this.db.removeNullifiedNotes(this.contractAddress);
   }
 }

package/src/common/debug_fn_name.ts

@@ -1,22 +1,16 @@
-import { type AztecAddress, Fr, FunctionSelector, PUBLIC_DISPATCH_SELECTOR } from '@aztec/circuits.js';
+import { type AztecAddress, type Fr, FunctionSelector } from '@aztec/circuits.js';
 
 import { type WorldStateDB } from '../public/public_db_sources.js';
 
 export async function getPublicFunctionDebugName(
   db: WorldStateDB,
   contractAddress: AztecAddress,
-  fn: FunctionSelector,
   calldata: Fr[],
 ): Promise<string> {
-  if (fn.equals(FunctionSelector.fromField(new Fr(PUBLIC_DISPATCH_SELECTOR)))) {
-    // If the function is a dispatch, we need to look up the target function which
-    // is expected to be the first argument.
-    const targetFunction =
-      calldata[0] !== undefined
-        ? await db.getDebugFunctionName(contractAddress, FunctionSelector.fromField(calldata[0]))
-        : `<calldata[0] undefined>`;
-    return `${targetFunction} (via dispatch)`;
-  } else {
-    return (await db.getDebugFunctionName(contractAddress, fn)) ?? `${contractAddress}:${fn}`;
-  }
+  // Public function is dispatched and therefore the target function is passed in the first argument.
+  const targetFunction =
+    calldata[0] !== undefined
+      ? await db.getDebugFunctionName(contractAddress, FunctionSelector.fromField(calldata[0]))
+      : `<calldata[0] undefined> (Contract Address: ${contractAddress})`;
+  return `${targetFunction}`;
 }

package/src/providers/acvm_native.ts

@@ -1,15 +1,15 @@
 import { runInDirectory } from '@aztec/foundation/fs';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import { type NoirCompiledCircuit } from '@aztec/types/noir';
 
 import { type WitnessMap } from '@noir-lang/types';
 import * as proc from 'child_process';
-import fs from 'fs/promises';
+import { promises as fs } from 'fs';
 
 import { type SimulationProvider } from './simulation_provider.js';
 
-const logger = createDebugLogger('aztec:acvm-native');
+const logger = createLogger('simulator:acvm-native');
 
 export enum ACVM_RESULT {
   SUCCESS,

package/src/providers/acvm_wasm.ts

@@ -1,4 +1,4 @@
-import { foreignCallHandler } from '@aztec/noir-protocol-circuits-types';
+import { foreignCallHandler } from '@aztec/noir-protocol-circuits-types/client';
 import { type NoirCompiledCircuit } from '@aztec/types/noir';
 
 import { executeCircuit } from '@noir-lang/acvm_js';
@@ -17,7 +17,7 @@ export class WASMSimulator implements SimulationProvider {
     const _witnessMap = await executeCircuit(
       decodedBytecode,
       input,
-      foreignCallHandler, // handle calls to debug_log
+      foreignCallHandler, // handle calls to debug_log and evaluate_blobs mock
     );
 
     return _witnessMap;

package/src/providers/factory.ts

@@ -1,6 +1,6 @@
-import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
+import { type Logger, createLogger } from '@aztec/foundation/log';
 
-import * as fs from 'fs/promises';
+import { promises as fs } from 'fs';
 
 import { NativeACVMSimulator } from './acvm_native.js';
 import { WASMSimulator } from './acvm_wasm.js';
@@ -21,7 +21,7 @@ export function getSimulationProviderConfigFromEnv() {
 
 export async function createSimulationProvider(
   config: SimulationProviderConfig,
-  logger: DebugLogger = createDebugLogger('aztec:simulator'),
+  logger: Logger = createLogger('simulator'),
 ): Promise<SimulationProvider> {
   if (config.acvmBinaryPath && config.acvmWorkingDirectory) {
     try {

package/src/providers/index.ts

@@ -1,4 +1,3 @@
 export * from './acvm_native.js';
-export * from './acvm_wasm.js';
 export * from './simulation_provider.js';
 export * from './factory.js';