Added better typing

Author: thewhaleking

async_substrate_interface/async_substrate.py

@@ -689,7 +689,7 @@ async def _start_receiving(self):
         except ConnectionClosed:
             await self.connect(force=True)
 
-    async def send(self, payload: dict) -> int:
+    async def send(self, payload: dict) -> str:
         """
         Sends a payload to the websocket connection.
 
@@ -714,6 +714,7 @@ async def send(self, payload: dict) -> int:
             return original_id
         except (ConnectionClosed, ssl.SSLError, EOFError):
             await self.connect(force=True)
+            return await self.send(payload)
 
     async def retrieve(self, item_id: int) -> Optional[dict]:
         """
@@ -911,7 +912,7 @@ async def name(self):
         return self._name
 
     async def get_storage_item(
-        self, module: str, storage_function: str, block_hash: str = None
+        self, module: str, storage_function: str, block_hash: Optional[str] = None
     ):
         runtime = await self.init_runtime(block_hash=block_hash)
         metadata_pallet = runtime.metadata.get_metadata_pallet(module)
@@ -1154,7 +1155,7 @@ async def create_storage_key(
         pallet: str,
         storage_function: str,
         params: Optional[list] = None,
-        block_hash: str = None,
+        block_hash: Optional[str] = None,
     ) -> StorageKey:
         """
         Create a `StorageKey` instance providing storage function details. See `subscribe_storage()`.
@@ -1169,7 +1170,7 @@ async def create_storage_key(
             StorageKey
         """
         runtime = await self.init_runtime(block_hash=block_hash)
-
+        params = params or []
         return StorageKey.create_from_storage_function(
             pallet,
             storage_function,
@@ -1424,7 +1425,7 @@ async def get_metadata_error(
                         return error
 
     async def get_metadata_runtime_call_functions(
-        self, block_hash: str = None, runtime: Optional[Runtime] = None
+        self, block_hash: Optional[str] = None, runtime: Optional[Runtime] = None
     ) -> list[GenericRuntimeCallDefinition]:
         """
         Get a list of available runtime API calls
@@ -1763,7 +1764,7 @@ async def get_block_header(
         ignore_decoding_errors: bool = False,
         include_author: bool = False,
         finalized_only: bool = False,
-    ) -> dict:
+    ) -> Optional[dict]:
         """
         Retrieves a block header and decodes its containing log digest items. If `block_hash` and `block_number`
         is omitted the chain tip will be retrieved, or the finalized head if `finalized_only` is set to true.
@@ -1790,7 +1791,7 @@ async def get_block_header(
             block_hash = await self.get_block_hash(block_number)
 
             if block_hash is None:
-                return
+                return None
 
         if block_hash and finalized_only:
             raise ValueError(
@@ -1820,7 +1821,7 @@ async def get_block_header(
 
     async def subscribe_block_headers(
         self,
-        subscription_handler: callable,
+        subscription_handler: Callable,
         ignore_decoding_errors: bool = False,
         include_author: bool = False,
         finalized_only=False,
@@ -1902,7 +1903,7 @@ def retrieve_extrinsic_by_hash(
         )
 
     async def get_extrinsics(
-        self, block_hash: str = None, block_number: int = None
+        self, block_hash: Optional[str] = None, block_number: Optional[int] = None
     ) -> Optional[list["AsyncExtrinsicReceipt"]]:
         """
         Return all extrinsics for given block_hash or block_number
@@ -2780,7 +2781,7 @@ async def create_signed_extrinsic(
         self,
         call: GenericCall,
         keypair: Keypair,
-        era: Optional[dict] = None,
+        era: Optional[Union[dict, str]] = None,
         nonce: Optional[int] = None,
         tip: int = 0,
         tip_asset_id: Optional[int] = None,
@@ -2932,12 +2933,12 @@ async def _do_runtime_call_old(
         params: Optional[Union[list, dict]] = None,
         block_hash: Optional[str] = None,
         runtime: Optional[Runtime] = None,
-    ) -> ScaleType:
+    ) -> ScaleObj:
         logger.debug(
             f"Decoding old runtime call: {api}.{method} with params: {params} at block hash: {block_hash}"
         )
         runtime_call_def = _TYPE_REGISTRY["runtime_api"][api]["methods"][method]
-
+        params = params or []
         # Encode params
         param_data = b""
 
@@ -3245,7 +3246,7 @@ async def get_payment_info(
         return result.value
 
     async def get_type_registry(
-        self, block_hash: str = None, max_recursion: int = 4
+        self, block_hash: Optional[str] = None, max_recursion: int = 4
     ) -> dict:
         """
         Generates an exhaustive list of which RUST types exist in the runtime specified at given block_hash (or
@@ -3284,7 +3285,7 @@ async def get_type_registry(
         return type_registry
 
     async def get_type_definition(
-        self, type_string: str, block_hash: str = None
+        self, type_string: str, block_hash: Optional[str] = None
     ) -> str:
         """
         Retrieves SCALE encoding specifications of given type_string
@@ -3589,11 +3590,11 @@ async def create_multisig_extrinsic(
         keypair: Keypair,
         multisig_account: MultiAccountId,
         max_weight: Optional[Union[dict, int]] = None,
-        era: dict = None,
-        nonce: int = None,
+        era: Optional[dict] = None,
+        nonce: Optional[int] = None,
         tip: int = 0,
-        tip_asset_id: int = None,
-        signature: Union[bytes, str] = None,
+        tip_asset_id: Optional[int] = None,
+        signature: Optional[Union[bytes, str]] = None,
     ) -> GenericExtrinsic:
         """
         Create a Multisig extrinsic that will be signed by one of the signatories. Checks on-chain if the threshold
@@ -3878,6 +3879,9 @@ async def get_block_number(self, block_hash: Optional[str] = None) -> int:
         elif "result" in response:
             if response["result"]:
                 return int(response["result"]["number"], 16)
+        raise SubstrateRequestException(
+            f"Unable to retrieve block number for {block_hash}"
+        )
 
     async def close(self):
         """
@@ -3973,14 +3977,14 @@ async def get_async_substrate_interface(
     """
     substrate = AsyncSubstrateInterface(
         url,
-        use_remote_preset,
-        auto_discover,
-        ss58_format,
-        type_registry,
-        chain_name,
-        max_retries,
-        retry_timeout,
-        _mock,
+        use_remote_preset=use_remote_preset,
+        auto_discover=auto_discover,
+        ss58_format=ss58_format,
+        type_registry=type_registry,
+        chain_name=chain_name,
+        max_retries=max_retries,
+        retry_timeout=retry_timeout,
+        _mock=_mock,
     )
     await substrate.initialize()
     return substrate

async_substrate_interface/sync_substrate.py

@@ -641,7 +641,7 @@ def connect(self, init=False):
                     raise ConnectionError(e)
 
     def get_storage_item(
-        self, module: str, storage_function: str, block_hash: str = None
+        self, module: str, storage_function: str, block_hash: Optional[str] = None
     ):
         self.init_runtime(block_hash=block_hash)
         metadata_pallet = self.runtime.metadata.get_metadata_pallet(module)
@@ -659,7 +659,9 @@ def _get_current_block_hash(
                 return self.last_block_hash
         return block_hash
 
-    def _load_registry_at_block(self, block_hash: Optional[str]) -> MetadataV15:
+    def _load_registry_at_block(
+        self, block_hash: Optional[str]
+    ) -> tuple[Optional[MetadataV15], Optional[PortableRegistry]]:
         # Should be called for any block that fails decoding.
         # Possibly the metadata was different.
         try:
@@ -864,7 +866,7 @@ def create_storage_key(
         pallet: str,
         storage_function: str,
         params: Optional[list] = None,
-        block_hash: str = None,
+        block_hash: Optional[str] = None,
     ) -> StorageKey:
         """
         Create a `StorageKey` instance providing storage function details. See `subscribe_storage()`.
@@ -883,7 +885,7 @@ def create_storage_key(
         return StorageKey.create_from_storage_function(
             pallet,
             storage_function,
-            params,
+            params or [],
             runtime_config=self.runtime_config,
             metadata=self.runtime.metadata,
         )
@@ -1104,7 +1106,7 @@ def get_metadata_error(self, module_name, error_name, block_hash=None):
                         return error
 
     def get_metadata_runtime_call_functions(
-        self, block_hash: str = None
+        self, block_hash: Optional[str] = None
     ) -> list[GenericRuntimeCallDefinition]:
         """
         Get a list of available runtime API calls
@@ -1124,7 +1126,7 @@ def get_metadata_runtime_call_functions(
         return call_functions
 
     def get_metadata_runtime_call_function(
-        self, api: str, method: str, block_hash: str = None
+        self, api: str, method: str, block_hash: Optional[str] = None
     ) -> GenericRuntimeCallDefinition:
         """
         Get details of a runtime API call
@@ -1416,7 +1418,7 @@ def get_block_header(
         ignore_decoding_errors: bool = False,
         include_author: bool = False,
         finalized_only: bool = False,
-    ) -> dict:
+    ) -> Optional[dict]:
         """
         Retrieves a block header and decodes its containing log digest items. If `block_hash` and `block_number`
         is omitted the chain tip will be retrieved, or the finalized head if `finalized_only` is set to true.
@@ -1473,7 +1475,7 @@ def get_block_header(
 
     def subscribe_block_headers(
         self,
-        subscription_handler: callable,
+        subscription_handler: Callable,
         ignore_decoding_errors: bool = False,
         include_author: bool = False,
         finalized_only=False,
@@ -1555,7 +1557,7 @@ def retrieve_extrinsic_by_hash(
         )
 
     def get_extrinsics(
-        self, block_hash: str = None, block_number: int = None
+        self, block_hash: str = None, block_number: Optional[int] = None
     ) -> Optional[list["ExtrinsicReceipt"]]:
         """
         Return all extrinsics for given block_hash or block_number
@@ -2349,7 +2351,7 @@ def create_signed_extrinsic(
         self,
         call: GenericCall,
         keypair: Keypair,
-        era: Optional[dict] = None,
+        era: Optional[Union[dict, str]] = None,
         nonce: Optional[int] = None,
         tip: int = 0,
         tip_asset_id: Optional[int] = None,
@@ -2496,7 +2498,7 @@ def _do_runtime_call_old(
         method: str,
         params: Optional[Union[list, dict]] = None,
         block_hash: Optional[str] = None,
-    ) -> ScaleType:
+    ) -> ScaleObj:
         logger.debug(
             f"Decoding old runtime call: {api}.{method} with params: {params} at block hash: {block_hash}"
         )
@@ -2544,7 +2546,7 @@ def runtime_call(
         method: str,
         params: Optional[Union[list, dict]] = None,
         block_hash: Optional[str] = None,
-    ) -> ScaleType:
+    ) -> ScaleObj:
         """
         Calls a runtime API method
 
@@ -2770,7 +2772,9 @@ def get_payment_info(self, call: GenericCall, keypair: Keypair) -> dict[str, Any
 
         return result.value
 
-    def get_type_registry(self, block_hash: str = None, max_recursion: int = 4) -> dict:
+    def get_type_registry(
+        self, block_hash: Optional[str] = None, max_recursion: int = 4
+    ) -> dict:
         """
         Generates an exhaustive list of which RUST types exist in the runtime specified at given block_hash (or
         chaintip if block_hash is omitted)
@@ -2807,7 +2811,9 @@ def get_type_registry(self, block_hash: str = None, max_recursion: int = 4) -> d
 
         return type_registry
 
-    def get_type_definition(self, type_string: str, block_hash: str = None) -> str:
+    def get_type_definition(
+        self, type_string: str, block_hash: Optional[str] = None
+    ) -> str:
         """
         Retrieves SCALE encoding specifications of given type_string
 
@@ -3052,11 +3058,11 @@ def create_multisig_extrinsic(
         keypair: Keypair,
         multisig_account: MultiAccountId,
         max_weight: Optional[Union[dict, int]] = None,
-        era: dict = None,
-        nonce: int = None,
+        era: Optional[dict] = None,
+        nonce: Optional[int] = None,
         tip: int = 0,
-        tip_asset_id: int = None,
-        signature: Union[bytes, str] = None,
+        tip_asset_id: Optional[int] = None,
+        signature: Optional[Union[bytes, str]] = None,
     ) -> GenericExtrinsic:
         """
         Create a Multisig extrinsic that will be signed by one of the signatories. Checks on-chain if the threshold
@@ -3333,6 +3339,9 @@ def get_block_number(self, block_hash: Optional[str] = None) -> int:
         elif "result" in response:
             if response["result"]:
                 return int(response["result"]["number"], 16)
+        raise SubstrateRequestException(
+            f"Unable to determine block number for {block_hash}"
+        )
 
     def close(self):
         """

async_substrate_interface/types.py

@@ -372,7 +372,7 @@ def __init__(self, payloads):
         self.responses = defaultdict(lambda: {"complete": False, "results": []})
         self.payloads_count = len(payloads)
 
-    def add_request(self, item_id: int, request_id: Any):
+    def add_request(self, item_id: Union[int, str], request_id: Any):
         """
         Adds an outgoing request to the responses map for later retrieval
         """

async_substrate_interface/utils/cache.py

@@ -127,7 +127,7 @@ def inner(self, *args, **kwargs):
     return decorator
 
 
-def async_sql_lru_cache(maxsize=None):
+def async_sql_lru_cache(maxsize: Optional[int] = None):
     def decorator(func):
         @cached_fetcher(max_size=maxsize)
         async def inner(self, *args, **kwargs):
@@ -283,7 +283,7 @@ def __get__(self, instance, owner):
         return self._instances[instance]
 
 
-def cached_fetcher(max_size: int, cache_key_index: int = 0):
+def cached_fetcher(max_size: Optional[int] = None, cache_key_index: int = 0):
     """Wrapper for CachedFetcher. See example in CachedFetcher docstring."""
 
     def wrapper(method):

async_substrate_interface/utils/decoding.py

@@ -160,7 +160,7 @@ def concat_hash_len(key_hasher: str) -> int:
 
 
 def legacy_scale_decode(
-    type_string: str, scale_bytes: Union[str, ScaleBytes], runtime: "Runtime"
+    type_string: str, scale_bytes: Union[str, bytes, ScaleBytes], runtime: "Runtime"
 ):
     if isinstance(scale_bytes, (str, bytes)):
         scale_bytes = ScaleBytes(scale_bytes)

async_substrate_interface/utils/storage.py

@@ -48,9 +48,9 @@ def create_from_data(
         data: bytes,
         runtime_config: RuntimeConfigurationObject,
         metadata: GenericMetadataVersioned,
-        value_scale_type: str = None,
-        pallet: str = None,
-        storage_function: str = None,
+        value_scale_type: Optional[str] = None,
+        pallet: Optional[str] = None,
+        storage_function: Optional[str] = None,
     ) -> "StorageKey":
         """
         Create a StorageKey instance providing raw storage key bytes