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

[Certora] [M-10] + [M-11] Manual tracking of EETH shares owned by membership manager #197

Open
wants to merge 1 commit into
base: staging-2.5
Choose a base branch
from
Open

[Certora] [M-10] + [M-11] Manual tracking of EETH shares owned by membership manager #197

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
30 changes: 24 additions & 6 deletions src/MembershipManager.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade

IEtherFiAdmin public etherFiAdmin;

// Phase 2.5
uint256 public membershipShares;

//--------------------------------------------------------------------------------------
//------------------------------------- EVENTS ---------------------------------------
//--------------------------------------------------------------------------------------
Expand Down Expand Up @@ -99,6 +102,11 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade
admins[_etherFiAdminAddress] = true;
}

function initializeV2dot5() external onlyOwner {
require(membershipShares == 0, "already initialized");
membershipShares = eETH.shares(address(this));
}

error InvalidEAPRollover();

/// @notice EarlyAdopterPool users can re-deposit and mint a membership NFT claiming their points & tiers
Expand All @@ -123,7 +131,8 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade
uint40 loyaltyPoints = uint40(_min(_points, type(uint40).max));
uint40 tierPoints = membershipNFT.computeTierPointsForEap(_eapDepositBlockNumber);

liquidityPool.deposit{value: msg.value}(msg.sender, address(0));
uint256 mintedShares = liquidityPool.deposit{value: msg.value}(msg.sender, address(0));
membershipShares += mintedShares;

uint256 tokenId = _mintMembershipNFT(msg.sender, msg.value - _amountForPoints, _amountForPoints, loyaltyPoints, tierPoints);

Expand Down Expand Up @@ -167,10 +176,12 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade
(uint256 totalBalance, uint256 feeAmount) = _withdrawAndBurn(_tokenId);

// transfer 'eEthShares' of eETH to the owner
membershipShares -= liquidityPool.sharesForAmount(totalBalance - feeAmount);
eETH.transfer(msg.sender, totalBalance - feeAmount);

if (feeAmount > 0) {
liquidityPool.withdraw(address(this), feeAmount);
uint256 feeShares = liquidityPool.withdraw(address(this), feeAmount);
membershipShares += feeShares;
}

emit NftUnwrappedForEEth(msg.sender, _tokenId, totalBalance - feeAmount, loyaltyPoints, feeAmount);
Expand All @@ -187,7 +198,9 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade
claim(_tokenId);

uint256 additionalDeposit = _topUpDeposit(_tokenId, _amount, _amountForPoints);
liquidityPool.deposit{value: additionalDeposit}(msg.sender, address(0));
uint256 mintedShares = liquidityPool.deposit{value: additionalDeposit}(msg.sender, address(0));
membershipShares += mintedShares;

_emitNftUpdateEvent(_tokenId);
}

Expand Down Expand Up @@ -216,6 +229,7 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade

// send EETH to recipient before requesting withdraw?
eETH.approve(address(liquidityPool), _amount);
membershipShares -= liquidityPool.sharesForAmount(_amount);
uint256 withdrawTokenId = liquidityPool.requestMembershipNFTWithdraw(address(msg.sender), _amount, uint64(0));

_emitNftUpdateEvent(_tokenId);
Expand All @@ -236,6 +250,7 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade
(uint256 totalBalance, uint256 feeAmount) = _withdrawAndBurn(_tokenId);

eETH.approve(address(liquidityPool), totalBalance);
membershipShares -= liquidityPool.sharesForAmount(totalBalance);
uint256 withdrawTokenId = liquidityPool.requestMembershipNFTWithdraw(msg.sender, totalBalance, feeAmount);

return withdrawTokenId;
Expand Down Expand Up @@ -266,10 +281,11 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade

// The balance of MembershipManager contract is used to reward ether.fan stakers (not eETH stakers)
// Eth Rewards Amount per NFT = (eETH share amount of the NFT) * (total rewards ETH amount) / (total eETH share amount in ether.fan)
uint256 etherFanEEthShares = eETH.shares(address(this));
uint256 etherFanEEthShares = membershipShares;
uint256 thresholdAmount = fanBoostThresholdEthAmount();
if (address(this).balance >= thresholdAmount) {
uint256 mintedShare = liquidityPool.deposit{value: thresholdAmount}(address(this), address(0));
uint256 mintedShares = liquidityPool.deposit{value: thresholdAmount}(address(this), address(0));
membershipShares += mintedShares;
ethRewardsPerEEthShareAfterRebase += 1 ether * thresholdAmount / etherFanEEthShares;
}

Expand Down Expand Up @@ -457,7 +473,9 @@ contract MembershipManager is Initializable, OwnableUpgradeable, PausableUpgrade
}

function _wrapEth(uint256 _amount, uint256 _amountForPoints, address _referral) internal returns (uint256) {
liquidityPool.deposit{value: _amount + _amountForPoints}(msg.sender, _referral);
uint256 mintedShares = liquidityPool.deposit{value: _amount + _amountForPoints}(msg.sender, _referral);
membershipShares += mintedShares;

uint256 tokenId = _mintMembershipNFT(msg.sender, _amount, _amountForPoints, 0, 0);
_emitNftUpdateEvent(tokenId);
return tokenId;
Expand Down
9 changes: 8 additions & 1 deletion test/MembershipManager.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ contract MembershipManagerTest is TestSetup {


_upgradeMembershipManagerFromV0ToV1();

vm.prank(membershipManagerV1Instance.owner());
membershipManagerV1Instance.initializeV2dot5();
}

function test_withdrawalPenalty() public {
Expand Down Expand Up @@ -1037,7 +1040,7 @@ contract MembershipManagerTest is TestSetup {
uint256 requestId = membershipManagerV1Instance.requestWithdrawAndBurn(token);

_finalizeWithdrawalRequest(requestId);

vm.prank(actor);
withdrawRequestNFTInstance.claimWithdraw(requestId);

Expand All @@ -1059,6 +1062,10 @@ contract MembershipManagerTest is TestSetup {
// console.log("resting Rewards", liquidityPoolInstance.amountForShare(membershipManagerV1Instance.sharesReservedForRewards()));
assertEq(totalActorsBalance + address(liquidityPoolInstance).balance, totalMoneySupply);
// assertLe(membershipManagerV1Instance.sharesReservedForRewards(), eETHInstance.shares(address(membershipManagerV1Instance)));

// ensure after all operations that shares should be very close to zero minus rounding and slippage
uint256 roundingThreshold = 1 gwei;
assert(roundingThreshold - membershipManagerV1Instance.membershipShares() > 0);
}

function test_eap_migration() public {
Expand Down
1 change: 1 addition & 0 deletions test/TestSetup.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,6 +721,7 @@ contract TestSetup is Test {
whitelist[0] = address(weEthInstance);
whitelist[1] = address(liquidityPoolInstance);
eETHInstance.setWhitelistedSpender(whitelist, true);

}

function setupRoleRegistry() public {
Expand Down
Loading