@aztec/archiver 0.0.1-commit.e558bd1c → 0.0.1-commit.e588bc7e5

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 (110) hide show
  1. package/README.md +12 -6
  2. package/dest/archiver.d.ts +9 -6
  3. package/dest/archiver.d.ts.map +1 -1
  4. package/dest/archiver.js +78 -113
  5. package/dest/config.d.ts +3 -3
  6. package/dest/config.d.ts.map +1 -1
  7. package/dest/config.js +2 -1
  8. package/dest/errors.d.ts +34 -10
  9. package/dest/errors.d.ts.map +1 -1
  10. package/dest/errors.js +45 -16
  11. package/dest/factory.d.ts +4 -5
  12. package/dest/factory.d.ts.map +1 -1
  13. package/dest/factory.js +31 -26
  14. package/dest/index.d.ts +2 -1
  15. package/dest/index.d.ts.map +1 -1
  16. package/dest/index.js +1 -0
  17. package/dest/l1/bin/retrieve-calldata.js +32 -28
  18. package/dest/l1/calldata_retriever.d.ts +73 -50
  19. package/dest/l1/calldata_retriever.d.ts.map +1 -1
  20. package/dest/l1/calldata_retriever.js +191 -259
  21. package/dest/l1/data_retrieval.d.ts +10 -10
  22. package/dest/l1/data_retrieval.d.ts.map +1 -1
  23. package/dest/l1/data_retrieval.js +34 -33
  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/modules/data_source_base.d.ts +14 -7
  28. package/dest/modules/data_source_base.d.ts.map +1 -1
  29. package/dest/modules/data_source_base.js +39 -77
  30. package/dest/modules/data_store_updater.d.ts +25 -12
  31. package/dest/modules/data_store_updater.d.ts.map +1 -1
  32. package/dest/modules/data_store_updater.js +125 -94
  33. package/dest/modules/instrumentation.d.ts +15 -2
  34. package/dest/modules/instrumentation.d.ts.map +1 -1
  35. package/dest/modules/instrumentation.js +19 -2
  36. package/dest/modules/l1_synchronizer.d.ts +7 -9
  37. package/dest/modules/l1_synchronizer.d.ts.map +1 -1
  38. package/dest/modules/l1_synchronizer.js +176 -136
  39. package/dest/modules/validation.d.ts +1 -1
  40. package/dest/modules/validation.d.ts.map +1 -1
  41. package/dest/modules/validation.js +2 -2
  42. package/dest/store/block_store.d.ts +65 -28
  43. package/dest/store/block_store.d.ts.map +1 -1
  44. package/dest/store/block_store.js +311 -134
  45. package/dest/store/contract_class_store.d.ts +2 -3
  46. package/dest/store/contract_class_store.d.ts.map +1 -1
  47. package/dest/store/contract_class_store.js +7 -67
  48. package/dest/store/contract_instance_store.d.ts +1 -1
  49. package/dest/store/contract_instance_store.d.ts.map +1 -1
  50. package/dest/store/contract_instance_store.js +6 -2
  51. package/dest/store/kv_archiver_store.d.ts +61 -24
  52. package/dest/store/kv_archiver_store.d.ts.map +1 -1
  53. package/dest/store/kv_archiver_store.js +75 -27
  54. package/dest/store/l2_tips_cache.d.ts +20 -0
  55. package/dest/store/l2_tips_cache.d.ts.map +1 -0
  56. package/dest/store/l2_tips_cache.js +109 -0
  57. package/dest/store/log_store.d.ts +6 -3
  58. package/dest/store/log_store.d.ts.map +1 -1
  59. package/dest/store/log_store.js +93 -16
  60. package/dest/store/message_store.d.ts +5 -1
  61. package/dest/store/message_store.d.ts.map +1 -1
  62. package/dest/store/message_store.js +21 -9
  63. package/dest/test/fake_l1_state.d.ts +14 -1
  64. package/dest/test/fake_l1_state.d.ts.map +1 -1
  65. package/dest/test/fake_l1_state.js +120 -26
  66. package/dest/test/mock_archiver.d.ts +1 -1
  67. package/dest/test/mock_archiver.d.ts.map +1 -1
  68. package/dest/test/mock_archiver.js +3 -2
  69. package/dest/test/mock_l1_to_l2_message_source.d.ts +1 -1
  70. package/dest/test/mock_l1_to_l2_message_source.d.ts.map +1 -1
  71. package/dest/test/mock_l1_to_l2_message_source.js +2 -1
  72. package/dest/test/mock_l2_block_source.d.ts +26 -5
  73. package/dest/test/mock_l2_block_source.d.ts.map +1 -1
  74. package/dest/test/mock_l2_block_source.js +160 -89
  75. package/dest/test/mock_structs.d.ts +4 -1
  76. package/dest/test/mock_structs.d.ts.map +1 -1
  77. package/dest/test/mock_structs.js +13 -1
  78. package/dest/test/noop_l1_archiver.d.ts +4 -1
  79. package/dest/test/noop_l1_archiver.d.ts.map +1 -1
  80. package/dest/test/noop_l1_archiver.js +5 -1
  81. package/package.json +13 -13
  82. package/src/archiver.ts +97 -133
  83. package/src/config.ts +8 -1
  84. package/src/errors.ts +70 -26
  85. package/src/factory.ts +46 -24
  86. package/src/index.ts +1 -0
  87. package/src/l1/README.md +25 -68
  88. package/src/l1/bin/retrieve-calldata.ts +40 -27
  89. package/src/l1/calldata_retriever.ts +250 -379
  90. package/src/l1/data_retrieval.ts +30 -36
  91. package/src/l1/spire_proposer.ts +7 -15
  92. package/src/modules/data_source_base.ts +78 -98
  93. package/src/modules/data_store_updater.ts +138 -124
  94. package/src/modules/instrumentation.ts +29 -2
  95. package/src/modules/l1_synchronizer.ts +195 -168
  96. package/src/modules/validation.ts +2 -2
  97. package/src/store/block_store.ts +393 -170
  98. package/src/store/contract_class_store.ts +8 -106
  99. package/src/store/contract_instance_store.ts +8 -5
  100. package/src/store/kv_archiver_store.ts +115 -41
  101. package/src/store/l2_tips_cache.ts +128 -0
  102. package/src/store/log_store.ts +126 -27
  103. package/src/store/message_store.ts +27 -10
  104. package/src/structs/inbox_message.ts +1 -1
  105. package/src/test/fake_l1_state.ts +163 -30
  106. package/src/test/mock_archiver.ts +3 -2
  107. package/src/test/mock_l1_to_l2_message_source.ts +1 -0
  108. package/src/test/mock_l2_block_source.ts +209 -82
  109. package/src/test/mock_structs.ts +20 -6
  110. package/src/test/noop_l1_archiver.ts +7 -1
@@ -7,31 +7,33 @@ import { BufferReader } from '@aztec/foundation/serialize';
7
7
  import { bufferToHex } from '@aztec/foundation/string';
8
8
  import { isDefined } from '@aztec/foundation/types';
9
9
  import { Body, CheckpointedL2Block, CommitteeAttestation, L2Block, deserializeValidateCheckpointResult, serializeValidateCheckpointResult } from '@aztec/stdlib/block';
10
- import { L1PublishedData } from '@aztec/stdlib/checkpoint';
10
+ import { Checkpoint, L1PublishedData } from '@aztec/stdlib/checkpoint';
11
+ import { getEpochAtSlot } from '@aztec/stdlib/epoch-helpers';
11
12
  import { CheckpointHeader } from '@aztec/stdlib/rollup';
12
13
  import { AppendOnlyTreeSnapshot } from '@aztec/stdlib/trees';
13
14
  import { BlockHeader, TxHash, TxReceipt, TxStatus, deserializeIndexedTxEffect, serializeIndexedTxEffect } from '@aztec/stdlib/tx';
14
- import { BlockArchiveNotConsistentError, BlockIndexNotSequentialError, BlockNotFoundError, BlockNumberNotSequentialError, CannotOverwriteCheckpointedBlockError, CheckpointNotFoundError, CheckpointNumberNotConsistentError, CheckpointNumberNotSequentialError, InitialBlockNumberNotSequentialError, InitialCheckpointNumberNotSequentialError } from '../errors.js';
15
+ import { BlockAlreadyCheckpointedError, BlockArchiveNotConsistentError, BlockIndexNotSequentialError, BlockNotFoundError, BlockNumberNotSequentialError, CannotOverwriteCheckpointedBlockError, CheckpointNotFoundError, CheckpointNumberNotSequentialError, InitialCheckpointNumberNotSequentialError, ProposedCheckpointNotSequentialError, ProposedCheckpointStaleError } from '../errors.js';
15
16
  export { TxReceipt } from '@aztec/stdlib/tx';
16
17
  /**
17
18
  * LMDB-based block storage for the archiver.
18
19
  */ export class BlockStore {
19
20
  db;
20
- l1Constants;
21
21
  /** Map block number to block data */ #blocks;
22
22
  /** Map checkpoint number to checkpoint data */ #checkpoints;
23
+ /** Map slot number to checkpoint number, for looking up checkpoints by slot range. */ #slotToCheckpoint;
23
24
  /** Map block hash to list of tx hashes */ #blockTxs;
24
25
  /** Tx hash to serialized IndexedTxEffect */ #txEffects;
25
26
  /** Stores L1 block number in which the last processed L2 block was included */ #lastSynchedL1Block;
26
27
  /** Stores last proven checkpoint */ #lastProvenCheckpoint;
28
+ /** Stores last finalized checkpoint (proven at or before the finalized L1 block) */ #lastFinalizedCheckpoint;
27
29
  /** Stores the pending chain validation status */ #pendingChainValidationStatus;
28
30
  /** Index mapping a contract's address (as a string) to its location in a block */ #contractIndex;
29
31
  /** Index mapping block hash to block number */ #blockHashIndex;
30
32
  /** Index mapping block archive to block number */ #blockArchiveIndex;
33
+ /** Singleton: assumes max 1-deep pipeline. For deeper pipelining, replace with a map keyed by checkpoint number. */ #proposedCheckpoint;
31
34
  #log;
32
- constructor(db, l1Constants){
35
+ constructor(db){
33
36
  this.db = db;
34
- this.l1Constants = l1Constants;
35
37
  this.#log = createLogger('archiver:block_store');
36
38
  this.#blocks = db.openMap('archiver_blocks');
37
39
  this.#blockTxs = db.openMap('archiver_block_txs');
@@ -41,94 +43,94 @@ export { TxReceipt } from '@aztec/stdlib/tx';
41
43
  this.#blockArchiveIndex = db.openMap('archiver_block_archive_index');
42
44
  this.#lastSynchedL1Block = db.openSingleton('archiver_last_synched_l1_block');
43
45
  this.#lastProvenCheckpoint = db.openSingleton('archiver_last_proven_l2_checkpoint');
46
+ this.#lastFinalizedCheckpoint = db.openSingleton('archiver_last_finalized_l2_checkpoint');
44
47
  this.#pendingChainValidationStatus = db.openSingleton('archiver_pending_chain_validation_status');
45
48
  this.#checkpoints = db.openMap('archiver_checkpoints');
49
+ this.#slotToCheckpoint = db.openMap('archiver_slot_to_checkpoint');
50
+ this.#proposedCheckpoint = db.openSingleton('proposed_checkpoint_data');
46
51
  }
47
52
  /**
48
- * Computes the finalized block number based on the proven block number.
49
- * A block is considered finalized when it's 2 epochs behind the proven block.
50
- * TODO(#13569): Compute proper finalized block number based on L1 finalized block.
51
- * TODO(palla/mbps): Even the provisional computation is wrong, since it should subtract checkpoints, not blocks
53
+ * Returns the finalized L2 block number. An L2 block is finalized when it was proven
54
+ * in an L1 block that has itself been finalized on Ethereum.
52
55
  * @returns The finalized block number.
53
56
  */ async getFinalizedL2BlockNumber() {
54
- const provenBlockNumber = await this.getProvenBlockNumber();
55
- return BlockNumber(Math.max(provenBlockNumber - this.l1Constants.epochDuration * 2, 0));
57
+ const finalizedCheckpointNumber = await this.getFinalizedCheckpointNumber();
58
+ if (finalizedCheckpointNumber === INITIAL_CHECKPOINT_NUMBER - 1) {
59
+ return BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
60
+ }
61
+ const checkpointStorage = await this.#checkpoints.getAsync(finalizedCheckpointNumber);
62
+ if (!checkpointStorage) {
63
+ throw new CheckpointNotFoundError(finalizedCheckpointNumber);
64
+ }
65
+ return BlockNumber(checkpointStorage.startBlock + checkpointStorage.blockCount - 1);
56
66
  }
57
67
  /**
58
- * Append new proposed blocks to the store's list. All blocks must be for the 'current' checkpoint.
59
- * These are uncheckpointed blocks that have been proposed by the sequencer but not yet included in a checkpoint on L1.
68
+ * Append a new proposed block to the store.
69
+ * This is an uncheckpointed block that has been proposed by the sequencer but not yet included in a checkpoint on L1.
60
70
  * For checkpointed blocks (already published to L1), use addCheckpoints() instead.
61
- * @param blocks - The proposed L2 blocks to be added to the store.
71
+ * @param block - The proposed L2 block to be added to the store.
62
72
  * @returns True if the operation is successful.
63
- */ async addProposedBlocks(blocks, opts = {}) {
64
- if (blocks.length === 0) {
65
- return true;
66
- }
73
+ */ async addProposedBlock(block, opts = {}) {
67
74
  return await this.db.transactionAsync(async ()=>{
68
- // Check that the block immediately before the first block to be added is present in the store.
69
- const firstBlockNumber = blocks[0].number;
70
- const firstBlockCheckpointNumber = blocks[0].checkpointNumber;
71
- const firstBlockIndex = blocks[0].indexWithinCheckpoint;
72
- const firstBlockLastArchive = blocks[0].header.lastArchive.root;
75
+ const blockNumber = block.number;
76
+ const blockCheckpointNumber = block.checkpointNumber;
77
+ const blockIndex = block.indexWithinCheckpoint;
78
+ const blockLastArchive = block.header.lastArchive.root;
73
79
  // Extract the latest block and checkpoint numbers
74
- const previousBlockNumber = await this.getLatestBlockNumber();
80
+ const previousBlockNumber = await this.getLatestL2BlockNumber();
81
+ const proposedCheckpointNumber = await this.getProposedCheckpointNumber();
75
82
  const previousCheckpointNumber = await this.getLatestCheckpointNumber();
76
83
  // Verify we're not overwriting checkpointed blocks
77
84
  const lastCheckpointedBlockNumber = await this.getCheckpointedL2BlockNumber();
78
- if (!opts.force && firstBlockNumber <= lastCheckpointedBlockNumber) {
79
- throw new CannotOverwriteCheckpointedBlockError(firstBlockNumber, lastCheckpointedBlockNumber);
85
+ if (!opts.force && blockNumber <= lastCheckpointedBlockNumber) {
86
+ // Check if the proposed block matches the already-checkpointed one
87
+ const existingBlock = await this.getBlock(BlockNumber(blockNumber));
88
+ if (existingBlock && existingBlock.archive.root.equals(block.archive.root)) {
89
+ throw new BlockAlreadyCheckpointedError(blockNumber);
90
+ }
91
+ throw new CannotOverwriteCheckpointedBlockError(blockNumber, lastCheckpointedBlockNumber);
80
92
  }
81
- // Check that the first block number is the expected one
82
- if (!opts.force && previousBlockNumber !== firstBlockNumber - 1) {
83
- throw new InitialBlockNumberNotSequentialError(firstBlockNumber, previousBlockNumber);
93
+ // Check that the block number is the expected one
94
+ if (!opts.force && previousBlockNumber !== blockNumber - 1) {
95
+ throw new BlockNumberNotSequentialError(blockNumber, previousBlockNumber);
84
96
  }
85
- // The same check as above but for checkpoints
86
- if (!opts.force && previousCheckpointNumber !== firstBlockCheckpointNumber - 1) {
87
- throw new InitialCheckpointNumberNotSequentialError(firstBlockCheckpointNumber, previousCheckpointNumber);
97
+ // The same check as above but for checkpoints. Accept the block if either the confirmed
98
+ // checkpoint or the pending (locally validated but not yet confirmed) checkpoint matches.
99
+ const expectedCheckpointNumber = blockCheckpointNumber - 1;
100
+ if (!opts.force && previousCheckpointNumber !== expectedCheckpointNumber && proposedCheckpointNumber !== expectedCheckpointNumber) {
101
+ const [reported, source] = proposedCheckpointNumber > previousCheckpointNumber ? [
102
+ proposedCheckpointNumber,
103
+ 'proposed'
104
+ ] : [
105
+ previousCheckpointNumber,
106
+ 'confirmed'
107
+ ];
108
+ throw new CheckpointNumberNotSequentialError(blockCheckpointNumber, reported, source);
88
109
  }
89
110
  // Extract the previous block if there is one and see if it is for the same checkpoint or not
90
111
  const previousBlockResult = await this.getBlock(previousBlockNumber);
91
- let expectedFirstblockIndex = 0;
112
+ let expectedBlockIndex = 0;
92
113
  let previousBlockIndex = undefined;
93
114
  if (previousBlockResult !== undefined) {
94
- if (previousBlockResult.checkpointNumber === firstBlockCheckpointNumber) {
115
+ if (previousBlockResult.checkpointNumber === blockCheckpointNumber) {
95
116
  // The previous block is for the same checkpoint, therefore our index should follow it
96
117
  previousBlockIndex = previousBlockResult.indexWithinCheckpoint;
97
- expectedFirstblockIndex = previousBlockIndex + 1;
118
+ expectedBlockIndex = previousBlockIndex + 1;
98
119
  }
99
- if (!previousBlockResult.archive.root.equals(firstBlockLastArchive)) {
100
- throw new BlockArchiveNotConsistentError(firstBlockNumber, previousBlockResult.number, firstBlockLastArchive, previousBlockResult.archive.root);
120
+ if (!previousBlockResult.archive.root.equals(blockLastArchive)) {
121
+ throw new BlockArchiveNotConsistentError(blockNumber, previousBlockResult.number, blockLastArchive, previousBlockResult.archive.root);
101
122
  }
102
123
  }
103
- // Now check that the first block has the expected index value
104
- if (!opts.force && expectedFirstblockIndex !== firstBlockIndex) {
105
- throw new BlockIndexNotSequentialError(firstBlockIndex, previousBlockIndex);
106
- }
107
- // Iterate over blocks array and insert them, checking that the block numbers and indexes are sequential. Also check they are for the correct checkpoint.
108
- let previousBlock = undefined;
109
- for (const block of blocks){
110
- if (!opts.force && previousBlock) {
111
- if (previousBlock.number + 1 !== block.number) {
112
- throw new BlockNumberNotSequentialError(block.number, previousBlock.number);
113
- }
114
- if (previousBlock.indexWithinCheckpoint + 1 !== block.indexWithinCheckpoint) {
115
- throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, previousBlock.indexWithinCheckpoint);
116
- }
117
- if (!previousBlock.archive.root.equals(block.header.lastArchive.root)) {
118
- throw new BlockArchiveNotConsistentError(block.number, previousBlock.number, block.header.lastArchive.root, previousBlock.archive.root);
119
- }
120
- }
121
- if (!opts.force && firstBlockCheckpointNumber !== block.checkpointNumber) {
122
- throw new CheckpointNumberNotConsistentError(block.checkpointNumber, firstBlockCheckpointNumber);
123
- }
124
- previousBlock = block;
125
- await this.addBlockToDatabase(block, block.checkpointNumber, block.indexWithinCheckpoint);
124
+ // Now check that the block has the expected index value
125
+ if (!opts.force && expectedBlockIndex !== blockIndex) {
126
+ throw new BlockIndexNotSequentialError(blockIndex, previousBlockIndex);
126
127
  }
128
+ await this.addBlockToDatabase(block, block.checkpointNumber, block.indexWithinCheckpoint);
127
129
  return true;
128
130
  });
129
131
  }
130
132
  /**
131
- * Append new cheskpoints to the store's list.
133
+ * Append new checkpoints to the store's list.
132
134
  * @param checkpoints - The L2 checkpoints to be added to the store.
133
135
  * @returns True if the operation is successful.
134
136
  */ async addCheckpoints(checkpoints, opts = {}) {
@@ -142,26 +144,8 @@ export { TxReceipt } from '@aztec/stdlib/tx';
142
144
  if (previousCheckpointNumber !== firstCheckpointNumber - 1 && !opts.force) {
143
145
  throw new InitialCheckpointNumberNotSequentialError(firstCheckpointNumber, previousCheckpointNumber);
144
146
  }
145
- // Extract the previous checkpoint if there is one
146
- let previousCheckpointData = undefined;
147
- if (previousCheckpointNumber !== INITIAL_CHECKPOINT_NUMBER - 1) {
148
- // There should be a previous checkpoint
149
- previousCheckpointData = await this.getCheckpointData(previousCheckpointNumber);
150
- if (previousCheckpointData === undefined) {
151
- throw new CheckpointNotFoundError(previousCheckpointNumber);
152
- }
153
- }
154
- let previousBlockNumber = undefined;
155
- let previousBlock = undefined;
156
- // If we have a previous checkpoint then we need to get the previous block number
157
- if (previousCheckpointData !== undefined) {
158
- previousBlockNumber = BlockNumber(previousCheckpointData.startBlock + previousCheckpointData.numBlocks - 1);
159
- previousBlock = await this.getBlock(previousBlockNumber);
160
- if (previousBlock === undefined) {
161
- // We should be able to get the required previous block
162
- throw new BlockNotFoundError(previousBlockNumber);
163
- }
164
- }
147
+ // Get the last block of the previous checkpoint for archive chaining
148
+ let previousBlock = await this.getPreviousCheckpointBlock(firstCheckpointNumber);
165
149
  // Iterate over checkpoints array and insert them, checking that the block numbers are sequential.
166
150
  let previousCheckpoint = undefined;
167
151
  for (const checkpoint of checkpoints){
@@ -169,48 +153,84 @@ export { TxReceipt } from '@aztec/stdlib/tx';
169
153
  throw new CheckpointNumberNotSequentialError(checkpoint.checkpoint.number, previousCheckpoint.checkpoint.number);
170
154
  }
171
155
  previousCheckpoint = checkpoint;
172
- // Store every block in the database. the block may already exist, but this has come from chain and is assumed to be correct.
156
+ // Validate block sequencing, indexes, and archive chaining
157
+ this.validateCheckpointBlocks(checkpoint.checkpoint.blocks, previousBlock);
158
+ // Store every block in the database (may already exist, but L1 data is authoritative)
173
159
  for(let i = 0; i < checkpoint.checkpoint.blocks.length; i++){
174
- const block = checkpoint.checkpoint.blocks[i];
175
- if (previousBlock) {
176
- // The blocks should have a sequential block number
177
- if (previousBlock.number !== block.number - 1) {
178
- throw new BlockNumberNotSequentialError(block.number, previousBlock.number);
179
- }
180
- // If the blocks are for the same checkpoint then they should have sequential indexes
181
- if (previousBlock.checkpointNumber === block.checkpointNumber && previousBlock.indexWithinCheckpoint !== block.indexWithinCheckpoint - 1) {
182
- throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, previousBlock.indexWithinCheckpoint);
183
- }
184
- if (!previousBlock.archive.root.equals(block.header.lastArchive.root)) {
185
- throw new BlockArchiveNotConsistentError(block.number, previousBlock.number, block.header.lastArchive.root, previousBlock.archive.root);
186
- }
187
- } else {
188
- // No previous block, must be block 1 at checkpoint index 0
189
- if (block.indexWithinCheckpoint !== 0) {
190
- throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, undefined);
191
- }
192
- if (block.number !== INITIAL_L2_BLOCK_NUM) {
193
- throw new BlockNumberNotSequentialError(block.number, undefined);
194
- }
195
- }
196
- previousBlock = block;
197
- await this.addBlockToDatabase(block, checkpoint.checkpoint.number, i);
160
+ await this.addBlockToDatabase(checkpoint.checkpoint.blocks[i], checkpoint.checkpoint.number, i);
198
161
  }
162
+ previousBlock = checkpoint.checkpoint.blocks.at(-1);
199
163
  // Store the checkpoint in the database
200
164
  await this.#checkpoints.set(checkpoint.checkpoint.number, {
201
165
  header: checkpoint.checkpoint.header.toBuffer(),
202
166
  archive: checkpoint.checkpoint.archive.toBuffer(),
167
+ checkpointOutHash: checkpoint.checkpoint.getCheckpointOutHash().toBuffer(),
203
168
  l1: checkpoint.l1.toBuffer(),
204
169
  attestations: checkpoint.attestations.map((attestation)=>attestation.toBuffer()),
205
170
  checkpointNumber: checkpoint.checkpoint.number,
206
171
  startBlock: checkpoint.checkpoint.blocks[0].number,
207
- numBlocks: checkpoint.checkpoint.blocks.length
172
+ blockCount: checkpoint.checkpoint.blocks.length
208
173
  });
174
+ // Update slot-to-checkpoint index
175
+ await this.#slotToCheckpoint.set(checkpoint.checkpoint.header.slotNumber, checkpoint.checkpoint.number);
209
176
  }
177
+ // Clear the proposed checkpoint if any of the confirmed checkpoints match or supersede it
178
+ const lastConfirmedCheckpointNumber = checkpoints[checkpoints.length - 1].checkpoint.number;
179
+ await this.clearProposedCheckpointIfSuperseded(lastConfirmedCheckpointNumber);
210
180
  await this.#lastSynchedL1Block.set(checkpoints[checkpoints.length - 1].l1.blockNumber);
211
181
  return true;
212
182
  });
213
183
  }
184
+ /**
185
+ * Gets the last block of the checkpoint before the given one.
186
+ * Returns undefined if there is no previous checkpoint (i.e. genesis).
187
+ */ async getPreviousCheckpointBlock(checkpointNumber) {
188
+ const previousCheckpointNumber = CheckpointNumber(checkpointNumber - 1);
189
+ if (previousCheckpointNumber === INITIAL_CHECKPOINT_NUMBER - 1) {
190
+ return undefined;
191
+ }
192
+ const previousCheckpointData = await this.getCheckpointData(previousCheckpointNumber);
193
+ if (previousCheckpointData === undefined) {
194
+ throw new CheckpointNotFoundError(previousCheckpointNumber);
195
+ }
196
+ const previousBlockNumber = BlockNumber(previousCheckpointData.startBlock + previousCheckpointData.blockCount - 1);
197
+ const previousBlock = await this.getBlock(previousBlockNumber);
198
+ if (previousBlock === undefined) {
199
+ throw new BlockNotFoundError(previousBlockNumber);
200
+ }
201
+ return previousBlock;
202
+ }
203
+ /**
204
+ * Validates that blocks are sequential, have correct indexes, and chain via archive roots.
205
+ * This is the same validation used for both confirmed checkpoints (addCheckpoints) and
206
+ * proposed checkpoints (setProposedCheckpoint).
207
+ */ validateCheckpointBlocks(blocks, previousBlock) {
208
+ for (const block of blocks){
209
+ if (previousBlock) {
210
+ if (previousBlock.number !== block.number - 1) {
211
+ throw new BlockNumberNotSequentialError(block.number, previousBlock.number);
212
+ }
213
+ if (previousBlock.checkpointNumber === block.checkpointNumber) {
214
+ if (previousBlock.indexWithinCheckpoint !== block.indexWithinCheckpoint - 1) {
215
+ throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, previousBlock.indexWithinCheckpoint);
216
+ }
217
+ } else if (block.indexWithinCheckpoint !== 0) {
218
+ throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, previousBlock.indexWithinCheckpoint);
219
+ }
220
+ if (!previousBlock.archive.root.equals(block.header.lastArchive.root)) {
221
+ throw new BlockArchiveNotConsistentError(block.number, previousBlock.number, block.header.lastArchive.root, previousBlock.archive.root);
222
+ }
223
+ } else {
224
+ if (block.indexWithinCheckpoint !== 0) {
225
+ throw new BlockIndexNotSequentialError(block.indexWithinCheckpoint, undefined);
226
+ }
227
+ if (block.number !== INITIAL_L2_BLOCK_NUM) {
228
+ throw new BlockNumberNotSequentialError(block.number, undefined);
229
+ }
230
+ }
231
+ previousBlock = block;
232
+ }
233
+ }
214
234
  async addBlockToDatabase(block, checkpointNumber, indexWithinCheckpoint) {
215
235
  const blockHash = await block.hash();
216
236
  await this.#blocks.set(block.number, {
@@ -274,15 +294,25 @@ export { TxReceipt } from '@aztec/stdlib/tx';
274
294
  if (!targetCheckpoint) {
275
295
  throw new Error(`Target checkpoint ${checkpointNumber} not found in store`);
276
296
  }
277
- lastBlockToKeep = BlockNumber(targetCheckpoint.startBlock + targetCheckpoint.numBlocks - 1);
297
+ lastBlockToKeep = BlockNumber(targetCheckpoint.startBlock + targetCheckpoint.blockCount - 1);
278
298
  }
279
299
  // Remove all blocks after lastBlockToKeep (both checkpointed and uncheckpointed)
280
300
  const blocksRemoved = await this.removeBlocksAfter(lastBlockToKeep);
281
301
  // Remove all checkpoints after the target
282
302
  for(let c = latestCheckpointNumber; c > checkpointNumber; c = CheckpointNumber(c - 1)){
303
+ const checkpointStorage = await this.#checkpoints.getAsync(c);
304
+ if (checkpointStorage) {
305
+ const slotNumber = CheckpointHeader.fromBuffer(checkpointStorage.header).slotNumber;
306
+ await this.#slotToCheckpoint.delete(slotNumber);
307
+ }
283
308
  await this.#checkpoints.delete(c);
284
309
  this.#log.debug(`Removed checkpoint ${c}`);
285
310
  }
311
+ // Clear any proposed checkpoint that was orphaned by the removal (its base chain no longer exists)
312
+ const proposedCheckpointNumber = await this.getProposedCheckpointNumber();
313
+ if (proposedCheckpointNumber > checkpointNumber) {
314
+ await this.#proposedCheckpoint.delete();
315
+ }
286
316
  return {
287
317
  blocksRemoved
288
318
  };
@@ -306,17 +336,30 @@ export { TxReceipt } from '@aztec/stdlib/tx';
306
336
  }
307
337
  return checkpoints;
308
338
  }
339
+ /** Returns checkpoint data for all checkpoints whose slot falls within the given range (inclusive). */ async getCheckpointDataForSlotRange(startSlot, endSlot) {
340
+ const result = [];
341
+ for await (const [, checkpointNumber] of this.#slotToCheckpoint.entriesAsync({
342
+ start: startSlot,
343
+ end: endSlot + 1
344
+ })){
345
+ const checkpointStorage = await this.#checkpoints.getAsync(checkpointNumber);
346
+ if (checkpointStorage) {
347
+ result.push(this.checkpointDataFromCheckpointStorage(checkpointStorage));
348
+ }
349
+ }
350
+ return result;
351
+ }
309
352
  checkpointDataFromCheckpointStorage(checkpointStorage) {
310
- const data = {
353
+ return {
311
354
  header: CheckpointHeader.fromBuffer(checkpointStorage.header),
312
355
  archive: AppendOnlyTreeSnapshot.fromBuffer(checkpointStorage.archive),
356
+ checkpointOutHash: Fr.fromBuffer(checkpointStorage.checkpointOutHash),
313
357
  checkpointNumber: CheckpointNumber(checkpointStorage.checkpointNumber),
314
- startBlock: checkpointStorage.startBlock,
315
- numBlocks: checkpointStorage.numBlocks,
358
+ startBlock: BlockNumber(checkpointStorage.startBlock),
359
+ blockCount: checkpointStorage.blockCount,
316
360
  l1: L1PublishedData.fromBuffer(checkpointStorage.l1),
317
- attestations: checkpointStorage.attestations
361
+ attestations: checkpointStorage.attestations.map((buf)=>CommitteeAttestation.fromBuffer(buf))
318
362
  };
319
- return data;
320
363
  }
321
364
  async getBlocksForCheckpoint(checkpointNumber) {
322
365
  const checkpoint = await this.#checkpoints.getAsync(checkpointNumber);
@@ -325,7 +368,7 @@ export { TxReceipt } from '@aztec/stdlib/tx';
325
368
  }
326
369
  const blocksForCheckpoint = await toArray(this.#blocks.entriesAsync({
327
370
  start: checkpoint.startBlock,
328
- end: checkpoint.startBlock + checkpoint.numBlocks
371
+ end: checkpoint.startBlock + checkpoint.blockCount
329
372
  }));
330
373
  const converted = await Promise.all(blocksForCheckpoint.map((x)=>this.getBlockFromBlockStorage(x[0], x[1])));
331
374
  return converted.filter(isDefined);
@@ -362,7 +405,7 @@ export { TxReceipt } from '@aztec/stdlib/tx';
362
405
  return await this.db.transactionAsync(async ()=>{
363
406
  const removedBlocks = [];
364
407
  // Get the latest block number to determine the range
365
- const latestBlockNumber = await this.getLatestBlockNumber();
408
+ const latestBlockNumber = await this.getLatestL2BlockNumber();
366
409
  // Iterate from blockNumber + 1 to latestBlockNumber
367
410
  for(let bn = blockNumber + 1; bn <= latestBlockNumber; bn++){
368
411
  const block = await this.getBlock(BlockNumber(bn));
@@ -386,16 +429,9 @@ export { TxReceipt } from '@aztec/stdlib/tx';
386
429
  if (!checkpointStorage) {
387
430
  throw new CheckpointNotFoundError(provenCheckpointNumber);
388
431
  } else {
389
- return BlockNumber(checkpointStorage.startBlock + checkpointStorage.numBlocks - 1);
432
+ return BlockNumber(checkpointStorage.startBlock + checkpointStorage.blockCount - 1);
390
433
  }
391
434
  }
392
- async getLatestBlockNumber() {
393
- const [latestBlocknumber] = await toArray(this.#blocks.keysAsync({
394
- reverse: true,
395
- limit: 1
396
- }));
397
- return typeof latestBlocknumber === 'number' ? BlockNumber(latestBlocknumber) : BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
398
- }
399
435
  async getLatestCheckpointNumber() {
400
436
  const [latestCheckpointNumber] = await toArray(this.#checkpoints.keysAsync({
401
437
  reverse: true,
@@ -406,6 +442,70 @@ export { TxReceipt } from '@aztec/stdlib/tx';
406
442
  }
407
443
  return CheckpointNumber(latestCheckpointNumber);
408
444
  }
445
+ async hasProposedCheckpoint() {
446
+ const proposed = await this.#proposedCheckpoint.getAsync();
447
+ return proposed !== undefined;
448
+ }
449
+ /** Deletes the proposed checkpoint from storage. */ async deleteProposedCheckpoint() {
450
+ await this.#proposedCheckpoint.delete();
451
+ }
452
+ /** Clears the proposed checkpoint if the given confirmed checkpoint number supersedes it. */ async clearProposedCheckpointIfSuperseded(confirmedCheckpointNumber) {
453
+ const proposedCheckpointNumber = await this.getProposedCheckpointNumber();
454
+ if (proposedCheckpointNumber <= confirmedCheckpointNumber) {
455
+ await this.#proposedCheckpoint.delete();
456
+ }
457
+ }
458
+ /** Returns the proposed checkpoint data, or undefined if no proposed checkpoint exists. No fallback to confirmed. */ async getProposedCheckpointOnly() {
459
+ const stored = await this.#proposedCheckpoint.getAsync();
460
+ if (!stored) {
461
+ return undefined;
462
+ }
463
+ return this.convertToProposedCheckpointData(stored);
464
+ }
465
+ /**
466
+ * Gets the checkpoint at the proposed tip
467
+ * - pending checkpoint if it exists
468
+ * - fallsback to latest confirmed checkpoint otherwise
469
+ * @returns CommonCheckpointData
470
+ */ async getProposedCheckpoint() {
471
+ const stored = await this.#proposedCheckpoint.getAsync();
472
+ if (!stored) {
473
+ return this.getCheckpointData(await this.getLatestCheckpointNumber());
474
+ }
475
+ return this.convertToProposedCheckpointData(stored);
476
+ }
477
+ convertToProposedCheckpointData(stored) {
478
+ return {
479
+ checkpointNumber: CheckpointNumber(stored.checkpointNumber),
480
+ header: CheckpointHeader.fromBuffer(stored.header),
481
+ archive: AppendOnlyTreeSnapshot.fromBuffer(stored.archive),
482
+ checkpointOutHash: Fr.fromBuffer(stored.checkpointOutHash),
483
+ startBlock: BlockNumber(stored.startBlock),
484
+ blockCount: stored.blockCount,
485
+ totalManaUsed: BigInt(stored.totalManaUsed),
486
+ feeAssetPriceModifier: BigInt(stored.feeAssetPriceModifier)
487
+ };
488
+ }
489
+ /**
490
+ * Attempts to get the proposedCheckpoint's number, if there is not one, then fallback to the latest confirmed checkpoint number.
491
+ * @returns CheckpointNumber
492
+ */ async getProposedCheckpointNumber() {
493
+ const proposed = await this.getProposedCheckpoint();
494
+ if (!proposed) {
495
+ return await this.getLatestCheckpointNumber();
496
+ }
497
+ return CheckpointNumber(proposed.checkpointNumber);
498
+ }
499
+ /**
500
+ * Attempts to get the proposedCheckpoint's block number, if there is not one, then fallback to the checkpointed block number
501
+ * @returns BlockNumber
502
+ */ async getProposedCheckpointL2BlockNumber() {
503
+ const proposed = await this.getProposedCheckpoint();
504
+ if (!proposed) {
505
+ return await this.getCheckpointedL2BlockNumber();
506
+ }
507
+ return BlockNumber(proposed.startBlock + proposed.blockCount - 1);
508
+ }
409
509
  async getCheckpointedBlock(number) {
410
510
  const blockStorage = await this.#blocks.getAsync(number);
411
511
  if (!blockStorage) {
@@ -468,6 +568,28 @@ export { TxReceipt } from '@aztec/stdlib/tx';
468
568
  }
469
569
  }
470
570
  /**
571
+ * Gets block metadata (without tx data) by block number.
572
+ * @param blockNumber - The number of the block to return.
573
+ * @returns The requested block data.
574
+ */ async getBlockData(blockNumber) {
575
+ const blockStorage = await this.#blocks.getAsync(blockNumber);
576
+ if (!blockStorage || !blockStorage.header) {
577
+ return undefined;
578
+ }
579
+ return this.getBlockDataFromBlockStorage(blockStorage);
580
+ }
581
+ /**
582
+ * Gets block metadata (without tx data) by archive root.
583
+ * @param archive - The archive root of the block to return.
584
+ * @returns The requested block data.
585
+ */ async getBlockDataByArchive(archive) {
586
+ const blockNumber = await this.#blockArchiveIndex.getAsync(archive.toString());
587
+ if (blockNumber === undefined) {
588
+ return undefined;
589
+ }
590
+ return this.getBlockData(BlockNumber(blockNumber));
591
+ }
592
+ /**
471
593
  * Gets an L2 block.
472
594
  * @param blockNumber - The number of the block to return.
473
595
  * @returns The requested L2 block.
@@ -557,12 +679,19 @@ export { TxReceipt } from '@aztec/stdlib/tx';
557
679
  ];
558
680
  }
559
681
  }
682
+ getBlockDataFromBlockStorage(blockStorage) {
683
+ return {
684
+ header: BlockHeader.fromBuffer(blockStorage.header),
685
+ archive: AppendOnlyTreeSnapshot.fromBuffer(blockStorage.archive),
686
+ blockHash: Fr.fromBuffer(blockStorage.blockHash),
687
+ checkpointNumber: CheckpointNumber(blockStorage.checkpointNumber),
688
+ indexWithinCheckpoint: IndexWithinCheckpoint(blockStorage.indexWithinCheckpoint)
689
+ };
690
+ }
560
691
  async getBlockFromBlockStorage(blockNumber, blockStorage) {
561
- const header = BlockHeader.fromBuffer(blockStorage.header);
562
- const archive = AppendOnlyTreeSnapshot.fromBuffer(blockStorage.archive);
563
- const blockHash = blockStorage.blockHash;
564
- header.setHash(Fr.fromBuffer(blockHash));
565
- const blockHashString = bufferToHex(blockHash);
692
+ const { header, archive, blockHash, checkpointNumber, indexWithinCheckpoint } = this.getBlockDataFromBlockStorage(blockStorage);
693
+ header.setHash(blockHash);
694
+ const blockHashString = bufferToHex(blockStorage.blockHash);
566
695
  const blockTxsBuffer = await this.#blockTxs.getAsync(blockHashString);
567
696
  if (blockTxsBuffer === undefined) {
568
697
  this.#log.warn(`Could not find body for block ${header.globalVariables.blockNumber} ${blockHash}`);
@@ -580,7 +709,7 @@ export { TxReceipt } from '@aztec/stdlib/tx';
580
709
  txEffects.push(deserializeIndexedTxEffect(txEffect).data);
581
710
  }
582
711
  const body = new Body(txEffects);
583
- const block = new L2Block(archive, header, body, CheckpointNumber(blockStorage.checkpointNumber), IndexWithinCheckpoint(blockStorage.indexWithinCheckpoint));
712
+ const block = new L2Block(archive, header, body, checkpointNumber, indexWithinCheckpoint);
584
713
  if (block.number !== blockNumber) {
585
714
  throw new Error(`Block number mismatch when retrieving block from archive (expected ${blockNumber} but got ${block.number} with hash ${blockHashString})`);
586
715
  }
@@ -601,17 +730,18 @@ export { TxReceipt } from '@aztec/stdlib/tx';
601
730
  * Gets a receipt of a settled tx.
602
731
  * @param txHash - The hash of a tx we try to get the receipt for.
603
732
  * @returns The requested tx receipt (or undefined if not found).
604
- */ async getSettledTxReceipt(txHash) {
733
+ */ async getSettledTxReceipt(txHash, l1Constants) {
605
734
  const txEffect = await this.getTxEffect(txHash);
606
735
  if (!txEffect) {
607
736
  return undefined;
608
737
  }
609
738
  const blockNumber = BlockNumber(txEffect.l2BlockNumber);
610
739
  // Use existing archiver methods to determine finalization level
611
- const [provenBlockNumber, checkpointedBlockNumber, finalizedBlockNumber] = await Promise.all([
740
+ const [provenBlockNumber, checkpointedBlockNumber, finalizedBlockNumber, blockData] = await Promise.all([
612
741
  this.getProvenBlockNumber(),
613
742
  this.getCheckpointedL2BlockNumber(),
614
- this.getFinalizedL2BlockNumber()
743
+ this.getFinalizedL2BlockNumber(),
744
+ this.getBlockData(blockNumber)
615
745
  ]);
616
746
  let status;
617
747
  if (blockNumber <= finalizedBlockNumber) {
@@ -623,7 +753,8 @@ export { TxReceipt } from '@aztec/stdlib/tx';
623
753
  } else {
624
754
  status = TxStatus.PROPOSED;
625
755
  }
626
- return new TxReceipt(txHash, status, TxReceipt.executionResultFromRevertCode(txEffect.data.revertCode), undefined, txEffect.data.transactionFee.toBigInt(), txEffect.l2BlockHash, blockNumber);
756
+ const epochNumber = blockData && l1Constants ? getEpochAtSlot(blockData.header.globalVariables.slotNumber, l1Constants) : undefined;
757
+ return new TxReceipt(txHash, status, TxReceipt.executionResultFromRevertCode(txEffect.data.revertCode), undefined, txEffect.data.transactionFee.toBigInt(), txEffect.l2BlockHash, blockNumber, epochNumber);
627
758
  }
628
759
  /**
629
760
  * Looks up which block included the requested tx effect.
@@ -656,7 +787,7 @@ export { TxReceipt } from '@aztec/stdlib/tx';
656
787
  if (!checkpoint) {
657
788
  return BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
658
789
  }
659
- return BlockNumber(checkpoint.startBlock + checkpoint.numBlocks - 1);
790
+ return BlockNumber(checkpoint.startBlock + checkpoint.blockCount - 1);
660
791
  }
661
792
  async getLatestL2BlockNumber() {
662
793
  const [lastBlockNumber] = await toArray(this.#blocks.keysAsync({
@@ -674,6 +805,42 @@ export { TxReceipt } from '@aztec/stdlib/tx';
674
805
  setSynchedL1BlockNumber(l1BlockNumber) {
675
806
  return this.#lastSynchedL1Block.set(l1BlockNumber);
676
807
  }
808
+ /** Sets the proposed checkpoint (not yet L1-confirmed). Only accepts confirmed + 1.
809
+ * Computes archive and checkpointOutHash from the stored blocks. */ async setProposedCheckpoint(proposed) {
810
+ return await this.db.transactionAsync(async ()=>{
811
+ const current = await this.getProposedCheckpointNumber();
812
+ if (proposed.checkpointNumber <= current) {
813
+ throw new ProposedCheckpointStaleError(proposed.checkpointNumber, current);
814
+ }
815
+ const confirmed = await this.getLatestCheckpointNumber();
816
+ if (proposed.checkpointNumber !== confirmed + 1) {
817
+ throw new ProposedCheckpointNotSequentialError(proposed.checkpointNumber, confirmed);
818
+ }
819
+ // Ensure the previous checkpoint + blocks exist
820
+ const previousBlock = await this.getPreviousCheckpointBlock(proposed.checkpointNumber);
821
+ const blocks = [];
822
+ for(let i = 0; i < proposed.blockCount; i++){
823
+ const block = await this.getBlock(BlockNumber(proposed.startBlock + i));
824
+ if (!block) {
825
+ throw new BlockNotFoundError(proposed.startBlock + i);
826
+ }
827
+ blocks.push(block);
828
+ }
829
+ this.validateCheckpointBlocks(blocks, previousBlock);
830
+ const archive = blocks[blocks.length - 1].archive;
831
+ const checkpointOutHash = Checkpoint.getCheckpointOutHash(blocks);
832
+ await this.#proposedCheckpoint.set({
833
+ header: proposed.header.toBuffer(),
834
+ archive: archive.toBuffer(),
835
+ checkpointOutHash: checkpointOutHash.toBuffer(),
836
+ checkpointNumber: proposed.checkpointNumber,
837
+ startBlock: proposed.startBlock,
838
+ blockCount: proposed.blockCount,
839
+ totalManaUsed: proposed.totalManaUsed.toString(),
840
+ feeAssetPriceModifier: proposed.feeAssetPriceModifier.toString()
841
+ });
842
+ });
843
+ }
677
844
  async getProvenCheckpointNumber() {
678
845
  const [latestCheckpointNumber, provenCheckpointNumber] = await Promise.all([
679
846
  this.getLatestCheckpointNumber(),
@@ -685,6 +852,16 @@ export { TxReceipt } from '@aztec/stdlib/tx';
685
852
  const result = await this.#lastProvenCheckpoint.set(checkpointNumber);
686
853
  return result;
687
854
  }
855
+ async getFinalizedCheckpointNumber() {
856
+ const [latestCheckpointNumber, finalizedCheckpointNumber] = await Promise.all([
857
+ this.getLatestCheckpointNumber(),
858
+ this.#lastFinalizedCheckpoint.getAsync()
859
+ ]);
860
+ return (finalizedCheckpointNumber ?? 0) > latestCheckpointNumber ? latestCheckpointNumber : CheckpointNumber(finalizedCheckpointNumber ?? 0);
861
+ }
862
+ setFinalizedCheckpointNumber(checkpointNumber) {
863
+ return this.#lastFinalizedCheckpoint.set(checkpointNumber);
864
+ }
688
865
  #computeBlockRange(start, limit) {
689
866
  if (limit < 1) {
690
867
  throw new Error(`Invalid limit: ${limit}`);