Skip to content

Commit

Permalink
document resetStakes for draft rate
Browse files Browse the repository at this point in the history
  • Loading branch information
tbrent committed Sep 10, 2024
1 parent 00c438a commit bcf1873
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions contracts/p1/StRSR.sol
Original file line number Diff line number Diff line change
Expand Up @@ -481,14 +481,17 @@ abstract contract StRSRP1 is Initializable, ComponentP1, IStRSR, EIP712Upgradeab

/// @custom:governance
/// Reset all stakes and advance era
/// @notice This function is only callable when the stake rate is unsafe.
/// The stake rate is unsafe when it is either too high or too low.
/// @notice This function is only callable when the stake or draft rates are unsafe.
/// The stake/draft rate is unsafe when it is either too high or too low.
/// There is the possibility of the rate reaching the borderline of being unsafe,
/// where users won't stake in fear that a reset might be executed.
/// A user may also grief this situation by staking enough RSR to vote against any reset.
/// This standoff will continue until enough RSR is staked and a reset is executed.
/// There is currently no good and easy way to mitigate the possibility of this situation,
/// and the risk of it occurring is low enough that it is not worth the effort to mitigate.
/// @notice Governance must monitor the draftRate! After multiple seizures it is possible
/// for it to drift near the unsafe bounds. Even if stakes are still safe at this point,
/// resetStakes() should be called by governance anyway.
function resetStakes() external {
_requireGovernanceOnly();
require(
Expand Down

0 comments on commit bcf1873

Please sign in to comment.