-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use NatSpec for ITokenBridge events and errors #202
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #202 +/- ##
=========================================
Coverage 70.69% 70.69%
Complexity 1059 1059
=========================================
Files 291 291
Lines 11972 11972
Branches 1106 1106
=========================================
Hits 8464 8464
Misses 3031 3031
Partials 477 477
|
event RemoteTokenBridgeSet(address indexed remoteTokenBridge, address indexed setBy); | ||
|
||
/** | ||
* @notice Emitted when the a token is set as deployed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "the"
event TokenDeployed(address indexed token); | ||
|
||
/** | ||
* @notice Emitted when the a token deployment is confirmed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "the"
event DeploymentConfirmed(address[] tokens, address indexed confirmedBy); | ||
|
||
/** | ||
* @notice Emitted when the a message service address is set. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "a"
event MessageServiceUpdated( | ||
address indexed newMessageService, | ||
address indexed oldMessageService, | ||
address indexed setBy | ||
); | ||
|
||
/** | ||
* @dev Thrown when the attempting to bridge a reserved token. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "the"
error RemoteTokenBridgeAlreadySet(address remoteTokenBridge); | ||
|
||
/** | ||
* @dev Thrown when the attempting to reserve an already bridged token. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "the"
error NativeToBridgedTokenAlreadySet(address token); | ||
|
||
/** | ||
* @dev Thrown when trying to set a token is already either native, deployed or reserved. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Thrown when trying to set a token that is already"
This PR implements issue(s) #
Checklist