Merge remote-tracking branch 'origin/staging' into feat/thewhaleking/warn-users-about-too-old-blocks

Author: thewhaleking

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 1.0.2 /2025-02-19
+
+## What's Changed
+* Closes the connection on the object being garbage-collected by @thewhaleking in https://github.com/opentensor/async-substrate-interface/pull/51
+* Generate UIDs for websockets by @thewhaleking in https://github.com/opentensor/async-substrate-interface/pull/50
+* Dynamically pulls the info for Vec<AccountId> from the metadata by @thewhaleking in https://github.com/opentensor/async-substrate-interface/pull/47
+* Fix readme by @igorsyl in https://github.com/opentensor/async-substrate-interface/pull/46
+* Handle options with bt-decode by @thewhaleking in https://github.com/opentensor/async-substrate-interface/pull/52
+* Backmerge main to staging 101 by @ibraheem-opentensor in https://github.com/opentensor/async-substrate-interface/pull/53
+* Handles None change_data by @ibraheem-opentensor in https://github.com/opentensor/async-substrate-interface/pull/54
+
+## New Contributors
+* @igorsyl made their first contribution in https://github.com/opentensor/async-substrate-interface/pull/46
+
+**Full Changelog**: https://github.com/opentensor/async-substrate-interface/compare/v1.0.1...v1.0.2
+
+## 1.0.1 /2025-02-17
+
+## What's Changed
+* Updates type for vec acc id by @ibraheem-opentensor in https://github.com/opentensor/async-substrate-interface/pull/45
+* Backmerge main staging 101 by @ibraheem-opentensor in https://github.com/opentensor/async-substrate-interface/pull/48
+
+**Full Changelog**: https://github.com/opentensor/async-substrate-interface/compare/v1.0.0...v1.0.1
+
 ## 1.0.0 /2025-02-13
 
 ## What's new

async_substrate_interface/async_substrate.py

@@ -48,7 +48,7 @@
     SubstrateMixin,
     Preprocessed,
 )
-from async_substrate_interface.utils import hex_to_bytes, json, generate_unique_id
+from async_substrate_interface.utils import hex_to_bytes, json, get_next_id
 from async_substrate_interface.utils.decoding import (
     _determine_if_old_runtime_call,
     _bt_decode_to_dict_or_list,
@@ -620,7 +620,7 @@ async def send(self, payload: dict) -> int:
             id: the internal ID of the request (incremented int)
         """
         # async with self._lock:
-        original_id = generate_unique_id(json.dumps(payload))
+        original_id = get_next_id()
         # self._open_subscriptions += 1
         try:
             await self.ws.send(json.dumps({**payload, **{"id": original_id}}))
@@ -904,15 +904,14 @@ async def decode_scale(
         Returns:
             Decoded object
         """
-        if scale_bytes == b"\x00":
-            obj = None
+        if scale_bytes == b"":
+            return None
+        if type_string == "scale_info::0":  # Is an AccountId
+            # Decode AccountId bytes to SS58 address
+            return ss58_encode(scale_bytes, SS58_FORMAT)
         else:
-            if type_string == "scale_info::0":  # Is an AccountId
-                # Decode AccountId bytes to SS58 address
-                return ss58_encode(scale_bytes, SS58_FORMAT)
-            else:
-                await self._wait_for_registry(_attempt, _retries)
-                obj = decode_by_type_string(type_string, self.registry, scale_bytes)
+            await self._wait_for_registry(_attempt, _retries)
+            obj = decode_by_type_string(type_string, self.registry, scale_bytes)
         if return_scale_obj:
             return ScaleObj(obj)
         else:
@@ -2245,7 +2244,7 @@ async def query_multi(
                 # Decode result for specified storage_key
                 storage_key = storage_key_map[change_storage_key]
                 if change_data is None:
-                    change_data = b"\x00"
+                    change_data = b""
                 else:
                     change_data = bytes.fromhex(change_data[2:])
                 result.append(

async_substrate_interface/sync_substrate.py

@@ -30,7 +30,7 @@
     Preprocessed,
     ScaleObj,
 )
-from async_substrate_interface.utils import hex_to_bytes, json, generate_unique_id
+from async_substrate_interface.utils import hex_to_bytes, json, get_next_id
 from async_substrate_interface.utils.decoding import (
     _determine_if_old_runtime_call,
     _bt_decode_to_dict_or_list,
@@ -652,15 +652,11 @@ def decode_scale(
         Returns:
             Decoded object
         """
-
-        if scale_bytes == b"\x00":
-            obj = None
+        if type_string == "scale_info::0":  # Is an AccountId
+            # Decode AccountId bytes to SS58 address
+            return ss58_encode(scale_bytes, SS58_FORMAT)
         else:
-            if type_string == "scale_info::0":  # Is an AccountId
-                # Decode AccountId bytes to SS58 address
-                return ss58_encode(scale_bytes, SS58_FORMAT)
-            else:
-                obj = decode_by_type_string(type_string, self.registry, scale_bytes)
+            obj = decode_by_type_string(type_string, self.registry, scale_bytes)
         if return_scale_obj:
             return ScaleObj(obj)
         else:
@@ -1688,8 +1684,7 @@ def _make_rpc_request(
 
         ws = self.connect(init=False if attempt == 1 else True)
         for payload in payloads:
-            payload_str = json.dumps(payload["payload"])
-            item_id = generate_unique_id(payload_str)
+            item_id = get_next_id()
             ws.send(json.dumps({**payload["payload"], **{"id": item_id}}))
             request_manager.add_request(item_id, payload["id"])
 

async_substrate_interface/utils/__init__.py

@@ -1,10 +1,18 @@
 import importlib
-import hashlib
+from itertools import cycle
+import random
+import string
 
+id_cycle = cycle(range(1, 999))
 
-def generate_unique_id(item: str, length=10):
-    hashed_value = hashlib.sha256(item.encode()).hexdigest()
-    return hashed_value[:length]
+
+def get_next_id() -> str:
+    """
+    Generates a pseudo-random ID by returning the next int of a range from 1-998 prepended with
+    two random ascii characters.
+    """
+    random_letters = "".join(random.choices(string.ascii_letters, k=2))
+    return f"{random_letters}{next(id_cycle)}"
 
 
 def hex_to_bytes(hex_str: str) -> bytes:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "async-substrate-interface"
-version = "1.0.0"
+version = "1.0.2"
 description = "Asyncio library for interacting with substrate. Mostly API-compatible with py-substrate-interface"
 readme = "README.md"
 license = { file = "LICENSE" }

tests/unit_tests/test_utils.py

@@ -0,0 +1,10 @@
+from async_substrate_interface.utils import get_next_id
+from string import ascii_letters
+
+
+def test_get_next_id():
+    next_id = get_next_id()
+    assert next_id[0] in ascii_letters
+    assert next_id[1] in ascii_letters
+    assert 0 < int(next_id[2:]) < 999
+    assert 3 <= len(next_id) <= 5