feat: custom dialer addr sorter

Author: vasco-santos

doc/CONFIGURATION.md

@@ -498,6 +498,7 @@ Dialing in libp2p can be configured to limit the rate of dialing, and how long d
 | maxDialsPerPeer | `number` | How many multiaddrs we can dial per peer, in parallel. |
 | dialTimeout | `number` | Second dial timeout per peer in ms. |
 | resolvers | `object` | Dial [Resolvers](https://github.com/multiformats/js-multiaddr/blob/master/src/resolvers/index.js) for resolving multiaddrs |
+| addressSorter | `(Array<Address>) => Array<Address>` | Sort the known addresses of a peer before trying to dial. |
 
 The below configuration example shows how the dialer should be configured, with the current defaults:
 
@@ -508,6 +509,7 @@ const MPLEX = require('libp2p-mplex')
 const { NOISE } = require('libp2p-noise')
 
 const { dnsaddrResolver } = require('multiaddr/src/resolvers')
+const { sortPublicAddressesFirst } = require('libp2p/src/dialer/utils')
 
 const node = await Libp2p.create({
   modules: {
@@ -521,7 +523,8 @@ const node = await Libp2p.create({
     dialTimeout: 30e3,
     resolvers: {
       dnsaddr: dnsaddrResolver
-    }
+    },
+    addressSorter: sortPublicAddressesFirst
   }
 ```
 

src/circuit/auto-relay.js

@@ -4,8 +4,6 @@ const debug = require('debug')
 const log = debug('libp2p:auto-relay')
 log.error = debug('libp2p:auto-relay:error')
 
-const isPrivate = require('libp2p-utils/src/multiaddr/is-private')
-
 const uint8ArrayFromString = require('uint8arrays/from-string')
 const uint8ArrayToString = require('uint8arrays/to-string')
 const multiaddr = require('multiaddr')
@@ -36,6 +34,7 @@ class AutoRelay {
     this._peerStore = libp2p.peerStore
     this._connectionManager = libp2p.connectionManager
     this._transportManager = libp2p.transportManager
+    this._addressSorter = libp2p.dialer.addressSorter
 
     this.maxListeners = maxListeners
 
@@ -134,12 +133,14 @@ class AutoRelay {
 
     try {
       // Get peer known addresses and sort them per public addresses first
-      remoteAddrs = this._peerStore.addressBook.get(connection.remotePeer)
-      // TODO: This sort should be customizable in the config (dialer addr sort)
-      remoteAddrs.sort(multiaddrsCompareFunction)
+      // Sorting addresses to public first
+      remoteAddrs = this._addressSorter(
+        this._peerStore.addressBook.get(connection.remotePeer) || []
+      )
 
       remoteMultiaddr = remoteAddrs.find(a => a.isCertified).multiaddr // Get first announced address certified
       // TODO: HOP Relays should avoid advertising private addresses!
+      // TODO ^: Log error if happens? with Example PR
     } catch (_) {
       log.error(`${id} does not have announced certified multiaddrs`)
 
@@ -269,24 +270,4 @@ class AutoRelay {
   }
 }
 
-/**
- * Compare function for array.sort().
- * This sort aims to move the private adresses to the end of the array.
- *
- * @param {Address} a
- * @param {Address} b
- * @returns {number}
- */
-function multiaddrsCompareFunction (a, b) {
-  const isAPrivate = isPrivate(a.multiaddr)
-  const isBPrivate = isPrivate(b.multiaddr)
-
-  if (isAPrivate && !isBPrivate) {
-    return 1
-  } else if (!isAPrivate && isBPrivate) {
-    return -1
-  }
-  return 0
-}
-
 module.exports = AutoRelay

src/config.js

@@ -6,6 +6,7 @@ const { dnsaddrResolver } = require('multiaddr/src/resolvers')
 const Constants = require('./constants')
 const RelayConstants = require('./circuit/constants')
 
+const { sortPublicAddressesFirst } = require('./dialer/utils')
 const { FaultTolerance } = require('./transport-manager')
 
 const DefaultConfig = {
@@ -26,7 +27,8 @@ const DefaultConfig = {
     dialTimeout: Constants.DIAL_TIMEOUT,
     resolvers: {
       dnsaddr: dnsaddrResolver
-    }
+    },
+    addressSorter: sortPublicAddressesFirst
   },
   metrics: {
     enabled: false

src/dialer/index.js

@@ -9,6 +9,7 @@ const log = debug('libp2p:dialer')
 log.error = debug('libp2p:dialer:error')
 
 const { DialRequest } = require('./dial-request')
+const { sortPublicAddressesFirst } = require('./utils')
 const getPeer = require('../get-peer')
 
 const { codes } = require('../errors')
@@ -24,6 +25,7 @@ class Dialer {
    * @param {object} options
    * @param {TransportManager} options.transportManager
    * @param {Peerstore} options.peerStore
+   * @param {(addresses: Array<Address) => Array<Address>} [options.addressSorter = sortPublicAddressesFirst] - Sort the known addresses of a peer before trying to dial.
    * @param {number} [options.concurrency = MAX_PARALLEL_DIALS] - Number of max concurrent dials.
    * @param {number} [options.perPeerLimit = MAX_PER_PEER_DIALS] - Number of max concurrent dials per peer.
    * @param {number} [options.timeout = DIAL_TIMEOUT] - How long a dial attempt is allowed to take.
@@ -32,13 +34,15 @@ class Dialer {
   constructor ({
     transportManager,
     peerStore,
+    addressSorter = sortPublicAddressesFirst,
     concurrency = MAX_PARALLEL_DIALS,
     timeout = DIAL_TIMEOUT,
     perPeerLimit = MAX_PER_PEER_DIALS,
     resolvers = {}
   }) {
     this.transportManager = transportManager
     this.peerStore = peerStore
+    this.addressSorter = addressSorter
     this.concurrency = concurrency
     this.timeout = timeout
     this.perPeerLimit = perPeerLimit
@@ -120,7 +124,16 @@ class Dialer {
       this.peerStore.addressBook.add(id, multiaddrs)
     }
 
-    let knownAddrs = this.peerStore.addressBook.getMultiaddrsForPeer(id) || []
+    let knownAddrs = this.addressSorter(
+      this.peerStore.addressBook.get(id) || []
+    ).map((address) => {
+      const multiaddr = address.multiaddr
+
+      const idString = multiaddr.getPeerId()
+      if (idString && idString === id.toB58String()) return multiaddr
+
+      return multiaddr.encapsulate(`/p2p/${id.toB58String()}`)
+    })
 
     // If received a multiaddr to dial, it should be the first to use
     // But, if we know other multiaddrs for the peer, we should try them too.

src/dialer/utils.js

@@ -0,0 +1,45 @@
+'use strict'
+
+const isPrivate = require('libp2p-utils/src/multiaddr/is-private')
+
+// TODO: Move to libp2p-utils?
+
+/**
+ * Compare function for array.sort().
+ * This sort aims to move the private adresses to the end of the array.
+ * In case of equality, a cerified address will come first.
+ *
+ * @param {Address} a
+ * @param {Address} b
+ * @returns {number}
+ */
+function addressesPublicFirstCompareFunction (a, b) {
+  const isAPrivate = isPrivate(a.multiaddr)
+  const isBPrivate = isPrivate(b.multiaddr)
+
+  if (isAPrivate && !isBPrivate) {
+    return 1
+  } else if (!isAPrivate && isBPrivate) {
+    return -1
+  }
+  // Check certified?
+  if (a.isCertified && !b.isCertified) {
+    return -1
+  } else if (!a.isCertified && b.isCertified) {
+    return 1
+  }
+
+  return 0
+}
+
+/**
+ * Sort given addresses by putting public addresses first.
+ *
+ * @param {Array<Address>} addresses
+ * @returns {Array<Address>}
+ */
+function sortPublicAddressesFirst (addresses) {
+  return [...addresses].sort(addressesPublicFirstCompareFunction)
+}
+
+module.exports.sortPublicAddressesFirst = sortPublicAddressesFirst

src/index.js

@@ -136,7 +136,8 @@ class Libp2p extends EventEmitter {
       concurrency: this._options.dialer.maxParallelDials,
       perPeerLimit: this._options.dialer.maxDialsPerPeer,
       timeout: this._options.dialer.dialTimeout,
-      resolvers: this._options.dialer.resolvers
+      resolvers: this._options.dialer.resolvers,
+      addressSorter: this._options.dialer.addressSorter
     })
 
     this._modules.transport.forEach((Transport) => {

test/dialing/direct.node.js

@@ -132,7 +132,7 @@ describe('Dialing (direct, TCP)', () => {
       peerStore: {
         addressBook: {
           add: () => {},
-          getMultiaddrsForPeer: () => [unsupportedAddr]
+          get: () => [{ multiaddr: unsupportedAddr }]
         }
       }
     })
@@ -175,7 +175,7 @@ describe('Dialing (direct, TCP)', () => {
       peerStore: {
         addressBook: {
           add: () => {},
-          getMultiaddrsForPeer: () => addrs
+          get: () => addrs.map(a => ({ multiaddr: multiaddr(a) }))
         }
       }
     })

test/dialing/direct.spec.js

@@ -85,7 +85,7 @@ describe('Dialing (direct, WebSockets)', () => {
       peerStore: {
         addressBook: {
           add: () => {},
-          getMultiaddrsForPeer: () => [remoteAddr]
+          get: () => [{ multiaddr: remoteAddr.decapsulate('/p2p') }]
         }
       }
     })
@@ -101,7 +101,7 @@ describe('Dialing (direct, WebSockets)', () => {
       peerStore: {
         addressBook: {
           add: () => {},
-          getMultiaddrsForPeer: () => [remoteAddr]
+          get: () => [{ multiaddr: remoteAddr.decapsulate('/p2p') }]
         }
       }
     })
@@ -125,7 +125,7 @@ describe('Dialing (direct, WebSockets)', () => {
       peerStore: {
         addressBook: {
           add: () => {},
-          getMultiaddrsForPeer: () => [remoteAddr]
+          get: () => [{ multiaddr: remoteAddr.decapsulate('/p2p') }]
         }
       }
     })
@@ -141,7 +141,7 @@ describe('Dialing (direct, WebSockets)', () => {
       peerStore: {
         addressBook: {
           set: () => {},
-          getMultiaddrsForPeer: () => [unsupportedAddr]
+          get: () => [{ multiaddr: unsupportedAddr.decapsulate('/p2p') }]
         }
       }
     })
@@ -158,7 +158,7 @@ describe('Dialing (direct, WebSockets)', () => {
       peerStore: {
         addressBook: {
           add: () => {},
-          getMultiaddrsForPeer: () => [remoteAddr]
+          get: () => [{ multiaddr: remoteAddr.decapsulate('/p2p') }]
         }
       }
     })
@@ -183,7 +183,7 @@ describe('Dialing (direct, WebSockets)', () => {
       peerStore: {
         addressBook: {
           set: () => {},
-          getMultiaddrsForPeer: () => [remoteAddr, remoteAddr, remoteAddr]
+          get: () => [{ multiaddr: remoteAddr }, { multiaddr: remoteAddr }, { multiaddr: remoteAddr }]
         }
       }
     })
@@ -221,7 +221,7 @@ describe('Dialing (direct, WebSockets)', () => {
       peerStore: {
         addressBook: {
           set: () => {},
-          getMultiaddrsForPeer: () => [remoteAddr, remoteAddr, remoteAddr]
+          get: () => [{ multiaddr: remoteAddr }, { multiaddr: remoteAddr }, { multiaddr: remoteAddr }]
         }
       }
     })