logos-messaging-nim/tests/waku_core/test_peers.nim

{.used.}

import
  results,
  testutils/unittests,
  libp2p/multiaddress,
  libp2p/peerid,
  libp2p/errors,
  confutils/toml/std/net
import waku/[waku_core, waku_enr], ../testlib/wakucore

suite "Waku Core - Peers":
  test "Peer info parses correctly":
    ## Given
    let address =
      "/ip4/127.0.0.1/tcp/65002/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## When
    let remotePeerInfoRes = parsePeerInfo(address)
    require remotePeerInfoRes.isOk()

    let remotePeerInfo = remotePeerInfoRes.value

    ## Then
    check:
      $(remotePeerInfo.peerId) == "16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
      $(remotePeerInfo.addrs[0][0].tryGet()) == "/ip4/127.0.0.1"
      $(remotePeerInfo.addrs[0][1].tryGet()) == "/tcp/65002"

  test "DNS multiaddrs parsing - dns peer":
    ## Given
    let address =
      "/dns/localhost/tcp/65012/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## When
    let dnsPeerRes = parsePeerInfo(address)
    require dnsPeerRes.isOk()

    let dnsPeer = dnsPeerRes.value

    ## Then
    check:
      $(dnsPeer.peerId) == "16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
      $(dnsPeer.addrs[0][0].tryGet()) == "/dns/localhost"
      $(dnsPeer.addrs[0][1].tryGet()) == "/tcp/65012"

  test "DNS multiaddrs parsing - dnsaddr peer":
    ## Given
    let address =
      "/dnsaddr/localhost/tcp/65022/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## When
    let dnsAddrPeerRes = parsePeerInfo(address)
    require dnsAddrPeerRes.isOk()

    let dnsAddrPeer = dnsAddrPeerRes.value

    ## Then
    check:
      $(dnsAddrPeer.peerId) == "16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
      $(dnsAddrPeer.addrs[0][0].tryGet()) == "/dnsaddr/localhost"
      $(dnsAddrPeer.addrs[0][1].tryGet()) == "/tcp/65022"

  test "DNS multiaddrs parsing - dns4 peer":
    ## Given
    let address =
      "/dns4/localhost/tcp/65032/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## When
    let dns4PeerRes = parsePeerInfo(address)
    require dns4PeerRes.isOk()

    let dns4Peer = dns4PeerRes.value

    # Then
    check:
      $(dns4Peer.peerId) == "16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
      $(dns4Peer.addrs[0][0].tryGet()) == "/dns4/localhost"
      $(dns4Peer.addrs[0][1].tryGet()) == "/tcp/65032"

  test "DNS multiaddrs parsing - dns6 peer":
    ## Given
    let address =
      "/dns6/localhost/tcp/65042/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## When
    let dns6PeerRes = parsePeerInfo(address)
    require dns6PeerRes.isOk()

    let dns6Peer = dns6PeerRes.value

    ## Then
    check:
      $(dns6Peer.peerId) == "16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"
      $(dns6Peer.addrs[0][0].tryGet()) == "/dns6/localhost"
      $(dns6Peer.addrs[0][1].tryGet()) == "/tcp/65042"

  test "Multiaddr parsing should fail with invalid address":
    ## Given
    let address = "/p2p/$UCH GIBBER!SH"

    ## Then
    check:
      parsePeerInfo(address).isErr()

  test "Multiaddr parsing should fail with leading whitespace":
    ## Given
    let address =
      " /ip4/127.0.0.1/tcp/65062/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## Then
    check:
      parsePeerInfo(address).isErr()

  test "Multiaddr parsing should fail with trailing whitespace":
    ## Given
    let address =
      "/ip4/127.0.0.1/tcp/65072/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc "

    ## Then
    check:
      parsePeerInfo(address).isErr()

  test "Multiaddress parsing should fail with invalid IP address":
    ## Given
    let address =
      "/ip4/127.0.0.0.1/tcp/65082/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## Then
    check:
      parsePeerInfo(address).isErr()

  test "Multiaddress parsing should fail with no peer ID":
    ## Given
    let address = "/ip4/127.0.0.1/tcp/65092"

    # Then
    check:
      parsePeerInfo(address).isErr()

  test "Multiaddress parsing should fail with unsupported transport":
    ## Given
    let address =
      "/ip4/127.0.0.1/udp/65102/p2p/16Uuu2HBmAcHvhLqQKwSSbX6BG5JLWUDRcaLVrehUVqpw7fz1hbYc"

    ## Then
    check:
      parsePeerInfo(address).isErr()

  test "ENRs capabilities are filled when creating RemotePeerInfo":
    let
      enrSeqNum = 1u64
      enrPrivKey = generatesecp256k1key()

    ## When
    var builder = EnrBuilder.init(enrPrivKey, seqNum = enrSeqNum)
    builder.withIpAddressAndPorts(
      ipAddr = some(parseIpAddress("127.0.0.1")),
      tcpPort = some(Port(0)),
      udpPort = some(Port(0)),
    )
    builder.withWakuCapabilities(Capabilities.Relay, Capabilities.Store)

    let recordRes = builder.build()

    ## Then
    assert recordRes.isOk(), $recordRes.error
    let record = recordRes.tryGet()

    let remotePeerInfoRes = record.toRemotePeerInfo()
    assert remotePeerInfoRes.isOk(),
      "failed creating RemotePeerInfo: " & $remotePeerInfoRes.error()

    let remotePeerInfo = remotePeerInfoRes.get()

    check:
      remotePeerInfo.protocols.len == 2
      remotePeerInfo.protocols.contains(WakuRelayCodec)
      remotePeerInfo.protocols.contains(WakuStoreCodec)