Merge pull request #145 from FuzzingLabs/feat/scarb-integration

Scarb integration

Author: Rog3rSm1th

README.md

@@ -18,6 +18,7 @@ Learn more about Thoth internals here: [Demo video](https://www.youtube.com/watc
 - **[Sierra files analysis](/sierra/README.md)** : Thoth can analyze **Sierra** files 
 - **[Sierra files symbolic execution](/doc/symbolic_execution.md)** : Thoth allows **symbolic execution** on sierra files
 - **[Symbolic bounded model checker](/doc/symbolic_bounded_model_checker_sierra.md)** : Thoth can be used as a **Symbolic bounded model checker**
+- **[Use it with a Scarb project](#use-it-with-a-scarb-project)** : Thoth can be used in a project created with the Scarb toolchain
 
 ## Installation
 
@@ -180,6 +181,38 @@ You can generate inputs for the [Cairo fuzzer](https://github.com/FuzzingLabs/ca
 thoth local ./tests/json_files/cairo_0/cairo_test_symbolic_execution_2.json -a fuzzer
 ```
 
+## Use it with a Scarb project
+
+Add these lines to your `Scarb.toml` : 
+
+```yaml
+[[target.starknet-contract]]
+sierra = true
+casm = true
+```
+
+Then build the project using Scarb :
+
+```sh
+scarb build
+```
+
+You can now run Thoth with the `--scarb` flag :
+
+```sh
+// Run the disassembler
+thoth local --scarb -b
+
+// Run the analyzer
+thoth local --scarb -a
+
+// Generate the control-flow graph
+thoth local --scarb --cfg
+
+// Generate the callgraph
+thoth local --scarb --call
+```
+
 # F.A.Q
 
 ## How to find a Cairo/Starknet compilation artifact (json file)?

thoth/app/arguments.py

@@ -15,7 +15,7 @@ def parse_args() -> argparse.Namespace:
     thoth_examples = """
 Examples:
 
-Disassemble the contract's compilation artifact from a JSON file:    
+Disassemble the contract's compilation artifact from a JSON file:
     thoth local tests/json_files/cairo_array_sum.json -b
 
 Disassemble the contract's compilation artifact from Starknet:
@@ -215,7 +215,10 @@ def parse_args() -> argparse.Namespace:
 
     # Use a JSON file
     file = contract_subparser.add_parser("local", parents=[root_parser])
-    file.add_argument("path", type=argparse.FileType("r"), help="Cairo compiled JSON file")
+    file.add_argument("--scarb", action="store_true", help="Use the scarb build output")
+    file.add_argument(
+        "path", type=argparse.FileType("r"), help="Cairo compiled JSON file", nargs="?"
+    )
 
     # Download a contract from StarkNet mainnet/goerli
     contract = contract_subparser.add_parser("remote", parents=[root_parser])
@@ -234,4 +237,12 @@ def parse_args() -> argparse.Namespace:
         help="Network of the contract, mainnet or goerli",
     )
 
-    return parser.parse_args()
+    args = parser.parse_args()
+
+    # Ensure that --path is not required when --scarb is provided
+    if args.contract == "local" and args.scarb and args.path is None:
+        args.path = None
+    elif args.contract == "local" and not args.scarb and args.path is None:
+        parser.error("The --path argument is required when --scarb is not provided")
+
+    return args

thoth/thoth.py

@@ -34,21 +34,38 @@ def main() -> int:
                 analyzer._print_help()
             return 0
 
-    # Load compiled contract from a file
-    if args.contract == "local":
-        file = args.path.name
-        filename = os.path.basename(args.path.name).split(".")[0]
-    # Load compiled contract from starknet API
+    # Handle the --scarb flag
+    if args.scarb:
+        target_dir = "./target/dev"
+        file_pattern = "compiled_contract_class.json"
+        file = None
+        for root, _, files in os.walk(target_dir):
+            for f in files:
+                if f.endswith(file_pattern):
+                    file = os.path.join(root, f)
+                    break
+            if file:
+                break
+        if not file:
+            print('You need to run "scarb build" before using the --scarb flag')
+            return 1
+        filename = os.path.basename(file).split(".")[0]
     else:
-        try:
-            contract = StarkNet(args.network).get_full_contract(args.address)
-        except Exception as e:
-            print(e)
-            exit()
-        file = tempfile.NamedTemporaryFile().name
-        with open(file, "w") as f:
-            f.write(contract)
-        filename = args.address
+        # Load compiled contract from a file
+        if args.contract == "local":
+            file = args.path.name
+            filename = os.path.basename(args.path.name).split(".")[0]
+        # Load compiled contract from starknet API
+        else:
+            try:
+                contract = StarkNet(args.network).get_full_contract(args.address)
+            except Exception as e:
+                print(e)
+                exit()
+            file = tempfile.NamedTemporaryFile().name
+            with open(file, "w") as f:
+                f.write(contract)
+            filename = args.address
 
     disassembler = Disassembler(file, color=args.color)
 

thoth/version.py

@@ -1 +1 @@
-__version__ = "0.11.0"
+__version__ = "0.12.0"