Add Dapp support (close #1)

Add --compile-force-framework flag

Author: montyly

.travis.yml

@@ -8,6 +8,7 @@ env:
   - TEST_SUITE=scripts/travis_test_solc.sh
   - TEST_SUITE=scripts/travis_test_truffle.sh
   - TEST_SUITE=scripts/travis_test_embark.sh
+  - TEST_SUITE=scripts/travis_test_dapp.sh
 branches:
   only:
   - master

README.md

@@ -9,6 +9,7 @@ Library to help smart contract compilation. It includes support for:
 - Direct solc compilation
 - [Truffle](https://truffleframework.com/)
 - [Embark](https://embark.status.im/)
+- [Dapp](https://dapp.tools/dapp/)
 
 The plugin is used in Crytic tools, including:
 - [Slither](https://github.com/crytic/slither)

crytic_compile/crytic_compile.py

@@ -3,8 +3,9 @@
 import logging
 
 from .platform.solc import compile as compile_solc, export as export_solc
-from .platform.truffle import compile as compile_truffle, export as export_truffle
-from .platform.embark import compile as compile_embark
+from .platform.truffle import is_truffle, compile as compile_truffle, export as export_truffle
+from .platform.embark import is_embark, compile as compile_embark
+from .platform.dapp import is_dapp, compile as compile_dapp#, export as export_truffle
 from .utils.naming import combine_filename_name
 
 logger = logging.getLogger("CryticCompile")
@@ -139,21 +140,33 @@ def _export_standard(self, **kwargs):
             json.dump(output, f)
 
 
+
     def _run(self, target, **kwargs):
 
         truffle_ignore = kwargs.get('truffle_ignore', False)
         embark_ignore = kwargs.get('embark_ignore', False)
-
-        # truffle directory
-        if not truffle_ignore and (os.path.isfile(os.path.join(target, 'truffle.js')) or
-                                     os.path.isfile(os.path.join(target, 'truffle-config.js'))):
-            compile_truffle(self, target, **kwargs)
-        # embark directory
-        elif not embark_ignore and os.path.isfile(os.path.join(target, 'embark.json')):
-            compile_embark(self, target, **kwargs)
-        # .json or .sol provided
+        dapp_ignore = kwargs.get('dapp_ignore', False)
+
+        compilation_force_framework = kwargs.get('compilation_force_framework', None)
+        if compilation_force_framework:
+            if compilation_force_framework == 'truffle':
+                compile_truffle(self, target, **kwargs)
+            elif compilation_force_framework == 'embark':
+                compile_embark(self, target, **kwargs)
+            elif compilation_force_framework == 'dapp':
+                compile_dapp(self, target, **kwargs)
         else:
-            compile_solc(self, target, **kwargs)
+            # truffle directory
+            if not truffle_ignore and is_truffle(target):
+                compile_truffle(self, target, **kwargs)
+            # embark directory
+            elif not embark_ignore and is_embark(target):
+                compile_embark(self, target, **kwargs)
+            elif not dapp_ignore and is_dapp(target):
+                compile_dapp(self, target, **kwargs)
+            # .json or .sol provided
+            else:
+                compile_solc(self, target, **kwargs)
 
 
 

crytic_compile/cryticparser/cryticparser.py

@@ -1,9 +1,17 @@
 from . import defaults_flag_in_config
 
 def init(parser):
+
+    group_solc = parser.add_argument_group('Compilation options')
+    group_solc.add_argument('--compile-force-framework',
+                            help='Force the compilation to a given framework (truffle, embark, dapp)',
+                            action='store',
+                            default=defaults_flag_in_config['compilation_force_framework'])
+
     init_solc(parser)
     init_truffle(parser)
     init_embark(parser)
+    init_dapp(parser)
 
 def init_solc(parser):
     group_solc = parser.add_argument_group('Solc options')
@@ -56,3 +64,11 @@ def init_embark(parser):
                               action='store_true',
                               default=defaults_flag_in_config['embark_overwrite_config'])
 
+def init_dapp(parser):
+    group_dapp = parser.add_argument_group('Dapp options')
+    group_dapp.add_argument('--dapp-ignore-compile',
+                            help='Do not run dapp build',
+                            action='store_true',
+                            dest='dapp_ignore_compile',
+                            default=defaults_flag_in_config['dapp_ignore_compile'])
+

crytic_compile/cryticparser/defaults.py

@@ -1,5 +1,6 @@
 # Those are the flags shared by the command line and the config file
 defaults_flag_in_config = {
+    'compilation_force_framework': None,
     'solc': 'solc',
     'solc_args': None,
     'solc_disable_warnings': False,
@@ -8,4 +9,5 @@
     'truffle_build_directory': 'build/contracts',
     'embark_ignore_compile': False,
     'embark_overwrite_config': False,
+    'dapp_ignore_compile': False,
 }

crytic_compile/platform/dapp.py

@@ -0,0 +1,90 @@
+import os
+import json
+import logging
+import glob
+
+
+import subprocess
+
+from .types import Type
+from ..utils.naming import extract_filename, extract_name, combine_filename_name
+
+logger = logging.getLogger("CryticCompile")
+
+
+def compile(crytic_compile, target, **kwargs):
+    crytic_compile.type = Type.DAPP
+    dapp_ignore_compile = kwargs.get('dapp_ignore_compile', False)
+    dir = os.path.join(target, "out")
+
+    if not dapp_ignore_compile:
+        _run_dapp()
+
+    files = glob.glob(dir + '/**/*.sol.json', recursive=True)
+    for file in files:
+        with open(file) as f:
+            targets_json = json.load(f)
+        for original_contract_name, info in targets_json["contracts"].items():
+            contract_name = extract_name(original_contract_name)
+            contract_filename = extract_filename(original_contract_name)
+            crytic_compile.contracts_name.add(contract_name)
+            crytic_compile.contracts_filenames[contract_name] = contract_filename
+            crytic_compile.abis[contract_name] = json.loads(info['abi'])
+            crytic_compile.init_bytecodes[contract_name] = info['bin']
+            crytic_compile.runtime_bytecodes[contract_name] = info['bin-runtime']
+
+        for path, info in targets_json["sources"].items():
+            crytic_compile.filenames.add(path)
+            crytic_compile.asts[path] = info['AST']
+
+
+def export(crytic_compile, **kwargs):
+    export_dir = kwargs.get('export_dir', 'crytic-export')
+    if not os.path.exists(export_dir):
+        os.makedirs(export_dir)
+    path = os.path.join(export_dir, "combined_solc.json")
+
+    with open(path, 'w') as f:
+        contracts = dict()
+        for contract_name in crytic_compile.contracts_name:
+            abi = str(crytic_compile.abi(contract_name))
+            abi = abi.replace('\'', '\"')
+            abi = abi.replace('True', 'true')
+            abi = abi.replace('False', 'false')
+            abi = abi.replace(' ', '')
+            exported_name = combine_filename_name(crytic_compile.contracts_filenames[contract_name], contract_name)
+            contracts[exported_name] = {
+                'srcmap': '',
+                'srcmap-runtime': '',
+                'abi': abi,
+                'bin': crytic_compile.init_bytecode(contract_name),
+                'bin-runtime': crytic_compile.runtime_bytecode(contract_name)
+            }
+
+        sources = {filename : {"AST": ast} for (filename, ast) in crytic_compile.asts.items()}
+        sourceList = crytic_compile.filenames
+
+        output = {'sources' : sources,
+                  'sourceList' : sourceList,
+                  'contracts': contracts}
+
+        json.dump(output, f)
+
+def is_dapp(target):
+    """
+    Heuristic used: check if "dapp build" is present in Makefile
+    :param target:
+    :return:
+    """
+    makefile = os.path.join(target, "Makefile")
+    if os.path.isfile(makefile):
+        with open(makefile) as f:
+            txt = f.read()
+            return "dapp build" in txt
+    return False
+
+def _run_dapp():
+    cmd = ["dapp", "build"]
+
+    process = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    _, _ = process.communicate()

crytic_compile/platform/embark.py

@@ -66,3 +66,6 @@ def compile(crytic_compile, target, **kwargs):
                 crytic_compile.init_bytecodes[contract_name] = info['bin'].replace('0x', '')
             if 'bin-runtime' in info:
                 crytic_compile.runtime_bytecodes[contract_name] = info['bin-runtime'].replace('0x', '')
+
+def is_embark(target):
+    return os.path.isfile(os.path.join(target, 'embark.json'))

crytic_compile/platform/truffle.py

@@ -75,4 +75,9 @@ def export(crytic_compile, **kwargs):
                 "deployedBytecode": "0x" + crytic_compile.runtime_bytecode(contract_name),
                 "ast": crytic_compile.ast(filename)
             }
-            json.dump(output, f)
+            json.dump(output, f)
+
+
+def is_truffle(target):
+    return (os.path.isfile(os.path.join(target, 'truffle.js')) or
+     os.path.isfile(os.path.join(target, 'truffle-config.js')))

crytic_compile/platform/types.py

@@ -4,4 +4,5 @@ class Type(Enum):
     SOLC = 1
     TRUFFLE = 2
     EMBARK = 3
+    DAPP = 4
 

scripts/travis_test_dapp.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+### Test dapp integration
+
+mkdir test_dapp
+cd test_dapp
+
+
+curl https://nixos.org/nix/install | sh
+. "$HOME/.nix-profile/etc/profile.d/nix.sh"
+git clone --recursive https://github.com/dapphub/dapptools $HOME/.dapp/dapptools
+nix-env -f $HOME/.dapp/dapptools -iA dapp seth solc hevm ethsign
+
+dapp init
+
+crytic-compile .
+
+DIFF=$(diff crytic-export/contracts.json ../tests/expected/dapp-demo.json)
+if [ $DIFF != "" ]
+then  
+    echo "Dapp test failed"
+    exit -1
+fi
+