libp2p 0.42.2-593deefe → 0.42.2-5e63ee2d

package/src/libp2p.ts

@@ -1,4 +1,3 @@
-import { RelayReservationManager } from './circuit/client.js'
 import { logger } from '@libp2p/logger'
 import type { AbortOptions } from '@libp2p/interfaces'
 import { EventEmitter, CustomEvent } from '@libp2p/interfaces/events'
@@ -11,8 +10,6 @@ import { codes } from './errors.js'
 import { DefaultAddressManager } from './address-manager/index.js'
 import { DefaultConnectionManager } from './connection-manager/index.js'
 import { AutoDialler } from './connection-manager/auto-dialler.js'
-import { Circuit } from './circuit/transport.js'
-import { Relay } from './circuit/index.js'
 import { DefaultKeyChain } from '@libp2p/keychain'
 import { DefaultTransportManager } from './transport-manager.js'
 import { DefaultUpgrader } from './upgrader.js'
@@ -25,10 +22,11 @@ import { PeerRecordUpdater } from './peer-record-updater.js'
 import { DHTPeerRouting } from './dht/dht-peer-routing.js'
 import { PersistentPeerStore } from '@libp2p/peer-store'
 import { DHTContentRouting } from './dht/dht-content-routing.js'
+import { AutonatService } from './autonat/index.js'
 import { DefaultComponents } from './components.js'
 import type { Components } from './components.js'
 import type { PeerId } from '@libp2p/interface-peer-id'
-import type { Connection } from '@libp2p/interface-connection'
+import type { Connection, Stream } from '@libp2p/interface-connection'
 import type { PeerRouting } from '@libp2p/interface-peer-routing'
 import type { ContentRouting } from '@libp2p/interface-content-routing'
 import type { PubSub } from '@libp2p/interface-pubsub'
@@ -53,6 +51,7 @@ import { peerIdFromString } from '@libp2p/peer-id'
 import type { Datastore } from 'interface-datastore'
 import type { KeyChain } from '@libp2p/interface-keychain'
 import mergeOptions from 'merge-options'
+import type { CircuitRelayService } from './circuit/index.js'
 
 const log = logger('libp2p')
 
@@ -61,9 +60,10 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
   public dht: DualDHT
   public pubsub: PubSub
   public identifyService: IdentifyService
-  public circuitService?: RelayReservationManager
+  public circuitService?: CircuitRelayService
   public fetchService: FetchService
   public pingService: PingService
+  public autonatService: AutonatService
   public components: Components
   public peerStore: PeerStore
   public contentRouting: ContentRouting
@@ -157,12 +157,6 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     // update our peer record when addresses change
     this.configureComponent(new PeerRecordUpdater(this.components))
 
-    this.configureComponent(new AutoDialler(this.components, {
-      enabled: init.connectionManager.autoDial,
-      minConnections: init.connectionManager.minConnections,
-      autoDialInterval: init.connectionManager.autoDialInterval
-    }))
-
     // Create keychain
     const keychainOpts = DefaultKeyChain.generateOptions()
     this.keychain = this.configureComponent(new DefaultKeyChain(this.components, {
@@ -173,24 +167,12 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     // Create the Nat Manager
     this.services.push(new NatManager(this.components, init.nat))
 
-    init.transports.forEach((fn) => {
-      this.components.transportManager.add(this.configureComponent(fn(this.components)))
-    })
-
     // Add the identify service
     this.identifyService = new IdentifyService(this.components, {
       ...init.identify
     })
     this.configureComponent(this.identifyService)
 
-    if (init.relay.reservationManager.enabled === true) {
-      this.circuitService = new RelayReservationManager(this.components, {
-        addressSorter: init.connectionManager.addressSorter,
-        ...init.relay.reservationManager
-      })
-      this.services.push(this.circuitService)
-    }
-
     // dht provided components (peerRouting, contentRouting, dht)
     if (init.dht != null) {
       this.dht = this.components.dht = init.dht(this.components)
@@ -236,14 +218,6 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
       routers: contentRouters
     }))
 
-    if (init.relay.enabled) {
-      this.components.transportManager.add(this.configureComponent(new Circuit(this.components, init.relay)))
-
-      this.configureComponent(new Relay(this.components, {
-        ...init.relay
-      }))
-    }
-
     this.fetchService = this.configureComponent(new FetchService(this.components, {
       ...init.fetch
     }))
@@ -252,6 +226,19 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
       ...init.ping
     }))
 
+    this.autonatService = this.configureComponent(new AutonatService(this.components, {
+      ...init.autonat
+    }))
+
+    this.configureComponent(new AutoDialler(this.components, {
+      minConnections: init.connectionManager.minConnections,
+      autoDialInterval: init.connectionManager.autoDialInterval
+    }))
+
+    if (init.relay != null) {
+      this.circuitService = this.configureComponent(init.relay(this.components))
+    }
+
     // Discovery modules
     for (const fn of init.peerDiscovery ?? []) {
       const service = this.configureComponent(fn(this.components))
@@ -260,6 +247,11 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
         this.onDiscoveryPeer(evt)
       })
     }
+
+    // Transport modules
+    init.transports.forEach((fn) => {
+      this.components.transportManager.add(this.configureComponent(fn(this.components)))
+    })
   }
 
   private configureComponent <T> (component: T): T {
@@ -273,7 +265,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
   /**
    * Starts the libp2p node and all its subsystems
    */
-  async start () {
+  async start (): Promise<void> {
     if (this.started) {
       return
     }
@@ -300,7 +292,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
 
       // start any startables
       await Promise.all(
-        this.services.map(async service => await service.start())
+        this.services.map(async service => { await service.start() })
       )
 
       await Promise.all(
@@ -322,7 +314,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
   /**
    * Stop the libp2p node by closing its listeners and open connections
    */
-  async stop () {
+  async stop (): Promise<void> {
     if (!this.started) {
       return
     }
@@ -340,7 +332,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     )
 
     await Promise.all(
-      this.services.map(async service => await service.stop())
+      this.services.map(async service => { await service.stop() })
     )
 
     await Promise.all(
@@ -354,7 +346,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     log('libp2p has stopped')
   }
 
-  isStarted () {
+  isStarted (): boolean {
     return this.started
   }
 
@@ -376,7 +368,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     return await this.components.connectionManager.openConnection(peer, options)
   }
 
-  async dialProtocol (peer: PeerId | Multiaddr, protocols: string | string[], options: AbortOptions = {}) {
+  async dialProtocol (peer: PeerId | Multiaddr, protocols: string | string[], options: AbortOptions = {}): Promise<Stream> {
     if (protocols == null) {
       throw errCode(new Error('no protocols were provided to open a stream'), codes.ERR_INVALID_PROTOCOLS_FOR_STREAM)
     }
@@ -495,7 +487,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     return await this.registrar.register(protocol, topology)
   }
 
-  unregister (id: string) {
+  unregister (id: string): void {
     this.registrar.unregister(id)
   }
 
@@ -503,7 +495,7 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
    * Called whenever peer discovery services emit `peer` events.
    * Known peers may be emitted.
    */
-  onDiscoveryPeer (evt: CustomEvent<PeerInfo>) {
+  onDiscoveryPeer (evt: CustomEvent<PeerInfo>): void {
     const { detail: peer } = evt
 
     if (peer.id.toString() === this.peerId.toString()) {
@@ -512,11 +504,11 @@ export class Libp2pNode extends EventEmitter<Libp2pEvents> implements Libp2p {
     }
 
     if (peer.multiaddrs.length > 0) {
-      void this.components.peerStore.addressBook.add(peer.id, peer.multiaddrs).catch(err => log.error(err))
+      void this.components.peerStore.addressBook.add(peer.id, peer.multiaddrs).catch(err => { log.error(err) })
     }
 
     if (peer.protocols.length > 0) {
-      void this.components.peerStore.protoBook.set(peer.id, peer.protocols).catch(err => log.error(err))
+      void this.components.peerStore.protoBook.set(peer.id, peer.protocols).catch(err => { log.error(err) })
     }
 
     this.dispatchEvent(new CustomEvent<PeerInfo>('peer:discovery', { detail: peer }))

package/src/nat-manager.ts

@@ -15,7 +15,7 @@ import type { AddressManager } from '@libp2p/interface-address-manager'
 const log = logger('libp2p:nat')
 const DEFAULT_TTL = 7200
 
-function highPort (min = 1024, max = 65535) {
+function highPort (min = 1024, max = 65535): number {
   return Math.floor(Math.random() * (max - min + 1) + min)
 }
 
@@ -98,18 +98,20 @@ export class NatManager implements Startable {
     }
   }
 
-  isStarted () {
+  isStarted (): boolean {
     return this.started
   }
 
-  start () {}
+  start (): void {
+    // #TODO: is there a way to remove this? Seems like a hack
+  }
 
   /**
    * Attempt to use uPnP to configure port mapping using the current gateway.
    *
    * Run after start to ensure the transport manager has all addresses configured.
    */
-  afterStart () {
+  afterStart (): void {
     if (isBrowser || !this.enabled || this.started) {
       return
     }
@@ -123,7 +125,7 @@ export class NatManager implements Startable {
     })
   }
 
-  async _start () {
+  async _start (): Promise<void> {
     const addrs = this.components.transportManager.getAddrs()
 
     for (const addr of addrs) {
@@ -178,7 +180,7 @@ export class NatManager implements Startable {
     }
   }
 
-  async _getClient () {
+  async _getClient (): Promise<NatAPI> {
     if (this.client != null) {
       return this.client
     }
@@ -196,7 +198,7 @@ export class NatManager implements Startable {
   /**
    * Stops the NAT manager
    */
-  async stop () {
+  async stop (): Promise<void> {
     if (isBrowser || this.client == null) {
       return
     }

package/src/peer-record-updater.ts

@@ -26,18 +26,18 @@ export class PeerRecordUpdater implements Startable {
     this.update = this.update.bind(this)
   }
 
-  isStarted () {
+  isStarted (): boolean {
     return this.started
   }
 
-  async start () {
+  async start (): Promise<void> {
     this.started = true
     this.components.transportManager.addEventListener('listener:listening', this.update)
     this.components.transportManager.addEventListener('listener:close', this.update)
     this.components.addressManager.addEventListener('change:addresses', this.update)
   }
 
-  async stop () {
+  async stop (): Promise<void> {
     this.started = false
     this.components.transportManager.removeEventListener('listener:listening', this.update)
     this.components.transportManager.removeEventListener('listener:close', this.update)
@@ -47,7 +47,7 @@ export class PeerRecordUpdater implements Startable {
   /**
    * Create (or update if existing) self peer record and store it in the AddressBook.
    */
-  update () {
+  update (): void {
     Promise.resolve()
       .then(async () => {
         const peerRecord = new PeerRecord({

package/src/peer-routing.ts

@@ -76,14 +76,14 @@ export class DefaultPeerRouting implements PeerRouting, Startable {
     this._findClosestPeersTask = this._findClosestPeersTask.bind(this)
   }
 
-  isStarted () {
+  isStarted (): boolean {
     return this.started
   }
 
   /**
    * Start peer routing service.
    */
-  async start () {
+  async start (): Promise<void> {
     if (this.started || this.routers.length === 0 || this.timeoutId != null || this.refreshManagerInit.enabled === false) {
       return
     }
@@ -98,7 +98,7 @@ export class DefaultPeerRouting implements PeerRouting, Startable {
   /**
    * Recurrent task to find closest peers and add their addresses to the Address Book.
    */
-  async _findClosestPeersTask () {
+  async _findClosestPeersTask (): Promise<void> {
     if (this.abortController != null) {
       // we are already running the query
       return
@@ -127,7 +127,7 @@ export class DefaultPeerRouting implements PeerRouting, Startable {
   /**
    * Stop peer routing service.
    */
-  async stop () {
+  async stop (): Promise<void> {
     clearDelayedInterval(this.timeoutId)
 
     // abort query if it is in-flight

package/src/ping/index.ts

@@ -47,7 +47,7 @@ export class PingService implements Startable {
     this.init = init
   }
 
-  async start () {
+  async start (): Promise<void> {
     await this.components.registrar.handle(this.protocol, this.handleMessage, {
       maxInboundStreams: this.init.maxInboundStreams,
       maxOutboundStreams: this.init.maxOutboundStreams
@@ -55,19 +55,19 @@ export class PingService implements Startable {
     this.started = true
   }
 
-  async stop () {
+  async stop (): Promise<void> {
     await this.components.registrar.unhandle(this.protocol)
     this.started = false
   }
 
-  isStarted () {
+  isStarted (): boolean {
     return this.started
   }
 
   /**
    * A handler to register with Libp2p to process ping messages
    */
-  handleMessage (data: IncomingStreamData) {
+  handleMessage (data: IncomingStreamData): void {
     const { stream } = data
 
     void pipe(stream, stream)

package/src/pnet/crypto.ts

@@ -11,7 +11,7 @@ const log = logger('libp2p:pnet')
 /**
  * Creates a stream iterable to encrypt messages in a private network
  */
-export function createBoxStream (nonce: Uint8Array, psk: Uint8Array) {
+export function createBoxStream (nonce: Uint8Array, psk: Uint8Array): (source: Source<Uint8Array>) => AsyncIterable<Uint8Array> {
   const xor = xsalsa20(nonce, psk)
 
   return (source: Source<Uint8Array>) => (async function * () {
@@ -38,7 +38,7 @@ export function createUnboxStream (nonce: Uint8Array, psk: Uint8Array) {
 /**
  * Decode the version 1 psk from the given Uint8Array
  */
-export function decodeV1PSK (pskBuffer: Uint8Array) {
+export function decodeV1PSK (pskBuffer: Uint8Array): { tag: string | undefined, codecName: string | undefined, psk: Uint8Array } {
   try {
     // This should pull from multibase/multicodec to allow for
     // more encoding flexibility. Ideally we'd consume the codecs
@@ -58,7 +58,7 @@ export function decodeV1PSK (pskBuffer: Uint8Array) {
     return {
       tag: pskTag,
       codecName: codec,
-      psk: psk
+      psk
     }
   } catch (err: any) {
     log.error(err)

package/src/pnet/key-generator.ts

@@ -8,7 +8,7 @@ import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
  * @param {Uint8Array | NodeJS.WriteStream} bytes - An object to write the psk into
  * @returns {void}
  */
-export function generateKey (bytes: Uint8Array | NodeJS.WriteStream) {
+export function generateKey (bytes: Uint8Array | NodeJS.WriteStream): void {
   const psk = uint8ArrayToString(randomBytes(KEY_LENGTH), 'base16')
   const key = uint8ArrayFromString('/key/swarm/psk/1.0.0/\n/base16/\n' + psk)
 

package/src/registrar.ts

@@ -44,14 +44,14 @@ export class DefaultRegistrar implements Registrar {
     this.components.peerStore.addEventListener('change:protocols', this._onProtocolChange)
   }
 
-  getProtocols () {
+  getProtocols (): string[] {
     return Array.from(new Set<string>([
       ...this.topologies.keys(),
       ...this.handlers.keys()
     ])).sort()
   }
 
-  getHandler (protocol: string) {
+  getHandler (protocol: string): StreamHandlerRecord {
     const handler = this.handlers.get(protocol)
 
     if (handler == null) {
@@ -61,7 +61,7 @@ export class DefaultRegistrar implements Registrar {
     return handler
   }
 
-  getTopologies (protocol: string) {
+  getTopologies (protocol: string): Topology[] {
     const topologies = this.topologies.get(protocol)
 
     if (topologies == null) {
@@ -99,7 +99,7 @@ export class DefaultRegistrar implements Registrar {
    * Removes the handler for each protocol. The protocol
    * will no longer be supported on streams.
    */
-  async unhandle (protocols: string | string[]) {
+  async unhandle (protocols: string | string[]): Promise<void> {
     const protocolList = Array.isArray(protocols) ? protocols : [protocols]
 
     protocolList.forEach(protocol => {
@@ -140,7 +140,7 @@ export class DefaultRegistrar implements Registrar {
   /**
    * Unregister topology
    */
-  unregister (id: string) {
+  unregister (id: string): void {
     for (const [protocol, topologies] of this.topologies.entries()) {
       if (topologies.has(id)) {
         topologies.delete(id)
@@ -155,7 +155,7 @@ export class DefaultRegistrar implements Registrar {
   /**
    * Remove a disconnected peer from the record
    */
-  _onDisconnect (evt: CustomEvent<Connection>) {
+  _onDisconnect (evt: CustomEvent<Connection>): void {
     const connection = evt.detail
 
     void this.components.peerStore.protoBook.get(connection.remotePeer)
@@ -182,7 +182,7 @@ export class DefaultRegistrar implements Registrar {
    * On peer connected if we already have their protocols. Usually used for reconnects
    * as change:protocols event won't be emitted due to identical protocols.
    */
-  _onConnect (evt: CustomEvent<Connection>) {
+  _onConnect (evt: CustomEvent<Connection>): void {
     const connection = evt.detail
 
     void this.components.peerStore.protoBook.get(connection.remotePeer)
@@ -208,7 +208,7 @@ export class DefaultRegistrar implements Registrar {
   /**
    * Check if a new peer support the multicodecs for this topology
    */
-  _onProtocolChange (evt: CustomEvent<PeerProtocolsChangeData>) {
+  _onProtocolChange (evt: CustomEvent<PeerProtocolsChangeData>): void {
     const { peerId, protocols, oldProtocols } = evt.detail
     const removed = oldProtocols.filter(protocol => !protocols.includes(protocol))
     const added = protocols.filter(protocol => !oldProtocols.includes(protocol))

package/src/transport-manager.ts

@@ -47,7 +47,7 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
   /**
    * Adds a `Transport` to the manager
    */
-  add (transport: Transport) {
+  add (transport: Transport): void {
     const tag = transport[Symbol.toStringTag]
 
     if (tag == null) {
@@ -55,7 +55,7 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
     }
 
     if (this.transports.has(tag)) {
-      throw errCode(new Error('There is already a transport with this tag'), codes.ERR_DUPLICATE_TRANSPORT)
+      throw errCode(new Error(`There is already a transport with the tag ${tag}`), codes.ERR_DUPLICATE_TRANSPORT)
     }
 
     log('adding transport %s', tag)
@@ -67,11 +67,11 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
     }
   }
 
-  isStarted () {
+  isStarted (): boolean {
     return this.started
   }
 
-  async start () {
+  async start (): Promise<void> {
     // Listen on the provided transports for the provided addresses
     const addrs = this.components.addressManager.getListenAddrs()
 
@@ -83,7 +83,7 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
   /**
    * Stops all listeners
    */
-  async stop () {
+  async stop (): Promise<void> {
     const tasks = []
     for (const [key, listeners] of this.listeners) {
       log('closing listeners for %s', key)
@@ -147,14 +147,14 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
   /**
    * Returns all the transports instances
    */
-  getTransports () {
+  getTransports (): Transport[] {
     return Array.of(...this.transports.values())
   }
 
   /**
    * Finds a transport that matches the given Multiaddr
    */
-  transportForMultiaddr (ma: Multiaddr) {
+  transportForMultiaddr (ma: Multiaddr): Transport | undefined {
     for (const transport of this.transports.values()) {
       const addrs = transport.filter([ma])
 
@@ -167,7 +167,7 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
   /**
    * Starts listeners for each listen Multiaddr
    */
-  async listen (addrs: Multiaddr[]) {
+  async listen (addrs: Multiaddr[]): Promise<void> {
     if (addrs == null || addrs.length === 0) {
       log('no addresses were provided for listening, this node is dial only')
       return
@@ -243,7 +243,7 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
    * Removes the given transport from the manager.
    * If a transport has any running listeners, they will be closed.
    */
-  async remove (key: string) {
+  async remove (key: string): Promise<void> {
     log('removing %s', key)
 
     // Close any running listeners
@@ -261,7 +261,7 @@ export class DefaultTransportManager extends EventEmitter<TransportManagerEvents
    *
    * @async
    */
-  async removeAll () {
+  async removeAll (): Promise<void> {
     const tasks = []
     for (const key of this.transports.keys()) {
       tasks.push(this.remove(key))