Parse tuple arguments from event #2211

cc7768 · 2021-11-19T06:13:02Z

What was wrong?

Events that have tuple-valued arguments are currently unable to be parsed.

Related to Issue #1629

How was it fixed?

I used the proposed fix from #1484

I'm struggling a little on incorporating the new test... I think I'm close but haven't quite had it come together yet.

I've done the following:

Modified tests/core/contracts/contract_sources/Emitter.sol
- Added a new struct (TestTuple)
- Created a new event (LogStructArgs) that uses TestTuple as an argument
- Created a new function (logStruct) that emits the LogStructArgs event
Used this contract to update web3/_utils/module_testing/emitter_contract.py
- Updated the ABI
- Tried updating the CONTRACT_EMITTER_CODE and CONTRACT_EMITTER_RUNTIME but I ran into errors because I haven't done this before. What's the easiest way to generate these?
Modified web3/tests/core/contracts/conftest.py
- Added LogStructArgs to the LogFunctions class
- Added LogStructArgs to the LogTopics class
Updated the parameterizations in tests/core/contracts/test_extracting_event_data.py
- Added parameterization for test_event_data_extraction
- Added two parameterizations for test_event_rich_log~

Sorry for the lengthy read. I think it's close but I just need a little push to get it across the finish line.

@fselmo, picking up here:
Added a bit more to this PR, thanks @cc7768 for getting this started!

- Added a NestedTestTuple struct inside the TestTuple juuuuuust to be sure
- Added a test for the added event and function that was failing
- Added collapse_if_tuple() in a few more places that were missing, from the test I added, until it passed
- Separated the emitter contract into a version compiled with a newer solidity version (0.8.11) and the original one (compiled with 0.4.21) since the strict bytes check does not seem to work with solidity versions 0.5.0 and above. Created an issue here to track that.

Todo:

~~The main TODO item left is to add tests -- The lack of tests is why #1484 was never merged.~~

The only function that is changed is get_event_abi_types_for_decoding from web3/_utils/events.py. This function itself is only called by get_event_data from web3/_utils/events.py. The get_event_data function is only tested in tests/core/contracts/test_extracting_event_data.py so the TODO items, as far as I can tell, should be:

- [x] Ensure old tests continue to work with the update
- [x] Add new test case that incorporates having tuple arguments to an event
- [x] Add entry to the release notes

Cute Animal Picture

kclowes · 2021-11-19T16:45:34Z

Thanks @cc7768! I will take a look!

lachgil · 2021-11-24T09:34:29Z

I have tried implementing the fix and still seeing issues

File "/usr/local/lib/python3.9/dist-packages/brownie/_cli/run.py", line 50, in main
return_value, frame = run(
File "/usr/local/lib/python3.9/dist-packages/brownie/project/scripts.py", line 103, in run
return_value = f_locals[method_name](*args, **kwargs)
File "./marketwatch.py", line 43, in main
event_printer(message_filter)
File "./marketwatch.py", line 32, in event_printer
for message in message_filter.get_new_entries():
File "/usr/local/lib/python3.9/dist-packages/web3/_utils/filters.py", line 161, in get_new_entries
return self._format_log_entries(log_entries)
File "/usr/local/lib/python3.9/dist-packages/web3/_utils/filters.py", line 172, in _format_log_entries
formatted_log_entries = [
File "/usr/local/lib/python3.9/dist-packages/web3/_utils/filters.py", line 172, in
formatted_log_entries = [
File "/usr/local/lib/python3.9/dist-packages/web3/_utils/filters.py", line 220, in is_valid_entry
return bool(self.data_filter_set_function(entry['data']))
File "cytoolz/functoolz.pyx", line 250, in cytoolz.functoolz.curry.call
File "/usr/local/lib/python3.9/dist-packages/web3/_utils/filters.py", line 255, in match_fn
decoded_values = codec.decode_abi(abi_types, HexBytes(data))
File "/usr/local/lib/python3.9/dist-packages/eth_abi/codec.py", line 173, in decode_abi
decoders = [
File "/usr/local/lib/python3.9/dist-packages/eth_abi/codec.py", line 174, in
self._registry.get_decoder(type_str)
File "/usr/local/lib/python3.9/dist-packages/eth_abi/registry.py", line 469, in get_decoder
return self._get_registration(self._decoders, type_str)
File "/usr/local/lib/python3.9/dist-packages/eth_abi/registry.py", line 354, in _get_registration
coder = super()._get_registration(mapping, type_str)
File "/usr/local/lib/python3.9/dist-packages/eth_abi/registry.py", line 336, in _get_registration
value = mapping.find(type_str)
File "/usr/local/lib/python3.9/dist-packages/eth_abi/registry.py", line 89, in find
raise NoEntriesFound("No matching entries for '{}' in {}".format(
NoEntriesFound: No matching entries for 'tuple' in decoder registry

tests/core/contracts/test_extracting_event_data.py

web3/_utils/filters.py

- Nested tuples seemed to be broken when parsing event filters. This commit piggy backs off previous work and uses the collapse_if_tuple() method in the _build_argument_filters_from_even_abi() method. From testing, this seemes to have been a missing piece to get these issues resolved and the added test passing. - Remove testing nested tuple method from tests that require the test id enum. These were added in the previous commit. Instead, add a test specific to testing the new method / event for tuples. - Add testing for the new nested tuple function + event in the emitter contract. - closes 1629 - closes 2298

`enable_strict_bytes_type_checking()` appears to be broken with solidity versions `0.5.0` and above. This commit separates a new emitter contract, compiled with solidity `0.8.11`, and the older emitter contract, compiled with solidity `0.4.21`. This way, we can update the tests using the `emitter` pytest modules while the strict bytes test can use the old emitter contract until we can update `enable_strict_bytes_type_checking()` to be compatible with newer solidity versions.

kclowes

Looks good to me. Thank you for getting this one over the line. I think there is at least one other issue we can close with this one! Left a few comments, but nothing blocking.

tests/core/contracts/test_extracting_event_data.py

web3/_utils/events.py

cc7768 · 2022-01-14T02:35:45Z

Thank you @fselmo for getting this across the finish line! I hope I didn't leave you more work than if you had started from scratch 😅

I see that you're based in CO -- Let me know if you're around during ETH Denver so I can treat you to a beer or a coffee!

fselmo · 2022-01-14T06:12:09Z

Thank you @fselmo for getting this across the finish line! I hope I didn't leave you more work than if you had started from scratch 😅

Not at all, thanks for getting the ball rolling on this. Yep, the plan is to go to ETH Denver 🤞🏼

Th0rgal · 2022-01-14T11:07:53Z

Thanks for merging!

Th0rgal mentioned this pull request Jan 10, 2022

eth_abi.exceptions.NoEntriesFound: No matching entries for 'tuple' in decoder registry #2298

Closed

fselmo force-pushed the tuple_args branch from 9b8df08 to 87b7159 Compare January 12, 2022 23:38

Implement fix proposed in ethereum#1484

b47e2a5

fselmo force-pushed the tuple_args branch 3 times, most recently from 437b45c to bf9f60b Compare January 13, 2022 00:35

fselmo mentioned this pull request Jan 13, 2022

enable_strict_bytes_type_checking() broken with solidty>=0.5.0 #2301

Closed

fselmo force-pushed the tuple_args branch 3 times, most recently from c499b3e to a57f532 Compare January 13, 2022 19:05

fselmo changed the title ~~WIP: Parse tuple arguments from event~~ Parse tuple arguments from event Jan 13, 2022

fselmo requested review from kclowes, carver, pacrob and wolovim January 13, 2022 19:16

fselmo reviewed Jan 13, 2022

View reviewed changes

tests/core/contracts/test_extracting_event_data.py Show resolved Hide resolved

fselmo reviewed Jan 13, 2022

View reviewed changes

web3/_utils/filters.py Show resolved Hide resolved

fselmo added 2 commits January 13, 2022 12:41

fselmo force-pushed the tuple_args branch from a57f532 to 693592b Compare January 13, 2022 19:41

kclowes approved these changes Jan 13, 2022

View reviewed changes

tests/core/contracts/test_extracting_event_data.py Show resolved Hide resolved

web3/_utils/events.py Outdated Show resolved Hide resolved

Abstract collapsing tuple abi arg types

987219d

fselmo force-pushed the tuple_args branch from efaf13a to 987219d Compare January 13, 2022 21:54

fselmo merged commit c3d4254 into ethereum:master Jan 13, 2022

This was referenced Jan 13, 2022

Add tuple decoder for events #1484

Closed

Can not parse event with tuple arguments #1629

Closed

fselmo mentioned this pull request Jan 21, 2022

ABIv2 tuple encoding is not supported #1065

Closed

charles-cooper mentioned this pull request Feb 8, 2022

fix ABI for events which contain structs vyperlang/vyper#2508

Merged

Zaptrouiyerxi mentioned this pull request Oct 18, 2022

eth_abi.exceptions.NoEntriesFound: No matching entries for 'tuple' in decoder registry kigawas/web3-input-decoder#83

Closed

sarinniural mentioned this pull request Jan 26, 2023

Error parsing function that takes input as a struct. kigawas/web3-input-decoder#102

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Parse tuple arguments from event #2211

Parse tuple arguments from event #2211

cc7768 commented Nov 19, 2021 •

edited by fselmo

Loading

kclowes commented Nov 19, 2021

lachgil commented Nov 24, 2021

kclowes left a comment

cc7768 commented Jan 14, 2022

fselmo commented Jan 14, 2022

Th0rgal commented Jan 14, 2022

Parse tuple arguments from event #2211

Parse tuple arguments from event #2211

Conversation

cc7768 commented Nov 19, 2021 • edited by fselmo Loading

What was wrong?

How was it fixed?

Todo:

Cute Animal Picture

kclowes commented Nov 19, 2021

lachgil commented Nov 24, 2021

kclowes left a comment

Choose a reason for hiding this comment

cc7768 commented Jan 14, 2022

fselmo commented Jan 14, 2022

Th0rgal commented Jan 14, 2022

cc7768 commented Nov 19, 2021 •

edited by fselmo

Loading