harb/onchain/test/Kraiken.t.sol

275 lines
11 KiB
Solidity
Raw Normal View History

2024-03-12 11:38:16 +01:00
// SPDX-License-Identifier: GPL-3.0-or-later
2024-03-28 19:55:01 +01:00
pragma solidity ^0.8.19;
2024-03-12 11:38:16 +01:00
import "../src/Kraiken.sol";
import { IERC20 } from "@openzeppelin/token/ERC20/IERC20.sol";
2024-03-12 11:38:16 +01:00
import "forge-std/Test.sol";
import "forge-std/console.sol";
2024-03-14 12:40:57 +01:00
contract KraikenTest is Test {
Kraiken internal kraiken;
address internal stakingPool;
address internal liquidityPool;
address internal liquidityManager;
2024-04-16 06:58:41 +02:00
2024-03-12 11:38:16 +01:00
function setUp() public {
kraiken = new Kraiken("KRAIKEN", "KRK");
2024-06-19 10:33:28 +02:00
stakingPool = makeAddr("stakingPool");
kraiken.setStakingPool(stakingPool);
2024-06-19 10:33:28 +02:00
liquidityManager = makeAddr("liquidityManager");
kraiken.setLiquidityManager(liquidityManager);
2024-03-12 11:38:16 +01:00
}
2024-06-16 09:26:11 +02:00
// Simulates staking by transferring tokens to the stakingPool address.
function simulateStake(uint256 amount) internal {
// the amount of token has to be available on the balance
// of the test contract
kraiken.transfer(stakingPool, amount);
2024-06-16 09:26:11 +02:00
}
2024-03-14 12:40:57 +01:00
2024-06-16 09:26:11 +02:00
// Simulates unstaking by transferring tokens from the stakingPool back to a given address.
function simulateUnstake(uint256 amount) internal {
// Direct transfer from the stakingPool to 'to' address to simulate unstaking
2025-07-08 10:33:10 +02:00
vm.prank(stakingPool); // Assuming 'stake' contract would allow this in an actual scenario
kraiken.transfer(address(this), amount);
2024-06-16 09:26:11 +02:00
}
2024-03-12 20:22:10 +01:00
function testKraikenConstructor() public view {
2024-06-16 09:26:11 +02:00
// Check if the token details are set as expected
assertEq(kraiken.name(), "KRAIKEN");
assertEq(kraiken.symbol(), "KRK");
2024-03-14 17:31:16 +01:00
2024-06-16 09:26:11 +02:00
// Confirm that the TwabController address is correctly set
(address _lm, address _sp) = kraiken.peripheryContracts();
2024-06-19 10:33:28 +02:00
assertEq(_lm, liquidityManager);
assertEq(_sp, stakingPool);
2024-06-16 09:26:11 +02:00
}
2024-03-14 12:40:57 +01:00
2024-06-16 09:26:11 +02:00
function testMintWithEmptyStakingPool() public {
uint256 initialSupply = kraiken.totalSupply();
2024-06-16 09:26:11 +02:00
uint256 mintAmount = 1000 * 1e18; // 1000 HARB tokens
vm.prank(address(liquidityManager));
kraiken.mint(mintAmount);
2024-06-16 09:26:11 +02:00
// Check if the total supply has increased correctly
assertEq(kraiken.totalSupply(), initialSupply + mintAmount);
2024-06-16 09:26:11 +02:00
// Check if the staking pool balance is still 0, as before
assertEq(kraiken.balanceOf(stakingPool), 0);
2024-06-16 09:26:11 +02:00
}
function testBurnWithEmptyStakingPool() public {
uint256 initialSupply = kraiken.totalSupply();
2024-06-16 09:26:11 +02:00
uint256 burnAmount = 500 * 1e18; // 500 HARB tokens
// First, mint some tokens to burn
vm.prank(address(liquidityManager));
kraiken.mint(burnAmount);
2024-06-16 09:26:11 +02:00
vm.prank(address(liquidityManager));
kraiken.burn(burnAmount);
2024-06-16 09:26:11 +02:00
// Check if the total supply has decreased correctly
assertEq(kraiken.totalSupply(), initialSupply);
2024-06-16 09:26:11 +02:00
// Check if the staking pool balance has decreased correctly
assertEq(kraiken.balanceOf(stakingPool), 0);
2024-06-16 09:26:11 +02:00
}
function testMintImpactOnSimulatedStaking() public {
uint256 initialStakingPoolBalance = kraiken.balanceOf(stakingPool);
2024-06-16 09:26:11 +02:00
uint256 mintAmount = 1000 * 1e18; // 1000 HARB tokens
// Ensure the test contract has enough tokens to simulate staking
vm.prank(address(liquidityManager));
kraiken.mint(mintAmount);
2024-06-16 09:26:11 +02:00
vm.prank(address(liquidityManager));
kraiken.transfer(address(this), mintAmount);
2024-06-16 09:26:11 +02:00
// Simulate staking of the minted amount
simulateStake(mintAmount);
// Check balances after simulated staking
assertEq(kraiken.balanceOf(stakingPool), initialStakingPoolBalance + mintAmount);
2024-06-16 09:26:11 +02:00
}
function testUnstakeImpactOnTotalSupply() public {
uint256 stakeAmount = 500 * 1e18; // 500 HARB tokens
// Ensure the test contract has enough tokens to simulate staking
vm.prank(address(liquidityManager));
kraiken.mint(stakeAmount);
2024-06-16 09:26:11 +02:00
vm.prank(address(liquidityManager));
kraiken.transfer(address(this), stakeAmount);
2024-06-16 09:26:11 +02:00
uint256 initialTotalSupply = kraiken.totalSupply();
2024-06-16 09:26:11 +02:00
// Simulate staking and then unstaking
simulateStake(stakeAmount);
simulateUnstake(stakeAmount);
// Check total supply remains unchanged after unstake
assertEq(kraiken.totalSupply(), initialTotalSupply);
2024-06-16 09:26:11 +02:00
}
// Fuzz test for mint function with varying stake amounts
function testMintWithStake(uint8 _stakePercentage, uint256 mintAmount) public {
uint256 initialAmount = 500 * 1e18;
// Ensure the test contract has enough tokens to simulate staking
vm.prank(address(liquidityManager));
kraiken.mint(initialAmount);
2024-06-16 09:26:11 +02:00
vm.prank(address(liquidityManager));
kraiken.transfer(address(this), initialAmount);
2024-06-16 09:26:11 +02:00
// Limit fuzzing input to 0% - 20%
uint8 effectiveStakePercentage = _stakePercentage % 21;
uint256 stakeAmount = (initialAmount * effectiveStakePercentage) / 100;
simulateStake(stakeAmount);
uint256 initialTotalSupply = kraiken.totalSupply();
uint256 initialStakingPoolBalance = kraiken.balanceOf(stakingPool);
2024-06-16 09:26:11 +02:00
2025-01-23 13:21:49 +01:00
mintAmount = bound(mintAmount, 1, 500 * 1e18);
uint256 expectedNewStake = initialStakingPoolBalance * mintAmount / (initialTotalSupply - initialStakingPoolBalance);
2024-06-16 09:26:11 +02:00
2025-01-23 13:21:49 +01:00
// Expect Transfer events
vm.expectEmit(true, true, true, true, address(kraiken));
2025-01-23 13:21:49 +01:00
emit IERC20.Transfer(address(0), address(liquidityManager), mintAmount);
2024-06-16 09:26:11 +02:00
vm.prank(address(liquidityManager));
kraiken.mint(mintAmount);
2024-06-16 09:26:11 +02:00
uint256 expectedStakingPoolBalance = initialStakingPoolBalance + expectedNewStake;
uint256 expectedTotalSupply = initialTotalSupply + mintAmount + expectedNewStake;
assertEq(kraiken.balanceOf(stakingPool), expectedStakingPoolBalance, "Staking pool balance did not adjust correctly after mint.");
assertEq(kraiken.totalSupply(), expectedTotalSupply, "Total supply did not match expected after mint.");
2024-06-16 09:26:11 +02:00
}
// Fuzz test for burn function with varying stake amounts
function testBurnWithStake(uint8 _stakePercentage, uint256 burnAmount) public {
uint256 mintAmount = 500 * 1e18;
// Ensure the test contract has enough tokens to simulate staking
vm.prank(address(liquidityManager));
kraiken.mint(mintAmount);
2024-06-16 09:26:11 +02:00
// Limit fuzzing input to 0% - 20%
uint8 effectiveStakePercentage = _stakePercentage % 21;
uint256 stakeAmount = (mintAmount * effectiveStakePercentage) / 100;
vm.prank(address(liquidityManager));
kraiken.transfer(address(this), stakeAmount);
2024-06-16 09:26:11 +02:00
simulateStake(stakeAmount);
burnAmount = bound(burnAmount, 0, 200 * 1e18);
uint256 initialTotalSupply = kraiken.totalSupply();
uint256 initialStakingPoolBalance = kraiken.balanceOf(stakingPool);
uint256 expectedExcessStake = initialStakingPoolBalance * burnAmount / (initialTotalSupply - initialStakingPoolBalance);
2024-04-23 06:58:34 +02:00
2024-06-16 09:26:11 +02:00
vm.prank(address(liquidityManager));
kraiken.burn(burnAmount);
2024-04-23 06:58:34 +02:00
2024-06-16 09:26:11 +02:00
uint256 expectedStakingPoolBalance = initialStakingPoolBalance - expectedExcessStake;
uint256 expectedTotalSupply = initialTotalSupply - burnAmount - expectedExcessStake;
assertEq(kraiken.balanceOf(stakingPool), expectedStakingPoolBalance, "Staking pool balance did not adjust correctly after burn.");
assertEq(kraiken.totalSupply(), expectedTotalSupply, "Total supply did not match expected after burn.");
2024-06-16 09:26:11 +02:00
}
// ========================================
// SETTER VALIDATION TESTS
// ========================================
function testSetLiquidityManagerZeroAddress() public {
Kraiken freshKraiken = new Kraiken("KRAIKEN", "KRK");
vm.expectRevert(Kraiken.ZeroAddressInSetter.selector);
freshKraiken.setLiquidityManager(address(0));
}
function testSetLiquidityManagerAlreadySet() public {
// liquidityManager is already set in setUp — calling again must revert
vm.expectRevert(Kraiken.AddressAlreadySet.selector);
kraiken.setLiquidityManager(makeAddr("anotherLiquidityManager"));
}
function testSetLiquidityManagerRejectsStakingPool() public {
Kraiken freshKraiken = new Kraiken("KRAIKEN", "KRK");
address sp = makeAddr("stakingPool");
freshKraiken.setStakingPool(sp);
vm.expectRevert(Kraiken.InvalidAddress.selector);
freshKraiken.setLiquidityManager(sp);
}
function testSetLiquidityManagerOnlyDeployer() public {
Kraiken freshKraiken = new Kraiken("KRAIKEN", "KRK");
address nonDeployer = makeAddr("nonDeployer");
vm.prank(nonDeployer);
vm.expectRevert("only deployer");
freshKraiken.setLiquidityManager(makeAddr("someManager"));
}
function testSetStakingPoolZeroAddress() public {
Kraiken freshKraiken = new Kraiken("KRAIKEN", "KRK");
vm.expectRevert(Kraiken.ZeroAddressInSetter.selector);
freshKraiken.setStakingPool(address(0));
}
function testSetStakingPoolAlreadySet() public {
// stakingPool is already set in setUp — calling again must revert
vm.expectRevert(Kraiken.AddressAlreadySet.selector);
kraiken.setStakingPool(makeAddr("anotherStakingPool"));
}
function testSetStakingPoolRejectsLiquidityManager() public {
Kraiken freshKraiken = new Kraiken("KRAIKEN", "KRK");
address lm = makeAddr("liquidityManager");
freshKraiken.setLiquidityManager(lm);
vm.expectRevert(Kraiken.InvalidAddress.selector);
freshKraiken.setStakingPool(lm);
}
function testSetStakingPoolOnlyDeployer() public {
Kraiken freshKraiken = new Kraiken("KRAIKEN", "KRK");
address nonDeployer = makeAddr("nonDeployer");
vm.prank(nonDeployer);
vm.expectRevert("only deployer");
freshKraiken.setStakingPool(makeAddr("somePool"));
}
function testOnlyLiquidityManagerModifier() public {
address nonLM = makeAddr("notLiquidityManager");
vm.prank(nonLM);
vm.expectRevert("only liquidity manager");
kraiken.mint(1000 * 1e18);
}
// ========================================
// ZERO AMOUNT TESTS
// ========================================
function testMintZeroAmount() public {
// Mint a positive amount first so previousTotalSupply gets set
vm.prank(address(liquidityManager));
kraiken.mint(1000 * 1e18);
uint256 totalSupplyBefore = kraiken.totalSupply();
assertGt(kraiken.previousTotalSupply(), 0, "previousTotalSupply should be non-zero after first mint");
// Mint zero: should skip the entire amount > 0 block
// AND should skip the previousTotalSupply == 0 block (it is already set)
vm.prank(address(liquidityManager));
kraiken.mint(0);
assertEq(kraiken.totalSupply(), totalSupplyBefore, "Total supply must not change when minting zero");
assertEq(kraiken.balanceOf(stakingPool), 0, "Staking pool balance must not change when minting zero");
}
function testBurnZeroAmount() public {
vm.prank(address(liquidityManager));
kraiken.mint(1000 * 1e18);
uint256 totalSupplyBefore = kraiken.totalSupply();
// Burn zero: should skip the entire amount > 0 block
vm.prank(address(liquidityManager));
kraiken.burn(0);
assertEq(kraiken.totalSupply(), totalSupplyBefore, "Total supply must not change when burning zero");
}
2024-03-12 11:38:16 +01:00
}