fix(docs): correct contract event filter example #4990
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
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.
Description
This PR fixes a documentation error in the getting-started.wrm file where the example for filtering Transfer events was inconsistent with its comment.
The comment states "Listen for any Transfer to 'ethers.eth'", but the code example was incorrectly using
contract.filters.Transfer("ethers.eth"), which actually filters for transfers FROM ethers.eth, not TO it.Changes
contract.filters.Transfer(null, "ethers.eth")which correctly filters for transfers TO ethers.ethFixes
Fixes #4984
Note
This PR addresses only the filter parameter inconsistency. The issue also mentions ContractEventPayload callbacks, which is a valid feature in v6 but not addressed in this particular PR since it would require more extensive documentation changes.