Fix type hints of transactions

Author: cburgdorf

eth/chains/base.py

@@ -24,6 +24,7 @@
 import logging
 
 from eth_typing import (
+    Address,
     BlockNumber,
     Hash32,
 )
@@ -241,9 +242,14 @@ def create_transaction(self, *args: Any, **kwargs: Any) -> BaseTransaction:
         raise NotImplementedError("Chain classes must implement this method")
 
     @abstractmethod
-    def create_unsigned_transaction(self,
-                                    *args: Any,
-                                    **kwargs: Any) -> BaseUnsignedTransaction:
+    def create_unsigned_transaction(cls,
+                                    *,
+                                    nonce: int,
+                                    gas_price: int,
+                                    gas: int,
+                                    to: Address,
+                                    value: int,
+                                    data: bytes) -> BaseUnsignedTransaction:
         raise NotImplementedError("Chain classes must implement this method")
 
     @abstractmethod
@@ -573,12 +579,24 @@ def create_transaction(self, *args: Any, **kwargs: Any) -> BaseTransaction:
         return self.get_vm().create_transaction(*args, **kwargs)
 
     def create_unsigned_transaction(self,
-                                    *args: Any,
-                                    **kwargs: Any) -> BaseUnsignedTransaction:
+                                    *,
+                                    nonce: int,
+                                    gas_price: int,
+                                    gas: int,
+                                    to: Address,
+                                    value: int,
+                                    data: bytes) -> BaseUnsignedTransaction:
         """
         Passthrough helper to the current VM class.
         """
-        return self.get_vm().create_unsigned_transaction(*args, **kwargs)
+        return self.get_vm().create_unsigned_transaction(
+            nonce=nonce,
+            gas_price=gas_price,
+            gas=gas,
+            to=to,
+            value=value,
+            data=data,
+        )
 
     #
     # Execution API

eth/rlp/transactions.py

@@ -2,9 +2,6 @@
     ABC,
     abstractmethod
 )
-from typing import (
-    Any,
-)
 
 import rlp
 from rlp.sedes import (
@@ -17,7 +14,9 @@
 )
 
 from eth_hash.auto import keccak
-
+from eth_keys.datatypes import (
+    PrivateKey
+)
 from eth_utils import (
     ValidationError,
 )
@@ -150,7 +149,14 @@ def get_message_for_signing(self) -> bytes:
 
     @classmethod
     @abstractmethod
-    def create_unsigned_transaction(self, *args: Any, **kwargs: Any) -> 'BaseTransaction':
+    def create_unsigned_transaction(cls,
+                                    *,
+                                    nonce: int,
+                                    gas_price: int,
+                                    gas: int,
+                                    to: Address,
+                                    value: int,
+                                    data: bytes) -> 'BaseUnsignedTransaction':
         """
         Create an unsigned transaction.
         """
@@ -171,7 +177,7 @@ class BaseUnsignedTransaction(rlp.Serializable, BaseTransactionMethods, ABC):
     # API that must be implemented by all Transaction subclasses.
     #
     @abstractmethod
-    def as_signed_transaction(self, private_key: bytes) -> 'BaseTransaction':
+    def as_signed_transaction(self, private_key: PrivateKey) -> 'BaseTransaction':
         """
         Return a version of this transaction which has been signed using the
         provided `private_key`

eth/vm/base.py

@@ -55,7 +55,10 @@
 from eth.rlp.sedes import (
     int32,
 )
-from eth.rlp.transactions import BaseTransaction
+from eth.rlp.transactions import (
+    BaseTransaction,
+    BaseUnsignedTransaction,
+)
 from eth.utils.datatypes import (
     Configurable,
 )
@@ -263,12 +266,19 @@ def get_uncle_reward(block_number: int, uncle: BaseBlock) -> int:
     # Transactions
     #
     @abstractmethod
-    def create_transaction(self, *args: Any, **kwargs: Any) -> Any:
+    def create_transaction(self, *args: Any, **kwargs: Any) -> BaseTransaction:
         raise NotImplementedError("VM classes must implement this method")
 
     @classmethod
     @abstractmethod
-    def create_unsigned_transaction(cls, *args: Any, **kwargs: Any) -> Any:
+    def create_unsigned_transaction(cls,
+                                    *,
+                                    nonce: int,
+                                    gas_price: int,
+                                    gas: int,
+                                    to: Address,
+                                    value: int,
+                                    data: bytes) -> BaseUnsignedTransaction:
         raise NotImplementedError("VM classes must implement this method")
 
     @classmethod
@@ -693,18 +703,32 @@ def previous_hashes(self) -> Optional[Tuple[Hash32, ...]]:
     #
     # Transactions
     #
-    def create_transaction(self, *args: Any, **kwargs: Any) -> BaseState:
+    def create_transaction(self, *args: Any, **kwargs: Any) -> BaseTransaction:
         """
         Proxy for instantiating a signed transaction for this VM.
         """
         return self.get_transaction_class()(*args, **kwargs)
 
     @classmethod
-    def create_unsigned_transaction(cls, *args: Any, **kwargs: Any) -> BaseTransaction:
+    def create_unsigned_transaction(cls,
+                                    *,
+                                    nonce: int,
+                                    gas_price: int,
+                                    gas: int,
+                                    to: Address,
+                                    value: int,
+                                    data: bytes) -> 'BaseUnsignedTransaction':
         """
         Proxy for instantiating an unsigned transaction for this VM.
         """
-        return cls.get_transaction_class().create_unsigned_transaction(*args, **kwargs)
+        return cls.get_transaction_class().create_unsigned_transaction(
+            nonce=nonce,
+            gas_price=gas_price,
+            gas=gas,
+            to=to,
+            value=value,
+            data=data
+        )
 
     @classmethod
     def get_transaction_class(cls) -> Type[BaseTransaction]:

eth/vm/forks/byzantium/transactions.py

@@ -1,11 +1,6 @@
 from eth_keys.datatypes import PrivateKey
 from eth_typing import Address
 
-from eth.rlp.transactions import (
-    BaseTransaction,
-    BaseUnsignedTransaction,
-)
-
 from eth.utils.transactions import (
     create_transaction_signature,
 )
@@ -18,21 +13,21 @@
 
 class ByzantiumTransaction(SpuriousDragonTransaction):
     @classmethod
-    def create_unsigned_transaction(cls,                 # type: ignore
+    def create_unsigned_transaction(cls,
                                     *,
                                     nonce: int,
                                     gas_price: int,
                                     gas: int,
                                     to: Address,
                                     value: int,
-                                    data: bytes) -> BaseTransaction:
+                                    data: bytes) -> 'ByzantiumUnsignedTransaction':
         return ByzantiumUnsignedTransaction(nonce, gas_price, gas, to, value, data)
 
 
 class ByzantiumUnsignedTransaction(SpuriousDragonUnsignedTransaction):
-    def as_signed_transaction(self,                          # type: ignore
+    def as_signed_transaction(self,
                               private_key: PrivateKey,
-                              chain_id: int=None) -> BaseUnsignedTransaction:
+                              chain_id: int=None) -> ByzantiumTransaction:
         v, r, s = create_transaction_signature(self, private_key, chain_id=chain_id)
         return ByzantiumTransaction(
             nonce=self.nonce,

eth/vm/forks/constantinople/transactions.py

@@ -1,11 +1,6 @@
 from eth_keys.datatypes import PrivateKey
 from eth_typing import Address
 
-from eth.rlp.transactions import (
-    BaseTransaction,
-    BaseUnsignedTransaction,
-)
-
 from eth.vm.forks.byzantium.transactions import (
     ByzantiumTransaction,
     ByzantiumUnsignedTransaction,
@@ -18,21 +13,21 @@
 
 class ConstantinopleTransaction(ByzantiumTransaction):
     @classmethod
-    def create_unsigned_transaction(cls,             # type: ignore
+    def create_unsigned_transaction(cls,
                                     *,
                                     nonce: int,
                                     gas_price: int,
                                     gas: int,
                                     to: Address,
                                     value: int,
-                                    data: bytes) -> BaseTransaction:
+                                    data: bytes) -> 'ConstantinopleUnsignedTransaction':
         return ConstantinopleUnsignedTransaction(nonce, gas_price, gas, to, value, data)
 
 
 class ConstantinopleUnsignedTransaction(ByzantiumUnsignedTransaction):
-    def as_signed_transaction(self,                         # type: ignore
+    def as_signed_transaction(self,
                               private_key: PrivateKey,
-                              chain_id: int=None) -> BaseUnsignedTransaction:
+                              chain_id: int=None) -> ConstantinopleTransaction:
         v, r, s = create_transaction_signature(self, private_key, chain_id=chain_id)
         return ConstantinopleTransaction(
             nonce=self.nonce,

eth/vm/forks/frontier/transactions.py

@@ -83,14 +83,14 @@ def get_message_for_signing(self) -> bytes:
         ))
 
     @classmethod
-    def create_unsigned_transaction(cls,                     # type: ignore
+    def create_unsigned_transaction(cls,
                                     *,
                                     nonce: int,
                                     gas_price: int,
                                     gas: int,
                                     to: Address,
                                     value: int,
-                                    data: bytes) -> BaseTransaction:
+                                    data: bytes) -> 'FrontierUnsignedTransaction':
         return FrontierUnsignedTransaction(nonce, gas_price, gas, to, value, data)
 
 
@@ -106,7 +106,7 @@ def validate(self) -> None:
         validate_is_bytes(self.data, title="Transaction.data")
         super().validate()
 
-    def as_signed_transaction(self, private_key: PrivateKey) -> BaseTransaction:    # type: ignore
+    def as_signed_transaction(self, private_key: PrivateKey) -> FrontierTransaction:
         v, r, s = create_transaction_signature(self, private_key)
         return FrontierTransaction(
             nonce=self.nonce,

eth/vm/forks/homestead/transactions.py

@@ -47,19 +47,19 @@ def get_message_for_signing(self) -> bytes:
         ))
 
     @classmethod
-    def create_unsigned_transaction(cls,        # type: ignore
+    def create_unsigned_transaction(cls,
                                     *,
                                     nonce: int,
                                     gas_price: int,
                                     gas: int,
                                     to: Address,
                                     value: int,
-                                    data: bytes) -> BaseTransaction:
+                                    data: bytes) -> 'HomesteadUnsignedTransaction':
         return HomesteadUnsignedTransaction(nonce, gas_price, gas, to, value, data)
 
 
 class HomesteadUnsignedTransaction(FrontierUnsignedTransaction):
-    def as_signed_transaction(self, private_key: PrivateKey) -> BaseTransaction:    # type: ignore
+    def as_signed_transaction(self, private_key: PrivateKey) -> HomesteadTransaction:
         v, r, s = create_transaction_signature(self, private_key)
         return HomesteadTransaction(
             nonce=self.nonce,

eth/vm/forks/spurious_dragon/transactions.py

@@ -12,11 +12,6 @@
 
 import rlp
 
-from eth.rlp.transactions import (
-    BaseTransaction,
-    BaseUnsignedTransaction,
-)
-
 from eth.vm.forks.homestead.transactions import (
     HomesteadTransaction,
     HomesteadUnsignedTransaction,
@@ -46,14 +41,14 @@ def get_message_for_signing(self) -> bytes:
             ))
 
     @classmethod
-    def create_unsigned_transaction(cls,         # type: ignore
+    def create_unsigned_transaction(cls,
                                     *,
                                     nonce: int,
                                     gas_price: int,
                                     gas: int,
                                     to: Address,
                                     value: int,
-                                    data: bytes) -> BaseTransaction:
+                                    data: bytes) -> 'SpuriousDragonUnsignedTransaction':
         return SpuriousDragonUnsignedTransaction(nonce, gas_price, gas, to, value, data)
 
     @property
@@ -79,9 +74,9 @@ def v_max(self) -> int:     # type: ignore
 
 
 class SpuriousDragonUnsignedTransaction(HomesteadUnsignedTransaction):
-    def as_signed_transaction(self,                     # type: ignore
+    def as_signed_transaction(self,
                               private_key: PrivateKey,
-                              chain_id: int=None) -> BaseUnsignedTransaction:
+                              chain_id: int=None) -> SpuriousDragonTransaction:
         v, r, s = create_transaction_signature(self, private_key, chain_id=chain_id)
         return SpuriousDragonTransaction(
             nonce=self.nonce,

trinity/chains/light.py

@@ -17,6 +17,7 @@
 )
 
 from eth_typing import (
+    Address,
     BlockNumber,
     Hash32,
 )
@@ -184,9 +185,14 @@ def build_block_with_transactions(
     def create_transaction(self, *args: Any, **kwargs: Any) -> BaseTransaction:
         raise NotImplementedError("Chain classes must implement " + inspect.stack()[0][3])
 
-    def create_unsigned_transaction(self,
-                                    *args: Any,
-                                    **kwargs: Any) -> BaseUnsignedTransaction:
+    def create_unsigned_transaction(cls,
+                                    *,
+                                    nonce: int,
+                                    gas_price: int,
+                                    gas: int,
+                                    to: Address,
+                                    value: int,
+                                    data: bytes) -> BaseUnsignedTransaction:
         raise NotImplementedError("Chain classes must implement " + inspect.stack()[0][3])
 
     def get_canonical_transaction(self, transaction_hash: Hash32) -> BaseTransaction: