@aztec/simulator 0.0.1-commit.2eb6648a → 0.0.1-commit.2f68f620

package/src/public/avm/avm_contract_call_result.ts

@@ -1,69 +0,0 @@
-import type { SimulationError } from '@aztec/stdlib/errors';
-import { Gas } from '@aztec/stdlib/gas';
-
-import { inspect } from 'util';
-
-import { createSimulationError } from '../../common/errors.js';
-import type { Gas as AvmGas } from './avm_gas.js';
-import type { ReturnData } from './calldata.js';
-import type { AvmRevertReason } from './errors.js';
-
-/**
- * Results of an contract call's execution in the AVM.
- */
-export class AvmContractCallResult {
-  constructor(
-    public reverted: boolean,
-    public output: ReturnData,
-    public gasLeft: AvmGas,
-    public revertReason?: AvmRevertReason,
-    public totalInstructions: number = 0, // including nested calls
-  ) {}
-
-  toString(): string {
-    let resultsStr = `reverted: ${this.reverted}, output: ${this.output.bestEffortReadAll(10)}${this.output.length() > 10 ? ' ...' : ''}, gasLeft: ${inspect(
-      this.gasLeft,
-    )}, totalInstructions: ${this.totalInstructions}`;
-    if (this.revertReason) {
-      resultsStr += `, revertReason: ${this.revertReason.message}`;
-    }
-    return resultsStr;
-  }
-
-  finalize(): AvmFinalizedCallResult {
-    const revertReason = this.revertReason
-      ? createSimulationError(this.revertReason, this.output.bestEffortReadAll())
-      : undefined;
-    return new AvmFinalizedCallResult(
-      this.reverted,
-      this.output,
-      Gas.from(this.gasLeft),
-      revertReason,
-      this.totalInstructions,
-    );
-  }
-}
-
-/**
- * Similar to AvmContractCallResult, but with a SimulationError and standard Gas
- * which are useful for consumption external to core AVM simulation.
- */
-export class AvmFinalizedCallResult {
-  constructor(
-    public reverted: boolean,
-    public output: ReturnData,
-    public gasLeft: Gas,
-    public revertReason?: SimulationError,
-    public totalInstructions: number = 0, // including nested calls
-  ) {}
-
-  toString(): string {
-    let resultsStr = `reverted: ${this.reverted}, output: ${this.output.bestEffortReadAll(10)}${this.output.length() > 10 ? ' ...' : ''}, gasLeft: ${inspect(
-      this.gasLeft,
-    )}, totalInstructions: ${this.totalInstructions}`;
-    if (this.revertReason) {
-      resultsStr += `, revertReason: ${this.revertReason.message}`;
-    }
-    return resultsStr;
-  }
-}

package/src/public/avm/avm_execution_environment.ts

@@ -1,51 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import type { PublicSimulatorConfig } from '@aztec/stdlib/avm';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { GlobalVariables } from '@aztec/stdlib/tx';
-
-import type { CallData } from './calldata.js';
-
-/**
- * Contains variables that remain constant during AVM execution
- * These variables are provided by the public kernel circuit
- */
-export class AvmExecutionEnvironment {
-  constructor(
-    public readonly address: AztecAddress,
-    public readonly sender: AztecAddress,
-    public readonly contractCallDepth: Fr,
-    public readonly transactionFee: Fr,
-    public readonly globals: GlobalVariables,
-    public readonly isStaticCall: boolean,
-    public readonly calldata: CallData,
-    public readonly config: PublicSimulatorConfig,
-  ) {}
-
-  private deriveEnvironmentForNestedCallInternal(
-    targetAddress: AztecAddress,
-    calldata: CallData,
-    isStaticCall: boolean,
-  ): AvmExecutionEnvironment {
-    return new AvmExecutionEnvironment(
-      /*address=*/ targetAddress,
-      /*sender=*/ this.address,
-      this.contractCallDepth.add(Fr.ONE),
-      this.transactionFee,
-      this.globals,
-      isStaticCall,
-      calldata,
-      this.config,
-    );
-  }
-
-  public deriveEnvironmentForNestedCall(targetAddress: AztecAddress, calldata: CallData): AvmExecutionEnvironment {
-    return this.deriveEnvironmentForNestedCallInternal(targetAddress, calldata, /*isStaticCall=*/ false);
-  }
-
-  public deriveEnvironmentForNestedStaticCall(
-    targetAddress: AztecAddress,
-    calldata: CallData,
-  ): AvmExecutionEnvironment {
-    return this.deriveEnvironmentForNestedCallInternal(targetAddress, calldata, /*isStaticCall=*/ true);
-  }
-}

package/src/public/avm/avm_gas.ts

@@ -1,183 +0,0 @@
-import * as c from '@aztec/constants';
-
-import { TypeTag } from './avm_memory_types.js';
-import { InstructionExecutionError } from './errors.js';
-import { Opcode } from './serialization/instruction_serialization.js';
-
-/** Gas counters in L1, L2, and DA. */
-export type Gas = {
-  l2Gas: number;
-  daGas: number;
-};
-
-/** Maps a Gas struct to gasLeft properties. */
-export function gasToGasLeft(gas: Gas) {
-  return { l2GasLeft: gas.l2Gas, daGasLeft: gas.daGas };
-}
-
-/** Maps gasLeft properties to a gas struct. */
-export function gasLeftToGas(gasLeft: { l2GasLeft: number; daGasLeft: number }) {
-  return { l2Gas: gasLeft.l2GasLeft, daGas: gasLeft.daGasLeft };
-}
-
-/** Creates a new instance with all values set to zero except the ones set. */
-export function makeGas(gasCost: Partial<Gas>) {
-  return { ...EmptyGas, ...gasCost };
-}
-
-/** Sums together multiple instances of Gas. */
-export function sumGas(...gases: Partial<Gas>[]): Gas {
-  return gases.reduce<Gas>(
-    (acc, gas) => ({
-      l2Gas: acc.l2Gas + (gas.l2Gas ?? 0),
-      daGas: acc.daGas + (gas.daGas ?? 0),
-    }),
-    EmptyGas,
-  );
-}
-
-/** Multiplies a gas instance by a scalar. */
-export function mulGas(gas: Partial<Gas>, scalar: number) {
-  return { l2Gas: (gas.l2Gas ?? 0) * scalar, daGas: (gas.daGas ?? 0) * scalar };
-}
-
-/** Zero gas across all gas dimensions. */
-export const EmptyGas: Gas = {
-  l2Gas: 0,
-  daGas: 0,
-};
-
-function makeCost(l2Gas: number, daGas: number): Gas {
-  return { l2Gas, daGas };
-}
-
-/** Dimensions of gas usage: L1, L2, and DA. */
-export const GAS_DIMENSIONS = ['l2Gas', 'daGas'] as const;
-
-/** Base gas costs for each instruction. Additional gas cost may be added on top due to memory or storage accesses, etc. */
-const BASE_GAS_COSTS: Record<Opcode, Gas> = {
-  [Opcode.ADD_8]: makeCost(c.AVM_ADD_BASE_L2_GAS, 0),
-  [Opcode.ADD_16]: makeCost(c.AVM_ADD_BASE_L2_GAS, 0),
-  [Opcode.SUB_8]: makeCost(c.AVM_SUB_BASE_L2_GAS, 0),
-  [Opcode.SUB_16]: makeCost(c.AVM_SUB_BASE_L2_GAS, 0),
-  [Opcode.MUL_8]: makeCost(c.AVM_MUL_BASE_L2_GAS, 0),
-  [Opcode.MUL_16]: makeCost(c.AVM_MUL_BASE_L2_GAS, 0),
-  [Opcode.DIV_8]: makeCost(c.AVM_DIV_BASE_L2_GAS, 0),
-  [Opcode.DIV_16]: makeCost(c.AVM_DIV_BASE_L2_GAS, 0),
-  [Opcode.FDIV_8]: makeCost(c.AVM_FDIV_BASE_L2_GAS, 0),
-  [Opcode.FDIV_16]: makeCost(c.AVM_FDIV_BASE_L2_GAS, 0),
-  [Opcode.EQ_8]: makeCost(c.AVM_EQ_BASE_L2_GAS, 0),
-  [Opcode.EQ_16]: makeCost(c.AVM_EQ_BASE_L2_GAS, 0),
-  [Opcode.LT_8]: makeCost(c.AVM_LT_BASE_L2_GAS, 0),
-  [Opcode.LT_16]: makeCost(c.AVM_LT_BASE_L2_GAS, 0),
-  [Opcode.LTE_8]: makeCost(c.AVM_LTE_BASE_L2_GAS, 0),
-  [Opcode.LTE_16]: makeCost(c.AVM_LTE_BASE_L2_GAS, 0),
-  [Opcode.AND_8]: makeCost(c.AVM_AND_BASE_L2_GAS, 0),
-  [Opcode.AND_16]: makeCost(c.AVM_AND_BASE_L2_GAS, 0),
-  [Opcode.OR_8]: makeCost(c.AVM_OR_BASE_L2_GAS, 0),
-  [Opcode.OR_16]: makeCost(c.AVM_OR_BASE_L2_GAS, 0),
-  [Opcode.XOR_8]: makeCost(c.AVM_XOR_BASE_L2_GAS, 0),
-  [Opcode.XOR_16]: makeCost(c.AVM_XOR_BASE_L2_GAS, 0),
-  [Opcode.NOT_8]: makeCost(c.AVM_NOT_BASE_L2_GAS, 0),
-  [Opcode.NOT_16]: makeCost(c.AVM_NOT_BASE_L2_GAS, 0),
-  [Opcode.SHL_8]: makeCost(c.AVM_SHL_BASE_L2_GAS, 0),
-  [Opcode.SHL_16]: makeCost(c.AVM_SHL_BASE_L2_GAS, 0),
-  [Opcode.SHR_8]: makeCost(c.AVM_SHR_BASE_L2_GAS, 0),
-  [Opcode.SHR_16]: makeCost(c.AVM_SHR_BASE_L2_GAS, 0),
-  [Opcode.CAST_8]: makeCost(c.AVM_CAST_BASE_L2_GAS, 0),
-  [Opcode.CAST_16]: makeCost(c.AVM_CAST_BASE_L2_GAS, 0),
-  [Opcode.GETENVVAR_16]: makeCost(c.AVM_GETENVVAR_BASE_L2_GAS, 0),
-  [Opcode.CALLDATACOPY]: makeCost(c.AVM_CALLDATACOPY_BASE_L2_GAS, 0),
-  [Opcode.SUCCESSCOPY]: makeCost(c.AVM_SUCCESSCOPY_BASE_L2_GAS, 0),
-  [Opcode.RETURNDATASIZE]: makeCost(c.AVM_RETURNDATASIZE_BASE_L2_GAS, 0),
-  [Opcode.RETURNDATACOPY]: makeCost(c.AVM_RETURNDATACOPY_BASE_L2_GAS, 0),
-  [Opcode.JUMP_32]: makeCost(c.AVM_JUMP_BASE_L2_GAS, 0),
-  [Opcode.JUMPI_32]: makeCost(c.AVM_JUMPI_BASE_L2_GAS, 0),
-  [Opcode.INTERNALCALL]: makeCost(c.AVM_INTERNALCALL_BASE_L2_GAS, 0),
-  [Opcode.INTERNALRETURN]: makeCost(c.AVM_INTERNALRETURN_BASE_L2_GAS, 0),
-  [Opcode.SET_8]: makeCost(c.AVM_SET_BASE_L2_GAS, 0),
-  [Opcode.SET_16]: makeCost(c.AVM_SET_BASE_L2_GAS, 0),
-  [Opcode.SET_32]: makeCost(c.AVM_SET_BASE_L2_GAS, 0),
-  [Opcode.SET_64]: makeCost(c.AVM_SET_BASE_L2_GAS, 0),
-  [Opcode.SET_128]: makeCost(c.AVM_SET_BASE_L2_GAS, 0),
-  [Opcode.SET_FF]: makeCost(c.AVM_SET_BASE_L2_GAS, 0),
-  [Opcode.MOV_8]: makeCost(c.AVM_MOV_BASE_L2_GAS, 0),
-  [Opcode.MOV_16]: makeCost(c.AVM_MOV_BASE_L2_GAS, 0),
-  [Opcode.SLOAD]: makeCost(c.AVM_SLOAD_BASE_L2_GAS, 0),
-  [Opcode.SSTORE]: makeCost(c.AVM_SSTORE_BASE_L2_GAS, 0), // DA gas is dynamic
-  [Opcode.NOTEHASHEXISTS]: makeCost(c.AVM_NOTEHASHEXISTS_BASE_L2_GAS, 0),
-  [Opcode.EMITNOTEHASH]: makeCost(c.AVM_EMITNOTEHASH_BASE_L2_GAS, c.AVM_EMITNOTEHASH_BASE_DA_GAS),
-  [Opcode.NULLIFIEREXISTS]: makeCost(c.AVM_NULLIFIEREXISTS_BASE_L2_GAS, 0),
-  [Opcode.EMITNULLIFIER]: makeCost(c.AVM_EMITNULLIFIER_BASE_L2_GAS, c.AVM_EMITNULLIFIER_BASE_DA_GAS),
-  [Opcode.L1TOL2MSGEXISTS]: makeCost(c.AVM_L1TOL2MSGEXISTS_BASE_L2_GAS, 0),
-  [Opcode.EMITUNENCRYPTEDLOG]: makeCost(c.AVM_EMITUNENCRYPTEDLOG_BASE_L2_GAS, c.AVM_EMITUNENCRYPTEDLOG_BASE_DA_GAS),
-  [Opcode.SENDL2TOL1MSG]: makeCost(c.AVM_SENDL2TOL1MSG_BASE_L2_GAS, c.AVM_SENDL2TOL1MSG_BASE_DA_GAS),
-  [Opcode.GETCONTRACTINSTANCE]: makeCost(c.AVM_GETCONTRACTINSTANCE_BASE_L2_GAS, 0),
-  [Opcode.CALL]: makeCost(c.AVM_CALL_BASE_L2_GAS, 0),
-  [Opcode.STATICCALL]: makeCost(c.AVM_STATICCALL_BASE_L2_GAS, 0),
-  [Opcode.RETURN]: makeCost(c.AVM_RETURN_BASE_L2_GAS, 0),
-  [Opcode.REVERT_8]: makeCost(c.AVM_REVERT_BASE_L2_GAS, 0),
-  [Opcode.REVERT_16]: makeCost(c.AVM_REVERT_BASE_L2_GAS, 0),
-  [Opcode.DEBUGLOG]: makeCost(c.AVM_DEBUGLOG_BASE_L2_GAS, 0),
-  [Opcode.POSEIDON2]: makeCost(c.AVM_POSEIDON2_BASE_L2_GAS, 0),
-  [Opcode.SHA256COMPRESSION]: makeCost(c.AVM_SHA256COMPRESSION_BASE_L2_GAS, 0),
-  [Opcode.KECCAKF1600]: makeCost(c.AVM_KECCAKF1600_BASE_L2_GAS, 0),
-  [Opcode.ECADD]: makeCost(c.AVM_ECADD_BASE_L2_GAS, 0),
-  [Opcode.TORADIXBE]: makeCost(c.AVM_TORADIXBE_BASE_L2_GAS, 0),
-};
-
-const DYNAMIC_GAS_COSTS = new Map<Opcode, Gas>([
-  [Opcode.CALLDATACOPY, makeCost(c.AVM_CALLDATACOPY_DYN_L2_GAS, 0)],
-  [Opcode.RETURNDATACOPY, makeCost(c.AVM_RETURNDATACOPY_DYN_L2_GAS, 0)],
-  // TODO: Call and static call based on bytecode length
-  [Opcode.EMITUNENCRYPTEDLOG, makeCost(c.AVM_EMITUNENCRYPTEDLOG_DYN_L2_GAS, c.AVM_EMITUNENCRYPTEDLOG_DYN_DA_GAS)],
-  [Opcode.TORADIXBE, makeCost(c.AVM_TORADIXBE_DYN_L2_GAS, 0)],
-  [Opcode.AND_8, makeCost(c.AVM_BITWISE_DYN_L2_GAS, 0)],
-  [Opcode.AND_16, makeCost(c.AVM_BITWISE_DYN_L2_GAS, 0)],
-  [Opcode.OR_8, makeCost(c.AVM_BITWISE_DYN_L2_GAS, 0)],
-  [Opcode.OR_16, makeCost(c.AVM_BITWISE_DYN_L2_GAS, 0)],
-  [Opcode.XOR_8, makeCost(c.AVM_BITWISE_DYN_L2_GAS, 0)],
-  [Opcode.XOR_16, makeCost(c.AVM_BITWISE_DYN_L2_GAS, 0)],
-  [Opcode.SSTORE, makeCost(0, c.AVM_SSTORE_DYN_DA_GAS)],
-]);
-
-/** Returns the fixed base gas cost for a given opcode. */
-export function getBaseGasCost(opcode: Opcode): Gas {
-  return BASE_GAS_COSTS[opcode];
-}
-
-export function computeAddressingCost(indirectOperandsCount: number, relativeOperandsCount: number): Gas {
-  return makeCost(
-    (relativeOperandsCount !== 0 ? c.AVM_ADDRESSING_BASE_RESOLUTION_L2_GAS : 0) +
-      indirectOperandsCount * c.AVM_ADDRESSING_INDIRECT_L2_GAS +
-      relativeOperandsCount * c.AVM_ADDRESSING_RELATIVE_L2_GAS,
-    0,
-  );
-}
-
-export function getDynamicGasCost(opcode: Opcode): Gas {
-  return DYNAMIC_GAS_COSTS.has(opcode) ? DYNAMIC_GAS_COSTS.get(opcode)! : makeCost(0, 0);
-}
-
-/** Returns a multiplier based on the byte size of the type represented by the integer tag.
- * Used to account for necessary rows in the bitwise trace. Throws on invalid. */
-export function getBitwiseDynamicGasMultiplier(tag: TypeTag) {
-  switch (tag) {
-    case TypeTag.UINT1: // same as u8
-      return 1;
-    case TypeTag.UINT8:
-      return 1;
-    case TypeTag.UINT16:
-      return 2;
-    case TypeTag.UINT32:
-      return 4;
-    case TypeTag.UINT64:
-      return 8;
-    case TypeTag.UINT128:
-      return 16;
-    case TypeTag.FIELD:
-      return 0; // Field is not allowed for bitwise operations. However we don't fail in gas, since we'll fail in bitwise.
-    case TypeTag.INVALID:
-      throw new InstructionExecutionError(`Invalid tag type for gas cost multiplier: ${TypeTag[tag]}`);
-  }
-}

package/src/public/avm/avm_machine_state.ts

@@ -1,170 +0,0 @@
-import type { Fr } from '@aztec/foundation/curves/bn254';
-
-import type { Gas } from './avm_gas.js';
-import { TaggedMemory } from './avm_memory_types.js';
-import { type ReturnData, ReturnDataArray } from './calldata.js';
-import { type AvmRevertReason, OutOfGasError } from './errors.js';
-
-/**
- * A few fields of machine state are initialized from AVM session inputs or call instruction arguments
- */
-export type InitialAvmMachineState = {
-  l2GasLeft: number;
-  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.
- */
-export class AvmMachineState {
-  /** gas remaining of the gas allocated for a contract call */
-  public l2GasLeft: number;
-  public daGasLeft: number;
-  /** 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: ReturnData = new ReturnDataArray([]);
-  /** Tracks whether the last external call was successful */
-  public nestedCallSuccess: boolean = false;
-  /**
-   * 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 and the return pc.
-   * On INTERNALRETURN, value is popped from the internal call stack and assigned to the return pc.
-   */
-  public internalCallStack: CallStackEntry[] = [];
-
-  /** Memory accessible to user code */
-  public readonly memory: TaggedMemory = new TaggedMemory();
-
-  /**
-   * Signals that execution should end.
-   * AvmContext execution continues executing instructions until the machine state signals "halted"
-   */
-  private halted: boolean = false;
-  /** Signals that execution has reverted normally (this does not cover exceptional halts) */
-  private reverted: boolean = false;
-  /** Output data must NOT be modified once it is set */
-  private output: ReturnData = new ReturnDataArray([]);
-
-  // Metrics only - not needed for execution
-  /** instruction counter, including nested calls */
-  public instrCounter: number = 0;
-  // End metrics only
-
-  constructor(gasLeft: Gas);
-  constructor(l2GasLeft: number, daGasLeft: number);
-  constructor(gasLeftOrL2GasLeft: Gas | number, daGasLeft?: number) {
-    if (typeof gasLeftOrL2GasLeft === 'object') {
-      ({ l2Gas: this.l2GasLeft, daGas: this.daGasLeft } = gasLeftOrL2GasLeft);
-    } else {
-      this.l2GasLeft = gasLeftOrL2GasLeft!;
-      this.daGasLeft = daGasLeft!;
-    }
-  }
-
-  public get gasLeft(): Gas {
-    return { l2Gas: this.l2GasLeft, daGas: this.daGasLeft };
-  }
-
-  public static fromState(state: InitialAvmMachineState): AvmMachineState {
-    return new AvmMachineState(state.l2GasLeft, state.daGasLeft);
-  }
-
-  /**
-   * Consumes the given gas.
-   * Should any of the gas dimensions get depleted, it sets all gas left to zero and triggers
-   * an exceptional halt by throwing an OutOfGasError.
-   */
-  public consumeGas(gasCost: Partial<Gas>) {
-    // Assert there is enough gas on every dimension.
-    const outOfL2Gas = this.l2GasLeft - (gasCost.l2Gas ?? 0) < 0;
-    const outOfDaGas = this.daGasLeft - (gasCost.daGas ?? 0) < 0;
-    // If not, trigger an exceptional halt.
-    if (outOfL2Gas || outOfDaGas) {
-      this.exceptionalHalt();
-      const dimensions = [];
-      if (outOfL2Gas) {
-        dimensions.push('l2Gas');
-      }
-      if (outOfDaGas) {
-        dimensions.push('daGas');
-      }
-      throw new OutOfGasError(dimensions);
-    }
-    // Otherwise, charge the corresponding gas
-    this.l2GasLeft -= gasCost.l2Gas ?? 0;
-    this.daGasLeft -= gasCost.daGas ?? 0;
-  }
-
-  /** Increases the gas left by the amounts specified. */
-  public refundGas(gasRefund: Partial<Gas>) {
-    this.l2GasLeft += gasRefund.l2Gas ?? 0;
-    this.daGasLeft += gasRefund.daGas ?? 0;
-  }
-
-  /**
-   * Halt as successful
-   * Output data must NOT be modified once it is set
-   * @param output
-   */
-  public return(output: ReturnData) {
-    this.halted = true;
-    this.output = output;
-  }
-
-  /**
-   * Halt as reverted
-   * Output data must NOT be modified once it is set
-   * @param output
-   */
-  public revert(output: ReturnData) {
-    this.halted = true;
-    this.reverted = true;
-    this.output = output;
-  }
-
-  public getHalted(): boolean {
-    return this.halted;
-  }
-
-  public getReverted(): boolean {
-    return this.reverted;
-  }
-
-  public getOutput(): ReturnData {
-    return this.output;
-  }
-
-  /**
-   * Flag an exceptional halt. Clears gas left and sets the reverted flag. No output data.
-   */
-  private exceptionalHalt() {
-    this.l2GasLeft = 0;
-    this.daGasLeft = 0;
-    this.reverted = true;
-    this.halted = true;
-  }
-}