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

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 (130) hide show
  1. package/dest/config.d.ts +1 -1
  2. package/dest/config.d.ts.map +1 -1
  3. package/dest/config.js +5 -3
  4. package/dest/indexeddb/array.d.ts +2 -1
  5. package/dest/indexeddb/array.d.ts.map +1 -1
  6. package/dest/indexeddb/array.js +3 -0
  7. package/dest/indexeddb/index.js +1 -1
  8. package/dest/indexeddb/map.d.ts +11 -5
  9. package/dest/indexeddb/map.d.ts.map +1 -1
  10. package/dest/indexeddb/map.js +38 -60
  11. package/dest/indexeddb/multi_map.d.ts +12 -0
  12. package/dest/indexeddb/multi_map.d.ts.map +1 -0
  13. package/dest/indexeddb/multi_map.js +78 -0
  14. package/dest/indexeddb/singleton.d.ts +2 -1
  15. package/dest/indexeddb/singleton.d.ts.map +1 -1
  16. package/dest/indexeddb/singleton.js +3 -1
  17. package/dest/indexeddb/store.d.ts +12 -13
  18. package/dest/indexeddb/store.d.ts.map +1 -1
  19. package/dest/indexeddb/store.js +45 -42
  20. package/dest/interfaces/array.d.ts +4 -3
  21. package/dest/interfaces/array.d.ts.map +1 -1
  22. package/dest/interfaces/array.js +1 -3
  23. package/dest/interfaces/common.d.ts +10 -8
  24. package/dest/interfaces/common.d.ts.map +1 -1
  25. package/dest/interfaces/common.js +8 -3
  26. package/dest/interfaces/index.d.ts +3 -1
  27. package/dest/interfaces/index.d.ts.map +1 -1
  28. package/dest/interfaces/index.js +2 -0
  29. package/dest/interfaces/map.d.ts +20 -48
  30. package/dest/interfaces/map.d.ts.map +1 -1
  31. package/dest/interfaces/map.js +1 -1
  32. package/dest/interfaces/map_test_suite.d.ts.map +1 -1
  33. package/dest/interfaces/map_test_suite.js +135 -70
  34. package/dest/interfaces/multi_map.d.ts +35 -0
  35. package/dest/interfaces/multi_map.d.ts.map +1 -0
  36. package/dest/interfaces/multi_map.js +3 -0
  37. package/dest/interfaces/multi_map_test_suite.d.ts +3 -0
  38. package/dest/interfaces/multi_map_test_suite.d.ts.map +1 -0
  39. package/dest/interfaces/multi_map_test_suite.js +245 -0
  40. package/dest/interfaces/store.d.ts +17 -42
  41. package/dest/interfaces/store.d.ts.map +1 -1
  42. package/dest/interfaces/utils.d.ts +1 -0
  43. package/dest/interfaces/utils.d.ts.map +1 -1
  44. package/dest/interfaces/utils.js +2 -1
  45. package/dest/lmdb/array.d.ts +2 -1
  46. package/dest/lmdb/array.d.ts.map +1 -1
  47. package/dest/lmdb/index.js +2 -2
  48. package/dest/lmdb/map.d.ts +10 -22
  49. package/dest/lmdb/map.d.ts.map +1 -1
  50. package/dest/lmdb/map.js +15 -81
  51. package/dest/lmdb/multi_map.d.ts +12 -0
  52. package/dest/lmdb/multi_map.d.ts.map +1 -0
  53. package/dest/lmdb/multi_map.js +29 -0
  54. package/dest/lmdb/store.d.ts +7 -22
  55. package/dest/lmdb/store.d.ts.map +1 -1
  56. package/dest/lmdb/store.js +11 -31
  57. package/dest/lmdb-v2/array.d.ts +2 -1
  58. package/dest/lmdb-v2/array.d.ts.map +1 -1
  59. package/dest/lmdb-v2/array.js +1 -0
  60. package/dest/lmdb-v2/factory.d.ts +1 -1
  61. package/dest/lmdb-v2/factory.d.ts.map +1 -1
  62. package/dest/lmdb-v2/factory.js +16 -6
  63. package/dest/lmdb-v2/map.d.ts +10 -43
  64. package/dest/lmdb-v2/map.d.ts.map +1 -1
  65. package/dest/lmdb-v2/map.js +17 -103
  66. package/dest/lmdb-v2/message.d.ts +23 -4
  67. package/dest/lmdb-v2/message.d.ts.map +1 -1
  68. package/dest/lmdb-v2/message.js +6 -4
  69. package/dest/lmdb-v2/multi_map.d.ts +51 -0
  70. package/dest/lmdb-v2/multi_map.d.ts.map +1 -0
  71. package/dest/lmdb-v2/multi_map.js +113 -0
  72. package/dest/lmdb-v2/read_transaction.d.ts +2 -0
  73. package/dest/lmdb-v2/read_transaction.d.ts.map +1 -1
  74. package/dest/lmdb-v2/read_transaction.js +34 -0
  75. package/dest/lmdb-v2/set.d.ts +15 -0
  76. package/dest/lmdb-v2/set.d.ts.map +1 -0
  77. package/dest/lmdb-v2/set.js +23 -0
  78. package/dest/lmdb-v2/singleton.d.ts.map +1 -1
  79. package/dest/lmdb-v2/singleton.js +1 -0
  80. package/dest/lmdb-v2/store.d.ts +9 -8
  81. package/dest/lmdb-v2/store.d.ts.map +1 -1
  82. package/dest/lmdb-v2/store.js +19 -7
  83. package/dest/lmdb-v2/utils.d.ts +2 -4
  84. package/dest/lmdb-v2/utils.d.ts.map +1 -1
  85. package/dest/lmdb-v2/write_transaction.d.ts +2 -4
  86. package/dest/lmdb-v2/write_transaction.d.ts.map +1 -1
  87. package/dest/stores/index.d.ts +1 -0
  88. package/dest/stores/index.d.ts.map +1 -1
  89. package/dest/stores/index.js +1 -0
  90. package/dest/stores/l2_tips_store.d.ts +2 -1
  91. package/dest/stores/l2_tips_store.d.ts.map +1 -1
  92. package/dest/stores/l2_tips_store.js +18 -9
  93. package/package.json +18 -14
  94. package/src/config.ts +6 -4
  95. package/src/indexeddb/array.ts +5 -1
  96. package/src/indexeddb/index.ts +2 -2
  97. package/src/indexeddb/map.ts +35 -53
  98. package/src/indexeddb/multi_map.ts +79 -0
  99. package/src/indexeddb/singleton.ts +4 -1
  100. package/src/indexeddb/store.ts +66 -56
  101. package/src/interfaces/array.ts +5 -3
  102. package/src/interfaces/common.ts +20 -9
  103. package/src/interfaces/index.ts +3 -1
  104. package/src/interfaces/map.ts +19 -53
  105. package/src/interfaces/map_test_suite.ts +73 -44
  106. package/src/interfaces/multi_map.ts +38 -0
  107. package/src/interfaces/multi_map_test_suite.ts +242 -0
  108. package/src/interfaces/store.ts +18 -53
  109. package/src/interfaces/utils.ts +1 -0
  110. package/src/lmdb/array.ts +2 -1
  111. package/src/lmdb/index.ts +3 -3
  112. package/src/lmdb/map.ts +23 -94
  113. package/src/lmdb/multi_map.ts +35 -0
  114. package/src/lmdb/store.ts +23 -47
  115. package/src/lmdb-v2/array.ts +7 -2
  116. package/src/lmdb-v2/factory.ts +17 -10
  117. package/src/lmdb-v2/map.ts +29 -126
  118. package/src/lmdb-v2/message.ts +23 -0
  119. package/src/lmdb-v2/multi_map.ts +141 -0
  120. package/src/lmdb-v2/read_transaction.ts +40 -0
  121. package/src/lmdb-v2/set.ts +33 -0
  122. package/src/lmdb-v2/singleton.ts +5 -1
  123. package/src/lmdb-v2/store.ts +22 -14
  124. package/src/lmdb-v2/write_transaction.ts +2 -2
  125. package/src/stores/index.ts +2 -0
  126. package/src/stores/l2_tips_store.ts +18 -9
  127. package/dest/interfaces/store_test_suite.d.ts +0 -3
  128. package/dest/interfaces/store_test_suite.d.ts.map +0 -1
  129. package/dest/interfaces/store_test_suite.js +0 -37
  130. package/src/interfaces/store_test_suite.ts +0 -56
package/src/lmdb/store.ts CHANGED
@@ -7,22 +7,17 @@ import { tmpdir } from 'os';
7
7
  import { join } from 'path';
8
8
 
9
9
  import type { AztecArray, AztecAsyncArray } from '../interfaces/array.js';
10
- import type { Key, StoreSize } from '../interfaces/common.js';
10
+ import type { Key, StoreSize, Value } from '../interfaces/common.js';
11
11
  import type { AztecAsyncCounter, AztecCounter } from '../interfaces/counter.js';
12
- import type {
13
- AztecAsyncMap,
14
- AztecAsyncMultiMap,
15
- AztecMap,
16
- AztecMapWithSize,
17
- AztecMultiMap,
18
- AztecMultiMapWithSize,
19
- } from '../interfaces/map.js';
12
+ import type { AztecAsyncMap, AztecMap } from '../interfaces/map.js';
13
+ import type { AztecAsyncMultiMap, AztecMultiMap } from '../interfaces/multi_map.js';
20
14
  import type { AztecAsyncSet, AztecSet } from '../interfaces/set.js';
21
15
  import type { AztecAsyncSingleton, AztecSingleton } from '../interfaces/singleton.js';
22
16
  import type { AztecAsyncKVStore, AztecKVStore } from '../interfaces/store.js';
23
17
  import { LmdbAztecArray } from './array.js';
24
18
  import { LmdbAztecCounter } from './counter.js';
25
- import { LmdbAztecMap, LmdbAztecMapWithSize } from './map.js';
19
+ import { LmdbAztecMap } from './map.js';
20
+ import { LmdbAztecMultiMap } from './multi_map.js';
26
21
  import { LmdbAztecSet } from './set.js';
27
22
  import { LmdbAztecSingleton } from './singleton.js';
28
23
 
@@ -37,7 +32,11 @@ export class AztecLmdbStore implements AztecKVStore, AztecAsyncKVStore {
37
32
  #multiMapData: Database<unknown, Key>;
38
33
  #log = createLogger('kv-store:lmdb');
39
34
 
40
- constructor(rootDb: RootDatabase, public readonly isEphemeral: boolean, private path: string) {
35
+ constructor(
36
+ rootDb: RootDatabase,
37
+ public readonly isEphemeral: boolean,
38
+ private path: string,
39
+ ) {
41
40
  this.#rootDb = rootDb;
42
41
 
43
42
  // big bucket to store all the data
@@ -80,27 +79,12 @@ export class AztecLmdbStore implements AztecKVStore, AztecAsyncKVStore {
80
79
  return new AztecLmdbStore(rootDb, ephemeral, dbPath);
81
80
  }
82
81
 
83
- /**
84
- * Forks the current DB into a new DB by backing it up to a temporary location and opening a new lmdb db.
85
- * @returns A new AztecLmdbStore.
86
- */
87
- async fork() {
88
- const baseDir = this.path;
89
- this.#log.debug(`Forking store with basedir ${baseDir}`);
90
- const forkPath = await fs.mkdtemp(join(baseDir, 'aztec-store-fork-'));
91
- this.#log.verbose(`Forking store to ${forkPath}`);
92
- await this.#rootDb.backup(forkPath, false);
93
- const forkDb = open(forkPath, { noSync: this.isEphemeral });
94
- this.#log.debug(`Forked store at ${forkPath} opened successfully`);
95
- return new AztecLmdbStore(forkDb, this.isEphemeral, forkPath);
96
- }
97
-
98
82
  /**
99
83
  * Creates a new AztecMap in the store.
100
84
  * @param name - Name of the map
101
85
  * @returns A new AztecMap
102
86
  */
103
- openMap<K extends Key, V>(name: string): AztecMap<K, V> & AztecAsyncMap<K, V> {
87
+ openMap<K extends Key, V extends Value>(name: string): AztecMap<K, V> & AztecAsyncMap<K, V> {
104
88
  return new LmdbAztecMap(this.#data, name);
105
89
  }
106
90
 
@@ -118,37 +102,20 @@ export class AztecLmdbStore implements AztecKVStore, AztecAsyncKVStore {
118
102
  * @param name - Name of the map
119
103
  * @returns A new AztecMultiMap
120
104
  */
121
- openMultiMap<K extends Key, V>(name: string): AztecMultiMap<K, V> & AztecAsyncMultiMap<K, V> {
122
- return new LmdbAztecMap(this.#multiMapData, name);
105
+ openMultiMap<K extends Key, V extends Value>(name: string): AztecMultiMap<K, V> & AztecAsyncMultiMap<K, V> {
106
+ return new LmdbAztecMultiMap(this.#multiMapData, name);
123
107
  }
124
108
 
125
109
  openCounter<K extends Key>(name: string): AztecCounter<K> & AztecAsyncCounter<K> {
126
110
  return new LmdbAztecCounter(this.#data, name);
127
111
  }
128
- /**
129
- * Creates a new AztecMultiMapWithSize in the store. A multi-map with size stores multiple values for a single key automatically.
130
- * @param name - Name of the map
131
- * @returns A new AztecMultiMapWithSize
132
- */
133
- openMultiMapWithSize<K extends Key, V>(name: string): AztecMultiMapWithSize<K, V> {
134
- return new LmdbAztecMapWithSize(this.#multiMapData, name);
135
- }
136
-
137
- /**
138
- * Creates a new AztecMapWithSize in the store.
139
- * @param name - Name of the map
140
- * @returns A new AztecMapWithSize
141
- */
142
- openMapWithSize<K extends Key, V>(name: string): AztecMapWithSize<K, V> {
143
- return new LmdbAztecMapWithSize(this.#data, name);
144
- }
145
112
 
146
113
  /**
147
114
  * Creates a new AztecArray in the store.
148
115
  * @param name - Name of the array
149
116
  * @returns A new AztecArray
150
117
  */
151
- openArray<T>(name: string): AztecArray<T> & AztecAsyncArray<T> {
118
+ openArray<T extends Value>(name: string): AztecArray<T> & AztecAsyncArray<T> {
152
119
  return new LmdbAztecArray(this.#data, name);
153
120
  }
154
121
 
@@ -224,10 +191,15 @@ export class AztecLmdbStore implements AztecKVStore, AztecAsyncKVStore {
224
191
  if ('mapSize' in stats && typeof stats.mapSize === 'number') {
225
192
  mapSize = stats.mapSize;
226
193
  }
194
+ let physicalFileSize = 0;
195
+ if ('physicalFileSize' in stats && typeof stats.physicalFileSize === 'number') {
196
+ physicalFileSize = stats.physicalFileSize;
197
+ }
227
198
  const dataResult = this.estimateSubDBSize(this.#data);
228
199
  const multiResult = this.estimateSubDBSize(this.#multiMapData);
229
200
  return Promise.resolve({
230
201
  mappingSize: mapSize,
202
+ physicalFileSize: physicalFileSize,
231
203
  actualSize: dataResult.actualSize + multiResult.actualSize,
232
204
  numItems: dataResult.numItems + multiResult.numItems,
233
205
  });
@@ -260,4 +232,8 @@ export class AztecLmdbStore implements AztecKVStore, AztecAsyncKVStore {
260
232
  }
261
233
  return { actualSize, numItems };
262
234
  }
235
+
236
+ backupTo(_dstPath: string, _compact?: boolean): Promise<void> {
237
+ throw new Error('Method not implemented.');
238
+ }
263
239
  }
@@ -1,17 +1,22 @@
1
1
  import { Encoder } from 'msgpackr/pack';
2
2
 
3
3
  import type { AztecAsyncArray } from '../interfaces/array.js';
4
+ import type { Value } from '../interfaces/common.js';
4
5
  import type { AztecAsyncSingleton } from '../interfaces/singleton.js';
5
6
  import type { ReadTransaction } from './read_transaction.js';
7
+ // eslint-disable-next-line import/no-cycle
6
8
  import { AztecLMDBStoreV2, execInReadTx, execInWriteTx } from './store.js';
7
9
  import { deserializeKey, serializeKey } from './utils.js';
8
10
 
9
- export class LMDBArray<T> implements AztecAsyncArray<T> {
11
+ export class LMDBArray<T extends Value> implements AztecAsyncArray<T> {
10
12
  private length: AztecAsyncSingleton<number>;
11
13
  private encoder = new Encoder();
12
14
  private prefix: string;
13
15
 
14
- constructor(private store: AztecLMDBStoreV2, name: string) {
16
+ constructor(
17
+ private store: AztecLMDBStoreV2,
18
+ name: string,
19
+ ) {
15
20
  this.length = store.openSingleton(name + ':length');
16
21
  this.prefix = `array:${name}`;
17
22
  }
@@ -28,16 +28,20 @@ export async function createStore(
28
28
  const rollupAddress = l1Contracts ? l1Contracts.rollupAddress : EthAddress.ZERO;
29
29
 
30
30
  // Create a version manager
31
- const versionManager = new DatabaseVersionManager(schemaVersion, rollupAddress, subDir, dbDirectory =>
32
- AztecLMDBStoreV2.new(dbDirectory, config.dataStoreMapSizeKB, MAX_READERS, () => Promise.resolve(), log),
33
- );
31
+ const versionManager = new DatabaseVersionManager({
32
+ schemaVersion,
33
+ rollupAddress,
34
+ dataDirectory: subDir,
35
+ onOpen: dbDirectory =>
36
+ AztecLMDBStoreV2.new(dbDirectory, config.dataStoreMapSizeKb, MAX_READERS, () => Promise.resolve(), log),
37
+ });
34
38
 
35
39
  log.info(
36
- `Creating ${name} data store at directory ${subDir} with map size ${config.dataStoreMapSizeKB} KB (LMDB v2)`,
40
+ `Creating ${name} data store at directory ${subDir} with map size ${config.dataStoreMapSizeKb} KB (LMDB v2)`,
37
41
  );
38
42
  [store] = await versionManager.open();
39
43
  } else {
40
- store = await openTmpStore(name, true, config.dataStoreMapSizeKB, MAX_READERS, log);
44
+ store = await openTmpStore(name, true, config.dataStoreMapSizeKb, MAX_READERS, log);
41
45
  }
42
46
 
43
47
  return store;
@@ -83,16 +87,19 @@ export async function openStoreAt(
83
87
  }
84
88
 
85
89
  export async function openVersionedStoreAt(
86
- dataDir: string,
90
+ dataDirectory: string,
87
91
  schemaVersion: number,
88
92
  rollupAddress: EthAddress,
89
93
  dbMapSizeKb = 10 * 1_024 * 1_024, // 10GB
90
94
  maxReaders = MAX_READERS,
91
95
  log: Logger = createLogger('kv-store:lmdb-v2'),
92
96
  ): Promise<AztecLMDBStoreV2> {
93
- log.debug(`Opening data store at: ${dataDir} with size: ${dbMapSizeKb} KB (LMDB v2)`);
94
- const [store] = await new DatabaseVersionManager(schemaVersion, rollupAddress, dataDir, dataDir =>
95
- AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log),
96
- ).open();
97
+ log.debug(`Opening data store at: ${dataDirectory} with size: ${dbMapSizeKb} KB (LMDB v2)`);
98
+ const [store] = await new DatabaseVersionManager({
99
+ schemaVersion,
100
+ rollupAddress,
101
+ dataDirectory,
102
+ onOpen: dataDir => AztecLMDBStoreV2.new(dataDir, dbMapSizeKb, maxReaders, undefined, log),
103
+ }).open();
97
104
  return store;
98
105
  }
@@ -1,16 +1,20 @@
1
1
  import { Encoder } from 'msgpackr';
2
2
 
3
- import type { Key, Range } from '../interfaces/common.js';
4
- import type { AztecAsyncMap, AztecAsyncMultiMap } from '../interfaces/map.js';
3
+ import type { Key, Range, Value } from '../interfaces/common.js';
4
+ import type { AztecAsyncMap } from '../interfaces/map.js';
5
5
  import type { ReadTransaction } from './read_transaction.js';
6
+ // eslint-disable-next-line import/no-cycle
6
7
  import { type AztecLMDBStoreV2, execInReadTx, execInWriteTx } from './store.js';
7
8
  import { deserializeKey, maxKey, minKey, serializeKey } from './utils.js';
8
9
 
9
- export class LMDBMap<K extends Key, V> implements AztecAsyncMap<K, V> {
10
+ export class LMDBMap<K extends Key, V extends Value> implements AztecAsyncMap<K, V> {
10
11
  private prefix: string;
11
12
  private encoder = new Encoder();
12
13
 
13
- constructor(private store: AztecLMDBStoreV2, name: string) {
14
+ constructor(
15
+ private store: AztecLMDBStoreV2,
16
+ name: string,
17
+ ) {
14
18
  this.prefix = `map:${name}`;
15
19
  }
16
20
  /**
@@ -22,6 +26,18 @@ export class LMDBMap<K extends Key, V> implements AztecAsyncMap<K, V> {
22
26
  return execInWriteTx(this.store, tx => tx.set(serializeKey(this.prefix, key), this.encoder.pack(val)));
23
27
  }
24
28
 
29
+ /**
30
+ * Sets the values at the given keys.
31
+ * @param entries - The entries to set
32
+ */
33
+ async setMany(entries: { key: K; value: V }[]): Promise<void> {
34
+ await execInWriteTx(this.store, async tx => {
35
+ for (const { key, value } of entries) {
36
+ await tx.set(serializeKey(this.prefix, key), this.encoder.pack(value));
37
+ }
38
+ });
39
+ }
40
+
25
41
  /**
26
42
  * Sets the value at the given key if it does not already exist.
27
43
  * @param key - The key to set the value at
@@ -58,15 +74,21 @@ export class LMDBMap<K extends Key, V> implements AztecAsyncMap<K, V> {
58
74
  return execInReadTx(this.store, async tx => !!(await tx.get(serializeKey(this.prefix, key))));
59
75
  }
60
76
 
77
+ sizeAsync(): Promise<number> {
78
+ return execInReadTx(this.store, tx => tx.countEntries(minKey(this.prefix), maxKey(this.prefix), false));
79
+ }
80
+
61
81
  /**
62
82
  * Iterates over the map's key-value entries in the key's natural order
63
83
  * @param range - The range of keys to iterate over
64
84
  */
65
85
  async *entriesAsync(range?: Range<K>): AsyncIterableIterator<[K, V]> {
66
86
  const reverse = range?.reverse ?? false;
67
- const startKey = range?.start ? serializeKey(this.prefix, range.start) : minKey(this.prefix);
68
87
 
69
- const endKey = range?.end ? serializeKey(this.prefix, range.end) : reverse ? maxKey(this.prefix) : undefined;
88
+ const startKey = range?.start !== undefined ? serializeKey(this.prefix, range.start) : minKey(this.prefix);
89
+
90
+ const endKey =
91
+ range?.end !== undefined ? serializeKey(this.prefix, range.end) : reverse ? maxKey(this.prefix) : undefined;
70
92
 
71
93
  let tx: ReadTransaction | undefined = this.store.getCurrentWriteTx();
72
94
  const shouldClose = !tx;
@@ -80,7 +102,7 @@ export class LMDBMap<K extends Key, V> implements AztecAsyncMap<K, V> {
80
102
  range?.limit,
81
103
  )) {
82
104
  const deserializedKey = deserializeKey<K>(this.prefix, key);
83
- if (!deserializedKey) {
105
+ if (deserializedKey === false) {
84
106
  break;
85
107
  }
86
108
  yield [deserializedKey, this.encoder.unpack(val)];
@@ -112,122 +134,3 @@ export class LMDBMap<K extends Key, V> implements AztecAsyncMap<K, V> {
112
134
  }
113
135
  }
114
136
  }
115
-
116
- export class LMDBMultiMap<K extends Key, V> implements AztecAsyncMultiMap<K, V> {
117
- private prefix: string;
118
- private encoder = new Encoder();
119
- constructor(private store: AztecLMDBStoreV2, name: string) {
120
- this.prefix = `multimap:${name}`;
121
- }
122
-
123
- /**
124
- * Sets the value at the given key.
125
- * @param key - The key to set the value at
126
- * @param val - The value to set
127
- */
128
- set(key: K, val: V): Promise<void> {
129
- return execInWriteTx(this.store, tx => tx.setIndex(serializeKey(this.prefix, key), this.encoder.pack(val)));
130
- }
131
-
132
- /**
133
- * Sets the value at the given key if it does not already exist.
134
- * @param key - The key to set the value at
135
- * @param val - The value to set
136
- */
137
- setIfNotExists(key: K, val: V): Promise<boolean> {
138
- return execInWriteTx(this.store, async tx => {
139
- const exists = !!(await this.getAsync(key));
140
- if (!exists) {
141
- await tx.setIndex(serializeKey(this.prefix, key), this.encoder.pack(val));
142
- return true;
143
- }
144
- return false;
145
- });
146
- }
147
-
148
- /**
149
- * Deletes the value at the given key.
150
- * @param key - The key to delete the value at
151
- */
152
- delete(key: K): Promise<void> {
153
- return execInWriteTx(this.store, tx => tx.removeIndex(serializeKey(this.prefix, key)));
154
- }
155
-
156
- getAsync(key: K): Promise<V | undefined> {
157
- return execInReadTx(this.store, async tx => {
158
- const val = await tx.getIndex(serializeKey(this.prefix, key));
159
- return val.length > 0 ? this.encoder.unpack(val[0]) : undefined;
160
- });
161
- }
162
-
163
- hasAsync(key: K): Promise<boolean> {
164
- return execInReadTx(this.store, async tx => (await tx.getIndex(serializeKey(this.prefix, key))).length > 0);
165
- }
166
-
167
- /**
168
- * Iterates over the map's key-value entries in the key's natural order
169
- * @param range - The range of keys to iterate over
170
- */
171
- async *entriesAsync(range?: Range<K>): AsyncIterableIterator<[K, V]> {
172
- const reverse = range?.reverse ?? false;
173
- const startKey = range?.start ? serializeKey(this.prefix, range.start) : minKey(this.prefix);
174
- const endKey = range?.end ? serializeKey(this.prefix, range.end) : reverse ? maxKey(this.prefix) : undefined;
175
-
176
- let tx: ReadTransaction | undefined = this.store.getCurrentWriteTx();
177
- const shouldClose = !tx;
178
- tx ??= this.store.getReadTx();
179
-
180
- try {
181
- for await (const [key, vals] of tx.iterateIndex(
182
- reverse ? endKey! : startKey,
183
- reverse ? startKey : endKey,
184
- reverse,
185
- range?.limit,
186
- )) {
187
- const deserializedKey = deserializeKey<K>(this.prefix, key);
188
- if (!deserializedKey) {
189
- break;
190
- }
191
-
192
- for (const val of vals) {
193
- yield [deserializedKey, this.encoder.unpack(val)];
194
- }
195
- }
196
- } finally {
197
- if (shouldClose) {
198
- tx.close();
199
- }
200
- }
201
- }
202
-
203
- /**
204
- * Iterates over the map's values in the key's natural order
205
- * @param range - The range of keys to iterate over
206
- */
207
- async *valuesAsync(range?: Range<K>): AsyncIterableIterator<V> {
208
- for await (const [_, value] of this.entriesAsync(range)) {
209
- yield value;
210
- }
211
- }
212
-
213
- /**
214
- * Iterates over the map's keys in the key's natural order
215
- * @param range - The range of keys to iterate over
216
- */
217
- async *keysAsync(range?: Range<K>): AsyncIterableIterator<K> {
218
- for await (const [key, _] of this.entriesAsync(range)) {
219
- yield key;
220
- }
221
- }
222
-
223
- deleteValue(key: K, val: V | undefined): Promise<void> {
224
- return execInWriteTx(this.store, tx => tx.removeIndex(serializeKey(this.prefix, key), this.encoder.pack(val)));
225
- }
226
-
227
- async *getValuesAsync(key: K): AsyncIterableIterator<V> {
228
- const values = await execInReadTx(this.store, tx => tx.getIndex(serializeKey(this.prefix, key)));
229
- for (const value of values) {
230
- yield this.encoder.unpack(value);
231
- }
232
- }
233
- }
@@ -12,6 +12,7 @@ export enum LMDBMessageType {
12
12
 
13
13
  START_CURSOR,
14
14
  ADVANCE_CURSOR,
15
+ ADVANCE_CURSOR_COUNT,
15
16
  CLOSE_CURSOR,
16
17
 
17
18
  BATCH,
@@ -19,6 +20,7 @@ export enum LMDBMessageType {
19
20
  STATS,
20
21
 
21
22
  CLOSE,
23
+ COPY_STORE,
22
24
  }
23
25
 
24
26
  type Key = Uint8Array;
@@ -59,10 +61,20 @@ interface AdvanceCursorRequest {
59
61
  count: number | null;
60
62
  }
61
63
 
64
+ interface AdvanceCursorCountRequest {
65
+ cursor: number;
66
+ endKey: Key;
67
+ }
68
+
62
69
  interface CloseCursorRequest {
63
70
  cursor: number;
64
71
  }
65
72
 
73
+ interface CopyStoreRequest {
74
+ dstPath: string;
75
+ compact: boolean;
76
+ }
77
+
66
78
  export interface Batch {
67
79
  addEntries: Array<KeyValues>;
68
80
  removeEntries: Array<KeyOptionalValues>;
@@ -80,6 +92,7 @@ export type LMDBRequestBody = {
80
92
 
81
93
  [LMDBMessageType.START_CURSOR]: StartCursorRequest;
82
94
  [LMDBMessageType.ADVANCE_CURSOR]: AdvanceCursorRequest;
95
+ [LMDBMessageType.ADVANCE_CURSOR_COUNT]: AdvanceCursorCountRequest;
83
96
  [LMDBMessageType.CLOSE_CURSOR]: CloseCursorRequest;
84
97
 
85
98
  [LMDBMessageType.BATCH]: BatchRequest;
@@ -87,6 +100,7 @@ export type LMDBRequestBody = {
87
100
  [LMDBMessageType.STATS]: void;
88
101
 
89
102
  [LMDBMessageType.CLOSE]: void;
103
+ [LMDBMessageType.COPY_STORE]: CopyStoreRequest;
90
104
  };
91
105
 
92
106
  interface GetResponse {
@@ -107,6 +121,11 @@ interface AdvanceCursorResponse {
107
121
  done: boolean;
108
122
  }
109
123
 
124
+ interface AdvanceCursorCountResponse {
125
+ count: number;
126
+ done: boolean;
127
+ }
128
+
110
129
  interface BatchResponse {
111
130
  durationNs: number;
112
131
  }
@@ -122,6 +141,7 @@ interface StatsResponse {
122
141
  totalUsedSize: bigint | number;
123
142
  }>;
124
143
  dbMapSizeBytes: bigint | number;
144
+ dbPhysicalFileSizeBytes: bigint | number;
125
145
  }
126
146
 
127
147
  export type LMDBResponseBody = {
@@ -132,6 +152,7 @@ export type LMDBResponseBody = {
132
152
 
133
153
  [LMDBMessageType.START_CURSOR]: StartCursorResponse;
134
154
  [LMDBMessageType.ADVANCE_CURSOR]: AdvanceCursorResponse;
155
+ [LMDBMessageType.ADVANCE_CURSOR_COUNT]: AdvanceCursorCountResponse;
135
156
  [LMDBMessageType.CLOSE_CURSOR]: BoolResponse;
136
157
 
137
158
  [LMDBMessageType.BATCH]: BatchResponse;
@@ -139,6 +160,8 @@ export type LMDBResponseBody = {
139
160
  [LMDBMessageType.STATS]: StatsResponse;
140
161
 
141
162
  [LMDBMessageType.CLOSE]: BoolResponse;
163
+
164
+ [LMDBMessageType.COPY_STORE]: BoolResponse;
142
165
  };
143
166
 
144
167
  export interface LMDBMessageChannel {
@@ -0,0 +1,141 @@
1
+ import { Encoder } from 'msgpackr/pack';
2
+
3
+ import type { Key, Range, Value } from '../interfaces/common.js';
4
+ import type { AztecAsyncMultiMap } from '../interfaces/multi_map.js';
5
+ import type { ReadTransaction } from './read_transaction.js';
6
+ import { type AztecLMDBStoreV2, execInReadTx, execInWriteTx } from './store.js';
7
+ import { deserializeKey, maxKey, minKey, serializeKey } from './utils.js';
8
+
9
+ export class LMDBMultiMap<K extends Key, V extends Value> implements AztecAsyncMultiMap<K, V> {
10
+ private prefix: string;
11
+ private encoder = new Encoder();
12
+ constructor(
13
+ private store: AztecLMDBStoreV2,
14
+ name: string,
15
+ ) {
16
+ this.prefix = `multimap:${name}`;
17
+ }
18
+
19
+ /**
20
+ * Sets the value at the given key.
21
+ * @param key - The key to set the value at
22
+ * @param val - The value to set
23
+ */
24
+ set(key: K, val: V): Promise<void> {
25
+ return execInWriteTx(this.store, tx => tx.setIndex(serializeKey(this.prefix, key), this.encoder.pack(val)));
26
+ }
27
+
28
+ async setMany(entries: { key: K; value: V }[]): Promise<void> {
29
+ await execInWriteTx(this.store, async tx => {
30
+ for (const { key, value } of entries) {
31
+ await tx.setIndex(serializeKey(this.prefix, key), this.encoder.pack(value));
32
+ }
33
+ });
34
+ }
35
+
36
+ /**
37
+ * Sets the value at the given key if it does not already exist.
38
+ * @param key - The key to set the value at
39
+ * @param val - The value to set
40
+ */
41
+ setIfNotExists(key: K, val: V): Promise<boolean> {
42
+ return execInWriteTx(this.store, async tx => {
43
+ const exists = !!(await this.getAsync(key));
44
+ if (!exists) {
45
+ await tx.setIndex(serializeKey(this.prefix, key), this.encoder.pack(val));
46
+ return true;
47
+ }
48
+ return false;
49
+ });
50
+ }
51
+
52
+ /**
53
+ * Deletes the value at the given key.
54
+ * @param key - The key to delete the value at
55
+ */
56
+ delete(key: K): Promise<void> {
57
+ return execInWriteTx(this.store, tx => tx.removeIndex(serializeKey(this.prefix, key)));
58
+ }
59
+
60
+ getAsync(key: K): Promise<V | undefined> {
61
+ return execInReadTx(this.store, async tx => {
62
+ const val = await tx.getIndex(serializeKey(this.prefix, key));
63
+ return val.length > 0 ? this.encoder.unpack(val[0]) : undefined;
64
+ });
65
+ }
66
+
67
+ hasAsync(key: K): Promise<boolean> {
68
+ return execInReadTx(this.store, async tx => (await tx.getIndex(serializeKey(this.prefix, key))).length > 0);
69
+ }
70
+
71
+ sizeAsync(): Promise<number> {
72
+ return execInReadTx(this.store, tx => tx.countEntriesIndex(minKey(this.prefix), maxKey(this.prefix), false));
73
+ }
74
+
75
+ /**
76
+ * Iterates over the map's key-value entries in the key's natural order
77
+ * @param range - The range of keys to iterate over
78
+ */
79
+ async *entriesAsync(range?: Range<K>): AsyncIterableIterator<[K, V]> {
80
+ const reverse = range?.reverse ?? false;
81
+ const startKey = range?.start ? serializeKey(this.prefix, range.start) : minKey(this.prefix);
82
+ const endKey = range?.end ? serializeKey(this.prefix, range.end) : reverse ? maxKey(this.prefix) : undefined;
83
+
84
+ let tx: ReadTransaction | undefined = this.store.getCurrentWriteTx();
85
+ const shouldClose = !tx;
86
+ tx ??= this.store.getReadTx();
87
+
88
+ try {
89
+ for await (const [key, vals] of tx.iterateIndex(
90
+ reverse ? endKey! : startKey,
91
+ reverse ? startKey : endKey,
92
+ reverse,
93
+ range?.limit,
94
+ )) {
95
+ const deserializedKey = deserializeKey<K>(this.prefix, key);
96
+ if (!deserializedKey) {
97
+ break;
98
+ }
99
+
100
+ for (const val of vals) {
101
+ yield [deserializedKey, this.encoder.unpack(val)];
102
+ }
103
+ }
104
+ } finally {
105
+ if (shouldClose) {
106
+ tx.close();
107
+ }
108
+ }
109
+ }
110
+
111
+ /**
112
+ * Iterates over the map's values in the key's natural order
113
+ * @param range - The range of keys to iterate over
114
+ */
115
+ async *valuesAsync(range?: Range<K>): AsyncIterableIterator<V> {
116
+ for await (const [_, value] of this.entriesAsync(range)) {
117
+ yield value;
118
+ }
119
+ }
120
+
121
+ /**
122
+ * Iterates over the map's keys in the key's natural order
123
+ * @param range - The range of keys to iterate over
124
+ */
125
+ async *keysAsync(range?: Range<K>): AsyncIterableIterator<K> {
126
+ for await (const [key, _] of this.entriesAsync(range)) {
127
+ yield key;
128
+ }
129
+ }
130
+
131
+ deleteValue(key: K, val: V | undefined): Promise<void> {
132
+ return execInWriteTx(this.store, tx => tx.removeIndex(serializeKey(this.prefix, key), this.encoder.pack(val)));
133
+ }
134
+
135
+ async *getValuesAsync(key: K): AsyncIterableIterator<V> {
136
+ const values = await execInReadTx(this.store, tx => tx.getIndex(serializeKey(this.prefix, key)));
137
+ for (const value of values) {
138
+ yield this.encoder.unpack(value);
139
+ }
140
+ }
141
+ }
@@ -48,6 +48,14 @@ export class ReadTransaction {
48
48
  yield* this.#iterate(Database.INDEX, startKey, endKey, reverse, limit, vals => vals);
49
49
  }
50
50
 
51
+ public countEntries(startKey: Uint8Array, endKey: Uint8Array, reverse: boolean): Promise<number> {
52
+ return this.#countEntries(Database.DATA, startKey, endKey, reverse);
53
+ }
54
+
55
+ public countEntriesIndex(startKey: Uint8Array, endKey: Uint8Array, reverse: boolean): Promise<number> {
56
+ return this.#countEntries(Database.INDEX, startKey, endKey, reverse);
57
+ }
58
+
51
59
  async *#iterate<T>(
52
60
  db: string,
53
61
  startKey: Uint8Array,
@@ -113,4 +121,36 @@ export class ReadTransaction {
113
121
  }
114
122
  }
115
123
  }
124
+
125
+ async #countEntries(db: string, startKey: Uint8Array, endKey: Uint8Array, reverse: boolean): Promise<number> {
126
+ this.assertIsOpen();
127
+
128
+ const response = await this.channel.sendMessage(LMDBMessageType.START_CURSOR, {
129
+ key: startKey,
130
+ reverse,
131
+ count: 0,
132
+ onePage: false,
133
+ db,
134
+ });
135
+
136
+ const cursor = response.cursor;
137
+
138
+ try {
139
+ if (!cursor) {
140
+ return 0;
141
+ }
142
+
143
+ const advanceResponse = await this.channel.sendMessage(LMDBMessageType.ADVANCE_CURSOR_COUNT, {
144
+ cursor,
145
+ endKey: endKey,
146
+ });
147
+
148
+ return advanceResponse.count;
149
+ } finally {
150
+ // we might not have anything to close
151
+ if (typeof cursor === 'number') {
152
+ await this.channel.sendMessage(LMDBMessageType.CLOSE_CURSOR, { cursor });
153
+ }
154
+ }
155
+ }
116
156
  }