@aztec-labs/p2p 6.0.0-nightly.20260829

package/src/client/factory.ts

@@ -0,0 +1,282 @@
+import type { EpochCacheInterface } from '@aztec-labs/epoch-cache';
+import { BlockNumber } from '@aztec-labs/foundation/branded-types';
+import { type Logger, createLogger } from '@aztec-labs/foundation/log';
+import { DateProvider } from '@aztec-labs/foundation/timer';
+import type { AztecAsyncKVStore } from '@aztec-labs/kv-store';
+import { AztecLMDBStoreV2, createStore } from '@aztec-labs/kv-store/lmdb-v2';
+import type { BlockHash, L2BlockSource } from '@aztec-labs/stdlib/block';
+import type { ChainConfig } from '@aztec-labs/stdlib/config';
+import type { ContractDataSource } from '@aztec-labs/stdlib/contract';
+import { type BlockMinFeesProvider, getNetworkTxGasLimits } from '@aztec-labs/stdlib/gas';
+import type {
+  AztecNode,
+  ClientProtocolCircuitVerifier,
+  WorldStateSynchronizer,
+} from '@aztec-labs/stdlib/interfaces/server';
+import type { DataStoreConfig } from '@aztec-labs/stdlib/kv-store';
+import { type TelemetryClient, getTelemetryClient } from '@aztec-labs/telemetry-client';
+
+import { P2PClient } from '../client/p2p_client.js';
+import type { P2PConfig } from '../config.js';
+import { AttestationPool, type AttestationPoolApi } from '../mem_pools/attestation_pool/attestation_pool.js';
+import type { MemPools } from '../mem_pools/interface.js';
+import type { TxPoolV2 } from '../mem_pools/tx_pool_v2/interfaces.js';
+import { AztecKVTxPoolV2 } from '../mem_pools/tx_pool_v2/tx_pool_v2.js';
+import {
+  createCheckAllowedSetupCalls,
+  createTxValidatorForOnDemandReceivedTxs,
+  createTxValidatorForTransactionsEnteringPendingTxPool,
+  getDefaultAllowedSetupFunctions,
+} from '../msg_validators/index.js';
+import { TxValidationCache } from '../msg_validators/tx_validator/tx_validation_cache.js';
+import { DummyP2PService } from '../services/dummy_service.js';
+import { LibP2PService } from '../services/index.js';
+import { createFileStoreTxSources } from '../services/tx_collection/file_store_tx_source.js';
+import { TxCollection } from '../services/tx_collection/tx_collection.js';
+import { NodeRpcTxSource, type TxSource, createNodeRpcTxSources } from '../services/tx_collection/tx_source.js';
+import { TxFileStore } from '../services/tx_file_store/tx_file_store.js';
+import { configureP2PClientAddresses, createLibP2PPeerIdFromPrivateKey, getPeerIdPrivateKey } from '../util.js';
+
+export type P2PClientDeps = {
+  txPool?: TxPoolV2;
+  store?: AztecAsyncKVStore;
+  attestationPool?: AttestationPoolApi;
+  logger?: Logger;
+  txCollectionNodeSources?: TxSource[];
+  rpcTxProviders?: AztecNode[];
+  p2pServiceFactory?: (...args: Parameters<(typeof LibP2PService)['new']>) => Promise<LibP2PService>;
+};
+
+export const P2P_STORE_NAME = 'p2p';
+export const P2P_ARCHIVE_STORE_NAME = 'p2p-archive';
+export const P2P_PEER_STORE_NAME = 'p2p-peers';
+export const P2P_ATTESTATION_STORE_NAME = 'p2p-attestation';
+
+export async function createP2PClient(
+  inputConfig: P2PConfig & DataStoreConfig & ChainConfig,
+  archiver: L2BlockSource & ContractDataSource,
+  proofVerifier: ClientProtocolCircuitVerifier,
+  worldStateSynchronizer: WorldStateSynchronizer,
+  epochCache: EpochCacheInterface,
+  blockMinFeesProvider: BlockMinFeesProvider,
+  packageVersion: string,
+  dateProvider: DateProvider = new DateProvider(),
+  telemetry: TelemetryClient = getTelemetryClient(),
+  deps: P2PClientDeps = {},
+  initialBlockHash: BlockHash,
+) {
+  const config = await configureP2PClientAddresses({
+    ...inputConfig,
+    dataStoreMapSizeKb: inputConfig.p2pStoreMapSizeKb ?? inputConfig.dataStoreMapSizeKb,
+  });
+
+  const logger = deps.logger ?? createLogger('p2p');
+
+  if (config.bootstrapNodes.length === 0) {
+    logger.warn(
+      'No bootstrap nodes have been provided. Set the BOOTSTRAP_NODES environment variable in order to join the P2P network',
+    );
+  }
+
+  const bindings = logger.getBindings();
+  // Schema version 4: L2 tips store resolves checkpoint tips from per-tip ids in l2_tip_checkpoints; the
+  // block->checkpoint mapping and checkpoint maps were dropped. Bumped to wipe stores whose tips predate
+  // per-tip ids, which would otherwise make getL2Tips throw on every read.
+  const store = deps.store ?? (await createStore(P2P_STORE_NAME, 4, config, bindings));
+  const archive = await createStore(P2P_ARCHIVE_STORE_NAME, 1, config, bindings);
+  const peerStore = await createStore(P2P_PEER_STORE_NAME, 1, config, bindings);
+  // Attestation store version 3: persisted proposal/attestation buffers embed the checkpoint header (which lost
+  // `inHash`) and the block-proposal wire format (which dropped its zeroed `inHash`), so pre-Fast-Inbox bytes no
+  // longer decode. Bumped to wipe stale pools; same no-migration policy as the archiver store.
+  const attestationStore = await createStore(P2P_ATTESTATION_STORE_NAME, 3, config, bindings);
+  const l1Constants = await archiver.getL1Constants();
+
+  const rollupAddress = inputConfig.rollupAddress.toString().toLowerCase().replace(/^0x/, '');
+  const txFileStoreBasePath = `aztec-${inputConfig.l1ChainId}-${inputConfig.rollupVersion}-0x${rollupAddress}`;
+
+  const allowedInSetup = [
+    ...(await getDefaultAllowedSetupFunctions()),
+    ...(inputConfig.txPublicSetupAllowListExtend ?? []),
+  ];
+  const checkAllowedSetupCalls = createCheckAllowedSetupCalls(
+    archiver,
+    allowedInSetup,
+    () => epochCache.getEpochAndSlotInNextL1Slot().ts,
+  );
+
+  const txPool =
+    deps.txPool ??
+    new AztecKVTxPoolV2(
+      store,
+      archive,
+      {
+        l2BlockSource: archiver,
+        worldStateSynchronizer,
+        checkAllowedSetupCalls,
+        createTxValidator: async () => {
+          const currentBlockNumber = await archiver.getBlockNumber();
+          const { ts: nextSlotTimestamp } = epochCache.getEpochAndSlotInNextL1Slot();
+          const l1Constants = await archiver.getL1Constants();
+          const gasFees = await blockMinFeesProvider.getCurrentMinFees();
+          const networkTxGasLimits = getNetworkTxGasLimits(config, l1Constants);
+          return createTxValidatorForTransactionsEnteringPendingTxPool(
+            worldStateSynchronizer,
+            nextSlotTimestamp,
+            BlockNumber(currentBlockNumber + 1),
+            {
+              maxTxL2Gas: networkTxGasLimits.l2Gas,
+              maxTxDAGas: networkTxGasLimits.daGas,
+            },
+            gasFees,
+          );
+        },
+        blockMinFeesProvider,
+      },
+      telemetry,
+      {
+        maxPendingTxCount: config.maxPendingTxCount,
+        archivedTxLimit: config.archivedTxLimit,
+        minTxPoolAgeMs: config.minTxPoolAgeMs,
+        dropTransactionsProbability: config.dropTransactionsProbability,
+        priceBumpPercentage: config.priceBumpPercentage,
+        keepFinalizedTxsForSlots: config.keepFinalizedTxsForSlots,
+      },
+      dateProvider,
+    );
+
+  const mempools: MemPools = {
+    txPool,
+    attestationPool: deps.attestationPool ?? new AttestationPool(attestationStore, telemetry),
+  };
+
+  const txValidationCache =
+    config.txValidationCacheSize > 0 ? new TxValidationCache(config.txValidationCacheSize) : undefined;
+
+  const p2pService = await createP2PService(
+    config,
+    archiver,
+    proofVerifier,
+    worldStateSynchronizer,
+    epochCache,
+    blockMinFeesProvider,
+    store,
+    peerStore,
+    mempools,
+    deps.p2pServiceFactory,
+    packageVersion,
+    logger.createChild('libp2p_service'),
+    telemetry,
+    txValidationCache,
+  );
+
+  const txValidatorForTxCollection = createTxValidatorForOnDemandReceivedTxs(
+    proofVerifier,
+    config,
+    /*bindings=*/ undefined,
+    txValidationCache,
+  );
+  const nodeSources = [
+    ...createNodeRpcTxSources(config.txCollectionNodeRpcUrls, txValidatorForTxCollection, config),
+    ...(deps.rpcTxProviders ?? []).map(
+      (node, i) => new NodeRpcTxSource(node, txValidatorForTxCollection, `node-rpc-provider-${i}`),
+    ),
+    ...(deps.txCollectionNodeSources ?? []),
+  ];
+  if (nodeSources.length > 0) {
+    logger.info(`Using ${nodeSources.length} node RPC sources for tx collection.`, {
+      nodes: nodeSources.map(n => n.getInfo()),
+    });
+  }
+
+  const fileStoreSources = await createFileStoreTxSources(
+    config.txCollectionFileStoreUrls,
+    txFileStoreBasePath,
+    txValidatorForTxCollection,
+    logger.createChild('file-store-tx-source'),
+    telemetry,
+  );
+  if (fileStoreSources.length > 0) {
+    logger.info(`Using ${fileStoreSources.length} file store sources for tx collection.`, {
+      stores: fileStoreSources.map(s => s.getInfo()),
+    });
+  }
+
+  const txCollection = new TxCollection(
+    p2pService.getBatchTxRequesterService(),
+    nodeSources,
+    l1Constants,
+    mempools.txPool,
+    config,
+    fileStoreSources,
+    dateProvider,
+    telemetry,
+    logger.createChild('tx-collection'),
+  );
+
+  const txFileStore = await TxFileStore.create(
+    mempools.txPool,
+    config,
+    txFileStoreBasePath,
+    logger.createChild('tx-file-store'),
+    telemetry,
+  );
+
+  return new P2PClient(
+    store,
+    archiver,
+    mempools,
+    p2pService,
+    txCollection,
+    txFileStore,
+    epochCache,
+    config,
+    dateProvider,
+    telemetry,
+    undefined,
+    initialBlockHash,
+  );
+}
+
+async function createP2PService(
+  config: P2PConfig & DataStoreConfig,
+  archiver: L2BlockSource & ContractDataSource,
+  proofVerifier: ClientProtocolCircuitVerifier,
+  worldStateSynchronizer: WorldStateSynchronizer,
+  epochCache: EpochCacheInterface,
+  blockMinFeesProvider: BlockMinFeesProvider,
+  store: AztecAsyncKVStore,
+  peerStore: AztecLMDBStoreV2,
+  mempools: MemPools,
+  p2pServiceFactory: P2PClientDeps['p2pServiceFactory'],
+  packageVersion: string,
+  logger: Logger,
+  telemetry: TelemetryClient,
+  txValidationCache?: TxValidationCache,
+) {
+  if (!config.p2pEnabled) {
+    logger.verbose('P2P is disabled. Using dummy P2P service.');
+    return new DummyP2PService();
+  }
+
+  logger.verbose('P2P is enabled. Using LibP2P service.');
+
+  // Create peer discovery service
+  const peerIdPrivateKey = await getPeerIdPrivateKey(config, store, logger);
+  const peerId = await createLibP2PPeerIdFromPrivateKey(peerIdPrivateKey.getValue());
+
+  const p2pService = await (p2pServiceFactory ?? LibP2PService.new)(config, peerId, {
+    packageVersion,
+    mempools,
+    l2BlockSource: archiver,
+    epochCache,
+    proofVerifier,
+    worldStateSynchronizer,
+    peerStore,
+    blockMinFeesProvider,
+    telemetry,
+    logger: logger.createChild(`libp2p_service`),
+    txValidationCache,
+  });
+
+  return p2pService;
+}

package/src/client/index.ts

@@ -0,0 +1,3 @@
+export * from './p2p_client.js';
+export * from './factory.js';
+export * from './interface.js';

package/src/client/interface.ts

@@ -0,0 +1,264 @@
+import type { SlotNumber } from '@aztec-labs/foundation/branded-types';
+import type { EthAddress, L2BlockId } from '@aztec-labs/stdlib/block';
+import type { ITxProvider, P2PClient } from '@aztec-labs/stdlib/interfaces/server';
+import type { BlockProposal, CheckpointAttestation, CheckpointProposal, TopicType } from '@aztec-labs/stdlib/p2p';
+import type { BlockHeader, Tx, TxHash } from '@aztec-labs/stdlib/tx';
+import type { PeerId } from '@libp2p/interface';
+import type { ENR } from '@nethermindeth/enr';
+
+import type { P2PConfig } from '../config.js';
+import type { AuthRequest, StatusMessage } from '../services/index.js';
+import type { ReqRespSubProtocol, ReqRespSubProtocolHandler } from '../services/reqresp/interface.js';
+import type {
+  DuplicateAttestationInfo,
+  DuplicateProposalInfo,
+  OversizedProposalInfo,
+  P2PBlockReceivedCallback,
+  P2PCheckpointAttestationCallback,
+  P2PCheckpointReceivedCallback,
+} from '../services/service.js';
+
+/**
+ * Enum defining the possible states of the p2p client.
+ */
+export enum P2PClientState {
+  IDLE,
+  SYNCHING,
+  RUNNING,
+  STOPPED,
+}
+
+/**
+ * The synchronization status of the P2P client.
+ */
+export interface P2PSyncState {
+  /**
+   * The current state of the p2p client.
+   */
+  state: P2PClientState;
+  /**
+   * The block number that the p2p client is synced to.
+   */
+  syncedToL2Block: L2BlockId;
+}
+
+/**
+ * Interface of a P2P client.
+ **/
+export type P2P = P2PClient & {
+  /**
+   * Broadcasts a block proposal to other peers.
+   *
+   * @param proposal - the block proposal
+   */
+  broadcastProposal(proposal: BlockProposal): Promise<void>;
+
+  /**
+   * Broadcasts a checkpoint proposal (last block in a checkpoint) to other peers.
+   *
+   * @param proposal - the checkpoint proposal
+   */
+  broadcastCheckpointProposal(proposal: CheckpointProposal): Promise<void>;
+
+  /** Broadcasts checkpoint attestations to other peers. */
+  broadcastCheckpointAttestations(attestations: CheckpointAttestation[]): Promise<void>;
+
+  /**
+   * Registers a callback from the validator client that determines how to behave when
+   * foreign block proposals are received
+   *
+   * @param handler - A function taking a received block proposal and producing an attestation
+   */
+  // REVIEW: https://github.com/AztecProtocol/aztec-packages/issues/7963
+  // ^ This pattern is not my favorite (md)
+  registerBlockProposalHandler(callback: P2PBlockReceivedCallback): void;
+
+  /**
+   * Registers a callback from the validator client that determines how to behave when
+   * foreign checkpoint proposals are received
+   *
+   * @param handler - A function taking a received checkpoint proposal and producing attestations
+   */
+  registerValidatorCheckpointProposalHandler(callback: P2PCheckpointReceivedCallback): void;
+
+  /**
+   * Registers a callback that runs for ALL nodes (not just validators) when a checkpoint proposal is received.
+   * Used to set the proposed checkpoint number on the archiver so the sequencer can build on top of it.
+   *
+   * @param handler - A function taking a received checkpoint proposal
+   */
+  registerAllNodesCheckpointProposalHandler(callback: P2PCheckpointReceivedCallback): void;
+
+  /**
+   * Registers a callback invoked when a duplicate proposal is detected (equivocation).
+   * The callback is triggered on the first duplicate (when count goes from 1 to 2).
+   *
+   * @param callback - Function called with info about the duplicate proposal
+   */
+  registerDuplicateProposalCallback(callback: (info: DuplicateProposalInfo) => void): void;
+
+  /**
+   * Registers a callback invoked when an oversized block proposal (index at or beyond the consensus
+   * per-checkpoint block limit) is stored and re-broadcast as slashing evidence.
+   *
+   * @param callback - Function called with info about the oversized proposal
+   */
+  registerOversizedProposalCallback(callback: (info: OversizedProposalInfo) => void): void;
+
+  /**
+   * Registers a callback invoked when a duplicate attestation is detected (equivocation).
+   * A validator signing attestations for different proposals at the same slot.
+   * The callback is triggered on the first duplicate (when count goes from 1 to 2).
+   *
+   * @param callback - Function called with info about the duplicate attestation
+   */
+  registerDuplicateAttestationCallback(callback: (info: DuplicateAttestationInfo) => void): void;
+
+  /** Registers a callback invoked when a valid checkpoint attestation is accepted into the pool. */
+  registerCheckpointAttestationCallback(callback: P2PCheckpointAttestationCallback): void;
+
+  /**
+   * Verifies the 'tx' and, if valid, adds it to local tx pool and forwards it to other peers.
+   * @param tx - The transaction.
+   **/
+  sendTx(tx: Tx): Promise<void>;
+
+  /**
+   * Handles failed transaction execution by removing txs from the pool.
+   * @param txHashes - Hashes of the transactions that failed execution.
+   **/
+  handleFailedExecution(txHashes: TxHash[]): Promise<void>;
+
+  /**
+   * Returns a transaction in the transaction pool by its hash.
+   * @param txHash  - Hash of tx to return.
+   * @param opts - Set `includeProof: false` to skip loading the tx proof from the DB.
+   * @returns A single tx or undefined.
+   */
+  getTxByHashFromPool(txHash: TxHash, opts?: { includeProof?: boolean }): Promise<Tx | undefined>;
+
+  /**
+   * Returns transactions in the transaction pool by hash.
+   * @param txHashes  - Hashes of txs to return.
+   * @param opts - Set `includeProof: false` to skip loading tx proofs from the DB.
+   * @returns An array of txs or undefined.
+   */
+  getTxsByHashFromPool(txHashes: TxHash[], opts?: { includeProof?: boolean }): Promise<(Tx | undefined)[]>;
+
+  /**
+   * Checks if transactions exist in the pool
+   * @param txHashes - The hashes of the transactions to check for
+   * @returns True or False for each hash
+   */
+  hasTxsInPool(txHashes: TxHash[]): Promise<boolean[]>;
+
+  /**
+   * Returns an archived transaction from the transaction pool by its hash.
+   * @param txHash  - Hash of tx to return.
+   * @returns A single tx or undefined.
+   */
+  getArchivedTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+
+  /**
+   * Returns whether the given tx hash is flagged as pending, mined, or deleted.
+   * @param txHash - Hash of the tx to query.
+   * @returns Pending, mined, or deleted depending on its status, or undefined if not found.
+   */
+  getTxStatus(txHash: TxHash): Promise<'pending' | 'mined' | 'deleted' | undefined>;
+
+  /**
+   * Returns an iterator over pending txs on the mempool.
+   * Set `includeProof: false` to skip loading tx proofs from the DB.
+   */
+  iteratePendingTxs(opts?: { includeProof?: boolean }): AsyncIterableIterator<Tx>;
+
+  /**
+   * Returns an iterator over pending txs that have been in the pool long enough to be eligible for block building.
+   * Set `includeProof: false` to skip loading tx proofs from the DB.
+   */
+  iterateEligiblePendingTxs(opts?: { includeProof?: boolean }): AsyncIterableIterator<Tx>;
+
+  /** Returns the number of pending txs in the mempool. */
+  getPendingTxCount(): Promise<number>;
+
+  /**
+   * Returns whether at least `minCount` pending txs have been in the pool long enough to be eligible for block
+   * building. Early-exits once the threshold is met instead of counting every eligible tx.
+   */
+  hasEligiblePendingTxs(minCount: number): Promise<boolean>;
+
+  /**
+   * Protects existing transactions by hash for a given slot.
+   * Returns hashes of transactions that weren't found in the pool.
+   * @param txHashes - Hashes of the transactions to protect.
+   * @param blockHeader - The block header providing slot context.
+   * @returns Hashes of transactions not found in the pool.
+   */
+  protectTxs(txHashes: TxHash[], blockHeader: BlockHeader): Promise<TxHash[]>;
+
+  /**
+   * Prepares the pool for a new slot.
+   * Unprotects transactions from earlier slots and validates them before
+   * returning to pending state.
+   * @param slotNumber - The slot number to prepare for
+   */
+  prepareForSlot(slotNumber: SlotNumber): Promise<void>;
+
+  /**
+   * Starts the p2p client.
+   * @returns A promise signalling the completion of the block sync.
+   */
+  start(): Promise<void>;
+
+  /**
+   * Stops the p2p client.
+   * @returns A promise signalling the completion of the stop process.
+   */
+  stop(): Promise<void>;
+
+  /**
+   * Indicates if the p2p client is ready for transaction submission.
+   * @returns A boolean flag indicating readiness.
+   */
+  isReady(): boolean;
+
+  /**
+   * Returns the current status of the p2p client.
+   */
+  getStatus(): Promise<P2PSyncState>;
+
+  /**
+   * Returns the ENR of this node, if any.
+   */
+  getEnr(): ENR | undefined;
+
+  /** Identifies a p2p client. */
+  isP2PClient(): true;
+
+  /** Returns the tx provider used for fetching transactions. */
+  getTxProvider(): ITxProvider;
+
+  updateP2PConfig(config: Partial<P2PConfig>): Promise<void>;
+
+  /**
+   * Validates a set of txs received in a block proposal.
+   * @throws InvalidBlockProposalTxsError - If any tx fails minimum integrity validation.
+   */
+  validateTxsReceivedInBlockProposal(txs: Tx[]): Promise<void>;
+
+  /** Clears the db. */
+  clear(): Promise<void>;
+
+  addReqRespSubProtocol(subProtocol: ReqRespSubProtocol, handler: ReqRespSubProtocolHandler): Promise<void>;
+
+  handleAuthRequestFromPeer(authRequest: AuthRequest, peerId: PeerId): Promise<StatusMessage>;
+
+  /** Checks if any block proposals exist for the given slot. */
+  hasBlockProposalsForSlot(slot: SlotNumber): Promise<boolean>;
+
+  /** If node running this P2P stack is validator, passes in validator address to P2P layer */
+  registerThisValidatorAddresses(address: EthAddress[]): void;
+
+  /** Returns the number of peers in the GossipSub mesh for a given topic type. */
+  getGossipMeshPeerCount(topicType: TopicType): Promise<number>;
+};