@aztec/pxe 0.0.1-commit.6230efd → 0.0.1-commit.64b6bbb

package/dest/contract_function_simulator/oracle/utility_execution_oracle.js

@@ -4,12 +4,12 @@ import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundatio
 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 { 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 { PublicStorageService } from '../../public_storage/public_storage_service.js';
-import { TreeMembershipService } from '../../tree_membership/tree_membership_service.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';
@@ -20,6 +20,9 @@ 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;
     contractAddress;
     authWitnesses;
     capsules;
@@ -29,36 +32,30 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
     keyStore;
     addressStore;
     aztecNode;
-    anchorBlockStore;
     recipientTaggingStore;
     senderAddressBookStore;
     capsuleStore;
     privateEventStore;
+    jobId;
     log;
     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, anchorBlockStore, recipientTaggingStore, senderAddressBookStore, capsuleStore, privateEventStore, 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.anchorBlockStore = anchorBlockStore;
-        this.recipientTaggingStore = recipientTaggingStore;
-        this.senderAddressBookStore = senderAddressBookStore;
-        this.capsuleStore = capsuleStore;
-        this.privateEventStore = privateEventStore;
-        this.log = log;
-        this.scopes = scopes;
-        this.isMisc = true;
-        this.isUtility = true;
-        this.aztecNrDebugLog = createLogger('aztec-nr:debug_log');
+    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) {
         if (version !== ORACLE_VERSION) {
@@ -69,82 +66,93 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
         return Fr.random();
     }
     utilityGetUtilityContext() {
-        return UtilityContext.from({
-            blockNumber: this.anchorBlockHeader.globalVariables.blockNumber,
-            timestamp: this.anchorBlockHeader.globalVariables.timestamp,
-            contractAddress: this.contractAddress,
-            version: this.anchorBlockHeader.globalVariables.version,
-            chainId: this.anchorBlockHeader.globalVariables.chainId
-        });
+        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) {
+   * @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.`);
+            }
+        }
         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) {
-        const treeMembershipService = new TreeMembershipService(this.aztecNode, this.anchorBlockStore);
-        return treeMembershipService.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.aztecNode.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) {
-        const treeMembershipService = new TreeMembershipService(this.aztecNode, this.anchorBlockStore);
-        return await treeMembershipService.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) {
-        const treeMembershipService = new TreeMembershipService(this.aztecNode, this.anchorBlockStore);
-        return await treeMembershipService.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 anchorBlockNumber = (await this.anchorBlockStore.getBlockHeader()).getBlockNumber();
+        const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
         if (blockNumber > anchorBlockNumber) {
             throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
         }
         const block = await this.aztecNode.getBlock(blockNumber);
-        return block?.getBlockHeader() || undefined;
+        return block?.header;
     }
     /**
    * Retrieve the complete address associated to a given address.
    * @param account - The account address.
-   * @returns A complete address associated with the input address.
-   * @throws An error if the account is not registered in the database.
-   */ utilityGetPublicKeysAndPartialAddress(account) {
-        return this.getCompleteAddress(account);
+   * @returns A complete address associated with the input address, or `undefined` if not registered.
+   */ utilityTryGetPublicKeysAndPartialAddress(account) {
+        return this.addressStore.getCompleteAddress(account);
     }
-    async getCompleteAddress(account) {
+    async getCompleteAddressOrFail(account) {
         const completeAddress = await this.addressStore.getCompleteAddress(account);
         if (!completeAddress) {
             throw new Error(`No public key registered for address ${account}.
@@ -196,7 +204,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * @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) {
-        const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore);
+        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)=>({
@@ -225,10 +233,14 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.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 treeMembershipService = new TreeMembershipService(this.aztecNode, this.anchorBlockStore);
-        const index = await treeMembershipService.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 executionStore, given its key.
@@ -238,42 +250,47 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
    * @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 treeMembershipService = new TreeMembershipService(this.aztecNode, this.anchorBlockStore);
-        const [messageIndex, siblingPath] = await treeMembershipService.getL1ToL2MembershipWitness(contractAddress, messageHash, secret);
-        // Assuming messageIndex is what you intended to use for the index in MessageLoadOracleInputs
+        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 = [];
-        const publicStorageService = new PublicStorageService(this.anchorBlockStore, this.aztecNode);
-        // TODO: why do we serialize these requests? This should probably a single call
-        // Privacy considerations?
-        for(let i = 0n; i < numberOfElements; i++){
-            const storageSlot = new Fr(startStorageSlot.value + i);
-            const value = await publicStorageService.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(level, message, fields) {
+    /**
+   * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
+   */ async #getContractLogger() {
+        if (!this.contractLogger) {
+            const addrAbbrev = this.contractAddress.toString().slice(0, 10);
+            const name = await this.contractStore.getDebugContractName(this.contractAddress);
+            const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::${addrAbbrev}`;
+            // 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 = createLogger(module, {
+                instanceId: this.jobId
+            });
+        }
+        return this.contractLogger;
+    }
+    async utilityLog(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 logger = await this.#getContractLogger();
+        logger[levelName](`${applyStringFormatting(message, fields)}`);
     }
     async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
-        const logService = new LogService(this.aztecNode, this.anchorBlockStore, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore);
-        await logService.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
-        const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore);
-        await noteService.syncNoteNullifiers(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);
     }
     /**
    * Validates all note and event validation requests enqueued via `enqueue_note_for_validation` and
@@ -284,26 +301,26 @@ 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 utilityValidateEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
-        // TODO(#10727): allow other contracts to deliver notes
+   */ 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}`);
         }
         // 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)).map(NoteValidationRequest.fromFields);
-        const eventValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot)).map(EventValidationRequest.fromFields);
-        const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore);
-        const noteDeliveries = noteValidationRequests.map((request)=>noteService.deliverNote(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.anchorBlockStore, this.aztecNode, this.privateEventStore);
-        const eventDeliveries = eventValidationRequests.map((request)=>eventService.deliverEvent(request.contractAddress, request.eventTypeId, request.serializedEvent, request.eventCommitment, request.txHash, request.recipient));
+        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([
-            ...noteDeliveries,
-            ...eventDeliveries
+            ...noteStorePromises,
+            ...eventStorePromises
         ]);
         // Requests are cleared once we're done.
-        await this.capsuleStore.setCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, []);
-        await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, []);
+        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
@@ -312,20 +329,21 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
         }
         // 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)).map(LogRetrievalRequest.fromFields);
-        const logService = new LogService(this.aztecNode, this.anchorBlockStore, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore);
+        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, []);
+        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));
+        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.capsuleStore.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)) {
@@ -333,21 +351,22 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.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.capsuleStore.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.capsuleStore.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.capsuleStore.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) {
@@ -364,7 +383,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
     }
     async getSharedSecret(address, ephPk) {
         // TODO(#12656): return an app-siloed secret
-        const recipientCompleteAddress = await this.getCompleteAddress(address);
+        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_sync/contract_sync_service.d.ts

@@ -0,0 +1,41 @@
+import type { Logger } from '@aztec/foundation/log';
+import type { FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { BlockHeader } from '@aztec/stdlib/tx';
+import type { StagedStore } from '../job_coordinator/job_coordinator.js';
+import type { ContractStore } from '../storage/contract_store/contract_store.js';
+import type { NoteStore } from '../storage/note_store/note_store.js';
+/**
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+ *
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
+ */
+export declare class ContractSyncService implements StagedStore {
+    #private;
+    private aztecNode;
+    private contractStore;
+    private noteStore;
+    private log;
+    readonly storeName = "contract_sync";
+    private syncedContracts;
+    private overriddenContracts;
+    constructor(aztecNode: AztecNode, contractStore: ContractStore, noteStore: NoteStore, log: Logger);
+    /** Sets contracts that should be skipped during sync for a specific job. */
+    setOverriddenContracts(jobId: string, addresses: Set<string>): void;
+    /**
+     * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
+     * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+     * @param contractAddress - The address of the contract to sync.
+     * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
+     * not sync_state itself).
+     * @param utilityExecutor - Executor function for running the sync_state utility function.
+     */
+    ensureContractSynced(contractAddress: AztecAddress, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (call: FunctionCall) => Promise<any>, anchorBlockHeader: BlockHeader, jobId: string): Promise<void>;
+    /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */
+    wipe(): void;
+    commit(jobId: string): Promise<void>;
+    discardStaged(jobId: string): Promise<void>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3Rfc3luY19zZXJ2aWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3Rfc3luYy9jb250cmFjdF9zeW5jX3NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDcEQsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLGdCQUFnQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFDeEUsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDaEUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFcEQsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sdUNBQXVDLENBQUM7QUFDekUsT0FBTyxLQUFLLEVBQUUsYUFBYSxFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFDakYsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFHckU7Ozs7O0dBS0c7QUFDSCxxQkFBYSxtQkFBb0IsWUFBVyxXQUFXOztJQVduRCxPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsYUFBYTtJQUNyQixPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsR0FBRztJQWJiLFFBQVEsQ0FBQyxTQUFTLG1CQUFtQjtJQUlyQyxPQUFPLENBQUMsZUFBZSxDQUF5QztJQUdoRSxPQUFPLENBQUMsbUJBQW1CLENBQXVDO0lBRWxFLFlBQ1UsU0FBUyxFQUFFLFNBQVMsRUFDcEIsYUFBYSxFQUFFLGFBQWEsRUFDNUIsU0FBUyxFQUFFLFNBQVMsRUFDcEIsR0FBRyxFQUFFLE1BQU0sRUFDakI7SUFFSiw0RUFBNEU7SUFDNUUsc0JBQXNCLENBQUMsS0FBSyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLElBQUksQ0FFbEU7SUFFRDs7Ozs7OztPQU9HO0lBQ0csb0JBQW9CLENBQ3hCLGVBQWUsRUFBRSxZQUFZLEVBQzdCLHlCQUF5QixFQUFFLGdCQUFnQixHQUFHLElBQUksRUFDbEQsZUFBZSxFQUFFLENBQUMsSUFBSSxFQUFFLFlBQVksS0FBSyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQ3JELGlCQUFpQixFQUFFLFdBQVcsRUFDOUIsS0FBSyxFQUFFLE1BQU0sR0FDWixPQUFPLENBQUMsSUFBSSxDQUFDLENBOEJmO0lBMEJELGdGQUFnRjtJQUNoRixJQUFJLElBQUksSUFBSSxDQUdYO0lBRUQsTUFBTSxDQUFDLEtBQUssRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUluQztJQUVELGFBQWEsQ0FBQyxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FNMUM7Q0FDRiJ9

package/dest/contract_sync/contract_sync_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract_sync_service.d.ts","sourceRoot":"","sources":["../../src/contract_sync/contract_sync_service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACjF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAGrE;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,WAAW;;IAWnD,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,GAAG;IAbb,QAAQ,CAAC,SAAS,mBAAmB;IAIrC,OAAO,CAAC,eAAe,CAAyC;IAGhE,OAAO,CAAC,mBAAmB,CAAuC;IAElE,YACU,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,SAAS,EAAE,SAAS,EACpB,GAAG,EAAE,MAAM,EACjB;IAEJ,4EAA4E;IAC5E,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAElE;IAED;;;;;;;OAOG;IACG,oBAAoB,CACxB,eAAe,EAAE,YAAY,EAC7B,yBAAyB,EAAE,gBAAgB,GAAG,IAAI,EAClD,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,GAAG,CAAC,EACrD,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CA8Bf;IA0BD,gFAAgF;IAChF,IAAI,IAAI,IAAI,CAGX;IAED,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAInC;IAED,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM1C;CACF"}

package/dest/contract_sync/contract_sync_service.js

@@ -0,0 +1,82 @@
+import { syncState, verifyCurrentClassId } from './helpers.js';
+/**
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+ *
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
+ */ export class ContractSyncService {
+    aztecNode;
+    contractStore;
+    noteStore;
+    log;
+    storeName;
+    // Tracks contracts synced since last wipe. Key is contract address string, value is a promise that resolves when
+    // the contract is synced.
+    syncedContracts;
+    // Per-job overridden contract addresses - these contracts should not be synced.
+    overriddenContracts;
+    constructor(aztecNode, contractStore, noteStore, log){
+        this.aztecNode = aztecNode;
+        this.contractStore = contractStore;
+        this.noteStore = noteStore;
+        this.log = log;
+        this.storeName = 'contract_sync';
+        this.syncedContracts = new Map();
+        this.overriddenContracts = new Map();
+    }
+    /** Sets contracts that should be skipped during sync for a specific job. */ setOverriddenContracts(jobId, addresses) {
+        this.overriddenContracts.set(jobId, addresses);
+    }
+    /**
+   * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
+   * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+   * @param contractAddress - The address of the contract to sync.
+   * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
+   * not sync_state itself).
+   * @param utilityExecutor - Executor function for running the sync_state utility function.
+   */ async ensureContractSynced(contractAddress, functionToInvokeAfterSync, utilityExecutor, anchorBlockHeader, jobId) {
+        const key = contractAddress.toString();
+        // Skip sync if this contract has an override for this job
+        const overrides = this.overriddenContracts.get(jobId);
+        if (overrides?.has(key)) {
+            return;
+        }
+        const existing = this.syncedContracts.get(key);
+        if (existing) {
+            return existing;
+        }
+        const syncPromise = this.#doSync(contractAddress, functionToInvokeAfterSync, utilityExecutor, anchorBlockHeader, jobId);
+        this.syncedContracts.set(key, syncPromise);
+        try {
+            await syncPromise;
+        } catch (err) {
+            // There was an error syncing the contract, so we remove it from the cache so that it can be retried.
+            this.syncedContracts.delete(key);
+            throw err;
+        }
+    }
+    async #doSync(contractAddress, functionToInvokeAfterSync, utilityExecutor, anchorBlockHeader, jobId) {
+        this.log.debug(`Syncing contract ${contractAddress}`);
+        await Promise.all([
+            syncState(contractAddress, this.contractStore, functionToInvokeAfterSync, utilityExecutor, this.noteStore, this.aztecNode, anchorBlockHeader, jobId),
+            verifyCurrentClassId(contractAddress, this.aztecNode, this.contractStore, anchorBlockHeader)
+        ]);
+        this.log.debug(`Contract ${contractAddress} synced`);
+    }
+    /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */ wipe() {
+        this.log.debug(`Wiping contract sync cache (${this.syncedContracts.size} entries)`);
+        this.syncedContracts.clear();
+    }
+    commit(jobId) {
+        // Clear overridden contracts for this job
+        this.overriddenContracts.delete(jobId);
+        return Promise.resolve();
+    }
+    discardStaged(jobId) {
+        // We clear the synced contracts cache here because, when the job is discarded, any associated database writes from
+        // the sync are also undone.
+        this.syncedContracts.clear();
+        this.overriddenContracts.delete(jobId);
+        return Promise.resolve();
+    }
+}

package/dest/contract_sync/helpers.d.ts

@@ -0,0 +1,28 @@
+import type { FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { ContractInstance } from '@aztec/stdlib/contract';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { BlockHeader } from '@aztec/stdlib/tx';
+import type { ContractStore } from '../storage/contract_store/contract_store.js';
+import type { NoteStore } from '../storage/note_store/note_store.js';
+/**
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
+ * from the instance is used.
+ * @param contractAddress - The address of the contract to read the class id for.
+ * @param instance - The instance of the contract.
+ * @param aztecNode - The Aztec node to query for storage.
+ * @param header - The header of the block at which to load the DelayedPublicMutable storing the class id.
+ * @returns The current class id.
+ */
+export declare function readCurrentClassId(contractAddress: AztecAddress, instance: ContractInstance, aztecNode: AztecNode, header: BlockHeader): Promise<import("@aztec/foundation/schemas").Fr>;
+export declare function syncState(contractAddress: AztecAddress, contractStore: ContractStore, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (privateSyncCall: FunctionCall) => Promise<any>, noteStore: NoteStore, aztecNode: AztecNode, anchorBlockHeader: BlockHeader, jobId: string): Promise<void>;
+/**
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in contract data
+ * provider (i.e. PXE's own storage).
+ * @param contractAddress - The address of the contract to verify.
+ * @param aztecNode - The Aztec node to query for storage.
+ * @param contractStore - The contract store to fetch the local instance from.
+ * @param header - The header of the block at which to verify the current class id.
+ */
+export declare function verifyCurrentClassId(contractAddress: AztecAddress, aztecNode: AztecNode, contractStore: ContractStore, header: BlockHeader): Promise<void>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X3N5bmMvaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUN4RSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRS9ELE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQ2pFLE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR3BELE9BQU8sS0FBSyxFQUFFLGFBQWEsRUFBRSxNQUFNLDZDQUE2QyxDQUFDO0FBQ2pGLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHFDQUFxQyxDQUFDO0FBRXJFOzs7Ozs7OztHQVFHO0FBQ0gsd0JBQXNCLGtCQUFrQixDQUN0QyxlQUFlLEVBQUUsWUFBWSxFQUM3QixRQUFRLEVBQUUsZ0JBQWdCLEVBQzFCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLE1BQU0sRUFBRSxXQUFXLG1EQWFwQjtBQUVELHdCQUFzQixTQUFTLENBQzdCLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGFBQWEsRUFBRSxhQUFhLEVBQzVCLHlCQUF5QixFQUFFLGdCQUFnQixHQUFHLElBQUksRUFDbEQsZUFBZSxFQUFFLENBQUMsZUFBZSxFQUFFLFlBQVksS0FBSyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQ2hFLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLGlCQUFpQixFQUFFLFdBQVcsRUFDOUIsS0FBSyxFQUFFLE1BQU0saUJBaUJkO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILHdCQUFzQixvQkFBb0IsQ0FDeEMsZUFBZSxFQUFFLFlBQVksRUFDN0IsU0FBUyxFQUFFLFNBQVMsRUFDcEIsYUFBYSxFQUFFLGFBQWEsRUFDNUIsTUFBTSxFQUFFLFdBQVcsaUJBYXBCIn0=

package/dest/contract_sync/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/contract_sync/helpers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACjF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAErE;;;;;;;;GAQG;AACH,wBAAsB,kBAAkB,CACtC,eAAe,EAAE,YAAY,EAC7B,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,WAAW,mDAapB;AAED,wBAAsB,SAAS,CAC7B,eAAe,EAAE,YAAY,EAC7B,aAAa,EAAE,aAAa,EAC5B,yBAAyB,EAAE,gBAAgB,GAAG,IAAI,EAClD,eAAe,EAAE,CAAC,eAAe,EAAE,YAAY,KAAK,OAAO,CAAC,GAAG,CAAC,EAChE,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,iBAiBd;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,WAAW,iBAapB"}