@aztec/pxe 0.0.1-commit.d3ec352c → 0.0.1-commit.d431d1c

package/dest/storage/private_event_store/private_event_store.js

@@ -0,0 +1,222 @@
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { createLogger } from '@aztec/foundation/log';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { L2BlockHash } from '@aztec/stdlib/block';
+import { TxHash } from '@aztec/stdlib/tx';
+/**
+ * Stores decrypted private event logs.
+ */ export class PrivateEventStore {
+    storeName = 'private_event';
+    #store;
+    /** Map storing the actual private event log entries, keyed by siloedEventCommitment */ #eventLogs;
+    /** Multi-map from contractAddress_scope_eventSelector to siloedEventCommitment for efficient lookup */ #eventsByContractScopeSelector;
+    /** Multi-map from block number to siloedEventCommitment for rollback support */ #eventsByBlockNumber;
+    /** Map from siloedEventCommitment to boolean indicating if log has been seen. */ #seenLogs;
+    /** jobId => eventId (event siloed nullifier)  => PrivateEventEntry */ #eventLogsInJobStage;
+    logger = createLogger('private_event_store');
+    constructor(store){
+        this.#store = store;
+        this.#eventLogs = this.#store.openMap('private_event_logs');
+        this.#eventsByContractScopeSelector = this.#store.openMultiMap('events_by_contract_scope_selector');
+        this.#seenLogs = this.#store.openMap('seen_logs');
+        this.#eventsByBlockNumber = this.#store.openMultiMap('events_by_block_number');
+        this.#eventLogsInJobStage = new Map();
+    }
+    #keyFor(contractAddress, scope, eventSelector) {
+        return `${contractAddress.toString()}_${scope.toString()}_${eventSelector.toString()}`;
+    }
+    async commit(jobId) {
+        await Promise.all([
+            ...this.#getEventLogsInJobStage(jobId).entries()
+        ].map(async ([eventId, eventEntry])=>{
+            this.logger.verbose('storing private event log (KV store)', eventEntry);
+            await Promise.all([
+                this.#eventLogs.set(eventId, eventEntry),
+                this.#eventsByContractScopeSelector.set(eventEntry.lookupKey, eventId),
+                this.#eventsByBlockNumber.set(eventEntry.l2BlockNumber, eventId),
+                this.#seenLogs.set(eventId, true)
+            ]);
+        }));
+        return this.discardStaged(jobId);
+    }
+    discardStaged(jobId) {
+        this.#eventLogsInJobStage.delete(jobId);
+        return Promise.resolve();
+    }
+    #getEventLogsInJobStage(jobId) {
+        let jobStage = this.#eventLogsInJobStage.get(jobId);
+        if (jobStage === undefined) {
+            jobStage = new Map();
+            this.#eventLogsInJobStage.set(jobId, jobStage);
+        }
+        return jobStage;
+    }
+    async #isSeenLog(jobId, eventId) {
+        const eventLogsInJobStage = this.#getEventLogsInJobStage(jobId).get(eventId);
+        return !!eventLogsInJobStage || !!await this.#seenLogs.getAsync(eventId);
+    }
+    #addEventLogToStage(jobId, eventId, eventEntry) {
+        this.#getEventLogsInJobStage(jobId).set(eventId, eventEntry);
+    }
+    async #getEventSiloedNullifiers(contractAddress, scope, eventSelector, jobId) {
+        const key = this.#keyFor(contractAddress, scope, eventSelector);
+        const eventSiloedNullifiersInStorage = [];
+        for await (const eventId of this.#eventsByContractScopeSelector.getValuesAsync(key)){
+            eventSiloedNullifiersInStorage.push(eventId);
+        }
+        if (!jobId) {
+            return eventSiloedNullifiersInStorage;
+        }
+        const eventSiloedNullifiersInJobStage = new Set([
+            ...this.#getEventLogsInJobStage(jobId).entries()
+        ].filter(([_, entry])=>entry.lookupKey === key).map(([idx, _])=>idx));
+        return [
+            ...new Set(eventSiloedNullifiersInStorage).union(eventSiloedNullifiersInJobStage)
+        ];
+    }
+    async #getEventLogBySiloedNullifier(eventId, jobId) {
+        if (jobId) {
+            return this.#getEventLogsInJobStage(jobId).get(eventId) ?? await this.#eventLogs.getAsync(eventId);
+        } else {
+            return await this.#eventLogs.getAsync(eventId);
+        }
+    }
+    /**
+   * Store a private event log.
+   * @param eventSelector - The event selector of the event.
+   * @param randomness - The randomness used for the event commitment.
+   * @param msgContent - The content of the event.
+   * @param siloedEventCommitment - The siloed event commitment (used as unique identifier).
+   * @param metadata
+   *  contractAddress - The address of the contract that emitted the event.
+   *  scope - The address to which the event is scoped.
+   *  txHash - The transaction hash of the event log.
+   *  blockNumber - The block number in which the event was emitted.
+   */ storePrivateEventLog(eventSelector, randomness, msgContent, siloedEventCommitment, metadata, jobId) {
+        const { contractAddress, scope, txHash, l2BlockNumber, l2BlockHash, txIndexInBlock, eventIndexInTx } = metadata;
+        return this.#store.transactionAsync(async ()=>{
+            const key = this.#keyFor(contractAddress, scope, eventSelector);
+            // The siloed event commitment is guaranteed to be unique as it's inserted into the nullifier tree. For this
+            // reason we use it as id.
+            const eventId = siloedEventCommitment.toString();
+            const hasBeenSeen = await this.#isSeenLog(jobId, eventId);
+            if (hasBeenSeen) {
+                this.logger.verbose('Ignoring duplicate event log', {
+                    txHash: txHash.toString(),
+                    siloedEventCommitment
+                });
+                return;
+            }
+            this.logger.verbose('storing private event log (job stage)', {
+                contractAddress,
+                scope,
+                msgContent,
+                l2BlockNumber
+            });
+            this.#addEventLogToStage(jobId, eventId, {
+                randomness,
+                msgContent: serializeToBuffer(msgContent),
+                l2BlockNumber,
+                l2BlockHash: l2BlockHash.toBuffer(),
+                txHash: txHash.toBuffer(),
+                txIndexInBlock,
+                eventIndexInTx,
+                lookupKey: key
+            });
+        });
+    }
+    /**
+   * Returns the private events given search parameters.
+   * @param eventSelector - The event selector to filter by.
+   * @param filter - Filtering criteria:
+   *  contractAddress: The address of the contract to get events from.
+   *  fromBlock: The block number to search from (inclusive).
+   *  toBlock: The block number to search upto (exclusive).
+   *  scope: - The addresses that decrypted the logs.
+   * @returns - The event log contents, augmented with metadata about the transaction and block in which the event was
+   * included.
+   */ async getPrivateEvents(eventSelector, filter) {
+        const events = [];
+        for (const scope of filter.scopes){
+            const eventIds = await this.#getEventSiloedNullifiers(filter.contractAddress, scope, eventSelector);
+            for (const eventId of eventIds){
+                const entry = await this.#getEventLogBySiloedNullifier(eventId);
+                if (!entry || entry.l2BlockNumber < filter.fromBlock || entry.l2BlockNumber >= filter.toBlock) {
+                    continue;
+                }
+                // Convert buffer back to Fr array
+                const reader = BufferReader.asReader(entry.msgContent);
+                const numFields = entry.msgContent.length / Fr.SIZE_IN_BYTES;
+                const msgContent = reader.readArray(numFields, Fr);
+                const txHash = TxHash.fromBuffer(entry.txHash);
+                const l2BlockHash = L2BlockHash.fromBuffer(entry.l2BlockHash);
+                if (filter.txHash && !txHash.equals(filter.txHash)) {
+                    continue;
+                }
+                events.push({
+                    l2BlockNumber: entry.l2BlockNumber,
+                    txIndexInBlock: entry.txIndexInBlock,
+                    eventIndexInTx: entry.eventIndexInTx,
+                    event: {
+                        packedEvent: msgContent,
+                        l2BlockNumber: BlockNumber(entry.l2BlockNumber),
+                        txHash,
+                        l2BlockHash,
+                        eventSelector
+                    }
+                });
+            }
+        }
+        // Sort by block number, then by tx index within block, then by event index within tx
+        events.sort((a, b)=>{
+            if (a.l2BlockNumber !== b.l2BlockNumber) {
+                return a.l2BlockNumber - b.l2BlockNumber;
+            }
+            if (a.txIndexInBlock !== b.txIndexInBlock) {
+                return a.txIndexInBlock - b.txIndexInBlock;
+            }
+            return a.eventIndexInTx - b.eventIndexInTx;
+        });
+        return events.map((ev)=>ev.event);
+    }
+    /**
+   * Rolls back private events that were stored after a given `blockNumber` and up to `synchedBlockNumber` (the block
+   * number up to which PXE managed to sync before the reorg happened).
+   *
+   * We don't need staged writes for a rollback since it's handled in the context of a blockchain rewind.
+   *
+   * Rollbacks are handled by the BlockSynchronizer, which runs a DB transaction across stores when it detects a
+   * re-org, including setting the new anchor block after rolling back.
+   *
+   * So if anything fails in the process of rolling back any store, all DB changes occurring during rollbacks will be
+   * lost and the anchor block will not be updated; which means this code will eventually need to run again
+   * (i.e.: PXE will detect it's basing it work on an invalid block hash, then which re-triggers rewind).
+   *
+   * For further details, refer to `BlockSynchronizer#handleBlockStreamEvent`.
+   *
+   * IMPORTANT: This method must be called within a transaction to ensure atomicity.
+   */ async rollback(blockNumber, synchedBlockNumber) {
+        let removedCount = 0;
+        for(let block = blockNumber + 1; block <= synchedBlockNumber; block++){
+            const eventIds = [];
+            for await (const eventId of this.#eventsByBlockNumber.getValuesAsync(block)){
+                eventIds.push(eventId);
+            }
+            if (eventIds.length > 0) {
+                await this.#eventsByBlockNumber.delete(block);
+                for (const eventId of eventIds){
+                    const entry = await this.#eventLogs.getAsync(eventId);
+                    if (!entry) {
+                        throw new Error(`Event log not found for eventId ${eventId}`);
+                    }
+                    await this.#eventLogs.delete(eventId);
+                    await this.#seenLogs.delete(eventId);
+                    await this.#eventsByContractScopeSelector.deleteValue(entry.lookupKey, eventId);
+                    removedCount++;
+                }
+            }
+        }
+        this.logger.verbose(`Rolled back ${removedCount} private events after block ${blockNumber}`);
+    }
+}

package/dest/storage/tagging_store/index.d.ts

@@ -0,0 +1,4 @@
+export { SenderTaggingStore } from './sender_tagging_store.js';
+export { SenderAddressBookStore } from './sender_address_book_store.js';
+export { RecipientTaggingStore } from './recipient_tagging_store.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdG9yYWdlL3RhZ2dpbmdfc3RvcmUvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sMkJBQTJCLENBQUM7QUFDL0QsT0FBTyxFQUFFLHNCQUFzQixFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDeEUsT0FBTyxFQUFFLHFCQUFxQixFQUFFLE1BQU0sOEJBQThCLENBQUMifQ==

package/dest/storage/tagging_store/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/storage/tagging_store/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC"}

package/dest/storage/tagging_store/index.js

@@ -0,0 +1,3 @@
+export { SenderTaggingStore } from './sender_tagging_store.js';
+export { SenderAddressBookStore } from './sender_address_book_store.js';
+export { RecipientTaggingStore } from './recipient_tagging_store.js';

package/dest/storage/tagging_store/recipient_tagging_store.d.ts

@@ -0,0 +1,28 @@
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { DirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
+import type { StagedStore } from '../../job_coordinator/job_coordinator.js';
+/**
+ * Data provider of tagging data used when syncing the logs as a recipient. The sender counterpart of this class
+ * is called SenderTaggingStore. We have the providers separate for the sender and recipient because
+ * the algorithms are completely disjoint and there is not data reuse between the two.
+ *
+ * @dev Chain reorgs do not need to be handled here because both the finalized and aged indexes refer to finalized
+ * blocks, which by definition cannot be affected by reorgs.
+ */
+export declare class RecipientTaggingStore implements StagedStore {
+    #private;
+    storeName: string;
+    constructor(store: AztecAsyncKVStore);
+    /**
+     * Writes all job-specific in-memory data to persistent storage.
+     *
+     * @remark This method must run in a DB transaction context. It's designed to be called from JobCoordinator#commitJob.
+     */
+    commit(jobId: string): Promise<void>;
+    discardStaged(jobId: string): Promise<void>;
+    getHighestAgedIndex(secret: DirectionalAppTaggingSecret, jobId: string): Promise<number | undefined>;
+    updateHighestAgedIndex(secret: DirectionalAppTaggingSecret, index: number, jobId: string): Promise<void>;
+    getHighestFinalizedIndex(secret: DirectionalAppTaggingSecret, jobId: string): Promise<number | undefined>;
+    updateHighestFinalizedIndex(secret: DirectionalAppTaggingSecret, index: number, jobId: string): Promise<void>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVjaXBpZW50X3RhZ2dpbmdfc3RvcmUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdG9yYWdlL3RhZ2dpbmdfc3RvcmUvcmVjaXBpZW50X3RhZ2dpbmdfc3RvcmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQWlCLE1BQU0saUJBQWlCLENBQUM7QUFDeEUsT0FBTyxLQUFLLEVBQUUsMkJBQTJCLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUV0RSxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSwwQ0FBMEMsQ0FBQztBQUU1RTs7Ozs7OztHQU9HO0FBQ0gscUJBQWEscUJBQXNCLFlBQVcsV0FBVzs7SUFDdkQsU0FBUyxFQUFFLE1BQU0sQ0FBdUI7SUFheEMsWUFBWSxLQUFLLEVBQUUsaUJBQWlCLEVBUW5DO0lBc0NEOzs7O09BSUc7SUFDRyxNQUFNLENBQUMsS0FBSyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBZ0J6QztJQUVELGFBQWEsQ0FBQyxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FJMUM7SUFFRCxtQkFBbUIsQ0FBQyxNQUFNLEVBQUUsMkJBQTJCLEVBQUUsS0FBSyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxDQUVuRztJQUVLLHNCQUFzQixDQUFDLE1BQU0sRUFBRSwyQkFBMkIsRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQU83RztJQUVELHdCQUF3QixDQUFDLE1BQU0sRUFBRSwyQkFBMkIsRUFBRSxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBRXhHO0lBRUssMkJBQTJCLENBQUMsTUFBTSxFQUFFLDJCQUEyQixFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBUWxIO0NBQ0YifQ==

package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipient_tagging_store.d.ts","sourceRoot":"","sources":["../../../src/storage/tagging_store/recipient_tagging_store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAiB,MAAM,iBAAiB,CAAC;AACxE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAEtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAC;AAE5E;;;;;;;GAOG;AACH,qBAAa,qBAAsB,YAAW,WAAW;;IACvD,SAAS,EAAE,MAAM,CAAuB;IAaxC,YAAY,KAAK,EAAE,iBAAiB,EAQnC;IAsCD;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBzC;IAED,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI1C;IAED,mBAAmB,CAAC,MAAM,EAAE,2BAA2B,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAEnG;IAEK,sBAAsB,CAAC,MAAM,EAAE,2BAA2B,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO7G;IAED,wBAAwB,CAAC,MAAM,EAAE,2BAA2B,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAExG;IAEK,2BAA2B,CAAC,MAAM,EAAE,2BAA2B,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAQlH;CACF"}

package/dest/storage/tagging_store/recipient_tagging_store.js

@@ -0,0 +1,99 @@
+/**
+ * Data provider of tagging data used when syncing the logs as a recipient. The sender counterpart of this class
+ * is called SenderTaggingStore. We have the providers separate for the sender and recipient because
+ * the algorithms are completely disjoint and there is not data reuse between the two.
+ *
+ * @dev Chain reorgs do not need to be handled here because both the finalized and aged indexes refer to finalized
+ * blocks, which by definition cannot be affected by reorgs.
+ */ export class RecipientTaggingStore {
+    storeName = 'recipient_tagging';
+    #store;
+    #highestAgedIndex;
+    #highestFinalizedIndex;
+    // jobId => secret => number
+    #highestAgedIndexForJob;
+    // jobId => secret => number
+    #highestFinalizedIndexForJob;
+    constructor(store){
+        this.#store = store;
+        this.#highestAgedIndex = this.#store.openMap('highest_aged_index');
+        this.#highestFinalizedIndex = this.#store.openMap('highest_finalized_index');
+        this.#highestAgedIndexForJob = new Map();
+        this.#highestFinalizedIndexForJob = new Map();
+    }
+    #getHighestAgedIndexForJob(jobId) {
+        let highestAgedIndexForJob = this.#highestAgedIndexForJob.get(jobId);
+        if (!highestAgedIndexForJob) {
+            highestAgedIndexForJob = new Map();
+            this.#highestAgedIndexForJob.set(jobId, highestAgedIndexForJob);
+        }
+        return highestAgedIndexForJob;
+    }
+    async #readHighestAgedIndex(jobId, secret) {
+        return this.#getHighestAgedIndexForJob(jobId).get(secret) ?? await this.#highestAgedIndex.getAsync(secret);
+    }
+    #writeHighestAgedIndex(jobId, secret, index) {
+        this.#getHighestAgedIndexForJob(jobId).set(secret, index);
+    }
+    #getHighestFinalizedIndexForJob(jobId) {
+        let jobStagedHighestFinalizedIndex = this.#highestFinalizedIndexForJob.get(jobId);
+        if (!jobStagedHighestFinalizedIndex) {
+            jobStagedHighestFinalizedIndex = new Map();
+            this.#highestFinalizedIndexForJob.set(jobId, jobStagedHighestFinalizedIndex);
+        }
+        return jobStagedHighestFinalizedIndex;
+    }
+    async #readHighestFinalizedIndex(jobId, secret) {
+        return this.#getHighestFinalizedIndexForJob(jobId).get(secret) ?? await this.#highestFinalizedIndex.getAsync(secret);
+    }
+    #writeHighestFinalizedIndex(jobId, secret, index) {
+        this.#getHighestFinalizedIndexForJob(jobId).set(secret, index);
+    }
+    /**
+   * Writes all job-specific in-memory data to persistent storage.
+   *
+   * @remark This method must run in a DB transaction context. It's designed to be called from JobCoordinator#commitJob.
+   */ async commit(jobId) {
+        const highestAgedIndexForJob = this.#highestAgedIndexForJob.get(jobId);
+        if (highestAgedIndexForJob) {
+            for (const [secret, index] of highestAgedIndexForJob.entries()){
+                await this.#highestAgedIndex.set(secret, index);
+            }
+        }
+        const highestFinalizedIndexForJob = this.#highestFinalizedIndexForJob.get(jobId);
+        if (highestFinalizedIndexForJob) {
+            for (const [secret, index] of highestFinalizedIndexForJob.entries()){
+                await this.#highestFinalizedIndex.set(secret, index);
+            }
+        }
+        return this.discardStaged(jobId);
+    }
+    discardStaged(jobId) {
+        this.#highestAgedIndexForJob.delete(jobId);
+        this.#highestFinalizedIndexForJob.delete(jobId);
+        return Promise.resolve();
+    }
+    getHighestAgedIndex(secret, jobId) {
+        return this.#readHighestAgedIndex(jobId, secret.toString());
+    }
+    async updateHighestAgedIndex(secret, index, jobId) {
+        const currentIndex = await this.#readHighestAgedIndex(jobId, secret.toString());
+        if (currentIndex !== undefined && index <= currentIndex) {
+            // Log sync should never set a lower highest aged index.
+            throw new Error(`New highest aged index (${index}) must be higher than the current one (${currentIndex})`);
+        }
+        this.#writeHighestAgedIndex(jobId, secret.toString(), index);
+    }
+    getHighestFinalizedIndex(secret, jobId) {
+        return this.#readHighestFinalizedIndex(jobId, secret.toString());
+    }
+    async updateHighestFinalizedIndex(secret, index, jobId) {
+        const currentIndex = await this.#readHighestFinalizedIndex(jobId, secret.toString());
+        if (currentIndex !== undefined && index < currentIndex) {
+            // Log sync should never set a lower highest finalized index but it can happen that it would try to set the same
+            // one because we are loading logs from highest aged index + 1 and not from the highest finalized index.
+            throw new Error(`New highest finalized index (${index}) must be higher than the current one (${currentIndex})`);
+        }
+        this.#writeHighestFinalizedIndex(jobId, secret.toString(), index);
+    }
+}

package/dest/storage/tagging_store/sender_address_book_store.d.ts

@@ -0,0 +1,14 @@
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+/**
+ * Stores sender addresses. During recipient log synchronization, these senders are used, along with a given recipient,
+ * to derive directional app tagging secrets that are then used to sync the logs.
+ */
+export declare class SenderAddressBookStore {
+    #private;
+    constructor(store: AztecAsyncKVStore);
+    addSender(address: AztecAddress): Promise<boolean>;
+    getSenders(): Promise<AztecAddress[]>;
+    removeSender(address: AztecAddress): Promise<boolean>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VuZGVyX2FkZHJlc3NfYm9va19zdG9yZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3N0b3JhZ2UvdGFnZ2luZ19zdG9yZS9zZW5kZXJfYWRkcmVzc19ib29rX3N0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFpQixNQUFNLGlCQUFpQixDQUFDO0FBQ3hFLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUUzRDs7O0dBR0c7QUFDSCxxQkFBYSxzQkFBc0I7O0lBSWpDLFlBQVksS0FBSyxFQUFFLGlCQUFpQixFQUluQztJQUVLLFNBQVMsQ0FBQyxPQUFPLEVBQUUsWUFBWSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FRdkQ7SUFFSyxVQUFVLElBQUksT0FBTyxDQUFDLFlBQVksRUFBRSxDQUFDLENBRTFDO0lBRUssWUFBWSxDQUFDLE9BQU8sRUFBRSxZQUFZLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQVExRDtDQUNGIn0=

package/dest/storage/tagging_store/sender_address_book_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sender_address_book_store.d.ts","sourceRoot":"","sources":["../../../src/storage/tagging_store/sender_address_book_store.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAiB,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE3D;;;GAGG;AACH,qBAAa,sBAAsB;;IAIjC,YAAY,KAAK,EAAE,iBAAiB,EAInC;IAEK,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAQvD;IAEK,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAE1C;IAEK,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAQ1D;CACF"}

package/dest/storage/tagging_store/sender_address_book_store.js

@@ -0,0 +1,30 @@
+import { toArray } from '@aztec/foundation/iterable';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+/**
+ * Stores sender addresses. During recipient log synchronization, these senders are used, along with a given recipient,
+ * to derive directional app tagging secrets that are then used to sync the logs.
+ */ export class SenderAddressBookStore {
+    #store;
+    #addressBook;
+    constructor(store){
+        this.#store = store;
+        this.#addressBook = this.#store.openMap('address_book');
+    }
+    async addSender(address) {
+        if (await this.#addressBook.hasAsync(address.toString())) {
+            return false;
+        }
+        await this.#addressBook.set(address.toString(), true);
+        return true;
+    }
+    async getSenders() {
+        return (await toArray(this.#addressBook.keysAsync())).map(AztecAddress.fromString);
+    }
+    async removeSender(address) {
+        if (!await this.#addressBook.hasAsync(address.toString())) {
+            return false;
+        }
+        await this.#addressBook.delete(address.toString());
+        return true;
+    }
+}

package/dest/storage/tagging_store/sender_tagging_store.d.ts

@@ -0,0 +1,77 @@
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { DirectionalAppTaggingSecret, PreTag } from '@aztec/stdlib/logs';
+import { TxHash } from '@aztec/stdlib/tx';
+import type { StagedStore } from '../../job_coordinator/job_coordinator.js';
+/**
+ * Data provider of tagging data used when syncing the sender tagging indexes. The recipient counterpart of this class
+ * is called RecipientTaggingStore. We have the data stores separate for sender and recipient because
+ * the algorithms are completely disjoint and there is not data reuse between the two.
+ */
+export declare class SenderTaggingStore implements StagedStore {
+    #private;
+    readonly storeName = "sender_tagging";
+    constructor(store: AztecAsyncKVStore);
+    /**
+     * Writes all job-specific in-memory data to persistent storage.
+     *
+     * @remark This method must run in a DB transaction context. It's designed to be called from JobCoordinator#commitJob.
+     */
+    commit(jobId: string): Promise<void>;
+    discardStaged(jobId: string): Promise<void>;
+    /**
+     * Stores pending indexes.
+     * @remarks Ignores the index if the same preTag + txHash combination already exists in the db with the same index.
+     * This is expected to happen because whenever we start sync we start from the last finalized index and we can have
+     * pending indexes already stored from previous syncs.
+     * @param preTags - The pre-tags containing the directional app tagging secrets and the indexes that are to be
+     * stored in the db.
+     * @param txHash - The tx in which the pretags were used in private logs.
+     * @param jobId - job context for staged writes to this store. See `JobCoordinator` for more details.
+     * @throws If any two pre-tags contain the same directional app tagging secret. This is enforced because we care
+     * only about the highest index for a given secret that was used in the tx. Hence this check is a good way to catch
+     * bugs.
+     * @throws If the newly stored pending index is further than window length from the highest finalized index for the
+     * same secret. This is enforced in order to give a guarantee to a recipient that he doesn't need to look further than
+     * window length ahead of the highest finalized index.
+     * @throws If a secret + txHash pair already exists in the db with a different index value. It should never happen
+     * that we would attempt to store a different index for a given secret-txHash pair because we always store just the
+     * highest index for a given secret-txHash pair. Hence this is a good way to catch bugs.
+     * @throws If the newly stored pending index is lower than or equal to the last finalized index for the same secret.
+     * This is enforced because this should never happen if the syncing is done correctly as we look for logs from higher
+     * indexes than finalized ones.
+     */
+    storePendingIndexes(preTags: PreTag[], txHash: TxHash, jobId: string): Promise<void>;
+    /**
+     * Returns the transaction hashes of all pending transactions that contain indexes within a specified range
+     * for a given directional app tagging secret.
+     * @param secret - The directional app tagging secret to query pending indexes for.
+     * @param startIndex - The lower bound of the index range (inclusive).
+     * @param endIndex - The upper bound of the index range (exclusive).
+     * @returns An array of unique transaction hashes for pending transactions that contain indexes in the range
+     * [startIndex, endIndex). Returns an empty array if no pending indexes exist in the range.
+     */
+    getTxHashesOfPendingIndexes(secret: DirectionalAppTaggingSecret, startIndex: number, endIndex: number, jobId: string): Promise<TxHash[]>;
+    /**
+     * Returns the last (highest) finalized index for a given secret.
+     * @param secret - The secret to get the last finalized index for.
+     * @returns The last (highest) finalized index for the given secret.
+     */
+    getLastFinalizedIndex(secret: DirectionalAppTaggingSecret, jobId: string): Promise<number | undefined>;
+    /**
+     * Returns the last used index for a given directional app tagging secret, considering both finalized and pending
+     * indexes.
+     * @param secret - The directional app tagging secret to query the last used index for.
+     * @returns The last used index.
+     */
+    getLastUsedIndex(secret: DirectionalAppTaggingSecret, jobId: string): Promise<number | undefined>;
+    /**
+     * Drops all pending indexes corresponding to the given transaction hashes.
+     */
+    dropPendingIndexes(txHashes: TxHash[], jobId: string): Promise<void>;
+    /**
+     * Updates pending indexes corresponding to the given transaction hashes to be finalized and prunes any lower pending
+     * indexes.
+     */
+    finalizePendingIndexes(txHashes: TxHash[], jobId: string): Promise<void>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VuZGVyX3RhZ2dpbmdfc3RvcmUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdG9yYWdlL3RhZ2dpbmdfc3RvcmUvc2VuZGVyX3RhZ2dpbmdfc3RvcmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQWlCLE1BQU0saUJBQWlCLENBQUM7QUFDeEUsT0FBTyxLQUFLLEVBQUUsMkJBQTJCLEVBQUUsTUFBTSxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFDOUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBRTFDLE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLDBDQUEwQyxDQUFDO0FBRzVFOzs7O0dBSUc7QUFDSCxxQkFBYSxrQkFBbUIsWUFBVyxXQUFXOztJQUNwRCxRQUFRLENBQUMsU0FBUyxvQkFBb0I7SUE2QnRDLFlBQVksS0FBSyxFQUFFLGlCQUFpQixFQVFuQztJQW9ERDs7OztPQUlHO0lBQ0csTUFBTSxDQUFDLEtBQUssRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQW9CekM7SUFFRCxhQUFhLENBQUMsS0FBSyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBSTFDO0lBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQXFCRztJQUNHLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxNQUFNLEVBQUUsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxNQUFNLGlCQWlEekU7SUFFRDs7Ozs7Ozs7T0FRRztJQUNHLDJCQUEyQixDQUMvQixNQUFNLEVBQUUsMkJBQTJCLEVBQ25DLFVBQVUsRUFBRSxNQUFNLEVBQ2xCLFFBQVEsRUFBRSxNQUFNLEVBQ2hCLEtBQUssRUFBRSxNQUFNLEdBQ1osT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBTW5CO0lBRUQ7Ozs7T0FJRztJQUNILHFCQUFxQixDQUFDLE1BQU0sRUFBRSwyQkFBMkIsRUFBRSxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBRXJHO0lBRUQ7Ozs7O09BS0c7SUFDRyxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsMkJBQTJCLEVBQUUsS0FBSyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxDQVl0RztJQUVEOztPQUVHO0lBQ0csa0JBQWtCLENBQUMsUUFBUSxFQUFFLE1BQU0sRUFBRSxFQUFFLEtBQUssRUFBRSxNQUFNLGlCQXFCekQ7SUFFRDs7O09BR0c7SUFDRyxzQkFBc0IsQ0FBQyxRQUFRLEVBQUUsTUFBTSxFQUFFLEVBQUUsS0FBSyxFQUFFLE1BQU0saUJBcUQ3RDtDQUNGIn0=

package/dest/storage/tagging_store/sender_tagging_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sender_tagging_store.d.ts","sourceRoot":"","sources":["../../../src/storage/tagging_store/sender_tagging_store.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAiB,MAAM,iBAAiB,CAAC;AACxE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAC;AAG5E;;;;GAIG;AACH,qBAAa,kBAAmB,YAAW,WAAW;;IACpD,QAAQ,CAAC,SAAS,oBAAoB;IA6BtC,YAAY,KAAK,EAAE,iBAAiB,EAQnC;IAoDD;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBzC;IAED,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI1C;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,iBAiDzE;IAED;;;;;;;;OAQG;IACG,2BAA2B,CAC/B,MAAM,EAAE,2BAA2B,EACnC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,EAAE,CAAC,CAMnB;IAED;;;;OAIG;IACH,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAErG;IAED;;;;;OAKG;IACG,gBAAgB,CAAC,MAAM,EAAE,2BAA2B,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAYtG;IAED;;OAEG;IACG,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,iBAqBzD;IAED;;;OAGG;IACG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,iBAqD7D;CACF"}