@aztec/kv-store 0.0.0-test.1 → 0.0.1-commit.5daedc8

package/src/interfaces/array.ts

@@ -1,7 +1,9 @@
+import type { Value } from './common.js';
+
 /**
  * An array backed by a persistent store. Can not have any holes in it.
  */
-interface BaseAztecArray<T> {
+interface BaseAztecArray<T extends Value> {
   /**
    * Pushes values to the end of the array
    * @param vals - The values to push to the end of the array
@@ -27,7 +29,7 @@ interface BaseAztecArray<T> {
 /**
  * An array backed by a persistent store. Can not have any holes in it.
  */
-export interface AztecAsyncArray<T> extends BaseAztecArray<T> {
+export interface AztecAsyncArray<T extends Value> extends BaseAztecArray<T> {
   /**
    * The size of the array
    */
@@ -58,7 +60,7 @@ export interface AztecAsyncArray<T> extends BaseAztecArray<T> {
   [Symbol.asyncIterator](): AsyncIterableIterator<T>;
 }
 
-export interface AztecArray<T> extends BaseAztecArray<T> {
+export interface AztecArray<T extends Value> extends BaseAztecArray<T> {
   /**
    * The size of the array
    */

package/src/interfaces/common.ts

@@ -1,12 +1,10 @@
-/**
- * The key type for use with the kv-store
- */
-export type Key = string | number | Array<string | number>;
+/** The key type for use with the kv-store */
+export type Key = string | number | Uint8Array | Array<string | number>;
 
-/**
- * A range of keys to iterate over.
- */
-export type Range<K extends Key = Key> = {
+export type Value = NonNullable<any>;
+
+/** A range of keys of arbitrary type. */
+export type CustomRange<K> = {
   /** The key of the first item to include */
   start?: K;
   /** The key of the last item to include */
@@ -17,4 +15,17 @@ export type Range<K extends Key = Key> = {
   limit?: number;
 };
 
-export type StoreSize = { mappingSize: number; actualSize: number; numItems: number };
+/** Maps a custom range into a range of valid key types to iterate over. */
+export function mapRange<CK, K extends Key = Key>(range: CustomRange<CK>, mapFn: (key: CK) => K): Range<K> {
+  return {
+    start: range.start ? mapFn(range.start) : undefined,
+    end: range.end ? mapFn(range.end) : undefined,
+    reverse: range.reverse,
+    limit: range.limit,
+  };
+}
+
+/** A range of keys to iterate over. */
+export type Range<K extends Key = Key> = CustomRange<K>;
+
+export type StoreSize = { mappingSize: number; physicalFileSize: number; actualSize: number; numItems: number };

package/src/interfaces/index.ts

@@ -4,4 +4,6 @@ export * from './counter.js';
 export * from './singleton.js';
 export * from './store.js';
 export * from './set.js';
-export type { Range, StoreSize } from './common.js';
+export * from './multi_map.js';
+export { mapRange } from './common.js';
+export type { CustomRange, Range, StoreSize } from './common.js';

package/src/interfaces/map.ts

@@ -1,9 +1,9 @@
-import type { Key, Range } from './common.js';
+import type { Key, Range, Value } from './common.js';
 
 /**
  * A map backed by a persistent store.
  */
-interface AztecBaseMap<K extends Key, V> {
+interface AztecBaseMap<K extends Key, V extends Value> {
   /**
    * Sets the value at the given key.
    * @param key - The key to set the value at
@@ -11,6 +11,12 @@ interface AztecBaseMap<K extends Key, V> {
    */
   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
@@ -24,13 +30,19 @@ interface AztecBaseMap<K extends Key, V> {
    */
   delete(key: K): Promise<void>;
 }
-export interface AztecMap<K extends Key, V> extends AztecBaseMap<K, V> {
+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
@@ -62,44 +74,10 @@ export interface AztecMap<K extends Key, V> extends AztecBaseMap<K, V> {
   clear(): Promise<void>;
 }
 
-export interface AztecMapWithSize<K extends Key, V> extends AztecMap<K, V> {
-  /**
-   * Gets the size of the map.
-   * @returns The size of the map
-   */
-  size(): number;
-}
-
-/**
- * A map backed by a persistent store that can have multiple values for a single key.
- */
-export interface AztecMultiMap<K extends Key, V> 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>;
-}
-
-export interface AztecMultiMapWithSize<K extends Key, V> extends AztecMultiMap<K, V> {
-  /**
-   * Gets the size of the map.
-   * @returns The size of the map
-   */
-  size(): number;
-}
-
 /**
  * A map backed by a persistent store.
  */
-export interface AztecAsyncMap<K extends Key, V> extends AztecBaseMap<K, V> {
+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
@@ -130,22 +108,10 @@ export interface AztecAsyncMap<K extends Key, V> extends AztecBaseMap<K, V> {
    * @param range - The range of keys to iterate over
    */
   keysAsync(range?: Range<K>): AsyncIterableIterator<K>;
-}
 
-/**
- * A map backed by a persistent store that can have multiple values for a single key.
- */
-export interface AztecAsyncMultiMap<K extends Key, V> 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>;
-
-  /**
-   * Deletes a specific value at the given key.
-   * @param key - The key to delete the value at
-   * @param val - The value to delete
+   * Gets the current size of the map.
+   * @returns The size of the map
    */
-  deleteValue(key: K, val: V): Promise<void>;
+  sizeAsync(): Promise<number>;
 }

package/src/interfaces/map_test_suite.ts

@@ -3,7 +3,7 @@ import { toArray } from '@aztec/foundation/iterable';
 import { expect } from 'chai';
 
 import type { Key, Range } from './common.js';
-import type { AztecAsyncMap, AztecAsyncMultiMap, AztecMap, AztecMultiMap } from './map.js';
+import type { AztecAsyncMap, AztecMap } from './map.js';
 import type { AztecAsyncKVStore, AztecKVStore } from './store.js';
 import { isSyncStore } from './utils.js';
 
@@ -14,11 +14,11 @@ export function describeAztecMap(
 ) {
   describe(testName, () => {
     let store: AztecKVStore | AztecAsyncKVStore;
-    let map: AztecMultiMap<Key, string> | AztecAsyncMultiMap<Key, string>;
+    let map: AztecMap<Key, string> | AztecAsyncMap<Key, string>;
 
     beforeEach(async () => {
       store = await getStore();
-      map = store.openMultiMap<string, string>('test');
+      map = store.openMap<string, string>('test');
     });
 
     afterEach(async () => {
@@ -27,32 +27,32 @@ export function describeAztecMap(
 
     async function get(key: Key, sut: AztecAsyncMap<any, any> | AztecMap<any, any> = map) {
       return isSyncStore(store) && !forceAsync
-        ? (sut as AztecMultiMap<any, any>).get(key)
-        : await (sut as AztecAsyncMultiMap<any, any>).getAsync(key);
+        ? (sut as AztecMap<any, any>).get(key)
+        : await (sut as AztecAsyncMap<any, any>).getAsync(key);
     }
 
-    async function entries() {
+    async function size(sut: AztecAsyncMap<any, any> | AztecMap<any, any> = map) {
       return isSyncStore(store) && !forceAsync
-        ? await toArray((map as AztecMultiMap<any, any>).entries())
-        : await toArray((map as AztecAsyncMultiMap<any, any>).entriesAsync());
+        ? (sut as AztecMap<any, any>).size()
+        : await (sut as AztecAsyncMap<any, any>).sizeAsync();
     }
 
-    async function values() {
+    async function entries() {
       return isSyncStore(store) && !forceAsync
-        ? await toArray((map as AztecMultiMap<any, any>).values())
-        : await toArray((map as AztecAsyncMultiMap<any, any>).valuesAsync());
+        ? await toArray((map as AztecMap<any, any>).entries())
+        : await toArray((map as AztecAsyncMap<any, any>).entriesAsync());
     }
 
-    async function keys(range?: Range<Key>, sut: AztecAsyncMap<any, any> | AztecMap<any, any> = map) {
+    async function values() {
       return isSyncStore(store) && !forceAsync
-        ? await toArray((sut as AztecMultiMap<any, any>).keys(range))
-        : await toArray((sut as AztecAsyncMultiMap<any, any>).keysAsync(range));
+        ? await toArray((map as AztecMap<any, any>).values())
+        : await toArray((map as AztecAsyncMap<any, any>).valuesAsync());
     }
 
-    async function getValues(key: Key) {
+    async function keys(range?: Range<Key>, sut: AztecAsyncMap<any, any> | AztecMap<any, any> = map) {
       return isSyncStore(store) && !forceAsync
-        ? await toArray((map as AztecMultiMap<any, any>).getValues(key))
-        : await toArray((map as AztecAsyncMultiMap<any, any>).getValuesAsync(key));
+        ? await toArray((sut as AztecMap<any, any>).keys(range))
+        : await toArray((sut as AztecAsyncMap<any, any>).keysAsync(range));
     }
 
     it('should be able to set and get values', async () => {
@@ -64,6 +64,22 @@ export function describeAztecMap(
       expect(await get('quux')).to.equal(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)).to.equal(value);
+      }
+    });
+
+    it('should be able to overwrite values', async () => {
+      await map.set('foo', 'bar');
+      await map.set('foo', 'baz');
+
+      expect(await get('foo')).to.equal('baz');
+    });
+
     it('should be able to set values if they do not exist', async () => {
       expect(await map.setIfNotExists('foo', 'bar')).to.equal(true);
       expect(await map.setIfNotExists('foo', 'baz')).to.equal(false);
@@ -81,6 +97,16 @@ export function describeAztecMap(
       expect(await get('baz')).to.equal('qux');
     });
 
+    it('should be able to return size of the map', async () => {
+      await map.set('foo', 'bar');
+      expect(await size()).to.equal(1);
+      await map.set('baz', 'qux');
+      expect(await size()).to.equal(2);
+
+      await map.delete('foo');
+      expect(await size()).to.equal(1);
+    });
+
     it('should be able to iterate over entries when there are no keys', async () => {
       expect(await entries()).to.deep.equal([]);
     });
@@ -109,35 +135,38 @@ export function describeAztecMap(
       expect(await keys()).to.deep.equal(['baz', 'foo']);
     });
 
-    it('should be able to get multiple values for a single key', async () => {
-      await map.set('foo', 'bar');
-      await map.set('foo', 'baz');
+    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 getValues('foo')).to.deep.equal(['bar', 'baz']);
+      expect(await keys()).to.deep.equal(['0x22', '0x31']);
     });
 
-    it('should be able to delete individual values for a single key', async () => {
-      await map.set('foo', 'bar');
-      await map.set('foo', 'baz');
-
-      await map.deleteValue('foo', 'bar');
-
-      expect(await getValues('foo')).to.deep.equal(['baz']);
-    });
-
-    it('supports range queries', async () => {
-      await map.set('a', 'a');
-      await map.set('b', 'b');
-      await map.set('c', 'c');
-      await map.set('d', 'd');
-
-      expect(await keys({ start: 'b', end: 'c' })).to.deep.equal(['b']);
-      expect(await keys({ start: 'b' })).to.deep.equal(['b', 'c', 'd']);
-      expect(await keys({ end: 'c' })).to.deep.equal(['a', 'b']);
-      expect(await keys({ start: 'b', end: 'c', reverse: true })).to.deep.equal(['c']);
-      expect(await keys({ start: 'b', limit: 1 })).to.deep.equal(['b']);
-      expect(await keys({ start: 'b', reverse: true })).to.deep.equal(['d', 'c']);
-      expect(await keys({ end: 'b', reverse: true })).to.deep.equal(['b', 'a']);
-    });
+    for (const [name, data] of [
+      ['chars', ['a', 'b', 'c', 'd']],
+      ['numbers', [1, 2, 3, 4]],
+      // disabled because indexeddb sorts lexigographically
+      // ['negative numbers', [-4, -3, -2, -1]],
+      ['strings', ['aaa', 'bbb', 'ccc', 'ddd']],
+      ['zero-based numbers', [0, 1, 2, 3]],
+    ]) {
+      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()).to.deep.equal([a, b, c, d]);
+        expect(await keys({ start: b, end: c })).to.deep.equal([b]);
+        expect(await keys({ start: b })).to.deep.equal([b, c, d]);
+        expect(await keys({ end: c })).to.deep.equal([a, b]);
+        expect(await keys({ start: b, end: c, reverse: true })).to.deep.equal([c]);
+        expect(await keys({ start: b, limit: 1 })).to.deep.equal([b]);
+        expect(await keys({ start: b, reverse: true })).to.deep.equal([d, c]);
+        expect(await keys({ end: b, reverse: true })).to.deep.equal([b, a]);
+      });
+    }
   });
 }

package/src/interfaces/multi_map.ts

@@ -0,0 +1,45 @@
+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>;
+}