You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* @param _duration Duration of the staking in days
The explanation for duration is incorrect. We added isActive for a reason, which is that duration does not suffice to compute the "duration for staking". Can we please provide a correct explanation for how duration is used?
The entire rewardDistribution nomenclature seems to make no sense. First, it is not a distribution, it is an account. Second, its use has nothing to do with who gets rewarded nor how rewards are distributed. It is only used to identify an account that can invoke a couple of functions. Wouldn't it make more sense to call this something like controller or admin?
Having said 3), it is super unclear what notifyRewardAmount does. It is external, presumably meant to be invoked by rewardDistribution. Can we document this function?
The text was updated successfully, but these errors were encountered:
arseneeth
changed the title
stakingReward documentation/naming issues
FIx: stakingReward documentation/naming issues
Apr 9, 2021
contracts/contracts/incentives/StakingRewards.sol
Line 54 in 6b58c0d
The explanation for
duration
is incorrect. We addedisActive
for a reason, which is thatduration
does not suffice to compute the "duration for staking". Can we please provide a correct explanation for how duration is used?contracts/contracts/incentives/StakingRewards.sol
Line 55 in 6b58c0d
Must the
_avatar
be an avatar? If not, can we rename this? See the following 3):contracts/contracts/incentives/StakingRewards.sol
Line 79 in 6b58c0d
The entire
rewardDistribution
nomenclature seems to make no sense. First, it is not a distribution, it is an account. Second, its use has nothing to do with who gets rewarded nor how rewards are distributed. It is only used to identify an account that can invoke a couple of functions. Wouldn't it make more sense to call this something likecontroller
oradmin
?notifyRewardAmount
does. It is external, presumably meant to be invoked byrewardDistribution
. Can we document this function?The text was updated successfully, but these errors were encountered: