libp2p 0.37.3-e6f646e → 0.38.0-0e7096d

package/src/identify/pb/message.ts

@@ -1,7 +1,8 @@
 /* eslint-disable import/export */
 /* eslint-disable @typescript-eslint/no-namespace */
 
-import { encodeMessage, decodeMessage, message, string, bytes } from 'protons-runtime'
+import { encodeMessage, decodeMessage, message } from 'protons-runtime'
+import type { Uint8ArrayList } from 'uint8arraylist'
 import type { Codec } from 'protons-runtime'
 
 export interface Identify {
@@ -15,23 +16,122 @@ export interface Identify {
 }
 
 export namespace Identify {
+  let _codec: Codec<Identify>
+
   export const codec = (): Codec<Identify> => {
-    return message<Identify>({
-      5: { name: 'protocolVersion', codec: string, optional: true },
-      6: { name: 'agentVersion', codec: string, optional: true },
-      1: { name: 'publicKey', codec: bytes, optional: true },
-      2: { name: 'listenAddrs', codec: bytes, repeats: true },
-      4: { name: 'observedAddr', codec: bytes, optional: true },
-      3: { name: 'protocols', codec: string, repeats: true },
-      8: { name: 'signedPeerRecord', codec: bytes, optional: true }
-    })
+    if (_codec == null) {
+      _codec = message<Identify>((obj, writer, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          writer.fork()
+        }
+
+        if (obj.protocolVersion != null) {
+          writer.uint32(42)
+          writer.string(obj.protocolVersion)
+        }
+
+        if (obj.agentVersion != null) {
+          writer.uint32(50)
+          writer.string(obj.agentVersion)
+        }
+
+        if (obj.publicKey != null) {
+          writer.uint32(10)
+          writer.bytes(obj.publicKey)
+        }
+
+        if (obj.listenAddrs != null) {
+          for (const value of obj.listenAddrs) {
+            writer.uint32(18)
+            writer.bytes(value)
+          }
+        } else {
+          throw new Error('Protocol error: required field "listenAddrs" was not found in object')
+        }
+
+        if (obj.observedAddr != null) {
+          writer.uint32(34)
+          writer.bytes(obj.observedAddr)
+        }
+
+        if (obj.protocols != null) {
+          for (const value of obj.protocols) {
+            writer.uint32(26)
+            writer.string(value)
+          }
+        } else {
+          throw new Error('Protocol error: required field "protocols" was not found in object')
+        }
+
+        if (obj.signedPeerRecord != null) {
+          writer.uint32(66)
+          writer.bytes(obj.signedPeerRecord)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          writer.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {}
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 5:
+              obj.protocolVersion = reader.string()
+              break
+            case 6:
+              obj.agentVersion = reader.string()
+              break
+            case 1:
+              obj.publicKey = reader.bytes()
+              break
+            case 2:
+              obj.listenAddrs = obj.listenAddrs ?? []
+              obj.listenAddrs.push(reader.bytes())
+              break
+            case 4:
+              obj.observedAddr = reader.bytes()
+              break
+            case 3:
+              obj.protocols = obj.protocols ?? []
+              obj.protocols.push(reader.string())
+              break
+            case 8:
+              obj.signedPeerRecord = reader.bytes()
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        obj.listenAddrs = obj.listenAddrs ?? []
+        obj.protocols = obj.protocols ?? []
+
+        if (obj.listenAddrs == null) {
+          throw new Error('Protocol error: value for required field "listenAddrs" was not found in protobuf')
+        }
+
+        if (obj.protocols == null) {
+          throw new Error('Protocol error: value for required field "protocols" was not found in protobuf')
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
   }
 
   export const encode = (obj: Identify): Uint8Array => {
     return encodeMessage(obj, Identify.codec())
   }
 
-  export const decode = (buf: Uint8Array): Identify => {
+  export const decode = (buf: Uint8Array | Uint8ArrayList): Identify => {
     return decodeMessage(buf, Identify.codec())
   }
 }

package/src/index.ts

@@ -50,6 +50,7 @@ export interface MetricsConfig {
 export interface HopConfig {
   enabled?: boolean
   active?: boolean
+  timeout: number
 }
 
 export interface RelayConfig {
@@ -139,12 +140,6 @@ export interface Libp2p extends Startable, EventEmitter<Libp2pEvents> {
   pubsub: PubSub
   dht: DualDHT
 
-  /**
-   * Load keychain keys from the datastore.
-   * Imports the private key as 'self', if needed.
-   */
-  loadKeychain: () => Promise<void>
-
   /**
    * Get a deduplicated list of peer advertising multiaddrs by concatenating
    * the listen addresses used by transports with any configured

package/src/insecure/index.ts

@@ -7,6 +7,7 @@ import type { PeerId } from '@libp2p/interface-peer-id'
 import { peerIdFromBytes, peerIdFromKeys } from '@libp2p/peer-id'
 import type { ConnectionEncrypter, SecuredConnection } from '@libp2p/interface-connection-encrypter'
 import type { Duplex } from 'it-stream-types'
+import map from 'it-map'
 
 const log = logger('libp2p:plaintext')
 const PROTOCOL = '/plaintext/2.0.0'
@@ -39,7 +40,7 @@ async function encrypt (localId: PeerId, conn: Duplex<Uint8Array>, remoteId?: Pe
         Type: type,
         Data: localId.publicKey ?? new Uint8Array(0)
       }
-    }).slice()
+    }).subarray()
   )
 
   log('write pubkey exchange to peer %p', remoteId)
@@ -47,7 +48,7 @@ async function encrypt (localId: PeerId, conn: Duplex<Uint8Array>, remoteId?: Pe
   // Get the Exchange message
   // @ts-expect-error needs to be generator
   const response = (await lp.decode.fromReader(shake.reader).next()).value
-  const id = Exchange.decode(response.slice())
+  const id = Exchange.decode(response)
   log('read pubkey exchange from peer %p', remoteId)
 
   let peerId
@@ -81,8 +82,12 @@ async function encrypt (localId: PeerId, conn: Duplex<Uint8Array>, remoteId?: Pe
   log('plaintext key exchange completed successfully with peer %p', peerId)
 
   shake.rest()
+
   return {
-    conn: shake.stream,
+    conn: {
+      sink: shake.stream.sink,
+      source: map(shake.stream.source, (buf) => buf.subarray())
+    },
     remotePeer: peerId,
     remoteEarlyData: new Uint8Array()
   }

package/src/insecure/pb/proto.ts

@@ -1,7 +1,8 @@
 /* eslint-disable import/export */
 /* eslint-disable @typescript-eslint/no-namespace */
 
-import { encodeMessage, decodeMessage, message, bytes, enumeration } from 'protons-runtime'
+import { encodeMessage, decodeMessage, message, enumeration } from 'protons-runtime'
+import type { Uint8ArrayList } from 'uint8arraylist'
 import type { Codec } from 'protons-runtime'
 
 export interface Exchange {
@@ -10,18 +11,61 @@ export interface Exchange {
 }
 
 export namespace Exchange {
+  let _codec: Codec<Exchange>
+
   export const codec = (): Codec<Exchange> => {
-    return message<Exchange>({
-      1: { name: 'id', codec: bytes, optional: true },
-      2: { name: 'pubkey', codec: PublicKey.codec(), optional: true }
-    })
+    if (_codec == null) {
+      _codec = message<Exchange>((obj, writer, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          writer.fork()
+        }
+
+        if (obj.id != null) {
+          writer.uint32(10)
+          writer.bytes(obj.id)
+        }
+
+        if (obj.pubkey != null) {
+          writer.uint32(18)
+          PublicKey.codec().encode(obj.pubkey, writer)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          writer.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {}
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.id = reader.bytes()
+              break
+            case 2:
+              obj.pubkey = PublicKey.codec().decode(reader, reader.uint32())
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
   }
 
   export const encode = (obj: Exchange): Uint8Array => {
     return encodeMessage(obj, Exchange.codec())
   }
 
-  export const decode = (buf: Uint8Array): Exchange => {
+  export const decode = (buf: Uint8Array | Uint8ArrayList): Exchange => {
     return decodeMessage(buf, Exchange.codec())
   }
 }
@@ -42,7 +86,7 @@ enum __KeyTypeValues {
 
 export namespace KeyType {
   export const codec = () => {
-    return enumeration<typeof KeyType>(__KeyTypeValues)
+    return enumeration<KeyType>(__KeyTypeValues)
   }
 }
 export interface PublicKey {
@@ -51,18 +95,73 @@ export interface PublicKey {
 }
 
 export namespace PublicKey {
+  let _codec: Codec<PublicKey>
+
   export const codec = (): Codec<PublicKey> => {
-    return message<PublicKey>({
-      1: { name: 'Type', codec: KeyType.codec() },
-      2: { name: 'Data', codec: bytes }
-    })
+    if (_codec == null) {
+      _codec = message<PublicKey>((obj, writer, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          writer.fork()
+        }
+
+        if (obj.Type != null) {
+          writer.uint32(8)
+          KeyType.codec().encode(obj.Type, writer)
+        } else {
+          throw new Error('Protocol error: required field "Type" was not found in object')
+        }
+
+        if (obj.Data != null) {
+          writer.uint32(18)
+          writer.bytes(obj.Data)
+        } else {
+          throw new Error('Protocol error: required field "Data" was not found in object')
+        }
+
+        if (opts.lengthDelimited !== false) {
+          writer.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {}
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.Type = KeyType.codec().decode(reader)
+              break
+            case 2:
+              obj.Data = reader.bytes()
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        if (obj.Type == null) {
+          throw new Error('Protocol error: value for required field "Type" was not found in protobuf')
+        }
+
+        if (obj.Data == null) {
+          throw new Error('Protocol error: value for required field "Data" was not found in protobuf')
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
   }
 
   export const encode = (obj: PublicKey): Uint8Array => {
     return encodeMessage(obj, PublicKey.codec())
   }
 
-  export const decode = (buf: Uint8Array): PublicKey => {
+  export const decode = (buf: Uint8Array | Uint8ArrayList): PublicKey => {
     return decodeMessage(buf, PublicKey.codec())
   }
 }

package/src/keychain/index.ts

@@ -13,6 +13,7 @@ import { generateKeyPair, importKey, unmarshalPrivateKey } from '@libp2p/crypto/
 import type { PeerId } from '@libp2p/interface-peer-id'
 import type { Components } from '@libp2p/components'
 import { pbkdf2, randomBytes } from '@libp2p/crypto'
+import type { Startable } from '@libp2p/interfaces/dist/src/startable'
 
 const log = logger('libp2p:keychain')
 
@@ -110,9 +111,10 @@ function DsInfoName (name: string) {
  * - '/pkcs8/*key-name*', contains the PKCS #8 for the key
  *
  */
-export class KeyChain {
+export class KeyChain implements Startable {
   private readonly components: Components
   private init: KeyChainInit
+  private started: boolean
 
   /**
    * Creates a new instance of a key chain
@@ -145,6 +147,25 @@ export class KeyChain {
       : ''
 
     privates.set(this, { dek })
+    this.started = false
+  }
+
+  isStarted () {
+    return this.started
+  }
+
+  async start () {
+    const dsname = DsInfoName('self')
+
+    if (!(await this.components.getDatastore().has(dsname))) {
+      await this.importPeer('self', this.components.getPeerId())
+    }
+
+    this.started = true
+  }
+
+  stop () {
+    this.started = false
   }
 
   /**
@@ -474,8 +495,11 @@ export class KeyChain {
       if (!validateKeyName(name)) {
         throw errCode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)
       }
-      if (peer == null || peer.privateKey == null) {
-        throw errCode(new Error('Peer.privKey is required'), codes.ERR_MISSING_PRIVATE_KEY)
+      if (peer == null) {
+        throw errCode(new Error('PeerId is required'), codes.ERR_MISSING_PRIVATE_KEY)
+      }
+      if (peer.privateKey == null) {
+        throw errCode(new Error('PeerId.privKey is required'), codes.ERR_MISSING_PRIVATE_KEY)
       }
 
       const privateKey = await unmarshalPrivateKey(peer.privateKey)

package/src/libp2p.ts

@@ -124,7 +124,8 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     // Set up the Upgrader
     this.components.setUpgrader(new DefaultUpgrader(this.components, {
       connectionEncryption: (init.connectionEncryption ?? []).map(component => this.configureComponent(component)),
-      muxers: (init.streamMuxers ?? []).map(component => this.configureComponent(component))
+      muxers: (init.streamMuxers ?? []).map(component => this.configureComponent(component)),
+      inboundUpgradeTimeout: init.connectionManager.inboundUpgradeTimeout
     }))
 
     // Create the Connection Manager
@@ -217,7 +218,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     })))
 
     if (init.relay.enabled) {
-      this.components.getTransportManager().add(this.configureComponent(new Circuit()))
+      this.components.getTransportManager().add(this.configureComponent(new Circuit(init.relay)))
 
       this.configureComponent(new Relay(this.components, {
         addressSorter: init.connectionManager.addressSorter,
@@ -351,22 +352,6 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     log('libp2p has stopped')
   }
 
-  /**
-   * Load keychain keys from the datastore.
-   * Imports the private key as 'self', if needed.
-   */
-  async loadKeychain () {
-    if (this.keychain == null) {
-      return
-    }
-
-    try {
-      await this.keychain.findKeyByName('self')
-    } catch (err: any) {
-      await this.keychain.importPeer('self', this.peerId)
-    }
-  }
-
   isStarted () {
     return this.started
   }

package/src/metrics/index.ts

@@ -6,7 +6,6 @@ import { DefaultStats, StatsInit } from './stats.js'
 import type { ComponentMetricsUpdate, Metrics, Stats, TrackedMetric, TrackStreamOptions } from '@libp2p/interface-metrics'
 import type { PeerId } from '@libp2p/interface-peer-id'
 import type { Startable } from '@libp2p/interfaces/startable'
-import type { Duplex } from 'it-stream-types'
 
 const initialCounters: ['dataReceived', 'dataSent'] = [
   'dataReceived',
@@ -263,11 +262,11 @@ export class DefaultMetrics implements Metrics, Startable {
    * When the `PeerId` is known, `Metrics.updatePlaceholder` should be called
    * with the placeholder string returned from here, and the known `PeerId`.
    */
-  trackStream <T extends Duplex<Uint8Array>> (opts: TrackStreamOptions<T>): T {
+  trackStream (opts: TrackStreamOptions): void {
     const { stream, remotePeer, protocol } = opts
 
     if (!this.running) {
-      return stream
+      return
     }
 
     const source = stream.source
@@ -275,7 +274,7 @@ export class DefaultMetrics implements Metrics, Startable {
       remotePeer,
       protocol,
       direction: 'in',
-      dataLength: chunk.length
+      dataLength: chunk.byteLength
     }))
 
     const sink = stream.sink
@@ -287,14 +286,12 @@ export class DefaultMetrics implements Metrics, Startable {
             remotePeer,
             protocol,
             direction: 'out',
-            dataLength: chunk.length
+            dataLength: chunk.byteLength
           })
         }),
         sink
       )
     }
-
-    return stream
   }
 }
 

package/src/ping/index.ts

@@ -11,8 +11,10 @@ import type { PeerId } from '@libp2p/interface-peer-id'
 import type { Startable } from '@libp2p/interfaces/startable'
 import type { Components } from '@libp2p/components'
 import type { AbortOptions } from '@libp2p/interfaces'
-import type { Duplex } from 'it-stream-types'
 import { abortableDuplex } from 'abortable-iterator'
+import { TimeoutController } from 'timeout-abort-controller'
+import type { Stream } from '@libp2p/interface-connection'
+import { setMaxListeners } from 'events'
 
 const log = logger('libp2p:ping')
 
@@ -20,6 +22,11 @@ export interface PingServiceInit {
   protocolPrefix: string
   maxInboundStreams: number
   maxOutboundStreams: number
+
+  /**
+   * How long we should wait for a ping response
+   */
+  timeout: number
 }
 
 export class PingService implements Startable {
@@ -73,19 +80,32 @@ export class PingService implements Startable {
   async ping (peer: PeerId, options: AbortOptions = {}): Promise<number> {
     log('dialing %s to %p', this.protocol, peer)
 
-    const connection = await this.components.getConnectionManager().openConnection(peer, options)
-    const stream = await connection.newStream([this.protocol], options)
     const start = Date.now()
     const data = randomBytes(PING_LENGTH)
-
-    let source: Duplex<Uint8Array> = stream
-
-    // make stream abortable if AbortSignal passed
-    if (options.signal != null) {
-      source = abortableDuplex(stream, options.signal)
+    const connection = await this.components.getConnectionManager().openConnection(peer, options)
+    let timeoutController
+    let signal = options.signal
+    let stream: Stream | undefined
+
+    // create a timeout if no abort signal passed
+    if (signal == null) {
+      timeoutController = new TimeoutController(this.init.timeout)
+      signal = timeoutController.signal
+
+      try {
+        // fails on node < 15.4
+        setMaxListeners?.(Infinity, timeoutController.signal)
+      } catch {}
     }
 
     try {
+      stream = await connection.newStream([this.protocol], {
+        signal
+      })
+
+      // make stream abortable
+      const source = abortableDuplex(stream, signal)
+
       const result = await pipe(
         [data],
         source,
@@ -93,13 +113,19 @@ export class PingService implements Startable {
       )
       const end = Date.now()
 
-      if (result == null || !uint8ArrayEquals(data, result)) {
+      if (result == null || !uint8ArrayEquals(data, result.subarray())) {
         throw errCode(new Error('Received wrong ping ack'), codes.ERR_WRONG_PING_ACK)
       }
 
       return end - start
     } finally {
-      stream.close()
+      if (timeoutController != null) {
+        timeoutController.clear()
+      }
+
+      if (stream != null) {
+        stream.close()
+      }
     }
   }
 }

package/src/pnet/index.ts

@@ -13,6 +13,7 @@ import {
 import { handshake } from 'it-handshake'
 import { NONCE_LENGTH } from './key-generator.js'
 import type { ConnectionProtector, MultiaddrConnection } from '@libp2p/interface-connection'
+import map from 'it-map'
 
 const log = logger('libp2p:pnet')
 
@@ -83,6 +84,7 @@ export class PreSharedKeyConnectionProtector implements ConnectionProtector {
       // Encrypt all outbound traffic
       createBoxStream(localNonce, this.psk),
       shake.stream,
+      (source) => map(source, (buf) => buf.subarray()),
       // Decrypt all inbound traffic
       createUnboxStream(remoteNonce, this.psk),
       external

package/src/registrar.ts

@@ -10,8 +10,8 @@ import type { Components } from '@libp2p/components'
 
 const log = logger('libp2p:registrar')
 
-export const DEFAULT_MAX_INBOUND_STREAMS = 1
-export const DEFAULT_MAX_OUTBOUND_STREAMS = 1
+export const DEFAULT_MAX_INBOUND_STREAMS = 32
+export const DEFAULT_MAX_OUTBOUND_STREAMS = 64
 
 /**
  * Responsible for notifying registered protocols of events in the network.