Skip to content

Commit

Permalink
test: add dedicated tests for smaller scenarios
Browse files Browse the repository at this point in the history
  • Loading branch information
@0x-r4bbit
0x-r4bbit committed Sep 25, 2024
1 parent 24c3469 commit 826f707
Showing 1 changed file with 274 additions and 1 deletion.
275 changes: 274 additions & 1 deletion test/RewardsStreamerMP.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ contract RewardsStreamerMPTest is Test {
address charlie = makeAddr("charlie");
address dave = makeAddr("dave");

function setUp() public {
function setUp() public virtual {
rewardToken = new MockToken("Reward Token", "RT");
stakingToken = new MockToken("Staking Token", "ST");
streamer = new RewardsStreamerMP(address(stakingToken), address(rewardToken));
Expand Down Expand Up @@ -74,6 +74,28 @@ contract RewardsStreamerMPTest is Test {
assertEq(userInfo.userPotentialMP, p.userPotentialMP, "wrong user potential MP");
}

function _stake(address account, uint256 amount, uint256 lockupTime) public {
vm.prank(account);
streamer.stake(amount, lockupTime);
}

function _unstake(address account, uint256 amount) public {
vm.prank(account);
streamer.unstake(amount);
}

function _addReward(uint256 amount) public {
vm.prank(admin);
rewardToken.transfer(address(streamer), amount);
streamer.updateGlobalState();
}
}

contract IntegrationTest is RewardsStreamerMPTest {
function setUp() public virtual override {
super.setUp();
}

function testStake() public {
streamer.updateGlobalState();

Expand Down Expand Up @@ -411,3 +433,254 @@ contract RewardsStreamerMPTest is Test {
);
}
}

contract StakeTest is RewardsStreamerMPTest {
function setUp() public virtual override {
super.setUp();
}

function test_StakeOneAccount() public {
// Alice stakes 10 tokens
_stake(alice, 10e18, 0);

checkStreamer(
CheckStreamerParams({
totalStaked: 10e18,
totalMP: 10e18,
potentialMP: 40e18,
stakingBalance: 10e18,
rewardBalance: 0,
rewardIndex: 0,
accountedRewards: 0
})
);
checkUser(
CheckUserParams({
user: alice,
rewardBalance: 0,
stakedBalance: 10e18,
rewardIndex: 0,
userMP: 10e18,
userPotentialMP: 40e18
})
);
}

function test_StakeOneAccountAndRewards() public {
_stake(alice, 10e18, 0);

checkStreamer(
CheckStreamerParams({
totalStaked: 10e18,
totalMP: 10e18,
potentialMP: 40e18,
stakingBalance: 10e18,
rewardBalance: 0,
rewardIndex: 0,
accountedRewards: 0
})
);

checkUser(
CheckUserParams({
user: alice,
rewardBalance: 0,
stakedBalance: 10e18,
rewardIndex: 0,
userMP: 10e18,
userPotentialMP: 40e18
})
);

// 1000 rewards generated
_addReward(1000e18);

checkStreamer(
CheckStreamerParams({
totalStaked: 10e18,
totalMP: 10e18,
potentialMP: 40e18,
stakingBalance: 10e18,
rewardBalance: 1000e18,
rewardIndex: 50e18, // (1000 rewards / (10 staked + 10 MP)) = 50
accountedRewards: 1000e18
})
);
}

function test_StakeMultipleAccounts() public {
// Alice stakes 10 tokens
_stake(alice, 10e18, 0);

// Bob stakes 30 tokens
_stake(bob, 30e18, 0);

checkStreamer(
CheckStreamerParams({
totalStaked: 40e18,
totalMP: 40e18,
potentialMP: 160e18,
stakingBalance: 40e18,
rewardBalance: 0,
rewardIndex: 0,
accountedRewards: 0
})
);

checkUser(
CheckUserParams({
user: alice,
rewardBalance: 0,
stakedBalance: 10e18,
rewardIndex: 0,
userMP: 10e18,
userPotentialMP: 40e18
})
);

checkUser(
CheckUserParams({
user: bob,
rewardBalance: 0,
stakedBalance: 30e18,
rewardIndex: 0,
userMP: 30e18,
userPotentialMP: 120e18
})
);
}

function test_StakeMultipleAccountsAndRewards() public {
// Alice stakes 10 tokens
_stake(alice, 10e18, 0);

// Bob stakes 30 tokens
_stake(bob, 30e18, 0);

checkStreamer(
CheckStreamerParams({
totalStaked: 40e18,
totalMP: 40e18,
potentialMP: 160e18,
stakingBalance: 40e18,
rewardBalance: 0,
rewardIndex: 0,
accountedRewards: 0
})
);

checkUser(
CheckUserParams({
user: alice,
rewardBalance: 0,
stakedBalance: 10e18,
rewardIndex: 0,
userMP: 10e18,
userPotentialMP: 40e18
})
);

checkUser(
CheckUserParams({
user: bob,
rewardBalance: 0,
stakedBalance: 30e18,
rewardIndex: 0,
userMP: 30e18,
userPotentialMP: 120e18
})
);
// 1000 rewards generated
_addReward(1000e18);

checkStreamer(
CheckStreamerParams({
totalStaked: 40e18,
totalMP: 40e18,
potentialMP: 160e18,
stakingBalance: 40e18,
rewardBalance: 1000e18,
rewardIndex: 125e17, // (1000 rewards / (40 staked + 40 MP)) = 12,5
accountedRewards: 1000e18
})
);
}
}

contract UnstakeTest is StakeTest {
function setUp() public override {
super.setUp();
}

function test_UnstakeOneAccount() public {
test_StakeOneAccount();

_unstake(alice, 8e18);

checkStreamer(
CheckStreamerParams({
totalStaked: 2e18,
totalMP: 2e18,
potentialMP: 8e18,
stakingBalance: 2e18,
rewardBalance: 0,
rewardIndex: 0,
accountedRewards: 0
})
);

checkUser(
CheckUserParams({
user: alice,
rewardBalance: 0,
stakedBalance: 2e18,
rewardIndex: 0,
userMP: 2e18,
userPotentialMP: 8e18
})
);

_unstake(alice, 2e18);

checkStreamer(
CheckStreamerParams({
totalStaked: 0,
totalMP: 0,
potentialMP: 0,
stakingBalance: 0,
rewardBalance: 0,
rewardIndex: 0,
accountedRewards: 0
})
);
}

function test_UnstakeOneAccountAndRewards() public {
test_StakeOneAccountAndRewards();

_unstake(alice, 8e18);

checkStreamer(
CheckStreamerParams({
totalStaked: 2e18,
totalMP: 2e18,
potentialMP: 8e18,
stakingBalance: 2e18,
rewardBalance: 0, // rewards are all paid out to alice
rewardIndex: 50e18,
accountedRewards: 0
})
);

checkUser(
CheckUserParams({
user: alice,
rewardBalance: 1000e18,
stakedBalance: 2e18,
rewardIndex: 50e18, // alice reward index has been updated
userMP: 2e18,
userPotentialMP: 8e18
})
);
}
}

0 comments on commit 826f707

Please sign in to comment.