Return the subscription id and result for subscription messages

ethereum · Sep 14, 2023 · af37d88 · af37d88
1 parent 7abf97d
commit af37d88
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/newsfragments/3096.breaking.rst b/newsfragments/3096.breaking.rst
@@ -1 +1 @@
-Breaking change to the API for interacting with a persistent websocket connection via ``AsyncWeb3`` and ``WebsocketProviderV2``. This change internalizes the ``provider.ws`` property and opts for a ``w3.ws`` API achieved via a new ``WebsocketConnection`` class.
+Breaking change to the API for interacting with a persistent websocket connection via ``AsyncWeb3`` and ``WebsocketProviderV2``. This change internalizes the ``provider.ws`` property and opts for a ``w3.ws`` API achieved via a new ``WebsocketConnection`` class. With these changes, ``eth_subscription`` messages now return the subscription id as the ``subscription`` param and the formatted message as the ``result`` param.
diff --git a/web3/manager.py b/web3/manager.py
@@ -233,10 +233,15 @@ def formatted_response(
             return response["result"]
         elif (
             # eth_subscribe case
-            response.get("params") is not None
+            response.get("method") == "eth_subscription"
+            and response.get("params") is not None
+            and response["params"].get("subscription") is not None
             and response["params"].get("result") is not None
         ):
-            return response["params"]["result"]
+            return {
+                "subscription": response["params"]["subscription"],
+                "result": response["params"]["result"],
+            }
         else:
             raise BadResponseFormat(
                 "The response was in an unexpected format and unable to be parsed. "
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Breaking change to the API for interacting with a persistent websocket connection via ``AsyncWeb3`` and ``WebsocketProviderV2``. This change internalizes the ``provider.ws`` property and opts for a ``w3.ws`` API achieved via a new ``WebsocketConnection`` class.
		Breaking change to the API for interacting with a persistent websocket connection via ``AsyncWeb3`` and ``WebsocketProviderV2``. This change internalizes the ``provider.ws`` property and opts for a ``w3.ws`` API achieved via a new ``WebsocketConnection`` class. With these changes, ``eth_subscription`` messages now return the subscription id as the ``subscription`` param and the formatted message as the ``result`` param.