Encode ABI Utility #3361
Encode ABI Utility #3361
Conversation
reedsa
force-pushed
the
abi-encode-util
branch
5 times, most recently
from
95af2f5 to
3f5a4aa
Compare
* 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`
There was a problem hiding this comment.
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.
| handle_offchain_lookup, | ||
| ) | ||
|
|
||
| # from eth_utils import ( # NOQA |
There was a problem hiding this comment.
This needs to be addressed. Are we waiting on anything here?
|
|
||
|
|
||
| def encode_abi( | ||
| function_abi: Union[ABIFunction, ABIConstructor, ABIFallback, ABIReceive], |
There was a problem hiding this comment.
This should use the new ABICallable, right?
| if "inputs" not in abi and abi["type"] == "fallback": | ||
| return [] | ||
| return [arg["name"] for arg in abi["inputs"]] | ||
| normalizers = [ |
There was a problem hiding this comment.
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.
| :param type: `HexStr` | ||
| :param arguments: Arguments used for the transaction request. | ||
| :param type: `Any` | ||
| :param is_async: Enable async transaction encoder. |
There was a problem hiding this comment.
Probably remove this if we go with my thought below.
| :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` |
There was a problem hiding this comment.
| :param type: `ABICodec` | |
| :param type: `ABICodec` (optional) |
| abi_bytes_to_bytes, | ||
| abi_string_to_text, | ||
| ] | ||
| if not w3.eth.is_async: |
There was a problem hiding this comment.
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.
|
|
||
| def named_tree( | ||
| abi: Iterable[Union[ABIFunctionParams, ABIFunction, ABIEvent, Dict[TypeStr, Any]]], | ||
| abi: Iterable[Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]]], |
There was a problem hiding this comment.
| abi: Iterable[Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]]], | |
| abi: Iterable[Union[ABIComponent, ABIFunction, ABIEvent, Dict[TypeStr, Any]]], |
|
|
||
| def _named_subtree( | ||
| abi: Union[ABIFunctionParams, ABIFunction, ABIEvent, Dict[TypeStr, Any]], | ||
| abi: Union[ABIFunctionParam, ABIFunction, ABIEvent, Dict[TypeStr, Any]], |
There was a problem hiding this comment.
| 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[ABIEventParams]: | ||
| def exclude_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]: |
There was a problem hiding this comment.
| 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[ABIEventParams]: | ||
| def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]: |
There was a problem hiding this comment.
| def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIEventParam]: | |
| def get_indexed_event_inputs(event_abi: ABIEvent) -> List[ABIComponent]: |
2 participants
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_abiABI utility.Todo:
Cute Animal Picture