chore: release version v0.26.2

* fix: allow pubsub sub/unsub via promises

* chore: fix linting errors

.aegir.js

@@ -1,69 +1,134 @@
 'use strict'
 
-const PeerInfo = require('peer-info')
-const PeerId = require('peer-id')
 const pull = require('pull-stream')
-const parallel = require('async/parallel')
-
-const rawPeer = require('./test/fixtures/test-peer.json')
-const Node = require('./test/utils/bundle.node.js')
-const sigServer = require('libp2p-webrtc-star/src/sig-server')
 const WebSocketStarRendezvous = require('libp2p-websocket-star-rendezvous')
+const sigServer = require('libp2p-webrtc-star/src/sig-server')
+const promisify = require('promisify-es6')
+const mplex = require('pull-mplex')
+const spdy = require('libp2p-spdy')
+const PeerBook = require('peer-book')
+const PeerId = require('peer-id')
+const PeerInfo = require('peer-info')
+const path = require('path')
+const Switch = require('./src/switch')
+const WebSockets = require('libp2p-websockets')
+
+const Node = require('./test/utils/bundle-nodejs.js')
+const {
+  getPeerRelay,
+  WRTC_RENDEZVOUS_MULTIADDR,
+  WS_RENDEZVOUS_MULTIADDR
+} = require('./test/utils/constants')
 
 let wrtcRendezvous
 let wsRendezvous
 let node
+let peerInfo
+let switchA
+let switchB
 
-const before = (done) => {
-  parallel([
-    (cb) => {
-      sigServer.start({
-        port: 15555
-        // cryptoChallenge: true TODO: needs https://github.com/libp2p/js-libp2p-webrtc-star/issues/128
-      }, (err, server) => {
-        if (err) { return cb(err) }
-        wrtcRendezvous = server
-        cb()
-      })
-    },
-    (cb) => {
-      WebSocketStarRendezvous.start({
-        port: 14444,
-        refreshPeerListIntervalMS: 1000,
-        strictMultiaddr: false,
-        cryptoChallenge: true
-      }, (err, _server) => {
-        if (err) { return cb(err) }
-        wsRendezvous = _server
-        cb()
-      })
-    },
-    (cb) => {
-      PeerId.createFromJSON(rawPeer, (err, peerId) => {
-        if (err) {
-          return done(err)
-        }
-        const peer = new PeerInfo(peerId)
-
-        peer.multiaddrs.add('/ip4/127.0.0.1/tcp/9200/ws')
-
-        node = new Node(peer)
-        node.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
-        node.start(cb)
-      })
-    }
-  ], done)
+function echo (protocol, conn) { pull(conn, conn) }
+function idJSON (id) {
+  const p = path.join(__dirname, `./test/switch/test-data/id-${id}.json`)
+  return require(p)
 }
 
-const after = (done) => {
-  setTimeout(() => parallel(
-    [node, wrtcRendezvous, wsRendezvous].map((s) => {
-      return (cb) => s.stop(cb)
+function createSwitchA () {
+  return new Promise((resolve, reject) => {
+    PeerId.createFromJSON(idJSON(1), (err, id) => {
+      if (err) { return reject(err) }
+
+      const peerA = new PeerInfo(id)
+      const maA = '/ip4/127.0.0.1/tcp/15337/ws'
+
+      peerA.multiaddrs.add(maA)
+      const sw = new Switch(peerA, new PeerBook())
+
+      sw.transport.add('ws', new WebSockets())
+      sw.start((err) => {
+        if (err) { return reject(err) }
+        resolve(sw)
+      })
     })
-   , done), 2000)
+  })
+}
+
+function createSwitchB () {
+  return new Promise((resolve, reject) => {
+    PeerId.createFromJSON(idJSON(2), (err, id) => {
+      if (err) { return reject(err) }
+
+      const peerB = new PeerInfo(id)
+      const maB = '/ip4/127.0.0.1/tcp/15347/ws'
+
+      peerB.multiaddrs.add(maB)
+      const sw = new Switch(peerB, new PeerBook())
+
+      sw.transport.add('ws', new WebSockets())
+      sw.connection.addStreamMuxer(mplex)
+      sw.connection.addStreamMuxer(spdy)
+      sw.connection.reuse()
+      sw.handle('/echo/1.0.0', echo)
+      sw.start((err) => {
+        if (err) { return reject(err) }
+        resolve(sw)
+      })
+    })
+  })
+}
+
+const before = async () => {
+  [
+    wrtcRendezvous,
+    wsRendezvous,
+    peerInfo,
+    switchA,
+    switchB
+  ] = await Promise.all([
+    sigServer.start({
+      port: WRTC_RENDEZVOUS_MULTIADDR.nodeAddress().port
+      // cryptoChallenge: true TODO: needs https://github.com/libp2p/js-libp2p-webrtc-star/issues/128
+    }),
+    WebSocketStarRendezvous.start({
+      port: WS_RENDEZVOUS_MULTIADDR.nodeAddress().port,
+      refreshPeerListIntervalMS: 1000,
+      strictMultiaddr: false,
+      cryptoChallenge: true
+    }),
+    getPeerRelay(),
+    createSwitchA(),
+    createSwitchB()
+  ])
+
+  node = new Node({
+    peerInfo,
+    config: {
+      relay: {
+        enabled: true,
+        hop: {
+          enabled: true,
+          active: true
+        }
+      }
+    }
+  })
+
+  node.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
+  await node.start()
+}
+
+const after = () => {
+  return Promise.all([
+    wrtcRendezvous.stop(),
+    wsRendezvous.stop(),
+    node.stop(),
+    promisify(switchA.stop, { context: switchA })(),
+    promisify(switchB.stop, { context: switchB })()
+  ])
 }
 
 module.exports = {
+  bundlesize: { maxSize: '220kB' },
   hooks: {
     pre: before,
     post: after

.gitignore

@@ -9,6 +9,7 @@ logs
 *.log
 
 coverage
+.nyc_output
 
 # Runtime data
 pids
@@ -41,3 +42,4 @@ test/test-data/go-ipfs-repo/LOG.old
 
 # while testing npm5
 package-lock.json
+yarn.lock

.npmignore

@@ -1,34 +0,0 @@
-**/node_modules/
-**/*.log
-test/repo-tests*
-
-# Logs
-logs
-*.log
-
-coverage
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-build
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
-node_modules
-
-test

.travis.yml

@@ -1,32 +1,44 @@
-# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
-sudo: false
 language: node_js
+cache: npm
+stages:
+  - check
+  - test
+  - cov
 
-matrix:
+node_js:
+  - '10'
+  - '12'
+
+os:
+  - linux
+  - osx
+
+script: npx nyc -s npm run test:node -- --bail
+after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
+
+jobs:
   include:
-  - node_js: 6
-    env: CXX=g++-4.8
-  - node_js: 8
-    env: CXX=g++-4.8
-    #  - node_js: stable
-    #    env: CXX=g++-4.8
+    - stage: check
+      script:
+        - npx aegir build --bundlesize
+        - npx aegir dep-check -- -i wrtc -i electron-webrtc
+        - npm run lint
 
-script:
-  - npm run lint
-  - npm run test
-  - npm run coverage
+    - stage: test
+      name: chrome
+      addons:
+        chrome: stable
+      script:
+        - npx aegir test -t browser
+        - npx aegir test -t webworker
 
-before_script:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
+    - stage: test
+      name: firefox
+      addons:
+        firefox: latest
+      script:
+        - npx aegir test -t browser -- --browsers FirefoxHeadless
+        - npx aegir test -t webworker -- --browsers FirefoxHeadless
 
-after_success:
-  - npm run coverage-publish
-
-addons:
-  firefox: 'latest'
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test
-    packages:
-      - g++-4.8
+notifications:
+  email: false

CHANGELOG.md

@@ -1,3 +1,463 @@
+<a name="0.26.2"></a>
+## [0.26.2](https://github.com/libp2p/js-libp2p/compare/v0.26.1...v0.26.2) (2019-09-24)
+
+
+### Bug Fixes
+
+* pubsub promisify ([#456](https://github.com/libp2p/js-libp2p/issues/456)) ([ae6af20](https://github.com/libp2p/js-libp2p/commit/ae6af20))
+
+
+
+<a name="0.26.1"></a>
+## [0.26.1](https://github.com/libp2p/js-libp2p/compare/v0.26.0...v0.26.1) (2019-08-21)
+
+
+### Bug Fixes
+
+* avoid using superstruct interface ([aa95ab9](https://github.com/libp2p/js-libp2p/commit/aa95ab9))
+* improve config defaults ([#409](https://github.com/libp2p/js-libp2p/issues/409)) ([3eef695](https://github.com/libp2p/js-libp2p/commit/3eef695)), closes [#406](https://github.com/libp2p/js-libp2p/issues/406)
+* pubsub configuration ([#404](https://github.com/libp2p/js-libp2p/issues/404)) ([b0f124b](https://github.com/libp2p/js-libp2p/commit/b0f124b)), closes [#401](https://github.com/libp2p/js-libp2p/issues/401) [#401](https://github.com/libp2p/js-libp2p/issues/401) [#401](https://github.com/libp2p/js-libp2p/issues/401) [#401](https://github.com/libp2p/js-libp2p/issues/401) [#401](https://github.com/libp2p/js-libp2p/issues/401)
+* reference files directly to avoid npm install failures ([#408](https://github.com/libp2p/js-libp2p/issues/408)) ([b3deb35](https://github.com/libp2p/js-libp2p/commit/b3deb35))
+* reject rather than throw in get peer info ([#410](https://github.com/libp2p/js-libp2p/issues/410)) ([60b0cbc](https://github.com/libp2p/js-libp2p/commit/60b0cbc)), closes [#400](https://github.com/libp2p/js-libp2p/issues/400)
+
+
+
+<a name="0.26.0"></a>
+# [0.26.0](https://github.com/libp2p/js-libp2p/compare/v0.26.0-rc.3...v0.26.0) (2019-08-07)
+
+
+
+<a name="0.26.0-rc.3"></a>
+# [0.26.0-rc.3](https://github.com/libp2p/js-libp2p/compare/v0.26.0-rc.2...v0.26.0-rc.3) (2019-08-06)
+
+
+### Bug Fixes
+
+* promisified methods ([#398](https://github.com/libp2p/js-libp2p/issues/398)) ([ff7a6c8](https://github.com/libp2p/js-libp2p/commit/ff7a6c8))
+
+
+
+<a name="0.26.0-rc.2"></a>
+# [0.26.0-rc.2](https://github.com/libp2p/js-libp2p/compare/v0.26.0-rc.1...v0.26.0-rc.2) (2019-08-01)
+
+
+### Bug Fixes
+
+* dont override methods of created instance ([#394](https://github.com/libp2p/js-libp2p/issues/394)) ([3e95e6f](https://github.com/libp2p/js-libp2p/commit/3e95e6f))
+* pubsub default config ([#393](https://github.com/libp2p/js-libp2p/issues/393)) ([f4f3f0f](https://github.com/libp2p/js-libp2p/commit/f4f3f0f))
+
+
+### Chores
+
+* update switch ([#395](https://github.com/libp2p/js-libp2p/issues/395)) ([684f283](https://github.com/libp2p/js-libp2p/commit/684f283))
+
+
+### BREAKING CHANGES
+
+* switch configuration has changed.
+'blacklistTTL' is now 'denyTTL' and 'blackListAttempts' is now 'denyAttempts'
+
+
+
+<a name="0.26.0-rc.1"></a>
+# [0.26.0-rc.1](https://github.com/libp2p/js-libp2p/compare/v0.26.0-rc.0...v0.26.0-rc.1) (2019-07-31)
+
+
+
+<a name="0.26.0-rc.0"></a>
+# [0.26.0-rc.0](https://github.com/libp2p/js-libp2p/compare/v0.25.5...v0.26.0-rc.0) (2019-07-31)
+
+
+### Bug Fixes
+
+* make subscribe comply with ipfs interface ([#389](https://github.com/libp2p/js-libp2p/issues/389)) ([9554b05](https://github.com/libp2p/js-libp2p/commit/9554b05))
+
+
+### Features
+
+* integrate gossipsub by default ([#365](https://github.com/libp2p/js-libp2p/issues/365)) ([791f39a](https://github.com/libp2p/js-libp2p/commit/791f39a))
+* promisify all api methods that accept callbacks ([#381](https://github.com/libp2p/js-libp2p/issues/381)) ([df6ef45](https://github.com/libp2p/js-libp2p/commit/df6ef45))
+
+
+### BREAKING CHANGES
+
+* new configuration for deciding the implementation of pubsub to be used.
+In this context, the experimental flags were also removed. See the README for the latest usage.
+* The ipfs interface specified that options
+should be provided after the handler, not before.
+https://github.com/ipfs/interface-js-ipfs-core/blob/v0.109.0/SPEC/PUBSUB.md#pubsubsubscribe
+
+This corrects the order of parameters. See the jsdocs examples
+for subscribe to see how it should be used.
+
+
+
+<a name="0.25.5"></a>
+## [0.25.5](https://github.com/libp2p/js-libp2p/compare/v0.25.4...v0.25.5) (2019-07-12)
+
+
+### Bug Fixes
+
+* peer routing for delegate router ([#377](https://github.com/libp2p/js-libp2p/issues/377)) ([905c911](https://github.com/libp2p/js-libp2p/commit/905c911)), closes [/github.com/libp2p/go-libp2p-core/blob/6e566d10f4a5447317a66d64c7459954b969bdab/routing/query.go#L15-L24](https://github.com//github.com/libp2p/go-libp2p-core/blob/6e566d10f4a5447317a66d64c7459954b969bdab/routing/query.go/issues/L15-L24)
+
+
+
+<a name="0.25.4"></a>
+## [0.25.4](https://github.com/libp2p/js-libp2p/compare/v0.25.3...v0.25.4) (2019-06-07)
+
+
+### Features
+
+* add createLibp2p to generate a PeerInfo instance ([#367](https://github.com/libp2p/js-libp2p/issues/367)) ([04faf18](https://github.com/libp2p/js-libp2p/commit/04faf18))
+* pass libp2p as option to transport creation ([#363](https://github.com/libp2p/js-libp2p/issues/363)) ([b06ca1b](https://github.com/libp2p/js-libp2p/commit/b06ca1b))
+
+
+
+<a name="0.25.3"></a>
+## [0.25.3](https://github.com/libp2p/js-libp2p/compare/v0.25.2...v0.25.3) (2019-05-07)
+
+
+### Features
+
+* sign pubsub messages ([#362](https://github.com/libp2p/js-libp2p/issues/362)) ([40978a1](https://github.com/libp2p/js-libp2p/commit/40978a1))
+
+
+
+<a name="0.25.2"></a>
+## [0.25.2](https://github.com/libp2p/js-libp2p/compare/v0.25.1...v0.25.2) (2019-04-17)
+
+
+### Bug Fixes
+
+* dht config ([#359](https://github.com/libp2p/js-libp2p/issues/359)) ([f3801f0](https://github.com/libp2p/js-libp2p/commit/f3801f0))
+
+
+
+<a name="0.25.1"></a>
+## [0.25.1](https://github.com/libp2p/js-libp2p/compare/v0.25.0...v0.25.1) (2019-04-16)
+
+
+### Bug Fixes
+
+* bail when discovering self ([#357](https://github.com/libp2p/js-libp2p/issues/357)) ([f28dffb](https://github.com/libp2p/js-libp2p/commit/f28dffb))
+
+
+
+<a name="0.25.0"></a>
+# [0.25.0](https://github.com/libp2p/js-libp2p/compare/v0.25.0-rc.6...v0.25.0) (2019-04-12)
+
+
+### Bug Fixes
+
+* allow switch to be configured ([#354](https://github.com/libp2p/js-libp2p/issues/354)) ([eb5aa03](https://github.com/libp2p/js-libp2p/commit/eb5aa03))
+
+
+
+<a name="0.25.0-rc.6"></a>
+# [0.25.0-rc.6](https://github.com/libp2p/js-libp2p/compare/v0.25.0-rc.5...v0.25.0-rc.6) (2019-04-11)
+
+
+### Bug Fixes
+
+* connection emits ([#352](https://github.com/libp2p/js-libp2p/issues/352)) ([313b1ea](https://github.com/libp2p/js-libp2p/commit/313b1ea))
+* remove unneeded peerbook puts ([#348](https://github.com/libp2p/js-libp2p/issues/348)) ([e5f19e8](https://github.com/libp2p/js-libp2p/commit/e5f19e8))
+
+
+### Features
+
+* auto dial discovered peers ([#349](https://github.com/libp2p/js-libp2p/issues/349)) ([01aa447](https://github.com/libp2p/js-libp2p/commit/01aa447))
+
+
+
+<a name="0.25.0-rc.5"></a>
+# [0.25.0-rc.5](https://github.com/libp2p/js-libp2p/compare/v0.25.0-rc.4...v0.25.0-rc.5) (2019-03-21)
+
+
+### Bug Fixes
+
+* disable dht by default [#338](https://github.com/libp2p/js-libp2p/issues/338) ([#339](https://github.com/libp2p/js-libp2p/issues/339)) ([e52ce66](https://github.com/libp2p/js-libp2p/commit/e52ce66))
+
+
+### Features
+
+* update to the latest switch ([#336](https://github.com/libp2p/js-libp2p/issues/336)) ([eee60ed](https://github.com/libp2p/js-libp2p/commit/eee60ed))
+
+
+
+<a name="0.25.0-rc.4"></a>
+# [0.25.0-rc.4](https://github.com/libp2p/js-libp2p/compare/v0.25.0-rc.3...v0.25.0-rc.4) (2019-03-06)
+
+
+
+<a name="0.25.0-rc.3"></a>
+# [0.25.0-rc.3](https://github.com/libp2p/js-libp2p/compare/v0.25.0-rc.2...v0.25.0-rc.3) (2019-02-26)
+
+
+
+<a name="0.25.0-rc.2"></a>
+# [0.25.0-rc.2](https://github.com/libp2p/js-libp2p/compare/v0.25.0-rc.1...v0.25.0-rc.2) (2019-02-26)
+
+
+### Bug Fixes
+
+* make the config less restrictive ([#329](https://github.com/libp2p/js-libp2p/issues/329)) ([5f92acd](https://github.com/libp2p/js-libp2p/commit/5f92acd))
+
+
+
+<a name="0.25.0-rc.1"></a>
+# [0.25.0-rc.1](https://github.com/libp2p/js-libp2p/compare/v0.25.0-rc.0...v0.25.0-rc.1) (2019-02-21)
+
+
+### Bug Fixes
+
+* bundle-size ([#298](https://github.com/libp2p/js-libp2p/issues/298)) ([d497961](https://github.com/libp2p/js-libp2p/commit/d497961))
+* emit peer discovery for dht discovery ([9e7a080](https://github.com/libp2p/js-libp2p/commit/9e7a080))
+
+
+### Features
+
+* support unsubscribe all for pubsub ([#321](https://github.com/libp2p/js-libp2p/issues/321)) ([6e76aad](https://github.com/libp2p/js-libp2p/commit/6e76aad))
+
+
+
+<a name="0.24.4"></a>
+## [0.24.4](https://github.com/libp2p/js-libp2p/compare/v0.24.3...v0.24.4) (2019-01-04)
+
+
+
+<a name="0.24.3"></a>
+## [0.24.3](https://github.com/libp2p/js-libp2p/compare/v0.24.2...v0.24.3) (2018-12-14)
+
+
+### Bug Fixes
+
+* not started yet ([#297](https://github.com/libp2p/js-libp2p/issues/297)) ([fdfb7b4](https://github.com/libp2p/js-libp2p/commit/fdfb7b4))
+
+
+
+<a name="0.24.2"></a>
+## [0.24.2](https://github.com/libp2p/js-libp2p/compare/v0.24.1...v0.24.2) (2018-12-04)
+
+
+### Bug Fixes
+
+* use symbol instead of constructor name ([#292](https://github.com/libp2p/js-libp2p/issues/292)) ([53ed3bd](https://github.com/libp2p/js-libp2p/commit/53ed3bd))
+
+
+
+<a name="0.24.1"></a>
+## [0.24.1](https://github.com/libp2p/js-libp2p/compare/v0.24.0...v0.24.1) (2018-12-03)
+
+
+### Features
+
+* allow configurable validators and selectors to the dht ([#288](https://github.com/libp2p/js-libp2p/issues/288)) ([7d12eb9](https://github.com/libp2p/js-libp2p/commit/7d12eb9))
+
+
+
+<a name="0.24.0"></a>
+# [0.24.0](https://github.com/libp2p/js-libp2p/compare/v0.24.0-rc.3...v0.24.0) (2018-11-16)
+
+### Bug Fixes
+
+* add maxtimeout to dht get ([#248](https://github.com/libp2p/js-libp2p/issues/248)) ([69f7264](https://github.com/libp2p/js-libp2p/commit/69f7264))
+* dht get options ([4460e82](https://github.com/libp2p/js-libp2p/commit/4460e82))
+* dont call callback before it's properly set ([17b5f73](https://github.com/libp2p/js-libp2p/commit/17b5f73))
+* improve get peer info errors ([714b6ec](https://github.com/libp2p/js-libp2p/commit/714b6ec))
+* start kad dht random walk ([#251](https://github.com/libp2p/js-libp2p/issues/251)) ([dd934b9](https://github.com/libp2p/js-libp2p/commit/dd934b9))
+
+### Features
+
+* add datastore to config ([40e840d](https://github.com/libp2p/js-libp2p/commit/40e840d))
+* add delegated peer and content routing support ([#242](https://github.com/libp2p/js-libp2p/issues/242)) ([a95389a](https://github.com/libp2p/js-libp2p/commit/a95389a))
+* add maxNumProviders to findprovs ([#283](https://github.com/libp2p/js-libp2p/issues/283)) ([970deec](https://github.com/libp2p/js-libp2p/commit/970deec))
+* conditionally emit errors ([f71fdfd](https://github.com/libp2p/js-libp2p/commit/f71fdfd))
+* enable relay by default (no hop) ([#254](https://github.com/libp2p/js-libp2p/issues/254)) ([686379e](https://github.com/libp2p/js-libp2p/commit/686379e))
+* make libp2p a state machine ([#257](https://github.com/libp2p/js-libp2p/issues/257)) ([0b75f99](https://github.com/libp2p/js-libp2p/commit/0b75f99))
+* use package-table vs custom script ([a63432e](https://github.com/libp2p/js-libp2p/commit/a63432e))
+
+<a name="0.23.1"></a>
+## [0.23.1](https://github.com/libp2p/js-libp2p/compare/v0.23.0...v0.23.1) (2018-08-13)
+
+
+### Bug Fixes
+
+* callback with error for invalid or non-peer multiaddr ([#232](https://github.com/libp2p/js-libp2p/issues/232)) ([c8a86db](https://github.com/libp2p/js-libp2p/commit/c8a86db))
+
+
+
+<a name="0.23.0"></a>
+# [0.23.0](https://github.com/libp2p/js-libp2p/compare/v0.22.0...v0.23.0) (2018-07-27)
+
+
+### Bug Fixes
+
+* start and stop connection manager with libp2p ([6106915](https://github.com/libp2p/js-libp2p/commit/6106915))
+
+
+### Features
+
+* add check for protector and enforced pnet ([2b7cc55](https://github.com/libp2p/js-libp2p/commit/2b7cc55))
+
+
+
+<a name="0.22.0"></a>
+# [0.22.0](https://github.com/libp2p/js-libp2p/compare/v0.21.0...v0.22.0) (2018-06-29)
+
+
+### Bug Fixes
+
+* add null property guards ([80f0b60](https://github.com/libp2p/js-libp2p/commit/80f0b60))
+* do not mutate the config object ([ac5cacb](https://github.com/libp2p/js-libp2p/commit/ac5cacb))
+* remove .only ([be9eafe](https://github.com/libp2p/js-libp2p/commit/be9eafe))
+* remove peer discovery module config checks ([4ad70ef](https://github.com/libp2p/js-libp2p/commit/4ad70ef))
+* typo in fixture and fail for correct reason ([1af5ba9](https://github.com/libp2p/js-libp2p/commit/1af5ba9))
+
+
+### Features
+
+* enable peer discovery modules by default ([e320854](https://github.com/libp2p/js-libp2p/commit/e320854))
+
+
+
+<a name="0.21.0"></a>
+# [0.21.0](https://github.com/libp2p/js-libp2p/compare/v0.20.4...v0.21.0) (2018-06-28)
+
+
+### Bug Fixes
+
+* lock wrtc to 0.1.1 ([6507379](https://github.com/libp2p/js-libp2p/commit/6507379))
+
+
+### Features
+
+* (BREAKING CHANGE) overhaul libp2p config and constructor ([6905f1b](https://github.com/libp2p/js-libp2p/commit/6905f1b))
+* set and hook up libp2p-connection-manager ([#184](https://github.com/libp2p/js-libp2p/issues/184)) ([d597204](https://github.com/libp2p/js-libp2p/commit/d597204))
+
+
+
+<a name="0.20.4"></a>
+## [0.20.4](https://github.com/libp2p/js-libp2p/compare/v0.20.2...v0.20.4) (2018-04-30)
+
+
+
+<a name="0.20.3"></a>
+## [0.20.3](https://github.com/libp2p/js-libp2p/compare/v0.20.2...v0.20.3) (2018-04-30)
+
+
+
+<a name="0.20.2"></a>
+## [0.20.2](https://github.com/libp2p/js-libp2p/compare/v0.20.1...v0.20.2) (2018-04-10)
+
+
+
+<a name="0.20.1"></a>
+## [0.20.1](https://github.com/libp2p/js-libp2p/compare/v0.20.0...v0.20.1) (2018-04-10)
+
+
+
+<a name="0.20.0"></a>
+# [0.20.0](https://github.com/libp2p/js-libp2p/compare/v0.19.2...v0.20.0) (2018-04-06)
+
+
+### Features
+
+* use class-is for type checks ([bb0c990](https://github.com/libp2p/js-libp2p/commit/bb0c990))
+
+
+
+<a name="0.19.2"></a>
+## [0.19.2](https://github.com/libp2p/js-libp2p/compare/v0.19.0...v0.19.2) (2018-03-28)
+
+
+
+<a name="0.19.1"></a>
+## [0.19.1](https://github.com/libp2p/js-libp2p/compare/v0.19.0...v0.19.1) (2018-03-28)
+
+
+
+<a name="0.19.0"></a>
+# [0.19.0](https://github.com/libp2p/js-libp2p/compare/v0.18.0...v0.19.0) (2018-03-15)
+
+
+
+<a name="0.18.0"></a>
+# [0.18.0](https://github.com/libp2p/js-libp2p/compare/v0.17.0...v0.18.0) (2018-02-19)
+
+
+
+<a name="0.17.0"></a>
+# [0.17.0](https://github.com/libp2p/js-libp2p/compare/v0.16.5...v0.17.0) (2018-02-16)
+
+
+### Bug Fixes
+
+* use correct reference to floodSub ([947eaf1](https://github.com/libp2p/js-libp2p/commit/947eaf1))
+
+
+### Features
+
+* add pubsub to libp2p ([0c543b7](https://github.com/libp2p/js-libp2p/commit/0c543b7))
+
+
+
+<a name="0.16.5"></a>
+## [0.16.5](https://github.com/libp2p/js-libp2p/compare/v0.16.4...v0.16.5) (2018-02-14)
+
+
+
+<a name="0.16.4"></a>
+## [0.16.4](https://github.com/libp2p/js-libp2p/compare/v0.16.3...v0.16.4) (2018-02-09)
+
+
+
+<a name="0.16.3"></a>
+## [0.16.3](https://github.com/libp2p/js-libp2p/compare/v0.16.2...v0.16.3) (2018-02-08)
+
+
+
+<a name="0.16.2"></a>
+## [0.16.2](https://github.com/libp2p/js-libp2p/compare/v0.16.1...v0.16.2) (2018-02-07)
+
+
+
+<a name="0.16.1"></a>
+## [0.16.1](https://github.com/libp2p/js-libp2p/compare/v0.16.0...v0.16.1) (2018-02-07)
+
+
+
+<a name="0.16.0"></a>
+# [0.16.0](https://github.com/libp2p/js-libp2p/compare/v0.15.2...v0.16.0) (2018-02-07)
+
+
+### Features
+
+* add explicit error for case peer id not included in multiaddr ([#155](https://github.com/libp2p/js-libp2p/issues/155)) ([bd8a35a](https://github.com/libp2p/js-libp2p/commit/bd8a35a))
+* dialProtocol and small refactor ([6651401](https://github.com/libp2p/js-libp2p/commit/6651401))
+* use libp2p-switch ([23e8293](https://github.com/libp2p/js-libp2p/commit/23e8293))
+
+
+
+<a name="0.15.2"></a>
+## [0.15.2](https://github.com/libp2p/js-libp2p/compare/v0.15.1...v0.15.2) (2018-01-28)
+
+
+
+<a name="0.15.1"></a>
+## [0.15.1](https://github.com/libp2p/js-libp2p/compare/v0.15.0...v0.15.1) (2018-01-16)
+
+
+### Bug Fixes
+
+* typo in DHT setup ([#151](https://github.com/libp2p/js-libp2p/issues/151)) ([61bebd1](https://github.com/libp2p/js-libp2p/commit/61bebd1))
+
+
+
+<a name="0.15.0"></a>
+# [0.15.0](https://github.com/libp2p/js-libp2p/compare/v0.14.3...v0.15.0) (2018-01-07)
+
+
+
 <a name="0.14.3"></a>
 ## [0.14.3](https://github.com/libp2p/js-libp2p/compare/v0.14.2...v0.14.3) (2017-12-15)
 

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 # Contributing guidelines
 
-libp2p as a project, including js-libp2p and all of its modules, follows the [standard IPFS Community contributing guidelines](https://github.com/ipfs/community/blob/master/contribution-guidelines.md).
+libp2p as a project, including js-libp2p and all of its modules, follows the [standard IPFS Community contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md).
 
-We also adhere to the [IPFS JavaScript Community contributing guidelines](https://github.com/ipfs/community/blob/master/js-project-guidelines.md) which provide additional information of how to collaborate and contribute in the JavaScript implementation of libp2p.
+We also adhere to the [IPFS JavaScript Community contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) which provide additional information of how to collaborate and contribute in the JavaScript implementation of libp2p.
 
 We appreciate your time and attention for going over these. Please open an issue on [ipfs/community](https://github.com/ipfs/community) if you have any question.
 

ISSUE_TEMPLATE.md

@@ -39,5 +39,5 @@ One of following:
 This is for you! Please read, and then delete this text before posting it.
 The js-ipfs issues are only for bug reports and directly actionable features.
 
-Read https://github.com/ipfs/community/blob/master/contributing.md#reporting-issues if your issue doesn't fit either of those categories.
+Read https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#reporting-issues if your issue doesn't fit either of those categories.
 -->

OKR.md

@@ -0,0 +1,19 @@
+# Quarterly Objectives and Key Results
+
+We try to frame our ongoing work using a process based on quarterly Objectives and Key Results (OKRs). Objectives reflect outcomes that are challenging, but realistic. Results are tangible and measurable.
+
+## 2019 Q1
+
+Find the js-libp2p OKRs for 2019 Q1 at the [2019 Q1 libp2p OKRs Spreadsheet](https://docs.google.com/spreadsheets/d/11GKG1DBRIIAiQnHvLD7_IqWxDGsVdaZFpxJM6NWtXe8/edit#gid=1271182838)
+
+## 2018 Q4
+
+Find the js-libp2p OKRs for 2018 Q4 at the [2018 Q4 libp2p OKRs Spreadsheet](https://docs.google.com/spreadsheets/d/1BYwmbVicgo6_tOHAbgiUXWge8Ej0qR1M_gAUulazmrg/edit#gid=1241853194)
+
+## 2018 Q3
+
+Find the js-libp2p OKRs for 2018 Q3 at the [2018 Q3 libp2p OKRs Spreadsheet](https://docs.google.com/spreadsheets/d/1HTXfgR5FyPTFhsTkFPRThkeMvHvCgJOaAs7BSl_vQ_0/edit#gid=1241853194)
+
+## Previous Quarters
+
+For the quarters before 2018 Q3, js-libp2p shared their KRs with the [IPFS OKRs](https://github.com/ipfs/js-ipfs/blob/master/OKR.md).

PEER_DISCOVERY.md

@@ -0,0 +1,60 @@
+# Peer Discovery and Auto Dial
+
+**Synopsis**:
+* All peers discovered are emitted via `peer:discovery` so applications can take any desired action.
+* Libp2p defaults to automatically connecting to new peers, when under the [ConnectionManager](https://github.com/libp2p/js-libp2p-connection-manager) low watermark (minimum peers).
+  * Applications can disable this via the `peerDiscovery.autoDial` config property, and handle connections themselves.
+  * Applications who have not disabled this should **never** connect on peer discovery. Applications should use the `peer:connect` event if they wish to take a specific action on new peers.
+
+## Scenarios
+In any scenario, if a peer is discovered it should be added to the PeerBook. This ensures that even if we don't dial to a node when we discover it, we know about it in the event that it becomes known as a provider for something we need. The scenarios listed below detail what actions the auto dialer will take when peers are discovered.
+
+### 1. Joining the network
+The node is new and needs to join the network. It currently has 0 peers.
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery)
+
+### Action to take
+Connect to discovered peers. This should have some degree of concurrency limiting. While the case should be low, if we immediately discover more peers than our high watermark we should avoid dialing them all.
+
+### 2. Connected to some
+The node is connected to other nodes. The current number of connections is less than the desired low watermark.
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery) and [Active Discovery](#active-discovery)
+
+### Action to take
+Connect to discovered peers. This should have some degree of concurrency limiting. The concurrency may need to be modified to reflect the current number of peers connected. The more peers we have, the lower the concurrency may need to be.
+
+### 3. Connected to enough
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery) and [Active Discovery](#active-discovery)
+
+### Action to take
+None. If we are connected to enough peers, the low watermark, we should not connect to discovered peers. As other peers discover us, they may connect to us based on their current scenario.
+
+For example, a long running node with adequate peers is on an MDNS network. A new peer joins the network and both become aware of each other. The new peer should be the peer that dials, as it has too few peers. The existing node has no reason to dial the new peer, but should keep a record of it in case it later becomes an important node due to its contents/capabilities.
+
+Avoiding dials above the low watermark also allows for a pool of connections to be reserved for application specific actions, such as connecting to a specific content provider via a DHT query to find that content (ipfs-bitswap).
+
+### 4. Connected to too many
+The node has more connections than it wants. The current number of connections is greater than the high watermark.
+
+[WIP Connection Manager v2 spec](https://github.com/libp2p/specs/pull/161)
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery) and [Active Discovery](#active-discovery)
+
+### Action to take
+None, the `ConnectionManager` will automatically prune connections.
+
+## Discovery Mechanisms
+Means of which a libp2p node discovers other peers.
+
+### Active Discovery
+Through active use of the libp2p network, a node may discovery peers.
+
+* Content/Peer routing (DHT, delegated, etc) provider and peer queries
+* DHT random walk
+* Rendezvous servers
+
+### Ambient Discovery
+Leveraging known addresses, or network discovery mechanisms, a node may discover peers outside of the bounds of the libp2p network.
+
+* Bootstrap
+* MDNS
+* proximity based (bluetooth, sound, etc)

README.md

@@ -1,20 +1,22 @@
 <h1 align="center">
-  <a href="libp2p.io"><img width="250" src="https://github.com/libp2p/libp2p/blob/master/logo/alternates/libp2p-logo-alt-2.png?raw=true" alt="libp2p hex logo" /></a>
+  <a href="libp2p.io"><img width="250" src="https://github.com/libp2p/libp2p/blob/master/logo/black-bg-2.png?raw=true" alt="libp2p hex logo" /></a>
 </h1>
 
 <h3 align="center">The JavaScript implementation of the libp2p Networking Stack.</h3>
 
 <p align="center">
   <a href="http://ipn.io"><img src="https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square" /></a>
-  <a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-blue.svg?style=flat-square" /></a>
-  <a href="http://webchat.freenode.net/?channels=%23ipfs"><img src="https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square" /></a>
-  <a href="https://waffle.io/libp2p/libp2p"><img src="https://img.shields.io/badge/pm-waffle-blue.svg?style=flat-square" /></a>
+  <a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" /></a>
+  <a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" /></a>
+  <a href="https://riot.permaweb.io/#/room/#libp2p:permaweb.io"><img src="https://img.shields.io/badge/matrix-%23libp2p%3Apermaweb.io-blue.svg?style=flat-square" /> </a>
+  <a href="https://discord.gg/66KBrm2"><img src="https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord&style=flat-square" /></a>
+  <a href="https://discuss.libp2p.io"><img src="https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg" /></a>
 </p>
 
 <p align="center">
-  <a href="https://travis-ci.org/libp2p/js-libp2p"><img src="https://travis-ci.org/libp2p/js-libp2p.svg?branch=master" /></a>
-  <a href="https://circleci.com/gh/libp2p/js-libp2p"><img src="https://circleci.com/gh/libp2p/js-libp2p.svg?style=svg" /></a>
-  <a href="https://coveralls.io/github/libp2p/js-libp2p?branch=master"><img src="https://coveralls.io/repos/github/libp2p/js-libp2p/badge.svg?branch=master"></a>
+  <a href="https://travis-ci.com/libp2p/js-libp2p"><img src="https://flat.badgen.net/travis/libp2p/js-libp2p" /></a>
+  <a href="https://codecov.io/gh/libp2p/js-libp2p"><img src="https://img.shields.io/codecov/c/github/ipfs/js-ipfs-multipart/master.svg?style=flat-square"></a>
+  <a href="https://bundlephobia.com/result?p=ipfsd-ctl"><img src="https://flat.badgen.net/bundlephobia/minzip/ipfsd-ctl"></a>
   <br>
   <a href="https://david-dm.org/libp2p/js-libp2p"><img src="https://david-dm.org/libp2p/js-libp2p.svg?style=flat-square" /></a>
   <a href="https://github.com/feross/standard"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"></a>
@@ -28,9 +30,17 @@
 
 We've come a long way, but this project is still in Alpha, lots of development is happening, API might change, beware of the Dragons 🐉..
 
-**Want to get started?** Check our [examples folder](/examples). You can check the development status at the [Waffle Board](https://waffle.io/libp2p/js-libp2p).
+**Want to get started?** Check our [examples folder](/examples).
 
-[![Throughput Graph](https://graphs.waffle.io/libp2p/js-libp2p/throughput.svg)](https://waffle.io/libp2p/js-libp2p/metrics/throughput)
+[**`Weekly Core Dev Calls`**](https://github.com/ipfs/pm/issues/650)
+
+## Tech Lead
+
+[David Dias](https://github.com/diasdavid/)
+
+## Lead Maintainer
+
+[Jacob Heun](https://github.com/jacobheun/)
 
 ## Table of Contents
 
@@ -40,6 +50,7 @@ We've come a long way, but this project is still in Alpha, lots of development i
   - [Install](#install)
   - [Usage](#usage)
   - [API](#api)
+    - [Events](#events)
 - [Development](#development)
   - [Tests](#tests)
   - [Packages](#packages)
@@ -53,7 +64,9 @@ libp2p is the product of a long and arduous quest to understand the evolution of
 We are in the process of writing better documentation, blog posts, tutorials and a formal specification. Today you can find:
 
 - [libp2p.io](https://libp2p.io)
+- [docs.libp2p.io](https://docs.libp2p.io)
 - [Specification (WIP)](https://github.com/libp2p/specs)
+- [Discussion Forums](https://discuss.libp2p.io)
 - Talks
   - [`libp2p <3 ethereum` at DEVCON2](https://ethereumfoundation.org/devcon/?session=libp2p) [📼 video](https://www.youtube.com/watch?v=HxueJbeMVG4) [slides](https://ethereumfoundation.org/devcon/wp-content/uploads/2016/10/libp2p-HEART-devp2p-IPFS-PLUS-Ethereum-networking.pdf) [📼 demo-1](https://ethereumfoundation.org/devcon/wp-content/uploads/2016/10/libp2p_demo1-1.mp4) [📼 demo-2](https://ethereumfoundation.org/devcon/wp-content/uploads/2016/10/libp2p_demo2-1.mp4)
 - Articles
@@ -80,123 +93,220 @@ npm install --save libp2p
 
 ## Usage
 
+**IMPORTANT NOTE**: We are currently on the way of migrating all our `libp2p` modules to use `async await` and `async iterators`, instead of callbacks and `pull-streams`. As a consequence, when you start a new libp2p project, we must check which versions of the modules you should use. For now, it is required to use the modules using callbacks with `libp2p`, while we are working on getting the remaining modules ready for a full migration. For more details, you can have a look at [libp2p/js-libp2p#266](https://github.com/libp2p/js-libp2p/issues/266).
+
 ### [Tutorials and Examples](/examples)
 
 You can find multiple examples on the [examples folder](/examples) that will guide you through using libp2p for several scenarios.
 
-### Extending libp2p skeleton
+### Creating your own libp2p bundle
 
-libp2p becomes very simple and basically acts as a glue for every module that compose this library. Since it can be highly customized, it requires some setup. What we recommend is to have a libp2p build for the system you are developing taking into account in your needs (e.g. for a browser working version of libp2p that acts as the network layer of IPFS, we have a built and minified version that browsers can require).
+The libp2p module acts as a glue for every libp2p module that you can use to create your own libp2p bundle. Creating your own libp2p bundle gives you a lot of freedom when it comes to customize it with features and default setup. We recommend creating your own libp2p bundle for the app you are developing that takes in account your needs (e.g. for a browser working version of libp2p that acts as the network layer of IPFS, we have a built one that leverages the Browser transports).
 
 **Example:**
 
 ```JavaScript
 // Creating a bundle that adds:
 //   transport: websockets + tcp
-//   stream-muxing: SPDY
+//   stream-muxing: spdy & mplex
 //   crypto-channel: secio
 //   discovery: multicast-dns
 
-const libp2p = require('libp2p')
+const Libp2p = require('libp2p')
 const TCP = require('libp2p-tcp')
 const WS = require('libp2p-websockets')
-const spdy = require('libp2p-spdy')
-const secio = require('libp2p-secio')
+const SPDY = require('libp2p-spdy')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
 const MulticastDNS = require('libp2p-mdns')
 const DHT = require('libp2p-kad-dht')
+const GossipSub = require('libp2p-gossipsub')
+const defaultsDeep = require('@nodeutils/defaults-deep')
+const Protector = require('libp2p-pnet')
+const DelegatedPeerRouter = require('libp2p-delegated-peer-routing')
+const DelegatedContentRouter = require('libp2p-delegated-content-routing')
 
-class Node extends libp2p {
-  constructor (peerInfo, peerBook, options) {
-    options = options || {}
-
-    const modules = {
-      transport: [
-        new TCP(),
-        new WS()
-      ],
-      connection: {
-        muxer: [
-          spdy
+class Node extends Libp2p {
+  constructor (_options) {
+    const peerInfo = _options.peerInfo
+    const defaults = {
+      // The libp2p modules for this libp2p bundle
+      modules: {
+        transport: [
+          TCP,
+          new WS()                    // It can take instances too!
         ],
-        crypto: [
-          secio
-        ]
+        streamMuxer: [
+          SPDY,
+          MPLEX
+        ],
+        connEncryption: [
+          SECIO
+        ],
+        /** Encryption for private networks. Needs additional private key to work **/
+        // connProtector: new Protector(/*protector specific opts*/),
+        /** Enable custom content routers, such as delegated routing **/
+        // contentRouting: [
+        //   new DelegatedContentRouter(peerInfo.id)
+        // ],
+        /** Enable custom peer routers, such as delegated routing **/
+        // peerRouting: [
+        //   new DelegatedPeerRouter()
+        // ],
+        peerDiscovery: [
+          MulticastDNS
+        ],
+        dht: DHT,                      // DHT enables PeerRouting, ContentRouting and DHT itself components
+        pubsub: GossipSub
       },
-      discovery: [
-        new MulticastDNS(peerInfo)
-      ],
-      // DHT is passed as its own enabling PeerRouting, ContentRouting and DHT itself components
-      dht: DHT
+
+      // libp2p config options (typically found on a config.json)
+      config: {                       // The config object is the part of the config that can go into a file, config.json.
+        peerDiscovery: {
+          autoDial: true,             // Auto connect to discovered peers (limited by ConnectionManager minPeers)
+          mdns: {                     // mdns options
+            interval: 1000,           // ms
+            enabled: true
+          },
+          webrtcStar: {               // webrtc-star options
+            interval: 1000,           // ms
+            enabled: false
+          }
+          // .. other discovery module options.
+        },
+        relay: {                      // Circuit Relay options
+          enabled: true,
+          hop: {
+            enabled: false,
+            active: false
+          }
+        },
+        dht: {
+          kBucketSize: 20,
+          enabled: true,
+          randomWalk: {
+            enabled: true,      // Allows to disable discovery (enabled by default)
+            interval: 300e3,
+            timeout: 10e3
+          }
+        },
+        pubsub: {
+          enabled: true,
+          emitSelf: true,      // whether the node should emit to self on publish, in the event of the topic being subscribed
+          signMessages: true,  // if messages should be signed
+          strictSigning: true  // if message signing should be required
+        }
+      }
     }
 
-    super(modules, peerInfo, peerBook, options)
+    // overload any defaults of your bundle using https://github.com/nodeutils/defaults-deep
+    super(defaultsDeep(_options, defaults))
   }
 }
 
-// Now all the nodes you create, will have TCP, WebSockets, SPDY, SECIO and MulticastDNS support.
+// Now all the nodes you create, will have TCP, WebSockets, SPDY, MPLEX, SECIO and MulticastDNS support.
 ```
 
 ### API
 
-#### Create a Node - `new libp2p.Node([peerInfo, peerBook, options])`
+**IMPORTANT NOTE**: All the methods listed in the API section that take a callback are also now Promisified. Libp2p is migrating away from callbacks to async/await, and in a future release (that will be announced in advance), callback support will be removed entirely. You can follow progress of the async/await endeavor at https://github.com/ipfs/js-ipfs/issues/1670.
 
-> Creates an instance of the libp2p.Node.
+#### Create a Node - `Libp2p.createLibp2p(options, callback)`
 
-- `peerInfo`: instance of [PeerInfo][] that contains the [PeerId][], Keys and [multiaddrs][multiaddr] of the libp2p Node. Optional.
-- `peerBook`: instance of [PeerBook][] that contains the [PeerInfo][] of known peers. Optional.
-- `options`: Object containing custom options for the bundle.
+> Behaves exactly like `new Libp2p(options)`, but doesn't require a PeerInfo. One will be generated instead
+
+```js
+const { createLibp2p } = require('libp2p')
+createLibp2p(options, (err, libp2p) => {
+  if (err) throw err
+  libp2p.start((err) => {
+    if (err) throw err
+  })
+})
+```
+
+- `options`: Object of libp2p configuration options
+- `callback`: Function with signature `function (Error, Libp2p) {}`
+
+#### Create a Node alternative - `new Libp2p(options)`
+
+> Creates an instance of Libp2p with a custom `PeerInfo` provided via `options.peerInfo`.
+
+Required keys in the `options` object:
+
+- `peerInfo`: instance of [PeerInfo][] that contains the [PeerId][], Keys and [multiaddrs][multiaddr] of the libp2p Node.
+- `modules.transport`: An array that must include at least 1 transport, such as `libp2p-tcp`.
 
 #### `libp2p.start(callback)`
 
 > Start the libp2p Node.
 
-`callback` is a function with the following `function (err) {}` signature, where `err` is an Error in case starting the node fails.
+`callback` following signature `function (err) {}`, where `err` is an Error in case starting the node fails.
 
 #### `libp2p.stop(callback)`
 
 > Stop the libp2p Node.
 
-`callback` is a function with the following `function (err) {}` signature, where `err` is an Error in case stopping the node fails.
+`callback` following signature `function (err) {}`, where `err` is an Error in case stopping the node fails.
 
-#### `libp2p.dial(peer [, protocol, callback])`
+#### `libp2p.dial(peer, callback)`
 
-> Dials to another peer in the network.
+> Dials to another peer in the network, establishes the connection.
 
-- `peer`: can be an instance of [PeerInfo][], [PeerId][] or [multiaddr][]
+- `peer`: can be an instance of [PeerInfo][], [PeerId][], [multiaddr][], or a multiaddr string
+- `callback` following signature `function (err, conn) {}`, where `err` is an Error in of failure to dial the connection and `conn` is a [Connection][] instance in case of a protocol selected, if not it is undefined.
+
+#### `libp2p.dialProtocol(peer, protocol, callback)`
+
+> Dials to another peer in the network and selects a protocol to talk with that peer.
+
+- `peer`: can be an instance of [PeerInfo][], [PeerId][], [multiaddr][], or a multiaddr string
 - `protocol`: String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')
+- `callback`: Function with signature `function (err, conn) {}`, where `conn` is a [Connection](https://github.com/libp2p/interface-connection) object
 
-`callback` is a function with the following `function (err, conn) {}` signature, where `err` is an Error in of failure to dial the connection and `conn` is a [Connection][] instance in case of a protocol selected, if not it is undefined.
+`callback` following signature `function (err, conn) {}`, where `err` is an Error in of failure to dial the connection and `conn` is a [Connection][] instance in case of a protocol selected, if not it is undefined.
 
-#### `libp2p.hangUp(peer, callback)
+#### `libp2p.dialFSM(peer, protocol, callback)`
+
+> Behaves like `.dial` and `.dialProtocol` but calls back with a Connection State Machine
+
+- `peer`: can be an instance of [PeerInfo][], [PeerId][], [multiaddr][], or a multiaddr string
+- `protocol`: an optional String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')
+- `callback`: following signature `function (err, connFSM) {}`, where `connFSM` is a [Connection State Machine](https://github.com/libp2p/js-libp2p-switch#connection-state-machine)
+
+#### `libp2p.hangUp(peer, callback)`
 
 > Closes an open connection with a peer, graciously.
 
 - `peer`: can be an instance of [PeerInfo][], [PeerId][] or [multiaddr][]
 
-`callback` is a function with the following `function (err) {}` signature, where `err` is an Error in case stopping the node fails.
+`callback` following signature `function (err) {}`, where `err` is an Error in case stopping the node fails.
 
-#### `libp2p.peerRouting.findPeer(id, callback)`
+#### `libp2p.peerRouting.findPeer(id, options, callback)`
 
 > Looks up for multiaddrs of a peer in the DHT
 
 - `id`: instance of [PeerId][]
+- `options`: object of options
+- `options.maxTimeout`: Number milliseconds
 
-#### `libp2p.contentRouting.findProviders(key, timeout, callback)`
+#### `libp2p.contentRouting.findProviders(key, options, callback)`
 
 - `key`: Buffer
-- `timeout`: Number miliseconds
+- `options`: object of options
+- `options.maxTimeout`: Number milliseconds
+- `options.maxNumProviders` maximum number of providers to find
 
 #### `libp2p.contentRouting.provide(key, callback)`
 
 - `key`: Buffer
 
-
 #### `libp2p.handle(protocol, handlerFunc [, matchFunc])`
 
 > Handle new protocol
 
 - `protocol`: String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')
-- `handlerFunc`: Function with signature `function (protocol, conn) {}`
+- `handlerFunc`: following signature `function (protocol, conn) {}`, where `conn` is a [Connection](https://github.com/libp2p/interface-connection) object
 - `matchFunc`: Function for matching on protocol (exact matching, semver, etc). Default to exact match.
 
 #### `libp2p.unhandle(protocol)`
@@ -205,21 +315,52 @@ class Node extends libp2p {
 
 - `protocol`: String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')
 
-#### `libp2p.on('peer:discovery', (peer) => {})`
+#### Events
+
+##### `libp2p.on('start', () => {})`
+
+> Libp2p has started, along with all its services.
+
+##### `libp2p.on('stop', () => {})`
+
+> Libp2p has stopped, along with all its services.
+
+##### `libp2p.on('error', (err) => {})`
+
+> An error has occurred
+
+- `err`: instance of `Error`
+
+##### `libp2p.on('peer:discovery', (peer) => {})`
 
 > Peer has been discovered.
 
-- `peer`: instance of [PeerInfo][]
-
-#### `libp2p.on('peer:connect', (peer) => {})`
-
-> We connected to a new peer
+If `autoDial` is `true`, applications should **not** attempt to connect to the peer
+unless they are performing a specific action. See [peer discovery and auto dial](./PEER_DISCOVERY.md) for more information.
 
 - `peer`: instance of [PeerInfo][]
 
-#### `libp2p.on('peer:disconnect', (peer) => {})`
+##### `libp2p.on('peer:connect', (peer) => {})`
 
-> We disconnected from Peer
+> We have a new muxed connection to a peer
+
+- `peer`: instance of [PeerInfo][]
+
+##### `libp2p.on('peer:disconnect', (peer) => {})`
+
+> We have closed a connection to a peer
+
+- `peer`: instance of [PeerInfo][]
+
+##### `libp2p.on('connection:start', (peer) => {})`
+
+> We created a new connection to a peer
+
+- `peer`: instance of [PeerInfo][]
+
+##### `libp2p.on('connection:end', (peer) => {})`
+
+> We closed a connection to a peer
 
 - `peer`: instance of [PeerInfo][]
 
@@ -239,23 +380,31 @@ class Node extends libp2p {
 
 > PeerInfo instance of the node
 
+#### `libp2p.pubsub`
+
+> Same API as IPFS PubSub, defined in the [CORE API Spec](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PUBSUB.md). Just replace `ipfs` by `libp2p` and you are golden.
+
 ---------------------
 
-`DHT methods exposed`
+`DHT methods also exposed for the time being`
 
 #### `libp2p.dht.put(key, value, callback)`
 
 - `key`: Buffer
 - `value`: Buffer
 
-#### `libp2p.dht.get(key, callback)`
+#### `libp2p.dht.get(key, options, callback)`
 
 - `key`: Buffer
+- `options`: object of options
+- `options.maxTimeout`: Number milliseconds
 
-#### `libp2p.dht.getMany(key, nVals, callback)`
+#### `libp2p.dht.getMany(key, nVals, options, callback)`
 
 - `key`: Buffer
 - `nVals`: Number
+- `options`: object of options
+- `options.maxTimeout`: Number milliseconds
 
 [PeerInfo]: https://github.com/libp2p/js-peer-info
 [PeerId]: https://github.com/libp2p/js-peer-id
@@ -263,6 +412,123 @@ class Node extends libp2p {
 [multiaddr]: https://github.com/multiformats/js-multiaddr
 [Connection]: https://github.com/libp2p/interface-connection
 
+-------
+
+### Switch Stats API
+
+##### `libp2p.stats.emit('update')`
+
+Every time any stat value changes, this object emits an `update` event.
+
+#### Global stats
+
+##### `libp2p.stats.global.snapshot`
+
+Should return a stats snapshot, which is an object containing the following keys and respective values:
+
+- dataSent: amount of bytes sent, [Big](https://github.com/MikeMcl/big.js#readme) number
+- dataReceived: amount of bytes received, [Big](https://github.com/MikeMcl/big.js#readme) number
+
+##### `libp2p.stats.global.movingAverages`
+
+Returns an object containing the following keys:
+
+- dataSent
+- dataReceived
+
+Each one of them contains an object that has a key for each interval (`60000`, `300000` and `900000` miliseconds).
+
+Each one of these values is [an exponential moving-average instance](https://github.com/pgte/moving-average#readme).
+
+#### Per-transport stats
+
+##### `libp2p.stats.transports()`
+
+Returns an array containing the tags (string) for each observed transport.
+
+##### `libp2p.stats.forTransport(transportTag).snapshot`
+
+Should return a stats snapshot, which is an object containing the following keys and respective values:
+
+- dataSent: amount of bytes sent, [Big](https://github.com/MikeMcl/big.js#readme) number
+- dataReceived: amount of bytes received, [Big](https://github.com/MikeMcl/big.js#readme) number
+
+##### `libp2p.stats.forTransport(transportTag).movingAverages`
+
+Returns an object containing the following keys:
+
+ dataSent
+ dataReceived
+
+Each one of them contains an object that has a key for each interval (`60000`, `300000` and `900000` miliseconds).
+
+Each one of these values is [an exponential moving-average instance](https://github.com/pgte/moving-average#readme).
+
+#### Per-protocol stats
+
+##### `libp2p.stats.protocols()`
+
+Returns an array containing the tags (string) for each observed protocol.
+
+##### `libp2p.stats.forProtocol(protocolTag).snapshot`
+
+Should return a stats snapshot, which is an object containing the following keys and respective values:
+
+- dataSent: amount of bytes sent, [Big](https://github.com/MikeMcl/big.js#readme) number
+- dataReceived: amount of bytes received, [Big](https://github.com/MikeMcl/big.js#readme) number
+
+
+##### `libp2p.stats.forProtocol(protocolTag).movingAverages`
+
+Returns an object containing the following keys:
+
+- dataSent
+- dataReceived
+
+Each one of them contains an object that has a key for each interval (`60000`, `300000` and `900000` miliseconds).
+
+Each one of these values is [an exponential moving-average instance](https://github.com/pgte/moving-average#readme).
+
+#### Per-peer stats
+
+##### `libp2p.stats.peers()`
+
+Returns an array containing the peerIDs (B58-encoded string) for each observed peer.
+
+##### `libp2p.stats.forPeer(peerId:String).snapshot`
+
+Should return a stats snapshot, which is an object containing the following keys and respective values:
+
+- dataSent: amount of bytes sent, [Big](https://github.com/MikeMcl/big.js#readme) number
+- dataReceived: amount of bytes received, [Big](https://github.com/MikeMcl/big.js#readme) number
+
+
+##### `libp2p.stats.forPeer(peerId:String).movingAverages`
+
+Returns an object containing the following keys:
+
+- dataSent
+- dataReceived
+
+Each one of them contains an object that has a key for each interval (`60000`, `300000` and `900000` miliseconds).
+
+Each one of these values is [an exponential moving-average instance](https://github.com/pgte/moving-average#readme).
+
+#### Stats update interval
+
+Stats are not updated in real-time. Instead, measurements are buffered and stats are updated at an interval. The maximum interval can be defined through the `Switch` constructor option `stats.computeThrottleTimeout`, defined in miliseconds.
+
+### Private Networks
+
+#### Enforcement
+
+Libp2p provides support for connection protection, such as for private networks. You can enforce network protection by setting the environment variable `LIBP2P_FORCE_PNET=1`. When this variable is on, if no protector is set via `options.connProtector`, Libp2p will throw an error upon creation.
+
+#### Protectors
+
+Some available network protectors:
+* [libp2p-pnet](https://github.com/libp2p/js-libp2p-pnet)
+
 ## Development
 
 **Clone and install dependencies:**
@@ -288,53 +554,58 @@ class Node extends libp2p {
 > npm run test:browser
 ```
 
-#### Run interop tests
-
-```sh
-N/A
-```
-
-#### Run benchmark tests
-
-```sh
-N/A
-```
-
 ### Packages
 
 List of packages currently in existence for libp2p
 
-| Package | Version | Dependencies | DevDependencies |
-|---------|---------|--------------|-----------------|
-| **Transports**                                     |
-| [`libp2p-utp`](//github.com/libp2p/js-libp2p-utp) | [![npm](https://img.shields.io/npm/v/libp2p-utp.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-utp/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-utp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-utp) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-utp/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-utp?type=dev) |
-| [`libp2p-websockets`](//github.com/libp2p/js-libp2p-websockets) | [![npm](https://img.shields.io/npm/v/libp2p-websockets.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-websockets/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-websockets.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websockets) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-websockets/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websockets?type=dev) |
-| [`libp2p-webrtc-star`](//github.com/libp2p/js-libp2p-webrtc-star) | [![npm](https://img.shields.io/npm/v/libp2p-webrtc-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-webrtc-star/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-webrtc-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-star) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-webrtc-star/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-star?type=dev) |
-| **Connection Upgrades**                            |
-| [`interface-connection`](//github.com/libp2p/interface-connection) | [![npm](https://img.shields.io/npm/v/interface-connection.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-connection/releases) | [![Dependency Status](https://david-dm.org/libp2p/interface-connection.svg?style=flat-square)](https://david-dm.org/libp2p/interface-connection) | [![devDependency Status](https://david-dm.org/libp2p/interface-connection/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/interface-connection?type=dev) |
-| **Stream Muxers**                                  |
-| [`interface-stream-muxer`](//github.com/libp2p/interface-stream-muxer) | [![npm](https://img.shields.io/npm/v/interface-stream-muxer.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-stream-muxer/releases) | [![Dependency Status](https://david-dm.org/libp2p/interface-stream-muxer.svg?style=flat-square)](https://david-dm.org/libp2p/interface-stream-muxer) | [![devDependency Status](https://david-dm.org/libp2p/interface-stream-muxer/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/interface-stream-muxer?type=dev) |
-| [`libp2p-spdy`](//github.com/libp2p/js-libp2p-spdy) | [![npm](https://img.shields.io/npm/v/libp2p-spdy.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-spdy/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-spdy.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-spdy) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-spdy/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-spdy?type=dev) |
-| [`libp2p-multiplex`](https://github.com/libp2p/js-libp2p-multiplex)
-| **Discovery**                                       |
-| [`libp2p-mdns-discovery`](//github.com/libp2p/js-libp2p-mdns-discovery) | [![npm](https://img.shields.io/npm/v/libp2p-mdns-discovery.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-mdns-discovery/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-mdns-discovery.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-mdns-discovery) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-mdns-discovery/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-mdns-discovery?type=dev) |
-| [`libp2p-railing`](//github.com/libp2p/js-libp2p-railing) | [![npm](https://img.shields.io/npm/v/libp2p-railing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-railing/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-railing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-railing) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-railing/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-railing?type=dev) |
-| **Crypto Channels**                                |
-| [`libp2p-secio`](//github.com/libp2p/js-libp2p-secio) | [![npm](https://img.shields.io/npm/v/libp2p-secio.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-secio/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-secio.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-secio) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-secio/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-secio?type=dev) |
-| **Peer Routing**                                     |
-| [`libp2p-kad-routing`](//github.com/libp2p/js-libp2p-kad-routing) | [![npm](https://img.shields.io/npm/v/libp2p-kad-routing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-routing/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-kad-routing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-routing) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-kad-routing/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-routing?type=dev) |
-| **Content Routing**                                |
-| [`interface-record-store`](//github.com/libp2p/interface-record-store) | [![npm](https://img.shields.io/npm/v/interface-record-store.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-record-store/releases) | [![Dependency Status](https://david-dm.org/libp2p/interface-record-store.svg?style=flat-square)](https://david-dm.org/libp2p/interface-record-store) | [![devDependency Status](https://david-dm.org/libp2p/interface-record-store/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/interface-record-store?type=dev) |
-| [`libp2p-record`](//github.com/libp2p/js-libp2p-record) | [![npm](https://img.shields.io/npm/v/libp2p-record.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-record/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-record.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-record) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-record/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-record?type=dev) |
-| [`libp2p-distributed-record-store`](//github.com/libp2p/js-libp2p-distributed-record-store) | [![npm](https://img.shields.io/npm/v/undefined.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-distributed-record-store/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-distributed-record-store.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-distributed-record-store) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-distributed-record-store/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-distributed-record-store?type=dev) |
-| [`libp2p-kad-record-store`](//github.com/libp2p/js-libp2p-kad-record-store) | [![npm](https://img.shields.io/npm/v/libp2p-kad-record-store.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-record-store/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-kad-record-store.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-record-store) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-kad-record-store/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-record-store?type=dev) |
-| **Generics**                                        |
-| [`libp2p-swarm`](//github.com/libp2p/js-libp2p-swarm) | [![npm](https://img.shields.io/npm/v/libp2p-swarm.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-swarm/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-swarm.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-swarm) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-swarm/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-swarm?type=dev) |
-| [`libp2p-ping`](//github.com/libp2p/js-libp2p-ping) | [![npm](https://img.shields.io/npm/v/libp2p-ping.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-ping/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-ping.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-ping) | [![devDependency Status](https://david-dm.org/libp2p/js-libp2p-ping/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-ping?type=dev) |
-| [`multistream-select`](//github.com/libp2p/js-multistream) | [![npm](https://img.shields.io/npm/v/multistream-select.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-multistream/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-multistream.svg?style=flat-square)](https://david-dm.org/libp2p/js-multistream) | [![devDependency Status](https://david-dm.org/libp2p/js-multistream/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-multistream?type=dev) |
-| **Data Types**                                      |
-| [`peer-book`](//github.com/libp2p/js-peer-book) | [![npm](https://img.shields.io/npm/v/peer-book.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-peer-book/releases) | [![Dependency Status](https://david-dm.org/libp2p/js-peer-book.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-book) | [![devDependency Status](https://david-dm.org/libp2p/js-peer-book/dev-status.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-book?type=dev) |
-| [`peer-id`](https://github.com/libp2p/js-peer-id)
+> This table is generated using the module `package-table` with `package-table --data=package-list.json`.
+
+| Package | Version | Deps | CI | Coverage | Lead Maintainer |
+| ---------|---------|---------|---------|---------|--------- |
+| **Libp2p** |
+| [`interface-libp2p`](//github.com/libp2p/interface-libp2p) | [![npm](https://img.shields.io/npm/v/interface-libp2p.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-libp2p/releases) | [![Deps](https://david-dm.org/libp2p/interface-libp2p.svg?style=flat-square)](https://david-dm.org/libp2p/interface-libp2p) | [![Travis CI](https://travis-ci.com/libp2p/interface-libp2p.svg?branch=master)](https://travis-ci.com/libp2p/interface-libp2p) | [![codecov](https://codecov.io/gh/libp2p/interface-libp2p/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-libp2p) | N/A |
+| [`libp2p`](//github.com/libp2p/js-libp2p) | [![npm](https://img.shields.io/npm/v/libp2p.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **Connection** |
+| [`interface-connection`](//github.com/libp2p/interface-connection) | [![npm](https://img.shields.io/npm/v/interface-connection.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-connection/releases) | [![Deps](https://david-dm.org/libp2p/interface-connection.svg?style=flat-square)](https://david-dm.org/libp2p/interface-connection) | [![Travis CI](https://travis-ci.com/libp2p/interface-connection.svg?branch=master)](https://travis-ci.com/libp2p/interface-connection) | [![codecov](https://codecov.io/gh/libp2p/interface-connection/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-connection) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **Transport** |
+| [`interface-transport`](//github.com/libp2p/interface-transport) | [![npm](https://img.shields.io/npm/v/interface-transport.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-transport/releases) | [![Deps](https://david-dm.org/libp2p/interface-transport.svg?style=flat-square)](https://david-dm.org/libp2p/interface-transport) | [![Travis CI](https://travis-ci.com/libp2p/interface-transport.svg?branch=master)](https://travis-ci.com/libp2p/interface-transport) | [![codecov](https://codecov.io/gh/libp2p/interface-transport/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-transport) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-tcp`](//github.com/libp2p/js-libp2p-tcp) | [![npm](https://img.shields.io/npm/v/libp2p-tcp.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-tcp/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-tcp.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-tcp) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-tcp/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-tcp) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-utp`](//github.com/libp2p/js-libp2p-utp) | [![npm](https://img.shields.io/npm/v/libp2p-utp.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-utp/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-utp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-utp) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-utp.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-utp) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-utp/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-utp) | N/A |
+| [`libp2p-webrtc-direct`](//github.com/libp2p/js-libp2p-webrtc-direct) | [![npm](https://img.shields.io/npm/v/libp2p-webrtc-direct.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-webrtc-direct/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-webrtc-direct.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-direct) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-webrtc-direct.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-webrtc-direct) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-webrtc-direct/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-direct) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| [`libp2p-webrtc-star`](//github.com/libp2p/js-libp2p-webrtc-star) | [![npm](https://img.shields.io/npm/v/libp2p-webrtc-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-webrtc-star/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-webrtc-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-star) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-webrtc-star.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-webrtc-star) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| [`libp2p-websockets`](//github.com/libp2p/js-libp2p-websockets) | [![npm](https://img.shields.io/npm/v/libp2p-websockets.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-websockets/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-websockets.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websockets) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-websockets.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-websockets) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-websockets/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-websockets) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-websocket-star`](//github.com/libp2p/js-libp2p-websocket-star) | [![npm](https://img.shields.io/npm/v/libp2p-websocket-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-websocket-star/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-websocket-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websocket-star) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-websocket-star.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-websocket-star) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-websocket-star/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-websocket-star) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **Crypto Channels** |
+| [`libp2p-secio`](//github.com/libp2p/js-libp2p-secio) | [![npm](https://img.shields.io/npm/v/libp2p-secio.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-secio/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-secio.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-secio) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-secio.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-secio) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-secio/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-secio) | [Friedel Ziegelmayer](mailto:dignifiedquire@gmail.com) |
+| **Stream Muxers** |
+| [`interface-stream-muxer`](//github.com/libp2p/interface-stream-muxer) | [![npm](https://img.shields.io/npm/v/interface-stream-muxer.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-stream-muxer/releases) | [![Deps](https://david-dm.org/libp2p/interface-stream-muxer.svg?style=flat-square)](https://david-dm.org/libp2p/interface-stream-muxer) | [![Travis CI](https://travis-ci.com/libp2p/interface-stream-muxer.svg?branch=master)](https://travis-ci.com/libp2p/interface-stream-muxer) | [![codecov](https://codecov.io/gh/libp2p/interface-stream-muxer/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-stream-muxer) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-mplex`](//github.com/libp2p/js-libp2p-mplex) | [![npm](https://img.shields.io/npm/v/libp2p-mplex.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-mplex/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-mplex.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-mplex) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-mplex.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-mplex) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-mplex/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-mplex) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| [`libp2p-spdy`](//github.com/libp2p/js-libp2p-spdy) | [![npm](https://img.shields.io/npm/v/libp2p-spdy.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-spdy/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-spdy.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-spdy) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-spdy.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-spdy) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-spdy/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-spdy) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **Discovery** |
+| [`interface-peer-discovery`](//github.com/libp2p/interface-peer-discovery) | [![npm](https://img.shields.io/npm/v/interface-peer-discovery.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-peer-discovery/releases) | [![Deps](https://david-dm.org/libp2p/interface-peer-discovery.svg?style=flat-square)](https://david-dm.org/libp2p/interface-peer-discovery) | [![Travis CI](https://travis-ci.com/libp2p/interface-peer-discovery.svg?branch=master)](https://travis-ci.com/libp2p/interface-peer-discovery) | [![codecov](https://codecov.io/gh/libp2p/interface-peer-discovery/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-peer-discovery) | N/A |
+| [`libp2p-bootstrap`](//github.com/libp2p/js-libp2p-bootstrap) | [![npm](https://img.shields.io/npm/v/libp2p-bootstrap.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-bootstrap/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-bootstrap.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-bootstrap) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-bootstrap.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-bootstrap) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-bootstrap/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-bootstrap) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| [`libp2p-kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [![npm](https://img.shields.io/npm/v/libp2p-kad-dht.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-dht/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-kad-dht.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-dht) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-kad-dht.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-kad-dht) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-kad-dht/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| [`libp2p-mdns`](//github.com/libp2p/js-libp2p-mdns) | [![npm](https://img.shields.io/npm/v/libp2p-mdns.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-mdns/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-mdns.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-mdns) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-mdns.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-mdns) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-mdns/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-mdns) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-rendezvous`](//github.com/libp2p/js-libp2p-rendezvous) | [![npm](https://img.shields.io/npm/v/libp2p-rendezvous.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-rendezvous/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-rendezvous.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-rendezvous) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-rendezvous.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-rendezvous) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-rendezvous/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-rendezvous) | N/A |
+| [`libp2p-webrtc-star`](//github.com/libp2p/js-libp2p-webrtc-star) | [![npm](https://img.shields.io/npm/v/libp2p-webrtc-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-webrtc-star/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-webrtc-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-webrtc-star) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-webrtc-star.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-webrtc-star) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-star) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| [`libp2p-websocket-star`](//github.com/libp2p/js-libp2p-websocket-star) | [![npm](https://img.shields.io/npm/v/libp2p-websocket-star.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-websocket-star/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-websocket-star.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websocket-star) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-websocket-star.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-websocket-star) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-websocket-star/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-websocket-star) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **Content Routing** |
+| [`interface-content-routing`](//github.com/libp2p/interface-content-routing) | [![npm](https://img.shields.io/npm/v/interface-content-routing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-content-routing/releases) | [![Deps](https://david-dm.org/libp2p/interface-content-routing.svg?style=flat-square)](https://david-dm.org/libp2p/interface-content-routing) | [![Travis CI](https://travis-ci.com/libp2p/interface-content-routing.svg?branch=master)](https://travis-ci.com/libp2p/interface-content-routing) | [![codecov](https://codecov.io/gh/libp2p/interface-content-routing/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-content-routing) | N/A |
+| [`libp2p-delegated-content-routing`](//github.com/libp2p/js-libp2p-delegated-content-routing) | [![npm](https://img.shields.io/npm/v/libp2p-delegated-content-routing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-delegated-content-routing/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-delegated-content-routing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-delegated-content-routing) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-delegated-content-routing.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-delegated-content-routing) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-delegated-content-routing/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-delegated-content-routing) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [![npm](https://img.shields.io/npm/v/libp2p-kad-dht.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-dht/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-kad-dht.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-dht) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-kad-dht.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-kad-dht) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-kad-dht/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| **Peer Routing** |
+| [`interface-peer-routing`](//github.com/libp2p/interface-peer-routing) | [![npm](https://img.shields.io/npm/v/interface-peer-routing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interface-peer-routing/releases) | [![Deps](https://david-dm.org/libp2p/interface-peer-routing.svg?style=flat-square)](https://david-dm.org/libp2p/interface-peer-routing) | [![Travis CI](https://travis-ci.com/libp2p/interface-peer-routing.svg?branch=master)](https://travis-ci.com/libp2p/interface-peer-routing) | [![codecov](https://codecov.io/gh/libp2p/interface-peer-routing/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-peer-routing) | N/A |
+| [`libp2p-delegated-peer-routing`](//github.com/libp2p/js-libp2p-delegated-peer-routing) | [![npm](https://img.shields.io/npm/v/libp2p-delegated-peer-routing.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-delegated-peer-routing/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-delegated-peer-routing.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-delegated-peer-routing) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-delegated-peer-routing.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-delegated-peer-routing) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [![npm](https://img.shields.io/npm/v/libp2p-kad-dht.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-dht/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-kad-dht.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-dht) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-kad-dht.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-kad-dht) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-kad-dht/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| **Utilities** |
+| [`libp2p-crypto`](//github.com/libp2p/js-libp2p-crypto) | [![npm](https://img.shields.io/npm/v/libp2p-crypto.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-crypto/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-crypto.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-crypto) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-crypto.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-crypto) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-crypto/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-crypto) | [Friedel Ziegelmayer](mailto:dignifiedquire@gmail.com) |
+| [`libp2p-crypto-secp256k1`](//github.com/libp2p/js-libp2p-crypto-secp256k1) | [![npm](https://img.shields.io/npm/v/libp2p-crypto-secp256k1.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-crypto-secp256k1/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-crypto-secp256k1.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-crypto-secp256k1) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-crypto-secp256k1.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-crypto-secp256k1) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-crypto-secp256k1/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-crypto-secp256k1) | [Friedel Ziegelmayer](mailto:dignifiedquire@gmail.com) |
+| **Data Types** |
+| [`peer-book`](//github.com/libp2p/js-peer-book) | [![npm](https://img.shields.io/npm/v/peer-book.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-peer-book/releases) | [![Deps](https://david-dm.org/libp2p/js-peer-book.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-book) | [![Travis CI](https://travis-ci.com/libp2p/js-peer-book.svg?branch=master)](https://travis-ci.com/libp2p/js-peer-book) | [![codecov](https://codecov.io/gh/libp2p/js-peer-book/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-peer-book) | [Pedro Teixeira](mailto:i@pgte.me) |
+| [`peer-id`](//github.com/libp2p/js-peer-id) | [![npm](https://img.shields.io/npm/v/peer-id.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-peer-id/releases) | [![Deps](https://david-dm.org/libp2p/js-peer-id.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-id) | [![Travis CI](https://travis-ci.com/libp2p/js-peer-id.svg?branch=master)](https://travis-ci.com/libp2p/js-peer-id) | [![codecov](https://codecov.io/gh/libp2p/js-peer-id/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-peer-id) | [Pedro Teixeira](mailto:i@pgte.me) |
+| [`peer-info`](//github.com/libp2p/js-peer-info) | [![npm](https://img.shields.io/npm/v/peer-info.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-peer-info/releases) | [![Deps](https://david-dm.org/libp2p/js-peer-info.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-info) | [![Travis CI](https://travis-ci.com/libp2p/js-peer-info.svg?branch=master)](https://travis-ci.com/libp2p/js-peer-info) | [![codecov](https://codecov.io/gh/libp2p/js-peer-info/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-peer-info) | [Pedro Teixeira](mailto:i@pgte.me) |
+| **Extensions** |
+| [`libp2p-floodsub`](//github.com/libp2p/js-libp2p-floodsub) | [![npm](https://img.shields.io/npm/v/libp2p-floodsub.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-floodsub/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-floodsub.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-floodsub) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-floodsub.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-floodsub) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-floodsub/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-floodsub) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
 
 ## Contribute
 
@@ -346,4 +617,4 @@ The libp2p implementation in JavaScript is a work in progress. As such, there ar
 
 ## License
 
-[MIT](LICENSE) © David Dias
+[MIT](LICENSE) © Protocol Labs

RELEASE.md

@@ -0,0 +1,58 @@
+# Release Template
+
+> short tl;dr; of the release
+
+# 🗺 What's left for release
+
+# 🔦 Highlights
+
+# 🏗 API Changes
+
+# ✅ Release Checklist
+
+- Robustness and quality
+  - [ ] Ensure that all tests are passing, this includes:
+    - [ ] unit
+  - [ ] Publish a release candidate to npm
+    ```sh
+    # Minor prerelease (e.g. 0.24.1 -> 0.25.0-rc.0)
+    $ npx aegir release --type preminor -t node -t browser --preid rc --dist-tag next
+
+    # Increment prerelease (e.g. 0.25.0-rc.0 -> 0.25.0-rc.1)
+    $ npx aegir release --type prerelease -t node -t browser --preid rc --dist-tag next
+    ```
+  - [ ] Run tests of the following projects with the new release:
+    - [ ] [js-ipfs](https://github.com/ipfs/js-ipfs)
+- Documentation
+  - [ ] Ensure that README.md is up to date
+  - [ ] Ensure that all the examples run
+- Communication
+  - [ ] Create the release issue
+  - [ ] Take a snapshot between of everyone that has contributed to this release (including its subdeps in IPFS, libp2p, IPLD and multiformats) using [`name-your-contributors`](https://www.npmjs.com/package/name-your-contributors). Generate a nice markdown list with [this script](https://gist.github.com/jacobheun/d2ff479ca991733c13cdcf688a1317e5)
+  - [ ] Announcements (both pre-release and post-release)
+    - [ ] Twitter
+    - [ ] IRC
+    - [ ] Reddit
+    - [ ] [discuss.libp2p.io](https://discuss.libp2p.io/c/news)
+  - [ ] Blog post
+  - [ ] Copy release notes to the [GitHub Release description](https://github.com/libp2p/js-libp2p/releases)
+
+# ❤️ Huge thank you to everyone that made this release possible
+
+In alphabetical order, here are all the humans that contributed to the release:
+
+- ...
+
+# 🙌🏽 Want to contribute?
+
+Would you like to contribute to the libp2p project and don't know how? Well, there are a few places you can get started:
+
+- Check the issues with the `help wanted` label in the [libp2p repo](https://github.com/libp2p/js-libp2p/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
+- Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt#all-hands-call
+- Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built
+- Join the discussion at http://discuss.ipfs.io/ and help users finding their answers.
+- Join the [⚡️ⒿⓈ Core Dev Team Weekly Sync 🙌🏽 ](https://github.com/ipfs/team-mgmt/issues/650) and be part of the Sprint action!
+
+# ⁉️ Do you have questions?
+
+The best place to ask your questions about libp2p, how it works and what you can do with it is at [discuss.libp2p.io](https://discuss.libp2p.io). We are also available at the #libp2p channel on Freenode.

appveyor.yml

@@ -1,29 +0,0 @@
-# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
-version: "{build}"
-
-environment:
-  matrix:
-    - nodejs_version: "6"
-    - nodejs_version: "8"
-
-matrix:
-  fast_finish: true
-
-install:
-  # Install Node.js
-  - ps: Install-Product node $env:nodejs_version
-
-  # Upgrade npm
-  - npm install -g npm
-
-  # Output our current versions for debugging
-  - node --version
-  - npm --version
-
-  # Install our package dependencies
-  - npm install
-
-test_script:
-  - npm run test:node
-
-build: off

ci/Jenkinsfile

@@ -1,2 +0,0 @@
-// Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
-javascript()

circle.yml

@@ -1,18 +0,0 @@
-machine:
-  node:
-    version: stable
-
-dependencies:
-  pre:
-    - google-chrome --version
-    - curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
-    - for v in $(curl http://archive.ubuntu.com/ubuntu/pool/main/n/nss/ | grep "href=" | grep "libnss3.*deb\"" -o | grep -o "libnss3.*deb" | grep "3.28" | grep "14.04"); do curl -L -o $v http://archive.ubuntu.com/ubuntu/pool/main/n/nss/$v; done && rm libnss3-tools*_i386.deb libnss3-dev*_i386.deb
-    - sudo dpkg -i google-chrome.deb || true
-    - sudo dpkg -i libnss3*.deb || true
-    - sudo apt-get update
-    - sudo apt-get install -f || true
-    - sudo dpkg -i libnss3*.deb
-    - sudo apt-get install -f
-    - sudo apt-get install --only-upgrade lsb-base
-    - sudo dpkg -i google-chrome.deb
-    - google-chrome --version

examples/README.md

@@ -10,8 +10,7 @@ Let us know if you find any issue or if you want to contribute and add a new tut
 - [Protocol and Stream Muxing](./protocol-and-stream-muxing)
 - [Encrypted Communications](./encrypted-communications)
 - [Discovery Mechanisms](./discovery-mechanisms)
-- [Peer Routing](./peer-routing)
-- [Content Routing](./content-routing)
+- [Peer and Content Routing](./peer-and-content-routing)
 - [PubSub](./pubsub)
 - [NAT Traversal](./nat-traversal)
 - Circuit Relay (future)
@@ -22,4 +21,4 @@ Let us know if you find any issue or if you want to contribute and add a new tut
 - [Running libp2p in the Browser](./libp2p-in-the-browser)
 - Running libp2p in the Electron (future)
 - [The standard echo net example with libp2p](./echo)
-- [A simple chat app with](./chat)
+- [A simple chat app with libp2p](./chat)

examples/chat/README.md

@@ -1 +1,13 @@
 # Chat example with libp2p
+
+This example creates a simple chat app in your terminal.
+
+## Setup
+1. Install the modules in the libp2p root directory, `npm install`.
+2. Open 2 terminal windows in the `./examples/chat/src` directory.
+
+## Running
+1. Run the listener in window 1, `node listener.js`
+2. Run the dialer in window 2, `node dialer.js`
+3. Type a message in either window and hit _enter_
+4. Tell yourself secrets to your hearts content!

examples/chat/src/dialer.js

@@ -31,7 +31,9 @@ async.parallel([
   if (err) throw err
   const peerDialer = new PeerInfo(ids[0])
   peerDialer.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-  const nodeDialer = new Node(peerDialer)
+  const nodeDialer = new Node({
+    peerInfo: peerDialer
+  })
 
   const peerListener = new PeerInfo(ids[1])
   idListener = ids[1]
@@ -44,10 +46,10 @@ async.parallel([
     console.log('Dialer ready, listening on:')
 
     peerListener.multiaddrs.forEach((ma) => {
-      console.log(ma.toString() + '/ipfs/' + idListener.toB58String())
+      console.log(ma.toString() + '/p2p/' + idListener.toB58String())
     })
 
-    nodeDialer.dial(peerListener, '/chat/1.0.0', (err, conn) => {
+    nodeDialer.dialProtocol(peerListener, '/chat/1.0.0', (err, conn) => {
       if (err) {
         throw err
       }

examples/chat/src/libp2p-bundle.js

@@ -3,11 +3,12 @@
 const TCP = require('libp2p-tcp')
 const MulticastDNS = require('libp2p-mdns')
 const WS = require('libp2p-websockets')
-const Railing = require('libp2p-railing')
+const Bootstrap = require('libp2p-bootstrap')
 const spdy = require('libp2p-spdy')
 const KadDHT = require('libp2p-kad-dht')
-const multiplex = require('libp2p-multiplex')
+const mplex = require('libp2p-mplex')
 const secio = require('libp2p-secio')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const libp2p = require('../../..')
 
 function mapMuxers (list) {
@@ -17,7 +18,7 @@ function mapMuxers (list) {
     }
     switch (pref.trim().toLowerCase()) {
       case 'spdy': return spdy
-      case 'multiplex': return multiplex
+      case 'mplex': return mplex
       default:
         throw new Error(pref + ' muxer not available')
     }
@@ -31,49 +32,45 @@ function getMuxers (muxers) {
   } else if (muxers) {
     return mapMuxers(muxers)
   } else {
-    return [multiplex, spdy]
+    return [mplex, spdy]
   }
 }
 
 class Node extends libp2p {
-  constructor (peerInfo, peerBook, options) {
-    options = options || {}
-
-    const modules = {
-      transport: [
-        new TCP(),
-        new WS()
-      ],
-      connection: {
-        muxer: getMuxers(options.muxer),
-        crypto: [ secio ]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [
+          TCP,
+          WS
+        ],
+        streamMuxer: getMuxers(_options.muxer),
+        connEncryption: [ secio ],
+        peerDiscovery: [
+          MulticastDNS,
+          Bootstrap
+        ],
+        dht: KadDHT
       },
-      discovery: []
+      config: {
+        peerDiscovery: {
+          mdns: {
+            interval: 10000,
+            enabled: false
+          },
+          bootstrap: {
+            interval: 10000,
+            enabled: false,
+            list: _options.bootstrapList
+          }
+        },
+        dht: {
+          kBucketSize: 20
+        }
+      }
     }
 
-    if (options.dht) {
-      modules.DHT = KadDHT
-    }
-
-    if (options.mdns) {
-      const mdns = new MulticastDNS(peerInfo, 'ipfs.local')
-      modules.discovery.push(mdns)
-    }
-
-    if (options.bootstrap) {
-      const r = new Railing(options.bootstrap)
-      modules.discovery.push(r)
-    }
-
-    if (options.modules && options.modules.transport) {
-      options.modules.transport.forEach((t) => modules.transport.push(t))
-    }
-
-    if (options.modules && options.modules.discovery) {
-      options.modules.discovery.forEach((d) => modules.discovery.push(d))
-    }
-
-    super(modules, peerInfo, peerBook, options)
+    super(defaultsDeep(_options, defaults))
   }
 }
 

examples/chat/src/listener.js

@@ -14,14 +14,16 @@ PeerId.createFromJSON(require('./peer-id-listener'), (err, idListener) => {
   }
   const peerListener = new PeerInfo(idListener)
   peerListener.multiaddrs.add('/ip4/0.0.0.0/tcp/10333')
-  const nodeListener = new Node(peerListener)
+  const nodeListener = new Node({
+    peerInfo: peerListener
+  })
 
   nodeListener.start((err) => {
     if (err) {
       throw err
     }
 
-    nodeListener.swarm.on('peer-mux-established', (peerInfo) => {
+    nodeListener.on('peer:connect', (peerInfo) => {
       console.log(peerInfo.id.toB58String())
     })
 
@@ -48,7 +50,7 @@ PeerId.createFromJSON(require('./peer-id-listener'), (err, idListener) => {
 
     console.log('Listener ready, listening on:')
     peerListener.multiaddrs.forEach((ma) => {
-      console.log(ma.toString() + '/ipfs/' + idListener.toB58String())
+      console.log(ma.toString() + '/p2p/' + idListener.toB58String())
     })
   })
 })

examples/delegated-routing/README.md

@@ -0,0 +1,49 @@
+# Delegated Routing with Libp2p and IPFS
+
+This example shows how to use delegated peer and content routing. The [Peer and Content Routing Example](../peer-and-content-routing) focuses
+on the DHT implementation. This example takes that a step further and introduces delegated routing. Delegated routing is
+especially useful when your libp2p node will have limited resources, making running a DHT impractical. It's
+also highly useful if your node is generating content, but can't reliably be on the network. You can use delegate nodes
+to provide content on your behalf.
+
+The starting [Libp2p Bundle](./src/libp2p-bundle.js) in this example starts by disabling the DHT and adding the Delegated Peer and Content Routers.
+Once you've completed the example, you should try enabled the DHT and see what kind of results you get! You can also enable the
+various Peer Discovery modules and see the impact it has on your Peer count.
+
+## Prerequisite
+**NOTE**: This example is currently dependent on a clone of the [delegated routing support branch of go-ipfs](https://github.com/ipfs/go-ipfs/pull/4595).
+
+## Running this example
+
+1. Install IPFS locally if you dont already have it. [Install Guide](https://docs.ipfs.io/introduction/install/)
+2. Run the IPFS daemon: `ipfs daemon`
+3. The daemon will output a line about its API address, like `API server listening on /ip4/127.0.0.1/tcp/8080`
+4. In another window output the addresses of the node: `ipfs id`. Make note of the websocket address, it will contain `/ws/` in the address.
+5. In `./src/libp2p-bundle.js` check if the host and port of your node are correct, according to the previous step. If they are different, replace them.
+6. In `./src/App.js` replace `BootstrapNode` with your nodes Websocket address from step 4.
+7. Start this example:
+
+```sh
+npm install
+npm start
+```
+
+This should open your browser to http://localhost:3000. If it does not, go ahead and do that now.
+
+8. Your browser should show you connected to at least 1 peer.
+
+### Finding Content via the Delegate
+1. Add a file to your IPFS node. From this example root you can do `ipfs add ./README.md` to add the example readme.
+2. Copy the hash from line 5, it will look something like *Qmf33vz4HJFkqgH7XPP1uA6atYKTX1BWQEQthzpKcAdeyZ*.
+3. In the browser, paste the hash into the *Hash* field and hit `Find`. The readme contents should display.
+
+This will do a few things:
+* The delegate nodes api will be queried to find providers of the content
+* The content will be fetched from the providers
+* Since we now have the content, we tell the delegate node to fetch the content from us and become a provider
+
+### Finding Peers via the Delegate
+1. Get a list of your delegate nodes peer by querying the IPFS daemon: `ipfs swarm peers`
+2. Copy one of the CIDs from the list of peer addresses, this will be the last portion of the address and will look something like `QmdoG8DpzYUZMVP5dGmgmigZwR1RE8Cf6SxMPg1SBXJAQ8`.
+3. In your browser, paste the CID into the *Peer* field and hit `Find`.
+4. You should see information about the peer including its addresses.

examples/delegated-routing/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "delegated-routing-example",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "ipfs": "~0.34.4",
+    "libp2p": "github:libp2p/js-libp2p#master",
+    "libp2p-delegated-content-routing": "~0.2.2",
+    "libp2p-delegated-peer-routing": "~0.2.2",
+    "libp2p-kad-dht": "~0.14.12",
+    "libp2p-mplex": "~0.8.5",
+    "libp2p-secio": "~0.11.1",
+    "libp2p-webrtc-star": "~0.15.8",
+    "libp2p-websocket-star": "~0.10.2",
+    "libp2p-websockets": "~0.12.2",
+    "react": "^16.8.6",
+    "react-dom": "^16.8.6",
+    "react-scripts": "2.1.8"
+  },
+  "scripts": {
+    "start": "react-scripts start"
+  },
+  "browserslist": [
+    ">0.2%",
+    "not dead",
+    "not ie <= 11",
+    "not op_mini all"
+  ]
+}

examples/delegated-routing/public/index.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="theme-color" content="#000000">
+    <title>Delegated Routing</title>
+    <link rel="stylesheet" type="text/css" href="main.css">
+  </head>
+  <body>
+    <noscript>
+      You need to enable JavaScript to run this app.
+    </noscript>
+    <div id="root"></div>
+  </body>
+</html>

examples/delegated-routing/public/main.css

@@ -0,0 +1,67 @@
+body {
+  margin: 0;
+  padding: 0;
+  font-family: sans-serif;
+}
+
+section * {
+  margin: 10px;
+}
+
+header {
+  background-color: #222;
+  height: 150px;
+  padding: 20px;
+  color: white;
+}
+
+.center {
+  text-align: center;
+}
+
+pre {
+  background-color: bisque;
+  min-height: 100px;
+  margin: 0px;
+  padding: 10px;
+}
+
+.loader {
+  text-align: center;
+  height: 64px;
+  margin-bottom: -64px;
+}
+
+.loading .lds-ripple {
+  display: inline-block;
+  position: relative;
+  width: 64px;
+  height: 64px;
+}
+.loading .lds-ripple div {
+  position: absolute;
+  border: 4px solid #000;
+  opacity: 1;
+  border-radius: 50%;
+  animation: lds-ripple 1s cubic-bezier(0, 0.2, 0.8, 1) infinite;
+  margin: auto;
+}
+.loading .lds-ripple div:nth-child(2) {
+  animation-delay: -0.5s;
+}
+@keyframes lds-ripple {
+  0% {
+    top: 28px;
+    left: 28px;
+    width: 0;
+    height: 0;
+    opacity: 1;
+  }
+  100% {
+    top: -1px;
+    left: -1px;
+    width: 58px;
+    height: 58px;
+    opacity: 0;
+  }
+}

examples/delegated-routing/src/App.js

@@ -0,0 +1,152 @@
+// eslint-disable-next-line
+'use strict'
+
+import React from 'react'
+import Ipfs from 'ipfs'
+import libp2pBundle from './libp2p-bundle'
+const Component = React.Component
+
+const BootstrapNode = '/ip4/127.0.0.1/tcp/8081/ws/p2p/QmdoG8DpzYUZMVP5dGmgmigZwR1RE8Cf6SxMPg1SBXJAQ8'
+
+class App extends Component {
+  constructor (props) {
+    super(props)
+    this.state = {
+      peers: 0,
+      // This hash is the IPFS readme
+      hash: 'QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB',
+      // This peer is one of the Bootstrap nodes for IPFS
+      peer: 'QmV6kA2fB8kTr6jc3pL5zbNsjKbmPUHAPKKHRBYe1kDEyc',
+      isLoading: 0
+    }
+    this.peerInterval = null
+
+    this.handleHashChange = this.handleHashChange.bind(this)
+    this.handleHashSubmit = this.handleHashSubmit.bind(this)
+    this.handlePeerChange = this.handlePeerChange.bind(this)
+    this.handlePeerSubmit = this.handlePeerSubmit.bind(this)
+  }
+
+  handleHashChange (event) {
+    this.setState({
+      hash: event.target.value
+    })
+  }
+  handlePeerChange (event) {
+    this.setState({
+      peer: event.target.value
+    })
+  }
+
+  handleHashSubmit (event) {
+    event.preventDefault()
+    this.setState({
+      isLoading: this.state.isLoading + 1
+    })
+
+    this.ipfs.files.cat(this.state.hash, (err, data) => {
+      if (err) console.log('Error', err)
+
+      this.setState({
+        response: data.toString(),
+        isLoading: this.state.isLoading - 1
+      })
+    })
+  }
+  handlePeerSubmit (event) {
+    event.preventDefault()
+    this.setState({
+      isLoading: this.state.isLoading + 1
+    })
+
+    this.ipfs.dht.findpeer(this.state.peer, (err, results) => {
+      if (err) console.log('Error', err)
+
+      this.setState({
+        response: JSON.stringify(results, null, 2),
+        isLoading: this.state.isLoading - 1
+      })
+    })
+  }
+
+  componentDidMount () {
+    window.ipfs = this.ipfs = new Ipfs({
+      config: {
+        Addresses: {
+          Swarm: []
+        },
+        Discovery: {
+          MDNS: {
+            Enabled: false
+          },
+          webRTCStar: {
+            Enabled: false
+          }
+        },
+        Bootstrap: [
+          BootstrapNode
+        ]
+      },
+      preload: {
+        enabled: false
+      },
+      libp2p: libp2pBundle
+    })
+    this.ipfs.on('ready', () => {
+      if (this.peerInterval) {
+        clearInterval(this.peerInterval)
+      }
+
+      this.ipfs.swarm.connect(BootstrapNode, (err) => {
+        if (err) {
+          console.log('Error connecting to the node', err)
+        }
+        console.log('Connected!')
+      })
+
+      this.peerInterval = setInterval(() => {
+        this.ipfs.swarm.peers((err, peers) => {
+          if (err) console.log(err)
+          if (peers) this.setState({peers: peers.length})
+        })
+      }, 2500)
+    })
+  }
+
+  render () {
+    return (
+      <div>
+        <header className="center">
+          <h1>Delegated Routing</h1>
+          <h2>There are currently {this.state.peers} peers.</h2>
+        </header>
+        <section className="center">
+          <form onSubmit={this.handleHashSubmit}>
+            <label>
+              Hash:
+              <input type="text" value={this.state.hash} onChange={this.handleHashChange} />
+              <input type="submit" value="Find" />
+            </label>
+          </form>
+          <form onSubmit={this.handlePeerSubmit}>
+            <label>
+              Peer:
+              <input type="text" value={this.state.peer} onChange={this.handlePeerChange} />
+              <input type="submit" value="Find" />
+            </label>
+          </form>
+        </section>
+        <section className={[this.state.isLoading > 0 ? 'loading' : '', 'loader'].join(' ')}>
+          <div className="lds-ripple"><div></div><div></div></div>
+        </section>
+        <section>
+          <pre>
+            {this.state.response}
+          </pre>
+        </section>
+      </div>
+    )
+  }
+}
+
+export default App

examples/delegated-routing/src/index.js

@@ -0,0 +1,8 @@
+// eslint-disable-next-line
+'use strict'
+
+import React from 'react' // eslint-disable-line no-unused-vars
+import ReactDOM from 'react-dom'
+import App from './App' // eslint-disable-line no-unused-vars
+
+ReactDOM.render(<App />, document.getElementById('root'))

examples/delegated-routing/src/libp2p-bundle.js

@@ -0,0 +1,76 @@
+// eslint-disable-next-line
+'use strict'
+
+const Libp2p = require('libp2p')
+const Websockets = require('libp2p-websockets')
+const WebSocketStar = require('libp2p-websocket-star')
+const WebRTCStar = require('libp2p-webrtc-star')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const KadDHT = require('libp2p-kad-dht')
+const DelegatedPeerRouter = require('libp2p-delegated-peer-routing')
+const DelegatedContentRouter = require('libp2p-delegated-content-routing')
+
+export default function Libp2pBundle ({peerInfo, peerBook}) {
+  const wrtcstar = new WebRTCStar({id: peerInfo.id})
+  const wsstar = new WebSocketStar({id: peerInfo.id})
+  const delegatedApiOptions = {
+    host: '0.0.0.0',
+    protocol: 'http',
+    port: '8080'
+  }
+
+  return new Libp2p({
+    peerInfo,
+    peerBook,
+    // Lets limit the connection managers peers and have it check peer health less frequently
+    connectionManager: {
+      maxPeers: 10,
+      pollInterval: 5000
+    },
+    modules: {
+      contentRouting: [
+        new DelegatedContentRouter(peerInfo.id, delegatedApiOptions)
+      ],
+      peerRouting: [
+        new DelegatedPeerRouter(delegatedApiOptions)
+      ],
+      peerDiscovery: [
+        wrtcstar.discovery,
+        wsstar.discovery
+      ],
+      transport: [
+        wrtcstar,
+        wsstar,
+        Websockets
+      ],
+      streamMuxer: [
+        MPLEX
+      ],
+      connEncryption: [
+        SECIO
+      ],
+      dht: KadDHT
+    },
+    config: {
+      peerDiscovery: {
+        autoDial: false,
+        webrtcStar: {
+          enabled: false
+        },
+        websocketStar: {
+          enabled: false
+        }
+      },
+      dht: {
+        enabled: false
+      },
+      relay: {
+        enabled: true,
+        hop: {
+          enabled: false
+        }
+      }
+    }
+  })
+}

examples/discovery-mechanisms/1.js

@@ -1,37 +1,50 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const Multiplex = require('libp2p-multiplex')
+const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
-const Railing = require('libp2p-railing')
+const Bootstrap = require('libp2p-bootstrap')
 const waterfall = require('async/waterfall')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 // Find this list at: https://github.com/ipfs/js-ipfs/blob/master/src/core/runtime/config-nodejs.json
 const bootstrapers = [
-  '/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ',
-  '/ip4/104.236.176.52/tcp/4001/ipfs/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z',
-  '/ip4/104.236.179.241/tcp/4001/ipfs/QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
-  '/ip4/162.243.248.213/tcp/4001/ipfs/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm',
-  '/ip4/128.199.219.111/tcp/4001/ipfs/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
-  '/ip4/104.236.76.40/tcp/4001/ipfs/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64',
-  '/ip4/178.62.158.247/tcp/4001/ipfs/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
-  '/ip4/178.62.61.185/tcp/4001/ipfs/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3',
-  '/ip4/104.236.151.122/tcp/4001/ipfs/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx'
+  '/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ',
+  '/ip4/104.236.176.52/tcp/4001/p2p/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z',
+  '/ip4/104.236.179.241/tcp/4001/p2p/QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
+  '/ip4/162.243.248.213/tcp/4001/p2p/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm',
+  '/ip4/128.199.219.111/tcp/4001/p2p/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
+  '/ip4/104.236.76.40/tcp/4001/p2p/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64',
+  '/ip4/178.62.158.247/tcp/4001/p2p/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
+  '/ip4/178.62.61.185/tcp/4001/p2p/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3',
+  '/ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx'
 ]
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ Bootstrap ]
       },
-      discovery: [new Railing(bootstrapers)]
+      config: {
+        peerDiscovery: {
+          autoDial: true,
+          bootstrap: {
+            interval: 20e3,
+            enabled: true,
+            list: bootstrapers
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -41,15 +54,17 @@ waterfall([
   (cb) => PeerInfo.create(cb),
   (peerInfo, cb) => {
     peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-    node = new MyBundle(peerInfo)
+    node = new MyBundle({
+      peerInfo
+    })
     node.start(cb)
   }
 ], (err) => {
   if (err) { throw err }
 
   node.on('peer:discovery', (peer) => {
+    // No need to dial, autoDial is on
     console.log('Discovered:', peer.id.toB58String())
-    node.dial(peer, () => {})
   })
 
   node.on('peer:connect', (peer) => {

examples/discovery-mechanisms/2.js

@@ -1,25 +1,36 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const Multiplex = require('libp2p-multiplex')
+const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
 const MulticastDNS = require('libp2p-mdns')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ MulticastDNS ]
       },
-      discovery: [new MulticastDNS(peerInfo, { interval: 1000 })]
+      config: {
+        peerDiscovery: {
+          mdns: {
+            interval: 20e3,
+            enabled: true
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -30,7 +41,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))

examples/discovery-mechanisms/README.md

@@ -8,22 +8,33 @@ These mechanisms save configuration and enable a node to operate without any exp
 
 ## 1. Bootstrap list of Peers when booting a node
 
-For this demo, we will connect to IPFS default bootstrapper nodes and so, we will need to support the same set of features those nodes have, that are: TCP, multiplex and SECIO. You can see the complete example at [1.js](./1.js).
+For this demo, we will connect to IPFS default bootstrapper nodes and so, we will need to support the same set of features those nodes have, that are: TCP, mplex and SECIO. You can see the complete example at [1.js](./1.js).
 
 First, we create our libp2p bundle.
 
 ```JavaScript
+const Bootstrap = require('libp2p-railing')
 class MyBundle extends libp2p {
   constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ Bootstrap ]
       },
-      discovery: [new Railing(bootstrapers)]
+      config: {
+        peerDiscovery: {
+          bootstrap: {
+            interval: 2000,
+            enabled: true,
+            list: bootstrapers
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```
@@ -32,28 +43,30 @@ In this bundle, we use a `bootstrappers` array listing peers to connect _on boot
 
 ```JavaScript
 const bootstrapers = [
-  '/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ',
-  '/ip4/104.236.176.52/tcp/4001/ipfs/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z',
-  '/ip4/104.236.179.241/tcp/4001/ipfs/QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
-  '/ip4/162.243.248.213/tcp/4001/ipfs/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm',
-  '/ip4/128.199.219.111/tcp/4001/ipfs/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
-  '/ip4/104.236.76.40/tcp/4001/ipfs/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64',
-  '/ip4/178.62.158.247/tcp/4001/ipfs/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
-  '/ip4/178.62.61.185/tcp/4001/ipfs/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3',
-  '/ip4/104.236.151.122/tcp/4001/ipfs/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx'
+  '/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ',
+  '/ip4/104.236.176.52/tcp/4001/p2p/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z',
+  '/ip4/104.236.179.241/tcp/4001/p2p/QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
+  '/ip4/162.243.248.213/tcp/4001/p2p/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm',
+  '/ip4/128.199.219.111/tcp/4001/p2p/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
+  '/ip4/104.236.76.40/tcp/4001/p2p/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64',
+  '/ip4/178.62.158.247/tcp/4001/p2p/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
+  '/ip4/178.62.61.185/tcp/4001/p2p/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3',
+  '/ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx'
 ]
 ```
 
 Now, once we create and start the node, we can listen for events such as `peer:discovery` and `peer:connect`, these events tell us when we found a peer, independently of the discovery mechanism used and when we actually dialed to that peer.
 
-```
+```JavaScript
 let node
 
 waterfall([
   (cb) => PeerInfo.create(cb),
   (peerInfo, cb) => {
     peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-    node = new MyBundle(peerInfo)
+    node = new MyBundle({
+      peerInfo
+    })
     node.start(cb)
   }
 ], (err) => {
@@ -108,17 +121,25 @@ Update your libp2p bundle to include MulticastDNS.
 ```JavaScript
 class MyBundle extends libp2p {
   constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ MulticastDNS ]
       },
-      // We set the interval here to 1 second so that is faster to observe. The
-      // default is 10 seconds.
-      discovery: [new MulticastDNS(peerInfo, { interval: 1000 })]
+      config: {
+        peerDiscovery: {
+          mdns: {
+            // Run at 1s so we can observe more quickly, default is 10s
+            interval: 1000,
+            enabled: true
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```

examples/echo/README.md

@@ -1 +1,13 @@
 # Echo example with libp2p
+
+This example performs a simple echo from the listener to the dialer.
+
+## Setup
+1. Install the modules from libp2p root, `npm install`.
+2. Open 2 terminal windows in the `./src` directory.
+
+## Running
+1. Run the listener in window 1, `node listener.js`
+2. Run the dialer in window 2, `node dialer.js`
+3. You should see console logs showing the dial, and the received echo of _hey_
+4. If you look at the listener window, you will see it receiving the dial

examples/echo/src/dialer.js

@@ -21,12 +21,14 @@ async.parallel([
   const dialerId = ids[0]
   const dialerPeerInfo = new PeerInfo(dialerId)
   dialerPeerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-  const dialerNode = new Node(dialerPeerInfo)
+  const dialerNode = new Node({
+    peerInfo: dialerPeerInfo
+  })
 
   // Peer to Dial
   const listenerPeerInfo = new PeerInfo(ids[1])
   const listenerId = ids[1]
-  const listenerMultiaddr = '/ip4/127.0.0.1/tcp/10333/ipfs/' +
+  const listenerMultiaddr = '/ip4/127.0.0.1/tcp/10333/p2p/' +
       listenerId.toB58String()
   listenerPeerInfo.multiaddrs.add(listenerMultiaddr)
 
@@ -35,10 +37,10 @@ async.parallel([
 
     console.log('Dialer ready, listening on:')
     dialerPeerInfo.multiaddrs.forEach((ma) => console.log(ma.toString() +
-          '/ipfs/' + dialerId.toB58String()))
+          '/p2p/' + dialerId.toB58String()))
 
     console.log('Dialing to peer:', listenerMultiaddr.toString())
-    dialerNode.dial(listenerPeerInfo, '/echo/1.0.0', (err, conn) => {
+    dialerNode.dialProtocol(listenerPeerInfo, '/echo/1.0.0', (err, conn) => {
       if (err) { throw err }
 
       console.log('nodeA dialed to nodeB on protocol: /echo/1.0.0')

examples/echo/src/libp2p-bundle.js

@@ -3,11 +3,12 @@
 const TCP = require('libp2p-tcp')
 const MulticastDNS = require('libp2p-mdns')
 const WS = require('libp2p-websockets')
-const Railing = require('libp2p-railing')
+const Bootstrap = require('libp2p-bootstrap')
 const spdy = require('libp2p-spdy')
 const KadDHT = require('libp2p-kad-dht')
-const multiplex = require('libp2p-multiplex')
+const mplex = require('libp2p-mplex')
 const secio = require('libp2p-secio')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const libp2p = require('../../..')
 
 function mapMuxers (list) {
@@ -17,7 +18,7 @@ function mapMuxers (list) {
     }
     switch (pref.trim().toLowerCase()) {
       case 'spdy': return spdy
-      case 'multiplex': return multiplex
+      case 'mplex': return mplex
       default:
         throw new Error(pref + ' muxer not available')
     }
@@ -31,49 +32,45 @@ function getMuxers (muxers) {
   } else if (muxers) {
     return mapMuxers(muxers)
   } else {
-    return [multiplex, spdy]
+    return [mplex, spdy]
   }
 }
 
 class Node extends libp2p {
-  constructor (peerInfo, peerBook, options) {
-    options = options || {}
-
-    const modules = {
-      transport: [
-        new TCP(),
-        new WS()
-      ],
-      connection: {
-        muxer: getMuxers(options.muxer),
-        crypto: [ secio ]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [
+          TCP,
+          WS
+        ],
+        streamMuxer: getMuxers(_options.muxer),
+        connEncryption: [ secio ],
+        peerDiscovery: [
+          MulticastDNS,
+          Bootstrap
+        ],
+        dht: KadDHT
       },
-      discovery: []
+      config: {
+        peerDiscovery: {
+          mdns: {
+            interval: 10000,
+            enabled: false
+          },
+          bootstrap: {
+            interval: 10000,
+            enabled: false,
+            list: _options.bootstrapList
+          }
+        },
+        dht: {
+          kBucketSize: 20
+        }
+      }
     }
 
-    if (options.dht) {
-      modules.DHT = KadDHT
-    }
-
-    if (options.mdns) {
-      const mdns = new MulticastDNS(peerInfo, 'ipfs.local')
-      modules.discovery.push(mdns)
-    }
-
-    if (options.bootstrap) {
-      const r = new Railing(options.bootstrap)
-      modules.discovery.push(r)
-    }
-
-    if (options.modules && options.modules.transport) {
-      options.modules.transport.forEach((t) => modules.transport.push(t))
-    }
-
-    if (options.modules && options.modules.discovery) {
-      options.modules.discovery.forEach((d) => modules.discovery.push(d))
-    }
-
-    super(modules, peerInfo, peerBook, options)
+    super(defaultsDeep(_options, defaults))
   }
 }
 

examples/echo/src/listener.js

@@ -25,9 +25,11 @@ series([
   (cb) => {
     const listenerPeerInfo = new PeerInfo(listenerId)
     listenerPeerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/10333')
-    listenerNode = new Node(listenerPeerInfo)
+    listenerNode = new Node({
+      peerInfo: listenerPeerInfo
+    })
 
-    listenerNode.swarm.on('peer-mux-established', (peerInfo) => {
+    listenerNode.on('peer:connect', (peerInfo) => {
       console.log('received dial to me from:', peerInfo.id.toB58String())
     })
 
@@ -39,6 +41,6 @@ series([
 
   console.log('Listener ready, listening on:')
   listenerNode.peerInfo.multiaddrs.forEach((ma) => {
-    console.log(ma.toString() + '/ipfs/' + listenerId.toB58String())
+    console.log(ma.toString() + '/p2p/' + listenerId.toB58String())
   })
 })

examples/encrypted-communications/1.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const SPDY = require('libp2p-spdy')
 const SECIO = require('libp2p-secio')
@@ -8,17 +8,19 @@ const PeerInfo = require('peer-info')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 const pull = require('pull-stream')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [SPDY],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ SPDY ],
+        connEncryption: [ SECIO ]
       }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -29,7 +31,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -52,7 +56,7 @@ parallel([
     )
   })
 
-  node1.dial(node2.peerInfo, '/a-protocol', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/a-protocol', (err, conn) => {
     if (err) { throw err }
     pull(pull.values(['This information is sent out encrypted to the other peer']), conn)
   })

examples/encrypted-communications/README.md

@@ -19,15 +19,16 @@ const SECIO = require('libp2p-secio')
 
 class MyBundle extends libp2p {
   constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [SPDY],
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ SPDY ],
         // Attach secio as the crypto channel to use
-        crypto: [SECIO]
+        connEncryption: [ SECIO ]
       }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```
@@ -36,4 +37,4 @@ And that's it, from now on, all your libp2p communications are encrypted. Try ru
 
 If you want to want to learn more about how SECIO works, you can read the [great write up done by Dominic Tarr](https://github.com/auditdrivencrypto/secure-channel/blob/master/prior-art.md#ipfss-secure-channel).
 
-Importante note: SECIO hasn't been audited and so, we do not recommend to trust its security. We intent to move to TLS 1.3 once the specification is finalized and an implementation exists that we can use.
+Important note: SECIO hasn't been audited and so, we do not recommend to trust its security. We intent to move to TLS 1.3 once the specification is finalized and an implementation exists that we can use.

examples/libp2p-in-the-browser/1/package.json

@@ -13,17 +13,20 @@
     "browserify": "^14.5.0",
     "concat-stream": "^1.6.0",
     "detect-dom-ready": "^1.0.2",
-    "node-static": "^0.7.10"
+    "node-static": "~0.7.10"
   },
   "dependencies": {
     "detect-dom-ready": "^1.0.2",
-    "libp2p": "^0.13.0",
-    "libp2p-multiplex": "^0.5.0",
-    "libp2p-railing": "^0.7.1",
-    "libp2p-secio": "^0.8.1",
-    "libp2p-spdy": "^0.11.0",
-    "libp2p-webrtc-star": "^0.13.2",
-    "libp2p-websockets": "^0.10.4",
-    "peer-info": "^0.11.0"
+    "libp2p": "../../../",
+    "libp2p-bootstrap": "~0.9.7",
+    "libp2p-gossipsub": "~0.0.4",
+    "libp2p-kad-dht": "^0.15.3",
+    "libp2p-mplex": "~0.8.5",
+    "libp2p-secio": "~0.11.1",
+    "libp2p-spdy": "~0.13.3",
+    "libp2p-webrtc-star": "~0.15.8",
+    "libp2p-websocket-star": "~0.10.2",
+    "libp2p-websockets": "~0.12.2",
+    "peer-info": "~0.15.1"
   }
 }

examples/libp2p-in-the-browser/1/src/browser-bundle.js

@@ -2,53 +2,92 @@
 
 const WebRTCStar = require('libp2p-webrtc-star')
 const WebSockets = require('libp2p-websockets')
-
-const Multiplex = require('libp2p-multiplex')
+const WebSocketStar = require('libp2p-websocket-star')
+const Mplex = require('libp2p-mplex')
 const SPDY = require('libp2p-spdy')
 const SECIO = require('libp2p-secio')
-
-const Railing = require('libp2p-railing')
+const Bootstrap = require('libp2p-bootstrap')
+const DHT = require('libp2p-kad-dht')
+const Gossipsub = require('libp2p-gossipsub')
 const libp2p = require('libp2p')
 
 // Find this list at: https://github.com/ipfs/js-ipfs/blob/master/src/core/runtime/config-browser.json
-const bootstrapers = [
-  '/dns4/ams-1.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
-  '/dns4/sfo-1.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx',
-  '/dns4/lon-1.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3',
-  '/dns4/sfo-2.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z',
-  '/dns4/sfo-3.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
-  '/dns4/sgp-1.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
-  '/dns4/nyc-1.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm',
-  '/dns4/nyc-2.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64',
-  '/dns4/wss0.bootstrap.libp2p.io/tcp/443/wss/ipfs/QmZMxNdpMkewiVZLMRxaNxUeZpDUb34pWjZ1kZvsd16Zic',
-  '/dns4/wss1.bootstrap.libp2p.io/tcp/443/wss/ipfs/Qmbut9Ywz9YEDrz8ySBSgWyJk41Uvm2QJPhwDJzJyGFsD6'
+const bootstrapList = [
+  '/dns4/ams-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
+  '/dns4/sfo-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx',
+  '/dns4/lon-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3',
+  '/dns4/sfo-2.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z',
+  '/dns4/sfo-3.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
+  '/dns4/sgp-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
+  '/dns4/nyc-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm',
+  '/dns4/nyc-2.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64',
+  '/dns4/node0.preload.ipfs.io/tcp/443/wss/p2p/QmZMxNdpMkewiVZLMRxaNxUeZpDUb34pWjZ1kZvsd16Zic',
+  '/dns4/node0.preload.ipfs.io/tcp/443/wss/p2p/Qmbut9Ywz9YEDrz8ySBSgWyJk41Uvm2QJPhwDJzJyGFsD6'
 ]
 
 class Node extends libp2p {
-  constructor (peerInfo, peerBook, options) {
-    options = options || {}
+  constructor ({ peerInfo }) {
+    const wrtcStar = new WebRTCStar({ id: peerInfo.id })
+    const wsstar = new WebSocketStar({ id: peerInfo.id })
 
-    const wstar = new WebRTCStar()
-
-    const modules = {
-      transport: [
-        wstar,
-        new WebSockets()
-      ],
-      connection: {
-        muxer: [
-          Multiplex,
+    const defaults = {
+      modules: {
+        transport: [
+          wrtcStar,
+          WebSockets,
+          wsstar
+        ],
+        streamMuxer: [
+          Mplex,
           SPDY
         ],
-        crypto: [SECIO]
+        connEncryption: [
+          SECIO
+        ],
+        peerDiscovery: [
+          wrtcStar.discovery,
+          wsstar.discovery,
+          Bootstrap
+        ],
+        dht: DHT,
+        pubsub: Gossipsub
       },
-      discovery: [
-        wstar.discovery,
-        new Railing(bootstrapers)
-      ]
+      config: {
+        peerDiscovery: {
+          autoDial: true,
+          webRTCStar: {
+            enabled: true
+          },
+          websocketStar: {
+            enabled: true
+          },
+          bootstrap: {
+            interval: 20e3,
+            enabled: true,
+            list: bootstrapList
+          }
+        },
+        relay: {
+          enabled: true,
+          hop: {
+            enabled: false,
+            active: false
+          }
+        },
+        dht: {
+          enabled: false
+        },
+        pubsub: {
+          enabled: false
+        }
+      },
+      connectionManager: {
+        minPeers: 10,
+        maxPeers: 50
+      }
     }
 
-    super(modules, peerInfo, peerBook, options)
+    super({ ...defaults, peerInfo })
   }
 }
 

examples/libp2p-in-the-browser/1/src/create-node.js

@@ -10,11 +10,15 @@ function createNode (callback) {
     }
 
     const peerIdStr = peerInfo.id.toB58String()
-    const ma = `/dns4/star-signal.cloud.ipfs.team/wss/p2p-webrtc-star/ipfs/${peerIdStr}`
+    const webrtcAddr = `/dns4/star-signal.cloud.ipfs.team/tcp/443/wss/p2p-webrtc-star/p2p/${peerIdStr}`
+    const wsAddr = `/dns4/ws-star.discovery.libp2p.io/tcp/443/wss/p2p-websocket-star`
 
-    peerInfo.multiaddrs.add(ma)
+    peerInfo.multiaddrs.add(webrtcAddr)
+    peerInfo.multiaddrs.add(wsAddr)
 
-    const node = new Node(peerInfo)
+    const node = new Node({
+      peerInfo
+    })
 
     node.idStr = peerIdStr
     callback(null, node)

examples/libp2p-in-the-browser/1/src/index.js

@@ -1,3 +1,5 @@
+/* eslint no-console: ["error", { allow: ["log"] }] */
+/* eslint max-nested-callbacks: ["error", 5] */
 'use strict'
 
 const domReady = require('detect-dom-ready')
@@ -13,13 +15,7 @@ domReady(() => {
     }
 
     node.on('peer:discovery', (peerInfo) => {
-      console.log('Discovered a peer')
-      const idStr = peerInfo.id.toB58String()
-      console.log('Discovered: ' + idStr)
-
-      node.dial(peerInfo, (err, conn) => {
-        if (err) { return console.log('Failed to dial:', idStr) }
-      })
+      console.log('Discovered a peer:', peerInfo.id.toB58String())
     })
 
     node.on('peer:connect', (peerInfo) => {
@@ -33,13 +29,13 @@ domReady(() => {
 
     node.on('peer:disconnect', (peerInfo) => {
       const idStr = peerInfo.id.toB58String()
-      console.log('Lost connection to: ' + idStr)
-      document.getElementById(idStr).remove()
+      const el = document.getElementById(idStr)
+      el && el.remove()
     })
 
     node.start((err) => {
       if (err) {
-        return console.log('WebRTC not supported')
+        return console.log(err)
       }
 
       const idStr = node.peerInfo.id.toB58String()
@@ -50,6 +46,9 @@ domReady(() => {
       myPeerDiv.append(idDiv)
 
       console.log('Node is listening o/')
+      node.peerInfo.multiaddrs.toArray().forEach(ma => {
+        console.log(ma.toString())
+      })
 
       // NOTE: to stop the node
       // node.stop((err) => {})

examples/libp2p-in-the-browser/README.md

@@ -4,7 +4,15 @@ One of the primary goals with libp2p P2P was to get it fully working in the brow
 
 # 1. Setting up a simple app that lists connections to other nodes
 
-Simple go into the folder [1](./1) and execute the following
+Start by installing libp2p's dependencies.
+
+```bash
+> cd ../../
+> npm install
+> cd examples/libp2p-in-the-browser
+```
+
+Then simply go into the folder [1](./1) and execute the following
 
 ```bash
 > cd 1
@@ -12,5 +20,3 @@ Simple go into the folder [1](./1) and execute the following
 > npm start
 # open your browser in port :9090
 ```
-
-[Version Published on IPFS](http://ipfs.io/ipfs/Qmbc1J7ehw1dNYachbkCWPto4RsnVvqCKNVzmYEod2gXcy)

examples/peer-and-content-routing/1.js

@@ -1,27 +1,35 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const Multiplex = require('libp2p-multiplex')
+const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
 const KadDHT = require('libp2p-kad-dht')
-
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        // we add the DHT module that will enable Peer and Content Routing
+        dht: KadDHT
       },
-      // we add the DHT module that will enable Peer and Content Routing
-      DHT: KadDHT
+      config: {
+        dht: {
+          enabled: true,
+          kBucketSize: 20
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -32,7 +40,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))

examples/peer-and-content-routing/2.js

@@ -1,28 +1,36 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const Multiplex = require('libp2p-multiplex')
+const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
 const CID = require('cids')
 const KadDHT = require('libp2p-kad-dht')
-
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        // we add the DHT module that will enable Peer and Content Routing
+        dht: KadDHT
       },
-      // we add the DHT module that will enable Peer and Content Routing
-      DHT: KadDHT
+      config: {
+        dht: {
+          enabled: true,
+          kBucketSize: 20
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -33,7 +41,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))

examples/peer-and-content-routing/README.md

@@ -14,17 +14,25 @@ First, let's update our bundle to support Peer Routing and Content Routing.
 
 ```JavaScript
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        // we add the DHT module that will enable Peer and Content Routing
+        dht: KadDHT
       },
-      // we add the DHT module that will enable Peer and Content Routing
-      DHT: KadDHT
+      config: {
+        dht: {
+          // dht must be enabled
+          enabled: true,
+          kBucketSize: 20
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```
@@ -44,7 +52,7 @@ parallel([
 ], (err) => {
   if (err) { throw err }
 
-  // 
+  //
   node1.peerRouting.findPeer(node3.peerInfo.id, (err, peer) => {
     if (err) { throw err }
 
@@ -59,8 +67,8 @@ You should see the output being something like:
 ```Bash
 > node 1.js
 Found it, multiaddrs are:
-/ip4/127.0.0.1/tcp/63617/ipfs/QmWrFXvZr9S4iDqycyoyc2zDdrT1jg9wpdenUTdd1LTar6
-/ip4/192.168.86.41/tcp/63617/ipfs/QmWrFXvZr9S4iDqycyoyc2zDdrT1jg9wpdenUTdd1LTar6
+/ip4/127.0.0.1/tcp/63617/p2p/QmWrFXvZr9S4iDqycyoyc2zDdrT1jg9wpdenUTdd1LTar6
+/ip4/192.168.86.41/tcp/63617/p2p/QmWrFXvZr9S4iDqycyoyc2zDdrT1jg9wpdenUTdd1LTar6
 ```
 
 You have successfully used Peer Routing to find a peer that you were not directly connected. Now all you have to do is to dial to the multiaddrs you discovered.

examples/pnet-ipfs/.gitignore

@@ -0,0 +1 @@
+tmp/

examples/pnet-ipfs/README.md

@@ -0,0 +1,29 @@
+# Private Networking with IPFS
+This example shows how to set up a private network of IPFS nodes.
+
+## Setup
+Install dependencies:
+
+```
+npm install
+```
+
+## Run
+Running the example will cause two nodes with the same swarm key to be started and exchange basic information.
+
+```
+node index.js
+```
+
+### Using different keys
+This example includes `TASK` comments that can be used to try the example with different swarm keys. This will
+allow you to see how nodes will fail to connect if they are on different private networks and try to connect to
+one another.
+
+To change the swarm key of one of the nodes, look through `index.js` for comments starting with `TASK` to indicate
+where lines are that pertain to changing the swarm key of node 2.
+
+### Exploring the repos
+Once you've run the example you can take a look at the repos in the `./tmp` directory to see how they differ, including
+the swarm keys. You should see a `swarm.key` file in each of the repos and when the nodes are on the same private network
+this contents of the `swarm.key` files should be the same.

examples/pnet-ipfs/index.js

@@ -0,0 +1,145 @@
+/* eslint no-console: ["off"] */
+'use strict'
+
+const IPFS = require('ipfs')
+const assert = require('assert').strict
+const writeKey = require('libp2p-pnet').generate
+const path = require('path')
+const fs = require('fs')
+const privateLibp2pBundle = require('./libp2p-bundle')
+const { mkdirp } = require('./utils')
+
+// Create two separate repo paths so we can run two nodes and check their output
+const repo1 = path.resolve('./tmp', 'repo1', '.ipfs')
+const repo2 = path.resolve('./tmp', 'repo2', '.ipfs')
+mkdirp(repo1)
+mkdirp(repo2)
+
+// Create a buffer and write the swarm key to it
+const swarmKey = Buffer.alloc(95)
+writeKey(swarmKey)
+
+// This key is for the `TASK` mentioned in the writeFileSync calls below
+const otherSwarmKey = Buffer.alloc(95)
+writeKey(otherSwarmKey)
+
+// Add the swarm key to both repos
+const swarmKey1Path = path.resolve(repo1, 'swarm.key')
+const swarmKey2Path = path.resolve(repo2, 'swarm.key')
+fs.writeFileSync(swarmKey1Path, swarmKey)
+// TASK: switch the commented out line below so we're using a different key, to see the nodes fail to connect
+fs.writeFileSync(swarmKey2Path, swarmKey)
+// fs.writeFileSync(swarmKey2Path, otherSwarmKey)
+
+// Create the first ipfs node
+const node1 = new IPFS({
+  repo: repo1,
+  libp2p: privateLibp2pBundle(swarmKey1Path),
+  config: {
+    Addresses: {
+      // Set the swarm address so we dont get port collision on the nodes
+      Swarm: ['/ip4/0.0.0.0/tcp/9101']
+    }
+  }
+})
+
+// Create the second ipfs node
+const node2 = new IPFS({
+  repo: repo2,
+  libp2p: privateLibp2pBundle(swarmKey2Path),
+  config: {
+    Addresses: {
+      // Set the swarm address so we dont get port collision on the nodes
+      Swarm: ['/ip4/0.0.0.0/tcp/9102']
+    }
+  }
+})
+
+console.log('auto starting the nodes...')
+
+// `nodesStarted` keeps track of how many of our nodes have started
+let nodesStarted = 0
+/**
+ * Calls `connectAndTalk` when both nodes have started
+ * @returns {void}
+ */
+const didStartHandler = () => {
+  if (++nodesStarted === 2) {
+    // If both nodes are up, start talking
+    connectAndTalk()
+  }
+}
+
+/**
+ * Exits the process when all started nodes have stopped
+ * @returns {void}
+ */
+const didStopHandler = () => {
+  if (--nodesStarted < 1) {
+    console.log('all nodes stopped, exiting.')
+    process.exit(0)
+  }
+}
+
+/**
+ * Stops the running nodes
+ * @param {Error} err An optional error to log to the console
+ * @returns {void}
+ */
+const doStop = (err) => {
+  if (err) {
+    console.error(err)
+  }
+
+  console.log('Shutting down...')
+  node1.stop()
+  node2.stop()
+}
+
+/**
+ * Connects the IPFS nodes and transfers data between them
+ * @returns {void}
+ */
+const connectAndTalk = async () => {
+  console.log('connecting the nodes...')
+  const node2Id = await node2.id()
+  const dataToAdd = Buffer.from('Hello, private friend!')
+
+  // Connect the nodes
+  // This will error when different private keys are used
+  try {
+    await node1.swarm.connect(node2Id.addresses[0])
+  } catch (err) {
+    return doStop(err)
+  }
+  console.log('the nodes are connected, let\'s add some data')
+
+  // Add some data to node 1
+  let addedCID
+  try {
+    addedCID = await node1.files.add(dataToAdd)
+  } catch (err) {
+    return doStop(err)
+  }
+  console.log(`added ${addedCID[0].path} to the node1`)
+
+  // Retrieve the data from node 2
+  let cattedData
+  try {
+    cattedData = await node2.files.cat(addedCID[0].path)
+  } catch (err) {
+    return doStop(err)
+  }
+  assert.deepEqual(cattedData.toString(), dataToAdd.toString(), 'Should have equal data')
+  console.log(`successfully retrieved "${dataToAdd.toString()}" from node2`)
+
+  doStop()
+}
+
+// Wait for the nodes to boot
+node1.once('start', didStartHandler)
+node2.once('start', didStartHandler)
+
+// Listen for the nodes stopping so we can cleanup
+node1.once('stop', didStopHandler)
+node2.once('stop', didStopHandler)

examples/pnet-ipfs/libp2p-bundle.js

@@ -0,0 +1,60 @@
+'use strict'
+
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const fs = require('fs')
+const Protector = require('libp2p-pnet')
+
+/**
+ * Options for the libp2p bundle
+ * @typedef {Object} libp2pBundle~options
+ * @property {PeerInfo} peerInfo - The PeerInfo of the IPFS node
+ * @property {PeerBook} peerBook - The PeerBook of the IPFS node
+ * @property {Object} config - The config of the IPFS node
+ * @property {Object} options - The options given to the IPFS node
+ */
+
+/**
+ * privateLibp2pBundle returns a libp2p bundle function that will use the swarm
+ * key at the given `swarmKeyPath` to create the Protector
+ *
+ * @param {string} swarmKeyPath The path to our swarm key
+ * @returns {libp2pBundle} Returns a libp2pBundle function for use in IPFS creation
+ */
+const privateLibp2pBundle = (swarmKeyPath) => {
+  /**
+   * This is the bundle we will use to create our fully customized libp2p bundle.
+   *
+   * @param {libp2pBundle~options} opts The options to use when generating the libp2p node
+   * @returns {Libp2p} Our new libp2p node
+   */
+  const libp2pBundle = (opts) => {
+    // Set convenience variables to clearly showcase some of the useful things that are available
+    const peerInfo = opts.peerInfo
+    const peerBook = opts.peerBook
+
+    // Build and return our libp2p node
+    return new Libp2p({
+      peerInfo,
+      peerBook,
+      modules: {
+        transport: [TCP], // We're only using the TCP transport for this example
+        streamMuxer: [MPLEX], // We're only using mplex muxing
+        // Let's make sure to use identifying crypto in our pnet since the protector doesn't
+        // care about node identity, and only the presence of private keys
+        connEncryption: [SECIO],
+        // Leave peer discovery empty, we don't want to find peers. We could omit the property, but it's
+        // being left in for explicit readability.
+        // We should explicitly dial pnet peers, or use a custom discovery service for finding nodes in our pnet
+        peerDiscovery: [],
+        connProtector: new Protector(fs.readFileSync(swarmKeyPath))
+      }
+    })
+  }
+
+  return libp2pBundle
+}
+
+module.exports = privateLibp2pBundle

examples/pnet-ipfs/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "pnet-ipfs-example",
+  "version": "1.0.0",
+  "description": "An example of private networking with IPFS",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "ipfs": "~0.32.3",
+    "libp2p": "~0.23.1",
+    "libp2p-mplex": "~0.8.2",
+    "libp2p-pnet": "../../",
+    "libp2p-secio": "~0.10.0",
+    "libp2p-tcp": "~0.13.0"
+  }
+}

examples/pnet-ipfs/utils.js

@@ -0,0 +1,28 @@
+'use strict'
+const fs = require('fs')
+const path = require('path')
+
+/**
+ * mkdirp recursively creates needed folders for the given dir path
+ * @param {string} dir
+ * @returns {string} The path that was created
+ */
+module.exports.mkdirp = (dir) => {
+  return path
+    .resolve(dir)
+    .split(path.sep)
+    .reduce((acc, cur) => {
+      const currentPath = path.normalize(acc + path.sep + cur)
+
+      try {
+        fs.statSync(currentPath)
+      } catch (e) {
+        if (e.code === 'ENOENT') {
+          fs.mkdirSync(currentPath)
+        } else {
+          throw e
+        }
+      }
+      return currentPath
+    }, '')
+}

examples/protocol-and-stream-muxing/1.js

@@ -1,18 +1,22 @@
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const PeerInfo = require('peer-info')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 const pull = require('pull-stream')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ]
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -23,7 +27,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -75,20 +81,20 @@ parallel([
   })
   */
 
-  node1.dial(node2.peerInfo, '/your-protocol', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/your-protocol', (err, conn) => {
     if (err) { throw err }
     pull(pull.values(['my own protocol, wow!']), conn)
   })
 
   /*
-  node1.dial(node2.peerInfo, '/another-protocol/1.0.0', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/another-protocol/1.0.0', (err, conn) => {
     if (err) { throw err }
     pull(pull.values(['semver me please']), conn)
   })
   */
 
   /*
-  node1.dial(node2.peerInfo, '/custom-match-func/some-query', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/custom-match-func/some-query', (err, conn) => {
     if (err) { throw err }
     pull(pull.values(['do I fall into your criteria?']), conn)
   })

examples/protocol-and-stream-muxing/2.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const SPDY = require('libp2p-spdy')
 const PeerInfo = require('peer-info')
@@ -8,16 +8,18 @@ const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 const series = require('async/series')
 const pull = require('pull-stream')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [SPDY]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ SPDY ]
       }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -28,7 +30,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -60,17 +64,17 @@ parallel([
   })
 
   series([
-    (cb) => node1.dial(node2.peerInfo, '/a', (err, conn) => {
+    (cb) => node1.dialProtocol(node2.peerInfo, '/a', (err, conn) => {
       if (err) { throw err }
       pull(pull.values(['protocol (a)']), conn)
       cb()
     }),
-    (cb) => node1.dial(node2.peerInfo, '/b', (err, conn) => {
+    (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
       if (err) { throw err }
       pull(pull.values(['protocol (b)']), conn)
       cb()
     }),
-    (cb) => node1.dial(node2.peerInfo, '/b', (err, conn) => {
+    (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
       if (err) { throw err }
       pull(pull.values(['another conn on protocol (b)']), conn)
       cb()

examples/protocol-and-stream-muxing/3.js

@@ -1,6 +1,7 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const SPDY = require('libp2p-spdy')
 const PeerInfo = require('peer-info')
@@ -8,16 +9,18 @@ const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 const series = require('async/series')
 const pull = require('pull-stream')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [SPDY]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ SPDY ]
       }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -28,7 +31,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -60,12 +65,12 @@ parallel([
   })
 
   series([
-    (cb) => node1.dial(node2.peerInfo, '/node-2', (err, conn) => {
+    (cb) => node1.dialProtocol(node2.peerInfo, '/node-2', (err, conn) => {
       if (err) { throw err }
       pull(pull.values(['from 1 to 2']), conn)
       cb()
     }),
-    (cb) => node2.dial(node1.peerInfo, '/node-1', (err, conn) => {
+    (cb) => node2.dialProtocol(node1.peerInfo, '/node-1', (err, conn) => {
       if (err) { throw err }
       pull(pull.values(['from 2 to 1']), conn)
       cb()

examples/protocol-and-stream-muxing/README.md

@@ -8,7 +8,7 @@ The feature of agreeing on a protocol over an established connection is what we
 
 Let's see _protocol multiplexing_ in action! You will need the following modules for this example: `libp2p`, `libp2p-tcp`, `peer-info`, `async` and `pull-stream`. This example reuses the base left by the [Transports](../transports) example. You can see the complete solution at [1.js](./1.js).
 
-After creating the nodes, we need to tell libp2p which protocols to handle. 
+After creating the nodes, we need to tell libp2p which protocols to handle.
 
 ```JavaScript
 // ...
@@ -30,7 +30,7 @@ node2.handle('/your-protocol', (protocol, conn) => {
 After the protocol is _handled_, now we can dial to it.
 
 ```JavaScript
-node1.dial(node2.peerInfo, '/your-protocol', (err, conn) => {
+node1.dialProtocol(node2.peerInfo, '/your-protocol', (err, conn) => {
   if (err) { throw err }
   pull(pull.values(['my own protocol, wow!']), conn)
 })
@@ -47,7 +47,7 @@ node2.handle('/another-protocol/1.0.1', (protocol, conn) => {
   )
 })
 // ...
-node1.dial(node2.peerInfo, '/another-protocol/1.0.0', (err, conn) => {
+node1.dialProtocol(node2.peerInfo, '/another-protocol/1.0.0', (err, conn) => {
   if (err) { throw err }
   pull(pull.values(['semver me please']), conn)
 })
@@ -55,7 +55,7 @@ node1.dial(node2.peerInfo, '/another-protocol/1.0.0', (err, conn) => {
 
 This feature is super power for network protocols. It works in the same way as versioning your RPC/REST API, but for anything that goes in the wire. We had to use this feature to upgrade protocols within the IPFS Stack (i.e Bitswap) and we successfully managed to do so without any network splits.
 
-There is still one last feature, you can create your custom match functions. 
+There is still one last feature, you can create your custom match functions.
 
 ```JavaScript
 node2.handle('/custom-match-func', (protocol, conn) => {
@@ -74,7 +74,7 @@ node2.handle('/custom-match-func', (protocol, conn) => {
   }
 })
 // ...
-node1.dial(node2.peerInfo, '/custom-match-func/some-query', (err, conn) => {
+node1.dialProtocol(node2.peerInfo, '/custom-match-func/some-query', (err, conn) => {
   if (err) { throw err }
   pull(pull.values(['do I fall into your criteria?']), conn)
 })
@@ -88,23 +88,24 @@ The example above would require a node to create a whole new connection for ever
 
 Stream multiplexing is a old concept, in fact it happens in many of the layers of the [OSI System](https://en.wikipedia.org/wiki/OSI_model), in libp2p we make this feature to our avail by letting the user pick which module for stream multiplexing to use.
 
-Currently, we have two available [libp2p-spdy](https://github.com/libp2p/js-libp2p-spdy) and [libp2p-multiplex](https://github.com/libp2p/js-libp2p-multiplex) and pluging them in is as easy as adding another transport. Let's revisit our libp2p bundle.
+Currently, we have two available [libp2p-spdy](https://github.com/libp2p/js-libp2p-spdy) and [libp2p-mplex](https://github.com/libp2p/js-libp2p-mplex) and pluging them in is as easy as adding another transport. Let's revisit our libp2p bundle.
 
 ```JavaScript
 const SPDY = require('libp2p-spdy')
 //...
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      // Here we are adding the SPDY muxer to our libp2p bundle.
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        // Here we are adding the SPDY muxer to our libp2p bundle.
       // Thanks to protocol muxing, a libp2p bundle can support multiple Stream Muxers at the same
       // time and pick the right one when dialing to a node
-      connection: {
-        muxer: [SPDY]
+        streamMuxer: [ SPDY ]
       }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```
@@ -129,17 +130,17 @@ node2.handle('/b', (protocol, conn) => {
 })
 
 series([
-  (cb) => node1.dial(node2.peerInfo, '/a', (err, conn) => {
+  (cb) => node1.dialProtocol(node2.peerInfo, '/a', (err, conn) => {
     if (err) { throw err }
     pull(pull.values(['protocol (a)']), conn)
     cb()
   }),
-  (cb) => node1.dial(node2.peerInfo, '/b', (err, conn) => {
+  (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
     if (err) { throw err }
     pull(pull.values(['protocol (b)']), conn)
     cb()
   }),
-  (cb) => node1.dial(node2.peerInfo, '/b', (err, conn) => {
+  (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
     if (err) { throw err }
     pull(pull.values(['another conn on protocol (b)']), conn)
     cb()
@@ -158,9 +159,9 @@ another protocol (b)
 
 # 3. Bidirectional connections
 
-There is one last trick on _protocol and stream multiplexing_ that libp2p uses to make everyone's life easier and that is _biderectional connection_.
+There is one last trick on _protocol and stream multiplexing_ that libp2p uses to make everyone's life easier and that is _bidirectional connection_.
 
-With the aid of both mechanisms, we can reuse an incomming connection to dial streams out too, this is specially useful when you are behind tricky NAT, firewalls or if you are running in a browser, where you can have listening addrs, but you can dial out. By dialing out, you enable other peers to talk with you in Protocols that they want, simply by opening a new multiplexed stream.
+With the aid of both mechanisms, we can reuse an incomming connection to dial streams out too, this is specially useful when you are behind tricky NAT, firewalls or if you are running in a browser, where you can't have listening addrs, but you can dial out. By dialing out, you enable other peers to talk with you in Protocols that they want, simply by opening a new multiplexed stream.
 
 You can see this working on example [3.js](./3.js). The result should look like the following:
 
@@ -168,7 +169,7 @@ You can see this working on example [3.js](./3.js). The result should look like
 > node 3.js
 from 1 to 2
 Addresses by which both peers are connected
-node 1 to node 2: /ip4/127.0.0.1/tcp/50629/ipfs/QmZwMKTo6wG4Te9A6M2eJnWDpR8uhsGed4YRegnV5DcKiv
-node 2 to node 1: /ip4/127.0.0.1/tcp/50630/ipfs/QmRgormJQeDyXhDKma11eUtksoh8vWmeBoxghVt4meauW9
+node 1 to node 2: /ip4/127.0.0.1/tcp/50629/p2p/QmZwMKTo6wG4Te9A6M2eJnWDpR8uhsGed4YRegnV5DcKiv
+node 2 to node 1: /ip4/127.0.0.1/tcp/50630/p2p/QmRgormJQeDyXhDKma11eUtksoh8vWmeBoxghVt4meauW9
 from 2 to 1
 ```

examples/pubsub/1.js

@@ -1,27 +1,43 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const Multiplex = require('libp2p-multiplex')
+const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
 const MulticastDNS = require('libp2p-mdns')
-const FloodSub = require('libp2p-floodsub')
+const Gossipsub = require('libp2p-gossipsub')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
 const series = require('async/series')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Multiplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ MulticastDNS ],
+        pubsub: Gossipsub
       },
-      discovery: [new MulticastDNS(peerInfo, { interval: 2000 })]
+      config: {
+        peerDiscovery: {
+          mdns: {
+            interval: 2000,
+            enabled: true
+          }
+        },
+        pubsub: {
+          enabled: true,
+          emitSelf: true
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -32,7 +48,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -47,22 +65,39 @@ parallel([
   const node1 = nodes[0]
   const node2 = nodes[1]
 
-  const fs1 = new FloodSub(node1)
-  const fs2 = new FloodSub(node2)
+  node1.once('peer:connect', (peer) => {
+    console.log('connected to %s', peer.id.toB58String())
 
-  series([
-    (cb) => fs1.start(cb),
-    (cb) => fs2.start(cb),
-    (cb) => node1.once('peer:discovery', (peer) => node1.dial(peer, cb)),
-    (cb) => setTimeout(cb, 500)
-  ], (err) => {
-    if (err) { throw err }
-
-    fs2.on('news', (msg) => console.log(msg.from, msg.data.toString()))
-    fs2.subscribe('news')
-
-    setInterval(() => {
-      fs1.publish('news', Buffer.from('Bird bird bird, bird is the word!'))
-    }, 1000)
+    series([
+      // node1 subscribes to "news"
+      (cb) => node1.pubsub.subscribe(
+        'news',
+        (msg) => console.log(`node1 received: ${msg.data.toString()}`),
+        cb
+      ),
+      (cb) => setTimeout(cb, 500),
+      // node2 subscribes to "news"
+      (cb) => node2.pubsub.subscribe(
+        'news',
+        (msg) => console.log(`node2 received: ${msg.data.toString()}`),
+        cb
+      ),
+      (cb) => setTimeout(cb, 500),
+      // node2 publishes "news" every second
+      (cb) => {
+        setInterval(() => {
+          node2.pubsub.publish(
+            'news',
+            Buffer.from('Bird bird bird, bird is the word!'),
+            (err) => {
+              if (err) { throw err }
+            }
+          )
+        }, 1000)
+        cb()
+      },
+    ], (err) => {
+      if (err) { throw err }
+    })
   })
 })

examples/pubsub/README.md

@@ -1,8 +1,6 @@
 # Publish Subscribe
 
-Publish Subscribe is something out of scope for the modular networking stack that is libp2p, however, it is something that is enabled through the primitives that libp2p offers and so it has become one of the most interesting use cases for libp2p.
-
-Currently, we have a PubSub implementation, [libp2p-floodsub](https://github.com/libp2p/js-libp2p-floodsub) and many more being researched at [research-pubsub](https://github.com/libp2p/research-pubsub).
+Publish Subscribe is also included on the stack. Currently, we have two PubSub implementation available [libp2p-floodsub](https://github.com/libp2p/js-libp2p-floodsub) and [libp2p-gossipsub](https://github.com/ChainSafe/gossipsub-js), with many more being researched at [research-pubsub](https://github.com/libp2p/research-pubsub).
 
 We've seen many interesting use cases appear with this, here are some highlights:
 
@@ -12,30 +10,45 @@ We've seen many interesting use cases appear with this, here are some highlights
 
 ## 1. Setting up a simple PubSub network on top of libp2p
 
-For this example, we will use MulticastDNS for automatic Peer Discovery and libp2p-floodsub to give us the PubSub primitives we are looking for. This example is based the previous examples found in [Discovery Mechanisms](../discovery-mechanisms). You can find the complete version at [1.js](./1.js).
+For this example, we will use MulticastDNS for automatic Peer Discovery. This example is based the previous examples found in [Discovery Mechanisms](../discovery-mechanisms). You can find the complete version at [1.js](./1.js).
 
-Getting PubSub is super simple, all you have to do is require the FloodSub module and pass it in a libp2p node, once you have done that you can start subscribing and publishing in any topic.
+Using PubSub is super simple, you only need to provide the implementation of your choice and you are ready to go. No need for extra configuration.
 
 ```JavaScript
-const FloodSub = require('libp2p-floodsub')
+node1.once('peer:connect', (peer) => {
+  console.log('connected to %s', peer.id.toB58String())
 
-const fs1 = new FloodSub(node1)
-const fs2 = new FloodSub(node2)
-
-series([
-  (cb) => fs1.start(cb),
-  (cb) => fs2.start(cb),
-  (cb) => node1.once('peer:discovery', (peer) => node1.dial(peer, cb)),
-  (cb) => setTimeout(cb, 500)
-], (err) => {
-  if (err) { throw err }
-
-  fs2.on('news', (msg) => console.log(msg.from, msg.data.toString()))
-  fs2.subscribe('news')
-
-  setInterval(() => {
-    fs1.publish('news', Buffer.from('Bird bird bird, bird is the word!'))
-  }, 1000)
+  series([
+    // node1 subscribes to "news"
+    (cb) => node1.pubsub.subscribe(
+      'news',
+      (msg) => console.log(`node1 received: ${msg.data.toString()}`),
+      cb
+    ),
+    (cb) => setTimeout(cb, 500),
+    // node2 subscribes to "news"
+    (cb) => node2.pubsub.subscribe(
+      'news',
+      (msg) => console.log(`node2 received: ${msg.data.toString()}`),
+      cb
+    ),
+    (cb) => setTimeout(cb, 500),
+    // node2 publishes "news" every second
+    (cb) => {
+      setInterval(() => {
+        node2.pubsub.publish(
+          'news',
+          Buffer.from('Bird bird bird, bird is the word!'),
+          (err) => {
+            if (err) { throw err }
+          }
+        )
+      }, 1000)
+      cb()
+    },
+  ], (err) => {
+    if (err) { throw err }
+  })
 })
 ```
 
@@ -43,11 +56,30 @@ The output of the program should look like:
 
 ```
 > node 1.js
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
+connected to QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82
+node2 received: Bird bird bird, bird is the word!
+node1 received: Bird bird bird, bird is the word!
+node2 received: Bird bird bird, bird is the word!
+node1 received: Bird bird bird, bird is the word!
+```
+
+You can change the pubsub `emitSelf` option if you don't want the publishing node to receive its own messages.
+
+```JavaScript
+const defaults = {
+  config: {
+    peerDiscovery: {
+      mdns: {
+        interval: 2000,
+        enabled: true
+      }
+    },
+    pubsub: {
+      enabled: true,
+      emitSelf: false
+    }
+  }
+}
 ```
 
 ## 2. Future work

examples/transports/1.js

@@ -1,16 +1,23 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const PeerInfo = require('peer-info')
 const waterfall = require('async/waterfall')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [
+          TCP
+        ]
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -20,7 +27,7 @@ waterfall([
   (cb) => PeerInfo.create(cb),
   (peerInfo, cb) => {
     peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-    node = new MyBundle(peerInfo)
+    node = new MyBundle({ peerInfo: peerInfo })
     node.start(cb)
   }
 ], (err) => {

examples/transports/2.js

@@ -1,18 +1,25 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const PeerInfo = require('peer-info')
 const waterfall = require('async/waterfall')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const parallel = require('async/parallel')
 const pull = require('pull-stream')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [
+          TCP
+        ]
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -23,7 +30,7 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({ peerInfo: peerInfo })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -54,7 +61,7 @@ parallel([
     )
   })
 
-  node1.dial(node2.peerInfo, '/print', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
     if (err) { throw err }
 
     pull(pull.values(['Hello', ' ', 'p2p', ' ', 'world', '!']), conn)

examples/transports/3.js

@@ -1,19 +1,27 @@
+/* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const WebSockets = require('libp2p-websockets')
 const PeerInfo = require('peer-info')
 const waterfall = require('async/waterfall')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const parallel = require('async/parallel')
 const pull = require('pull-stream')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP(), new WebSockets()]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [
+          TCP,
+          WebSockets
+        ]
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -28,7 +36,7 @@ function createNode (addrs, callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       addrs.forEach((addr) => peerInfo.multiaddrs.add(addr))
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({ peerInfo: peerInfo })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -66,19 +74,19 @@ parallel([
   node2.handle('/print', print)
   node3.handle('/print', print)
 
-  node1.dial(node2.peerInfo, '/print', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
     if (err) { throw err }
 
     pull(pull.values(['node 1 dialed to node 2 successfully']), conn)
   })
 
-  node2.dial(node3.peerInfo, '/print', (err, conn) => {
+  node2.dialProtocol(node3.peerInfo, '/print', (err, conn) => {
     if (err) { throw err }
 
     pull(pull.values(['node 2 dialed to node 3 successfully']), conn)
   })
 
-  node3.dial(node1.peerInfo, '/print', (err, conn) => {
+  node3.dialProtocol(node1.peerInfo, '/print', (err, conn) => {
     if (err) {
       console.log('node 3 failed to dial to node 1 with:', err.message)
     }

examples/transports/README.md

@@ -10,10 +10,10 @@ A more complete definition of what is a transport can be found on the [interface
 
 When using libp2p, you always want to create your own libp2p Bundle, that is, pick your set of modules and create your network stack with the properties you need. In this example, we will create a bundle with TCP. You can find the complete solution on the file [1.js](./1.js).
 
-You will need 4 deps total, so go ahead and install all of them with: 
+You will need 5 deps total, so go ahead and install all of them with:
 
-```
-> npm install libp2p libp2p-tcp peer-info async
+```bash
+> npm install libp2p libp2p-tcp peer-info async @nodeutils/defaults-deep
 ```
 
 Then, on your favorite text editor create a file with the `.js` extension. I've called mine `1.js`.
@@ -27,16 +27,22 @@ const libp2p = require('libp2p')
 const TCP = require('libp2p-tcp')
 const PeerInfo = require('peer-info')
 const waterfall = require('async/waterfall')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 // This MyBundle class is your libp2p bundle packed with TCP
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    // modules is a JS object that will describe the components
-    // we want for our libp2p bundle
-    const modules = {
-      transport: [new TCP()]
+  constructor (_options) {
+    const defaults = {
+      // modules is a JS object that will describe the components
+      // we want for our libp2p bundle
+      modules: {
+        transport: [
+          TCP
+        ]
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```
@@ -57,7 +63,7 @@ waterfall([
     // the multiaddr format, a self describable address
     peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
     // Now we can create a node with that PeerInfo object
-    node = new MyBundle(peerInfo)
+    node = new MyBundle({ peerInfo: peerInfo })
     // Last, we start the node!
     node.start(cb)
   }
@@ -76,14 +82,14 @@ waterfall([
 })
 ```
 
-Running this should result in somehting like:
+Running this should result in something like:
 
 ```bash
 > node 1.js
 node has started (true/false): true
 listening on:
-/ip4/127.0.0.1/tcp/61329/ipfs/QmW2cKTakTYqbQkUzBTEGXgWYFj1YEPeUndE1YWs6CBzDQ
-/ip4/192.168.2.156/tcp/61329/ipfs/QmW2cKTakTYqbQkUzBTEGXgWYFj1YEPeUndE1YWs6CBzDQ
+/ip4/127.0.0.1/tcp/61329/p2p/QmW2cKTakTYqbQkUzBTEGXgWYFj1YEPeUndE1YWs6CBzDQ
+/ip4/192.168.2.156/tcp/61329/p2p/QmW2cKTakTYqbQkUzBTEGXgWYFj1YEPeUndE1YWs6CBzDQ
 ```
 
 That `QmW2cKTakTYqbQkUzBTEGXgWYFj1YEPeUndE1YWs6CBzDQ` is the PeerId that was created during the PeerInfo generation.
@@ -98,6 +104,12 @@ For this step, we will need one more dependency.
 > npm install pull-stream
 ```
 
+And we also need to import the module on our .js file:
+
+```js
+const pull = require('pull-stream')
+```
+
 We are going to reuse the MyBundle class from step 1, but this time to make things simpler, we will create two functions, one to create nodes and another to print the addrs to avoid duplicating code.
 
 ```JavaScript
@@ -108,7 +120,7 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({ peerInfo: peerInfo })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -118,11 +130,18 @@ function printAddrs (node, number) {
   console.log('node %s is listening on:', number)
   node.peerInfo.multiaddrs.forEach((ma) => console.log(ma.toString()))
 }
-```
-
-Now we are going to use `async/parallel` to create two nodes, print their addresses and dial from one node to the other.
 
 ```
+
+Now we are going to use `async/parallel` to create two nodes, print their addresses and dial from one node to the other. We already added `async` as a dependency, but still need to import `async/parallel`:
+
+```js
+const parallel = require('async/parallel')
+```
+
+Then,
+
+```js
 parallel([
   (cb) => createNode(cb),
   (cb) => createNode(cb)
@@ -143,7 +162,7 @@ parallel([
     )
   })
 
-  node1.dial(node2.peerInfo, '/print', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
     if (err) { throw err }
 
     pull(pull.values(['Hello', ' ', 'p2p', ' ', 'world', '!']), conn)
@@ -156,11 +175,11 @@ The result should be look like:
 ```bash
 > node 2.js
 node 1 is listening on:
-/ip4/127.0.0.1/tcp/62279/ipfs/QmeM4wNWv1uci7UJjUXZYfvcy9uqAbw7G9icuxdqy88Mj9
-/ip4/192.168.2.156/tcp/62279/ipfs/QmeM4wNWv1uci7UJjUXZYfvcy9uqAbw7G9icuxdqy88Mj9
+/ip4/127.0.0.1/tcp/62279/p2p/QmeM4wNWv1uci7UJjUXZYfvcy9uqAbw7G9icuxdqy88Mj9
+/ip4/192.168.2.156/tcp/62279/p2p/QmeM4wNWv1uci7UJjUXZYfvcy9uqAbw7G9icuxdqy88Mj9
 node 2 is listening on:
-/ip4/127.0.0.1/tcp/62278/ipfs/QmWp58xJgzbouNJcyiNNTpZuqQCJU8jf6ixc7TZT9xEZhV
-/ip4/192.168.2.156/tcp/62278/ipfs/QmWp58xJgzbouNJcyiNNTpZuqQCJU8jf6ixc7TZT9xEZhV
+/ip4/127.0.0.1/tcp/62278/p2p/QmWp58xJgzbouNJcyiNNTpZuqQCJU8jf6ixc7TZT9xEZhV
+/ip4/192.168.2.156/tcp/62278/p2p/QmWp58xJgzbouNJcyiNNTpZuqQCJU8jf6ixc7TZT9xEZhV
 Hello p2p world!
 ```
 
@@ -172,7 +191,7 @@ What we are going to do in this step is to create 3 nodes, one with TCP, another
 
 In this example, we will need to also install `libp2p-websockets`, go ahead and install:
 
-```sh
+```bash
 > npm install libp2p-websockets
 ```
 
@@ -183,11 +202,17 @@ const WebSockets = require('libp2p-websockets')
 // ...
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP(), new WebSockets()]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [
+          TCP,
+          WebSockets
+        ]
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```
@@ -206,7 +231,7 @@ function createNode (addrs, callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       addrs.forEach((addr) => peerInfo.multiaddrs.add(addr))
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({ peerInfo: peerInfo })
       node.start(cb)
     }
   ], (err) => callback(err, node))
@@ -240,21 +265,21 @@ parallel([
   node3.handle('/print', print)
 
   // node 1 (TCP) dials to node 2 (TCP+WebSockets)
-  node1.dial(node2.peerInfo, '/print', (err, conn) => {
+  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
     if (err) { throw err }
 
     pull(pull.values(['node 1 dialed to node 2 successfully']), conn)
   })
 
   // node 2 (TCP+WebSockets) dials to node 2 (WebSockets)
-  node2.dial(node3.peerInfo, '/print', (err, conn) => {
+  node2.dialProtocol(node3.peerInfo, '/print', (err, conn) => {
     if (err) { throw err }
 
     pull(pull.values(['node 2 dialed to node 3 successfully']), conn)
   })
 
   // node 3 (WebSockets) attempts to dial to node 1 (TCP)
-  node3.dial(node1.peerInfo, '/print', (err, conn) => {
+  node3.dialProtocol(node1.peerInfo, '/print', (err, conn) => {
     if (err) {
       console.log('node 3 failed to dial to node 1 with:', err.message)
     }
@@ -279,14 +304,14 @@ If everything was set correctly, you now should see the following after you run
 ```Bash
 > node 3.js
 node 1 is listening on:
-/ip4/127.0.0.1/tcp/62620/ipfs/QmWpWmcVJkF6EpmAaVDauku8g1uFGuxPsGP35XZp9GYEqs
-/ip4/192.168.2.156/tcp/62620/ipfs/QmWpWmcVJkF6EpmAaVDauku8g1uFGuxPsGP35XZp9GYEqs
+/ip4/127.0.0.1/tcp/62620/p2p/QmWpWmcVJkF6EpmAaVDauku8g1uFGuxPsGP35XZp9GYEqs
+/ip4/192.168.2.156/tcp/62620/p2p/QmWpWmcVJkF6EpmAaVDauku8g1uFGuxPsGP35XZp9GYEqs
 node 2 is listening on:
-/ip4/127.0.0.1/tcp/10000/ws/ipfs/QmWAQtWdzWXibgfyc7WRHhhv6MdqVKzXvyfSTnN2aAvixX
-/ip4/127.0.0.1/tcp/62619/ipfs/QmWAQtWdzWXibgfyc7WRHhhv6MdqVKzXvyfSTnN2aAvixX
-/ip4/192.168.2.156/tcp/62619/ipfs/QmWAQtWdzWXibgfyc7WRHhhv6MdqVKzXvyfSTnN2aAvixX
+/ip4/127.0.0.1/tcp/10000/ws/p2p/QmWAQtWdzWXibgfyc7WRHhhv6MdqVKzXvyfSTnN2aAvixX
+/ip4/127.0.0.1/tcp/62619/p2p/QmWAQtWdzWXibgfyc7WRHhhv6MdqVKzXvyfSTnN2aAvixX
+/ip4/192.168.2.156/tcp/62619/p2p/QmWAQtWdzWXibgfyc7WRHhhv6MdqVKzXvyfSTnN2aAvixX
 node 3 is listening on:
-/ip4/127.0.0.1/tcp/20000/ws/ipfs/QmVq1PWh3VSDYdFqYMtqp4YQyXcrH27N7968tGdM1VQPj1
+/ip4/127.0.0.1/tcp/20000/ws/p2p/QmVq1PWh3VSDYdFqYMtqp4YQyXcrH27N7968tGdM1VQPj1
 node 3 failed to dial to node 1 with: No available transport to dial to
 node 1 dialed to node 2 successfully
 node 2 dialed to node 3 successfully
@@ -298,8 +323,8 @@ As expected, we created 3 nodes, node 1 with TCP, node 2 with TCP+WebSockets and
 
 Today there are already 3 transports available, one in the works and plenty to come, you can find these at [interface-transport implementations](https://github.com/libp2p/interface-transport#modules-that-implement-the-interface) list.
 
-Adding more transports is done through the same way as you added TCP and WebSockets. Some transports might offer extra functionalities but for what is libp2p concern, as long as it follows the interface defined at the [spec](https://github.com/libp2p/interface-transport#api), it will be able to use it.
+Adding more transports is done through the same way as you added TCP and WebSockets. Some transports might offer extra functionalities, but as far as libp2p is concerned, if it follows the interface defined at the [spec](https://github.com/libp2p/interface-transport#api) it will be able to use it.
 
 If you decide to implement a transport yourself, please consider adding to the list so that others can use it as well.
 
-Hope this tutorial was useful. We are always looking to improve it, contributions are welcome!
+Hope this tutorial was useful. We are always looking to improve it, so contributions are welcome!

package-list.json

@@ -0,0 +1,66 @@
+{
+  "columns": [
+    "Package",
+    "Version",
+    "Deps",
+    "CI",
+    "Coverage",
+    "Lead Maintainer"
+  ],
+  "rows": [
+    "Libp2p",
+    ["libp2p/interface-libp2p", "interface-libp2p"],
+    ["libp2p/js-libp2p", "libp2p"],
+
+    "Connection",
+    ["libp2p/interface-connection", "interface-connection"],
+
+    "Transport",
+    ["libp2p/interface-transport", "interface-transport"],
+    ["libp2p/js-libp2p-tcp", "libp2p-tcp"],
+    ["libp2p/js-libp2p-utp", "libp2p-utp"],
+    ["libp2p/js-libp2p-webrtc-direct", "libp2p-webrtc-direct"],
+    ["libp2p/js-libp2p-webrtc-star", "libp2p-webrtc-star"],
+    ["libp2p/js-libp2p-websockets", "libp2p-websockets"],
+    ["libp2p/js-libp2p-websocket-star", "libp2p-websocket-star"],
+
+    "Crypto Channels",
+    ["libp2p/js-libp2p-secio", "libp2p-secio"],
+
+    "Stream Muxers",
+    ["libp2p/interface-stream-muxer", "interface-stream-muxer"],
+    ["libp2p/js-libp2p-mplex", "libp2p-mplex"],
+    ["libp2p/js-libp2p-spdy", "libp2p-spdy"],
+
+    "Discovery",
+    ["libp2p/interface-peer-discovery", "interface-peer-discovery"],
+    ["libp2p/js-libp2p-bootstrap", "libp2p-bootstrap"],
+    ["libp2p/js-libp2p-kad-dht", "libp2p-kad-dht"],
+    ["libp2p/js-libp2p-mdns", "libp2p-mdns"],
+    ["libp2p/js-libp2p-rendezvous", "libp2p-rendezvous"],
+    ["libp2p/js-libp2p-webrtc-star", "libp2p-webrtc-star"],
+    ["libp2p/js-libp2p-websocket-star", "libp2p-websocket-star"],
+
+    "Content Routing",
+    ["libp2p/interface-content-routing", "interface-content-routing"],
+    ["libp2p/js-libp2p-delegated-content-routing", "libp2p-delegated-content-routing"],
+    ["libp2p/js-libp2p-kad-dht", "libp2p-kad-dht"],
+
+    "Peer Routing",
+    ["libp2p/interface-peer-routing", "interface-peer-routing"],
+    ["libp2p/js-libp2p-delegated-peer-routing", "libp2p-delegated-peer-routing"],
+    ["libp2p/js-libp2p-kad-dht", "libp2p-kad-dht"],
+
+    "Utilities",
+    ["libp2p/js-libp2p-crypto", "libp2p-crypto"],
+    ["libp2p/js-libp2p-crypto-secp256k1", "libp2p-crypto-secp256k1"],
+
+    "Data Types",
+    ["libp2p/js-peer-book", "peer-book"],
+    ["libp2p/js-peer-id", "peer-id"],
+    ["libp2p/js-peer-info", "peer-info"],
+
+    "Extensions",
+    ["libp2p/js-libp2p-floodsub", "libp2p-floodsub"]
+  ]
+}

package.json

@@ -1,8 +1,13 @@
 {
   "name": "libp2p",
-  "version": "0.14.3",
-  "description": "JavaScript base class for libp2p bundles",
+  "version": "0.26.2",
+  "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
+  "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
+  "files": [
+    "dist",
+    "src"
+  ],
   "scripts": {
     "lint": "aegir lint",
     "build": "aegir build",
@@ -12,84 +17,152 @@
     "release": "aegir release -t node -t browser",
     "release-minor": "aegir release --type minor -t node -t browser",
     "release-major": "aegir release --type major -t node -t browser",
-    "coverage": "aegir coverage",
-    "coverage-publish": "aegir coverage --provider coveralls"
+    "coverage": "nyc --reporter=text --reporter=lcov npm run test:node"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/libp2p/js-libp2p.git"
   },
   "keywords": [
+    "libp2p",
+    "network",
+    "p2p",
+    "peer",
+    "peer-to-peer",
     "IPFS"
   ],
-  "engines": {
-    "node": ">=6.0.0",
-    "npm": ">=3.0.0"
-  },
-  "pre-commit": [
-    "lint",
-    "test"
-  ],
-  "author": "David Dias <daviddias@ipfs.io>",
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/libp2p/js-libp2p/issues"
   },
-  "homepage": "https://github.com/libp2p/js-libp2p",
+  "homepage": "https://libp2p.io",
+  "license": "MIT",
+  "browser": {
+    "./test/utils/bundle-nodejs": "./test/utils/bundle-browser"
+  },
+  "engines": {
+    "node": ">=10.0.0",
+    "npm": ">=6.0.0"
+  },
   "dependencies": {
-    "async": "^2.6.0",
-    "libp2p-ping": "~0.6.0",
-    "libp2p-swarm": "~0.34.0",
-    "mafmt": "^3.0.2",
-    "multiaddr": "^3.0.1",
-    "peer-book": "~0.5.2",
-    "peer-id": "~0.10.3",
-    "peer-info": "~0.11.3"
+    "async": "^2.6.2",
+    "bignumber.js": "^9.0.0",
+    "class-is": "^1.1.0",
+    "debug": "^4.1.1",
+    "err-code": "^1.1.2",
+    "fsm-event": "^2.1.0",
+    "hashlru": "^2.3.0",
+    "interface-connection": "~0.3.3",
+    "latency-monitor": "~0.2.1",
+    "libp2p-crypto": "~0.16.1",
+    "libp2p-websockets": "^0.12.2",
+    "mafmt": "^6.0.7",
+    "merge-options": "^1.0.1",
+    "moving-average": "^1.0.0",
+    "multiaddr": "^6.1.0",
+    "multistream-select": "~0.14.6",
+    "once": "^1.4.0",
+    "peer-book": "^0.9.1",
+    "peer-id": "^0.12.2",
+    "peer-info": "~0.15.1",
+    "pull-cat": "^1.1.11",
+    "pull-defer": "~0.2.3",
+    "pull-handshake": "^1.1.4",
+    "pull-reader": "^1.3.1",
+    "pull-stream": "^3.6.9",
+    "promisify-es6": "^1.0.3",
+    "protons": "^1.0.1",
+    "retimer": "^2.0.0",
+    "superstruct": "^0.6.0",
+    "xsalsa20": "^1.0.2"
   },
   "devDependencies": {
-    "aegir": "^12.2.0",
-    "chai": "^4.1.2",
-    "cids": "~0.5.2",
+    "@nodeutils/defaults-deep": "^1.1.0",
+    "aegir": "^20.0.0",
+    "chai": "^4.2.0",
+    "chai-checkmark": "^1.0.1",
+    "cids": "^0.7.1",
+    "delay": "^4.3.0",
     "dirty-chai": "^2.0.1",
-    "electron-webrtc": "~0.3.0",
-    "libp2p-circuit": "~0.1.4",
-    "libp2p-kad-dht": "~0.6.0",
-    "libp2p-mdns": "~0.9.1",
-    "libp2p-multiplex": "~0.5.1",
-    "libp2p-railing": "~0.7.1",
-    "libp2p-secio": "~0.8.1",
-    "libp2p-spdy": "~0.11.0",
-    "libp2p-tcp": "~0.11.1",
-    "libp2p-webrtc-star": "~0.13.3",
-    "libp2p-websockets": "~0.10.4",
-    "libp2p-websocket-star": "~0.7.2",
-    "libp2p-websocket-star-rendezvous": "~0.2.2",
+    "electron-webrtc": "^0.3.0",
+    "interface-datastore": "^0.6.0",
+    "libp2p-bootstrap": "^0.9.7",
+    "libp2p-delegated-content-routing": "^0.2.2",
+    "libp2p-delegated-peer-routing": "^0.2.2",
+    "libp2p-floodsub": "~0.17.0",
+    "libp2p-gossipsub": "~0.0.4",
+    "libp2p-kad-dht": "^0.15.3",
+    "libp2p-mdns": "^0.12.3",
+    "libp2p-mplex": "^0.8.4",
+    "libp2p-pnet": "~0.1.0",
+    "libp2p-secio": "^0.11.1",
+    "libp2p-spdy": "^0.13.2",
+    "libp2p-tcp": "^0.13.0",
+    "libp2p-webrtc-star": "^0.16.1",
+    "libp2p-websocket-star": "~0.10.2",
+    "libp2p-websocket-star-rendezvous": "~0.4.1",
     "lodash.times": "^4.3.2",
-    "pre-commit": "^1.2.2",
+    "nock": "^10.0.6",
+    "portfinder": "^1.0.20",
     "pull-goodbye": "0.0.2",
-    "pull-serializer": "~0.3.2",
-    "pull-stream": "^3.6.1",
-    "safe-buffer": "^5.1.1",
-    "sinon": "^4.1.3",
-    "wrtc": "0.0.63"
+    "pull-length-prefixed": "^1.3.3",
+    "pull-mplex": "^0.1.2",
+    "pull-pair": "^1.1.0",
+    "pull-protocol-buffers": "~0.1.2",
+    "pull-serializer": "^0.3.2",
+    "sinon": "^7.2.7",
+    "wrtc": "^0.4.1"
   },
   "contributors": [
+    "Aditya Bose <13054902+adbose@users.noreply.github.com>",
+    "Alan Shaw <alan.shaw@protocol.ai>",
+    "Alan Shaw <alan@tableflip.io>",
+    "Alex Potsides <alex@achingbrain.net>",
+    "Andrew Nesbitt <andrewnez@gmail.com>",
     "Chris Bratlien <chrisbratlien@gmail.com>",
+    "Chris Dostert <chrisdostert@users.noreply.github.com>",
     "Daijiro Wachi <daijiro.wachi@gmail.com>",
     "David Dias <daviddias.p@gmail.com>",
+    "Diogo Silva <fsdiogo@gmail.com>",
     "Dmitriy Ryajov <dryajov@gmail.com>",
     "Elven <mon.samuel@qq.com>",
+    "Fei Liu <liu.feiwood@gmail.com>",
+    "Florian-Merle <florian.david.merle@gmail.com>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Giovanni T. Parra <fiatjaf@gmail.com>",
+    "Guy Sviry <32539816+guysv@users.noreply.github.com>",
+    "Henrique Dias <hacdias@gmail.com>",
+    "Hugo Dias <mail@hugodias.me>",
+    "Hugo Dias <hugomrdias@gmail.com>",
+    "Irakli Gozalishvili <rfobic@gmail.com>",
+    "Jacob Heun <jacobheun@gmail.com>",
     "Joel Gustafson <joelg@mit.edu>",
+    "John Rees <johnrees@users.noreply.github.com>",
+    "João Santos <joaosantos15@users.noreply.github.com>",
+    "Kevin Kwok <antimatter15@gmail.com>",
     "Lars Gierth <lgierth@users.noreply.github.com>",
     "Maciej Krüger <mkg20001@gmail.com>",
+    "Marcin Tojek <mtojek@users.noreply.github.com>",
     "Nuno Nogueira <nunofmn@gmail.com>",
+    "Pedro Teixeira <pedro@protocol.ai>",
     "Pedro Teixeira <i@pgte.me>",
     "RasmusErik Voel Jensen <github@solsort.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "Ryan Bell <ryan@piing.net>",
+    "Soeren <nikorpoulsen@gmail.com>",
+    "Sönke Hahn <soenkehahn@gmail.com>",
+    "Thomas Eizinger <thomas@eizinger.io>",
+    "Tiago Alves <alvesjtiago@gmail.com>",
+    "Vasco Santos <vasco.santos@moxy.studio>",
+    "Vasco Santos <vasco.santos@ua.pt>",
+    "Volker Mische <volker.mische@gmail.com>",
+    "Yusef Napora <yusef@napora.org>",
+    "Zane Starr <zcstarr@gmail.com>",
+    "a1300 <a1300@users.noreply.github.com>",
+    "ebinks <elizabethjbinks@gmail.com>",
     "greenkeeperio-bot <support@greenkeeper.io>",
+    "isan_rivkin <isanrivkin@gmail.com>",
     "mayerwin <mayerwin@users.noreply.github.com>",
+    "swedneck <40505480+swedneck@users.noreply.github.com>",
     "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
   ]
 }

pdd/README.md

@@ -0,0 +1,3 @@
+# PDD Test Stories Implementation
+
+> Implementation of the Compliance tests from https://github.com/libp2p/interop

pdd/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "pdd-impl",
+  "version": "0.0.0",
+  "description": "PDD Test Stories implementation",
+  "repository": {
+    "type": "git",
+    "url": "  "
+  },
+  "keywords": [
+    "PDD",
+    "libp2p"
+  ],
+  "author": "David Dias <daviddias@ipfs.io>",
+  "license": "MIT",
+  "dependencies": {
+    "libp2p": "file:./..",
+    "libp2p-interop": "github:libp2p/interop#master",
+    "tape": "^4.8.0"
+  }
+}

pdd/pdd-the-ipfs-bundle--story-1--peer-a.js

@@ -0,0 +1,104 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const WebSockets = require('libp2p-websockets')
+const SECIO = require('libp2p-secio')
+const Multiplex = require('libp2p-multiplex')
+const Railing = require('libp2p-railing')
+const MulticastDNS = require('libp2p-mdns')
+const KadDHT = require('libp2p-kad-dht')
+const PeerInfo = require('peer-info')
+const pull = require('pull-stream')
+const waterfall = require('async/waterfall')
+const series = require('async/series')
+const PeerA = require('libp2p-interop/peer-a.json')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class IPFSBundle extends libp2p {
+  constructor (peerInfo, options) {
+    options = Object.assign({ bootstrap: [] }, options)
+
+    const modules = {
+      transport: [
+        new TCP(),
+        new WebSockets()
+      ],
+      connection: {
+        muxer: [
+          Multiplex
+        ],
+        crypto: [
+          SECIO
+        ]
+      },
+      discovery: [
+        new MulticastDNS(peerInfo, 'ipfs.local'),
+        new Railing(options.bootstrap)
+      ],
+      DHT: KadDHT
+    }
+
+    super(modules, peerInfo, undefined, options)
+  }
+}
+
+test('story 1 - peerA', (t) => {
+  t.plan(10)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerA, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10000')
+      node = new IPFSBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err, 'created Node successfully')
+    t.ok(node.isStarted(), 'PeerA is Running')
+
+    const peerBAddr = `/ip4/127.0.0.1/tcp/10001/p2p/${PeerB.id}`
+
+    node.handle('/time/1.0.0', (protocol, conn) => {
+      pull(
+        pull.values([Date.now().toString()]),
+        conn,
+        pull.onEnd((err) => {
+          t.ifErr(err)
+          t.pass('Sent time successfully')
+        })
+      )
+    })
+
+    series([
+      (cb) => setTimeout(cb, 5 * 1000), // time to run both scripts
+      (cb) => node.ping(peerBAddr, (err, p) => {
+        t.ifErr(err, 'initiated Ping to PeerB')
+        p.once('error', (err) => t.ifErr(err, 'Ping should not fail'))
+        p.once('ping', (time) => {
+          t.pass('ping PeerB successfully')
+          p.stop()
+          cb()
+        })
+      }),
+      (cb) => node.dial(peerBAddr, '/echo/1.0.0', (err, conn) => {
+        t.ifErr(err, 'dial successful')
+
+        const data = Buffer.from('Hey')
+
+        pull(
+          pull.values([data]),
+          conn,
+          pull.collect((err, values) => {
+            t.ifErr(err, 'Received echo back')
+            t.deepEqual(values[0], data)
+            cb()
+          })
+        )
+      }),
+      (cb) => setTimeout(cb, 2 * 1000) // time to both finish
+    ], () => node.stop((err) => t.ifErr(err, 'PeerA has stopped')))
+  })
+})

pdd/pdd-the-ipfs-bundle--story-1--peer-b.js

@@ -0,0 +1,98 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const WebSockets = require('libp2p-websockets')
+const SECIO = require('libp2p-secio')
+const Multiplex = require('libp2p-multiplex')
+const Railing = require('libp2p-railing')
+const MulticastDNS = require('libp2p-mdns')
+const KadDHT = require('libp2p-kad-dht')
+const PeerInfo = require('peer-info')
+const pull = require('pull-stream')
+const waterfall = require('async/waterfall')
+const series = require('async/series')
+const PeerA = require('libp2p-interop/peer-a.json')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class IPFSBundle extends libp2p {
+  constructor (peerInfo, options) {
+    options = Object.assign({ bootstrap: [] }, options)
+
+    const modules = {
+      transport: [
+        new TCP(),
+        new WebSockets()
+      ],
+      connection: {
+        muxer: [
+          Multiplex
+        ],
+        crypto: [
+          SECIO
+        ]
+      },
+      discovery: [
+        new MulticastDNS(peerInfo, 'ipfs.local'),
+        new Railing(options.bootstrap)
+      ],
+      DHT: KadDHT
+    }
+
+    super(modules, peerInfo, undefined, options)
+  }
+}
+
+test('story 1 - peerA', (t) => {
+  t.plan(8)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerB, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10001')
+      node = new IPFSBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err, 'created Node successfully')
+    t.ok(node.isStarted(), 'PeerB is Running')
+
+    const peerAAddr = `/ip4/127.0.0.1/tcp/10000/p2p/${PeerA.id}`
+
+    node.handle('/echo/1.0.0', (protocol, conn) => {
+      pull(
+        conn,
+        conn,
+        pull.onEnd((err) => t.ifErr(err, 'echo was successful'))
+      )
+    })
+
+    series([
+      (cb) => setTimeout(cb, 5 * 1000), // time to run both scripts
+      (cb) => node.ping(peerAAddr, (err, p) => {
+        t.ifErr(err, 'initiated Ping to PeerA')
+        p.once('error', (err) => t.ifErr(err, 'Ping should not fail'))
+        p.once('ping', (time) => {
+          t.pass('ping PeerA successfully')
+          p.stop()
+          cb()
+        })
+      }),
+      (cb) => node.dial(peerAAddr, '/time/1.0.0', (err, conn) => {
+        t.ifErr(err, 'dial successful')
+
+        pull(
+          pull.values([]),
+          conn,
+          pull.collect((err, values) => {
+            t.ifErr(err, 'Received time')
+            cb()
+          })
+        )
+      }),
+      (cb) => setTimeout(cb, 2 * 1000) // time to both finish
+    ], () => node.stop((err) => t.ifErr(err, 'PeerB has stopped')))
+  })
+})

pdd/pdd-transport--story-1--peer-a.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const PeerInfo = require('peer-info')
+const waterfall = require('async/waterfall')
+const pull = require('pull-stream')
+const PeerA = require('libp2p-interop/peer-a.json')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class MyBundle extends libp2p {
+  constructor (peerInfo) {
+    const modules = {
+      transport: [new TCP()]
+    }
+    super(modules, peerInfo)
+  }
+}
+
+test('story 1 - peerA', (t) => {
+  t.plan(6)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerA, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10000')
+      node = new MyBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err, 'created Node')
+    t.ok(node.isStarted(), 'PeerA is running')
+
+    const PeerBAddr = `/ip4/127.0.0.1/tcp/10001/p2p/${PeerB.id}`
+
+    node.dial(PeerBAddr, '/echo/1.0.0', (err, conn) => {
+      t.ifErr(err, 'dial successful')
+
+      const data = Buffer.from('Heey')
+
+      pull(
+        pull.values([data]),
+        conn,
+        pull.collect((err, values) => {
+          t.ifErr(err, 'Received echo back')
+          t.deepEqual(values[0], data)
+          node.stop((err) => t.ifErr(err, 'PeerA has stopped'))
+        })
+      )
+    })
+  })
+})

pdd/pdd-transport--story-1--peer-b.js

@@ -0,0 +1,49 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const PeerInfo = require('peer-info')
+const waterfall = require('async/waterfall')
+const pull = require('pull-stream')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class MyBundle extends libp2p {
+  constructor (peerInfo) {
+    const modules = {
+      transport: [new TCP()]
+    }
+    super(modules, peerInfo)
+  }
+}
+
+test('story 1 - peerB', (t) => {
+  t.plan(5)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerB, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10001')
+      node = new MyBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err)
+    t.ok(node.isStarted(), 'PeerB is running')
+
+    node.handle('/echo/1.0.0', (protocol, conn) => {
+      pull(
+        conn,
+        conn,
+        pull.onEnd((err) => {
+          t.ifErr(err)
+          t.pass('Received End of Connection')
+          node.stop((err) => {
+            t.ifErr(err, 'PeerB has stopped')
+          })
+        })
+      )
+    })
+  })
+})

pdd/pdd-transport--story-2--peer-a.js

@@ -0,0 +1,54 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+const PeerInfo = require('peer-info')
+const waterfall = require('async/waterfall')
+const pull = require('pull-stream')
+const PeerA = require('libp2p-interop/peer-a.json')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class MyBundle extends libp2p {
+  constructor (peerInfo) {
+    const modules = {
+      transport: [new WebSockets()]
+    }
+    super(modules, peerInfo)
+  }
+}
+
+test('story 2 - peerA', (t) => {
+  t.plan(6)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerA, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10000/ws')
+      node = new MyBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err, 'created Node')
+    t.ok(node.isStarted(), 'PeerA is running')
+
+    const PeerBAddr = `/ip4/127.0.0.1/tcp/10001/p2p/${PeerB.id}`
+
+    node.dial(PeerBAddr, '/echo/1.0.0', (err, conn) => {
+      t.ifErr(err, 'dial successful')
+
+      const data = Buffer.from('Heey')
+
+      pull(
+        pull.values([data]),
+        conn,
+        pull.collect((err, values) => {
+          t.ifErr(err, 'Received echo back')
+          t.deepEqual(values[0], data)
+          node.stop((err) => t.ifErr(err, 'PeerA has stopped'))
+        })
+      )
+    })
+  })
+})

pdd/pdd-transport--story-2--peer-b.js

@@ -0,0 +1,49 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+const PeerInfo = require('peer-info')
+const waterfall = require('async/waterfall')
+const pull = require('pull-stream')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class MyBundle extends libp2p {
+  constructor (peerInfo) {
+    const modules = {
+      transport: [new WebSockets()]
+    }
+    super(modules, peerInfo)
+  }
+}
+
+test('story 2 - peerB', (t) => {
+  t.plan(5)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerB, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10001/ws')
+      node = new MyBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err)
+    t.ok(node.isStarted(), 'PeerB is running')
+
+    node.handle('/echo/1.0.0', (protocol, conn) => {
+      pull(
+        conn,
+        pull.through(v => v, err => {
+          t.ifErr(err)
+          t.pass('Received End of Connection')
+          node.stop((err) => {
+            t.ifErr(err, 'PeerB has stopped')
+          })
+        }),
+        conn
+      )
+    })
+  })
+})

pdd/pdd-transport--story-3--peer-a.js

@@ -0,0 +1,42 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const PeerInfo = require('peer-info')
+const waterfall = require('async/waterfall')
+const PeerA = require('libp2p-interop/peer-a.json')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class MyBundle extends libp2p {
+  constructor (peerInfo) {
+    const modules = {
+      transport: [new TCP()]
+    }
+    super(modules, peerInfo)
+  }
+}
+
+test('story 3 - peerA', (t) => {
+  t.plan(4)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerA, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10000')
+      node = new MyBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err, 'created Node')
+    t.ok(node.isStarted(), 'PeerA is running')
+
+    const PeerBAddr = `/ip4/127.0.0.1/tcp/10001/ws/p2p/${PeerB.id}`
+
+    setTimeout(() => node.dial(PeerBAddr, '/echo/1.0.0', (err, conn) => {
+      t.ok(err, 'dial failed')
+      node.stop((err) => t.ifErr(err, 'PeerA has stopped'))
+    }), 1000)
+  })
+})

pdd/pdd-transport--story-3--peer-b.js

@@ -0,0 +1,42 @@
+'use strict'
+
+const test = require('tape')
+const libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+const PeerInfo = require('peer-info')
+const waterfall = require('async/waterfall')
+const PeerA = require('libp2p-interop/peer-a.json')
+const PeerB = require('libp2p-interop/peer-b.json')
+
+class MyBundle extends libp2p {
+  constructor (peerInfo) {
+    const modules = {
+      transport: [new WebSockets()]
+    }
+    super(modules, peerInfo)
+  }
+}
+
+test('story 3 - peerB', (t) => {
+  t.plan(4)
+  let node
+
+  waterfall([
+    (cb) => PeerInfo.create(PeerB, cb),
+    (peerInfo, cb) => {
+      peerInfo.multiaddrs.add('/ip4/127.0.0.1/tcp/10000/ws')
+      node = new MyBundle(peerInfo)
+      node.start(cb)
+    }
+  ], (err) => {
+    t.ifErr(err, 'created Node')
+    t.ok(node.isStarted(), 'PeerA is running')
+
+    const PeerAAddr = `/ip4/127.0.0.1/tcp/10000/ws/p2p/${PeerA.id}`
+
+    setTimeout(() => node.dial(PeerAAddr, '/echo/1.0.0', (err, conn) => {
+      t.ok(err, 'dial failed')
+      node.stop((err) => t.ifErr(err, 'PeerA has stopped'))
+    }), 1000)
+  })
+})

src/circuit/IMPLEMENTATION_NOTES.md

@@ -0,0 +1,128 @@
+EDIT: This document is outdated and here only for historical purposes
+
+NOTE: This document is structured in an `if-then/else[if]-then` manner, each line is a precondition for following lines with a higher number of indentation
+
+Example:
+
+- if there are apples
+    - eat them
+- if not, check for pears
+    - then eat them
+- if not, check for cherries
+    - then eat them
+
+Or,
+
+- if there are apples
+    - eat them
+- if not
+    - check for pears
+        - then eat them
+- if not
+    - check for cherries
+        - then eat them
+
+In order to minimize nesting, the first example is preferred
+
+# Relay flow
+
+## Relay transport (dialer/listener)
+
+- ### Dial over a relay
+    - See if there is a relay that's already connected to the destination peer, if not
+        - Ask all the peer's known relays to dial the destination peer until an active relay (one that can dial on behalf of other peers), or a relay that may have recently acquired a connection to the destination peer is successful. 
+            - If successful
+                - Write the `/ipfs/relay/circuit/1.0.0` header to the relay, followed by the destination address
+                    -  e.g. `/ipfs/relay/circuit/1.0.0\n/p2p-circuit/ipfs/QmDest`.
+            - If no relays could connect, fail the same way a regular transport would
+    - Once the connection has been established, the swarm should treat it as a regular connection, 
+        - i.e. muxing, encrypt, etc should all be performed on the relayed connection
+
+- ### Listen for relayed connections
+    - Peer mounts the `/ipfs/relay/circuit/1.0.0` proto and listens for relayed connections
+        - A connection arrives
+            - read the address of the source peer from the incoming connection stream
+                - if valid, create a PeerInfo object for that peer and add the incoming address to its multiaddresses list
+                - pass the connection to `protocolMuxer(swarm.protocols, conn)` to have it go through the regular muxing/encryption flow
+                
+- ### Relay discovery and static relay addresses in swarm config
+
+    - #### Relay address in swarm config
+       - A peer has relay addresses in its swarm config section
+           - On node startup, connect to the relays in swarm config
+                - if successful add address to swarms PeerInfo's multiaddresses
+                    - `identify` should take care of announcing that the peer is reachable over the listed relays
+
+    - #### Passive relay discovery
+        - A peer that can dial over `/ipfs/relay/circuit/1.0.0` listens for the `peer-mux-established` swarm event, every time a new muxed connection arrives, it checks if the incoming peer is a relay. (How would this work? Some way of discovering if its a relay is required.)
+           - *Useful in cases when the peer/node doesn't know of any relays on startup and also, to learn of as many additional relays in the network as possible*
+           - *Useful during startup, when connecting to bootstrap nodes. It allows us to implicitly learn if its a relay without having to explicitly add `/p2p-circuit` addresses to the bootstrap list*
+           - *Also useful if the relay communicates its capabilities upon connecting to it, as to avoid additional unnecessary requests/queries. I.e. if it supports weather its able to forward connections and weather it supports the `ls` or other commands.*
+           - *Should it be possible to disable passive relay discovery?*
+               - This could be useful when the peer wants to be reachable **only** over the listed relays
+       - If the incoming peer is a relay, send an `ls` and record its peers
+
+## Relay Nodes
+
+- ### Passive relay node
+    - *A passive relay does not explicitly dial into any requested peer, only those that it's swarm already has connections to.*
+        - When the relay gets a request, read the the destination peer's multiaddr from the connection stream and if its a valid address and peer id
+            - check its swarm's peerbook(?) see if its a known peer, if it is
+                - use the swarms existing connection and
+                    - send the multistream header and the source peer address to the dest peer
+                        - e.g. `/ipfs/relay/circuit/1.0.0\n/p2p-circuit/ipfs/QmSource`
+                    - circuit the source and dest connections
+                - if couldn't dial, or the connection/stream to the dest peer closed prematurelly
+                    - close the src stream
+
+
+- ### Active relay node
+    - *An active relay node can dial other peers even if its swarm doesnt know about those peers*
+        - When the relay gets a request, read the the destination peer's multiaddr from the connection stream and if its a valid address and peer id
+            - use the swarm to dial to the dest node
+                - send the multistream header and the source peer address to the dest peer
+                    - e.g. `/ipfs/relay/circuit/1.0.0\n/p2p-circuit/ipfs/QmSource`
+                - circuit the source and dest connections
+            - if couldn't dial, or the connection/stream to the dest peer closed prematurely
+                - close the src stream
+
+- ### `ls` command
+    - *A relay node can allow the peers known to it's swarm to be listed*
+        - *this should be possible to enable/disable from the config*
+            - when a relay gets the `ls` request
+                - if enabled, get its swarm's peerbook's known peers and return their ids and multiaddrs
+                    - e.g `[{id: /ipfs/QmPeerId, addrs: ['ma1', 'ma2', 'ma3']}, ...]`
+                - if disabled, respond with `na`
+
+
+## Relay Implementation notes
+
+- ### Relay transport
+    - Currently I've implemented the dialer and listener parts of the relay as a transport, meaning that it *tries* to implement the `interface-transport` interface as closely as possible. This seems to work pretty well and it's makes the dialer/listener parts really easy to plug in into the swarm. I think this is the cleanest solution.
+
+- ### `circuit-relay`
+    - This is implemented as a separate piece (not a transport), and it can be enabled/disabled with a config. The transport listener however, will do the initial parsing of the incoming header and figure out weather it's a connection that's needs to be handled by the circuit-relay, or its a connection that is being relayed from a circuit-relay.
+
+## Relay swarm integration
+
+- The relay transport is mounted explicitly by calling the `swarm.connection.relay(config.relay)` from libp2p
+    - Swarm will register the dialer and listener using the swarm `transport.add` and `transport.listen` methods
+
+    - ### Listener 
+        - the listener registers itself as a multistream handler on the `/ipfs/relay/circuit/1.0.0` proto
+            - if `circuit-relay` is enabled, the listener will delegate connections to it if appropriate
+        - when the listener receives a connection, it will read the multiaddr and determine if its a connection that needs to be relayed, or its a connection that is being relayed
+
+    - ### Dialer
+        - When the swarm attempts to dial to a peer, it will filter the protocols that the peer can be reached on
+            - *The relay will be used in two cases*
+            - If the peer has an explicit relay address that it can be reached on
+                -  no other transport is available
+                    - The relay will attempt to dial the peer over that relay
+            - If no explicit relay address is provided
+                -  no other transport is available
+                    -  A generic circuit address will be added to the peers multiaddr list
+                        - i.e. `/p2p-circuit/ipfs/QmDest`
+            - If another transport is available, then use that instead of the relay
+    
+

src/circuit/README.md

@@ -0,0 +1,156 @@
+# js-libp2p-circuit
+
+> Node.js implementation of the Circuit module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/interface-connection) interface for dial/listen.
+
+**Note**: git history prior to merging into js-libp2p can be found in the original repository, https://github.com/libp2p/js-libp2p-circuit.
+
+`libp2p-circuit` implements the circuit-relay mechanism that allows nodes that don't speak the same protocol to communicate using a third _relay_ node.
+
+This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces.
+
+### Why?
+
+`circuit-relaying` uses additional nodes in order to transfer traffic between two otherwise unreachable nodes. This allows nodes that don't speak the same protocols or are running in limited environments, e.g. browsers and IoT devices, to communicate, which would otherwise be impossible given the fact that for example browsers don't have any socket support and as such cannot be directly dialed.
+
+The use of circuit-relaying is not limited to routing traffic between browser nodes, other uses include:
+ - routing traffic between private nets and circumventing NAT layers
+ - route mangling for better privacy (matreshka/shallot dialing).
+
+ It's also possible to use it for clients that implement exotic transports such as  devices that only have bluetooth radios to be reachable over bluetooth enabled relays and become full p2p nodes.
+
+### libp2p-circuit and IPFS
+
+Prior to `libp2p-circuit` there was a rift in the IPFS network, were IPFS nodes could only access content from nodes that speak the same protocol, for example TCP only nodes could only dial to other TCP only nodes, same for any other protocol combination. In practice, this limitation was most visible in JS-IPFS browser nodes, since they can only dial out but not be dialed in over WebRTC or WebSockets, hence any content that the browser node held was not reachable by the rest of the network even through it was announced on the DHT. Non browser IPFS nodes would usually speak more than one protocol such as TCP, WebSockets and/or WebRTC, this made the problem less severe outside of the browser. `libp2p-circuit` solves this problem completely, as long as there are `relay nodes` capable of routing traffic between those nodes their content should be available to the rest of the IPFS network.
+
+## Table of Contents
+
+- [Install](#install)
+  - [npm](#npm)
+- [Usage](#usage)
+  - [Example](#example)
+  - [This module uses `pull-streams`](#this-module-uses-pull-streams)
+    - [Converting `pull-streams` to Node.js Streams](#converting-pull-streams-to-nodejs-streams)
+- [API](#api)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Usage
+
+### Example
+
+#### Create dialer/listener
+
+```js
+const Circuit = require('libp2p-circuit')
+const multiaddr = require('multiaddr')
+const pull = require('pull-stream')
+
+const mh1 = multiaddr('/p2p-circuit/ipfs/QmHash') // dial /ipfs/QmHash over any circuit
+
+const circuit = new Circuit(swarmInstance, options) // pass swarm instance and options
+
+const listener = circuit.createListener(mh1, (connection) => {
+  console.log('new connection opened')
+  pull(
+    pull.values(['hello']),
+    socket
+  )
+})
+
+listener.listen(() => {
+  console.log('listening')
+
+  pull(
+    circuit.dial(mh1),
+    pull.log,
+    pull.onEnd(() => {
+      circuit.close()
+    })
+  )
+})
+```
+
+Outputs:
+
+```sh
+listening
+new connection opened
+hello
+```
+
+#### Create `relay`
+
+```js
+const Relay = require('libp2p-circuit').Relay
+
+const relay = new Relay(options)
+
+relay.mount(swarmInstance) // start relaying traffic
+```
+
+### This module uses `pull-streams`
+
+We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
+
+You can learn more about pull-streams at:
+
+- [The history of Node.js streams, nodebp April 2014](https://www.youtube.com/watch?v=g5ewQEuXjsQ)
+- [The history of streams, 2016](http://dominictarr.com/post/145135293917/history-of-streams)
+- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
+- [pull-streams documentation](https://pull-stream.github.io/)
+
+#### Converting `pull-streams` to Node.js Streams
+
+If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/dominictarr/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
+
+```js
+const pullToStream = require('pull-stream-to-stream')
+
+const nodeStreamInstance = pullToStream(pullStreamInstance)
+// nodeStreamInstance is an instance of a Node.js Stream
+```
+
+To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
+
+## API
+
+[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
+
+`libp2p-circuit` accepts Circuit addresses for both IPFS and non IPFS encapsulated addresses, i.e:
+
+`/p2p-circuit/ip4/127.0.0.1/tcp/4001/ipfs/QmHash`
+
+Both for dialing and listening.
+
+### Implementation rational
+
+This module is not a transport, however it implements `interface-transport` interface in order to allow circuit to be plugged with `libp2p-swarm`. The rational behind it is that, `libp2p-circuit` has a dial and listen flow, which fits nicely with other transports, moreover, it requires the _raw_ connection to be encrypted and muxed just as a regular transport's connection does. All in all, `interface-transport` ended up being the correct level of abstraction for circuit, as well as allowed us to reuse existing integration points in `libp2p-swarm` and `libp2p` without adding any ad-hoc logic. All parts of `interface-transport` are used, including `.getAddr` which returns a list of `/p2p-circuit` addresses that circuit is currently listening.
+
+```
+libp2p                                                                                  libp2p-circuit (transport)
++-------------------------------------------------+                                     +--------------------------+
+|        +---------------------------------+      |                                     |                          |
+|        |                                 |      |                                     |   +------------------+   |
+|        |                                 |      |  circuit-relay listens for the HOP  |   |                  |   |
+|        |           libp2p-swarm          <------------------------------------------------|  circuit-relay   |   |
+|        |                                 |      |  message to handle incomming relay  |   |                  |   |
+|        |                                 |      |  requests from other nodes          |   +------------------+   |
+|        +---------------------------------+      |                                     |                          |
+|         ^     ^   ^  ^   ^           ^          |                                     |   +------------------+   |
+|         |     |   |  |   |           |          |                                     |   | +-------------+  |   |
+|         |     |   |  |   |           |          |  dialer uses libp2p-swarm to dial   |   | |             |  |   |
+|         |     |   |  +---------------------------------------------------------------------->   dialer    |  |   |
+|         |     | transports           |          |  to a circuit-relay node using the  |   | |             |  |   |
+|         |     |   |      |           |          |  HOP message                        |   | +-------------+  |   |
+|         |     |   |      |           |          |                                     |   |                  |   |
+|         v     v   |      v           v          |                                     |   |                  |   |
+|+------------------|----------------------------+|                                     |   |  +-------------+ |   |
+||           |      |    |      |                ||                                     |   |  |             | |   |
+||libp2p-tcp |libp2p-ws  | .... |libp2p-circuit  ||  listener handles STOP messages from|   |  | listener    | |   |
+||           |      +-------------------------------------------------------------------------->             | |   |
+||           |           |      |plugs in just   ||  circuit-relay nodes                |   |  +-------------+ |   |
+||           |           |      |as any other    ||                                     |   |                  |   |
+||           |           |      |transport       ||                                     |   +------------------+   |
+|+-----------------------------------------------+|                                     |                          |
++-------------------------------------------------+                                     +--------------------------+
+```

src/circuit/circuit.js

@@ -0,0 +1,126 @@
+'use strict'
+
+const mafmt = require('mafmt')
+const multiaddr = require('multiaddr')
+
+const CircuitDialer = require('./circuit/dialer')
+const utilsFactory = require('./circuit/utils')
+
+const debug = require('debug')
+const log = debug('libp2p:circuit:transportdialer')
+log.err = debug('libp2p:circuit:error:transportdialer')
+
+const createListener = require('./listener')
+
+class Circuit {
+  static get tag () {
+    return 'Circuit'
+  }
+
+  /**
+   * Creates an instance of Dialer.
+   *
+   * @param {Swarm} swarm - the swarm
+   * @param {any} options - config options
+   *
+   * @memberOf Dialer
+   */
+  constructor (swarm, options) {
+    this.options = options || {}
+
+    this.swarm = swarm
+    this.dialer = null
+    this.utils = utilsFactory(swarm)
+    this.peerInfo = this.swarm._peerInfo
+    this.relays = this.filter(this.peerInfo.multiaddrs.toArray())
+
+    // if no explicit relays, add a default relay addr
+    if (this.relays.length === 0) {
+      this.peerInfo
+        .multiaddrs
+        .add(`/p2p-circuit/ipfs/${this.peerInfo.id.toB58String()}`)
+    }
+
+    this.dialer = new CircuitDialer(swarm, options)
+
+    this.swarm.on('peer-mux-established', (peerInfo) => {
+      this.dialer.canHop(peerInfo)
+    })
+    this.swarm.on('peer-mux-closed', (peerInfo) => {
+      this.dialer.relayPeers.delete(peerInfo.id.toB58String())
+    })
+  }
+
+  /**
+   * Dial the relays in the Addresses.Swarm config
+   *
+   * @param {Array} relays
+   * @return {void}
+   */
+  _dialSwarmRelays () {
+    // if we have relay addresses in swarm config, then dial those relays
+    this.relays.forEach((relay) => {
+      const relaySegments = relay
+        .toString()
+        .split('/p2p-circuit')
+        .filter(segment => segment.length)
+
+      relaySegments.forEach((relaySegment) => {
+        const ma = this.utils.peerInfoFromMa(multiaddr(relaySegment))
+        this.dialer._dialRelay(ma)
+      })
+    })
+  }
+
+  /**
+   * Dial a peer over a relay
+   *
+   * @param {multiaddr} ma - the multiaddr of the peer to dial
+   * @param {Object} options - dial options
+   * @param {Function} cb - a callback called once dialed
+   * @returns {Connection} - the connection
+   *
+   * @memberOf Dialer
+   */
+  dial (ma, options, cb) {
+    return this.dialer.dial(ma, options, cb)
+  }
+
+  /**
+   * Create a listener
+   *
+   * @param {any} options
+   * @param {Function} handler
+   * @return {listener}
+   */
+  createListener (options, handler) {
+    if (typeof options === 'function') {
+      handler = options
+      options = this.options || {}
+    }
+
+    const listener = createListener(this.swarm, options, handler)
+    listener.on('listen', this._dialSwarmRelays.bind(this))
+    return listener
+  }
+
+  /**
+   * Filter check for all multiaddresses
+   * that this transport can dial on
+   *
+   * @param {any} multiaddrs
+   * @returns {Array<multiaddr>}
+   *
+   * @memberOf Dialer
+   */
+  filter (multiaddrs) {
+    if (!Array.isArray(multiaddrs)) {
+      multiaddrs = [multiaddrs]
+    }
+    return multiaddrs.filter((ma) => {
+      return mafmt.Circuit.matches(ma)
+    })
+  }
+}
+
+module.exports = Circuit

src/circuit/circuit/dialer.js

@@ -0,0 +1,275 @@
+'use strict'
+
+const once = require('once')
+const PeerId = require('peer-id')
+const waterfall = require('async/waterfall')
+const setImmediate = require('async/setImmediate')
+const multiaddr = require('multiaddr')
+
+const Connection = require('interface-connection').Connection
+
+const utilsFactory = require('./utils')
+const StreamHandler = require('./stream-handler')
+
+const debug = require('debug')
+const log = debug('libp2p:circuit:dialer')
+log.err = debug('libp2p:circuit:error:dialer')
+
+const multicodec = require('../multicodec')
+const proto = require('../protocol')
+
+class Dialer {
+  /**
+   * Creates an instance of Dialer.
+   * @param {Swarm} swarm - the swarm
+   * @param {any} options - config options
+   *
+   * @memberOf Dialer
+   */
+  constructor (swarm, options) {
+    this.swarm = swarm
+    this.relayPeers = new Map()
+    this.relayConns = new Map()
+    this.options = options
+    this.utils = utilsFactory(swarm)
+  }
+
+  /**
+   * Helper that returns a relay connection
+   *
+   * @param {*} relay
+   * @param {*} callback
+   * @returns {Function} - callback
+   */
+  _dialRelayHelper (relay, callback) {
+    if (this.relayConns.has(relay.id.toB58String())) {
+      return callback(null, this.relayConns.get(relay.id.toB58String()))
+    }
+
+    return this._dialRelay(relay, callback)
+  }
+
+  /**
+   * Dial a peer over a relay
+   *
+   * @param {multiaddr} ma - the multiaddr of the peer to dial
+   * @param {Function} cb - a callback called once dialed
+   * @returns {Connection} - the connection
+   *
+   */
+  dial (ma, cb) {
+    cb = cb || (() => { })
+    const strMa = ma.toString()
+    if (!strMa.includes('/p2p-circuit')) {
+      log.err('invalid circuit address')
+      return cb(new Error('invalid circuit address'))
+    }
+
+    const addr = strMa.split('p2p-circuit') // extract relay address if any
+    const relay = addr[0] === '/' ? null : multiaddr(addr[0])
+    const peer = multiaddr(addr[1] || addr[0])
+
+    const dstConn = new Connection()
+    setImmediate(
+      this._dialPeer.bind(this),
+      peer,
+      relay,
+      (err, conn) => {
+        if (err) {
+          log.err(err)
+          return cb(err)
+        }
+
+        dstConn.setInnerConn(conn)
+        cb(null, dstConn)
+      })
+
+    return dstConn
+  }
+
+  /**
+   * Does the peer support the HOP protocol
+   *
+   * @param {PeerInfo} peer
+   * @param {Function} callback
+   * @returns {void}
+   */
+  canHop (peer, callback) {
+    callback = once(callback || (() => { }))
+
+    this._dialRelayHelper(peer, (err, conn) => {
+      if (err) {
+        return callback(err)
+      }
+
+      const sh = new StreamHandler(conn)
+      waterfall([
+        (cb) => sh.write(proto.CircuitRelay.encode({
+          type: proto.CircuitRelay.Type.CAN_HOP
+        }), cb),
+        (cb) => sh.read(cb)
+      ], (err, msg) => {
+        if (err) {
+          return callback(err)
+        }
+        const response = proto.CircuitRelay.decode(msg)
+
+        if (response.code !== proto.CircuitRelay.Status.SUCCESS) {
+          const err = new Error(`HOP not supported, skipping - ${this.utils.getB58String(peer)}`)
+          log(err)
+          return callback(err)
+        }
+
+        log('HOP supported adding as relay - %s', this.utils.getB58String(peer))
+        this.relayPeers.set(this.utils.getB58String(peer), peer)
+        sh.close()
+        callback()
+      })
+    })
+  }
+
+  /**
+   * Dial the destination peer over a relay
+   *
+   * @param {multiaddr} dstMa
+   * @param {Connection|PeerInfo} relay
+   * @param {Function} cb
+   * @return {Function|void}
+   * @private
+   */
+  _dialPeer (dstMa, relay, cb) {
+    if (typeof relay === 'function') {
+      cb = relay
+      relay = null
+    }
+
+    if (!cb) {
+      cb = () => {}
+    }
+
+    dstMa = multiaddr(dstMa)
+    // if no relay provided, dial on all available relays until one succeeds
+    if (!relay) {
+      const relays = Array.from(this.relayPeers.values())
+      const next = (nextRelay) => {
+        if (!nextRelay) {
+          const err = 'no relay peers were found or all relays failed to dial'
+          log.err(err)
+          return cb(err)
+        }
+
+        return this._negotiateRelay(
+          nextRelay,
+          dstMa,
+          (err, conn) => {
+            if (err) {
+              log.err(err)
+              return next(relays.shift())
+            }
+            cb(null, conn)
+          })
+      }
+      next(relays.shift())
+    } else {
+      return this._negotiateRelay(
+        relay,
+        dstMa,
+        (err, conn) => {
+          if (err) {
+            log.err('An error has occurred negotiating the relay connection', err)
+            return cb(err)
+          }
+
+          return cb(null, conn)
+        })
+    }
+  }
+
+  /**
+   * Negotiate the relay connection
+   *
+   * @param {Multiaddr|PeerInfo|Connection} relay - the Connection or PeerInfo of the relay
+   * @param {multiaddr} dstMa - the multiaddr of the peer to relay the connection for
+   * @param {Function} callback - a callback which gets the negotiated relay connection
+   * @returns {void}
+   * @private
+   *
+   * @memberOf Dialer
+   */
+  _negotiateRelay (relay, dstMa, callback) {
+    dstMa = multiaddr(dstMa)
+    relay = this.utils.peerInfoFromMa(relay)
+    const srcMas = this.swarm._peerInfo.multiaddrs.toArray()
+    this._dialRelayHelper(relay, (err, conn) => {
+      if (err) {
+        log.err(err)
+        return callback(err)
+      }
+      const sh = new StreamHandler(conn)
+      waterfall([
+        (cb) => {
+          log('negotiating relay for peer %s', dstMa.getPeerId())
+          let dstPeerId
+          try {
+            dstPeerId = PeerId.createFromB58String(dstMa.getPeerId()).id
+          } catch (err) {
+            return cb(err)
+          }
+          sh.write(
+            proto.CircuitRelay.encode({
+              type: proto.CircuitRelay.Type.HOP,
+              srcPeer: {
+                id: this.swarm._peerInfo.id.id,
+                addrs: srcMas.map((addr) => addr.buffer)
+              },
+              dstPeer: {
+                id: dstPeerId,
+                addrs: [dstMa.buffer]
+              }
+            }), cb)
+        },
+        (cb) => sh.read(cb)
+      ], (err, msg) => {
+        if (err) {
+          return callback(err)
+        }
+        const message = proto.CircuitRelay.decode(msg)
+        if (message.type !== proto.CircuitRelay.Type.STATUS) {
+          return callback(new Error('Got invalid message type - ' +
+            `expected ${proto.CircuitRelay.Type.STATUS} got ${message.type}`))
+        }
+
+        if (message.code !== proto.CircuitRelay.Status.SUCCESS) {
+          return callback(new Error(`Got ${message.code} error code trying to dial over relay`))
+        }
+
+        callback(null, new Connection(sh.rest()))
+      })
+    })
+  }
+
+  /**
+   * Dial a relay peer by its PeerInfo
+   *
+   * @param {PeerInfo} peer - the PeerInfo of the relay peer
+   * @param {Function} cb - a callback with the connection to the relay peer
+   * @returns {void}
+   * @private
+   */
+  _dialRelay (peer, cb) {
+    cb = once(cb || (() => { }))
+
+    this.swarm.dial(
+      peer,
+      multicodec.relay,
+      once((err, conn) => {
+        if (err) {
+          log.err(err)
+          return cb(err)
+        }
+        cb(null, conn)
+      }))
+  }
+}
+
+module.exports = Dialer

src/circuit/circuit/hop.js

@@ -0,0 +1,283 @@
+'use strict'
+
+const pull = require('pull-stream/pull')
+const debug = require('debug')
+const PeerInfo = require('peer-info')
+const PeerId = require('peer-id')
+const EE = require('events').EventEmitter
+const once = require('once')
+const utilsFactory = require('./utils')
+const StreamHandler = require('./stream-handler')
+const proto = require('../protocol').CircuitRelay
+const multiaddr = require('multiaddr')
+const series = require('async/series')
+const waterfall = require('async/waterfall')
+const setImmediate = require('async/setImmediate')
+
+const multicodec = require('./../multicodec')
+
+const log = debug('libp2p:circuit:relay')
+log.err = debug('libp2p:circuit:error:relay')
+
+class Hop extends EE {
+  /**
+   * Construct a Circuit object
+   *
+   * This class will handle incoming circuit connections and
+   * either start a relay or hand the relayed connection to
+   * the swarm
+   *
+   * @param {Swarm} swarm
+   * @param {Object} options
+   */
+  constructor (swarm, options) {
+    super()
+    this.swarm = swarm
+    this.peerInfo = this.swarm._peerInfo
+    this.utils = utilsFactory(swarm)
+    this.config = options || { active: false, enabled: false }
+    this.active = this.config.active
+  }
+
+  /**
+   * Handle the relay message
+   *
+   * @param {CircuitRelay} message
+   * @param {StreamHandler} sh
+   * @returns {*}
+   */
+  handle (message, sh) {
+    if (!this.config.enabled) {
+      this.utils.writeResponse(
+        sh,
+        proto.Status.HOP_CANT_SPEAK_RELAY)
+      return sh.close()
+    }
+
+    // check if message is `CAN_HOP`
+    if (message.type === proto.Type.CAN_HOP) {
+      this.utils.writeResponse(
+        sh,
+        proto.Status.SUCCESS)
+      return sh.close()
+    }
+
+    // This is a relay request - validate and create a circuit
+    let srcPeerId = null
+    let dstPeerId = null
+    try {
+      srcPeerId = PeerId.createFromBytes(message.srcPeer.id).toB58String()
+      dstPeerId = PeerId.createFromBytes(message.dstPeer.id).toB58String()
+    } catch (err) {
+      log.err(err)
+
+      if (!srcPeerId) {
+        this.utils.writeResponse(
+          sh,
+          proto.Status.HOP_SRC_MULTIADDR_INVALID)
+        return sh.close()
+      }
+
+      if (!dstPeerId) {
+        this.utils.writeResponse(
+          sh,
+          proto.Status.HOP_DST_MULTIADDR_INVALID)
+        return sh.close()
+      }
+    }
+
+    if (srcPeerId === dstPeerId) {
+      this.utils.writeResponse(
+        sh,
+        proto.Status.HOP_CANT_RELAY_TO_SELF)
+      return sh.close()
+    }
+
+    if (!message.dstPeer.addrs.length) {
+      // TODO: use encapsulate here
+      const addr = multiaddr(`/p2p-circuit/ipfs/${dstPeerId}`).buffer
+      message.dstPeer.addrs.push(addr)
+    }
+
+    log('trying to establish a circuit: %s <-> %s', srcPeerId, dstPeerId)
+    const noPeer = () => {
+      // log.err(err)
+      this.utils.writeResponse(
+        sh,
+        proto.Status.HOP_NO_CONN_TO_DST)
+      return sh.close()
+    }
+
+    const isConnected = (cb) => {
+      let dstPeer
+      try {
+        dstPeer = this.swarm._peerBook.get(dstPeerId)
+        if (!dstPeer.isConnected() && !this.active) {
+          const err = new Error(`No Connection to peer ${dstPeerId}`)
+          noPeer(err)
+          return cb(err)
+        }
+      } catch (err) {
+        if (!this.active) {
+          noPeer(err)
+          return cb(err)
+        }
+      }
+      cb()
+    }
+
+    series([
+      (cb) => this.utils.validateAddrs(message, sh, proto.Type.HOP, cb),
+      (cb) => isConnected(cb),
+      (cb) => this._circuit(sh, message, cb)
+    ], (err) => {
+      if (err) {
+        log.err(err)
+        sh.close()
+        return setImmediate(() => this.emit('circuit:error', err))
+      }
+      setImmediate(() => this.emit('circuit:success'))
+    })
+  }
+
+  /**
+   * Connect to STOP
+   *
+   * @param {PeerInfo} peer
+   * @param {StreamHandler} srcSh
+   * @param {function} callback
+   * @returns {void}
+   */
+  _connectToStop (peer, srcSh, callback) {
+    this._dialPeer(peer, (err, dstConn) => {
+      if (err) {
+        this.utils.writeResponse(
+          srcSh,
+          proto.Status.HOP_CANT_DIAL_DST)
+        log.err(err)
+        return callback(err)
+      }
+
+      return this.utils.writeResponse(
+        srcSh,
+        proto.Status.SUCCESS,
+        (err) => {
+          if (err) {
+            log.err(err)
+            return callback(err)
+          }
+          return callback(null, dstConn)
+        })
+    })
+  }
+
+  /**
+   * Negotiate STOP
+   *
+   * @param {StreamHandler} dstSh
+   * @param {StreamHandler} srcSh
+   * @param {CircuitRelay} message
+   * @param {function} callback
+   * @returns {void}
+   */
+  _negotiateStop (dstSh, srcSh, message, callback) {
+    const stopMsg = Object.assign({}, message, {
+      type: proto.Type.STOP // change the message type
+    })
+    dstSh.write(proto.encode(stopMsg),
+      (err) => {
+        if (err) {
+          this.utils.writeResponse(
+            srcSh,
+            proto.Status.HOP_CANT_OPEN_DST_STREAM)
+          log.err(err)
+          return callback(err)
+        }
+
+        // read response from STOP
+        dstSh.read((err, msg) => {
+          if (err) {
+            log.err(err)
+            return callback(err)
+          }
+
+          const message = proto.decode(msg)
+          if (message.code !== proto.Status.SUCCESS) {
+            return callback(new Error('Unable to create circuit!'))
+          }
+
+          return callback(null, msg)
+        })
+      })
+  }
+
+  /**
+   * Attempt to make a circuit from A <-> R <-> B where R is this relay
+   *
+   * @param {StreamHandler} srcSh - the source stream handler
+   * @param {CircuitRelay} message - the message with the src and dst entries
+   * @param {Function} callback - callback to signal success or failure
+   * @returns {void}
+   * @private
+   */
+  _circuit (srcSh, message, callback) {
+    let dstSh = null
+    waterfall([
+      (cb) => this._connectToStop(message.dstPeer, srcSh, cb),
+      (_dstConn, cb) => {
+        dstSh = new StreamHandler(_dstConn)
+        this._negotiateStop(dstSh, srcSh, message, cb)
+      }
+    ], (err) => {
+      if (err) {
+        // close/end the source stream if there was an error
+        if (srcSh) {
+          srcSh.close()
+        }
+
+        if (dstSh) {
+          dstSh.close()
+        }
+        return callback(err)
+      }
+
+      const src = srcSh.rest()
+      const dst = dstSh.rest()
+
+      const srcIdStr = PeerId.createFromBytes(message.srcPeer.id).toB58String()
+      const dstIdStr = PeerId.createFromBytes(message.dstPeer.id).toB58String()
+
+      // circuit the src and dst streams
+      pull(
+        src,
+        dst,
+        src
+      )
+      log('circuit %s <-> %s established', srcIdStr, dstIdStr)
+      callback()
+    })
+  }
+
+  /**
+   * Dial the dest peer and create a circuit
+   *
+   * @param {Multiaddr} dstPeer
+   * @param {Function} callback
+   * @returns {void}
+   * @private
+   */
+  _dialPeer (dstPeer, callback) {
+    const peerInfo = new PeerInfo(PeerId.createFromBytes(dstPeer.id))
+    dstPeer.addrs.forEach((a) => peerInfo.multiaddrs.add(a))
+    this.swarm.dial(peerInfo, multicodec.relay, once((err, conn) => {
+      if (err) {
+        log.err(err)
+        return callback(err)
+      }
+
+      callback(null, conn)
+    }))
+  }
+}
+
+module.exports = Hop

src/circuit/circuit/stop.js

@@ -0,0 +1,56 @@
+'use strict'
+
+const setImmediate = require('async/setImmediate')
+
+const EE = require('events').EventEmitter
+const Connection = require('interface-connection').Connection
+const utilsFactory = require('./utils')
+const PeerInfo = require('peer-info')
+const proto = require('../protocol').CircuitRelay
+const series = require('async/series')
+
+const debug = require('debug')
+
+const log = debug('libp2p:circuit:stop')
+log.err = debug('libp2p:circuit:error:stop')
+
+class Stop extends EE {
+  constructor (swarm) {
+    super()
+    this.swarm = swarm
+    this.utils = utilsFactory(swarm)
+  }
+
+  /**
+   * Handle the incoming STOP message
+   *
+   * @param {{}} msg  - the parsed protobuf message
+   * @param {StreamHandler} sh  - the stream handler wrapped connection
+   * @param {Function} callback  - callback
+   * @returns {undefined}
+   */
+  handle (msg, sh, callback) {
+    callback = callback || (() => {})
+
+    series([
+      (cb) => this.utils.validateAddrs(msg, sh, proto.Type.STOP, cb),
+      (cb) => this.utils.writeResponse(sh, proto.Status.Success, cb)
+    ], (err) => {
+      if (err) {
+        // we don't return the error here,
+        // since multistream select don't expect one
+        callback()
+        return log(err)
+      }
+
+      const peerInfo = new PeerInfo(this.utils.peerIdFromId(msg.srcPeer.id))
+      msg.srcPeer.addrs.forEach((addr) => peerInfo.multiaddrs.add(addr))
+      const newConn = new Connection(sh.rest())
+      newConn.setPeerInfo(peerInfo)
+      setImmediate(() => this.emit('connection', newConn))
+      callback(newConn)
+    })
+  }
+}
+
+module.exports = Stop

src/circuit/circuit/stream-handler.js

@@ -0,0 +1,140 @@
+'use strict'
+
+const values = require('pull-stream/sources/values')
+const collect = require('pull-stream/sinks/collect')
+const empty = require('pull-stream/sources/empty')
+const pull = require('pull-stream/pull')
+const lp = require('pull-length-prefixed')
+const handshake = require('pull-handshake')
+
+const debug = require('debug')
+const log = debug('libp2p:circuit:stream-handler')
+log.err = debug('libp2p:circuit:error:stream-handler')
+
+class StreamHandler {
+  /**
+   * Create a stream handler for connection
+   *
+   * @param {Connection} conn - connection to read/write
+   * @param {Function|undefined} cb - handshake callback called on error
+   * @param {Number} timeout - handshake timeout
+   * @param {Number} maxLength - max bytes length of message
+   */
+  constructor (conn, cb, timeout, maxLength) {
+    this.conn = conn
+    this.stream = null
+    this.shake = null
+    this.timeout = cb || 1000 * 60
+    this.maxLength = maxLength || 4096
+
+    if (typeof cb === 'function') {
+      this.timeout = timeout || 1000 * 60
+    }
+
+    this.stream = handshake({ timeout: this.timeout }, cb)
+    this.shake = this.stream.handshake
+
+    pull(this.stream, conn, this.stream)
+  }
+
+  isValid () {
+    return this.conn && this.shake && this.stream
+  }
+
+  /**
+   * Read and decode message
+   *
+   * @param {Function} cb
+   * @returns {void|Function}
+   */
+  read (cb) {
+    if (!this.isValid()) {
+      return cb(new Error('handler is not in a valid state'))
+    }
+
+    lp.decodeFromReader(
+      this.shake,
+      { maxLength: this.maxLength },
+      (err, msg) => {
+        if (err) {
+          log.err(err)
+          // this.shake.abort(err)
+          return cb(err)
+        }
+
+        return cb(null, msg)
+      })
+  }
+
+  /**
+   * Encode and write array of buffers
+   *
+   * @param {Buffer[]} msg
+   * @param {Function} [cb]
+   * @returns {Function}
+   */
+  write (msg, cb) {
+    cb = cb || (() => {})
+
+    if (!this.isValid()) {
+      return cb(new Error('handler is not in a valid state'))
+    }
+
+    pull(
+      values([msg]),
+      lp.encode(),
+      collect((err, encoded) => {
+        if (err) {
+          log.err(err)
+          this.shake.abort(err)
+          return cb(err)
+        }
+
+        encoded.forEach((e) => this.shake.write(e))
+        cb()
+      })
+    )
+  }
+
+  /**
+   * Get the raw Connection
+   *
+   * @returns {null|Connection|*}
+   */
+  getRawConn () {
+    return this.conn
+  }
+
+  /**
+   * Return the handshake rest stream and invalidate handler
+   *
+   * @return {*|{source, sink}}
+   */
+  rest () {
+    const rest = this.shake.rest()
+
+    this.conn = null
+    this.stream = null
+    this.shake = null
+    return rest
+  }
+
+  /**
+   * Close the stream
+   *
+   * @returns {undefined}
+   */
+  close () {
+    if (!this.isValid()) {
+      return
+    }
+
+    // close stream
+    pull(
+      empty(),
+      this.rest()
+    )
+  }
+}
+
+module.exports = StreamHandler

src/circuit/circuit/utils.js

@@ -0,0 +1,118 @@
+'use strict'
+
+const multiaddr = require('multiaddr')
+const PeerInfo = require('peer-info')
+const PeerId = require('peer-id')
+const proto = require('../protocol')
+const { getPeerInfo } = require('../../get-peer-info')
+
+module.exports = function (swarm) {
+  /**
+   * Get b58 string from multiaddr or peerinfo
+   *
+   * @param {Multiaddr|PeerInfo} peer
+   * @return {*}
+   */
+  function getB58String (peer) {
+    let b58Id = null
+    if (multiaddr.isMultiaddr(peer)) {
+      const relayMa = multiaddr(peer)
+      b58Id = relayMa.getPeerId()
+    } else if (PeerInfo.isPeerInfo(peer)) {
+      b58Id = peer.id.toB58String()
+    }
+
+    return b58Id
+  }
+
+  /**
+   * Helper to make a peer info from a multiaddrs
+   *
+   * @param {Multiaddr|PeerInfo|PeerId} peer
+   * @return {PeerInfo}
+   * @private
+   */
+  function peerInfoFromMa (peer) {
+    return getPeerInfo(peer, swarm._peerBook)
+  }
+
+  /**
+   * Checks if peer has an existing connection
+   *
+   * @param {String} peerId
+   * @param {Swarm} swarm
+   * @return {Boolean}
+   */
+  function isPeerConnected (peerId) {
+    return swarm.muxedConns[peerId] || swarm.conns[peerId]
+  }
+
+  /**
+   * Write a response
+   *
+   * @param {StreamHandler} streamHandler
+   * @param {CircuitRelay.Status} status
+   * @param {Function} cb
+   * @returns {*}
+   */
+  function writeResponse (streamHandler, status, cb) {
+    cb = cb || (() => {})
+    streamHandler.write(proto.CircuitRelay.encode({
+      type: proto.CircuitRelay.Type.STATUS,
+      code: status
+    }))
+    return cb()
+  }
+
+  /**
+   * Validate incomming HOP/STOP message
+   *
+   * @param {CircuitRelay} msg
+   * @param {StreamHandler} streamHandler
+   * @param {CircuitRelay.Type} type
+   * @returns {*}
+   * @param {Function} cb
+   */
+  function validateAddrs (msg, streamHandler, type, cb) {
+    try {
+      msg.dstPeer.addrs.forEach((addr) => {
+        return multiaddr(addr)
+      })
+    } catch (err) {
+      writeResponse(streamHandler, type === proto.CircuitRelay.Type.HOP
+        ? proto.CircuitRelay.Status.HOP_DST_MULTIADDR_INVALID
+        : proto.CircuitRelay.Status.STOP_DST_MULTIADDR_INVALID)
+      return cb(err)
+    }
+
+    try {
+      msg.srcPeer.addrs.forEach((addr) => {
+        return multiaddr(addr)
+      })
+    } catch (err) {
+      writeResponse(streamHandler, type === proto.CircuitRelay.Type.HOP
+        ? proto.CircuitRelay.Status.HOP_SRC_MULTIADDR_INVALID
+        : proto.CircuitRelay.Status.STOP_SRC_MULTIADDR_INVALID)
+      return cb(err)
+    }
+
+    return cb(null)
+  }
+
+  function peerIdFromId (id) {
+    if (typeof id === 'string') {
+      return PeerId.createFromB58String(id)
+    }
+
+    return PeerId.createFromBytes(id)
+  }
+
+  return {
+    getB58String,
+    peerInfoFromMa,
+    isPeerConnected,
+    validateAddrs,
+    writeResponse,
+    peerIdFromId
+  }
+}

src/circuit/index.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('./circuit')

src/circuit/listener.js

@@ -0,0 +1,149 @@
+'use strict'
+
+const setImmediate = require('async/setImmediate')
+
+const multicodec = require('./multicodec')
+const EE = require('events').EventEmitter
+const multiaddr = require('multiaddr')
+const mafmt = require('mafmt')
+const Stop = require('./circuit/stop')
+const Hop = require('./circuit/hop')
+const proto = require('./protocol')
+const utilsFactory = require('./circuit/utils')
+
+const StreamHandler = require('./circuit/stream-handler')
+
+const debug = require('debug')
+
+const log = debug('libp2p:circuit:listener')
+log.err = debug('libp2p:circuit:error:listener')
+
+module.exports = (swarm, options, connHandler) => {
+  const listener = new EE()
+  const utils = utilsFactory(swarm)
+
+  listener.stopHandler = new Stop(swarm)
+  listener.stopHandler.on('connection', (conn) => listener.emit('connection', conn))
+  listener.hopHandler = new Hop(swarm, options.hop)
+
+  /**
+   * Add swarm handler and listen for incoming connections
+   *
+   * @param {Multiaddr} ma
+   * @param {Function} callback
+   * @return {void}
+   */
+  listener.listen = (ma, callback) => {
+    callback = callback || (() => {})
+
+    swarm.handle(multicodec.relay, (_, conn) => {
+      const sh = new StreamHandler(conn)
+
+      sh.read((err, msg) => {
+        if (err) {
+          log.err(err)
+          return
+        }
+
+        let request = null
+        try {
+          request = proto.CircuitRelay.decode(msg)
+        } catch (err) {
+          return utils.writeResponse(
+            sh,
+            proto.CircuitRelay.Status.MALFORMED_MESSAGE)
+        }
+
+        switch (request.type) {
+          case proto.CircuitRelay.Type.CAN_HOP:
+          case proto.CircuitRelay.Type.HOP: {
+            return listener.hopHandler.handle(request, sh)
+          }
+
+          case proto.CircuitRelay.Type.STOP: {
+            return listener.stopHandler.handle(request, sh, connHandler)
+          }
+
+          default: {
+            utils.writeResponse(
+              sh,
+              proto.CircuitRelay.Status.INVALID_MSG_TYPE)
+            return sh.close()
+          }
+        }
+      })
+    })
+
+    setImmediate(() => listener.emit('listen'))
+    callback()
+  }
+
+  /**
+   * Remove swarm listener
+   *
+   * @param {Function} cb
+   * @return {void}
+   */
+  listener.close = (cb) => {
+    swarm.unhandle(multicodec.relay)
+    setImmediate(() => listener.emit('close'))
+    cb()
+  }
+
+  /**
+   * Get fixed up multiaddrs
+   *
+   * NOTE: This method will grab the peers multiaddrs and expand them such that:
+   *
+   * a) If it's an existing /p2p-circuit address for a specific relay i.e.
+   *    `/ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit` this method will expand the
+   *    address to `/ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit/ipfs/QmPeer` where
+   *    `QmPeer` is this peers id
+   * b) If it's not a /p2p-circuit address, it will encapsulate the address as a /p2p-circuit
+   *    addr, such when dialing over a relay with this address, it will create the circuit using
+   *    the encapsulated transport address. This is useful when for example, a peer should only
+   *    be dialed over TCP rather than any other transport
+   *
+   * @param {Function} callback
+   * @return {void}
+   */
+  listener.getAddrs = (callback) => {
+    let addrs = swarm._peerInfo.multiaddrs.toArray()
+
+    // get all the explicit relay addrs excluding self
+    const p2pAddrs = addrs.filter((addr) => {
+      return mafmt.Circuit.matches(addr) &&
+        !addr.toString().includes(swarm._peerInfo.id.toB58String())
+    })
+
+    // use the explicit relays instead of any relay
+    if (p2pAddrs.length) {
+      addrs = p2pAddrs
+    }
+
+    const listenAddrs = []
+    addrs.forEach((addr) => {
+      const peerMa = `/p2p-circuit/ipfs/${swarm._peerInfo.id.toB58String()}`
+      if (addr.toString() === peerMa) {
+        listenAddrs.push(multiaddr(peerMa))
+        return
+      }
+
+      if (!mafmt.Circuit.matches(addr)) {
+        if (addr.getPeerId()) {
+          // by default we're reachable over any relay
+          listenAddrs.push(multiaddr('/p2p-circuit').encapsulate(addr))
+        } else {
+          const ma = `${addr}/ipfs/${swarm._peerInfo.id.toB58String()}`
+          listenAddrs.push(multiaddr('/p2p-circuit').encapsulate(ma))
+        }
+      } else {
+        listenAddrs.push(addr.encapsulate(`/ipfs/${swarm._peerInfo.id.toB58String()}`))
+      }
+    })
+
+    callback(null, listenAddrs)
+  }
+
+  return listener
+}

src/circuit/multicodec.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = {
+  relay: '/libp2p/circuit/relay/0.1.0'
+}

src/circuit/protocol/index.js

@@ -0,0 +1,44 @@
+'use strict'
+const protobuf = require('protons')
+module.exports = protobuf(`
+message CircuitRelay {
+
+  enum Status {
+    SUCCESS                    = 100;
+    HOP_SRC_ADDR_TOO_LONG      = 220;
+    HOP_DST_ADDR_TOO_LONG      = 221;
+    HOP_SRC_MULTIADDR_INVALID  = 250;
+    HOP_DST_MULTIADDR_INVALID  = 251;
+    HOP_NO_CONN_TO_DST         = 260;
+    HOP_CANT_DIAL_DST          = 261;
+    HOP_CANT_OPEN_DST_STREAM   = 262;
+    HOP_CANT_SPEAK_RELAY       = 270;
+    HOP_CANT_RELAY_TO_SELF     = 280;
+    STOP_SRC_ADDR_TOO_LONG     = 320;
+    STOP_DST_ADDR_TOO_LONG     = 321;
+    STOP_SRC_MULTIADDR_INVALID = 350;
+    STOP_DST_MULTIADDR_INVALID = 351;
+    STOP_RELAY_REFUSED         = 390;
+    MALFORMED_MESSAGE          = 400;
+  }
+
+  enum Type { // RPC identifier, either HOP, STOP or STATUS
+    HOP = 1;
+    STOP = 2;
+    STATUS = 3;
+    CAN_HOP = 4;
+  }
+
+  message Peer {
+    required bytes id = 1;    // peer id
+    repeated bytes addrs = 2; // peer's known addresses
+  }
+
+  optional Type type = 1;     // Type of the message
+
+  optional Peer srcPeer = 2;  // srcPeer and dstPeer are used when Type is HOP or STATUS
+  optional Peer dstPeer = 3;
+
+  optional Status code = 4;   // Status code, used when Type is STATUS
+}
+`)

src/config.js

@@ -0,0 +1,104 @@
+'use strict'
+
+const mergeOptions = require('merge-options')
+const { struct, superstruct } = require('superstruct')
+const { optional, list } = struct
+
+const DefaultConfig = {
+  connectionManager: {
+    minPeers: 25
+  },
+  config: {
+    dht: {
+      enabled: false,
+      kBucketSize: 20,
+      randomWalk: {
+        enabled: false, // disabled waiting for https://github.com/libp2p/js-libp2p-kad-dht/issues/86
+        queriesPerPeriod: 1,
+        interval: 300e3,
+        timeout: 10e3
+      }
+    },
+    peerDiscovery: {
+      autoDial: true
+    },
+    pubsub: {
+      enabled: true,
+      emitSelf: true,
+      signMessages: true,
+      strictSigning: true
+    },
+    relay: {
+      enabled: true,
+      hop: {
+        enabled: false,
+        active: false
+      }
+    }
+  }
+}
+
+// Define custom types
+const s = superstruct({
+  types: {
+    transport: value => {
+      if (value.length === 0) return 'ERROR_EMPTY'
+      value.forEach(i => {
+        if (!i.dial) return 'ERR_NOT_A_TRANSPORT'
+      })
+      return true
+    },
+    protector: value => {
+      if (!value.protect) return 'ERR_NOT_A_PROTECTOR'
+      return true
+    }
+  }
+})
+
+const modulesSchema = s({
+  connEncryption: optional(list([s('object|function')])),
+  // this is hacky to simulate optional because interface doesnt work correctly with it
+  // change to optional when fixed upstream
+  connProtector: s('undefined|protector'),
+  contentRouting: optional(list(['object'])),
+  dht: optional(s('null|function|object')),
+  pubsub: optional(s('null|function|object')),
+  peerDiscovery: optional(list([s('object|function')])),
+  peerRouting: optional(list(['object'])),
+  streamMuxer: optional(list([s('object|function')])),
+  transport: 'transport'
+})
+
+const configSchema = s({
+  peerDiscovery: 'object?',
+  relay: 'object?',
+  dht: 'object?',
+  pubsub: 'object?'
+})
+
+const optionsSchema = s({
+  switch: 'object?',
+  connectionManager: 'object?',
+  datastore: 'object?',
+  peerInfo: 'object',
+  peerBook: 'object?',
+  modules: modulesSchema,
+  config: configSchema
+})
+
+module.exports.validate = (opts) => {
+  opts = mergeOptions(DefaultConfig, opts)
+  const [error, options] = optionsSchema.validate(opts)
+
+  // Improve errors throwed, reduce stack by throwing here and add reason to the message
+  if (error) {
+    throw new Error(`${error.message}${error.reason ? ' - ' + error.reason : ''}`)
+  } else {
+    // Throw when dht is enabled but no dht module provided
+    if (options.config.dht.enabled) {
+      s('function|object')(options.modules.dht)
+    }
+  }
+
+  return options
+}