@aztec/pxe 0.0.1-commit.e558bd1c → 0.0.1-commit.e588bc7e5

package/dest/contract_function_simulator/oracle/utility_execution_oracle.js

@@ -1,11 +1,13 @@
 import { Aes128 } from '@aztec/foundation/crypto/aes128';
 import { Fr } from '@aztec/foundation/curves/bn254';
-import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundation/log';
+import { LogLevels, createLogger } from '@aztec/foundation/log';
+import { isProtocolContract } from '@aztec/protocol-contracts';
 import { siloNullifier } from '@aztec/stdlib/hash';
 import { computeAddressSecret } from '@aztec/stdlib/keys';
-import { deriveEcdhSharedSecret } from '@aztec/stdlib/logs';
+import { MessageContext, deriveAppSiloedSharedSecret } from '@aztec/stdlib/logs';
 import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
 import { MerkleTreeId } from '@aztec/stdlib/trees';
+import { createContractLogger, logContractMessage, stripAztecnrLogPrefix } 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';
@@ -20,6 +22,11 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
 /**
  * The oracle for an execution of utility contract functions.
  */ export class UtilityExecutionOracle {
+    isMisc = true;
+    isUtility = true;
+    contractLogger;
+    aztecnrLogger;
+    offchainEffects = [];
     contractAddress;
     authWitnesses;
     capsules;
@@ -31,44 +38,56 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
     aztecNode;
     recipientTaggingStore;
     senderAddressBookStore;
-    capsuleStore;
+    capsuleService;
     privateEventStore;
+    messageContextService;
+    contractSyncService;
     jobId;
-    log;
+    logger;
     scopes;
-    isMisc;
-    isUtility;
-    aztecNrDebugLog;
-    constructor(contractAddress, /** List of transient auth witnesses to be used during this simulation */ authWitnesses, capsules, anchorBlockHeader, contractStore, noteStore, keyStore, addressStore, aztecNode, recipientTaggingStore, senderAddressBookStore, capsuleStore, privateEventStore, jobId, log = createLogger('simulator:client_view_context'), scopes){
-        this.contractAddress = contractAddress;
-        this.authWitnesses = authWitnesses;
-        this.capsules = capsules;
-        this.anchorBlockHeader = anchorBlockHeader;
-        this.contractStore = contractStore;
-        this.noteStore = noteStore;
-        this.keyStore = keyStore;
-        this.addressStore = addressStore;
-        this.aztecNode = aztecNode;
-        this.recipientTaggingStore = recipientTaggingStore;
-        this.senderAddressBookStore = senderAddressBookStore;
-        this.capsuleStore = capsuleStore;
-        this.privateEventStore = privateEventStore;
-        this.jobId = jobId;
-        this.log = log;
-        this.scopes = scopes;
-        this.isMisc = true;
-        this.isUtility = true;
-        this.aztecNrDebugLog = createLogger('aztec-nr:debug_log');
-    }
-    utilityAssertCompatibleOracleVersion(version) {
+    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.capsuleService = args.capsuleService;
+        this.privateEventStore = args.privateEventStore;
+        this.messageContextService = args.messageContextService;
+        this.contractSyncService = args.contractSyncService;
+        this.jobId = args.jobId;
+        this.logger = args.log ?? createLogger('simulator:client_view_context');
+        this.scopes = args.scopes;
+    }
+    assertCompatibleOracleVersion(version) {
+        // TODO(F-416): Remove this hack on v5 when protocol contracts are redeployed.
+        // Protocol contracts/canonical contracts shipped with committed bytecode that cannot be changed. Assert they use
+        // the expected pinned version or the current one. We want to allow for both the pinned and the current versions
+        // because we want this code to work with both the pinned and unpinned version since some branches do not have the
+        // pinned contracts (like e.g. next)
+        const LEGACY_ORACLE_VERSION = 12;
+        if (isProtocolContract(this.contractAddress)) {
+            if (version !== LEGACY_ORACLE_VERSION && version !== ORACLE_VERSION) {
+                const hint = version > ORACLE_VERSION ? 'The contract was compiled with a newer version of Aztec.nr than your private environment supports. Upgrade your private environment to a compatible version.' : 'The contract was compiled with an older version of Aztec.nr than your private environment supports. Recompile the contract with a compatible version of Aztec.nr.';
+                throw new Error(`Incompatible private environment version: ${hint} See https://docs.aztec.network/errors/8 (expected oracle version ${LEGACY_ORACLE_VERSION} or ${ORACLE_VERSION}, got ${version})`);
+            }
+            return;
+        }
         if (version !== ORACLE_VERSION) {
-            throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
+            const hint = version > ORACLE_VERSION ? 'The contract was compiled with a newer version of Aztec.nr than your private environment supports. Upgrade your private environment to a compatible version.' : 'The contract was compiled with an older version of Aztec.nr than your private environment supports. Recompile the contract with a compatible version of Aztec.nr.';
+            throw new Error(`Incompatible private environment version: ${hint} See https://docs.aztec.network/errors/8 (expected oracle version ${ORACLE_VERSION}, got ${version})`);
         }
     }
-    utilityGetRandomField() {
+    getRandomField() {
         return Fr.random();
     }
-    utilityGetUtilityContext() {
+    getUtilityContext() {
         return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
     }
     /**
@@ -77,24 +96,26 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * @returns A Promise that resolves to nullifier keys.
    * @throws If the keys are not registered in the key store.
    * @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 && this.scopes.length > 0) {
-            const [, account] = await this.keyStore.getKeyPrefixAndAccount(pkMHash);
-            if (!this.scopes.some((scope)=>scope.equals(account))) {
-                throw new Error(`Key validation request denied: account ${account.toString()} is not in the allowed scopes.`);
+   */ async getKeyValidationRequest(pkMHash) {
+        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 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 blockHash - 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);
+   */ getNoteHashMembershipWitness(blockHash, noteHash) {
+        return this.#queryWithBlockHashNotAfterAnchor(blockHash, ()=>this.aztecNode.getNoteHashMembershipWitness(blockHash, noteHash));
     }
     /**
    * Fetches the index and sibling path of a block hash in the archive tree.
@@ -102,20 +123,23 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * 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
+   * @param referenceBlockHash - 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);
+   */ getBlockHashMembershipWitness(referenceBlockHash, blockHash) {
+        // Note that we validate that the reference block hash is at or before the anchor block - we don't test the block
+        // hash at all. If the block hash did not exist by the reference block hash, then the node will not return the
+        // membership witness as there is none.
+        return this.#queryWithBlockHashNotAfterAnchor(referenceBlockHash, ()=>this.aztecNode.getBlockHashMembershipWitness(referenceBlockHash, blockHash));
     }
     /**
    * Returns a nullifier membership witness for a given nullifier at a given block.
    * @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).
-   */ utilityGetNullifierMembershipWitness(blockHash, nullifier) {
-        return this.aztecNode.getNullifierMembershipWitness(blockHash, nullifier);
+   */ getNullifierMembershipWitness(blockHash, nullifier) {
+        return this.#queryWithBlockHashNotAfterAnchor(blockHash, ()=>this.aztecNode.getNullifierMembershipWitness(blockHash, nullifier));
     }
     /**
    * Returns a low nullifier membership witness for a given nullifier at a given block.
@@ -125,22 +149,22 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * @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(blockHash, nullifier) {
-        return this.aztecNode.getLowNullifierMembershipWitness(blockHash, nullifier);
+   */ getLowNullifierMembershipWitness(blockHash, nullifier) {
+        return this.#queryWithBlockHashNotAfterAnchor(blockHash, ()=>this.aztecNode.getLowNullifierMembershipWitness(blockHash, nullifier));
     }
     /**
    * Returns a public data tree witness for a given leaf slot at a given block.
    * @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
-   */ utilityGetPublicDataWitness(blockHash, leafSlot) {
-        return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
+   */ getPublicDataWitness(blockHash, leafSlot) {
+        return this.#queryWithBlockHashNotAfterAnchor(blockHash, ()=>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) {
+   */ async getBlockHeader(blockNumber) {
         const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
         if (blockNumber > anchorBlockNumber) {
             throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
@@ -149,11 +173,18 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
         return block?.header;
     }
     /**
-   * Retrieve the complete address associated to a given address.
+   * Retrieve the public keys and partial address associated to a given address.
    * @param account - The account address.
-   * @returns A complete address associated with the input address, or `undefined` if not registered.
-   */ utilityTryGetPublicKeysAndPartialAddress(account) {
-        return this.addressStore.getCompleteAddress(account);
+   * @returns The public keys and partial address, or `undefined` if the account is not registered.
+   */ async getPublicKeysAndPartialAddress(account) {
+        const completeAddress = await this.addressStore.getCompleteAddress(account);
+        if (!completeAddress) {
+            return undefined;
+        }
+        return {
+            publicKeys: completeAddress.publicKeys,
+            partialAddress: completeAddress.partialAddress
+        };
     }
     async getCompleteAddressOrFail(account) {
         const completeAddress = await this.addressStore.getCompleteAddress(account);
@@ -167,10 +198,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * Returns a contract instance associated with an address or throws if not found.
    * @param address - Address.
    * @returns A contract instance.
-   */ utilityGetContractInstance(address) {
-        return this.getContractInstance(address);
-    }
-    async 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()}`);
@@ -182,7 +210,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * 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) {
+   */ getAuthWitness(messageHash) {
         return Promise.resolve(this.authWitnesses.find((w)=>w.requestHash.equals(messageHash))?.witness);
     }
     /**
@@ -206,7 +234,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * @param offset - The starting index for pagination.
    * @param status - The status of notes to fetch.
    * @returns Array of note data.
-   */ async utilityGetNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
+   */ async getNotes(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, {
@@ -235,7 +263,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * 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) {
+   */ async doesNullifierExist(innerNullifier) {
         const [nullifier, anchorBlockHash] = await Promise.all([
             siloNullifier(this.contractAddress, innerNullifier),
             this.anchorBlockHeader.hash()
@@ -246,14 +274,14 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
         return leafIndex?.data !== undefined;
     }
     /**
-   * Fetches a message from the executionStore, given its key.
+   * Returns the membership witness of an un-nullified L1 to L2 message.
    * @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) {
-        const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(this.aztecNode, contractAddress, messageHash, secret);
+   */ async getL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
+        const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(this.aztecNode, contractAddress, messageHash, secret, await this.anchorBlockHeader.hash());
         return new MessageLoadOracleInputs(messageIndex, siblingPath);
     }
     /**
@@ -262,22 +290,49 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * @param contractAddress - The address to read storage from.
    * @param startStorageSlot - The starting storage slot.
    * @param numberOfElements - Number of elements to read from the starting storage slot.
-   */ 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;
+   */ getFromPublicStorage(blockHash, contractAddress, startStorageSlot, numberOfElements) {
+        return this.#queryWithBlockHashNotAfterAnchor(blockHash, async ()=>{
+            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.logger.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
+            return values;
+        });
+    }
+    /**
+   * Returns a per-contract logger whose output is prefixed with `contract:<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), 'user', {
+                instanceId: this.jobId
+            });
+        }
+        return this.contractLogger;
     }
-    utilityDebugLog(level, message, fields) {
+    /**
+   * Returns a per-contract logger whose output is prefixed with `aztecnr:<name>(<addrAbbrev>)`.
+   */ async #getAztecnrLogger() {
+        if (!this.aztecnrLogger) {
+            // 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.aztecnrLogger = await createContractLogger(this.contractAddress, (addr)=>this.contractStore.getDebugContractName(addr), 'aztecnr', {
+                instanceId: this.jobId
+            });
+        }
+        return this.aztecnrLogger;
+    }
+    async log(level, message, fields) {
         if (!LogLevels[level]) {
-            throw new Error(`Invalid debug log level: ${level}`);
+            throw new Error(`Invalid log level: ${level}`);
         }
-        const levelName = LogLevels[level];
-        this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
+        const { kind, message: strippedMessage } = stripAztecnrLogPrefix(message);
+        const logger = kind == 'aztecnr' ? await this.#getAztecnrLogger() : await this.#getContractLogger();
+        logContractMessage(logger, LogLevels[level], strippedMessage, fields);
     }
-    async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
-        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 getPendingTaggedLogs(pendingTaggedLogArrayBaseSlot, scope) {
+        const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleService, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
+        await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, scope);
     }
     /**
    * Validates all note and event validation requests enqueued via `enqueue_note_for_validation` and
@@ -288,91 +343,145 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * @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) {
+   */ async validateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot, maxNotePackedLen, maxEventSerializedLen, scope) {
         // 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}`);
         }
         // 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 noteValidationRequests = (await this.capsuleService.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId, scope)).map((fields)=>NoteValidationRequest.fromFields(fields, maxNotePackedLen));
+        const eventValidationRequests = (await this.capsuleService.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId, scope)).map((fields)=>EventValidationRequest.fromFields(fields, maxEventSerializedLen));
         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 noteStorePromises = noteValidationRequests.map((request)=>noteService.validateAndStoreNote(request.contractAddress, request.owner, request.storageSlot, request.randomness, request.noteNonce, request.content, request.noteHash, request.nullifier, request.txHash, scope));
         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));
+        const eventStorePromises = eventValidationRequests.map((request)=>eventService.validateAndStoreEvent(request.contractAddress, request.eventTypeId, request.randomness, request.serializedEvent, request.eventCommitment, request.txHash, scope));
         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);
+        await this.capsuleService.setCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, [], this.jobId, scope);
+        await this.capsuleService.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId, scope);
     }
-    async utilityBulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
+    async getLogsByTag(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot, scope) {
         // 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}`);
         }
         // 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);
+        const logRetrievalRequests = (await this.capsuleService.readCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, this.jobId, scope)).map(LogRetrievalRequest.fromFields);
+        const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleService, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
+        const maybeLogRetrievalResponses = await logService.fetchLogsByTag(contractAddress, logRetrievalRequests);
         // Requests are cleared once we're done.
-        await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, [], this.jobId);
+        await this.capsuleService.setCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, [], this.jobId, scope);
         // The responses are stored as Option<LogRetrievalResponse> in a second CapsuleArray.
-        await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalResponsesArrayBaseSlot, maybeLogRetrievalResponses.map(LogRetrievalResponse.toSerializedOption), this.jobId);
+        await this.capsuleService.setCapsuleArray(contractAddress, logRetrievalResponsesArrayBaseSlot, maybeLogRetrievalResponses.map(LogRetrievalResponse.toSerializedOption), this.jobId, scope);
+    }
+    async getMessageContextsByTxHash(contractAddress, messageContextRequestsArrayBaseSlot, messageContextResponsesArrayBaseSlot, scope) {
+        try {
+            if (!this.contractAddress.equals(contractAddress)) {
+                throw new Error(`Got a message context request from ${contractAddress}, expected ${this.contractAddress}`);
+            }
+            // TODO(@mverzilli): this is a prime example of where using a volatile array would make much more sense, we don't
+            // need scopes here, we just need a bit of shared memory to cross boundaries between Noir and TS.
+            // At the same time, we don't want to allow any global scope access other than where backwards compatibility
+            // forces us to. Hence we need the scope here to be artificial.
+            const requestCapsules = await this.capsuleService.readCapsuleArray(contractAddress, messageContextRequestsArrayBaseSlot, this.jobId, scope);
+            const txHashes = requestCapsules.map((fields, i)=>{
+                if (fields.length !== 1) {
+                    throw new Error(`Malformed message context request at index ${i}: expected 1 field (tx hash), got ${fields.length}`);
+                }
+                return fields[0];
+            });
+            const maybeMessageContexts = await this.messageContextService.getMessageContextsByTxHash(txHashes, this.anchorBlockHeader.getBlockNumber());
+            // Leave response in response capsule array.
+            await this.capsuleService.setCapsuleArray(contractAddress, messageContextResponsesArrayBaseSlot, maybeMessageContexts.map(MessageContext.toSerializedOption), this.jobId, scope);
+        } finally{
+            await this.capsuleService.setCapsuleArray(contractAddress, messageContextRequestsArrayBaseSlot, [], this.jobId, scope);
+        }
     }
-    utilityStoreCapsule(contractAddress, slot, capsule) {
+    setCapsule(contractAddress, slot, capsule, scope) {
         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`);
         }
-        this.capsuleStore.storeCapsule(this.contractAddress, slot, capsule, this.jobId);
-        return Promise.resolve();
+        this.capsuleService.setCapsule(contractAddress, slot, capsule, this.jobId, scope);
     }
-    async utilityLoadCapsule(contractAddress, slot) {
+    getCapsule(contractAddress, slot, scope) {
         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.capsuleStore.loadCapsule(this.contractAddress, slot, this.jobId));
+        return this.capsuleService.getCapsule(contractAddress, slot, this.jobId, scope, this.capsules);
     }
-    utilityDeleteCapsule(contractAddress, slot) {
+    deleteCapsule(contractAddress, slot, scope) {
         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`);
         }
-        this.capsuleStore.deleteCapsule(this.contractAddress, slot, this.jobId);
-        return Promise.resolve();
+        this.capsuleService.deleteCapsule(contractAddress, slot, this.jobId, scope);
     }
-    utilityCopyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
+    copyCapsule(contractAddress, srcSlot, dstSlot, numEntries, scope) {
         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.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
+        return this.capsuleService.copyCapsule(contractAddress, srcSlot, dstSlot, numEntries, this.jobId, scope);
+    }
+    /**
+   * Clears cached sync state for a contract for a set of scopes, forcing re-sync on the next query so that newly
+   * stored notes or events are discovered.
+   */ setContractSyncCacheInvalid(contractAddress, scopes) {
+        if (!contractAddress.equals(this.contractAddress)) {
+            throw new Error(`Contract ${this.contractAddress} cannot invalidate sync cache of ${contractAddress}`);
+        }
+        this.contractSyncService.invalidateContractForScopes(contractAddress, scopes);
     }
     // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
-    utilityAes128Decrypt(ciphertext, iv, symKey) {
+    decryptAes128(ciphertext, iv, symKey) {
         const aes128 = new Aes128();
         return aes128.decryptBufferCBC(ciphertext, iv, symKey);
     }
     /**
-   * Retrieves the shared secret for a given address and ephemeral public key.
+   * Retrieves the app-siloed 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
+   * @param contractAddress - The contract address for app-siloing (validated against execution context).
+   * @returns The app-siloed shared secret as a Field.
+   */ async getSharedSecret(address, ephPk, contractAddress) {
+        if (!contractAddress.equals(this.contractAddress)) {
+            throw new Error(`getSharedSecret called with contract address ${contractAddress}, expected ${this.contractAddress}`);
+        }
         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);
+        return deriveAppSiloedSharedSecret(addressSecret, ephPk, this.contractAddress);
+    }
+    emitOffchainEffect(data) {
+        this.offchainEffects.push({
+            data,
+            contractAddress: this.contractAddress
+        });
+        return Promise.resolve();
+    }
+    /** Returns offchain effects collected during execution. */ getOffchainEffects() {
+        return this.offchainEffects;
+    }
+    /** Runs a query concurrently with a validation that the block hash is not ahead of the anchor block. */ async #queryWithBlockHashNotAfterAnchor(blockHash, query) {
+        const [response] = await Promise.all([
+            query(),
+            (async ()=>{
+                const header = await this.aztecNode.getBlockHeader(blockHash);
+                if (!header) {
+                    throw new Error(`Could not find block header for block hash ${blockHash}`);
+                }
+                if (header.getBlockNumber() > this.anchorBlockHeader.getBlockNumber()) {
+                    throw new Error(`Made a node query with a reference block hash ${blockHash} with block number ${header.getBlockNumber()}, which is ahead of the anchor block number ${this.anchorBlockHeader.getBlockNumber()} (from anchor block hash ${await this.anchorBlockHeader.hash()}).`);
+                }
+            })()
+        ]);
+        return response;
     }
 }

package/dest/contract_logging.d.ts

@@ -0,0 +1,27 @@
+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>;
+export type CONTRACT_LOG_KIND = 'aztecnr' | 'user';
+/**
+ * Creates a logger whose output is prefixed with `contract:<name>(<addrAbbrev>)`.
+ */
+export declare function createContractLogger(contractAddress: AztecAddress, getContractName: ContractNameResolver, kind: CONTRACT_LOG_KIND, 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:` prefixed logger format.
+ */
+export declare function displayDebugLogs(debugLogs: DebugLog[], getContractName: ContractNameResolver): Promise<void>;
+export declare function stripAztecnrLogPrefix(message: string): {
+    kind: CONTRACT_LOG_KIND;
+    message: string;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3RfbG9nZ2luZy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnRyYWN0X2xvZ2dpbmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDekQsT0FBTyxFQUFFLEtBQUssUUFBUSxFQUFFLEtBQUssTUFBTSxFQUF1QyxNQUFNLHVCQUF1QixDQUFDO0FBQ3hHLE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ2hFLE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRW5ELDBFQUEwRTtBQUMxRSxNQUFNLE1BQU0sb0JBQW9CLEdBQUcsQ0FBQyxPQUFPLEVBQUUsWUFBWSxLQUFLLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUM7QUFDMUYsTUFBTSxNQUFNLGlCQUFpQixHQUFHLFNBQVMsR0FBRyxNQUFNLENBQUM7QUFFbkQ7O0dBRUc7QUFDSCx3QkFBc0Isb0JBQW9CLENBQ3hDLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGVBQWUsRUFBRSxvQkFBb0IsRUFDckMsSUFBSSxFQUFFLGlCQUFpQixFQUN2QixPQUFPLENBQUMsRUFBRTtJQUFFLFVBQVUsQ0FBQyxFQUFFLE1BQU0sQ0FBQTtDQUFFLEdBQ2hDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FPakI7QUFFRDs7R0FFRztBQUNILHdCQUFnQixrQkFBa0IsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFLEdBQUcsSUFBSSxDQUV2RztBQUVEOzs7R0FHRztBQUNILHdCQUFzQixnQkFBZ0IsQ0FBQyxTQUFTLEVBQUUsUUFBUSxFQUFFLEVBQUUsZUFBZSxFQUFFLG9CQUFvQixHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FNbEg7QUFFRCx3QkFBZ0IscUJBQXFCLENBQUMsT0FBTyxFQUFFLE1BQU0sR0FBRztJQUFFLElBQUksRUFBRSxpQkFBaUIsQ0FBQztJQUFDLE9BQU8sRUFBRSxNQUFNLENBQUE7Q0FBRSxDQU1uRyJ9

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;AAC1F,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEnD;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,eAAe,EAAE,oBAAoB,EACrC,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAChC,OAAO,CAAC,MAAM,CAAC,CAOjB;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,CAMlH;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAMnG"}

package/dest/contract_logging.js

@@ -0,0 +1,38 @@
+import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
+/**
+ * Creates a logger whose output is prefixed with `contract:<name>(<addrAbbrev>)`.
+ */ export async function createContractLogger(contractAddress, getContractName, kind, options) {
+    const addrAbbrev = contractAddress.toString().slice(0, 10);
+    const name = await getContractName(contractAddress);
+    const prefix = kind == 'aztecnr' ? 'aztecnr' : 'contract';
+    const module = name ? `${prefix}:${name}(${addrAbbrev})` : `${prefix}: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:` prefixed logger format.
+ */ export async function displayDebugLogs(debugLogs, getContractName) {
+    for (const log of debugLogs){
+        const { kind, message } = stripAztecnrLogPrefix(log.message);
+        const logger = await createContractLogger(log.contractAddress, getContractName, kind);
+        logContractMessage(logger, log.level, message, log.fields);
+    }
+}
+export function stripAztecnrLogPrefix(message) {
+    if (message.startsWith('[aztec-nr] ')) {
+        return {
+            kind: 'aztecnr',
+            message: message.slice('[aztec-nr] '.length)
+        };
+    } else {
+        return {
+            kind: 'user',
+            message
+        };
+    }
+}