feat: dht ready

Author: vasco-santos

README.md

@@ -319,7 +319,7 @@ Enable and configure experimental features.
 - `pubsub` (boolean): Enable libp2p pub-sub. (Default: `false`)
 - `ipnsPubsub` (boolean): Enable pub-sub on IPNS. (Default: `false`)
 - `sharding` (boolean): Enable directory sharding. Directories that have many child objects will be represented by multiple DAG nodes instead of just one. It can improve lookup performance when a directory has several thousand files or more. (Default: `false`)
-- `dht` (boolean): Enable KadDHT. **This is currently not interoperable with `go-ipfs`.**
+- `dht` (boolean): Enable KadDHT.
 
 ##### `options.config`
 
@@ -600,7 +600,13 @@ The core API is grouped into several areas:
   - [`ipfs.bootstrap.add(addr, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/BOOTSTRAP.md#bootstrapadd)
   - [`ipfs.bootstrap.rm(peer, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/BOOTSTRAP.md#bootstraprm)
 
-- dht (not implemented yet)
+- [dht](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/)
+  - [`ipfs.dht.findpeer(peerId, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DHT.md#dhtfindpeer)
+  - [`ipfs.dht.findprovs(multihash, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DHT.md#dhtfindprovs)
+  - [`ipfs.dht.get(key, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DHT.md#dhtget)
+  - [`ipfs.dht.provide(cid, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DHT.md#dhtprovide)
+  - [`ipfs.dht.put(key, value, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DHT.md#dhtput)
+  - [`ipfs.dht.query(peerId, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DHT.md#dhtquery)
 
 - [pubsub](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md)
   - [`ipfs.pubsub.subscribe(topic, handler, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/PUBSUB.md#pubsubsubscribe)

src/core/components/dht.js

@@ -4,6 +4,7 @@ const promisify = require('promisify-es6')
 const every = require('async/every')
 const PeerId = require('peer-id')
 const CID = require('cids')
+const multihash = require('multihashes')
 const each = require('async/each')
 const setImmediate = require('async/setImmediate')
 // const bsplit = require('buffer-split')
@@ -19,17 +20,21 @@ module.exports = (self) => {
      * @returns {Promise|void}
      */
     get: promisify((key, options, callback) => {
-      if (!Buffer.isBuffer(key)) {
-        return callback(new Error('Not valid key'))
-      }
-
       if (typeof options === 'function') {
         callback = options
         options = {}
       }
 
       options = options || {}
 
+      if (!Buffer.isBuffer(key)) {
+        try {
+          key = multihash.fromB58String(key)
+        } catch (err) {
+          return callback(err)
+        }
+      }
+
       self.libp2p.dht.get(key, options.timeout, callback)
     }),
 
@@ -47,7 +52,11 @@ module.exports = (self) => {
      */
     put: promisify((key, value, callback) => {
       if (!Buffer.isBuffer(key)) {
-        return callback(new Error('Not valid key'))
+        try {
+          key = multihash.fromB58String(key)
+        } catch (err) {
+          return callback(err)
+        }
       }
 
       self.libp2p.dht.put(key, value, callback)

src/core/components/libp2p.js

@@ -47,35 +47,37 @@ module.exports = function libp2p (self, config) {
 
 function defaultBundle ({ datastore, peerInfo, peerBook, options, config }) {
   const libp2pDefaults = {
-    datastore,
-    peerInfo,
-    peerBook,
+    datastore: opts.datastore,
+    peerInfo: opts.peerInfo,
+    peerBook: opts.peerBook,
     config: {
       peerDiscovery: {
         mdns: {
-          enabled: get(options, 'config.Discovery.MDNS.Enabled',
-            get(config, 'Discovery.MDNS.Enabled', true))
+          enabled: get(opts.options, 'config.Discovery.MDNS.Enabled',
+            get(opts.config, 'Discovery.MDNS.Enabled', true))
         },
         webRTCStar: {
-          enabled: get(options, 'config.Discovery.webRTCStar.Enabled',
-            get(config, 'Discovery.webRTCStar.Enabled', true))
+          enabled: get(opts.options, 'config.Discovery.webRTCStar.Enabled',
+            get(opts.config, 'Discovery.webRTCStar.Enabled', true))
         },
         bootstrap: {
-          list: get(options, 'config.Bootstrap',
-            get(config, 'Bootstrap', []))
+          list: get(opts.options, 'config.Bootstrap',
+            get(opts.config, 'Bootstrap', []))
         }
       },
       relay: {
-        enabled: get(options, 'relay.enabled',
-          get(config, 'relay.enabled', false)),
+        enabled: get(opts.options, 'relay.enabled',
+          get(opts.config, 'relay.enabled', false)),
         hop: {
-          enabled: get(options, 'relay.hop.enabled',
-            get(config, 'relay.hop.enabled', false)),
-          active: get(options, 'relay.hop.active',
-            get(config, 'relay.hop.active', false))
+          enabled: get(opts.options, 'relay.hop.enabled',
+            get(opts.config, 'relay.hop.enabled', false)),
+          active: get(opts.options, 'relay.hop.active',
+            get(opts.config, 'relay.hop.active', false))
         }
       },
       dht: {
+        kBucketSize: get(opts.options, 'dht.kBucketSize', 20),
+        enabledDiscovery: get(opts.options, 'dht.enabledDiscovery', true),
         validators: {
           ipns: ipnsUtils.validator
         },
@@ -84,12 +86,12 @@ function defaultBundle ({ datastore, peerInfo, peerBook, options, config }) {
         }
       },
       EXPERIMENTAL: {
-        dht: get(options, 'EXPERIMENTAL.dht', false),
-        pubsub: get(options, 'EXPERIMENTAL.pubsub', false)
+        dht: get(opts.options, 'EXPERIMENTAL.dht', false),
+        pubsub: get(opts.options, 'EXPERIMENTAL.pubsub', false)
       }
     },
-    connectionManager: get(options, 'connectionManager',
-      get(config, 'connectionManager', {}))
+    connectionManager: get(opts.options, 'connectionManager',
+      get(opts.config, 'connectionManager', {}))
   }
 
   const libp2pOptions = defaultsDeep(get(options, 'libp2p', {}), libp2pDefaults)

src/core/runtime/libp2p-browser.js

@@ -6,6 +6,7 @@ const WebSocketStarMulti = require('libp2p-websocket-star-multi')
 const Multiplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const Bootstrap = require('libp2p-bootstrap')
+const KadDHT = require('libp2p-kad-dht')
 const libp2p = require('libp2p')
 const defaultsDeep = require('@nodeutils/defaults-deep')
 const multiaddr = require('multiaddr')
@@ -37,7 +38,8 @@ class Node extends libp2p {
           wrtcstar.discovery,
           wsstar.discovery,
           Bootstrap
-        ]
+        ],
+        dht: KadDHT
       },
       config: {
         peerDiscovery: {
@@ -51,6 +53,10 @@ class Node extends libp2p {
             enabled: true
           }
         },
+        dht: {
+          kBucketSize: 20,
+          enabledDiscovery: true
+        },
         EXPERIMENTAL: {
           dht: false,
           pubsub: false

src/core/runtime/libp2p-nodejs.js

@@ -53,7 +53,8 @@ class Node extends libp2p {
           }
         },
         dht: {
-          kBucketSize: 20
+          kBucketSize: 20,
+          enabledDiscovery: true
         },
         EXPERIMENTAL: {
           dht: false,

test/core/interface.spec.js

@@ -36,19 +36,23 @@ describe('interface-ipfs-core tests', () => {
 
   const dhtCommonFactory = CommonFactory.create({
     spawnOptions: {
-      initOptions: { bits: 512 },
-      EXPERIMENTAL: {
-        dht: true
-      },
       config: {
-        Bootstrap: []
-      }
+        Bootstrap: [],
+        Discovery: {
+          MDNS: {
+            Enabled: false
+          },
+          webRTCStar: {
+            Enabled: false
+          }
+        }
+      },
+      args: ['--enable-dht-experiment'],
+      initOptions: { bits: 512 }
     }
   })
 
-  tests.dht(dhtCommonFactory, {
-    skip: { reason: 'TODO: unskip when https://github.com/ipfs/js-ipfs/pull/856 is merged' }
-  })
+  tests.dht(dhtCommonFactory)
 
   tests.filesRegular(defaultCommonFactory, {
     skip: isNode ? null : [{