Update(GaugeController.sol): Add NatSpec and Comments #273
Conversation
|
|
||
| /** | ||
| * @notice Tracks user rewards for staking. | ||
| * @dev The rewards is updated in |
There was a problem hiding this comment.
Add functions in which the rewards are updated.
There was a problem hiding this comment.
There are no functions at the moment which update rewards
| @@ -33,16 +79,43 @@ contract GaugeController is IGaugeController { | |||
| rewardVault = _rewardVault; | |||
| } | |||
|
|
|||
| modifier requireGauge(address _gauge) { | |||
contracts/GaugeController.sol
Outdated
| @@ -33,16 +79,43 @@ contract GaugeController is IGaugeController { | |||
| rewardVault = _rewardVault; | |||
There was a problem hiding this comment.
Add requires to check for address zero.
There was a problem hiding this comment.
Agree. Out of scope for natspec PR though.
| @@ -33,16 +79,43 @@ contract GaugeController is IGaugeController { | |||
| rewardVault = _rewardVault; | |||
| } | |||
|
|
|||
| modifier requireGauge(address _gauge) { | |||
| require(isGauge(_gauge), "GaugeController:invalid-address"); | |||
There was a problem hiding this comment.
We should also create an internal function _isGauge to call in this modifier to avoid calling a public function.
There was a problem hiding this comment.
Agree. Out of scope for natspec PR though.
Co-authored-by: Pierrick Turelier <pierrick@turelier.com>
Co-authored-by: Pierrick Turelier <pierrick@turelier.com>
Co-authored-by: Pierrick Turelier <pierrick@turelier.com>
Co-authored-by: Pierrick Turelier <pierrick@turelier.com>
| IGaugeReward _gaugeReward, | ||
| address _owner | ||
| ) Ownable(_owner){ | ||
| require(address(_token) != address(0), "GC/token-not-zero-address"); |
There was a problem hiding this comment.
Add the same kind of require for _gaugeReward.
| */ | ||
| interface IGaugeReward { | ||
| /** | ||
| * @notice Fallback function to call in GaugeController after a user has increased their gauge stake. |
There was a problem hiding this comment.
I described it as being a callback function and not a fallback function since it's being called after increasing the gauge and not in replacement of the function to increase gauge but it's not a callback function either, so we could just say:
Called in GaugeController after a user has increased their gauge stake.
No description provided.