Skip to content

Handle subscription failures from substrate #243

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

Merged
merged 2 commits into from
Dec 1, 2025
+53 −1
Merged

Handle subscription failures from substrate #243

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
1c09484
Handle 'usurped' error from substrate
thewhaleking Nov 28, 2025
73b6586
Handle all subscription update failures
thewhaleking Nov 28, 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
28 changes: 27 additions & 1 deletion async_substrate_interface/async_substrate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3987,6 +3987,32 @@ async def result_handler(message: dict, subscription_id) -> tuple[dict, bool]:
message_result = {
k.lower(): v for k, v in message["params"]["result"].items()
}
# check for any subscription indicators of failure
failure_message = None
if "usurped" in message_result:
failure_message = (
f"Subscription {subscription_id} usurped: {message_result}"
)
if "retracted" in message_result:
failure_message = (
f"Subscription {subscription_id} retracted: {message_result}"
)
if "finalitytimeout" in message_result:
failure_message = f"Subscription {subscription_id} finalityTimeout: {message_result}"
if "dropped" in message_result:
failure_message = (
f"Subscription {subscription_id} dropped: {message_result}"
)
if "invalid" in message_result:
failure_message = (
f"Subscription {subscription_id} invalid: {message_result}"
)

if failure_message is not None:
async with self.ws as ws:
await ws.unsubscribe(subscription_id)
logger.error(failure_message)
raise SubstrateRequestException(failure_message)

if "finalized" in message_result and wait_for_finalization:
logger.debug("Extrinsic finalized. Unsubscribing.")
Expand All @@ -3998,7 +4024,7 @@ async def result_handler(message: dict, subscription_id) -> tuple[dict, bool]:
"finalized": True,
}, True
elif (
any(x in message_result for x in ["inblock", "inBlock"])
"inblock" in message_result
and wait_for_inclusion
and not wait_for_finalization
):
Expand Down
26 changes: 26 additions & 0 deletions async_substrate_interface/sync_substrate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3170,6 +3170,32 @@ def result_handler(message: dict, subscription_id) -> tuple[dict, bool]:
k.lower(): v for k, v in message["params"]["result"].items()
}

# check for any subscription indicators of failure
failure_message = None
if "usurped" in message_result:
failure_message = (
f"Subscription {subscription_id} usurped: {message_result}"
)
if "retracted" in message_result:
failure_message = (
f"Subscription {subscription_id} retracted: {message_result}"
)
if "finalitytimeout" in message_result:
failure_message = f"Subscription {subscription_id} finalityTimeout: {message_result}"
if "dropped" in message_result:
failure_message = (
f"Subscription {subscription_id} dropped: {message_result}"
)
if "invalid" in message_result:
failure_message = (
f"Subscription {subscription_id} invalid: {message_result}"
)

if failure_message is not None:
self.rpc_request("author_unwatchExtrinsic", [subscription_id])
logger.error(failure_message)
raise SubstrateRequestException(failure_message)

if "finalized" in message_result and wait_for_finalization:
# Created as a task because we don't actually care about the result
# TODO change this logic
Expand Down
Loading