Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(RewardsStreamerMP): introduce leave() function #77

Closed
wants to merge 1 commit into from
Closed

feat(RewardsStreamerMP): introduce leave() function #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 28 additions & 18 deletions .gas-report
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,37 +15,38 @@
| src/RewardsStreamerMP.sol:RewardsStreamerMP contract | | | | | |
|------------------------------------------------------|-----------------|-------|--------|-------|---------|
| Deployment Cost | Deployment Size | | | | |
| 1425736 | 6528 | | | | |
| 1464062 | 6707 | | | | |
| Function Name | min | avg | median | max | # calls |
| MAX_LOCKUP_PERIOD | 228 | 228 | 228 | 228 | 23 |
| MAX_MULTIPLIER | 274 | 274 | 274 | 274 | 30 |
| MIN_LOCKUP_PERIOD | 275 | 275 | 275 | 275 | 11 |
| MP_RATE_PER_YEAR | 231 | 231 | 231 | 231 | 3 |
| SCALE_FACTOR | 295 | 295 | 295 | 295 | 41 |
| STAKING_TOKEN | 273 | 273 | 273 | 273 | 172 |
| accountedRewards | 351 | 906 | 351 | 2351 | 72 |
| SCALE_FACTOR | 273 | 273 | 273 | 273 | 41 |
| STAKING_TOKEN | 273 | 273 | 273 | 273 | 182 |
| accountedRewards | 329 | 896 | 329 | 2329 | 74 |
| emergencyModeEnabled | 2377 | 2377 | 2377 | 2377 | 7 |
| enableEmergencyMode | 23504 | 40411 | 45696 | 45696 | 8 |
| getAccount | 1596 | 1596 | 1596 | 1596 | 71 |
| isTrustedCodehash | 496 | 996 | 496 | 2496 | 172 |
| rewardIndex | 373 | 400 | 373 | 2373 | 72 |
| setTrustedCodehash | 47926 | 47926 | 47926 | 47926 | 43 |
| totalMP | 330 | 330 | 330 | 330 | 75 |
| totalMaxMP | 351 | 351 | 351 | 351 | 75 |
| totalStaked | 330 | 330 | 330 | 330 | 75 |
| enableEmergencyMode | 23482 | 40389 | 45674 | 45674 | 8 |
| getAccount | 1596 | 1596 | 1596 | 1596 | 72 |
| isTrustedCodehash | 496 | 996 | 496 | 2496 | 180 |
| rewardIndex | 373 | 400 | 373 | 2373 | 74 |
| setTrustedCodehash | 47926 | 47926 | 47926 | 47926 | 47 |
| totalMP | 330 | 330 | 330 | 330 | 77 |
| totalMaxMP | 351 | 351 | 351 | 351 | 77 |
| totalStaked | 330 | 330 | 330 | 330 | 77 |
| updateAccountMP | 36758 | 38996 | 39260 | 39260 | 19 |
| updateGlobalState | 32134 | 60366 | 49513 | 82460 | 28 |


| src/StakeVault.sol:StakeVault contract | | | | | |
|----------------------------------------|-----------------|--------|--------|--------|---------|
| Deployment Cost | Deployment Size | | | | |
| 1095864 | 5202 | | | | |
| 1130636 | 5366 | | | | |
| Function Name | min | avg | median | max | # calls |
| emergencyExit | 31410 | 43924 | 43160 | 60260 | 7 |
| leave | 24019 | 24019 | 24019 | 24019 | 1 |
| lock | 38362 | 60516 | 42741 | 100445 | 3 |
| stake | 199213 | 236948 | 242906 | 263435 | 55 |
| unstake | 84988 | 113999 | 103434 | 146128 | 13 |
| stake | 199207 | 237049 | 242900 | 263429 | 56 |
| unstake | 85027 | 114046 | 103483 | 146178 | 13 |


| src/XPNFTToken.sol:XPNFTToken contract | | | | | |
Expand Down Expand Up @@ -108,6 +109,15 @@
| urlSuffix | 1250 | 1250 | 1250 | 1250 | 1 |


| test/harness/StakeVaultNonTrusting.sol:StakeVaultNonTrusting contract | | | | | |
|-----------------------------------------------------------------------|-----------------|--------|--------|--------|---------|
| Deployment Cost | Deployment Size | | | | |
| 1090189 | 5189 | | | | |
| Function Name | min | avg | median | max | # calls |
| leave | 84495 | 84495 | 84495 | 84495 | 1 |
| stakeNonTrusted | 240739 | 240739 | 240739 | 240739 | 1 |


| test/mocks/MockMetadataGenerator.sol:MockMetadataGenerator contract | | | | | |
|---------------------------------------------------------------------|-----------------|-------|--------|-------|---------|
| Deployment Cost | Deployment Size | | | | |
Expand All @@ -121,9 +131,9 @@
| Deployment Cost | Deployment Size | | | | |
| 639406 | 3369 | | | | |
| Function Name | min | avg | median | max | # calls |
| approve | 46334 | 46343 | 46346 | 46346 | 220 |
| balanceOf | 561 | 1381 | 561 | 2561 | 334 |
| mint | 51284 | 58817 | 51284 | 68384 | 236 |
| approve | 46334 | 46343 | 46346 | 46346 | 232 |
| balanceOf | 561 | 1388 | 561 | 2561 | 343 |
| mint | 51284 | 58789 | 51284 | 68384 | 246 |
| transfer | 34390 | 48859 | 51490 | 51490 | 13 |


Expand Down
88 changes: 45 additions & 43 deletions .gas-snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,55 @@
EmergencyExitTest:test_CannotEnableEmergencyModeTwice() (gas: 79829)
EmergencyExitTest:test_CannotLeaveBeforeEmergencyMode() (gas: 283234)
EmergencyExitTest:test_EmergencyExitBasic() (gas: 379874)
EmergencyExitTest:test_EmergencyExitMultipleUsers() (gas: 788714)
EmergencyExitTest:test_EmergencyExitToAlternateAddress() (gas: 517455)
EmergencyExitTest:test_EmergencyExitWithLock() (gas: 370304)
EmergencyExitTest:test_EmergencyExitWithRewards() (gas: 507361)
EmergencyExitTest:test_OnlyOwnerCanEnableEmergencyMode() (gas: 34607)
IntegrationTest:testStakeFoo() (gas: 1490300)
LockTest:test_LockFailsWithInvalidPeriod() (gas: 290178)
LockTest:test_LockFailsWithNoStake() (gas: 53357)
LockTest:test_LockWithoutPriorLock() (gas: 383272)
EmergencyExitTest:test_CannotEnableEmergencyModeTwice() (gas: 79785)
EmergencyExitTest:test_CannotLeaveBeforeEmergencyMode() (gas: 283229)
EmergencyExitTest:test_EmergencyExitBasic() (gas: 379825)
EmergencyExitTest:test_EmergencyExitMultipleUsers() (gas: 788638)
EmergencyExitTest:test_EmergencyExitToAlternateAddress() (gas: 517427)
EmergencyExitTest:test_EmergencyExitWithLock() (gas: 370277)
EmergencyExitTest:test_EmergencyExitWithRewards() (gas: 507312)
EmergencyExitTest:test_OnlyOwnerCanEnableEmergencyMode() (gas: 34585)
IntegrationTest:testStakeFoo() (gas: 1490184)
LeaveTest:test_LeaveShouldProperlyUpdateAccounting() (gas: 365536)
LeaveTest:test_RevertWhenStakeManagerIsTrusted() (gas: 275827)
LockTest:test_LockFailsWithInvalidPeriod() (gas: 290237)
LockTest:test_LockFailsWithNoStake() (gas: 53423)
LockTest:test_LockWithoutPriorLock() (gas: 383200)
NFTMetadataGeneratorSVGTest:testGenerateMetadata() (gas: 92874)
NFTMetadataGeneratorSVGTest:testSetImageStrings() (gas: 60081)
NFTMetadataGeneratorSVGTest:testSetImageStringsRevert() (gas: 35818)
NFTMetadataGeneratorURLTest:testGenerateMetadata() (gas: 109345)
NFTMetadataGeneratorURLTest:testSetBaseURL() (gas: 50653)
NFTMetadataGeneratorURLTest:testSetBaseURLRevert() (gas: 35993)
RewardsStreamerTest:testStake() (gas: 869874)
StakeTest:test_StakeMultipleAccounts() (gas: 493279)
StakeTest:test_StakeMultipleAccountsAndRewards() (gas: 640763)
StakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 818252)
StakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 499381)
StakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 520783)
StakeTest:test_StakeOneAccount() (gas: 284277)
StakeTest:test_StakeOneAccountAndRewards() (gas: 431756)
StakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 498901)
StakeTest:test_StakeOneAccountReachingMPLimit() (gas: 494078)
StakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 298175)
StakeTest:test_StakeOneAccountWithMinLockUp() (gas: 298187)
StakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 298298)
UnstakeTest:test_StakeMultipleAccounts() (gas: 493323)
UnstakeTest:test_StakeMultipleAccountsAndRewards() (gas: 640807)
UnstakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 818251)
UnstakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 499380)
UnstakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 520827)
UnstakeTest:test_StakeOneAccount() (gas: 284300)
UnstakeTest:test_StakeOneAccountAndRewards() (gas: 431800)
UnstakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 498945)
UnstakeTest:test_StakeOneAccountReachingMPLimit() (gas: 494080)
UnstakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 298132)
UnstakeTest:test_StakeOneAccountWithMinLockUp() (gas: 298187)
UnstakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 298298)
UnstakeTest:test_UnstakeBonusMPAndAccuredMP() (gas: 508511)
UnstakeTest:test_UnstakeMultipleAccounts() (gas: 688755)
UnstakeTest:test_UnstakeMultipleAccountsAndRewards() (gas: 1014239)
UnstakeTest:test_UnstakeOneAccount() (gas: 480152)
UnstakeTest:test_UnstakeOneAccountAndAccruedMP() (gas: 496638)
UnstakeTest:test_UnstakeOneAccountAndRewards() (gas: 585964)
UnstakeTest:test_UnstakeOneAccountWithLockUpAndAccruedMP() (gas: 518574)
StakeTest:test_StakeMultipleAccounts() (gas: 493245)
StakeTest:test_StakeMultipleAccountsAndRewards() (gas: 640707)
StakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 818174)
StakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 499259)
StakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 520661)
StakeTest:test_StakeOneAccount() (gas: 284249)
StakeTest:test_StakeOneAccountAndRewards() (gas: 431706)
StakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 498829)
StakeTest:test_StakeOneAccountReachingMPLimit() (gas: 493984)
StakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 298103)
StakeTest:test_StakeOneAccountWithMinLockUp() (gas: 298115)
StakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 298226)
UnstakeTest:test_StakeMultipleAccounts() (gas: 493267)
UnstakeTest:test_StakeMultipleAccountsAndRewards() (gas: 640729)
UnstakeTest:test_StakeMultipleAccountsMPIncreasesMaxMPDoesNotChange() (gas: 818151)
UnstakeTest:test_StakeMultipleAccountsWithMinLockUp() (gas: 499236)
UnstakeTest:test_StakeMultipleAccountsWithRandomLockUp() (gas: 520683)
UnstakeTest:test_StakeOneAccount() (gas: 284272)
UnstakeTest:test_StakeOneAccountAndRewards() (gas: 431728)
UnstakeTest:test_StakeOneAccountMPIncreasesMaxMPDoesNotChange() (gas: 498851)
UnstakeTest:test_StakeOneAccountReachingMPLimit() (gas: 493964)
UnstakeTest:test_StakeOneAccountWithMaxLockUp() (gas: 298103)
UnstakeTest:test_StakeOneAccountWithMinLockUp() (gas: 298115)
UnstakeTest:test_StakeOneAccountWithRandomLockUp() (gas: 298204)
UnstakeTest:test_UnstakeBonusMPAndAccuredMP() (gas: 508466)
UnstakeTest:test_UnstakeMultipleAccounts() (gas: 688777)
UnstakeTest:test_UnstakeMultipleAccountsAndRewards() (gas: 1014246)
UnstakeTest:test_UnstakeOneAccount() (gas: 480136)
UnstakeTest:test_UnstakeOneAccountAndAccruedMP() (gas: 496593)
UnstakeTest:test_UnstakeOneAccountAndRewards() (gas: 585942)
UnstakeTest:test_UnstakeOneAccountWithLockUpAndAccruedMP() (gas: 518419)
XPNFTTokenTest:testApproveNotAllowed() (gas: 10507)
XPNFTTokenTest:testGetApproved() (gas: 10531)
XPNFTTokenTest:testIsApprovedForAll() (gas: 10705)
Expand Down
3 changes: 2 additions & 1 deletion certora/specs/EmergencyMode.spec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ rule accountCanOnlyLeaveInEmergencyMode(method f) {
f@withrevert(e, args);
bool isReverted = lastReverted;

assert !isReverted => isViewFunction(f) ||
assert !isReverted => f.selector == sig:streamer.leave().selector ||
isViewFunction(f) ||
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

leave() will not revert but should still be protected by a rule that ensures that, if leave() was called and the accounting was updated, the stake manager was not trusted by the caller (vault).

If it was trusted and the vault still manages to leave the system, this is a bug. Vault should properly unstake in that case.

isOwnableFunction(f) ||
isTrustedCodehashAccessFunction(f);
}
Expand Down
1 change: 1 addition & 0 deletions certora/specs/RewardsStreamerMP.spec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ methods {
function updateGlobalState() external;
function updateAccountMP(address accountAddress) external;
function emergencyModeEnabled() external returns (bool) envfree;
function leave() external;
}

ghost mathint sumOfBalances {
Expand Down
28 changes: 24 additions & 4 deletions src/RewardsStreamerMP.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,13 +150,16 @@ contract RewardsStreamerMP is IStakeManager, TrustedCodehashAccess, ReentrancyGu
if (block.timestamp < account.lockUntil) {
revert StakingManager__TokensAreLocked();
}
_unstake(amount, account, msg.sender);
}

function _unstake(uint256 amount, Account storage account, address accountAddress) internal {
_updateGlobalState();
_updateAccountMP(msg.sender);
_updateAccountMP(accountAddress);

uint256 accountRewards = calculateAccountRewards(msg.sender);
uint256 accountRewards = calculateAccountRewards(accountAddress);
if (accountRewards > 0) {
distributeRewards(msg.sender, accountRewards);
distributeRewards(accountAddress, accountRewards);
}

uint256 previousStakedBalance = account.stakedBalance;
Expand All @@ -167,11 +170,28 @@ contract RewardsStreamerMP is IStakeManager, TrustedCodehashAccess, ReentrancyGu
account.stakedBalance -= amount;
account.accountMP -= mpToReduce;
account.maxMP -= maxMPToReduce;
account.accountRewardIndex = rewardIndex;
totalMP -= mpToReduce;
totalMaxMP -= maxMPToReduce;
totalStaked -= amount;
}

account.accountRewardIndex = rewardIndex;
// @notice Allows an account to leave the system. This can happen when a
// user doesn't agree with an upgrade of the stake manager.
// @dev This function is protected by whitelisting the codehash of the caller.
// This ensures `StakeVault`s will call this function only if they don't
// trust the `StakeManager` (e.g. in case of an upgrade).
function leave() external onlyTrustedCodehash nonReentrant {
Account storage account = accounts[msg.sender];

if (account.stakedBalance > 0) {
// calling `_unstake` to update accounting accordingly
_unstake(account.stakedBalance, account, msg.sender);

// further cleanup that isn't done in `_unstake`
account.accountRewardIndex = 0;
account.lockUntil = 0;
}
}

function _updateGlobalState() internal {
Expand Down
Loading