Add network switching capabilities to Truffle Dashboard

.gitignore

@@ -4,6 +4,7 @@ packages/**/node_modules
 node_modules
 yarn-error.log
 .vscode
+.idea
 .DS_Store
 Thumbs.db
 $RECYCLE.BIN/

packages/compile-solidity/test/test_supplier.js

@@ -18,7 +18,6 @@ describe("CompilerSupplier", function () {
     let oldPragmaFloatSource; // ^0.4.15
     let version4PragmaSource; // ^0.4.21
     let version5PragmaSource; // ^0.5.0
-    let version6PragmaSource; // ^0.6.0
     let version8PragmaSource; // ^0.8.0
     let versionLatestPragmaSource; // Currently: ^0.8.0
     let compileConfig;
@@ -46,10 +45,6 @@ describe("CompilerSupplier", function () {
         path.join(__dirname, "./sources/v0.5.x/Version5Pragma.sol"),
         "utf-8"
       );
-      const version6Pragma = await fse.readFile(
-        path.join(__dirname, "./sources/v0.6.x/Version6Pragma.sol"),
-        "utf-8"
-      );
       const version8Pragma = await fse.readFile(
         path.join(__dirname, "./sources/v0.8.x/Version8Pragma.sol"),
         "utf-8"
@@ -60,7 +55,6 @@ describe("CompilerSupplier", function () {
       oldPragmaFloatSource = { "OldPragmaFloat.sol": oldPragmaFloat };
       version4PragmaSource = { "NewPragma.sol": version4Pragma };
       version5PragmaSource = { "Version5Pragma.sol": version5Pragma };
-      version6PragmaSource = { "Version6Pragma.sol": version6Pragma };
       version8PragmaSource = { "Version8Pragma.sol": version8Pragma };
       versionLatestPragmaSource = { "Version8Pragma.sol": versionLatestPragma }; //update when necessary
     });
@@ -122,9 +116,12 @@ describe("CompilerSupplier", function () {
     });
 
     it("compiles w/ local path solc when options specify path", async function () {
-      // If multiple child projects have same solc version dependency, then yarn hoists the solc dependency 
+      // If multiple child projects have same solc version dependency, then yarn hoists the solc dependency
       // in the truffle root node_modules folder rather than the local package node_modules folder
-      const pathToSolc = path.join(__dirname, "../../../node_modules/solc/index.js");
+      const pathToSolc = path.join(
+        __dirname,
+        "../../../node_modules/solc/index.js"
+      );
 
       options.compilers = {
         solc: {

packages/core/cli.js

@@ -56,7 +56,9 @@ if (userWantsGeneralHelp) {
 
 command
   .run(inputArguments, options)
-  .then(returnStatus => process.exit(returnStatus))
+  .then(returnStatus => {
+    setInterval(() => process.exit(returnStatus), 1000);
+  })
   .catch(error => {
     if (error instanceof TaskError) {
       analytics.send({

packages/core/lib/commands/create/helpers.js

@@ -27,7 +27,7 @@ const replaceContents = (filePath, find, replacement) => {
   fs.writeFileSync(filePath, result, { encoding: "utf8" });
 };
 
-const toUnderscoreFromCamel = (string) => {
+const toUnderscoreFromCamel = string => {
   string = string.replace(/([A-Z])/g, function ($1) {
     return "_" + $1.toLowerCase();
   });
@@ -41,9 +41,10 @@ const toUnderscoreFromCamel = (string) => {
 
 // getLicense return the license property value from Truffle config first and
 // in case that the file doesn't exist it will fallback to package.json
-const getLicense = (options) => {
+const getLicense = options => {
   try {
-    if ((license = require("@truffle/config").detect(options).license)) {
+    const license = require("@truffle/config").detect(options).license;
+    if (license) {
       return license;
     }
   } catch (err) {
@@ -53,7 +54,7 @@ const getLicense = (options) => {
   try {
     return require(path.join(process.cwd(), "package.json")).license;
   } catch {}
-}
+};
 
 const Create = {
   contract: async function (directory, name, options) {
@@ -67,7 +68,8 @@ const Create = {
     await copy(from, to);
 
     replaceContents(to, templates.contract.name, name);
-    if ((license = getLicense(options))) {
+    const license = (license = getLicense(options));
+    if (license) {
       replaceContents(to, templates.contract.license, license);
     }
   },

packages/core/lib/commands/dashboard/run.js

@@ -8,9 +8,103 @@ module.exports = async function (options) {
   const port = options.port || config.dashboard.port;
   const host = options.host || config.dashboard.host;
   const verbose = options.verbose || config.dashboard.verbose;
-  const rpc = true;
+  const publicChains = [
+    {
+      chainId: "0x1",
+      chainName: "ethereum mainnet",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://mainnet.infura.io/v3/"],
+      blockExplorerUrls: ["https://etherscan.com"]
+    },
+    {
+      chainId: "0x3",
+      chainName: "ropsten",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://ropsten.infura.io/v3/"],
+      blockExplorerUrls: ["https://ropsten.etherscan.com"]
+    },
+    {
+      chainId: "0x4",
+      chainName: "rinkeby",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://rinkeby.infura.io/v3/"],
+      blockExplorerUrls: ["https://rinkeby.etherscan.com"]
+    },
+    {
+      chainId: "0x2A",
+      chainName: "kovan",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://ropsten.infura.io/v3/"],
+      blockExplorerUrls: ["https://kovan.etherscan.com"]
+    },
+    {
+      chainId: "0x5",
+      chainName: "goerli",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://goerli.infura.io/v3/"],
+      blockExplorerUrls: ["https://goerli.etherscan.com"]
+    }
+  ];
 
-  const dashboardServerOptions = { port, host, verbose, rpc };
+  const mainnet = publicChains[0];
+  const mergedChains = [...publicChains];
+  if (config.networks) {
+    const chainNames = Object.keys(config.networks);
+
+    // filters out all truffle-config chains that wouldn't make valid dashboard
+    // networks. for the rest, it assembles the relevant data and fills in
+    // mainnet data where needed to make a `dashboardChain`
+    const configuredNetworks = chainNames.reduce((filtered, chainName) => {
+      const chain = config.networks[chainName];
+      if (
+        chainName !== "dashboard" &&
+        chainName !== "test" &&
+        chainName !== "develop" &&
+        ((chain.host && chain.port) || // either has a host/port
+          (chain.rpcUrls && chain.rpcUrls.length > 0)) // or they provided an rpc url
+      ) {
+        filtered.push({
+          chainId: chain.chainId ? chain.chainId : undefined,
+          chainName: chainName,
+          nativeCurrency: chain.nativeCurrency
+            ? chain.nativeCurrency
+            : mainnet.nativeCurrency,
+          rpcUrls: chain.rpcUrls
+            ? chain.rpcUrls
+            : [`http://${chain.host}:${chain.port}`],
+          blockExplorerUrls: chain.blockExplorerUrls
+            ? chain.blockExplorerUrls
+            : undefined
+        });
+      }
+      return filtered;
+    }, []);
+
+    mergedChains.push(...configuredNetworks);
+    console.log(configuredNetworks);
+  }
+
+  const dashboardServerOptions = {
+    port,
+    host,
+    verbose,
+    dashboardChains: mergedChains
+  };
   const dashboardServer = new DashboardServer(dashboardServerOptions);
   await dashboardServer.start();
 

packages/dashboard-message-bus/lib/message/types.ts

@@ -31,6 +31,16 @@ export interface LogMessage extends Message {
   };
 }
 
+/**
+ * Message to log in Dashboard browser console
+ */
+export interface DebugMessage extends Message {
+  type: "debug";
+  payload: {
+    message: string;
+  };
+}
+
 /**
  * Message intended to invalidate earlier messages.
  * The payload is the ID of the message that should be invalidated.
@@ -41,6 +51,17 @@ export interface InvalidateMessage extends Message {
   payload: number;
 }
 
+/**
+ * Message intended to be passed from Server to Dashboard UI on initialization
+ * of the dashboard.
+ */
+export interface InitializeMessage extends Message {
+  type: "initialize";
+  payload: {
+    dashboardChains: object[];
+  };
+}
+
 export const isDashboardProviderMessage = (
   message: Message
 ): message is DashboardProviderMessage => {
@@ -51,8 +72,18 @@ export const isLogMessage = (message: Message): message is LogMessage => {
   return message.type === "log";
 };
 
+export const isDebugMessage = (message: Message): message is DebugMessage => {
+  return message.type === "debug";
+};
+
 export const isInvalidateMessage = (
   message: Message
 ): message is InvalidateMessage => {
   return message.type === "invalidate";
 };
+
+export const isInitializeMessage = (
+  message: Message
+): message is InitializeMessage => {
+  return message.type === "initialize";
+};

packages/dashboard-message-bus/lib/utils.ts

@@ -6,6 +6,8 @@ import axios from "axios";
 
 any.shim();
 
+export class MessageBusConnectionError extends Error {}
+
 /**
  * Convert any JS object or value to a base64 representation of it
  */
@@ -152,7 +154,7 @@ export const getMessageBusPorts = async (
     }
   }
 
-  throw new Error(
+  throw new MessageBusConnectionError(
     `Could not connect to dashboard at http://${dashboardHost}:${dashboardPort}/ports`
   );
 };

packages/dashboard/bin/start-dev-server.ts

@@ -4,8 +4,59 @@ const options = {
   port: 24012,
   host: "localhost",
   verbose: true,
-  rpc: true,
-  autoOpen: false
+  autoOpen: false,
+  dashboardChains: [
+    {
+      chainId: "0x1",
+      chainName: "ethereum mainnet",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://mainnet.infura.io/v3/"],
+      blockExplorerUrls: ["https://etherscan.com"]
+    },
+    {
+      chainId: "0x3",
+      chainName: "ropsten",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://ropsten.infura.io/v3/"],
+      blockExplorerUrls: ["https://ropsten.etherscan.com"]
+    },
+    {
+      chainId: "0x4",
+      chainName: "rinkeby",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://rinkeby.infura.io/v3/"],
+      blockExplorerUrls: ["https://rinkeby.etherscan.com"]
+    },
+    {
+      chainId: "0x2A",
+      chainName: "kovan",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://ropsten.infura.io/v3/"],
+      blockExplorerUrls: ["https://kovan.etherscan.com"]
+    },
+    {
+      chainId: "0x5",
+      chainName: "goerli",
+      nativeCurrency: {
+        symbol: "ETH",
+        decimals: 18
+      },
+      rpcUrls: ["https://goerli.infura.io/v3/"],
+      blockExplorerUrls: ["https://goerli.etherscan.com"]
+    }
+  ]
 };
 
 const dashboardServer = new DashboardServer(options);