Initialize contracts having function or event overrides #3476
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
reedsa
force-pushed
the
get-event-abi-ambiguity
branch
4 times, most recently
from
bdc2282 to
4b2adad
Compare
reedsa
added a commit
to reedsa/web3.py
that referenced
this pull request
Sep 5, 2024
kclowes
approved these changes
Sep 6, 2024
This was referenced Sep 6, 2024
|
The ambiguity with functions is also an issue unfortunately. Taking a look at how to disambiguate since right now it uses the "first" one. |
reedsa
added a commit
to reedsa/web3.py
that referenced
this pull request
Sep 10, 2024
reedsa
force-pushed
the
get-event-abi-ambiguity
branch
2 times, most recently
from
7b15976 to
4354b1a
Compare
reedsa
changed the title
pacrob
reviewed
Sep 12, 2024
pacrob
reviewed
Sep 12, 2024
pacrob
reviewed
Sep 12, 2024
pacrob
reviewed
Sep 12, 2024
__getattr__ now uses the ABI to look up the function class by signature Additional fixes for ens
Refactoring and docs update for ``get_abi_element`` and ``_build_filters`` Rename ``get_abi_element_identifier`` -> ``get_abi_element_signature``
…ith_name`` Further cleanup and refactoring
Fix contract compilation and naming
Remove docs from events iter Fix docstring formatting
reedsa
force-pushed
the
get-event-abi-ambiguity
branch
from
1b05ab8 to
e1d16e5
Compare
reedsa
force-pushed
the
get-event-abi-ambiguity
branch
from
054b8e5 to
233fa23
Compare
pacrob
reviewed
Sep 13, 2024
pacrob
reviewed
Sep 13, 2024
pacrob
reviewed
Sep 13, 2024
kclowes
reviewed
Sep 13, 2024
Filter by type prior to getting an ABI element
kclowes
approved these changes
Sep 18, 2024
There was a problem hiding this comment.
LGTM! Since this is such a core component of our library, it's probably worth some manual testing to make sure old functionality still works as expected. I did some myself and have fairly high confidence in the tests, but it's probably worth one more run through!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was wrong?
Closes #1704, #3482
The
Contractclass cannot initialize if the contract contains overloaded functions or events. Currently only the function/event name is used to filter ABI events from the contract ABI, so an exception is raised. Currently, events raise a ValueError when_get_event_abiis called on the Contract or ContractEvent class. Functions raise a MismatchedABI error.Example:
BaseContractEvent._get_event_abi()calls eth-utilsget_event_abi()and expects to return the ABI for the event class. The event classes are not created for every overloaded function. When there are contract events with the same name, only one is ever created and used.How was it fixed?
Initialize the
ContractFunctionsorContractEventsclass with every ABI found in the contract, storing the abi signature in the class name. Along with the signature, theabiproperty is set for each class within the__init__method. This ensures the correct instance is found and used for subsequent functions likeget_logs().get_abi_elementnow handles both functions and events using the ABI signature to find a unique ABI. The signature is represented by a string that includes it's name and list of input types within parentheses.name(arg1Type,arg2Type,...)Exceptions are now shared between functions and events for consistency.
Todo:
Cute Animal Picture