Add support for connecting peers through a relay

.github/workflows/run-test.yml

@@ -16,6 +16,8 @@ jobs:
         run: npm ci
       - name: Run linter
         run: npm run lint
+      - name: Run libp2p relay in the background
+        run: npm run start:relay:background
       - name: Run an Orbiter 1 instance in the background
         run: npm run start:orbiter1:background
       - name: Run an Orbiter 2 instance in the background

conf/webpack.tests.config.js

@@ -28,6 +28,9 @@ export default (env, argv) => {
       })
     ],
     resolve: {
+      alias: {
+        './test-config': path.resolve(__dirname, '../test/utils/test-config-browser')
+      },
       modules: [
         'node_modules',
         path.resolve(__dirname, '../node_modules')

package.json

@@ -37,10 +37,12 @@
     "lint:fix": "standard --fix",
     "copy:fixtures1": "rm -rf ./orbiter1 && mkdir -p ./orbiter1/voyager/orbiter/keystore && cp -Rf test/fixtures/keystore1/** ./orbiter1/voyager/orbiter/keystore/",
     "copy:fixtures2": "rm -rf ./orbiter2 && mkdir -p ./orbiter2/voyager/orbiter/keystore && cp -Rf test/fixtures/keystore2/** ./orbiter2/voyager/orbiter/keystore/",
-    "start:orbiter1": "npm run copy:fixtures1 && node ./src/bin/cli.js daemon -p 54321 --allow --directory ./orbiter1 -vv",
-    "start:orbiter2": "npm run copy:fixtures2 && node ./src/bin/cli.js daemon -p 54322 --allow --directory ./orbiter2 -vv",
-    "start:orbiter1:background": "npm run copy:fixtures1 && node ./src/bin/cli.js daemon -p 54321 --allow --directory ./orbiter1 &",
-    "start:orbiter2:background": "npm run copy:fixtures2 && node ./src/bin/cli.js daemon -p 54322 --allow --directory ./orbiter2 &",
+    "start:relay": "node ./test/utils/relay.js",
+    "start:relay:background": "node ./test/utils/relay.js &",
+    "start:orbiter1": "npm run copy:fixtures1 && node ./src/bin/cli.js daemon -p 54321 -w 55441 --allow --directory ./orbiter1 -vv",
+    "start:orbiter2": "npm run copy:fixtures2 && node ./src/bin/cli.js daemon -p 54322 -w 55442 --allow --directory ./orbiter2 -vv",
+    "start:orbiter1:background": "npm run copy:fixtures1 && node ./src/bin/cli.js daemon -p 54321 -w 55441 --allow --directory ./orbiter1 &",
+    "start:orbiter2:background": "npm run copy:fixtures2 && node ./src/bin/cli.js daemon -p 54322 -w 55442 --allow --directory ./orbiter2 &",
     "test:browser": "npm run build:tests && ./node_modules/.bin/playwright-test test/browser/bundle.js --runner mocha"
   },
   "standard": {

src/bin/cli.js

@@ -23,6 +23,11 @@ yargs(hideBin(process.argv))
           description: 'The port to listen on. Defaults to 0.',
           type: 'number'
         })
+        .option('wsport', {
+          alias: 'w',
+          description: 'The port to listen on for WebSockets. Defaults to 0.',
+          type: 'number'
+        })
     },
     async (argv) => {
       await daemon({ options: argv })

src/daemon.js

@@ -27,10 +27,9 @@ export default async ({ options }) => {
   const defaultAccess = options.allow ? Access.ALLOW : Access.DENY
 
   options.verbose = options.verbose || 0
-
   options.silent = options.silent || false
-
   options.port = options.port || 0
+  options.wsport = options.wsport || 0
 
   const id = orbiterId
 
@@ -54,7 +53,7 @@ export default async ({ options }) => {
   const peerId = await createFromPrivKey(await keystore.getKey(id))
   await keystore.close()
 
-  const libp2p = await createLibp2p(await libp2pConfig({ peerId, port: options.port }))
+  const libp2p = await createLibp2p(await libp2pConfig({ peerId, port: options.port, websocketPort: options.wsport }))
 
   log('peerid:', libp2p.peerId.toString())
   for (const addr of libp2p.getMultiaddrs().map(e => e.toString())) {

src/lib/lander.js

@@ -13,7 +13,7 @@ export default async ({ orbitdb, orbiterAddressOrId }) => {
       })()
     }
 
-    const stream = await orbitdb.ipfs.libp2p.dialProtocol(orbiterAddressOrId, voyagerProtocol)
+    const stream = await orbitdb.ipfs.libp2p.dialProtocol(orbiterAddressOrId, voyagerProtocol, { runOnTransientConnection: true })
 
     await pipe(pinDBs, stream, async (source) => {
       for await (const chunk of source) {
@@ -39,7 +39,7 @@ export default async ({ orbitdb, orbiterAddressOrId }) => {
       })()
     }
 
-    const stream = await orbitdb.ipfs.libp2p.dialProtocol(orbiterAddressOrId, voyagerProtocol)
+    const stream = await orbitdb.ipfs.libp2p.dialProtocol(orbiterAddressOrId, voyagerProtocol, { runOnTransientConnection: true })
 
     await pipe(unpinDBs, stream, async source => {
       for await (const chunk of source) {

src/lib/orbiter.js

@@ -28,7 +28,7 @@ export default async ({ orbitdb, defaultAccess, verbose } = {}) => {
     await pipe(stream, handleRequest({ log, orbitdb, pins, dbs, auth }), stream)
   }
 
-  await orbitdb.ipfs.libp2p.handle(voyagerProtocol, handleMessages)
+  await orbitdb.ipfs.libp2p.handle(voyagerProtocol, handleMessages, { runOnTransientConnection: true })
 
   log('open pinned databases')
 

src/utils/libp2p-config.js

@@ -6,12 +6,12 @@ import { webSockets } from '@libp2p/websockets'
 import { gossipsub } from '@chainsafe/libp2p-gossipsub'
 import { mdns } from '@libp2p/mdns'
 
-export const config = ({ peerId, port } = {}) => {
+export const config = ({ peerId, port, websocketPort } = {}) => {
   const conf = {
     addresses: {
       listen: [
-        '/ip4/0.0.0.0/tcp/0',
-      `/ip4/0.0.0.0/tcp/${port || 0}/ws`
+        `/ip4/0.0.0.0/tcp/${port || 0}`,
+        `/ip4/0.0.0.0/tcp/${websocketPort || 0}/ws`
       ]
     },
     transports: [
@@ -24,6 +24,9 @@ export const config = ({ peerId, port } = {}) => {
     streamMuxers: [
       yamux()
     ],
+    connectionGater: {
+      denyDialMultiaddr: () => false // allow dialling of private addresses.
+    },
     peerDiscovery: [
       mdns()
     ],