@aztec-labs/world-state 6.0.0-nightly.20260829

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 (86) hide show
  1. package/README.md +40 -0
  2. package/dest/index.d.ts +6 -0
  3. package/dest/index.d.ts.map +1 -0
  4. package/dest/index.js +5 -0
  5. package/dest/instrumentation/instrumentation.d.ts +25 -0
  6. package/dest/instrumentation/instrumentation.d.ts.map +1 -0
  7. package/dest/instrumentation/instrumentation.js +96 -0
  8. package/dest/native/bench_metrics.d.ts +23 -0
  9. package/dest/native/bench_metrics.d.ts.map +1 -0
  10. package/dest/native/bench_metrics.js +81 -0
  11. package/dest/native/fork_checkpoint.d.ts +16 -0
  12. package/dest/native/fork_checkpoint.d.ts.map +1 -0
  13. package/dest/native/fork_checkpoint.js +38 -0
  14. package/dest/native/index.d.ts +4 -0
  15. package/dest/native/index.d.ts.map +1 -0
  16. package/dest/native/index.js +3 -0
  17. package/dest/native/ipc_world_state_instance.d.ts +91 -0
  18. package/dest/native/ipc_world_state_instance.d.ts.map +1 -0
  19. package/dest/native/ipc_world_state_instance.js +672 -0
  20. package/dest/native/merkle_trees_facade.d.ts +58 -0
  21. package/dest/native/merkle_trees_facade.d.ts.map +1 -0
  22. package/dest/native/merkle_trees_facade.js +250 -0
  23. package/dest/native/message.d.ts +145 -0
  24. package/dest/native/message.d.ts.map +1 -0
  25. package/dest/native/message.js +150 -0
  26. package/dest/native/native_world_state.d.ts +77 -0
  27. package/dest/native/native_world_state.d.ts.map +1 -0
  28. package/dest/native/native_world_state.js +350 -0
  29. package/dest/native/native_world_state_instance.d.ts +63 -0
  30. package/dest/native/native_world_state_instance.d.ts.map +1 -0
  31. package/dest/native/native_world_state_instance.js +1 -0
  32. package/dest/native/world_state_operation.d.ts +7 -0
  33. package/dest/native/world_state_operation.d.ts.map +1 -0
  34. package/dest/native/world_state_operation.js +5 -0
  35. package/dest/synchronizer/config.d.ts +31 -0
  36. package/dest/synchronizer/config.d.ts.map +1 -0
  37. package/dest/synchronizer/config.js +61 -0
  38. package/dest/synchronizer/errors.d.ts +11 -0
  39. package/dest/synchronizer/errors.d.ts.map +1 -0
  40. package/dest/synchronizer/errors.js +12 -0
  41. package/dest/synchronizer/factory.d.ts +20 -0
  42. package/dest/synchronizer/factory.d.ts.map +1 -0
  43. package/dest/synchronizer/factory.js +30 -0
  44. package/dest/synchronizer/index.d.ts +4 -0
  45. package/dest/synchronizer/index.d.ts.map +1 -0
  46. package/dest/synchronizer/index.js +3 -0
  47. package/dest/synchronizer/server_world_state_synchronizer.d.ts +83 -0
  48. package/dest/synchronizer/server_world_state_synchronizer.d.ts.map +1 -0
  49. package/dest/synchronizer/server_world_state_synchronizer.js +434 -0
  50. package/dest/test/index.d.ts +2 -0
  51. package/dest/test/index.d.ts.map +1 -0
  52. package/dest/test/index.js +1 -0
  53. package/dest/test/utils.d.ts +35 -0
  54. package/dest/test/utils.d.ts.map +1 -0
  55. package/dest/test/utils.js +118 -0
  56. package/dest/testing.d.ts +11 -0
  57. package/dest/testing.d.ts.map +1 -0
  58. package/dest/testing.js +48 -0
  59. package/dest/world-state-db/index.d.ts +3 -0
  60. package/dest/world-state-db/index.d.ts.map +1 -0
  61. package/dest/world-state-db/index.js +1 -0
  62. package/dest/world-state-db/merkle_tree_db.d.ts +65 -0
  63. package/dest/world-state-db/merkle_tree_db.d.ts.map +1 -0
  64. package/dest/world-state-db/merkle_tree_db.js +17 -0
  65. package/package.json +98 -0
  66. package/src/index.ts +5 -0
  67. package/src/instrumentation/instrumentation.ts +150 -0
  68. package/src/native/bench_metrics.ts +91 -0
  69. package/src/native/fork_checkpoint.ts +46 -0
  70. package/src/native/index.ts +3 -0
  71. package/src/native/ipc_world_state_instance.ts +849 -0
  72. package/src/native/merkle_trees_facade.ts +375 -0
  73. package/src/native/message.ts +287 -0
  74. package/src/native/native_world_state.ts +435 -0
  75. package/src/native/native_world_state_instance.ts +104 -0
  76. package/src/native/world_state_operation.ts +33 -0
  77. package/src/synchronizer/config.ts +106 -0
  78. package/src/synchronizer/errors.ts +13 -0
  79. package/src/synchronizer/factory.ts +83 -0
  80. package/src/synchronizer/index.ts +3 -0
  81. package/src/synchronizer/server_world_state_synchronizer.ts +525 -0
  82. package/src/test/index.ts +1 -0
  83. package/src/test/utils.ts +184 -0
  84. package/src/testing.ts +65 -0
  85. package/src/world-state-db/index.ts +3 -0
  86. package/src/world-state-db/merkle_tree_db.ts +80 -0
@@ -0,0 +1,61 @@
1
+ import { getConfigFromMappings, numberConfigHelper, optionalNumberConfigHelper } from '@aztec-labs/foundation/config';
2
+ export const worldStateConfigMappings = {
3
+ worldStateBlockCheckIntervalMS: {
4
+ env: 'WS_BLOCK_CHECK_INTERVAL_MS',
5
+ ...numberConfigHelper(100),
6
+ description: 'The frequency in which to check.'
7
+ },
8
+ worldStateBlockRequestBatchSize: {
9
+ env: 'WS_BLOCK_REQUEST_BATCH_SIZE',
10
+ ...optionalNumberConfigHelper(),
11
+ description: 'Size of the batch for each get-blocks request from the synchronizer to the archiver.'
12
+ },
13
+ worldStateDbMapSizeKb: {
14
+ env: 'WS_DB_MAP_SIZE_KB',
15
+ ...optionalNumberConfigHelper(),
16
+ description: 'The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKb.'
17
+ },
18
+ archiveTreeMapSizeKb: {
19
+ env: 'ARCHIVE_TREE_MAP_SIZE_KB',
20
+ ...optionalNumberConfigHelper(),
21
+ description: 'The maximum possible size of the world state archive tree in KB. Overwrites the general worldStateDbMapSizeKb.'
22
+ },
23
+ nullifierTreeMapSizeKb: {
24
+ env: 'NULLIFIER_TREE_MAP_SIZE_KB',
25
+ ...optionalNumberConfigHelper(),
26
+ description: 'The maximum possible size of the world state nullifier tree in KB. Overwrites the general worldStateDbMapSizeKb.'
27
+ },
28
+ noteHashTreeMapSizeKb: {
29
+ env: 'NOTE_HASH_TREE_MAP_SIZE_KB',
30
+ ...optionalNumberConfigHelper(),
31
+ description: 'The maximum possible size of the world state note hash tree in KB. Overwrites the general worldStateDbMapSizeKb.'
32
+ },
33
+ messageTreeMapSizeKb: {
34
+ env: 'MESSAGE_TREE_MAP_SIZE_KB',
35
+ ...optionalNumberConfigHelper(),
36
+ description: 'The maximum possible size of the world state message tree in KB. Overwrites the general worldStateDbMapSizeKb.'
37
+ },
38
+ publicDataTreeMapSizeKb: {
39
+ env: 'PUBLIC_DATA_TREE_MAP_SIZE_KB',
40
+ ...optionalNumberConfigHelper(),
41
+ description: 'The maximum possible size of the world state public data tree in KB. Overwrites the general worldStateDbMapSizeKb.'
42
+ },
43
+ worldStateDataDirectory: {
44
+ env: 'WS_DATA_DIRECTORY',
45
+ description: 'Optional directory for the world state database'
46
+ },
47
+ worldStateCheckpointHistory: {
48
+ env: 'WS_NUM_HISTORIC_CHECKPOINTS',
49
+ description: 'The number of historic checkpoints worth of blocks to maintain. Values less than 1 mean all history is maintained',
50
+ fallback: [
51
+ 'WS_NUM_HISTORIC_BLOCKS'
52
+ ],
53
+ ...numberConfigHelper(64)
54
+ }
55
+ };
56
+ /**
57
+ * Returns the configuration values for the world state synchronizer.
58
+ * @returns The configuration values for the world state synchronizer.
59
+ */ export function getWorldStateConfigFromEnv() {
60
+ return getConfigFromMappings(worldStateConfigMappings);
61
+ }
@@ -0,0 +1,11 @@
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
+ */
8
+ export declare class WorldStateSynchronizerError extends Error {
9
+ constructor(message: string, options?: ErrorOptions);
10
+ }
11
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc3luY2hyb25pemVyL2Vycm9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7O0dBTUc7QUFDSCxxQkFBYSwyQkFBNEIsU0FBUSxLQUFLO0lBQ3BELFlBQVksT0FBTyxFQUFFLE1BQU0sRUFBRSxPQUFPLENBQUMsRUFBRSxZQUFZLEVBR2xEO0NBQ0YifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/synchronizer/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,qBAAa,2BAA4B,SAAQ,KAAK;IACpD,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAGlD;CACF"}
@@ -0,0 +1,12 @@
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
+ */ export class WorldStateSynchronizerError extends Error {
8
+ constructor(message, options){
9
+ super(message, options);
10
+ this.name = 'WorldStateSynchronizerError';
11
+ }
12
+ }
@@ -0,0 +1,20 @@
1
+ import type { LoggerBindings } from '@aztec-labs/foundation/log';
2
+ import type { L2BlockSource } from '@aztec-labs/stdlib/block';
3
+ import type { DataStoreConfig } from '@aztec-labs/stdlib/kv-store';
4
+ import type { L1ToL2MessageSource } from '@aztec-labs/stdlib/messaging';
5
+ import { type GenesisData } from '@aztec-labs/stdlib/world-state';
6
+ import { type TelemetryClient } from '@aztec-labs/telemetry-client';
7
+ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
8
+ import { NativeWorldStateService } from '../native/native_world_state.js';
9
+ import type { WorldStateConfig } from './config.js';
10
+ import { ServerWorldStateSynchronizer } from './server_world_state_synchronizer.js';
11
+ export interface WorldStateTreeMapSizes {
12
+ archiveTreeMapSizeKb: number;
13
+ nullifierTreeMapSizeKb: number;
14
+ noteHashTreeMapSizeKb: number;
15
+ messageTreeMapSizeKb: number;
16
+ publicDataTreeMapSizeKb: number;
17
+ }
18
+ export declare function createWorldStateSynchronizer(config: WorldStateConfig & DataStoreConfig, l2BlockSource: L2BlockSource & L1ToL2MessageSource, genesisOrNativeWorldState: GenesisData | NativeWorldStateService, client?: TelemetryClient, bindings?: LoggerBindings): Promise<ServerWorldStateSynchronizer>;
19
+ export declare function createWorldState(config: Pick<WorldStateConfig, 'worldStateDataDirectory' | 'worldStateDbMapSizeKb' | 'archiveTreeMapSizeKb' | 'nullifierTreeMapSizeKb' | 'noteHashTreeMapSizeKb' | 'messageTreeMapSizeKb' | 'publicDataTreeMapSizeKb'> & Pick<DataStoreConfig, 'dataDirectory' | 'dataStoreMapSizeKb' | 'rollupAddress'>, genesis?: GenesisData, instrumentation?: WorldStateInstrumentation, bindings?: LoggerBindings): Promise<NativeWorldStateService>;
20
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmFjdG9yeS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3N5bmNocm9uaXplci9mYWN0b3J5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLGNBQWMsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBQ2pFLE9BQU8sS0FBSyxFQUFFLGFBQWEsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBQzlELE9BQU8sS0FBSyxFQUFFLGVBQWUsRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ25FLE9BQU8sS0FBSyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sOEJBQThCLENBQUM7QUFDeEUsT0FBTyxFQUFzQixLQUFLLFdBQVcsRUFBaUIsTUFBTSxnQ0FBZ0MsQ0FBQztBQUNyRyxPQUFPLEVBQUUsS0FBSyxlQUFlLEVBQXNCLE1BQU0sOEJBQThCLENBQUM7QUFFeEYsT0FBTyxFQUFFLHlCQUF5QixFQUFFLE1BQU0sdUNBQXVDLENBQUM7QUFDbEYsT0FBTyxFQUFFLHVCQUF1QixFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDMUUsT0FBTyxLQUFLLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDcEQsT0FBTyxFQUFFLDRCQUE0QixFQUFFLE1BQU0sc0NBQXNDLENBQUM7QUFFcEYsTUFBTSxXQUFXLHNCQUFzQjtJQUNyQyxvQkFBb0IsRUFBRSxNQUFNLENBQUM7SUFDN0Isc0JBQXNCLEVBQUUsTUFBTSxDQUFDO0lBQy9CLHFCQUFxQixFQUFFLE1BQU0sQ0FBQztJQUM5QixvQkFBb0IsRUFBRSxNQUFNLENBQUM7SUFDN0IsdUJBQXVCLEVBQUUsTUFBTSxDQUFDO0NBQ2pDO0FBRUQsd0JBQXNCLDRCQUE0QixDQUNoRCxNQUFNLEVBQUUsZ0JBQWdCLEdBQUcsZUFBZSxFQUMxQyxhQUFhLEVBQUUsYUFBYSxHQUFHLG1CQUFtQixFQUNsRCx5QkFBeUIsRUFBRSxXQUFXLEdBQUcsdUJBQXVCLEVBQ2hFLE1BQU0sR0FBRSxlQUFzQyxFQUM5QyxRQUFRLENBQUMsRUFBRSxjQUFjLHlDQU8xQjtBQUVELHdCQUFzQixnQkFBZ0IsQ0FDcEMsTUFBTSxFQUFFLElBQUksQ0FDVixnQkFBZ0IsRUFDZCx5QkFBeUIsR0FDekIsdUJBQXVCLEdBQ3ZCLHNCQUFzQixHQUN0Qix3QkFBd0IsR0FDeEIsdUJBQXVCLEdBQ3ZCLHNCQUFzQixHQUN0Qix5QkFBeUIsQ0FDNUIsR0FDQyxJQUFJLENBQUMsZUFBZSxFQUFFLGVBQWUsR0FBRyxvQkFBb0IsR0FBRyxlQUFlLENBQUMsRUFDakYsT0FBTyxHQUFFLFdBQWdDLEVBQ3pDLGVBQWUsR0FBRSx5QkFBK0UsRUFDaEcsUUFBUSxDQUFDLEVBQUUsY0FBYyxvQ0FrQzFCIn0=
@@ -0,0 +1 @@
1
+ {"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/synchronizer/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAsB,KAAK,WAAW,EAAiB,MAAM,gCAAgC,CAAC;AACrG,OAAO,EAAE,KAAK,eAAe,EAAsB,MAAM,8BAA8B,CAAC;AAExF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AAEpF,MAAM,WAAW,sBAAsB;IACrC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,gBAAgB,GAAG,eAAe,EAC1C,aAAa,EAAE,aAAa,GAAG,mBAAmB,EAClD,yBAAyB,EAAE,WAAW,GAAG,uBAAuB,EAChE,MAAM,GAAE,eAAsC,EAC9C,QAAQ,CAAC,EAAE,cAAc,yCAO1B;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,IAAI,CACV,gBAAgB,EACd,yBAAyB,GACzB,uBAAuB,GACvB,sBAAsB,GACtB,wBAAwB,GACxB,uBAAuB,GACvB,sBAAsB,GACtB,yBAAyB,CAC5B,GACC,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,oBAAoB,GAAG,eAAe,CAAC,EACjF,OAAO,GAAE,WAAgC,EACzC,eAAe,GAAE,yBAA+E,EAChG,QAAQ,CAAC,EAAE,cAAc,oCAkC1B"}
@@ -0,0 +1,30 @@
1
+ import { EMPTY_GENESIS_DATA, isGenesisData } from '@aztec-labs/stdlib/world-state';
2
+ import { getTelemetryClient } from '@aztec-labs/telemetry-client';
3
+ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
4
+ import { NativeWorldStateService } from '../native/native_world_state.js';
5
+ import { ServerWorldStateSynchronizer } from './server_world_state_synchronizer.js';
6
+ export async function createWorldStateSynchronizer(config, l2BlockSource, genesisOrNativeWorldState, client = getTelemetryClient(), bindings) {
7
+ const instrumentation = new WorldStateInstrumentation(client);
8
+ const merkleTrees = isGenesisData(genesisOrNativeWorldState) ? await createWorldState(config, genesisOrNativeWorldState, instrumentation, bindings) : genesisOrNativeWorldState;
9
+ return new ServerWorldStateSynchronizer(merkleTrees, l2BlockSource, config, instrumentation);
10
+ }
11
+ export async function createWorldState(config, genesis = EMPTY_GENESIS_DATA, instrumentation = new WorldStateInstrumentation(getTelemetryClient()), bindings) {
12
+ const dataDirectory = config.worldStateDataDirectory ?? config.dataDirectory;
13
+ const dataStoreMapSizeKb = config.worldStateDbMapSizeKb ?? config.dataStoreMapSizeKb;
14
+ const wsTreeMapSizes = {
15
+ archiveTreeMapSizeKb: config.archiveTreeMapSizeKb ?? dataStoreMapSizeKb,
16
+ nullifierTreeMapSizeKb: config.nullifierTreeMapSizeKb ?? dataStoreMapSizeKb,
17
+ noteHashTreeMapSizeKb: config.noteHashTreeMapSizeKb ?? dataStoreMapSizeKb,
18
+ messageTreeMapSizeKb: config.messageTreeMapSizeKb ?? dataStoreMapSizeKb,
19
+ publicDataTreeMapSizeKb: config.publicDataTreeMapSizeKb ?? dataStoreMapSizeKb
20
+ };
21
+ if (!config.rollupAddress) {
22
+ throw new Error('Rollup address is required to create a world state synchronizer.');
23
+ }
24
+ // If a data directory is provided in config, then create a persistent store.
25
+ const merkleTrees = dataDirectory ? await NativeWorldStateService.new(config.rollupAddress, dataDirectory, wsTreeMapSizes, genesis, instrumentation, bindings) : await NativeWorldStateService.tmp(![
26
+ 'true',
27
+ '1'
28
+ ].includes(process.env.DEBUG_WORLD_STATE), genesis, instrumentation, bindings);
29
+ return merkleTrees;
30
+ }
@@ -0,0 +1,4 @@
1
+ export * from './server_world_state_synchronizer.js';
2
+ export * from './factory.js';
3
+ export * from './errors.js';
4
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zeW5jaHJvbml6ZXIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxzQ0FBc0MsQ0FBQztBQUNyRCxjQUFjLGNBQWMsQ0FBQztBQUM3QixjQUFjLGFBQWEsQ0FBQyJ9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/synchronizer/index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"}
@@ -0,0 +1,3 @@
1
+ export * from './server_world_state_synchronizer.js';
2
+ export * from './factory.js';
3
+ export * from './errors.js';
@@ -0,0 +1,83 @@
1
+ import { BlockNumber } from '@aztec-labs/foundation/branded-types';
2
+ import type { Fr } from '@aztec-labs/foundation/curves/bn254';
3
+ import { type Logger } from '@aztec-labs/foundation/log';
4
+ import { type BlockHash, EventDrivenL2BlockStream, type L2Block, type L2BlockSource, type L2BlockStreamEvent, type L2BlockStreamEventHandler, type L2BlockStreamLocalDataProvider, type LocalChainTips } from '@aztec-labs/stdlib/block';
5
+ import { type WorldStateSynchronizer, type WorldStateSynchronizerStatus } from '@aztec-labs/stdlib/interfaces/server';
6
+ import type { L1ToL2MessageSource } from '@aztec-labs/stdlib/messaging';
7
+ import type { SnapshotDataKeys } from '@aztec-labs/stdlib/snapshots';
8
+ import { type MerkleTreeReadOperations, type MerkleTreeWriteOperations } from '@aztec-labs/stdlib/trees';
9
+ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
10
+ import type { WorldStateStatusFull } from '../native/message.js';
11
+ import type { MerkleTreeAdminDatabase } from '../world-state-db/merkle_tree_db.js';
12
+ import type { WorldStateConfig } from './config.js';
13
+ export type { SnapshotDataKeys };
14
+ /**
15
+ * Synchronizes the world state with the L2 blocks from a L2BlockSource via a block stream.
16
+ * The synchronizer will download the L2 blocks from the L2BlockSource and update the merkle trees.
17
+ * Handles chain reorgs via the L2BlockStream.
18
+ */
19
+ export declare class ServerWorldStateSynchronizer implements WorldStateSynchronizer, L2BlockStreamLocalDataProvider, L2BlockStreamEventHandler {
20
+ private readonly merkleTreeDb;
21
+ private readonly l2BlockSource;
22
+ private readonly config;
23
+ private instrumentation;
24
+ private readonly log;
25
+ private readonly merkleTreeCommitted;
26
+ private latestBlockNumberAtStart;
27
+ private historyToKeep;
28
+ private currentState;
29
+ private syncPromise;
30
+ protected blockStream: EventDrivenL2BlockStream | undefined;
31
+ private provenBlockNumber;
32
+ constructor(merkleTreeDb: MerkleTreeAdminDatabase, l2BlockSource: L2BlockSource & L1ToL2MessageSource, config: WorldStateConfig, instrumentation?: WorldStateInstrumentation, log?: Logger);
33
+ getCommitted(): MerkleTreeReadOperations;
34
+ getSnapshot(blockNumber: BlockNumber): MerkleTreeReadOperations;
35
+ getVerifiedSnapshot(blockNumber: BlockNumber, blockHash: BlockHash): Promise<MerkleTreeReadOperations>;
36
+ fork(blockNumber?: BlockNumber, opts?: {
37
+ closeDelayMs?: number;
38
+ }): Promise<MerkleTreeWriteOperations>;
39
+ backupTo(dstPath: string, compact?: boolean): Promise<Record<Exclude<SnapshotDataKeys, 'archiver'>, string>>;
40
+ clear(): Promise<void>;
41
+ start(): Promise<void | import("@aztec-labs/foundation/promise").PromiseWithResolvers<void>>;
42
+ protected createBlockStream(): EventDrivenL2BlockStream;
43
+ stop(): Promise<void>;
44
+ status(): Promise<WorldStateSynchronizerStatus>;
45
+ getLatestBlockNumber(): Promise<BlockNumber>;
46
+ stopSync(): Promise<void>;
47
+ resumeSync(): void;
48
+ /**
49
+ * Forces an immediate sync.
50
+ * @param targetBlockNumber - The target block number that we must sync to. Will download unproven blocks if needed to reach it.
51
+ * @param blockHash - If provided, verifies the block at targetBlockNumber matches this hash. On mismatch, triggers a resync (reorg detection).
52
+ * @returns A promise that resolves with the block number the world state was synced to
53
+ */
54
+ syncImmediate(targetBlockNumber?: BlockNumber, blockHash?: BlockHash): Promise<BlockNumber>;
55
+ /** Returns the L2 block hash for a given number. Used by the L2BlockStream for detecting reorgs. */
56
+ getL2BlockHash(number: BlockNumber): Promise<string | undefined>;
57
+ /**
58
+ * Returns the proposed, proven, and finalized block tips of the chain. World state drives its block stream with
59
+ * `ignoreCheckpoints`, so it does not track checkpointed blocks or checkpoints and omits `checkpointed` from the tips
60
+ * it reports.
61
+ */
62
+ getL2Tips(): Promise<LocalChainTips>;
63
+ /** Handles an event emitted by the block stream. */
64
+ handleBlockStreamEvent(event: L2BlockStreamEvent): Promise<void>;
65
+ private handleL2Blocks;
66
+ private getL1ToL2LeafCountBefore;
67
+ /**
68
+ * Handles a single L2 block (i.e. Inserts the new note hashes into the merkle tree).
69
+ * @param l2Block - The L2 block to handle.
70
+ * @param l1ToL2Messages - The L1 to L2 messages for the block.
71
+ * @returns Whether the block handled was produced by this same node.
72
+ */
73
+ protected handleL2Block(l2Block: L2Block, l1ToL2Messages: Fr[]): Promise<WorldStateStatusFull>;
74
+ private handleChainFinalized;
75
+ private handleChainProven;
76
+ private handleChainPruned;
77
+ /**
78
+ * Method to set the value of the current state.
79
+ * @param newState - New state value.
80
+ */
81
+ private setCurrentState;
82
+ }
83
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmVyX3dvcmxkX3N0YXRlX3N5bmNocm9uaXplci5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3N5bmNocm9uaXplci9zZXJ2ZXJfd29ybGRfc3RhdGVfc3luY2hyb25pemVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxXQUFXLEVBQW9CLE1BQU0sc0NBQXNDLENBQUM7QUFDckYsT0FBTyxLQUFLLEVBQUUsRUFBRSxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFDOUQsT0FBTyxFQUFFLEtBQUssTUFBTSxFQUFnQixNQUFNLDRCQUE0QixDQUFDO0FBR3ZFLE9BQU8sRUFDTCxLQUFLLFNBQVMsRUFDZCx3QkFBd0IsRUFDeEIsS0FBSyxPQUFPLEVBQ1osS0FBSyxhQUFhLEVBQ2xCLEtBQUssa0JBQWtCLEVBQ3ZCLEtBQUsseUJBQXlCLEVBQzlCLEtBQUssOEJBQThCLEVBQ25DLEtBQUssY0FBYyxFQUNwQixNQUFNLDBCQUEwQixDQUFDO0FBQ2xDLE9BQU8sRUFHTCxLQUFLLHNCQUFzQixFQUMzQixLQUFLLDRCQUE0QixFQUNsQyxNQUFNLHNDQUFzQyxDQUFDO0FBQzlDLE9BQU8sS0FBSyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sOEJBQThCLENBQUM7QUFDeEUsT0FBTyxLQUFLLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUVyRSxPQUFPLEVBQWdCLEtBQUssd0JBQXdCLEVBQUUsS0FBSyx5QkFBeUIsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBR3ZILE9BQU8sRUFBRSx5QkFBeUIsRUFBRSxNQUFNLHVDQUF1QyxDQUFDO0FBQ2xGLE9BQU8sS0FBSyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFDakUsT0FBTyxLQUFLLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxxQ0FBcUMsQ0FBQztBQUNuRixPQUFPLEtBQUssRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUdwRCxZQUFZLEVBQUUsZ0JBQWdCLEVBQUUsQ0FBQztBQUVqQzs7OztHQUlHO0FBQ0gscUJBQWEsNEJBQ1gsWUFBVyxzQkFBc0IsRUFBRSw4QkFBOEIsRUFBRSx5QkFBeUI7SUFnQjFGLE9BQU8sQ0FBQyxRQUFRLENBQUMsWUFBWTtJQUM3QixPQUFPLENBQUMsUUFBUSxDQUFDLGFBQWE7SUFDOUIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNO0lBQ3ZCLE9BQU8sQ0FBQyxlQUFlO0lBQ3ZCLE9BQU8sQ0FBQyxRQUFRLENBQUMsR0FBRztJQWxCdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxtQkFBbUIsQ0FBMkI7SUFFL0QsT0FBTyxDQUFDLHdCQUF3QixDQUFvQjtJQUNwRCxPQUFPLENBQUMsYUFBYSxDQUFxQjtJQUMxQyxPQUFPLENBQUMsWUFBWSxDQUF1RDtJQUUzRSxPQUFPLENBQUMsV0FBVyxDQUFnQztJQUNuRCxTQUFTLENBQUMsV0FBVyxFQUFFLHdCQUF3QixHQUFHLFNBQVMsQ0FBQztJQUk1RCxPQUFPLENBQUMsaUJBQWlCLENBQTBCO0lBRW5ELFlBQ21CLFlBQVksRUFBRSx1QkFBdUIsRUFDckMsYUFBYSxFQUFFLGFBQWEsR0FBRyxtQkFBbUIsRUFDbEQsTUFBTSxFQUFFLGdCQUFnQixFQUNqQyxlQUFlLDRCQUFzRCxFQUM1RCxHQUFHLEdBQUUsTUFBb0MsRUFTM0Q7SUFFTSxZQUFZLElBQUksd0JBQXdCLENBRTlDO0lBRU0sV0FBVyxDQUFDLFdBQVcsRUFBRSxXQUFXLEdBQUcsd0JBQXdCLENBRXJFO0lBRVksbUJBQW1CLENBQUMsV0FBVyxFQUFFLFdBQVcsRUFBRSxTQUFTLEVBQUUsU0FBUyxHQUFHLE9BQU8sQ0FBQyx3QkFBd0IsQ0FBQyxDQXNDbEg7SUFFTSxJQUFJLENBQUMsV0FBVyxDQUFDLEVBQUUsV0FBVyxFQUFFLElBQUksQ0FBQyxFQUFFO1FBQUUsWUFBWSxDQUFDLEVBQUUsTUFBTSxDQUFBO0tBQUUsR0FBRyxPQUFPLENBQUMseUJBQXlCLENBQUMsQ0FFM0c7SUFFTSxRQUFRLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxPQUFPLENBQUMsRUFBRSxPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsZ0JBQWdCLEVBQUUsVUFBVSxDQUFDLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FFbEg7SUFFTSxLQUFLLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxDQUU1QjtJQUVZLEtBQUssd0ZBNEJqQjtJQUVELFNBQVMsQ0FBQyxpQkFBaUIsSUFBSSx3QkFBd0IsQ0FPdEQ7SUFFWSxJQUFJLGtCQU9oQjtJQUVZLE1BQU0sSUFBSSxPQUFPLENBQUMsNEJBQTRCLENBQUMsQ0FhM0Q7SUFFWSxvQkFBb0IseUJBRWhDO0lBRVksUUFBUSxrQkFJcEI7SUFFTSxVQUFVLFNBT2hCO0lBRUQ7Ozs7O09BS0c7SUFDVSxhQUFhLENBQUMsaUJBQWlCLENBQUMsRUFBRSxXQUFXLEVBQUUsU0FBUyxDQUFDLEVBQUUsU0FBUyxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0EyRXZHO0lBRUQsb0dBQW9HO0lBQ3ZGLGNBQWMsQ0FBQyxNQUFNLEVBQUUsV0FBVyxHQUFHLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBSzVFO0lBRUQ7Ozs7T0FJRztJQUNVLFNBQVMsSUFBSSxPQUFPLENBQUMsY0FBYyxDQUFDLENBdUJoRDtJQUVELG9EQUFvRDtJQUN2QyxzQkFBc0IsQ0FBQyxLQUFLLEVBQUUsa0JBQWtCLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQXdCNUU7WUFPYSxjQUFjO1lBNkNkLHdCQUF3QjtJQVN0Qzs7Ozs7T0FLRztJQUNILFVBQWdCLGFBQWEsQ0FBQyxPQUFPLEVBQUUsT0FBTyxFQUFFLGNBQWMsRUFBRSxFQUFFLEVBQUUsR0FBRyxPQUFPLENBQUMsb0JBQW9CLENBQUMsQ0FnQm5HO1lBRWEsb0JBQW9CO0lBdURsQyxPQUFPLENBQUMsaUJBQWlCO1lBTVgsaUJBQWlCO0lBUy9COzs7T0FHRztJQUNILE9BQU8sQ0FBQyxlQUFlO0NBSXhCIn0=
@@ -0,0 +1 @@
1
+ {"version":3,"file":"server_world_state_synchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/server_world_state_synchronizer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAoB,MAAM,sCAAsC,CAAC;AACrF,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,qCAAqC,CAAC;AAC9D,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,4BAA4B,CAAC;AAGvE,OAAO,EACL,KAAK,SAAS,EACd,wBAAwB,EACxB,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,8BAA8B,EACnC,KAAK,cAAc,EACpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAGL,KAAK,sBAAsB,EAC3B,KAAK,4BAA4B,EAClC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAgB,KAAK,wBAAwB,EAAE,KAAK,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAGvH,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AACnF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGpD,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAEjC;;;;GAIG;AACH,qBAAa,4BACX,YAAW,sBAAsB,EAAE,8BAA8B,EAAE,yBAAyB;IAgB1F,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAlBtB,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA2B;IAE/D,OAAO,CAAC,wBAAwB,CAAoB;IACpD,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,YAAY,CAAuD;IAE3E,OAAO,CAAC,WAAW,CAAgC;IACnD,SAAS,CAAC,WAAW,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAI5D,OAAO,CAAC,iBAAiB,CAA0B;IAEnD,YACmB,YAAY,EAAE,uBAAuB,EACrC,aAAa,EAAE,aAAa,GAAG,mBAAmB,EAClD,MAAM,EAAE,gBAAgB,EACjC,eAAe,4BAAsD,EAC5D,GAAG,GAAE,MAAoC,EAS3D;IAEM,YAAY,IAAI,wBAAwB,CAE9C;IAEM,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,wBAAwB,CAErE;IAEY,mBAAmB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAsClH;IAEM,IAAI,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAE3G;IAEM,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC,CAElH;IAEM,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAE5B;IAEY,KAAK,wFA4BjB;IAED,SAAS,CAAC,iBAAiB,IAAI,wBAAwB,CAOtD;IAEY,IAAI,kBAOhB;IAEY,MAAM,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAa3D;IAEY,oBAAoB,yBAEhC;IAEY,QAAQ,kBAIpB;IAEM,UAAU,SAOhB;IAED;;;;;OAKG;IACU,aAAa,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CA2EvG;IAED,oGAAoG;IACvF,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAK5E;IAED;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC,CAuBhD;IAED,oDAAoD;IACvC,sBAAsB,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB5E;YAOa,cAAc;YA6Cd,wBAAwB;IAStC;;;;;OAKG;IACH,UAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAgBnG;YAEa,oBAAoB;IAuDlC,OAAO,CAAC,iBAAiB;YAMX,iBAAiB;IAS/B;;;OAGG;IACH,OAAO,CAAC,eAAe;CAIxB"}