libp2p 0.42.2-45fc415b → 0.42.2-593deefe

package/dist/src/circuit/client.d.ts

@@ -0,0 +1,81 @@
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { AddressSorter } from '@libp2p/interface-peer-store';
+import type { Connection } from '@libp2p/interface-connection';
+import { EventEmitter } from '@libp2p/interfaces/events';
+import type { Startable } from '@libp2p/interfaces/startable';
+import type { Components } from '../components.js';
+import type { RelayReservationManagerConfig } from './index.js';
+import { PeerList } from '@libp2p/peer-collections';
+/**
+ * CircuitServiceInit initializes the circuit service using values
+ * from the provided config and an @type{AddressSorter}.
+ */
+export interface CircuitServiceInit extends RelayReservationManagerConfig {
+    /**
+     * Allows prioritizing addresses from the peerstore for dialing. The
+     * default behavior is to prioritise public addresses.
+     */
+    addressSorter?: AddressSorter;
+    /**
+     * A callback to invoke when an error occurs in the circuit service.
+     */
+    onError?: (error: Error) => void;
+}
+export interface RelayReservationManagerEvents {
+    'relay:reservation': CustomEvent;
+}
+/**
+ * ReservationManager automatically makes a circuit v2 reservation on any connected
+ * peers that support the circuit v2 HOP protocol.
+ */
+export declare class RelayReservationManager extends EventEmitter<RelayReservationManagerEvents> implements Startable {
+    private readonly components;
+    private readonly addressSorter;
+    private readonly maxReservations;
+    private readonly relays;
+    private readonly reservationMap;
+    private readonly onError;
+    private started;
+    constructor(components: Components, init: CircuitServiceInit);
+    isStarted(): boolean;
+    start(): void;
+    stop(): Promise<void>;
+    /**
+     * Check if a peer supports the relay protocol.
+     * If the protocol is not supported, check if it was supported before and remove it as a listen relay.
+     * If the protocol is supported, check if the peer supports **HOP** and add it as a listener if
+     * inside the threshold.
+     */
+    _onProtocolChange({ peerId, protocols }: {
+        peerId: PeerId;
+        protocols: string[];
+    }): Promise<void>;
+    /**
+     * Handle case when peer connects. If we already have the peer in the protobook,
+     * we treat this event as an `onProtocolChange`.
+     */
+    _onPeerConnect({ detail: connection }: CustomEvent<Connection>): void;
+    /**
+     * Peer disconnects
+     */
+    _onPeerDisconnected(evt: CustomEvent<Connection>): void;
+    /**
+     * Attempt to listen on the given relay connection
+     */
+    _addListenRelay(connection: Connection, peerId: PeerId): Promise<void>;
+    /**
+     * Remove listen relay
+     */
+    _removeListenRelay(PeerId: PeerId): Promise<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.
+     */
+    _listenOnAvailableHopRelays(peersToIgnore?: PeerList): Promise<void>;
+    _tryToListenOnRelay(peerId: PeerId): Promise<void>;
+    private readonly createOrRefreshReservation;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/src/circuit/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/circuit/client.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AAM9D,OAAO,EAAE,YAAY,EAAe,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAoB,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAMrE;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,6BAA6B;IACvE;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;CACjC;AAED,MAAM,WAAW,6BAA6B;IAC5C,mBAAmB,EAAE,WAAW,CAAA;CACjC;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,YAAY,CAAC,6BAA6B,CAAE,YAAW,SAAS;IAC3G,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAwC;IACvE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwB;IAChD,OAAO,CAAC,OAAO,CAAS;gBAEX,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB;IAwB7D,SAAS;IAIT,KAAK;IAKC,IAAI;IAMV;;;;;OAKG;IACG,iBAAiB,CAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,EAAE,CAAA;KAAC;IA6CrF;;;OAGG;IACH,cAAc,CAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,WAAW,CAAC,UAAU,CAAC;IAa/D;;OAEG;IACH,mBAAmB,CAAE,GAAG,EAAE,WAAW,CAAC,UAAU,CAAC;IAgBjD;;OAEG;IACG,eAAe,CAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiD7E;;OAEG;IACG,kBAAkB,CAAE,MAAM,EAAE,MAAM;IASxC;;;;;;OAMG;IACG,2BAA2B,CAAE,aAAa,GAAE,QAA2B;IAmEvE,mBAAmB,CAAE,MAAM,EAAE,MAAM;IAczC,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CA0C1C;CACF"}

package/dist/src/circuit/client.js

@@ -0,0 +1,285 @@
+import { logger } from '@libp2p/logger';
+import { RELAY_V2_HOP_CODEC } from './multicodec.js';
+import { getExpiration, namespaceToCid } from './utils.js';
+import { CIRCUIT_PROTO_CODE, DEFAULT_MAX_RESERVATIONS, RELAY_RENDEZVOUS_NS } from './constants.js';
+import sort from 'it-sort';
+import all from 'it-all';
+import { pipe } from 'it-pipe';
+import { publicAddressesFirst } from '@libp2p/utils/address-sort';
+import { reserve } from './hop.js';
+import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events';
+import { PeerSet, PeerMap, PeerList } from '@libp2p/peer-collections';
+const log = logger('libp2p:circuit:client');
+const noop = () => { };
+/**
+ * ReservationManager automatically makes a circuit v2 reservation on any connected
+ * peers that support the circuit v2 HOP protocol.
+ */
+export class RelayReservationManager extends EventEmitter {
+    constructor(components, init) {
+        super();
+        this.createOrRefreshReservation = async (peerId) => {
+            try {
+                const connections = this.components.connectionManager.getConnections(peerId);
+                if (connections.length === 0) {
+                    throw new Error('No connections to peer');
+                }
+                const connection = connections[0];
+                const reservation = await reserve(connection);
+                const refreshReservation = this.createOrRefreshReservation;
+                if (reservation != null) {
+                    log('new reservation on %p', peerId);
+                    // clear any previous timeouts
+                    const previous = this.reservationMap.get(peerId);
+                    if (previous != null) {
+                        clearTimeout(previous);
+                    }
+                    const timeout = setTimeout((peerId) => {
+                        void refreshReservation(peerId).catch(err => {
+                            log.error('error refreshing reservation for %p', peerId, err);
+                        });
+                    }, Math.max(getExpiration(reservation.expire) - 100, 0), peerId);
+                    this.reservationMap.set(peerId, timeout);
+                    this.dispatchEvent(new CustomEvent('relay:reservation'));
+                }
+            }
+            catch (err) {
+                log.error(err);
+                await this._removeListenRelay(peerId);
+            }
+        };
+        this.started = false;
+        this.components = components;
+        this.addressSorter = init.addressSorter ?? publicAddressesFirst;
+        this.maxReservations = init.maxReservations ?? DEFAULT_MAX_RESERVATIONS;
+        this.relays = new PeerSet();
+        this.reservationMap = new PeerMap();
+        this.onError = init.onError ?? noop;
+        this._onProtocolChange = this._onProtocolChange.bind(this);
+        this._onPeerDisconnected = this._onPeerDisconnected.bind(this);
+        this._onPeerConnect = this._onPeerConnect.bind(this);
+        this.components.peerStore.addEventListener('change:protocols', (evt) => {
+            void this._onProtocolChange(evt.detail).catch(err => {
+                log.error('handling protocol change failed', err);
+            });
+        });
+        this.components.connectionManager.addEventListener('peer:disconnect', this._onPeerDisconnected);
+        this.components.connectionManager.addEventListener('peer:connect', this._onPeerConnect);
+    }
+    isStarted() {
+        return this.started;
+    }
+    start() {
+        void this._listenOnAvailableHopRelays().catch(err => { log.error('error listening on relays', err); });
+        this.started = true;
+    }
+    async stop() {
+        this.reservationMap.forEach((timer) => clearTimeout(timer));
+        this.reservationMap.clear();
+        this.relays.clear();
+    }
+    /**
+     * Check if a peer supports the relay protocol.
+     * If the protocol is not supported, check if it was supported before and remove it as a listen relay.
+     * If the protocol is supported, check if the peer supports **HOP** and add it as a listener if
+     * inside the threshold.
+     */
+    async _onProtocolChange({ peerId, protocols }) {
+        if (peerId.equals(this.components.peerId)) {
+            return;
+        }
+        // Check if it has the protocol
+        const hasProtocol = protocols.includes(RELAY_V2_HOP_CODEC);
+        log.trace('Peer %p protocol change %p', peerId, this.components.peerId);
+        // If no protocol, check if we were keeping the peer before as a listenRelay
+        if (!hasProtocol) {
+            if (this.relays.has(peerId)) {
+                await this._removeListenRelay(peerId);
+            }
+            return;
+        }
+        if (this.relays.has(peerId)) {
+            return;
+        }
+        // If protocol, check if can hop, store info in the metadataBook and listen on it
+        try {
+            const connections = this.components.connectionManager.getConnections(peerId);
+            // if no connections, try to listen on relay
+            if (connections.length === 0) {
+                void this._tryToListenOnRelay(peerId);
+                return;
+            }
+            const connection = connections[0];
+            // Do not hop on a relayed connection
+            if (connection.remoteAddr.protoCodes().includes(CIRCUIT_PROTO_CODE)) {
+                log('relayed connection to %p will not be used to hop on', peerId);
+                return;
+            }
+            await this._addListenRelay(connection, peerId);
+        }
+        catch (err) {
+            log.error('could not add %p as relay', peerId);
+            this.onError(err);
+        }
+    }
+    /**
+     * Handle case when peer connects. If we already have the peer in the protobook,
+     * we treat this event as an `onProtocolChange`.
+     */
+    _onPeerConnect({ detail: connection }) {
+        void this.components.peerStore.protoBook.get(connection.remotePeer)
+            .then((protocols) => {
+            void this._onProtocolChange({ peerId: connection.remotePeer, protocols })
+                .catch((err) => log.error('handling reconnect failed', err));
+        }, (err) => {
+            // this is not necessarily an error as we will only have the protocols stored
+            // in case of a reconnect
+            log.trace('could not fetch protocols for peer: %p', connection.remotePeer, err);
+        });
+    }
+    /**
+     * Peer disconnects
+     */
+    _onPeerDisconnected(evt) {
+        const connection = evt.detail;
+        const peerId = connection.remotePeer;
+        clearTimeout(this.reservationMap.get(peerId));
+        this.reservationMap.delete(peerId);
+        // Not listening on this relay
+        if (!this.relays.has(peerId)) {
+            return;
+        }
+        this._removeListenRelay(peerId).catch(err => {
+            log.error(err);
+        });
+    }
+    /**
+     * Attempt to listen on the given relay connection
+     */
+    async _addListenRelay(connection, peerId) {
+        log.trace('peerId %p is being added as relay', peerId);
+        try {
+            // Check if already enough relay reservations
+            if (this.relays.size >= this.maxReservations) {
+                return;
+            }
+            await this.createOrRefreshReservation(peerId);
+            // Get peer known addresses and sort them with public addresses first
+            const remoteAddrs = await pipe(await this.components.peerStore.addressBook.get(connection.remotePeer), (source) => sort(source, this.addressSorter), async (source) => await all(source));
+            // Attempt to listen on relay
+            const result = await Promise.all(remoteAddrs.map(async (addr) => {
+                let multiaddr = addr.multiaddr;
+                if (multiaddr.getPeerId() == null) {
+                    multiaddr = multiaddr.encapsulate(`/p2p/${connection.remotePeer.toString()}`);
+                }
+                multiaddr = multiaddr.encapsulate('/p2p-circuit');
+                try {
+                    // Announce multiaddrs will update on listen success by TransportManager event being triggered
+                    await this.components.transportManager.listen([multiaddr]);
+                    return true;
+                }
+                catch (err) {
+                    log.error('error listening on circuit address', multiaddr, err);
+                    this.onError(err);
+                }
+                return false;
+            }));
+            if (result.includes(true)) {
+                this.relays.add(peerId);
+            }
+        }
+        catch (err) {
+            this.relays.delete(peerId);
+            log.error('error adding relay for %p %s', peerId, err);
+            this.onError(err);
+        }
+    }
+    /**
+     * Remove listen relay
+     */
+    async _removeListenRelay(PeerId) {
+        const recheck = this.relays.has(PeerId);
+        this.relays.delete(PeerId);
+        if (recheck) {
+            // TODO: this should be responsibility of the connMgr
+            await this._listenOnAvailableHopRelays(new PeerList([PeerId]));
+        }
+    }
+    /**
+     * 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 _listenOnAvailableHopRelays(peersToIgnore = new PeerList([])) {
+        // Check if already listening on enough relays
+        if (this.relays.size >= this.maxReservations) {
+            return;
+        }
+        const knownHopsToDial = [];
+        const peers = (await this.components.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) && !this.relays.has(id) && !peersToIgnore.includes(id))
+            .map(({ id }) => {
+            const connections = this.components.connectionManager.getConnections(id);
+            if (connections.length === 0) {
+                knownHopsToDial.push(id);
+                return [id, null];
+            }
+            return [id, connections[0]];
+        })
+            .sort(() => Math.random() - 0.5);
+        // Check if we have known hop peers to use and attempt to listen on the already connected
+        for (const [id, conn] of peers) {
+            await this._addListenRelay(conn, id);
+            // Check if already listening on enough relays
+            if (this.relays.size >= this.maxReservations) {
+                return;
+            }
+        }
+        // Try to listen on known peers that are not connected
+        for (const peerId of knownHopsToDial) {
+            // Check if already listening on enough relays
+            if (this.relays.size >= this.maxReservations) {
+                return;
+            }
+            await this._tryToListenOnRelay(peerId);
+        }
+        // Try to find relays to hop on the network
+        try {
+            const cid = await namespaceToCid(RELAY_RENDEZVOUS_NS);
+            for await (const provider of this.components.contentRouting.findProviders(cid)) {
+                if (provider.multiaddrs.length > 0 &&
+                    !provider.id.equals(this.components.peerId)) {
+                    const peerId = provider.id;
+                    await this.components.peerStore.addressBook.add(peerId, provider.multiaddrs);
+                    await this._tryToListenOnRelay(peerId);
+                    // Check if already listening on enough relays
+                    if (this.relays.size >= this.maxReservations) {
+                        return;
+                    }
+                }
+            }
+        }
+        catch (err) {
+            log.error('failed when finding relays on the network', err);
+            this.onError(err);
+        }
+    }
+    async _tryToListenOnRelay(peerId) {
+        try {
+            if (peerId.equals(this.components.peerId)) {
+                log.trace('Skipping dialling self %p', peerId.toString());
+                return;
+            }
+            const connection = await this.components.connectionManager.openConnection(peerId);
+            await this._addListenRelay(connection, peerId);
+        }
+        catch (err) {
+            log.error('Could not connect and listen on relay %p', peerId, err);
+            this.onError(err);
+        }
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/src/circuit/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/circuit/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,gBAAgB,CAAA;AAIvB,OAAO,IAAI,MAAM,SAAS,CAAA;AAC1B,OAAO,GAAG,MAAM,QAAQ,CAAA;AACxB,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAIrE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAErE,MAAM,GAAG,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAA;AAE3C,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;AAsBrB;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,YAA2C;IAStF,YAAa,UAAsB,EAAE,IAAwB;QAC3D,KAAK,EAAE,CAAA;QAqRQ,+BAA0B,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;YACrE,IAAI;gBACF,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;gBAE5E,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC5B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;iBAC1C;gBAED,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;gBAEjC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAA;gBAE7C,MAAM,kBAAkB,GAAG,IAAI,CAAC,0BAA0B,CAAA;gBAE1D,IAAI,WAAW,IAAI,IAAI,EAAE;oBACvB,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAA;oBAEpC,8BAA8B;oBAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;oBAChD,IAAI,QAAQ,IAAI,IAAI,EAAE;wBACpB,YAAY,CAAC,QAAQ,CAAC,CAAA;qBACvB;oBAED,MAAM,OAAO,GAAG,UAAU,CACxB,CAAC,MAAc,EAAE,EAAE;wBACjB,KAAK,kBAAkB,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;4BAC1C,GAAG,CAAC,KAAK,CAAC,qCAAqC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;wBAC/D,CAAC,CAAC,CAAA;oBACJ,CAAC,EACD,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,EACpD,MAAM,CACP,CAAA;oBACD,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,MAAM,EACN,OAAO,CACR,CAAA;oBACD,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAU,mBAAmB,CAAC,CAAC,CAAA;iBAClE;aACF;YAAC,OAAO,GAAQ,EAAE;gBACjB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACd,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;aACtC;QACH,CAAC,CAAA;QA9TC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,oBAAoB,CAAA;QAC/D,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,wBAAwB,CAAA;QACvE,IAAI,CAAC,MAAM,GAAG,IAAI,OAAO,EAAE,CAAA;QAC3B,IAAI,CAAC,cAAc,GAAG,IAAI,OAAO,EAAE,CAAA;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAA;QAEnC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1D,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEpD,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC,GAAG,EAAE,EAAE;YACrE,KAAK,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBAClD,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;YACnD,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAC/F,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;IACzF,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK;QACH,KAAK,IAAI,CAAC,2BAA2B,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA,CAAC,CAAC,CAAC,CAAA;QACrG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA;QAC3D,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAA;QAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CAAE,EAAE,MAAM,EAAE,SAAS,EAAyC;QACnF,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YACzC,OAAM;SACP;QAED,+BAA+B;QAC/B,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAA;QAC1D,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAEvE,4EAA4E;QAC5E,IAAI,CAAC,WAAW,EAAE;YAChB,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC3B,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;aACtC;YACD,OAAM;SACP;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC3B,OAAM;SACP;QAED,iFAAiF;QACjF,IAAI;YACF,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;YAE5E,4CAA4C;YAC5C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC5B,KAAK,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAA;gBACrC,OAAM;aACP;YACD,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;YAEjC,qCAAqC;YACrC,IAAI,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE;gBACnE,GAAG,CAAC,qDAAqD,EAAE,MAAM,CAAC,CAAA;gBAClE,OAAM;aACP;YAED,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;SAC/C;QAAC,OAAO,GAAQ,EAAE;YACjB,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAA;YAC9C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;SAClB;IACH,CAAC;IAED;;;OAGG;IACH,cAAc,CAAE,EAAE,MAAM,EAAE,UAAU,EAA2B;QAC7D,KAAK,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC;aAChE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;YAClB,KAAK,IAAI,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,CAAC;iBACtE,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC,CAAA;QAChE,CAAC,EACD,CAAC,GAAG,EAAE,EAAE;YACN,6EAA6E;YAC7E,yBAAyB;YACzB,GAAG,CAAC,KAAK,CAAC,wCAAwC,EAAE,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;QACjF,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;OAEG;IACH,mBAAmB,CAAE,GAA4B;QAC/C,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAA;QAC7B,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAA;QACpC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;QAC7C,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAElC,8BAA8B;QAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAM;SACP;QAED,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAC1C,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAE,UAAsB,EAAE,MAAc;QAC3D,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAA;QACtD,IAAI;YACF,6CAA6C;YAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE;gBAC5C,OAAM;aACP;YAED,MAAM,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAA;YAE7C,qEAAqE;YACrE,MAAM,WAAW,GAAG,MAAM,IAAI,CAC5B,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EACtE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,EAC5C,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,CACpC,CAAA;YAED,6BAA6B;YAC7B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,WAAW,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;gBAC3B,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;gBAE9B,IAAI,SAAS,CAAC,SAAS,EAAE,IAAI,IAAI,EAAE;oBACjC,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,QAAQ,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;iBAC9E;gBACD,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;gBACjD,IAAI;oBACF,8FAA8F;oBAC9F,MAAM,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;oBAC1D,OAAO,IAAI,CAAA;iBACZ;gBAAC,OAAO,GAAQ,EAAE;oBACjB,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;oBAC/D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;iBAClB;gBAED,OAAO,KAAK,CAAA;YACd,CAAC,CAAC,CACH,CAAA;YAED,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACzB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;aACxB;SACF;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YAC1B,GAAG,CAAC,KAAK,CAAC,8BAA8B,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;YACtD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;SAClB;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CAAE,MAAc;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC1B,IAAI,OAAO,EAAE;YACX,qDAAqD;YACrD,MAAM,IAAI,CAAC,2BAA2B,CAAC,IAAI,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;SAC/D;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,2BAA2B,CAAE,gBAA0B,IAAI,QAAQ,CAAC,EAAE,CAAC;QAC3E,8CAA8C;QAC9C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE;YAC5C,OAAM;SACP;QAED,MAAM,eAAe,GAAa,EAAE,CAAA;QACpC,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;YACnD,qFAAqF;aACpF,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAC5B,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAC9F;aACA,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YACd,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;YACxE,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC5B,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBACxB,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;aAClB;YACD,OAAO,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAA;QAElC,yFAAyF;QACzF,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,KAAK,EAAE;YAC9B,MAAM,IAAI,CAAC,eAAe,CAAC,IAAkB,EAAE,EAAY,CAAC,CAAA;YAE5D,8CAA8C;YAC9C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE;gBAC5C,OAAM;aACP;SACF;QAED,sDAAsD;QACtD,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE;YACpC,8CAA8C;YAC9C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE;gBAC5C,OAAM;aACP;YAED,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAA;SACvC;QAED,2CAA2C;QAC3C,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,mBAAmB,CAAC,CAAA;YACrD,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;gBAC9E,IACE,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;oBAC9B,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAC3C;oBACA,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAA;oBAE1B,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;oBAC5E,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAA;oBAEtC,8CAA8C;oBAC9C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE;wBAC5C,OAAM;qBACP;iBACF;aACF;SACF;QAAC,OAAO,GAAQ,EAAE;YACjB,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,GAAG,CAAC,CAAA;YAC3D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;SAClB;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAE,MAAc;QACvC,IAAI;YACF,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBACzC,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACzD,OAAM;aACP;YACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;YACjF,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;SAC/C;QAAC,OAAO,GAAQ,EAAE;YACjB,GAAG,CAAC,KAAK,CAAC,0CAA0C,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;YAClE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;SAClB;IACH,CAAC;CA6CF"}

package/dist/src/circuit/constants.d.ts

@@ -10,16 +10,15 @@ export declare const ADVERTISE_TTL: number;
  * Multicodec code
  */
 export declare const CIRCUIT_PROTO_CODE = 290;
-/**
- * PeerStore metadaBook key for HOP relay service
- */
-export declare const HOP_METADATA_KEY = "hop_relay";
-/**
- * PeerStore metadaBook value for HOP relay service
- */
-export declare const HOP_METADATA_VALUE = "true";
 /**
  * Relay HOP relay service namespace for discovery
  */
 export declare const RELAY_RENDEZVOUS_NS = "/libp2p/relay";
+/**
+ * Maximum reservations for auto relay
+ */
+export declare const DEFAULT_MAX_RESERVATIONS = 1;
+export declare const RELAY_DESTINATION_TAG = "relay-destination";
+export declare const DEFAULT_DURATION_LIMIT: number;
+export declare const DEFAULT_DATA_LIMIT: bigint;
 //# sourceMappingURL=constants.d.ts.map

package/dist/src/circuit/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAc,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,aAAa,QAAc,CAAA;AAExC;;GAEG;AACH,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAErC;;GAEG;AACH,eAAO,MAAM,gBAAgB,cAAc,CAAA;AAE3C;;GAEG;AACH,eAAO,MAAM,kBAAkB,SAAS,CAAA;AAExC;;GAEG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAc,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,aAAa,QAAc,CAAA;AAExC;;GAEG;AACH,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAErC;;GAEG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,wBAAwB,IAAI,CAAA;AAEzC,eAAO,MAAM,qBAAqB,sBAAsB,CAAA;AAMxD,eAAO,MAAM,sBAAsB,QAAgB,CAAA;AAGnD,eAAO,MAAM,kBAAkB,QAAkB,CAAA"}

package/dist/src/circuit/constants.js

@@ -11,16 +11,19 @@ export const ADVERTISE_TTL = 30 * minute;
  * Multicodec code
  */
 export const CIRCUIT_PROTO_CODE = 290;
-/**
- * PeerStore metadaBook key for HOP relay service
- */
-export const HOP_METADATA_KEY = 'hop_relay';
-/**
- * PeerStore metadaBook value for HOP relay service
- */
-export const HOP_METADATA_VALUE = 'true';
 /**
  * Relay HOP relay service namespace for discovery
  */
 export const RELAY_RENDEZVOUS_NS = '/libp2p/relay';
+/**
+ * Maximum reservations for auto relay
+ */
+export const DEFAULT_MAX_RESERVATIONS = 1;
+export const RELAY_DESTINATION_TAG = 'relay-destination';
+// circuit v2 connection limits
+// https://github.com/libp2p/go-libp2p/blob/master/p2p/protocol/circuitv2/relay/resources.go#L61-L66
+// 2 min is the default connection duration
+export const DEFAULT_DURATION_LIMIT = 2 * 60 * 1000;
+// 128k is the default data limit
+export const DEFAULT_DATA_LIMIT = BigInt(1 << 17);
 //# sourceMappingURL=constants.js.map

package/dist/src/circuit/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,CAAA;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,MAAM,CAAA;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,GAAG,MAAM,CAAA;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAA;AAE3C;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAA;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAA"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,CAAA;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,MAAM,CAAA;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,GAAG,MAAM,CAAA;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAA;AAElD;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAA;AAEzC,MAAM,CAAC,MAAM,qBAAqB,GAAG,mBAAmB,CAAA;AAExD,+BAA+B;AAC/B,oGAAoG;AAEpG,2CAA2C;AAC3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA;AAEnD,iCAAiC;AACjC,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA"}

package/dist/src/circuit/hop.d.ts

@@ -0,0 +1,23 @@
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { Connection, Stream } from '@libp2p/interface-connection';
+import { HopMessage, Limit, Reservation } from './pb/index.js';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { Acl, ReservationStore } from './interfaces.js';
+import type { ConnectionManager } from '@libp2p/interface-connection-manager';
+import type { ProtobufStream } from 'it-pb-stream';
+import type { PeerStore } from '@libp2p/interface-peer-store';
+export interface HopProtocolOptions {
+    connection: Connection;
+    request: HopMessage;
+    stream: ProtobufStream<Stream>;
+    relayPeer: PeerId;
+    relayAddrs: Multiaddr[];
+    limit?: Limit;
+    acl?: Acl;
+    reservationStore: ReservationStore;
+    connectionManager: ConnectionManager;
+    peerStore: PeerStore;
+}
+export declare function handleHopProtocol(options: HopProtocolOptions): Promise<void>;
+export declare function reserve(connection: Connection): Promise<Reservation>;
+//# sourceMappingURL=hop.d.ts.map

package/dist/src/circuit/hop.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hop.d.ts","sourceRoot":"","sources":["../../../src/circuit/hop.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAGvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAuB,MAAM,eAAe,CAAA;AACnF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,OAAO,KAAK,EAAE,GAAG,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAK5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAGlD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAK7D,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,wBAAsB,iBAAiB,CAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAWnF;AAED,wBAAsB,OAAO,CAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,CAsB3E"}

package/dist/src/circuit/hop.js

@@ -0,0 +1,167 @@
+import { RecordEnvelope } from '@libp2p/peer-record';
+import { logger } from '@libp2p/logger';
+import { HopMessage, Status, StopMessage } from './pb/index.js';
+import { multiaddr } from '@multiformats/multiaddr';
+import { RELAY_V2_HOP_CODEC } from './multicodec.js';
+import { stop } from './stop.js';
+import { ReservationVoucherRecord } from './reservation-voucher.js';
+import { peerIdFromBytes } from '@libp2p/peer-id';
+import { pbStream } from 'it-pb-stream';
+import { CIRCUIT_PROTO_CODE, RELAY_DESTINATION_TAG } from './constants.js';
+import { createLimitedRelay } from './utils.js';
+const log = logger('libp2p:circuit:v2:hop');
+export async function handleHopProtocol(options) {
+    const { stream, request } = options;
+    log('received hop message');
+    switch (request.type) {
+        case HopMessage.Type.RESERVE:
+            await handleReserve(options);
+            break;
+        case HopMessage.Type.CONNECT:
+            await handleConnect(options);
+            break;
+        default: {
+            log.error('invalid hop request type %s via peer %s', options.request.type, options.connection.remotePeer);
+            stream.pb(HopMessage).write({ type: HopMessage.Type.STATUS, status: Status.UNEXPECTED_MESSAGE });
+        }
+    }
+}
+export async function reserve(connection) {
+    log('requesting reservation from %s', connection.remotePeer);
+    const stream = await connection.newStream([RELAY_V2_HOP_CODEC]);
+    const pbstr = pbStream(stream);
+    const hopstr = pbstr.pb(HopMessage);
+    hopstr.write({ type: HopMessage.Type.RESERVE });
+    let response;
+    try {
+        response = await hopstr.read();
+    }
+    catch (err) {
+        log.error('error passing reserve message response from %s because', connection.remotePeer, err.message);
+        stream.close();
+        throw err;
+    }
+    if (response.status === Status.OK && (response.reservation != null)) {
+        return response.reservation;
+    }
+    const errMsg = `reservation failed with status ${response.status ?? 'undefined'}`;
+    log.error(errMsg);
+    throw new Error(errMsg);
+}
+const isRelayAddr = (ma) => ma.protoCodes().includes(CIRCUIT_PROTO_CODE);
+async function handleReserve({ connection, stream: pbstr, relayPeer, relayAddrs, acl, reservationStore, peerStore }) {
+    const hopstr = pbstr.pb(HopMessage);
+    log('hop reserve request from %s', connection.remotePeer);
+    if (isRelayAddr(connection.remoteAddr)) {
+        log.error('relay reservation over circuit connection denied for peer: %p', connection.remotePeer);
+        hopstr.write({ type: HopMessage.Type.STATUS, status: Status.PERMISSION_DENIED });
+        return;
+    }
+    if ((await acl?.allowReserve?.(connection.remotePeer, connection.remoteAddr)) === false) {
+        log.error('acl denied reservation to %s', connection.remotePeer);
+        hopstr.write({ type: HopMessage.Type.STATUS, status: Status.PERMISSION_DENIED });
+        return;
+    }
+    const result = await reservationStore.reserve(connection.remotePeer, connection.remoteAddr);
+    if (result.status !== Status.OK) {
+        hopstr.write({ type: HopMessage.Type.STATUS, status: result.status });
+        return;
+    }
+    try {
+        // tag relayed peer
+        // result.expire is non-null if `ReservationStore.reserve` returns with status == OK
+        if (result.expire != null) {
+            const ttl = new Date().getTime() - result.expire;
+            await peerStore.tagPeer(relayPeer, RELAY_DESTINATION_TAG, { value: 1, ttl });
+        }
+        hopstr.write({
+            type: HopMessage.Type.STATUS,
+            status: Status.OK,
+            reservation: await makeReservation(relayAddrs, relayPeer, connection.remotePeer, BigInt(result.expire ?? 0)),
+            limit: (await reservationStore.get(relayPeer))?.limit
+        });
+        log('sent confirmation response to %s', connection.remotePeer);
+    }
+    catch (err) {
+        log.error('failed to send confirmation response to %s', connection.remotePeer);
+        await reservationStore.removeReservation(connection.remotePeer);
+    }
+}
+async function handleConnect(options) {
+    const { connection, stream, request, reservationStore, connectionManager, acl } = options;
+    const hopstr = stream.pb(HopMessage);
+    log('hop connect request from %s', connection.remotePeer);
+    let dstPeer;
+    try {
+        if (request.peer == null) {
+            log.error('no peer info in hop connect request');
+            throw new Error('no peer info in request');
+        }
+        request.peer.addrs.forEach(multiaddr);
+        dstPeer = peerIdFromBytes(request.peer.id);
+    }
+    catch (err) {
+        log.error('invalid hop connect request via peer %p %s', connection.remotePeer, err);
+        hopstr.write({ type: HopMessage.Type.STATUS, status: Status.MALFORMED_MESSAGE });
+        return;
+    }
+    if (acl?.allowConnect !== undefined) {
+        const status = await acl.allowConnect(connection.remotePeer, connection.remoteAddr, dstPeer);
+        if (status !== Status.OK) {
+            log.error('hop connect denied for %s with status %s', connection.remotePeer, status);
+            hopstr.write({ type: HopMessage.Type.STATUS, status: status });
+            return;
+        }
+    }
+    if (!await reservationStore.hasReservation(dstPeer)) {
+        log.error('hop connect denied for %s with status %s', connection.remotePeer, Status.NO_RESERVATION);
+        hopstr.write({ type: HopMessage.Type.STATUS, status: Status.NO_RESERVATION });
+        return;
+    }
+    const connections = connectionManager.getConnections(dstPeer);
+    if (connections.length === 0) {
+        log('hop connect denied for %s as there is no destination connection', connection.remotePeer);
+        hopstr.write({ type: HopMessage.Type.STATUS, status: Status.NO_RESERVATION });
+        return;
+    }
+    const destinationConnection = connections[0];
+    log('hop connect request from %s to %s is valid', connection.remotePeer, dstPeer);
+    const destinationStream = await stop({
+        connection: destinationConnection,
+        request: {
+            type: StopMessage.Type.CONNECT,
+            peer: {
+                id: connection.remotePeer.toBytes(),
+                addrs: [multiaddr('/p2p/' + connection.remotePeer.toString()).bytes]
+            }
+        }
+    });
+    if (destinationStream == null) {
+        log.error('failed to open stream to destination peer %s', destinationConnection?.remotePeer);
+        hopstr.write({ type: HopMessage.Type.STATUS, status: Status.CONNECTION_FAILED });
+        return;
+    }
+    hopstr.write({ type: HopMessage.Type.STATUS, status: Status.OK });
+    const sourceStream = stream.unwrap();
+    log('connection to destination established, short circuiting streams...');
+    const limit = (await reservationStore.get(dstPeer))?.limit;
+    // Short circuit the two streams to create the relayed connection
+    return createLimitedRelay(sourceStream, destinationStream, limit);
+}
+async function makeReservation(relayAddrs, relayPeerId, remotePeer, expire) {
+    const addrs = [];
+    for (const relayAddr of relayAddrs) {
+        addrs.push(relayAddr.bytes);
+    }
+    const voucher = await RecordEnvelope.seal(new ReservationVoucherRecord({
+        peer: remotePeer,
+        relay: relayPeerId,
+        expiration: Number(expire)
+    }), relayPeerId);
+    return {
+        addrs,
+        expire,
+        voucher: voucher.marshal()
+    };
+}
+//# sourceMappingURL=hop.js.map