Catch newly raised geth errors when tx indexing in progress:

- Geth ``1.13.11`` started to return an error when transaction indexing
is in progress and a ``eth_getTransactionReceipt`` call is made.
Handle this in the ``wait_for_transaction_receipt`` method by catching
the error in order to continue waiting.

Author: fselmo

newsfragments/3217.bugfix.rst

@@ -0,0 +1 @@
+Handle new geth errors related to waiting for a transaction receipt while transactions are still being indexed.

tests/core/contracts/test_contract_panic_errors.py

@@ -4,12 +4,12 @@
 from tests.core.contracts.utils import (
     deploy,
 )
-from web3._utils.contract_error_handling import (
-    PANIC_ERROR_CODES,
-)
 from web3._utils.contract_sources.contract_data.panic_errors_contract import (
     PANIC_ERRORS_CONTRACT_DATA,
 )
+from web3._utils.error_formatters_utils import (
+    PANIC_ERROR_CODES,
+)
 from web3.exceptions import (
     ContractPanicError,
 )

tests/core/eth-module/test_transactions.py

@@ -24,6 +24,9 @@
     Web3ValidationError,
 )
 from web3.middleware import (
+    async_construct_error_generator_middleware,
+    async_construct_result_generator_middleware,
+    construct_error_generator_middleware,
     construct_result_generator_middleware,
 )
 from web3.middleware.simulate_unmined_transaction import (
@@ -33,6 +36,16 @@
 RECEIPT_TIMEOUT = 0.2
 
 
+def _swap_error_middleware_for_result_middleware_and_return_error(
+    w3, result_middleware
+):
+    # On the first call, this will be in ``layer=0`` and we will remove this
+    # middleware and add the result middleware to layer 0 for the next call.
+    w3.middleware_onion.remove("error_middleware")
+    w3.middleware_onion.inject(result_middleware, "result_middleware", layer=0)
+    return {"code": -32000, "message": "transaction indexing in progress"}
+
+
 @pytest.mark.parametrize(
     "transaction",
     (
@@ -193,6 +206,28 @@ def test_unmined_transaction_wait_for_receipt(w3):
     assert txn_receipt["blockHash"] is not None
 
 
+def test_eth_wait_for_transaction_receipt_transaction_indexing_in_progress(w3):
+    result_middleware = construct_result_generator_middleware(
+        {RPC.eth_getTransactionReceipt: lambda *_: {"status": 1}}
+    )
+    error_middleware = construct_error_generator_middleware(
+        {
+            RPC.eth_getTransactionReceipt: lambda *_: (
+                _swap_error_middleware_for_result_middleware_and_return_error(
+                    w3, result_middleware
+                )
+            )
+        }
+    )
+    w3.middleware_onion.inject(error_middleware, "error_middleware", layer=0)
+
+    receipt = w3.eth.wait_for_transaction_receipt(f"0x{'00' * 32}")
+    assert receipt == {"status": 1}
+
+    assert "error_middleware" not in w3.middleware_onion.middlewares
+    w3.middleware_onion.remove("result_middleware")
+
+
 def test_get_transaction_formatters(w3):
     non_checksummed_addr = "0xB2930B35844A230F00E51431ACAE96FE543A0347"  # all uppercase
     unformatted_transaction = {
@@ -300,3 +335,30 @@ def test_get_transaction_formatters(w3):
 
     assert received_tx == expected
     w3.middleware_onion.remove("result_middleware")
+
+
+# --- async --- #
+
+
+@pytest.mark.asyncio
+async def test_async_wait_for_transaction_receipt_transaction_indexing_in_progress(
+    async_w3,
+):
+    result_middleware = await async_construct_result_generator_middleware(
+        {RPC.eth_getTransactionReceipt: lambda *_: {"status": 1}}
+    )
+    error_middleware = await async_construct_error_generator_middleware(
+        {
+            RPC.eth_getTransactionReceipt: lambda *_: (
+                _swap_error_middleware_for_result_middleware_and_return_error(
+                    async_w3, result_middleware
+                )
+            )
+        }
+    )
+    async_w3.middleware_onion.inject(error_middleware, "error_middleware", layer=0)
+
+    receipt = await async_w3.eth.wait_for_transaction_receipt(f"0x{'00' * 32}")
+    assert receipt == {"status": 1}
+
+    async_w3.middleware_onion.remove("result_middleware")

web3/_utils/contract_error_handling.py renamed to web3/_utils/error_formatters_utils.py

@@ -12,6 +12,7 @@
     ContractLogicError,
     ContractPanicError,
     OffchainLookup,
+    TransactionIndexingInProgress,
 )
 from web3.types import (
     RPCResponse,
@@ -164,3 +165,21 @@ def raise_contract_logic_error_on_revert(response: RPCResponse) -> RPCResponse:
             raise ContractLogicError("execution reverted", data=data)
 
     return response
+
+
+def raise_transaction_indexing_error_if_indexing(response: RPCResponse) -> RPCResponse:
+    """
+    Raise an error if ``eth_getTransactionReceipt`` returns an error indicating that
+    transactions are still being indexed.
+    """
+
+    error = response.get("error")
+    if not isinstance(error, str) and error is not None:
+        message = error.get("message")
+        if message is not None:
+            if all(
+                idx_key_phrases in message for idx_key_phrases in ("index", "progress")
+            ):
+                raise TransactionIndexingInProgress(message)
+
+    return response

web3/_utils/method_formatters.py

@@ -52,13 +52,14 @@
 from web3._utils.abi import (
     is_length,
 )
-from web3._utils.contract_error_handling import (
-    raise_contract_logic_error_on_revert,
-)
 from web3._utils.encoding import (
     hexstr_if_str,
     to_hex,
 )
+from web3._utils.error_formatters_utils import (
+    raise_contract_logic_error_on_revert,
+    raise_transaction_indexing_error_if_indexing,
+)
 from web3._utils.filters import (
     AsyncBlockFilter,
     AsyncLogFilter,
@@ -791,6 +792,7 @@ def subscription_formatter(value: Any) -> Union[HexBytes, HexStr, Dict[str, Any]
 ERROR_FORMATTERS: Dict[RPCEndpoint, Callable[..., Any]] = {
     RPC.eth_estimateGas: raise_contract_logic_error_on_revert,
     RPC.eth_call: raise_contract_logic_error_on_revert,
+    RPC.eth_getTransactionReceipt: raise_transaction_indexing_error_if_indexing,
 }
 
 

web3/_utils/module_testing/eth_module.py

@@ -40,15 +40,15 @@
     HexBytes,
 )
 
-from web3._utils.contract_error_handling import (
-    PANIC_ERROR_CODES,
-)
 from web3._utils.empty import (
     empty,
 )
 from web3._utils.ens import (
     ens_addresses,
 )
+from web3._utils.error_formatters_utils import (
+    PANIC_ERROR_CODES,
+)
 from web3._utils.method_formatters import (
     to_hex_if_integer,
 )

web3/eth/async_eth.py

@@ -60,6 +60,7 @@
     OffchainLookup,
     TimeExhausted,
     TooManyRequests,
+    TransactionIndexingInProgress,
     TransactionNotFound,
 )
 from web3.method import (
@@ -517,7 +518,7 @@ async def _wait_for_tx_receipt_with_timeout(
             while True:
                 try:
                     tx_receipt = await self._transaction_receipt(_tx_hash)
-                except TransactionNotFound:
+                except (TransactionNotFound, TransactionIndexingInProgress):
                     tx_receipt = None
                 if tx_receipt is not None:
                     break

web3/eth/eth.py

@@ -60,6 +60,7 @@
     OffchainLookup,
     TimeExhausted,
     TooManyRequests,
+    TransactionIndexingInProgress,
     TransactionNotFound,
 )
 from web3.method import (
@@ -485,7 +486,7 @@ def wait_for_transaction_receipt(
                 while True:
                     try:
                         tx_receipt = self._transaction_receipt(transaction_hash)
-                    except TransactionNotFound:
+                    except (TransactionNotFound, TransactionIndexingInProgress):
                         tx_receipt = None
                     if tx_receipt is not None:
                         break

web3/exceptions.py

@@ -223,6 +223,15 @@ class TransactionNotFound(Web3Exception):
     pass
 
 
+class TransactionIndexingInProgress(Web3Exception):
+    """
+    Raised when a transaction receipt is not yet available due to transaction indexing
+    still being in progress.
+    """
+
+    pass
+
+
 class BlockNotFound(Web3Exception):
     """
     Raised when the block id used to lookup a block in a jsonrpc call cannot be found.

web3/providers/eth_tester/defaults.py

@@ -45,7 +45,7 @@
 from web3 import (
     Web3,
 )
-from web3._utils.contract_error_handling import (
+from web3._utils.error_formatters_utils import (
     OFFCHAIN_LOOKUP_FIELDS,
     PANIC_ERROR_CODES,
 )