fix: protocols change event

I was spelunking last night and found that pubsub was constantly having it's `onConnect` handler fired from the multicodec topology.

It was because bitswap was calling `dialProtocol` to connect to a peer. `dialProtocol` makes a `PeerInfo` out of the multiaddr it's given but it has no `protocols` i.e. `[]`. This is passed to `peerStore.update()` where we compare `[]` with an array of populated protocols. Obviously there is no intersection here so `change:protocols` was being emitted, even though no protocols were added or removed.

This logic needs to be improved and tested properly but I just wanted to send a PR to document my findings.

.aegir.js

@@ -1,82 +1,47 @@
 'use strict'
 
-const pull = require('pull-stream')
-const parallel = require('async/parallel')
-const WebSocketStarRendezvous = require('libp2p-websocket-star-rendezvous')
-const sigServer = require('libp2p-webrtc-star/src/sig-server')
+const Libp2p = require('./src')
+const { MULTIADDRS_WEBSOCKETS } = require('./test/fixtures/browser')
+const Peers = require('./test/fixtures/peers')
+const PeerId = require('peer-id')
+const PeerInfo = require('peer-info')
+const WebSockets = require('libp2p-websockets')
+const Muxer = require('libp2p-mplex')
+const Crypto = require('libp2p-secio')
+const pipe = require('it-pipe')
+let libp2p
 
-const Node = require('./test/utils/bundle-nodejs.js')
-const {
-  getPeerRelay,
-  WRTC_RENDEZVOUS_MULTIADDR,
-  WS_RENDEZVOUS_MULTIADDR
-} = require('./test/utils/constants')
+const before = async () => {
+  // Use the last peer
+  const peerId = await PeerId.createFromJSON(Peers[Peers.length - 1])
+  const peerInfo = new PeerInfo(peerId)
+  peerInfo.multiaddrs.add(MULTIADDRS_WEBSOCKETS[0])
 
-let wrtcRendezvous
-let wsRendezvous
-let node
-
-const before = (done) => {
-  parallel([
-    (cb) => {
-      sigServer.start({
-        port: WRTC_RENDEZVOUS_MULTIADDR.nodeAddress().port
-        // cryptoChallenge: true TODO: needs https://github.com/libp2p/js-libp2p-webrtc-star/issues/128
-      })
-      .then(server => {
-        wrtcRendezvous = server
-        cb()
-      })
-      .catch(cb)
+  libp2p = new Libp2p({
+    peerInfo,
+    modules: {
+      transport: [WebSockets],
+      streamMuxer: [Muxer],
+      connEncryption: [Crypto]
     },
-    (cb) => {
-      WebSocketStarRendezvous.start({
-        port: WS_RENDEZVOUS_MULTIADDR.nodeAddress().port,
-        refreshPeerListIntervalMS: 1000,
-        strictMultiaddr: false,
-        cryptoChallenge: true
-      }, (err, _server) => {
-        if (err) {
-          return cb(err)
+    config: {
+      relay: {
+        enabled: true,
+        hop: {
+          enabled: true,
+          active: false
         }
-        wsRendezvous = _server
-        cb()
-      })
-    },
-    (cb) => {
-      getPeerRelay((err, peerInfo) => {
-        if (err) {
-          return done(err)
-        }
-
-        node = new Node({
-          peerInfo,
-          config: {
-            relay: {
-              enabled: true,
-              hop: {
-                enabled: true,
-                active: true
-              }
-            }
-          }
-        })
-
-        node.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
-        node.start(cb)
-      })
+      }
     }
-  ], done)
+  })
+  // Add the echo protocol
+  libp2p.handle('/echo/1.0.0', ({ stream }) => pipe(stream, stream))
+
+  await libp2p.start()
 }
 
-const after = (done) => {
-  setTimeout(() =>
-    parallel([
-      (cb) => wrtcRendezvous.stop().then(cb).catch(cb),
-      ...[node, wsRendezvous].map((s) => (cb) => s.stop(cb)),
-    ], done),
-    2000
-  )
+const after = async () => {
+  await libp2p.stop()
 }
 
 module.exports = {

.gitignore

@@ -3,12 +3,14 @@ docs
 **/*.log
 test/repo-tests*
 **/bundle.js
+.cache
 
 # Logs
 logs
 *.log
 
 coverage
+.nyc_output
 
 # Runtime data
 pids

.travis.yml

@@ -21,7 +21,8 @@ jobs:
     - stage: check
       script:
         - npx aegir build --bundlesize
-        - npx aegir dep-check -- -i wrtc -i electron-webrtc
+        # Remove pull libs once ping is async
+        - npx aegir dep-check -- -i pull-handshake -i pull-stream
         - npm run lint
 
     - stage: test
@@ -29,16 +30,21 @@ jobs:
       addons:
         chrome: stable
       script:
-        - npx aegir test -t browser
-        - npx aegir test -t webworker
+        - npx aegir test -t browser -t webworker
 
     - stage: test
       name: firefox
       addons:
         firefox: latest
       script:
-        - npx aegir test -t browser -- --browsers FirefoxHeadless
-        - npx aegir test -t webworker -- --browsers FirefoxHeadless
+        - npx aegir test -t browser -t webworker -- --browsers FirefoxHeadless
+
+    - stage: test
+      name: interop
+      script:
+        - cd node_modules/interop-libp2p
+        - npm install
+        - LIBP2P_JS=${TRAVIS_BUILD_DIR}/src/index.js npx aegir test -t node --bail
 
 notifications:
   email: false

CHANGELOG.md

@@ -1,3 +1,191 @@
+<a name="0.27.2"></a>
+## [0.27.2](https://github.com/libp2p/js-libp2p/compare/v0.27.1...v0.27.2) (2020-02-05)
+
+
+### Bug Fixes
+
+* ensure identify streams are closed ([#551](https://github.com/libp2p/js-libp2p/issues/551)) ([f662fdc](https://github.com/libp2p/js-libp2p/commit/f662fdc))
+
+
+
+<a name="0.27.1"></a>
+## [0.27.1](https://github.com/libp2p/js-libp2p/compare/v0.27.0...v0.27.1) (2020-02-03)
+
+
+### Bug Fixes
+
+* stop stream after first pong received ([#545](https://github.com/libp2p/js-libp2p/issues/545)) ([be8fc9d](https://github.com/libp2p/js-libp2p/commit/be8fc9d))
+
+
+
+<a name="0.27.0"></a>
+# [0.27.0](https://github.com/libp2p/js-libp2p/compare/v0.26.2...v0.27.0) (2020-01-28)
+
+
+### Bug Fixes
+
+* clean up peer discovery flow ([#494](https://github.com/libp2p/js-libp2p/issues/494)) ([12fc069](https://github.com/libp2p/js-libp2p/commit/12fc069))
+* clean up pending dials abort per feedback ([633b0c2](https://github.com/libp2p/js-libp2p/commit/633b0c2))
+* conn mngr min/max connection values ([#528](https://github.com/libp2p/js-libp2p/issues/528)) ([ba4681b](https://github.com/libp2p/js-libp2p/commit/ba4681b))
+* correct release readme ([ce8e60b](https://github.com/libp2p/js-libp2p/commit/ce8e60b))
+* examples readme typos ([#481](https://github.com/libp2p/js-libp2p/issues/481)) ([35ac02d](https://github.com/libp2p/js-libp2p/commit/35ac02d))
+* make dialer configurable ([#521](https://github.com/libp2p/js-libp2p/issues/521)) ([4ca481b](https://github.com/libp2p/js-libp2p/commit/4ca481b))
+* performance bottleneck in stat.js ([#463](https://github.com/libp2p/js-libp2p/issues/463)) ([93a1e42](https://github.com/libp2p/js-libp2p/commit/93a1e42))
+* registrar should filter the disconnected conn ([#532](https://github.com/libp2p/js-libp2p/issues/532)) ([bb2e56e](https://github.com/libp2p/js-libp2p/commit/bb2e56e))
+* release tokens as soon as they are available ([2570a1b](https://github.com/libp2p/js-libp2p/commit/2570a1b))
+* replace peerInfo addresses with listen addresses ([#485](https://github.com/libp2p/js-libp2p/issues/485)) ([1999606](https://github.com/libp2p/js-libp2p/commit/1999606))
+* stop discoveries ([#530](https://github.com/libp2p/js-libp2p/issues/530)) ([4222c49](https://github.com/libp2p/js-libp2p/commit/4222c49))
+* token release logic ([90ecc57](https://github.com/libp2p/js-libp2p/commit/90ecc57))
+* upgrader should not need muxers ([#517](https://github.com/libp2p/js-libp2p/issues/517)) ([5d7ee50](https://github.com/libp2p/js-libp2p/commit/5d7ee50))
+* use toB58String everywhere to be consistent ([#537](https://github.com/libp2p/js-libp2p/issues/537)) ([c1038be](https://github.com/libp2p/js-libp2p/commit/c1038be))
+
+
+### Features
+
+* abort all pending dials on stop ([ba02764](https://github.com/libp2p/js-libp2p/commit/ba02764))
+* add early token recycling in ([a5b54a7](https://github.com/libp2p/js-libp2p/commit/a5b54a7))
+* add libp2p.connections getter ([#522](https://github.com/libp2p/js-libp2p/issues/522)) ([6445fda](https://github.com/libp2p/js-libp2p/commit/6445fda))
+* add token based dialer ([e445a17](https://github.com/libp2p/js-libp2p/commit/e445a17))
+* allow transport options to be passed on creation ([#524](https://github.com/libp2p/js-libp2p/issues/524)) ([c339be1](https://github.com/libp2p/js-libp2p/commit/c339be1))
+* coalescing dial support ([#518](https://github.com/libp2p/js-libp2p/issues/518)) ([15f7c2a](https://github.com/libp2p/js-libp2p/commit/15f7c2a))
+* discovery modules ([#486](https://github.com/libp2p/js-libp2p/issues/486)) ([18a062e](https://github.com/libp2p/js-libp2p/commit/18a062e))
+* discovery modules from transports should be added ([#510](https://github.com/libp2p/js-libp2p/issues/510)) ([f1eb373](https://github.com/libp2p/js-libp2p/commit/f1eb373))
+* peer store ([#470](https://github.com/libp2p/js-libp2p/issues/470)) ([582094a](https://github.com/libp2p/js-libp2p/commit/582094a))
+* registrar ([#471](https://github.com/libp2p/js-libp2p/issues/471)) ([9d52b80](https://github.com/libp2p/js-libp2p/commit/9d52b80))
+* support peer-id instances in peer store operations ([#491](https://github.com/libp2p/js-libp2p/issues/491)) ([8da9fc9](https://github.com/libp2p/js-libp2p/commit/8da9fc9))
+
+
+
+<a name="0.27.0-rc.0"></a>
+# [0.27.0-rc.0](https://github.com/libp2p/js-libp2p/compare/v0.27.0-pre.2...v0.27.0-rc.0) (2020-01-24)
+
+
+### Bug Fixes
+
+* registrar should filter the disconnected conn ([#532](https://github.com/libp2p/js-libp2p/issues/532)) ([83409de](https://github.com/libp2p/js-libp2p/commit/83409de))
+* stop discoveries ([#530](https://github.com/libp2p/js-libp2p/issues/530)) ([c44e6e3](https://github.com/libp2p/js-libp2p/commit/c44e6e3))
+* use toB58String everywhere to be consistent ([#537](https://github.com/libp2p/js-libp2p/issues/537)) ([31d1b23](https://github.com/libp2p/js-libp2p/commit/31d1b23))
+
+
+
+<a name="0.27.0-pre.2"></a>
+# [0.27.0-pre.2](https://github.com/libp2p/js-libp2p/compare/v0.27.0-pre.1...v0.27.0-pre.2) (2020-01-07)
+
+
+### Bug Fixes
+
+* conn mngr min/max connection values ([#528](https://github.com/libp2p/js-libp2p/issues/528)) ([a1717da](https://github.com/libp2p/js-libp2p/commit/a1717da))
+* make dialer configurable ([#521](https://github.com/libp2p/js-libp2p/issues/521)) ([24c3ce6](https://github.com/libp2p/js-libp2p/commit/24c3ce6))
+* upgrader should not need muxers ([#517](https://github.com/libp2p/js-libp2p/issues/517)) ([56a1825](https://github.com/libp2p/js-libp2p/commit/56a1825))
+
+
+### Features
+
+* add libp2p.connections getter ([#522](https://github.com/libp2p/js-libp2p/issues/522)) ([6ca19c5](https://github.com/libp2p/js-libp2p/commit/6ca19c5))
+* allow transport options to be passed on creation ([#524](https://github.com/libp2p/js-libp2p/issues/524)) ([0d4b2bd](https://github.com/libp2p/js-libp2p/commit/0d4b2bd))
+
+
+
+<a name="0.27.0-pre.1"></a>
+# [0.27.0-pre.1](https://github.com/libp2p/js-libp2p/compare/v0.27.0-pre.0...v0.27.0-pre.1) (2019-12-15)
+
+
+### Features
+
+* coalescing dial support ([#518](https://github.com/libp2p/js-libp2p/issues/518)) ([4a871bb](https://github.com/libp2p/js-libp2p/commit/4a871bb))
+
+
+
+<a name="0.27.0-pre.0"></a>
+# [0.27.0-pre.0](https://github.com/libp2p/js-libp2p/compare/v0.26.2...v0.27.0-pre.0) (2019-12-12)
+
+
+### Bug Fixes
+
+* clean up peer discovery flow ([#494](https://github.com/libp2p/js-libp2p/issues/494)) ([f3eb1f1](https://github.com/libp2p/js-libp2p/commit/f3eb1f1))
+* clean up pending dials abort per feedback ([7c3371b](https://github.com/libp2p/js-libp2p/commit/7c3371b))
+* correct release readme ([c4bc00b](https://github.com/libp2p/js-libp2p/commit/c4bc00b))
+* examples readme typos ([#481](https://github.com/libp2p/js-libp2p/issues/481)) ([35ac02d](https://github.com/libp2p/js-libp2p/commit/35ac02d))
+* performance bottleneck in stat.js ([#463](https://github.com/libp2p/js-libp2p/issues/463)) ([93a1e42](https://github.com/libp2p/js-libp2p/commit/93a1e42))
+* release tokens as soon as they are available ([43440aa](https://github.com/libp2p/js-libp2p/commit/43440aa))
+* replace peerInfo addresses with listen addresses ([#485](https://github.com/libp2p/js-libp2p/issues/485)) ([acbbc0f](https://github.com/libp2p/js-libp2p/commit/acbbc0f))
+* token release logic ([1838a64](https://github.com/libp2p/js-libp2p/commit/1838a64))
+
+
+### Features
+
+* abort all pending dials on stop ([754fbc2](https://github.com/libp2p/js-libp2p/commit/754fbc2))
+* add early token recycling in ([24c6037](https://github.com/libp2p/js-libp2p/commit/24c6037))
+* add token based dialer ([f8540fa](https://github.com/libp2p/js-libp2p/commit/f8540fa))
+* discovery modules ([#486](https://github.com/libp2p/js-libp2p/issues/486)) ([997ee16](https://github.com/libp2p/js-libp2p/commit/997ee16))
+* discovery modules from transports should be added ([#510](https://github.com/libp2p/js-libp2p/issues/510)) ([af96dcc](https://github.com/libp2p/js-libp2p/commit/af96dcc))
+* peer store ([#470](https://github.com/libp2p/js-libp2p/issues/470)) ([f3e276e](https://github.com/libp2p/js-libp2p/commit/f3e276e))
+* registrar ([#471](https://github.com/libp2p/js-libp2p/issues/471)) ([797d8f0](https://github.com/libp2p/js-libp2p/commit/797d8f0))
+* support peer-id instances in peer store operations ([#491](https://github.com/libp2p/js-libp2p/issues/491)) ([11ed6bd](https://github.com/libp2p/js-libp2p/commit/11ed6bd))
+
+
+
+<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)
 

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-code-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.
 

README.md

@@ -5,11 +5,12 @@
 <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://protocol.ai"><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-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.im/app/#/room/#libp2p:matrix.org"><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>
-  <a href="https://waffle.io/libp2p/libp2p"><img src="https://img.shields.io/badge/pm-waffle-yellow.svg?style=flat-square" /></a>
 </p>
 
 <p align="center">
@@ -29,9 +30,10 @@
 
 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).
+The documentation in the master branch may contain changes from a pre-release.
+If you are looking for the documentation of the latest release, you can view the latest release on [**npm**](https://www.npmjs.com/package/libp2p), or select the tag in github that matches the version you are looking for.
 
-[![Throughput Graph](https://graphs.waffle.io/libp2p/js-libp2p/throughput.svg)](https://waffle.io/libp2p/js-libp2p/metrics/throughput)
+**Want to get started?** Check our [examples folder](/examples).
 
 [**`Weekly Core Dev Calls`**](https://github.com/ipfs/pm/issues/650)
 
@@ -46,12 +48,12 @@ We've come a long way, but this project is still in Alpha, lots of development i
 ## Table of Contents
 
 - [Background](#background)
-- [Bundles](#bundles)
+- [Install](#install)
 - [Usage](#usage)
-  - [Install](#install)
-  - [Usage](#usage)
+  - [Configuration](#configuration)
   - [API](#api)
-    - [Events](#events)
+  - [Getting Started](#getting-started)
+  - [Tutorials and Examples](#tutorials-and-examples)
 - [Development](#development)
   - [Tests](#tests)
   - [Packages](#packages)
@@ -60,7 +62,7 @@ We've come a long way, but this project is still in Alpha, lots of development i
 
 ## Background
 
-libp2p is the product of a long and arduous quest to understand the evolution of the Internet networking stack. In order to build P2P applications, devs have long had to made custom ad-hoc solutions to fit their needs, sometimes making some hard assumptions about their runtimes and the state of the network at the time of their development. Today, looking back more than 20 years, we see a clear pattern in the types of mechanisms built around the Internet Protocol, IP, which can be found throughout many layers of the OSI layer system, libp2p distils these mechanisms into flat categories and defines clear interfaces that once exposed, enable other protocols and applications to use and swap them, enabling upgradability and adaptability for the runtime, without breaking the API.
+libp2p is the product of a long and arduous quest to understand the evolution of the Internet networking stack. In order to build P2P applications, devs have long had to make custom ad-hoc solutions to fit their needs, sometimes making some hard assumptions about their runtimes and the state of the network at the time of their development. Today, looking back more than 20 years, we see a clear pattern in the types of mechanisms built around the Internet Protocol, IP, which can be found throughout many layers of the OSI layer system, libp2p distils these mechanisms into flat categories and defines clear interfaces that once exposed, enable other protocols and applications to use and swap them, enabling upgradability and adaptability for the runtime, without breaking the API.
 
 We are in the process of writing better documentation, blog posts, tutorials and a formal specification. Today you can find:
 
@@ -75,463 +77,37 @@ We are in the process of writing better documentation, blog posts, tutorials and
 
 To sum up, libp2p is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradeability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.
 
-## Bundles
-
-With its modular nature, libp2p can be found being used in different projects with different sets of features, while preserving the same top level API. `js-libp2p` is only a skeleton and should not be installed directly, if you are looking for a prebundled libp2p stack, please check:
-
-- [libp2p-ipfs-nodejs](https://github.com/ipfs/js-ipfs/tree/master/src/core/runtime/libp2p-nodejs.js) - The libp2p build used by js-ipfs when run in Node.js
-- [libp2p-ipfs-browser](https://github.com/ipfs/js-ipfs/tree/master/src/core/runtime/libp2p-browser.js) - The libp2p build used by js-ipfs when run in a Browser (that supports WebRTC)
-
-If you have developed a libp2p bundle, please consider submitting it to this list so that it can be found easily by the users of libp2p.
-
 ## Install
 
-Again, as noted above, this module is only a skeleton and should not be used directly other than libp2p bundle implementors that want to extend its code.
-
 ```sh
-npm install --save libp2p
+npm install libp2p
 ```
 
 ## Usage
 
-### [Tutorials and Examples](/examples)
+### Configuration
 
-You can find multiple examples on the [examples folder](/examples) that will guide you through using libp2p for several scenarios.
-
-### Creating your own libp2p bundle
-
-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 & mplex
-//   crypto-channel: secio
-//   discovery: multicast-dns
-
-const Libp2p = require('libp2p')
-const TCP = require('libp2p-tcp')
-const WS = require('libp2p-websockets')
-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 (_options) {
-    const peerInfo = _options.peerInfo
-    const defaults = {
-      // The libp2p modules for this libp2p bundle
-      modules: {
-        transport: [
-          TCP,
-          new WS()                    // It can take instances too!
-        ],
-        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
-      },
-
-      // 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
-        }
-      }
-    }
-
-    // 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, MPLEX, SECIO and MulticastDNS support.
-```
+For all the information on how you can configure libp2p see [CONFIGURATION.md](./doc/CONFIGURATION.md).
 
 ### API
 
-**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.
+The specification is available on [API.md](./doc/API.md).
 
-#### Create a Node - `Libp2p.createLibp2p(options, callback)`
+### Getting started
 
-> Behaves exactly like `new Libp2p(options)`, but doesn't require a PeerInfo. One will be generated instead
+If you are starting your journey with `js-libp2p`, read the [GETTING_STARTED.md](./doc/GETTING_STARTED.md) guide.
 
-```js
-const { createLibp2p } = require('libp2p')
-createLibp2p(options, (err, libp2p) => {
-  if (err) throw err
-  libp2p.start((err) => {
-    if (err) throw err
-  })
-})
-```
+### Tutorials and Examples
 
-- `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` following signature `function (err) {}`, where `err` is an Error in case starting the node fails.
-
-#### `libp2p.stop(callback)`
-
-> Stop the libp2p Node.
-
-`callback` following signature `function (err) {}`, where `err` is an Error in case stopping the node fails.
-
-#### `libp2p.dial(peer, callback)`
-
-> Dials to another peer in the network, establishes the connection.
-
-- `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` 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.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` following signature `function (err) {}`, where `err` is an Error in case stopping the node fails.
-
-#### `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, options, callback)`
-
-- `key`: Buffer
-- `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`: 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)`
-
-> Stop handling protocol
-
-- `protocol`: String that defines the protocol (e.g '/ipfs/bitswap/1.1.0')
-
-#### 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.
-
-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:connect', (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][]
-
-#### `libp2p.isStarted()`
-
-> Check if libp2p is started
-
-#### `libp2p.ping(peer [, options], callback)`
-
-> Ping a node in the network
-
-#### `libp2p.peerBook`
-
-> PeerBook instance of the node
-
-#### `libp2p.peerInfo`
-
-> 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 also exposed for the time being`
-
-#### `libp2p.dht.put(key, value, callback)`
-
-- `key`: Buffer
-- `value`: Buffer
-
-#### `libp2p.dht.get(key, options, callback)`
-
-- `key`: Buffer
-- `options`: object of options
-- `options.maxTimeout`: Number milliseconds
-
-#### `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
-[PeerBook]: https://github.com/libp2p/js-peer-book
-[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)
+You can find multiple examples on the [examples folder](./examples) that will guide you through using libp2p for several scenarios.
 
 ## Development
 
 **Clone and install dependencies:**
 
 ```sh
-> git clone https://github.com/ipfs/js-ipfs.git
-> cd js-ipfs
+> git clone https://github.com/libp2p/js-libp2p.git
+> cd js-libp2p
 > npm install
 ```
 
@@ -558,67 +134,50 @@ List of packages currently in existence for libp2p
 
 | 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-udp`](//github.com/libp2p/js-libp2p-udp) | [![npm](https://img.shields.io/npm/v/libp2p-udp.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-udp/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-udp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-udp) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-udp.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-udp) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-udp/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-udp) | N/A |
-| [`libp2p-udt`](//github.com/libp2p/js-libp2p-udt) | [![npm](https://img.shields.io/npm/v/libp2p-udt.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-udt/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-udt.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-udt) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-udt.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-udt) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-udt/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-udt) | N/A |
-| [`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) |
-| [`libp2p-websocket-star-rendezvous`](//github.com/libp2p/js-libp2p-websocket-star-rendezvous) | [![npm](https://img.shields.io/npm/v/libp2p-websocket-star-rendezvous.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-websocket-star-rendezvous/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-websocket-star-rendezvous.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websocket-star-rendezvous) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-websocket-star-rendezvous.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-websocket-star-rendezvous) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-websocket-star-rendezvous/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-websocket-star-rendezvous) | [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) |
-| **NAT Traversal** |
-| [`libp2p-circuit`](//github.com/libp2p/js-libp2p-circuit) | [![npm](https://img.shields.io/npm/v/libp2p-circuit.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-circuit/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-circuit.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-circuit) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-circuit.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-circuit) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-circuit/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-circuit) | [Jacob Heun](mailto:jacobheun@gmail.com) |
-| [`libp2p-nat-mngr`](//github.com/libp2p/js-libp2p-nat-mngr) | [![npm](https://img.shields.io/npm/v/libp2p-nat-mngr.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-nat-mngr/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-nat-mngr.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-nat-mngr) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-nat-mngr.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-nat-mngr) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-nat-mngr/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-nat-mngr) | N/A |
-| **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) |
-| **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) |
-| **Record Store** |
-| [`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) | [![Deps](https://david-dm.org/libp2p/interface-record-store.svg?style=flat-square)](https://david-dm.org/libp2p/interface-record-store) | [![Travis CI](https://travis-ci.com/libp2p/interface-record-store.svg?branch=master)](https://travis-ci.com/libp2p/interface-record-store) | [![codecov](https://codecov.io/gh/libp2p/interface-record-store/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/interface-record-store) | N/A |
-| [`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) | [![Deps](https://david-dm.org/libp2p/js-libp2p-record.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-record) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-record.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-record) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-record/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-record) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
-| **Generics** |
-| [`libp2p-connection-manager`](//github.com/libp2p/js-libp2p-connection-manager) | [![npm](https://img.shields.io/npm/v/libp2p-connection-manager.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-connection-manager/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-connection-manager.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-connection-manager) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-connection-manager.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-connection-manager) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-connection-manager/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-connection-manager) | N/A |
-| [`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) |
-| [`libp2p-switch`](//github.com/libp2p/js-libp2p-switch) | [![npm](https://img.shields.io/npm/v/libp2p-switch.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-switch/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-switch.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-switch) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-switch.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-switch) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-switch/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-switch) | [Jacob Heun](mailto:jacobheun@gmail.com) |
-| **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) |
-| [`libp2p-identify`](//github.com/libp2p/js-libp2p-identify) | [![npm](https://img.shields.io/npm/v/libp2p-identify.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-identify/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-identify.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-identify) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-identify.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-identify) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-identify/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-identify) | [Jacob Heun](mailto:jacobheun@gmail.com) |
-| [`libp2p-keychain`](//github.com/libp2p/js-libp2p-keychain) | [![npm](https://img.shields.io/npm/v/libp2p-keychain.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-keychain/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-keychain.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-keychain) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-keychain.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-keychain) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-keychain/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-keychain) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
-| [`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) | [![Deps](https://david-dm.org/libp2p/js-libp2p-ping.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-ping) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-ping.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-ping) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-ping/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-ping) | [Jacob Heun](mailto:jacobheun@gmail.com) |
-| [`libp2p-pnet`](//github.com/libp2p/js-libp2p-pnet) | [![npm](https://img.shields.io/npm/v/libp2p-pnet.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-pnet/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-pnet.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-pnet) | [![Travis CI](https://travis-ci.com/libp2p/js-libp2p-pnet.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-pnet) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-pnet/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-libp2p-pnet) | [Jacob Heun](mailto:jacobheun@gmail.com) |
-| **Utilities** |
-| [`p2pcat`](//github.com/libp2p/js-p2pcat) | [![npm](https://img.shields.io/npm/v/p2pcat.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-p2pcat/releases) | [![Deps](https://david-dm.org/libp2p/js-p2pcat.svg?style=flat-square)](https://david-dm.org/libp2p/js-p2pcat) | [![Travis CI](https://travis-ci.com/libp2p/js-p2pcat.svg?branch=master)](https://travis-ci.com/libp2p/js-p2pcat) | [![codecov](https://codecov.io/gh/libp2p/js-p2pcat/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/js-p2pcat) | N/A |
+| **libp2p** |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-daemon`](//github.com/libp2p/js-libp2p-daemon) | [![npm](https://img.shields.io/npm/v/libp2p-daemon.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-daemon/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-daemon.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-daemon) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-daemon.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-daemon) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-daemon/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-daemon) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`libp2p-daemon-client`](//github.com/libp2p/js-libp2p-daemon-client) | [![npm](https://img.shields.io/npm/v/libp2p-daemon-client.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-daemon-client/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-daemon-client.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-daemon-client) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-daemon-client.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-daemon-client) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-daemon-client/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-daemon-client) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
+| [`libp2p-interfaces`](//github.com/libp2p/js-interfaces) | [![npm](https://img.shields.io/npm/v/libp2p-interfaces.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-interfaces/releases) | [![Deps](https://david-dm.org/libp2p/js-interfaces.svg?style=flat-square)](https://david-dm.org/libp2p/js-interfaces) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-interfaces.svg?branch=master)](https://travis-ci.com/libp2p/js-interfaces) | [![codecov](https://codecov.io/gh/libp2p/js-interfaces/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-interfaces) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`interop-libp2p`](//github.com/libp2p/interop) | [![npm](https://img.shields.io/npm/v/interop-libp2p.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/interop/releases) | [![Deps](https://david-dm.org/libp2p/interop.svg?style=flat-square)](https://david-dm.org/libp2p/interop) | [![Travis CI](https://flat.badgen.net/travis/libp2p/interop.svg?branch=master)](https://travis-ci.com/libp2p/interop) | [![codecov](https://codecov.io/gh/libp2p/interop/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/interop) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
+| **transports** |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-utp) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-websocket-star) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **secure 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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-secio) | [Friedel Ziegelmayer](mailto:dignifiedquire@gmail.com) |
+| **stream multiplexers** |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-spdy) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **peer discovery** |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-rendezvous) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-websocket-star) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| **content routing** |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| **peer routing** |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-crypto) | [Jacob Heun](mailto:jacobheun@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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-crypto-secp256k1) | [Friedel Ziegelmayer](mailto:dignifiedquire@gmail.com) |
+| **data types** |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-peer-id) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-peer-info) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| **pubsub** |
+| [`libp2p-pubsub`](//github.com/libp2p/js-libp2p-pubsub) | [![npm](https://img.shields.io/npm/v/libp2p-pubsub.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-pubsub/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-pubsub.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-pubsub) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-pubsub.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-pubsub) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-pubsub/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-pubsub) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
+| [`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://flat.badgen.net/travis/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?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-floodsub) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
+| [`libp2p-gossipsub`](//github.com/ChainSafe/gossipsub-js) | [![npm](https://img.shields.io/npm/v/libp2p-gossipsub.svg?maxAge=86400&style=flat-square)](//github.com/ChainSafe/gossipsub-js/releases) | [![Deps](https://david-dm.org/ChainSafe/gossipsub-js.svg?style=flat-square)](https://david-dm.org/ChainSafe/gossipsub-js) | [![Travis CI](https://flat.badgen.net/travis/ChainSafe/gossipsub-js.svg?branch=master)](https://travis-ci.com/ChainSafe/gossipsub-js) | [![codecov](https://codecov.io/gh/ChainSafe/gossipsub-js/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ChainSafe/gossipsub-js) | [Cayman Nava](mailto:caymannava@gmail.com) |
+| **extensions** |
+| [`libp2p-nat-mgnr`](//github.com/libp2p/js-libp2p-nat-mgnr) | [![npm](https://img.shields.io/npm/v/libp2p-nat-mgnr.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-nat-mgnr/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-nat-mgnr.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-nat-mgnr) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-nat-mgnr.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-nat-mgnr) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-nat-mgnr/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-nat-mgnr) | N/A |
+| [`libp2p-utils`](//github.com/libp2p/js-libp2p-utils) | [![npm](https://img.shields.io/npm/v/libp2p-utils.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-utils/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-utils.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-utils) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-utils.svg?branch=master)](https://travis-ci.com/libp2p/js-libp2p-utils) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-utils/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-utils) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
 
 ## Contribute
 

RELEASE.md

@@ -50,8 +50,8 @@ Would you like to contribute to the libp2p project and don't know how? Well, the
 - 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!
+- Join the discussion at http://discuss.libp2p.io/ and help users finding their answers.
+- Join the [⚡️libp2p Weekly Sync 🙌🏽](https://github.com/libp2p/team-mgmt/issues/16) and be part of the Sprint action!
 
 # ⁉️ Do you have questions?
 

doc/API.md

@@ -0,0 +1,807 @@
+# API
+
+* [Static Functions](#static-functions)
+  * [`create`](#create)
+* [Instance Methods](#instance-methods)
+  * [`start`](#start)
+  * [`stop`](#stop)
+  * [`dial`](#dial)
+  * [`dialProtocol`](#dialprotocol)
+  * [`hangUp`](#hangup)
+  * [`handle`](#handle)
+  * [`unhandle`](#unhandle)
+  * [`ping`](#ping)
+  * [`peerRouting.findPeer`](#peerroutingfindpeer)
+  * [`contentRouting.findProviders`](#contentroutingfindproviders)
+  * [`contentRouting.provide`](#contentroutingprovide)
+  * [`contentRouting.put`](#contentroutingput)
+  * [`contentRouting.get`](#contentroutingget)
+  * [`contentRouting.getMany`](#contentroutinggetmany)
+  * [`pubsub.getSubscribers`](#pubsubgetsubscribers)
+  * [`pubsub.getTopics`](#pubsubgettopics)
+  * [`pubsub.publish`](#pubsubpublish)
+  * [`pubsub.subscribe`](#pubsubsubscribe)
+  * [`pubsub.unsubscribe`](#pubsubunsubscribe)
+  * [`connectionManager.setPeerValue`](#connectionmanagersetpeervalue)
+  * [`metrics.global`](#metricsglobal)
+  * [`metrics.peers`](#metricspeers)
+  * [`metrics.protocols`](#metricsprotocols)
+  * [`metrics.forPeer`](#metricsforpeer)
+  * [`metrics.forProtocol`](#metricsforprotocol)
+* [Events](#events)
+* [Types](#types)
+  * [`Stats`](#stats)
+
+## Static Functions
+
+### create
+
+Creates an instance of Libp2p.
+
+`create(options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| options | `Object` | libp2p options |
+| options.modules | `Array<Object>` | libp2p modules to use |
+| [options.config] | `Object` | libp2p modules configuration and core configuration |
+| [options.connectionManager] | `Object` | libp2p Connection Manager configuration |
+| [options.datastore] | `Object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) (in memory datastore will be used if not provided) |
+| [options.dialer] | `Object` | libp2p Dialer configuration
+| [options.metrics] | `Object` | libp2p Metrics configuration
+| [options.peerInfo] | [`PeerInfo`][peer-info] | peerInfo instance (it will be created if not provided) |
+
+For Libp2p configurations and modules details read the [Configuration Document](./CONFIGURATION.md).
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<Libp2p>` | Promise resolves with the Libp2p instance |
+
+#### Example
+
+```js
+const Libp2p = require('libp2p')
+
+// specify options
+const options = {}
+
+// create libp2p
+const libp2p = await Libp2p.create(options)
+```
+
+Note: The [`PeerInfo`][peer-info] option is not required and will be generated if it is not provided.
+
+<details><summary>Alternative</summary>
+As an alternative, it is possible to create a Libp2p instance with the constructor:
+
+#### Example
+
+```js
+const Libp2p = require('libp2p')
+
+// specify options
+const options = {}
+
+// create libp2p
+const libp2p = new Libp2p(options)
+```
+
+Required keys in the `options` object:
+
+- `peerInfo`: instance of [`PeerInfo`][peer-info] that contains the [`PeerId`][peer-id], Keys and [multiaddrs][multiaddr] of the libp2p Node (optional when using `.create`).
+- `modules.transport`: An array that must include at least 1 compliant transport. See [modules that implement the transport interface](https://github.com/libp2p/js-interfaces/tree/master/src/transport#modules-that-implement-the-interface).
+
+</details>
+
+## Libp2p Instance Methods
+
+### start
+
+Starts the libp2p node.
+
+`libp2p.start()`
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise` | Promise resolves when the node is ready |
+
+#### Example
+
+```js
+const Libp2p = require('libp2p')
+
+// ...
+
+const libp2p = await Libp2p.create(options)
+
+// start libp2p
+await libp2p.start()
+```
+
+### stop
+
+Stops the libp2p node.
+
+`libp2p.stop()`
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise` | Promise resolves when the node is fully stopped |
+
+#### Example
+
+```js
+const Libp2p = require('libp2p')
+
+// ...
+const libp2p = await Libp2p.create(options)
+// ...
+
+// stop libp2p
+await libp2p.stop()
+```
+
+### connections
+
+A Getter that returns a Map of the current Connections libp2p has to other peers.
+
+`libp2p.connections`
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Map<string, Array<Connection>>` | A map of [`PeerId`][peer-id] strings to [`Connection`][connection] Arrays |
+
+#### Example
+
+```js
+for (const [peerId, connections] of libp2p.connections) {
+  for (const connection of connections) {
+    console.log(peerId, connection.remoteAddr.toString())
+    // Logs the PeerId string and the observed remote multiaddr of each Connection
+  }
+}
+```
+
+### dial
+
+Dials to another peer in the network and establishes the connection.
+
+`dial(peer, options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to dial |
+| [options] | `Object` | dial options |
+| [options.signal] | [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) | An `AbortSignal` instance obtained from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) that can be used to abort the connection before it completes |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<Connection>` | Promise resolves with the [Connection][connection] instance |
+
+#### Example
+
+```js
+// ...
+const conn = await libp2p.dial(remotePeerInfo)
+
+// create a new stream within the connection
+const { stream, protocol } = await conn.newStream(['/echo/1.1.0', '/echo/1.0.0'])
+
+// protocol negotiated: 'echo/1.0.0' means that the other party only supports the older version
+
+// ...
+await conn.close()
+```
+
+### dialProtocol
+
+Dials to another peer in the network and selects a protocol to communicate with that peer. The stream between both parties is returned, together with the negotiated protocol.
+
+`dialProtocol(peer, protocols, options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to dial |
+| protocols | `String|Array<String>` |  A list of protocols (or single protocol) to negotiate with. Protocols are attempted in order until a match is made. (e.g '/ipfs/bitswap/1.1.0') |
+| [options] | `Object` | dial options |
+| [options.signal] | [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) | An `AbortSignal` instance obtained from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) that can be used to abort the connection before it completes |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<{ stream:*, protocol:string }>` | Promise resolves with a [duplex stream](https://gist.github.com/alanshaw/591dc7dd54e4f99338a347ef568d6ee9#duplex-it) and the protocol used |
+
+#### Example
+
+```js
+// ...
+const pipe = require('it-pipe')
+
+const { stream, protocol } = await libp2p.dialProtocol(remotePeerInfo, protocols)
+
+// Use this new stream like any other duplex stream
+pipe([1, 2, 3], stream, consume)
+```
+
+### hangUp
+
+Attempts to gracefully close an open connection to the given peer. If the connection is not closed in the grace period, it will be forcefully closed.
+
+`hangUp(peer)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to hang up |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<void>` | Promise resolves once connection closes |
+
+#### Example
+
+```js
+// ...
+await libp2p.hangUp(remotePeerInfo)
+```
+
+### handle
+
+Sets up [multistream-select routing](https://github.com/multiformats/multistream-select) of protocols to their application handlers. Whenever a stream is opened on one of the provided protocols, the handler will be called. `handle` must be called in order to register a handler and support for a given protocol. This also informs other peers of the protocols you support.
+
+`libp2p.handle(protocols, handler)`
+
+In the event of a new handler for the same protocol being added, the first one is discarded.
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| protocols | `Array<String>|String` | protocols to register |
+| handler | `function({ connection:*, stream:*, protocol:string })` | handler to call |
+
+
+#### Example
+
+```js
+// ...
+const handler = ({ connection, stream, protocol }) => {
+  // use stream or connection according to the needs
+}
+
+libp2p.handle('/echo/1.0.0', handler)
+```
+
+### unhandle
+
+Unregisters all handlers with the given protocols
+
+`libp2p.unhandle(protocols)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| protocols | `Array<String>|String` | protocols to unregister |
+
+#### Example
+
+```js
+// ...
+libp2p.unhandle(['/echo/1.0.0'])
+```
+
+### ping
+
+Pings a given peer and get the operation's latency.
+
+`libp2p.ping(peer)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to ping |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<number>` | Latency of the operation in ms |
+
+#### Example
+
+```js
+// ...
+const latency = await libp2p.ping(otherPeerId)
+```
+
+### peerRouting.findPeer
+
+Iterates over all peer routers in series to find the given peer. If the DHT is enabled, it will be tried first.
+
+`libp2p.peerRouting.findPeer(peerId, options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| peerId | [`PeerId`][peer-id] | ID of the peer to find |
+| options | `Object` | operation options |
+| options.timeout | `number` | maximum time the query should run |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<PeerInfo>` | Peer info of a known peer |
+
+#### Example
+
+```js
+// ...
+const peerInfo = await libp2p.peerRouting.findPeer(peerId, options)
+```
+
+### contentRouting.findProviders
+
+Iterates over all content routers in series to find providers of the given key.
+Once a content router succeeds, the iteration will stop. If the DHT is enabled, it will be queried first.
+
+`libp2p.contentRouting.findProviders(cid, options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| cid | [`CID`][cid] | cid to find |
+| options | `Object` | operation options |
+| options.timeout | `number` | maximum time the query should run |
+| options.maxNumProviders | `number` | maximum number of providers to find |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `AsyncIterator<PeerInfo>` |  Async iterator for [`PeerInfo`][peer-info] |
+
+#### Example
+
+```js
+// Iterate over the providers found for the given cid
+for await (const provider of libp2p.contentRouting.findProviders(cid)) {
+  console.log(provider)
+}
+```
+
+### contentRouting.provide
+
+Iterates over all content routers in parallel, in order to notify it is a provider of the given key.
+
+`libp2p.contentRouting.provide(cid)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| cid | [`CID`][cid] | cid to provide |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<void>` | Promise resolves once notifications are sent |
+
+#### Example
+
+```js
+// ...
+await libp2p.contentRouting.provide(cid)
+```
+
+### contentRouting.put
+
+Writes a value to a key in the DHT.
+
+`libp2p.contentRouting.put(key, value, options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| key | `String` | key to add to the dht |
+| value | `Buffer` | value to add to the dht |
+| [options] | `Object` | put options |
+| [options.minPeers] | `number` | minimum number of peers required to successfully put (default: closestPeers.length) |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<void>` | Promise resolves once value is stored |
+
+#### Example
+
+```js
+// ...
+const key = '/key'
+const value = Buffer.from('oh hello there')
+
+await libp2p.contentRouting.put(key, value)
+```
+
+### contentRouting.get
+
+Queries the DHT for a value stored for a given key.
+
+`libp2p.contentRouting.get(key, options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| key | `String` | key to get from the dht |
+| [options] | `Object` | get options |
+| [options.timeout] | `number` | maximum time the query should run |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<Buffer>` | Value obtained from the DHT |
+
+#### Example
+
+```js
+// ...
+
+const key = '/key'
+const value = await libp2p.contentRouting.get(key)
+```
+
+### contentRouting.getMany
+
+Queries the DHT for the n values stored for the given key (without sorting).
+
+`libp2p.contentRouting.getMany(key, nvals, options)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| key | `String` | key to get from the dht |
+| nvals | `number` | number of values aimed |
+| [options] | `Object` | get options |
+| [options.timeout] | `number` | maximum time the query should run |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise<Array<{from: PeerId, val: Buffer}>>` | Array of records obtained from the DHT |
+
+#### Example
+
+```js
+// ...
+
+const key = '/key'
+const { from, val } = await libp2p.contentRouting.get(key)
+```
+
+### pubsub.getSubscribers
+
+Gets a list of the peer-ids that are subscribed to one topic.
+
+`libp2p.pubsub.getSubscribers(topic)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| topic | `string` | topic to publish |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Array<String>` | peer-id subscribed to the topic |
+
+#### Example
+
+```js
+const peerIds = libp2p.pubsub.getSubscribers(topic)
+```
+
+### pubsub.getTopics
+
+Gets a list of topics the node is subscribed to.
+
+`libp2p.pubsub.getTopics()`
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Array<String>` | topics the node is subscribed to |
+
+#### Example
+
+```js
+const topics = libp2p.pubsub.getTopics()
+```
+
+### pubsub.publish
+
+Publishes messages to the given topics.
+
+`libp2p.pubsub.publish(topic, data)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| topic | `string` | topic to publish |
+| data | `Buffer` | data to publish  |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `Promise` | publish success |
+
+#### Example
+
+```js
+const topic = 'topic'
+const data = Buffer.from('data')
+
+await libp2p.pubsub.publish(topic, data)
+```
+
+### pubsub.subscribe
+
+Subscribes the given handler to a pubsub topic.
+
+`libp2p.pubsub.subscribe(topic, handler)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| topic | `string` | topic to subscribe |
+| handler | `function({ from: String, data: Buffer, seqno: Buffer, topicIDs: Array<String>, signature: Buffer, key: Buffer })` | handler for new data on topic |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `void` |  |
+
+#### Example
+
+```js
+const topic = 'topic'
+const handler = (msg) => {
+  // msg.data - pubsub data received
+}
+
+libp2p.pubsub.subscribe(topic, handler)
+```
+
+### pubsub.unsubscribe
+
+Unsubscribes the given handler from a pubsub topic. If no handler is provided, all handlers for the topic are removed.
+
+`libp2p.pubsub.unsubscribe(topic, handler)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| topic | `string` | topic to unsubscribe |
+| handler | `function(<Object>)` | handler subscribed |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `void` |  |
+
+#### Example
+
+```js
+const topic = 'topic'
+const handler = (msg) => {
+  // msg.data - pubsub data received
+}
+
+libp2p.pubsub.unsubscribe(topic, handler)
+```
+
+### connectionManager.setPeerValue
+
+Enables users to change the value of certain peers in a range of 0 to 1. Peers with the lowest values will have their Connections pruned first, if any Connection Manager limits are exceeded. See [./CONFIGURATION.md#configuring-connection-manager](./CONFIGURATION.md#configuring-connection-manager) for details on how to configure these limits.
+
+`libp2p.connectionManager.setPeerValue(peerId, value)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| peerId | [`PeerId`][peer-id] | The peer to set the value for |
+| value | `number` | The value of the peer from 0 to 1 |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| `void` |  |
+
+#### Example
+
+```js
+libp2p.connectionManager.setPeerValue(highPriorityPeerId, 1)
+libp2p.connectionManager.setPeerValue(lowPriorityPeerId, 0)
+```
+
+### metrics.global
+
+A [`Stats`](#stats) object of tracking the global bandwidth of the libp2p node.
+
+#### Example
+
+```js
+const peerIdStrings = libp2p.metrics.peers
+```
+
+### metrics.peers
+
+An array of [`PeerId`][peer-id] strings of each peer currently being tracked.
+
+#### Example
+
+```js
+const peerIdStrings = libp2p.metrics.peers
+```
+
+### metrics.protocols
+
+An array of protocol strings that are currently being tracked.
+
+#### Example
+
+```js
+const protocols = libp2p.metrics.protocols
+```
+
+### metrics.forPeer
+
+Returns the [`Stats`](#stats) object for a given [`PeerId`][peer-id] if it is being tracked.
+
+`libp2p.metrics.forPeer(peerId)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| peerId | [`PeerId`][peer-id] | The peer to get stats for |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| [`Stats`](#stats) | The bandwidth stats of the peer |
+
+#### Example
+
+```js
+const peerStats = libp2p.metrics.forPeer(peerInfo)
+console.log(peerStats.toJSON())
+```
+
+### metrics.forProtocol
+
+Returns the [`Stats`](#stats) object for a given protocol if it is being tracked.
+
+`libp2p.metrics.forProtocol(protocol)`
+
+#### Parameters
+
+| Name | Type | Description |
+|------|------|-------------|
+| protocol | `string` | The protocol to get stats for |
+
+#### Returns
+
+| Type | Description |
+|------|-------------|
+| [`Stats`](#stats) | The bandwidth stats of the protocol across all peers |
+
+#### Example
+
+```js
+const peerStats = libp2p.metrics.forProtocol('/meshsub/1.0.0')
+console.log(peerStats.toJSON())
+```
+
+## Events
+
+Once you have a libp2p instance, you can listen to several events it emits, so that you can be notified of relevant network events.
+
+#### An error has occurred
+
+`libp2p.on('error', (err) => {})`
+
+- `err`: instance of `Error`
+
+#### A peer has been discovered
+
+`libp2p.on('peer:discovery', (peer) => {})`
+
+If `autoDial` option 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`][peer-info]
+
+#### A new connection to a peer has been opened
+
+This event will be triggered anytime a new Connection is established to another peer.
+
+`libp2p.on('peer:connect', (peer) => {})`
+
+- `peer`: instance of [`PeerInfo`][peer-info]
+
+#### An existing connection to a peer has been closed
+
+This event will be triggered anytime we are disconnected from another peer, regardless of the circumstances of that disconnection. If we happen to have multiple connections to a peer, this event will **only** be triggered when the last connection is closed.
+
+`libp2p.on('peer:disconnect', (peer) => {})`
+
+- `peer`: instance of [`PeerInfo`][peer-info]
+
+## Types
+
+### Stats
+
+- `Stats`
+  - `toJSON<function()>`: Returns a JSON snapshot of the stats.
+    - `dataReceived<string>`: The stringified value of total incoming data for this stat.
+    - `dataSent<string>`: The stringified value of total outgoing data for this stat.
+    - `movingAverages<object>`: The properties are dependent on the configuration of the moving averages interval. Defaults are listed here.
+      - `['60000']<Number>`: The calculated moving average at a 1 minute interval.
+      - `['300000']<Number>`: The calculated moving average at a 5 minute interval.
+      - `['900000']<Number>`: The calculated moving average at a 15 minute interval.
+  - `snapshot<object>`: A getter that returns a clone of the raw stats.
+    - `dataReceived<BigNumber>`: A [`BigNumber`](https://github.com/MikeMcl/bignumber.js/) of the amount of incoming data
+    - `dataSent<BigNumber>`: A [`BigNumber`](https://github.com/MikeMcl/bignumber.js/) of the amount of outgoing data
+  - `movingAverages<object>`: A getter that returns a clone of the raw [moving averages](https://www.npmjs.com/package/moving-averages) stats. **Note**: The properties of this are dependent on configuration. The defaults are shown here.
+    - `['60000']<MovingAverage>`: The [MovingAverage](https://www.npmjs.com/package/moving-averages) at a 1 minute interval.
+    - `['300000']<MovingAverage>`: The [MovingAverage](https://www.npmjs.com/package/moving-averages) at a 5 minute interval.
+    - `['900000']<MovingAverage>`: The [MovingAverage](https://www.npmjs.com/package/moving-averages) at a 15 minute interval.
+
+[cid]: https://github.com/multiformats/js-cid
+[connection]: https://github.com/libp2p/js-interfaces/tree/master/src/connection
+[multiaddr]: https://github.com/multiformats/js-multiaddr
+[peer-id]: https://github.com/libp2p/js-peer-id
+[peer-info]: https://github.com/libp2p/js-peer-info

doc/CONFIGURATION.md

@@ -0,0 +1,541 @@
+# Configuration
+
+- [Configuration](#configuration)
+  - [Overview](#overview)
+  - [Modules](#modules)
+    - [Transport](#transport)
+    - [Stream Multiplexing](#stream-multiplexing)
+    - [Connection Encryption](#connection-encryption)
+    - [Peer Discovery](#peer-discovery)
+    - [Content Routing](#content-routing)
+    - [Peer Routing](#peer-routing)
+    - [DHT](#dht)
+    - [Pubsub](#pubsub)
+  - [Customizing libp2p](#customizing-libp2p)
+    - [Examples](#examples)
+      - [Basic setup](#basic-setup)
+      - [Customizing Peer Discovery](#customizing-peer-discovery)
+      - [Setup webrtc transport and discovery](#setup-webrtc-transport-and-discovery)
+      - [Customizing Pubsub](#customizing-pubsub)
+      - [Customizing DHT](#customizing-dht)
+      - [Setup with Content and Peer Routing](#setup-with-content-and-peer-routing)
+      - [Setup with Relay](#setup-with-relay)
+      - [Configuring Dialing](#configuring-dialing)
+      - [Configuring Connection Manager](#configuring-connection-manager)
+      - [Configuring Metrics](#configuring-metrics)
+      - [Customizing Transports](#customizing-transports)
+  - [Configuration examples](#configuration-examples)
+
+## Overview
+
+libp2p is a modular networking stack. It's designed to be able to suit a variety of project needs. The configuration of libp2p is a key part of its structure. It enables you to bring exactly what you need, and only what you need. This document is a guide on how to configure libp2p for your particular project. Check out the [Configuration examples](#configuration-examples) section if you're just looking to leverage an existing configuration.
+
+Regardless of how you configure libp2p, the top level [API](./API.md) will always remain the same. **Note**: if some modules are not configured, like Content Routing, using those methods will throw errors.
+
+## Modules
+
+`js-libp2p` acts as the composer for this modular p2p networking stack using libp2p compatible modules as its subsystems. For getting an instance of `js-libp2p` compliant with all types of networking requirements, it is possible to specify the following subsystems:
+
+- Transports
+- Multiplexers
+- Connection encryption mechanisms
+- Peer discovery protocols
+- Content routing protocols
+- Peer routing protocols
+- DHT implementation
+- Pubsub router
+
+The libp2p ecosystem contains at least one module for each of these subsystems. The user should install and import the modules that are relevant for their requirements. Moreover, thanks to the existing interfaces it is easy to create a libp2p compatible module and use it.
+
+After selecting the modules to use, it is also possible to configure each one according to your needs.
+
+Bear in mind that only a **transport** and **connection encryption** are required, while all the other subsystems are optional.
+
+### Transport
+
+> In a p2p system, we need to interact with other peers in the network. Transports are used to establish connections between peers. The libp2p transports to use should be decided according to the environment where your node will live, as well as other requirements that you might have.
+
+Some available transports are:
+
+- [libp2p/js-libp2p-tcp](https://github.com/libp2p/js-libp2p-tcp)
+- [libp2p/js-libp2p-webrtc-star](https://github.com/libp2p/js-libp2p-webrtc-star)
+- [libp2p/js-libp2p-webrtc-direct](https://github.com/libp2p/js-libp2p-webrtc-direct)
+- [libp2p/js-libp2p-websockets](https://github.com/libp2p/js-libp2p-websockets)
+- [libp2p/js-libp2p-utp](https://github.com/libp2p/js-libp2p-utp) (Work in Progress)
+
+You should take into consideration that `js-libp2p-tcp` and `js-libp2p-utp` are not available in a **browser** environment.
+
+If none of the available transports fulfills your needs, you can create a libp2p compatible transport. A libp2p transport just needs to be compliant with the [Transport Interface](https://github.com/libp2p/js-interfaces/tree/master/src/transport).
+
+If you want to know more about libp2p transports, you should read the following content:
+
+- https://docs.libp2p.io/concepts/transport
+- https://github.com/libp2p/specs/tree/master/connections
+
+### Stream Multiplexing
+
+> Libp2p peers will need to communicate with each other through several protocols during their life. Stream multiplexing allows multiple independent logical streams to share a common underlying transport medium, instead of creating a new connection with the same peer per needed protocol.
+
+Some available stream multiplexers are:
+
+- [libp2p/js-libp2p-mplex](https://github.com/libp2p/js-libp2p-mplex)
+
+If none of the available stream multiplexers fulfills your needs, you can create a libp2p compatible stream multiplexer. A libp2p multiplexer just needs to be compliant with the [Stream Muxer Interface](https://github.com/libp2p/js-interfaces/tree/master/src/stream-muxer).
+
+If you want to know more about libp2p stream multiplexing, you should read the following content:
+
+- https://docs.libp2p.io/concepts/stream-multiplexing
+- https://github.com/libp2p/specs/tree/master/connections
+- https://github.com/libp2p/specs/tree/master/mplex
+
+### Connection Encryption
+
+> A connection encryption mechanism must be used, in order to ensure all exchanged data between two peers is encrypted.
+
+Some available connection encryption protocols:
+
+- [libp2p/js-libp2p-secio](https://github.com/libp2p/js-libp2p-secio)
+
+If none of the available connection encryption mechanisms fulfills your needs, you can create a libp2p compatible one. A libp2p connection encryption protocol just needs to be compliant with the [Crypto Interface](https://github.com/libp2p/js-interfaces/tree/master/src/crypto).
+
+If you want to know more about libp2p connection encryption, you should read the following content:
+
+- https://docs.libp2p.io/concepts/secure-comms
+- https://github.com/libp2p/specs/tree/master/connections
+
+### Peer Discovery
+
+> In a p2p network, peer discovery is critical to a functioning system.
+
+Some available peer discovery modules are:
+
+- [js-libp2p-mdns](https://github.com/libp2p/js-libp2p-mdns)
+- [js-libp2p-bootstrap](https://github.com/libp2p/js-libp2p-bootstrap)
+- [js-libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht)
+- [js-libp2p-webrtc-star](https://github.com/libp2p/js-libp2p-webrtc-star)
+
+**Note**: `peer-discovery` services within transports (such as `js-libp2p-webrtc-star`) are automatically gathered from the `transport`, via it's `discovery` property. As such, they do not need to be added in the discovery modules. However, these transports can also be configured and disabled as the other ones.
+
+If none of the available peer discovery protocols fulfills your needs, you can create a libp2p compatible one. A libp2p peer discovery protocol just needs to be compliant with the [Peer Discovery Interface](https://github.com/libp2p/js-interfaces/tree/master/src/peer-discovery).
+
+If you want to know more about libp2p peer discovery, you should read the following content:
+
+- https://github.com/libp2p/specs/blob/master/discovery/mdns.md
+
+### Content Routing
+
+> Content routing provides a way to find where content lives in the network. It works in two steps: 1) Peers provide (announce) to the network that they are holders of specific content and 2) Peers issue queries to find where that content lives. A Content Routing mechanism could be as complex as a DHT or as simple as a registry somewhere in the network.
+
+Some available content routing modules are:
+
+- [js-libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht)
+- [js-libp2p-delegated-content-routing](https://github.com/libp2p/js-libp2p-delegated-content-routing)
+
+If none of the available content routing protocols fulfills your needs, you can create a libp2p compatible one. A libp2p content routing protocol just needs to be compliant with the [Content Routing Interface](https://github.com/libp2p/js-interfaces/tree/master/src/content-routing). **(WIP: This module is not yet implemented)**
+
+If you want to know more about libp2p content routing, you should read the following content:
+
+- https://docs.libp2p.io/concepts/content-routing
+
+### Peer Routing
+
+> Peer Routing offers a way to find other peers in the network by issuing queries using a Peer Routing algorithm, which may be iterative or recursive. If the algorithm is unable to find the target peer, it will return the peers that are "closest" to the target peer, using a distance metric defined by the algorithm.
+
+Some available peer routing modules are:
+
+- [js-libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht)
+- [js-libp2p-delegated-peer-routing](https://github.com/libp2p/js-libp2p-delegated-peer-routing)
+
+If none of the available peer routing protocols fulfills your needs, you can create a libp2p compatible one. A libp2p peer routing protocol just needs to be compliant with the [Peer Routing Interface](https://github.com/libp2p/js-interfaces/tree/master/src/peer-routing). **(WIP: This module is not yet implemented)**
+
+If you want to know more about libp2p peer routing, you should read the following content:
+
+- https://docs.libp2p.io/concepts/peer-routing
+
+### DHT
+
+> A DHT can provide content and peer routing capabilities in a p2p system, as well as peer discovery capabilities.
+
+The DHT implementation currently available is [libp2p/js-libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht). This implementation is largely based on the Kademlia whitepaper, augmented with notions from S/Kademlia, Coral and mainlineDHT.
+
+If this DHT implementation does not fulfill your needs and you want to create or use your own implementation, please get in touch with us through a github issue. We plan to work on improving the ability to bring your own DHT in a future release.
+
+If you want to know more about libp2p DHT, you should read the following content:
+
+- https://docs.libp2p.io/concepts/protocols/#kad-dht
+- https://github.com/libp2p/specs/pull/108
+
+### Pubsub
+
+> Publish/Subscribe is a system where peers congregate around topics they are interested in. Peers interested in a topic are said to be subscribed to that topic and should receive the data published on it from other peers.
+
+Some available pubsub routers are:
+
+- [libp2p/js-libp2p-floodsub](https://github.com/libp2p/js-libp2p-floodsub)
+- [ChainSafe/gossipsub-js](https://github.com/ChainSafe/gossipsub-js)
+
+If none of the available pubsub routers fulfills your needs, you can create a libp2p compatible one. A libp2p pubsub router just needs to be created on top of [libp2p/js-libp2p-pubsub](https://github.com/libp2p/js-libp2p-pubsub), which ensures `js-libp2p` API expectations.
+
+If you want to know more about libp2p pubsub, you should read the following content:
+
+- https://docs.libp2p.io/concepts/publish-subscribe
+- https://github.com/libp2p/specs/tree/master/pubsub
+
+## Customizing libp2p
+
+When [creating a libp2p node](./API.md#create), the modules needed should be specified as follows:
+
+```js
+const modules = {
+  transport: [],
+  streamMuxer: [],
+  connEncryption: [],
+  contentRouting: [],
+  peerRouting: [],
+  peerDiscovery: [],
+  dht: dhtImplementation,
+  pubsub: pubsubImplementation
+}
+```
+
+Moreover, the majority of the modules can be customized via option parameters. This way, it is also possible to provide this options through a `config` object. This config object should have the property name of each building block to configure, the same way as the modules specification.
+
+Besides the `modules` and `config`, libp2p allows other internal options and configurations:
+- `datastore`: an instance of [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore/) modules.
+  - This is used in modules such as the DHT. If it is not provided, `js-libp2p` will use an in memory datastore.
+- `peerInfo`: a previously created instance of [libp2p/js-peer-info](https://github.com/libp2p/js-peer-info).
+  - This is particularly useful if you want to reuse the same `peer-id`, as well as for modules like `libp2p-delegated-content-routing`, which need a `peer-id` in their instantiation.
+
+### Examples
+
+#### Basic setup
+
+```js
+// Creating a libp2p node with:
+//   transport: websockets + tcp
+//   stream-muxing: mplex
+//   crypto-channel: secio
+//   discovery: multicast-dns
+//   dht: kad-dht
+//   pubsub: gossipsub
+
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const WS = require('libp2p-websockets')
+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 node = await Libp2p.create({
+  modules: {
+    transport: [
+      TCP,
+      new WS() // It can take instances too!
+    ],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO],
+    peerDiscovery: [MulticastDNS],
+    dht: DHT,
+    pubsub: GossipSub
+  }
+})
+```
+
+#### Customizing Peer Discovery
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const MulticastDNS = require('libp2p-mdns')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO],
+    peerDiscovery: [MulticastDNS]
+  },
+  config: {
+    peerDiscovery: {
+      autoDial: true,             // Auto connect to discovered peers (limited by ConnectionManager minPeers)
+      // The `tag` property will be searched when creating the instance of your Peer Discovery service.
+      // The associated object, will be passed to the service when it is instantiated.
+      [MulticastDNS.tag]: {
+        interval: 1000,
+        enabled: true
+      }
+      // .. other discovery module options.
+    }
+  }
+})
+```
+
+#### Setup webrtc transport and discovery
+
+```js
+
+const Libp2p = require('libp2p')
+const WS = require('libp2p-websockets')
+const WebRTCStar = require('libp2p-webrtc-star')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [
+      WS,
+      WebRTCStar
+    ],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO],
+  },
+  config: {
+    peerDiscovery: {
+      webRTCStar: {
+        enabled: true
+      }
+    }
+  }
+})
+```
+
+#### Customizing Pubsub
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const GossipSub = require('libp2p-gossipsub')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO],
+    pubsub: GossipSub
+  },
+  config: {
+    pubsub: {                     // The pubsub options (and defaults) can be found in the pubsub router documentation
+      enabled: true,
+      emitSelf: true,             // whether the node should emit to self on publish
+      signMessages: true,         // if messages should be signed
+      strictSigning: true         // if message signing should be required
+    }
+  }
+})
+```
+
+#### Customizing DHT
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const DHT = require('libp2p-kad-dht')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO],
+    dht: DHT
+  },
+  config: {
+    dht: {                        // The DHT options (and defaults) can be found in its documentation
+      kBucketSize: 20,
+      enabled: true,
+      randomWalk: {
+        enabled: true,            // Allows to disable discovery (enabled by default)
+        interval: 300e3,
+        timeout: 10e3
+      }
+    }
+  }
+})
+```
+
+#### Setup with Content and Peer Routing
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const DelegatedPeerRouter = require('libp2p-delegated-peer-routing')
+const DelegatedContentRouter = require('libp2p-delegated-content-routing')
+const PeerInfo = require('peer-info')
+
+// create a peerInfo
+const peerInfo = await PeerInfo.create()
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO],
+    contentRouting: [
+      new DelegatedContentRouter(peerInfo.id)
+    ],
+    peerRouting: [
+      new DelegatedPeerRouter()
+    ],
+  },
+  peerInfo
+})
+```
+
+#### Setup with Relay
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO]
+  },
+  config: {
+    relay: {                   // Circuit Relay options (this config is part of libp2p core configurations)
+      enabled: true,           // Allows you to dial and accept relayed connections. Does not make you a relay.
+      hop: {
+        enabled: true,         // Allows you to be a relay for other peers
+        active: true           // You will attempt to dial destination peers if you are not connected to them
+      }
+    }
+  }
+})
+```
+
+#### Configuring Dialing
+
+Dialing in libp2p can be configured to limit the rate of dialing, and how long dials are allowed to take. The below configuration example shows the default values for the dialer.
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO]
+  },
+  dialer: {
+    maxParallelDials: 100, // How many multiaddrs we can dial in parallel
+    maxDialsPerPeer: 4, // How many multiaddrs we can dial per peer, in parallel
+    dialTimeout: 30e3 // 30 second dial timeout per peer
+  }
+```
+
+#### Configuring Connection Manager
+
+The Connection Manager prunes Connections in libp2p whenever certain limits are exceeded. If Metrics are enabled, you can also configure the Connection Manager to monitor the bandwidth of libp2p and prune connections as needed. You can read more about what Connection Manager does at [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md). The configuration values below show the defaults for Connection Manager. See [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md#options) for a full description of the parameters.
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO]
+  },
+  connectionManager: {
+    maxConnections: Infinity,
+    minConnections: 0,
+    pollInterval: 2000,
+    defaultPeerValue: 1,
+    // The below values will only be taken into account when Metrics are enabled
+    maxData: Infinity,
+    maxSentData: Infinity,
+    maxReceivedData: Infinity,
+    maxEventLoopDelay: Infinity,
+    movingAverageInterval: 60000
+  }
+})
+```
+
+#### Configuring Metrics
+
+Metrics are disabled in libp2p by default. You can enable and configure them as follows. Aside from enabled being `false` by default, the configuration options listed here are the current defaults.
+
+```js
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [TCP],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO]
+  },
+  metrics: {
+    enabled: true,
+    computeThrottleMaxQueueSize: 1000,  // How many messages a stat will queue before processing
+    computeThrottleTimeout: 2000,       // Time in milliseconds a stat will wait, after the last item was added, before processing
+    movingAverageIntervals: [           // The moving averages that will be computed
+      60 * 1000, // 1 minute
+      5 * 60 * 1000, // 5 minutes
+      15 * 60 * 1000 // 15 minutes
+    ],
+    maxOldPeersRetention: 50            // How many disconnected peers we will retain stats for
+  }
+})
+```
+
+#### Customizing Transports
+
+Some Transports can be passed additional options when they are created. For example, `libp2p-webrtc-star` accepts an optional, custom `wrtc` implementation. In addition to libp2p passing itself and an `Upgrader` to handle connection upgrading, libp2p will also pass the options, if they are provided, from `config.transport`.
+
+```js
+const Libp2p = require('libp2p')
+const WebRTCStar = require('libp2p-webrtc-star')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const wrtc = require('wrtc')
+
+const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
+const node = await Libp2p.create({
+  modules: {
+    transport: [WebRTCStar],
+    streamMuxer: [MPLEX],
+    connEncryption: [SECIO]
+  },
+  config: {
+    transport: {
+      [transportKey]: {
+        wrtc // You can use `wrtc` when running in Node.js
+      }
+    }
+  }
+})
+```
+
+## Configuration examples
+
+As libp2p is designed to be a modular networking library, its usage will vary based on individual project needs. We've included links to some existing project configurations for your reference, in case you wish to replicate their configuration:
+
+
+- [libp2p-ipfs-nodejs](https://github.com/ipfs/js-ipfs/tree/master/src/core/runtime/libp2p-nodejs.js) - libp2p configuration used by js-ipfs when running in Node.js
+- [libp2p-ipfs-browser](https://github.com/ipfs/js-ipfs/tree/master/src/core/runtime/libp2p-browser.js) - libp2p configuration used by js-ipfs when running in a Browser (that supports WebRTC)
+
+If you have developed a project using `js-libp2p`, please consider submitting your configuration to this list so that it can be found easily by other users.
+
+The [examples](../examples) are also a good source of help for finding a configuration that suits your needs.

doc/CONNECTION_MANAGER.md

@@ -0,0 +1,20 @@
+# Connection Manager
+
+The Connection Manager works with the Registrar to keep connections across libp2p within acceptable ranges, which can be configured. By default Connection Manager will monitor:
+- The total number of open connections
+- The latency/delay of the event loop
+
+If Metrics are enabled for libp2p, see [./CONFIGURATION.md#configuring-metrics](./CONFIGURATION.md#configuring-metrics) on how to configure metrics, the Connection Manager can be used to prune connections when certain limits are exceeded.
+
+The following is a list of available options for setting limits for the Connection Manager to enforce.
+
+## Options
+- `maxConnections`: the maximum number of connections libp2p is willing to have before it starts disconnecting. Defaults to `Infinity`
+- `minConnections`: the minimum number of connections below which libp2p not activate preemptive disconnections. Defaults to `0`.
+- `maxData`: sets the maximum data — in bytes per second -  (sent and received) this node is willing to endure before it starts disconnecting peers. Defaults to `Infinity`.
+- `maxSentData`: sets the maximum sent data — in bytes per second -  this node is willing to endure before it starts disconnecting peers. Defaults to `Infinity`.
+- `maxReceivedData`: sets the maximum received data — in bytes per second -  this node is willing to endure before it starts disconnecting peers. Defaults to `Infinity`.
+- `maxEventLoopDelay`: sets the maximum event loop delay (measured in milliseconds) this node is willing to endure before it starts disconnecting peers. Defaults to `Infinity`.
+- `pollInterval`: sets the poll interval (in milliseconds) for assessing the current state and determining if this peer needs to force a disconnect. Defaults to `2000` (2 seconds).
+- `movingAverageInterval`: the interval used to calculate moving averages (in milliseconds). Defaults to `60000` (1 minute). This must be an available interval configured in `Metrics`
+- `defaultPeerValue`: number between 0 and 1. Defaults to 1.

doc/DIALER.md

@@ -0,0 +1,32 @@
+# js-libp2p Dialer
+
+**Synopsis**
+* Parallel dials to the same peer will yield the same connection/error when the first dial settles.
+* All Dial Requests in js-libp2p must request a token(s) from the Dialer.
+  * The number of tokens requested should be between 1 and the MAX_PER_PEER_DIALS max set in the Dialer.
+  * If the number of available tokens is less than requested, the Dialer may return less than requested.
+* The number of tokens a DialRequest obtains reflects the maximum number of parallel Multiaddr Dials it can make.
+* If no tokens are available a DialRequest should immediately end and throw.
+* As tokens are limited, DialRequests should be given a prioritized list of Multiaddrs to minimize the potential request time.
+* Once a Multiaddr Dial has succeeded, all pending dials in that Dial Request should be aborted.
+* If DIAL_TIMEOUT time has elapsed before any one Multiaddr Dial succeeds, all remaining dials in the DialRequest should be aborted.
+* When a Multiaddr Dial is settled, if there are no more addresses to dial, its token should be released back to the dialer.
+* Once the DialRequest is settled, any remaining tokens should be released to the dialer.
+
+## Multiaddr Confidence
+
+An effective dialing system should involve the inclusion of a Confidence system for Multiaddrs. This enables ranking of Multiaddrs so that a prioritized list can be passed to DialRequests to maximize usage of Dialer Tokens, and minimize connection times.
+
+**Not Yet Implemented**: This system will be designed and implemented in a future update.
+
+## Notes
+
+* A DialRequest gets a set of tokens from the Dialer, up to the MAX_PER_PEER_DIALS max.
+* A DialRequest SHOULD fail if no dial tokens are available. The DialRequest MAY proceed without tokens, but this should be reserved for High Priority actions and should be rare.
+* A DialRequest MUST NOT request more tokens than it has addresses to dial. Example: If the MAX_PER_PEER_DIALS is 4 and a DialRequest has 1 address, it should only request 1 token.
+* A DialRequest SHOULD execute parallel dials for each of its addresses up the total number of tokens it has.
+* On a successful dial, the DialRequest MUST abort any other in progress dials, return the successful connection and release all tokens.
+* A new DialRequest SHOULD be given a descending list of prioritized Multiaddrs, based on their confidence. Having higher confidence Multiaddrs first can help minimize the time a DialRequest is active.
+* A failed dial to a Multiaddr SHOULD add that Multiaddr to a temporary denyList.
+* A failed dial to a Multiaddr SHOULD lower the confidence of that Multiaddr.
+* A successful dial to a Multiaddr SHOULD increase the confidence of that Multiaddr.

doc/GETTING_STARTED.md

@@ -0,0 +1,247 @@
+# Getting Started
+
+Welcome to libp2p! This guide will walk you through setting up a fully functional libp2p node 🚀
+
+- [Getting Started](#getting-started)
+  - [Install](#install)
+  - [Configuring libp2p](#configuring-libp2p)
+    - [Basic setup](#basic-setup)
+      - [Transports](#transports)
+      - [Connection Encryption](#connection-encryption)
+      - [Multiplexing](#multiplexing)
+      - [Running Libp2p](#running-libp2p)
+    - [Custom setup](#custom-setup)
+      - [Peer Discovery](#peer-discovery)
+      - [Pubsub](#pubsub)
+  - [What is next](#what-is-next)
+
+## Install
+
+The first step is to install libp2p in your project:
+
+```sh
+npm install libp2p
+```
+
+## Configuring libp2p
+
+If you're new to libp2p, we recommend configuring your node in stages, as this can make troubleshooting configuration issues much easier. In this guide, we'll do just that. If you're more experienced with libp2p, you may wish to jump to the [Configuration readme](./CONFIGURATION.md).
+
+### Basic setup
+
+Now that we have libp2p installed, let's configure the minimum needed to get your node running. The only modules libp2p requires are a [**Transport**][transport] and [**Crypto**][crypto] module. However, we recommend that a basic setup should also have a [**Stream Multiplexer**](streamMuxer) configured, which we will explain shortly. Let's start by setting up a Transport.
+
+#### Transports
+
+Libp2p uses Transports to establish connections between peers over the network. Transports are the components responsible for performing the actual exchange of data between libp2p nodes. You can configure any number of Transports, but you only need 1 to start with. Supporting more Transports will improve the ability of your node to speak to a larger number of nodes on the network, as matching Transports are required for two nodes to communicate with one another.
+
+You should select Transports according to the runtime of your application; Node.js or the browser. You can see a list of some of the available Transports in the [configuration readme](./CONFIGURATION.md#transport). For this guide let's install `libp2p-websockets`, as it can be used in both Node.js and the browser.
+
+Start by installing `libp2p-websockets`:
+
+```sh
+npm install libp2p-websockets
+```
+
+Now that we have the module installed, let's configure libp2p to use the Transport. We'll use the [`Libp2p.create`](./API.md#create) method, which takes a single configuration object as its only parameter. We can add the Transport by passing it into the `modules.transport` array:
+
+```js
+const Libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [WebSockets]
+  }
+})
+```
+
+There are multiple libp2p transports available, you should evaluate the needs of your application and select the Transport(s) that best suit your requirements. You can add as many transports as you like to `modules.transport` in order to establish connections with as many peers as possible.
+
+<details><summary>Read More</summary>
+If you want to know more about libp2p transports, you should read the following content:
+
+- https://docs.libp2p.io/concepts/transport
+- https://github.com/libp2p/specs/tree/master/connections
+</details>
+
+#### Connection Encryption
+
+Encryption is an important part of communicating on the libp2p network. Every connection must be encrypted to help ensure security for everyone. As such, Connection Encryption (Crypto) is a required component of libp2p.
+
+There are a growing number of Crypto modules being developed for libp2p. As those are released they will be tracked in the [Connection Encryption section of the configuration readme](./CONFIGURATION.md#connection-encryption). For now, we are going to configure our node to use the `libp2p-secio` module, which is widely supported across the various libp2p implementations.
+
+```sh
+npm install libp2p-secio
+```
+
+With `libp2p-secio` installed, we can add it to our existing configuration by importing it and adding it to the `modules.connEncryption` array:
+
+```js
+const Libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+const SECIO = require('libp2p-secio')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [WebSockets],
+    connEncryption: [SECIO]
+  }
+})
+```
+
+<details><summary>Read More</summary>
+If you want to know more about libp2p connection encryption, you should read the following content:
+
+- https://docs.libp2p.io/concepts/secure-comms
+- https://github.com/libp2p/specs/tree/master/connections
+</details>
+
+#### Multiplexing
+
+While multiplexers are not strictly required, they are highly recommended as they improve the effectiveness and efficiency of connections for the various protocols libp2p runs. Adding a multiplexer to your configuration will allow libp2p to run several of its internal protocols, like Identify, as well as allow your application to easily run any number of protocols over a single connection.
+
+Looking at the [available stream multiplexing](./CONFIGURATION.md#stream-multiplexing) modules, js-libp2p currently only supports `libp2p-mplex`, so we will use that here. Bear in mind that future libp2p Transports might have `multiplexing` capabilities already built-in (such as `QUIC`).
+
+You can install `libp2p-mplex` and add it to your libp2p node as follows in the next example.
+
+```sh
+npm install libp2p-mplex
+```
+
+```js
+const Libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+const SECIO = require('libp2p-secio')
+const MPLEX = require('libp2p-mplex')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [WebSockets],
+    connEncryption: [SECIO],
+    streamMuxer: [MPLEX]
+  }
+})
+```
+
+<details><summary>Read More</summary>
+If you want to know more about libp2p stream multiplexing, you should read the following content:
+
+- https://docs.libp2p.io/concepts/stream-multiplexing
+- https://github.com/libp2p/specs/tree/master/connections
+- https://github.com/libp2p/specs/tree/master/mplex
+</details>
+
+#### Running Libp2p
+
+Now that you have configured a [**Transport**][transport], [**Crypto**][crypto] and [**Stream Multiplexer**](streamMuxer) module, you can start your libp2p node. We can start and stop libp2p using the [`libp2p.start()`](./API.md#start) and [`libp2p.stop()`](./API.md#stop) methods.
+
+```js
+const Libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+const SECIO = require('libp2p-secio')
+const MPLEX = require('libp2p-mplex')
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [WebSockets],
+    connEncryption: [SECIO],
+    streamMuxer: [MPLEX]
+  }
+})
+
+// start libp2p
+await node.start()
+console.log('libp2p has started')
+
+// stop libp2p
+await node.stop()
+console.log('libp2p has stopped')
+```
+
+### Custom setup
+
+Once your libp2p node is running, it is time to get it connected to the public network. We can do this via peer discovery.
+
+#### Peer Discovery
+
+Peer discovery is an important part of creating a well connected libp2p node. A static list of peers will often be used to join the network, but it's useful to couple other discovery mechanisms to ensure you're able to discover other peers that are important to your application.
+
+For each discovered peer libp2p will emit a `peer:discovery` event which includes metadata about that peer. You can read the [Events](./API.md#events) in the API doc to learn more.
+
+Looking at the [available peer discovery](./CONFIGURATION.md#peer-discovery) protocols, there are several options to be considered:
+- If you already know the addresses of some other network peers, you should consider using `libp2p-bootstrap` as this is the easiest way of getting your peer into the network.
+- If it is likely that you will have other peers on your local network, `libp2p-mdns` is a must if you're node is not running in the browser. It allows peers to discover each other when on the same local network.
+- If your application is browser based you can use the `libp2p-webrtc-star` Transport, which includes a rendezvous based peer sharing service.
+- A random walk approach can be used via `libp2p-kad-dht`, to crawl the network and find new peers along the way.
+
+For this guide we will configure `libp2p-bootstrap` as this is useful for joining the public network.
+
+Let's install `libp2p-bootstrap`.
+
+```sh
+npm install libp2p-bootstrap
+```
+
+We can provide specific configurations for each protocol within a `config.peerDiscovery` property in the options as shown below.
+
+```js
+const Libp2p = require('libp2p')
+const WebSockets = require('libp2p-websockets')
+const SECIO = require('libp2p-secio')
+const MPLEX = require('libp2p-mplex')
+
+const Bootstrap = require('libp2p-bootstrap')
+
+// Known peers addresses
+const bootstrapMultiaddrs = [
+  '/dns4/ams-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
+  '/dns4/lon-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3'
+]
+
+const node = await Libp2p.create({
+  modules: {
+    transport: [WebSockets],
+    connEncryption: [SECIO],
+    streamMuxer: [MPLEX],
+    peerDiscovery: [Bootstrap]
+  },
+  config: {
+    peerDiscovery: {
+      autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minPeers)
+      // The `tag` property will be searched when creating the instance of your Peer Discovery service.
+      // The associated object, will be passed to the service when it is instantiated.
+      [Bootstrap.tag]: {
+        enabled: true,
+        list: bootstrapMultiaddrs // provide array of multiaddrs
+      }
+    }
+  }
+})
+
+node.on('peer:discovery', (peer) => {
+  console.log('Discovered %s', peer.id.toB58String()) // Log discovered peer
+})
+
+node.on('peer:connect', (peer) => {
+    console.log('Connected to %s', peer.id.toB58String()) // Log connected peer
+  })
+
+// start libp2p
+await node.start()
+```
+
+<details><summary>Read More</summary>
+If you want to know more about libp2p peer discovery, you should read the following content:
+
+- https://github.com/libp2p/specs/blob/master/discovery/mdns.md
+</details>
+
+## What is next
+
+There are a lot of other concepts within `libp2p`, that are not covered in this guide. For additional configuration options we recommend checking out the [Configuration Readme](./CONFIGURATION.md) and the [examples folder](../examples). If you have any problems getting started, or if anything isn't clear, please let us know by submitting an issue!
+
+
+[transport]: https://github.com/libp2p/js-interfaces/tree/master/src/transport
+[crypto]: https://github.com/libp2p/js-interfaces/tree/master/src/crypto
+[streamMuxer]: https://github.com/libp2p/js-interfaces/tree/master/src/stream-muxer

doc/METRICS.md

@@ -0,0 +1,28 @@
+# Bandwidth Metrics
+
+- Metrics gathering is optional, as there is a performance hit to using it.
+- Metrics do NOT currently contain OS level stats, only libp2p application level Metrics. For example, TCP messages (ACK, FIN, etc) are not accounted for.
+- See the [API](./API.md) for Metrics usage. Metrics in libp2p do not emit events, as such applications wishing to read Metrics will need to do so actively. This ensures that the system is not unnecessarily firing update notifications.
+
+## Tracking
+- When a transport hands off a connection for upgrading, Metrics are hooked up if enabled.
+- When a stream is created, Metrics will be tracked on that stream and associated to that streams protocol.
+- Tracked Metrics are associated to a specific peer, and count towards global bandwidth Metrics.
+
+### Metrics Processing
+- The main Metrics object consists of individual `Stats` objects
+- The following categories are tracked:
+  - Global stats; every byte in and out
+  - Peer stats; every byte in and out, per peer
+  - Protocol stats; every byte in and out, per protocol
+- When a message goes through Metrics:
+  - It is added to the global stat
+  - It is added to the stats for the remote peer
+  - It is added to the protocol stats if there is one
+- When data is pushed onto a `Stat` it is added to a queue
+  - The queue is processed at the earliest of either (configurable):
+    - every 2 seconds after the last item was added to the queue
+    - or once 1000 items have been queued
+  - When the queue is processed:
+    - The data length is added to either the `in` or `out` stat
+    - The moving averages is calculated since the last queue processing (based on most recently processed item timestamp)

doc/STREAMING_ITERABLES.md

@@ -0,0 +1,164 @@
+# Iterable Streams
+
+> This document is a guide on how to use Iterable Streams in Libp2p. As a part of the [refactor away from callbacks](https://github.com/ipfs/js-ipfs/issues/1670), we have also moved to using Iterable Streams instead of [pull-streams](https://pull-stream.github.io/). If there are missing usage guides you feel should be added, please submit a PR!
+
+## Table of Contents
+
+- [Iterable Streams](#iterable-streams)
+  - [Table of Contents](#table-of-contents)
+  - [Usage Guide](#usage-guide)
+    - [Transforming Bidirectional Data](#transforming-bidirectional-data)
+  - [Iterable Stream Types](#iterable-stream-types)
+    - [Source](#source)
+    - [Sink](#sink)
+    - [Transform](#transform)
+    - [Duplex](#duplex)
+  - [Iterable Modules](#iterable-modules)
+
+## Usage Guide
+
+### Transforming Bidirectional Data
+
+Sometimes you may need to wrap an existing duplex stream in order to perform incoming and outgoing [transforms](#transform) on data. This type of wrapping is commonly used in stream encryption/decryption. Using [it-pair][it-pair] and [it-pipe][it-pipe], we can do this rather easily, given an existing [duplex iterable](#duplex).
+
+```js
+const duplexPair = require('it-pair/duplex')
+const pipe = require('it-pipe')
+
+// Wrapper is what we will write and read from
+// This gives us two duplex iterables that are internally connected
+const [internal, external] = duplexPair()
+
+// Now we can pipe our wrapper to the existing duplex iterable
+pipe(
+  external, // The external half of the pair interacts with the existing duplex
+  outgoingTransform, // A transform iterable to send data through (ie: encrypting)
+  existingDuplex, // The original duplex iterable we are wrapping
+  incomingTransform, // A transform iterable to read data through (ie: decrypting)
+  external
+)
+
+// We can now read and write from the other half of our pair
+pipe(
+  ['some data'],
+  internal, // The internal half of the pair is what we will interact with to read/write data
+  async (source) => {
+    for await (const chunk of source) {
+      console.log('Data: %s', chunk.toString())
+      // > Data: some data
+    }
+  }
+)
+```
+
+## Iterable Stream Types
+
+These types are pulled from [@alanshaw's gist](https://gist.github.com/alanshaw/591dc7dd54e4f99338a347ef568d6ee9) on streaming iterables.
+
+### Source
+
+A "source" is something that can be consumed. It is an iterable object.
+
+```js
+const ints = {
+  [Symbol.asyncIterator] () {
+    let i = 0
+    return {
+      async next () {
+        return { done: false, value: i++ }
+      }
+    }
+  }
+}
+
+// or, more succinctly using a generator and for/await:
+
+const ints = (async function * () {
+  let i = 0
+  while (true) yield i++
+})()
+```
+
+### Sink
+
+A "sink" is something that consumes (or drains) a source. It is a function that takes a source and iterates over it. It optionally returns a value.
+
+```js
+const logger = async source => {
+  const it = source[Symbol.asyncIterator]()
+  while (true) {
+    const { done, value } = await it.next()
+    if (done) break
+    console.log(value) // prints 0, 1, 2, 3...
+  }
+}
+
+// or, more succinctly using a generator and for/await:
+
+const logger = async source => {
+  for await (const chunk of source) {
+    console.log(chunk) // prints 0, 1, 2, 3...
+  }
+}
+```
+
+### Transform
+
+A "transform" is both a sink _and_ a source where the values it consumes and the values that can be consumed from it are connected in some way. It is a function that takes a source and returns a source.
+
+```js
+const doubler = source => {
+  return {
+    [Symbol.asyncIterator] () {
+      const it = source[Symbol.asyncIterator]()
+      return {
+        async next () {
+          const { done, value } = await it.next()
+          if (done) return { done }
+          return { done, value: value * 2 }
+        }
+        return () {
+          return it.return && it.return()
+        }
+      }
+    }
+  }
+}
+
+// or, more succinctly using a generator and for/await:
+
+const doubler = source => (async function * () {
+  for await (const chunk of source) {
+    yield chunk * 2
+  }
+})()
+```
+
+### Duplex
+
+A "duplex" is similar to a transform but the values it consumes are not necessarily connected to the values that can be consumed from it. It is an object with two properties, `sink` and `source`.
+
+```js
+const duplex = {
+  sink: async source => {/* ... */},
+  source: { [Symbol.asyncIterator] () {/* ... */} }
+}
+```
+
+## Iterable Modules
+
+- [it-handshake][it-handshake] Handshakes for binary protocols with iterable streams.
+- [it-length-prefixed][it-length-prefixed] Streaming length prefixed buffers with async iterables.
+- [it-pair][it-pair] Paired streams that are internally connected.
+- [it-pipe][it-pipe] Create a pipeline of iterables. Works with duplex streams.
+- [it-pushable][it-pushable] An iterable that you can push values into.
+- [it-reader][it-reader] Read an exact number of bytes from a binary, async iterable.
+- [streaming-iterables][streaming-iterables] A Swiss army knife for async iterables.
+
+[it-handshake]: https://github.com/jacobheun/it-handshake
+[it-length-prefixed]: https://github.com/alanshaw/it-length-prefixed
+[it-pair]: https://github.com/alanshaw/it-pair
+[it-pipe]: https://github.com/alanshaw/it-pipe
+[it-pushable]: https://github.com/alanshaw/it-pushable
+[it-reader]: https://github.com/alanshaw/it-reader
+[streaming-iterables]: https://github.com/bustle/streaming-iterables

doc/migrations/v0.26-v0.27.md

@@ -0,0 +1,178 @@
+# Migrating to the new API
+
+A migration guide for refactoring your application code from libp2p v0.26.x to v0.27.0.
+
+## Table of Contents
+
+- [Migrating from callbacks](#migrating-from-callbacks)
+- [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables)
+- [Sample API Migrations](#sample-api-migrations)
+  - [Registering Protocol Handlers](#registering-protocol-handlers)
+  - [Dialing and Sending Data](#dialing-and-sending-data)
+  - [Checking if a peer is connected](#checking-if-a-peer-is-connected)
+  - [Pinging another peer](#pinging-another-peer)
+  - [Pubsub](#pubsub)
+    - [Getting subscribers](#getting-subscribers)
+    - [Getting subscribed topics](#getting-subscribed-topics)
+
+## Migrating from callbacks
+
+Callbacks are no longer supported in the libp2p API, as the API has now fully moved to async / await. You can see a full list of the available methods in the [API readme][api]
+
+**Before**
+```js
+libp2p.start((err) => {
+  if (err) throw err
+  console.log('libp2p started')
+})
+```
+
+**After**
+```js
+await libp2p.start()
+console.log('libp2p started')
+```
+
+## Pull Streams to Streaming Iterables
+
+The libp2p API no longer supports Pull Streams and has migrated to [Streaming Iterables][streaming_iterable]. If you would like to continue using Pull Streams in your application code, or need additional time to migrate your code base, you can leverage the conversion modules [async-iterator-to-pull-stream](https://github.com/alanshaw/async-iterator-to-pull-stream) and [pull-stream-to-async-iterator](https://github.com/alanshaw/pull-stream-to-async-iterator).
+
+For a growing list of async iterator modules, you should follow the [it-awesome repo][it_awesome].
+
+## Sample API Migrations
+
+### Registering Protocol Handlers
+
+Protocol registration is very similar to how it previously was, however, the handler now takes a single parameter containing the incoming stream and its protocol. Additionally, you can now pass an array of protocols to `.handle`, but a single string is still supported.
+
+**Before**
+```js
+const pull = require('pull-stream')
+libp2p.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
+```
+
+**After**
+```js
+const pipe = require('it-pipe')
+libp2p.handle(['/echo/1.0.0'], ({ protocol, stream }) => pipe(stream, stream))
+```
+
+### Dialing and Sending Data
+
+`dialProtocol` no longer takes a callback, and will now return a [Streaming Iterable][streaming_iterable] and the protocol that was successfully negotiated. The new stream can be used with async iterator modules, see [it-awesome][it_awesome], instead of pull streams.
+
+**Before**
+```js
+const pull = require('pull-stream')
+libp2p.dialProtocol(peerInfo, '/echo/1.0.0', (err, conn) => {
+  if (err) { throw err }
+  pull(
+    pull.values(['hey']),
+    conn,
+    pull.drain((data) => {
+      console.log('received echo:', data.toString())
+    }, (err) => {
+      if (err) { throw err }
+    })
+  )
+})
+```
+
+**After**
+```js
+const pipe = require('it-pipe')
+const { protocol, stream } = await libp2p.dialProtocol(peerInfo, '/echo/1.0.0')
+await pipe(
+  ['hey'],
+  stream,
+  async function (source) {
+    for await (const data of source) {
+      console.log('received echo:', data.toString())
+    }
+  }
+)
+```
+
+### Checking if a peer is connected
+
+`peerInfo.isConnected` has been deprecated. libp2p now tracks all connections centrally and will no longer update the state of `peerInfo.isConnected`. Consumers should switch to using `libp2p.registrar.getConnection(peerInfo)`, which will return an open connection to that peer if one exists.
+
+**Before**
+```js
+if (peerInfo.isConnected()) {
+  // ...do something if connected
+}
+```
+
+**After**
+```js
+const connection = libp2p.registrar.getConnection(peerInfo)
+if (connection) {
+  // ...do something if connected
+}
+```
+
+### Pinging another peer
+
+`libp2p.ping` will no longer callback with a `Ping` event emitter. The internal logic has been simplified to give more flexibility to the API. `libp2p.ping` will now execute a single ping and return the latency.
+
+**Before**
+```js
+libp2p.ping(peerInfo, (err, ping) => {
+  if (err) throw err
+  ping.once('ping', (latency) => {
+    console.log('Latency is %s ms', latency)
+    ping.stop()
+  })
+
+  ping.start()
+})
+```
+
+**After**
+```js
+const latency = await libp2p.ping(peerInfo)
+console.log('Latency is %s ms', latency)
+```
+
+### Pubsub
+
+#### Getting subscribers
+
+`libp2p.pubsub.peers()` is now `libp2p.pubsub.getSubscribers()` and is no longer an asynchronous action.
+
+**Before**
+```js
+libp2p.pubsub.peers(topic, (err, subscribers) => {
+  if (err) throw err
+  console.log('Subscribers:', subscribers)
+})
+```
+
+**After**
+```js
+const subscribers = libp2p.pubsub.getSubscribers(topic)
+console.log('Subscribers:', subscribers)
+```
+
+#### Getting subscribed topics
+
+`libp2p.pubsub.ls()` is now `libp2p.pubsub.getTopics()` and is no longer an asynchronous action.
+
+**Before**
+```js
+libp2p.pubsub.ls((err, topics) => {
+  if (err) throw err
+  console.log('Topics:', topics)
+})
+```
+
+**After**
+```js
+const topics = libp2p.pubsub.getTopics()
+console.log('Topics:', topics)
+```
+
+[api]: ../API.md
+[it_awesome]: https://github.com/alanshaw/it-awesome
+[streaming_iterable]: ../STREAMING_ITERABLES.md

examples/README.md

@@ -1,8 +1,8 @@
 # `js-libp2p` Examples and Tutorials
 
-In this folder, you can find a variety of examples to help you get started in using js-libp2p, in Node.js and in the Browser. Every example as a specific purpose and some of each incorporate a full tutorial that you can follow through, helping you expand your knowledge about libp2p and p2p networks in general.
+In this folder, you can find a variety of examples to help you get started in using js-libp2p, in Node.js and in the Browser. Every example has a specific purpose and some incorporate a full tutorial that you can follow through, helping you expand your knowledge about libp2p and p2p networks in general.
 
-Let us know if you find any issue or if you want to contribute and add a new tutorial, feel welcome to submit a PR, thank you!
+Let us know if you find any issues, or if you want to contribute and add a new tutorial, feel free to submit a PR, thank you!
 
 ## Understanding how libp2p works
 
@@ -22,3 +22,5 @@ Let us know if you find any issue or if you want to contribute and add a new tut
 - Running libp2p in the Electron (future)
 - [The standard echo net example with libp2p](./echo)
 - [A simple chat app with libp2p](./chat)
+
+For go-libp2p examples, check out https://github.com/libp2p/go-libp2p-examples#examples-and-tutorials

examples/chat/src/dialer.js

@@ -4,76 +4,44 @@
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
 const Node = require('./libp2p-bundle')
-const pull = require('pull-stream')
-const async = require('async')
-const Pushable = require('pull-pushable')
-const p = Pushable()
-let idListener
+const { stdinToStream, streamToConsole } = require('./stream')
 
-async.parallel([
-  (callback) => {
-    PeerId.createFromJSON(require('./peer-id-dialer'), (err, idDialer) => {
-      if (err) {
-        throw err
-      }
-      callback(null, idDialer)
-    })
-  },
-  (callback) => {
-    PeerId.createFromJSON(require('./peer-id-listener'), (err, idListener) => {
-      if (err) {
-        throw err
-      }
-      callback(null, idListener)
-    })
-  }
-], (err, ids) => {
-  if (err) throw err
-  const peerDialer = new PeerInfo(ids[0])
+async function run() {
+  const [idDialer, idListener] = await Promise.all([
+    PeerId.createFromJSON(require('./peer-id-dialer')),
+    PeerId.createFromJSON(require('./peer-id-listener'))
+  ])
+
+  // Create a new libp2p node on localhost with a randomly chosen port
+  const peerDialer = new PeerInfo(idDialer)
   peerDialer.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
   const nodeDialer = new Node({
     peerInfo: peerDialer
   })
 
-  const peerListener = new PeerInfo(ids[1])
-  idListener = ids[1]
+  // Create a PeerInfo with the listening peer's address
+  const peerListener = new PeerInfo(idListener)
   peerListener.multiaddrs.add('/ip4/127.0.0.1/tcp/10333')
-  nodeDialer.start((err) => {
-    if (err) {
-      throw err
-    }
 
-    console.log('Dialer ready, listening on:')
+  // Start the libp2p host
+  await nodeDialer.start()
 
-    peerListener.multiaddrs.forEach((ma) => {
-      console.log(ma.toString() + '/p2p/' + idListener.toB58String())
-    })
-
-    nodeDialer.dialProtocol(peerListener, '/chat/1.0.0', (err, conn) => {
-      if (err) {
-        throw err
-      }
-      console.log('nodeA dialed to nodeB on protocol: /chat/1.0.0')
-      console.log('Type a message and see what happens')
-      // Write operation. Data sent as a buffer
-      pull(
-        p,
-        conn
-      )
-      // Sink, data converted from buffer to utf8 string
-      pull(
-        conn,
-        pull.map((data) => {
-          return data.toString('utf8').replace('\n', '')
-        }),
-        pull.drain(console.log)
-      )
-
-      process.stdin.setEncoding('utf8')
-      process.openStdin().on('data', (chunk) => {
-        var data = chunk.toString()
-        p.push(data)
-      })
-    })
+  // Output this node's address
+  console.log('Dialer ready, listening on:')
+  peerListener.multiaddrs.forEach((ma) => {
+    console.log(ma.toString() + '/p2p/' + idListener.toB58String())
   })
-})
+
+  // Dial to the remote peer (the "listener")
+  const { stream } = await nodeDialer.dialProtocol(peerListener, '/chat/1.0.0')
+
+  console.log('Dialer dialed to listener on protocol: /chat/1.0.0')
+  console.log('Type a message and see what happens')
+
+  // Send stdin to the stream
+  stdinToStream(stream)
+  // Read the stream and output to console
+  streamToConsole(stream)
+}
+
+run()

examples/chat/src/libp2p-bundle.js

@@ -1,41 +1,12 @@
 'use strict'
 
 const TCP = require('libp2p-tcp')
-const MulticastDNS = require('libp2p-mdns')
 const WS = require('libp2p-websockets')
-const Bootstrap = require('libp2p-bootstrap')
-const spdy = require('libp2p-spdy')
-const KadDHT = require('libp2p-kad-dht')
 const mplex = require('libp2p-mplex')
 const secio = require('libp2p-secio')
 const defaultsDeep = require('@nodeutils/defaults-deep')
 const libp2p = require('../../..')
 
-function mapMuxers (list) {
-  return list.map((pref) => {
-    if (typeof pref !== 'string') {
-      return pref
-    }
-    switch (pref.trim().toLowerCase()) {
-      case 'spdy': return spdy
-      case 'mplex': return mplex
-      default:
-        throw new Error(pref + ' muxer not available')
-    }
-  })
-}
-
-function getMuxers (muxers) {
-  const muxerPrefs = process.env.LIBP2P_MUXER
-  if (muxerPrefs && !muxers) {
-    return mapMuxers(muxerPrefs.split(','))
-  } else if (muxers) {
-    return mapMuxers(muxers)
-  } else {
-    return [mplex, spdy]
-  }
-}
-
 class Node extends libp2p {
   constructor (_options) {
     const defaults = {
@@ -44,29 +15,8 @@ class Node extends libp2p {
           TCP,
           WS
         ],
-        streamMuxer: getMuxers(_options.muxer),
-        connEncryption: [ secio ],
-        peerDiscovery: [
-          MulticastDNS,
-          Bootstrap
-        ],
-        dht: KadDHT
-      },
-      config: {
-        peerDiscovery: {
-          mdns: {
-            interval: 10000,
-            enabled: false
-          },
-          bootstrap: {
-            interval: 10000,
-            enabled: false,
-            list: _options.bootstrapList
-          }
-        },
-        dht: {
-          kBucketSize: 20
-        }
+        streamMuxer: [ mplex ],
+        connEncryption: [ secio ]
       }
     }
 

examples/chat/src/listener.js

@@ -4,53 +4,38 @@
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
 const Node = require('./libp2p-bundle.js')
-const pull = require('pull-stream')
-const Pushable = require('pull-pushable')
-const p = Pushable()
+const { stdinToStream, streamToConsole } = require('./stream')
 
-PeerId.createFromJSON(require('./peer-id-listener'), (err, idListener) => {
-  if (err) {
-    throw err
-  }
+async function run() {
+  // Create a new libp2p node with the given multi-address
+  const idListener = await PeerId.createFromJSON(require('./peer-id-listener'))
   const peerListener = new PeerInfo(idListener)
   peerListener.multiaddrs.add('/ip4/0.0.0.0/tcp/10333')
   const nodeListener = new Node({
     peerInfo: peerListener
   })
 
-  nodeListener.start((err) => {
-    if (err) {
-      throw err
-    }
-
-    nodeListener.on('peer:connect', (peerInfo) => {
-      console.log(peerInfo.id.toB58String())
-    })
-
-    nodeListener.handle('/chat/1.0.0', (protocol, conn) => {
-      pull(
-        p,
-        conn
-      )
-
-      pull(
-        conn,
-        pull.map((data) => {
-          return data.toString('utf8').replace('\n', '')
-        }),
-        pull.drain(console.log)
-      )
-
-      process.stdin.setEncoding('utf8')
-      process.openStdin().on('data', (chunk) => {
-        var data = chunk.toString()
-        p.push(data)
-      })
-    })
-
-    console.log('Listener ready, listening on:')
-    peerListener.multiaddrs.forEach((ma) => {
-      console.log(ma.toString() + '/p2p/' + idListener.toB58String())
-    })
+  // Log a message when a remote peer connects to us
+  nodeListener.on('peer:connect', (peerInfo) => {
+    console.log(peerInfo.id.toB58String())
   })
-})
+
+  // Handle messages for the protocol
+  await nodeListener.handle('/chat/1.0.0', async ({ stream }) => {
+    // Send stdin to the stream
+    stdinToStream(stream)
+    // Read the stream and output to console
+    streamToConsole(stream)
+  })
+
+  // Start listening
+  await nodeListener.start()
+
+  // Output listen addresses to the console
+  console.log('Listener ready, listening on:')
+  peerListener.multiaddrs.forEach((ma) => {
+    console.log(ma.toString() + '/p2p/' + idListener.toB58String())
+  })
+}
+
+run()

examples/chat/src/stream.js

@@ -0,0 +1,40 @@
+'use strict'
+/* eslint-disable no-console */
+
+const pipe = require('it-pipe')
+const lp = require('it-length-prefixed')
+
+function stdinToStream(stream) {
+  // Read utf-8 from stdin
+  process.stdin.setEncoding('utf8')
+  pipe(
+    // Read from stdin (the source)
+    process.stdin,
+    // Encode with length prefix (so receiving side knows how much data is coming)
+    lp.encode(),
+    // Write to the stream (the sink)
+    stream.sink
+  )
+}
+
+function streamToConsole(stream) {
+  pipe(
+    // Read from the stream (the source)
+    stream.source,
+    // Decode length-prefixed data
+    lp.decode(),
+    // Sink function
+    async function (source) {
+      // For each chunk of data
+      for await (const msg of source) {
+        // Output the data as a utf8 string
+        console.log('> ' + msg.toString('utf8').replace('\n', ''))
+      }
+    }
+  )
+}
+
+module.exports = {
+  stdinToStream,
+  streamToConsole
+}

examples/delegated-routing/src/App.js

@@ -44,7 +44,7 @@ class App extends Component {
       isLoading: this.state.isLoading + 1
     })
 
-    this.ipfs.files.cat(this.state.hash, (err, data) => {
+    this.ipfs.cat(this.state.hash, (err, data) => {
       if (err) console.log('Error', err)
 
       this.setState({

examples/discovery-mechanisms/1.js

@@ -1,14 +1,11 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
-const PeerInfo = require('peer-info')
 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 = [
@@ -23,51 +20,35 @@ const bootstrapers = [
   '/ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx'
 ]
 
-class MyBundle extends libp2p {
-  constructor (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ Mplex ],
-        connEncryption: [ SECIO ],
-        peerDiscovery: [ Bootstrap ]
-      },
-      config: {
-        peerDiscovery: {
-          autoDial: true,
-          bootstrap: {
-            interval: 20e3,
-            enabled: true,
-            list: bootstrapers
-          }
+;(async () => {
+  const node = await Libp2p.create({
+    modules: {
+      transport: [TCP],
+      streamMuxer: [Mplex],
+      connEncryption: [SECIO],
+      peerDiscovery: [Bootstrap]
+    },
+    config: {
+      peerDiscovery: {
+        bootstrap: {
+          interval: 60e3,
+          enabled: true,
+          list: bootstrapers
         }
       }
     }
+  })
 
-    super(defaultsDeep(_options, defaults))
-  }
-}
+  node.peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
 
-let node
-
-waterfall([
-  (cb) => PeerInfo.create(cb),
-  (peerInfo, cb) => {
-    peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-    node = new MyBundle({
-      peerInfo
-    })
-    node.start(cb)
-  }
-], (err) => {
-  if (err) { throw err }
+  node.on('peer:connect', (peer) => {
+    console.log('Connection established to:', peer.id.toB58String())	// Emitted when a peer has been found
+  })
 
   node.on('peer:discovery', (peer) => {
     // No need to dial, autoDial is on
     console.log('Discovered:', peer.id.toB58String())
   })
 
-  node.on('peer:connect', (peer) => {
-    console.log('Connection established to:', peer.id.toB58String())
-  })
-})
+  await node.start()
+})();

examples/discovery-mechanisms/2.js

@@ -1,63 +1,45 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ Mplex ],
-        connEncryption: [ SECIO ],
-        peerDiscovery: [ MulticastDNS ]
-      },
-      config: {
-        peerDiscovery: {
-          mdns: {
-            interval: 20e3,
-            enabled: true
-          }
+const createNode = async () => {
+  const node = await Libp2p.create({
+    modules: {
+      transport: [TCP],
+      streamMuxer: [Mplex],
+      connEncryption: [SECIO],
+      peerDiscovery: [MulticastDNS]
+    },
+    config: {
+      peerDiscovery: {
+        mdns: {
+          interval: 20e3,
+          enabled: true
         }
       }
     }
+  })
+  node.peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
 
-    super(defaultsDeep(_options, defaults))
-  }
+  return node
 }
 
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
+;(async () => {
+  const [node1, node2] = await Promise.all([
+    createNode(),
+    createNode()
+  ])
 
   node1.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
   node2.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
-})
+
+  await Promise.all([
+    node1.start(),
+    node2.start()
+  ])
+})();

examples/discovery-mechanisms/README.md

@@ -10,36 +10,32 @@ These mechanisms save configuration and enable a node to operate without any exp
 
 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.
+First, we create our libp2p node.
 
 ```JavaScript
-const Bootstrap = require('libp2p-railing')
-class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ Mplex ],
-        connEncryption: [ SECIO ],
-        peerDiscovery: [ Bootstrap ]
-      },
-      config: {
-        peerDiscovery: {
-          bootstrap: {
-            interval: 2000,
-            enabled: true,
-            list: bootstrapers
-          }
-        }
+const Libp2p = require('libp2p')
+const Bootstrap = require('libp2p-bootstrap')
+
+const node = Libp2p.create({
+  modules: {
+    transport: [ TCP ],
+    streamMuxer: [ Mplex ],
+    connEncryption: [ SECIO ],
+    peerDiscovery: [ Bootstrap ]
+  },
+  config: {
+    peerDiscovery: {
+      bootstrap: {
+        interval: 60e3,
+        enabled: true,
+        list: bootstrapers
       }
     }
-
-    super(defaultsDeep(_options, defaults))
   }
-}
+})
 ```
 
-In this bundle, we use a `bootstrappers` array listing peers to connect _on boot_. Here is the list used by js-ipfs and go-ipfs.
+In this configuration, we use a `bootstrappers` array listing peers to connect _on boot_. Here is the list used by js-ipfs and go-ipfs.
 
 ```JavaScript
 const bootstrapers = [
@@ -58,34 +54,37 @@ const bootstrapers = [
 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.start(cb)
+const node = await Libp2p.create({
+  peerInfo,
+  modules: {
+    transport: [ TCP ],
+    streamMuxer: [ Mplex ],
+    connEncryption: [ SECIO ],
+    peerDiscovery: [ Bootstrap ]
+  },
+  config: {
+    peerDiscovery: {
+      bootstrap: {
+        interval: 60e3,
+        enabled: true,
+        list: bootstrapers
+      }
+    }
   }
-], (err) => {
-  if (err) { throw err }
-
-  // Emitted when a peer has been found
-  node.on('peer:discovery', (peer) => {
-    console.log('Discovered:', peer.id.toB58String())
-    // Note how we need to dial, even if just to warm up the Connection (by not
-    // picking any protocol) in order to get a full Connection. The Peer Discovery
-    // doesn't make any decisions for you.
-    node.dial(peer, () => {})
-  })
-
-  // Once the dial is complete, this event is emitted.
-  node.on('peer:connect', (peer) => {
-    console.log('Connection established to:', peer.id.toB58String())
-  })
 })
+
+node.peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+node.on('peer:connect', (peer) => {
+  console.log('Connection established to:', peer.id.toB58String())	// Emitted when a peer has been found
+})
+
+// Emitted when a peer has been found
+node.on('peer:discovery', (peer) => {
+  console.log('Discovered:', peer.id.toB58String())
+})
+
+await node.start()
 ```
 
 From running [1.js](./1.js), you should see the following:
@@ -101,76 +100,56 @@ Discovered: QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64
 Discovered: QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd
 Discovered: QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3
 Discovered: QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx
-Connection established to: QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3
-Connection established to: QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd
-Connection established to: QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64
-Connection established to: QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm
-Connection established to: QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM
-Connection established to: QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx
-Connection established to: QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
-Connection established to: QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z
-Connection established to: QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu
 ```
 
 ## 2. MulticastDNS to find other peers in the network
 
 For this example, we need `libp2p-mdns`, go ahead and `npm install` it. You can find the complete solution at [2.js](./2.js).
 
-Update your libp2p bundle to include MulticastDNS.
+Update your libp2p configuration to include MulticastDNS.
 
 ```JavaScript
-class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ Mplex ],
-        connEncryption: [ SECIO ],
-        peerDiscovery: [ MulticastDNS ]
-      },
-      config: {
-        peerDiscovery: {
-          mdns: {
-            // Run at 1s so we can observe more quickly, default is 10s
-            interval: 1000,
-            enabled: true
-          }
+const Libp2p = require('libp2p')
+const MulticastDNS = require('libp2p-mdns')
+
+const createNode = () => {
+  return Libp2p.create({
+    modules: {
+      transport: [ TCP ],
+      streamMuxer: [ Mplex ],
+      connEncryption: [ SECIO ],
+      peerDiscovery: [ MulticastDNS ]
+    },
+    config: {
+      peerDiscovery: {
+        mdns: {
+          interval: 20e3,
+          enabled: true
         }
       }
     }
-
-    super(defaultsDeep(_options, defaults))
-  }
+  })
 }
 ```
 
 To observe it working, spawn two nodes.
 
 ```JavaScript
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
+const [node1, node2] = await Promise.all([
+  createNode(),
+  createNode()
+])
 
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-
-  node1.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
-  node2.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
-})
+node1.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
+node2.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
 ```
 
-If you run this example, you will see a continuous stream of each peer discovering each other.
+If you run this example, you will see the other peers being discovered.
 
 ```bash
 > node 2.js
 Discovered: QmSSbQpuKrxkoXHm1v4Pi35hPN5hUHMZoBoawEs2Nhvi8m
 Discovered: QmRcXXhtG8vTqwVBRonKWtV4ovDoC1Fe56WYtcrw694eiJ
-Discovered: QmSSbQpuKrxkoXHm1v4Pi35hPN5hUHMZoBoawEs2Nhvi8m
-Discovered: QmRcXXhtG8vTqwVBRonKWtV4ovDoC1Fe56WYtcrw694eiJ
-Discovered: QmSSbQpuKrxkoXHm1v4Pi35hPN5hUHMZoBoawEs2Nhvi8m
-Discovered: QmRcXXhtG8vTqwVBRonKWtV4ovDoC1Fe56WYtcrw694eiJ
 ```
 
 ## 3. Where to find other Peer Discovery Mechanisms

examples/echo/src/dialer.js

@@ -8,51 +8,54 @@
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
 const Node = require('./libp2p-bundle')
-const pull = require('pull-stream')
-const async = require('async')
+const pipe = require('it-pipe')
 
-async.parallel([
-  (cb) => PeerId.createFromJSON(require('./id-d'), cb),
-  (cb) => PeerId.createFromJSON(require('./id-l'), cb)
-], (err, ids) => {
-  if (err) { throw err }
+async function run() {
+  const [dialerId, listenerId] = await Promise.all([
+    PeerId.createFromJSON(require('./id-d')),
+    PeerId.createFromJSON(require('./id-l'))
+  ])
 
   // Dialer
-  const dialerId = ids[0]
   const dialerPeerInfo = new PeerInfo(dialerId)
   dialerPeerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
   const dialerNode = new Node({
     peerInfo: dialerPeerInfo
   })
 
-  // Peer to Dial
-  const listenerPeerInfo = new PeerInfo(ids[1])
-  const listenerId = ids[1]
+  // Peer to Dial (the listener)
+  const listenerPeerInfo = new PeerInfo(listenerId)
   const listenerMultiaddr = '/ip4/127.0.0.1/tcp/10333/p2p/' +
       listenerId.toB58String()
   listenerPeerInfo.multiaddrs.add(listenerMultiaddr)
 
-  dialerNode.start((err) => {
-    if (err) { throw err }
+  // Start the dialer libp2p node
+  await dialerNode.start()
 
-    console.log('Dialer ready, listening on:')
-    dialerPeerInfo.multiaddrs.forEach((ma) => console.log(ma.toString() +
-          '/p2p/' + dialerId.toB58String()))
+  console.log('Dialer ready, listening on:')
+  dialerPeerInfo.multiaddrs.forEach((ma) => console.log(ma.toString() +
+        '/p2p/' + dialerId.toB58String()))
 
-    console.log('Dialing to peer:', listenerMultiaddr.toString())
-    dialerNode.dialProtocol(listenerPeerInfo, '/echo/1.0.0', (err, conn) => {
-      if (err) { throw err }
+  // Dial the listener node
+  console.log('Dialing to peer:', listenerMultiaddr.toString())
+  const { stream } = await dialerNode.dialProtocol(listenerPeerInfo, '/echo/1.0.0')
 
-      console.log('nodeA dialed to nodeB on protocol: /echo/1.0.0')
+  console.log('nodeA dialed to nodeB on protocol: /echo/1.0.0')
 
-      pull(
-        pull.values(['hey']),
-        conn,
-        pull.collect((err, data) => {
-          if (err) { throw err }
-          console.log('received echo:', data.toString())
-        })
-      )
-    })
-  })
-})
+  pipe(
+    // Source data
+    ['hey'],
+    // Write to the stream, and pass its output to the next function
+    stream,
+    // Sink function
+    async function (source) {
+      // For each chunk of data
+      for await (const data of source) {
+        // Output the data
+        console.log('received echo:', data.toString())
+      }
+    }
+  )
+}
+
+run()

examples/echo/src/libp2p-bundle.js

@@ -1,41 +1,12 @@
 'use strict'
 
 const TCP = require('libp2p-tcp')
-const MulticastDNS = require('libp2p-mdns')
 const WS = require('libp2p-websockets')
-const Bootstrap = require('libp2p-bootstrap')
-const spdy = require('libp2p-spdy')
-const KadDHT = require('libp2p-kad-dht')
 const mplex = require('libp2p-mplex')
 const secio = require('libp2p-secio')
 const defaultsDeep = require('@nodeutils/defaults-deep')
 const libp2p = require('../../..')
 
-function mapMuxers (list) {
-  return list.map((pref) => {
-    if (typeof pref !== 'string') {
-      return pref
-    }
-    switch (pref.trim().toLowerCase()) {
-      case 'spdy': return spdy
-      case 'mplex': return mplex
-      default:
-        throw new Error(pref + ' muxer not available')
-    }
-  })
-}
-
-function getMuxers (muxers) {
-  const muxerPrefs = process.env.LIBP2P_MUXER
-  if (muxerPrefs && !muxers) {
-    return mapMuxers(muxerPrefs.split(','))
-  } else if (muxers) {
-    return mapMuxers(muxers)
-  } else {
-    return [mplex, spdy]
-  }
-}
-
 class Node extends libp2p {
   constructor (_options) {
     const defaults = {
@@ -44,29 +15,8 @@ class Node extends libp2p {
           TCP,
           WS
         ],
-        streamMuxer: getMuxers(_options.muxer),
-        connEncryption: [ secio ],
-        peerDiscovery: [
-          MulticastDNS,
-          Bootstrap
-        ],
-        dht: KadDHT
-      },
-      config: {
-        peerDiscovery: {
-          mdns: {
-            interval: 10000,
-            enabled: false
-          },
-          bootstrap: {
-            interval: 10000,
-            enabled: false,
-            list: _options.bootstrapList
-          }
-        },
-        dht: {
-          kBucketSize: 20
-        }
+        streamMuxer: [ mplex ],
+        connEncryption: [ secio ]
       }
     }
 

examples/echo/src/listener.js

@@ -8,39 +8,34 @@
 const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
 const Node = require('./libp2p-bundle')
-const pull = require('pull-stream')
-const series = require('async/series')
+const pipe = require('it-pipe')
 
-let listenerId
-let listenerNode
+async function run() {
+  const listenerId = await PeerId.createFromJSON(require('./id-l'))
 
-series([
-  (cb) => {
-    PeerId.createFromJSON(require('./id-l'), (err, id) => {
-      if (err) { return cb(err) }
-      listenerId = id
-      cb()
-    })
-  },
-  (cb) => {
-    const listenerPeerInfo = new PeerInfo(listenerId)
-    listenerPeerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/10333')
-    listenerNode = new Node({
-      peerInfo: listenerPeerInfo
-    })
+  // Listener libp2p node
+  const listenerPeerInfo = new PeerInfo(listenerId)
+  listenerPeerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/10333')
+  const listenerNode = new Node({
+    peerInfo: listenerPeerInfo
+  })
 
-    listenerNode.on('peer:connect', (peerInfo) => {
-      console.log('received dial to me from:', peerInfo.id.toB58String())
-    })
+  // Log a message when we receive a connection
+  listenerNode.on('peer:connect', (peerInfo) => {
+    console.log('received dial to me from:', peerInfo.id.toB58String())
+  })
 
-    listenerNode.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
-    listenerNode.start(cb)
-  }
-], (err) => {
-  if (err) { throw err }
+  // Handle incoming connections for the protocol by piping from the stream
+  // back to itself (an echo)
+  await listenerNode.handle('/echo/1.0.0', ({ stream }) => pipe(stream.source, stream.sink))
+
+  // Start listening
+  await listenerNode.start()
 
   console.log('Listener ready, listening on:')
   listenerNode.peerInfo.multiaddrs.forEach((ma) => {
     console.log(ma.toString() + '/p2p/' + listenerId.toB58String())
   })
-})
+}
+
+run()

examples/encrypted-communications/1.js

@@ -1,63 +1,52 @@
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const SPDY = require('libp2p-spdy')
+const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ SPDY ],
-        connEncryption: [ SECIO ]
+const pipe = require('it-pipe')
+
+const createNode = async () => {
+  const peerInfo = await PeerInfo.create()
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      streamMuxer: [Mplex],
+      connEncryption: [SECIO]
+    }
+  })
+
+  await node.start()
+
+  return node
+}
+
+;(async () => {
+  const [node1, node2] = await Promise.all([
+    createNode(),
+    createNode()
+  ])
+
+  node2.handle('/a-protocol', ({ stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
       }
-    }
-
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-
-  node2.handle('/a-protocol', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
     )
   })
 
-  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)
-  })
-})
+  const { stream } = await node1.dialProtocol(node2.peerInfo, '/a-protocol')
+
+  await pipe(
+    ['This information is sent out encrypted to the other peer'],
+    stream
+  )
+})();

examples/encrypted-communications/README.md

@@ -4,7 +4,7 @@ libp2p can leverage the encrypted communications from the transports it uses (i.
 
 We call this usage a _connection upgrade_ where given a connection between peer A to peer B, a protocol handshake can be performed that gives that connection new properties.
 
-A byproduct of having these encrypted communications modules is that we can authenticate the peers we are dialing to. You might have noticed that every time we dial to a peer in libp2p space, we always use its PeerId at the end (e.g /ip4/127.0.0.1/tcp/89765/ipfs/QmWCbVw1XZ8hiYBwwshPce2yaTDYTqTaP7GCHGpry3ykWb), this PeerId is generated by hashing the Public Key of the peer. With this, we can create a crypto challenge when dialing to another peer and prove that peer is the owner of a PrivateKey that matches the Public Key we know.
+A byproduct of having these encrypted communications modules is that we can authenticate the peers we are dialing to. You might have noticed that every time we dial to a peer in libp2p space, we always use its PeerId at the end (e.g /ip4/127.0.0.1/tcp/89765/p2p/QmWCbVw1XZ8hiYBwwshPce2yaTDYTqTaP7GCHGpry3ykWb), this PeerId is generated by hashing the Public Key of the peer. With this, we can create a crypto challenge when dialing to another peer and prove that peer is the owner of a PrivateKey that matches the Public Key we know.
 
 # 1. Set up encrypted communications with SECIO
 
@@ -12,24 +12,21 @@ We will build this example on top of example for [Protocol and Stream Multiplexi
 
 SECIO is the crypto channel developed for IPFS, it is a TLS 1.3 like crypto channel that established an encrypted communication channel between two peers.
 
-To add it to your libp2p bundle, all you have to do is:
+To add it to your libp2p configuration, all you have to do is:
 
 ```JavaScript
+const Libp2p = require('libp2p')
 const SECIO = require('libp2p-secio')
 
-class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ SPDY ],
-        // Attach secio as the crypto channel to use
-        connEncryption: [ SECIO ]
-      }
+const createNode = () => {
+  return Libp2p.create({
+    modules: {
+      transport: [ TCP ],
+      streamMuxer: [ Mplex ],
+      // Attach secio as the crypto channel to use
+      connEncryption: [ SECIO ]
     }
-
-    super(defaultsDeep(_options, defaults))
-  }
+  })
 }
 ```
 

examples/libp2p-in-the-browser/.babelrc

@@ -0,0 +1,4 @@
+{
+  "presets": ["@babel/preset-env"],
+  "plugins": ["syntax-async-functions","transform-regenerator"]
+}

examples/libp2p-in-the-browser/1/.gitignore

@@ -1 +0,0 @@
-bundle.js

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

@@ -1,31 +0,0 @@
-{
-  "name": "libp2p-in-the-browser",
-  "version": "0.1.0",
-  "description": "See other nodes in the network using WebRTC Star discovery mechanism",
-  "main": "src/index.js",
-  "scripts": {
-    "bundle": "browserify src/index.js > public/bundle.js",
-    "serve": "static public -p 9090 -H '{\"Cache-Control\": \"no-cache, must-revalidate\"}'",
-    "start": "npm run bundle && npm run serve"
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "browserify": "^14.5.0",
-    "concat-stream": "^1.6.0",
-    "detect-dom-ready": "^1.0.2",
-    "node-static": "~0.7.10"
-  },
-  "dependencies": {
-    "detect-dom-ready": "^1.0.2",
-    "libp2p": "../../../",
-    "libp2p-bootstrap": "~0.9.7",
-    "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/public/index.html

@@ -1,14 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8"/>
-    <title>libp2p in the browser</title>
-  </head>
-  <body>
-    <h1>libp2p node running \o/</h1>
-    <div id="my-peer"></div>
-    <div id="swarm"></div>
-
-    <script src="bundle.js"></script>
-  </body>
-</html>

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

@@ -1,92 +0,0 @@
-'use strict'
-
-const WebRTCStar = require('libp2p-webrtc-star')
-const WebSockets = require('libp2p-websockets')
-const WebSocketStar = require('libp2p-websocket-star')
-const Mplex = require('libp2p-mplex')
-const SPDY = require('libp2p-spdy')
-const SECIO = require('libp2p-secio')
-const Bootstrap = require('libp2p-bootstrap')
-const DHT = require('libp2p-kad-dht')
-const libp2p = require('libp2p')
-
-// Find this list at: https://github.com/ipfs/js-ipfs/blob/master/src/core/runtime/config-browser.json
-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 }) {
-    const wrtcStar = new WebRTCStar({ id: peerInfo.id })
-    const wsstar = new WebSocketStar({ id: peerInfo.id })
-
-    const defaults = {
-      modules: {
-        transport: [
-          wrtcStar,
-          WebSockets,
-          wsstar
-        ],
-        streamMuxer: [
-          Mplex,
-          SPDY
-        ],
-        connEncryption: [
-          SECIO
-        ],
-        peerDiscovery: [
-          wrtcStar.discovery,
-          wsstar.discovery,
-          Bootstrap
-        ],
-        dht: DHT
-      },
-      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
-        },
-        EXPERIMENTAL: {
-          pubsub: false
-        }
-      },
-      connectionManager: {
-        minPeers: 10,
-        maxPeers: 50
-      }
-    }
-
-    super({ ...defaults, peerInfo })
-  }
-}
-
-module.exports = Node

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

@@ -1,28 +0,0 @@
-'use strict'
-
-const PeerInfo = require('peer-info')
-const Node = require('./browser-bundle')
-
-function createNode (callback) {
-  PeerInfo.create((err, peerInfo) => {
-    if (err) {
-      return callback(err)
-    }
-
-    const peerIdStr = peerInfo.id.toB58String()
-    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(webrtcAddr)
-    peerInfo.multiaddrs.add(wsAddr)
-
-    const node = new Node({
-      peerInfo
-    })
-
-    node.idStr = peerIdStr
-    callback(null, node)
-  })
-}
-
-module.exports = createNode

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

@@ -1,57 +0,0 @@
-/* eslint no-console: ["error", { allow: ["log"] }] */
-/* eslint max-nested-callbacks: ["error", 5] */
-'use strict'
-
-const domReady = require('detect-dom-ready')
-const createNode = require('./create-node')
-
-domReady(() => {
-  const myPeerDiv = document.getElementById('my-peer')
-  const swarmDiv = document.getElementById('swarm')
-
-  createNode((err, node) => {
-    if (err) {
-      return console.log('Could not create the Node, check if your browser has WebRTC Support', err)
-    }
-
-    node.on('peer:discovery', (peerInfo) => {
-      console.log('Discovered a peer:', peerInfo.id.toB58String())
-    })
-
-    node.on('peer:connect', (peerInfo) => {
-      const idStr = peerInfo.id.toB58String()
-      console.log('Got connection to: ' + idStr)
-      const connDiv = document.createElement('div')
-      connDiv.innerHTML = 'Connected to: ' + idStr
-      connDiv.id = idStr
-      swarmDiv.append(connDiv)
-    })
-
-    node.on('peer:disconnect', (peerInfo) => {
-      const idStr = peerInfo.id.toB58String()
-      const el = document.getElementById(idStr)
-      el && el.remove()
-    })
-
-    node.start((err) => {
-      if (err) {
-        return console.log(err)
-      }
-
-      const idStr = node.peerInfo.id.toB58String()
-
-      const idDiv = document
-        .createTextNode('Node is ready. ID: ' + idStr)
-
-      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

@@ -1,22 +1,55 @@
-# libp2p running in the Browser
+# libp2p in the browser
 
-One of the primary goals with libp2p P2P was to get it fully working in the browser and interopable with the versions running in Go and in Node.js.
+This example leverages the [Parcel.js bundler](https://parceljs.org/) to compile and serve the libp2p code in the browser. Parcel uses [Babel](https://babeljs.io/) to handle transpilation of the code. You can use other bundlers such as Webpack or Browserify, but we will not be covering them here.
 
-# 1. Setting up a simple app that lists connections to other nodes
+## Setup
 
-Start by installing libp2p's dependencies.
+In order to run the example, first install the dependencies from same directory as this README:
 
-```bash
-> cd ../../
-> npm install
-> cd examples/libp2p-in-the-browser
+```
+cd ./examples/libp2p-in-the-browser
+npm install
 ```
 
-Then simply go into the folder [1](./1) and execute the following
+## Signaling Server
 
-```bash
-> cd 1
-> npm install
-> npm start
-# open your browser in port :9090
+This example uses the `libp2p-webrtc-star` module, which enables libp2p browser nodes to establish direct connections to one another via a central signaling server. For this example, we are using the signaling server that ships with `libp2p-webrtc-star`.
+
+You can start the server by running `npm run server`. This will start a signaling server locally on port `9090`. If you'd like to run a signaling server outside of this example, you can see instructions on how to do so in the [`libp2p-webrtc-star` README](https://github.com/libp2p/js-libp2p-webrtc-star).
+
+When you run the server, you should see output that looks something like this:
+
+```log
+$ npm run server
+
+> libp2p-in-browser@1.0.0 server
+> star-signal
+
+Listening on: http://0.0.0.0:9090
 ```
+
+## Running the examples
+
+Once you have started the signaling server, you can run the Parcel server.
+
+```
+npm start
+```
+
+The output should look something like this:
+
+```log
+$ npm start
+
+> libp2p-in-browser@1.0.0 start
+> parcel index.html
+
+Server running at http://localhost:1234
+✨  Built in 1000ms.
+```
+
+This will compile the code and start a server listening on port [http://localhost:1234](http://localhost:1234). Now open your browser to `http://localhost:1234`. You should see a log of your node's Peer ID, the discovered peers from the Bootstrap module, and connections to those peers as they are created.
+
+Now, if you open a second browser tab to `http://localhost:1234`, you should discover your node from the previous tab. This is due to the fact that the `libp2p-webrtc-star` transport also acts as a Peer Discovery interface. Your node will be notified of any peer that connects to the same signaling server you are connected to. Once libp2p discovers this new peer, it will attempt to establish a direct WebRTC connection.
+
+**Note**: In the example we assign libp2p to `window.libp2p`, in case you would like to play around with the API directly in the browser. You can of course make changes to `index.js` and Parcel will automatically rebuild and reload the browser tabs.

examples/libp2p-in-the-browser/index.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+
+<html lang="en">
+
+  <head>
+    <meta charset="utf-8">
+    <title>js-libp2p parcel.js browser example</title>
+  </head>
+
+  <body>
+    <header>
+      <h1 id="status">Starting libp2p...</h1>
+    </header>
+
+    <main>
+      <pre id="output"></pre>
+    </main>
+
+    <script src="./index.js"></script>
+
+  </body>
+
+</html>

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

@@ -0,0 +1,73 @@
+import 'babel-polyfill'
+import Libp2p from 'libp2p'
+import Websockets from 'libp2p-websockets'
+import WebRTCStar from 'libp2p-webrtc-star'
+import Secio from 'libp2p-secio'
+import Mplex from 'libp2p-mplex'
+import Boostrap from 'libp2p-bootstrap'
+
+document.addEventListener('DOMContentLoaded', async () => {
+  // Create our libp2p node
+  const libp2p = await Libp2p.create({
+    modules: {
+      transport: [Websockets, WebRTCStar],
+      connEncryption: [Secio],
+      streamMuxer: [Mplex],
+      peerDiscovery: [Boostrap]
+    },
+    config: {
+      peerDiscovery: {
+        bootstrap: {
+          enabled: true,
+          list: [
+            '/dns4/ams-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLer265NRgSp2LA3dPaeykiS1J6DifTC88f5uVQKNAd',
+            '/dns4/lon-1.bootstrap.libp2p.io/tcp/443/wss/p2p/QmSoLMeWqB7YGVLJN3pNLQpmmEk35v6wYtsMGLzSr5QBU3',
+            '/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'
+          ]
+        }
+      }
+    }
+  })
+
+  // UI elements
+  const status = document.getElementById('status')
+  const output = document.getElementById('output')
+
+  output.textContent = ''
+
+  function log (txt) {
+    console.info(txt)
+    output.textContent += `${txt.trim()}\n`
+  }
+
+  // Add the signaling server address, along with our PeerId to our multiaddrs list
+  // libp2p will automatically attempt to dial to the signaling server so that it can
+  // receive inbound connections from other peers
+  const webrtcAddr = '/ip4/0.0.0.0/tcp/9090/wss/p2p-webrtc-star'
+  libp2p.peerInfo.multiaddrs.add(webrtcAddr)
+
+  // Listen for new peers
+  libp2p.on('peer:discovery', (peerInfo) => {
+    log(`Found peer ${peerInfo.id.toB58String()}`)
+  })
+
+  // Listen for new connections to peers
+  libp2p.on('peer:connect', (peerInfo) => {
+    log(`Connected to ${peerInfo.id.toB58String()}`)
+  })
+
+  // Listen for peers disconnecting
+  libp2p.on('peer:disconnect', (peerInfo) => {
+    log(`Disconnected from ${peerInfo.id.toB58String()}`)
+  })
+
+  await libp2p.start()
+  status.innerText = 'libp2p started!'
+  log(`libp2p id is ${libp2p.peerInfo.id.toB58String()}`)
+
+  // Export libp2p to the window so you can play with the API
+  window.libp2p = libp2p
+})

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

@@ -0,0 +1,34 @@
+{
+  "name": "libp2p-in-browser",
+  "version": "1.0.0",
+  "description": "A libp2p node running in the browser",
+  "main": "index.js",
+  "browserslist": [
+    "last 2 Chrome versions"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "parcel index.html",
+    "server": "star-signal"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@babel/preset-env": "^7.8.3",
+    "libp2p": "../../",
+    "libp2p-bootstrap": "^0.10.3",
+    "libp2p-mplex": "^0.9.3",
+    "libp2p-secio": "^0.12.2",
+    "libp2p-webrtc-star": "^0.17.3",
+    "libp2p-websockets": "^0.13.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.8.3",
+    "@babel/core": "^7.8.3",
+    "babel-plugin-syntax-async-functions": "^6.13.0",
+    "babel-plugin-transform-regenerator": "^6.26.0",
+    "babel-polyfill": "^6.26.0",
+    "parcel-bundler": "^1.12.4"
+  }
+}

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

@@ -1,77 +1,55 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ Mplex ],
-        connEncryption: [ SECIO ],
-        // we add the DHT module that will enable Peer and Content Routing
-        dht: KadDHT
-      },
-      config: {
-        dht: {
-          enabled: true,
-          kBucketSize: 20
-        }
+const delay = require('delay')
+
+const createNode = async () => {
+  const peerInfo = await PeerInfo.create()
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      streamMuxer: [Mplex],
+      connEncryption: [SECIO],
+      dht: KadDHT
+    },
+    config: {
+      dht: {
+        enabled: true
       }
     }
-
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-  const node3 = nodes[2]
-
-  parallel([
-    (cb) => node1.dial(node2.peerInfo, cb),
-    (cb) => node2.dial(node3.peerInfo, cb),
-    // Set up of the cons might take time
-    (cb) => setTimeout(cb, 300)
-  ], (err) => {
-    if (err) { throw err }
-
-    node1.peerRouting.findPeer(node3.peerInfo.id, (err, peer) => {
-      if (err) { throw err }
-
-      console.log('Found it, multiaddrs are:')
-      peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
-    })
   })
-})
+
+  await node.start()
+  return node
+}
+
+;(async () => {
+  const [node1, node2, node3] = await Promise.all([
+    createNode(),
+    createNode(),
+    createNode()
+  ])
+
+  await Promise.all([
+    node1.dial(node2.peerInfo),
+    node2.dial(node3.peerInfo)
+  ])
+
+  // The DHT routing tables need a moment to populate
+  await delay(100)
+
+  const peer = await node1.peerRouting.findPeer(node3.peerInfo.id)
+
+  console.log('Found it, multiaddrs are:')
+  peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
+})();

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

@@ -1,85 +1,61 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ Mplex ],
-        connEncryption: [ SECIO ],
-        // we add the DHT module that will enable Peer and Content Routing
-        dht: KadDHT
-      },
-      config: {
-        dht: {
-          enabled: true,
-          kBucketSize: 20
-        }
+const all = require('it-all')
+const delay = require('delay')
+
+const createNode = async () => {
+  const peerInfo = await PeerInfo.create()
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      streamMuxer: [Mplex],
+      connEncryption: [SECIO],
+      dht: KadDHT
+    },
+    config: {
+      dht: {
+        enabled: true
       }
     }
-
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-  const node3 = nodes[2]
-
-  parallel([
-    (cb) => node1.dial(node2.peerInfo, cb),
-    (cb) => node2.dial(node3.peerInfo, cb),
-    // Set up of the cons might take time
-    (cb) => setTimeout(cb, 300)
-  ], (err) => {
-    if (err) { throw err }
-
-    const cid = new CID('QmTp9VkYvnHyrqKQuFPiuZkiX9gPcqj6x5LJ1rmWuSySnL')
-
-    node1.contentRouting.provide(cid, (err) => {
-      if (err) { throw err }
-
-      console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
-
-      node3.contentRouting.findProviders(cid, 5000, (err, providers) => {
-        if (err) { throw err }
-
-        console.log('Found provider:', providers[0].id.toB58String())
-      })
-    })
   })
-})
+
+  await node.start()
+  return node
+}
+
+;(async () => {
+  const [node1, node2, node3] = await Promise.all([
+    createNode(),
+    createNode(),
+    createNode()
+  ])
+
+  await Promise.all([
+    node1.dial(node2.peerInfo),
+    node2.dial(node3.peerInfo)
+  ])
+
+  const cid = new CID('QmTp9VkYvnHyrqKQuFPiuZkiX9gPcqj6x5LJ1rmWuSySnL')
+  await node1.contentRouting.provide(cid)
+
+  console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
+
+  // wait for propagation
+  await delay(300)
+
+  const providers = await all(node3.contentRouting.findProviders(cid, { timeout: 3000 }))
+
+  console.log('Found provider:', providers[0].id.toB58String())
+})();

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

@@ -10,31 +10,27 @@ Content Routing is the category of modules that offer a way to find where conten
 
 This example builds on top of the [Protocol and Stream Muxing](../protocol-and-stream-muxing). We need to install `libp2p-kad-dht`, go ahead and `npm install libp2p-kad-dht`. If you want to see the final version, open [1.js](./1.js).
 
-First, let's update our bundle to support Peer Routing and Content Routing.
+First, let's update our config to support Peer Routing and Content Routing.
 
 ```JavaScript
-class MyBundle extends libp2p {
-  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
-      },
-      config: {
-        dht: {
-          // dht must be enabled
-          enabled: true,
-          kBucketSize: 20
-        }
-      }
-    }
+const Libp2p = require('libp2p')
+const KadDHT = require('libp2p-kad-dht')
 
-    super(defaultsDeep(_options, defaults))
+const node = await Libp2p.create({
+  modules: {
+    transport: [ TCP ],
+    streamMuxer: [ Mplex ],
+    connEncryption: [ SECIO ],
+    // we add the DHT module that will enable Peer and Content Routing
+    dht: KadDHT
+  },
+  config: {
+    dht: {
+      // dht must be enabled
+      enabled: true
+    }
   }
-}
+})
 ```
 
 Once that is done, we can use the createNode function we developed in the previous example to create 3 nodes. Connect node 1 to node 2 and node 2 to node 3. We will use node 2 as a way to find the whereabouts of node 3
@@ -44,22 +40,18 @@ const node1 = nodes[0]
 const node2 = nodes[1]
 const node3 = nodes[2]
 
-parallel([
-  (cb) => node1.dial(node2.peerInfo, cb),
-  (cb) => node2.dial(node3.peerInfo, cb),
-  // Set up of the cons might take time
-  (cb) => setTimeout(cb, 100)
-], (err) => {
-  if (err) { throw err }
+await Promise.all([
+  node1.dial(node2.peerInfo),
+  node2.dial(node3.peerInfo)
+])
 
-  //
-  node1.peerRouting.findPeer(node3.peerInfo.id, (err, peer) => {
-    if (err) { throw err }
+// Set up of the cons might take time
+await delay(100)
 
-    console.log('Found it, multiaddrs are:')
-    peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
-  })
-})
+const peer = await node1.peerRouting.findPeer(node3.peerInfo.id)
+
+console.log('Found it, multiaddrs are:')
+peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
 ```
 
 You should see the output being something like:
@@ -82,17 +74,12 @@ You can find this example completed in [2.js](./2.js), however as you will see i
 Instead of calling `peerRouting.findPeer`, we will use `contentRouting.provide` and `contentRouting.findProviders`.
 
 ```JavaScript
-node1.contentRouting.provide(cid, (err) => {
-  if (err) { throw err }
+await node1.contentRouting.provide(cid)
+console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
 
-  console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
+const provs = await all(node3.contentRouting.findProviders(cid, { timeout: 5000 }))
 
-  node3.contentRouting.findProviders(cid, 5000, (err, providers) => {
-    if (err) { throw err }
-
-    console.log('Found provider:', providers[0].id.toB58String())
-  })
-})
+console.log('Found provider:', providers[0].id.toB58String())
 ```
 
 The output of your program should look like:

examples/pnet/.gitignore

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

examples/pnet/README.md

@@ -0,0 +1,29 @@
+# Private Networking
+This example shows how to set up a private network of libp2p 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/index.js

@@ -0,0 +1,50 @@
+/* eslint no-console: ["off"] */
+'use strict'
+
+const { generate } = require('libp2p/src/pnet')
+const privateLibp2pNode = require('./libp2p-node')
+
+const pipe = require('it-pipe')
+
+// Create a buffer and write the swarm key to it
+const swarmKey = Buffer.alloc(95)
+generate(swarmKey)
+
+// This key is for testing a different key not working
+const otherSwarmKey = Buffer.alloc(95)
+generate(otherSwarmKey)
+
+;(async () => {
+  const node1 = await privateLibp2pNode(swarmKey)
+
+  // TASK: switch the commented out line below so we're using a different key, to see the nodes fail to connect	
+  const node2 = await privateLibp2pNode(swarmKey)
+  // const node2 = await privateLibp2pNode(otherSwarmKey)
+
+  await Promise.all([
+    node1.start(),
+    node2.start()
+  ])
+
+  console.log('nodes started...')
+
+  await node1.dial(node2.peerInfo)
+
+  node2.handle('/private', ({ stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
+      }
+    )
+  })
+
+  const { stream } = await node1.dialProtocol(node2.peerInfo, '/private')
+
+  await pipe(
+    ['This message is sent on a private network'],
+    stream
+  )
+})();

examples/pnet/libp2p-node.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const Protector = require('libp2p/src/pnet')
+
+/**
+ * privateLibp2pNode returns a libp2p node function that will use the swarm
+ * key at the given `swarmKeyPath` to create the Protector
+ *
+ * @param {Buffer} swarmKey
+ * @returns {Promise<libp2p>} Returns a libp2pNode function for use in IPFS creation
+ */
+const privateLibp2pNode = async (swarmKeyPath) => {
+  const node = await Libp2p.create({
+    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(swarmKeyPath)
+    }
+  })
+
+  node.peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+  return node
+}
+
+module.exports = privateLibp2pNode

examples/pnet/package.json

@@ -0,0 +1,19 @@
+{
+  "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": {
+    "libp2p": "../..",
+    "libp2p-mplex": "^0.9.3",
+    "libp2p-secio": "^0.12.1",
+    "libp2p-tcp": "^0.14.2"
+  }
+}

examples/pnet/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,102 +1,79 @@
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
 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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ]
-      }
+const pipe = require('it-pipe')
+
+const createNode = async () => {
+  const peerInfo = await PeerInfo.create()
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      streamMuxer: [MPLEX],
+      connEncryption: [SECIO]
     }
+  })
 
-    super(defaultsDeep(_options, defaults))
-  }
+  await node.start()
+
+  return node
 }
 
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
+;(async () => {
+  const [node1, node2] = await Promise.all([
+    createNode(),
+    createNode()
+  ])
 
   // exact matching
-  node2.handle('/your-protocol', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
+  node2.handle('/your-protocol', ({ stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
+      }
     )
   })
 
-  // semver matching
+  // multiple protocols
   /*
-  node2.handle('/another-protocol/1.0.1', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
-    )
-  })
-  */
-
-  // custom func matching
-  /*
-  node2.handle('/custom-match-func', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
-    )
-  }, (myProtocol, requestedProtocol, callback) => {
-    if (myProtocol.indexOf(requestedProtocol)) {
-      callback(null, true)
-    } else {
-      callback(null, false)
+  node2.handle(['/another-protocol/1.0.0', '/another-protocol/2.0.0'], ({ protocol, stream }) => {
+    if (protocol === '/another-protocol/2.0.0') {
+      // handle backwards compatibility
     }
+
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
+      }
+    )
   })
   */
 
-  node1.dialProtocol(node2.peerInfo, '/your-protocol', (err, conn) => {
-    if (err) { throw err }
-    pull(pull.values(['my own protocol, wow!']), conn)
-  })
+  const { stream } = await node1.dialProtocol(node2.peerInfo, ['/your-protocol'])
+  await pipe(
+    ['my own protocol, wow!'],
+    stream
+  )
 
   /*
-  node1.dialProtocol(node2.peerInfo, '/another-protocol/1.0.0', (err, conn) => {
-    if (err) { throw err }
-    pull(pull.values(['semver me please']), conn)
-  })
-  */
+  const { stream } = node1.dialProtocol(node2.peerInfo, ['/another-protocol/1.0.0'])
 
-  /*
-  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)
-  })
+  await pipe(
+    ['my own protocol, wow!'],
+    stream
+  )
   */
-})
+})();

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

@@ -1,83 +1,63 @@
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const SPDY = require('libp2p-spdy')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
-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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ SPDY ]
-      }
+const pipe = require('it-pipe')
+
+const createNode = async () => {
+  const peerInfo = await PeerInfo.create()
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      streamMuxer: [MPLEX],
+      connEncryption: [SECIO]
     }
-
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-
-  node2.handle('/a', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
-    )
   })
 
-  node2.handle('/b', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
-    )
-  })
+  await node.start()
 
-  series([
-    (cb) => node1.dialProtocol(node2.peerInfo, '/a', (err, conn) => {
-      if (err) { throw err }
-      pull(pull.values(['protocol (a)']), conn)
-      cb()
-    }),
-    (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
-      if (err) { throw err }
-      pull(pull.values(['protocol (b)']), conn)
-      cb()
-    }),
-    (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
-      if (err) { throw err }
-      pull(pull.values(['another conn on protocol (b)']), conn)
-      cb()
-    })
+  return node
+}
+
+;(async () => {
+  const [node1, node2] = await Promise.all([
+    createNode(),
+    createNode()
   ])
-})
+
+  node2.handle(['/a', '/b'], ({ protocol, stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(`from: ${protocol}, msg: ${msg.toString()}`)
+        }
+      }
+    )
+  })
+
+  const { stream: stream1 } = await node1.dialProtocol(node2.peerInfo, ['/a'])
+  await pipe(
+    ['protocol (a)'],
+    stream1
+  )
+
+  const { stream: stream2 } = await node1.dialProtocol(node2.peerInfo, ['/b'])
+  await pipe(
+    ['protocol (b)'],
+    stream2
+  )
+
+  const { stream: stream3 } = await node1.dialProtocol(node2.peerInfo, ['/b'])
+  await pipe(
+    ['another stream on protocol (b)'],
+    stream3
+  )
+})();

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

@@ -1,88 +1,69 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
-const SPDY = require('libp2p-spdy')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
-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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ SPDY ]
+const pipe = require('it-pipe')
+
+const createNode = async () => {
+  const peerInfo = await PeerInfo.create()
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      streamMuxer: [MPLEX],
+      connEncryption: [SECIO]
+    }
+  })
+
+  await node.start()
+
+  return node
+}
+
+;(async () => {
+  const [node1, node2] = await Promise.all([
+    createNode(),
+    createNode()
+  ])
+  
+  node1.handle('/node-1', ({ stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
       }
-    }
-
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-
-  node1.handle('/node-1', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
     )
   })
 
-  node2.handle('/node-2', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
+  node2.handle('/node-2', ({ stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
+      }
     )
   })
 
-  series([
-    (cb) => node1.dialProtocol(node2.peerInfo, '/node-2', (err, conn) => {
-      if (err) { throw err }
-      pull(pull.values(['from 1 to 2']), conn)
-      cb()
-    }),
-    (cb) => node2.dialProtocol(node1.peerInfo, '/node-1', (err, conn) => {
-      if (err) { throw err }
-      pull(pull.values(['from 2 to 1']), conn)
-      cb()
-    })
-  ], (err) => {
-    if (err) { throw err }
-    console.log('Addresses by which both peers are connected')
-    node1.peerBook
-      .getAllArray()
-      .forEach((peer) => console.log('node 1 to node 2:', peer.isConnected().toString()))
-    node2.peerBook
-      .getAllArray()
-      .forEach((peer) => console.log('node 2 to node 1:', peer.isConnected().toString()))
-  })
-})
+  const { stream: stream1 } = await node1.dialProtocol(node2.peerInfo, ['/node-2'])
+  await pipe(
+    ['from 1 to 2'],
+    stream1
+  )
+
+  const { stream: stream2 } = await node2.dialProtocol(node1.peerInfo, ['/node-1'])
+  await pipe(
+    ['from 2 to 1'],
+    stream2
+  )
+})();

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

@@ -6,23 +6,30 @@ The feature of agreeing on a protocol over an established connection is what we
 
 # 1. Handle multiple protocols
 
-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).
+Let's see _protocol multiplexing_ in action! You will need the following modules for this example: `libp2p`, `libp2p-tcp`, `peer-info`, `it-pipe`, `it-buffer` and `streaming-iterables`. 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.
 
 ```JavaScript
+const pipe = require('it-pipe')
+const { map } = require('streaming-iterables')
+const { toBuffer } = require('it-buffer')
+
 // ...
 const node1 = nodes[0]
 const node2 = nodes[1]
 
-// Here we are telling libp2p that is someone dials this node to talk with the `/your-protocol`
-// multicodec, the protocol identifier, please call this callback and give it the connection
+// Here we are telling libp2p that if someone dials this node to talk with the `/your-protocol`
+// multicodec, the protocol identifier, please call this handler and give it the stream
 // so that incomming data can be handled
-node2.handle('/your-protocol', (protocol, conn) => {
-  pull(
-    conn,
-    pull.map((v) => v.toString()),
-    pull.log()
+node2.handle('/your-protocol', ({ stream }) => {
+  pipe(
+    stream,
+    source => (async function () {
+      for await (const msg of source) {
+        console.log(msg.toString())
+      }
+    })()
   )
 })
 ```
@@ -30,53 +37,54 @@ node2.handle('/your-protocol', (protocol, conn) => {
 After the protocol is _handled_, now we can dial to it.
 
 ```JavaScript
-node1.dialProtocol(node2.peerInfo, '/your-protocol', (err, conn) => {
-  if (err) { throw err }
-  pull(pull.values(['my own protocol, wow!']), conn)
-})
+const { stream } = await node1.dialProtocol(node2.peerInfo, ['/your-protocol'])
+
+await pipe(
+  ['my own protocol, wow!'],
+  stream
+)
 ```
 
 You might have seen this in the [Transports](../transports) examples. However, what it was not explained is that you can do more than exact string matching, for example, you can use semver.
 
 ```JavaScript
-node2.handle('/another-protocol/1.0.1', (protocol, conn) => {
-  pull(
-    conn,
-    pull.map((v) => v.toString()),
-    pull.log()
+node2.handle('/another-protocol/1.0.1', ({ stream }) => {
+  pipe(
+    stream,
+    async function (source) {
+      for await (const msg of source) {
+        console.log(msg.toString())
+      }
+    }
   )
 })
 // ...
-node1.dialProtocol(node2.peerInfo, '/another-protocol/1.0.0', (err, conn) => {
-  if (err) { throw err }
-  pull(pull.values(['semver me please']), conn)
-})
+const { stream } = await node1.dialProtocol(node2.peerInfo, ['/another-protocol/1.0.0'])
+
+await pipe(
+  ['my own protocol, wow!'],
+  stream
+)
 ```
 
 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 provide multiple protocols for the same handler. If you have a backwards incompatible change, but it only requires minor changes to the code, you may prefer to do protocol checking instead of having multiple handlers
 
 ```JavaScript
-node2.handle('/custom-match-func', (protocol, conn) => {
-  pull(
-    conn,
-    pull.map((v) => v.toString()),
-    pull.log()
-  )
-}, (myProtocol, requestedProtocol, callback) => {
-  // This is all custom. I'm checking the base path matches, think of this
-  // as a HTTP routing table.
-  if (myProtocol.indexOf(requestedProtocol)) {
-    callback(null, true)
-  } else {
-    callback(null, false)
+node2.handle(['/another-protocol/1.0.0', '/another-protocol/2.0.0'], ({ protocol, stream }) => {
+  if (protocol === '/another-protocol/2.0.0') {
+    // handle backwards compatibility
   }
-})
-// ...
-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)
+
+  pipe(
+    stream,
+    async function (source) {
+      for await (const msg of source) {
+        console.log(msg.toString())
+      }
+    }
+  )
 })
 ```
 
@@ -84,77 +92,68 @@ Try all of this out by executing [1.js](./1.js).
 
 # 2. Reuse existing connection
 
-The example above would require a node to create a whole new connection for every time it dials in one of the protocols, this is a waste of resources and also it might be simply not possible (e.g lack of file descriptors, not enough ports being open, etc). What we really want is to dial a connection once and then multiplex several virtual connections (stream) over a single connection, this is where _stream multiplexing_ comes into play.
+The examples above would require a node to create a whole new connection for every time it dials in one of the protocols, this is a waste of resources and also it might be simply not possible (e.g lack of file descriptors, not enough ports being open, etc). What we really want is to dial a connection once and then multiplex several virtual connections (stream) over a single connection, this is where _stream multiplexing_ comes into play.
 
-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.
+Stream multiplexing is an 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-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.
+Currently, we have [libp2p-mplex](https://github.com/libp2p/js-libp2p-mplex) and pluging it in is as easy as adding a transport. Let's revisit our libp2p configuration.
 
 ```JavaScript
-const SPDY = require('libp2p-spdy')
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
 //...
-class MyBundle extends libp2p {
-  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
-        streamMuxer: [ SPDY ]
-      }
-    }
 
-    super(defaultsDeep(_options, defaults))
-  }
+const createNode = () => {
+  return Libp2p.create({
+    modules: {
+      transport: [ TCP ],
+      streamMuxer: [ Mplex ]
+    }
+  })
 }
 ```
 
 With this, we can dial as many times as we want to a peer and always reuse the same established underlying connection.
 
 ```JavaScript
-node2.handle('/a', (protocol, conn) => {
-  pull(
-    conn,
-    pull.map((v) => v.toString()),
-    pull.log()
+node2.handle(['/a', '/b'], ({ protocol, stream }) => {
+  pipe(
+    stream,
+    async function (source) {
+      for await (const msg of source) {
+        console.log(`from: ${protocol}, msg: ${msg.toString()}`)
+      }
+    }
   )
 })
 
-node2.handle('/b', (protocol, conn) => {
-  pull(
-    conn,
-    pull.map((v) => v.toString()),
-    pull.log()
-  )
-})
+const { stream } = await node1.dialProtocol(node2.peerInfo, ['/a'])
+await pipe(
+  ['protocol (a)'],
+  stream
+)
 
-series([
-  (cb) => node1.dialProtocol(node2.peerInfo, '/a', (err, conn) => {
-    if (err) { throw err }
-    pull(pull.values(['protocol (a)']), conn)
-    cb()
-  }),
-  (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
-    if (err) { throw err }
-    pull(pull.values(['protocol (b)']), conn)
-    cb()
-  }),
-  (cb) => node1.dialProtocol(node2.peerInfo, '/b', (err, conn) => {
-    if (err) { throw err }
-    pull(pull.values(['another conn on protocol (b)']), conn)
-    cb()
-  })
-])
+const { stream: stream2 } = await node1.dialProtocol(node2.peerInfo, ['/b'])
+await pipe(
+  ['protocol (b)'],
+  stream2
+)
+
+const { stream: stream3 } = await node1.dialProtocol(node2.peerInfo, ['/b'])
+await pipe(
+  ['another stream on protocol (b)'],
+  stream3
+)
 ```
 
 By running [2.js](./2.js) you should see the following result:
 
 ```
 > node 2.js
-protocol (a)
-protocol (b)
-another protocol (b)
+from: /a, msg: protocol (a)
+from: /b, msg: protocol (b)
+from: /b, msg: another stream on protocol (b)
 ```
 
 # 3. Bidirectional connections
@@ -168,8 +167,5 @@ You can see this working on example [3.js](./3.js). The result should look like
 ```Bash
 > 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/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,83 +1,51 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
-const MulticastDNS = require('libp2p-mdns')
-const defaultsDeep = require('@nodeutils/defaults-deep')
-const waterfall = require('async/waterfall')
-const parallel = require('async/parallel')
-const series = require('async/series')
+const Gossipsub = require('libp2p-gossipsub')
 
-class MyBundle extends libp2p {
-  constructor (_options) {
-    const defaults = {
-      modules: {
-        transport: [ TCP ],
-        streamMuxer: [ Mplex ],
-        connEncryption: [ SECIO ],
-        peerDiscovery: [ MulticastDNS ]
-      },
-      config: {
-        peerDiscovery: {
-          mdns: {
-            interval: 2000,
-            enabled: true
-          }
-        },
-        EXPERIMENTAL: {
-          pubsub: true
-        }
-      }
+const createNode = async () => {
+  const peerInfo = await PeerInfo.create()
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      streamMuxer: [Mplex],
+      connEncryption: [SECIO],
+      pubsub: Gossipsub
     }
-
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({
-        peerInfo
-      })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-
-  node1.once('peer:connect', (peer) => {
-    console.log('connected to %s', peer.id.toB58String())
-
-    // Subscribe to the topic 'news'
-    node1.pubsub.subscribe('news',
-      (msg) => console.log(msg.from, msg.data.toString()),
-      () => {
-        setInterval(() => {
-          // Publish the message on topic 'news'
-          node2.pubsub.publish(
-            'news',
-            Buffer.from('Bird bird bird, bird is the word!'),
-            () => {}
-          )
-        }, 1000)
-      }
-    )
   })
-})
+
+  await node.start()
+  return node
+}
+
+;(async () => {
+  const topic = 'news'
+
+  const [node1, node2] = await Promise.all([
+    createNode(),
+    createNode(),
+  ])
+
+  await node1.dial(node2.peerInfo)
+
+  await node1.pubsub.subscribe(topic, (msg) => {
+    console.log(`node1 received: ${msg.data.toString()}`)
+  })
+
+  await node2.pubsub.subscribe(topic, (msg) => {
+    console.log(`node2 received: ${msg.data.toString()}`)
+  })
+
+  // node2 publishes "news" every second
+  setInterval(() => {
+    node2.pubsub.publish(topic, Buffer.from('Bird bird bird, bird is the word!'))
+  }, 1000)
+})();

examples/pubsub/README.md

@@ -1,6 +1,6 @@
 # Publish Subscribe
 
-Publish Subscribe is also included on the stack. Currently, we have on PubSub implementation which we ship by default [libp2p-floodsub](https://github.com/libp2p/js-libp2p-floodsub), with 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,39 +12,71 @@ We've seen many interesting use cases appear with this, here are some highlights
 
 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).
 
-Using PubSub is super simple, all you have to do is start a libp2p node with `EXPERIMENTAL.pubsub` set to true.
+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.
+
+First, let's update our libp2p configuration with a pubsub implementation.
 
 ```JavaScript
-node1.once('peer:connect', (peer) => {
-  console.log('connected to %s', peer.id.toB58String())
+const Libp2p = require('libp2p')
+const Gossipsub = require('libp2p-gossipsub')
 
-  // Subscribe to the topic 'news'
-  node1.pubsub.subscribe('news',
-    (msg) => console.log(msg.from, msg.data.toString()),
-    () => {
-      setInterval(() => {
-        // Publish the message on topic 'news'
-        node2.pubsub.publish(
-          'news',
-          Buffer.from('Bird bird bird, bird is the word!'),
-          () => {}
-        )
-      }, 1000)
-    }
-  )
+const node = await Libp2p.create({
+  modules: {
+    transport: [ TCP ],
+    streamMuxer: [ Mplex ],
+    connEncryption: [ SECIO ],
+    // we add the Pubsub module we want
+    pubsub: Gossipsub
+  }
 })
 ```
 
+Once that is done, we only need to create a few libp2p nodes, connect them and everything is ready to start using pubsub.
+
+```JavaScript
+const topic = 'news'
+
+const node1 = nodes[0]
+const node2 = nodes[1]
+
+await node1.dial(node2.peerInfo)
+
+await node1.pubsub.subscribe(topic, (msg) => {
+  console.log(`node1 received: ${msg.data.toString()}`)
+})
+
+await node2.pubsub.subscribe(topic, (msg) => {
+  console.log(`node2 received: ${msg.data.toString()}`)
+})
+
+// node2 publishes "news" every second
+setInterval(() => {
+  node2.pubsub.publish(topic, Buffer.from('Bird bird bird, bird is the word!'))
+}, 1000)
+```
+
 The output of the program should look like:
 
 ```
 > node 1.js
 connected to QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82
-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!
+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: {
+    pubsub: {
+      enabled: true,
+      emitSelf: false
+    }
+  }
+}
 ```
 
 ## 2. Future work

examples/transports/1.js

@@ -1,39 +1,33 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../..')
 const TCP = require('libp2p-tcp')
+const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
-const waterfall = require('async/waterfall')
-const defaultsDeep = require('@nodeutils/defaults-deep')
 
-class MyBundle extends libp2p {
-  constructor (_options) {
-    const defaults = {
-      modules: {
-        transport: [
-          TCP
-        ]
-      }
+const createNode = async (peerInfo) => {
+  // To signall the addresses we want to be available, we use
+  // the multiaddr format, a self describable address
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      connEncryption: [SECIO]
     }
+  })
 
-    super(defaultsDeep(_options, defaults))
-  }
+  await node.start()
+  return node
 }
 
-let node
-
-waterfall([
-  (cb) => PeerInfo.create(cb),
-  (peerInfo, cb) => {
-    peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-    node = new MyBundle({ peerInfo: peerInfo })
-    node.start(cb)
-  }
-], (err) => {
-  if (err) { throw err }
+;(async () => {
+  const peerInfo = await PeerInfo.create()
+  const node = await createNode(peerInfo)
 
   console.log('node has started (true/false):', node.isStarted())
   console.log('listening on:')
   node.peerInfo.multiaddrs.forEach((ma) => console.log(ma.toString()))
-})
+})();

examples/transports/2.js

@@ -1,39 +1,31 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../..')
 const TCP = require('libp2p-tcp')
+const SECIO = require('libp2p-secio')
+const MPLEX = require('libp2p-mplex')
 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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [
-          TCP
-        ]
-      }
+const pipe = require('it-pipe')
+const concat = require('it-concat')
+
+const createNode = async (peerInfo) => {
+  // To signall the addresses we want to be available, we use
+  // the multiaddr format, a self describable address
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [TCP],
+      connEncryption: [SECIO],
+      streamMuxer: [MPLEX]
     }
+  })
 
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({ peerInfo: peerInfo })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
+  await node.start()
+  return node
 }
 
 function printAddrs (node, number) {
@@ -41,29 +33,31 @@ function printAddrs (node, number) {
   node.peerInfo.multiaddrs.forEach((ma) => console.log(ma.toString()))
 }
 
-parallel([
-  (cb) => createNode(cb),
-  (cb) => createNode(cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
+;(async () => {
+  const [peerInfo1, peerInfo2] = await Promise.all([
+    PeerInfo.create(),
+    PeerInfo.create()
+  ])
+  const [node1, node2] = await Promise.all([
+    createNode(peerInfo1),
+    createNode(peerInfo2)
+  ])
 
   printAddrs(node1, '1')
   printAddrs(node2, '2')
 
-  node2.handle('/print', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
+  node2.handle('/print', async ({ stream }) => {
+    const result = await pipe(
+      stream,
+      concat
     )
+    console.log(result.toString())
   })
 
-  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
-    if (err) { throw err }
+  const { stream } = await node1.dialProtocol(node2.peerInfo, '/print')
 
-    pull(pull.values(['Hello', ' ', 'p2p', ' ', 'world', '!']), conn)
-  })
-})
+  await pipe(
+    ['Hello', ' ', 'p2p', ' ', 'world', '!'],
+    stream
+  )
+})();

examples/transports/3.js

@@ -1,70 +1,62 @@
 /* eslint-disable no-console */
 'use strict'
 
-const libp2p = require('../../')
+const Libp2p = require('../..')
 const TCP = require('libp2p-tcp')
 const WebSockets = require('libp2p-websockets')
+const SECIO = require('libp2p-secio')
+const MPLEX = require('libp2p-mplex')
 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 (_options) {
-    const defaults = {
-      modules: {
-        transport: [
-          TCP,
-          WebSockets
-        ]
-      }
-    }
+const pipe = require('it-pipe')
 
-    super(defaultsDeep(_options, defaults))
-  }
-}
-
-function createNode (addrs, callback) {
-  if (!Array.isArray(addrs)) {
-    addrs = [addrs]
+const createNode = async (peerInfo, transports, multiaddrs = []) => {
+  if (!Array.isArray(multiaddrs)) {
+    multiaddrs = [multiaddrs]
   }
 
-  let node
+  multiaddrs.forEach((addr) => peerInfo.multiaddrs.add(addr))
 
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      addrs.forEach((addr) => peerInfo.multiaddrs.add(addr))
-      node = new MyBundle({ peerInfo: peerInfo })
-      node.start(cb)
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: transports,
+      connEncryption: [SECIO],
+      streamMuxer: [MPLEX]
     }
-  ], (err) => callback(err, node))
+  })
+
+  await node.start()
+  return node
 }
 
-function printAddrs (node, number) {
+function printAddrs(node, number) {
   console.log('node %s is listening on:', number)
   node.peerInfo.multiaddrs.forEach((ma) => console.log(ma.toString()))
 }
 
-function print (protocol, conn) {
-  pull(
-    conn,
-    pull.map((v) => v.toString()),
-    pull.log()
+function print ({ stream }) {
+  pipe(
+    stream,
+    async function (source) {
+      for await (const msg of source) {
+        console.log(msg.toString())
+      }
+    }
   )
 }
 
-parallel([
-  (cb) => createNode('/ip4/0.0.0.0/tcp/0', cb),
-  (cb) => createNode(['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws'], cb),
-  (cb) => createNode('/ip4/127.0.0.1/tcp/20000/ws', cb)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-  const node3 = nodes[2]
+;(async () => {
+  const [peerInfo1, peerInfo2, peerInfo3] = await Promise.all([
+    PeerInfo.create(),
+    PeerInfo.create(),
+    PeerInfo.create()
+  ])
+  const [node1, node2, node3] = await Promise.all([
+    createNode(peerInfo1, [TCP], '/ip4/0.0.0.0/tcp/0'),
+    createNode(peerInfo2, [TCP, WebSockets], ['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws']),
+    createNode(peerInfo3, [WebSockets], '/ip4/127.0.0.1/tcp/20000/ws')
+  ])
 
   printAddrs(node1, '1')
   printAddrs(node2, '2')
@@ -74,21 +66,24 @@ parallel([
   node2.handle('/print', print)
   node3.handle('/print', print)
 
-  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
-    if (err) { throw err }
+  // node 1 (TCP) dials to node 2 (TCP+WebSockets)
+  const { stream } = await node1.dialProtocol(node2.peerInfo, '/print')
+  await pipe(
+    ['node 1 dialed to node 2 successfully'],
+    stream
+  )
 
-    pull(pull.values(['node 1 dialed to node 2 successfully']), conn)
-  })
+  // node 2 (TCP+WebSockets) dials to node 2 (WebSockets)
+  const { stream: stream2 } = await node2.dialProtocol(node3.peerInfo, '/print')
+  await pipe(
+    ['node 2 dialed to node 3 successfully'],
+    stream2
+  )
 
-  node2.dialProtocol(node3.peerInfo, '/print', (err, conn) => {
-    if (err) { throw err }
-
-    pull(pull.values(['node 2 dialed to node 3 successfully']), conn)
-  })
-
-  node3.dialProtocol(node1.peerInfo, '/print', (err, conn) => {
-    if (err) {
-      console.log('node 3 failed to dial to node 1 with:', err.message)
-    }
-  })
-})
+  // node 3 (listening WebSockets) can dial node 1 (TCP)
+  try {
+    await node3.dialProtocol(node1.peerInfo, '/print')
+  } catch (err) {
+    console.log('node 3 failed to dial to node 1 with:', err.message)
+  }
+})();

examples/transports/README.md

@@ -1,85 +1,65 @@
 # [Transports](http://libp2p.io/implementations/#transports)
 
-libp2p doesn't make assumptions for you, instead, it enables you as the developer of the application to pick the modules you need to run your application, which can vary depending on the runtime you are executing. A libp2p node can use one or more Transports to dial and listen for Connections. These transports are modules that offer a clean interface for dialing and listening, defined by the [interface-transport](https://github.com/libp2p/interface-transport) specification. Some examples of possible transports are: TCP, UTP, WebRTC, QUIC, HTTP, Pigeon and so on.
+libp2p doesn't make assumptions for you, instead, it enables you as the developer of the application to pick the modules you need to run your application, which can vary depending on the runtime you are executing. A libp2p node can use one or more Transports to dial and listen for Connections. These transports are modules that offer a clean interface for dialing and listening, defined by the [interface-transport](https://github.com/libp2p/js-interfaces/tree/master/src/transport) specification. Some examples of possible transports are: TCP, UTP, WebRTC, QUIC, HTTP, Pigeon and so on.
 
-A more complete definition of what is a transport can be found on the [interface-transport](https://github.com/libp2p/interface-transport) specification. A way to recognize a candidate transport is through the badge:
+A more complete definition of what is a transport can be found on the [interface-transport](https://github.com/libp2p/js-interfaces/tree/master/src/transport) specification. A way to recognize a candidate transport is through the badge:
 
 [![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)
 
-## 1. Creating a libp2p Bundle with TCP
+## 1. Creating a libp2p node with TCP
 
-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).
+When using libp2p, you need properly configure it, that is, pick your set of modules and create your network stack with the properties you need. In this example, we will create a libp2p node TCP. You can find the complete solution on the file [1.js](./1.js).
 
-You will need 5 deps total, so go ahead and install all of them with:
+You will need 4 dependencies total, so go ahead and install all of them with:
 
 ```bash
-> npm install libp2p libp2p-tcp peer-info async @nodeutils/defaults-deep
+> npm install libp2p libp2p-tcp libp2p-secio peer-info
 ```
 
 Then, on your favorite text editor create a file with the `.js` extension. I've called mine `1.js`.
 
-First thing is to create our own bundle! Insert:
+First thing is to create our own libp2p node! Insert:
 
 ```JavaScript
 'use strict'
 
-const libp2p = require('libp2p')
+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')
+const SECIO = require('libp2p-secio')
 
-// This MyBundle class is your libp2p bundle packed with TCP
-class MyBundle extends libp2p {
-  constructor (_options) {
-    const defaults = {
-      // modules is a JS object that will describe the components
-      // we want for our libp2p bundle
-      modules: {
-        transport: [
-          TCP
-        ]
-      }
+const createNode = async (peerInfo) => {
+  // To signall the addresses we want to be available, we use
+  // the multiaddr format, a self describable address
+  peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: [ TCP ],
+      connEncryption: [ SECIO ]
     }
+  })
 
-    super(defaultsDeep(_options, defaults))
-  }
+  await node.start()
+  return node
 }
 ```
 
-Now that we have our own MyBundle class that extends libp2p, let's create a node with it. We will use `async/waterfall` just for code structure, but you don't need to. Append to the same file:
+Now that we have a function to create our own libp2p node, let's create a node with it.
 
 ```JavaScript
-let node
+const peerInfo = await PeerInfo.create()
+const node = await createNode(peerInfo)
 
-waterfall([
-  // First we create a PeerInfo object, which will pack the
-  // info about our peer. Creating a PeerInfo is an async
-  // operation because we use the WebCrypto API
-  // (yeei Universal JS)
-  (cb) => PeerInfo.create(cb),
-  (peerInfo, cb) => {
-    // To signall the addresses we want to be available, we use
-    // 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: peerInfo })
-    // Last, we start the node!
-    node.start(cb)
-  }
-], (err) => {
-  if (err) { throw err }
-
-  // At this point the node has started
-  console.log('node has started (true/false):', node.isStarted())
-  // And we can print the now listening addresses.
-  // If you are familiar with TCP, you might have noticed
-  // that we specified the node to listen in 0.0.0.0 and port
-  // 0, which means "listen in any network interface and pick
-  // a port for me
-  console.log('listening on:')
-  node.peerInfo.multiaddrs.forEach((ma) => console.log(ma.toString()))
-})
+// At this point the node has started
+console.log('node has started (true/false):', node.isStarted())
+// And we can print the now listening addresses.
+// If you are familiar with TCP, you might have noticed
+// that we specified the node to listen in 0.0.0.0 and port
+// 0, which means "listen in any network interface and pick
+// a port for me
+console.log('listening on:')
+node.peerInfo.multiaddrs.forEach((ma) => console.log(ma.toString()))
 ```
 
 Running this should result in something like:
@@ -96,78 +76,64 @@ That `QmW2cKTakTYqbQkUzBTEGXgWYFj1YEPeUndE1YWs6CBzDQ` is the PeerId that was cre
 
 ## 2. Dialing from one node to another node
 
-Now that we have our bundle, let's create two nodes and make them dial to each other! You can find the complete solution at [2.js](./2.js).
+Now that we have our `createNode` function, let's create two nodes and make them dial to each other! You can find the complete solution at [2.js](./2.js).
 
 For this step, we will need one more dependency.
 
 ```bash
-> npm install pull-stream
+> npm install it-pipe it-buffer
 ```
 
 And we also need to import the module on our .js file:
 
 ```js
-const pull = require('pull-stream')
+const pipe = require('it-pipe')
+const { toBuffer } = require('it-buffer')
 ```
 
-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.
+We are going to reuse the `createNode` function from step 1, but this time to make things simpler, we will create another function to print the addrs to avoid duplicating code.
 
 ```JavaScript
-function createNode (callback) {
-  let node
-
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle({ peerInfo: peerInfo })
-      node.start(cb)
-    }
-  ], (err) => callback(err, node))
-}
-
 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. 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)
-], (err, nodes) => {
-  if (err) { throw err }
-
-  const node1 = nodes[0]
-  const node2 = nodes[1]
+;(async () => {
+  const [peerInfo1, peerInfo2] = await Promise.all([
+    PeerInfo.create(),
+    PeerInfo.create()
+  ])
+  const [node1, node2] = await Promise.all([
+    createNode(),
+    createNode()
+  ])
 
   printAddrs(node1, '1')
   printAddrs(node2, '2')
 
-  node2.handle('/print', (protocol, conn) => {
-    pull(
-      conn,
-      pull.map((v) => v.toString()),
-      pull.log()
+  node2.handle('/print', ({ stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
+      }
     )
   })
 
-  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
-    if (err) { throw err }
+  const { stream } = await node1.dialProtocol(node2.peerInfo, '/print')
 
-    pull(pull.values(['Hello', ' ', 'p2p', ' ', 'world', '!']), conn)
-  })
-})
+  await pipe(
+    ['Hello', ' ', 'p2p', ' ', 'world', '!'],
+    stream
+  )
+})();
 ```
 
 The result should be look like:
@@ -195,46 +161,28 @@ In this example, we will need to also install `libp2p-websockets`, go ahead and
 > npm install libp2p-websockets
 ```
 
-We want to create 3 nodes, one with TCP, one with TCP+WebSockets and one with just WebSockets. We need to update our `MyBundle` class to contemplate WebSockets as well:
+We want to create 3 nodes, one with TCP, one with TCP+WebSockets and one with just WebSockets. We need to update our `createNode` function to contemplate WebSockets as well. Moreover, let's upgrade our function to enable us to pick the addrs in which a node will start a listener:
 
 ```JavaScript
-const WebSockets = require('libp2p-websockets')
 // ...
 
-class MyBundle extends libp2p {
-  constructor (_options) {
-    const defaults = {
-      modules: {
-        transport: [
-          TCP,
-          WebSockets
-        ]
-      }
-    }
-
-    super(defaultsDeep(_options, defaults))
-  }
-}
-```
-
-Now that we have our bundle ready, let's upgrade our createNode function to enable us to pick the addrs in which a node will start a listener.
-
-```JavaScript
-function createNode (addrs, callback) {
-  if (!Array.isArray(addrs)) {
-    addrs = [addrs]
+const createNode = async (peerInfo, transports, multiaddrs = []) => {
+  if (!Array.isArray(multiaddrs)) {
+    multiaddrs = [multiaddrs]
   }
 
-  let node
+  multiaddrs.forEach((addr) => peerInfo.multiaddrs.add(addr))
 
-  waterfall([
-    (cb) => PeerInfo.create(cb),
-    (peerInfo, cb) => {
-      addrs.forEach((addr) => peerInfo.multiaddrs.add(addr))
-      node = new MyBundle({ peerInfo: peerInfo })
-      node.start(cb)
+  const node = await Libp2p.create({
+    peerInfo,
+    modules: {
+      transport: transports,
+      connEncryption: [ SECIO ]
     }
-  ], (err) => callback(err, node))
+  })
+
+  await node.start()
+  return node
 }
 ```
 
@@ -243,58 +191,61 @@ As a rule, a libp2p node will only be capable of using a transport if: a) it has
 Let's update our flow to create nodes and see how they behave when dialing to each other:
 
 ```JavaScript
-parallel([
-  (cb) => createNode('/ip4/0.0.0.0/tcp/0', cb),
-  // Here we add an extra multiaddr that has a /ws at the end, this means that we want
-  // to create a TCP socket, but mount it as WebSockets instead.
-  (cb) => createNode(['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws'], cb),
-  (cb) => createNode('/ip4/127.0.0.1/tcp/20000/ws', cb)
-], (err, nodes) => {
-  if (err) { throw err }
+const WebSockets = require('libp2p-websockets')
+const TCP = require('libp2p-tcp')
 
-  const node1 = nodes[0]
-  const node2 = nodes[1]
-  const node3 = nodes[2]
+const [peerInfo1, peerInfo2, peerInfo3] = await Promise.all([
+  PeerInfo.create(),
+  PeerInfo.create(),
+  PeerInfo.create()
+])
+const [node1, node2, node3] = await Promise.all([
+  createNode(peerInfo1, [TCP], '/ip4/0.0.0.0/tcp/0'),
+  createNode(peerInfo2, [TCP, WebSockets], ['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws']),
+  createNode(peerInfo3, [WebSockets], '/ip4/127.0.0.1/tcp/20000/ws')
+])
 
-  printAddrs(node1, '1')
-  printAddrs(node2, '2')
-  printAddrs(node3, '3')
+printAddrs(node1, '1')
+printAddrs(node2, '2')
+printAddrs(node3, '3')
 
-  node1.handle('/print', print)
-  node2.handle('/print', print)
-  node3.handle('/print', print)
+node1.handle('/print', print)
+node2.handle('/print', print)
+node3.handle('/print', print)
 
-  // node 1 (TCP) dials to node 2 (TCP+WebSockets)
-  node1.dialProtocol(node2.peerInfo, '/print', (err, conn) => {
-    if (err) { throw err }
+// node 1 (TCP) dials to node 2 (TCP+WebSockets)
+const { stream } = await node1.dialProtocol(node2.peerInfo, '/print')
+await pipe(
+  ['node 1 dialed to node 2 successfully'],
+  stream
+)
 
-    pull(pull.values(['node 1 dialed to node 2 successfully']), conn)
-  })
+// node 2 (TCP+WebSockets) dials to node 2 (WebSockets)
+const { stream: stream2 } = await node2.dialProtocol(node3.peerInfo, '/print')
+await pipe(
+  ['node 2 dialed to node 3 successfully'],
+  stream2
+)
 
-  // node 2 (TCP+WebSockets) dials to node 2 (WebSockets)
-  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.dialProtocol(node1.peerInfo, '/print', (err, conn) => {
-    if (err) {
-      console.log('node 3 failed to dial to node 1 with:', err.message)
-    }
-  })
-})
+// node 3 (WebSockets) attempts to dial to node 1 (TCP)
+try {
+  await node3.dialProtocol(node1.peerInfo, '/print')
+} catch (err) {
+  console.log('node 3 failed to dial to node 1 with:', err.message)
+}
 ```
 
 `print` is a function created using the code from 2.js, but factored into its own function to save lines, here it is:
 
 ```JavaScript
-function print (protocol, conn) {
-  pull(
-    conn,
-    pull.map((v) => v.toString()),
-    pull.log()
+function print ({ stream }) {
+  pipe(
+    stream,
+    async function (source) {
+      for await (const msg of source) {
+        console.log(msg.toString())
+      }
+    }
   )
 }
 ```
@@ -312,18 +263,19 @@ node 2 is listening on:
 /ip4/192.168.2.156/tcp/62619/p2p/QmWAQtWdzWXibgfyc7WRHhhv6MdqVKzXvyfSTnN2aAvixX
 node 3 is listening on:
 /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
+node 3 failed to dial to node 1 with:
+    Error: No transport available for address /ip4/127.0.0.1/tcp/51482
 ```
 
 As expected, we created 3 nodes, node 1 with TCP, node 2 with TCP+WebSockets and node 3 with just WebSockets. node 1 -> node 2 and node 2 -> node 3 managed to dial correctly because they shared a common transport, however, node 3 -> node 1 failed because they didn't share any.
 
 ## 4. How to create a new libp2p transport
 
-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.
+Today there are already several transports available and plenty to come, you can find these at [interface-transport implementations](https://github.com/libp2p/js-interfaces/tree/master/src/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 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.
+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/js-interfaces/tree/master/src/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.
 

package-list.json

@@ -3,40 +3,34 @@
     "Package",
     "Version",
     "Deps",
-    "CI/Travis",
+    "CI",
     "Coverage",
     "Lead Maintainer"
   ],
   "rows": [
-    "Libp2p",
-    ["libp2p/interface-libp2p", "interface-libp2p"],
+    "libp2p",
     ["libp2p/js-libp2p", "libp2p"],
+    ["libp2p/js-libp2p-daemon", "libp2p-daemon"],
+    ["libp2p/js-libp2p-daemon-client", "libp2p-daemon-client"],
+    ["libp2p/js-interfaces", "libp2p-interfaces"],
+    ["libp2p/interop", "interop-libp2p"],
 
-    "Connection",
-    ["libp2p/interface-connection", "interface-connection"],
-
-    "Transport",
-    ["libp2p/interface-transport", "interface-transport"],
+    "transports",
     ["libp2p/js-libp2p-tcp", "libp2p-tcp"],
-    ["libp2p/js-libp2p-udp", "libp2p-udp"],
-    ["libp2p/js-libp2p-udt", "libp2p-udt"],
     ["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"],
-    ["libp2p/js-libp2p-websocket-star-rendezvous", "libp2p-websocket-star-rendezvous"],
 
-    "Crypto Channels",
+    "secure channels",
     ["libp2p/js-libp2p-secio", "libp2p-secio"],
 
-    "Stream Muxers",
-    ["libp2p/interface-stream-muxer", "interface-stream-muxer"],
+    "stream multiplexers",
     ["libp2p/js-libp2p-mplex", "libp2p-mplex"],
     ["libp2p/js-libp2p-spdy", "libp2p-spdy"],
 
-    "Discovery",
-    ["libp2p/interface-peer-discovery", "interface-peer-discovery"],
+    "peer discovery",
     ["libp2p/js-libp2p-bootstrap", "libp2p-bootstrap"],
     ["libp2p/js-libp2p-kad-dht", "libp2p-kad-dht"],
     ["libp2p/js-libp2p-mdns", "libp2p-mdns"],
@@ -44,43 +38,29 @@
     ["libp2p/js-libp2p-webrtc-star", "libp2p-webrtc-star"],
     ["libp2p/js-libp2p-websocket-star", "libp2p-websocket-star"],
 
-    "NAT Traversal",
-    ["libp2p/js-libp2p-circuit", "libp2p-circuit"],
-    ["libp2p/js-libp2p-nat-mngr", "libp2p-nat-mngr"],
-
-    "Data Types",
-    ["libp2p/js-peer-book", "peer-book"],
-    ["libp2p/js-peer-id", "peer-id"],
-    ["libp2p/js-peer-info", "peer-info"],
-
-    "Content Routing",
-    ["libp2p/interface-content-routing", "interface-content-routing"],
+    "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"],
+    "peer routing",
     ["libp2p/js-libp2p-delegated-peer-routing", "libp2p-delegated-peer-routing"],
     ["libp2p/js-libp2p-kad-dht", "libp2p-kad-dht"],
 
-    "Record Store",
-    ["libp2p/interface-record-store", "interface-record-store"],
-    ["libp2p/js-libp2p-record", "libp2p-record"],
-
-    "Generics",
-    ["libp2p/js-libp2p-connection-manager", "libp2p-connection-manager"],
+    "utilities",
     ["libp2p/js-libp2p-crypto", "libp2p-crypto"],
     ["libp2p/js-libp2p-crypto-secp256k1", "libp2p-crypto-secp256k1"],
-    ["libp2p/js-libp2p-switch", "libp2p-switch"],
 
-    "Extensions",
+    "data types",
+    ["libp2p/js-peer-id", "peer-id"],
+    ["libp2p/js-peer-info", "peer-info"],
+
+    "pubsub",
+    ["libp2p/js-libp2p-pubsub", "libp2p-pubsub"],
     ["libp2p/js-libp2p-floodsub", "libp2p-floodsub"],
-    ["libp2p/js-libp2p-identify", "libp2p-identify"],
-    ["libp2p/js-libp2p-keychain", "libp2p-keychain"],
-    ["libp2p/js-libp2p-ping", "libp2p-ping"],
-    ["libp2p/js-libp2p-pnet", "libp2p-pnet"],
+    ["ChainSafe/gossipsub-js", "libp2p-gossipsub"],
 
-    "Utilities",
-    ["libp2p/js-p2pcat", "p2pcat"]
+    "extensions",
+    ["libp2p/js-libp2p-nat-mgnr", "libp2p-nat-mgnr"],
+    ["libp2p/js-libp2p-utils", "libp2p-utils"]
   ]
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.26.0-rc.1",
+  "version": "0.27.2",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -11,12 +11,13 @@
   "scripts": {
     "lint": "aegir lint",
     "build": "aegir build",
-    "test": "aegir test -t node -t browser",
-    "test:node": "aegir test -t node",
+    "test": "npm run test:node && npm run test:browser",
+    "test:node": "aegir test -t node -f \"./test/**/*.{node,spec}.js\"",
     "test:browser": "aegir test -t browser",
     "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"
+    "release-major": "aegir release --type major -t node -t browser",
+    "coverage": "nyc --reporter=text --reporter=lcov npm run test:node"
   },
   "repository": {
     "type": "git",
@@ -35,63 +36,75 @@
   },
   "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.2",
+    "abort-controller": "^3.0.0",
+    "aggregate-error": "^3.0.1",
+    "any-signal": "^1.1.0",
+    "bignumber.js": "^9.0.0",
+    "class-is": "^1.1.0",
     "debug": "^4.1.1",
-    "err-code": "^1.1.2",
-    "fsm-event": "^2.1.0",
-    "libp2p-connection-manager": "^0.1.0",
-    "libp2p-ping": "^0.8.5",
-    "libp2p-switch": "^0.42.12",
-    "libp2p-websockets": "^0.12.2",
-    "mafmt": "^6.0.7",
-    "multiaddr": "^6.1.0",
-    "once": "^1.4.0",
-    "peer-book": "^0.9.1",
-    "peer-id": "^0.12.2",
-    "peer-info": "^0.15.1",
-    "promisify-es6": "^1.0.3",
-    "superstruct": "^0.6.0"
+    "err-code": "^2.0.0",
+    "hashlru": "^2.3.0",
+    "it-all": "^1.0.1",
+    "it-buffer": "^0.1.1",
+    "it-handshake": "^1.0.1",
+    "it-length-prefixed": "^3.0.0",
+    "it-pipe": "^1.1.0",
+    "it-protocol-buffers": "^0.2.0",
+    "latency-monitor": "~0.2.1",
+    "libp2p-crypto": "^0.17.1",
+    "libp2p-interfaces": "^0.2.3",
+    "mafmt": "^7.0.0",
+    "merge-options": "^2.0.0",
+    "moving-average": "^1.0.0",
+    "multiaddr": "^7.2.1",
+    "multistream-select": "^0.15.0",
+    "mutable-proxy": "^1.0.0",
+    "p-any": "^2.1.0",
+    "p-fifo": "^1.0.0",
+    "p-settle": "^3.1.0",
+    "peer-id": "^0.13.4",
+    "peer-info": "^0.17.0",
+    "protons": "^1.0.1",
+    "retimer": "^2.0.0",
+    "timeout-abort-controller": "^1.0.0",
+    "xsalsa20": "^1.0.2"
   },
   "devDependencies": {
     "@nodeutils/defaults-deep": "^1.1.0",
-    "aegir": "^20.0.0",
+    "abortable-iterator": "^3.0.0",
+    "aegir": "^20.5.1",
     "chai": "^4.2.0",
-    "chai-checkmark": "^1.0.1",
+    "chai-as-promised": "^7.1.1",
     "cids": "^0.7.1",
+    "delay": "^4.3.0",
     "dirty-chai": "^2.0.1",
-    "electron-webrtc": "^0.3.0",
-    "interface-datastore": "^0.6.0",
-    "libp2p-bootstrap": "^0.9.7",
-    "libp2p-circuit": "^0.3.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-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.3.0",
-    "lodash.times": "^4.3.2",
-    "merge-options": "^1.0.1",
-    "nock": "^10.0.6",
-    "pull-goodbye": "0.0.2",
-    "pull-mplex": "^0.1.2",
-    "pull-serializer": "^0.3.2",
-    "pull-stream": "^3.6.12",
-    "sinon": "^7.2.7",
+    "it-concat": "^1.0.0",
+    "it-pair": "^1.0.0",
+    "it-pushable": "^1.4.0",
+    "interop-libp2p": "~0.0.1",
+    "libp2p-bootstrap": "^0.10.3",
+    "libp2p-delegated-content-routing": "^0.4.1",
+    "libp2p-delegated-peer-routing": "^0.4.0",
+    "libp2p-floodsub": "^0.20.0",
+    "libp2p-gossipsub": "^0.2.0",
+    "libp2p-kad-dht": "^0.18.2",
+    "libp2p-mdns": "^0.13.0",
+    "libp2p-mplex": "^0.9.1",
+    "libp2p-secio": "^0.12.1",
+    "libp2p-tcp": "^0.14.1",
+    "libp2p-webrtc-star": "^0.17.0",
+    "libp2p-websockets": "^0.13.1",
+    "nock": "^11.7.2",
+    "p-defer": "^3.0.0",
+    "p-times": "^2.1.0",
+    "p-wait-for": "^3.1.0",
+    "sinon": "^8.1.0",
+    "streaming-iterables": "^4.1.0",
     "wrtc": "^0.4.1"
   },
   "contributors": [
@@ -100,13 +113,16 @@
     "Alan Shaw <alan@tableflip.io>",
     "Alex Potsides <alex@achingbrain.net>",
     "Andrew Nesbitt <andrewnez@gmail.com>",
+    "Cayman <caymannava@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>",
+    "Didrik Nordström <didrik.nordstrom@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>",
@@ -138,10 +154,16 @@
     "Volker Mische <volker.mische@gmail.com>",
     "Yusef Napora <yusef@napora.org>",
     "Zane Starr <zcstarr@gmail.com>",
+    "a1300 <a1300@users.noreply.github.com>",
+    "dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>",
+    "dirkmc <dirkmdev@gmail.com>",
     "ebinks <elizabethjbinks@gmail.com>",
     "greenkeeperio-bot <support@greenkeeper.io>",
     "isan_rivkin <isanrivkin@gmail.com>",
     "mayerwin <mayerwin@users.noreply.github.com>",
+    "phillmac <phillmac@users.noreply.github.com>",
+    "shresthagrawal <34920931+shresthagrawal@users.noreply.github.com>",
+    "swedneck <40505480+swedneck@users.noreply.github.com>",
     "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
   ]
 }

pdd/README.md

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

pdd/package.json

@@ -1,20 +0,0 @@
-{
-  "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

@@ -1,104 +0,0 @@
-'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

@@ -1,98 +0,0 @@
-'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

@@ -1,54 +0,0 @@
-'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

@@ -1,49 +0,0 @@
-'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

@@ -1,54 +0,0 @@
-'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

@@ -1,49 +0,0 @@
-'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

@@ -1,42 +0,0 @@
-'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

@@ -1,42 +0,0 @@
-'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,133 @@
+# js-libp2p-circuit
+
+> Node.js implementation of the Circuit module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/js-interfaces/tree/master/src/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
+
+- [js-libp2p-circuit](#js-libp2p-circuit)
+    - [Why?](#why)
+    - [libp2p-circuit and IPFS](#libp2p-circuit-and-ipfs)
+  - [Table of Contents](#table-of-contents)
+  - [Usage](#usage)
+    - [Example](#example)
+      - [Create dialer/listener](#create-dialerlistener)
+      - [Create `relay`](#create-relay)
+  - [API](#api)
+    - [Implementation rational](#implementation-rational)
+
+## 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/p2p/QmHash') // dial /p2p/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
+```
+
+## 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/p2p/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/hop.js

@@ -0,0 +1,136 @@
+'use strict'
+
+const debug = require('debug')
+const PeerInfo = require('peer-info')
+const PeerId = require('peer-id')
+const { validateAddrs } = require('./utils')
+const StreamHandler = require('./stream-handler')
+const { CircuitRelay: CircuitPB } = require('../protocol')
+const pipe = require('it-pipe')
+const errCode = require('err-code')
+const { codes: Errors } = require('../../errors')
+
+const { stop } = require('./stop')
+
+const multicodec = require('./../multicodec')
+
+const log = debug('libp2p:circuit:hop')
+log.error = debug('libp2p:circuit:hop:error')
+
+module.exports.handleHop = async function handleHop ({
+  connection,
+  request,
+  streamHandler,
+  circuit
+}) {
+  // Ensure hop is enabled
+  if (!circuit._options.hop.enabled) {
+    log('HOP request received but we are not acting as a relay')
+    return streamHandler.end({
+      type: CircuitPB.Type.STATUS,
+      code: CircuitPB.Status.HOP_CANT_SPEAK_RELAY
+    })
+  }
+
+  // Validate the HOP request has the required input
+  try {
+    validateAddrs(request, streamHandler)
+  } catch (err) {
+    return log.error('invalid hop request via peer %s', connection.remotePeer.toB58String(), err)
+  }
+
+  // Get the connection to the destination (stop) peer
+  const destinationPeer = new PeerId(request.dstPeer.id)
+
+  const destinationConnection = circuit._registrar.getConnection(new PeerInfo(destinationPeer))
+  if (!destinationConnection && !circuit._options.hop.active) {
+    log('HOP request received but we are not connected to the destination peer')
+    return streamHandler.end({
+      type: CircuitPB.Type.STATUS,
+      code: CircuitPB.Status.HOP_NO_CONN_TO_DST
+    })
+  }
+
+  // TODO: Handle being an active relay
+
+  // Handle the incoming HOP request by performing a STOP request
+  const stopRequest = {
+    type: CircuitPB.Type.STOP,
+    dstPeer: request.dstPeer,
+    srcPeer: request.srcPeer
+  }
+
+  let destinationStream
+  try {
+    destinationStream = await stop({
+      connection: destinationConnection,
+      request: stopRequest,
+      circuit
+    })
+  } catch (err) {
+    return log.error(err)
+  }
+
+  log('hop request from %s is valid', connection.remotePeer.toB58String())
+  streamHandler.write({
+    type: CircuitPB.Type.STATUS,
+    code: CircuitPB.Status.SUCCESS
+  })
+  const sourceStream = streamHandler.rest()
+
+  // Short circuit the two streams to create the relayed connection
+  return pipe(
+    sourceStream,
+    destinationStream,
+    sourceStream
+  )
+}
+
+/**
+ * Performs a HOP request to a relay peer, to request a connection to another
+ * peer. A new, virtual, connection will be created between the two via the relay.
+ *
+ * @param {object} options
+ * @param {Connection} options.connection Connection to the relay
+ * @param {*} options.request
+ * @param {Circuit} options.circuit
+ * @returns {Promise<Connection>}
+ */
+module.exports.hop = async function hop ({
+  connection,
+  request
+}) {
+  // Create a new stream to the relay
+  const { stream } = await connection.newStream([multicodec.relay])
+  // Send the HOP request
+  const streamHandler = new StreamHandler({ stream })
+  streamHandler.write(request)
+
+  const response = await streamHandler.read()
+
+  if (response.code === CircuitPB.Status.SUCCESS) {
+    log('hop request was successful')
+    return streamHandler.rest()
+  }
+
+  log('hop request failed with code %d, closing stream', response.code)
+  streamHandler.close()
+  throw errCode(new Error(`HOP request failed with code ${response.code}`), Errors.ERR_HOP_REQUEST_FAILED)
+}
+
+/**
+ * Creates an unencoded CAN_HOP response based on the Circuits configuration
+ * @private
+ */
+module.exports.handleCanHop = function handleCanHop ({
+  connection,
+  streamHandler,
+  circuit
+}) {
+  const canHop = circuit._options.hop.enabled
+  log('can hop (%s) request from %s', canHop, connection.remotePeer.toB58String())
+  streamHandler.end({
+    type: CircuitPB.Type.STATUS,
+    code: canHop ? CircuitPB.Status.SUCCESS : CircuitPB.Status.HOP_CANT_SPEAK_RELAY
+  })
+}

src/circuit/circuit/stop.js

@@ -0,0 +1,69 @@
+'use strict'
+
+const { CircuitRelay: CircuitPB } = require('../protocol')
+const multicodec = require('../multicodec')
+const StreamHandler = require('./stream-handler')
+const { validateAddrs } = require('./utils')
+
+const debug = require('debug')
+const log = debug('libp2p:circuit:stop')
+log.error = debug('libp2p:circuit:stop:error')
+
+/**
+ * Handles incoming STOP requests
+ *
+ * @private
+ * @param {*} options
+ * @param {Connection} options.connection
+ * @param {*} options.request The CircuitRelay protobuf request (unencoded)
+ * @param {StreamHandler} options.streamHandler
+ * @returns {Promise<*>} Resolves a duplex iterable
+ */
+module.exports.handleStop = function handleStop ({
+  connection,
+  request,
+  streamHandler
+}) {
+  // Validate the STOP request has the required input
+  try {
+    validateAddrs(request, streamHandler)
+  } catch (err) {
+    return log.error('invalid stop request via peer %s', connection.remotePeer.toB58String(), err)
+  }
+
+  // The request is valid
+  log('stop request is valid')
+  streamHandler.write({
+    type: CircuitPB.Type.STATUS,
+    code: CircuitPB.Status.SUCCESS
+  })
+  return streamHandler.rest()
+}
+
+/**
+ * Creates a STOP request
+ * @private
+ * @param {*} options
+ * @param {Connection} options.connection
+ * @param {*} options.request The CircuitRelay protobuf request (unencoded)
+ * @returns {Promise<*>} Resolves a duplex iterable
+ */
+module.exports.stop = async function stop ({
+  connection,
+  request
+}) {
+  const { stream } = await connection.newStream([multicodec.relay])
+  log('starting stop request to %s', connection.remotePeer.toB58String())
+  const streamHandler = new StreamHandler({ stream })
+
+  streamHandler.write(request)
+  const response = await streamHandler.read()
+
+  if (response.code === CircuitPB.Status.SUCCESS) {
+    log('stop request to %s was successful', connection.remotePeer.toB58String())
+    return streamHandler.rest()
+  }
+
+  log('stop request failed with code %d', response.code)
+  streamHandler.close()
+}

src/circuit/circuit/stream-handler.js

@@ -0,0 +1,80 @@
+'use strict'
+
+const lp = require('it-length-prefixed')
+const handshake = require('it-handshake')
+const { CircuitRelay: CircuitPB } = require('../protocol')
+
+const debug = require('debug')
+const log = debug('libp2p:circuit:stream-handler')
+log.error = debug('libp2p:circuit:stream-handler:error')
+
+class StreamHandler {
+  /**
+   * Create a stream handler for connection
+   *
+   * @param {object} options
+   * @param {*} options.stream - A duplex iterable
+   * @param {Number} options.maxLength - max bytes length of message
+   */
+  constructor ({ stream, maxLength = 4096 }) {
+    this.stream = stream
+
+    this.shake = handshake(this.stream)
+    this.decoder = lp.decode.fromReader(this.shake.reader, { maxDataLength: maxLength })
+  }
+
+  /**
+   * Read and decode message
+   * @async
+   * @returns {void}
+   */
+  async read () {
+    const msg = await this.decoder.next()
+    if (msg.value) {
+      const value = CircuitPB.decode(msg.value.slice())
+      log('read message type', value.type)
+      return value
+    }
+
+    log('read received no value, closing stream')
+    // End the stream, we didn't get data
+    this.close()
+  }
+
+  /**
+   * Encode and write array of buffers
+   *
+   * @param {*} msg An unencoded CircuitRelay protobuf message
+   */
+  write (msg) {
+    log('write message type %s', msg.type)
+    this.shake.write(lp.encode.single(CircuitPB.encode(msg)))
+  }
+
+  /**
+   * Return the handshake rest stream and invalidate handler
+   *
+   * @return {*} A duplex iterable
+   */
+  rest () {
+    this.shake.rest()
+    return this.shake.stream
+  }
+
+  end (msg) {
+    this.write(msg)
+    this.close()
+  }
+
+  /**
+   * Close the stream
+   *
+   * @returns {void}
+   */
+  close () {
+    log('closing the stream')
+    this.rest().sink([])
+  }
+}
+
+module.exports = StreamHandler

src/circuit/circuit/utils.js

@@ -0,0 +1,51 @@
+'use strict'
+
+const multiaddr = require('multiaddr')
+const { CircuitRelay } = require('../protocol')
+
+/**
+ * Write a response
+ *
+ * @param {StreamHandler} streamHandler
+ * @param {CircuitRelay.Status} status
+ */
+function writeResponse (streamHandler, status) {
+  streamHandler.write({
+    type: CircuitRelay.Type.STATUS,
+    code: status
+  })
+}
+
+/**
+ * Validate incomming HOP/STOP message
+ *
+ * @param {*} msg A CircuitRelay unencoded protobuf message
+ * @param {StreamHandler} streamHandler
+ */
+function validateAddrs (msg, streamHandler) {
+  try {
+    msg.dstPeer.addrs.forEach((addr) => {
+      return multiaddr(addr)
+    })
+  } catch (err) {
+    writeResponse(streamHandler, msg.type === CircuitRelay.Type.HOP
+      ? CircuitRelay.Status.HOP_DST_MULTIADDR_INVALID
+      : CircuitRelay.Status.STOP_DST_MULTIADDR_INVALID)
+    throw err
+  }
+
+  try {
+    msg.srcPeer.addrs.forEach((addr) => {
+      return multiaddr(addr)
+    })
+  } catch (err) {
+    writeResponse(streamHandler, msg.type === CircuitRelay.Type.HOP
+      ? CircuitRelay.Status.HOP_SRC_MULTIADDR_INVALID
+      : CircuitRelay.Status.STOP_SRC_MULTIADDR_INVALID)
+    throw err
+  }
+}
+
+module.exports = {
+  validateAddrs
+}

src/circuit/index.js

@@ -0,0 +1,186 @@
+'use strict'
+
+const mafmt = require('mafmt')
+const multiaddr = require('multiaddr')
+const PeerId = require('peer-id')
+const PeerInfo = require('peer-info')
+const withIs = require('class-is')
+const { CircuitRelay: CircuitPB } = require('./protocol')
+
+const debug = require('debug')
+const log = debug('libp2p:circuit')
+log.error = debug('libp2p:circuit:error')
+
+const { relay: multicodec } = require('./multicodec')
+const createListener = require('./listener')
+const { handleCanHop, handleHop, hop } = require('./circuit/hop')
+const { handleStop } = require('./circuit/stop')
+const StreamHandler = require('./circuit/stream-handler')
+const toConnection = require('./stream-to-conn')
+
+class Circuit {
+  /**
+   * Creates an instance of Circuit.
+   *
+   * @constructor
+   * @param {object} options
+   * @param {Libp2p} options.libp2p
+   * @param {Upgrader} options.upgrader
+   */
+  constructor ({ libp2p, upgrader }) {
+    this._dialer = libp2p.dialer
+    this._registrar = libp2p.registrar
+    this._upgrader = upgrader
+    this._options = libp2p._config.relay
+    this.peerInfo = libp2p.peerInfo
+    this._registrar.handle(multicodec, this._onProtocol.bind(this))
+  }
+
+  async _onProtocol ({ connection, stream, protocol }) {
+    const streamHandler = new StreamHandler({ stream })
+    const request = await streamHandler.read()
+    const circuit = this
+    let virtualConnection
+
+    switch (request.type) {
+      case CircuitPB.Type.CAN_HOP: {
+        log('received CAN_HOP request from %s', connection.remotePeer.toB58String())
+        await handleCanHop({ circuit, connection, streamHandler })
+        break
+      }
+      case CircuitPB.Type.HOP: {
+        log('received HOP request from %s', connection.remotePeer.toB58String())
+        virtualConnection = await handleHop({
+          connection,
+          request,
+          streamHandler,
+          circuit
+        })
+        break
+      }
+      case CircuitPB.Type.STOP: {
+        log('received STOP request from %s', connection.remotePeer.toB58String())
+        virtualConnection = await handleStop({
+          connection,
+          request,
+          streamHandler,
+          circuit
+        })
+        break
+      }
+      default: {
+        log('Request of type %s not supported', request.type)
+      }
+    }
+
+    if (virtualConnection) {
+      const remoteAddr = multiaddr(request.dstPeer.addrs[0])
+      const localAddr = multiaddr(request.srcPeer.addrs[0])
+      const maConn = toConnection({
+        stream: virtualConnection,
+        remoteAddr,
+        localAddr
+      })
+      const type = CircuitPB.Type === CircuitPB.Type.HOP ? 'relay' : 'inbound'
+      log('new %s connection %s', type, maConn.remoteAddr)
+
+      const conn = await this._upgrader.upgradeInbound(maConn)
+      log('%s connection %s upgraded', type, maConn.remoteAddr)
+      this.handler && this.handler(conn)
+    }
+  }
+
+  /**
+   * Dial a peer over a relay
+   *
+   * @param {multiaddr} ma - the multiaddr of the peer to dial
+   * @param {Object} options - dial options
+   * @param {AbortSignal} [options.signal] - An optional abort signal
+   * @returns {Connection} - the connection
+   */
+  async dial (ma, options) {
+    // Check the multiaddr to see if it contains a relay and a destination peer
+    const addrs = ma.toString().split('/p2p-circuit')
+    const relayAddr = multiaddr(addrs[0])
+    const destinationAddr = multiaddr(addrs[addrs.length - 1])
+    const relayPeer = PeerId.createFromCID(relayAddr.getPeerId())
+    const destinationPeer = PeerId.createFromCID(destinationAddr.getPeerId())
+
+    let disconnectOnFailure = false
+    let relayConnection = this._registrar.getConnection(new PeerInfo(relayPeer))
+    if (!relayConnection) {
+      relayConnection = await this._dialer.connectToPeer(relayAddr, options)
+      disconnectOnFailure = true
+    }
+
+    try {
+      const virtualConnection = await hop({
+        connection: relayConnection,
+        circuit: this,
+        request: {
+          type: CircuitPB.Type.HOP,
+          srcPeer: {
+            id: this.peerInfo.id.toBytes(),
+            addrs: this.peerInfo.multiaddrs.toArray().map(addr => addr.buffer)
+          },
+          dstPeer: {
+            id: destinationPeer.toBytes(),
+            addrs: [multiaddr(destinationAddr).buffer]
+          }
+        }
+      })
+
+      const localAddr = relayAddr.encapsulate(`/p2p-circuit/p2p/${this.peerInfo.id.toB58String()}`)
+      const maConn = toConnection({
+        stream: virtualConnection,
+        remoteAddr: ma,
+        localAddr
+      })
+      log('new outbound connection %s', maConn.remoteAddr)
+
+      return this._upgrader.upgradeOutbound(maConn)
+    } catch (err) {
+      log.error('Circuit relay dial failed', err)
+      disconnectOnFailure && await relayConnection.close()
+      throw err
+    }
+  }
+
+  /**
+   * Create a listener
+   *
+   * @param {any} options
+   * @param {Function} handler
+   * @return {listener}
+   */
+  createListener (options, handler) {
+    if (typeof options === 'function') {
+      handler = options
+      options = {}
+    }
+
+    // Called on successful HOP and STOP requests
+    this.handler = handler
+
+    return createListener(this, options)
+  }
+
+  /**
+   * Filter check for all Multiaddrs that this transport can dial on
+   *
+   * @param {Array<Multiaddr>} multiaddrs
+   * @returns {Array<Multiaddr>}
+   */
+  filter (multiaddrs) {
+    multiaddrs = Array.isArray(multiaddrs) ? multiaddrs : [multiaddrs]
+
+    return multiaddrs.filter((ma) => {
+      return mafmt.Circuit.matches(ma)
+    })
+  }
+}
+
+/**
+ * @type {Circuit}
+ */
+module.exports = withIs(Circuit, { className: 'Circuit', symbolName: '@libp2p/js-libp2p-circuit/circuit' })

src/circuit/listener.js

@@ -0,0 +1,66 @@
+'use strict'
+
+const EventEmitter = require('events')
+const multiaddr = require('multiaddr')
+
+const debug = require('debug')
+const log = debug('libp2p:circuit:listener')
+log.err = debug('libp2p:circuit:error:listener')
+
+/**
+ * @param {*} circuit
+ * @returns {Listener} a transport listener
+ */
+module.exports = (circuit) => {
+  const listener = new EventEmitter()
+  const listeningAddrs = new Map()
+
+  /**
+   * Add swarm handler and listen for incoming connections
+   *
+   * @param {Multiaddr} addr
+   * @return {void}
+   */
+  listener.listen = async (addr) => {
+    const [addrString] = String(addr).split('/p2p-circuit').slice(-1)
+
+    const relayConn = await circuit._dialer.connectToPeer(multiaddr(addrString))
+    const relayedAddr = relayConn.remoteAddr.encapsulate('/p2p-circuit')
+
+    listeningAddrs.set(relayConn.remotePeer.toB58String(), relayedAddr)
+    listener.emit('listening')
+  }
+
+  /**
+   * TODO: Remove the peers from our topology
+   *
+   * @return {void}
+   */
+  listener.close = () => {}
+
+  /**
+   * 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
+   *
+   * @return {Multiaddr[]}
+   */
+  listener.getAddrs = () => {
+    const addrs = []
+    for (const addr of listeningAddrs.values()) {
+      addrs.push(addr)
+    }
+    return addrs
+  }
+
+  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/circuit/stream-to-conn.js

@@ -0,0 +1,49 @@
+'use strict'
+
+const abortable = require('abortable-iterator')
+const log = require('debug')('libp2p:circuit:stream')
+
+// Convert a duplex iterable into a MultiaddrConnection
+// https://github.com/libp2p/interface-transport#multiaddrconnection
+module.exports = ({ stream, remoteAddr, localAddr }, options = {}) => {
+  const { sink, source } = stream
+  const maConn = {
+    async sink (source) {
+      if (options.signal) {
+        source = abortable(source, options.signal)
+      }
+
+      try {
+        await sink(source)
+      } catch (err) {
+        // If aborted we can safely ignore
+        if (err.type !== 'aborted') {
+          // If the source errored the socket will already have been destroyed by
+          // toIterable.duplex(). If the socket errored it will already be
+          // destroyed. There's nothing to do here except log the error & return.
+          log(err)
+        }
+      }
+      close()
+    },
+
+    source: options.signal ? abortable(source, options.signal) : source,
+    conn: stream,
+    localAddr,
+    remoteAddr,
+    timeline: { open: Date.now() },
+
+    close () {
+      sink([])
+      close()
+    }
+  }
+
+  function close () {
+    if (!maConn.timeline.close) {
+      maConn.timeline.close = Date.now()
+    }
+  }
+
+  return maConn
+}

src/config.js

@@ -1,100 +1,55 @@
 'use strict'
 
-const { struct, superstruct } = require('superstruct')
-const { optional, list } = struct
+const mergeOptions = require('merge-options')
+const Constants = require('./constants')
 
-// Define custom types
-const s = superstruct()
-const transport = s.union([
-  s.interface({
-    createListener: 'function',
-    dial: 'function'
-  }),
-  'function'
-])
-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.union(['undefined', s.interface({ protect: 'function' })]),
-  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: s.intersection([[transport], s.interface({
-    length (v) {
-      return v > 0 ? true : 'ERROR_EMPTY'
-    }
-  })])
-})
-
-const configSchema = s({
-  peerDiscovery: s('object', {
-    autoDial: true
-  }),
-  relay: s({
-    enabled: 'boolean',
-    hop: optional(s({
-      enabled: 'boolean',
-      active: 'boolean'
-    }, {
-      // HOP defaults
-      enabled: false,
-      active: false
-    }))
-  }, {
-    // Relay defaults
-    enabled: true
-  }),
-  // DHT config
-  dht: s('object?', {
-    // DHT defaults
-    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
-    }
-  }),
-  // Pubsub config
-  pubsub: s('object?', {
-    // DHT defaults
-    enabled: false
-  })
-}, {})
-
-const optionsSchema = s({
-  switch: 'object?',
-  connectionManager: s('object', {
+const DefaultConfig = {
+  connectionManager: {
     minPeers: 25
-  }),
-  datastore: 'object?',
-  peerInfo: 'object',
-  peerBook: 'object?',
-  modules: modulesSchema,
-  config: configSchema
-})
+  },
+  dialer: {
+    maxParallelDials: Constants.MAX_PARALLEL_DIALS,
+    maxDialsPerPeer: Constants.MAX_PER_PEER_DIALS,
+    dialTimeout: Constants.DIAL_TIMEOUT
+  },
+  metrics: {
+    enabled: false
+  },
+  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
+      }
+    },
+    transport: {}
+  }
+}
 
 module.exports.validate = (opts) => {
-  const [error, options] = optionsSchema.validate(opts)
+  opts = mergeOptions(DefaultConfig, 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)
-    }
-  }
+  if (opts.modules.transport.length < 1) throw new Error("'options.modules.transport' must contain at least 1 transport")
 
-  if (options.config.peerDiscovery.autoDial === undefined) {
-    options.config.peerDiscovery.autoDial = true
-  }
-
-  return options
+  return opts
 }

src/connection-manager/index.js

@@ -0,0 +1,192 @@
+'use strict'
+
+const assert = require('assert')
+const mergeOptions = require('merge-options')
+const LatencyMonitor = require('latency-monitor').default
+const debug = require('debug')('libp2p:connection-manager')
+const retimer = require('retimer')
+
+const defaultOptions = {
+  maxConnections: Infinity,
+  minConnections: 0,
+  maxData: Infinity,
+  maxSentData: Infinity,
+  maxReceivedData: Infinity,
+  maxEventLoopDelay: Infinity,
+  pollInterval: 2000,
+  movingAverageInterval: 60000,
+  defaultPeerValue: 1
+}
+
+class ConnectionManager {
+  /**
+   * @constructor
+   * @param {Libp2p} libp2p
+   * @param {object} options
+   * @param {Number} options.maxConnections The maximum number of connections allowed. Default=Infinity
+   * @param {Number} options.minConnections The minimum number of connections to avoid pruning. Default=0
+   * @param {Number} options.maxData The max data (in and out), per average interval to allow. Default=Infinity
+   * @param {Number} options.maxSentData The max outgoing data, per average interval to allow. Default=Infinity
+   * @param {Number} options.maxReceivedData The max incoming data, per average interval to allow.. Default=Infinity
+   * @param {Number} options.maxEventLoopDelay The upper limit the event loop can take to run. Default=Infinity
+   * @param {Number} options.pollInterval How often, in milliseconds, metrics and latency should be checked. Default=2000
+   * @param {Number} options.movingAverageInterval How often, in milliseconds, to compute averages. Default=60000
+   * @param {Number} options.defaultPeerValue The value of the peer. Default=1
+   */
+  constructor (libp2p, options) {
+    this._libp2p = libp2p
+    this._registrar = libp2p.registrar
+    this._peerId = libp2p.peerInfo.id.toB58String()
+    this._options = mergeOptions.call({ ignoreUndefined: true }, defaultOptions, options)
+    assert(
+      this._options.maxConnections > this._options.minConnections,
+      'Connection Manager maxConnections must be greater than minConnections'
+    )
+
+    debug('options: %j', this._options)
+
+    this._metrics = libp2p.metrics
+
+    this._peerValues = new Map()
+    this._connections = new Map()
+    this._timer = null
+    this._checkMetrics = this._checkMetrics.bind(this)
+  }
+
+  /**
+   * Starts the Connection Manager. If Metrics are not enabled on libp2p
+   * only event loop and connection limits will be monitored.
+   */
+  start () {
+    if (this._metrics) {
+      this._timer = this._timer || retimer(this._checkMetrics, this._options.pollInterval)
+    }
+
+    // latency monitor
+    this._latencyMonitor = new LatencyMonitor({
+      latencyCheckIntervalMs: this._options.pollInterval,
+      dataEmitIntervalMs: this._options.pollInterval
+    })
+    this._onLatencyMeasure = this._onLatencyMeasure.bind(this)
+    this._latencyMonitor.on('data', this._onLatencyMeasure)
+    debug('started')
+  }
+
+  /**
+   * Stops the Connection Manager
+   */
+  stop () {
+    this._timer && this._timer.clear()
+    this._latencyMonitor && this._latencyMonitor.removeListener('data', this._onLatencyMeasure)
+    debug('stopped')
+  }
+
+  /**
+   * Sets the value of the given peer. Peers with lower values
+   * will be disconnected first.
+   * @param {PeerId} peerId
+   * @param {number} value A number between 0 and 1
+   */
+  setPeerValue (peerId, value) {
+    if (value < 0 || value > 1) {
+      throw new Error('value should be a number between 0 and 1')
+    }
+    if (peerId.toB58String) {
+      peerId = peerId.toB58String()
+    }
+    this._peerValues.set(peerId, value)
+  }
+
+  /**
+   * Checks the libp2p metrics to determine if any values have exceeded
+   * the configured maximums.
+   * @private
+   */
+  _checkMetrics () {
+    const movingAverages = this._metrics.global.movingAverages
+    const received = movingAverages.dataReceived[this._options.movingAverageInterval].movingAverage()
+    this._checkLimit('maxReceivedData', received)
+    const sent = movingAverages.dataSent[this._options.movingAverageInterval].movingAverage()
+    this._checkLimit('maxSentData', sent)
+    const total = received + sent
+    this._checkLimit('maxData', total)
+    debug('metrics update', total)
+    this._timer.reschedule(this._options.pollInterval)
+  }
+
+  /**
+   * Tracks the incoming connection and check the connection limit
+   * @param {Connection} connection
+   */
+  onConnect (connection) {
+    const peerId = connection.remotePeer.toB58String()
+    this._connections.set(connection.id, connection)
+    if (!this._peerValues.has(peerId)) {
+      this._peerValues.set(peerId, this._options.defaultPeerValue)
+    }
+    this._checkLimit('maxConnections', this._connections.size)
+  }
+
+  /**
+   * Removes the connection from tracking
+   * @param {Connection} connection
+   */
+  onDisconnect (connection) {
+    this._connections.delete(connection.id)
+    this._peerValues.delete(connection.remotePeer.toB58String())
+  }
+
+  /**
+   * If the event loop is slow, maybe close a connection
+   * @private
+   * @param {*} summary The LatencyMonitor summary
+   */
+  _onLatencyMeasure (summary) {
+    this._checkLimit('maxEventLoopDelay', summary.avgMs)
+  }
+
+  /**
+   * If the `value` of `name` has exceeded its limit, maybe close a connection
+   * @private
+   * @param {string} name The name of the field to check limits for
+   * @param {number} value The current value of the field
+   */
+  _checkLimit (name, value) {
+    const limit = this._options[name]
+    debug('checking limit of %s. current value: %d of %d', name, value, limit)
+    if (value > limit) {
+      debug('%s: limit exceeded: %s, %d', this._peerId, name, value)
+      this._maybeDisconnectOne()
+    }
+  }
+
+  /**
+   * If we have more connections than our maximum, close a connection
+   * to the lowest valued peer.
+   * @private
+   */
+  _maybeDisconnectOne () {
+    if (this._options.minConnections < this._connections.size) {
+      const peerValues = Array.from(this._peerValues).sort(byPeerValue)
+      debug('%s: sorted peer values: %j', this._peerId, peerValues)
+      const disconnectPeer = peerValues[0]
+      if (disconnectPeer) {
+        const peerId = disconnectPeer[0]
+        debug('%s: lowest value peer is %s', this._peerId, peerId)
+        debug('%s: closing a connection to %j', this._peerId, peerId)
+        for (const connection of this._connections.values()) {
+          if (connection.remotePeer.toB58String() === peerId) {
+            connection.close()
+            break
+          }
+        }
+      }
+    }
+  }
+}
+
+module.exports = ConnectionManager
+
+function byPeerValue (peerValueEntryA, peerValueEntryB) {
+  return peerValueEntryA[1] - peerValueEntryB[1]
+}