@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.b655e406

package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts

@@ -0,0 +1,154 @@
+import { Fr, Point } from '@aztec/foundation/fields';
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { CompleteAddress, ContractInstance } from '@aztec/stdlib/contract';
+import type { KeyValidationRequest } from '@aztec/stdlib/kernel';
+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 { ExecutionDataProvider } from '../execution_data_provider.js';
+import { UtilityContext } from '../noir-structs/utility_context.js';
+import type { IMiscOracle, IUtilityExecutionOracle, NoteData } from './interfaces.js';
+/**
+ * The oracle for an execution of utility contract functions.
+ */
+export declare class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOracle {
+    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: import("@aztec/foundation/log").Logger;
+    protected readonly scopes?: AztecAddress[] | undefined;
+    isMisc: true;
+    isUtility: true;
+    private aztecNrDebugLog;
+    constructor(contractAddress: AztecAddress, 
+    /** List of transient auth witnesses to be used during this simulation */
+    authWitnesses: AuthWitness[], capsules: Capsule[], // TODO(#12425): Rename to transientCapsules
+    executionDataProvider: ExecutionDataProvider, log?: import("@aztec/foundation/log").Logger, scopes?: AztecAddress[] | undefined);
+    utilityAssertCompatibleOracleVersion(version: number): void;
+    utilityGetRandomField(): Fr;
+    utilityGetUtilityContext(): Promise<UtilityContext>;
+    /**
+     * 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.
+     */
+    utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest>;
+    /**
+     * 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]
+     */
+    utilityGetMembershipWitness(blockNumber: number, treeId: MerkleTreeId, leafValue: Fr): Promise<Fr[]>;
+    /**
+     * 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).
+     */
+    utilityGetNullifierMembershipWitness(blockNumber: number, nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+    /**
+     * 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.
+     */
+    utilityGetLowNullifierMembershipWitness(blockNumber: number, nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+    /**
+     * 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
+     */
+    utilityGetPublicDataWitness(blockNumber: number, leafSlot: Fr): Promise<PublicDataWitness | undefined>;
+    /**
+     * 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`.
+     */
+    utilityGetBlockHeader(blockNumber: number): Promise<BlockHeader | undefined>;
+    /**
+     * 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.
+     */
+    utilityGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress>;
+    /**
+     * Returns a contract instance associated with an address or throws if not found.
+     * @param address - Address.
+     * @returns A contract instance.
+     */
+    utilityGetContractInstance(address: AztecAddress): Promise<ContractInstance>;
+    /**
+     * 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.
+     */
+    utilityGetAuthWitness(messageHash: Fr): Promise<Fr[] | undefined>;
+    /**
+     * 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.
+     */
+    utilityGetNotes(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[]>;
+    /**
+     * 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.
+     */
+    utilityCheckNullifierExists(innerNullifier: Fr): Promise<boolean>;
+    /**
+     * 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).
+     */
+    utilityGetL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr): Promise<import("./message_load_oracle_inputs.js").MessageLoadOracleInputs<36>>;
+    /**
+     * 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.
+     */
+    utilityStorageRead(contractAddress: AztecAddress, startStorageSlot: Fr, blockNumber: number, numberOfElements: number): Promise<Fr[]>;
+    utilityDebugLog(level: number, message: string, fields: Fr[]): void;
+    utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr): Promise<void>;
+    utilityValidateEnqueuedNotesAndEvents(contractAddress: AztecAddress, noteValidationRequestsArrayBaseSlot: Fr, eventValidationRequestsArrayBaseSlot: Fr): Promise<void>;
+    utilityBulkRetrieveLogs(contractAddress: AztecAddress, logRetrievalRequestsArrayBaseSlot: Fr, logRetrievalResponsesArrayBaseSlot: Fr): Promise<void>;
+    utilityStoreCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void>;
+    utilityLoadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null>;
+    utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void>;
+    utilityCopyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void>;
+    utilityAes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer>;
+    utilityGetSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point>;
+}
+//# sourceMappingURL=utility_execution_oracle.d.ts.map

package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility_execution_oracle.d.ts","sourceRoot":"","sources":["../../../src/contract_function_simulator/oracle/utility_execution_oracle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC5G,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEpE,OAAO,KAAK,EAAE,WAAW,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEtF;;GAEG;AACH,qBAAa,sBAAuB,YAAW,WAAW,EAAE,uBAAuB;IAO/E,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,YAAY;IAChD,yEAAyE;IACzE,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,WAAW,EAAE;IAC/C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE;IACtC,SAAS,CAAC,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB;IAC/D,SAAS,CAAC,GAAG;IACb,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE;IAZ5C,MAAM,EAAG,IAAI,CAAU;IACvB,SAAS,EAAG,IAAI,CAAU;IAE1B,OAAO,CAAC,eAAe,CAAsC;gBAGxC,eAAe,EAAE,YAAY;IAChD,yEAAyE;IACtD,aAAa,EAAE,WAAW,EAAE,EAC5B,QAAQ,EAAE,OAAO,EAAE,EAAE,4CAA4C;IACjE,qBAAqB,EAAE,qBAAqB,EACrD,GAAG,yCAAgD,EAC1C,MAAM,CAAC,EAAE,YAAY,EAAE,YAAA;IAGrC,oCAAoC,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI3D,qBAAqB,IAAI,EAAE;IAIrB,wBAAwB,IAAI,OAAO,CAAC,cAAc,CAAC;IAWhE;;;;;OAKG;IACI,8BAA8B,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIjF;;;;;;OAMG;IACI,2BAA2B,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAI3G;;;;;OAKG;IACU,oCAAoC,CAC/C,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,EAAE,GACZ,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAIlD;;;;;;;;OAQG;IACU,uCAAuC,CAClD,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,EAAE,GACZ,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAIlD;;;;;OAKG;IACU,2BAA2B,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAInH;;;;OAIG;IACU,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAQzF;;;;;OAKG;IACI,qCAAqC,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC;IAI7F;;;;OAIG;IACI,0BAA0B,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAInF;;;;;OAKG;IACI,qBAAqB,CAAC,WAAW,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,GAAG,SAAS,CAAC;IAIxE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,eAAe,CAC1B,WAAW,EAAE,EAAE,EACf,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EAAE,EACzB,eAAe,EAAE,MAAM,EAAE,EACzB,eAAe,EAAE,MAAM,EAAE,EACzB,YAAY,EAAE,EAAE,EAAE,EAClB,iBAAiB,EAAE,MAAM,EAAE,EAC3B,aAAa,EAAE,MAAM,EAAE,EACvB,aAAa,EAAE,MAAM,EAAE,EACvB,aAAa,EAAE,MAAM,EAAE,EACvB,SAAS,EAAE,MAAM,EAAE,EACnB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,QAAQ,EAAE,CAAC;IAiBtB;;;;OAIG;IACU,2BAA2B,CAAC,cAAc,EAAE,EAAE;IAM3D;;;;;;;OAOG;IACU,iCAAiC,CAAC,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE;IAIzG;;;;;;OAMG;IACU,kBAAkB,CAC7B,eAAe,EAAE,YAAY,EAC7B,gBAAgB,EAAE,EAAE,EACpB,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM;IAenB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI;IAQ7D,sBAAsB,CAAC,6BAA6B,EAAE,EAAE;IAMxD,qCAAqC,CAChD,eAAe,EAAE,YAAY,EAC7B,mCAAmC,EAAE,EAAE,EACvC,oCAAoC,EAAE,EAAE;IAc7B,uBAAuB,CAClC,eAAe,EAAE,YAAY,EAC7B,iCAAiC,EAAE,EAAE,EACrC,kCAAkC,EAAE,EAAE;IAcjC,mBAAmB,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpF,kBAAkB,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC;IAYvF,oBAAoB,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5E,kBAAkB,CACvB,eAAe,EAAE,YAAY,EAC7B,OAAO,EAAE,EAAE,EACX,OAAO,EAAE,EAAE,EACX,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAST,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKrF,sBAAsB,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;CAGnF"}

package/dest/contract_function_simulator/oracle/utility_execution_oracle.js

@@ -0,0 +1,265 @@
+import { Aes128 } from '@aztec/foundation/crypto';
+import { Fr } from '@aztec/foundation/fields';
+import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundation/log';
+import { siloNullifier } from '@aztec/stdlib/hash';
+import { UtilityContext } from '../noir-structs/utility_context.js';
+import { pickNotes } from '../pick_notes.js';
+/**
+ * The oracle for an execution of utility contract functions.
+ */ export class UtilityExecutionOracle {
+    contractAddress;
+    authWitnesses;
+    capsules;
+    executionDataProvider;
+    log;
+    scopes;
+    isMisc;
+    isUtility;
+    aztecNrDebugLog;
+    constructor(contractAddress, /** List of transient auth witnesses to be used during this simulation */ authWitnesses, capsules, executionDataProvider, log = createLogger('simulator:client_view_context'), scopes){
+        this.contractAddress = contractAddress;
+        this.authWitnesses = authWitnesses;
+        this.capsules = capsules;
+        this.executionDataProvider = executionDataProvider;
+        this.log = log;
+        this.scopes = scopes;
+        this.isMisc = true;
+        this.isUtility = true;
+        this.aztecNrDebugLog = createLogger('aztec-nr:debug_log');
+    }
+    utilityAssertCompatibleOracleVersion(version) {
+        this.executionDataProvider.assertCompatibleOracleVersion(version);
+    }
+    utilityGetRandomField() {
+        return Fr.random();
+    }
+    async utilityGetUtilityContext() {
+        const blockHeader = await this.executionDataProvider.getAnchorBlockHeader();
+        return UtilityContext.from({
+            blockNumber: blockHeader.globalVariables.blockNumber,
+            timestamp: blockHeader.globalVariables.timestamp,
+            contractAddress: this.contractAddress,
+            version: blockHeader.globalVariables.version,
+            chainId: blockHeader.globalVariables.chainId
+        });
+    }
+    /**
+   * 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.
+   */ utilityGetKeyValidationRequest(pkMHash) {
+        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]
+   */ utilityGetMembershipWitness(blockNumber, treeId, leafValue) {
+        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).
+   */ async utilityGetNullifierMembershipWitness(blockNumber, nullifier) {
+        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.
+   */ async utilityGetLowNullifierMembershipWitness(blockNumber, nullifier) {
+        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
+   */ async utilityGetPublicDataWitness(blockNumber, leafSlot) {
+        return await this.executionDataProvider.getPublicDataWitness(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`.
+   */ async utilityGetBlockHeader(blockNumber) {
+        const block = await this.executionDataProvider.getBlock(blockNumber);
+        if (!block) {
+            return undefined;
+        }
+        return block.getBlockHeader();
+    }
+    /**
+   * 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.
+   */ utilityGetPublicKeysAndPartialAddress(account) {
+        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.
+   */ utilityGetContractInstance(address) {
+        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.
+   */ utilityGetAuthWitness(messageHash) {
+        return Promise.resolve(this.authWitnesses.find((w)=>w.requestHash.equals(messageHash))?.witness);
+    }
+    /**
+   * 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.
+   */ async utilityGetNotes(storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
+        const dbNotes = await this.executionDataProvider.getNotes(this.contractAddress, storageSlot, status, this.scopes);
+        return pickNotes(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.
+   */ async utilityCheckNullifierExists(innerNullifier) {
+        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).
+   */ async utilityGetL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
+        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.
+   */ async utilityStorageRead(contractAddress, startStorageSlot, blockNumber, numberOfElements) {
+        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;
+    }
+    utilityDebugLog(level, message, fields) {
+        if (!LogLevels[level]) {
+            throw new Error(`Invalid debug log level: ${level}`);
+        }
+        const levelName = LogLevels[level];
+        this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
+    }
+    async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
+        await this.executionDataProvider.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
+        await this.executionDataProvider.syncNoteNullifiers(this.contractAddress);
+    }
+    async utilityValidateEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
+        // TODO(#10727): allow other contracts to deliver notes
+        if (!this.contractAddress.equals(contractAddress)) {
+            throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
+        }
+        await this.executionDataProvider.validateEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot);
+    }
+    async utilityBulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
+        // TODO(#10727): allow other contracts to process partial notes
+        if (!this.contractAddress.equals(contractAddress)) {
+            throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
+        }
+        await this.executionDataProvider.bulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot);
+    }
+    utilityStoreCapsule(contractAddress, slot, capsule) {
+        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);
+    }
+    async utilityLoadCapsule(contractAddress, slot) {
+        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(// TODO(#12425): On the following line, the pertinent capsule gets overshadowed by the transient one. Tackle this.
+        this.capsules.find((c)=>c.contractAddress.equals(contractAddress) && c.storageSlot.equals(slot))?.data ?? await this.executionDataProvider.loadCapsule(this.contractAddress, slot));
+    }
+    utilityDeleteCapsule(contractAddress, slot) {
+        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);
+    }
+    utilityCopyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
+        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.
+    utilityAes128Decrypt(ciphertext, iv, symKey) {
+        const aes128 = new Aes128();
+        return aes128.decryptBufferCBC(ciphertext, iv, symKey);
+    }
+    utilityGetSharedSecret(address, ephPk) {
+        return this.executionDataProvider.getSharedSecret(address, ephPk);
+    }
+}

package/dest/contract_function_simulator/pick_notes.d.ts

@@ -0,0 +1,85 @@
+import { Fr } from '@aztec/foundation/fields';
+import { Comparator, type Note } from '@aztec/stdlib/note';
+export interface PropertySelector {
+    index: number;
+    offset: number;
+    length: number;
+}
+/**
+ * Configuration for selecting values.
+ */
+export interface Select {
+    /**
+     * Selector of the field to select and match.
+     */
+    selector: PropertySelector;
+    /**
+     * Required value of the field.
+     */
+    value: Fr;
+    /**
+     * The comparator to use
+     */
+    comparator: Comparator;
+}
+/**
+ * The order to sort an array.
+ */
+export declare enum SortOrder {
+    NADA = 0,
+    DESC = 1,
+    ASC = 2
+}
+/**
+ * Configuration for sorting values.
+ */
+export interface Sort {
+    /**
+     * Selector of the field to sort.
+     */
+    selector: PropertySelector;
+    /**
+     * Order to sort the field.
+     */
+    order: SortOrder;
+}
+/**
+ * Options for picking items from an array of BasicNoteData.
+ */
+interface GetOptions {
+    /**
+     * Configurations for selecting items.
+     * Default: empty array.
+     */
+    selects?: Select[];
+    /**
+     * Configurations for sorting items.
+     * Default: empty array.
+     */
+    sorts?: Sort[];
+    /**
+     * The number of items to retrieve per query.
+     * Default: 0. No limit.
+     */
+    limit?: number;
+    /**
+     * The starting index for pagination.
+     * Default: 0.
+     */
+    offset?: number;
+}
+/**
+ * Data needed from to perform sort.
+ */
+interface ContainsNote {
+    /**
+     * The note.
+     */
+    note: Note;
+}
+/**
+ * Pick from a note array a number of notes that meet the criteria.
+ */
+export declare function pickNotes<T extends ContainsNote>(noteDatas: T[], { selects, sorts, limit, offset }: GetOptions): T[];
+export {};
+//# sourceMappingURL=pick_notes.d.ts.map

package/dest/contract_function_simulator/pick_notes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick_notes.d.ts","sourceRoot":"","sources":["../../src/contract_function_simulator/pick_notes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,KAAK,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,EAAE,CAAC;IACV;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;GAEG;AACH,oBAAY,SAAS;IACnB,IAAI,IAAI;IACR,IAAI,IAAI;IACR,GAAG,IAAI;CACR;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;CAClB;AAED;;GAEG;AACH,UAAU,UAAU;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,UAAU,YAAY;IACpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;CACZ;AA8CD;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,YAAY,EAC9C,SAAS,EAAE,CAAC,EAAE,EACd,EAAE,OAAY,EAAE,KAAU,EAAE,KAAS,EAAE,MAAU,EAAE,EAAE,UAAU,GAC9D,CAAC,EAAE,CAIL"}

package/dest/contract_function_simulator/pick_notes.js

@@ -0,0 +1,51 @@
+import { Fr } from '@aztec/foundation/fields';
+import { Comparator } from '@aztec/stdlib/note';
+/**
+ * The order to sort an array.
+ */ export var SortOrder = /*#__PURE__*/ function(SortOrder) {
+    SortOrder[SortOrder["NADA"] = 0] = "NADA";
+    SortOrder[SortOrder["DESC"] = 1] = "DESC";
+    SortOrder[SortOrder["ASC"] = 2] = "ASC";
+    return SortOrder;
+}({});
+const selectPropertyFromPackedNoteContent = (noteData, selector)=>{
+    const noteValueBuffer = noteData[selector.index].toBuffer();
+    const noteValue = noteValueBuffer.subarray(selector.offset, selector.offset + selector.length);
+    return Fr.fromBuffer(noteValue);
+};
+const selectNotes = (noteDatas, selects)=>noteDatas.filter((noteData)=>selects.every(({ selector, value, comparator })=>{
+            const noteValueFr = selectPropertyFromPackedNoteContent(noteData.note.items, selector);
+            const comparatorSelector = {
+                [Comparator.EQ]: ()=>noteValueFr.equals(value),
+                [Comparator.NEQ]: ()=>!noteValueFr.equals(value),
+                [Comparator.LT]: ()=>noteValueFr.lt(value),
+                [Comparator.LTE]: ()=>noteValueFr.lt(value) || noteValueFr.equals(value),
+                [Comparator.GT]: ()=>!noteValueFr.lt(value) && !noteValueFr.equals(value),
+                [Comparator.GTE]: ()=>!noteValueFr.lt(value)
+            };
+            return comparatorSelector[comparator]();
+        }));
+const sortNotes = (a, b, sorts, level = 0)=>{
+    if (sorts[level] === undefined) {
+        return 0;
+    }
+    const { selector, order } = sorts[level];
+    if (order === 0) {
+        return 0;
+    }
+    const aValue = selectPropertyFromPackedNoteContent(a, selector);
+    const bValue = selectPropertyFromPackedNoteContent(b, selector);
+    const dir = order === 1 ? [
+        -1,
+        1
+    ] : [
+        1,
+        -1
+    ];
+    return aValue.toBigInt() === bValue.toBigInt() ? sortNotes(a, b, sorts, level + 1) : aValue.toBigInt() > bValue.toBigInt() ? dir[0] : dir[1];
+};
+/**
+ * Pick from a note array a number of notes that meet the criteria.
+ */ export function pickNotes(noteDatas, { selects = [], sorts = [], limit = 0, offset = 0 }) {
+    return selectNotes(noteDatas, selects).sort((a, b)=>sortNotes(a.note.items, b.note.items, sorts)).slice(offset, limit ? offset + limit : undefined);
+}

package/dest/contract_function_simulator/proxied_contract_data_source.d.ts

@@ -0,0 +1,6 @@
+import type { ContractOverrides } from '@aztec/stdlib/tx';
+import type { ContractDataProvider } from '../storage/index.js';
+export declare class ProxiedContractDataProviderFactory {
+    static create(contractDataProvider: ContractDataProvider, overrides?: ContractOverrides): ContractDataProvider;
+}
+//# sourceMappingURL=proxied_contract_data_source.d.ts.map

package/dest/contract_function_simulator/proxied_contract_data_source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxied_contract_data_source.d.ts","sourceRoot":"","sources":["../../src/contract_function_simulator/proxied_contract_data_source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAOhE,qBAAa,kCAAkC;IAC7C,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,SAAS,CAAC,EAAE,iBAAiB;CAqDxF"}

package/dest/contract_function_simulator/proxied_contract_data_source.js

@@ -0,0 +1,62 @@
+import { FunctionSelector } from '@aztec/stdlib/abi';
+/*
+ * Proxy generator for a ContractDataProvider that allows overriding contract instances and artifacts, so
+ * the contract function simulator can execute different bytecode on certain addresses. An example use case
+ * would be overriding your own account contract so that valid signatures don't have to be provided while simulating.
+ */ export class ProxiedContractDataProviderFactory {
+    static create(contractDataProvider, overrides) {
+        if (!overrides) {
+            return contractDataProvider;
+        }
+        return new Proxy(contractDataProvider, {
+            get (target, prop) {
+                switch(prop){
+                    case 'getContractInstance':
+                        {
+                            return async (address)=>{
+                                if (overrides[address.toString()]) {
+                                    const { instance } = overrides[address.toString()];
+                                    instance.address = address;
+                                    const realInstance = await target.getContractInstance(address);
+                                    if (!realInstance) {
+                                        throw new Error(`Contract instance not found for address: ${address}`);
+                                    }
+                                    instance.currentContractClassId = realInstance.currentContractClassId;
+                                    instance.originalContractClassId = realInstance.originalContractClassId;
+                                    return instance;
+                                } else {
+                                    return target.getContractInstance(address);
+                                }
+                            };
+                        }
+                    case 'getFunctionArtifact':
+                        {
+                            return async (contractAddress, selector)=>{
+                                if (overrides[contractAddress.toString()]) {
+                                    const { artifact } = overrides[contractAddress.toString()];
+                                    const functions = artifact.functions;
+                                    for(let i = 0; i < functions.length; i++){
+                                        const fn = functions[i];
+                                        const fnSelector = await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters);
+                                        if (fnSelector.equals(selector)) {
+                                            return fn;
+                                        }
+                                    }
+                                } else {
+                                    return target.getFunctionArtifact(contractAddress, selector);
+                                }
+                            };
+                        }
+                    default:
+                        {
+                            const value = Reflect.get(target, prop);
+                            if (typeof value === 'function') {
+                                return value.bind(target);
+                            }
+                            return value;
+                        }
+                }
+            }
+        });
+    }
+}

package/dest/contract_function_simulator/proxied_node.d.ts

@@ -0,0 +1,9 @@
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { NodeStats } from '@aztec/stdlib/tx';
+export type ProxiedNode = AztecNode & {
+    getStats(): NodeStats;
+};
+export declare class ProxiedNodeFactory {
+    static create(node: AztecNode): ProxiedNode;
+}
+//# sourceMappingURL=proxied_node.d.ts.map

package/dest/contract_function_simulator/proxied_node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxied_node.d.ts","sourceRoot":"","sources":["../../src/contract_function_simulator/proxied_node.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG;IAAE,QAAQ,IAAI,SAAS,CAAA;CAAE,CAAC;AAEhE,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,GAoBrB,WAAW;CAEpB"}