@libp2p/upnp-nat 3.0.5-bf0f74d66 → 3.0.5-c1d0b7fa4

package/src/constants.ts

@@ -1,7 +1,2 @@
-export const DEFAULT_INITIAL_GATEWAY_SEARCH_INTERVAL = 5_000
-export const DEFAULT_INITIAL_GATEWAY_SEARCH_TIMEOUT = 5_000
-export const DEFAULT_INITIAL_GATEWAY_SEARCH_MESSAGE_INTERVAL = 1_000
-
 export const DEFAULT_GATEWAY_SEARCH_TIMEOUT = 60_000
 export const DEFAULT_GATEWAY_SEARCH_INTERVAL = 300_000
-export const DEFAULT_GATEWAY_SEARCH_MESSAGE_INTERVAL = 10_000

package/src/gateway-finder.ts

@@ -0,0 +1,75 @@
+import { TypedEventEmitter, start, stop } from '@libp2p/interface'
+import { repeatingTask } from '@libp2p/utils/repeating-task'
+import { DEFAULT_GATEWAY_SEARCH_INTERVAL, DEFAULT_GATEWAY_SEARCH_TIMEOUT } from './constants.js'
+import type { Gateway, UPnPNAT } from '@achingbrain/nat-port-mapper'
+import type { ComponentLogger, Logger } from '@libp2p/interface'
+import type { RepeatingTask } from '@libp2p/utils/repeating-task'
+
+export interface GatewayFinderComponents {
+  logger: ComponentLogger
+}
+
+export interface GatewayFinderInit {
+  portMappingClient: UPnPNAT
+}
+
+export interface GatewayFinderEvents {
+  'gateway': CustomEvent<Gateway>
+}
+
+export class GatewayFinder extends TypedEventEmitter<GatewayFinderEvents> {
+  private readonly log: Logger
+  private readonly gateways: Gateway[]
+  private readonly findGateways: RepeatingTask
+  private readonly portMappingClient: UPnPNAT
+  private started: boolean
+
+  constructor (components: GatewayFinderComponents, init: GatewayFinderInit) {
+    super()
+
+    this.log = components.logger.forComponent('libp2p:upnp-nat')
+    this.portMappingClient = init.portMappingClient
+    this.started = false
+    this.gateways = []
+
+    // every five minutes, search for network gateways for one minute
+    this.findGateways = repeatingTask(async (options) => {
+      for await (const gateway of this.portMappingClient.findGateways({
+        ...options,
+        searchInterval: 10000
+      })) {
+        if (this.gateways.some(g => {
+          return g.id === gateway.id && g.family === gateway.family
+        })) {
+          // already seen this gateway
+          continue
+        }
+
+        this.gateways.push(gateway)
+        this.safeDispatchEvent('gateway', {
+          detail: gateway
+        })
+      }
+    }, DEFAULT_GATEWAY_SEARCH_INTERVAL, {
+      runImmediately: true,
+      timeout: DEFAULT_GATEWAY_SEARCH_TIMEOUT
+    })
+  }
+
+  async start (): Promise<void> {
+    if (this.started) {
+      return
+    }
+
+    this.started = true
+    await start(this.findGateways)
+  }
+
+  /**
+   * Stops the NAT manager
+   */
+  async stop (): Promise<void> {
+    await stop(this.findGateways)
+    this.started = false
+  }
+}

package/src/index.ts

@@ -33,46 +33,6 @@
  *   }
  * })
  * ```
- *
- * @example Manually specifying gateways and external ports
- *
- * Some ISP-provided routers are underpowered and may require rebooting before
- * they will respond to SSDP M-SEARCH messages.
- *
- * You can manually specify your external address and/or gateways, though note
- * that those gateways will still need to have UPnP enabled in order for libp2p
- * to configure mapping of external ports (for IPv4) and/or opening pinholes in
- * the firewall (for IPv6).
- *
- * ```typescript
- * import { createLibp2p } from 'libp2p'
- * import { tcp } from '@libp2p/tcp'
- * import { uPnPNAT } from '@libp2p/upnp-nat'
- *
- * const node = await createLibp2p({
- *   addresses: {
- *     listen: [
- *       '/ip4/0.0.0.0/tcp/0'
- *     ]
- *   },
- *   transports: [
- *     tcp()
- *   ],
- *   services: {
- *     upnpNAT: uPnPNAT({
- *       // manually specify external address - this will normally be an IPv4
- *       // address that the router is performing NAT with
- *       externalAddress: '92.137.164.96',
- *       gateways: [
- *         // an IPv4 gateway
- *         'http://192.168.1.1:8080/path/to/descriptor.xml',
- *         // an IPv6 gateway
- *         'http://[xx:xx:xx:xx]:8080/path/to/descriptor.xml'
- *       ]
- *     })
- *   }
- * })
- * ```
  */
 
 import { UPnPNAT as UPnPNATClass } from './upnp-nat.js'
@@ -90,14 +50,6 @@ export interface PMPOptions {
 }
 
 export interface UPnPNATInit {
-  /**
-   * By default we query discovered/configured gateways for their external
-   * address. To specify it manually instead, pass a value here.
-   *
-   * Typically this would be an IPv4 address that the router performs NAT with.
-   */
-  externalAddress?: string
-
   /**
    * Check if the external address has changed this often in ms. Ignored if an
    * external address is specified.
@@ -157,91 +109,6 @@ export interface UPnPNATInit {
    * @default false
    */
   autoConfirmAddress?: boolean
-
-  /**
-   * By default we search for local gateways using SSDP M-SEARCH messages. To
-   * manually specify a gateway instead, pass values here.
-   *
-   * A lot of ISP-provided gateway/routers are underpowered so may need
-   * rebooting before they will respond to M-SEARCH messages.
-   *
-   * Each value is an IPv4 or IPv6 URL of the UPnP device descriptor document,
-   * e.g. `http://192.168.1.1:8080/description.xml`. Please see the
-   * documentation of your gateway to discover the URL.
-   *
-   * Note that some gateways will randomise the port/path the descriptor
-   * document is served from and even change it over time so you may be forced
-   * to use an SSDP search instead.
-   */
-  gateways?: string[]
-
-  /**
-   * How often to search for network gateways in ms.
-   *
-   * This interval is used before a gateway has been found on the network, after
-   * that it switches to `gatewaySearchInterval` which lowers the frequency of
-   * the search.
-   *
-   * @default 5_000
-   */
-  initialGatewaySearchInterval?: number
-
-  /**
-   * How often to send the `M-SEARCH` SSDP message during a gateway search in
-   * ms.
-   *
-   * Some routers are flaky and may not respond to every query so decreasing
-   * this will increase the number of search messages sent before the timeout.
-   *
-   * This interval is used before a gateway has been found on the network, after
-   * that it switches to `gatewaySearchMessageInterval` which lowers the
-   * frequency of search messages sent.
-   *
-   * @default 1_000
-   */
-  initialGatewaySearchMessageInterval?: number
-
-  /**
-   * How long to search for gateways for before giving up in ms.
-   *
-   * This timeout is used before a gateway has been found on the network, after
-   * that it switches to `gatewaySearchTimeout` which increases the timeout to
-   * give gateways more time to respond.
-   *
-   * @default 5_000
-   */
-  initialGatewaySearchTimeout?: number
-
-  /**
-   * How often to search for network gateways in ms.
-   *
-   * This interval is used after a gateway has been found on the network.
-   *
-   * @default 300_000
-   */
-  gatewaySearchInterval?: number
-
-  /**
-   * How often to send the `M-SEARCH` SSDP message during a gateway search in
-   * ms.
-   *
-   * Some routers are flaky and may not respond to every query so decreasing
-   * this will increase the number of search messages sent before the timeout.
-   *
-   * This interval is used after a gateway has been found on the network.
-   *
-   * @default 10_000
-   */
-  gatewaySearchMessageInterval?: number
-
-  /**
-   * How long to search for gateways for before giving up in ms.
-   *
-   * This timeout is used after a gateway has been found on the network.
-   *
-   * @default 60_000
-   */
-  gatewaySearchTimeout?: number
 }
 
 export interface UPnPNATComponents {

package/src/upnp-nat.ts

@@ -1,22 +1,13 @@
 import { upnpNat } from '@achingbrain/nat-port-mapper'
 import { serviceCapabilities, serviceDependencies, setMaxListeners, start, stop } from '@libp2p/interface'
 import { debounce } from '@libp2p/utils/debounce'
-import { SearchGatewayFinder } from './search-gateway-finder.js'
-import { StaticGatewayFinder } from './static-gateway-finder.js'
+import { GatewayFinder } from './gateway-finder.js'
 import { UPnPPortMapper } from './upnp-port-mapper.js'
 import type { UPnPNATComponents, UPnPNATInit, UPnPNAT as UPnPNATInterface } from './index.js'
 import type { Gateway, UPnPNAT as UPnPNATClient } from '@achingbrain/nat-port-mapper'
-import type { Logger, Startable, TypedEventTarget } from '@libp2p/interface'
+import type { Logger, Startable } from '@libp2p/interface'
 import type { DebouncedFunction } from '@libp2p/utils/debounce'
 
-export interface GatewayFinderEvents {
-  'gateway': CustomEvent<Gateway>
-}
-
-export interface GatewayFinder extends TypedEventTarget<GatewayFinderEvents> {
-
-}
-
 export class UPnPNAT implements Startable, UPnPNATInterface {
   private readonly log: Logger
   private readonly components: UPnPNATComponents
@@ -53,23 +44,10 @@ export class UPnPNAT implements Startable, UPnPNATInterface {
       }
     }, 5_000)
 
-    if (init.gateways != null) {
-      this.gatewayFinder = new StaticGatewayFinder(components, {
-        portMappingClient: this.portMappingClient,
-        gateways: init.gateways
-      })
-    } else {
-      // trigger update when we discovery gateways on the network
-      this.gatewayFinder = new SearchGatewayFinder(components, {
-        portMappingClient: this.portMappingClient,
-        initialSearchInterval: init.initialGatewaySearchInterval,
-        initialSearchTimeout: init.initialGatewaySearchTimeout,
-        initialSearchMessageInterval: init.initialGatewaySearchMessageInterval,
-        searchInterval: init.gatewaySearchInterval,
-        searchTimeout: init.gatewaySearchTimeout,
-        searchMessageInterval: init.gatewaySearchMessageInterval
-      })
-    }
+    // trigger update when we discovery gateways on the network
+    this.gatewayFinder = new GatewayFinder(components, {
+      portMappingClient: this.portMappingClient
+    })
 
     this.onGatewayDiscovered = this.onGatewayDiscovered.bind(this)
   }

package/src/upnp-port-mapper.ts

@@ -6,7 +6,7 @@ import { isPrivate } from '@libp2p/utils/multiaddr/is-private'
 import { isPrivateIp } from '@libp2p/utils/private-ip'
 import { multiaddr } from '@multiformats/multiaddr'
 import { QUICV1, TCP, WebSockets, WebSocketsSecure, WebTransport } from '@multiformats/multiaddr-matcher'
-import { dynamicExternalAddress, staticExternalAddress } from './check-external-address.js'
+import { dynamicExternalAddress } from './check-external-address.js'
 import { DoubleNATError } from './errors.js'
 import type { ExternalAddress } from './check-external-address.js'
 import type { Gateway } from '@achingbrain/nat-port-mapper'
@@ -18,7 +18,6 @@ const MAX_DATE = 8_640_000_000_000_000
 
 export interface UPnPPortMapperInit {
   gateway: Gateway
-  externalAddress?: string
   externalAddressCheckInterval?: number
   externalAddressCheckTimeout?: number
 }
@@ -49,20 +48,15 @@ export class UPnPPortMapper {
     this.log = components.logger.forComponent(`libp2p:upnp-nat:gateway:${init.gateway.id}`)
     this.addressManager = components.addressManager
     this.gateway = init.gateway
-
-    if (init.externalAddress != null) {
-      this.externalAddress = staticExternalAddress(init.externalAddress)
-    } else {
-      this.externalAddress = dynamicExternalAddress({
-        gateway: this.gateway,
-        addressManager: this.addressManager,
-        logger: components.logger
-      }, {
-        interval: init.externalAddressCheckInterval,
-        timeout: init.externalAddressCheckTimeout,
-        onExternalAddressChange: this.remapPorts.bind(this)
-      })
-    }
+    this.externalAddress = dynamicExternalAddress({
+      gateway: this.gateway,
+      addressManager: this.addressManager,
+      logger: components.logger
+    }, {
+      interval: init.externalAddressCheckInterval,
+      timeout: init.externalAddressCheckTimeout,
+      onExternalAddressChange: this.remapPorts.bind(this)
+    })
     this.gateway = init.gateway
     this.mappedPorts = new Map()
     this.started = false

package/dist/src/search-gateway-finder.d.ts

@@ -1,27 +0,0 @@
-import { TypedEventEmitter } from '@libp2p/interface';
-import type { GatewayFinder, GatewayFinderEvents } from './upnp-nat.js';
-import type { UPnPNAT } from '@achingbrain/nat-port-mapper';
-import type { ComponentLogger } from '@libp2p/interface';
-export interface SearchGatewayFinderComponents {
-    logger: ComponentLogger;
-}
-export interface SearchGatewayFinderInit {
-    portMappingClient: UPnPNAT;
-    initialSearchInterval?: number;
-    initialSearchTimeout?: number;
-    initialSearchMessageInterval?: number;
-    searchInterval?: number;
-    searchTimeout?: number;
-    searchMessageInterval?: number;
-}
-export declare class SearchGatewayFinder extends TypedEventEmitter<GatewayFinderEvents> implements GatewayFinder {
-    private readonly log;
-    private readonly gateways;
-    private readonly findGateways;
-    private readonly portMappingClient;
-    private started;
-    constructor(components: SearchGatewayFinderComponents, init: SearchGatewayFinderInit);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-}
-//# sourceMappingURL=search-gateway-finder.d.ts.map

package/dist/src/search-gateway-finder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"search-gateway-finder.d.ts","sourceRoot":"","sources":["../../src/search-gateway-finder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAe,MAAM,mBAAmB,CAAA;AAGlE,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,KAAK,EAAW,OAAO,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAGhE,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,OAAO,CAAA;IAC1B,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,4BAA4B,CAAC,EAAE,MAAM,CAAA;IACrC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED,qBAAa,mBAAoB,SAAQ,iBAAiB,CAAC,mBAAmB,CAAE,YAAW,aAAa;IACtG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,OAAO,CAAS;gBAEX,UAAU,EAAE,6BAA6B,EAAE,IAAI,EAAE,uBAAuB;IAmD/E,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IASvB,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;CAI7B"}

package/dist/src/search-gateway-finder.js

@@ -1,66 +0,0 @@
-import { TypedEventEmitter, start, stop } from '@libp2p/interface';
-import { repeatingTask } from '@libp2p/utils/repeating-task';
-import { DEFAULT_GATEWAY_SEARCH_INTERVAL, DEFAULT_GATEWAY_SEARCH_MESSAGE_INTERVAL, DEFAULT_GATEWAY_SEARCH_TIMEOUT, DEFAULT_INITIAL_GATEWAY_SEARCH_INTERVAL, DEFAULT_INITIAL_GATEWAY_SEARCH_MESSAGE_INTERVAL, DEFAULT_INITIAL_GATEWAY_SEARCH_TIMEOUT } from './constants.js';
-export class SearchGatewayFinder extends TypedEventEmitter {
-    log;
-    gateways;
-    findGateways;
-    portMappingClient;
-    started;
-    constructor(components, init) {
-        super();
-        this.log = components.logger.forComponent('libp2p:upnp-nat');
-        this.portMappingClient = init.portMappingClient;
-        this.started = false;
-        this.gateways = [];
-        // every five minutes, search for network gateways for one minute
-        this.findGateways = repeatingTask(async (options) => {
-            try {
-                const searchMessageInterval = this.gateways.length > 0
-                    ? init.searchMessageInterval ?? DEFAULT_GATEWAY_SEARCH_MESSAGE_INTERVAL
-                    : init.initialSearchMessageInterval ?? DEFAULT_INITIAL_GATEWAY_SEARCH_MESSAGE_INTERVAL;
-                this.log('begin gateway search, sending M-SEARCH every %dms', searchMessageInterval);
-                for await (const gateway of this.portMappingClient.findGateways({
-                    ...options,
-                    searchInterval: searchMessageInterval
-                })) {
-                    if (this.gateways.some(g => {
-                        return g.id === gateway.id && g.family === gateway.family;
-                    })) {
-                        // already seen this gateway
-                        continue;
-                    }
-                    this.gateways.push(gateway);
-                    this.safeDispatchEvent('gateway', {
-                        detail: gateway
-                    });
-                    // we've found a gateway, wait for longer before searching again
-                    const searchInterval = init.searchTimeout ?? DEFAULT_GATEWAY_SEARCH_INTERVAL;
-                    const searchTimeout = init.searchTimeout ?? DEFAULT_GATEWAY_SEARCH_TIMEOUT;
-                    this.log('switching gateway search to every %dms, timing out after %dms', searchInterval, searchTimeout);
-                    this.findGateways.setInterval(searchInterval);
-                    this.findGateways.setTimeout(searchTimeout);
-                }
-                this.log('gateway search finished, found %d gateways', this.gateways.length);
-            }
-            catch (err) {
-                this.log.error('gateway search errored - %e', err);
-            }
-        }, init.initialSearchInterval ?? DEFAULT_INITIAL_GATEWAY_SEARCH_INTERVAL, {
-            runImmediately: true,
-            timeout: init.initialSearchTimeout ?? DEFAULT_INITIAL_GATEWAY_SEARCH_TIMEOUT
-        });
-    }
-    async start() {
-        if (this.started) {
-            return;
-        }
-        this.started = true;
-        await start(this.findGateways);
-    }
-    async stop() {
-        await stop(this.findGateways);
-        this.started = false;
-    }
-}
-//# sourceMappingURL=search-gateway-finder.js.map

package/dist/src/search-gateway-finder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"search-gateway-finder.js","sourceRoot":"","sources":["../../src/search-gateway-finder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAC5D,OAAO,EAAE,+BAA+B,EAAE,uCAAuC,EAAE,8BAA8B,EAAE,uCAAuC,EAAE,+CAA+C,EAAE,sCAAsC,EAAE,MAAM,gBAAgB,CAAA;AAoB3Q,MAAM,OAAO,mBAAoB,SAAQ,iBAAsC;IAC5D,GAAG,CAAQ;IACX,QAAQ,CAAW;IACnB,YAAY,CAAe;IAC3B,iBAAiB,CAAS;IACnC,OAAO,CAAS;IAExB,YAAa,UAAyC,EAAE,IAA6B;QACnF,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;QAC5D,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAElB,iEAAiE;QACjE,IAAI,CAAC,YAAY,GAAG,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAClD,IAAI,CAAC;gBACH,MAAM,qBAAqB,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;oBACpD,CAAC,CAAC,IAAI,CAAC,qBAAqB,IAAI,uCAAuC;oBACvE,CAAC,CAAC,IAAI,CAAC,4BAA4B,IAAI,+CAA+C,CAAA;gBAExF,IAAI,CAAC,GAAG,CAAC,mDAAmD,EAAE,qBAAqB,CAAC,CAAA;gBAEpF,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;oBAC9D,GAAG,OAAO;oBACV,cAAc,EAAE,qBAAqB;iBACtC,CAAC,EAAE,CAAC;oBACH,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;wBACzB,OAAO,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,CAAA;oBAC3D,CAAC,CAAC,EAAE,CAAC;wBACH,4BAA4B;wBAC5B,SAAQ;oBACV,CAAC;oBAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;oBAC3B,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE;wBAChC,MAAM,EAAE,OAAO;qBAChB,CAAC,CAAA;oBAEF,gEAAgE;oBAChE,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,IAAI,+BAA+B,CAAA;oBAC5E,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,IAAI,8BAA8B,CAAA;oBAC1E,IAAI,CAAC,GAAG,CAAC,+DAA+D,EAAE,cAAc,EAAE,aAAa,CAAC,CAAA;oBACxG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;oBAC7C,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;gBAC7C,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,4CAA4C,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YAC9E,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;YACpD,CAAC;QACH,CAAC,EAAE,IAAI,CAAC,qBAAqB,IAAI,uCAAuC,EAAE;YACxE,cAAc,EAAE,IAAI;YACpB,OAAO,EAAE,IAAI,CAAC,oBAAoB,IAAI,sCAAsC;SAC7E,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAChC,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;CACF"}

package/dist/src/static-gateway-finder.d.ts

@@ -1,23 +0,0 @@
-import { TypedEventEmitter } from '@libp2p/interface';
-import type { GatewayFinder, GatewayFinderEvents } from './upnp-nat.js';
-import type { UPnPNAT } from '@achingbrain/nat-port-mapper';
-import type { ComponentLogger } from '@libp2p/interface';
-export interface StaticGatewayFinderComponents {
-    logger: ComponentLogger;
-}
-export interface StaticGatewayFinderInit {
-    portMappingClient: UPnPNAT;
-    gateways: string[];
-}
-export declare class StaticGatewayFinder extends TypedEventEmitter<GatewayFinderEvents> implements GatewayFinder {
-    private readonly log;
-    private readonly gatewayUrls;
-    private readonly gateways;
-    private readonly portMappingClient;
-    private started;
-    constructor(components: StaticGatewayFinderComponents, init: StaticGatewayFinderInit);
-    start(): Promise<void>;
-    afterStart(): Promise<void>;
-    stop(): Promise<void>;
-}
-//# sourceMappingURL=static-gateway-finder.d.ts.map

package/dist/src/static-gateway-finder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"static-gateway-finder.d.ts","sourceRoot":"","sources":["../../src/static-gateway-finder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,KAAK,EAAW,OAAO,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAEhE,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,OAAO,CAAA;IAC1B,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,qBAAa,mBAAoB,SAAQ,iBAAiB,CAAC,mBAAmB,CAAE,YAAW,aAAa;IACtG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAO;IACnC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,OAAO,CAAS;gBAEX,UAAU,EAAE,6BAA6B,EAAE,IAAI,EAAE,uBAAuB;IAU/E,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAIvB,UAAU,IAAK,OAAO,CAAC,IAAI,CAAC;IAqB5B,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;CAG7B"}

package/dist/src/static-gateway-finder.js

@@ -1,42 +0,0 @@
-import { TypedEventEmitter } from '@libp2p/interface';
-export class StaticGatewayFinder extends TypedEventEmitter {
-    log;
-    gatewayUrls;
-    gateways;
-    portMappingClient;
-    started;
-    constructor(components, init) {
-        super();
-        this.log = components.logger.forComponent('libp2p:upnp-nat:static-gateway-finder');
-        this.portMappingClient = init.portMappingClient;
-        this.started = false;
-        this.gateways = [];
-        this.gatewayUrls = init.gateways.map(url => new URL(url));
-    }
-    async start() {
-        this.started = true;
-    }
-    async afterStart() {
-        for (const url of this.gatewayUrls) {
-            try {
-                this.log('fetching gateway descriptor from %s', url);
-                const gateway = await this.portMappingClient.getGateway(url);
-                if (!this.started) {
-                    return;
-                }
-                this.log('found static gateway at %s', url);
-                this.gateways.push(gateway);
-                this.safeDispatchEvent('gateway', {
-                    detail: gateway
-                });
-            }
-            catch (err) {
-                this.log.error('could not contact static gateway at %s - %e', url, err);
-            }
-        }
-    }
-    async stop() {
-        this.started = false;
-    }
-}
-//# sourceMappingURL=static-gateway-finder.js.map

package/dist/src/static-gateway-finder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"static-gateway-finder.js","sourceRoot":"","sources":["../../src/static-gateway-finder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAcrD,MAAM,OAAO,mBAAoB,SAAQ,iBAAsC;IAC5D,GAAG,CAAQ;IACX,WAAW,CAAO;IAClB,QAAQ,CAAW;IACnB,iBAAiB,CAAS;IACnC,OAAO,CAAS;IAExB,YAAa,UAAyC,EAAE,IAA6B;QACnF,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,uCAAuC,CAAC,CAAA;QAClF,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnC,IAAI,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAA;gBACpD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;gBAE5D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;oBAClB,OAAM;gBACR,CAAC;gBAED,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAA;gBAC3C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;gBAC3B,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE;oBAChC,MAAM,EAAE,OAAO;iBAChB,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6CAA6C,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;YACzE,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;CACF"}

package/src/search-gateway-finder.ts

@@ -1,94 +0,0 @@
-import { TypedEventEmitter, start, stop } from '@libp2p/interface'
-import { repeatingTask } from '@libp2p/utils/repeating-task'
-import { DEFAULT_GATEWAY_SEARCH_INTERVAL, DEFAULT_GATEWAY_SEARCH_MESSAGE_INTERVAL, DEFAULT_GATEWAY_SEARCH_TIMEOUT, DEFAULT_INITIAL_GATEWAY_SEARCH_INTERVAL, DEFAULT_INITIAL_GATEWAY_SEARCH_MESSAGE_INTERVAL, DEFAULT_INITIAL_GATEWAY_SEARCH_TIMEOUT } from './constants.js'
-import type { GatewayFinder, GatewayFinderEvents } from './upnp-nat.js'
-import type { Gateway, UPnPNAT } from '@achingbrain/nat-port-mapper'
-import type { ComponentLogger, Logger } from '@libp2p/interface'
-import type { RepeatingTask } from '@libp2p/utils/repeating-task'
-
-export interface SearchGatewayFinderComponents {
-  logger: ComponentLogger
-}
-
-export interface SearchGatewayFinderInit {
-  portMappingClient: UPnPNAT
-  initialSearchInterval?: number
-  initialSearchTimeout?: number
-  initialSearchMessageInterval?: number
-  searchInterval?: number
-  searchTimeout?: number
-  searchMessageInterval?: number
-}
-
-export class SearchGatewayFinder extends TypedEventEmitter<GatewayFinderEvents> implements GatewayFinder {
-  private readonly log: Logger
-  private readonly gateways: Gateway[]
-  private readonly findGateways: RepeatingTask
-  private readonly portMappingClient: UPnPNAT
-  private started: boolean
-
-  constructor (components: SearchGatewayFinderComponents, init: SearchGatewayFinderInit) {
-    super()
-
-    this.log = components.logger.forComponent('libp2p:upnp-nat')
-    this.portMappingClient = init.portMappingClient
-    this.started = false
-    this.gateways = []
-
-    // every five minutes, search for network gateways for one minute
-    this.findGateways = repeatingTask(async (options) => {
-      try {
-        const searchMessageInterval = this.gateways.length > 0
-          ? init.searchMessageInterval ?? DEFAULT_GATEWAY_SEARCH_MESSAGE_INTERVAL
-          : init.initialSearchMessageInterval ?? DEFAULT_INITIAL_GATEWAY_SEARCH_MESSAGE_INTERVAL
-
-        this.log('begin gateway search, sending M-SEARCH every %dms', searchMessageInterval)
-
-        for await (const gateway of this.portMappingClient.findGateways({
-          ...options,
-          searchInterval: searchMessageInterval
-        })) {
-          if (this.gateways.some(g => {
-            return g.id === gateway.id && g.family === gateway.family
-          })) {
-            // already seen this gateway
-            continue
-          }
-
-          this.gateways.push(gateway)
-          this.safeDispatchEvent('gateway', {
-            detail: gateway
-          })
-
-          // we've found a gateway, wait for longer before searching again
-          const searchInterval = init.searchTimeout ?? DEFAULT_GATEWAY_SEARCH_INTERVAL
-          const searchTimeout = init.searchTimeout ?? DEFAULT_GATEWAY_SEARCH_TIMEOUT
-          this.log('switching gateway search to every %dms, timing out after %dms', searchInterval, searchTimeout)
-          this.findGateways.setInterval(searchInterval)
-          this.findGateways.setTimeout(searchTimeout)
-        }
-
-        this.log('gateway search finished, found %d gateways', this.gateways.length)
-      } catch (err) {
-        this.log.error('gateway search errored - %e', err)
-      }
-    }, init.initialSearchInterval ?? DEFAULT_INITIAL_GATEWAY_SEARCH_INTERVAL, {
-      runImmediately: true,
-      timeout: init.initialSearchTimeout ?? DEFAULT_INITIAL_GATEWAY_SEARCH_TIMEOUT
-    })
-  }
-
-  async start (): Promise<void> {
-    if (this.started) {
-      return
-    }
-
-    this.started = true
-    await start(this.findGateways)
-  }
-
-  async stop (): Promise<void> {
-    await stop(this.findGateways)
-    this.started = false
-  }
-}

package/src/static-gateway-finder.ts

@@ -1,60 +0,0 @@
-import { TypedEventEmitter } from '@libp2p/interface'
-import type { GatewayFinder, GatewayFinderEvents } from './upnp-nat.js'
-import type { Gateway, UPnPNAT } from '@achingbrain/nat-port-mapper'
-import type { ComponentLogger, Logger } from '@libp2p/interface'
-
-export interface StaticGatewayFinderComponents {
-  logger: ComponentLogger
-}
-
-export interface StaticGatewayFinderInit {
-  portMappingClient: UPnPNAT
-  gateways: string[]
-}
-
-export class StaticGatewayFinder extends TypedEventEmitter<GatewayFinderEvents> implements GatewayFinder {
-  private readonly log: Logger
-  private readonly gatewayUrls: URL[]
-  private readonly gateways: Gateway[]
-  private readonly portMappingClient: UPnPNAT
-  private started: boolean
-
-  constructor (components: StaticGatewayFinderComponents, init: StaticGatewayFinderInit) {
-    super()
-
-    this.log = components.logger.forComponent('libp2p:upnp-nat:static-gateway-finder')
-    this.portMappingClient = init.portMappingClient
-    this.started = false
-    this.gateways = []
-    this.gatewayUrls = init.gateways.map(url => new URL(url))
-  }
-
-  async start (): Promise<void> {
-    this.started = true
-  }
-
-  async afterStart (): Promise<void> {
-    for (const url of this.gatewayUrls) {
-      try {
-        this.log('fetching gateway descriptor from %s', url)
-        const gateway = await this.portMappingClient.getGateway(url)
-
-        if (!this.started) {
-          return
-        }
-
-        this.log('found static gateway at %s', url)
-        this.gateways.push(gateway)
-        this.safeDispatchEvent('gateway', {
-          detail: gateway
-        })
-      } catch (err) {
-        this.log.error('could not contact static gateway at %s - %e', url, err)
-      }
-    }
-  }
-
-  async stop (): Promise<void> {
-    this.started = false
-  }
-}