@aztec/simulator 0.33.0 → 0.34.0

package/src/avm/journal/trace.ts

@@ -1,23 +1,28 @@
 import { Fr } from '@aztec/foundation/fields';
 
-import { type TracedL1toL2MessageCheck, type TracedNoteHashCheck, type TracedNullifierCheck } from './trace_types.js';
+import {
+  type TracedL1toL2MessageCheck,
+  type TracedNoteHash,
+  type TracedNoteHashCheck,
+  type TracedNullifier,
+  type TracedNullifierCheck,
+  type TracedPublicStorageRead,
+  type TracedPublicStorageWrite,
+} from './trace_types.js';
 
 export class WorldStateAccessTrace {
   public accessCounter: number;
-  //public contractCalls: Array<TracedContractCall> = [];
 
-  //public publicStorageReads: Array<TracedPublicStorageRead> = [];
-  public publicStorageReads: Map<bigint, Map<bigint, Fr[]>> = new Map();
-  //public publicStorageWrites: Array<TracedPublicStorageWrite> = [];
-  public publicStorageWrites: Map<bigint, Map<bigint, Fr[]>> = new Map();
+  public publicStorageReads: TracedPublicStorageRead[] = [];
+  public publicStorageWrites: TracedPublicStorageWrite[] = [];
 
   public noteHashChecks: TracedNoteHashCheck[] = [];
-  //public newNoteHashes: TracedNoteHash[] = [];
-  public newNoteHashes: Fr[] = [];
+  public newNoteHashes: TracedNoteHash[] = [];
   public nullifierChecks: TracedNullifierCheck[] = [];
-  //public newNullifiers: TracedNullifier[] = [];
-  public newNullifiers: Fr[] = [];
+  public newNullifiers: TracedNullifier[] = [];
   public l1ToL2MessageChecks: TracedL1toL2MessageCheck[] = [];
+
+  //public contractCalls: TracedContractCall[] = [];
   //public archiveChecks: TracedArchiveLeafCheck[] = [];
 
   constructor(parentTrace?: WorldStateAccessTrace) {
@@ -28,76 +33,73 @@ export class WorldStateAccessTrace {
     return this.accessCounter;
   }
 
-  public tracePublicStorageRead(storageAddress: Fr, slot: Fr, value: Fr /*, _exists: boolean*/) {
+  public tracePublicStorageRead(storageAddress: Fr, slot: Fr, value: Fr, exists: boolean) {
     // TODO(4805): check if some threshold is reached for max storage reads
     // (need access to parent length, or trace needs to be initialized with parent's contents)
-    //const traced: TracedPublicStorageRead = {
-    //  callPointer: Fr.ZERO,
-    //  storageAddress,
-    //  slot,
-    //  value,
-    //  exists,
-    //  counter: new Fr(this.accessCounter),
-    //  endLifetime: Fr.ZERO,
-    //};
-    //this.publicStorageReads.push(traced);
-    this.journalRead(storageAddress, slot, value);
+    const traced: TracedPublicStorageRead = {
+      //  callPointer: Fr.ZERO,
+      storageAddress,
+      slot,
+      value,
+      exists,
+      counter: new Fr(this.accessCounter),
+      //  endLifetime: Fr.ZERO,
+    };
+    this.publicStorageReads.push(traced);
     this.incrementAccessCounter();
   }
 
   public tracePublicStorageWrite(storageAddress: Fr, slot: Fr, value: Fr) {
     // TODO(4805): check if some threshold is reached for max storage writes
     // (need access to parent length, or trace needs to be initialized with parent's contents)
-    //const traced: TracedPublicStorageWrite = {
-    //  callPointer: Fr.ZERO,
-    //  storageAddress,
-    //  slot,
-    //  value,
-    //  counter: new Fr(this.accessCounter),
-    //  endLifetime: Fr.ZERO,
-    //};
-    //this.publicStorageWrites.push(traced);
-    this.journalWrite(storageAddress, slot, value);
+    const traced: TracedPublicStorageWrite = {
+      //  callPointer: Fr.ZERO,
+      storageAddress,
+      slot,
+      value,
+      counter: new Fr(this.accessCounter),
+      //  endLifetime: Fr.ZERO,
+    };
+    this.publicStorageWrites.push(traced);
     this.incrementAccessCounter();
   }
 
   public traceNoteHashCheck(storageAddress: Fr, noteHash: Fr, exists: boolean, leafIndex: Fr) {
     const traced: TracedNoteHashCheck = {
-      callPointer: Fr.ZERO, // FIXME
+      // callPointer: Fr.ZERO,
       storageAddress,
       noteHash,
       exists,
       counter: new Fr(this.accessCounter),
-      endLifetime: Fr.ZERO,
+      // endLifetime: Fr.ZERO,
       leafIndex,
     };
     this.noteHashChecks.push(traced);
     this.incrementAccessCounter();
   }
 
-  public traceNewNoteHash(_storageAddress: Fr, noteHash: Fr) {
+  public traceNewNoteHash(storageAddress: Fr, noteHash: Fr) {
     // TODO(4805): check if some threshold is reached for max new note hash
-    //const traced: TracedNoteHash = {
-    //  callPointer: Fr.ZERO,
-    //  storageAddress,
-    //  noteHash,
-    //  counter: new Fr(this.accessCounter),
-    //  endLifetime: Fr.ZERO,
-    //};
-    //this.newNoteHashes.push(traced);
-    this.newNoteHashes.push(noteHash);
+    const traced: TracedNoteHash = {
+      //  callPointer: Fr.ZERO,
+      storageAddress,
+      noteHash,
+      counter: new Fr(this.accessCounter),
+      //  endLifetime: Fr.ZERO,
+    };
+    this.newNoteHashes.push(traced);
     this.incrementAccessCounter();
   }
 
   public traceNullifierCheck(storageAddress: Fr, nullifier: Fr, exists: boolean, isPending: boolean, leafIndex: Fr) {
     // TODO(4805): check if some threshold is reached for max new nullifier
     const traced: TracedNullifierCheck = {
-      callPointer: Fr.ZERO, // FIXME
+      // callPointer: Fr.ZERO,
       storageAddress,
       nullifier,
       exists,
       counter: new Fr(this.accessCounter),
-      endLifetime: Fr.ZERO,
+      // endLifetime: Fr.ZERO,
       isPending,
       leafIndex,
     };
@@ -105,17 +107,16 @@ export class WorldStateAccessTrace {
     this.incrementAccessCounter();
   }
 
-  public traceNewNullifier(_storageAddress: Fr, nullifier: Fr) {
+  public traceNewNullifier(storageAddress: Fr, nullifier: Fr) {
     // TODO(4805): check if some threshold is reached for max new nullifier
-    //const traced: TracedNullifier = {
-    //  callPointer: Fr.ZERO,
-    //  storageAddress,
-    //  nullifier,
-    //  counter: new Fr(this.accessCounter),
-    //  endLifetime: Fr.ZERO,
-    //};
-    //this.newNullifiers.push(traced);
-    this.newNullifiers.push(nullifier);
+    const tracedNullifier: TracedNullifier = {
+      // callPointer: Fr.ZERO,
+      storageAddress,
+      nullifier,
+      counter: new Fr(this.accessCounter),
+      // endLifetime: Fr.ZERO,
+    };
+    this.newNullifiers.push(tracedNullifier);
     this.incrementAccessCounter();
   }
 
@@ -146,8 +147,8 @@ export class WorldStateAccessTrace {
    */
   public acceptAndMerge(incomingTrace: WorldStateAccessTrace) {
     // Merge storage read and write journals
-    mergeContractJournalMaps(this.publicStorageReads, incomingTrace.publicStorageReads);
-    mergeContractJournalMaps(this.publicStorageWrites, incomingTrace.publicStorageWrites);
+    this.publicStorageReads = this.publicStorageReads.concat(incomingTrace.publicStorageReads);
+    this.publicStorageWrites = this.publicStorageWrites.concat(incomingTrace.publicStorageWrites);
     // Merge new note hashes and nullifiers
     this.noteHashChecks = this.noteHashChecks.concat(incomingTrace.noteHashChecks);
     this.newNoteHashes = this.newNoteHashes.concat(incomingTrace.newNoteHashes);
@@ -157,67 +158,4 @@ export class WorldStateAccessTrace {
     // it is assumed that the incoming trace was initialized with this as parent, so accept counter
     this.accessCounter = incomingTrace.accessCounter;
   }
-
-  /**
-   * We want to keep track of all performed reads in the journal
-   * This information is hinted to the avm circuit
-
-   * @param contractAddress -
-   * @param key -
-   * @param value -
-   */
-  journalUpdate(map: Map<bigint, Map<bigint, Fr[]>>, contractAddress: Fr, key: Fr, value: Fr): void {
-    let contractMap = map.get(contractAddress.toBigInt());
-    if (!contractMap) {
-      contractMap = new Map<bigint, Array<Fr>>();
-      map.set(contractAddress.toBigInt(), contractMap);
-    }
-
-    let accessArray = contractMap.get(key.toBigInt());
-    if (!accessArray) {
-      accessArray = new Array<Fr>();
-      contractMap.set(key.toBigInt(), accessArray);
-    }
-    accessArray.push(value);
-  }
-
-  // Create an instance of journalUpdate that appends to the read array
-  private journalRead = this.journalUpdate.bind(this, this.publicStorageReads);
-  // Create an instance of journalUpdate that appends to the writes array
-  private journalWrite = this.journalUpdate.bind(this, this.publicStorageWrites);
-}
-
-/**
- * Merges two contract journalling maps together
- * For read maps, we just append the childMap arrays into the host map arrays, as the order is important
- *
- * @param hostMap - The map to be merged into
- * @param childMap - The map to be merged from
- */
-function mergeContractJournalMaps(hostMap: Map<bigint, Map<bigint, Fr[]>>, childMap: Map<bigint, Map<bigint, Fr[]>>) {
-  for (const [key, value] of childMap) {
-    const map1Value = hostMap.get(key);
-    if (!map1Value) {
-      hostMap.set(key, value);
-    } else {
-      mergeStorageJournalMaps(map1Value, value);
-    }
-  }
-}
-
-/**
- * Merge two storage journalling maps together (for a particular contract).
- *
- * @param hostMap - The map to be merge into
- * @param childMap - The map to be merged from
- */
-function mergeStorageJournalMaps(hostMap: Map<bigint, Fr[]>, childMap: Map<bigint, Fr[]>) {
-  for (const [key, value] of childMap) {
-    const readArr = hostMap.get(key);
-    if (!readArr) {
-      hostMap.set(key, value);
-    } else {
-      hostMap.set(key, readArr?.concat(...value));
-    }
-  }
 }

package/src/avm/journal/trace_types.ts

@@ -6,64 +6,64 @@ import { type Fr } from '@aztec/foundation/fields';
 //  storageAddress: Fr;
 //  endLifetime: Fr;
 //};
-//
-//export type TracedPublicStorageRead = {
-//  callPointer: Fr;
-//  storageAddress: Fr;
-//  exists: boolean;
-//  slot: Fr;
-//  value: Fr;
-//  counter: Fr;
-//  endLifetime: Fr;
-//};
-//
-//export type TracedPublicStorageWrite = {
-//  callPointer: Fr;
-//  storageAddress: Fr;
-//  slot: Fr;
-//  value: Fr;
-//  counter: Fr;
-//  endLifetime: Fr;
-//};
-//
+
+export type TracedPublicStorageRead = {
+  //  callPointer: Fr;
+  storageAddress: Fr;
+  exists: boolean;
+  slot: Fr;
+  value: Fr;
+  counter: Fr;
+  //  endLifetime: Fr;
+};
+
+export type TracedPublicStorageWrite = {
+  //  callPointer: Fr;
+  storageAddress: Fr;
+  slot: Fr;
+  value: Fr;
+  counter: Fr;
+  //  endLifetime: Fr;
+};
+
 export type TracedNoteHashCheck = {
-  callPointer: Fr;
+  // callPointer: Fr;
   storageAddress: Fr;
   leafIndex: Fr;
   noteHash: Fr;
   exists: boolean;
   counter: Fr;
-  endLifetime: Fr;
+  // endLifetime: Fr;
+};
+
+export type TracedNoteHash = {
+  //  callPointer: Fr;
+  storageAddress: Fr;
+  noteHash: Fr;
+  counter: Fr;
+  //  endLifetime: Fr;
 };
-//
-//export type TracedNoteHash = {
-//  callPointer: Fr;
-//  storageAddress: Fr;
-//  noteHash: Fr;
-//  counter: Fr;
-//  endLifetime: Fr;
-//};
 
 export type TracedNullifierCheck = {
-  callPointer: Fr;
+  // callPointer: Fr;
   storageAddress: Fr;
   nullifier: Fr;
   exists: boolean;
   counter: Fr;
-  endLifetime: Fr;
+  // endLifetime: Fr;
   // the fields below are relevant only to the public kernel
   // and are therefore omitted from VM inputs
   isPending: boolean;
   leafIndex: Fr;
 };
 
-//export type TracedNullifier = {
-//  callPointer: Fr;
-//  storageAddress: Fr;
-//  nullifier: Fr;
-//  counter: Fr;
-//  endLifetime: Fr;
-//};
+export type TracedNullifier = {
+  // callPointer: Fr;
+  storageAddress: Fr;
+  nullifier: Fr;
+  counter: Fr;
+  // endLifetime: Fr;
+};
 
 export type TracedL1toL2MessageCheck = {
   //callPointer: Fr;

package/src/avm/opcodes/accrued_substate.ts

@@ -69,7 +69,7 @@ export class EmitNoteHash extends Instruction {
     }
 
     const noteHash = memory.get(this.noteHashOffset).toFr();
-    context.persistableState.writeNoteHash(noteHash);
+    context.persistableState.writeNoteHash(context.environment.storageAddress, noteHash);
 
     memory.assert(memoryOperations);
     context.machineState.incrementPc();

package/src/avm/opcodes/external_calls.ts

@@ -1,10 +1,16 @@
 import { FunctionSelector } from '@aztec/circuits.js';
 import { padArrayEnd } from '@aztec/foundation/collection';
 
+import { executePublicFunction } from '../../public/executor.js';
+import {
+  convertPublicExecutionResult,
+  createPublicExecutionContext,
+  updateAvmContextFromPublicExecutionResult,
+} from '../../public/transitional_adaptors.js';
 import type { AvmContext } from '../avm_context.js';
 import { gasLeftToGas, sumGas } from '../avm_gas.js';
 import { Field, Uint8 } from '../avm_memory_types.js';
-import { AvmSimulator } from '../avm_simulator.js';
+import { type AvmContractCallResults } from '../avm_message_call_result.js';
 import { Opcode, OperandType } from '../serialization/instruction_serialization.js';
 import { Addressing } from './addressing_mode.js';
 import { Instruction } from './instruction.js';
@@ -61,6 +67,7 @@ abstract class ExternalCall extends Instruction {
     const totalGas = sumGas(this.gasCost(memoryOperations), allocatedGas);
     context.machineState.consumeGas(totalGas);
 
+    // TRANSITIONAL: This should be removed once the AVM is fully operational and the public executor is gone.
     const nestedContext = context.createNestedContractCallContext(
       callAddress.toFr(),
       calldata,
@@ -68,8 +75,21 @@ abstract class ExternalCall extends Instruction {
       this.type,
       FunctionSelector.fromField(functionSelector),
     );
+    const pxContext = createPublicExecutionContext(nestedContext, calldata);
+    const pxResults = await executePublicFunction(pxContext, /*nested=*/ true);
+    const nestedCallResults: AvmContractCallResults = convertPublicExecutionResult(pxResults);
+    updateAvmContextFromPublicExecutionResult(nestedContext, pxResults);
+    const nestedPersistableState = nestedContext.persistableState;
+    // const nestedContext = context.createNestedContractCallContext(
+    //   callAddress.toFr(),
+    //   calldata,
+    //   allocatedGas,
+    //   this.type,
+    //   FunctionSelector.fromField(functionSelector),
+    // );
+    // const nestedCallResults: AvmContractCallResults = await new AvmSimulator(nestedContext).execute();
+    // const nestedPersistableState = nestedContext.persistableState;
 
-    const nestedCallResults = await new AvmSimulator(nestedContext).execute();
     const success = !nestedCallResults.reverted;
 
     // We only take as much data as was specified in the return size and pad with zeroes if the return data is smaller
@@ -90,9 +110,9 @@ abstract class ExternalCall extends Instruction {
 
     // TODO: Should we merge the changes from a nested call in the case of a STATIC call?
     if (success) {
-      context.persistableState.acceptNestedCallState(nestedContext.persistableState);
+      context.persistableState.acceptNestedCallState(nestedPersistableState);
     } else {
-      context.persistableState.rejectNestedCallState(nestedContext.persistableState);
+      context.persistableState.rejectNestedCallState(nestedPersistableState);
     }
 
     memory.assert(memoryOperations);

package/src/client/client_execution_context.ts

@@ -235,7 +235,7 @@ export class ClientExecutionContext extends ViewDataOracle {
       offset,
     });
 
-    this.log(
+    this.log.debug(
       `Returning ${notes.length} notes for ${this.callContext.storageContractAddress} at ${storageSlot}: ${notes
         .map(n => `${n.nonce.toString()}:[${n.note.items.map(i => i.toString()).join(',')}]`)
         .join(', ')}`,
@@ -316,7 +316,7 @@ export class ClientExecutionContext extends ViewDataOracle {
   public emitUnencryptedLog(log: UnencryptedL2Log) {
     this.unencryptedLogs.push(log);
     const text = log.toHumanReadable();
-    this.log(`Emitted unencrypted log: "${text.length > 100 ? text.slice(0, 100) + '...' : text}"`);
+    this.log.verbose(`Emitted unencrypted log: "${text.length > 100 ? text.slice(0, 100) + '...' : text}"`);
   }
 
   #checkValidStaticCall(childExecutionResult: ExecutionResult) {
@@ -349,7 +349,7 @@ export class ClientExecutionContext extends ViewDataOracle {
     isStaticCall: boolean,
     isDelegateCall: boolean,
   ) {
-    this.log(
+    this.log.debug(
       `Calling private function ${this.contractAddress}:${functionSelector} from ${this.callContext.storageContractAddress}`,
     );
 
@@ -441,7 +441,7 @@ export class ClientExecutionContext extends ViewDataOracle {
     // side-effect counter, that will leak info about how many other private
     // side-effects occurred in the TX. Ultimately the private kernel should
     // just output everything in the proper order without any counters.
-    this.log(
+    this.log.verbose(
       `Enqueued call to public function (with side-effect counter #${sideEffectCounter}) ${targetContractAddress}:${functionSelector}(${targetArtifact.name})`,
     );
 
@@ -497,7 +497,7 @@ export class ClientExecutionContext extends ViewDataOracle {
         throw new Error(`No witness for slot ${storageSlot.toString()}`);
       }
       const value = witness.leafPreimage.value;
-      this.log(`Oracle storage read: slot=${storageSlot.toString()} value=${value}`);
+      this.log.debug(`Oracle storage read: slot=${storageSlot.toString()} value=${value}`);
       values.push(value);
     }
     return values;

package/src/client/private_execution.ts

@@ -22,7 +22,7 @@ export async function executePrivateFunction(
   log = createDebugLogger('aztec:simulator:secret_execution'),
 ): Promise<ExecutionResult> {
   const functionSelector = functionData.selector;
-  log(`Executing external function ${contractAddress}:${functionSelector}(${artifact.name})`);
+  log.verbose(`Executing external function ${contractAddress}:${functionSelector}(${artifact.name})`);
   const acir = artifact.bytecode;
   const initialWitness = context.getInitialWitness(artifact);
   const acvmCallback = new Oracle(context);
@@ -66,7 +66,7 @@ export async function executePrivateFunction(
   const nestedExecutions = context.getNestedExecutions();
   const enqueuedPublicFunctionCalls = context.getEnqueuedPublicFunctionCalls();
 
-  log(`Returning from call to ${contractAddress.toString()}:${functionSelector}`);
+  log.debug(`Returning from call to ${contractAddress.toString()}:${functionSelector}`);
 
   return {
     acir,

package/src/client/unconstrained_execution.ts

@@ -23,7 +23,7 @@ export async function executeUnconstrainedFunction(
   log = createDebugLogger('aztec:simulator:unconstrained_execution'),
 ): Promise<DecodedReturn> {
   const functionSelector = functionData.selector;
-  log(`Executing unconstrained function ${contractAddress}:${functionSelector}`);
+  log.verbose(`Executing unconstrained function ${contractAddress}:${functionSelector}(${artifact.name})`);
 
   const acir = artifact.bytecode;
   const initialWitness = toACVMWitness(0, args);

package/src/client/view_data_oracle.ts

@@ -257,7 +257,7 @@ export class ViewDataOracle extends TypedOracle {
       const storageSlot = new Fr(startStorageSlot.value + i);
       const value = await this.aztecNode.getPublicStorageAt(this.contractAddress, storageSlot);
 
-      this.log(`Oracle storage read: slot=${storageSlot.toString()} value=${value}`);
+      this.log.debug(`Oracle storage read: slot=${storageSlot.toString()} value=${value}`);
       values.push(value);
     }
     return values;