Skip to content

feat(StakeVault): add withdraw function and improve documentation #144

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

Open
3esmit wants to merge 2 commits into
base: develop
Choose a base branch
from
+245 −83
Open

feat(StakeVault): add withdraw function and improve documentation #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c08fe41
feat(StakeVault): add withdraw function and improve documentation
3esmit Oct 1, 2024
2f1c8fe
chore(StakeVault): add important comment about STAKED_TOKEN being imm…
3esmit Oct 3, 2024
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
56 changes: 28 additions & 28 deletions .gas-report
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
| MAX_LOCKUP_PERIOD | 361 | 361 | 361 | 361 | 4 |
| MIN_LOCKUP_PERIOD | 264 | 264 | 264 | 264 | 12 |
| YEAR | 263 | 263 | 263 | 263 | 637 |
| accounts | 1597 | 1597 | 1597 | 1597 | 144273 |
| accounts | 1597 | 1597 | 1597 | 1597 | 144393 |
| calculateMPToMint | 740 | 740 | 740 | 740 | 1276 |
| currentEpoch | 384 | 1050 | 384 | 2384 | 54 |
| epochEnd | 627 | 627 | 627 | 2627 | 23675 |
| epochEnd | 627 | 627 | 627 | 2627 | 23695 |
| epochReward | 1425 | 2925 | 1425 | 5925 | 3 |
| executeAccount(address) | 151152 | 151152 | 151152 | 151152 | 2 |
| executeAccount(address,uint256) | 26562 | 72616 | 74122 | 217879 | 141860 |
| executeEpoch() | 23458 | 120800 | 121956 | 938985 | 23564 |
| executeAccount(address,uint256) | 26562 | 72609 | 74122 | 217879 | 141980 |
| executeEpoch() | 23458 | 120804 | 121956 | 938985 | 23584 |
| executeEpoch(uint256) | 23861 | 24497 | 23861 | 26090 | 7 |
| isVault | 540 | 948 | 540 | 2540 | 680 |
| lock | 23862 | 23862 | 23862 | 23862 | 1 |
Expand All @@ -24,7 +24,7 @@
| migrationInitialize | 24602 | 24602 | 24602 | 24602 | 1 |
| newEpoch | 441 | 441 | 441 | 441 | 5 |
| owner | 2432 | 2432 | 2432 | 2432 | 13 |
| pendingMPToBeMinted | 364 | 364 | 364 | 364 | 46432 |
| pendingMPToBeMinted | 364 | 364 | 364 | 364 | 46472 |
| pendingReward | 386 | 1420 | 2386 | 2386 | 29 |
| previousManager | 275 | 275 | 275 | 275 | 13 |
| setVault | 46239 | 46239 | 46239 | 46239 | 139 |
Expand All @@ -35,7 +35,7 @@
| startTime | 306 | 306 | 306 | 306 | 21 |
| totalSupply | 762 | 1943 | 2762 | 2762 | 22 |
| totalSupplyBalance | 407 | 1807 | 2407 | 2407 | 20 |
| totalSupplyMP | 362 | 362 | 362 | 2362 | 46453 |
| totalSupplyMP | 362 | 362 | 362 | 2362 | 46493 |
| unstake | 23819 | 23819 | 23819 | 23819 | 1 |


Expand All @@ -44,7 +44,7 @@
| Deployment Cost | Deployment Size | | | | |
| 0 | 0 | | | | |
| Function Name | min | avg | median | max | # calls |
| getExpiredMP | 2427 | 2427 | 2427 | 2427 | 23725 |
| getExpiredMP | 2427 | 2427 | 2427 | 2427 | 23745 |
| transferOwnership | 28533 | 28533 | 28533 | 28533 | 1 |


Expand All @@ -53,40 +53,40 @@
| Deployment Cost | Deployment Size | | | | |
| 0 | 0 | | | | |
| Function Name | min | avg | median | max | # calls |
| acceptMigration | 35280 | 35280 | 35280 | 35280 | 2 |
| leave | 35266 | 35266 | 35266 | 35266 | 1 |
| lock | 43329 | 96146 | 64421 | 204745 | 7 |
| owner | 362 | 362 | 362 | 362 | 679 |
| stake | 27265 | 282079 | 265719 | 351866 | 684 |
| stakedToken | 212 | 212 | 212 | 212 | 2 |
| unstake | 40167 | 95818 | 78688 | 233549 | 11 |
| acceptMigration | 35303 | 35303 | 35303 | 35303 | 2 |
| leave | 35327 | 35327 | 35327 | 35327 | 1 |
| lock | 43352 | 96169 | 64444 | 204768 | 7 |
| owner | 364 | 364 | 364 | 364 | 679 |
| stake | 49545 | 304906 | 288231 | 374378 | 684 |
| stakedToken | 257 | 257 | 257 | 257 | 2 |
| unstake | 40209 | 98514 | 82820 | 237681 | 11 |


| contracts/VaultFactory.sol:VaultFactory contract | | | | | |
|--------------------------------------------------|-----------------|--------|--------|--------|---------|
| Deployment Cost | Deployment Size | | | | |
| 0 | 0 | | | | |
| Function Name | min | avg | median | max | # calls |
| createVault | 696553 | 696553 | 696553 | 696553 | 683 |
| setStakeManager | 23710 | 26669 | 26076 | 30222 | 3 |
| stakeManager | 368 | 1868 | 2368 | 2368 | 4 |
| contracts/VaultFactory.sol:VaultFactory contract | | | | | |
|--------------------------------------------------|-----------------|---------|---------|---------|---------|
| Deployment Cost | Deployment Size | | | | |
| 0 | 0 | | | | |
| Function Name | min | avg | median | max | # calls |
| createVault | 1127500 | 1127500 | 1127500 | 1127500 | 683 |
| setStakeManager | 23710 | 26669 | 26076 | 30222 | 3 |
| stakeManager | 368 | 1868 | 2368 | 2368 | 4 |


| lib/openzeppelin-contracts/contracts/token/ERC20/ERC20.sol:ERC20 contract | | | | | |
|---------------------------------------------------------------------------|-----------------|-------|--------|-------|---------|
| Deployment Cost | Deployment Size | | | | |
| 0 | 0 | | | | |
| Function Name | min | avg | median | max | # calls |
| approve | 46175 | 46239 | 46199 | 46367 | 679 |
| balanceOf | 561 | 2107 | 2561 | 2561 | 30744 |
| approve | 46175 | 46235 | 46199 | 46367 | 679 |
| balanceOf | 561 | 2108 | 2561 | 2561 | 30764 |


| script/Deploy.s.sol:Deploy contract | | | | | |
|-------------------------------------|-----------------|---------|---------|---------|---------|
| Deployment Cost | Deployment Size | | | | |
| 6118940 | 29538 | | | | |
| 6587720 | 31730 | | | | |
| Function Name | min | avg | median | max | # calls |
| run | 5316305 | 5316305 | 5316305 | 5316305 | 66 |
| run | 5755371 | 5755371 | 5755371 | 5755371 | 66 |


| script/DeployMigrationStakeManager.s.sol:DeployMigrationStakeManager contract | | | | | |
Expand Down Expand Up @@ -117,9 +117,9 @@
| test/script/DeployBroken.s.sol:DeployBroken contract | | | | | |
|------------------------------------------------------|-----------------|---------|---------|---------|---------|
| Deployment Cost | Deployment Size | | | | |
| 4803693 | 23336 | | | | |
| 5272431 | 25528 | | | | |
| Function Name | min | avg | median | max | # calls |
| run | 4156127 | 4156127 | 4156127 | 4156127 | 1 |
| run | 4595193 | 4595193 | 4595193 | 4595193 | 1 |



Expand Down
74 changes: 37 additions & 37 deletions .gas-snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
CreateVaultTest:testDeployment() (gas: 9774)
CreateVaultTest:test_createVault() (gas: 714022)
CreateVaultTest:test_createVault() (gas: 1145016)
ExecuteAccountTest:testDeployment() (gas: 28785)
ExecuteAccountTest:test_ExecuteAccountLimit() (gas: 1580255)
ExecuteAccountTest:test_ExecuteAccountMintMP() (gas: 5297777)
ExecuteAccountTest:test_RevertWhen_InvalidLimitEpoch() (gas: 1788412)
ExecuteAccountTest:test_ShouldNotMintMoreThanCap() (gas: 321397553)
ExecuteAccountTest:test_ExecuteAccountLimit() (gas: 2033714)
ExecuteAccountTest:test_ExecuteAccountMintMP() (gas: 6658154)
ExecuteAccountTest:test_RevertWhen_InvalidLimitEpoch() (gas: 2241871)
ExecuteAccountTest:test_ShouldNotMintMoreThanCap() (gas: 325025225)
ExecuteEpochTest:testDeployment() (gas: 28786)
ExecuteEpochTest:testNewDeployment() (gas: 30858)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterEpochEnd() (gas: 1366211)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterManyEpochsJumoMany() (gas: 1385045)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTime() (gas: 1629507)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTimeJumpMany() (gas: 1395200)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochAfterEnd() (gas: 1936210)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochs() (gas: 2523553)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochsJumoMany() (gas: 1479491)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTime() (gas: 2533729)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTimeJumpMany() (gas: 1489623)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterEpochEnd() (gas: 1819670)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterManyEpochsJumoMany() (gas: 1838504)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTime() (gas: 2082966)
ExecuteEpochTest:test_ExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTimeJumpMany() (gas: 1848659)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochAfterEnd() (gas: 2389669)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochs() (gas: 2977012)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochsJumoMany() (gas: 1932950)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTime() (gas: 2987188)
ExecuteEpochTest:test_ExecuteEpochExecuteEpochExecuteAccountAfterManyEpochsWithBrokenTimeJumpMany() (gas: 1943082)
ExecuteEpochTest:test_ExecuteEpochNewEpoch() (gas: 1122339)
ExecuteEpochTest:test_ExecuteEpochShouldIncreaseEpoch() (gas: 92413)
ExecuteEpochTest:test_ExecuteEpochShouldIncreasePendingReward() (gas: 256446)
ExecuteEpochTest:test_ExecuteEpochShouldNotIncreaseEpochBeforeEnd() (gas: 38984)
ExecuteEpochTest:test_ExecuteEpochShouldNotIncreaseEpochInMigration() (gas: 149638)
LeaveTest:testDeployment() (gas: 28763)
LeaveTest:test_RevertWhen_NoPendingMigration() (gas: 1327993)
LeaveTest:test_RevertWhen_NoPendingMigration() (gas: 1781536)
LeaveTest:test_RevertWhen_SenderIsNotVault() (gas: 31964)
LockTest:testDeployment() (gas: 28763)
LockTest:test_NewLockupPeriod() (gas: 1329045)
LockTest:test_RevertWhen_InvalidNewLockupPeriod() (gas: 1301374)
LockTest:test_RevertWhen_InvalidUpdateLockupPeriod() (gas: 1545884)
LockTest:test_NewLockupPeriod() (gas: 1782527)
LockTest:test_RevertWhen_InvalidNewLockupPeriod() (gas: 1754856)
LockTest:test_RevertWhen_InvalidUpdateLockupPeriod() (gas: 1999366)
LockTest:test_RevertWhen_SenderIsNotVault() (gas: 31856)
LockTest:test_ShouldIncreaseBonusMP() (gas: 1311575)
LockTest:test_UpdateLockupPeriod() (gas: 1634540)
LockTest:test_ShouldIncreaseBonusMP() (gas: 1765057)
LockTest:test_UpdateLockupPeriod() (gas: 2088045)
MigrateTest:testDeployment() (gas: 28763)
MigrateTest:test_RevertWhen_NoPendingMigration() (gas: 1292046)
MigrateTest:test_RevertWhen_NoPendingMigration() (gas: 1745528)
MigrateTest:test_RevertWhen_SenderIsNotVault() (gas: 31976)
MigrationInitializeTest:testDeployment() (gas: 28763)
MigrationInitializeTest:test_RevertWhen_MigrationPending() (gas: 5181388)
Expand All @@ -44,24 +44,24 @@ SetStakeManagerTest:test_RevertWhen_InvalidStakeManagerAddress() (gas: 63105)
SetStakeManagerTest:test_SetStakeManager() (gas: 41301)
StakeManagerTest:testDeployment() (gas: 28535)
StakeTest:testDeployment() (gas: 28741)
StakeTest:test_RevertWhen_InvalidLockupPeriod() (gas: 1080635)
StakeTest:test_RevertWhen_Restake() (gas: 1316847)
StakeTest:test_RevertWhen_RestakeWithLock() (gas: 1320861)
StakeTest:test_RevertWhen_InvalidLockupPeriod() (gas: 1556142)
StakeTest:test_RevertWhen_Restake() (gas: 1775486)
StakeTest:test_RevertWhen_RestakeWithLock() (gas: 1779500)
StakeTest:test_RevertWhen_SenderIsNotVault() (gas: 32018)
StakeTest:test_RevertWhen_StakeIsTooLow() (gas: 817762)
StakeTest:test_RevertWhen_StakeTokenTransferFails() (gas: 211363)
StakeTest:test_StakeWithLockBonusMP() (gas: 2357564)
StakeTest:test_StakeWithoutLockUpTimeMintsMultiplierPoints() (gas: 1322003)
StakedTokenTest:testStakeToken() (gas: 7616)
StakeTest:test_RevertWhen_StakeIsTooLow() (gas: 1251089)
StakeTest:test_RevertWhen_StakeTokenTransferFails() (gas: 229187)
StakeTest:test_StakeWithLockBonusMP() (gas: 3264505)
StakeTest:test_StakeWithoutLockUpTimeMintsMultiplierPoints() (gas: 1778561)
StakedTokenTest:testStakeToken() (gas: 7661)
UnstakeTest:testDeployment() (gas: 28785)
UnstakeTest:test_RevertWhen_AmountMoreThanBalance() (gas: 1297407)
UnstakeTest:test_RevertWhen_FundsLocked() (gas: 1342144)
UnstakeTest:test_RevertWhen_AmountMoreThanBalance() (gas: 1750908)
UnstakeTest:test_RevertWhen_FundsLocked() (gas: 1795687)
UnstakeTest:test_RevertWhen_SenderIsNotVault() (gas: 31857)
UnstakeTest:test_UnstakeShouldBurnMultiplierPoints() (gas: 6526945)
UnstakeTest:test_UnstakeShouldReturnFund_NoLockUp() (gas: 1319573)
UnstakeTest:test_UnstakeShouldReturnFund_WithLockUp() (gas: 1440205)
UnstakeTest:test_UnstakeShouldBurnMultiplierPoints() (gas: 6893844)
UnstakeTest:test_UnstakeShouldReturnFund_NoLockUp() (gas: 1776131)
UnstakeTest:test_UnstakeShouldReturnFund_WithLockUp() (gas: 1896763)
UserFlowsTest:testDeployment() (gas: 28763)
UserFlowsTest:test_PendingMPToBeMintedCannotBeGreaterThanTotalSupplyMP(uint8,uint128) (runs: 106, μ: 131402731, ~: 130856521)
UserFlowsTest:test_StakeWithLockUpTimeLocksStake() (gas: 1481301)
UserFlowsTest:test_StakedSupplyShouldIncreaseAndDecreaseAgain() (gas: 2494771)
UserFlowsTest:test_PendingMPToBeMintedCannotBeGreaterThanTotalSupplyMP(uint8,uint128) (runs: 106, μ: 134225064, ~: 133577563)
UserFlowsTest:test_StakeWithLockUpTimeLocksStake() (gas: 1937901)
UserFlowsTest:test_StakedSupplyShouldIncreaseAndDecreaseAgain() (gas: 3406943)
VaultFactoryTest:testDeployment() (gas: 9774)
Loading