@libp2p/circuit-relay-v2 1.0.24 → 1.0.25-44791342

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

@@ -1,72 +0,0 @@
-import { TypedEventEmitter } from '@libp2p/interface';
-import pRetry from 'p-retry';
-import { DEFAULT_ADVERT_BOOT_DELAY, ERR_NO_ROUTERS_AVAILABLE, RELAY_RENDEZVOUS_NS } from '../constants.js';
-import { namespaceToCid } from '../utils.js';
-export class AdvertService extends TypedEventEmitter {
-    contentRouting;
-    timeout;
-    started;
-    bootDelay;
-    log;
-    /**
-     * Creates an instance of Relay
-     */
-    constructor(components, init) {
-        super();
-        this.log = components.logger.forComponent('libp2p:circuit-relay:advert-service');
-        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 => {
-                this.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.safeDispatchEvent('advert:success', { detail: undefined });
-            }
-            catch (err) {
-                this.safeDispatchEvent('advert:error', { detail: err });
-                if (err.code === ERR_NO_ROUTERS_AVAILABLE) {
-                    this.log.error('a content router, such as a DHT, must be provided in order to advertise the relay service', err);
-                    this.stop();
-                    return;
-                }
-                this.log.error('could not advertise service', err);
-                throw err;
-            }
-        });
-    }
-}
-//# sourceMappingURL=advert-service.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"advert-service.js","sourceRoot":"","sources":["../../../src/server/advert-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EACL,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAuB5C,MAAM,OAAO,aAAc,SAAQ,iBAAsC;IACtD,cAAc,CAAgB;IACvC,OAAO,CAAM;IACb,OAAO,CAAS;IACP,SAAS,CAAQ;IACjB,GAAG,CAAQ;IAE5B;;OAEG;IACH,YAAa,UAAmC,EAAE,IAAwB;QACxE,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,qCAAqC,CAAC,CAAA;QAChF,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,CAAC;YACjB,OAAM;QACR,CAAC;QAED,2DAA2D;QAC3D,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC7B,IAAI,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACnC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;YACpD,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,CAAC;YACH,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC5B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC;QAEjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,MAAM,CAAC,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,mBAAmB,CAAC,CAAA;gBACrD,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;gBAEtC,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;YACjE,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;gBAEvD,IAAI,GAAG,CAAC,IAAI,KAAK,wBAAwB,EAAE,CAAC;oBAC1C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2FAA2F,EAAE,GAAG,CAAC,CAAA;oBAChH,IAAI,CAAC,IAAI,EAAE,CAAA;oBACX,OAAM;gBACR,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;gBAClD,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/typedoc-urls.json

@@ -1,12 +0,0 @@
-{
-  "CircuitRelayService": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html",
-  ".:CircuitRelayService": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.CircuitRelayService.html",
-  "CircuitRelayServiceEvents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html",
-  ".:CircuitRelayServiceEvents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.CircuitRelayServiceEvents.html",
-  "RelayReservation": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html",
-  ".:RelayReservation": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_circuit_relay_v2.RelayReservation.html",
-  "RELAY_V2_HOP_CODEC": "https://libp2p.github.io/js-libp2p/variables/_libp2p_circuit_relay_v2.RELAY_V2_HOP_CODEC.html",
-  "RELAY_V2_STOP_CODEC": "https://libp2p.github.io/js-libp2p/variables/_libp2p_circuit_relay_v2.RELAY_V2_STOP_CODEC.html",
-  "circuitRelayServer": "https://libp2p.github.io/js-libp2p/functions/_libp2p_circuit_relay_v2.circuitRelayServer.html",
-  "circuitRelayTransport": "https://libp2p.github.io/js-libp2p/functions/_libp2p_circuit_relay_v2.circuitRelayTransport.html"
-}

package/src/server/advert-service.ts

@@ -1,107 +0,0 @@
-import { TypedEventEmitter } from '@libp2p/interface'
-import pRetry from 'p-retry'
-import {
-  DEFAULT_ADVERT_BOOT_DELAY,
-  ERR_NO_ROUTERS_AVAILABLE,
-  RELAY_RENDEZVOUS_NS
-} from '../constants.js'
-import { namespaceToCid } from '../utils.js'
-import type { ComponentLogger, Logger, ContentRouting, Startable } from '@libp2p/interface'
-
-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
-  logger: ComponentLogger
-}
-
-export interface AdvertServiceEvents {
-  'advert:success': CustomEvent<unknown>
-  'advert:error': CustomEvent<Error>
-}
-
-export class AdvertService extends TypedEventEmitter<AdvertServiceEvents> implements Startable {
-  private readonly contentRouting: ContentRouting
-  private timeout?: any
-  private started: boolean
-  private readonly bootDelay: number
-  private readonly log: Logger
-
-  /**
-   * Creates an instance of Relay
-   */
-  constructor (components: AdvertServiceComponents, init?: AdvertServiceInit) {
-    super()
-
-    this.log = components.logger.forComponent('libp2p:circuit-relay:advert-service')
-    this.contentRouting = components.contentRouting
-    this.bootDelay = init?.bootDelay ?? DEFAULT_ADVERT_BOOT_DELAY
-    this.started = false
-  }
-
-  isStarted (): boolean {
-    return this.started
-  }
-
-  /**
-   * Start Relay service
-   */
-  start (): void {
-    if (this.started) {
-      return
-    }
-
-    // Advertise service if HOP enabled and advertising enabled
-    this.timeout = setTimeout(() => {
-      this._advertiseService().catch(err => {
-        this.log.error('could not advertise service', err)
-      })
-    }, this.bootDelay)
-
-    this.started = true
-  }
-
-  /**
-   * Stop Relay service
-   */
-  stop (): void {
-    try {
-      clearTimeout(this.timeout)
-    } catch (err) { }
-
-    this.started = false
-  }
-
-  /**
-   * Advertise hop relay service in the network.
-   */
-  async _advertiseService (): Promise<void> {
-    await pRetry(async () => {
-      try {
-        const cid = await namespaceToCid(RELAY_RENDEZVOUS_NS)
-        await this.contentRouting.provide(cid)
-
-        this.safeDispatchEvent('advert:success', { detail: undefined })
-      } catch (err: any) {
-        this.safeDispatchEvent('advert:error', { detail: err })
-
-        if (err.code === ERR_NO_ROUTERS_AVAILABLE) {
-          this.log.error('a content router, such as a DHT, must be provided in order to advertise the relay service', err)
-          this.stop()
-          return
-        }
-
-        this.log.error('could not advertise service', err)
-        throw err
-      }
-    })
-  }
-}