libp2p 0.32.3 → 0.34.0

package/src/index.js

@@ -301,14 +301,9 @@ class Libp2p extends EventEmitter {
     // dht provided components (peerRouting, contentRouting, dht)
     if (this._modules.dht) {
       const DHT = this._modules.dht
-      // @ts-ignore Object is not constructable
-      this._dht = new DHT({
+      // @ts-ignore TODO: types need fixing - DHT is an `object` which has no `create` method
+      this._dht = DHT.create({
         libp2p: this,
-        dialer: this.dialer,
-        peerId: this.peerId,
-        peerStore: this.peerStore,
-        registrar: this.registrar,
-        datastore: this.datastore,
         ...this._config.dht
       })
     }
@@ -363,7 +358,7 @@ class Libp2p extends EventEmitter {
       await this._onStarting()
       await this._onDidStart()
       log('libp2p has started')
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       this.emit('error', err)
       log.error('An error occurred starting libp2p', err)
       await this.stop()
@@ -408,7 +403,7 @@ class Libp2p extends EventEmitter {
 
       ping.unmount(this)
       this.dialer.destroy()
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       if (err) {
         log.error(err)
         this.emit('error', err)
@@ -431,7 +426,7 @@ class Libp2p extends EventEmitter {
 
     try {
       await this.keychain.findKeyByName('self')
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       await this.keychain.importPeer('self', this.peerId)
     }
   }
@@ -624,7 +619,7 @@ class Libp2p extends EventEmitter {
 
     // DHT subsystem
     if (this._config.dht.enabled) {
-      this._dht && this._dht.start()
+      this._dht && await this._dht.start()
 
       // TODO: this should be modified once random-walk is used as
       // the other discovery modules
@@ -698,7 +693,7 @@ class Libp2p extends EventEmitter {
         log('connecting to discovered peer %s', peerId.toB58String())
         try {
           await this.dialer.connectToPeer(peerId)
-        } catch (err) {
+        } catch (/** @type {any} */ err) {
           log.error(`could not connect to discovered peer ${peerId.toB58String()} with ${err}`)
         }
       }

package/src/insecure/plaintext.js

@@ -55,7 +55,7 @@ async function encrypt (localId, conn, remoteId) {
   let peerId
   try {
     peerId = await PeerId.createFromPubKey(id.pubkey.Data)
-  } catch (err) {
+  } catch (/** @type {any} */ err) {
     log.error(err)
     throw new InvalidCryptoExchangeError('Remote did not provide its public key')
   }

package/src/keychain/cms.js

@@ -8,8 +8,8 @@ require('node-forge/lib/pbe')
 const forge = require('node-forge/lib/forge')
 const { certificateForKey, findAsync } = require('./util')
 const errcode = require('err-code')
-const uint8ArrayFromString = require('uint8arrays/from-string')
-const uint8ArrayToString = require('uint8arrays/to-string')
+const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string')
+const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
 
 const privates = new WeakMap()
 
@@ -90,7 +90,7 @@ class CMS {
       const obj = forge.asn1.fromDer(buf)
       // @ts-ignore not defined
       cms = forge.pkcs7.messageFromAsn1(obj)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       throw errcode(new Error('Invalid CMS: ' + err.message), 'ERR_INVALID_CMS')
     }
 
@@ -114,7 +114,7 @@ class CMS {
       try {
         const key = await this.keychain.findKeyById(recipient.keyId)
         if (key) return true
-      } catch (err) {
+      } catch (/** @type {any} */ err) {
         return false
       }
       return false

package/src/keychain/index.js

@@ -7,11 +7,11 @@ const log = Object.assign(debug('libp2p:keychain'), {
 const sanitize = require('sanitize-filename')
 const mergeOptions = require('merge-options')
 const crypto = require('libp2p-crypto')
-const { Key } = require('interface-datastore')
+const { Key } = require('interface-datastore/key')
 const CMS = require('./cms')
 const errcode = require('err-code')
-const uint8ArrayToString = require('uint8arrays/to-string')
-const uint8ArrayFromString = require('uint8arrays/from-string')
+const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
+const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string')
 
 // @ts-ignore node-forge sha512 types not exported
 require('node-forge/lib/sha512')
@@ -248,7 +248,7 @@ class Keychain {
       batch.put(DsInfoName(name), uint8ArrayFromString(JSON.stringify(keyInfo)))
 
       await batch.commit()
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(err)
     }
 
@@ -284,7 +284,7 @@ class Keychain {
     try {
       const keys = await this.listKeys()
       return keys.find((k) => k.id === id)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(err)
     }
   }
@@ -304,7 +304,7 @@ class Keychain {
     try {
       const res = await this.store.get(dsname)
       return JSON.parse(uint8ArrayToString(res))
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(errcode(new Error(`Key '${name}' does not exist. ${err.message}`), 'ERR_KEY_NOT_FOUND'))
     }
   }
@@ -365,7 +365,7 @@ class Keychain {
       batch.delete(oldInfoName)
       await batch.commit()
       return keyInfo
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(err)
     }
   }
@@ -393,7 +393,7 @@ class Keychain {
       const dek = privates.get(this).dek
       const privateKey = await crypto.keys.import(pem, dek)
       return privateKey.export(password)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(err)
     }
   }
@@ -421,7 +421,7 @@ class Keychain {
     let privateKey
     try {
       privateKey = await crypto.keys.import(pem, password)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(errcode(new Error('Cannot read the key, most likely the password is wrong'), 'ERR_CANNOT_READ_KEY'))
     }
 
@@ -431,7 +431,7 @@ class Keychain {
       /** @type {string} */
       const dek = privates.get(this).dek
       pem = await privateKey.export(dek)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(err)
     }
 
@@ -482,7 +482,7 @@ class Keychain {
       batch.put(DsInfoName(name), uint8ArrayFromString(JSON.stringify(keyInfo)))
       await batch.commit()
       return keyInfo
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(err)
     }
   }
@@ -502,7 +502,7 @@ class Keychain {
       const dsname = DsName(name)
       const res = await this.store.get(dsname)
       return uint8ArrayToString(res)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       return throwDelayed(errcode(new Error(`Key '${name}' does not exist. ${err.message}`), 'ERR_KEY_NOT_FOUND'))
     }
   }

package/src/nat-manager.js

@@ -10,7 +10,6 @@ const log = Object.assign(debug('libp2p:nat'), {
 })
 const { isBrowser } = require('wherearewe')
 const retry = require('p-retry')
-// @ts-ignore private-api does not export types
 const isPrivateIp = require('private-ip')
 const pkg = require('../package.json')
 const errcode = require('err-code')
@@ -115,6 +114,7 @@ class NatManager {
       const client = this._getClient()
       const publicIp = this._externalIp || await client.externalIp()
 
+      // @ts-expect-error types are wrong
       if (isPrivateIp(publicIp)) {
         throw new Error(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`)
       }
@@ -188,7 +188,7 @@ class NatManager {
     try {
       await this._client.destroy()
       this._client = null
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error(err)
     }
   }

package/src/peer-routing.js

@@ -21,6 +21,7 @@ const {
   clearDelayedInterval
 // @ts-ignore module with no types
 } = require('set-delayed-interval')
+const { DHTPeerRouting } = require('./dht/dht-peer-routing')
 
 /**
  * @typedef {import('peer-id')} PeerId
@@ -51,7 +52,7 @@ class PeerRouting {
 
     // If we have the dht, add it to the available peer routers
     if (libp2p._dht && libp2p._config.dht.enabled) {
-      this._routers.push(libp2p._dht)
+      this._routers.push(new DHTPeerRouting(libp2p._dht))
     }
 
     this._refreshManagerOptions = libp2p._options.peerRouting.refreshManager
@@ -79,7 +80,7 @@ class PeerRouting {
     try {
       // nb getClosestPeers adds the addresses to the address book
       await drain(this.getClosestPeers(this._peerId.id))
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error(err)
     }
   }

package/src/peer-store/address-book.js

@@ -83,7 +83,7 @@ class AddressBook extends Book {
     let peerRecord
     try {
       peerRecord = PeerRecord.createFromProtobuf(envelope.payload)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error('invalid peer record received')
       return false
     }

package/src/peer-store/metadata-book.js

@@ -5,7 +5,7 @@ const log = Object.assign(debug('libp2p:peer-store:proto-book'), {
   error: debug('libp2p:peer-store:proto-book:err')
 })
 const errcode = require('err-code')
-const uint8ArrayEquals = require('uint8arrays/equals')
+const { equals: uint8ArrayEquals } = require('uint8arrays/equals')
 
 const PeerId = require('peer-id')
 
@@ -80,10 +80,11 @@ class MetadataBook extends Book {
   /**
    * Set data into the datastructure
    *
-   * @override
    * @param {PeerId} peerId
    * @param {string} key
    * @param {Uint8Array} value
+   * @param {object} [opts]
+   * @param {boolean} [opts.emit]
    */
   _setValue (peerId, key, value, { emit = true } = {}) {
     const id = peerId.toB58String()

package/src/peer-store/persistent/index.js

@@ -4,7 +4,7 @@ const debug = require('debug')
 const log = Object.assign(debug('libp2p:persistent-peer-store'), {
   error: debug('libp2p:persistent-peer-store:err')
 })
-const { Key } = require('interface-datastore')
+const { Key } = require('interface-datastore/key')
 const { Multiaddr } = require('multiaddr')
 const PeerId = require('peer-id')
 const { base32 } = require('multiformats/bases/base32')
@@ -249,7 +249,7 @@ class PersistentPeerStore extends PeerStore {
       }).finish()
 
       batch.put(key, encodedData)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error(err)
     }
   }
@@ -275,7 +275,7 @@ class PersistentPeerStore extends PeerStore {
       const encodedData = peerId.marshalPubKey()
 
       batch.put(key, encodedData)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error(err)
     }
   }
@@ -302,7 +302,7 @@ class PersistentPeerStore extends PeerStore {
           batch.delete(key)
         }
       })
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error(err)
     }
   }
@@ -330,7 +330,7 @@ class PersistentPeerStore extends PeerStore {
       const encodedData = Protocols.encode({ protocols }).finish()
 
       batch.put(key, encodedData)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error(err)
     }
   }
@@ -399,7 +399,7 @@ class PersistentPeerStore extends PeerStore {
         default:
           log('invalid data persisted for: ', key.toString())
       }
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error(err)
     }
   }

package/src/ping/index.js

@@ -11,7 +11,7 @@ const { pipe } = require('it-pipe')
 // @ts-ignore it-buffer has no types exported
 const { toBuffer } = require('it-buffer')
 const { collect, take } = require('streaming-iterables')
-const equals = require('uint8arrays/equals')
+const { equals } = require('uint8arrays/equals')
 
 const { PROTOCOL_NAME, PING_LENGTH, PROTOCOL_VERSION } = require('./constants')
 

package/src/pnet/crypto.js

@@ -10,8 +10,8 @@ const Errors = require('./errors')
 // @ts-ignore xsalsa20 has no types exported
 const xsalsa20 = require('xsalsa20')
 const KEY_LENGTH = require('./key-generator').KEY_LENGTH
-const uint8ArrayFromString = require('uint8arrays/from-string')
-const uint8ArrayToString = require('uint8arrays/to-string')
+const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string')
+const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
 
 /**
  * Creates a stream iterable to encrypt messages in a private network
@@ -77,7 +77,7 @@ module.exports.decodeV1PSK = (pskBuffer) => {
       codecName: codec,
       psk: psk
     }
-  } catch (err) {
+  } catch (/** @type {any} */ err) {
     log.error(err)
     throw new Error(Errors.INVALID_PSK)
   }

package/src/pnet/key-generator.js

@@ -2,8 +2,8 @@
 
 const crypto = require('libp2p-crypto')
 const KEY_LENGTH = 32
-const uint8ArrayToString = require('uint8arrays/to-string')
-const uint8ArrayFromString = require('uint8arrays/from-string')
+const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
+const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string')
 
 /**
  * Generates a PSK that can be used in a libp2p-pnet private network
@@ -28,6 +28,6 @@ try {
     // @ts-ignore
     generate(process.stdout)
   }
-} catch (error) {
+} catch (/** @type {any} */ error) {
 
 }

package/src/record/README.md

@@ -17,7 +17,7 @@ You can read further about the envelope in [libp2p/specs#217](https://github.com
 ```js
 // interface-record implementation example with the "libp2p-example" namespace
 const Record = require('libp2p-interfaces/src/record')
-const fromString = require('uint8arrays/from-string')
+const { fromString } = require('uint8arrays/from-string')
 
 class ExampleRecord extends Record {
   constructor () {

package/src/record/envelope/index.js

@@ -1,13 +1,13 @@
 'use strict'
 
 const errCode = require('err-code')
-const uint8arraysConcat = require('uint8arrays/concat')
-const uint8arraysFromString = require('uint8arrays/from-string')
+const { concat: uint8arraysConcat } = require('uint8arrays/concat')
+const { fromString: uint8arraysFromString } = require('uint8arrays/from-string')
 // @ts-ignore libp2p-crypto does not support types
 const cryptoKeys = require('libp2p-crypto/src/keys')
 const PeerId = require('peer-id')
 const varint = require('varint')
-const uint8arraysEquals = require('uint8arrays/equals')
+const { equals: uint8arraysEquals } = require('uint8arrays/equals')
 
 const { codes } = require('../../errors')
 const { Envelope: Protobuf } = require('./envelope')

package/src/transport-manager.js

@@ -109,7 +109,7 @@ class TransportManager {
 
     try {
       return await transport.dial(ma, options)
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       if (!err.code) err.code = codes.ERR_TRANSPORT_DIAL_FAILED
       throw err
     }

package/src/upgrader.js

@@ -106,7 +106,7 @@ class Upgrader {
       } else {
         upgradedConn = encryptedConn
       }
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error('Failed to upgrade inbound connection', err)
       await maConn.close(err)
       throw err
@@ -181,7 +181,7 @@ class Upgrader {
       } else {
         upgradedConn = encryptedConn
       }
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       log.error('Failed to upgrade outbound connection', err)
       await maConn.close(err)
       throw err
@@ -245,7 +245,7 @@ class Upgrader {
             if (this.metrics) this.metrics.trackStream({ stream, remotePeer, protocol })
             connection.addStream(muxedStream, { protocol })
             this._onStream({ connection, stream: { ...muxedStream, ...stream }, protocol })
-          } catch (err) {
+          } catch (/** @type {any} */ err) {
             log.error(err)
           }
         },
@@ -263,7 +263,7 @@ class Upgrader {
           const { stream, protocol } = await mss.select(protocols)
           if (this.metrics) this.metrics.trackStream({ stream, remotePeer, protocol })
           return { stream: { ...muxedStream, ...stream }, protocol }
-        } catch (err) {
+        } catch (/** @type {any} */ err) {
           log.error('could not create new stream', err)
           throw errCode(err, codes.ERR_UNSUPPORTED_PROTOCOL)
         }
@@ -283,7 +283,7 @@ class Upgrader {
               if (connection.stat.status === 'open') {
                 await connection.close()
               }
-            } catch (err) {
+            } catch (/** @type {any} */ err) {
               log.error(err)
             } finally {
               this.onConnectionEnd(connection)
@@ -371,7 +371,7 @@ class Upgrader {
         ...await crypto.secureInbound(localPeer, stream),
         protocol
       }
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       throw errCode(err, codes.ERR_ENCRYPTION_FAILED)
     }
   }
@@ -406,7 +406,7 @@ class Upgrader {
         ...await crypto.secureOutbound(localPeer, stream, remotePeerId),
         protocol
       }
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       throw errCode(err, codes.ERR_ENCRYPTION_FAILED)
     }
   }
@@ -430,7 +430,7 @@ class Upgrader {
       log('%s selected as muxer protocol', protocol)
       const Muxer = muxers.get(protocol)
       return { stream, Muxer }
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       throw errCode(err, codes.ERR_MUXER_UNAVAILABLE)
     }
   }
@@ -453,7 +453,7 @@ class Upgrader {
       const { stream, protocol } = await listener.handle(protocols)
       const Muxer = muxers.get(protocol)
       return { stream, Muxer }
-    } catch (err) {
+    } catch (/** @type {any} */ err) {
       throw errCode(err, codes.ERR_MUXER_UNAVAILABLE)
     }
   }