@libp2p/interface-mocks/src/multiaddr-connection.ts

Mock implementations of several libp2p interfaces

import { multiaddr } from '@multiformats/multiaddr'
import { abortableSource } from 'abortable-iterator'
import { duplexPair } from 'it-pair/duplex'
import type { MultiaddrConnection } from '@libp2p/interface-connection'
import type { PeerId } from '@libp2p/interface-peer-id'
import type { Multiaddr } from '@multiformats/multiaddr'
import type { Duplex } from 'it-stream-types'

export function mockMultiaddrConnection (source: Duplex<AsyncGenerator<Uint8Array>> & Partial<MultiaddrConnection>, peerId: PeerId): MultiaddrConnection {
  const maConn: MultiaddrConnection = {
    async close () {

    },
    timeline: {
      open: Date.now()
    },
    remoteAddr: multiaddr(`/ip4/127.0.0.1/tcp/4001/p2p/${peerId.toString()}`),
    ...source
  }

  return maConn
}

export interface MockMultiaddrConnPairOptions {
  addrs: Multiaddr[]
  remotePeer: PeerId
}

/**
 * Returns both sides of a mocked MultiaddrConnection
 */
export function mockMultiaddrConnPair (opts: MockMultiaddrConnPairOptions): { inbound: MultiaddrConnection, outbound: MultiaddrConnection } {
  const { addrs, remotePeer } = opts
  const controller = new AbortController()
  const [localAddr, remoteAddr] = addrs
  const [inboundStream, outboundStream] = duplexPair<Uint8Array>()

  const outbound: MultiaddrConnection = {
    ...outboundStream,
    remoteAddr: remoteAddr.toString().includes(`/p2p/${remotePeer.toString()}`) ? remoteAddr : remoteAddr.encapsulate(`/p2p/${remotePeer.toString()}`),
    timeline: {
      open: Date.now()
    },
    close: async () => {
      outbound.timeline.close = Date.now()
      controller.abort()
    }
  }

  const inbound: MultiaddrConnection = {
    ...inboundStream,
    remoteAddr: localAddr,
    timeline: {
      open: Date.now()
    },
    close: async () => {
      inbound.timeline.close = Date.now()
      controller.abort()
    }
  }

  // Make the sources abortable so we can close them easily
  inbound.source = abortableSource(inbound.source, controller.signal)
  outbound.source = abortableSource(outbound.source, controller.signal)

  return { inbound, outbound }
}