Skip to content

Commit

Permalink
Add more documentation (#90)
Browse files Browse the repository at this point in the history
* Add more documentation for earning power
  • Loading branch information
alexkeating authored Dec 13, 2024
1 parent 6f11554 commit 3a9ad65
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/GovernanceStaker.sol
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,10 @@ abstract contract GovernanceStaker is INotifiableRewardReceiver, Multicall {
uint256 public totalEarningPower;

/// @notice Contract that determines a deposit's earning power based on their delegatee.
/// @dev An earning power calculator should take into account that a deposit's earning power is an
/// uint96. There may be overflow issues within governance staker if this is not taken into
/// account. Also, there should be some mechanism to prevent the deposit from frequently being
/// bumpable: if earning power changes frequently, this will eat into a users unclaimed rewards.
IEarningPowerCalculator public earningPowerCalculator;

/// @notice Tracks the total staked by a depositor across all unique deposits.
Expand Down

0 comments on commit 3a9ad65

Please sign in to comment.