Newsfragments for #3408

Author: Stuart Reed

newsfragments/3408.breaking.rst

@@ -0,0 +1,5 @@
+Upgrades to use latest ``ABI`` utilities and typings from ``eth-utils`` and ``eth-typing``.
+* New ``ABI`` functions from ``eth-utils`` are now included in the ``web3.utils.abi`` module.
+* Typings for ``ABI`` components are now available in the ``eth-typing`` package. ``ABI`` types previously in ``web3.types`` have been removed.
+* ABI exceptions have been renamed in ``web3.exceptions``. The ``ABIEventFunctionNotFound`` and ``FallbackNotFound`` exceptions have been removed. Use ``ABIEventNotFound`` and ``ABIFallbackNotFound`` instead.
+* ``MismatchedABI`` exceptions are raised instead of a ``Web3ValidationError`` for ABI related errors.

newsfragments/3408.docs.rst

@@ -0,0 +1 @@
+Use autodoc and update ABI functions with docstrings and doctests.

newsfragments/3408.feature.rst

@@ -0,0 +1,10 @@
+Utilities to extract function and event ``ABI`` attributes from a contract. Utilities in the ``web3.utils.abi`` module parse ABI elements and check encodability of provided arguments. ABI functions in ``eth-utils`` are exposed by the ``web3.utils.abi`` module.
+* ``get_abi_element_info`` returns an ``ABIElementInfo`` TypedDict with the ``abi``, ``selector``, and ``arguments``.
+* ``get_abi_element`` returns the ``ABI`` of a function, event, or error given the name and arguments.
+* ``get_constructor_function_abi`` returns the constructor function as an ``ABIConstructor`` type.
+* ``get_receive_function_abi`` returns the receive function as an ``ABIReceive`` type.
+* ``get_fallback_function_abi`` returns the fallback function as an ``ABIFallback`` type.
+* ``check_if_arguments_can_be_encoded`` returns true if the arguments can be encoded with the given ABI.
+* ``get_event_abi`` returns the ``ABI`` of an event given the name.
+* ``get_event_log_topics`` returns the log topics of an event given the name.
+* ``log_topics_to_bytes`` returns the log topics as bytes.

newsfragments/3408.misc.rst

@@ -0,0 +1 @@
+Move ``get_abi_input_names`` and ``get_abi_output_names`` to ``eth-utils`` and re-export in ``web3.utils.abi``.