feat: add stardust behind flag "EXPERIMENTAL.stardust"

This adds support for the stardust protocol behind the flag EXPERIMENTAL.stardust This pr is part of the endeavour to replace ws-star with stardust for the time being until a better solution is found. See the discussion at libp2p/js-libp2p-websocket-star#70 (comment) for more information
ipfs · Jan 12, 2019 · 0348766 · 0348766
1 parent f7ece99
commit 0348766
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 5 deletions.
diff --git a/package.json b/package.json
@@ -137,6 +137,7 @@
     "libp2p-mplex": "~0.8.4",
     "libp2p-record": "~0.6.1",
     "libp2p-secio": "~0.10.1",
+    "libp2p-stardust": "0.0.2",
     "libp2p-tcp": "~0.13.0",
     "libp2p-webrtc-star": "~0.15.5",
     "libp2p-websocket-star": "~0.10.0",

diff --git a/src/core/components/libp2p.js b/src/core/components/libp2p.js
@@ -26,6 +26,10 @@ module.exports = function libp2p (self) {
                   enabled: get(opts.options, 'config.Discovery.MDNS.Enabled',
                     get(opts.config, 'Discovery.MDNS.Enabled', true))
                 },
+                stardust: {
+                  enabled: get(opts.options, 'config.Discovery.Stardust.Enabled',
+                    get(opts.config, 'Discovery.Stardust.Enabled', true))
+                },
                 webRTCStar: {
                   enabled: get(opts.options, 'config.Discovery.webRTCStar.Enabled',
                     get(opts.config, 'Discovery.webRTCStar.Enabled', true))
@@ -55,7 +59,8 @@ module.exports = function libp2p (self) {
               },
               EXPERIMENTAL: {
                 dht: get(opts.options, 'EXPERIMENTAL.dht', false),
-                pubsub: get(opts.options, 'EXPERIMENTAL.pubsub', false)
+                pubsub: get(opts.options, 'EXPERIMENTAL.pubsub', false),
+                stardust: get(opts.options, 'EXPERIMENTAL.stardust', false)
               }
             },
             connectionManager: get(opts.options, 'connectionManager',

diff --git a/src/core/runtime/config-browser.js b/src/core/runtime/config-browser.js
@@ -3,6 +3,7 @@
 module.exports = () => ({
   Addresses: {
     Swarm: [
+      '/dns4/stardust.mkg20001.io/tcp/443/wss/p2p-stardust' // until it's actually stable it would be good to have this enabled here so `EXPERIMENTAL.stardust` actually does something
     ],
     API: '',
     Gateway: ''

diff --git a/src/core/runtime/libp2p-browser.js b/src/core/runtime/libp2p-browser.js
@@ -4,6 +4,7 @@ const WS = require('libp2p-websockets')
 const WebRTCStar = require('libp2p-webrtc-star')
 const WebSocketStar = require('libp2p-websocket-star')
 const Multiplex = require('libp2p-mplex')
+const Stardust = require('libp2p-stardust')
 const SECIO = require('libp2p-secio')
 const Bootstrap = require('libp2p-bootstrap')
 const libp2p = require('libp2p')
@@ -14,12 +15,18 @@ class Node extends libp2p {
     const wrtcstar = new WebRTCStar({ id: _options.peerInfo.id })
     const wsstar = new WebSocketStar({ id: _options.peerInfo.id })
 
+    let stardust
+
+    if (_options.config.EXPERIMENTAL.stardust) {
+      stardust = new Stardust({ id: _options.peerInfo.id })
+    }
+
     const defaults = {
       modules: {
         transport: [
           WS,
           wrtcstar,
-          wsstar
+          stardust || wsstar
         ],
         streamMuxer: [
           Multiplex
@@ -29,7 +36,7 @@ class Node extends libp2p {
         ],
         peerDiscovery: [
           wrtcstar.discovery,
-          wsstar.discovery,
+          stardust ? stardust.discovery : wsstar.discovery,
           Bootstrap
         ]
       },
@@ -52,6 +59,8 @@ class Node extends libp2p {
       }
     }
 
+    delete _options.config.EXPERIMENTAL.stardust
+
     super(defaultsDeep(_options, defaults))
   }
 }

diff --git a/src/core/runtime/libp2p-nodejs.js b/src/core/runtime/libp2p-nodejs.js
@@ -7,6 +7,7 @@ const WebSocketStar = require('libp2p-websocket-star')
 const Bootstrap = require('libp2p-bootstrap')
 const KadDHT = require('libp2p-kad-dht')
 const Multiplex = require('libp2p-mplex')
+const Stardust = require('libp2p-stardust')
 const SECIO = require('libp2p-secio')
 const libp2p = require('libp2p')
 const defaultsDeep = require('@nodeutils/defaults-deep')
@@ -15,12 +16,18 @@ class Node extends libp2p {
   constructor (_options) {
     const wsstar = new WebSocketStar({ id: _options.peerInfo.id })
 
+    let stardust
+
+    if (_options.config.EXPERIMENTAL.stardust) {
+      stardust = new Stardust({ id: _options.peerInfo.id })
+    }
+
     const defaults = {
       modules: {
         transport: [
           TCP,
           WS,
-          wsstar
+          stardust || wsstar
         ],
         streamMuxer: [
           Multiplex
@@ -31,7 +38,7 @@ class Node extends libp2p {
         peerDiscovery: [
           MulticastDNS,
           Bootstrap,
-          wsstar.discovery
+          stardust ? stardust.discovery : wsstar.discovery
         ],
         dht: KadDHT
       },
@@ -40,6 +47,9 @@ class Node extends libp2p {
           mdns: {
             enabled: true
           },
+          stardust: {
+            enabled: true
+          },
           bootstrap: {
             enabled: true
           },
@@ -57,6 +67,8 @@ class Node extends libp2p {
       }
     }
 
+    delete _options.config.EXPERIMENTAL.stardust
+
     super(defaultsDeep(_options, defaults))
   }
 }