@aztec/p2p 0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2 → 0.75.0

package/dest/services/libp2p/libp2p_service.d.ts

@@ -0,0 +1,225 @@
+import { BlockAttestation, BlockProposal, type ClientProtocolCircuitVerifier, EpochProofQuote, type Gossipable, type L2BlockSource, P2PClientType, type PeerInfo, type WorldStateSynchronizer } from '@aztec/circuit-types';
+import { type EpochCache } from '@aztec/epoch-cache';
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import { type TelemetryClient, WithTracer } from '@aztec/telemetry-client';
+import { type ENR } from '@chainsafe/enr';
+import { type PeerId } from '@libp2p/interface';
+import '@libp2p/kad-dht';
+import { type P2PConfig } from '../../config.js';
+import { type MemPools } from '../../mem_pools/interface.js';
+import { type PubSubLibp2p } from '../../util.js';
+import { ReqRespSubProtocol, type SubProtocolMap } from '../reqresp/interface.js';
+import { ReqResp } from '../reqresp/reqresp.js';
+import type { P2PService, PeerDiscoveryService } from '../service.js';
+/**
+ * Lib P2P implementation of the P2PService interface.
+ */
+export declare class LibP2PService<T extends P2PClientType> extends WithTracer implements P2PService {
+    private clientType;
+    private config;
+    private node;
+    private peerDiscoveryService;
+    private mempools;
+    private l2BlockSource;
+    private proofVerifier;
+    private worldStateSynchronizer;
+    private logger;
+    private jobQueue;
+    private peerManager;
+    private discoveryRunningPromise?;
+    private attestationValidator;
+    private blockProposalValidator;
+    private epochProofQuoteValidator;
+    reqresp: ReqResp;
+    /**
+     * Callback for when a block is received from a peer.
+     * @param block - The block received from the peer.
+     * @returns The attestation for the block, if any.
+     */
+    private blockReceivedCallback;
+    constructor(clientType: T, config: P2PConfig, node: PubSubLibp2p, peerDiscoveryService: PeerDiscoveryService, mempools: MemPools<T>, l2BlockSource: L2BlockSource, epochCache: EpochCache, proofVerifier: ClientProtocolCircuitVerifier, worldStateSynchronizer: WorldStateSynchronizer, telemetry: TelemetryClient, logger?: import("@aztec/foundation/log").Logger);
+    /**
+     * Creates an instance of the LibP2P service.
+     * @param config - The configuration to use when creating the service.
+     * @param txPool - The transaction pool to be accessed by the service.
+     * @returns The new service.
+     */
+    static new<T extends P2PClientType>(clientType: T, config: P2PConfig, peerDiscoveryService: PeerDiscoveryService, peerId: PeerId, mempools: MemPools<T>, l2BlockSource: L2BlockSource, epochCache: EpochCache, proofVerifier: ClientProtocolCircuitVerifier, worldStateSynchronizer: WorldStateSynchronizer, store: AztecAsyncKVStore, telemetry: TelemetryClient): Promise<LibP2PService<T>>;
+    /**
+     * Starts the LibP2P service.
+     * @returns An empty promise.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the LibP2P service.
+     * @returns An empty promise.
+     */
+    stop(): Promise<void>;
+    getPeers(includePending?: boolean): PeerInfo[];
+    private handleGossipSubEvent;
+    /**
+     * Send Request via the ReqResp service
+     * The subprotocol defined will determine the request and response types
+     *
+     * See the subProtocolMap for the mapping of subprotocols to request/response types in `interface.ts`
+     *
+     * @param protocol The request response protocol to use
+     * @param request The request type to send
+     * @returns
+     */
+    sendRequest<SubProtocol extends ReqRespSubProtocol>(protocol: SubProtocol, request: InstanceType<SubProtocolMap[SubProtocol]['request']>): Promise<InstanceType<SubProtocolMap[SubProtocol]['response']> | undefined>;
+    /**
+     * Send a batch of requests to peers, and return the responses
+     * @param protocol - The request response protocol to use
+     * @param requests - The requests to send to the peers
+     * @returns The responses to the requests
+     */
+    sendBatchRequest<SubProtocol extends ReqRespSubProtocol>(protocol: SubProtocol, requests: InstanceType<SubProtocolMap[SubProtocol]['request']>[]): Promise<InstanceType<SubProtocolMap[SubProtocol]['response']>[] | undefined>;
+    /**
+     * Get the ENR of the node
+     * @returns The ENR of the node
+     */
+    getEnr(): ENR | undefined;
+    registerBlockReceivedCallback(callback: (block: BlockProposal) => Promise<BlockAttestation | undefined>): void;
+    /**
+     * Subscribes to a topic.
+     * @param topic - The topic to subscribe to.
+     */
+    private subscribeToTopic;
+    /**
+     * Publishes data to a topic.
+     * @param topic - The topic to publish to.
+     * @param data - The data to publish.
+     * @returns The number of recipients the data was sent to.
+     */
+    private publishToTopic;
+    /**
+     * Handles a new gossip message that was received by the client.
+     * @param topic - The message's topic.
+     * @param data - The message data
+     */
+    private handleNewGossipMessage;
+    /**Process Attestation From Peer
+     * When a proposal is received from a peer, we add it to the attestation pool, so it can be accessed by other services.
+     *
+     * @param attestation - The attestation to process.
+     */
+    private processAttestationFromPeer;
+    /**Process block from peer
+     *
+     * Pass the received block to the validator client
+     *
+     * @param block - The block to process.
+     */
+    private processBlockFromPeer;
+    /**
+     * Broadcast an attestation to all peers.
+     * @param attestation - The attestation to broadcast.
+     */
+    private broadcastAttestation;
+    private processEpochProofQuoteFromPeer;
+    /**
+     * Propagates provided message to peers.
+     * @param message - The message to propagate.
+     */
+    propagate<T extends Gossipable>(message: T): Promise<void>;
+    private processTxFromPeer;
+    /**
+     * Validate a tx that has been requested from a peer.
+     *
+     * The core component of this validator is that the tx hash MUST match the requested tx hash,
+     * In order to perform this check, the tx proof must be verified.
+     *
+     * Note: This function is called from within `ReqResp.sendRequest` as part of the
+     * ReqRespSubProtocol.TX subprotocol validation.
+     *
+     * @param requestedTxHash - The hash of the tx that was requested.
+     * @param responseTx - The tx that was received as a response to the request.
+     * @param peerId - The peer ID of the peer that sent the tx.
+     * @returns True if the tx is valid, false otherwise.
+     */
+    private validateRequestedTx;
+    /**
+     * Validate a tx from a peer.
+     * @param propagationSource - The peer ID of the peer that sent the tx.
+     * @param msg - The tx message.
+     * @returns True if the tx is valid, false otherwise.
+     */
+    private validatePropagatedTxFromMessage;
+    /**
+     * Validate an attestation from a peer.
+     * @param propagationSource - The peer ID of the peer that sent the attestation.
+     * @param msg - The attestation message.
+     * @returns True if the attestation is valid, false otherwise.
+     */
+    private validatePropagatedAttestationFromMessage;
+    /**
+     * Validate a block proposal from a peer.
+     * @param propagationSource - The peer ID of the peer that sent the block.
+     * @param msg - The block proposal message.
+     * @returns True if the block proposal is valid, false otherwise.
+     */
+    private validatePropagatedBlockFromMessage;
+    /**
+     * Validate an epoch proof quote from a peer.
+     * @param propagationSource - The peer ID of the peer that sent the epoch proof quote.
+     * @param msg - The epoch proof quote message.
+     * @returns True if the epoch proof quote is valid, false otherwise.
+     */
+    private validatePropagatedEpochProofQuoteFromMessage;
+    private validatePropagatedTx;
+    /**
+     * Create message validators for the given block number.
+     *
+     * Each validator is a pair of a validator and a severity.
+     * If a validator fails, the peer is penalized with the severity of the validator.
+     *
+     * @param blockNumber - The block number to create validators for.
+     * @returns The message validators.
+     */
+    private createMessageValidators;
+    /**
+     * Run validations on a tx.
+     * @param tx - The tx to validate.
+     * @param messageValidators - The message validators to run.
+     * @returns The validation outcome.
+     */
+    private runValidations;
+    /**
+     * Handle a double spend failure.
+     *
+     * Double spend failures are managed on their own because they are a special case.
+     * We must check if the double spend is recent or old, if it is past a threshold, then we heavily penalize the peer.
+     *
+     * @param tx - The tx that failed the double spend validator.
+     * @param blockNumber - The block number of the tx.
+     * @param peerId - The peer ID of the peer that sent the tx.
+     * @returns True if the tx is valid, false otherwise.
+     */
+    private handleDoubleSpendFailure;
+    /**
+     * Validate an attestation.
+     *
+     * @param attestation - The attestation to validate.
+     * @returns True if the attestation is valid, false otherwise.
+     */
+    validateAttestation(peerId: PeerId, attestation: BlockAttestation): Promise<boolean>;
+    /**
+     * Validate a block proposal.
+     *
+     * @param block - The block proposal to validate.
+     * @returns True if the block proposal is valid, false otherwise.
+     */
+    validateBlockProposal(peerId: PeerId, block: BlockProposal): Promise<boolean>;
+    /**
+     * Validate an epoch proof quote.
+     *
+     * @param epochProofQuote - The epoch proof quote to validate.
+     * @returns True if the epoch proof quote is valid, false otherwise.
+     */
+    validateEpochProofQuote(peerId: PeerId, epochProofQuote: EpochProofQuote): Promise<boolean>;
+    getPeerScore(peerId: PeerId): number;
+    private sendToPeers;
+    private stopLibP2P;
+}
+//# sourceMappingURL=libp2p_service.d.ts.map

package/dest/services/libp2p/libp2p_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"libp2p_service.d.ts","sourceRoot":"","sources":["../../../src/services/libp2p/libp2p_service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,KAAK,6BAA6B,EAClC,eAAe,EACf,KAAK,UAAU,EACf,KAAK,aAAa,EAElB,aAAa,EAEb,KAAK,QAAQ,EAMb,KAAK,sBAAsB,EAG5B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAIrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAkC,KAAK,eAAe,EAAE,UAAU,EAAa,MAAM,yBAAyB,CAAC;AAEtH,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAW1C,OAAO,EAAgB,KAAK,MAAM,EAAwB,MAAM,mBAAmB,CAAC;AAEpF,OAAO,iBAAiB,CAAC;AAKzB,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAS7D,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,eAAe,CAAC;AAKtE,OAAO,EAAmC,kBAAkB,EAAE,KAAK,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGnH,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAkBtE;;GAEG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,aAAa,CAAE,SAAQ,UAAW,YAAW,UAAU;IAqBxF,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,oBAAoB;IAC5B,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IAErB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,sBAAsB;IAE9B,OAAO,CAAC,MAAM;IA9BhB,OAAO,CAAC,QAAQ,CAAkC;IAClD,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,uBAAuB,CAAC,CAAiB;IAGjD,OAAO,CAAC,oBAAoB,CAAuB;IACnD,OAAO,CAAC,sBAAsB,CAAyB;IACvD,OAAO,CAAC,wBAAwB,CAA2B;IAGpD,OAAO,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,OAAO,CAAC,qBAAqB,CAAkE;gBAGrF,UAAU,EAAE,CAAC,EACb,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,YAAY,EAClB,oBAAoB,EAAE,oBAAoB,EAC1C,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EACrB,aAAa,EAAE,aAAa,EACpC,UAAU,EAAE,UAAU,EACd,aAAa,EAAE,6BAA6B,EAC5C,sBAAsB,EAAE,sBAAsB,EACtD,SAAS,EAAE,eAAe,EAClB,MAAM,yCAAqC;IAoCrD;;;;;OAKG;WACiB,GAAG,CAAC,CAAC,SAAS,aAAa,EAC7C,UAAU,EAAE,CAAC,EACb,MAAM,EAAE,SAAS,EACjB,oBAAoB,EAAE,oBAAoB,EAC1C,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EACrB,aAAa,EAAE,aAAa,EAC5B,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,6BAA6B,EAC5C,sBAAsB,EAAE,sBAAsB,EAC9C,KAAK,EAAE,iBAAiB,EACxB,SAAS,EAAE,eAAe;IAsG5B;;;OAGG;IACU,KAAK;IA0ElB;;;OAGG;IACU,IAAI;IAqBV,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,QAAQ,EAAE;IAIrD,OAAO,CAAC,oBAAoB;IAS5B;;;;;;;;;OASG;IACH,WAAW,CAAC,WAAW,SAAS,kBAAkB,EAChD,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,GAC5D,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC;IAI7E;;;;;OAKG;IACH,gBAAgB,CAAC,WAAW,SAAS,kBAAkB,EACrD,QAAQ,EAAE,WAAW,EACrB,QAAQ,EAAE,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,GAC/D,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;IAI/E;;;OAGG;IACI,MAAM,IAAI,GAAG,GAAG,SAAS;IAIzB,6BAA6B,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAK9G;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;;;;OAKG;YACW,cAAc;IAS5B;;;;OAIG;YACW,sBAAsB;IAqBpC;;;;OAIG;YAOW,0BAA0B;IAaxC;;;;;OAKG;YAQW,oBAAoB;IA4BlC;;;OAGG;YAOW,oBAAoB;YAIpB,8BAA8B;IAW5C;;;OAGG;IACU,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,OAAO,EAAE,CAAC;YAQzC,iBAAiB;IAO/B;;;;;;;;;;;;;OAaG;YAIW,mBAAmB;IAoBjC;;;;;OAKG;YACW,+BAA+B;IAa7C;;;;;OAKG;YACW,wCAAwC;IAatD;;;;;OAKG;YACW,kCAAkC;IAahD;;;;;OAKG;YACW,4CAA4C;YAgB5C,oBAAoB;IAuBlC;;;;;;;;OAQG;IACH,OAAO,CAAC,uBAAuB;IA2B/B;;;;;OAKG;YACW,cAAc;IA8B5B;;;;;;;;;;OAUG;YACW,wBAAwB;IAwBtC;;;;;OAKG;IAIU,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAUjG;;;;;OAKG;IAIU,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAU1F;;;;;OAKG;IAIU,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAUjG,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;YAI7B,WAAW;YAWX,UAAU;CAYzB"}