libp2p 0.36.0 → 0.36.2-1473044

package/dist/src/transport-manager.js

@@ -0,0 +1,223 @@
+import { logger } from '@libp2p/logger';
+import pSettle from 'p-settle';
+import { codes } from './errors.js';
+import errCode from 'err-code';
+import { CustomEvent, EventEmitter } from '@libp2p/interfaces';
+import { trackedMap } from '@libp2p/tracked-map';
+const log = logger('libp2p:transports');
+export class DefaultTransportManager extends EventEmitter {
+    constructor(components, init = {}) {
+        super();
+        this.components = components;
+        this.started = false;
+        this.transports = new Map();
+        this.listeners = trackedMap({
+            component: 'transport-manager',
+            metric: 'listeners',
+            metrics: this.components.getMetrics()
+        });
+        this.faultTolerance = init.faultTolerance ?? FaultTolerance.FATAL_ALL;
+    }
+    /**
+     * Adds a `Transport` to the manager
+     */
+    add(transport) {
+        const tag = transport[Symbol.toStringTag];
+        if (tag == null) {
+            throw errCode(new Error('Transport must have a valid tag'), codes.ERR_INVALID_KEY);
+        }
+        if (this.transports.has(tag)) {
+            throw errCode(new Error('There is already a transport with this tag'), codes.ERR_DUPLICATE_TRANSPORT);
+        }
+        log('adding transport %s', tag);
+        this.transports.set(tag, transport);
+        if (!this.listeners.has(tag)) {
+            this.listeners.set(tag, []);
+        }
+    }
+    isStarted() {
+        return this.started;
+    }
+    async start() {
+        // Listen on the provided transports for the provided addresses
+        const addrs = this.components.getAddressManager().getListenAddrs();
+        await this.listen(addrs);
+        this.started = true;
+    }
+    /**
+     * Stops all listeners
+     */
+    async stop() {
+        const tasks = [];
+        for (const [key, listeners] of this.listeners) {
+            log('closing listeners for %s', key);
+            while (listeners.length > 0) {
+                const listener = listeners.pop();
+                if (listener == null) {
+                    continue;
+                }
+                tasks.push(listener.close());
+            }
+        }
+        await Promise.all(tasks);
+        log('all listeners closed');
+        for (const key of this.listeners.keys()) {
+            this.listeners.set(key, []);
+        }
+        this.started = false;
+    }
+    /**
+     * Dials the given Multiaddr over it's supported transport
+     */
+    async dial(ma, options) {
+        const transport = this.transportForMultiaddr(ma);
+        if (transport == null) {
+            throw errCode(new Error(`No transport available for address ${String(ma)}`), codes.ERR_TRANSPORT_UNAVAILABLE);
+        }
+        try {
+            return await transport.dial(ma, {
+                ...options,
+                upgrader: this.components.getUpgrader()
+            });
+        }
+        catch (err) {
+            if (err.code == null) {
+                err.code = codes.ERR_TRANSPORT_DIAL_FAILED;
+            }
+            throw err;
+        }
+    }
+    /**
+     * Returns all Multiaddr's the listeners are using
+     */
+    getAddrs() {
+        let addrs = [];
+        for (const listeners of this.listeners.values()) {
+            for (const listener of listeners) {
+                addrs = [...addrs, ...listener.getAddrs()];
+            }
+        }
+        return addrs;
+    }
+    /**
+     * Returns all the transports instances
+     */
+    getTransports() {
+        return Array.of(...this.transports.values());
+    }
+    /**
+     * Finds a transport that matches the given Multiaddr
+     */
+    transportForMultiaddr(ma) {
+        for (const transport of this.transports.values()) {
+            const addrs = transport.filter([ma]);
+            if (addrs.length > 0) {
+                return transport;
+            }
+        }
+    }
+    /**
+     * Starts listeners for each listen Multiaddr
+     */
+    async listen(addrs) {
+        if (addrs == null || addrs.length === 0) {
+            log('no addresses were provided for listening, this node is dial only');
+            return;
+        }
+        const couldNotListen = [];
+        for (const [key, transport] of this.transports.entries()) {
+            const supportedAddrs = transport.filter(addrs);
+            const tasks = [];
+            // For each supported multiaddr, create a listener
+            for (const addr of supportedAddrs) {
+                log('creating listener for %s on %s', key, addr);
+                const listener = transport.createListener({
+                    upgrader: this.components.getUpgrader()
+                });
+                let listeners = this.listeners.get(key);
+                if (listeners == null) {
+                    listeners = [];
+                    this.listeners.set(key, listeners);
+                }
+                listeners.push(listener);
+                // Track listen/close events
+                listener.addEventListener('listening', () => {
+                    this.dispatchEvent(new CustomEvent('listener:listening', {
+                        detail: listener
+                    }));
+                });
+                listener.addEventListener('close', () => {
+                    this.dispatchEvent(new CustomEvent('listener:close', {
+                        detail: listener
+                    }));
+                });
+                // We need to attempt to listen on everything
+                tasks.push(listener.listen(addr));
+            }
+            // Keep track of transports we had no addresses for
+            if (tasks.length === 0) {
+                couldNotListen.push(key);
+                continue;
+            }
+            const results = await pSettle(tasks);
+            // If we are listening on at least 1 address, succeed.
+            // TODO: we should look at adding a retry (`p-retry`) here to better support
+            // listening on remote addresses as they may be offline. We could then potentially
+            // just wait for any (`p-any`) listener to succeed on each transport before returning
+            const isListening = results.find(r => r.isFulfilled);
+            if ((isListening == null) && this.faultTolerance !== FaultTolerance.NO_FATAL) {
+                throw errCode(new Error(`Transport (${key}) could not listen on any available address`), codes.ERR_NO_VALID_ADDRESSES);
+            }
+        }
+        // If no transports were able to listen, throw an error. This likely
+        // means we were given addresses we do not have transports for
+        if (couldNotListen.length === this.transports.size) {
+            const message = `no valid addresses were provided for transports [${couldNotListen.join(', ')}]`;
+            if (this.faultTolerance === FaultTolerance.FATAL_ALL) {
+                throw errCode(new Error(message), codes.ERR_NO_VALID_ADDRESSES);
+            }
+            log(`libp2p in dial mode only: ${message}`);
+        }
+    }
+    /**
+     * Removes the given transport from the manager.
+     * If a transport has any running listeners, they will be closed.
+     */
+    async remove(key) {
+        log('removing %s', key);
+        // Close any running listeners
+        for (const listener of this.listeners.get(key) ?? []) {
+            await listener.close();
+        }
+        this.transports.delete(key);
+        this.listeners.delete(key);
+    }
+    /**
+     * Removes all transports from the manager.
+     * If any listeners are running, they will be closed.
+     *
+     * @async
+     */
+    async removeAll() {
+        const tasks = [];
+        for (const key of this.transports.keys()) {
+            tasks.push(this.remove(key));
+        }
+        await Promise.all(tasks);
+    }
+}
+/**
+ * Enum Transport Manager Fault Tolerance values
+ */
+export var FaultTolerance;
+(function (FaultTolerance) {
+    /**
+     * should be used for failing in any listen circumstance
+     */
+    FaultTolerance[FaultTolerance["FATAL_ALL"] = 0] = "FATAL_ALL";
+    /**
+     * should be used for not failing when not listening
+     */
+    FaultTolerance[FaultTolerance["NO_FATAL"] = 1] = "NO_FATAL";
+})(FaultTolerance || (FaultTolerance = {}));
+//# sourceMappingURL=transport-manager.js.map

package/dist/src/transport-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport-manager.js","sourceRoot":"","sources":["../../src/transport-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,OAAO,MAAM,UAAU,CAAA;AAI9B,OAAO,EAAgB,WAAW,EAAE,YAAY,EAAa,MAAM,oBAAoB,CAAA;AAEvF,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAEhD,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;AAMvC,MAAM,OAAO,uBAAwB,SAAQ,YAAoC;IAO/E,YAAa,UAAsB,EAAE,OAA6B,EAAE;QAClE,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAqB,CAAA;QAC9C,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC;YAC1B,SAAS,EAAE,mBAAmB;YAC9B,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;SACtC,CAAC,CAAA;QACF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,SAAS,CAAA;IACvE,CAAC;IAED;;OAEG;IACH,GAAG,CAAE,SAAoB;QACvB,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAEzC,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,iCAAiC,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAA;SACnF;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC5B,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,4CAA4C,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAA;SACtG;QAED,GAAG,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAA;QAE/B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;QAEnC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;SAC5B;IACH,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,+DAA+D;QAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,cAAc,EAAE,CAAA;QAElE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAExB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,KAAK,GAAG,EAAE,CAAA;QAChB,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,SAAS,EAAE;YAC7C,GAAG,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;YACpC,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC3B,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,CAAA;gBAEhC,IAAI,QAAQ,IAAI,IAAI,EAAE;oBACpB,SAAQ;iBACT;gBAED,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;aAC7B;SACF;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACxB,GAAG,CAAC,sBAAsB,CAAC,CAAA;QAC3B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE;YACvC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;SAC5B;QAED,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAE,EAAa,EAAE,OAAsB;QAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAEhD,IAAI,SAAS,IAAI,IAAI,EAAE;YACrB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,sCAAsC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC9G;QAED,IAAI;YACF,OAAO,MAAM,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE;gBAC9B,GAAG,OAAO;gBACV,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE;aACxC,CAAC,CAAA;SACH;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE;gBACpB,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,yBAAyB,CAAA;aAC3C;YAED,MAAM,GAAG,CAAA;SACV;IACH,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,IAAI,KAAK,GAAgB,EAAE,CAAA;QAC3B,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE;YAC/C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBAChC,KAAK,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;aAC3C;SACF;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED;;OAEG;IACH,qBAAqB,CAAE,EAAa;QAClC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;YAChD,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAEpC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBACpB,OAAO,SAAS,CAAA;aACjB;SACF;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAE,KAAkB;QAC9B,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACvC,GAAG,CAAC,kEAAkE,CAAC,CAAA;YACvE,OAAM;SACP;QAED,MAAM,cAAc,GAAG,EAAE,CAAA;QAEzB,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE;YACxD,MAAM,cAAc,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YAC9C,MAAM,KAAK,GAAG,EAAE,CAAA;YAEhB,kDAAkD;YAClD,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE;gBACjC,GAAG,CAAC,gCAAgC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;gBAChD,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc,CAAC;oBACxC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE;iBACxC,CAAC,CAAA;gBAEF,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBAEvC,IAAI,SAAS,IAAI,IAAI,EAAE;oBACrB,SAAS,GAAG,EAAE,CAAA;oBACd,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;iBACnC;gBAED,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAExB,4BAA4B;gBAC5B,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE;oBAC1C,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAW,oBAAoB,EAAE;wBACjE,MAAM,EAAE,QAAQ;qBACjB,CAAC,CAAC,CAAA;gBACL,CAAC,CAAC,CAAA;gBACF,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;oBACtC,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAW,gBAAgB,EAAE;wBAC7D,MAAM,EAAE,QAAQ;qBACjB,CAAC,CAAC,CAAA;gBACL,CAAC,CAAC,CAAA;gBAEF,6CAA6C;gBAC7C,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;aAClC;YAED,mDAAmD;YACnD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACxB,SAAQ;aACT;YAED,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAA;YACpC,sDAAsD;YACtD,4EAA4E;YAC5E,kFAAkF;YAClF,qFAAqF;YACrF,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;YACpD,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,QAAQ,EAAE;gBAC5E,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,cAAc,GAAG,6CAA6C,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;aACvH;SACF;QAED,oEAAoE;QACpE,8DAA8D;QAC9D,IAAI,cAAc,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;YAClD,MAAM,OAAO,GAAG,oDAAoD,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAA;YAChG,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,SAAS,EAAE;gBACpD,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;aAChE;YACD,GAAG,CAAC,6BAA6B,OAAO,EAAE,CAAC,CAAA;SAC5C;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAE,GAAW;QACvB,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;QAEvB,8BAA8B;QAC9B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE;YACpD,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAA;SACvB;QAED,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC5B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,KAAK,GAAG,EAAE,CAAA;QAChB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE;YACxC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;SAC7B;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IAC1B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAUX;AAVD,WAAY,cAAc;IACxB;;OAEG;IACH,6DAAa,CAAA;IAEb;;OAEG;IACH,2DAAQ,CAAA;AACV,CAAC,EAVW,cAAc,KAAd,cAAc,QAUzB"}

package/dist/src/upgrader.d.ts

@@ -1,157 +1,77 @@
-export = Upgrader;
-/**
- * @typedef {import('libp2p-interfaces/src/transport/types').MultiaddrConnection} MultiaddrConnection
- * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxerFactory} MuxerFactory
- * @typedef {import('libp2p-interfaces/src/stream-muxer/types').Muxer} Muxer
- * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxedStream} MuxedStream
- * @typedef {import('libp2p-interfaces/src/crypto/types').Crypto} Crypto
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('multiaddr').Multiaddr} Multiaddr
- * @typedef {import('./types').ConnectionGater} ConnectionGater
- */
-/**
- * @typedef CryptoResult
- * @property {MultiaddrConnection} conn A duplex iterable
- * @property {PeerId} remotePeer
- * @property {string} protocol
- */
-declare class Upgrader {
-    /**
-     * @param {object} options
-     * @param {PeerId} options.localPeer
-     * @param {ConnectionGater} options.connectionGater
-     *
-     * @param {import('./metrics')} [options.metrics]
-     * @param {Map<string, Crypto>} [options.cryptos]
-     * @param {Map<string, MuxerFactory>} [options.muxers]
-     * @param {(connection: Connection) => void} options.onConnection - Called when a connection is upgraded
-     * @param {(connection: Connection) => void} options.onConnectionEnd
-     */
-    constructor({ localPeer, metrics, connectionGater, cryptos, muxers, onConnectionEnd, onConnection }: {
-        localPeer: PeerId;
-        connectionGater: ConnectionGater;
-        metrics?: import("./metrics") | undefined;
-        cryptos?: Map<string, import("libp2p-interfaces/src/crypto/types").Crypto> | undefined;
-        muxers?: Map<string, import("libp2p-interfaces/src/stream-muxer/types").MuxerFactory> | undefined;
-        onConnection: (connection: Connection) => void;
-        onConnectionEnd: (connection: Connection) => void;
-    });
-    connectionGater: import("./types").ConnectionGater;
-    localPeer: PeerId;
-    metrics: import("./metrics") | undefined;
-    cryptos: Map<string, import("libp2p-interfaces/src/crypto/types").Crypto>;
-    muxers: Map<string, import("libp2p-interfaces/src/stream-muxer/types").MuxerFactory>;
-    /** @type {import("./pnet") | null} */
-    protector: import("./pnet") | null;
-    protocols: Map<any, any>;
-    onConnection: (connection: Connection) => void;
-    onConnectionEnd: (connection: Connection) => void;
+import { EventEmitter } from '@libp2p/interfaces';
+import type { Connection, Stream } from '@libp2p/interfaces/connection';
+import type { ConnectionEncrypter, SecuredConnection } from '@libp2p/interfaces/connection-encrypter';
+import type { StreamMuxerFactory } from '@libp2p/interfaces/stream-muxer';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { MultiaddrConnection, Upgrader, UpgraderEvents } from '@libp2p/interfaces/transport';
+import type { Duplex } from 'it-stream-types';
+import type { Components } from '@libp2p/interfaces/components';
+interface CreateConectionOptions {
+    cryptoProtocol: string;
+    direction: 'inbound' | 'outbound';
+    maConn: MultiaddrConnection;
+    upgradedConn: Duplex<Uint8Array>;
+    remotePeer: PeerId;
+    muxerFactory?: StreamMuxerFactory;
+}
+interface OnStreamOptions {
+    connection: Connection;
+    stream: Stream;
+    protocol: string;
+}
+export interface CryptoResult extends SecuredConnection {
+    protocol: string;
+}
+export interface UpgraderInit {
+    connectionEncryption: ConnectionEncrypter[];
+    muxers: StreamMuxerFactory[];
+}
+export declare class DefaultUpgrader extends EventEmitter<UpgraderEvents> implements Upgrader {
+    private readonly components;
+    private readonly connectionEncryption;
+    private readonly muxers;
+    constructor(components: Components, init: UpgraderInit);
     /**
      * Upgrades an inbound connection
-     *
-     * @async
-     * @param {MultiaddrConnection} maConn
-     * @returns {Promise<Connection>}
      */
     upgradeInbound(maConn: MultiaddrConnection): Promise<Connection>;
     /**
      * Upgrades an outbound connection
-     *
-     * @async
-     * @param {MultiaddrConnection} maConn
-     * @returns {Promise<Connection>}
      */
     upgradeOutbound(maConn: MultiaddrConnection): Promise<Connection>;
     /**
      * A convenience method for generating a new `Connection`
-     *
-     * @private
-     * @param {object} options
-     * @param {string} options.cryptoProtocol - The crypto protocol that was negotiated
-     * @param {'inbound' | 'outbound'} options.direction - One of ['inbound', 'outbound']
-     * @param {MultiaddrConnection} options.maConn - The transport layer connection
-     * @param {MuxedStream | MultiaddrConnection} options.upgradedConn - A duplex connection returned from multiplexer and/or crypto selection
-     * @param {MuxerFactory} [options.Muxer] - The muxer to be used for muxing
-     * @param {PeerId} options.remotePeer - The peer the connection is with
-     * @returns {Connection}
      */
-    private _createConnection;
+    _createConnection(opts: CreateConectionOptions): Connection;
     /**
      * Routes incoming streams to the correct handler
-     *
-     * @private
-     * @param {object} options
-     * @param {Connection} options.connection - The connection the stream belongs to
-     * @param {MuxedStream} options.stream
-     * @param {string} options.protocol
      */
-    private _onStream;
+    _onStream(opts: OnStreamOptions): void;
     /**
-     * Attempts to encrypt the incoming `connection` with the provided `cryptos`.
-     *
-     * @private
-     * @async
-     * @param {PeerId} localPeer - The initiators PeerId
-     * @param {*} connection
-     * @param {Map<string, Crypto>} cryptos
-     * @returns {Promise<CryptoResult>} An encrypted connection, remote peer `PeerId` and the protocol of the `Crypto` used
+     * Attempts to encrypt the incoming `connection` with the provided `cryptos`
      */
-    private _encryptInbound;
+    _encryptInbound(connection: Duplex<Uint8Array>): Promise<CryptoResult>;
     /**
-     * Attempts to encrypt the given `connection` with the provided `cryptos`.
-     * The first `Crypto` module to succeed will be used
-     *
-     * @private
-     * @async
-     * @param {PeerId} localPeer - The initiators PeerId
-     * @param {MultiaddrConnection} connection
-     * @param {PeerId} remotePeerId
-     * @param {Map<string, Crypto>} cryptos
-     * @returns {Promise<CryptoResult>} An encrypted connection, remote peer `PeerId` and the protocol of the `Crypto` used
+     * Attempts to encrypt the given `connection` with the provided connection encrypters.
+     * The first `ConnectionEncrypter` module to succeed will be used
      */
-    private _encryptOutbound;
+    _encryptOutbound(connection: MultiaddrConnection, remotePeerId: PeerId): Promise<CryptoResult>;
     /**
      * Selects one of the given muxers via multistream-select. That
      * muxer will be used for all future streams on the connection.
-     *
-     * @private
-     * @async
-     * @param {MultiaddrConnection} connection - A basic duplex connection to multiplex
-     * @param {Map<string, MuxerFactory>} muxers - The muxers to attempt multiplexing with
-     * @returns {Promise<{ stream: MuxedStream, Muxer?: MuxerFactory}>} A muxed connection
      */
-    private _multiplexOutbound;
+    _multiplexOutbound(connection: MultiaddrConnection, muxers: Map<string, StreamMuxerFactory>): Promise<{
+        stream: Duplex<Uint8Array>;
+        muxerFactory?: StreamMuxerFactory;
+    }>;
     /**
      * Registers support for one of the given muxers via multistream-select. The
      * selected muxer will be used for all future streams on the connection.
-     *
-     * @private
-     * @async
-     * @param {MultiaddrConnection} connection - A basic duplex connection to multiplex
-     * @param {Map<string, MuxerFactory>} muxers - The muxers to attempt multiplexing with
-     * @returns {Promise<{ stream: MuxedStream, Muxer?: MuxerFactory}>} A muxed connection
      */
-    private _multiplexInbound;
+    _multiplexInbound(connection: MultiaddrConnection, muxers: Map<string, StreamMuxerFactory>): Promise<{
+        stream: Duplex<Uint8Array>;
+        muxerFactory?: StreamMuxerFactory;
+    }>;
 }
-declare namespace Upgrader {
-    export { MultiaddrConnection, MuxerFactory, Muxer, MuxedStream, Crypto, Connection, Multiaddr, ConnectionGater, CryptoResult };
-}
-import PeerId = require("peer-id");
-type MultiaddrConnection = import('libp2p-interfaces/src/transport/types').MultiaddrConnection;
-import { Connection } from "libp2p-interfaces/src/connection";
-type ConnectionGater = import('./types').ConnectionGater;
-type MuxerFactory = import('libp2p-interfaces/src/stream-muxer/types').MuxerFactory;
-type Muxer = import('libp2p-interfaces/src/stream-muxer/types').Muxer;
-type MuxedStream = import('libp2p-interfaces/src/stream-muxer/types').MuxedStream;
-type Crypto = import('libp2p-interfaces/src/crypto/types').Crypto;
-type Connection = import("libp2p-interfaces/src/connection/connection");
-type Multiaddr = import('multiaddr').Multiaddr;
-type CryptoResult = {
-    /**
-     * A duplex iterable
-     */
-    conn: MultiaddrConnection;
-    remotePeer: PeerId;
-    protocol: string;
-};
+export {};
 //# sourceMappingURL=upgrader.d.ts.map

package/dist/src/upgrader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upgrader.d.ts","sourceRoot":"","sources":["../../src/upgrader.js"],"names":[],"mappings":";AAgBA;;;;;;;;;GASG;AAEH;;;;;GAKG;AAEH;IACE;;;;;;;;;;OAUG;IACH;mBATW,MAAM;yBACN,eAAe;;;;mCAKF,UAAU,KAAK,IAAI;sCACnB,UAAU,KAAK,IAAI;OAqB1C;IAVC,mDAAsC;IACtC,kBAA0B;IAC1B,yCAAsB;IACtB,0EAAsB;IACtB,qFAAoB;IACpB,sCAAsC;IACtC,WADW,OAAO,QAAQ,CAAC,GAAG,IAAI,CACb;IACrB,yBAA0B;IAC1B,2BApBsB,UAAU,KAAK,IAAI,CAoBT;IAChC,8BApBsB,UAAU,KAAK,IAAI,CAoBH;IAGxC;;;;;;OAMG;IACH,uBAHW,mBAAmB,GACjB,QAAQ,UAAU,CAAC,CAyE/B;IAED;;;;;;OAMG;IACH,wBAHW,mBAAmB,GACjB,QAAQ,UAAU,CAAC,CAgF/B;IAED;;;;;;;;;;;;OAYG;IACH,0BAgHC;IAED;;;;;;;;OAQG;IACH,kBAGC;IAED;;;;;;;;;OASG;IACH,wBAqBC;IAED;;;;;;;;;;;OAWG;IACH,yBAqBC;IAED;;;;;;;;;OASG;IACH,2BAYC;IAED;;;;;;;;;OASG;IACH,0BAWC;CACF;;;;;2BAxdY,OAAO,uCAAuC,EAAE,mBAAmB;;uBAOnE,OAAO,SAAS,EAAE,eAAe;oBANjC,OAAO,0CAA0C,EAAE,YAAY;aAC/D,OAAO,0CAA0C,EAAE,KAAK;mBACxD,OAAO,0CAA0C,EAAE,WAAW;cAC9D,OAAO,oCAAoC,EAAE,MAAM;;iBAEnD,OAAO,WAAW,EAAE,SAAS;;;;;UAM5B,mBAAmB;gBACnB,MAAM;cACN,MAAM"}
+{"version":3,"file":"upgrader.d.ts","sourceRoot":"","sources":["../../src/upgrader.ts"],"names":[],"mappings":"AAQA,OAAO,EAAe,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAE9D,OAAO,KAAK,EAAE,UAAU,EAAkB,MAAM,EAAE,MAAM,+BAA+B,CAAA;AACvF,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAA;AACrG,OAAO,KAAK,EAAe,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AACtF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AACjG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAI/D,UAAU,sBAAsB;IAC9B,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,SAAS,GAAG,UAAU,CAAA;IACjC,MAAM,EAAE,mBAAmB,CAAA;IAC3B,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,kBAAkB,CAAA;CAClC;AAED,UAAU,eAAe;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,oBAAoB,EAAE,mBAAmB,EAAE,CAAA;IAC3C,MAAM,EAAE,kBAAkB,EAAE,CAAA;CAC7B;AAED,qBAAa,eAAgB,SAAQ,YAAY,CAAC,cAAc,CAAE,YAAW,QAAQ;IACnF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAkC;IACvE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiC;gBAE3C,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY;IAiBvD;;OAEG;IACG,cAAc,CAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAwFvE;;OAEG;IACG,eAAe,CAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IA8FxE;;OAEG;IACH,iBAAiB,CAAE,IAAI,EAAE,sBAAsB,GAAG,UAAU;IA6I5D;;OAEG;IACH,SAAS,CAAE,IAAI,EAAE,eAAe,GAAG,IAAI;IAMvC;;OAEG;IACG,eAAe,CAAE,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IAwB7E;;;OAGG;IACG,gBAAgB,CAAE,UAAU,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAwBrG;;;OAGG;IACG,kBAAkB,CAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;KAAC,CAAC;IAe9K;;;OAGG;IACG,iBAAiB,CAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;KAAC,CAAC;CAa9K"}