@libp2p/interop 5.0.0 → 6.0.1

package/src/pubsub/gossipsub.ts

@@ -4,6 +4,8 @@ import { expect } from 'aegir/chai'
 import type { Daemon, DaemonFactory, NodeType, SpawnOptions } from '../index.js'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import first from 'it-first'
+import pWaitFor from 'p-wait-for'
+import type { IdentifyResult } from '@libp2p/daemon-client'
 
 export function gossipsubTests (factory: DaemonFactory): void {
   const nodeTypes: NodeType[] = ['js', 'go']
@@ -22,6 +24,7 @@ export function gossipsubTests (factory: DaemonFactory): void {
 function runGossipsubTests (factory: DaemonFactory, optionsA: SpawnOptions, optionsB: SpawnOptions): void {
   describe('pubsub.gossipsub', () => {
     let daemons: Daemon[]
+    let identify1: IdentifyResult
 
     // Start Daemons
     before(async function () {
@@ -32,7 +35,7 @@ function runGossipsubTests (factory: DaemonFactory, optionsA: SpawnOptions, opti
         factory.spawn(optionsB)
       ])
 
-      const identify1 = await daemons[1].client.identify()
+      identify1 = await daemons[1].client.identify()
       await daemons[0].client.connect(identify1.peerId, identify1.addrs)
     })
 
@@ -40,7 +43,7 @@ function runGossipsubTests (factory: DaemonFactory, optionsA: SpawnOptions, opti
     after(async function () {
       if (daemons != null) {
         await Promise.all(
-          daemons.map(async (daemon) => { await daemon.stop() })
+          daemons.map(async daemon => { await daemon.stop() })
         )
       }
     })
@@ -59,7 +62,11 @@ function runGossipsubTests (factory: DaemonFactory, optionsA: SpawnOptions, opti
 
       const publisher = async (): Promise<void> => {
         // wait for subscription stream
-        await new Promise(resolve => setTimeout(resolve, 800))
+        await pWaitFor(async () => {
+          const peers = await daemons[0].client.pubsub.getSubscribers(topic)
+          return peers.map(p => p.toString()).includes(identify1.peerId.toString())
+        })
+
         await daemons[0].client.pubsub.publish(topic, data)
       }
 

package/src/pubsub/hybrid.ts

@@ -4,6 +4,8 @@ import { expect } from 'aegir/chai'
 import type { Daemon, DaemonFactory, NodeType, SpawnOptions } from '../index.js'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import first from 'it-first'
+import pWaitFor from 'p-wait-for'
+import type { IdentifyResult } from '@libp2p/daemon-client'
 
 export function hybridTests (factory: DaemonFactory): void {
   const nodeTypes: NodeType[] = ['js', 'go']
@@ -22,6 +24,7 @@ export function hybridTests (factory: DaemonFactory): void {
 function runHybridTests (factory: DaemonFactory, optionsA: SpawnOptions, optionsB: SpawnOptions): void {
   describe('pubsub.hybrid', () => {
     let daemons: Daemon[]
+    let identify1: IdentifyResult
 
     // Start Daemons
     before(async function () {
@@ -32,7 +35,7 @@ function runHybridTests (factory: DaemonFactory, optionsA: SpawnOptions, options
         factory.spawn(optionsB)
       ])
 
-      const identify1 = await daemons[1].client.identify()
+      identify1 = await daemons[1].client.identify()
       await daemons[0].client.connect(identify1.peerId, identify1.addrs)
     })
 
@@ -59,7 +62,10 @@ function runHybridTests (factory: DaemonFactory, optionsA: SpawnOptions, options
 
       const publisher = async (): Promise<void> => {
         // wait for subscription stream
-        await new Promise(resolve => setTimeout(resolve, 800))
+        await pWaitFor(async () => {
+          const peers = await daemons[0].client.pubsub.getSubscribers(topic)
+          return peers.map(p => p.toString()).includes(identify1.peerId.toString())
+        })
         await daemons[0].client.pubsub.publish(topic, data)
       }
 

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;
+}