feat: support for DHT and without DHT at the same time

refactor(tests): make tests independent without require global set up steps
feat: move libp2p just to the network, take libp2p as a whole and not pieces
docs: Update README Documentation

Author: daviddias

README.md

@@ -34,13 +34,7 @@
 > npm install ipfs-bitswap
 ```
 
-### Use in Node.js
-
-```js
-const Bitswap = require('ipfs-bitswap')
-```
-
-### Use in a browser with browserify, webpack or any other bundler
+### Use in Node.js or in the browser with browserify, webpack or any other bundler
 
 ```js
 const Bitswap = require('ipfs-bitswap')
@@ -56,10 +50,6 @@ Loading this module through a script tag will make the `IpfsBitswap` object avai
 <script src="https://unpkg.com/ipfs-bitswap/dist/index.js"></script>
 ```
 
-## Usage
-
-See https://ipfs.github.io/js-ipfs-bitswap
-
 ## API
 
 See https://ipfs.github.io/js-ipfs-bitswap
@@ -73,24 +63,21 @@ See https://ipfs.github.io/js-ipfs-bitswap
 ```sh
 » tree src
 src
-├── components
-│   ├── decision
-│   │   ├── engine.js
-│   │   ├── index.js
-│   │   └── ledger.js
-│   ├── network             # Handles peerSet and open new conns
-│   │   └── index.js
-│   └── want-manager        # Keeps track of all blocks the peer wants (not the others which it is connected)
-│       ├── index.js
-│       └── msg-queue.js    # Messages to send queue, one per peer
 ├── constants.js
+├── decision-engine
+│   ├── index.js
+│   └── ledger.js
 ├── index.js
-└── types
-    ├── message             # (Type) message that is put in the wire
+├── network.js             # Handles peerSet and open new conns
+├─── want-manager          # Keeps track of all blocks the peer (self) wants
+│   ├── index.js
+│   └── msg-queue.js       # Messages to send queue, one per peer
+└─── types
+    ├── message            # (Type) message that is put in the wire
     │   ├── entry.js
     │   ├── index.js
     │   └── message.proto.js
-    └── wantlist            # (Type) track wanted blocks
+    └── wantlist           # (Type) track wanted blocks
         ├── entry.js
         └── index.js
 ```

package.json

@@ -4,7 +4,8 @@
   "description": "Node.js implementation of the Bitswap data exchange protocol used by IPFS",
   "main": "src/index.js",
   "browser": {
-    "./test/libp2p-bundle": false
+    "./test/utils/create-libp2p-node": false,
+    "./test/utils/create-temp-repo-nodejs.js": "./test/utils/create-temp-repo-browser.js"
   },
   "scripts": {
     "test": "aegir-test",
@@ -39,10 +40,11 @@
   "devDependencies": {
     "aegir": "^11.0.2",
     "benchmark": "^2.1.4",
-    "chai": "^4.1.0",
+    "chai": "^4.1.1",
     "dirty-chai": "^2.0.1",
     "ipfs-repo": "~0.17.0",
     "libp2p": "^0.11.0",
+    "libp2p-kad-dht": "^0.4.1",
     "libp2p-multiplex": "^0.4.4",
     "libp2p-secio": "^0.7.1",
     "libp2p-tcp": "^0.10.2",
@@ -58,7 +60,7 @@
   "dependencies": {
     "async": "^2.5.0",
     "cids": "~0.5.1",
-    "debug": "^2.6.8",
+    "debug": "^3.0.0",
     "ipfs-block": "~0.6.0",
     "lodash.debounce": "^4.0.8",
     "lodash.find": "^4.6.0",
@@ -75,6 +77,7 @@
     "pull-length-prefixed": "^1.3.0",
     "pull-pushable": "^2.1.1",
     "pull-stream": "^3.6.0",
+    "safe-buffer": "^5.1.1",
     "varint-decoder": "^0.1.1"
   },
   "contributors": [

src/components/decision-engine/index.js renamed to src/decision-engine/index.js

@@ -4,6 +4,8 @@ const debug = require('debug')
 const each = require('async/each')
 const eachSeries = require('async/eachSeries')
 const waterfall = require('async/waterfall')
+const setImmediate = require('async/setImmediate')
+
 const map = require('async/map')
 const debounce = require('lodash.debounce')
 const uniqWith = require('lodash.uniqwith')
@@ -15,8 +17,8 @@ const pullAllWith = require('lodash.pullallwith')
 const log = debug('bitswap:engine')
 log.error = debug('bitswap:engine:error')
 
-const Message = require('../../types/message')
-const Wantlist = require('../../types/wantlist')
+const Message = require('../types/message')
+const Wantlist = require('../types/wantlist')
 const Ledger = require('./ledger')
 
 const MAX_MESSAGE_SIZE = 512 * 1024
@@ -271,12 +273,14 @@ class DecisionEngine {
     return l
   }
 
-  start () {
+  start (callback) {
     this._running = true
+    setImmediate(() => callback())
   }
 
-  stop () {
+  stop (callback) {
     this._running = false
+    setImmediate(() => callback())
   }
 }
 

src/components/decision-engine/ledger.js renamed to src/decision-engine/ledger.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const Wantlist = require('../../types/wantlist')
+const Wantlist = require('../types/wantlist')
 
 class Ledger {
   constructor (peerId) {

src/index.js

@@ -10,29 +10,24 @@ const map = require('async/map')
 const once = require('once')
 
 const CONSTANTS = require('./constants')
-const WantManager = require('./components/want-manager')
-const Network = require('./components/network')
-const DecisionEngine = require('./components/decision-engine')
+const WantManager = require('./want-manager')
+const Network = require('./network')
+const DecisionEngine = require('./decision-engine')
 
 const log = debug('bitswap')
 log.error = debug('bitswap:error')
 
-/**
- *
- */
 class Bitswap {
   /**
    * Create a new bitswap instance.
    *
    * @param {Libp2p} libp2p
    * @param {Blockstore} blockstore
-   * @param {PeerBook} peerBook
    * @returns {Bitswap}
    */
-  constructor (libp2p, blockstore, peerBook) {
-    this.libp2p = libp2p
+  constructor (libp2p, blockstore) {
     // the network delivers messages
-    this.network = new Network(libp2p, peerBook, this)
+    this.network = new Network(libp2p, this)
 
     // local database
     this.blockstore = blockstore
@@ -54,6 +49,7 @@ class Bitswap {
   _receiveMessage (peerId, incoming, callback) {
     this.engine.messageReceived(peerId, incoming, (err) => {
       if (err) {
+        // TODO: Q: why do we just log and not return here?
         log('failed to receive message', incoming)
       }
 
@@ -272,7 +268,8 @@ class Bitswap {
         })
       }, cb),
       (cb) => {
-        if (missing.length > 0) {
+        if (missing.length > 0) {        // TODO: Q: why do we just log and not return here?
+
           addListeners(missing)
           this.wm.wantBlocks(missing)
 
@@ -389,23 +386,31 @@ class Bitswap {
   /**
    * Start the bitswap node.
    *
+   * @param {function(Error)} callback
+   *
    * @returns {void}
    */
-  start () {
-    this.wm.run()
-    this.network.start()
-    this.engine.start()
+  start (callback) {
+    series([
+      (cb) => this.wm.start(cb),
+      (cb) => this.network.start(cb),
+      (cb) => this.engine.start(cb)
+    ], callback)
   }
 
   /**
-   * Stooop the bitswap node.
+   * Stop the bitswap node.
+   *
+   * @param {function(Error)} callback
    *
    * @returns {void}
    */
-  stop () {
-    this.wm.stop(this.libp2p.peerInfo.id)
-    this.network.stop()
-    this.engine.stop()
+  stop (callback) {
+    series([
+      (cb) => this.wm.stop(cb),
+      (cb) => this.network.stop(cb),
+      (cb) => this.engine.stop(cb)
+    ], callback)
   }
 }