@libp2p/identify 1.0.21 → 2.0.0

package/src/identify-push.ts

@@ -0,0 +1,146 @@
+/* eslint-disable complexity */
+
+import { setMaxListeners } from '@libp2p/interface'
+import { RecordEnvelope, PeerRecord } from '@libp2p/peer-record'
+import { protocols } from '@multiformats/multiaddr'
+import drain from 'it-drain'
+import parallel from 'it-parallel'
+import { pbStream } from 'it-protobuf-stream'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
+import {
+  MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME,
+  MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION
+} from './consts.js'
+import { Identify as IdentifyMessage } from './pb/message.js'
+import { AbstractIdentify, consumeIdentifyMessage, defaultValues } from './utils.js'
+import type { IdentifyPush as IdentifyPushInterface, IdentifyPushComponents, IdentifyPushInit } from './index.js'
+import type { Stream, Startable } from '@libp2p/interface'
+import type { ConnectionManager, IncomingStreamData } from '@libp2p/interface-internal'
+
+export class IdentifyPush extends AbstractIdentify implements Startable, IdentifyPushInterface {
+  private readonly connectionManager: ConnectionManager
+  private readonly concurrency: number
+
+  constructor (components: IdentifyPushComponents, init: IdentifyPushInit = {}) {
+    super(components, {
+      ...init,
+      protocol: `/${init.protocolPrefix ?? defaultValues.protocolPrefix}/${MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME}/${MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION}`,
+      log: components.logger.forComponent('libp2p:identify-push')
+    })
+
+    this.connectionManager = components.connectionManager
+    this.concurrency = init.concurrency ?? defaultValues.concurrency
+
+    if ((init.runOnSelfUpdate ?? defaultValues.runOnSelfUpdate)) {
+      // When self peer record changes, trigger identify-push
+      components.events.addEventListener('self:peer:update', (evt) => {
+        void this.push().catch(err => { this.log.error(err) })
+      })
+    }
+  }
+
+  /**
+   * Calls `push` on all peer connections
+   */
+  async push (): Promise<void> {
+    // Do not try to push if we are not running
+    if (!this.isStarted()) {
+      return
+    }
+
+    const listenAddresses = this.addressManager.getAddresses().map(ma => ma.decapsulateCode(protocols('p2p').code))
+    const peerRecord = new PeerRecord({
+      peerId: this.peerId,
+      multiaddrs: listenAddresses
+    })
+    const signedPeerRecord = await RecordEnvelope.seal(peerRecord, this.peerId)
+    const supportedProtocols = this.registrar.getProtocols()
+    const peer = await this.peerStore.get(this.peerId)
+    const agentVersion = uint8ArrayToString(peer.metadata.get('AgentVersion') ?? uint8ArrayFromString(this.host.agentVersion))
+    const protocolVersion = uint8ArrayToString(peer.metadata.get('ProtocolVersion') ?? uint8ArrayFromString(this.host.protocolVersion))
+    const self = this
+
+    async function * pushToConnections (): AsyncGenerator<() => Promise<void>> {
+      for (const connection of self.connectionManager.getConnections()) {
+        const peer = await self.peerStore.get(connection.remotePeer)
+
+        if (!peer.protocols.includes(self.protocol)) {
+          continue
+        }
+
+        yield async () => {
+          let stream: Stream | undefined
+          const signal = AbortSignal.timeout(self.timeout)
+
+          setMaxListeners(Infinity, signal)
+
+          try {
+            stream = await connection.newStream(self.protocol, {
+              signal,
+              runOnTransientConnection: self.runOnTransientConnection
+            })
+
+            const pb = pbStream(stream, {
+              maxDataLength: self.maxMessageSize
+            }).pb(IdentifyMessage)
+
+            await pb.write({
+              listenAddrs: listenAddresses.map(ma => ma.bytes),
+              signedPeerRecord: signedPeerRecord.marshal(),
+              protocols: supportedProtocols,
+              agentVersion,
+              protocolVersion
+            }, {
+              signal
+            })
+
+            await stream.close({
+              signal
+            })
+          } catch (err: any) {
+            // Just log errors
+            self.log.error('could not push identify update to peer', err)
+            stream?.abort(err)
+          }
+        }
+      }
+    }
+
+    await drain(parallel(pushToConnections(), {
+      concurrency: this.concurrency
+    }))
+  }
+
+  /**
+   * Reads the Identify Push message from the given `connection`
+   */
+  async handleProtocol (data: IncomingStreamData): Promise<void> {
+    const { connection, stream } = data
+
+    try {
+      if (this.peerId.equals(connection.remotePeer)) {
+        throw new Error('received push from ourselves?')
+      }
+
+      const options = {
+        signal: AbortSignal.timeout(this.timeout)
+      }
+
+      const pb = pbStream(stream, {
+        maxDataLength: this.maxMessageSize
+      }).pb(IdentifyMessage)
+
+      const message = await pb.read(options)
+      await stream.close(options)
+
+      await consumeIdentifyMessage(this.peerStore, this.events, this.log, connection, message)
+    } catch (err: any) {
+      this.log.error('received invalid message', err)
+      stream.abort(err)
+      return
+    }
+
+    this.log('handled push from %p', connection.remotePeer)
+  }
+}

package/src/identify.ts

@@ -1,94 +1,28 @@
 /* eslint-disable complexity */
 
-import { CodeError, ERR_NOT_FOUND, setMaxListeners } from '@libp2p/interface'
+import { CodeError, setMaxListeners } from '@libp2p/interface'
 import { peerIdFromKeys } from '@libp2p/peer-id'
 import { RecordEnvelope, PeerRecord } from '@libp2p/peer-record'
-import { type Multiaddr, multiaddr, protocols } from '@multiformats/multiaddr'
+import { protocols } from '@multiformats/multiaddr'
 import { IP_OR_DOMAIN } from '@multiformats/multiaddr-matcher'
 import { pbStream } from 'it-protobuf-stream'
-import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
-import { isNode, isBrowser, isWebWorker, isElectronMain, isElectronRenderer, isReactNative } from 'wherearewe'
 import {
-  IDENTIFY_PROTOCOL_VERSION,
   MULTICODEC_IDENTIFY_PROTOCOL_NAME,
-  MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME,
-  MULTICODEC_IDENTIFY_PROTOCOL_VERSION,
-  MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION
+  MULTICODEC_IDENTIFY_PROTOCOL_VERSION
 } from './consts.js'
 import { Identify as IdentifyMessage } from './pb/message.js'
+import { AbstractIdentify, consumeIdentifyMessage, defaultValues, getCleanMultiaddr } from './utils.js'
 import type { Identify as IdentifyInterface, IdentifyComponents, IdentifyInit } from './index.js'
-import type { Libp2pEvents, IdentifyResult, SignedPeerRecord, AbortOptions, Logger, Connection, Stream, TypedEventTarget, PeerId, Peer, PeerData, PeerStore, Startable } from '@libp2p/interface'
-import type { AddressManager, ConnectionManager, IncomingStreamData, Registrar } from '@libp2p/interface-internal'
-
-// https://github.com/libp2p/go-libp2p/blob/8d2e54e1637041d5cf4fac1e531287560bd1f4ac/p2p/protocol/identify/id.go#L52
-const MAX_IDENTIFY_MESSAGE_SIZE = 1024 * 8
-
-const defaultValues = {
-  protocolPrefix: 'ipfs',
-  // https://github.com/libp2p/go-libp2p/blob/8d2e54e1637041d5cf4fac1e531287560bd1f4ac/p2p/protocol/identify/id.go#L48
-  timeout: 60000,
-  maxInboundStreams: 1,
-  maxOutboundStreams: 1,
-  maxPushIncomingStreams: 1,
-  maxPushOutgoingStreams: 1,
-  maxObservedAddresses: 10,
-  maxIdentifyMessageSize: 8192,
-  runOnConnectionOpen: true,
-  runOnTransientConnection: true
-}
-
-export class Identify implements Startable, IdentifyInterface {
-  private readonly identifyProtocolStr: string
-  private readonly identifyPushProtocolStr: string
-  public readonly host: {
-    protocolVersion: string
-    agentVersion: string
-  }
-
-  private started: boolean
-  private readonly timeout: number
-  private readonly peerId: PeerId
-  private readonly peerStore: PeerStore
-  private readonly registrar: Registrar
-  private readonly connectionManager: ConnectionManager
-  private readonly addressManager: AddressManager
-  private readonly maxInboundStreams: number
-  private readonly maxOutboundStreams: number
-  private readonly maxPushIncomingStreams: number
-  private readonly maxPushOutgoingStreams: number
-  private readonly maxIdentifyMessageSize: number
-  private readonly maxObservedAddresses: number
-  private readonly events: TypedEventTarget<Libp2pEvents>
-  private readonly runOnTransientConnection: boolean
-  private readonly log: Logger
+import type { IdentifyResult, AbortOptions, Connection, Stream, Startable } from '@libp2p/interface'
+import type { IncomingStreamData } from '@libp2p/interface-internal'
 
+export class Identify extends AbstractIdentify implements Startable, IdentifyInterface {
   constructor (components: IdentifyComponents, init: IdentifyInit = {}) {
-    this.started = false
-    this.peerId = components.peerId
-    this.peerStore = components.peerStore
-    this.registrar = components.registrar
-    this.addressManager = components.addressManager
-    this.connectionManager = components.connectionManager
-    this.events = components.events
-    this.log = components.logger.forComponent('libp2p:identify')
-
-    this.identifyProtocolStr = `/${init.protocolPrefix ?? defaultValues.protocolPrefix}/${MULTICODEC_IDENTIFY_PROTOCOL_NAME}/${MULTICODEC_IDENTIFY_PROTOCOL_VERSION}`
-    this.identifyPushProtocolStr = `/${init.protocolPrefix ?? defaultValues.protocolPrefix}/${MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME}/${MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION}`
-    this.timeout = init.timeout ?? defaultValues.timeout
-    this.maxInboundStreams = init.maxInboundStreams ?? defaultValues.maxInboundStreams
-    this.maxOutboundStreams = init.maxOutboundStreams ?? defaultValues.maxOutboundStreams
-    this.maxPushIncomingStreams = init.maxPushIncomingStreams ?? defaultValues.maxPushIncomingStreams
-    this.maxPushOutgoingStreams = init.maxPushOutgoingStreams ?? defaultValues.maxPushOutgoingStreams
-    this.maxIdentifyMessageSize = init.maxIdentifyMessageSize ?? defaultValues.maxIdentifyMessageSize
-    this.maxObservedAddresses = init.maxObservedAddresses ?? defaultValues.maxObservedAddresses
-    this.runOnTransientConnection = init.runOnTransientConnection ?? defaultValues.runOnTransientConnection
-
-    // Store self host metadata
-    this.host = {
-      protocolVersion: `${init.protocolPrefix ?? defaultValues.protocolPrefix}/${IDENTIFY_PROTOCOL_VERSION}`,
-      agentVersion: init.agentVersion ?? `${components.nodeInfo.name}/${components.nodeInfo.version}`
-    }
+    super(components, {
+      ...init,
+      protocol: `/${init.protocolPrefix ?? defaultValues.protocolPrefix}/${MULTICODEC_IDENTIFY_PROTOCOL_NAME}/${MULTICODEC_IDENTIFY_PROTOCOL_VERSION}`,
+      log: components.logger.forComponent('libp2p:identify')
+    })
 
     if (init.runOnConnectionOpen ?? defaultValues.runOnConnectionOpen) {
       // When a new connection happens, trigger identify
@@ -97,151 +31,6 @@ export class Identify implements Startable, IdentifyInterface {
         this.identify(connection).catch(err => { this.log.error('error during identify trigged by connection:open', err) })
       })
     }
-
-    // When self peer record changes, trigger identify-push
-    components.events.addEventListener('self:peer:update', (evt) => {
-      void this.push().catch(err => { this.log.error(err) })
-    })
-
-    // Append user agent version to default AGENT_VERSION depending on the environment
-    if (this.host.agentVersion === `${components.nodeInfo.name}/${components.nodeInfo.version}`) {
-      if (isNode || isElectronMain) {
-        this.host.agentVersion += ` UserAgent=${globalThis.process.version}`
-      } else if (isBrowser || isWebWorker || isElectronRenderer || isReactNative) {
-        this.host.agentVersion += ` UserAgent=${globalThis.navigator.userAgent}`
-      }
-    }
-  }
-
-  isStarted (): boolean {
-    return this.started
-  }
-
-  async start (): Promise<void> {
-    if (this.started) {
-      return
-    }
-
-    await this.peerStore.merge(this.peerId, {
-      metadata: {
-        AgentVersion: uint8ArrayFromString(this.host.agentVersion),
-        ProtocolVersion: uint8ArrayFromString(this.host.protocolVersion)
-      }
-    })
-
-    await this.registrar.handle(this.identifyProtocolStr, (data) => {
-      void this._handleIdentify(data).catch(err => {
-        this.log.error(err)
-      })
-    }, {
-      maxInboundStreams: this.maxInboundStreams,
-      maxOutboundStreams: this.maxOutboundStreams,
-      runOnTransientConnection: this.runOnTransientConnection
-    })
-    await this.registrar.handle(this.identifyPushProtocolStr, (data) => {
-      void this._handlePush(data).catch(err => {
-        this.log.error(err)
-      })
-    }, {
-      maxInboundStreams: this.maxPushIncomingStreams,
-      maxOutboundStreams: this.maxPushOutgoingStreams,
-      runOnTransientConnection: this.runOnTransientConnection
-    })
-
-    this.started = true
-  }
-
-  async stop (): Promise<void> {
-    await this.registrar.unhandle(this.identifyProtocolStr)
-    await this.registrar.unhandle(this.identifyPushProtocolStr)
-
-    this.started = false
-  }
-
-  /**
-   * Send an Identify Push update to the list of connections
-   */
-  async pushToConnections (connections: Connection[]): Promise<void> {
-    const listenAddresses = this.addressManager.getAddresses().map(ma => ma.decapsulateCode(protocols('p2p').code))
-    const peerRecord = new PeerRecord({
-      peerId: this.peerId,
-      multiaddrs: listenAddresses
-    })
-    const signedPeerRecord = await RecordEnvelope.seal(peerRecord, this.peerId)
-    const supportedProtocols = this.registrar.getProtocols()
-    const peer = await this.peerStore.get(this.peerId)
-    const agentVersion = uint8ArrayToString(peer.metadata.get('AgentVersion') ?? uint8ArrayFromString(this.host.agentVersion))
-    const protocolVersion = uint8ArrayToString(peer.metadata.get('ProtocolVersion') ?? uint8ArrayFromString(this.host.protocolVersion))
-
-    const pushes = connections.map(async connection => {
-      let stream: Stream | undefined
-      const signal = AbortSignal.timeout(this.timeout)
-
-      setMaxListeners(Infinity, signal)
-
-      try {
-        stream = await connection.newStream(this.identifyPushProtocolStr, {
-          signal,
-          runOnTransientConnection: this.runOnTransientConnection
-        })
-
-        const pb = pbStream(stream, {
-          maxDataLength: this.maxIdentifyMessageSize ?? MAX_IDENTIFY_MESSAGE_SIZE
-        }).pb(IdentifyMessage)
-
-        await pb.write({
-          listenAddrs: listenAddresses.map(ma => ma.bytes),
-          signedPeerRecord: signedPeerRecord.marshal(),
-          protocols: supportedProtocols,
-          agentVersion,
-          protocolVersion
-        }, {
-          signal
-        })
-
-        await stream.close({
-          signal
-        })
-      } catch (err: any) {
-        // Just log errors
-        this.log.error('could not push identify update to peer', err)
-        stream?.abort(err)
-      }
-    })
-
-    await Promise.all(pushes)
-  }
-
-  /**
-   * Calls `push` on all peer connections
-   */
-  async push (): Promise<void> {
-    // Do not try to push if we are not running
-    if (!this.isStarted()) {
-      return
-    }
-
-    const connections: Connection[] = []
-
-    await Promise.all(
-      this.connectionManager.getConnections().map(async conn => {
-        try {
-          const peer = await this.peerStore.get(conn.remotePeer)
-
-          if (!peer.protocols.includes(this.identifyPushProtocolStr)) {
-            return
-          }
-
-          connections.push(conn)
-        } catch (err: any) {
-          if (err.code !== ERR_NOT_FOUND) {
-            throw err
-          }
-        }
-      })
-    )
-
-    await this.pushToConnections(connections)
   }
 
   async _identify (connection: Connection, options: AbortOptions = {}): Promise<IdentifyMessage> {
@@ -258,13 +47,13 @@ export class Identify implements Startable, IdentifyInterface {
     }
 
     try {
-      stream = await connection.newStream(this.identifyProtocolStr, {
+      stream = await connection.newStream(this.protocol, {
         ...options,
         runOnTransientConnection: this.runOnTransientConnection
       })
 
       const pb = pbStream(stream, {
-        maxDataLength: this.maxIdentifyMessageSize ?? MAX_IDENTIFY_MESSAGE_SIZE
+        maxDataLength: this.maxMessageSize
       }).pb(IdentifyMessage)
 
       const message = await pb.read(options)
@@ -313,14 +102,14 @@ export class Identify implements Startable, IdentifyInterface {
       this.addressManager.addObservedAddr(cleanObservedAddr)
     }
 
-    return this.#consumeIdentifyMessage(connection, message)
+    return consumeIdentifyMessage(this.peerStore, this.events, this.log, connection, message)
   }
 
   /**
    * Sends the `Identify` response with the Signed Peer Record
    * to the requesting peer over the given `connection`
    */
-  async _handleIdentify (data: IncomingStreamData): Promise<void> {
+  async handleProtocol (data: IncomingStreamData): Promise<void> {
     const { connection, stream } = data
 
     const signal = AbortSignal.timeout(this.timeout)
@@ -371,181 +160,4 @@ export class Identify implements Startable, IdentifyInterface {
       stream.abort(err)
     }
   }
-
-  /**
-   * Reads the Identify Push message from the given `connection`
-   */
-  async _handlePush (data: IncomingStreamData): Promise<void> {
-    const { connection, stream } = data
-
-    try {
-      if (this.peerId.equals(connection.remotePeer)) {
-        throw new Error('received push from ourselves?')
-      }
-
-      const options = {
-        signal: AbortSignal.timeout(this.timeout)
-      }
-
-      const pb = pbStream(stream, {
-        maxDataLength: this.maxIdentifyMessageSize ?? MAX_IDENTIFY_MESSAGE_SIZE
-      }).pb(IdentifyMessage)
-
-      const message = await pb.read(options)
-      await stream.close(options)
-
-      await this.#consumeIdentifyMessage(connection, message)
-    } catch (err: any) {
-      this.log.error('received invalid message', err)
-      stream.abort(err)
-      return
-    }
-
-    this.log('handled push from %p', connection.remotePeer)
-  }
-
-  async #consumeIdentifyMessage (connection: Connection, message: IdentifyMessage): Promise<IdentifyResult> {
-    this.log('received identify from %p', connection.remotePeer)
-
-    if (message == null) {
-      throw new CodeError('message was null or undefined', 'ERR_INVALID_MESSAGE')
-    }
-
-    const peer: PeerData = {}
-
-    if (message.listenAddrs.length > 0) {
-      peer.addresses = message.listenAddrs.map(buf => ({
-        isCertified: false,
-        multiaddr: multiaddr(buf)
-      }))
-    }
-
-    if (message.protocols.length > 0) {
-      peer.protocols = message.protocols
-    }
-
-    if (message.publicKey != null) {
-      peer.publicKey = message.publicKey
-
-      const peerId = await peerIdFromKeys(message.publicKey)
-
-      if (!peerId.equals(connection.remotePeer)) {
-        throw new CodeError('public key did not match remote PeerId', 'ERR_INVALID_PUBLIC_KEY')
-      }
-    }
-
-    let output: SignedPeerRecord | undefined
-
-    // if the peer record has been sent, prefer the addresses in the record as they are signed by the remote peer
-    if (message.signedPeerRecord != null) {
-      this.log('received signedPeerRecord from %p', connection.remotePeer)
-
-      let peerRecordEnvelope = message.signedPeerRecord
-      const envelope = await RecordEnvelope.openAndCertify(peerRecordEnvelope, PeerRecord.DOMAIN)
-      let peerRecord = PeerRecord.createFromProtobuf(envelope.payload)
-
-      // Verify peerId
-      if (!peerRecord.peerId.equals(envelope.peerId)) {
-        throw new CodeError('signing key does not match PeerId in the PeerRecord', 'ERR_INVALID_SIGNING_KEY')
-      }
-
-      // Make sure remote peer is the one sending the record
-      if (!connection.remotePeer.equals(peerRecord.peerId)) {
-        throw new CodeError('signing key does not match remote PeerId', 'ERR_INVALID_PEER_RECORD_KEY')
-      }
-
-      let existingPeer: Peer | undefined
-
-      try {
-        existingPeer = await this.peerStore.get(peerRecord.peerId)
-      } catch (err: any) {
-        if (err.code !== 'ERR_NOT_FOUND') {
-          throw err
-        }
-      }
-
-      if (existingPeer != null) {
-        // don't lose any existing metadata
-        peer.metadata = existingPeer.metadata
-
-        // if we have previously received a signed record for this peer, compare it to the incoming one
-        if (existingPeer.peerRecordEnvelope != null) {
-          const storedEnvelope = await RecordEnvelope.createFromProtobuf(existingPeer.peerRecordEnvelope)
-          const storedRecord = PeerRecord.createFromProtobuf(storedEnvelope.payload)
-
-          // ensure seq is greater than, or equal to, the last received
-          if (storedRecord.seqNumber >= peerRecord.seqNumber) {
-            this.log('sequence number was lower or equal to existing sequence number - stored: %d received: %d', storedRecord.seqNumber, peerRecord.seqNumber)
-            peerRecord = storedRecord
-            peerRecordEnvelope = existingPeer.peerRecordEnvelope
-          }
-        }
-      }
-
-      // store the signed record for next time
-      peer.peerRecordEnvelope = peerRecordEnvelope
-
-      // override the stored addresses with the signed multiaddrs
-      peer.addresses = peerRecord.multiaddrs.map(multiaddr => ({
-        isCertified: true,
-        multiaddr
-      }))
-
-      output = {
-        seq: peerRecord.seqNumber,
-        addresses: peerRecord.multiaddrs
-      }
-    } else {
-      this.log('%p did not send a signed peer record', connection.remotePeer)
-    }
-
-    this.log('patching %p with', connection.remotePeer, peer)
-    await this.peerStore.patch(connection.remotePeer, peer)
-
-    if (message.agentVersion != null || message.protocolVersion != null) {
-      const metadata: Record<string, Uint8Array> = {}
-
-      if (message.agentVersion != null) {
-        metadata.AgentVersion = uint8ArrayFromString(message.agentVersion)
-      }
-
-      if (message.protocolVersion != null) {
-        metadata.ProtocolVersion = uint8ArrayFromString(message.protocolVersion)
-      }
-
-      this.log('merging %p metadata', connection.remotePeer, metadata)
-      await this.peerStore.merge(connection.remotePeer, {
-        metadata
-      })
-    }
-
-    const result: IdentifyResult = {
-      peerId: connection.remotePeer,
-      protocolVersion: message.protocolVersion,
-      agentVersion: message.agentVersion,
-      publicKey: message.publicKey,
-      listenAddrs: message.listenAddrs.map(buf => multiaddr(buf)),
-      observedAddr: message.observedAddr == null ? undefined : multiaddr(message.observedAddr),
-      protocols: message.protocols,
-      signedPeerRecord: output,
-      connection
-    }
-
-    this.events.safeDispatchEvent('peer:identify', { detail: result })
-
-    return result
-  }
-}
-
-/**
- * Takes the `addr` and converts it to a Multiaddr if possible
- */
-function getCleanMultiaddr (addr: Uint8Array | string | null | undefined): Multiaddr | undefined {
-  if (addr != null && addr.length > 0) {
-    try {
-      return multiaddr(addr)
-    } catch {
-
-    }
-  }
 }