@aztec/simulator 0.0.0-test.1 → 0.0.1-commit.5476d83

package/src/public/avm/opcodes/.eslintrc.cjs

@@ -1,8 +0,0 @@
-const baseConfig = require('@aztec/foundation/eslint');
-module.exports = {
-  ...baseConfig,
-  rules: {
-    ...baseConfig.rules,
-    'require-await': 'off',
-  },
-};

package/src/public/bytecode_errors.ts

@@ -1,6 +0,0 @@
-export class ContractClassBytecodeError extends Error {
-  constructor(contractAddress: string) {
-    super(`Failed to get bytecode for contract at address ${contractAddress}`);
-    this.name = 'ContractClassBytecodeError';
-  }
-}

package/src/public/execution.ts

@@ -1,140 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-import {
-  type AvmExecutionHints,
-  type ContractStorageRead,
-  type ContractStorageUpdateRequest,
-  PublicCallStackItemCompressed,
-  type PublicDataUpdateRequest,
-  PublicInnerCallRequest,
-  RevertCode,
-} from '@aztec/stdlib/avm';
-import type { SimulationError } from '@aztec/stdlib/errors';
-import { Gas } from '@aztec/stdlib/gas';
-import { computeVarArgsHash } from '@aztec/stdlib/hash';
-import type { NoteHash, Nullifier, ReadRequest, TreeLeafReadRequest } from '@aztec/stdlib/kernel';
-import type { PublicLog } from '@aztec/stdlib/logs';
-import type { L2ToL1Message, ScopedL2ToL1Message } from '@aztec/stdlib/messaging';
-import type { PublicExecutionRequest } from '@aztec/stdlib/tx';
-
-export interface PublicSideEffects {
-  /** The contract storage update requests performed. */
-  publicDataWrites: PublicDataUpdateRequest[];
-  /** The new note hashes to be inserted into the note hashes tree. */
-  noteHashes: NoteHash[];
-  /** The new nullifiers to be inserted into the nullifier tree. */
-  nullifiers: Nullifier[];
-  /** The new l2 to l1 messages generated to be inserted into the messages tree. */
-  l2ToL1Messages: ScopedL2ToL1Message[];
-  /** Public logs emitted during execution. */
-  publicLogs: PublicLog[];
-}
-
-export interface EnqueuedPublicCallExecutionResult {
-  /** How much gas was left after this public execution. */
-  endGasLeft: Gas;
-  /** The side effect counter after execution */
-  endSideEffectCounter: Fr;
-
-  /** The return values of the function. */
-  returnValues: Fr[];
-  /** Whether the execution reverted. */
-  reverted: boolean;
-  /** The revert reason if the execution reverted. */
-  revertReason?: SimulationError;
-}
-
-export interface EnqueuedPublicCallExecutionResultWithSideEffects {
-  /** How much gas was left after this public execution. */
-  endGasLeft: Gas;
-  /** The side effect counter after execution */
-  endSideEffectCounter: Fr;
-
-  /** The return values of the function. */
-  returnValues: Fr[];
-  /** Whether the execution reverted. */
-  reverted: boolean;
-  /** The revert reason if the execution reverted. */
-  revertReason?: SimulationError;
-
-  /** The public side effects of the function. */
-  sideEffects: PublicSideEffects;
-}
-
-/**
- * The public function execution result.
- */
-export interface PublicFunctionCallResult {
-  /** The execution request that triggered this result. */
-  executionRequest: PublicExecutionRequest;
-
-  /** The side effect counter at the start of the function call. */
-  startSideEffectCounter: Fr;
-  /** The side effect counter after executing this function call */
-  endSideEffectCounter: Fr;
-  /** How much gas was available for this public execution. */
-  startGasLeft: Gas;
-  /** How much gas was left after this public execution. */
-  endGasLeft: Gas;
-  /** Transaction fee set for this tx. */
-  transactionFee: Fr;
-
-  /** Bytecode used for this execution. */
-  bytecode?: Buffer;
-  /** Calldata used for this execution. */
-  calldata: Fr[];
-  /** The return values of the function. */
-  returnValues: Fr[];
-  /** Whether the execution reverted. */
-  reverted: boolean;
-  /** The revert reason if the execution reverted. */
-  revertReason?: SimulationError;
-
-  /** The contract storage reads performed by the function. */
-  contractStorageReads: ContractStorageRead[];
-  /** The contract storage update requests performed by the function. */
-  contractStorageUpdateRequests: ContractStorageUpdateRequest[];
-  /** The new note hashes to be inserted into the note hashes tree. */
-  noteHashes: NoteHash[];
-  /** The new l2 to l1 messages generated in this call. */
-  l2ToL1Messages: L2ToL1Message[];
-  /** The new nullifiers to be inserted into the nullifier tree. */
-  nullifiers: Nullifier[];
-  /** The note hash read requests emitted in this call. */
-  noteHashReadRequests: TreeLeafReadRequest[];
-  /** The nullifier read requests emitted in this call. */
-  nullifierReadRequests: ReadRequest[];
-  /** The nullifier non existent read requests emitted in this call. */
-  nullifierNonExistentReadRequests: ReadRequest[];
-  /** L1 to L2 message read requests emitted in this call. */
-  l1ToL2MsgReadRequests: TreeLeafReadRequest[];
-  /**
-   * The public logs emitted in this call.
-   * Note: PublicLog has no counter - unsure if this is needed bc this struct is unused
-   */
-  publicLogs: PublicLog[];
-  /** The requests to call public functions made by this call. */
-  publicCallRequests: PublicInnerCallRequest[];
-  /** The results of nested calls. */
-  nestedExecutions: this[];
-
-  /** Hints for proving AVM execution. */
-  avmCircuitHints: AvmExecutionHints;
-
-  /** The name of the function that was executed. Only used for logging. */
-  functionName: string;
-}
-
-export async function resultToPublicCallRequest(result: PublicFunctionCallResult) {
-  const request = result.executionRequest;
-  const item = new PublicCallStackItemCompressed(
-    request.callContext.contractAddress,
-    request.callContext,
-    await computeVarArgsHash(request.args),
-    await computeVarArgsHash(result.returnValues),
-    // TODO(@just-mitch): need better mapping from simulator to revert code.
-    result.reverted ? RevertCode.APP_LOGIC_REVERTED : RevertCode.OK,
-    Gas.from(result.startGasLeft),
-    Gas.from(result.endGasLeft),
-  );
-  return new PublicInnerCallRequest(item, result.startSideEffectCounter.toNumber());
-}

package/src/public/tx_contract_cache.ts

@@ -1,69 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { ContractClassPublic, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-
-/**
- * A cache for contract classes and instances for a single transaction.
- * Useful for tracking/retrieving contracts for a tx while leaving
- * the option to clear them if the tx is reverted.
- */
-export class TxContractCache {
-  private instanceCache = new Map<string, ContractInstanceWithAddress>();
-  private classCache = new Map<string, ContractClassPublic>();
-
-  /**
-   * Add a contract instance to the cache
-   */
-  public addInstance(address: AztecAddress, instance: ContractInstanceWithAddress): void {
-    this.instanceCache.set(address.toString(), instance);
-  }
-
-  /**
-   * Add a contract class to the cache
-   */
-  public addClass(classId: Fr, contractClass: ContractClassPublic): void {
-    this.classCache.set(classId.toString(), contractClass);
-  }
-
-  /**
-   * Get a contract instance from the cache
-   */
-  public getInstance(address: AztecAddress): ContractInstanceWithAddress | undefined {
-    return this.instanceCache.get(address.toString());
-  }
-
-  /**
-   * Get a contract class from the cache
-   */
-  public getClass(classId: Fr): ContractClassPublic | undefined {
-    return this.classCache.get(classId.toString());
-  }
-
-  /**
-   * Check if the cache has a contract class
-   */
-  public hasClass(classId: Fr): boolean {
-    return this.classCache.has(classId.toString());
-  }
-
-  /**
-   * Clear all entries from the cache
-   */
-  public clear(): void {
-    this.instanceCache.clear();
-    this.classCache.clear();
-  }
-
-  /**
-   * Merge another cache into this one
-   */
-  public mergeFrom(other: TxContractCache): void {
-    other.instanceCache.forEach((value, key) => {
-      this.instanceCache.set(key, value);
-    });
-
-    other.classCache.forEach((value, key) => {
-      this.classCache.set(key, value);
-    });
-  }
-}

package/src/test/utils.ts

@@ -1,36 +0,0 @@
-import { sha256ToField } from '@aztec/foundation/crypto';
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr } from '@aztec/foundation/fields';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { computeSecretHash } from '@aztec/stdlib/hash';
-import { L1Actor, L1ToL2Message, L2Actor } from '@aztec/stdlib/messaging';
-
-/**
- * Test utility function to craft an L1 to L2 message.
- * @param selector - The cross chain message selector.
- * @param contentPreimage - The args after the selector.
- * @param targetContract - The contract to consume the message.
- * @param secret - The secret to unlock the message.
- * @returns The L1 to L2 message.
- */
-export const buildL1ToL2Message = async (
-  selector: string,
-  contentPreimage: Fr[],
-  targetContract: AztecAddress,
-  secret: Fr,
-  msgIndex: Fr | number,
-) => {
-  // Write the selector into a buffer.
-  const selectorBuf = Buffer.from(selector, 'hex');
-
-  const content = sha256ToField([selectorBuf, ...contentPreimage]);
-  const secretHash = await computeSecretHash(secret);
-
-  return new L1ToL2Message(
-    new L1Actor(EthAddress.random(), 1),
-    new L2Actor(targetContract, 1),
-    content,
-    secretHash,
-    new Fr(msgIndex),
-  );
-};