@aztec/simulator 0.24.0 → 0.26.1

package/src/acvm/oracle/typed_oracle.ts

@@ -1,6 +1,5 @@
 import {
   CompleteAddress,
-  L1ToL2Message,
   MerkleTreeId,
   Note,
   NoteStatus,
@@ -21,6 +20,7 @@ import { FunctionSelector } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
+import { ContractInstance } from '@aztec/types/contracts';
 
 /**
  * A pair of public key and secret key.
@@ -58,8 +58,6 @@ export interface NoteData {
 
 export class MessageLoadOracleInputs<N extends number> {
   constructor(
-    /** The message. */
-    public message: L1ToL2Message,
     /** The index of the message commitment in the merkle tree. */
     public index: bigint,
     /** The path in the merkle tree to the message. */
@@ -67,7 +65,7 @@ export class MessageLoadOracleInputs<N extends number> {
   ) {}
 
   toFields(): Fr[] {
-    return [...this.message.toFields(), new Fr(this.index), ...this.siblingPath.toFields()];
+    return [new Fr(this.index), ...this.siblingPath.toFields()];
   }
 }
 
@@ -93,6 +91,10 @@ export abstract class TypedOracle {
     throw new Error('Not available.');
   }
 
+  getContractInstance(_address: AztecAddress): Promise<ContractInstance> {
+    throw new Error('Not available.');
+  }
+
   getMembershipWitness(_blockNumber: number, _treeId: MerkleTreeId, _leafValue: Fr): Promise<Fr[] | undefined> {
     throw new Error('Not available.');
   }
@@ -159,7 +161,7 @@ export abstract class TypedOracle {
     throw new Error('Not available.');
   }
 
-  getL1ToL2Message(_msgKey: Fr): Promise<MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT>> {
+  getL1ToL2MembershipWitness(_entryKey: Fr): Promise<MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT>> {
     throw new Error('Not available.');
   }
 
@@ -194,6 +196,8 @@ export abstract class TypedOracle {
     _functionSelector: FunctionSelector,
     _argsHash: Fr,
     _sideffectCounter: number,
+    _isStaticCall: boolean,
+    _isDelegateCall: boolean,
   ): Promise<PrivateCallStackItem> {
     throw new Error('Not available.');
   }
@@ -202,6 +206,8 @@ export abstract class TypedOracle {
     _targetContractAddress: AztecAddress,
     _functionSelector: FunctionSelector,
     _argsHash: Fr,
+    _isStaticCall: boolean,
+    _isDelegateCall: boolean,
   ): Promise<Fr[]> {
     throw new Error('Not available.');
   }
@@ -211,6 +217,8 @@ export abstract class TypedOracle {
     _functionSelector: FunctionSelector,
     _argsHash: Fr,
     _sideffectCounter: number,
+    _isStaticCall: boolean,
+    _isDelegateCall: boolean,
   ): Promise<PublicCallRequest> {
     throw new Error('Not available.');
   }

package/src/avm/avm_context.ts

@@ -3,7 +3,7 @@ import { Fr } from '@aztec/foundation/fields';
 
 import { AvmExecutionEnvironment } from './avm_execution_environment.js';
 import { AvmMachineState } from './avm_machine_state.js';
-import { AvmWorldStateJournal } from './journal/journal.js';
+import { AvmPersistableStateManager } from './journal/journal.js';
 
 /**
  * An execution context includes the information necessary to initiate AVM
@@ -12,13 +12,13 @@ import { AvmWorldStateJournal } from './journal/journal.js';
 export class AvmContext {
   /**
    * Create a new AVM context
-   * @param worldState - Manages mutable state during execution - (caching, fetching)
+   * @param persistableState - Manages world state and accrued substate during execution - (caching, fetching, tracing)
    * @param environment - Contains constant variables provided by the kernel
    * @param machineState - VM state that is modified on an instruction-by-instruction basis
    * @returns new AvmContext instance
    */
   constructor(
-    public worldState: AvmWorldStateJournal,
+    public persistableState: AvmPersistableStateManager,
     public environment: AvmExecutionEnvironment,
     public machineState: AvmMachineState,
   ) {}
@@ -37,7 +37,7 @@ export class AvmContext {
    */
   public createNestedContractCallContext(address: AztecAddress, calldata: Fr[]): AvmContext {
     const newExecutionEnvironment = this.environment.deriveEnvironmentForNestedCall(address, calldata);
-    const forkedWorldState = this.worldState.fork();
+    const forkedWorldState = this.persistableState.fork();
     const machineState = AvmMachineState.fromState(this.machineState);
     return new AvmContext(forkedWorldState, newExecutionEnvironment, machineState);
   }
@@ -56,7 +56,7 @@ export class AvmContext {
    */
   public createNestedContractStaticCallContext(address: AztecAddress, calldata: Fr[]): AvmContext {
     const newExecutionEnvironment = this.environment.deriveEnvironmentForNestedStaticCall(address, calldata);
-    const forkedWorldState = this.worldState.fork();
+    const forkedWorldState = this.persistableState.fork();
     const machineState = AvmMachineState.fromState(this.machineState);
     return new AvmContext(forkedWorldState, newExecutionEnvironment, machineState);
   }

package/src/avm/avm_memory_types.ts

@@ -1,3 +1,4 @@
+import { toBufferBE } from '@aztec/foundation/bigint-buffer';
 import { Fr } from '@aztec/foundation/fields';
 
 import { strict as assert } from 'assert';
@@ -12,6 +13,7 @@ export abstract class MemoryValue {
   public abstract div(rhs: MemoryValue): MemoryValue;
 
   public abstract equals(rhs: MemoryValue): boolean;
+  public abstract lt(rhs: MemoryValue): boolean;
 
   // We need this to be able to build an instance of the subclasses.
   public abstract build(n: bigint): MemoryValue;
@@ -19,6 +21,9 @@ export abstract class MemoryValue {
   // Use sparingly.
   public abstract toBigInt(): bigint;
 
+  // To Buffer
+  public abstract toBuffer(): Buffer;
+
   // To field
   public toFr(): Fr {
     return new Fr(this.toBigInt());
@@ -33,8 +38,6 @@ export abstract class IntegralValue extends MemoryValue {
   public abstract or(rhs: IntegralValue): IntegralValue;
   public abstract xor(rhs: IntegralValue): IntegralValue;
   public abstract not(): IntegralValue;
-
-  public abstract lt(rhs: IntegralValue): boolean;
 }
 
 /**
@@ -111,6 +114,10 @@ function UnsignedIntegerClassFactory(bits: number) {
     public toBigInt(): bigint {
       return this.n;
     }
+
+    public toBuffer(): Buffer {
+      return toBufferBE(this.n, bits / 8);
+    }
   };
 }
 
@@ -127,7 +134,7 @@ export class Field extends MemoryValue {
   public static readonly MODULUS: bigint = Fr.MODULUS;
   private readonly rep: Fr;
 
-  constructor(v: number | bigint | Fr) {
+  constructor(v: number | bigint | Fr | Buffer) {
     super();
     this.rep = new Fr(v);
   }
@@ -156,9 +163,17 @@ export class Field extends MemoryValue {
     return this.rep.equals(rhs.rep);
   }
 
+  public lt(rhs: Field): boolean {
+    return this.rep.lt(rhs.rep);
+  }
+
   public toBigInt(): bigint {
     return this.rep.toBigInt();
   }
+
+  public toBuffer(): Buffer {
+    return this.rep.toBuffer();
+  }
 }
 
 export enum TypeTag {

package/src/avm/avm_simulator.ts

@@ -17,8 +17,27 @@ export class AvmSimulator {
    * Fetch the bytecode and execute it in the current context.
    */
   public async execute(): Promise<AvmContractCallResults> {
-    const instructions = await this.fetchAndDecodeBytecode();
-    return this.executeInstructions(instructions);
+    const selector = this.context.environment.temporaryFunctionSelector;
+    const bytecode = await this.context.persistableState.hostStorage.contractsDb.getBytecode(
+      this.context.environment.address,
+      selector,
+    );
+
+    // This assumes that we will not be able to send messages to accounts without code
+    // Pending classes and instances impl details
+    if (!bytecode) {
+      throw new NoBytecodeForContractError(this.context.environment.address);
+    }
+
+    return await this.executeBytecode(bytecode);
+  }
+
+  /**
+   * Executes the provided bytecode in the current context.
+   * This method is useful for testing and debugging.
+   */
+  public async executeBytecode(bytecode: Buffer): Promise<AvmContractCallResults> {
+    return await this.executeInstructions(decodeFromBytecode(bytecode));
   }
 
   /**
@@ -35,7 +54,7 @@ export class AvmSimulator {
         const instruction = instructions[this.context.machineState.pc];
         assert(!!instruction); // This should never happen
 
-        this.log(`Executing PC=${this.context.machineState.pc}: ${instruction.toString()}`);
+        this.log.debug(`@${this.context.machineState.pc} ${instruction.toString()}`);
         // Execute the instruction.
         // Normal returns and reverts will return normally here.
         // "Exceptional halts" will throw.
@@ -65,25 +84,4 @@ export class AvmSimulator {
       return results;
     }
   }
-
-  /**
-   * Fetch contract bytecode from world state and decode into executable instructions.
-   */
-  private async fetchAndDecodeBytecode(): Promise<Instruction[]> {
-    // NOTE: the following is mocked as getPublicBytecode does not exist yet
-
-    const selector = this.context.environment.temporaryFunctionSelector;
-    const bytecode = await this.context.worldState.hostStorage.contractsDb.getBytecode(
-      this.context.environment.address,
-      selector,
-    );
-
-    // This assumes that we will not be able to send messages to accounts without code
-    // Pending classes and instances impl details
-    if (!bytecode) {
-      throw new NoBytecodeForContractError(this.context.environment.address);
-    }
-
-    return decodeFromBytecode(bytecode);
-  }
 }

package/src/avm/fixtures/index.ts

@@ -1,4 +1,5 @@
-import { GlobalVariables } from '@aztec/circuits.js';
+import { SiblingPath } from '@aztec/circuit-types';
+import { GlobalVariables, L1_TO_L2_MSG_TREE_HEIGHT } from '@aztec/circuits.js';
 import { FunctionSelector } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
@@ -7,32 +8,44 @@ import { Fr } from '@aztec/foundation/fields';
 import { mock } from 'jest-mock-extended';
 import merge from 'lodash.merge';
 
-import { CommitmentsDB, PublicContractsDB, PublicStateDB } from '../../index.js';
+import { CommitmentsDB, MessageLoadOracleInputs, PublicContractsDB, PublicStateDB } from '../../index.js';
 import { AvmContext } from '../avm_context.js';
 import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
 import { AvmMachineState } from '../avm_machine_state.js';
 import { HostStorage } from '../journal/host_storage.js';
-import { AvmWorldStateJournal } from '../journal/journal.js';
+import { AvmPersistableStateManager } from '../journal/journal.js';
 
 /**
  * Create a new AVM context with default values.
  */
 export function initContext(overrides?: {
-  worldState?: AvmWorldStateJournal;
+  persistableState?: AvmPersistableStateManager;
   env?: AvmExecutionEnvironment;
   machineState?: AvmMachineState;
 }): AvmContext {
   return new AvmContext(
-    overrides?.worldState || initMockWorldStateJournal(),
+    overrides?.persistableState || initMockPersistableStateManager(),
     overrides?.env || initExecutionEnvironment(),
     overrides?.machineState || initMachineState(),
   );
 }
 
-/** Creates an empty world state with mocked storage. */
-export function initMockWorldStateJournal(): AvmWorldStateJournal {
-  const hostStorage = new HostStorage(mock<PublicStateDB>(), mock<PublicContractsDB>(), mock<CommitmentsDB>());
-  return new AvmWorldStateJournal(hostStorage);
+/** Creates an empty host storage with mocked dbs. */
+export function initHostStorage(overrides?: {
+  publicDb?: PublicStateDB;
+  contractsDb?: PublicContractsDB;
+  commitmentsDb?: CommitmentsDB;
+}): HostStorage {
+  return new HostStorage(
+    overrides?.publicDb || mock<PublicStateDB>(),
+    overrides?.contractsDb || mock<PublicContractsDB>(),
+    overrides?.commitmentsDb || mock<CommitmentsDB>(),
+  );
+}
+
+/** Creates an empty state manager with mocked storage. */
+export function initMockPersistableStateManager(): AvmPersistableStateManager {
+  return new AvmPersistableStateManager(initHostStorage());
 }
 
 /**
@@ -88,3 +101,15 @@ export function initMachineState(overrides?: Partial<AvmMachineState>): AvmMachi
 export function allSameExcept(original: any, overrides: any): any {
   return merge({}, original, overrides);
 }
+
+/**
+ * Create an empty L1ToL2Message oracle input
+ */
+export function initL1ToL2MessageOracleInput(
+  leafIndex?: bigint,
+): MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT> {
+  return new MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT>(
+    leafIndex ?? 0n,
+    new SiblingPath(L1_TO_L2_MSG_TREE_HEIGHT, Array(L1_TO_L2_MSG_TREE_HEIGHT)),
+  );
+}

package/src/avm/journal/host_storage.ts

@@ -6,15 +6,9 @@ import { CommitmentsDB, PublicContractsDB, PublicStateDB } from '../../public/db
  * A wrapper around the node dbs
  */
 export class HostStorage {
-  public readonly publicStateDb: PublicStateDB;
-
-  public readonly contractsDb: PublicContractsDB;
-
-  public readonly commitmentsDb: CommitmentsDB;
-
-  constructor(publicStateDb: PublicStateDB, contractsDb: PublicContractsDB, commitmentsDb: CommitmentsDB) {
-    this.publicStateDb = publicStateDb;
-    this.contractsDb = contractsDb;
-    this.commitmentsDb = commitmentsDb;
-  }
+  constructor(
+    public readonly publicStateDb: PublicStateDB,
+    public readonly contractsDb: PublicContractsDB,
+    public readonly commitmentsDb: CommitmentsDB,
+  ) {}
 }