@aztec/kv-store 0.0.0-test.1 → 0.0.1-commit.001888fc

package/dest/lmdb-v2/write_transaction.js

@@ -1,6 +1,7 @@
+import { dedupeSortedArray, findInSortedArray, findIndexInSortedArray, insertIntoSortedArray, merge, removeAnyOf, removeFromSortedArray } from '@aztec/foundation/array';
 import { Database, LMDBMessageType } from './message.js';
 import { ReadTransaction } from './read_transaction.js';
-import { dedupeSortedArray, findInSortedArray, findIndexInSortedArray, insertIntoSortedArray, keyCmp, merge, removeAnyOf, removeFromSortedArray, singleKeyCmp } from './utils.js';
+import { keyCmp, singleKeyCmp } from './utils.js';
 export class WriteTransaction extends ReadTransaction {
     // exposed for tests
     dataBatch = {
@@ -35,10 +36,10 @@ export class WriteTransaction extends ReadTransaction {
     remove(key) {
         const removeEntryIndex = findIndexInSortedArray(this.dataBatch.removeEntries, key, singleKeyCmp);
         if (removeEntryIndex === -1) {
-            this.dataBatch.removeEntries.push([
+            insertIntoSortedArray(this.dataBatch.removeEntries, [
                 key,
                 null
-            ]);
+            ], keyCmp);
         }
         const addEntryIndex = findIndexInSortedArray(this.dataBatch.addEntries, key, singleKeyCmp);
         if (addEntryIndex > -1) {
@@ -155,10 +156,13 @@ export class WriteTransaction extends ReadTransaction {
     }
     async *#iterate(iterator, batch, startKey, endKey, reverse = false, limit, merge, map) {
         this.assertIsOpen();
-        // make a copy of this in case we're running in reverse
+        // Snapshot both add and remove entries at the start of iteration to ensure consistency
         const uncommittedEntries = [
             ...batch.addEntries
         ];
+        const removeEntries = [
+            ...batch.removeEntries
+        ];
         // used to check we're in the right order when comparing between a key and uncommittedEntries
         let cmpDirection = -1;
         if (reverse) {
@@ -198,7 +202,7 @@ export class WriteTransaction extends ReadTransaction {
             if (!checkLimit()) {
                 break;
             }
-            const toRemove = findInSortedArray(batch.removeEntries, key, singleKeyCmp);
+            const toRemove = findInSortedArray(removeEntries, key, singleKeyCmp);
             // at this point we've either exhausted all uncommitted entries,
             // we reached a key strictly greater/smaller than `key`
             // or we found the key itself

package/dest/stores/index.d.ts

@@ -1,2 +1,3 @@
 export * from './l2_tips_store.js';
-//# sourceMappingURL=index.d.ts.map
+export { L2TipsMemoryStore, type L2TipsStore } from '@aztec/stdlib/block';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zdG9yZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxvQkFBb0IsQ0FBQztBQUVuQyxPQUFPLEVBQUUsaUJBQWlCLEVBQUUsS0FBSyxXQUFXLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQyJ9

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/stores/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/stores/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,iBAAiB,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC"}

package/dest/stores/index.js

@@ -1 +1,2 @@
 export * from './l2_tips_store.js';
+export { L2TipsMemoryStore } from '@aztec/stdlib/block';

package/dest/stores/l2_tips_store.d.ts

@@ -1,13 +1,29 @@
-import type { L2BlockStreamEvent, L2BlockStreamEventHandler, L2BlockStreamLocalDataProvider, L2Tips } from '@aztec/stdlib/block';
+import { BlockNumber, CheckpointNumber } from '@aztec/foundation/branded-types';
+import { type L2BlockTag, L2TipsStoreBase } from '@aztec/stdlib/block';
+import { PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
 import type { AztecAsyncKVStore } from '../interfaces/store.js';
-/** Stores currently synced L2 tips and unfinalized block hashes. */
-export declare class L2TipsStore implements L2BlockStreamEventHandler, L2BlockStreamLocalDataProvider {
+/**
+ * Persistent implementation of L2 tips store backed by a KV store.
+ * Used by nodes that need to persist chain state across restarts.
+ */
+export declare class L2TipsKVStore extends L2TipsStoreBase {
+    private store;
     private readonly l2TipsStore;
     private readonly l2BlockHashesStore;
+    private readonly l2BlockNumberToCheckpointNumberStore;
+    private readonly l2CheckpointStore;
     constructor(store: AztecAsyncKVStore, namespace: string);
-    getL2BlockHash(number: number): Promise<string | undefined>;
-    getL2Tips(): Promise<L2Tips>;
-    private getL2Tip;
-    handleBlockStreamEvent(event: L2BlockStreamEvent): Promise<void>;
+    protected getTip(tag: L2BlockTag): Promise<BlockNumber | undefined>;
+    protected setTip(tag: L2BlockTag, blockNumber: BlockNumber): Promise<void>;
+    protected getStoredBlockHash(blockNumber: BlockNumber): Promise<string | undefined>;
+    protected setBlockHash(blockNumber: BlockNumber, hash: string): Promise<void>;
+    protected deleteBlockHashesBefore(blockNumber: BlockNumber): Promise<void>;
+    protected getCheckpointNumberForBlock(blockNumber: BlockNumber): Promise<CheckpointNumber | undefined>;
+    protected setCheckpointNumberForBlock(blockNumber: BlockNumber, checkpointNumber: CheckpointNumber): Promise<void>;
+    protected deleteBlockToCheckpointBefore(blockNumber: BlockNumber): Promise<void>;
+    protected getCheckpoint(checkpointNumber: CheckpointNumber): Promise<PublishedCheckpoint | undefined>;
+    protected saveCheckpointData(checkpoint: PublishedCheckpoint): Promise<void>;
+    protected deleteCheckpointsBefore(checkpointNumber: CheckpointNumber): Promise<void>;
+    protected runInTransaction<T>(fn: () => Promise<T>): Promise<T>;
 }
-//# sourceMappingURL=l2_tips_store.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibDJfdGlwc19zdG9yZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3N0b3Jlcy9sMl90aXBzX3N0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxXQUFXLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUNoRixPQUFPLEVBQUUsS0FBSyxVQUFVLEVBQUUsZUFBZSxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFDdkUsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFHL0QsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUVoRTs7O0dBR0c7QUFDSCxxQkFBYSxhQUFjLFNBQVEsZUFBZTtJQU85QyxPQUFPLENBQUMsS0FBSztJQU5mLE9BQU8sQ0FBQyxRQUFRLENBQUMsV0FBVyxDQUF5QztJQUNyRSxPQUFPLENBQUMsUUFBUSxDQUFDLGtCQUFrQixDQUFxQztJQUN4RSxPQUFPLENBQUMsUUFBUSxDQUFDLG9DQUFvQyxDQUErQztJQUNwRyxPQUFPLENBQUMsUUFBUSxDQUFDLGlCQUFpQixDQUEwQztJQUU1RSxZQUNVLEtBQUssRUFBRSxpQkFBaUIsRUFDaEMsU0FBUyxFQUFFLE1BQU0sRUFTbEI7SUFFRCxTQUFTLENBQUMsTUFBTSxDQUFDLEdBQUcsRUFBRSxVQUFVLEdBQUcsT0FBTyxDQUFDLFdBQVcsR0FBRyxTQUFTLENBQUMsQ0FFbEU7SUFFRCxTQUFTLENBQUMsTUFBTSxDQUFDLEdBQUcsRUFBRSxVQUFVLEVBQUUsV0FBVyxFQUFFLFdBQVcsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBRXpFO0lBRUQsU0FBUyxDQUFDLGtCQUFrQixDQUFDLFdBQVcsRUFBRSxXQUFXLEdBQUcsT0FBTyxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUMsQ0FFbEY7SUFFRCxTQUFTLENBQUMsWUFBWSxDQUFDLFdBQVcsRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBRTVFO0lBRUQsVUFBZ0IsdUJBQXVCLENBQUMsV0FBVyxFQUFFLFdBQVcsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBSS9FO0lBRUQsU0FBUyxDQUFDLDJCQUEyQixDQUFDLFdBQVcsRUFBRSxXQUFXLEdBQUcsT0FBTyxDQUFDLGdCQUFnQixHQUFHLFNBQVMsQ0FBQyxDQUVyRztJQUVELFNBQVMsQ0FBQywyQkFBMkIsQ0FBQyxXQUFXLEVBQUUsV0FBVyxFQUFFLGdCQUFnQixFQUFFLGdCQUFnQixHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FFakg7SUFFRCxVQUFnQiw2QkFBNkIsQ0FBQyxXQUFXLEVBQUUsV0FBVyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FJckY7SUFFRCxVQUFnQixhQUFhLENBQUMsZ0JBQWdCLEVBQUUsZ0JBQWdCLEdBQUcsT0FBTyxDQUFDLG1CQUFtQixHQUFHLFNBQVMsQ0FBQyxDQU0xRztJQUVELFNBQVMsQ0FBQyxrQkFBa0IsQ0FBQyxVQUFVLEVBQUUsbUJBQW1CLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUUzRTtJQUVELFVBQWdCLHVCQUF1QixDQUFDLGdCQUFnQixFQUFFLGdCQUFnQixHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FJekY7SUFFRCxTQUFTLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxFQUFFLEVBQUUsRUFBRSxNQUFNLE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBRTlEO0NBQ0YifQ==

package/dest/stores/l2_tips_store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"l2_tips_store.d.ts","sourceRoot":"","sources":["../../src/stores/l2_tips_store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAClB,yBAAyB,EACzB,8BAA8B,EAE9B,MAAM,EACP,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,oEAAoE;AACpE,qBAAa,WAAY,YAAW,yBAAyB,EAAE,8BAA8B;IAC3F,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAoC;IAChE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAgC;gBAEvD,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM;IAKhD,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIrD,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;YAQ3B,QAAQ;IAaT,sBAAsB,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAsB9E"}
+{"version":3,"file":"l2_tips_store.d.ts","sourceRoot":"","sources":["../../src/stores/l2_tips_store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,KAAK,UAAU,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAG/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;;GAGG;AACH,qBAAa,aAAc,SAAQ,eAAe;IAO9C,OAAO,CAAC,KAAK;IANf,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;IACrE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAqC;IACxE,OAAO,CAAC,QAAQ,CAAC,oCAAoC,CAA+C;IACpG,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA0C;IAE5E,YACU,KAAK,EAAE,iBAAiB,EAChC,SAAS,EAAE,MAAM,EASlB;IAED,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAElE;IAED,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAEzE;IAED,SAAS,CAAC,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAElF;IAED,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5E;IAED,UAAgB,uBAAuB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/E;IAED,SAAS,CAAC,2BAA2B,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAErG;IAED,SAAS,CAAC,2BAA2B,CAAC,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjH;IAED,UAAgB,6BAA6B,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAIrF;IAED,UAAgB,aAAa,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAM1G;IAED,SAAS,CAAC,kBAAkB,CAAC,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAE3E;IAED,UAAgB,uBAAuB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAIzF;IAED,SAAS,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAE9D;CACF"}

package/dest/stores/l2_tips_store.js

@@ -1,7 +1,16 @@
-/** Stores currently synced L2 tips and unfinalized block hashes. */ export class L2TipsStore {
+import { L2TipsStoreBase } from '@aztec/stdlib/block';
+import { PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
+/**
+ * Persistent implementation of L2 tips store backed by a KV store.
+ * Used by nodes that need to persist chain state across restarts.
+ */ export class L2TipsKVStore extends L2TipsStoreBase {
+    store;
     l2TipsStore;
     l2BlockHashesStore;
+    l2BlockNumberToCheckpointNumberStore;
+    l2CheckpointStore;
     constructor(store, namespace){
+        super(), this.store = store;
         this.l2TipsStore = store.openMap([
             namespace,
             'l2_tips'
@@ -10,56 +19,65 @@
             namespace,
             'l2_block_hashes'
         ].join('_'));
+        this.l2BlockNumberToCheckpointNumberStore = store.openMap([
+            namespace,
+            'l2_block_number_to_checkpoint_number'
+        ].join('_'));
+        this.l2CheckpointStore = store.openMap([
+            namespace,
+            'l2_checkpoint_store'
+        ].join('_'));
     }
-    getL2BlockHash(number) {
-        return this.l2BlockHashesStore.getAsync(number);
+    getTip(tag) {
+        return this.l2TipsStore.getAsync(tag);
     }
-    async getL2Tips() {
-        return {
-            latest: await this.getL2Tip('latest'),
-            finalized: await this.getL2Tip('finalized'),
-            proven: await this.getL2Tip('proven')
-        };
+    setTip(tag, blockNumber) {
+        return this.l2TipsStore.set(tag, blockNumber);
     }
-    async getL2Tip(tag) {
-        const blockNumber = await this.l2TipsStore.getAsync(tag);
-        if (blockNumber === undefined || blockNumber === 0) {
-            return {
-                number: 0,
-                hash: undefined
-            };
+    getStoredBlockHash(blockNumber) {
+        return this.l2BlockHashesStore.getAsync(blockNumber);
+    }
+    setBlockHash(blockNumber, hash) {
+        return this.l2BlockHashesStore.set(blockNumber, hash);
+    }
+    async deleteBlockHashesBefore(blockNumber) {
+        for await (const key of this.l2BlockHashesStore.keysAsync({
+            end: blockNumber
+        })){
+            await this.l2BlockHashesStore.delete(key);
         }
-        const blockHash = await this.l2BlockHashesStore.getAsync(blockNumber);
-        if (!blockHash) {
-            throw new Error(`Block hash not found for block number ${blockNumber}`);
+    }
+    getCheckpointNumberForBlock(blockNumber) {
+        return this.l2BlockNumberToCheckpointNumberStore.getAsync(blockNumber);
+    }
+    setCheckpointNumberForBlock(blockNumber, checkpointNumber) {
+        return this.l2BlockNumberToCheckpointNumberStore.set(blockNumber, checkpointNumber);
+    }
+    async deleteBlockToCheckpointBefore(blockNumber) {
+        for await (const key of this.l2BlockNumberToCheckpointNumberStore.keysAsync({
+            end: blockNumber
+        })){
+            await this.l2BlockNumberToCheckpointNumberStore.delete(key);
+        }
+    }
+    async getCheckpoint(checkpointNumber) {
+        const buffer = await this.l2CheckpointStore.getAsync(checkpointNumber);
+        if (!buffer) {
+            return undefined;
         }
-        return {
-            number: blockNumber,
-            hash: blockHash
-        };
+        return PublishedCheckpoint.fromBuffer(buffer);
+    }
+    saveCheckpointData(checkpoint) {
+        return this.l2CheckpointStore.set(checkpoint.checkpoint.number, checkpoint.toBuffer());
     }
-    async handleBlockStreamEvent(event) {
-        switch(event.type){
-            case 'blocks-added':
-                for (const block of event.blocks){
-                    await this.l2BlockHashesStore.set(block.number, (await block.header.hash()).toString());
-                }
-                await this.l2TipsStore.set('latest', event.blocks.at(-1).number);
-                break;
-            case 'chain-pruned':
-                await this.l2TipsStore.set('latest', event.blockNumber);
-                break;
-            case 'chain-proven':
-                await this.l2TipsStore.set('proven', event.blockNumber);
-                break;
-            case 'chain-finalized':
-                await this.l2TipsStore.set('finalized', event.blockNumber);
-                for await (const key of this.l2BlockHashesStore.keysAsync({
-                    end: event.blockNumber
-                })){
-                    await this.l2BlockHashesStore.delete(key);
-                }
-                break;
+    async deleteCheckpointsBefore(checkpointNumber) {
+        for await (const key of this.l2CheckpointStore.keysAsync({
+            end: checkpointNumber
+        })){
+            await this.l2CheckpointStore.delete(key);
         }
     }
+    runInTransaction(fn) {
+        return this.store.transactionAsync(fn);
+    }
 }

package/dest/utils.d.ts

@@ -1,12 +1,15 @@
-import type { EthAddress } from '@aztec/foundation/eth-address';
+import { EthAddress } from '@aztec/foundation/eth-address';
 import type { Logger } from '@aztec/foundation/log';
 import type { AztecAsyncKVStore, AztecKVStore } from './interfaces/store.js';
 /**
- * Clears the store if the rollup address does not match the one stored in the database.
- * This is to prevent data from being accidentally shared between different rollup instances.
+ * Clears the store if the schema version or rollup address does not match the one stored in the database.
+ * Also clears if migrating from an older store format that didn't track schema version.
+ * This is to prevent data from being accidentally mixed up between different rollup instances or schema versions.
  * @param store - The store to check
+ * @param targetSchemaVersion - The current schema version
  * @param rollupAddress - The ETH address of the rollup contract
- * @returns A promise that resolves when the store is cleared, or rejects if the rollup address does not match
+ * @param log - Optional logger
+ * @returns The store (cleared if necessary)
  */
-export declare function initStoreForRollup<T extends AztecKVStore | AztecAsyncKVStore>(store: T, rollupAddress: EthAddress, log?: Logger): Promise<T>;
-//# sourceMappingURL=utils.d.ts.map
+export declare function initStoreForRollupAndSchemaVersion<T extends AztecKVStore | AztecAsyncKVStore>(store: T, schemaVersion: number | undefined, rollupAddress: EthAddress | undefined, log?: Logger): Promise<T>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy91dGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFDM0QsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFJcEQsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsWUFBWSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFHN0U7Ozs7Ozs7OztHQVNHO0FBQ0gsd0JBQXNCLGtDQUFrQyxDQUFDLENBQUMsU0FBUyxZQUFZLEdBQUcsaUJBQWlCLEVBQ2pHLEtBQUssRUFBRSxDQUFDLEVBQ1IsYUFBYSxFQUFFLE1BQU0sR0FBRyxTQUFTLEVBQ2pDLGFBQWEsRUFBRSxVQUFVLEdBQUcsU0FBUyxFQUNyQyxHQUFHLENBQUMsRUFBRSxNQUFNLEdBQ1gsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQXFDWiJ9

package/dest/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAG7E;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,SAAS,YAAY,GAAG,iBAAiB,EACjF,KAAK,EAAE,CAAC,EACR,aAAa,EAAE,UAAU,EACzB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,CAAC,CAqBZ"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAIpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAG7E;;;;;;;;;GASG;AACH,wBAAsB,kCAAkC,CAAC,CAAC,SAAS,YAAY,GAAG,iBAAiB,EACjG,KAAK,EAAE,CAAC,EACR,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,aAAa,EAAE,UAAU,GAAG,SAAS,EACrC,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,CAAC,CAqCZ"}

package/dest/utils.js

@@ -1,24 +1,59 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { DatabaseVersion } from '@aztec/stdlib/database-version/version';
 import { isSyncStore } from './interfaces/utils.js';
 /**
- * Clears the store if the rollup address does not match the one stored in the database.
- * This is to prevent data from being accidentally shared between different rollup instances.
+ * Clears the store if the schema version or rollup address does not match the one stored in the database.
+ * Also clears if migrating from an older store format that didn't track schema version.
+ * This is to prevent data from being accidentally mixed up between different rollup instances or schema versions.
  * @param store - The store to check
+ * @param targetSchemaVersion - The current schema version
  * @param rollupAddress - The ETH address of the rollup contract
- * @returns A promise that resolves when the store is cleared, or rejects if the rollup address does not match
- */ export async function initStoreForRollup(store, rollupAddress, log) {
-    if (!rollupAddress) {
-        throw new Error('Rollup address is required');
-    }
-    const rollupAddressValue = store.openSingleton('rollupAddress');
-    const rollupAddressString = rollupAddress.toString();
-    const storedRollupAddressString = isSyncStore(store) ? rollupAddressValue.get() : await rollupAddressValue.getAsync();
-    if (typeof storedRollupAddressString !== 'undefined' && storedRollupAddressString !== rollupAddressString) {
-        log?.warn(`Rollup address mismatch. Clearing entire database...`, {
-            expected: rollupAddressString,
-            found: storedRollupAddressString
-        });
+ * @param log - Optional logger
+ * @returns The store (cleared if necessary)
+ */ export async function initStoreForRollupAndSchemaVersion(store, schemaVersion, rollupAddress, log) {
+    const targetSchemaVersion = schemaVersion ?? 0;
+    const targetRollupAddress = rollupAddress ?? EthAddress.ZERO;
+    const targetDatabaseVersion = new DatabaseVersion(targetSchemaVersion, targetRollupAddress);
+    // DB version: database schema version + rollup address combined)
+    const dbVersion = store.openSingleton('dbVersion');
+    const storedDatabaseVersion = isSyncStore(store) ? dbVersion.get() : await dbVersion.getAsync();
+    // Check if this is an old format store (has rollupAddress singleton but no dbVersion)
+    const oldRollupSingleton = store.openSingleton('rollupAddress');
+    const hasOldFormat = isSyncStore(store) ? !storedDatabaseVersion && !!oldRollupSingleton.get() : !storedDatabaseVersion && !!await oldRollupSingleton.getAsync();
+    if (hasOldFormat || doesStoreNeedToBeCleared(targetDatabaseVersion, storedDatabaseVersion, targetSchemaVersion, targetRollupAddress, log)) {
+        if (hasOldFormat) {
+            log?.warn('Detected old store format without dbVersion, clearing database');
+        }
         await store.clear();
     }
-    await rollupAddressValue.set(rollupAddressString);
+    await dbVersion.set(targetDatabaseVersion.toBuffer().toString('utf-8'));
     return store;
 }
+function doesStoreNeedToBeCleared(targetDatabaseVersion, storedDatabaseVersion, targetSchemaVersion, targetRollupAddress, log) {
+    if (storedDatabaseVersion) {
+        try {
+            const storedVersion = DatabaseVersion.fromBuffer(Buffer.from(storedDatabaseVersion, 'utf-8'));
+            const cmp = storedVersion.cmp(targetDatabaseVersion);
+            if (cmp === undefined) {
+                log?.warn('Rollup address changed, clearing database', {
+                    stored: storedVersion.rollupAddress.toString(),
+                    current: targetRollupAddress.toString()
+                });
+                return true;
+            }
+            if (cmp !== 0) {
+                log?.warn('Schema version changed, clearing database', {
+                    stored: storedVersion.schemaVersion,
+                    current: targetSchemaVersion
+                });
+                return true;
+            }
+        } catch (err) {
+            log?.warn('Failed to parse stored version, clearing database', {
+                err
+            });
+            return true;
+        }
+    }
+    return false;
+}

package/package.json

@@ -1,59 +1,63 @@
 {
   "name": "@aztec/kv-store",
-  "version": "0.0.0-test.1",
+  "version": "0.0.1-commit.001888fc",
   "type": "module",
   "exports": {
     ".": "./dest/interfaces/index.js",
+    "./interfaces": "./dest/interfaces/index.js",
     "./lmdb": "./dest/lmdb/index.js",
     "./lmdb-v2": "./dest/lmdb-v2/index.js",
     "./indexeddb": "./dest/indexeddb/index.js",
-    "./stores": "./dest/stores/index.js",
-    "./config": "./dest/config.js"
+    "./stores": "./dest/stores/index.js"
   },
   "scripts": {
-    "build": "yarn clean && tsc -b",
-    "build:dev": "tsc -b --watch",
+    "build": "yarn clean && ../scripts/tsc.sh",
+    "build:dev": "../scripts/tsc.sh --watch",
     "clean": "rm -rf ./dest .tsbuildinfo",
-    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
-    "formatting:fix": "run -T eslint --fix ./src && run -T prettier -w ./src",
     "test:node": "NODE_NO_WARNINGS=1 mocha --config ./.mocharc.json",
-    "test:browser": "wtr --config ./web-test-runner.config.mjs",
-    "test": "yarn test:node && yarn test:browser && true"
+    "test:browser": "vitest run --config ./vitest.config.ts",
+    "test": "yarn test:node && yarn test:browser",
+    "test:jest": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
   },
   "inherits": [
     "../package.common.json",
     "./package.local.json"
   ],
   "dependencies": {
-    "@aztec/ethereum": "0.0.0-test.1",
-    "@aztec/foundation": "0.0.0-test.1",
-    "@aztec/native": "0.0.0-test.1",
-    "@aztec/stdlib": "0.0.0-test.1",
+    "@aztec/constants": "0.0.1-commit.001888fc",
+    "@aztec/ethereum": "0.0.1-commit.001888fc",
+    "@aztec/foundation": "0.0.1-commit.001888fc",
+    "@aztec/native": "0.0.1-commit.001888fc",
+    "@aztec/stdlib": "0.0.1-commit.001888fc",
     "idb": "^8.0.0",
     "lmdb": "^3.2.0",
     "msgpackr": "^1.11.2",
+    "ohash": "^2.0.11",
     "ordered-binary": "^1.5.3"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
+    "@jest/globals": "^30.0.0",
     "@types/chai": "^5.0.1",
     "@types/chai-as-promised": "^8.0.1",
-    "@types/jest": "^29.5.0",
+    "@types/jest": "^30.0.0",
     "@types/mocha": "^10.0.10",
     "@types/mocha-each": "^2.0.4",
-    "@types/node": "^18.7.23",
+    "@types/node": "^22.15.17",
     "@types/sinon": "^17.0.3",
-    "@web/dev-server-esbuild": "^1.0.3",
-    "@web/test-runner": "^0.19.0",
-    "@web/test-runner-playwright": "^0.11.0",
+    "@typescript/native-preview": "7.0.0-dev.20260113.1",
+    "@vitest/browser-playwright": "^4.0.0",
+    "buffer": "^6.0.3",
     "chai": "^5.1.2",
     "chai-as-promised": "^8.0.1",
-    "jest": "^29.5.0",
+    "jest": "^30.0.0",
     "mocha": "^10.8.2",
     "mocha-each": "^2.0.1",
+    "playwright": "1.49.0",
     "sinon": "^19.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.3.3",
+    "util": "^0.12.5",
+    "vitest": "^4.0.0"
   },
   "files": [
     "dest",
@@ -61,7 +65,7 @@
     "!*.test.*"
   ],
   "engines": {
-    "node": ">=18"
+    "node": ">=20.10"
   },
   "jest": {
     "extensionsToTreatAsEsm": [
@@ -94,6 +98,10 @@
     "testTimeout": 120000,
     "setupFiles": [
       "../../foundation/src/jest/setup.mjs"
+    ],
+    "testEnvironment": "../../foundation/src/jest/env.mjs",
+    "setupFilesAfterEnv": [
+      "../../foundation/src/jest/setupAfterEnv.mjs"
     ]
   }
 }

package/src/indexeddb/array.ts

@@ -1,12 +1,14 @@
 import type { IDBPDatabase, IDBPObjectStore } from 'idb';
+import { hash } from 'ohash';
 
 import type { AztecAsyncArray } from '../interfaces/array.js';
+import type { Value } from '../interfaces/common.js';
 import type { AztecIDBSchema } from './store.js';
 
 /**
  * A persistent array backed by IndexedDB.
  */
-export class IndexedDBAztecArray<T> implements AztecAsyncArray<T> {
+export class IndexedDBAztecArray<T extends Value> implements AztecAsyncArray<T> {
   #_db?: IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'>;
   #rootDB: IDBPDatabase<AztecIDBSchema>;
   #container: string;
@@ -30,7 +32,7 @@ export class IndexedDBAztecArray<T> implements AztecAsyncArray<T> {
     return (
       (await this.db
         .index('key')
-        .count(IDBKeyRange.bound([this.#container, this.#name], [this.#container, this.#name]))) ?? 0
+        .count(IDBKeyRange.bound([this.#container, [this.#name]], [this.#container, [this.#name]]))) ?? 0
     );
   }
 
@@ -39,8 +41,9 @@ export class IndexedDBAztecArray<T> implements AztecAsyncArray<T> {
     for (const val of vals) {
       await this.db.put({
         value: val,
+        hash: hash(val),
         container: this.#container,
-        key: this.#name,
+        key: [this.#name],
         keyCount: length + 1,
         slot: this.#slot(length),
       });
@@ -86,8 +89,9 @@ export class IndexedDBAztecArray<T> implements AztecAsyncArray<T> {
 
     await this.db.put({
       value: val,
+      hash: hash(val),
       container: this.#container,
-      key: this.#name,
+      key: [this.#name],
       keyCount: index + 1,
       slot: this.#slot(index),
     });
@@ -96,7 +100,7 @@ export class IndexedDBAztecArray<T> implements AztecAsyncArray<T> {
 
   async *entriesAsync(): AsyncIterableIterator<[number, T]> {
     const index = this.db.index('key');
-    const rangeQuery = IDBKeyRange.bound([this.#container, this.#name], [this.#container, this.#name]);
+    const rangeQuery = IDBKeyRange.bound([this.#container, [this.#name]], [this.#container, [this.#name]]);
     for await (const cursor of index.iterate(rangeQuery)) {
       yield [cursor.value.keyCount - 1, cursor.value.value] as [number, T];
     }

package/src/indexeddb/index.ts

@@ -1,12 +1,17 @@
 import { type Logger, createLogger } from '@aztec/foundation/log';
+import type { DataStoreConfig } from '@aztec/stdlib/kv-store';
 
-import type { DataStoreConfig } from '../config.js';
-import { initStoreForRollup } from '../utils.js';
+import { initStoreForRollupAndSchemaVersion } from '../utils.js';
 import { AztecIndexedDBStore } from './store.js';
 
 export { AztecIndexedDBStore } from './store.js';
 
-export async function createStore(name: string, config: DataStoreConfig, log: Logger = createLogger('kv-store')) {
+export async function createStore(
+  name: string,
+  config: DataStoreConfig,
+  schemaVersion: number | undefined = undefined,
+  log: Logger = createLogger('kv-store'),
+) {
   let { dataDirectory } = config;
   if (typeof dataDirectory !== 'undefined') {
     dataDirectory = `${dataDirectory}/${name}`;
@@ -14,14 +19,11 @@ export async function createStore(name: string, config: DataStoreConfig, log: Lo
 
   log.info(
     dataDirectory
-      ? `Creating ${name} data store at directory ${dataDirectory} with map size ${config.dataStoreMapSizeKB} KB`
-      : `Creating ${name} ephemeral data store with map size ${config.dataStoreMapSizeKB} KB`,
+      ? `Creating ${name} data store at directory ${dataDirectory} with map size ${config.dataStoreMapSizeKb} KB`
+      : `Creating ${name} ephemeral data store with map size ${config.dataStoreMapSizeKb} KB`,
   );
   const store = await AztecIndexedDBStore.open(createLogger('kv-store:indexeddb'), dataDirectory ?? '', false);
-  if (config.l1Contracts?.rollupAddress) {
-    return initStoreForRollup(store, config.l1Contracts.rollupAddress, log);
-  }
-  return store;
+  return initStoreForRollupAndSchemaVersion(store, schemaVersion, config.l1Contracts?.rollupAddress, log);
 }
 
 export function openTmpStore(ephemeral: boolean = false): Promise<AztecIndexedDBStore> {