Tighten type support

Author: cburgdorf

eth/_utils/headers.py

@@ -4,6 +4,8 @@
 from eth_typing import (
     Address
 )
+
+from eth.abc import BlockHeaderAPI
 from eth.constants import (
     GENESIS_GAS_LIMIT,
     GAS_LIMIT_EMA_DENOMINATOR,
@@ -17,7 +19,7 @@
 )
 
 
-def compute_gas_limit_bounds(parent: BlockHeader) -> Tuple[int, int]:
+def compute_gas_limit_bounds(parent: BlockHeaderAPI) -> Tuple[int, int]:
     """
     Compute the boundaries for the block gas limit based on the parent block.
     """
@@ -27,7 +29,7 @@ def compute_gas_limit_bounds(parent: BlockHeader) -> Tuple[int, int]:
     return lower_bound, upper_bound
 
 
-def compute_gas_limit(parent_header: BlockHeader, gas_limit_floor: int) -> int:
+def compute_gas_limit(parent_header: BlockHeaderAPI, gas_limit_floor: int) -> int:
     """
     A simple strategy for adjusting the gas limit.
 
@@ -78,8 +80,8 @@ def compute_gas_limit(parent_header: BlockHeader, gas_limit_floor: int) -> int:
 
 
 def generate_header_from_parent_header(
-        compute_difficulty_fn: Callable[[BlockHeader, int], int],
-        parent_header: BlockHeader,
+        compute_difficulty_fn: Callable[[BlockHeaderAPI, int], int],
+        parent_header: BlockHeaderAPI,
         coinbase: Address,
         timestamp: Optional[int] = None,
         extra_data: bytes = b'') -> BlockHeader:

eth/_utils/transactions.py

@@ -13,6 +13,7 @@
     ValidationError,
 )
 
+from eth.abc import UnsignedTransactionAPI
 from eth.constants import (
     CREATE_CONTRACT_ADDRESS,
 )
@@ -53,7 +54,7 @@ def extract_signature_v(v: int) -> int:
         return V_OFFSET
 
 
-def create_transaction_signature(unsigned_txn: BaseTransaction,
+def create_transaction_signature(unsigned_txn: UnsignedTransactionAPI,
                                  private_key: datatypes.PrivateKey,
                                  chain_id: int=None) -> VRS:
 

eth/abc.py

@@ -19,10 +19,9 @@
     Type,
     TypeVar,
     Union,
+    Hashable,
 )
 
-import rlp
-
 from eth_bloom import BloomFilter
 
 from eth_typing import (
@@ -53,7 +52,7 @@
 T = TypeVar('T')
 
 
-class MiningHeaderAPI(rlp.Serializable, ABC):
+class MiningHeaderAPI(ABC):
     """
     A class to define a block header without ``mix_hash`` and ``nonce`` which can act as a
     temporary representation during mining before the block header is sealed.
@@ -72,6 +71,53 @@ class MiningHeaderAPI(rlp.Serializable, ABC):
     timestamp: int
     extra_data: bytes
 
+    @property
+    @abstractmethod
+    def hash(self) -> Hash32:
+        """
+        Return the hash of the block header.
+        """
+        ...
+
+    @property
+    @abstractmethod
+    def mining_hash(self) -> Hash32:
+        """
+        Return the mining hash of the block header.
+        """
+
+    @property
+    def hex_hash(self) -> str:
+        """
+        Return the hash as a hex string.
+        """
+        ...
+
+    @property
+    @abstractmethod
+    def is_genesis(self) -> bool:
+        """
+        Return ``True`` if this header represents the genesis block of the chain,
+        otherwise ``False``.
+        """
+        ...
+
+    # We can remove this API and inherit from rlp.Serializable when it becomes typesafe
+    @abstractmethod
+    def build_changeset(self, *args: Any, **kwargs: Any) -> Any:
+        """
+        Open a changeset to modify the header.
+        """
+        ...
+
+    # We can remove this API and inherit from rlp.Serializable when it becomes typesafe
+    @abstractmethod
+    def as_dict(self) -> Dict[Hashable, Any]:
+        """
+        Return a dictionary representation of the header.
+        """
+        ...
+
 
 class BlockHeaderAPI(MiningHeaderAPI):
     """
@@ -81,8 +127,16 @@ class BlockHeaderAPI(MiningHeaderAPI):
     mix_hash: Hash32
     nonce: bytes
 
+    # We can remove this API and inherit from rlp.Serializable when it becomes typesafe
+    @abstractmethod
+    def copy(self, *args: Any, **kwargs: Any) -> 'BlockHeaderAPI':
+        """
+        Return a copy of the header, optionally overwriting any of its properties.
+        """
+        ...
+
 
-class LogAPI(rlp.Serializable, ABC):
+class LogAPI(ABC):
     """
     A class to define a written log.
     """
@@ -96,7 +150,7 @@ def bloomables(self) -> Tuple[bytes, ...]:
         ...
 
 
-class ReceiptAPI(rlp.Serializable, ABC):
+class ReceiptAPI(ABC):
     """
     A class to define a receipt to capture the outcome of a transaction.
     """
@@ -110,6 +164,15 @@ class ReceiptAPI(rlp.Serializable, ABC):
     def bloom_filter(self) -> BloomFilter:
         ...
 
+    # We can remove this API and inherit from rlp.Serializable when it becomes typesafe
+    def copy(self, *args: Any, **kwargs: Any) -> 'ReceiptAPI':
+        """
+        Return a copy of the receipt, optionally overwriting any of its properties.
+        """
+        # This method isn't marked abstract because derived classes implement it by deriving from
+        # rlp.Serializable but mypy won't recognize it as implemented.
+        ...
+
 
 class BaseTransactionAPI(ABC):
     """
@@ -148,6 +211,7 @@ def gas_used_by(self, computation: 'ComputationAPI') -> int:
         """
         ...
 
+    # We can remove this API and inherit from rlp.Serializable when it becomes typesafe
     @abstractmethod
     def copy(self: T, **overrides: Any) -> T:
         """
@@ -172,11 +236,15 @@ class TransactionFieldsAPI(ABC):
 
     @property
     @abstractmethod
-    def hash(self) -> bytes:
+    def hash(self) -> Hash32:
+        """
+        Return the hash of the transaction.
+        """
         ...
 
 
-class UnsignedTransactionAPI(rlp.Serializable, BaseTransactionAPI):
+class UnsignedTransactionAPI(BaseTransactionAPI):
+
     """
     A class representing a transaction before it is signed.
     """
@@ -199,7 +267,11 @@ def as_signed_transaction(self, private_key: PrivateKey) -> 'SignedTransactionAP
         ...
 
 
-class SignedTransactionAPI(rlp.Serializable, BaseTransactionAPI, TransactionFieldsAPI):
+class SignedTransactionAPI(BaseTransactionAPI, TransactionFieldsAPI):
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        ...
+
     """
     A class representing a transaction that was signed with a private key.
     """
@@ -288,12 +360,29 @@ def create_unsigned_transaction(cls,
         """
         ...
 
+    # We can remove this API and inherit from rlp.Serializable when it becomes typesafe
+    def as_dict(self) -> Dict[Hashable, Any]:
+        """
+        Return a dictionary representation of the transaction.
+        """
+        ...
 
-class BlockAPI(rlp.Serializable, ABC):
+
+class BlockAPI(ABC):
     """
     A class to define a block.
     """
+    header: BlockHeaderAPI
+    transactions: Tuple[SignedTransactionAPI, ...]
     transaction_class: Type[SignedTransactionAPI] = None
+    uncles: Tuple[BlockHeaderAPI, ...]
+
+    @abstractmethod
+    def __init__(self,
+                 header: BlockHeaderAPI,
+                 transactions: Sequence[SignedTransactionAPI],
+                 uncles: Sequence[BlockHeaderAPI]):
+        ...
 
     @classmethod
     @abstractmethod
@@ -311,6 +400,13 @@ def from_header(cls, header: BlockHeaderAPI, chaindb: 'ChainDatabaseAPI') -> 'Bl
         """
         ...
 
+    @abstractmethod
+    def get_receipts(self, chaindb: 'ChainDatabaseAPI') -> Tuple[ReceiptAPI, ...]:
+        """
+        Fetch the receipts for this block from the given ``chaindb``.
+        """
+        ...
+
     @property
     @abstractmethod
     def hash(self) -> Hash32:
@@ -336,6 +432,15 @@ def is_genesis(self) -> bool:
         """
         ...
 
+    # We can remove this API and inherit from rlp.Serializable when it becomes typesafe
+    def copy(self, *args: Any, **kwargs: Any) -> 'BlockAPI':
+        """
+        Return a copy of the block, optionally overwriting any of its properties.
+        """
+        # This method isn't marked abstract because derived classes implement it by deriving from
+        # rlp.Serializable but mypy won't recognize it as implemented.
+        ...
+
 
 class MetaWitnessAPI(ABC):
     @property
@@ -1749,6 +1854,16 @@ def get_accessed_slots(self) -> FrozenSet[int]:
         ...
 
 
+class AccountAPI(ABC):
+    """
+    A class representing an Ethereum account.
+    """
+    nonce: int
+    balance: int
+    storage_root: Hash32
+    code_hash: Hash32
+
+
 class AccountDatabaseAPI(ABC):
     """
     A class representing a database for accounts.
@@ -2807,7 +2922,7 @@ def previous_hashes(self) -> Optional[Iterable[Hash32]]:
 
     @staticmethod
     @abstractmethod
-    def get_uncle_reward(block_number: BlockNumber, uncle: BlockAPI) -> int:
+    def get_uncle_reward(block_number: BlockNumber, uncle: BlockHeaderAPI) -> int:
         """
         Return the reward which should be given to the miner of the given `uncle`.
 

eth/chains/base.py

@@ -317,7 +317,7 @@ def get_ancestors(self, limit: int, header: BlockHeaderAPI) -> Tuple[BlockAPI, .
         # We construct a temporary block object
         vm_class = self.get_vm_class_for_block_number(header.block_number)
         block_class = vm_class.get_block_class()
-        block = block_class(header=header, uncles=[])
+        block = block_class(header=header, uncles=[], transactions=[])
 
         ancestor_generator = iterate(compose(
             self.get_block_by_hash,
@@ -611,7 +611,7 @@ def validate_uncles(self, block: BlockAPI) -> None:
                 uncle_parent = self.get_block_header_by_hash(uncle.parent_hash)
             except HeaderNotFound:
                 raise ValidationError(
-                    f"Uncle ancestor not found: {uncle.parent_hash}"
+                    f"Uncle ancestor not found: {uncle.parent_hash!r}"
                 )
 
             uncle_vm_class = self.get_vm_class_for_block_number(uncle.block_number)
@@ -643,7 +643,7 @@ def apply_transaction(self,
 
         # since we are building the block locally, we have to persist all the incremental state
         vm.state.persist()
-        new_header = header_with_receipt.copy(state_root=vm.state.state_root)
+        new_header: BlockHeaderAPI = header_with_receipt.copy(state_root=vm.state.state_root)
 
         transactions = base_block.transactions + (transaction, )
         receipts = base_block.get_receipts(self.chaindb) + (receipt, )

eth/chains/tester/__init__.py

@@ -21,7 +21,6 @@
 )
 
 from eth.abc import (
-    BlockAPI,
     BlockHeaderAPI,
     VirtualMachineAPI,
 )
@@ -147,7 +146,7 @@ class MainnetTesterChain(BaseMainnetTesterChain):
     configuration of fork rules.
     """
 
-    def validate_seal(self, block: BlockAPI) -> None:
+    def validate_seal(self, header: BlockHeaderAPI) -> None:
         """
         We don't validate the proof of work seal on the tester chain.
         """

eth/consensus/clique/_utils.py

@@ -68,7 +68,7 @@ def get_signature_hash(header: BlockHeaderAPI) -> Hash32:
     if len(header.extra_data) < SIGNATURE_LENGTH:
         raise ValueError("header.extra_data too short to contain signature")
 
-    signature_header = header.copy(
+    signature_header: BlockHeaderAPI = header.copy(
         extra_data=header.extra_data[:len(header.extra_data) - SIGNATURE_LENGTH]
     )
     return signature_header.hash
@@ -162,7 +162,7 @@ def validate_header_integrity(header: BlockHeaderAPI, epoch_length: int) -> None
         raise ValidationError(f"Invalid mix hash: {header.mix_hash!r}")
 
     if header.uncles_hash != EMPTY_UNCLE_HASH:
-        raise ValidationError(f"Invalid uncle hash: {header.uncle_hash}")
+        raise ValidationError(f"Invalid uncle hash: {header.uncles_hash!r}")
 
     if header.difficulty not in ALLOWED_CLIQUE_DIFFICULTIES:
         raise ValidationError(f"Invalid difficulty: {header.difficulty}")

eth/db/chain.py

@@ -280,7 +280,7 @@ def persist_uncles(self, uncles: Tuple[BlockHeaderAPI]) -> Hash32:
         return self._persist_uncles(self.db, uncles)
 
     @staticmethod
-    def _persist_uncles(db: DatabaseAPI, uncles: Tuple[BlockHeaderAPI]) -> Hash32:
+    def _persist_uncles(db: DatabaseAPI, uncles: Tuple[BlockHeaderAPI, ...]) -> Hash32:
         uncles_hash = keccak(rlp.encode(uncles))
         db.set(
             uncles_hash,

eth/rlp/accounts.py

@@ -3,6 +3,7 @@
     big_endian_int,
 )
 
+from eth.abc import AccountAPI
 from eth.constants import (
     EMPTY_SHA3,
     BLANK_ROOT_HASH,
@@ -16,7 +17,7 @@
 from typing import Any
 
 
-class Account(rlp.Serializable):
+class Account(rlp.Serializable, AccountAPI):
     """
     RLP object for accounts.
     """