@aztec/kv-store 0.0.0-test.0

package/README.md

@@ -0,0 +1,10 @@
+# KV Store
+
+The Aztec KV store is an implementation of a durable key-value database with a pluggable backend. The only supported backend right now is LMDB by using the [`lmdb-js` package](https://github.com/kriszyp/lmdb-js).
+
+This package exports a number of primitive data structures that can be used to build domain-specific databases in each node component (e.g. a PXE database or an Archiver database). The data structures supported:
+
+- singleton - holds a single value. Great for when a value needs to be stored but it's not a collection (e.g. the latest block header or the length of an array)
+- array - works like a normal in-memory JS array. It can't contain holes and it can be used as a stack (push-pop mechanics).
+- map - a hashmap where keys can be numbers or strings
+- multi-map - just like a map but each key holds multiple values. Can be used for indexing into other data structures

package/dest/config.d.ts

@@ -0,0 +1,17 @@
+import { type ConfigMappingsType } from '@aztec/foundation/config';
+import type { EthAddress } from '@aztec/foundation/eth-address';
+export type DataStoreConfig = {
+    dataDirectory: string | undefined;
+    dataStoreMapSizeKB: number;
+    l1Contracts?: {
+        rollupAddress: EthAddress;
+    };
+};
+export declare const dataConfigMappings: ConfigMappingsType<DataStoreConfig>;
+/**
+ * Returns the archiver configuration from the environment variables.
+ * Note: If an environment variable is not set, the default value is used.
+ * @returns The archiver configuration.
+ */
+export declare function getDataConfigFromEnv(): DataStoreConfig;
+//# sourceMappingURL=config.d.ts.map

package/dest/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,kBAAkB,EAA6C,MAAM,0BAA0B,CAAC;AAC9G,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAEhE,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE,CAAC;CAC7C,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,kBAAkB,CAAC,eAAe,CAclE,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,eAAe,CAEtD"}

package/dest/config.js

@@ -0,0 +1,24 @@
+import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
+import { getConfigFromMappings, numberConfigHelper } from '@aztec/foundation/config';
+export const dataConfigMappings = {
+    dataDirectory: {
+        env: 'DATA_DIRECTORY',
+        description: 'Optional dir to store data. If omitted will store in memory.'
+    },
+    dataStoreMapSizeKB: {
+        env: 'DATA_STORE_MAP_SIZE_KB',
+        description: 'DB mapping size to be applied to all key/value stores',
+        ...numberConfigHelper(128 * 1_024 * 1_024)
+    },
+    l1Contracts: {
+        description: 'The deployed L1 contract addresses',
+        nested: l1ContractAddressesMapping
+    }
+};
+/**
+ * Returns the archiver configuration from the environment variables.
+ * Note: If an environment variable is not set, the default value is used.
+ * @returns The archiver configuration.
+ */ export function getDataConfigFromEnv() {
+    return getConfigFromMappings(dataConfigMappings);
+}

package/dest/indexeddb/array.d.ts

@@ -0,0 +1,21 @@
+import type { IDBPDatabase, IDBPObjectStore } from 'idb';
+import type { AztecAsyncArray } from '../interfaces/array.js';
+import type { AztecIDBSchema } from './store.js';
+/**
+ * A persistent array backed by IndexedDB.
+ */
+export declare class IndexedDBAztecArray<T> implements AztecAsyncArray<T> {
+    #private;
+    constructor(rootDB: IDBPDatabase<AztecIDBSchema>, name: string);
+    set db(db: IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'> | undefined);
+    get db(): IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'>;
+    lengthAsync(): Promise<number>;
+    push(...vals: T[]): Promise<number>;
+    pop(): Promise<T | undefined>;
+    atAsync(index: number): Promise<T | undefined>;
+    setAt(index: number, val: T): Promise<boolean>;
+    entriesAsync(): AsyncIterableIterator<[number, T]>;
+    valuesAsync(): AsyncIterableIterator<T>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+}
+//# sourceMappingURL=array.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/indexeddb/array.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,KAAK,CAAC;AAEzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,qBAAa,mBAAmB,CAAC,CAAC,CAAE,YAAW,eAAe,CAAC,CAAC,CAAC;;gBAMnD,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,MAAM;IAM9D,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,SAAS,EAEpF;IAED,IAAI,EAAE,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAEvE;IAEK,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ9B,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAenC,GAAG,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAa7B,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAW9C,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAqB7C,YAAY,IAAI,qBAAqB,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAQlD,WAAW,IAAI,qBAAqB,CAAC,CAAC,CAAC;IAM9C,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC;CAOnD"}

package/dest/indexeddb/array.js

@@ -0,0 +1,104 @@
+/**
+ * A persistent array backed by IndexedDB.
+ */ export class IndexedDBAztecArray {
+    #_db;
+    #rootDB;
+    #container;
+    #name;
+    constructor(rootDB, name){
+        this.#rootDB = rootDB;
+        this.#name = name;
+        this.#container = `array:${this.#name}`;
+    }
+    set db(db) {
+        this.#_db = db;
+    }
+    get db() {
+        return this.#_db ? this.#_db : this.#rootDB.transaction('data', 'readwrite').store;
+    }
+    async lengthAsync() {
+        return await this.db.index('key').count(IDBKeyRange.bound([
+            this.#container,
+            this.#name
+        ], [
+            this.#container,
+            this.#name
+        ])) ?? 0;
+    }
+    async push(...vals) {
+        let length = await this.lengthAsync();
+        for (const val of vals){
+            await this.db.put({
+                value: val,
+                container: this.#container,
+                key: this.#name,
+                keyCount: length + 1,
+                slot: this.#slot(length)
+            });
+            length += 1;
+        }
+        return length;
+    }
+    async pop() {
+        const length = await this.lengthAsync();
+        if (length === 0) {
+            return undefined;
+        }
+        const slot = this.#slot(length - 1);
+        const data = await this.db.get(slot);
+        await this.db.delete(slot);
+        return data?.value;
+    }
+    async atAsync(index) {
+        const length = await this.lengthAsync();
+        if (index < 0) {
+            index = length + index;
+        }
+        const data = await this.db.get(this.#slot(index));
+        return data?.value;
+    }
+    async setAt(index, val) {
+        const length = await this.lengthAsync();
+        if (index < 0) {
+            index = length + index;
+        }
+        if (index < 0 || index >= length) {
+            return Promise.resolve(false);
+        }
+        await this.db.put({
+            value: val,
+            container: this.#container,
+            key: this.#name,
+            keyCount: index + 1,
+            slot: this.#slot(index)
+        });
+        return true;
+    }
+    async *entriesAsync() {
+        const index = this.db.index('key');
+        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
+            ];
+        }
+    }
+    async *valuesAsync() {
+        for await (const [_, value] of this.entriesAsync()){
+            yield value;
+        }
+    }
+    [Symbol.asyncIterator]() {
+        return this.valuesAsync();
+    }
+    #slot(index) {
+        return `array:${this.#name}:slot:${index}`;
+    }
+}

package/dest/indexeddb/index.d.ts

@@ -0,0 +1,7 @@
+import { type Logger } from '@aztec/foundation/log';
+import type { DataStoreConfig } from '../config.js';
+import { AztecIndexedDBStore } from './store.js';
+export { AztecIndexedDBStore } from './store.js';
+export declare function createStore(name: string, config: DataStoreConfig, log?: Logger): Promise<AztecIndexedDBStore>;
+export declare function openTmpStore(ephemeral?: boolean): Promise<AztecIndexedDBStore>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/indexeddb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAElE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,GAAE,MAAiC,gCAgB9G;AAED,wBAAgB,YAAY,CAAC,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAErF"}

package/dest/indexeddb/index.js

@@ -0,0 +1,19 @@
+import { createLogger } from '@aztec/foundation/log';
+import { initStoreForRollup } from '../utils.js';
+import { AztecIndexedDBStore } from './store.js';
+export { AztecIndexedDBStore } from './store.js';
+export async function createStore(name, config, log = createLogger('kv-store')) {
+    let { dataDirectory } = config;
+    if (typeof dataDirectory !== 'undefined') {
+        dataDirectory = `${dataDirectory}/${name}`;
+    }
+    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`);
+    const store = await AztecIndexedDBStore.open(createLogger('kv-store:indexeddb'), dataDirectory ?? '', false);
+    if (config.l1Contracts?.rollupAddress) {
+        return initStoreForRollup(store, config.l1Contracts.rollupAddress, log);
+    }
+    return store;
+}
+export function openTmpStore(ephemeral = false) {
+    return AztecIndexedDBStore.open(createLogger('kv-store:indexeddb'), undefined, ephemeral);
+}

package/dest/indexeddb/map.d.ts

@@ -0,0 +1,26 @@
+import type { IDBPDatabase, IDBPObjectStore } from 'idb';
+import type { Key, Range } from '../interfaces/common.js';
+import type { AztecAsyncMultiMap } from '../interfaces/map.js';
+import type { AztecIDBSchema } from './store.js';
+/**
+ * A map backed by IndexedDB.
+ */
+export declare class IndexedDBAztecMap<K extends Key, V> implements AztecAsyncMultiMap<K, V> {
+    #private;
+    protected name: string;
+    constructor(rootDB: IDBPDatabase<AztecIDBSchema>, mapName: string);
+    set db(db: IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'> | undefined);
+    get db(): IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'>;
+    getAsync(key: K): Promise<V | undefined>;
+    getValuesAsync(key: K): AsyncIterableIterator<V>;
+    hasAsync(key: K): Promise<boolean>;
+    set(key: K, val: V): Promise<void>;
+    swap(_key: K, _fn: (val: V | undefined) => V): Promise<void>;
+    setIfNotExists(key: K, val: V): Promise<boolean>;
+    delete(key: K): Promise<void>;
+    deleteValue(key: K, val: V): Promise<void>;
+    entriesAsync(range?: Range<K>): AsyncIterableIterator<[K, V]>;
+    valuesAsync(range?: Range<K>): AsyncIterableIterator<V>;
+    keysAsync(range?: Range<K>): AsyncIterableIterator<K>;
+}
+//# sourceMappingURL=map.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/indexeddb/map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,KAAK,CAAC;AAEzD,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAE,YAAW,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;;IAClF,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;gBAMX,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,MAAM;IAMjE,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,SAAS,EAEpF;IAED,IAAI,EAAE,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAEvE;IAEK,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAKvC,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAajD,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAKlC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,SAAS,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQhD,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7B,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBzC,YAAY,CAAC,KAAK,GAAE,KAAK,CAAC,CAAC,CAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAkBjE,WAAW,CAAC,KAAK,GAAE,KAAK,CAAC,CAAC,CAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAM3D,SAAS,CAAC,KAAK,GAAE,KAAK,CAAC,CAAC,CAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC;CAmBjE"}

package/dest/indexeddb/map.js

@@ -0,0 +1,133 @@
+/**
+ * A map backed by IndexedDB.
+ */ export class IndexedDBAztecMap {
+    name;
+    #container;
+    #_db;
+    #rootDB;
+    constructor(rootDB, mapName){
+        this.name = mapName;
+        this.#container = `map:${mapName}`;
+        this.#rootDB = rootDB;
+    }
+    set db(db) {
+        this.#_db = db;
+    }
+    get db() {
+        return this.#_db ? this.#_db : this.#rootDB.transaction('data', 'readwrite').store;
+    }
+    async getAsync(key) {
+        const data = await this.db.get(this.#slot(key));
+        return data?.value;
+    }
+    async *getValuesAsync(key) {
+        const index = this.db.index('keyCount');
+        const rangeQuery = IDBKeyRange.bound([
+            this.#container,
+            this.#normalizeKey(key),
+            0
+        ], [
+            this.#container,
+            this.#normalizeKey(key),
+            Number.MAX_SAFE_INTEGER
+        ], false, false);
+        for await (const cursor of index.iterate(rangeQuery)){
+            yield cursor.value.value;
+        }
+    }
+    async hasAsync(key) {
+        const result = await this.getAsync(key) !== undefined;
+        return result;
+    }
+    async set(key, val) {
+        const count = await this.db.index('key').count(IDBKeyRange.bound([
+            this.#container,
+            this.#normalizeKey(key)
+        ], [
+            this.#container,
+            this.#normalizeKey(key)
+        ]));
+        await this.db.put({
+            value: val,
+            container: this.#container,
+            key: this.#normalizeKey(key),
+            keyCount: count + 1,
+            slot: this.#slot(key, count)
+        });
+    }
+    swap(_key, _fn) {
+        throw new Error('Not implemented');
+    }
+    async setIfNotExists(key, val) {
+        if (!await this.hasAsync(key)) {
+            await this.set(key, val);
+            return true;
+        }
+        return false;
+    }
+    async delete(key) {
+        await this.db.delete(this.#slot(key));
+    }
+    async deleteValue(key, val) {
+        const index = this.db.index('keyCount');
+        const rangeQuery = IDBKeyRange.bound([
+            this.#container,
+            this.#normalizeKey(key),
+            0
+        ], [
+            this.#container,
+            this.#normalizeKey(key),
+            Number.MAX_SAFE_INTEGER
+        ], false, false);
+        for await (const cursor of index.iterate(rangeQuery)){
+            if (JSON.stringify(cursor.value.value) === JSON.stringify(val)) {
+                await cursor.delete();
+                return;
+            }
+        }
+    }
+    async *entriesAsync(range = {}) {
+        const index = this.db.index('key');
+        const rangeQuery = IDBKeyRange.bound([
+            this.#container,
+            range.start ?? ''
+        ], [
+            this.#container,
+            range.end ?? '\uffff'
+        ], !!range.reverse, !range.reverse);
+        let count = 0;
+        for await (const cursor of index.iterate(rangeQuery, range.reverse ? 'prev' : 'next')){
+            if (range.limit && count >= range.limit) {
+                return;
+            }
+            yield [
+                cursor.value.key,
+                cursor.value.value
+            ];
+            count++;
+        }
+    }
+    async *valuesAsync(range = {}) {
+        for await (const [_, value] of this.entriesAsync(range)){
+            yield value;
+        }
+    }
+    async *keysAsync(range = {}) {
+        for await (const [key, _] of this.entriesAsync(range)){
+            yield this.#denormalizeKey(key);
+        }
+    }
+    #denormalizeKey(key) {
+        const denormalizedKey = key.split(',').map((part)=>isNaN(parseInt(part)) ? part : parseInt(part));
+        return denormalizedKey.length > 1 ? denormalizedKey : key;
+    }
+    #normalizeKey(key) {
+        const arrayKey = Array.isArray(key) ? key : [
+            key
+        ];
+        return arrayKey.join(',');
+    }
+    #slot(key, index = 0) {
+        return `map:${this.name}:slot:${this.#normalizeKey(key)}:${index}`;
+    }
+}

package/dest/indexeddb/set.d.ts

@@ -0,0 +1,17 @@
+import type { IDBPDatabase, IDBPObjectStore } from 'idb';
+import type { Key, Range } from '../interfaces/common.js';
+import type { AztecAsyncSet } from '../interfaces/set.js';
+import type { AztecIDBSchema } from './store.js';
+/**
+ * A set backed by IndexedDB.
+ */
+export declare class IndexedDBAztecSet<K extends Key> implements AztecAsyncSet<K> {
+    private map;
+    constructor(rootDb: IDBPDatabase<AztecIDBSchema>, mapName: string);
+    set db(db: IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'> | undefined);
+    hasAsync(key: K): Promise<boolean>;
+    add(key: K): Promise<void>;
+    delete(key: K): Promise<void>;
+    entriesAsync(range?: Range<K>): AsyncIterableIterator<K>;
+}
+//# sourceMappingURL=set.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../src/indexeddb/set.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,KAAK,CAAC;AAEzD,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,GAAG,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC;IACvE,OAAO,CAAC,GAAG,CAAgC;gBAE/B,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,MAAM;IAIjE,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,SAAS,EAEpF;IAED,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1B,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItB,YAAY,CAAC,KAAK,GAAE,KAAK,CAAC,CAAC,CAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC;CAGpE"}

package/dest/indexeddb/set.js

@@ -0,0 +1,24 @@
+import { IndexedDBAztecMap } from './map.js';
+/**
+ * A set backed by IndexedDB.
+ */ export class IndexedDBAztecSet {
+    map;
+    constructor(rootDb, mapName){
+        this.map = new IndexedDBAztecMap(rootDb, mapName);
+    }
+    set db(db) {
+        this.map.db = db;
+    }
+    hasAsync(key) {
+        return this.map.hasAsync(key);
+    }
+    add(key) {
+        return this.map.set(key, true);
+    }
+    delete(key) {
+        return this.map.delete(key);
+    }
+    async *entriesAsync(range = {}) {
+        yield* this.map.keysAsync(range);
+    }
+}

package/dest/indexeddb/singleton.d.ts

@@ -0,0 +1,16 @@
+import type { IDBPDatabase, IDBPObjectStore } from 'idb';
+import type { AztecAsyncSingleton } from '../interfaces/singleton.js';
+import type { AztecIDBSchema } from './store.js';
+/**
+ * Stores a single value in IndexedDB.
+ */
+export declare class IndexedDBAztecSingleton<T> implements AztecAsyncSingleton<T> {
+    #private;
+    constructor(rootDB: IDBPDatabase<AztecIDBSchema>, name: string);
+    set db(db: IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'> | undefined);
+    get db(): IDBPObjectStore<AztecIDBSchema, ['data'], 'data', 'readwrite'>;
+    getAsync(): Promise<T | undefined>;
+    set(val: T): Promise<boolean>;
+    delete(): Promise<boolean>;
+}
+//# sourceMappingURL=singleton.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"singleton.d.ts","sourceRoot":"","sources":["../../src/indexeddb/singleton.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,KAAK,CAAC;AAEzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,qBAAa,uBAAuB,CAAC,CAAC,CAAE,YAAW,mBAAmB,CAAC,CAAC,CAAC;;gBAM3D,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,MAAM;IAM9D,IAAI,EAAE,CAAC,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,SAAS,EAEpF;IAED,IAAI,EAAE,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAEvE;IAEK,QAAQ,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAKlC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAW7B,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;CAIjC"}

package/dest/indexeddb/singleton.js

@@ -0,0 +1,37 @@
+/**
+ * Stores a single value in IndexedDB.
+ */ export class IndexedDBAztecSingleton {
+    #_db;
+    #rootDB;
+    #container;
+    #slot;
+    constructor(rootDB, name){
+        this.#rootDB = rootDB;
+        this.#container = `singleton:${name}`;
+        this.#slot = `singleton:${name}:value`;
+    }
+    set db(db) {
+        this.#_db = db;
+    }
+    get db() {
+        return this.#_db ? this.#_db : this.#rootDB.transaction('data', 'readwrite').store;
+    }
+    async getAsync() {
+        const data = await this.db.get(this.#slot);
+        return data?.value;
+    }
+    async set(val) {
+        const result = await this.db.put({
+            container: this.#container,
+            slot: this.#slot,
+            key: this.#slot,
+            keyCount: 1,
+            value: val
+        });
+        return result !== undefined;
+    }
+    async delete() {
+        await this.db.delete(this.#slot);
+        return true;
+    }
+}

package/dest/indexeddb/store.d.ts

@@ -0,0 +1,97 @@
+import type { Logger } from '@aztec/foundation/log';
+import { type DBSchema, type IDBPDatabase } from 'idb';
+import type { AztecAsyncArray } from '../interfaces/array.js';
+import type { Key, StoreSize } from '../interfaces/common.js';
+import type { AztecAsyncCounter } from '../interfaces/counter.js';
+import type { AztecAsyncMap, AztecAsyncMultiMap } from '../interfaces/map.js';
+import type { AztecAsyncSet } from '../interfaces/set.js';
+import type { AztecAsyncSingleton } from '../interfaces/singleton.js';
+import type { AztecAsyncKVStore } from '../interfaces/store.js';
+export type StoredData<V> = {
+    value: V;
+    container: string;
+    key: string;
+    keyCount: number;
+    slot: string;
+};
+export interface AztecIDBSchema extends DBSchema {
+    data: {
+        value: StoredData<any>;
+        key: string;
+        indexes: {
+            container: string;
+            key: string;
+            keyCount: number;
+        };
+    };
+}
+/**
+ * A key-value store backed by IndexedDB.
+ */
+export declare class AztecIndexedDBStore implements AztecAsyncKVStore {
+    #private;
+    readonly isEphemeral: boolean;
+    constructor(rootDB: IDBPDatabase<AztecIDBSchema>, isEphemeral: boolean, log: Logger, name: string);
+    /**
+     * Creates a new AztecKVStore backed by IndexedDB. The path to the database is optional. If not provided,
+     * the database will be stored in a temporary location and be deleted when the process exists.
+     *
+     *
+     * @param path - A path on the disk to store the database. Optional
+     * @param ephemeral - true if the store should only exist in memory and not automatically be flushed to disk. Optional
+     * @param log - A logger to use. Optional
+     * @returns The store
+     */
+    static open(log: Logger, name?: string, ephemeral?: boolean): Promise<AztecIndexedDBStore>;
+    /**
+     * Forks the current DB into a new DB by backing it up to a temporary location and opening a new indexedb.
+     * @returns A new AztecIndexedDBStore.
+     */
+    fork(): Promise<AztecAsyncKVStore>;
+    /**
+     * Creates a new AztecMap in the store.
+     * @param name - Name of the map
+     * @returns A new AztecMap
+     */
+    openMap<K extends Key, V>(name: string): AztecAsyncMap<K, V>;
+    /**
+     * Creates a new AztecSet in the store.
+     * @param name - Name of the set
+     * @returns A new AztecSet
+     */
+    openSet<K extends Key>(name: string): AztecAsyncSet<K>;
+    /**
+     * Creates a new AztecMultiMap in the store. A multi-map stores multiple values for a single key automatically.
+     * @param name - Name of the map
+     * @returns A new AztecMultiMap
+     */
+    openMultiMap<K extends Key, V>(name: string): AztecAsyncMultiMap<K, V>;
+    openCounter<K extends Key>(_name: string): AztecAsyncCounter<K>;
+    /**
+     * Creates a new AztecArray in the store.
+     * @param name - Name of the array
+     * @returns A new AztecArray
+     */
+    openArray<T>(name: string): AztecAsyncArray<T>;
+    /**
+     * Creates a new AztecSingleton in the store.
+     * @param name - Name of the singleton
+     * @returns A new AztecSingleton
+     */
+    openSingleton<T>(name: string): AztecAsyncSingleton<T>;
+    /**
+     * 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
+     */
+    transactionAsync<T>(callback: () => Promise<T>): Promise<T>;
+    /**
+     * Clears all entries in the store & sub DBs.
+     */
+    clear(): Promise<void>;
+    /** Deletes this store and removes the database */
+    delete(): Promise<void>;
+    estimateSize(): Promise<StoreSize>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=store.d.ts.map

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

@@ -0,0 +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,EAAoB,MAAM,KAAK,CAAC;AAEzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC9E,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;AAMhE,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAAE,KAAK,EAAE,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzG,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,CAAA;SAAE,CAAC;KAC/D,CAAC;CACH;AAED;;GAEG;AAEH,qBAAa,mBAAoB,YAAW,iBAAiB;;aASO,WAAW,EAAE,OAAO;gBAA1E,MAAM,EAAE,YAAY,CAAC,cAAc,CAAC,EAAkB,WAAW,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKjH;;;;;;;;;OASG;WACU,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgBvG;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAmBxC;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAM5D;;;;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,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAMtE,WAAW,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;IAI/D;;;;OAIG;IACH,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;IAM9C;;;;OAIG;IACH,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAAC,CAAC,CAAC;IAMtD;;;;OAIG;IACG,gBAAgB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAkBjE;;OAEG;IACG,KAAK;IAIX,kDAAkD;IAClD,MAAM;IAMN,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IAIlC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGvB"}