feat(StakeManager): add Pausable capabilities

Author: 0x-r4bbit

status-network-contracts/.gas-report

@@ -8,26 +8,26 @@ AddRewardDistributorTest:testRemoveUnknownKarmaDistributor() (gas: 41666)
 AddRewardDistributorTest:testTotalSupply() (gas: 359391)
 AddRewardDistributorTest:testTransfersNotAllowed() (gas: 61947)
 AddRewardDistributorTest:test_RevertWhen_SenderIsNotDefaultAdmin() (gas: 68406)
-EmergencyExitTest:test_CannotEnableEmergencyModeTwice() (gas: 93535)
-EmergencyExitTest:test_CannotLeaveBeforeEmergencyMode() (gas: 381899)
-EmergencyExitTest:test_EmergencyExitBasic() (gas: 562908)
-EmergencyExitTest:test_EmergencyExitMultipleUsers() (gas: 1012077)
-EmergencyExitTest:test_EmergencyExitToAlternateAddress() (gas: 517549)
-EmergencyExitTest:test_EmergencyExitWithLock() (gas: 468749)
-EmergencyExitTest:test_EmergencyExitWithRewards() (gas: 523071)
-EmergencyExitTest:test_GuardianCanEnableEmergencyMode() (gas: 61684)
+EmergencyExitTest:test_CannotEnableEmergencyModeTwice() (gas: 93544)
+EmergencyExitTest:test_CannotLeaveBeforeEmergencyMode() (gas: 384049)
+EmergencyExitTest:test_EmergencyExitBasic() (gas: 565128)
+EmergencyExitTest:test_EmergencyExitMultipleUsers() (gas: 1016514)
+EmergencyExitTest:test_EmergencyExitToAlternateAddress() (gas: 519702)
+EmergencyExitTest:test_EmergencyExitWithLock() (gas: 470902)
+EmergencyExitTest:test_EmergencyExitWithRewards() (gas: 525291)
+EmergencyExitTest:test_GuardianCanEnableEmergencyMode() (gas: 61687)
 EmergencyExitTest:test_OnlyOwnerOrGuardianCanEnableEmergencyMode() (gas: 43375)
-EmergencyExitTest:test_OwnerCanEnableEmergencyMode() (gas: 63866)
-FuzzTests:testFuzz_AccrueMP(uint128,uint64,uint64) (runs: 1000, μ: 601963, ~: 569241)
-FuzzTests:testFuzz_AccrueMP_Relock(uint128,uint64,uint64,uint64) (runs: 1000, μ: 826338, ~: 795608)
-FuzzTests:testFuzz_EmergencyExit(uint256,uint256) (runs: 1000, μ: 615850, ~: 615759)
-FuzzTests:testFuzz_Lock(uint256,uint64) (runs: 1000, μ: 1019480, ~: 1020428)
-FuzzTests:testFuzz_Relock(uint256,uint64,uint64) (runs: 1000, μ: 616519, ~: 592696)
-FuzzTests:testFuzz_Rewards(uint256,uint256,uint256,uint16,uint16) (runs: 1000, μ: 672169, ~: 674387)
-FuzzTests:testFuzz_Stake(uint256,uint64) (runs: 1000, μ: 396388, ~: 366370)
-FuzzTests:testFuzz_Unstake(uint128,uint64,uint16,uint128) (runs: 1000, μ: 776860, ~: 752260)
-FuzzTests:testFuzz_UpdateVault(uint128,uint64,uint64) (runs: 1000, μ: 601986, ~: 569264)
-IntegrationTest:testStakeFoo() (gas: 2454611)
+EmergencyExitTest:test_OwnerCanEnableEmergencyMode() (gas: 63869)
+FuzzTests:testFuzz_AccrueMP(uint128,uint64,uint64) (runs: 1000, μ: 607780, ~: 573687)
+FuzzTests:testFuzz_AccrueMP_Relock(uint128,uint64,uint64,uint64) (runs: 1000, μ: 830402, ~: 802234)
+FuzzTests:testFuzz_EmergencyExit(uint256,uint256) (runs: 1000, μ: 618065, ~: 617979)
+FuzzTests:testFuzz_Lock(uint256,uint64) (runs: 1000, μ: 1023817, ~: 1024840)
+FuzzTests:testFuzz_Relock(uint256,uint64,uint64) (runs: 1000, μ: 621022, ~: 597099)
+FuzzTests:testFuzz_Rewards(uint256,uint256,uint256,uint16,uint16) (runs: 1000, μ: 676428, ~: 678665)
+FuzzTests:testFuzz_Stake(uint256,uint64) (runs: 1000, μ: 398589, ~: 368610)
+FuzzTests:testFuzz_Unstake(uint128,uint64,uint16,uint128) (runs: 1000, μ: 780903, ~: 756749)
+FuzzTests:testFuzz_UpdateVault(uint128,uint64,uint64) (runs: 1000, μ: 607803, ~: 573710)
+IntegrationTest:testStakeFoo() (gas: 2474610)
 KarmaNFTTest:testApproveNotAllowed() (gas: 10507)
 KarmaNFTTest:testGetApproved() (gas: 10531)
 KarmaNFTTest:testIsApprovedForAll() (gas: 10705)
@@ -65,23 +65,23 @@ KarmaTiersTest:test_Revert_When_TiersNotStartingAtZero() (gas: 37667)
 KarmaTiersTest:test_Revert_When_UpdateTiersCalledByNonOwner() (gas: 36642)
 KarmaTiersTest:test_Success_When_LastTierIsUnlimited() (gas: 242295)
 KarmaTiersTest:test_Success_When_TiersAreContiguous() (gas: 336294)
-LeaveTest:test_LeaveShouldKeepFundsLockedInStakeVault() (gas: 10576618)
-LeaveTest:test_LeaveShouldProperlyUpdateAccounting() (gas: 10664877)
-LockTest:test_LockFailsWithInvalidPeriod(uint256) (runs: 1000, μ: 423703, ~: 423729)
-LockTest:test_LockFailsWithNoStake() (gas: 87924)
-LockTest:test_LockFailsWithZero() (gas: 385332)
-LockTest:test_LockMultipleTimesExceedMaxLock() (gas: 765795)
-LockTest:test_LockWithPriorLock() (gas: 698449)
-LockTest:test_LockWithoutPriorLock() (gas: 542550)
-LockTest:test_RevertWhenVaultToLockIsEmpty() (gas: 87924)
-MaliciousUpgradeTest:test_UpgradeStackOverflowStakeManager() (gas: 2581736)
+LeaveTest:test_LeaveShouldKeepFundsLockedInStakeVault() (gas: 10810421)
+LeaveTest:test_LeaveShouldProperlyUpdateAccounting() (gas: 10898793)
+LockTest:test_LockFailsWithInvalidPeriod(uint256) (runs: 1000, μ: 427982, ~: 428007)
+LockTest:test_LockFailsWithNoStake() (gas: 90052)
+LockTest:test_LockFailsWithZero() (gas: 389610)
+LockTest:test_LockMultipleTimesExceedMaxLock() (gas: 774351)
+LockTest:test_LockWithPriorLock() (gas: 704855)
+LockTest:test_LockWithoutPriorLock() (gas: 546828)
+LockTest:test_RevertWhenVaultToLockIsEmpty() (gas: 90052)
+MaliciousUpgradeTest:test_UpgradeStackOverflowStakeManager() (gas: 2583931)
 MathTest:test_CalcAbsoluteMaxTotalMP() (gas: 5240)
 MathTest:test_CalcAccrueMP() (gas: 8599)
-MathTest:test_CalcBonusMP() (gas: 30610)
+MathTest:test_CalcBonusMP() (gas: 30656)
 MathTest:test_CalcInitialMP() (gas: 5836)
 MathTest:test_CalcMaxAccruedMP() (gas: 4886)
-MathTest:test_CalcMaxTotalMP() (gas: 31372)
-MultipleVaultsStakeTest:test_StakeMultipleVaults() (gas: 1041639)
+MathTest:test_CalcMaxTotalMP() (gas: 31418)
+MultipleVaultsStakeTest:test_StakeMultipleVaults() (gas: 1048134)
 NFTMetadataGeneratorSVGTest:testGenerateMetadata() (gas: 92580)
 NFTMetadataGeneratorSVGTest:testSetImageStrings() (gas: 77581)
 NFTMetadataGeneratorSVGTest:testSetImageStringsRevert() (gas: 35891)
@@ -98,6 +98,9 @@ OverflowTest:testTotalSupply() (gas: 359391)
 OverflowTest:testTransfersNotAllowed() (gas: 61925)
 OverflowTest:test_RevertWhen_MintingCausesOverflow() (gas: 129592)
 OverflowTest:test_RevertWhen_SettingRewardCausesOverflow() (gas: 127920)
+PauseTest:test_PauseAndUnpause() (gas: 501645)
+PauseTest:test_RevertWhenNotAdmin() (gas: 43335)
+PauseTest:test_RevertWhenNotGuardian() (gas: 43380)
 RLNTest:test_initial_state() (gas: 45654)
 RLNTest:test_register_fails_when_duplicate_identity_commitment() (gas: 131740)
 RLNTest:test_register_fails_when_index_exceeds_set_size() (gas: 2313519)
@@ -152,30 +155,30 @@ SlashTest:test_RevertWhen_KarmaBalanceIsInvalid() (gas: 71550)
 SlashTest:test_RevertWhen_SenderIsNotDefaultAdminOrSlasher() (gas: 43232)
 SlashTest:test_Slash() (gas: 428385)
 SlashTest:test_SlashRemainingBalanceIfBalanceIsLow() (gas: 251800)
-StakeManager_RewardsTest:testRewardsBalanceOf() (gas: 2798435)
-StakeManager_RewardsTest:testSetRewards() (gas: 280257)
-StakeManager_RewardsTest:testSetRewardsAccumulatesRemainingRewards() (gas: 388372)
-StakeManager_RewardsTest:testSetRewardsAfterPeriodEndedNoAccumulation() (gas: 309095)
-StakeManager_RewardsTest:testSetRewardsWithPartialElapsedTime() (gas: 307281)
-StakeManager_RewardsTest:testSetRewards_RevertsBadAmount() (gas: 63845)
-StakeManager_RewardsTest:testSetRewards_RevertsBadDuration() (gas: 103603)
-StakeManager_RewardsTest:testSetRewards_RevertsNotAuthorized() (gas: 41537)
-StakeManager_RewardsTest:testTotalRewardsSupply() (gas: 1326087)
-StakeTest:test_StakeMultipleAccounts() (gas: 748595)
-StakeTest:test_StakeMultipleAccountsAndRewards() (gas: 803496)
-StakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 1406194)
-StakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 674725)
-StakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 683358)
-StakeTest:test_StakeMultipleTimesDoesNotExceedsMaxMP() (gas: 1829113)
-StakeTest:test_StakeMultipleTimesWithLockIncreaseAtSameBlock() (gas: 715357)
-StakeTest:test_StakeMultipleTimesWithLockZeroAfterMaxLock() (gas: 1237445)
-StakeTest:test_StakeOneAccount() (gas: 431210)
-StakeTest:test_StakeOneAccountAndRewards() (gas: 486174)
-StakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 865966)
-StakeTest:test_StakeOneAccountReachingMPLimit() (gas: 755456)
-StakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 400384)
-StakeTest:test_StakeOneAccountWithMinLockUp() (gas: 400957)
-StakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 401002)
+StakeManager_RewardsTest:testRewardsBalanceOf() (gas: 2808933)
+StakeManager_RewardsTest:testSetRewards() (gas: 282629)
+StakeManager_RewardsTest:testSetRewardsAccumulatesRemainingRewards() (gas: 392894)
+StakeManager_RewardsTest:testSetRewardsAfterPeriodEndedNoAccumulation() (gas: 313395)
+StakeManager_RewardsTest:testSetRewardsWithPartialElapsedTime() (gas: 311581)
+StakeManager_RewardsTest:testSetRewards_RevertsBadAmount() (gas: 65995)
+StakeManager_RewardsTest:testSetRewards_RevertsBadDuration() (gas: 105753)
+StakeManager_RewardsTest:testSetRewards_RevertsNotAuthorized() (gas: 43687)
+StakeManager_RewardsTest:testTotalRewardsSupply() (gas: 1332537)
+StakeTest:test_StakeMultipleAccounts() (gas: 752962)
+StakeTest:test_StakeMultipleAccountsAndRewards() (gas: 807930)
+StakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 1419295)
+StakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 679115)
+StakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 687748)
+StakeTest:test_StakeMultipleTimesDoesNotExceedsMaxMP() (gas: 1846313)
+StakeTest:test_StakeMultipleTimesWithLockIncreaseAtSameBlock() (gas: 721941)
+StakeTest:test_StakeMultipleTimesWithLockZeroAfterMaxLock() (gas: 1250323)
+StakeTest:test_StakeOneAccount() (gas: 433427)
+StakeTest:test_StakeOneAccountAndRewards() (gas: 488458)
+StakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 876917)
+StakeTest:test_StakeOneAccountReachingMPLimit() (gas: 762107)
+StakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 402601)
+StakeTest:test_StakeOneAccountWithMinLockUp() (gas: 403197)
+StakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 403242)
 StakeVaultCoverageTest:testOwner() (gas: 15412)
 StakeVaultCoverageTest:test_LeaveTransfersAllFunds() (gas: 215757)
 StakeVaultCoverageTest:test_StakeRevertsIfNotOwner() (gas: 37215)
@@ -186,42 +189,42 @@ StakeVaultCoverageTest:test_WithdrawOtherTokenTransfersToDestination() (gas: 142
 StakeVaultCoverageTest:test_WithdrawRevertsIfInsufficientAvailableBalance() (gas: 167250)
 StakeVaultCoverageTest:test_WithdrawRevertsIfInvalidDestination() (gas: 111137)
 StakeVaultCoverageTest:test_WithdrawTransfersGenericTokenToOwner() (gas: 139661)
-StakeVaultMigrationTest:testMigrateToVault() (gas: 1273180)
-StakeVaultMigrationTest:test_RevertWhenDestinationVaultIsNotRegistered() (gas: 268817)
-StakeVaultMigrationTest:test_RevertWhenMigrationVaultNotEmpty() (gas: 646944)
+StakeVaultMigrationTest:testMigrateToVault() (gas: 1282047)
+StakeVaultMigrationTest:test_RevertWhenDestinationVaultIsNotRegistered() (gas: 270967)
+StakeVaultMigrationTest:test_RevertWhenMigrationVaultNotEmpty() (gas: 653460)
 StakeVaultMigrationTest:test_RevertWhenNotOwnerOfMigrationVault() (gas: 49447)
 StakeVaultTest:testOwner() (gas: 15307)
 StakingTokenTest:testOwner() (gas: 15307)
 StakingTokenTest:testStakeToken() (gas: 13144)
 TransferOwnershipTest:testOwner() (gas: 15307)
 TransferOwnershipTest:test_RevertWhen_TransferOwnership() (gas: 41429)
-TrustedCodehashAccessTest:test_RevertWhenProxyCloneCodehashNotTrusted() (gas: 2131267)
-UnstakeTest:test_RevertWhen_FundsLocked() (gas: 460594)
-UnstakeTest:test_StakeMultipleAccounts() (gas: 748574)
-UnstakeTest:test_StakeMultipleAccountsAndRewards() (gas: 803540)
-UnstakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 1406260)
-UnstakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 674791)
-UnstakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 683357)
-UnstakeTest:test_StakeMultipleTimesDoesNotExceedsMaxMP() (gas: 1829169)
-UnstakeTest:test_StakeMultipleTimesWithLockIncreaseAtSameBlock() (gas: 715312)
-UnstakeTest:test_StakeMultipleTimesWithLockZeroAfterMaxLock() (gas: 1237456)
-UnstakeTest:test_StakeOneAccount() (gas: 431232)
-UnstakeTest:test_StakeOneAccountAndRewards() (gas: 486173)
-UnstakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 865965)
-UnstakeTest:test_StakeOneAccountReachingMPLimit() (gas: 755436)
-UnstakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 400406)
-UnstakeTest:test_StakeOneAccountWithMinLockUp() (gas: 400957)
-UnstakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 401002)
-UnstakeTest:test_UnstakeBonusMPAndAccuredMP() (gas: 774353)
-UnstakeTest:test_UnstakeMultipleAccounts() (gas: 1112086)
-UnstakeTest:test_UnstakeMultipleAccountsAndRewards() (gas: 1398136)
-UnstakeTest:test_UnstakeOneAccount() (gas: 801942)
-UnstakeTest:test_UnstakeOneAccountAndAccruedMP() (gas: 761419)
-UnstakeTest:test_UnstakeOneAccountAndRewards() (gas: 715667)
-UnstakeTest:test_UnstakeOneAccountWithLockUpAndAccruedMP() (gas: 741990)
-UpdateVaultTest:test_UpdateAccount() (gas: 2681687)
-UpgradeTest:test_RevertWhenNotOwner() (gas: 4005864)
-UpgradeTest:test_UpgradeStakeManager() (gas: 10494818)
+TrustedCodehashAccessTest:test_RevertWhenProxyCloneCodehashNotTrusted() (gas: 2135633)
+UnstakeTest:test_RevertWhen_FundsLocked() (gas: 464070)
+UnstakeTest:test_StakeMultipleAccounts() (gas: 752941)
+UnstakeTest:test_StakeMultipleAccountsAndRewards() (gas: 807974)
+UnstakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 1419361)
+UnstakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 679181)
+UnstakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 687747)
+UnstakeTest:test_StakeMultipleTimesDoesNotExceedsMaxMP() (gas: 1846369)
+UnstakeTest:test_StakeMultipleTimesWithLockIncreaseAtSameBlock() (gas: 721896)
+UnstakeTest:test_StakeMultipleTimesWithLockZeroAfterMaxLock() (gas: 1250334)
+UnstakeTest:test_StakeOneAccount() (gas: 433449)
+UnstakeTest:test_StakeOneAccountAndRewards() (gas: 488457)
+UnstakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 876916)
+UnstakeTest:test_StakeOneAccountReachingMPLimit() (gas: 762087)
+UnstakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 402623)
+UnstakeTest:test_StakeOneAccountWithMinLockUp() (gas: 403197)
+UnstakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 403242)
+UnstakeTest:test_UnstakeBonusMPAndAccuredMP() (gas: 780918)
+UnstakeTest:test_UnstakeMultipleAccounts() (gas: 1120866)
+UnstakeTest:test_UnstakeMultipleAccountsAndRewards() (gas: 1408420)
+UnstakeTest:test_UnstakeOneAccount() (gas: 807769)
+UnstakeTest:test_UnstakeOneAccountAndAccruedMP() (gas: 768093)
+UnstakeTest:test_UnstakeOneAccountAndRewards() (gas: 720191)
+UnstakeTest:test_UnstakeOneAccountWithLockUpAndAccruedMP() (gas: 748710)
+UpdateVaultTest:test_UpdateAccount() (gas: 2701213)
+UpgradeTest:test_RevertWhenNotOwner() (gas: 4126787)
+UpgradeTest:test_UpgradeStakeManager() (gas: 10727443)
 VaultRegistrationTest:test_VaultRegistration() (gas: 90314)
-WithdrawTest:test_RewertWhen_WithdrawingStakedFundsWithoutCallingLeaveFirst() (gas: 458520)
-WithdrawTest:test_WithdrawStakedTokensAfterLeave() (gas: 536637)
+WithdrawTest:test_RewertWhen_WithdrawingStakedFundsWithoutCallingLeaveFirst() (gas: 460737)
+WithdrawTest:test_WithdrawStakedTokensAfterLeave() (gas: 540077)

status-network-contracts/.gas-snapshot

@@ -15,6 +15,11 @@ definition isTrustedCodehashAccessFunction(method f) returns bool = (
   f.selector == sig:streamer.setTrustedCodehash(bytes32, bool).selector
 );
 
+definition isPausableFunction(method f) returns bool = (
+  f.selector == sig:streamer.pause().selector ||
+  f.selector == sig:streamer.unpause().selector
+);
+
 definition isInitializerFunction(method f) returns bool = (
   f.selector == sig:streamer.initialize(address,address).selector
 );
@@ -37,9 +42,11 @@ definition noCallDuringEmergency(method f) returns bool = (
                 || f.selector == sig:streamer.lock(uint256, uint256).selector
                 || f.selector == sig:streamer.setReward(uint256, uint256).selector
                 || f.selector == sig:enableEmergencyMode().selector
+                || f.selector == sig:pause().selector
+                || f.selector == sig:unpause().selector
 );
 
-rule accountCanOnlyLeaveInEmergencyMode(method f) {
+rule allowedActionsInEmergencyMode(method f) {
   env e;
   calldataarg args;
 
@@ -51,6 +58,7 @@ rule accountCanOnlyLeaveInEmergencyMode(method f) {
   assert !isReverted => f.selector == sig:streamer.leave().selector ||
                         f.isView ||
                         isAccessControlFunction(f) ||
+                        isPausableFunction(f) ||
                         isTrustedCodehashAccessFunction(f) ||
                         isInitializerFunction(f) ||
                         isUUPSUpgradeableFunction(f);

status-network-contracts/certora/specs/EmergencyMode.spec

@@ -15,6 +15,7 @@ methods {
     function emergencyModeEnabled() external returns (bool) envfree;
     function leave() external;
     function Math.mulDiv(uint256 a, uint256 b, uint256 c) internal returns uint256 => mulDivSummary(a,b,c);
+    function paused() external returns (bool) envfree;
 
     function _.migrateFromVault(IStakeVault.MigrationData) external => DISPATCHER(true);
     function _.lockUntil() external => DISPATCHER(true);
@@ -124,3 +125,25 @@ rule MPsOnlyDecreaseWhenUnstaking(method f) filtered { f -> f.selector != sig:up
 
   assert totalMPAfter < totalMPBefore => f.selector == sig:unstake(uint256).selector || f.selector == sig:leave().selector;
 }
+
+rule allowedActionsWhenPaused(method f) {
+  env e;
+  calldataarg args;
+
+  require paused();
+
+  f@withrevert(e, args);
+  bool reverted = lastReverted;
+
+  assert !reverted => f.isView ||
+    f.selector == sig:streamer.initialize(address,address).selector ||
+    f.selector == sig:streamer.upgradeTo(address).selector ||
+    f.selector == sig:streamer.upgradeToAndCall(address, bytes).selector ||
+    f.selector == sig:streamer.grantRole(bytes32, address).selector ||
+    f.selector == sig:streamer.revokeRole(bytes32, address).selector ||
+    f.selector == sig:streamer.renounceRole(bytes32, address).selector ||
+    f.selector == sig:streamer.setTrustedCodehash(bytes32, bool).selector ||
+    f.selector == sig:streamer.__TrustedCodehashAccess_init(address).selector ||
+    f.selector == sig:streamer.enableEmergencyMode().selector ||
+    f.selector == sig:streamer.unpause().selector;
+}