@aztec/kv-store 1.0.0 → 1.1.0

package/dest/indexeddb/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/indexeddb/store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,YAAY,EAA0C,MAAM,KAAK,CAAC;AAE/F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAOhE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,KAAK,IAAI;IACxC,KAAK,EAAE,CAAC,CAAC;IACT,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,IAAI,EAAE;QACJ,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;QACvB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7E,CAAC;CACH;AAED;;GAEG;AAEH,qBAAa,mBAAoB,YAAW,iBAAiB;;aAezC,WAAW,EAAE,OAAO;gBADpC,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EACpB,WAAW,EAAE,OAAO,EACpC,IAAI,EAAE,MAAM;IAKd;;;;;;;;;OASG;WACU,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqBvG;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAM1E;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC;IAMtD;;;;OAIG;IACH,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAMpF,WAAW,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;IAI/D;;;;OAIG;IACH,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;IAM5D;;;;OAIG;IACH,aAAa,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAAC,CAAC,CAAC;IAMpE;;;;OAIG;IACG,gBAAgB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAwBjE;;OAEG;IACG,KAAK;IAIX,kDAAkD;IAClD,MAAM;IAMN,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IAIlC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAG9D"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/indexeddb/store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAC;AAEzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAOhE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,KAAK,IAAI;IACxC,KAAK,EAAE,CAAC,CAAC;IACT,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,IAAI,EAAE;QACJ,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;QACvB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7E,CAAC;CACH;AAED;;GAEG;AAEH,qBAAa,mBAAoB,YAAW,iBAAiB;;aAezC,WAAW,EAAE,OAAO;gBADpC,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EACpB,WAAW,EAAE,OAAO,EACpC,IAAI,EAAE,MAAM;IAOd;;;;;;;;;OASG;WACU,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqBvG;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAM1E;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC;IAMtD;;;;OAIG;IACH,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAMpF,WAAW,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;IAI/D;;;;OAIG;IACH,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;IAM5D;;;;OAIG;IACH,aAAa,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAAC,CAAC,CAAC;IAMpE;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAuB3D;;OAEG;IACG,KAAK;IAIX,kDAAkD;IAClD,MAAM;IAMN,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IAIlC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAG9D"}

package/dest/indexeddb/store.js

@@ -1,3 +1,4 @@
+import { SerialQueue } from '@aztec/foundation/queue';
 import { deleteDB, openDB } from 'idb';
 import { IndexedDBAztecArray } from './array.js';
 import { IndexedDBAztecMap } from './map.js';
@@ -10,13 +11,15 @@ import { IndexedDBAztecSingleton } from './singleton.js';
     isEphemeral;
     #rootDB;
     #name;
-    #currentTx;
+    #txQueue;
     #containers;
     constructor(rootDB, isEphemeral, name){
         this.isEphemeral = isEphemeral;
         this.#containers = new Set();
         this.#rootDB = rootDB;
         this.#name = name;
+        this.#txQueue = new SerialQueue();
+        this.#txQueue.start();
     }
     /**
    * Creates a new AztecKVStore backed by IndexedDB. The path to the database is optional. If not provided,
@@ -116,27 +119,26 @@ import { IndexedDBAztecSingleton } from './singleton.js';
    * Runs a callback in a transaction.
    * @param callback - Function to execute in a transaction
    * @returns A promise that resolves to the return value of the callback
-   */ async transactionAsync(callback) {
+   */ transactionAsync(callback) {
         // We can only have one transaction at a time for the same store
         // So we need to wait for the current one to finish
-        if (this.#currentTx) {
-            await this.#currentTx.done;
-        }
-        this.#currentTx = this.#rootDB.transaction('data', 'readwrite');
-        for (const container of this.#containers){
-            container.db = this.#currentTx.store;
-        }
-        // Avoid awaiting this promise so it doesn't get scheduled in the next microtask
-        // By then, the tx would be closed
-        const runningPromise = callback();
-        // Wait for the transaction to finish
-        await this.#currentTx.done;
-        for (const container of this.#containers){
-            container.db = undefined;
-        }
-        // Return the result of the callback.
-        // Tx is guaranteed to already be closed, so the await doesn't hurt anything here
-        return await runningPromise;
+        return this.#txQueue.put(async ()=>{
+            const tx = this.#rootDB.transaction('data', 'readwrite');
+            for (const container of this.#containers){
+                container.db = tx.store;
+            }
+            // Avoid awaiting this promise so it doesn't get scheduled in the next microtask
+            // By then, the tx would be closed
+            const runningPromise = callback();
+            // Wait for the transaction to finish
+            await tx.done;
+            for (const container of this.#containers){
+                container.db = undefined;
+            }
+            // Return the result of the callback.
+            // Tx is guaranteed to already be closed, so the await doesn't hurt anything here
+            return await runningPromise;
+        });
     }
     /**
    * Clears all entries in the store & sub DBs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/kv-store",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
   "exports": {
     ".": "./dest/interfaces/index.js",
@@ -24,10 +24,10 @@
     "./package.local.json"
   ],
   "dependencies": {
-    "@aztec/ethereum": "1.0.0",
-    "@aztec/foundation": "1.0.0",
-    "@aztec/native": "1.0.0",
-    "@aztec/stdlib": "1.0.0",
+    "@aztec/ethereum": "1.1.0",
+    "@aztec/foundation": "1.1.0",
+    "@aztec/native": "1.1.0",
+    "@aztec/stdlib": "1.1.0",
     "idb": "^8.0.0",
     "lmdb": "^3.2.0",
     "msgpackr": "^1.11.2",

package/src/indexeddb/store.ts

@@ -1,6 +1,7 @@
 import type { Logger } from '@aztec/foundation/log';
+import { SerialQueue } from '@aztec/foundation/queue';
 
-import { type DBSchema, type IDBPDatabase, type IDBPTransaction, deleteDB, openDB } from 'idb';
+import { type DBSchema, type IDBPDatabase, deleteDB, openDB } from 'idb';
 
 import type { AztecAsyncArray } from '../interfaces/array.js';
 import type { Key, StoreSize, Value } from '../interfaces/common.js';
@@ -40,7 +41,7 @@ export interface AztecIDBSchema extends DBSchema {
 export class AztecIndexedDBStore implements AztecAsyncKVStore {
   #rootDB: IDBPDatabase<AztecIDBSchema>;
   #name: string;
-  #currentTx: IDBPTransaction<AztecIDBSchema, ['data'], 'readwrite'> | undefined;
+  #txQueue: SerialQueue;
 
   #containers = new Set<
     | IndexedDBAztecArray<any>
@@ -57,6 +58,8 @@ export class AztecIndexedDBStore implements AztecAsyncKVStore {
   ) {
     this.#rootDB = rootDB;
     this.#name = name;
+    this.#txQueue = new SerialQueue();
+    this.#txQueue.start();
   }
   /**
    * Creates a new AztecKVStore backed by IndexedDB. The path to the database is optional. If not provided,
@@ -153,28 +156,27 @@ export class AztecIndexedDBStore implements AztecAsyncKVStore {
    * @param callback - Function to execute in a transaction
    * @returns A promise that resolves to the return value of the callback
    */
-  async transactionAsync<T>(callback: () => Promise<T>): Promise<T> {
+  transactionAsync<T>(callback: () => Promise<T>): Promise<T> {
     // We can only have one transaction at a time for the same store
     // So we need to wait for the current one to finish
-    if (this.#currentTx) {
-      await this.#currentTx.done;
-    }
-    this.#currentTx = this.#rootDB.transaction('data', 'readwrite');
-    for (const container of this.#containers) {
-      container.db = this.#currentTx.store;
-    }
-    // Avoid awaiting this promise so it doesn't get scheduled in the next microtask
-    // By then, the tx would be closed
-    const runningPromise = callback();
-    // Wait for the transaction to finish
-    await this.#currentTx.done;
-    for (const container of this.#containers) {
-      container.db = undefined;
-    }
-
-    // Return the result of the callback.
-    // Tx is guaranteed to already be closed, so the await doesn't hurt anything here
-    return await runningPromise;
+    return this.#txQueue.put(async () => {
+      const tx = this.#rootDB.transaction('data', 'readwrite');
+      for (const container of this.#containers) {
+        container.db = tx.store;
+      }
+      // Avoid awaiting this promise so it doesn't get scheduled in the next microtask
+      // By then, the tx would be closed
+      const runningPromise = callback();
+      // Wait for the transaction to finish
+      await tx.done;
+      for (const container of this.#containers) {
+        container.db = undefined;
+      }
+
+      // Return the result of the callback.
+      // Tx is guaranteed to already be closed, so the await doesn't hurt anything here
+      return await runningPromise;
+    });
   }
 
   /**