Enhance documentation in TokenCallbackHandler with ERC-1820 registration details #885
Conversation
This file contains 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
remedcu
approved these changes
Jan 8, 2025
| * @dev Account that wishes to receive the tokens also needs to register the implementer (this contract) via the ERC-1820 interface registry. | ||
| * From the standard: "This is done by calling the setInterfaceImplementer function on the ERC-1820 registry with the holder address as | ||
| * the address, the keccak256 hash of ERC777TokensSender (0x29ddb589b1fb5fc7cf394961c1adf5f8c6454761adf795e67fe149f658abe895) as the | ||
| * interface hash, and the address of the contract implementing the ERC777TokensSender as the implementer." | ||
| * return nothing (not standardized) |
There was a problem hiding this comment.
Suggested change
| * return nothing (not standardized) | |
| * @return nothing (not standardized) |
There was a problem hiding this comment.
My bad, maybe add it as a sentence, as this one seems like the end of the previous line.
There was a problem hiding this comment.
I removed it because it adds no value. We also don't specify empty returns in other contracts' NatSpec.
…ion details This commit adds a detailed comment in the TokenCallbackHandler contract, clarifying the requirement for accounts to register the implementer via the ERC-1820 interface registry to receive ERC777 tokens. This update aims to improve clarity and understanding of the token reception process. No functional changes were made to the contract logic.
mmv08
force-pushed
the
erc777-compat-comments
branch
from
bdf63fa to
137558b
Compare
…777-compat-comments
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds a detailed comment in the TokenCallbackHandler contract, clarifying the requirement for accounts to register the implementer via the ERC-1820 interface registry to receive ERC777 tokens. This update aims to improve clarity and understanding of the token reception process.
No functional changes were made to the contract logic.