Draft: Provide built-in ganache by default (#16)

* update dependencies

* prepare for use with multiple blockchain providers

* better error handling
--fork option (for ganache internal)
update dependencies
--reset-config switch
--show-config-file switch

* update changelog

* fix web3js error on wrong fork config...

* .chain eth_X now issues eth rpc calls to provider

* update changelog

* update changelog

Author: tintinweb

CHANGELOG.md

@@ -1,6 +1,25 @@
 # Change Log
 All notable changes will be documented in this file.
 
+## v0.1.0
+
+⚠️ pot. breaking changes: `solidity-shell` now ships with ganache. use `.chain set-provider` to switch chain providers. the `built-in` ganache provider is used by default.
+
+- new: built in ganache provider
+- new: `.chain` subcommand
+  - `.chain restart` - restarts the service (formerly known as `.restartblockchain`)
+  - `.chain set-provider [fork-url]` - switch between the internal or an external `ganache-cli` command or url-provider. Optionally specify a ganache fork-url.
+    - ` .chain set-provider internal https://mainnet.infura.io/v3/yourApiKey `
+  - `.chain accounts` - show ganache accounts
+  - `.chain eth_<X> [args...]` - arbitrary eth JSONrpc method calls to blockchain provider.
+    - e.g. `.chain eth_accounts` returns the blockchain providers response to the `eth_accounts` JSONrpc call.
+- new: command line switches:
+  - `--fork` overrides fork-url option for internal ganache provider `solidity-shell --fork https://mainnet.infura.io/v3/yourApiKey`.
+  - `--reset-config` resets the config file.
+  - `--show-config-file` prints the path to the config file.
+- fix: better error handling. prevent vicious cycles where broken config trashes the app 🤦‍♂️
+- update: dependencies and solc references updated
+
 ## v0.0.11
 - new: configurable call and deploy gas
 - new: `.restartblockchain` command to restart ganache e.g. after config changes

bin/main.js

@@ -46,20 +46,44 @@ function saveFile(name, data){
 /** MAIN */
 const argv = require('minimist')(process.argv, {'--': true});
 var config = loadFile(CONFIG_FILE);
-const oldGanacheArgs = config.ganacheArgs;
+
+const oldConf = {
+    ganacheArgs: config.ganacheArgs,
+    ganacheOptions: config.ganacheOptions
+}
+
 if(argv['--'].length){ // temporarily override ganache args
     config.ganacheArgs = argv['--'];
 }
+if(argv['fork']){
+    config.ganacheOptions.fork = {url: argv['fork']}
+}
+if(argv['reset-config']){
+    config = {};
+}
+if(argv['show-config-file']){
+    console.log(path.join(CONFIG_HOME, CONFIG_FILE));
+    process.exit(0);
+}
 
 const shell = new InteractiveSolidityShell(config);
 
 process.on('exit', () => { 
     shell.blockchain.stopService(); 
     if(argv['--'].length){ //restore old ganache args
-        shell.settings.ganacheArgs = oldGanacheArgs;
+        shell.settings.ganacheArgs = oldConf.ganacheArgs;
+    }
+    if(argv['fork']){
+        shell.settings.ganacheOptions.fork = oldConf.ganacheOptions.fork;
     }
-    saveFile(CONFIG_FILE, shell.settings)
     saveFile(SESSION, shell.dumpSession())
+
+    // exit if dirty exit detected
+    if(process.exitCode!=0){
+        console.log("🧨  not saving config due to dirty shutdown.")
+        return;
+    }
+    saveFile(CONFIG_FILE, shell.settings)
 });
 
 const vorpal = new Vorpal()
@@ -77,7 +101,7 @@ vorpal
     .mode('repl', 'Enters Solidity Shell Mode')
     .delimiter(c.bold('» '))
     .init(function (args, cb) {
-        this.log(`🚀 Entering interactive Solidity ${c.bold(shell.settings.installedSolidityVersion)} shell. '${c.bold('.help')}' and '${c.bold('.exit')}' are your friends.`);
+        this.log(`🚀 Entering interactive Solidity ${c.bold(shell.settings.installedSolidityVersion)} shell (🧁:${c.bold(shell.blockchain.name)}). '${c.bold('.help')}' and '${c.bold('.exit')}' are your friends.`);
         return cb();
     })
     .action(function (input, cb) {
@@ -102,7 +126,14 @@ vorpal
  ${c.bold('General:')}
     .help                                ... this help :)
     .exit                                ... exit the shell
-    .restartblockchain                   ... restart the ganache blockchain service
+
+${c.bold('Blockchain:')}
+    .chain                         
+            restart                      ... restart the blockchain service
+            set-provider <fork-url>      ... "internal" | <shell-command: e.g. ganache-cli> | <https://localhost:8545>
+                                            - fork url e.g. https://mainnet.infura.io/v3/yourApiKey  
+            accounts                     ... return eth_getAccounts
+            <X>                          ... return web3.eth.<X>()
 
  ${c.bold('Settings:')}
     .config                              ... show settings
@@ -129,7 +160,41 @@ cheers 🙌
 
                     break; //show usage
                 case '.exit': process.exit(); break; //exit -> no more cb()
-                case '.restartblockchain': shell.blockchain.restartService(); break; //restart ganache
+                case '.chain': 
+                    if(!commandParts[1]){
+                        break;
+                    }
+                    switch(commandParts[1]){
+                        case 'restart': 
+                            shell.blockchain.restartService(); 
+                            this.log(`  ✨ '${shell.blockchain.name}' blockchain provider restarted.`)
+                            break;
+                        case 'set-provider':
+                            shell.settings.blockchainProvider = commandParts[2];
+                            if(commandParts.length > 3){
+                                //fork-url
+                                shell.settings.ganacheOptions.fork = {url: commandParts[3]}
+                            } else {
+                                delete shell.settings.ganacheOptions.fork
+                            }
+                            shell.initBlockchain();
+                            this.log(`  ✨ '${shell.blockchain.name}' initialized.`)
+                            break;
+                        case 'accounts':
+                            shell.blockchain.getAccounts().then(acc => {
+                                this.log(`\n   🧝‍ ${acc.join('\n   🧝 ')}\n`)
+                                
+                            })
+                            break;
+                        default:
+                            if(commandParts[1].startsWith("eth_")){
+                                shell.blockchain.rpcCall(commandParts[1], commandParts.slice(2)).then(res => this.log(res)).catch(e => this.log(e))
+                            }
+                            
+                            break;
+                    }
+                    
+                    break; //restart ganache
                 case '.reset': shell.reset(); break; //reset complete state
                 case '.undo': shell.revert(); break; //revert last action
                 case '.config':
@@ -214,7 +279,8 @@ vorpal
     .command(".exit")
     .alias("exit")
 vorpal
-    .command(".restartblockchain")
+    .command(".chain")
+    .autocomplete(["restart","set-provider","accounts", "getAccounts"])
 vorpal 
     .command(".config")
     .autocomplete(["set","unset"])