Refactor

Author: kclowes

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

web3/_utils/abi.py

@@ -15,6 +15,7 @@
 import warnings
 
 from eth_abi import (
+    decoding,
     encoding,
 )
 from eth_abi.base import (
@@ -28,6 +29,10 @@
     TupleType,
     parse,
 )
+from eth_abi.registry import (
+    BaseEquals,
+    registry as default_registry
+)
 from eth_typing import (
     TypeStr,
 )
@@ -782,3 +787,67 @@ def strip_abi_type(elements):
         return elements.data
     else:
         return elements
+
+
+def build_default_registry():
+    # We make a copy here just to make sure that eth-abi's default registry is not
+    # affected by our custom encoder subclasses
+    registry = default_registry.copy()
+
+    registry.unregister('address')
+    registry.unregister('bytes<M>')
+    registry.unregister('bytes')
+    registry.unregister('string')
+
+    registry.register(
+        BaseEquals('address'),
+        AddressEncoder, decoding.AddressDecoder,
+        label='address',
+    )
+    registry.register(
+        BaseEquals('bytes', with_sub=True),
+        BytesEncoder, decoding.BytesDecoder,
+        label='bytes<M>',
+    )
+    registry.register(
+        BaseEquals('bytes', with_sub=False),
+        ByteStringEncoder, decoding.ByteStringDecoder,
+        label='bytes',
+    )
+    registry.register(
+        BaseEquals('string'),
+        TextStringEncoder, decoding.StringDecoder,
+        label='string',
+    )
+    return registry
+
+
+def build_strict_registry():
+    registry = default_registry.copy()
+
+    registry.unregister('address')
+    registry.unregister('bytes<M>')
+    registry.unregister('bytes')
+    registry.unregister('string')
+
+    registry.register(
+        BaseEquals('address'),
+        AddressEncoder, decoding.AddressDecoder,
+        label='address',
+    )
+    registry.register(
+        BaseEquals('bytes', with_sub=True),
+        ExactLengthBytesEncoder, decoding.BytesDecoder,
+        label='bytes<M>',
+    )
+    registry.register(
+        BaseEquals('bytes', with_sub=False),
+        StrictByteStringEncoder, decoding.ByteStringDecoder,
+        label='bytes',
+    )
+    registry.register(
+        BaseEquals('string'),
+        TextStringEncoder, decoding.StringDecoder,
+        label='string',
+    )
+    return registry

web3/_utils/contracts.py

@@ -172,7 +172,7 @@ def prepare_transaction(
     TODO: add new prepare_deploy_transaction API
     """
     if fn_abi is None:
-        fn_abi = find_matching_fn_abi(contract_abi, web3, fn_identifier, fn_args, fn_kwargs)
+        fn_abi = find_matching_fn_abi(contract_abi, web3.codec, fn_identifier, fn_args, fn_kwargs)
 
     validate_payable(transaction, fn_abi)
 

web3/contract.py

@@ -418,7 +418,7 @@ def decode_function_input(self, data):
     @combomethod
     def find_functions_by_args(self, *args):
         def callable_check(fn_abi):
-            return check_if_arguments_can_be_encoded(fn_abi, self.web3, args=args, kwargs={})
+            return check_if_arguments_can_be_encoded(fn_abi, self.web3.codec, args=args, kwargs={})
 
         return find_functions_by_identifier(
             self.abi, self.web3, self.address, callable_check
@@ -454,7 +454,7 @@ def _prepare_transaction(cls,
     @classmethod
     def _find_matching_fn_abi(cls, fn_identifier=None, args=None, kwargs=None):
         return find_matching_fn_abi(cls.abi,
-                                    cls.web3,
+                                    cls.web3.codec,
                                     fn_identifier=fn_identifier,
                                     args=args,
                                     kwargs=kwargs)
@@ -686,7 +686,7 @@ def _none_addr(datatype, data):
 class ImplicitMethod(ConciseMethod):
     def __call_by_default(self, args):
         function_abi = find_matching_fn_abi(self._function.contract_abi,
-                                            self._function.web3,
+                                            self._function.web3.codec,
                                             fn_identifier=self._function.function_identifier,
                                             args=args)
 
@@ -766,7 +766,7 @@ def _set_function_info(self):
         if not self.abi:
             self.abi = find_matching_fn_abi(
                 self.contract_abi,
-                self.web3,
+                self.web3.codec,
                 self.function_identifier,
                 self.args,
                 self.kwargs
@@ -1350,7 +1350,7 @@ def call_contract_function(
         return_data = web3.eth.call(call_transaction, block_identifier=block_id)
 
     if fn_abi is None:
-        fn_abi = find_matching_fn_abi(contract_abi, web3, function_identifier, args, kwargs)
+        fn_abi = find_matching_fn_abi(contract_abi, web3.codec, function_identifier, args, kwargs)
 
     output_types = get_abi_output_types(fn_abi)
 

web3/main.py

@@ -1,13 +1,6 @@
-from eth_abi import (
-    decoding,
-)
 from eth_abi.codec import (
     ABICodec,
 )
-from eth_abi.registry import (
-    BaseEquals,
-    registry as default_registry,
-)
 from eth_utils import (
     add_0x_prefix,
     apply_to_return_value,
@@ -25,13 +18,9 @@
 
 from ens import ENS
 from web3._utils.abi import (
+    build_default_registry,
+    build_strict_registry,
     map_abi_data,
-    AddressEncoder,
-    BytesEncoder,
-    ByteStringEncoder,
-    ExactLengthBytesEncoder,
-    StrictByteStringEncoder,
-    TextStringEncoder,
 )
 from web3._utils.decorators import (
     combomethod,
@@ -156,46 +145,10 @@ def __init__(self, provider=None, middlewares=None, modules=None, ens=empty):
 
         attach_modules(self, modules)
 
-        self.codec = ABICodec(self.build_default_registry())
+        self.codec = ABICodec(build_default_registry())
 
         self.ens = ens
 
-    def is_encodable(self, _type, value):
-        # TODO - there is probably a better place to put this
-        return self.codec.is_encodable(_type, value)
-
-    def build_default_registry(self):
-        # We make a copy here just to make sure that eth-abi's default registry is not
-        # affected by our custom encoder subclasses
-        registry = default_registry.copy()
-
-        registry.unregister('address')
-        registry.unregister('bytes<M>')
-        registry.unregister('bytes')
-        registry.unregister('string')
-
-        registry.register(
-            BaseEquals('address'),
-            AddressEncoder, decoding.AddressDecoder,
-            label='address',
-        )
-        registry.register(
-            BaseEquals('bytes', with_sub=True),
-            BytesEncoder, decoding.BytesDecoder,
-            label='bytes<M>',
-        )
-        registry.register(
-            BaseEquals('bytes', with_sub=False),
-            ByteStringEncoder, decoding.ByteStringDecoder,
-            label='bytes',
-        )
-        registry.register(
-            BaseEquals('string'),
-            TextStringEncoder, decoding.StringDecoder,
-            label='string',
-        )
-        return registry
-
     @property
     def middleware_onion(self):
         return self.manager.middleware_onion
@@ -300,35 +253,5 @@ def enable_unstable_package_management_api(self):
         if not hasattr(self, '_pm'):
             PM.attach(self, '_pm')
 
-    def build_strict_registry(self):
-        registry = default_registry.copy()
-
-        registry.unregister('address')
-        registry.unregister('bytes<M>')
-        registry.unregister('bytes')
-        registry.unregister('string')
-
-        registry.register(
-            BaseEquals('address'),
-            AddressEncoder, decoding.AddressDecoder,
-            label='address',
-        )
-        registry.register(
-            BaseEquals('bytes', with_sub=True),
-            ExactLengthBytesEncoder, decoding.BytesDecoder,
-            label='bytes<M>',
-        )
-        registry.register(
-            BaseEquals('bytes', with_sub=False),
-            StrictByteStringEncoder, decoding.ByteStringDecoder,
-            label='bytes',
-        )
-        registry.register(
-            BaseEquals('string'),
-            TextStringEncoder, decoding.StringDecoder,
-            label='string',
-        )
-        return registry
-
     def enable_strict_bytes_type_checking(self):
-        return setattr(self, 'codec', ABICodec(self.build_strict_registry()))
+        return setattr(self, 'codec', ABICodec(build_strict_registry()))