add session recording and fix some bugs

tintinweb · tintinweb · commit 4b7678e16ac4 · 2021-08-30T18:14:59.000+02:00
diff --git a/README.md b/README.md
@@ -6,18 +6,120 @@
 
 ## Solidity Shell
 
-An interactive Solidity shell.
+An interactive Solidity shell with lightweight session recording.
 
 [💾](https://www.npmjs.com/package/solidity-shell) `npm install solidity-shell` 
 
+
+```javascript
+⇒  solidity-shell
+ 
+🚀 Entering interactive Solidity shell. Type '.help' for help, '.exit' to exit.
+ »  ℹ️  ganache-mgr: starting temp. ganache instance ...
+ »
+ »  uint a = 100
+ »  uint b = 200
+ »  a + b + 2 + uint8(50)
+352
+```
+
+**Note**: The previous session can always be loaded by calling `.session load previous`.
+
 ## Examples 
 
+
 ![solidity-shell](https://user-images.githubusercontent.com/2865694/131328119-e363f20a-f627-43fc-8801-8d6613ad740f.gif)
 
-____
+#### Sample Usage
+
+```shell
+ »  .help
+
+📚 Help:
+   -----
+
+  General:
+    .help                                ... this help :)
+    .exit                                ... exit the shell
+
+  Settings:
+    .config                              ... show settings
+            set <key> <value>            ... set setting
+            unset <key>                  ... unset setting
+  Session:
+    .session                             ... list sessions
+            load <id>                    ... load session
+            save <id>                    ... save session
+            
+    .undo                                ... undo last command
+    .reset                               ... reset cmd history. start from scratch.
+
+  Debug:
+    .dump                                ... (debug) show template contract
+
+
+cheers 🙌 
+    @tintinweb 
+    ConsenSys Diligence @ https://diligence.consensys.net/
+```
+
+
+#### Contracts, Structs, Functions
+
+```javascript
+⇒  solidity-shell
+ 
+🚀 Entering interactive Solidity shell. Type '.help' for help, '.exit' to exit.
+ »  ℹ️  ganache-mgr: starting temp. ganache instance ...
+ »
+ »  contract TestContract {}
+ »  new TestContract()
+0xFBC1B2e79D816E36a1E1e923dd6c6fad463F4368
+ »  msg.sender
+0x363830C6aee2F0c43922bcB785C570a7cca613b5
+ »  block.timestamp
+1630339581
+ »  struct yolo {uint8 x; uint8 y;}
+ »  function mytest(uint x) public pure returns(uint) {
+multi> return x -5;
+multi> }
+ »  mytest(100)
+95
+```
 
 ![solidity-shell2](https://user-images.githubusercontent.com/2865694/131328490-e211e89b-ac59-4729-972b-3e3b19b75cfc.gif)
 
+#### Advanced usage
+
+```
+ »  struct yolo {uint8 x; uint8 y;}
+ »  .dump
+// SPDX-License-Identifier: GPL-2.0-or-later
+pragma solidity ^0.8.7;
+
+contract TestContract {}
+
+struct yolo {uint8 x; uint8 y;}
+
+contract MainContract {
+
+    
+
+    function main() public  {
+        uint a = 100;
+        uint b = 200;
+        a + b + 2 + uint8(50);
+        new TestContract();
+        msg.sender;
+        block.timestamp;
+        return ;
+    }
+}
+```
+____
+
+
+
 ____
 
 ## Acknowledgements
diff --git a/bin/main.js b/bin/main.js
@@ -14,35 +14,43 @@ const { InteractiveSolidityShell, SolidityStatement } = require('../src/handler'
 const { convert, multilineInput } = require('../src/utils');
 
 const CONFIG_HOME = path.join(os.homedir(), '.solidity-shell');
-const CONFIG_FILE = path.join(CONFIG_HOME, '.config');
+const CONFIG_FILE = '.config';
+
+var SESSION = 'previous.session';
 
 /** static funcs */
-function tryLoadSettings(){
-    let settings = {};
+function loadFile(name){
+    let cfgFile = path.join(CONFIG_HOME, name);
 
-    if(fs.existsSync(CONFIG_FILE)){
-        settings = JSON.parse(fs.readFileSync(CONFIG_FILE));
+    if(fs.existsSync(cfgFile)){
+        return JSON.parse(fs.readFileSync(cfgFile));
     }
-    return settings;
+    return {};
 }
 
-function trySaveSettings(settings){
+function saveFile(name, data){
+    let cfgFile = path.join(CONFIG_HOME, name);
+    
     if(!fs.existsSync(CONFIG_HOME)){
         fs.mkdirSync(CONFIG_HOME);
     }
-    fs.writeFileSync(CONFIG_FILE, JSON.stringify(settings));
+    fs.writeFileSync(cfgFile, JSON.stringify(data));
 }
 
 /** MAIN */
 
-const shell = new InteractiveSolidityShell(tryLoadSettings());
+const shell = new InteractiveSolidityShell(loadFile(CONFIG_FILE));
 
 const vorpal = new Vorpal()
     .delimiter('')
     .show()
     .parse(process.argv);
 
-process.on('exit', () => { shell.blockchain.stopService(); trySaveSettings(shell.settings) });
+process.on('exit', () => { 
+    shell.blockchain.stopService(); 
+    saveFile(CONFIG_FILE, shell.settings)
+    saveFile(SESSION, shell.dumpSession())
+});
 
 
 vorpal
@@ -56,21 +64,31 @@ vorpal
         let command = multilineInput(input);
         if (command.startsWith('.')) {
             let commandParts = command.split(' ');
+            let ret = undefined;
             switch (commandParts[0]) {
                 case '.help':
                     cb(`
 📚 Help:
    -----
 
-    .help                    ... this help :)
-    .exit                    ... exit the shell
+  General:
+    .help                                ... this help :)
+    .exit                                ... exit the shell
 
-    .config                  ... show settings
-    .set   <key> <value>     ... set setting
-    .unset <key>             ... clear setting
-    
-    .reset                   ... reset cmd history. start from scratch.
-    .undo                    ... undo last command
+  Settings:
+    .config                              ... show settings
+            set <key> <value>            ... set setting
+            unset <key>                  ... unset setting
+  Session:
+    .session                             ... list sessions
+            load <id>                    ... load session
+            save <id>                    ... save session
+            
+    .undo                                ... undo last command
+    .reset                               ... reset cmd history. start from scratch.
+
+  Debug:
+    .dump                                ... (debug) show template contract
 
 
 cheers 🙌 
@@ -79,23 +97,44 @@ cheers 🙌
 `);
 
                     break; //show usage
-                case '.exit': process.exit(); return; //exit -> no more cb()
+                case '.exit': process.exit(); //exit -> no more cb()
                 case '.reset': shell.reset(); break; //reset complete state
                 case '.undo': shell.revert(); break; //revert last action
-                case '.set': shell.setSetting(commandParts[1], convert(commandParts[2])); break;
-                case '.unset': shell.setSetting(commandParts[1], undefined); break;
-                case '.config': return cb(shell.settings); break;
+                case '.config':
+                    switch(commandParts[1]){
+                        case 'set': shell.setSetting(commandParts[2], convert(commandParts[3])); break;
+                        case 'del': delete shell.settings[commandParts[2]]; break;
+                        default: return cb(shell.settings); 
+                    } break;
+                case '.session': 
+                    switch(commandParts[1]){
+                        default:
+                            let sessions = fs.readdirSync(CONFIG_HOME).filter(file => file.endsWith('.session'));
+                            return cb('     - ' + sessions.map(s => s.replace('.session','')).join('\n     - '));
+                        case 'load': 
+                            shell.loadSession(loadFile(`${commandParts[2]}.session`))
+                            break;
+                        case 'save': 
+                            SESSION = `${commandParts[2]}.session`;
+                            saveFile(SESSION, shell.dumpSession())
+                            break;
+                    }; break;
+                case '.dump': return cb(shell.template());
+
                 default:
                     console.error(`unknown command: ${command}. type '.help' for a list of commands.`);
             }
             // meta commands
-            return cb();
+            return cb(ret);
         }
 
         const statement = new SolidityStatement(command);
 
         /* REPL cmd */
         shell.run(statement).then(res => {
+            if(typeof res === 'object'){
+                return cb();
+            }
             cb(c.bold(c.yellow(res)));
         }).catch(errors => {
             console.error(errors)
diff --git a/src/handler.js b/src/handler.js
@@ -22,7 +22,7 @@ const IGNORE_WARNINGS = [
 class SolidityStatement {
 
     constructor(rawCommand, scope) {
-        this.rawCommand = rawCommand ? rawCommand.trim() : "true";
+        this.rawCommand = rawCommand ? rawCommand.trim() : "";
         this.hasNoReturnValue = (rexAssign.test(this.rawCommand)) || (this.rawCommand.startsWith('delete')) || (this.rawCommand.startsWith('assembly')) || (this.rawCommand.startsWith('revert'))
 
         if (scope) {
@@ -46,14 +46,16 @@ class SolidityStatement {
             } else {
                 this.scope = "main";
                 this.rawCommand = this.fixStatement(this.rawCommand);
+                if(this.rawCommand===';'){
+                    this.hasNoReturnValue = true;
+                }
             }
         }
 
-        //
         if (this.hasNoReturnValue) {
             // expression
-            this.returnExpression = 'true;';
-            this.returnType = 'bool';
+            this.returnExpression = ';';
+            this.returnType = '';
         } else {
             // not an expression
             this.returnExpression = this.rawCommand;
@@ -68,6 +70,10 @@ class SolidityStatement {
     toString() {
         return this.rawCommand;
     }
+
+    toList() {
+        return [this.rawCommand, this.scope]
+    }
 }
 
 
@@ -95,7 +101,20 @@ class InteractiveSolidityShell {
         this.blockchain.connect()
     }
 
+    loadSession(stmts){
+        if(!stmts) {
+            this.session.statements = []
+        } else {
+            this.session.statements = stmts.map(s => new SolidityStatement(s[0], s[1]));
+        }
+    }
+
+    dumpSession(){
+        return this.session.statements.map(s => s.toList());
+    }
+
     setSetting(key, value){
+        if(key === 'installedSolidityVersion') return;
         this.settings[key] = value;
     }
 
@@ -120,7 +139,7 @@ class InteractiveSolidityShell {
         const contractState = this.session.statements.filter(stm => stm.scope === "contract");
         const mainStatements = this.session.statements.filter(stm => stm.scope === "main");
 
-        var lastStatement = this.session.statements[this.session.statements.length -1];
+        var lastStatement = this.session.statements[this.session.statements.length -1] || {}
         if(lastStatement.scope !== 'main'){
             /* not a main statement, put everything in the body and use a dummy as returnexpression */
             var mainBody = mainStatements; 
@@ -140,7 +159,7 @@ contract ${this.settings.templateContractName} {
 
     ${contractState.join('    \n\n')}
 
-    function ${this.settings.templateFuncMain}() public returns (${lastStatement.returnType}) {
+    function ${this.settings.templateFuncMain}() public ${lastStatement.returnType ? `returns (${lastStatement.returnType})` : ''} {
         ${mainBody.join('\n        ')}
         return ${lastStatement.returnExpression}
     }
@@ -200,6 +219,7 @@ contract ${this.settings.templateContractName} {
                         this.revert();
                         return reject(err)
                     }
+
                     return resolve(retval) // return value
                 })
             }).catch(errors => {
