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

package/src/test-helpers/make-test-p2p-clients.ts

@@ -1,30 +1,54 @@
 import { MockL2BlockSource } from '@aztec/archiver/test';
 import type { EpochCache } from '@aztec/epoch-cache';
+import { SecretValue } from '@aztec/foundation/config';
 import { type Logger, createLogger } from '@aztec/foundation/log';
-import type { DataStoreConfig } from '@aztec/kv-store/config';
+import { retryUntil } from '@aztec/foundation/retry';
+import { sleep } from '@aztec/foundation/sleep';
 import { openTmpStore } from '@aztec/kv-store/lmdb-v2';
 import type { WorldStateSynchronizer } from '@aztec/stdlib/interfaces/server';
-import { P2PClientType } from '@aztec/stdlib/p2p';
+import type { DataStoreConfig } from '@aztec/stdlib/kv-store';
 
 import { createP2PClient } from '../client/index.js';
 import type { P2PClient } from '../client/p2p_client.js';
 import type { P2PConfig } from '../config.js';
 import type { AttestationPool } from '../mem_pools/attestation_pool/attestation_pool.js';
-import type { TxPool } from '../mem_pools/tx_pool/index.js';
+import type { TxPoolV2 } from '../mem_pools/tx_pool_v2/interfaces.js';
 import { generatePeerIdPrivateKeys } from '../test-helpers/generate-peer-id-private-keys.js';
 import { getPorts } from './get-ports.js';
 import { makeEnrs } from './make-enrs.js';
+import { type MockGossipSubNetwork, getMockPubSubP2PServiceFactory } from './mock-pubsub.js';
 import { AlwaysFalseCircuitVerifier, AlwaysTrueCircuitVerifier } from './reqresp-nodes.js';
 
-interface MakeTestP2PClientOptions {
+export interface MakeTestP2PClientOptions {
   mockAttestationPool: AttestationPool;
-  mockTxPool: TxPool;
+  mockTxPool: TxPoolV2;
   mockEpochCache: EpochCache;
   mockWorldState: WorldStateSynchronizer;
   alwaysTrueVerifier?: boolean;
   p2pBaseConfig: P2PConfig;
   p2pConfigOverrides?: Partial<P2PConfig>;
   logger?: Logger;
+  mockGossipSubNetwork?: MockGossipSubNetwork;
+}
+
+/**
+ * Creates a single P2P client and immediately starts it for testing purposes.
+ * @param peerIdPrivateKey - The private key of the peer.
+ * @param port - The port to run the client on.
+ * @param peers - The peers to connect to.
+ * @param options - The options for the client.
+ * @returns The created and already started client.
+ */
+export async function makeAndStartTestP2PClient(
+  peerIdPrivateKey: string,
+  port: number,
+  peers: string[],
+  options: MakeTestP2PClientOptions,
+) {
+  const client = await makeTestP2PClient(peerIdPrivateKey, port, peers, options);
+
+  await client.start();
+  return client;
 }
 
 /**
@@ -47,22 +71,18 @@ export async function makeTestP2PClient(
     mockTxPool,
     mockEpochCache,
     mockWorldState,
+    mockGossipSubNetwork,
     logger = createLogger('p2p-test-client'),
   }: MakeTestP2PClientOptions,
 ) {
-  const addr = `127.0.0.1:${port}`;
-  const listenAddr = `0.0.0.0:${port}`;
-
   // Filter nodes so that we only dial active peers
-
   const config: P2PConfig & DataStoreConfig = {
     ...p2pBaseConfig,
     p2pEnabled: true,
-    peerIdPrivateKey,
-    tcpListenAddress: listenAddr, // run on port 0
-    udpListenAddress: listenAddr,
-    tcpAnnounceAddress: addr,
-    udpAnnounceAddress: addr,
+    peerIdPrivateKey: new SecretValue(peerIdPrivateKey),
+    p2pIp: `127.0.0.1`,
+    listenAddress: `127.0.0.1`,
+    p2pPort: port,
     bootstrapNodes: peers,
     peerCheckIntervalMS: 1000,
     maxPeerCount: 10,
@@ -75,27 +95,75 @@ export async function makeTestP2PClient(
 
   const proofVerifier = alwaysTrueVerifier ? new AlwaysTrueCircuitVerifier() : new AlwaysFalseCircuitVerifier();
   const kvStore = await openTmpStore('test');
-  const deps = {
-    txPool: mockTxPool as unknown as TxPool,
-    attestationPool: mockAttestationPool as unknown as AttestationPool,
-    store: kvStore,
-    logger,
-  };
+
   const client = await createP2PClient(
-    P2PClientType.Full,
     config,
     l2BlockSource,
     proofVerifier,
     mockWorldState,
     mockEpochCache,
+    'test-p2p-client',
     undefined,
-    deps,
+    undefined,
+    {
+      txPool: mockTxPool as unknown as TxPoolV2,
+      attestationPool: mockAttestationPool as unknown as AttestationPool,
+      store: kvStore,
+      logger,
+      p2pServiceFactory: mockGossipSubNetwork && getMockPubSubP2PServiceFactory(mockGossipSubNetwork),
+    },
   );
-  await client.start();
 
   return client;
 }
 
+/**
+ * Creates a number of P2P clients and immediately starts them for testing purposes.
+ * @param numberOfPeers - The number of clients to create.
+ * @param options - The options for the clients.
+ * @returns The created and started clients.
+ */
+export async function makeAndStartTestP2PClients(numberOfPeers: number, testConfig: MakeTestP2PClientOptions) {
+  const clients: P2PClient[] = [];
+  const peerIdPrivateKeys = generatePeerIdPrivateKeys(numberOfPeers);
+
+  let ports = [];
+  while (true) {
+    try {
+      ports = await getPorts(numberOfPeers);
+      break;
+    } catch {
+      await sleep(1000);
+    }
+  }
+
+  const peerEnrs = await makeEnrs(peerIdPrivateKeys, ports, testConfig.p2pBaseConfig);
+
+  for (let i = 0; i < numberOfPeers; i++) {
+    const client = await makeAndStartTestP2PClient(peerIdPrivateKeys[i], ports[i], peerEnrs, {
+      ...testConfig,
+      logger: createLogger(`p2p:${i}`),
+    });
+    clients.push(client);
+  }
+
+  await retryUntil(() => clients.every(c => c.isReady()), 'p2p clients started', 10, 0.5);
+  testConfig.logger?.info(`Created and started ${clients.length} P2P clients at ports ${ports.join(',')}`, {
+    ports,
+    peerEnrs,
+    peerIdPrivateKeys,
+  });
+
+  return clients.map((client, index) => {
+    return {
+      client,
+      peerPrivateKey: peerIdPrivateKeys[index],
+      port: ports[index],
+      enr: peerEnrs[index],
+    };
+  });
+}
+
 /**
  * Creates a number of P2P clients for testing purposes.
  * @param numberOfPeers - The number of clients to create.
@@ -106,7 +174,16 @@ export async function makeTestP2PClients(numberOfPeers: number, testConfig: Make
   const clients: P2PClient[] = [];
   const peerIdPrivateKeys = generatePeerIdPrivateKeys(numberOfPeers);
 
-  const ports = await getPorts(numberOfPeers);
+  let ports = [];
+  while (true) {
+    try {
+      ports = await getPorts(numberOfPeers);
+      break;
+    } catch {
+      await sleep(1000);
+    }
+  }
+
   const peerEnrs = await makeEnrs(peerIdPrivateKeys, ports, testConfig.p2pBaseConfig);
 
   for (let i = 0; i < numberOfPeers; i++) {
@@ -117,6 +194,17 @@ export async function makeTestP2PClients(numberOfPeers: number, testConfig: Make
     clients.push(client);
   }
 
-  await Promise.all(clients.map(client => client.isReady()));
-  return clients;
+  return clients.map((client, index) => {
+    return {
+      client,
+      peerPrivateKey: peerIdPrivateKeys[index],
+      port: ports[index],
+      enr: peerEnrs[index],
+    };
+  });
+}
+
+export async function startTestP2PClients(clients: P2PClient[]) {
+  await Promise.all(clients.map(c => c.start()));
+  await retryUntil(() => clients.every(c => c.isReady()), 'p2p clients started', 10, 0.5);
 }

package/src/test-helpers/mock-pubsub.ts

@@ -0,0 +1,325 @@
+import type { EpochCacheInterface } from '@aztec/epoch-cache';
+import { type Logger, createLogger } from '@aztec/foundation/log';
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { L2BlockSource } from '@aztec/stdlib/block';
+import type { ContractDataSource } from '@aztec/stdlib/contract';
+import type { ClientProtocolCircuitVerifier, WorldStateSynchronizer } from '@aztec/stdlib/interfaces/server';
+import type { TelemetryClient } from '@aztec/telemetry-client';
+
+import type { GossipsubEvents, GossipsubMessage } from '@chainsafe/libp2p-gossipsub';
+import type { MsgIdStr, PeerIdStr, PublishOpts, TopicStr } from '@chainsafe/libp2p-gossipsub/types';
+import {
+  type Libp2pStatus,
+  type PeerId,
+  type PublishResult,
+  type TopicValidatorResult,
+  TypedEventEmitter,
+} from '@libp2p/interface';
+
+import type { P2PConfig } from '../config.js';
+import type { MemPools } from '../mem_pools/interface.js';
+import { DummyPeerDiscoveryService, DummyPeerManager, LibP2PService } from '../services/index.js';
+import type { P2PReqRespConfig } from '../services/reqresp/config.js';
+import type { ConnectionSampler } from '../services/reqresp/connection-sampler/connection_sampler.js';
+import {
+  type ReqRespInterface,
+  type ReqRespResponse,
+  type ReqRespSubProtocol,
+  type ReqRespSubProtocolHandler,
+  type ReqRespSubProtocolHandlers,
+  type ReqRespSubProtocolValidators,
+  type SubProtocolMap,
+  responseFromBuffer,
+} from '../services/reqresp/interface.js';
+import { ReqRespStatus } from '../services/reqresp/status.js';
+import { GossipSubEvent } from '../types/index.js';
+import type { PubSubLibp2p } from '../util.js';
+
+type GossipSubService = PubSubLibp2p['services']['pubsub'];
+
+/**
+ * Given a mock gossip sub network, returns a factory function that creates an instance LibP2PService connected to it.
+ * Designed to be used in tests in P2PClientDeps.p2pServiceFactory.
+ */
+export function getMockPubSubP2PServiceFactory(
+  network: MockGossipSubNetwork,
+): (...args: Parameters<(typeof LibP2PService)['new']>) => Promise<LibP2PService> {
+  return (
+    config: P2PConfig,
+    peerId: PeerId,
+    deps: {
+      packageVersion: string;
+      mempools: MemPools;
+      l2BlockSource: L2BlockSource & ContractDataSource;
+      epochCache: EpochCacheInterface;
+      proofVerifier: ClientProtocolCircuitVerifier;
+      worldStateSynchronizer: WorldStateSynchronizer;
+      peerStore: AztecAsyncKVStore;
+      telemetry: TelemetryClient;
+      logger: Logger;
+    },
+  ) => {
+    deps.logger.verbose('Creating mock PubSub service');
+    const libp2p = new MockPubSub(peerId, network);
+    const peerManager = new DummyPeerManager(peerId, network);
+    const reqresp: ReqRespInterface = new MockReqResp(peerId, network);
+    const peerDiscoveryService = new DummyPeerDiscoveryService();
+    const service = new LibP2PService(
+      config,
+      libp2p,
+      peerDiscoveryService,
+      reqresp,
+      peerManager,
+      deps.mempools,
+      deps.l2BlockSource,
+      deps.epochCache,
+      deps.proofVerifier,
+      deps.worldStateSynchronizer,
+      deps.telemetry,
+      deps.logger,
+    );
+
+    return Promise.resolve(service);
+  };
+}
+
+/**
+ * Mock implementation of ReqRespInterface that routes requests to other peers' handlers through the mock network.
+ * When a peer calls sendBatchRequest, the mock iterates over network peers and invokes their registered handler
+ * for the sub-protocol, simulating the request-response protocol without actual libp2p streams.
+ */
+class MockReqResp implements ReqRespInterface {
+  private handlers: Partial<ReqRespSubProtocolHandlers> = {};
+  private logger = createLogger('p2p:test:mock-reqresp');
+
+  constructor(
+    private peerId: PeerId,
+    private network: MockGossipSubNetwork,
+  ) {
+    network.registerReqRespPeer(this);
+  }
+
+  updateConfig(_config: Partial<P2PReqRespConfig>): void {}
+
+  start(
+    subProtocolHandlers: Partial<ReqRespSubProtocolHandlers>,
+    _subProtocolValidators: ReqRespSubProtocolValidators,
+  ): Promise<void> {
+    Object.assign(this.handlers, subProtocolHandlers);
+    return Promise.resolve();
+  }
+
+  addSubProtocol(
+    subProtocol: ReqRespSubProtocol,
+    handler: ReqRespSubProtocolHandler,
+    _validator?: ReqRespSubProtocolValidators[ReqRespSubProtocol],
+  ): Promise<void> {
+    this.handlers[subProtocol] = handler;
+    return Promise.resolve();
+  }
+
+  stop(): Promise<void> {
+    this.handlers = {};
+    return Promise.resolve();
+  }
+
+  getHandler(subProtocol: ReqRespSubProtocol): ReqRespSubProtocolHandler | undefined {
+    return this.handlers[subProtocol];
+  }
+
+  async sendBatchRequest<SubProtocol extends ReqRespSubProtocol>(
+    subProtocol: SubProtocol,
+    requests: InstanceType<SubProtocolMap[SubProtocol]['request']>[],
+    pinnedPeer: PeerId | undefined,
+    _timeoutMs?: number,
+    _maxPeers?: number,
+    _maxRetryAttempts?: number,
+  ): Promise<InstanceType<SubProtocolMap[SubProtocol]['response']>[]> {
+    const responses: InstanceType<SubProtocolMap[SubProtocol]['response']>[] = [];
+    const peers = this.network.getReqRespPeers().filter(p => !p.peerId.equals(this.peerId));
+    const targetPeers = pinnedPeer ? peers.filter(p => p.peerId.equals(pinnedPeer)) : peers;
+
+    for (const request of requests) {
+      const requestBuffer = request.toBuffer();
+      for (const peer of targetPeers) {
+        const handler = peer.getHandler(subProtocol);
+        if (!handler) {
+          continue;
+        }
+        try {
+          const responseBuffer = await handler(this.peerId, requestBuffer);
+          if (responseBuffer.length > 0) {
+            const response = responseFromBuffer(subProtocol, responseBuffer);
+            responses.push(response as InstanceType<SubProtocolMap[SubProtocol]['response']>);
+            break;
+          }
+        } catch (err) {
+          this.logger.debug(`Mock reqresp handler error from peer ${peer.peerId}`, { err });
+        }
+      }
+    }
+
+    return responses;
+  }
+
+  async sendRequestToPeer(
+    peerId: PeerId,
+    subProtocol: ReqRespSubProtocol,
+    payload: Buffer,
+    _dialTimeout?: number,
+  ): Promise<ReqRespResponse> {
+    const peer = this.network.getReqRespPeers().find(p => p.peerId.equals(peerId));
+    const handler = peer?.getHandler(subProtocol);
+    if (!handler) {
+      return { status: ReqRespStatus.SUCCESS, data: Buffer.from([]) };
+    }
+    try {
+      const data = await handler(this.peerId, payload);
+      return { status: ReqRespStatus.SUCCESS, data };
+    } catch {
+      return { status: ReqRespStatus.FAILURE };
+    }
+  }
+
+  getConnectionSampler(): Pick<ConnectionSampler, 'getPeerListSortedByConnectionCountAsc'> {
+    return {
+      getPeerListSortedByConnectionCountAsc: () =>
+        this.network
+          .getReqRespPeers()
+          .filter(p => !p.peerId.equals(this.peerId))
+          .map(p => p.peerId),
+    };
+  }
+}
+
+/**
+ * Implementation of PubSub services that relies on a mock gossip sub network.
+ * This is used in tests to simulate a gossip sub network without needing a real P2P network.
+ * All messages are sent to the mock network which then distributes them to subscribed peers.
+ */
+export class MockPubSub implements PubSubLibp2p {
+  public status: Libp2pStatus = 'stopped';
+
+  private gossipSub: GossipSubService;
+
+  constructor(
+    public peerId: PeerId,
+    network: MockGossipSubNetwork,
+  ) {
+    this.gossipSub = new MockGossipSubService(peerId, network);
+  }
+
+  get services() {
+    return {
+      pubsub: this.gossipSub,
+    };
+  }
+
+  start(): void | Promise<void> {
+    this.status = 'started';
+    return Promise.resolve();
+  }
+  stop(): void | Promise<void> {
+    this.status = 'stopped';
+    return Promise.resolve();
+  }
+}
+
+class MockGossipSubService extends TypedEventEmitter<GossipsubEvents> implements GossipSubService {
+  private logger = createLogger('p2p:test:mock-gossipsub');
+  public subscribedTopics: Set<TopicStr> = new Set();
+  public readonly direct = new Set<string>();
+
+  constructor(
+    public peerId: PeerId,
+    private network: MockGossipSubNetwork,
+  ) {
+    super();
+    network.registerPeer(this);
+  }
+
+  score = {
+    score: (_peerId: PeerIdStr) => 0,
+  };
+
+  publish(topic: TopicStr, data: Uint8Array, _opts?: PublishOpts): Promise<PublishResult> {
+    this.logger.debug(`Publishing message on topic ${topic}`, { topic, sender: this.peerId.toString() });
+    this.network.publishToPeers(topic, data, this.peerId);
+    return Promise.resolve({ recipients: this.network.getPeers().filter(peer => !this.peerId.equals(peer)) });
+  }
+
+  receive(msg: GossipsubMessage) {
+    if (msg.propagationSource.equals(this.peerId)) {
+      return; // Ignore messages from self
+    }
+    this.logger.debug(`Received message on topic ${msg.msg.topic}`, { ...msg });
+    this.safeDispatchEvent<GossipsubMessage>(GossipSubEvent.MESSAGE, { detail: msg });
+  }
+
+  subscribe(topic: TopicStr): void {
+    this.logger.debug(`Subscribed to topic ${topic}`, { topic });
+    this.subscribedTopics.add(topic);
+  }
+
+  reportMessageValidationResult(msgId: MsgIdStr, propagationSource: PeerIdStr, acceptance: TopicValidatorResult): void {
+    this.logger.debug(
+      `Reported message validation result ${acceptance} for msgId ${msgId} from source ${propagationSource}`,
+      { msgId, propagationSource, acceptance },
+    );
+  }
+
+  getMeshPeers(topic?: TopicStr): PeerIdStr[] {
+    if (topic && !this.subscribedTopics.has(topic)) {
+      return [];
+    }
+    return this.network
+      .getPeers()
+      .filter(peer => !this.peerId.equals(peer))
+      .map(peer => peer.toString());
+  }
+}
+
+/**
+ * Mock gossip sub network used for testing.
+ * All instances of MockGossipSubService connected to the same network will instantly receive the same messages.
+ */
+export class MockGossipSubNetwork {
+  private peers: MockGossipSubService[] = [];
+  private reqRespPeers: MockReqResp[] = [];
+  private nextMsgId = 0;
+
+  private logger = createLogger('p2p:test:mock-gossipsub-network');
+
+  public getPeers(): PeerId[] {
+    return this.peers.map(peer => peer.peerId);
+  }
+
+  public registerPeer(peer: MockGossipSubService): void {
+    this.peers.push(peer);
+  }
+
+  public registerReqRespPeer(peer: MockReqResp): void {
+    this.reqRespPeers.push(peer);
+  }
+
+  public getReqRespPeers(): MockReqResp[] {
+    return this.reqRespPeers;
+  }
+
+  public publishToPeers(topic: TopicStr, data: Uint8Array, sender: PeerId): void {
+    const msgId = (this.nextMsgId++).toString();
+    this.logger.debug(`Network is distributing message on topic ${topic}`, {
+      topic,
+      size: data.length,
+      sender: sender.toString(),
+      msgId,
+    });
+
+    const gossipSubMsg: GossipsubMessage = { msgId, msg: { type: 'unsigned', topic, data }, propagationSource: sender };
+    for (const peer of this.peers) {
+      if (peer.subscribedTopics.has(topic)) {
+        peer.receive(gossipSubMsg);
+      }
+    }
+  }
+}

package/src/test-helpers/mock-tx-helpers.ts

@@ -0,0 +1,24 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vk-tree';
+import { protocolContractsHash } from '@aztec/protocol-contracts';
+import { mockTx } from '@aztec/stdlib/testing';
+import { Tx } from '@aztec/stdlib/tx';
+
+import type { P2PConfig } from '../config.js';
+
+/**
+ * Helper function to create mock transactions with the correct metadata values
+ * that will pass validation when sent over the p2p network.
+ *
+ * @param config - The P2P configuration containing chainId and rollupVersion
+ * @param seed - Optional seed for the mock transaction
+ * @returns A mock transaction with valid metadata for p2p network transmission
+ */
+export const createMockTxWithMetadata = (config: P2PConfig, seed?: number): Promise<Tx> => {
+  return mockTx(seed, {
+    chainId: new Fr(config.l1ChainId),
+    version: new Fr(config.rollupVersion),
+    vkTreeRoot: getVKTreeRoot(),
+    protocolContractsHash,
+  });
+};