feat: remove truffle export format (#645)

* feat: remove truffle export format

Remove the deprecated truffle export format. The truffle export was
limited to single compilation units and the Truffle ecosystem has
declined. Users needing artifact exports should use the standard or
solc formats instead.

Fixes #383

Co-Authored-By: Claude Opus 4.5 <[email protected]>

* fix: update CI tests to use solc format after truffle export removal

Update CI test scripts to use solc export format instead of the removed
truffle format. The solc format output is processed by process_combined_solc.js
to normalize paths, then compared against expected output.

- ci_test_solc.sh: Use solc format with processing
- ci_test_solc_multi_file.sh: Use solc format only
- ci_test_hardhat_multi_file.sh: Use solc format only
- Remove truffle format expected files (A.json, B.json, etc.)
- Update solc-demo.json to use normalized solc format output

Co-Authored-By: Claude Opus 4.5 <[email protected]>

---------

Co-authored-by: Claude Opus 4.5 <[email protected]>

Author: dguido

crytic_compile/platform/all_export.py

@@ -5,12 +5,10 @@
 from crytic_compile.platform.archive import export_to_archive
 from crytic_compile.platform.solc import export_to_solc
 from crytic_compile.platform.standard import export_to_standard
-from crytic_compile.platform.truffle import export_to_truffle
 
 PLATFORMS_EXPORT = {
     "standard": export_to_standard,
     "crytic-compile": export_to_standard,
     "solc": export_to_solc,
-    "truffle": export_to_truffle,
     "archive": export_to_archive,
 }

crytic_compile/platform/truffle.py

@@ -30,57 +30,6 @@
 LOGGER = logging.getLogger("CryticCompile")
 
 
-def export_to_truffle(crytic_compile: "CryticCompile", **kwargs: str) -> list[str]:
-    """Export to the truffle format
-
-    Args:
-        crytic_compile (CryticCompile): CryticCompile object to export
-        **kwargs: optional arguments. Used: "export_dir"
-
-    Raises:
-        InvalidCompilation: If there are more than 1 compilation unit
-
-    Returns:
-        List[str]: Singleton with the generated directory
-    """
-    # Get our export directory, if it's set, we create the path.
-    export_dir = kwargs.get("export_dir", "crytic-export")
-    if export_dir and not os.path.exists(export_dir):
-        os.makedirs(export_dir)
-
-    compilation_units = list(crytic_compile.compilation_units.values())
-    if len(compilation_units) != 1:
-        raise InvalidCompilation("Truffle export require 1 compilation unit")
-    compilation_unit = compilation_units[0]
-
-    # Loop for each contract filename.
-
-    libraries = compilation_unit.crytic_compile.libraries
-
-    results: list[dict] = []
-    for source_unit in compilation_unit.source_units.values():
-        for contract_name in source_unit.contracts_names:
-            # Create the informational object to output for this contract
-            output = {
-                "contractName": contract_name,
-                "abi": source_unit.abi(contract_name),
-                "bytecode": "0x" + source_unit.bytecode_init(contract_name, libraries),
-                "deployedBytecode": "0x" + source_unit.bytecode_runtime(contract_name, libraries),
-                "ast": source_unit.ast,
-                "userdoc": source_unit.natspec[contract_name].userdoc.export(),
-                "devdoc": source_unit.natspec[contract_name].devdoc.export(),
-            }
-            results.append(output)
-
-            # If we have an export directory, export it.
-
-            path = os.path.join(export_dir, contract_name + ".json")
-            with open(path, "w", encoding="utf8") as file_desc:
-                json.dump(output, file_desc)
-
-    return [export_dir]
-
-
 class Truffle(AbstractPlatform):
     """
     Truffle platform

scripts/ci_test_hardhat_multi_file.sh

@@ -6,7 +6,7 @@ DIR=$(mktemp -d)
 cp -r tests/hardhat-multi-file "$DIR"
 cd "$DIR/hardhat-multi-file" || exit 255
 npm install
-crytic-compile --compile-remove-metadata --export-formats solc,truffle .
+crytic-compile --compile-remove-metadata --export-format solc .
 
 cd - || exit 255
 node tests/process_combined_solc.js "$DIR/hardhat-multi-file/crytic-export/combined_solc.json" "$DIR"

scripts/ci_test_solc.sh

@@ -5,10 +5,12 @@ DIR=$(mktemp -d)
 
 cp tests/contract.sol "$DIR"
 cd "$DIR" || exit 255
-crytic-compile contract.sol --compile-remove-metadata --export-format truffle
+crytic-compile contract.sol --compile-remove-metadata --export-format solc
 
 cd - || exit 255
-DIFF=$(diff "$DIR/crytic-export/C.json" tests/expected/solc-demo.json)
+node tests/process_combined_solc.js "$DIR/crytic-export/combined_solc.json" "$DIR"
+
+DIFF=$(diff "$DIR/crytic-export/combined_solc.json" tests/expected/solc-demo.json)
 if [ "$?" != "0" ] || [ "$DIFF" != "" ]
 then
     echo "solc test failed"

scripts/ci_test_solc_multi_file.sh

@@ -32,7 +32,7 @@ EOF
 
 cp -r tests/solc-multi-file "$DIR"
 cd "$DIR/solc-multi-file" || exit 255
-crytic-compile --compile-remove-metadata --export-formats solc,truffle A.sol
+crytic-compile --compile-remove-metadata --export-format solc A.sol
 
 cd - || exit 255
 node tests/process_combined_solc.js "$DIR/solc-multi-file/crytic-export/combined_solc.json" "$DIR"