chore: use public delegated routing

* test: add pubsub reconnect test

* chore: dep bump

* chore: remove temp pubsub dep

Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>

Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>

CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="0.28.4"></a>
+## [0.28.4](https://github.com/libp2p/js-libp2p/compare/v0.28.3...v0.28.4) (2020-07-03)
+
+
+
+<a name="0.28.3"></a>
+## [0.28.3](https://github.com/libp2p/js-libp2p/compare/v0.28.2...v0.28.3) (2020-06-18)
+
+
+### Bug Fixes
+
+* catch pipe errors ([#678](https://github.com/libp2p/js-libp2p/issues/678)) ([a8219e6](https://github.com/libp2p/js-libp2p/commit/a8219e6))
+
+
+
 <a name="0.28.2"></a>
 ## [0.28.2](https://github.com/libp2p/js-libp2p/compare/v0.28.1...v0.28.2) (2020-06-15)
 

RELEASE.md

@@ -26,6 +26,7 @@
 - Documentation
   - [ ] Ensure that README.md is up to date
   - [ ] Ensure that all the examples run
+  - [ ] Ensure that [libp2p/docs](https://github.com/libp2p/docs) is updated
 - Communication
   - [ ] Create the release issue
   - [ ] Take a snapshot between of everyone that has contributed to this release (including its subdeps in IPFS, libp2p, IPLD and multiformats) using [`name-your-contributors`](https://www.npmjs.com/package/name-your-contributors). Generate a nice markdown list with [this script](https://gist.github.com/jacobheun/d2ff479ca991733c13cdcf688a1317e5)

doc/CONFIGURATION.md

@@ -649,8 +649,8 @@ const node = await Libp2p.create({
 
 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)
+- [libp2p-ipfs-nodejs](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/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/blob/master/packages/ipfs/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.
 

doc/STREAMING_ITERABLES.md

@@ -161,4 +161,4 @@ const duplex = {
 [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
+[streaming-iterables]: https://github.com/reconbot/streaming-iterables

examples/delegated-routing/.env

@@ -0,0 +1,3 @@
+# required because react-scripts scans *up* the tree from this project and finds
+# a conflicting version of webpack in the node_modules dir for js-libp2p (aegir).
+SKIP_PREFLIGHT_CHECK=true

examples/delegated-routing/README.md

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

examples/delegated-routing/package.json

@@ -3,19 +3,19 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
-    "ipfs": "~0.34.4",
-    "libp2p": "github:libp2p/js-libp2p#master",
-    "libp2p-delegated-content-routing": "~0.2.2",
-    "libp2p-delegated-peer-routing": "~0.2.2",
-    "libp2p-kad-dht": "~0.14.12",
-    "libp2p-mplex": "~0.8.5",
-    "libp2p-secio": "~0.11.1",
-    "libp2p-webrtc-star": "~0.15.8",
-    "libp2p-websocket-star": "~0.10.2",
-    "libp2p-websockets": "~0.12.2",
+    "ipfs": "~0.47.0",
+    "libp2p": "../..",
+    "libp2p-delegated-content-routing": "~0.5.0",
+    "libp2p-delegated-peer-routing": "~0.5.0",
+    "libp2p-kad-dht": "~0.19.7",
+    "libp2p-mplex": "~0.9.5",
+    "libp2p-secio": "~0.12.5",
+    "libp2p-webrtc-star": "~0.18.6",
+    "libp2p-websockets": "~0.13.6",
+    "peer-id": "^0.13.13",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
-    "react-scripts": "2.1.8"
+    "react-scripts": "^3.2.0"
   },
   "scripts": {
     "start": "react-scripts start"

examples/delegated-routing/src/App.js

@@ -3,12 +3,12 @@
 
 import React from 'react'
 import Ipfs from 'ipfs'
-import libp2pBundle from './libp2p-bundle'
-const Component = React.Component
+import libp2pConfig from './libp2p-configuration'
+import PeerId from 'peer-id'
 
-const BootstrapNode = '/ip4/127.0.0.1/tcp/8081/ws/p2p/QmdoG8DpzYUZMVP5dGmgmigZwR1RE8Cf6SxMPg1SBXJAQ8'
+const BootstrapNode = '/ip4/127.0.0.1/tcp/4010/ws/p2p/QmZrsjJ7v9QoJNjDJmjsQ8947wiK3UnaPPLQvrTSRDAZ2d'
 
-class App extends Component {
+class App extends React.Component {
   constructor (props) {
     super(props)
     this.state = {
@@ -16,7 +16,7 @@ class App extends Component {
       // This hash is the IPFS readme
       hash: 'QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB',
       // This peer is one of the Bootstrap nodes for IPFS
-      peer: 'QmV6kA2fB8kTr6jc3pL5zbNsjKbmPUHAPKKHRBYe1kDEyc',
+      peer: 'QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z',
       isLoading: 0
     }
     this.peerInterval = null
@@ -38,39 +38,39 @@ class App extends Component {
     })
   }
 
-  handleHashSubmit (event) {
+  async handleHashSubmit (event) {
     event.preventDefault()
     this.setState({
       isLoading: this.state.isLoading + 1
     })
 
-    this.ipfs.cat(this.state.hash, (err, data) => {
-      if (err) console.log('Error', err)
+    const chunks = []
+    for await (const chunk of this.ipfs.cat(this.state.hash)) {
+      chunks.push(chunk)
+    }
 
-      this.setState({
-        response: data.toString(),
-        isLoading: this.state.isLoading - 1
-      })
+    this.setState({
+      response: Buffer.concat(chunks).toString(),
+      isLoading: this.state.isLoading - 1
     })
   }
-  handlePeerSubmit (event) {
+  async handlePeerSubmit (event) {
     event.preventDefault()
     this.setState({
       isLoading: this.state.isLoading + 1
     })
 
-    this.ipfs.dht.findpeer(this.state.peer, (err, results) => {
-      if (err) console.log('Error', err)
+    const peerId = PeerId.createFromB58String(this.state.peer)
+    const results = await this.ipfs.libp2p.peerRouting.findPeer(peerId)
 
-      this.setState({
-        response: JSON.stringify(results, null, 2),
-        isLoading: this.state.isLoading - 1
-      })
+    this.setState({
+      response: JSON.stringify(results, null, 2),
+      isLoading: this.state.isLoading - 1
     })
   }
 
-  componentDidMount () {
-    window.ipfs = this.ipfs = new Ipfs({
+  async componentDidMount () {
+    window.ipfs = this.ipfs = await Ipfs.create({
       config: {
         Addresses: {
           Swarm: []
@@ -90,27 +90,17 @@ class App extends Component {
       preload: {
         enabled: false
       },
-      libp2p: libp2pBundle
+      libp2p: libp2pConfig
     })
-    this.ipfs.on('ready', () => {
-      if (this.peerInterval) {
-        clearInterval(this.peerInterval)
-      }
 
-      this.ipfs.swarm.connect(BootstrapNode, (err) => {
-        if (err) {
-          console.log('Error connecting to the node', err)
-        }
-        console.log('Connected!')
-      })
+    await this.ipfs.swarm.connect(BootstrapNode)
+    console.log('Connected!')
 
-      this.peerInterval = setInterval(() => {
-        this.ipfs.swarm.peers((err, peers) => {
-          if (err) console.log(err)
-          if (peers) this.setState({peers: peers.length})
-        })
-      }, 2500)
-    })
+    this.peerInterval = setInterval(async () => {
+      const peers = await this.ipfs.swarm.peers()
+
+      if (peers) this.setState({ peers: peers.length })
+    }, 2500)
   }
 
   render () {

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

@@ -3,7 +3,6 @@
 
 const Libp2p = require('libp2p')
 const Websockets = require('libp2p-websockets')
-const WebSocketStar = require('libp2p-websocket-star')
 const WebRTCStar = require('libp2p-webrtc-star')
 const MPLEX = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
@@ -11,18 +10,15 @@ const KadDHT = require('libp2p-kad-dht')
 const DelegatedPeerRouter = require('libp2p-delegated-peer-routing')
 const DelegatedContentRouter = require('libp2p-delegated-content-routing')
 
-export default function Libp2pBundle ({peerInfo, peerBook}) {
-  const wrtcstar = new WebRTCStar({id: peerInfo.id})
-  const wsstar = new WebSocketStar({id: peerInfo.id})
+export default function Libp2pConfiguration ({peerId}) {
   const delegatedApiOptions = {
-    host: '0.0.0.0',
-    protocol: 'http',
-    port: '8080'
+    protocol: 'https',
+    port: 443,
+    host: 'node0.delegate.ipfs.io'
   }
 
   return new Libp2p({
-    peerInfo,
-    peerBook,
+    peerId,
     // Lets limit the connection managers peers and have it check peer health less frequently
     connectionManager: {
       maxPeers: 10,
@@ -30,18 +26,13 @@ export default function Libp2pBundle ({peerInfo, peerBook}) {
     },
     modules: {
       contentRouting: [
-        new DelegatedContentRouter(peerInfo.id, delegatedApiOptions)
+        new DelegatedContentRouter(peerId, delegatedApiOptions)
       ],
       peerRouting: [
         new DelegatedPeerRouter(delegatedApiOptions)
       ],
-      peerDiscovery: [
-        wrtcstar.discovery,
-        wsstar.discovery
-      ],
       transport: [
-        wrtcstar,
-        wsstar,
+        WebRTCStar,
         Websockets
       ],
       streamMuxer: [

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

@@ -11,26 +11,9 @@ cd ./examples/libp2p-in-the-browser
 npm install
 ```
 
-## Signaling Server
-
-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.
+Start by running the Parcel server:
 
 ```
 npm start
@@ -53,3 +36,11 @@ This will compile the code and start a server listening on port [http://localhos
 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.
+
+## Going to production?
+
+This example uses public `libp2p-webrtc-star` servers. These servers should be used for experimenting and demos, they **MUST** not be used in production as there is no guarantee on availability.
+
+You can see how to deploy your own signaling server in [libp2p/js-libp2p-webrtc-star/DEPLOYMENT.md](https://github.com/libp2p/js-libp2p-webrtc-star/blob/master/DEPLOYMENT.md).
+
+Once you have your own server running, you should add its listen address in your libp2p node configuration.

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

@@ -14,7 +14,10 @@ document.addEventListener('DOMContentLoaded', async () => {
       // 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
-      listen: ['/ip4/0.0.0.0/tcp/9090/wss/p2p-webrtc-star']
+      listen: [
+        '/dns4/wrtc-star1.par.dwebops.pub/tcp/443/wss/p2p-webrtc-star',
+        '/dns4/wrtc-star2.sjc.dwebops.pub/tcp/443/wss/p2p-webrtc-star'
+      ]
     },
     modules: {
       transport: [Websockets, WebRTCStar],

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

@@ -8,8 +8,7 @@
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "parcel index.html",
-    "server": "star-signal"
+    "start": "parcel index.html"
   },
   "keywords": [],
   "author": "",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.28.2",
+  "version": "0.28.4",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -59,7 +59,7 @@
     "it-pipe": "^1.1.0",
     "it-protocol-buffers": "^0.2.0",
     "libp2p-crypto": "^0.17.6",
-    "libp2p-interfaces": "^0.3.0",
+    "libp2p-interfaces": "^0.3.1",
     "libp2p-utils": "^0.1.2",
     "mafmt": "^7.0.0",
     "merge-options": "^2.0.0",
@@ -102,7 +102,7 @@
     "libp2p-delegated-content-routing": "^0.5.0",
     "libp2p-delegated-peer-routing": "^0.5.0",
     "libp2p-floodsub": "^0.21.0",
-    "libp2p-gossipsub": "^0.4.0",
+    "libp2p-gossipsub": "^0.4.6",
     "libp2p-kad-dht": "^0.19.1",
     "libp2p-mdns": "^0.14.1",
     "libp2p-mplex": "^0.9.5",
@@ -131,8 +131,8 @@
     "Alex Potsides <alex@achingbrain.net>",
     "Maciej Krüger <mkg20001@gmail.com>",
     "Hugo Dias <mail@hugodias.me>",
-    "Volker Mische <volker.mische@gmail.com>",
     "dirkmc <dirkmdev@gmail.com>",
+    "Volker Mische <volker.mische@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "Elven <mon.samuel@qq.com>",
     "Andrew Nesbitt <andrewnez@gmail.com>",
@@ -141,7 +141,7 @@
     "Thomas Eizinger <thomas@eizinger.io>",
     "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
     "Didrik Nordström <didrik@betamos.se>",
-    "Joel Gustafson <joelg@mit.edu>",
+    "Francis Gulotta <wizard@roborooter.com>",
     "Julien Bouquillon <contact@revolunet.com>",
     "Kevin Kwok <antimatter15@gmail.com>",
     "Florian-Merle <florian.david.merle@gmail.com>",
@@ -161,6 +161,7 @@
     "Chris Bratlien <chrisbratlien@gmail.com>",
     "isan_rivkin <isanrivkin@gmail.com>",
     "Henrique Dias <hacdias@gmail.com>",
-    "Irakli Gozalishvili <rfobic@gmail.com>"
+    "Irakli Gozalishvili <rfobic@gmail.com>",
+    "Joel Gustafson <joelg@mit.edu>"
   ]
 }

src/circuit/README.md

@@ -1,12 +1,20 @@
 # 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.
+> Node.js implementation of the Circuit module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/js-libp2p-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.
+`libp2p-circuit` implements the circuit-relay mechanism that allows nodes that don't speak the same protocol to communicate using a third _relay_ node. You can read more about this in its [spec](https://github.com/libp2p/specs/tree/master/relay).
 
-This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces.
+## 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)
+  - [API](#api)
+    - [Implementation rational](#implementation-rational)
 
 ### Why?
 
@@ -16,77 +24,42 @@ The use of circuit-relaying is not limited to routing traffic between browser no
  - 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.
+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
+Libp2p circuit configuration can be seen at [Setup with Relay](../../doc/CONFIGURATION.md#setup-with-relay).
 
-#### Create dialer/listener
+Once you have a circuit relay node running, you can configure other nodes to use it as a relay as follows:
 
 ```js
-const Circuit = require('libp2p-circuit')
 const multiaddr = require('multiaddr')
-const pull = require('pull-stream')
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
 
-const mh1 = multiaddr('/p2p-circuit/p2p/QmHash') // dial /p2p/QmHash over any circuit
+const relayAddr = ...
 
-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
-  )
+const node = await Libp2p.create({
+  addresses: {
+    listen: [multiaddr(`${relayAddr}/p2p-circuit`)]
+  },
+  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.
+    }
+  }
 })
-
-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
@@ -101,7 +74,7 @@ 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.
+This module is not a transport, however it implements `interface-transport` interface in order to allow circuit to be plugged with `libp2p`. 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` 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)
@@ -109,13 +82,13 @@ libp2p
 |        +---------------------------------+      |                                     |                          |
 |        |                                 |      |                                     |   +------------------+   |
 |        |                                 |      |  circuit-relay listens for the HOP  |   |                  |   |
-|        |           libp2p-swarm          <------------------------------------------------|  circuit-relay   |   |
+|        |              libp2p             <------------------------------------------------|  circuit-relay   |   |
 |        |                                 |      |  message to handle incomming relay  |   |                  |   |
 |        |                                 |      |  requests from other nodes          |   +------------------+   |
 |        +---------------------------------+      |                                     |                          |
 |         ^     ^   ^  ^   ^           ^          |                                     |   +------------------+   |
 |         |     |   |  |   |           |          |                                     |   | +-------------+  |   |
-|         |     |   |  |   |           |          |  dialer uses libp2p-swarm to dial   |   | |             |  |   |
+|         |     |   |  |   |           |          |      dialer uses libp2p to dial     |   | |             |  |   |
 |         |     |   |  +---------------------------------------------------------------------->   dialer    |  |   |
 |         |     | transports           |          |  to a circuit-relay node using the  |   | |             |  |   |
 |         |     |   |      |           |          |  HOP message                        |   | +-------------+  |   |

src/identify/index.js

@@ -208,7 +208,7 @@ class IdentifyService {
    * @param {*} options.stream
    * @param {Connection} options.connection
    */
-  _handleIdentify ({ connection, stream }) {
+  async _handleIdentify ({ connection, stream }) {
     let publicKey = Buffer.alloc(0)
     if (this.peerId.pubKey) {
       publicKey = this.peerId.pubKey.bytes
@@ -223,12 +223,16 @@ class IdentifyService {
       protocols: Array.from(this._protocols.keys())
     })
 
-    pipe(
-      [message],
-      lp.encode(),
-      stream,
-      consume
-    )
+    try {
+      await pipe(
+        [message],
+        lp.encode(),
+        stream,
+        consume
+      )
+    } catch (err) {
+      log.error('could not respond to identify request', err)
+    }
   }
 
   /**
@@ -239,17 +243,16 @@ class IdentifyService {
    * @param {Connection} options.connection
    */
   async _handlePush ({ connection, stream }) {
-    const [data] = await pipe(
-      [],
-      stream,
-      lp.decode(),
-      take(1),
-      toBuffer,
-      collect
-    )
-
     let message
     try {
+      const [data] = await pipe(
+        [],
+        stream,
+        lp.decode(),
+        take(1),
+        toBuffer,
+        collect
+      )
       message = Message.decode(data)
     } catch (err) {
       return log.error('received invalid message', err)

src/metrics/index.js

@@ -215,7 +215,7 @@ class Metrics {
 
     const _sink = stream.sink
     stream.sink = source => {
-      pipe(
+      return pipe(
         source,
         tap(chunk => metrics._onMessage({
           remotePeer,

src/pnet/index.js

@@ -17,7 +17,7 @@ const handshake = require('it-handshake')
 const { NONCE_LENGTH } = require('./key-generator')
 const debug = require('debug')
 const log = debug('libp2p:pnet')
-log.err = debug('libp2p:pnet:err')
+log.error = debug('libp2p:pnet:err')
 
 /**
  * Takes a Private Shared Key (psk) and provides a `protect` method
@@ -69,7 +69,7 @@ class Protector {
       // Decrypt all inbound traffic
       createUnboxStream(remoteNonce, this.psk),
       external
-    )
+    ).catch(log.error)
 
     return internal
   }

src/upgrader.js

@@ -258,7 +258,7 @@ class Upgrader {
       }
 
       // Pipe all data through the muxer
-      pipe(upgradedConn, muxer, upgradedConn)
+      pipe(upgradedConn, muxer, upgradedConn).catch(log.error)
     }
 
     const _timeline = maConn.timeline

test/pubsub/operation.node.js

@@ -189,4 +189,135 @@ describe('Pubsub subsystem operates correctly', () => {
       await defer.promise
     })
   })
+
+  describe('pubsub with intermittent connections', () => {
+    beforeEach(async () => {
+      libp2p = await create(mergeOptions(subsystemOptions, {
+        peerId,
+        addresses: {
+          listen: [listenAddr]
+        },
+        config: {
+          pubsub: {
+            enabled: true,
+            emitSelf: false
+          }
+        }
+      }))
+
+      remoteLibp2p = await create(mergeOptions(subsystemOptions, {
+        peerId: remotePeerId,
+        addresses: {
+          listen: [remoteListenAddr]
+        },
+        config: {
+          pubsub: {
+            enabled: true,
+            emitSelf: false
+          }
+        }
+      }))
+
+      await libp2p.start()
+      await remoteLibp2p.start()
+
+      libp2p.peerStore.addressBook.set(remotePeerId, remoteLibp2p.multiaddrs)
+    })
+
+    afterEach(() => Promise.all([
+      libp2p && libp2p.stop(),
+      remoteLibp2p && remoteLibp2p.stop()
+    ]))
+
+    afterEach(() => {
+      sinon.restore()
+    })
+
+    it('should receive pubsub messages after a node restart', async () => {
+      const topic = 'test-topic'
+      const data = 'hey!'
+      const libp2pId = libp2p.peerId.toB58String()
+
+      let counter = 0
+      const defer1 = pDefer()
+      const defer2 = pDefer()
+      const handler = (msg) => {
+        expect(msg.data.toString()).to.equal(data)
+        counter++
+        counter === 1 ? defer1.resolve() : defer2.resolve()
+      }
+
+      await libp2p.dial(remotePeerId)
+
+      let subscribedTopics = libp2p.pubsub.getTopics()
+      expect(subscribedTopics).to.not.include(topic)
+
+      libp2p.pubsub.subscribe(topic, handler)
+
+      subscribedTopics = libp2p.pubsub.getTopics()
+      expect(subscribedTopics).to.include(topic)
+
+      // wait for remoteLibp2p to know about libp2p subscription
+      await pWaitFor(() => {
+        const subscribedPeers = remoteLibp2p.pubsub.getSubscribers(topic)
+        return subscribedPeers.includes(libp2pId)
+      })
+      remoteLibp2p.pubsub.publish(topic, data)
+
+      await defer1.promise
+
+      await remoteLibp2p.stop()
+      await remoteLibp2p.start()
+
+      libp2p.peerStore.addressBook.set(remotePeerId, remoteLibp2p.multiaddrs)
+      await libp2p.dial(remotePeerId)
+
+      // wait for remoteLibp2p to know about libp2p subscription
+      await pWaitFor(() => {
+        const subscribedPeers = remoteLibp2p.pubsub.getSubscribers(topic)
+        return subscribedPeers.includes(libp2pId)
+      })
+
+      remoteLibp2p.pubsub.publish(topic, data)
+
+      await defer2.promise
+    })
+
+    it('should handle quick reconnects with a delayed disconnect', async () => {
+      // Subscribe on both
+      const handlerSpy = sinon.spy()
+      const topic = 'reconnect-channel'
+      await Promise.all([
+        libp2p.pubsub.subscribe(topic, handlerSpy),
+        remoteLibp2p.pubsub.subscribe(topic, handlerSpy)
+      ])
+      // Create two connections to the remote peer
+      const originalConnection = await libp2p.dialer.connectToPeer(remoteLibp2p.peerId)
+      // second connection
+      await libp2p.dialer.connectToPeer(remoteLibp2p.peerId)
+      expect(libp2p.connections.get(remoteLibp2p.peerId.toB58String())).to.have.length(2)
+
+      // Wait for subscriptions to occur
+      await pWaitFor(() => {
+        return libp2p.pubsub.getSubscribers(topic).includes(remoteLibp2p.peerId.toB58String()) &&
+          remoteLibp2p.pubsub.getSubscribers(topic).includes(libp2p.peerId.toB58String())
+      })
+
+      // Verify messages go both ways
+      libp2p.pubsub.publish(topic, 'message1')
+      remoteLibp2p.pubsub.publish(topic, 'message2')
+      await pWaitFor(() => handlerSpy.callCount === 2)
+      expect(handlerSpy.args.map(([message]) => message.data.toString())).to.include.members(['message1', 'message2'])
+
+      // Disconnect the first connection (this acts as a delayed reconnect)
+      await originalConnection.close()
+
+      // Verify messages go both ways after the disconnect
+      handlerSpy.resetHistory()
+      libp2p.pubsub.publish(topic, 'message3')
+      remoteLibp2p.pubsub.publish(topic, 'message4')
+      await pWaitFor(() => handlerSpy.callCount === 2)
+      expect(handlerSpy.args.map(([message]) => message.data.toString())).to.include.members(['message3', 'message4'])
+    })
+  })
 })