@aztec/archiver 0.0.1-commit.d431d1c → 0.0.1-commit.db765a8

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 (95) hide show
  1. package/README.md +9 -0
  2. package/dest/archiver.d.ts +10 -6
  3. package/dest/archiver.d.ts.map +1 -1
  4. package/dest/archiver.js +50 -111
  5. package/dest/errors.d.ts +6 -1
  6. package/dest/errors.d.ts.map +1 -1
  7. package/dest/errors.js +8 -0
  8. package/dest/factory.d.ts +5 -2
  9. package/dest/factory.d.ts.map +1 -1
  10. package/dest/factory.js +16 -13
  11. package/dest/index.d.ts +2 -1
  12. package/dest/index.d.ts.map +1 -1
  13. package/dest/index.js +1 -0
  14. package/dest/l1/bin/retrieve-calldata.js +35 -32
  15. package/dest/l1/calldata_retriever.d.ts +73 -50
  16. package/dest/l1/calldata_retriever.d.ts.map +1 -1
  17. package/dest/l1/calldata_retriever.js +190 -259
  18. package/dest/l1/data_retrieval.d.ts +9 -9
  19. package/dest/l1/data_retrieval.d.ts.map +1 -1
  20. package/dest/l1/data_retrieval.js +24 -22
  21. package/dest/l1/spire_proposer.d.ts +5 -5
  22. package/dest/l1/spire_proposer.d.ts.map +1 -1
  23. package/dest/l1/spire_proposer.js +9 -17
  24. package/dest/l1/validate_trace.d.ts +6 -3
  25. package/dest/l1/validate_trace.d.ts.map +1 -1
  26. package/dest/l1/validate_trace.js +13 -9
  27. package/dest/modules/data_source_base.d.ts +23 -19
  28. package/dest/modules/data_source_base.d.ts.map +1 -1
  29. package/dest/modules/data_source_base.js +44 -119
  30. package/dest/modules/data_store_updater.d.ts +31 -20
  31. package/dest/modules/data_store_updater.d.ts.map +1 -1
  32. package/dest/modules/data_store_updater.js +79 -60
  33. package/dest/modules/instrumentation.d.ts +17 -4
  34. package/dest/modules/instrumentation.d.ts.map +1 -1
  35. package/dest/modules/instrumentation.js +36 -12
  36. package/dest/modules/l1_synchronizer.d.ts +4 -8
  37. package/dest/modules/l1_synchronizer.d.ts.map +1 -1
  38. package/dest/modules/l1_synchronizer.js +23 -19
  39. package/dest/store/block_store.d.ts +50 -32
  40. package/dest/store/block_store.d.ts.map +1 -1
  41. package/dest/store/block_store.js +147 -54
  42. package/dest/store/contract_class_store.d.ts +1 -1
  43. package/dest/store/contract_class_store.d.ts.map +1 -1
  44. package/dest/store/contract_class_store.js +11 -7
  45. package/dest/store/kv_archiver_store.d.ts +43 -25
  46. package/dest/store/kv_archiver_store.d.ts.map +1 -1
  47. package/dest/store/kv_archiver_store.js +38 -17
  48. package/dest/store/l2_tips_cache.d.ts +19 -0
  49. package/dest/store/l2_tips_cache.d.ts.map +1 -0
  50. package/dest/store/l2_tips_cache.js +89 -0
  51. package/dest/store/log_store.d.ts +4 -4
  52. package/dest/store/log_store.d.ts.map +1 -1
  53. package/dest/store/log_store.js +57 -37
  54. package/dest/test/fake_l1_state.d.ts +9 -4
  55. package/dest/test/fake_l1_state.d.ts.map +1 -1
  56. package/dest/test/fake_l1_state.js +56 -18
  57. package/dest/test/index.js +3 -1
  58. package/dest/test/mock_archiver.d.ts +1 -1
  59. package/dest/test/mock_archiver.d.ts.map +1 -1
  60. package/dest/test/mock_archiver.js +3 -2
  61. package/dest/test/mock_l2_block_source.d.ts +36 -21
  62. package/dest/test/mock_l2_block_source.d.ts.map +1 -1
  63. package/dest/test/mock_l2_block_source.js +151 -109
  64. package/dest/test/mock_structs.d.ts +3 -2
  65. package/dest/test/mock_structs.d.ts.map +1 -1
  66. package/dest/test/mock_structs.js +11 -9
  67. package/dest/test/noop_l1_archiver.d.ts +23 -0
  68. package/dest/test/noop_l1_archiver.d.ts.map +1 -0
  69. package/dest/test/noop_l1_archiver.js +68 -0
  70. package/package.json +14 -13
  71. package/src/archiver.ts +71 -136
  72. package/src/errors.ts +12 -0
  73. package/src/factory.ts +30 -14
  74. package/src/index.ts +1 -0
  75. package/src/l1/README.md +25 -68
  76. package/src/l1/bin/retrieve-calldata.ts +45 -33
  77. package/src/l1/calldata_retriever.ts +249 -379
  78. package/src/l1/data_retrieval.ts +27 -29
  79. package/src/l1/spire_proposer.ts +7 -15
  80. package/src/l1/validate_trace.ts +24 -6
  81. package/src/modules/data_source_base.ts +73 -163
  82. package/src/modules/data_store_updater.ts +92 -63
  83. package/src/modules/instrumentation.ts +46 -14
  84. package/src/modules/l1_synchronizer.ts +26 -24
  85. package/src/store/block_store.ts +188 -92
  86. package/src/store/contract_class_store.ts +11 -7
  87. package/src/store/kv_archiver_store.ts +69 -29
  88. package/src/store/l2_tips_cache.ts +89 -0
  89. package/src/store/log_store.ts +105 -43
  90. package/src/test/fake_l1_state.ts +77 -19
  91. package/src/test/index.ts +3 -0
  92. package/src/test/mock_archiver.ts +3 -2
  93. package/src/test/mock_l2_block_source.ts +196 -126
  94. package/src/test/mock_structs.ts +26 -10
  95. package/src/test/noop_l1_archiver.ts +109 -0
@@ -6,8 +6,14 @@ import { createLogger } from '@aztec/foundation/log';
6
6
  import type { AztecAsyncKVStore, CustomRange, StoreSize } from '@aztec/kv-store';
7
7
  import { FunctionSelector } from '@aztec/stdlib/abi';
8
8
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
9
- import { CheckpointedL2Block, L2BlockHash, L2BlockNew, type ValidateCheckpointResult } from '@aztec/stdlib/block';
10
- import type { PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
9
+ import {
10
+ type BlockData,
11
+ BlockHash,
12
+ CheckpointedL2Block,
13
+ L2Block,
14
+ type ValidateCheckpointResult,
15
+ } from '@aztec/stdlib/block';
16
+ import type { CheckpointData, PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
11
17
  import type {
12
18
  ContractClassPublic,
13
19
  ContractDataSource,
@@ -16,6 +22,7 @@ import type {
16
22
  ExecutablePrivateFunctionWithMembershipProof,
17
23
  UtilityFunctionWithMembershipProof,
18
24
  } from '@aztec/stdlib/contract';
25
+ import type { L1RollupConstants } from '@aztec/stdlib/epoch-helpers';
19
26
  import type { GetContractClassLogsResponse, GetPublicLogsResponse } from '@aztec/stdlib/interfaces/client';
20
27
  import type { LogFilter, SiloedTag, Tag, TxScopedL2Log } from '@aztec/stdlib/logs';
21
28
  import type { BlockHeader, TxHash, TxReceipt } from '@aztec/stdlib/tx';
@@ -24,7 +31,7 @@ import type { UInt64 } from '@aztec/stdlib/types';
24
31
  import { join } from 'path';
25
32
 
26
33
  import type { InboxMessage } from '../structs/inbox_message.js';
27
- import { BlockStore, type CheckpointData } from './block_store.js';
34
+ import { BlockStore, type RemoveCheckpointsResult } from './block_store.js';
28
35
  import { ContractClassStore } from './contract_class_store.js';
29
36
  import { ContractInstanceStore } from './contract_instance_store.js';
30
37
  import { LogStore } from './log_store.js';
@@ -64,14 +71,20 @@ export class KVArchiverDataStore implements ContractDataSource {
64
71
  constructor(
65
72
  private db: AztecAsyncKVStore,
66
73
  logsMaxPageSize: number = 1000,
74
+ l1Constants: Pick<L1RollupConstants, 'epochDuration'>,
67
75
  ) {
68
- this.#blockStore = new BlockStore(db);
76
+ this.#blockStore = new BlockStore(db, l1Constants);
69
77
  this.#logStore = new LogStore(db, this.#blockStore, logsMaxPageSize);
70
78
  this.#messageStore = new MessageStore(db);
71
79
  this.#contractClassStore = new ContractClassStore(db);
72
80
  this.#contractInstanceStore = new ContractInstanceStore(db);
73
81
  }
74
82
 
83
+ /** Returns the underlying block store. Used by L2TipsCache. */
84
+ get blockStore(): BlockStore {
85
+ return this.#blockStore;
86
+ }
87
+
75
88
  /** Opens a new transaction to the underlying store and runs all operations within it. */
76
89
  public transactionAsync<T>(callback: () => Promise<T>): Promise<T> {
77
90
  return this.db.transactionAsync(callback);
@@ -101,6 +114,11 @@ export class KVArchiverDataStore implements ContractDataSource {
101
114
  return this.db.close();
102
115
  }
103
116
 
117
+ /** Computes the finalized block number based on the proven block number. */
118
+ getFinalizedL2BlockNumber(): Promise<BlockNumber> {
119
+ return this.#blockStore.getFinalizedL2BlockNumber();
120
+ }
121
+
104
122
  /** Looks up a public function name given a selector. */
105
123
  getDebugFunctionName(_address: AztecAddress, selector: FunctionSelector): Promise<string | undefined> {
106
124
  return Promise.resolve(this.functionNames.get(selector.toString()));
@@ -228,12 +246,14 @@ export class KVArchiverDataStore implements ContractDataSource {
228
246
  }
229
247
 
230
248
  /**
231
- * Append new blocks to the store's list.
232
- * @param blocks - The L2 blocks to be added to the store and the last processed L1 block.
249
+ * Append new proposed blocks to the store's list.
250
+ * These are uncheckpointed blocks that have been proposed by the sequencer but not yet included in a checkpoint on L1.
251
+ * For checkpointed blocks (already published to L1), use addCheckpoints() instead.
252
+ * @param blocks - The proposed L2 blocks to be added to the store.
233
253
  * @returns True if the operation is successful.
234
254
  */
235
- addBlocks(blocks: L2BlockNew[], opts: { force?: boolean; checkpointNumber?: number } = {}): Promise<boolean> {
236
- return this.#blockStore.addBlocks(blocks, opts);
255
+ addProposedBlocks(blocks: L2Block[], opts: { force?: boolean; checkpointNumber?: number } = {}): Promise<boolean> {
256
+ return this.#blockStore.addProposedBlocks(blocks, opts);
237
257
  }
238
258
 
239
259
  /**
@@ -254,14 +274,12 @@ export class KVArchiverDataStore implements ContractDataSource {
254
274
  }
255
275
 
256
276
  /**
257
- * Unwinds checkpoints from the database
258
- * @param from - The tip of the chain, passed for verification purposes,
259
- * ensuring that we don't end up deleting something we did not intend
260
- * @param checkpointsToUnwind - The number of checkpoints we are to unwind
261
- * @returns True if the operation is successful
277
+ * Removes all checkpoints with checkpoint number > checkpointNumber.
278
+ * Also removes ALL blocks (both checkpointed and uncheckpointed) after the last block of the given checkpoint.
279
+ * @param checkpointNumber - Remove all checkpoints strictly after this one.
262
280
  */
263
- unwindCheckpoints(from: CheckpointNumber, checkpointsToUnwind: number): Promise<boolean> {
264
- return this.#blockStore.unwindCheckpoints(from, checkpointsToUnwind);
281
+ removeCheckpointsAfter(checkpointNumber: CheckpointNumber): Promise<RemoveCheckpointsResult> {
282
+ return this.#blockStore.removeCheckpointsAfter(checkpointNumber);
265
283
  }
266
284
 
267
285
  /**
@@ -284,7 +302,7 @@ export class KVArchiverDataStore implements ContractDataSource {
284
302
  * Returns the block for the given hash, or undefined if not exists.
285
303
  * @param blockHash - The block hash to return.
286
304
  */
287
- getCheckpointedBlockByHash(blockHash: Fr): Promise<CheckpointedL2Block | undefined> {
305
+ getCheckpointedBlockByHash(blockHash: BlockHash): Promise<CheckpointedL2Block | undefined> {
288
306
  return this.#blockStore.getCheckpointedBlockByHash(blockHash);
289
307
  }
290
308
  /**
@@ -298,21 +316,21 @@ export class KVArchiverDataStore implements ContractDataSource {
298
316
  * Returns the block for the given number, or undefined if not exists.
299
317
  * @param number - The block number to return.
300
318
  */
301
- getBlock(number: BlockNumber): Promise<L2BlockNew | undefined> {
319
+ getBlock(number: BlockNumber): Promise<L2Block | undefined> {
302
320
  return this.#blockStore.getBlock(number);
303
321
  }
304
322
  /**
305
323
  * Returns the block for the given hash, or undefined if not exists.
306
324
  * @param blockHash - The block hash to return.
307
325
  */
308
- getBlockByHash(blockHash: Fr): Promise<L2BlockNew | undefined> {
309
- return this.#blockStore.getBlockByHash(L2BlockHash.fromField(blockHash));
326
+ getBlockByHash(blockHash: BlockHash): Promise<L2Block | undefined> {
327
+ return this.#blockStore.getBlockByHash(blockHash);
310
328
  }
311
329
  /**
312
330
  * Returns the block for the given archive root, or undefined if not exists.
313
331
  * @param archive - The archive root to return.
314
332
  */
315
- getBlockByArchive(archive: Fr): Promise<L2BlockNew | undefined> {
333
+ getBlockByArchive(archive: Fr): Promise<L2Block | undefined> {
316
334
  return this.#blockStore.getBlockByArchive(archive);
317
335
  }
318
336
 
@@ -322,7 +340,7 @@ export class KVArchiverDataStore implements ContractDataSource {
322
340
  * @param limit - The number of blocks to return.
323
341
  * @returns The requested L2 blocks.
324
342
  */
325
- getBlocks(from: BlockNumber, limit: number): Promise<L2BlockNew[]> {
343
+ getBlocks(from: BlockNumber, limit: number): Promise<L2Block[]> {
326
344
  return toArray(this.#blockStore.getBlocks(from, limit));
327
345
  }
328
346
 
@@ -350,8 +368,8 @@ export class KVArchiverDataStore implements ContractDataSource {
350
368
  * Returns the block header for the given hash, or undefined if not exists.
351
369
  * @param blockHash - The block hash to return.
352
370
  */
353
- getBlockHeaderByHash(blockHash: Fr): Promise<BlockHeader | undefined> {
354
- return this.#blockStore.getBlockHeaderByHash(L2BlockHash.fromField(blockHash));
371
+ getBlockHeaderByHash(blockHash: BlockHash): Promise<BlockHeader | undefined> {
372
+ return this.#blockStore.getBlockHeaderByHash(blockHash);
355
373
  }
356
374
 
357
375
  /**
@@ -362,6 +380,22 @@ export class KVArchiverDataStore implements ContractDataSource {
362
380
  return this.#blockStore.getBlockHeaderByArchive(archive);
363
381
  }
364
382
 
383
+ /**
384
+ * Gets block metadata (without tx data) by block number.
385
+ * @param blockNumber - The block number to return.
386
+ */
387
+ getBlockData(blockNumber: BlockNumber): Promise<BlockData | undefined> {
388
+ return this.#blockStore.getBlockData(blockNumber);
389
+ }
390
+
391
+ /**
392
+ * Gets block metadata (without tx data) by archive root.
393
+ * @param archive - The archive root to return.
394
+ */
395
+ getBlockDataByArchive(archive: Fr): Promise<BlockData | undefined> {
396
+ return this.#blockStore.getBlockDataByArchive(archive);
397
+ }
398
+
365
399
  /**
366
400
  * Gets a tx effect.
367
401
  * @param txHash - The hash of the tx corresponding to the tx effect.
@@ -385,11 +419,11 @@ export class KVArchiverDataStore implements ContractDataSource {
385
419
  * @param blocks - The blocks for which to add the logs.
386
420
  * @returns True if the operation is successful.
387
421
  */
388
- addLogs(blocks: L2BlockNew[]): Promise<boolean> {
422
+ addLogs(blocks: L2Block[]): Promise<boolean> {
389
423
  return this.#logStore.addLogs(blocks);
390
424
  }
391
425
 
392
- deleteLogs(blocks: L2BlockNew[]): Promise<boolean> {
426
+ deleteLogs(blocks: L2Block[]): Promise<boolean> {
393
427
  return this.#logStore.deleteLogs(blocks);
394
428
  }
395
429
 
@@ -598,7 +632,7 @@ export class KVArchiverDataStore implements ContractDataSource {
598
632
  * @param checkpointNumber Retrieves all blocks for the given checkpoint
599
633
  * @returns The collection of blocks for the requested checkpoint if available (undefined otherwise)
600
634
  */
601
- getBlocksForCheckpoint(checkpointNumber: CheckpointNumber): Promise<L2BlockNew[] | undefined> {
635
+ getBlocksForCheckpoint(checkpointNumber: CheckpointNumber): Promise<L2Block[] | undefined> {
602
636
  return this.#blockStore.getBlocksForCheckpoint(checkpointNumber);
603
637
  }
604
638
 
@@ -611,21 +645,27 @@ export class KVArchiverDataStore implements ContractDataSource {
611
645
  return this.#blockStore.getCheckpointData(checkpointNumber);
612
646
  }
613
647
 
648
+ /** Returns checkpoint data for all checkpoints whose slot falls within the given range (inclusive). */
649
+ getCheckpointDataForSlotRange(startSlot: SlotNumber, endSlot: SlotNumber): Promise<CheckpointData[]> {
650
+ return this.#blockStore.getCheckpointDataForSlotRange(startSlot, endSlot);
651
+ }
652
+
614
653
  /**
615
654
  * Gets all blocks that have the given slot number.
616
655
  * @param slotNumber - The slot number to search for.
617
656
  * @returns All blocks with the given slot number.
618
657
  */
619
- getBlocksForSlot(slotNumber: SlotNumber): Promise<L2BlockNew[]> {
658
+ getBlocksForSlot(slotNumber: SlotNumber): Promise<L2Block[]> {
620
659
  return this.#blockStore.getBlocksForSlot(slotNumber);
621
660
  }
622
661
 
623
662
  /**
624
663
  * Removes all blocks with block number > blockNumber.
664
+ * Does not remove any associated checkpoints.
625
665
  * @param blockNumber - The block number to remove after.
626
666
  * @returns The removed blocks (for event emission).
627
667
  */
628
- removeBlocksAfter(blockNumber: BlockNumber): Promise<L2BlockNew[]> {
629
- return this.#blockStore.unwindBlocksAfter(blockNumber);
668
+ removeBlocksAfter(blockNumber: BlockNumber): Promise<L2Block[]> {
669
+ return this.#blockStore.removeBlocksAfter(blockNumber);
630
670
  }
631
671
  }
@@ -0,0 +1,89 @@
1
+ import { GENESIS_BLOCK_HEADER_HASH, INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
2
+ import { BlockNumber, CheckpointNumber } from '@aztec/foundation/branded-types';
3
+ import { type BlockData, type CheckpointId, GENESIS_CHECKPOINT_HEADER_HASH, type L2Tips } from '@aztec/stdlib/block';
4
+
5
+ import type { BlockStore } from './block_store.js';
6
+
7
+ /**
8
+ * In-memory cache for L2 chain tips (proposed, checkpointed, proven, finalized).
9
+ * Populated from the BlockStore on first access, then kept up-to-date by the ArchiverDataStoreUpdater.
10
+ * Refresh calls should happen within the store transaction that mutates block data to ensure consistency.
11
+ */
12
+ export class L2TipsCache {
13
+ #tipsPromise: Promise<L2Tips> | undefined;
14
+
15
+ constructor(private blockStore: BlockStore) {}
16
+
17
+ /** Returns the cached L2 tips. Loads from the block store on first call. */
18
+ public getL2Tips(): Promise<L2Tips> {
19
+ return (this.#tipsPromise ??= this.loadFromStore());
20
+ }
21
+
22
+ /** Reloads the L2 tips from the block store. Should be called within the store transaction that mutates data. */
23
+ public async refresh(): Promise<void> {
24
+ this.#tipsPromise = this.loadFromStore();
25
+ await this.#tipsPromise;
26
+ }
27
+
28
+ private async loadFromStore(): Promise<L2Tips> {
29
+ const [latestBlockNumber, provenBlockNumber, checkpointedBlockNumber, finalizedBlockNumber] = await Promise.all([
30
+ this.blockStore.getLatestBlockNumber(),
31
+ this.blockStore.getProvenBlockNumber(),
32
+ this.blockStore.getCheckpointedL2BlockNumber(),
33
+ this.blockStore.getFinalizedL2BlockNumber(),
34
+ ]);
35
+
36
+ const genesisBlockHeader = {
37
+ blockHash: GENESIS_BLOCK_HEADER_HASH,
38
+ checkpointNumber: CheckpointNumber.ZERO,
39
+ } as const;
40
+ const beforeInitialBlockNumber = BlockNumber(INITIAL_L2_BLOCK_NUM - 1);
41
+
42
+ const getBlockData = (blockNumber: BlockNumber) =>
43
+ blockNumber > beforeInitialBlockNumber ? this.blockStore.getBlockData(blockNumber) : genesisBlockHeader;
44
+
45
+ const [latestBlockData, provenBlockData, checkpointedBlockData, finalizedBlockData] = await Promise.all(
46
+ [latestBlockNumber, provenBlockNumber, checkpointedBlockNumber, finalizedBlockNumber].map(getBlockData),
47
+ );
48
+
49
+ if (!latestBlockData || !provenBlockData || !finalizedBlockData || !checkpointedBlockData) {
50
+ throw new Error('Failed to load block data for L2 tips');
51
+ }
52
+
53
+ const [provenCheckpointId, finalizedCheckpointId, checkpointedCheckpointId] = await Promise.all([
54
+ this.getCheckpointIdForBlock(provenBlockData),
55
+ this.getCheckpointIdForBlock(finalizedBlockData),
56
+ this.getCheckpointIdForBlock(checkpointedBlockData),
57
+ ]);
58
+
59
+ return {
60
+ proposed: { number: latestBlockNumber, hash: latestBlockData.blockHash.toString() },
61
+ proven: {
62
+ block: { number: provenBlockNumber, hash: provenBlockData.blockHash.toString() },
63
+ checkpoint: provenCheckpointId,
64
+ },
65
+ finalized: {
66
+ block: { number: finalizedBlockNumber, hash: finalizedBlockData.blockHash.toString() },
67
+ checkpoint: finalizedCheckpointId,
68
+ },
69
+ checkpointed: {
70
+ block: { number: checkpointedBlockNumber, hash: checkpointedBlockData.blockHash.toString() },
71
+ checkpoint: checkpointedCheckpointId,
72
+ },
73
+ };
74
+ }
75
+
76
+ private async getCheckpointIdForBlock(blockData: Pick<BlockData, 'checkpointNumber'>): Promise<CheckpointId> {
77
+ const checkpointData = await this.blockStore.getCheckpointData(blockData.checkpointNumber);
78
+ if (!checkpointData) {
79
+ return {
80
+ number: CheckpointNumber.ZERO,
81
+ hash: GENESIS_CHECKPOINT_HEADER_HASH.toString(),
82
+ };
83
+ }
84
+ return {
85
+ number: checkpointData.checkpointNumber,
86
+ hash: checkpointData.header.hash().toString(),
87
+ };
88
+ }
89
+ }
@@ -6,7 +6,7 @@ import { createLogger } from '@aztec/foundation/log';
6
6
  import { BufferReader, numToUInt32BE } from '@aztec/foundation/serialize';
7
7
  import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
8
8
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
9
- import { L2BlockHash, L2BlockNew } from '@aztec/stdlib/block';
9
+ import { BlockHash, L2Block } from '@aztec/stdlib/block';
10
10
  import { MAX_LOGS_PER_TAG } from '@aztec/stdlib/interfaces/api-limit';
11
11
  import type { GetContractClassLogsResponse, GetPublicLogsResponse } from '@aztec/stdlib/interfaces/client';
12
12
  import {
@@ -20,6 +20,7 @@ import {
20
20
  Tag,
21
21
  TxScopedL2Log,
22
22
  } from '@aztec/stdlib/logs';
23
+ import { TxHash } from '@aztec/stdlib/tx';
23
24
 
24
25
  import type { BlockStore } from './block_store.js';
25
26
 
@@ -59,7 +60,7 @@ export class LogStore {
59
60
  * @param block - The L2 block to extract logs from.
60
61
  * @returns An object containing the private and public tagged logs for the block.
61
62
  */
62
- #extractTaggedLogsFromBlock(block: L2BlockNew) {
63
+ #extractTaggedLogsFromBlock(block: L2Block) {
63
64
  // SiloedTag (as string) -> array of log buffers.
64
65
  const privateTaggedLogs = new Map<string, Buffer[]>();
65
66
  // "{contractAddress}_{tag}" (as string) -> array of log buffers.
@@ -120,7 +121,7 @@ export class LogStore {
120
121
  * @returns A map from tag (as string) to an array of serialized private logs belonging to that tag, and a map from
121
122
  * "{contractAddress}_{tag}" (as string) to an array of serialized public logs belonging to that key.
122
123
  */
123
- #extractTaggedLogs(blocks: L2BlockNew[]): {
124
+ #extractTaggedLogs(blocks: L2Block[]): {
124
125
  privateTaggedLogs: Map<string, Buffer[]>;
125
126
  publicTaggedLogs: Map<string, Buffer[]>;
126
127
  } {
@@ -146,7 +147,7 @@ export class LogStore {
146
147
  return { privateTaggedLogs, publicTaggedLogs };
147
148
  }
148
149
 
149
- async #addPrivateLogs(blocks: L2BlockNew[]): Promise<void> {
150
+ async #addPrivateLogs(blocks: L2Block[]): Promise<void> {
150
151
  const newBlocks = await filterAsync(
151
152
  blocks,
152
153
  async block => !(await this.#privateLogKeysByBlock.hasAsync(block.number)),
@@ -181,7 +182,7 @@ export class LogStore {
181
182
  }
182
183
  }
183
184
 
184
- async #addPublicLogs(blocks: L2BlockNew[]): Promise<void> {
185
+ async #addPublicLogs(blocks: L2Block[]): Promise<void> {
185
186
  const newBlocks = await filterAsync(
186
187
  blocks,
187
188
  async block => !(await this.#publicLogKeysByBlock.hasAsync(block.number)),
@@ -219,6 +220,7 @@ export class LogStore {
219
220
  .map((txEffect, txIndex) =>
220
221
  [
221
222
  numToUInt32BE(txIndex),
223
+ txEffect.txHash.toBuffer(),
222
224
  numToUInt32BE(txEffect.publicLogs.length),
223
225
  txEffect.publicLogs.map(log => log.toBuffer()),
224
226
  ].flat(),
@@ -229,7 +231,7 @@ export class LogStore {
229
231
  }
230
232
  }
231
233
 
232
- async #addContractClassLogs(blocks: L2BlockNew[]): Promise<void> {
234
+ async #addContractClassLogs(blocks: L2Block[]): Promise<void> {
233
235
  const newBlocks = await filterAsync(
234
236
  blocks,
235
237
  async block => !(await this.#contractClassLogsByBlock.hasAsync(block.number)),
@@ -242,6 +244,7 @@ export class LogStore {
242
244
  .map((txEffect, txIndex) =>
243
245
  [
244
246
  numToUInt32BE(txIndex),
247
+ txEffect.txHash.toBuffer(),
245
248
  numToUInt32BE(txEffect.contractClassLogs.length),
246
249
  txEffect.contractClassLogs.map(log => log.toBuffer()),
247
250
  ].flat(),
@@ -260,7 +263,7 @@ export class LogStore {
260
263
  * @param blocks - The blocks for which to add the logs.
261
264
  * @returns True if the operation is successful.
262
265
  */
263
- addLogs(blocks: L2BlockNew[]): Promise<boolean> {
266
+ addLogs(blocks: L2Block[]): Promise<boolean> {
264
267
  return this.db.transactionAsync(async () => {
265
268
  await Promise.all([
266
269
  this.#addPrivateLogs(blocks),
@@ -271,21 +274,21 @@ export class LogStore {
271
274
  });
272
275
  }
273
276
 
274
- #packWithBlockHash(blockHash: Fr, data: Buffer<ArrayBufferLike>[]): Buffer<ArrayBufferLike> {
277
+ #packWithBlockHash(blockHash: BlockHash, data: Buffer<ArrayBufferLike>[]): Buffer<ArrayBufferLike> {
275
278
  return Buffer.concat([blockHash.toBuffer(), ...data]);
276
279
  }
277
280
 
278
- #unpackBlockHash(reader: BufferReader): L2BlockHash {
281
+ #unpackBlockHash(reader: BufferReader): BlockHash {
279
282
  const blockHash = reader.remainingBytes() > 0 ? reader.readObject(Fr) : undefined;
280
283
 
281
284
  if (!blockHash) {
282
285
  throw new Error('Failed to read block hash from log entry buffer');
283
286
  }
284
287
 
285
- return L2BlockHash.fromField(blockHash);
288
+ return new BlockHash(blockHash);
286
289
  }
287
290
 
288
- deleteLogs(blocks: L2BlockNew[]): Promise<boolean> {
291
+ deleteLogs(blocks: L2Block[]): Promise<boolean> {
289
292
  return this.db.transactionAsync(async () => {
290
293
  await Promise.all(
291
294
  blocks.map(async block => {
@@ -386,24 +389,33 @@ export class LogStore {
386
389
  }
387
390
 
388
391
  const buffer = (await this.#publicLogsByBlock.getAsync(blockNumber)) ?? Buffer.alloc(0);
389
- const publicLogsInBlock: [PublicLog[]] = [[]];
392
+ const publicLogsInBlock: { txHash: TxHash; logs: PublicLog[] }[] = [];
390
393
  const reader = new BufferReader(buffer);
391
394
 
392
395
  const blockHash = this.#unpackBlockHash(reader);
393
396
 
394
397
  while (reader.remainingBytes() > 0) {
395
398
  const indexOfTx = reader.readNumber();
399
+ const txHash = reader.readObject(TxHash);
396
400
  const numLogsInTx = reader.readNumber();
397
- publicLogsInBlock[indexOfTx] = [];
401
+ publicLogsInBlock[indexOfTx] = { txHash, logs: [] };
398
402
  for (let i = 0; i < numLogsInTx; i++) {
399
- publicLogsInBlock[indexOfTx].push(reader.readObject(PublicLog));
403
+ publicLogsInBlock[indexOfTx].logs.push(reader.readObject(PublicLog));
400
404
  }
401
405
  }
402
406
 
403
- const txLogs = publicLogsInBlock[txIndex];
407
+ const txData = publicLogsInBlock[txIndex];
404
408
 
405
409
  const logs: ExtendedPublicLog[] = [];
406
- const maxLogsHit = this.#accumulateLogs(logs, blockNumber, blockHash, txIndex, txLogs, filter);
410
+ const maxLogsHit = this.#accumulatePublicLogs(
411
+ logs,
412
+ blockNumber,
413
+ blockHash,
414
+ txIndex,
415
+ txData.txHash,
416
+ txData.logs,
417
+ filter,
418
+ );
407
419
 
408
420
  return { logs, maxLogsHit };
409
421
  }
@@ -424,22 +436,31 @@ export class LogStore {
424
436
 
425
437
  let maxLogsHit = false;
426
438
  loopOverBlocks: for await (const [blockNumber, logBuffer] of this.#publicLogsByBlock.entriesAsync({ start, end })) {
427
- const publicLogsInBlock: [PublicLog[]] = [[]];
439
+ const publicLogsInBlock: { txHash: TxHash; logs: PublicLog[] }[] = [];
428
440
  const reader = new BufferReader(logBuffer);
429
441
 
430
442
  const blockHash = this.#unpackBlockHash(reader);
431
443
 
432
444
  while (reader.remainingBytes() > 0) {
433
445
  const indexOfTx = reader.readNumber();
446
+ const txHash = reader.readObject(TxHash);
434
447
  const numLogsInTx = reader.readNumber();
435
- publicLogsInBlock[indexOfTx] = [];
448
+ publicLogsInBlock[indexOfTx] = { txHash, logs: [] };
436
449
  for (let i = 0; i < numLogsInTx; i++) {
437
- publicLogsInBlock[indexOfTx].push(reader.readObject(PublicLog));
450
+ publicLogsInBlock[indexOfTx].logs.push(reader.readObject(PublicLog));
438
451
  }
439
452
  }
440
453
  for (let txIndex = filter.afterLog?.txIndex ?? 0; txIndex < publicLogsInBlock.length; txIndex++) {
441
- const txLogs = publicLogsInBlock[txIndex];
442
- maxLogsHit = this.#accumulateLogs(logs, blockNumber, blockHash, txIndex, txLogs, filter);
454
+ const txData = publicLogsInBlock[txIndex];
455
+ maxLogsHit = this.#accumulatePublicLogs(
456
+ logs,
457
+ blockNumber,
458
+ blockHash,
459
+ txIndex,
460
+ txData.txHash,
461
+ txData.logs,
462
+ filter,
463
+ );
443
464
  if (maxLogsHit) {
444
465
  this.#log.debug(`Max logs hit at block ${blockNumber}`);
445
466
  break loopOverBlocks;
@@ -475,24 +496,33 @@ export class LogStore {
475
496
  return { logs: [], maxLogsHit: false };
476
497
  }
477
498
  const contractClassLogsBuffer = (await this.#contractClassLogsByBlock.getAsync(blockNumber)) ?? Buffer.alloc(0);
478
- const contractClassLogsInBlock: [ContractClassLog[]] = [[]];
499
+ const contractClassLogsInBlock: { txHash: TxHash; logs: ContractClassLog[] }[] = [];
479
500
 
480
501
  const reader = new BufferReader(contractClassLogsBuffer);
481
502
  const blockHash = this.#unpackBlockHash(reader);
482
503
 
483
504
  while (reader.remainingBytes() > 0) {
484
505
  const indexOfTx = reader.readNumber();
506
+ const txHash = reader.readObject(TxHash);
485
507
  const numLogsInTx = reader.readNumber();
486
- contractClassLogsInBlock[indexOfTx] = [];
508
+ contractClassLogsInBlock[indexOfTx] = { txHash, logs: [] };
487
509
  for (let i = 0; i < numLogsInTx; i++) {
488
- contractClassLogsInBlock[indexOfTx].push(reader.readObject(ContractClassLog));
510
+ contractClassLogsInBlock[indexOfTx].logs.push(reader.readObject(ContractClassLog));
489
511
  }
490
512
  }
491
513
 
492
- const txLogs = contractClassLogsInBlock[txIndex];
514
+ const txData = contractClassLogsInBlock[txIndex];
493
515
 
494
516
  const logs: ExtendedContractClassLog[] = [];
495
- const maxLogsHit = this.#accumulateLogs(logs, blockNumber, blockHash, txIndex, txLogs, filter);
517
+ const maxLogsHit = this.#accumulateContractClassLogs(
518
+ logs,
519
+ blockNumber,
520
+ blockHash,
521
+ txIndex,
522
+ txData.txHash,
523
+ txData.logs,
524
+ filter,
525
+ );
496
526
 
497
527
  return { logs, maxLogsHit };
498
528
  }
@@ -516,20 +546,29 @@ export class LogStore {
516
546
  start,
517
547
  end,
518
548
  })) {
519
- const contractClassLogsInBlock: [ContractClassLog[]] = [[]];
549
+ const contractClassLogsInBlock: { txHash: TxHash; logs: ContractClassLog[] }[] = [];
520
550
  const reader = new BufferReader(logBuffer);
521
551
  const blockHash = this.#unpackBlockHash(reader);
522
552
  while (reader.remainingBytes() > 0) {
523
553
  const indexOfTx = reader.readNumber();
554
+ const txHash = reader.readObject(TxHash);
524
555
  const numLogsInTx = reader.readNumber();
525
- contractClassLogsInBlock[indexOfTx] = [];
556
+ contractClassLogsInBlock[indexOfTx] = { txHash, logs: [] };
526
557
  for (let i = 0; i < numLogsInTx; i++) {
527
- contractClassLogsInBlock[indexOfTx].push(reader.readObject(ContractClassLog));
558
+ contractClassLogsInBlock[indexOfTx].logs.push(reader.readObject(ContractClassLog));
528
559
  }
529
560
  }
530
561
  for (let txIndex = filter.afterLog?.txIndex ?? 0; txIndex < contractClassLogsInBlock.length; txIndex++) {
531
- const txLogs = contractClassLogsInBlock[txIndex];
532
- maxLogsHit = this.#accumulateLogs(logs, blockNumber, blockHash, txIndex, txLogs, filter);
562
+ const txData = contractClassLogsInBlock[txIndex];
563
+ maxLogsHit = this.#accumulateContractClassLogs(
564
+ logs,
565
+ blockNumber,
566
+ blockHash,
567
+ txIndex,
568
+ txData.txHash,
569
+ txData.logs,
570
+ filter,
571
+ );
533
572
  if (maxLogsHit) {
534
573
  this.#log.debug(`Max logs hit at block ${blockNumber}`);
535
574
  break loopOverBlocks;
@@ -540,12 +579,13 @@ export class LogStore {
540
579
  return { logs, maxLogsHit };
541
580
  }
542
581
 
543
- #accumulateLogs(
544
- results: (ExtendedContractClassLog | ExtendedPublicLog)[],
582
+ #accumulatePublicLogs(
583
+ results: ExtendedPublicLog[],
545
584
  blockNumber: number,
546
- blockHash: L2BlockHash,
585
+ blockHash: BlockHash,
547
586
  txIndex: number,
548
- txLogs: (ContractClassLog | PublicLog)[],
587
+ txHash: TxHash,
588
+ txLogs: PublicLog[],
549
589
  filter: LogFilter = {},
550
590
  ): boolean {
551
591
  let maxLogsHit = false;
@@ -553,15 +593,37 @@ export class LogStore {
553
593
  for (; logIndex < txLogs.length; logIndex++) {
554
594
  const log = txLogs[logIndex];
555
595
  if (!filter.contractAddress || log.contractAddress.equals(filter.contractAddress)) {
556
- if (log instanceof ContractClassLog) {
557
- results.push(
558
- new ExtendedContractClassLog(new LogId(BlockNumber(blockNumber), blockHash, txIndex, logIndex), log),
559
- );
560
- } else if (log instanceof PublicLog) {
561
- results.push(new ExtendedPublicLog(new LogId(BlockNumber(blockNumber), blockHash, txIndex, logIndex), log));
562
- } else {
563
- throw new Error('Unknown log type');
596
+ results.push(
597
+ new ExtendedPublicLog(new LogId(BlockNumber(blockNumber), blockHash, txHash, txIndex, logIndex), log),
598
+ );
599
+
600
+ if (results.length >= this.#logsMaxPageSize) {
601
+ maxLogsHit = true;
602
+ break;
564
603
  }
604
+ }
605
+ }
606
+
607
+ return maxLogsHit;
608
+ }
609
+
610
+ #accumulateContractClassLogs(
611
+ results: ExtendedContractClassLog[],
612
+ blockNumber: number,
613
+ blockHash: BlockHash,
614
+ txIndex: number,
615
+ txHash: TxHash,
616
+ txLogs: ContractClassLog[],
617
+ filter: LogFilter = {},
618
+ ): boolean {
619
+ let maxLogsHit = false;
620
+ let logIndex = typeof filter.afterLog?.logIndex === 'number' ? filter.afterLog.logIndex + 1 : 0;
621
+ for (; logIndex < txLogs.length; logIndex++) {
622
+ const log = txLogs[logIndex];
623
+ if (!filter.contractAddress || log.contractAddress.equals(filter.contractAddress)) {
624
+ results.push(
625
+ new ExtendedContractClassLog(new LogId(BlockNumber(blockNumber), blockHash, txHash, txIndex, logIndex), log),
626
+ );
565
627
 
566
628
  if (results.length >= this.#logsMaxPageSize) {
567
629
  maxLogsHit = true;