@libp2p/dcutr 0.0.0-97ab31c0c

package/dist/src/dcutr.js

@@ -0,0 +1,312 @@
+import { CodeError, ERR_INVALID_MESSAGE } from '@libp2p/interface/errors';
+import { multiaddr } from '@multiformats/multiaddr';
+import delay from 'delay';
+import { pbStream } from 'it-protobuf-stream';
+import { HolePunch } from './pb/message.js';
+import { isPublicAndDialable } from './utils.js';
+import { multicodec } from './index.js';
+// https://github.com/libp2p/specs/blob/master/relay/DCUtR.md#rpc-messages
+const MAX_DCUTR_MESSAGE_SIZE = 1024 * 4;
+// ensure the dial has a high priority to jump to the head of the dial queue
+const DCUTR_DIAL_PRIORITY = 100;
+const defaultValues = {
+    // https://github.com/libp2p/go-libp2p/blob/8d2e54e1637041d5cf4fac1e531287560bd1f4ac/p2p/protocol/holepunch/holepuncher.go#L27
+    timeout: 5000,
+    // https://github.com/libp2p/go-libp2p/blob/8d2e54e1637041d5cf4fac1e531287560bd1f4ac/p2p/protocol/holepunch/holepuncher.go#L28
+    retries: 3,
+    maxInboundStreams: 1,
+    maxOutboundStreams: 1
+};
+export class DefaultDCUtRService {
+    started;
+    timeout;
+    retries;
+    maxInboundStreams;
+    maxOutboundStreams;
+    peerStore;
+    registrar;
+    connectionManager;
+    addressManager;
+    transportManager;
+    topologyId;
+    log;
+    constructor(components, init) {
+        this.log = components.logger.forComponent('libp2p:dcutr');
+        this.started = false;
+        this.peerStore = components.peerStore;
+        this.registrar = components.registrar;
+        this.addressManager = components.addressManager;
+        this.connectionManager = components.connectionManager;
+        this.transportManager = components.transportManager;
+        this.timeout = init.timeout ?? defaultValues.timeout;
+        this.retries = init.retries ?? defaultValues.retries;
+        this.maxInboundStreams = init.maxInboundStreams ?? defaultValues.maxInboundStreams;
+        this.maxOutboundStreams = init.maxOutboundStreams ?? defaultValues.maxOutboundStreams;
+    }
+    isStarted() {
+        return this.started;
+    }
+    async start() {
+        if (this.started) {
+            return;
+        }
+        // register for notifications of when peers that support DCUtR connect
+        // nb. requires the identify service to be enabled
+        this.topologyId = await this.registrar.register(multicodec, {
+            notifyOnTransient: true,
+            onConnect: (peerId, connection) => {
+                if (!connection.transient) {
+                    // the connection is already direct, no upgrade is required
+                    return;
+                }
+                // the inbound peer starts the connection upgrade
+                if (connection.direction !== 'inbound') {
+                    return;
+                }
+                this.upgradeInbound(connection)
+                    .catch(err => {
+                    this.log.error('error during outgoing DCUtR attempt', err);
+                });
+            }
+        });
+        await this.registrar.handle(multicodec, (data) => {
+            void this.handleIncomingUpgrade(data.stream, data.connection).catch(err => {
+                this.log.error('error during incoming DCUtR attempt', err);
+                data.stream.abort(err);
+            });
+        }, {
+            maxInboundStreams: this.maxInboundStreams,
+            maxOutboundStreams: this.maxOutboundStreams,
+            runOnTransientConnection: true
+        });
+        this.started = true;
+    }
+    async stop() {
+        await this.registrar.unhandle(multicodec);
+        if (this.topologyId != null) {
+            this.registrar.unregister(this.topologyId);
+        }
+        this.started = false;
+    }
+    /**
+     * Perform the inbound connection upgrade as B
+     *
+     * @see https://github.com/libp2p/specs/blob/master/relay/DCUtR.md#the-protocol
+     */
+    async upgradeInbound(relayedConnection) {
+        // Upon observing the new connection, the inbound peer (here B) checks the
+        // addresses advertised by A via identify.
+        //
+        // If that set includes public addresses, then A may be reachable by a direct
+        // connection, in which case B attempts a unilateral connection upgrade by
+        // initiating a direct connection to A.
+        if (await this.attemptUnilateralConnectionUpgrade(relayedConnection)) {
+            return;
+        }
+        let stream;
+        for (let i = 0; i < this.retries; i++) {
+            const options = {
+                signal: AbortSignal.timeout(this.timeout)
+            };
+            try {
+                // 1. B opens a stream to A using the /libp2p/dcutr protocol.
+                stream = await relayedConnection.newStream([multicodec], {
+                    signal: options.signal,
+                    runOnTransientConnection: true
+                });
+                const pb = pbStream(stream, {
+                    maxDataLength: MAX_DCUTR_MESSAGE_SIZE
+                }).pb(HolePunch);
+                // 2. B sends to A a Connect message containing its observed (and
+                // possibly predicted) addresses from identify and starts a timer
+                // to measure RTT of the relay connection.
+                this.log('B sending connect to %p', relayedConnection.remotePeer);
+                const connectTimer = Date.now();
+                await pb.write({
+                    type: HolePunch.Type.CONNECT,
+                    observedAddresses: this.addressManager.getAddresses().map(ma => ma.bytes)
+                }, options);
+                this.log('B receiving connect from %p', relayedConnection.remotePeer);
+                // 4. Upon receiving the Connect, B sends a Sync message
+                const connect = await pb.read(options);
+                if (connect.type !== HolePunch.Type.CONNECT) {
+                    this.log('A sent wrong message type');
+                    throw new CodeError('DCUtR message type was incorrect', ERR_INVALID_MESSAGE);
+                }
+                const multiaddrs = this.getDialableMultiaddrs(connect.observedAddresses);
+                if (multiaddrs.length === 0) {
+                    this.log('A did not have any dialable multiaddrs');
+                    throw new CodeError('DCUtR connect message had no multiaddrs', ERR_INVALID_MESSAGE);
+                }
+                const rtt = Date.now() - connectTimer;
+                this.log('A sending sync, rtt %dms', rtt);
+                await pb.write({
+                    type: HolePunch.Type.SYNC,
+                    observedAddresses: []
+                }, options);
+                this.log('A waiting for half RTT');
+                // ..and starts a timer for half the RTT measured from the time between
+                // sending the initial Connect and receiving the response
+                await delay(rtt / 2);
+                // TODO: when we have a QUIC transport, the dial step is different - for
+                // now we only have tcp support
+                // https://github.com/libp2p/specs/blob/master/relay/DCUtR.md#the-protocol
+                this.log('B dialing', multiaddrs);
+                // Upon expiry of the timer, B dials the address to A.
+                const conn = await this.connectionManager.openConnection(multiaddrs, {
+                    signal: options.signal,
+                    priority: DCUTR_DIAL_PRIORITY
+                });
+                this.log('DCUtR to %p succeeded to address %a, closing relayed connection', relayedConnection.remotePeer, conn.remoteAddr);
+                await relayedConnection.close(options);
+                break;
+            }
+            catch (err) {
+                this.log.error('error while attempting DCUtR on attempt %d of %d', i + 1, this.retries, err);
+                stream?.abort(err);
+                if (i === this.retries) {
+                    throw err;
+                }
+            }
+            finally {
+                if (stream != null) {
+                    await stream.close(options);
+                }
+            }
+        }
+    }
+    /**
+     * This is performed when A has dialed B via a relay but A also has a public
+     * address that B can dial directly
+     */
+    async attemptUnilateralConnectionUpgrade(relayedConnection) {
+        // Upon observing the new connection, the inbound peer (here B) checks the
+        // addresses advertised by A via identify.
+        const peerInfo = await this.peerStore.get(relayedConnection.remotePeer);
+        // If that set includes public addresses, then A may be reachable by a direct
+        // connection, in which case B attempts a unilateral connection upgrade by
+        // initiating a direct connection to A.
+        const publicAddresses = peerInfo.addresses
+            .map(address => {
+            const ma = address.multiaddr;
+            // ensure all multiaddrs have the peer id
+            if (ma.getPeerId() == null) {
+                return ma.encapsulate(`/p2p/${relayedConnection.remotePeer}`);
+            }
+            return ma;
+        })
+            .filter(ma => {
+            return isPublicAndDialable(ma, this.transportManager);
+        });
+        if (publicAddresses.length > 0) {
+            const signal = AbortSignal.timeout(this.timeout);
+            try {
+                this.log('attempting unilateral connection upgrade to %a', publicAddresses);
+                // force-dial the multiaddr(s), otherwise `connectionManager.openConnection`
+                // will return the existing relayed connection
+                const connection = await this.connectionManager.openConnection(publicAddresses, {
+                    signal,
+                    force: true
+                });
+                if (connection.transient) {
+                    throw new Error('Could not open a new, non-transient, connection');
+                }
+                this.log('unilateral connection upgrade to %p succeeded via %a, closing relayed connection', relayedConnection.remotePeer, connection.remoteAddr);
+                await relayedConnection.close({
+                    signal
+                });
+                return true;
+            }
+            catch (err) {
+                this.log.error('unilateral connection upgrade to %p on addresses %a failed', relayedConnection.remotePeer, publicAddresses, err);
+            }
+        }
+        else {
+            this.log('peer %p has no public addresses, not attempting unilateral connection upgrade', relayedConnection.remotePeer);
+        }
+        // no public addresses or failed to dial public addresses
+        return false;
+    }
+    /**
+     * Perform the connection upgrade as A
+     *
+     * @see https://github.com/libp2p/specs/blob/master/relay/DCUtR.md#the-protocol
+     */
+    async handleIncomingUpgrade(stream, relayedConnection) {
+        const options = {
+            signal: AbortSignal.timeout(this.timeout)
+        };
+        try {
+            const pb = pbStream(stream, {
+                maxDataLength: MAX_DCUTR_MESSAGE_SIZE
+            }).pb(HolePunch);
+            this.log('A receiving connect');
+            // 3. Upon receiving the Connect, A responds back with a Connect message
+            // containing its observed (and possibly predicted) addresses.
+            const connect = await pb.read(options);
+            if (connect.type !== HolePunch.Type.CONNECT) {
+                this.log('B sent wrong message type');
+                throw new CodeError('DCUtR message type was incorrect', ERR_INVALID_MESSAGE);
+            }
+            if (connect.observedAddresses.length === 0) {
+                this.log('B sent no multiaddrs');
+                throw new CodeError('DCUtR connect message had no multiaddrs', ERR_INVALID_MESSAGE);
+            }
+            const multiaddrs = this.getDialableMultiaddrs(connect.observedAddresses);
+            if (multiaddrs.length === 0) {
+                this.log('B had no dialable multiaddrs');
+                throw new CodeError('DCUtR connect message had no dialable multiaddrs', ERR_INVALID_MESSAGE);
+            }
+            this.log('A sending connect');
+            await pb.write({
+                type: HolePunch.Type.CONNECT,
+                observedAddresses: this.addressManager.getAddresses().map(ma => ma.bytes)
+            });
+            this.log('A receiving sync');
+            const sync = await pb.read(options);
+            if (sync.type !== HolePunch.Type.SYNC) {
+                throw new CodeError('DCUtR message type was incorrect', ERR_INVALID_MESSAGE);
+            }
+            // TODO: when we have a QUIC transport, the dial step is different - for
+            // now we only have tcp support
+            // https://github.com/libp2p/specs/blob/master/relay/DCUtR.md#the-protocol
+            // Upon receiving the Sync, A immediately dials the address to B
+            this.log('A dialing', multiaddrs);
+            const connection = await this.connectionManager.openConnection(multiaddrs, {
+                signal: options.signal,
+                priority: DCUTR_DIAL_PRIORITY,
+                force: true
+            });
+            this.log('DCUtR to %p succeeded via %a, closing relayed connection', relayedConnection.remotePeer, connection.remoteAddr);
+            await relayedConnection.close(options);
+        }
+        catch (err) {
+            this.log.error('incoming DCUtR from %p failed', relayedConnection.remotePeer, err);
+            stream.abort(err);
+        }
+        finally {
+            await stream.close(options);
+        }
+    }
+    /**
+     * Takes the `addr` and converts it to a Multiaddr if possible
+     */
+    getDialableMultiaddrs(addrs) {
+        const output = [];
+        for (const addr of addrs) {
+            if (addr == null || addr.length === 0) {
+                continue;
+            }
+            try {
+                const ma = multiaddr(addr);
+                if (!isPublicAndDialable(ma, this.transportManager)) {
+                    continue;
+                }
+                output.push(ma);
+            }
+            catch { }
+        }
+        return output;
+    }
+}
+//# sourceMappingURL=dcutr.js.map

package/dist/src/dcutr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dcutr.js","sourceRoot":"","sources":["../../src/dcutr.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACzE,OAAO,EAAkB,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnE,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAWvC,0EAA0E;AAC1E,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,CAAA;AACvC,4EAA4E;AAC5E,MAAM,mBAAmB,GAAG,GAAG,CAAA;AAE/B,MAAM,aAAa,GAAG;IACpB,8HAA8H;IAC9H,OAAO,EAAE,IAAI;IACb,8HAA8H;IAC9H,OAAO,EAAE,CAAC;IACV,iBAAiB,EAAE,CAAC;IACpB,kBAAkB,EAAE,CAAC;CACtB,CAAA;AAED,MAAM,OAAO,mBAAmB;IACtB,OAAO,CAAS;IACP,OAAO,CAAQ;IACf,OAAO,CAAQ;IACf,iBAAiB,CAAQ;IACzB,kBAAkB,CAAQ;IAC1B,SAAS,CAAW;IACpB,SAAS,CAAW;IACpB,iBAAiB,CAAmB;IACpC,cAAc,CAAgB;IAC9B,gBAAgB,CAAkB;IAC3C,UAAU,CAAS;IACV,GAAG,CAAQ;IAE5B,YAAa,UAAkC,EAAE,IAAsB;QACrE,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;QACzD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAA;QACrD,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAA;QAEnD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAA;QACpD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO,CAAA;QACpD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,aAAa,CAAC,iBAAiB,CAAA;QAClF,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,aAAa,CAAC,kBAAkB,CAAA;IACvF,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAM;SACP;QAED,sEAAsE;QACtE,kDAAkD;QAClD,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE;YAC1D,iBAAiB,EAAE,IAAI;YACvB,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE;gBAChC,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE;oBACzB,2DAA2D;oBAC3D,OAAM;iBACP;gBAED,iDAAiD;gBACjD,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE;oBACtC,OAAM;iBACP;gBAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;qBAC5B,KAAK,CAAC,GAAG,CAAC,EAAE;oBACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAA;gBAC5D,CAAC,CAAC,CAAA;YACN,CAAC;SACF,CAAC,CAAA;QAEF,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;YAC/C,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACxE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAA;gBAC1D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACxB,CAAC,CAAC,CAAA;QACJ,CAAC,EAAE;YACD,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,wBAAwB,EAAE,IAAI;SAC/B,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAEzC,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;SAC3C;QAED,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAE,iBAA6B;QACjD,0EAA0E;QAC1E,0CAA0C;QAC1C,EAAE;QACF,6EAA6E;QAC7E,0EAA0E;QAC1E,uCAAuC;QACvC,IAAI,MAAM,IAAI,CAAC,kCAAkC,CAAC,iBAAiB,CAAC,EAAE;YACpE,OAAM;SACP;QAED,IAAI,MAA0B,CAAA;QAE9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG;gBACd,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;aAC1C,CAAA;YAED,IAAI;gBACF,6DAA6D;gBAC7D,MAAM,GAAG,MAAM,iBAAiB,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,EAAE;oBACvD,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,wBAAwB,EAAE,IAAI;iBAC/B,CAAC,CAAA;gBAEF,MAAM,EAAE,GAAG,QAAQ,CAAC,MAAM,EAAE;oBAC1B,aAAa,EAAE,sBAAsB;iBACtC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAA;gBAEhB,iEAAiE;gBACjE,iEAAiE;gBACjE,0CAA0C;gBAC1C,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAA;gBACjE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;gBAC/B,MAAM,EAAE,CAAC,KAAK,CAAC;oBACb,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,OAAO;oBAC5B,iBAAiB,EAAE,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;iBAC1E,EAAE,OAAO,CAAC,CAAA;gBAEX,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAA;gBACrE,wDAAwD;gBACxD,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;gBAEtC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE;oBAC3C,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAA;oBACrC,MAAM,IAAI,SAAS,CAAC,kCAAkC,EAAE,mBAAmB,CAAC,CAAA;iBAC7E;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;gBAExE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC3B,IAAI,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAA;oBAClD,MAAM,IAAI,SAAS,CAAC,yCAAyC,EAAE,mBAAmB,CAAC,CAAA;iBACpF;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,YAAY,CAAA;gBAErC,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;gBACzC,MAAM,EAAE,CAAC,KAAK,CAAC;oBACb,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;oBACzB,iBAAiB,EAAE,EAAE;iBACtB,EAAE,OAAO,CAAC,CAAA;gBAEX,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;gBAClC,uEAAuE;gBACvE,yDAAyD;gBACzD,MAAM,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;gBAEpB,wEAAwE;gBACxE,+BAA+B;gBAC/B,0EAA0E;gBAE1E,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;gBACjC,sDAAsD;gBACtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,UAAU,EAAE;oBACnE,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,QAAQ,EAAE,mBAAmB;iBAC9B,CAAC,CAAA;gBAEF,IAAI,CAAC,GAAG,CAAC,iEAAiE,EAAE,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;gBAC1H,MAAM,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBAEtC,MAAK;aACN;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kDAAkD,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;gBAC5F,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;gBAElB,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE;oBACtB,MAAM,GAAG,CAAA;iBACV;aACF;oBAAS;gBACR,IAAI,MAAM,IAAI,IAAI,EAAE;oBAClB,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;iBAC5B;aACF;SACF;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kCAAkC,CAAE,iBAA6B;QACrE,0EAA0E;QAC1E,0CAA0C;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAA;QAEvE,6EAA6E;QAC7E,0EAA0E;QAC1E,uCAAuC;QACvC,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS;aACvC,GAAG,CAAC,OAAO,CAAC,EAAE;YACb,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAA;YAE5B,yCAAyC;YACzC,IAAI,EAAE,CAAC,SAAS,EAAE,IAAI,IAAI,EAAE;gBAC1B,OAAO,EAAE,CAAC,WAAW,CAAC,QAAQ,iBAAiB,CAAC,UAAU,EAAE,CAAC,CAAA;aAC9D;YAED,OAAO,EAAE,CAAA;QACX,CAAC,CAAC;aACD,MAAM,CAAC,EAAE,CAAC,EAAE;YACX,OAAO,mBAAmB,CAAC,EAAE,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACvD,CAAC,CAAC,CAAA;QAEJ,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9B,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAEhD,IAAI;gBACF,IAAI,CAAC,GAAG,CAAC,gDAAgD,EAAE,eAAe,CAAC,CAAA;gBAE3E,4EAA4E;gBAC5E,8CAA8C;gBAC9C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,eAAe,EAAE;oBAC9E,MAAM;oBACN,KAAK,EAAE,IAAI;iBACZ,CAAC,CAAA;gBAEF,IAAI,UAAU,CAAC,SAAS,EAAE;oBACxB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;iBACnE;gBAED,IAAI,CAAC,GAAG,CAAC,kFAAkF,EAAE,iBAAiB,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;gBAEjJ,MAAM,iBAAiB,CAAC,KAAK,CAAC;oBAC5B,MAAM;iBACP,CAAC,CAAA;gBAEF,OAAO,IAAI,CAAA;aACZ;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4DAA4D,EAAE,iBAAiB,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,CAAC,CAAA;aACjI;SACF;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,+EAA+E,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAA;SACxH;QAED,yDAAyD;QACzD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB,CAAE,MAAc,EAAE,iBAA6B;QACxE,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;SAC1C,CAAA;QAED,IAAI;YACF,MAAM,EAAE,GAAG,QAAQ,CAAC,MAAM,EAAE;gBAC1B,aAAa,EAAE,sBAAsB;aACtC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAA;YAEhB,IAAI,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;YAC/B,wEAAwE;YACxE,8DAA8D;YAC9D,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAEtC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE;gBAC3C,IAAI,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAA;gBACrC,MAAM,IAAI,SAAS,CAAC,kCAAkC,EAAE,mBAAmB,CAAC,CAAA;aAC7E;YAED,IAAI,OAAO,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1C,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;gBAChC,MAAM,IAAI,SAAS,CAAC,yCAAyC,EAAE,mBAAmB,CAAC,CAAA;aACpF;YAED,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;YAExE,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,IAAI,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAA;gBACxC,MAAM,IAAI,SAAS,CAAC,kDAAkD,EAAE,mBAAmB,CAAC,CAAA;aAC7F;YAED,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;YAC7B,MAAM,EAAE,CAAC,KAAK,CAAC;gBACb,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,OAAO;gBAC5B,iBAAiB,EAAE,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;aAC1E,CAAC,CAAA;YAEF,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;YAC5B,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAEnC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE;gBACrC,MAAM,IAAI,SAAS,CAAC,kCAAkC,EAAE,mBAAmB,CAAC,CAAA;aAC7E;YAED,wEAAwE;YACxE,+BAA+B;YAC/B,0EAA0E;YAE1E,gEAAgE;YAChE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;YACjC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,UAAU,EAAE;gBACzE,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,QAAQ,EAAE,mBAAmB;gBAC7B,KAAK,EAAE,IAAI;aACZ,CAAC,CAAA;YAEF,IAAI,CAAC,GAAG,CAAC,0DAA0D,EAAE,iBAAiB,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YACzH,MAAM,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SACvC;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,iBAAiB,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;YAClF,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;SAClB;gBAAS;YACR,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC5B;IACH,CAAC;IAED;;OAEG;IACH,qBAAqB,CAAE,KAAoD;QACzE,MAAM,MAAM,GAAG,EAAE,CAAA;QAEjB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;gBACrC,SAAQ;aACT;YAED,IAAI;gBACF,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;gBAE1B,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,IAAI,CAAC,gBAAgB,CAAC,EAAE;oBACnD,SAAQ;iBACT;gBAED,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;aAChB;YAAC,MAAM,GAAE;SACX;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF"}

package/dist/src/index.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @packageDocumentation
+ *
+ * Direct Connection Upgrade through Relay (DCUtR) is a protocol that allows two
+ * nodes to connect to each other who would otherwise be prevented doing so due
+ * to being behind NATed connections or firewalls.
+ *
+ * The protocol involves making a relayed connection between the two peers and
+ * using the relay to synchronise connection timings so that they dial each other
+ * at precisely the same moment.
+ *
+ * @example
+ *
+ * ```ts
+ * import { createLibp2p } from 'libp2p'
+ * import { circuitRelayTransport } from 'libp2p/circuit-relay'
+ * import { tcp } from '@libp2p/tcp'
+ * import { identify } from '@libp2p/identify'
+ * import { dcutr } from '@libp2p/dcutr'
+ *
+ * const node = await createLibp2p({
+ *   transports: [
+ *     circuitRelayTransport(),
+ *     tcp()
+ *   ],
+ *   services: {
+ *     identify: identify(),
+ *     dcutr: dcutr()
+ *   }
+ * })
+ *
+ * // QmTarget is a peer that is behind a NAT, supports TCP and has a relay
+ * // reservation
+ * await node.dial('/ip4/.../p2p/QmRelay/p2p-circuit/p2p/QmTarget')
+ *
+ * // after a while the connection should automatically get upgraded to a
+ * // direct connection (e.g. non-transient)
+ * while (true) {
+ *   const connections = node.getConnections()
+ *
+ *   if (connections.find(conn => conn.transient === false)) {
+ *     console.info('have direct connection')
+ *     break
+ *   } else {
+ *     console.info('have relayed connection')
+ *
+ *     // wait a few seconds to see if it's succeeded yet
+ *     await new Promise((resolve) => {
+ *       setTimeout(() => resolve(), 5000)
+ *     })
+ *   }
+ * }
+ * ```
+ */
+import type { ComponentLogger } from '@libp2p/interface';
+import type { PeerStore } from '@libp2p/interface/peer-store';
+import type { AddressManager } from '@libp2p/interface-internal/address-manager';
+import type { ConnectionManager } from '@libp2p/interface-internal/connection-manager';
+import type { Registrar } from '@libp2p/interface-internal/registrar';
+import type { TransportManager } from '@libp2p/interface-internal/transport-manager';
+export interface DCUtRServiceInit {
+    /**
+     * How long we should wait for the connection upgrade to complete (default: 5s)
+     */
+    timeout?: number;
+    /**
+     * How many times to retry the connection upgrade (default: 3)
+     */
+    retries?: number;
+    /**
+     * How many simultaneous inbound DCUtR protocol streams to allow on each
+     * connection (default: 1)
+     */
+    maxInboundStreams?: number;
+    /**
+     * How many simultaneous outbound DCUtR protocol streams to allow on each
+     * connection (default: 1)
+     */
+    maxOutboundStreams?: number;
+}
+export interface DCUtRServiceComponents {
+    peerStore: PeerStore;
+    connectionManager: ConnectionManager;
+    registrar: Registrar;
+    addressManager: AddressManager;
+    transportManager: TransportManager;
+    logger: ComponentLogger;
+}
+/**
+ * The DCUtR protocol
+ */
+export declare const multicodec = "/libp2p/dcutr";
+export declare function dcutr(init?: DCUtRServiceInit): (components: DCUtRServiceComponents) => unknown;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAChF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAA;AACtF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAA;AAEpF,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAA;IACpB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,SAAS,EAAE,SAAS,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,MAAM,EAAE,eAAe,CAAA;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,kBAAkB,CAAA;AAEzC,wBAAgB,KAAK,CAAE,IAAI,GAAE,gBAAqB,GAAG,CAAC,UAAU,EAAE,sBAAsB,KAAK,OAAO,CAEnG"}

package/dist/src/index.js

@@ -0,0 +1,63 @@
+/**
+ * @packageDocumentation
+ *
+ * Direct Connection Upgrade through Relay (DCUtR) is a protocol that allows two
+ * nodes to connect to each other who would otherwise be prevented doing so due
+ * to being behind NATed connections or firewalls.
+ *
+ * The protocol involves making a relayed connection between the two peers and
+ * using the relay to synchronise connection timings so that they dial each other
+ * at precisely the same moment.
+ *
+ * @example
+ *
+ * ```ts
+ * import { createLibp2p } from 'libp2p'
+ * import { circuitRelayTransport } from 'libp2p/circuit-relay'
+ * import { tcp } from '@libp2p/tcp'
+ * import { identify } from '@libp2p/identify'
+ * import { dcutr } from '@libp2p/dcutr'
+ *
+ * const node = await createLibp2p({
+ *   transports: [
+ *     circuitRelayTransport(),
+ *     tcp()
+ *   ],
+ *   services: {
+ *     identify: identify(),
+ *     dcutr: dcutr()
+ *   }
+ * })
+ *
+ * // QmTarget is a peer that is behind a NAT, supports TCP and has a relay
+ * // reservation
+ * await node.dial('/ip4/.../p2p/QmRelay/p2p-circuit/p2p/QmTarget')
+ *
+ * // after a while the connection should automatically get upgraded to a
+ * // direct connection (e.g. non-transient)
+ * while (true) {
+ *   const connections = node.getConnections()
+ *
+ *   if (connections.find(conn => conn.transient === false)) {
+ *     console.info('have direct connection')
+ *     break
+ *   } else {
+ *     console.info('have relayed connection')
+ *
+ *     // wait a few seconds to see if it's succeeded yet
+ *     await new Promise((resolve) => {
+ *       setTimeout(() => resolve(), 5000)
+ *     })
+ *   }
+ * }
+ * ```
+ */
+import { DefaultDCUtRService } from './dcutr.js';
+/**
+ * The DCUtR protocol
+ */
+export const multicodec = '/libp2p/dcutr';
+export function dcutr(init = {}) {
+    return (components) => new DefaultDCUtRService(components, init);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAyChD;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAA;AAEzC,MAAM,UAAU,KAAK,CAAE,OAAyB,EAAE;IAChD,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AAClE,CAAC"}

package/dist/src/pb/message.d.ts

@@ -0,0 +1,20 @@
+import type { Codec } from 'protons-runtime';
+import type { Uint8ArrayList } from 'uint8arraylist';
+export interface HolePunch {
+    type?: HolePunch.Type;
+    observedAddresses: Uint8Array[];
+}
+export declare namespace HolePunch {
+    enum Type {
+        UNUSED = "UNUSED",
+        CONNECT = "CONNECT",
+        SYNC = "SYNC"
+    }
+    namespace Type {
+        const codec: () => Codec<Type>;
+    }
+    const codec: () => Codec<HolePunch>;
+    const encode: (obj: Partial<HolePunch>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList) => HolePunch;
+}
+//# sourceMappingURL=message.d.ts.map

package/dist/src/pb/message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../src/pb/message.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC,IAAI,CAAA;IACrB,iBAAiB,EAAE,UAAU,EAAE,CAAA;CAChC;AAED,yBAAiB,SAAS,CAAC;IACzB,KAAY,IAAI;QACd,MAAM,WAAW;QACjB,OAAO,YAAY;QACnB,IAAI,SAAS;KACd;IAQD,UAAiB,IAAI,CAAC;QACb,MAAM,KAAK,QAAO,MAAM,IAAI,CAElC,CAAA;KACF;IAIM,MAAM,KAAK,QAAO,MAAM,SAAS,CAkDvC,CAAA;IAEM,MAAM,MAAM,QAAS,QAAQ,SAAS,CAAC,KAAG,UAEhD,CAAA;IAEM,MAAM,MAAM,QAAS,UAAU,GAAG,cAAc,KAAG,SAEzD,CAAA;CACF"}

package/dist/src/pb/message.js

@@ -0,0 +1,77 @@
+/* eslint-disable import/export */
+/* eslint-disable complexity */
+/* eslint-disable @typescript-eslint/no-namespace */
+/* eslint-disable @typescript-eslint/no-unnecessary-boolean-literal-compare */
+/* eslint-disable @typescript-eslint/no-empty-interface */
+import { enumeration, encodeMessage, decodeMessage, message } from 'protons-runtime';
+export var HolePunch;
+(function (HolePunch) {
+    let Type;
+    (function (Type) {
+        Type["UNUSED"] = "UNUSED";
+        Type["CONNECT"] = "CONNECT";
+        Type["SYNC"] = "SYNC";
+    })(Type = HolePunch.Type || (HolePunch.Type = {}));
+    let __TypeValues;
+    (function (__TypeValues) {
+        __TypeValues[__TypeValues["UNUSED"] = 0] = "UNUSED";
+        __TypeValues[__TypeValues["CONNECT"] = 100] = "CONNECT";
+        __TypeValues[__TypeValues["SYNC"] = 300] = "SYNC";
+    })(__TypeValues || (__TypeValues = {}));
+    (function (Type) {
+        Type.codec = () => {
+            return enumeration(__TypeValues);
+        };
+    })(Type = HolePunch.Type || (HolePunch.Type = {}));
+    let _codec;
+    HolePunch.codec = () => {
+        if (_codec == null) {
+            _codec = message((obj, w, opts = {}) => {
+                if (opts.lengthDelimited !== false) {
+                    w.fork();
+                }
+                if (obj.type != null) {
+                    w.uint32(8);
+                    HolePunch.Type.codec().encode(obj.type, w);
+                }
+                if (obj.observedAddresses != null) {
+                    for (const value of obj.observedAddresses) {
+                        w.uint32(18);
+                        w.bytes(value);
+                    }
+                }
+                if (opts.lengthDelimited !== false) {
+                    w.ldelim();
+                }
+            }, (reader, length) => {
+                const obj = {
+                    observedAddresses: []
+                };
+                const end = length == null ? reader.len : reader.pos + length;
+                while (reader.pos < end) {
+                    const tag = reader.uint32();
+                    switch (tag >>> 3) {
+                        case 1:
+                            obj.type = HolePunch.Type.codec().decode(reader);
+                            break;
+                        case 2:
+                            obj.observedAddresses.push(reader.bytes());
+                            break;
+                        default:
+                            reader.skipType(tag & 7);
+                            break;
+                    }
+                }
+                return obj;
+            });
+        }
+        return _codec;
+    };
+    HolePunch.encode = (obj) => {
+        return encodeMessage(obj, HolePunch.codec());
+    };
+    HolePunch.decode = (buf) => {
+        return decodeMessage(buf, HolePunch.codec());
+    };
+})(HolePunch || (HolePunch = {}));
+//# sourceMappingURL=message.js.map

package/dist/src/pb/message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../../../src/pb/message.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,+BAA+B;AAC/B,oDAAoD;AACpD,8EAA8E;AAC9E,0DAA0D;AAE1D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AASpF,MAAM,KAAW,SAAS,CAgFzB;AAhFD,WAAiB,SAAS;IACxB,IAAY,IAIX;IAJD,WAAY,IAAI;QACd,yBAAiB,CAAA;QACjB,2BAAmB,CAAA;QACnB,qBAAa,CAAA;IACf,CAAC,EAJW,IAAI,GAAJ,cAAI,KAAJ,cAAI,QAIf;IAED,IAAK,YAIJ;IAJD,WAAK,YAAY;QACf,mDAAU,CAAA;QACV,uDAAa,CAAA;QACb,iDAAU,CAAA;IACZ,CAAC,EAJI,YAAY,KAAZ,YAAY,QAIhB;IAED,WAAiB,IAAI;QACN,UAAK,GAAG,GAAgB,EAAE;YACrC,OAAO,WAAW,CAAO,YAAY,CAAC,CAAA;QACxC,CAAC,CAAA;IACH,CAAC,EAJgB,IAAI,GAAJ,cAAI,KAAJ,cAAI,QAIpB;IAED,IAAI,MAAwB,CAAA;IAEf,eAAK,GAAG,GAAqB,EAAE;QAC1C,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,MAAM,GAAG,OAAO,CAAY,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,GAAG,EAAE,EAAE,EAAE;gBAChD,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,EAAE;oBAClC,CAAC,CAAC,IAAI,EAAE,CAAA;iBACT;gBAED,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE;oBACpB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;oBACX,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;iBAC3C;gBAED,IAAI,GAAG,CAAC,iBAAiB,IAAI,IAAI,EAAE;oBACjC,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,iBAAiB,EAAE;wBACzC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;wBACZ,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;qBACf;iBACF;gBAED,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,EAAE;oBAClC,CAAC,CAAC,MAAM,EAAE,CAAA;iBACX;YACH,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;gBACpB,MAAM,GAAG,GAAQ;oBACf,iBAAiB,EAAE,EAAE;iBACtB,CAAA;gBAED,MAAM,GAAG,GAAG,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,CAAA;gBAE7D,OAAO,MAAM,CAAC,GAAG,GAAG,GAAG,EAAE;oBACvB,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,CAAA;oBAE3B,QAAQ,GAAG,KAAK,CAAC,EAAE;wBACjB,KAAK,CAAC;4BACJ,GAAG,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;4BAChD,MAAK;wBACP,KAAK,CAAC;4BACJ,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;4BAC1C,MAAK;wBACP;4BACE,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;4BACxB,MAAK;qBACR;iBACF;gBAED,OAAO,GAAG,CAAA;YACZ,CAAC,CAAC,CAAA;SACH;QAED,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;IAEY,gBAAM,GAAG,CAAC,GAAuB,EAAc,EAAE;QAC5D,OAAO,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAA;IAEY,gBAAM,GAAG,CAAC,GAAgC,EAAa,EAAE;QACpE,OAAO,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC,CAAA;IAC9C,CAAC,CAAA;AACH,CAAC,EAhFgB,SAAS,KAAT,SAAS,QAgFzB"}

package/dist/src/utils.d.ts

@@ -0,0 +1,8 @@
+import { type Multiaddr } from '@multiformats/multiaddr';
+import type { TransportManager } from '@libp2p/interface-internal/src/transport-manager';
+/**
+ * Returns true if the passed multiaddr is public, not relayed and we have a
+ * transport that can dial it
+ */
+export declare function isPublicAndDialable(ma: Multiaddr, transportManager: TransportManager): boolean;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAA;AAExF;;;GAGG;AACH,wBAAgB,mBAAmB,CAAE,EAAE,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAuB/F"}

package/dist/src/utils.js

@@ -0,0 +1,27 @@
+import {} from '@multiformats/multiaddr';
+import { Circuit, IP, DNS } from '@multiformats/multiaddr-matcher';
+import isPrivate from 'private-ip';
+/**
+ * Returns true if the passed multiaddr is public, not relayed and we have a
+ * transport that can dial it
+ */
+export function isPublicAndDialable(ma, transportManager) {
+    // ignore circuit relay
+    if (Circuit.matches(ma)) {
+        return false;
+    }
+    const transport = transportManager.transportForMultiaddr(ma);
+    if (transport == null) {
+        return false;
+    }
+    // dns addresses are probably public?
+    if (DNS.matches(ma)) {
+        return true;
+    }
+    // ensure we have only IPv4/IPv6 addresses
+    if (!IP.matches(ma)) {
+        return false;
+    }
+    return isPrivate(ma.toOptions().host) === false;
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAA;AAClE,OAAO,SAAS,MAAM,YAAY,CAAA;AAGlC;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAE,EAAa,EAAE,gBAAkC;IACpF,uBAAuB;IACvB,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;QACvB,OAAO,KAAK,CAAA;KACb;IAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;IAE5D,IAAI,SAAS,IAAI,IAAI,EAAE;QACrB,OAAO,KAAK,CAAA;KACb;IAED,qCAAqC;IACrC,IAAI,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;QACnB,OAAO,IAAI,CAAA;KACZ;IAED,0CAA0C;IAC1C,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;QACnB,OAAO,KAAK,CAAA;KACb;IAED,OAAO,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,CAAA;AACjD,CAAC"}