@aztec/pxe 0.0.1-commit.24de95ac → 0.0.1-commit.2606882

package/dest/logs/log_service.js

@@ -0,0 +1,172 @@
+import { createLogger } from '@aztec/foundation/log';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { AppTaggingSecret, PendingTaggedLog, SiloedTag } from '@aztec/stdlib/logs';
+import { LogSource } from '../contract_function_simulator/noir-structs/log_retrieval_request.js';
+import { LogRetrievalResponse } from '../contract_function_simulator/noir-structs/log_retrieval_response.js';
+import { getAllPrivateLogsByTags, getAllPublicLogsByTagsFromContract, syncTaggedPrivateLogs } from '../tagging/index.js';
+const rangeKey = (fromBlock, toBlock)=>`${fromBlock ?? ''}-${toBlock ?? ''}`;
+export class LogService {
+    aztecNode;
+    anchorBlockHeader;
+    l2TipsStore;
+    keyStore;
+    recipientTaggingStore;
+    senderAddressBookStore;
+    addressStore;
+    jobId;
+    log;
+    constructor(aztecNode, anchorBlockHeader, l2TipsStore, keyStore, recipientTaggingStore, senderAddressBookStore, addressStore, jobId, bindings){
+        this.aztecNode = aztecNode;
+        this.anchorBlockHeader = anchorBlockHeader;
+        this.l2TipsStore = l2TipsStore;
+        this.keyStore = keyStore;
+        this.recipientTaggingStore = recipientTaggingStore;
+        this.senderAddressBookStore = senderAddressBookStore;
+        this.addressStore = addressStore;
+        this.jobId = jobId;
+        this.log = createLogger('pxe:log_service', bindings);
+    }
+    /** Fetches all logs matching each request's tag, returning an array of log arrays (one per request). */ async fetchLogsByTag(contractAddress, logRetrievalRequests) {
+        for (const request of logRetrievalRequests){
+            if (!contractAddress.equals(request.contractAddress)) {
+                throw new Error(`Got a log retrieval request from ${request.contractAddress}, expected ${contractAddress}`);
+            }
+        }
+        if (logRetrievalRequests.length === 0) {
+            return [];
+        }
+        const anchorBlockHash = await this.anchorBlockHeader.hash();
+        const [publicLogsPerRequest, privateLogsPerRequest] = await Promise.all([
+            this.#fetchPublicLogs(contractAddress, logRetrievalRequests, anchorBlockHash),
+            this.#fetchPrivateLogs(logRetrievalRequests, anchorBlockHash)
+        ]);
+        return logRetrievalRequests.map((_request, i)=>[
+                ...publicLogsPerRequest[i].map(LogService.#toLogRetrievalResponse),
+                ...privateLogsPerRequest[i].map(LogService.#toLogRetrievalResponse)
+            ]);
+    }
+    async #fetchPublicLogs(contractAddress, requests, anchorBlockHash) {
+        const indices = requests.flatMap((r, i)=>r.source !== LogSource.PRIVATE ? [
+                i
+            ] : []);
+        if (indices.length === 0) {
+            return requests.map(()=>[]);
+        }
+        const resultsPerRequest = requests.map(()=>[]);
+        const groups = LogService.#groupByRange(indices.map((i)=>({
+                index: i,
+                request: requests[i]
+            })));
+        await Promise.all(Array.from(groups.values()).map(async (group)=>{
+            const tags = group.entries.map((e)=>e.request.tag);
+            const results = await getAllPublicLogsByTagsFromContract(this.aztecNode, contractAddress, tags, anchorBlockHash, {
+                fromBlock: group.fromBlock,
+                toBlock: group.toBlock,
+                includeEffects: true
+            });
+            group.entries.forEach((entry, i)=>{
+                resultsPerRequest[entry.index] = results[i];
+            });
+        }));
+        return resultsPerRequest;
+    }
+    async #fetchPrivateLogs(requests, anchorBlockHash) {
+        const indices = requests.flatMap((r, i)=>r.source !== LogSource.PUBLIC ? [
+                i
+            ] : []);
+        if (indices.length === 0) {
+            return requests.map(()=>[]);
+        }
+        const resultsPerRequest = requests.map(()=>[]);
+        const groups = LogService.#groupByRange(indices.map((i)=>({
+                index: i,
+                request: requests[i]
+            })));
+        await Promise.all(Array.from(groups.values()).map(async (group)=>{
+            const siloedTags = await Promise.all(group.entries.map((e)=>SiloedTag.computeFromTagAndApp(e.request.tag, e.request.contractAddress)));
+            const results = await getAllPrivateLogsByTags(this.aztecNode, siloedTags, anchorBlockHash, {
+                fromBlock: group.fromBlock,
+                toBlock: group.toBlock,
+                includeEffects: true
+            });
+            group.entries.forEach((entry, i)=>{
+                resultsPerRequest[entry.index] = results[i];
+            });
+        }));
+        return resultsPerRequest;
+    }
+    /**
+   * Groups requests by their (fromBlock, toBlock) range so each distinct range becomes a single node call with
+   * the range pushed down into the query (no in-memory filter).
+   */ static #groupByRange(entries) {
+        const groups = new Map();
+        for (const entry of entries){
+            const key = rangeKey(entry.request.fromBlock, entry.request.toBlock);
+            const existing = groups.get(key);
+            if (existing) {
+                existing.entries.push(entry);
+            } else {
+                groups.set(key, {
+                    fromBlock: entry.request.fromBlock,
+                    toBlock: entry.request.toBlock,
+                    entries: [
+                        entry
+                    ]
+                });
+            }
+        }
+        return groups;
+    }
+    static #toLogRetrievalResponse(log) {
+        // includeEffects: true was used, so noteHashes and nullifiers are populated. Every tx has at least one nullifier
+        // (the first nullifier derived from the tx hash); empty here would indicate a buggy node.
+        const noteHashes = log.noteHashes;
+        const nullifiers = log.nullifiers;
+        if (nullifiers.length === 0) {
+            throw new Error(`Log for tx ${log.txHash} returned no nullifiers from the node`);
+        }
+        return new LogRetrievalResponse(log.logData.slice(1), log.txHash, noteHashes, nullifiers[0]);
+    }
+    async fetchTaggedLogs(contractAddress, recipient, providedSecrets) {
+        this.log.verbose(`Fetching tagged logs for ${contractAddress.toString()}`);
+        const l2Tips = await this.l2TipsStore.getL2Tips();
+        // The secrets PXE derives or stores internally, plus any the app supplies explicitly for secrets PXE cannot
+        // enumerate itself (e.g. handshake-derived ones).
+        const secrets = [
+            ...await this.#getSecretsForSenders(contractAddress, recipient),
+            ...providedSecrets
+        ];
+        const logs = await syncTaggedPrivateLogs(secrets, this.aztecNode, this.recipientTaggingStore, this.anchorBlockHeader, l2Tips.finalized.block.number, this.jobId);
+        return logs.map((log)=>{
+            const noteHashes = log.noteHashes;
+            const nullifiers = log.nullifiers;
+            if (nullifiers.length === 0) {
+                throw new Error(`Log for tx ${log.txHash} returned no nullifiers from the node`);
+            }
+            return new PendingTaggedLog(log.logData, log.txHash, noteHashes, nullifiers[0]);
+        });
+    }
+    async #getSecretsForSenders(contractAddress, recipient) {
+        const recipientCompleteAddress = await this.addressStore.getCompleteAddress(recipient);
+        if (!recipientCompleteAddress) {
+            return [];
+        }
+        const recipientIvsk = await this.keyStore.getMasterIncomingViewingSecretKey(recipient);
+        // We implicitly add all PXE accounts as senders, this helps us find tagged logs with messages that are sent to a
+        // local account (recipient = us, sender = us)
+        const allSenders = [
+            ...await this.senderAddressBookStore.getSenders(),
+            ...await this.keyStore.getAccounts()
+        ];
+        // We deduplicate the senders by adding them to a set and then converting the set back to an array
+        const deduplicatedSenders = Array.from(new Set(allSenders.map((sender)=>sender.toString()))).map((sender)=>AztecAddress.fromString(sender));
+        return Promise.all(deduplicatedSenders.map(async (sender)=>{
+            const secret = await AppTaggingSecret.computeUnconstrained(recipientCompleteAddress, recipientIvsk, sender, contractAddress, recipient);
+            if (!secret) {
+                // Note that all senders originate from either the SenderAddressBookStore or the KeyStore.
+                throw new Error(`Failed to compute a tagging secret for sender ${sender} - this implies this is an invalid address, which should not happen as they have been previously registered in PXE.`);
+            }
+            return secret;
+        }));
+    }
+}

package/dest/messages/message_context_service.d.ts

@@ -0,0 +1,17 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import type { AztecNode } from '@aztec/stdlib/interfaces/server';
+import { MessageContext } from '@aztec/stdlib/logs';
+/** Resolves transaction hashes into the context needed to process messages. */
+export declare class MessageContextService {
+    private readonly aztecNode;
+    constructor(aztecNode: AztecNode);
+    /**
+     * Resolves a list of tx hashes into their message contexts.
+     *
+     * For each tx hash, looks up the corresponding tx effect and extracts the note hashes and first nullifier needed to
+     * process messages that originated from that transaction. Returns `null` for tx hashes that are zero, not yet
+     * available, or in blocks beyond the anchor block.
+     */
+    getMessageContextsByTxHash(txHashes: Fr[], anchorBlockNumber: number): Promise<(MessageContext | null)[]>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWVzc2FnZV9jb250ZXh0X3NlcnZpY2UuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tZXNzYWdlcy9tZXNzYWdlX2NvbnRleHRfc2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDcEQsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBR3BELCtFQUErRTtBQUMvRSxxQkFBYSxxQkFBcUI7SUFDcEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxTQUFTO0lBQXRDLFlBQTZCLFNBQVMsRUFBRSxTQUFTLEVBQUk7SUFFckQ7Ozs7OztPQU1HO0lBQ0csMEJBQTBCLENBQUMsUUFBUSxFQUFFLEVBQUUsRUFBRSxFQUFFLGlCQUFpQixFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsQ0FBQyxjQUFjLEdBQUcsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQTJDOUc7Q0FDRiJ9

package/dest/messages/message_context_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message_context_service.d.ts","sourceRoot":"","sources":["../../src/messages/message_context_service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD,+EAA+E;AAC/E,qBAAa,qBAAqB;IACpB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,SAAS,EAAI;IAErD;;;;;;OAMG;IACG,0BAA0B,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,EAAE,CAAC,CA2C9G;CACF"}

package/dest/messages/message_context_service.js

@@ -0,0 +1,55 @@
+import { uniqueBy } from '@aztec/foundation/collection';
+import { MessageContext } from '@aztec/stdlib/logs';
+import { TxHash } from '@aztec/stdlib/tx';
+/** Resolves transaction hashes into the context needed to process messages. */ export class MessageContextService {
+    aztecNode;
+    constructor(aztecNode){
+        this.aztecNode = aztecNode;
+    }
+    /**
+   * Resolves a list of tx hashes into their message contexts.
+   *
+   * For each tx hash, looks up the corresponding tx effect and extracts the note hashes and first nullifier needed to
+   * process messages that originated from that transaction. Returns `null` for tx hashes that are zero, not yet
+   * available, or in blocks beyond the anchor block.
+   */ async getMessageContextsByTxHash(txHashes, anchorBlockNumber) {
+        const nonZeroTxHashes = txHashes.filter((h)=>!h.isZero()).map((h)=>TxHash.fromField(h));
+        const uniqueTxHashes = uniqueBy(nonZeroTxHashes, (h)=>h.toString());
+        const fetched = await Promise.all(uniqueTxHashes.map((h)=>this.aztecNode.getTxReceipt(h, {
+                includeTxEffect: true
+            })));
+        const txEffects = new Map(uniqueTxHashes.map((h, i)=>{
+            const receipt = fetched[i];
+            if (!receipt.isMined() || !receipt.txEffect) {
+                return [
+                    h.toString(),
+                    undefined
+                ];
+            }
+            return [
+                h.toString(),
+                {
+                    data: receipt.txEffect,
+                    l2BlockNumber: receipt.blockNumber,
+                    l2BlockHash: receipt.blockHash,
+                    txIndexInBlock: receipt.txIndexInBlock,
+                    slotNumber: receipt.slotNumber
+                }
+            ];
+        }).filter((entry)=>entry[1] !== undefined));
+        return txHashes.map((txHashField)=>{
+            const txHash = TxHash.fromField(txHashField);
+            const txEffect = txEffects.get(txHash.toString());
+            if (!txEffect || txEffect.l2BlockNumber > anchorBlockNumber) {
+                return null;
+            }
+            // Every tx has at least one nullifier (the first nullifier derived from the tx hash). Hitting this condition
+            // would mean a buggy node, but since we need to access data.nullifiers[0], the defensive check does no harm.
+            const data = txEffect.data;
+            if (data.nullifiers.length === 0) {
+                throw new Error(`Tx effect for ${txHash} has no nullifiers`);
+            }
+            return new MessageContext(data.txHash, data.noteHashes, data.nullifiers[0]);
+        });
+    }
+}

package/dest/notes/index.d.ts

@@ -0,0 +1,2 @@
+export { NoteService } from './note_service.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ub3Rlcy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sbUJBQW1CLENBQUMifQ==

package/dest/notes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/notes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC"}

package/dest/notes/index.js

@@ -0,0 +1 @@
+export { NoteService } from './note_service.js';

package/dest/notes/note_service.d.ts

@@ -0,0 +1,70 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { type AztecNode } from '@aztec/stdlib/interfaces/client';
+import { Note, NoteStatus } from '@aztec/stdlib/note';
+import type { BlockHeader, IndexedTxEffect } from '@aztec/stdlib/tx';
+import type { NoteValidationRequest } from '../contract_function_simulator/noir-structs/note_validation_request.js';
+import type { NoteStore } from '../storage/note_store/note_store.js';
+export declare class NoteService {
+    #private;
+    private readonly noteStore;
+    private readonly aztecNode;
+    private readonly anchorBlockHeader;
+    private readonly jobId;
+    constructor(noteStore: NoteStore, aztecNode: AztecNode, anchorBlockHeader: BlockHeader, jobId: string);
+    /**
+     * Retrieves a set of notes stored in the database for a given contract address and storage slot.
+     * The query result is paginated using 'limit' and 'offset' values.
+     * Returns an object containing an array of note data.
+     *
+     * @param owner - The owner of the notes. If undefined, returns notes for all known owners.
+     * @param status - The status of notes to fetch.
+     * @param scopes - The accounts whose notes we can access in this call. Currently optional and will default to all.
+     */
+    getNotes(contractAddress: AztecAddress, owner: AztecAddress | undefined, storageSlot: Fr, status: NoteStatus, scopes: AztecAddress[]): Promise<{
+        contractAddress: AztecAddress;
+        owner: AztecAddress;
+        storageSlot: Fr;
+        randomness: Fr;
+        noteNonce: Fr;
+        note: Note;
+        noteHash: Fr;
+        isPending: boolean;
+        siloedNullifier: Fr;
+    }[]>;
+    /**
+     * Looks for nullifiers of active contract notes and marks them as nullified if a nullifier is found.
+     *
+     * Fetches notes from the NoteStore and checks which nullifiers are present in the
+     * onchain nullifier Merkle tree - up to the latest locally synced block. We use the
+     * locally synced block instead of querying the chain's 'latest' block to ensure correctness:
+     * notes are only marked nullified once their corresponding nullifier has been included in a
+     * block up to which the PXE has synced.
+     * This allows recent nullifications to be processed even if the node is not an archive node.
+     *
+     * @param contractAddress - The contract whose notes should be checked and nullified.
+     */
+    syncNoteNullifiers(contractAddress: AztecAddress, scopes: AztecAddress[]): Promise<void>;
+    /**
+     * Validates and stores a batch of notes against pre-fetched tx effects.
+     *
+     * For each request we must verify that:
+     *  - the note actually exists in the corresponding tx effect (and thus in the note hash tree), and
+     *  - the note has not already been nullified.
+     *
+     * Failing to do either would result in circuits getting either non-existent notes and failing to produce inclusion
+     * proofs for them, or getting nullified notes and producing duplicate nullifiers, both of which are catastrophic
+     * failure modes.
+     *
+     * Note that adding a note and removing it is *not* equivalent to never adding it in the first place. A nullifier
+     * emitted in a block that comes after note creation might result in the note being de-nullified by a chain reorg,
+     * so we must store both the note hash and nullifier block information.
+     *
+     * @param requests - The notes to validate and store.
+     * @param scope - The scope under which the notes are being stored.
+     * @param txEffects - Pre-fetched tx effects keyed by `TxHash.toString()`. Must contain entries for every request's
+     *                   txHash; missing entries are treated as a node bug and cause an error.
+     */
+    validateAndStoreNotes(requests: NoteValidationRequest[], scope: AztecAddress, txEffects: Map<string, IndexedTxEffect>): Promise<void>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm90ZV9zZXJ2aWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbm90ZXMvbm90ZV9zZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxFQUFFLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUNwRCxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUdoRSxPQUFPLEVBQUUsS0FBSyxTQUFTLEVBQWUsTUFBTSxpQ0FBaUMsQ0FBQztBQUM5RSxPQUFPLEVBQUUsSUFBSSxFQUFXLFVBQVUsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRS9ELE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxlQUFlLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUVyRSxPQUFPLEtBQUssRUFBRSxxQkFBcUIsRUFBRSxNQUFNLHdFQUF3RSxDQUFDO0FBQ3BILE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHFDQUFxQyxDQUFDO0FBRXJFLHFCQUFhLFdBQVc7O0lBRXBCLE9BQU8sQ0FBQyxRQUFRLENBQUMsU0FBUztJQUMxQixPQUFPLENBQUMsUUFBUSxDQUFDLFNBQVM7SUFDMUIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxpQkFBaUI7SUFDbEMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxLQUFLO0lBSnhCLFlBQ21CLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLGlCQUFpQixFQUFFLFdBQVcsRUFDOUIsS0FBSyxFQUFFLE1BQU0sRUFDNUI7SUFFSjs7Ozs7Ozs7T0FRRztJQUNVLFFBQVEsQ0FDbkIsZUFBZSxFQUFFLFlBQVksRUFDN0IsS0FBSyxFQUFFLFlBQVksR0FBRyxTQUFTLEVBQy9CLFdBQVcsRUFBRSxFQUFFLEVBQ2YsTUFBTSxFQUFFLFVBQVUsRUFDbEIsTUFBTSxFQUFFLFlBQVksRUFBRTs7Ozs7Ozs7OztTQXlCdkI7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNVLGtCQUFrQixDQUFDLGVBQWUsRUFBRSxZQUFZLEVBQUUsTUFBTSxFQUFFLFlBQVksRUFBRSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FxQnBHO0lBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7T0FtQkc7SUFDVSxxQkFBcUIsQ0FDaEMsUUFBUSxFQUFFLHFCQUFxQixFQUFFLEVBQ2pDLEtBQUssRUFBRSxZQUFZLEVBQ25CLFNBQVMsRUFBRSxHQUFHLENBQUMsTUFBTSxFQUFFLGVBQWUsQ0FBQyxHQUN0QyxPQUFPLENBQUMsSUFBSSxDQUFDLENBa0dmO0NBVUYifQ==

package/dest/notes/note_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"note_service.d.ts","sourceRoot":"","sources":["../../src/notes/note_service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAGhE,OAAO,EAAE,KAAK,SAAS,EAAe,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,IAAI,EAAW,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE/D,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAErE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wEAAwE,CAAC;AACpH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAErE,qBAAa,WAAW;;IAEpB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK;IAJxB,YACmB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,EAC5B;IAEJ;;;;;;;;OAQG;IACU,QAAQ,CACnB,eAAe,EAAE,YAAY,EAC7B,KAAK,EAAE,YAAY,GAAG,SAAS,EAC/B,WAAW,EAAE,EAAE,EACf,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,YAAY,EAAE;;;;;;;;;;SAyBvB;IAED;;;;;;;;;;;OAWG;IACU,kBAAkB,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAqBpG;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACU,qBAAqB,CAChC,QAAQ,EAAE,qBAAqB,EAAE,EACjC,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,GACtC,OAAO,CAAC,IAAI,CAAC,CAkGf;CAUF"}

package/dest/notes/note_service.js

@@ -0,0 +1,172 @@
+import { chunk } from '@aztec/foundation/collection';
+import { computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
+import { MAX_RPC_LEN } from '@aztec/stdlib/interfaces/client';
+import { Note, NoteDao } from '@aztec/stdlib/note';
+import { MerkleTreeId } from '@aztec/stdlib/trees';
+export class NoteService {
+    noteStore;
+    aztecNode;
+    anchorBlockHeader;
+    jobId;
+    constructor(noteStore, aztecNode, anchorBlockHeader, jobId){
+        this.noteStore = noteStore;
+        this.aztecNode = aztecNode;
+        this.anchorBlockHeader = anchorBlockHeader;
+        this.jobId = jobId;
+    }
+    /**
+   * Retrieves a set of notes stored in the database for a given contract address and storage slot.
+   * The query result is paginated using 'limit' and 'offset' values.
+   * Returns an object containing an array of note data.
+   *
+   * @param owner - The owner of the notes. If undefined, returns notes for all known owners.
+   * @param status - The status of notes to fetch.
+   * @param scopes - The accounts whose notes we can access in this call. Currently optional and will default to all.
+   */ async getNotes(contractAddress, owner, storageSlot, status, scopes) {
+        const noteDaos = await this.noteStore.getNotes({
+            contractAddress,
+            owner,
+            storageSlot,
+            status,
+            scopes
+        }, this.jobId);
+        return noteDaos.map(({ contractAddress, owner, storageSlot, randomness, noteNonce, note, noteHash, siloedNullifier })=>({
+                contractAddress,
+                owner,
+                storageSlot,
+                randomness,
+                noteNonce,
+                note,
+                noteHash,
+                isPending: false,
+                siloedNullifier
+            }));
+    }
+    /**
+   * Looks for nullifiers of active contract notes and marks them as nullified if a nullifier is found.
+   *
+   * Fetches notes from the NoteStore and checks which nullifiers are present in the
+   * onchain nullifier Merkle tree - up to the latest locally synced block. We use the
+   * locally synced block instead of querying the chain's 'latest' block to ensure correctness:
+   * notes are only marked nullified once their corresponding nullifier has been included in a
+   * block up to which the PXE has synced.
+   * This allows recent nullifications to be processed even if the node is not an archive node.
+   *
+   * @param contractAddress - The contract whose notes should be checked and nullified.
+   */ async syncNoteNullifiers(contractAddress, scopes) {
+        const anchorBlockHash = await this.anchorBlockHeader.hash();
+        const contractNotes = await this.noteStore.getNotes({
+            contractAddress,
+            scopes
+        }, this.jobId);
+        if (contractNotes.length === 0) {
+            return;
+        }
+        const nullifiersToCheck = contractNotes.map((note)=>note.siloedNullifier);
+        const nullifierIndexes = await this.#findNullifierIndexes(anchorBlockHash, nullifiersToCheck);
+        const foundNullifiers = nullifiersToCheck.map((nullifier, i)=>{
+            if (nullifierIndexes[i] !== undefined) {
+                return {
+                    ...nullifierIndexes[i],
+                    ...{
+                        data: nullifier
+                    }
+                };
+            }
+        }).filter((nullifier)=>nullifier !== undefined);
+        await this.noteStore.applyNullifiers(foundNullifiers, this.jobId);
+    }
+    /**
+   * Validates and stores a batch of notes against pre-fetched tx effects.
+   *
+   * For each request we must verify that:
+   *  - the note actually exists in the corresponding tx effect (and thus in the note hash tree), and
+   *  - the note has not already been nullified.
+   *
+   * Failing to do either would result in circuits getting either non-existent notes and failing to produce inclusion
+   * proofs for them, or getting nullified notes and producing duplicate nullifiers, both of which are catastrophic
+   * failure modes.
+   *
+   * Note that adding a note and removing it is *not* equivalent to never adding it in the first place. A nullifier
+   * emitted in a block that comes after note creation might result in the note being de-nullified by a chain reorg,
+   * so we must store both the note hash and nullifier block information.
+   *
+   * @param requests - The notes to validate and store.
+   * @param scope - The scope under which the notes are being stored.
+   * @param txEffects - Pre-fetched tx effects keyed by `TxHash.toString()`. Must contain entries for every request's
+   *                   txHash; missing entries are treated as a node bug and cause an error.
+   */ async validateAndStoreNotes(requests, scope, txEffects) {
+        if (requests.length === 0) {
+            return;
+        }
+        // We avoid making node queries at 'latest' since we don't want to process notes or nullifiers that only exist ahead
+        // in time of the locally synced state.
+        // Note that while this technically results in historical queries, we perform it at the latest locally synced block
+        // number which *should* be recent enough to be available, even for non-archive nodes.
+        // Also note that the note should never be ahead of the synced block here since `fetchTaggedLogs` only processes
+        // logs up to the synced block making this only an additional safety check.
+        const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
+        const anchorBlockHash = await this.anchorBlockHeader.hash();
+        // By computing siloed and unique note hashes ourselves we prevent contracts from interfering with the note storage
+        // of other contracts, which would constitute a security breach.
+        const computed = await Promise.all(requests.map(async ({ contractAddress, noteHash, nullifier, noteNonce })=>{
+            const [siloedNoteHash, siloedNullifier] = await Promise.all([
+                siloNoteHash(contractAddress, noteHash),
+                siloNullifier(contractAddress, nullifier)
+            ]);
+            const uniqueNoteHash = await computeUniqueNoteHash(noteNonce, siloedNoteHash);
+            return {
+                uniqueNoteHash,
+                siloedNullifier
+            };
+        }));
+        const nullifierIndexes = await this.#findNullifierIndexes(anchorBlockHash, computed.map((c)=>c.siloedNullifier));
+        const noteDaos = [];
+        const foundNullifiers = [];
+        for(let i = 0; i < requests.length; i++){
+            const { contractAddress, owner, storageSlot, randomness, noteNonce, content, noteHash, txHash } = requests[i];
+            const { uniqueNoteHash, siloedNullifier } = computed[i];
+            const nullifierIndex = nullifierIndexes[i];
+            const txEffect = txEffects.get(txHash.toString());
+            if (!txEffect) {
+                // We error out instead of just logging a warning and skipping the note because this would indicate a bug. This
+                // is because the node has already served info about this tx either when obtaining the log (LogResult carries
+                // the tx info) or when getting metadata for the offchain message (before the message got passed to
+                // `process_log`).
+                throw new Error(`Could not find tx effect for tx hash ${txHash} when processing a note.`);
+            }
+            if (txEffect.l2BlockNumber > anchorBlockNumber) {
+                // If the message was delivered onchain, this would indicate a bug: log sync should never load logs from blocks
+                // newer than the anchor block. If the note came via an offchain message, it would likely also be a bug, since
+                // we sync a new anchor block before calling `process_message`. For this not to be a bug, the message would
+                // need to come from a newer block than the anchor served by the node, implying the node isn't properly synced.
+                //     We therefore error out here rather than assuming the offchain message was constructed by a malicious
+                // sender with the intention of bricking recipient's PXE (if we assumed that we would just ignore the message).
+                throw new Error(`Obtained a newer tx effect for ${txHash} for a note validation request than the anchor block ${anchorBlockNumber}. This is a bug as we should not ever be processing a note from a newer block than the anchor block.`);
+            }
+            // Find the index of the note hash in the noteHashes array to determine note ordering within the tx
+            const noteIndexInTx = txEffect.data.noteHashes.findIndex((nh)=>nh.equals(uniqueNoteHash));
+            if (noteIndexInTx === -1) {
+                // Similar to the comment above - we error out as this would indicate a bug in nonce discovery.
+                throw new Error(`Note hash ${noteHash} (uniqued as ${uniqueNoteHash}) is not present in tx ${txHash}`);
+            }
+            noteDaos.push(new NoteDao(new Note(content), contractAddress, owner, storageSlot, randomness, noteNonce, noteHash, siloedNullifier, txHash, txEffect.l2BlockNumber, txEffect.l2BlockHash.toString(), txEffect.txIndexInBlock, noteIndexInTx));
+            if (nullifierIndex !== undefined) {
+                // We found a nullifier index which implies that the note has already been nullified.
+                const { data: _, ...blockHashAndNum } = nullifierIndex;
+                foundNullifiers.push({
+                    data: siloedNullifier,
+                    ...blockHashAndNum
+                });
+            }
+        }
+        await this.noteStore.addNotes(noteDaos, scope, this.jobId);
+        if (foundNullifiers.length > 0) {
+            await this.noteStore.applyNullifiers(foundNullifiers, this.jobId);
+        }
+    }
+    async #findNullifierIndexes(anchorBlockHash, siloedNullifiers) {
+        const batches = chunk(siloedNullifiers, MAX_RPC_LEN);
+        return (await Promise.all(batches.map((batch)=>this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, batch)))).flat();
+    }
+}

package/dest/notes_filter.d.ts

@@ -0,0 +1,24 @@
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { NoteStatus } from '@aztec/stdlib/note';
+/**
+ * A filter used to fetch notes.
+ * @remarks This filter is applied as an intersection of all its params.
+ */
+export type NotesFilter = {
+    /**
+     * The contract address the note belongs to.
+     * @remarks Providing a contract address is required as we need that information to trigger private state sync.
+     */
+    contractAddress: AztecAddress;
+    /** The owner of the note. */
+    owner?: AztecAddress;
+    /** The specific storage location of the note on the contract. */
+    storageSlot?: Fr;
+    /** The status of the note. Defaults to 'ACTIVE'. */
+    status?: NoteStatus;
+    /** The siloed nullifier for the note. */
+    siloedNullifier?: Fr;
+    scopes: AztecAddress[];
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm90ZXNfZmlsdGVyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvbm90ZXNfZmlsdGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3pELE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ2hFLE9BQU8sS0FBSyxFQUFFLFVBQVUsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRXJEOzs7R0FHRztBQUNILE1BQU0sTUFBTSxXQUFXLEdBQUc7SUFDeEI7OztPQUdHO0lBQ0gsZUFBZSxFQUFFLFlBQVksQ0FBQztJQUM5Qiw2QkFBNkI7SUFDN0IsS0FBSyxDQUFDLEVBQUUsWUFBWSxDQUFDO0lBQ3JCLGlFQUFpRTtJQUNqRSxXQUFXLENBQUMsRUFBRSxFQUFFLENBQUM7SUFDakIsb0RBQW9EO0lBQ3BELE1BQU0sQ0FBQyxFQUFFLFVBQVUsQ0FBQztJQUNwQix5Q0FBeUM7SUFDekMsZUFBZSxDQUFDLEVBQUUsRUFBRSxDQUFDO0lBQ3JCLE1BQU0sRUFBRSxZQUFZLEVBQUUsQ0FBQztDQUN4QixDQUFDIn0=

package/dest/notes_filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notes_filter.d.ts","sourceRoot":"","sources":["../src/notes_filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;;OAGG;IACH,eAAe,EAAE,YAAY,CAAC;IAC9B,6BAA6B;IAC7B,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,iEAAiE;IACjE,WAAW,CAAC,EAAE,EAAE,CAAC;IACjB,oDAAoD;IACpD,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,yCAAyC;IACzC,eAAe,CAAC,EAAE,EAAE,CAAC;IACrB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC"}

package/dest/notes_filter.js

@@ -0,0 +1,4 @@
+/**
+ * A filter used to fetch notes.
+ * @remarks This filter is applied as an intersection of all its params.
+ */ export { };

package/dest/oracle_version.d.ts

@@ -1,3 +1,4 @@
-export declare const ORACLE_VERSION = 3;
-export declare const ORACLE_INTERFACE_HASH = "f9168ceb5a2227c148c5021ebffd4e2ca0da99885b87c5be3ee5ac0d8dd3d67c";
-//# sourceMappingURL=oracle_version.d.ts.map
+export declare const ORACLE_VERSION_MAJOR = 29;
+export declare const ORACLE_VERSION_MINOR = 0;
+export declare const ORACLE_INTERFACE_HASH = "157fe8fa79f0e5a25db3d61341f9bcf5b43cb68367bea497204006daa48751b6";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3JhY2xlX3ZlcnNpb24uZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9vcmFjbGVfdmVyc2lvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFZQSxlQUFPLE1BQU0sb0JBQW9CLEtBQUssQ0FBQztBQUN2QyxlQUFPLE1BQU0sb0JBQW9CLElBQUksQ0FBQztBQVF0QyxlQUFPLE1BQU0scUJBQXFCLHFFQUFxRSxDQUFDIn0=

package/dest/oracle_version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"oracle_version.d.ts","sourceRoot":"","sources":["../src/oracle_version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,cAAc,IAAI,CAAC;AAIhC,eAAO,MAAM,qBAAqB,qEAAqE,CAAC"}
+{"version":3,"file":"oracle_version.d.ts","sourceRoot":"","sources":["../src/oracle_version.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAQtC,eAAO,MAAM,qBAAqB,qEAAqE,CAAC"}

package/dest/oracle_version.js

@@ -1,10 +1,21 @@
-/// The ORACLE_VERSION constant is used to check that the oracle interface is in sync between PXE and Aztec.nr. We need
-/// to version the oracle interface to ensure that developers get a reasonable error message if they use incompatible
-/// versions of Aztec.nr and PXE. The Noir counterpart is in `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
+/// The oracle version constants are used to check that the oracle interface is in sync between PXE and Aztec.nr.
+/// We version the oracle interface as `major.minor` where:
+///   - `major` = backward-breaking changes (must match exactly between PXE and Aztec.nr)
+///   - `minor` = oracle additions (non-breaking; PXE minor >= contract minor)
 ///
-/// @dev Whenever a contract function or Noir test is run, the `utilityAssertCompatibleOracleVersion` oracle is called
-/// and if the oracle version is incompatible an error is thrown.
-export const ORACLE_VERSION = 3;
-/// This hash is computed as by hashing the Oracle interface and it is used to detect when the Oracle interface changes,
-/// which in turn implies that you need to update the ORACLE_VERSION constant.
-export const ORACLE_INTERFACE_HASH = 'f9168ceb5a2227c148c5021ebffd4e2ca0da99885b87c5be3ee5ac0d8dd3d67c';
+/// The Noir counterparts are in `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
+///
+/// @dev Whenever a contract function or Noir test is run, the `aztec_misc_assertCompatibleOracleVersion` oracle is called.
+/// If the major version is incompatible, an error is thrown immediately. The minor version is recorded by the PXE and
+/// used to provide helpful error messages if a contract calls an oracle that doesn't exist. We don't throw immediately
+/// if AZTEC_NR_MINOR > PXE_MINOR because if a contract is updated to use a newer Aztec.nr dependency without actually
+/// using any of the new oracles then there is no reason to throw.
+export const ORACLE_VERSION_MAJOR = 29;
+export const ORACLE_VERSION_MINOR = 0;
+/// This hash is computed from the Oracle interface and is used to detect when that interface changes. When it does,
+/// you need to either:
+/// - increment `ORACLE_VERSION_MAJOR` and reset `ORACLE_VERSION_MINOR` to zero if the change is breaking, or
+/// - increment only `ORACLE_VERSION_MINOR` if the change is additive (a new oracle was added).
+///
+/// These constants must be kept in sync between this file and `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
+export const ORACLE_INTERFACE_HASH = '157fe8fa79f0e5a25db3d61341f9bcf5b43cb68367bea497204006daa48751b6';