@aztec-labs/p2p 6.0.0-nightly.20260829

package/src/services/dummy_service.ts

@@ -0,0 +1,320 @@
+import type { EthAddress } from '@aztec-labs/foundation/eth-address';
+import type { P2PConnectivity, PeerInfo } from '@aztec-labs/stdlib/interfaces/server';
+import type { Gossipable, PeerErrorSeverity, TopicType } from '@aztec-labs/stdlib/p2p';
+import { Tx, TxHash } from '@aztec-labs/stdlib/tx';
+import type { PeerId } from '@libp2p/interface';
+import type { ENR } from '@nethermindeth/enr';
+import EventEmitter from 'events';
+
+import type { PeerManagerInterface } from './peer-manager/interface.js';
+import type { BatchTxRequesterLibP2PService } from './reqresp/batch-tx-requester/interface.js';
+import type { P2PReqRespConfig } from './reqresp/config.js';
+import type { ConnectionSampler } from './reqresp/connection-sampler/connection_sampler.js';
+import { type AuthRequest, StatusMessage } from './reqresp/index.js';
+import type {
+  ReqRespInterface,
+  ReqRespResponse,
+  ReqRespSubProtocol,
+  ReqRespSubProtocolHandler,
+  ReqRespSubProtocolHandlers,
+  SubProtocolMap,
+} from './reqresp/interface.js';
+import type { GoodByeReason } from './reqresp/protocols/goodbye.js';
+import { ReqRespStatus } from './reqresp/status.js';
+import {
+  type P2PBlockReceivedCallback,
+  type P2PCheckpointAttestationCallback,
+  type P2PCheckpointReceivedCallback,
+  type P2PDuplicateAttestationCallback,
+  type P2PDuplicateProposalCallback,
+  type P2POversizedProposalCallback,
+  type P2PService,
+  type PeerDiscoveryService,
+  PeerDiscoveryState,
+} from './service.js';
+
+/**
+ * A dummy implementation of the P2P Service.
+ */
+export class DummyP2PService implements P2PService {
+  private allNodesCheckpointReceivedCallback?: P2PCheckpointReceivedCallback;
+
+  updateConfig(_config: Partial<P2PReqRespConfig>): void {}
+
+  /** Returns an empty array for peers. */
+  getPeers(): PeerInfo[] {
+    return [];
+  }
+
+  /** Reports p2p as disabled, since this service does not run a p2p stack. */
+  getP2PConnectivity(): P2PConnectivity {
+    return { enabled: false, connectedPeers: 0 };
+  }
+
+  getGossipMeshPeerCount(_topicType: TopicType): number {
+    return 0;
+  }
+
+  /**
+   * Starts the dummy implementation.
+   * @returns A resolved promise.
+   */
+  public start() {
+    return Promise.resolve();
+  }
+
+  /**
+   * Stops the dummy implementation.
+   * @returns A resolved promise.
+   */
+  public stop() {
+    return Promise.resolve();
+  }
+
+  /**
+   * Called to have the given message propagated through the P2P network.
+   * @param _ - The message to be propagated.
+   */
+  public propagate<T extends Gossipable>(_: T) {
+    return Promise.resolve();
+  }
+
+  /**
+   * Called upon receipt of settled transactions.
+   * @param _ - The hashes of the settled transactions.
+   */
+  public settledTxs(_: TxHash[]) {}
+
+  /**
+   * Register a callback into the validator client for when a block proposal is received
+   */
+  public registerBlockReceivedCallback(_callback: P2PBlockReceivedCallback) {}
+
+  /**
+   * Register a callback into the validator client for when a checkpoint proposal is received
+   */
+  public registerValidatorCheckpointReceivedCallback(_callback: P2PCheckpointReceivedCallback) {}
+  public registerAllNodesCheckpointReceivedCallback(callback: P2PCheckpointReceivedCallback) {
+    this.allNodesCheckpointReceivedCallback = callback;
+  }
+
+  /**
+   * Register a callback for when a duplicate proposal is detected
+   */
+  public registerDuplicateProposalCallback(_callback: P2PDuplicateProposalCallback): void {}
+
+  /**
+   * Register a callback for when an oversized proposal is stored
+   */
+  public registerOversizedProposalCallback(_callback: P2POversizedProposalCallback): void {}
+
+  /**
+   * Register a callback for when a duplicate attestation is detected
+   */
+  public registerDuplicateAttestationCallback(_callback: P2PDuplicateAttestationCallback): void {}
+
+  public registerCheckpointAttestationCallback(_callback: P2PCheckpointAttestationCallback): void {}
+
+  /**
+   * Sends a request to a peer.
+   * @param _protocol - The protocol to send the request on.
+   * @param _request - The request to send.
+   * @returns The response from the peer, otherwise undefined.
+   */
+  public sendRequest<Protocol extends ReqRespSubProtocol>(
+    _protocol: Protocol,
+    _request: InstanceType<SubProtocolMap[Protocol]['request']>,
+  ): Promise<InstanceType<SubProtocolMap[Protocol]['response']> | undefined> {
+    return Promise.resolve(undefined);
+  }
+
+  public sendRequestToPeer(
+    _peerId: PeerId,
+    _subProtocol: ReqRespSubProtocol,
+    _payload: Buffer,
+    _dialTimeout?: number,
+  ): Promise<ReqRespResponse> {
+    return Promise.resolve({ status: ReqRespStatus.SUCCESS, data: Buffer.from([]) });
+  }
+
+  /**
+   * Returns the ENR of the peer.
+   * @returns The ENR of the peer, otherwise undefined.
+   */
+  public getEnr(): undefined {
+    return undefined;
+  }
+
+  validateTxsReceivedInBlockProposal(_txs: Tx[]): Promise<void> {
+    return Promise.resolve();
+  }
+
+  addReqRespSubProtocol(_subProtocol: ReqRespSubProtocol, _handler: ReqRespSubProtocolHandler): Promise<void> {
+    return Promise.resolve();
+  }
+
+  handleAuthRequestFromPeer(_authRequest: AuthRequest, _peerId: PeerId): Promise<StatusMessage> {
+    return Promise.resolve(StatusMessage.random());
+  }
+
+  //this is no-op
+  registerThisValidatorAddresses(_address: EthAddress[]): void {}
+
+  /**
+   * Get dummy BatchTxRequesterLibP2PService for testing
+   */
+  getBatchTxRequesterService(): BatchTxRequesterLibP2PService {
+    return {
+      reqResp: this, // The dummy service implements ReqRespInterface
+      connectionSampler: new DummyReqResp().getConnectionSampler(),
+      txValidatorConfig: {
+        l1ChainId: 1,
+        rollupVersion: 1,
+        proofVerifier: {
+          verifyProof: () => Promise.resolve({ valid: true, durationMs: 0, totalDurationMs: 0 }),
+          stop: () => Promise.resolve(),
+        },
+      },
+      peerScoring: {
+        penalizePeer: (_peerId, _penalty) => {},
+      },
+      validateRequestedBlockTxsConsistency: () => Promise.resolve(true),
+    };
+  }
+}
+
+/**
+ * A dummy implementation of the Peer Discovery Service.
+ */
+export class DummyPeerDiscoveryService extends EventEmitter implements PeerDiscoveryService {
+  private currentState = PeerDiscoveryState.STOPPED;
+  public bootstrapNodeEnrs: ENR[] = [];
+
+  /**
+   * Starts the dummy implementation.
+   * @returns A resolved promise.
+   */
+  public start() {
+    this.currentState = PeerDiscoveryState.RUNNING;
+    return Promise.resolve();
+  }
+  /**
+   * Stops the dummy implementation.
+   * @returns A resolved promise.
+   */
+  public stop() {
+    this.currentState = PeerDiscoveryState.STOPPED;
+    return Promise.resolve();
+  }
+  /**
+   * Called to discover peers in the network.
+   * @returns An array of Enrs.
+   */
+  public getKadValues() {
+    return [];
+  }
+
+  public runRandomNodesQuery(): Promise<void> {
+    return Promise.resolve();
+  }
+
+  public isBootstrapPeer(_: PeerId): boolean {
+    return false;
+  }
+
+  public getStatus(): PeerDiscoveryState {
+    return this.currentState;
+  }
+
+  public getEnr(): undefined {
+    return undefined;
+  }
+}
+
+export class DummyPeerManager implements PeerManagerInterface {
+  constructor(
+    public peerId: PeerId,
+    private peersProvider?: { getPeers: () => PeerId[] },
+  ) {}
+
+  public getPeers(_includePending?: boolean): PeerInfo[] {
+    if (!this.peersProvider) {
+      return [];
+    }
+    return this.peersProvider
+      .getPeers()
+      .filter(peer => !peer.equals(this.peerId))
+      .map(id => ({
+        id: id.toString(),
+        status: 'connected',
+        score: 0,
+      }));
+  }
+
+  public initializePeers(): Promise<void> {
+    return Promise.resolve();
+  }
+  public getPeerScore(_peerId: string): number {
+    return 0;
+  }
+
+  public shouldDisableP2PGossip(_peerId: string): boolean {
+    return false;
+  }
+
+  public stop(): Promise<void> {
+    return Promise.resolve();
+  }
+  public heartbeat(): Promise<void> {
+    return Promise.resolve();
+  }
+  public addTrustedPeer(_peerId: PeerId): void {}
+  public addPrivatePeer(_peerId: PeerId): void {}
+  public goodbyeReceived(_peerId: PeerId, _reason: GoodByeReason): void {}
+  public penalizePeer(_peerId: PeerId, _penalty: PeerErrorSeverity): void {}
+  public addPreferredPeer(_peerId: PeerId): void {}
+  public handleAuthRequestFromPeer(_authRequest: AuthRequest, _peerId: PeerId): Promise<StatusMessage> {
+    return Promise.resolve(StatusMessage.random());
+  }
+
+  //this is no-op
+  registerThisValidatorAddresses(_address: EthAddress[]): void {}
+}
+
+export class DummyReqResp implements ReqRespInterface {
+  updateConfig(_config: Partial<P2PReqRespConfig>): void {}
+  setShouldRejectPeer(): void {}
+  start(_subProtocolHandlers: ReqRespSubProtocolHandlers): Promise<void> {
+    return Promise.resolve();
+  }
+  stop(): Promise<void> {
+    return Promise.resolve();
+  }
+  sendRequest<SubProtocol extends ReqRespSubProtocol>(
+    _subProtocol: SubProtocol,
+    _request: InstanceType<SubProtocolMap[SubProtocol]['request']>,
+  ): Promise<InstanceType<SubProtocolMap[SubProtocol]['response']> | undefined> {
+    return Promise.resolve(undefined);
+  }
+  public sendRequestToPeer(
+    _peerId: PeerId,
+    _subProtocol: ReqRespSubProtocol,
+    _payload: Buffer,
+    _dialTimeout?: number,
+  ): Promise<ReqRespResponse> {
+    return Promise.resolve({ status: ReqRespStatus.SUCCESS, data: Buffer.from([]) });
+  }
+
+  /**
+   * Get dummy connection sampler for testing
+   */
+  getConnectionSampler(): Pick<ConnectionSampler, 'getPeerListSortedByConnectionCountAsc'> {
+    return {
+      getPeerListSortedByConnectionCountAsc: () => [],
+    };
+  }
+
+  addSubProtocol(_subProtocol: ReqRespSubProtocol, _handler: ReqRespSubProtocolHandler): Promise<void> {
+    return Promise.resolve();
+  }
+}

package/src/services/encoding.ts

@@ -0,0 +1,170 @@
+// Taken from lodestar: https://github.com/ChainSafe/lodestar
+import { createLogger } from '@aztec-labs/foundation/log';
+import { MAX_TX_SIZE_KB, TopicType, getTopicFromString } from '@aztec-labs/stdlib/p2p';
+import type { DataTransform } from '@chainsafe/libp2p-gossipsub/types';
+import type { Message } from '@libp2p/interface';
+import { webcrypto } from 'node:crypto';
+import { compressSync, uncompressSync } from 'snappy';
+
+/**
+ * Fallback maximum response size (in KB) applied when no explicit per-request bound is supplied.
+ * Used both as the `SnappyTransform` default and as the reception-side fallback in `readMessage`.
+ */
+export const DEFAULT_MAX_RESPONSE_SIZE_KB = 10 * 1024;
+
+/** Thrown when a Snappy-compressed response exceeds the allowed decompressed size. */
+export class OversizedSnappyResponseError extends Error {
+  constructor(decompressedSize: number, maxSizeKb: number) {
+    super(`Decompressed size ${decompressedSize} exceeds maximum allowed size of ${maxSizeKb}kb`);
+    this.name = 'OversizedSnappyResponseError';
+  }
+}
+
+/**
+ * Thrown when the compressed bytes accumulated while reading a response stream exceed the reception
+ * bound, before the full payload is buffered. Distinct from {@link OversizedSnappyResponseError},
+ * which guards the decompressed size after the stream has already been fully received.
+ */
+export class ResponseSizeLimitExceededError extends Error {
+  constructor(accumulatedBytes: number, limitBytes: number) {
+    super(`Accumulated response size ${accumulatedBytes} bytes exceeds reception limit of ${limitBytes} bytes`);
+    this.name = 'ResponseSizeLimitExceededError';
+  }
+}
+
+// Shared buffer to convert msgId to string
+const sharedMsgIdBuf = Buffer.alloc(20);
+
+export function msgIdToStrFn(msgId: Uint8Array): string {
+  // This happens serially, no need to reallocate the buffer
+  sharedMsgIdBuf.set(msgId);
+  return `0x${sharedMsgIdBuf.toString('hex')}`;
+}
+
+/**
+ * Get the message identifier from a libp2p message
+ *
+ * Follows similarly to:
+ * https://github.com/ethereum/consensus-specs/blob/v1.1.0-alpha.7/specs/altair/p2p-interface.md#topics-and-messages
+ *
+ * The topic length is framed into the hash input (`uint32be(topicLen) || topic || data`) so the
+ * `(topic, data)` boundary is unambiguous. A raw `topic || data` concatenation is not injective —
+ * shifting bytes across the boundary (e.g. `(topic + data[0], data[1:])`) yields the same bytes and
+ * thus the same id, letting an unsubscribed-topic message pre-occupy a real message's seenCache slot
+ * and suppress it as a duplicate.
+ *
+ * @param message - The libp2p message
+ * @returns The message identifier
+ */
+export async function getMsgIdFn({ topic, data }: Pick<Message, 'topic' | 'data'>): Promise<Uint8Array> {
+  const topicBytes = Buffer.from(topic);
+  const framedTopicLength = Buffer.allocUnsafe(4);
+  framedTopicLength.writeUInt32BE(topicBytes.length);
+  const buffer = Buffer.concat([framedTopicLength, topicBytes, data]);
+  const hash = await webcrypto.subtle.digest('SHA-256', buffer);
+  return Buffer.from(hash.slice(0, 20));
+}
+
+const DefaultMaxSizesKb: Record<TopicType, number> = {
+  [TopicType.tx]: MAX_TX_SIZE_KB,
+  // An attestation has roughly 30 fields, which is 1kb, so 5x is plenty
+  [TopicType.checkpoint_attestation]: 5,
+  // Proposals may carry some tx objects, so we allow a larger size capped at 10mb
+  // Note this may not be enough for carrying all tx objects in a block
+  [TopicType.block_proposal]: 1024 * 10,
+  // Checkpoint proposals carry almost the same data as a block proposal (see the lastBlockProposal)
+  // Only diff is an additional header, which is pretty small compared to the 10mb limit
+  [TopicType.checkpoint_proposal]: 1024 * 10,
+};
+
+/**
+ * Snappy transform for libp2p gossipsub
+ */
+export class SnappyTransform implements DataTransform {
+  constructor(
+    private maxSizesKb: Record<TopicType, number> = DefaultMaxSizesKb,
+    private defaultMaxSizeKb: number = DEFAULT_MAX_RESPONSE_SIZE_KB,
+    private logger = createLogger('p2p:snappy-transform'),
+  ) {}
+
+  // Topic string included to satisfy DataTransform interface
+  inboundTransform(topicStr: string, data: Uint8Array): Uint8Array {
+    const topic = getTopicFromString(topicStr);
+    return this.inboundTransformData(Buffer.from(data), topic);
+  }
+
+  public inboundTransformData(data: Buffer, topic?: TopicType, maxSizeKbOverride?: number): Buffer {
+    if (data.length === 0) {
+      return data;
+    }
+    const maxSizeKb = maxSizeKbOverride ?? this.maxSizesKb[topic!] ?? this.defaultMaxSizeKb;
+    const { decompressedSize } = readSnappyPreamble(data);
+    if (decompressedSize > maxSizeKb * 1024) {
+      this.logger.warn(`Decompressed size ${decompressedSize} exceeds maximum allowed size of ${maxSizeKb}kb`);
+      throw new OversizedSnappyResponseError(decompressedSize, maxSizeKb);
+    }
+
+    return Buffer.from(uncompressSync(data, { asBuffer: true }));
+  }
+
+  // Topic string included to satisfy DataTransform interface
+  outboundTransform(_topicStr: string, data: Uint8Array): Uint8Array {
+    return this.outboundTransformData(Buffer.from(data));
+  }
+
+  public outboundTransformData(data: Buffer): Buffer {
+    if (data.length === 0) {
+      return data;
+    }
+    return Buffer.from(compressSync(data));
+  }
+}
+
+/**
+ * Reads the Snappy preamble from compressed data and returns the expected decompressed size.
+ *
+ * The Snappy format starts with a little-endian varint encoding the uncompressed length.
+ * Varints consist of a series of bytes where:
+ * - Lower 7 bits contain data
+ * - Upper bit (0x80) is set if more bytes follow
+ *
+ * @param data - The compressed data starting with the Snappy preamble
+ * @returns Object containing the decompressed size and the number of bytes read from the preamble
+ * @throws Error if the data is too short or the varint is invalid
+ */
+export function readSnappyPreamble(data: Uint8Array): { decompressedSize: number; bytesRead: number } {
+  if (data.length === 0) {
+    throw new Error('Cannot read preamble from empty data');
+  }
+
+  let result = 0;
+  let shift = 0;
+  let bytesRead = 0;
+
+  // Maximum varint length for 32-bit value is 5 bytes
+  // (7 bits per byte, so 5 bytes = 35 bits, enough for 2^32 - 1)
+  const maxBytes = 5;
+
+  for (let i = 0; i < Math.min(data.length, maxBytes); i++) {
+    const byte = data[i];
+    bytesRead++;
+
+    // Extract lower 7 bits and add to result with appropriate shift
+    // Use >>> 0 to convert to unsigned 32-bit integer to avoid sign issues
+    result = (result | ((byte & 0x7f) << shift)) >>> 0;
+
+    // If upper bit is not set, we're done
+    if ((byte & 0x80) === 0) {
+      return { decompressedSize: result, bytesRead };
+    }
+
+    shift += 7;
+  }
+
+  // If we get here, either we ran out of data or the varint is too long
+  if (bytesRead >= maxBytes) {
+    throw new Error('Varint is too long (max 5 bytes for 32-bit value)');
+  }
+
+  throw new Error('Incomplete varint: data ended before varint termination');
+}