@libp2p/utils 4.0.2 → 4.0.3

package/dist/src/address-sort.d.ts

@@ -21,13 +21,19 @@
  */
 import type { Address } from '@libp2p/interface/peer-store';
 /**
- * Compare function for array.sort().
- * This sort aims to move the private addresses to the end of the array.
- * In case of equality, a certified address will come first.
+ * Compare function for array.sort() that moves public addresses to the start
+ * of the array.
  */
 export declare function publicAddressesFirst(a: Address, b: Address): -1 | 0 | 1;
 /**
- * A test thing
+ * Compare function for array.sort() that moves certified addresses to the start
+ * of the array.
  */
-export declare function something(): Promise<Uint8Array>;
+export declare function certifiedAddressesFirst(a: Address, b: Address): -1 | 0 | 1;
+/**
+ * Compare function for array.sort() that moves circuit relay addresses to the
+ * start of the array.
+ */
+export declare function circuitRelayAddressesLast(a: Address, b: Address): -1 | 0 | 1;
+export declare function defaultAddressSort(a: Address, b: Address): -1 | 0 | 1;
 //# sourceMappingURL=address-sort.d.ts.map

package/dist/src/address-sort.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"address-sort.d.ts","sourceRoot":"","sources":["../../src/address-sort.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAE3D;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAiBxE;AAED;;GAEG;AACH,wBAAsB,SAAS,IAAK,OAAO,CAAC,UAAU,CAAC,CAEtD"}
+{"version":3,"file":"address-sort.d.ts","sourceRoot":"","sources":["../../src/address-sort.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAIH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAA;AAE3D;;;GAGG;AACH,wBAAgB,oBAAoB,CAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAWxE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAQ3E;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAW7E;AAED,wBAAgB,kBAAkB,CAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAgBtE"}

package/dist/src/address-sort.js

@@ -19,11 +19,11 @@
  * // ['/ip4/82.41.53.1/tcp/9000', '/ip4/127.0.0.1/tcp/9000']
  * ```
  */
+import { Circuit } from '@multiformats/multiaddr-matcher';
 import { isPrivate } from './multiaddr/is-private.js';
 /**
- * Compare function for array.sort().
- * This sort aims to move the private addresses to the end of the array.
- * In case of equality, a certified address will come first.
+ * Compare function for array.sort() that moves public addresses to the start
+ * of the array.
  */
 export function publicAddressesFirst(a, b) {
     const isAPrivate = isPrivate(a.multiaddr);
@@ -34,7 +34,13 @@ export function publicAddressesFirst(a, b) {
     else if (!isAPrivate && isBPrivate) {
         return -1;
     }
-    // Check certified?
+    return 0;
+}
+/**
+ * Compare function for array.sort() that moves certified addresses to the start
+ * of the array.
+ */
+export function certifiedAddressesFirst(a, b) {
     if (a.isCertified && !b.isCertified) {
         return -1;
     }
@@ -44,9 +50,30 @@ export function publicAddressesFirst(a, b) {
     return 0;
 }
 /**
- * A test thing
+ * Compare function for array.sort() that moves circuit relay addresses to the
+ * start of the array.
  */
-export async function something() {
-    return Uint8Array.from([0, 1, 2]);
+export function circuitRelayAddressesLast(a, b) {
+    const isACircuit = Circuit.exactMatch(a.multiaddr);
+    const isBCircuit = Circuit.exactMatch(b.multiaddr);
+    if (isACircuit && !isBCircuit) {
+        return 1;
+    }
+    else if (!isACircuit && isBCircuit) {
+        return -1;
+    }
+    return 0;
+}
+export function defaultAddressSort(a, b) {
+    const publicResult = publicAddressesFirst(a, b);
+    if (publicResult !== 0) {
+        return publicResult;
+    }
+    const relayResult = circuitRelayAddressesLast(a, b);
+    if (relayResult !== 0) {
+        return relayResult;
+    }
+    const certifiedResult = certifiedAddressesFirst(a, b);
+    return certifiedResult;
 }
 //# sourceMappingURL=address-sort.js.map

package/dist/src/address-sort.js.map

@@ -1 +1 @@
-{"version":3,"file":"address-sort.js","sourceRoot":"","sources":["../../src/address-sort.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAGrD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAE,CAAU,EAAE,CAAU;IAC1D,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IACzC,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEzC,IAAI,UAAU,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,CAAC,CAAA;KACT;SAAM,IAAI,CAAC,UAAU,IAAI,UAAU,EAAE;QACpC,OAAO,CAAC,CAAC,CAAA;KACV;IACD,mBAAmB;IACnB,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE;QACnC,OAAO,CAAC,CAAC,CAAA;KACV;SAAM,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,EAAE;QAC1C,OAAO,CAAC,CAAA;KACT;IAED,OAAO,CAAC,CAAA;AACV,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS;IAC7B,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AACnC,CAAC"}
+{"version":3,"file":"address-sort.js","sourceRoot":"","sources":["../../src/address-sort.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAA;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAGrD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAE,CAAU,EAAE,CAAU;IAC1D,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IACzC,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAEzC,IAAI,UAAU,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,CAAC,CAAA;KACT;SAAM,IAAI,CAAC,UAAU,IAAI,UAAU,EAAE;QACpC,OAAO,CAAC,CAAC,CAAA;KACV;IAED,OAAO,CAAC,CAAA;AACV,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAE,CAAU,EAAE,CAAU;IAC7D,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE;QACnC,OAAO,CAAC,CAAC,CAAA;KACV;SAAM,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,EAAE;QAC1C,OAAO,CAAC,CAAA;KACT;IAED,OAAO,CAAC,CAAA;AACV,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAE,CAAU,EAAE,CAAU;IAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAClD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAElD,IAAI,UAAU,IAAI,CAAC,UAAU,EAAE;QAC7B,OAAO,CAAC,CAAA;KACT;SAAM,IAAI,CAAC,UAAU,IAAI,UAAU,EAAE;QACpC,OAAO,CAAC,CAAC,CAAA;KACV;IAED,OAAO,CAAC,CAAA;AACV,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAE,CAAU,EAAE,CAAU;IACxD,MAAM,YAAY,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAE/C,IAAI,YAAY,KAAK,CAAC,EAAE;QACtB,OAAO,YAAY,CAAA;KACpB;IAED,MAAM,WAAW,GAAG,yBAAyB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAEnD,IAAI,WAAW,KAAK,CAAC,EAAE;QACrB,OAAO,WAAW,CAAA;KACnB;IAED,MAAM,eAAe,GAAG,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAErD,OAAO,eAAe,CAAA;AACxB,CAAC"}

package/dist/typedoc-urls.json

@@ -1,11 +1,24 @@
 {
+  "certifiedAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html",
+  "./address-sort:certifiedAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.certifiedAddressesFirst.html",
+  "circuitRelayAddressesLast": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html",
+  "./address-sort:circuitRelayAddressesLast": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.circuitRelayAddressesLast.html",
+  "defaultAddressSort": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.defaultAddressSort.html",
+  "./address-sort:defaultAddressSort": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.defaultAddressSort.html",
   "publicAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.publicAddressesFirst.html",
-  "something": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.something.html",
+  "./address-sort:publicAddressesFirst": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.address_sort.publicAddressesFirst.html",
   "arrayEquals": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.array_equals.arrayEquals.html",
+  "./array-equals:arrayEquals": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.array_equals.arrayEquals.html",
   "Errors": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html",
+  "./ip-port-to-multiaddr:Errors": "https://libp2p.github.io/js-libp2p/variables/_libp2p_utils.ip_port_to_multiaddr.Errors.html",
   "ipPortToMultiaddr": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html",
+  "./ip-port-to-multiaddr:ipPortToMultiaddr": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.ip_port_to_multiaddr.ipPortToMultiaddr.html",
   "isLoopback": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html",
+  "./multiaddr/is-loopback:isLoopback": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_loopback.isLoopback.html",
   "isPrivate": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html",
+  "./multiaddr/is-private:isPrivate": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.multiaddr_is_private.isPrivate.html",
   "StreamProperties": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html",
-  "streamToMaConnection": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html"
+  "./stream-to-ma-conn:StreamProperties": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_utils.stream_to_ma_conn.StreamProperties.html",
+  "streamToMaConnection": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html",
+  "./stream-to-ma-conn:streamToMaConnection": "https://libp2p.github.io/js-libp2p/functions/_libp2p_utils.stream_to_ma_conn.streamToMaConnection.html"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/utils",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "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/master/packages/utils#readme",
@@ -89,6 +89,7 @@
     "@libp2p/interface": "^0.1.2",
     "@libp2p/logger": "^3.0.2",
     "@multiformats/multiaddr": "^12.1.5",
+    "@multiformats/multiaddr-matcher": "^1.0.1",
     "is-loopback-addr": "^2.0.1",
     "it-stream-types": "^2.0.1",
     "private-ip": "^3.0.0",

package/src/address-sort.ts

@@ -20,13 +20,13 @@
  * ```
  */
 
+import { Circuit } from '@multiformats/multiaddr-matcher'
 import { isPrivate } from './multiaddr/is-private.js'
 import type { Address } from '@libp2p/interface/peer-store'
 
 /**
- * Compare function for array.sort().
- * This sort aims to move the private addresses to the end of the array.
- * In case of equality, a certified address will come first.
+ * Compare function for array.sort() that moves public addresses to the start
+ * of the array.
  */
 export function publicAddressesFirst (a: Address, b: Address): -1 | 0 | 1 {
   const isAPrivate = isPrivate(a.multiaddr)
@@ -37,7 +37,15 @@ export function publicAddressesFirst (a: Address, b: Address): -1 | 0 | 1 {
   } else if (!isAPrivate && isBPrivate) {
     return -1
   }
-  // Check certified?
+
+  return 0
+}
+
+/**
+ * Compare function for array.sort() that moves certified addresses to the start
+ * of the array.
+ */
+export function certifiedAddressesFirst (a: Address, b: Address): -1 | 0 | 1 {
   if (a.isCertified && !b.isCertified) {
     return -1
   } else if (!a.isCertified && b.isCertified) {
@@ -48,8 +56,36 @@ export function publicAddressesFirst (a: Address, b: Address): -1 | 0 | 1 {
 }
 
 /**
- * A test thing
+ * Compare function for array.sort() that moves circuit relay addresses to the
+ * start of the array.
  */
-export async function something (): Promise<Uint8Array> {
-  return Uint8Array.from([0, 1, 2])
+export function circuitRelayAddressesLast (a: Address, b: Address): -1 | 0 | 1 {
+  const isACircuit = Circuit.exactMatch(a.multiaddr)
+  const isBCircuit = Circuit.exactMatch(b.multiaddr)
+
+  if (isACircuit && !isBCircuit) {
+    return 1
+  } else if (!isACircuit && isBCircuit) {
+    return -1
+  }
+
+  return 0
+}
+
+export function defaultAddressSort (a: Address, b: Address): -1 | 0 | 1 {
+  const publicResult = publicAddressesFirst(a, b)
+
+  if (publicResult !== 0) {
+    return publicResult
+  }
+
+  const relayResult = circuitRelayAddressesLast(a, b)
+
+  if (relayResult !== 0) {
+    return relayResult
+  }
+
+  const certifiedResult = certifiedAddressesFirst(a, b)
+
+  return certifiedResult
 }