@aztec/archiver 0.0.1-commit.d117d021b → 0.0.1-commit.d1da697d6

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 (87) hide show
  1. package/README.md +12 -6
  2. package/dest/archiver.d.ts +5 -7
  3. package/dest/archiver.d.ts.map +1 -1
  4. package/dest/archiver.js +56 -20
  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 +3 -4
  12. package/dest/factory.d.ts.map +1 -1
  13. package/dest/factory.js +19 -18
  14. package/dest/l1/calldata_retriever.d.ts +1 -1
  15. package/dest/l1/calldata_retriever.d.ts.map +1 -1
  16. package/dest/l1/calldata_retriever.js +2 -1
  17. package/dest/l1/data_retrieval.d.ts +2 -2
  18. package/dest/l1/data_retrieval.d.ts.map +1 -1
  19. package/dest/l1/data_retrieval.js +13 -14
  20. package/dest/modules/data_source_base.d.ts +8 -6
  21. package/dest/modules/data_source_base.d.ts.map +1 -1
  22. package/dest/modules/data_source_base.js +11 -5
  23. package/dest/modules/data_store_updater.d.ts +14 -11
  24. package/dest/modules/data_store_updater.d.ts.map +1 -1
  25. package/dest/modules/data_store_updater.js +78 -76
  26. package/dest/modules/l1_synchronizer.d.ts +4 -3
  27. package/dest/modules/l1_synchronizer.d.ts.map +1 -1
  28. package/dest/modules/l1_synchronizer.js +160 -127
  29. package/dest/modules/validation.d.ts +1 -1
  30. package/dest/modules/validation.d.ts.map +1 -1
  31. package/dest/modules/validation.js +2 -2
  32. package/dest/store/block_store.d.ts +50 -16
  33. package/dest/store/block_store.d.ts.map +1 -1
  34. package/dest/store/block_store.js +288 -119
  35. package/dest/store/contract_class_store.d.ts +2 -3
  36. package/dest/store/contract_class_store.d.ts.map +1 -1
  37. package/dest/store/contract_class_store.js +7 -67
  38. package/dest/store/contract_instance_store.d.ts +1 -1
  39. package/dest/store/contract_instance_store.d.ts.map +1 -1
  40. package/dest/store/contract_instance_store.js +6 -2
  41. package/dest/store/kv_archiver_store.d.ts +45 -22
  42. package/dest/store/kv_archiver_store.d.ts.map +1 -1
  43. package/dest/store/kv_archiver_store.js +57 -27
  44. package/dest/store/l2_tips_cache.d.ts +2 -1
  45. package/dest/store/l2_tips_cache.d.ts.map +1 -1
  46. package/dest/store/l2_tips_cache.js +25 -5
  47. package/dest/store/log_store.d.ts +6 -3
  48. package/dest/store/log_store.d.ts.map +1 -1
  49. package/dest/store/log_store.js +93 -16
  50. package/dest/store/message_store.d.ts +5 -1
  51. package/dest/store/message_store.d.ts.map +1 -1
  52. package/dest/store/message_store.js +20 -8
  53. package/dest/test/fake_l1_state.d.ts +16 -1
  54. package/dest/test/fake_l1_state.d.ts.map +1 -1
  55. package/dest/test/fake_l1_state.js +77 -8
  56. package/dest/test/mock_l1_to_l2_message_source.d.ts +1 -1
  57. package/dest/test/mock_l1_to_l2_message_source.d.ts.map +1 -1
  58. package/dest/test/mock_l1_to_l2_message_source.js +2 -1
  59. package/dest/test/mock_l2_block_source.d.ts +9 -4
  60. package/dest/test/mock_l2_block_source.d.ts.map +1 -1
  61. package/dest/test/mock_l2_block_source.js +32 -7
  62. package/dest/test/noop_l1_archiver.d.ts +4 -1
  63. package/dest/test/noop_l1_archiver.d.ts.map +1 -1
  64. package/dest/test/noop_l1_archiver.js +5 -1
  65. package/package.json +13 -13
  66. package/src/archiver.ts +62 -21
  67. package/src/config.ts +8 -1
  68. package/src/errors.ts +70 -26
  69. package/src/factory.ts +19 -14
  70. package/src/l1/calldata_retriever.ts +2 -1
  71. package/src/l1/data_retrieval.ts +7 -11
  72. package/src/modules/data_source_base.ts +26 -7
  73. package/src/modules/data_store_updater.ts +91 -107
  74. package/src/modules/l1_synchronizer.ts +174 -156
  75. package/src/modules/validation.ts +2 -2
  76. package/src/store/block_store.ts +370 -140
  77. package/src/store/contract_class_store.ts +8 -106
  78. package/src/store/contract_instance_store.ts +8 -5
  79. package/src/store/kv_archiver_store.ts +81 -39
  80. package/src/store/l2_tips_cache.ts +50 -11
  81. package/src/store/log_store.ts +126 -27
  82. package/src/store/message_store.ts +26 -9
  83. package/src/structs/inbox_message.ts +1 -1
  84. package/src/test/fake_l1_state.ts +103 -13
  85. package/src/test/mock_l1_to_l2_message_source.ts +1 -0
  86. package/src/test/mock_l2_block_source.ts +46 -5
  87. package/src/test/noop_l1_archiver.ts +7 -1
@@ -1,29 +1,21 @@
1
1
  import { BlockNumber, CheckpointNumber } from '@aztec/foundation/branded-types';
2
- import { Fr } from '@aztec/foundation/curves/bn254';
2
+ import { filterAsync } from '@aztec/foundation/collection';
3
3
  import { createLogger } from '@aztec/foundation/log';
4
- import {
5
- ContractClassPublishedEvent,
6
- PrivateFunctionBroadcastedEvent,
7
- UtilityFunctionBroadcastedEvent,
8
- } from '@aztec/protocol-contracts/class-registry';
4
+ import { ContractClassPublishedEvent } from '@aztec/protocol-contracts/class-registry';
9
5
  import {
10
6
  ContractInstancePublishedEvent,
11
7
  ContractInstanceUpdatedEvent,
12
8
  } from '@aztec/protocol-contracts/instance-registry';
13
9
  import type { L2Block, ValidateCheckpointResult } from '@aztec/stdlib/block';
14
- import { type PublishedCheckpoint, validateCheckpoint } from '@aztec/stdlib/checkpoint';
10
+ import { type ProposedCheckpointInput, type PublishedCheckpoint, validateCheckpoint } from '@aztec/stdlib/checkpoint';
15
11
  import {
16
- type ExecutablePrivateFunctionWithMembershipProof,
17
- type UtilityFunctionWithMembershipProof,
18
- computePublicBytecodeCommitment,
19
- isValidPrivateFunctionMembershipProof,
20
- isValidUtilityFunctionMembershipProof,
12
+ type ContractClassPublicWithCommitment,
13
+ computeContractAddressFromInstance,
14
+ computeContractClassId,
21
15
  } from '@aztec/stdlib/contract';
22
16
  import type { ContractClassLog, PrivateLog, PublicLog } from '@aztec/stdlib/logs';
23
17
  import type { UInt64 } from '@aztec/stdlib/types';
24
18
 
25
- import groupBy from 'lodash.groupby';
26
-
27
19
  import type { KVArchiverDataStore } from '../store/kv_archiver_store.js';
28
20
  import type { L2TipsCache } from '../store/l2_tips_cache.js';
29
21
 
@@ -52,29 +44,28 @@ export class ArchiverDataStoreUpdater {
52
44
  ) {}
53
45
 
54
46
  /**
55
- * Adds proposed blocks to the store with contract class/instance extraction from logs.
56
- * These are uncheckpointed blocks that have been proposed by the sequencer but not yet included in a checkpoint on L1.
57
- * Extracts ContractClassPublished, ContractInstancePublished, ContractInstanceUpdated events,
58
- * and individually broadcasted functions from the block logs.
47
+ * Adds a proposed block to the store with contract class/instance extraction from logs.
48
+ * This is an uncheckpointed block that has been proposed by the sequencer but not yet included in a checkpoint on L1.
49
+ * Extracts ContractClassPublished, ContractInstancePublished, ContractInstanceUpdated events from the block logs.
59
50
  *
60
- * @param blocks - The proposed L2 blocks to add.
51
+ * @param block - The proposed L2 block to add.
61
52
  * @param pendingChainValidationStatus - Optional validation status to set.
62
53
  * @returns True if the operation is successful.
63
54
  */
64
- public async addProposedBlocks(
65
- blocks: L2Block[],
55
+ public async addProposedBlock(
56
+ block: L2Block,
66
57
  pendingChainValidationStatus?: ValidateCheckpointResult,
67
58
  ): Promise<boolean> {
68
59
  const result = await this.store.transactionAsync(async () => {
69
- await this.store.addProposedBlocks(blocks);
60
+ await this.store.addProposedBlock(block);
70
61
 
71
62
  const opResults = await Promise.all([
72
63
  // Update the pending chain validation status if provided
73
64
  pendingChainValidationStatus && this.store.setPendingChainValidationStatus(pendingChainValidationStatus),
74
- // Add any logs emitted during the retrieved blocks
75
- this.store.addLogs(blocks),
76
- // Unroll all logs emitted during the retrieved blocks and extract any contract classes and instances from them
77
- ...blocks.map(block => this.addContractDataToDb(block)),
65
+ // Add any logs emitted during the retrieved block
66
+ this.store.addLogs([block]),
67
+ // Unroll all logs emitted during the retrieved block and extract any contract classes and instances from it
68
+ this.addContractDataToDb(block),
78
69
  ]);
79
70
 
80
71
  await this.l2TipsCache?.refresh();
@@ -87,8 +78,7 @@ export class ArchiverDataStoreUpdater {
87
78
  * Reconciles local blocks with incoming checkpoints from L1.
88
79
  * Adds new checkpoints to the store with contract class/instance extraction from logs.
89
80
  * Prunes any local blocks that conflict with checkpoint data (by comparing archive roots).
90
- * Extracts ContractClassPublished, ContractInstancePublished, ContractInstanceUpdated events,
91
- * and individually broadcasted functions from the checkpoint block logs.
81
+ * Extracts ContractClassPublished, ContractInstancePublished, ContractInstanceUpdated events from the checkpoint block logs.
92
82
  *
93
83
  * @param checkpoints - The published checkpoints to add.
94
84
  * @param pendingChainValidationStatus - Optional validation status to set.
@@ -108,7 +98,7 @@ export class ArchiverDataStoreUpdater {
108
98
 
109
99
  await this.store.addCheckpoints(checkpoints);
110
100
 
111
- // Filter out blocks that were already inserted via addProposedBlocks() to avoid duplicating logs/contract data
101
+ // Filter out blocks that were already inserted via addProposedBlock() to avoid duplicating logs/contract data
112
102
  const newBlocks = checkpoints
113
103
  .flatMap((ch: PublishedCheckpoint) => ch.checkpoint.blocks)
114
104
  .filter(b => lastAlreadyInsertedBlockNumber === undefined || b.number > lastAlreadyInsertedBlockNumber);
@@ -128,6 +118,15 @@ export class ArchiverDataStoreUpdater {
128
118
  return result;
129
119
  }
130
120
 
121
+ public async setProposedCheckpoint(proposedCheckpoint: ProposedCheckpointInput) {
122
+ const result = await this.store.transactionAsync(async () => {
123
+ await this.store.setProposedCheckpoint(proposedCheckpoint);
124
+ await this.l2TipsCache?.refresh();
125
+ });
126
+
127
+ return result;
128
+ }
129
+
131
130
  /**
132
131
  * Checks for local proposed blocks that do not match the ones to be checkpointed and prunes them.
133
132
  * This method handles multiple checkpoints but returns after pruning the first conflict found.
@@ -178,7 +177,7 @@ export class ArchiverDataStoreUpdater {
178
177
  this.log.verbose(`Block number ${blockNumber} already inserted and matches checkpoint`, blockInfos);
179
178
  lastAlreadyInsertedBlockNumber = blockNumber;
180
179
  } else {
181
- this.log.warn(`Conflict detected at block ${blockNumber} between checkpointed and local block`, blockInfos);
180
+ this.log.info(`Conflict detected at block ${blockNumber} between checkpointed and local block`, blockInfos);
182
181
  const prunedBlocks = await this.removeBlocksAfter(BlockNumber(blockNumber - 1));
183
182
  return { prunedBlocks, lastAlreadyInsertedBlockNumber };
184
183
  }
@@ -221,6 +220,10 @@ export class ArchiverDataStoreUpdater {
221
220
  }
222
221
 
223
222
  const result = await this.removeBlocksAfter(blockNumber);
223
+
224
+ // Clear the proposed checkpoint if it exists, since its blocks have been pruned
225
+ await this.store.deleteProposedCheckpoint();
226
+
224
227
  await this.l2TipsCache?.refresh();
225
228
  return result;
226
229
  });
@@ -281,6 +284,17 @@ export class ArchiverDataStoreUpdater {
281
284
  });
282
285
  }
283
286
 
287
+ /**
288
+ * Updates the finalized checkpoint number and refreshes the L2 tips cache.
289
+ * @param checkpointNumber - The checkpoint number to set as finalized.
290
+ */
291
+ public async setFinalizedCheckpointNumber(checkpointNumber: CheckpointNumber): Promise<void> {
292
+ await this.store.transactionAsync(async () => {
293
+ await this.store.setFinalizedCheckpointNumber(checkpointNumber);
294
+ await this.l2TipsCache?.refresh();
295
+ });
296
+ }
297
+
284
298
  /** Extracts and stores contract data from a single block. */
285
299
  private addContractDataToDb(block: L2Block): Promise<boolean> {
286
300
  return this.updateContractDataOnDb(block, Operation.Store);
@@ -302,9 +316,6 @@ export class ArchiverDataStoreUpdater {
302
316
  this.updatePublishedContractClasses(contractClassLogs, block.number, operation),
303
317
  this.updateDeployedContractInstances(privateLogs, block.number, operation),
304
318
  this.updateUpdatedContractInstances(publicLogs, block.header.globalVariables.timestamp, operation),
305
- operation === Operation.Store
306
- ? this.storeBroadcastedIndividualFunctions(contractClassLogs, block.number)
307
- : Promise.resolve(true),
308
319
  ])
309
320
  ).every(Boolean);
310
321
  }
@@ -321,18 +332,37 @@ export class ArchiverDataStoreUpdater {
321
332
  .filter(log => ContractClassPublishedEvent.isContractClassPublishedEvent(log))
322
333
  .map(log => ContractClassPublishedEvent.fromLog(log));
323
334
 
324
- const contractClasses = await Promise.all(contractClassPublishedEvents.map(e => e.toContractClassPublic()));
325
- if (contractClasses.length > 0) {
326
- contractClasses.forEach(c => this.log.verbose(`${Operation[operation]} contract class ${c.id.toString()}`));
327
- if (operation == Operation.Store) {
328
- // TODO: Will probably want to create some worker threads to compute these bytecode commitments as they are expensive
329
- const commitments = await Promise.all(
330
- contractClasses.map(c => computePublicBytecodeCommitment(c.packedBytecode)),
331
- );
332
- return await this.store.addContractClasses(contractClasses, commitments, blockNum);
333
- } else if (operation == Operation.Delete) {
335
+ if (operation == Operation.Delete) {
336
+ const contractClasses = contractClassPublishedEvents.map(e => e.toContractClassPublic());
337
+ if (contractClasses.length > 0) {
338
+ contractClasses.forEach(c => this.log.verbose(`${Operation[operation]} contract class ${c.id.toString()}`));
334
339
  return await this.store.deleteContractClasses(contractClasses, blockNum);
335
340
  }
341
+ return true;
342
+ }
343
+
344
+ // Compute bytecode commitments and validate class IDs in a single pass.
345
+ const contractClasses: ContractClassPublicWithCommitment[] = [];
346
+ for (const event of contractClassPublishedEvents) {
347
+ const contractClass = await event.toContractClassPublicWithBytecodeCommitment();
348
+ const computedClassId = await computeContractClassId({
349
+ artifactHash: contractClass.artifactHash,
350
+ privateFunctionsRoot: contractClass.privateFunctionsRoot,
351
+ publicBytecodeCommitment: contractClass.publicBytecodeCommitment,
352
+ });
353
+ if (!computedClassId.equals(contractClass.id)) {
354
+ this.log.warn(
355
+ `Skipping contract class with mismatched id at block ${blockNum}. Claimed ${contractClass.id}, computed ${computedClassId}`,
356
+ { blockNum, contractClassId: event.contractClassId.toString() },
357
+ );
358
+ continue;
359
+ }
360
+ contractClasses.push(contractClass);
361
+ }
362
+
363
+ if (contractClasses.length > 0) {
364
+ contractClasses.forEach(c => this.log.verbose(`${Operation[operation]} contract class ${c.id.toString()}`));
365
+ return await this.store.addContractClasses(contractClasses, blockNum);
336
366
  }
337
367
  return true;
338
368
  }
@@ -345,10 +375,27 @@ export class ArchiverDataStoreUpdater {
345
375
  blockNum: BlockNumber,
346
376
  operation: Operation,
347
377
  ): Promise<boolean> {
348
- const contractInstances = allLogs
378
+ const allInstances = allLogs
349
379
  .filter(log => ContractInstancePublishedEvent.isContractInstancePublishedEvent(log))
350
380
  .map(log => ContractInstancePublishedEvent.fromLog(log))
351
381
  .map(e => e.toContractInstance());
382
+
383
+ // Verify that each instance's address matches the one derived from its fields if we're adding
384
+ const contractInstances =
385
+ operation === Operation.Delete
386
+ ? allInstances
387
+ : await filterAsync(allInstances, async instance => {
388
+ const computedAddress = await computeContractAddressFromInstance(instance);
389
+ if (!computedAddress.equals(instance.address)) {
390
+ this.log.warn(
391
+ `Found contract instance with mismatched address at block ${blockNum}. Claimed ${instance.address} but computed ${computedAddress}.`,
392
+ { instanceAddress: instance.address.toString(), computedAddress: computedAddress.toString(), blockNum },
393
+ );
394
+ return false;
395
+ }
396
+ return true;
397
+ });
398
+
352
399
  if (contractInstances.length > 0) {
353
400
  contractInstances.forEach(c =>
354
401
  this.log.verbose(`${Operation[operation]} contract instance at ${c.address.toString()}`),
@@ -387,67 +434,4 @@ export class ArchiverDataStoreUpdater {
387
434
  }
388
435
  return true;
389
436
  }
390
-
391
- /**
392
- * Stores the functions that were broadcasted individually.
393
- *
394
- * @dev Beware that there is not a delete variant of this, since they are added to contract classes
395
- * and will be deleted as part of the class if needed.
396
- */
397
- private async storeBroadcastedIndividualFunctions(
398
- allLogs: ContractClassLog[],
399
- _blockNum: BlockNumber,
400
- ): Promise<boolean> {
401
- // Filter out private and utility function broadcast events
402
- const privateFnEvents = allLogs
403
- .filter(log => PrivateFunctionBroadcastedEvent.isPrivateFunctionBroadcastedEvent(log))
404
- .map(log => PrivateFunctionBroadcastedEvent.fromLog(log));
405
- const utilityFnEvents = allLogs
406
- .filter(log => UtilityFunctionBroadcastedEvent.isUtilityFunctionBroadcastedEvent(log))
407
- .map(log => UtilityFunctionBroadcastedEvent.fromLog(log));
408
-
409
- // Group all events by contract class id
410
- for (const [classIdString, classEvents] of Object.entries(
411
- groupBy([...privateFnEvents, ...utilityFnEvents], e => e.contractClassId.toString()),
412
- )) {
413
- const contractClassId = Fr.fromHexString(classIdString);
414
- const contractClass = await this.store.getContractClass(contractClassId);
415
- if (!contractClass) {
416
- this.log.warn(`Skipping broadcasted functions as contract class ${contractClassId.toString()} was not found`);
417
- continue;
418
- }
419
-
420
- // Split private and utility functions, and filter out invalid ones
421
- const allFns = classEvents.map(e => e.toFunctionWithMembershipProof());
422
- const privateFns = allFns.filter(
423
- (fn): fn is ExecutablePrivateFunctionWithMembershipProof => 'utilityFunctionsTreeRoot' in fn,
424
- );
425
- const utilityFns = allFns.filter(
426
- (fn): fn is UtilityFunctionWithMembershipProof => 'privateFunctionsArtifactTreeRoot' in fn,
427
- );
428
-
429
- const privateFunctionsWithValidity = await Promise.all(
430
- privateFns.map(async fn => ({ fn, valid: await isValidPrivateFunctionMembershipProof(fn, contractClass) })),
431
- );
432
- const validPrivateFns = privateFunctionsWithValidity.filter(({ valid }) => valid).map(({ fn }) => fn);
433
- const utilityFunctionsWithValidity = await Promise.all(
434
- utilityFns.map(async fn => ({
435
- fn,
436
- valid: await isValidUtilityFunctionMembershipProof(fn, contractClass),
437
- })),
438
- );
439
- const validUtilityFns = utilityFunctionsWithValidity.filter(({ valid }) => valid).map(({ fn }) => fn);
440
- const validFnCount = validPrivateFns.length + validUtilityFns.length;
441
- if (validFnCount !== allFns.length) {
442
- this.log.warn(`Skipping ${allFns.length - validFnCount} invalid functions`);
443
- }
444
-
445
- // Store the functions in the contract class in a single operation
446
- if (validFnCount > 0) {
447
- this.log.verbose(`Storing ${validFnCount} functions for contract class ${contractClassId.toString()}`);
448
- }
449
- return await this.store.addFunctions(contractClassId, validPrivateFns, validUtilityFns);
450
- }
451
- return true;
452
- }
453
437
  }