chore: release version v0.31.3

CHANGELOG.md

@@ -1,3 +1,29 @@
+## [0.31.3](https://github.com/libp2p/js-libp2p/compare/v0.31.2...v0.31.3) (2021-05-04)
+
+
+
+## [0.31.2](https://github.com/libp2p/js-libp2p/compare/v0.31.1...v0.31.2) (2021-04-30)
+
+
+### Bug Fixes
+
+* moving averages record types ([#935](https://github.com/libp2p/js-libp2p/issues/935)) ([b5a9eb2](https://github.com/libp2p/js-libp2p/commit/b5a9eb208763efa027d0b4caae87c515b6f5869b))
+
+
+
+## [0.31.1](https://github.com/libp2p/js-libp2p/compare/v0.31.0...v0.31.1) (2021-04-30)
+
+
+### Bug Fixes
+
+* event emitter and interfaces types for discovery and routing ([#934](https://github.com/libp2p/js-libp2p/issues/934)) ([302bb90](https://github.com/libp2p/js-libp2p/commit/302bb9005891aa06b70a5f354bfac6b2d5a3c3b8))
+
+
+
+# [0.31.0](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.7...v0.31.0) (2021-04-28)
+
+
+
 # [0.31.0-rc.7](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.6...v0.31.0-rc.7) (2021-04-27)
 
 

doc/migrations/v0.30-v0.31.md

@@ -0,0 +1,123 @@
+<!--Specify versions for migration below-->
+# Migrating to libp2p@31
+
+A migration guide for refactoring your application code from libp2p v0.30.x to v0.31.0.
+
+## Table of Contents
+
+- [Types](#types)
+- [API](#api)
+- [Module Updates](#module-updates)
+
+## Types
+
+Most of the type definitions in the libp2p configuration were `any` or were not included before this release. This might cause breaking changes on upstream projects relying on the previous provided types, as well as to libp2p modules implemented by the libp2p community.
+
+## API
+
+### Core API
+
+`libp2p.dialProtocol` does not accept empty or null protocols returning a connection anymore and `dial` must be used instead.
+
+```js
+const connection = await libp2p.dialProtocol(peerId)
+```
+
+**After**
+
+```js
+const connection = await libp2p.dial(peerId)
+```
+
+### Connection Manager Options
+
+We updated the connection manager options naming in `libp2p@0.29` but kept it backward compatible until now.
+
+**Before**
+
+```js
+const node = await Libp2p.create({
+  connectionManager: {
+    minPeers: 0
+  }
+})
+```
+
+**After**
+
+```js
+const node = await Libp2p.create({
+  connectionManager: {
+    minConnections: 0
+  }
+})
+```
+
+You can see full details on how to configure the connection manager [here](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md#configuring-connection-manager).
+
+### Dialer and Keychain components
+
+Internal property names to create a libp2p `Dialer` and `Keychain` were updated to reflect the properties naming in the libp2p configuration. These are internal modules of libp2p core and should not impact most of the users, but as it is possible to use them separately here follow the changes:
+
+***Before**
+
+```js
+const dialer = new Dialer({
+  transportManager,
+  peerStore,
+  concurrency,
+  perPeerLimit,
+  timeout,
+  resolvers,
+  addressSorter
+})
+
+const keychain = new Keychain(datastore, {
+  passPhrase
+})
+```
+
+**After**
+
+```js
+this.dialer = new Dialer({
+  transportManager,
+  peerStore,
+  maxParallelDials,
+  maxDialsPerPeer,
+  dialTimeout,
+  resolvers,
+  addressSorter
+})
+
+const keychain = new Keychain(datastore, {
+  pass
+})
+```
+
+## Module Updates
+
+With this release you should update the following libp2p modules if you are relying on them:
+
+<!--Specify module versions in JSON for migration below.
+It's recommended to check package.json changes for this: 
+`git diff <release> <prev> -- package.json`
+-->
+
+```json
+"libp2p-bootstrap": "^0.12.3",
+"libp2p-crypto": "^0.19.4",
+"libp2p-interfaces": "^0.10.0",
+"libp2p-delegated-content-routing": "^0.10.0",
+"libp2p-delegated-peer-routing": "^0.9.0",
+"libp2p-floodsub": "^0.25.1",
+"libp2p-gossipsub": "^0.9.0",
+"libp2p-kad-dht": "^0.22.0",
+"libp2p-mdns": "^0.16.0",
+"libp2p-noise": "^3.0.0",
+"libp2p-tcp": "^0.15.4",
+"libp2p-webrtc-star": "^0.22.2",
+"libp2p-websockets": "^0.15.6"
+```
+
+One of the main changes in this new release is the update to `multiaddr@9.0.0`. This should also be updated in upstream projects to avoid several multiaddr versions in the bundle and to avoid potential problems when libp2p interacts with provided outdated multiaddr instances.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.31.0-rc.7",
+  "version": "0.31.3",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -91,7 +91,7 @@
     "events": "^3.3.0",
     "hashlru": "^2.3.0",
     "interface-datastore": "^4.0.0",
-    "ipfs-utils": "^6.0.0",
+    "ipfs-utils": "^7.0.0",
     "it-all": "^1.0.4",
     "it-buffer": "^0.1.2",
     "it-drain": "^1.0.3",
@@ -103,12 +103,12 @@
     "it-merge": "1.0.0",
     "it-pipe": "^1.1.0",
     "it-take": "1.0.0",
-    "libp2p-crypto": "^0.19.0",
-    "libp2p-interfaces": "^0.10.3",
+    "libp2p-crypto": "^0.19.4",
+    "libp2p-interfaces": "^0.10.4",
     "libp2p-utils": "^0.3.1",
     "mafmt": "^9.0.0",
     "merge-options": "^3.0.4",
-    "moving-average": "^1.0.0",
+    "@vascosantos/moving-average": "^1.1.0",
     "multiaddr": "^9.0.1",
     "multicodec": "^3.0.1",
     "multihashing-async": "^2.1.2",
@@ -150,14 +150,14 @@
     "libp2p-delegated-content-routing": "^0.10.0",
     "libp2p-delegated-peer-routing": "^0.9.0",
     "libp2p-floodsub": "^0.25.0",
-    "libp2p-gossipsub": "^0.8.0",
-    "libp2p-kad-dht": "^0.21.0",
+    "libp2p-gossipsub": "^0.9.0",
+    "libp2p-kad-dht": "^0.22.0",
     "libp2p-mdns": "^0.16.0",
     "libp2p-mplex": "^0.10.1",
     "libp2p-noise": "^3.0.0",
-    "libp2p-tcp": "^0.15.1",
-    "libp2p-webrtc-star": "^0.22.0",
-    "libp2p-websockets": "^0.15.0",
+    "libp2p-tcp": "^0.15.4",
+    "libp2p-webrtc-star": "^0.22.2",
+    "libp2p-websockets": "^0.15.6",
     "multihashes": "^4.0.2",
     "nock": "^13.0.3",
     "p-defer": "^3.0.0",

src/address-manager/index.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const EventEmitter = require('events')
+const { EventEmitter } = require('events')
 const { Multiaddr } = require('multiaddr')
 const PeerId = require('peer-id')
 

src/connection-manager/index.js

@@ -11,7 +11,7 @@ const LatencyMonitor = require('./latency-monitor')
 // @ts-ignore retimer does not have types
 const retimer = require('retimer')
 
-const EventEmitter = require('events')
+const { EventEmitter } = require('events')
 
 const PeerId = require('peer-id')
 

src/connection-manager/latency-monitor.js

@@ -5,7 +5,7 @@
  * This code is based on `latency-monitor` (https://github.com/mlucool/latency-monitor) by `mlucool` (https://github.com/mlucool), available under Apache License 2.0 (https://github.com/mlucool/latency-monitor/blob/master/LICENSE)
  */
 
-const EventEmitter = require('events')
+const { EventEmitter } = require('events')
 const VisibilityChangeEmitter = require('./visibility-change-emitter')
 const debug = require('debug')('latency-monitor:LatencyMonitor')
 

src/connection-manager/visibility-change-emitter.js

@@ -6,7 +6,7 @@
  */
 'use strict'
 
-const EventEmitter = require('events')
+const { EventEmitter } = require('events')
 
 const debug = require('debug')('latency-monitor:VisibilityChangeEmitter')
 

src/content-routing/index.js

@@ -16,7 +16,7 @@ const { pipe } = require('it-pipe')
  * @typedef {import('peer-id')} PeerId
  * @typedef {import('multiaddr').Multiaddr} Multiaddr
  * @typedef {import('cids')} CID
- * @typedef {import('libp2p-interfaces/src/content-routing/types')} ContentRoutingModule
+ * @typedef {import('libp2p-interfaces/src/content-routing/types').ContentRouting} ContentRoutingModule
  */
 
 /**

src/index.js

@@ -4,7 +4,7 @@ const debug = require('debug')
 const log = Object.assign(debug('libp2p'), {
   error: debug('libp2p:err')
 })
-const EventEmitter = require('events')
+const { EventEmitter } = require('events')
 
 const errCode = require('err-code')
 const PeerId = require('peer-id')
@@ -40,9 +40,9 @@ const { updateSelfPeerRecord } = require('./record/utils')
  * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxedStream} MuxedStream
  * @typedef {import('libp2p-interfaces/src/transport/types').TransportFactory<any, any>} TransportFactory
  * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxerFactory} MuxerFactory
- * @typedef {import('libp2p-interfaces/src/content-routing/types')} ContentRoutingModule
- * @typedef {import('libp2p-interfaces/src/peer-discovery/types')} PeerDiscoveryModule
- * @typedef {import('libp2p-interfaces/src/peer-routing/types')} PeerRoutingModule
+ * @typedef {import('libp2p-interfaces/src/content-routing/types').ContentRouting} ContentRoutingModule
+ * @typedef {import('libp2p-interfaces/src/peer-discovery/types').PeerDiscoveryFactory} PeerDiscoveryFactory
+ * @typedef {import('libp2p-interfaces/src/peer-routing/types').PeerRouting} PeerRoutingModule
  * @typedef {import('libp2p-interfaces/src/crypto/types').Crypto} Crypto
  * @typedef {import('libp2p-interfaces/src/pubsub')} Pubsub
  * @typedef {import('libp2p-interfaces/src/pubsub').PubsubOptions} PubsubOptions
@@ -100,7 +100,7 @@ const { updateSelfPeerRecord } = require('./record/utils')
  * @property {TransportFactory[]} transport
  * @property {MuxerFactory[]} streamMuxer
  * @property {Crypto[]} connEncryption
- * @property {PeerDiscoveryModule[]} [peerDiscovery]
+ * @property {PeerDiscoveryFactory[]} [peerDiscovery]
  * @property {PeerRoutingModule[]} [peerRouting]
  * @property {ContentRoutingModule[]} [contentRouting]
  * @property {Object} [dht]
@@ -714,7 +714,7 @@ class Libp2p extends EventEmitter {
    */
   async _setupPeerDiscovery () {
     /**
-     * @param {PeerDiscoveryModule} DiscoveryService
+     * @param {PeerDiscoveryFactory} DiscoveryService
      */
     const setupService = (DiscoveryService) => {
       let config = {

src/metrics/stats.js

@@ -1,11 +1,15 @@
 // @ts-nocheck
 'use strict'
 
-const EventEmitter = require('events')
+const { EventEmitter } = require('events')
 const { BigNumber: Big } = require('bignumber.js')
-const MovingAverage = require('moving-average')
+const MovingAverage = require('@vascosantos/moving-average')
 const retimer = require('retimer')
 
+/**
+ * @typedef {import('@vascosantos/moving-average').IMovingAverage} IMovingAverage
+ */
+
 class Stats extends EventEmitter {
   /**
    * A queue based manager for stat processing
@@ -29,7 +33,7 @@ class Stats extends EventEmitter {
     this._frequencyLastTime = Date.now()
     this._frequencyAccumulators = {}
 
-    /** @type {{ dataReceived: MovingAverage[], dataSent: MovingAverage[] }} */
+    /** @type {{ dataReceived: IMovingAverage[], dataSent: IMovingAverage[] }} */
     this._movingAverages = {}
 
     this._update = this._update.bind(this)

src/peer-routing.js

@@ -25,7 +25,7 @@ const {
 /**
  * @typedef {import('peer-id')} PeerId
  * @typedef {import('multiaddr').Multiaddr} Multiaddr
- * @typedef {import('libp2p-interfaces/src/peer-routing/types')} PeerRoutingModule
+ * @typedef {import('libp2p-interfaces/src/peer-routing/types').PeerRouting} PeerRoutingModule
  */
 
 /**

src/peer-store/index.js

@@ -2,7 +2,7 @@
 
 const errcode = require('err-code')
 
-const EventEmitter = require('events')
+const { EventEmitter } = require('events')
 const PeerId = require('peer-id')
 
 const AddressBook = require('./address-book')

src/upgrader.js

@@ -137,7 +137,12 @@ class Upgrader {
    * @returns {Promise<Connection>}
    */
   async upgradeOutbound (maConn) {
-    const remotePeerId = PeerId.createFromB58String(maConn.remoteAddr.getPeerId())
+    const idStr = maConn.remoteAddr.getPeerId()
+    if (!idStr) {
+      throw errCode(new Error('outbound connection must have a peer id'), codes.ERR_INVALID_MULTIADDR)
+    }
+
+    const remotePeerId = PeerId.createFromB58String(idStr)
 
     let encryptedConn
     let remotePeer