fix: updated multiaddr logging (#1797)

Some logs are not particularly useful in debugging due to the formatting e.g.

```
libp2p:connection-manager:dial-queue dial to { bytes: [Object] } succeeded +709ms
```

Updated the logs given the changes in libp2p/js-libp2p-logger#36

Author: maschad

packages/libp2p/src/autonat/index.ts

@@ -258,7 +258,7 @@ class DefaultAutoNATService implements Startable {
             .filter(ma => {
               const isFromSameHost = ma.toOptions().host === data.connection.remoteAddr.toOptions().host
 
-              log.trace('request to dial %s was sent from %s is same host %s', ma, data.connection.remoteAddr, isFromSameHost)
+              log.trace('request to dial %a was sent from %a is same host %s', ma, data.connection.remoteAddr, isFromSameHost)
               // skip any Multiaddrs where the target node's IP does not match the sending node's IP
               return isFromSameHost
             })
@@ -281,7 +281,7 @@ class DefaultAutoNATService implements Startable {
             .filter(ma => {
               const isSupportedTransport = Boolean(self.components.transportManager.transportForMultiaddr(ma))
 
-              log.trace('transport for %s is supported %s', ma, isSupportedTransport)
+              log.trace('transport for %a is supported %s', ma, isSupportedTransport)
               // skip any Multiaddrs that have transports we do not support
               return isSupportedTransport
             })
@@ -324,7 +324,7 @@ class DefaultAutoNATService implements Startable {
               })
 
               if (!connection.remoteAddr.equals(multiaddr)) {
-                log.error('tried to dial %s but dialed %s', multiaddr, connection.remoteAddr)
+                log.error('tried to dial %a but dialed %a', multiaddr, connection.remoteAddr)
                 throw new Error('Unexpected remote address')
               }
 

packages/libp2p/src/circuit-relay/server/index.ts

@@ -193,7 +193,7 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
   }
 
   async onHop ({ connection, stream }: IncomingStreamData): Promise<void> {
-    log('received circuit v2 hop protocol stream from %s', connection.remotePeer)
+    log('received circuit v2 hop protocol stream from %p', connection.remotePeer)
 
     const hopTimeoutPromise = pDefer<HopMessage>()
     const timeout = setTimeout(() => {
@@ -239,15 +239,15 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
       case HopMessage.Type.RESERVE: await this.handleReserve({ stream, request, connection }); break
       case HopMessage.Type.CONNECT: await this.handleConnect({ stream, request, connection }); break
       default: {
-        log.error('invalid hop request type %s via peer %s', request.type, connection.remotePeer)
+        log.error('invalid hop request type %s via peer %p', request.type, connection.remotePeer)
         stream.pb(HopMessage).write({ type: HopMessage.Type.STATUS, status: Status.UNEXPECTED_MESSAGE })
       }
     }
   }
 
   async handleReserve ({ stream, request, connection }: HopProtocolOptions): Promise<void> {
     const hopstr = stream.pb(HopMessage)
-    log('hop reserve request from %s', connection.remotePeer)
+    log('hop reserve request from %p', connection.remotePeer)
 
     if (isRelayAddr(connection.remoteAddr)) {
       log.error('relay reservation over circuit connection denied for peer: %p', connection.remotePeer)
@@ -329,7 +329,7 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
       return
     }
 
-    log('hop connect request from %s', connection.remotePeer)
+    log('hop connect request from %p', connection.remotePeer)
 
     let dstPeer: PeerId
 
@@ -381,7 +381,7 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
     })
 
     if (destinationStream == null) {
-      log.error('failed to open stream to destination peer %s', destinationConnection?.remotePeer)
+      log.error('failed to open stream to destination peer %p', destinationConnection?.remotePeer)
       hopstr.write({ type: HopMessage.Type.STATUS, status: Status.CONNECTION_FAILED })
       return
     }
@@ -414,17 +414,17 @@ class CircuitRelayServer extends EventEmitter<RelayServerEvents> implements Star
     try {
       response = await stopstr.read()
     } catch (err) {
-      log.error('error parsing stop message response from %s', connection.remotePeer)
+      log.error('error parsing stop message response from %p', connection.remotePeer)
     }
 
     if (response == null) {
-      log.error('could not read response from %s', connection.remotePeer)
+      log.error('could not read response from %p', connection.remotePeer)
       stream.close()
       return
     }
 
     if (response.status === Status.OK) {
-      log('stop request to %s was successful', connection.remotePeer)
+      log('stop request to %p was successful', connection.remotePeer)
       return pbstr.unwrap()
     }
 

packages/libp2p/src/circuit-relay/transport/index.ts

@@ -266,7 +266,7 @@ class CircuitRelayTransport implements Transport {
         localAddr: relayAddr.encapsulate(`/p2p-circuit/p2p/${this.peerId.toString()}`)
       })
 
-      log('new outbound connection %s', maConn.remoteAddr)
+      log('new outbound connection %a', maConn.remoteAddr)
       return await this.upgrader.upgradeOutbound(maConn)
     } catch (err) {
       log.error(`Circuit relay dial to destination ${destinationPeer.toString()} via relay ${connection.remotePeer.toString()} failed`, err)
@@ -312,17 +312,17 @@ class CircuitRelayTransport implements Transport {
     }
 
     const stopstr = pbstr.pb(StopMessage)
-    log('new circuit relay v2 stop stream from %s', connection.remotePeer)
+    log('new circuit relay v2 stop stream from %p', connection.remotePeer)
 
     // Validate the STOP request has the required input
     if (request.type !== StopMessage.Type.CONNECT) {
-      log.error('invalid stop connect request via peer %s', connection.remotePeer)
+      log.error('invalid stop connect request via peer %p', connection.remotePeer)
       stopstr.write({ type: StopMessage.Type.STATUS, status: Status.UNEXPECTED_MESSAGE })
       return
     }
 
     if (!isValidStop(request)) {
-      log.error('invalid stop connect request via peer %s', connection.remotePeer)
+      log.error('invalid stop connect request via peer %p', connection.remotePeer)
       stopstr.write({ type: StopMessage.Type.STATUS, status: Status.MALFORMED_MESSAGE })
       return
     }
@@ -346,7 +346,7 @@ class CircuitRelayTransport implements Transport {
 
     log('new inbound connection %s', maConn.remoteAddr)
     await this.upgrader.upgradeInbound(maConn)
-    log('%s connection %s upgraded', 'inbound', maConn.remoteAddr)
+    log('%s connection %a upgraded', 'inbound', maConn.remoteAddr)
   }
 }
 

packages/libp2p/src/circuit-relay/transport/listener.ts

@@ -37,7 +37,7 @@ class CircuitRelayTransportListener extends EventEmitter<ListenerEvents> impleme
   }
 
   async listen (addr: Multiaddr): Promise<void> {
-    log('listen on %s', addr)
+    log('listen on %a', addr)
 
     const relayPeerStr = addr.getPeerId()
     let relayConn: Connection | undefined

packages/libp2p/src/circuit-relay/transport/reservation-store.ts

@@ -237,7 +237,7 @@ export class ReservationStore extends EventEmitter<ReservationStoreEvents> imple
   }
 
   async #createReservation (connection: Connection): Promise<Reservation> {
-    log('requesting reservation from %s', connection.remotePeer)
+    log('requesting reservation from %p', connection.remotePeer)
     const stream = await connection.newStream(RELAY_V2_HOP_CODEC)
     const pbstr = pbStream(stream)
     const hopstr = pbstr.pb(HopMessage)

packages/libp2p/src/connection-manager/dial-queue.ts

@@ -418,13 +418,13 @@ export class DialQueue {
         // let any signal abort the dial
         const signal = combineSignals(controller.signal, options.signal)
         signal.addEventListener('abort', () => {
-          log('dial to %s aborted', addr)
+          log('dial to %a aborted', addr)
         })
         const deferred = pDefer<Connection>()
 
         await peerDialQueue.add(async () => {
           if (signal.aborted) {
-            log('dial to %s was aborted before reaching the head of the peer dial queue', addr)
+            log('dial to %a was aborted before reaching the head of the peer dial queue', addr)
             deferred.reject(new AbortError())
             return
           }
@@ -433,7 +433,7 @@ export class DialQueue {
           await this.queue.add(async () => {
             try {
               if (signal.aborted) {
-                log('dial to %s was aborted before reaching the head of the dial queue', addr)
+                log('dial to %a was aborted before reaching the head of the dial queue', addr)
                 deferred.reject(new AbortError())
                 return
               }
@@ -468,13 +468,13 @@ export class DialQueue {
                 }
               })
 
-              log('dial to %s succeeded', addr)
+              log('dial to %a succeeded', addr)
 
               // resolve the connection promise
               deferred.resolve(conn)
             } catch (err: any) {
               // something only went wrong if our signal was not aborted
-              log.error('error during dial of %s', addr, err)
+              log.error('error during dial of %a', addr, err)
               deferred.reject(err)
             }
           }, {

packages/libp2p/src/connection-manager/index.ts

@@ -547,7 +547,7 @@ export class DefaultConnectionManager implements ConnectionManager, Startable {
     })
 
     if (denyConnection) {
-      log('connection from %s refused - connection remote address was in deny list', maConn.remoteAddr)
+      log('connection from %a refused - connection remote address was in deny list', maConn.remoteAddr)
       return false
     }
 
@@ -564,7 +564,7 @@ export class DefaultConnectionManager implements ConnectionManager, Startable {
 
     // check pending connections
     if (this.incomingPendingConnections === this.maxIncomingPendingConnections) {
-      log('connection from %s refused - incomingPendingConnections exceeded by peer %s', maConn.remoteAddr)
+      log('connection from %a refused - incomingPendingConnections exceeded by host', maConn.remoteAddr)
       return false
     }
 
@@ -574,7 +574,7 @@ export class DefaultConnectionManager implements ConnectionManager, Startable {
       try {
         await this.inboundConnectionRateLimiter.consume(host, 1)
       } catch {
-        log('connection from %s refused - inboundConnectionThreshold exceeded by host %s', host, maConn.remoteAddr)
+        log('connection from %a refused - inboundConnectionThreshold exceeded by host %s', maConn.remoteAddr, host)
         return false
       }
     }
@@ -585,7 +585,7 @@ export class DefaultConnectionManager implements ConnectionManager, Startable {
       return true
     }
 
-    log('connection from %s refused - maxConnections exceeded', maConn.remoteAddr)
+    log('connection from %a refused - maxConnections exceeded', maConn.remoteAddr)
     return false
   }
 

packages/libp2p/src/identify/identify.ts

@@ -322,11 +322,11 @@ export class DefaultIdentifyService implements Startable {
     const cleanObservedAddr = getCleanMultiaddr(observedAddr)
 
     log('identify completed for peer %p and protocols %o', id, protocols)
-    log('our observed address is %s', cleanObservedAddr)
+    log('our observed address is %a', cleanObservedAddr)
 
     if (cleanObservedAddr != null &&
         this.addressManager.getObservedAddrs().length < (this.maxObservedAddresses ?? Infinity)) {
-      log('storing our observed address %s', cleanObservedAddr?.toString())
+      log('storing our observed address %a', cleanObservedAddr)
       this.addressManager.addObservedAddr(cleanObservedAddr)
     }
 

packages/libp2p/src/transport-manager.ts

@@ -190,7 +190,7 @@ export class DefaultTransportManager implements TransportManager, Startable {
 
       // For each supported multiaddr, create a listener
       for (const addr of supportedAddrs) {
-        log('creating listener for %s on %s', key, addr)
+        log('creating listener for %s on %a', key, addr)
         const listener = transport.createListener({
           upgrader: this.components.upgrader
         })