feat[tool]: add settings dict to combined_json output (#4541)

charles-cooper · web-flow · commit 533682df9895 · 2025-05-26T10:18:37.000Z
this commit adds the compiler settings used for this compilation run
as a dict entry in the `combined_json` output. this is useful for
explorers and tooling, which then have a reliable way of knowing which
settings were used for the compilation, instead of having to rely on
heuristics.
diff --git a/tests/unit/cli/vyper_compile/test_compile_files.py b/tests/unit/cli/vyper_compile/test_compile_files.py
@@ -14,6 +14,7 @@
 from vyper.compiler.input_bundle import FilesystemInputBundle
 from vyper.compiler.output_bundle import OutputBundle
 from vyper.compiler.phases import CompilerData
+from vyper.compiler.settings import Settings
 from vyper.utils import sha256sum
 
 TAMPERED_INTEGRITY_SUM = sha256sum("tampered integrity sum")
@@ -37,13 +38,26 @@ def test_combined_json_keys(chdir_tmp_path, make_file):
         "method_identifiers",
         "userdoc",
         "devdoc",
+        "settings_dict",
     }
     compile_data = compile_files(["bar.vy"], ["combined_json"])
 
     assert set(compile_data.keys()) == {Path("bar.vy"), "version"}
     assert set(compile_data[Path("bar.vy")].keys()) == combined_keys
 
 
+def test_combined_json_settings_output(chdir_tmp_path, make_file, compiler_settings):
+    make_file("bar.vy", "")
+
+    compile_data = compile_files(["bar.vy"], ["combined_json"])
+    output_settings = compile_data[Path("bar.vy")]["settings_dict"]
+
+    # test output settings == expected settings
+    assert output_settings == compiler_settings.as_dict()
+    # test round-trip
+    assert Settings.from_dict(output_settings) == compiler_settings
+
+
 def test_invalid_root_path():
     with pytest.raises(FileNotFoundError):
         compile_files([], [], paths=["path/that/does/not/exist"])
diff --git a/vyper/cli/vyper_compile.py b/vyper/cli/vyper_compile.py
@@ -50,6 +50,7 @@
 integrity          - Output the integrity hash of the source code
 archive            - Output the build as an archive file
 solc_json          - Output the build in solc json format
+settings           - Output the settings for a given build in json format
 """
 
 combined_json_outputs = [
@@ -63,6 +64,7 @@
     "method_identifiers",
     "userdoc",
     "devdoc",
+    "settings_dict",
 ]
 
 
@@ -343,6 +345,7 @@ def compile_files(
         "ast": "ast_dict",
         "annotated_ast": "annotated_ast_dict",
         "ir_json": "ir_dict",
+        "settings": "settings_dict",
     }
     final_formats = [translate_map.get(i, i) for i in output_formats]
 
diff --git a/vyper/compiler/__init__.py b/vyper/compiler/__init__.py
@@ -33,6 +33,7 @@
     "ir_runtime_dict": output.build_ir_runtime_dict_output,
     "method_identifiers": output.build_method_identifiers_output,
     "metadata": output.build_metadata_output,
+    "settings_dict": output.build_settings_output,
     # requires assembly
     "abi": output.build_abi_output,
     "asm": output.build_asm_output,
diff --git a/vyper/compiler/output.py b/vyper/compiler/output.py
@@ -211,6 +211,10 @@ def build_ir_runtime_dict_output(compiler_data: CompilerData) -> dict:
     return _ir_to_dict(compiler_data.ir_runtime)
 
 
+def build_settings_output(compiler_data: CompilerData) -> dict:
+    return compiler_data.settings.as_dict()
+
+
 def build_metadata_output(compiler_data: CompilerData) -> dict:
     # need ir info to be computed
     _ = compiler_data.function_signatures
