@aztec/simulator 0.0.0-test.1 → 0.0.1-commit.24de95ac

package/src/public/avm/fixtures/index.ts

@@ -1,296 +0,0 @@
-import {
-  DEPLOYER_CONTRACT_ADDRESS,
-  MAX_L2_GAS_PER_TX_PUBLIC_PORTION,
-  PUBLIC_DISPATCH_SELECTOR,
-} from '@aztec/constants';
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr } from '@aztec/foundation/fields';
-import { AvmGadgetsTestContractArtifact } from '@aztec/noir-contracts.js/AvmGadgetsTest';
-import { AvmTestContractArtifact } from '@aztec/noir-contracts.js/AvmTest';
-import { type ContractArtifact, type FunctionArtifact, FunctionSelector } from '@aztec/stdlib/abi';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import {
-  type ContractClassPublic,
-  type ContractInstanceWithAddress,
-  computeInitializationHash,
-} from '@aztec/stdlib/contract';
-import { isNoirCallStackUnresolved } from '@aztec/stdlib/errors';
-import { GasFees } from '@aztec/stdlib/gas';
-import { siloNullifier } from '@aztec/stdlib/hash';
-import type { MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server';
-import { makeContractClassPublic, makeContractInstanceFromClassId } from '@aztec/stdlib/testing';
-import { GlobalVariables } from '@aztec/stdlib/tx';
-
-import { strict as assert } from 'assert';
-import { mock } from 'jest-mock-extended';
-import merge from 'lodash.merge';
-
-import { resolveAssertionMessageFromRevertData, traverseCauseChain } from '../../../common/index.js';
-import type { WorldStateDB } from '../../public_db_sources.js';
-import type { PublicSideEffectTraceInterface } from '../../side_effect_trace_interface.js';
-import { AvmContext } from '../avm_context.js';
-import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
-import { AvmMachineState } from '../avm_machine_state.js';
-import { Field, Uint8, Uint32, Uint64 } from '../avm_memory_types.js';
-import { AvmSimulator } from '../avm_simulator.js';
-import type { AvmRevertReason } from '../errors.js';
-import { AvmPersistableStateManager } from '../journal/journal.js';
-import { NullifierManager } from '../journal/nullifiers.js';
-import { PublicStorage } from '../journal/public_storage.js';
-
-export const PUBLIC_DISPATCH_FN_NAME = 'public_dispatch';
-
-/**
- * Create a new AVM context with default values.
- */
-export function initContext(overrides?: {
-  persistableState?: AvmPersistableStateManager;
-  env?: AvmExecutionEnvironment;
-  machineState?: AvmMachineState;
-}): AvmContext {
-  const ctx = new AvmContext(
-    overrides?.persistableState || initPersistableStateManager(),
-    overrides?.env || initExecutionEnvironment(),
-    overrides?.machineState || initMachineState(),
-  );
-  ctx.provideSimulator = AvmSimulator.build;
-  return ctx;
-}
-
-/** Creates an empty state manager with mocked host storage. */
-export function initPersistableStateManager(overrides?: {
-  worldStateDB?: WorldStateDB;
-  trace?: PublicSideEffectTraceInterface;
-  publicStorage?: PublicStorage;
-  nullifiers?: NullifierManager;
-  doMerkleOperations?: boolean;
-  db?: MerkleTreeWriteOperations;
-  firstNullifier?: Fr;
-}): AvmPersistableStateManager {
-  const worldStateDB = overrides?.worldStateDB || mock<WorldStateDB>();
-  return new AvmPersistableStateManager(
-    worldStateDB,
-    overrides?.trace || mock<PublicSideEffectTraceInterface>(),
-    overrides?.publicStorage || new PublicStorage(worldStateDB),
-    overrides?.nullifiers || new NullifierManager(worldStateDB),
-    overrides?.doMerkleOperations || false,
-    overrides?.db || mock<MerkleTreeWriteOperations>(),
-    overrides?.firstNullifier || new Fr(27),
-  );
-}
-
-/**
- * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
- */
-export function initExecutionEnvironment(overrides?: Partial<AvmExecutionEnvironment>): AvmExecutionEnvironment {
-  return new AvmExecutionEnvironment(
-    overrides?.address ?? AztecAddress.zero(),
-    overrides?.sender ?? AztecAddress.zero(),
-    overrides?.contractCallDepth ?? Fr.zero(),
-    overrides?.transactionFee ?? Fr.zero(),
-    overrides?.globals ?? GlobalVariables.empty(),
-    overrides?.isStaticCall ?? false,
-    overrides?.calldata ?? [],
-  );
-}
-
-/**
- * Create an empty instance of the Execution Environment where all values are zero, unless overridden in the overrides object
- */
-export function initGlobalVariables(overrides?: Partial<GlobalVariables>): GlobalVariables {
-  return new GlobalVariables(
-    overrides?.chainId ?? Fr.zero(),
-    overrides?.version ?? Fr.zero(),
-    overrides?.blockNumber ?? Fr.zero(),
-    overrides?.slotNumber ?? Fr.zero(),
-    overrides?.timestamp ?? Fr.zero(),
-    overrides?.coinbase ?? EthAddress.ZERO,
-    overrides?.feeRecipient ?? AztecAddress.zero(),
-    overrides?.gasFees ?? GasFees.empty(),
-  );
-}
-
-/**
- * Create an empty instance of the Machine State where all values are set to a large enough amount, unless overridden in the overrides object
- */
-export function initMachineState(overrides?: Partial<AvmMachineState>): AvmMachineState {
-  return AvmMachineState.fromState({
-    l2GasLeft: overrides?.l2GasLeft ?? MAX_L2_GAS_PER_TX_PUBLIC_PORTION,
-    daGasLeft: overrides?.daGasLeft ?? 1e8,
-  });
-}
-
-/**
- * Create a new object with all the same properties as the original, except for the ones in the overrides object.
- */
-export function allSameExcept(original: any, overrides: any): any {
-  return merge({}, original, overrides);
-}
-
-export function randomMemoryBytes(length: number): Uint8[] {
-  return [...Array(length)].map(_ => new Uint8(Math.floor(Math.random() * 255)));
-}
-
-export function randomMemoryUint32s(length: number): Uint32[] {
-  return [...Array(length)].map(_ => new Uint32(Math.floor(Math.random() * 255)));
-}
-
-export function randomMemoryUint64s(length: number): Uint64[] {
-  return [...Array(length)].map(_ => new Uint64(Math.floor(Math.random() * 255)));
-}
-
-export function randomMemoryFields(length: number): Field[] {
-  return [...Array(length)].map(_ => new Field(Fr.random()));
-}
-
-export function getFunctionSelector(
-  functionName: string,
-  contractArtifact: ContractArtifact,
-): Promise<FunctionSelector> {
-  const fnArtifact = contractArtifact.functions.find(f => f.name === functionName)!;
-  assert(!!fnArtifact, `Function ${functionName} not found in ${contractArtifact.name}`);
-  const params = fnArtifact.parameters;
-  return FunctionSelector.fromNameAndParameters(fnArtifact.name, params);
-}
-
-export function getContractFunctionArtifact(
-  functionName: string,
-  contractArtifact: ContractArtifact,
-): FunctionArtifact | undefined {
-  const artifact = contractArtifact.functions.find(f => f.name === functionName)!;
-  if (!artifact) {
-    return undefined;
-  }
-  return artifact;
-}
-
-export function resolveContractAssertionMessage(
-  functionName: string,
-  revertReason: AvmRevertReason,
-  output: Fr[],
-  contractArtifact: ContractArtifact,
-): string | undefined {
-  traverseCauseChain(revertReason, cause => {
-    revertReason = cause as AvmRevertReason;
-  });
-
-  const functionArtifact = contractArtifact.functions.find(f => f.name === functionName);
-  if (!functionArtifact || !revertReason.noirCallStack || !isNoirCallStackUnresolved(revertReason.noirCallStack)) {
-    return undefined;
-  }
-
-  return resolveAssertionMessageFromRevertData(output, functionArtifact);
-}
-
-export function getAvmTestContractFunctionSelector(functionName: string): Promise<FunctionSelector> {
-  return getFunctionSelector(functionName, AvmTestContractArtifact);
-}
-
-export function getAvmGadgetsTestContractFunctionSelector(functionName: string): Promise<FunctionSelector> {
-  const artifact = AvmGadgetsTestContractArtifact.functions.find(f => f.name === functionName)!;
-  assert(!!artifact, `Function ${functionName} not found in AvmGadgetsTestContractArtifact`);
-  const params = artifact.parameters;
-  return FunctionSelector.fromNameAndParameters(artifact.name, params);
-}
-
-export function getAvmTestContractArtifact(functionName: string): FunctionArtifact {
-  const artifact = getContractFunctionArtifact(functionName, AvmTestContractArtifact);
-  assert(
-    !!artifact?.bytecode,
-    `No bytecode found for function ${functionName}. Try re-running bootstrap.sh on the repository root.`,
-  );
-  return artifact;
-}
-
-export function getAvmGadgetsTestContractArtifact(functionName: string): FunctionArtifact {
-  const artifact = AvmGadgetsTestContractArtifact.functions.find(f => f.name === functionName)!;
-  assert(
-    !!artifact?.bytecode,
-    `No bytecode found for function ${functionName}. Try re-running bootstrap.sh on the repository root.`,
-  );
-  return artifact;
-}
-
-export function getAvmTestContractBytecode(functionName: string): Buffer {
-  const artifact = getAvmTestContractArtifact(functionName);
-  return artifact.bytecode;
-}
-
-export function getAvmGadgetsTestContractBytecode(functionName: string): Buffer {
-  const artifact = getAvmGadgetsTestContractArtifact(functionName);
-  return artifact.bytecode;
-}
-
-export function resolveAvmTestContractAssertionMessage(
-  functionName: string,
-  revertReason: AvmRevertReason,
-  output: Fr[],
-): string | undefined {
-  return resolveContractAssertionMessage(functionName, revertReason, output, AvmTestContractArtifact);
-}
-
-export function resolveAvmGadgetsTestContractAssertionMessage(
-  functionName: string,
-  revertReason: AvmRevertReason,
-  output: Fr[],
-): string | undefined {
-  traverseCauseChain(revertReason, cause => {
-    revertReason = cause as AvmRevertReason;
-  });
-
-  const functionArtifact = AvmGadgetsTestContractArtifact.functions.find(f => f.name === functionName);
-  if (!functionArtifact || !revertReason.noirCallStack || !isNoirCallStackUnresolved(revertReason.noirCallStack)) {
-    return undefined;
-  }
-
-  return resolveAssertionMessageFromRevertData(output, functionArtifact);
-}
-
-/**
- * Create a contract class and instance given constructor args, artifact, etc.
- * NOTE: This is useful for testing real-ish contract class registration and instance deployment TXs (via logs)
- * @param constructorArgs - The constructor arguments for the contract.
- * @param deployer - The deployer of the contract.
- * @param contractArtifact - The contract artifact for the contract.
- * @param seed - The seed for the contract.
- * @param originalContractClassId - The original contract class ID (if upgraded)
- * @returns The contract class, instance, and contract address nullifier.
- */
-export async function createContractClassAndInstance(
-  constructorArgs: any[],
-  deployer: AztecAddress,
-  contractArtifact: ContractArtifact,
-  seed = 0,
-  originalContractClassId?: Fr, // if previously upgraded
-): Promise<{
-  contractClass: ContractClassPublic;
-  contractInstance: ContractInstanceWithAddress;
-  contractAddressNullifier: Fr;
-}> {
-  const bytecode = getContractFunctionArtifact(PUBLIC_DISPATCH_FN_NAME, contractArtifact)!.bytecode;
-  const contractClass = await makeContractClassPublic(
-    seed,
-    /*publicDispatchFunction=*/ { bytecode, selector: new FunctionSelector(PUBLIC_DISPATCH_SELECTOR) },
-  );
-
-  const constructorAbi = getContractFunctionArtifact('constructor', contractArtifact);
-  const initializationHash = await computeInitializationHash(constructorAbi, constructorArgs);
-  const contractInstance =
-    originalContractClassId === undefined
-      ? await makeContractInstanceFromClassId(contractClass.id, seed, {
-          deployer,
-          initializationHash,
-        })
-      : await makeContractInstanceFromClassId(originalContractClassId, seed, {
-          deployer,
-          initializationHash,
-          currentClassId: contractClass.id,
-        });
-
-  const contractAddressNullifier = await siloNullifier(
-    AztecAddress.fromNumber(DEPLOYER_CONTRACT_ADDRESS),
-    contractInstance.address.toField(),
-  );
-
-  return { contractClass, contractInstance, contractAddressNullifier };
-}

package/src/public/avm/journal/index.ts

@@ -1 +0,0 @@
-export * from './journal.js';