chore: add discv5 peer-discovery module

* test(fix): dont use mdns in browser tests

* refactor: use async await consistently for _setupPeerDiscovery

CHANGELOG.md

@@ -1,3 +1,13 @@
+<a name="0.27.5"></a>
+## [0.27.5](https://github.com/libp2p/js-libp2p/compare/v0.27.4...v0.27.5) (2020-04-06)
+
+
+### Bug Fixes
+
+* await peer discovery start in libp2p start ([#600](https://github.com/libp2p/js-libp2p/issues/600)) ([bd7fd0f](https://github.com/libp2p/js-libp2p/commit/bd7fd0f))
+
+
+
 <a name="0.27.4"></a>
 ## [0.27.4](https://github.com/libp2p/js-libp2p/compare/v0.27.3...v0.27.4) (2020-03-31)
 

README.md

@@ -157,6 +157,7 @@ List of packages currently in existence for libp2p
 | [`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/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/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-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/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) |
+| [`discv5`](//github.com/ChainSafe/discv5) | [![npm](https://img.shields.io/npm/v/discv5.svg?maxAge=86400&style=flat-square)](//github.com/ChainSafe/discv5/releases) | [![Deps](https://david-dm.org/ChainSafe/discv5.svg?style=flat-square)](https://david-dm.org/ChainSafe/discv5) | [![Travis CI](https://flat.badgen.net/travis/ChainSafe/discv5/master)](https://travis-ci.com/ChainSafe/discv5) | [![codecov](https://codecov.io/gh/ChainSafe/discv5/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ChainSafe/discv5) | [Cayman Nava](mailto:caymannava@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/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/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) |

doc/CONFIGURATION.md

@@ -113,6 +113,7 @@ Some available peer discovery modules are:
 - [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)
+- [discv5](https://github.com/chainsafe/discv5)
 
 **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.
 

package-list.json

@@ -33,6 +33,7 @@
     ["libp2p/js-libp2p-kad-dht", "libp2p-kad-dht"],
     ["libp2p/js-libp2p-mdns", "libp2p-mdns"],
     ["libp2p/js-libp2p-webrtc-star", "libp2p-webrtc-star"],
+    ["ChainSafe/discv5", "discv5"],
 
     "content routing",
     ["libp2p/js-libp2p-delegated-content-routing", "libp2p-delegated-content-routing"],

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.27.4",
+  "version": "0.27.5",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -123,30 +123,30 @@
     "Richard Littauer <richard.littauer@gmail.com>",
     "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
     "Andrew Nesbitt <andrewnez@gmail.com>",
+    "Cayman <caymannava@gmail.com>",
     "Elven <mon.samuel@qq.com>",
     "Giovanni T. Parra <fiatjaf@gmail.com>",
     "Ryan Bell <ryan@piing.net>",
     "Thomas Eizinger <thomas@eizinger.io>",
-    "Henrique Dias <hacdias@gmail.com>",
+    "Joel Gustafson <joelg@mit.edu>",
     "Kevin Kwok <antimatter15@gmail.com>",
+    "Henrique Dias <hacdias@gmail.com>",
     "Nuno Nogueira <nunofmn@gmail.com>",
-    "Florian-Merle <florian.david.merle@gmail.com>",
     "RasmusErik Voel Jensen <github@solsort.com>",
-    "Fei Liu <liu.feiwood@gmail.com>",
+    "Florian-Merle <florian.david.merle@gmail.com>",
     "Soeren <nikorpoulsen@gmail.com>",
     "Sönke Hahn <soenkehahn@gmail.com>",
     "Tiago Alves <alvesjtiago@gmail.com>",
+    "Fei Liu <liu.feiwood@gmail.com>",
     "Dmitriy Ryajov <dryajov@gmail.com>",
     "Diogo Silva <fsdiogo@gmail.com>",
-    "Didrik Nordström <didrik.nordstrom@gmail.com>",
     "Yusef Napora <yusef@napora.org>",
     "Zane Starr <zcstarr@gmail.com>",
+    "Didrik Nordström <didrik.nordstrom@gmail.com>",
     "Daijiro Wachi <daijiro.wachi@gmail.com>",
-    "Chris Bratlien <chrisbratlien@gmail.com>",
     "ebinks <elizabethjbinks@gmail.com>",
-    "Cayman <caymannava@gmail.com>",
+    "Chris Bratlien <chrisbratlien@gmail.com>",
     "isan_rivkin <isanrivkin@gmail.com>",
-    "Irakli Gozalishvili <rfobic@gmail.com>",
-    "Joel Gustafson <joelg@mit.edu>"
+    "Irakli Gozalishvili <rfobic@gmail.com>"
   ]
 }

src/index.js

@@ -399,7 +399,7 @@ class Libp2p extends EventEmitter {
    * Called when libp2p has started and before it returns
    * @private
    */
-  _onDidStart () {
+  async _onDidStart () {
     this._isStarted = true
 
     this.connectionManager.start()
@@ -410,7 +410,7 @@ class Libp2p extends EventEmitter {
     })
 
     // Peer discovery
-    this._setupPeerDiscovery()
+    await this._setupPeerDiscovery()
 
     // Once we start, emit and dial any peers we may have already discovered
     for (const peerInfo of this.peerStore.peers.values()) {
@@ -458,10 +458,10 @@ class Libp2p extends EventEmitter {
   /**
    * Initializes and starts peer discovery services
    *
+   * @async
    * @private
-   * @returns {Promise<void>}
    */
-  _setupPeerDiscovery () {
+  async _setupPeerDiscovery () {
     const setupService = (DiscoveryService) => {
       let config = {
         enabled: true // on by default
@@ -500,7 +500,7 @@ class Libp2p extends EventEmitter {
       }
     }
 
-    return Promise.all(Array.from(this._discovery.values(), d => d.start()))
+    await Promise.all(Array.from(this._discovery.values(), d => d.start()))
   }
 }
 

test/peer-discovery/index.spec.js

@@ -9,12 +9,12 @@ const sinon = require('sinon')
 const defer = require('p-defer')
 const mergeOptions = require('merge-options')
 
-const MulticastDNS = require('libp2p-mdns')
 const WebRTCStar = require('libp2p-webrtc-star')
 
 const Libp2p = require('../../src')
 const baseOptions = require('../utils/base-options.browser')
 const { createPeerInfo } = require('../utils/creators/peer')
+const { EventEmitter } = require('events')
 
 describe('peer discovery', () => {
   describe('basic functions', () => {
@@ -51,17 +51,22 @@ describe('peer discovery', () => {
     })
 
     it('should ignore self on discovery', async () => {
+      const mockDiscovery = new EventEmitter()
+      mockDiscovery.tag = 'mock'
+      mockDiscovery.start = () => {}
+      mockDiscovery.stop = () => {}
+
       libp2p = new Libp2p(mergeOptions(baseOptions, {
         peerInfo,
         modules: {
-          peerDiscovery: [MulticastDNS]
+          peerDiscovery: [mockDiscovery]
         }
       }))
 
       await libp2p.start()
       const discoverySpy = sinon.spy()
       libp2p.on('peer:discovery', discoverySpy)
-      libp2p._discovery.get('mdns').emit('peer', libp2p.peerInfo)
+      libp2p._discovery.get('mock').emit('peer', libp2p.peerInfo)
 
       expect(discoverySpy.called).to.eql(false)
     })