dht-rpc 5.0.4 → 6.0.0

package/README.md

@@ -6,10 +6,6 @@ Make RPC calls over a [Kademlia](https://pdos.csail.mit.edu/~petar/papers/maymou
 npm install dht-rpc
 ```
 
-## NOTE: v5
-
-Note that the latest release is v5. To see the v4 documentation/code go to https://github.com/mafintosh/dht-rpc/tree/v4
-
 ## Key Features
 
 * Remote IP / firewall detection
@@ -116,12 +112,12 @@ Options include:
 {
   // A list of bootstrap nodes
   bootstrap: [ 'bootstrap-node.com:24242', ... ],
-  // Optionally pass in your own UDP socket to use.
-  socket: udpSocket,
   // Optionally pass in array of { host, port } to add to the routing table if you know any peers
   nodes: [{ host, port }, ...],
   // Optionally pass a port you prefer to bind to instead of a random one
-  bind: 0,
+  port: 0,
+  // Optionally pass a UDX instance on which sockets will be created.
+  udx,
   // dht-rpc will automatically detect if you are firewalled. If you know that you are not set this to false
   firewalled: true
 }
@@ -133,7 +129,7 @@ For the vast majority of use-cases you should always use adaptive mode to ensure
 
 Your DHT routing id is `hash(publicIp + publicPort)` and will be autoconfigured internally.
 
-#### `const node = DHT.boostrapper(bind, [options])`
+#### `const node = DHT.bootrapper(port, [options])`
 
 Sugar for the options needed to run a bootstrap node, ie
 
@@ -144,7 +140,7 @@ Sugar for the options needed to run a bootstrap node, ie
 }
 ```
 
-Additionally since you'll want a known port for a bootstrap node it adds the bind option as a primary argument.
+Additionally since you'll want a known port for a bootstrap node it adds the `port` option as a primary argument.
 
 #### `await node.ready()`
 
@@ -165,7 +161,7 @@ Emitted when the routing table is fully bootstrapped. Emitted as a conveinience.
 
 #### `node.on('listening')`
 
-Emitted when the underlying UDP socket is listening. Emitted as a conveinience.
+Emitted when the underlying UDX socket is listening. Emitted as a conveinience.
 
 #### `node.on('persistent')`
 
@@ -179,6 +175,10 @@ you are on an open NAT.
 Emitted when the node has detected that the computer has gone to sleep. If this happens,
 it will switch from persistent mode to ephemeral again.
 
+#### `node.on('network-change', interfaces)`
+
+Emitted when the network interfaces of the computer change.
+
 #### `node.refresh()`
 
 Refresh the routing table by looking up a random node in the background.
@@ -201,12 +201,12 @@ Boolean indicated if your node is behind a firewall.
 This is auto detected by having other node's trying to do a PING to you
 without you contacting them first.
 
-#### `const udpAddr = node.address()`
+#### `const addr = node.address()`
 
 Get the local address of the UDP socket bound.
 
 Note that if you are in ephemeral mode, this will return a different
-port than the one you provided in the constructor (under bind), as ephemeral
+port than the one you provided in the constructor (under `port`), as ephemeral
 mode always uses a random port.
 
 #### `node.on('request', req)`
@@ -242,7 +242,7 @@ Options include:
 ```js
 {
   retry: true, // whether the request should retry on timeout
-  socket: udpSocket // request on this specific socket
+  socket: udxSocket // request on this specific socket
 }
 ```
 
@@ -309,6 +309,10 @@ nodes are stored in `stream.closestNodes` array.
 
 If you want to access the closest replies to your provided target you can see those at `stream.closestReplies`.
 
+#### `stream = node.findNode(target, [options])`
+
+Find the node closest to the node with id `target`. Returns a stream encapsulating the query (see `node.query()`). `options` are the same as `node.query()`.
+
 #### `node.destroy()`
 
 Shutdown the DHT node.

package/index.js

@@ -2,16 +2,18 @@ const dns = require('dns')
 const { EventEmitter } = require('events')
 const Table = require('kademlia-routing-table')
 const TOS = require('time-ordered-set')
+const UDX = require('udx-native')
 const sodium = require('sodium-universal')
 const c = require('compact-encoding')
 const NatSampler = require('nat-sampler')
+const b4a = require('b4a')
 const IO = require('./lib/io')
 const Query = require('./lib/query')
 const peer = require('./lib/peer')
 const { UNKNOWN_COMMAND, INVALID_TOKEN } = require('./lib/errors')
 const { PING, PING_NAT, FIND_NODE, DOWN_HINT } = require('./lib/commands')
 
-const TMP = Buffer.allocUnsafe(32)
+const TMP = b4a.allocUnsafe(32)
 const TICK_INTERVAL = 5000
 const SLEEPING_INTERVAL = 3 * TICK_INTERVAL
 const STABLE_TICKS = 240 // if nothing major bad happens in ~20mins we can consider this node stable (if nat is friendly)
@@ -27,7 +29,8 @@ class DHT extends EventEmitter {
     this.bootstrapNodes = opts.bootstrap === false ? [] : (opts.bootstrap || []).map(parseNode)
     this.table = new Table(opts.id || randomBytes(32))
     this.nodes = new TOS()
-    this.io = new IO(this.table, {
+    this.udx = opts.udx || new UDX()
+    this.io = new IO(this.table, this.udx, {
       ...opts,
       onrequest: this._onrequest.bind(this),
       onresponse: this._onresponse.bind(this),
@@ -42,7 +45,7 @@ class DHT extends EventEmitter {
     this.destroyed = false
 
     this._nat = new NatSampler()
-    this._bind = opts.bind || 0
+    this._port = opts.port || 0
     this._quickFirewall = opts.quickFirewall !== false
     this._forcePersistent = opts.ephemeral === false
     this._repinging = 0
@@ -59,13 +62,15 @@ class DHT extends EventEmitter {
 
     this.table.on('row', this._onrow)
 
+    this.io.networkInterfaces.on('change', (interfaces) => this._onnetworkchange(interfaces))
+
     if (opts.nodes) {
       for (const node of opts.nodes) this.addNode(node)
     }
   }
 
-  static bootstrapper (bind, opts) {
-    return new this({ bind, firewalled: false, bootstrap: [], ...opts })
+  static bootstrapper (port, opts) {
+    return new this({ port, firewalled: false, bootstrap: [], ...opts })
   }
 
   get id () {
@@ -194,7 +199,7 @@ class DHT extends EventEmitter {
       if (!first) return
       first = false
 
-      const value = Buffer.allocUnsafe(2)
+      const value = b4a.allocUnsafe(2)
       c.uint16.encode({ start: 0, end: 2, buffer: value }, self.io.serverSocket.address().port)
 
       self._request(data.from, true, PING_NAT, null, value, () => { testNat = true }, noop)
@@ -269,7 +274,7 @@ class DHT extends EventEmitter {
   }
 
   _addNode (node) {
-    if (this.nodes.has(node) || node.id.equals(this.table.id)) return
+    if (this.nodes.has(node) || b4a.equals(node.id, this.table.id)) return
 
     node.added = node.pinged = node.seen = this._tick
 
@@ -328,6 +333,10 @@ class DHT extends EventEmitter {
     this._repingAndSwap(newNode, oldest)
   }
 
+  _onnetworkchange (interfaces) {
+    this.emit('network-change', interfaces)
+  }
+
   _repingAndSwap (newNode, oldNode) {
     const self = this
     const lastSeen = oldNode.seen
@@ -529,13 +538,13 @@ class DHT extends EventEmitter {
     // as possible, vs blindly copying them over...
 
     // all good! copy over the old routing table to the new one
-    if (!this.table.id.equals(id)) {
+    if (!b4a.equals(this.table.id, id)) {
       const nodes = this.table.toArray()
 
       this.table = this.io.table = new Table(id)
 
       for (const node of nodes) {
-        if (node.id.equals(id)) continue
+        if (b4a.equals(node.id, id)) continue
         if (!this.table.add(node)) this.nodes.remove(node)
       }
 
@@ -586,7 +595,7 @@ class DHT extends EventEmitter {
     if (nodes.length === 0) return true
 
     const hosts = []
-    const value = Buffer.allocUnsafe(2)
+    const value = b4a.allocUnsafe(2)
 
     c.uint16.encode({ start: 0, end: 2, buffer: value }, this.io.serverSocket.address().port)
 
@@ -618,8 +627,8 @@ class DHT extends EventEmitter {
 
     return false
 
-    function onmessage (_, rinfo) {
-      hosts.push(rinfo.address)
+    function onmessage (_, { host }) {
+      hosts.push(host)
     }
   }
 
@@ -659,7 +668,7 @@ function parseNode (s) {
 }
 
 function randomBytes (n) {
-  const b = Buffer.alloc(n)
+  const b = b4a.alloc(n)
   sodium.randombytes_buf(b)
   return b
 }

package/lib/errors.js

@@ -1,8 +1,14 @@
 exports.UNKNOWN_COMMAND = 1
 exports.INVALID_TOKEN = 2
 
-exports.TIMEOUT = new Error('Request timed out')
-exports.TIMEOUT.code = 'ETIMEDOUT'
+exports.createTimeoutError = () => {
+  const timeoutErr = new Error('Request timed out')
+  timeoutErr.code = 'ETIMEDOUT'
+  return timeoutErr
+}
 
-exports.DESTROY = new Error('Request destroyed')
-exports.DESTROY.code = 'EDESTROYED'
+exports.createDestroyedError = () => {
+  const destroyErr = new Error('Request destroyed')
+  destroyErr.code = 'EDESTROYED'
+  return destroyErr
+}

package/lib/io.js

@@ -1,25 +1,27 @@
 const FIFO = require('fast-fifo')
 const sodium = require('sodium-universal')
 const c = require('compact-encoding')
-const bind = require('bind-easy')
+const b4a = require('b4a')
 const peer = require('./peer')
-const { INVALID_TOKEN, TIMEOUT, DESTROY } = require('./errors')
+const errors = require('./errors')
 
 const VERSION = 0b11
 const RESPONSE_ID = (0b0001 << 4) | VERSION
 const REQUEST_ID = (0b0000 << 4) | VERSION
-const TMP = Buffer.alloc(32)
+const TMP = b4a.alloc(32)
 const EMPTY_ARRAY = []
 
 module.exports = class IO {
-  constructor (table, { maxWindow = 80, bind = 0, firewalled = true, onrequest, onresponse = noop, ontimeout = noop } = {}) {
+  constructor (table, udx, { maxWindow = 80, port = 0, firewalled = true, onrequest, onresponse = noop, ontimeout = noop } = {}) {
     this.table = table
+    this.udx = udx
     this.inflight = []
     this.clientSocket = null
     this.serverSocket = null
     this.firewalled = firewalled !== false
     this.ephemeral = true
     this.congestion = new CongestionWindow(maxWindow)
+    this.networkInterfaces = udx.watchNetworkInterfaces()
 
     this.onrequest = onrequest
     this.onresponse = onresponse
@@ -32,13 +34,13 @@ module.exports = class IO {
     this._drainInterval = null
     this._destroying = null
     this._binding = null
-    this._bind = bind
+    this._port = port
   }
 
-  onmessage (socket, buffer, rinfo) {
-    if (buffer.byteLength < 2 || !(rinfo.port > 0 && rinfo.port < 65536)) return
+  onmessage (socket, buffer, { host, port }) {
+    if (buffer.byteLength < 2 || !(port > 0 && port < 65536)) return
 
-    const from = { id: null, host: rinfo.address, port: rinfo.port }
+    const from = { id: null, host, port }
     const state = { start: 1, end: buffer.byteLength, buffer }
     const expectedSocket = this.firewalled ? this.clientSocket : this.serverSocket
     const external = socket !== expectedSocket
@@ -46,8 +48,8 @@ module.exports = class IO {
     if (buffer[0] === REQUEST_ID) {
       const req = Request.decode(this, socket, from, state)
       if (req === null) return
-      if (req.token !== null && !req.token.equals(this.token(req.from, 1)) && !req.token.equals(this.token(req.from, 0))) {
-        req.error(INVALID_TOKEN, { token: true })
+      if (req.token !== null && !b4a.equals(req.token, this.token(req.from, 1)) && !b4a.equals(req.token, this.token(req.from, 0))) {
+        req.error(errors.INVALID_TOKEN, { token: true })
         return
       }
       this.onrequest(req, external)
@@ -65,7 +67,7 @@ module.exports = class IO {
         if (i === this.inflight.length - 1) this.inflight.pop()
         else this.inflight[i] = this.inflight.pop()
 
-        // TODO: Auto retry here if INVALID_TOKEN is returned?
+        // TODO: Auto retry here if errors.INVALID_TOKEN is returned?
 
         if (req._timeout) {
           clearTimeout(req._timeout)
@@ -82,14 +84,14 @@ module.exports = class IO {
 
   token (addr, i) {
     if (this._secrets === null) {
-      const buf = Buffer.alloc(64)
+      const buf = b4a.alloc(64)
       this._secrets = [buf.subarray(0, 32), buf.subarray(32, 64)]
       sodium.randombytes_buf(this._secrets[0])
       sodium.randombytes_buf(this._secrets[1])
     }
 
-    const token = Buffer.allocUnsafe(32)
-    sodium.crypto_generichash(token, Buffer.from(addr.host), this._secrets[i])
+    const token = b4a.allocUnsafe(32)
+    sodium.crypto_generichash(token, b4a.from(addr.host), this._secrets[i])
     return token
   }
 
@@ -109,19 +111,15 @@ module.exports = class IO {
       if (req._timeout) clearTimeout(req._timeout)
       req._timeout = null
       req.destroyed = true
-      req.onerror(DESTROY, req)
-    }
-
-    this._destroying = new Promise((resolve) => {
-      let missing = 2
 
-      this.serverSocket.close(done)
-      this.clientSocket.close(done)
+      req.onerror(errors.createDestroyedError(), req)
+    }
 
-      function done () {
-        if (--missing === 0) resolve()
-      }
-    })
+    this._destroying = Promise.allSettled([
+      this.serverSocket.close(),
+      this.clientSocket.close(),
+      this.networkInterfaces.destroy()
+    ])
 
     return this._destroying
   }
@@ -133,19 +131,32 @@ module.exports = class IO {
   }
 
   async _bindSockets () {
-    const serverSocket = typeof this._bind === 'function' ? await this._bind() : await bind.udp(this._bind)
+    const serverSocket = this.udx.createSocket()
 
     try {
-      // TODO: we should reroll the socket is it's close to our preferred range of ports
-      // to avoid it being accidentally opened
-      // We'll prop need additional APIs for that
-      this.clientSocket = await bind.udp()
-      this.serverSocket = serverSocket
+      serverSocket.bind(this._port)
+    } catch {
+      try {
+        serverSocket.bind()
+      } catch (err) {
+        await serverSocket.close()
+        throw err
+      }
+    }
+
+    const clientSocket = this.udx.createSocket()
+
+    try {
+      clientSocket.bind()
     } catch (err) {
-      await new Promise((resolve) => serverSocket.close(resolve))
+      await serverSocket.close()
+      await clientSocket.close()
       throw err
     }
 
+    this.clientSocket = clientSocket
+    this.serverSocket = serverSocket
+
     this.serverSocket.on('message', this.onmessage.bind(this, this.serverSocket))
     this.clientSocket.on('message', this.onmessage.bind(this, this.clientSocket))
 
@@ -240,8 +251,7 @@ class Request {
   reply (value, opts = {}) {
     const socket = opts.socket || this.socket
     const to = opts.to || this.from
-    const onflush = opts.onflush || null
-    this._sendReply(0, value || null, opts.token !== false, opts.closerNodes !== false, to, socket, onflush)
+    this._sendReply(0, value || null, opts.token !== false, opts.closerNodes !== false, to, socket)
   }
 
   error (code, opts = {}) {
@@ -253,7 +263,7 @@ class Request {
   relay (value, to, opts) {
     const socket = (opts && opts.socket) || this.socket
     const buffer = this._encodeRequest(null, value, to, socket)
-    socket.send(buffer, 0, buffer.byteLength, to.port, to.host)
+    socket.trySend(buffer, to.port, to.host)
   }
 
   send (force = false) {
@@ -278,7 +288,7 @@ class Request {
     if (this.destroyed) return
     this.sent++
     this._io.congestion.send()
-    this.socket.send(this._buffer, 0, this._buffer.byteLength, this.to.port, this.to.host)
+    this.socket.trySend(this._buffer, this.to.port, this.to.host)
     if (this._timeout) clearTimeout(this._timeout)
     this._timeout = setTimeout(oncycle, 1000, this)
   }
@@ -293,10 +303,10 @@ class Request {
     if (i === this._io.inflight.length - 1) this._io.inflight.pop()
     else this._io.inflight[i] = this._io.inflight.pop()
 
-    this.onerror(err || DESTROY, this)
+    this.onerror(err || errors.createDestroyedError(), this)
   }
 
-  _sendReply (error, value, token, hasCloserNodes, from, socket, onflush) {
+  _sendReply (error, value, token, hasCloserNodes, from, socket) {
     if (socket === null || this.destroyed) return
 
     const id = this._io.ephemeral === false && socket === this._io.serverSocket
@@ -309,7 +319,7 @@ class Request {
     if (error > 0) c.uint.preencode(state, error)
     if (value) c.buffer.preencode(state, value)
 
-    state.buffer = Buffer.allocUnsafe(state.end)
+    state.buffer = b4a.allocUnsafe(state.end)
     state.buffer[state.start++] = RESPONSE_ID
     state.buffer[state.start++] = (id ? 1 : 0) | (token ? 2 : 0) | (closerNodes.length > 0 ? 4 : 0) | (error > 0 ? 8 : 0) | (value ? 16 : 0)
 
@@ -322,7 +332,7 @@ class Request {
     if (error > 0) c.uint.encode(state, error)
     if (value) c.buffer.encode(state, value)
 
-    socket.send(state.buffer, 0, state.buffer.byteLength, from.port, from.host, onflush)
+    socket.trySend(state.buffer, from.port, from.host)
   }
 
   _encodeRequest (token, value, to, socket) {
@@ -337,7 +347,7 @@ class Request {
     if (this.target) state.end += 32
     if (value) c.buffer.preencode(state, value)
 
-    state.buffer = Buffer.allocUnsafe(state.end)
+    state.buffer = b4a.allocUnsafe(state.end)
     state.buffer[state.start++] = REQUEST_ID
     state.buffer[state.start++] = (id ? 1 : 0) | (token ? 2 : 0) | (this.internal ? 4 : 0) | (this.target ? 8 : 0) | (value ? 16 : 0)
 
@@ -393,7 +403,7 @@ function oncycle (req) {
   req._timeout = null
   req.oncycle(req)
   if (req.sent >= req.retries) {
-    req.destroy(TIMEOUT)
+    req.destroy(errors.createTimeoutError())
     req._io.ontimeout(req)
   } else {
     req.send()
@@ -420,5 +430,5 @@ function decodeReply (from, state) {
 }
 
 function validateId (id, from) {
-  return peer.id(from.host, from.port, TMP).equals(id) ? id : null
+  return b4a.equals(peer.id(from.host, from.port, TMP), id) ? id : null
 }

package/lib/peer.js

@@ -1,6 +1,7 @@
 const sodium = require('sodium-universal')
 const c = require('compact-encoding')
 const net = require('compact-encoding-net')
+const b4a = require('b4a')
 
 const ipv4 = {
   ...net.ipv4Address,
@@ -16,7 +17,7 @@ const ipv4 = {
 
 module.exports = { id, ipv4, ipv4Array: c.array(ipv4) }
 
-function id (host, port, out = Buffer.allocUnsafe(32)) {
+function id (host, port, out = b4a.allocUnsafe(32)) {
   const addr = out.subarray(0, 6)
   ipv4.encode(
     { start: 0, end: 6, buffer: addr },

package/lib/query.js

@@ -1,4 +1,5 @@
 const { Readable } = require('streamx')
+const b4a = require('b4a')
 const peer = require('./peer')
 const { DOWN_HINT } = require('./commands')
 
@@ -240,7 +241,7 @@ module.exports = class Query extends Readable {
     if (m.closerNodes !== null) {
       for (const node of m.closerNodes) {
         node.id = peer.id(node.host, node.port)
-        if (node.id.equals(this.dht.table.id)) continue
+        if (b4a.equals(node.id, this.dht.table.id)) continue
         // TODO: we could continue here instead of breaking to ensure that one of the nodes in the closer list
         // is later marked as DOWN that we gossip that back
         if (!this._addPending(node, m.from)) break
@@ -281,7 +282,7 @@ module.exports = class Query extends Readable {
   }
 
   _downHint (node, down) {
-    const state = { start: 0, end: 6, buffer: Buffer.allocUnsafe(6) }
+    const state = { start: 0, end: 6, buffer: b4a.allocUnsafe(6) }
     peer.ipv4.encode(state, down)
     this.dht._request(node, true, DOWN_HINT, null, state.buffer, noop, noop)
   }

package/package.json

@@ -1,21 +1,23 @@
 {
   "name": "dht-rpc",
-  "version": "5.0.4",
+  "version": "6.0.0",
   "description": "Make RPC calls over a Kademlia based DHT",
   "main": "index.js",
   "dependencies": {
-    "bind-easy": "^1.0.0",
+    "b4a": "^1.3.1",
     "compact-encoding": "^2.1.0",
     "compact-encoding-net": "^1.0.1",
+    "events": "^3.3.0",
     "fast-fifo": "^1.0.0",
     "kademlia-routing-table": "^1.0.0",
     "nat-sampler": "^1.0.1",
     "sodium-universal": "^3.0.4",
     "streamx": "^2.10.3",
-    "time-ordered-set": "^1.0.2"
+    "time-ordered-set": "^1.0.2",
+    "udx-native": "^1.1.0"
   },
   "devDependencies": {
-    "brittle": "^1.4.3",
+    "brittle": "^2.3.1",
     "standard": "^16.0.3"
   },
   "scripts": {

package/test.js

@@ -2,14 +2,12 @@ const test = require('brittle')
 const dgram = require('dgram')
 const DHT = require('./')
 
-test.configure({ serial: true })
-
 test('make tiny swarm', async function (t) {
   await makeSwarm(2, t)
   t.pass('could make swarm')
 })
 
-test('make bigger swarm', async function (t) {
+test('make bigger swarm', { timeout: 60000 }, async function (t) {
   const swarm = await makeSwarm(500, t)
 
   const targetNode = swarm[25]
@@ -165,23 +163,6 @@ test('request with/without retries', async function (t) {
   t.is(tries, 4)
 })
 
-test('reply onflush', async function (t) {
-  const [, a, b] = await makeSwarm(3, t)
-
-  let flushed = false
-
-  b.on('request', function (req) {
-    req.reply(null, {
-      onflush () {
-        flushed = true
-      }
-    })
-  })
-
-  await a.request({ command: 42 }, { host: '127.0.0.1', port: b.address().port })
-  t.ok(flushed)
-})
-
 test('shorthand commit', async function (t) {
   const swarm = await makeSwarm(40, t)
 
@@ -290,12 +271,12 @@ test('addNode / nodes option', async function (t) {
 test('set bind', async function (t) {
   const port = await freePort()
 
-  const a = new DHT({ bind: port, firewalled: false })
+  const a = new DHT({ port, firewalled: false })
   await a.ready()
 
   t.alike(a.address().port, port, 'bound to explicit port')
 
-  const b = new DHT({ bind: port })
+  const b = new DHT({ port })
   await b.ready()
 
   t.not(b.address().port, port, 'bound to different port as explicit one is taken')