libp2p 0.36.2 → 0.37.0

package/src/identify/index.js

@@ -1,384 +0,0 @@
-'use strict'
-
-const debug = require('debug')
-const log = Object.assign(debug('libp2p:identify'), {
-  error: debug('libp2p:identify:err')
-})
-const errCode = require('err-code')
-const lp = require('it-length-prefixed')
-const { pipe } = require('it-pipe')
-const { collect, take, consume } = require('streaming-iterables')
-const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string')
-
-const PeerId = require('peer-id')
-const { Multiaddr } = require('multiaddr')
-// @ts-ignore it-buffer does not have types
-const { toBuffer } = require('it-buffer')
-
-const Message = require('./message')
-
-const Envelope = require('../record/envelope')
-const PeerRecord = require('../record/peer-record')
-
-const {
-  MULTICODEC_IDENTIFY,
-  MULTICODEC_IDENTIFY_PUSH,
-  IDENTIFY_PROTOCOL_VERSION,
-  MULTICODEC_IDENTIFY_PROTOCOL_NAME,
-  MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME,
-  MULTICODEC_IDENTIFY_PROTOCOL_VERSION,
-  MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION
-} = require('./consts')
-
-const { codes } = require('../errors')
-
-/**
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxedStream} MuxedStream
- */
-
-/**
- * @typedef {Object} HostProperties
- * @property {string} agentVersion
- */
-
-class IdentifyService {
-  /**
-   * @param {import('../')} libp2p
-   */
-  static getProtocolStr (libp2p) {
-    return {
-      identifyProtocolStr: `/${libp2p._config.protocolPrefix}/${MULTICODEC_IDENTIFY_PROTOCOL_NAME}/${MULTICODEC_IDENTIFY_PROTOCOL_VERSION}`,
-      identifyPushProtocolStr: `/${libp2p._config.protocolPrefix}/${MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME}/${MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION}`
-    }
-  }
-
-  /**
-   * @class
-   * @param {Object} options
-   * @param {import('../')} options.libp2p
-   */
-  constructor ({ libp2p }) {
-    this._libp2p = libp2p
-    this.peerStore = libp2p.peerStore
-    this.addressManager = libp2p.addressManager
-    this.connectionManager = libp2p.connectionManager
-    this.peerId = libp2p.peerId
-
-    this.handleMessage = this.handleMessage.bind(this)
-
-    const protocolStr = IdentifyService.getProtocolStr(libp2p)
-    this.identifyProtocolStr = protocolStr.identifyProtocolStr
-    this.identifyPushProtocolStr = protocolStr.identifyPushProtocolStr
-
-    // Store self host metadata
-    this._host = {
-      protocolVersion: `${libp2p._config.protocolPrefix}/${IDENTIFY_PROTOCOL_VERSION}`,
-      ...libp2p._options.host
-    }
-
-    // When a new connection happens, trigger identify
-    this.connectionManager.on('peer:connect', (connection) => {
-      this.identify(connection).catch(log.error)
-    })
-
-    // When self multiaddrs change, trigger identify-push
-    this.peerStore.on('change:multiaddrs', ({ peerId }) => {
-      if (peerId.toString() === this.peerId.toString()) {
-        this.pushToPeerStore().catch(err => log.error(err))
-      }
-    })
-
-    // When self protocols change, trigger identify-push
-    this.peerStore.on('change:protocols', ({ peerId }) => {
-      if (peerId.toString() === this.peerId.toString()) {
-        this.pushToPeerStore().catch(err => log.error(err))
-      }
-    })
-  }
-
-  async start () {
-    await this.peerStore.metadataBook.setValue(this.peerId, 'AgentVersion', uint8ArrayFromString(this._host.agentVersion))
-    await this.peerStore.metadataBook.setValue(this.peerId, 'ProtocolVersion', uint8ArrayFromString(this._host.protocolVersion))
-  }
-
-  async stop () {
-
-  }
-
-  /**
-   * Send an Identify Push update to the list of connections
-   *
-   * @param {Connection[]} connections
-   * @returns {Promise<void[]>}
-   */
-  async push (connections) {
-    const signedPeerRecord = await this.peerStore.addressBook.getRawEnvelope(this.peerId)
-    const listenAddrs = this._libp2p.multiaddrs.map((ma) => ma.bytes)
-    const protocols = await this.peerStore.protoBook.get(this.peerId)
-
-    const pushes = connections.map(async connection => {
-      try {
-        const { stream } = await connection.newStream(this.identifyPushProtocolStr)
-
-        await pipe(
-          [Message.Identify.encode({
-            listenAddrs,
-            signedPeerRecord,
-            protocols
-          }).finish()],
-          lp.encode(),
-          stream,
-          consume
-        )
-      } catch (/** @type {any} */ err) {
-        // Just log errors
-        log.error('could not push identify update to peer', err)
-      }
-    })
-
-    return Promise.all(pushes)
-  }
-
-  /**
-   * Calls `push` for all peers in the `peerStore` that are connected
-   */
-  async pushToPeerStore () {
-    // Do not try to push if libp2p node is not running
-    if (!this._libp2p.isStarted()) {
-      return
-    }
-
-    const connections = []
-    let connection
-    for await (const peer of this.peerStore.getPeers()) {
-      if (peer.protocols.includes(this.identifyPushProtocolStr) && (connection = this.connectionManager.get(peer.id))) {
-        connections.push(connection)
-      }
-    }
-
-    await this.push(connections)
-  }
-
-  /**
-   * Requests the `Identify` message from peer associated with the given `connection`.
-   * If the identified peer does not match the `PeerId` associated with the connection,
-   * an error will be thrown.
-   *
-   * @async
-   * @param {Connection} connection
-   * @returns {Promise<void>}
-   */
-  async identify (connection) {
-    const { stream } = await connection.newStream(this.identifyProtocolStr)
-    const [data] = await pipe(
-      [],
-      stream,
-      lp.decode(),
-      take(1),
-      toBuffer,
-      collect
-    )
-
-    if (!data) {
-      throw errCode(new Error('No data could be retrieved'), codes.ERR_CONNECTION_ENDED)
-    }
-
-    let message
-    try {
-      message = Message.Identify.decode(data)
-    } catch (/** @type {any} */ err) {
-      throw errCode(err, codes.ERR_INVALID_MESSAGE)
-    }
-
-    const {
-      publicKey,
-      listenAddrs,
-      protocols,
-      observedAddr,
-      signedPeerRecord
-    } = message
-
-    const id = await PeerId.createFromPubKey(publicKey)
-
-    if (connection.remotePeer.toB58String() !== id.toB58String()) {
-      throw errCode(new Error('identified peer does not match the expected peer'), codes.ERR_INVALID_PEER)
-    }
-
-    // Get the observedAddr if there is one
-    const cleanObservedAddr = IdentifyService.getCleanMultiaddr(observedAddr)
-
-    try {
-      const envelope = await Envelope.openAndCertify(signedPeerRecord, PeerRecord.DOMAIN)
-      if (await this.peerStore.addressBook.consumePeerRecord(envelope)) {
-        await this.peerStore.protoBook.set(id, protocols)
-        await this.peerStore.metadataBook.setValue(id, 'AgentVersion', uint8ArrayFromString(message.agentVersion))
-        await this.peerStore.metadataBook.setValue(id, 'ProtocolVersion', uint8ArrayFromString(message.protocolVersion))
-        return
-      }
-    } catch (/** @type {any} */ err) {
-      log('received invalid envelope, discard it and fallback to listenAddrs is available', err)
-    }
-
-    // LEGACY: Update peers data in PeerStore
-    try {
-      await this.peerStore.addressBook.set(id, listenAddrs.map((addr) => new Multiaddr(addr)))
-    } catch (/** @type {any} */ err) {
-      log.error('received invalid addrs', err)
-    }
-
-    await this.peerStore.protoBook.set(id, protocols)
-    await this.peerStore.metadataBook.setValue(id, 'AgentVersion', uint8ArrayFromString(message.agentVersion))
-    await this.peerStore.metadataBook.setValue(id, 'ProtocolVersion', uint8ArrayFromString(message.protocolVersion))
-
-    // TODO: Add and score our observed addr
-    log('received observed address of %s', cleanObservedAddr)
-    // this.addressManager.addObservedAddr(observedAddr)
-  }
-
-  /**
-   * A handler to register with Libp2p to process identify messages.
-   *
-   * @param {Object} options
-   * @param {Connection} options.connection
-   * @param {MuxedStream} options.stream
-   * @param {string} options.protocol
-   * @returns {Promise<void>|undefined}
-   */
-  handleMessage ({ connection, stream, protocol }) {
-    switch (protocol) {
-      case this.identifyProtocolStr:
-        return this._handleIdentify({ connection, stream })
-      case this.identifyPushProtocolStr:
-        return this._handlePush({ connection, stream })
-      default:
-        log.error('cannot handle unknown protocol %s', protocol)
-    }
-  }
-
-  /**
-   * Sends the `Identify` response with the Signed Peer Record
-   * to the requesting peer over the given `connection`
-   *
-   * @private
-   * @param {Object} options
-   * @param {MuxedStream} options.stream
-   * @param {Connection} options.connection
-   * @returns {Promise<void>}
-   */
-  async _handleIdentify ({ connection, stream }) {
-    try {
-      let publicKey = new Uint8Array(0)
-      if (this.peerId.pubKey) {
-        publicKey = this.peerId.pubKey.bytes
-      }
-
-      const signedPeerRecord = await this.peerStore.addressBook.getRawEnvelope(this.peerId)
-      const protocols = await this.peerStore.protoBook.get(this.peerId)
-
-      const message = Message.Identify.encode({
-        protocolVersion: this._host.protocolVersion,
-        agentVersion: this._host.agentVersion,
-        publicKey,
-        listenAddrs: this._libp2p.multiaddrs.map((ma) => ma.bytes),
-        signedPeerRecord,
-        observedAddr: connection.remoteAddr.bytes,
-        protocols
-      }).finish()
-
-      await pipe(
-        [message],
-        lp.encode(),
-        stream,
-        consume
-      )
-    } catch (/** @type {any} */ err) {
-      log.error('could not respond to identify request', err)
-    }
-  }
-
-  /**
-   * Reads the Identify Push message from the given `connection`
-   *
-   * @private
-   * @param {object} options
-   * @param {MuxedStream} options.stream
-   * @param {Connection} options.connection
-   * @returns {Promise<void>}
-   */
-  async _handlePush ({ connection, stream }) {
-    let message
-    try {
-      const [data] = await pipe(
-        [],
-        stream,
-        lp.decode(),
-        take(1),
-        toBuffer,
-        collect
-      )
-      message = Message.Identify.decode(data)
-    } catch (/** @type {any} */ err) {
-      return log.error('received invalid message', err)
-    }
-
-    const id = connection.remotePeer
-
-    try {
-      const envelope = await Envelope.openAndCertify(message.signedPeerRecord, PeerRecord.DOMAIN)
-      if (await this.peerStore.addressBook.consumePeerRecord(envelope)) {
-        await this.peerStore.protoBook.set(id, message.protocols)
-        return
-      }
-    } catch (/** @type {any} */ err) {
-      log('received invalid envelope, discard it and fallback to listenAddrs is available', err)
-    }
-
-    // LEGACY: Update peers data in PeerStore
-    try {
-      await this.peerStore.addressBook.set(id,
-        message.listenAddrs.map((addr) => new Multiaddr(addr)))
-    } catch (/** @type {any} */ err) {
-      log.error('received invalid addrs', err)
-    }
-
-    // Update the protocols
-    try {
-      await this.peerStore.protoBook.set(id, message.protocols)
-    } catch (/** @type {any} */ err) {
-      log.error('received invalid protocols', err)
-    }
-  }
-
-  /**
-   * Takes the `addr` and converts it to a Multiaddr if possible
-   *
-   * @param {Uint8Array | string} addr
-   * @returns {Multiaddr|null}
-   */
-  static getCleanMultiaddr (addr) {
-    if (addr && addr.length > 0) {
-      try {
-        return new Multiaddr(addr)
-      } catch (_) {
-        return null
-      }
-    }
-    return null
-  }
-}
-
-/**
- * The protocols the IdentifyService supports
- *
- * @property multicodecs
- */
-const multicodecs = {
-  IDENTIFY: MULTICODEC_IDENTIFY,
-  IDENTIFY_PUSH: MULTICODEC_IDENTIFY_PUSH
-}
-
-IdentifyService.multicodecs = multicodecs
-IdentifyService.Messsage = Message
-
-module.exports = IdentifyService

package/src/identify/message.d.ts

@@ -1,95 +0,0 @@
-import * as $protobuf from "protobufjs";
-/** Properties of an Identify. */
-export interface IIdentify {
-
-    /** Identify protocolVersion */
-    protocolVersion?: (string|null);
-
-    /** Identify agentVersion */
-    agentVersion?: (string|null);
-
-    /** Identify publicKey */
-    publicKey?: (Uint8Array|null);
-
-    /** Identify listenAddrs */
-    listenAddrs?: (Uint8Array[]|null);
-
-    /** Identify observedAddr */
-    observedAddr?: (Uint8Array|null);
-
-    /** Identify protocols */
-    protocols?: (string[]|null);
-
-    /** Identify signedPeerRecord */
-    signedPeerRecord?: (Uint8Array|null);
-}
-
-/** Represents an Identify. */
-export class Identify implements IIdentify {
-
-    /**
-     * Constructs a new Identify.
-     * @param [p] Properties to set
-     */
-    constructor(p?: IIdentify);
-
-    /** Identify protocolVersion. */
-    public protocolVersion: string;
-
-    /** Identify agentVersion. */
-    public agentVersion: string;
-
-    /** Identify publicKey. */
-    public publicKey: Uint8Array;
-
-    /** Identify listenAddrs. */
-    public listenAddrs: Uint8Array[];
-
-    /** Identify observedAddr. */
-    public observedAddr: Uint8Array;
-
-    /** Identify protocols. */
-    public protocols: string[];
-
-    /** Identify signedPeerRecord. */
-    public signedPeerRecord: Uint8Array;
-
-    /**
-     * Encodes the specified Identify message. Does not implicitly {@link Identify.verify|verify} messages.
-     * @param m Identify message or plain object to encode
-     * @param [w] Writer to encode to
-     * @returns Writer
-     */
-    public static encode(m: IIdentify, w?: $protobuf.Writer): $protobuf.Writer;
-
-    /**
-     * Decodes an Identify message from the specified reader or buffer.
-     * @param r Reader or buffer to decode from
-     * @param [l] Message length if known beforehand
-     * @returns Identify
-     * @throws {Error} If the payload is not a reader or valid buffer
-     * @throws {$protobuf.util.ProtocolError} If required fields are missing
-     */
-    public static decode(r: ($protobuf.Reader|Uint8Array), l?: number): Identify;
-
-    /**
-     * Creates an Identify message from a plain object. Also converts values to their respective internal types.
-     * @param d Plain object
-     * @returns Identify
-     */
-    public static fromObject(d: { [k: string]: any }): Identify;
-
-    /**
-     * Creates a plain object from an Identify message. Also converts values to other types if specified.
-     * @param m Identify
-     * @param [o] Conversion options
-     * @returns Plain object
-     */
-    public static toObject(m: Identify, o?: $protobuf.IConversionOptions): { [k: string]: any };
-
-    /**
-     * Converts this Identify to JSON.
-     * @returns JSON object
-     */
-    public toJSON(): { [k: string]: any };
-}