@aztec-labs/pxe 6.0.0-nightly.20260829

package/dest/node/caching_aztec_node.js

@@ -0,0 +1,268 @@
+import { allToCompletion } from '@aztec-labs/foundation/promise';
+import { BlockHash } from '@aztec-labs/stdlib/block';
+import { withRecording } from './benchmarked_node.js';
+/**
+ * Wraps `node`, serving repeated reads from a cache the wrapper owns. Consumers share cached reads by sharing the
+ * wrapper.
+ *
+ * Only hash-pinned reads are cached. A block hash names immutable content, so the same call can never correctly answer
+ * differently, and even an `undefined` witness or leaf index is kept as a non-membership fact. That makes the wrapper
+ * safe for any consumer, whatever its anchor block. Uncached methods, and reads that name a block any other way (see
+ * {@link hashReferenceOf}), pass straight through. A few entries below opt out even when hash-pinned, where the answer
+ * can still change, and the tag queries opt in only once the request also stops short of blocks yet to be produced
+ * (see {@link hasImmutableAnswer}).
+ *
+ * Wiping (see {@link CachingAztecNode.wipeCache}) bounds memory. Correctness does not depend on it.
+ */ export function withCache(node) {
+    const cache = new AztecNodeCache();
+    // The recording wrapper sits below the cache, so a recording sees only the reads the node answered: a read served
+    // from the cache appears nowhere in it. Every read below goes to `source` rather than to `node`, and
+    // `startRecording` passes through this wrapper untouched.
+    const source = withRecording(node);
+    /** Runs `read` through `cache` when `block` pins a chain position by hash. Everything else goes to the node. */ const readCachedIfBlockIsHashPinned = (block, key, read, options)=>{
+        const blockHash = hashReferenceOf(block);
+        return blockHash === undefined ? read() : cache.fetch(key(blockHash.toString()), read, options);
+    };
+    const cachedReads = {
+        getBlock: (block, options)=>{
+            if (options?.includeL1PublishInfo || options?.includeAttestations) {
+                // These payloads keep changing after a block is fixed (its L1 publication status, its incoming committee
+                // attestations), so a repeat can correctly differ; read straight from the node.
+                return source.getBlock(block, options);
+            }
+            return readCachedIfBlockIsHashPinned(block, (blockHash)=>`block:${blockHash}:${keyPart(options)}`, ()=>source.getBlock(block, options), {
+                // PXE only asks for pinned blocks it has already observed, so an undefined answer means the node has not
+                // served the block yet, not that it never will.
+                shouldCache: (response)=>response !== undefined
+            });
+        },
+        getContract: (address, referenceBlock)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`contract:${blockHash}:${address.toString()}`, ()=>source.getContract(address, referenceBlock)),
+        getBlockHashMembershipWitness: (referenceBlock, blockHash)=>readCachedIfBlockIsHashPinned(referenceBlock, (referenceHash)=>`block-hash-membership-witness:${referenceHash}:${blockHash.toString()}`, ()=>source.getBlockHashMembershipWitness(referenceBlock, blockHash)),
+        getPublicDataWitness: (referenceBlock, leafSlot)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`public-data-witness:${blockHash}:${leafSlot.toString()}`, ()=>source.getPublicDataWitness(referenceBlock, leafSlot)),
+        getNoteHashMembershipWitness: (referenceBlock, noteHash)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`note-hash-membership-witness:${blockHash}:${noteHash.toString()}`, ()=>source.getNoteHashMembershipWitness(referenceBlock, noteHash)),
+        getNullifierMembershipWitness: (referenceBlock, nullifier)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`nullifier-membership-witness:${blockHash}:${nullifier.toString()}`, ()=>source.getNullifierMembershipWitness(referenceBlock, nullifier)),
+        getLowNullifierMembershipWitness: (referenceBlock, nullifier)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`low-nullifier-membership-witness:${blockHash}:${nullifier.toString()}`, ()=>source.getLowNullifierMembershipWitness(referenceBlock, nullifier)),
+        getL1ToL2MessageMembershipWitness: (referenceBlock, l1ToL2Message)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`l1-to-l2-message-membership-witness:${blockHash}:${l1ToL2Message.toString()}`, ()=>source.getL1ToL2MessageMembershipWitness(referenceBlock, l1ToL2Message)),
+        getPublicStorageAt: (referenceBlock, contractAddress, storageSlot)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`public-storage:${blockHash}:${contractAddress.toString()}:${storageSlot.toString()}`, ()=>source.getPublicStorageAt(referenceBlock, contractAddress, storageSlot)),
+        findLeavesIndexes: (referenceBlock, treeId, leafValues)=>{
+            // Cached per leaf: only leaves without a cached result are fetched, in a single batched node call. The per-leaf
+            // keys don't fit single-key readCachedIfBlockIsHashPinned, so the hash gate is inline.
+            const referenceHash = hashReferenceOf(referenceBlock);
+            if (referenceHash === undefined) {
+                return source.findLeavesIndexes(referenceBlock, treeId, leafValues);
+            }
+            return readBatchedPerKey(cache, leafValues.map((leaf)=>`leaf-index:${referenceHash.toString()}:${treeId}:${leaf.toString()}`), (missing)=>source.findLeavesIndexes(referenceBlock, treeId, missing.map((i)=>leafValues[i])), {
+                method: 'findLeavesIndexes',
+                requested: 'leaves'
+            });
+        },
+        getPrivateLogsByTags: (query)=>{
+            if (!hasImmutableAnswer(query)) {
+                return source.getPrivateLogsByTags(query);
+            }
+            const keyPrefix = `private-logs:${privateLogsQueryKey(query)}`;
+            return readBatchedPerKey(cache, query.tags.map((tag)=>`${keyPrefix}:${tagQueryKey(tag)}`), (missing)=>source.getPrivateLogsByTags({
+                    ...query,
+                    tags: missing.map((i)=>query.tags[i])
+                }), {
+                method: 'getPrivateLogsByTags',
+                requested: 'tags'
+            });
+        },
+        getPublicLogsByTags: (query)=>{
+            if (!hasImmutableAnswer(query)) {
+                return source.getPublicLogsByTags(query);
+            }
+            const keyPrefix = `public-logs:${publicLogsQueryKey(query)}`;
+            return readBatchedPerKey(cache, query.tags.map((tag)=>`${keyPrefix}:${tagQueryKey(tag)}`), (missing)=>source.getPublicLogsByTags({
+                    ...query,
+                    tags: missing.map((i)=>query.tags[i])
+                }), {
+                method: 'getPublicLogsByTags',
+                requested: 'tags'
+            });
+        }
+    };
+    return new Proxy(source, {
+        get (target, prop) {
+            if (prop === 'wipeCache') {
+                return ()=>cache.wipe();
+            }
+            if (Object.hasOwn(cachedReads, prop)) {
+                return cachedReads[prop];
+            }
+            const value = Reflect.get(target, prop);
+            return typeof value === 'function' ? value.bind(target) : value;
+        }
+    });
+}
+/**
+ * Store of node read promises keyed by method and arguments.
+ *
+ * Holds no node reference of its own: it only memoizes promises handed to it by the {@link withCache} wrapper that
+ * owns it. Rejected promises are evicted so callers can retry. A settled value is kept unless the caller's
+ * `shouldCache` turns it away.
+ */ class AztecNodeCache {
+    cache = new Map();
+    /**
+   * Returns the cached promise for `key`, or runs `read` and caches the in-flight promise.
+   *
+   * `shouldCache` runs once the promise settles and answers whether its value is kept. Every settled value is kept by
+   * default. Callers waiting on a value that is then turned away still share the one in-flight read, so declining to
+   * keep a value costs nothing on concurrent reads.
+   */ fetch(key, read, { shouldCache } = {}) {
+        return this.#get(key) ?? this.#set(key, read(), shouldCache);
+    }
+    /**
+   * The cached promise for each of `keys`, `undefined` where there is none. For callers that batch their own misses
+   * rather than reading one key.
+   */ peekAll(keys) {
+        return keys.map((key)=>this.#get(key));
+    }
+    /**
+   * Clears the store.
+   */ wipe() {
+        this.cache.clear();
+    }
+    #get(key) {
+        return this.cache.get(key);
+    }
+    #set(key, promise, shouldCache) {
+        const evict = ()=>{
+            if (this.cache.get(key) === promise) {
+                this.cache.delete(key);
+            }
+        };
+        // A rejected read is evicted so callers can retry; a `shouldCache` that throws is treated the same way. The
+        // trailing catch keeps a throwing predicate from surfacing as an unhandled rejection on this detached promise.
+        promise.then((value)=>{
+            if (shouldCache && !shouldCache(value)) {
+                evict();
+            }
+        }, evict).catch(evict);
+        this.cache.set(key, promise);
+        return promise;
+    }
+}
+/**
+ * The block hash `block` pins to (a `BlockHash` or `{ hash }` reference), or `undefined` for every other way of naming
+ * a block.
+ *
+ * A number or a tag names a moving chain position, as does naming no block at all: a reorg can put a different block
+ * at the same number, and tags follow the growing chain. An `{ archive }` root is different, since it commits to every
+ * block hash up to its own block and so pins content as tightly as a hash. It stays uncached because no PXE read uses
+ * one: keeping an `undefined` answer as a non-membership fact is only sound because PXE pins blocks it has already
+ * seen, and that holds for the references PXE actually builds.
+ */ function hashReferenceOf(block) {
+    if (block instanceof BlockHash) {
+        return block;
+    }
+    if (typeof block === 'object' && block !== null && 'hash' in block) {
+        return block.hash;
+    }
+    return undefined;
+}
+/**
+ * Answers one result per entry of `keys`, taking whatever the cache already holds and fetching the rest in a single
+ * batched call. Each fetched result is cached under its own key, so a later call that overlaps this one fetches only
+ * the entries it has not seen, and a key repeated within `keys` is asked of the node once.
+ *
+ * `fetchMissing` receives the indexes still missing, in order, and must answer one result per requested index.
+ * `shortResponse` names the method and what it requests, for the error raised when it does not.
+ */ function readBatchedPerKey(cache, keys, fetchMissing, shortResponse) {
+    const cached = cache.peekAll(keys);
+    // One request per missing key rather than per missing position, so a key repeated in `keys` seeds a single entry
+    // that every position carrying it then reads.
+    const requestIndexByKey = new Map();
+    cached.forEach((result, index)=>{
+        if (result === undefined && !requestIndexByKey.has(keys[index])) {
+            requestIndexByKey.set(keys[index], index);
+        }
+    });
+    const fetchedByKey = new Map();
+    if (requestIndexByKey.size > 0) {
+        const requestedIndexes = [
+            ...requestIndexByKey.values()
+        ];
+        const batch = fetchMissing(requestedIndexes).then((fetched)=>{
+            if (fetched.length !== requestedIndexes.length) {
+                // Each entry is filled from the batch response by position. If the node returned fewer results than we asked
+                // for, the positions past the end would read undefined, which the cache keeps as a genuine answer, so a
+                // truncated response would be cached as fact. Rejecting the whole batch evicts those entries instead, so a
+                // retry re-fetches every one of them.
+                throw new Error(`${shortResponse.method} returned ${fetched.length} results for ${requestedIndexes.length} requested ` + `${shortResponse.requested}`);
+            }
+            return fetched;
+        });
+        [
+            ...requestIndexByKey.keys()
+        ].forEach((key, batchIndex)=>{
+            fetchedByKey.set(key, cache.fetch(key, ()=>batch.then((fetched)=>fetched[batchIndex])));
+        });
+    }
+    // Every position is answered: a cache hit, or the entry its key's request seeded just above.
+    return allToCompletion(keys.map((key, index)=>cached[index] ?? fetchedByKey.get(key)));
+}
+/**
+ * Whether a tag query's answer can no longer change, and so can be cached.
+ *
+ * Two things would let it change, and the query has to rule out both. `referenceBlock` names the chain the answer
+ * belongs to, so the call fails once that block is gone rather than answering from a chain that reorged. `toBlock`
+ * stops the query below the tip, so blocks yet to be produced cannot add logs to the answer. Where the query starts
+ * does not matter: an open lower end reaches only blocks that are already behind it, which no longer move. PXE's tag
+ * queries get both from the `getAll*LogsByTags` helpers, which take them from the anchor block the query is pinned to.
+ */ function hasImmutableAnswer(query) {
+    return query.referenceBlock !== undefined && query.toBlock !== undefined;
+}
+/** Cache-key segment for the parts of a private tag query that every tag in it shares. */ function privateLogsQueryKey(query) {
+    const parts = {
+        ...sharedQueryKeyParts(query)
+    };
+    return Object.values(parts).map(keyPart).join(':');
+}
+/** Cache-key segment for the parts of a public tag query that every tag in it shares. */ function publicLogsQueryKey(query) {
+    const parts = {
+        ...sharedQueryKeyParts(query),
+        contractAddress: query.contractAddress
+    };
+    return Object.values(parts).map(keyPart).join(':');
+}
+/** The key parts {@link PrivateLogsQuery} and {@link PublicLogsQuery} have in common. */ function sharedQueryKeyParts(query) {
+    return {
+        referenceBlock: query.referenceBlock,
+        fromBlock: query.fromBlock,
+        toBlock: query.toBlock,
+        txHash: query.txHash,
+        includeEffects: query.includeEffects,
+        limitPerTag: query.limitPerTag
+    };
+}
+/**
+ * Cache-key segment for one tag entry, covering the pagination cursor as well as the tag: each page of a tag's stream
+ * is a read of its own, and a repeated query asks for the same pages in the same order.
+ */ function tagQueryKey(entry) {
+    return 'tag' in entry ? `${keyPart(entry.tag)}@${keyPart(entry.afterLog)}` : keyPart(entry);
+}
+/**
+ * Renders a call argument as a stable cache-key segment, via its own `toString` when it has one, else as JSON.
+ *
+ * Example: the options object `{ includeTransactions: true }` renders as `'{"includeTransactions":true}'`, and an
+ * absent optional argument as `'undefined'`.
+ */ function keyPart(value) {
+    if ([
+        'string',
+        'number',
+        'bigint',
+        'boolean'
+    ].includes(typeof value)) {
+        return String(value);
+    }
+    if (value && typeof value === 'object') {
+        const toString = value.toString;
+        if (toString && toString !== Object.prototype.toString) {
+            return toString.call(value);
+        }
+        return JSON.stringify(value, (_key, nested)=>typeof nested === 'bigint' ? nested.toString() : nested);
+    }
+    return String(value);
+}

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,77 @@
+import { Fr } from '@aztec-labs/foundation/curves/bn254';
+import type { AztecAddress } from '@aztec-labs/stdlib/aztec-address';
+import { type InBlock } from '@aztec-labs/stdlib/block';
+import { type AztecNode } from '@aztec-labs/stdlib/interfaces/client';
+import { Note, NoteStatus } from '@aztec-labs/stdlib/note';
+import type { BlockHeader } from '@aztec-labs/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';
+import type { ChangeSetId } from '../storage/staged_write_coordinator.js';
+export declare class NoteService {
+    #private;
+    private readonly noteStore;
+    private readonly aztecNode;
+    private readonly anchorBlockHeader;
+    private readonly changeSetId;
+    constructor(noteStore: NoteStore, aztecNode: AztecNode, anchorBlockHeader: BlockHeader, changeSetId: ChangeSetId);
+    /**
+     * 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. An empty list matches no notes.
+     */
+    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 the pre-fetched onchain context of their txs.
+     *
+     * 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 validationTxData - The onchain context of each request's tx, 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, validationTxData: ReadonlyMap<string, NoteValidationTxData>): Promise<void>;
+}
+/** The onchain context of the tx a note validation request points at: where it was mined and its note hashes. */
+export type NoteValidationTxData = InBlock & {
+    noteHashes: Fr[];
+    txIndexInBlock: number;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm90ZV9zZXJ2aWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbm90ZXMvbm90ZV9zZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxFQUFFLEVBQUUsTUFBTSxxQ0FBcUMsQ0FBQztBQUV6RCxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSxrQ0FBa0MsQ0FBQztBQUNyRSxPQUFPLEVBQStCLEtBQUssT0FBTyxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFFckYsT0FBTyxFQUFFLEtBQUssU0FBUyxFQUFlLE1BQU0sc0NBQXNDLENBQUM7QUFDbkYsT0FBTyxFQUFFLElBQUksRUFBVyxVQUFVLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUVwRSxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUV6RCxPQUFPLEtBQUssRUFBRSxxQkFBcUIsRUFBRSxNQUFNLHdFQUF3RSxDQUFDO0FBQ3BILE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHFDQUFxQyxDQUFDO0FBQ3JFLE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLHdDQUF3QyxDQUFDO0FBRTFFLHFCQUFhLFdBQVc7O0lBRXBCLE9BQU8sQ0FBQyxRQUFRLENBQUMsU0FBUztJQUMxQixPQUFPLENBQUMsUUFBUSxDQUFDLFNBQVM7SUFDMUIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxpQkFBaUI7SUFDbEMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxXQUFXO0lBSjlCLFlBQ21CLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLGlCQUFpQixFQUFFLFdBQVcsRUFDOUIsV0FBVyxFQUFFLFdBQVcsRUFDdkM7SUFFSjs7Ozs7Ozs7T0FRRztJQUNVLFFBQVEsQ0FDbkIsZUFBZSxFQUFFLFlBQVksRUFDN0IsS0FBSyxFQUFFLFlBQVksR0FBRyxTQUFTLEVBQy9CLFdBQVcsRUFBRSxFQUFFLEVBQ2YsTUFBTSxFQUFFLFVBQVUsRUFDbEIsTUFBTSxFQUFFLFlBQVksRUFBRTs7Ozs7Ozs7OztTQXlCdkI7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNVLGtCQUFrQixDQUFDLGVBQWUsRUFBRSxZQUFZLEVBQUUsTUFBTSxFQUFFLFlBQVksRUFBRSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FxQnBHO0lBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7T0FtQkc7SUFDVSxxQkFBcUIsQ0FDaEMsUUFBUSxFQUFFLHFCQUFxQixFQUFFLEVBQ2pDLEtBQUssRUFBRSxZQUFZLEVBQ25CLGdCQUFnQixFQUFFLFdBQVcsQ0FBQyxNQUFNLEVBQUUsb0JBQW9CLENBQUMsR0FDMUQsT0FBTyxDQUFDLElBQUksQ0FBQyxDQWtHZjtDQVVGO0FBRUQsaUhBQWlIO0FBQ2pILE1BQU0sTUFBTSxvQkFBb0IsR0FBRyxPQUFPLEdBQUc7SUFDM0MsVUFBVSxFQUFFLEVBQUUsRUFBRSxDQUFDO0lBQ2pCLGNBQWMsRUFBRSxNQUFNLENBQUM7Q0FDeEIsQ0FBQyJ9

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,qCAAqC,CAAC;AAEzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAA+B,KAAK,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAErF,OAAO,EAAE,KAAK,SAAS,EAAe,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,IAAI,EAAW,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAEpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wEAAwE,CAAC;AACpH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAE1E,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,WAAW;IAJ9B,YACmB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,iBAAiB,EAAE,WAAW,EAC9B,WAAW,EAAE,WAAW,EACvC;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,gBAAgB,EAAE,WAAW,CAAC,MAAM,EAAE,oBAAoB,CAAC,GAC1D,OAAO,CAAC,IAAI,CAAC,CAkGf;CAUF;AAED,iHAAiH;AACjH,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG;IAC3C,UAAU,EAAE,EAAE,EAAE,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC"}

package/dest/notes/note_service.js

@@ -0,0 +1,173 @@
+import { chunk } from '@aztec-labs/foundation/collection';
+import { allToCompletion } from '@aztec-labs/foundation/promise';
+import { computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec-labs/stdlib/hash';
+import { MAX_RPC_LEN } from '@aztec-labs/stdlib/interfaces/client';
+import { Note, NoteDao } from '@aztec-labs/stdlib/note';
+import { MerkleTreeId } from '@aztec-labs/stdlib/trees';
+export class NoteService {
+    noteStore;
+    aztecNode;
+    anchorBlockHeader;
+    changeSetId;
+    constructor(noteStore, aztecNode, anchorBlockHeader, changeSetId){
+        this.noteStore = noteStore;
+        this.aztecNode = aztecNode;
+        this.anchorBlockHeader = anchorBlockHeader;
+        this.changeSetId = changeSetId;
+    }
+    /**
+   * 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. An empty list matches no notes.
+   */ async getNotes(contractAddress, owner, storageSlot, status, scopes) {
+        const noteDaos = await this.noteStore.getNotes({
+            contractAddress,
+            owner,
+            storageSlot,
+            status,
+            scopes
+        }, this.changeSetId);
+        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.changeSetId);
+        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.changeSetId);
+    }
+    /**
+   * Validates and stores a batch of notes against the pre-fetched onchain context of their txs.
+   *
+   * 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 validationTxData - The onchain context of each request's tx, 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, validationTxData) {
+        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 allToCompletion(requests.map(async ({ contractAddress, noteHash, nullifier, noteNonce })=>{
+            const [siloedNoteHash, siloedNullifier] = await allToCompletion([
+                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 txData = validationTxData.get(txHash.toString());
+            if (!txData) {
+                // 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 (txData.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 = txData.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, txData.l2BlockNumber, txData.l2BlockHash.toString(), txData.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.changeSetId);
+        if (foundNullifiers.length > 0) {
+            await this.noteStore.applyNullifiers(foundNullifiers, this.changeSetId);
+        }
+    }
+    async #findNullifierIndexes(anchorBlockHash, siloedNullifiers) {
+        const batches = chunk(siloedNullifiers, MAX_RPC_LEN);
+        return (await allToCompletion(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-labs/foundation/curves/bn254';
+import type { AztecAddress } from '@aztec-labs/stdlib/aztec-address';
+import type { NoteStatus } from '@aztec-labs/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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm90ZXNfZmlsdGVyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvbm90ZXNfZmlsdGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLEVBQUUsRUFBRSxNQUFNLHFDQUFxQyxDQUFDO0FBQzlELE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLGtDQUFrQyxDQUFDO0FBQ3JFLE9BQU8sS0FBSyxFQUFFLFVBQVUsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBRTFEOzs7R0FHRztBQUNILE1BQU0sTUFBTSxXQUFXLEdBQUc7SUFDeEI7OztPQUdHO0lBQ0gsZUFBZSxFQUFFLFlBQVksQ0FBQztJQUM5Qiw2QkFBNkI7SUFDN0IsS0FBSyxDQUFDLEVBQUUsWUFBWSxDQUFDO0lBQ3JCLGlFQUFpRTtJQUNqRSxXQUFXLENBQUMsRUFBRSxFQUFFLENBQUM7SUFDakIsb0RBQW9EO0lBQ3BELE1BQU0sQ0FBQyxFQUFFLFVBQVUsQ0FBQztJQUNwQix5Q0FBeUM7SUFDekMsZUFBZSxDQUFDLEVBQUUsRUFBRSxDQUFDO0lBQ3JCLE1BQU0sRUFBRSxZQUFZLEVBQUUsQ0FBQztDQUN4QixDQUFDIn0=

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,qCAAqC,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;;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/operation_lifecycle.d.ts

@@ -0,0 +1,45 @@
+import type { Logger } from '@aztec-labs/foundation/log';
+import type { ChangeSetId, StagedWriteCoordinator } from './storage/staged_write_coordinator.js';
+/**
+ * Contributes work to every synced operation (e.g. writes into its change set). The operation waits for a
+ * contributor's work to settle before deciding its change set, and informs it of the outcome.
+ */
+export interface OperationContributor {
+    /**
+     * Waits for any work the contributor still has in flight. Awaited before the operation's change set is decided, so
+     * that no contributor is still writing when it is committed or discarded. A rejection causes the operation to
+     * discard instead of commit.
+     */
+    settle?(changeSetId: ChangeSetId): Promise<void>;
+    /**
+     * Called once the operation's change set has been committed or discarded. A throw is logged and swallowed: the outcome is
+     * already decided by this point, so it cannot change it.
+     */
+    onOperationEnd(changeSetId: ChangeSetId, outcome: 'committed' | 'discarded'): void;
+}
+/**
+ * Runs `fn` as the operation's work and decides its change set.
+ *
+ * On success:
+ * 1. Waits for every contributor to settle. A rejection vetoes the commit and the failure path below runs instead.
+ * 2. Commits the change set.
+ * 3. Notifies contributors of the outcome.
+ *
+ * On failure:
+ * 1. Drains contributors, logging failures instead of propagating them so the discard runs to completion and the
+ *    error that aborted the operation is not masked.
+ * 2. Aborts the change set.
+ * 3. Notifies contributors of the outcome.
+ * 4. Rethrows.
+ */
+export declare function runOperation<T>(args: RunOperationArgs, fn: () => Promise<T>): Promise<T>;
+/** What {@link runOperation} needs to decide an operation's change set. */
+type RunOperationArgs = {
+    stagedWriteCoordinator: StagedWriteCoordinator;
+    contributors: OperationContributor[];
+    /** The change set the operation's writes are staged under, from {@link StagedWriteCoordinator.begin}. */
+    changeSetId: ChangeSetId;
+    log: Logger;
+};
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3BlcmF0aW9uX2xpZmVjeWNsZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL29wZXJhdGlvbl9saWZlY3ljbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFHekQsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLHNCQUFzQixFQUFFLE1BQU0sdUNBQXVDLENBQUM7QUFFakc7OztHQUdHO0FBQ0gsTUFBTSxXQUFXLG9CQUFvQjtJQUNuQzs7OztPQUlHO0lBQ0gsTUFBTSxDQUFDLENBQUMsV0FBVyxFQUFFLFdBQVcsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFFakQ7OztPQUdHO0lBQ0gsY0FBYyxDQUFDLFdBQVcsRUFBRSxXQUFXLEVBQUUsT0FBTyxFQUFFLFdBQVcsR0FBRyxXQUFXLEdBQUcsSUFBSSxDQUFDO0NBQ3BGO0FBRUQ7Ozs7Ozs7Ozs7Ozs7O0dBY0c7QUFDSCx3QkFBc0IsWUFBWSxDQUFDLENBQUMsRUFBRSxJQUFJLEVBQUUsZ0JBQWdCLEVBQUUsRUFBRSxFQUFFLE1BQU0sT0FBTyxDQUFDLENBQUMsQ0FBQyxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0F5QjlGO0FBMkJELDJFQUEyRTtBQUMzRSxLQUFLLGdCQUFnQixHQUFHO0lBQ3RCLHNCQUFzQixFQUFFLHNCQUFzQixDQUFDO0lBQy9DLFlBQVksRUFBRSxvQkFBb0IsRUFBRSxDQUFDO0lBQ3JDLHlHQUF5RztJQUN6RyxXQUFXLEVBQUUsV0FBVyxDQUFDO0lBQ3pCLEdBQUcsRUFBRSxNQUFNLENBQUM7Q0FDYixDQUFDIn0=

package/dest/operation_lifecycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation_lifecycle.d.ts","sourceRoot":"","sources":["../src/operation_lifecycle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGzD,OAAO,KAAK,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAEjG;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,MAAM,CAAC,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,GAAG,WAAW,GAAG,IAAI,CAAC;CACpF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAyB9F;AA2BD,2EAA2E;AAC3E,KAAK,gBAAgB,GAAG;IACtB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,YAAY,EAAE,oBAAoB,EAAE,CAAC;IACrC,yGAAyG;IACzG,WAAW,EAAE,WAAW,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}