Merge branch 'chore/misc-fixes-and-improvements' into 'dev'

Misc bug fixes and improvements

Closes #70 and #71

See merge request ergo/rosen-bridge/rosenet!30

.changeset/cool-snakes-perform.md

@@ -0,0 +1,6 @@
+---
+'@rosen-bridge/rosenet-relay': minor
+'@rosen-bridge/rosenet-node': minor
+---
+
+Limit node connections to relay to 3 to prevent network traffic issues

.changeset/empty-lobsters-pump.md

@@ -0,0 +1,5 @@
+---
+'@rosen-bridge/rosenet-relay': minor
+---
+
+Add `subscribe` function for subscribing to a pubsub topic

.changeset/long-hornets-swim.md

@@ -0,0 +1,5 @@
+---
+'@rosen-bridge/rosenet-relay': minor
+---
+
+Configuare relays as Gossipsub bootstrappers

.changeset/modern-hairs-scream.md

@@ -0,0 +1,5 @@
+---
+'@rosen-bridge/rosenet-utils': patch
+---
+
+Append unused format parameters to format function

.changeset/tame-queens-study.md

@@ -0,0 +1,6 @@
+---
+'@rosen-bridge/rosenet-relay': minor
+'@rosen-bridge/rosenet-node': minor
+---
+
+Switch from mplex to yamux for multiplexing

.changeset/wet-tomatoes-nail.md

@@ -0,0 +1,6 @@
+---
+'@rosen-bridge/rosenet-relay': minor
+'@rosen-bridge/rosenet-node': minor
+---
+
+Prevent Gossipsub from running on transient connections

packages/rosenet-node/lib/createRoseNetNode.ts

@@ -4,7 +4,7 @@ import { bootstrap } from '@libp2p/bootstrap';
 import { circuitRelayTransport } from '@libp2p/circuit-relay-v2';
 import { identify } from '@libp2p/identify';
 import { PeerId } from '@libp2p/interface';
-import { mplex } from '@libp2p/mplex';
+import { yamux } from '@chainsafe/libp2p-yamux';
 import { pubsubPeerDiscovery } from '@libp2p/pubsub-peer-discovery';
 import { tcp } from '@libp2p/tcp';
 import map from 'it-map';
@@ -23,6 +23,7 @@ import addressService from './address/address-service';
 import streamService from './stream/stream-service';
 
 import { decode, encode } from './utils/codec';
+import sample from './utils/sample';
 
 import RoseNetNodeError from './errors/RoseNetNodeError';
 
@@ -61,6 +62,11 @@ const createRoseNetNode = async ({
   const announceMultiaddr = await addressService.getAnnounceMultiaddr(port);
   logger.info(`${announceMultiaddr} set as announce multiaddr`);
 
+  const sampledRelayMultiaddrs = sample(
+    config.relayMultiaddrs,
+    RELAYS_COUNT_TO_CONNECT,
+  );
+
   const node = await createLibp2p({
     peerId,
     transports: [
@@ -72,13 +78,13 @@ const createRoseNetNode = async ({
     addresses: {
       listen: [
         `/ip4/0.0.0.0/tcp/${port}`,
-        ...config.relayMultiaddrs.map(
+        ...sampledRelayMultiaddrs.map(
           (multiaddr) => `${multiaddr}/p2p-circuit`,
         ),
       ],
       announce: [
         announceMultiaddr,
-        ...config.relayMultiaddrs.map(
+        ...sampledRelayMultiaddrs.map(
           (multiaddr) => `${multiaddr}/p2p-circuit`,
         ),
       ],
@@ -95,10 +101,10 @@ const createRoseNetNode = async ({
         denyDialPeer: isPeerUnauthorized,
       }),
     },
-    streamMuxers: [mplex()],
+    streamMuxers: [yamux()],
     peerDiscovery: [
       bootstrap({
-        list: config.relayMultiaddrs,
+        list: sampledRelayMultiaddrs,
       }),
       pubsubPeerDiscovery(),
     ],
@@ -110,7 +116,6 @@ const createRoseNetNode = async ({
       identify: identify(),
       pubsub: gossipsub({
         allowPublishToZeroPeers: true,
-        runOnTransientConnection: true,
       }),
     },
     logger: libp2pLoggerFactory(logger, config.debug?.libp2pComponents ?? []),

packages/rosenet-node/lib/utils/sample.ts

@@ -0,0 +1,13 @@
+/**
+ * Sample `size` elements from `array` randomly
+ * @param array
+ * @param size
+ */
+const sample = <T>(array: T[], size: number): T[] =>
+  array
+    .map((value) => ({ value, sort: Math.random() }))
+    .sort((a, b) => a.sort - b.sort)
+    .map(({ value }) => value)
+    .slice(0, size);
+
+export default sample;

packages/rosenet-node/package.json

@@ -37,10 +37,10 @@
   "dependencies": {
     "@chainsafe/libp2p-gossipsub": "^12.0.0",
     "@chainsafe/libp2p-noise": "^15.0.0",
+    "@chainsafe/libp2p-yamux": "^6.0.2",
     "@libp2p/bootstrap": "^10.0.15",
     "@libp2p/circuit-relay-v2": "^1.0.15",
     "@libp2p/identify": "^1.0.14",
-    "@libp2p/mplex": "^10.0.15",
     "@libp2p/peer-id": "^4.0.6",
     "@libp2p/pubsub-peer-discovery": "^10.0.2",
     "@libp2p/tcp": "^9.0.15",

packages/rosenet-relay/lib/createRoseNetRelay.ts

@@ -3,7 +3,7 @@ import { noise } from '@chainsafe/libp2p-noise';
 import { circuitRelayServer } from '@libp2p/circuit-relay-v2';
 import { identify } from '@libp2p/identify';
 import { PeerId } from '@libp2p/interface';
-import { mplex } from '@libp2p/mplex';
+import { yamux } from '@chainsafe/libp2p-yamux';
 import { pubsubPeerDiscovery } from '@libp2p/pubsub-peer-discovery';
 import { tcp } from '@libp2p/tcp';
 import { createLibp2p } from 'libp2p';
@@ -63,7 +63,7 @@ const createRoseNetRelay = async ({
       denyInboundRelayedConnection: () => true,
       denyDialPeer: isPeerUnauthorized,
     },
-    streamMuxers: [mplex()],
+    streamMuxers: [yamux()],
     services: {
       circuitRelay: circuitRelayServer({
         reservations: {
@@ -75,11 +75,14 @@ const createRoseNetRelay = async ({
       }),
       pubsub: gossipsub({
         allowPublishToZeroPeers: true,
-        runOnTransientConnection: true,
+        D: 0,
+        Dlo: 0,
+        Dhi: 0,
+        Dout: 0,
       }),
       identify: identify(),
     },
-    peerDiscovery: [pubsubPeerDiscovery()],
+    peerDiscovery: [pubsubPeerDiscovery({ listenOnly: true })],
     nodeInfo: {
       name: 'rosenet-relay',
       version: packageJson.version,
@@ -93,6 +96,15 @@ const createRoseNetRelay = async ({
 
   return {
     start: async () => node.start(),
+    subscribe: async (topic: string, handler: (message: string) => void) => {
+      node.services.pubsub.subscribe(topic);
+      node.services.pubsub.addEventListener('message', (event) => {
+        if (event.detail.topic === topic) {
+          const textDecoder = new TextDecoder();
+          handler(textDecoder.decode(event.detail.data));
+        }
+      });
+    },
   };
 };
 

packages/rosenet-relay/package.json

@@ -35,10 +35,10 @@
   "dependencies": {
     "@chainsafe/libp2p-gossipsub": "^12.0.0",
     "@chainsafe/libp2p-noise": "^15.0.0",
+    "@chainsafe/libp2p-yamux": "^6.0.2",
     "@libp2p/circuit-relay-v2": "^1.0.15",
     "@libp2p/identify": "^1.0.14",
     "@libp2p/interface": "^1.1.3",
-    "@libp2p/mplex": "^10.0.15",
     "@libp2p/pubsub-peer-discovery": "^10.0.2",
     "@libp2p/tcp": "^9.0.15",
     "@rosen-bridge/logger-interface": "^0.2.0",

packages/utils/lib/logger/format.ts

@@ -43,15 +43,19 @@ const formatters = {
 const format = (str: string, ...args: any[]) => {
   let j = 0;
 
-  return str.replace(/%([a-z])/gi, (match, f: keyof typeof formatters) => {
-    if (formatters[f]) {
-      return formatters[f](args[j++]);
-    }
-    if (f) {
-      return utilFormat(`%${f}`, args[j++]);
-    }
-    return match;
-  });
+  const formatted = str.replace(
+    /%([a-z])/gi,
+    (match, f: keyof typeof formatters) => {
+      if (formatters[f]) {
+        return formatters[f](args[j++]);
+      }
+      if (f) {
+        return utilFormat(`%${f}`, args[j++]);
+      }
+      return match;
+    },
+  );
+  return `${formatted} ${args.slice(j).join(' ')}`.trimEnd();
 };
 
 export default format;