Skip to content

Websocket shutdown timer support #2919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Websocket shutdown timer support #2919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e0570f
Adds websocket shutdown timer exposure
thewhaleking Jun 13, 2025
3acc5f3
Merge branch 'feat/thewhaleking/retry-archive-node-support' into feat…
thewhaleking Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions bittensor/core/async_subtensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ def __init__(
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.
Expand All @@ -134,6 +135,8 @@ def __init__(
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: Number of seconds to wait after last request before shutting down connection to
the node

Raises:
Any exceptions raised during the setup, configuration, or connection process.
Expand All @@ -157,6 +160,7 @@ def __init__(
retry_forever=retry_forever,
_mock=_mock,
archive_endpoints=archive_endpoints,
ws_shutdown_timer=websocket_shutdown_timer
)
if self.log_verbose:
logging.info(
Expand Down Expand Up @@ -296,6 +300,7 @@ def _get_substrate(
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.

Expand All @@ -307,6 +312,7 @@ def _get_substrate(
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: Number of seconds to wait after last request before shutting down connection to the node

Returns:
the instance of the SubstrateInterface or RetrySyncSubstrate class.
Expand All @@ -322,6 +328,7 @@ def _get_substrate(
chain_name="Bittensor",
_mock=_mock,
archive_nodes=archive_endpoints,
ws_shutdown_timer=ws_shutdown_timer
)
return AsyncSubstrateInterface(
url=self.chain_endpoint,
Expand All @@ -330,6 +337,7 @@ def _get_substrate(
use_remote_preset=True,
chain_name="Bittensor",
_mock=_mock,
ws_shutdown_timer=ws_shutdown_timer
)

# Subtensor queries ===========================================================================================
Expand Down
5 changes: 5 additions & 0 deletions bittensor/core/subtensor_api/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ class SubtensorApi:
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: Number of seconds to wait after last request before shutting down connection to
the node. Only applicable to AsyncSubtensor (and RetryAsyncSubtensor).

Example:
# sync version
Expand Down Expand Up @@ -78,6 +80,7 @@ def __init__(
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
Expand All @@ -87,6 +90,7 @@ def __init__(
self.log_verbose = log_verbose
self.is_async = async_subtensor
self._config = config
self._ws_shutdown_timer = websocket_shutdown_timer

# assigned only for async instance
self.initialize = None
Expand Down Expand Up @@ -124,6 +128,7 @@ def _get_subtensor(self) -> Union["_Subtensor", "_AsyncSubtensor"]:
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
Expand Down
Loading