@libp2p/circuit-relay-v2 0.0.0-05b52d69c

package/dist/src/transport/discovery.js

@@ -0,0 +1,97 @@
+import { TypedEventEmitter } from '@libp2p/interface/events';
+import { RELAY_RENDEZVOUS_NS, RELAY_V2_HOP_CODEC } from '../constants.js';
+import { namespaceToCid } from '../utils.js';
+/**
+ * ReservationManager automatically makes a circuit v2 reservation on any connected
+ * peers that support the circuit v2 HOP protocol.
+ */
+export class RelayDiscovery extends TypedEventEmitter {
+    peerId;
+    peerStore;
+    contentRouting;
+    registrar;
+    started;
+    topologyId;
+    log;
+    constructor(components) {
+        super();
+        this.log = components.logger.forComponent('libp2p:circuit-relay:discover-relays');
+        this.started = false;
+        this.peerId = components.peerId;
+        this.peerStore = components.peerStore;
+        this.contentRouting = components.contentRouting;
+        this.registrar = components.registrar;
+    }
+    isStarted() {
+        return this.started;
+    }
+    async start() {
+        // register a topology listener for when new peers are encountered
+        // that support the hop protocol
+        this.topologyId = await this.registrar.register(RELAY_V2_HOP_CODEC, {
+            notifyOnTransient: true,
+            onConnect: (peerId) => {
+                this.safeDispatchEvent('relay:discover', { detail: peerId });
+            }
+        });
+        void this.discover()
+            .catch(err => {
+            this.log.error('error listening on relays', err);
+        });
+        this.started = true;
+    }
+    stop() {
+        if (this.topologyId != null) {
+            this.registrar.unregister(this.topologyId);
+        }
+        this.started = false;
+    }
+    /**
+     * Try to listen on available hop relay connections.
+     * The following order will happen while we do not have enough relays:
+     *
+     * 1. Check the metadata store for known relays, try to listen on the ones we are already connected
+     * 2. Dial and try to listen on the peers we know that support hop but are not connected
+     * 3. Search the network
+     */
+    async discover() {
+        this.log('searching peer store for relays');
+        const peers = (await this.peerStore.all({
+            filters: [
+                // filter by a list of peers supporting RELAY_V2_HOP and ones we are not listening on
+                (peer) => {
+                    return peer.protocols.includes(RELAY_V2_HOP_CODEC);
+                }
+            ],
+            orders: [
+                () => Math.random() < 0.5 ? 1 : -1
+            ]
+        }));
+        for (const peer of peers) {
+            this.log('found relay peer %p in content peer store', peer.id);
+            this.safeDispatchEvent('relay:discover', { detail: peer.id });
+        }
+        this.log('found %d relay peers in peer store', peers.length);
+        try {
+            this.log('searching content routing for relays');
+            const cid = await namespaceToCid(RELAY_RENDEZVOUS_NS);
+            let found = 0;
+            for await (const provider of this.contentRouting.findProviders(cid)) {
+                if (provider.multiaddrs.length > 0 && !provider.id.equals(this.peerId)) {
+                    const peerId = provider.id;
+                    found++;
+                    await this.peerStore.merge(peerId, {
+                        multiaddrs: provider.multiaddrs
+                    });
+                    this.log('found relay peer %p in content routing', peerId);
+                    this.safeDispatchEvent('relay:discover', { detail: peerId });
+                }
+            }
+            this.log('found %d relay peers in content routing', found);
+        }
+        catch (err) {
+            this.log.error('failed when finding relays on the network', err);
+        }
+    }
+}
+//# sourceMappingURL=discovery.js.map

package/dist/src/transport/discovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../../../src/transport/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAwB5C;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,iBAAuC;IACxD,MAAM,CAAQ;IACd,SAAS,CAAW;IACpB,cAAc,CAAgB;IAC9B,SAAS,CAAW;IAC7B,OAAO,CAAS;IAChB,UAAU,CAAS;IACV,GAAG,CAAQ;IAE5B,YAAa,UAAoC;QAC/C,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,sCAAsC,CAAC,CAAA;QACjF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;IACvC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,kEAAkE;QAClE,gCAAgC;QAChC,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE;YAClE,iBAAiB,EAAE,IAAI;YACvB,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE;gBACpB,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;YAC9D,CAAC;SACF,CAAC,CAAA;QAEF,KAAK,IAAI,CAAC,QAAQ,EAAE;aACjB,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;QAEJ,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,IAAI;QACF,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;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ;QACZ,IAAI,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;QAC3C,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;YACtC,OAAO,EAAE;gBACP,qFAAqF;gBACrF,CAAC,IAAI,EAAE,EAAE;oBACP,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAA;gBACpD,CAAC;aACF;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACnC;SACF,CAAC,CAAC,CAAA;QAEH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,CAAC,GAAG,CAAC,2CAA2C,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;YAC9D,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;SAC9D;QAED,IAAI,CAAC,GAAG,CAAC,oCAAoC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAE5D,IAAI;YACF,IAAI,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAA;YAChD,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,mBAAmB,CAAC,CAAA;YAErD,IAAI,KAAK,GAAG,CAAC,CAAA;YAEb,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;gBACnE,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBACtE,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAA;oBAE1B,KAAK,EAAE,CAAA;oBACP,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE;wBACjC,UAAU,EAAE,QAAQ,CAAC,UAAU;qBAChC,CAAC,CAAA;oBAEF,IAAI,CAAC,GAAG,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAA;oBAC1D,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;iBAC7D;aACF;YAED,IAAI,CAAC,GAAG,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAA;SAC3D;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,GAAG,CAAC,CAAA;SACjE;IACH,CAAC;CACF"}

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

@@ -0,0 +1,58 @@
+import { type Transport, type Upgrader } from '@libp2p/interface/transport';
+import { type RelayDiscoveryComponents } from './discovery.js';
+import { type RelayStoreInit } from './reservation-store.js';
+import type { Libp2pEvents, ComponentLogger } from '@libp2p/interface';
+import type { ConnectionGater } from '@libp2p/interface/connection-gater';
+import type { ContentRouting } from '@libp2p/interface/content-routing';
+import type { TypedEventTarget } from '@libp2p/interface/events';
+import type { PeerId } from '@libp2p/interface/peer-id';
+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';
+export interface CircuitRelayTransportComponents extends RelayDiscoveryComponents {
+    peerId: PeerId;
+    peerStore: PeerStore;
+    registrar: Registrar;
+    connectionManager: ConnectionManager;
+    upgrader: Upgrader;
+    addressManager: AddressManager;
+    contentRouting: ContentRouting;
+    connectionGater: ConnectionGater;
+    events: TypedEventTarget<Libp2pEvents>;
+    logger: ComponentLogger;
+}
+/**
+ * RelayConfig configures the circuit v2 relay transport.
+ */
+export interface CircuitRelayTransportInit extends RelayStoreInit {
+    /**
+     * The number of peers running diable relays to search for and
+     * connect to. (default: 0)
+     */
+    discoverRelays?: number;
+    /**
+     * The maximum number of simultaneous STOP inbound streams that can be open at
+     * once - each inbound relayed connection uses a STOP stream (default: 300)
+     */
+    maxInboundStopStreams?: number;
+    /**
+     * The maximum number of simultaneous STOP outbound streams that can be open at
+     * once. If this transport is used along with the relay server these settings
+     * should be set to the same value (default: 300)
+     */
+    maxOutboundStopStreams?: number;
+    /**
+     * Incoming STOP requests (e.g. when a remote peer wants to dial us via a relay)
+     * must finish the initial protocol negotiation within this timeout in ms
+     * (default: 30000)
+     */
+    stopTimeout?: number;
+    /**
+     * When creating a reservation it must complete within this number of ms
+     * (default: 10000)
+     */
+    reservationCompletionTimeout?: number;
+}
+export declare function circuitRelayTransport(init?: CircuitRelayTransportInit): (components: CircuitRelayTransportComponents) => Transport;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,KAAK,SAAS,EAA6C,KAAK,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAQ9H,OAAO,EAAkB,KAAK,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AAE9E,OAAO,EAAE,KAAK,cAAc,EAAoB,MAAM,wBAAwB,CAAA;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAgB,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAE5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AACzE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACvD,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,EAAsB,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAiBzF,MAAM,WAAW,+BAAgC,SAAQ,wBAAwB;IAC/E,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,SAAS,CAAA;IACpB,SAAS,EAAE,SAAS,CAAA;IACpB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,QAAQ,EAAE,QAAQ,CAAA;IAClB,cAAc,EAAE,cAAc,CAAA;IAC9B,cAAc,EAAE,cAAc,CAAA;IAC9B,eAAe,EAAE,eAAe,CAAA;IAChC,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAA;IACtC,MAAM,EAAE,eAAe,CAAA;CACxB;AAYD;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC/D;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAE/B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAA;CACtC;AA0SD,wBAAgB,qBAAqB,CAAE,IAAI,GAAE,yBAA8B,GAAG,CAAC,UAAU,EAAE,+BAA+B,KAAK,SAAS,CAIvI"}

package/dist/src/transport/index.js

@@ -0,0 +1,279 @@
+import { CodeError } from '@libp2p/interface/errors';
+import { symbol } from '@libp2p/interface/transport';
+import { peerIdFromBytes, peerIdFromString } from '@libp2p/peer-id';
+import { streamToMaConnection } from '@libp2p/utils/stream-to-ma-conn';
+import * as mafmt from '@multiformats/mafmt';
+import { multiaddr } from '@multiformats/multiaddr';
+import { pbStream } from 'it-protobuf-stream';
+import { CIRCUIT_PROTO_CODE, ERR_HOP_REQUEST_FAILED, ERR_RELAYED_DIAL, MAX_CONNECTIONS, RELAY_V2_HOP_CODEC, RELAY_V2_STOP_CODEC } from '../constants.js';
+import { StopMessage, HopMessage, Status } from '../pb/index.js';
+import { RelayDiscovery } from './discovery.js';
+import { createListener } from './listener.js';
+import { ReservationStore } from './reservation-store.js';
+const isValidStop = (request) => {
+    if (request.peer == null) {
+        return false;
+    }
+    try {
+        request.peer.addrs.forEach(multiaddr);
+    }
+    catch {
+        return false;
+    }
+    return true;
+};
+const defaults = {
+    maxInboundStopStreams: MAX_CONNECTIONS,
+    maxOutboundStopStreams: MAX_CONNECTIONS,
+    stopTimeout: 30000
+};
+class CircuitRelayTransport {
+    discovery;
+    registrar;
+    peerStore;
+    connectionManager;
+    peerId;
+    upgrader;
+    addressManager;
+    connectionGater;
+    reservationStore;
+    logger;
+    maxInboundStopStreams;
+    maxOutboundStopStreams;
+    stopTimeout;
+    started;
+    log;
+    constructor(components, init) {
+        this.log = components.logger.forComponent('libp2p:circuit-relay:transport');
+        this.registrar = components.registrar;
+        this.peerStore = components.peerStore;
+        this.connectionManager = components.connectionManager;
+        this.logger = components.logger;
+        this.peerId = components.peerId;
+        this.upgrader = components.upgrader;
+        this.addressManager = components.addressManager;
+        this.connectionGater = components.connectionGater;
+        this.maxInboundStopStreams = init.maxInboundStopStreams ?? defaults.maxInboundStopStreams;
+        this.maxOutboundStopStreams = init.maxOutboundStopStreams ?? defaults.maxOutboundStopStreams;
+        this.stopTimeout = init.stopTimeout ?? defaults.stopTimeout;
+        if (init.discoverRelays != null && init.discoverRelays > 0) {
+            this.discovery = new RelayDiscovery(components);
+            this.discovery.addEventListener('relay:discover', (evt) => {
+                this.reservationStore.addRelay(evt.detail, 'discovered')
+                    .catch(err => {
+                    this.log.error('could not add discovered relay %p', evt.detail, err);
+                });
+            });
+        }
+        this.reservationStore = new ReservationStore(components, init);
+        this.reservationStore.addEventListener('relay:not-enough-relays', () => {
+            this.discovery?.discover()
+                .catch(err => {
+                this.log.error('could not discover relays', err);
+            });
+        });
+        this.started = false;
+    }
+    isStarted() {
+        return this.started;
+    }
+    async start() {
+        await this.reservationStore.start();
+        await this.discovery?.start();
+        await this.registrar.handle(RELAY_V2_STOP_CODEC, (data) => {
+            void this.onStop(data).catch(err => {
+                this.log.error('error while handling STOP protocol', err);
+                data.stream.abort(err);
+            });
+        }, {
+            maxInboundStreams: this.maxInboundStopStreams,
+            maxOutboundStreams: this.maxOutboundStopStreams,
+            runOnTransientConnection: true
+        });
+        this.started = true;
+    }
+    async stop() {
+        this.discovery?.stop();
+        await this.reservationStore.stop();
+        await this.registrar.unhandle(RELAY_V2_STOP_CODEC);
+        this.started = false;
+    }
+    [symbol] = true;
+    [Symbol.toStringTag] = 'libp2p/circuit-relay-v2';
+    /**
+     * Dial a peer over a relay
+     */
+    async dial(ma, options = {}) {
+        if (ma.protoCodes().filter(code => code === CIRCUIT_PROTO_CODE).length !== 1) {
+            const errMsg = 'Invalid circuit relay address';
+            this.log.error(errMsg, ma);
+            throw new CodeError(errMsg, ERR_RELAYED_DIAL);
+        }
+        // Check the multiaddr to see if it contains a relay and a destination peer
+        const addrs = ma.toString().split('/p2p-circuit');
+        const relayAddr = multiaddr(addrs[0]);
+        const destinationAddr = multiaddr(addrs[addrs.length - 1]);
+        const relayId = relayAddr.getPeerId();
+        const destinationId = destinationAddr.getPeerId();
+        if (relayId == null || destinationId == null) {
+            const errMsg = `Circuit relay dial to ${ma.toString()} failed as address did not have peer ids`;
+            this.log.error(errMsg);
+            throw new CodeError(errMsg, ERR_RELAYED_DIAL);
+        }
+        const relayPeer = peerIdFromString(relayId);
+        const destinationPeer = peerIdFromString(destinationId);
+        let disconnectOnFailure = false;
+        const relayConnections = this.connectionManager.getConnections(relayPeer);
+        let relayConnection = relayConnections[0];
+        if (relayConnection == null) {
+            await this.peerStore.merge(relayPeer, {
+                multiaddrs: [relayAddr]
+            });
+            relayConnection = await this.connectionManager.openConnection(relayPeer, options);
+            disconnectOnFailure = true;
+        }
+        let stream;
+        try {
+            stream = await relayConnection.newStream([RELAY_V2_HOP_CODEC]);
+            return await this.connectV2({
+                stream,
+                connection: relayConnection,
+                destinationPeer,
+                destinationAddr,
+                relayAddr,
+                ma,
+                disconnectOnFailure
+            });
+        }
+        catch (err) {
+            this.log.error('circuit relay dial to destination %p via relay %p failed', destinationPeer, relayPeer, err);
+            if (stream != null) {
+                stream.abort(err);
+            }
+            disconnectOnFailure && await relayConnection.close();
+            throw err;
+        }
+    }
+    async connectV2({ stream, connection, destinationPeer, destinationAddr, relayAddr, ma, disconnectOnFailure }) {
+        try {
+            const pbstr = pbStream(stream);
+            const hopstr = pbstr.pb(HopMessage);
+            await hopstr.write({
+                type: HopMessage.Type.CONNECT,
+                peer: {
+                    id: destinationPeer.toBytes(),
+                    addrs: [multiaddr(destinationAddr).bytes]
+                }
+            });
+            const status = await hopstr.read();
+            if (status.status !== Status.OK) {
+                throw new CodeError(`failed to connect via relay with status ${status?.status?.toString() ?? 'undefined'}`, ERR_HOP_REQUEST_FAILED);
+            }
+            const maConn = streamToMaConnection({
+                stream: pbstr.unwrap(),
+                remoteAddr: ma,
+                localAddr: relayAddr.encapsulate(`/p2p-circuit/p2p/${this.peerId.toString()}`),
+                logger: this.logger
+            });
+            this.log('new outbound transient connection %a', maConn.remoteAddr);
+            return await this.upgrader.upgradeOutbound(maConn, {
+                transient: true
+            });
+        }
+        catch (err) {
+            this.log.error(`Circuit relay dial to destination ${destinationPeer.toString()} via relay ${connection.remotePeer.toString()} failed`, err);
+            disconnectOnFailure && await connection.close();
+            throw err;
+        }
+    }
+    /**
+     * Create a listener
+     */
+    createListener(options) {
+        return createListener({
+            connectionManager: this.connectionManager,
+            relayStore: this.reservationStore,
+            logger: this.logger
+        });
+    }
+    /**
+     * Filter check for all Multiaddrs that this transport can dial on
+     *
+     * @param {Multiaddr[]} multiaddrs
+     * @returns {Multiaddr[]}
+     */
+    filter(multiaddrs) {
+        multiaddrs = Array.isArray(multiaddrs) ? multiaddrs : [multiaddrs];
+        return multiaddrs.filter((ma) => {
+            return mafmt.Circuit.matches(ma);
+        });
+    }
+    /**
+     * An incoming STOP request means a remote peer wants to dial us via a relay
+     */
+    async onStop({ connection, stream }) {
+        const signal = AbortSignal.timeout(this.stopTimeout);
+        const pbstr = pbStream(stream).pb(StopMessage);
+        const request = await pbstr.read({
+            signal
+        });
+        this.log('new circuit relay v2 stop stream from %p with type %s', connection.remotePeer, request.type);
+        if (request?.type === undefined) {
+            this.log.error('type was missing from circuit v2 stop protocol request from %s', connection.remotePeer);
+            await pbstr.write({ type: StopMessage.Type.STATUS, status: Status.MALFORMED_MESSAGE }, {
+                signal
+            });
+            await stream.close();
+            return;
+        }
+        // Validate the STOP request has the required input
+        if (request.type !== StopMessage.Type.CONNECT) {
+            this.log.error('invalid stop connect request via peer %p', connection.remotePeer);
+            await pbstr.write({ type: StopMessage.Type.STATUS, status: Status.UNEXPECTED_MESSAGE }, {
+                signal
+            });
+            await stream.close();
+            return;
+        }
+        if (!isValidStop(request)) {
+            this.log.error('invalid stop connect request via peer %p', connection.remotePeer);
+            await pbstr.write({ type: StopMessage.Type.STATUS, status: Status.MALFORMED_MESSAGE }, {
+                signal
+            });
+            await stream.close();
+            return;
+        }
+        const remotePeerId = peerIdFromBytes(request.peer.id);
+        if ((await this.connectionGater.denyInboundRelayedConnection?.(connection.remotePeer, remotePeerId)) === true) {
+            this.log.error('connection gater denied inbound relayed connection from %p', connection.remotePeer);
+            await pbstr.write({ type: StopMessage.Type.STATUS, status: Status.PERMISSION_DENIED }, {
+                signal
+            });
+            await stream.close();
+            return;
+        }
+        this.log.trace('sending success response to %p', connection.remotePeer);
+        await pbstr.write({ type: StopMessage.Type.STATUS, status: Status.OK }, {
+            signal
+        });
+        const remoteAddr = connection.remoteAddr.encapsulate(`/p2p-circuit/p2p/${remotePeerId.toString()}`);
+        const localAddr = this.addressManager.getAddresses()[0];
+        const maConn = streamToMaConnection({
+            stream: pbstr.unwrap().unwrap(),
+            remoteAddr,
+            localAddr,
+            logger: this.logger
+        });
+        this.log('new inbound transient connection %a', maConn.remoteAddr);
+        await this.upgrader.upgradeInbound(maConn, {
+            transient: true
+        });
+        this.log('%s connection %a upgraded', 'inbound', maConn.remoteAddr);
+    }
+}
+export function circuitRelayTransport(init = {}) {
+    return (components) => {
+        return new CircuitRelayTransport(components, init);
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/src/transport/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,MAAM,EAA4E,MAAM,6BAA6B,CAAA;AAC9H,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,KAAK,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,eAAe,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACxJ,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAChE,OAAO,EAAE,cAAc,EAAiC,MAAM,gBAAgB,CAAA;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAuB,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAa9E,MAAM,WAAW,GAAG,CAAC,OAAoB,EAAoC,EAAE;IAC7E,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE;QACxB,OAAO,KAAK,CAAA;KACb;IAED,IAAI;QACF,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;KACtC;IAAC,MAAM;QACN,OAAO,KAAK,CAAA;KACb;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AA8DD,MAAM,QAAQ,GAAG;IACf,qBAAqB,EAAE,eAAe;IACtC,sBAAsB,EAAE,eAAe;IACvC,WAAW,EAAE,KAAK;CACnB,CAAA;AAED,MAAM,qBAAqB;IACR,SAAS,CAAiB;IAC1B,SAAS,CAAW;IACpB,SAAS,CAAW;IACpB,iBAAiB,CAAmB;IACpC,MAAM,CAAQ;IACd,QAAQ,CAAU;IAClB,cAAc,CAAgB;IAC9B,eAAe,CAAiB;IAChC,gBAAgB,CAAkB;IAClC,MAAM,CAAiB;IACvB,qBAAqB,CAAQ;IAC7B,sBAAsB,CAAS;IAC/B,WAAW,CAAQ;IAC5B,OAAO,CAAS;IACP,GAAG,CAAQ;IAE5B,YAAa,UAA2C,EAAE,IAA+B;QACvF,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,gCAAgC,CAAC,CAAA;QAC3E,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAA;QACrD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAA;QACnC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,eAAe,CAAA;QACjD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,IAAI,QAAQ,CAAC,qBAAqB,CAAA;QACzF,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,IAAI,QAAQ,CAAC,sBAAsB,CAAA;QAC5F,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW,CAAA;QAE3D,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,EAAE;YAC1D,IAAI,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,UAAU,CAAC,CAAA;YAC/C,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE;gBACxD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC;qBACrD,KAAK,CAAC,GAAG,CAAC,EAAE;oBACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;gBACtE,CAAC,CAAC,CAAA;YACN,CAAC,CAAC,CAAA;SACH;QAED,IAAI,CAAC,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QAC9D,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACrE,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE;iBACvB,KAAK,CAAC,GAAG,CAAC,EAAE;gBACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;YAClD,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAA;QACnC,MAAM,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,CAAA;QAE7B,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,IAAI,EAAE,EAAE;YACxD,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAA;gBACzD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACxB,CAAC,CAAC,CAAA;QACJ,CAAC,EAAE;YACD,iBAAiB,EAAE,IAAI,CAAC,qBAAqB;YAC7C,kBAAkB,EAAE,IAAI,CAAC,sBAAsB;YAC/C,wBAAwB,EAAE,IAAI;SAC/B,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,CAAA;QACtB,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAA;QAClC,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAA;QAElD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAEQ,CAAC,MAAM,CAAC,GAAG,IAAI,CAAA;IAEf,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,yBAAyB,CAAA;IAEzD;;OAEG;IACH,KAAK,CAAC,IAAI,CAAE,EAAa,EAAE,UAAwB,EAAE;QACnD,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5E,MAAM,MAAM,GAAG,+BAA+B,CAAA;YAC9C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;YAC1B,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;SAC9C;QAED,2EAA2E;QAC3E,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QACjD,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;QAC1D,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,EAAE,CAAA;QACrC,MAAM,aAAa,GAAG,eAAe,CAAC,SAAS,EAAE,CAAA;QAEjD,IAAI,OAAO,IAAI,IAAI,IAAI,aAAa,IAAI,IAAI,EAAE;YAC5C,MAAM,MAAM,GAAG,yBAAyB,EAAE,CAAC,QAAQ,EAAE,0CAA0C,CAAA;YAC/F,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YACtB,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;SAC9C;QAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;QAC3C,MAAM,eAAe,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAA;QAEvD,IAAI,mBAAmB,GAAG,KAAK,CAAA;QAC/B,MAAM,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;QACzE,IAAI,eAAe,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAA;QAEzC,IAAI,eAAe,IAAI,IAAI,EAAE;YAC3B,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE;gBACpC,UAAU,EAAE,CAAC,SAAS,CAAC;aACxB,CAAC,CAAA;YACF,eAAe,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;YACjF,mBAAmB,GAAG,IAAI,CAAA;SAC3B;QAED,IAAI,MAA0B,CAAA;QAE9B,IAAI;YACF,MAAM,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAA;YAE9D,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC;gBAC1B,MAAM;gBACN,UAAU,EAAE,eAAe;gBAC3B,eAAe;gBACf,eAAe;gBACf,SAAS;gBACT,EAAE;gBACF,mBAAmB;aACpB,CAAC,CAAA;SACH;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0DAA0D,EAAE,eAAe,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;YAE3G,IAAI,MAAM,IAAI,IAAI,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;aAClB;YAED,mBAAmB,IAAI,MAAM,eAAe,CAAC,KAAK,EAAE,CAAA;YACpD,MAAM,GAAG,CAAA;SACV;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CACb,EACE,MAAM,EAAE,UAAU,EAAE,eAAe,EACnC,eAAe,EAAE,SAAS,EAAE,EAAE,EAC9B,mBAAmB,EACJ;QAEjB,IAAI;YACF,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;YAC9B,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAA;YACnC,MAAM,MAAM,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,OAAO;gBAC7B,IAAI,EAAE;oBACJ,EAAE,EAAE,eAAe,CAAC,OAAO,EAAE;oBAC7B,KAAK,EAAE,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC;iBAC1C;aACF,CAAC,CAAA;YAEF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;YAElC,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,EAAE;gBAC/B,MAAM,IAAI,SAAS,CAAC,2CAA2C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,WAAW,EAAE,EAAE,sBAAsB,CAAC,CAAA;aACpI;YAED,MAAM,MAAM,GAAG,oBAAoB,CAAC;gBAClC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;gBACtB,UAAU,EAAE,EAAE;gBACd,SAAS,EAAE,SAAS,CAAC,WAAW,CAAC,oBAAoB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAC9E,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAA;YAEF,IAAI,CAAC,GAAG,CAAC,sCAAsC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YACnE,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,EAAE;gBACjD,SAAS,EAAE,IAAI;aAChB,CAAC,CAAA;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,eAAe,CAAC,QAAQ,EAAE,cAAc,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;YAC3I,mBAAmB,IAAI,MAAM,UAAU,CAAC,KAAK,EAAE,CAAA;YAC/C,MAAM,GAAG,CAAA;SACV;IACH,CAAC;IAED;;OAEG;IACH,cAAc,CAAE,OAA8B;QAC5C,OAAO,cAAc,CAAC;YACpB,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,UAAU,EAAE,IAAI,CAAC,gBAAgB;YACjC,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAE,UAAuB;QAC7B,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QAElE,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;YAC9B,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAE,EAAE,UAAU,EAAE,MAAM,EAAsB;QACtD,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACpD,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,CAAA;QAC9C,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC;YAC/B,MAAM;SACP,CAAC,CAAA;QAEF,IAAI,CAAC,GAAG,CAAC,uDAAuD,EAAE,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;QAEtG,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YACvG,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,EAAE;gBACrF,MAAM;aACP,CAAC,CAAA;YACF,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;YACpB,OAAM;SACP;QAED,mDAAmD;QACnD,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YAC7C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YACjF,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,kBAAkB,EAAE,EAAE;gBACtF,MAAM;aACP,CAAC,CAAA;YACF,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;YACpB,OAAM;SACP;QAED,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YACjF,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,EAAE;gBACrF,MAAM;aACP,CAAC,CAAA;YACF,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;YACpB,OAAM;SACP;QAED,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAErD,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,4BAA4B,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,KAAK,IAAI,EAAE;YAC7G,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4DAA4D,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YACnG,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,EAAE;gBACrF,MAAM;aACP,CAAC,CAAA;YACF,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;YACpB,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;QACvE,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE;YACtE,MAAM;SACP,CAAC,CAAA;QAEF,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,oBAAoB,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;QACnG,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAA;QACvD,MAAM,MAAM,GAAG,oBAAoB,CAAC;YAClC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE;YAC/B,UAAU;YACV,SAAS;YACT,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;QAEF,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QAClE,MAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE;YACzC,SAAS,EAAE,IAAI;SAChB,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,SAAS,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IACrE,CAAC;CACF;AAED,MAAM,UAAU,qBAAqB,CAAE,OAAkC,EAAE;IACzE,OAAO,CAAC,UAAU,EAAE,EAAE;QACpB,OAAO,IAAI,qBAAqB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IACpD,CAAC,CAAA;AACH,CAAC"}

package/dist/src/transport/listener.d.ts

@@ -0,0 +1,11 @@
+import type { ReservationStore } from './reservation-store.js';
+import type { ComponentLogger } from '@libp2p/interface';
+import type { Listener } from '@libp2p/interface/transport';
+import type { ConnectionManager } from '@libp2p/interface-internal/connection-manager';
+export interface CircuitRelayTransportListenerComponents {
+    connectionManager: ConnectionManager;
+    relayStore: ReservationStore;
+    logger: ComponentLogger;
+}
+export declare function createListener(options: CircuitRelayTransportListenerComponents): Listener;
+//# sourceMappingURL=listener.d.ts.map

package/dist/src/transport/listener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../../src/transport/listener.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAEhE,OAAO,KAAK,EAAE,QAAQ,EAAkB,MAAM,6BAA6B,CAAA;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAA;AAGtF,MAAM,WAAW,uCAAuC;IACtD,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,UAAU,EAAE,gBAAgB,CAAA;IAC5B,MAAM,EAAE,eAAe,CAAA;CACxB;AAgFD,wBAAgB,cAAc,CAAE,OAAO,EAAE,uCAAuC,GAAG,QAAQ,CAE1F"}

package/dist/src/transport/listener.js

@@ -0,0 +1,66 @@
+import { CodeError } from '@libp2p/interface/errors';
+import { TypedEventEmitter } from '@libp2p/interface/events';
+import { PeerMap } from '@libp2p/peer-collections';
+import { multiaddr } from '@multiformats/multiaddr';
+class CircuitRelayTransportListener extends TypedEventEmitter {
+    connectionManager;
+    relayStore;
+    listeningAddrs;
+    log;
+    constructor(components) {
+        super();
+        this.log = components.logger.forComponent('libp2p:circuit-relay:transport:listener');
+        this.connectionManager = components.connectionManager;
+        this.relayStore = components.relayStore;
+        this.listeningAddrs = new PeerMap();
+        // remove listening addrs when a relay is removed
+        this.relayStore.addEventListener('relay:removed', this._onRemoveRelayPeer);
+    }
+    _onRemoveRelayPeer = (evt) => {
+        this.#removeRelayPeer(evt.detail);
+    };
+    async listen(addr) {
+        this.log('listen on %a', addr);
+        // remove the circuit part to get the peer id of the relay
+        const relayAddr = addr.decapsulate('/p2p-circuit');
+        const relayConn = await this.connectionManager.openConnection(relayAddr);
+        if (!this.relayStore.hasReservation(relayConn.remotePeer)) {
+            // addRelay calls transportManager.listen which calls this listen method
+            await this.relayStore.addRelay(relayConn.remotePeer, 'configured');
+            return;
+        }
+        const reservation = this.relayStore.getReservation(relayConn.remotePeer);
+        if (reservation == null) {
+            throw new CodeError('Did not have reservation after making reservation', 'ERR_NO_RESERVATION');
+        }
+        if (this.listeningAddrs.has(relayConn.remotePeer)) {
+            this.log('already listening on relay %p', relayConn.remotePeer);
+            return;
+        }
+        // add all addresses from the relay reservation
+        this.listeningAddrs.set(relayConn.remotePeer, reservation.addrs.map(buf => {
+            return multiaddr(buf).encapsulate('/p2p-circuit');
+        }));
+        this.safeDispatchEvent('listening', {});
+    }
+    getAddrs() {
+        return [...this.listeningAddrs.values()].flat();
+    }
+    async close() {
+    }
+    #removeRelayPeer(peerId) {
+        const had = this.listeningAddrs.has(peerId);
+        this.log('relay peer removed %p - had reservation', peerId, had);
+        this.listeningAddrs.delete(peerId);
+        if (had) {
+            this.log.trace('removing relay event listener for peer %p', peerId);
+            this.relayStore.removeEventListener('relay:removed', this._onRemoveRelayPeer);
+            // Announce listen addresses change
+            this.safeDispatchEvent('close', {});
+        }
+    }
+}
+export function createListener(options) {
+    return new CircuitRelayTransportListener(options);
+}
+//# sourceMappingURL=listener.js.map

package/dist/src/transport/listener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listener.js","sourceRoot":"","sources":["../../../src/transport/listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAcnD,MAAM,6BAA8B,SAAQ,iBAAiC;IAC1D,iBAAiB,CAAmB;IACpC,UAAU,CAAkB;IAC5B,cAAc,CAAsB;IACpC,GAAG,CAAQ;IAE5B,YAAa,UAAmD;QAC9D,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,yCAAyC,CAAC,CAAA;QACpF,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAA;QACrD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAA;QACvC,IAAI,CAAC,cAAc,GAAG,IAAI,OAAO,EAAE,CAAA;QAEnC,iDAAiD;QACjD,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAA;IAC5E,CAAC;IAED,kBAAkB,GAAG,CAAC,GAAwB,EAAQ,EAAE;QACtD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACnC,CAAC,CAAA;IAED,KAAK,CAAC,MAAM,CAAE,IAAe;QAC3B,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;QAE9B,0DAA0D;QAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;QAClD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;QAExE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;YACzD,wEAAwE;YACxE,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA;YAClE,OAAM;SACP;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QAExE,IAAI,WAAW,IAAI,IAAI,EAAE;YACvB,MAAM,IAAI,SAAS,CAAC,mDAAmD,EAAE,oBAAoB,CAAC,CAAA;SAC/F;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;YACjD,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;YAC/D,OAAM;SACP;QAED,+CAA+C;QAC/C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACxE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;QACnD,CAAC,CAAC,CAAC,CAAA;QAEH,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,QAAQ;QACN,OAAO,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;IACjD,CAAC;IAED,KAAK,CAAC,KAAK;IAEX,CAAC;IAED,gBAAgB,CAAE,MAAc;QAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAE3C,IAAI,CAAC,GAAG,CAAC,yCAAyC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;QAEhE,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAElC,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,MAAM,CAAC,CAAA;YACnE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAA;YAC7E,mCAAmC;YACnC,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;SACpC;IACH,CAAC;CACF;AAED,MAAM,UAAU,cAAc,CAAE,OAAgD;IAC9E,OAAO,IAAI,6BAA6B,CAAC,OAAO,CAAC,CAAA;AACnD,CAAC"}

package/dist/src/transport/reservation-store.d.ts

@@ -0,0 +1,74 @@
+import { TypedEventEmitter, type TypedEventTarget } from '@libp2p/interface/events';
+import type { Reservation } from '../pb/index.js';
+import type { Libp2pEvents, ComponentLogger } from '@libp2p/interface';
+import type { PeerId } from '@libp2p/interface/peer-id';
+import type { PeerStore } from '@libp2p/interface/peer-store';
+import type { Startable } from '@libp2p/interface/startable';
+import type { ConnectionManager } from '@libp2p/interface-internal/connection-manager';
+import type { TransportManager } from '@libp2p/interface-internal/transport-manager';
+export interface RelayStoreComponents {
+    peerId: PeerId;
+    connectionManager: ConnectionManager;
+    transportManager: TransportManager;
+    peerStore: PeerStore;
+    events: TypedEventTarget<Libp2pEvents>;
+    logger: ComponentLogger;
+}
+export interface RelayStoreInit {
+    /**
+     * Multiple relays may be discovered simultaneously - to prevent listening
+     * on too many relays, this value controls how many to attempt to reserve a
+     * slot on at once. If set to more than one, we may end up listening on
+     * more relays than the `maxReservations` value, but on networks with poor
+     * connectivity the user may wish to attempt to reserve on multiple relays
+     * simultaneously. (default: 1)
+     */
+    reservationConcurrency?: number;
+    /**
+     * How many discovered relays to allow in the reservation store
+     */
+    discoverRelays?: number;
+    /**
+     * Limit the number of potential relays we will dial (default: 100)
+     */
+    maxReservationQueueLength?: number;
+    /**
+     * When creating a reservation it must complete within this number of ms
+     * (default: 5000)
+     */
+    reservationCompletionTimeout?: number;
+}
+export type RelayType = 'discovered' | 'configured';
+export interface ReservationStoreEvents {
+    'relay:not-enough-relays': CustomEvent;
+    'relay:removed': CustomEvent<PeerId>;
+}
+export declare class ReservationStore extends TypedEventEmitter<ReservationStoreEvents> implements Startable {
+    #private;
+    private readonly peerId;
+    private readonly connectionManager;
+    private readonly transportManager;
+    private readonly peerStore;
+    private readonly events;
+    private readonly reserveQueue;
+    private readonly reservations;
+    private readonly maxDiscoveredRelays;
+    private readonly maxReservationQueueLength;
+    private readonly reservationCompletionTimeout;
+    private started;
+    private readonly log;
+    constructor(components: RelayStoreComponents, init?: RelayStoreInit);
+    isStarted(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * If the number of current relays is beneath the configured `maxReservations`
+     * value, and the passed peer id is not our own, and we have a non-relayed connection
+     * to the remote, and the remote peer speaks the hop protocol, try to reserve a slot
+     * on the remote peer
+     */
+    addRelay(peerId: PeerId, type: RelayType): Promise<void>;
+    hasReservation(peerId: PeerId): boolean;
+    getReservation(peerId: PeerId): Reservation | undefined;
+}
+//# sourceMappingURL=reservation-store.d.ts.map

package/dist/src/transport/reservation-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservation-store.d.ts","sourceRoot":"","sources":["../../../src/transport/reservation-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAQnF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,YAAY,EAAgB,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAE5F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAA;AACtF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAA;AAWpF,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,SAAS,EAAE,SAAS,CAAA;IACpB,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAA;IACtC,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAElC;;;OAGG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAA;CACtC;AAED,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,YAAY,CAAA;AAQnD,MAAM,WAAW,sBAAsB;IACrC,yBAAyB,EAAE,WAAW,CAAA;IACtC,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACrC;AAED,qBAAa,gBAAiB,SAAQ,iBAAiB,CAAC,sBAAsB,CAAE,YAAW,SAAS;;IAClG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IACrD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgC;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAQ;IAClD,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAQ;IACrD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;gBAEf,UAAU,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAAE,cAAc;IA4BpE,SAAS,IAAK,OAAO;IAIf,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAIvB,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;IAS5B;;;;;OAKG;IACG,QAAQ,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA8G/D,cAAc,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAIxC,cAAc,CAAE,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;CAwDzD"}