Move eth-abi functions to the local web3 codec

Author: kclowes

docs/overview.rst

@@ -359,23 +359,23 @@ For example, if an abi specifies a type of ``bytes4``, web3 will handle all of t
 
 .. code-block:: python
 
-   - ''       # valid - empty string that is less than 4 bytes and can be decoded as a hex string
-   - '0x'     # valid - empty hex string
-   - b''      # valid - empty bytestring
-   - b'ab'    # valid - less than 4 bytes
-   - '0xab'   # valid - hex string with less than 4 bytes
-   - '1234'   # valid - string that can be decoded as a hex string
-   - '0xabcd' # valid - hex string with exactly 4 bytes
-   - b'1234'  # valid - bytestring with exactly 4 bytes
+   - ''           # valid - empty string less than 4 bytes and can be decoded as a hex string
+   - '0x'         # valid - empty hex string
+   - b''          # valid - empty bytestring
+   - b'ab'        # valid - less than 4 bytes
+   - '0xab'       # valid - hex string with less than 4 bytes
+   - '1234'       # valid - string that can be decoded as a hex string
+   - '0x61626364' # valid - hex string with exactly 4 bytes
+   - b'1234'      # valid - bytestring with exactly 4 bytes
 
 The following values will raise an error by default:
 
 .. code-block:: python
 
-   - b'abcde'  # invalid - more than 4 bytes
-   - '0xabcde' # invalid - hex string with more than 4 bytes
-   - 2         # invalid - wrong type
-   - 'ah'      # invalid - string not valid hex
+   - b'abcde'       # invalid - more than 4 bytes
+   - '0x6162636423' # invalid - hex string with more than 4 bytes
+   - 2              # invalid - wrong type
+   - 'ah'           # invalid - string not valid hex
 
 However, you may want to be stricter with acceptable values for bytes types.
 For this you can use the ``enable_strict_bytes_type_checking`` method,
@@ -386,17 +386,17 @@ specified byte size will raise an error. Using the same ``bytes4`` example:
 
 .. code-block:: python
 
-   - '0xabcd'  # valid - hex string with exactly 4 bytes
-   - b'1234'   # valid - bytestring with exactly 4 bytes
-   - b'ab'     # invalid - less than 4 bytes
-   - '0xab'    # invalid - hex string with less than 4 bytes
-   - ''        # invalid - needs a 0x to be interpreted as hex
-   - '1234'    # invalid - needs a 0x to be interpreted as hex
-   - b''       # invalid - less than 4 bytes
-   - b'abcde'  # invalid - more than 4 bytes
-   - '0xabcde' # invalid - hex string with more than 4 bytes
-   - 2         # invalid - wrong type
-   - 'ah'      # invalid - string not valid hex
+   - '0x61626364'   # valid - hex string with exactly 4 bytes
+   - b'1234'        # valid - bytestring with exactly 4 bytes
+   - b'ab'          # invalid - less than 4 bytes
+   - '0xab'         # invalid - hex string with less than 4 bytes
+   - ''             # invalid - needs a 0x to be interpreted as hex
+   - '1234'         # invalid - needs a 0x to be interpreted as hex
+   - b''            # invalid - less than 4 bytes
+   - b'abcde'       # invalid - more than 4 bytes
+   - '0x6162636423' # invalid - hex string with more than 4 bytes
+   - 2              # invalid - wrong type
+   - 'ah'           # invalid - string not valid hex
 
 
 For example, the following contract code will generate the abi below and some bytecode:

tests/core/contracts/test_contract_constructor_encoding.py

@@ -1,8 +1,5 @@
 import pytest
 
-from eth_abi import (
-    encode_abi,
-)
 from eth_utils import (
     encode_hex,
     remove_0x_prefix,
@@ -53,13 +50,27 @@ def test_error_if_invalid_arguments_supplied(WithConstructorArgumentsContract, a
     'bytes_arg',
     (
         b'abcd',
-        '61626364',
         '0x61626364',
     ),
 )
-def test_contract_constructor_encoding_encoding(WithConstructorArgumentsContract, bytes_arg):
+def test_contract_constructor_encoding_encoding(web3, WithConstructorArgumentsContract, bytes_arg):
     deploy_data = WithConstructorArgumentsContract._encode_constructor_data([1234, bytes_arg])
     encoded_args = '0x00000000000000000000000000000000000000000000000000000000000004d26162636400000000000000000000000000000000000000000000000000000000'  # noqa: E501
-    expected_ending = encode_hex(encode_abi(['uint256', 'bytes32'], [1234, b'abcd']))
+    expected_ending = encode_hex(web3.codec.encode_abi(['uint256', 'bytes32'], [1234, b'abcd']))
     assert expected_ending == encoded_args
     assert deploy_data.endswith(remove_0x_prefix(expected_ending))
+
+
+def test_contract_constructor_encoding_encoding_warning(web3, WithConstructorArgumentsContract):
+    with pytest.warns(
+        DeprecationWarning,
+        match="in v6 it will be invalid to pass a hexstring without the \"0x\" prefix"
+    ):
+
+        deploy_data = WithConstructorArgumentsContract._encode_constructor_data([1234, '61626364'])
+        encoded_args = '0x00000000000000000000000000000000000000000000000000000000000004d26162636400000000000000000000000000000000000000000000000000000000'  # noqa: E501
+        expected_ending = encode_hex(
+            web3.codec.encode_abi(['uint256', 'bytes32'], [1234, b'abcd'])
+        )
+        assert expected_ending == encoded_args
+        assert deploy_data.endswith(remove_0x_prefix(expected_ending))

tests/core/contracts/test_contract_method_to_argument_matching.py

@@ -128,7 +128,6 @@ def test_error_when_no_function_name_match(web3):
         ([], []),
         ([b'arst'], ['bytes32']),
         (['0xf00b47'], ['bytes32']),
-        ([''], ['bytes32']),
         (['0x'], ['bytes32']),
         ([1234567890], ['uint256']),
         # ([255], ['uint8']),  # TODO: enable
@@ -145,6 +144,16 @@ def test_finds_function_with_matching_args(web3, arguments, expected_types):
     assert set(get_abi_input_types(abi)) == set(expected_types)
 
 
+def test_finds_function_with_matching_args_deprecation_warning(web3):
+    Contract = web3.eth.contract(abi=MULTIPLE_FUNCTIONS)
+
+    with pytest.warns(DeprecationWarning):
+        abi = Contract._find_matching_fn_abi('a', [''])
+        assert abi['name'] == 'a'
+        assert len(abi['inputs']) == len(['bytes32'])
+        assert set(get_abi_input_types(abi)) == set(['bytes32'])
+
+
 def test_error_when_duplicate_match(web3):
     Contract = web3.eth.contract(abi=MULTIPLE_FUNCTIONS)
 

tests/core/contracts/test_extracting_event_data.py

@@ -176,7 +176,7 @@ def test_event_data_extraction(web3,
     else:
         assert event_topic in log_entry['topics']
 
-    event_data = get_event_data(event_abi, log_entry)
+    event_data = get_event_data(web3.codec, event_abi, log_entry)
 
     assert event_data['args'] == expected_args
     assert event_data['blockHash'] == txn_receipt['blockHash']
@@ -207,7 +207,7 @@ def test_dynamic_length_argument_extraction(web3,
     string_0_topic = web3.keccak(text=string_0)
     assert string_0_topic in log_entry['topics']
 
-    event_data = get_event_data(event_abi, log_entry)
+    event_data = get_event_data(web3.codec, event_abi, log_entry)
 
     expected_args = {
         "arg0": string_0_topic,

tests/core/contracts/test_extracting_event_data_old.py

@@ -95,7 +95,7 @@ def test_event_data_extraction(web3,
     else:
         assert event_topic in log_entry['topics']
 
-    event_data = get_event_data(event_abi, log_entry)
+    event_data = get_event_data(web3.codec, event_abi, log_entry)
 
     assert event_data['args'] == expected_args
     assert event_data['blockHash'] == txn_receipt['blockHash']
@@ -126,7 +126,7 @@ def test_dynamic_length_argument_extraction(web3,
     string_0_topic = web3.keccak(text=string_0)
     assert string_0_topic in log_entry['topics']
 
-    event_data = get_event_data(event_abi, log_entry)
+    event_data = get_event_data(web3.codec, event_abi, log_entry)
 
     expected_args = {
         "arg0": string_0_topic,

tests/core/filtering/test_utils_functions.py

@@ -3,10 +3,6 @@
 )
 import pytest
 
-from eth_abi import (
-    encode_abi,
-)
-
 from web3._utils.filters import (
     match_fn,
 )
@@ -83,19 +79,21 @@
         ),
     )
 )
-def test_match_fn_with_various_data_types(data, expected, match_data_and_abi):
+def test_match_fn_with_various_data_types(web3, data, expected, match_data_and_abi):
     abi_types, match_data = zip(*match_data_and_abi)
-    encoded_data = encode_abi(abi_types, data)
-    assert match_fn(match_data_and_abi, encoded_data) == expected
+    # import pdb
+    # pdb.set_trace()
+    encoded_data = web3.codec.encode_abi(abi_types, data)
+    assert match_fn(web3, match_data_and_abi, encoded_data) == expected
 
 
-def test_wrong_type_match_data():
+def test_wrong_type_match_data(web3):
     data = ("hello", "goodbye")
     match_data_and_abi = (
         ("string", (50505050,)),
         ("string", (50505050,)),
     )
     abi_types, match_data = zip(*match_data_and_abi)
-    encoded_data = encode_abi(abi_types, data)
+    encoded_data = web3.codec.encode_abi(abi_types, data)
     with pytest.raises(ValueError):
-        match_fn(match_data_and_abi, encoded_data)
+        match_fn(web3, match_data_and_abi, encoded_data)

tests/core/utilities/test_abi_is_encodable.py

@@ -75,7 +75,7 @@
 )
 def test_is_encodable(value, _type, expected):
     w3 = Web3(EthereumTesterProvider())
-    actual = w3.is_encodable(_type, value)
+    actual = w3.codec.is_encodable(_type, value)
     assert actual is expected
 
 
@@ -107,5 +107,5 @@ def test_is_encodable_strict(value, _type, expected):
     w3 = Web3(EthereumTesterProvider())
     w3.enable_strict_bytes_type_checking()
 
-    actual = w3.is_encodable(_type, value)
+    actual = w3.codec.is_encodable(_type, value)
     assert actual is expected

tests/core/utilities/test_construct_event_data_set.py

@@ -68,6 +68,6 @@ def hex_and_pad(i):
         ),
     )
 )
-def test_construct_event_data_set(event_abi, arguments, expected):
-    actual = construct_event_data_set(event_abi, arguments)
+def test_construct_event_data_set(web3, event_abi, arguments, expected):
+    actual = construct_event_data_set(event_abi, web3.codec, arguments)
     assert actual == expected

tests/core/utilities/test_construct_event_filter_params.py

@@ -46,8 +46,8 @@
         }),
     ),
 )
-def test_construct_event_filter_params(event_abi, fn_kwargs, expected):
-    _, actual = construct_event_filter_params(event_abi, **fn_kwargs)
+def test_construct_event_filter_params(web3, event_abi, fn_kwargs, expected):
+    _, actual = construct_event_filter_params(event_abi, web3.codec, **fn_kwargs)
     assert actual == expected
 
 
@@ -68,7 +68,7 @@ def hex_and_pad(i):
         ]),
     ),
 )
-def test_construct_event_filter_params_for_data_filters(event_abi, fn_kwargs,
+def test_construct_event_filter_params_for_data_filters(event_abi, web3, fn_kwargs,
                                                         expected):
-    actual, _ = construct_event_filter_params(event_abi, **fn_kwargs)
+    actual, _ = construct_event_filter_params(event_abi, web3.codec, **fn_kwargs)
     assert actual == expected

tests/core/utilities/test_construct_event_topics.py

@@ -75,6 +75,6 @@ def hex_and_pad(i):
         ),
     )
 )
-def test_construct_event_topics(event_abi, arguments, expected):
-    actual = construct_event_topic_set(event_abi, arguments)
+def test_construct_event_topics(web3, event_abi, arguments, expected):
+    actual = construct_event_topic_set(event_abi, web3.codec, arguments)
     assert actual == expected