Merge pull request #2909 from opentensor/feat/thewhaleking/retry-archive-node-support

Retry archive node support

Author: thewhaleking

bittensor/core/async_subtensor.py

@@ -120,6 +120,8 @@ def __init__(
         fallback_endpoints: Optional[list[str]] = None,
         retry_forever: bool = False,
         _mock: bool = False,
+        archive_endpoints: Optional[list[str]] = None,
+        websocket_shutdown_timer: float = 5.0,
     ):
         """
         Initializes an instance of the AsyncSubtensor class.
@@ -132,6 +134,9 @@ def __init__(
                 Defaults to `None`.
             retry_forever: Whether to retry forever on connection errors. Defaults to `False`.
             _mock: Whether this is a mock instance. Mainly just for use in testing.
+            archive_endpoints: Similar to fallback_endpoints, but specifically only archive nodes. Will be used in cases
+                where you are requesting a block that is too old for your current (presumably lite) node. Defaults to
+                `None`
 
         Raises:
             Any exceptions raised during the setup, configuration, or connection process.
@@ -154,6 +159,8 @@ def __init__(
             fallback_endpoints=fallback_endpoints,
             retry_forever=retry_forever,
             _mock=_mock,
+            archive_endpoints=archive_endpoints,
+            ws_shutdown_timer=websocket_shutdown_timer,
         )
         if self.log_verbose:
             logging.info(
@@ -292,6 +299,8 @@ def _get_substrate(
         fallback_endpoints: Optional[list[str]] = None,
         retry_forever: bool = False,
         _mock: bool = False,
+        archive_endpoints: Optional[list[str]] = None,
+        ws_shutdown_timer: float = 5.0,
     ) -> Union[AsyncSubstrateInterface, RetryAsyncSubstrate]:
         """Creates the Substrate instance based on provided arguments.
 
@@ -300,11 +309,16 @@ def _get_substrate(
                 Defaults to `None`.
             retry_forever: Whether to retry forever on connection errors. Defaults to `False`.
             _mock: Whether this is a mock instance. Mainly just for use in testing.
+            archive_endpoints: Similar to fallback_endpoints, but specifically only archive nodes. Will be used in cases
+                where you are requesting a block that is too old for your current (presumably lite) node. Defaults to
+                `None`
+            ws_shutdown_timer: Amount of time, in seconds, to wait after the last response from the chain to close the
+                connection.
 
         Returns:
             the instance of the SubstrateInterface or RetrySyncSubstrate class.
         """
-        if fallback_endpoints or retry_forever:
+        if fallback_endpoints or retry_forever or archive_endpoints:
             return RetryAsyncSubstrate(
                 url=self.chain_endpoint,
                 fallback_chains=fallback_endpoints,
@@ -314,6 +328,8 @@ def _get_substrate(
                 use_remote_preset=True,
                 chain_name="Bittensor",
                 _mock=_mock,
+                archive_nodes=archive_endpoints,
+                ws_shutdown_timer=ws_shutdown_timer,
             )
         return AsyncSubstrateInterface(
             url=self.chain_endpoint,
@@ -322,6 +338,7 @@ def _get_substrate(
             use_remote_preset=True,
             chain_name="Bittensor",
             _mock=_mock,
+            ws_shutdown_timer=ws_shutdown_timer,
         )
 
     # Subtensor queries ===========================================================================================

bittensor/core/subtensor.py

@@ -117,11 +117,12 @@ class Subtensor(SubtensorMixin):
     def __init__(
         self,
         network: Optional[str] = None,
-        config: Optional["Config"] = None,
+        config: Optional[Config] = None,
         log_verbose: bool = False,
         fallback_endpoints: Optional[list[str]] = None,
         retry_forever: bool = False,
         _mock: bool = False,
+        archive_endpoints: Optional[list[str]] = None,
     ):
         """
         Initializes an instance of the Subtensor class.
@@ -134,6 +135,9 @@ def __init__(
                 Defaults to `None`.
             retry_forever: Whether to retry forever on connection errors. Defaults to `False`.
             _mock: Whether this is a mock instance. Mainly just for use in testing.
+            archive_endpoints: Similar to fallback_endpoints, but specifically only archive nodes. Will be used in cases
+                where you are requesting a block that is too old for your current (presumably lite) node. Defaults to
+                `None`
 
         Raises:
             Any exceptions raised during the setup, configuration, or connection process.
@@ -154,6 +158,7 @@ def __init__(
             fallback_endpoints=fallback_endpoints,
             retry_forever=retry_forever,
             _mock=_mock,
+            archive_endpoints=archive_endpoints,
         )
         if self.log_verbose:
             logging.info(
@@ -175,19 +180,23 @@ def _get_substrate(
         fallback_endpoints: Optional[list[str]] = None,
         retry_forever: bool = False,
         _mock: bool = False,
+        archive_endpoints: Optional[list[str]] = None,
     ) -> Union[SubstrateInterface, RetrySyncSubstrate]:
         """Creates the Substrate instance based on provided arguments.
 
         Arguments:
-            fallback_endpoints: List of fallback chains endpoints to use if main network isn't available.
-                Defaults to `None`.
+            fallback_endpoints: List of fallback chains endpoints to use if main network isn't available. Defaults to
+                `None`.
             retry_forever: Whether to retry forever on connection errors. Defaults to `False`.
             _mock: Whether this is a mock instance. Mainly just for use in testing.
+            archive_endpoints: Similar to fallback_endpoints, but specifically only archive nodes. Will be used in cases
+                where you are requesting a block that is too old for your current (presumably lite) node. Defaults to
+                `None`
 
         Returns:
             the instance of the SubstrateInterface or RetrySyncSubstrate class.
         """
-        if fallback_endpoints or retry_forever:
+        if fallback_endpoints or retry_forever or archive_endpoints:
             return RetrySyncSubstrate(
                 url=self.chain_endpoint,
                 ss58_format=SS58_FORMAT,
@@ -197,6 +206,7 @@ def _get_substrate(
                 fallback_chains=fallback_endpoints,
                 retry_forever=retry_forever,
                 _mock=_mock,
+                archive_nodes=archive_endpoints,
             )
         return SubstrateInterface(
             url=self.chain_endpoint,

bittensor/core/subtensor_api/__init__.py

@@ -29,6 +29,10 @@ class SubtensorApi:
         retry_forever: Whether to retry forever on connection errors. Defaults to `False`.
         log_verbose: Enables or disables verbose logging.
         mock: Whether this is a mock instance. Mainly just for use in testing.
+        archive_endpoints: Similar to fallback_endpoints, but specifically only archive nodes. Will be used in cases
+            where you are requesting a block that is too old for your current (presumably lite) node. Defaults to `None`
+        websocket_shutdown_timer: Amount of time, in seconds, to wait after the last response from the chain to close
+            the connection. Only applicable to AsyncSubtensor.
 
     Example:
         # sync version
@@ -75,10 +79,14 @@ def __init__(
         retry_forever: bool = False,
         log_verbose: bool = False,
         mock: bool = False,
+        archive_endpoints: Optional[list[str]] = None,
+        websocket_shutdown_timer: float = 5.0,
     ):
         self.network = network
         self._fallback_endpoints = fallback_endpoints
+        self._archive_endpoints = archive_endpoints
         self._retry_forever = retry_forever
+        self._ws_shutdown_timer = websocket_shutdown_timer
         self._mock = mock
         self.log_verbose = log_verbose
         self.is_async = async_subtensor
@@ -119,6 +127,8 @@ def _get_subtensor(self) -> Union["_Subtensor", "_AsyncSubtensor"]:
                 fallback_endpoints=self._fallback_endpoints,
                 retry_forever=self._retry_forever,
                 _mock=self._mock,
+                archive_endpoints=self._archive_endpoints,
+                websocket_shutdown_timer=self._ws_shutdown_timer,
             )
             self.initialize = _subtensor.initialize
             return _subtensor
@@ -130,6 +140,7 @@ def _get_subtensor(self) -> Union["_Subtensor", "_AsyncSubtensor"]:
                 fallback_endpoints=self._fallback_endpoints,
                 retry_forever=self._retry_forever,
                 _mock=self._mock,
+                archive_endpoints=self._archive_endpoints,
             )
 
     def _determine_chain_endpoint(self) -> str:

pyproject.toml

@@ -36,7 +36,7 @@ dependencies = [
     "uvicorn",
     "bittensor-drand>=0.5.0",
     "bittensor-wallet>=3.0.8",
-    "async-substrate-interface>=1.2.0"
+    "async-substrate-interface>=1.3.1"
 ]
 
 [project.optional-dependencies]

tests/helpers/helpers.py

@@ -1,4 +1,5 @@
 import asyncio
+import itertools
 import json
 import time
 from collections import deque
@@ -204,6 +205,9 @@ def recv(self, *args, **kwargs):
                 response = WEBSOCKET_RESPONSES[self.seed][item["method"]][
                     json.dumps(item["params"])
                 ]
+                if isinstance(response, itertools.cycle):
+                    # Allows us to cycle through different responses for the same method/params combo
+                    response = next(response)
                 response["id"] = _id
             return json.dumps(response)
         except (KeyError, TypeError):