dht-rpc 5.0.0-rc.7 → 5.0.3

package/README.md

@@ -3,13 +3,12 @@
 Make RPC calls over a [Kademlia](https://pdos.csail.mit.edu/~petar/papers/maymounkov-kademlia-lncs.pdf) based DHT.
 
 ```
-npm install dht-rpc@next
+npm install dht-rpc
 ```
 
-## NOTE: v5 Release Candidate
+## NOTE: v5
 
-Note that this is the README for the v5 release candidate.
-To see the v4 documentation/code go to https://github.com/mafintosh/dht-rpc/tree/v4
+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
 
@@ -115,11 +114,6 @@ Options include:
 
 ``` js
 {
-  // Whether or not this node is ephemeral or should join the routing table
-  ephemeral: false,
-  // If you don't explicitly specific the ephemerality, the node will automatically
-  // figure it out in adaptive mode, based on your NAT settings, uptime and some other heuristics
-  adaptive: true,
   // A list of bootstrap nodes
   bootstrap: [ 'bootstrap-node.com:24242', ... ],
   // Optionally pass in your own UDP socket to use.
@@ -133,8 +127,9 @@ Options include:
 }
 ```
 
-Note that adaptive mode is very conservative, so it might take ~20-30 mins for the node to turn persistent.
-For the majority of use-cases you should always use adaptive mode to ensure good DHT health.
+Nodes per default use something called adaptive mode to decide whether or not they want to join other nodes' routing table.
+This includes things like node uptime, if the node is firewalled etc. Adaptive mode is conservative, so it might take ~20-30 mins for the node to turn persistent. If you are making a test case with your own bootstrap network you'd usually want to turn this off to make sure your test finishes in a timely maner. You can do this by passing `ephemeral: false` in the constructor.
+For the vast majority of use-cases you should always use adaptive mode to ensure good DHT health, ie the defaults.
 
 Your DHT routing id is `hash(publicIp + publicPort)` and will be autoconfigured internally.
 

package/index.js

@@ -55,7 +55,7 @@ class DHT extends EventEmitter {
     this._lastHost = null
     this._onrow = (row) => row.on('full', (node) => this._onfullrow(node, row))
     this._nonePersistentSamples = []
-    this._bootstrapping = this.bootstrap()
+    this._bootstrapping = this.bootstrap().catch(noop)
 
     this.table.on('row', this._onrow)
 

package/lib/io.js

@@ -36,7 +36,7 @@ module.exports = class IO {
   }
 
   onmessage (socket, buffer, rinfo) {
-    if (buffer.byteLength < 2) return
+    if (buffer.byteLength < 2 || !(rinfo.port > 0 && rinfo.port < 65536)) return
 
     const from = { id: null, host: rinfo.address, port: rinfo.port }
     const state = { start: 1, end: buffer.byteLength, buffer }

package/lib/peer.js

@@ -1,49 +1,27 @@
 const sodium = require('sodium-universal')
 const c = require('compact-encoding')
-
-const addr = Buffer.alloc(6)
-let i = 0
+const net = require('compact-encoding-net')
 
 const ipv4 = {
-  preencode (state, p) {
-    state.end += 6
-  },
-  encode (state, p) {
-    i = 0
-    state.buffer[state.start++] = num(p.host)
-    state.buffer[state.start++] = num(p.host)
-    state.buffer[state.start++] = num(p.host)
-    state.buffer[state.start++] = num(p.host)
-    state.buffer[state.start++] = p.port
-    state.buffer[state.start++] = p.port >>> 8
-  },
+  ...net.ipv4Address,
   decode (state) {
-    if (state.end - state.start < 6) throw new Error('Out of bounds')
+    const ip = net.ipv4Address.decode(state)
     return {
-      id: null, // populated elsewhere
-      host: state.buffer[state.start++] + '.' + state.buffer[state.start++] + '.' + state.buffer[state.start++] + '.' + state.buffer[state.start++],
-      port: state.buffer[state.start++] + 256 * state.buffer[state.start++]
+      id: null, // populated by the callee
+      host: ip.host,
+      port: ip.port
     }
   }
 }
 
 module.exports = { id, ipv4, ipv4Array: c.array(ipv4) }
 
-function num (ip) {
-  let n = 0
-  let c = 0
-  while (i < ip.length && (c = ip.charCodeAt(i++)) !== 46) n = n * 10 + (c - 48)
-  return n
-}
-
-function id (ip, port, out = Buffer.allocUnsafe(32)) {
-  i = 0
-  addr[0] = num(ip)
-  addr[1] = num(ip)
-  addr[2] = num(ip)
-  addr[3] = num(ip)
-  addr[4] = port
-  addr[5] = port >>> 8
+function id (host, port, out = Buffer.allocUnsafe(32)) {
+  const addr = out.subarray(0, 6)
+  ipv4.encode(
+    { start: 0, end: 6, buffer: addr },
+    { host, port }
+  )
   sodium.crypto_generichash(out, addr)
   return out
 }

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "dht-rpc",
-  "version": "5.0.0-rc.7",
+  "version": "5.0.3",
   "description": "Make RPC calls over a Kademlia based DHT",
   "main": "index.js",
   "dependencies": {
     "bind-easy": "^1.0.0",
     "compact-encoding": "^2.1.0",
+    "compact-encoding-net": "^1.0.1",
     "fast-fifo": "^1.0.0",
     "kademlia-routing-table": "^1.0.0",
     "nat-sampler": "^1.0.1",