@libp2p/upnp-nat 2.0.12-a82b07d8c → 2.0.12-b02ea9b6e

package/dist/src/upnp-port-mapper.d.ts

@@ -0,0 +1,38 @@
+import type { Gateway } from '@achingbrain/nat-port-mapper';
+import type { ComponentLogger } from '@libp2p/interface';
+import type { AddressManager } from '@libp2p/interface-internal';
+export interface UPnPPortMapperInit {
+    gateway: Gateway;
+    externalAddressCheckInterval?: number;
+    externalAddressCheckTimeout?: number;
+}
+export interface UPnPPortMapperComponents {
+    logger: ComponentLogger;
+    addressManager: AddressManager;
+}
+export declare class UPnPPortMapper {
+    private readonly gateway;
+    private readonly externalAddress;
+    private readonly addressManager;
+    private readonly log;
+    private readonly mappedPorts;
+    private started;
+    constructor(components: UPnPPortMapperComponents, init: UPnPPortMapperInit);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * Update the local address mappings when the gateway's external interface
+     * address changes
+     */
+    private remapPorts;
+    /**
+     * Return any eligible multiaddrs that are not mapped on the detected gateway
+     */
+    private getUnmappedAddresses;
+    mapIpAddresses(): Promise<void>;
+    /**
+     * Some ISPs have double-NATs, there's not much we can do with them
+     */
+    private assertNotBehindDoubleNAT;
+}
+//# sourceMappingURL=upnp-port-mapper.d.ts.map

package/dist/src/upnp-port-mapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upnp-port-mapper.d.ts","sourceRoot":"","sources":["../../src/upnp-port-mapper.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAU,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAGhE,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,4BAA4B,CAAC,EAAE,MAAM,CAAA;IACrC,2BAA2B,CAAC,EAAE,MAAM,CAAA;CACrC;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,eAAe,CAAA;IACvB,cAAc,EAAE,cAAc,CAAA;CAC/B;AAOD,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,OAAO,CAAS;gBAEX,UAAU,EAAE,wBAAwB,EAAE,IAAI,EAAE,kBAAkB;IAkBrE,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IASvB,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;IAe5B;;;OAGG;IACH,OAAO,CAAC,UAAU;IAalB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAyCtB,cAAc,IAAK,OAAO,CAAC,IAAI,CAAC;IAmEtC;;OAEG;IACH,OAAO,CAAC,wBAAwB;CAWjC"}

package/dist/src/upnp-port-mapper.js

@@ -0,0 +1,166 @@
+import { isIPv4, isIPv6 } from '@chainsafe/is-ip';
+import { InvalidParametersError, start, stop } from '@libp2p/interface';
+import { isLoopback } from '@libp2p/utils/multiaddr/is-loopback';
+import { isPrivate } from '@libp2p/utils/multiaddr/is-private';
+import { isPrivateIp } from '@libp2p/utils/private-ip';
+import { QUICV1, TCP, WebSockets, WebSocketsSecure, WebTransport } from '@multiformats/multiaddr-matcher';
+import { dynamicExternalAddress } from './check-external-address.js';
+import { DoubleNATError, InvalidIPAddressError } from './errors.js';
+export class UPnPPortMapper {
+    gateway;
+    externalAddress;
+    addressManager;
+    log;
+    mappedPorts;
+    started;
+    constructor(components, init) {
+        this.log = components.logger.forComponent(`libp2p:upnp-nat:gateway:${init.gateway.id}`);
+        this.addressManager = components.addressManager;
+        this.gateway = init.gateway;
+        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;
+    }
+    async start() {
+        if (this.started) {
+            return;
+        }
+        await start(this.externalAddress);
+        this.started = true;
+    }
+    async stop() {
+        try {
+            const shutdownTimeout = AbortSignal.timeout(1000);
+            await this.gateway.stop({
+                signal: shutdownTimeout
+            });
+        }
+        catch (err) {
+            this.log.error('error closing gateway - %e', err);
+        }
+        await stop(this.externalAddress);
+        this.started = false;
+    }
+    /**
+     * Update the local address mappings when the gateway's external interface
+     * address changes
+     */
+    remapPorts(newExternalHost) {
+        for (const [key, { externalHost, externalPort }] of this.mappedPorts.entries()) {
+            const [host, port, transport] = key.split('-');
+            this.addressManager.removePublicAddressMapping(host, parseInt(port), externalHost, externalPort, transport === 'tcp' ? 'tcp' : 'udp');
+            this.addressManager.addPublicAddressMapping(host, parseInt(port), newExternalHost, externalPort, transport === 'tcp' ? 'tcp' : 'udp');
+        }
+    }
+    /**
+     * Return any eligible multiaddrs that are not mapped on the detected gateway
+     */
+    getUnmappedAddresses(multiaddrs, ipType) {
+        const output = [];
+        for (const ma of multiaddrs) {
+            // ignore public addresses
+            if (!isPrivate(ma)) {
+                continue;
+            }
+            // ignore loopback
+            if (isLoopback(ma)) {
+                continue;
+            }
+            // only IP based addresses
+            if (!(TCP.exactMatch(ma) ||
+                WebSockets.exactMatch(ma) ||
+                WebSocketsSecure.exactMatch(ma) ||
+                QUICV1.exactMatch(ma) ||
+                WebTransport.exactMatch(ma))) {
+                continue;
+            }
+            const { port, host, family, transport } = ma.toOptions();
+            if (family !== ipType) {
+                continue;
+            }
+            if (this.mappedPorts.has(`${host}-${port}-${transport}`)) {
+                continue;
+            }
+            output.push(ma);
+        }
+        return output;
+    }
+    async mapIpAddresses() {
+        try {
+            const externalHost = await this.externalAddress.getPublicIp();
+            let ipType = 4;
+            if (isIPv4(externalHost)) {
+                ipType = 4;
+            }
+            else if (isIPv6(externalHost)) {
+                ipType = 6;
+            }
+            else {
+                throw new InvalidIPAddressError(`Public address ${externalHost} 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', externalHost);
+            this.assertNotBehindDoubleNAT(externalHost);
+            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(`${host}-${port}-${transport}`)) {
+                    // already mapped this port
+                    continue;
+                }
+                try {
+                    const key = `${host}-${port}-${transport}`;
+                    this.log('creating mapping of key %s', key);
+                    const externalPort = await this.gateway.map(port, {
+                        localAddress: host,
+                        protocol: transport === 'tcp' ? 'tcp' : 'udp'
+                    });
+                    this.mappedPorts.set(key, {
+                        externalHost,
+                        externalPort
+                    });
+                    this.log('created mapping of %s:%s to %s:%s', externalHost, externalPort, host, port);
+                    this.addressManager.addPublicAddressMapping(host, port, externalHost, externalPort, transport === 'tcp' ? 'tcp' : 'udp');
+                }
+                catch (err) {
+                    this.log.error('failed to create mapping of %s:%s - %e', host, port, err);
+                }
+            }
+        }
+        catch (err) {
+            this.log.error('error finding gateways - %e', err);
+        }
+    }
+    /**
+     * Some ISPs have double-NATs, there's not much we can do with them
+     */
+    assertNotBehindDoubleNAT(publicIp) {
+        const isPrivate = isPrivateIp(publicIp);
+        if (isPrivate === true) {
+            throw new DoubleNATError(`${publicIp} is private - please init uPnPNAT with 'externalAddress' set to an externally routable IP or ensure you are not behind a double NAT`);
+        }
+        if (isPrivate == null) {
+            throw new InvalidParametersError(`${publicIp} is not an IP address`);
+        }
+    }
+}
+//# sourceMappingURL=upnp-port-mapper.js.map

package/dist/src/upnp-port-mapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upnp-port-mapper.js","sourceRoot":"","sources":["../../src/upnp-port-mapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AACvE,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,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACzG,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAuBnE,MAAM,OAAO,cAAc;IACR,OAAO,CAAS;IAChB,eAAe,CAAiB;IAChC,cAAc,CAAgB;IAC9B,GAAG,CAAQ;IACX,WAAW,CAA0B;IAC9C,OAAO,CAAS;IAExB,YAAa,UAAoC,EAAE,IAAwB;QACzE,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,2BAA2B,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAA;QACvF,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,eAAe,GAAG,sBAAsB,CAAC;YAC5C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,EAAE;YACD,QAAQ,EAAE,IAAI,CAAC,4BAA4B;YAC3C,OAAO,EAAE,IAAI,CAAC,2BAA2B;YACzC,uBAAuB,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;SACpD,CAAC,CAAA;QACF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAM;QACR,CAAC;QAED,MAAM,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;YAEjD,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBACtB,MAAM,EAAE,eAAe;aACxB,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAA;QACnD,CAAC;QAED,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAChC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED;;;OAGG;IACK,UAAU,CAAE,eAAuB;QACzC,KAAK,MAAM,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/E,MAAM,CACJ,IAAI,EACJ,IAAI,EACJ,SAAS,CACV,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAElB,IAAI,CAAC,cAAc,CAAC,0BAA0B,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;YACrI,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,YAAY,EAAE,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QACvI,CAAC;IACH,CAAC;IAED;;OAEG;IACK,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,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAA;YAExD,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;gBACtB,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,IAAI,IAAI,SAAS,EAAE,CAAC,EAAE,CAAC;gBACzD,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,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,CAAA;YAE7D,IAAI,MAAM,GAAU,CAAC,CAAA;YAErB,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACzB,MAAM,GAAG,CAAC,CAAA;YACZ,CAAC;iBAAM,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBAChC,MAAM,GAAG,CAAC,CAAA;YACZ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,qBAAqB,CAAC,kBAAkB,YAAY,0BAA0B,CAAC,CAAA;YAC3F,CAAC;YAED,yEAAyE;YACzE,qBAAqB;YACrB,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAA;YAEvF,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3B,IAAI,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAA;gBACrE,OAAM;YACR,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;YAE3G,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAA;YAE3C,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;gBAC7B,qDAAqD;gBACrD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;gBAE1D,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;oBACjB,8BAA8B;oBAC9B,SAAQ;gBACV,CAAC;gBAED,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,IAAI,IAAI,SAAS,EAAE,CAAC,EAAE,CAAC;oBACzD,2BAA2B;oBAC3B,SAAQ;gBACV,CAAC;gBAED,IAAI,CAAC;oBACH,MAAM,GAAG,GAAG,GAAG,IAAI,IAAI,IAAI,IAAI,SAAS,EAAE,CAAA;oBAC1C,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAA;oBAE3C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;wBAChD,YAAY,EAAE,IAAI;wBAClB,QAAQ,EAAE,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK;qBAC9C,CAAC,CAAA;oBAEF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE;wBACxB,YAAY;wBACZ,YAAY;qBACb,CAAC,CAAA;oBAEF,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;oBAErF,IAAI,CAAC,cAAc,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;gBAC1H,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wCAAwC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;gBAC3E,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;QACpD,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,qIAAqI,CAAC,CAAA;QAC5K,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.12-a82b07d8c",
+  "version": "2.0.12-b02ea9b6e",
   "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,20 +50,20 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@achingbrain/nat-port-mapper": "^2.0.1",
+    "@achingbrain/nat-port-mapper": "^3.0.1",
     "@chainsafe/is-ip": "^2.0.2",
-    "@libp2p/interface": "2.2.1-a82b07d8c",
-    "@libp2p/interface-internal": "2.1.1-a82b07d8c",
-    "@libp2p/utils": "6.2.1-a82b07d8c",
+    "@libp2p/interface": "2.2.1-b02ea9b6e",
+    "@libp2p/interface-internal": "2.1.1-b02ea9b6e",
+    "@libp2p/utils": "6.2.1-b02ea9b6e",
     "@multiformats/multiaddr": "^12.2.3",
     "@multiformats/multiaddr-matcher": "^1.4.0",
     "p-defer": "^4.0.1",
     "race-signal": "^1.1.0"
   },
   "devDependencies": {
-    "@libp2p/crypto": "5.0.7-a82b07d8c",
-    "@libp2p/logger": "5.1.4-a82b07d8c",
-    "@libp2p/peer-id": "5.0.8-a82b07d8c",
+    "@libp2p/crypto": "5.0.7-b02ea9b6e",
+    "@libp2p/logger": "5.1.4-b02ea9b6e",
+    "@libp2p/peer-id": "5.0.8-b02ea9b6e",
     "aegir": "^44.0.1",
     "sinon-ts": "^2.0.0"
   },

package/src/check-external-address.ts

@@ -2,14 +2,14 @@ import { NotStartedError, start, stop } from '@libp2p/interface'
 import { repeatingTask } from '@libp2p/utils/repeating-task'
 import pDefer from 'p-defer'
 import { raceSignal } from 'race-signal'
-import type { NatAPI } from '@achingbrain/nat-port-mapper'
+import type { Gateway } 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
+  gateway: Gateway
   addressManager: AddressManager
   logger: ComponentLogger
 }
@@ -29,7 +29,7 @@ export interface ExternalAddress {
  */
 class ExternalAddressChecker implements ExternalAddress, Startable {
   private readonly log: Logger
-  private readonly client: NatAPI
+  private readonly gateway: Gateway
   private readonly addressManager: AddressManager
   private started: boolean
   private lastPublicIp?: string
@@ -39,7 +39,7 @@ class ExternalAddressChecker implements ExternalAddress, Startable {
 
   constructor (components: ExternalAddressCheckerComponents, init: ExternalAddressCheckerInit) {
     this.log = components.logger.forComponent('libp2p:upnp-nat:external-address-check')
-    this.client = components.client
+    this.gateway = components.gateway
     this.addressManager = components.addressManager
     this.onExternalAddressChange = init.onExternalAddressChange
     this.started = false
@@ -60,14 +60,11 @@ class ExternalAddressChecker implements ExternalAddress, Startable {
     }
 
     await start(this.check)
-
-    this.check.start()
     this.started = true
   }
 
   async stop (): Promise<void> {
     await stop(this.check)
-
     this.started = false
   }
 
@@ -86,7 +83,7 @@ class ExternalAddressChecker implements ExternalAddress, Startable {
 
   private async checkExternalAddress (options?: AbortOptions): Promise<void> {
     try {
-      const externalAddress = await this.client.externalIp(options)
+      const externalAddress = await this.gateway.externalIp(options)
 
       // check if our public address has changed
       if (this.lastPublicIp != null && externalAddress !== this.lastPublicIp) {
@@ -99,6 +96,8 @@ class ExternalAddressChecker implements ExternalAddress, Startable {
       this.lastPublicIp = externalAddress
       this.lastPublicIpPromise.resolve(externalAddress)
     } catch (err: any) {
+      this.log.error('could not resolve external address - %e', err)
+
       if (this.lastPublicIp != null) {
         // ignore the error if we've previously run successfully
         return

package/src/constants.ts

@@ -0,0 +1,3 @@
+export const DEFAULT_PORT_MAPPING_TTL = 720_000
+export const DEFAULT_GATEWAY_SEARCH_TIMEOUT = 60_000
+export const DEFAULT_GATEWAY_SEARCH_INTERVAL = 300_000

package/src/gateway-finder.ts

@@ -0,0 +1,70 @@
+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)) {
+        if (this.gateways.some(g => g.id === gateway.id)) {
+          // 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

@@ -35,11 +35,12 @@
  * ```
  */
 
-import { UPnPNAT as UPnPNATClass, type NatAPI, type MapPortOptions } from './upnp-nat.js'
+import { UPnPNAT as UPnPNATClass } from './upnp-nat.js'
+import type { UPnPNAT as UPnPNATClient, MapPortOptions } from '@achingbrain/nat-port-mapper'
 import type { ComponentLogger, Libp2pEvents, NodeInfo, PeerId, TypedEventTarget } from '@libp2p/interface'
 import type { AddressManager } from '@libp2p/interface-internal'
 
-export type { NatAPI, MapPortOptions }
+export type { UPnPNATClient, MapPortOptions }
 
 export interface PMPOptions {
   /**
@@ -49,12 +50,6 @@ export interface PMPOptions {
 }
 
 export interface UPnPNATInit {
-  /**
-   * 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.
@@ -71,46 +66,31 @@ export interface UPnPNATInit {
    */
   externalAddressCheckTimeout?: number
 
-  /**
-   * Pass a value to use instead of auto-detection
-   */
-  localAddress?: string
-
   /**
    * A string value to use for the port mapping description on the gateway
    */
-  description?: string
+  portMappingDescription?: string
 
   /**
-   * How long UPnP port mappings should last for in seconds (minimum 1200)
-   */
-  ttl?: number
-
-  /**
-   * Whether to automatically refresh UPnP port mappings when their TTL is reached
-   */
-  keepAlive?: boolean
-
-  /**
-   * Pass a value to use instead of auto-detection
+   * How long UPnP port mappings should last for in ms
+   *
+   * @default 720_000
    */
-  gateway?: string
+  portMappingTTL?: 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
+   * Whether to automatically refresh UPnP port mappings when their TTL is
+   * reached
    *
-   * @default 5000
+   * @default true
    */
-  delay?: number
+  portMappingAutoRefresh?: boolean
 
   /**
    * A preconfigured instance of a NatAPI client can be passed as an option,
    * otherwise one will be created
    */
-  client?: NatAPI
+  portMappingClient?: UPnPNATClient
 }
 
 export interface UPnPNATComponents {
@@ -122,7 +102,7 @@ export interface UPnPNATComponents {
 }
 
 export interface UPnPNAT {
-  client: NatAPI
+  portMappingClient: UPnPNATClient
 }
 
 export function uPnPNAT (init: UPnPNATInit = {}): (components: UPnPNATComponents) => UPnPNAT {