Global provider flag for CCIP Read renamed based discussion in pr #2503

Author: fselmo

docs/contracts.rst

@@ -745,7 +745,7 @@ and forwarded to the contract function when applicable.
 
 `EIP-3668 <https://eips.ethereum.org/EIPS/eip-3668>`_ introduced support for the ``OffchainLookup`` revert /
 CCIP Read support. CCIP Read is set to ``True`` for calls by default, as recommended in EIP-3668. This is done via a
-global ``ccip_read_calls_enabled`` flag on the provider. If raising the ``OffchainLookup`` revert is preferred for a
+global ``global_ccip_read_enabled`` flag on the provider. If raising the ``OffchainLookup`` revert is preferred for a
 specific call, the ``ccip_read_enabled`` flag on the call may be set to ``False``.
 
     .. code-block:: python
@@ -758,14 +758,14 @@ Disabling CCIP Read support can be useful if a transaction needs to be sent to t
 "preflighting" with an ``eth_call``, handling the ``OffchainLookup``, and sending the data via a transaction may be
 necessary. See :ref:`ccip-read-example` in the examples section for how to preflight a transaction with a contract call.
 
-Similarly, if CCIP Read is globally set to ``False`` via the ``ccip_read_calls_enabled`` flag on the provider, it may be
+Similarly, if CCIP Read is globally set to ``False`` via the ``global_ccip_read_enabled`` flag on the provider, it may be
 enabled on a per-call basis - overriding the global flag. This ensures only explicitly enabled calls will handle the
 ``OffchainLookup`` revert appropriately.
 
     .. code-block:: python
 
         >>> # global flag set to `False`
-        >>> w3.provider.ccip_read_calls_enabled = False
+        >>> w3.provider.global_ccip_read_enabled = False
 
         >>> # does not raise the revert since explicitly enabled on the call:
         >>> response = myContract.functions.revertsWithOffchainLookup(myData).call(ccip_read_enabled=True)

docs/examples.rst

@@ -630,7 +630,7 @@ CCIP Read support for offchain lookup
 -------------------------------------
 
 Contract calls support CCIP Read by default, via a ``ccip_read_enabled`` flag on the call and, more globally, a
-``ccip_read_calls_enabled`` flag on the provider. The following should work by default without raising an
+``global_ccip_read_enabled`` flag on the provider. The following should work by default without raising an
 ``OffchainLookup`` and instead handling it appropriately as per the specification outlined in
 `EIP-3668 <https://eips.ethereum.org/EIPS/eip-3668>`_.
 

docs/web3.eth.rst

@@ -1094,7 +1094,7 @@ The following methods are available on the ``web3.eth`` namespace.
     Read support. In order to properly handle a call to a contract function that reverts with an ``OffchainLookup``
     error for offchain data retrieval, the ``ccip_read_enabled`` flag has been added to the ``eth_call`` method.
     ``ccip_read_enabled`` is optional, yielding the default value for CCIP Read on calls to a global
-    ``ccip_read_calls_enabled`` flag on the provider which is set to ``True`` by default. This means CCIP Read is
+    ``global_ccip_read_enabled`` flag on the provider which is set to ``True`` by default. This means CCIP Read is
     enabled by default for calls, as is recommended in EIP-3668. Therefore, calls to contract functions that revert with
     an ``OffchainLookup`` will be handled appropriately by default.
 

newsfragments/2499.feature.rst

@@ -1 +1 @@
-Add a global flag on the provider for enabling / disabling CCIP Read for calls: ``ccip_read_calls_enabled`` (defaults to ``True``).
+Add a global flag on the provider for enabling / disabling CCIP Read for calls: ``global_ccip_read_enabled`` (defaults to ``True``).

tests/core/contracts/test_offchain_lookup.py

@@ -84,7 +84,7 @@ def test_eth_call_offchain_lookup_raises_when_ccip_read_is_disabled(w3, offchain
         )
 
     # test global flag on the provider
-    w3.provider.ccip_read_calls_enabled = False
+    w3.provider.global_ccip_read_enabled = False
 
     with pytest.raises(OffchainLookup):
         offchain_lookup_contract.caller.testOffchainLookup(OFFCHAIN_LOOKUP_TEST_DATA)
@@ -94,7 +94,7 @@ def test_eth_call_offchain_lookup_raises_when_ccip_read_is_disabled(w3, offchain
             OFFCHAIN_LOOKUP_TEST_DATA
         )
 
-    w3.provider.ccip_read_calls_enabled = True  # cleanup
+    w3.provider.global_ccip_read_enabled = True  # cleanup
 
 
 def test_offchain_lookup_call_flag_overrides_provider_flag(
@@ -107,14 +107,14 @@ def test_offchain_lookup_call_flag_overrides_provider_flag(
         mocked_json_data=WEB3PY_AS_HEXBYTES,
     )
 
-    w3.provider.ccip_read_calls_enabled = False
+    w3.provider.global_ccip_read_enabled = False
 
     response = offchain_lookup_contract.functions.testOffchainLookup(
         OFFCHAIN_LOOKUP_TEST_DATA
     ).call(ccip_read_enabled=True)
     assert decode_abi(['string'], response)[0] == 'web3py'
 
-    w3.provider.ccip_read_calls_enabled = True
+    w3.provider.global_ccip_read_enabled = True
 
 
 def test_offchain_lookup_raises_for_improperly_formatted_rest_request_response(

tests/core/web3-module/test_providers.py

@@ -26,5 +26,5 @@ def test_auto_provider_none():
 
 
 def test_provider_default_value_for_ccip_read_redirect(w3):
-    assert w3.provider.ccip_read_calls_enabled
+    assert w3.provider.global_ccip_read_enabled
     assert w3.provider.ccip_read_max_redirects == 4

web3/_utils/module_testing/eth_module.py

@@ -802,14 +802,14 @@ async def test_eth_call_offchain_lookup_raises_when_ccip_read_is_disabled(
             ).call(ccip_read_enabled=False)
 
         # test global flag on the provider
-        async_w3.provider.ccip_read_calls_enabled = False
+        async_w3.provider.global_ccip_read_enabled = False
 
         with pytest.raises(OffchainLookup):
             await async_offchain_lookup_contract.functions.testOffchainLookup(  # noqa: E501 type: ignore
                 OFFCHAIN_LOOKUP_TEST_DATA
             ).call()
 
-        async_w3.provider.ccip_read_calls_enabled = True  # cleanup
+        async_w3.provider.global_ccip_read_enabled = True  # cleanup
 
     @pytest.mark.asyncio
     async def test_eth_call_offchain_lookup_call_flag_overrides_provider_flag(
@@ -829,15 +829,15 @@ async def test_eth_call_offchain_lookup_call_flag_overrides_provider_flag(
             mocked_json_data=WEB3PY_AS_HEXBYTES,
         )
 
-        async_w3.provider.ccip_read_calls_enabled = False
+        async_w3.provider.global_ccip_read_enabled = False
 
         response = await async_offchain_lookup_contract.functions.testOffchainLookup(
             # noqa: E501 type: ignore
             OFFCHAIN_LOOKUP_TEST_DATA
         ).call(ccip_read_enabled=True)
         assert async_w3.codec.decode_abi(['string'], response)[0] == 'web3py'
 
-        async_w3.provider.ccip_read_calls_enabled = True  # cleanup
+        async_w3.provider.global_ccip_read_enabled = True  # cleanup
 
     @pytest.mark.asyncio
     @pytest.mark.parametrize("max_redirects", range(-1, 4))
@@ -2552,12 +2552,12 @@ def test_eth_call_offchain_lookup_raises_when_ccip_read_is_disabled(
             )
 
         # test global flag on the provider
-        w3.provider.ccip_read_calls_enabled = False
+        w3.provider.global_ccip_read_enabled = False
 
         with pytest.raises(OffchainLookup):
             offchain_lookup_contract.functions.testOffchainLookup(OFFCHAIN_LOOKUP_TEST_DATA).call()
 
-        w3.provider.ccip_read_calls_enabled = True  # cleanup
+        w3.provider.global_ccip_read_enabled = True  # cleanup
 
     def test_eth_call_offchain_lookup_call_flag_overrides_provider_flag(
         self,
@@ -2573,14 +2573,14 @@ def test_eth_call_offchain_lookup_call_flag_overrides_provider_flag(
             mocked_json_data=WEB3PY_AS_HEXBYTES,
         )
 
-        w3.provider.ccip_read_calls_enabled = False
+        w3.provider.global_ccip_read_enabled = False
 
         response = offchain_lookup_contract.functions.testOffchainLookup(
             OFFCHAIN_LOOKUP_TEST_DATA
         ).call(ccip_read_enabled=True)
         assert w3.codec.decode_abi(['string'], response)[0] == 'web3py'
 
-        w3.provider.ccip_read_calls_enabled = True  # cleanup
+        w3.provider.global_ccip_read_enabled = True  # cleanup
 
     @pytest.mark.parametrize("max_redirects", range(-1, 4))
     def test_eth_call_offchain_lookup_raises_if_max_redirects_is_less_than_4(

web3/eth.py

@@ -415,7 +415,7 @@ async def call(
         state_override: Optional[CallOverride] = None,
         ccip_read_enabled: Optional[bool] = None,
     ) -> Union[bytes, bytearray]:
-        ccip_read_enabled_on_provider = self.w3.provider.ccip_read_calls_enabled
+        ccip_read_enabled_on_provider = self.w3.provider.global_ccip_read_enabled
         if (
             # default conditions:
             ccip_read_enabled_on_provider and ccip_read_enabled is not False
@@ -828,7 +828,7 @@ def call(
         state_override: Optional[CallOverride] = None,
         ccip_read_enabled: Optional[bool] = None,
     ) -> Union[bytes, bytearray]:
-        ccip_read_enabled_on_provider = self.w3.provider.ccip_read_calls_enabled
+        ccip_read_enabled_on_provider = self.w3.provider.global_ccip_read_enabled
         if (
             # default conditions:
             ccip_read_enabled_on_provider and ccip_read_enabled is not False

web3/providers/async_base.py

@@ -36,7 +36,7 @@ class AsyncBaseProvider:
     # a tuple of (all_middlewares, request_func)
     _request_func_cache: Tuple[Tuple[Middleware, ...], Callable[..., RPCResponse]] = (None, None)
 
-    ccip_read_calls_enabled: bool = True
+    global_ccip_read_enabled: bool = True
     ccip_read_max_redirects: int = 4
 
     def __init__(self) -> None:

web3/providers/base.py

@@ -35,7 +35,7 @@ class BaseProvider:
     # a tuple of (all_middlewares, request_func)
     _request_func_cache: Tuple[Tuple[Middleware, ...], Callable[..., RPCResponse]] = (None, None)
 
-    ccip_read_calls_enabled: bool = True
+    global_ccip_read_enabled: bool = True
     ccip_read_max_redirects: int = 4
 
     @property