@aztec/world-state 0.0.1-commit.d431d1c → 0.0.1-commit.d58ff9d0

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 (76) hide show
  1. package/dest/index.d.ts +2 -1
  2. package/dest/index.d.ts.map +1 -1
  3. package/dest/index.js +1 -0
  4. package/dest/instrumentation/instrumentation.d.ts +4 -3
  5. package/dest/instrumentation/instrumentation.d.ts.map +1 -1
  6. package/dest/instrumentation/instrumentation.js +13 -11
  7. package/dest/native/fork_checkpoint.d.ts +7 -1
  8. package/dest/native/fork_checkpoint.d.ts.map +1 -1
  9. package/dest/native/fork_checkpoint.js +15 -3
  10. package/dest/native/index.d.ts +2 -1
  11. package/dest/native/index.d.ts.map +1 -1
  12. package/dest/native/index.js +1 -0
  13. package/dest/native/ipc_world_state_instance.d.ts +89 -0
  14. package/dest/native/ipc_world_state_instance.d.ts.map +1 -0
  15. package/dest/native/ipc_world_state_instance.js +661 -0
  16. package/dest/native/merkle_trees_facade.d.ts +12 -8
  17. package/dest/native/merkle_trees_facade.d.ts.map +1 -1
  18. package/dest/native/merkle_trees_facade.js +63 -115
  19. package/dest/native/message.d.ts +14 -221
  20. package/dest/native/message.d.ts.map +1 -1
  21. package/dest/native/message.js +0 -42
  22. package/dest/native/native_world_state.d.ts +22 -10
  23. package/dest/native/native_world_state.d.ts.map +1 -1
  24. package/dest/native/native_world_state.js +122 -59
  25. package/dest/native/native_world_state_instance.d.ts +56 -42
  26. package/dest/native/native_world_state_instance.d.ts.map +1 -1
  27. package/dest/native/native_world_state_instance.js +1 -203
  28. package/dest/native/world_state_operation.d.ts +7 -0
  29. package/dest/native/world_state_operation.d.ts.map +1 -0
  30. package/dest/native/world_state_operation.js +5 -0
  31. package/dest/synchronizer/config.d.ts +3 -5
  32. package/dest/synchronizer/config.d.ts.map +1 -1
  33. package/dest/synchronizer/config.js +15 -18
  34. package/dest/synchronizer/errors.d.ts +8 -1
  35. package/dest/synchronizer/errors.d.ts.map +1 -1
  36. package/dest/synchronizer/errors.js +8 -1
  37. package/dest/synchronizer/factory.d.ts +6 -5
  38. package/dest/synchronizer/factory.d.ts.map +1 -1
  39. package/dest/synchronizer/factory.js +7 -6
  40. package/dest/synchronizer/index.d.ts +2 -1
  41. package/dest/synchronizer/index.d.ts.map +1 -1
  42. package/dest/synchronizer/index.js +1 -0
  43. package/dest/synchronizer/server_world_state_synchronizer.d.ts +13 -8
  44. package/dest/synchronizer/server_world_state_synchronizer.d.ts.map +1 -1
  45. package/dest/synchronizer/server_world_state_synchronizer.js +134 -49
  46. package/dest/test/utils.d.ts +6 -6
  47. package/dest/test/utils.d.ts.map +1 -1
  48. package/dest/test/utils.js +9 -4
  49. package/dest/testing.d.ts +4 -3
  50. package/dest/testing.d.ts.map +1 -1
  51. package/dest/testing.js +14 -7
  52. package/dest/world-state-db/merkle_tree_db.d.ts +3 -12
  53. package/dest/world-state-db/merkle_tree_db.d.ts.map +1 -1
  54. package/package.json +13 -11
  55. package/src/index.ts +1 -0
  56. package/src/instrumentation/instrumentation.ts +15 -19
  57. package/src/native/fork_checkpoint.ts +19 -3
  58. package/src/native/index.ts +1 -0
  59. package/src/native/ipc_world_state_instance.ts +834 -0
  60. package/src/native/merkle_trees_facade.ts +89 -109
  61. package/src/native/message.ts +13 -286
  62. package/src/native/native_world_state.ts +152 -93
  63. package/src/native/native_world_state_instance.ts +94 -279
  64. package/src/native/world_state_operation.ts +33 -0
  65. package/src/synchronizer/config.ts +16 -23
  66. package/src/synchronizer/errors.ts +8 -0
  67. package/src/synchronizer/factory.ts +18 -11
  68. package/src/synchronizer/index.ts +1 -0
  69. package/src/synchronizer/server_world_state_synchronizer.ts +156 -51
  70. package/src/test/utils.ts +14 -5
  71. package/src/testing.ts +12 -10
  72. package/src/world-state-db/merkle_tree_db.ts +2 -12
  73. package/dest/native/world_state_ops_queue.d.ts +0 -19
  74. package/dest/native/world_state_ops_queue.d.ts.map +0 -1
  75. package/dest/native/world_state_ops_queue.js +0 -146
  76. package/src/native/world_state_ops_queue.ts +0 -190
@@ -1,289 +1,104 @@
1
- import {
2
- ARCHIVE_HEIGHT,
3
- GeneratorIndex,
4
- L1_TO_L2_MSG_TREE_HEIGHT,
5
- MAX_NULLIFIERS_PER_TX,
6
- MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
7
- NOTE_HASH_TREE_HEIGHT,
8
- NULLIFIER_TREE_HEIGHT,
9
- PUBLIC_DATA_TREE_HEIGHT,
10
- } from '@aztec/constants';
11
- import { type Logger, createLogger } from '@aztec/foundation/log';
12
- import { NativeWorldState as BaseNativeWorldState, MsgpackChannel } from '@aztec/native';
13
- import { MerkleTreeId } from '@aztec/stdlib/trees';
14
- import type { PublicDataTreeLeaf } from '@aztec/stdlib/trees';
15
-
16
- import assert from 'assert';
17
- import { cpus } from 'os';
18
-
19
- import type { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
20
- import type { WorldStateTreeMapSizes } from '../synchronizer/factory.js';
21
- import {
22
- WorldStateMessageType,
23
- type WorldStateRequest,
24
- type WorldStateRequestCategories,
25
- type WorldStateResponse,
26
- isWithCanonical,
27
- isWithForkId,
28
- isWithRevision,
1
+ import type { BlockNumber } from '@aztec/foundation/branded-types';
2
+ import type { Fr } from '@aztec/foundation/curves/bn254';
3
+ import type { IndexedTreeId, TreeInfo } from '@aztec/stdlib/interfaces/server';
4
+ import type { MerkleTreeId } from '@aztec/stdlib/trees';
5
+ import type { WorldStateRevision } from '@aztec/stdlib/world-state';
6
+
7
+ import type {
8
+ BlockStateReference,
9
+ SerializedBatchInsertionResult,
10
+ SerializedIndexedLeaf,
11
+ SerializedLeafValue,
12
+ SerializedSequentialInsertionResult,
13
+ SerializedSiblingPathAndIndex,
14
+ TreeStateReference,
15
+ WorldStateStatusFull,
16
+ WorldStateStatusSummary,
29
17
  } from './message.js';
30
- import { WorldStateOpsQueue } from './world_state_ops_queue.js';
31
-
32
- const MAX_WORLD_STATE_THREADS = +(process.env.HARDWARE_CONCURRENCY || '16');
33
18
 
19
+ /** Backend-agnostic handle to a running aztec-wsdb world state, accessed by the TS layer. */
34
20
  export interface NativeWorldStateInstance {
35
- call<T extends WorldStateMessageType>(
36
- messageType: T,
37
- body: WorldStateRequest[T] & WorldStateRequestCategories,
38
- ): Promise<WorldStateResponse[T]>;
39
- // TODO(dbanks12): this returns any type, but we should strongly type it
40
- getHandle(): any;
41
- }
42
-
43
- /**
44
- * Strongly-typed interface to access the WorldState class in the native world_state_napi module.
45
- */
46
- export class NativeWorldState implements NativeWorldStateInstance {
47
- private open = true;
48
-
49
- // We maintain a map of queue to fork
50
- private queues = new Map<number, WorldStateOpsQueue>();
51
-
52
- private instance: MsgpackChannel<WorldStateMessageType, WorldStateRequest, WorldStateResponse>;
53
-
54
- /** Creates a new native WorldState instance */
55
- constructor(
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'),
61
- ) {
62
- const threads = Math.min(cpus().length, MAX_WORLD_STATE_THREADS);
63
- log.info(
64
- `Creating world state data store at directory ${dataDir} with map sizes ${JSON.stringify(
65
- wsTreeMapSizes,
66
- )} and ${threads} threads.`,
67
- );
68
- const prefilledPublicDataBufferArray = prefilledPublicData.map(d => [d.slot.toBuffer(), d.value.toBuffer()]);
69
- const ws = new BaseNativeWorldState(
70
- dataDir,
71
- {
72
- [MerkleTreeId.NULLIFIER_TREE]: NULLIFIER_TREE_HEIGHT,
73
- [MerkleTreeId.NOTE_HASH_TREE]: NOTE_HASH_TREE_HEIGHT,
74
- [MerkleTreeId.PUBLIC_DATA_TREE]: PUBLIC_DATA_TREE_HEIGHT,
75
- [MerkleTreeId.L1_TO_L2_MESSAGE_TREE]: L1_TO_L2_MSG_TREE_HEIGHT,
76
- [MerkleTreeId.ARCHIVE]: ARCHIVE_HEIGHT,
77
- },
78
- {
79
- [MerkleTreeId.NULLIFIER_TREE]: 2 * MAX_NULLIFIERS_PER_TX,
80
- [MerkleTreeId.PUBLIC_DATA_TREE]: 2 * MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
81
- },
82
- prefilledPublicDataBufferArray,
83
- GeneratorIndex.BLOCK_HASH,
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
- },
91
- threads,
92
- );
93
- this.instance = new MsgpackChannel(ws);
94
- // Manually create the queue for the canonical fork
95
- this.queues.set(0, new WorldStateOpsQueue());
96
- }
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
- }
21
+ getTreeInfo(treeId: MerkleTreeId, revision: WorldStateRevision): Promise<TreeInfo>;
22
+ getStateReference(revision: WorldStateRevision): Promise<Record<number, TreeStateReference>>;
23
+ getInitialStateReference(): Promise<Record<number, TreeStateReference>>;
24
+ getLeafValue(
25
+ treeId: MerkleTreeId,
26
+ revision: WorldStateRevision,
27
+ leafIndex: bigint,
28
+ ): Promise<SerializedLeafValue | undefined>;
29
+ getLeafPreimage(
30
+ treeId: IndexedTreeId,
31
+ revision: WorldStateRevision,
32
+ leafIndex: bigint,
33
+ ): Promise<SerializedIndexedLeaf | undefined>;
34
+ getSiblingPath(treeId: MerkleTreeId, revision: WorldStateRevision, leafIndex: bigint): Promise<Buffer[]>;
35
+ getBlockNumbersForLeafIndices(
36
+ treeId: MerkleTreeId,
37
+ revision: WorldStateRevision,
38
+ leafIndices: bigint[],
39
+ ): Promise<(bigint | undefined)[]>;
40
+ findLeafIndices(
41
+ treeId: MerkleTreeId,
42
+ revision: WorldStateRevision,
43
+ leaves: SerializedLeafValue[],
44
+ startIndex: bigint,
45
+ ): Promise<(bigint | undefined)[]>;
46
+ findLowLeaf(
47
+ treeId: IndexedTreeId,
48
+ revision: WorldStateRevision,
49
+ key: Fr,
50
+ ): Promise<{ index: bigint; alreadyPresent: boolean }>;
51
+ findSiblingPaths(
52
+ treeId: MerkleTreeId,
53
+ revision: WorldStateRevision,
54
+ leaves: SerializedLeafValue[],
55
+ ): Promise<(SerializedSiblingPathAndIndex | undefined)[]>;
56
+ updateArchive(forkId: number, blockStateRef: BlockStateReference, blockHeaderHash: Buffer): Promise<void>;
57
+ appendLeaves(treeId: MerkleTreeId, forkId: number, leaves: SerializedLeafValue[]): Promise<void>;
58
+ batchInsert(
59
+ treeId: IndexedTreeId,
60
+ forkId: number,
61
+ leaves: SerializedLeafValue[],
62
+ subtreeDepth: number,
63
+ ): Promise<SerializedBatchInsertionResult>;
64
+ sequentialInsert(
65
+ treeId: IndexedTreeId,
66
+ forkId: number,
67
+ leaves: SerializedLeafValue[],
68
+ ): Promise<SerializedSequentialInsertionResult>;
69
+ syncBlock(input: {
70
+ blockNumber: BlockNumber;
71
+ blockStateRef: BlockStateReference;
72
+ blockHeaderHash: Buffer;
73
+ expectedArchiveRoot: Buffer;
74
+ expectedPreviousArchiveRoot: Buffer;
75
+ paddedNoteHashes: readonly SerializedLeafValue[];
76
+ paddedL1ToL2Messages: readonly SerializedLeafValue[];
77
+ paddedNullifiers: readonly SerializedLeafValue[];
78
+ publicDataWrites: readonly SerializedLeafValue[];
79
+ }): Promise<WorldStateStatusFull>;
80
+ createFork(input: { latest: boolean; blockNumber: BlockNumber }): Promise<number>;
81
+ deleteFork(forkId: number): Promise<void>;
82
+ finalizeBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusSummary>;
83
+ unwindBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusFull>;
84
+ removeHistoricalBlocks(toBlockNumber: BlockNumber): Promise<WorldStateStatusFull>;
85
+ getStatus(): Promise<WorldStateStatusSummary>;
86
+ createCheckpoint(forkId: number): Promise<number>;
87
+ commitCheckpoint(forkId: number): Promise<void>;
88
+ revertCheckpoint(forkId: number): Promise<void>;
89
+ commitAllCheckpoints(forkId: number, depth: number): Promise<void>;
90
+ revertAllCheckpoints(forkId: number, depth: number): Promise<void>;
91
+ copyStores(dstPath: string, compact: boolean): Promise<void>;
111
92
 
112
93
  /**
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)
94
+ * IPC path the underlying aztec-wsdb process listens on. The C++ AVM uses this to attach to the
95
+ * same world state instance the TS layer is using.
118
96
  */
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
- }
97
+ getIpcPath(): string;
137
98
 
138
99
  /**
139
- * Sends a message to the native instance and returns the response.
140
- * @param messageType - The type of message to send
141
- * @param body - The message body
142
- * @param responseHandler - A callback accepting the response, executed on the job queue
143
- * @param errorHandler - A callback called on request error, executed on the job queue
144
- * @returns The response to the message
100
+ * Shut down the world state instance. Cancels any in-flight queues, closes the IPC channel, and
101
+ * terminates the underlying aztec-wsdb process. Idempotent.
145
102
  */
146
- public async call<T extends WorldStateMessageType>(
147
- messageType: T,
148
- body: WorldStateRequest[T] & WorldStateRequestCategories,
149
- // allows for the pre-processing of responses on the job queue before being passed back
150
- responseHandler = (response: WorldStateResponse[T]): WorldStateResponse[T] => response,
151
- errorHandler = (_: string) => {},
152
- ): Promise<WorldStateResponse[T]> {
153
- // Here we determine which fork the request is being executed against and whether it requires uncommitted data
154
- // We use the fork Id to select the appropriate request queue and the uncommitted data flag to pass to the queue
155
- let forkId = -1;
156
- // We assume it includes uncommitted unless explicitly told otherwise
157
- let committedOnly = false;
158
-
159
- // Canonical requests ALWAYS go against the canonical fork
160
- // These include things like block syncs/unwinds etc
161
- // These requests don't contain a fork ID
162
- if (isWithCanonical(body)) {
163
- forkId = 0;
164
- } else if (isWithForkId(body)) {
165
- forkId = body.forkId;
166
- } else if (isWithRevision(body)) {
167
- forkId = body.revision.forkId;
168
- committedOnly = body.revision.includeUncommitted === false;
169
- } else {
170
- const _: never = body;
171
- throw new Error(`Unable to determine forkId for message=${WorldStateMessageType[messageType]}`);
172
- }
173
-
174
- // Get the queue or create a new one
175
- let requestQueue = this.queues.get(forkId);
176
- if (requestQueue === undefined) {
177
- requestQueue = new WorldStateOpsQueue();
178
- this.queues.set(forkId, requestQueue);
179
- }
180
-
181
- // Enqueue the request and wait for the response
182
- const response = await requestQueue.execute(
183
- async () => {
184
- assert.notEqual(messageType, WorldStateMessageType.CLOSE, 'Use close() to close the native instance');
185
- assert.equal(this.open, true, 'Native instance is closed');
186
- let response: WorldStateResponse[T];
187
- try {
188
- response = await this._sendMessage(messageType, body);
189
- } catch (error: any) {
190
- errorHandler(error.message);
191
- throw error;
192
- }
193
- return responseHandler(response);
194
- },
195
- messageType,
196
- committedOnly,
197
- );
198
-
199
- // If the request was to delete the fork then we clean it up here
200
- if (messageType === WorldStateMessageType.DELETE_FORK) {
201
- await requestQueue.stop();
202
- this.queues.delete(forkId);
203
- }
204
- return response;
205
- }
206
-
207
- /**
208
- * Stops the native instance.
209
- */
210
- public async close(): Promise<void> {
211
- if (!this.open) {
212
- return;
213
- }
214
- this.open = false;
215
- const queue = this.queues.get(0)!;
216
-
217
- await queue.execute(
218
- async () => {
219
- await this._sendMessage(WorldStateMessageType.CLOSE, { canonical: true });
220
- },
221
- WorldStateMessageType.CLOSE,
222
- false,
223
- );
224
- await queue.stop();
225
- }
226
-
227
- private async _sendMessage<T extends WorldStateMessageType>(
228
- messageType: T,
229
- body: WorldStateRequest[T] & WorldStateRequestCategories,
230
- ): Promise<WorldStateResponse[T]> {
231
- let logMetadata: Record<string, any> = {};
232
-
233
- if (body) {
234
- if ('treeId' in body) {
235
- logMetadata['treeId'] = MerkleTreeId[body.treeId];
236
- }
237
-
238
- if ('revision' in body) {
239
- logMetadata = { ...logMetadata, ...body.revision };
240
- }
241
-
242
- if ('forkId' in body) {
243
- logMetadata['forkId'] = body.forkId;
244
- }
245
-
246
- if ('blockNumber' in body) {
247
- logMetadata['blockNumber'] = body.blockNumber;
248
- }
249
-
250
- if ('toBlockNumber' in body) {
251
- logMetadata['toBlockNumber'] = body.toBlockNumber;
252
- }
253
-
254
- if ('leafIndex' in body) {
255
- logMetadata['leafIndex'] = body.leafIndex;
256
- }
257
-
258
- if ('blockHeaderHash' in body) {
259
- logMetadata['blockHeaderHash'] = '0x' + body.blockHeaderHash.toString('hex');
260
- }
261
-
262
- if ('leaves' in body) {
263
- logMetadata['leavesCount'] = body.leaves.length;
264
- }
265
-
266
- // sync operation
267
- if ('paddedNoteHashes' in body) {
268
- logMetadata['notesCount'] = body.paddedNoteHashes.length;
269
- logMetadata['nullifiersCount'] = body.paddedNullifiers.length;
270
- logMetadata['l1ToL2MessagesCount'] = body.paddedL1ToL2Messages.length;
271
- logMetadata['publicDataWritesCount'] = body.publicDataWrites.length;
272
- }
273
- }
274
-
275
- try {
276
- const { duration, response } = await this.instance.sendMessage(messageType, body);
277
- this.log.trace(`Call ${WorldStateMessageType[messageType]} took (ms)`, {
278
- duration,
279
- ...logMetadata,
280
- });
281
-
282
- this.instrumentation.recordRoundTrip(duration.totalUs, messageType);
283
- return response;
284
- } catch (error) {
285
- this.log.error(`Call ${WorldStateMessageType[messageType]} failed: ${error}`, error, logMetadata);
286
- throw error;
287
- }
288
- }
103
+ close(): Promise<void>;
289
104
  }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Names of the world-state operations, used as labels for instrumentation and
3
+ * logging. (Read/write ordering is enforced server-side by the wsdb scheduler,
4
+ * so there is no longer a client-side operation queue.)
5
+ */
6
+ export type WorldStateOperationName =
7
+ | 'getTreeInfo'
8
+ | 'getStateReference'
9
+ | 'getInitialStateReference'
10
+ | 'getLeafValue'
11
+ | 'getLeafPreimage'
12
+ | 'getSiblingPath'
13
+ | 'getBlockNumbersForLeafIndices'
14
+ | 'findLeafIndices'
15
+ | 'findLowLeaf'
16
+ | 'findSiblingPaths'
17
+ | 'appendLeaves'
18
+ | 'batchInsert'
19
+ | 'sequentialInsert'
20
+ | 'updateArchive'
21
+ | 'syncBlock'
22
+ | 'createFork'
23
+ | 'deleteFork'
24
+ | 'finalizeBlocks'
25
+ | 'unwindBlocks'
26
+ | 'removeHistoricalBlocks'
27
+ | 'getStatus'
28
+ | 'createCheckpoint'
29
+ | 'commitCheckpoint'
30
+ | 'revertCheckpoint'
31
+ | 'commitAllCheckpoints'
32
+ | 'revertAllCheckpoints'
33
+ | 'copyStores';
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  type ConfigMappingsType,
3
- booleanConfigHelper,
4
3
  getConfigFromMappings,
5
4
  numberConfigHelper,
5
+ optionalNumberConfigHelper,
6
6
  } from '@aztec/foundation/config';
7
7
 
8
8
  /** World State synchronizer configuration values. */
@@ -10,9 +10,6 @@ export interface WorldStateConfig {
10
10
  /** The frequency in which to check. */
11
11
  worldStateBlockCheckIntervalMS: number;
12
12
 
13
- /** Whether to follow only the proven chain. */
14
- worldStateProvenBlocksOnly: boolean;
15
-
16
13
  /** Size of the batch for each get-blocks request from the synchronizer to the archiver. */
17
14
  worldStateBlockRequestBatchSize?: number;
18
15
 
@@ -37,59 +34,53 @@ export interface WorldStateConfig {
37
34
  /** Optional directory for the world state DB, if unspecified will default to the general data directory */
38
35
  worldStateDataDirectory?: string;
39
36
 
40
- /** The number of historic blocks to maintain */
41
- worldStateBlockHistory: number;
37
+ /** The number of historic checkpoints worth of blocks to maintain */
38
+ worldStateCheckpointHistory: number;
42
39
  }
43
40
 
44
41
  export const worldStateConfigMappings: ConfigMappingsType<WorldStateConfig> = {
45
42
  worldStateBlockCheckIntervalMS: {
46
43
  env: 'WS_BLOCK_CHECK_INTERVAL_MS',
47
- parseEnv: (val: string) => +val,
48
- defaultValue: 100,
44
+ ...numberConfigHelper(100),
49
45
  description: 'The frequency in which to check.',
50
46
  },
51
- worldStateProvenBlocksOnly: {
52
- env: 'WS_PROVEN_BLOCKS_ONLY',
53
- description: 'Whether to follow only the proven chain.',
54
- ...booleanConfigHelper(),
55
- },
56
47
  worldStateBlockRequestBatchSize: {
57
48
  env: 'WS_BLOCK_REQUEST_BATCH_SIZE',
58
- parseEnv: (val: string | undefined) => (val ? +val : undefined),
49
+ ...optionalNumberConfigHelper(),
59
50
  description: 'Size of the batch for each get-blocks request from the synchronizer to the archiver.',
60
51
  },
61
52
  worldStateDbMapSizeKb: {
62
53
  env: 'WS_DB_MAP_SIZE_KB',
63
- parseEnv: (val: string | undefined) => (val ? +val : undefined),
54
+ ...optionalNumberConfigHelper(),
64
55
  description: 'The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKb.',
65
56
  },
66
57
  archiveTreeMapSizeKb: {
67
58
  env: 'ARCHIVE_TREE_MAP_SIZE_KB',
68
- parseEnv: (val: string | undefined) => (val ? +val : undefined),
59
+ ...optionalNumberConfigHelper(),
69
60
  description:
70
61
  'The maximum possible size of the world state archive tree in KB. Overwrites the general worldStateDbMapSizeKb.',
71
62
  },
72
63
  nullifierTreeMapSizeKb: {
73
64
  env: 'NULLIFIER_TREE_MAP_SIZE_KB',
74
- parseEnv: (val: string | undefined) => (val ? +val : undefined),
65
+ ...optionalNumberConfigHelper(),
75
66
  description:
76
67
  'The maximum possible size of the world state nullifier tree in KB. Overwrites the general worldStateDbMapSizeKb.',
77
68
  },
78
69
  noteHashTreeMapSizeKb: {
79
70
  env: 'NOTE_HASH_TREE_MAP_SIZE_KB',
80
- parseEnv: (val: string | undefined) => (val ? +val : undefined),
71
+ ...optionalNumberConfigHelper(),
81
72
  description:
82
73
  'The maximum possible size of the world state note hash tree in KB. Overwrites the general worldStateDbMapSizeKb.',
83
74
  },
84
75
  messageTreeMapSizeKb: {
85
76
  env: 'MESSAGE_TREE_MAP_SIZE_KB',
86
- parseEnv: (val: string | undefined) => (val ? +val : undefined),
77
+ ...optionalNumberConfigHelper(),
87
78
  description:
88
79
  'The maximum possible size of the world state message tree in KB. Overwrites the general worldStateDbMapSizeKb.',
89
80
  },
90
81
  publicDataTreeMapSizeKb: {
91
82
  env: 'PUBLIC_DATA_TREE_MAP_SIZE_KB',
92
- parseEnv: (val: string | undefined) => (val ? +val : undefined),
83
+ ...optionalNumberConfigHelper(),
93
84
  description:
94
85
  'The maximum possible size of the world state public data tree in KB. Overwrites the general worldStateDbMapSizeKb.',
95
86
  },
@@ -97,9 +88,11 @@ export const worldStateConfigMappings: ConfigMappingsType<WorldStateConfig> = {
97
88
  env: 'WS_DATA_DIRECTORY',
98
89
  description: 'Optional directory for the world state database',
99
90
  },
100
- worldStateBlockHistory: {
101
- env: 'WS_NUM_HISTORIC_BLOCKS',
102
- description: 'The number of historic blocks to maintain. Values less than 1 mean all history is maintained',
91
+ worldStateCheckpointHistory: {
92
+ env: 'WS_NUM_HISTORIC_CHECKPOINTS',
93
+ description:
94
+ 'The number of historic checkpoints worth of blocks to maintain. Values less than 1 mean all history is maintained',
95
+ fallback: ['WS_NUM_HISTORIC_BLOCKS'],
103
96
  ...numberConfigHelper(64),
104
97
  },
105
98
  };
@@ -1,5 +1,13 @@
1
+ /**
2
+ * Thrown by {@link ServerWorldStateSynchronizer.syncImmediate} when world state cannot be synced to the requested
3
+ * target: either the block is not available from the block source (`block_not_available`, e.g. it was pruned away)
4
+ * or the synced block does not match the requested hash (`block_hash_mismatch`, i.e. a reorg). Both causes are
5
+ * transient from the caller's perspective: re-resolving the query against the current chain and retrying may succeed
6
+ * or produce a more precise error.
7
+ */
1
8
  export class WorldStateSynchronizerError extends Error {
2
9
  constructor(message: string, options?: ErrorOptions) {
3
10
  super(message, options);
11
+ this.name = 'WorldStateSynchronizerError';
4
12
  }
5
13
  }
@@ -1,7 +1,8 @@
1
- import type { DataStoreConfig } from '@aztec/kv-store/config';
1
+ import type { LoggerBindings } from '@aztec/foundation/log';
2
2
  import type { L2BlockSource } from '@aztec/stdlib/block';
3
+ import type { DataStoreConfig } from '@aztec/stdlib/kv-store';
3
4
  import type { L1ToL2MessageSource } from '@aztec/stdlib/messaging';
4
- import type { PublicDataTreeLeaf } from '@aztec/stdlib/trees';
5
+ import { EMPTY_GENESIS_DATA, type GenesisData, isGenesisData } from '@aztec/stdlib/world-state';
5
6
  import { type TelemetryClient, getTelemetryClient } from '@aztec/telemetry-client';
6
7
 
7
8
  import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
@@ -20,11 +21,14 @@ export interface WorldStateTreeMapSizes {
20
21
  export async function createWorldStateSynchronizer(
21
22
  config: WorldStateConfig & DataStoreConfig,
22
23
  l2BlockSource: L2BlockSource & L1ToL2MessageSource,
23
- prefilledPublicData: PublicDataTreeLeaf[] = [],
24
+ genesisOrNativeWorldState: GenesisData | NativeWorldStateService,
24
25
  client: TelemetryClient = getTelemetryClient(),
26
+ bindings?: LoggerBindings,
25
27
  ) {
26
28
  const instrumentation = new WorldStateInstrumentation(client);
27
- const merkleTrees = await createWorldState(config, prefilledPublicData, instrumentation);
29
+ const merkleTrees = isGenesisData(genesisOrNativeWorldState)
30
+ ? await createWorldState(config, genesisOrNativeWorldState, instrumentation, bindings)
31
+ : genesisOrNativeWorldState;
28
32
  return new ServerWorldStateSynchronizer(merkleTrees, l2BlockSource, config, instrumentation);
29
33
  }
30
34
 
@@ -39,9 +43,10 @@ export async function createWorldState(
39
43
  | 'messageTreeMapSizeKb'
40
44
  | 'publicDataTreeMapSizeKb'
41
45
  > &
42
- Pick<DataStoreConfig, 'dataDirectory' | 'dataStoreMapSizeKb' | 'l1Contracts'>,
43
- prefilledPublicData: PublicDataTreeLeaf[] = [],
46
+ Pick<DataStoreConfig, 'dataDirectory' | 'dataStoreMapSizeKb' | 'rollupAddress'>,
47
+ genesis: GenesisData = EMPTY_GENESIS_DATA,
44
48
  instrumentation: WorldStateInstrumentation = new WorldStateInstrumentation(getTelemetryClient()),
49
+ bindings?: LoggerBindings,
45
50
  ) {
46
51
  const dataDirectory = config.worldStateDataDirectory ?? config.dataDirectory;
47
52
  const dataStoreMapSizeKb = config.worldStateDbMapSizeKb ?? config.dataStoreMapSizeKb;
@@ -53,23 +58,25 @@ export async function createWorldState(
53
58
  publicDataTreeMapSizeKb: config.publicDataTreeMapSizeKb ?? dataStoreMapSizeKb,
54
59
  };
55
60
 
56
- if (!config.l1Contracts?.rollupAddress) {
61
+ if (!config.rollupAddress) {
57
62
  throw new Error('Rollup address is required to create a world state synchronizer.');
58
63
  }
59
64
 
60
65
  // If a data directory is provided in config, then create a persistent store.
61
66
  const merkleTrees = dataDirectory
62
67
  ? await NativeWorldStateService.new(
63
- config.l1Contracts.rollupAddress,
68
+ config.rollupAddress,
64
69
  dataDirectory,
65
70
  wsTreeMapSizes,
66
- prefilledPublicData,
71
+ genesis,
67
72
  instrumentation,
73
+ bindings,
68
74
  )
69
75
  : await NativeWorldStateService.tmp(
70
- config.l1Contracts.rollupAddress,
71
76
  !['true', '1'].includes(process.env.DEBUG_WORLD_STATE!),
72
- prefilledPublicData,
77
+ genesis,
78
+ instrumentation,
79
+ bindings,
73
80
  );
74
81
 
75
82
  return merkleTrees;
@@ -1,2 +1,3 @@
1
1
  export * from './server_world_state_synchronizer.js';
2
2
  export * from './factory.js';
3
+ export * from './errors.js';