npm - @libp2p/utils - Versions diffs - 7.0.17-fd68eecf7 → 7.1.0 - Mend

@libp2p/utils 7.0.17-fd68eecf7 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/dist/index.min.js +4 -4
package/dist/index.min.js.map +3 -3
package/dist/src/multiaddr/get-net-config.d.ts +7 -4
package/dist/src/multiaddr/get-net-config.d.ts.map +1 -1
package/dist/src/multiaddr/get-net-config.js +18 -9
package/dist/src/multiaddr/get-net-config.js.map +1 -1
package/dist/src/multiaddr/is-network-address.d.ts.map +1 -1
package/dist/src/multiaddr/is-network-address.js +2 -8
package/dist/src/multiaddr/is-network-address.js.map +1 -1
package/dist/typedoc-urls.json +125 -0
package/package.json +5 -5
package/src/multiaddr/get-net-config.ts +21 -9
package/src/multiaddr/is-network-address.ts +2 -8

package/dist/src/multiaddr/get-net-config.d.ts CHANGED Viewed

@@ -46,10 +46,13 @@ export interface DNSAddrNetConfig {
 }
 export type NetConfig = IP4NetConfig | IP6NetConfig | DNSNetConfig | DNS4NetConfig | DNS6NetConfig | DNSAddrNetConfig;
 /**
- * Returns host/port/etc information for multiaddrs, if it is available.
- *
- * It will throw if the passed multiaddr does not start with a network address,
- * e.g. a IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR address
+ * Returns host/port/etc information for a multiaddr if it starts with a
+ * network address (IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR), or null otherwise.
+ */
+export declare function tryGetNetConfig(ma: Multiaddr): NetConfig | null;
+/**
+ * Like `tryGetNetConfig` but throws `InvalidParametersError` when the multiaddr
+ * does not start with a network address.
  */
 export declare function getNetConfig(ma: Multiaddr): NetConfig;
 //# sourceMappingURL=get-net-config.d.ts.map

package/dist/src/multiaddr/get-net-config.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"get-net-config.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/get-net-config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAErH~~;;;;;GAKG~~;AACH,wBAAgB,YAAY,CAAE,EAAE,EAAE,SAAS,GAAG,SAAS,~~CAiDtD~~"}
1	+ {"version":3,"file":"get-net-config.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/get-net-config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAErH;;;GAGG;AACH,wBAAgB,eAAe,CAAE,EAAE,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAiDhE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAE,EAAE,EAAE,SAAS,GAAG,SAAS,CAQtD"}

package/dist/src/multiaddr/get-net-config.js CHANGED Viewed

@@ -1,11 +1,9 @@
 import { InvalidParametersError } from '@libp2p/interface';
 /**
- * Returns host/port/etc information for multiaddrs, if it is available.
- *
- * It will throw if the passed multiaddr does not start with a network address,
- * e.g. a IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR address
+ * Returns host/port/etc information for a multiaddr if it starts with a
+ * network address (IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR), or null otherwise.
  */
-export function getNetConfig(ma) {
+export function tryGetNetConfig(ma) {
     const components = ma.getComponents();
     const config = {};
     let index = 0;
@@ -13,17 +11,17 @@ export function getNetConfig(ma) {
         config.zone = `${components[index].value}`;
         index++;
     }
-    if (components[index].name === 'ip4' || components[index].name === 'ip6') {
+    if (components[index]?.name === 'ip4' || components[index]?.name === 'ip6') {
         config.type = components[index].name;
         config.host = components[index].value;
         index++;
     }
-    else if (components[index].name === 'dns' || components[index].name === 'dns4' || components[index].name === 'dns6') {
+    else if (components[index]?.name === 'dns' || components[index]?.name === 'dns4' || components[index]?.name === 'dns6') {
         config.type = components[index].name;
         config.host = components[index].value;
         index++;
     }
-    else if (components[index].name === 'dnsaddr') {
+    else if (components[index]?.name === 'dnsaddr') {
         config.type = components[index].name;
         config.host = `_dnsaddr.${components[index].value}`;
         index++;
@@ -43,7 +41,7 @@ export function getNetConfig(ma) {
         index++;
     }
     if (config.type == null || config.host == null) {
-        throw new InvalidParametersError(`Multiaddr ${ma} was not an IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR address`);
+        return null;
     }
     if (components[index]?.name === 'tls' && components[index + 1]?.name === 'sni') {
         config.sni = components[index + 1].value;
@@ -51,4 +49,15 @@ export function getNetConfig(ma) {
     }
     return config;
 }
+/**
+ * Like `tryGetNetConfig` but throws `InvalidParametersError` when the multiaddr
+ * does not start with a network address.
+ */
+export function getNetConfig(ma) {
+    const config = tryGetNetConfig(ma);
+    if (config == null) {
+        throw new InvalidParametersError(`Multiaddr ${ma} was not an IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR address`);
+    }
+    return config;
+}
 //# sourceMappingURL=get-net-config.js.map

package/dist/src/multiaddr/get-net-config.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"get-net-config.js","sourceRoot":"","sources":["../../../src/multiaddr/get-net-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAwD1D~~;;;;;GAKG~~;AACH,MAAM,UAAU,~~YAAY~~,CAAE,EAAa;~~IACzC~~,MAAM,UAAU,GAAG,EAAE,CAAC,aAAa,EAAE,CAAA;IACrC,MAAM,MAAM,GAAQ,EAAE,CAAA;IACtB,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAA;QAC1C,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,~~CAAC~~,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,~~CAAC~~,IAAI,KAAK,KAAK,EAAE,CAAC;~~QACzE~~,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CAAA;QACrC,KAAK,EAAE,CAAA;IACT,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,~~CAAC~~,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,~~CAAC~~,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,~~CAAC~~,IAAI,KAAK,MAAM,EAAE,CAAC;~~QACtH~~,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CAAA;QACrC,KAAK,EAAE,CAAA;IACT,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,~~CAAC~~,IAAI,KAAK,SAAS,EAAE,CAAC;~~QAChD~~,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,YAAY,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAA;QACnD,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;QAC3E,MAAM,CAAC,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;QAClE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;QACpD,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzC,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;QACtD,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAA;QAC5C,CAAC;QACD,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QAC/C,~~MAAM~~,IAAI,~~sBAAsB,CAAC,aAAa,EAAE,4DAA4D,CAAC,~~CAAA;~~IAC/G~~,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/E,MAAM,CAAC,GAAG,GAAG,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAA;QACxC,KAAK,IAAI,CAAC,CAAA;IACZ,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}
1	+ {"version":3,"file":"get-net-config.js","sourceRoot":"","sources":["../../../src/multiaddr/get-net-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAwD1D;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAE,EAAa;IAC5C,MAAM,UAAU,GAAG,EAAE,CAAC,aAAa,EAAE,CAAA;IACrC,MAAM,MAAM,GAAQ,EAAE,CAAA;IACtB,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAA;QAC1C,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;QAC3E,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CAAA;QACrC,KAAK,EAAE,CAAA;IACT,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;QACzH,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CAAA;QACrC,KAAK,EAAE,CAAA;IACT,CAAC;SAAM,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QACjD,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,YAAY,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAA;QACnD,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;QAC3E,MAAM,CAAC,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;QAClE,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;QACpD,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzC,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;QACtD,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAA;QAC5C,CAAC;QACD,KAAK,EAAE,CAAA;IACT,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;QAC/E,MAAM,CAAC,GAAG,GAAG,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAA;QACxC,KAAK,IAAI,CAAC,CAAA;IACZ,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAE,EAAa;IACzC,MAAM,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC,CAAA;IAElC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,sBAAsB,CAAC,aAAa,EAAE,4DAA4D,CAAC,CAAA;IAC/G,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/src/multiaddr/is-network-address.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"is-network-address.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-network-address.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,~~CAQxD~~"}
1	+ {"version":3,"file":"is-network-address.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-network-address.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAExD"}

package/dist/src/multiaddr/is-network-address.js CHANGED Viewed

@@ -1,14 +1,8 @@
-import { getNetConfig } from "./get-net-config.js";
+import { tryGetNetConfig } from "./get-net-config.js";
 /**
  * Check if a given multiaddr is a network address
  */
 export function isNetworkAddress(ma) {
-    try {
-        getNetConfig(ma);
-        return true;
-    }
-    catch {
-        return false;
-    }
+    return tryGetNetConfig(ma) !== null;
 }
 //# sourceMappingURL=is-network-address.js.map

package/dist/src/multiaddr/is-network-address.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"is-network-address.js","sourceRoot":"","sources":["../../../src/multiaddr/is-network-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,~~YAAY~~,EAAE,MAAM,qBAAqB,CAAA;~~AAGlD~~;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAE,EAAa;IAC7C,~~IAAI~~,~~CAAC;QACH~~,~~YAAY,~~CAAC,EAAE,CAAC,~~CAAA;QAEhB~~,~~OAAO,~~IAAI,CAAA;~~IACb~~,CAAC~~;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC~~"}
1	+ {"version":3,"file":"is-network-address.js","sourceRoot":"","sources":["../../../src/multiaddr/is-network-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAGrD;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAE,EAAa;IAC7C,OAAO,eAAe,CAAC,EAAE,CAAC,KAAK,IAAI,CAAA;AACrC,CAAC"}

package/dist/typedoc-urls.json ADDED Viewed

@@ -0,0 +1,125 @@
+{
+  "AbstractMessageStream": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.AbstractMessageStream.html",
+  "AbstractMultiaddrConnection": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.AbstractMultiaddrConnection.html",
+  "AbstractStream": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.AbstractStream.html",
+  "AbstractStreamMuxer": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.AbstractStreamMuxer.html",
+  "AdaptiveTimeout": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.AdaptiveTimeout.html",
+  "BloomFilter": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.BloomFilter.html",
+  "CuckooFilter": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.CuckooFilter.html",
+  "InvalidDataLengthError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.InvalidDataLengthError.html",
+  "InvalidDataLengthLengthError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.InvalidDataLengthLengthError.html",
+  "InvalidMessageLengthError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.InvalidMessageLengthError.html",
+  "LengthPrefixedDecoder": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.LengthPrefixedDecoder.html",
+  "MaxEarlyStreamsError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.MaxEarlyStreamsError.html",
+  "MemoryStorage": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.MemoryStorage.html",
+  "MockStream": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.MockStream.html",
+  "MovingAverage": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.MovingAverage.html",
+  "PeerQueue": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.PeerQueue.html",
+  "PriorityQueue": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.PriorityQueue.html",
+  "Queue": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.Queue.html",
+  "QueueFullError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.QueueFullError.html",
+  "RateLimiter": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.RateLimiter.html",
+  "RateLimitError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.RateLimitError.html",
+  "ScalableCuckooFilter": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.ScalableCuckooFilter.html",
+  "StreamClosedError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.StreamClosedError.html",
+  "UnexpectedEOFError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.UnexpectedEOFError.html",
+  "UnwrappedError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_utils.UnwrappedError.html",
+  "AbstractMultiaddrConnectionInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.AbstractMultiaddrConnectionInit.html",
+  "AbstractStreamInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.AbstractStreamInit.html",
+  "AbstractStreamMuxerInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.AbstractStreamMuxerInit.html",
+  "AdaptiveTimeoutInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.AdaptiveTimeoutInit.html",
+  "AdaptiveTimeoutSignal": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.AdaptiveTimeoutSignal.html",
+  "BloomFilterOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.BloomFilterOptions.html",
+  "Bucket": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.Bucket.html",
+  "ByteStream": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ByteStream.html",
+  "ByteStreamOpts": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ByteStreamOpts.html",
+  "Comparator": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.Comparator.html",
+  "CreateTrackedListInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.CreateTrackedListInit.html",
+  "CreateTrackedMapInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.CreateTrackedMapInit.html",
+  "CuckooFilterInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.CuckooFilterInit.html",
+  "DebouncedFunction": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.DebouncedFunction.html",
+  "DNS4NetConfig": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.DNS4NetConfig.html",
+  "DNS6NetConfig": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.DNS6NetConfig.html",
+  "DNSAddrNetConfig": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.DNSAddrNetConfig.html",
+  "DNSNetConfig": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.DNSNetConfig.html",
+  "Filter": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.Filter.html",
+  "Fingerprint": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.Fingerprint.html",
+  "GetKeySecDurationOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.GetKeySecDurationOptions.html",
+  "GetTimeoutSignalOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.GetTimeoutSignalOptions.html",
+  "Hash": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.Hash.html",
+  "IP4NetConfig": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.IP4NetConfig.html",
+  "IP6NetConfig": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.IP6NetConfig.html",
+  "Job": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.Job.html",
+  "JobMatcher": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.JobMatcher.html",
+  "JobRecipient": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.JobRecipient.html",
+  "JobTimeline": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.JobTimeline.html",
+  "LengthPrefixedDecoderInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.LengthPrefixedDecoderInit.html",
+  "LengthPrefixedStream": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.LengthPrefixedStream.html",
+  "LengthPrefixedStreamOpts": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.LengthPrefixedStreamOpts.html",
+  "MessageStreamInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.MessageStreamInit.html",
+  "MockMultiaddrConnectionInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.MockMultiaddrConnectionInit.html",
+  "MockMuxedStreamInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.MockMuxedStreamInit.html",
+  "MultiaddrConnectionPairOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.MultiaddrConnectionPairOptions.html",
+  "PeerQueueJobOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.PeerQueueJobOptions.html",
+  "PriorityQueueJobOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.PriorityQueueJobOptions.html",
+  "ProtobufDecoder": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ProtobufDecoder.html",
+  "ProtobufEncoder": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ProtobufEncoder.html",
+  "ProtobufMessageStream": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ProtobufMessageStream.html",
+  "ProtobufStream": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ProtobufStream.html",
+  "ProtobufStreamOpts": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ProtobufStreamOpts.html",
+  "QueueEvents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.QueueEvents.html",
+  "QueueInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.QueueInit.html",
+  "QueueJobFailure": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.QueueJobFailure.html",
+  "QueueJobSuccess": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.QueueJobSuccess.html",
+  "RateLimiterInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.RateLimiterInit.html",
+  "RateLimiterResult": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.RateLimiterResult.html",
+  "RateRecord": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.RateRecord.html",
+  "ReadBytesOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ReadBytesOptions.html",
+  "RepeatingTask": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.RepeatingTask.html",
+  "RepeatingTaskOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.RepeatingTaskOptions.html",
+  "RunFunction": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.RunFunction.html",
+  "ScalableCuckooFilterInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.ScalableCuckooFilterInit.html",
+  "SendResult": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.SendResult.html",
+  "StreamPairOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.StreamPairOptions.html",
+  "TrackedMapInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.TrackedMapInit.html",
+  "JobStatus": "https://libp2p.github.io/js-libp2p/types/_libp2p_utils.JobStatus.html",
+  "NetConfig": "https://libp2p.github.io/js-libp2p/types/_libp2p_utils.NetConfig.html",
+  "PipeInput": "https://libp2p.github.io/js-libp2p/types/_libp2p_utils.PipeInput.html",
+  "DEFAULT_FAILURE_MULTIPLIER": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.DEFAULT_FAILURE_MULTIPLIER.html",
+  "DEFAULT_INTERVAL": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.DEFAULT_INTERVAL.html",
+  "DEFAULT_MAX_TIMEOUT": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.DEFAULT_MAX_TIMEOUT.html",
+  "DEFAULT_MIN_TIMEOUT": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.DEFAULT_MIN_TIMEOUT.html",
+  "DEFAULT_TIMEOUT_MULTIPLIER": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.DEFAULT_TIMEOUT_MULTIPLIER.html",
+  "byteStream": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.byteStream.html",
+  "createBloomFilter": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.createBloomFilter.html",
+  "createCuckooFilter": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.createCuckooFilter.html",
+  "createScalableCuckooFilter": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.createScalableCuckooFilter.html",
+  "debounce": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.debounce.html",
+  "echo": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.echo.html",
+  "echoStream": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.echoStream.html",
+  "getNetConfig": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.getNetConfig.html",
+  "getThinWaistAddresses": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.getThinWaistAddresses.html",
+  "ipPortToMultiaddr": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.ipPortToMultiaddr.html",
+  "isAsyncGenerator": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isAsyncGenerator.html",
+  "isGenerator": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isGenerator.html",
+  "isGlobalUnicast": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isGlobalUnicast.html",
+  "isGlobalUnicastIp": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isGlobalUnicastIp.html",
+  "isLinkLocal": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isLinkLocal.html",
+  "isLinkLocalIp": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isLinkLocalIp.html",
+  "isLoopback": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isLoopback.html",
+  "isNetworkAddress": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isNetworkAddress.html",
+  "isPrivate": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isPrivate.html",
+  "isPrivateIp": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isPrivateIp.html",
+  "isPromise": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.isPromise.html",
+  "lpStream": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.lpStream.html",
+  "messageStreamToDuplex": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.messageStreamToDuplex.html",
+  "mockMuxer": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.mockMuxer.html",
+  "multiaddrConnectionPair": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddrConnectionPair.html",
+  "pbStream": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.pbStream.html",
+  "pipe": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.pipe.html",
+  "repeatingTask": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.repeatingTask.html",
+  "streamPair": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.streamPair.html",
+  "trackedList": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.trackedList.html",
+  "trackedMap": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.trackedMap.html",
+  "tryGetNetConfig": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.tryGetNetConfig.html"
+}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/utils",
-  "version": "7.0.17-fd68eecf7",
+  "version": "7.1.0",
   "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/utils#readme",
@@ -47,9 +47,9 @@
   "dependencies": {
     "@chainsafe/is-ip": "^2.1.0",
     "@chainsafe/netmask": "^2.0.0",
-    "@libp2p/crypto": "5.1.17-fd68eecf7",
-    "@libp2p/interface": "3.2.2-fd68eecf7",
-    "@libp2p/logger": "6.2.6-fd68eecf7",
+    "@libp2p/crypto": "^5.1.17",
+    "@libp2p/interface": "^3.2.2",
+    "@libp2p/logger": "^6.2.6",
     "@multiformats/multiaddr": "^13.0.1",
     "@sindresorhus/fnv1a": "^3.1.0",
     "any-signal": "^4.1.1",
@@ -71,7 +71,7 @@
     "uint8arrays": "^5.1.0"
   },
   "devDependencies": {
-    "@libp2p/peer-id": "6.0.8-fd68eecf7",
+    "@libp2p/peer-id": "^6.0.8",
     "@types/netmask": "^2.0.5",
     "aegir": "^47.0.22",
     "benchmark": "^2.1.4",

package/src/multiaddr/get-net-config.ts CHANGED Viewed

@@ -55,12 +55,10 @@ export interface DNSAddrNetConfig {
 export type NetConfig = IP4NetConfig | IP6NetConfig | DNSNetConfig | DNS4NetConfig | DNS6NetConfig | DNSAddrNetConfig
 /**
- * Returns host/port/etc information for multiaddrs, if it is available.
- *
- * It will throw if the passed multiaddr does not start with a network address,
- * e.g. a IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR address
+ * Returns host/port/etc information for a multiaddr if it starts with a
+ * network address (IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR), or null otherwise.
  */
-export function getNetConfig (ma: Multiaddr): NetConfig {
+export function tryGetNetConfig (ma: Multiaddr): NetConfig | null {
   const components = ma.getComponents()
   const config: any = {}
   let index = 0
@@ -70,15 +68,15 @@ export function getNetConfig (ma: Multiaddr): NetConfig {
     index++
   }
-  if (components[index].name === 'ip4' || components[index].name === 'ip6') {
+  if (components[index]?.name === 'ip4' || components[index]?.name === 'ip6') {
     config.type = components[index].name
     config.host = components[index].value
     index++
-  } else if (components[index].name === 'dns' || components[index].name === 'dns4' || components[index].name === 'dns6') {
+  } else if (components[index]?.name === 'dns' || components[index]?.name === 'dns4' || components[index]?.name === 'dns6') {
     config.type = components[index].name
     config.host = components[index].value
     index++
-  } else if (components[index].name === 'dnsaddr') {
+  } else if (components[index]?.name === 'dnsaddr') {
     config.type = components[index].name
     config.host = `_dnsaddr.${components[index].value}`
     index++
@@ -100,7 +98,7 @@ export function getNetConfig (ma: Multiaddr): NetConfig {
   }
   if (config.type == null || config.host == null) {
-    throw new InvalidParametersError(`Multiaddr ${ma} was not an IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR address`)
+    return null
   }
   if (components[index]?.name === 'tls' && components[index + 1]?.name === 'sni') {
@@ -110,3 +108,17 @@ export function getNetConfig (ma: Multiaddr): NetConfig {
   return config
 }
+/**
+ * Like `tryGetNetConfig` but throws `InvalidParametersError` when the multiaddr
+ * does not start with a network address.
+ */
+export function getNetConfig (ma: Multiaddr): NetConfig {
+  const config = tryGetNetConfig(ma)
+  if (config == null) {
+    throw new InvalidParametersError(`Multiaddr ${ma} was not an IPv4, IPv6, DNS, DNS4, DNS6 or DNSADDR address`)
+  }
+  return config
+}

package/src/multiaddr/is-network-address.ts CHANGED Viewed

@@ -1,15 +1,9 @@
-import { getNetConfig } from './get-net-config.ts'
+import { tryGetNetConfig } from './get-net-config.ts'
 import type { Multiaddr } from '@multiformats/multiaddr'
 /**
  * Check if a given multiaddr is a network address
  */
 export function isNetworkAddress (ma: Multiaddr): boolean {
-  try {
-    getNetConfig(ma)
-    return true
-  } catch {
-    return false
-  }
+  return tryGetNetConfig(ma) !== null
 }