@aztec/archiver 0.0.1-commit.9b94fc1 → 0.0.1-commit.9ee6fcc6

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 (211) hide show
  1. package/README.md +156 -22
  2. package/dest/archiver.d.ts +138 -0
  3. package/dest/archiver.d.ts.map +1 -0
  4. package/dest/archiver.js +743 -0
  5. package/dest/config.d.ts +30 -0
  6. package/dest/config.d.ts.map +1 -0
  7. package/dest/{archiver/config.js → config.js} +23 -6
  8. package/dest/errors.d.ts +53 -0
  9. package/dest/errors.d.ts.map +1 -0
  10. package/dest/errors.js +75 -0
  11. package/dest/factory.d.ts +8 -7
  12. package/dest/factory.d.ts.map +1 -1
  13. package/dest/factory.js +99 -15
  14. package/dest/index.d.ts +11 -4
  15. package/dest/index.d.ts.map +1 -1
  16. package/dest/index.js +9 -3
  17. package/dest/interfaces.d.ts +9 -0
  18. package/dest/interfaces.d.ts.map +1 -0
  19. package/dest/interfaces.js +3 -0
  20. package/dest/l1/bin/retrieve-calldata.d.ts +3 -0
  21. package/dest/l1/bin/retrieve-calldata.d.ts.map +1 -0
  22. package/dest/l1/bin/retrieve-calldata.js +152 -0
  23. package/dest/l1/calldata_retriever.d.ts +135 -0
  24. package/dest/l1/calldata_retriever.d.ts.map +1 -0
  25. package/dest/l1/calldata_retriever.js +402 -0
  26. package/dest/l1/data_retrieval.d.ts +88 -0
  27. package/dest/l1/data_retrieval.d.ts.map +1 -0
  28. package/dest/{archiver → l1}/data_retrieval.js +83 -155
  29. package/dest/l1/debug_tx.d.ts +19 -0
  30. package/dest/l1/debug_tx.d.ts.map +1 -0
  31. package/dest/l1/debug_tx.js +73 -0
  32. package/dest/l1/spire_proposer.d.ts +70 -0
  33. package/dest/l1/spire_proposer.d.ts.map +1 -0
  34. package/dest/l1/spire_proposer.js +149 -0
  35. package/dest/l1/trace_tx.d.ts +97 -0
  36. package/dest/l1/trace_tx.d.ts.map +1 -0
  37. package/dest/l1/trace_tx.js +91 -0
  38. package/dest/l1/types.d.ts +12 -0
  39. package/dest/l1/types.d.ts.map +1 -0
  40. package/dest/l1/types.js +3 -0
  41. package/dest/l1/validate_trace.d.ts +32 -0
  42. package/dest/l1/validate_trace.d.ts.map +1 -0
  43. package/dest/l1/validate_trace.js +154 -0
  44. package/dest/modules/data_source_base.d.ts +89 -0
  45. package/dest/modules/data_source_base.d.ts.map +1 -0
  46. package/dest/modules/data_source_base.js +216 -0
  47. package/dest/modules/data_store_updater.d.ts +85 -0
  48. package/dest/modules/data_store_updater.d.ts.map +1 -0
  49. package/dest/modules/data_store_updater.js +324 -0
  50. package/dest/modules/instrumentation.d.ts +50 -0
  51. package/dest/modules/instrumentation.d.ts.map +1 -0
  52. package/dest/{archiver → modules}/instrumentation.js +49 -62
  53. package/dest/modules/l1_synchronizer.d.ts +72 -0
  54. package/dest/modules/l1_synchronizer.d.ts.map +1 -0
  55. package/dest/modules/l1_synchronizer.js +1147 -0
  56. package/dest/modules/validation.d.ts +17 -0
  57. package/dest/modules/validation.d.ts.map +1 -0
  58. package/dest/{archiver → modules}/validation.js +7 -1
  59. package/dest/store/block_store.d.ts +195 -0
  60. package/dest/store/block_store.d.ts.map +1 -0
  61. package/dest/store/block_store.js +773 -0
  62. package/dest/store/contract_class_store.d.ts +17 -0
  63. package/dest/store/contract_class_store.d.ts.map +1 -0
  64. package/dest/store/contract_class_store.js +64 -0
  65. package/dest/store/contract_instance_store.d.ts +24 -0
  66. package/dest/store/contract_instance_store.d.ts.map +1 -0
  67. package/dest/{archiver/kv_archiver_store → store}/contract_instance_store.js +7 -3
  68. package/dest/store/kv_archiver_store.d.ts +364 -0
  69. package/dest/store/kv_archiver_store.d.ts.map +1 -0
  70. package/dest/store/kv_archiver_store.js +477 -0
  71. package/dest/store/l2_tips_cache.d.ts +19 -0
  72. package/dest/store/l2_tips_cache.d.ts.map +1 -0
  73. package/dest/store/l2_tips_cache.js +89 -0
  74. package/dest/store/log_store.d.ts +57 -0
  75. package/dest/store/log_store.d.ts.map +1 -0
  76. package/dest/store/log_store.js +533 -0
  77. package/dest/store/message_store.d.ts +44 -0
  78. package/dest/store/message_store.d.ts.map +1 -0
  79. package/dest/{archiver/kv_archiver_store → store}/message_store.js +29 -15
  80. package/dest/{archiver/structs → structs}/data_retrieval.d.ts +1 -1
  81. package/dest/structs/data_retrieval.d.ts.map +1 -0
  82. package/dest/structs/inbox_message.d.ts +15 -0
  83. package/dest/structs/inbox_message.d.ts.map +1 -0
  84. package/dest/{archiver/structs → structs}/inbox_message.js +6 -5
  85. package/dest/structs/published.d.ts +2 -0
  86. package/dest/structs/published.d.ts.map +1 -0
  87. package/dest/test/fake_l1_state.d.ts +202 -0
  88. package/dest/test/fake_l1_state.d.ts.map +1 -0
  89. package/dest/test/fake_l1_state.js +455 -0
  90. package/dest/test/index.d.ts +2 -1
  91. package/dest/test/index.d.ts.map +1 -1
  92. package/dest/test/index.js +4 -1
  93. package/dest/test/mock_archiver.d.ts +16 -8
  94. package/dest/test/mock_archiver.d.ts.map +1 -1
  95. package/dest/test/mock_archiver.js +19 -14
  96. package/dest/test/mock_l1_to_l2_message_source.d.ts +7 -6
  97. package/dest/test/mock_l1_to_l2_message_source.d.ts.map +1 -1
  98. package/dest/test/mock_l1_to_l2_message_source.js +21 -11
  99. package/dest/test/mock_l2_block_source.d.ts +54 -20
  100. package/dest/test/mock_l2_block_source.d.ts.map +1 -1
  101. package/dest/test/mock_l2_block_source.js +251 -85
  102. package/dest/test/mock_structs.d.ts +83 -4
  103. package/dest/test/mock_structs.d.ts.map +1 -1
  104. package/dest/test/mock_structs.js +157 -11
  105. package/dest/test/noop_l1_archiver.d.ts +26 -0
  106. package/dest/test/noop_l1_archiver.d.ts.map +1 -0
  107. package/dest/test/noop_l1_archiver.js +72 -0
  108. package/package.json +20 -20
  109. package/src/archiver.ts +500 -0
  110. package/src/{archiver/config.ts → config.ts} +36 -13
  111. package/src/errors.ts +118 -0
  112. package/src/factory.ts +154 -17
  113. package/src/index.ts +11 -3
  114. package/src/interfaces.ts +9 -0
  115. package/src/l1/README.md +55 -0
  116. package/src/l1/bin/retrieve-calldata.ts +194 -0
  117. package/src/l1/calldata_retriever.ts +511 -0
  118. package/src/{archiver → l1}/data_retrieval.ts +143 -226
  119. package/src/l1/debug_tx.ts +99 -0
  120. package/src/l1/spire_proposer.ts +152 -0
  121. package/src/l1/trace_tx.ts +128 -0
  122. package/src/l1/types.ts +13 -0
  123. package/src/l1/validate_trace.ts +229 -0
  124. package/src/modules/data_source_base.ts +333 -0
  125. package/src/modules/data_store_updater.ts +424 -0
  126. package/src/{archiver → modules}/instrumentation.ts +63 -66
  127. package/src/modules/l1_synchronizer.ts +967 -0
  128. package/src/{archiver → modules}/validation.ts +11 -6
  129. package/src/store/block_store.ts +1018 -0
  130. package/src/store/contract_class_store.ts +82 -0
  131. package/src/{archiver/kv_archiver_store → store}/contract_instance_store.ts +10 -7
  132. package/src/store/kv_archiver_store.ts +682 -0
  133. package/src/store/l2_tips_cache.ts +89 -0
  134. package/src/store/log_store.ts +736 -0
  135. package/src/{archiver/kv_archiver_store → store}/message_store.ts +41 -19
  136. package/src/{archiver/structs → structs}/inbox_message.ts +8 -8
  137. package/src/{archiver/structs → structs}/published.ts +0 -1
  138. package/src/test/fake_l1_state.ts +698 -0
  139. package/src/test/fixtures/debug_traceTransaction-multicall3.json +88 -0
  140. package/src/test/fixtures/debug_traceTransaction-multiplePropose.json +153 -0
  141. package/src/test/fixtures/debug_traceTransaction-proxied.json +122 -0
  142. package/src/test/fixtures/trace_transaction-multicall3.json +65 -0
  143. package/src/test/fixtures/trace_transaction-multiplePropose.json +319 -0
  144. package/src/test/fixtures/trace_transaction-proxied.json +128 -0
  145. package/src/test/fixtures/trace_transaction-randomRevert.json +216 -0
  146. package/src/test/index.ts +4 -0
  147. package/src/test/mock_archiver.ts +23 -16
  148. package/src/test/mock_l1_to_l2_message_source.ts +18 -11
  149. package/src/test/mock_l2_block_source.ts +311 -93
  150. package/src/test/mock_structs.ts +289 -13
  151. package/src/test/noop_l1_archiver.ts +115 -0
  152. package/dest/archiver/archiver.d.ts +0 -287
  153. package/dest/archiver/archiver.d.ts.map +0 -1
  154. package/dest/archiver/archiver.js +0 -1408
  155. package/dest/archiver/archiver_store.d.ts +0 -255
  156. package/dest/archiver/archiver_store.d.ts.map +0 -1
  157. package/dest/archiver/archiver_store.js +0 -4
  158. package/dest/archiver/archiver_store_test_suite.d.ts +0 -8
  159. package/dest/archiver/archiver_store_test_suite.d.ts.map +0 -1
  160. package/dest/archiver/archiver_store_test_suite.js +0 -1289
  161. package/dest/archiver/config.d.ts +0 -21
  162. package/dest/archiver/config.d.ts.map +0 -1
  163. package/dest/archiver/data_retrieval.d.ts +0 -79
  164. package/dest/archiver/data_retrieval.d.ts.map +0 -1
  165. package/dest/archiver/errors.d.ts +0 -12
  166. package/dest/archiver/errors.d.ts.map +0 -1
  167. package/dest/archiver/errors.js +0 -17
  168. package/dest/archiver/index.d.ts +0 -7
  169. package/dest/archiver/index.d.ts.map +0 -1
  170. package/dest/archiver/index.js +0 -4
  171. package/dest/archiver/instrumentation.d.ts +0 -35
  172. package/dest/archiver/instrumentation.d.ts.map +0 -1
  173. package/dest/archiver/kv_archiver_store/block_store.d.ts +0 -124
  174. package/dest/archiver/kv_archiver_store/block_store.d.ts.map +0 -1
  175. package/dest/archiver/kv_archiver_store/block_store.js +0 -370
  176. package/dest/archiver/kv_archiver_store/contract_class_store.d.ts +0 -18
  177. package/dest/archiver/kv_archiver_store/contract_class_store.d.ts.map +0 -1
  178. package/dest/archiver/kv_archiver_store/contract_class_store.js +0 -120
  179. package/dest/archiver/kv_archiver_store/contract_instance_store.d.ts +0 -24
  180. package/dest/archiver/kv_archiver_store/contract_instance_store.d.ts.map +0 -1
  181. package/dest/archiver/kv_archiver_store/kv_archiver_store.d.ts +0 -168
  182. package/dest/archiver/kv_archiver_store/kv_archiver_store.d.ts.map +0 -1
  183. package/dest/archiver/kv_archiver_store/kv_archiver_store.js +0 -296
  184. package/dest/archiver/kv_archiver_store/log_store.d.ts +0 -49
  185. package/dest/archiver/kv_archiver_store/log_store.d.ts.map +0 -1
  186. package/dest/archiver/kv_archiver_store/log_store.js +0 -336
  187. package/dest/archiver/kv_archiver_store/message_store.d.ts +0 -39
  188. package/dest/archiver/kv_archiver_store/message_store.d.ts.map +0 -1
  189. package/dest/archiver/structs/data_retrieval.d.ts.map +0 -1
  190. package/dest/archiver/structs/inbox_message.d.ts +0 -15
  191. package/dest/archiver/structs/inbox_message.d.ts.map +0 -1
  192. package/dest/archiver/structs/published.d.ts +0 -3
  193. package/dest/archiver/structs/published.d.ts.map +0 -1
  194. package/dest/archiver/validation.d.ts +0 -17
  195. package/dest/archiver/validation.d.ts.map +0 -1
  196. package/dest/rpc/index.d.ts +0 -9
  197. package/dest/rpc/index.d.ts.map +0 -1
  198. package/dest/rpc/index.js +0 -15
  199. package/src/archiver/archiver.ts +0 -1858
  200. package/src/archiver/archiver_store.ts +0 -305
  201. package/src/archiver/archiver_store_test_suite.ts +0 -1264
  202. package/src/archiver/errors.ts +0 -26
  203. package/src/archiver/index.ts +0 -6
  204. package/src/archiver/kv_archiver_store/block_store.ts +0 -481
  205. package/src/archiver/kv_archiver_store/contract_class_store.ts +0 -176
  206. package/src/archiver/kv_archiver_store/kv_archiver_store.ts +0 -422
  207. package/src/archiver/kv_archiver_store/log_store.ts +0 -406
  208. package/src/rpc/index.ts +0 -16
  209. /package/dest/{archiver/structs → structs}/data_retrieval.js +0 -0
  210. /package/dest/{archiver/structs → structs}/published.js +0 -0
  211. /package/src/{archiver/structs → structs}/data_retrieval.ts +0 -0
package/src/errors.ts ADDED
@@ -0,0 +1,118 @@
1
+ import type { Fr } from '@aztec/foundation/schemas';
2
+
3
+ export class NoBlobBodiesFoundError extends Error {
4
+ constructor(l2BlockNum: number) {
5
+ super(`No blob bodies found for block ${l2BlockNum}`);
6
+ }
7
+ }
8
+
9
+ export class BlockNumberNotSequentialError extends Error {
10
+ constructor(newBlockNumber: number, previous: number | undefined) {
11
+ super(`Cannot insert new block ${newBlockNumber} given previous block number is ${previous ?? 'undefined'}`);
12
+ }
13
+ }
14
+
15
+ export class InitialCheckpointNumberNotSequentialError extends Error {
16
+ constructor(
17
+ public readonly newCheckpointNumber: number,
18
+ public readonly previousCheckpointNumber: number | undefined,
19
+ ) {
20
+ super(
21
+ `Cannot insert new checkpoint ${newCheckpointNumber} given previous checkpoint number in store is ${
22
+ previousCheckpointNumber ?? 'undefined'
23
+ }`,
24
+ );
25
+ }
26
+ }
27
+
28
+ export class CheckpointNumberNotSequentialError extends Error {
29
+ constructor(newCheckpointNumber: number, previous: number | undefined) {
30
+ super(
31
+ `Cannot insert new checkpoint ${newCheckpointNumber} given previous checkpoint number in batch is ${previous ?? 'undefined'}`,
32
+ );
33
+ }
34
+ }
35
+
36
+ export class BlockIndexNotSequentialError extends Error {
37
+ constructor(newBlockIndex: number, previousBlockIndex: number | undefined) {
38
+ super(
39
+ `Cannot insert new block at checkpoint index ${newBlockIndex} given previous block index is ${previousBlockIndex ?? 'undefined'}`,
40
+ );
41
+ }
42
+ }
43
+
44
+ export class BlockArchiveNotConsistentError extends Error {
45
+ constructor(
46
+ newBlockNumber: number,
47
+ previousBlockNumber: number | undefined,
48
+ newBlockArchive: Fr,
49
+ previousBlockArchive: Fr,
50
+ ) {
51
+ super(
52
+ `Cannot insert new block number ${newBlockNumber} with archive ${newBlockArchive.toString()} previous block number is ${previousBlockNumber ?? 'undefined'}, previous archive is ${previousBlockArchive?.toString() ?? 'undefined'}`,
53
+ );
54
+ }
55
+ }
56
+
57
+ export class CheckpointNotFoundError extends Error {
58
+ constructor(checkpointNumber: number) {
59
+ super(`Failed to find expected checkpoint number ${checkpointNumber}`);
60
+ }
61
+ }
62
+
63
+ export class BlockNotFoundError extends Error {
64
+ constructor(blockNumber: number) {
65
+ super(`Failed to find expected block number ${blockNumber}`);
66
+ }
67
+ }
68
+
69
+ /** Thrown when a proposed block matches a block that was already checkpointed. This is expected for late proposals. */
70
+ export class BlockAlreadyCheckpointedError extends Error {
71
+ constructor(public readonly blockNumber: number) {
72
+ super(`Block ${blockNumber} has already been checkpointed with the same content`);
73
+ this.name = 'BlockAlreadyCheckpointedError';
74
+ }
75
+ }
76
+
77
+ /** Thrown when logs are added for a tag whose last stored log has a higher block number than the new log. */
78
+ export class OutOfOrderLogInsertionError extends Error {
79
+ constructor(
80
+ public readonly logType: 'private' | 'public',
81
+ public readonly tag: string,
82
+ public readonly lastBlockNumber: number,
83
+ public readonly newBlockNumber: number,
84
+ ) {
85
+ super(
86
+ `Out-of-order ${logType} log insertion for tag ${tag}: ` +
87
+ `last existing log is from block ${lastBlockNumber} but new log is from block ${newBlockNumber}`,
88
+ );
89
+ this.name = 'OutOfOrderLogInsertionError';
90
+ }
91
+ }
92
+
93
+ /** Thrown when L1 to L2 messages are requested for a checkpoint whose message tree hasn't been sealed yet. */
94
+ export class L1ToL2MessagesNotReadyError extends Error {
95
+ constructor(
96
+ public readonly checkpointNumber: number,
97
+ public readonly inboxTreeInProgress: bigint,
98
+ ) {
99
+ super(
100
+ `Cannot get L1 to L2 messages for checkpoint ${checkpointNumber}: ` +
101
+ `inbox tree in progress is ${inboxTreeInProgress}, messages not yet sealed`,
102
+ );
103
+ this.name = 'L1ToL2MessagesNotReadyError';
104
+ }
105
+ }
106
+
107
+ /** Thrown when a proposed block conflicts with an already checkpointed block (different content). */
108
+ export class CannotOverwriteCheckpointedBlockError extends Error {
109
+ constructor(
110
+ public readonly blockNumber: number,
111
+ public readonly lastCheckpointedBlock: number,
112
+ ) {
113
+ super(
114
+ `Cannot add block ${blockNumber}: would overwrite checkpointed data (checkpointed up to block ${lastCheckpointedBlock})`,
115
+ );
116
+ this.name = 'CannotOverwriteCheckpointedBlockError';
117
+ }
118
+ }
package/src/factory.ts CHANGED
@@ -1,14 +1,31 @@
1
- import { createLogger } from '@aztec/foundation/log';
2
- import type { DataStoreConfig } from '@aztec/kv-store/config';
1
+ import { EpochCache } from '@aztec/epoch-cache';
2
+ import { createEthereumChain } from '@aztec/ethereum/chain';
3
+ import { makeL1HttpTransport } from '@aztec/ethereum/client';
4
+ import { InboxContract, RollupContract } from '@aztec/ethereum/contracts';
5
+ import type { ViemPublicDebugClient } from '@aztec/ethereum/types';
6
+ import { BlockNumber } from '@aztec/foundation/branded-types';
7
+ import { Buffer32 } from '@aztec/foundation/buffer';
8
+ import { merge } from '@aztec/foundation/collection';
9
+ import { Fr } from '@aztec/foundation/curves/bn254';
10
+ import { DateProvider } from '@aztec/foundation/timer';
3
11
  import { createStore } from '@aztec/kv-store/lmdb-v2';
4
12
  import { protocolContractNames } from '@aztec/protocol-contracts';
5
13
  import { BundledProtocolContractsProvider } from '@aztec/protocol-contracts/providers/bundle';
6
14
  import { FunctionType, decodeFunctionSignature } from '@aztec/stdlib/abi';
7
- import { type ContractClassPublic, computePublicBytecodeCommitment } from '@aztec/stdlib/contract';
15
+ import type { ArchiverEmitter } from '@aztec/stdlib/block';
16
+ import { type ContractClassPublicWithCommitment, computePublicBytecodeCommitment } from '@aztec/stdlib/contract';
17
+ import type { DataStoreConfig } from '@aztec/stdlib/kv-store';
18
+ import { getTelemetryClient } from '@aztec/telemetry-client';
8
19
 
9
- import { Archiver, type ArchiverDeps } from './archiver/archiver.js';
10
- import type { ArchiverConfig } from './archiver/config.js';
11
- import { ARCHIVER_DB_VERSION, KVArchiverDataStore } from './archiver/kv_archiver_store/kv_archiver_store.js';
20
+ import { EventEmitter } from 'events';
21
+ import { createPublicClient } from 'viem';
22
+
23
+ import { Archiver, type ArchiverDeps } from './archiver.js';
24
+ import { type ArchiverConfig, mapArchiverConfig } from './config.js';
25
+ import { ArchiverInstrumentation } from './modules/instrumentation.js';
26
+ import { ArchiverL1Synchronizer } from './modules/l1_synchronizer.js';
27
+ import { ARCHIVER_DB_VERSION, KVArchiverDataStore } from './store/kv_archiver_store.js';
28
+ import { L2TipsCache } from './store/l2_tips_cache.js';
12
29
 
13
30
  export const ARCHIVER_STORE_NAME = 'archiver';
14
31
 
@@ -20,16 +37,15 @@ export async function createArchiverStore(
20
37
  ...userConfig,
21
38
  dataStoreMapSizeKb: userConfig.archiverStoreMapSizeKb ?? userConfig.dataStoreMapSizeKb,
22
39
  };
23
- const store = await createStore(ARCHIVER_STORE_NAME, ARCHIVER_DB_VERSION, config, createLogger('archiver:lmdb'));
40
+ const store = await createStore(ARCHIVER_STORE_NAME, ARCHIVER_DB_VERSION, config);
24
41
  return new KVArchiverDataStore(store, config.maxLogs);
25
42
  }
26
43
 
27
44
  /**
28
45
  * Creates a local archiver.
29
46
  * @param config - The archiver configuration.
30
- * @param blobSinkClient - The blob sink client.
47
+ * @param deps - The archiver dependencies (blobClient, epochCache, dateProvider, telemetry).
31
48
  * @param opts - The options.
32
- * @param telemetry - The telemetry client.
33
49
  * @returns The local archiver.
34
50
  */
35
51
  export async function createArchiver(
@@ -39,18 +55,140 @@ export async function createArchiver(
39
55
  ): Promise<Archiver> {
40
56
  const archiverStore = await createArchiverStore(config);
41
57
  await registerProtocolContracts(archiverStore);
42
- return Archiver.createAndSync(config, archiverStore, deps, opts.blockUntilSync);
58
+
59
+ // Create Ethereum clients
60
+ const chain = createEthereumChain(config.l1RpcUrls, config.l1ChainId);
61
+ const httpTimeout = config.l1HttpTimeoutMS;
62
+ const publicClient = createPublicClient({
63
+ chain: chain.chainInfo,
64
+ transport: makeL1HttpTransport(config.l1RpcUrls, { timeout: httpTimeout }),
65
+ pollingInterval: config.viemPollingIntervalMS,
66
+ });
67
+
68
+ // Create debug client using debug RPC URLs if available, otherwise fall back to regular RPC URLs
69
+ const debugRpcUrls = config.l1DebugRpcUrls.length > 0 ? config.l1DebugRpcUrls : config.l1RpcUrls;
70
+ const debugClient = createPublicClient({
71
+ chain: chain.chainInfo,
72
+ transport: makeL1HttpTransport(debugRpcUrls, { timeout: httpTimeout }),
73
+ pollingInterval: config.viemPollingIntervalMS,
74
+ }) as ViemPublicDebugClient;
75
+
76
+ // Create L1 contract instances
77
+ const rollup = new RollupContract(publicClient, config.l1Contracts.rollupAddress);
78
+ const inbox = new InboxContract(publicClient, config.l1Contracts.inboxAddress);
79
+
80
+ // Fetch L1 constants from rollup contract
81
+ const [
82
+ l1StartBlock,
83
+ l1GenesisTime,
84
+ proofSubmissionEpochs,
85
+ genesisArchiveRoot,
86
+ slashingProposerAddress,
87
+ targetCommitteeSize,
88
+ rollupManaLimit,
89
+ ] = await Promise.all([
90
+ rollup.getL1StartBlock(),
91
+ rollup.getL1GenesisTime(),
92
+ rollup.getProofSubmissionEpochs(),
93
+ rollup.getGenesisArchiveTreeRoot(),
94
+ rollup.getSlashingProposerAddress(),
95
+ rollup.getTargetCommitteeSize(),
96
+ rollup.getManaLimit(),
97
+ ] as const);
98
+
99
+ const l1StartBlockHash = await publicClient
100
+ .getBlock({ blockNumber: l1StartBlock, includeTransactions: false })
101
+ .then(block => Buffer32.fromString(block.hash));
102
+
103
+ const { aztecEpochDuration: epochDuration, aztecSlotDuration: slotDuration, ethereumSlotDuration } = config;
104
+
105
+ const l1Constants = {
106
+ l1StartBlockHash,
107
+ l1StartBlock,
108
+ l1GenesisTime,
109
+ epochDuration,
110
+ slotDuration,
111
+ ethereumSlotDuration,
112
+ proofSubmissionEpochs: Number(proofSubmissionEpochs),
113
+ targetCommitteeSize,
114
+ genesisArchiveRoot: Fr.fromString(genesisArchiveRoot.toString()),
115
+ rollupManaLimit: Number(rollupManaLimit),
116
+ };
117
+
118
+ const archiverConfig = merge(
119
+ {
120
+ pollingIntervalMs: 10_000,
121
+ batchSize: 100,
122
+ maxAllowedEthClientDriftSeconds: 300,
123
+ ethereumAllowNoDebugHosts: false,
124
+ },
125
+ mapArchiverConfig(config),
126
+ );
127
+
128
+ const epochCache = deps.epochCache ?? (await EpochCache.create(config.l1Contracts.rollupAddress, config, deps));
129
+ const telemetry = deps.telemetry ?? getTelemetryClient();
130
+ const instrumentation = await ArchiverInstrumentation.new(telemetry, () => archiverStore.estimateSize());
131
+
132
+ // Create the event emitter that will be shared by archiver and synchronizer
133
+ const events = new EventEmitter() as ArchiverEmitter;
134
+
135
+ // Create L2 tips cache shared by archiver and synchronizer
136
+ const l2TipsCache = new L2TipsCache(archiverStore.blockStore);
137
+
138
+ // Create the L1 synchronizer
139
+ const synchronizer = new ArchiverL1Synchronizer(
140
+ publicClient,
141
+ debugClient,
142
+ rollup,
143
+ inbox,
144
+ archiverStore,
145
+ archiverConfig,
146
+ deps.blobClient,
147
+ epochCache,
148
+ deps.dateProvider ?? new DateProvider(),
149
+ instrumentation,
150
+ l1Constants,
151
+ events,
152
+ instrumentation.tracer,
153
+ l2TipsCache,
154
+ undefined, // log (use default)
155
+ );
156
+
157
+ const archiver = new Archiver(
158
+ publicClient,
159
+ debugClient,
160
+ rollup,
161
+ { ...config.l1Contracts, slashingProposerAddress },
162
+ archiverStore,
163
+ archiverConfig,
164
+ deps.blobClient,
165
+ instrumentation,
166
+ l1Constants,
167
+ synchronizer,
168
+ events,
169
+ l2TipsCache,
170
+ );
171
+
172
+ await archiver.start(opts.blockUntilSync);
173
+ return archiver;
43
174
  }
44
175
 
45
- async function registerProtocolContracts(store: KVArchiverDataStore) {
176
+ /** Registers protocol contracts in the archiver store. Idempotent — skips contracts that already exist (e.g. on node restart). */
177
+ export async function registerProtocolContracts(store: KVArchiverDataStore) {
46
178
  const blockNumber = 0;
47
179
  for (const name of protocolContractNames) {
48
180
  const provider = new BundledProtocolContractsProvider();
49
181
  const contract = await provider.getProtocolContractArtifact(name);
50
- const contractClassPublic: ContractClassPublic = {
182
+
183
+ // Skip if already registered (happens on node restart with a persisted store).
184
+ if (await store.getContractClass(contract.contractClass.id)) {
185
+ continue;
186
+ }
187
+
188
+ const publicBytecodeCommitment = await computePublicBytecodeCommitment(contract.contractClass.packedBytecode);
189
+ const contractClassPublic: ContractClassPublicWithCommitment = {
51
190
  ...contract.contractClass,
52
- privateFunctions: [],
53
- utilityFunctions: [],
191
+ publicBytecodeCommitment,
54
192
  };
55
193
 
56
194
  const publicFunctionSignatures = contract.artifact.functions
@@ -58,8 +196,7 @@ async function registerProtocolContracts(store: KVArchiverDataStore) {
58
196
  .map(fn => decodeFunctionSignature(fn.name, fn.parameters));
59
197
 
60
198
  await store.registerContractFunctionSignatures(publicFunctionSignatures);
61
- const bytecodeCommitment = await computePublicBytecodeCommitment(contractClassPublic.packedBytecode);
62
- await store.addContractClasses([contractClassPublic], [bytecodeCommitment], blockNumber);
63
- await store.addContractInstances([contract.instance], blockNumber);
199
+ await store.addContractClasses([contractClassPublic], BlockNumber(blockNumber));
200
+ await store.addContractInstances([contract.instance], BlockNumber(blockNumber));
64
201
  }
65
202
  }
package/src/index.ts CHANGED
@@ -1,5 +1,13 @@
1
- export * from './archiver/index.js';
2
1
  export * from './factory.js';
3
- export * from './rpc/index.js';
2
+ export * from './interfaces.js';
3
+ export * from './archiver.js';
4
+ export * from './modules/data_source_base.js';
5
+ export * from './modules/data_store_updater.js';
6
+ export * from './config.js';
4
7
 
5
- export { retrieveL2ProofVerifiedEvents } from './archiver/data_retrieval.js';
8
+ export { type L1PublishedData } from './structs/published.js';
9
+ export { KVArchiverDataStore, ARCHIVER_DB_VERSION } from './store/kv_archiver_store.js';
10
+ export { ContractInstanceStore } from './store/contract_instance_store.js';
11
+ export { L2TipsCache } from './store/l2_tips_cache.js';
12
+
13
+ export { retrieveCheckpointsFromRollup, retrieveL2ProofVerifiedEvents } from './l1/data_retrieval.js';
@@ -0,0 +1,9 @@
1
+ import type { L2BlockSource } from '@aztec/stdlib/block';
2
+ import type { ContractDataSource } from '@aztec/stdlib/contract';
3
+ import type { L2LogsSource } from '@aztec/stdlib/interfaces/server';
4
+ import type { L1ToL2MessageSource } from '@aztec/stdlib/messaging';
5
+
6
+ /**
7
+ * Helper interface to combine all sources this archiver implementation provides.
8
+ */
9
+ export type ArchiverDataSource = L2BlockSource & L2LogsSource & ContractDataSource & L1ToL2MessageSource;
@@ -0,0 +1,55 @@
1
+ # Archiver L1 Data Retrieval
2
+
3
+ Modules and classes to handle data retrieval from L1 for the archiver.
4
+
5
+ ## Calldata Retriever
6
+
7
+ The sequencer publisher bundles multiple operations into a single multicall3 transaction for gas
8
+ efficiency. The archiver needs to extract the `propose` calldata from these bundled transactions
9
+ to reconstruct L2 blocks.
10
+
11
+ The retriever uses hash matching against `attestationsHash` and `payloadDigest` from the
12
+ `CheckpointProposed` L1 event to verify it has found the correct propose calldata. These hashes
13
+ are always required.
14
+
15
+ ### Multicall3 Decoding with Hash Matching
16
+
17
+ First attempt to decode the transaction as a multicall3 `aggregate3` call:
18
+
19
+ - Check if transaction is to multicall3 address (`0xcA11bde05977b3631167028862bE2a173976CA11`)
20
+ - Decode as `aggregate3(Call3[] calldata calls)`
21
+ - Find all calls matching the rollup contract address and the `propose` function selector
22
+ - Verify each candidate by computing `attestationsHash` (keccak256 of ABI-encoded attestations)
23
+ and `payloadDigest` (keccak256 of the consensus payload signing hash) and comparing against
24
+ expected values from the `CheckpointProposed` event
25
+ - Return the verified candidate (if multiple verify, return the first with a warning)
26
+
27
+ This approach works regardless of what other calls are in the multicall3 bundle, because hash
28
+ matching identifies the correct propose call without needing an allowlist.
29
+
30
+ ### Direct Propose Call
31
+
32
+ Second attempt to decode the transaction as a direct `propose` call to the rollup contract:
33
+
34
+ - Check if transaction is to the rollup address
35
+ - Decode as `propose` function call
36
+ - Verify against expected hashes
37
+ - Return the transaction input as the propose calldata
38
+
39
+ ### Spire Proposer Call
40
+
41
+ Given existing attempts to route the call via the Spire proposer, we also check if the tx is
42
+ `to` the proposer known address. If so, we extract all wrapped calls and try each as either
43
+ a multicall3 or direct propose call, using hash matching to find and verify the correct one.
44
+
45
+ Since the Spire proposer is upgradeable, we check that the implementation has not changed in
46
+ order to decode. Any validation failure triggers fallback to the next step.
47
+
48
+ ### Debug and Trace Transaction Fallback
49
+
50
+ Last, we use L1 node's trace/debug RPC methods to definitively identify the one successful
51
+ `propose` call within the tx. We can then extract the exact calldata that hit the `propose`
52
+ function in the rollup contract.
53
+
54
+ This approach requires access to a debug-enabled L1 node, which may be more resource-intensive,
55
+ so we only use it as a fallback when earlier steps fail, which should be rare in practice.
@@ -0,0 +1,194 @@
1
+ #!/usr/bin/env node
2
+ import type { ViemPublicClient, ViemPublicDebugClient } from '@aztec/ethereum/types';
3
+ import { CheckpointNumber } from '@aztec/foundation/branded-types';
4
+ import { EthAddress } from '@aztec/foundation/eth-address';
5
+ import { createLogger } from '@aztec/foundation/log';
6
+ import { RollupAbi } from '@aztec/l1-artifacts/RollupAbi';
7
+
8
+ import { type Hex, createPublicClient, decodeEventLog, getAbiItem, http, toEventSelector } from 'viem';
9
+ import { mainnet } from 'viem/chains';
10
+
11
+ import { CalldataRetriever } from '../calldata_retriever.js';
12
+
13
+ const logger = createLogger('archiver:calldata-test');
14
+
15
+ interface ScriptArgs {
16
+ rollupAddress: EthAddress;
17
+ txHash: Hex;
18
+ rpcUrl: string;
19
+ targetCommitteeSize: number;
20
+ }
21
+
22
+ function parseArgs(): ScriptArgs {
23
+ const args = process.argv.slice(2);
24
+
25
+ if (args.length < 2) {
26
+ // eslint-disable-next-line no-console
27
+ console.error('Usage: node index.js <rollup-address> <tx-hash> [target-committee-size]');
28
+ // eslint-disable-next-line no-console
29
+ console.error('');
30
+ // eslint-disable-next-line no-console
31
+ console.error('Environment variables:');
32
+ // eslint-disable-next-line no-console
33
+ console.error(' ETHEREUM_HOST or RPC_URL - Ethereum RPC endpoint');
34
+ // eslint-disable-next-line no-console
35
+ console.error('');
36
+ // eslint-disable-next-line no-console
37
+ console.error('Example:');
38
+ // eslint-disable-next-line no-console
39
+ console.error(' RPC_URL=https://eth-mainnet.g.alchemy.com/v2/YOUR-API-KEY \\');
40
+ // eslint-disable-next-line no-console
41
+ console.error(' node index.js 0x1234... 0xabcd... 32');
42
+ process.exit(1);
43
+ }
44
+
45
+ const rollupAddress = EthAddress.fromString(args[0]);
46
+ const txHash = args[1] as Hex;
47
+ const targetCommitteeSize = args[2] ? parseInt(args[2], 10) : 24;
48
+
49
+ const rpcUrl = process.env.ETHEREUM_HOST || process.env.RPC_URL;
50
+ if (!rpcUrl) {
51
+ // eslint-disable-next-line no-console
52
+ console.error('Error: ETHEREUM_HOST or RPC_URL environment variable must be set');
53
+ process.exit(1);
54
+ }
55
+
56
+ if (targetCommitteeSize <= 0 || targetCommitteeSize > 256) {
57
+ // eslint-disable-next-line no-console
58
+ console.error('Error: target-committee-size must be between 1 and 256');
59
+ process.exit(1);
60
+ }
61
+
62
+ return { rollupAddress, txHash, rpcUrl, targetCommitteeSize };
63
+ }
64
+
65
+ async function main() {
66
+ const { rollupAddress, txHash, rpcUrl, targetCommitteeSize } = parseArgs();
67
+
68
+ logger.info('Calldata Retriever Test Script');
69
+ logger.info('===============================');
70
+ logger.info(`Rollup Address: ${rollupAddress.toString()}`);
71
+ logger.info(`Transaction Hash: ${txHash}`);
72
+ logger.info(`RPC URL: ${rpcUrl}`);
73
+ logger.info(`Target Committee Size: ${targetCommitteeSize}`);
74
+ logger.info('');
75
+
76
+ try {
77
+ // Create viem public client
78
+ const publicClient = createPublicClient({
79
+ chain: mainnet,
80
+ transport: http(rpcUrl, { batch: false }),
81
+ });
82
+
83
+ logger.info('Fetching transaction...');
84
+ const tx = await publicClient.getTransaction({ hash: txHash });
85
+
86
+ if (!tx) {
87
+ throw new Error(`Transaction ${txHash} not found`);
88
+ }
89
+
90
+ logger.info(`Transaction found in block ${tx.blockNumber}`);
91
+
92
+ // Create CalldataRetriever
93
+ const retriever = new CalldataRetriever(
94
+ publicClient as unknown as ViemPublicClient,
95
+ publicClient as unknown as ViemPublicDebugClient,
96
+ targetCommitteeSize,
97
+ undefined,
98
+ logger,
99
+ rollupAddress,
100
+ );
101
+
102
+ // Extract checkpoint number and hashes from transaction logs
103
+ logger.info('Decoding transaction to extract checkpoint number and hashes...');
104
+ const receipt = await publicClient.getTransactionReceipt({ hash: txHash });
105
+
106
+ // Look for CheckpointProposed event
107
+ const checkpointProposedEventAbi = getAbiItem({ abi: RollupAbi, name: 'CheckpointProposed' });
108
+ const checkpointProposedLog = receipt.logs.find(log => {
109
+ try {
110
+ return (
111
+ log.address.toLowerCase() === rollupAddress.toString().toLowerCase() &&
112
+ log.topics[0] === toEventSelector(checkpointProposedEventAbi)
113
+ );
114
+ } catch {
115
+ return false;
116
+ }
117
+ });
118
+
119
+ if (!checkpointProposedLog || checkpointProposedLog.topics[1] === undefined) {
120
+ throw new Error(`Checkpoint proposed event not found`);
121
+ }
122
+
123
+ const checkpointNumber = CheckpointNumber.fromBigInt(BigInt(checkpointProposedLog.topics[1]));
124
+
125
+ // Decode the full event to extract attestationsHash and payloadDigest
126
+ const decodedEvent = decodeEventLog({
127
+ abi: RollupAbi,
128
+ data: checkpointProposedLog.data,
129
+ topics: checkpointProposedLog.topics,
130
+ });
131
+
132
+ const eventArgs = decodedEvent.args as {
133
+ checkpointNumber: bigint;
134
+ archive: Hex;
135
+ versionedBlobHashes: Hex[];
136
+ attestationsHash: Hex;
137
+ payloadDigest: Hex;
138
+ };
139
+
140
+ if (!eventArgs.attestationsHash || !eventArgs.payloadDigest) {
141
+ throw new Error(`CheckpointProposed event missing attestationsHash or payloadDigest`);
142
+ }
143
+
144
+ const expectedHashes = {
145
+ attestationsHash: eventArgs.attestationsHash,
146
+ payloadDigest: eventArgs.payloadDigest,
147
+ };
148
+
149
+ logger.info(`Checkpoint Number: ${checkpointNumber}`);
150
+ logger.info(`Attestations Hash: ${expectedHashes.attestationsHash}`);
151
+ logger.info(`Payload Digest: ${expectedHashes.payloadDigest}`);
152
+
153
+ logger.info('');
154
+ logger.info('Retrieving checkpoint from rollup transaction...');
155
+ logger.info('');
156
+
157
+ const result = await retriever.getCheckpointFromRollupTx(txHash, [], checkpointNumber, expectedHashes);
158
+
159
+ logger.info(' Successfully retrieved block header!');
160
+ logger.info('');
161
+ logger.info('Block Header Details:');
162
+ logger.info('====================');
163
+ logger.info(`Checkpoint Number: ${result.checkpointNumber}`);
164
+ logger.info(`Block Hash: ${result.blockHash}`);
165
+ logger.info(`Archive Root: ${result.archiveRoot.toString()}`);
166
+ logger.info('');
167
+ logger.info('Header:');
168
+ logger.info(` Slot Number: ${result.header.slotNumber.toString()}`);
169
+ logger.info(` Timestamp: ${result.header.timestamp.toString()}`);
170
+ logger.info(` Coinbase: ${result.header.coinbase.toString()}`);
171
+ logger.info(` Fee Recipient: ${result.header.feeRecipient.toString()}`);
172
+ logger.info(` Total Mana Used: ${result.header.totalManaUsed.toString()}`);
173
+ logger.info('');
174
+ logger.info('Attestations:');
175
+ logger.info(` Count: ${result.attestations.length}`);
176
+ logger.info(` Non-empty attestations: ${result.attestations.filter((a: any) => !a.signature.isEmpty()).length}`);
177
+
178
+ process.exit(0);
179
+ } catch (error) {
180
+ logger.error('Error retrieving block header:');
181
+ logger.error(error instanceof Error ? error.message : String(error));
182
+
183
+ if (error instanceof Error && error.stack) {
184
+ logger.debug(error.stack);
185
+ }
186
+
187
+ process.exit(1);
188
+ }
189
+ }
190
+
191
+ // Only run if this is the main module
192
+ if (import.meta.url === `file://${process.argv[1]}`) {
193
+ void main();
194
+ }