chore: release version v0.3.0

* chore: remove peer-info usage on topology

BREAKING CHANGE: topology api now uses peer-id instead of peer-info

.gitignore

@@ -13,3 +13,4 @@ docs
 node_modules
 # Lock files
 package-lock.json
+yarn.lock

CHANGELOG.md

@@ -1,3 +1,121 @@
+<a name="0.3.0"></a>
+# [0.3.0](https://github.com/libp2p/js-interfaces/compare/v0.2.8...v0.3.0) (2020-04-21)
+
+
+### Chores
+
+* remove peer-info usage on topology ([#42](https://github.com/libp2p/js-interfaces/issues/42)) ([79a7843](https://github.com/libp2p/js-interfaces/commit/79a7843))
+* update content and peer routing interfaces removing peer-info ([#43](https://github.com/libp2p/js-interfaces/issues/43)) ([d2032e6](https://github.com/libp2p/js-interfaces/commit/d2032e6))
+
+
+### Features
+
+* peer-discovery not using peer-info ([5792b13](https://github.com/libp2p/js-interfaces/commit/5792b13))
+
+
+### BREAKING CHANGES
+
+* topology api now uses peer-id instead of peer-info
+* content-routing and peer-routing APIs return an object with relevant properties instead of peer-info
+* peer-discovery emits object with id and multiaddrs properties
+
+
+
+<a name="0.2.8"></a>
+## [0.2.8](https://github.com/libp2p/js-interfaces/compare/v0.2.7...v0.2.8) (2020-04-21)
+
+
+
+<a name="0.2.7"></a>
+## [0.2.7](https://github.com/libp2p/js-interfaces/compare/v0.2.6...v0.2.7) (2020-03-20)
+
+
+### Bug Fixes
+
+* add buffer ([#39](https://github.com/libp2p/js-interfaces/issues/39)) ([78e015c](https://github.com/libp2p/js-interfaces/commit/78e015c))
+
+
+
+<a name="0.2.6"></a>
+## [0.2.6](https://github.com/libp2p/js-interfaces/compare/v0.2.5...v0.2.6) (2020-02-17)
+
+
+### Bug Fixes
+
+* remove use of assert module ([#34](https://github.com/libp2p/js-interfaces/issues/34)) ([c77d8de](https://github.com/libp2p/js-interfaces/commit/c77d8de))
+
+
+
+<a name="0.2.5"></a>
+## [0.2.5](https://github.com/libp2p/js-interfaces/compare/v0.2.4...v0.2.5) (2020-02-04)
+
+
+### Bug Fixes
+
+* **connection:** tracks streams properly ([#25](https://github.com/libp2p/js-interfaces/issues/25)) ([5c88d77](https://github.com/libp2p/js-interfaces/commit/5c88d77))
+
+
+
+<a name="0.2.4"></a>
+## [0.2.4](https://github.com/libp2p/js-interfaces/compare/v0.2.3...v0.2.4) (2020-02-04)
+
+
+### Bug Fixes
+
+* dependencies for tests should not be needed by who requires the tests ([#18](https://github.com/libp2p/js-interfaces/issues/18)) ([c5b724a](https://github.com/libp2p/js-interfaces/commit/c5b724a))
+
+
+
+<a name="0.2.3"></a>
+## [0.2.3](https://github.com/libp2p/js-interfaces/compare/v0.2.2...v0.2.3) (2020-01-21)
+
+
+### Bug Fixes
+
+* **transport:** make close listener test more resilient ([#21](https://github.com/libp2p/js-interfaces/issues/21)) ([2de533e](https://github.com/libp2p/js-interfaces/commit/2de533e))
+
+
+
+<a name="0.2.2"></a>
+## [0.2.2](https://github.com/libp2p/js-interfaces/compare/v0.2.1...v0.2.2) (2020-01-17)
+
+
+### Bug Fixes
+
+* **connection:** dont require remoteAddr on creation ([#20](https://github.com/libp2p/js-interfaces/issues/20)) ([5967834](https://github.com/libp2p/js-interfaces/commit/5967834))
+
+
+
+<a name="0.2.1"></a>
+## [0.2.1](https://github.com/libp2p/js-interfaces/compare/v0.2.0...v0.2.1) (2019-12-28)
+
+
+### Features
+
+* add crypto transmission error ([#17](https://github.com/libp2p/js-interfaces/issues/17)) ([d98bb23](https://github.com/libp2p/js-interfaces/commit/d98bb23))
+
+
+
+<a name="0.2.0"></a>
+# [0.2.0](https://github.com/libp2p/js-interfaces/compare/v0.1.7...v0.2.0) (2019-12-20)
+
+
+### Bug Fixes
+
+* transport should not handle connection if upgradeInbound throws ([#16](https://github.com/libp2p/js-interfaces/issues/16)) ([ff03137](https://github.com/libp2p/js-interfaces/commit/ff03137))
+
+
+
+<a name="0.1.7"></a>
+## [0.1.7](https://github.com/libp2p/js-interfaces/compare/v0.1.6...v0.1.7) (2019-12-15)
+
+
+### Features
+
+* export connection status' ([#15](https://github.com/libp2p/js-interfaces/issues/15)) ([bdbd58e](https://github.com/libp2p/js-interfaces/commit/bdbd58e))
+
+
+
 <a name="0.1.6"></a>
 ## [0.1.6](https://github.com/libp2p/js-interfaces/compare/v0.1.5...v0.1.6) (2019-12-02)
 

package.json

@@ -1,7 +1,8 @@
 {
   "name": "libp2p-interfaces",
-  "version": "0.1.6",
+  "version": "0.3.0",
   "description": "Interfaces for JS Libp2p",
+  "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
   "files": [
     "src",
@@ -33,28 +34,31 @@
   "homepage": "https://github.com/libp2p/js-interfaces#readme",
   "dependencies": {
     "abort-controller": "^3.0.0",
-    "abortable-iterator": "^2.1.0",
-    "async-iterator-to-pull-stream": "^1.3.0",
+    "abortable-iterator": "^3.0.0",
+    "buffer": "^5.6.0",
     "chai": "^4.2.0",
     "chai-checkmark": "^1.0.1",
     "class-is": "^1.1.0",
+    "delay": "^4.3.0",
     "detect-node": "^2.0.4",
     "dirty-chai": "^2.0.1",
     "err-code": "^2.0.0",
     "it-goodbye": "^2.0.1",
+    "it-pair": "^1.0.0",
+    "it-pipe": "^1.0.1",
     "libp2p-tcp": "^0.14.1",
-    "multiaddr": "^7.1.0",
-    "p-limit": "^2.2.1",
-    "peer-id": "^0.13.3",
-    "sinon": "^7.5.0",
+    "multiaddr": "^7.4.3",
+    "p-defer": "^3.0.0",
+    "p-limit": "^2.3.0",
+    "p-wait-for": "^3.1.0",
+    "peer-id": "^0.13.11",
+    "peer-info": "^0.17.0",
+    "sinon": "^9.0.2",
     "streaming-iterables": "^4.1.0"
   },
   "devDependencies": {
-    "aegir": "^20.4.1",
-    "it-handshake": "^1.0.0",
-    "it-pair": "^1.0.0",
-    "it-pipe": "^1.0.1",
-    "peer-info": "^0.17.0"
+    "aegir": "^21.9.0",
+    "it-handshake": "^1.0.1"
   },
   "contributors": [
     "Alan Shaw <alan.shaw@protocol.ai>",
@@ -64,6 +68,7 @@
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
     "Greg Zuro <gregzuro@users.noreply.github.com>",
     "Jacob Heun <jacobheun@gmail.com>",
+    "Jacob Heun <jacobheun@Jacobs-MacBook-Pro.local>",
     "James Ray <16969914+jamesray1@users.noreply.github.com>",
     "Jeffrey Hulten <jhulten@gmail.com>",
     "João Santos <joaosantos15@users.noreply.github.com>",
@@ -76,6 +81,7 @@
     "Sathya Narrayanan <plasmashadowx@gmail.com>",
     "Vasco Santos <vasco.santos@moxy.studio>",
     "Vasco Santos <vasco.santos@ua.pt>",
+    "dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>",
     "dirkmc <dirkmdev@gmail.com>",
     "dmitriy ryajov <dryajov@dmitriys-MBP.HomeNET>",
     "greenkeeperio-bot <support@greenkeeper.io>",

src/connection/README.md

@@ -110,7 +110,7 @@ const conn = new Connection({
 Creates a new Connection instance.
 
 `localAddr` is the optional [multiaddr](https://github.com/multiformats/multiaddr) address used by the local peer to reach the remote.
-`remoteAddr` is the [multiaddr](https://github.com/multiformats/multiaddr) address used to communicate with the remote peer.
+`remoteAddr` is the optional [multiaddr](https://github.com/multiformats/multiaddr) address used to communicate with the remote peer.
 `localPeer` is the [PeerId](https://github.com/libp2p/js-peer-id) of the local peer.
 `remotePeer` is the [PeerId](https://github.com/libp2p/js-peer-id) of the remote peer.
 `newStream` is the `function` responsible for getting a new muxed+multistream-selected stream.
@@ -121,6 +121,7 @@ Creates a new Connection instance.
 - `timeline` is an `object` with the relevant events timestamps of the connection (`open`, `upgraded` and `closed`; the `closed` will be added when the connection is closed).
 - `multiplexer` is a `string` with the connection multiplexing codec (optional).
 - `encryption` is a `string` with the connection encryption method identifier (optional).
+- `status` is a `string` indicating the overall status of the connection. It is one of [`'open'`, `'closing'`, `'closed'`]
 
 #### Create a new stream
 
@@ -220,7 +221,17 @@ This getter returns an `Object` with the metadata of the connection, as follows:
 
 - `status`:
 
-This property contains the status of the connection. It can be either `open`, `closing` or `closed`. Once the connection is created it is in an `open` status. When a `conn.close()` happens, the status will change to `closing` and finally, after all the connection streams are properly closed, the status will be `closed`.
+This property contains the status of the connection. It can be either `open`, `closing` or `closed`. Once the connection is created it is in an `open` status. When a `conn.close()` happens, the status will change to `closing` and finally, after all the connection streams are properly closed, the status will be `closed`. These values can also be directly referenced by importing the `status` file:
+
+```js
+const {
+  OPEN, CLOSING, CLOSED
+} = require('libp2p-interfaces/src/connection/status')
+
+if (connection.stat.status === OPEN) {
+  // ...
+}
+```
 
 - `timeline`:
 

src/connection/connection.js

@@ -2,11 +2,55 @@
 
 const PeerId = require('peer-id')
 const multiaddr = require('multiaddr')
-
 const withIs = require('class-is')
-
-const assert = require('assert')
 const errCode = require('err-code')
+const Status = require('./status')
+
+function validateArgs (localAddr, localPeer, remotePeer, newStream, close, getStreams, stat) {
+  if (localAddr && !multiaddr.isMultiaddr(localAddr)) {
+    throw errCode(new Error('localAddr must be an instance of multiaddr'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (!PeerId.isPeerId(localPeer)) {
+    throw errCode(new Error('localPeer must be an instance of peer-id'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (!PeerId.isPeerId(remotePeer)) {
+    throw errCode(new Error('remotePeer must be an instance of peer-id'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (typeof newStream !== 'function') {
+    throw errCode(new Error('new stream must be a function'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (typeof close !== 'function') {
+    throw errCode(new Error('close must be a function'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (typeof getStreams !== 'function') {
+    throw errCode(new Error('getStreams must be a function'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (!stat) {
+    throw errCode(new Error('connection metadata object must be provided'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (stat.direction !== 'inbound' && stat.direction !== 'outbound') {
+    throw errCode(new Error('direction must be "inbound" or "outbound"'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (!stat.timeline) {
+    throw errCode(new Error('connection timeline object must be provided in the stat object'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (!stat.timeline.open) {
+    throw errCode(new Error('connection open timestamp must be provided'), 'ERR_INVALID_PARAMETERS')
+  }
+
+  if (!stat.timeline.upgraded) {
+    throw errCode(new Error('connection upgraded timestamp must be provided'), 'ERR_INVALID_PARAMETERS')
+  }
+}
 
 /**
  * An implementation of the js-libp2p connection.
@@ -17,7 +61,7 @@ class Connection {
    * Creates an instance of Connection.
    * @param {object} properties properties of the connection.
    * @param {multiaddr} [properties.localAddr] local multiaddr of the connection if known.
-   * @param {multiaddr} properties.remoteAddr remote multiaddr of the connection.
+   * @param {multiaddr} [properties.remoteAddr] remote multiaddr of the connection.
    * @param {PeerId} properties.localPeer local peer-id.
    * @param {PeerId} properties.remotePeer remote peer-id.
    * @param {function} properties.newStream new stream muxer function.
@@ -32,18 +76,7 @@ class Connection {
    * @param {string} [properties.stat.encryption] connection encryption method identifier.
    */
   constructor ({ localAddr, remoteAddr, localPeer, remotePeer, newStream, close, getStreams, stat }) {
-    localAddr && assert(multiaddr.isMultiaddr(localAddr), 'localAddr must be an instance of multiaddr')
-    assert(multiaddr.isMultiaddr(remoteAddr), 'remoteAddr must be an instance of multiaddr')
-    assert(PeerId.isPeerId(localPeer), 'localPeer must be an instance of peer-id')
-    assert(PeerId.isPeerId(remotePeer), 'remotePeer must be an instance of peer-id')
-    assert(typeof newStream === 'function', 'new stream must be a function')
-    assert(typeof close === 'function', 'close must be a function')
-    assert(typeof getStreams === 'function', 'getStreams must be a function')
-    assert(stat, 'connection metadata object must be provided')
-    assert(stat.direction === 'inbound' || stat.direction === 'outbound', 'direction must be "inbound" or "outbound"')
-    assert(stat.timeline, 'connection timeline object must be provided in the stat object')
-    assert(stat.timeline.open, 'connection open timestamp must be provided')
-    assert(stat.timeline.upgraded, 'connection upgraded timestamp must be provided')
+    validateArgs(localAddr, localPeer, remotePeer, newStream, close, getStreams, stat)
 
     /**
      * Connection identifier.
@@ -75,7 +108,7 @@ class Connection {
      */
     this._stat = {
       ...stat,
-      status: 'open'
+      status: Status.OPEN
     }
 
     /**
@@ -126,11 +159,11 @@ class Connection {
    * @return {Promise<object>} with muxed+multistream-selected stream and selected protocol
    */
   async newStream (protocols) {
-    if (this.stat.status === 'closing') {
+    if (this.stat.status === Status.CLOSING) {
       throw errCode(new Error('the connection is being closed'), 'ERR_CONNECTION_BEING_CLOSED')
     }
 
-    if (this.stat.status === 'closed') {
+    if (this.stat.status === Status.CLOSED) {
       throw errCode(new Error('the connection is closed'), 'ERR_CONNECTION_CLOSED')
     }
 
@@ -138,7 +171,7 @@ class Connection {
 
     const { stream, protocol } = await this._newStream(protocols)
 
-    this.addStream(stream, protocol)
+    this.addStream(stream, { protocol })
 
     return {
       stream,
@@ -175,7 +208,7 @@ class Connection {
    * @return {Promise}
    */
   async close () {
-    if (this.stat.status === 'closed') {
+    if (this.stat.status === Status.CLOSED) {
       return
     }
 
@@ -183,13 +216,13 @@ class Connection {
       return this._closing
     }
 
-    this.stat.status = 'closing'
+    this.stat.status = Status.CLOSING
 
     // Close raw connection
     this._closing = await this._close()
 
     this._stat.timeline.close = Date.now()
-    this.stat.status = 'closed'
+    this.stat.status = Status.CLOSED
   }
 }
 

src/connection/status.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = {
+  OPEN: 'open',
+  CLOSING: 'closing',
+  CLOSED: 'closed'
+}

src/connection/tests/connection.js

@@ -6,6 +6,7 @@ const chai = require('chai')
 const expect = chai.expect
 chai.use(require('dirty-chai'))
 const sinon = require('sinon')
+const Status = require('../status')
 
 module.exports = (test) => {
   describe('connection', () => {
@@ -28,7 +29,7 @@ module.exports = (test) => {
         expect(connection.remotePeer).to.exist()
         expect(connection.localAddr).to.exist()
         expect(connection.remoteAddr).to.exist()
-        expect(connection.stat.status).to.equal('open')
+        expect(connection.stat.status).to.equal(Status.OPEN)
         expect(connection.stat.timeline.open).to.exist()
         expect(connection.stat.timeline.upgraded).to.exist()
         expect(connection.stat.timeline.close).to.not.exist()
@@ -40,7 +41,7 @@ module.exports = (test) => {
       it('should get the metadata of an open connection', () => {
         const stat = connection.stat
 
-        expect(stat.status).to.equal('open')
+        expect(stat.status).to.equal(Status.OPEN)
         expect(stat.direction).to.exist()
         expect(stat.timeline.open).to.exist()
         expect(stat.timeline.upgraded).to.exist()
@@ -103,7 +104,7 @@ module.exports = (test) => {
         await connection.close()
 
         expect(connection.stat.timeline.close).to.exist()
-        expect(connection.stat.status).to.equal('closed')
+        expect(connection.stat.status).to.equal(Status.CLOSED)
       })
 
       it('should be able to close the connection after opening a stream', async () => {
@@ -116,7 +117,20 @@ module.exports = (test) => {
         await connection.close()
 
         expect(connection.stat.timeline.close).to.exist()
-        expect(connection.stat.status).to.equal('closed')
+        expect(connection.stat.status).to.equal(Status.CLOSED)
+      })
+
+      it('should properly track streams', async () => {
+        // Open stream
+        const protocol = '/echo/0.0.1'
+        const { stream } = await connection.newStream(protocol)
+        const trackedStream = connection.registry.get(stream.id)
+        expect(trackedStream).to.have.property('protocol', protocol)
+
+        // Close stream
+        await stream.close()
+
+        expect(connection.registry.get(stream.id)).to.not.exist()
       })
 
       it('should support a proxy on the timeline', async () => {

src/content-routing/README.md

@@ -12,7 +12,7 @@ Publishing a test suite as a module lets multiple modules all ensure compatibili
 # Modules that implement the interface
 
 - [JavaScript libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht)
-- [JavaScript libp2p-delegated-peer-routing](https://github.com/libp2p/js-libp2p-delegated-peer-routing)
+- [JavaScript libp2p-delegated-content-routing](https://github.com/libp2p/js-libp2p-delegated-content-routing)
 
 # Badge
 
@@ -30,6 +30,32 @@ TBD
 
 A valid (read: that follows this abstraction) Content Routing module must implement the following API.
 
-### `.findProviders`
+### findProviders
 
-### `.provide`
+- `findProviders(cid)`
+
+Find peers in the network that can provide a specific value, given a key.
+
+**Parameters**
+- [CID](https://github.com/multiformats/js-cid)
+
+**Returns**
+
+It returns an `AsyncIterable` containing the identification and addresses of the peers providing the given key, as follows:
+
+`AsyncIterable<{ id: PeerId, addrs: Multiaddr[] }>`
+
+### provide
+
+- `provide(cid)`
+
+Announce to the network that we are providing the given value.
+
+**Parameters**
+- [CID](https://github.com/multiformats/js-cid)
+
+**Returns**
+
+It returns a promise that is resolved on the success of the operation.
+
+`Promise<void>`

src/crypto/README.md

@@ -85,6 +85,7 @@ Common crypto errors come with the interface, and can be imported directly. All
 ```js
 const {
   InvalidCryptoExchangeError,
+  InvalidCryptoTransmissionError,
   UnexpectedPeerError
 } = require('libp2p-interfaces/src/crypto/errors')
 
@@ -95,4 +96,5 @@ console.log(error.code === UnexpectedPeerError.code) // true
 ### Error Types
 
 - `InvalidCryptoExchangeError` - Should be thrown when a peer provides data that is insufficient to finish the crypto exchange.
+- `InvalidCryptoTransmissionError` - Should be thrown when an error occurs during encryption/decryption.
 - `UnexpectedPeerError` - Should be thrown when the expected peer id does not match the peer id determined via the crypto exchange.

src/crypto/errors.js

@@ -22,7 +22,19 @@ class InvalidCryptoExchangeError extends Error {
   }
 }
 
+class InvalidCryptoTransmissionError extends Error {
+  constructor (message = 'Invalid crypto transmission') {
+    super(message)
+    this.code = InvalidCryptoTransmissionError.code
+  }
+
+  static get code () {
+    return 'ERR_INVALID_CRYPTO_TRANSMISSION'
+  }
+}
+
 module.exports = {
   UnexpectedPeerError,
-  InvalidCryptoExchangeError
+  InvalidCryptoExchangeError,
+  InvalidCryptoTransmissionError
 }

src/crypto/tests/index.js

@@ -1,6 +1,7 @@
 /* eslint-env mocha */
 'use strict'
 
+const { Buffer } = require('buffer')
 const duplexPair = require('it-pair/duplex')
 const pipe = require('it-pipe')
 const peers = require('../../utils/peers')

src/peer-discovery/README.md

@@ -16,6 +16,7 @@ The API is presented with both Node.js and Go primitives, however, there is not
 - [JavaScript libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht)
 - [JavaScript libp2p-webrtc-star](https://github.com/libp2p/js-libp2p-webrtc-star)
 - [JavaScript libp2p-websocket-star](https://github.com/libp2p/js-libp2p-websocket-star)
+- [TypeScript discv5](https://github.com/chainsafe/discv5)
 
 Send a PR to add a new one if you happen to find or write one.
 
@@ -69,6 +70,9 @@ It returns a `Promise`
 
 ### discoverying peers
 
-- `discovery.on('peer', (peerInfo) => {})`
+- `discovery.on('peer', (peerData) => {})`
 
-Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discover peer's [PeerInfo](https://github.com/libp2p/js-peer-info).
+Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which must contain the following properties:
+
+- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
+- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs`

src/peer-discovery/tests/index.js

@@ -1,17 +1,31 @@
 /* eslint-env mocha */
 'use strict'
 
+const chai = require('chai')
+const expect = chai.expect
+chai.use(require('dirty-chai'))
+
+const multiaddr = require('multiaddr')
+const PeerId = require('peer-id')
+
+const delay = require('delay')
+const pDefer = require('p-defer')
+
 module.exports = (common) => {
   describe('interface-peer-discovery', () => {
     let discovery
 
-    before(async () => {
+    beforeEach(async () => {
       discovery = await common.setup()
     })
 
-    after(() => common.teardown && common.teardown())
+    afterEach('ensure discovery was stopped', async () => {
+      await discovery.stop()
 
-    afterEach('ensure discovery was stopped', () => discovery.stop())
+      discovery.removeAllListeners()
+
+      common.teardown && common.teardown()
+    })
 
     it('can start the service', async () => {
       await discovery.start()
@@ -30,5 +44,49 @@ module.exports = (common) => {
       await discovery.start()
       await discovery.start()
     })
+
+    it('should emit a peer event after start', async () => {
+      const defer = pDefer()
+      await discovery.start()
+
+      discovery.on('peer', ({ id, multiaddrs }) => {
+        expect(id).to.exist()
+        expect(PeerId.isPeerId(id)).to.eql(true)
+        expect(multiaddrs).to.exist()
+
+        multiaddrs.forEach((m) => expect(multiaddr.isMultiaddr(m)).to.eql(true))
+
+        defer.resolve()
+      })
+
+      await defer.promise
+    })
+
+    it('should not receive a peer event before start', async () => {
+      discovery.on('peer', () => {
+        throw new Error('should not receive a peer event before start')
+      })
+
+      await delay(2000)
+    })
+
+    it('should not receive a peer event after stop', async () => {
+      const deferStart = pDefer()
+
+      await discovery.start()
+
+      discovery.on('peer', () => {
+        deferStart.resolve()
+      })
+
+      await deferStart.promise
+      await discovery.stop()
+
+      discovery.on('peer', () => {
+        throw new Error('should not receive a peer event after stop')
+      })
+
+      await delay(2000)
+    })
   })
 }

src/peer-routing/README.md

@@ -30,12 +30,17 @@ TBD
 
 A valid (read: that follows this abstraction) Peer Routing module must implement the following API.
 
-### `.findPeers` - Find peers 'responsible' or 'closest' to a given key
+### findPeer
 
-- `Node.js` peerRouting.findPeers(key, function (err, peersPriorityQueue) {})
+- `findPeer(peerId)`
 
-In a peer to peer context, the concept of 'responsability' or 'closeness' for a given key translates to having a way to find deterministically or that at least there is a significant overlap between searches, the same group of peers when searching for the same given key.
+Query the network for all multiaddresses associated with a `PeerId`.
 
-This method will query the network (route it) and return a Priority Queue datastructe with a list of PeerInfo objects, ordered by 'closeness'.
+**Parameters**
+- [peerId](https://github.com/libp2p/js-peer-id).
 
-key is a multihash
+**Returns**
+
+It returns the [peerId](https://github.com/libp2p/js-peer-id) together with the known peers [multiaddrs](https://github.com/multiformats/js-multiaddr), as follows:
+
+`Promise<{ id: PeerId, addrs: Multiaddr[] }>`

src/stream-muxer/tests/close-test.js

@@ -2,6 +2,7 @@
 /* eslint max-nested-callbacks: ["error", 8] */
 'use strict'
 
+const { Buffer } = require('buffer')
 const pair = require('it-pair/duplex')
 const pipe = require('it-pipe')
 const { consume } = require('streaming-iterables')

src/topology/README.md

@@ -56,8 +56,8 @@ const toplogy = new MulticodecTopology({
   max: 50,
   multicodecs: ['/echo/1.0.0'],
   handlers: {
-    onConnect: (peerInfo, conn) => {},
-    onDisconnect: (peerInfo) => {}
+    onConnect: (peerId, conn) => {},
+    onDisconnect: (peerId) => {}
   }
 })
 ```
@@ -69,8 +69,8 @@ The `MulticodecTopology` extends the `Topology`, which makes the `Topology` API
 ###  Topology
 
 - `Topology`
-  - `peers<Map<string, PeerInfo>>`: A Map of peers belonging to the topology.
-  - `disconnect<function(PeerInfo)>`: Called when a peer has been disconnected
+  - `peers<Map<string, PeerId>>`: A Map of peers belonging to the topology.
+  - `disconnect<function(PeerId)>`: Called when a peer has been disconnected
 
 #### Constructor
 
@@ -79,8 +79,8 @@ const toplogy = new Topology({
   min: 0,
   max: 50,
   handlers: {
-    onConnect: (peerInfo, conn) => {},
-    onDisconnect: (peerInfo) => {}
+    onConnect: (peerId, conn) => {},
+    onDisconnect: (peerId) => {}
   }
 })
 ```
@@ -95,27 +95,27 @@ const toplogy = new Topology({
 
 #### Set a peer
 
-- `topology.peers.set(id, peerInfo)`
+- `topology.peers.set(id, peerId)`
 
 Add a peer to the topology.
 
 **Parameters**
 - `id` is the `string` that identifies the peer to add.
-- `peerInfo` is the [PeerInfo][peer-info] of the peer to add.
+- `peerId` is the [PeerId][peer-id] of the peer to add.
 
 #### Notify about a peer disconnected event
 
-- `topology.disconnect(peerInfo)`
+- `topology.disconnect(peerId)`
 
 **Parameters**
-- `peerInfo` is the [PeerInfo][peer-info] of the peer disconnected.
+- `peerId` is the [PeerId][peer-id] of the peer disconnected.
 
 ###  Multicodec Topology
 
 - `MulticodecTopology`
   - `registrar<Registrar>`: The `Registrar` of the topology. This is set by the `Registrar` during registration.
-  - `peers<Map<string, PeerInfo>>`: The Map of peers that belong to the topology
-  - `disconnect<function(PeerInfo)>`: Disconnects a peer from the topology.
+  - `peers<Map<string, PeerId>>`: The Map of peers that belong to the topology
+  - `disconnect<function(PeerId)>`: Disconnects a peer from the topology.
 
 #### Constructor
 
@@ -125,8 +125,8 @@ const toplogy = new MulticodecTopology({
   max: 50,
   multicodecs: ['/echo/1.0.0'],
   handlers: {
-    onConnect: (peerInfo, conn) => {},
-    onDisconnect: (peerInfo) => {}
+    onConnect: (peerId, conn) => {},
+    onDisconnect: (peerId) => {}
   }
 })
 ```
@@ -139,3 +139,5 @@ const toplogy = new MulticodecTopology({
   - `handlers` is an optional `Object` containing the handler called when a peer is connected or disconnected.
     - `onConnect` is a `function` called everytime a peer is connected in the topology context.
     - `onDisconnect` is a `function` called everytime a peer is disconnected in the topology context.
+
+[peer-id]: https://github.com/libp2p/js-peer-id

src/topology/index.js

@@ -26,7 +26,11 @@ class Topology {
     this._onConnect = handlers.onConnect || noop
     this._onDisconnect = handlers.onDisconnect || noop
 
-    this.peers = new Map()
+    /**
+     * Set of peers that support the protocol.
+     * @type {Set<string>}
+     */
+    this.peers = new Set()
   }
 
   set registrar (registrar) {
@@ -35,11 +39,11 @@ class Topology {
 
   /**
    * Notify about peer disconnected event.
-   * @param {PeerInfo} peerInfo
+   * @param {PeerId} peerId
    * @returns {void}
    */
-  disconnect (peerInfo) {
-    this._onDisconnect(peerInfo)
+  disconnect (peerId) {
+    this._onDisconnect(peerId)
   }
 }
 

src/topology/multicodec-topology.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const assert = require('assert')
 const withIs = require('class-is')
 
 const Topology = require('./index')
@@ -24,12 +23,21 @@ class MulticodecTopology extends Topology {
   }) {
     super({ min, max, handlers })
 
-    assert(multicodecs, 'one or more multicodec should be provided')
-    assert(handlers, 'the handlers should be provided')
-    assert(handlers.onConnect && typeof handlers.onConnect === 'function',
-      'the \'onConnect\' handler must be provided')
-    assert(handlers.onDisconnect && typeof handlers.onDisconnect === 'function',
-      'the \'onDisconnect\' handler must be provided')
+    if (!multicodecs) {
+      throw new Error('one or more multicodec should be provided')
+    }
+
+    if (!handlers) {
+      throw new Error('the handlers should be provided')
+    }
+
+    if (typeof handlers.onConnect !== 'function') {
+      throw new Error('the \'onConnect\' handler must be provided')
+    }
+
+    if (typeof handlers.onDisconnect !== 'function') {
+      throw new Error('the \'onDisconnect\' handler must be provided')
+    }
 
     this.multicodecs = Array.isArray(multicodecs) ? multicodecs : [multicodecs]
     this._registrar = undefined
@@ -47,20 +55,20 @@ class MulticodecTopology extends Topology {
 
   /**
    * Update topology.
-   * @param {Array<PeerInfo>} peerInfoIterable
+   * @param {Array<{id: PeerId, multiaddrs: Array<Multiaddr>, protocols: Array<string>}>} peerDataIterable
    * @returns {void}
    */
-  _updatePeers (peerInfoIterable) {
-    for (const peerInfo of peerInfoIterable) {
-      if (this.multicodecs.filter(multicodec => peerInfo.protocols.has(multicodec)).length) {
+  _updatePeers (peerDataIterable) {
+    for (const { id, protocols } of peerDataIterable) {
+      if (this.multicodecs.filter(multicodec => protocols.includes(multicodec)).length) {
         // Add the peer regardless of whether or not there is currently a connection
-        this.peers.set(peerInfo.id.toB58String(), peerInfo)
+        this.peers.add(id.toB58String())
         // If there is a connection, call _onConnect
-        const connection = this._registrar.getConnection(peerInfo)
-        connection && this._onConnect(peerInfo, connection)
+        const connection = this._registrar.getConnection(id)
+        connection && this._onConnect(id, connection)
       } else {
         // Remove any peers we might be tracking that are no longer of value to us
-        this.peers.delete(peerInfo.id.toB58String())
+        this.peers.delete(id.toB58String())
       }
     }
   }
@@ -68,22 +76,23 @@ class MulticodecTopology extends Topology {
   /**
    * Check if a new peer support the multicodecs for this topology.
    * @param {Object} props
-   * @param {PeerInfo} props.peerInfo
+   * @param {PeerId} props.peerId
    * @param {Array<string>} props.protocols
    */
-  _onProtocolChange ({ peerInfo, protocols }) {
-    const existingPeer = this.peers.get(peerInfo.id.toB58String())
+  _onProtocolChange ({ peerId, protocols }) {
+    const hadPeer = this.peers.has(peerId.toB58String())
     const hasProtocol = protocols.filter(protocol => this.multicodecs.includes(protocol))
 
     // Not supporting the protocol anymore?
-    if (existingPeer && hasProtocol.length === 0) {
-      this._onDisconnect(peerInfo)
+    if (hadPeer && hasProtocol.length === 0) {
+      this._onDisconnect(peerId)
     }
 
     // New to protocol support
     for (const protocol of protocols) {
       if (this.multicodecs.includes(protocol)) {
-        this._updatePeers([peerInfo])
+        const peerData = this._registrar.peerStore.get(peerId)
+        this._updatePeers([peerData])
         return
       }
     }

src/topology/tests/multicodec-topology.js

@@ -8,19 +8,18 @@ chai.use(require('dirty-chai'))
 const sinon = require('sinon')
 
 const PeerId = require('peer-id')
-const PeerInfo = require('peer-info')
+
 const peers = require('../../utils/peers')
 
 module.exports = (test) => {
   describe('multicodec topology', () => {
-    let topology, peer
+    let topology, id
 
     beforeEach(async () => {
       topology = await test.setup()
       if (!topology) throw new Error('missing multicodec topology')
 
-      const id = await PeerId.createFromJSON(peers[0])
-      peer = await PeerInfo.create(id)
+      id = await PeerId.createFromJSON(peers[0])
     })
 
     afterEach(async () => {
@@ -38,7 +37,7 @@ module.exports = (test) => {
 
     it('should trigger "onDisconnect" on peer disconnected', () => {
       sinon.spy(topology, '_onDisconnect')
-      topology.disconnect(peer)
+      topology.disconnect(id)
 
       expect(topology._onDisconnect.callCount).to.equal(1)
     })
@@ -47,13 +46,16 @@ module.exports = (test) => {
       sinon.spy(topology, '_updatePeers')
       expect(topology.peers.size).to.eql(0)
 
-      const id2 = await PeerId.createFromJSON(peers[1])
-      const peer2 = await PeerInfo.create(id2)
-      topology.multicodecs.forEach((m) => peer2.protocols.add(m))
-
       const peerStore = topology._registrar.peerStore
+
+      const id2 = await PeerId.createFromJSON(peers[1])
+      peerStore.peers.set(id2.toB58String(), {
+        id: id2,
+        protocols: Array.from(topology.multicodecs)
+      })
+
       peerStore.emit('change:protocols', {
-        peerInfo: peer2,
+        peerId: id2,
         protocols: Array.from(topology.multicodecs)
       })
 
@@ -65,28 +67,34 @@ module.exports = (test) => {
       sinon.spy(topology, '_onDisconnect')
       expect(topology.peers.size).to.eql(0)
 
-      const id2 = await PeerId.createFromJSON(peers[1])
-      const peer2 = await PeerInfo.create(id2)
-      topology.multicodecs.forEach((m) => peer2.protocols.add(m))
-
       const peerStore = topology._registrar.peerStore
+
+      const id2 = await PeerId.createFromJSON(peers[1])
+      peerStore.peers.set(id2.toB58String(), {
+        id: id2,
+        protocols: Array.from(topology.multicodecs)
+      })
+
       peerStore.emit('change:protocols', {
-        peerInfo: peer2,
+        peerId: id2,
         protocols: Array.from(topology.multicodecs)
       })
 
       expect(topology.peers.size).to.eql(1)
 
-      topology.multicodecs.forEach((m) => peer2.protocols.delete(m))
+      peerStore.peers.set(id2.toB58String(), {
+        id: id2,
+        protocols: []
+      })
       // Peer does not support the protocol anymore
       peerStore.emit('change:protocols', {
-        peerInfo: peer2,
+        peerId: id2,
         protocols: []
       })
 
       expect(topology.peers.size).to.eql(1)
       expect(topology._onDisconnect.callCount).to.equal(1)
-      expect(topology._onDisconnect.calledWith(peer2)).to.equal(true)
+      expect(topology._onDisconnect.calledWith(id2)).to.equal(true)
     })
   })
 }

src/topology/tests/topology.js

@@ -8,19 +8,17 @@ chai.use(require('dirty-chai'))
 const sinon = require('sinon')
 
 const PeerId = require('peer-id')
-const PeerInfo = require('peer-info')
 const peers = require('../../utils/peers')
 
 module.exports = (test) => {
   describe('topology', () => {
-    let topology, peer
+    let topology, id
 
     beforeEach(async () => {
       topology = await test.setup()
       if (!topology) throw new Error('missing multicodec topology')
 
-      const id = await PeerId.createFromJSON(peers[0])
-      peer = await PeerInfo.create(id)
+      id = await PeerId.createFromJSON(peers[0])
     })
 
     afterEach(async () => {
@@ -38,7 +36,7 @@ module.exports = (test) => {
 
     it('should trigger "onDisconnect" on peer disconnected', () => {
       sinon.spy(topology, '_onDisconnect')
-      topology.disconnect(peer)
+      topology.disconnect(id)
 
       expect(topology._onDisconnect.callCount).to.equal(1)
     })

src/transport/tests/listen-test.js

@@ -2,12 +2,14 @@
 /* eslint-env mocha */
 'use strict'
 
+const { Buffer } = require('buffer')
 const chai = require('chai')
 const dirtyChai = require('dirty-chai')
 const expect = chai.expect
 chai.use(dirtyChai)
 const sinon = require('sinon')
 
+const pWaitFor = require('p-wait-for')
 const pipe = require('it-pipe')
 const { isValidTick } = require('./utils')
 
@@ -69,7 +71,7 @@ module.exports = (common) => {
       ])
 
       // Give the listener a chance to finish its upgrade
-      await new Promise(resolve => setTimeout(resolve, 0))
+      await pWaitFor(() => listenerConns.length === 2)
 
       // Wait for the data send and close to finish
       await Promise.all([
@@ -92,6 +94,23 @@ module.exports = (common) => {
       expect(upgradeSpy.callCount).to.equal(2)
     })
 
+    it('should not handle connection if upgradeInbound throws', async () => {
+      sinon.stub(upgrader, 'upgradeInbound').throws()
+
+      const listener = transport.createListener(() => {
+        throw new Error('should not handle the connection if upgradeInbound throws')
+      })
+
+      // Listen
+      await listener.listen(addrs[0])
+
+      // Create a connection to the listener
+      const socket = await transport.dial(addrs[0])
+
+      await pWaitFor(() => typeof socket.timeline.close === 'number')
+      await listener.close()
+    })
+
     describe('events', () => {
       it('connection', (done) => {
         const upgradeSpy = sinon.spy(upgrader, 'upgradeInbound')

test/connection/compliance.spec.js

@@ -25,7 +25,7 @@ describe('compliance tests', () => {
       const openStreams = []
       let streamId = 0
 
-      return new Connection({
+      const connection = new Connection({
         localPeer,
         remotePeer,
         localAddr,
@@ -43,7 +43,10 @@ describe('compliance tests', () => {
           const id = streamId++
           const stream = pair()
 
-          stream.close = () => stream.sink([])
+          stream.close = async () => {
+            await stream.sink([])
+            connection.removeStream(stream.id)
+          }
           stream.id = id
 
           openStreams.push(stream)
@@ -57,6 +60,7 @@ describe('compliance tests', () => {
         getStreams: () => openStreams,
         ...properties
       })
+      return connection
     },
     async teardown () {
       // cleanup resources created by setup()

test/connection/index.spec.js

@@ -0,0 +1,48 @@
+/* eslint-env mocha */
+'use strict'
+
+const { Connection } = require('../../src/connection')
+const peers = require('../../src/utils/peers')
+const PeerId = require('peer-id')
+const pair = require('it-pair')
+
+describe('connection tests', () => {
+  it('should not require local or remote addrs', async () => {
+    const [localPeer, remotePeer] = await Promise.all([
+      PeerId.createFromJSON(peers[0]),
+      PeerId.createFromJSON(peers[1])
+    ])
+    const openStreams = []
+    let streamId = 0
+
+    return new Connection({
+      localPeer,
+      remotePeer,
+      stat: {
+        timeline: {
+          open: Date.now() - 10,
+          upgraded: Date.now()
+        },
+        direction: 'outbound',
+        encryption: '/secio/1.0.0',
+        multiplexer: '/mplex/6.7.0'
+      },
+      newStream: (protocols) => {
+        const id = streamId++
+        const stream = pair()
+
+        stream.close = () => stream.sink([])
+        stream.id = id
+
+        openStreams.push(stream)
+
+        return {
+          stream,
+          protocol: protocols[0]
+        }
+      },
+      close: () => {},
+      getStreams: () => openStreams
+    })
+  })
+})

test/peer-discovery/compliance.spec.js

@@ -5,13 +5,20 @@ const tests = require('../../src/peer-discovery/tests')
 const MockDiscovery = require('./mock-discovery')
 
 describe('compliance tests', () => {
+  let intervalId
+
   tests({
-    async setup () {
-      await new Promise(resolve => setTimeout(resolve, 10))
-      return new MockDiscovery()
+    setup () {
+      const mockDiscovery = new MockDiscovery({
+        discoveryDelay: 1
+      })
+
+      intervalId = setInterval(mockDiscovery._discoverPeer, 1000)
+
+      return mockDiscovery
     },
-    async teardown () {
-      await new Promise(resolve => setTimeout(resolve, 10))
+    teardown () {
+      clearInterval(intervalId)
     }
   })
 })

test/peer-discovery/mock-discovery.js

@@ -2,8 +2,8 @@
 
 const { EventEmitter } = require('events')
 
+const multiaddr = require('multiaddr')
 const PeerId = require('peer-id')
-const PeerInfo = require('peer-info')
 
 /**
  * Emits 'peer' events on discovery.
@@ -37,10 +37,12 @@ class MockDiscovery extends EventEmitter {
     if (!this._isRunning) return
 
     const peerId = await PeerId.create({ bits: 512 })
-    const peerInfo = new PeerInfo(peerId)
 
     this._timer = setTimeout(() => {
-      this.emit('peer', peerInfo)
+      this.emit('peer', {
+        id: peerId,
+        multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')]
+      })
     }, this.options.discoveryDelay || 1000)
   }
 }

test/topology/mock-peer-store.js

@@ -7,6 +7,10 @@ class MockPeerStore extends EventEmitter {
     super()
     this.peers = peers
   }
+
+  get (peerId) {
+    return this.peers.get(peerId.toB58String())
+  }
 }
 
 module.exports = MockPeerStore

test/topology/multicodec-topology.spec.js

@@ -21,7 +21,8 @@ describe('multicodec topology compliance tests', () => {
       })
 
       if (!registrar) {
-        const peerStore = new MockPeerStore([])
+        const peers = new Map()
+        const peerStore = new MockPeerStore(peers)
 
         registrar = {
           peerStore,