@aztec/world-state 0.0.0-test.0 → 0.0.1-commit.03f7ef2
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.
- package/dest/index.d.ts +1 -1
- package/dest/instrumentation/instrumentation.d.ts +6 -4
- package/dest/instrumentation/instrumentation.d.ts.map +1 -1
- package/dest/instrumentation/instrumentation.js +16 -8
- package/dest/native/bench_metrics.d.ts +23 -0
- package/dest/native/bench_metrics.d.ts.map +1 -0
- package/dest/native/bench_metrics.js +81 -0
- package/dest/native/fork_checkpoint.d.ts +1 -1
- package/dest/native/fork_checkpoint.d.ts.map +1 -1
- package/dest/native/index.d.ts +1 -1
- package/dest/native/merkle_trees_facade.d.ts +19 -7
- package/dest/native/merkle_trees_facade.d.ts.map +1 -1
- package/dest/native/merkle_trees_facade.js +62 -11
- package/dest/native/message.d.ts +72 -51
- package/dest/native/message.d.ts.map +1 -1
- package/dest/native/message.js +61 -61
- package/dest/native/native_world_state.d.ts +28 -20
- package/dest/native/native_world_state.d.ts.map +1 -1
- package/dest/native/native_world_state.js +97 -36
- package/dest/native/native_world_state_instance.d.ts +20 -4
- package/dest/native/native_world_state_instance.d.ts.map +1 -1
- package/dest/native/native_world_state_instance.js +42 -3
- package/dest/native/world_state_ops_queue.d.ts +1 -1
- package/dest/native/world_state_ops_queue.d.ts.map +1 -1
- package/dest/native/world_state_ops_queue.js +1 -1
- package/dest/synchronizer/config.d.ts +12 -2
- package/dest/synchronizer/config.d.ts.map +1 -1
- package/dest/synchronizer/config.js +26 -1
- package/dest/synchronizer/errors.d.ts +4 -0
- package/dest/synchronizer/errors.d.ts.map +1 -0
- package/dest/synchronizer/errors.js +5 -0
- package/dest/synchronizer/factory.d.ts +9 -2
- package/dest/synchronizer/factory.d.ts.map +1 -1
- package/dest/synchronizer/factory.js +9 -4
- package/dest/synchronizer/index.d.ts +1 -1
- package/dest/synchronizer/server_world_state_synchronizer.d.ts +20 -29
- package/dest/synchronizer/server_world_state_synchronizer.d.ts.map +1 -1
- package/dest/synchronizer/server_world_state_synchronizer.js +94 -70
- package/dest/test/index.d.ts +1 -1
- package/dest/test/utils.d.ts +16 -9
- package/dest/test/utils.d.ts.map +1 -1
- package/dest/test/utils.js +56 -49
- package/dest/testing.d.ts +3 -3
- package/dest/testing.d.ts.map +1 -1
- package/dest/testing.js +7 -11
- package/dest/world-state-db/index.d.ts +1 -1
- package/dest/world-state-db/merkle_tree_db.d.ts +12 -9
- package/dest/world-state-db/merkle_tree_db.d.ts.map +1 -1
- package/package.json +24 -24
- package/src/instrumentation/instrumentation.ts +22 -10
- package/src/native/bench_metrics.ts +91 -0
- package/src/native/merkle_trees_facade.ts +73 -17
- package/src/native/message.ts +92 -73
- package/src/native/native_world_state.ts +118 -50
- package/src/native/native_world_state_instance.ts +59 -8
- package/src/native/world_state_ops_queue.ts +1 -1
- package/src/synchronizer/config.ts +47 -2
- package/src/synchronizer/errors.ts +5 -0
- package/src/synchronizer/factory.ts +31 -8
- package/src/synchronizer/server_world_state_synchronizer.ts +132 -93
- package/src/test/utils.ts +94 -84
- package/src/testing.ts +4 -8
- package/src/world-state-db/merkle_tree_db.ts +12 -8
|
@@ -1,17 +1,21 @@
|
|
|
1
1
|
import { MAX_NOTE_HASHES_PER_TX, MAX_NULLIFIERS_PER_TX, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP } from '@aztec/constants';
|
|
2
|
-
import {
|
|
2
|
+
import { BlockNumber } from '@aztec/foundation/branded-types';
|
|
3
|
+
import { fromEntries, padArrayEnd } from '@aztec/foundation/collection';
|
|
4
|
+
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
3
5
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
4
|
-
import {
|
|
5
|
-
import { createLogger } from '@aztec/foundation/log';
|
|
6
|
-
import type {
|
|
6
|
+
import { tryRmDir } from '@aztec/foundation/fs';
|
|
7
|
+
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
8
|
+
import type { L2BlockNew } from '@aztec/stdlib/block';
|
|
7
9
|
import { DatabaseVersionManager } from '@aztec/stdlib/database-version';
|
|
8
10
|
import type {
|
|
9
11
|
IndexedTreeId,
|
|
10
12
|
MerkleTreeReadOperations,
|
|
11
13
|
MerkleTreeWriteOperations,
|
|
12
14
|
} from '@aztec/stdlib/interfaces/server';
|
|
15
|
+
import type { SnapshotDataKeys } from '@aztec/stdlib/snapshots';
|
|
13
16
|
import { MerkleTreeId, NullifierLeaf, type NullifierLeafPreimage, PublicDataTreeLeaf } from '@aztec/stdlib/trees';
|
|
14
17
|
import { BlockHeader, PartialStateReference, StateReference } from '@aztec/stdlib/tx';
|
|
18
|
+
import { WorldStateRevision } from '@aztec/stdlib/world-state';
|
|
15
19
|
import { getTelemetryClient } from '@aztec/telemetry-client';
|
|
16
20
|
|
|
17
21
|
import assert from 'assert/strict';
|
|
@@ -20,6 +24,7 @@ import { tmpdir } from 'os';
|
|
|
20
24
|
import { join } from 'path';
|
|
21
25
|
|
|
22
26
|
import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
|
|
27
|
+
import type { WorldStateTreeMapSizes } from '../synchronizer/factory.js';
|
|
23
28
|
import type { MerkleTreeAdminDatabase as MerkleTreeDatabase } from '../world-state-db/merkle_tree_db.js';
|
|
24
29
|
import { MerkleTreesFacade, MerkleTreesForkFacade, serializeLeaf } from './merkle_trees_facade.js';
|
|
25
30
|
import {
|
|
@@ -27,16 +32,17 @@ import {
|
|
|
27
32
|
type WorldStateStatusFull,
|
|
28
33
|
type WorldStateStatusSummary,
|
|
29
34
|
blockStateReference,
|
|
30
|
-
|
|
31
|
-
|
|
35
|
+
sanitizeFullStatus,
|
|
36
|
+
sanitizeSummary,
|
|
32
37
|
treeStateReferenceToSnapshot,
|
|
33
|
-
worldStateRevision,
|
|
34
38
|
} from './message.js';
|
|
35
39
|
import { NativeWorldState } from './native_world_state_instance.js';
|
|
36
40
|
|
|
37
41
|
// The current version of the world state database schema
|
|
38
42
|
// Increment this when making incompatible changes to the database schema
|
|
39
|
-
export const WORLD_STATE_DB_VERSION =
|
|
43
|
+
export const WORLD_STATE_DB_VERSION = 2; // The initial version
|
|
44
|
+
|
|
45
|
+
export const WORLD_STATE_DIR = 'world_state';
|
|
40
46
|
|
|
41
47
|
export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
42
48
|
protected initialHeader: BlockHeader | undefined;
|
|
@@ -44,38 +50,38 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
44
50
|
private cachedStatusSummary: WorldStateStatusSummary | undefined;
|
|
45
51
|
|
|
46
52
|
protected constructor(
|
|
47
|
-
protected
|
|
53
|
+
protected instance: NativeWorldState,
|
|
48
54
|
protected readonly worldStateInstrumentation: WorldStateInstrumentation,
|
|
49
|
-
protected readonly log = createLogger('world-state:database'),
|
|
55
|
+
protected readonly log: Logger = createLogger('world-state:database'),
|
|
50
56
|
private readonly cleanup = () => Promise.resolve(),
|
|
51
57
|
) {}
|
|
52
58
|
|
|
53
59
|
static async new(
|
|
54
60
|
rollupAddress: EthAddress,
|
|
55
61
|
dataDir: string,
|
|
56
|
-
|
|
62
|
+
wsTreeMapSizes: WorldStateTreeMapSizes,
|
|
57
63
|
prefilledPublicData: PublicDataTreeLeaf[] = [],
|
|
58
64
|
instrumentation = new WorldStateInstrumentation(getTelemetryClient()),
|
|
59
65
|
log = createLogger('world-state:database'),
|
|
60
66
|
cleanup = () => Promise.resolve(),
|
|
61
67
|
): Promise<NativeWorldStateService> {
|
|
62
|
-
const worldStateDirectory = join(dataDir,
|
|
68
|
+
const worldStateDirectory = join(dataDir, WORLD_STATE_DIR);
|
|
63
69
|
// Create a version manager to handle versioning
|
|
64
|
-
const versionManager = new DatabaseVersionManager(
|
|
65
|
-
WORLD_STATE_DB_VERSION,
|
|
70
|
+
const versionManager = new DatabaseVersionManager({
|
|
71
|
+
schemaVersion: WORLD_STATE_DB_VERSION,
|
|
66
72
|
rollupAddress,
|
|
67
|
-
worldStateDirectory,
|
|
68
|
-
(dir: string) => {
|
|
69
|
-
return Promise.resolve(new NativeWorldState(dir,
|
|
73
|
+
dataDirectory: worldStateDirectory,
|
|
74
|
+
onOpen: (dir: string) => {
|
|
75
|
+
return Promise.resolve(new NativeWorldState(dir, wsTreeMapSizes, prefilledPublicData, instrumentation));
|
|
70
76
|
},
|
|
71
|
-
);
|
|
77
|
+
});
|
|
72
78
|
|
|
73
79
|
const [instance] = await versionManager.open();
|
|
74
80
|
const worldState = new this(instance, instrumentation, log, cleanup);
|
|
75
81
|
try {
|
|
76
82
|
await worldState.init();
|
|
77
83
|
} catch (e) {
|
|
78
|
-
log.error(`Error
|
|
84
|
+
log.error(`Error initializing world state: ${e}`);
|
|
79
85
|
throw e;
|
|
80
86
|
}
|
|
81
87
|
|
|
@@ -91,7 +97,14 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
91
97
|
const log = createLogger('world-state:database');
|
|
92
98
|
const dataDir = await mkdtemp(join(tmpdir(), 'aztec-world-state-'));
|
|
93
99
|
const dbMapSizeKb = 10 * 1024 * 1024;
|
|
94
|
-
|
|
100
|
+
const worldStateTreeMapSizes: WorldStateTreeMapSizes = {
|
|
101
|
+
archiveTreeMapSizeKb: dbMapSizeKb,
|
|
102
|
+
nullifierTreeMapSizeKb: dbMapSizeKb,
|
|
103
|
+
noteHashTreeMapSizeKb: dbMapSizeKb,
|
|
104
|
+
messageTreeMapSizeKb: dbMapSizeKb,
|
|
105
|
+
publicDataTreeMapSizeKb: dbMapSizeKb,
|
|
106
|
+
};
|
|
107
|
+
log.debug(`Created temporary world state database at: ${dataDir} with tree map size: ${dbMapSizeKb}`);
|
|
95
108
|
|
|
96
109
|
// pass a cleanup callback because process.on('beforeExit', cleanup) does not work under Jest
|
|
97
110
|
const cleanup = async () => {
|
|
@@ -103,7 +116,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
103
116
|
}
|
|
104
117
|
};
|
|
105
118
|
|
|
106
|
-
return this.new(rollupAddress, dataDir,
|
|
119
|
+
return this.new(rollupAddress, dataDir, worldStateTreeMapSizes, prefilledPublicData, instrumentation, log, cleanup);
|
|
107
120
|
}
|
|
108
121
|
|
|
109
122
|
protected async init() {
|
|
@@ -127,33 +140,67 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
127
140
|
assert.strictEqual(initialHeaderIndex, 0n, 'Invalid initial archive state');
|
|
128
141
|
}
|
|
129
142
|
|
|
143
|
+
public async clear() {
|
|
144
|
+
await this.instance.close();
|
|
145
|
+
this.cachedStatusSummary = undefined;
|
|
146
|
+
await tryRmDir(this.instance.getDataDir(), this.log);
|
|
147
|
+
this.instance = this.instance.clone();
|
|
148
|
+
}
|
|
149
|
+
|
|
130
150
|
public getCommitted(): MerkleTreeReadOperations {
|
|
131
|
-
return new MerkleTreesFacade(this.instance, this.initialHeader!,
|
|
151
|
+
return new MerkleTreesFacade(this.instance, this.initialHeader!, WorldStateRevision.empty());
|
|
132
152
|
}
|
|
133
153
|
|
|
134
|
-
public getSnapshot(blockNumber:
|
|
135
|
-
return new MerkleTreesFacade(
|
|
154
|
+
public getSnapshot(blockNumber: BlockNumber): MerkleTreeReadOperations {
|
|
155
|
+
return new MerkleTreesFacade(
|
|
156
|
+
this.instance,
|
|
157
|
+
this.initialHeader!,
|
|
158
|
+
new WorldStateRevision(/*forkId=*/ 0, /* blockNumber=*/ blockNumber, /* includeUncommitted=*/ false),
|
|
159
|
+
);
|
|
136
160
|
}
|
|
137
161
|
|
|
138
|
-
public async fork(
|
|
162
|
+
public async fork(
|
|
163
|
+
blockNumber?: BlockNumber,
|
|
164
|
+
opts: { closeDelayMs?: number } = {},
|
|
165
|
+
): Promise<MerkleTreeWriteOperations> {
|
|
139
166
|
const resp = await this.instance.call(WorldStateMessageType.CREATE_FORK, {
|
|
140
167
|
latest: blockNumber === undefined,
|
|
141
|
-
blockNumber: blockNumber ??
|
|
168
|
+
blockNumber: blockNumber ?? BlockNumber.ZERO,
|
|
142
169
|
canonical: true,
|
|
143
170
|
});
|
|
144
|
-
return new MerkleTreesForkFacade(
|
|
171
|
+
return new MerkleTreesForkFacade(
|
|
172
|
+
this.instance,
|
|
173
|
+
this.initialHeader!,
|
|
174
|
+
new WorldStateRevision(
|
|
175
|
+
/*forkId=*/ resp.forkId,
|
|
176
|
+
/* blockNumber=*/ BlockNumber.ZERO,
|
|
177
|
+
/* includeUncommitted=*/ true,
|
|
178
|
+
),
|
|
179
|
+
opts,
|
|
180
|
+
);
|
|
145
181
|
}
|
|
146
182
|
|
|
147
183
|
public getInitialHeader(): BlockHeader {
|
|
148
184
|
return this.initialHeader!;
|
|
149
185
|
}
|
|
150
186
|
|
|
151
|
-
public async handleL2BlockAndMessages(l2Block:
|
|
152
|
-
|
|
187
|
+
public async handleL2BlockAndMessages(l2Block: L2BlockNew, l1ToL2Messages: Fr[]): Promise<WorldStateStatusFull> {
|
|
188
|
+
const isFirstBlock = l2Block.indexWithinCheckpoint === 0;
|
|
189
|
+
if (!isFirstBlock && l1ToL2Messages.length > 0) {
|
|
190
|
+
throw new Error(
|
|
191
|
+
`L1 to L2 messages must be empty for non-first blocks, but got ${l1ToL2Messages.length} messages for block ${l2Block.number}.`,
|
|
192
|
+
);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
// We have to pad the given l1 to l2 messages, and the note hashes and nullifiers within tx effects, because that's
|
|
196
|
+
// how the trees are built by circuits.
|
|
197
|
+
const paddedL1ToL2Messages = isFirstBlock
|
|
198
|
+
? padArrayEnd<Fr, number>(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP)
|
|
199
|
+
: [];
|
|
200
|
+
|
|
153
201
|
const paddedNoteHashes = l2Block.body.txEffects.flatMap(txEffect =>
|
|
154
202
|
padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX),
|
|
155
203
|
);
|
|
156
|
-
const paddedL1ToL2Messages = padArrayEnd(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
|
|
157
204
|
|
|
158
205
|
const paddedNullifiers = l2Block.body.txEffects
|
|
159
206
|
.flatMap(txEffect => padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX))
|
|
@@ -173,7 +220,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
173
220
|
WorldStateMessageType.SYNC_BLOCK,
|
|
174
221
|
{
|
|
175
222
|
blockNumber: l2Block.number,
|
|
176
|
-
blockHeaderHash: await l2Block.
|
|
223
|
+
blockHeaderHash: await l2Block.hash(),
|
|
177
224
|
paddedL1ToL2Messages: paddedL1ToL2Messages.map(serializeLeaf),
|
|
178
225
|
paddedNoteHashes: paddedNoteHashes.map(serializeLeaf),
|
|
179
226
|
paddedNullifiers: paddedNullifiers.map(serializeLeaf),
|
|
@@ -181,7 +228,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
181
228
|
blockStateRef: blockStateReference(l2Block.header.state),
|
|
182
229
|
canonical: true,
|
|
183
230
|
},
|
|
184
|
-
this.
|
|
231
|
+
this.sanitizeAndCacheSummaryFromFull.bind(this),
|
|
185
232
|
this.deleteCachedSummary.bind(this),
|
|
186
233
|
);
|
|
187
234
|
} catch (err) {
|
|
@@ -200,16 +247,16 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
200
247
|
return BlockHeader.empty({ state });
|
|
201
248
|
}
|
|
202
249
|
|
|
203
|
-
private
|
|
204
|
-
const
|
|
205
|
-
this.cachedStatusSummary = { ...
|
|
206
|
-
return
|
|
250
|
+
private sanitizeAndCacheSummaryFromFull(response: WorldStateStatusFull) {
|
|
251
|
+
const sanitized = sanitizeFullStatus(response);
|
|
252
|
+
this.cachedStatusSummary = { ...sanitized.summary };
|
|
253
|
+
return sanitized;
|
|
207
254
|
}
|
|
208
255
|
|
|
209
|
-
private
|
|
210
|
-
const
|
|
211
|
-
this.cachedStatusSummary = { ...
|
|
212
|
-
return
|
|
256
|
+
private sanitizeAndCacheSummary(response: WorldStateStatusSummary) {
|
|
257
|
+
const sanitized = sanitizeSummary(response);
|
|
258
|
+
this.cachedStatusSummary = { ...sanitized };
|
|
259
|
+
return sanitized;
|
|
213
260
|
}
|
|
214
261
|
|
|
215
262
|
private deleteCachedSummary(_: string) {
|
|
@@ -217,19 +264,19 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
217
264
|
}
|
|
218
265
|
|
|
219
266
|
/**
|
|
220
|
-
* Advances the
|
|
221
|
-
* @param toBlockNumber The block number that is now the tip of the
|
|
267
|
+
* Advances the finalized block number to be the number provided
|
|
268
|
+
* @param toBlockNumber The block number that is now the tip of the finalized chain
|
|
222
269
|
* @returns The new WorldStateStatus
|
|
223
270
|
*/
|
|
224
|
-
public async
|
|
271
|
+
public async setFinalized(toBlockNumber: BlockNumber) {
|
|
225
272
|
try {
|
|
226
273
|
await this.instance.call(
|
|
227
|
-
WorldStateMessageType.
|
|
274
|
+
WorldStateMessageType.FINALIZE_BLOCKS,
|
|
228
275
|
{
|
|
229
276
|
toBlockNumber,
|
|
230
277
|
canonical: true,
|
|
231
278
|
},
|
|
232
|
-
this.
|
|
279
|
+
this.sanitizeAndCacheSummary.bind(this),
|
|
233
280
|
this.deleteCachedSummary.bind(this),
|
|
234
281
|
);
|
|
235
282
|
} catch (err) {
|
|
@@ -244,7 +291,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
244
291
|
* @param toBlockNumber The block number of the new oldest historical block
|
|
245
292
|
* @returns The new WorldStateStatus
|
|
246
293
|
*/
|
|
247
|
-
public async removeHistoricalBlocks(toBlockNumber:
|
|
294
|
+
public async removeHistoricalBlocks(toBlockNumber: BlockNumber) {
|
|
248
295
|
try {
|
|
249
296
|
return await this.instance.call(
|
|
250
297
|
WorldStateMessageType.REMOVE_HISTORICAL_BLOCKS,
|
|
@@ -252,7 +299,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
252
299
|
toBlockNumber,
|
|
253
300
|
canonical: true,
|
|
254
301
|
},
|
|
255
|
-
this.
|
|
302
|
+
this.sanitizeAndCacheSummaryFromFull.bind(this),
|
|
256
303
|
this.deleteCachedSummary.bind(this),
|
|
257
304
|
);
|
|
258
305
|
} catch (err) {
|
|
@@ -266,7 +313,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
266
313
|
* @param toBlockNumber The block number of the new tip of the pending chain,
|
|
267
314
|
* @returns The new WorldStateStatus
|
|
268
315
|
*/
|
|
269
|
-
public async unwindBlocks(toBlockNumber:
|
|
316
|
+
public async unwindBlocks(toBlockNumber: BlockNumber) {
|
|
270
317
|
try {
|
|
271
318
|
return await this.instance.call(
|
|
272
319
|
WorldStateMessageType.UNWIND_BLOCKS,
|
|
@@ -274,7 +321,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
274
321
|
toBlockNumber,
|
|
275
322
|
canonical: true,
|
|
276
323
|
},
|
|
277
|
-
this.
|
|
324
|
+
this.sanitizeAndCacheSummaryFromFull.bind(this),
|
|
278
325
|
this.deleteCachedSummary.bind(this),
|
|
279
326
|
);
|
|
280
327
|
} catch (err) {
|
|
@@ -290,7 +337,7 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
290
337
|
return await this.instance.call(
|
|
291
338
|
WorldStateMessageType.GET_STATUS,
|
|
292
339
|
{ canonical: true },
|
|
293
|
-
this.
|
|
340
|
+
this.sanitizeAndCacheSummary.bind(this),
|
|
294
341
|
);
|
|
295
342
|
}
|
|
296
343
|
|
|
@@ -314,4 +361,25 @@ export class NativeWorldStateService implements MerkleTreeDatabase {
|
|
|
314
361
|
),
|
|
315
362
|
);
|
|
316
363
|
}
|
|
364
|
+
|
|
365
|
+
public async backupTo(
|
|
366
|
+
dstPath: string,
|
|
367
|
+
compact: boolean = true,
|
|
368
|
+
): Promise<Record<Exclude<SnapshotDataKeys, 'archiver'>, string>> {
|
|
369
|
+
await this.instance.call(WorldStateMessageType.COPY_STORES, {
|
|
370
|
+
dstPath,
|
|
371
|
+
compact,
|
|
372
|
+
canonical: true,
|
|
373
|
+
});
|
|
374
|
+
return fromEntries(NATIVE_WORLD_STATE_DBS.map(([name, dir]) => [name, join(dstPath, dir, 'data.mdb')] as const));
|
|
375
|
+
}
|
|
317
376
|
}
|
|
377
|
+
|
|
378
|
+
// The following paths are defined in cpp-land
|
|
379
|
+
export const NATIVE_WORLD_STATE_DBS = [
|
|
380
|
+
['l1-to-l2-message-tree', 'L1ToL2MessageTree'],
|
|
381
|
+
['archive-tree', 'ArchiveTree'],
|
|
382
|
+
['public-data-tree', 'PublicDataTree'],
|
|
383
|
+
['note-hash-tree', 'NoteHashTree'],
|
|
384
|
+
['nullifier-tree', 'NullifierTree'],
|
|
385
|
+
] as const;
|
|
@@ -8,7 +8,7 @@ import {
|
|
|
8
8
|
NULLIFIER_TREE_HEIGHT,
|
|
9
9
|
PUBLIC_DATA_TREE_HEIGHT,
|
|
10
10
|
} from '@aztec/constants';
|
|
11
|
-
import { createLogger } from '@aztec/foundation/log';
|
|
11
|
+
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
12
12
|
import { NativeWorldState as BaseNativeWorldState, MsgpackChannel } from '@aztec/native';
|
|
13
13
|
import { MerkleTreeId } from '@aztec/stdlib/trees';
|
|
14
14
|
import type { PublicDataTreeLeaf } from '@aztec/stdlib/trees';
|
|
@@ -17,6 +17,7 @@ import assert from 'assert';
|
|
|
17
17
|
import { cpus } from 'os';
|
|
18
18
|
|
|
19
19
|
import type { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
|
|
20
|
+
import type { WorldStateTreeMapSizes } from '../synchronizer/factory.js';
|
|
20
21
|
import {
|
|
21
22
|
WorldStateMessageType,
|
|
22
23
|
type WorldStateRequest,
|
|
@@ -35,6 +36,8 @@ export interface NativeWorldStateInstance {
|
|
|
35
36
|
messageType: T,
|
|
36
37
|
body: WorldStateRequest[T] & WorldStateRequestCategories,
|
|
37
38
|
): Promise<WorldStateResponse[T]>;
|
|
39
|
+
// TODO(dbanks12): this returns any type, but we should strongly type it
|
|
40
|
+
getHandle(): any;
|
|
38
41
|
}
|
|
39
42
|
|
|
40
43
|
/**
|
|
@@ -50,15 +53,17 @@ export class NativeWorldState implements NativeWorldStateInstance {
|
|
|
50
53
|
|
|
51
54
|
/** Creates a new native WorldState instance */
|
|
52
55
|
constructor(
|
|
53
|
-
dataDir: string,
|
|
54
|
-
|
|
55
|
-
prefilledPublicData: PublicDataTreeLeaf[] = [],
|
|
56
|
-
private instrumentation: WorldStateInstrumentation,
|
|
57
|
-
private log = createLogger('world-state:database'),
|
|
56
|
+
private readonly dataDir: string,
|
|
57
|
+
private readonly wsTreeMapSizes: WorldStateTreeMapSizes,
|
|
58
|
+
private readonly prefilledPublicData: PublicDataTreeLeaf[] = [],
|
|
59
|
+
private readonly instrumentation: WorldStateInstrumentation,
|
|
60
|
+
private readonly log: Logger = createLogger('world-state:database'),
|
|
58
61
|
) {
|
|
59
62
|
const threads = Math.min(cpus().length, MAX_WORLD_STATE_THREADS);
|
|
60
63
|
log.info(
|
|
61
|
-
`Creating world state data store at directory ${dataDir} with map
|
|
64
|
+
`Creating world state data store at directory ${dataDir} with map sizes ${JSON.stringify(
|
|
65
|
+
wsTreeMapSizes,
|
|
66
|
+
)} and ${threads} threads.`,
|
|
62
67
|
);
|
|
63
68
|
const prefilledPublicDataBufferArray = prefilledPublicData.map(d => [d.slot.toBuffer(), d.value.toBuffer()]);
|
|
64
69
|
const ws = new BaseNativeWorldState(
|
|
@@ -76,7 +81,13 @@ export class NativeWorldState implements NativeWorldStateInstance {
|
|
|
76
81
|
},
|
|
77
82
|
prefilledPublicDataBufferArray,
|
|
78
83
|
GeneratorIndex.BLOCK_HASH,
|
|
79
|
-
|
|
84
|
+
{
|
|
85
|
+
[MerkleTreeId.NULLIFIER_TREE]: wsTreeMapSizes.nullifierTreeMapSizeKb,
|
|
86
|
+
[MerkleTreeId.NOTE_HASH_TREE]: wsTreeMapSizes.noteHashTreeMapSizeKb,
|
|
87
|
+
[MerkleTreeId.PUBLIC_DATA_TREE]: wsTreeMapSizes.publicDataTreeMapSizeKb,
|
|
88
|
+
[MerkleTreeId.L1_TO_L2_MESSAGE_TREE]: wsTreeMapSizes.messageTreeMapSizeKb,
|
|
89
|
+
[MerkleTreeId.ARCHIVE]: wsTreeMapSizes.archiveTreeMapSizeKb,
|
|
90
|
+
},
|
|
80
91
|
threads,
|
|
81
92
|
);
|
|
82
93
|
this.instance = new MsgpackChannel(ws);
|
|
@@ -84,6 +95,46 @@ export class NativeWorldState implements NativeWorldStateInstance {
|
|
|
84
95
|
this.queues.set(0, new WorldStateOpsQueue());
|
|
85
96
|
}
|
|
86
97
|
|
|
98
|
+
public getDataDir() {
|
|
99
|
+
return this.dataDir;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
public clone() {
|
|
103
|
+
return new NativeWorldState(
|
|
104
|
+
this.dataDir,
|
|
105
|
+
this.wsTreeMapSizes,
|
|
106
|
+
this.prefilledPublicData,
|
|
107
|
+
this.instrumentation,
|
|
108
|
+
this.log,
|
|
109
|
+
);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Gets the native WorldState handle from the underlying native instance.
|
|
114
|
+
* We call the getHandle() method on the native WorldState to get a NAPI External
|
|
115
|
+
* that wraps the underlying C++ WorldState pointer.
|
|
116
|
+
* @returns The NAPI External handle to the native WorldState instance,since
|
|
117
|
+
* the NAPI external type is opaque, we return any (we could also use an opaque symbol type)
|
|
118
|
+
*/
|
|
119
|
+
public getHandle(): any {
|
|
120
|
+
const worldStateWrapper = (this.instance as any).dest;
|
|
121
|
+
|
|
122
|
+
if (!worldStateWrapper) {
|
|
123
|
+
throw new Error('No WorldStateWrapper found');
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
if (typeof worldStateWrapper.getHandle !== 'function') {
|
|
127
|
+
throw new Error('WorldStateWrapper does not have getHandle method');
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// Call getHandle() to get the NAPI External
|
|
131
|
+
try {
|
|
132
|
+
return worldStateWrapper.getHandle();
|
|
133
|
+
} catch (error) {
|
|
134
|
+
this.log.error('Failed to get native WorldState handle', error);
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
87
138
|
/**
|
|
88
139
|
* Sends a message to the native instance and returns the response.
|
|
89
140
|
* @param messageType - The type of message to send
|
|
@@ -35,7 +35,7 @@ export const MUTATING_MSG_TYPES = new Set([
|
|
|
35
35
|
WorldStateMessageType.SYNC_BLOCK,
|
|
36
36
|
WorldStateMessageType.CREATE_FORK,
|
|
37
37
|
WorldStateMessageType.DELETE_FORK,
|
|
38
|
-
WorldStateMessageType.
|
|
38
|
+
WorldStateMessageType.FINALIZE_BLOCKS,
|
|
39
39
|
WorldStateMessageType.UNWIND_BLOCKS,
|
|
40
40
|
WorldStateMessageType.REMOVE_HISTORICAL_BLOCKS,
|
|
41
41
|
WorldStateMessageType.CREATE_CHECKPOINT,
|
|
@@ -16,9 +16,24 @@ export interface WorldStateConfig {
|
|
|
16
16
|
/** Size of the batch for each get-blocks request from the synchronizer to the archiver. */
|
|
17
17
|
worldStateBlockRequestBatchSize?: number;
|
|
18
18
|
|
|
19
|
-
/** The map size to be provided to LMDB for each world state tree DB, optional, will inherit from the general
|
|
19
|
+
/** The map size to be provided to LMDB for each world state tree DB, optional, will inherit from the general dataStoreMapSizeKb if not specified*/
|
|
20
20
|
worldStateDbMapSizeKb?: number;
|
|
21
21
|
|
|
22
|
+
/** The map size to be provided to LMDB for each world state archive tree, optional, will inherit from the general worldStateDbMapSizeKb if not specified*/
|
|
23
|
+
archiveTreeMapSizeKb?: number;
|
|
24
|
+
|
|
25
|
+
/** The map size to be provided to LMDB for each world state nullifier tree, optional, will inherit from the general worldStateDbMapSizeKb if not specified*/
|
|
26
|
+
nullifierTreeMapSizeKb?: number;
|
|
27
|
+
|
|
28
|
+
/** The map size to be provided to LMDB for each world state note hash tree, optional, will inherit from the general worldStateDbMapSizeKb if not specified*/
|
|
29
|
+
noteHashTreeMapSizeKb?: number;
|
|
30
|
+
|
|
31
|
+
/** The map size to be provided to LMDB for each world state message tree, optional, will inherit from the general worldStateDbMapSizeKb if not specified*/
|
|
32
|
+
messageTreeMapSizeKb?: number;
|
|
33
|
+
|
|
34
|
+
/** The map size to be provided to LMDB for each world state public data tree, optional, will inherit from the general worldStateDbMapSizeKb if not specified*/
|
|
35
|
+
publicDataTreeMapSizeKb?: number;
|
|
36
|
+
|
|
22
37
|
/** Optional directory for the world state DB, if unspecified will default to the general data directory */
|
|
23
38
|
worldStateDataDirectory?: string;
|
|
24
39
|
|
|
@@ -46,7 +61,37 @@ export const worldStateConfigMappings: ConfigMappingsType<WorldStateConfig> = {
|
|
|
46
61
|
worldStateDbMapSizeKb: {
|
|
47
62
|
env: 'WS_DB_MAP_SIZE_KB',
|
|
48
63
|
parseEnv: (val: string | undefined) => (val ? +val : undefined),
|
|
49
|
-
description: 'The maximum possible size of the world state DB',
|
|
64
|
+
description: 'The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKb.',
|
|
65
|
+
},
|
|
66
|
+
archiveTreeMapSizeKb: {
|
|
67
|
+
env: 'ARCHIVE_TREE_MAP_SIZE_KB',
|
|
68
|
+
parseEnv: (val: string | undefined) => (val ? +val : undefined),
|
|
69
|
+
description:
|
|
70
|
+
'The maximum possible size of the world state archive tree in KB. Overwrites the general worldStateDbMapSizeKb.',
|
|
71
|
+
},
|
|
72
|
+
nullifierTreeMapSizeKb: {
|
|
73
|
+
env: 'NULLIFIER_TREE_MAP_SIZE_KB',
|
|
74
|
+
parseEnv: (val: string | undefined) => (val ? +val : undefined),
|
|
75
|
+
description:
|
|
76
|
+
'The maximum possible size of the world state nullifier tree in KB. Overwrites the general worldStateDbMapSizeKb.',
|
|
77
|
+
},
|
|
78
|
+
noteHashTreeMapSizeKb: {
|
|
79
|
+
env: 'NOTE_HASH_TREE_MAP_SIZE_KB',
|
|
80
|
+
parseEnv: (val: string | undefined) => (val ? +val : undefined),
|
|
81
|
+
description:
|
|
82
|
+
'The maximum possible size of the world state note hash tree in KB. Overwrites the general worldStateDbMapSizeKb.',
|
|
83
|
+
},
|
|
84
|
+
messageTreeMapSizeKb: {
|
|
85
|
+
env: 'MESSAGE_TREE_MAP_SIZE_KB',
|
|
86
|
+
parseEnv: (val: string | undefined) => (val ? +val : undefined),
|
|
87
|
+
description:
|
|
88
|
+
'The maximum possible size of the world state message tree in KB. Overwrites the general worldStateDbMapSizeKb.',
|
|
89
|
+
},
|
|
90
|
+
publicDataTreeMapSizeKb: {
|
|
91
|
+
env: 'PUBLIC_DATA_TREE_MAP_SIZE_KB',
|
|
92
|
+
parseEnv: (val: string | undefined) => (val ? +val : undefined),
|
|
93
|
+
description:
|
|
94
|
+
'The maximum possible size of the world state public data tree in KB. Overwrites the general worldStateDbMapSizeKb.',
|
|
50
95
|
},
|
|
51
96
|
worldStateDataDirectory: {
|
|
52
97
|
env: 'WS_DATA_DIRECTORY',
|
|
@@ -9,6 +9,14 @@ import { NativeWorldStateService } from '../native/native_world_state.js';
|
|
|
9
9
|
import type { WorldStateConfig } from './config.js';
|
|
10
10
|
import { ServerWorldStateSynchronizer } from './server_world_state_synchronizer.js';
|
|
11
11
|
|
|
12
|
+
export interface WorldStateTreeMapSizes {
|
|
13
|
+
archiveTreeMapSizeKb: number;
|
|
14
|
+
nullifierTreeMapSizeKb: number;
|
|
15
|
+
noteHashTreeMapSizeKb: number;
|
|
16
|
+
messageTreeMapSizeKb: number;
|
|
17
|
+
publicDataTreeMapSizeKb: number;
|
|
18
|
+
}
|
|
19
|
+
|
|
12
20
|
export async function createWorldStateSynchronizer(
|
|
13
21
|
config: WorldStateConfig & DataStoreConfig,
|
|
14
22
|
l2BlockSource: L2BlockSource & L1ToL2MessageSource,
|
|
@@ -21,25 +29,40 @@ export async function createWorldStateSynchronizer(
|
|
|
21
29
|
}
|
|
22
30
|
|
|
23
31
|
export async function createWorldState(
|
|
24
|
-
config:
|
|
32
|
+
config: Pick<
|
|
33
|
+
WorldStateConfig,
|
|
34
|
+
| 'worldStateDataDirectory'
|
|
35
|
+
| 'worldStateDbMapSizeKb'
|
|
36
|
+
| 'archiveTreeMapSizeKb'
|
|
37
|
+
| 'nullifierTreeMapSizeKb'
|
|
38
|
+
| 'noteHashTreeMapSizeKb'
|
|
39
|
+
| 'messageTreeMapSizeKb'
|
|
40
|
+
| 'publicDataTreeMapSizeKb'
|
|
41
|
+
> &
|
|
42
|
+
Pick<DataStoreConfig, 'dataDirectory' | 'dataStoreMapSizeKb' | 'l1Contracts'>,
|
|
25
43
|
prefilledPublicData: PublicDataTreeLeaf[] = [],
|
|
26
44
|
instrumentation: WorldStateInstrumentation = new WorldStateInstrumentation(getTelemetryClient()),
|
|
27
45
|
) {
|
|
28
|
-
const
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
46
|
+
const dataDirectory = config.worldStateDataDirectory ?? config.dataDirectory;
|
|
47
|
+
const dataStoreMapSizeKb = config.worldStateDbMapSizeKb ?? config.dataStoreMapSizeKb;
|
|
48
|
+
const wsTreeMapSizes: WorldStateTreeMapSizes = {
|
|
49
|
+
archiveTreeMapSizeKb: config.archiveTreeMapSizeKb ?? dataStoreMapSizeKb,
|
|
50
|
+
nullifierTreeMapSizeKb: config.nullifierTreeMapSizeKb ?? dataStoreMapSizeKb,
|
|
51
|
+
noteHashTreeMapSizeKb: config.noteHashTreeMapSizeKb ?? dataStoreMapSizeKb,
|
|
52
|
+
messageTreeMapSizeKb: config.messageTreeMapSizeKb ?? dataStoreMapSizeKb,
|
|
53
|
+
publicDataTreeMapSizeKb: config.publicDataTreeMapSizeKb ?? dataStoreMapSizeKb,
|
|
54
|
+
};
|
|
32
55
|
|
|
33
56
|
if (!config.l1Contracts?.rollupAddress) {
|
|
34
57
|
throw new Error('Rollup address is required to create a world state synchronizer.');
|
|
35
58
|
}
|
|
36
59
|
|
|
37
60
|
// If a data directory is provided in config, then create a persistent store.
|
|
38
|
-
const merkleTrees =
|
|
61
|
+
const merkleTrees = dataDirectory
|
|
39
62
|
? await NativeWorldStateService.new(
|
|
40
63
|
config.l1Contracts.rollupAddress,
|
|
41
|
-
|
|
42
|
-
|
|
64
|
+
dataDirectory,
|
|
65
|
+
wsTreeMapSizes,
|
|
43
66
|
prefilledPublicData,
|
|
44
67
|
instrumentation,
|
|
45
68
|
)
|