@libp2p/webrtc 1.2.0 → 2.0.0

package/src/maconn.ts

@@ -64,6 +64,12 @@ export class WebRTCMultiaddrConnection implements MultiaddrConnection {
     this.remoteAddr = init.remoteAddr
     this.timeline = init.timeline
     this.peerConnection = init.peerConnection
+
+    this.peerConnection.onconnectionstatechange = () => {
+      if (this.peerConnection.connectionState === 'closed' || this.peerConnection.connectionState === 'disconnected' || this.peerConnection.connectionState === 'failed') {
+        this.timeline.close = Date.now()
+      }
+    }
   }
 
   async close (err?: Error | undefined): Promise<void> {

package/src/peer_transport/handler.ts

@@ -15,7 +15,7 @@ const log = logger('libp2p:webrtc:peer')
 
 export type IncomingStreamOpts = { rtcConfiguration?: RTCConfiguration } & IncomingStreamData
 
-export async function handleIncomingStream ({ rtcConfiguration, stream: rawStream }: IncomingStreamOpts): Promise<[RTCPeerConnection, StreamMuxerFactory]> {
+export async function handleIncomingStream ({ rtcConfiguration, stream: rawStream }: IncomingStreamOpts): Promise<{ pc: RTCPeerConnection, muxerFactory: StreamMuxerFactory, remoteAddress: string }> {
   const signal = AbortSignal.timeout(DEFAULT_TIMEOUT)
   const stream = pbStream(abortableDuplex(rawStream, signal)).pb(pb.Message)
   const pc = new RTCPeerConnection(rtcConfiguration)
@@ -76,7 +76,10 @@ export async function handleIncomingStream ({ rtcConfiguration, stream: rawStrea
 
   // wait until candidates are connected
   await readCandidatesUntilConnected(connectedPromise, pc, stream)
-  return [pc, muxerFactory]
+
+  const remoteAddress = parseRemoteAddress(pc.currentRemoteDescription?.sdp ?? '')
+
+  return { pc, muxerFactory, remoteAddress }
 }
 
 export interface ConnectOptions {
@@ -85,9 +88,8 @@ export interface ConnectOptions {
   rtcConfiguration?: RTCConfiguration
 }
 
-export async function initiateConnection ({ rtcConfiguration, signal, stream: rawStream }: ConnectOptions): Promise<[RTCPeerConnection, StreamMuxerFactory]> {
+export async function initiateConnection ({ rtcConfiguration, signal, stream: rawStream }: ConnectOptions): Promise<{ pc: RTCPeerConnection, muxerFactory: StreamMuxerFactory, remoteAddress: string }> {
   const stream = pbStream(abortableDuplex(rawStream, signal)).pb(pb.Message)
-
   // setup peer connection
   const pc = new RTCPeerConnection(rtcConfiguration)
   const muxerFactory = new DataChannelMuxerFactory(pc)
@@ -133,5 +135,21 @@ export async function initiateConnection ({ rtcConfiguration, signal, stream: ra
 
   await readCandidatesUntilConnected(connectedPromise, pc, stream)
   channel.close()
-  return [pc, muxerFactory]
+
+  const remoteAddress = parseRemoteAddress(pc.currentRemoteDescription?.sdp ?? '')
+
+  return { pc, muxerFactory, remoteAddress }
+}
+
+function parseRemoteAddress (sdp: string): string {
+  // 'a=candidate:1746876089 1 udp 2113937151 0614fbad-b...ocal 54882 typ host generation 0 network-cost 999'
+  const candidateLine = sdp.split('\r\n').filter(line => line.startsWith('a=candidate')).pop()
+  const candidateParts = candidateLine?.split(' ')
+
+  if (candidateLine == null || candidateParts == null || candidateParts.length < 5) {
+    log('could not parse remote address from', candidateLine)
+    return '/webrtc'
+  }
+
+  return `/dnsaddr/${candidateParts[4]}/${candidateParts[2]}/${candidateParts[3]}/webrtc`
 }

package/src/peer_transport/listener.ts

@@ -1,44 +1,55 @@
 import { EventEmitter } from '@libp2p/interfaces/events'
-import { multiaddr, type Multiaddr } from '@multiformats/multiaddr'
-import { inappropriateMultiaddr } from '../error.js'
-import { TRANSPORT } from './transport.js'
+import type { Libp2pEvents } from '@libp2p/interface-libp2p'
 import type { PeerId } from '@libp2p/interface-peer-id'
-import type { ListenerEvents, TransportManager, Upgrader, Listener } from '@libp2p/interface-transport'
+import type { ListenerEvents, Listener } from '@libp2p/interface-transport'
+import type { Multiaddr } from '@multiformats/multiaddr'
 
 export interface ListenerOptions {
   peerId: PeerId
-  upgrader: Upgrader
-  transportManager: TransportManager
+  events: EventEmitter<Libp2pEvents>
 }
 
 export class WebRTCPeerListener extends EventEmitter<ListenerEvents> implements Listener {
-  constructor (
-    private readonly opts: ListenerOptions
-  ) {
+  private readonly peerId: PeerId
+  private listeners: Listener[] = []
+
+  constructor (opts: ListenerOptions) {
     super()
-  }
 
-  private getBaseAddress (ma: Multiaddr): Multiaddr {
-    const addrs = ma.toString().split(TRANSPORT)
-    if (addrs.length < 2) {
-      throw inappropriateMultiaddr('base address not found')
-    }
-    return multiaddr(addrs[0])
+    this.peerId = opts.peerId
+
+    opts.events.addEventListener('transport:listening', (event) => {
+      const listener = event.detail
+
+      if (listener === this || this.listeners.includes(listener)) {
+        return
+      }
+
+      this.listeners.push(listener)
+    })
+
+    opts.events.addEventListener('transport:close', (event) => {
+      const listener = event.detail
+
+      this.listeners = this.listeners.filter(l => l !== listener)
+    })
   }
 
-  private listeningAddrs: Multiaddr[] = []
   async listen (ma: Multiaddr): Promise<void> {
-    const baseAddr = this.getBaseAddress(ma)
-    const tpt = this.opts.transportManager.transportForMultiaddr(baseAddr)
-    const listener = tpt?.createListener({ ...this.opts })
-    await listener?.listen(baseAddr)
-    const listeningAddr = ma.encapsulate(`/p2p/${this.opts.peerId.toString()}`)
-    this.listeningAddrs.push(listeningAddr)
-    listener?.addEventListener('close', () => {
-      this.listeningAddrs = this.listeningAddrs.filter(a => a !== listeningAddr)
-    })
+    this.safeDispatchEvent('listening', {})
   }
 
-  getAddrs (): Multiaddr[] { return this.listeningAddrs }
-  async close (): Promise<void> { }
+  getAddrs (): Multiaddr[] {
+    return this.listeners
+      .map(l => l.getAddrs()
+        .map(ma => {
+          return ma.encapsulate(`/webrtc/p2p/${this.peerId}`)
+        })
+      )
+      .flat()
+  }
+
+  async close (): Promise<void> {
+    this.safeDispatchEvent('close', {})
+  }
 }

package/src/peer_transport/transport.ts

@@ -1,4 +1,4 @@
-import { type CreateListenerOptions, type DialOptions, type Listener, symbol, type Transport, type TransportManager, type Upgrader } from '@libp2p/interface-transport'
+import { type CreateListenerOptions, type DialOptions, type Listener, symbol, type Transport, type Upgrader, type TransportManager } from '@libp2p/interface-transport'
 import { CodeError } from '@libp2p/interfaces/errors'
 import { logger } from '@libp2p/logger'
 import { peerIdFromString } from '@libp2p/peer-id'
@@ -8,16 +8,18 @@ import { WebRTCMultiaddrConnection } from '../maconn.js'
 import { initiateConnection, handleIncomingStream } from './handler.js'
 import { WebRTCPeerListener } from './listener.js'
 import type { Connection } from '@libp2p/interface-connection'
+import type { Libp2pEvents } from '@libp2p/interface-libp2p'
 import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerStore } from '@libp2p/interface-peer-store'
 import type { IncomingStreamData, Registrar } from '@libp2p/interface-registrar'
+import type { EventEmitter } from '@libp2p/interfaces/events'
 import type { Startable } from '@libp2p/interfaces/startable'
 
 const log = logger('libp2p:webrtc:peer')
 
-export const TRANSPORT = '/webrtc'
-export const SIGNALING_PROTO_ID = '/webrtc-signaling/0.0.1'
-export const CODE = protocols('webrtc').code
+const WEBRTC_TRANSPORT = '/webrtc'
+const CIRCUIT_RELAY_TRANSPORT = '/p2p-circuit'
+const SIGNALING_PROTO_ID = '/webrtc-signaling/0.0.1'
+const WEBRTC_CODE = protocols('webrtc').code
 
 export interface WebRTCTransportInit {
   rtcConfiguration?: RTCConfiguration
@@ -28,7 +30,7 @@ export interface WebRTCTransportComponents {
   registrar: Registrar
   upgrader: Upgrader
   transportManager: TransportManager
-  peerStore: PeerStore
+  events: EventEmitter<Libp2pEvents>
 }
 
 export class WebRTCTransport implements Transport, Startable {
@@ -67,22 +69,27 @@ export class WebRTCTransport implements Transport, Startable {
   filter (multiaddrs: Multiaddr[]): Multiaddr[] {
     return multiaddrs.filter((ma) => {
       const codes = ma.protoCodes()
-      return codes.includes(CODE)
+      return codes.includes(WEBRTC_CODE)
     })
   }
 
   private splitAddr (ma: Multiaddr): { baseAddr: Multiaddr, peerId: PeerId } {
-    const addrs = ma.toString().split(`${TRANSPORT}/`)
+    const addrs = ma.toString().split(WEBRTC_TRANSPORT)
     if (addrs.length !== 2) {
-      throw new CodeError('invalid multiaddr', codes.ERR_INVALID_MULTIADDR)
+      throw new CodeError('webrtc protocol was not present in multiaddr', codes.ERR_INVALID_MULTIADDR)
+    }
+
+    if (!addrs[0].includes(CIRCUIT_RELAY_TRANSPORT)) {
+      throw new CodeError('p2p-circuit protocol was not present in multiaddr', codes.ERR_INVALID_MULTIADDR)
     }
+
     // look for remote peerId
     let remoteAddr = multiaddr(addrs[0])
-    const destination = multiaddr('/' + addrs[1])
+    const destination = multiaddr(addrs[1])
 
     const destinationIdString = destination.getPeerId()
     if (destinationIdString == null) {
-      throw new CodeError('bad destination', codes.ERR_INVALID_MULTIADDR)
+      throw new CodeError('destination peer id was missing', codes.ERR_INVALID_MULTIADDR)
     }
 
     const lastProtoInRemote = remoteAddr.protos().pop()
@@ -112,22 +119,21 @@ export class WebRTCTransport implements Transport, Startable {
       options.signal = controller.signal
     }
 
-    const connection = await this.components.transportManager.dial(baseAddr)
-
-    const rawStream = await connection.newStream([SIGNALING_PROTO_ID], options)
+    const connection = await this.components.transportManager.dial(baseAddr, options)
+    const signalingStream = await connection.newStream([SIGNALING_PROTO_ID], options)
 
     try {
-      const [pc, muxerFactory] = await initiateConnection({
-        stream: rawStream,
+      const { pc, muxerFactory, remoteAddress } = await initiateConnection({
+        stream: signalingStream,
         rtcConfiguration: this.init.rtcConfiguration,
         signal: options.signal
       })
-      const webrtcMultiaddr = baseAddr.encapsulate(`${TRANSPORT}/p2p/${peerId.toString()}`)
+
       const result = await options.upgrader.upgradeOutbound(
         new WebRTCMultiaddrConnection({
           peerConnection: pc,
           timeline: { open: Date.now() },
-          remoteAddr: webrtcMultiaddr
+          remoteAddr: multiaddr(remoteAddress).encapsulate(`/p2p/${peerId.toString()}`)
         }),
         {
           skipProtection: true,
@@ -137,28 +143,27 @@ export class WebRTCTransport implements Transport, Startable {
       )
 
       // close the stream if SDP has been exchanged successfully
-      rawStream.close()
+      signalingStream.close()
       return result
     } catch (err) {
       // reset the stream in case of any error
-      rawStream.reset()
+      signalingStream.reset()
       throw err
     }
   }
 
   async _onProtocol ({ connection, stream }: IncomingStreamData): Promise<void> {
     try {
-      const [pc, muxerFactory] = await handleIncomingStream({
+      const { pc, muxerFactory, remoteAddress } = await handleIncomingStream({
         rtcConfiguration: this.init.rtcConfiguration,
         connection,
         stream
       })
-      const remotePeerId = connection.remoteAddr.getPeerId()
-      const webrtcMultiaddr = connection.remoteAddr.encapsulate(`${TRANSPORT}/p2p/${remotePeerId}`)
+
       await this.components.upgrader.upgradeInbound(new WebRTCMultiaddrConnection({
         peerConnection: pc,
         timeline: { open: (new Date()).getTime() },
-        remoteAddr: webrtcMultiaddr
+        remoteAddr: multiaddr(remoteAddress).encapsulate(`/p2p/${connection.remotePeer.toString()}`)
       }), {
         skipEncryption: true,
         skipProtection: true,

package/src/peer_transport/util.ts

@@ -53,7 +53,7 @@ export function resolveOnConnected (pc: RTCPeerConnection, promise: DeferredProm
       case 'failed':
       case 'disconnected':
       case 'closed':
-        promise.reject()
+        promise.reject(new Error('RTCPeerConnection was closed'))
         break
       default:
         break

package/src/stream.ts

@@ -268,7 +268,7 @@ export class WebRTCStream implements Stream {
     // surface data from the `Message.message` field through a source.
     this._src = pipe(
       this._innersrc,
-      lengthPrefixed.decode(),
+      (source) => lengthPrefixed.decode(source),
       (source) => (async function * () {
         for await (const buf of source) {
           const message = self.processIncomingProtobuf(buf.subarray())

package/src/transport.ts

@@ -189,15 +189,13 @@ export class WebRTCDirectTransport implements Transport {
     const wrappedDuplex = {
       ...wrappedChannel,
       sink: wrappedChannel.sink.bind(wrappedChannel),
-      source: {
-        [Symbol.asyncIterator]: async function * () {
-          for await (const list of wrappedChannel.source) {
-            for (const buf of list) {
-              yield buf
-            }
+      source: (async function * () {
+        for await (const list of wrappedChannel.source) {
+          for (const buf of list) {
+            yield buf
           }
         }
-      }
+      }())
     }
 
     // Creating the connection before completion of the noise