@aztec/p2p 0.0.0-test.0 → 0.0.1-commit.24de95ac

package/dest/services/reqresp/reqresp.d.ts

@@ -1,12 +1,9 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import { type Logger } from '@aztec/foundation/log';
 import { type TelemetryClient } from '@aztec/telemetry-client';
 import type { PeerId } from '@libp2p/interface';
 import type { Libp2p } from 'libp2p';
 import type { PeerScoring } from '../peer-manager/peer_scoring.js';
-import type { P2PReqRespConfig } from './config.js';
-import { type ReqRespResponse, ReqRespSubProtocol, type ReqRespSubProtocolHandlers, type ReqRespSubProtocolValidators, type SubProtocolMap } from './interface.js';
+import { type P2PReqRespConfig } from './config.js';
+import { type ReqRespInterface, type ReqRespResponse, ReqRespSubProtocol, type ReqRespSubProtocolHandler, type ReqRespSubProtocolHandlers, type ReqRespSubProtocolRateLimits, type ReqRespSubProtocolValidators, type SubProtocolMap } from './interface.js';
 /**
  * The Request Response Service
  *
@@ -21,58 +18,30 @@ import { type ReqRespResponse, ReqRespSubProtocol, type ReqRespSubProtocolHandle
  *
  * see: https://github.com/ethereum/consensus-specs/blob/dev/specs/phase0/p2p-interface.md#the-reqresp-domain
  */
-export declare class ReqResp {
+export declare class ReqResp implements ReqRespInterface {
     private libp2p;
     private peerScoring;
-    protected readonly logger: Logger;
-    private overallRequestTimeoutMs;
+    private logger;
     private individualRequestTimeoutMs;
+    private dialTimeoutMs;
     private subProtocolHandlers;
     private subProtocolValidators;
     private connectionSampler;
     private rateLimiter;
     private snappyTransform;
     private metrics;
-    constructor(config: P2PReqRespConfig, libp2p: Libp2p, peerScoring: PeerScoring, telemetryClient?: TelemetryClient);
+    constructor(config: P2PReqRespConfig, libp2p: Libp2p, peerScoring: PeerScoring, logger?: import("@aztec/foundation/log").Logger, rateLimits?: Partial<ReqRespSubProtocolRateLimits>, telemetryClient?: TelemetryClient);
+    updateConfig(config: Partial<P2PReqRespConfig>): void;
     get tracer(): import("@aztec/telemetry-client").Tracer;
     /**
      * Start the reqresp service
      */
     start(subProtocolHandlers: ReqRespSubProtocolHandlers, subProtocolValidators: ReqRespSubProtocolValidators): Promise<void>;
+    addSubProtocol(subProtocol: ReqRespSubProtocol, handler: ReqRespSubProtocolHandler, validator?: ReqRespSubProtocolValidators[ReqRespSubProtocol]): Promise<void>;
     /**
      * Stop the reqresp service
      */
     stop(): Promise<void>;
-    /**
-     * Send a request to peers, returns the first response
-     *
-     * @param subProtocol - The protocol being requested
-     * @param request - The request to send
-     * @returns - The response from the peer, otherwise undefined
-     *
-     * @description
-     * This method attempts to send a request to all active peers using the specified sub-protocol.
-     * It opens a stream with each peer, sends the request, and awaits a response.
-     * If a valid response is received, it returns the response; otherwise, it continues to the next peer.
-     * If no response is received from any peer, it returns undefined.
-     *
-     * The method performs the following steps:
-     * - Sample a peer to send the request to.
-     * - Opens a stream with the peer using the specified sub-protocol.
-     *
-     * When a response is received, it is validated using the given sub protocols response validator.
-     * To see the interface for the response validator - see `interface.ts`
-     *
-     * Failing a response validation requests in a severe peer penalty, and will
-     * prompt the node to continue to search to the next peer.
-     * For example, a transaction request validator will check that the payload returned does in fact
-     * match the txHash that was requested. A peer that fails this check an only be an extremely naughty peer.
-     *
-     * This entire operation is wrapped in an overall timeout, that is independent of the
-     * peer it is requesting data from.
-     *
-     */
-    sendRequest<SubProtocol extends ReqRespSubProtocol>(subProtocol: SubProtocol, request: InstanceType<SubProtocolMap[SubProtocol]['request']>): Promise<InstanceType<SubProtocolMap[SubProtocol]['response']> | undefined>;
     /**
      * Request multiple messages over the same sub protocol, balancing the requests across peers.
      *
@@ -95,7 +64,7 @@ export declare class ReqResp {
      *
      * @throws {CollectiveReqRespTimeoutError} - If the request batch exceeds the specified timeout (`timeoutMs`).
      */
-    sendBatchRequest<SubProtocol extends ReqRespSubProtocol>(subProtocol: SubProtocol, requests: InstanceType<SubProtocolMap[SubProtocol]['request']>[], timeoutMs?: number, maxPeers?: number, maxRetryAttempts?: number): Promise<InstanceType<SubProtocolMap[SubProtocol]['response']>[]>;
+    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']>[]>;
     /**
      * Sends a request to a specific peer
      *
@@ -106,6 +75,7 @@ export declare class ReqResp {
      * @param peerId - The peer to send the request to
      * @param subProtocol - The protocol to use to request
      * @param payload - The payload to send
+     * @param dialTimeout - If establishing a stream takes longer than this an error will be thrown
      * @returns If the request is successful, the response is returned, otherwise undefined
      *
      * @description
@@ -120,7 +90,7 @@ export declare class ReqResp {
      * If the stream is not closed by the dialled peer, and a timeout occurs, then
      * the stream is closed on the requester's end and sender (us) updates its peer score
      */
-    sendRequestToPeer(peerId: PeerId, subProtocol: ReqRespSubProtocol, payload: Buffer): Promise<ReqRespResponse | undefined>;
+    sendRequestToPeer(peerId: PeerId, subProtocol: ReqRespSubProtocol, payload: Buffer, dialTimeout?: number): Promise<ReqRespResponse>;
     /**
      * Handle a response error
      *
@@ -132,10 +102,6 @@ export declare class ReqResp {
      * @returns If the error is non pubishable, then undefined is returned, otherwise the peer is penalized
      */
     private handleResponseError;
-    /**
-     * Categorize the error and log it.
-     */
-    private categorizeError;
     /**
      * Read a message returned from a stream into a single buffer
      *
@@ -148,7 +114,8 @@ export declare class ReqResp {
      * Stream Handler
      * Reads the incoming stream, determines the protocol, then triggers the appropriate handler
      *
-     * @param param0 - The incoming stream data
+     * @param protocol - The sub protocol to handle
+     * @param incomingStream - The incoming stream data containing the stream and connection
      *
      * @description
      * An individual stream handler will be bound to each sub protocol, and handles returning data back
@@ -161,6 +128,37 @@ export declare class ReqResp {
      * if they exceed their peer specific limits.
      */
     private streamHandler;
-    private sendErrorChunk;
+    /**
+     * Reads incoming data from the stream, processes it according to the sub protocol,
+     * and puts response back into the stream.
+     *
+     * @param protocol - The sub protocol to use for processing the stream
+     * @param incomingStream - The incoming stream data containing the stream and connection
+     *
+     * */
+    private processStream;
+    /**
+     * Try to send error status to the peer. We say try, because the stream,
+     * might already be closed
+     * @param stream - The stream opened between us and the peer
+     * @param status - The error status to send back to the peer
+     * @returns true if error was sent successfully, otherwise false
+     *
+     */
+    private trySendError;
+    private handleRequestError;
+    /**
+     * Categorize the request error and log it.
+     *
+     * @returns Severity of the error, or undefined if the error is not punishable.
+     */
+    private categorizeRequestError;
+    /**
+     * Categorize the response error and log it.
+     *
+     * @returns Severity of the error, or undefined if the error is not punishable.
+     */
+    private categorizeResponseError;
+    private categorizeConnectionErrors;
 }
 //# sourceMappingURL=reqresp.d.ts.map

package/dest/services/reqresp/reqresp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reqresp.d.ts","sourceRoot":"","sources":["../../../src/services/reqresp/reqresp.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAGlE,OAAO,EAAc,KAAK,eAAe,EAAiC,MAAM,yBAAyB,CAAC;AAE1G,OAAO,KAAK,EAAsB,MAAM,EAAU,MAAM,mBAAmB,CAAC;AAE5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AASrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGpD,OAAO,EAGL,KAAK,eAAe,EACpB,kBAAkB,EAClB,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,cAAc,EAEpB,MAAM,gBAAgB,CAAC;AASxB;;;;;;;;;;;;;GAaG;AACH,qBAAa,OAAO;IAmBhB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,WAAW;IAnBrB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAElC,OAAO,CAAC,uBAAuB,CAAS;IACxC,OAAO,CAAC,0BAA0B,CAAS;IAG3C,OAAO,CAAC,mBAAmB,CAA6D;IACxF,OAAO,CAAC,qBAAqB,CAAiE;IAE9F,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,WAAW,CAA6B;IAEhD,OAAO,CAAC,eAAe,CAAkB;IAEzC,OAAO,CAAC,OAAO,CAAiB;gBAG9B,MAAM,EAAE,gBAAgB,EAChB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,WAAW,EAChC,eAAe,GAAE,eAAsC;IAgBzD,IAAI,MAAM,6CAET;IAED;;OAEG;IACG,KAAK,CAAC,mBAAmB,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,4BAA4B;IAiBhH;;OAEG;IACG,IAAI;IAoBV;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,WAAW,CAAC,WAAW,SAAS,kBAAkB,EACtD,WAAW,EAAE,WAAW,EACxB,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;IA8D7E;;;;;;;;;;;;;;;;;;;;;OAqBG;IAQG,gBAAgB,CAAC,WAAW,SAAS,kBAAkB,EAC3D,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAChE,SAAS,SAAQ,EACjB,QAAQ,SAAgC,EACxC,gBAAgB,SAAI,GACnB,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;IA6HnE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAKU,iBAAiB,CAC5B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,kBAAkB,EAC/B,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAgCvC;;;;;;;;;OASG;IACH,OAAO,CAAC,mBAAmB;IAO3B;;OAEG;IACH,OAAO,CAAC,eAAe;IAoDvB;;;;;;OAMG;YACW,WAAW;IAoCzB;;;;;;;;;;;;;;;OAeG;YAKW,aAAa;YAkEZ,cAAc;CAI9B"}
+{"version":3,"file":"reqresp.d.ts","sourceRoot":"","sources":["../../../src/services/reqresp/reqresp.ts"],"names":[],"mappings":"AAMA,OAAO,EAAc,KAAK,eAAe,EAAiC,MAAM,yBAAyB,CAAC;AAE1G,OAAO,KAAK,EAAsB,MAAM,EAAU,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAUrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAEL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,EACjC,KAAK,cAAc,EAEpB,MAAM,gBAAgB,CAAC;AASxB;;;;;;;;;;;;;GAaG;AACH,qBAAa,OAAQ,YAAW,gBAAgB;IAgB5C,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,MAAM;IAjBhB,OAAO,CAAC,0BAA0B,CAAiD;IACnF,OAAO,CAAC,aAAa,CAA2C;IAEhE,OAAO,CAAC,mBAAmB,CAA2C;IACtE,OAAO,CAAC,qBAAqB,CAA6C;IAE1E,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,WAAW,CAA6B;IAEhD,OAAO,CAAC,eAAe,CAAkB;IAEzC,OAAO,CAAC,OAAO,CAAiB;gBAG9B,MAAM,EAAE,gBAAgB,EAChB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,WAAW,EACxB,MAAM,yCAA8B,EAC5C,UAAU,GAAE,OAAO,CAAC,4BAA4B,CAAM,EACtD,eAAe,GAAE,eAAsC;IAkBlD,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,IAAI;IAU5D,IAAI,MAAM,6CAET;IAED;;OAEG;IACG,KAAK,CAAC,mBAAmB,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,4BAA4B;IAkB1G,cAAc,CAClB,WAAW,EAAE,kBAAkB,EAC/B,OAAO,EAAE,yBAAyB,EAClC,SAAS,GAAE,4BAA4B,CAAC,kBAAkB,CAAgD,GACzG,OAAO,CAAC,IAAI,CAAC;IAahB;;OAEG;IACG,IAAI;IAoBV;;;;;;;;;;;;;;;;;;;;;OAqBG;IAQG,gBAAgB,CAAC,WAAW,SAAS,kBAAkB,EAC3D,WAAW,EAAE,WAAW,EACxB,QAAQ,EAAE,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAChE,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,SAAS,SAAQ,EACjB,QAAQ,SAA+C,EACvD,gBAAgB,SAAI,GACnB,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;IAgJnE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAKU,iBAAiB,CAC5B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,kBAAkB,EAC/B,OAAO,EAAE,MAAM,EACf,WAAW,GAAE,MAA2B,GACvC,OAAO,CAAC,eAAe,CAAC;IAsD3B;;;;;;;;;OASG;IACH,OAAO,CAAC,mBAAmB;IAO3B;;;;;;OAMG;YACW,WAAW;IA6CzB;;;;;;;;;;;;;;;;OAgBG;YAKW,aAAa;IAuD3B;;;;;;;SAOK;YACS,aAAa;IAgC3B;;;;;;;OAOG;YACW,YAAY;IAmC1B,OAAO,CAAC,kBAAkB;IAO1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAiB9B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAyB/B,OAAO,CAAC,0BAA0B;CA8DnC"}