@libp2p/upnp-nat 2.0.10 → 2.0.11

package/dist/src/check-external-address.d.ts

@@ -0,0 +1,19 @@
+import type { NatAPI } from '@achingbrain/nat-port-mapper';
+import type { AbortOptions, ComponentLogger } from '@libp2p/interface';
+import type { AddressManager } from '@libp2p/interface-internal';
+export interface ExternalAddressCheckerComponents {
+    client: NatAPI;
+    addressManager: AddressManager;
+    logger: ComponentLogger;
+}
+export interface ExternalAddressCheckerInit {
+    interval?: number;
+    timeout?: number;
+    autoConfirmAddress?: boolean;
+}
+export interface ExternalAddress {
+    getPublicIp(options?: AbortOptions): Promise<string> | string;
+}
+export declare function dynamicExternalAddress(components: ExternalAddressCheckerComponents, init?: ExternalAddressCheckerInit): ExternalAddress;
+export declare function staticExternalAddress(address: string): ExternalAddress;
+//# sourceMappingURL=check-external-address.d.ts.map

package/dist/src/check-external-address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-external-address.d.ts","sourceRoot":"","sources":["../../src/check-external-address.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAqB,MAAM,mBAAmB,CAAA;AACzF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAIhE,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;CAC/D;AAyGD,wBAAgB,sBAAsB,CAAE,UAAU,EAAE,gCAAgC,EAAE,IAAI,GAAE,0BAA+B,GAAG,eAAe,CAE5I;AAED,wBAAgB,qBAAqB,CAAE,OAAO,EAAE,MAAM,GAAG,eAAe,CAIvE"}

package/dist/src/check-external-address.js

@@ -0,0 +1,98 @@
+import { NotStartedError, start, stop } from '@libp2p/interface';
+import { repeatingTask } from '@libp2p/utils/repeating-task';
+import { multiaddr } from '@multiformats/multiaddr';
+import pDefer from 'p-defer';
+import { raceSignal } from 'race-signal';
+/**
+ * Monitors the external network address and notifies when/if it changes
+ */
+class ExternalAddressChecker {
+    log;
+    client;
+    addressManager;
+    started;
+    lastPublicIp;
+    lastPublicIpPromise;
+    check;
+    autoConfirmAddress;
+    constructor(components, init = {}) {
+        this.log = components.logger.forComponent('libp2p:upnp-nat:external-address-check');
+        this.client = components.client;
+        this.addressManager = components.addressManager;
+        this.autoConfirmAddress = init.autoConfirmAddress ?? false;
+        this.started = false;
+        this.checkExternalAddress = this.checkExternalAddress.bind(this);
+        this.lastPublicIpPromise = pDefer();
+        this.check = repeatingTask(this.checkExternalAddress, init.interval ?? 30000, {
+            timeout: init.timeout ?? 10000,
+            runImmediately: true
+        });
+    }
+    async start() {
+        if (this.started) {
+            return;
+        }
+        await start(this.check);
+        this.check.start();
+        this.started = true;
+    }
+    async stop() {
+        await stop(this.check);
+        this.started = false;
+    }
+    /**
+     * Return the last public IP address we found, or wait for it to be found
+     */
+    async getPublicIp(options) {
+        if (!this.started) {
+            throw new NotStartedError('Not started yet');
+        }
+        return this.lastPublicIp ?? raceSignal(this.lastPublicIpPromise.promise, options?.signal, {
+            errorMessage: 'Requesting the public IP from the network gateway timed out - UPnP may not be enabled'
+        });
+    }
+    async checkExternalAddress(options) {
+        try {
+            const externalAddress = await this.client.externalIp(options);
+            // check if our public address has changed
+            if (this.lastPublicIp != null && externalAddress !== this.lastPublicIp) {
+                this.log('external address changed from %s to %s', this.lastPublicIp, externalAddress);
+                for (const ma of this.addressManager.getAddresses()) {
+                    const addrString = ma.toString();
+                    if (!addrString.includes(this.lastPublicIp)) {
+                        continue;
+                    }
+                    // create a new version of the multiaddr with the new public IP
+                    const newAddress = multiaddr(addrString.replace(this.lastPublicIp, externalAddress));
+                    // remove the old address and add the new one
+                    this.addressManager.removeObservedAddr(ma);
+                    this.addressManager.confirmObservedAddr(newAddress);
+                    if (this.autoConfirmAddress) {
+                        this.addressManager.confirmObservedAddr(newAddress);
+                    }
+                    else {
+                        this.addressManager.addObservedAddr(newAddress);
+                    }
+                }
+            }
+            this.lastPublicIp = externalAddress;
+            this.lastPublicIpPromise.resolve(externalAddress);
+        }
+        catch (err) {
+            if (this.lastPublicIp != null) {
+                // ignore the error if we've previously run successfully
+                return;
+            }
+            this.lastPublicIpPromise.reject(err);
+        }
+    }
+}
+export function dynamicExternalAddress(components, init = {}) {
+    return new ExternalAddressChecker(components, init);
+}
+export function staticExternalAddress(address) {
+    return {
+        getPublicIp: () => address
+    };
+}
+//# sourceMappingURL=check-external-address.js.map

package/dist/src/check-external-address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-external-address.js","sourceRoot":"","sources":["../../src/check-external-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAuBxC;;GAEG;AACH,MAAM,sBAAsB;IACT,GAAG,CAAQ;IACX,MAAM,CAAQ;IACd,cAAc,CAAgB;IACvC,OAAO,CAAS;IAChB,YAAY,CAAS;IACZ,mBAAmB,CAAyB;IAC5C,KAAK,CAAe;IACpB,kBAAkB,CAAS;IAE5C,YAAa,UAA4C,EAAE,OAAmC,EAAE;QAC9F,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,wCAAwC,CAAC,CAAA;QACnF,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAA;QAC1D,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QAEpB,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEhE,IAAI,CAAC,mBAAmB,GAAG,MAAM,EAAE,CAAA;QAEnC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,QAAQ,IAAI,KAAK,EAAE;YAC5E,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,KAAK;YAC9B,cAAc,EAAE,IAAI;SACrB,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAM;QACR,CAAC;QAED,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAEvB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;QAClB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAEtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAE,OAAsB;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,eAAe,CAAC,iBAAiB,CAAC,CAAA;QAC9C,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,IAAI,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE;YACxF,YAAY,EAAE,uFAAuF;SACtG,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAE,OAAsB;QACxD,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;YAE7D,0CAA0C;YAC1C,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,IAAI,eAAe,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC;gBACvE,IAAI,CAAC,GAAG,CAAC,wCAAwC,EAAE,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;gBAEtF,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,CAAC;oBACpD,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAA;oBAEhC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;wBAC5C,SAAQ;oBACV,CAAC;oBAED,+DAA+D;oBAC/D,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAA;oBAEpF,6CAA6C;oBAC7C,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;oBAC1C,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;oBAEnD,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;wBAC5B,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAA;oBACrD,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,CAAC,CAAA;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAI,CAAC,YAAY,GAAG,eAAe,CAAA;YACnC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QACnD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;gBAC9B,wDAAwD;gBACxD,OAAM;YACR,CAAC;YAED,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;CACF;AAED,MAAM,UAAU,sBAAsB,CAAE,UAA4C,EAAE,OAAmC,EAAE;IACzH,OAAO,IAAI,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAE,OAAe;IACpD,OAAO;QACL,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO;KAC3B,CAAA;AACH,CAAC"}

package/dist/src/errors.d.ts

@@ -1,4 +1,8 @@
 export declare class DoubleNATError extends Error {
     constructor(message?: string);
 }
+export declare class InvalidIPAddressError extends Error {
+    static name: string;
+    name: string;
+}
 //# sourceMappingURL=errors.d.ts.map

package/dist/src/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAe,SAAQ,KAAK;gBAC1B,OAAO,SAAwB;CAI7C"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAe,SAAQ,KAAK;gBAC1B,OAAO,SAAwB;CAI7C;AAED,qBAAa,qBAAsB,SAAQ,KAAK;IAC9C,MAAM,CAAC,IAAI,SAA0B;IACrC,IAAI,SAA0B;CAC/B"}

package/dist/src/errors.js

@@ -4,4 +4,8 @@ export class DoubleNATError extends Error {
         this.name = 'DoubleNATError';
     }
 }
+export class InvalidIPAddressError extends Error {
+    static name = 'InvalidIPAddressError';
+    name = 'InvalidIPAddressError';
+}
 //# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvC,YAAa,OAAO,GAAG,qBAAqB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAA;IAC9B,CAAC;CACF"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvC,YAAa,OAAO,GAAG,qBAAqB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAA;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,MAAM,CAAC,IAAI,GAAG,uBAAuB,CAAA;IACrC,IAAI,GAAG,uBAAuB,CAAA"}

package/dist/src/index.d.ts

@@ -35,8 +35,8 @@
  * ```
  */
 import { type NatAPI, type MapPortOptions } from './upnp-nat.js';
-import type { ComponentLogger, NodeInfo, PeerId } from '@libp2p/interface';
-import type { AddressManager, TransportManager } from '@libp2p/interface-internal';
+import type { ComponentLogger, Libp2pEvents, NodeInfo, PeerId, TypedEventTarget } from '@libp2p/interface';
+import type { AddressManager } from '@libp2p/interface-internal';
 export type { NatAPI, MapPortOptions };
 export interface PMPOptions {
     /**
@@ -46,9 +46,24 @@ export interface PMPOptions {
 }
 export interface UPnPNATInit {
     /**
-     * Pass a value to use instead of auto-detection
+     * Pass a string to hard code the external address, otherwise it will be
+     * auto-detected
      */
     externalAddress?: string;
+    /**
+     * Check if the external address has changed this often in ms. Ignored if an
+     * external address is specified.
+     *
+     * @default 30000
+     */
+    externalAddressCheckInterval?: number;
+    /**
+     * Do not take longer than this to check if the external address has changed
+     * in ms.  Ignored if an external address is specified.
+     *
+     * @default 10000
+     */
+    externalAddressCheckTimeout?: number;
     /**
      * Pass a value to use instead of auto-detection
      */
@@ -69,13 +84,45 @@ export interface UPnPNATInit {
      * Pass a value to use instead of auto-detection
      */
     gateway?: string;
+    /**
+     * How long in ms to wait before giving up trying to auto-detect a
+     * `urn:schemas-upnp-org:device:InternetGatewayDevice:1` device on the local
+     * network
+     *
+     * @default 10000
+     */
+    gatewayDetectionTimeout?: number;
+    /**
+     * Ports are mapped when the `self:peer:update` event fires, which happens
+     * when the node's addresses change. To avoid starting to map ports while
+     * multiple addresses are being added, the mapping function is debounced by
+     * this number of ms
+     *
+     * @default 5000
+     */
+    delay?: number;
+    /**
+     * A preconfigured instance of a NatAPI client can be passed as an option,
+     * otherwise one will be created
+     */
+    client?: NatAPI;
+    /**
+     * Any mapped addresses are added to the observed address list. These
+     * addresses require additional verification by the `@libp2p/autonat` protocol
+     * or similar before they are trusted.
+     *
+     * To skip this verification and trust them immediately pass `true` here
+     *
+     * @default false
+     */
+    autoConfirmAddress?: boolean;
 }
 export interface UPnPNATComponents {
     peerId: PeerId;
     nodeInfo: NodeInfo;
     logger: ComponentLogger;
-    transportManager: TransportManager;
     addressManager: AddressManager;
+    events: TypedEventTarget<Libp2pEvents>;
 }
 export interface UPnPNAT {
     client: NatAPI;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,EAA2B,KAAK,MAAM,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAA;AACzF,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAElF,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;AAEtC,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;IAClB,MAAM,EAAE,eAAe,CAAA;IACvB,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc,EAAE,cAAc,CAAA;CAC/B;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,OAAO,CAAE,IAAI,GAAE,WAAgB,GAAG,CAAC,UAAU,EAAE,iBAAiB,KAAK,OAAO,CAI3F"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,EAA2B,KAAK,MAAM,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAA;AACzF,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAC1G,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAEhE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;AAEtC,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;;;OAKG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAA;IAErC;;;;;OAKG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAA;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAEhC;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;IAClB,MAAM,EAAE,eAAe,CAAA;IACvB,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAA;CACvC;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,wBAAgB,OAAO,CAAE,IAAI,GAAE,WAAgB,GAAG,CAAC,UAAU,EAAE,iBAAiB,KAAK,OAAO,CAI3F"}

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,EAAE,OAAO,IAAI,YAAY,EAAoC,MAAM,eAAe,CAAA;AAyDzF,MAAM,UAAU,OAAO,CAAE,OAAoB,EAAE;IAC7C,OAAO,CAAC,UAA6B,EAAE,EAAE;QACvC,OAAO,IAAI,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC,CAAA;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AAEH,OAAO,EAAE,OAAO,IAAI,YAAY,EAAoC,MAAM,eAAe,CAAA;AA8GzF,MAAM,UAAU,OAAO,CAAE,OAAoB,EAAE;IAC7C,OAAO,CAAC,UAA6B,EAAE,EAAE;QACvC,OAAO,IAAI,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC,CAAA;AACH,CAAC"}

package/dist/src/upnp-nat.d.ts

@@ -1,12 +1,13 @@
-import { type NatAPI, type MapPortOptions } from '@achingbrain/nat-port-mapper';
-import { serviceCapabilities } from '@libp2p/interface';
+import { serviceCapabilities, serviceDependencies } from '@libp2p/interface';
 import type { UPnPNATComponents, UPnPNATInit, UPnPNAT as UPnPNATInterface } from './index.js';
+import type { NatAPI, MapPortOptions } from '@achingbrain/nat-port-mapper';
 import type { Startable } from '@libp2p/interface';
 export type { NatAPI, MapPortOptions };
 export declare class UPnPNAT implements Startable, UPnPNATInterface {
     client: NatAPI;
-    private readonly components;
-    private readonly externalAddress?;
+    private readonly addressManager;
+    private readonly events;
+    private readonly externalAddress;
     private readonly localAddress?;
     private readonly description;
     private readonly ttl;
@@ -14,21 +15,26 @@ export declare class UPnPNAT implements Startable, UPnPNATInterface {
     private readonly gateway?;
     private started;
     private readonly log;
+    private readonly gatewayDetectionTimeout;
+    private readonly mappedPorts;
+    private readonly onSelfPeerUpdate;
+    private readonly autoConfirmAddress;
     constructor(components: UPnPNATComponents, init: UPnPNATInit);
     readonly [Symbol.toStringTag] = "@libp2p/upnp-nat";
     readonly [serviceCapabilities]: string[];
+    get [serviceDependencies](): string[];
     isStarted(): boolean;
-    start(): void;
+    start(): Promise<void>;
     /**
-     * Attempt to use uPnP to configure port mapping using the current gateway.
-     *
-     * Run after start to ensure the transport manager has all addresses configured.
+     * Stops the NAT manager
      */
-    afterStart(): void;
+    stop(): Promise<void>;
+    _onSelfPeerUpdate(): void;
+    private getUnmappedAddresses;
     mapIpAddresses(): Promise<void>;
     /**
-     * Stops the NAT manager
+     * Some ISPs have double-NATs, there's not much we can do with them
      */
-    stop(): Promise<void>;
+    private assertNotBehindDoubleNAT;
 }
 //# sourceMappingURL=upnp-nat.d.ts.map

package/dist/src/upnp-nat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upnp-nat.d.ts","sourceRoot":"","sources":["../../src/upnp-nat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,MAAM,EAAE,KAAK,cAAc,EAAE,MAAM,8BAA8B,CAAA;AACxF,OAAO,EAA0B,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAM/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC7F,OAAO,KAAK,EAAU,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAI1D,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;AAMtC,qBAAa,OAAQ,YAAW,SAAS,EAAE,gBAAgB;IAClD,MAAM,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAmB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAQ;IACjC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;gBAEf,UAAU,EAAE,iBAAiB,EAAE,IAAI,EAAE,WAAW;IAwB7D,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,sBAAqB;IAElD,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAEvC;IAED,SAAS,IAAK,OAAO;IAIrB,KAAK,IAAK,IAAI;IAId;;;;OAIG;IACH,UAAU,IAAK,IAAI;IAcb,cAAc,IAAK,OAAO,CAAC,IAAI,CAAC;IAsDtC;;OAEG;IACG,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;CAW7B"}
+{"version":3,"file":"upnp-nat.d.ts","sourceRoot":"","sources":["../../src/upnp-nat.ts"],"names":[],"mappings":"AAEA,OAAO,EAA0B,mBAAmB,EAAE,mBAAmB,EAAe,MAAM,mBAAmB,CAAA;AAWjH,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC7F,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAC1E,OAAO,KAAK,EAAwB,SAAS,EAAoB,MAAM,mBAAmB,CAAA;AAO1F,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;AAEtC,qBAAa,OAAQ,YAAW,SAAS,EAAE,gBAAgB;IAClD,MAAM,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgC;IACvD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAQ;IACjC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAQ;IAChD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmB;IACpD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAS;gBAE/B,UAAU,EAAE,iBAAiB,EAAE,IAAI,EAAE,WAAW;IA0C7D,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,sBAAqB;IAElD,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAEvC;IAED,IAAI,CAAC,mBAAmB,CAAC,IAAK,MAAM,EAAE,CAQrC;IAED,SAAS,IAAK,OAAO;IAIf,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAU7B;;OAEG;IACG,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;IAY5B,iBAAiB,IAAK,IAAI;IAO1B,OAAO,CAAC,oBAAoB;IAyCtB,cAAc,IAAK,OAAO,CAAC,IAAI,CAAC;IAyEtC;;OAEG;IACH,OAAO,CAAC,wBAAwB;CAWjC"}

package/dist/src/upnp-nat.js

@@ -1,17 +1,20 @@
 import { upnpNat } from '@achingbrain/nat-port-mapper';
-import { InvalidParametersError, serviceCapabilities } from '@libp2p/interface';
+import { isIPv4, isIPv6 } from '@chainsafe/is-ip';
+import { InvalidParametersError, serviceCapabilities, serviceDependencies, start, stop } from '@libp2p/interface';
+import { debounce } from '@libp2p/utils/debounce';
 import { isLoopback } from '@libp2p/utils/multiaddr/is-loopback';
+import { isPrivate } from '@libp2p/utils/multiaddr/is-private';
 import { isPrivateIp } from '@libp2p/utils/private-ip';
-import { fromNodeAddress } from '@multiformats/multiaddr';
-import { isBrowser } from 'wherearewe';
-import { DoubleNATError } from './errors.js';
+import { multiaddr } from '@multiformats/multiaddr';
+import { QUICV1, TCP, WebSockets, WebSocketsSecure, WebTransport } from '@multiformats/multiaddr-matcher';
+import { raceSignal } from 'race-signal';
+import { dynamicExternalAddress, staticExternalAddress } from './check-external-address.js';
+import { DoubleNATError, InvalidIPAddressError } from './errors.js';
 const DEFAULT_TTL = 7200;
-function highPort(min = 1024, max = 65535) {
-    return Math.floor(Math.random() * (max - min + 1) + min);
-}
 export class UPnPNAT {
     client;
-    components;
+    addressManager;
+    events;
     externalAddress;
     localAddress;
     description;
@@ -20,106 +23,188 @@ export class UPnPNAT {
     gateway;
     started;
     log;
+    gatewayDetectionTimeout;
+    mappedPorts;
+    onSelfPeerUpdate;
+    autoConfirmAddress;
     constructor(components, init) {
-        this.components = components;
         this.log = components.logger.forComponent('libp2p:upnp-nat');
+        this.addressManager = components.addressManager;
+        this.events = components.events;
         this.started = false;
-        this.externalAddress = init.externalAddress;
         this.localAddress = init.localAddress;
-        this.description = init.description ?? `${components.nodeInfo.name}@${components.nodeInfo.version} ${this.components.peerId.toString()}`;
+        this.description = init.description ?? `${components.nodeInfo.name}@${components.nodeInfo.version} ${components.peerId.toString()}`;
         this.ttl = init.ttl ?? DEFAULT_TTL;
         this.keepAlive = init.keepAlive ?? true;
         this.gateway = init.gateway;
+        this.gatewayDetectionTimeout = init.gatewayDetectionTimeout ?? 10000;
+        this.autoConfirmAddress = init.autoConfirmAddress ?? false;
+        this.mappedPorts = new Map();
         if (this.ttl < DEFAULT_TTL) {
             throw new InvalidParametersError(`NatManager ttl should be at least ${DEFAULT_TTL} seconds`);
         }
-        this.client = upnpNat({
+        this.client = init.client ?? upnpNat({
             description: this.description,
             ttl: this.ttl,
             keepAlive: this.keepAlive,
             gateway: this.gateway
         });
+        this.onSelfPeerUpdate = debounce(this._onSelfPeerUpdate.bind(this), init.delay ?? 5000);
+        if (typeof init.externalAddress === 'string') {
+            this.externalAddress = staticExternalAddress(init.externalAddress);
+        }
+        else {
+            this.externalAddress = dynamicExternalAddress({
+                client: this.client,
+                addressManager: this.addressManager,
+                logger: components.logger
+            }, {
+                autoConfirmAddress: init.autoConfirmAddress,
+                interval: init.externalAddressCheckInterval,
+                timeout: init.externalAddressCheckTimeout
+            });
+        }
     }
     [Symbol.toStringTag] = '@libp2p/upnp-nat';
     [serviceCapabilities] = [
         '@libp2p/nat-traversal'
     ];
+    get [serviceDependencies]() {
+        if (!this.autoConfirmAddress) {
+            return [
+                '@libp2p/autonat'
+            ];
+        }
+        return [];
+    }
     isStarted() {
         return this.started;
     }
-    start() {
-        // #TODO: is there a way to remove this? Seems like a hack
+    async start() {
+        if (this.started) {
+            return;
+        }
+        this.started = true;
+        this.events.addEventListener('self:peer:update', this.onSelfPeerUpdate);
+        await start(this.externalAddress, this.onSelfPeerUpdate);
     }
     /**
-     * Attempt to use uPnP to configure port mapping using the current gateway.
-     *
-     * Run after start to ensure the transport manager has all addresses configured.
+     * Stops the NAT manager
      */
-    afterStart() {
-        if (isBrowser || this.started) {
-            return;
+    async stop() {
+        try {
+            await this.client?.close();
         }
-        this.started = true;
-        // done async to not slow down startup
-        void this.mapIpAddresses().catch((err) => {
-            // hole punching errors are non-fatal
+        catch (err) {
             this.log.error(err);
+        }
+        this.events.removeEventListener('self:peer:update', this.onSelfPeerUpdate);
+        await stop(this.externalAddress, this.onSelfPeerUpdate);
+        this.started = false;
+    }
+    _onSelfPeerUpdate() {
+        this.mapIpAddresses()
+            .catch(err => {
+            this.log.error('error mapping IP addresses - %e', err);
         });
     }
-    async mapIpAddresses() {
-        const addrs = this.components.transportManager.getAddrs();
-        for (const addr of addrs) {
-            // try to open uPnP ports for each thin waist address
-            const { family, host, port, transport } = addr.toOptions();
-            if (!addr.isThinWaistAddress() || transport !== 'tcp') {
-                // only bare tcp addresses
-                // eslint-disable-next-line no-continue
+    getUnmappedAddresses(multiaddrs, ipType) {
+        const output = [];
+        for (const ma of multiaddrs) {
+            // ignore public addresses
+            if (!isPrivate(ma)) {
                 continue;
             }
-            if (isLoopback(addr)) {
-                // eslint-disable-next-line no-continue
+            // ignore loopback
+            if (isLoopback(ma)) {
                 continue;
             }
-            if (family !== 4) {
-                // ignore ipv6
-                // eslint-disable-next-line no-continue
+            // only IP based addresses
+            if (!(TCP.exactMatch(ma) ||
+                WebSockets.exactMatch(ma) ||
+                WebSocketsSecure.exactMatch(ma) ||
+                QUICV1.exactMatch(ma) ||
+                WebTransport.exactMatch(ma))) {
                 continue;
             }
-            const publicIp = this.externalAddress ?? await this.client.externalIp();
-            const isPrivate = isPrivateIp(publicIp);
-            if (isPrivate === true) {
-                throw new DoubleNATError(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`);
+            const { port, family } = ma.toOptions();
+            if (family !== ipType) {
+                continue;
             }
-            if (isPrivate == null) {
-                throw new InvalidParametersError(`${publicIp} is not an IP address`);
+            if (this.mappedPorts.has(port)) {
+                continue;
             }
-            const publicPort = highPort();
-            this.log(`opening uPnP connection from ${publicIp}:${publicPort} to ${host}:${port}`);
-            await this.client.map({
-                publicPort,
-                localPort: port,
-                localAddress: this.localAddress,
-                protocol: transport.toUpperCase() === 'TCP' ? 'TCP' : 'UDP'
+            output.push(ma);
+        }
+        return output;
+    }
+    async mapIpAddresses() {
+        if (this.externalAddress == null) {
+            this.log('discovering public address');
+        }
+        const publicIp = await this.externalAddress.getPublicIp({
+            signal: AbortSignal.timeout(this.gatewayDetectionTimeout)
+        });
+        this.externalAddress ?? await raceSignal(this.client.externalIp(), AbortSignal.timeout(this.gatewayDetectionTimeout), {
+            errorMessage: `Did not discover a "urn:schemas-upnp-org:device:InternetGatewayDevice:1" device on the local network after ${this.gatewayDetectionTimeout}ms - UPnP may not be configured on your router correctly`
+        });
+        let ipType = 4;
+        if (isIPv4(publicIp)) {
+            ipType = 4;
+        }
+        else if (isIPv6(publicIp)) {
+            ipType = 6;
+        }
+        else {
+            throw new InvalidIPAddressError(`Public address ${publicIp} was not an IPv4 address`);
+        }
+        // filter addresses to get private, non-relay, IP based addresses that we
+        // haven't mapped yet
+        const addresses = this.getUnmappedAddresses(this.addressManager.getAddresses(), ipType);
+        if (addresses.length === 0) {
+            this.log('no private, non-relay, unmapped, IP based addresses found');
+            return;
+        }
+        this.log('%s public IP %s', this.externalAddress != null ? 'using configured' : 'discovered', publicIp);
+        this.assertNotBehindDoubleNAT(publicIp);
+        for (const addr of addresses) {
+            // try to open uPnP ports for each thin waist address
+            const { family, host, port, transport } = addr.toOptions();
+            if (family === 6) {
+                // only support IPv4 addresses
+                continue;
+            }
+            if (this.mappedPorts.has(port)) {
+                // already mapped this port
+                continue;
+            }
+            const protocol = transport.toUpperCase();
+            this.log(`creating mapping of ${host}:${port}`);
+            const mappedPort = await this.client.map(port, {
+                localAddress: host,
+                protocol: protocol === 'TCP' ? 'TCP' : 'UDP'
             });
-            this.components.addressManager.addObservedAddr(fromNodeAddress({
-                family: 4,
-                address: publicIp,
-                port: publicPort
-            }, transport));
+            this.mappedPorts.set(port, mappedPort);
+            const ma = multiaddr(addr.toString().replace(`/ip${family}/${host}/${transport}/${port}`, `/ip${family}/${publicIp}/${transport}/${mappedPort}`));
+            this.log(`created mapping of ${publicIp}:${mappedPort} to ${host}:${port} as %a`, ma);
+            if (this.autoConfirmAddress) {
+                this.addressManager.confirmObservedAddr(ma);
+            }
+            else {
+                this.addressManager.addObservedAddr(ma);
+            }
         }
     }
     /**
-     * Stops the NAT manager
+     * Some ISPs have double-NATs, there's not much we can do with them
      */
-    async stop() {
-        if (isBrowser || this.client == null) {
-            return;
-        }
-        try {
-            await this.client.close();
+    assertNotBehindDoubleNAT(publicIp) {
+        const isPrivate = isPrivateIp(publicIp);
+        if (isPrivate === true) {
+            throw new DoubleNATError(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`);
         }
-        catch (err) {
-            this.log.error(err);
+        if (isPrivate == null) {
+            throw new InvalidParametersError(`${publicIp} is not an IP address`);
         }
     }
 }

package/dist/src/upnp-nat.js.map

@@ -1 +1 @@
-{"version":3,"file":"upnp-nat.js","sourceRoot":"","sources":["../../src/upnp-nat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoC,MAAM,8BAA8B,CAAA;AACxF,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAI5C,MAAM,WAAW,GAAG,IAAI,CAAA;AAIxB,SAAS,QAAQ,CAAE,GAAG,GAAG,IAAI,EAAE,GAAG,GAAG,KAAK;IACxC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAA;AAC1D,CAAC;AAED,MAAM,OAAO,OAAO;IACX,MAAM,CAAQ;IACJ,UAAU,CAAmB;IAC7B,eAAe,CAAS;IACxB,YAAY,CAAS;IACrB,WAAW,CAAQ;IACnB,GAAG,CAAQ;IACX,SAAS,CAAS;IAClB,OAAO,CAAS;IACzB,OAAO,CAAS;IACP,GAAG,CAAQ;IAE5B,YAAa,UAA6B,EAAE,IAAiB;QAC3D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAE5B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;QAC5D,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAA;QAC3C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAA;QACxI,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,WAAW,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAA;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,IAAI,IAAI,CAAC,GAAG,GAAG,WAAW,EAAE,CAAC;YAC3B,MAAM,IAAI,sBAAsB,CAAC,qCAAqC,WAAW,UAAU,CAAC,CAAA;QAC9F,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;YACpB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;IACJ,CAAC;IAEQ,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,kBAAkB,CAAA;IAEzC,CAAC,mBAAmB,CAAC,GAAa;QACzC,uBAAuB;KACxB,CAAA;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK;QACH,0DAA0D;IAC5D,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC9B,OAAM;QACR,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QAEnB,sCAAsC;QACtC,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACvC,qCAAqC;YACrC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAA;QAEzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,qDAAqD;YACrD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAE1D,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;gBACtD,0BAA0B;gBAC1B,uCAAuC;gBACvC,SAAQ;YACV,CAAC;YAED,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,uCAAuC;gBACvC,SAAQ;YACV,CAAC;YAED,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;gBACjB,cAAc;gBACd,uCAAuC;gBACvC,SAAQ;YACV,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;YACvE,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAA;YAEvC,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACvB,MAAM,IAAI,cAAc,CAAC,GAAG,QAAQ,uHAAuH,CAAC,CAAA;YAC9J,CAAC;YAED,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;gBACtB,MAAM,IAAI,sBAAsB,CAAC,GAAG,QAAQ,uBAAuB,CAAC,CAAA;YACtE,CAAC;YAED,MAAM,UAAU,GAAG,QAAQ,EAAE,CAAA;YAE7B,IAAI,CAAC,GAAG,CAAC,gCAAgC,QAAQ,IAAI,UAAU,OAAO,IAAI,IAAI,IAAI,EAAE,CAAC,CAAA;YAErF,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;gBACpB,UAAU;gBACV,SAAS,EAAE,IAAI;gBACf,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,QAAQ,EAAE,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK;aAC5D,CAAC,CAAA;YAEF,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,eAAe,CAAC,eAAe,CAAC;gBAC7D,MAAM,EAAE,CAAC;gBACT,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,UAAU;aACjB,EAAE,SAAS,CAAC,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,SAAS,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YACrC,OAAM;QACR,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAC3B,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"upnp-nat.js","sourceRoot":"","sources":["../../src/upnp-nat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AACjH,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACzG,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AAC3F,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AASnE,MAAM,WAAW,GAAG,IAAI,CAAA;AAIxB,MAAM,OAAO,OAAO;IACX,MAAM,CAAQ;IACJ,cAAc,CAAgB;IAC9B,MAAM,CAAgC;IACtC,eAAe,CAAiB;IAChC,YAAY,CAAS;IACrB,WAAW,CAAQ;IACnB,GAAG,CAAQ;IACX,SAAS,CAAS;IAClB,OAAO,CAAS;IACzB,OAAO,CAAS;IACP,GAAG,CAAQ;IACX,uBAAuB,CAAQ;IAC/B,WAAW,CAAqB;IAChC,gBAAgB,CAAmB;IACnC,kBAAkB,CAAS;IAE5C,YAAa,UAA6B,EAAE,IAAiB;QAC3D,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;QAC5D,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAA;QACnI,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,WAAW,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAA;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,IAAI,KAAK,CAAA;QACpE,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAA;QAC1D,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;QAE5B,IAAI,IAAI,CAAC,GAAG,GAAG,WAAW,EAAE,CAAC;YAC3B,MAAM,IAAI,sBAAsB,CAAC,qCAAqC,WAAW,UAAU,CAAC,CAAA;QAC9F,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC;YACnC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAA;QAEF,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;QAEvF,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ,EAAE,CAAC;YAC7C,IAAI,CAAC,eAAe,GAAG,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QACpE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,eAAe,GAAG,sBAAsB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,EAAE;gBACD,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;gBAC3C,QAAQ,EAAE,IAAI,CAAC,4BAA4B;gBAC3C,OAAO,EAAE,IAAI,CAAC,2BAA2B;aAC1C,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAEQ,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,kBAAkB,CAAA;IAEzC,CAAC,mBAAmB,CAAC,GAAa;QACzC,uBAAuB;KACxB,CAAA;IAED,IAAI,CAAC,mBAAmB,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO;gBACL,iBAAiB;aAClB,CAAA;QACH,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACvE,MAAM,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;IAC1D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAA;QAC5B,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC1E,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACvD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,cAAc,EAAE;aAClB,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;IACN,CAAC;IAEO,oBAAoB,CAAE,UAAuB,EAAE,MAAa;QAClE,MAAM,MAAM,GAAgB,EAAE,CAAA;QAE9B,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;YAC5B,0BAA0B;YAC1B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;gBACnB,SAAQ;YACV,CAAC;YAED,kBAAkB;YAClB,IAAI,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;gBACnB,SAAQ;YACV,CAAC;YAED,0BAA0B;YAC1B,IAAI,CAAC,CACH,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClB,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzB,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;gBACrB,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAC5B,EAAE,CAAC;gBACF,SAAQ;YACV,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAA;YAEvC,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;gBACtB,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,SAAQ;YACV,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACjB,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,EAAE,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAA;QACxC,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC;YACtD,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC;SAC1D,CAAC,CAAA;QAEF,IAAI,CAAC,eAAe,IAAI,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE;YACpH,YAAY,EAAE,8GAA8G,IAAI,CAAC,uBAAuB,0DAA0D;SACnN,CAAC,CAAA;QAEF,IAAI,MAAM,GAAU,CAAC,CAAA;QAErB,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrB,MAAM,GAAG,CAAC,CAAA;QACZ,CAAC;aAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,MAAM,GAAG,CAAC,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,qBAAqB,CAAC,kBAAkB,QAAQ,0BAA0B,CAAC,CAAA;QACvF,CAAC;QAED,yEAAyE;QACzE,qBAAqB;QACrB,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAA;QAEvF,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAA;YACrE,OAAM;QACR,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;QAEvG,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAA;QAEvC,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,qDAAqD;YACrD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAE1D,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;gBACjB,8BAA8B;gBAC9B,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/B,2BAA2B;gBAC3B,SAAQ;YACV,CAAC;YAED,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,EAAE,CAAA;YAExC,IAAI,CAAC,GAAG,CAAC,uBAAuB,IAAI,IAAI,IAAI,EAAE,CAAC,CAAA;YAE/C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE;gBAC7C,YAAY,EAAE,IAAI;gBAClB,QAAQ,EAAE,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK;aAC7C,CAAC,CAAA;YAEF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;YAEtC,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,MAAM,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,EAAE,EAAE,MAAM,MAAM,IAAI,QAAQ,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC,CAAC,CAAA;YAEjJ,IAAI,CAAC,GAAG,CAAC,sBAAsB,QAAQ,IAAI,UAAU,OAAO,IAAI,IAAI,IAAI,QAAQ,EAAE,EAAE,CAAC,CAAA;YAErF,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC5B,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAA;YAC7C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACK,wBAAwB,CAAE,QAAgB;QAChD,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAA;QAEvC,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,cAAc,CAAC,GAAG,QAAQ,uHAAuH,CAAC,CAAA;QAC9J,CAAC;QAED,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,MAAM,IAAI,sBAAsB,CAAC,GAAG,QAAQ,uBAAuB,CAAC,CAAA;QACtE,CAAC;IACH,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/upnp-nat",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "description": "UPnP NAT hole punching",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/upnp-nat#readme",
@@ -50,12 +50,15 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@achingbrain/nat-port-mapper": "^1.0.13",
+    "@achingbrain/nat-port-mapper": "^2.0.1",
+    "@chainsafe/is-ip": "^2.0.2",
     "@libp2p/interface": "^2.2.0",
-    "@libp2p/interface-internal": "^2.0.10",
-    "@libp2p/utils": "^6.1.3",
+    "@libp2p/interface-internal": "^2.1.0",
+    "@libp2p/utils": "^6.2.0",
     "@multiformats/multiaddr": "^12.2.3",
-    "wherearewe": "^2.0.1"
+    "@multiformats/multiaddr-matcher": "^1.4.0",
+    "p-defer": "^4.0.1",
+    "race-signal": "^1.1.0"
   },
   "devDependencies": {
     "@libp2p/crypto": "^5.0.6",

package/src/check-external-address.ts

@@ -0,0 +1,139 @@
+import { NotStartedError, start, stop } from '@libp2p/interface'
+import { repeatingTask } from '@libp2p/utils/repeating-task'
+import { multiaddr } from '@multiformats/multiaddr'
+import pDefer from 'p-defer'
+import { raceSignal } from 'race-signal'
+import type { NatAPI } from '@achingbrain/nat-port-mapper'
+import type { AbortOptions, ComponentLogger, Logger, Startable } from '@libp2p/interface'
+import type { AddressManager } from '@libp2p/interface-internal'
+import type { RepeatingTask } from '@libp2p/utils/repeating-task'
+import type { DeferredPromise } from 'p-defer'
+
+export interface ExternalAddressCheckerComponents {
+  client: NatAPI
+  addressManager: AddressManager
+  logger: ComponentLogger
+}
+
+export interface ExternalAddressCheckerInit {
+  interval?: number
+  timeout?: number
+  autoConfirmAddress?: boolean
+}
+
+export interface ExternalAddress {
+  getPublicIp (options?: AbortOptions): Promise<string> | string
+}
+
+/**
+ * Monitors the external network address and notifies when/if it changes
+ */
+class ExternalAddressChecker implements ExternalAddress, Startable {
+  private readonly log: Logger
+  private readonly client: NatAPI
+  private readonly addressManager: AddressManager
+  private started: boolean
+  private lastPublicIp?: string
+  private readonly lastPublicIpPromise: DeferredPromise<string>
+  private readonly check: RepeatingTask
+  private readonly autoConfirmAddress: boolean
+
+  constructor (components: ExternalAddressCheckerComponents, init: ExternalAddressCheckerInit = {}) {
+    this.log = components.logger.forComponent('libp2p:upnp-nat:external-address-check')
+    this.client = components.client
+    this.addressManager = components.addressManager
+    this.autoConfirmAddress = init.autoConfirmAddress ?? false
+    this.started = false
+
+    this.checkExternalAddress = this.checkExternalAddress.bind(this)
+
+    this.lastPublicIpPromise = pDefer()
+
+    this.check = repeatingTask(this.checkExternalAddress, init.interval ?? 30000, {
+      timeout: init.timeout ?? 10000,
+      runImmediately: true
+    })
+  }
+
+  async start (): Promise<void> {
+    if (this.started) {
+      return
+    }
+
+    await start(this.check)
+
+    this.check.start()
+    this.started = true
+  }
+
+  async stop (): Promise<void> {
+    await stop(this.check)
+
+    this.started = false
+  }
+
+  /**
+   * Return the last public IP address we found, or wait for it to be found
+   */
+  async getPublicIp (options?: AbortOptions): Promise<string> {
+    if (!this.started) {
+      throw new NotStartedError('Not started yet')
+    }
+
+    return this.lastPublicIp ?? raceSignal(this.lastPublicIpPromise.promise, options?.signal, {
+      errorMessage: 'Requesting the public IP from the network gateway timed out - UPnP may not be enabled'
+    })
+  }
+
+  private async checkExternalAddress (options?: AbortOptions): Promise<void> {
+    try {
+      const externalAddress = await this.client.externalIp(options)
+
+      // check if our public address has changed
+      if (this.lastPublicIp != null && externalAddress !== this.lastPublicIp) {
+        this.log('external address changed from %s to %s', this.lastPublicIp, externalAddress)
+
+        for (const ma of this.addressManager.getAddresses()) {
+          const addrString = ma.toString()
+
+          if (!addrString.includes(this.lastPublicIp)) {
+            continue
+          }
+
+          // create a new version of the multiaddr with the new public IP
+          const newAddress = multiaddr(addrString.replace(this.lastPublicIp, externalAddress))
+
+          // remove the old address and add the new one
+          this.addressManager.removeObservedAddr(ma)
+          this.addressManager.confirmObservedAddr(newAddress)
+
+          if (this.autoConfirmAddress) {
+            this.addressManager.confirmObservedAddr(newAddress)
+          } else {
+            this.addressManager.addObservedAddr(newAddress)
+          }
+        }
+      }
+
+      this.lastPublicIp = externalAddress
+      this.lastPublicIpPromise.resolve(externalAddress)
+    } catch (err: any) {
+      if (this.lastPublicIp != null) {
+        // ignore the error if we've previously run successfully
+        return
+      }
+
+      this.lastPublicIpPromise.reject(err)
+    }
+  }
+}
+
+export function dynamicExternalAddress (components: ExternalAddressCheckerComponents, init: ExternalAddressCheckerInit = {}): ExternalAddress {
+  return new ExternalAddressChecker(components, init)
+}
+
+export function staticExternalAddress (address: string): ExternalAddress {
+  return {
+    getPublicIp: () => address
+  }
+}

package/src/errors.ts

@@ -4,3 +4,8 @@ export class DoubleNATError extends Error {
     this.name = 'DoubleNATError'
   }
 }
+
+export class InvalidIPAddressError extends Error {
+  static name = 'InvalidIPAddressError'
+  name = 'InvalidIPAddressError'
+}

package/src/index.ts

@@ -36,8 +36,8 @@
  */
 
 import { UPnPNAT as UPnPNATClass, type NatAPI, type MapPortOptions } from './upnp-nat.js'
-import type { ComponentLogger, NodeInfo, PeerId } from '@libp2p/interface'
-import type { AddressManager, TransportManager } from '@libp2p/interface-internal'
+import type { ComponentLogger, Libp2pEvents, NodeInfo, PeerId, TypedEventTarget } from '@libp2p/interface'
+import type { AddressManager } from '@libp2p/interface-internal'
 
 export type { NatAPI, MapPortOptions }
 
@@ -50,10 +50,27 @@ export interface PMPOptions {
 
 export interface UPnPNATInit {
   /**
-   * Pass a value to use instead of auto-detection
+   * Pass a string to hard code the external address, otherwise it will be
+   * auto-detected
    */
   externalAddress?: string
 
+  /**
+   * Check if the external address has changed this often in ms. Ignored if an
+   * external address is specified.
+   *
+   * @default 30000
+   */
+  externalAddressCheckInterval?: number
+
+  /**
+   * Do not take longer than this to check if the external address has changed
+   * in ms.  Ignored if an external address is specified.
+   *
+   * @default 10000
+   */
+  externalAddressCheckTimeout?: number
+
   /**
    * Pass a value to use instead of auto-detection
    */
@@ -78,14 +95,50 @@ export interface UPnPNATInit {
    * Pass a value to use instead of auto-detection
    */
   gateway?: string
+
+  /**
+   * How long in ms to wait before giving up trying to auto-detect a
+   * `urn:schemas-upnp-org:device:InternetGatewayDevice:1` device on the local
+   * network
+   *
+   * @default 10000
+   */
+  gatewayDetectionTimeout?: number
+
+  /**
+   * Ports are mapped when the `self:peer:update` event fires, which happens
+   * when the node's addresses change. To avoid starting to map ports while
+   * multiple addresses are being added, the mapping function is debounced by
+   * this number of ms
+   *
+   * @default 5000
+   */
+  delay?: number
+
+  /**
+   * A preconfigured instance of a NatAPI client can be passed as an option,
+   * otherwise one will be created
+   */
+  client?: NatAPI
+
+  /**
+   * Any mapped addresses are added to the observed address list. These
+   * addresses require additional verification by the `@libp2p/autonat` protocol
+   * or similar before they are trusted.
+   *
+   * To skip this verification and trust them immediately pass `true` here
+   *
+   * @default false
+   */
+  autoConfirmAddress?: boolean
 }
 
 export interface UPnPNATComponents {
   peerId: PeerId
   nodeInfo: NodeInfo
   logger: ComponentLogger
-  transportManager: TransportManager
   addressManager: AddressManager
+  events: TypedEventTarget<Libp2pEvents>
 }
 
 export interface UPnPNAT {

package/src/upnp-nat.ts

@@ -1,25 +1,32 @@
-import { upnpNat, type NatAPI, type MapPortOptions } from '@achingbrain/nat-port-mapper'
-import { InvalidParametersError, serviceCapabilities } from '@libp2p/interface'
+import { upnpNat } from '@achingbrain/nat-port-mapper'
+import { isIPv4, isIPv6 } from '@chainsafe/is-ip'
+import { InvalidParametersError, serviceCapabilities, serviceDependencies, start, stop } from '@libp2p/interface'
+import { debounce } from '@libp2p/utils/debounce'
 import { isLoopback } from '@libp2p/utils/multiaddr/is-loopback'
+import { isPrivate } from '@libp2p/utils/multiaddr/is-private'
 import { isPrivateIp } from '@libp2p/utils/private-ip'
-import { fromNodeAddress } from '@multiformats/multiaddr'
-import { isBrowser } from 'wherearewe'
-import { DoubleNATError } from './errors.js'
+import { multiaddr } from '@multiformats/multiaddr'
+import { QUICV1, TCP, WebSockets, WebSocketsSecure, WebTransport } from '@multiformats/multiaddr-matcher'
+import { raceSignal } from 'race-signal'
+import { dynamicExternalAddress, staticExternalAddress } from './check-external-address.js'
+import { DoubleNATError, InvalidIPAddressError } from './errors.js'
+import type { ExternalAddress } from './check-external-address.js'
 import type { UPnPNATComponents, UPnPNATInit, UPnPNAT as UPnPNATInterface } from './index.js'
-import type { Logger, Startable } from '@libp2p/interface'
+import type { NatAPI, MapPortOptions } from '@achingbrain/nat-port-mapper'
+import type { Libp2pEvents, Logger, Startable, TypedEventTarget } from '@libp2p/interface'
+import type { AddressManager } from '@libp2p/interface-internal'
+import type { DebouncedFunction } from '@libp2p/utils/debounce'
+import type { Multiaddr } from '@multiformats/multiaddr'
 
 const DEFAULT_TTL = 7200
 
 export type { NatAPI, MapPortOptions }
 
-function highPort (min = 1024, max = 65535): number {
-  return Math.floor(Math.random() * (max - min + 1) + min)
-}
-
 export class UPnPNAT implements Startable, UPnPNATInterface {
   public client: NatAPI
-  private readonly components: UPnPNATComponents
-  private readonly externalAddress?: string
+  private readonly addressManager: AddressManager
+  private readonly events: TypedEventTarget<Libp2pEvents>
+  private readonly externalAddress: ExternalAddress
   private readonly localAddress?: string
   private readonly description: string
   private readonly ttl: number
@@ -27,29 +34,51 @@ export class UPnPNAT implements Startable, UPnPNATInterface {
   private readonly gateway?: string
   private started: boolean
   private readonly log: Logger
+  private readonly gatewayDetectionTimeout: number
+  private readonly mappedPorts: Map<number, number>
+  private readonly onSelfPeerUpdate: DebouncedFunction
+  private readonly autoConfirmAddress: boolean
 
   constructor (components: UPnPNATComponents, init: UPnPNATInit) {
-    this.components = components
-
     this.log = components.logger.forComponent('libp2p:upnp-nat')
+    this.addressManager = components.addressManager
+    this.events = components.events
     this.started = false
-    this.externalAddress = init.externalAddress
     this.localAddress = init.localAddress
-    this.description = init.description ?? `${components.nodeInfo.name}@${components.nodeInfo.version} ${this.components.peerId.toString()}`
+    this.description = init.description ?? `${components.nodeInfo.name}@${components.nodeInfo.version} ${components.peerId.toString()}`
     this.ttl = init.ttl ?? DEFAULT_TTL
     this.keepAlive = init.keepAlive ?? true
     this.gateway = init.gateway
+    this.gatewayDetectionTimeout = init.gatewayDetectionTimeout ?? 10000
+    this.autoConfirmAddress = init.autoConfirmAddress ?? false
+    this.mappedPorts = new Map()
 
     if (this.ttl < DEFAULT_TTL) {
       throw new InvalidParametersError(`NatManager ttl should be at least ${DEFAULT_TTL} seconds`)
     }
 
-    this.client = upnpNat({
+    this.client = init.client ?? upnpNat({
       description: this.description,
       ttl: this.ttl,
       keepAlive: this.keepAlive,
       gateway: this.gateway
     })
+
+    this.onSelfPeerUpdate = debounce(this._onSelfPeerUpdate.bind(this), init.delay ?? 5000)
+
+    if (typeof init.externalAddress === 'string') {
+      this.externalAddress = staticExternalAddress(init.externalAddress)
+    } else {
+      this.externalAddress = dynamicExternalAddress({
+        client: this.client,
+        addressManager: this.addressManager,
+        logger: components.logger
+      }, {
+        autoConfirmAddress: init.autoConfirmAddress,
+        interval: init.externalAddressCheckInterval,
+        timeout: init.externalAddressCheckTimeout
+      })
+    }
   }
 
   readonly [Symbol.toStringTag] = '@libp2p/upnp-nat'
@@ -58,99 +87,178 @@ export class UPnPNAT implements Startable, UPnPNATInterface {
     '@libp2p/nat-traversal'
   ]
 
+  get [serviceDependencies] (): string[] {
+    if (!this.autoConfirmAddress) {
+      return [
+        '@libp2p/autonat'
+      ]
+    }
+
+    return []
+  }
+
   isStarted (): boolean {
     return this.started
   }
 
-  start (): void {
-    // #TODO: is there a way to remove this? Seems like a hack
+  async start (): Promise<void> {
+    if (this.started) {
+      return
+    }
+
+    this.started = true
+    this.events.addEventListener('self:peer:update', this.onSelfPeerUpdate)
+    await start(this.externalAddress, this.onSelfPeerUpdate)
   }
 
   /**
-   * Attempt to use uPnP to configure port mapping using the current gateway.
-   *
-   * Run after start to ensure the transport manager has all addresses configured.
+   * Stops the NAT manager
    */
-  afterStart (): void {
-    if (isBrowser || this.started) {
-      return
+  async stop (): Promise<void> {
+    try {
+      await this.client?.close()
+    } catch (err: any) {
+      this.log.error(err)
     }
 
-    this.started = true
+    this.events.removeEventListener('self:peer:update', this.onSelfPeerUpdate)
+    await stop(this.externalAddress, this.onSelfPeerUpdate)
+    this.started = false
+  }
 
-    // done async to not slow down startup
-    void this.mapIpAddresses().catch((err) => {
-      // hole punching errors are non-fatal
-      this.log.error(err)
-    })
+  _onSelfPeerUpdate (): void {
+    this.mapIpAddresses()
+      .catch(err => {
+        this.log.error('error mapping IP addresses - %e', err)
+      })
   }
 
-  async mapIpAddresses (): Promise<void> {
-    const addrs = this.components.transportManager.getAddrs()
+  private getUnmappedAddresses (multiaddrs: Multiaddr[], ipType: 4 | 6): Multiaddr[] {
+    const output: Multiaddr[] = []
 
-    for (const addr of addrs) {
-      // try to open uPnP ports for each thin waist address
-      const { family, host, port, transport } = addr.toOptions()
+    for (const ma of multiaddrs) {
+      // ignore public addresses
+      if (!isPrivate(ma)) {
+        continue
+      }
 
-      if (!addr.isThinWaistAddress() || transport !== 'tcp') {
-        // only bare tcp addresses
-        // eslint-disable-next-line no-continue
+      // ignore loopback
+      if (isLoopback(ma)) {
         continue
       }
 
-      if (isLoopback(addr)) {
-        // eslint-disable-next-line no-continue
+      // only IP based addresses
+      if (!(
+        TCP.exactMatch(ma) ||
+        WebSockets.exactMatch(ma) ||
+        WebSocketsSecure.exactMatch(ma) ||
+        QUICV1.exactMatch(ma) ||
+        WebTransport.exactMatch(ma)
+      )) {
         continue
       }
 
-      if (family !== 4) {
-        // ignore ipv6
-        // eslint-disable-next-line no-continue
+      const { port, family } = ma.toOptions()
+
+      if (family !== ipType) {
         continue
       }
 
-      const publicIp = this.externalAddress ?? await this.client.externalIp()
-      const isPrivate = isPrivateIp(publicIp)
+      if (this.mappedPorts.has(port)) {
+        continue
+      }
 
-      if (isPrivate === true) {
-        throw new DoubleNATError(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`)
+      output.push(ma)
+    }
+
+    return output
+  }
+
+  async mapIpAddresses (): Promise<void> {
+    if (this.externalAddress == null) {
+      this.log('discovering public address')
+    }
+
+    const publicIp = await this.externalAddress.getPublicIp({
+      signal: AbortSignal.timeout(this.gatewayDetectionTimeout)
+    })
+
+    this.externalAddress ?? await raceSignal(this.client.externalIp(), AbortSignal.timeout(this.gatewayDetectionTimeout), {
+      errorMessage: `Did not discover a "urn:schemas-upnp-org:device:InternetGatewayDevice:1" device on the local network after ${this.gatewayDetectionTimeout}ms - UPnP may not be configured on your router correctly`
+    })
+
+    let ipType: 4 | 6 = 4
+
+    if (isIPv4(publicIp)) {
+      ipType = 4
+    } else if (isIPv6(publicIp)) {
+      ipType = 6
+    } else {
+      throw new InvalidIPAddressError(`Public address ${publicIp} was not an IPv4 address`)
+    }
+
+    // filter addresses to get private, non-relay, IP based addresses that we
+    // haven't mapped yet
+    const addresses = this.getUnmappedAddresses(this.addressManager.getAddresses(), ipType)
+
+    if (addresses.length === 0) {
+      this.log('no private, non-relay, unmapped, IP based addresses found')
+      return
+    }
+
+    this.log('%s public IP %s', this.externalAddress != null ? 'using configured' : 'discovered', publicIp)
+
+    this.assertNotBehindDoubleNAT(publicIp)
+
+    for (const addr of addresses) {
+      // try to open uPnP ports for each thin waist address
+      const { family, host, port, transport } = addr.toOptions()
+
+      if (family === 6) {
+        // only support IPv4 addresses
+        continue
       }
 
-      if (isPrivate == null) {
-        throw new InvalidParametersError(`${publicIp} is not an IP address`)
+      if (this.mappedPorts.has(port)) {
+        // already mapped this port
+        continue
       }
 
-      const publicPort = highPort()
+      const protocol = transport.toUpperCase()
 
-      this.log(`opening uPnP connection from ${publicIp}:${publicPort} to ${host}:${port}`)
+      this.log(`creating mapping of ${host}:${port}`)
 
-      await this.client.map({
-        publicPort,
-        localPort: port,
-        localAddress: this.localAddress,
-        protocol: transport.toUpperCase() === 'TCP' ? 'TCP' : 'UDP'
+      const mappedPort = await this.client.map(port, {
+        localAddress: host,
+        protocol: protocol === 'TCP' ? 'TCP' : 'UDP'
       })
 
-      this.components.addressManager.addObservedAddr(fromNodeAddress({
-        family: 4,
-        address: publicIp,
-        port: publicPort
-      }, transport))
+      this.mappedPorts.set(port, mappedPort)
+
+      const ma = multiaddr(addr.toString().replace(`/ip${family}/${host}/${transport}/${port}`, `/ip${family}/${publicIp}/${transport}/${mappedPort}`))
+
+      this.log(`created mapping of ${publicIp}:${mappedPort} to ${host}:${port} as %a`, ma)
+
+      if (this.autoConfirmAddress) {
+        this.addressManager.confirmObservedAddr(ma)
+      } else {
+        this.addressManager.addObservedAddr(ma)
+      }
     }
   }
 
   /**
-   * Stops the NAT manager
+   * Some ISPs have double-NATs, there's not much we can do with them
    */
-  async stop (): Promise<void> {
-    if (isBrowser || this.client == null) {
-      return
+  private assertNotBehindDoubleNAT (publicIp: string): void {
+    const isPrivate = isPrivateIp(publicIp)
+
+    if (isPrivate === true) {
+      throw new DoubleNATError(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`)
     }
 
-    try {
-      await this.client.close()
-    } catch (err: any) {
-      this.log.error(err)
+    if (isPrivate == null) {
+      throw new InvalidParametersError(`${publicIp} is not an IP address`)
     }
   }
 }