Add Type Hinting for base files and logic files of eth.vm

Author: Bhargavasomu

eth/_warnings.py

@@ -1,10 +1,11 @@
 from contextlib import contextmanager
+from typing import Iterator
 import warnings
 
 
 # TODO: drop once https://github.com/cython/cython/issues/1720 is resolved
 @contextmanager
-def catch_and_ignore_import_warning():
+def catch_and_ignore_import_warning() -> Iterator[None]:
     with warnings.catch_warnings():
         warnings.simplefilter('ignore', category=ImportWarning)
         yield

eth/db/chain.py

@@ -156,7 +156,7 @@ def get(self, key: bytes) -> bytes:
         raise NotImplementedError("ChainDB classes must implement this method")
 
     @abstractmethod
-    def persist_trie_data_dict(self, trie_data_dict: Dict[bytes, bytes]) -> None:
+    def persist_trie_data_dict(self, trie_data_dict: Dict[Hash32, bytes]) -> None:
         raise NotImplementedError("ChainDB classes must implement this method")
 
 
@@ -463,7 +463,7 @@ def get(self, key: bytes) -> bytes:
         """
         return self.db[key]
 
-    def persist_trie_data_dict(self, trie_data_dict: Dict[bytes, bytes]) -> None:
+    def persist_trie_data_dict(self, trie_data_dict: Dict[Hash32, bytes]) -> None:
         """
         Store raw trie data to db from a dict
         """

eth/rlp/headers.py

@@ -203,7 +203,7 @@ def from_parent(cls,
         return header
 
     def create_execution_context(
-            self, prev_hashes: Union[Tuple[bytes], Tuple[bytes, bytes]]) -> ExecutionContext:
+            self, prev_hashes: Tuple[Hash32, ...]) -> ExecutionContext:
 
         return ExecutionContext(
             coinbase=self.coinbase,

eth/rlp/logs.py

@@ -4,6 +4,8 @@
     binary,
 )
 
+from typing import List
+
 from .sedes import (
     address,
     int32,
@@ -17,7 +19,7 @@ class Log(rlp.Serializable):
         ('data', binary)
     ]
 
-    def __init__(self, address: bytes, topics: bytes, data: bytes) -> None:
+    def __init__(self, address: bytes, topics: List[int], data: bytes) -> None:
         super().__init__(address, topics, data)
 
     @property

eth/tools/_utils/hashing.py

@@ -4,6 +4,7 @@
 
 from typing import (
     Iterable,
+    List,
     Tuple,
 )
 
@@ -14,7 +15,7 @@
 from eth.rlp.logs import Log
 
 
-def hash_log_entries(log_entries: Iterable[Tuple[bytes, bytes, bytes]]) -> Hash32:
+def hash_log_entries(log_entries: Iterable[Tuple[bytes, List[int], bytes]]) -> Hash32:
     """
     Helper function for computing the RLP hash of the logs from transaction
     execution.

eth/tools/fixtures/fillers/_utils.py

@@ -3,6 +3,7 @@
 
 from typing import (
     Any,
+    cast,
     Dict,
     List,
     Tuple,
@@ -72,7 +73,7 @@ def calc_state_root(state: AccountState, account_db_class: Type[BaseAccountDB])
 
 def generate_random_keypair() -> Tuple[bytes, Address]:
     key_object = keys.PrivateKey(pad32(int_to_big_endian(random.getrandbits(8 * 32))))
-    return key_object.to_bytes(), key_object.public_key.to_canonical_address()
+    return key_object.to_bytes(), cast(Address, key_object.public_key.to_canonical_address())
 
 
 def generate_random_address() -> Address:

eth/tools/fixtures/fillers/vm.py

@@ -2,6 +2,7 @@
     Any,
     Dict,
     Iterable,
+    List,
     Tuple,
     Union,
 )
@@ -28,7 +29,7 @@ def fill_vm_test(
         call_creates: Any=None,
         gas_price: Union[int, str]=None,
         gas_remaining: Union[int, str]=0,
-        logs: Iterable[Tuple[bytes, bytes, bytes]]=None,
+        logs: Iterable[Tuple[bytes, List[int], bytes]]=None,
         output: bytes=b"") -> Dict[str, Dict[str, Any]]:
 
     test_name = get_test_name(filler)

eth/utils/db.py

@@ -2,6 +2,10 @@
     TYPE_CHECKING,
 )
 
+from eth_typing import (
+    Hash32,
+)
+
 from eth.db.account import (
     BaseAccountDB,
 )
@@ -24,7 +28,7 @@ def get_parent_header(block_header: BlockHeader, db: 'BaseChainDB') -> BlockHead
     return db.get_block_header_by_hash(block_header.parent_hash)
 
 
-def get_block_header_by_hash(block_hash: BlockHeader, db: 'BaseChainDB') -> BlockHeader:
+def get_block_header_by_hash(block_hash: Hash32, db: 'BaseChainDB') -> BlockHeader:
     """
     Returns the header for the parent block.
     """

eth/validation.py

@@ -1,5 +1,21 @@
 import functools
 
+from typing import (
+    Any,
+    Dict,
+    Iterable,
+    Sequence,
+    Tuple,
+    Type,
+    TYPE_CHECKING,
+    Union,
+)
+
+from eth_typing import (
+    Address,
+    Hash32,
+)
+
 from eth_utils import (
     ValidationError,
 )
@@ -24,22 +40,25 @@
     UINT_256_MAX,
 )
 
+if TYPE_CHECKING:
+    from eth.vm.base import BaseVM      # noqa: F401
+
 
-def validate_is_bytes(value, title="Value"):
+def validate_is_bytes(value: bytes, title: str="Value") -> None:
     if not isinstance(value, bytes):
         raise ValidationError(
             "{title} must be a byte string.  Got: {0}".format(type(value), title=title)
         )
 
 
-def validate_is_integer(value, title="Value"):
+def validate_is_integer(value: Union[int, bool], title: str="Value") -> None:
     if not isinstance(value, int) or isinstance(value, bool):
         raise ValidationError(
             "{title} must be a an integer.  Got: {0}".format(type(value), title=title)
         )
 
 
-def validate_length(value, length, title="Value"):
+def validate_length(value: Sequence[Any], length: int, title: str="Value") -> None:
     if not len(value) == length:
         raise ValidationError(
             "{title} must be of length {0}.  Got {1} of length {2}".format(
@@ -51,7 +70,7 @@ def validate_length(value, length, title="Value"):
         )
 
 
-def validate_length_lte(value, maximum_length, title="Value"):
+def validate_length_lte(value: Sequence[Any], maximum_length: int, title: str="Value") -> None:
     if len(value) > maximum_length:
         raise ValidationError(
             "{title} must be of length less than or equal to {0}.  "
@@ -64,7 +83,7 @@ def validate_length_lte(value, maximum_length, title="Value"):
         )
 
 
-def validate_gte(value, minimum, title="Value"):
+def validate_gte(value: int, minimum: int, title: str="Value") -> None:
     if value < minimum:
         raise ValidationError(
             "{title} {0} is not greater than or equal to {1}".format(
@@ -76,15 +95,15 @@ def validate_gte(value, minimum, title="Value"):
     validate_is_integer(value)
 
 
-def validate_gt(value, minimum, title="Value"):
+def validate_gt(value: int, minimum: int, title: str="Value") -> None:
     if value <= minimum:
         raise ValidationError(
             "{title} {0} is not greater than {1}".format(value, minimum, title=title)
         )
     validate_is_integer(value, title=title)
 
 
-def validate_lte(value, maximum, title="Value"):
+def validate_lte(value: int, maximum: int, title: str="Value") -> None:
     if value > maximum:
         raise ValidationError(
             "{title} {0} is not less than or equal to {1}".format(
@@ -96,36 +115,36 @@ def validate_lte(value, maximum, title="Value"):
     validate_is_integer(value, title=title)
 
 
-def validate_lt(value, maximum, title="Value"):
+def validate_lt(value: int, maximum: int, title: str="Value") -> None:
     if value >= maximum:
         raise ValidationError(
             "{title} {0} is not less than {1}".format(value, maximum, title=title)
         )
     validate_is_integer(value, title=title)
 
 
-def validate_canonical_address(value, title="Value"):
+def validate_canonical_address(value: Address, title: str="Value") -> None:
     if not isinstance(value, bytes) or not len(value) == 20:
         raise ValidationError(
             "{title} {0} is not a valid canonical address".format(value, title=title)
         )
 
 
-def validate_multiple_of(value, multiple_of, title="Value"):
+def validate_multiple_of(value: int, multiple_of: int, title: str="Value") -> None:
     if not value % multiple_of == 0:
         raise ValidationError(
             "{title} {0} is not a multiple of {1}".format(value, multiple_of, title=title)
         )
 
 
-def validate_is_boolean(value, title="Value"):
+def validate_is_boolean(value: bool, title: str="Value") -> None:
     if not isinstance(value, bool):
         raise ValidationError(
             "{title} must be an boolean.  Got type: {0}".format(type(value), title=title)
         )
 
 
-def validate_word(value, title="Value"):
+def validate_word(value: Hash32, title: str="Value") -> None:
     if not isinstance(value, bytes):
         raise ValidationError(
             "{title} is not a valid word. Must be of bytes type: Got: {0}".format(
@@ -142,7 +161,7 @@ def validate_word(value, title="Value"):
         )
 
 
-def validate_uint256(value, title="Value"):
+def validate_uint256(value: int, title: str="Value") -> None:
     if not isinstance(value, int) or isinstance(value, bool):
         raise ValidationError(
             "{title} must be an integer: Got: {0}".format(
@@ -166,7 +185,7 @@ def validate_uint256(value, title="Value"):
         )
 
 
-def validate_stack_item(value):
+def validate_stack_item(value: Union[int, bytes]) -> None:
     if isinstance(value, bytes) and len(value) <= 32:
         return
     elif isinstance(value, int) and 0 <= value <= UINT_256_MAX:
@@ -181,7 +200,7 @@ def validate_stack_item(value):
 validate_lt_secpk1n2 = functools.partial(validate_lte, maximum=SECPK1_N // 2 - 1)
 
 
-def validate_unique(values, title="Value"):
+def validate_unique(values: Iterable[Any], title: str="Value") -> None:
     if not isdistinct(values):
         duplicates = pipe(
             values,
@@ -198,27 +217,27 @@ def validate_unique(values, title="Value"):
         )
 
 
-def validate_block_number(block_number, title="Block Number"):
+def validate_block_number(block_number: int, title: str="Block Number") -> None:
     validate_is_integer(block_number, title)
     validate_gte(block_number, 0, title)
 
 
-def validate_vm_block_numbers(vm_block_numbers):
+def validate_vm_block_numbers(vm_block_numbers: Iterable[int]) -> None:
     validate_unique(vm_block_numbers, title="Block Number set")
 
     for block_number in vm_block_numbers:
         validate_block_number(block_number)
 
 
-def validate_vm_configuration(vm_configuration):
+def validate_vm_configuration(vm_configuration: Tuple[Tuple[int, Type['BaseVM']], ...]) -> None:
     validate_vm_block_numbers(tuple(
         block_number
         for block_number, _
         in vm_configuration
     ))
 
 
-def validate_gas_limit(gas_limit, parent_gas_limit):
+def validate_gas_limit(gas_limit: int, parent_gas_limit: int) -> None:
     if gas_limit < GAS_LIMIT_MINIMUM:
         raise ValidationError("Gas limit {0} is below minimum {1}".format(
             gas_limit, GAS_LIMIT_MINIMUM))
@@ -245,7 +264,7 @@ def validate_gas_limit(gas_limit, parent_gas_limit):
 }
 
 
-def validate_header_params_for_configuration(header_params):
+def validate_header_params_for_configuration(header_params: Dict[str, Any]) -> None:
     extra_fields = set(header_params.keys()).difference(ALLOWED_HEADER_FIELDS)
     if extra_fields:
         raise ValidationError(