libp2p 0.43.4 → 0.44.0

package/dist/src/connection-manager/connection-pruner.js

@@ -0,0 +1,96 @@
+import { logger } from '@libp2p/logger';
+import { PeerMap } from '@libp2p/peer-collections';
+import { MAX_CONNECTIONS } from './constants.js';
+import { CustomEvent } from '@libp2p/interfaces/events';
+const log = logger('libp2p:connection-manager:connection-pruner');
+const defaultOptions = {
+    maxConnections: MAX_CONNECTIONS,
+    allow: []
+};
+/**
+ * If we go over the max connections limit, choose some connections to close
+ */
+export class ConnectionPruner {
+    constructor(components, init = {}) {
+        this.maxConnections = init.maxConnections ?? defaultOptions.maxConnections;
+        this.allow = init.allow ?? defaultOptions.allow;
+        this.connectionManager = components.connectionManager;
+        this.peerStore = components.peerStore;
+    }
+    /**
+     * If we have more connections than our maximum, select some excess connections
+     * to prune based on peer value
+     */
+    async maybePruneConnections() {
+        const connections = this.connectionManager.getConnections();
+        const numConnections = connections.length;
+        const toPrune = Math.max(numConnections - this.maxConnections, 0);
+        log.trace('checking max connections limit %d/%d', numConnections, this.maxConnections);
+        if (numConnections <= this.maxConnections) {
+            return;
+        }
+        log('max connections limit exceeded %d/%d, pruning %d connection(s)', numConnections, this.maxConnections, toPrune);
+        const peerValues = new PeerMap();
+        // work out peer values
+        for (const connection of connections) {
+            const remotePeer = connection.remotePeer;
+            if (peerValues.has(remotePeer)) {
+                continue;
+            }
+            const tags = await this.peerStore.getTags(remotePeer);
+            // sum all tag values
+            peerValues.set(remotePeer, tags.reduce((acc, curr) => {
+                return acc + curr.value;
+            }, 0));
+        }
+        // sort by value, lowest to highest
+        const sortedConnections = connections.sort((a, b) => {
+            const peerAValue = peerValues.get(a.remotePeer) ?? 0;
+            const peerBValue = peerValues.get(b.remotePeer) ?? 0;
+            if (peerAValue > peerBValue) {
+                return 1;
+            }
+            if (peerAValue < peerBValue) {
+                return -1;
+            }
+            // if the peers have an equal tag value then we want to close short-lived connections first
+            const connectionALifespan = a.stat.timeline.open;
+            const connectionBLifespan = b.stat.timeline.open;
+            if (connectionALifespan < connectionBLifespan) {
+                return 1;
+            }
+            if (connectionALifespan > connectionBLifespan) {
+                return -1;
+            }
+            return 0;
+        });
+        // close some connections
+        const toClose = [];
+        for (const connection of sortedConnections) {
+            log('too many connections open - closing a connection to %p', connection.remotePeer);
+            // check allow list
+            const connectionInAllowList = this.allow.some((ma) => {
+                return connection.remoteAddr.toString().startsWith(ma.toString());
+            });
+            // Connections in the allow list should be excluded from pruning
+            if (!connectionInAllowList) {
+                toClose.push(connection);
+            }
+            if (toClose.length === toPrune) {
+                break;
+            }
+        }
+        // close connections
+        await Promise.all(toClose.map(async (connection) => {
+            try {
+                await connection.close();
+            }
+            catch (err) {
+                log.error(err);
+            }
+        }));
+        // despatch prune event
+        this.connectionManager.dispatchEvent(new CustomEvent('peer:prune', { detail: toClose.map(conn => conn.remotePeer) }));
+    }
+}
+//# sourceMappingURL=connection-pruner.js.map

package/dist/src/connection-manager/connection-pruner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection-pruner.js","sourceRoot":"","sources":["../../../src/connection-manager/connection-pruner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAGvC,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAElD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAEvD,MAAM,GAAG,GAAG,MAAM,CAAC,6CAA6C,CAAC,CAAA;AAYjE,MAAM,cAAc,GAAG;IACrB,cAAc,EAAE,eAAe;IAC/B,KAAK,EAAE,EAAE;CACV,CAAA;AAED;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAM3B,YAAa,UAAsC,EAAE,OAA6B,EAAE;QAClF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,cAAc,CAAA;QAC1E,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,cAAc,CAAC,KAAK,CAAA;QAC/C,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAA;QACrD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;IACvC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAA;QAC3D,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,CAAA;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAA;QAEjE,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;QACtF,IAAI,cAAc,IAAI,IAAI,CAAC,cAAc,EAAE;YACzC,OAAM;SACP;QAED,GAAG,CAAC,gEAAgE,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;QACnH,MAAM,UAAU,GAAG,IAAI,OAAO,EAAU,CAAA;QAExC,uBAAuB;QACvB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAA;YAExC,IAAI,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBAC9B,SAAQ;aACT;YAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;YAErD,qBAAqB;YACrB,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBACnD,OAAO,GAAG,GAAG,IAAI,CAAC,KAAK,CAAA;YACzB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;SACP;QAED,mCAAmC;QACnC,MAAM,iBAAiB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAClD,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YACpD,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YAEpD,IAAI,UAAU,GAAG,UAAU,EAAE;gBAC3B,OAAO,CAAC,CAAA;aACT;YAED,IAAI,UAAU,GAAG,UAAU,EAAE;gBAC3B,OAAO,CAAC,CAAC,CAAA;aACV;YAED,2FAA2F;YAC3F,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAA;YAChD,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAA;YAEhD,IAAI,mBAAmB,GAAG,mBAAmB,EAAE;gBAC7C,OAAO,CAAC,CAAA;aACT;YAED,IAAI,mBAAmB,GAAG,mBAAmB,EAAE;gBAC7C,OAAO,CAAC,CAAC,CAAA;aACV;YAED,OAAO,CAAC,CAAA;QACV,CAAC,CAAC,CAAA;QAEF,yBAAyB;QACzB,MAAM,OAAO,GAAG,EAAE,CAAA;QAElB,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE;YAC1C,GAAG,CAAC,wDAAwD,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YACpF,mBAAmB;YACnB,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;gBACnD,OAAO,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;YACnE,CAAC,CAAC,CAAA;YAEF,gEAAgE;YAChE,IAAI,CAAC,qBAAqB,EAAE;gBAC1B,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;aACzB;YAED,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE;gBAC9B,MAAK;aACN;SACF;QAED,oBAAoB;QACpB,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,KAAK,EAAC,UAAU,EAAC,EAAE;YAC7B,IAAI;gBACF,MAAM,UAAU,CAAC,KAAK,EAAE,CAAA;aACzB;YAAC,OAAO,GAAG,EAAE;gBACZ,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;aACf;QACH,CAAC,CAAC,CACH,CAAA;QAED,uBAAuB;QACvB,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA;IACvH,CAAC;CACF"}

package/dist/src/connection-manager/constants.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#dialTimeout
+ */
+export declare const DIAL_TIMEOUT = 30000;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#inboundUpgradeTimeout
+ */
+export declare const INBOUND_UPGRADE_TIMEOUT = 30000;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxParallelDials
+ */
+export declare const MAX_PARALLEL_DIALS = 100;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxPeerAddrsToDial
+ */
+export declare const MAX_PEER_ADDRS_TO_DIAL = 25;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxParallelDialsPerPeer
+ */
+export declare const MAX_PARALLEL_DIALS_PER_PEER = 10;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#minConnections
+ */
+export declare const MIN_CONNECTIONS = 50;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxConnections
+ */
+export declare const MAX_CONNECTIONS = 300;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#autoDialInterval
+ */
+export declare const AUTO_DIAL_INTERVAL = 5000;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#autoDialConcurrency
+ */
+export declare const AUTO_DIAL_CONCURRENCY = 25;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#autoDialPriority
+ */
+export declare const AUTO_DIAL_PRIORITY = 0;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#inboundConnectionThreshold
+ */
+export declare const INBOUND_CONNECTION_THRESHOLD = 5;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxIncomingPendingConnections
+ */
+export declare const MAX_INCOMING_PENDING_CONNECTIONS = 10;
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/connection-manager/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/connection-manager/constants.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,eAAO,MAAM,YAAY,QAAO,CAAA;AAEhC;;GAEG;AACH,eAAO,MAAM,uBAAuB,QAAO,CAAA;AAE3C;;GAEG;AACH,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAErC;;GAEG;AACH,eAAO,MAAM,sBAAsB,KAAK,CAAA;AAExC;;GAEG;AACH,eAAO,MAAM,2BAA2B,KAAK,CAAA;AAE7C;;GAEG;AACH,eAAO,MAAM,eAAe,KAAK,CAAA;AAEjC;;GAEG;AACH,eAAO,MAAM,eAAe,MAAM,CAAA;AAElC;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAA;AAEtC;;GAEG;AACH,eAAO,MAAM,qBAAqB,KAAK,CAAA;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAA;AAEnC;;GAEG;AACH,eAAO,MAAM,4BAA4B,IAAI,CAAA;AAE7C;;GAEG;AACH,eAAO,MAAM,gCAAgC,KAAK,CAAA"}

package/dist/src/connection-manager/constants.js

@@ -0,0 +1,49 @@
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#dialTimeout
+ */
+export const DIAL_TIMEOUT = 30e3;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#inboundUpgradeTimeout
+ */
+export const INBOUND_UPGRADE_TIMEOUT = 30e3;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxParallelDials
+ */
+export const MAX_PARALLEL_DIALS = 100;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxPeerAddrsToDial
+ */
+export const MAX_PEER_ADDRS_TO_DIAL = 25;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxParallelDialsPerPeer
+ */
+export const MAX_PARALLEL_DIALS_PER_PEER = 10;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#minConnections
+ */
+export const MIN_CONNECTIONS = 50;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxConnections
+ */
+export const MAX_CONNECTIONS = 300;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#autoDialInterval
+ */
+export const AUTO_DIAL_INTERVAL = 5000;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#autoDialConcurrency
+ */
+export const AUTO_DIAL_CONCURRENCY = 25;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#autoDialPriority
+ */
+export const AUTO_DIAL_PRIORITY = 0;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#inboundConnectionThreshold
+ */
+export const INBOUND_CONNECTION_THRESHOLD = 5;
+/**
+ * @see https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html#maxIncomingPendingConnections
+ */
+export const MAX_INCOMING_PENDING_CONNECTIONS = 10;
+//# sourceMappingURL=constants.js.map

package/dist/src/connection-manager/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/connection-manager/constants.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAA;AAEhC;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAA;AAE3C;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAA;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,EAAE,CAAA;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAA;AAEjC;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAA;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAA;AAEtC;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAA;AAEvC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAA;AAEnC;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAA;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,CAAA"}

package/dist/src/connection-manager/dial-queue.d.ts

@@ -0,0 +1,77 @@
+import { Multiaddr, Resolver } from '@multiformats/multiaddr';
+import type { Connection } from '@libp2p/interface-connection';
+import type { AbortOptions } from '@libp2p/interfaces';
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { AddressSorter, PeerStore } from '@libp2p/interface-peer-store';
+import type { Metrics } from '@libp2p/interface-metrics';
+import type { TransportManager } from '@libp2p/interface-transport';
+import type { ConnectionGater } from '@libp2p/interface-connection-gater';
+import PQueue from 'p-queue';
+export type PendingDialStatus = 'queued' | 'active' | 'error' | 'success';
+export interface PendingDial {
+    id: string;
+    status: PendingDialStatus;
+    peerId?: PeerId;
+    multiaddrs: Multiaddr[];
+    promise: Promise<Connection>;
+}
+export interface PendingDialTarget {
+    resolve: (value: any) => void;
+    reject: (err: Error) => void;
+}
+export interface DialOptions extends AbortOptions {
+    priority?: number;
+}
+interface DialerInit {
+    addressSorter?: AddressSorter;
+    maxParallelDials?: number;
+    maxPeerAddrsToDial?: number;
+    maxParallelDialsPerPeer?: number;
+    dialTimeout?: number;
+    resolvers?: Record<string, Resolver>;
+}
+interface DialQueueComponents {
+    peerId: PeerId;
+    metrics?: Metrics;
+    peerStore: PeerStore;
+    transportManager: TransportManager;
+    connectionGater: ConnectionGater;
+}
+export declare class DialQueue {
+    pendingDials: PendingDial[];
+    queue: PQueue;
+    private readonly peerId;
+    private readonly peerStore;
+    private readonly connectionGater;
+    private readonly transportManager;
+    private readonly addressSorter;
+    private readonly maxPeerAddrsToDial;
+    private readonly maxParallelDialsPerPeer;
+    private readonly dialTimeout;
+    private readonly inProgressDialCount?;
+    private readonly pendingDialCount?;
+    private readonly shutDownController;
+    constructor(components: DialQueueComponents, init?: DialerInit);
+    /**
+     * Clears any pending dials
+     */
+    stop(): void;
+    /**
+     * Connects to a given peer, multiaddr or list of multiaddrs.
+     *
+     * If a peer is passed, all known multiaddrs will be tried. If a multiaddr or
+     * multiaddrs are passed only those will be dialled.
+     *
+     * Where a list of multiaddrs is passed, if any contain a peer id then all
+     * multiaddrs in the list must contain the same peer id.
+     *
+     * The dial to the first address that is successfully able to upgrade a connection
+     * will be used, all other dials will be aborted when that happens.
+     */
+    dial(peerIdOrMultiaddr: PeerId | Multiaddr | Multiaddr[], options?: DialOptions): Promise<Connection>;
+    private createDialAbortControllers;
+    private calculateMultiaddrs;
+    private performDial;
+}
+export {};
+//# sourceMappingURL=dial-queue.d.ts.map

package/dist/src/connection-manager/dial-queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dial-queue.d.ts","sourceRoot":"","sources":["../../../src/connection-manager/dial-queue.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAa,MAAM,yBAAyB,CAAA;AAUxE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAEvD,OAAO,KAAK,EAAW,aAAa,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,KAAK,EAAU,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AACzE,OAAO,MAAM,MAAM,SAAS,CAAA;AAQ5B,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAA;AAEzE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,iBAAiB,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAA;IAC7B,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAA;CAC7B;AAED,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,UAAU,UAAU;IAClB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;CACrC;AAaD,UAAU,mBAAmB;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,SAAS,CAAA;IACpB,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,eAAe,EAAE,eAAe,CAAA;CACjC;AAED,qBAAa,SAAS;IACb,YAAY,EAAE,WAAW,EAAE,CAAA;IAC3B,KAAK,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAQ;IAC3C,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAQ;IAChD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAQ;IAC7C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAiB;gBAEvC,UAAU,EAAE,mBAAmB,EAAE,IAAI,GAAE,UAAe;IA0DnE;;OAEG;IACH,IAAI,IAAK,IAAI;IAIb;;;;;;;;;;;OAWG;IACG,IAAI,CAAE,iBAAiB,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAuFhH,OAAO,CAAC,0BAA0B;YAcpB,mBAAmB;YA4GnB,WAAW;CAwH1B"}

package/dist/src/connection-manager/dial-queue.js

@@ -0,0 +1,366 @@
+import { logger } from '@libp2p/logger';
+import { AbortError, CodeError } from '@libp2p/interfaces/errors';
+import { resolvers } from '@multiformats/multiaddr';
+import { TimeoutController } from 'timeout-abort-controller';
+import { publicAddressesFirst } from '@libp2p/utils/address-sort';
+import { codes } from '../errors.js';
+import { DIAL_TIMEOUT, MAX_PARALLEL_DIALS_PER_PEER, MAX_PARALLEL_DIALS, MAX_PEER_ADDRS_TO_DIAL } from './constants.js';
+import { getPeerAddress } from '../get-peer.js';
+import PQueue from 'p-queue';
+import { dnsaddrResolver } from '@multiformats/multiaddr/resolvers';
+import { combineSignals, resolveMultiaddrs } from './utils.js';
+import pDefer from 'p-defer';
+const log = logger('libp2p:connection-manager:dial-queue');
+const defaultOptions = {
+    addressSorter: publicAddressesFirst,
+    maxParallelDials: MAX_PARALLEL_DIALS,
+    maxPeerAddrsToDial: MAX_PEER_ADDRS_TO_DIAL,
+    maxParallelDialsPerPeer: MAX_PARALLEL_DIALS_PER_PEER,
+    dialTimeout: DIAL_TIMEOUT,
+    resolvers: {
+        dnsaddr: dnsaddrResolver
+    }
+};
+export class DialQueue {
+    constructor(components, init = {}) {
+        this.addressSorter = init.addressSorter ?? defaultOptions.addressSorter;
+        this.maxPeerAddrsToDial = init.maxPeerAddrsToDial ?? defaultOptions.maxPeerAddrsToDial;
+        this.maxParallelDialsPerPeer = init.maxParallelDialsPerPeer ?? defaultOptions.maxParallelDialsPerPeer;
+        this.dialTimeout = init.dialTimeout ?? defaultOptions.dialTimeout;
+        this.peerId = components.peerId;
+        this.peerStore = components.peerStore;
+        this.connectionGater = components.connectionGater;
+        this.transportManager = components.transportManager;
+        this.shutDownController = new AbortController();
+        this.pendingDialCount = components.metrics?.registerMetric('libp2p_dialler_pending_dials');
+        this.inProgressDialCount = components.metrics?.registerMetric('libp2p_dialler_in_progress_dials');
+        this.pendingDials = [];
+        for (const [key, value] of Object.entries(init.resolvers ?? {})) {
+            resolvers.set(key, value);
+        }
+        // controls dial concurrency
+        this.queue = new PQueue({
+            concurrency: init.maxParallelDials ?? defaultOptions.maxParallelDials
+        });
+        // a job was added to the queue
+        this.queue.on('add', () => {
+            this.pendingDialCount?.update(this.queue.size);
+            this.inProgressDialCount?.update(this.queue.pending);
+        });
+        // a queued job started
+        this.queue.on('active', () => {
+            this.pendingDialCount?.update(this.queue.size);
+            this.inProgressDialCount?.update(this.queue.pending);
+        });
+        // a started job completed without error
+        this.queue.on('completed', () => {
+            this.pendingDialCount?.update(this.queue.size);
+            this.inProgressDialCount?.update(this.queue.pending);
+        });
+        // a started job errored
+        this.queue.on('error', (err) => {
+            log.error('error in dial queue', err);
+            this.pendingDialCount?.update(this.queue.size);
+            this.inProgressDialCount?.update(this.queue.pending);
+        });
+        // all queued jobs have been started
+        this.queue.on('empty', () => {
+            this.pendingDialCount?.update(this.queue.size);
+            this.inProgressDialCount?.update(this.queue.pending);
+        });
+        // add started jobs have run and the queue is empty
+        this.queue.on('idle', () => {
+            this.pendingDialCount?.update(this.queue.size);
+            this.inProgressDialCount?.update(this.queue.pending);
+        });
+    }
+    /**
+     * Clears any pending dials
+     */
+    stop() {
+        this.shutDownController.abort();
+    }
+    /**
+     * Connects to a given peer, multiaddr or list of multiaddrs.
+     *
+     * If a peer is passed, all known multiaddrs will be tried. If a multiaddr or
+     * multiaddrs are passed only those will be dialled.
+     *
+     * Where a list of multiaddrs is passed, if any contain a peer id then all
+     * multiaddrs in the list must contain the same peer id.
+     *
+     * The dial to the first address that is successfully able to upgrade a connection
+     * will be used, all other dials will be aborted when that happens.
+     */
+    async dial(peerIdOrMultiaddr, options = {}) {
+        const { peerId, multiaddrs } = getPeerAddress(peerIdOrMultiaddr);
+        const addrs = multiaddrs.map(multiaddr => ({
+            multiaddr,
+            isCertified: false
+        }));
+        // create abort conditions - need to do this before `calculateMultiaddrs` as we may be about to
+        // resolve a dns addr which can time out
+        const { timeoutController, signal } = this.createDialAbortControllers(options.signal);
+        let addrsToDial;
+        try {
+            // load addresses from address book, resolve and dnsaddrs, filter undiallables, add peer IDs, etc
+            addrsToDial = await this.calculateMultiaddrs(peerId, addrs, {
+                ...options,
+                signal
+            });
+        }
+        catch (err) {
+            signal.clear();
+            timeoutController.clear();
+            throw err;
+        }
+        // ready to dial, all async work finished - make sure we don't have any
+        // pending dials in progress for this peer or set of multiaddrs
+        const existingDial = this.pendingDials.find(dial => {
+            // is the dial for the same peer id?
+            if (dial.peerId != null && peerId != null && dial.peerId.equals(peerId)) {
+                return true;
+            }
+            // is the dial for the same set of multiaddrs?
+            if (addrsToDial.map(({ multiaddr }) => multiaddr.toString()).join() === dial.multiaddrs.map(multiaddr => multiaddr.toString()).join()) {
+                return true;
+            }
+            return false;
+        });
+        if (existingDial != null) {
+            log('joining existing dial target for %p', peerId);
+            signal.clear();
+            timeoutController.clear();
+            return await existingDial.promise;
+        }
+        log('creating dial target for', addrsToDial.map(({ multiaddr }) => multiaddr.toString()));
+        // @ts-expect-error .promise property is set below
+        const pendingDial = {
+            id: randomId(),
+            status: 'queued',
+            peerId,
+            multiaddrs: addrsToDial.map(({ multiaddr }) => multiaddr)
+        };
+        pendingDial.promise = this.performDial(pendingDial, {
+            ...options,
+            signal
+        })
+            .finally(() => {
+            // remove our pending dial entry
+            this.pendingDials = this.pendingDials.filter(p => p.id !== pendingDial.id);
+            // clean up abort signals/controllers
+            signal.clear();
+            timeoutController.clear();
+        })
+            .catch(err => {
+            log.error('dial failed to %s', addrsToDial.map(({ multiaddr }) => multiaddr.toString()).join(', '), err);
+            // Error is a timeout
+            if (timeoutController.signal.aborted) {
+                const error = new CodeError(err.message, codes.ERR_TIMEOUT);
+                throw error;
+            }
+            throw err;
+        });
+        // let other dials join this one
+        this.pendingDials.push(pendingDial);
+        return await pendingDial.promise;
+    }
+    createDialAbortControllers(userSignal) {
+        // ensure we throw if the dial takes longer than the dial timeout
+        const timeoutController = new TimeoutController(this.dialTimeout);
+        // let any signal abort the dial
+        const signal = combineSignals(timeoutController.signal, this.shutDownController.signal, userSignal);
+        return { timeoutController, signal };
+    }
+    async calculateMultiaddrs(peerId, addrs = [], options = {}) {
+        // if a peer id or multiaddr(s) with a peer id, make sure it isn't our peer id and that we are allowed to dial it
+        if (peerId != null) {
+            if (this.peerId.equals(peerId)) {
+                throw new CodeError('Tried to dial self', codes.ERR_DIALED_SELF);
+            }
+            if ((await this.connectionGater.denyDialPeer?.(peerId)) === true) {
+                throw new CodeError('The dial request is blocked by gater.allowDialPeer', codes.ERR_PEER_DIAL_INTERCEPTED);
+            }
+            // if just a peer id was passed, load available multiaddrs for this peer from the address book
+            if (addrs.length === 0) {
+                log('loading multiaddrs for %p', peerId);
+                addrs.push(...(await this.peerStore.addressBook.get(peerId)));
+                log('loaded multiaddrs for %p', peerId, addrs.map(({ multiaddr }) => multiaddr.toString()));
+            }
+        }
+        // resolve addresses - this can result in a one-to-many translation when dnsaddrs are resolved
+        const resolvedAddresses = (await Promise.all(addrs.map(async (addr) => {
+            const result = await resolveMultiaddrs(addr.multiaddr, options);
+            if (result.length === 1 && result[0].equals(addr.multiaddr)) {
+                return addr;
+            }
+            return result.map(multiaddr => ({
+                multiaddr,
+                isCertified: false
+            }));
+        })))
+            .flat();
+        // filter out any multiaddrs that we do not have transports for
+        const filteredAddrs = resolvedAddresses.filter(addr => Boolean(this.transportManager.transportForMultiaddr(addr.multiaddr)));
+        // deduplicate addresses
+        const dedupedAddrs = new Map();
+        for (const addr of filteredAddrs) {
+            const maStr = addr.multiaddr.toString();
+            const existing = dedupedAddrs.get(maStr);
+            if (existing != null) {
+                existing.isCertified = existing.isCertified || addr.isCertified || false;
+                continue;
+            }
+            dedupedAddrs.set(maStr, addr);
+        }
+        let dedupedMultiaddrs = [...dedupedAddrs.values()];
+        if (dedupedMultiaddrs.length === 0 || dedupedMultiaddrs.length > this.maxPeerAddrsToDial) {
+            log('addresses for %p before filtering', peerId ?? 'unknown peer', resolvedAddresses.map(({ multiaddr }) => multiaddr.toString()));
+            log('addresses for %p after filtering', peerId ?? 'unknown peer', dedupedMultiaddrs.map(({ multiaddr }) => multiaddr.toString()));
+        }
+        // make sure we actually have some addresses to dial
+        if (dedupedMultiaddrs.length === 0) {
+            throw new CodeError('The dial request has no valid addresses', codes.ERR_NO_VALID_ADDRESSES);
+        }
+        // make sure we don't have too many addresses to dial
+        if (dedupedMultiaddrs.length > this.maxPeerAddrsToDial) {
+            throw new CodeError('dial with more addresses than allowed', codes.ERR_TOO_MANY_ADDRESSES);
+        }
+        // ensure the peer id is appended to the multiaddr
+        if (peerId != null) {
+            const peerIdMultiaddr = `/p2p/${peerId.toString()}`;
+            dedupedMultiaddrs = dedupedMultiaddrs.map(addr => {
+                const addressPeerId = addr.multiaddr.getPeerId();
+                const lastProto = addr.multiaddr.protos().pop();
+                // do not append peer id to path multiaddrs
+                if (lastProto?.path === true) {
+                    return addr;
+                }
+                // append peer id to multiaddr if it is not already present
+                if (addressPeerId !== peerId.toString()) {
+                    return {
+                        multiaddr: addr.multiaddr.encapsulate(peerIdMultiaddr),
+                        isCertified: addr.isCertified
+                    };
+                }
+                return addr;
+            });
+        }
+        const gatedAdrs = [];
+        for (const addr of dedupedMultiaddrs) {
+            if (this.connectionGater.denyDialMultiaddr != null && await this.connectionGater.denyDialMultiaddr(addr.multiaddr)) {
+                continue;
+            }
+            gatedAdrs.push(addr);
+        }
+        return gatedAdrs.sort(this.addressSorter);
+    }
+    async performDial(pendingDial, options = {}) {
+        const dialAbortControllers = pendingDial.multiaddrs.map(() => new AbortController());
+        try {
+            // internal peer dial queue to ensure we only dial the configured number of addresses
+            // per peer at the same time to prevent one peer with a lot of addresses swamping
+            // the dial queue
+            const peerDialQueue = new PQueue({
+                concurrency: this.maxParallelDialsPerPeer
+            });
+            peerDialQueue.on('error', (err) => {
+                log.error('error dialling', err);
+            });
+            const conn = await Promise.any(pendingDial.multiaddrs.map(async (addr, i) => {
+                const controller = dialAbortControllers[i];
+                if (controller == null) {
+                    throw new CodeError('dialAction did not come with an AbortController', codes.ERR_INVALID_PARAMETERS);
+                }
+                // let any signal abort the dial
+                const signal = combineSignals(controller.signal, options.signal);
+                signal.addEventListener('abort', () => {
+                    log('dial to %s aborted', addr);
+                });
+                const deferred = pDefer();
+                await peerDialQueue.add(async () => {
+                    if (signal.aborted) {
+                        log('dial to %s was aborted before reaching the head of the peer dial queue', addr);
+                        deferred.reject(new AbortError());
+                        return;
+                    }
+                    // add the individual dial to the dial queue so we don't breach maxConcurrentDials
+                    await this.queue.add(async () => {
+                        try {
+                            if (signal.aborted) {
+                                log('dial to %s was aborted before reaching the head of the dial queue', addr);
+                                deferred.reject(new AbortError());
+                                return;
+                            }
+                            // update dial status
+                            pendingDial.status = 'active';
+                            const conn = await this.transportManager.dial(addr, {
+                                ...options,
+                                signal
+                            });
+                            if (controller.signal.aborted) {
+                                // another dial succeeded faster than this one
+                                log('multiple dials succeeded, closing superfluous connection');
+                                conn.close().catch(err => {
+                                    log.error('error closing superfluous connection', err);
+                                });
+                                deferred.reject(new AbortError());
+                                return;
+                            }
+                            // remove the successful AbortController so it is not aborted
+                            dialAbortControllers[i] = undefined;
+                            // immediately abort any other dials
+                            dialAbortControllers.forEach(c => {
+                                if (c !== undefined) {
+                                    c.abort();
+                                }
+                            });
+                            log('dial to %s succeeded', addr);
+                            // resolve the connection promise
+                            deferred.resolve(conn);
+                        }
+                        catch (err) {
+                            // something only went wrong if our signal was not aborted
+                            log.error('error during dial of %s', addr, err);
+                            deferred.reject(err);
+                        }
+                    }, {
+                        ...options,
+                        signal
+                    }).catch(err => {
+                        deferred.reject(err);
+                    });
+                }, {
+                    signal
+                }).catch(err => {
+                    deferred.reject(err);
+                }).finally(() => {
+                    signal.clear();
+                });
+                return await deferred.promise;
+            }));
+            // dial succeeded or failed
+            if (conn == null) {
+                throw new CodeError('successful dial led to empty object returned from peer dial queue', codes.ERR_TRANSPORT_DIAL_FAILED);
+            }
+            pendingDial.status = 'success';
+            return conn;
+        }
+        catch (err) {
+            pendingDial.status = 'error';
+            // if we only dialled one address, unwrap the AggregateError to provide more
+            // useful feedback to the user
+            if (pendingDial.multiaddrs.length === 1 && err.name === 'AggregateError') {
+                throw err.errors[0];
+            }
+            throw err;
+        }
+    }
+}
+/**
+ * Returns a random string
+ */
+function randomId() {
+    return `${(parseInt(String(Math.random() * 1e9), 10)).toString()}${Date.now()}`;
+}
+//# sourceMappingURL=dial-queue.js.map