@aztec/archiver 4.0.0-nightly.20260113 → 4.0.0-nightly.20260114

package/src/archiver/test/fake_l1_state.ts

@@ -0,0 +1,561 @@
+import type { BlobClientInterface } from '@aztec/blob-client/client';
+import { type Blob, getBlobsPerL1Block, getPrefixedEthBlobCommitments } from '@aztec/blob-lib';
+import type { CheckpointProposedLog, InboxContract, MessageSentLog, RollupContract } from '@aztec/ethereum/contracts';
+import { MULTI_CALL_3_ADDRESS } from '@aztec/ethereum/contracts';
+import type { ViemPublicClient } from '@aztec/ethereum/types';
+import { type BlockNumber, CheckpointNumber, SlotNumber } from '@aztec/foundation/branded-types';
+import { Buffer16, Buffer32 } from '@aztec/foundation/buffer';
+import { Secp256k1Signer } from '@aztec/foundation/crypto/secp256k1-signer';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { createLogger } from '@aztec/foundation/log';
+import { RollupAbi } from '@aztec/l1-artifacts';
+import { CommitteeAttestation, CommitteeAttestationsAndSigners } from '@aztec/stdlib/block';
+import { Checkpoint } from '@aztec/stdlib/checkpoint';
+import { InboxLeaf } from '@aztec/stdlib/messaging';
+import {
+  makeAndSignCommitteeAttestationsAndSigners,
+  makeCheckpointAttestationFromCheckpoint,
+  mockCheckpointAndMessages,
+} from '@aztec/stdlib/testing';
+import { AppendOnlyTreeSnapshot } from '@aztec/stdlib/trees';
+
+import { type MockProxy, mock } from 'jest-mock-extended';
+import { type FormattedBlock, type Transaction, encodeFunctionData, multicall3Abi, toHex } from 'viem';
+
+import { updateRollingHash } from '../structs/inbox_message.js';
+
+/** Configuration for the fake L1 state. */
+export type FakeL1StateConfig = {
+  /** Genesis archive root. */
+  genesisArchiveRoot: Fr;
+  /** L1 start block number. */
+  l1StartBlock: bigint;
+  /** L1 genesis time in seconds. */
+  l1GenesisTime: bigint;
+  /** Ethereum slot duration in seconds. */
+  ethereumSlotDuration: number;
+  /** Rollup address for mock contracts. */
+  rollupAddress: EthAddress;
+  /** Inbox address for mock contracts. */
+  inboxAddress: EthAddress;
+};
+
+/** Options for adding a checkpoint. */
+type AddCheckpointOptions = {
+  /** L1 block number where checkpoint was proposed. */
+  l1BlockNumber: bigint;
+  /** Number of L2 blocks in the checkpoint. Default: 1 */
+  numBlocks?: number;
+  /** Number of transactions per block. Default: 4 */
+  txsPerBlock?: number;
+  /** Max number of effects per tx (for generating large blobs). Default: undefined */
+  maxEffects?: number;
+  /** Signers for attestations. Default: none */
+  signers?: Secp256k1Signer[];
+  /** Override slot number. */
+  slotNumber?: SlotNumber;
+  /** Override previous archive. */
+  previousArchive?: AppendOnlyTreeSnapshot;
+  /** Timestamp for the checkpoint. */
+  timestamp?: bigint;
+  /** Number of L1-to-L2 messages. Default: 3 */
+  numL1ToL2Messages?: number;
+  /** L1 block number where messages were sent. Default: l1BlockNumber - 3 */
+  messagesL1BlockNumber?: bigint;
+};
+
+/** Result from adding a checkpoint. */
+type AddCheckpointResult = {
+  /** The checkpoint that was created. */
+  checkpoint: Checkpoint;
+  /** The L1-to-L2 messages for this checkpoint. */
+  messages: Fr[];
+};
+
+/** Data stored for a checkpoint. */
+type CheckpointData = {
+  checkpointNumber: CheckpointNumber;
+  checkpoint: Checkpoint;
+  l1BlockNumber: bigint;
+  tx: Transaction;
+  blobHashes: `0x${string}`[];
+  blobs: Blob[];
+  signers: Secp256k1Signer[];
+  /** If true, archiveAt will ignore it */
+  pruned?: boolean;
+};
+
+/** Data stored for a message. */
+type MessageData = {
+  l1BlockNumber: bigint;
+  checkpointNumber: CheckpointNumber;
+  index: bigint;
+  leaf: Fr;
+  rollingHash: Buffer16;
+};
+
+/**
+ * Stateful fake for L1 data used by the archiver.
+ *
+ * This class simulates the L1 blockchain state that the archiver reads from:
+ * - RollupContract: status(), archiveAt(), getVersion(), getTargetCommitteeSize(), CheckpointProposed events
+ * - InboxContract: getState(), MessageSent events
+ * - PublicClient: getBlockNumber(), getBlock(), getTransaction()
+ * - BlobClient: getBlobSidecar()
+ *
+ * @example
+ * ```ts
+ * const fake = new FakeL1State(config);
+ *
+ * // Add checkpoint (creates messages automatically)
+ * const { checkpoint, messages } = await fake.addCheckpoint(CheckpointNumber(1), { l1BlockNumber: 101n });
+ * fake.setL1BlockNumber(105n);
+ *
+ * // Status auto-updated
+ * expect(fake.getRollupStatus().pendingCheckpointNumber).toEqual(CheckpointNumber(1));
+ * ```
+ */
+export class FakeL1State {
+  private readonly log = createLogger('archiver:test:fake-l1');
+  private l1BlockNumber: bigint;
+  private checkpoints: CheckpointData[] = [];
+  private messages: MessageData[] = [];
+  private messagesRollingHash: Buffer16 = Buffer16.ZERO;
+  private lastArchive: AppendOnlyTreeSnapshot;
+  private provenCheckpointNumber: CheckpointNumber = CheckpointNumber(0);
+  private targetCommitteeSize: number = 0;
+  private version: bigint = 1n;
+
+  // Computed from checkpoints based on L1 block visibility
+  private pendingCheckpointNumber: CheckpointNumber = CheckpointNumber(0);
+
+  constructor(private readonly config: FakeL1StateConfig) {
+    this.l1BlockNumber = config.l1StartBlock;
+    this.lastArchive = new AppendOnlyTreeSnapshot(config.genesisArchiveRoot, 1);
+  }
+
+  /**
+   * Adds messages for a checkpoint. Returns the message leaves.
+   * Auto-updates rolling hash.
+   *
+   * Note: For most use cases, use `addCheckpoint` which creates both checkpoint and messages.
+   * Use this method only when you need to add messages without creating a checkpoint (e.g., for reorg tests).
+   */
+  addMessages(checkpointNumber: CheckpointNumber, l1BlockNumber: bigint, messageLeaves: Fr[]): void {
+    messageLeaves.forEach((leaf, i) => {
+      const index = InboxLeaf.smallestIndexForCheckpoint(checkpointNumber) + BigInt(i);
+      this.messagesRollingHash = updateRollingHash(this.messagesRollingHash, leaf);
+
+      this.messages.push({
+        l1BlockNumber,
+        checkpointNumber,
+        index,
+        leaf,
+        rollingHash: this.messagesRollingHash,
+      });
+    });
+  }
+
+  /**
+   * Creates and adds a checkpoint with its L1-to-L2 messages.
+   * Returns both the checkpoint and the message leaves.
+   * Auto-chains from lastArchive, auto-updates pending status if L1 block >= checkpoint's L1 block.
+   */
+  async addCheckpoint(checkpointNumber: CheckpointNumber, options: AddCheckpointOptions): Promise<AddCheckpointResult> {
+    this.log.warn(`Adding checkpoint ${checkpointNumber}`);
+
+    const {
+      l1BlockNumber,
+      numBlocks = 1,
+      txsPerBlock = 4,
+      maxEffects,
+      signers = [],
+      slotNumber,
+      previousArchive = this.lastArchive,
+      timestamp,
+      numL1ToL2Messages = 3,
+      messagesL1BlockNumber = l1BlockNumber - 3n,
+    } = options;
+
+    // Create the checkpoint using the stdlib helper
+    // Only pass slotNumber and timestamp if they're defined to avoid overwriting defaults
+    const { checkpoint, messages, lastArchive } = await mockCheckpointAndMessages(checkpointNumber, {
+      startBlockNumber: this.getNextBlockNumber(checkpointNumber),
+      numBlocks,
+      numTxsPerBlock: txsPerBlock,
+      numL1ToL2Messages,
+      previousArchive,
+      ...(slotNumber !== undefined ? { slotNumber } : {}),
+      ...(timestamp !== undefined ? { timestamp } : {}),
+      ...(maxEffects !== undefined ? { maxEffects } : {}),
+    });
+
+    // Store the messages internally so they match the checkpoint's inHash
+    this.addMessages(checkpointNumber, messagesL1BlockNumber, messages);
+
+    // Create the transaction and blobs
+    const tx = this.makeRollupTx(checkpoint, signers);
+    const blobHashes = this.makeVersionedBlobHashes(checkpoint);
+    const blobs = this.makeBlobsFromCheckpoint(checkpoint);
+
+    // Store the checkpoint data
+    this.checkpoints.push({
+      checkpointNumber,
+      checkpoint,
+      l1BlockNumber,
+      tx,
+      blobHashes,
+      blobs,
+      signers,
+    });
+
+    // Update last archive for auto-chaining
+    this.lastArchive = lastArchive ?? checkpoint.blocks.at(-1)!.archive;
+
+    // Auto-update pending checkpoint number
+    this.updatePendingCheckpointNumber();
+
+    return { checkpoint, messages };
+  }
+
+  /**
+   * Sets the current L1 block number.
+   * Auto-updates pending checkpoint number based on visible checkpoints.
+   */
+  setL1BlockNumber(blockNumber: bigint): void {
+    this.l1BlockNumber = blockNumber;
+    this.updatePendingCheckpointNumber();
+  }
+
+  /** Marks a checkpoint as proven. Updates provenCheckpointNumber. */
+  markCheckpointAsProven(checkpointNumber: CheckpointNumber): void {
+    this.provenCheckpointNumber = checkpointNumber;
+  }
+
+  /** Sets the target committee size for attestation validation. */
+  setTargetCommitteeSize(size: number): void {
+    this.targetCommitteeSize = size;
+  }
+
+  /**
+   * Removes all entries for a checkpoint number (simulates L1 reorg or prune).
+   * Note: Does NOT remove messages for this checkpoint (use numL1ToL2Messages: 0 when re-adding).
+   * Auto-updates pending status.
+   */
+  removeCheckpoint(checkpointNumber: CheckpointNumber): void {
+    this.checkpoints = this.checkpoints.filter(cpData => cpData.checkpointNumber !== checkpointNumber);
+    this.updatePendingCheckpointNumber();
+  }
+
+  /**
+   * Removes messages after a given total index (simulates L1 reorg).
+   * Auto-updates rolling hash.
+   */
+  removeMessagesAfter(totalIndex: number): void {
+    this.messages = this.messages.slice(0, totalIndex);
+    // Recalculate rolling hash
+    this.messagesRollingHash = this.messages.reduce((hash, msg) => updateRollingHash(hash, msg.leaf), Buffer16.ZERO);
+  }
+
+  /**
+   * Simulates a pruned checkpoint by marking all entries with this number as pruned.
+   * The event will still be returned, but archiveAt() will return the previous checkpoint's archive
+   * (or genesis if no previous checkpoint), causing a mismatch that the archiver will detect.
+   */
+  markCheckpointAsPruned(checkpointNumber: CheckpointNumber): void {
+    for (const cpData of this.checkpoints) {
+      if (cpData.checkpointNumber === checkpointNumber) {
+        cpData.pruned = true;
+      }
+    }
+    this.updatePendingCheckpointNumber();
+  }
+
+  /**
+   * Moves messages at a given L1 block to a new L1 block.
+   * Useful for simulating partial message visibility (messages at higher L1 blocks won't be fetched).
+   */
+  moveMessagesToL1Block(fromL1Block: bigint, toL1Block: bigint): void {
+    this.messages.forEach(msg => {
+      if (msg.l1BlockNumber === fromL1Block) {
+        msg.l1BlockNumber = toL1Block;
+      }
+    });
+  }
+
+  /**
+   * Moves a specific message (by index in the messages array) to a new L1 block.
+   */
+  moveMessageAtIndexToL1Block(index: number, toL1Block: bigint): void {
+    if (this.messages[index]) {
+      this.messages[index].l1BlockNumber = toL1Block;
+    }
+  }
+
+  /** Gets current rollup status. */
+  getRollupStatus(): {
+    provenCheckpointNumber: CheckpointNumber;
+    pendingCheckpointNumber: CheckpointNumber;
+    provenArchive: Fr;
+    pendingArchive: Fr;
+  } {
+    return {
+      provenCheckpointNumber: this.provenCheckpointNumber,
+      pendingCheckpointNumber: this.pendingCheckpointNumber,
+      provenArchive: this.getArchiveAt(this.provenCheckpointNumber),
+      pendingArchive: this.getArchiveAt(this.pendingCheckpointNumber),
+    };
+  }
+
+  /** Gets the last archive (for manual chaining if needed). */
+  getLastArchive(): AppendOnlyTreeSnapshot {
+    return this.lastArchive;
+  }
+
+  /** Gets the latest checkpoint entry by number (returns the last added one). */
+  getCheckpoint(checkpointNumber: CheckpointNumber): Checkpoint | undefined {
+    return this.checkpoints.findLast(cpData => cpData.checkpointNumber === checkpointNumber)?.checkpoint;
+  }
+
+  /** Gets messages for a checkpoint. */
+  getMessages(checkpointNumber: CheckpointNumber): Fr[] {
+    return this.messages.filter(m => m.checkpointNumber === checkpointNumber).map(m => m.leaf);
+  }
+
+  /** Gets the blobs for a checkpoint. */
+  getCheckpointBlobs(checkpointNumber: CheckpointNumber): Blob[] {
+    return this.checkpoints.findLast(cpData => cpData.checkpointNumber === checkpointNumber)?.blobs ?? [];
+  }
+
+  /** Creates mock RollupContract that reads from this fake state. */
+  createMockRollupContract(_publicClient: MockProxy<ViemPublicClient>): MockProxy<RollupContract> {
+    const mockRollup = mock<RollupContract>();
+
+    mockRollup.getVersion.mockImplementation(() => Promise.resolve(this.version));
+    mockRollup.getTargetCommitteeSize.mockImplementation(() => Promise.resolve(this.targetCommitteeSize));
+    mockRollup.archiveAt.mockImplementation((cpNum: CheckpointNumber) => Promise.resolve(this.getArchiveAt(cpNum)));
+    mockRollup.status.mockImplementation((localCheckpointNum: CheckpointNumber) => {
+      const status = this.getRollupStatus();
+      return Promise.resolve({
+        provenCheckpointNumber: status.provenCheckpointNumber,
+        provenArchive: status.provenArchive,
+        pendingCheckpointNumber: status.pendingCheckpointNumber,
+        pendingArchive: status.pendingArchive,
+        archiveOfMyCheckpoint: this.getArchiveAt(localCheckpointNum),
+      });
+    });
+
+    // Mock the wrapper method for fetching checkpoint events
+    mockRollup.getCheckpointProposedEvents.mockImplementation((fromBlock: bigint, toBlock: bigint) =>
+      Promise.resolve(this.getCheckpointProposedLogs(fromBlock, toBlock)),
+    );
+
+    Object.defineProperty(mockRollup, 'address', { get: () => this.config.rollupAddress.toString() });
+
+    return mockRollup;
+  }
+
+  /** Creates mock InboxContract that reads from this fake state. */
+  createMockInboxContract(_publicClient: MockProxy<ViemPublicClient>): MockProxy<InboxContract> {
+    const mockInbox = mock<InboxContract>();
+
+    mockInbox.getState.mockImplementation(() =>
+      Promise.resolve({
+        messagesRollingHash: this.messagesRollingHash,
+        totalMessagesInserted: BigInt(this.messages.length),
+        treeInProgress: 0n,
+      }),
+    );
+
+    // Mock the wrapper methods for fetching message events
+    mockInbox.getMessageSentEvents.mockImplementation((fromBlock: bigint, toBlock: bigint) =>
+      Promise.resolve(this.getMessageSentLogs(fromBlock, toBlock)),
+    );
+
+    mockInbox.getMessageSentEventByHash.mockImplementation((hash: string, fromBlock: bigint, toBlock: bigint) =>
+      Promise.resolve(this.getMessageSentLogs(fromBlock, toBlock, hash)),
+    );
+
+    return mockInbox;
+  }
+
+  /** Creates mock PublicClient that reads from this fake state. */
+  createMockPublicClient(): MockProxy<ViemPublicClient> {
+    const publicClient = mock<ViemPublicClient>();
+
+    publicClient.getChainId.mockResolvedValue(1);
+    publicClient.getBlockNumber.mockImplementation(() => Promise.resolve(this.l1BlockNumber));
+
+    // Use async function pattern that existing test uses for getBlock
+
+    publicClient.getBlock.mockImplementation((async (args: { blockNumber?: bigint } = {}) => {
+      const blockNum = args.blockNumber ?? (await publicClient.getBlockNumber());
+      return {
+        number: blockNum,
+        timestamp: BigInt(blockNum) * BigInt(this.config.ethereumSlotDuration) + this.config.l1GenesisTime,
+        hash: Buffer32.fromBigInt(blockNum).toString(),
+      } as FormattedBlock;
+    }) as any);
+
+    // Use the same pattern as existing test for getTransaction
+    publicClient.getTransaction.mockImplementation((args: { hash?: `0x${string}` }) =>
+      Promise.resolve(
+        args.hash ? (this.checkpoints.find(cpData => cpData.tx.hash === args.hash)?.tx as any) : undefined,
+      ),
+    );
+
+    return publicClient;
+  }
+
+  /** Creates mock BlobClient that reads from this fake state. */
+  createMockBlobClient(): MockProxy<BlobClientInterface> {
+    const blobClient = mock<BlobClientInterface>();
+
+    // The blockId is the transaction's blockHash, which we set to the checkpoint's archive root
+    blobClient.getBlobSidecar.mockImplementation((blockId: `0x${string}`) =>
+      Promise.resolve(
+        this.checkpoints.find(cpData => cpData.checkpoint.archive.root.toString() === blockId)?.blobs ?? [],
+      ),
+    );
+
+    blobClient.testSources.mockResolvedValue(undefined);
+
+    return blobClient;
+  }
+
+  private updatePendingCheckpointNumber(): void {
+    this.pendingCheckpointNumber = this.checkpoints
+      .filter(cpData => cpData.l1BlockNumber <= this.l1BlockNumber && !cpData.pruned)
+      .reduce((max, cpData) => (cpData.checkpointNumber > max ? cpData.checkpointNumber : max), CheckpointNumber(0));
+  }
+
+  private getArchiveAt(checkpointNumber: CheckpointNumber): Fr {
+    if (checkpointNumber === 0) {
+      return this.config.genesisArchiveRoot;
+    }
+    // Find the latest non-pruned entry for this checkpoint number
+    const entries = this.checkpoints.filter(cpData => cpData.checkpointNumber === checkpointNumber);
+    const latestEntry = entries.at(-1);
+
+    if (!latestEntry || latestEntry.pruned) {
+      // For pruned or missing checkpoints, return the previous non-pruned checkpoint's archive
+      return this.getArchiveAt(CheckpointNumber(checkpointNumber - 1));
+    }
+    return latestEntry.checkpoint.archive.root;
+  }
+
+  private getNextBlockNumber(checkpointNumber: CheckpointNumber): BlockNumber {
+    const lastBlockNumber = this.checkpoints
+      .filter(cpData => cpData.checkpointNumber < checkpointNumber)
+      .flatMap(cpData => cpData.checkpoint.blocks.map(b => b.number))
+      .reduce((max, num) => Math.max(max, num), 0);
+    return (lastBlockNumber + 1) as BlockNumber;
+  }
+
+  private getCheckpointProposedLogs(fromBlock: bigint, toBlock: bigint): CheckpointProposedLog[] {
+    return this.checkpoints
+      .filter(cpData => cpData.l1BlockNumber >= fromBlock && cpData.l1BlockNumber <= toBlock)
+      .map(cpData => ({
+        l1BlockNumber: cpData.l1BlockNumber,
+        l1BlockHash: Buffer32.fromBigInt(cpData.l1BlockNumber),
+        l1TransactionHash: cpData.tx.hash as `0x${string}`,
+        args: {
+          checkpointNumber: cpData.checkpointNumber,
+          archive: cpData.checkpoint.archive.root,
+          versionedBlobHashes: cpData.blobHashes.map(h => Buffer.from(h.slice(2), 'hex')),
+          // These are intentionally undefined to skip hash validation in the archiver
+          // (validation is skipped when these fields are falsy)
+          payloadDigest: undefined,
+          attestationsHash: undefined,
+        },
+      }));
+  }
+
+  private getMessageSentLogs(fromBlock?: bigint, toBlock?: bigint, hashFilter?: string): MessageSentLog[] {
+    return this.messages
+      .filter(
+        msg =>
+          (!hashFilter || msg.leaf.toString() === hashFilter) &&
+          (!fromBlock || msg.l1BlockNumber >= fromBlock) &&
+          (!toBlock || msg.l1BlockNumber <= toBlock),
+      )
+      .map(msg => ({
+        l1BlockNumber: msg.l1BlockNumber,
+        l1BlockHash: Buffer32.fromBigInt(msg.l1BlockNumber),
+        l1TransactionHash: `0x${msg.l1BlockNumber.toString(16)}` as `0x${string}`,
+        args: {
+          checkpointNumber: msg.checkpointNumber,
+          index: msg.index,
+          leaf: msg.leaf,
+          rollingHash: msg.rollingHash,
+        },
+      }));
+  }
+
+  private makeRollupTx(checkpoint: Checkpoint, signers: Secp256k1Signer[]): Transaction {
+    const attestations = signers
+      .map(signer => makeCheckpointAttestationFromCheckpoint(checkpoint, signer))
+      .map(attestation => CommitteeAttestation.fromSignature(attestation.signature))
+      .map(committeeAttestation => committeeAttestation.toViem());
+
+    const header = checkpoint.header.toViem();
+    const blobInput = getPrefixedEthBlobCommitments(getBlobsPerL1Block(checkpoint.toBlobFields()));
+    const archive = toHex(checkpoint.archive.root.toBuffer());
+    const attestationsAndSigners = new CommitteeAttestationsAndSigners(
+      attestations.map(attestation => CommitteeAttestation.fromViem(attestation)),
+    );
+
+    const attestationsAndSignersSignature = makeAndSignCommitteeAttestationsAndSigners(
+      attestationsAndSigners,
+      signers[0],
+    );
+
+    const rollupInput = encodeFunctionData({
+      abi: RollupAbi,
+      functionName: 'propose',
+      args: [
+        {
+          header,
+          archive,
+          oracleInput: { feeAssetPriceModifier: 0n },
+        },
+        attestationsAndSigners.getPackedAttestations(),
+        attestationsAndSigners.getSigners().map(signer => signer.toString()),
+        attestationsAndSignersSignature.toViemSignature(),
+        blobInput,
+      ],
+    });
+
+    const multiCallInput = encodeFunctionData({
+      abi: multicall3Abi,
+      functionName: 'aggregate3',
+      args: [
+        [
+          {
+            target: this.config.rollupAddress.toString(),
+            callData: rollupInput,
+            allowFailure: false,
+          },
+        ],
+      ],
+    });
+
+    return {
+      input: multiCallInput,
+      hash: archive,
+      blockHash: archive,
+      to: MULTI_CALL_3_ADDRESS as `0x${string}`,
+    } as Transaction<bigint, number>;
+  }
+
+  private makeVersionedBlobHashes(checkpoint: Checkpoint): `0x${string}`[] {
+    return getBlobsPerL1Block(checkpoint.toBlobFields()).map(
+      b => `0x${b.getEthVersionedBlobHash().toString('hex')}` as `0x${string}`,
+    );
+  }
+
+  private makeBlobsFromCheckpoint(checkpoint: Checkpoint): Blob[] {
+    return getBlobsPerL1Block(checkpoint.toBlobFields());
+  }
+}