Merge pull request #1447 from ipsilon/eof/stack_height_constants

refactor(tests): Rename stack height constants

Author: marioevz

src/ethereum_test_tools/eof/__init__.py

@@ -20,3 +20,10 @@
 """
 Length of the version byte.
 """
+
+MAX_RUNTIME_STACK_HEIGHT = 1024
+"""
+Maximum height of the EVM runtime operand stack.
+Exceeding this value during execution will result in the stack overflow exception.
+This value applies to both legacy EVM and EOF.
+"""

src/ethereum_test_tools/eof/constants.py

@@ -13,7 +13,10 @@
 
 MAX_RETURN_STACK_HEIGHT = 1024
 
-MAX_OPERAND_STACK_HEIGHT = 1023
+MAX_STACK_INCREASE_LIMIT = 0x3FF
+"""
+Maximum value for the max stack increase accepted by the EOF format.
+"""
 
 MAX_CODE_INPUTS = 127
 

src/ethereum_test_tools/eof/v1/__init__.py

@@ -17,8 +17,8 @@
     Initcode,
     Transaction,
 )
-from ethereum_test_tools.eof.v1 import Container
 from ethereum_test_tools.vm.opcode import Opcodes as Op
+from ethereum_test_types.eof.v1 import Container
 
 from .spec import ref_spec_1153
 

src/ethereum_test_tools/eof/v1/constants.py

@@ -7,8 +7,9 @@
 
 from ethereum_test_tools import EOFException, EOFTestFiller, Opcode, UndefinedOpcodes
 from ethereum_test_tools import Opcodes as Op
-from ethereum_test_tools.eof.v1 import Container, ContainerKind, Section
-from ethereum_test_tools.eof.v1.constants import MAX_OPERAND_STACK_HEIGHT
+from ethereum_test_types.eof.constants import MAX_RUNTIME_STACK_HEIGHT
+from ethereum_test_types.eof.v1 import Container, ContainerKind, Section
+from ethereum_test_types.eof.v1.constants import MAX_STACK_INCREASE_LIMIT
 from ethereum_test_vm import Bytecode
 
 from .. import EOF_FORK_NAME
@@ -337,7 +338,7 @@ def test_all_opcodes_stack_overflow(
     opcode = opcode[0] if opcode.has_data_portion() else opcode
 
     assert opcode.pushed_stack_items - opcode.popped_stack_items == 1
-    opcode_count = MAX_OPERAND_STACK_HEIGHT + 1 - opcode.min_stack_height
+    opcode_count = MAX_RUNTIME_STACK_HEIGHT - opcode.min_stack_height
 
     bytecode = Op.PUSH0 * opcode.min_stack_height
     bytecode += opcode * opcode_count
@@ -347,7 +348,7 @@ def test_all_opcodes_stack_overflow(
 
     if exception == EOFException.INVALID_MAX_STACK_INCREASE:
         # Lie about the max stack height to make the code be checked for stack overflow.
-        kwargs["max_stack_height"] = MAX_OPERAND_STACK_HEIGHT
+        kwargs["max_stack_height"] = MAX_STACK_INCREASE_LIMIT
 
     sections = [Section.Code(**kwargs)]
 

src/ethereum_test_types/eof/constants.py

@@ -4,8 +4,8 @@
 
 from ethereum_test_tools import EOFException, EOFTestFiller
 from ethereum_test_tools import Opcodes as Op
-from ethereum_test_tools.eof.v1 import Container, Section
-from ethereum_test_tools.eof.v1.constants import MAX_INITCODE_SIZE
+from ethereum_test_types.eof.v1 import Container, Section
+from ethereum_test_types.eof.v1.constants import MAX_INITCODE_SIZE
 
 from .. import EOF_FORK_NAME
 

src/ethereum_test_types/eof/v1/constants.py

@@ -5,20 +5,20 @@
 import pytest
 
 from ethereum_test_tools import EOFException, EOFTestFiller
-from ethereum_test_tools.eof.v1 import (
+from ethereum_test_tools.vm.opcode import Opcodes as Op
+from ethereum_test_types.eof.v1 import (
     AutoSection,
     Container,
     ContainerKind,
     Section,
     SectionKind,
 )
-from ethereum_test_tools.eof.v1.constants import (
+from ethereum_test_types.eof.v1.constants import (
     MAX_CODE_INPUTS,
     MAX_CODE_OUTPUTS,
     MAX_CODE_SECTIONS,
-    MAX_OPERAND_STACK_HEIGHT,
+    MAX_STACK_INCREASE_LIMIT,
 )
-from ethereum_test_tools.vm.opcode import Opcodes as Op
 
 from .. import EOF_FORK_NAME
 
@@ -37,10 +37,10 @@
             name="single_code_section_max_stack_size",
             sections=[
                 Section.Code(
-                    code=(Op.CALLER * MAX_OPERAND_STACK_HEIGHT)
-                    + (Op.POP * MAX_OPERAND_STACK_HEIGHT)
+                    code=(Op.CALLER * MAX_STACK_INCREASE_LIMIT)
+                    + (Op.POP * MAX_STACK_INCREASE_LIMIT)
                     + Op.STOP,
-                    max_stack_height=MAX_OPERAND_STACK_HEIGHT,
+                    max_stack_height=MAX_STACK_INCREASE_LIMIT,
                 ),
             ],
         ),