Remove solidity-parser-sc completely

Author: area

lib/instrumentSolidity.js

@@ -1,5 +1,4 @@
-const SolidityParser = require('solidity-parser-sc');
-const SolidityParserAntlr = require('solidity-parser-antlr');
+const SolidityParser = require('solidity-parser-antlr');
 const preprocessor = require('./preprocessor');
 const injector = require('./injector');
 const parse = require('./parse');
@@ -21,7 +20,7 @@ module.exports = function instrumentSolidity(contractSource, fileName) {
   contract.injectionPoints = {};
 
   // First, we run over the original contract to get the source mapping.
-  let ast = SolidityParserAntlr.parse(contract.source, {range: true});
+  let ast = SolidityParser.parse(contract.source, {range: true});
   parse[ast.type](contract, ast);
   const retValue = JSON.parse(JSON.stringify(contract));
 
@@ -37,7 +36,7 @@ module.exports = function instrumentSolidity(contractSource, fileName) {
 
   contract.preprocessed = preprocessor.run(contract.source);
   contract.instrumented = contract.preprocessed;
-  ast = SolidityParserAntlr.parse(contract.preprocessed, {range: true});
+  ast = SolidityParser.parse(contract.preprocessed, {range: true});
   const contractStatement = ast.children.filter(node => (node.type === 'ContractDefinition' ||
                                                      node.type === 'LibraryDefinition'  ||
                                                      node.type === 'InterfaceDefinition'));

lib/preprocessor.js

@@ -1,5 +1,5 @@
 const SolExplore = require('sol-explore');
-const SolidityParser = require('solidity-parser-sc');
+const SolidityParser = require('solidity-parser-antlr');
 
 const crRegex = /[\r\n ]+$/g;
 /**
@@ -9,21 +9,27 @@ const crRegex = /[\r\n ]+$/g;
  * @return {String}          contract
  */
 function blockWrap(contract, expression) {
-  return contract.slice(0, expression.start) + '{' + contract.slice(expression.start, expression.end) + '}' + contract.slice(expression.end);
+  return contract.slice(0, expression.range[0]) + '{' + contract.slice(expression.range[0], expression.range[1] + 1) + '}' + contract.slice(expression.range[1] + 1);
 }
 
-
-/**
- * Captures carriage returns at modifiers we'll remove. These need to be re-injected into the
- * source to keep line report alignments accurate.
+/** Remove 'pure' and 'view' from the function declaration.
  * @param  {String} contract solidity source
- * @param  {Object} modifier AST node
- * @return {String} whitespace around the modifier
- */
-function getModifierWhitespace(contract,  modifier){
-  const source = contract.slice(modifier.start, modifier.end);
-  const whitespace = source.match(crRegex) || [];
-  return whitespace.join('');
+ * @param  {Object} function AST node
+ * @return {String} contract with the modifiers removed from the given function.
+*/
+function removePureView(contract, node){
+  let fDefStart = node.range[0];
+  if (node.body){
+    fDefEnd = node.body.range[0];
+  } else if (node.returnParameters) {
+    fDefEnd = node.returnParameters.range[0];
+  } else {
+    fDefEnd = node.range[1];
+  }
+  let fDef = contract.slice(fDefStart, fDefEnd + 1);
+  fDef = fDef.replace(/\bview\b/i, '    ');
+  fDef = fDef.replace(/\bpure\b/i, '    ');
+  return contract.slice(0, fDefStart) + fDef + contract.slice(fDefEnd + 1);
 }
 
 /**
@@ -42,47 +48,42 @@ module.exports.run = function r(contract) {
 
   while (keepRunning) {
     try {
-      const ast = SolidityParser.parse(contract);
+      const ast = SolidityParser.parse(contract, { range: true });
       keepRunning = false;
-      SolExplore.traverse(ast, {
-        enter(node, parent) { // eslint-disable-line no-loop-func
-          // If consequents
-          if (node.type === 'IfStatement' && node.consequent.type !== 'BlockStatement') {
-            contract = blockWrap(contract, node.consequent);
+      SolidityParser.visit(ast, {
+        IfStatement: function(node) {
+          if (node.trueBody.type !== 'Block') {
+            contract = blockWrap(contract, node.trueBody);
             keepRunning = true;
-            this.stopTraversal();
-          // If alternates
-          } else if (
-              node.type === 'IfStatement' &&
-              node.alternate &&
-              node.alternate.type !== 'BlockStatement') {
-            contract = blockWrap(contract, node.alternate);
+            return false;
+          } else if (node.falseBody && node.falseBody.type !== 'Block'){
+            contract = blockWrap(contract, node.falseBody);
             keepRunning = true;
-            this.stopTraversal();
-          // Loops
-          } else if (
-              (node.type === 'ForStatement' || node.type === 'WhileStatement') &&
-              node.body.type !== 'BlockStatement') {
+            return false;
+          }
+        },
+        ForStatement: function(node){
+          if (node.body.type !== 'Block'){
             contract = blockWrap(contract, node.body);
             keepRunning = true;
-            this.stopTraversal();
-          } else if (node.type === 'FunctionDeclaration' && node.modifiers) {
-            // We want to remove constant / pure / view from functions
-            for (let i = 0; i < node.modifiers.length; i++) {
-              if (['pure', 'constant', 'view'].indexOf(node.modifiers[i].name) > -1) {
-                let whitespace = getModifierWhitespace(contract, node.modifiers[i]);
-
-                contract = contract.slice(0, node.modifiers[i].start) +
-                           whitespace +
-                           contract.slice(node.modifiers[i].end);
-
-                keepRunning = true;
-                this.stopTraversal();
-              }
-            }
+            return false;
           }
         },
-      });
+        WhileStatement: function(node){
+          if (node.body.type !== 'Block'){
+            contract = blockWrap(contract, node.body);
+            keepRunning = true;
+            return false;
+          }
+        },
+        FunctionDefinition: function(node){
+          if (node.stateMutability === 'view' || node.stateMutability === 'pure'){
+            contract = removePureView(contract, node);
+            keepRunning = true;
+            return false;
+          }
+        }
+      })
     } catch (err) {
       contract = err;
       keepRunning = false;