#127 - Replace deprecated typing features

- typing.Dict → dict
- typing.List → list
- typing.Tuple → tuple
- typing.Sequence → collections.abc.Sequence

Author: Raad05

uniswap_universal_router_decoder/_abi_builder.py

@@ -7,14 +7,12 @@
 """
 from __future__ import annotations
 
+from collections.abc import Sequence
 from io import BytesIO
 from typing import (
     Any,
     cast,
-    Dict,
-    List,
     Optional,
-    Sequence,
     Union,
 )
 
@@ -30,7 +28,7 @@
 )
 
 
-def _get_types_from_list(type_list: List[Any]) -> List[str]:
+def _get_types_from_list(type_list: list[Any]) -> list[str]:
     types = []
     for item in type_list:
         if item["type"][:5] == "tuple":
@@ -41,28 +39,28 @@ def _get_types_from_list(type_list: List[Any]) -> List[str]:
     return types
 
 
-def build_abi_type_list(abi_dict: Dict[str, Any]) -> List[str]:
+def build_abi_type_list(abi_dict: dict[str, Any]) -> list[str]:
     return _get_types_from_list(abi_dict["inputs"])
 
 
 class FunctionABI:
-    def __init__(self, inputs: List[Any], name: str, _type: str) -> None:
+    def __init__(self, inputs: list[Any], name: str, _type: str) -> None:
         self.inputs = inputs
         self.name = name
         self.type = _type
 
-    def get_abi(self) -> Dict[str, Any]:
+    def get_abi(self) -> dict[str, Any]:
         return {"inputs": self.inputs, "name": self.name, "type": self.type}
 
-    def get_struct_abi(self) -> Dict[str, Any]:
+    def get_struct_abi(self) -> dict[str, Any]:
         result = self.get_abi()
         result["components"] = result.pop("inputs")
         return result
 
-    def get_full_abi(self) -> List[Dict[str, Any]]:
+    def get_full_abi(self) -> list[dict[str, Any]]:
         return [self.get_abi()]
 
-    def get_abi_types(self) -> List[str]:
+    def get_abi_types(self) -> list[str]:
         return build_abi_type_list(self.get_abi())
 
     def get_signature(self) -> str:
@@ -75,7 +73,7 @@ def encode(self, args: Sequence[Any]) -> bytes:
         return encode(self.get_abi_types(), args)
 
 
-ABIMap = Dict[Union[MiscFunctions, RouterFunction, V4Actions], FunctionABI]
+ABIMap = dict[Union[MiscFunctions, RouterFunction, V4Actions], FunctionABI]
 
 
 class FunctionABIBuilder:
@@ -438,12 +436,12 @@ def _build_v4_swap_exact_in() -> FunctionABI:
         builder = FunctionABIBuilder(V4Actions.SWAP_EXACT_IN.name)
         return builder.add_v4_exact_input_params().build()
 
-    def decode_v4_exact_input_params(self, stream: BytesIO) -> Dict[str, Any]:
+    def decode_v4_exact_input_params(self, stream: BytesIO) -> dict[str, Any]:
         fct_abi = self.abi_map[MiscFunctions.STRICT_V4_SWAP_EXACT_IN]
         raw_data = stream.read()
         sub_contract = self.w3.eth.contract(abi=fct_abi.get_full_abi())
         fct_name, decoded_params = sub_contract.decode_function_input(fct_abi.get_selector() + raw_data[32:])
-        return cast(Dict[str, Any], decoded_params)
+        return cast(dict[str, Any], decoded_params)
 
     def encode_v4_exact_input_params(self, args: Sequence[Any]) -> bytes:
         fct_abi = self.abi_map[MiscFunctions.STRICT_V4_SWAP_EXACT_IN]
@@ -455,12 +453,12 @@ def _build_v4_swap_exact_out() -> FunctionABI:
         builder = FunctionABIBuilder(V4Actions.SWAP_EXACT_OUT.name)
         return builder.add_v4_exact_output_params().build()
 
-    def decode_v4_exact_output_params(self, stream: BytesIO) -> Dict[str, Any]:
+    def decode_v4_exact_output_params(self, stream: BytesIO) -> dict[str, Any]:
         fct_abi = self.abi_map[MiscFunctions.STRICT_V4_SWAP_EXACT_OUT]
         raw_data = stream.read()
         sub_contract = self.w3.eth.contract(abi=fct_abi.get_full_abi())
         fct_name, decoded_params = sub_contract.decode_function_input(fct_abi.get_selector() + raw_data[32:])
-        return cast(Dict[str, Any], decoded_params)
+        return cast(dict[str, Any], decoded_params)
 
     def encode_v4_exact_output_params(self, args: Sequence[Any]) -> bytes:
         fct_abi = self.abi_map[MiscFunctions.STRICT_V4_SWAP_EXACT_OUT]

uniswap_universal_router_decoder/_decoder.py

@@ -5,14 +5,11 @@
 * License: MIT.
 * Doc: https://github.com/Elnaril/uniswap-universal-router-decoder
 """
+from collections.abc import Sequence
 from itertools import chain
 import json
 from typing import (
     Any,
-    Dict,
-    List,
-    Sequence,
-    Tuple,
     Union,
 )
 
@@ -54,7 +51,7 @@ def __init__(self, w3: Web3, abi_map: ABIMap) -> None:
     def _decode_v4_actions(
             self,
             actions: bytes,
-            params: List[bytes]) -> List[Tuple[BaseContractFunction, Dict[str, Any]]]:
+            params: list[bytes]) -> list[tuple[BaseContractFunction, dict[str, Any]]]:
         if len(actions) != len(params):
             raise ValueError(f"Number of actions {len(actions)} is different from number of params: {len(params)}")
 
@@ -69,10 +66,10 @@ def _decode_v4_actions(
                 decoded_params.append(params[i].hex())
         return decoded_params
 
-    def decode_v4_swap(self, actions: bytes, params: List[bytes]) -> List[Tuple[BaseContractFunction, Dict[str, Any]]]:
+    def decode_v4_swap(self, actions: bytes, params: list[bytes]) -> list[tuple[BaseContractFunction, dict[str, Any]]]:
         return self._decode_v4_actions(actions, params)
 
-    def decode_v4_pm_call(self, encoded_input: bytes) -> Dict[str, Any]:
+    def decode_v4_pm_call(self, encoded_input: bytes) -> dict[str, Any]:
         actions, params = decode(["bytes", "bytes[]"], encoded_input)
         return {"actions": actions, "params": self._decode_v4_actions(actions, params)}
 
@@ -84,7 +81,7 @@ def __init__(self, w3: Web3, abi_map: ABIMap) -> None:
         self._abi_map = abi_map
         self._v4_decoder = _V4Decoder(w3, abi_map)
 
-    def function_input(self, input_data: Union[HexStr, HexBytes]) -> Tuple[BaseContractFunction, Dict[str, Any]]:
+    def function_input(self, input_data: Union[HexStr, HexBytes]) -> tuple[BaseContractFunction, dict[str, Any]]:
         """
         Decode the data sent to an UR function
 
@@ -147,7 +144,7 @@ def function_input(self, input_data: Union[HexStr, HexBytes]) -> Tuple[BaseContr
         decoded_input["inputs"] = decoded_command_input
         return fct_name, decoded_input
 
-    def transaction(self, trx_hash: Union[HexBytes, HexStr]) -> Dict[str, Any]:
+    def transaction(self, trx_hash: Union[HexBytes, HexStr]) -> dict[str, Any]:
         """
         Get transaction details and decode the data used to call a UR function.
 
@@ -166,7 +163,7 @@ def _get_transaction(self, trx_hash: Union[HexBytes, HexStr]) -> TxData:
         return self._w3.eth.get_transaction(trx_hash)
 
     @staticmethod
-    def v3_path(v3_fn_name: str, path: Union[bytes, str]) -> Tuple[Union[int, ChecksumAddress], ...]:
+    def v3_path(v3_fn_name: str, path: Union[bytes, str]) -> tuple[Union[int, ChecksumAddress], ...]:
         """
         Decode a V3 router path
 
@@ -180,8 +177,8 @@ def v3_path(v3_fn_name: str, path: Union[bytes, str]) -> Tuple[Union[int, Checks
             raise ValueError(f"v3_fn_name must be in {valid_fn_names}")
         path_str = path.hex() if isinstance(path, bytes) else str(path)
         path_str = path_str[2:] if path_str.startswith("0x") else path_str
-        path_list: List[Union[int, ChecksumAddress]] = [Web3.to_checksum_address(path_str[0:40]), ]
-        parsed_remaining_path: List[List[Union[int, ChecksumAddress]]] = [
+        path_list: list[Union[int, ChecksumAddress]] = [Web3.to_checksum_address(path_str[0:40]), ]
+        parsed_remaining_path: list[list[Union[int, ChecksumAddress]]] = [
             [
                 int(path_str[40:][i:i + 6], 16),
                 Web3.to_checksum_address(path_str[40:][i + 6:i + 46]),
@@ -199,7 +196,7 @@ def contract_error(
             self,
             contract_error: Union[str, HexStr],
             abis: Sequence[str] = (_permit2_abi, _pool_manager_abi, _position_manager_abi, _router_abi),
-    ) -> Tuple[str, Dict[str, Any]]:
+    ) -> tuple[str, dict[str, Any]]:
         """
         Decode contract custom errors.
 

uniswap_universal_router_decoder/_encoder.py

@@ -8,13 +8,11 @@
 from __future__ import annotations
 
 from abc import ABC
+from collections.abc import Sequence
 from typing import (
     Any,
     cast,
-    Dict,
-    List,
     Optional,
-    Sequence,
     TypedDict,
     TypeVar,
     Union,
@@ -182,7 +180,7 @@ def __init__(self, builder: _ChainedFunctionBuilder, w3: Web3, abi_map: ABIMap):
         self._w3 = w3
         self._abi_map = abi_map
         self.actions: bytearray = bytearray()
-        self.arguments: List[bytes] = []
+        self.arguments: list[bytes] = []
 
     def _add_action(self, action: V4Actions, args: Sequence[Any]) -> None:
         abi = self._abi_map[action]
@@ -523,7 +521,7 @@ def __init__(self, w3: Web3, abi_map: ABIMap):
         self._router_contract = self._w3.eth.contract(abi=_router_abi)
         self._abi_map = abi_map
         self.commands: bytearray = bytearray()
-        self.arguments: List[bytes] = []
+        self.arguments: list[bytes] = []
 
     def _add_command(self, command: RouterFunction, args: Sequence[Any], add_selector: bool = False) -> None:
         abi = self._abi_map[command]
@@ -758,7 +756,7 @@ def v3_swap_exact_out(
 
     def permit2_permit(
             self,
-            permit_single: Dict[str, Any],
+            permit_single: dict[str, Any],
             signed_permit_single: SignedMessage) -> _ChainedFunctionBuilder:
         """
         Encode the call to the function PERMIT2_PERMIT, which gives token allowances to the Permit2 contract.

uniswap_universal_router_decoder/router_codec.py

@@ -8,9 +8,7 @@
 from datetime import datetime
 from typing import (
     Any,
-    Dict,
     Optional,
-    Tuple,
 )
 
 from eth_account.messages import (
@@ -84,7 +82,7 @@ def create_permit2_signable_message(
             spender: ChecksumAddress,
             deadline: int,
             chain_id: int = 1,
-            verifying_contract: ChecksumAddress = _permit2_address) -> Tuple[Dict[str, Any], SignableMessage]:
+            verifying_contract: ChecksumAddress = _permit2_address) -> tuple[dict[str, Any], SignableMessage]:
         """
         Create a eth_account.messages.SignableMessage that will be sent to the UR/Permit2 contracts
         to set token permissions through signature validation.
@@ -136,7 +134,7 @@ def fetch_permit2_allowance(
             spender: ChecksumAddress = _ur_address,
             permit2: ChecksumAddress = _permit2_address,
             permit2_abi: str = _permit2_abi,
-            block_identifier: BlockIdentifier = "latest") -> Tuple[Wei, int, Nonce]:
+            block_identifier: BlockIdentifier = "latest") -> tuple[Wei, int, Nonce]:
         """
         Request the permit2 allowance function to know if the UR has enough valid allowance,
         and to get the current permit2 nonce for a given wallet and token.

uniswap_universal_router_decoder/utils.py

@@ -1,9 +1,6 @@
+from collections.abc import Sequence
 from statistics import quantiles
-from typing import (
-    cast,
-    Sequence,
-    Tuple,
-)
+from typing import cast
 
 from web3 import Web3
 from web3.types import (
@@ -26,7 +23,7 @@
 def compute_gas_fees(
         w3: Web3,
         trx_speed: TransactionSpeed = TransactionSpeed.FAST,
-        block_identifier: BlockIdentifier = "latest") -> Tuple[Wei, Wei]:
+        block_identifier: BlockIdentifier = "latest") -> tuple[Wei, Wei]:
     """
     Compute the priority_fee (maxPriorityFeePerGas) and max_fee_per_gas (maxFeePerGas) according to the given
     transaction 'speed'. All speeds will compute gas fees in order to try to place the transaction in the next block