@aztec/archiver 0.0.1-commit.f2ce05ee → 0.0.1-commit.f5a9928

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 (132) hide show
  1. package/README.md +19 -13
  2. package/dest/archiver.d.ts +76 -18
  3. package/dest/archiver.d.ts.map +1 -1
  4. package/dest/archiver.js +329 -162
  5. package/dest/config.d.ts +7 -3
  6. package/dest/config.d.ts.map +1 -1
  7. package/dest/config.js +43 -14
  8. package/dest/errors.d.ts +55 -9
  9. package/dest/errors.d.ts.map +1 -1
  10. package/dest/errors.js +81 -14
  11. package/dest/factory.d.ts +20 -9
  12. package/dest/factory.d.ts.map +1 -1
  13. package/dest/factory.js +87 -39
  14. package/dest/index.d.ts +12 -3
  15. package/dest/index.d.ts.map +1 -1
  16. package/dest/index.js +11 -2
  17. package/dest/l1/bin/retrieve-calldata.js +32 -28
  18. package/dest/l1/calldata_retriever.d.ts +81 -50
  19. package/dest/l1/calldata_retriever.d.ts.map +1 -1
  20. package/dest/l1/calldata_retriever.js +202 -260
  21. package/dest/l1/data_retrieval.d.ts +32 -18
  22. package/dest/l1/data_retrieval.d.ts.map +1 -1
  23. package/dest/l1/data_retrieval.js +42 -47
  24. package/dest/l1/spire_proposer.d.ts +5 -5
  25. package/dest/l1/spire_proposer.d.ts.map +1 -1
  26. package/dest/l1/spire_proposer.js +9 -17
  27. package/dest/l1/trace_tx.d.ts +12 -66
  28. package/dest/l1/trace_tx.d.ts.map +1 -1
  29. package/dest/l1/validate_historical_logs.d.ts +23 -0
  30. package/dest/l1/validate_historical_logs.d.ts.map +1 -0
  31. package/dest/l1/validate_historical_logs.js +108 -0
  32. package/dest/modules/contract_data_source_adapter.d.ts +25 -0
  33. package/dest/modules/contract_data_source_adapter.d.ts.map +1 -0
  34. package/dest/modules/contract_data_source_adapter.js +32 -0
  35. package/dest/modules/data_source_base.d.ts +74 -46
  36. package/dest/modules/data_source_base.d.ts.map +1 -1
  37. package/dest/modules/data_source_base.js +252 -190
  38. package/dest/modules/data_store_updater.d.ts +49 -17
  39. package/dest/modules/data_store_updater.d.ts.map +1 -1
  40. package/dest/modules/data_store_updater.js +218 -122
  41. package/dest/modules/instrumentation.d.ts +29 -3
  42. package/dest/modules/instrumentation.d.ts.map +1 -1
  43. package/dest/modules/instrumentation.js +67 -11
  44. package/dest/modules/l1_synchronizer.d.ts +16 -14
  45. package/dest/modules/l1_synchronizer.d.ts.map +1 -1
  46. package/dest/modules/l1_synchronizer.js +488 -219
  47. package/dest/modules/outbox_trees_resolver.d.ts +64 -0
  48. package/dest/modules/outbox_trees_resolver.d.ts.map +1 -0
  49. package/dest/modules/outbox_trees_resolver.js +184 -0
  50. package/dest/modules/validation.d.ts +30 -7
  51. package/dest/modules/validation.d.ts.map +1 -1
  52. package/dest/modules/validation.js +35 -17
  53. package/dest/store/block_store.d.ts +186 -74
  54. package/dest/store/block_store.d.ts.map +1 -1
  55. package/dest/store/block_store.js +810 -285
  56. package/dest/store/contract_class_store.d.ts +17 -4
  57. package/dest/store/contract_class_store.d.ts.map +1 -1
  58. package/dest/store/contract_class_store.js +42 -68
  59. package/dest/store/contract_instance_store.d.ts +28 -1
  60. package/dest/store/contract_instance_store.d.ts.map +1 -1
  61. package/dest/store/contract_instance_store.js +58 -6
  62. package/dest/store/data_stores.d.ts +68 -0
  63. package/dest/store/data_stores.d.ts.map +1 -0
  64. package/dest/store/data_stores.js +54 -0
  65. package/dest/store/function_names_cache.d.ts +17 -0
  66. package/dest/store/function_names_cache.d.ts.map +1 -0
  67. package/dest/store/function_names_cache.js +30 -0
  68. package/dest/store/l2_tips_cache.d.ts +25 -0
  69. package/dest/store/l2_tips_cache.d.ts.map +1 -0
  70. package/dest/store/l2_tips_cache.js +26 -0
  71. package/dest/store/log_store.d.ts +42 -37
  72. package/dest/store/log_store.d.ts.map +1 -1
  73. package/dest/store/log_store.js +262 -408
  74. package/dest/store/log_store_codec.d.ts +78 -0
  75. package/dest/store/log_store_codec.d.ts.map +1 -0
  76. package/dest/store/log_store_codec.js +110 -0
  77. package/dest/store/message_store.d.ts +11 -1
  78. package/dest/store/message_store.d.ts.map +1 -1
  79. package/dest/store/message_store.js +51 -9
  80. package/dest/test/fake_l1_state.d.ts +25 -1
  81. package/dest/test/fake_l1_state.d.ts.map +1 -1
  82. package/dest/test/fake_l1_state.js +166 -32
  83. package/dest/test/mock_archiver.d.ts +1 -1
  84. package/dest/test/mock_archiver.d.ts.map +1 -1
  85. package/dest/test/mock_archiver.js +3 -2
  86. package/dest/test/mock_l2_block_source.d.ts +61 -47
  87. package/dest/test/mock_l2_block_source.d.ts.map +1 -1
  88. package/dest/test/mock_l2_block_source.js +306 -211
  89. package/dest/test/mock_structs.d.ts +4 -1
  90. package/dest/test/mock_structs.d.ts.map +1 -1
  91. package/dest/test/mock_structs.js +15 -3
  92. package/dest/test/noop_l1_archiver.d.ts +17 -6
  93. package/dest/test/noop_l1_archiver.d.ts.map +1 -1
  94. package/dest/test/noop_l1_archiver.js +31 -11
  95. package/package.json +15 -14
  96. package/src/archiver.ts +427 -185
  97. package/src/config.ts +51 -13
  98. package/src/errors.ts +122 -21
  99. package/src/factory.ts +104 -29
  100. package/src/index.ts +19 -2
  101. package/src/l1/README.md +25 -68
  102. package/src/l1/bin/retrieve-calldata.ts +40 -27
  103. package/src/l1/calldata_retriever.ts +267 -379
  104. package/src/l1/data_retrieval.ts +66 -70
  105. package/src/l1/spire_proposer.ts +7 -15
  106. package/src/l1/validate_historical_logs.ts +140 -0
  107. package/src/modules/contract_data_source_adapter.ts +46 -0
  108. package/src/modules/data_source_base.ts +337 -238
  109. package/src/modules/data_store_updater.ts +259 -154
  110. package/src/modules/instrumentation.ts +71 -11
  111. package/src/modules/l1_synchronizer.ts +659 -269
  112. package/src/modules/outbox_trees_resolver.ts +220 -0
  113. package/src/modules/validation.ts +80 -23
  114. package/src/store/block_store.ts +989 -358
  115. package/src/store/contract_class_store.ts +49 -103
  116. package/src/store/contract_instance_store.ts +74 -11
  117. package/src/store/data_stores.ts +104 -0
  118. package/src/store/function_names_cache.ts +37 -0
  119. package/src/store/l2_tips_cache.ts +35 -0
  120. package/src/store/log_store.ts +302 -559
  121. package/src/store/log_store_codec.ts +143 -0
  122. package/src/store/message_store.ts +60 -10
  123. package/src/structs/inbox_message.ts +1 -1
  124. package/src/test/fake_l1_state.ts +213 -42
  125. package/src/test/mock_archiver.ts +3 -2
  126. package/src/test/mock_l2_block_source.ts +378 -233
  127. package/src/test/mock_structs.ts +25 -8
  128. package/src/test/noop_l1_archiver.ts +61 -12
  129. package/dest/store/kv_archiver_store.d.ts +0 -340
  130. package/dest/store/kv_archiver_store.d.ts.map +0 -1
  131. package/dest/store/kv_archiver_store.js +0 -446
  132. package/src/store/kv_archiver_store.ts +0 -639
@@ -1,38 +1,133 @@
1
- import { BlockNumber, CheckpointNumber, type EpochNumber, type SlotNumber } from '@aztec/foundation/branded-types';
1
+ import { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
2
+ import {
3
+ BlockNumber,
4
+ CheckpointNumber,
5
+ type EpochNumber,
6
+ IndexWithinCheckpoint,
7
+ type SlotNumber,
8
+ } from '@aztec/foundation/branded-types';
2
9
  import type { Fr } from '@aztec/foundation/curves/bn254';
3
10
  import type { EthAddress } from '@aztec/foundation/eth-address';
4
- import { isDefined } from '@aztec/foundation/types';
5
11
  import type { FunctionSelector } from '@aztec/stdlib/abi';
6
12
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
7
- import { type BlockHash, CheckpointedL2Block, CommitteeAttestation, L2Block, type L2Tips } from '@aztec/stdlib/block';
8
- import { Checkpoint, PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
13
+ import {
14
+ type BlockData,
15
+ type BlockHash,
16
+ type BlockQuery,
17
+ type BlockTag,
18
+ type BlocksQuery,
19
+ Body,
20
+ type CheckpointQuery,
21
+ type CheckpointsQuery,
22
+ L2Block,
23
+ type L2Tips,
24
+ type ProposedCheckpointQuery,
25
+ } from '@aztec/stdlib/block';
26
+ import {
27
+ Checkpoint,
28
+ type CheckpointData,
29
+ type ProposedCheckpointData,
30
+ PublishedCheckpoint,
31
+ } from '@aztec/stdlib/checkpoint';
9
32
  import type { ContractClassPublic, ContractDataSource, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
10
- import { type L1RollupConstants, getSlotRangeForEpoch } from '@aztec/stdlib/epoch-helpers';
11
- import type { GetContractClassLogsResponse, GetPublicLogsResponse } from '@aztec/stdlib/interfaces/client';
33
+ import {
34
+ type L1RollupConstants,
35
+ getEpochAtSlot,
36
+ getEpochNumberAtTimestamp,
37
+ getLastL1SlotTimestampForL2Slot,
38
+ getProofSubmissionDeadlineEpoch,
39
+ getSlotRangeForEpoch,
40
+ } from '@aztec/stdlib/epoch-helpers';
12
41
  import type { L2LogsSource } from '@aztec/stdlib/interfaces/server';
13
- import type { LogFilter, SiloedTag, Tag, TxScopedL2Log } from '@aztec/stdlib/logs';
14
- import type { L1ToL2MessageSource } from '@aztec/stdlib/messaging';
15
- import type { CheckpointHeader } from '@aztec/stdlib/rollup';
16
- import type { BlockHeader, IndexedTxEffect, TxHash, TxReceipt } from '@aztec/stdlib/tx';
42
+ import type { LogResult, PrivateLogsQuery, PublicLogsQuery } from '@aztec/stdlib/logs';
43
+ import type { L1ToL2MessageSource, L2ToL1MembershipWitness } from '@aztec/stdlib/messaging';
44
+ import { AppendOnlyTreeSnapshot } from '@aztec/stdlib/trees';
45
+ import type { BlockHeader, IndexedTxEffect, TxHash } from '@aztec/stdlib/tx';
17
46
  import type { UInt64 } from '@aztec/stdlib/types';
18
47
 
19
48
  import type { ArchiverDataSource } from '../interfaces.js';
20
- import type { CheckpointData } from '../store/block_store.js';
21
- import type { KVArchiverDataStore } from '../store/kv_archiver_store.js';
49
+ import type { ResolvedBlockQuery, ResolvedBlocksQuery } from '../store/block_store.js';
50
+ import type { ArchiverDataStores } from '../store/data_stores.js';
22
51
  import type { ValidateCheckpointResult } from './validation.js';
23
52
 
24
53
  /**
25
- * Abstract base class implementing ArchiverDataSource using a KVArchiverDataStore.
26
- * Provides implementations for all store-delegating methods and declares abstract methods
27
- * for L1-dependent functionality that subclasses must implement.
54
+ * Sentinel returned by {@link ArchiverDataSourceBase#resolveBlockQuery} when a query resolves
55
+ * to the genesis block. Forces single-block lookup methods to take the genesis branch
56
+ * explicitly rather than silently falling through to the BlockStore (which never has a block 0).
57
+ */
58
+ type GenesisBlockQuery = { genesis: true };
59
+
60
+ /**
61
+ * Abstract base class implementing ArchiverDataSource using a bundle of archiver substores.
62
+ * Provides implementations for all read-side methods and declares abstract methods for
63
+ * L1-dependent functionality that subclasses must implement.
28
64
  */
29
65
  export abstract class ArchiverDataSourceBase
30
66
  implements ArchiverDataSource, L2LogsSource, ContractDataSource, L1ToL2MessageSource
31
67
  {
68
+ /** The injected genesis block header. */
69
+ protected readonly initialHeader: BlockHeader;
70
+ /** Precomputed hash of the initial header, exposed via {@link getGenesisBlockHash}. */
71
+ protected readonly initialBlockHash: BlockHash;
72
+ /** Archive root after block 0 was appended — read from L1 (`Rollup.getGenesisArchiveTreeRoot`). */
73
+ protected readonly genesisArchiveRoot: Fr;
74
+
75
+ /** Memoized synthetic genesis block — callers rely on referential identity for caching. */
76
+ private readonly genesisBlock: L2Block;
77
+ /** Memoized synthetic genesis block data — kept consistent with {@link genesisBlock}. */
78
+ private readonly genesisBlockData: BlockData;
79
+
32
80
  constructor(
33
- protected readonly store: KVArchiverDataStore,
34
- protected readonly l1Constants?: L1RollupConstants,
35
- ) {}
81
+ protected readonly stores: ArchiverDataStores,
82
+ protected readonly l1Constants: L1RollupConstants | undefined,
83
+ initialHeader: BlockHeader,
84
+ initialBlockHash: BlockHash,
85
+ genesisArchiveRoot: Fr,
86
+ ) {
87
+ this.initialHeader = initialHeader;
88
+ this.initialBlockHash = initialBlockHash;
89
+ this.genesisArchiveRoot = genesisArchiveRoot;
90
+
91
+ const genesisArchive = new AppendOnlyTreeSnapshot(genesisArchiveRoot, 1);
92
+ this.genesisBlock = new L2Block(
93
+ genesisArchive,
94
+ initialHeader,
95
+ Body.empty(),
96
+ CheckpointNumber.ZERO,
97
+ IndexWithinCheckpoint(0),
98
+ );
99
+ this.genesisBlockData = {
100
+ header: initialHeader,
101
+ archive: genesisArchive,
102
+ blockHash: initialBlockHash,
103
+ checkpointNumber: CheckpointNumber.ZERO,
104
+ indexWithinCheckpoint: IndexWithinCheckpoint(0),
105
+ };
106
+ }
107
+
108
+ /** Returns the precomputed hash of the genesis block header. */
109
+ public getGenesisBlockHash(): BlockHash {
110
+ return this.initialBlockHash;
111
+ }
112
+
113
+ /** Returns the synthetic genesis L2Block (memoized — same instance across calls). */
114
+ private getGenesisBlock(): L2Block {
115
+ return this.genesisBlock;
116
+ }
117
+
118
+ /** Returns genesis block data (memoized — same instance across calls). */
119
+ private getGenesisBlockData(): BlockData {
120
+ return this.genesisBlockData;
121
+ }
122
+
123
+ /**
124
+ * Type guard distinguishing the genesis sentinel from a {@link ResolvedBlockQuery}.
125
+ * `resolveBlockQuery` already rewrites every genesis-matching shape to the sentinel,
126
+ * so callers only need this single sync check.
127
+ */
128
+ private isGenesisBlockQuery(query: ResolvedBlockQuery | GenesisBlockQuery): query is GenesisBlockQuery {
129
+ return 'genesis' in query;
130
+ }
36
131
 
37
132
  abstract getRollupAddress(): Promise<EthAddress>;
38
133
 
@@ -46,107 +141,137 @@ export abstract class ArchiverDataSourceBase
46
141
 
47
142
  abstract getL2Tips(): Promise<L2Tips>;
48
143
 
49
- abstract getL2SlotNumber(): Promise<SlotNumber | undefined>;
144
+ abstract getSyncedL2SlotNumber(): Promise<SlotNumber | undefined>;
50
145
 
51
- abstract getL2EpochNumber(): Promise<EpochNumber | undefined>;
146
+ abstract getSyncedL2EpochNumber(): Promise<EpochNumber | undefined>;
52
147
 
53
148
  abstract isEpochComplete(epochNumber: EpochNumber): Promise<boolean>;
54
149
 
55
150
  abstract syncImmediate(): Promise<void>;
56
151
 
57
- public getCheckpointNumber(): Promise<CheckpointNumber> {
58
- return this.store.getSynchedCheckpointNumber();
59
- }
152
+ abstract getL2ToL1MembershipWitness(
153
+ txHash: TxHash,
154
+ message: Fr,
155
+ messageIndexInTx?: number,
156
+ ): Promise<L2ToL1MembershipWitness | undefined>;
60
157
 
61
- public getSynchedCheckpointNumber(): Promise<CheckpointNumber> {
62
- return this.store.getSynchedCheckpointNumber();
63
- }
158
+ public async isPruneDueAtSlot(slot: SlotNumber): Promise<boolean> {
159
+ if (!this.l1Constants) {
160
+ throw new Error('isPruneDueAtSlot requires l1Constants');
161
+ }
162
+ const tips = await this.getL2Tips();
163
+ const proven = tips.proven.checkpoint.number;
164
+ const pending = tips.checkpointed.checkpoint.number;
165
+ if (pending === proven) {
166
+ return false;
167
+ }
64
168
 
65
- public getProvenCheckpointNumber(): Promise<CheckpointNumber> {
66
- return this.store.getProvenCheckpointNumber();
169
+ const oldestUnproven = await this.getCheckpointData({ number: CheckpointNumber(Number(proven) + 1) });
170
+ if (!oldestUnproven) {
171
+ return false;
172
+ }
173
+
174
+ const slotTs = getLastL1SlotTimestampForL2Slot(slot, this.l1Constants);
175
+ const slotEpoch = getEpochNumberAtTimestamp(slotTs, this.l1Constants);
176
+ const oldestUnprovenEpoch = getEpochAtSlot(oldestUnproven.header.slotNumber, this.l1Constants);
177
+ const deadlineEpoch = getProofSubmissionDeadlineEpoch(oldestUnprovenEpoch, this.l1Constants);
178
+ return slotEpoch >= deadlineEpoch;
67
179
  }
68
180
 
69
- public getBlockNumber(): Promise<BlockNumber> {
70
- return this.store.getLatestBlockNumber();
181
+ public getCheckpointNumber(): Promise<CheckpointNumber> {
182
+ return this.stores.blocks.getLatestCheckpointNumber();
71
183
  }
72
184
 
73
- public getProvenBlockNumber(): Promise<BlockNumber> {
74
- return this.store.getProvenBlockNumber();
185
+ public getProvenCheckpointNumber(): Promise<CheckpointNumber> {
186
+ return this.stores.blocks.getProvenCheckpointNumber();
75
187
  }
76
188
 
77
- public async getBlockHeader(number: BlockNumber | 'latest'): Promise<BlockHeader | undefined> {
78
- const blockNumber = number === 'latest' ? await this.store.getLatestBlockNumber() : number;
79
- if (blockNumber === 0) {
189
+ public getBlockNumber(): Promise<BlockNumber>;
190
+ public getBlockNumber(query: BlockQuery): Promise<BlockNumber | undefined>;
191
+ public async getBlockNumber(query?: BlockQuery): Promise<BlockNumber | undefined> {
192
+ if (!query) {
193
+ return this.stores.blocks.getLatestL2BlockNumber();
194
+ }
195
+ const resolved = await this.resolveBlockQuery(query);
196
+ if (resolved === undefined) {
80
197
  return undefined;
81
198
  }
82
- const headers = await this.store.getBlockHeaders(blockNumber, 1);
83
- return headers.length === 0 ? undefined : headers[0];
84
- }
85
-
86
- public getCheckpointedBlock(number: BlockNumber): Promise<CheckpointedL2Block | undefined> {
87
- return this.store.getCheckpointedBlock(number);
88
- }
89
-
90
- public getCheckpointedL2BlockNumber(): Promise<BlockNumber> {
91
- return this.store.getCheckpointedL2BlockNumber();
92
- }
93
-
94
- public getFinalizedL2BlockNumber(): Promise<BlockNumber> {
95
- return this.store.getFinalizedL2BlockNumber();
199
+ if (this.isGenesisBlockQuery(resolved)) {
200
+ return BlockNumber.ZERO;
201
+ }
202
+ return this.stores.blocks.getBlockNumber(resolved);
96
203
  }
97
204
 
98
- public async getCheckpointHeader(number: CheckpointNumber | 'latest'): Promise<CheckpointHeader | undefined> {
99
- if (number === 'latest') {
100
- number = await this.store.getSynchedCheckpointNumber();
205
+ /**
206
+ * Resolves a {@link CheckpointQuery} to a concrete `CheckpointNumber`, or undefined when the
207
+ * query refers to a position that has no checkpoint yet (e.g. `{ slot }` not found).
208
+ */
209
+ private resolveCheckpointQuery(query: CheckpointQuery): Promise<CheckpointNumber | undefined> {
210
+ if ('number' in query) {
211
+ return Promise.resolve(query.number);
101
212
  }
102
- if (number === 0) {
103
- return undefined;
213
+ if ('slot' in query) {
214
+ return this.stores.blocks.getCheckpointNumberBySlot(query.slot);
104
215
  }
105
- const checkpoint = await this.store.getCheckpointData(number);
106
- if (!checkpoint) {
107
- return undefined;
216
+ // tag variant
217
+ switch (query.tag) {
218
+ case 'checkpointed':
219
+ return this.stores.blocks.getLatestCheckpointNumber();
220
+ case 'proven':
221
+ return this.stores.blocks.getProvenCheckpointNumber();
222
+ case 'finalized':
223
+ return this.stores.blocks.getFinalizedCheckpointNumber();
108
224
  }
109
- return checkpoint.header;
110
225
  }
111
226
 
112
- public async getLastBlockNumberInCheckpoint(checkpointNumber: CheckpointNumber): Promise<BlockNumber | undefined> {
113
- const checkpointData = await this.store.getCheckpointData(checkpointNumber);
114
- if (!checkpointData) {
227
+ public async getCheckpoint(query: CheckpointQuery): Promise<PublishedCheckpoint | undefined> {
228
+ const number = await this.resolveCheckpointQuery(query);
229
+ if (number === undefined || number === 0) {
230
+ return undefined;
231
+ }
232
+ const data = await this.stores.blocks.getCheckpointData(number);
233
+ if (!data) {
115
234
  return undefined;
116
235
  }
117
- return BlockNumber(checkpointData.startBlock + checkpointData.numBlocks - 1);
236
+ return this.getPublishedCheckpointFromCheckpointData(data);
118
237
  }
119
238
 
120
- public getCheckpointedBlocks(from: BlockNumber, limit: number): Promise<CheckpointedL2Block[]> {
121
- return this.store.getCheckpointedBlocks(from, limit);
239
+ public async getCheckpoints(query: CheckpointsQuery): Promise<PublishedCheckpoint[]> {
240
+ const checkpoints = await this.getCheckpointsData(query);
241
+ return Promise.all(checkpoints.map(ch => this.getPublishedCheckpointFromCheckpointData(ch)));
122
242
  }
123
243
 
124
- public getBlockHeaderByHash(blockHash: BlockHash): Promise<BlockHeader | undefined> {
125
- return this.store.getBlockHeaderByHash(blockHash);
244
+ public async getCheckpointData(query: CheckpointQuery): Promise<CheckpointData | undefined> {
245
+ const number = await this.resolveCheckpointQuery(query);
246
+ if (number === undefined || number === 0) {
247
+ return undefined;
248
+ }
249
+ return this.stores.blocks.getCheckpointData(number);
126
250
  }
127
251
 
128
- public getBlockHeaderByArchive(archive: Fr): Promise<BlockHeader | undefined> {
129
- return this.store.getBlockHeaderByArchive(archive);
252
+ public async getCheckpointsData(query: CheckpointsQuery): Promise<CheckpointData[]> {
253
+ if ('fromSlot' in query) {
254
+ return this.stores.blocks.getCheckpointsBySlot(query.fromSlot, query.limit, query.reverse ?? false);
255
+ }
256
+ if ('from' in query) {
257
+ return this.stores.blocks.getRangeOfCheckpoints(query.from, query.limit);
258
+ }
259
+ const numbers = await this.getCheckpointNumbersForEpoch(query.epoch);
260
+ return numbers.length > 0 ? this.stores.blocks.getRangeOfCheckpoints(numbers[0], numbers.length) : [];
130
261
  }
131
262
 
132
- public async getL2Block(number: BlockNumber): Promise<L2Block | undefined> {
133
- // If the number provided is -ve, then return the latest block.
134
- if (number < 0) {
135
- number = await this.store.getLatestBlockNumber();
263
+ public getProposedCheckpointData(query?: ProposedCheckpointQuery): Promise<ProposedCheckpointData | undefined> {
264
+ if (!query || 'tag' in query) {
265
+ return this.stores.blocks.getLastProposedCheckpoint();
136
266
  }
137
- if (number === 0) {
138
- return undefined;
267
+ if ('number' in query) {
268
+ return this.stores.blocks.getProposedCheckpointByNumber(query.number);
139
269
  }
140
- const publishedBlock = await this.store.getBlock(number);
141
- return publishedBlock;
270
+ return this.stores.blocks.getProposedCheckpointBySlot(query.slot);
142
271
  }
143
272
 
144
273
  public getTxEffect(txHash: TxHash): Promise<IndexedTxEffect | undefined> {
145
- return this.store.getTxEffect(txHash);
146
- }
147
-
148
- public getSettledTxReceipt(txHash: TxHash): Promise<TxReceipt | undefined> {
149
- return this.store.getSettledTxReceipt(txHash);
274
+ return this.stores.blocks.getTxEffect(txHash);
150
275
  }
151
276
 
152
277
  public isPendingChainInvalid(): Promise<boolean> {
@@ -154,214 +279,188 @@ export abstract class ArchiverDataSourceBase
154
279
  }
155
280
 
156
281
  public async getPendingChainValidationStatus(): Promise<ValidateCheckpointResult> {
157
- return (await this.store.getPendingChainValidationStatus()) ?? { valid: true };
282
+ return (await this.stores.blocks.getPendingChainValidationStatus()) ?? { valid: true };
158
283
  }
159
284
 
160
- public getPrivateLogsByTags(tags: SiloedTag[], page?: number): Promise<TxScopedL2Log[][]> {
161
- return this.store.getPrivateLogsByTags(tags, page);
285
+ public getPrivateLogsByTags(query: PrivateLogsQuery): Promise<LogResult[][]> {
286
+ return this.stores.logs.getPrivateLogsByTags(query);
162
287
  }
163
288
 
164
- public getPublicLogsByTagsFromContract(
165
- contractAddress: AztecAddress,
166
- tags: Tag[],
167
- page?: number,
168
- ): Promise<TxScopedL2Log[][]> {
169
- return this.store.getPublicLogsByTagsFromContract(contractAddress, tags, page);
170
- }
171
-
172
- public getPublicLogs(filter: LogFilter): Promise<GetPublicLogsResponse> {
173
- return this.store.getPublicLogs(filter);
174
- }
175
-
176
- public getContractClassLogs(filter: LogFilter): Promise<GetContractClassLogsResponse> {
177
- return this.store.getContractClassLogs(filter);
289
+ public getPublicLogsByTags(query: PublicLogsQuery): Promise<LogResult[][]> {
290
+ return this.stores.logs.getPublicLogsByTags(query);
178
291
  }
179
292
 
180
293
  public getContractClass(id: Fr): Promise<ContractClassPublic | undefined> {
181
- return this.store.getContractClass(id);
294
+ return this.stores.contractClasses.getContractClass(id);
182
295
  }
183
296
 
184
297
  public getBytecodeCommitment(id: Fr): Promise<Fr | undefined> {
185
- return this.store.getBytecodeCommitment(id);
186
- }
187
-
188
- public async getContract(
189
- address: AztecAddress,
190
- maybeTimestamp?: UInt64,
191
- ): Promise<ContractInstanceWithAddress | undefined> {
192
- let timestamp;
193
- if (maybeTimestamp === undefined) {
194
- const latestBlockHeader = await this.getBlockHeader('latest');
195
- // If we get undefined block header, it means that the archiver has not yet synced any block so we default to 0.
196
- timestamp = latestBlockHeader ? latestBlockHeader.globalVariables.timestamp : 0n;
197
- } else {
198
- timestamp = maybeTimestamp;
199
- }
298
+ return this.stores.contractClasses.getBytecodeCommitment(id);
299
+ }
200
300
 
201
- return this.store.getContractInstance(address, timestamp);
301
+ public getContract(address: AztecAddress, timestamp: UInt64): Promise<ContractInstanceWithAddress | undefined> {
302
+ return this.stores.contractInstances.getContractInstance(address, timestamp);
202
303
  }
203
304
 
204
305
  public getContractClassIds(): Promise<Fr[]> {
205
- return this.store.getContractClassIds();
306
+ return this.stores.contractClasses.getContractClassIds();
206
307
  }
207
308
 
208
- public getDebugFunctionName(address: AztecAddress, selector: FunctionSelector): Promise<string | undefined> {
209
- return this.store.getDebugFunctionName(address, selector);
309
+ /** Looks up a public function name given a selector. */
310
+ public getDebugFunctionName(_address: AztecAddress, selector: FunctionSelector): Promise<string | undefined> {
311
+ return Promise.resolve(this.stores.functionNames.get(selector));
210
312
  }
211
313
 
314
+ /** Register public function signatures so they can be looked up by selector. */
212
315
  public registerContractFunctionSignatures(signatures: string[]): Promise<void> {
213
- return this.store.registerContractFunctionSignatures(signatures);
316
+ return this.stores.functionNames.register(signatures);
214
317
  }
215
318
 
216
319
  public getL1ToL2Messages(checkpointNumber: CheckpointNumber): Promise<Fr[]> {
217
- return this.store.getL1ToL2Messages(checkpointNumber);
320
+ return this.stores.messages.getL1ToL2Messages(checkpointNumber);
218
321
  }
219
322
 
220
323
  public getL1ToL2MessageIndex(l1ToL2Message: Fr): Promise<bigint | undefined> {
221
- return this.store.getL1ToL2MessageIndex(l1ToL2Message);
222
- }
223
-
224
- public async getCheckpoints(checkpointNumber: CheckpointNumber, limit: number): Promise<PublishedCheckpoint[]> {
225
- const checkpoints = await this.store.getRangeOfCheckpoints(checkpointNumber, limit);
226
- const blocks = (
227
- await Promise.all(checkpoints.map(ch => this.store.getBlocksForCheckpoint(ch.checkpointNumber)))
228
- ).filter(isDefined);
229
-
230
- const fullCheckpoints: PublishedCheckpoint[] = [];
231
- for (let i = 0; i < checkpoints.length; i++) {
232
- const blocksForCheckpoint = blocks[i];
233
- const checkpoint = checkpoints[i];
234
- const fullCheckpoint = new Checkpoint(
235
- checkpoint.archive,
236
- checkpoint.header,
237
- blocksForCheckpoint,
238
- checkpoint.checkpointNumber,
239
- );
240
- const publishedCheckpoint = new PublishedCheckpoint(
241
- fullCheckpoint,
242
- checkpoint.l1,
243
- checkpoint.attestations.map(x => CommitteeAttestation.fromBuffer(x)),
244
- );
245
- fullCheckpoints.push(publishedCheckpoint);
324
+ return this.stores.messages.getL1ToL2MessageIndex(l1ToL2Message);
325
+ }
326
+
327
+ private async getPublishedCheckpointFromCheckpointData(checkpoint: CheckpointData): Promise<PublishedCheckpoint> {
328
+ const blocksForCheckpoint = await this.stores.blocks.getBlocksForCheckpoint(checkpoint.checkpointNumber);
329
+ if (!blocksForCheckpoint) {
330
+ throw new Error(`Blocks for checkpoint ${checkpoint.checkpointNumber} not found`);
246
331
  }
247
- return fullCheckpoints;
332
+ const fullCheckpoint = new Checkpoint(
333
+ checkpoint.archive,
334
+ checkpoint.header,
335
+ blocksForCheckpoint,
336
+ checkpoint.checkpointNumber,
337
+ checkpoint.feeAssetPriceModifier,
338
+ );
339
+ return new PublishedCheckpoint(fullCheckpoint, checkpoint.l1, checkpoint.attestations);
248
340
  }
249
341
 
250
342
  public getBlocksForSlot(slotNumber: SlotNumber): Promise<L2Block[]> {
251
- return this.store.getBlocksForSlot(slotNumber);
343
+ return this.stores.blocks.getBlocksForSlot(slotNumber);
252
344
  }
253
345
 
254
- public async getCheckpointedBlocksForEpoch(epochNumber: EpochNumber): Promise<CheckpointedL2Block[]> {
346
+ /** Returns just the checkpoint numbers for all checkpoints whose slot falls within the given epoch. */
347
+ private getCheckpointNumbersForEpoch(epochNumber: EpochNumber): Promise<CheckpointNumber[]> {
255
348
  if (!this.l1Constants) {
256
349
  throw new Error('L1 constants not set');
257
350
  }
258
351
 
259
352
  const [start, end] = getSlotRangeForEpoch(epochNumber, this.l1Constants);
260
- const blocks: CheckpointedL2Block[] = [];
261
-
262
- // Walk the list of checkpoints backwards and filter by slots matching the requested epoch.
263
- // We'll typically ask for checkpoints for a very recent epoch, so we shouldn't need an index here.
264
- let checkpoint = await this.store.getCheckpointData(await this.store.getSynchedCheckpointNumber());
265
- const slot = (b: CheckpointData) => b.header.slotNumber;
266
- while (checkpoint && slot(checkpoint) >= start) {
267
- if (slot(checkpoint) <= end) {
268
- // push the blocks on backwards
269
- const endBlock = checkpoint.startBlock + checkpoint.numBlocks - 1;
270
- for (let i = endBlock; i >= checkpoint.startBlock; i--) {
271
- const checkpointedBlock = await this.getCheckpointedBlock(BlockNumber(i));
272
- if (checkpointedBlock) {
273
- blocks.push(checkpointedBlock);
274
- }
275
- }
276
- }
277
- checkpoint = await this.store.getCheckpointData(CheckpointNumber(checkpoint.checkpointNumber - 1));
278
- }
279
-
280
- return blocks.reverse();
353
+ return this.stores.blocks.getCheckpointNumbersForSlotRange(start, end);
281
354
  }
282
355
 
283
- public async getCheckpointedBlockHeadersForEpoch(epochNumber: EpochNumber): Promise<BlockHeader[]> {
284
- if (!this.l1Constants) {
285
- throw new Error('L1 constants not set');
356
+ public async getBlock(query: BlockQuery): Promise<L2Block | undefined> {
357
+ const resolved = await this.resolveBlockQuery(query);
358
+ if (resolved === undefined) {
359
+ return undefined;
286
360
  }
287
-
288
- const [start, end] = getSlotRangeForEpoch(epochNumber, this.l1Constants);
289
- const blocks: BlockHeader[] = [];
290
-
291
- // Walk the list of checkpoints backwards and filter by slots matching the requested epoch.
292
- // We'll typically ask for checkpoints for a very recent epoch, so we shouldn't need an index here.
293
- let checkpoint = await this.store.getCheckpointData(await this.store.getSynchedCheckpointNumber());
294
- const slot = (b: CheckpointData) => b.header.slotNumber;
295
- while (checkpoint && slot(checkpoint) >= start) {
296
- if (slot(checkpoint) <= end) {
297
- // push the blocks on backwards
298
- const endBlock = checkpoint.startBlock + checkpoint.numBlocks - 1;
299
- for (let i = endBlock; i >= checkpoint.startBlock; i--) {
300
- const block = await this.getBlockHeader(BlockNumber(i));
301
- if (block) {
302
- blocks.push(block);
303
- }
304
- }
305
- }
306
- checkpoint = await this.store.getCheckpointData(CheckpointNumber(checkpoint.checkpointNumber - 1));
361
+ if (this.isGenesisBlockQuery(resolved)) {
362
+ return this.getGenesisBlock();
307
363
  }
308
- return blocks.reverse();
364
+ return this.stores.blocks.getBlock(resolved);
309
365
  }
310
366
 
311
- public async getCheckpointsForEpoch(epochNumber: EpochNumber): Promise<Checkpoint[]> {
312
- if (!this.l1Constants) {
313
- throw new Error('L1 constants not set');
314
- }
315
-
316
- const [start, end] = getSlotRangeForEpoch(epochNumber, this.l1Constants);
317
- const checkpoints: Checkpoint[] = [];
318
-
319
- // Walk the list of checkpoints backwards and filter by slots matching the requested epoch.
320
- // We'll typically ask for checkpoints for a very recent epoch, so we shouldn't need an index here.
321
- let checkpointData = await this.store.getCheckpointData(await this.store.getSynchedCheckpointNumber());
322
- const slot = (b: CheckpointData) => b.header.slotNumber;
323
- while (checkpointData && slot(checkpointData) >= start) {
324
- if (slot(checkpointData) <= end) {
325
- // push the checkpoints on backwards
326
- const [checkpoint] = await this.getCheckpoints(checkpointData.checkpointNumber, 1);
327
- checkpoints.push(checkpoint.checkpoint);
328
- }
329
- checkpointData = await this.store.getCheckpointData(CheckpointNumber(checkpointData.checkpointNumber - 1));
330
- }
331
-
332
- return checkpoints.reverse();
367
+ /**
368
+ * Range queries iterate physical blocks only; the genesis block is NOT prepended.
369
+ * `L2BlockStream` consumers (`world-state.handleL2Blocks`, etc.) emit `blocks-added` events for
370
+ * real blocks and would be surprised by a synthetic block 0. Use {@link getBlock} or
371
+ * {@link getBlockData} for genesis-aware single-block lookups.
372
+ */
373
+ public async getBlocks(query: BlocksQuery): Promise<L2Block[]> {
374
+ const resolved = await this.resolveBlocksQuery(query);
375
+ return resolved ? this.stores.blocks.getBlocks(resolved) : [];
333
376
  }
334
377
 
335
- public async getBlock(number: BlockNumber): Promise<L2Block | undefined> {
336
- // If the number provided is -ve, then return the latest block.
337
- if (number < 0) {
338
- number = await this.store.getLatestBlockNumber();
339
- }
340
- if (number === 0) {
378
+ public async getBlockData(query: BlockQuery): Promise<BlockData | undefined> {
379
+ const resolved = await this.resolveBlockQuery(query);
380
+ if (resolved === undefined) {
341
381
  return undefined;
342
382
  }
343
- return this.store.getBlock(number);
344
- }
345
-
346
- public getBlocks(from: BlockNumber, limit: number): Promise<L2Block[]> {
347
- return this.store.getBlocks(from, limit);
348
- }
349
-
350
- public getCheckpointedBlockByHash(blockHash: BlockHash): Promise<CheckpointedL2Block | undefined> {
351
- return this.store.getCheckpointedBlockByHash(blockHash);
383
+ if (this.isGenesisBlockQuery(resolved)) {
384
+ return this.getGenesisBlockData();
385
+ }
386
+ return this.stores.blocks.getBlockData(resolved);
352
387
  }
353
388
 
354
- public getCheckpointedBlockByArchive(archive: Fr): Promise<CheckpointedL2Block | undefined> {
355
- return this.store.getCheckpointedBlockByArchive(archive);
389
+ /** See {@link getBlocks} range queries do not prepend the genesis block. */
390
+ public async getBlocksData(query: BlocksQuery): Promise<BlockData[]> {
391
+ const resolved = await this.resolveBlocksQuery(query);
392
+ return resolved ? this.stores.blocks.getBlocksData(resolved) : [];
356
393
  }
357
394
 
358
- public async getL2BlockByHash(blockHash: BlockHash): Promise<L2Block | undefined> {
359
- const checkpointedBlock = await this.store.getCheckpointedBlockByHash(blockHash);
360
- return checkpointedBlock?.block;
395
+ /**
396
+ * Resolves a {@link BlockQuery} to either the genesis sentinel or a {@link ResolvedBlockQuery}
397
+ * understood by BlockStore. Detects every shape that points at block 0 — `{number:0}`,
398
+ * `{hash}` matching the initial header, `{archive}` matching the post-genesis archive root,
399
+ * and `{tag}` resolving to 0 — and rewrites them to the sentinel so callers branch once.
400
+ */
401
+ private async resolveBlockQuery(query: BlockQuery): Promise<ResolvedBlockQuery | GenesisBlockQuery | undefined> {
402
+ if ('number' in query) {
403
+ return query.number === BlockNumber.ZERO ? { genesis: true } : query;
404
+ }
405
+ if ('hash' in query) {
406
+ return query.hash.equals(this.initialBlockHash) ? { genesis: true } : query;
407
+ }
408
+ if ('archive' in query) {
409
+ return query.archive.equals(this.genesisArchiveRoot) ? { genesis: true } : query;
410
+ }
411
+ const number = await this.resolveBlockTag(query.tag);
412
+ if (number === BlockNumber.ZERO) {
413
+ return { genesis: true };
414
+ }
415
+ return { number };
416
+ }
417
+
418
+ /** Maps a {@link BlockTag} to the matching block number for the current chain state. */
419
+ private resolveBlockTag(tag: BlockTag): Promise<BlockNumber> {
420
+ switch (tag) {
421
+ case 'latest':
422
+ case 'proposed':
423
+ return this.stores.blocks.getLatestL2BlockNumber();
424
+ case 'checkpointed':
425
+ return this.stores.blocks.getCheckpointedL2BlockNumber();
426
+ case 'proven':
427
+ return this.stores.blocks.getProvenBlockNumber();
428
+ case 'finalized':
429
+ return this.stores.blocks.getFinalizedL2BlockNumber();
430
+ }
361
431
  }
362
432
 
363
- public async getL2BlockByArchive(archive: Fr): Promise<L2Block | undefined> {
364
- const checkpointedBlock = await this.store.getCheckpointedBlockByArchive(archive);
365
- return checkpointedBlock?.block;
433
+ /**
434
+ * Converts an epoch-based BlocksQuery to a from/limit query using l1Constants.
435
+ * Returns undefined when the epoch has no checkpoints, so callers can return [] without
436
+ * entering BlockStore. Reads only the two endpoint checkpoints rather than the whole epoch.
437
+ */
438
+ private async resolveBlocksQuery(query: BlocksQuery): Promise<ResolvedBlocksQuery | undefined> {
439
+ if (!('epoch' in query)) {
440
+ if (query.from < INITIAL_L2_BLOCK_NUM) {
441
+ throw new Error(
442
+ `getBlocks/getBlocksData: 'from' must be >= ${INITIAL_L2_BLOCK_NUM}, got ${query.from}. ` +
443
+ `Use getBlock({number:0})/getBlockData({number:0}) for genesis-aware single-block lookups.`,
444
+ );
445
+ }
446
+ return query;
447
+ }
448
+ const checkpointNumbers = await this.getCheckpointNumbersForEpoch(query.epoch);
449
+ if (checkpointNumbers.length === 0) {
450
+ return undefined;
451
+ }
452
+ const firstNumber = checkpointNumbers[0];
453
+ const lastNumber = checkpointNumbers[checkpointNumbers.length - 1];
454
+ const first = await this.stores.blocks.getCheckpointData(firstNumber);
455
+ if (!first) {
456
+ return undefined;
457
+ }
458
+ const last = firstNumber === lastNumber ? first : await this.stores.blocks.getCheckpointData(lastNumber);
459
+ if (!last) {
460
+ return undefined;
461
+ }
462
+ const from = BlockNumber(first.startBlock);
463
+ const limit = last.startBlock + last.blockCount - first.startBlock;
464
+ return { from, limit, onlyCheckpointed: true };
366
465
  }
367
466
  }