npm - @aztec/archiver - Versions diffs - 0.55.1 → 0.57.0 - Mend

@aztec/archiver 0.55.1 → 0.57.0

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 (78) hide show

package/README.md +1 -1
package/dest/archiver/archiver.d.ts +27 -25
package/dest/archiver/archiver.d.ts.map +1 -1
package/dest/archiver/archiver.js +391 -169
package/dest/archiver/archiver_store.d.ts +47 -23
package/dest/archiver/archiver_store.d.ts.map +1 -1
package/dest/archiver/archiver_store_test_suite.d.ts.map +1 -1
package/dest/archiver/archiver_store_test_suite.js +75 -42
package/dest/archiver/config.js +6 -6
package/dest/archiver/data_retrieval.d.ts +32 -5
package/dest/archiver/data_retrieval.d.ts.map +1 -1
package/dest/archiver/data_retrieval.js +126 -16
package/dest/archiver/epoch_helpers.d.ts +15 -0
package/dest/archiver/epoch_helpers.d.ts.map +1 -0
package/dest/archiver/epoch_helpers.js +23 -0
package/dest/archiver/kv_archiver_store/block_store.d.ts +22 -3
package/dest/archiver/kv_archiver_store/block_store.d.ts.map +1 -1
package/dest/archiver/kv_archiver_store/block_store.js +75 -12
package/dest/archiver/kv_archiver_store/contract_class_store.d.ts +2 -1
package/dest/archiver/kv_archiver_store/contract_class_store.d.ts.map +1 -1
package/dest/archiver/kv_archiver_store/contract_class_store.js +11 -4
package/dest/archiver/kv_archiver_store/contract_instance_store.d.ts +1 -0
package/dest/archiver/kv_archiver_store/contract_instance_store.d.ts.map +1 -1
package/dest/archiver/kv_archiver_store/contract_instance_store.js +4 -1
package/dest/archiver/kv_archiver_store/kv_archiver_store.d.ts +31 -23
package/dest/archiver/kv_archiver_store/kv_archiver_store.d.ts.map +1 -1
package/dest/archiver/kv_archiver_store/kv_archiver_store.js +65 -38
package/dest/archiver/kv_archiver_store/log_store.d.ts +4 -5
package/dest/archiver/kv_archiver_store/log_store.d.ts.map +1 -1
package/dest/archiver/kv_archiver_store/log_store.js +18 -14
package/dest/archiver/kv_archiver_store/message_store.d.ts +2 -0
package/dest/archiver/kv_archiver_store/message_store.d.ts.map +1 -1
package/dest/archiver/kv_archiver_store/message_store.js +18 -8
package/dest/archiver/memory_archiver_store/l1_to_l2_message_store.d.ts +1 -0
package/dest/archiver/memory_archiver_store/l1_to_l2_message_store.d.ts.map +1 -1
package/dest/archiver/memory_archiver_store/l1_to_l2_message_store.js +4 -1
package/dest/archiver/memory_archiver_store/memory_archiver_store.d.ts +23 -39
package/dest/archiver/memory_archiver_store/memory_archiver_store.d.ts.map +1 -1
package/dest/archiver/memory_archiver_store/memory_archiver_store.js +132 -91
package/dest/index.d.ts +0 -1
package/dest/index.d.ts.map +1 -1
package/dest/index.js +2 -2
package/dest/test/index.d.ts +2 -0
package/dest/test/index.d.ts.map +1 -0
package/dest/test/index.js +2 -0
package/dest/test/mock_l2_block_source.d.ts +73 -0
package/dest/test/mock_l2_block_source.d.ts.map +1 -0
package/dest/test/mock_l2_block_source.js +134 -0
package/package.json +15 -11
package/src/archiver/archiver.ts +531 -248
package/src/archiver/archiver_store.ts +53 -31
package/src/archiver/archiver_store_test_suite.ts +93 -81
package/src/archiver/config.ts +5 -5
package/src/archiver/data_retrieval.ts +189 -30
package/src/archiver/epoch_helpers.ts +26 -0
package/src/archiver/kv_archiver_store/block_store.ts +87 -12
package/src/archiver/kv_archiver_store/contract_class_store.ts +18 -5
package/src/archiver/kv_archiver_store/contract_instance_store.ts +4 -0
package/src/archiver/kv_archiver_store/kv_archiver_store.ts +74 -47
package/src/archiver/kv_archiver_store/log_store.ts +18 -18
package/src/archiver/kv_archiver_store/message_store.ts +18 -5
package/src/archiver/memory_archiver_store/l1_to_l2_message_store.ts +4 -0
package/src/archiver/memory_archiver_store/memory_archiver_store.ts +155 -108
package/src/index.ts +1 -2
package/src/test/index.ts +1 -0
package/src/test/mock_l2_block_source.ts +165 -0
package/dest/archiver/eth_log_handlers.d.ts +0 -59
package/dest/archiver/eth_log_handlers.d.ts.map +0 -1
package/dest/archiver/eth_log_handlers.js +0 -155
package/dest/archiver/kv_archiver_store/block_body_store.d.ts +0 -34
package/dest/archiver/kv_archiver_store/block_body_store.d.ts.map +0 -1
package/dest/archiver/kv_archiver_store/block_body_store.js +0 -65
package/dest/archiver/kv_archiver_store/proven_store.d.ts +0 -14
package/dest/archiver/kv_archiver_store/proven_store.d.ts.map +0 -1
package/dest/archiver/kv_archiver_store/proven_store.js +0 -30
package/src/archiver/eth_log_handlers.ts +0 -213
package/src/archiver/kv_archiver_store/block_body_store.ts +0 -74
package/src/archiver/kv_archiver_store/proven_store.ts +0 -34

package/src/archiver/kv_archiver_store/kv_archiver_store.ts CHANGED Viewed

@@ -1,7 +1,4 @@
 import {
-  type Body,
-  type EncryptedL2BlockL2Logs,
-  type EncryptedNoteL2BlockL2Logs,
   type FromLogType,
   type GetUnencryptedLogsResponse,
   type InboxLeaf,
@@ -12,9 +9,8 @@ import {
   type TxEffect,
   type TxHash,
   type TxReceipt,
-  type UnencryptedL2BlockL2Logs,
 } from '@aztec/circuit-types';
-import { type Fr } from '@aztec/circuits.js';
+import { type Fr, type Header } from '@aztec/circuits.js';
 import { type ContractArtifact } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { createDebugLogger } from '@aztec/foundation/log';
@@ -27,24 +23,20 @@ import {
 } from '@aztec/types/contracts';
 import { type ArchiverDataStore, type ArchiverL1SynchPoint } from '../archiver_store.js';
-import { type DataRetrieval, type SingletonDataRetrieval } from '../structs/data_retrieval.js';
+import { type DataRetrieval } from '../structs/data_retrieval.js';
 import { type L1Published } from '../structs/published.js';
-import { BlockBodyStore } from './block_body_store.js';
 import { BlockStore } from './block_store.js';
 import { ContractArtifactsStore } from './contract_artifacts_store.js';
 import { ContractClassStore } from './contract_class_store.js';
 import { ContractInstanceStore } from './contract_instance_store.js';
 import { LogStore } from './log_store.js';
 import { MessageStore } from './message_store.js';
-import { ProvenStore } from './proven_store.js';
 /**
  * LMDB implementation of the ArchiverDataStore interface.
  */
 export class KVArchiverDataStore implements ArchiverDataStore {
-  #blockBodyStore: BlockBodyStore;
   #blockStore: BlockStore;
-  #provenStore: ProvenStore;
   #logStore: LogStore;
   #messageStore: MessageStore;
   #contractClassStore: ContractClassStore;
@@ -54,9 +46,7 @@ export class KVArchiverDataStore implements ArchiverDataStore {
   #log = createDebugLogger('aztec:archiver:data-store');
   constructor(db: AztecKVStore, logsMaxPageSize: number = 1000) {
-    this.#blockBodyStore = new BlockBodyStore(db);
-    this.#blockStore = new BlockStore(db, this.#blockBodyStore);
-    this.#provenStore = new ProvenStore(db);
+    this.#blockStore = new BlockStore(db);
     this.#logStore = new LogStore(db, this.#blockStore, logsMaxPageSize);
     this.#messageStore = new MessageStore(db);
     this.#contractClassStore = new ContractClassStore(db);
@@ -84,8 +74,14 @@ export class KVArchiverDataStore implements ArchiverDataStore {
     return Promise.resolve(this.#contractInstanceStore.getContractInstance(address));
   }
-  async addContractClasses(data: ContractClassPublic[], _blockNumber: number): Promise<boolean> {
-    return (await Promise.all(data.map(c => this.#contractClassStore.addContractClass(c)))).every(Boolean);
+  async addContractClasses(data: ContractClassPublic[], blockNumber: number): Promise<boolean> {
+    return (await Promise.all(data.map(c => this.#contractClassStore.addContractClass(c, blockNumber)))).every(Boolean);
+  }
+  async deleteContractClasses(data: ContractClassPublic[], blockNumber: number): Promise<boolean> {
+    return (await Promise.all(data.map(c => this.#contractClassStore.deleteContractClasses(c, blockNumber)))).every(
+      Boolean,
+    );
   }
   addFunctions(
@@ -100,23 +96,8 @@ export class KVArchiverDataStore implements ArchiverDataStore {
     return (await Promise.all(data.map(c => this.#contractInstanceStore.addContractInstance(c)))).every(Boolean);
   }
-  /**
-   * Append new block bodies to the store's list.
-   * @param blockBodies - The L2 block bodies to be added to the store.
-   * @returns True if the operation is successful.
-   */
-  addBlockBodies(blockBodies: DataRetrieval<Body>): Promise<boolean> {
-    return this.#blockBodyStore.addBlockBodies(blockBodies);
-  }
-  /**
-   * Gets block bodies that have the same txHashes as we supply.
-   *
-   * @param txsEffectsHashes - A list of txsEffectsHashes (body hashes).
-   * @returns The requested L2 block bodies
-   */
-  getBlockBodies(txsEffectsHashes: Buffer[]): Promise<(Body | undefined)[]> {
-    return this.#blockBodyStore.getBlockBodies(txsEffectsHashes);
+  async deleteContractInstances(data: ContractInstanceWithAddress[], _blockNumber: number): Promise<boolean> {
+    return (await Promise.all(data.map(c => this.#contractInstanceStore.deleteContractInstance(c)))).every(Boolean);
   }
   /**
@@ -128,6 +109,17 @@ export class KVArchiverDataStore implements ArchiverDataStore {
     return this.#blockStore.addBlocks(blocks);
   }
+  /**
+   * Unwinds blocks from the database
+   * @param from -  The tip of the chain, passed for verification purposes,
+   *                ensuring that we don't end up deleting something we did not intend
+   * @param blocksToUnwind - The number of blocks we are to unwind
+   * @returns True if the operation is successful
+   */
+  unwindBlocks(from: number, blocksToUnwind: number): Promise<boolean> {
+    return this.#blockStore.unwindBlocks(from, blocksToUnwind);
+  }
   /**
    * Gets up to `limit` amount of L2 blocks starting from `from`.
    *
@@ -144,6 +136,22 @@ export class KVArchiverDataStore implements ArchiverDataStore {
     }
   }
+  /**
+   * Gets up to `limit` amount of L2 blocks headers starting from `from`.
+   *
+   * @param start - Number of the first block to return (inclusive).
+   * @param limit - The number of blocks to return.
+   * @returns The requested L2 blocks
+   */
+  getBlockHeaders(start: number, limit: number): Promise<Header[]> {
+    try {
+      return Promise.resolve(Array.from(this.#blockStore.getBlockHeaders(start, limit)));
+    } catch (err) {
+      // this function is sync so if any errors are thrown we need to make sure they're passed on as rejected Promises
+      return Promise.reject(err);
+    }
+  }
   /**
    * Gets a tx effect.
    * @param txHash - The txHash of the tx corresponding to the tx effect.
@@ -164,18 +172,19 @@ export class KVArchiverDataStore implements ArchiverDataStore {
   /**
    * Append new logs to the store's list.
-   * @param encryptedLogs - The logs to be added to the store.
-   * @param unencryptedLogs - The type of the logs to be added to the store.
-   * @param blockNumber - The block for which to add the logs.
+   * @param blocks - The blocks for which to add the logs.
    * @returns True if the operation is successful.
    */
-  addLogs(
-    noteEncryptedLogs: EncryptedNoteL2BlockL2Logs | undefined,
-    encryptedLogs: EncryptedL2BlockL2Logs | undefined,
-    unencryptedLogs: UnencryptedL2BlockL2Logs | undefined,
-    blockNumber: number,
-  ): Promise<boolean> {
-    return this.#logStore.addLogs(noteEncryptedLogs, encryptedLogs, unencryptedLogs, blockNumber);
+  addLogs(blocks: L2Block[]): Promise<boolean> {
+    return this.#logStore.addLogs(blocks);
+  }
+  deleteLogs(blocks: L2Block[]): Promise<boolean> {
+    return this.#logStore.deleteLogs(blocks);
+  }
+  getTotalL1ToL2MessageCount(): Promise<bigint> {
+    return Promise.resolve(this.#messageStore.getTotalL1ToL2MessageCount());
   }
   /**
@@ -251,11 +260,31 @@ export class KVArchiverDataStore implements ArchiverDataStore {
   }
   getProvenL2BlockNumber(): Promise<number> {
-    return Promise.resolve(this.#provenStore.getProvenL2BlockNumber());
+    return Promise.resolve(this.#blockStore.getProvenL2BlockNumber());
+  }
+  getProvenL2EpochNumber(): Promise<number | undefined> {
+    return Promise.resolve(this.#blockStore.getProvenL2EpochNumber());
+  }
+  setProvenL2BlockNumber(blockNumber: number) {
+    this.#blockStore.setProvenL2BlockNumber(blockNumber);
+    return Promise.resolve();
+  }
+  setProvenL2EpochNumber(epochNumber: number) {
+    this.#blockStore.setProvenL2EpochNumber(epochNumber);
+    return Promise.resolve();
+  }
+  setBlockSynchedL1BlockNumber(l1BlockNumber: bigint) {
+    this.#blockStore.setSynchedL1BlockNumber(l1BlockNumber);
+    return Promise.resolve();
   }
-  async setProvenL2BlockNumber(blockNumber: SingletonDataRetrieval<number>) {
-    await this.#provenStore.setProvenL2BlockNumber(blockNumber);
+  setMessageSynchedL1BlockNumber(l1BlockNumber: bigint) {
+    this.#messageStore.setSynchedL1BlockNumber(l1BlockNumber);
+    return Promise.resolve();
   }
   /**
@@ -264,9 +293,7 @@ export class KVArchiverDataStore implements ArchiverDataStore {
   getSynchPoint(): Promise<ArchiverL1SynchPoint> {
     return Promise.resolve({
       blocksSynchedTo: this.#blockStore.getSynchedL1BlockNumber(),
-      blockBodiesSynchedTo: this.#blockBodyStore.getSynchedL1BlockNumber(),
       messagesSynchedTo: this.#messageStore.getSynchedL1BlockNumber(),
-      provenLogsSynchedTo: this.#provenStore.getSynchedL1BlockNumber(),
     });
   }
 }

package/src/archiver/kv_archiver_store/log_store.ts CHANGED Viewed

@@ -4,6 +4,7 @@ import {
   ExtendedUnencryptedL2Log,
   type FromLogType,
   type GetUnencryptedLogsResponse,
+  type L2Block,
   type L2BlockL2Logs,
   type LogFilter,
   LogId,
@@ -37,29 +38,28 @@ export class LogStore {
   /**
    * Append new logs to the store's list.
-   * @param encryptedLogs - The logs to be added to the store.
-   * @param unencryptedLogs - The type of the logs to be added to the store.
-   * @param blockNumber - The block for which to add the logs.
+   * @param blocks - The blocks for which to add the logs.
    * @returns True if the operation is successful.
    */
-  addLogs(
-    noteEncryptedLogs: EncryptedNoteL2BlockL2Logs | undefined,
-    encryptedLogs: EncryptedL2BlockL2Logs | undefined,
-    unencryptedLogs: UnencryptedL2BlockL2Logs | undefined,
-    blockNumber: number,
-  ): Promise<boolean> {
+  addLogs(blocks: L2Block[]): Promise<boolean> {
     return this.db.transaction(() => {
-      if (noteEncryptedLogs) {
-        void this.#noteEncryptedLogs.set(blockNumber, noteEncryptedLogs.toBuffer());
-      }
+      blocks.forEach(block => {
+        void this.#noteEncryptedLogs.set(block.number, block.body.noteEncryptedLogs.toBuffer());
+        void this.#encryptedLogs.set(block.number, block.body.encryptedLogs.toBuffer());
+        void this.#unencryptedLogs.set(block.number, block.body.unencryptedLogs.toBuffer());
+      });
-      if (encryptedLogs) {
-        void this.#encryptedLogs.set(blockNumber, encryptedLogs.toBuffer());
-      }
+      return true;
+    });
+  }
-      if (unencryptedLogs) {
-        void this.#unencryptedLogs.set(blockNumber, unencryptedLogs.toBuffer());
-      }
+  deleteLogs(blocks: L2Block[]): Promise<boolean> {
+    return this.db.transaction(() => {
+      blocks.forEach(block => {
+        void this.#noteEncryptedLogs.delete(block.number);
+        void this.#encryptedLogs.delete(block.number);
+        void this.#unencryptedLogs.delete(block.number);
+      });
       return true;
     });

package/src/archiver/kv_archiver_store/message_store.ts CHANGED Viewed

@@ -16,7 +16,8 @@ import { type DataRetrieval } from '../structs/data_retrieval.js';
 export class MessageStore {
   #l1ToL2Messages: AztecMap<string, Buffer>;
   #l1ToL2MessageIndices: AztecMap<string, bigint[]>; // We store array of bigints here because there can be duplicate messages
-  #lastL1BlockMessages: AztecSingleton<bigint>;
+  #lastSynchedL1Block: AztecSingleton<bigint>;
+  #totalMessageCount: AztecSingleton<bigint>;
   #log = createDebugLogger('aztec:archiver:message_store');
@@ -25,7 +26,12 @@ export class MessageStore {
   constructor(private db: AztecKVStore) {
     this.#l1ToL2Messages = db.openMap('archiver_l1_to_l2_messages');
     this.#l1ToL2MessageIndices = db.openMap('archiver_l1_to_l2_message_indices');
-    this.#lastL1BlockMessages = db.openSingleton('archiver_last_l1_block_new_messages');
+    this.#lastSynchedL1Block = db.openSingleton('archiver_last_l1_block_new_messages');
+    this.#totalMessageCount = db.openSingleton('archiver_l1_to_l2_message_count');
+  }
+  getTotalL1ToL2MessageCount(): bigint {
+    return this.#totalMessageCount.get() ?? 0n;
   }
   /**
@@ -33,7 +39,11 @@ export class MessageStore {
    * @returns The last L1 block number processed
    */
   getSynchedL1BlockNumber(): bigint | undefined {
-    return this.#lastL1BlockMessages.get();
+    return this.#lastSynchedL1Block.get();
+  }
+  setSynchedL1BlockNumber(l1BlockNumber: bigint) {
+    void this.#lastSynchedL1Block.set(l1BlockNumber);
   }
   /**
@@ -43,12 +53,12 @@ export class MessageStore {
    */
   addL1ToL2Messages(messages: DataRetrieval<InboxLeaf>): Promise<boolean> {
     return this.db.transaction(() => {
-      const lastL1BlockNumber = this.#lastL1BlockMessages.get() ?? 0n;
+      const lastL1BlockNumber = this.#lastSynchedL1Block.get() ?? 0n;
       if (lastL1BlockNumber >= messages.lastProcessedL1BlockNumber) {
         return false;
       }
-      void this.#lastL1BlockMessages.set(messages.lastProcessedL1BlockNumber);
+      void this.#lastSynchedL1Block.set(messages.lastProcessedL1BlockNumber);
       for (const message of messages.retrievedData) {
         if (message.index >= this.#l1ToL2MessagesSubtreeSize) {
@@ -66,6 +76,9 @@ export class MessageStore {
         void this.#l1ToL2MessageIndices.set(message.leaf.toString(), indices);
       }
+      const lastTotalMessageCount = this.getTotalL1ToL2MessageCount();
+      void this.#totalMessageCount.set(lastTotalMessageCount + BigInt(messages.retrievedData.length));
       return true;
     });
   }

package/src/archiver/memory_archiver_store/l1_to_l2_message_store.ts CHANGED Viewed

@@ -19,6 +19,10 @@ export class L1ToL2MessageStore {
   constructor() {}
+  getTotalL1ToL2MessageCount(): bigint {
+    return BigInt(this.store.size);
+  }
   addMessage(message: InboxLeaf) {
     if (message.index >= this.#l1ToL2MessagesSubtreeSize) {
       throw new Error(`Message index ${message.index} out of subtree range`);