More explicit use of abi.encode() rather than encode(), etc.

- With commonly used words like ``encode`` and ``decode``, it is better to import the library so a reader knows what exactly is encoding / decoding. Here, it is better to import ``abi`` and use ``abi.encode()`` / ``abi.decode()`` for better context.

Author: fselmo

newsfragments/2668.internal.rst

@@ -0,0 +1 @@
+Clean up remaining uses of deprecated ``eth_abi`` methods.

tests/core/contracts/test_offchain_lookup.py

@@ -1,7 +1,7 @@
 import pytest
 
 from eth_abi import (
-    decode,
+    abi,
 )
 
 from web3._utils.module_testing.module_testing_utils import (
@@ -74,7 +74,7 @@ def test_offchain_lookup_functionality(
     response = offchain_lookup_contract.caller.testOffchainLookup(
         OFFCHAIN_LOOKUP_TEST_DATA
     )
-    assert decode(["string"], response)[0] == "web3py"
+    assert abi.decode(["string"], response)[0] == "web3py"
 
 
 def test_eth_call_offchain_lookup_raises_when_ccip_read_is_disabled(
@@ -123,7 +123,7 @@ def test_offchain_lookup_call_flag_overrides_provider_flag(
     response = offchain_lookup_contract.functions.testOffchainLookup(
         OFFCHAIN_LOOKUP_TEST_DATA
     ).call(ccip_read_enabled=True)
-    assert decode(["string"], response)[0] == "web3py"
+    assert abi.decode(["string"], response)[0] == "web3py"
 
     w3.provider.global_ccip_read_enabled = True
 
@@ -176,7 +176,7 @@ def test_eth_call_offchain_lookup_tries_next_url_for_non_4xx_error_status_and_te
     response = offchain_lookup_contract.caller.testOffchainLookup(
         OFFCHAIN_LOOKUP_TEST_DATA
     )
-    assert decode(["string"], response)[0] == "web3py"
+    assert abi.decode(["string"], response)[0] == "web3py"
 
 
 @pytest.mark.parametrize("status_code_4xx_error", [400, 410, 450, 499])

web3/_utils/async_transactions.py

@@ -8,7 +8,7 @@
 )
 
 from eth_abi import (
-    encode,
+    abi,
 )
 from eth_typing import (
     URI,
@@ -199,7 +199,7 @@ async def async_handle_offchain_lookup(
                 # 4-byte callback function selector
                 to_bytes_if_hex(offchain_lookup_payload["callbackFunction"]),
                 # encode the `data` from the result and the `extraData` as bytes
-                encode(
+                abi.encode(
                     ["bytes", "bytes"],
                     [
                         to_bytes_if_hex(result["data"]),

web3/_utils/events.py

@@ -127,7 +127,7 @@ def construct_event_topic_set(
         [
             None
             if option is None
-            else encode_hex(abi_codec.encode_single(arg["type"], option))
+            else encode_hex(abi_codec.encode([arg["type"]], [option]))
             for option in arg_options
         ]
         for arg, arg_options in zipped_abi_and_args
@@ -169,7 +169,7 @@ def construct_event_data_set(
         [
             None
             if option is None
-            else encode_hex(abi_codec.encode_single(arg["type"], option))
+            else encode_hex(abi_codec.encode([arg["type"]], [option]))
             for option in arg_options
         ]
         for arg, arg_options in zipped_abi_and_args
@@ -252,7 +252,7 @@ def get_event_data(
     )
 
     decoded_topic_data = [
-        abi_codec.decode_single(topic_type, topic_data)
+        abi_codec.decode([topic_type], topic_data)[0]
         for topic_type, topic_data in zip(log_topic_types, log_topics)
     ]
     normalized_topic_data = map_abi_data(
@@ -517,7 +517,7 @@ def _encode(self, value: Any) -> HexStr:
         if is_dynamic_sized_type(self.arg_type):
             return to_hex(keccak(encode_single_packed(self.arg_type, value)))
         else:
-            return to_hex(self.abi_codec.encode_single(self.arg_type, value))
+            return to_hex(self.abi_codec.encode([self.arg_type], [value]))
 
 
 class EventLogErrorFlags(Enum):

web3/_utils/method_formatters.py

@@ -13,7 +13,7 @@
 )
 
 from eth_abi import (
-    decode,
+    abi,
 )
 from eth_typing import (
     HexStr,
@@ -623,7 +623,9 @@ def raise_solidity_error_on_revert(response: RPCResponse) -> RPCResponse:
     # OffchainLookup(address,string[],bytes,bytes4,bytes)
     if data[:10] == "0x556f1830":
         parsed_data_as_bytes = to_bytes(hexstr=data[10:])
-        abi_decoded_data = decode(OFFCHAIN_LOOKUP_FIELDS.values(), parsed_data_as_bytes)
+        abi_decoded_data = abi.decode(
+            OFFCHAIN_LOOKUP_FIELDS.values(), parsed_data_as_bytes
+        )
         offchain_lookup_payload = dict(
             zip(OFFCHAIN_LOOKUP_FIELDS.keys(), abi_decoded_data)
         )

web3/_utils/module_testing/eth_module.py

@@ -747,7 +747,7 @@ async def test_eth_call(self, async_w3: "Web3", math_contract: "Contract") -> No
         )
         call_result = await async_w3.eth.call(txn_params)  # type: ignore
         assert is_string(call_result)
-        result = async_w3.codec.decode_single("uint256", call_result)
+        (result,) = async_w3.codec.decode(["uint256"], call_result)
         assert result == 18
 
     @pytest.mark.asyncio
@@ -760,7 +760,7 @@ async def test_eth_call_with_override(
             transaction={"from": coinbase, "to": revert_contract.address},
         )
         call_result = await async_w3.eth.call(txn_params)  # type: ignore
-        result = async_w3.codec.decode_single("bool", call_result)
+        (result,) = async_w3.codec.decode(["bool"], call_result)
         assert result is True
 
         # override runtime bytecode: `normalFunction` returns `false`
@@ -770,7 +770,7 @@ async def test_eth_call_with_override(
         call_result = await async_w3.eth.call(  # type: ignore
             txn_params, "latest", {revert_contract.address: {"code": override_code}}
         )
-        result = async_w3.codec.decode_single("bool", call_result)
+        (result,) = async_w3.codec.decode(["bool"], call_result)
         assert result is False
 
     @pytest.mark.asyncio
@@ -785,7 +785,7 @@ async def test_eth_call_with_0_result(
         )
         call_result = await async_w3.eth.call(txn_params)  # type: ignore
         assert is_string(call_result)
-        result = async_w3.codec.decode_single("uint256", call_result)
+        (result,) = async_w3.codec.decode(["uint256"], call_result)
         assert result == 0
 
     @pytest.mark.asyncio
@@ -2569,7 +2569,7 @@ def test_eth_call(self, w3: "Web3", math_contract: "Contract") -> None:
         )
         call_result = w3.eth.call(txn_params)
         assert is_string(call_result)
-        result = w3.codec.decode_single("uint256", call_result)
+        (result,) = w3.codec.decode(["uint256"], call_result)
         assert result == 18
 
     def test_eth_call_with_override(
@@ -2581,7 +2581,7 @@ def test_eth_call_with_override(
             transaction={"from": coinbase, "to": revert_contract.address},
         )
         call_result = w3.eth.call(txn_params)
-        result = w3.codec.decode_single("bool", call_result)
+        (result,) = w3.codec.decode(["bool"], call_result)
         assert result is True
 
         # override runtime bytecode: `normalFunction` returns `false`
@@ -2591,7 +2591,7 @@ def test_eth_call_with_override(
         call_result = w3.eth.call(
             txn_params, "latest", {revert_contract.address: {"code": override_code}}
         )
-        result = w3.codec.decode_single("bool", call_result)
+        (result,) = w3.codec.decode(["bool"], call_result)
         assert result is False
 
     def test_eth_call_with_0_result(
@@ -2605,7 +2605,7 @@ def test_eth_call_with_0_result(
         )
         call_result = w3.eth.call(txn_params)
         assert is_string(call_result)
-        result = w3.codec.decode_single("uint256", call_result)
+        (result,) = w3.codec.decode(["uint256"], call_result)
         assert result == 0
 
     def test_eth_call_revert_with_msg(

web3/providers/eth_tester/defaults.py

@@ -13,8 +13,8 @@
     Type,
 )
 
-from eth_abi.abi import (
-    decode,
+from eth_abi import (
+    abi,
 )
 from eth_tester.exceptions import (
     BlockNotFound,
@@ -89,7 +89,7 @@ def call_eth_tester(
             data_payload = parsed_data_as_bytes[
                 4:
             ]  # everything but the function selector
-            abi_decoded_data = decode(OFFCHAIN_LOOKUP_FIELDS.values(), data_payload)
+            abi_decoded_data = abi.decode(OFFCHAIN_LOOKUP_FIELDS.values(), data_payload)
             offchain_lookup_payload = dict(
                 zip(OFFCHAIN_LOOKUP_FIELDS.keys(), abi_decoded_data)
             )

web3/utils/async_exception_handling.py

@@ -4,7 +4,7 @@
 )
 
 from eth_abi import (
-    encode,
+    abi,
 )
 from eth_typing import (
     URI,
@@ -81,7 +81,7 @@ async def async_handle_offchain_lookup(
                 # 4-byte callback function selector
                 to_bytes_if_hex(offchain_lookup_payload["callbackFunction"]),
                 # encode the `data` from the result and the `extraData` as bytes
-                encode(
+                abi.encode(
                     ["bytes", "bytes"],
                     [
                         to_bytes_if_hex(result["data"]),

web3/utils/exception_handling.py

@@ -4,7 +4,7 @@
 )
 
 from eth_abi import (
-    encode,
+    abi,
 )
 from eth_typing import (
     URI,
@@ -83,7 +83,7 @@ def handle_offchain_lookup(
                 # 4-byte callback function selector
                 to_bytes_if_hex(offchain_lookup_payload["callbackFunction"]),
                 # encode the `data` from the result and the `extraData` as bytes
-                encode(
+                abi.encode(
                     ["bytes", "bytes"],
                     [
                         to_bytes_if_hex(result["data"]),