Utilities for Contract ABIs #271

reedsa · 2024-04-10T22:29:46Z

What was wrong?

Contract ABI utilities are useful for encoding and decoding contract transactions. Many utilities are implemented in web3.py as private methods.

Related to ethereum/web3.py#3036

These changes will be utilized in web3.py function/event utils:
ethereum/web3.py#3408
ethereum/web3.py#3401

How was it fixed?

Implements a public API for ABI utilities.

Todo:

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

Cute Animal Picture

eth_utils/abi.py

kclowes

I like the new test functions, very nice! I didn't go through with a fine tooth comb, but looks good overall!

The only outstanding things I saw are:

the comment around which exceptions to raise, and where they live
I left a comment about raising vs returning an empty list. let me know what you think!

eth_utils/abi.py

eth_utils/encoding.py

reedsa · 2024-04-12T21:46:24Z

eth_utils/abi.py

+    if function_identifier is None or not is_text(function_identifier):
+        raise TypeError("Unsupported function identifier")
+
+    if abi_codec is None:


I'm not sure where and how to document this feature. Maybe the docstring should point to the codec docs?

That makes sense to me.

pyproject.toml

eth_utils/abi.py

pacrob · 2024-05-01T20:04:26Z

Usage question - I pulled an ABI from web3 (extended_resolver.py), use get_all_function_abis to get function info, then take a name from that, say supportsInterface. From the description, I should be able to plug the abi and the function name into get_function_abi and get the same info back about that function, but I get:

MismatchedABI: 
Could not identify the intended function with name `supportsInterface`, positional arguments with type(s) `` and keyword arguments with type(s) `{}`.
Found 1 function(s) with the name `supportsInterface`: ['supportsInterface(bytes4)']
Function invocation failed due to improper number of arguments.

Same for get_function_info.

reedsa · 2024-05-22T03:36:06Z

This is still a WIP. Keeping the ABI methods but codec utils will move into web3.utils.abi.

* Utility moved to `web3.utils.abi` module * Expose `get_normalized_abi_inputs` and `get_aligned_abi_inputs` * Docs improvements for `get_aligned_abi_inputs`

Doctests added to the following: `collapse_if_tuple` `function_signature_to_4byte_selector` `function_abi_to_4byte_selector` `event_signature_to_log_topic` `event_abi_to_log_topic` `get_normalized_abi_arg_type`

kclowes

I left a couple small comments, but nothing major!

eth_utils/abi.py

kclowes · 2024-05-29T21:45:16Z

eth_utils/abi.py

    """
+    warnings.warn(


I see a warning in the doctests about line 94 where you use collapse_if_tuple

setup.py

Remove unused `_filter_by_encodability` method Remove `_abi_to_signature` and related methods Move `abi_to_signature` with public methods. Doctest for `abi_to_signature` Fix doctest in `collapse_if_tuple`

reedsa · 2024-05-30T17:38:58Z

Cleaning up a few more items on this and I will request reviews when it's good to go!

reedsa commented Apr 10, 2024

View reviewed changes

eth_utils/abi.py Outdated Show resolved Hide resolved

reedsa requested review from pacrob, kclowes and fselmo April 10, 2024 22:31

pacrob reviewed Apr 11, 2024

View reviewed changes

eth_utils/abi.py Outdated Show resolved Hide resolved

reedsa force-pushed the abi-element-utils branch from 0c6d60f to 615e3d4 Compare April 11, 2024 22:29

kclowes reviewed Apr 11, 2024

View reviewed changes

eth_utils/abi.py Outdated Show resolved Hide resolved

eth_utils/abi.py Outdated Show resolved Hide resolved

reedsa force-pushed the abi-element-utils branch from 1d18a64 to 9e2a2da Compare April 12, 2024 16:55

reedsa added a commit to reedsa/eth-utils that referenced this pull request Apr 12, 2024

Newsfragment for ethereum#271

526b63a

reedsa commented Apr 12, 2024

View reviewed changes

eth_utils/encoding.py Show resolved Hide resolved

reedsa commented Apr 12, 2024

View reviewed changes

reedsa added a commit to reedsa/eth-utils that referenced this pull request Apr 15, 2024

Newsfragment for ethereum#271

b76e640

reedsa force-pushed the abi-element-utils branch from 8d65e46 to b76e640 Compare April 15, 2024 20:59

reedsa added a commit to reedsa/eth-utils that referenced this pull request Apr 17, 2024

Newsfragment for ethereum#271

6e44918

reedsa force-pushed the abi-element-utils branch from 03fe5b4 to 6e44918 Compare April 17, 2024 23:31

reedsa mentioned this pull request Apr 18, 2024

ABI types improvements ethereum/eth-typing#62

Merged

3 tasks

reedsa added a commit to reedsa/eth-utils that referenced this pull request Apr 18, 2024

Newsfragment for ethereum#271

4b6df2c

reedsa force-pushed the abi-element-utils branch from 6e44918 to 4b6df2c Compare April 18, 2024 19:28

reedsa added a commit to reedsa/eth-utils that referenced this pull request Apr 22, 2024

Newsfragment for ethereum#271

60f4477

reedsa force-pushed the abi-element-utils branch from 1599e85 to 761d1c8 Compare April 22, 2024 19:22

reedsa marked this pull request as ready for review April 26, 2024 20:49

reedsa requested review from pacrob and kclowes April 26, 2024 21:12

reedsa added a commit to reedsa/eth-utils that referenced this pull request Apr 29, 2024

Newsfragment for ethereum#271

86cface

reedsa force-pushed the abi-element-utils branch 2 times, most recently from adfc679 to 854a6a5 Compare April 29, 2024 18:00

pacrob reviewed May 1, 2024

View reviewed changes

pyproject.toml Show resolved Hide resolved

pacrob reviewed May 1, 2024

View reviewed changes

eth_utils/abi.py Outdated Show resolved Hide resolved

pacrob reviewed May 1, 2024

View reviewed changes

eth_utils/abi.py Outdated Show resolved Hide resolved

reedsa force-pushed the abi-element-utils branch from 38c36eb to 91c5457 Compare May 22, 2024 19:59

Move get_function_info

462e983

* Utility moved to `web3.utils.abi` module * Expose `get_normalized_abi_inputs` and `get_aligned_abi_inputs` * Docs improvements for `get_aligned_abi_inputs`

reedsa force-pushed the abi-element-utils branch from 91c5457 to 6cad12c Compare May 22, 2024 20:14

Copy tests from web3._utils.abi.merge_args_and_kwargs

8b27c40

reedsa force-pushed the abi-element-utils branch from 6cad12c to 8b27c40 Compare May 22, 2024 20:23

reedsa added 2 commits May 22, 2024 14:42

Add tests for get_aligned_abi_inputs

6cce41f

Add doctests to docstrings from original ABI docs.

f1dbce9

Doctests added to the following: `collapse_if_tuple` `function_signature_to_4byte_selector` `function_abi_to_4byte_selector` `event_signature_to_log_topic` `event_abi_to_log_topic` `get_normalized_abi_arg_type`

reedsa force-pushed the abi-element-utils branch from c26f038 to f1dbce9 Compare May 23, 2024 21:25

kclowes reviewed May 29, 2024

View reviewed changes

reedsa force-pushed the abi-element-utils branch from 483c7b9 to 50ad789 Compare May 30, 2024 15:55

Move get_function_abi to web3.utils.abi

32d386f

Remove unused `_filter_by_encodability` method Remove `_abi_to_signature` and related methods Move `abi_to_signature` with public methods. Doctest for `abi_to_signature` Fix doctest in `collapse_if_tuple`

reedsa force-pushed the abi-element-utils branch from bbb9ad2 to 32d386f Compare May 30, 2024 17:07

reedsa removed the request for review from fselmo May 30, 2024 17:39

reedsa force-pushed the abi-element-utils branch from b088418 to ad129b5 Compare May 30, 2024 18:40

reedsa added 3 commits May 30, 2024 12:42

Fix imports for get_aligned_abi_inputs and get_normalized_abi_inputs

02a7fe8

Doctests and cleanup for all public ABI utilities.

bf613c0

Refactor test helpers

e3c655e

reedsa force-pushed the abi-element-utils branch from ad129b5 to e3c655e Compare May 30, 2024 18:43

Remove eth-abi dependency

9d7b3de

reedsa requested review from fselmo, kclowes and pacrob May 30, 2024 19:02

Pin eth-typing >= 4.0.0

604dc29

This was referenced May 30, 2024

Encode ABI Utility ethereum/web3.py#3361

Open

Function ABI Utilities ethereum/web3.py#3408

Open

Event ABI Utilities ethereum/web3.py#3401

Draft

reedsa added 2 commits June 3, 2024 12:33

Pin to latest eth-typing

dc7c350

Move get_event_data to web3.

378bdc3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Utilities for Contract ABIs #271

Utilities for Contract ABIs #271

reedsa commented Apr 10, 2024 •

edited

kclowes left a comment

reedsa Apr 12, 2024

pacrob May 1, 2024

pacrob commented May 1, 2024 •

edited

reedsa commented May 22, 2024

kclowes left a comment

kclowes May 29, 2024

reedsa commented May 30, 2024

Utilities for Contract ABIs #271

Are you sure you want to change the base?

Utilities for Contract ABIs #271

Conversation

reedsa commented Apr 10, 2024 • edited

What was wrong?

How was it fixed?

Todo:

Cute Animal Picture

kclowes left a comment

Choose a reason for hiding this comment

reedsa Apr 12, 2024

Choose a reason for hiding this comment

pacrob May 1, 2024

Choose a reason for hiding this comment

pacrob commented May 1, 2024 • edited

reedsa commented May 22, 2024

kclowes left a comment

Choose a reason for hiding this comment

kclowes May 29, 2024

Choose a reason for hiding this comment

reedsa commented May 30, 2024

reedsa commented Apr 10, 2024 •

edited

pacrob commented May 1, 2024 •

edited