libp2p 0.36.2 → 0.37.0

package/src/registrar.js

@@ -1,127 +0,0 @@
-'use strict'
-
-const debug = require('debug')
-const log = Object.assign(debug('libp2p:registrar'), {
-  error: debug('libp2p:registrar:err')
-})
-const errcode = require('err-code')
-
-const {
-  codes: { ERR_INVALID_PARAMETERS }
-} = require('./errors')
-const Topology = require('libp2p-interfaces/src/topology')
-
-/**
- * @typedef {import('peer-id')} PeerId
- * @typedef {import('./peer-store/types').PeerStore} PeerStore
- * @typedef {import('./connection-manager')} ConnectionManager
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('./').HandlerProps} HandlerProps
- */
-
-/**
- *
- */
-
-/**
- * Responsible for notifying registered protocols of events in the network.
- */
-class Registrar {
-  /**
-   * @param {Object} props
-   * @param {PeerStore} props.peerStore
-   * @param {ConnectionManager} props.connectionManager
-   * @class
-   */
-  constructor ({ peerStore, connectionManager }) {
-    // Used on topology to listen for protocol changes
-    this.peerStore = peerStore
-
-    this.connectionManager = connectionManager
-
-    /**
-     * Map of topologies
-     *
-     * @type {Map<string, Topology>}
-     */
-    this.topologies = new Map()
-
-    /** @type {(protocols: string[]|string, handler: (props: HandlerProps) => void) => void} */
-    // @ts-ignore handle is not optional
-    this._handle = undefined
-
-    this._onDisconnect = this._onDisconnect.bind(this)
-    this.connectionManager.on('peer:disconnect', this._onDisconnect)
-  }
-
-  /**
-   * @returns {(protocols: string[]|string, handler: (props: HandlerProps) => void) => void}
-   */
-  get handle () {
-    return this._handle
-  }
-
-  /**
-   * @param {(protocols: string[]|string, handler: (props: HandlerProps) => void) => void} handle
-   */
-  set handle (handle) {
-    this._handle = handle
-  }
-
-  /**
-   * Get a connection with a peer.
-   *
-   * @param {PeerId} peerId
-   * @returns {Connection | null}
-   */
-  getConnection (peerId) {
-    return this.connectionManager.get(peerId)
-  }
-
-  /**
-   * Register handlers for a set of multicodecs given
-   *
-   * @param {Topology} topology - protocol topology
-   * @returns {Promise<string>} registrar identifier
-   */
-  async register (topology) {
-    if (!Topology.isTopology(topology)) {
-      log.error('topology must be an instance of interfaces/topology')
-      throw errcode(new Error('topology must be an instance of interfaces/topology'), ERR_INVALID_PARAMETERS)
-    }
-
-    // Create topology
-    const id = (Math.random() * 1e9).toString(36) + Date.now()
-
-    this.topologies.set(id, topology)
-
-    // Set registrar
-    await topology.setRegistrar(this)
-
-    return id
-  }
-
-  /**
-   * Unregister topology.
-   *
-   * @param {string} id - registrar identifier
-   * @returns {boolean} unregistered successfully
-   */
-  unregister (id) {
-    return this.topologies.delete(id)
-  }
-
-  /**
-   * Remove a disconnected peer from the record
-   *
-   * @param {Connection} connection
-   * @returns {void}
-   */
-  _onDisconnect (connection) {
-    for (const [, topology] of this.topologies) {
-      topology.disconnect(connection.remotePeer)
-    }
-  }
-}
-
-module.exports = Registrar

package/src/transport-manager.js

@@ -1,269 +0,0 @@
-'use strict'
-
-const debug = require('debug')
-const log = Object.assign(debug('libp2p:transports'), {
-  error: debug('libp2p:transports:err')
-})
-
-const pSettle = require('p-settle')
-const { codes } = require('./errors')
-const errCode = require('err-code')
-
-const { updateSelfPeerRecord } = require('./record/utils')
-
-/**
- * @typedef {import('multiaddr').Multiaddr} Multiaddr
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('libp2p-interfaces/src/transport/types').TransportFactory<any, any>} TransportFactory
- * @typedef {import('libp2p-interfaces/src/transport/types').Transport<any, any>} Transport
- *
- * @typedef {Object} TransportManagerProperties
- * @property {import('./')} libp2p
- * @property {import('./upgrader')} upgrader
- *
- * @typedef {Object} TransportManagerOptions
- * @property {number} [faultTolerance = FAULT_TOLERANCE.FATAL_ALL] - Address listen error tolerance.
- */
-
-class TransportManager {
-  /**
-   * @class
-   * @param {TransportManagerProperties & TransportManagerOptions} options
-   */
-  constructor ({ libp2p, upgrader, faultTolerance = FAULT_TOLERANCE.FATAL_ALL }) {
-    this.libp2p = libp2p
-    this.upgrader = upgrader
-    /** @type {Map<string, Transport>} */
-    this._transports = new Map()
-    this._listeners = new Map()
-    this._listenerOptions = new Map()
-    this.faultTolerance = faultTolerance
-  }
-
-  /**
-   * Adds a `Transport` to the manager
-   *
-   * @param {string} key
-   * @param {TransportFactory} Transport
-   * @param {*} transportOptions - Additional options to pass to the transport
-   * @returns {void}
-   */
-  add (key, Transport, transportOptions = {}) {
-    log('adding %s', key)
-    if (!key) {
-      throw errCode(new Error(`Transport must have a valid key, was given '${key}'`), codes.ERR_INVALID_KEY)
-    }
-    if (this._transports.has(key)) {
-      throw errCode(new Error('There is already a transport with this key'), codes.ERR_DUPLICATE_TRANSPORT)
-    }
-
-    const transport = new Transport({
-      ...transportOptions,
-      libp2p: this.libp2p,
-      upgrader: this.upgrader
-    })
-
-    this._transports.set(key, transport)
-    this._listenerOptions.set(key, transportOptions.listenerOptions || {})
-    if (!this._listeners.has(key)) {
-      this._listeners.set(key, [])
-    }
-  }
-
-  /**
-   * Stops all listeners
-   *
-   * @async
-   */
-  async close () {
-    const tasks = []
-    for (const [key, listeners] of this._listeners) {
-      log('closing listeners for %s', key)
-      while (listeners.length) {
-        const listener = listeners.pop()
-        listener.removeAllListeners('listening')
-        listener.removeAllListeners('close')
-        tasks.push(listener.close())
-      }
-    }
-
-    await Promise.all(tasks)
-    log('all listeners closed')
-    for (const key of this._listeners.keys()) {
-      this._listeners.set(key, [])
-    }
-  }
-
-  /**
-   * Dials the given Multiaddr over it's supported transport
-   *
-   * @param {Multiaddr} ma
-   * @param {*} options
-   * @returns {Promise<Connection>}
-   */
-  async dial (ma, options) {
-    const transport = this.transportForMultiaddr(ma)
-    if (!transport) {
-      throw errCode(new Error(`No transport available for address ${String(ma)}`), codes.ERR_TRANSPORT_UNAVAILABLE)
-    }
-
-    try {
-      return await transport.dial(ma, options)
-    } catch (/** @type {any} */ err) {
-      if (!err.code) err.code = codes.ERR_TRANSPORT_DIAL_FAILED
-      throw err
-    }
-  }
-
-  /**
-   * Returns all Multiaddr's the listeners are using
-   *
-   * @returns {Multiaddr[]}
-   */
-  getAddrs () {
-    /** @type {Multiaddr[]} */
-    let addrs = []
-    for (const listeners of this._listeners.values()) {
-      for (const listener of listeners) {
-        addrs = [...addrs, ...listener.getAddrs()]
-      }
-    }
-    return addrs
-  }
-
-  /**
-   * Returns all the transports instances.
-   *
-   * @returns {IterableIterator<Transport>}
-   */
-  getTransports () {
-    return this._transports.values()
-  }
-
-  /**
-   * Finds a transport that matches the given Multiaddr
-   *
-   * @param {Multiaddr} ma
-   * @returns {Transport|null}
-   */
-  transportForMultiaddr (ma) {
-    for (const transport of this._transports.values()) {
-      const addrs = transport.filter([ma])
-      if (addrs.length) return transport
-    }
-    return null
-  }
-
-  /**
-   * Starts listeners for each listen Multiaddr.
-   *
-   * @async
-   * @param {Multiaddr[]} addrs - addresses to attempt to listen on
-   */
-  async listen (addrs) {
-    if (!addrs || addrs.length === 0) {
-      log('no addresses were provided for listening, this node is dial only')
-      return
-    }
-
-    const couldNotListen = []
-    for (const [key, transport] of this._transports.entries()) {
-      const supportedAddrs = transport.filter(addrs)
-      const tasks = []
-
-      // For each supported multiaddr, create a listener
-      for (const addr of supportedAddrs) {
-        log('creating listener for %s on %s', key, addr)
-        const listener = transport.createListener(this._listenerOptions.get(key))
-        this._listeners.get(key).push(listener)
-
-        // Track listen/close events
-        listener.on('listening', () => updateSelfPeerRecord(this.libp2p))
-        listener.on('close', () => updateSelfPeerRecord(this.libp2p))
-
-        // We need to attempt to listen on everything
-        tasks.push(listener.listen(addr))
-      }
-
-      // Keep track of transports we had no addresses for
-      if (tasks.length === 0) {
-        couldNotListen.push(key)
-        continue
-      }
-
-      const results = await pSettle(tasks)
-      // If we are listening on at least 1 address, succeed.
-      // TODO: we should look at adding a retry (`p-retry`) here to better support
-      // listening on remote addresses as they may be offline. We could then potentially
-      // just wait for any (`p-any`) listener to succeed on each transport before returning
-      const isListening = results.find(r => r.isFulfilled === true)
-      if (!isListening && this.faultTolerance !== FAULT_TOLERANCE.NO_FATAL) {
-        throw errCode(new Error(`Transport (${key}) could not listen on any available address`), codes.ERR_NO_VALID_ADDRESSES)
-      }
-    }
-
-    // If no transports were able to listen, throw an error. This likely
-    // means we were given addresses we do not have transports for
-    if (couldNotListen.length === this._transports.size) {
-      const message = `no valid addresses were provided for transports [${couldNotListen}]`
-      if (this.faultTolerance === FAULT_TOLERANCE.FATAL_ALL) {
-        throw errCode(new Error(message), codes.ERR_NO_VALID_ADDRESSES)
-      }
-      log(`libp2p in dial mode only: ${message}`)
-    }
-  }
-
-  /**
-   * Removes the given transport from the manager.
-   * If a transport has any running listeners, they will be closed.
-   *
-   * @async
-   * @param {string} key
-   */
-  async remove (key) {
-    log('removing %s', key)
-    if (this._listeners.has(key)) {
-      // Close any running listeners
-      for (const listener of this._listeners.get(key)) {
-        listener.removeAllListeners('listening')
-        listener.removeAllListeners('close')
-        await listener.close()
-      }
-    }
-
-    this._transports.delete(key)
-    this._listeners.delete(key)
-  }
-
-  /**
-   * Removes all transports from the manager.
-   * If any listeners are running, they will be closed.
-   *
-   * @async
-   */
-  async removeAll () {
-    const tasks = []
-    for (const key of this._transports.keys()) {
-      tasks.push(this.remove(key))
-    }
-
-    await Promise.all(tasks)
-  }
-}
-
-/**
- * Enum Transport Manager Fault Tolerance values.
- * FATAL_ALL should be used for failing in any listen circumstance.
- * NO_FATAL should be used for not failing when not listening.
- *
- * @readonly
- * @enum {number}
- */
-const FAULT_TOLERANCE = {
-  FATAL_ALL: 0,
-  NO_FATAL: 1
-}
-
-TransportManager.FaultTolerance = FAULT_TOLERANCE
-
-module.exports = TransportManager

package/src/types.ts

@@ -1,98 +0,0 @@
-import type PeerId from 'peer-id'
-import type { Multiaddr } from 'multiaddr'
-import type { MultiaddrConnection } from 'libp2p-interfaces/src/transport/types'
-
-export interface ConnectionGater {
-  /**
-   * denyDialMultiaddr tests whether we're permitted to Dial the
-   * specified peer.
-   *
-   * This is called by the dialer.connectToPeer implementation before
-   * dialling a peer.
-   *
-   * Return true to prevent dialing the passed peer.
-   */
-  denyDialPeer: (peerId: PeerId) => Promise<boolean>
-
-  /**
-   * denyDialMultiaddr tests whether we're permitted to dial the specified
-   * multiaddr for the given peer.
-   *
-   * This is called by the dialer.connectToPeer implementation after it has
-   * resolved the peer's addrs, and prior to dialling each.
-   *
-   * Return true to prevent dialing the passed peer on the passed multiaddr.
-   */
-  denyDialMultiaddr: (peerId: PeerId, multiaddr: Multiaddr) => Promise<boolean>
-
-  /**
-   * denyInboundConnection tests whether an incipient inbound connection is allowed.
-   *
-   * This is called by the upgrader, or by the transport directly (e.g. QUIC,
-   * Bluetooth), straight after it has accepted a connection from its socket.
-   *
-   * Return true to deny the incoming passed connection.
-   */
-  denyInboundConnection: (maConn: MultiaddrConnection) => Promise<boolean>
-
-  /**
-   * denyOutboundConnection tests whether an incipient outbound connection is allowed.
-   *
-   * This is called by the upgrader, or by the transport directly (e.g. QUIC,
-   * Bluetooth), straight after it has created a connection with its socket.
-   *
-   * Return true to deny the incoming passed connection.
-   */
-  denyOutboundConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
-
-  /**
-   * denyInboundEncryptedConnection tests whether a given connection, now encrypted,
-   * is allowed.
-   *
-   * This is called by the upgrader, after it has performed the security
-   * handshake, and before it negotiates the muxer, or by the directly by the
-   * transport, at the exact same checkpoint.
-   *
-   * Return true to deny the passed secured connection.
-   */
-  denyInboundEncryptedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
-
-  /**
-   * denyOutboundEncryptedConnection tests whether a given connection, now encrypted,
-   * is allowed.
-   *
-   * This is called by the upgrader, after it has performed the security
-   * handshake, and before it negotiates the muxer, or by the directly by the
-   * transport, at the exact same checkpoint.
-   *
-   * Return true to deny the passed secured connection.
-   */
-  denyOutboundEncryptedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
-
-  /**
-   * denyInboundUpgradedConnection tests whether a fully capable connection is allowed.
-   *
-   * This is called after encryption has been negotiated and the connection has been
-   * multiplexed, if a multiplexer is configured.
-   *
-   * Return true to deny the passed upgraded connection.
-   */
-  denyInboundUpgradedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
-
-  /**
-   * denyOutboundUpgradedConnection tests whether a fully capable connection is allowed.
-   *
-   * This is called after encryption has been negotiated and the connection has been
-   * multiplexed, if a multiplexer is configured.
-   *
-   * Return true to deny the passed upgraded connection.
-   */
-  denyOutboundUpgradedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
-
-  /**
-   * Used by the address book to filter passed addresses.
-   *
-   * Return true to allow storing the passed multiaddr for the passed peer.
-   */
-  filterMultiaddrForPeer: (peer: PeerId, multiaddr: Multiaddr) => Promise<boolean>
-}