Refactor

- less web3 object passing,
- move around build registry functions

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,
 )
@@ -287,16 +292,16 @@ def from_type_str(cls, abi_type, registry):
         )
 
 
-def filter_by_encodability(abi_encoder, args, kwargs, contract_abi):
+def filter_by_encodability(abi_codec, args, kwargs, contract_abi):
     return [
         function_abi
         for function_abi
         in contract_abi
-        if check_if_arguments_can_be_encoded(function_abi, abi_encoder, args, kwargs)
+        if check_if_arguments_can_be_encoded(function_abi, abi_codec, args, kwargs)
     ]
 
 
-def check_if_arguments_can_be_encoded(function_abi, abi_encoder, args, kwargs):
+def check_if_arguments_can_be_encoded(function_abi, abi_codec, args, kwargs):
     try:
         arguments = merge_args_and_kwargs(function_abi, args, kwargs)
     except TypeError:
@@ -311,7 +316,7 @@ def check_if_arguments_can_be_encoded(function_abi, abi_encoder, args, kwargs):
         return False
 
     return all(
-        abi_encoder.is_encodable(_type, arg)
+        abi_codec.is_encodable(_type, arg)
         for _type, arg in zip(types, aligned_args)
     )
 
@@ -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

@@ -69,7 +69,7 @@ def find_matching_event_abi(abi, event_name=None, argument_names=None):
         raise ValueError("Multiple events found")
 
 
-def find_matching_fn_abi(abi, abi_encoder, fn_identifier=None, args=None, kwargs=None):
+def find_matching_fn_abi(abi, abi_codec, fn_identifier=None, args=None, kwargs=None):
     args = args or tuple()
     kwargs = kwargs or dict()
     num_arguments = len(args) + len(kwargs)
@@ -82,7 +82,7 @@ def find_matching_fn_abi(abi, abi_encoder, fn_identifier=None, args=None, kwargs
 
     name_filter = functools.partial(filter_by_name, fn_identifier)
     arg_count_filter = functools.partial(filter_by_argument_count, num_arguments)
-    encoding_filter = functools.partial(filter_by_encodability, abi_encoder, args, kwargs)
+    encoding_filter = functools.partial(filter_by_encodability, abi_codec, args, kwargs)
 
     function_candidates = pipe(abi, name_filter, arg_count_filter, encoding_filter)
 
@@ -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)
 
@@ -225,14 +225,14 @@ def get_fallback_function_info(contract_abi=None, fn_abi=None):
     return fn_abi, fn_selector, fn_arguments
 
 
-def get_function_info(fn_name, abi_encoder, contract_abi=None, fn_abi=None, args=None, kwargs=None):
+def get_function_info(fn_name, abi_codec, contract_abi=None, fn_abi=None, args=None, kwargs=None):
     if args is None:
         args = tuple()
     if kwargs is None:
         kwargs = {}
 
     if fn_abi is None:
-        fn_abi = find_matching_fn_abi(contract_abi, abi_encoder, fn_name, args, kwargs)
+        fn_abi = find_matching_fn_abi(contract_abi, abi_codec, fn_name, args, kwargs)
 
     fn_selector = encode_hex(function_abi_to_4byte_selector(fn_abi))
 

web3/_utils/events.py

@@ -61,7 +61,7 @@
 )
 
 
-def construct_event_topic_set(event_abi, abi_encoder, arguments=None):
+def construct_event_topic_set(event_abi, abi_codec, arguments=None):
     if arguments is None:
         arguments = {}
     if isinstance(arguments, (list, tuple)):
@@ -89,7 +89,7 @@ def construct_event_topic_set(event_abi, abi_encoder, arguments=None):
     ]
     encoded_args = [
         [
-            None if option is None else encode_hex(abi_encoder.encode_single(arg['type'], option))
+            None if option is None else encode_hex(abi_codec.encode_single(arg['type'], option))
             for option in arg_options]
         for arg, arg_options in zipped_abi_and_args
     ]
@@ -98,7 +98,7 @@ def construct_event_topic_set(event_abi, abi_encoder, arguments=None):
     return topics
 
 
-def construct_event_data_set(event_abi, abi_encoder, arguments=None):
+def construct_event_data_set(event_abi, abi_codec, arguments=None):
     if arguments is None:
         arguments = {}
     if isinstance(arguments, (list, tuple)):
@@ -125,7 +125,7 @@ def construct_event_data_set(event_abi, abi_encoder, arguments=None):
     ]
     encoded_args = [
         [
-            None if option is None else encode_hex(abi_encoder.encode_single(arg['type'], option))
+            None if option is None else encode_hex(abi_codec.encode_single(arg['type'], option))
             for option in arg_options]
         for arg, arg_options in zipped_abi_and_args
     ]

web3/_utils/filters.py

@@ -31,15 +31,15 @@
 
 
 def construct_event_filter_params(event_abi,
-                                  abi_encoder,
+                                  abi_codec,
                                   contract_address=None,
                                   argument_filters=None,
                                   topics=None,
                                   fromBlock=None,
                                   toBlock=None,
                                   address=None):
     filter_params = {}
-    topic_set = construct_event_topic_set(event_abi, abi_encoder, argument_filters)
+    topic_set = construct_event_topic_set(event_abi, abi_codec, argument_filters)
 
     if topics is not None:
         if len(topic_set) > 1:
@@ -81,7 +81,7 @@ def construct_event_filter_params(event_abi,
     if toBlock is not None:
         filter_params['toBlock'] = toBlock
 
-    data_filters_set = construct_event_data_set(event_abi, abi_encoder, argument_filters)
+    data_filters_set = construct_event_data_set(event_abi, abi_codec, argument_filters)
 
     return data_filters_set, filter_params
 

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()))