@aztec/p2p 0.0.0-test.0 → 0.0.1-commit.001888fc

package/src/services/tx_file_store/tx_file_store.ts

@@ -0,0 +1,175 @@
+import { type Logger, createLogger } from '@aztec/foundation/log';
+import { RunningPromise } from '@aztec/foundation/promise';
+import { makeBackoff, retry } from '@aztec/foundation/retry';
+import { Timer } from '@aztec/foundation/timer';
+import { type FileStore, createFileStore } from '@aztec/stdlib/file-store';
+import type { Tx } from '@aztec/stdlib/tx';
+import { type TelemetryClient, getTelemetryClient } from '@aztec/telemetry-client';
+
+import type { TxPoolV2 } from '../../mem_pools/index.js';
+import type { TxFileStoreConfig } from './config.js';
+import { TxFileStoreInstrumentation } from './instrumentation.js';
+
+/**
+ * Uploads validated transactions to a file store as a fallback retrieval mechanism.
+ * Listens to TxPool txs-added events and uploads txs asynchronously with bounded concurrency.
+ */
+export class TxFileStore {
+  private uploadQueue: Tx[] = [];
+  private activeUploads = 0;
+  private readonly queueProcessor: RunningPromise;
+  private readonly handleTxsAdded: (args: { txs: Tx[]; source?: string }) => void;
+
+  /** Recently uploaded tx hashes for deduplication. */
+  private recentUploads: Set<string> = new Set();
+  private recentUploadsOrder: string[] = [];
+  private readonly maxRecentUploads = 1000;
+
+  private constructor(
+    private readonly fileStore: FileStore,
+    private readonly txPool: TxPoolV2,
+    private readonly config: TxFileStoreConfig,
+    private readonly instrumentation: TxFileStoreInstrumentation,
+    private readonly log: Logger,
+    private readonly basePath: string,
+  ) {
+    this.handleTxsAdded = (args: { txs: Tx[]; source?: string }) => {
+      this.enqueueTxs(args.txs);
+    };
+    this.queueProcessor = new RunningPromise(() => this.processQueueBatch(), this.log, 100);
+  }
+
+  /**
+   * Creates and initializes the file store.
+   * @param txPool - The transaction pool to listen to.
+   * @param config - The file store configuration.
+   * @param log - Optional logger.
+   * @param telemetry - Optional telemetry client.
+   * @param fileStoreOverride - Optional FileStore for testing (bypasses createFileStore).
+   * @returns The file store instance, or undefined if not configured/enabled.
+   */
+  static async create(
+    txPool: TxPoolV2,
+    config: TxFileStoreConfig,
+    basePath: string,
+    log: Logger = createLogger('p2p:tx_file_store'),
+    telemetry: TelemetryClient = getTelemetryClient(),
+    fileStoreOverride?: FileStore,
+  ): Promise<TxFileStore | undefined> {
+    if (!config.txFileStoreEnabled) {
+      log.debug('Tx file store is disabled');
+      return undefined;
+    }
+
+    if (!config.txFileStoreUrl) {
+      log.warn('Tx file store is enabled but URL is not configured');
+      return undefined;
+    }
+
+    const fileStore = fileStoreOverride ?? (await createFileStore(config.txFileStoreUrl, log));
+    if (!fileStore) {
+      log.warn('Failed to create file store for tx file store');
+      return undefined;
+    }
+
+    const instrumentation = new TxFileStoreInstrumentation(telemetry, 'TxFileStore');
+    log.info('Created tx file store', { url: config.txFileStoreUrl, basePath });
+    return new TxFileStore(fileStore, txPool, config, instrumentation, log, basePath);
+  }
+
+  /** Starts listening to TxPool events and uploading txs. */
+  public start(): void {
+    this.queueProcessor.start();
+    this.txPool.on('txs-added', this.handleTxsAdded);
+    this.log.info('Started tx file store', {
+      concurrency: this.config.txFileStoreUploadConcurrency,
+      maxQueueSize: this.config.txFileStoreMaxQueueSize,
+    });
+  }
+
+  /** Stops listening and waits for pending uploads to complete. */
+  public async stop(): Promise<void> {
+    this.txPool.removeListener('txs-added', this.handleTxsAdded);
+    await this.queueProcessor.stop();
+    this.log.info('Stopped tx file store');
+  }
+
+  private enqueueTxs(txs: Tx[]): void {
+    this.uploadQueue.push(...txs);
+
+    // Enforce max queue size by dropping oldest entries
+    const overflow = this.uploadQueue.length - this.config.txFileStoreMaxQueueSize;
+    if (overflow > 0) {
+      this.log.warn(`Upload queue overflow, dropping ${overflow} oldest txs`);
+      this.uploadQueue.splice(0, overflow);
+    }
+
+    this.instrumentation.recordQueueSize(this.uploadQueue.length);
+
+    // Immediately start uploading txs
+    void this.queueProcessor.trigger();
+  }
+
+  private async processQueueBatch(): Promise<void> {
+    const batch = this.uploadQueue.splice(0, this.config.txFileStoreUploadConcurrency);
+    this.instrumentation.recordQueueSize(this.uploadQueue.length);
+
+    this.activeUploads += batch.length;
+    try {
+      await Promise.all(batch.map(tx => this.uploadTx(tx)));
+    } finally {
+      this.activeUploads -= batch.length;
+    }
+  }
+
+  private async uploadTx(tx: Tx): Promise<void> {
+    const txHash = tx.getTxHash().toString();
+    const path = `${this.basePath}/txs/${txHash}.bin`;
+    const timer = new Timer();
+
+    if (this.recentUploads.has(txHash)) {
+      return;
+    }
+
+    try {
+      this.recentUploads.add(txHash);
+      this.recentUploadsOrder.push(txHash);
+
+      if (this.recentUploadsOrder.length > this.maxRecentUploads) {
+        // delete old entries in recentUploads
+        for (const txHashToRemove of this.recentUploadsOrder.splice(
+          0,
+          this.recentUploadsOrder.length - this.maxRecentUploads,
+        )) {
+          this.recentUploads.delete(txHashToRemove);
+        }
+      }
+
+      await retry(
+        () => this.fileStore.save(path, tx.toBuffer(), { compress: true }),
+        `Uploading tx ${txHash}`,
+        makeBackoff([0.1, 0.5, 2]),
+        this.log,
+        true, // failSilently - don't log errors during retries
+      );
+      const durationMs = Math.trunc(timer.ms());
+      this.log.debug(`Uploaded tx to file store`, { txHash, path, durationMs });
+      this.instrumentation.recordUploadSuccess(durationMs);
+    } catch (err) {
+      this.log.warn(`Failed to upload tx to file store after retries`, { txHash, error: err });
+      this.instrumentation.recordUploadFailed();
+    }
+  }
+
+  /** Waits for all queued and in-flight uploads to complete. For testing. */
+  public async flush(): Promise<void> {
+    while (this.uploadQueue.length > 0 || this.activeUploads > 0) {
+      await this.queueProcessor.trigger();
+    }
+  }
+
+  /** Returns the number of pending uploads (queued + in-flight). */
+  public getPendingUploadCount(): number {
+    return this.uploadQueue.length + this.activeUploads;
+  }
+}

package/src/services/tx_provider.ts

@@ -0,0 +1,233 @@
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { compactArray } from '@aztec/foundation/collection';
+import { type Logger, createLogger } from '@aztec/foundation/log';
+import { elapsed } from '@aztec/foundation/timer';
+import type { L2Block, L2BlockInfo } from '@aztec/stdlib/block';
+import type { ITxProvider } from '@aztec/stdlib/interfaces/server';
+import type { BlockProposal } from '@aztec/stdlib/p2p';
+import { type BlockHeader, Tx, TxHash } from '@aztec/stdlib/tx';
+import { type TelemetryClient, getTelemetryClient } from '@aztec/telemetry-client';
+
+import type { PeerId } from '@libp2p/interface';
+
+import type { P2PClient } from '../client/p2p_client.js';
+import type { TxPoolV2 } from '../mem_pools/tx_pool_v2/interfaces.js';
+import type { FastCollectionRequestInput, TxCollection } from './tx_collection/tx_collection.js';
+import { TxProviderInstrumentation } from './tx_provider_instrumentation.js';
+
+/**
+ * Gathers and returns txs given a block proposal, block, or their hashes.
+ * Loads available txs from the tx pool, and  relies on a TxCollection service to collect txs from the network and other nodes.
+ */
+export class TxProvider implements ITxProvider {
+  protected instrumentation: TxProviderInstrumentation;
+
+  constructor(
+    private txCollection: TxCollection,
+    private txPool: TxPoolV2,
+    private blockProposalTransactionValidator: Pick<P2PClient, 'validateTxsReceivedInBlockProposal'>,
+    private log: Logger = createLogger('p2p:tx-collector'),
+    client: TelemetryClient = getTelemetryClient(),
+  ) {
+    this.instrumentation = new TxProviderInstrumentation(client, 'TxProvider');
+  }
+
+  /** Returns txs from the tx pool given their hashes.*/
+  public async getAvailableTxs(txHashes: TxHash[]): Promise<{ txs: Tx[]; missingTxs: TxHash[] }> {
+    const response = await this.txPool.getTxsByHash(txHashes);
+    if (response.length !== txHashes.length) {
+      throw new Error(`Unexpected response size from tx pool: expected ${txHashes.length} but got ${response.length}`);
+    }
+    const txs: Tx[] = [];
+    const missingTxs: TxHash[] = [];
+
+    for (let i = 0; i < txHashes.length; i++) {
+      const tx = response[i];
+      if (tx === undefined) {
+        missingTxs.push(txHashes[i]);
+      } else {
+        txs.push(tx);
+      }
+    }
+
+    return { txs, missingTxs };
+  }
+
+  /** Gathers txs from the tx pool, proposal body, remote rpc nodes, and reqresp. */
+  public getTxsForBlockProposal(
+    blockProposal: BlockProposal,
+    blockNumber: BlockNumber,
+    opts: { pinnedPeer: PeerId | undefined; deadline: Date },
+  ): Promise<{ txs: Tx[]; missingTxs: TxHash[] }> {
+    return this.getOrderedTxsFromAllSources(
+      { type: 'proposal', blockProposal, blockNumber },
+      { ...blockProposal.toBlockInfo(), blockNumber },
+      blockProposal.txHashes,
+      { ...opts, pinnedPeer: opts.pinnedPeer },
+    );
+  }
+
+  /** Gathers txs from the tx pool, remote rpc nodes, and reqresp. */
+  public getTxsForBlock(block: L2Block, opts: { deadline: Date }): Promise<{ txs: Tx[]; missingTxs: TxHash[] }> {
+    return this.getOrderedTxsFromAllSources(
+      { type: 'block', block },
+      block.toBlockInfo(),
+      block.body.txEffects.map(tx => tx.txHash),
+      { ...opts, pinnedPeer: undefined },
+    );
+  }
+
+  private async getOrderedTxsFromAllSources(
+    request: FastCollectionRequestInput,
+    blockInfo: L2BlockInfo,
+    txHashes: TxHash[],
+    opts: { pinnedPeer: PeerId | undefined; deadline: Date },
+  ) {
+    const [durationMs, result] = await elapsed(() => this.getTxsFromAllSources(request, blockInfo, txHashes, opts));
+    const { missingTxHashes, txsFromMempool, txsFromNetwork, txsFromProposal } = result;
+
+    const txs = [...(txsFromMempool ?? []), ...(txsFromProposal ?? []), ...(txsFromNetwork ?? [])];
+    const missingTxs = missingTxHashes?.length ?? 0;
+
+    const level = missingTxs === 0 ? 'verbose' : 'warn';
+    this.log[level](`Retrieved ${txs.length} out of ${blockInfo.txCount} txs for ${request.type}`, {
+      ...blockInfo,
+      txsFromProposal: txsFromProposal?.length,
+      txsFromMempool: txsFromMempool?.length,
+      txsFromNetwork: txsFromNetwork?.length,
+      missingTxs,
+      durationMs,
+    });
+
+    const orderedTxs = this.orderTxs(txs, txHashes);
+    if (orderedTxs.length + missingTxs !== txHashes.length) {
+      throw new Error(
+        `Error collecting txs for ${request.type} with ${txHashes.length} txs: found ${orderedTxs.length} and flagged ${missingTxs} as missing`,
+      );
+    }
+
+    return { txs: orderedTxs, missingTxs: (missingTxHashes ?? []).map(TxHash.fromString), durationMs };
+  }
+
+  private orderTxs(txs: Tx[], order: TxHash[]): Tx[] {
+    const txsMap = new Map(txs.map(tx => [tx.txHash.toString(), tx]));
+    return order.map(hash => txsMap.get(hash.toString())!).filter(tx => tx !== undefined);
+  }
+
+  private async getTxsFromAllSources(
+    request: FastCollectionRequestInput,
+    blockInfo: L2BlockInfo,
+    txHashes: TxHash[],
+    opts: { pinnedPeer: PeerId | undefined; deadline: Date },
+  ) {
+    const missingTxHashes = new Set(txHashes.map(txHash => txHash.toString()));
+    if (missingTxHashes.size === 0) {
+      this.log.debug(`Received request with no transactions`, blockInfo);
+      return {};
+    }
+
+    // First go to our tx pool and fetch whatever txs we have there
+    // We go to the mempool first since those txs are already validated
+    const txsFromMempool = compactArray(await this.txPool.getTxsByHash(txHashes));
+    txsFromMempool.forEach(tx => missingTxHashes.delete(tx.getTxHash().toString()));
+    this.instrumentation.incTxsFromMempool(txsFromMempool.length);
+    this.log.debug(
+      `Retrieved ${txsFromMempool.length} txs from mempool for block proposal (${missingTxHashes.size} pending)`,
+      { ...blockInfo, missingTxHashes: [...missingTxHashes] },
+    );
+
+    if (missingTxHashes.size === 0) {
+      this.instrumentation.incTxsFromP2P(0, txHashes.length);
+      return { txsFromMempool };
+    }
+
+    // Take txs from the proposal body if there are any
+    // Note that we still have to validate these txs, but we do it in parallel with tx collection
+    const proposal = request.type === 'proposal' ? request.blockProposal : undefined;
+    const proposalBlockHeader = proposal?.blockHeader;
+    const txsFromProposal = this.extractFromProposal(proposal, [...missingTxHashes]);
+    if (txsFromProposal.length > 0) {
+      this.instrumentation.incTxsFromProposals(txsFromProposal.length);
+      txsFromProposal.forEach(tx => missingTxHashes.delete(tx.txHash.toString()));
+      this.log.debug(`Retrieved ${txsFromProposal.length} txs from proposal body (${missingTxHashes.size} pending)`, {
+        ...blockInfo,
+        missingTxHashes: [...missingTxHashes],
+      });
+    }
+
+    if (missingTxHashes.size === 0) {
+      await this.processProposalTxs(txsFromProposal, proposalBlockHeader!);
+      this.instrumentation.incTxsFromP2P(0, txHashes.length);
+      return { txsFromMempool, txsFromProposal };
+    }
+
+    // Start tx collection from the network if needed, while we validate the txs taken from the proposal in parallel
+    const [txsFromNetwork] = await Promise.all([
+      this.collectFromP2P(request, [...missingTxHashes], opts),
+      this.processProposalTxs(txsFromProposal, proposalBlockHeader!),
+    ] as const);
+
+    if (txsFromNetwork.length > 0) {
+      txsFromNetwork.forEach(tx => missingTxHashes.delete(tx.txHash.toString()));
+      this.log.debug(
+        `Retrieved ${txsFromNetwork.length} txs from network for block proposal (${missingTxHashes.size} pending)`,
+        { ...blockInfo, missingTxHashes: [...missingTxHashes] },
+      );
+    }
+
+    this.instrumentation.incTxsFromP2P(txsFromNetwork.length, txHashes.length);
+
+    if (missingTxHashes.size === 0) {
+      return { txsFromNetwork, txsFromMempool, txsFromProposal };
+    }
+
+    // We are still missing txs, make one last attempt to collect them from our pool, in case they showed up somehow else
+    const moreTxsFromPool = compactArray(await this.txPool.getTxsByHash([...missingTxHashes].map(TxHash.fromString)));
+
+    if (moreTxsFromPool.length > 0) {
+      this.instrumentation.incTxsFromMempool(moreTxsFromPool.length);
+      this.log.debug(
+        `Retrieved ${moreTxsFromPool.length} txs from pool retry for block proposal (${missingTxHashes.size} pending)`,
+        { ...blockInfo, missingTxHashes: [...missingTxHashes] },
+      );
+    }
+
+    if (missingTxHashes.size > 0) {
+      this.instrumentation.incMissingTxs(missingTxHashes.size);
+    }
+
+    return {
+      txsFromNetwork,
+      txsFromMempool: [...txsFromMempool, ...moreTxsFromPool],
+      txsFromProposal,
+      missingTxHashes: [...missingTxHashes],
+    };
+  }
+
+  private async collectFromP2P(
+    input: FastCollectionRequestInput,
+    txHashes: TxHash[] | string[],
+    opts: { deadline: Date; pinnedPeer?: PeerId },
+  ): Promise<Tx[]> {
+    const requestedAt = Date.now();
+    const result = await this.txCollection.collectFastFor(input, txHashes, opts);
+    const requestProcessedAt = Date.now();
+    this.instrumentation.recordTxsRequestDelay(requestProcessedAt - requestedAt);
+    return result;
+  }
+
+  private extractFromProposal(proposal: BlockProposal | undefined, missingTxHashes: string[]): Tx[] {
+    if (!proposal) {
+      return [];
+    }
+    return compactArray(proposal.txs ?? []).filter(tx => missingTxHashes.includes(tx.getTxHash().toString()));
+  }
+
+  private async processProposalTxs(txs: Tx[], blockHeader: BlockHeader): Promise<void> {
+    if (txs.length === 0) {
+      return;
+    }
+    await this.blockProposalTransactionValidator.validateTxsReceivedInBlockProposal(txs);
+    await this.txPool.addProtectedTxs(txs, blockHeader);
+  }
+}

package/src/services/tx_provider_instrumentation.ts

@@ -0,0 +1,54 @@
+import {
+  type Histogram,
+  Metrics,
+  type TelemetryClient,
+  type UpDownCounter,
+  createUpDownCounterWithDefault,
+} from '@aztec/telemetry-client';
+
+export class TxProviderInstrumentation {
+  private txFromProposalCount: UpDownCounter;
+  private txFromMempoolCount: UpDownCounter;
+  private txFromP2PCount: UpDownCounter;
+  private missingTxsCount: UpDownCounter;
+
+  private fractionOfTxsRequestedFromP2P: Histogram;
+  private txsRequestDelay: Histogram;
+
+  constructor(client: TelemetryClient, name: string) {
+    const meter = client.getMeter(name);
+
+    this.txFromProposalCount = createUpDownCounterWithDefault(meter, Metrics.TX_PROVIDER_TXS_FROM_PROPOSALS_COUNT);
+
+    this.txFromMempoolCount = createUpDownCounterWithDefault(meter, Metrics.TX_PROVIDER_TXS_FROM_MEMPOOL_COUNT);
+
+    this.txFromP2PCount = createUpDownCounterWithDefault(meter, Metrics.TX_PROVIDER_TXS_FROM_P2P_COUNT);
+
+    this.missingTxsCount = createUpDownCounterWithDefault(meter, Metrics.TX_PROVIDER_MISSING_TXS_COUNT);
+
+    this.fractionOfTxsRequestedFromP2P = meter.createHistogram(Metrics.TX_PROVIDER_P2P_TXS_REQUESTED_FRACTION);
+
+    this.txsRequestDelay = meter.createHistogram(Metrics.TX_PROVIDER_P2P_TXS_REQUEST_DELAY);
+  }
+
+  incTxsFromProposals(count: number) {
+    this.txFromProposalCount.add(count);
+  }
+
+  incTxsFromMempool(count: number) {
+    this.txFromMempoolCount.add(count);
+  }
+
+  incTxsFromP2P(count: number, total: number) {
+    this.txFromP2PCount.add(count);
+    this.fractionOfTxsRequestedFromP2P.record(count / total);
+  }
+
+  recordTxsRequestDelay(delay: number) {
+    this.txsRequestDelay.record(delay);
+  }
+
+  incMissingTxs(count: number) {
+    this.missingTxsCount.add(count);
+  }
+}

package/src/test-helpers/index.ts

@@ -3,3 +3,6 @@ export * from './get-ports.js';
 export * from './make-enrs.js';
 export * from './make-test-p2p-clients.js';
 export * from './reqresp-nodes.js';
+export * from './mock-pubsub.js';
+export * from './test_tx_provider.js';
+export * from './testbench-utils.js';

package/src/test-helpers/make-enrs.ts

@@ -1,7 +1,7 @@
 import type { ChainConfig } from '@aztec/stdlib/config';
 
-import { SignableENR } from '@chainsafe/enr';
 import { multiaddr } from '@multiformats/multiaddr';
+import { SignableENR } from '@nethermindeth/enr';
 
 import { convertToMultiaddr, createLibP2PPeerIdFromPrivateKey } from '../util.js';
 import { setAztecEnrKey } from '../versioning.js';
@@ -30,10 +30,9 @@ export async function makeEnr(p2pPrivateKey: string, port: number, config: Chain
   const peerId = await createLibP2PPeerIdFromPrivateKey(p2pPrivateKey);
   const enr = SignableENR.createFromPeerId(peerId);
 
-  const udpAnnounceAddress = `127.0.0.1:${port}`;
-  const tcpAnnounceAddress = `127.0.0.1:${port}`;
-  const udpPublicAddr = multiaddr(convertToMultiaddr(udpAnnounceAddress, 'udp'));
-  const tcpPublicAddr = multiaddr(convertToMultiaddr(tcpAnnounceAddress, 'tcp'));
+  const p2pIp = `127.0.0.1`;
+  const udpPublicAddr = multiaddr(convertToMultiaddr(p2pIp, port, 'udp'));
+  const tcpPublicAddr = multiaddr(convertToMultiaddr(p2pIp, port, 'tcp'));
 
   // ENRS must include the network and a discoverable address (udp for discv5)
   setAztecEnrKey(enr, config);