@aztec/kv-store 0.0.0-test.0

package/dest/lmdb/store.d.ts

@@ -0,0 +1,110 @@
+import { type RootDatabase } from 'lmdb';
+import type { AztecArray, AztecAsyncArray } from '../interfaces/array.js';
+import type { Key, StoreSize } from '../interfaces/common.js';
+import type { AztecAsyncCounter, AztecCounter } from '../interfaces/counter.js';
+import type { AztecAsyncMap, AztecAsyncMultiMap, AztecMap, AztecMapWithSize, AztecMultiMap, AztecMultiMapWithSize } from '../interfaces/map.js';
+import type { AztecAsyncSet, AztecSet } from '../interfaces/set.js';
+import type { AztecAsyncSingleton, AztecSingleton } from '../interfaces/singleton.js';
+import type { AztecAsyncKVStore, AztecKVStore } from '../interfaces/store.js';
+/**
+ * A key-value store backed by LMDB.
+ */
+export declare class AztecLmdbStore implements AztecKVStore, AztecAsyncKVStore {
+    #private;
+    readonly isEphemeral: boolean;
+    private path;
+    syncGetters: true;
+    constructor(rootDb: RootDatabase, isEphemeral: boolean, path: string);
+    /**
+     * Creates a new AztecKVStore backed by LMDB. 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.
+     *
+     * The `rollupAddress` passed is checked against what is stored in the database. If they do not match,
+     * the database is cleared before returning the store. This way data is not accidentally shared between
+     * different rollup instances.
+     *
+     * @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(path?: string, mapSizeKb?: number, // defaults to 1 GB map size
+    ephemeral?: boolean, log?: import("@aztec/foundation/log").Logger): AztecLmdbStore;
+    /**
+     * Forks the current DB into a new DB by backing it up to a temporary location and opening a new lmdb db.
+     * @returns A new AztecLmdbStore.
+     */
+    fork(): Promise<AztecLmdbStore>;
+    /**
+     * Creates a new AztecMap in the store.
+     * @param name - Name of the map
+     * @returns A new AztecMap
+     */
+    openMap<K extends Key, V>(name: string): AztecMap<K, V> & 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): AztecSet<K> & 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): AztecMultiMap<K, V> & AztecAsyncMultiMap<K, V>;
+    openCounter<K extends Key>(name: string): AztecCounter<K> & AztecAsyncCounter<K>;
+    /**
+     * Creates a new AztecMultiMapWithSize in the store. A multi-map with size stores multiple values for a single key automatically.
+     * @param name - Name of the map
+     * @returns A new AztecMultiMapWithSize
+     */
+    openMultiMapWithSize<K extends Key, V>(name: string): AztecMultiMapWithSize<K, V>;
+    /**
+     * Creates a new AztecMapWithSize in the store.
+     * @param name - Name of the map
+     * @returns A new AztecMapWithSize
+     */
+    openMapWithSize<K extends Key, V>(name: string): AztecMapWithSize<K, V>;
+    /**
+     * Creates a new AztecArray in the store.
+     * @param name - Name of the array
+     * @returns A new AztecArray
+     */
+    openArray<T>(name: string): AztecArray<T> & AztecAsyncArray<T>;
+    /**
+     * Creates a new AztecSingleton in the store.
+     * @param name - Name of the singleton
+     * @returns A new AztecSingleton
+     */
+    openSingleton<T>(name: string): AztecSingleton<T> & 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
+     */
+    transaction<T>(callback: () => T): Promise<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>;
+    /**
+     * Drops the database & sub DBs.
+     */
+    drop(): Promise<void>;
+    /**
+     * Close the database. Note, once this is closed we can no longer interact with the DB.
+     */
+    close(): Promise<void>;
+    /** Deletes this store and removes the database files from disk */
+    delete(): Promise<void>;
+    estimateSize(): Promise<StoreSize>;
+    private estimateSubDBSize;
+}
+//# sourceMappingURL=store.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/lmdb/store.ts"],"names":[],"mappings":"AAIA,OAAO,EAAiB,KAAK,YAAY,EAAQ,MAAM,MAAM,CAAC;AAI9D,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,QAAQ,EACR,gBAAgB,EAChB,aAAa,EACb,qBAAqB,EACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAO9E;;GAEG;AACH,qBAAa,cAAe,YAAW,YAAY,EAAE,iBAAiB;;aAQlB,WAAW,EAAE,OAAO;IAAE,OAAO,CAAC,IAAI;IAPpF,WAAW,OAAiB;gBAOhB,MAAM,EAAE,YAAY,EAAkB,WAAW,EAAE,OAAO,EAAU,IAAI,EAAE,MAAM;IAgB5F;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,CACT,IAAI,CAAC,EAAE,MAAM,EACb,SAAS,SAAkB,EAAE,4BAA4B;IACzD,SAAS,GAAE,OAAe,EAC1B,GAAG,yCAAgC,GAClC,cAAc;IASjB;;;OAGG;IACG,IAAI;IAWV;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAI7E;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;IAIpE;;;;OAIG;IACH,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAI5F,WAAW,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC;IAGhF;;;;OAIG;IACH,oBAAoB,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IAIjF;;;;OAIG;IACH,eAAe,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAIvE;;;;OAIG;IACH,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC;IAI9D;;;;OAIG;IACH,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC;IAI1E;;;;OAIG;IACH,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7C;;;;OAIG;IACG,gBAAgB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAIjE;;OAEG;IACG,KAAK;IAMX;;OAEG;IACG,IAAI;IAMV;;OAEG;IACG,KAAK;IAMX,kEAAkE;IAC5D,MAAM;IASZ,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IAiBlC,OAAO,CAAC,iBAAiB;CA2B1B"}

package/dest/lmdb/store.js

@@ -0,0 +1,216 @@
+import { randomBytes } from '@aztec/foundation/crypto';
+import { createLogger } from '@aztec/foundation/log';
+import { promises as fs, mkdirSync } from 'fs';
+import { open } from 'lmdb';
+import { tmpdir } from 'os';
+import { join } from 'path';
+import { LmdbAztecArray } from './array.js';
+import { LmdbAztecCounter } from './counter.js';
+import { LmdbAztecMap, LmdbAztecMapWithSize } from './map.js';
+import { LmdbAztecSet } from './set.js';
+import { LmdbAztecSingleton } from './singleton.js';
+/**
+ * A key-value store backed by LMDB.
+ */ export class AztecLmdbStore {
+    isEphemeral;
+    path;
+    syncGetters;
+    #rootDb;
+    #data;
+    #multiMapData;
+    #log;
+    constructor(rootDb, isEphemeral, path){
+        this.isEphemeral = isEphemeral;
+        this.path = path;
+        this.syncGetters = true;
+        this.#log = createLogger('kv-store:lmdb');
+        this.#rootDb = rootDb;
+        // big bucket to store all the data
+        this.#data = rootDb.openDB('data', {
+            encoding: 'msgpack',
+            keyEncoding: 'ordered-binary'
+        });
+        this.#multiMapData = rootDb.openDB('data_dup_sort', {
+            encoding: 'ordered-binary',
+            keyEncoding: 'ordered-binary',
+            dupSort: true
+        });
+    }
+    /**
+   * Creates a new AztecKVStore backed by LMDB. 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.
+   *
+   * The `rollupAddress` passed is checked against what is stored in the database. If they do not match,
+   * the database is cleared before returning the store. This way data is not accidentally shared between
+   * different rollup instances.
+   *
+   * @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(path, mapSizeKb = 1 * 1024 * 1024, ephemeral = false, log = createLogger('kv-store:lmdb')) {
+        const dbPath = path ?? join(tmpdir(), randomBytes(8).toString('hex'));
+        mkdirSync(dbPath, {
+            recursive: true
+        });
+        const mapSize = 1024 * mapSizeKb;
+        log.debug(`Opening LMDB database at ${path || 'temporary location'} with map size ${mapSize}`);
+        const rootDb = open({
+            path: dbPath,
+            noSync: ephemeral,
+            mapSize
+        });
+        return new AztecLmdbStore(rootDb, ephemeral, dbPath);
+    }
+    /**
+   * Forks the current DB into a new DB by backing it up to a temporary location and opening a new lmdb db.
+   * @returns A new AztecLmdbStore.
+   */ async fork() {
+        const baseDir = this.path;
+        this.#log.debug(`Forking store with basedir ${baseDir}`);
+        const forkPath = await fs.mkdtemp(join(baseDir, 'aztec-store-fork-'));
+        this.#log.verbose(`Forking store to ${forkPath}`);
+        await this.#rootDb.backup(forkPath, false);
+        const forkDb = open(forkPath, {
+            noSync: this.isEphemeral
+        });
+        this.#log.debug(`Forked store at ${forkPath} opened successfully`);
+        return new AztecLmdbStore(forkDb, this.isEphemeral, forkPath);
+    }
+    /**
+   * Creates a new AztecMap in the store.
+   * @param name - Name of the map
+   * @returns A new AztecMap
+   */ openMap(name) {
+        return new LmdbAztecMap(this.#data, name);
+    }
+    /**
+   * Creates a new AztecSet in the store.
+   * @param name - Name of the set
+   * @returns A new AztecSet
+   */ openSet(name) {
+        return new LmdbAztecSet(this.#data, name);
+    }
+    /**
+   * 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(name) {
+        return new LmdbAztecMap(this.#multiMapData, name);
+    }
+    openCounter(name) {
+        return new LmdbAztecCounter(this.#data, name);
+    }
+    /**
+   * Creates a new AztecMultiMapWithSize in the store. A multi-map with size stores multiple values for a single key automatically.
+   * @param name - Name of the map
+   * @returns A new AztecMultiMapWithSize
+   */ openMultiMapWithSize(name) {
+        return new LmdbAztecMapWithSize(this.#multiMapData, name);
+    }
+    /**
+   * Creates a new AztecMapWithSize in the store.
+   * @param name - Name of the map
+   * @returns A new AztecMapWithSize
+   */ openMapWithSize(name) {
+        return new LmdbAztecMapWithSize(this.#data, name);
+    }
+    /**
+   * Creates a new AztecArray in the store.
+   * @param name - Name of the array
+   * @returns A new AztecArray
+   */ openArray(name) {
+        return new LmdbAztecArray(this.#data, name);
+    }
+    /**
+   * Creates a new AztecSingleton in the store.
+   * @param name - Name of the singleton
+   * @returns A new AztecSingleton
+   */ openSingleton(name) {
+        return new LmdbAztecSingleton(this.#data, name);
+    }
+    /**
+   * 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
+   */ transaction(callback) {
+        return this.#rootDb.transaction(callback);
+    }
+    /**
+   * 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) {
+        return await this.#rootDb.transaction(callback);
+    }
+    /**
+   * Clears all entries in the store & sub DBs.
+   */ async clear() {
+        await this.#data.clearAsync();
+        await this.#multiMapData.clearAsync();
+        await this.#rootDb.clearAsync();
+    }
+    /**
+   * Drops the database & sub DBs.
+   */ async drop() {
+        await this.#data.drop();
+        await this.#multiMapData.drop();
+        await this.#rootDb.drop();
+    }
+    /**
+   * Close the database. Note, once this is closed we can no longer interact with the DB.
+   */ async close() {
+        await this.#data.close();
+        await this.#multiMapData.close();
+        await this.#rootDb.close();
+    }
+    /** Deletes this store and removes the database files from disk */ async delete() {
+        await this.drop();
+        await this.close();
+        if (this.path) {
+            await fs.rm(this.path, {
+                recursive: true,
+                force: true,
+                maxRetries: 3
+            });
+            this.#log.verbose(`Deleted database files at ${this.path}`);
+        }
+    }
+    estimateSize() {
+        const stats = this.#rootDb.getStats();
+        // The 'mapSize' is the total amount of virtual address space allocated to the DB (effectively the maximum possible size)
+        // http://www.lmdb.tech/doc/group__mdb.html#a4bde3c8b676457342cba2fe27aed5fbd
+        let mapSize = 0;
+        if ('mapSize' in stats && typeof stats.mapSize === 'number') {
+            mapSize = stats.mapSize;
+        }
+        const dataResult = this.estimateSubDBSize(this.#data);
+        const multiResult = this.estimateSubDBSize(this.#multiMapData);
+        return Promise.resolve({
+            mappingSize: mapSize,
+            actualSize: dataResult.actualSize + multiResult.actualSize,
+            numItems: dataResult.numItems + multiResult.numItems
+        });
+    }
+    estimateSubDBSize(db) {
+        const stats = db.getStats();
+        let actualSize = 0;
+        let numItems = 0;
+        // This is the total number of key/value pairs present in the DB
+        if ('entryCount' in stats && typeof stats.entryCount === 'number') {
+            numItems = stats.entryCount;
+        }
+        // The closest value we can get to the actual size of the database is the number of consumed pages * the page size
+        if ('treeBranchPageCount' in stats && typeof stats.treeBranchPageCount === 'number' && 'treeLeafPageCount' in stats && typeof stats.treeLeafPageCount === 'number' && 'overflowPages' in stats && typeof stats.overflowPages === 'number' && 'pageSize' in stats && typeof stats.pageSize === 'number') {
+            const branchPages = stats.treeBranchPageCount;
+            const leafPages = stats.treeLeafPageCount;
+            const overflowPages = stats.overflowPages;
+            const pageSize = stats.pageSize;
+            actualSize = (branchPages + leafPages + overflowPages) * pageSize;
+        }
+        return {
+            actualSize,
+            numItems
+        };
+    }
+}

package/dest/lmdb-v2/array.d.ts

@@ -0,0 +1,18 @@
+import type { AztecAsyncArray } from '../interfaces/array.js';
+import { AztecLMDBStoreV2 } from './store.js';
+export declare class LMDBArray<T> implements AztecAsyncArray<T> {
+    private store;
+    private length;
+    private encoder;
+    private prefix;
+    constructor(store: AztecLMDBStoreV2, name: string);
+    pop(): Promise<T | undefined>;
+    push(...vals: T[]): Promise<number>;
+    setAt(index: number, val: T): Promise<boolean>;
+    atAsync(index: number): Promise<T | undefined>;
+    lengthAsync(): Promise<number>;
+    entriesAsync(): AsyncIterableIterator<[number, T]>;
+    valuesAsync(): AsyncIterableIterator<T>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+}
+//# sourceMappingURL=array.d.ts.map

package/dest/lmdb-v2/array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/lmdb-v2/array.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAG9D,OAAO,EAAE,gBAAgB,EAA+B,MAAM,YAAY,CAAC;AAG3E,qBAAa,SAAS,CAAC,CAAC,CAAE,YAAW,eAAe,CAAC,CAAC,CAAC;IAKzC,OAAO,CAAC,KAAK;IAJzB,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,MAAM,CAAS;gBAEH,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM;IAKzD,GAAG,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAgB7B,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAWnC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAc9C,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAexC,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7B,YAAY,IAAI,qBAAqB,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IA2BlD,WAAW,IAAI,qBAAqB,CAAC,CAAC,CAAC;IAM9C,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC;CAGnD"}

package/dest/lmdb-v2/array.js

@@ -0,0 +1,101 @@
+import { Encoder } from 'msgpackr/pack';
+import { execInReadTx, execInWriteTx } from './store.js';
+import { deserializeKey, serializeKey } from './utils.js';
+export class LMDBArray {
+    store;
+    length;
+    encoder;
+    prefix;
+    constructor(store, name){
+        this.store = store;
+        this.encoder = new Encoder();
+        this.length = store.openSingleton(name + ':length');
+        this.prefix = `array:${name}`;
+    }
+    pop() {
+        return execInWriteTx(this.store, async (tx)=>{
+            const length = await this.lengthAsync();
+            if (length === 0) {
+                return;
+            }
+            const val = await tx.get(serializeKey(this.prefix, length - 1));
+            await tx.remove(serializeKey(this.prefix, length - 1));
+            await this.length.set(length - 1);
+            return val ? this.encoder.unpack(val) : undefined;
+        });
+    }
+    push(...vals) {
+        return execInWriteTx(this.store, async (tx)=>{
+            let length = await this.lengthAsync();
+            for (const val of vals){
+                await tx.set(serializeKey(this.prefix, length++), this.encoder.pack(val));
+            }
+            await this.length.set(length);
+            return length;
+        });
+    }
+    setAt(index, val) {
+        return execInWriteTx(this.store, async (tx)=>{
+            const length = await this.lengthAsync();
+            if (index < 0) {
+                index += length;
+            }
+            if (index < 0 || index >= length) {
+                return false;
+            }
+            await tx.set(serializeKey(this.prefix, index), this.encoder.pack(val));
+            return true;
+        });
+    }
+    atAsync(index) {
+        return execInReadTx(this.store, async (tx)=>{
+            const length = await this.lengthAsync();
+            if (index < 0) {
+                index += length;
+            }
+            if (index < 0 || index >= length) {
+                return undefined;
+            }
+            const val = await tx.get(serializeKey(this.prefix, index));
+            return val ? this.encoder.unpack(val) : undefined;
+        });
+    }
+    async lengthAsync() {
+        return await this.length.getAsync() ?? 0;
+    }
+    async *entriesAsync() {
+        // pin array length so that pushes don't affect iteration
+        const length = await this.lengthAsync();
+        if (length === 0) {
+            return;
+        }
+        let tx = this.store.getCurrentWriteTx();
+        const shouldClose = !tx;
+        tx ??= this.store.getReadTx();
+        try {
+            for await (const [key, val] of tx.iterate(serializeKey(this.prefix, 0), undefined, false, length)){
+                const deserializedKey = deserializeKey(this.prefix, key);
+                // if pops happened while iterating we may have read too much. Terminate early
+                if (deserializedKey === false) {
+                    break;
+                }
+                yield [
+                    deserializedKey,
+                    this.encoder.unpack(val)
+                ];
+            }
+        } finally{
+            if (shouldClose) {
+                tx.close();
+            }
+        }
+    }
+    async *valuesAsync() {
+        for await (const [_, value] of this.entriesAsync()){
+            yield value;
+        }
+    }
+    [Symbol.asyncIterator]() {
+        return this.valuesAsync();
+    }
+}

package/dest/lmdb-v2/factory.d.ts

@@ -0,0 +1,12 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { type Logger } from '@aztec/foundation/log';
+import type { DataStoreConfig } from '../config.js';
+import { AztecLMDBStoreV2 } from './store.js';
+export declare function createStore(name: string, schemaVersion: number, config: DataStoreConfig, log?: Logger): Promise<AztecLMDBStoreV2>;
+export declare function openTmpStore(name: string, ephemeral?: boolean, dbMapSizeKb?: number, // 10GB
+maxReaders?: number, log?: Logger): Promise<AztecLMDBStoreV2>;
+export declare function openStoreAt(dataDir: string, dbMapSizeKb?: number, // 10GB
+maxReaders?: number, log?: Logger): Promise<AztecLMDBStoreV2>;
+export declare function openVersionedStoreAt(dataDir: string, schemaVersion: number, rollupAddress: EthAddress, dbMapSizeKb?: number, // 10GB
+maxReaders?: number, log?: Logger): Promise<AztecLMDBStoreV2>;
+//# sourceMappingURL=factory.d.ts.map

package/dest/lmdb-v2/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/lmdb-v2/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAOlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAI9C,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,eAAe,EACvB,GAAG,GAAE,MAAiD,GACrD,OAAO,CAAC,gBAAgB,CAAC,CAyB3B;AAED,wBAAsB,YAAY,CAChC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,OAAc,EACzB,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAiD,GACrD,OAAO,CAAC,gBAAgB,CAAC,CAqB3B;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,MAAM,EACf,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAyC,GAC7C,OAAO,CAAC,gBAAgB,CAAC,CAG3B;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,UAAU,EACzB,WAAW,SAAqB,EAAE,OAAO;AACzC,UAAU,SAAc,EACxB,GAAG,GAAE,MAAyC,GAC7C,OAAO,CAAC,gBAAgB,CAAC,CAM3B"}

package/dest/lmdb-v2/factory.js

@@ -0,0 +1,60 @@
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { createLogger } from '@aztec/foundation/log';
+import { DatabaseVersionManager } from '@aztec/stdlib/database-version';
+import { mkdir, mkdtemp, rm } from 'fs/promises';
+import { tmpdir } from 'os';
+import { join } from 'path';
+import { AztecLMDBStoreV2 } from './store.js';
+const MAX_READERS = 16;
+export async function createStore(name, schemaVersion, config, log = createLogger('kv-store:lmdb-v2:' + name)) {
+    const { dataDirectory, l1Contracts } = config;
+    let store;
+    if (typeof dataDirectory !== 'undefined') {
+        // Get rollup address from contracts config, or use zero address
+        const subDir = join(dataDirectory, name);
+        await mkdir(subDir, {
+            recursive: true
+        });
+        const rollupAddress = l1Contracts ? l1Contracts.rollupAddress : EthAddress.ZERO;
+        // Create a version manager
+        const versionManager = new DatabaseVersionManager(schemaVersion, rollupAddress, subDir, (dbDirectory)=>AztecLMDBStoreV2.new(dbDirectory, config.dataStoreMapSizeKB, MAX_READERS, ()=>Promise.resolve(), log));
+        log.info(`Creating ${name} data store at directory ${subDir} with map size ${config.dataStoreMapSizeKB} KB (LMDB v2)`);
+        [store] = await versionManager.open();
+    } else {
+        store = await openTmpStore(name, true, config.dataStoreMapSizeKB, MAX_READERS, log);
+    }
+    return store;
+}
+export async function openTmpStore(name, ephemeral = true, dbMapSizeKb = 10 * 1_024 * 1_024, maxReaders = MAX_READERS, log = createLogger('kv-store:lmdb-v2:' + name)) {
+    const dataDir = await mkdtemp(join(tmpdir(), name + '-'));
+    log.debug(`Created temporary data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
+    // pass a cleanup callback because process.on('beforeExit', cleanup) does not work under Jest
+    const cleanup = async ()=>{
+        if (ephemeral) {
+            try {
+                await rm(dataDir, {
+                    recursive: true,
+                    force: true,
+                    maxRetries: 3
+                });
+                log.debug(`Deleted temporary data store: ${dataDir}`);
+            } catch (err) {
+                log.warn(`Failed to delete temporary data directory (LMDB v2) ${dataDir}: ${err}`);
+            }
+        } else {
+            log.debug(`Leaving temporary data store: ${dataDir}`);
+        }
+    };
+    // For temporary stores, we don't need to worry about versioning
+    // as they are ephemeral and get cleaned up after use
+    return AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, cleanup, log);
+}
+export async function openStoreAt(dataDir, dbMapSizeKb = 10 * 1_024 * 1_024, maxReaders = MAX_READERS, log = createLogger('kv-store:lmdb-v2')) {
+    log.debug(`Opening data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
+    return await AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log);
+}
+export async function openVersionedStoreAt(dataDir, schemaVersion, rollupAddress, dbMapSizeKb = 10 * 1_024 * 1_024, maxReaders = MAX_READERS, log = createLogger('kv-store:lmdb-v2')) {
+    log.debug(`Opening data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
+    const [store] = await new DatabaseVersionManager(schemaVersion, rollupAddress, dataDir, (dataDir)=>AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log)).open();
+    return store;
+}

package/dest/lmdb-v2/index.d.ts

@@ -0,0 +1,3 @@
+export * from './store.js';
+export * from './factory.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/lmdb-v2/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lmdb-v2/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/dest/lmdb-v2/index.js

@@ -0,0 +1,2 @@
+export * from './store.js';
+export * from './factory.js';

package/dest/lmdb-v2/map.d.ts

@@ -0,0 +1,86 @@
+import type { Key, Range } from '../interfaces/common.js';
+import type { AztecAsyncMap, AztecAsyncMultiMap } from '../interfaces/map.js';
+import { type AztecLMDBStoreV2 } from './store.js';
+export declare class LMDBMap<K extends Key, V> implements AztecAsyncMap<K, V> {
+    private store;
+    private prefix;
+    private encoder;
+    constructor(store: AztecLMDBStoreV2, name: string);
+    /**
+     * Sets the value at the given key.
+     * @param key - The key to set the value at
+     * @param val - The value to set
+     */
+    set(key: K, val: V): Promise<void>;
+    /**
+     * Sets the value at the given key if it does not already exist.
+     * @param key - The key to set the value at
+     * @param val - The value to set
+     */
+    setIfNotExists(key: K, val: V): Promise<boolean>;
+    /**
+     * Deletes the value at the given key.
+     * @param key - The key to delete the value at
+     */
+    delete(key: K): Promise<void>;
+    getAsync(key: K): Promise<V | undefined>;
+    hasAsync(key: K): Promise<boolean>;
+    /**
+     * Iterates over the map's key-value entries in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    entriesAsync(range?: Range<K>): AsyncIterableIterator<[K, V]>;
+    /**
+     * Iterates over the map's values in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    valuesAsync(range?: Range<K>): AsyncIterableIterator<V>;
+    /**
+     * Iterates over the map's keys in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    keysAsync(range?: Range<K>): AsyncIterableIterator<K>;
+}
+export declare class LMDBMultiMap<K extends Key, V> implements AztecAsyncMultiMap<K, V> {
+    private store;
+    private prefix;
+    private encoder;
+    constructor(store: AztecLMDBStoreV2, name: string);
+    /**
+     * Sets the value at the given key.
+     * @param key - The key to set the value at
+     * @param val - The value to set
+     */
+    set(key: K, val: V): Promise<void>;
+    /**
+     * Sets the value at the given key if it does not already exist.
+     * @param key - The key to set the value at
+     * @param val - The value to set
+     */
+    setIfNotExists(key: K, val: V): Promise<boolean>;
+    /**
+     * Deletes the value at the given key.
+     * @param key - The key to delete the value at
+     */
+    delete(key: K): Promise<void>;
+    getAsync(key: K): Promise<V | undefined>;
+    hasAsync(key: K): Promise<boolean>;
+    /**
+     * Iterates over the map's key-value entries in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    entriesAsync(range?: Range<K>): AsyncIterableIterator<[K, V]>;
+    /**
+     * Iterates over the map's values in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    valuesAsync(range?: Range<K>): AsyncIterableIterator<V>;
+    /**
+     * Iterates over the map's keys in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    keysAsync(range?: Range<K>): AsyncIterableIterator<K>;
+    deleteValue(key: K, val: V | undefined): Promise<void>;
+    getValuesAsync(key: K): AsyncIterableIterator<V>;
+}
+//# sourceMappingURL=map.d.ts.map

package/dest/lmdb-v2/map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/lmdb-v2/map.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE9E,OAAO,EAAE,KAAK,gBAAgB,EAA+B,MAAM,YAAY,CAAC;AAGhF,qBAAa,OAAO,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAIvD,OAAO,CAAC,KAAK;IAHzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAiB;gBAEZ,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM;IAGzD;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAYhD;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7B,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAOxC,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlC;;;OAGG;IACI,YAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IA8BpE;;;OAGG;IACI,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAM9D;;;OAGG;IACI,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;CAK7D;AAED,qBAAa,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAE,YAAW,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAGjE,OAAO,CAAC,KAAK;IAFzB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAiB;gBACZ,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM;IAIzD;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAWhD;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7B,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAOxC,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlC;;;OAGG;IACI,YAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAgCpE;;;OAGG;IACI,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAM9D;;;OAGG;IACI,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAM5D,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC;CAMxD"}