Catch if data is None in revert error

Author: kclowes

newsfragments/3054.bugfix.rst

@@ -0,0 +1 @@
+Handle case where data gets returned as ``None`` in a JSON-RPC error response

tests/core/utilities/test_method_formatters.py

@@ -101,6 +101,42 @@
     }
 )
 
+NONE_DATA_RESPONSE = RPCResponse(
+    {
+        "id": 24,
+        "jsonrpc": "2.0",
+        "error": {
+            "message": "execution reverted",
+            "code": -32000,
+            "data": None,
+        },
+    }
+)
+
+NONE_MESSAGE_RESPONSE = RPCResponse(
+    {
+        "id": 24,
+        "jsonrpc": "2.0",
+        "error": {
+            "message": None,
+            "code": -32000,
+            "data": "execution reverted",  # noqa: E501
+        },
+    }
+)
+
+NO_DATA_NO_MESSAGE_RESPONSE = RPCResponse(
+    {
+        "id": 24,
+        "jsonrpc": "2.0",
+        "error": {
+            "message": None,
+            "code": -32000,
+            "data": None,  # noqa: E501
+        },
+    }
+)
+
 
 @pytest.mark.parametrize(
     "response,expected",
@@ -116,13 +152,28 @@
             SPACENETH_RESPONSE,
             "execution reverted: OwnerId does not exist in registry",
         ),
+        (
+            NONE_DATA_RESPONSE,
+            "execution reverted",
+        ),
+        (
+            NONE_MESSAGE_RESPONSE,
+            "execution reverted",
+        ),
+        (
+            NO_DATA_NO_MESSAGE_RESPONSE,
+            "execution reverted",
+        ),
     ),
     ids=[
         "test-get-revert-reason-with-msg",
         "test-get-revert-reason-without-msg",
         "test-get-geth-revert-reason",
         "test_get-ganache-revert-reason",
         "test_get-spaceneth-revert-reason",
+        "test_none-data-response",
+        "test_none-message-response",
+        "test_no-data-no-message-response",
     ],
 )
 def test_get_revert_reason(response, expected) -> None:

web3/_utils/contract_error_handling.py

@@ -65,12 +65,21 @@ def raise_contract_logic_error_on_revert(response: RPCResponse) -> RPCResponse:
         raise ValueError("Error expected to be a dict")
 
     data = response["error"].get("data", "")
+    message = response["error"].get("message", "")
+
+    message_present = message is not None and message != ""
+
+    if data is None:
+        if message_present:
+            raise ContractLogicError(message)
+        elif not message_present:
+            raise ContractLogicError("execution reverted")
+        else:
+            raise Exception("Unreachable")
 
     # Ganache case:
-    if isinstance(data, dict) and response["error"].get("message"):
-        raise ContractLogicError(
-            f'execution reverted: {response["error"]["message"]}', data=data
-        )
+    if isinstance(data, dict) and message_present:
+        raise ContractLogicError(f"execution reverted: {message}", data=data)
 
     # Parity/OpenEthereum case:
     if data.startswith("Reverted "):
@@ -126,12 +135,10 @@ def raise_contract_logic_error_on_revert(response: RPCResponse) -> RPCResponse:
         raise ContractCustomError(data, data=data)
 
     # Geth case:
-    if "message" in response["error"] and response["error"].get("code", "") == 3:
-        message = response["error"]["message"]
+    if message_present and response["error"].get("code", "") == 3:
         raise ContractLogicError(message, data=data)
-
     # Geth Revert without error message case:
-    if "execution reverted" in response["error"].get("message"):
+    if message_present and "execution reverted" in message:
         raise ContractLogicError("execution reverted", data=data)
 
     return response