vacp2p/staking-reward-streamer
1
0
Fork 0
mirror of https://github.com/vacp2p/staking-reward-streamer.git synced 2026-01-09 21:18:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore: formatting with the new foundry config

Browse Source
This commit is contained in:
Andrea Franz
2024-09-23 16:51:52 +02:00
committed by r4bbit
parent 25f44c3037
commit 0871bdfad7
6 changed files with 38 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
script/RewardsStreamer.s.sol
View File

@@ -1,13 +1,13 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Script, console} from "forge-std/Script.sol";
import {RewardsStreamer} from "../src/RewardsStreamer.sol";
import { Script, console } from "forge-std/Script.sol";
import { RewardsStreamer } from "../src/RewardsStreamer.sol";
contract RewardsStreamerScript is Script {
RewardsStreamer public rewardsStreamer;
function setUp() public {}
function setUp() public { }
function run() public {
vm.startBroadcast();

4
src/RewardsStreamer.sol
View File

@@ -1,8 +1,8 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { ReentrancyGuard } from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
contract RewardsStreamer is ReentrancyGuard {
error StakingManager__AmountCannotBeZero();

4
src/RewardsStreamerMP.sol
View File

@@ -1,8 +1,8 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { ReentrancyGuard } from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
// Rewards Streamer with Multiplier Points
contract RewardsStreamerMP is ReentrancyGuard {

36
test/RewardsStreamer.t.sol
View File

@@ -1,9 +1,9 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Test, console} from "forge-std/Test.sol";
import {RewardsStreamer} from "../src/RewardsStreamer.sol";
import {MockToken} from "./mocks/MockToken.sol";
import { Test, console } from "forge-std/Test.sol";
import { RewardsStreamer } from "../src/RewardsStreamer.sol";
import { MockToken } from "./mocks/MockToken.sol";
contract RewardsStreamerTest is Test {
MockToken rewardToken;
@@ -122,8 +122,8 @@ contract RewardsStreamerTest is Test {
})
);
checkUser(CheckUserParams({user: alice, rewardBalance: 0, stakedBalance: 10e18, rewardIndex: 0}));
checkUser(CheckUserParams({user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0}));
checkUser(CheckUserParams({ user: alice, rewardBalance: 0, stakedBalance: 10e18, rewardIndex: 0 }));
checkUser(CheckUserParams({ user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0 }));
// T4
vm.prank(alice);
@@ -139,8 +139,8 @@ contract RewardsStreamerTest is Test {
})
);
checkUser(CheckUserParams({user: alice, rewardBalance: 250e18, stakedBalance: 0e18, rewardIndex: 25e18}));
checkUser(CheckUserParams({user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0}));
checkUser(CheckUserParams({ user: alice, rewardBalance: 250e18, stakedBalance: 0e18, rewardIndex: 25e18 }));
checkUser(CheckUserParams({ user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0 }));
// T5
vm.prank(charlie);
@@ -156,9 +156,9 @@ contract RewardsStreamerTest is Test {
})
);
checkUser(CheckUserParams({user: alice, rewardBalance: 250e18, stakedBalance: 0e18, rewardIndex: 25e18}));
checkUser(CheckUserParams({user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0}));
checkUser(CheckUserParams({user: charlie, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 25e18}));
checkUser(CheckUserParams({ user: alice, rewardBalance: 250e18, stakedBalance: 0e18, rewardIndex: 25e18 }));
checkUser(CheckUserParams({ user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0 }));
checkUser(CheckUserParams({ user: charlie, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 25e18 }));
// T6
vm.prank(admin);
@@ -170,14 +170,14 @@ contract RewardsStreamerTest is Test {
totalStaked: 60e18,
stakingBalance: 60e18,
rewardBalance: 1750e18,
rewardIndex: 41666666666666666666,
rewardIndex: 41_666_666_666_666_666_666,
accountedRewards: 1750e18
})
);
checkUser(CheckUserParams({user: alice, rewardBalance: 250e18, stakedBalance: 0, rewardIndex: 25e18}));
checkUser(CheckUserParams({user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0}));
checkUser(CheckUserParams({user: charlie, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 25e18}));
checkUser(CheckUserParams({ user: alice, rewardBalance: 250e18, stakedBalance: 0, rewardIndex: 25e18 }));
checkUser(CheckUserParams({ user: bob, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 0 }));
checkUser(CheckUserParams({ user: charlie, rewardBalance: 0, stakedBalance: 30e18, rewardIndex: 25e18 }));
//T7
vm.prank(bob);
@@ -188,18 +188,18 @@ contract RewardsStreamerTest is Test {
totalStaked: 30e18,
stakingBalance: 30e18,
rewardBalance: 500e18 + 20, // 500e18 (with rounding error of 20 wei)
rewardIndex: 41666666666666666666,
rewardIndex: 41_666_666_666_666_666_666,
accountedRewards: 500e18 + 20
})
);
checkUser(CheckUserParams({user: alice, rewardBalance: 250e18, stakedBalance: 0, rewardIndex: 25e18}));
checkUser(CheckUserParams({ user: alice, rewardBalance: 250e18, stakedBalance: 0, rewardIndex: 25e18 }));
checkUser(
CheckUserParams({
user: bob,
rewardBalance: 1249999999999999999980, // 750e18 + 500e18 (with rounding error)
rewardBalance: 1_249_999_999_999_999_999_980, // 750e18 + 500e18 (with rounding error)
stakedBalance: 0,
rewardIndex: 41666666666666666666
rewardIndex: 41_666_666_666_666_666_666
})
);
}

21
test/RewardsStreamerMP.t.sol
View File

@@ -1,9 +1,9 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {Test, console} from "forge-std/Test.sol";
import {RewardsStreamerMP} from "../src/RewardsStreamerMP.sol";
import {MockToken} from "./mocks/MockToken.sol";
import { Test, console } from "forge-std/Test.sol";
import { RewardsStreamerMP } from "../src/RewardsStreamerMP.sol";
import { MockToken } from "./mocks/MockToken.sol";
import "forge-std/console.sol";
contract RewardsStreamerMPTest is Test {
@@ -222,7 +222,8 @@ contract RewardsStreamerMPTest is Test {
CheckStreamerParams({
totalStaked: 30e18,
totalMP: 45e18, // 60 - 15 from Alice (10 + 6 months = 5)
potentialMP: 105e18, // Alice's initial potential MP: 40. 5 already accrued in 6 months. new potentialMP = 140 - 35 = 105
potentialMP: 105e18, // Alice's initial potential MP: 40. 5 already accrued in 6 months. new potentialMP
// = 140 - 35 = 105
stakingBalance: 30e18,
rewardBalance: 750e18,
rewardIndex: 10e18,
@@ -313,7 +314,7 @@ contract RewardsStreamerMPTest is Test {
potentialMP: 225e18,
stakingBalance: 60e18,
rewardBalance: 1750e18,
rewardIndex: 17407407407407407407,
rewardIndex: 17_407_407_407_407_407_407,
accountedRewards: 1750e18
})
);
@@ -363,9 +364,9 @@ contract RewardsStreamerMPTest is Test {
potentialMP: 120e18,
stakingBalance: 30e18,
// 1750 - (750 + 555.55) = 444.44
rewardBalance: 444444444444444444475,
rewardIndex: 17407407407407407407,
accountedRewards: 444444444444444444475
rewardBalance: 444_444_444_444_444_444_475,
rewardIndex: 17_407_407_407_407_407_407,
accountedRewards: 444_444_444_444_444_444_475
})
);
@@ -390,9 +391,9 @@ contract RewardsStreamerMPTest is Test {
// total weight = 135
// bobs rewards = 1000 * 75 / 135 = 555.555555555555555555
// bobs total rewards = 555.55 + 750 of the first bucket = 1305.55
rewardBalance: 1305555555555555555525,
rewardBalance: 1_305_555_555_555_555_555_525,
stakedBalance: 0e18,
rewardIndex: 17407407407407407407,
rewardIndex: 17_407_407_407_407_407_407,
userMP: 0,
userPotentialMP: 0
})

4
test/mocks/MockToken.sol
View File

@@ -1,10 +1,10 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.26;
import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
contract MockToken is ERC20 {
constructor(string memory name, string memory symbol) ERC20(name, symbol) {}
constructor(string memory name, string memory symbol) ERC20(name, symbol) { }
function mint(address account, uint256 amount) external {
_mint(account, amount);