feat(fw): add call_return_code

src/ethereum_test_tools/__init__.py

@@ -64,6 +64,7 @@
     OpcodeCallArg,
     Opcodes,
     UndefinedOpcodes,
+    call_return_code,
 )
 
 from .code import (
@@ -135,6 +136,7 @@
     "Yul",
     "YulCompiler",
     "add_kzg_version",
+    "call_return_code",
     "ceiling_division",
     "compute_create_address",
     "compute_create2_address",

src/ethereum_test_vm/__init__.py

@@ -4,6 +4,7 @@
 
 from .bytecode import Bytecode
 from .evm_types import EVMCodeType
+from .helpers import call_return_code
 from .opcode import Macro, Macros, Opcode, OpcodeCallArg, Opcodes, UndefinedOpcodes
 
 __all__ = (
@@ -15,4 +16,5 @@
     "OpcodeCallArg",
     "Opcodes",
     "UndefinedOpcodes",
+    "call_return_code",
 )

src/ethereum_test_vm/helpers.py

@@ -0,0 +1,20 @@
+"""
+Helper functions for the EVM.
+"""
+
+from .opcode import Opcodes as Op
+
+
+def call_return_code(opcode: Op, success: bool, *, revert: bool = False) -> int:
+    """
+    Returns the return code for a CALL operation.
+    """
+    if opcode in [Op.CALL, Op.CALLCODE, Op.DELEGATECALL, Op.STATICCALL]:
+        return int(success)
+    elif opcode in [Op.EXTCALL, Op.EXTDELEGATECALL, Op.EXTSTATICCALL]:
+        if success:
+            return 0
+        if revert:
+            return 2
+        return 1
+    raise ValueError(f"Not a call opcode: {opcode}")