@aztec-labs/kv-store 6.0.0-nightly.20260829

package/dest/interfaces/counter.js

@@ -0,0 +1 @@
+export { };

package/dest/interfaces/index.d.ts

@@ -0,0 +1,10 @@
+export * from './array.js';
+export * from './map.js';
+export * from './counter.js';
+export * from './singleton.js';
+export * from './store.js';
+export * from './set.js';
+export * from './multi_map.js';
+export { mapRange } from './common.js';
+export type { CustomRange, Key, Range, StoreSize } from './common.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcmZhY2VzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsWUFBWSxDQUFDO0FBQzNCLGNBQWMsVUFBVSxDQUFDO0FBQ3pCLGNBQWMsY0FBYyxDQUFDO0FBQzdCLGNBQWMsZ0JBQWdCLENBQUM7QUFDL0IsY0FBYyxZQUFZLENBQUM7QUFDM0IsY0FBYyxVQUFVLENBQUM7QUFDekIsY0FBYyxnQkFBZ0IsQ0FBQztBQUMvQixPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ3ZDLFlBQVksRUFBRSxXQUFXLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxhQUFhLENBQUMifQ==

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,YAAY,EAAE,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dest/interfaces/index.js

@@ -0,0 +1,8 @@
+export * from './array.js';
+export * from './map.js';
+export * from './counter.js';
+export * from './singleton.js';
+export * from './store.js';
+export * from './set.js';
+export * from './multi_map.js';
+export { mapRange } from './common.js';

package/dest/interfaces/map.d.ts

@@ -0,0 +1,106 @@
+import type { Key, Range, Value } from './common.js';
+/**
+ * A map backed by a persistent store.
+ */
+interface AztecBaseMap<K extends Key, V extends Value> {
+    /**
+     * 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 values at the given keys.
+     * @param entries - The entries to set
+     */
+    setMany(entries: {
+        key: K;
+        value: 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>;
+}
+export interface AztecMap<K extends Key, V extends Value> extends AztecBaseMap<K, V> {
+    /**
+     * Gets the value at the given key.
+     * @param key - The key to get the value from
+     */
+    get(key: K): V | undefined;
+    /**
+     * Gets the current size of the map.
+     * @returns The size of the map
+     */
+    size(): number;
+    /**
+     * Checks if a key exists in the map.
+     * @param key - The key to check
+     * @returns True if the key exists, false otherwise
+     */
+    has(key: K): boolean;
+    /**
+     * Iterates over the map's key-value entries in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    entries(range?: Range<K>): IterableIterator<[K, V]>;
+    /**
+     * Iterates over the map's values in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    values(range?: Range<K>): IterableIterator<V>;
+    /**
+     * Iterates over the map's keys in the key's natural order
+     * @param range - The range of keys to iterate over
+     */
+    keys(range?: Range<K>): IterableIterator<K>;
+    /**
+     * Clears the map.
+     */
+    clear(): Promise<void>;
+}
+/**
+ * A map backed by a persistent store.
+ */
+export interface AztecAsyncMap<K extends Key, V extends Value> extends AztecBaseMap<K, V> {
+    /**
+     * Gets the value at the given key.
+     * @param key - The key to get the value from
+     */
+    getAsync(key: K): Promise<V | undefined>;
+    /**
+     * Checks if a key exists in the map.
+     * @param key - The key to check
+     * @returns True if the key exists, false otherwise
+     */
+    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>;
+    /**
+     * Gets the current size of the map.
+     * @returns The size of the map
+     */
+    sizeAsync(): Promise<number>;
+}
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFwLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9tYXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFFckQ7O0dBRUc7QUFDSCxVQUFVLFlBQVksQ0FBQyxDQUFDLFNBQVMsR0FBRyxFQUFFLENBQUMsU0FBUyxLQUFLO0lBQ25EOzs7O09BSUc7SUFDSCxHQUFHLENBQUMsR0FBRyxFQUFFLENBQUMsRUFBRSxHQUFHLEVBQUUsQ0FBQyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUVuQzs7O09BR0c7SUFDSCxPQUFPLENBQUMsT0FBTyxFQUFFO1FBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQztRQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7S0FBRSxFQUFFLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXhEOzs7O09BSUc7SUFDSCxjQUFjLENBQUMsR0FBRyxFQUFFLENBQUMsRUFBRSxHQUFHLEVBQUUsQ0FBQyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUVqRDs7O09BR0c7SUFDSCxNQUFNLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7Q0FDL0I7QUFDRCxNQUFNLFdBQVcsUUFBUSxDQUFDLENBQUMsU0FBUyxHQUFHLEVBQUUsQ0FBQyxTQUFTLEtBQUssQ0FBRSxTQUFRLFlBQVksQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ2xGOzs7T0FHRztJQUNILEdBQUcsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxHQUFHLENBQUMsR0FBRyxTQUFTLENBQUM7SUFFM0I7OztPQUdHO0lBQ0gsSUFBSSxJQUFJLE1BQU0sQ0FBQztJQUVmOzs7O09BSUc7SUFDSCxHQUFHLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxPQUFPLENBQUM7SUFFckI7OztPQUdHO0lBQ0gsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsR0FBRyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRXBEOzs7T0FHRztJQUNILE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQyxDQUFDLEdBQUcsZ0JBQWdCLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFOUM7OztPQUdHO0lBQ0gsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsR0FBRyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUU1Qzs7T0FFRztJQUNILEtBQUssSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7Q0FDeEI7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxhQUFhLENBQUMsQ0FBQyxTQUFTLEdBQUcsRUFBRSxDQUFDLFNBQVMsS0FBSyxDQUFFLFNBQVEsWUFBWSxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUM7SUFDdkY7OztPQUdHO0lBQ0gsUUFBUSxDQUFDLEdBQUcsRUFBRSxDQUFDLEdBQUcsT0FBTyxDQUFDLENBQUMsR0FBRyxTQUFTLENBQUMsQ0FBQztJQUV6Qzs7OztPQUlHO0lBQ0gsUUFBUSxDQUFDLEdBQUcsRUFBRSxDQUFDLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBRW5DOzs7T0FHRztJQUNILFlBQVksQ0FBQyxLQUFLLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQyxDQUFDLEdBQUcscUJBQXFCLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUU5RDs7O09BR0c7SUFDSCxXQUFXLENBQUMsS0FBSyxDQUFDLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQyxHQUFHLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRXhEOzs7T0FHRztJQUNILFNBQVMsQ0FBQyxLQUFLLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQyxDQUFDLEdBQUcscUJBQXFCLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFdEQ7OztPQUdHO0lBQ0gsU0FBUyxJQUFJLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztDQUM5QiJ9

package/dest/interfaces/map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/interfaces/map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAErD;;GAEG;AACH,UAAU,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK;IACnD;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,CAAC,CAAC;QAAC,KAAK,EAAE,CAAC,CAAA;KAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjD;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B;AACD,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,CAAE,SAAQ,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;IAClF;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE3B;;;OAGG;IACH,IAAI,IAAI,MAAM,CAAC;IAEf;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEpD;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAE9C;;;OAGG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAE5C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,CAAE,SAAQ,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;IACvF;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,YAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACH,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAExD;;;OAGG;IACH,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEtD;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAC9B"}

package/dest/interfaces/map.js

@@ -0,0 +1,3 @@
+/**
+ * A map backed by a persistent store.
+ */ export { };

package/dest/interfaces/map_test_suite.d.ts

@@ -0,0 +1,3 @@
+import type { AztecAsyncKVStore, AztecKVStore } from './store.js';
+export declare function describeAztecMap(testName: string, getStore: () => AztecKVStore | Promise<AztecAsyncKVStore>, forceAsync?: boolean): void;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWFwX3Rlc3Rfc3VpdGUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcmZhY2VzL21hcF90ZXN0X3N1aXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUlBLE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLFlBQVksRUFBRSxNQUFNLFlBQVksQ0FBQztBQUdsRSx3QkFBZ0IsZ0JBQWdCLENBQzlCLFFBQVEsRUFBRSxNQUFNLEVBQ2hCLFFBQVEsRUFBRSxNQUFNLFlBQVksR0FBRyxPQUFPLENBQUMsaUJBQWlCLENBQUMsRUFDekQsVUFBVSxHQUFFLE9BQWUsUUEyTDVCIn0=

package/dest/interfaces/map_test_suite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map_test_suite.d.ts","sourceRoot":"","sources":["../../src/interfaces/map_test_suite.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAGlE,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,EACzD,UAAU,GAAE,OAAe,QA2L5B"}

package/dest/interfaces/map_test_suite.js

@@ -0,0 +1,261 @@
+import { toArray } from '@aztec-labs/foundation/iterable';
+import { isSyncStore } from './utils.js';
+export function describeAztecMap(testName, getStore, forceAsync = false) {
+    describe(testName, ()=>{
+        let store;
+        let map;
+        beforeEach(async ()=>{
+            store = await getStore();
+            map = store.openMap('test');
+        });
+        afterEach(async ()=>{
+            await store.delete();
+        });
+        async function get(key, sut = map) {
+            return isSyncStore(store) && !forceAsync ? sut.get(key) : await sut.getAsync(key);
+        }
+        async function size(sut = map) {
+            return isSyncStore(store) && !forceAsync ? sut.size() : await sut.sizeAsync();
+        }
+        async function entries() {
+            return isSyncStore(store) && !forceAsync ? await toArray(map.entries()) : await toArray(map.entriesAsync());
+        }
+        async function values() {
+            return isSyncStore(store) && !forceAsync ? await toArray(map.values()) : await toArray(map.valuesAsync());
+        }
+        async function keys(range, sut = map) {
+            return isSyncStore(store) && !forceAsync ? await toArray(sut.keys(range)) : await toArray(sut.keysAsync(range));
+        }
+        it('should be able to set and get values', async ()=>{
+            await map.set('foo', 'bar');
+            await map.set('baz', 'qux');
+            expect(await get('foo')).toBe('bar');
+            expect(await get('baz')).toBe('qux');
+            expect(await get('quux')).toBe(undefined);
+        });
+        it('should be able to set many values', async ()=>{
+            const pairs = Array.from({
+                length: 100
+            }, (_, i)=>({
+                    key: `key${i}`,
+                    value: `value${i}`
+                }));
+            await map.setMany(pairs);
+            for (const { key, value } of pairs){
+                expect(await get(key)).toBe(value);
+            }
+        });
+        it('should be able to overwrite values', async ()=>{
+            await map.set('foo', 'bar');
+            await map.set('foo', 'baz');
+            expect(await get('foo')).toBe('baz');
+        });
+        it('should be able to set values if they do not exist', async ()=>{
+            expect(await map.setIfNotExists('foo', 'bar')).toBe(true);
+            expect(await map.setIfNotExists('foo', 'baz')).toBe(false);
+            expect(await get('foo')).toBe('bar');
+        });
+        it('should be able to delete values', async ()=>{
+            await map.set('foo', 'bar');
+            await map.set('baz', 'qux');
+            await map.delete('foo');
+            expect(await get('foo')).toBe(undefined);
+            expect(await get('baz')).toBe('qux');
+        });
+        it('should be able to return size of the map', async ()=>{
+            await map.set('foo', 'bar');
+            expect(await size()).toBe(1);
+            await map.set('baz', 'qux');
+            expect(await size()).toBe(2);
+            await map.delete('foo');
+            expect(await size()).toBe(1);
+        });
+        it('returns 0 for empty map size', async ()=>{
+            expect(await size()).toBe(0);
+        });
+        it('calculates size correctly across multiple operations', async ()=>{
+            expect(await size()).toBe(0);
+            // Add items
+            await map.set('a', 'value1');
+            await map.set('b', 'value2');
+            await map.set('c', 'value3');
+            expect(await size()).toBe(3);
+            // Update existing (size should not change)
+            await map.set('b', 'updated');
+            expect(await size()).toBe(3);
+            // Delete some
+            await map.delete('a');
+            expect(await size()).toBe(2);
+            // Delete all
+            await map.delete('b');
+            await map.delete('c');
+            expect(await size()).toBe(0);
+        });
+        it('should be able to iterate over entries when there are no keys', async ()=>{
+            expect(await entries()).toEqual([]);
+        });
+        it('should be able to iterate over entries', async ()=>{
+            await map.set('foo', 'bar');
+            await map.set('baz', 'qux');
+            expect(await entries()).toEqual([
+                [
+                    'baz',
+                    'qux'
+                ],
+                [
+                    'foo',
+                    'bar'
+                ]
+            ]);
+        });
+        it('should be able to iterate over values', async ()=>{
+            await map.set('foo', 'bar');
+            await map.set('baz', 'quux');
+            expect(await values()).toEqual([
+                'quux',
+                'bar'
+            ]);
+        });
+        it('should be able to iterate over keys', async ()=>{
+            await map.set('foo', 'bar');
+            await map.set('baz', 'qux');
+            expect(await keys()).toEqual([
+                'baz',
+                'foo'
+            ]);
+        });
+        it('should be able to iterate over string keys that represent numbers', async ()=>{
+            await map.set('0x22', 'bar');
+            await map.set('0x31', 'qux');
+            expect(await keys()).toEqual([
+                '0x22',
+                '0x31'
+            ]);
+        });
+        for (const [name, data] of [
+            [
+                'chars',
+                [
+                    'a',
+                    'b',
+                    'c',
+                    'd'
+                ]
+            ],
+            [
+                'numbers',
+                [
+                    1,
+                    2,
+                    3,
+                    4
+                ]
+            ],
+            [
+                'negative numbers',
+                [
+                    -4,
+                    -3,
+                    -2,
+                    -1
+                ]
+            ],
+            [
+                'strings',
+                [
+                    'aaa',
+                    'bbb',
+                    'ccc',
+                    'ddd'
+                ]
+            ],
+            [
+                'zero-based numbers',
+                [
+                    0,
+                    1,
+                    2,
+                    3
+                ]
+            ],
+            [
+                'large numbers',
+                [
+                    100,
+                    999,
+                    1000,
+                    1001
+                ]
+            ],
+            [
+                'mixed negative and positive',
+                [
+                    -1000,
+                    -1,
+                    1,
+                    1000
+                ]
+            ]
+        ]){
+            it(`supports range queries over ${name} keys`, async ()=>{
+                const [a, b, c, d] = data;
+                await map.set(a, 'a');
+                await map.set(b, 'b');
+                await map.set(c, 'c');
+                await map.set(d, 'd');
+                expect(await keys()).toEqual([
+                    a,
+                    b,
+                    c,
+                    d
+                ]);
+                expect(await keys({
+                    start: b,
+                    end: c
+                })).toEqual([
+                    b
+                ]);
+                expect(await keys({
+                    start: b
+                })).toEqual([
+                    b,
+                    c,
+                    d
+                ]);
+                expect(await keys({
+                    end: c
+                })).toEqual([
+                    a,
+                    b
+                ]);
+                expect(await keys({
+                    start: b,
+                    end: c,
+                    reverse: true
+                })).toEqual([
+                    c
+                ]);
+                expect(await keys({
+                    start: b,
+                    limit: 1
+                })).toEqual([
+                    b
+                ]);
+                expect(await keys({
+                    start: b,
+                    reverse: true
+                })).toEqual([
+                    d,
+                    c
+                ]);
+                expect(await keys({
+                    end: b,
+                    reverse: true
+                })).toEqual([
+                    b,
+                    a
+                ]);
+            });
+        }
+    });
+}

package/dest/interfaces/multi_map.d.ts

@@ -0,0 +1,41 @@
+import type { Key, Value } from './common.js';
+import type { AztecAsyncMap, AztecMap } from './map.js';
+/**
+ * A map backed by a persistent store that can have multiple values for a single key.
+ */
+export interface AztecMultiMap<K extends Key, V extends Value> extends AztecMap<K, V> {
+    /**
+     * Gets all the values at the given key.
+     * @param key - The key to get the values from
+     */
+    getValues(key: K): IterableIterator<V>;
+    /**
+     * Deletes a specific value at the given key.
+     * @param key - The key to delete the value at
+     * @param val - The value to delete
+     */
+    deleteValue(key: K, val: V): Promise<void>;
+}
+/**
+ * A map backed by a persistent store that can have multiple values for a single key.
+ */
+export interface AztecAsyncMultiMap<K extends Key, V extends Value> extends AztecAsyncMap<K, V> {
+    /**
+     * Gets all the values at the given key.
+     * @param key - The key to get the values from
+     */
+    getValuesAsync(key: K): AsyncIterableIterator<V>;
+    /**
+     * Gets the number of values at the given key.
+     * @param key - The key to get the number of values from
+     * @returns The number of values at the given key
+     */
+    getValueCountAsync(key: K): Promise<number>;
+    /**
+     * Deletes a specific value at the given key.
+     * @param key - The key to delete the value at
+     * @param val - The value to delete
+     */
+    deleteValue(key: K, val: V): Promise<void>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXVsdGlfbWFwLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9tdWx0aV9tYXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUM5QyxPQUFPLEtBQUssRUFBRSxhQUFhLEVBQUUsUUFBUSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBRXhEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLGFBQWEsQ0FBQyxDQUFDLFNBQVMsR0FBRyxFQUFFLENBQUMsU0FBUyxLQUFLLENBQUUsU0FBUSxRQUFRLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNuRjs7O09BR0c7SUFDSCxTQUFTLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUV2Qzs7OztPQUlHO0lBQ0gsV0FBVyxDQUFDLEdBQUcsRUFBRSxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUMsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7Q0FDNUM7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxrQkFBa0IsQ0FBQyxDQUFDLFNBQVMsR0FBRyxFQUFFLENBQUMsU0FBUyxLQUFLLENBQUUsU0FBUSxhQUFhLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUM3Rjs7O09BR0c7SUFDSCxjQUFjLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUVqRDs7OztPQUlHO0lBQ0gsa0JBQWtCLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7SUFFNUM7Ozs7T0FJRztJQUNILFdBQVcsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFDLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0NBQzVDIn0=

package/dest/interfaces/multi_map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi_map.d.ts","sourceRoot":"","sources":["../../src/interfaces/multi_map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,CAAE,SAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACnF;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEvC;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,CAAE,SAAQ,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7F;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5C;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}

package/dest/interfaces/multi_map.js

@@ -0,0 +1,3 @@
+/**
+ * A map backed by a persistent store that can have multiple values for a single key.
+ */ export { };

package/dest/interfaces/multi_map_test_suite.d.ts

@@ -0,0 +1,3 @@
+import type { AztecAsyncKVStore, AztecKVStore } from './store.js';
+export declare function describeAztecMultiMap(testName: string, getStore: () => AztecKVStore | Promise<AztecAsyncKVStore>, forceAsync?: boolean): void;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXVsdGlfbWFwX3Rlc3Rfc3VpdGUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcmZhY2VzL211bHRpX21hcF90ZXN0X3N1aXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUlBLE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLFlBQVksRUFBRSxNQUFNLFlBQVksQ0FBQztBQUdsRSx3QkFBZ0IscUJBQXFCLENBQ25DLFFBQVEsRUFBRSxNQUFNLEVBQ2hCLFFBQVEsRUFBRSxNQUFNLFlBQVksR0FBRyxPQUFPLENBQUMsaUJBQWlCLENBQUMsRUFDekQsVUFBVSxHQUFFLE9BQWUsUUF5VzVCIn0=

package/dest/interfaces/multi_map_test_suite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi_map_test_suite.d.ts","sourceRoot":"","sources":["../../src/interfaces/multi_map_test_suite.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAGlE,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,EACzD,UAAU,GAAE,OAAe,QAyW5B"}