@aztec/simulator 0.0.0-test.0

package/src/private/unconstrained_execution_oracle.ts

@@ -0,0 +1,373 @@
+import { Aes128 } from '@aztec/foundation/crypto';
+import { Fr } from '@aztec/foundation/fields';
+import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { CompleteAddress, ContractInstance } from '@aztec/stdlib/contract';
+import { siloNullifier } from '@aztec/stdlib/hash';
+import type { KeyValidationRequest } from '@aztec/stdlib/kernel';
+import { IndexedTaggingSecret, LogWithTxData } from '@aztec/stdlib/logs';
+import type { NoteStatus } from '@aztec/stdlib/note';
+import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
+import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
+
+import { type NoteData, TypedOracle } from './acvm/index.js';
+import type { ExecutionDataProvider } from './execution_data_provider.js';
+import { pickNotes } from './pick_notes.js';
+
+/**
+ * The oracle for an unconstrained function execution.
+ */
+export class UnconstrainedExecutionOracle extends TypedOracle {
+  constructor(
+    protected readonly contractAddress: AztecAddress,
+    /** List of transient auth witnesses to be used during this simulation */
+    protected readonly authWitnesses: AuthWitness[],
+    protected readonly capsules: Capsule[],
+    protected readonly executionDataProvider: ExecutionDataProvider,
+    protected log = createLogger('simulator:client_view_context'),
+    protected readonly scopes?: AztecAddress[],
+  ) {
+    super();
+  }
+
+  public override getBlockNumber(): Promise<number> {
+    return this.executionDataProvider.getBlockNumber();
+  }
+
+  public override getContractAddress(): Promise<AztecAddress> {
+    return Promise.resolve(this.contractAddress);
+  }
+
+  public override getChainId(): Promise<Fr> {
+    return Promise.resolve(this.executionDataProvider.getChainId().then(id => new Fr(id)));
+  }
+
+  public override getVersion(): Promise<Fr> {
+    return Promise.resolve(this.executionDataProvider.getVersion().then(v => new Fr(v)));
+  }
+
+  /**
+   * Retrieve keys associated with a specific master public key and app address.
+   * @param pkMHash - The master public key hash.
+   * @returns A Promise that resolves to nullifier keys.
+   * @throws If the keys are not registered in the key store.
+   */
+  public override getKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
+    return this.executionDataProvider.getKeyValidationRequest(pkMHash, this.contractAddress);
+  }
+
+  /**
+   * Fetches the index and sibling path of a leaf at a given block from a given tree.
+   * @param blockNumber - The block number at which to get the membership witness.
+   * @param treeId - Id of the tree to get the sibling path from.
+   * @param leafValue - The leaf value
+   * @returns The index and sibling path concatenated [index, sibling_path]
+   */
+  public override getMembershipWitness(blockNumber: number, treeId: MerkleTreeId, leafValue: Fr): Promise<Fr[]> {
+    return this.executionDataProvider.getMembershipWitness(blockNumber, treeId, leafValue);
+  }
+
+  /**
+   * Returns a nullifier membership witness for a given nullifier at a given block.
+   * @param blockNumber - The block number at which to get the index.
+   * @param nullifier - Nullifier we try to find witness for.
+   * @returns The nullifier membership witness (if found).
+   */
+  public override async getNullifierMembershipWitness(
+    blockNumber: number,
+    nullifier: Fr,
+  ): Promise<NullifierMembershipWitness | undefined> {
+    return await this.executionDataProvider.getNullifierMembershipWitness(blockNumber, nullifier);
+  }
+
+  /**
+   * Returns a low nullifier membership witness for a given nullifier at a given block.
+   * @param blockNumber - The block number at which to get the index.
+   * @param nullifier - Nullifier we try to find the low nullifier witness for.
+   * @returns The low nullifier membership witness (if found).
+   * @remarks Low nullifier witness can be used to perform a nullifier non-inclusion proof by leveraging the "linked
+   * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
+   * we are trying to prove non-inclusion for.
+   */
+  public override async getLowNullifierMembershipWitness(
+    blockNumber: number,
+    nullifier: Fr,
+  ): Promise<NullifierMembershipWitness | undefined> {
+    return await this.executionDataProvider.getLowNullifierMembershipWitness(blockNumber, nullifier);
+  }
+
+  /**
+   * Returns a public data tree witness for a given leaf slot at a given block.
+   * @param blockNumber - The block number at which to get the index.
+   * @param leafSlot - The slot of the public data tree to get the witness for.
+   * @returns - The witness
+   */
+  public override async getPublicDataTreeWitness(
+    blockNumber: number,
+    leafSlot: Fr,
+  ): Promise<PublicDataWitness | undefined> {
+    return await this.executionDataProvider.getPublicDataTreeWitness(blockNumber, leafSlot);
+  }
+
+  /**
+   * Fetches a block header of a given block.
+   * @param blockNumber - The number of a block of which to get the block header.
+   * @returns Block extracted from a block with block number `blockNumber`.
+   */
+  public override async getBlockHeader(blockNumber: number): Promise<BlockHeader | undefined> {
+    const block = await this.executionDataProvider.getBlock(blockNumber);
+    if (!block) {
+      return undefined;
+    }
+    return block.header;
+  }
+
+  /**
+   * Retrieve the complete address associated to a given address.
+   * @param account - The account address.
+   * @returns A complete address associated with the input address.
+   * @throws An error if the account is not registered in the database.
+   */
+  public override getCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
+    return this.executionDataProvider.getCompleteAddress(account);
+  }
+
+  /**
+   * Returns a contract instance associated with an address or throws if not found.
+   * @param address - Address.
+   * @returns A contract instance.
+   */
+  public override getContractInstance(address: AztecAddress): Promise<ContractInstance> {
+    return this.executionDataProvider.getContractInstance(address);
+  }
+
+  /**
+   * Returns an auth witness for the given message hash. Checks on the list of transient witnesses
+   * for this transaction first, and falls back to the local database if not found.
+   * @param messageHash - Hash of the message to authenticate.
+   * @returns Authentication witness for the requested message hash.
+   */
+  public override getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
+    return Promise.resolve(
+      this.authWitnesses.find(w => w.requestHash.equals(messageHash))?.witness ??
+        this.executionDataProvider.getAuthWitness(messageHash),
+    );
+  }
+
+  /**
+   * Gets some notes for a contract address and storage slot.
+   * Returns a flattened array containing filtered notes.
+   *
+   * @remarks
+   * Check for pending notes with matching slot.
+   * Real notes coming from DB will have a leafIndex which
+   * represents their index in the note hash tree.
+   *
+   * @param storageSlot - The storage slot.
+   * @param numSelects - The number of valid selects in selectBy and selectValues.
+   * @param selectBy - An array of indices of the fields to selects.
+   * @param selectValues - The values to match.
+   * @param selectComparators - The comparators to use to match values.
+   * @param sortBy - An array of indices of the fields to sort.
+   * @param sortOrder - The order of the corresponding index in sortBy. (1: DESC, 2: ASC, 0: Do nothing)
+   * @param limit - The number of notes to retrieve per query.
+   * @param offset - The starting index for pagination.
+   * @param status - The status of notes to fetch.
+   * @returns Array of note data.
+   */
+  public override async getNotes(
+    storageSlot: Fr,
+    numSelects: number,
+    selectByIndexes: number[],
+    selectByOffsets: number[],
+    selectByLengths: number[],
+    selectValues: Fr[],
+    selectComparators: number[],
+    sortByIndexes: number[],
+    sortByOffsets: number[],
+    sortByLengths: number[],
+    sortOrder: number[],
+    limit: number,
+    offset: number,
+    status: NoteStatus,
+  ): Promise<NoteData[]> {
+    const dbNotes = await this.executionDataProvider.getNotes(this.contractAddress, storageSlot, status, this.scopes);
+    return pickNotes<NoteData>(dbNotes, {
+      selects: selectByIndexes.slice(0, numSelects).map((index, i) => ({
+        selector: { index, offset: selectByOffsets[i], length: selectByLengths[i] },
+        value: selectValues[i],
+        comparator: selectComparators[i],
+      })),
+      sorts: sortByIndexes.map((index, i) => ({
+        selector: { index, offset: sortByOffsets[i], length: sortByLengths[i] },
+        order: sortOrder[i],
+      })),
+      limit,
+      offset,
+    });
+  }
+
+  /**
+   * Check if a nullifier exists in the nullifier tree.
+   * @param innerNullifier - The inner nullifier.
+   * @returns A boolean indicating whether the nullifier exists in the tree or not.
+   */
+  public override async checkNullifierExists(innerNullifier: Fr) {
+    const nullifier = await siloNullifier(this.contractAddress, innerNullifier!);
+    const index = await this.executionDataProvider.getNullifierIndex(nullifier);
+    return index !== undefined;
+  }
+
+  /**
+   * Fetches a message from the executionDataProvider, given its key.
+   * @param contractAddress - Address of a contract by which the message was emitted.
+   * @param messageHash - Hash of the message.
+   * @param secret - Secret used to compute a nullifier.
+   * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
+   * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
+   */
+  public override async getL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
+    return await this.executionDataProvider.getL1ToL2MembershipWitness(contractAddress, messageHash, secret);
+  }
+
+  /**
+   * Read the public storage data.
+   * @param contractAddress - The address to read storage from.
+   * @param startStorageSlot - The starting storage slot.
+   * @param blockNumber - The block number to read storage at.
+   * @param numberOfElements - Number of elements to read from the starting storage slot.
+   */
+  public override async storageRead(
+    contractAddress: AztecAddress,
+    startStorageSlot: Fr,
+    blockNumber: number,
+    numberOfElements: number,
+  ) {
+    const values = [];
+    for (let i = 0n; i < numberOfElements; i++) {
+      const storageSlot = new Fr(startStorageSlot.value + i);
+      const value = await this.executionDataProvider.getPublicStorageAt(blockNumber, contractAddress, storageSlot);
+
+      this.log.debug(
+        `Oracle storage read: slot=${storageSlot.toString()} address-${contractAddress.toString()} value=${value}`,
+      );
+      values.push(value);
+    }
+    return values;
+  }
+
+  public override debugLog(message: string, fields: Fr[]): void {
+    // TODO(#10558) Remove this check once the debug log is fixed
+    if (message.startsWith('Context.note_hashes, after pushing new note hash:')) {
+      return;
+    }
+    this.log.verbose(`${applyStringFormatting(message, fields)}`, { module: `${this.log.module}:debug_log` });
+  }
+
+  /**
+   * Returns the tagging secret for a given sender and recipient pair, siloed to the current contract address.
+   * Includes the next index to be used used for tagging with this secret.
+   * For this to work, the ivsk_m of the sender must be known.
+   * @param sender - The address sending the note
+   * @param recipient - The address receiving the note
+   * @returns A tagging secret that can be used to tag notes.
+   */
+  public override async getIndexedTaggingSecretAsSender(
+    sender: AztecAddress,
+    recipient: AztecAddress,
+  ): Promise<IndexedTaggingSecret> {
+    return await this.executionDataProvider.getIndexedTaggingSecretAsSender(this.contractAddress, sender, recipient);
+  }
+
+  public override async syncNotes() {
+    const taggedLogsByRecipient = await this.executionDataProvider.syncTaggedLogs(
+      this.contractAddress,
+      await this.executionDataProvider.getBlockNumber(),
+      this.scopes,
+    );
+
+    for (const [recipient, taggedLogs] of taggedLogsByRecipient.entries()) {
+      await this.executionDataProvider.processTaggedLogs(taggedLogs, AztecAddress.fromString(recipient));
+    }
+
+    await this.executionDataProvider.removeNullifiedNotes(this.contractAddress);
+  }
+
+  public override async deliverNote(
+    contractAddress: AztecAddress,
+    storageSlot: Fr,
+    nonce: Fr,
+    content: Fr[],
+    noteHash: Fr,
+    nullifier: Fr,
+    txHash: Fr,
+    recipient: AztecAddress,
+  ) {
+    // TODO(#10727): allow other contracts to deliver notes
+    if (!this.contractAddress.equals(contractAddress)) {
+      throw new Error(`Got a note delivery request from ${contractAddress}, expected ${this.contractAddress}`);
+    }
+
+    await this.executionDataProvider.deliverNote(
+      contractAddress,
+      storageSlot,
+      nonce,
+      content,
+      noteHash,
+      nullifier,
+      txHash,
+      recipient,
+    );
+  }
+
+  public override getLogByTag(tag: Fr): Promise<LogWithTxData | null> {
+    return this.executionDataProvider.getLogByTag(tag);
+  }
+
+  public override storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
+    if (!contractAddress.equals(this.contractAddress)) {
+      // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
+      throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
+    }
+    return this.executionDataProvider.storeCapsule(this.contractAddress, slot, capsule);
+  }
+
+  public override async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
+    if (!contractAddress.equals(this.contractAddress)) {
+      // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
+      throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
+    }
+    return (
+      this.capsules.find(c => c.contractAddress.equals(contractAddress) && c.storageSlot.equals(slot))?.data ??
+      (await this.executionDataProvider.loadCapsule(this.contractAddress, slot))
+    );
+  }
+
+  public override deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
+    if (!contractAddress.equals(this.contractAddress)) {
+      // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
+      throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
+    }
+    return this.executionDataProvider.deleteCapsule(this.contractAddress, slot);
+  }
+
+  public override copyCapsule(
+    contractAddress: AztecAddress,
+    srcSlot: Fr,
+    dstSlot: Fr,
+    numEntries: number,
+  ): Promise<void> {
+    if (!contractAddress.equals(this.contractAddress)) {
+      // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
+      throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
+    }
+    return this.executionDataProvider.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries);
+  }
+
+  // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
+  public override aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
+    const aes128 = new Aes128();
+    return aes128.decryptBufferCBC(ciphertext, iv, symKey);
+  }
+}

package/src/public/avm/avm_context.ts

@@ -0,0 +1,61 @@
+import type { Fr } from '@aztec/foundation/fields';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+
+import type { AvmExecutionEnvironment } from './avm_execution_environment.js';
+import { type Gas, gasToGasLeft } from './avm_gas.js';
+import { AvmMachineState } from './avm_machine_state.js';
+import type { AvmSimulator } from './avm_simulator.js';
+import type { AvmPersistableStateManager } from './journal/journal.js';
+
+/**
+ * An execution context includes the information necessary to initiate AVM
+ * execution along with all state maintained by the AVM throughout execution.
+ */
+export class AvmContext {
+  /**
+   * Create a new AVM context
+   * @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 persistableState: AvmPersistableStateManager,
+    public environment: AvmExecutionEnvironment,
+    public machineState: AvmMachineState,
+  ) {}
+
+  // This is needed to break a dependency cycle created by the CALL opcode,
+  // which needs to create a new simulator but cannot depend directly on AvmSimulator.
+  public provideSimulator?: (ctx: this) => Promise<AvmSimulator>;
+
+  /**
+   * Prepare a new AVM context that will be ready for an external/nested call
+   * - Fork the world state journal
+   * - Derive a machine state from the current state
+   *   - E.g., gas metering is preserved but pc is reset
+   * - Derive an execution environment from the caller/parent
+   *   - Alter address
+   *
+   * @param address - The contract instance to initialize a context for
+   * @param calldata - Data/arguments for nested call
+   * @param allocatedGas - Gas allocated for the nested call
+   * @param callType - Type of call (CALL or STATICCALL)
+   * @returns new AvmContext instance
+   */
+  public async createNestedContractCallContext(
+    address: AztecAddress,
+    calldata: Fr[],
+    allocatedGas: Gas,
+    callType: 'CALL' | 'STATICCALL',
+  ): Promise<AvmContext> {
+    const deriveFn =
+      callType === 'CALL'
+        ? this.environment.deriveEnvironmentForNestedCall
+        : this.environment.deriveEnvironmentForNestedStaticCall;
+    const newExecutionEnvironment = deriveFn.call(this.environment, address, calldata);
+    const forkedWorldState = await this.persistableState.fork();
+    const machineState = AvmMachineState.fromState(gasToGasLeft(allocatedGas));
+    return new AvmContext(forkedWorldState, newExecutionEnvironment, machineState);
+  }
+}

package/src/public/avm/avm_contract_call_result.ts

@@ -0,0 +1,55 @@
+import type { Fr } from '@aztec/foundation/fields';
+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 { AvmRevertReason } from './errors.js';
+
+/**
+ * Results of an contract call's execution in the AVM.
+ */
+export class AvmContractCallResult {
+  constructor(
+    public reverted: boolean,
+    public output: Fr[],
+    public gasLeft: AvmGas,
+    public revertReason?: AvmRevertReason,
+  ) {}
+
+  toString(): string {
+    let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}`;
+    if (this.revertReason) {
+      resultsStr += `, revertReason: ${this.revertReason}`;
+    }
+    return resultsStr;
+  }
+
+  finalize(): AvmFinalizedCallResult {
+    const revertReason = this.revertReason ? createSimulationError(this.revertReason, this.output) : undefined;
+    return new AvmFinalizedCallResult(this.reverted, this.output, Gas.from(this.gasLeft), revertReason);
+  }
+}
+
+/**
+ * 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: Fr[],
+    public gasLeft: Gas,
+    public revertReason?: SimulationError,
+  ) {}
+
+  toString(): string {
+    let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(this.gasLeft)}`;
+    if (this.revertReason) {
+      resultsStr += `, revertReason: ${this.revertReason}`;
+    }
+    return resultsStr;
+  }
+}

package/src/public/avm/avm_execution_environment.ts

@@ -0,0 +1,39 @@
+import { Fr } from '@aztec/foundation/fields';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { GlobalVariables } from '@aztec/stdlib/tx';
+
+/**
+ * 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: Fr[],
+  ) {}
+
+  private deriveEnvironmentForNestedCallInternal(targetAddress: AztecAddress, calldata: Fr[], isStaticCall: boolean) {
+    return new AvmExecutionEnvironment(
+      /*address=*/ targetAddress,
+      /*sender=*/ this.address,
+      this.contractCallDepth.add(Fr.ONE),
+      this.transactionFee,
+      this.globals,
+      isStaticCall,
+      calldata,
+    );
+  }
+
+  public deriveEnvironmentForNestedCall(targetAddress: AztecAddress, calldata: Fr[]): AvmExecutionEnvironment {
+    return this.deriveEnvironmentForNestedCallInternal(targetAddress, calldata, /*isStaticCall=*/ false);
+  }
+
+  public deriveEnvironmentForNestedStaticCall(targetAddress: AztecAddress, calldata: Fr[]): AvmExecutionEnvironment {
+    return this.deriveEnvironmentForNestedCallInternal(targetAddress, calldata, /*isStaticCall=*/ true);
+  }
+}