@aztec/simulator 0.52.0 → 0.54.0

package/src/avm/avm_memory_types.ts

@@ -350,7 +350,7 @@ export class TaggedMemory implements TaggedMemoryInterface {
   }
 
   // Truncates the value to fit the type.
-  public static integralFromTag(v: bigint | number, tag: TypeTag): IntegralValue {
+  public static buildFromTagTruncating(v: bigint | number, tag: TypeTag): MemoryValue {
     v = BigInt(v);
     switch (tag) {
       case TypeTag.UINT8:
@@ -363,8 +363,10 @@ export class TaggedMemory implements TaggedMemoryInterface {
         return new Uint64(v & ((1n << 64n) - 1n));
       case TypeTag.UINT128:
         return new Uint128(v & ((1n << 128n) - 1n));
+      case TypeTag.FIELD:
+        return new Field(v);
       default:
-        throw new Error(`${TypeTag[tag]} is not a valid integral type.`);
+        throw new Error(`${TypeTag[tag]} is not a valid tag.`);
     }
   }
 

package/src/avm/bytecode_utils.ts

@@ -1,13 +1,13 @@
 import { promisify } from 'util';
 import { gunzip } from 'zlib';
 
-import { Mov } from '../avm/opcodes/memory.js';
+import { Opcode } from './serialization/instruction_serialization.js';
 
 const AVM_MAGIC_SUFFIX = Buffer.from([
-  Mov.opcode, // opcode
+  Opcode.MOV_16, // opcode
   0x00, // indirect
-  ...Buffer.from('000018ca', 'hex'), // srcOffset
-  ...Buffer.from('000018ca', 'hex'), // dstOffset
+  ...Buffer.from('18ca', 'hex'), // srcOffset
+  ...Buffer.from('18ca', 'hex'), // dstOffset
 ]);
 
 export function markBytecodeAsAvm(bytecode: Buffer): Buffer {

package/src/avm/errors.ts

@@ -151,7 +151,7 @@ export function revertReasonFromExplicitRevert(revertData: Fr[], context: AvmCon
  */
 export function decodeRevertDataAsMessage(revertData: Fr[]): string {
   if (revertData.length === 0) {
-    return 'Assertion failed.';
+    return 'Assertion failed';
   } else {
     try {
       // We remove the first element which is the 'error selector'.

package/src/avm/fixtures/index.ts

@@ -1,5 +1,6 @@
+import { isNoirCallStackUnresolved } from '@aztec/circuit-types';
 import { GasFees, GlobalVariables, Header } from '@aztec/circuits.js';
-import { FunctionSelector } from '@aztec/foundation/abi';
+import { FunctionSelector, getFunctionDebugMetadata } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
@@ -9,12 +10,19 @@ import { strict as assert } from 'assert';
 import { mock } from 'jest-mock-extended';
 import merge from 'lodash.merge';
 
-import { type CommitmentsDB, type PublicContractsDB, type PublicStateDB } from '../../index.js';
+import {
+  type CommitmentsDB,
+  type PublicContractsDB,
+  type PublicStateDB,
+  resolveAssertionMessage,
+  traverseCauseChain,
+} from '../../index.js';
 import { type PublicSideEffectTraceInterface } from '../../public/side_effect_trace_interface.js';
 import { AvmContext } from '../avm_context.js';
 import { AvmContextInputs, AvmExecutionEnvironment } from '../avm_execution_environment.js';
 import { AvmMachineState } from '../avm_machine_state.js';
 import { Field, Uint8, Uint64 } from '../avm_memory_types.js';
+import { type AvmRevertReason } from '../errors.js';
 import { HostStorage } from '../journal/host_storage.js';
 import { AvmPersistableStateManager } from '../journal/journal.js';
 import { NullifierManager } from '../journal/nullifiers.js';
@@ -152,3 +160,25 @@ export function getAvmTestContractBytecode(functionName: string): Buffer {
   );
   return artifact.bytecode;
 }
+
+export function resolveAvmTestContractAssertionMessage(
+  functionName: string,
+  revertReason: AvmRevertReason,
+): string | undefined {
+  const functionArtifact = AvmTestContractArtifact.functions.find(f => f.name === functionName)!;
+
+  traverseCauseChain(revertReason, cause => {
+    revertReason = cause as AvmRevertReason;
+  });
+
+  if (!functionArtifact || !revertReason.noirCallStack || !isNoirCallStackUnresolved(revertReason.noirCallStack)) {
+    return undefined;
+  }
+
+  const debugMetadata = getFunctionDebugMetadata(AvmTestContractArtifact, functionArtifact);
+  if (!debugMetadata) {
+    return undefined;
+  }
+
+  return resolveAssertionMessage(revertReason.noirCallStack, debugMetadata);
+}

package/src/avm/journal/journal.ts

@@ -1,5 +1,5 @@
 import { AztecAddress, type FunctionSelector, type Gas } from '@aztec/circuits.js';
-import { type Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/fields';
 import { type DebugLogger, createDebugLogger } from '@aztec/foundation/log';
 import { SerializableContractInstance } from '@aztec/types/contracts';
 
@@ -122,10 +122,14 @@ export class AvmPersistableStateManager {
    * @returns true if the note hash exists at the given leaf index, false otherwise
    */
   public async checkNoteHashExists(storageAddress: Fr, noteHash: Fr, leafIndex: Fr): Promise<boolean> {
-    const gotLeafIndex = await this.hostStorage.commitmentsDb.getCommitmentIndex(noteHash);
-    const exists = gotLeafIndex === leafIndex.toBigInt();
-    this.log.debug(`noteHashes(${storageAddress})@${noteHash} ?? leafIndex: ${leafIndex}, exists: ${exists}.`);
-    this.trace.traceNoteHashCheck(storageAddress, noteHash, leafIndex, exists);
+    const gotLeafValue = (await this.hostStorage.commitmentsDb.getCommitmentValue(leafIndex.toBigInt())) ?? Fr.ZERO;
+    const exists = gotLeafValue.equals(noteHash);
+    this.log.debug(
+      `noteHashes(${storageAddress})@${noteHash} ?? leafIndex: ${leafIndex} | gotLeafValue: ${gotLeafValue}, exists: ${exists}.`,
+    );
+    // TODO(8287): We still return exists here, but we need to transmit both the requested noteHash and the gotLeafValue
+    // such that the VM can constrain the equality and decide on exists based on that.
+    this.trace.traceNoteHashCheck(storageAddress, gotLeafValue, leafIndex, exists);
     return Promise.resolve(exists);
   }
 
@@ -173,12 +177,14 @@ export class AvmPersistableStateManager {
    * @returns exists - whether the message exists in the L1 to L2 Messages tree
    */
   public async checkL1ToL2MessageExists(contractAddress: Fr, msgHash: Fr, msgLeafIndex: Fr): Promise<boolean> {
-    const valueAtIndex = await this.hostStorage.commitmentsDb.getL1ToL2LeafValue(msgLeafIndex.toBigInt());
-    const exists = valueAtIndex?.equals(msgHash) ?? false;
+    const valueAtIndex = (await this.hostStorage.commitmentsDb.getL1ToL2LeafValue(msgLeafIndex.toBigInt())) ?? Fr.ZERO;
+    const exists = valueAtIndex.equals(msgHash);
     this.log.debug(
       `l1ToL2Messages(@${msgLeafIndex}) ?? exists: ${exists}, expected: ${msgHash}, found: ${valueAtIndex}.`,
     );
-    this.trace.traceL1ToL2MessageCheck(contractAddress, msgHash, msgLeafIndex, exists);
+    // TODO(8287): We still return exists here, but we need to transmit both the requested msgHash and the value
+    // such that the VM can constrain the equality and decide on exists based on that.
+    this.trace.traceL1ToL2MessageCheck(contractAddress, valueAtIndex, msgLeafIndex, exists);
     return Promise.resolve(exists);
   }
 

package/src/avm/opcodes/arithmetic.ts

@@ -1,8 +1,7 @@
 import type { AvmContext } from '../avm_context.js';
-import { type Field, type MemoryValue, TypeTag } from '../avm_memory_types.js';
-import { Opcode, OperandType } from '../serialization/instruction_serialization.js';
+import { type Field, type MemoryValue } from '../avm_memory_types.js';
+import { Opcode } from '../serialization/instruction_serialization.js';
 import { Addressing } from './addressing_mode.js';
-import { Instruction } from './instruction.js';
 import { ThreeOperandInstruction } from './instruction_impl.js';
 
 export abstract class ThreeOperandArithmeticInstruction extends ThreeOperandInstruction {
@@ -32,7 +31,7 @@ export abstract class ThreeOperandArithmeticInstruction extends ThreeOperandInst
 
 export class Add extends ThreeOperandArithmeticInstruction {
   static readonly type: string = 'ADD';
-  static readonly opcode = Opcode.ADD;
+  static readonly opcode = Opcode.ADD_8; // FIXME: needed for gas.
 
   protected compute(a: MemoryValue, b: MemoryValue): MemoryValue {
     return a.add(b);
@@ -41,7 +40,7 @@ export class Add extends ThreeOperandArithmeticInstruction {
 
 export class Sub extends ThreeOperandArithmeticInstruction {
   static readonly type: string = 'SUB';
-  static readonly opcode = Opcode.SUB;
+  static readonly opcode = Opcode.SUB_8; // FIXME: needed for gas.
 
   protected compute(a: MemoryValue, b: MemoryValue): MemoryValue {
     return a.sub(b);
@@ -50,7 +49,7 @@ export class Sub extends ThreeOperandArithmeticInstruction {
 
 export class Mul extends ThreeOperandArithmeticInstruction {
   static type: string = 'MUL';
-  static readonly opcode = Opcode.MUL;
+  static readonly opcode = Opcode.MUL_8; // FIXME: needed for gas.
 
   protected compute(a: MemoryValue, b: MemoryValue): MemoryValue {
     return a.mul(b);
@@ -59,48 +58,20 @@ export class Mul extends ThreeOperandArithmeticInstruction {
 
 export class Div extends ThreeOperandArithmeticInstruction {
   static type: string = 'DIV';
-  static readonly opcode = Opcode.DIV;
+  static readonly opcode = Opcode.DIV_8; // FIXME: needed for gas.
 
   protected compute(a: MemoryValue, b: MemoryValue): MemoryValue {
     return a.div(b);
   }
 }
 
-export class FieldDiv extends Instruction {
+// TODO: This class now temporarily has a tag, until all tags are removed.
+export class FieldDiv extends ThreeOperandArithmeticInstruction {
   static type: string = 'FDIV';
-  static readonly opcode = Opcode.FDIV;
-
-  // Informs (de)serialization. See Instruction.deserialize.
-  static readonly wireFormat: OperandType[] = [
-    OperandType.UINT8,
-    OperandType.UINT8,
-    OperandType.UINT32,
-    OperandType.UINT32,
-    OperandType.UINT32,
-  ];
-
-  constructor(private indirect: number, private aOffset: number, private bOffset: number, private dstOffset: number) {
-    super();
-  }
-
-  public async execute(context: AvmContext): Promise<void> {
-    const memoryOperations = { reads: 2, writes: 1, indirect: this.indirect };
-    const memory = context.machineState.memory.track(this.type);
-    context.machineState.consumeGas(this.gasCost(memoryOperations));
-
-    const [aOffset, bOffset, dstOffset] = Addressing.fromWire(this.indirect).resolve(
-      [this.aOffset, this.bOffset, this.dstOffset],
-      memory,
-    );
-    memory.checkTags(TypeTag.FIELD, aOffset, bOffset);
-
-    const a = memory.getAs<Field>(aOffset);
-    const b = memory.getAs<Field>(bOffset);
+  static readonly opcode = Opcode.FDIV_8; // FIXME: needed for gas.
 
-    const dest = a.fdiv(b);
-    memory.set(dstOffset, dest);
-
-    memory.assert(memoryOperations);
-    context.machineState.incrementPc();
+  protected compute(a: Field, b: Field): Field {
+    // return (a as Field).fdiv(b as Field);
+    return a.fdiv(b);
   }
 }

package/src/avm/opcodes/bitwise.ts

@@ -34,7 +34,7 @@ abstract class ThreeOperandBitwiseInstruction extends ThreeOperandInstruction {
 
 export class And extends ThreeOperandBitwiseInstruction {
   static readonly type: string = 'AND';
-  static readonly opcode = Opcode.AND;
+  static readonly opcode = Opcode.AND_8; // FIXME: needed for gas.
 
   protected override compute(a: IntegralValue, b: IntegralValue): IntegralValue {
     return a.and(b);
@@ -43,7 +43,7 @@ export class And extends ThreeOperandBitwiseInstruction {
 
 export class Or extends ThreeOperandBitwiseInstruction {
   static readonly type: string = 'OR';
-  static readonly opcode = Opcode.OR;
+  static readonly opcode = Opcode.OR_8; // FIXME: needed for gas.
 
   protected override compute(a: IntegralValue, b: IntegralValue): IntegralValue {
     return a.or(b);
@@ -52,7 +52,7 @@ export class Or extends ThreeOperandBitwiseInstruction {
 
 export class Xor extends ThreeOperandBitwiseInstruction {
   static readonly type: string = 'XOR';
-  static readonly opcode = Opcode.XOR;
+  static readonly opcode = Opcode.XOR_8; // FIXME: needed for gas.
 
   protected override compute(a: IntegralValue, b: IntegralValue): IntegralValue {
     return a.xor(b);
@@ -61,7 +61,7 @@ export class Xor extends ThreeOperandBitwiseInstruction {
 
 export class Shl extends ThreeOperandBitwiseInstruction {
   static readonly type: string = 'SHL';
-  static readonly opcode = Opcode.SHL;
+  static readonly opcode = Opcode.SHL_8; // FIXME: needed for gas.
 
   protected override compute(a: IntegralValue, b: IntegralValue): IntegralValue {
     return a.shl(b);
@@ -74,7 +74,7 @@ export class Shl extends ThreeOperandBitwiseInstruction {
 
 export class Shr extends ThreeOperandBitwiseInstruction {
   static readonly type: string = 'SHR';
-  static readonly opcode = Opcode.SHR;
+  static readonly opcode = Opcode.SHR_8; // FIXME: needed for gas.
 
   protected override compute(a: IntegralValue, b: IntegralValue): IntegralValue {
     return a.shr(b);

package/src/avm/opcodes/comparators.ts

@@ -31,7 +31,7 @@ abstract class ComparatorInstruction extends ThreeOperandInstruction {
 
 export class Eq extends ComparatorInstruction {
   static readonly type: string = 'EQ';
-  static readonly opcode = Opcode.EQ;
+  static readonly opcode = Opcode.EQ_8; // FIXME: needed for gas.
 
   protected compare(a: MemoryValue, b: MemoryValue): boolean {
     return a.equals(b);
@@ -40,7 +40,7 @@ export class Eq extends ComparatorInstruction {
 
 export class Lt extends ComparatorInstruction {
   static readonly type: string = 'LT';
-  static readonly opcode = Opcode.LT;
+  static readonly opcode = Opcode.LT_8; // FIXME: needed for gas.
 
   protected compare(a: MemoryValue, b: MemoryValue): boolean {
     return a.lt(b);
@@ -49,7 +49,7 @@ export class Lt extends ComparatorInstruction {
 
 export class Lte extends ComparatorInstruction {
   static readonly type: string = 'LTE';
-  static readonly opcode = Opcode.LTE;
+  static readonly opcode = Opcode.LTE_8; // FIXME: needed for gas.
 
   protected compare(a: MemoryValue, b: MemoryValue): boolean {
     return a.lt(b) || a.equals(b);

package/src/avm/opcodes/control_flow.ts

@@ -7,9 +7,9 @@ import { Instruction } from './instruction.js';
 
 export class Jump extends Instruction {
   static type: string = 'JUMP';
-  static readonly opcode: Opcode = Opcode.JUMP;
+  static readonly opcode: Opcode = Opcode.JUMP_16;
   // Informs (de)serialization. See Instruction.deserialize.
-  static readonly wireFormat: OperandType[] = [OperandType.UINT8, OperandType.UINT32];
+  static readonly wireFormat: OperandType[] = [OperandType.UINT8, OperandType.UINT16];
 
   constructor(private jumpOffset: number) {
     super();
@@ -26,14 +26,14 @@ export class Jump extends Instruction {
 
 export class JumpI extends Instruction {
   static type: string = 'JUMPI';
-  static readonly opcode: Opcode = Opcode.JUMPI;
+  static readonly opcode: Opcode = Opcode.JUMPI_16;
 
   // Instruction wire format with opcode.
   static readonly wireFormat: OperandType[] = [
     OperandType.UINT8,
     OperandType.UINT8,
-    OperandType.UINT32,
-    OperandType.UINT32,
+    OperandType.UINT16,
+    OperandType.UINT16,
   ];
 
   constructor(private indirect: number, private loc: number, private condOffset: number) {

package/src/avm/opcodes/instruction.ts

@@ -4,11 +4,11 @@ import type { AvmContext } from '../avm_context.js';
 import { getBaseGasCost, getDynamicGasCost, mulGas, sumGas } from '../avm_gas.js';
 import { type MemoryOperations } from '../avm_memory_types.js';
 import { type BufferCursor } from '../serialization/buffer_cursor.js';
-import { Opcode, type OperandType, deserialize, serialize } from '../serialization/instruction_serialization.js';
+import { type Serializable } from '../serialization/bytecode_serialization.js';
+import { Opcode, type OperandType, deserialize, serializeAs } from '../serialization/instruction_serialization.js';
 
 type InstructionConstructor = {
   new (...args: any[]): Instruction;
-  wireFormat?: OperandType[];
 };
 
 /**
@@ -37,29 +37,51 @@ export abstract class Instruction {
     return instructionStr;
   }
 
+  // Default deserialization which uses Class.opcode and Class.wireFormat.
+  public static deserialize(
+    this: InstructionConstructor & { wireFormat: OperandType[]; as: any },
+    buf: BufferCursor | Buffer,
+  ): Instruction {
+    return this.as(this.wireFormat).deserialize(buf);
+  }
+
+  // Default serialization which uses Class.opcode and Class.wireFormat.
+  public serialize(): Buffer {
+    const klass = this.constructor as any;
+    assert(klass.opcode !== undefined && klass.opcode !== null);
+    assert(klass.wireFormat !== undefined && klass.wireFormat !== null);
+    return this.as(klass.opcode, klass.wireFormat).serialize();
+  }
+
   /**
-   * Serialize the instruction to a Buffer according to its wire format specified in its subclass.
-   * If you want to use this, your subclass should specify a {@code static wireFormat: OperandType[]}.
-   * @param this - The instruction to serialize.
-   * @returns The serialized instruction.
+   * Returns a new instruction instance that can be serialized with the given opcode and wire format.
+   * @param opcode The opcode of the instruction.
+   * @param wireFormat The wire format of the instruction.
+   * @returns The new instruction instance.
    */
-  public serialize(this: any): Buffer {
-    assert(!!this.constructor.wireFormat, 'wireFormat must be defined on the class');
-    return serialize(this.constructor.wireFormat, this);
+  public as(opcode: Opcode, wireFormat: OperandType[]): Instruction & Serializable {
+    return Object.defineProperty(this, 'serialize', {
+      value: (): Buffer => {
+        return serializeAs(wireFormat, opcode, this);
+      },
+      enumerable: false,
+    });
   }
 
   /**
-   * Deserializes a subclass of Instruction from a Buffer.
-   * If you want to use this, your subclass should specify a {@code static wireFormat: OperandType[]}.
-   * @param this Class object to deserialize to.
-   * @param buf Buffer to read from.
-   * @returns Constructed instance of Class.
+   * Returns a new instruction class that can be deserialized with the given opcode and wire format.
+   * @param opcode The opcode of the instruction.
+   * @param wireFormat The wire format of the instruction.
+   * @returns The new instruction class.
    */
-  public static deserialize(this: InstructionConstructor, buf: BufferCursor | Buffer): Instruction {
-    assert(!!this.wireFormat, 'wireFormat must be defined on the instruction class');
-    const res = deserialize(buf, this.wireFormat);
-    const args = res.slice(1); // Remove opcode.
-    return new this(...args);
+  public static as(this: InstructionConstructor, wireFormat: OperandType[]) {
+    return Object.assign(this, {
+      deserialize: (buf: BufferCursor | Buffer): Instruction => {
+        const res = deserialize(buf, wireFormat);
+        const args = res.slice(1); // Remove opcode.
+        return new this(...args);
+      },
+    });
   }
 
   /**

package/src/avm/opcodes/instruction_impl.ts

@@ -14,13 +14,21 @@ export const TwoOperandWireFormat = [
 ];
 
 /** Wire format that informs deserialization for instructions with three operands. */
-export const ThreeOperandWireFormat = [
+export const ThreeOperandWireFormat8 = [
+  OperandType.UINT8,
+  OperandType.UINT8,
+  OperandType.UINT8,
   OperandType.UINT8,
   OperandType.UINT8,
   OperandType.UINT8,
-  OperandType.UINT32,
-  OperandType.UINT32,
-  OperandType.UINT32,
+];
+export const ThreeOperandWireFormat16 = [
+  OperandType.UINT8,
+  OperandType.UINT8,
+  OperandType.UINT8,
+  OperandType.UINT16,
+  OperandType.UINT16,
+  OperandType.UINT16,
 ];
 
 /**
@@ -46,8 +54,8 @@ export abstract class TwoOperandInstruction extends Instruction {
  * indirect, inTag, and three UINT32s.
  */
 export abstract class ThreeOperandInstruction extends Instruction {
-  // Informs (de)serialization. See Instruction.deserialize.
-  static readonly wireFormat: OperandType[] = ThreeOperandWireFormat;
+  static readonly wireFormat8: OperandType[] = ThreeOperandWireFormat8;
+  static readonly wireFormat16: OperandType[] = ThreeOperandWireFormat16;
 
   constructor(
     protected indirect: number,