web3 7.0.0b8__py3-none-any.whl → 7.1.0__py3-none-any.whl

web3/_utils/abi.py

@@ -25,7 +25,6 @@ from typing import (
 )
 
 from eth_abi import (
-    codec,
     decoding,
     encoding,
 )
@@ -47,11 +46,23 @@ from eth_abi.registry import (
     registry as default_registry,
 )
 from eth_typing import (
+    ABI,
+    ABIComponent,
+    ABIComponentIndexed,
+    ABIConstructor,
+    ABIElement,
+    ABIEvent,
+    ABIFallback,
+    ABIFunction,
+    ABIReceive,
     HexStr,
     TypeStr,
 )
 from eth_utils import (
+    collapse_if_tuple,
     decode_hex,
+    filter_abi_by_type,
+    get_abi_input_names,
     is_bytes,
     is_list_like,
     is_string,
@@ -59,9 +70,6 @@ from eth_utils import (
     to_text,
     to_tuple,
 )
-from eth_utils.abi import (
-    collapse_if_tuple,
-)
 from eth_utils.toolz import (
     curry,
     partial,
@@ -78,23 +86,14 @@ from web3._utils.formatters import (
     recursive_map,
 )
 from web3.exceptions import (
-    FallbackNotFound,
     MismatchedABI,
     Web3AttributeError,
     Web3TypeError,
     Web3ValueError,
 )
 from web3.types import (
-    ABI,
-    ABIEvent,
-    ABIEventParams,
-    ABIFunction,
-    ABIFunctionParams,
     TReturn,
 )
-from web3.utils import (  # public utils module
-    get_abi_input_names,
-)
 
 if TYPE_CHECKING:
     from web3 import (  # noqa: F401
@@ -102,106 +101,62 @@ if TYPE_CHECKING:
     )
 
 
-def filter_by_type(_type: str, contract_abi: ABI) -> List[Union[ABIFunction, ABIEvent]]:
-    return [abi for abi in contract_abi if abi["type"] == _type]
-
-
-def filter_by_name(name: str, contract_abi: ABI) -> List[Union[ABIFunction, ABIEvent]]:
-    return [
-        abi
-        for abi in contract_abi
-        if (
-            abi["type"] not in ("fallback", "constructor", "receive")
-            and abi["name"] == name
-        )
-    ]
-
-
-def get_abi_input_types(abi: ABIFunction) -> List[str]:
-    if "inputs" not in abi and (abi["type"] == "fallback" or abi["type"] == "receive"):
-        return []
-    else:
-        return [collapse_if_tuple(cast(Dict[str, Any], arg)) for arg in abi["inputs"]]
-
-
-def get_abi_output_types(abi: ABIFunction) -> List[str]:
-    if abi["type"] == "fallback":
-        return []
-    else:
-        return [collapse_if_tuple(cast(Dict[str, Any], arg)) for arg in abi["outputs"]]
-
-
-def get_receive_func_abi(contract_abi: ABI) -> ABIFunction:
-    receive_abis = filter_by_type("receive", contract_abi)
-    if receive_abis:
-        return cast(ABIFunction, receive_abis[0])
-    else:
-        raise FallbackNotFound("No receive function was found in the contract ABI.")
-
-
-def get_fallback_func_abi(contract_abi: ABI) -> ABIFunction:
-    fallback_abis = filter_by_type("fallback", contract_abi)
-    if fallback_abis:
-        return cast(ABIFunction, fallback_abis[0])
-    else:
-        raise FallbackNotFound("No fallback function was found in the contract ABI.")
-
-
-def fallback_func_abi_exists(contract_abi: ABI) -> List[Union[ABIFunction, ABIEvent]]:
-    return filter_by_type("fallback", contract_abi)
+def fallback_func_abi_exists(contract_abi: ABI) -> Sequence[ABIFallback]:
+    return filter_abi_by_type("fallback", contract_abi)
 
 
-def receive_func_abi_exists(contract_abi: ABI) -> List[Union[ABIFunction, ABIEvent]]:
-    return filter_by_type("receive", contract_abi)
+def receive_func_abi_exists(contract_abi: ABI) -> Sequence[ABIReceive]:
+    return filter_abi_by_type("receive", contract_abi)
 
 
-def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParams]:
-    return [arg for arg in event_abi["inputs"] if arg["indexed"] is True]
+def get_indexed_event_inputs(event_abi: ABIEvent) -> Sequence[ABIComponentIndexed]:
+    return [
+        cast(ABIComponentIndexed, arg)
+        for arg in event_abi["inputs"]
+        if cast(ABIComponentIndexed, arg)["indexed"] is True
+    ]
 
 
-def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParams]:
-    return [arg for arg in event_abi["inputs"] if arg["indexed"] is False]
+def exclude_indexed_event_inputs(event_abi: ABIEvent) -> Sequence[ABIComponent]:
+    return [
+        arg
+        for arg in event_abi["inputs"]
+        if cast(ABIComponentIndexed, arg)["indexed"] is False
+    ]
 
 
-def get_normalized_abi_arg_type(abi_arg: ABIEventParams) -> str:
+def filter_by_argument_name(
+    argument_names: Collection[str], contract_abi: ABI
+) -> List[ABIElement]:
     """
-    Return the normalized type for the abi argument provided.
-    In order to account for tuple argument types, this abstraction
-    makes use of `collapse_if_tuple()` to collapse the appropriate component
-    types within a tuple type, if present.
+    Return a list of each ``ABIElement`` which contain arguments matching provided
+    names.
     """
-    return collapse_if_tuple(dict(abi_arg))
+    abis_with_matching_args = []
+    for abi_element in contract_abi:
+        try:
+            abi_arg_names = get_abi_input_names(abi_element)
 
+            if set(argument_names).intersection(abi_arg_names) == set(argument_names):
+                abis_with_matching_args.append(abi_element)
+        except TypeError:
+            # fallback or receive functions do not have arguments
+            # proceed to next ABIElement
+            continue
 
-def filter_by_argument_count(
-    num_arguments: int, contract_abi: ABI
-) -> List[Union[ABIFunction, ABIEvent]]:
-    return [abi for abi in contract_abi if len(abi["inputs"]) == num_arguments]
+    return abis_with_matching_args
 
 
-def filter_by_argument_name(
-    argument_names: Collection[str], contract_abi: ABI
-) -> List[Union[ABIFunction, ABIEvent]]:
-    return [
-        abi
-        for abi in contract_abi
-        if set(argument_names).intersection(get_abi_input_names(abi))
-        == set(argument_names)
-    ]
-
-
-# type ignored because subclassing encoding.AddressEncoder which has type Any
-class AddressEncoder(encoding.AddressEncoder):  # type: ignore[misc]
+class AddressEncoder(encoding.AddressEncoder):
     @classmethod
     def validate_value(cls, value: Any) -> None:
         if is_ens_name(value):
             return
 
-        super().validate_value(value)
+        super().validate_value(value)  # type: ignore[no-untyped-call]
 
 
-# type ignored because subclassing encoding.BytesEncoder which has type Any
-class AcceptsHexStrEncoder(encoding.BaseEncoder):  # type: ignore[misc]
+class AcceptsHexStrEncoder(encoding.BaseEncoder):
     subencoder_cls: Type[encoding.BaseEncoder] = None
     is_strict: bool = None
     is_big_endian: bool = False
@@ -213,7 +168,7 @@ class AcceptsHexStrEncoder(encoding.BaseEncoder):  # type: ignore[misc]
         subencoder: encoding.BaseEncoder,
         **kwargs: Dict[str, Any],
     ) -> None:
-        super().__init__(**kwargs)
+        super().__init__(**kwargs)  # type: ignore[no-untyped-call]
         self.subencoder = subencoder
         self.is_dynamic = subencoder.is_dynamic
 
@@ -225,7 +180,7 @@ class AcceptsHexStrEncoder(encoding.BaseEncoder):  # type: ignore[misc]
         # cast b/c expects BaseCoder but `from_type_string`
         # restricted to BaseEncoder subclasses
         subencoder = cast(
-            encoding.BaseEncoder, subencoder_cls.from_type_str(abi_type, registry)
+            encoding.BaseEncoder, subencoder_cls.from_type_str(abi_type, registry)  # type: ignore[no-untyped-call]  # noqa: E501
         )
         return cls(subencoder)
 
@@ -290,7 +245,7 @@ class ExactLengthBytesEncoder(BytesEncoder):
     is_strict = True
 
     def validate(self) -> None:
-        super().validate()
+        super().validate()  # type: ignore[no-untyped-call]
         if self.value_bit_size is None:
             raise Web3ValueError("`value_bit_size` may not be none")
         if self.data_byte_size is None:
@@ -307,16 +262,22 @@ class ExactLengthBytesEncoder(BytesEncoder):
         if self.value_bit_size > self.data_byte_size * 8:
             raise Web3ValueError("Value byte size exceeds data size")
 
-    @parse_type_str("bytes")
+    @parse_type_str("bytes")  # type: ignore[no-untyped-call]
     def from_type_str(
         cls, abi_type: BasicType, registry: ABIRegistry
     ) -> "ExactLengthBytesEncoder":
         subencoder_cls = cls.get_subencoder_class()
-        subencoder = subencoder_cls.from_type_str(abi_type.to_type_str(), registry)
-        return cls(
-            subencoder,
-            value_bit_size=abi_type.sub * 8,
-            data_byte_size=abi_type.sub,
+        subencoder = subencoder_cls.from_type_str(abi_type.to_type_str(), registry)  # type: ignore[no-untyped-call]  # noqa: E501
+        return cast(
+            ExactLengthBytesEncoder,
+            # type ignored b/c mypy thinks the __call__ is from BaseEncoder, but it's
+            # from ExactLengthBytesEncoder, which does have value_bit_size and
+            # data_byte_size attributes
+            cls(  # type: ignore[call-arg]
+                subencoder,
+                value_bit_size=abi_type.sub * 8,
+                data_byte_size=abi_type.sub,
+            ),
         )
 
 
@@ -330,8 +291,7 @@ class StrictByteStringEncoder(AcceptsHexStrEncoder):
     is_strict = True
 
 
-# type ignored because subclassing encoding.TextStringEncoder which has type Any
-class TextStringEncoder(encoding.TextStringEncoder):  # type: ignore[misc]
+class TextStringEncoder(encoding.TextStringEncoder):
     @classmethod
     def validate_value(cls, value: Any) -> None:
         if is_bytes(value):
@@ -343,110 +303,7 @@ class TextStringEncoder(encoding.TextStringEncoder):  # type: ignore[misc]
                     msg="not decodable as unicode string",
                 )
 
-        super().validate_value(value)
-
-
-def filter_by_encodability(
-    abi_codec: codec.ABIEncoder,
-    args: Sequence[Any],
-    kwargs: Dict[str, Any],
-    contract_abi: ABI,
-) -> List[ABIFunction]:
-    return [
-        cast(ABIFunction, function_abi)
-        for function_abi in contract_abi
-        if check_if_arguments_can_be_encoded(
-            cast(ABIFunction, function_abi), abi_codec, args, kwargs
-        )
-    ]
-
-
-def check_if_arguments_can_be_encoded(
-    function_abi: ABIFunction,
-    abi_codec: codec.ABIEncoder,
-    args: Sequence[Any],
-    kwargs: Dict[str, Any],
-) -> bool:
-    try:
-        arguments = merge_args_and_kwargs(function_abi, args, kwargs)
-    except TypeError:
-        return False
-
-    if len(function_abi.get("inputs", [])) != len(arguments):
-        return False
-
-    try:
-        types, aligned_args = get_aligned_abi_inputs(function_abi, arguments)
-    except TypeError:
-        return False
-
-    return all(
-        abi_codec.is_encodable(_type, arg) for _type, arg in zip(types, aligned_args)
-    )
-
-
-def merge_args_and_kwargs(
-    function_abi: ABIFunction, args: Sequence[Any], kwargs: Dict[str, Any]
-) -> Tuple[Any, ...]:
-    """
-    Takes a list of positional args (``args``) and a dict of keyword args
-    (``kwargs``) defining values to be passed to a call to the contract function
-    described by ``function_abi``.  Checks to ensure that the correct number of
-    args were given, no duplicate args were given, and no unknown args were
-    given.  Returns a list of argument values aligned to the order of inputs
-    defined in ``function_abi``.
-    """
-    # Ensure the function is being applied to the correct number of args
-    if len(args) + len(kwargs) != len(function_abi.get("inputs", [])):
-        raise Web3TypeError(
-            f"Incorrect argument count. Expected '{len(function_abi['inputs'])}'"
-            f". Got '{len(args) + len(kwargs)}'"
-        )
-
-    # If no keyword args were given, we don't need to align them
-    if not kwargs:
-        return cast(Tuple[Any, ...], args)
-
-    kwarg_names = set(kwargs.keys())
-    sorted_arg_names = tuple(arg_abi["name"] for arg_abi in function_abi["inputs"])
-    args_as_kwargs = dict(zip(sorted_arg_names, args))
-
-    # Check for duplicate args
-    duplicate_args = kwarg_names.intersection(args_as_kwargs.keys())
-    if duplicate_args:
-        raise Web3TypeError(
-            f"{function_abi.get('name')}() got multiple values for argument(s) "
-            f"'{', '.join(duplicate_args)}'"
-        )
-
-    # Check for unknown args
-    unknown_args = kwarg_names.difference(sorted_arg_names)
-    if unknown_args:
-        if function_abi.get("name"):
-            raise Web3TypeError(
-                f"{function_abi.get('name')}() got unexpected keyword argument(s)"
-                f" '{', '.join(unknown_args)}'"
-            )
-        raise Web3TypeError(
-            f"Type: '{function_abi.get('type')}' got unexpected keyword argument(s)"
-            f" '{', '.join(unknown_args)}'"
-        )
-
-    # Sort args according to their position in the ABI and unzip them from their
-    # names
-    sorted_args = tuple(
-        zip(
-            *sorted(
-                itertools.chain(kwargs.items(), args_as_kwargs.items()),
-                key=lambda kv: sorted_arg_names.index(kv[0]),
-            )
-        )
-    )
-
-    if sorted_args:
-        return sorted_args[1]
-    else:
-        return tuple()
+        super().validate_value(value)  # type: ignore[no-untyped-call]
 
 
 TUPLE_TYPE_STR_RE = re.compile(r"^(tuple)((\[([1-9]\d*\b)?])*)??$")
@@ -468,7 +325,9 @@ def get_tuple_type_str_parts(s: str) -> Optional[Tuple[str, Optional[str]]]:
     return None
 
 
-def _align_abi_input(arg_abi: ABIFunctionParams, arg: Any) -> Tuple[Any, ...]:
+def _align_abi_input(
+    arg_abi: Union[ABIComponent, ABIComponentIndexed], arg: Any
+) -> Tuple[Any, ...]:
     """
     Aligns the values of any mapping at any level of nesting in ``arg``
     according to the layout of the corresponding abi spec.
@@ -492,7 +351,7 @@ def _align_abi_input(arg_abi: ABIFunctionParams, arg: Any) -> Tuple[Any, ...]:
         new_abi = copy.copy(arg_abi)
         new_abi["type"] = tuple_prefix + "[]" * (num_dims - 1)
 
-        sub_abis = itertools.repeat(new_abi)  # type: ignore
+        sub_abis = [cast(ABIComponent, abi) for abi in itertools.repeat(new_abi)]
 
     if isinstance(arg, abc.Mapping):
         # Arg is mapping.  Align values according to abi order.
@@ -515,29 +374,14 @@ def _align_abi_input(arg_abi: ABIFunctionParams, arg: Any) -> Tuple[Any, ...]:
     )
 
 
-def get_aligned_abi_inputs(
-    abi: ABIFunction, args: Union[Tuple[Any, ...], Mapping[Any, Any]]
-) -> Tuple[Tuple[Any, ...], Tuple[Any, ...]]:
-    """
-    Takes a function ABI (``abi``) and a sequence or mapping of args (``args``).
-    Returns a list of type strings for the function's inputs and a list of
-    arguments which have been aligned to the layout of those types.  The args
-    contained in ``args`` may contain nested mappings or sequences corresponding
-    to tuple-encoded values in ``abi``.
+def find_constructor_abi_element_by_type(contract_abi: ABI) -> ABIConstructor:
     """
-    input_abis = abi.get("inputs", [])
-
-    if isinstance(args, abc.Mapping):
-        # `args` is mapping.  Align values according to abi order.
-        args = tuple(args[abi["name"]] for abi in input_abis)
-
-    return (
-        tuple(collapse_if_tuple(abi) for abi in input_abis),
-        type(args)(_align_abi_input(abi, arg) for abi, arg in zip(input_abis, args)),
-    )
-
+    Find the constructor ABI element in the contract ABI.
 
-def get_constructor_abi(contract_abi: ABI) -> ABIFunction:
+    This function is often used in place of `web3.utils.abi.get_abi_element` to find
+    a constructor without considering it's argument types. This is used prior to
+    encoding the abi, since the argument types are not known at that time.
+    """
     candidates = [abi for abi in contract_abi if abi["type"] == "constructor"]
     if len(candidates) == 1:
         return candidates[0]
@@ -671,8 +515,8 @@ def is_probably_enum(abi_type: TypeStr) -> bool:
 
 @to_tuple
 def normalize_event_input_types(
-    abi_args: Collection[Union[ABIFunction, ABIEvent]]
-) -> Iterable[Union[ABIFunction, ABIEvent, Dict[TypeStr, Any]]]:
+    abi_args: Collection[ABIEvent],
+) -> Iterable[Union[ABIEvent, Dict[TypeStr, Any]]]:
     for arg in abi_args:
         if is_recognized_type(arg["type"]):
             yield arg
@@ -682,17 +526,6 @@ def normalize_event_input_types(
             yield arg
 
 
-def abi_to_signature(abi: Union[ABIFunction, ABIEvent]) -> str:
-    function_signature = "{fn_name}({fn_input_types})".format(
-        fn_name=abi["name"],
-        fn_input_types=",".join(
-            collapse_if_tuple(dict(arg))
-            for arg in normalize_event_input_types(abi.get("inputs", []))
-        ),
-    )
-    return function_signature
-
-
 ########################################################
 #
 #  Conditionally modifying data, tagged with ABI Types
@@ -843,7 +676,7 @@ def strip_abi_type(elements: Any) -> Any:
 def build_non_strict_registry() -> ABIRegistry:
     # 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 = default_registry.copy()  # type: ignore[no-untyped-call]
 
     registry.unregister("address")
     registry.unregister("bytes<M>")
@@ -851,25 +684,25 @@ def build_non_strict_registry() -> ABIRegistry:
     registry.unregister("string")
 
     registry.register(
-        BaseEquals("address"),
+        BaseEquals("address"),  # type: ignore[no-untyped-call]
         AddressEncoder,
         decoding.AddressDecoder,
         label="address",
     )
     registry.register(
-        BaseEquals("bytes", with_sub=True),
+        BaseEquals("bytes", with_sub=True),  # type: ignore[no-untyped-call]
         BytesEncoder,
         decoding.BytesDecoder,
         label="bytes<M>",
     )
     registry.register(
-        BaseEquals("bytes", with_sub=False),
+        BaseEquals("bytes", with_sub=False),  # type: ignore[no-untyped-call]
         ByteStringEncoder,
         decoding.ByteStringDecoder,
         label="bytes",
     )
     registry.register(
-        BaseEquals("string"),
+        BaseEquals("string"),  # type: ignore[no-untyped-call]
         TextStringEncoder,
         decoding.StringDecoder,
         label="string",
@@ -878,7 +711,7 @@ def build_non_strict_registry() -> ABIRegistry:
 
 
 def build_strict_registry() -> ABIRegistry:
-    registry = default_registry.copy()
+    registry = default_registry.copy()  # type: ignore[no-untyped-call]
 
     registry.unregister("address")
     registry.unregister("bytes<M>")
@@ -886,25 +719,25 @@ def build_strict_registry() -> ABIRegistry:
     registry.unregister("string")
 
     registry.register(
-        BaseEquals("address"),
+        BaseEquals("address"),  # type: ignore[no-untyped-call]
         AddressEncoder,
         decoding.AddressDecoder,
         label="address",
     )
     registry.register(
-        BaseEquals("bytes", with_sub=True),
+        BaseEquals("bytes", with_sub=True),  # type: ignore[no-untyped-call]
         ExactLengthBytesEncoder,
         decoding.BytesDecoder,
         label="bytes<M>",
     )
     registry.register(
-        BaseEquals("bytes", with_sub=False),
+        BaseEquals("bytes", with_sub=False),  # type: ignore[no-untyped-call]
         StrictByteStringEncoder,
         decoding.ByteStringDecoder,
         label="bytes",
     )
     registry.register(
-        BaseEquals("string"),
+        BaseEquals("string"),  # type: ignore[no-untyped-call]
         encoding.TextStringEncoder,
         decoding.StringDecoder,
         label="string",
@@ -913,7 +746,11 @@ def build_strict_registry() -> ABIRegistry:
 
 
 def named_tree(
-    abi: Iterable[Union[ABIFunctionParams, ABIFunction, ABIEvent, Dict[TypeStr, Any]]],
+    abi: Iterable[
+        Union[
+            ABIComponent, ABIComponentIndexed, ABIFunction, ABIEvent, Dict[TypeStr, Any]
+        ]
+    ],
     data: Iterable[Tuple[Any, ...]],
 ) -> Dict[str, Any]:
     """
@@ -926,10 +763,12 @@ def named_tree(
 
 
 def _named_subtree(
-    abi: Union[ABIFunctionParams, ABIFunction, ABIEvent, Dict[TypeStr, Any]],
+    abi: Union[
+        ABIComponent, ABIComponentIndexed, ABIFunction, ABIEvent, Dict[TypeStr, Any]
+    ],
     data: Tuple[Any, ...],
 ) -> Union[Dict[str, Any], Tuple[Any, ...], List[Any]]:
-    abi_type = parse(collapse_if_tuple(dict(abi)))
+    abi_type = parse(collapse_if_tuple(cast(Dict[str, Any], abi)))
 
     if abi_type.is_array:
         item_type = abi_type.item_type.to_type_str()
@@ -938,7 +777,11 @@ def _named_subtree(
         return items
 
     elif isinstance(abi_type, TupleType):
-        abi = cast(ABIFunctionParams, abi)
+        if abi.get("indexed"):
+            abi = cast(ABIComponentIndexed, abi)
+        else:
+            abi = cast(ABIComponent, abi)
+
         names = [item["name"] for item in abi["components"]]
         items = [_named_subtree(*item) for item in zip(abi["components"], data)]
 

web3/_utils/compat/__init__.py

@@ -12,4 +12,5 @@ from typing_extensions import (
     NotRequired,  # py311
     Self,  # py311
     Unpack,  # py311
+    TypeAlias,  # py310
 )