@libp2p/interop 5.0.0 → 6.0.0

package/src/relay/index.ts

@@ -0,0 +1,76 @@
+import { Multiaddr, multiaddr } from '@multiformats/multiaddr'
+import { expect } from 'aegir/chai'
+import type { Daemon, DaemonFactory, NodeType, SpawnOptions } from '../index.js'
+import { Status } from './pb/index.js'
+import { echoHandler, reserve } from './util.js'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import type { IdentifyResult } from '@libp2p/daemon-client'
+import { handshake } from 'it-handshake'
+
+export function relayTests (factory: DaemonFactory): void {
+  const t: NodeType[] = ['go', 'js']
+  t.forEach(a => { t.forEach(b => { t.forEach(r => { relayTest(factory, a, b, r) }) }) })
+}
+
+function relayTest (factory: DaemonFactory, aType: NodeType, bType: NodeType, relayType: NodeType): void {
+  describe(`${aType} to ${bType} over relay ${relayType}`, () => {
+    const opts: SpawnOptions[] = [
+      { type: aType, noise: true, noListen: true },
+      { type: bType, noise: true, noListen: true },
+      { type: relayType, noise: true, relay: true }
+    ]
+
+    let aNode: Daemon
+    let bNode: Daemon
+    let relay: Daemon
+    let bId: IdentifyResult
+    let relayId: IdentifyResult
+    let bAddrViaRelay: Multiaddr
+
+    beforeEach(async function () {
+      this.timeout(20 * 1000)
+      ;[aNode, bNode, relay] = await Promise.all(opts.map(async o => await factory.spawn(o)))
+      ;[bId, relayId] = await Promise.all([bNode, relay].map(async d => await d.client.identify()))
+
+      // construct a relay address
+      bAddrViaRelay = multiaddr(`${relayId.addrs[0].toString()}/p2p/${relayId.peerId.toString()}/p2p-circuit/p2p/${bId.peerId.toString()}`)
+
+      // connect b to the relay
+      await bNode.client.connect(relayId.peerId, relayId.addrs)
+    })
+
+    afterEach(async function () {
+      await Promise.all([aNode, bNode, relay].map(async d => { await d.stop() }))
+    })
+
+    it('connects', async () => {
+      // b makes reservation on relay
+      const reserveResponse = await reserve(bNode, relayId.peerId)
+      expect(reserveResponse.status).to.eq(Status.OK)
+
+      // a dials b through relay
+      await aNode.client.connect(bId.peerId, [bAddrViaRelay])
+      await new Promise(resolve => setTimeout(resolve, 500))
+      const connectedPeers = await aNode.client.listPeers()
+      expect(connectedPeers.filter(p => p.equals(bId.peerId))).to.have.length(1)
+
+      // run an echo test
+      await bNode.client.registerStreamHandler(echoHandler.protocol, echoHandler.handler)
+      const stream = await aNode.client.openStream(bId.peerId, echoHandler.protocol)
+
+      // send some data, read the response
+      const input = uint8ArrayFromString('test')
+      const shake = handshake(stream)
+      shake.write(input)
+      const output = await shake.read()
+
+      expect(output?.subarray()).to.deep.equal(input)
+    })
+
+    it('fails to connect without a reservation', async () => {
+      // a dials b through relay
+      await expect(aNode.client.connect(bId.peerId, [bAddrViaRelay])).to.eventually.be.rejected
+        .with.property('message').that.matches(/NO_RESERVATION/)
+    })
+  })
+}

package/src/relay/pb/index.proto

@@ -0,0 +1,67 @@
+syntax = "proto3";
+
+message HopMessage {
+  enum Type {
+    RESERVE = 0;
+    CONNECT = 1;
+    STATUS = 2;
+  }
+
+  // the presence of this field is enforced at application level
+  optional Type type = 1;
+
+  optional Peer peer = 2;
+  optional Reservation reservation = 3;
+  optional Limit limit = 4;
+
+  optional Status status = 5;
+}
+
+message StopMessage {
+  enum Type {
+    CONNECT = 0;
+    STATUS = 1;
+  }
+
+  // the presence of this field is enforced at application level
+  optional Type type = 1;
+
+  optional Peer peer = 2;
+  optional Limit limit = 3;
+
+  optional Status status = 4;
+}
+
+message Peer {
+  bytes id = 1;
+  repeated bytes addrs = 2;
+}
+
+message Reservation {
+  uint64 expire = 1; // Unix expiration time (UTC)
+  repeated bytes addrs = 2;   // relay addrs for reserving peer
+  optional bytes voucher = 3; // reservation voucher
+}
+
+message Limit {
+  optional uint32 duration = 1; // seconds
+  optional uint64 data = 2;     // bytes
+}
+
+enum Status {
+  UNUSED = 0;
+  OK                      = 100;
+  RESERVATION_REFUSED     = 200;
+  RESOURCE_LIMIT_EXCEEDED = 201;
+  PERMISSION_DENIED       = 202;
+  CONNECTION_FAILED       = 203;
+  NO_RESERVATION          = 204;
+  MALFORMED_MESSAGE       = 400;
+  UNEXPECTED_MESSAGE      = 401;
+}
+
+message ReservationVoucher {
+  bytes relay = 1;
+  bytes peer = 2;
+  uint64 expiration = 3;
+}

package/src/relay/pb/index.ts

@@ -0,0 +1,549 @@
+/* eslint-disable import/export */
+/* eslint-disable complexity */
+/* eslint-disable @typescript-eslint/no-namespace */
+/* eslint-disable @typescript-eslint/no-unnecessary-boolean-literal-compare */
+/* eslint-disable @typescript-eslint/no-empty-interface */
+
+import { enumeration, encodeMessage, decodeMessage, message } from 'protons-runtime'
+import type { Uint8ArrayList } from 'uint8arraylist'
+import type { Codec } from 'protons-runtime'
+
+export interface HopMessage {
+  type?: HopMessage.Type
+  peer?: Peer
+  reservation?: Reservation
+  limit?: Limit
+  status?: Status
+}
+
+export namespace HopMessage {
+  export enum Type {
+    RESERVE = 'RESERVE',
+    CONNECT = 'CONNECT',
+    STATUS = 'STATUS'
+  }
+
+  enum __TypeValues {
+    RESERVE = 0,
+    CONNECT = 1,
+    STATUS = 2
+  }
+
+  export namespace Type {
+    export const codec = (): Codec<Type> => {
+      return enumeration<Type>(__TypeValues)
+    }
+  }
+
+  let _codec: Codec<HopMessage>
+
+  export const codec = (): Codec<HopMessage> => {
+    if (_codec == null) {
+      _codec = message<HopMessage>((obj, w, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          w.fork()
+        }
+
+        if (obj.type != null) {
+          w.uint32(8)
+          HopMessage.Type.codec().encode(obj.type, w)
+        }
+
+        if (obj.peer != null) {
+          w.uint32(18)
+          Peer.codec().encode(obj.peer, w, {
+            writeDefaults: false
+          })
+        }
+
+        if (obj.reservation != null) {
+          w.uint32(26)
+          Reservation.codec().encode(obj.reservation, w, {
+            writeDefaults: false
+          })
+        }
+
+        if (obj.limit != null) {
+          w.uint32(34)
+          Limit.codec().encode(obj.limit, w, {
+            writeDefaults: false
+          })
+        }
+
+        if (obj.status != null) {
+          w.uint32(40)
+          Status.codec().encode(obj.status, w)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          w.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {}
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.type = HopMessage.Type.codec().decode(reader)
+              break
+            case 2:
+              obj.peer = Peer.codec().decode(reader, reader.uint32())
+              break
+            case 3:
+              obj.reservation = Reservation.codec().decode(reader, reader.uint32())
+              break
+            case 4:
+              obj.limit = Limit.codec().decode(reader, reader.uint32())
+              break
+            case 5:
+              obj.status = Status.codec().decode(reader)
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
+  }
+
+  export const encode = (obj: HopMessage): Uint8Array => {
+    return encodeMessage(obj, HopMessage.codec())
+  }
+
+  export const decode = (buf: Uint8Array | Uint8ArrayList): HopMessage => {
+    return decodeMessage(buf, HopMessage.codec())
+  }
+}
+
+export interface StopMessage {
+  type?: StopMessage.Type
+  peer?: Peer
+  limit?: Limit
+  status?: Status
+}
+
+export namespace StopMessage {
+  export enum Type {
+    CONNECT = 'CONNECT',
+    STATUS = 'STATUS'
+  }
+
+  enum __TypeValues {
+    CONNECT = 0,
+    STATUS = 1
+  }
+
+  export namespace Type {
+    export const codec = (): Codec<Type> => {
+      return enumeration<Type>(__TypeValues)
+    }
+  }
+
+  let _codec: Codec<StopMessage>
+
+  export const codec = (): Codec<StopMessage> => {
+    if (_codec == null) {
+      _codec = message<StopMessage>((obj, w, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          w.fork()
+        }
+
+        if (obj.type != null) {
+          w.uint32(8)
+          StopMessage.Type.codec().encode(obj.type, w)
+        }
+
+        if (obj.peer != null) {
+          w.uint32(18)
+          Peer.codec().encode(obj.peer, w, {
+            writeDefaults: false
+          })
+        }
+
+        if (obj.limit != null) {
+          w.uint32(26)
+          Limit.codec().encode(obj.limit, w, {
+            writeDefaults: false
+          })
+        }
+
+        if (obj.status != null) {
+          w.uint32(32)
+          Status.codec().encode(obj.status, w)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          w.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {}
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.type = StopMessage.Type.codec().decode(reader)
+              break
+            case 2:
+              obj.peer = Peer.codec().decode(reader, reader.uint32())
+              break
+            case 3:
+              obj.limit = Limit.codec().decode(reader, reader.uint32())
+              break
+            case 4:
+              obj.status = Status.codec().decode(reader)
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
+  }
+
+  export const encode = (obj: StopMessage): Uint8Array => {
+    return encodeMessage(obj, StopMessage.codec())
+  }
+
+  export const decode = (buf: Uint8Array | Uint8ArrayList): StopMessage => {
+    return decodeMessage(buf, StopMessage.codec())
+  }
+}
+
+export interface Peer {
+  id: Uint8Array
+  addrs: Uint8Array[]
+}
+
+export namespace Peer {
+  let _codec: Codec<Peer>
+
+  export const codec = (): Codec<Peer> => {
+    if (_codec == null) {
+      _codec = message<Peer>((obj, w, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          w.fork()
+        }
+
+        if (opts.writeDefaults === true || (obj.id != null && obj.id.byteLength > 0)) {
+          w.uint32(10)
+          w.bytes(obj.id)
+        }
+
+        if (obj.addrs != null) {
+          for (const value of obj.addrs) {
+            w.uint32(18)
+            w.bytes(value)
+          }
+        }
+
+        if (opts.lengthDelimited !== false) {
+          w.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {
+          id: new Uint8Array(0),
+          addrs: []
+        }
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.id = reader.bytes()
+              break
+            case 2:
+              obj.addrs.push(reader.bytes())
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
+  }
+
+  export const encode = (obj: Peer): Uint8Array => {
+    return encodeMessage(obj, Peer.codec())
+  }
+
+  export const decode = (buf: Uint8Array | Uint8ArrayList): Peer => {
+    return decodeMessage(buf, Peer.codec())
+  }
+}
+
+export interface Reservation {
+  expire: bigint
+  addrs: Uint8Array[]
+  voucher?: Uint8Array
+}
+
+export namespace Reservation {
+  let _codec: Codec<Reservation>
+
+  export const codec = (): Codec<Reservation> => {
+    if (_codec == null) {
+      _codec = message<Reservation>((obj, w, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          w.fork()
+        }
+
+        if (opts.writeDefaults === true || obj.expire !== 0n) {
+          w.uint32(8)
+          w.uint64(obj.expire)
+        }
+
+        if (obj.addrs != null) {
+          for (const value of obj.addrs) {
+            w.uint32(18)
+            w.bytes(value)
+          }
+        }
+
+        if (obj.voucher != null) {
+          w.uint32(26)
+          w.bytes(obj.voucher)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          w.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {
+          expire: 0n,
+          addrs: []
+        }
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.expire = reader.uint64()
+              break
+            case 2:
+              obj.addrs.push(reader.bytes())
+              break
+            case 3:
+              obj.voucher = reader.bytes()
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
+  }
+
+  export const encode = (obj: Reservation): Uint8Array => {
+    return encodeMessage(obj, Reservation.codec())
+  }
+
+  export const decode = (buf: Uint8Array | Uint8ArrayList): Reservation => {
+    return decodeMessage(buf, Reservation.codec())
+  }
+}
+
+export interface Limit {
+  duration?: number
+  data?: bigint
+}
+
+export namespace Limit {
+  let _codec: Codec<Limit>
+
+  export const codec = (): Codec<Limit> => {
+    if (_codec == null) {
+      _codec = message<Limit>((obj, w, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          w.fork()
+        }
+
+        if (obj.duration != null) {
+          w.uint32(8)
+          w.uint32(obj.duration)
+        }
+
+        if (obj.data != null) {
+          w.uint32(16)
+          w.uint64(obj.data)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          w.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {}
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.duration = reader.uint32()
+              break
+            case 2:
+              obj.data = reader.uint64()
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
+  }
+
+  export const encode = (obj: Limit): Uint8Array => {
+    return encodeMessage(obj, Limit.codec())
+  }
+
+  export const decode = (buf: Uint8Array | Uint8ArrayList): Limit => {
+    return decodeMessage(buf, Limit.codec())
+  }
+}
+
+export enum Status {
+  UNUSED = 'UNUSED',
+  OK = 'OK',
+  RESERVATION_REFUSED = 'RESERVATION_REFUSED',
+  RESOURCE_LIMIT_EXCEEDED = 'RESOURCE_LIMIT_EXCEEDED',
+  PERMISSION_DENIED = 'PERMISSION_DENIED',
+  CONNECTION_FAILED = 'CONNECTION_FAILED',
+  NO_RESERVATION = 'NO_RESERVATION',
+  MALFORMED_MESSAGE = 'MALFORMED_MESSAGE',
+  UNEXPECTED_MESSAGE = 'UNEXPECTED_MESSAGE'
+}
+
+enum __StatusValues {
+  UNUSED = 0,
+  OK = 100,
+  RESERVATION_REFUSED = 200,
+  RESOURCE_LIMIT_EXCEEDED = 201,
+  PERMISSION_DENIED = 202,
+  CONNECTION_FAILED = 203,
+  NO_RESERVATION = 204,
+  MALFORMED_MESSAGE = 400,
+  UNEXPECTED_MESSAGE = 401
+}
+
+export namespace Status {
+  export const codec = (): Codec<Status> => {
+    return enumeration<Status>(__StatusValues)
+  }
+}
+export interface ReservationVoucher {
+  relay: Uint8Array
+  peer: Uint8Array
+  expiration: bigint
+}
+
+export namespace ReservationVoucher {
+  let _codec: Codec<ReservationVoucher>
+
+  export const codec = (): Codec<ReservationVoucher> => {
+    if (_codec == null) {
+      _codec = message<ReservationVoucher>((obj, w, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          w.fork()
+        }
+
+        if (opts.writeDefaults === true || (obj.relay != null && obj.relay.byteLength > 0)) {
+          w.uint32(10)
+          w.bytes(obj.relay)
+        }
+
+        if (opts.writeDefaults === true || (obj.peer != null && obj.peer.byteLength > 0)) {
+          w.uint32(18)
+          w.bytes(obj.peer)
+        }
+
+        if (opts.writeDefaults === true || obj.expiration !== 0n) {
+          w.uint32(24)
+          w.uint64(obj.expiration)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          w.ldelim()
+        }
+      }, (reader, length) => {
+        const obj: any = {
+          relay: new Uint8Array(0),
+          peer: new Uint8Array(0),
+          expiration: 0n
+        }
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1:
+              obj.relay = reader.bytes()
+              break
+            case 2:
+              obj.peer = reader.bytes()
+              break
+            case 3:
+              obj.expiration = reader.uint64()
+              break
+            default:
+              reader.skipType(tag & 7)
+              break
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
+  }
+
+  export const encode = (obj: ReservationVoucher): Uint8Array => {
+    return encodeMessage(obj, ReservationVoucher.codec())
+  }
+
+  export const decode = (buf: Uint8Array | Uint8ArrayList): ReservationVoucher => {
+    return decodeMessage(buf, ReservationVoucher.codec())
+  }
+}

package/src/relay/util.ts

@@ -0,0 +1,35 @@
+import type { PeerId } from '@libp2p/interface-peer-id'
+import type { Daemon } from '../index.js'
+import { HopMessage } from './pb/index.js'
+import type { Duplex } from 'it-stream-types'
+import type { Uint8ArrayList } from 'uint8arraylist'
+import { pipe } from 'it-pipe'
+import { pbStream } from 'it-pb-stream'
+
+const RELAY_V2_HOP = '/libp2p/circuit/relay/0.2.0/hop'
+
+export const reserve = async (d: Daemon, peerID: PeerId, message?: Partial<HopMessage>): Promise<HopMessage> => {
+  const stream = await d.client.openStream(peerID, RELAY_V2_HOP)
+  const pb = pbStream(stream)
+  pb.writePB({
+    type: HopMessage.Type.RESERVE,
+    ...(message ?? {})
+  }, HopMessage)
+
+  return await pb.readPB(HopMessage)
+}
+
+export const echoHandler = {
+  protocol: '/echo/1.0.0',
+  handler: async (stream: Duplex<Uint8ArrayList | Uint8Array, Uint8Array, Promise<void>>) => {
+    await pipe(
+      stream,
+      async function * (src) {
+        for await (const buf of src) {
+          yield buf.subarray()
+        }
+      },
+      stream
+    )
+  }
+}