chore: remove gas estimates from ABI by default (#2590)

gas estimates can break downstream tooling if they are wrong

fixes #2151

Author: tserg

tests/base_conftest.py

@@ -109,6 +109,7 @@ def _get_contract(w3, source_code, no_optimize, *args, **kwargs):
         interface_codes=kwargs.pop("interface_codes", None),
         no_optimize=no_optimize,
         evm_version=kwargs.pop("evm_version", None),
+        show_gas_estimates=True,  # Enable gas estimates for testing
     )
     LARK_GRAMMAR.parse(source_code + "\n")  # Test grammar.
     abi = out["abi"]

tests/parser/features/test_assert.py

@@ -1,5 +1,4 @@
 import pytest
-from eth_abi import decode_single
 from eth_tester.exceptions import TransactionFailed
 
 
@@ -189,18 +188,12 @@ def test(x: uint256[3]) -> bool:
     assert_tx_failed(lambda: c.test([1, 3, 5]))
 
 
-def test_assert_reason_revert_length(w3, get_contract, memory_mocker):
+def test_assert_reason_revert_length(w3, get_contract, assert_tx_failed, memory_mocker):
     code = """
 @external
 def test() -> int128:
     assert 1 == 2, "oops"
     return 1
 """
     c = get_contract(code)
-    w3.manager.provider.ethereum_tester.backend.is_eip838_error = lambda err: False
-    with pytest.raises(TransactionFailed) as e_info:
-        c.test()
-    error_bytes = eval(_fixup_err_str(e_info.value.args[0]))
-    assert len(error_bytes) == 100
-    msg = decode_single("string", error_bytes[36:])
-    assert msg == "oops"
+    assert_tx_failed(lambda: c.test(), exc_text="oops")

tests/parser/features/test_assert_unreachable.py

@@ -1,7 +1,3 @@
-import pytest
-from eth_tester.exceptions import TransactionFailed
-
-
 def test_assure_refund(w3, get_contract):
     code = """
 @external
@@ -32,13 +28,9 @@ def foo(val: int128) -> bool:
 
     assert c.foo(2) is True
 
-    assert_tx_failed(lambda: c.foo(1))
-    assert_tx_failed(lambda: c.foo(-1))
-
-    with pytest.raises(TransactionFailed) as e_info:
-        c.foo(-2)
-
-    assert "Invalid opcode 0xfe" in e_info.value.args[0]
+    assert_tx_failed(lambda: c.foo(1), exc_text="Invalid opcode 0xfe")
+    assert_tx_failed(lambda: c.foo(-1), exc_text="Invalid opcode 0xfe")
+    assert_tx_failed(lambda: c.foo(-2), exc_text="Invalid opcode 0xfe")
 
 
 def test_basic_call_unreachable(w3, get_contract, assert_tx_failed):
@@ -59,6 +51,6 @@ def foo(val: int128) -> int128:
 
     assert c.foo(33) == -123
 
-    assert_tx_failed(lambda: c.foo(1))
-    assert_tx_failed(lambda: c.foo(1))
-    assert_tx_failed(lambda: c.foo(-1))
+    assert_tx_failed(lambda: c.foo(1), exc_text="Invalid opcode 0xfe")
+    assert_tx_failed(lambda: c.foo(1), exc_text="Invalid opcode 0xfe")
+    assert_tx_failed(lambda: c.foo(-1), exc_text="Invalid opcode 0xfe")

vyper/cli/vyper_compile.py

@@ -10,7 +10,6 @@
 import vyper
 from vyper.cli import vyper_json
 from vyper.cli.utils import extract_file_interface_imports, get_interface_file_path
-from vyper.codegen.lll_node import LLLnode
 from vyper.compiler.settings import VYPER_TRACEBACK_LIMIT
 from vyper.evm.opcodes import DEFAULT_EVM_VERSION, EVM_VERSIONS
 from vyper.typing import ContractCodes, ContractPath, OutputFormats
@@ -91,7 +90,7 @@ def _parse_args(argv):
     )
     parser.add_argument(
         "--show-gas-estimates",
-        help="Show gas estimates in ir output mode.",
+        help="Show gas estimates in abi and ir output mode.",
         action="store_true",
     )
     parser.add_argument(
@@ -230,9 +229,6 @@ def compile_files(
     no_optimize: bool = False,
 ) -> OrderedDict:
 
-    if show_gas_estimates:
-        LLLnode.repr_show_gas = True
-
     root_path = Path(root_folder).resolve()
     if not root_path.exists():
         raise FileNotFoundError(f"Invalid root path - '{root_path.as_posix()}' does not exist")
@@ -266,6 +262,7 @@ def compile_files(
         interface_codes=get_interface_codes(root_path, contract_sources),
         evm_version=evm_version,
         no_optimize=no_optimize,
+        show_gas_estimates=show_gas_estimates,
     )
     if show_version:
         compiler_data["version"] = vyper.__version__

vyper/compiler/__init__.py

@@ -39,6 +39,7 @@ def compile_codes(
     interface_codes: Union[InterfaceDict, InterfaceImports, None] = None,
     initial_id: int = 0,
     no_optimize: bool = False,
+    show_gas_estimates: bool = False,
 ) -> OrderedDict:
     """
     Generate compiler output(s) from one or more contract source codes.
@@ -60,6 +61,8 @@ def compile_codes(
         implemented ruleset.
     no_optimize: bool, optional
         Turn off optimizations. Defaults to False
+    show_gas_estimates: bool, optional
+        Show gas estimates for abi and ir output modes
     interface_codes: Dict, optional
         Interfaces that may be imported by the contracts during compilation.
 
@@ -93,7 +96,14 @@ def compile_codes(
         ):
             interfaces = interfaces[contract_name]
 
-        compiler_data = CompilerData(source_code, contract_name, interfaces, source_id, no_optimize)
+        compiler_data = CompilerData(
+            source_code,
+            contract_name,
+            interfaces,
+            source_id,
+            no_optimize,
+            show_gas_estimates
+        )
         for output_format in output_formats[contract_name]:
             if output_format not in OUTPUT_FORMATS:
                 raise ValueError(f"Unsupported format type {repr(output_format)}")
@@ -118,6 +128,7 @@ def compile_code(
     interface_codes: Optional[InterfaceImports] = None,
     evm_version: str = DEFAULT_EVM_VERSION,
     no_optimize: bool = False,
+    show_gas_estimates: bool = False,
 ) -> dict:
     """
     Generate compiler output(s) from a single contract source code.
@@ -134,6 +145,8 @@ def compile_code(
         implemented ruleset.
     no_optimize: bool, optional
         Turn off optimizations. Defaults to False
+    show_gas_estimates: bool, optional
+        Show gas estimates for abi and ir output modes
     interface_codes: Dict, optional
         Interfaces that may be imported by the contracts during compilation.
 
@@ -154,4 +167,5 @@ def compile_code(
         interface_codes=interface_codes,
         evm_version=evm_version,
         no_optimize=no_optimize,
+        show_gas_estimates=show_gas_estimates,
     )[UNKNOWN_CONTRACT_NAME]

vyper/compiler/output.py

@@ -74,6 +74,8 @@ def build_interface_output(compiler_data: CompilerData) -> str:
 
 
 def build_ir_output(compiler_data: CompilerData) -> LLLnode:
+    if compiler_data.show_gas_estimates:
+        LLLnode.repr_show_gas = True
     return compiler_data.lll_nodes
 
 
@@ -98,20 +100,21 @@ def build_method_identifiers_output(compiler_data: CompilerData) -> dict:
 
 def build_abi_output(compiler_data: CompilerData) -> list:
     abi = compiler_data.vyper_module_folded._metadata["type"].to_abi_dict()
-    # Add gas estimates for each function to ABI
-    gas_estimates = build_gas_estimates(compiler_data.lll_runtime)
-    for func in abi:
-        try:
-            func_signature = func["name"]
-        except KeyError:
-            # constructor and fallback functions don't have a name
-            continue
+    if compiler_data.show_gas_estimates:
+        # Add gas estimates for each function to ABI
+        gas_estimates = build_gas_estimates(compiler_data.lll_runtime)
+        for func in abi:
+            try:
+                func_signature = func["name"]
+            except KeyError:
+                # constructor and fallback functions don't have a name
+                continue
 
-        func_name, _, _ = func_signature.partition("(")
-        # This check ensures we skip __init__ since it has no estimate
-        if func_name in gas_estimates:
-            # TODO: mutation
-            func["gas"] = gas_estimates[func_name]
+            func_name, _, _ = func_signature.partition("(")
+            # This check ensures we skip __init__ since it has no estimate
+            if func_name in gas_estimates:
+                # TODO: mutation
+                func["gas"] = gas_estimates[func_name]
     return abi
 
 

vyper/compiler/phases.py

@@ -48,6 +48,7 @@ def __init__(
         interface_codes: Optional[InterfaceImports] = None,
         source_id: int = 0,
         no_optimize: bool = False,
+        show_gas_estimates: bool = False,
     ) -> None:
         """
         Initialization method.
@@ -64,12 +65,17 @@ def __init__(
             * JSON interfaces are given as lists, vyper interfaces as strings
         source_id : int, optional
             ID number used to identify this contract in the source map.
+        no_optimize: bool, optional
+            Turn off optimizations. Defaults to False
+        show_gas_estimates: bool, optional
+            Show gas estimates for abi and ir output modes
         """
         self.contract_name = contract_name
         self.source_code = source_code
         self.interface_codes = interface_codes
         self.source_id = source_id
         self.no_optimize = no_optimize
+        self.show_gas_estimates = show_gas_estimates
 
     @property
     def vyper_module(self) -> vy_ast.Module: