improve(cross-chain-oracle): Clarify comments for refundL2Address#3687
Merged
chrismaree merged 3 commits intomasterfrom Dec 14, 2021
Merged
improve(cross-chain-oracle): Clarify comments for refundL2Address#3687chrismaree merged 3 commits intomasterfrom
chrismaree merged 3 commits intomasterfrom
Conversation
chrismaree
approved these changes
Dec 13, 2021
mrice32
reviewed
Dec 13, 2021
| * @dev The caller of this function must be the owner. This should be set to the DVM governor. | ||
| * @param newRefundl2Address the new refund address to set. | ||
| * @dev The caller of this function must be the owner, which should be set to the DVM governor. | ||
| * @param newRefundl2Address the new refund address to set. This should be set to an L2 address that is trusted by |
Member
There was a problem hiding this comment.
When we say trusted, what do we mean? This address just gets the excess funds? Or does it have more control than that?
Member
There was a problem hiding this comment.
that's right. it can get the excess funds on L2.
Member
There was a problem hiding this comment.
I updated this comment to be a bit more clear.
Signed-off-by: chrismaree <christopher.maree@gmail.com>
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
3 participants
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.
Motivation
Comments are misleading about what the
refundL2Addressshould be set to. Clarifies that address should be set to an EOA or contract that can spend the funds.Testing
Check a box to describe how you tested these changes and list the steps for reviewers to test.