@aztec/archiver 0.0.1-commit.b655e406 → 0.0.1-commit.c7c42ec

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/dest/archiver/archiver.d.ts +110 -83
  2. package/dest/archiver/archiver.d.ts.map +1 -1
  3. package/dest/archiver/archiver.js +672 -349
  4. package/dest/archiver/archiver_store.d.ts +100 -47
  5. package/dest/archiver/archiver_store.d.ts.map +1 -1
  6. package/dest/archiver/archiver_store_test_suite.d.ts +1 -1
  7. package/dest/archiver/archiver_store_test_suite.d.ts.map +1 -1
  8. package/dest/archiver/archiver_store_test_suite.js +1871 -389
  9. package/dest/archiver/config.d.ts +5 -4
  10. package/dest/archiver/config.d.ts.map +1 -1
  11. package/dest/archiver/config.js +15 -3
  12. package/dest/archiver/errors.d.ts +25 -1
  13. package/dest/archiver/errors.d.ts.map +1 -1
  14. package/dest/archiver/errors.js +37 -0
  15. package/dest/archiver/index.d.ts +2 -2
  16. package/dest/archiver/index.d.ts.map +1 -1
  17. package/dest/archiver/instrumentation.d.ts +5 -3
  18. package/dest/archiver/instrumentation.d.ts.map +1 -1
  19. package/dest/archiver/instrumentation.js +11 -0
  20. package/dest/archiver/kv_archiver_store/block_store.d.ts +51 -18
  21. package/dest/archiver/kv_archiver_store/block_store.d.ts.map +1 -1
  22. package/dest/archiver/kv_archiver_store/block_store.js +324 -87
  23. package/dest/archiver/kv_archiver_store/contract_class_store.d.ts +2 -2
  24. package/dest/archiver/kv_archiver_store/contract_class_store.d.ts.map +1 -1
  25. package/dest/archiver/kv_archiver_store/contract_class_store.js +1 -1
  26. package/dest/archiver/kv_archiver_store/contract_instance_store.d.ts +2 -2
  27. package/dest/archiver/kv_archiver_store/contract_instance_store.d.ts.map +1 -1
  28. package/dest/archiver/kv_archiver_store/kv_archiver_store.d.ts +47 -57
  29. package/dest/archiver/kv_archiver_store/kv_archiver_store.d.ts.map +1 -1
  30. package/dest/archiver/kv_archiver_store/kv_archiver_store.js +65 -48
  31. package/dest/archiver/kv_archiver_store/log_store.d.ts +12 -16
  32. package/dest/archiver/kv_archiver_store/log_store.d.ts.map +1 -1
  33. package/dest/archiver/kv_archiver_store/log_store.js +149 -84
  34. package/dest/archiver/kv_archiver_store/message_store.d.ts +6 -5
  35. package/dest/archiver/kv_archiver_store/message_store.d.ts.map +1 -1
  36. package/dest/archiver/kv_archiver_store/message_store.js +15 -14
  37. package/dest/archiver/l1/bin/retrieve-calldata.d.ts +3 -0
  38. package/dest/archiver/l1/bin/retrieve-calldata.d.ts.map +1 -0
  39. package/dest/archiver/l1/bin/retrieve-calldata.js +149 -0
  40. package/dest/archiver/l1/calldata_retriever.d.ts +112 -0
  41. package/dest/archiver/l1/calldata_retriever.d.ts.map +1 -0
  42. package/dest/archiver/l1/calldata_retriever.js +471 -0
  43. package/dest/archiver/l1/data_retrieval.d.ts +90 -0
  44. package/dest/archiver/l1/data_retrieval.d.ts.map +1 -0
  45. package/dest/archiver/l1/data_retrieval.js +331 -0
  46. package/dest/archiver/l1/debug_tx.d.ts +19 -0
  47. package/dest/archiver/l1/debug_tx.d.ts.map +1 -0
  48. package/dest/archiver/l1/debug_tx.js +73 -0
  49. package/dest/archiver/l1/spire_proposer.d.ts +70 -0
  50. package/dest/archiver/l1/spire_proposer.d.ts.map +1 -0
  51. package/dest/archiver/l1/spire_proposer.js +157 -0
  52. package/dest/archiver/l1/trace_tx.d.ts +97 -0
  53. package/dest/archiver/l1/trace_tx.d.ts.map +1 -0
  54. package/dest/archiver/l1/trace_tx.js +91 -0
  55. package/dest/archiver/l1/types.d.ts +12 -0
  56. package/dest/archiver/l1/types.d.ts.map +1 -0
  57. package/dest/archiver/l1/types.js +3 -0
  58. package/dest/archiver/l1/validate_trace.d.ts +29 -0
  59. package/dest/archiver/l1/validate_trace.d.ts.map +1 -0
  60. package/dest/archiver/l1/validate_trace.js +150 -0
  61. package/dest/archiver/structs/data_retrieval.d.ts +1 -1
  62. package/dest/archiver/structs/inbox_message.d.ts +4 -4
  63. package/dest/archiver/structs/inbox_message.d.ts.map +1 -1
  64. package/dest/archiver/structs/inbox_message.js +6 -5
  65. package/dest/archiver/structs/published.d.ts +2 -2
  66. package/dest/archiver/structs/published.d.ts.map +1 -1
  67. package/dest/archiver/validation.d.ts +10 -4
  68. package/dest/archiver/validation.d.ts.map +1 -1
  69. package/dest/archiver/validation.js +29 -21
  70. package/dest/factory.d.ts +2 -2
  71. package/dest/factory.d.ts.map +1 -1
  72. package/dest/factory.js +4 -3
  73. package/dest/index.d.ts +2 -2
  74. package/dest/index.d.ts.map +1 -1
  75. package/dest/index.js +1 -1
  76. package/dest/rpc/index.d.ts +2 -2
  77. package/dest/test/index.d.ts +1 -1
  78. package/dest/test/mock_archiver.d.ts +16 -8
  79. package/dest/test/mock_archiver.d.ts.map +1 -1
  80. package/dest/test/mock_archiver.js +19 -14
  81. package/dest/test/mock_l1_to_l2_message_source.d.ts +7 -6
  82. package/dest/test/mock_l1_to_l2_message_source.d.ts.map +1 -1
  83. package/dest/test/mock_l1_to_l2_message_source.js +10 -9
  84. package/dest/test/mock_l2_block_source.d.ts +23 -11
  85. package/dest/test/mock_l2_block_source.d.ts.map +1 -1
  86. package/dest/test/mock_l2_block_source.js +38 -24
  87. package/dest/test/mock_structs.d.ts +3 -2
  88. package/dest/test/mock_structs.d.ts.map +1 -1
  89. package/dest/test/mock_structs.js +9 -8
  90. package/package.json +18 -17
  91. package/src/archiver/archiver.ts +884 -449
  92. package/src/archiver/archiver_store.ts +113 -46
  93. package/src/archiver/archiver_store_test_suite.ts +1936 -356
  94. package/src/archiver/config.ts +20 -10
  95. package/src/archiver/errors.ts +64 -0
  96. package/src/archiver/index.ts +1 -1
  97. package/src/archiver/instrumentation.ts +16 -2
  98. package/src/archiver/kv_archiver_store/block_store.ts +442 -101
  99. package/src/archiver/kv_archiver_store/contract_class_store.ts +1 -1
  100. package/src/archiver/kv_archiver_store/contract_instance_store.ts +1 -1
  101. package/src/archiver/kv_archiver_store/kv_archiver_store.ts +87 -71
  102. package/src/archiver/kv_archiver_store/log_store.ts +209 -99
  103. package/src/archiver/kv_archiver_store/message_store.ts +21 -18
  104. package/src/archiver/l1/README.md +98 -0
  105. package/src/archiver/l1/bin/retrieve-calldata.ts +182 -0
  106. package/src/archiver/l1/calldata_retriever.ts +641 -0
  107. package/src/archiver/l1/data_retrieval.ts +512 -0
  108. package/src/archiver/l1/debug_tx.ts +99 -0
  109. package/src/archiver/l1/spire_proposer.ts +160 -0
  110. package/src/archiver/l1/trace_tx.ts +128 -0
  111. package/src/archiver/l1/types.ts +13 -0
  112. package/src/archiver/l1/validate_trace.ts +211 -0
  113. package/src/archiver/structs/inbox_message.ts +8 -8
  114. package/src/archiver/structs/published.ts +1 -1
  115. package/src/archiver/validation.ts +52 -27
  116. package/src/factory.ts +4 -3
  117. package/src/index.ts +1 -1
  118. package/src/test/fixtures/debug_traceTransaction-multicall3.json +88 -0
  119. package/src/test/fixtures/debug_traceTransaction-multiplePropose.json +153 -0
  120. package/src/test/fixtures/debug_traceTransaction-proxied.json +122 -0
  121. package/src/test/fixtures/trace_transaction-multicall3.json +65 -0
  122. package/src/test/fixtures/trace_transaction-multiplePropose.json +319 -0
  123. package/src/test/fixtures/trace_transaction-proxied.json +128 -0
  124. package/src/test/fixtures/trace_transaction-randomRevert.json +216 -0
  125. package/src/test/mock_archiver.ts +22 -16
  126. package/src/test/mock_l1_to_l2_message_source.ts +10 -9
  127. package/src/test/mock_l2_block_source.ts +51 -30
  128. package/src/test/mock_structs.ts +10 -9
  129. package/dest/archiver/data_retrieval.d.ts +0 -79
  130. package/dest/archiver/data_retrieval.d.ts.map +0 -1
  131. package/dest/archiver/data_retrieval.js +0 -362
  132. package/src/archiver/data_retrieval.ts +0 -545
@@ -1,20 +1,25 @@
1
- import { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
2
- import { Fr } from '@aztec/foundation/fields';
1
+ import { INITIAL_CHECKPOINT_NUMBER, INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
2
+ import { BlockNumber, CheckpointNumber } from '@aztec/foundation/branded-types';
3
+ import { Fr } from '@aztec/foundation/curves/bn254';
3
4
  import { toArray } from '@aztec/foundation/iterable';
4
5
  import { createLogger } from '@aztec/foundation/log';
5
6
  import { BufferReader } from '@aztec/foundation/serialize';
6
7
  import { bufferToHex } from '@aztec/foundation/string';
8
+ import { isDefined } from '@aztec/foundation/types';
7
9
  import type { AztecAsyncKVStore, AztecAsyncMap, AztecAsyncSingleton, Range } from '@aztec/kv-store';
8
10
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
9
11
  import {
10
12
  Body,
13
+ CheckpointedL2Block,
11
14
  CommitteeAttestation,
12
- L2Block,
13
15
  L2BlockHash,
14
- PublishedL2Block,
16
+ L2BlockNew,
15
17
  type ValidateBlockResult,
18
+ deserializeValidateBlockResult,
19
+ serializeValidateBlockResult,
16
20
  } from '@aztec/stdlib/block';
17
- import { L2BlockHeader, deserializeValidateBlockResult, serializeValidateBlockResult } from '@aztec/stdlib/block';
21
+ import { L1PublishedData, PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
22
+ import { CheckpointHeader } from '@aztec/stdlib/rollup';
18
23
  import { AppendOnlyTreeSnapshot } from '@aztec/stdlib/trees';
19
24
  import {
20
25
  BlockHeader,
@@ -26,8 +31,17 @@ import {
26
31
  serializeIndexedTxEffect,
27
32
  } from '@aztec/stdlib/tx';
28
33
 
29
- import { BlockNumberNotSequentialError, InitialBlockNumberNotSequentialError } from '../errors.js';
30
- import type { L1PublishedData } from '../structs/published.js';
34
+ import {
35
+ BlockArchiveNotConsistentError,
36
+ BlockIndexNotSequentialError,
37
+ BlockNotFoundError,
38
+ BlockNumberNotSequentialError,
39
+ CheckpointNotFoundError,
40
+ CheckpointNumberNotConsistentError,
41
+ CheckpointNumberNotSequentialError,
42
+ InitialBlockNumberNotSequentialError,
43
+ InitialCheckpointNumberNotSequentialError,
44
+ } from '../errors.js';
31
45
 
32
46
  export { TxReceipt, type TxEffect, type TxHash } from '@aztec/stdlib/tx';
33
47
 
@@ -37,6 +51,26 @@ type BlockStorage = {
37
51
  header: Buffer;
38
52
  blockHash: Buffer;
39
53
  archive: Buffer;
54
+ checkpointNumber: number;
55
+ indexWithinCheckpoint: number;
56
+ };
57
+
58
+ type CheckpointStorage = {
59
+ header: Buffer;
60
+ archive: Buffer;
61
+ checkpointNumber: number;
62
+ startBlock: number;
63
+ numBlocks: number;
64
+ l1: Buffer;
65
+ attestations: Buffer[];
66
+ };
67
+
68
+ export type CheckpointData = {
69
+ checkpointNumber: CheckpointNumber;
70
+ header: CheckpointHeader;
71
+ archive: AppendOnlyTreeSnapshot;
72
+ startBlock: number;
73
+ numBlocks: number;
40
74
  l1: L1PublishedData;
41
75
  attestations: Buffer[];
42
76
  };
@@ -48,6 +82,9 @@ export class BlockStore {
48
82
  /** Map block number to block data */
49
83
  #blocks: AztecAsyncMap<number, BlockStorage>;
50
84
 
85
+ /** Map checkpoint number to checkpoint data */
86
+ #checkpoints: AztecAsyncMap<number, CheckpointStorage>;
87
+
51
88
  /** Map block hash to list of tx hashes */
52
89
  #blockTxs: AztecAsyncMap<string, Buffer>;
53
90
 
@@ -57,8 +94,8 @@ export class BlockStore {
57
94
  /** Stores L1 block number in which the last processed L2 block was included */
58
95
  #lastSynchedL1Block: AztecAsyncSingleton<bigint>;
59
96
 
60
- /** Stores l2 block number of the last proven block */
61
- #lastProvenL2Block: AztecAsyncSingleton<number>;
97
+ /** Stores last proven checkpoint */
98
+ #lastProvenCheckpoint: AztecAsyncSingleton<number>;
62
99
 
63
100
  /** Stores the pending chain validation status */
64
101
  #pendingChainValidationStatus: AztecAsyncSingleton<Buffer>;
@@ -82,125 +119,412 @@ export class BlockStore {
82
119
  this.#blockHashIndex = db.openMap('archiver_block_hash_index');
83
120
  this.#blockArchiveIndex = db.openMap('archiver_block_archive_index');
84
121
  this.#lastSynchedL1Block = db.openSingleton('archiver_last_synched_l1_block');
85
- this.#lastProvenL2Block = db.openSingleton('archiver_last_proven_l2_block');
122
+ this.#lastProvenCheckpoint = db.openSingleton('archiver_last_proven_l2_checkpoint');
86
123
  this.#pendingChainValidationStatus = db.openSingleton('archiver_pending_chain_validation_status');
124
+ this.#checkpoints = db.openMap('archiver_checkpoints');
87
125
  }
88
126
 
89
127
  /**
90
- * Append new blocks to the store's list.
128
+ * Append new blocks to the store's list. All blocks must be for the 'current' checkpoint
91
129
  * @param blocks - The L2 blocks to be added to the store.
92
130
  * @returns True if the operation is successful.
93
131
  */
94
- async addBlocks(blocks: PublishedL2Block[], opts: { force?: boolean } = {}): Promise<boolean> {
132
+ async addBlocks(blocks: L2BlockNew[], opts: { force?: boolean } = {}): Promise<boolean> {
95
133
  if (blocks.length === 0) {
96
134
  return true;
97
135
  }
98
136
 
99
137
  return await this.db.transactionAsync(async () => {
100
138
  // Check that the block immediately before the first block to be added is present in the store.
101
- const firstBlockNumber = blocks[0].block.number;
102
- const [previousBlockNumber] = await toArray(
103
- this.#blocks.keysAsync({ reverse: true, limit: 1, end: firstBlockNumber - 1 }),
104
- );
105
- const hasPreviousBlock =
106
- firstBlockNumber === INITIAL_L2_BLOCK_NUM ||
107
- (previousBlockNumber !== undefined && previousBlockNumber === firstBlockNumber - 1);
108
- if (!opts.force && !hasPreviousBlock) {
139
+ const firstBlockNumber = blocks[0].number;
140
+ const firstBlockCheckpointNumber = blocks[0].checkpointNumber;
141
+ const firstBlockIndex = blocks[0].indexWithinCheckpoint;
142
+ const firstBlockLastArchive = blocks[0].header.lastArchive.root;
143
+
144
+ // Extract the latest block and checkpoint numbers
145
+ const previousBlockNumber = await this.getLatestBlockNumber();
146
+ const previousCheckpointNumber = await this.getLatestCheckpointNumber();
147
+
148
+ // Check that the first block number is the expected one
149
+ if (!opts.force && previousBlockNumber !== firstBlockNumber - 1) {
109
150
  throw new InitialBlockNumberNotSequentialError(firstBlockNumber, previousBlockNumber);
110
151
  }
111
152
 
112
- // Iterate over blocks array and insert them, checking that the block numbers are sequential.
113
- let previousBlock: PublishedL2Block | undefined = undefined;
153
+ // The same check as above but for checkpoints
154
+ if (!opts.force && previousCheckpointNumber !== firstBlockCheckpointNumber - 1) {
155
+ throw new InitialCheckpointNumberNotSequentialError(firstBlockCheckpointNumber, previousCheckpointNumber);
156
+ }
157
+
158
+ // Extract the previous block if there is one and see if it is for the same checkpoint or not
159
+ const previousBlockResult = await this.getBlock(previousBlockNumber);
160
+
161
+ let expectedFirstblockIndex = 0;
162
+ let previousBlockIndex: number | undefined = undefined;
163
+ if (previousBlockResult !== undefined) {
164
+ if (previousBlockResult.checkpointNumber === firstBlockCheckpointNumber) {
165
+ // The previous block is for the same checkpoint, therefore our index should follow it
166
+ previousBlockIndex = previousBlockResult.indexWithinCheckpoint;
167
+ expectedFirstblockIndex = previousBlockIndex + 1;
168
+ }
169
+ if (!previousBlockResult.archive.root.equals(firstBlockLastArchive)) {
170
+ throw new BlockArchiveNotConsistentError(
171
+ firstBlockNumber,
172
+ previousBlockResult.number,
173
+ firstBlockLastArchive,
174
+ previousBlockResult.archive.root,
175
+ );
176
+ }
177
+ }
178
+
179
+ // Now check that the first block has the expected index value
180
+ if (!opts.force && expectedFirstblockIndex !== firstBlockIndex) {
181
+ throw new BlockIndexNotSequentialError(firstBlockIndex, previousBlockIndex);
182
+ }
183
+
184
+ // Iterate over blocks array and insert them, checking that the block numbers and indexes are sequential. Also check they are for the correct checkpoint.
185
+ let previousBlock: L2BlockNew | undefined = undefined;
114
186
  for (const block of blocks) {
115
- if (!opts.force && previousBlock && previousBlock.block.number + 1 !== block.block.number) {
116
- throw new BlockNumberNotSequentialError(block.block.number, previousBlock.block.number);
187
+ if (!opts.force && previousBlock) {
188
+ if (previousBlock.number + 1 !== block.number) {
189
+ throw new BlockNumberNotSequentialError(block.number, previousBlock.number);
190
+ }
191
+ if (previousBlock.indexWithinCheckpoint + 1 !== block.indexWithinCheckpoint) {
192
+ throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, previousBlock.indexWithinCheckpoint);
193
+ }
194
+ if (!previousBlock.archive.root.equals(block.header.lastArchive.root)) {
195
+ throw new BlockArchiveNotConsistentError(
196
+ block.number,
197
+ previousBlock.number,
198
+ block.header.lastArchive.root,
199
+ previousBlock.archive.root,
200
+ );
201
+ }
202
+ }
203
+ if (!opts.force && firstBlockCheckpointNumber !== block.checkpointNumber) {
204
+ throw new CheckpointNumberNotConsistentError(block.checkpointNumber, firstBlockCheckpointNumber);
117
205
  }
118
206
  previousBlock = block;
119
- const blockHash = L2BlockHash.fromField(await block.block.hash());
120
-
121
- await this.#blocks.set(block.block.number, {
122
- header: block.block.header.toBuffer(),
123
- blockHash: blockHash.toBuffer(),
124
- archive: block.block.archive.toBuffer(),
125
- l1: block.l1,
126
- attestations: block.attestations.map(attestation => attestation.toBuffer()),
127
- });
207
+ await this.addBlockToDatabase(block, block.checkpointNumber, block.indexWithinCheckpoint);
208
+ }
209
+
210
+ return true;
211
+ });
212
+ }
128
213
 
129
- for (let i = 0; i < block.block.body.txEffects.length; i++) {
130
- const txEffect: IndexedTxEffect = {
131
- data: block.block.body.txEffects[i],
132
- l2BlockNumber: block.block.number,
133
- l2BlockHash: blockHash,
134
- txIndexInBlock: i,
135
- };
136
- await this.#txEffects.set(txEffect.data.txHash.toString(), serializeIndexedTxEffect(txEffect));
214
+ /**
215
+ * Append new cheskpoints to the store's list.
216
+ * @param checkpoints - The L2 checkpoints to be added to the store.
217
+ * @returns True if the operation is successful.
218
+ */
219
+ async addCheckpoints(checkpoints: PublishedCheckpoint[], opts: { force?: boolean } = {}): Promise<boolean> {
220
+ if (checkpoints.length === 0) {
221
+ return true;
222
+ }
223
+
224
+ return await this.db.transactionAsync(async () => {
225
+ // Check that the checkpoint immediately before the first block to be added is present in the store.
226
+ const firstCheckpointNumber = checkpoints[0].checkpoint.number;
227
+ const previousCheckpointNumber = await this.getLatestCheckpointNumber();
228
+
229
+ if (previousCheckpointNumber !== firstCheckpointNumber - 1 && !opts.force) {
230
+ throw new InitialCheckpointNumberNotSequentialError(firstCheckpointNumber, previousCheckpointNumber);
231
+ }
232
+
233
+ // Extract the previous checkpoint if there is one
234
+ let previousCheckpointData: CheckpointData | undefined = undefined;
235
+ if (previousCheckpointNumber !== INITIAL_CHECKPOINT_NUMBER - 1) {
236
+ // There should be a previous checkpoint
237
+ previousCheckpointData = await this.getCheckpointData(previousCheckpointNumber);
238
+ if (previousCheckpointData === undefined) {
239
+ throw new CheckpointNotFoundError(previousCheckpointNumber);
137
240
  }
241
+ }
138
242
 
139
- await this.#blockTxs.set(
140
- blockHash.toString(),
141
- Buffer.concat(block.block.body.txEffects.map(tx => tx.txHash.toBuffer())),
142
- );
243
+ let previousBlockNumber: BlockNumber | undefined = undefined;
244
+ let previousBlock: L2BlockNew | undefined = undefined;
143
245
 
144
- // Update indices for block hash and archive
145
- await this.#blockHashIndex.set(blockHash.toString(), block.block.number);
146
- await this.#blockArchiveIndex.set(block.block.archive.root.toString(), block.block.number);
246
+ // If we have a previous checkpoint then we need to get the previous block number
247
+ if (previousCheckpointData !== undefined) {
248
+ previousBlockNumber = BlockNumber(previousCheckpointData.startBlock + previousCheckpointData.numBlocks - 1);
249
+ previousBlock = await this.getBlock(previousBlockNumber);
250
+ if (previousBlock === undefined) {
251
+ // We should be able to get the required previous block
252
+ throw new BlockNotFoundError(previousBlockNumber);
253
+ }
147
254
  }
148
255
 
149
- await this.#lastSynchedL1Block.set(blocks[blocks.length - 1].l1.blockNumber);
256
+ // Iterate over checkpoints array and insert them, checking that the block numbers are sequential.
257
+ let previousCheckpoint: PublishedCheckpoint | undefined = undefined;
258
+ for (const checkpoint of checkpoints) {
259
+ if (
260
+ !opts.force &&
261
+ previousCheckpoint &&
262
+ previousCheckpoint.checkpoint.number + 1 !== checkpoint.checkpoint.number
263
+ ) {
264
+ throw new CheckpointNumberNotSequentialError(
265
+ checkpoint.checkpoint.number,
266
+ previousCheckpoint.checkpoint.number,
267
+ );
268
+ }
269
+ previousCheckpoint = checkpoint;
270
+
271
+ // Store every block in the database. the block may already exist, but this has come from chain and is assumed to be correct.
272
+ for (let i = 0; i < checkpoint.checkpoint.blocks.length; i++) {
273
+ const block = checkpoint.checkpoint.blocks[i];
274
+ if (previousBlock) {
275
+ // The blocks should have a sequential block number
276
+ if (previousBlock.number !== block.number - 1) {
277
+ throw new BlockNumberNotSequentialError(block.number, previousBlock.number);
278
+ }
279
+ // If the blocks are for the same checkpoint then they should have sequential indexes
280
+ if (
281
+ previousBlock.checkpointNumber === block.checkpointNumber &&
282
+ previousBlock.indexWithinCheckpoint !== block.indexWithinCheckpoint - 1
283
+ ) {
284
+ throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, previousBlock.indexWithinCheckpoint);
285
+ }
286
+ if (!previousBlock.archive.root.equals(block.header.lastArchive.root)) {
287
+ throw new BlockArchiveNotConsistentError(
288
+ block.number,
289
+ previousBlock.number,
290
+ block.header.lastArchive.root,
291
+ previousBlock.archive.root,
292
+ );
293
+ }
294
+ } else {
295
+ // No previous block, must be block 1 at checkpoint index 0
296
+ if (block.indexWithinCheckpoint !== 0) {
297
+ throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, undefined);
298
+ }
299
+ if (block.number !== INITIAL_L2_BLOCK_NUM) {
300
+ throw new BlockNumberNotSequentialError(block.number, undefined);
301
+ }
302
+ }
303
+
304
+ previousBlock = block;
305
+ await this.addBlockToDatabase(block, checkpoint.checkpoint.number, i);
306
+ }
307
+
308
+ // Store the checkpoint in the database
309
+ await this.#checkpoints.set(checkpoint.checkpoint.number, {
310
+ header: checkpoint.checkpoint.header.toBuffer(),
311
+ archive: checkpoint.checkpoint.archive.toBuffer(),
312
+ l1: checkpoint.l1.toBuffer(),
313
+ attestations: checkpoint.attestations.map(attestation => attestation.toBuffer()),
314
+ checkpointNumber: checkpoint.checkpoint.number,
315
+ startBlock: checkpoint.checkpoint.blocks[0].number,
316
+ numBlocks: checkpoint.checkpoint.blocks.length,
317
+ });
318
+ }
319
+
320
+ await this.#lastSynchedL1Block.set(checkpoints[checkpoints.length - 1].l1.blockNumber);
150
321
  return true;
151
322
  });
152
323
  }
153
324
 
325
+ private async addBlockToDatabase(block: L2BlockNew, checkpointNumber: number, indexWithinCheckpoint: number) {
326
+ const blockHash = L2BlockHash.fromField(await block.hash());
327
+
328
+ await this.#blocks.set(block.number, {
329
+ header: block.header.toBuffer(),
330
+ blockHash: blockHash.toBuffer(),
331
+ archive: block.archive.toBuffer(),
332
+ checkpointNumber,
333
+ indexWithinCheckpoint,
334
+ });
335
+
336
+ for (let i = 0; i < block.body.txEffects.length; i++) {
337
+ const txEffect: IndexedTxEffect = {
338
+ data: block.body.txEffects[i],
339
+ l2BlockNumber: block.number,
340
+ l2BlockHash: blockHash,
341
+ txIndexInBlock: i,
342
+ };
343
+ await this.#txEffects.set(txEffect.data.txHash.toString(), serializeIndexedTxEffect(txEffect));
344
+ }
345
+
346
+ await this.#blockTxs.set(blockHash.toString(), Buffer.concat(block.body.txEffects.map(tx => tx.txHash.toBuffer())));
347
+
348
+ // Update indices for block hash and archive
349
+ await this.#blockHashIndex.set(blockHash.toString(), block.number);
350
+ await this.#blockArchiveIndex.set(block.archive.root.toString(), block.number);
351
+ }
352
+
154
353
  /**
155
- * Unwinds blocks from the database
354
+ * Unwinds checkpoints from the database
156
355
  * @param from - The tip of the chain, passed for verification purposes,
157
356
  * ensuring that we don't end up deleting something we did not intend
158
- * @param blocksToUnwind - The number of blocks we are to unwind
357
+ * @param checkpointsToUnwind - The number of checkpoints we are to unwind
159
358
  * @returns True if the operation is successful
160
359
  */
161
- async unwindBlocks(from: number, blocksToUnwind: number) {
360
+ async unwindCheckpoints(from: CheckpointNumber, checkpointsToUnwind: number) {
162
361
  return await this.db.transactionAsync(async () => {
163
- const last = await this.getSynchedL2BlockNumber();
362
+ const last = await this.getLatestCheckpointNumber();
164
363
  if (from !== last) {
165
- throw new Error(`Can only unwind blocks from the tip (requested ${from} but current tip is ${last})`);
364
+ throw new Error(`Can only unwind checkpoints from the tip (requested ${from} but current tip is ${last})`);
166
365
  }
167
366
 
168
- const proven = await this.getProvenL2BlockNumber();
169
- if (from - blocksToUnwind < proven) {
170
- await this.setProvenL2BlockNumber(from - blocksToUnwind);
367
+ const proven = await this.getProvenCheckpointNumber();
368
+ if (from - checkpointsToUnwind < proven) {
369
+ await this.setProvenCheckpointNumber(CheckpointNumber(from - checkpointsToUnwind));
171
370
  }
172
371
 
173
- for (let i = 0; i < blocksToUnwind; i++) {
174
- const blockNumber = from - i;
175
- const block = await this.getBlock(blockNumber);
372
+ for (let i = 0; i < checkpointsToUnwind; i++) {
373
+ const checkpointNumber = from - i;
374
+ const checkpoint = await this.#checkpoints.getAsync(checkpointNumber);
176
375
 
177
- if (block === undefined) {
178
- this.#log.warn(`Cannot remove block ${blockNumber} from the store since we don't have it`);
376
+ if (checkpoint === undefined) {
377
+ this.#log.warn(`Cannot remove checkpoint ${checkpointNumber} from the store since we don't have it`);
179
378
  continue;
180
379
  }
181
- await this.#blocks.delete(block.block.number);
182
- await Promise.all(block.block.body.txEffects.map(tx => this.#txEffects.delete(tx.txHash.toString())));
183
- const blockHash = (await block.block.hash()).toString();
184
- await this.#blockTxs.delete(blockHash);
185
-
186
- // Clean up indices
187
- await this.#blockHashIndex.delete(blockHash);
188
- await this.#blockArchiveIndex.delete(block.block.archive.root.toString());
189
-
190
- this.#log.debug(`Unwound block ${blockNumber} ${blockHash}`);
380
+ await this.#checkpoints.delete(checkpointNumber);
381
+ const maxBlock = checkpoint.startBlock + checkpoint.numBlocks - 1;
382
+
383
+ for (let blockNumber = checkpoint.startBlock; blockNumber <= maxBlock; blockNumber++) {
384
+ const block = await this.getBlock(BlockNumber(blockNumber));
385
+
386
+ if (block === undefined) {
387
+ this.#log.warn(`Cannot remove block ${blockNumber} from the store since we don't have it`);
388
+ continue;
389
+ }
390
+ await this.#blocks.delete(block.number);
391
+ await Promise.all(block.body.txEffects.map(tx => this.#txEffects.delete(tx.txHash.toString())));
392
+ const blockHash = (await block.hash()).toString();
393
+ await this.#blockTxs.delete(blockHash);
394
+
395
+ // Clean up indices
396
+ await this.#blockHashIndex.delete(blockHash);
397
+ await this.#blockArchiveIndex.delete(block.archive.root.toString());
398
+
399
+ this.#log.debug(`Unwound block ${blockNumber} ${blockHash} for checkpoint ${checkpointNumber}`);
400
+ }
191
401
  }
192
402
 
193
403
  return true;
194
404
  });
195
405
  }
196
406
 
407
+ async getCheckpointData(checkpointNumber: CheckpointNumber): Promise<CheckpointData | undefined> {
408
+ const checkpointStorage = await this.#checkpoints.getAsync(checkpointNumber);
409
+ if (!checkpointStorage) {
410
+ return undefined;
411
+ }
412
+ return this.checkpointDataFromCheckpointStorage(checkpointStorage);
413
+ }
414
+
415
+ async getRangeOfCheckpoints(from: CheckpointNumber, limit: number): Promise<CheckpointData[]> {
416
+ const checkpoints: CheckpointData[] = [];
417
+ for (let checkpointNumber = from; checkpointNumber < from + limit; checkpointNumber++) {
418
+ const checkpoint = await this.#checkpoints.getAsync(checkpointNumber);
419
+ if (!checkpoint) {
420
+ break;
421
+ }
422
+ checkpoints.push(this.checkpointDataFromCheckpointStorage(checkpoint));
423
+ }
424
+ return checkpoints;
425
+ }
426
+
427
+ private checkpointDataFromCheckpointStorage(checkpointStorage: CheckpointStorage) {
428
+ const data: CheckpointData = {
429
+ header: CheckpointHeader.fromBuffer(checkpointStorage.header),
430
+ archive: AppendOnlyTreeSnapshot.fromBuffer(checkpointStorage.archive),
431
+ checkpointNumber: CheckpointNumber(checkpointStorage.checkpointNumber),
432
+ startBlock: checkpointStorage.startBlock,
433
+ numBlocks: checkpointStorage.numBlocks,
434
+ l1: L1PublishedData.fromBuffer(checkpointStorage.l1),
435
+ attestations: checkpointStorage.attestations,
436
+ };
437
+ return data;
438
+ }
439
+
440
+ async getBlocksForCheckpoint(checkpointNumber: CheckpointNumber): Promise<L2BlockNew[] | undefined> {
441
+ const checkpoint = await this.#checkpoints.getAsync(checkpointNumber);
442
+ if (!checkpoint) {
443
+ return undefined;
444
+ }
445
+
446
+ const blocksForCheckpoint = await toArray(
447
+ this.#blocks.entriesAsync({
448
+ start: checkpoint.startBlock,
449
+ end: checkpoint.startBlock + checkpoint.numBlocks,
450
+ }),
451
+ );
452
+
453
+ const converted = await Promise.all(blocksForCheckpoint.map(x => this.getBlockFromBlockStorage(x[0], x[1])));
454
+ return converted.filter(isDefined);
455
+ }
456
+
457
+ async getProvenBlockNumber(): Promise<BlockNumber> {
458
+ const provenCheckpointNumber = await this.getProvenCheckpointNumber();
459
+ if (provenCheckpointNumber === INITIAL_CHECKPOINT_NUMBER - 1) {
460
+ return BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
461
+ }
462
+ const checkpointStorage = await this.#checkpoints.getAsync(provenCheckpointNumber);
463
+ if (!checkpointStorage) {
464
+ throw new CheckpointNotFoundError(provenCheckpointNumber);
465
+ } else {
466
+ return BlockNumber(checkpointStorage.startBlock + checkpointStorage.numBlocks - 1);
467
+ }
468
+ }
469
+
470
+ async getLatestBlockNumber(): Promise<BlockNumber> {
471
+ const [latestBlocknumber] = await toArray(this.#blocks.keysAsync({ reverse: true, limit: 1 }));
472
+ return typeof latestBlocknumber === 'number'
473
+ ? BlockNumber(latestBlocknumber)
474
+ : BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
475
+ }
476
+
477
+ async getLatestCheckpointNumber(): Promise<CheckpointNumber> {
478
+ const [latestCheckpointNumber] = await toArray(this.#checkpoints.keysAsync({ reverse: true, limit: 1 }));
479
+ if (latestCheckpointNumber === undefined) {
480
+ return CheckpointNumber(INITIAL_CHECKPOINT_NUMBER - 1);
481
+ }
482
+ return CheckpointNumber(latestCheckpointNumber);
483
+ }
484
+
485
+ async getCheckpointedBlock(number: BlockNumber): Promise<CheckpointedL2Block | undefined> {
486
+ const blockStorage = await this.#blocks.getAsync(number);
487
+ if (!blockStorage) {
488
+ return undefined;
489
+ }
490
+ const checkpoint = await this.#checkpoints.getAsync(blockStorage.checkpointNumber);
491
+ if (!checkpoint) {
492
+ return undefined;
493
+ }
494
+ const block = await this.getBlockFromBlockStorage(number, blockStorage);
495
+ if (!block) {
496
+ return undefined;
497
+ }
498
+ return new CheckpointedL2Block(
499
+ CheckpointNumber(checkpoint.checkpointNumber),
500
+ block,
501
+ L1PublishedData.fromBuffer(checkpoint.l1),
502
+ checkpoint.attestations.map(buf => CommitteeAttestation.fromBuffer(buf)),
503
+ );
504
+ }
505
+
506
+ async getCheckpointedBlockByHash(blockHash: Fr): Promise<CheckpointedL2Block | undefined> {
507
+ const blockNumber = await this.#blockHashIndex.getAsync(blockHash.toString());
508
+ if (blockNumber === undefined) {
509
+ return undefined;
510
+ }
511
+ return this.getCheckpointedBlock(BlockNumber(blockNumber));
512
+ }
513
+ async getCheckpointedBlockByArchive(archive: Fr): Promise<CheckpointedL2Block | undefined> {
514
+ const blockNumber = await this.#blockArchiveIndex.getAsync(archive.toString());
515
+ if (blockNumber === undefined) {
516
+ return undefined;
517
+ }
518
+ return this.getCheckpointedBlock(BlockNumber(blockNumber));
519
+ }
520
+
197
521
  /**
198
522
  * Gets up to `limit` amount of L2 blocks starting from `from`.
199
523
  * @param start - Number of the first block to return (inclusive).
200
524
  * @param limit - The number of blocks to return.
201
525
  * @returns The requested L2 blocks
202
526
  */
203
- async *getBlocks(start: number, limit: number): AsyncIterableIterator<PublishedL2Block> {
527
+ async *getBlocks(start: BlockNumber, limit: number): AsyncIterableIterator<L2BlockNew> {
204
528
  for await (const [blockNumber, blockStorage] of this.getBlockStorages(start, limit)) {
205
529
  const block = await this.getBlockFromBlockStorage(blockNumber, blockStorage);
206
530
  if (block) {
@@ -214,7 +538,7 @@ export class BlockStore {
214
538
  * @param blockNumber - The number of the block to return.
215
539
  * @returns The requested L2 block.
216
540
  */
217
- async getBlock(blockNumber: number): Promise<PublishedL2Block | undefined> {
541
+ async getBlock(blockNumber: BlockNumber): Promise<L2BlockNew | undefined> {
218
542
  const blockStorage = await this.#blocks.getAsync(blockNumber);
219
543
  if (!blockStorage || !blockStorage.header) {
220
544
  return Promise.resolve(undefined);
@@ -227,12 +551,12 @@ export class BlockStore {
227
551
  * @param blockHash - The hash of the block to return.
228
552
  * @returns The requested L2 block.
229
553
  */
230
- async getBlockByHash(blockHash: L2BlockHash): Promise<PublishedL2Block | undefined> {
554
+ async getBlockByHash(blockHash: L2BlockHash): Promise<L2BlockNew | undefined> {
231
555
  const blockNumber = await this.#blockHashIndex.getAsync(blockHash.toString());
232
556
  if (blockNumber === undefined) {
233
557
  return undefined;
234
558
  }
235
- return this.getBlock(blockNumber);
559
+ return this.getBlock(BlockNumber(blockNumber));
236
560
  }
237
561
 
238
562
  /**
@@ -240,12 +564,12 @@ export class BlockStore {
240
564
  * @param archive - The archive root of the block to return.
241
565
  * @returns The requested L2 block.
242
566
  */
243
- async getBlockByArchive(archive: Fr): Promise<PublishedL2Block | undefined> {
567
+ async getBlockByArchive(archive: Fr): Promise<L2BlockNew | undefined> {
244
568
  const blockNumber = await this.#blockArchiveIndex.getAsync(archive.toString());
245
569
  if (blockNumber === undefined) {
246
570
  return undefined;
247
571
  }
248
- return this.getBlock(blockNumber);
572
+ return this.getBlock(BlockNumber(blockNumber));
249
573
  }
250
574
 
251
575
  /**
@@ -262,7 +586,7 @@ export class BlockStore {
262
586
  if (!blockStorage || !blockStorage.header) {
263
587
  return undefined;
264
588
  }
265
- return L2BlockHeader.fromBuffer(blockStorage.header).toBlockHeader();
589
+ return BlockHeader.fromBuffer(blockStorage.header);
266
590
  }
267
591
 
268
592
  /**
@@ -279,7 +603,7 @@ export class BlockStore {
279
603
  if (!blockStorage || !blockStorage.header) {
280
604
  return undefined;
281
605
  }
282
- return L2BlockHeader.fromBuffer(blockStorage.header).toBlockHeader();
606
+ return BlockHeader.fromBuffer(blockStorage.header);
283
607
  }
284
608
 
285
609
  /**
@@ -288,9 +612,9 @@ export class BlockStore {
288
612
  * @param limit - The number of blocks to return.
289
613
  * @returns The requested L2 block headers
290
614
  */
291
- async *getBlockHeaders(start: number, limit: number): AsyncIterableIterator<BlockHeader> {
615
+ async *getBlockHeaders(start: BlockNumber, limit: number): AsyncIterableIterator<BlockHeader> {
292
616
  for await (const [blockNumber, blockStorage] of this.getBlockStorages(start, limit)) {
293
- const header = L2BlockHeader.fromBuffer(blockStorage.header).toBlockHeader();
617
+ const header = BlockHeader.fromBuffer(blockStorage.header);
294
618
  if (header.getBlockNumber() !== blockNumber) {
295
619
  throw new Error(
296
620
  `Block number mismatch when retrieving block header from archive (expected ${blockNumber} but got ${header.getBlockNumber()})`,
@@ -300,7 +624,7 @@ export class BlockStore {
300
624
  }
301
625
  }
302
626
 
303
- private async *getBlockStorages(start: number, limit: number) {
627
+ private async *getBlockStorages(start: BlockNumber, limit: number) {
304
628
  let expectedBlockNumber = start;
305
629
  for await (const [blockNumber, blockStorage] of this.#blocks.entriesAsync(this.#computeBlockRange(start, limit))) {
306
630
  if (blockNumber !== expectedBlockNumber) {
@@ -316,8 +640,8 @@ export class BlockStore {
316
640
  private async getBlockFromBlockStorage(
317
641
  blockNumber: number,
318
642
  blockStorage: BlockStorage,
319
- ): Promise<PublishedL2Block | undefined> {
320
- const header = L2BlockHeader.fromBuffer(blockStorage.header);
643
+ ): Promise<L2BlockNew | undefined> {
644
+ const header = BlockHeader.fromBuffer(blockStorage.header);
321
645
  const archive = AppendOnlyTreeSnapshot.fromBuffer(blockStorage.archive);
322
646
  const blockHash = blockStorage.blockHash;
323
647
  const blockHashString = bufferToHex(blockHash);
@@ -339,7 +663,13 @@ export class BlockStore {
339
663
  txEffects.push(deserializeIndexedTxEffect(txEffect).data);
340
664
  }
341
665
  const body = new Body(txEffects);
342
- const block = new L2Block(archive, header, body, Fr.fromBuffer(blockHash));
666
+ const block = new L2BlockNew(
667
+ archive,
668
+ header,
669
+ body,
670
+ CheckpointNumber(blockStorage.checkpointNumber!),
671
+ blockStorage.indexWithinCheckpoint,
672
+ );
343
673
 
344
674
  if (block.number !== blockNumber) {
345
675
  throw new Error(
@@ -348,8 +678,7 @@ export class BlockStore {
348
678
  } with hash ${blockHashString})`,
349
679
  );
350
680
  }
351
- const attestations = blockStorage.attestations.map(CommitteeAttestation.fromBuffer);
352
- return PublishedL2Block.fromFields({ block, l1: blockStorage.l1, attestations });
681
+ return block;
353
682
  }
354
683
 
355
684
  /**
@@ -382,7 +711,7 @@ export class BlockStore {
382
711
  '',
383
712
  txEffect.data.transactionFee.toBigInt(),
384
713
  txEffect.l2BlockHash,
385
- txEffect.l2BlockNumber,
714
+ BlockNumber(txEffect.l2BlockNumber),
386
715
  );
387
716
  }
388
717
 
@@ -410,12 +739,21 @@ export class BlockStore {
410
739
  }
411
740
 
412
741
  /**
413
- * Gets the number of the latest L2 block processed.
414
- * @returns The number of the latest L2 block processed.
742
+ * Gets the number of the latest L2 block checkpointed.
743
+ * @returns The number of the latest L2 block checkpointed.
415
744
  */
416
- async getSynchedL2BlockNumber(): Promise<number> {
745
+ async getCheckpointedL2BlockNumber(): Promise<BlockNumber> {
746
+ const latestCheckpointNumber = await this.getLatestCheckpointNumber();
747
+ const checkpoint = await this.getCheckpointData(latestCheckpointNumber);
748
+ if (!checkpoint) {
749
+ return BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
750
+ }
751
+ return BlockNumber(checkpoint.startBlock + checkpoint.numBlocks - 1);
752
+ }
753
+
754
+ async getLatestL2BlockNumber(): Promise<BlockNumber> {
417
755
  const [lastBlockNumber] = await toArray(this.#blocks.keysAsync({ reverse: true, limit: 1 }));
418
- return typeof lastBlockNumber === 'number' ? lastBlockNumber : INITIAL_L2_BLOCK_NUM - 1;
756
+ return typeof lastBlockNumber === 'number' ? BlockNumber(lastBlockNumber) : BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
419
757
  }
420
758
 
421
759
  /**
@@ -430,19 +768,22 @@ export class BlockStore {
430
768
  return this.#lastSynchedL1Block.set(l1BlockNumber);
431
769
  }
432
770
 
433
- async getProvenL2BlockNumber(): Promise<number> {
434
- const [latestBlockNumber, provenBlockNumber] = await Promise.all([
435
- this.getSynchedL2BlockNumber(),
436
- this.#lastProvenL2Block.getAsync(),
771
+ async getProvenCheckpointNumber(): Promise<CheckpointNumber> {
772
+ const [latestCheckpointNumber, provenCheckpointNumber] = await Promise.all([
773
+ this.getLatestCheckpointNumber(),
774
+ this.#lastProvenCheckpoint.getAsync(),
437
775
  ]);
438
- return (provenBlockNumber ?? 0) > latestBlockNumber ? latestBlockNumber : (provenBlockNumber ?? 0);
776
+ return (provenCheckpointNumber ?? 0) > latestCheckpointNumber
777
+ ? latestCheckpointNumber
778
+ : CheckpointNumber(provenCheckpointNumber ?? 0);
439
779
  }
440
780
 
441
- setProvenL2BlockNumber(blockNumber: number) {
442
- return this.#lastProvenL2Block.set(blockNumber);
781
+ async setProvenCheckpointNumber(checkpointNumber: CheckpointNumber) {
782
+ const result = await this.#lastProvenCheckpoint.set(checkpointNumber);
783
+ return result;
443
784
  }
444
785
 
445
- #computeBlockRange(start: number, limit: number): Required<Pick<Range<number>, 'start' | 'limit'>> {
786
+ #computeBlockRange(start: BlockNumber, limit: number): Required<Pick<Range<number>, 'start' | 'limit'>> {
446
787
  if (limit < 1) {
447
788
  throw new Error(`Invalid limit: ${limit}`);
448
789
  }