Encode ABI Utility #3361

reedsa · 2024-04-24T19:37:26Z

What was wrong?

Related to Issue #3279

Dependent PRs:
web3.py: #3408, #3401

eth-utils: ethereum/eth-utils#271

How was it fixed?

Exposes encode_abi ABI utility.

Todo:

Clean up commit history
Add or update documentation related to these changes
Add entry to the release notes

Cute Animal Picture

* Use ABI types from `eth_typing` * Fix reference to `ABIEventParam` and `ABIFunctionParam` types * Import `get_abi_input_types` and `get_abi_output_types` from `eth-utils` * Rename `collapse_if_tuple` -> `get_normalized_abi_arg_type` * Import `get_abi_input_names` and `get_abi_output_names` from `eth_utils`

fselmo

It looks like this needs rebasing and some conflict resolution but my review was requested so I left a first pass of comments. I think we can remove the need for is_async altogether from the utility method and pass in appropriate normalizers for each code block instead. I also don't think this is up to date with the latest eth-typing changes so I made some comments on using ABIComponent and ABICallable where appropriate. I may have missed some but in general it looks like this needs to be updated to match the current state of things there.

fselmo · 2024-05-28T19:06:46Z

web3/utils/__init__.py

@@ -17,3 +16,43 @@
 from .exception_handling import (  # NOQA
    handle_offchain_lookup,
 )
+
+# from eth_utils import (  # NOQA


This needs to be addressed. Are we waiting on anything here?

fselmo · 2024-06-17T17:53:11Z

web3/utils/abi.py

+
+
+def encode_abi(
+    function_abi: Union[ABIFunction, ABIConstructor, ABIFallback, ABIReceive],


This should use the new ABICallable, right?

fselmo · 2024-06-17T18:01:36Z

web3/utils/abi.py

-    if "inputs" not in abi and abi["type"] == "fallback":
-        return []
-    return [arg["name"] for arg in abi["inputs"]]
+    normalizers = [


Can we just have one set of normalizers, instead of data_normalizers and normalizers? We can probably take out the is_async from this utility method and just be able to pass in the data normalizers. I think that feature let's us achieve everything we want. From within the code block, the sync code can pass in all the normalizers it needs and the async code can do the same.

fselmo · 2024-06-17T18:03:21Z

web3/utils/abi.py

+    :param type: `HexStr`
+    :param arguments: Arguments used for the transaction request.
+    :param type: `Any`
+    :param is_async: Enable async transaction encoder.


Probably remove this if we go with my thought below.

fselmo · 2024-06-17T18:03:45Z

web3/utils/abi.py

+    :param data_normalizers: List of custom normalizers to apply to the data.
+    :param type: `list[Callable[..., Tuple[TypeStr, Any]]]`
+    :param abi_codec: Codec used for encoding and decoding.
+    :param type: `ABICodec`


Suggested change

:param type: `ABICodec`

:param type: `ABICodec` (optional)

fselmo · 2024-06-17T18:07:33Z

web3/_utils/contracts.py

-        abi_bytes_to_bytes,
-        abi_string_to_text,
-    ]
-    if not w3.eth.is_async:


See my comment about removing the is_async from the utility method. I think we can just build the appropriate normalizers here in the code block instead of trying to use an is_async flag for a general public utility method that's trying to encode abi. We can build the right normalizers for each code block and pass it in instead, one appropriate for the sync code block and another that is appropriate for the async code.

fselmo · 2024-06-17T18:07:55Z

web3/_utils/abi.py

@@ -913,7 +889,7 @@ def build_strict_registry() -> ABIRegistry:


 def named_tree(
-    abi: Iterable[Union[ABIFunctionParams, ABIFunction, ABIEvent, Dict[TypeStr, Any]]],
+    abi: Iterable[Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]]],


Suggested change

abi: Iterable[Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]]],

abi: Iterable[Union[ABIComponent, ABIFunction, ABIEvent, Dict[TypeStr, Any]]],

fselmo · 2024-06-17T18:09:49Z

web3/_utils/abi.py

@@ -926,10 +902,10 @@ def named_tree(


 def _named_subtree(
-    abi: Union[ABIFunctionParams, ABIFunction, ABIEvent, Dict[TypeStr, Any]],
+    abi: Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]],


Suggested change

abi: Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]],

abi: Union[ABIComponent, ABIFunction, ABIEvent, Dict[TypeStr, Any]],

fselmo · 2024-06-17T18:10:08Z

web3/_utils/abi.py

    return [arg for arg in event_abi["inputs"] if arg["indexed"] is True]


-def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParams]:
+def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]:


Suggested change

def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]:

def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIComponent]:

fselmo · 2024-06-17T18:10:20Z

web3/_utils/abi.py

@@ -155,24 +139,14 @@ def receive_func_abi_exists(contract_abi: ABI) -> List[Union[ABIFunction, ABIEve
    return filter_by_type("receive", contract_abi)


-def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParams]:
+def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]:


Suggested change

def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]:

def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIComponent]:

reedsa force-pushed the abi-encode-util branch 5 times, most recently from 95af2f5 to 3f5a4aa Compare April 25, 2024 23:50

reedsa added a commit to reedsa/web3.py that referenced this pull request Apr 26, 2024

Newsfragment for ethereum#3361

6760256

reedsa force-pushed the abi-encode-util branch from 3f5a4aa to 6760256 Compare April 26, 2024 20:25

reedsa added 11 commits May 16, 2024 12:42

Pass in ens_resolver normalizer

ac1a397

Fixes from merge with v7 branch

047aa5d

Pin deps

c43ccbb

Use encode_abi public utility.

d43d4d6

encode_abi takes normalizers as arguments

5d618cb

Pass codec from contract class

ce69252

Use ens_resolver normalizer

0e2fd3a

Pass is_async

8e349e2

Newsfragment for ethereum#3361

fbc58a8

Pin to latest eth-typing

9c87e06

reedsa force-pushed the abi-encode-util branch from d4e78a5 to 9c87e06 Compare May 16, 2024 18:42

Fix lint

0b6e19b

reedsa marked this pull request as ready for review May 16, 2024 19:05

reedsa requested review from fselmo, pacrob and kclowes May 16, 2024 19:05

fselmo reviewed Jun 17, 2024

View reviewed changes

reedsa removed request for pacrob and kclowes June 17, 2024 19:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Encode ABI Utility #3361

Encode ABI Utility #3361

reedsa commented Apr 24, 2024 •

edited

Loading

fselmo left a comment •

edited

Loading

fselmo May 28, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024

fselmo Jun 17, 2024



		def encode_abi(
		function_abi: Union[ABIFunction, ABIConstructor, ABIFallback, ABIReceive],

	abi: Iterable[Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]]],
	abi: Iterable[Union[ABIComponent, ABIFunction, ABIEvent, Dict[TypeStr, Any]]],

	abi: Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]],
	abi: Union[ABIComponent, ABIFunction, ABIEvent, Dict[TypeStr, Any]],

	def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]:
	def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIComponent]:

	def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]:
	def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIComponent]:

Encode ABI Utility #3361

Are you sure you want to change the base?

Encode ABI Utility #3361

Conversation

reedsa commented Apr 24, 2024 • edited Loading

What was wrong?

How was it fixed?

Todo:

Cute Animal Picture

fselmo left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reedsa commented Apr 24, 2024 •

edited

Loading

fselmo left a comment •

edited

Loading