libp2p 0.42.2-593deefe → 0.42.2-75d5a36f

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

@@ -15,10 +15,36 @@ export declare const CIRCUIT_PROTO_CODE = 290;
  */
 export declare const RELAY_RENDEZVOUS_NS = "/libp2p/relay";
 /**
- * Maximum reservations for auto relay
+ * The maximum number of relay reservations the relay server will accept
  */
-export declare const DEFAULT_MAX_RESERVATIONS = 1;
-export declare const RELAY_DESTINATION_TAG = "relay-destination";
+export declare const DEFAULT_MAX_RESERVATION_STORE_SIZE = 15;
+/**
+ * How often to check for reservation expiry
+ */
+export declare const DEFAULT_MAX_RESERVATION_CLEAR_INTERVAL: number;
+/**
+ * How often to check for reservation expiry
+ */
+export declare const DEFAULT_MAX_RESERVATION_TTL: number;
+export declare const DEFAULT_RESERVATION_CONCURRENCY = 1;
+export declare const RELAY_SOURCE_TAG = "circuit-relay-source";
+export declare const RELAY_TAG = "circuit-relay-relay";
 export declare const DEFAULT_DURATION_LIMIT: number;
 export declare const DEFAULT_DATA_LIMIT: bigint;
+/**
+ * The hop protocol
+ */
+export declare const RELAY_V2_HOP_CODEC = "/libp2p/circuit/relay/0.2.0/hop";
+/**
+ * the stop protocol
+ */
+export declare const RELAY_V2_STOP_CODEC = "/libp2p/circuit/relay/0.2.0/stop";
+/**
+ * Hop messages must be exchanged inside this timeout
+ */
+export declare const DEFAULT_HOP_TIMEOUT: number;
+/**
+ * How long to wait before starting to advertise the relay service
+ */
+export declare const DEFAULT_ADVERT_BOOT_DELAY: number;
 //# 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,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"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAGA;;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,kCAAkC,KAAK,CAAA;AAEpD;;GAEG;AACH,eAAO,MAAM,sCAAsC,QAAe,CAAA;AAElE;;GAEG;AACH,eAAO,MAAM,2BAA2B,QAAkB,CAAA;AAE1D,eAAO,MAAM,+BAA+B,IAAI,CAAA;AAEhD,eAAO,MAAM,gBAAgB,yBAAyB,CAAA;AAEtD,eAAO,MAAM,SAAS,wBAAwB,CAAA;AAM9C,eAAO,MAAM,sBAAsB,QAAa,CAAA;AAGhD,eAAO,MAAM,kBAAkB,QAAkB,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,kBAAkB,oCAAoC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,mBAAmB,qCAAqC,CAAA;AAErE;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAc,CAAA;AAE9C;;GAEG;AACH,eAAO,MAAM,yBAAyB,QAAc,CAAA"}

package/dist/src/circuit/constants.js

@@ -1,4 +1,5 @@
-const minute = 60 * 1000;
+const second = 1000;
+const minute = 60 * second;
 /**
  * Delay before HOP relay service is advertised on the network
  */
@@ -16,14 +17,40 @@ export const CIRCUIT_PROTO_CODE = 290;
  */
 export const RELAY_RENDEZVOUS_NS = '/libp2p/relay';
 /**
- * Maximum reservations for auto relay
+ * The maximum number of relay reservations the relay server will accept
  */
-export const DEFAULT_MAX_RESERVATIONS = 1;
-export const RELAY_DESTINATION_TAG = 'relay-destination';
+export const DEFAULT_MAX_RESERVATION_STORE_SIZE = 15;
+/**
+ * How often to check for reservation expiry
+ */
+export const DEFAULT_MAX_RESERVATION_CLEAR_INTERVAL = 300 * second;
+/**
+ * How often to check for reservation expiry
+ */
+export const DEFAULT_MAX_RESERVATION_TTL = 2 * 60 * minute;
+export const DEFAULT_RESERVATION_CONCURRENCY = 1;
+export const RELAY_SOURCE_TAG = 'circuit-relay-source';
+export const RELAY_TAG = 'circuit-relay-relay';
 // 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;
+export const DEFAULT_DURATION_LIMIT = 2 * minute;
 // 128k is the default data limit
 export const DEFAULT_DATA_LIMIT = BigInt(1 << 17);
+/**
+ * The hop protocol
+ */
+export const RELAY_V2_HOP_CODEC = '/libp2p/circuit/relay/0.2.0/hop';
+/**
+ * the stop protocol
+ */
+export const RELAY_V2_STOP_CODEC = '/libp2p/circuit/relay/0.2.0/stop';
+/**
+ * Hop messages must be exchanged inside this timeout
+ */
+export const DEFAULT_HOP_TIMEOUT = 30 * second;
+/**
+ * How long to wait before starting to advertise the relay service
+ */
+export const DEFAULT_ADVERT_BOOT_DELAY = 30 * second;
 //# 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,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"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,IAAI,CAAA;AACnB,MAAM,MAAM,GAAG,EAAE,GAAG,MAAM,CAAA;AAE1B;;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,kCAAkC,GAAG,EAAE,CAAA;AAEpD;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,GAAG,GAAG,MAAM,CAAA;AAElE;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,GAAG,EAAE,GAAG,MAAM,CAAA;AAE1D,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAA;AAEhD,MAAM,CAAC,MAAM,gBAAgB,GAAG,sBAAsB,CAAA;AAEtD,MAAM,CAAC,MAAM,SAAS,GAAG,qBAAqB,CAAA;AAE9C,+BAA+B;AAC/B,oGAAoG;AAEpG,2CAA2C;AAC3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAG,MAAM,CAAA;AAEhD,iCAAiC;AACjC,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,iCAAiC,CAAA;AAEnE;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,kCAAkC,CAAA;AAErE;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,MAAM,CAAA;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,EAAE,GAAG,MAAM,CAAA"}

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

@@ -1,65 +1,20 @@
-/**
- * RelayConfig configures the circuit v2 relay transport.
- */
-export interface RelayConfig {
-    /**
-     * Enable dialing a client over a relay and receiving relayed connections.
-     * This in itself does not enable the node to act as a relay.
-     */
-    enabled: boolean;
-    advertise: RelayAdvertiseConfig;
-    hop: HopConfig;
-    reservationManager: RelayReservationManagerConfig;
+import type { EventEmitter } from '@libp2p/interfaces/events';
+import type { PeerMap } from '@libp2p/peer-collections';
+import type { Limit } from './pb/index.js';
+import type { Multiaddr } from '@multiformats/multiaddr';
+export interface RelayReservation {
+    expire: Date;
+    addr: Multiaddr;
+    limit?: Limit;
 }
-/**
- * RelayReservationManagerConfig allows the node to automatically listen
- * on any discovered relays upto a specified maximum.
- */
-export interface RelayReservationManagerConfig {
-    /**
-     * enable or disable autorelay (default: false)
-     */
-    enabled?: boolean;
-    /**
-     * maximum number of relays to listen (default: 1)
-     */
-    maxReservations?: number;
+export interface CircuitRelayServiceEvents {
+    'relay:reservation': CustomEvent<RelayReservation>;
+    'relay:advert:success': CustomEvent<unknown>;
+    'relay:advert:error': CustomEvent<Error>;
 }
-/**
- * Configures using the node as a HOP relay
- */
-export interface HopConfig {
-    /**
-     * If true this node will function as a limited relay (default: false)
-     */
-    enabled?: boolean;
-    /**
-     * timeout for hop requests to complete
-     */
-    timeout: number;
-    /**
-     * If false, no connection limits will be applied to relayed connections (default: true)
-     */
-    applyConnectionLimits?: boolean;
-    /**
-     * Limits to apply to incoming relay connections - relayed connections will be closed if
-     * these limits are exceeded.
-     */
-    limit?: {
-        /**
-         * How long to relay a connection for in milliseconds (default: 2m)
-         */
-        duration?: number;
-        /**
-         * How many bytes to allow to be transferred over a relayed connection (default: 128k)
-         */
-        data?: bigint;
-    };
+export interface CircuitRelayService extends EventEmitter<CircuitRelayServiceEvents> {
+    reservations: PeerMap<RelayReservation>;
 }
-export interface RelayAdvertiseConfig {
-    bootDelay?: number;
-    enabled?: boolean;
-    ttl?: number;
-}
-export { Relay } from './relay.js';
+export { circuitRelayServer } from './server/index.js';
+export { circuitRelayTransport } from './transport/index.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/circuit/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,oBAAoB,CAAA;IAC/B,GAAG,EAAE,SAAS,CAAA;IACd,kBAAkB,EAAE,6BAA6B,CAAA;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAE/B;;;OAGG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QAEjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/circuit/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,IAAI,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,MAAM,WAAW,yBAAyB;IACxC,mBAAmB,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAA;IAClD,sBAAsB,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC5C,oBAAoB,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;CACzC;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY,CAAC,yBAAyB,CAAC;IAClF,YAAY,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;CACxC;AAED,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/src/circuit/index.js

@@ -1,2 +1,3 @@
-export { Relay } from './relay.js';
+export { circuitRelayServer } from './server/index.js';
+export { circuitRelayTransport } from './transport/index.js';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/circuit/index.ts"],"names":[],"mappings":"AAwEA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/circuit/index.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/src/circuit/server/advert-service.d.ts

@@ -0,0 +1,43 @@
+import type { Startable } from '@libp2p/interfaces/startable';
+import type { ContentRouting } from '@libp2p/interface-content-routing';
+import { EventEmitter } from '@libp2p/interfaces/events';
+export interface AdvertServiceInit {
+    /**
+     * How long to wait after startup to begin advertising the service
+     * - if some configured content routers take a while to warm up (for
+     * example, the DHT needs some peers to be able to publish) this
+     * value should be high enough that they will have warmed up
+     */
+    bootDelay?: number;
+}
+export interface AdvertServiceComponents {
+    contentRouting: ContentRouting;
+}
+export interface AdvertServiceEvents {
+    'advert:success': CustomEvent<unknown>;
+    'advert:error': CustomEvent<Error>;
+}
+export declare class AdvertService extends EventEmitter<AdvertServiceEvents> implements Startable {
+    private readonly contentRouting;
+    private timeout?;
+    private started;
+    private readonly bootDelay;
+    /**
+     * Creates an instance of Relay
+     */
+    constructor(components: AdvertServiceComponents, init?: AdvertServiceInit);
+    isStarted(): boolean;
+    /**
+     * Start Relay service
+     */
+    start(): void;
+    /**
+     * Stop Relay service
+     */
+    stop(): void;
+    /**
+     * Advertise hop relay service in the network.
+     */
+    _advertiseService(): Promise<void>;
+}
+//# sourceMappingURL=advert-service.d.ts.map

package/dist/src/circuit/server/advert-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"advert-service.d.ts","sourceRoot":"","sources":["../../../../src/circuit/server/advert-service.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,EAAe,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAKrE,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,cAAc,EAAE,cAAc,CAAA;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IACtC,cAAc,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;CACnC;AAED,qBAAa,aAAc,SAAQ,YAAY,CAAC,mBAAmB,CAAE,YAAW,SAAS;IACvF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,OAAO,CAAC,CAAK;IACrB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAQ;IAElC;;OAEG;gBACU,UAAU,EAAE,uBAAuB,EAAE,IAAI,CAAC,EAAE,iBAAiB;IAQ1E,SAAS,IAAK,OAAO;IAIrB;;OAEG;IACH,KAAK,IAAK,IAAI;IAed;;OAEG;IACH,IAAI,IAAK,IAAI;IAQb;;OAEG;IACG,iBAAiB,IAAK,OAAO,CAAC,IAAI,CAAC;CAqB1C"}

package/dist/src/circuit/server/advert-service.js

@@ -0,0 +1,69 @@
+import { logger } from '@libp2p/logger';
+import { codes } from '../../errors.js';
+import { namespaceToCid } from '../utils.js';
+import { DEFAULT_ADVERT_BOOT_DELAY, RELAY_RENDEZVOUS_NS } from '../constants.js';
+import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events';
+import pRetry from 'p-retry';
+const log = logger('libp2p:circuit-relay:advert-service');
+export class AdvertService extends EventEmitter {
+    /**
+     * Creates an instance of Relay
+     */
+    constructor(components, init) {
+        super();
+        this.contentRouting = components.contentRouting;
+        this.bootDelay = init?.bootDelay ?? DEFAULT_ADVERT_BOOT_DELAY;
+        this.started = false;
+    }
+    isStarted() {
+        return this.started;
+    }
+    /**
+     * Start Relay service
+     */
+    start() {
+        if (this.started) {
+            return;
+        }
+        // Advertise service if HOP enabled and advertising enabled
+        this.timeout = setTimeout(() => {
+            this._advertiseService().catch(err => {
+                log.error('could not advertise service', err);
+            });
+        }, this.bootDelay);
+        this.started = true;
+    }
+    /**
+     * Stop Relay service
+     */
+    stop() {
+        try {
+            clearTimeout(this.timeout);
+        }
+        catch (err) { }
+        this.started = false;
+    }
+    /**
+     * Advertise hop relay service in the network.
+     */
+    async _advertiseService() {
+        await pRetry(async () => {
+            try {
+                const cid = await namespaceToCid(RELAY_RENDEZVOUS_NS);
+                await this.contentRouting.provide(cid);
+                this.dispatchEvent(new CustomEvent('advert:success'));
+            }
+            catch (err) {
+                this.safeDispatchEvent('advert:error', { detail: err });
+                if (err.code === codes.ERR_NO_ROUTERS_AVAILABLE) {
+                    log.error('a content router, such as a DHT, must be provided in order to advertise the relay service', err);
+                    await this.stop();
+                    return;
+                }
+                log.error('could not advertise service', err);
+                throw err;
+            }
+        });
+    }
+}
+//# sourceMappingURL=advert-service.js.map

package/dist/src/circuit/server/advert-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"advert-service.js","sourceRoot":"","sources":["../../../../src/circuit/server/advert-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EACL,yBAAyB,EACzB,mBAAmB,EACpB,MAAM,iBAAiB,CAAA;AAGxB,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,MAAM,MAAM,SAAS,CAAA;AAE5B,MAAM,GAAG,GAAG,MAAM,CAAC,qCAAqC,CAAC,CAAA;AAqBzD,MAAM,OAAO,aAAc,SAAQ,YAAiC;IAMlE;;OAEG;IACH,YAAa,UAAmC,EAAE,IAAwB;QACxE,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,yBAAyB,CAAA;QAC7D,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAM;SACP;QAED,2DAA2D;QAC3D,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC7B,IAAI,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACnC,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;YAC/C,CAAC,CAAC,CAAA;QACJ,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QAElB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI;YACF,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;SAC3B;QAAC,OAAO,GAAG,EAAE,GAAG;QAEjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,MAAM,CAAC,KAAK,IAAI,EAAE;YACtB,IAAI;gBACF,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,mBAAmB,CAAC,CAAA;gBACrD,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBAEtC,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAA;aACtD;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;gBAEvD,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,wBAAwB,EAAE;oBAC/C,GAAG,CAAC,KAAK,CAAC,2FAA2F,EAAE,GAAG,CAAC,CAAA;oBAC3G,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;oBACjB,OAAM;iBACP;gBAED,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;gBAC7C,MAAM,GAAG,CAAA;aACV;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,60 @@
+import type { PeerStore } from '@libp2p/interface-peer-store';
+import { ReservationStoreInit } from './reservation-store.js';
+import type { Registrar } from '@libp2p/interface-registrar';
+import { AdvertServiceComponents, AdvertServiceInit } from './advert-service.js';
+import { ProtobufStream } from 'it-pb-stream';
+import { HopMessage, StopMessage } from '../pb/index.js';
+import type { Connection, Stream } from '@libp2p/interface-connection';
+import type { ConnectionGater } from '@libp2p/interface-connection-gater';
+import type { PeerId } from '@libp2p/interface-peer-id';
+import type { AddressManager } from '@libp2p/interface-address-manager';
+import type { ConnectionManager } from '@libp2p/interface-connection-manager';
+import type { CircuitRelayService, RelayReservation } from '../index.js';
+export interface CircuitRelayServerInit {
+    /**
+     * Incoming hop requests must complete within this time in ms otherwise
+     * the stream will be reset (default: 30s)
+     */
+    hopTimeout?: number;
+    /**
+     * If true, advertise this service via libp2p content routing to allow
+     * peers to locate us on the network (default: false)
+     */
+    advertise?: boolean | AdvertServiceInit;
+    /**
+     * Configuration of reservations
+     */
+    reservations?: ReservationStoreInit;
+    /**
+     * The maximum number of simultaneous HOP inbound streams that can be open at once
+     */
+    maxInboundHopStreams?: number;
+    /**
+     * The maximum number of simultaneous HOP outbound streams that can be open at once
+     */
+    maxOutboundHopStreams?: number;
+}
+export interface HopProtocolOptions {
+    connection: Connection;
+    request: HopMessage;
+    stream: ProtobufStream<Stream>;
+}
+export interface StopOptions {
+    connection: Connection;
+    request: StopMessage;
+}
+export interface CircuitRelayServerComponents extends AdvertServiceComponents {
+    registrar: Registrar;
+    peerStore: PeerStore;
+    addressManager: AddressManager;
+    peerId: PeerId;
+    connectionManager: ConnectionManager;
+    connectionGater: ConnectionGater;
+}
+export interface RelayServerEvents {
+    'relay:reservation': CustomEvent<RelayReservation>;
+    'relay:advert:success': CustomEvent<unknown>;
+    'relay:advert:error': CustomEvent<Error>;
+}
+export declare function circuitRelayServer(init?: CircuitRelayServerInit): (components: CircuitRelayServerComponents) => CircuitRelayService;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/circuit/server/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAE7D,OAAO,EAAoB,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC/E,OAAO,KAAK,EAAsB,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAChF,OAAO,EAAiB,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAE/F,OAAO,EAAY,cAAc,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,UAAU,EAAuB,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAE7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAA;AAEzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAGvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAC7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAQxE,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAA;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAA;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E,SAAS,EAAE,SAAS,CAAA;IACpB,SAAS,EAAE,SAAS,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,eAAe,EAAE,eAAe,CAAA;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC,mBAAmB,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAA;IAClD,sBAAsB,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC5C,oBAAoB,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;CACzC;AAyUD,wBAAgB,kBAAkB,CAAE,IAAI,GAAE,sBAA2B,GAAG,CAAC,UAAU,EAAE,4BAA4B,KAAK,mBAAmB,CAIxI"}