Merge pull request #7 from tintinweb/cmdlinArgsPassthru

Generic Commandline Passthru - specify any ganache-cli settings as options to solidity-shell

Author: tintinweb

CHANGELOG.md

@@ -1,6 +1,24 @@
 # Change Log
 All notable changes will be documented in this file.
 
+## v0.0.8
+- new: Passthru ganache-cli settings as options to solidity-shell #7
+```shell
+solidity-shell -- -fork https://mainnet.infura.io/v3/yourToken
+```
+
+Query a live contracts `ERC20.name()`:
+```solidity
+
+ »  interface ERC20 {
+multi> function name() external view returns (string memory);
+multi> }
+ 
+ »  ERC20(0xB8c77482e45F1F44dE1745F52C74426C631bDD52).name()
+BNB
+
+```
+- fix: `.config set` handling of strings and multi-word arguments
 
 ## v0.0.7
 - fix: rework remote compiler

README.md

@@ -27,11 +27,11 @@ An interactive Solidity shell with lightweight session recording and remote comp
 352
 ```
 
-Oh, did you know that we automatically fetch a matching remote compiler when you change the solidity pragma? It is as easy as typing `pgrama solidity 0.5.0` and solidity-shell will do the rest 🙌
+Oh, did you know that we automatically fetch a matching remote compiler when you change the solidity pragma? It is as easy as typing `pgrama solidity 0.5.0` and solidity-shell will do the rest 🙌.
 
-### Hints
 
 
+### Hints
 
 * `pragma solidity <version>` attempts to dynamically load the selected compiler version (remote compiler, may take a couple of seconds).
 * Sessions can be saved and restored using the `.session` command. Your previous session is always stored and can be loaded via `.session load previous` (not safe when running concurrent shells).
@@ -41,8 +41,19 @@ Oh, did you know that we automatically fetch a matching remote compiler when you
 * `$_` is a placeholder for the last known result. Feel free to use that placeholder in your scripts :)
 * Special commands are dot-prefixed. Everything else is evaluated as Solidity code.
 
+
 ### Usage
 
+#### Cmdline Passthru
+
+Any arguments provided after an empty `--` are directly passed to `ganacheCmd` (default: `ganache-cli`). This way, for example, you can start a solidity shell on a ganache fork of mainnet via infura. Check `ganache-cli --help` for a list of available options.
+
+```shell
+⇒  solidity-shell -- --fork https://mainnet.infura.io/v3/yourApiToken
+```
+
+#### Repl
+
 ```shell
  🚀 Entering interactive Solidity shell. '.help' and '.exit' are your friends.
  »  ℹ️  ganache-mgr: starting temp. ganache instance ...

bin/main.js

@@ -42,21 +42,32 @@ function saveFile(name, data){
 }
 
 /** MAIN */
+const argv = require('minimist')(process.argv, {'--': true});
+var config = loadFile(CONFIG_FILE);
+const oldGanacheArgs = config.ganacheArgs;
+if(argv['--'].length){ // temporarily override ganache args
+    config.ganacheArgs = argv['--'];
+}
 
-const shell = new InteractiveSolidityShell(loadFile(CONFIG_FILE));
+const shell = new InteractiveSolidityShell(config);
 
-const vorpal = new Vorpal()
-    .delimiter('')
-    .show()
-    .parse(process.argv);
 
 process.on('exit', () => { 
     shell.blockchain.stopService(); 
+    if(argv['--'].length){ //restore old ganache args
+        shell.settings.ganacheArgs = oldGanacheArgs;
+    }
     saveFile(CONFIG_FILE, shell.settings)
     saveFile(SESSION, shell.dumpSession())
 });
 
 
+
+const vorpal = new Vorpal()
+    .delimiter('')
+    .show()
+    .parse(argv._);
+
 vorpal
     .mode('repl', 'Enters Solidity Shell Mode')
     .delimiter(c.bold('» '))
@@ -116,7 +127,7 @@ cheers 🙌
                 case '.undo': shell.revert(); break; //revert last action
                 case '.config':
                     switch(commandParts[1]){
-                        case 'set': shell.setSetting(commandParts[2], convert(commandParts[3])); break;
+                        case 'set': shell.setSetting(commandParts[2], convert(commandParts.slice(3).join(' '))); break;
                         case 'unset': delete shell.settings[commandParts[2]]; break;
                         default: return cb(shell.settings); 
                     } break;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "solidity-shell",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "",
   "main": "src/index.js",
   "bin": {
@@ -25,6 +25,7 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "minimist": "^1.2.5",
     "readline-sync": "^1.4.10",
     "request": "^2.88.2",
     "solc": "^0.8.10",

package.json

@@ -113,13 +113,15 @@ class InteractiveSolidityShell {
 
     constructor(settings, log) {
         this.log = log || console.log;
+
         const defaults = {
             templateContractName: 'MainContract',
             templateFuncMain: 'main',
             installedSolidityVersion: null, // overridden after merging settings; never use configured value
             providerUrl: 'http://localhost:8545',
             autostartGanache: true,
             ganacheCmd: 'ganache-cli',
+            ganacheArgs: [],
             debugShowContract: false
         }
 
@@ -153,7 +155,19 @@ class InteractiveSolidityShell {
     }
 
     setSetting(key, value){
-        if(key === 'installedSolidityVersion') return;
+        switch(key){
+            case 'installedSolidityVersion': return;
+            case 'ganacheArgs':
+                if(!value) {
+                    value = [];
+                }
+                else if(!Array.isArray(value)){
+                    value = value.split(' ');
+                }
+                break;
+            case 'ganacheCmd':
+                value = value.trim();
+        }
         this.settings[key] = value;
     }
 
@@ -395,7 +409,7 @@ class Blockchain {
         if (this.proc) {
             return this.proc;
         }
-        this.proc = require('child_process').spawn(this.settings.ganacheCmd);
+        this.proc = require('child_process').spawn(this.settings.ganacheCmd, this.settings.ganacheArgs);
     }
 
     stopService() {

src/handler.js

@@ -11,7 +11,8 @@ function convert(str){
         case 'false': return false;
     }
     try {
-        return parseInt(str);
+        let num = parseInt(str);
+        if(!isNaN(num)) return num;
     } catch {}
 
     return str;
@@ -33,8 +34,6 @@ function multilineInput(command){
     return command;
 }
 
-
-
 module.exports = {
     convert,
     multilineInput