@libp2p/utils 6.6.6-6c42ea64a → 6.6.6-ae595d8db

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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../src/index.ts"],
4
- "sourcesContent": ["/**\n * @packageDocumentation\n *\n * This module contains utility functions used by libp2p modules.\n */\n\nexport {}\n"],
4
+ "sourcesContent": ["/**\n * @packageDocumentation\n *\n * The libp2p ecosystem has lots of repos with it comes several problems like:\n *\n * - Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.\n * - Dependencies management - it's really easy with so many repos for dependencies to go out of control, they become outdated, different repos use different modules to do the same thing (like merging defaults options), browser bundles ends up with multiple versions of the same package, bumping versions is cumbersome to do because we need to go through several repos, etc.\n *\n * These problems are the motivation for this package, having shared logic in this package avoids creating cyclic dependencies, centralizes common use modules/functions (exactly like aegir does for the tooling), semantic versioning for 3rd party dependencies is handled in one single place (a good example is going from streams 2 to 3) and maintainers should only care about having `libp2p-utils` updated.\n *\n * @example\n *\n * Each function should be imported directly.\n *\n * ```TypeScript\n * import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'\n *\n * const ma = ipPortToMultiaddr('127.0.0.1', 9000)\n * ```\n */\n\nexport {}\n"],
5
5
  "mappings": ";qYAAA,IAAAA,EAAA",
6
6
  "names": ["index_exports"]
7
7
  }
@@ -1,7 +1,22 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * This module contains utility functions used by libp2p modules.
4
+ * The libp2p ecosystem has lots of repos with it comes several problems like:
5
+ *
6
+ * - Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.
7
+ * - Dependencies management - it's really easy with so many repos for dependencies to go out of control, they become outdated, different repos use different modules to do the same thing (like merging defaults options), browser bundles ends up with multiple versions of the same package, bumping versions is cumbersome to do because we need to go through several repos, etc.
8
+ *
9
+ * These problems are the motivation for this package, having shared logic in this package avoids creating cyclic dependencies, centralizes common use modules/functions (exactly like aegir does for the tooling), semantic versioning for 3rd party dependencies is handled in one single place (a good example is going from streams 2 to 3) and maintainers should only care about having `libp2p-utils` updated.
10
+ *
11
+ * @example
12
+ *
13
+ * Each function should be imported directly.
14
+ *
15
+ * ```TypeScript
16
+ * import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
17
+ *
18
+ * const ma = ipPortToMultiaddr('127.0.0.1', 9000)
19
+ * ```
5
20
  */
6
21
  export {};
7
22
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,CAAA"}
package/dist/src/index.js CHANGED
@@ -1,7 +1,22 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * This module contains utility functions used by libp2p modules.
4
+ * The libp2p ecosystem has lots of repos with it comes several problems like:
5
+ *
6
+ * - Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.
7
+ * - Dependencies management - it's really easy with so many repos for dependencies to go out of control, they become outdated, different repos use different modules to do the same thing (like merging defaults options), browser bundles ends up with multiple versions of the same package, bumping versions is cumbersome to do because we need to go through several repos, etc.
8
+ *
9
+ * These problems are the motivation for this package, having shared logic in this package avoids creating cyclic dependencies, centralizes common use modules/functions (exactly like aegir does for the tooling), semantic versioning for 3rd party dependencies is handled in one single place (a good example is going from streams 2 to 3) and maintainers should only care about having `libp2p-utils` updated.
10
+ *
11
+ * @example
12
+ *
13
+ * Each function should be imported directly.
14
+ *
15
+ * ```TypeScript
16
+ * import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
17
+ *
18
+ * const ma = ipPortToMultiaddr('127.0.0.1', 9000)
19
+ * ```
5
20
  */
6
21
  export {};
7
22
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"is-global-unicast.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-global-unicast.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,wBAAgB,eAAe,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAgBvD"}
1
+ {"version":3,"file":"is-global-unicast.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-global-unicast.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAIxD;;GAEG;AACH,wBAAgB,eAAe,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAgBvD"}
@@ -1,17 +1,16 @@
1
1
  import { cidrContains } from '@chainsafe/netmask';
2
- import { CODE_IP6 } from '@multiformats/multiaddr';
2
+ const CODEC_IP6 = 0x29;
3
3
  /**
4
4
  * Check if a given multiaddr is an IPv6 global unicast address
5
5
  */
6
6
  export function isGlobalUnicast(ma) {
7
7
  try {
8
- for (const { code, value } of ma.getComponents()) {
9
- if (value == null) {
10
- continue;
11
- }
12
- if (code === CODE_IP6) {
13
- return cidrContains('2000::/3', value);
14
- }
8
+ const [[codec, value]] = ma.stringTuples();
9
+ if (value == null) {
10
+ return false;
11
+ }
12
+ if (codec === CODEC_IP6) {
13
+ return cidrContains('2000::/3', value);
15
14
  }
16
15
  }
17
16
  catch {
@@ -1 +1 @@
1
- {"version":3,"file":"is-global-unicast.js","sourceRoot":"","sources":["../../../src/multiaddr/is-global-unicast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAGlD;;GAEG;AACH,MAAM,UAAU,eAAe,CAAE,EAAa;IAC5C,IAAI,CAAC;QACH,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC;YACjD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAClB,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,OAAO,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
1
+ {"version":3,"file":"is-global-unicast.js","sourceRoot":"","sources":["../../../src/multiaddr/is-global-unicast.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGjD,MAAM,SAAS,GAAG,IAAI,CAAA;AAEtB;;GAEG;AACH,MAAM,UAAU,eAAe,CAAE,EAAa;IAC5C,IAAI,CAAC;QACH,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,CAAA;QAE1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"is-ip-based.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-ip-based.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,wBAAgB,SAAS,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAcjD"}
1
+ {"version":3,"file":"is-ip-based.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-ip-based.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAKxD;;GAEG;AACH,wBAAgB,SAAS,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAUjD"}
@@ -1,15 +1,12 @@
1
- import { CODE_IP4, CODE_IP6, CODE_IP6ZONE } from '@multiformats/multiaddr';
1
+ const CODEC_IP4 = 0x04;
2
+ const CODEC_IP6 = 0x29;
2
3
  /**
3
4
  * Check if a given multiaddr is IP-based
4
5
  */
5
6
  export function isIpBased(ma) {
6
7
  try {
7
- for (const { code } of ma.getComponents()) {
8
- if (code === CODE_IP6ZONE) {
9
- continue;
10
- }
11
- return code === CODE_IP4 || code === CODE_IP6;
12
- }
8
+ const [[codec]] = ma.stringTuples();
9
+ return codec === CODEC_IP4 || codec === CODEC_IP6;
13
10
  }
14
11
  catch {
15
12
  }
@@ -1 +1 @@
1
- {"version":3,"file":"is-ip-based.js","sourceRoot":"","sources":["../../../src/multiaddr/is-ip-based.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAG1E;;GAEG;AACH,MAAM,UAAU,SAAS,CAAE,EAAa;IACtC,IAAI,CAAC;QACH,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC;YAC1C,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC1B,SAAQ;YACV,CAAC;YAED,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ,CAAA;QAC/C,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
1
+ {"version":3,"file":"is-ip-based.js","sourceRoot":"","sources":["../../../src/multiaddr/is-ip-based.ts"],"names":[],"mappings":"AAEA,MAAM,SAAS,GAAG,IAAI,CAAA;AACtB,MAAM,SAAS,GAAG,IAAI,CAAA;AAEtB;;GAEG;AACH,MAAM,UAAU,SAAS,CAAE,EAAa;IACtC,IAAI,CAAC;QACH,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,CAAA;QAEnC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,CAAA;IACnD,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"is-link-local.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-link-local.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,wBAAgB,WAAW,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAwBnD"}
1
+ {"version":3,"file":"is-link-local.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-link-local.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAKxD;;GAEG;AACH,wBAAgB,WAAW,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAoBnD"}
@@ -1,22 +1,19 @@
1
- import { CODE_IP4, CODE_IP6, CODE_IP6ZONE } from '@multiformats/multiaddr';
1
+ const CODEC_IP4 = 0x04;
2
+ const CODEC_IP6 = 0x29;
2
3
  /**
3
4
  * Check if a given multiaddr is a link-local address
4
5
  */
5
6
  export function isLinkLocal(ma) {
6
7
  try {
7
- for (const { code, value } of ma.getComponents()) {
8
- if (code === CODE_IP6ZONE) {
9
- continue;
10
- }
11
- if (value == null) {
12
- continue;
13
- }
14
- if (code === CODE_IP4) {
15
- return value.startsWith('169.254.');
16
- }
17
- if (code === CODE_IP6) {
18
- return value.toLowerCase().startsWith('fe80');
19
- }
8
+ const [[codec, value]] = ma.stringTuples();
9
+ if (value == null) {
10
+ return false;
11
+ }
12
+ if (codec === CODEC_IP4) {
13
+ return value.startsWith('169.254.');
14
+ }
15
+ if (codec === CODEC_IP6) {
16
+ return value.toLowerCase().startsWith('fe80');
20
17
  }
21
18
  }
22
19
  catch {
@@ -1 +1 @@
1
- {"version":3,"file":"is-link-local.js","sourceRoot":"","sources":["../../../src/multiaddr/is-link-local.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAG1E;;GAEG;AACH,MAAM,UAAU,WAAW,CAAE,EAAa;IACxC,IAAI,CAAC;QACH,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC;YACjD,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC1B,SAAQ;YACV,CAAC;YAED,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBAClB,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,OAAO,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;YACrC,CAAC;YAED,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
1
+ {"version":3,"file":"is-link-local.js","sourceRoot":"","sources":["../../../src/multiaddr/is-link-local.ts"],"names":[],"mappings":"AAEA,MAAM,SAAS,GAAG,IAAI,CAAA;AACtB,MAAM,SAAS,GAAG,IAAI,CAAA;AAEtB;;GAEG;AACH,MAAM,UAAU,WAAW,CAAE,EAAa;IACxC,IAAI,CAAC;QACH,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,CAAA;QAE1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;QACrC,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
@@ -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;AAWxD;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAcxD"}
1
+ {"version":3,"file":"is-network-address.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-network-address.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAkBxD;;GAEG;AACH,wBAAgB,gBAAgB,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAUxD"}
@@ -1,23 +1,24 @@
1
- import { CODE_IP4, CODE_IP6, CODE_IP6ZONE, CODE_DNS, CODE_DNS4, CODE_DNS6, CODE_DNSADDR } from '@multiformats/multiaddr';
1
+ const CODEC_IP4 = 0x04;
2
+ const CODEC_IP6 = 0x29;
3
+ const CODEC_DNS = 0x35;
4
+ const CODEC_DNS4 = 0x36;
5
+ const CODEC_DNS6 = 0x37;
6
+ const CODEC_DNSADDR = 0x38;
2
7
  const NETWORK_CODECS = [
3
- CODE_IP4,
4
- CODE_IP6,
5
- CODE_DNS,
6
- CODE_DNS4,
7
- CODE_DNS6,
8
- CODE_DNSADDR
8
+ CODEC_IP4,
9
+ CODEC_IP6,
10
+ CODEC_DNS,
11
+ CODEC_DNS4,
12
+ CODEC_DNS6,
13
+ CODEC_DNSADDR
9
14
  ];
10
15
  /**
11
16
  * Check if a given multiaddr is a network address
12
17
  */
13
18
  export function isNetworkAddress(ma) {
14
19
  try {
15
- for (const { code } of ma.getComponents()) {
16
- if (code === CODE_IP6ZONE) {
17
- continue;
18
- }
19
- return NETWORK_CODECS.includes(code);
20
- }
20
+ const [[codec]] = ma.stringTuples();
21
+ return NETWORK_CODECS.includes(codec);
21
22
  }
22
23
  catch {
23
24
  }
@@ -1 +1 @@
1
- {"version":3,"file":"is-network-address.js","sourceRoot":"","sources":["../../../src/multiaddr/is-network-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAGxH,MAAM,cAAc,GAAG;IACrB,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,SAAS;IACT,YAAY;CACb,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAE,EAAa;IAC7C,IAAI,CAAC;QACH,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC;YAC1C,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC1B,SAAQ;YACV,CAAC;YAED,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACtC,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
1
+ {"version":3,"file":"is-network-address.js","sourceRoot":"","sources":["../../../src/multiaddr/is-network-address.ts"],"names":[],"mappings":"AAEA,MAAM,SAAS,GAAG,IAAI,CAAA;AACtB,MAAM,SAAS,GAAG,IAAI,CAAA;AACtB,MAAM,SAAS,GAAG,IAAI,CAAA;AACtB,MAAM,UAAU,GAAG,IAAI,CAAA;AACvB,MAAM,UAAU,GAAG,IAAI,CAAA;AACvB,MAAM,aAAa,GAAG,IAAI,CAAA;AAE1B,MAAM,cAAc,GAAG;IACrB,SAAS;IACT,SAAS;IACT,SAAS;IACT,UAAU;IACV,UAAU;IACV,aAAa;CACd,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAE,EAAa;IAC7C,IAAI,CAAC;QACH,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,YAAY,EAAE,CAAA;QAEnC,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"private-ip.d.ts","sourceRoot":"","sources":["../../src/private-ip.ts"],"names":[],"mappings":"AA0FA,wBAAgB,WAAW,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAgB5D"}
1
+ {"version":3,"file":"private-ip.d.ts","sourceRoot":"","sources":["../../src/private-ip.ts"],"names":[],"mappings":"AA0FA,wBAAgB,WAAW,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAE5D"}
@@ -79,14 +79,17 @@ export function isPrivateIp(ip) {
79
79
  if (isIPv4(ip)) {
80
80
  return ipv4Check(ip);
81
81
  }
82
- if (isIpv4MappedIpv6(ip)) {
82
+ else if (isIpv4MappedIpv6(ip)) {
83
83
  return ipv4MappedIpv6Check(ip);
84
84
  }
85
- if (isIpv4EmbeddedIpv6(ip)) {
85
+ else if (isIpv4EmbeddedIpv6(ip)) {
86
86
  return ipv4EmbeddedIpv6Check(ip);
87
87
  }
88
- if (isIPv6(ip)) {
88
+ else if (isIPv6(ip)) {
89
89
  return ipv6Check(ip);
90
90
  }
91
+ else {
92
+ return undefined;
93
+ }
91
94
  }
92
95
  //# sourceMappingURL=private-ip.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"private-ip.js","sourceRoot":"","sources":["../../src/private-ip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEjC,MAAM,iBAAiB,GAAG;IACxB,WAAW;IACX,YAAY;IACZ,eAAe;IACf,aAAa;IACb,gBAAgB;IAChB,eAAe;IACf,cAAc;IACd,cAAc;IACd,cAAc;IACd,cAAc;IACd,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,cAAc;IACd,iBAAiB;IACjB,iBAAiB;IACjB,gBAAgB;IAChB,gBAAgB;IAChB,iBAAiB;IACjB,eAAe;IACf,iBAAiB;IACjB,gBAAgB;IAChB,aAAa;IACb,oBAAoB;CACrB,CAAA;AAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;AAE7E,SAAS,SAAS,CAAE,MAAc;IAChC,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE,CAAC;QAC/B,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAAC,OAAO,IAAI,CAAA;QAAC,CAAC;IACzC,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,gBAAgB,CAAE,MAAc;IACvC,OAAO,gDAAgD,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACtE,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAAE,MAAc;IAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE/B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACxD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAExD,MAAM,GAAG,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAA;IAE3K,OAAO,SAAS,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAE,MAAc;IACzC,OAAO,iEAAiE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACvF,CAAC;AAED,SAAS,qBAAqB,CAAE,MAAc;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAEnC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AAED,SAAS,SAAS,CAAE,MAAc;IAChC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;QACpB,mEAAmE,CAAC,IAAI,CAAC,MAAM,CAAC;QAChF,uFAAuF,CAAC,IAAI,CAAC,MAAM,CAAC;QACpG,gIAAgI,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7I,4IAA4I,CAAC,IAAI,CAAC,MAAM,CAAC;QACzJ,mIAAmI,CAAC,IAAI,CAAC,MAAM,CAAC;QAChJ,mJAAmJ,CAAC,IAAI,CAAC,MAAM,CAAC;QAChK,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1C,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1C,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAC1C,CAAC;AAED,MAAM,UAAU,WAAW,CAAE,EAAU;IACrC,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;QACf,OAAO,SAAS,CAAC,EAAE,CAAC,CAAA;IACtB,CAAC;IAED,IAAI,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC;QACzB,OAAO,mBAAmB,CAAC,EAAE,CAAC,CAAA;IAChC,CAAC;IAED,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3B,OAAO,qBAAqB,CAAC,EAAE,CAAC,CAAA;IAClC,CAAC;IAED,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;QACf,OAAO,SAAS,CAAC,EAAE,CAAC,CAAA;IACtB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"private-ip.js","sourceRoot":"","sources":["../../src/private-ip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEjC,MAAM,iBAAiB,GAAG;IACxB,WAAW;IACX,YAAY;IACZ,eAAe;IACf,aAAa;IACb,gBAAgB;IAChB,eAAe;IACf,cAAc;IACd,cAAc;IACd,cAAc;IACd,cAAc;IACd,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,cAAc;IACd,iBAAiB;IACjB,iBAAiB;IACjB,gBAAgB;IAChB,gBAAgB;IAChB,iBAAiB;IACjB,eAAe;IACf,iBAAiB;IACjB,gBAAgB;IAChB,aAAa;IACb,oBAAoB;CACrB,CAAA;AAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;AAE7E,SAAS,SAAS,CAAE,MAAc;IAChC,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE,CAAC;QAC/B,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAAC,OAAO,IAAI,CAAA;QAAC,CAAC;IACzC,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,gBAAgB,CAAE,MAAc;IACvC,OAAO,gDAAgD,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACtE,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAAE,MAAc;IAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE/B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IACxD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAExD,MAAM,GAAG,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAA;IAE3K,OAAO,SAAS,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAE,MAAc;IACzC,OAAO,iEAAiE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACvF,CAAC;AAED,SAAS,qBAAqB,CAAE,MAAc;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC/B,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAEnC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAA;AACvB,CAAC;AAED,SAAS,SAAS,CAAE,MAAc;IAChC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;QACpB,mEAAmE,CAAC,IAAI,CAAC,MAAM,CAAC;QAChF,uFAAuF,CAAC,IAAI,CAAC,MAAM,CAAC;QACpG,gIAAgI,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7I,4IAA4I,CAAC,IAAI,CAAC,MAAM,CAAC;QACzJ,mIAAmI,CAAC,IAAI,CAAC,MAAM,CAAC;QAChJ,mJAAmJ,CAAC,IAAI,CAAC,MAAM,CAAC;QAChK,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1C,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC;QAC1C,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAC1C,CAAC;AAED,MAAM,UAAU,WAAW,CAAE,EAAU;IACrC,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;QAAC,OAAO,SAAS,CAAC,EAAE,CAAC,CAAA;IAAC,CAAC;SAAM,IAAI,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC;QAAC,OAAO,mBAAmB,CAAC,EAAE,CAAC,CAAA;IAAC,CAAC;SAAM,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;QAAC,OAAO,qBAAqB,CAAC,EAAE,CAAC,CAAA;IAAC,CAAC;SAAM,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;QAAC,OAAO,SAAS,CAAC,EAAE,CAAC,CAAA;IAAC,CAAC;SAAM,CAAC;QAAC,OAAO,SAAS,CAAA;IAAC,CAAC;AAC1P,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/utils",
3
- "version": "6.6.6-6c42ea64a",
3
+ "version": "6.6.6-ae595d8db",
4
4
  "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/utils#readme",
@@ -191,10 +191,10 @@
191
191
  "dependencies": {
192
192
  "@chainsafe/is-ip": "^2.1.0",
193
193
  "@chainsafe/netmask": "^2.0.0",
194
- "@libp2p/crypto": "5.1.5-6c42ea64a",
195
- "@libp2p/interface": "2.10.3-6c42ea64a",
196
- "@libp2p/logger": "5.1.19-6c42ea64a",
197
- "@multiformats/multiaddr": "^12.4.4",
194
+ "@libp2p/crypto": "5.1.5-ae595d8db",
195
+ "@libp2p/interface": "2.10.3-ae595d8db",
196
+ "@libp2p/logger": "5.1.19-ae595d8db",
197
+ "@multiformats/multiaddr": "^12.4.0",
198
198
  "@sindresorhus/fnv1a": "^3.1.0",
199
199
  "any-signal": "^4.1.1",
200
200
  "delay": "^6.0.0",
@@ -214,7 +214,7 @@
214
214
  "uint8arrays": "^5.1.0"
215
215
  },
216
216
  "devDependencies": {
217
- "@libp2p/peer-id": "5.1.6-6c42ea64a",
217
+ "@libp2p/peer-id": "5.1.6-ae595d8db",
218
218
  "@types/netmask": "^2.0.5",
219
219
  "aegir": "^47.0.14",
220
220
  "benchmark": "^2.1.4",
package/src/index.ts CHANGED
@@ -1,7 +1,22 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * This module contains utility functions used by libp2p modules.
4
+ * The libp2p ecosystem has lots of repos with it comes several problems like:
5
+ *
6
+ * - Domain logic dedupe - all modules shared a lot of logic like validation, streams handling, etc.
7
+ * - Dependencies management - it's really easy with so many repos for dependencies to go out of control, they become outdated, different repos use different modules to do the same thing (like merging defaults options), browser bundles ends up with multiple versions of the same package, bumping versions is cumbersome to do because we need to go through several repos, etc.
8
+ *
9
+ * These problems are the motivation for this package, having shared logic in this package avoids creating cyclic dependencies, centralizes common use modules/functions (exactly like aegir does for the tooling), semantic versioning for 3rd party dependencies is handled in one single place (a good example is going from streams 2 to 3) and maintainers should only care about having `libp2p-utils` updated.
10
+ *
11
+ * @example
12
+ *
13
+ * Each function should be imported directly.
14
+ *
15
+ * ```TypeScript
16
+ * import { ipPortToMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
17
+ *
18
+ * const ma = ipPortToMultiaddr('127.0.0.1', 9000)
19
+ * ```
5
20
  */
6
21
 
7
22
  export {}
@@ -1,20 +1,21 @@
1
1
  import { cidrContains } from '@chainsafe/netmask'
2
- import { CODE_IP6 } from '@multiformats/multiaddr'
3
2
  import type { Multiaddr } from '@multiformats/multiaddr'
4
3
 
4
+ const CODEC_IP6 = 0x29
5
+
5
6
  /**
6
7
  * Check if a given multiaddr is an IPv6 global unicast address
7
8
  */
8
9
  export function isGlobalUnicast (ma: Multiaddr): boolean {
9
10
  try {
10
- for (const { code, value } of ma.getComponents()) {
11
- if (value == null) {
12
- continue
13
- }
11
+ const [[codec, value]] = ma.stringTuples()
12
+
13
+ if (value == null) {
14
+ return false
15
+ }
14
16
 
15
- if (code === CODE_IP6) {
16
- return cidrContains('2000::/3', value)
17
- }
17
+ if (codec === CODEC_IP6) {
18
+ return cidrContains('2000::/3', value)
18
19
  }
19
20
  } catch {
20
21
 
@@ -1,18 +1,16 @@
1
- import { CODE_IP4, CODE_IP6, CODE_IP6ZONE } from '@multiformats/multiaddr'
2
1
  import type { Multiaddr } from '@multiformats/multiaddr'
3
2
 
3
+ const CODEC_IP4 = 0x04
4
+ const CODEC_IP6 = 0x29
5
+
4
6
  /**
5
7
  * Check if a given multiaddr is IP-based
6
8
  */
7
9
  export function isIpBased (ma: Multiaddr): boolean {
8
10
  try {
9
- for (const { code } of ma.getComponents()) {
10
- if (code === CODE_IP6ZONE) {
11
- continue
12
- }
11
+ const [[codec]] = ma.stringTuples()
13
12
 
14
- return code === CODE_IP4 || code === CODE_IP6
15
- }
13
+ return codec === CODEC_IP4 || codec === CODEC_IP6
16
14
  } catch {
17
15
 
18
16
  }
@@ -1,27 +1,25 @@
1
- import { CODE_IP4, CODE_IP6, CODE_IP6ZONE } from '@multiformats/multiaddr'
2
1
  import type { Multiaddr } from '@multiformats/multiaddr'
3
2
 
3
+ const CODEC_IP4 = 0x04
4
+ const CODEC_IP6 = 0x29
5
+
4
6
  /**
5
7
  * Check if a given multiaddr is a link-local address
6
8
  */
7
9
  export function isLinkLocal (ma: Multiaddr): boolean {
8
10
  try {
9
- for (const { code, value } of ma.getComponents()) {
10
- if (code === CODE_IP6ZONE) {
11
- continue
12
- }
11
+ const [[codec, value]] = ma.stringTuples()
13
12
 
14
- if (value == null) {
15
- continue
16
- }
13
+ if (value == null) {
14
+ return false
15
+ }
17
16
 
18
- if (code === CODE_IP4) {
19
- return value.startsWith('169.254.')
20
- }
17
+ if (codec === CODEC_IP4) {
18
+ return value.startsWith('169.254.')
19
+ }
21
20
 
22
- if (code === CODE_IP6) {
23
- return value.toLowerCase().startsWith('fe80')
24
- }
21
+ if (codec === CODEC_IP6) {
22
+ return value.toLowerCase().startsWith('fe80')
25
23
  }
26
24
  } catch {
27
25
 
@@ -1,13 +1,19 @@
1
- import { CODE_IP4, CODE_IP6, CODE_IP6ZONE, CODE_DNS, CODE_DNS4, CODE_DNS6, CODE_DNSADDR } from '@multiformats/multiaddr'
2
1
  import type { Multiaddr } from '@multiformats/multiaddr'
3
2
 
3
+ const CODEC_IP4 = 0x04
4
+ const CODEC_IP6 = 0x29
5
+ const CODEC_DNS = 0x35
6
+ const CODEC_DNS4 = 0x36
7
+ const CODEC_DNS6 = 0x37
8
+ const CODEC_DNSADDR = 0x38
9
+
4
10
  const NETWORK_CODECS = [
5
- CODE_IP4,
6
- CODE_IP6,
7
- CODE_DNS,
8
- CODE_DNS4,
9
- CODE_DNS6,
10
- CODE_DNSADDR
11
+ CODEC_IP4,
12
+ CODEC_IP6,
13
+ CODEC_DNS,
14
+ CODEC_DNS4,
15
+ CODEC_DNS6,
16
+ CODEC_DNSADDR
11
17
  ]
12
18
 
13
19
  /**
@@ -15,13 +21,9 @@ const NETWORK_CODECS = [
15
21
  */
16
22
  export function isNetworkAddress (ma: Multiaddr): boolean {
17
23
  try {
18
- for (const { code } of ma.getComponents()) {
19
- if (code === CODE_IP6ZONE) {
20
- continue
21
- }
24
+ const [[codec]] = ma.stringTuples()
22
25
 
23
- return NETWORK_CODECS.includes(code)
24
- }
26
+ return NETWORK_CODECS.includes(codec)
25
27
  } catch {
26
28
 
27
29
  }
package/src/private-ip.ts CHANGED
@@ -89,19 +89,5 @@ function ipv6Check (ipAddr: string): boolean {
89
89
  }
90
90
 
91
91
  export function isPrivateIp (ip: string): boolean | undefined {
92
- if (isIPv4(ip)) {
93
- return ipv4Check(ip)
94
- }
95
-
96
- if (isIpv4MappedIpv6(ip)) {
97
- return ipv4MappedIpv6Check(ip)
98
- }
99
-
100
- if (isIpv4EmbeddedIpv6(ip)) {
101
- return ipv4EmbeddedIpv6Check(ip)
102
- }
103
-
104
- if (isIPv6(ip)) {
105
- return ipv6Check(ip)
106
- }
92
+ if (isIPv4(ip)) { return ipv4Check(ip) } else if (isIpv4MappedIpv6(ip)) { return ipv4MappedIpv6Check(ip) } else if (isIpv4EmbeddedIpv6(ip)) { return ipv4EmbeddedIpv6Check(ip) } else if (isIPv6(ip)) { return ipv6Check(ip) } else { return undefined }
107
93
  }