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

Add Test Cases For MultiTokenVault #165

Merged
merged 7 commits into from
Oct 28, 2024
Merged

Add Test Cases For MultiTokenVault #165

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8593697
:white_check_mark: Add Test Cases
nawar-hisso Oct 25, 2024
9117a32
:fire: Remove Comments
nawar-hisso Oct 25, 2024
769fee7
Tweaked to allow setting of a custom `maxDeposit` while also accessin…
jplodge-pro Oct 28, 2024
ef8d68b
Added the Branch Coverage option to the `genhtml` invocation.
jplodge-pro Oct 28, 2024
8288924
Added a test case for Max Deposit being exceeded on deposit.
jplodge-pro Oct 28, 2024
323511c
:twisted_rightwards_arrows: Merge
nawar-hisso Oct 28, 2024
0341366
:fire: Remove Unused Code
nawar-hisso Oct 28, 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
182 changes: 182 additions & 0 deletions packages/contracts/test/src/token/ERC1155/MultiTokenVaultTest.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ contract MultiTokenVaultTest is IMultiTokenVaultTestBase {
uint256 redeemPeriod = 2001;

TestParamSet.TestParam[] memory _batchTestParams = new TestParamSet.TestParam[](3);
TestParamSet.TestParam[] memory _batchTestParamsToRevert = new TestParamSet.TestParam[](2);

_batchTestParams[0] =
TestParamSet.TestParam({ principal: 1001 * _scale, depositPeriod: 1, redeemPeriod: redeemPeriod });
Expand All @@ -246,15 +247,30 @@ contract MultiTokenVaultTest is IMultiTokenVaultTestBase {
_batchTestParams[2] =
TestParamSet.TestParam({ principal: 3003 * _scale, depositPeriod: 303, redeemPeriod: redeemPeriod });

_batchTestParamsToRevert[0] =
TestParamSet.TestParam({ principal: 1001 * _scale, depositPeriod: 1, redeemPeriod: redeemPeriod });
_batchTestParamsToRevert[1] =
TestParamSet.TestParam({ principal: 2002 * _scale, depositPeriod: 202, redeemPeriod: redeemPeriod });

IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);
TestParamSet.TestUsers memory testUsers = TestParamSet.toSingletonUsers(_alice);

uint256[] memory shares = _testDepositOnly(testUsers, vault, _batchTestParams);
uint256[] memory depositPeriods = _batchTestParams.depositPeriods();
uint256[] memory depositPeriodsToRevert = _batchTestParamsToRevert.depositPeriods();

// ------------------------ batch convert to assets ------------------------
uint256[] memory assets = vault.convertToAssetsForDepositPeriodBatch(shares, depositPeriods, redeemPeriod);

vm.expectRevert(
abi.encodeWithSelector(
MultiTokenVault.MultiTokenVault__InvalidArrayLength.selector,
depositPeriodsToRevert.length,
shares.length
)
);
vault.convertToAssetsForDepositPeriodBatch(shares, depositPeriodsToRevert, redeemPeriod);

assertEq(3, assets.length, "assets are wrong length");
assertEq(
assets[0],
Expand Down Expand Up @@ -286,6 +302,172 @@ contract MultiTokenVaultTest is IMultiTokenVaultTestBase {
_testBalanceOfBatch(_charlie, vault, _batchTestParams, assetToSharesRatio); // verify bob
}

function test__MultiTokenVaulTest__SafeTransferFrom() public {
uint256 assetToSharesRatio = 2;

TestParamSet.TestParam memory testParams =
TestParamSet.TestParam({ principal: 100 * _scale, depositPeriod: 0, redeemPeriod: 10 });

// Step 1: Create and set up the vault
IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

// Step 2: Deposit some assets for _alice to receive shares
vm.startPrank(_alice);
_asset.approve(address(vault), testParams.principal);
uint256 shares = vault.deposit(testParams.principal, _alice);
vm.stopPrank();

// Verify _alice has received the shares
assertEq(
vault.balanceOf(_alice, testParams.depositPeriod), shares, "_alice should have the shares after deposit"
);

// Step 3: Perform the safe transfer from _alice to _bob
vm.startPrank(_alice);
vault.safeTransferFrom(_alice, _bob, testParams.depositPeriod, shares, "");
vm.stopPrank();

// Step 4: Verify the transfer was successful
assertEq(vault.balanceOf(_alice, testParams.depositPeriod), 0, "_alice should have no shares after transfer");
assertEq(vault.balanceOf(_bob, testParams.depositPeriod), shares, "_bob should have the transferred shares");
}

function test__MultiTokenVaulTest__ConvertToSharesForDepositPeriod() public {
jplodge-pro marked this conversation as resolved.
Show resolved Hide resolved
// Assuming the asset to shares ratio is set to a fixed value for testing.
uint256 assetToSharesRatio = 2;
uint256 depositPeriod = 1;

// Step 1: Create and initialize the vault with a dummy asset
IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

// Typical Case: Convert a positive asset amount to shares
uint256 assets = 500 * _scale;
uint256 expectedShares = assets / assetToSharesRatio;
uint256 shares = vault.convertToSharesForDepositPeriod(assets, depositPeriod);
assertEq(shares, expectedShares, "Conversion to shares did not match expected value");

// Edge Case: Convert zero assets to shares
assets = 0;
expectedShares = 0;
shares = vault.convertToSharesForDepositPeriod(assets, depositPeriod);
assertEq(shares, expectedShares, "Conversion of zero assets to shares failed");

// Edge Case: Convert maximum assets to shares
assets = type(uint256).max;
expectedShares = assets / assetToSharesRatio;
shares = vault.convertToSharesForDepositPeriod(assets, depositPeriod);
assertEq(shares, expectedShares, "Conversion of max assets to shares failed");
}

function test__MultiTokenVaulTest__ConvertToAssetsForDepositPeriod() public {
uint256 assetToSharesRatio = 2;

TestParamSet.TestParam memory testParams =
TestParamSet.TestParam({ principal: 500 * _scale, depositPeriod: 0, redeemPeriod: 30 });

// Step 1: Create and initialize the vault with a dummy asset
IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

// Typical Case: Convert a positive share amount to assets
uint256 shares = testParams.principal / assetToSharesRatio;
uint256 expectedAssets = shares * assetToSharesRatio + _expectedReturns(shares, vault, testParams);
uint256 assets =
vault.convertToAssetsForDepositPeriod(shares, testParams.depositPeriod, testParams.redeemPeriod);
assertEq(assets, expectedAssets, "Conversion to assets did not match expected value");

// Edge Case: Convert zero shares to assets
shares = 0;
expectedAssets = 0;
assets = vault.convertToAssetsForDepositPeriod(shares, testParams.depositPeriod, testParams.redeemPeriod);
assertEq(assets, expectedAssets, "Conversion of zero shares to assets failed");

// Edge Case: Convert maximum shares to assets
testParams =
TestParamSet.TestParam({ principal: type(uint128).max * _scale, depositPeriod: 0, redeemPeriod: 30 });
shares = testParams.principal / assetToSharesRatio;
expectedAssets = shares * assetToSharesRatio + _expectedReturns(shares, vault, testParams);
assets = vault.convertToAssetsForDepositPeriod(shares, testParams.depositPeriod, testParams.redeemPeriod);
assertEq(assets, expectedAssets, "Conversion of max shares to assets failed");
}

function test__MultiTokenVaulTest__PreviewDeposit() public {
uint256 assetToSharesRatio = 2;

TestParamSet.TestParam memory testParams =
TestParamSet.TestParam({ principal: 500 * _scale, depositPeriod: 0, redeemPeriod: 30 });

uint256 expectedShares = testParams.principal / assetToSharesRatio;

IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

uint256 shares = vault.previewDeposit(testParams.principal);
assertEq(shares, expectedShares, "Preview deposit conversion did not match expected value");
}

function test__MultiTokenVaulTest__PreviewRedeemForDepositPeriod() public {
uint256 assetToSharesRatio = 2;

TestParamSet.TestParam memory testParams =
TestParamSet.TestParam({ principal: 500 * _scale, depositPeriod: 0, redeemPeriod: 30 });

IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

uint256 shares = testParams.principal / assetToSharesRatio;
uint256 expectedAssets = shares * assetToSharesRatio + _expectedReturns(shares, vault, testParams);

uint256 assets = vault.previewRedeemForDepositPeriod(shares, testParams.depositPeriod);
assertEq(assets, expectedAssets, "Preview redeem conversion did not match expected value");
}

function test__MultiTokenVaulTest__IsApprovedForAll() public {
address operator = makeAddr("operator");
uint256 assetToSharesRatio = 2;

IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

// Set approval
vm.prank(_alice);
vault.setApprovalForAll(operator, true);

// Check if the operator is approved
bool isApproved = vault.isApprovedForAll(_alice, operator);
assertEq(isApproved, true, "Operator should be approved");

// Revoke approval and check
vm.prank(_alice);
vault.setApprovalForAll(operator, false);
isApproved = vault.isApprovedForAll(_alice, operator);
assertEq(isApproved, false, "Operator should not be approved");
}

function test__MultiTokenVaulTest__MaxDeposit() public {
uint256 assetToSharesRatio = 2;

IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

uint256 maxDepositValue = vault.maxDeposit(_alice);
assertEq(maxDepositValue, type(uint256).max, "Max deposit should be uint256 max");
}

function test__MultiTokenVaulTest__MaxRedeemAtPeriod() public {
uint256 assetToSharesRatio = 2;

TestParamSet.TestParam memory testParams =
TestParamSet.TestParam({ principal: 500 * _scale, depositPeriod: 0, redeemPeriod: 30 });

IMultiTokenVault vault = _createMultiTokenVault(_asset, assetToSharesRatio, 10);

// Alice deposits assets and receives shares
vm.startPrank(_alice);
_asset.approve(address(vault), testParams.principal);
uint256 shares = vault.deposit(testParams.principal, _alice);
vm.stopPrank();

// Check max redeemable shares for the deposit period
uint256 maxShares = vault.maxRedeemAtPeriod(_alice, testParams.depositPeriod); // Assuming deposit period = 1
assertEq(maxShares, shares, "Max redeemable shares did not match the deposited shares");
}

function _testBalanceOfBatch(
address account,
IMultiTokenVault vault,
Expand Down