Enable complete type hinting for eth.precompiles

Author: Bhargavasomu

eth/precompiles/ecadd.py

@@ -1,3 +1,5 @@
+from typing import Tuple
+
 from py_ecc import (
     optimized_bn128 as bn128,
 )
@@ -21,8 +23,12 @@
     pad32r,
 )
 
+from eth.vm.computation import (
+    BaseComputation,
+)
+
 
-def ecadd(computation):
+def ecadd(computation: BaseComputation) -> BaseComputation:
     computation.consume_gas(constants.GAS_ECADD, reason='ECADD Precompile')
 
     try:
@@ -39,7 +45,7 @@ def ecadd(computation):
     return computation
 
 
-def _ecadd(data):
+def _ecadd(data: bytes) -> Tuple[bn128.FQ, bn128.FQ]:
     x1_bytes = pad32r(data[:32])
     y1_bytes = pad32r(data[32:64])
     x2_bytes = pad32r(data[64:96])

eth/precompiles/ecmul.py

@@ -1,3 +1,5 @@
+from typing import Tuple
+
 from py_ecc import (
     optimized_bn128 as bn128,
 )
@@ -21,8 +23,12 @@
     pad32r,
 )
 
+from eth.vm.computation import (
+    BaseComputation,
+)
+
 
-def ecmul(computation):
+def ecmul(computation: BaseComputation) -> BaseComputation:
     computation.consume_gas(constants.GAS_ECMUL, reason='ECMUL Precompile')
 
     try:
@@ -39,7 +45,7 @@ def ecmul(computation):
     return computation
 
 
-def _ecmull(data):
+def _ecmull(data: bytes) -> Tuple[bn128.FQ, bn128.FQ]:
     x_bytes = pad32r(data[:32])
     y_bytes = pad32r(data[32:64])
     m_bytes = pad32r(data[64:96])

eth/precompiles/ecpairing.py

@@ -1,3 +1,5 @@
+from typing import Tuple
+
 from cytoolz import (
     curry,
     pipe,
@@ -16,19 +18,24 @@
 from eth.exceptions import (
     VMError,
 )
+
 from eth.utils.bn128 import (
     validate_point,
 )
 from eth.utils.padding import (
     pad32,
 )
 
+from eth.vm.computation import (
+    BaseComputation,
+)
+
 
 ZERO = (bn128.FQ2.one(), bn128.FQ2.one(), bn128.FQ2.zero())
 EXPONENT = bn128.FQ12.one()
 
 
-def ecpairing(computation):
+def ecpairing(computation: BaseComputation) -> BaseComputation:
     if len(computation.msg.data) % 192:
         # data length must be an exact multiple of 192
         raise VMError("Invalid ECPAIRING parameters")
@@ -52,7 +59,7 @@ def ecpairing(computation):
     return computation
 
 
-def _ecpairing(data):
+def _ecpairing(data: bytes) -> bool:
     exponent = bn128.FQ12.one()
 
     processing_pipeline = (
@@ -67,7 +74,7 @@ def _ecpairing(data):
 
 
 @curry
-def _process_point(data_buffer, exponent):
+def _process_point(data_buffer: bytes, exponent: int) -> int:
     x1, y1, x2_i, x2_r, y2_i, y2_r = _extract_point(data_buffer)
     p1 = validate_point(x1, y1)
 
@@ -91,7 +98,7 @@ def _process_point(data_buffer, exponent):
     return exponent * bn128.pairing(p2, p1, final_exponentiate=False)
 
 
-def _extract_point(data_slice):
+def _extract_point(data_slice: bytes) -> Tuple[int, int, int, int, int, int]:
     x1_bytes = data_slice[:32]
     y1_bytes = data_slice[32:64]
     x2_i_bytes = data_slice[64:96]

eth/precompiles/ecrecover.py

@@ -10,19 +10,22 @@
 
 from eth import constants
 
+from eth.utils.padding import (
+    pad32,
+    pad32r,
+)
+
 from eth.validation import (
     validate_lt_secpk1n,
     validate_gte,
     validate_lte,
 )
-
-from eth.utils.padding import (
-    pad32,
-    pad32r,
+from eth.vm.computation import (
+    BaseComputation,
 )
 
 
-def ecrecover(computation):
+def ecrecover(computation: BaseComputation) -> BaseComputation:
     computation.consume_gas(constants.GAS_ECRECOVER, reason="ECRecover Precompile")
     raw_message_hash = computation.msg.data[:32]
     message_hash = pad32r(raw_message_hash)

eth/precompiles/identity.py

@@ -3,8 +3,12 @@
     ceil32,
 )
 
+from eth.vm.computation import (
+    BaseComputation,
+)
+
 
-def identity(computation):
+def identity(computation: BaseComputation) -> BaseComputation:
     word_count = ceil32(len(computation.msg.data)) // 32
     gas_fee = constants.GAS_IDENTITY + word_count * constants.GAS_IDENTITYWORD
 

eth/precompiles/modexp.py

@@ -1,3 +1,7 @@
+from typing import (
+    Tuple,
+)
+
 from eth_utils import (
     big_endian_to_int,
     int_to_big_endian,
@@ -14,8 +18,13 @@
     zpad_left,
 )
 
+from eth.vm.computation import (
+    BaseComputation,
+)
+
 
-def _compute_adjusted_exponent_length(exponent_length, first_32_exponent_bytes):
+def _compute_adjusted_exponent_length(exponent_length: int,
+                                      first_32_exponent_bytes: bytes) -> int:
     exponent = big_endian_to_int(first_32_exponent_bytes)
 
     if exponent_length <= 32 and exponent == 0:
@@ -30,7 +39,7 @@ def _compute_adjusted_exponent_length(exponent_length, first_32_exponent_bytes):
         )
 
 
-def _compute_complexity(length):
+def _compute_complexity(length: int) -> int:
     if length <= 64:
         return length ** 2
     elif length <= 1024:
@@ -41,7 +50,7 @@ def _compute_complexity(length):
         return length ** 2 // 16 + 480 * length - 199680
 
 
-def _extract_lengths(data):
+def _extract_lengths(data: bytes) -> Tuple[int, int, int]:
     # extract argument lengths
     base_length_bytes = pad32r(data[:32])
     base_length = big_endian_to_int(base_length_bytes)
@@ -55,7 +64,7 @@ def _extract_lengths(data):
     return base_length, exponent_length, modulus_length
 
 
-def _compute_modexp_gas_fee(data):
+def _compute_modexp_gas_fee(data: bytes) -> int:
     base_length, exponent_length, modulus_length = _extract_lengths(data)
 
     first_32_exponent_bytes = zpad_right(
@@ -76,7 +85,7 @@ def _compute_modexp_gas_fee(data):
     return gas_fee
 
 
-def _modexp(data):
+def _modexp(data: bytes) -> int:
     base_length, exponent_length, modulus_length = _extract_lengths(data)
 
     if base_length == 0:
@@ -112,7 +121,7 @@ def _modexp(data):
     return result
 
 
-def modexp(computation):
+def modexp(computation: BaseComputation) -> BaseComputation:
     """
     https://github.com/ethereum/EIPs/pull/198
     """

eth/precompiles/ripemd160.py

@@ -8,9 +8,12 @@
 from eth.utils.padding import (
     pad32,
 )
+from eth.vm.computation import (
+    BaseComputation,
+)
 
 
-def ripemd160(computation):
+def ripemd160(computation: BaseComputation) -> BaseComputation:
     word_count = ceil32(len(computation.msg.data)) // 32
     gas_fee = constants.GAS_RIPEMD160 + word_count * constants.GAS_RIPEMD160WORD
 

eth/precompiles/sha256.py

@@ -6,8 +6,12 @@
     ceil32,
 )
 
+from eth.vm.computation import (
+    BaseComputation,
+)
+
 
-def sha256(computation):
+def sha256(computation: BaseComputation) -> BaseComputation:
     word_count = ceil32(len(computation.msg.data)) // 32
     gas_fee = constants.GAS_SHA256 + word_count * constants.GAS_SHA256WORD