libp2p 0.42.2 → 0.43.0

package/dist/src/circuit/transport/discovery.d.ts

@@ -0,0 +1,45 @@
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { PeerStore } from '@libp2p/interface-peer-store';
+import { EventEmitter } from '@libp2p/interfaces/events';
+import type { Startable } from '@libp2p/interfaces/startable';
+import type { ConnectionManager } from '@libp2p/interface-connection-manager';
+import type { TransportManager } from '@libp2p/interface-transport';
+import type { ContentRouting } from '@libp2p/interface-content-routing';
+import type { Registrar } from '@libp2p/interface-registrar';
+export interface RelayDiscoveryEvents {
+    'relay:discover': CustomEvent<PeerId>;
+}
+export interface RelayDiscoveryComponents {
+    peerId: PeerId;
+    peerStore: PeerStore;
+    connectionManager: ConnectionManager;
+    transportManager: TransportManager;
+    contentRouting: ContentRouting;
+    registrar: Registrar;
+}
+/**
+ * ReservationManager automatically makes a circuit v2 reservation on any connected
+ * peers that support the circuit v2 HOP protocol.
+ */
+export declare class RelayDiscovery extends EventEmitter<RelayDiscoveryEvents> implements Startable {
+    private readonly peerId;
+    private readonly peerStore;
+    private readonly contentRouting;
+    private readonly registrar;
+    private started;
+    private topologyId?;
+    constructor(components: RelayDiscoveryComponents);
+    isStarted(): boolean;
+    start(): Promise<void>;
+    stop(): void;
+    /**
+     * 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
+     */
+    discover(): Promise<void>;
+}
+//# sourceMappingURL=discovery.d.ts.map

package/dist/src/circuit/transport/discovery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../../../../src/circuit/transport/discovery.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAK5D,MAAM,WAAW,oBAAoB;IACnC,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,SAAS,CAAA;IACpB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc,EAAE,cAAc,CAAA;IAC9B,SAAS,EAAE,SAAS,CAAA;CACrB;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,YAAY,CAAC,oBAAoB,CAAE,YAAW,SAAS;IACzF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAC,CAAQ;gBAEd,UAAU,EAAE,wBAAwB;IASjD,SAAS,IAAK,OAAO;IAIf,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAiB7B,IAAI,IAAK,IAAI;IAQb;;;;;;;OAOG;IACG,QAAQ,IAAK,OAAO,CAAC,IAAI,CAAC;CAqCjC"}

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

@@ -0,0 +1,82 @@
+import { logger } from '@libp2p/logger';
+import { namespaceToCid } from '../utils.js';
+import { RELAY_RENDEZVOUS_NS, RELAY_V2_HOP_CODEC } from '../constants.js';
+import { EventEmitter } from '@libp2p/interfaces/events';
+import { createTopology } from '@libp2p/topology';
+const log = logger('libp2p:circuit-relay:discover-relays');
+/**
+ * ReservationManager automatically makes a circuit v2 reservation on any connected
+ * peers that support the circuit v2 HOP protocol.
+ */
+export class RelayDiscovery extends EventEmitter {
+    constructor(components) {
+        super();
+        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, createTopology({
+            onConnect: (peerId) => {
+                this.safeDispatchEvent('relay:discover', { detail: peerId });
+            }
+        }));
+        void this.discover()
+            .catch(err => {
+            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() {
+        log('searching peer store for relays');
+        const peers = (await this.peerStore.all())
+            // filter by a list of peers supporting RELAY_V2_HOP and ones we are not listening on
+            .filter(({ id, protocols }) => protocols.includes(RELAY_V2_HOP_CODEC))
+            .sort(() => Math.random() - 0.5);
+        for (const peer of peers) {
+            log('found relay peer %p in content peer store', peer.id);
+            this.safeDispatchEvent('relay:discover', { detail: peer.id });
+        }
+        log('found %d relay peers in peer store', peers.length);
+        try {
+            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++;
+                    log('found relay peer %p in content routing', peerId);
+                    await this.peerStore.addressBook.add(peerId, provider.multiaddrs);
+                    this.safeDispatchEvent('relay:discover', { detail: peerId });
+                }
+            }
+            log('found %d relay peers in content routing', found);
+        }
+        catch (err) {
+            log.error('failed when finding relays on the network', err);
+        }
+    }
+}
+//# sourceMappingURL=discovery.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../../../../src/circuit/transport/discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EACL,mBAAmB,EACjB,kBAAkB,EACrB,MAAM,iBAAiB,CAAA;AAGxB,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAMxD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEjD,MAAM,GAAG,GAAG,MAAM,CAAC,sCAAsC,CAAC,CAAA;AAe1D;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,YAAkC;IAQpE,YAAa,UAAoC;QAC/C,KAAK,EAAE,CAAA;QACP,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,cAAc,CAAC;YACjF,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE;gBACpB,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;YAC9D,CAAC;SACF,CAAC,CAAC,CAAA;QAEH,KAAK,IAAI,CAAC,QAAQ,EAAE;aACjB,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;QAC7C,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,GAAG,CAAC,iCAAiC,CAAC,CAAA;QACtC,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;YACxC,qFAAqF;aACpF,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;aACrE,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAA;QAElC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,GAAG,CAAC,2CAA2C,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;YACzD,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;SAC9D;QAED,GAAG,CAAC,oCAAoC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAEvD,IAAI;YACF,GAAG,CAAC,sCAAsC,CAAC,CAAA;YAC3C,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,GAAG,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAA;oBACrD,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;oBAEjE,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;iBAC7D;aACF;YAED,GAAG,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAA;SACtD;QAAC,OAAO,GAAQ,EAAE;YACjB,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,GAAG,CAAC,CAAA;SAC5D;IACH,CAAC;CACF"}

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

@@ -0,0 +1,33 @@
+import { Upgrader } from '@libp2p/interface-transport';
+import type { Registrar } from '@libp2p/interface-registrar';
+import type { Transport } from '@libp2p/interface-transport';
+import type { ConnectionGater } from '@libp2p/interface-connection-gater';
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { PeerStore } from '@libp2p/interface-peer-store';
+import type { ConnectionManager } from '@libp2p/interface-connection-manager';
+import type { AddressManager } from '@libp2p/interface-address-manager';
+import type { ContentRouting } from '@libp2p/interface-content-routing';
+import { RelayStoreInit } from './reservation-store.js';
+import { RelayDiscoveryComponents } from './discovery.js';
+export interface CircuitRelayTransportComponents extends RelayDiscoveryComponents {
+    peerId: PeerId;
+    peerStore: PeerStore;
+    registrar: Registrar;
+    connectionManager: ConnectionManager;
+    upgrader: Upgrader;
+    addressManager: AddressManager;
+    contentRouting: ContentRouting;
+    connectionGater: ConnectionGater;
+}
+/**
+ * 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;
+}
+export declare function circuitRelayTransport(init?: CircuitRelayTransportInit): (components: CircuitRelayTransportComponents) => Transport;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/circuit/transport/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAU,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAG9D,OAAO,KAAK,EAAsB,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAChF,OAAO,KAAK,EAAY,SAAS,EAAyB,MAAM,6BAA6B,CAAA;AAE7F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAEvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAEvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAEvE,OAAO,EAAE,cAAc,EAAoB,MAAM,wBAAwB,CAAA;AACzE,OAAO,EAAkB,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AAmBzE,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;CACjC;AAYD;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,cAAc;IAC/D;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAwPD,wBAAgB,qBAAqB,CAAE,IAAI,GAAE,yBAA8B,GAAG,CAAC,UAAU,EAAE,+BAA+B,KAAK,SAAS,CAIvI"}

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

@@ -0,0 +1,225 @@
+import { StopMessage, HopMessage, Status } from '../pb/index.js';
+import { logger } from '@libp2p/logger';
+import * as mafmt from '@multiformats/mafmt';
+import { multiaddr } from '@multiformats/multiaddr';
+import { codes } from '../../errors.js';
+import { streamToMaConnection } from '@libp2p/utils/stream-to-ma-conn';
+import { createListener } from './listener.js';
+import { symbol } from '@libp2p/interface-transport';
+import { peerIdFromBytes, peerIdFromString } from '@libp2p/peer-id';
+import { pbStream } from 'it-pb-stream';
+import { CIRCUIT_PROTO_CODE, RELAY_V2_HOP_CODEC, RELAY_V2_STOP_CODEC } from '../constants.js';
+import { ReservationStore } from './reservation-store.js';
+import { RelayDiscovery } from './discovery.js';
+import { CodeError } from '@libp2p/interfaces/errors';
+const log = logger('libp2p:circuit-relay:transport');
+const isValidStop = (request) => {
+    if (request.peer == null) {
+        return false;
+    }
+    try {
+        request.peer.addrs.forEach(multiaddr);
+    }
+    catch {
+        return false;
+    }
+    return true;
+};
+class CircuitRelayTransport {
+    constructor(components, init) {
+        this.registrar = components.registrar;
+        this.peerStore = components.peerStore;
+        this.connectionManager = components.connectionManager;
+        this.peerId = components.peerId;
+        this.upgrader = components.upgrader;
+        this.addressManager = components.addressManager;
+        this.connectionGater = components.connectionGater;
+        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 => {
+                    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 => {
+                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 => {
+                log.error(err);
+            });
+        });
+        this.started = true;
+    }
+    async stop() {
+        this.discovery?.stop();
+        await this.reservationStore.stop();
+        await this.registrar.unhandle(RELAY_V2_STOP_CODEC);
+        this.started = false;
+    }
+    get [symbol]() {
+        return true;
+    }
+    get [Symbol.toStringTag]() {
+        return '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';
+            log.error(errMsg, ma);
+            throw new CodeError(errMsg, codes.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 failed as addresses did not have peer id';
+            log.error(errMsg);
+            throw new CodeError(errMsg, codes.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.addressBook.add(relayPeer, [relayAddr]);
+            relayConnection = await this.connectionManager.openConnection(relayPeer, options);
+            disconnectOnFailure = true;
+        }
+        try {
+            const stream = await relayConnection.newStream([RELAY_V2_HOP_CODEC]);
+            return await this.connectV2({
+                stream,
+                connection: relayConnection,
+                destinationPeer,
+                destinationAddr,
+                relayAddr,
+                ma,
+                disconnectOnFailure
+            });
+        }
+        catch (err) {
+            log.error('Circuit relay dial failed', 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);
+            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'}`, codes.ERR_HOP_REQUEST_FAILED);
+            }
+            // TODO: do something with limit and transient connection
+            const maConn = streamToMaConnection({
+                stream: pbstr.unwrap(),
+                remoteAddr: ma,
+                localAddr: relayAddr.encapsulate(`/p2p-circuit/p2p/${this.peerId.toString()}`)
+            });
+            log('new outbound connection %s', maConn.remoteAddr);
+            return await this.upgrader.upgradeOutbound(maConn);
+        }
+        catch (err) {
+            log.error('Circuit relay dial failed', err);
+            disconnectOnFailure && await connection.close();
+            throw err;
+        }
+    }
+    /**
+     * Create a listener
+     */
+    createListener(options) {
+        return createListener({
+            connectionManager: this.connectionManager,
+            relayStore: this.reservationStore
+        });
+    }
+    /**
+     * 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 pbstr = pbStream(stream);
+        const request = await pbstr.readPB(StopMessage);
+        log('received circuit v2 stop protocol request from %s', connection.remotePeer);
+        if (request?.type === undefined) {
+            return;
+        }
+        const stopstr = pbstr.pb(StopMessage);
+        log('new circuit relay v2 stop stream from %s', connection.remotePeer);
+        // Validate the STOP request has the required input
+        if (request.type !== StopMessage.Type.CONNECT) {
+            log.error('invalid stop connect request via peer %s', connection.remotePeer);
+            stopstr.write({ type: StopMessage.Type.STATUS, status: Status.UNEXPECTED_MESSAGE });
+            return;
+        }
+        if (!isValidStop(request)) {
+            log.error('invalid stop connect request via peer %s', connection.remotePeer);
+            stopstr.write({ type: StopMessage.Type.STATUS, status: Status.MALFORMED_MESSAGE });
+            return;
+        }
+        const remotePeerId = peerIdFromBytes(request.peer.id);
+        if ((await this.connectionGater.denyInboundRelayedConnection?.(connection.remotePeer, remotePeerId)) === true) {
+            stopstr.write({ type: StopMessage.Type.STATUS, status: Status.PERMISSION_DENIED });
+            return;
+        }
+        stopstr.write({ type: StopMessage.Type.STATUS, status: Status.OK });
+        const remoteAddr = connection.remoteAddr.encapsulate(`/p2p-circuit/p2p/${remotePeerId.toString()}`);
+        const localAddr = this.addressManager.getAddresses()[0];
+        const maConn = streamToMaConnection({
+            stream: pbstr.unwrap(),
+            remoteAddr,
+            localAddr
+        });
+        log('new inbound connection %s', maConn.remoteAddr);
+        await this.upgrader.upgradeInbound(maConn);
+        log('%s connection %s upgraded', 'inbound', maConn.remoteAddr);
+    }
+}
+export function circuitRelayTransport(init = {}) {
+    return (components) => {
+        return new CircuitRelayTransport(components, init);
+    };
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/circuit/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,MAAM,EAAY,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAWnE,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAEvC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAC7F,OAAO,EAAkB,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EAAE,cAAc,EAA4B,MAAM,gBAAgB,CAAA;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAErD,MAAM,GAAG,GAAG,MAAM,CAAC,gCAAgC,CAAC,CAAA;AAEpD,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;AAkCD,MAAM,qBAAqB;IAYzB,YAAa,UAA2C,EAAE,IAA+B;QACvF,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,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;QAEjD,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,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;gBACjE,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,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;YAC7C,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,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC,CAAC,CAAA;QACJ,CAAC,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;IAED,IAAI,CAAC,MAAM,CAAC;QACV,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,yBAAyB,CAAA;IAClC,CAAC;IAED;;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,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;YACrB,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;SACpD;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,6DAA6D,CAAA;YAC5E,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YACjB,MAAM,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;SACpD;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,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;YAC5D,eAAe,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;YACjF,mBAAmB,GAAG,IAAI,CAAA;SAC3B;QAED,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAA;YAEpE,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,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;YAC3C,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,CAAC,KAAK,CAAC;gBACX,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,KAAK,CAAC,sBAAsB,CAAC,CAAA;aAC1I;YAED,yDAAyD;YAEzD,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;aAC/E,CAAC,CAAA;YAEF,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YACpD,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;SACnD;QAAC,OAAO,GAAG,EAAE;YACZ,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;YAC3C,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;SAClC,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,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC9B,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAC/C,GAAG,CAAC,mDAAmD,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;QAE/E,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE;YAC/B,OAAM;SACP;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAA;QACrC,GAAG,CAAC,0CAA0C,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;QAEtE,mDAAmD;QACnD,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE;YAC7C,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YAC5E,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAA;YACnF,OAAM;SACP;QAED,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YACzB,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;YAC5E,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAA;YAClF,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,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAA;YAClF,OAAM;SACP;QAED,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAA;QAEnE,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;YACtB,UAAU;YACV,SAAS;SACV,CAAC,CAAA;QAEF,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QACnD,MAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;QAC1C,GAAG,CAAC,2BAA2B,EAAE,SAAS,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;IAChE,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/circuit/transport/listener.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../../../src/circuit/transport/listener.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,OAAO,KAAK,EAAE,QAAQ,EAAkB,MAAM,6BAA6B,CAAA;AAG3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAO3D,MAAM,WAAW,uCAAuC;IACtD,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,UAAU,EAAE,gBAAgB,CAAA;CAC7B;AAiFD,wBAAgB,cAAc,CAAE,OAAO,EAAE,uCAAuC,GAAG,QAAQ,CAE1F"}

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

@@ -0,0 +1,76 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _CircuitRelayTransportListener_instances, _CircuitRelayTransportListener_removeRelayPeer;
+import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events';
+import { multiaddr } from '@multiformats/multiaddr';
+import { PeerMap } from '@libp2p/peer-collections';
+import { logger } from '@libp2p/logger';
+const log = logger('libp2p:circuit-relay:transport:listener');
+class CircuitRelayTransportListener extends EventEmitter {
+    constructor(components) {
+        super();
+        _CircuitRelayTransportListener_instances.add(this);
+        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', (evt) => {
+            __classPrivateFieldGet(this, _CircuitRelayTransportListener_instances, "m", _CircuitRelayTransportListener_removeRelayPeer).call(this, evt.detail);
+        });
+        // remove listening addrs when a peer disconnects
+        this.connectionManager.addEventListener('peer:disconnect', (evt) => {
+            __classPrivateFieldGet(this, _CircuitRelayTransportListener_instances, "m", _CircuitRelayTransportListener_removeRelayPeer).call(this, evt.detail.remotePeer);
+        });
+    }
+    async listen(addr) {
+        log('listen on %s', addr);
+        const addrString = addr.toString().split('/p2p-circuit').find(a => a !== '');
+        const ma = multiaddr(addrString);
+        const relayConn = await this.connectionManager.openConnection(ma);
+        if (!this.relayStore.hasReservation(relayConn.remotePeer)) {
+            // addRelay calls transportManager.listen which calls this listen method
+            await this.relayStore.addRelay(relayConn.remotePeer, 'configured');
+            return;
+        }
+        if (this.listeningAddrs.has(relayConn.remotePeer)) {
+            log('already listening on relay %p', relayConn.remotePeer);
+            return;
+        }
+        this.listeningAddrs.set(relayConn.remotePeer, addr);
+        this.dispatchEvent(new CustomEvent('listening'));
+    }
+    /**
+     * Get fixed up multiaddrs
+     *
+     * NOTE: This method will grab the peers multiaddrs and expand them such that:
+     *
+     * a) If it's an existing /p2p-circuit address for a specific relay i.e.
+     * `/ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit` this method will expand the
+     * address to `/ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit/ipfs/QmPeer` where
+     * `QmPeer` is this peers id
+     * b) If it's not a /p2p-circuit address, it will encapsulate the address as a /p2p-circuit
+     * addr, such when dialing over a relay with this address, it will create the circuit using
+     * the encapsulated transport address. This is useful when for example, a peer should only
+     * be dialed over TCP rather than any other transport
+     */
+    getAddrs() {
+        return [...this.listeningAddrs.values()];
+    }
+    async close() {
+    }
+}
+_CircuitRelayTransportListener_instances = new WeakSet(), _CircuitRelayTransportListener_removeRelayPeer = function _CircuitRelayTransportListener_removeRelayPeer(peerId) {
+    const had = this.listeningAddrs.has(peerId);
+    this.listeningAddrs.delete(peerId);
+    if (had) {
+        // Announce listen addresses change
+        this.dispatchEvent(new CustomEvent('close'));
+    }
+};
+export function createListener(options) {
+    return new CircuitRelayTransportListener(options);
+}
+//# sourceMappingURL=listener.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"listener.js","sourceRoot":"","sources":["../../../../src/circuit/transport/listener.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAIrE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAGnD,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEvC,MAAM,GAAG,GAAG,MAAM,CAAC,yCAAyC,CAAC,CAAA;AAO7D,MAAM,6BAA8B,SAAQ,YAA4B;IAKtE,YAAa,UAAmD;QAC9D,KAAK,EAAE,CAAA;;QAEP,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,CAAC,GAAG,EAAE,EAAE;YACxD,uBAAA,IAAI,gGAAiB,MAArB,IAAI,EAAkB,GAAG,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,iDAAiD;QACjD,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,GAAG,EAAE,EAAE;YACjE,uBAAA,IAAI,gGAAiB,MAArB,IAAI,EAAkB,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAE,IAAe;QAC3B,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;QAEzB,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;QAC5E,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,CAAA;QAChC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;QAEjE,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,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;YACjD,GAAG,CAAC,+BAA+B,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;YAC1D,OAAM;SACP;QAED,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACnD,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ;QACN,OAAO,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,KAAK;IAEX,CAAC;CAYF;mKAVmB,MAAc;IAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAE3C,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAElC,IAAI,GAAG,EAAE;QACP,mCAAmC;QACnC,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;KAC7C;AACH,CAAC;AAGH,MAAM,UAAU,cAAc,CAAE,OAAgD;IAC9E,OAAO,IAAI,6BAA6B,CAAC,OAAO,CAAC,CAAA;AACnD,CAAC"}

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

@@ -0,0 +1,60 @@
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { ConnectionManager } from '@libp2p/interface-connection-manager';
+import type { TransportManager } from '@libp2p/interface-transport';
+import type { Startable } from '@libp2p/interfaces/dist/src/startable.js';
+import { EventEmitter } from '@libp2p/interfaces/events';
+import type { PeerStore } from '@libp2p/interface-peer-store';
+export interface RelayStoreComponents {
+    peerId: PeerId;
+    connectionManager: ConnectionManager;
+    transportManager: TransportManager;
+    peerStore: PeerStore;
+}
+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;
+}
+export type RelayType = 'discovered' | 'configured';
+export interface ReservationStoreEvents {
+    'relay:not-enough-relays': CustomEvent;
+    'relay:removed': CustomEvent<PeerId>;
+}
+export declare class ReservationStore extends EventEmitter<ReservationStoreEvents> implements Startable {
+    #private;
+    private readonly peerId;
+    private readonly connectionManager;
+    private readonly transportManager;
+    private readonly peerStore;
+    private readonly reserveQueue;
+    private readonly reservations;
+    private readonly maxDiscoveredRelays;
+    private started;
+    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;
+    /**
+     * Remove listen relay
+     */
+    removeRelay(peerId: PeerId): void;
+}
+//# sourceMappingURL=reservation-store.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reservation-store.d.ts","sourceRoot":"","sources":["../../../../src/circuit/transport/reservation-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAMvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAK7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAA;AACzE,OAAO,EAAe,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAW7D,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;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,YAAY,CAAC,sBAAsB,CAAE,YAAW,SAAS;;IAC7F,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,YAAY,CAAQ;IACrC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAC5C,OAAO,CAAC,OAAO,CAAS;gBAEX,UAAU,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAAE,cAAc;IAwBpE,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;IA4E/D,cAAc,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAgCxC;;OAEG;IACH,WAAW,CAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAkBnC"}