Introduce experimental option in standard JSON

nikola-matic · nikola-matic · commit 251837823903 · 2025-11-20T12:55:25.000+01:00
diff --git a/libsolidity/interface/StandardCompiler.cpp b/libsolidity/interface/StandardCompiler.cpp
@@ -307,6 +307,21 @@ bool isEthdebugRequested(Json const& _outputSelection)
 	return false;
 }
 
+bool isExperimentalArtifactRequested(Json const& _outputSelection)
+{
+	std::set<std::string> experimentalArtifacts{"irAst", "irOptimizedAst", "yulCFGJson"};
+	if (!_outputSelection.is_object())
+		return false;
+
+	for (auto const& fileRequests: _outputSelection)
+		for (auto const& requests: fileRequests)
+			for (auto const& request: requests)
+				if (experimentalArtifacts.contains(request))
+					return true;
+
+	return false;
+}
+
 /// @returns The set of selected contracts, along with their compiler pipeline configuration, based
 /// on outputs requested in the JSON. Translates wildcards to the ones understood by CompilerStack.
 /// Note that as an exception, '*' does not yet match "ir", "irAst", "irOptimized" or "irOptimizedAst".
@@ -430,7 +445,7 @@ std::optional<Json> checkAuxiliaryInputKeys(Json const& _input)
 
 std::optional<Json> checkSettingsKeys(Json const& _input)
 {
-	static std::set<std::string> keys{"debug", "evmVersion", "eofVersion", "libraries", "metadata", "modelChecker", "optimizer", "outputSelection", "remappings", "stopAfter", "viaIR"};
+	static std::set<std::string> keys{"debug", "evmVersion", "experimental", "eofVersion", "libraries", "metadata", "modelChecker", "optimizer", "outputSelection", "remappings", "stopAfter", "viaIR"};
 	return checkKeys(_input, keys, "settings");
 }
 
@@ -803,6 +818,13 @@ std::variant<StandardCompiler::InputsAndSettings, Json> StandardCompiler::parseI
 	if (auto result = checkSettingsKeys(settings))
 		return *result;
 
+	if (settings.contains("experimental"))
+	{
+		if (!settings["experimental"].is_boolean())
+			return formatFatalError(Error::Type::JSONError, "\"settings.experimental\" must be a Boolean.");
+		ret.experimental = settings["experimental"].get<bool>();
+	}
+
 	if (settings.contains("stopAfter"))
 	{
 		if (!settings["stopAfter"].is_string())
@@ -1213,6 +1235,21 @@ std::variant<StandardCompiler::InputsAndSettings, Json> StandardCompiler::parseI
 		if (ret.optimiserSettings.runYulOptimiser)
 			solUnimplemented("Optimization is not yet supported with ethdebug.");
 
+	if (!ret.experimental)
+	{
+		if (ret.language == "SolidityAST" || ret.language == "EVMAssembly")
+			return formatFatalError(Error::Type::FatalError, "'SolidityAST' and 'EVMAssembly' inputs are experimental, and can only be used by toggling the 'settings.experimental' option.");
+
+		if (isExperimentalArtifactRequested(ret.outputSelection))
+			return formatFatalError(Error::Type::FatalError, "'irAst', 'irOptimizedAst' and 'yulCFGJson' outputs are experimental, and can only be used by toggling the 'settings.experimental' option.");
+
+		if (isEthdebugRequested(ret.outputSelection))
+			return formatFatalError(Error::Type::FatalError, "'settings.debug.debugInfo.ethdebug' is experimental, and can only be used by toggling the 'settings.experimental' option.");
+
+		if (ret.eofVersion)
+			return formatFatalError(Error::Type::FatalError, "'eofVersion' is experimental, and can only be used by toggling the 'settings.experimental' option.");
+	}
+
 	return {std::move(ret)};
 }
 
@@ -1373,6 +1410,7 @@ Json StandardCompiler::compileSolidity(StandardCompiler::InputsAndSettings _inpu
 	compilerStack.setMetadataHash(_inputsAndSettings.metadataHash);
 	compilerStack.selectContracts(pipelineConfig(_inputsAndSettings.outputSelection));
 	compilerStack.setModelCheckerSettings(_inputsAndSettings.modelCheckerSettings);
+	compilerStack.setExperimental(_inputsAndSettings.experimental);
 
 	Json errors = std::move(_inputsAndSettings.errors);
 
diff --git a/libsolidity/interface/StandardCompiler.h b/libsolidity/interface/StandardCompiler.h
@@ -89,6 +89,7 @@ class StandardCompiler
 		Json outputSelection;
 		ModelCheckerSettings modelCheckerSettings = ModelCheckerSettings{};
 		bool viaIR = false;
+		bool experimental = false;
 	};
 
 	/// Parses the input json (and potentially invokes the read callback) and either returns
diff --git a/scripts/ASTImportTest.sh b/scripts/ASTImportTest.sh
@@ -139,7 +139,7 @@ function test_ast_import_export_equivalence
     echo ". += {\"sources\":" > _ast_json.json
     jq .sources expected.json >> _ast_json.json
     echo "}" >> _ast_json.json
-    echo "{\"language\": \"SolidityAST\", \"settings\": {\"outputSelection\": {\"*\": {\"\": [\"ast\"]}}}}" > standard_json.json
+    echo "{\"language\": \"SolidityAST\", \"settings\": {\"experimental\": true, \"outputSelection\": {\"*\": {\"\": [\"ast\"]}}}}" > standard_json.json
     jq --from-file _ast_json.json standard_json.json > standard_json_input.json
 
     # (re)import ast via standard json - and export it again as obtained result (silently)
diff --git a/test/cmdlineTests/import_asm_json_standard_json_no_optimize/input.json b/test/cmdlineTests/import_asm_json_standard_json_no_optimize/input.json
@@ -28,6 +28,7 @@
         }
     },
     "settings": {
+        "experimental": true,
         "outputSelection": {
             "*": {
                 "": ["evm.assembly"]
diff --git a/test/cmdlineTests/import_asm_json_standard_json_optimize/input.json b/test/cmdlineTests/import_asm_json_standard_json_optimize/input.json
@@ -28,6 +28,7 @@
         }
     },
     "settings": {
+        "experimental": true,
         "outputSelection": {
             "*": {
                 "": ["evm.assembly"]
diff --git a/test/cmdlineTests/standard_import_asm_json/input.json b/test/cmdlineTests/standard_import_asm_json/input.json
@@ -19,6 +19,7 @@
         }
     },
     "settings": {
+        "experimental": true,
         "outputSelection": {
             "*": {
                 "": ["*"]
diff --git a/test/cmdlineTests/standard_import_asm_json_immutable_references/input.json b/test/cmdlineTests/standard_import_asm_json_immutable_references/input.json
@@ -34,6 +34,7 @@
         }
     },
     "settings": {
+        "experimental": true,
         "outputSelection": {
             "*": {
                 "": [
diff --git a/test/cmdlineTests/standard_import_asm_json_invalid_opcode/input.json b/test/cmdlineTests/standard_import_asm_json_invalid_opcode/input.json
@@ -19,6 +19,7 @@
         }
     },
     "settings": {
+        "experimental": true,
         "outputSelection": {
             "*": {
                 "": ["evm.bytecode"]
diff --git a/test/cmdlineTests/standard_import_asm_json_link_references/input.json b/test/cmdlineTests/standard_import_asm_json_link_references/input.json
@@ -26,6 +26,7 @@
         }
     },
     "settings": {
+        "experimental": true,
         "outputSelection": {
             "*": {
                 "": [
diff --git a/test/cmdlineTests/standard_import_asm_json_no_output_selection/input.json b/test/cmdlineTests/standard_import_asm_json_no_output_selection/input.json
@@ -19,6 +19,7 @@
         }
     },
     "settings": {
+        "experimental": true,
         "outputSelection": {
             "*": {
                 "": [
diff --git a/test/cmdlineTests/standard_import_ast/input.json b/test/cmdlineTests/standard_import_ast/input.json
@@ -83,6 +83,7 @@
 		}
 	},
 	"settings": {
+		"experimental": true,
 		"outputSelection": {
 			"*": {
 				"": [
diff --git a/test/cmdlineTests/standard_import_ast_select_bytecode/input.json b/test/cmdlineTests/standard_import_ast_select_bytecode/input.json
@@ -38,6 +38,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "outputSelection": {
       "*": {
         "*": [
diff --git a/test/cmdlineTests/standard_import_with_comments/input.json b/test/cmdlineTests/standard_import_with_comments/input.json
@@ -84,6 +84,7 @@
 		}
 	},
 	"settings": {
+		"experimental": true,
 		"outputSelection": {
 			"*": {
 				"": [
diff --git a/test/cmdlineTests/standard_import_with_comments_simple/input.json b/test/cmdlineTests/standard_import_with_comments_simple/input.json
@@ -76,6 +76,7 @@
 		}
 	},
 	"settings": {
+		"experimental": true,
 		"outputSelection": {
 			"*": {
 				"": ["ast"]
diff --git a/test/cmdlineTests/standard_irOptimized_ast_requested/input.json b/test/cmdlineTests/standard_irOptimized_ast_requested/input.json
@@ -4,6 +4,7 @@
 		"C": {"urls": ["in.sol"]}
 	},
 	"settings": {
+		"experimental": true,
 		"outputSelection": {"*": {"*": ["irOptimizedAst"]}}
 	}
 }
diff --git a/test/cmdlineTests/standard_ir_ast_requested/input.json b/test/cmdlineTests/standard_ir_ast_requested/input.json
@@ -4,6 +4,7 @@
 		"C": {"urls": ["in.sol"]}
 	},
 	"settings": {
+		"experimental": true,
 		"outputSelection": {"*": {"*": ["irAst"]}}
 	}
 }
diff --git a/test/cmdlineTests/standard_no_experimental_ast_import/input.json b/test/cmdlineTests/standard_no_experimental_ast_import/input.json
@@ -0,0 +1,8 @@
+{
+    "language": "SolidityAST",
+    "sources": {
+        "A.sol": {
+            "content": "contract A { constructor() { uint x = 2; { uint y = 3; } } }"
+        }
+  }
+}
diff --git a/test/cmdlineTests/standard_no_experimental_ast_import/output.json b/test/cmdlineTests/standard_no_experimental_ast_import/output.json
@@ -0,0 +1,11 @@
+{
+    "errors": [
+        {
+            "component": "general",
+            "formattedMessage": "'SolidityAST' and 'EVMAssembly' inputs are experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "message": "'SolidityAST' and 'EVMAssembly' inputs are experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "severity": "error",
+            "type": "FatalError"
+        }
+    ]
+}
diff --git a/test/cmdlineTests/standard_no_experimental_eof/input.json b/test/cmdlineTests/standard_no_experimental_eof/input.json
@@ -0,0 +1,12 @@
+{
+    "language": "Solidity",
+    "sources": {
+        "A.sol": {
+          "content": "contract A { constructor() { uint x = 2; { uint y = 3; } } }"
+        }
+    },
+    "settings": {
+        "eofVersion": 1,
+        "evmVersion": "osaka"
+    }
+}
diff --git a/test/cmdlineTests/standard_no_experimental_eof/output.json b/test/cmdlineTests/standard_no_experimental_eof/output.json
@@ -0,0 +1,11 @@
+{
+    "errors": [
+        {
+            "component": "general",
+            "formattedMessage": "'eofVersion' is experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "message": "'eofVersion' is experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "severity": "error",
+            "type": "FatalError"
+        }
+    ]
+}
diff --git a/test/cmdlineTests/standard_no_experimental_ethdebug/input.json b/test/cmdlineTests/standard_no_experimental_ethdebug/input.json
@@ -0,0 +1,19 @@
+{
+    "language": "Solidity",
+    "sources": {
+        "A.sol": {
+            "content": "contract A { constructor() { uint x = 2; { uint y = 3; } } }"
+        }
+    },
+    "settings": {
+        "viaIR": true,
+        "debug": {
+            "debugInfo": ["ethdebug"]
+        },
+        "outputSelection": {
+            "A.sol": {
+                "A": ["evm.bytecode.ethdebug", "evm.deployedBytecode.ethdebug"]
+            }
+        }
+    }
+}
diff --git a/test/cmdlineTests/standard_no_experimental_ethdebug/output.json b/test/cmdlineTests/standard_no_experimental_ethdebug/output.json
@@ -0,0 +1,11 @@
+{
+    "errors": [
+        {
+            "component": "general",
+            "formattedMessage": "'settings.debug.debugInfo.ethdebug' is experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "message": "'settings.debug.debugInfo.ethdebug' is experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "severity": "error",
+            "type": "FatalError"
+        }
+    ]
+}
diff --git a/test/cmdlineTests/standard_no_experimental_ir_ast_output/input.json b/test/cmdlineTests/standard_no_experimental_ir_ast_output/input.json
@@ -0,0 +1,15 @@
+{
+    "language": "Solidity",
+    "sources": {
+        "A.sol": {
+            "content": "contract A { constructor() { uint x = 2; { uint y = 3; } } }"
+        }
+    },
+    "settings": {
+        "outputSelection": {
+            "A.sol": {
+                "A": ["irAst"]
+            }
+        }
+    }
+}
diff --git a/test/cmdlineTests/standard_no_experimental_ir_ast_output/output.json b/test/cmdlineTests/standard_no_experimental_ir_ast_output/output.json
@@ -0,0 +1,11 @@
+{
+    "errors": [
+        {
+            "component": "general",
+            "formattedMessage": "'irAst', 'irOptimizedAst' and 'yulCFGJson' outputs are experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "message": "'irAst', 'irOptimizedAst' and 'yulCFGJson' outputs are experimental, and can only be used by toggling the 'settings.experimental' option.",
+            "severity": "error",
+            "type": "FatalError"
+        }
+    ]
+}
diff --git a/test/cmdlineTests/standard_output_debuginfo_ethdebug_compatible/input.json b/test/cmdlineTests/standard_output_debuginfo_ethdebug_compatible/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "debug": {
       "debugInfo": [
diff --git a/test/cmdlineTests/standard_output_debuginfo_ethdebug_with_interfaces_and_abstracts/input.json b/test/cmdlineTests/standard_output_debuginfo_ethdebug_with_interfaces_and_abstracts/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "debug": {
       "debugInfo": [
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_and_deployedbytecode_ir/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_and_deployedbytecode_ir/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "optimizer": {
       "enabled": false
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_and_deployedbytecode_iroptimized/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_and_deployedbytecode_iroptimized/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "optimizer": {
       "enabled": false
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_ir/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_ir/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "optimizer": {
       "enabled": false
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_iroptimized/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_bytecode_iroptimized/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "optimizer": {
       "enabled": false
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_deployedbytecode_ir/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_deployedbytecode_ir/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "optimizer": {
       "enabled": false
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_deployedbytecode_iroptimized/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_deployedbytecode_iroptimized/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "optimizer": {
       "enabled": false
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_ir/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_ir/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "outputSelection": {
       "*": {
diff --git a/test/cmdlineTests/standard_output_selection_ethdebug_iroptimized/input.json b/test/cmdlineTests/standard_output_selection_ethdebug_iroptimized/input.json
@@ -9,6 +9,7 @@
     }
   },
   "settings": {
+    "experimental": true,
     "viaIR": true,
     "outputSelection": {
       "*": {
diff --git a/test/cmdlineTests/standard_undeployable_contract_all_outputs/input.json b/test/cmdlineTests/standard_undeployable_contract_all_outputs/input.json
@@ -4,6 +4,7 @@
 		"C": {"urls": ["in.sol"]}
 	},
 	"settings": {
+		"experimental": true,
 		"outputSelection": {
 			"*": {
 				"*": ["*", "ir", "irAst", "irOptimized", "irOptimizedAst"]
diff --git a/test/cmdlineTests/standard_yul_cfg_json_export/input.json b/test/cmdlineTests/standard_yul_cfg_json_export/input.json
@@ -4,6 +4,7 @@
 		"C": {"urls": ["in.sol"]}
 	},
 	"settings": {
+		"experimental": true,
 		"optimizer": {
 			"enabled": true
 		},
diff --git a/test/cmdlineTests/standard_yul_debug_info_ethdebug_compatible_output/input.json b/test/cmdlineTests/standard_yul_debug_info_ethdebug_compatible_output/input.json
diff --git a/test/cmdlineTests/standard_yul_debug_info_ethdebug_compatible_output_eof/input.json b/test/cmdlineTests/standard_yul_debug_info_ethdebug_compatible_output_eof/input.json
diff --git a/test/cmdlineTests/standard_yul_debug_info_ethdebug_verbatim_unimplemented/input.json b/test/cmdlineTests/standard_yul_debug_info_ethdebug_verbatim_unimplemented/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_assign_immutable/input.json b/test/cmdlineTests/standard_yul_ethdebug_assign_immutable/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_bytecode_ir/input.json b/test/cmdlineTests/standard_yul_ethdebug_bytecode_ir/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_bytecode_iroptimized/input.json b/test/cmdlineTests/standard_yul_ethdebug_bytecode_iroptimized/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_deployed_bytecode/input.json b/test/cmdlineTests/standard_yul_ethdebug_deployed_bytecode/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_deployed_bytecode_and_bytecode/input.json b/test/cmdlineTests/standard_yul_ethdebug_deployed_bytecode_and_bytecode/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_eof/input.json b/test/cmdlineTests/standard_yul_ethdebug_eof/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_ir/input.json b/test/cmdlineTests/standard_yul_ethdebug_ir/input.json
diff --git a/test/cmdlineTests/standard_yul_ethdebug_iroptimize/input.json b/test/cmdlineTests/standard_yul_ethdebug_iroptimize/input.json
diff --git a/test/ethdebugSchemaTests/input_file.json b/test/ethdebugSchemaTests/input_file.json
diff --git a/test/ethdebugSchemaTests/input_file_eof.json b/test/ethdebugSchemaTests/input_file_eof.json
diff --git a/test/libsolidity/StandardCompiler.cpp b/test/libsolidity/StandardCompiler.cpp

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@`
`28`	`28`	`}`
`29`	`29`	`},`
`30`	`30`	`"settings": {`
	`31`	`+ "experimental": true,`
`31`	`32`	`"outputSelection": {`
`32`	`33`	`"*": {`
`33`	`34`	`"": ["evm.assembly"]`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`}`
`20`	`20`	`},`
`21`	`21`	`"settings": {`
	`22`	`+ "experimental": true,`
`22`	`23`	`"outputSelection": {`
`23`	`24`	`"*": {`
`24`	`25`	`"": ["*"]`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@`
`34`	`34`	`}`
`35`	`35`	`},`
`36`	`36`	`"settings": {`
	`37`	`+ "experimental": true,`
`37`	`38`	`"outputSelection": {`
`38`	`39`	`"*": {`
`39`	`40`	`"": [`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`	`}`
`27`	`27`	`},`
`28`	`28`	`"settings": {`
	`29`	`+ "experimental": true,`
`29`	`30`	`"outputSelection": {`
`30`	`31`	`"*": {`
`31`	`32`	`"": [`