@aztec/pxe 0.0.1-fake-ceab37513c → 0.0.6-commit.a2d1860fe9

package/dest/contract_function_simulator/oracle/utility_execution_oracle.js

@@ -1,111 +1,184 @@
-import { Aes128 } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
-import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
+import { Aes128 } from '@aztec/foundation/crypto/aes128';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { LogLevels, createLogger } from '@aztec/foundation/log';
 import { siloNullifier } from '@aztec/stdlib/hash';
+import { computeAddressSecret } from '@aztec/stdlib/keys';
+import { deriveEcdhSharedSecret } from '@aztec/stdlib/logs';
+import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
+import { MerkleTreeId } from '@aztec/stdlib/trees';
+import { createContractLogger, logContractMessage } from '../../contract_logging.js';
+import { EventService } from '../../events/event_service.js';
+import { LogService } from '../../logs/log_service.js';
+import { NoteService } from '../../notes/note_service.js';
+import { ORACLE_VERSION } from '../../oracle_version.js';
+import { EventValidationRequest } from '../noir-structs/event_validation_request.js';
+import { LogRetrievalRequest } from '../noir-structs/log_retrieval_request.js';
+import { LogRetrievalResponse } from '../noir-structs/log_retrieval_response.js';
+import { NoteValidationRequest } from '../noir-structs/note_validation_request.js';
+import { UtilityContext } from '../noir-structs/utility_context.js';
 import { pickNotes } from '../pick_notes.js';
-import { TypedOracle } from './typed_oracle.js';
+import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
 /**
  * The oracle for an execution of utility contract functions.
- */ export class UtilityExecutionOracle extends TypedOracle {
+ */ export class UtilityExecutionOracle {
+    isMisc = true;
+    isUtility = true;
+    contractLogger;
     contractAddress;
     authWitnesses;
     capsules;
-    executionDataProvider;
+    anchorBlockHeader;
+    contractStore;
+    noteStore;
+    keyStore;
+    addressStore;
+    aztecNode;
+    recipientTaggingStore;
+    senderAddressBookStore;
+    capsuleStore;
+    privateEventStore;
+    jobId;
     log;
     scopes;
-    constructor(contractAddress, /** List of transient auth witnesses to be used during this simulation */ authWitnesses, capsules, executionDataProvider, log = createLogger('simulator:client_view_context'), scopes){
-        super(), this.contractAddress = contractAddress, this.authWitnesses = authWitnesses, this.capsules = capsules, this.executionDataProvider = executionDataProvider, this.log = log, this.scopes = scopes;
+    constructor(args){
+        this.contractAddress = args.contractAddress;
+        this.authWitnesses = args.authWitnesses;
+        this.capsules = args.capsules;
+        this.anchorBlockHeader = args.anchorBlockHeader;
+        this.contractStore = args.contractStore;
+        this.noteStore = args.noteStore;
+        this.keyStore = args.keyStore;
+        this.addressStore = args.addressStore;
+        this.aztecNode = args.aztecNode;
+        this.recipientTaggingStore = args.recipientTaggingStore;
+        this.senderAddressBookStore = args.senderAddressBookStore;
+        this.capsuleStore = args.capsuleStore;
+        this.privateEventStore = args.privateEventStore;
+        this.jobId = args.jobId;
+        this.log = args.log ?? createLogger('simulator:client_view_context');
+        this.scopes = args.scopes;
     }
     utilityAssertCompatibleOracleVersion(version) {
-        this.executionDataProvider.assertCompatibleOracleVersion(version);
+        if (version !== ORACLE_VERSION) {
+            throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
+        }
     }
     utilityGetRandomField() {
         return Fr.random();
     }
-    utilityGetBlockNumber() {
-        return this.executionDataProvider.getBlockNumber();
-    }
-    utilityGetTimestamp() {
-        return this.executionDataProvider.getTimestamp();
-    }
-    utilityGetContractAddress() {
-        return Promise.resolve(this.contractAddress);
-    }
-    utilityGetChainId() {
-        return Promise.resolve(this.executionDataProvider.getChainId().then((id)=>new Fr(id)));
-    }
-    utilityGetVersion() {
-        return Promise.resolve(this.executionDataProvider.getVersion().then((v)=>new Fr(v)));
+    utilityGetUtilityContext() {
+        return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
     }
     /**
    * 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);
+   * @throws If scopes are defined and the account is not in the scopes.
+   */ async utilityGetKeyValidationRequest(pkMHash) {
+        // If scopes are defined, check that the key belongs to an account in the scopes.
+        if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
+            let hasAccess = false;
+            for(let i = 0; i < this.scopes.length && !hasAccess; i++){
+                if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
+                    hasAccess = true;
+                }
+            }
+            if (!hasAccess) {
+                throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
+            }
+        }
+        return this.keyStore.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);
+   * Fetches the index and sibling path of a leaf at a given block from the note hash tree.
+   * @param anchorBlockHash - The hash of a block that contains the note hash tree root in which to find the membership
+   * witness.
+   * @param noteHash - The note hash to find in the note hash tree.
+   * @returns The membership witness containing the leaf index and sibling path
+   */ utilityGetNoteHashMembershipWitness(anchorBlockHash, noteHash) {
+        return this.aztecNode.getNoteHashMembershipWitness(anchorBlockHash, noteHash);
+    }
+    /**
+   * Fetches the index and sibling path of a block hash in the archive tree.
+   *
+   * Block hashes are the leaves of the archive tree. Each time a new block is added to the chain,
+   * its block hash is appended as a new leaf to the archive tree.
+   *
+   * @param anchorBlockHash - The hash of a block that contains the archive tree root in which to find the membership
+   * witness.
+   * @param blockHash - The block hash to find in the archive tree.
+   * @returns The membership witness containing the leaf index and sibling path
+   */ utilityGetBlockHashMembershipWitness(anchorBlockHash, blockHash) {
+        return this.aztecNode.getBlockHashMembershipWitness(anchorBlockHash, blockHash);
     }
     /**
    * 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 blockHash - The block hash 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);
+   */ utilityGetNullifierMembershipWitness(blockHash, nullifier) {
+        return this.aztecNode.getNullifierMembershipWitness(blockHash, 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 blockHash - The block hash 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);
+   */ utilityGetLowNullifierMembershipWitness(blockHash, nullifier) {
+        return this.aztecNode.getLowNullifierMembershipWitness(blockHash, 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 blockHash - The block hash 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);
+   */ utilityGetPublicDataWitness(blockHash, leafSlot) {
+        return this.aztecNode.getPublicDataWitness(blockHash, 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;
+        const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
+        if (blockNumber > anchorBlockNumber) {
+            throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
         }
-        return block.header;
+        const block = await this.aztecNode.getBlock(blockNumber);
+        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.
-   */ utilityGetCompleteAddress(account) {
-        return this.executionDataProvider.getCompleteAddress(account);
+   * @returns A complete address associated with the input address, or `undefined` if not registered.
+   */ utilityTryGetPublicKeysAndPartialAddress(account) {
+        return this.addressStore.getCompleteAddress(account);
+    }
+    async getCompleteAddressOrFail(account) {
+        const completeAddress = await this.addressStore.getCompleteAddress(account);
+        if (!completeAddress) {
+            throw new Error(`No public key registered for address ${account}.
+        Register it by calling pxe.addAccount(...).\nSee docs for context: https://docs.aztec.network/developers/resources/debugging/aztecnr-errors#simulation-error-no-public-key-registered-for-address-0x0-register-it-by-calling-pxeregisterrecipient-or-pxeregisteraccount`);
+        }
+        return completeAddress;
     }
     /**
    * 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);
+        return this.getContractInstance(address);
+    }
+    async getContractInstance(address) {
+        const instance = await this.contractStore.getContractInstance(address);
+        if (!instance) {
+            throw new Error(`No contract instance found for address ${address.toString()}`);
+        }
+        return instance;
     }
     /**
    * Returns an auth witness for the given message hash. Checks on the list of transient witnesses
@@ -124,6 +197,7 @@ import { TypedOracle } from './typed_oracle.js';
    * Real notes coming from DB will have a leafIndex which
    * represents their index in the note hash tree.
    *
+   * @param owner - The owner of the notes. If undefined, returns notes for all owners.
    * @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.
@@ -135,8 +209,9 @@ import { TypedOracle } from './typed_oracle.js';
    * @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);
+   */ async utilityGetNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
+        const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
+        const dbNotes = await noteService.getNotes(this.contractAddress, owner, storageSlot, status, this.scopes);
         return pickNotes(dbNotes, {
             selects: selectByIndexes.slice(0, numSelects).map((index, i)=>({
                     selector: {
@@ -164,75 +239,113 @@ import { TypedOracle } from './typed_oracle.js';
    * @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;
+        const [nullifier, anchorBlockHash] = await Promise.all([
+            siloNullifier(this.contractAddress, innerNullifier),
+            this.anchorBlockHeader.hash()
+        ]);
+        const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
+            nullifier
+        ]);
+        return leafIndex?.data !== undefined;
     }
     /**
-   * Fetches a message from the executionDataProvider, given its key.
+   * Fetches a message from the executionStore, 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);
+        const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(this.aztecNode, contractAddress, messageHash, secret);
+        return new MessageLoadOracleInputs(messageIndex, siblingPath);
     }
     /**
    * Read the public storage data.
+   * @param blockHash - The block hash to read storage at.
    * @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);
-        }
+   */ async utilityStorageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
+        const slots = Array(numberOfElements).fill(0).map((_, i)=>new Fr(startStorageSlot.value + BigInt(i)));
+        const values = await Promise.all(slots.map((storageSlot)=>this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)));
+        this.log.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
         return values;
     }
-    utilityDebugLog(message, fields) {
-        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.
-   */ async utilityGetIndexedTaggingSecretAsSender(sender, recipient) {
-        return await this.executionDataProvider.getIndexedTaggingSecretAsSender(this.contractAddress, sender, recipient);
+   * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
+   */ async #getContractLogger() {
+        if (!this.contractLogger) {
+            // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
+            // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
+            this.contractLogger = await createContractLogger(this.contractAddress, (addr)=>this.contractStore.getDebugContractName(addr), {
+                instanceId: this.jobId
+            });
+        }
+        return this.contractLogger;
+    }
+    async utilityLog(level, message, fields) {
+        if (!LogLevels[level]) {
+            throw new Error(`Invalid log level: ${level}`);
+        }
+        const logger = await this.#getContractLogger();
+        logContractMessage(logger, LogLevels[level], message, fields);
     }
     async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
-        await this.executionDataProvider.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
-        await this.executionDataProvider.removeNullifiedNotes(this.contractAddress);
+        const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.log.getBindings());
+        await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
     }
-    async utilityValidateEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
-        // TODO(#10727): allow other contracts to deliver notes
+    /**
+   * Validates all note and event validation requests enqueued via `enqueue_note_for_validation` and
+   * `enqueue_event_for_validation`, inserting them into the note database and event store respectively, making them
+   * queryable via `get_notes` and `getPrivateEvents`.
+   *
+   * This automatically clears both validation request queues, so no further work needs to be done by the caller.
+   * @param contractAddress - The address of the contract that the logs are tagged for.
+   * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
+   * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
+   */ async utilityValidateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
+        // TODO(#10727): allow other contracts to store 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);
+        // We read all note and event validation requests and process them all concurrently. This makes the process much
+        // faster as we don't need to wait for the network round-trip.
+        const noteValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)).map(NoteValidationRequest.fromFields);
+        const eventValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)).map(EventValidationRequest.fromFields);
+        const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
+        const noteStorePromises = noteValidationRequests.map((request)=>noteService.validateAndStoreNote(request.contractAddress, request.owner, request.storageSlot, request.randomness, request.noteNonce, request.content, request.noteHash, request.nullifier, request.txHash, request.recipient));
+        const eventService = new EventService(this.anchorBlockHeader, this.aztecNode, this.privateEventStore, this.jobId);
+        const eventStorePromises = eventValidationRequests.map((request)=>eventService.validateAndStoreEvent(request.contractAddress, request.eventTypeId, request.randomness, request.serializedEvent, request.eventCommitment, request.txHash, request.recipient));
+        await Promise.all([
+            ...noteStorePromises,
+            ...eventStorePromises
+        ]);
+        // Requests are cleared once we're done.
+        await this.capsuleStore.setCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, [], this.jobId);
+        await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
     }
     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);
+        // We read all log retrieval requests and process them all concurrently. This makes the process much faster as we
+        // don't need to wait for the network round-trip.
+        const logRetrievalRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, this.jobId)).map(LogRetrievalRequest.fromFields);
+        const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.log.getBindings());
+        const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
+        // Requests are cleared once we're done.
+        await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, [], this.jobId);
+        // The responses are stored as Option<LogRetrievalResponse> in a second CapsuleArray.
+        await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalResponsesArrayBaseSlot, maybeLogRetrievalResponses.map(LogRetrievalResponse.toSerializedOption), this.jobId);
     }
     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);
+        this.capsuleStore.storeCapsule(this.contractAddress, slot, capsule, this.jobId);
+        return Promise.resolve();
     }
     async utilityLoadCapsule(contractAddress, slot) {
         if (!contractAddress.equals(this.contractAddress)) {
@@ -240,31 +353,41 @@ import { TypedOracle } from './typed_oracle.js';
             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));
+        this.capsules.find((c)=>c.contractAddress.equals(contractAddress) && c.storageSlot.equals(slot))?.data ?? await this.capsuleStore.loadCapsule(this.contractAddress, slot, this.jobId));
     }
     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);
+        this.capsuleStore.deleteCapsule(this.contractAddress, slot, this.jobId);
+        return Promise.resolve();
     }
     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);
+        return this.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
     }
     // 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);
-    }
-    utilityEmitOffchainEffect(_data) {
-        return Promise.reject(new Error('Cannot emit offchain effects from a utility function'));
+    /**
+   * Retrieves the shared secret for a given address and ephemeral public key.
+   * @param address - The address to get the secret for.
+   * @param ephPk - The ephemeral public key to get the secret for.
+   * @returns The secret for the given address.
+   */ utilityGetSharedSecret(address, ephPk) {
+        return this.getSharedSecret(address, ephPk);
+    }
+    async getSharedSecret(address, ephPk) {
+        // TODO(#12656): return an app-siloed secret
+        const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
+        const ivskM = await this.keyStore.getMasterSecretKey(recipientCompleteAddress.publicKeys.masterIncomingViewingPublicKey);
+        const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
+        return deriveEcdhSharedSecret(addressSecret, ephPk);
     }
 }

package/dest/contract_function_simulator/pick_notes.d.ts

@@ -1,4 +1,4 @@
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { Comparator, type Note } from '@aztec/stdlib/note';
 export interface PropertySelector {
     index: number;
@@ -82,4 +82,4 @@ interface ContainsNote {
  */
 export declare function pickNotes<T extends ContainsNote>(noteDatas: T[], { selects, sorts, limit, offset }: GetOptions): T[];
 export {};
-//# sourceMappingURL=pick_notes.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGlja19ub3Rlcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X2Z1bmN0aW9uX3NpbXVsYXRvci9waWNrX25vdGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxFQUFFLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUNwRCxPQUFPLEVBQUUsVUFBVSxFQUFFLEtBQUssSUFBSSxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFFM0QsTUFBTSxXQUFXLGdCQUFnQjtJQUMvQixLQUFLLEVBQUUsTUFBTSxDQUFDO0lBQ2QsTUFBTSxFQUFFLE1BQU0sQ0FBQztJQUNmLE1BQU0sRUFBRSxNQUFNLENBQUM7Q0FDaEI7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxNQUFNO0lBQ3JCOztPQUVHO0lBQ0gsUUFBUSxFQUFFLGdCQUFnQixDQUFDO0lBQzNCOztPQUVHO0lBQ0gsS0FBSyxFQUFFLEVBQUUsQ0FBQztJQUNWOztPQUVHO0lBQ0gsVUFBVSxFQUFFLFVBQVUsQ0FBQztDQUN4QjtBQUVEOztHQUVHO0FBQ0gsb0JBQVksU0FBUztJQUNuQixJQUFJLElBQUk7SUFDUixJQUFJLElBQUk7SUFDUixHQUFHLElBQUk7Q0FDUjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLElBQUk7SUFDbkI7O09BRUc7SUFDSCxRQUFRLEVBQUUsZ0JBQWdCLENBQUM7SUFDM0I7O09BRUc7SUFDSCxLQUFLLEVBQUUsU0FBUyxDQUFDO0NBQ2xCO0FBRUQ7O0dBRUc7QUFDSCxVQUFVLFVBQVU7SUFDbEI7OztPQUdHO0lBQ0gsT0FBTyxDQUFDLEVBQUUsTUFBTSxFQUFFLENBQUM7SUFDbkI7OztPQUdHO0lBQ0gsS0FBSyxDQUFDLEVBQUUsSUFBSSxFQUFFLENBQUM7SUFDZjs7O09BR0c7SUFDSCxLQUFLLENBQUMsRUFBRSxNQUFNLENBQUM7SUFDZjs7O09BR0c7SUFDSCxNQUFNLENBQUMsRUFBRSxNQUFNLENBQUM7Q0FDakI7QUFFRDs7R0FFRztBQUNILFVBQVUsWUFBWTtJQUNwQjs7T0FFRztJQUNILElBQUksRUFBRSxJQUFJLENBQUM7Q0FDWjtBQThDRDs7R0FFRztBQUNILHdCQUFnQixTQUFTLENBQUMsQ0FBQyxTQUFTLFlBQVksRUFDOUMsU0FBUyxFQUFFLENBQUMsRUFBRSxFQUNkLEVBQUUsT0FBWSxFQUFFLEtBQVUsRUFBRSxLQUFTLEVBQUUsTUFBVSxFQUFFLEVBQUUsVUFBVSxHQUM5RCxDQUFDLEVBQUUsQ0FJTCJ9

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

@@ -1 +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"}
+{"version":3,"file":"pick_notes.d.ts","sourceRoot":"","sources":["../../src/contract_function_simulator/pick_notes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,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

@@ -1,4 +1,4 @@
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { Comparator } from '@aztec/stdlib/note';
 /**
  * The order to sort an array.

package/dest/contract_function_simulator/proxied_contract_data_source.d.ts

@@ -1,6 +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;
+import type { ContractStore } from '../storage/contract_store/contract_store.js';
+export declare class ProxiedContractStoreFactory {
+    static create(contractStore: ContractStore, overrides?: ContractOverrides): ContractStore;
 }
-//# sourceMappingURL=proxied_contract_data_source.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJveGllZF9jb250cmFjdF9kYXRhX3NvdXJjZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X2Z1bmN0aW9uX3NpbXVsYXRvci9wcm94aWVkX2NvbnRyYWN0X2RhdGFfc291cmNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFMUQsT0FBTyxLQUFLLEVBQUUsYUFBYSxFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFPakYscUJBQWEsMkJBQTJCO0lBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsYUFBYSxFQUFFLGFBQWEsRUFBRSxTQUFTLENBQUMsRUFBRSxpQkFBaUIsaUJBcUV4RTtDQUNGIn0=

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

@@ -1 +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"}
+{"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,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAOjF,qBAAa,2BAA2B;IACtC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,CAAC,EAAE,iBAAiB,iBAqExE;CACF"}

package/dest/contract_function_simulator/proxied_contract_data_source.js

@@ -1,14 +1,14 @@
 import { FunctionSelector } from '@aztec/stdlib/abi';
 /*
- * Proxy generator for a ContractDataProvider that allows overriding contract instances and artifacts, so
+ * Proxy generator for a ContractStore 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) {
+ */ export class ProxiedContractStoreFactory {
+    static create(contractStore, overrides) {
         if (!overrides) {
-            return contractDataProvider;
+            return contractStore;
         }
-        return new Proxy(contractDataProvider, {
+        return new Proxy(contractStore, {
             get (target, prop) {
                 switch(prop){
                     case 'getContractInstance':
@@ -47,6 +47,24 @@ import { FunctionSelector } from '@aztec/stdlib/abi';
                                 }
                             };
                         }
+                    case 'getFunctionArtifactWithDebugMetadata':
+                        {
+                            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.getFunctionArtifactWithDebugMetadata(contractAddress, selector);
+                                }
+                            };
+                        }
                     default:
                         {
                             const value = Reflect.get(target, prop);

package/dest/contract_logging.d.ts

@@ -0,0 +1,22 @@
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import { type LogLevel, type Logger } from '@aztec/foundation/log';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { DebugLog } from '@aztec/stdlib/logs';
+/** Resolves a contract address to a human-readable name, if available. */
+export type ContractNameResolver = (address: AztecAddress) => Promise<string | undefined>;
+/**
+ * Creates a logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
+ */
+export declare function createContractLogger(contractAddress: AztecAddress, getContractName: ContractNameResolver, options?: {
+    instanceId?: string;
+}): Promise<Logger>;
+/**
+ * Formats and emits a single contract log message through the given logger.
+ */
+export declare function logContractMessage(logger: Logger, level: LogLevel, message: string, fields: Fr[]): void;
+/**
+ * Displays debug logs collected during public function simulation,
+ * using the `contract_log::` prefixed logger format.
+ */
+export declare function displayDebugLogs(debugLogs: DebugLog[], getContractName: ContractNameResolver): Promise<void>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3RfbG9nZ2luZy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnRyYWN0X2xvZ2dpbmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDekQsT0FBTyxFQUFFLEtBQUssUUFBUSxFQUFFLEtBQUssTUFBTSxFQUF1QyxNQUFNLHVCQUF1QixDQUFDO0FBQ3hHLE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ2hFLE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRW5ELDBFQUEwRTtBQUMxRSxNQUFNLE1BQU0sb0JBQW9CLEdBQUcsQ0FBQyxPQUFPLEVBQUUsWUFBWSxLQUFLLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUM7QUFFMUY7O0dBRUc7QUFDSCx3QkFBc0Isb0JBQW9CLENBQ3hDLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGVBQWUsRUFBRSxvQkFBb0IsRUFDckMsT0FBTyxDQUFDLEVBQUU7SUFBRSxVQUFVLENBQUMsRUFBRSxNQUFNLENBQUE7Q0FBRSxHQUNoQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBS2pCO0FBRUQ7O0dBRUc7QUFDSCx3QkFBZ0Isa0JBQWtCLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxHQUFHLElBQUksQ0FFdkc7QUFFRDs7O0dBR0c7QUFDSCx3QkFBc0IsZ0JBQWdCLENBQUMsU0FBUyxFQUFFLFFBQVEsRUFBRSxFQUFFLGVBQWUsRUFBRSxvQkFBb0IsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBS2xIIn0=

package/dest/contract_logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract_logging.d.ts","sourceRoot":"","sources":["../src/contract_logging.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAuC,MAAM,uBAAuB,CAAC;AACxG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD,0EAA0E;AAC1E,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;AAE1F;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,eAAe,EAAE,oBAAoB,EACrC,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAChC,OAAO,CAAC,MAAM,CAAC,CAKjB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAEvG;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlH"}

package/dest/contract_logging.js

@@ -0,0 +1,23 @@
+import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
+/**
+ * Creates a logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
+ */ export async function createContractLogger(contractAddress, getContractName, options) {
+    const addrAbbrev = contractAddress.toString().slice(0, 10);
+    const name = await getContractName(contractAddress);
+    const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::Unknown(${addrAbbrev})`;
+    return createLogger(module, options);
+}
+/**
+ * Formats and emits a single contract log message through the given logger.
+ */ export function logContractMessage(logger, level, message, fields) {
+    logger[level](applyStringFormatting(message, fields));
+}
+/**
+ * Displays debug logs collected during public function simulation,
+ * using the `contract_log::` prefixed logger format.
+ */ export async function displayDebugLogs(debugLogs, getContractName) {
+    for (const log of debugLogs){
+        const logger = await createContractLogger(log.contractAddress, getContractName);
+        logContractMessage(logger, log.level, log.message, log.fields);
+    }
+}