Issue a deprecation warning for byzantium and older EVM versions

cameel · cameel · commit 2f01aa3365ac · 2023-10-23T14:41:09.000+02:00
diff --git a/Changelog.md b/Changelog.md
@@ -7,6 +7,7 @@ Language Features:
 Compiler Features:
  * Commandline Interface: Add ``--no-import-callback`` option that prevents the compiler from loading source files not given explicitly on the CLI or in Standard JSON input.
  * Commandline Interface: Use proper severity and coloring also for error messages produced outside of the compilation pipeline.
+ * EVM: Deprecate support for "homestead", "tangerineWhistle", "spuriousDragon" and "byzantium" EVM versions.
  * Parser: Remove the experimental error recovery mode (``--error-recovery`` / ``settings.parserErrorRecovery``).
  * SMTChecker: Support user-defined operators.
  * Yul Optimizer: If ``PUSH0`` is supported, favor zero literals over storing zero values in variables.
diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst
@@ -147,14 +147,14 @@ Target Options
 Below is a list of target EVM versions and the compiler-relevant changes introduced
 at each version. Backward compatibility is not guaranteed between each version.
 
-- ``homestead``
+- ``homestead`` (*support deprecated*)
    - (oldest version)
-- ``tangerineWhistle``
+- ``tangerineWhistle`` (*support deprecated*)
    - Gas cost for access to other accounts increased, relevant for gas estimation and the optimizer.
    - All gas sent by default for external calls, previously a certain amount had to be retained.
-- ``spuriousDragon``
+- ``spuriousDragon`` (*support deprecated*)
    - Gas cost for the ``exp`` opcode increased, relevant for gas estimation and the optimizer.
-- ``byzantium``
+- ``byzantium`` (*support deprecated*)
    - Opcodes ``returndatacopy``, ``returndatasize`` and ``staticcall`` are available in assembly.
    - The ``staticcall`` opcode is used when calling non-library view or pure functions, which prevents the functions from modifying state at the EVM level, i.e., even applies when you use invalid type conversions.
    - It is possible to access dynamic data returned from function calls.
@@ -318,7 +318,7 @@ Input Description
         // Affects type checking and code generation. Can be homestead,
         // tangerineWhistle, spuriousDragon, byzantium, constantinople,
         // petersburg, istanbul, berlin, london, paris or shanghai (default)
-        "evmVersion": "byzantium",
+        "evmVersion": "shanghai",
         // Optional: Change compilation pipeline to go through the Yul intermediate representation.
         // This is false by default.
         "viaIR": true,
diff --git a/libsolidity/interface/StandardCompiler.cpp b/libsolidity/interface/StandardCompiler.cpp
@@ -787,6 +787,12 @@ std::variant<StandardCompiler::InputsAndSettings, Json::Value> StandardCompiler:
 		std::optional<langutil::EVMVersion> version = langutil::EVMVersion::fromString(settings["evmVersion"].asString());
 		if (!version)
 			return formatFatalError(Error::Type::JSONError, "Invalid EVM version requested.");
+		if (version < EVMVersion::constantinople())
+			ret.errors.append(formatError(
+				Error::Type::Warning,
+				"general",
+				"Support for EVM versions older than constantinople is deprecated and will be removed in the future."
+			));
 		ret.evmVersion = *version;
 	}
 
diff --git a/solc/CommandLineInterface.cpp b/solc/CommandLineInterface.cpp
@@ -681,6 +681,12 @@ bool CommandLineInterface::parseArguments(int _argc, char const* const* _argv)
 
 void CommandLineInterface::processInput()
 {
+	if (m_options.output.evmVersion < EVMVersion::constantinople())
+		report(
+			Error::Severity::Warning,
+			"Support for EVM versions older than constantinople is deprecated and will be removed in the future."
+		);
+
 	switch (m_options.input.mode)
 	{
 	case InputMode::Help:
diff --git a/test/cmdlineTests/ast_json_import_wrong_evmVersion/err b/test/cmdlineTests/ast_json_import_wrong_evmVersion/err
@@ -1 +1,2 @@
+Warning: Support for EVM versions older than constantinople is deprecated and will be removed in the future.
 Error: Failed to import AST: Imported tree evm version differs from configured evm version!
diff --git a/test/cmdlineTests/evm_version_byzantium/args b/test/cmdlineTests/evm_version_byzantium/args
@@ -0,0 +1 @@
+--evm-version byzantium
diff --git a/test/cmdlineTests/evm_version_byzantium/err b/test/cmdlineTests/evm_version_byzantium/err
@@ -0,0 +1,3 @@
+Warning: Support for EVM versions older than constantinople is deprecated and will be removed in the future.
+Warning: Source file does not specify required compiler version!
+--> evm_version_byzantium/input.sol
diff --git a/test/cmdlineTests/evm_version_byzantium/input.sol b/test/cmdlineTests/evm_version_byzantium/input.sol
@@ -0,0 +1 @@
+// SPDX-License-Identifier: GPL-3.0
diff --git a/test/cmdlineTests/evm_version_constantinople/args b/test/cmdlineTests/evm_version_constantinople/args
@@ -0,0 +1 @@
+--evm-version constantinople
diff --git a/test/cmdlineTests/evm_version_constantinople/err b/test/cmdlineTests/evm_version_constantinople/err
@@ -0,0 +1,2 @@
+Warning: Source file does not specify required compiler version!
+--> evm_version_constantinople/input.sol
diff --git a/test/cmdlineTests/evm_version_constantinople/input.sol b/test/cmdlineTests/evm_version_constantinople/input.sol
@@ -0,0 +1 @@
+// SPDX-License-Identifier: GPL-3.0
diff --git a/test/cmdlineTests/standard_evm_version_byzantium/input.json b/test/cmdlineTests/standard_evm_version_byzantium/input.json
@@ -0,0 +1,9 @@
+{
+	"language": "Solidity",
+	"sources": {
+		"input.sol": {"content": "// SPDX-License-Identifier: GPL-3.0\npragma solidity *;"}
+	},
+	"settings": {
+		"evmVersion": "byzantium"
+	}
+}
diff --git a/test/cmdlineTests/standard_evm_version_byzantium/output.json b/test/cmdlineTests/standard_evm_version_byzantium/output.json
@@ -0,0 +1,19 @@
+{
+    "errors":
+    [
+        {
+            "component": "general",
+            "formattedMessage": "Support for EVM versions older than constantinople is deprecated and will be removed in the future.",
+            "message": "Support for EVM versions older than constantinople is deprecated and will be removed in the future.",
+            "severity": "warning",
+            "type": "Warning"
+        }
+    ],
+    "sources":
+    {
+        "input.sol":
+        {
+            "id": 0
+        }
+    }
+}
diff --git a/test/cmdlineTests/standard_evm_version_constantinople/input.json b/test/cmdlineTests/standard_evm_version_constantinople/input.json
@@ -0,0 +1,9 @@
+{
+	"language": "Solidity",
+	"sources": {
+		"input.sol": {"content": "// SPDX-License-Identifier: GPL-3.0\npragma solidity *;"}
+	},
+	"settings": {
+		"evmVersion": "constantinople"
+	}
+}
diff --git a/test/cmdlineTests/standard_evm_version_constantinople/output.json b/test/cmdlineTests/standard_evm_version_constantinople/output.json
@@ -0,0 +1,9 @@
+{
+    "sources":
+    {
+        "input.sol":
+        {
+            "id": 0
+        }
+    }
+}
diff --git a/test/cmdlineTests/standard_missing_key_useLiteralContent/output.json b/test/cmdlineTests/standard_missing_key_useLiteralContent/output.json
@@ -1,4 +1,14 @@
 {
+    "errors":
+    [
+        {
+            "component": "general",
+            "formattedMessage": "Support for EVM versions older than constantinople is deprecated and will be removed in the future.",
+            "message": "Support for EVM versions older than constantinople is deprecated and will be removed in the future.",
+            "severity": "warning",
+            "type": "Warning"
+        }
+    ],
     "sources":
     {
         "A":
diff --git a/test/cmdlineTests/standard_yul_evm_version_byzantium/input.json b/test/cmdlineTests/standard_yul_evm_version_byzantium/input.json
@@ -0,0 +1,9 @@
+{
+	"language": "Yul",
+	"sources": {
+		"input.yul": {"content": "{}"}
+	},
+	"settings": {
+		"evmVersion": "byzantium"
+	}
+}
diff --git a/test/cmdlineTests/standard_yul_evm_version_byzantium/output.json b/test/cmdlineTests/standard_yul_evm_version_byzantium/output.json
@@ -0,0 +1,12 @@
+{
+    "errors":
+    [
+        {
+            "component": "general",
+            "formattedMessage": "Support for EVM versions older than constantinople is deprecated and will be removed in the future.",
+            "message": "Support for EVM versions older than constantinople is deprecated and will be removed in the future.",
+            "severity": "warning",
+            "type": "Warning"
+        }
+    ]
+}
diff --git a/test/cmdlineTests/standard_yul_evm_version_constantinople/input.json b/test/cmdlineTests/standard_yul_evm_version_constantinople/input.json
@@ -0,0 +1,9 @@
+{
+	"language": "Yul",
+	"sources": {
+		"input.yul": {"content": "{}"}
+	},
+	"settings": {
+		"evmVersion": "constantinople"
+	}
+}
diff --git a/test/cmdlineTests/standard_yul_evm_version_constantinople/output.json b/test/cmdlineTests/standard_yul_evm_version_constantinople/output.json
@@ -0,0 +1,2 @@
+{
+}
diff --git a/test/cmdlineTests/strict_asm_evm_version_byzantium/args b/test/cmdlineTests/strict_asm_evm_version_byzantium/args
@@ -0,0 +1 @@
+--strict-assembly --evm-version byzantium
diff --git a/test/cmdlineTests/strict_asm_evm_version_byzantium/err b/test/cmdlineTests/strict_asm_evm_version_byzantium/err
@@ -0,0 +1 @@
+Warning: Support for EVM versions older than constantinople is deprecated and will be removed in the future.
diff --git a/test/cmdlineTests/strict_asm_evm_version_byzantium/input.yul b/test/cmdlineTests/strict_asm_evm_version_byzantium/input.yul
@@ -0,0 +1 @@
+{}
diff --git a/test/cmdlineTests/strict_asm_evm_version_byzantium/output b/test/cmdlineTests/strict_asm_evm_version_byzantium/output
@@ -0,0 +1,15 @@
+
+======= strict_asm_evm_version_byzantium/input.yul (EVM) =======
+
+Pretty printed source:
+object "object" {
+    code { { } }
+}
+
+
+Binary representation:
+00
+
+Text representation:
+    /* "strict_asm_evm_version_byzantium/input.yul":0:2   */
+  stop
diff --git a/test/cmdlineTests/strict_asm_evm_version_constantinople/args b/test/cmdlineTests/strict_asm_evm_version_constantinople/args
@@ -0,0 +1 @@
+--strict-assembly --evm-version constantinople
diff --git a/test/cmdlineTests/strict_asm_evm_version_constantinople/input.yul b/test/cmdlineTests/strict_asm_evm_version_constantinople/input.yul
@@ -0,0 +1 @@
+{}
diff --git a/test/cmdlineTests/strict_asm_evm_version_constantinople/output b/test/cmdlineTests/strict_asm_evm_version_constantinople/output
@@ -0,0 +1,15 @@
+
+======= strict_asm_evm_version_constantinople/input.yul (EVM) =======
+
+Pretty printed source:
+object "object" {
+    code { { } }
+}
+
+
+Binary representation:
+00
+
+Text representation:
+    /* "strict_asm_evm_version_constantinople/input.yul":0:2   */
+  stop

Original file line number	Diff line number	Diff line change
`@@ -681,6 +681,12 @@ bool CommandLineInterface::parseArguments(int _argc, char const* const* _argv)`
`681`	`681`
`682`	`682`	`void CommandLineInterface::processInput()`
`683`	`683`	`{`
	`684`	`+ if (m_options.output.evmVersion < EVMVersion::constantinople())`
	`685`	`+ report(`
	`686`	`+ Error::Severity::Warning,`
	`687`	`+ "Support for EVM versions older than constantinople is deprecated and will be removed in the future."`
	`688`	`+ );`
	`689`	`+`
`684`	`690`	`switch (m_options.input.mode)`
`685`	`691`	`{`
`686`	`692`	`case InputMode::Help:`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+Warning: Support for EVM versions older than constantinople is deprecated and will be removed in the future.`
`1`	`2`	`Error: Failed to import AST: Imported tree evm version differs from configured evm version!`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Warning: Support for EVM versions older than constantinople is deprecated and will be removed in the future.`
	`2`	`+Warning: Source file does not specify required compiler version!`
	`3`	`+--> evm_version_byzantium/input.sol`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Warning: Source file does not specify required compiler version!`
	`2`	`+--> evm_version_constantinople/input.sol`