libp2p 0.36.0 → 0.36.2-199395d

package/src/dialer/index.js

@@ -1,376 +0,0 @@
-'use strict'
-
-const debug = require('debug')
-const all = require('it-all')
-const filter = require('it-filter')
-const { pipe } = require('it-pipe')
-const log = Object.assign(debug('libp2p:dialer'), {
-  error: debug('libp2p:dialer:err')
-})
-const errCode = require('err-code')
-const { Multiaddr } = require('multiaddr')
-const { TimeoutController } = require('timeout-abort-controller')
-const { AbortError } = require('abortable-iterator')
-const { anySignal } = require('any-signal')
-// @ts-expect-error setMaxListeners is missing from the types
-const { setMaxListeners } = require('events')
-const DialRequest = require('./dial-request')
-const { publicAddressesFirst } = require('libp2p-utils/src/address-sort')
-const getPeer = require('../get-peer')
-const trackedMap = require('../metrics/tracked-map')
-const { codes } = require('../errors')
-const {
-  DIAL_TIMEOUT,
-  MAX_PARALLEL_DIALS,
-  MAX_PER_PEER_DIALS,
-  MAX_ADDRS_TO_DIAL
-} = require('../constants')
-
-const METRICS_COMPONENT = 'dialler'
-const METRICS_PENDING_DIALS = 'pending-dials'
-const METRICS_PENDING_DIAL_TARGETS = 'pending-dial-targets'
-
-/**
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('peer-id')} PeerId
- * @typedef {import('../peer-store/types').PeerStore} PeerStore
- * @typedef {import('../peer-store/types').Address} Address
- * @typedef {import('../transport-manager')} TransportManager
- * @typedef {import('../types').ConnectionGater} ConnectionGater
- */
-
-/**
- * @typedef {Object} DialerProperties
- * @property {PeerStore} peerStore
- * @property {TransportManager} transportManager
- * @property {ConnectionGater} connectionGater
- *
- * @typedef {(addr:Multiaddr) => Promise<string[]>} Resolver
- *
- * @typedef {Object} DialerOptions
- * @property {(addresses: Address[]) => Address[]} [options.addressSorter = publicAddressesFirst] - Sort the known addresses of a peer before trying to dial.
- * @property {number} [maxParallelDials = MAX_PARALLEL_DIALS] - Number of max concurrent dials.
- * @property {number} [maxAddrsToDial = MAX_ADDRS_TO_DIAL] - Number of max addresses to dial for a given peer.
- * @property {number} [maxDialsPerPeer = MAX_PER_PEER_DIALS] - Number of max concurrent dials per peer.
- * @property {number} [dialTimeout = DIAL_TIMEOUT] - How long a dial attempt is allowed to take.
- * @property {Record<string, Resolver>} [resolvers = {}] - multiaddr resolvers to use when dialing
- * @property {import('../metrics')} [metrics]
- *
- * @typedef DialTarget
- * @property {string} id
- * @property {Multiaddr[]} addrs
- *
- * @typedef PendingDial
- * @property {import('./dial-request')} dialRequest
- * @property {import('timeout-abort-controller').TimeoutController} controller
- * @property {Promise<Connection>} promise
- * @property {function():void} destroy
- */
-
-class Dialer {
-  /**
-   * @class
-   * @param {DialerProperties & DialerOptions} options
-   */
-  constructor ({
-    transportManager,
-    peerStore,
-    connectionGater,
-    addressSorter = publicAddressesFirst,
-    maxParallelDials = MAX_PARALLEL_DIALS,
-    maxAddrsToDial = MAX_ADDRS_TO_DIAL,
-    dialTimeout = DIAL_TIMEOUT,
-    maxDialsPerPeer = MAX_PER_PEER_DIALS,
-    resolvers = {},
-    metrics
-  }) {
-    this.connectionGater = connectionGater
-    this.transportManager = transportManager
-    this.peerStore = peerStore
-    this.addressSorter = addressSorter
-    this.maxParallelDials = maxParallelDials
-    this.maxAddrsToDial = maxAddrsToDial
-    this.timeout = dialTimeout
-    this.maxDialsPerPeer = maxDialsPerPeer
-    this.tokens = [...new Array(maxParallelDials)].map((_, index) => index)
-
-    /** @type {Map<string, PendingDial>} */
-    this._pendingDials = trackedMap({
-      component: METRICS_COMPONENT,
-      metric: METRICS_PENDING_DIALS,
-      metrics
-    })
-
-    /** @type {Map<string, { resolve: (value: any) => void, reject: (err: Error) => void}>} */
-    this._pendingDialTargets = trackedMap({
-      component: METRICS_COMPONENT,
-      metric: METRICS_PENDING_DIAL_TARGETS,
-      metrics
-    })
-
-    for (const [key, value] of Object.entries(resolvers)) {
-      Multiaddr.resolvers.set(key, value)
-    }
-  }
-
-  /**
-   * Clears any pending dials
-   */
-  destroy () {
-    for (const dial of this._pendingDials.values()) {
-      try {
-        dial.controller.abort()
-      } catch (/** @type {any} */ err) {
-        log.error(err)
-      }
-    }
-    this._pendingDials.clear()
-
-    for (const pendingTarget of this._pendingDialTargets.values()) {
-      pendingTarget.reject(new AbortError('Dialer was destroyed'))
-    }
-    this._pendingDialTargets.clear()
-  }
-
-  /**
-   * Connects to a given `peer` by dialing all of its known addresses.
-   * The dial to the first address that is successfully able to upgrade a connection
-   * will be used.
-   *
-   * @param {PeerId|Multiaddr|string} peer - The peer to dial
-   * @param {object} [options]
-   * @param {AbortSignal} [options.signal] - An AbortController signal
-   * @returns {Promise<Connection>}
-   */
-  async connectToPeer (peer, options = {}) {
-    const { id } = getPeer(peer)
-
-    if (await this.connectionGater.denyDialPeer(id)) {
-      throw errCode(new Error('The dial request is blocked by gater.allowDialPeer'), codes.ERR_PEER_DIAL_INTERCEPTED)
-    }
-
-    const dialTarget = await this._createCancellableDialTarget(peer)
-
-    if (!dialTarget.addrs.length) {
-      throw errCode(new Error('The dial request has no valid addresses'), codes.ERR_NO_VALID_ADDRESSES)
-    }
-    const pendingDial = this._pendingDials.get(dialTarget.id) || this._createPendingDial(dialTarget, options)
-
-    try {
-      const connection = await pendingDial.promise
-      log('dial succeeded to %s', dialTarget.id)
-      return connection
-    } catch (/** @type {any} */ err) {
-      // Error is a timeout
-      if (pendingDial.controller.signal.aborted) {
-        err.code = codes.ERR_TIMEOUT
-      }
-      log.error(err)
-      throw err
-    } finally {
-      pendingDial.destroy()
-    }
-  }
-
-  /**
-   * Connects to a given `peer` by dialing all of its known addresses.
-   * The dial to the first address that is successfully able to upgrade a connection
-   * will be used.
-   *
-   * @param {PeerId|Multiaddr|string} peer - The peer to dial
-   * @returns {Promise<DialTarget>}
-   */
-  async _createCancellableDialTarget (peer) {
-    // Make dial target promise cancellable
-    const id = `${(parseInt(String(Math.random() * 1e9), 10)).toString() + Date.now()}`
-    const cancellablePromise = new Promise((resolve, reject) => {
-      this._pendingDialTargets.set(id, { resolve, reject })
-    })
-
-    try {
-      const dialTarget = await Promise.race([
-        this._createDialTarget(peer),
-        cancellablePromise
-      ])
-
-      return dialTarget
-    } finally {
-      this._pendingDialTargets.delete(id)
-    }
-  }
-
-  /**
-   * Creates a DialTarget. The DialTarget is used to create and track
-   * the DialRequest to a given peer.
-   * If a multiaddr is received it should be the first address attempted.
-   * Multiaddrs not supported by the available transports will be filtered out.
-   *
-   * @private
-   * @param {PeerId|Multiaddr|string} peer - A PeerId or Multiaddr
-   * @returns {Promise<DialTarget>}
-   */
-  async _createDialTarget (peer) {
-    const { id, multiaddrs } = getPeer(peer)
-
-    if (multiaddrs) {
-      await this.peerStore.addressBook.add(id, multiaddrs)
-    }
-
-    let knownAddrs = await pipe(
-      await this.peerStore.addressBook.getMultiaddrsForPeer(id, this.addressSorter),
-      (source) => filter(source, async (multiaddr) => {
-        return !(await this.connectionGater.denyDialMultiaddr(id, multiaddr))
-      }),
-      (source) => all(source)
-    )
-
-    // If received a multiaddr to dial, it should be the first to use
-    // But, if we know other multiaddrs for the peer, we should try them too.
-    if (Multiaddr.isMultiaddr(peer)) {
-      knownAddrs = knownAddrs.filter((addr) => !peer.equals(addr))
-      knownAddrs.unshift(peer)
-    }
-
-    /** @type {Multiaddr[]} */
-    const addrs = []
-    for (const a of knownAddrs) {
-      const resolvedAddrs = await this._resolve(a)
-      resolvedAddrs.forEach(ra => addrs.push(ra))
-    }
-
-    // Multiaddrs not supported by the available transports will be filtered out.
-    const supportedAddrs = addrs.filter(a => this.transportManager.transportForMultiaddr(a))
-
-    if (supportedAddrs.length > this.maxAddrsToDial) {
-      await this.peerStore.delete(id)
-      throw errCode(new Error('dial with more addresses than allowed'), codes.ERR_TOO_MANY_ADDRESSES)
-    }
-
-    return {
-      id: id.toB58String(),
-      addrs: supportedAddrs
-    }
-  }
-
-  /**
-   * Creates a PendingDial that wraps the underlying DialRequest
-   *
-   * @private
-   * @param {DialTarget} dialTarget
-   * @param {object} [options]
-   * @param {AbortSignal} [options.signal] - An AbortController signal
-   * @returns {PendingDial}
-   */
-  _createPendingDial (dialTarget, options = {}) {
-    /**
-     * @param {Multiaddr} addr
-     * @param {{ signal: { aborted: any; }; }} options
-     */
-    const dialAction = (addr, options) => {
-      if (options.signal.aborted) throw errCode(new Error('already aborted'), codes.ERR_ALREADY_ABORTED)
-      return this.transportManager.dial(addr, options)
-    }
-
-    const dialRequest = new DialRequest({
-      addrs: dialTarget.addrs,
-      dialAction,
-      dialer: this
-    })
-
-    // Combine the timeout signal and options.signal, if provided
-    const timeoutController = new TimeoutController(this.timeout)
-
-    const signals = [timeoutController.signal]
-    options.signal && signals.push(options.signal)
-    const signal = anySignal(signals)
-
-    // this signal will potentially be used while dialing lots of
-    // peers so prevent MaxListenersExceededWarning appearing in the console
-    try {
-      // fails on node < 15.4
-      setMaxListeners && setMaxListeners(Infinity, signal)
-    } catch {}
-
-    const pendingDial = {
-      dialRequest,
-      controller: timeoutController,
-      promise: dialRequest.run({ ...options, signal }),
-      destroy: () => {
-        timeoutController.clear()
-        this._pendingDials.delete(dialTarget.id)
-      }
-    }
-    this._pendingDials.set(dialTarget.id, pendingDial)
-
-    return pendingDial
-  }
-
-  /**
-   * @param {number} num
-   */
-  getTokens (num) {
-    const total = Math.min(num, this.maxDialsPerPeer, this.tokens.length)
-    const tokens = this.tokens.splice(0, total)
-    log('%d tokens request, returning %d, %d remaining', num, total, this.tokens.length)
-    return tokens
-  }
-
-  /**
-   * @param {number} token
-   */
-  releaseToken (token) {
-    // Guard against duplicate releases
-    if (this.tokens.indexOf(token) > -1) return
-    log('token %d released', token)
-    this.tokens.push(token)
-  }
-
-  /**
-   * Resolve multiaddr recursively.
-   *
-   * @param {Multiaddr} ma
-   * @returns {Promise<Multiaddr[]>}
-   */
-  async _resolve (ma) {
-    // TODO: recursive logic should live in multiaddr once dns4/dns6 support is in place
-    // Now only supporting resolve for dnsaddr
-    const resolvableProto = ma.protoNames().includes('dnsaddr')
-
-    // Multiaddr is not resolvable? End recursion!
-    if (!resolvableProto) {
-      return [ma]
-    }
-
-    const resolvedMultiaddrs = await this._resolveRecord(ma)
-    const recursiveMultiaddrs = await Promise.all(resolvedMultiaddrs.map((nm) => {
-      return this._resolve(nm)
-    }))
-
-    const addrs = recursiveMultiaddrs.flat()
-    return addrs.reduce((array, newM) => {
-      if (!array.find(m => m.equals(newM))) {
-        array.push(newM)
-      }
-      return array
-    }, /** @type  {Multiaddr[]} */([]))
-  }
-
-  /**
-   * Resolve a given multiaddr. If this fails, an empty array will be returned
-   *
-   * @param {Multiaddr} ma
-   * @returns {Promise<Multiaddr[]>}
-   */
-  async _resolveRecord (ma) {
-    try {
-      ma = new Multiaddr(ma.toString()) // Use current multiaddr module
-      const multiaddrs = await ma.resolve()
-      return multiaddrs
-    } catch (_) {
-      log.error(`multiaddr ${ma} could not be resolved`)
-      return []
-    }
-  }
-}
-
-module.exports = Dialer

package/src/errors.js

@@ -1,66 +0,0 @@
-'use strict'
-
-exports.messages = {
-  NOT_STARTED_YET: 'The libp2p node is not started yet',
-  DHT_DISABLED: 'DHT is not available',
-  CONN_ENCRYPTION_REQUIRED: 'At least one connection encryption module is required',
-  NOT_FOUND: 'Not found'
-}
-
-exports.codes = {
-  DHT_DISABLED: 'ERR_DHT_DISABLED',
-  PUBSUB_NOT_STARTED: 'ERR_PUBSUB_NOT_STARTED',
-  DHT_NOT_STARTED: 'ERR_DHT_NOT_STARTED',
-  CONN_ENCRYPTION_REQUIRED: 'ERR_CONN_ENCRYPTION_REQUIRED',
-  ERR_PEER_DIAL_INTERCEPTED: 'ERR_PEER_DIAL_INTERCEPTED',
-  ERR_CONNECTION_INTERCEPTED: 'ERR_CONNECTION_INTERCEPTED',
-  ERR_INVALID_PROTOCOLS_FOR_STREAM: 'ERR_INVALID_PROTOCOLS_FOR_STREAM',
-  ERR_CONNECTION_ENDED: 'ERR_CONNECTION_ENDED',
-  ERR_CONNECTION_FAILED: 'ERR_CONNECTION_FAILED',
-  ERR_NODE_NOT_STARTED: 'ERR_NODE_NOT_STARTED',
-  ERR_ALREADY_ABORTED: 'ERR_ALREADY_ABORTED',
-  ERR_TOO_MANY_ADDRESSES: 'ERR_TOO_MANY_ADDRESSES',
-  ERR_NO_VALID_ADDRESSES: 'ERR_NO_VALID_ADDRESSES',
-  ERR_RELAYED_DIAL: 'ERR_RELAYED_DIAL',
-  ERR_DIALED_SELF: 'ERR_DIALED_SELF',
-  ERR_DISCOVERED_SELF: 'ERR_DISCOVERED_SELF',
-  ERR_DUPLICATE_TRANSPORT: 'ERR_DUPLICATE_TRANSPORT',
-  ERR_ENCRYPTION_FAILED: 'ERR_ENCRYPTION_FAILED',
-  ERR_HOP_REQUEST_FAILED: 'ERR_HOP_REQUEST_FAILED',
-  ERR_INVALID_KEY: 'ERR_INVALID_KEY',
-  ERR_INVALID_MESSAGE: 'ERR_INVALID_MESSAGE',
-  ERR_INVALID_PARAMETERS: 'ERR_INVALID_PARAMETERS',
-  ERR_INVALID_PEER: 'ERR_INVALID_PEER',
-  ERR_MUXER_UNAVAILABLE: 'ERR_MUXER_UNAVAILABLE',
-  ERR_NOT_FOUND: 'ERR_NOT_FOUND',
-  ERR_TIMEOUT: 'ERR_TIMEOUT',
-  ERR_TRANSPORT_UNAVAILABLE: 'ERR_TRANSPORT_UNAVAILABLE',
-  ERR_TRANSPORT_DIAL_FAILED: 'ERR_TRANSPORT_DIAL_FAILED',
-  ERR_UNSUPPORTED_PROTOCOL: 'ERR_UNSUPPORTED_PROTOCOL',
-  ERR_INVALID_MULTIADDR: 'ERR_INVALID_MULTIADDR',
-  ERR_SIGNATURE_NOT_VALID: 'ERR_SIGNATURE_NOT_VALID',
-  ERR_FIND_SELF: 'ERR_FIND_SELF',
-  ERR_NO_ROUTERS_AVAILABLE: 'ERR_NO_ROUTERS_AVAILABLE',
-  ERR_CONNECTION_NOT_MULTIPLEXED: 'ERR_CONNECTION_NOT_MULTIPLEXED',
-  ERR_NO_DIAL_TOKENS: 'ERR_NO_DIAL_TOKENS',
-  ERR_KEYCHAIN_REQUIRED: 'ERR_KEYCHAIN_REQUIRED',
-  ERR_INVALID_CMS: 'ERR_INVALID_CMS',
-  ERR_MISSING_KEYS: 'ERR_MISSING_KEYS',
-  ERR_NO_KEY: 'ERR_NO_KEY',
-  ERR_INVALID_KEY_NAME: 'ERR_INVALID_KEY_NAME',
-  ERR_INVALID_KEY_TYPE: 'ERR_INVALID_KEY_TYPE',
-  ERR_KEY_ALREADY_EXISTS: 'ERR_KEY_ALREADY_EXISTS',
-  ERR_INVALID_KEY_SIZE: 'ERR_INVALID_KEY_SIZE',
-  ERR_KEY_NOT_FOUND: 'ERR_KEY_NOT_FOUND',
-  ERR_OLD_KEY_NAME_INVALID: 'ERR_OLD_KEY_NAME_INVALID',
-  ERR_NEW_KEY_NAME_INVALID: 'ERR_NEW_KEY_NAME_INVALID',
-  ERR_PASSWORD_REQUIRED: 'ERR_PASSWORD_REQUIRED',
-  ERR_PEM_REQUIRED: 'ERR_PEM_REQUIRED',
-  ERR_CANNOT_READ_KEY: 'ERR_CANNOT_READ_KEY',
-  ERR_MISSING_PRIVATE_KEY: 'ERR_MISSING_PRIVATE_KEY',
-  ERR_INVALID_OLD_PASS_TYPE: 'ERR_INVALID_OLD_PASS_TYPE',
-  ERR_INVALID_NEW_PASS_TYPE: 'ERR_INVALID_NEW_PASS_TYPE',
-  ERR_INVALID_PASS_LENGTH: 'ERR_INVALID_PASS_LENGTH',
-  ERR_NOT_IMPLEMENTED: 'ERR_NOT_IMPLEMENTED',
-  ERR_WRONG_PING_ACK: 'ERR_WRONG_PING_ACK'
-}

package/src/fetch/constants.js

@@ -1,6 +0,0 @@
-'use strict'
-
-module.exports = {
-  // https://github.com/libp2p/specs/tree/master/fetch#wire-protocol
-  PROTOCOL: '/libp2p/fetch/0.0.1'
-}

package/src/get-peer.js

@@ -1,49 +0,0 @@
-'use strict'
-
-const PeerId = require('peer-id')
-const { Multiaddr } = require('multiaddr')
-const errCode = require('err-code')
-
-const { codes } = require('./errors')
-
-/**
- * Converts the given `peer` to a `Peer` object.
- * If a multiaddr is received, the addressBook is updated.
- *
- * @param {PeerId|Multiaddr|string} peer
- * @returns {{ id: PeerId, multiaddrs: Multiaddr[]|undefined }}
- */
-function getPeer (peer) {
-  if (typeof peer === 'string') {
-    peer = new Multiaddr(peer)
-  }
-
-  let addr
-  if (Multiaddr.isMultiaddr(peer)) {
-    addr = peer
-    const idStr = peer.getPeerId()
-
-    if (!idStr) {
-      throw errCode(
-        new Error(`${peer} does not have a valid peer type`),
-        codes.ERR_INVALID_MULTIADDR
-      )
-    }
-
-    try {
-      peer = PeerId.createFromB58String(idStr)
-    } catch (/** @type {any} */ err) {
-      throw errCode(
-        new Error(`${peer} is not a valid peer type`),
-        codes.ERR_INVALID_MULTIADDR
-      )
-    }
-  }
-
-  return {
-    id: peer,
-    multiaddrs: addr ? [addr] : undefined
-  }
-}
-
-module.exports = getPeer

package/src/identify/consts.js

@@ -1,15 +0,0 @@
-'use strict'
-
-// @ts-ignore file not listed within the file list of projects
-const libp2pVersion = require('../../package.json').version
-
-module.exports.PROTOCOL_VERSION = 'ipfs/0.1.0' // deprecated
-module.exports.AGENT_VERSION = `js-libp2p/${libp2pVersion}`
-module.exports.MULTICODEC_IDENTIFY = '/ipfs/id/1.0.0' // deprecated
-module.exports.MULTICODEC_IDENTIFY_PUSH = '/ipfs/id/push/1.0.0' // deprecated
-
-module.exports.IDENTIFY_PROTOCOL_VERSION = '0.1.0'
-module.exports.MULTICODEC_IDENTIFY_PROTOCOL_NAME = 'id'
-module.exports.MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME = 'id/push'
-module.exports.MULTICODEC_IDENTIFY_PROTOCOL_VERSION = '1.0.0'
-module.exports.MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION = '1.0.0'