feat: improve comments and apply changes to cancun

src/ethereum/arrow_glacier/vm/gas.py

@@ -85,7 +85,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -189,8 +190,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/berlin/vm/gas.py

@@ -86,7 +86,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -190,8 +191,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/byzantium/vm/gas.py

@@ -85,7 +85,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -189,8 +190,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/cancun/vm/gas.py

@@ -91,18 +91,19 @@ class ExtendMemory:
 @dataclass
 class MessageCallGas:
     """
-    Define the gas cost and stipend for executing the call opcodes.
+    Define the gas cost and gas given to the sub-call for
+    executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The non-refundable portion of gas reserved for executing the
-        call opcode.
-    `stipend`: `ethereum.base_types.Uint`
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
+    `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
-        if not consumed
+        if not consumed.
     """
 
     cost: Uint
-    stipend: Uint
+    sub_call: Uint
 
 
 def charge_gas(evm: Evm, amount: Uint) -> None:
@@ -199,8 +200,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/cancun/vm/instructions/system.py

@@ -384,11 +384,11 @@ def call(evm: Evm) -> None:
     if sender_balance < value:
         push(evm.stack, U256(0))
         evm.return_data = b""
-        evm.gas_left += message_call_gas.stipend
+        evm.gas_left += message_call_gas.sub_call
     else:
         generic_call(
             evm,
-            message_call_gas.stipend,
+            message_call_gas.sub_call,
             value,
             evm.message.current_target,
             to,
@@ -458,11 +458,11 @@ def callcode(evm: Evm) -> None:
     if sender_balance < value:
         push(evm.stack, U256(0))
         evm.return_data = b""
-        evm.gas_left += message_call_gas.stipend
+        evm.gas_left += message_call_gas.sub_call
     else:
         generic_call(
             evm,
-            message_call_gas.stipend,
+            message_call_gas.sub_call,
             value,
             evm.message.current_target,
             to,
@@ -577,7 +577,7 @@ def delegatecall(evm: Evm) -> None:
     evm.memory += b"\x00" * extend_memory.expand_by
     generic_call(
         evm,
-        message_call_gas.stipend,
+        message_call_gas.sub_call,
         evm.message.value,
         evm.message.caller,
         evm.message.current_target,
@@ -639,7 +639,7 @@ def staticcall(evm: Evm) -> None:
     evm.memory += b"\x00" * extend_memory.expand_by
     generic_call(
         evm,
-        message_call_gas.stipend,
+        message_call_gas.sub_call,
         U256(0),
         evm.message.current_target,
         to,

src/ethereum/constantinople/vm/gas.py

@@ -86,7 +86,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -190,8 +191,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/dao_fork/vm/gas.py

@@ -84,7 +84,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.

src/ethereum/frontier/vm/gas.py

@@ -84,7 +84,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.

src/ethereum/gray_glacier/vm/gas.py

@@ -85,7 +85,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -189,8 +190,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/homestead/vm/gas.py

@@ -84,7 +84,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.

src/ethereum/istanbul/vm/gas.py

@@ -88,7 +88,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -192,8 +193,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/london/vm/gas.py

@@ -85,7 +85,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -189,8 +190,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/muir_glacier/vm/gas.py

@@ -88,7 +88,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -192,8 +193,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/paris/vm/gas.py

@@ -85,7 +85,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -189,8 +190,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/shanghai/vm/gas.py

@@ -86,7 +86,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -190,8 +191,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/spurious_dragon/vm/gas.py

@@ -84,7 +84,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -188,8 +189,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------

src/ethereum/tangerine_whistle/vm/gas.py

@@ -84,7 +84,8 @@ class MessageCallGas:
     executing the call opcodes.
 
     `cost`: `ethereum.base_types.Uint`
-        The gas required to execute the call opcode.
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
     `sub_call`: `ethereum.base_types.Uint`
         The portion of gas available to sub-calls that is refundable
         if not consumed.
@@ -188,8 +189,8 @@ def calculate_message_call_gas(
     call_stipend: Uint = GAS_CALL_STIPEND,
 ) -> MessageCallGas:
     """
-    Calculates the MessageCallGas (cost and stipend) for
-    executing call Opcodes.
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
 
     Parameters
     ----------