Merge pull request #6 from tintinweb/fix/remoteCompiler

prep v0.0.7 - better remote compiler handling; new keywords

Author: tintinweb

CHANGELOG.md

@@ -1,6 +1,16 @@
 # Change Log
 All notable changes will be documented in this file.
 
+
+## v0.0.7
+- fix: rework remote compiler
+  - added a remoteCompiler wrapper
+- fix: always use latest compiler shipped with this package by default
+  - new: ship with solc 0.8.10
+  - preference: use solc shipped with package by default, else check static solcVersions list and fetch remote compiler, else update solcVersions list and fetch remote compiler.
+- fix: better error handling when changing compiler version
+- new: support `error` keyword and fix memory/storage type declarations
+
 ## v0.0.6
 - fix: handle interface declarations
 

package-lock.json

@@ -1,13 +1,13 @@
 {
   "name": "solidity-shell",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "",
   "main": "src/index.js",
   "bin": {
     "solidity-shell": "bin/main.js"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "updateCompilerList": "node scripts/UpdateCompilerList.js > src/solcVersions.js"
   },
   "author": {
     "name": "tintinweb",
@@ -26,7 +26,8 @@
   "license": "MIT",
   "dependencies": {
     "readline-sync": "^1.4.10",
-    "solc": "^0.8.7-fixed",
+    "request": "^2.88.2",
+    "solc": "^0.8.10",
     "vorpal": "^1.12.0",
     "web3": "^1.5.2"
   }

package.json

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+'use strict'
+/**
+ * @author github.com/tintinweb
+ * @license MIT
+ * */
+const { getSolcJsCompilerList } = require('../src/remoteCompiler');
+
+
+getSolcJsCompilerList({nightly:false}).then(compilers => {
+    console.log(`'use strict'
+/**
+ * @author github.com/tintinweb
+ * @license MIT
+ * */
+    
+//autogenerated with # npm run updateCompilerList
+module.exports.solcVersions = ${JSON.stringify(compilers, null, 4)}`);
+})
+

scripts/updateCompilerList.js

@@ -6,11 +6,12 @@
 /** IMPORT */
 const Web3 = require('web3')
 const solc = require('solc')
-const { solcVersions } = require('./solcVersions.js')
+const { getRemoteCompiler } = require('./remoteCompiler.js')
 
 /** CONST */
 const rexTypeError = /Return argument type (.*) is not implicitly convertible to expected type \(type of first return variable\)/;
-const rexAssign = /[^=]=[^=]/;
+const rexAssign = /[^=]=[^=];?/;
+const rexTypeDecl = /^([\w\[\]]+\s(memory|storage)?\s*\w+);?$/
 const IGNORE_WARNINGS = [
     "Statement has no effect.",
     "Function state mutability can be restricted to ",
@@ -45,15 +46,19 @@ class SolidityStatement {
 
     constructor(rawCommand, scope) {
         this.rawCommand = rawCommand ? rawCommand.trim() : "";
-        this.hasNoReturnValue = (rexAssign.test(this.rawCommand)) || (this.rawCommand.startsWith('delete')) || (this.rawCommand.startsWith('assembly')) || (this.rawCommand.startsWith('revert'))
+        this.hasNoReturnValue = (rexAssign.test(this.rawCommand)) 
+            || (this.rawCommand.startsWith('delete')) 
+            || (this.rawCommand.startsWith('assembly')) 
+            || (this.rawCommand.startsWith('revert'))
+            || (rexTypeDecl.test(this.rawCommand))
 
         if (scope) {
             this.scope = scope
         } else {
             if (this.rawCommand.startsWith('function ') || this.rawCommand.startsWith('modifier ')) {
                 this.scope = SCOPE.CONTRACT;
                 this.hasNoReturnValue = true;
-            } else if (this.rawCommand.startsWith('mapping ') || this.rawCommand.startsWith('event ')) {
+            } else if (this.rawCommand.startsWith('mapping ') || this.rawCommand.startsWith('event ') || this.rawCommand.startsWith('error ')) {
                 this.scope = SCOPE.CONTRACT;
                 this.hasNoReturnValue = true;
             } else if (this.rawCommand.startsWith('pragma solidity ')) {
@@ -111,7 +116,7 @@ class InteractiveSolidityShell {
         const defaults = {
             templateContractName: 'MainContract',
             templateFuncMain: 'main',
-            installedSolidityVersion: require('../package.json').dependencies.solc.split("-", 1)[0],
+            installedSolidityVersion: null, // overridden after merging settings; never use configured value
             providerUrl: 'http://localhost:8545',
             autostartGanache: true,
             ganacheCmd: 'ganache-cli',
@@ -122,6 +127,8 @@ class InteractiveSolidityShell {
             ...defaults, ... (settings || {})
         };
 
+        this.settings.installedSolidityVersion = require('../package.json').dependencies.solc.split("-", 1)[0];
+
         this.cache = {
             compiler: {} /** compilerVersion:object */
         }
@@ -203,35 +210,38 @@ contract ${this.settings.templateContractName} {
 
 
     loadCachedCompiler(solidityVersion) {
-        solidityVersion = solidityVersion.startsWith("^") ? solidityVersion.substring(1) : solidityVersion; //strip leading ^
-        /** load remote version - (maybe cache?) */
-        if(this.cache.compiler[solidityVersion]){
-            return new Promise((resolve, reject) => {
-                return resolve(this.cache.compiler[solidityVersion]);
-            });
-        }
-
-        var remoteSolidityVersion = solcVersions.find(
-            (e) => !e.includes('nightly') && e.includes(`v${solidityVersion}`)
-        )
 
+        solidityVersion = solidityVersion.startsWith("^") ? solidityVersion.substring(1) : solidityVersion; //strip leading ^
         var that = this;
+        /** load remote version - (maybe cache?) */
 
         return new Promise((resolve, reject) => {
-            solc.loadRemoteVersion(remoteSolidityVersion, function (err, solcSnapshot) {
-                that.cache.compiler[solidityVersion] = solcSnapshot;
-                return resolve(solcSnapshot)
-            })
+            if(that.cache.compiler[solidityVersion]){
+                return resolve(that.cache.compiler[solidityVersion]);
+            }
+
+            getRemoteCompiler(solidityVersion)
+                .then(remoteSolidityVersion => {
+                    solc.loadRemoteVersion(remoteSolidityVersion, function (err, solcSnapshot) {
+                        that.cache.compiler[solidityVersion] = solcSnapshot;
+                        return resolve(solcSnapshot)
+                    })
+                })
+                .catch(err => {
+                    return reject(err)
+                })
         });
 
     }
 
     compile(source, cbWarning) {
-
         let solidityVersion = getBestSolidityVersion(source);
 
         return new Promise((resolve, reject) => {
 
+            if(!solidityVersion){
+                return reject(new Error(`No valid solidity version found in source code (e.g. pragma solidity 0.8.10).`));
+            }
             this.loadCachedCompiler(solidityVersion).then(solcSelected => {
 
                 let input = {
@@ -263,6 +273,9 @@ contract ${this.settings.templateContractName} {
 
                 }
                 return resolve(ret);
+            })
+            .catch(err => {
+                return reject(err);
             });
 
 
@@ -296,6 +309,11 @@ contract ${this.settings.templateContractName} {
                 })
             }).catch(errors => {
                 // frownie face
+                
+                if(!Array.isArray(errors)){ //handle single error
+                    this.revert();
+                    return reject(errors);
+                }
                 //get last typeError to detect return type:
                 let lastTypeError = errors.slice().reverse().find(err => err.type === "TypeError");
                 if (!lastTypeError) {

src/handler.js

@@ -1,3 +1,4 @@
+'use strict'
 /**
  * @author github.com/tintinweb
  * @license MIT

src/index.js

@@ -0,0 +1,63 @@
+'use strict'
+/**
+ * @author github.com/tintinweb
+ * @license MIT
+ * */
+/** IMPORT */
+const { solcVersions } = require('./solcVersions.js')
+const request = require('request');
+
+function normalizeSolcVersion(version) {
+    return version.replace('soljson-', '').replace('.js', '');
+}
+
+function getSolcJsCompilerList(options){
+    options = options || {};
+    return new Promise((resolve, reject) => {
+        request.get('https://solc-bin.ethereum.org/bin/list.json', (err, res, body) => {
+            if(err){
+                return reject(err)
+            }else{
+                let data = JSON.parse(body);
+                let releases = Object.values(data.releases)
+
+                if(options.nightly){
+                    releases = Array.from(new Set([...releases, ...data.builds.map(b => b.path)]));
+                }
+                return resolve(releases.map(normalizeSolcVersion))
+            }
+        })
+    });
+}
+
+function getRemoteCompiler(solidityVersion) {
+    return new Promise((resolve, reject) => {
+
+        //check if version is in static list (avoid http requests)
+        let remoteSolidityVersion = solcVersions.find(
+            (e) => !e.includes('nightly') && e.includes(`v${solidityVersion}`)
+        )
+
+        if (remoteSolidityVersion) { 
+            return resolve(remoteSolidityVersion);
+        }
+        //download remote compiler list and check again.
+        getSolcJsCompilerList().then(solcJsCompilerList => {
+            let found = solcJsCompilerList.find(
+                (e) => !e.includes('nightly') && e.includes(`v${solidityVersion}`)
+            )
+            if (found) {
+                return resolve(found);
+            }
+            return reject(new Error(`No compiler found for version ${solidityVersion}`));
+        })
+
+    });
+}
+
+
+module.exports = {
+    getRemoteCompiler,
+    getSolcJsCompilerList
+}
+

src/remoteCompiler.js

@@ -1,9 +1,9 @@
+'use strict'
 /**
  * @author github.com/tintinweb
  * @license MIT
  * */
 
-
 function convert(str){
     switch(str){
         case '': return undefined; 
@@ -33,6 +33,8 @@ function multilineInput(command){
     return command;
 }
 
+
+
 module.exports = {
     convert,
     multilineInput