@aztec/simulator 0.62.0 → 0.63.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/simulator",
-  "version": "0.62.0",
+  "version": "0.63.1",
   "type": "module",
   "exports": {
     ".": "./dest/index.js",
@@ -59,17 +59,19 @@
     ]
   },
   "dependencies": {
-    "@aztec/circuit-types": "0.62.0",
-    "@aztec/circuits.js": "0.62.0",
-    "@aztec/foundation": "0.62.0",
-    "@aztec/noir-protocol-circuits-types": "0.62.0",
-    "@aztec/protocol-contracts": "0.62.0",
-    "@aztec/telemetry-client": "0.62.0",
-    "@aztec/types": "0.62.0",
-    "@aztec/world-state": "0.62.0",
+    "@aztec/circuit-types": "0.63.1",
+    "@aztec/circuits.js": "0.63.1",
+    "@aztec/foundation": "0.63.1",
+    "@aztec/noir-protocol-circuits-types": "0.63.1",
+    "@aztec/protocol-contracts": "0.63.1",
+    "@aztec/telemetry-client": "0.63.1",
+    "@aztec/types": "0.63.1",
+    "@aztec/world-state": "0.63.1",
     "@noir-lang/acvm_js": "portal:../../noir/packages/acvm_js",
+    "@noir-lang/noirc_abi": "portal:../../noir/packages/noirc_abi",
     "@noir-lang/types": "portal:../../noir/packages/types",
     "levelup": "^5.1.1",
+    "lodash.clonedeep": "^4.5.0",
     "memdown": "^6.1.1",
     "tslib": "^2.4.0"
   },
@@ -80,6 +82,7 @@
     "@jest/globals": "^29.5.0",
     "@types/jest": "^29.5.0",
     "@types/levelup": "^5.1.3",
+    "@types/lodash.clonedeep": "^4.5.7",
     "@types/lodash.merge": "^4.6.9",
     "@types/memdown": "^3.0.2",
     "@types/node": "^18.7.23",

package/src/acvm/acvm.ts

@@ -1,5 +1,5 @@
-import { type NoirCallStack, type SourceCodeLocation } from '@aztec/circuit-types';
-import type { BrilligFunctionId, FunctionDebugMetadata, OpcodeLocation } from '@aztec/foundation/abi';
+import { type NoirCallStack } from '@aztec/circuit-types';
+import type { FunctionDebugMetadata } from '@aztec/foundation/abi';
 import { createDebugLogger } from '@aztec/foundation/log';
 
 import {
@@ -9,7 +9,7 @@ import {
   executeCircuitWithReturnWitness,
 } from '@noir-lang/acvm_js';
 
-import { traverseCauseChain } from '../common/errors.js';
+import { resolveOpcodeLocations, traverseCauseChain } from '../common/errors.js';
 import { type ACVMWitness } from './acvm_types.js';
 import { type ORACLE_NAMES } from './oracle/index.js';
 
@@ -34,97 +34,6 @@ export interface ACIRExecutionResult {
   returnWitness: ACVMWitness;
 }
 
-/**
- * Extracts a brillig location from an opcode location.
- * @param opcodeLocation - The opcode location to extract from. It should be in the format `acirLocation.brilligLocation` or `acirLocation`.
- * @returns The brillig location if the opcode location contains one.
- */
-function extractBrilligLocation(opcodeLocation: string): string | undefined {
-  const splitted = opcodeLocation.split('.');
-  if (splitted.length === 2) {
-    return splitted[1];
-  }
-  return undefined;
-}
-
-/**
- * Extracts the call stack from the location of a failing opcode and the debug metadata.
- * One opcode can point to multiple calls due to inlining.
- */
-function getSourceCodeLocationsFromOpcodeLocation(
-  opcodeLocation: string,
-  debug: FunctionDebugMetadata,
-  brilligFunctionId?: BrilligFunctionId,
-): SourceCodeLocation[] {
-  const { debugSymbols, files } = debug;
-
-  let callStack = debugSymbols.locations[opcodeLocation] || [];
-  if (callStack.length === 0) {
-    const brilligLocation = extractBrilligLocation(opcodeLocation);
-    if (brilligFunctionId !== undefined && brilligLocation !== undefined) {
-      callStack = debugSymbols.brillig_locations[brilligFunctionId][brilligLocation] || [];
-    }
-  }
-  return callStack.map(call => {
-    const { file: fileId, span } = call;
-
-    const { path, source } = files[fileId];
-
-    const locationText = source.substring(span.start, span.end);
-    const precedingText = source.substring(0, span.start);
-    const previousLines = precedingText.split('\n');
-    // Lines and columns in stacks are one indexed.
-    const line = previousLines.length;
-    const column = previousLines[previousLines.length - 1].length + 1;
-
-    return {
-      filePath: path,
-      line,
-      column,
-      fileSource: source,
-      locationText,
-    };
-  });
-}
-
-/**
- * Extracts the source code locations for an array of opcode locations
- * @param opcodeLocations - The opcode locations that caused the error.
- * @param debug - The debug metadata of the function.
- * @returns The source code locations.
- */
-export function resolveOpcodeLocations(
-  opcodeLocations: OpcodeLocation[],
-  debug: FunctionDebugMetadata,
-  brilligFunctionId?: BrilligFunctionId,
-): SourceCodeLocation[] {
-  return opcodeLocations.flatMap(opcodeLocation =>
-    getSourceCodeLocationsFromOpcodeLocation(opcodeLocation, debug, brilligFunctionId),
-  );
-}
-
-/**
- * Extracts the source code locations for an array of opcode locations
- * @param opcodeLocations - The opcode locations that caused the error.
- * @param debug - The debug metadata of the function.
- * @returns The source code locations.
- */
-export function resolveAssertionMessage(
-  opcodeLocations: OpcodeLocation[],
-  debug: FunctionDebugMetadata,
-): string | undefined {
-  if (opcodeLocations.length === 0) {
-    return undefined;
-  }
-
-  const lastLocation = extractBrilligLocation(opcodeLocations[opcodeLocations.length - 1]);
-  if (!lastLocation) {
-    return undefined;
-  }
-
-  return debug.assertMessages?.[parseInt(lastLocation, 10)];
-}
-
 /**
  * The function call that executes an ACIR.
  */

package/src/acvm/oracle/oracle.ts

@@ -293,7 +293,7 @@ export class Oracle {
     [numberOfElements]: ACVMField[],
   ): Promise<ACVMField[]> {
     const values = await this.typedOracle.storageRead(
-      fromACVMField(contractAddress),
+      new AztecAddress(fromACVMField(contractAddress)),
       fromACVMField(startStorageSlot),
       +blockNumber,
       +numberOfElements,
@@ -336,15 +336,11 @@ export class Oracle {
     return toACVMField(0);
   }
 
-  emitContractClassUnencryptedLog(
-    [contractAddress]: ACVMField[],
-    message: ACVMField[],
-    [counter]: ACVMField[],
-  ): ACVMField {
+  emitContractClassLog([contractAddress]: ACVMField[], message: ACVMField[], [counter]: ACVMField[]): ACVMField {
     const logPayload = Buffer.concat(message.map(fromACVMField).map(f => f.toBuffer()));
     const log = new UnencryptedL2Log(AztecAddress.fromString(contractAddress), logPayload);
 
-    const logHash = this.typedOracle.emitContractClassUnencryptedLog(log, +counter);
+    const logHash = this.typedOracle.emitContractClassLog(log, +counter);
     return toACVMField(logHash);
   }
 
@@ -409,23 +405,22 @@ export class Oracle {
     this.typedOracle.notifySetMinRevertibleSideEffectCounter(frToNumber(fromACVMField(minRevertibleSideEffectCounter)));
   }
 
-  async getAppTaggingSecret([sender]: ACVMField[], [recipient]: ACVMField[]): Promise<ACVMField[]> {
-    const taggingSecret = await this.typedOracle.getAppTaggingSecret(
+  async getAppTaggingSecretAsSender([sender]: ACVMField[], [recipient]: ACVMField[]): Promise<ACVMField[]> {
+    const taggingSecret = await this.typedOracle.getAppTaggingSecretAsSender(
       AztecAddress.fromString(sender),
       AztecAddress.fromString(recipient),
     );
     return taggingSecret.toFields().map(toACVMField);
   }
 
-  async incrementAppTaggingSecret([sender]: ACVMField[], [recipient]: ACVMField[]) {
-    await this.typedOracle.incrementAppTaggingSecret(
+  async incrementAppTaggingSecretIndexAsSender([sender]: ACVMField[], [recipient]: ACVMField[]) {
+    await this.typedOracle.incrementAppTaggingSecretIndexAsSender(
       AztecAddress.fromString(sender),
       AztecAddress.fromString(recipient),
     );
   }
 
-  async getAppTaggingSecretsForSenders([recipient]: ACVMField[]): Promise<ACVMField[]> {
-    const taggingSecrets = await this.typedOracle.getAppTaggingSecretsForSenders(AztecAddress.fromString(recipient));
-    return taggingSecrets.flatMap(taggingSecret => taggingSecret.toFields().map(toACVMField));
+  async syncNotes() {
+    await this.typedOracle.syncNotes();
   }
 }

package/src/acvm/oracle/typed_oracle.ts

@@ -183,7 +183,7 @@ export abstract class TypedOracle {
   }
 
   storageRead(
-    _contractAddress: Fr,
+    _contractAddress: AztecAddress,
     _startStorageSlot: Fr,
     _blockNumber: number,
     _numberOfElements: number,
@@ -212,7 +212,7 @@ export abstract class TypedOracle {
     throw new OracleMethodNotAvailableError('emitUnencryptedLog');
   }
 
-  emitContractClassUnencryptedLog(_log: UnencryptedL2Log, _counter: number): Fr {
+  emitContractClassLog(_log: UnencryptedL2Log, _counter: number): Fr {
     throw new OracleMethodNotAvailableError('emitContractClassUnencryptedLog');
   }
 
@@ -254,15 +254,15 @@ export abstract class TypedOracle {
     throw new OracleMethodNotAvailableError('debugLog');
   }
 
-  getAppTaggingSecret(_sender: AztecAddress, _recipient: AztecAddress): Promise<IndexedTaggingSecret> {
-    throw new OracleMethodNotAvailableError('getAppTaggingSecret');
+  getAppTaggingSecretAsSender(_sender: AztecAddress, _recipient: AztecAddress): Promise<IndexedTaggingSecret> {
+    throw new OracleMethodNotAvailableError('getAppTaggingSecretAsSender');
   }
 
-  incrementAppTaggingSecret(_sender: AztecAddress, _recipient: AztecAddress): Promise<void> {
-    throw new OracleMethodNotAvailableError('incrementAppTaggingSecret');
+  incrementAppTaggingSecretIndexAsSender(_sender: AztecAddress, _recipient: AztecAddress): Promise<void> {
+    throw new OracleMethodNotAvailableError('incrementAppTaggingSecretIndexAsSender');
   }
 
-  getAppTaggingSecretsForSenders(_recipient: AztecAddress): Promise<IndexedTaggingSecret[]> {
-    throw new OracleMethodNotAvailableError('getAppTaggingSecretsForSenders');
+  syncNotes(): Promise<void> {
+    throw new OracleMethodNotAvailableError('syncNotes');
   }
 }

package/src/avm/avm_gas.ts

@@ -136,6 +136,7 @@ const DYNAMIC_GAS_COSTS = new Map<Opcode, Gas>([
   [Opcode.RETURN, makeCost(c.AVM_RETURN_DYN_L2_GAS, 0)],
   [Opcode.REVERT_8, makeCost(c.AVM_REVERT_DYN_L2_GAS, 0)],
   [Opcode.REVERT_16, makeCost(c.AVM_REVERT_DYN_L2_GAS, 0)],
+  [Opcode.DEBUGLOG, makeCost(c.AVM_DEBUGLOG_DYN_L2_GAS, 0)],
   [Opcode.MSM, makeCost(c.AVM_MSM_DYN_L2_GAS, 0)],
   [Opcode.TORADIXBE, makeCost(c.AVM_TORADIXBE_DYN_L2_GAS, 0)],
 ]);

package/src/avm/avm_machine_state.ts

@@ -2,7 +2,7 @@ import { type Fr } from '@aztec/circuits.js';
 
 import { GAS_DIMENSIONS, type Gas } from './avm_gas.js';
 import { TaggedMemory } from './avm_memory_types.js';
-import { OutOfGasError } from './errors.js';
+import { type AvmRevertReason, OutOfGasError } from './errors.js';
 
 /**
  * A few fields of machine state are initialized from AVM session inputs or call instruction arguments
@@ -12,6 +12,21 @@ export type InitialAvmMachineState = {
   daGasLeft: number;
 };
 
+/**
+ * Used to track the call stack and revert data of nested calls.
+ * This is used to provide a more detailed revert reason when a contract call reverts.
+ * It is only a heuristic and may not always provide the correct revert reason.
+ */
+type TrackedRevertInfo = {
+  revertDataRepresentative: Fr[];
+  recursiveRevertReason: AvmRevertReason;
+};
+
+type CallStackEntry = {
+  callPc: number;
+  returnPc: number;
+};
+
 /**
  * Avm state modified on an instruction-per-instruction basis.
  */
@@ -19,16 +34,24 @@ export class AvmMachineState {
   /** gas remaining of the gas allocated for a contract call */
   public l2GasLeft: number;
   public daGasLeft: number;
-  /** program counter */
+  /** program counter, byte based */
   public pc: number = 0;
+  /** program counter of the next instruction, byte based */
+  public nextPc: number = 0;
   /** return/revertdata of the last nested call. */
   public nestedReturndata: Fr[] = [];
+  /**
+   * Used to track the call stack and revert data of nested calls.
+   * This is used to provide a more detailed revert reason when a contract call reverts.
+   * It is only a heuristic and may not always provide the correct revert reason.
+   */
+  public collectedRevertInfo: TrackedRevertInfo | undefined;
 
   /**
-   * On INTERNALCALL, internal call stack is pushed to with the current pc + 1
-   * On INTERNALRETURN, value is popped from the internal call stack and assigned to the pc.
+   * On INTERNALCALL, internal call stack is pushed to with the current pc and the return pc.
+   * On INTERNALRETURN, value is popped from the internal call stack and assigned to the return pc.
    */
-  public internalCallStack: number[] = [];
+  public internalCallStack: CallStackEntry[] = [];
 
   /** Memory accessible to user code */
   public readonly memory: TaggedMemory = new TaggedMemory();
@@ -91,13 +114,6 @@ export class AvmMachineState {
     }
   }
 
-  /**
-   * Most instructions just increment PC before they complete
-   */
-  public incrementPc() {
-    this.pc++;
-  }
-
   /**
    * Halt as successful
    * Output data must NOT be modified once it is set

package/src/avm/avm_memory_types.ts

@@ -7,6 +7,7 @@ import {
   MEM_TAG_U64,
   MEM_TAG_U128,
 } from '@aztec/circuits.js';
+import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { toBufferBE } from '@aztec/foundation/bigint-buffer';
 import { Fr } from '@aztec/foundation/fields';
 import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
@@ -41,6 +42,10 @@ export abstract class MemoryValue {
     return new Fr(this.toBigInt());
   }
 
+  public toAztecAddress(): AztecAddress {
+    return new AztecAddress(this.toFr());
+  }
+
   // To number. Throws if exceeds max safe int.
   public toNumber(): number {
     return this.toFr().toNumber();

package/src/avm/avm_simulator.ts

@@ -15,8 +15,7 @@ import {
   revertReasonFromExceptionalHalt,
   revertReasonFromExplicitRevert,
 } from './errors.js';
-import type { Instruction } from './opcodes/index.js';
-import { decodeFromBytecode } from './serialization/bytecode_serialization.js';
+import { decodeInstructionFromBytecode } from './serialization/bytecode_serialization.js';
 
 type OpcodeTally = {
   count: number;
@@ -31,8 +30,8 @@ type PcTally = {
 export class AvmSimulator {
   private log: DebugLogger;
   private bytecode: Buffer | undefined;
-  public opcodeTallies: Map<string, OpcodeTally> = new Map();
-  public pcTallies: Map<number, PcTally> = new Map();
+  private opcodeTallies: Map<string, OpcodeTally> = new Map();
+  private pcTallies: Map<number, PcTally> = new Map();
 
   constructor(private context: AvmContext) {
     assert(
@@ -70,24 +69,17 @@ export class AvmSimulator {
    */
   public async executeBytecode(bytecode: Buffer): Promise<AvmContractCallResult> {
     assert(isAvmBytecode(bytecode), "AVM simulator can't execute non-AVM bytecode");
+    assert(bytecode.length > 0, "AVM simulator can't execute empty bytecode");
 
     this.bytecode = bytecode;
-    return await this.executeInstructions(decodeFromBytecode(bytecode));
-  }
 
-  /**
-   * Executes the provided instructions in the current context.
-   * This method is useful for testing and debugging.
-   */
-  public async executeInstructions(instructions: Instruction[]): Promise<AvmContractCallResult> {
-    assert(instructions.length > 0);
     const { machineState } = this.context;
     try {
       // Execute instruction pointed to by the current program counter
       // continuing until the machine state signifies a halt
       let instrCounter = 0;
       while (!machineState.getHalted()) {
-        const instruction = instructions[machineState.pc];
+        const [instruction, bytesRead] = decodeInstructionFromBytecode(bytecode, machineState.pc);
         assert(
           !!instruction,
           'AVM attempted to execute non-existent instruction. This should never happen (invalid bytecode or AVM simulator bug)!',
@@ -104,7 +96,12 @@ export class AvmSimulator {
         // Execute the instruction.
         // Normal returns and reverts will return normally here.
         // "Exceptional halts" will throw.
+        machineState.nextPc = machineState.pc + bytesRead;
         await instruction.execute(this.context);
+        if (!instruction.handlesPC()) {
+          // Increment PC if the instruction doesn't handle it itself
+          machineState.pc += bytesRead;
+        }
 
         // gas used by this instruction - used for profiling/tallying
         const gasUsed: Gas = {
@@ -113,9 +110,9 @@ export class AvmSimulator {
         };
         this.tallyInstruction(instrPc, instruction.constructor.name, gasUsed);
 
-        if (machineState.pc >= instructions.length) {
+        if (machineState.pc >= bytecode.length) {
           this.log.warn('Passed end of program');
-          throw new InvalidProgramCounterError(machineState.pc, /*max=*/ instructions.length);
+          throw new InvalidProgramCounterError(machineState.pc, /*max=*/ bytecode.length);
         }
       }
 
@@ -136,7 +133,7 @@ export class AvmSimulator {
       }
 
       const revertReason = revertReasonFromExceptionalHalt(err, this.context);
-      // Note: "exceptional halts" cannot return data, hence []
+      // Note: "exceptional halts" cannot return data, hence [].
       const results = new AvmContractCallResult(/*reverted=*/ true, /*output=*/ [], revertReason);
       this.log.debug(`Context execution results: ${results.toString()}`);