@aztec/kv-store 0.0.1-commit.a072138 → 0.0.1-commit.a5db02d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/README.md +10 -1
  2. package/dest/bench/shared_map_bench.d.ts +19 -0
  3. package/dest/bench/shared_map_bench.d.ts.map +1 -0
  4. package/dest/bench/shared_map_bench.js +91 -0
  5. package/dest/deprecated/indexeddb/array.d.ts +22 -0
  6. package/dest/deprecated/indexeddb/array.d.ts.map +1 -0
  7. package/dest/{indexeddb → deprecated/indexeddb}/array.js +18 -6
  8. package/dest/deprecated/indexeddb/index.d.ts +7 -0
  9. package/dest/deprecated/indexeddb/index.d.ts.map +1 -0
  10. package/dest/deprecated/indexeddb/index.js +8 -0
  11. package/dest/deprecated/indexeddb/map.d.ts +38 -0
  12. package/dest/deprecated/indexeddb/map.d.ts.map +1 -0
  13. package/dest/{indexeddb → deprecated/indexeddb}/map.js +23 -13
  14. package/dest/deprecated/indexeddb/multi_map.d.ts +14 -0
  15. package/dest/deprecated/indexeddb/multi_map.d.ts.map +1 -0
  16. package/dest/{indexeddb → deprecated/indexeddb}/multi_map.js +16 -1
  17. package/dest/deprecated/indexeddb/set.d.ts +17 -0
  18. package/dest/deprecated/indexeddb/set.d.ts.map +1 -0
  19. package/dest/deprecated/indexeddb/singleton.d.ts +17 -0
  20. package/dest/deprecated/indexeddb/singleton.d.ts.map +1 -0
  21. package/dest/{indexeddb → deprecated/indexeddb}/singleton.js +3 -1
  22. package/dest/deprecated/indexeddb/store.d.ts +98 -0
  23. package/dest/deprecated/indexeddb/store.d.ts.map +1 -0
  24. package/dest/{indexeddb → deprecated/indexeddb}/store.js +8 -4
  25. package/dest/interfaces/array_test_suite.d.ts +1 -1
  26. package/dest/interfaces/array_test_suite.d.ts.map +1 -1
  27. package/dest/interfaces/array_test_suite.js +33 -34
  28. package/dest/interfaces/index.d.ts +2 -2
  29. package/dest/interfaces/index.d.ts.map +1 -1
  30. package/dest/interfaces/map_test_suite.d.ts +1 -1
  31. package/dest/interfaces/map_test_suite.d.ts.map +1 -1
  32. package/dest/interfaces/map_test_suite.js +74 -29
  33. package/dest/interfaces/multi_map_test_suite.d.ts +1 -1
  34. package/dest/interfaces/multi_map_test_suite.d.ts.map +1 -1
  35. package/dest/interfaces/multi_map_test_suite.js +84 -60
  36. package/dest/interfaces/set_test_suite.d.ts +1 -1
  37. package/dest/interfaces/set_test_suite.d.ts.map +1 -1
  38. package/dest/interfaces/set_test_suite.js +13 -14
  39. package/dest/interfaces/singleton_test_suite.d.ts +1 -1
  40. package/dest/interfaces/singleton_test_suite.d.ts.map +1 -1
  41. package/dest/interfaces/singleton_test_suite.js +6 -7
  42. package/dest/lmdb/index.d.ts +2 -2
  43. package/dest/lmdb/index.d.ts.map +1 -1
  44. package/dest/lmdb/index.js +2 -2
  45. package/dest/lmdb/store.d.ts +3 -3
  46. package/dest/lmdb/store.d.ts.map +1 -1
  47. package/dest/lmdb/store.js +12 -8
  48. package/dest/lmdb-v2/factory.d.ts +30 -4
  49. package/dest/lmdb-v2/factory.d.ts.map +1 -1
  50. package/dest/lmdb-v2/factory.js +62 -10
  51. package/dest/lmdb-v2/read_transaction.js +21 -19
  52. package/dest/lmdb-v2/store.d.ts +2 -2
  53. package/dest/lmdb-v2/store.d.ts.map +1 -1
  54. package/dest/lmdb-v2/store.js +4 -4
  55. package/dest/sqlite-opfs/array.d.ts +21 -0
  56. package/dest/sqlite-opfs/array.d.ts.map +1 -0
  57. package/dest/sqlite-opfs/array.js +128 -0
  58. package/dest/sqlite-opfs/errors.d.ts +27 -0
  59. package/dest/sqlite-opfs/errors.d.ts.map +1 -0
  60. package/dest/sqlite-opfs/errors.js +34 -0
  61. package/dest/sqlite-opfs/index.d.ts +14 -0
  62. package/dest/sqlite-opfs/index.d.ts.map +1 -0
  63. package/dest/sqlite-opfs/index.js +16 -0
  64. package/dest/sqlite-opfs/internal/ordered-binary-browser.d.ts +32 -0
  65. package/dest/sqlite-opfs/internal/ordered-binary-browser.d.ts.map +1 -0
  66. package/dest/sqlite-opfs/internal/ordered-binary-browser.js +448 -0
  67. package/dest/sqlite-opfs/manage.d.ts +20 -0
  68. package/dest/sqlite-opfs/manage.d.ts.map +1 -0
  69. package/dest/sqlite-opfs/manage.js +31 -0
  70. package/dest/sqlite-opfs/map.d.ts +35 -0
  71. package/dest/sqlite-opfs/map.d.ts.map +1 -0
  72. package/dest/sqlite-opfs/map.js +163 -0
  73. package/dest/sqlite-opfs/messages.d.ts +66 -0
  74. package/dest/sqlite-opfs/messages.d.ts.map +1 -0
  75. package/dest/sqlite-opfs/messages.js +5 -0
  76. package/dest/sqlite-opfs/multi_map.d.ts +16 -0
  77. package/dest/sqlite-opfs/multi_map.d.ts.map +1 -0
  78. package/dest/sqlite-opfs/multi_map.js +67 -0
  79. package/dest/sqlite-opfs/set.d.ts +13 -0
  80. package/dest/sqlite-opfs/set.d.ts.map +1 -0
  81. package/dest/sqlite-opfs/set.js +19 -0
  82. package/dest/sqlite-opfs/singleton.d.ts +13 -0
  83. package/dest/sqlite-opfs/singleton.d.ts.map +1 -0
  84. package/dest/sqlite-opfs/singleton.js +48 -0
  85. package/dest/sqlite-opfs/store.d.ts +79 -0
  86. package/dest/sqlite-opfs/store.d.ts.map +1 -0
  87. package/dest/sqlite-opfs/store.js +281 -0
  88. package/dest/sqlite-opfs/worker.d.ts +2 -0
  89. package/dest/sqlite-opfs/worker.d.ts.map +1 -0
  90. package/dest/sqlite-opfs/worker.js +264 -0
  91. package/dest/stores/l2_tips_store.d.ts +7 -13
  92. package/dest/stores/l2_tips_store.d.ts.map +1 -1
  93. package/dest/stores/l2_tips_store.js +24 -43
  94. package/dest/utils.d.ts +1 -1
  95. package/dest/utils.d.ts.map +1 -1
  96. package/dest/utils.js +7 -1
  97. package/package.json +30 -26
  98. package/src/bench/shared_map_bench.ts +111 -0
  99. package/src/{indexeddb → deprecated/indexeddb}/array.ts +6 -6
  100. package/src/deprecated/indexeddb/index.ts +12 -0
  101. package/src/{indexeddb → deprecated/indexeddb}/map.ts +26 -13
  102. package/src/{indexeddb → deprecated/indexeddb}/multi_map.ts +17 -3
  103. package/src/{indexeddb → deprecated/indexeddb}/set.ts +2 -2
  104. package/src/{indexeddb → deprecated/indexeddb}/singleton.ts +3 -3
  105. package/src/{indexeddb → deprecated/indexeddb}/store.ts +23 -15
  106. package/src/interfaces/array_test_suite.ts +33 -35
  107. package/src/interfaces/index.ts +1 -1
  108. package/src/interfaces/map_test_suite.ts +56 -30
  109. package/src/interfaces/multi_map_test_suite.ts +88 -58
  110. package/src/interfaces/set_test_suite.ts +13 -15
  111. package/src/interfaces/singleton_test_suite.ts +6 -8
  112. package/src/lmdb/index.ts +3 -3
  113. package/src/lmdb/store.ts +12 -8
  114. package/src/lmdb-v2/factory.ts +86 -10
  115. package/src/lmdb-v2/read_transaction.ts +23 -23
  116. package/src/lmdb-v2/store.ts +4 -2
  117. package/src/sqlite-opfs/array.ts +124 -0
  118. package/src/sqlite-opfs/errors.ts +44 -0
  119. package/src/sqlite-opfs/index.ts +22 -0
  120. package/src/sqlite-opfs/internal/ordered-binary-browser.js +465 -0
  121. package/src/sqlite-opfs/manage.ts +36 -0
  122. package/src/sqlite-opfs/map.ts +163 -0
  123. package/src/sqlite-opfs/messages.ts +39 -0
  124. package/src/sqlite-opfs/multi_map.ts +74 -0
  125. package/src/sqlite-opfs/set.ts +29 -0
  126. package/src/sqlite-opfs/singleton.ts +48 -0
  127. package/src/sqlite-opfs/store.ts +296 -0
  128. package/src/sqlite-opfs/worker.ts +248 -0
  129. package/src/stores/l2_tips_store.ts +20 -41
  130. package/src/utils.ts +10 -0
  131. package/dest/config.d.ts +0 -17
  132. package/dest/config.d.ts.map +0 -1
  133. package/dest/config.js +0 -26
  134. package/dest/indexeddb/array.d.ts +0 -22
  135. package/dest/indexeddb/array.d.ts.map +0 -1
  136. package/dest/indexeddb/index.d.ts +0 -7
  137. package/dest/indexeddb/index.d.ts.map +0 -1
  138. package/dest/indexeddb/index.js +0 -16
  139. package/dest/indexeddb/map.d.ts +0 -32
  140. package/dest/indexeddb/map.d.ts.map +0 -1
  141. package/dest/indexeddb/multi_map.d.ts +0 -13
  142. package/dest/indexeddb/multi_map.d.ts.map +0 -1
  143. package/dest/indexeddb/set.d.ts +0 -17
  144. package/dest/indexeddb/set.d.ts.map +0 -1
  145. package/dest/indexeddb/singleton.d.ts +0 -17
  146. package/dest/indexeddb/singleton.d.ts.map +0 -1
  147. package/dest/indexeddb/store.d.ts +0 -96
  148. package/dest/indexeddb/store.d.ts.map +0 -1
  149. package/src/config.ts +0 -36
  150. package/src/indexeddb/index.ts +0 -31
  151. /package/dest/{indexeddb → deprecated/indexeddb}/set.js +0 -0
@@ -1,31 +1,26 @@
1
+ import { CheckpointNumber } from '@aztec/foundation/branded-types';
1
2
  import { L2TipsStoreBase } from '@aztec/stdlib/block';
2
- import { PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
3
3
  /**
4
4
  * Persistent implementation of L2 tips store backed by a KV store.
5
5
  * Used by nodes that need to persist chain state across restarts.
6
6
  */ export class L2TipsKVStore extends L2TipsStoreBase {
7
7
  store;
8
8
  l2TipsStore;
9
+ l2TipCheckpointsStore;
9
10
  l2BlockHashesStore;
10
- l2BlockNumberToCheckpointNumberStore;
11
- l2CheckpointStore;
12
- constructor(store, namespace){
13
- super(), this.store = store;
11
+ constructor(store, namespace, initialBlockHash){
12
+ super(initialBlockHash), this.store = store;
14
13
  this.l2TipsStore = store.openMap([
15
14
  namespace,
16
15
  'l2_tips'
17
16
  ].join('_'));
18
- this.l2BlockHashesStore = store.openMap([
19
- namespace,
20
- 'l2_block_hashes'
21
- ].join('_'));
22
- this.l2BlockNumberToCheckpointNumberStore = store.openMap([
17
+ this.l2TipCheckpointsStore = store.openMap([
23
18
  namespace,
24
- 'l2_block_number_to_checkpoint_number'
19
+ 'l2_tip_checkpoints'
25
20
  ].join('_'));
26
- this.l2CheckpointStore = store.openMap([
21
+ this.l2BlockHashesStore = store.openMap([
27
22
  namespace,
28
- 'l2_checkpoint_store'
23
+ 'l2_block_hashes'
29
24
  ].join('_'));
30
25
  }
31
26
  getTip(tag) {
@@ -34,6 +29,22 @@ import { PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
34
29
  setTip(tag, blockNumber) {
35
30
  return this.l2TipsStore.set(tag, blockNumber);
36
31
  }
32
+ async getTipCheckpoint(tag) {
33
+ const stored = await this.l2TipCheckpointsStore.getAsync(tag);
34
+ if (stored === undefined) {
35
+ return undefined;
36
+ }
37
+ return {
38
+ number: CheckpointNumber(stored.number),
39
+ hash: stored.hash
40
+ };
41
+ }
42
+ setTipCheckpoint(tag, checkpoint) {
43
+ return this.l2TipCheckpointsStore.set(tag, {
44
+ number: checkpoint.number,
45
+ hash: checkpoint.hash
46
+ });
47
+ }
37
48
  getStoredBlockHash(blockNumber) {
38
49
  return this.l2BlockHashesStore.getAsync(blockNumber);
39
50
  }
@@ -47,36 +58,6 @@ import { PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
47
58
  await this.l2BlockHashesStore.delete(key);
48
59
  }
49
60
  }
50
- getCheckpointNumberForBlock(blockNumber) {
51
- return this.l2BlockNumberToCheckpointNumberStore.getAsync(blockNumber);
52
- }
53
- setCheckpointNumberForBlock(blockNumber, checkpointNumber) {
54
- return this.l2BlockNumberToCheckpointNumberStore.set(blockNumber, checkpointNumber);
55
- }
56
- async deleteBlockToCheckpointBefore(blockNumber) {
57
- for await (const key of this.l2BlockNumberToCheckpointNumberStore.keysAsync({
58
- end: blockNumber
59
- })){
60
- await this.l2BlockNumberToCheckpointNumberStore.delete(key);
61
- }
62
- }
63
- async getCheckpoint(checkpointNumber) {
64
- const buffer = await this.l2CheckpointStore.getAsync(checkpointNumber);
65
- if (!buffer) {
66
- return undefined;
67
- }
68
- return PublishedCheckpoint.fromBuffer(buffer);
69
- }
70
- saveCheckpointData(checkpoint) {
71
- return this.l2CheckpointStore.set(checkpoint.checkpoint.number, checkpoint.toBuffer());
72
- }
73
- async deleteCheckpointsBefore(checkpointNumber) {
74
- for await (const key of this.l2CheckpointStore.keysAsync({
75
- end: checkpointNumber
76
- })){
77
- await this.l2CheckpointStore.delete(key);
78
- }
79
- }
80
61
  runInTransaction(fn) {
81
62
  return this.store.transactionAsync(fn);
82
63
  }
package/dest/utils.d.ts CHANGED
@@ -12,4 +12,4 @@ import type { AztecAsyncKVStore, AztecKVStore } from './interfaces/store.js';
12
12
  * @returns The store (cleared if necessary)
13
13
  */
14
14
  export declare function initStoreForRollupAndSchemaVersion<T extends AztecKVStore | AztecAsyncKVStore>(store: T, schemaVersion: number | undefined, rollupAddress: EthAddress | undefined, log?: Logger): Promise<T>;
15
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy91dGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFDM0QsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFJcEQsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsWUFBWSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFHN0U7Ozs7Ozs7OztHQVNHO0FBQ0gsd0JBQXNCLGtDQUFrQyxDQUFDLENBQUMsU0FBUyxZQUFZLEdBQUcsaUJBQWlCLEVBQ2pHLEtBQUssRUFBRSxDQUFDLEVBQ1IsYUFBYSxFQUFFLE1BQU0sR0FBRyxTQUFTLEVBQ2pDLGFBQWEsRUFBRSxVQUFVLEdBQUcsU0FBUyxFQUNyQyxHQUFHLENBQUMsRUFBRSxNQUFNLEdBQ1gsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQTJCWiJ9
15
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy91dGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFDM0QsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFJcEQsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsWUFBWSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFHN0U7Ozs7Ozs7OztHQVNHO0FBQ0gsd0JBQXNCLGtDQUFrQyxDQUFDLENBQUMsU0FBUyxZQUFZLEdBQUcsaUJBQWlCLEVBQ2pHLEtBQUssRUFBRSxDQUFDLEVBQ1IsYUFBYSxFQUFFLE1BQU0sR0FBRyxTQUFTLEVBQ2pDLGFBQWEsRUFBRSxVQUFVLEdBQUcsU0FBUyxFQUNyQyxHQUFHLENBQUMsRUFBRSxNQUFNLEdBQ1gsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQXFDWiJ9
@@ -1 +1 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAIpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAG7E;;;;;;;;;GASG;AACH,wBAAsB,kCAAkC,CAAC,CAAC,SAAS,YAAY,GAAG,iBAAiB,EACjG,KAAK,EAAE,CAAC,EACR,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,aAAa,EAAE,UAAU,GAAG,SAAS,EACrC,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,CAAC,CA2BZ"}
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAIpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAG7E;;;;;;;;;GASG;AACH,wBAAsB,kCAAkC,CAAC,CAAC,SAAS,YAAY,GAAG,iBAAiB,EACjG,KAAK,EAAE,CAAC,EACR,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,aAAa,EAAE,UAAU,GAAG,SAAS,EACrC,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,CAAC,CAAC,CAqCZ"}
package/dest/utils.js CHANGED
@@ -17,7 +17,13 @@ import { isSyncStore } from './interfaces/utils.js';
17
17
  // DB version: database schema version + rollup address combined)
18
18
  const dbVersion = store.openSingleton('dbVersion');
19
19
  const storedDatabaseVersion = isSyncStore(store) ? dbVersion.get() : await dbVersion.getAsync();
20
- if (doesStoreNeedToBeCleared(targetDatabaseVersion, storedDatabaseVersion, targetSchemaVersion, targetRollupAddress, log)) {
20
+ // Check if this is an old format store (has rollupAddress singleton but no dbVersion)
21
+ const oldRollupSingleton = store.openSingleton('rollupAddress');
22
+ const hasOldFormat = isSyncStore(store) ? !storedDatabaseVersion && !!oldRollupSingleton.get() : !storedDatabaseVersion && !!await oldRollupSingleton.getAsync();
23
+ if (hasOldFormat || doesStoreNeedToBeCleared(targetDatabaseVersion, storedDatabaseVersion, targetSchemaVersion, targetRollupAddress, log)) {
24
+ if (hasOldFormat) {
25
+ log?.warn('Detected old store format without dbVersion, clearing database');
26
+ }
21
27
  await store.clear();
22
28
  }
23
29
  await dbVersion.set(targetDatabaseVersion.toBuffer().toString('utf-8'));
package/package.json CHANGED
@@ -1,23 +1,34 @@
1
1
  {
2
2
  "name": "@aztec/kv-store",
3
- "version": "0.0.1-commit.a072138",
3
+ "version": "0.0.1-commit.a5db02d",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": "./dest/interfaces/index.js",
7
7
  "./interfaces": "./dest/interfaces/index.js",
8
8
  "./lmdb": "./dest/lmdb/index.js",
9
9
  "./lmdb-v2": "./dest/lmdb-v2/index.js",
10
- "./indexeddb": "./dest/indexeddb/index.js",
11
- "./stores": "./dest/stores/index.js",
12
- "./config": "./dest/config.js"
10
+ "./deprecated/indexeddb": "./dest/deprecated/indexeddb/index.js",
11
+ "./sqlite-opfs": "./dest/sqlite-opfs/index.js",
12
+ "./stores": "./dest/stores/index.js"
13
+ },
14
+ "imports": {
15
+ "#msgpackr": {
16
+ "browser": "msgpackr/index-no-eval",
17
+ "default": "msgpackr"
18
+ },
19
+ "#ordered-binary": {
20
+ "browser": "./dest/sqlite-opfs/internal/ordered-binary-browser.js",
21
+ "default": "ordered-binary"
22
+ }
13
23
  },
14
24
  "scripts": {
15
25
  "build": "yarn clean && ../scripts/tsc.sh",
16
26
  "build:dev": "../scripts/tsc.sh --watch",
17
27
  "clean": "rm -rf ./dest .tsbuildinfo",
18
- "test:node": "NODE_NO_WARNINGS=1 mocha --config ./.mocharc.json",
19
- "test:browser": "wtr --config ./web-test-runner.config.mjs",
20
- "test": "yarn test:node",
28
+ "test:node": "vitest run --project node",
29
+ "test:browser": "bash scripts/run-browser-tests.sh",
30
+ "bench:browser": "VITE_BENCH=1 vitest run --project browser src/bench",
31
+ "test": "vitest run",
21
32
  "test:jest": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
22
33
  },
23
34
  "inherits": [
@@ -25,11 +36,12 @@
25
36
  "./package.local.json"
26
37
  ],
27
38
  "dependencies": {
28
- "@aztec/constants": "0.0.1-commit.a072138",
29
- "@aztec/ethereum": "0.0.1-commit.a072138",
30
- "@aztec/foundation": "0.0.1-commit.a072138",
31
- "@aztec/native": "0.0.1-commit.a072138",
32
- "@aztec/stdlib": "0.0.1-commit.a072138",
39
+ "@aztec/constants": "0.0.1-commit.a5db02d",
40
+ "@aztec/ethereum": "0.0.1-commit.a5db02d",
41
+ "@aztec/foundation": "0.0.1-commit.a5db02d",
42
+ "@aztec/native": "0.0.1-commit.a5db02d",
43
+ "@aztec/sqlite3mc-wasm": "0.0.1-commit.a5db02d",
44
+ "@aztec/stdlib": "0.0.1-commit.a5db02d",
33
45
  "idb": "^8.0.0",
34
46
  "lmdb": "^3.2.0",
35
47
  "msgpackr": "^1.11.2",
@@ -38,25 +50,17 @@
38
50
  },
39
51
  "devDependencies": {
40
52
  "@jest/globals": "^30.0.0",
41
- "@types/chai": "^5.0.1",
42
- "@types/chai-as-promised": "^8.0.1",
43
53
  "@types/jest": "^30.0.0",
44
- "@types/mocha": "^10.0.10",
45
- "@types/mocha-each": "^2.0.4",
46
54
  "@types/node": "^22.15.17",
47
- "@types/sinon": "^17.0.3",
48
55
  "@typescript/native-preview": "7.0.0-dev.20260113.1",
49
- "@web/dev-server-esbuild": "^1.0.3",
50
- "@web/test-runner": "^0.19.0",
51
- "@web/test-runner-playwright": "^0.11.0",
52
- "chai": "^5.1.2",
53
- "chai-as-promised": "^8.0.1",
56
+ "@vitest/browser-playwright": "^4.0.0",
57
+ "buffer": "^6.0.3",
54
58
  "jest": "^30.0.0",
55
- "mocha": "^10.8.2",
56
- "mocha-each": "^2.0.1",
57
- "sinon": "^19.0.2",
59
+ "playwright": "1.49.0",
58
60
  "ts-node": "^10.9.1",
59
- "typescript": "^5.3.3"
61
+ "typescript": "^5.3.3",
62
+ "util": "^0.12.5",
63
+ "vitest": "^4.0.0"
60
64
  },
61
65
  "files": [
62
66
  "dest",
@@ -0,0 +1,111 @@
1
+ import type { Logger } from '@aztec/foundation/log';
2
+ import { Timer } from '@aztec/foundation/timer';
3
+
4
+ import type { Key } from '../interfaces/common.js';
5
+ import type { AztecAsyncMap } from '../interfaces/map.js';
6
+ import type { AztecAsyncKVStore } from '../interfaces/store.js';
7
+
8
+ /** One benchmark measurement. */
9
+ export type BenchResult = {
10
+ /** Benchmark name (includes the backend prefix for disambiguation). */
11
+ name: string;
12
+ value: number;
13
+ unit: 'ms' | 'us';
14
+ };
15
+
16
+ export type BenchReporter = (results: BenchResult[]) => void | Promise<void>;
17
+
18
+ /**
19
+ * Runs the standard Map benchmark suite against any `AztecAsyncKVStore` backend,
20
+ * populates `results`, and calls `reporter` in `afterAll`.
21
+ *
22
+ * Kept free of Node-only deps (`fs`, `path`) so the same runner works under
23
+ * vitest-browser for IndexedDB and SQLite-OPFS.
24
+ */
25
+ export function describeAztecMapBench(
26
+ backendPrefix: string,
27
+ getStore: () => Promise<AztecAsyncKVStore>,
28
+ logger: Logger,
29
+ reporter: BenchReporter,
30
+ ) {
31
+ describe(`${backendPrefix} Map benchmarks`, () => {
32
+ let store: AztecAsyncKVStore;
33
+ let map: AztecAsyncMap<Key, string>;
34
+
35
+ const results: BenchResult[] = [];
36
+
37
+ const generateKeyValuePairs = (count: number, offset = 0) => {
38
+ const keys = Array.from({ length: count }, (_, i) => `key-${i + offset}`);
39
+ const values = Array.from({ length: count }, (_, i) => `value-${i + offset}`);
40
+ return keys.map((key, i) => ({ key, value: values[i] }));
41
+ };
42
+
43
+ const record = (name: string, value: number, unit: BenchResult['unit']) => {
44
+ results.push({ name: `${backendPrefix}/Map/${name}`, value, unit });
45
+ };
46
+
47
+ beforeEach(async () => {
48
+ store = await getStore();
49
+ map = store.openMap<Key, string>('test');
50
+ });
51
+
52
+ afterEach(async () => {
53
+ await store.delete();
54
+ });
55
+
56
+ afterAll(async () => {
57
+ const pretty = results.map(r => `${r.name}: ${r.value.toFixed(2)} ${r.unit}`).join('\n');
58
+ logger.info(`\n${pretty}\n`);
59
+ await reporter(results);
60
+ });
61
+
62
+ it('adds individual values', async () => {
63
+ const pairs = generateKeyValuePairs(1000);
64
+ const timer = new Timer();
65
+ for (const pair of pairs) {
66
+ await map.set(pair.key, pair.value);
67
+ }
68
+ record('Individual insertion', timer.ms() / pairs.length, 'ms');
69
+ });
70
+
71
+ it('adds batched values', async () => {
72
+ const batches = Array.from({ length: 100 }, (_, i) => generateKeyValuePairs(1000, i * 1000));
73
+ const timer = new Timer();
74
+ for (const batch of batches) {
75
+ await map.setMany(batch);
76
+ }
77
+ record(`Batch insertion of ${batches[0].length} items`, timer.ms() / batches.length, 'ms');
78
+ });
79
+
80
+ it('reads individual values', async () => {
81
+ const pairs = generateKeyValuePairs(10000);
82
+ await map.setMany(pairs);
83
+ const timer = new Timer();
84
+ for (const pair of pairs) {
85
+ await map.getAsync(pair.key);
86
+ }
87
+ record('Individual read', (timer.ms() * 1000) / pairs.length, 'us');
88
+ });
89
+
90
+ it('reads via a cursor', async () => {
91
+ const pairs = generateKeyValuePairs(10000);
92
+ await map.setMany(pairs);
93
+ const timer = new Timer();
94
+ for await (const _ of map.entriesAsync()) {
95
+ // consume
96
+ }
97
+ record(`Iterator per item read of ${pairs.length} items`, (timer.ms() * 1000) / pairs.length, 'us');
98
+ });
99
+
100
+ it('reads the size of the map', async () => {
101
+ const numIterations = 1000;
102
+ const pairs = generateKeyValuePairs(10000);
103
+ await map.setMany(pairs);
104
+ const timer = new Timer();
105
+ for (let i = 0; i < numIterations; i++) {
106
+ await map.sizeAsync();
107
+ }
108
+ record(`Read size of ${pairs.length} items`, (timer.ms() * 1000) / numIterations, 'us');
109
+ });
110
+ });
111
+ }
@@ -1,8 +1,8 @@
1
1
  import type { IDBPDatabase, IDBPObjectStore } from 'idb';
2
2
  import { hash } from 'ohash';
3
3
 
4
- import type { AztecAsyncArray } from '../interfaces/array.js';
5
- import type { Value } from '../interfaces/common.js';
4
+ import type { AztecAsyncArray } from '../../interfaces/array.js';
5
+ import type { Value } from '../../interfaces/common.js';
6
6
  import type { AztecIDBSchema } from './store.js';
7
7
 
8
8
  /**
@@ -32,7 +32,7 @@ export class IndexedDBAztecArray<T extends Value> implements AztecAsyncArray<T>
32
32
  return (
33
33
  (await this.db
34
34
  .index('key')
35
- .count(IDBKeyRange.bound([this.#container, this.#name], [this.#container, this.#name]))) ?? 0
35
+ .count(IDBKeyRange.bound([this.#container, [this.#name]], [this.#container, [this.#name]]))) ?? 0
36
36
  );
37
37
  }
38
38
 
@@ -43,7 +43,7 @@ export class IndexedDBAztecArray<T extends Value> implements AztecAsyncArray<T>
43
43
  value: val,
44
44
  hash: hash(val),
45
45
  container: this.#container,
46
- key: this.#name,
46
+ key: [this.#name],
47
47
  keyCount: length + 1,
48
48
  slot: this.#slot(length),
49
49
  });
@@ -91,7 +91,7 @@ export class IndexedDBAztecArray<T extends Value> implements AztecAsyncArray<T>
91
91
  value: val,
92
92
  hash: hash(val),
93
93
  container: this.#container,
94
- key: this.#name,
94
+ key: [this.#name],
95
95
  keyCount: index + 1,
96
96
  slot: this.#slot(index),
97
97
  });
@@ -100,7 +100,7 @@ export class IndexedDBAztecArray<T extends Value> implements AztecAsyncArray<T>
100
100
 
101
101
  async *entriesAsync(): AsyncIterableIterator<[number, T]> {
102
102
  const index = this.db.index('key');
103
- const rangeQuery = IDBKeyRange.bound([this.#container, this.#name], [this.#container, this.#name]);
103
+ const rangeQuery = IDBKeyRange.bound([this.#container, [this.#name]], [this.#container, [this.#name]]);
104
104
  for await (const cursor of index.iterate(rangeQuery)) {
105
105
  yield [cursor.value.keyCount - 1, cursor.value.value] as [number, T];
106
106
  }
@@ -0,0 +1,12 @@
1
+ import { createLogger } from '@aztec/foundation/log';
2
+
3
+ import { AztecIndexedDBStore } from './store.js';
4
+
5
+ export { AztecIndexedDBStore } from './store.js';
6
+
7
+ /**
8
+ * @deprecated The IndexedDB backend is being retired. Use `@aztec/kv-store/sqlite-opfs` instead.
9
+ */
10
+ export function openTmpStore(ephemeral: boolean = false): Promise<AztecIndexedDBStore> {
11
+ return AztecIndexedDBStore.open(createLogger('kv-store:indexeddb'), undefined, ephemeral);
12
+ }
@@ -1,8 +1,8 @@
1
1
  import type { IDBPDatabase, IDBPObjectStore } from 'idb';
2
2
  import { hash } from 'ohash';
3
3
 
4
- import type { Key, Range, Value } from '../interfaces/common.js';
5
- import type { AztecAsyncMap } from '../interfaces/map.js';
4
+ import type { Key, Range, Value } from '../../interfaces/common.js';
5
+ import type { AztecAsyncMap } from '../../interfaces/map.js';
6
6
  import type { AztecIDBSchema } from './store.js';
7
7
 
8
8
  /**
@@ -31,7 +31,7 @@ export class IndexedDBAztecMap<K extends Key, V extends Value> implements AztecA
31
31
 
32
32
  async getAsync(key: K): Promise<V | undefined> {
33
33
  const data = await this.db.get(this.slot(key));
34
- return data?.value as V;
34
+ return data ? this.restoreBuffers(data.value as V) : undefined;
35
35
  }
36
36
 
37
37
  async hasAsync(key: K): Promise<boolean> {
@@ -41,7 +41,7 @@ export class IndexedDBAztecMap<K extends Key, V extends Value> implements AztecA
41
41
 
42
42
  async sizeAsync(): Promise<number> {
43
43
  const index = this.db.index('key');
44
- const rangeQuery = IDBKeyRange.bound([this.container, ''], [this.container, '\uffff']);
44
+ const rangeQuery = IDBKeyRange.bound([this.container], [this.container + '\uffff'], true, true);
45
45
  return await index.count(rangeQuery);
46
46
  }
47
47
 
@@ -80,9 +80,12 @@ export class IndexedDBAztecMap<K extends Key, V extends Value> implements AztecA
80
80
 
81
81
  async *entriesAsync(range: Range<K> = {}): AsyncIterableIterator<[K, V]> {
82
82
  const index = this.db.index('key');
83
+ const startKey = range.start ? this.normalizeKey(range.start) : [];
84
+ const endKey = range.end ? this.normalizeKey(range.end) : ['\uffff'];
85
+
83
86
  const rangeQuery = IDBKeyRange.bound(
84
- [this.container, range.start ? this.normalizeKey(range.start) : ''],
85
- [this.container, range.end ? this.normalizeKey(range.end) : '\uffff'],
87
+ [this.container, startKey],
88
+ [this.container, endKey],
86
89
  !!range.reverse,
87
90
  !range.reverse,
88
91
  );
@@ -91,7 +94,7 @@ export class IndexedDBAztecMap<K extends Key, V extends Value> implements AztecA
91
94
  if (range.limit && count >= range.limit) {
92
95
  return;
93
96
  }
94
- yield [this.#denormalizeKey(cursor.value.key), cursor.value.value] as [K, V];
97
+ yield [this.#denormalizeKey(cursor.value.key), this.restoreBuffers(cursor.value.value as V)] as [K, V];
95
98
  count++;
96
99
  }
97
100
  }
@@ -108,14 +111,24 @@ export class IndexedDBAztecMap<K extends Key, V extends Value> implements AztecA
108
111
  }
109
112
  }
110
113
 
111
- #denormalizeKey(key: string): K {
112
- const denormalizedKey = key.split(',').map(part => (part.startsWith('n_') ? Number(part.slice(2)) : part));
113
- return (denormalizedKey.length > 1 ? denormalizedKey : denormalizedKey[0]) as K;
114
+ /**
115
+ * IndexedDB's structured clone downcasts Buffer (a Node.js subclass of Uint8Array) to plain Uint8Array.
116
+ * This breaks .toString() behavior: Buffer.toString() returns UTF-8, Uint8Array.toString() returns
117
+ * comma-separated decimal bytes. We restore Buffer identity on read so callers get consistent behavior.
118
+ */
119
+ protected restoreBuffers(val: V): V {
120
+ if (val instanceof Uint8Array && !Buffer.isBuffer(val)) {
121
+ return Buffer.from(val) as V;
122
+ }
123
+ return val;
124
+ }
125
+
126
+ #denormalizeKey(key: (string | number | Uint8Array)[]): K {
127
+ return (key.length > 1 ? key : key[0]) as K;
114
128
  }
115
129
 
116
- protected normalizeKey(key: K): string {
117
- const arrayKey = Array.isArray(key) ? key : [key];
118
- return (arrayKey as K[]).map((element: K) => (typeof element === 'number' ? `n_${element}` : element)).join(',');
130
+ protected normalizeKey(key: K): (string | number | Uint8Array)[] {
131
+ return Array.isArray(key) ? key : [key];
119
132
  }
120
133
 
121
134
  protected slot(key: K, index: number = 0): string {
@@ -1,7 +1,7 @@
1
1
  import { hash } from 'ohash';
2
2
 
3
- import type { Key, Value } from '../interfaces/common.js';
4
- import type { AztecAsyncMultiMap } from '../interfaces/multi_map.js';
3
+ import type { Key, Value } from '../../interfaces/common.js';
4
+ import type { AztecAsyncMultiMap } from '../../interfaces/multi_map.js';
5
5
  import { IndexedDBAztecMap } from './map.js';
6
6
 
7
7
  /**
@@ -57,7 +57,7 @@ export class IndexedDBAztecMultiMap<K extends Key, V extends Value>
57
57
  false,
58
58
  );
59
59
  for await (const cursor of index.iterate(rangeQuery)) {
60
- yield cursor.value.value as V;
60
+ yield this.restoreBuffers(cursor.value.value as V);
61
61
  }
62
62
  }
63
63
 
@@ -88,4 +88,18 @@ export class IndexedDBAztecMultiMap<K extends Key, V extends Value>
88
88
  await this.db.delete(fullKey);
89
89
  }
90
90
  }
91
+
92
+ override async delete(key: K): Promise<void> {
93
+ const index = this.db.index('keyCount');
94
+ const rangeQuery = IDBKeyRange.bound(
95
+ [this.container, this.normalizeKey(key), 0],
96
+ [this.container, this.normalizeKey(key), Number.MAX_SAFE_INTEGER],
97
+ false,
98
+ false,
99
+ );
100
+
101
+ for await (const cursor of index.iterate(rangeQuery)) {
102
+ await cursor.delete();
103
+ }
104
+ }
91
105
  }
@@ -1,7 +1,7 @@
1
1
  import type { IDBPDatabase, IDBPObjectStore } from 'idb';
2
2
 
3
- import type { Key, Range } from '../interfaces/common.js';
4
- import type { AztecAsyncSet } from '../interfaces/set.js';
3
+ import type { Key, Range } from '../../interfaces/common.js';
4
+ import type { AztecAsyncSet } from '../../interfaces/set.js';
5
5
  import { IndexedDBAztecMap } from './map.js';
6
6
  import type { AztecIDBSchema } from './store.js';
7
7
 
@@ -1,8 +1,8 @@
1
1
  import type { IDBPDatabase, IDBPObjectStore } from 'idb';
2
2
  import { hash } from 'ohash';
3
3
 
4
- import type { Value } from '../interfaces/common.js';
5
- import type { AztecAsyncSingleton } from '../interfaces/singleton.js';
4
+ import type { Value } from '../../interfaces/common.js';
5
+ import type { AztecAsyncSingleton } from '../../interfaces/singleton.js';
6
6
  import type { AztecIDBSchema } from './store.js';
7
7
 
8
8
  /**
@@ -37,7 +37,7 @@ export class IndexedDBAztecSingleton<T extends Value> implements AztecAsyncSingl
37
37
  const result = await this.db.put({
38
38
  container: this.#container,
39
39
  slot: this.#slot,
40
- key: this.#slot,
40
+ key: [this.#slot],
41
41
  keyCount: 1,
42
42
  value: val,
43
43
  hash: hash(val),
@@ -3,14 +3,14 @@ import { SerialQueue } from '@aztec/foundation/queue';
3
3
 
4
4
  import { type DBSchema, type IDBPDatabase, deleteDB, openDB } from 'idb';
5
5
 
6
- import type { AztecAsyncArray } from '../interfaces/array.js';
7
- import type { Key, StoreSize, Value } from '../interfaces/common.js';
8
- import type { AztecAsyncCounter } from '../interfaces/counter.js';
9
- import type { AztecAsyncMap } from '../interfaces/map.js';
10
- import type { AztecAsyncMultiMap } from '../interfaces/multi_map.js';
11
- import type { AztecAsyncSet } from '../interfaces/set.js';
12
- import type { AztecAsyncSingleton } from '../interfaces/singleton.js';
13
- import type { AztecAsyncKVStore } from '../interfaces/store.js';
6
+ import type { AztecAsyncArray } from '../../interfaces/array.js';
7
+ import type { Key, StoreSize, Value } from '../../interfaces/common.js';
8
+ import type { AztecAsyncCounter } from '../../interfaces/counter.js';
9
+ import type { AztecAsyncMap } from '../../interfaces/map.js';
10
+ import type { AztecAsyncMultiMap } from '../../interfaces/multi_map.js';
11
+ import type { AztecAsyncSet } from '../../interfaces/set.js';
12
+ import type { AztecAsyncSingleton } from '../../interfaces/singleton.js';
13
+ import type { AztecAsyncKVStore } from '../../interfaces/store.js';
14
14
  import { IndexedDBAztecArray } from './array.js';
15
15
  import { IndexedDBAztecMap } from './map.js';
16
16
  import { IndexedDBAztecMultiMap } from './multi_map.js';
@@ -20,7 +20,7 @@ import { IndexedDBAztecSingleton } from './singleton.js';
20
20
  export type StoredData<V extends Value> = {
21
21
  value: V;
22
22
  container: string;
23
- key: string;
23
+ key: (string | number | Uint8Array)[];
24
24
  keyCount: number;
25
25
  slot: string;
26
26
  hash: string;
@@ -30,14 +30,20 @@ export interface AztecIDBSchema extends DBSchema {
30
30
  data: {
31
31
  value: StoredData<any>;
32
32
  key: string;
33
- indexes: { container: string; key: string; keyCount: number; hash: string };
33
+ indexes: {
34
+ container: string;
35
+ key: any; // Runtime: (string | number | Uint8Array)[] - idb types don't support arrays
36
+ keyCount: number;
37
+ hash: string;
38
+ };
34
39
  };
35
40
  }
36
41
 
37
42
  /**
38
43
  * A key-value store backed by IndexedDB.
44
+ *
45
+ * @deprecated The IndexedDB backend is being retired. Use `@aztec/kv-store/sqlite-opfs` instead.
39
46
  */
40
-
41
47
  export class AztecIndexedDBStore implements AztecAsyncKVStore {
42
48
  #rootDB: IDBPDatabase<AztecIDBSchema>;
43
49
  #name: string;
@@ -187,18 +193,20 @@ export class AztecIndexedDBStore implements AztecAsyncKVStore {
187
193
  }
188
194
 
189
195
  /** Deletes this store and removes the database */
190
- delete() {
196
+ async delete() {
191
197
  this.#containers.clear();
198
+ await this.#txQueue.end();
192
199
  this.#rootDB.close();
193
- return deleteDB(this.#name);
200
+ await deleteDB(this.#name);
194
201
  }
195
202
 
196
203
  estimateSize(): Promise<StoreSize> {
197
204
  return Promise.resolve({ mappingSize: 0, physicalFileSize: 0, actualSize: 0, numItems: 0 });
198
205
  }
199
206
 
200
- close(): Promise<void> {
201
- return Promise.resolve();
207
+ async close(): Promise<void> {
208
+ await this.#txQueue.end();
209
+ this.#rootDB.close();
202
210
  }
203
211
 
204
212
  backupTo(_dstPath: string, _compact?: boolean): Promise<void> {