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: added test for claiming rewards on 0 deposit gauge #331

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

feat: added test for claiming rewards on 0 deposit gauge #331

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1a7102
feat: added test for claiming rewards on 0 deposit gauge
lilPlumberBoy Apr 12, 2024
159a053
fix: corrected test to claim rewards
lilPlumberBoy Apr 12, 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
70 changes: 69 additions & 1 deletion test/unit/rewards/ERC20RewardsGauge.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.18;

import { BaseTest } from "test/utils/BaseTest.t.sol";
import { BaseTest, console2 } from "test/utils/BaseTest.t.sol";
import { ERC20RewardsGauge, BaseRewardsGauge } from "src/rewards/ERC20RewardsGauge.sol";
import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
Expand Down Expand Up @@ -267,6 +267,7 @@ contract ERC20RewardsGauge_Test is BaseTest {
assertEq(rewardData.lastUpdate, block.timestamp);
assertEq(rewardData.integral, 0);
assertEq(rewardData.leftOver, rewardAmount % _WEEK);
console2.log("total supply: ", rewardsGauge.totalSupply());
}

function testFuzz_depositRewardToken_withPartialRewardRemaining(
Expand Down Expand Up @@ -426,6 +427,73 @@ contract ERC20RewardsGauge_Test is BaseTest {
assertEq(dummyRewardToken.balanceOf(alice), 0);
}

function testFuzz_claimeRewards_afterZeroDepositsForRewardDuration(uint256 rewardAmount, uint256 amount) public {
amount = bound(amount, 1, type(uint128).max);
rewardAmount = bound(rewardAmount, Math.max(1e9, amount / 1e15), type(uint128).max);
airdrop(dummyRewardToken, admin, rewardAmount);
vm.prank(manager);
rewardsGauge.addReward(address(dummyRewardToken), admin);
vm.startPrank(admin);
dummyRewardToken.approve(address(rewardsGauge), rewardAmount);
vm.expectEmit();
emit RewardTokenDeposited(address(dummyRewardToken), rewardAmount, rewardAmount / _WEEK, block.timestamp);
rewardsGauge.depositRewardToken(address(dummyRewardToken), rewardAmount);
BaseRewardsGauge.Reward memory rewardData = rewardsGauge.getRewardData(address(dummyRewardToken));
assertEq(rewardData.distributor, admin);
assertEq(rewardData.periodFinish, block.timestamp + 1 weeks);
assertEq(rewardData.rate, rewardAmount / _WEEK);
assertEq(rewardData.lastUpdate, block.timestamp);
assertEq(rewardData.integral, 0);
assertEq(rewardData.leftOver, rewardAmount % _WEEK);
assertEq(rewardsGauge.totalSupply(), 0);
// Warp to after rewards are done distributing
vm.warp(rewardData.periodFinish + 1);
// User deposits now
// alice gets some mockgauge tokens by depositing dummy token
airdrop(dummyGaugeAsset, alice, amount);
vm.startPrank(alice);
dummyGaugeAsset.approve(address(rewardsGauge), amount);
rewardsGauge.deposit(amount, alice);
assertEq(rewardsGauge.balanceOf(alice), amount, "alice should have received shares 1:1");
// alice's claimable rewards should be 0 at this block
assertApproxEqRel(
rewardAmount,
rewardsGauge.claimableReward(alice, address(dummyRewardToken)),
0.005 * 1e18,
"alice should receive unclaimed rewards"
);
uint256 aliceBalanceBefore = dummyRewardToken.balanceOf(alice);
// alice claims rewards
rewardsGauge.claimRewards(alice, alice);
// alice's claimable rewards should be 0 after claiming
assertEq(
0,
rewardsGauge.claimableReward(alice, address(dummyRewardToken)),
"alice should have 0 claimable rewards after claiming"
);
uint256 newAliceBalance = dummyRewardToken.balanceOf(alice) - aliceBalanceBefore;
// alices balance should be close to the reward amount
assertApproxEqRel(
rewardAmount,
newAliceBalance,
0.005 * 1e18,
"alice should have received the full reward amount minus the adjustment"
);
// check that the integral was updated after claiming
uint256 integral = rewardsGauge.getRewardData(address(dummyRewardToken)).integral;
assertGt(integral, 0);
// alices claimed rewards should have increase by the claimed amount
assertEq(
rewardsGauge.claimedReward(alice, address(dummyRewardToken)),
newAliceBalance,
"alice should have claimed rewards equal to the total amount of reward tokens deposited"
);
// check that claimable rewards was correct
assertApproxEqRel(
newAliceBalance, rewardAmount, 0.005 * 1e18, "claimable rewards should be equal to the claimed amount"
);
}

function testFuzz_claimRewards_multipleRewards(uint256 amount, uint256[8] memory rewardAmounts) public {
amount = bound(amount, 1, type(uint128).max);
for (uint256 i = 0; i < rewardAmounts.length; i++) {
Expand Down
Loading