Skip to content

Generalize open_long & open_short test cases into InstanceTest suite #889

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

Merged
merged 21 commits into from
Mar 29, 2024
Merged

Generalize open_long & open_short test cases into InstanceTest suite #889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
329a9d0
First step, migrated open long test cases for stETH to testing suite
cashd Mar 26, 2024
918a05d
Migrated all yield sources to InstanceTestV2
cashd Mar 27, 2024
c5bd365
Removed duplicate AccountBalances and verifyDeposit functions
cashd Mar 27, 2024
600c748
Bigger delta for ezeth verifyDeposit
cashd Mar 27, 2024
93d3a99
remove unused code and comments
cashd Mar 27, 2024
570a5f1
cut down on sol warnings
cashd Mar 27, 2024
412e042
remove more comments
cashd Mar 27, 2024
4b1f5cf
Replace v1 with v2 InstanceTest
cashd Mar 27, 2024
b3190f6
natspec for rETH overrides and InstanceTest virtuals
cashd Mar 27, 2024
a20c799
comments in other instances
cashd Mar 27, 2024
5806382
fix build
cashd Mar 27, 2024
00fa7d1
Fix lint errors by asserting value stays the same in rETH and lsETH
cashd Mar 27, 2024
afd7960
address nits
cashd Mar 27, 2024
35cfe89
update func sig for getSupply
cashd Mar 28, 2024
95b38b5
added check for open long return value
cashd Mar 28, 2024
33f94d2
Generalize open short with share token test case
cashd Mar 28, 2024
5786aef
Add open short generalization to instance test
cashd Mar 28, 2024
bd15fea
better comments for open short cases
cashd Mar 28, 2024
d041bdd
Add checks for receiving correct amount of tokens
cashd Mar 28, 2024
985dc29
Update InstanceTest.sol
cashd Mar 28, 2024
777a085
Address comments
cashd Mar 29, 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
341 changes: 103 additions & 238 deletions test/instances/ezETH/EzETHHyperdrive.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,30 @@ contract EzETHHyperdriveTest is InstanceTest {
/// @dev Converts base amount to the equivalent about in EzETH.
function convertToShares(
uint256 baseAmount
) internal view override returns (uint256 shareAmount) {
) internal view override returns (uint256) {
// Get protocol state information used for calculating shares.
(uint256 sharePrice, , ) = getSharePrice();
return baseAmount.divDown(sharePrice);
}

/// @dev Converts share amount to the equivalent amount in ETH.
function convertToBase(
uint256 baseAmount
) internal view override returns (uint256) {
// Get the total TVL priced in ETH from RestakeManager.
(, , uint256 totalTVL) = RESTAKE_MANAGER.calculateTVLs();

// Get the total supply of the ezETH token.
uint256 totalSupply = EZETH.totalSupply();

return
RENZO_ORACLE.calculateRedeemAmount(
baseAmount,
totalSupply,
totalTVL
);
}

/// @dev Deploys the EzETH deployer coordinator contract.
function deployCoordinator() internal override returns (address) {
vm.startPrank(alice);
Expand All @@ -114,6 +132,88 @@ contract EzETHHyperdriveTest is InstanceTest {
);
}

/// @dev Fetches the token balance information of an account.
function getTokenBalances(
address account
) internal view override returns (uint256, uint256) {
// EzETH does not have a convenient function for fetching base balance.
return (0, EZETH.balanceOf(account));
}

/// @dev Fetches the total supply of the base and share tokens.
function getSupply() internal view override returns (uint256, uint256) {
(, uint256 totalPooledEther, ) = getSharePrice();
return (totalPooledEther, EZETH.totalSupply());
}

/// @dev Verifies that deposit accounting is correct when opening positions.
function verifyDeposit(
address trader,
uint256 basePaid,
bool asBase,
uint256 totalBaseSupplyBefore,
uint256 totalSharesBefore,
AccountBalances memory traderBalancesBefore,
AccountBalances memory hyperdriveBalancesBefore
) internal override {
if (asBase) {
// Ensure that the amount of pooled ether increased by the base paid.
(, uint256 totalPooledEther, ) = getSharePrice();
assertEq(totalPooledEther, totalBaseSupplyBefore + basePaid);

// Ensure that the ETH balances were updated correctly.
assertEq(
address(hyperdrive).balance,
hyperdriveBalancesBefore.ETHBalance
);
assertEq(bob.balance, traderBalancesBefore.ETHBalance - basePaid);

// Ensure ezETH shares were updated correctly.
assertEq(
EZETH.balanceOf(trader),
traderBalancesBefore.sharesBalance
);

// Ensure that the ezETH shares were updated correctly.
uint256 expectedShares = RENZO_ORACLE.calculateMintAmount(
totalBaseSupplyBefore,
basePaid,
totalSharesBefore
);
assertEq(EZETH.totalSupply(), totalSharesBefore + expectedShares);
assertEq(
EZETH.balanceOf(address(hyperdrive)),
hyperdriveBalancesBefore.sharesBalance + expectedShares
);
assertEq(EZETH.balanceOf(bob), traderBalancesBefore.sharesBalance);
} else {
// Ensure that the amount of pooled ether stays the same.
(, uint256 totalPooledEther, ) = getSharePrice();
assertEq(totalPooledEther, totalBaseSupplyBefore);

// Ensure that the ETH balances were updated correctly.
assertEq(
address(hyperdrive).balance,
hyperdriveBalancesBefore.ETHBalance
);
assertEq(trader.balance, traderBalancesBefore.ETHBalance);

// Ensure that the ezETH shares were updated correctly.
uint256 expectedShares = convertToShares(basePaid);
assertEq(EZETH.totalSupply(), totalSharesBefore);
assertApproxEqAbs(
EZETH.balanceOf(address(hyperdrive)),
hyperdriveBalancesBefore.sharesBalance + expectedShares,
2 // Higher tolerance due to rounding when converting back into shares.
);
assertApproxEqAbs(
EZETH.balanceOf(trader),
traderBalancesBefore.sharesBalance - expectedShares,
2 // Higher tolerance due to rounding when converting back into shares.
);
}
}

/// Getters ///

function test_getters() external {
Expand Down Expand Up @@ -184,74 +284,6 @@ contract EzETHHyperdriveTest is InstanceTest {

/// Long ///

function test_open_long_with_eth(uint256 basePaid) external {
// Bob opens a long by depositing ETH.
basePaid = basePaid.normalizeToRange(
2 * hyperdrive.getPoolConfig().minimumTransactionAmount,
HyperdriveUtils.calculateMaxLong(hyperdrive)
);

// Ensure that we get an UnsupportedToken error. Opening positions
// with ETH are not allowed right now. There is a great enough
// precision loss when minting ezeth that warrants some investigation
// before we can turn this on. Until then, we can zap ezeth into the
// pool.
vm.expectRevert(IHyperdrive.NotPayable.selector);
hyperdrive.openLong{ value: basePaid }(
basePaid,
0, // min bond proceeds
0, // min vault share price
IHyperdrive.Options({
destination: bob,
asBase: true,
extraData: new bytes(0)
})
);
}

function test_open_long_with_ezeth(uint256 basePaid) external {
vm.stopPrank();
vm.startPrank(bob);

// Get some balance information before the deposit.
(
,
uint256 totalPooledEtherBefore,
uint256 totalSharesBefore
) = getSharePrice();
AccountBalances memory bobBalancesBefore = getAccountBalances(bob);
AccountBalances memory hyperdriveBalancesBefore = getAccountBalances(
address(hyperdrive)
);

// Calculate the maximum amount of basePaid we can test.
uint256 maxLong = HyperdriveUtils.calculateMaxLong(hyperdrive);
uint256 maxEzEth = EZETH.balanceOf(address(bob));
uint256 maxRange = maxLong > maxEzEth ? maxEzEth : maxLong;
basePaid = basePaid.normalizeToRange(
2 * hyperdrive.getPoolConfig().minimumTransactionAmount,
maxRange
);

// Convert to shares and approve hyperdrive.
uint256 sharesPaid = getAndApproveShares(basePaid);

// Open the position.
openLong(bob, sharesPaid, false);

// Ensure that Renzo's aggregates and the token balances were updated
// correctly during the trade.
verifyDeposit(
bob,
basePaid,
false,
totalPooledEtherBefore,
totalSharesBefore,
bobBalancesBefore,
hyperdriveBalancesBefore
);
}

function test_close_long_with_eth(uint256 basePaid) external {
vm.stopPrank();
vm.startPrank(bob);
Expand Down Expand Up @@ -364,88 +396,6 @@ contract EzETHHyperdriveTest is InstanceTest {

// /// Short ///

function test_open_short_with_eth(uint256 shortAmount) external {
vm.stopPrank();
vm.startPrank(bob);

// Bob opens a short by depositing ETH.
shortAmount = shortAmount.normalizeToRange(
2 * hyperdrive.getPoolConfig().minimumTransactionAmount,
HyperdriveUtils.calculateMaxShort(hyperdrive)
);

// Ensure that we get an UnsupportedToken error. Opening positions
// with ETH are not allowed right now. There is a great enough
// precision loss when minting ezeth that warrants some investigation
// before we can turn this on. Until then, we can zap ezeth into the
// pool.
vm.expectRevert(IHyperdrive.NotPayable.selector);
hyperdrive.openShort{ value: shortAmount }(
shortAmount,
shortAmount,
0,
IHyperdrive.Options({
destination: bob,
asBase: true,
extraData: new bytes(0)
})
);
}

function test_open_short_with_ezeth(uint256 shortAmount) external {
vm.stopPrank();
vm.startPrank(bob);

// Get some balance information before the deposit.
(
,
uint256 totalPooledEtherBefore,
uint256 totalSharesBefore
) = getSharePrice();
AccountBalances memory bobBalancesBefore = getAccountBalances(bob);
AccountBalances memory hyperdriveBalancesBefore = getAccountBalances(
address(hyperdrive)
);

// Calculate the maximum amount we can short.
shortAmount = shortAmount.normalizeToRange(
2 * hyperdrive.getPoolConfig().minimumTransactionAmount,
HyperdriveUtils.calculateMaxShort(hyperdrive)
);

// Bob opens a short by depositing ezETH.
EZETH.approve(address(hyperdrive), shortAmount);
(, uint256 sharesPaid) = openShort(bob, shortAmount, false);

// Get the base Bob paid for the short.
(, uint256 totalPooledEther, uint256 totalShares) = getSharePrice();
uint256 basePaid = sharesPaid.mulDivDown(totalPooledEther, totalShares);

// Ensure that the amount of base paid by the short is reasonable.
uint256 realizedRate = HyperdriveUtils.calculateAPRFromRealizedPrice(
shortAmount - basePaid,
shortAmount,
1e18
);
assertGt(basePaid, 0);
assertGe(
realizedRate,
FIXED_RATE.mulDown(POSITION_DURATION_15_DAYS.divDown(365 days))
);

// Ensure that Renzo's aggregates and the token balances were updated
// correctly during the trade.
verifyDeposit(
bob,
basePaid,
false,
totalPooledEtherBefore,
totalSharesBefore,
bobBalancesBefore,
hyperdriveBalancesBefore
);
}

function test_open_short_refunds() external {
vm.startPrank(bob);

Expand Down Expand Up @@ -651,76 +601,6 @@ contract EzETHHyperdriveTest is InstanceTest {
);
}

function verifyDeposit(
address trader,
uint256 basePaid,
bool asBase,
uint256 totalPooledEtherBefore,
uint256 totalSharesBefore,
AccountBalances memory traderBalancesBefore,
AccountBalances memory hyperdriveBalancesBefore
) internal {
if (asBase) {
// Ensure that the amount of pooled ether increased by the base paid.
(, uint256 totalPooledEther, ) = getSharePrice();
assertEq(totalPooledEther, totalPooledEtherBefore + basePaid);

// Ensure that the ETH balances were updated correctly.
assertEq(
address(hyperdrive).balance,
hyperdriveBalancesBefore.ETHBalance
);
assertEq(bob.balance, traderBalancesBefore.ETHBalance - basePaid);

// Ensure ezETH shares were updated correctly.
assertEq(
EZETH.balanceOf(trader),
traderBalancesBefore.ezethBalance
);

// Ensure that the ezETH shares were updated correctly.
uint256 expectedShares = RENZO_ORACLE.calculateMintAmount(
totalPooledEtherBefore,
basePaid,
totalSharesBefore
);
assertEq(EZETH.totalSupply(), totalSharesBefore + expectedShares);
assertEq(
EZETH.balanceOf(address(hyperdrive)),
hyperdriveBalancesBefore.ezethBalance + expectedShares
);
assertEq(EZETH.balanceOf(bob), traderBalancesBefore.ezethBalance);
} else {
// Ensure that the amount of pooled ether stays the same.
(, uint256 totalPooledEther, ) = getSharePrice();
assertEq(totalPooledEther, totalPooledEtherBefore);

// Ensure that the ETH balances were updated correctly.
assertEq(
address(hyperdrive).balance,
hyperdriveBalancesBefore.ETHBalance
);
assertEq(trader.balance, traderBalancesBefore.ETHBalance);

// Ensure that the ezETH shares were updated correctly.
uint256 expectedShares = basePaid.mulDivDown(
totalSharesBefore,
totalPooledEtherBefore
);
assertEq(EZETH.totalSupply(), totalSharesBefore);
assertApproxEqAbs(
EZETH.balanceOf(address(hyperdrive)),
hyperdriveBalancesBefore.ezethBalance + expectedShares,
1
);
assertApproxEqAbs(
EZETH.balanceOf(trader),
traderBalancesBefore.ezethBalance - expectedShares,
1
);
}
}

function verifyEzethWithdrawal(
address trader,
uint256 baseProceeds,
Expand Down Expand Up @@ -748,12 +628,12 @@ contract EzETHHyperdriveTest is InstanceTest {
);
assertApproxEqAbs(
EZETH.balanceOf(address(hyperdrive)),
hyperdriveBalancesBefore.ezethBalance - expectedShares,
hyperdriveBalancesBefore.sharesBalance - expectedShares,
1
);
assertApproxEqAbs(
EZETH.balanceOf(trader),
traderBalancesBefore.ezethBalance + expectedShares,
traderBalancesBefore.sharesBalance + expectedShares,
1
);
}
Expand Down Expand Up @@ -804,21 +684,6 @@ contract EzETHHyperdriveTest is InstanceTest {
}
}

struct AccountBalances {
uint256 ezethBalance;
uint256 ETHBalance;
}

function getAccountBalances(
address account
) internal view returns (AccountBalances memory) {
return
AccountBalances({
ezethBalance: EZETH.balanceOf(account),
ETHBalance: account.balance
});
}

// returns share price information.
function getSharePrice()
internal
Expand Down
Loading