@aztec/archiver 0.56.0 → 0.58.0

package/src/test/mock_l2_block_source.ts

@@ -0,0 +1,190 @@
+import { L2Block, type L2BlockSource, type L2Tips, type TxHash, TxReceipt, TxStatus } from '@aztec/circuit-types';
+import { EthAddress, type Header } from '@aztec/circuits.js';
+import { createDebugLogger } from '@aztec/foundation/log';
+
+import { getSlotRangeForEpoch } from '../archiver/epoch_helpers.js';
+
+/**
+ * A mocked implementation of L2BlockSource to be used in tests.
+ */
+export class MockL2BlockSource implements L2BlockSource {
+  protected l2Blocks: L2Block[] = [];
+
+  private provenEpochNumber: number = 0;
+  private provenBlockNumber: number = 0;
+
+  private log = createDebugLogger('aztec:archiver:mock_l2_block_source');
+
+  public createBlocks(numBlocks: number) {
+    for (let i = 0; i < numBlocks; i++) {
+      const blockNum = this.l2Blocks.length + 1;
+      const block = L2Block.random(blockNum);
+      this.l2Blocks.push(block);
+    }
+
+    this.log.verbose(`Created ${numBlocks} blocks in the mock L2 block source`);
+  }
+
+  public addBlocks(blocks: L2Block[]) {
+    this.l2Blocks.push(...blocks);
+    this.log.verbose(`Added ${blocks.length} blocks to the mock L2 block source`);
+  }
+
+  public removeBlocks(numBlocks: number) {
+    this.l2Blocks = this.l2Blocks.slice(0, -numBlocks);
+    this.log.verbose(`Removed ${numBlocks} blocks from the mock L2 block source`);
+  }
+
+  public setProvenBlockNumber(provenBlockNumber: number) {
+    this.provenBlockNumber = provenBlockNumber;
+  }
+
+  public setProvenEpochNumber(provenEpochNumber: number) {
+    this.provenEpochNumber = provenEpochNumber;
+  }
+
+  /**
+   * Method to fetch the rollup contract address at the base-layer.
+   * @returns The rollup address.
+   */
+  getRollupAddress(): Promise<EthAddress> {
+    return Promise.resolve(EthAddress.random());
+  }
+
+  /**
+   * Method to fetch the registry contract address at the base-layer.
+   * @returns The registry address.
+   */
+  getRegistryAddress(): Promise<EthAddress> {
+    return Promise.resolve(EthAddress.random());
+  }
+
+  /**
+   * Gets the number of the latest L2 block processed by the block source implementation.
+   * @returns In this mock instance, returns the number of L2 blocks that we've mocked.
+   */
+  public getBlockNumber() {
+    return Promise.resolve(this.l2Blocks.length);
+  }
+
+  public async getProvenBlockNumber(): Promise<number> {
+    return this.provenBlockNumber ?? (await this.getBlockNumber());
+  }
+
+  public getProvenL2EpochNumber(): Promise<number | undefined> {
+    return Promise.resolve(this.provenEpochNumber);
+  }
+
+  /**
+   * Gets an l2 block.
+   * @param number - The block number to return (inclusive).
+   * @returns The requested L2 block.
+   */
+  public getBlock(number: number) {
+    return Promise.resolve(this.l2Blocks[number - 1]);
+  }
+
+  /**
+   * Gets up to `limit` amount of L2 blocks starting from `from`.
+   * @param from - Number of the first block to return (inclusive).
+   * @param limit - The maximum number of blocks to return.
+   * @returns The requested mocked L2 blocks.
+   */
+  public getBlocks(from: number, limit: number, proven?: boolean) {
+    return Promise.resolve(
+      this.l2Blocks
+        .slice(from - 1, from - 1 + limit)
+        .filter(b => !proven || this.provenBlockNumber === undefined || b.number <= this.provenBlockNumber),
+    );
+  }
+
+  getBlockHeader(number: number | 'latest'): Promise<Header | undefined> {
+    return Promise.resolve(this.l2Blocks.at(typeof number === 'number' ? number - 1 : -1)?.header);
+  }
+
+  getBlocksForEpoch(epochNumber: bigint): Promise<L2Block[]> {
+    const [start, end] = getSlotRangeForEpoch(epochNumber);
+    const blocks = this.l2Blocks.filter(b => {
+      const slot = b.header.globalVariables.slotNumber.toBigInt();
+      return slot >= start && slot <= end;
+    });
+    return Promise.resolve(blocks);
+  }
+
+  /**
+   * Gets a tx effect.
+   * @param txHash - The hash of a transaction which resulted in the returned tx effect.
+   * @returns The requested tx effect.
+   */
+  public getTxEffect(txHash: TxHash) {
+    const txEffect = this.l2Blocks.flatMap(b => b.body.txEffects).find(tx => tx.txHash.equals(txHash));
+    return Promise.resolve(txEffect);
+  }
+
+  /**
+   * Gets a receipt of a settled tx.
+   * @param txHash - The hash of a tx we try to get the receipt for.
+   * @returns The requested tx receipt (or undefined if not found).
+   */
+  public getSettledTxReceipt(txHash: TxHash): Promise<TxReceipt | undefined> {
+    for (const block of this.l2Blocks) {
+      for (const txEffect of block.body.txEffects) {
+        if (txEffect.txHash.equals(txHash)) {
+          return Promise.resolve(
+            new TxReceipt(
+              txHash,
+              TxStatus.SUCCESS,
+              '',
+              txEffect.transactionFee.toBigInt(),
+              block.hash().toBuffer(),
+              block.number,
+            ),
+          );
+        }
+      }
+    }
+    return Promise.resolve(undefined);
+  }
+
+  async getL2Tips(): Promise<L2Tips> {
+    const [latest, proven, finalized] = [
+      await this.getBlockNumber(),
+      await this.getProvenBlockNumber(),
+      await this.getProvenBlockNumber(),
+    ] as const;
+
+    return {
+      latest: { number: latest, hash: this.l2Blocks[latest - 1]?.hash().toString() },
+      proven: { number: proven, hash: this.l2Blocks[proven - 1]?.hash().toString() },
+      finalized: { number: finalized, hash: this.l2Blocks[finalized - 1]?.hash().toString() },
+    };
+  }
+
+  getL2EpochNumber(): Promise<bigint> {
+    throw new Error('Method not implemented.');
+  }
+
+  getL2SlotNumber(): Promise<bigint> {
+    throw new Error('Method not implemented.');
+  }
+
+  isEpochComplete(_epochNumber: bigint): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
+
+  /**
+   * Starts the block source. In this mock implementation, this is a noop.
+   * @returns A promise that signals the initialization of the l2 block source on completion.
+   */
+  public start(): Promise<void> {
+    return Promise.resolve();
+  }
+
+  /**
+   * Stops the block source. In this mock implementation, this is a noop.
+   * @returns A promise that signals the l2 block source is now stopped.
+   */
+  public stop(): Promise<void> {
+    return Promise.resolve();
+  }
+}

package/dest/archiver/kv_archiver_store/proven_store.d.ts

@@ -1,14 +0,0 @@
-import { type AztecKVStore } from '@aztec/kv-store';
-import { type SingletonDataRetrieval } from '../structs/data_retrieval.js';
-export declare class ProvenStore {
-    #private;
-    private db;
-    constructor(db: AztecKVStore);
-    /**
-     * Gets the most recent L1 block processed.
-     */
-    getSynchedL1BlockNumber(): bigint | undefined;
-    getProvenL2BlockNumber(): number;
-    setProvenL2BlockNumber(blockNumber: SingletonDataRetrieval<number>): Promise<void>;
-}
-//# sourceMappingURL=proven_store.d.ts.map

package/dest/archiver/kv_archiver_store/proven_store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"proven_store.d.ts","sourceRoot":"","sources":["../../../src/archiver/kv_archiver_store/proven_store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAuB,MAAM,iBAAiB,CAAC;AAEzE,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAE3E,qBAAa,WAAW;;IAOV,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,YAAY;IAKpC;;OAEG;IACH,uBAAuB,IAAI,MAAM,GAAG,SAAS;IAI7C,sBAAsB,IAAI,MAAM;IAI1B,sBAAsB,CAAC,WAAW,EAAE,sBAAsB,CAAC,MAAM,CAAC;CAMzE"}

package/dest/archiver/kv_archiver_store/proven_store.js

@@ -1,30 +0,0 @@
-var _ProvenStore_lastSynchedL1Block, _ProvenStore_lastProvenL2Block;
-import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
-export class ProvenStore {
-    constructor(db) {
-        this.db = db;
-        /** Stores L1 block number in which the last processed L2 block was included */
-        _ProvenStore_lastSynchedL1Block.set(this, void 0);
-        /** Stores last proven L2 block number */
-        _ProvenStore_lastProvenL2Block.set(this, void 0);
-        __classPrivateFieldSet(this, _ProvenStore_lastSynchedL1Block, db.openSingleton('archiver_last_l1_block_proven_logs'), "f");
-        __classPrivateFieldSet(this, _ProvenStore_lastProvenL2Block, db.openSingleton('archiver_last_proven_l2_block'), "f");
-    }
-    /**
-     * Gets the most recent L1 block processed.
-     */
-    getSynchedL1BlockNumber() {
-        return __classPrivateFieldGet(this, _ProvenStore_lastSynchedL1Block, "f").get();
-    }
-    getProvenL2BlockNumber() {
-        return __classPrivateFieldGet(this, _ProvenStore_lastProvenL2Block, "f").get() ?? 0;
-    }
-    async setProvenL2BlockNumber(blockNumber) {
-        await this.db.transaction(() => {
-            void __classPrivateFieldGet(this, _ProvenStore_lastProvenL2Block, "f").set(blockNumber.retrievedData);
-            void __classPrivateFieldGet(this, _ProvenStore_lastSynchedL1Block, "f").set(blockNumber.lastProcessedL1BlockNumber);
-        });
-    }
-}
-_ProvenStore_lastSynchedL1Block = new WeakMap(), _ProvenStore_lastProvenL2Block = new WeakMap();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvdmVuX3N0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2FyY2hpdmVyL2t2X2FyY2hpdmVyX3N0b3JlL3Byb3Zlbl9zdG9yZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUlBLE1BQU0sT0FBTyxXQUFXO0lBT3RCLFlBQW9CLEVBQWdCO1FBQWhCLE9BQUUsR0FBRixFQUFFLENBQWM7UUFOcEMsK0VBQStFO1FBQy9FLGtEQUE0QztRQUU1Qyx5Q0FBeUM7UUFDekMsaURBQTJDO1FBR3pDLHVCQUFBLElBQUksbUNBQXVCLEVBQUUsQ0FBQyxhQUFhLENBQUMsb0NBQW9DLENBQUMsTUFBQSxDQUFDO1FBQ2xGLHVCQUFBLElBQUksa0NBQXNCLEVBQUUsQ0FBQyxhQUFhLENBQUMsK0JBQStCLENBQUMsTUFBQSxDQUFDO0lBQzlFLENBQUM7SUFFRDs7T0FFRztJQUNILHVCQUF1QjtRQUNyQixPQUFPLHVCQUFBLElBQUksdUNBQW9CLENBQUMsR0FBRyxFQUFFLENBQUM7SUFDeEMsQ0FBQztJQUVELHNCQUFzQjtRQUNwQixPQUFPLHVCQUFBLElBQUksc0NBQW1CLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRCxLQUFLLENBQUMsc0JBQXNCLENBQUMsV0FBMkM7UUFDdEUsTUFBTSxJQUFJLENBQUMsRUFBRSxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUU7WUFDN0IsS0FBSyx1QkFBQSxJQUFJLHNDQUFtQixDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsYUFBYSxDQUFDLENBQUM7WUFDNUQsS0FBSyx1QkFBQSxJQUFJLHVDQUFvQixDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsMEJBQTBCLENBQUMsQ0FBQztRQUM1RSxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7Q0FDRiJ9

package/src/archiver/kv_archiver_store/proven_store.ts

@@ -1,34 +0,0 @@
-import { type AztecKVStore, type AztecSingleton } from '@aztec/kv-store';
-
-import { type SingletonDataRetrieval } from '../structs/data_retrieval.js';
-
-export class ProvenStore {
-  /** Stores L1 block number in which the last processed L2 block was included */
-  #lastSynchedL1Block: AztecSingleton<bigint>;
-
-  /** Stores last proven L2 block number */
-  #lastProvenL2Block: AztecSingleton<number>;
-
-  constructor(private db: AztecKVStore) {
-    this.#lastSynchedL1Block = db.openSingleton('archiver_last_l1_block_proven_logs');
-    this.#lastProvenL2Block = db.openSingleton('archiver_last_proven_l2_block');
-  }
-
-  /**
-   * Gets the most recent L1 block processed.
-   */
-  getSynchedL1BlockNumber(): bigint | undefined {
-    return this.#lastSynchedL1Block.get();
-  }
-
-  getProvenL2BlockNumber(): number {
-    return this.#lastProvenL2Block.get() ?? 0;
-  }
-
-  async setProvenL2BlockNumber(blockNumber: SingletonDataRetrieval<number>) {
-    await this.db.transaction(() => {
-      void this.#lastProvenL2Block.set(blockNumber.retrievedData);
-      void this.#lastSynchedL1Block.set(blockNumber.lastProcessedL1BlockNumber);
-    });
-  }
-}