libp2p 0.44.0 → 0.45.0

package/src/circuit-relay/server/index.ts

@@ -24,7 +24,7 @@ import { ReservationVoucherRecord } from './reservation-voucher.js'
 import type { AddressManager } from '@libp2p/interface-address-manager'
 import type { ConnectionManager } from '@libp2p/interface-connection-manager'
 import type { CircuitRelayService, RelayReservation } from '../index.js'
-import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events'
+import { EventEmitter } from '@libp2p/interfaces/events'
 import { setMaxListeners } from 'events'
 import type { PeerMap } from '@libp2p/peer-collections'
 
@@ -128,7 +128,7 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
     if (init.advertise != null && init.advertise !== false) {
       this.advertService = new AdvertService(components, init.advertise === true ? undefined : init.advertise)
       this.advertService.addEventListener('advert:success', () => {
-        this.dispatchEvent(new CustomEvent('relay:advert:success'))
+        this.safeDispatchEvent('relay:advert:success', {})
       })
       this.advertService.addEventListener('advert:error', (evt) => {
         this.safeDispatchEvent('relay:advert:error', { detail: evt.detail })
@@ -260,7 +260,11 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
       // result.expire is non-null if `ReservationStore.reserve` returns with status == OK
       if (result.expire != null) {
         const ttl = (result.expire * 1000) - Date.now()
-        await this.peerStore.tagPeer(connection.remotePeer, RELAY_SOURCE_TAG, { value: 1, ttl })
+        await this.peerStore.merge(connection.remotePeer, {
+          tags: {
+            [RELAY_SOURCE_TAG]: { value: 1, ttl }
+          }
+        })
       }
 
       hopstr.write({
@@ -283,6 +287,10 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
     const addrs = []
 
     for (const relayAddr of this.addressManager.getAddresses()) {
+      if (relayAddr.toString().includes('/p2p-circuit')) {
+        continue
+      }
+
       addrs.push(relayAddr.bytes)
     }
 

package/src/circuit-relay/transport/discovery.ts

@@ -91,7 +91,7 @@ export class RelayDiscovery extends EventEmitter<RelayDiscoveryEvents> implement
     log('searching peer store for relays')
     const peers = (await this.peerStore.all())
       // filter by a list of peers supporting RELAY_V2_HOP and ones we are not listening on
-      .filter(({ id, protocols }) => protocols.includes(RELAY_V2_HOP_CODEC))
+      .filter(({ protocols }) => protocols.includes(RELAY_V2_HOP_CODEC))
       .sort(() => Math.random() - 0.5)
 
     for (const peer of peers) {
@@ -112,9 +112,11 @@ export class RelayDiscovery extends EventEmitter<RelayDiscoveryEvents> implement
           const peerId = provider.id
 
           found++
-          log('found relay peer %p in content routing', peerId)
-          await this.peerStore.addressBook.add(peerId, provider.multiaddrs)
+          await this.peerStore.merge(peerId, {
+            multiaddrs: provider.multiaddrs
+          })
 
+          log('found relay peer %p in content routing', peerId)
           this.safeDispatchEvent('relay:discover', { detail: peerId })
         }
       }

package/src/circuit-relay/transport/index.ts

@@ -23,6 +23,8 @@ import { CIRCUIT_PROTO_CODE, RELAY_V2_HOP_CODEC, RELAY_V2_STOP_CODEC } from '../
 import { RelayStoreInit, ReservationStore } from './reservation-store.js'
 import { RelayDiscovery, RelayDiscoveryComponents } from './discovery.js'
 import { CodeError } from '@libp2p/interfaces/errors'
+import type { EventEmitter } from '@libp2p/interfaces/events'
+import type { Libp2pEvents } from '@libp2p/interface-libp2p'
 
 const log = logger('libp2p:circuit-relay:transport')
 
@@ -49,6 +51,7 @@ export interface CircuitRelayTransportComponents extends RelayDiscoveryComponent
   addressManager: AddressManager
   contentRouting: ContentRouting
   connectionGater: ConnectionGater
+  events: EventEmitter<Libp2pEvents>
 }
 
 interface ConnectOptions {
@@ -165,7 +168,7 @@ class CircuitRelayTransport implements Transport {
     const destinationId = destinationAddr.getPeerId()
 
     if (relayId == null || destinationId == null) {
-      const errMsg = 'Circuit relay dial failed as addresses did not have peer id'
+      const errMsg = `Circuit relay dial to ${ma.toString()} failed as address did not have peer ids`
       log.error(errMsg)
       throw new CodeError(errMsg, codes.ERR_RELAYED_DIAL)
     }
@@ -178,7 +181,9 @@ class CircuitRelayTransport implements Transport {
     let relayConnection = relayConnections[0]
 
     if (relayConnection == null) {
-      await this.peerStore.addressBook.add(relayPeer, [relayAddr])
+      await this.peerStore.merge(relayPeer, {
+        multiaddrs: [relayAddr]
+      })
       relayConnection = await this.connectionManager.openConnection(relayPeer, options)
       disconnectOnFailure = true
     }
@@ -196,7 +201,7 @@ class CircuitRelayTransport implements Transport {
         disconnectOnFailure
       })
     } catch (err: any) {
-      log.error('Circuit relay dial failed', err)
+      log.error(`Circuit relay dial to destination ${destinationPeer.toString()} via relay ${relayPeer.toString()} failed`, err)
       disconnectOnFailure && await relayConnection.close()
       throw err
     }
@@ -237,7 +242,7 @@ class CircuitRelayTransport implements Transport {
       log('new outbound connection %s', maConn.remoteAddr)
       return await this.upgrader.upgradeOutbound(maConn)
     } catch (err) {
-      log.error('Circuit relay dial failed', err)
+      log.error(`Circuit relay dial to destination ${destinationPeer.toString()} via relay ${connection.remotePeer.toString()} failed`, err)
       disconnectOnFailure && await connection.close()
       throw err
     }

package/src/circuit-relay/transport/listener.ts

@@ -1,4 +1,4 @@
-import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events'
+import { EventEmitter } from '@libp2p/interfaces/events'
 import type { ConnectionManager } from '@libp2p/interface-connection-manager'
 import type { Listener, ListenerEvents } from '@libp2p/interface-transport'
 import type { Multiaddr } from '@multiformats/multiaddr'
@@ -7,6 +7,9 @@ import type { ReservationStore } from './reservation-store.js'
 import type { PeerId } from '@libp2p/interface-peer-id'
 import { PeerMap } from '@libp2p/peer-collections'
 import { logger } from '@libp2p/logger'
+import { peerIdFromString } from '@libp2p/peer-id'
+import type { Connection } from '@libp2p/interface-connection'
+import { CodeError } from '@libp2p/interfaces/errors'
 
 const log = logger('libp2p:circuit-relay:transport:listener')
 
@@ -18,7 +21,7 @@ export interface CircuitRelayTransportListenerComponents {
 class CircuitRelayTransportListener extends EventEmitter<ListenerEvents> implements Listener {
   private readonly connectionManager: ConnectionManager
   private readonly relayStore: ReservationStore
-  private readonly listeningAddrs: PeerMap<Multiaddr>
+  private readonly listeningAddrs: PeerMap<Multiaddr[]>
 
   constructor (components: CircuitRelayTransportListenerComponents) {
     super()
@@ -31,19 +34,30 @@ class CircuitRelayTransportListener extends EventEmitter<ListenerEvents> impleme
     this.relayStore.addEventListener('relay:removed', (evt) => {
       this.#removeRelayPeer(evt.detail)
     })
-
-    // remove listening addrs when a peer disconnects
-    this.connectionManager.addEventListener('peer:disconnect', (evt) => {
-      this.#removeRelayPeer(evt.detail.remotePeer)
-    })
   }
 
   async listen (addr: Multiaddr): Promise<void> {
     log('listen on %s', addr)
 
-    const addrString = addr.toString().split('/p2p-circuit').find(a => a !== '')
-    const ma = multiaddr(addrString)
-    const relayConn = await this.connectionManager.openConnection(ma)
+    const relayPeerStr = addr.getPeerId()
+    let relayConn: Connection | undefined
+
+    // check if we already have a connection to the relay
+    if (relayPeerStr != null) {
+      const relayPeer = peerIdFromString(relayPeerStr)
+      const connections = this.connectionManager.getConnectionsMap().get(relayPeer) ?? []
+
+      if (connections.length > 0) {
+        relayConn = connections[0]
+      }
+    }
+
+    // open a new connection as we don't already have one
+    if (relayConn == null) {
+      const addrString = addr.toString().split('/p2p-circuit').find(a => a !== '')
+      const ma = multiaddr(addrString)
+      relayConn = await this.connectionManager.openConnection(ma)
+    }
 
     if (!this.relayStore.hasReservation(relayConn.remotePeer)) {
       // addRelay calls transportManager.listen which calls this listen method
@@ -51,31 +65,27 @@ class CircuitRelayTransportListener extends EventEmitter<ListenerEvents> impleme
       return
     }
 
+    const reservation = this.relayStore.getReservation(relayConn.remotePeer)
+
+    if (reservation == null) {
+      throw new CodeError('Did not have reservation after making reservation', 'ERR_NO_RESERVATION')
+    }
+
     if (this.listeningAddrs.has(relayConn.remotePeer)) {
       log('already listening on relay %p', relayConn.remotePeer)
       return
     }
 
-    this.listeningAddrs.set(relayConn.remotePeer, addr)
-    this.dispatchEvent(new CustomEvent('listening'))
+    // add all addresses from the relay reservation
+    this.listeningAddrs.set(relayConn.remotePeer, reservation.addrs.map(buf => {
+      return multiaddr(buf).encapsulate('/p2p-circuit')
+    }))
+
+    this.safeDispatchEvent('listening', {})
   }
 
-  /**
-   * Get fixed up multiaddrs
-   *
-   * NOTE: This method will grab the peers multiaddrs and expand them such that:
-   *
-   * a) If it's an existing /p2p-circuit address for a specific relay i.e.
-   * `/ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit` this method will expand the
-   * address to `/ip4/0.0.0.0/tcp/0/ipfs/QmRelay/p2p-circuit/ipfs/QmPeer` where
-   * `QmPeer` is this peers id
-   * b) If it's not a /p2p-circuit address, it will encapsulate the address as a /p2p-circuit
-   * addr, such when dialing over a relay with this address, it will create the circuit using
-   * the encapsulated transport address. This is useful when for example, a peer should only
-   * be dialed over TCP rather than any other transport
-   */
   getAddrs (): Multiaddr[] {
-    return [...this.listeningAddrs.values()]
+    return [...this.listeningAddrs.values()].flat()
   }
 
   async close (): Promise<void> {
@@ -89,7 +99,7 @@ class CircuitRelayTransportListener extends EventEmitter<ListenerEvents> impleme
 
     if (had) {
       // Announce listen addresses change
-      this.dispatchEvent(new CustomEvent('close'))
+      this.safeDispatchEvent('close', {})
     }
   }
 }

package/src/circuit-relay/transport/reservation-store.ts

@@ -11,9 +11,10 @@ import { HopMessage, Status } from '../pb/index.js'
 import { getExpirationMilliseconds } from '../utils.js'
 import type { TransportManager } from '@libp2p/interface-transport'
 import type { Startable } from '@libp2p/interfaces/startable'
-import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events'
+import { EventEmitter } from '@libp2p/interfaces/events'
 import type { PeerStore } from '@libp2p/interface-peer-store'
 import { multiaddr } from '@multiformats/multiaddr'
+import type { Libp2pEvents } from '@libp2p/interface-libp2p'
 
 const log = logger('libp2p:circuit-relay:transport:reservation-store')
 
@@ -31,6 +32,7 @@ export interface RelayStoreComponents {
   connectionManager: ConnectionManager
   transportManager: TransportManager
   peerStore: PeerStore
+  events: EventEmitter<Libp2pEvents>
 }
 
 export interface RelayStoreInit {
@@ -68,6 +70,7 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
   private readonly connectionManager: ConnectionManager
   private readonly transportManager: TransportManager
   private readonly peerStore: PeerStore
+  private readonly events: EventEmitter<Libp2pEvents>
   private readonly reserveQueue: PQueue
   private readonly reservations: PeerMap<RelayEntry>
   private readonly maxDiscoveredRelays: number
@@ -80,6 +83,7 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
     this.connectionManager = components.connectionManager
     this.transportManager = components.transportManager
     this.peerStore = components.peerStore
+    this.events = components.events
     this.reservations = new PeerMap()
     this.maxDiscoveredRelays = init?.discoverRelays ?? 0
     this.started = false
@@ -92,8 +96,8 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
     // When a peer disconnects, if we had a reservation on that peer
     // remove the reservation and multiaddr and maybe trigger search
     // for new relays
-    this.connectionManager.addEventListener('peer:disconnect', (evt) => {
-      this.removeRelay(evt.detail.remotePeer)
+    this.events.addEventListener('peer:disconnect', (evt) => {
+      this.#removeRelay(evt.detail)
     })
   }
 
@@ -121,15 +125,15 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
    * on the remote peer
    */
   async addRelay (peerId: PeerId, type: RelayType): Promise<void> {
-    log('add relay', this.reserveQueue.size)
+    if (this.peerId.equals(peerId)) {
+      log('not trying to use self as relay')
+      return
+    }
+
+    log('add relay %p', peerId)
 
     await this.reserveQueue.add(async () => {
       try {
-        if (this.peerId.equals(peerId)) {
-          log('not trying to use self as relay')
-          return
-        }
-
         // allow refresh of an existing reservation if it is about to expire
         const existingReservation = this.reservations.get(peerId)
 
@@ -177,6 +181,7 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
           })
         }, timeoutDuration)
 
+        // we've managed to create a reservation successfully
         this.reservations.set(peerId, {
           timeout,
           reservation,
@@ -184,18 +189,22 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
         })
 
         // ensure we don't close the connection to the relay
-        await this.peerStore.tagPeer(peerId, RELAY_TAG, {
-          value: 1,
-          ttl: expiration
+        await this.peerStore.merge(peerId, {
+          tags: {
+            [RELAY_TAG]: {
+              value: 1,
+              ttl: expiration
+            }
+          }
         })
 
-        await this.transportManager.listen(
-          reservation.addrs.map(ma => {
-            return multiaddr(ma).encapsulate('/p2p-circuit')
-          })
-        )
+        // listen on multiaddr that only the circuit transport is listening for
+        await this.transportManager.listen([multiaddr(`/p2p/${peerId.toString()}/p2p-circuit`)])
       } catch (err) {
         log.error('could not reserve slot on %p', peerId, err)
+
+        // if listening failed, remove the reservation
+        this.reservations.delete(peerId)
       }
     })
   }
@@ -204,6 +213,10 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
     return this.reservations.has(peerId)
   }
 
+  getReservation (peerId: PeerId): Reservation | undefined {
+    return this.reservations.get(peerId)?.reservation
+  }
+
   async #createReservation (connection: Connection): Promise<Reservation> {
     log('requesting reservation from %s', connection.remotePeer)
     const stream = await connection.newStream(RELAY_V2_HOP_CODEC)
@@ -235,14 +248,14 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
   /**
    * Remove listen relay
    */
-  removeRelay (peerId: PeerId): void {
+  #removeRelay (peerId: PeerId): void {
     const existingReservation = this.reservations.get(peerId)
 
     if (existingReservation == null) {
       return
     }
 
-    log('removing relay %p', peerId)
+    log('connection to relay %p closed, removing reservation from local store', peerId)
 
     clearTimeout(existingReservation.timeout)
     this.reservations.delete(peerId)
@@ -250,7 +263,8 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
     this.safeDispatchEvent('relay:removed', { detail: peerId })
 
     if (this.reservations.size < this.maxDiscoveredRelays) {
-      this.dispatchEvent(new CustomEvent('relay:not-enough-relays'))
+      log('not enough relays %d/%d', this.reservations.size, this.maxDiscoveredRelays)
+      this.safeDispatchEvent('relay:not-enough-relays', {})
     }
   }
 }