@aztec/archiver 0.16.3 → 0.16.5

package/src/archiver/config.ts

@@ -1,86 +0,0 @@
-import { L1ContractAddresses } from '@aztec/ethereum';
-import { EthAddress } from '@aztec/foundation/eth-address';
-
-/**
- * There are 2 polling intervals used in this configuration. The first is the archiver polling interval, archiverPollingIntervalMS.
- * This is the interval between successive calls to eth_blockNumber via viem.
- * Results of calls to eth_blockNumber are cached by viem with this cache being updated periodically at the interval specified by viemPollingIntervalMS.
- * As a result the maximum observed polling time for new blocks will be viemPollingIntervalMS + archiverPollingIntervalMS.
- */
-
-/**
- * The archiver configuration.
- */
-export interface ArchiverConfig {
-  /**
-   * The url of the Ethereum RPC node.
-   */
-  rpcUrl: string;
-
-  /**
-   * The key for the ethereum node.
-   */
-  apiKey?: string;
-
-  /**
-   * The polling interval in ms for retrieving new L2 blocks and encrypted logs.
-   */
-  archiverPollingIntervalMS?: number;
-
-  /**
-   * The polling interval viem uses in ms
-   */
-  viemPollingIntervalMS?: number;
-
-  /**
-   * The deployed L1 contract addresses
-   */
-  l1Contracts: L1ContractAddresses;
-
-  /**
-   * Optional dir to store data. If omitted will store in memory.
-   */
-  dataDirectory?: string;
-
-  /** The max number of logs that can be obtained in 1 "getUnencryptedLogs" call. */
-  maxLogs?: number;
-}
-
-/**
- * Returns the archiver configuration from the environment variables.
- * Note: If an environment variable is not set, the default value is used.
- * @returns The archiver configuration.
- */
-export function getConfigEnvVars(): ArchiverConfig {
-  const {
-    ETHEREUM_HOST,
-    ARCHIVER_POLLING_INTERVAL_MS,
-    ARCHIVER_VIEM_POLLING_INTERVAL_MS,
-    ROLLUP_CONTRACT_ADDRESS,
-    CONTRACT_DEPLOYMENT_EMITTER_ADDRESS,
-    API_KEY,
-    INBOX_CONTRACT_ADDRESS,
-    OUTBOX_CONTRACT_ADDRESS,
-    REGISTRY_CONTRACT_ADDRESS,
-    DATA_DIRECTORY,
-  } = process.env;
-  // Populate the relevant addresses for use by the archiver.
-  const addresses: L1ContractAddresses = {
-    rollupAddress: ROLLUP_CONTRACT_ADDRESS ? EthAddress.fromString(ROLLUP_CONTRACT_ADDRESS) : EthAddress.ZERO,
-    registryAddress: REGISTRY_CONTRACT_ADDRESS ? EthAddress.fromString(REGISTRY_CONTRACT_ADDRESS) : EthAddress.ZERO,
-    inboxAddress: INBOX_CONTRACT_ADDRESS ? EthAddress.fromString(INBOX_CONTRACT_ADDRESS) : EthAddress.ZERO,
-    outboxAddress: OUTBOX_CONTRACT_ADDRESS ? EthAddress.fromString(OUTBOX_CONTRACT_ADDRESS) : EthAddress.ZERO,
-    contractDeploymentEmitterAddress: CONTRACT_DEPLOYMENT_EMITTER_ADDRESS
-      ? EthAddress.fromString(CONTRACT_DEPLOYMENT_EMITTER_ADDRESS)
-      : EthAddress.ZERO,
-    decoderHelperAddress: EthAddress.ZERO,
-  };
-  return {
-    rpcUrl: ETHEREUM_HOST || 'http://127.0.0.1:8545/',
-    archiverPollingIntervalMS: ARCHIVER_POLLING_INTERVAL_MS ? +ARCHIVER_POLLING_INTERVAL_MS : 1_000,
-    viemPollingIntervalMS: ARCHIVER_VIEM_POLLING_INTERVAL_MS ? +ARCHIVER_VIEM_POLLING_INTERVAL_MS : 1_000,
-    apiKey: API_KEY,
-    l1Contracts: addresses,
-    dataDirectory: DATA_DIRECTORY,
-  };
-}

package/src/archiver/data_retrieval.ts

@@ -1,186 +0,0 @@
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { CancelledL1ToL2Message, ExtendedContractData, L2Block, PendingL1ToL2Message } from '@aztec/types';
-
-import { PublicClient } from 'viem';
-
-import {
-  getContractDeploymentLogs,
-  getL1ToL2MessageCancelledLogs,
-  getL2BlockProcessedLogs,
-  getPendingL1ToL2MessageLogs,
-  processBlockLogs,
-  processCancelledL1ToL2MessagesLogs,
-  processContractDeploymentLogs,
-  processPendingL1ToL2MessageAddedLogs,
-} from './eth_log_handlers.js';
-
-/**
- * Data retrieved from logs
- */
-type DataRetrieval<T> = {
-  /**
-   * The next block number.
-   */
-  nextEthBlockNumber: bigint;
-  /**
-   * The data returned.
-   */
-  retrievedData: T[];
-};
-
-/**
- * Fetches new L2 Blocks.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param rollupAddress - The address of the rollup contract.
- * @param blockUntilSynced - If true, blocks until the archiver has fully synced.
- * @param searchStartBlock - The block number to use for starting the search.
- * @param searchEndBlock - The highest block number that we should search up to.
- * @param expectedNextL2BlockNum - The next L2 block number that we expect to find.
- * @returns An array of L2 Blocks and the next eth block to search from
- */
-export async function retrieveBlocks(
-  publicClient: PublicClient,
-  rollupAddress: EthAddress,
-  blockUntilSynced: boolean,
-  searchStartBlock: bigint,
-  searchEndBlock: bigint,
-  expectedNextL2BlockNum: bigint,
-): Promise<DataRetrieval<L2Block>> {
-  const retrievedBlocks: L2Block[] = [];
-  do {
-    if (searchStartBlock > searchEndBlock) {
-      break;
-    }
-    const l2BlockProcessedLogs = await getL2BlockProcessedLogs(
-      publicClient,
-      rollupAddress,
-      searchStartBlock,
-      searchEndBlock,
-    );
-    if (l2BlockProcessedLogs.length === 0) {
-      break;
-    }
-
-    const newBlocks = await processBlockLogs(publicClient, expectedNextL2BlockNum, l2BlockProcessedLogs);
-    retrievedBlocks.push(...newBlocks);
-    searchStartBlock = l2BlockProcessedLogs[l2BlockProcessedLogs.length - 1].blockNumber! + 1n;
-    expectedNextL2BlockNum += BigInt(newBlocks.length);
-  } while (blockUntilSynced && searchStartBlock <= searchEndBlock);
-  return { nextEthBlockNumber: searchStartBlock, retrievedData: retrievedBlocks };
-}
-
-/**
- * Fetches new contract data.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param contractDeploymentEmitterAddress - The address of the contract deployment emitter contract.
- * @param blockUntilSynced - If true, blocks until the archiver has fully synced.
- * @param searchStartBlock - The block number to use for starting the search.
- * @param searchEndBlock - The highest block number that we should search up to.
- * @param blockHashMapping - A mapping from block number to relevant block hash.
- * @returns An array of ExtendedContractData and their equivalent L2 Block number along with the next eth block to search from..
- */
-export async function retrieveNewContractData(
-  publicClient: PublicClient,
-  contractDeploymentEmitterAddress: EthAddress,
-  blockUntilSynced: boolean,
-  searchStartBlock: bigint,
-  searchEndBlock: bigint,
-  blockHashMapping: { [key: number]: Buffer | undefined },
-): Promise<DataRetrieval<[ExtendedContractData[], number]>> {
-  let retrievedNewContracts: [ExtendedContractData[], number][] = [];
-  do {
-    if (searchStartBlock > searchEndBlock) {
-      break;
-    }
-    const contractDataLogs = await getContractDeploymentLogs(
-      publicClient,
-      contractDeploymentEmitterAddress,
-      searchStartBlock,
-      searchEndBlock,
-    );
-    if (contractDataLogs.length === 0) {
-      break;
-    }
-    const newContracts = processContractDeploymentLogs(blockHashMapping, contractDataLogs);
-    retrievedNewContracts = retrievedNewContracts.concat(newContracts);
-    searchStartBlock = (contractDataLogs.findLast(cd => !!cd)?.blockNumber || searchStartBlock) + 1n;
-  } while (blockUntilSynced && searchStartBlock <= searchEndBlock);
-  return { nextEthBlockNumber: searchStartBlock, retrievedData: retrievedNewContracts };
-}
-
-/**
- * Fetch new pending L1 to L2 messages.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param inboxAddress - The address of the inbox contract to fetch messages from.
- * @param blockUntilSynced - If true, blocks until the archiver has fully synced.
- * @param searchStartBlock - The block number to use for starting the search.
- * @param searchEndBlock - The highest block number that we should search up to.
- * @returns An array of L1ToL2Message and next eth block to search from.
- */
-export async function retrieveNewPendingL1ToL2Messages(
-  publicClient: PublicClient,
-  inboxAddress: EthAddress,
-  blockUntilSynced: boolean,
-  searchStartBlock: bigint,
-  searchEndBlock: bigint,
-): Promise<DataRetrieval<PendingL1ToL2Message>> {
-  const retrievedNewL1ToL2Messages: PendingL1ToL2Message[] = [];
-  do {
-    if (searchStartBlock > searchEndBlock) {
-      break;
-    }
-    const newL1ToL2MessageLogs = await getPendingL1ToL2MessageLogs(
-      publicClient,
-      inboxAddress,
-      searchStartBlock,
-      searchEndBlock,
-    );
-    if (newL1ToL2MessageLogs.length === 0) {
-      break;
-    }
-    const newL1ToL2Messages = processPendingL1ToL2MessageAddedLogs(newL1ToL2MessageLogs);
-    retrievedNewL1ToL2Messages.push(...newL1ToL2Messages);
-    // handles the case when there are no new messages:
-    searchStartBlock = (newL1ToL2MessageLogs.findLast(msgLog => !!msgLog)?.blockNumber || searchStartBlock) + 1n;
-  } while (blockUntilSynced && searchStartBlock <= searchEndBlock);
-  return { nextEthBlockNumber: searchStartBlock, retrievedData: retrievedNewL1ToL2Messages };
-}
-
-/**
- * Fetch newly cancelled L1 to L2 messages.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param inboxAddress - The address of the inbox contract to fetch messages from.
- * @param blockUntilSynced - If true, blocks until the archiver has fully synced.
- * @param searchStartBlock - The block number to use for starting the search.
- * @param searchEndBlock - The highest block number that we should search up to.
- * @returns An array of message keys that were cancelled and next eth block to search from.
- */
-export async function retrieveNewCancelledL1ToL2Messages(
-  publicClient: PublicClient,
-  inboxAddress: EthAddress,
-  blockUntilSynced: boolean,
-  searchStartBlock: bigint,
-  searchEndBlock: bigint,
-): Promise<DataRetrieval<CancelledL1ToL2Message>> {
-  const retrievedNewCancelledL1ToL2Messages: CancelledL1ToL2Message[] = [];
-  do {
-    if (searchStartBlock > searchEndBlock) {
-      break;
-    }
-    const newL1ToL2MessageCancelledLogs = await getL1ToL2MessageCancelledLogs(
-      publicClient,
-      inboxAddress,
-      searchStartBlock,
-      searchEndBlock,
-    );
-    if (newL1ToL2MessageCancelledLogs.length === 0) {
-      break;
-    }
-    const newCancelledL1ToL2Messages = processCancelledL1ToL2MessagesLogs(newL1ToL2MessageCancelledLogs);
-    retrievedNewCancelledL1ToL2Messages.push(...newCancelledL1ToL2Messages);
-    // handles the case when there are no new messages:
-    searchStartBlock =
-      (newL1ToL2MessageCancelledLogs.findLast(msgLog => !!msgLog)?.blockNumber || searchStartBlock) + 1n;
-  } while (blockUntilSynced && searchStartBlock <= searchEndBlock);
-  return { nextEthBlockNumber: searchStartBlock, retrievedData: retrievedNewCancelledL1ToL2Messages };
-}

package/src/archiver/eth_log_handlers.ts

@@ -1,268 +0,0 @@
-import { AztecAddress } from '@aztec/foundation/aztec-address';
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr, Point } from '@aztec/foundation/fields';
-import { ContractDeploymentEmitterAbi, InboxAbi, RollupAbi } from '@aztec/l1-artifacts';
-import {
-  BufferReader,
-  CancelledL1ToL2Message,
-  ContractData,
-  EncodedContractFunction,
-  ExtendedContractData,
-  L1Actor,
-  L1ToL2Message,
-  L2Actor,
-  L2Block,
-  PendingL1ToL2Message,
-} from '@aztec/types';
-
-import { Hex, Log, PublicClient, decodeFunctionData, getAbiItem, getAddress, hexToBytes } from 'viem';
-
-/**
- * Processes newly received MessageAdded (L1 to L2) logs.
- * @param logs - MessageAdded logs.
- * @returns Array of all Pending L1 to L2 messages that were processed
- */
-export function processPendingL1ToL2MessageAddedLogs(
-  logs: Log<bigint, number, undefined, true, typeof InboxAbi, 'MessageAdded'>[],
-): PendingL1ToL2Message[] {
-  const l1ToL2Messages: PendingL1ToL2Message[] = [];
-  for (const [index, log] of logs.entries()) {
-    const { sender, senderChainId, recipient, recipientVersion, content, secretHash, deadline, fee, entryKey } =
-      log.args;
-    l1ToL2Messages.push(
-      new PendingL1ToL2Message(
-        new L1ToL2Message(
-          new L1Actor(EthAddress.fromString(sender), Number(senderChainId)),
-          new L2Actor(AztecAddress.fromString(recipient), Number(recipientVersion)),
-          Fr.fromString(content),
-          Fr.fromString(secretHash),
-          deadline,
-          Number(fee),
-          Fr.fromString(entryKey),
-        ),
-        log.blockNumber!,
-        index,
-      ),
-    );
-  }
-  return l1ToL2Messages;
-}
-
-/**
- * Process newly received L1ToL2MessageCancelled logs.
- * @param logs - L1ToL2MessageCancelled logs.
- * @returns Array of message keys of the L1 to L2 messages that were cancelled
- */
-export function processCancelledL1ToL2MessagesLogs(
-  logs: Log<bigint, number, undefined, true, typeof InboxAbi, 'L1ToL2MessageCancelled'>[],
-): CancelledL1ToL2Message[] {
-  const cancelledL1ToL2Messages: CancelledL1ToL2Message[] = [];
-  for (const [index, log] of logs.entries()) {
-    cancelledL1ToL2Messages.push(new CancelledL1ToL2Message(Fr.fromString(log.args.entryKey), log.blockNumber!, index));
-  }
-  return cancelledL1ToL2Messages;
-}
-
-/**
- * Processes newly received L2BlockProcessed logs.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param expectedL2BlockNumber - The next expected L2 block number.
- * @param logs - L2BlockProcessed logs.
- */
-export async function processBlockLogs(
-  publicClient: PublicClient,
-  expectedL2BlockNumber: bigint,
-  logs: Log<bigint, number, undefined, true, typeof RollupAbi, 'L2BlockProcessed'>[],
-): Promise<L2Block[]> {
-  const retrievedBlocks: L2Block[] = [];
-  for (const log of logs) {
-    const blockNum = log.args.blockNum;
-    if (blockNum !== expectedL2BlockNumber) {
-      throw new Error('Block number mismatch. Expected: ' + expectedL2BlockNumber + ' but got: ' + blockNum + '.');
-    }
-    // TODO: Fetch blocks from calldata in parallel
-    const newBlock = await getBlockFromCallData(publicClient, log.transactionHash!, log.args.blockNum);
-    newBlock.setL1BlockNumber(log.blockNumber!);
-    retrievedBlocks.push(newBlock);
-    expectedL2BlockNumber++;
-  }
-  return retrievedBlocks;
-}
-
-/**
- * Builds an L2 block out of calldata from the tx that published it.
- * Assumes that the block was published from an EOA.
- * TODO: Add retries and error management.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param txHash - Hash of the tx that published it.
- * @param l2BlockNum - L2 block number.
- * @returns An L2 block deserialized from the calldata.
- */
-async function getBlockFromCallData(
-  publicClient: PublicClient,
-  txHash: `0x${string}`,
-  l2BlockNum: bigint,
-): Promise<L2Block> {
-  const { input: data } = await publicClient.getTransaction({ hash: txHash });
-  // TODO: File a bug in viem who complains if we dont remove the ctor from the abi here
-  const { functionName, args } = decodeFunctionData({
-    abi: RollupAbi.filter(item => item.type.toString() !== 'constructor'),
-    data,
-  });
-  if (functionName !== 'process') {
-    throw new Error(`Unexpected method called ${functionName}`);
-  }
-  const [, l2BlockHex] = args! as [Hex, Hex];
-  const block = L2Block.fromBufferWithLogs(Buffer.from(hexToBytes(l2BlockHex)));
-  if (BigInt(block.number) !== l2BlockNum) {
-    throw new Error(`Block number mismatch: expected ${l2BlockNum} but got ${block.number}`);
-  }
-  return block;
-}
-
-/**
- * Gets relevant `L2BlockProcessed` logs from chain.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param rollupAddress - The address of the rollup contract.
- * @param fromBlock - First block to get logs from (inclusive).
- * @param toBlock - Last block to get logs from (inclusive).
- * @returns An array of `L2BlockProcessed` logs.
- */
-export async function getL2BlockProcessedLogs(
-  publicClient: PublicClient,
-  rollupAddress: EthAddress,
-  fromBlock: bigint,
-  toBlock: bigint,
-) {
-  // Note: For some reason the return type of `getLogs` would not get correctly derived if I didn't set the abiItem
-  //       as a standalone constant.
-  const abiItem = getAbiItem({
-    abi: RollupAbi,
-    name: 'L2BlockProcessed',
-  });
-  return await publicClient.getLogs<typeof abiItem, true>({
-    address: getAddress(rollupAddress.toString()),
-    event: abiItem,
-    fromBlock,
-    toBlock: toBlock + 1n, // the toBlock argument in getLogs is exclusive
-  });
-}
-
-/**
- * Gets relevant `ContractDeployment` logs from chain.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param contractDeploymentEmitterAddress - The address of the L2 contract deployment emitter contract.
- * @param fromBlock - First block to get logs from (inclusive).
- * @param toBlock - Last block to get logs from (inclusive).
- * @returns An array of `ContractDeployment` logs.
- */
-export async function getContractDeploymentLogs(
-  publicClient: PublicClient,
-  contractDeploymentEmitterAddress: EthAddress,
-  fromBlock: bigint,
-  toBlock: bigint,
-): Promise<Log<bigint, number, undefined, true, typeof ContractDeploymentEmitterAbi, 'ContractDeployment'>[]> {
-  const abiItem = getAbiItem({
-    abi: ContractDeploymentEmitterAbi,
-    name: 'ContractDeployment',
-  });
-  return await publicClient.getLogs({
-    address: getAddress(contractDeploymentEmitterAddress.toString()),
-    event: abiItem,
-    fromBlock,
-    toBlock: toBlock + 1n, // the toBlock argument in getLogs is exclusive
-  });
-}
-
-/**
- * Processes newly received ContractDeployment logs.
- * @param blockHashMapping - A mapping from block number to relevant block hash.
- * @param logs - ContractDeployment logs.
- * @returns The set of retrieved extended contract data items.
- */
-export function processContractDeploymentLogs(
-  blockHashMapping: { [key: number]: Buffer | undefined },
-  logs: Log<bigint, number, undefined, true, typeof ContractDeploymentEmitterAbi, 'ContractDeployment'>[],
-): [ExtendedContractData[], number][] {
-  const extendedContractData: [ExtendedContractData[], number][] = [];
-  for (let i = 0; i < logs.length; i++) {
-    const log = logs[i];
-    const l2BlockNum = Number(log.args.l2BlockNum);
-    const blockHash = Buffer.from(hexToBytes(log.args.l2BlockHash));
-    const expectedBlockHash = blockHashMapping[l2BlockNum];
-    if (expectedBlockHash === undefined || !blockHash.equals(expectedBlockHash)) {
-      continue;
-    }
-    const publicFnsReader = BufferReader.asReader(Buffer.from(log.args.acir.slice(2), 'hex'));
-    const partialAddress = Fr.fromBuffer(Buffer.from(hexToBytes(log.args.partialAddress)));
-    const publicKey = new Point(
-      Fr.fromBuffer(Buffer.from(hexToBytes(log.args.pubKeyX))),
-      Fr.fromBuffer(Buffer.from(hexToBytes(log.args.pubKeyY))),
-    );
-
-    const contractData = new ExtendedContractData(
-      new ContractData(AztecAddress.fromString(log.args.aztecAddress), EthAddress.fromString(log.args.portalAddress)),
-      publicFnsReader.readVector(EncodedContractFunction),
-      partialAddress,
-      publicKey,
-    );
-    if (extendedContractData[i]) {
-      extendedContractData[i][0].push(contractData);
-    } else {
-      extendedContractData[i] = [[contractData], l2BlockNum];
-    }
-  }
-  return extendedContractData;
-}
-
-/**
- * Get relevant `MessageAdded` logs emitted by Inbox on chain.
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param inboxAddress - The address of the inbox contract.
- * @param fromBlock - First block to get logs from (inclusive).
- * @param toBlock - Last block to get logs from (inclusive).
- * @returns An array of `MessageAdded` logs.
- */
-export async function getPendingL1ToL2MessageLogs(
-  publicClient: PublicClient,
-  inboxAddress: EthAddress,
-  fromBlock: bigint,
-  toBlock: bigint,
-): Promise<Log<bigint, number, undefined, true, typeof InboxAbi, 'MessageAdded'>[]> {
-  const abiItem = getAbiItem({
-    abi: InboxAbi,
-    name: 'MessageAdded',
-  });
-  return await publicClient.getLogs({
-    address: getAddress(inboxAddress.toString()),
-    event: abiItem,
-    fromBlock,
-    toBlock: toBlock + 1n, // the toBlock argument in getLogs is exclusive
-  });
-}
-
-/**
- * Get relevant `L1ToL2MessageCancelled` logs emitted by Inbox on chain when pending messages are cancelled
- * @param publicClient - The viem public client to use for transaction retrieval.
- * @param inboxAddress - The address of the inbox contract.
- * @param fromBlock - First block to get logs from (inclusive).
- * @param toBlock - Last block to get logs from (inclusive).
- * @returns An array of `L1ToL2MessageCancelled` logs.
- */
-export async function getL1ToL2MessageCancelledLogs(
-  publicClient: PublicClient,
-  inboxAddress: EthAddress,
-  fromBlock: bigint,
-  toBlock: bigint,
-): Promise<Log<bigint, number, undefined, true, typeof InboxAbi, 'L1ToL2MessageCancelled'>[]> {
-  const abiItem = getAbiItem({
-    abi: InboxAbi,
-    name: 'L1ToL2MessageCancelled',
-  });
-  return await publicClient.getLogs({
-    address: getAddress(inboxAddress.toString()),
-    event: abiItem,
-    fromBlock,
-    toBlock: toBlock + 1n, // the toBlock argument in getLogs is exclusive
-  });
-}

package/src/archiver/index.ts

@@ -1,5 +0,0 @@
-export * from './archiver.js';
-export * from './config.js';
-export { MemoryArchiverStore } from './memory_archiver_store/memory_archiver_store.js';
-export { LMDBArchiverStore } from './lmdb_archiver_store.js';
-export { ArchiverDataStore } from './archiver_store.js';