refactor: circuit relay to async (#477)

* refactor: add dialing over relay support

* chore: fix lint

* fix: dont clear listeners on close

* fix: if dial errors already have codes, just rethrow them

* fix: clear the registrar when libp2p stops

* fix: improve connection maintenance with circuit

* chore: correct feedback

* test: use chai as promised

* test(fix): reset multiaddrs on dial test

Author: jacobheun

.aegir.js

@@ -23,6 +23,15 @@ const before = async () => {
       transport: [WebSockets],
       streamMuxer: [Muxer],
       connEncryption: [Crypto]
+    },
+    config: {
+      relay: {
+        enabled: true,
+        hop: {
+          enabled: true,
+          active: false
+        }
+      }
     }
   })
   // Add the echo protocol

package.json

@@ -59,13 +59,13 @@
     "mafmt": "^7.0.0",
     "merge-options": "^1.0.1",
     "moving-average": "^1.0.0",
-    "multiaddr": "^7.1.0",
+    "multiaddr": "^7.2.1",
     "multistream-select": "^0.15.0",
     "once": "^1.4.0",
     "p-map": "^3.0.0",
     "p-queue": "^6.1.1",
     "p-settle": "^3.1.0",
-    "peer-id": "^0.13.3",
+    "peer-id": "^0.13.4",
     "peer-info": "^0.17.0",
     "promisify-es6": "^1.0.3",
     "protons": "^1.0.1",
@@ -80,6 +80,7 @@
     "abortable-iterator": "^2.1.0",
     "aegir": "^20.0.0",
     "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
     "chai-checkmark": "^1.0.1",
     "cids": "^0.7.1",
     "delay": "^4.3.0",

src/circuit/README.md

@@ -32,8 +32,6 @@ Prior to `libp2p-circuit` there was a rift in the IPFS network, were IPFS nodes
     - [Example](#example)
       - [Create dialer/listener](#create-dialerlistener)
       - [Create `relay`](#create-relay)
-    - [This module uses `pull-streams`](#this-module-uses-pull-streams)
-      - [Converting `pull-streams` to Node.js Streams](#converting-pull-streams-to-nodejs-streams)
   - [API](#api)
     - [Implementation rational](#implementation-rational)
 
@@ -48,7 +46,7 @@ const Circuit = require('libp2p-circuit')
 const multiaddr = require('multiaddr')
 const pull = require('pull-stream')
 
-const mh1 = multiaddr('/p2p-circuit/ipfs/QmHash') // dial /ipfs/QmHash over any circuit
+const mh1 = multiaddr('/p2p-circuit/p2p/QmHash') // dial /p2p/QmHash over any circuit
 
 const circuit = new Circuit(swarmInstance, options) // pass swarm instance and options
 
@@ -91,37 +89,13 @@ const relay = new Relay(options)
 relay.mount(swarmInstance) // start relaying traffic
 ```
 
-### This module uses `pull-streams`
-
-We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
-
-You can learn more about pull-streams at:
-
-- [The history of Node.js streams, nodebp April 2014](https://www.youtube.com/watch?v=g5ewQEuXjsQ)
-- [The history of streams, 2016](http://dominictarr.com/post/145135293917/history-of-streams)
-- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
-- [pull-streams documentation](https://pull-stream.github.io/)
-
-#### Converting `pull-streams` to Node.js Streams
-
-If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/dominictarr/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
-
-```js
-const pullToStream = require('pull-stream-to-stream')
-
-const nodeStreamInstance = pullToStream(pullStreamInstance)
-// nodeStreamInstance is an instance of a Node.js Stream
-```
-
-To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
-
 ## API
 
 [![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
 
 `libp2p-circuit` accepts Circuit addresses for both IPFS and non IPFS encapsulated addresses, i.e:
 
-`/p2p-circuit/ip4/127.0.0.1/tcp/4001/ipfs/QmHash`
+`/p2p-circuit/ip4/127.0.0.1/tcp/4001/p2p/QmHash`
 
 Both for dialing and listening.