libp2p 0.36.0 → 0.36.2-1473044

package/dist/src/dialer/auto-dialer.js

@@ -0,0 +1,24 @@
+import { logger } from '@libp2p/logger';
+const log = logger('libp2p:dialer:auto-dialer');
+export class AutoDialer {
+    constructor(components, init) {
+        this.components = components;
+        this.enabled = init.enabled;
+        this.minConnections = init.minConnections;
+    }
+    handle(evt) {
+        const { detail: peer } = evt;
+        // If auto dialing is on and we have no connection to the peer, check if we should dial
+        if (this.enabled && this.components.getConnectionManager().getConnection(peer.id) == null) {
+            const minConnections = this.minConnections ?? 0;
+            if (minConnections > this.components.getConnectionManager().getConnectionList().length) {
+                log('auto-dialing discovered peer %p', peer.id);
+                void this.components.getDialer().dial(peer.id)
+                    .catch(err => {
+                    log.error('could not connect to discovered peer %p with %o', peer.id, err);
+                });
+            }
+        }
+    }
+}
+//# sourceMappingURL=auto-dialer.js.map

package/dist/src/dialer/auto-dialer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auto-dialer.js","sourceRoot":"","sources":["../../../src/dialer/auto-dialer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAGvC,MAAM,GAAG,GAAG,MAAM,CAAC,2BAA2B,CAAC,CAAA;AAO/C,MAAM,OAAO,UAAU;IAKrB,YAAa,UAAsB,EAAE,IAAoB;QACvD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAA;IAC3C,CAAC;IAEM,MAAM,CAAE,GAA0B;QACvC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAA;QAE5B,uFAAuF;QACvF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE;YACzF,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,CAAC,CAAA;YAE/C,IAAI,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,iBAAiB,EAAE,CAAC,MAAM,EAAE;gBACtF,GAAG,CAAC,iCAAiC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;gBAE/C,KAAK,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;qBAC3C,KAAK,CAAC,GAAG,CAAC,EAAE;oBACX,GAAG,CAAC,KAAK,CAAC,iDAAiD,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;gBAC5E,CAAC,CAAC,CAAA;aACL;SACF;IACH,CAAC;CACF"}

package/dist/src/dialer/dial-request.d.ts

@@ -1,55 +1,27 @@
-export = DialRequest;
-/**
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('./')} Dialer
- * @typedef {import('multiaddr').Multiaddr} Multiaddr
- */
-/**
- * @typedef {Object} DialOptions
- * @property {AbortSignal} signal
- *
- * @typedef {Object} DialRequestOptions
- * @property {Multiaddr[]} addrs
- * @property {(m: Multiaddr, options: DialOptions) => Promise<Connection>} dialAction
- * @property {Dialer} dialer
- */
-declare class DialRequest {
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { Connection } from '@libp2p/interfaces/connection';
+import type { AbortOptions } from '@libp2p/interfaces';
+import type { DefaultDialer } from './index.js';
+export interface DialAction {
+    (m: Multiaddr, options: AbortOptions): Promise<Connection>;
+}
+export interface DialRequestOptions {
+    addrs: Multiaddr[];
+    dialAction: DialAction;
+    dialer: DefaultDialer;
+}
+export declare class DialRequest {
+    private readonly addrs;
+    private readonly dialer;
+    private readonly dialAction;
     /**
      * Manages running the `dialAction` on multiple provided `addrs` in parallel
      * up to a maximum determined by the number of tokens returned
      * from `dialer.getTokens`. Once a DialRequest is created, it can be
      * started using `DialRequest.run(options)`. Once a single dial has succeeded,
      * all other dials in the request will be cancelled.
-     *
-     * @class
-     * @param {DialRequestOptions} options
      */
-    constructor({ addrs, dialAction, dialer }: DialRequestOptions);
-    addrs: import("multiaddr").Multiaddr[];
-    dialer: import("./");
-    dialAction: (m: Multiaddr, options: DialOptions) => Promise<Connection>;
-    /**
-     * @async
-     * @param {object} [options]
-     * @param {AbortSignal} [options.signal] - An AbortController signal
-     * @returns {Promise<Connection>}
-     */
-    run(options?: {
-        signal?: AbortSignal | undefined;
-    } | undefined): Promise<Connection>;
-}
-declare namespace DialRequest {
-    export { Connection, Dialer, Multiaddr, DialOptions, DialRequestOptions };
+    constructor(options: DialRequestOptions);
+    run(options?: AbortOptions): Promise<Connection>;
 }
-type Connection = import("libp2p-interfaces/src/connection/connection");
-type DialRequestOptions = {
-    addrs: Multiaddr[];
-    dialAction: (m: Multiaddr, options: DialOptions) => Promise<Connection>;
-    dialer: Dialer;
-};
-type Dialer = import('./');
-type Multiaddr = import('multiaddr').Multiaddr;
-type DialOptions = {
-    signal: AbortSignal;
-};
 //# sourceMappingURL=dial-request.d.ts.map

package/dist/src/dialer/dial-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dial-request.d.ts","sourceRoot":"","sources":["../../../src/dialer/dial-request.js"],"names":[],"mappings":";AAWA;;;;GAIG;AAEH;;;;;;;;GAQG;AAEH;IACE;;;;;;;;;OASG;IACH,2CAFW,kBAAkB,EAU5B;IAHC,uCAAkB;IAClB,qBAAoB;IACpB,gBAtBc,SAAS,WAAW,WAAW,KAAK,QAAQ,UAAU,CAAC,CAsBzC;IAG9B;;;;;OAKG;IACH;;oBAFa,QAAQ,UAAU,CAAC,CA+C/B;CACF;;;;;;WA9Ea,SAAS,EAAE;oBACP,SAAS,WAAW,WAAW,KAAK,QAAQ,UAAU,CAAC;YAC3D,MAAM;;cAXP,OAAO,IAAI,CAAC;iBACZ,OAAO,WAAW,EAAE,SAAS;;YAK5B,WAAW"}
+{"version":3,"file":"dial-request.d.ts","sourceRoot":"","sources":["../../../src/dialer/dial-request.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAI/C,MAAM,WAAW,UAAU;IACzB,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CAC3D;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,aAAa,CAAA;CACtB;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAa;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IAEvC;;;;;;OAMG;gBACU,OAAO,EAAE,kBAAkB;IAYlC,GAAG,CAAE,OAAO,GAAE,YAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;CA+D5D"}

package/dist/src/dialer/dial-request.js

@@ -0,0 +1,83 @@
+import errCode from 'err-code';
+import { anySignal } from 'any-signal';
+import FIFO from 'p-fifo';
+// @ts-expect-error setMaxListeners is missing from the node 16 types
+import { setMaxListeners } from 'events';
+import { codes } from '../errors.js';
+import { logger } from '@libp2p/logger';
+const log = logger('libp2p:dialer:dial-request');
+export class DialRequest {
+    /**
+     * Manages running the `dialAction` on multiple provided `addrs` in parallel
+     * up to a maximum determined by the number of tokens returned
+     * from `dialer.getTokens`. Once a DialRequest is created, it can be
+     * started using `DialRequest.run(options)`. Once a single dial has succeeded,
+     * all other dials in the request will be cancelled.
+     */
+    constructor(options) {
+        const { addrs, dialAction, dialer } = options;
+        this.addrs = addrs;
+        this.dialer = dialer;
+        this.dialAction = dialAction;
+    }
+    async run(options = {}) {
+        const tokens = this.dialer.getTokens(this.addrs.length);
+        // If no tokens are available, throw
+        if (tokens.length < 1) {
+            throw errCode(new Error('No dial tokens available'), codes.ERR_NO_DIAL_TOKENS);
+        }
+        const tokenHolder = new FIFO();
+        for (const token of tokens) {
+            void tokenHolder.push(token).catch(err => {
+                log.error(err);
+            });
+        }
+        const dialAbortControllers = this.addrs.map(() => {
+            const controller = new AbortController();
+            try {
+                // fails on node < 15.4
+                setMaxListeners?.(Infinity, controller.signal);
+            }
+            catch { }
+            return controller;
+        });
+        if (options.signal != null) {
+            try {
+                // fails on node < 15.4
+                setMaxListeners?.(Infinity, options.signal);
+            }
+            catch { }
+        }
+        let completedDials = 0;
+        try {
+            return await Promise.any(this.addrs.map(async (addr, i) => {
+                const token = await tokenHolder.shift(); // get token
+                let conn;
+                try {
+                    const signal = dialAbortControllers[i].signal;
+                    conn = await this.dialAction(addr, { ...options, signal: (options.signal != null) ? anySignal([signal, options.signal]) : signal });
+                    // Remove the successful AbortController so it is not aborted
+                    dialAbortControllers.splice(i, 1);
+                }
+                finally {
+                    completedDials++;
+                    // If we have more or equal dials remaining than tokens, recycle the token, otherwise release it
+                    if (this.addrs.length - completedDials >= tokens.length) {
+                        void tokenHolder.push(token).catch(err => {
+                            log.error(err);
+                        });
+                    }
+                    else {
+                        this.dialer.releaseToken(tokens.splice(tokens.indexOf(token), 1)[0]);
+                    }
+                }
+                return conn;
+            }));
+        }
+        finally {
+            dialAbortControllers.map(c => c.abort()); // success/failure happened, abort everything else
+            tokens.forEach(token => this.dialer.releaseToken(token)); // release tokens back to the dialer
+        }
+    }
+}
+//# sourceMappingURL=dial-request.js.map

package/dist/src/dialer/dial-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dial-request.js","sourceRoot":"","sources":["../../../src/dialer/dial-request.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,IAAI,MAAM,QAAQ,CAAA;AACzB,qEAAqE;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAMvC,MAAM,GAAG,GAAG,MAAM,CAAC,4BAA4B,CAAC,CAAA;AAYhD,MAAM,OAAO,WAAW;IAKtB;;;;;;OAMG;IACH,YAAa,OAA2B;QACtC,MAAM,EACJ,KAAK,EACL,UAAU,EACV,MAAM,EACP,GAAG,OAAO,CAAA;QAEX,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,UAAwB,EAAE;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAEvD,oCAAoC;QACpC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAA;SAC/E;QAED,MAAM,WAAW,GAAG,IAAI,IAAI,EAAU,CAAA;QAEtC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,KAAK,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACvC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC,CAAC,CAAA;SACH;QAED,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YAC/C,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;YACxC,IAAI;gBACF,uBAAuB;gBACvB,eAAe,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;aAC/C;YAAC,MAAM,GAAE;YAEV,OAAO,UAAU,CAAA;QACnB,CAAC,CAAC,CAAA;QAEF,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;YAC1B,IAAI;gBACF,uBAAuB;gBACvB,eAAe,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;aAC5C;YAAC,MAAM,GAAE;SACX;QAED,IAAI,cAAc,GAAG,CAAC,CAAA;QAEtB,IAAI;YACF,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE;gBACxD,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,CAAA,CAAC,YAAY;gBACpD,IAAI,IAAI,CAAA;gBACR,IAAI;oBACF,MAAM,MAAM,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;oBAC7C,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAA;oBACnI,6DAA6D;oBAC7D,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;iBAClC;wBAAS;oBACR,cAAc,EAAE,CAAA;oBAChB,gGAAgG;oBAChG,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE;wBACvD,KAAK,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;4BACvC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;wBAChB,CAAC,CAAC,CAAA;qBACH;yBAAM;wBACL,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;qBACrE;iBACF;gBAED,OAAO,IAAI,CAAA;YACb,CAAC,CAAC,CAAC,CAAA;SACJ;gBAAS;YACR,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA,CAAC,kDAAkD;YAC3F,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA,CAAC,oCAAoC;SAC9F;IACH,CAAC;CACF"}

package/dist/src/dialer/index.d.ts

@@ -1,182 +1,75 @@
-export = Dialer;
-/**
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('peer-id')} PeerId
- * @typedef {import('../peer-store/types').PeerStore} PeerStore
- * @typedef {import('../peer-store/types').Address} Address
- * @typedef {import('../transport-manager')} TransportManager
- * @typedef {import('../types').ConnectionGater} ConnectionGater
- */
-/**
- * @typedef {Object} DialerProperties
- * @property {PeerStore} peerStore
- * @property {TransportManager} transportManager
- * @property {ConnectionGater} connectionGater
- *
- * @typedef {(addr:Multiaddr) => Promise<string[]>} Resolver
- *
- * @typedef {Object} DialerOptions
- * @property {(addresses: Address[]) => Address[]} [options.addressSorter = publicAddressesFirst] - Sort the known addresses of a peer before trying to dial.
- * @property {number} [maxParallelDials = MAX_PARALLEL_DIALS] - Number of max concurrent dials.
- * @property {number} [maxAddrsToDial = MAX_ADDRS_TO_DIAL] - Number of max addresses to dial for a given peer.
- * @property {number} [maxDialsPerPeer = MAX_PER_PEER_DIALS] - Number of max concurrent dials per peer.
- * @property {number} [dialTimeout = DIAL_TIMEOUT] - How long a dial attempt is allowed to take.
- * @property {Record<string, Resolver>} [resolvers = {}] - multiaddr resolvers to use when dialing
- * @property {import('../metrics')} [metrics]
- *
- * @typedef DialTarget
- * @property {string} id
- * @property {Multiaddr[]} addrs
- *
- * @typedef PendingDial
- * @property {import('./dial-request')} dialRequest
- * @property {import('timeout-abort-controller').TimeoutController} controller
- * @property {Promise<Connection>} promise
- * @property {function():void} destroy
- */
-declare class Dialer {
-    /**
-     * @class
-     * @param {DialerProperties & DialerOptions} options
-     */
-    constructor({ transportManager, peerStore, connectionGater, addressSorter, maxParallelDials, maxAddrsToDial, dialTimeout, maxDialsPerPeer, resolvers, metrics }: DialerProperties & DialerOptions);
-    connectionGater: import("../types").ConnectionGater;
-    transportManager: import("../transport-manager");
-    peerStore: import("../peer-store/types").PeerStore;
-    addressSorter: (addresses: Address[]) => Address[];
-    maxParallelDials: number;
-    maxAddrsToDial: number;
-    timeout: number;
-    maxDialsPerPeer: number;
+import { Multiaddr } from '@multiformats/multiaddr';
+import { TimeoutController } from 'timeout-abort-controller';
+import { DialRequest } from './dial-request.js';
+import type { Connection } from '@libp2p/interfaces/connection';
+import type { AbortOptions, Startable } from '@libp2p/interfaces';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { Components } from '@libp2p/interfaces/components';
+import type { Dialer, DialerInit } from '@libp2p/interfaces/dialer';
+export interface DialTarget {
+    id: string;
+    addrs: Multiaddr[];
+}
+export interface PendingDial {
+    dialRequest: DialRequest;
+    controller: TimeoutController;
+    promise: Promise<Connection>;
+    destroy: () => void;
+}
+export interface PendingDialTarget {
+    resolve: (value: any) => void;
+    reject: (err: Error) => void;
+}
+export declare class DefaultDialer implements Dialer, Startable {
+    private readonly components;
+    private readonly addressSorter;
+    private readonly maxAddrsToDial;
+    private readonly timeout;
+    private readonly maxDialsPerPeer;
     tokens: number[];
-    /** @type {Map<string, PendingDial>} */
-    _pendingDials: Map<string, PendingDial>;
-    /** @type {Map<string, { resolve: (value: any) => void, reject: (err: Error) => void}>} */
-    _pendingDialTargets: Map<string, {
-        resolve: (value: any) => void;
-        reject: (err: Error) => void;
-    }>;
+    pendingDials: Map<string, PendingDial>;
+    pendingDialTargets: Map<string, PendingDialTarget>;
+    private started;
+    constructor(components: Components, init?: DialerInit);
+    isStarted(): boolean;
+    start(): Promise<void>;
     /**
      * Clears any pending dials
      */
-    destroy(): void;
+    stop(): Promise<void>;
     /**
      * Connects to a given `peer` by dialing all of its known addresses.
      * The dial to the first address that is successfully able to upgrade a connection
      * will be used.
-     *
-     * @param {PeerId|Multiaddr|string} peer - The peer to dial
-     * @param {object} [options]
-     * @param {AbortSignal} [options.signal] - An AbortController signal
-     * @returns {Promise<Connection>}
      */
-    connectToPeer(peer: PeerId | Multiaddr | string, options?: {
-        signal?: AbortSignal | undefined;
-    } | undefined): Promise<Connection>;
+    dial(peer: PeerId | Multiaddr, options?: AbortOptions): Promise<Connection>;
+    dialProtocol(peer: PeerId | Multiaddr, protocols: string | string[], options?: AbortOptions): Promise<import("@libp2p/interfaces/connection").ProtocolStream>;
     /**
      * Connects to a given `peer` by dialing all of its known addresses.
      * The dial to the first address that is successfully able to upgrade a connection
      * will be used.
-     *
-     * @param {PeerId|Multiaddr|string} peer - The peer to dial
-     * @returns {Promise<DialTarget>}
      */
-    _createCancellableDialTarget(peer: PeerId | Multiaddr | string): Promise<DialTarget>;
+    _createCancellableDialTarget(peer: PeerId): Promise<DialTarget>;
     /**
      * Creates a DialTarget. The DialTarget is used to create and track
      * the DialRequest to a given peer.
      * If a multiaddr is received it should be the first address attempted.
      * Multiaddrs not supported by the available transports will be filtered out.
-     *
-     * @private
-     * @param {PeerId|Multiaddr|string} peer - A PeerId or Multiaddr
-     * @returns {Promise<DialTarget>}
      */
-    private _createDialTarget;
+    _createDialTarget(peer: PeerId): Promise<DialTarget>;
     /**
      * Creates a PendingDial that wraps the underlying DialRequest
-     *
-     * @private
-     * @param {DialTarget} dialTarget
-     * @param {object} [options]
-     * @param {AbortSignal} [options.signal] - An AbortController signal
-     * @returns {PendingDial}
-     */
-    private _createPendingDial;
-    /**
-     * @param {number} num
      */
+    _createPendingDial(dialTarget: DialTarget, options?: AbortOptions): PendingDial;
     getTokens(num: number): number[];
-    /**
-     * @param {number} token
-     */
     releaseToken(token: number): void;
     /**
-     * Resolve multiaddr recursively.
-     *
-     * @param {Multiaddr} ma
-     * @returns {Promise<Multiaddr[]>}
+     * Resolve multiaddr recursively
      */
     _resolve(ma: Multiaddr): Promise<Multiaddr[]>;
     /**
      * Resolve a given multiaddr. If this fails, an empty array will be returned
-     *
-     * @param {Multiaddr} ma
-     * @returns {Promise<Multiaddr[]>}
      */
     _resolveRecord(ma: Multiaddr): Promise<Multiaddr[]>;
 }
-declare namespace Dialer {
-    export { Connection, PeerId, PeerStore, Address, TransportManager, ConnectionGater, DialerProperties, Resolver, DialerOptions, DialTarget, PendingDial };
-}
-type PendingDial = {
-    dialRequest: import('./dial-request');
-    controller: import('timeout-abort-controller').TimeoutController;
-    promise: Promise<Connection>;
-    destroy: () => void;
-};
-type PeerId = import('peer-id');
-import { Multiaddr } from "multiaddr";
-type Connection = import("libp2p-interfaces/src/connection/connection");
-type DialTarget = {
-    id: string;
-    addrs: Multiaddr[];
-};
-type DialerProperties = {
-    peerStore: PeerStore;
-    transportManager: TransportManager;
-    connectionGater: ConnectionGater;
-};
-type DialerOptions = {
-    /**
-     * - Sort the known addresses of a peer before trying to dial.
-     */
-    addressSorter?: ((addresses: Address[]) => Address[]) | undefined;
-    /**
-     * - Number of max concurrent dials.
-     */
-    maxParallelDials?: number | undefined;
-    /**
-     * - Number of max addresses to dial for a given peer.
-     */
-    maxAddrsToDial?: number | undefined;
-    /**
-     * - Number of max concurrent dials per peer.
-     */
-    maxDialsPerPeer?: number | undefined;
-    /**
-     * - How long a dial attempt is allowed to take.
-     */
-    dialTimeout?: number | undefined;
-    /**
-     * - multiaddr resolvers to use when dialing
-     */
-    resolvers?: Record<string, Resolver> | undefined;
-    metrics?: import("../metrics") | undefined;
-};
-type PeerStore = import('../peer-store/types').PeerStore;
-type Address = import('../peer-store/types').Address;
-type TransportManager = import('../transport-manager');
-type ConnectionGater = import('../types').ConnectionGater;
-type Resolver = (addr: Multiaddr) => Promise<string[]>;
 //# sourceMappingURL=index.d.ts.map

package/dist/src/dialer/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/dialer/index.js"],"names":[],"mappings":";AAgCA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;IACE;;;OAGG;IACH,iKAFW,gBAAgB,GAAG,aAAa,EAyC1C;IA3BC,oDAAsC;IACtC,iDAAwC;IACxC,mDAA0B;IAC1B,2BAvCsB,OAAO,EAAE,KAAK,OAAO,EAAE,CAuCX;IAClC,yBAAwC;IACxC,uBAAoC;IACpC,gBAA0B;IAC1B,wBAAsC;IACtC,iBAAuE;IAEvE,uCAAuC;IACvC,eADW,IAAI,MAAM,EAAE,WAAW,CAAC,CAKjC;IAEF,0FAA0F;IAC1F;yBAD0C,GAAG,KAAK,IAAI;sBAAgB,KAAK,KAAK,IAAI;OAKlF;IAOJ;;OAEG;IACH,gBAcC;IAED;;;;;;;;;OASG;IACH,oBALW,MAAM,GAAC,SAAS,GAAC,MAAM;;oBAGrB,QAAQ,UAAU,CAAC,CA8B/B;IAED;;;;;;;OAOG;IACH,mCAHW,MAAM,GAAC,SAAS,GAAC,MAAM,GACrB,QAAQ,UAAU,CAAC,CAmB/B;IAED;;;;;;;;;OASG;IACH,0BAyCC;IAED;;;;;;;;OAQG;IACH,2BA0CC;IAED;;OAEG;IACH,eAFW,MAAM,YAOhB;IAED;;OAEG;IACH,oBAFW,MAAM,QAOhB;IAED;;;;;OAKG;IACH,aAHW,SAAS,GACP,QAAQ,SAAS,EAAE,CAAC,CAwBhC;IAED;;;;;OAKG;IACH,mBAHW,SAAS,GACP,QAAQ,SAAS,EAAE,CAAC,CAWhC;CACF;;;;;iBAtTa,OAAO,gBAAgB,CAAC;gBACxB,OAAO,0BAA0B,EAAE,iBAAiB;aACpD,QAAQ,UAAU,CAAC;mBACR,IAAI;;cAhChB,OAAO,SAAS,CAAC;;;;QAyBhB,MAAM;WACN,SAAS,EAAE;;;eAjBX,SAAS;sBACT,gBAAgB;qBAChB,eAAe;;;;;;iCAKH,OAAO,EAAE,KAAK,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;iBAfpC,OAAO,qBAAqB,EAAE,SAAS;eACvC,OAAO,qBAAqB,EAAE,OAAO;wBACrC,OAAO,sBAAsB,CAAC;uBAC9B,OAAO,UAAU,EAAE,eAAe;uBAS5B,SAAS,KAAK,QAAQ,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/dialer/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAK5D,OAAO,EAAc,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAU3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAGxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAUnE,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,SAAS,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,WAAW,CAAA;IACxB,UAAU,EAAE,iBAAiB,CAAA;IAC7B,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;IAC5B,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB;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,qBAAa,aAAc,YAAW,MAAM,EAAE,SAAS;IACrD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACjC,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACtC,kBAAkB,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IACzD,OAAO,CAAC,OAAO,CAAS;gBAEX,UAAU,EAAE,UAAU,EAAE,IAAI,GAAE,UAAe;IAwB1D,SAAS;IAIH,KAAK;IAIX;;OAEG;IACG,IAAI;IAkBV;;;;OAIG;IACG,IAAI,CAAE,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,GAAE,YAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAuDhF,YAAY,CAAE,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,GAAE,YAAiB;IAgBtG;;;;OAIG;IACG,4BAA4B,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAmBtE;;;;;OAKG;IACG,iBAAiB,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAuC3D;;OAEG;IACH,kBAAkB,CAAE,UAAU,EAAE,UAAU,EAAE,OAAO,GAAE,YAAiB,GAAG,WAAW;IA+CpF,SAAS,CAAE,GAAG,EAAE,MAAM;IAOtB,YAAY,CAAE,KAAK,EAAE,MAAM;IAU3B;;OAEG;IACG,QAAQ,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAwBpD;;OAEG;IACG,cAAc,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAU3D"}