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

Apply needed fixes and improvements #90

Merged
merged 15 commits into from
Dec 14, 2024
Merged

Apply needed fixes and improvements #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
cf526b1
add notes
R-Santev Dec 12, 2024
05346cc
more notes and docs improvement
R-Santev Dec 12, 2024
449dbb6
minor improvements
R-Santev Dec 12, 2024
8cccd7e
fixes and improvements
R-Santev Dec 13, 2024
0a19e64
fixes and improvements
R-Santev Dec 13, 2024
35ba1e4
fixes
R-Santev Dec 13, 2024
1e9947b
modify check
R-Santev Dec 13, 2024
2a6559f
fix comment and enable tests
R-Santev Dec 13, 2024
f252a15
Fix audit comments left
R-Santev Dec 13, 2024
c978ccd
Update docs/HydraChain/HydraChain.md
R-Santev Dec 13, 2024
eb2377f
Update docs/HydraChain/HydraChain.md
R-Santev Dec 13, 2024
4a33cb3
Minor improvements
R-Santev Dec 13, 2024
06367f8
fix failing test
R-Santev Dec 13, 2024
c20dde4
fix docs
R-Santev Dec 13, 2024
bada1ef
extend staking rewards claiming test
R-Santev Dec 13, 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
106 changes: 54 additions & 52 deletions contracts/APRCalculator/APRCalculator.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,58 +99,60 @@ contract APRCalculator is IAPRCalculator, MacroFactor, RSIndex {
* @notice Initializes vesting bonus for each week.
*/
function _initializeVestingBonus() private {
vestingBonus[0] = 6;
vestingBonus[1] = 16;
vestingBonus[2] = 30;
vestingBonus[3] = 46;
vestingBonus[4] = 65;
vestingBonus[5] = 85;
vestingBonus[6] = 108;
vestingBonus[7] = 131;
vestingBonus[8] = 157;
vestingBonus[9] = 184;
vestingBonus[10] = 212;
vestingBonus[11] = 241;
vestingBonus[12] = 272;
vestingBonus[13] = 304;
vestingBonus[14] = 338;
vestingBonus[15] = 372;
vestingBonus[16] = 407;
vestingBonus[17] = 444;
vestingBonus[18] = 481;
vestingBonus[19] = 520;
vestingBonus[20] = 559;
vestingBonus[21] = 599;
vestingBonus[22] = 641;
vestingBonus[23] = 683;
vestingBonus[24] = 726;
vestingBonus[25] = 770;
vestingBonus[26] = 815;
vestingBonus[27] = 861;
vestingBonus[28] = 907;
vestingBonus[29] = 955;
vestingBonus[30] = 1003;
vestingBonus[31] = 1052;
vestingBonus[32] = 1101;
vestingBonus[33] = 1152;
vestingBonus[34] = 1203;
vestingBonus[35] = 1255;
vestingBonus[36] = 1307;
vestingBonus[37] = 1361;
vestingBonus[38] = 1415;
vestingBonus[39] = 1470;
vestingBonus[40] = 1525;
vestingBonus[41] = 1581;
vestingBonus[42] = 1638;
vestingBonus[43] = 1696;
vestingBonus[44] = 1754;
vestingBonus[45] = 1812;
vestingBonus[46] = 1872;
vestingBonus[47] = 1932;
vestingBonus[48] = 1993;
vestingBonus[49] = 2054;
vestingBonus[50] = 2116;
vestingBonus[51] = 2178;
vestingBonus = [
6,
16,
30,
46,
65,
85,
108,
131,
157,
184,
212,
241,
272,
304,
338,
372,
407,
444,
481,
520,
559,
599,
641,
683,
726,
770,
815,
861,
907,
955,
1003,
1052,
1101,
1152,
1203,
1255,
1307,
1361,
1415,
1470,
1525,
1581,
1638,
1696,
1754,
1812,
1872,
1932,
1993,
2054,
2116,
2178
];
}

// slither-disable-next-line unused-state,naming-convention
Expand Down
13 changes: 7 additions & 6 deletions contracts/HydraChain/modules/DaoIncentive/DaoIncentive.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ abstract contract DaoIncentive is IDaoIncentive, System, Initializable, RewardWa
* @inheritdoc IDaoIncentive
*/
function distributeDAOIncentive() external onlySystemCall {
uint256 reward = (((hydraStakingContract.totalBalance() * 200) / 10000) *
(block.timestamp - lastDistribution)) / 365 days;
uint256 reward = (
((hydraStakingContract.totalBalance() * 200 * (block.timestamp - lastDistribution)) / (10000 * 365 days))
);
lastDistribution = block.timestamp;
vaultDistribution += reward;

Expand All @@ -51,15 +52,15 @@ abstract contract DaoIncentive is IDaoIncentive, System, Initializable, RewardWa
* @inheritdoc IDaoIncentive
*/
function claimVaultFunds() external {
uint256 reward = vaultDistribution;
if (reward == 0) {
uint256 incentive = vaultDistribution;
if (incentive == 0) {
revert NoVaultFundsToClaim();
}

vaultDistribution = 0;
rewardWalletContract.distributeReward(daoIncentiveVaultContract, reward);
rewardWalletContract.distributeReward(daoIncentiveVaultContract, incentive);

emit VaultFunded(reward);
emit VaultFunded(incentive);
}

// slither-disable-next-line unused-state,naming-convention
Expand Down
8 changes: 6 additions & 2 deletions contracts/HydraChain/modules/Inspector/Inspector.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ abstract contract Inspector is IInspector, ValidatorManager {
uint256 public validatorPenalty;
/// @notice The reward for the person who reports a validator that have to be banned
uint256 public reporterReward;
/// @notice Validator inactiveness (in blocks) threshold that needs to be passed to initiate ban for a validator
/// @notice Threshold for validator inactiveness (in blocks).
/// A ban can be initiated for a validator if this threshold is reached or exceeded.
/// @dev must be always bigger than the epoch length (better bigger than at least 4 epochs),
/// otherwise all validators can be banned
uint256 public initiateBanThreshold;
/// @notice Validator inactiveness (in seconds) threshold that needs to be passed to ban a validator
/// @notice Threshold for validator inactiveness (in seconds). A validator can be banned
/// if it remains in the ban-initiated state for a duration equal to or exceeding this threshold.
uint256 public banThreshold;
/// @notice Mapping of the validators that bans has been initiated for (validator => timestamp)
mapping(address => uint256) public bansInitiated;
Expand Down
17 changes: 1 addition & 16 deletions contracts/HydraChain/modules/ValidatorManager/ValidatorManager.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ abstract contract ValidatorManager is
mapping(address => Validator) public validators;
/**
* @notice Mapping that keeps the last time when a validator has participated in the consensus
* @dev Updated on epoch-ending blocks only
* @dev Keep in mind that the validator will initially be set active when stake,
* but it will be able to participate in the next epoch. So, the validator will have
* less blocks to participate before getting eligible for ban.
Expand Down Expand Up @@ -72,22 +73,6 @@ abstract contract ValidatorManager is
}
}

// _______________ Modifiers _______________

modifier onlyActiveValidator(address validator) {
if (validators[validator].status != ValidatorStatus.Active) revert Unauthorized("INACTIVE_VALIDATOR");
_;
}

/// @notice Modifier to check if the validator is registered or active
modifier onlyValidator(address validator) {
if (
validators[validator].status != ValidatorStatus.Registered &&
validators[validator].status != ValidatorStatus.Active
) revert Unauthorized("INVALID_VALIDATOR");
_;
}

// _______________ External functions _______________

/**
Expand Down
10 changes: 6 additions & 4 deletions contracts/HydraDelegation/Delegation.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,12 @@ contract Delegation is
}

/**
* @notice Base delegation funds to a staker
* @notice Core logic for delegating funds to a staker
* @param staker Address of the validator
* @param delegator Address of the delegator
* @param amount Amount to delegate
*/
function _baseDelegate(address staker, address delegator, uint256 amount) internal virtual {
function _baseDelegate(address staker, address delegator, uint256 amount) internal {
if (amount == 0) revert DelegateRequirement({src: "delegate", msg: "DELEGATING_AMOUNT_ZERO"});
DelegationPool storage delegation = delegationPools[staker];
uint256 delegatedAmount = delegation.balanceOf(delegator);
Expand Down Expand Up @@ -253,6 +253,7 @@ contract Delegation is

/**
* @notice Undelegates funds from a staker
* @dev overridden in child contracts to extend core undelegate behaviour
* @param staker Address of the validator
* @param delegator Address of the delegator
* @param amount Amount to delegate
Expand All @@ -262,12 +263,12 @@ contract Delegation is
}

/**
* @notice Base undelegating funds from a staker
* @notice Core logic for undelegating funds from a staker
* @param staker Address of the validator
* @param delegator Address of the delegator
* @param amount Amount to delegate
*/
function _baseUndelegate(address staker, address delegator, uint256 amount) internal virtual {
function _baseUndelegate(address staker, address delegator, uint256 amount) internal {
DelegationPool storage delegation = delegationPools[staker];
uint256 delegatedAmount = delegation.balanceOf(delegator);
if (amount > delegatedAmount) revert DelegateRequirement({src: "undelegate", msg: "INSUFFICIENT_BALANCE"});
Expand All @@ -290,6 +291,7 @@ contract Delegation is

/**
* @notice Withdraws funds from stakers pool
* @dev overridden in child contracts to extend core withdraw behaviour
* @param delegation Delegation pool
* @param delegator Address of the delegator
* @param amount Amount to withdraw
Expand Down
16 changes: 13 additions & 3 deletions contracts/HydraDelegation/HydraDelegation.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ contract HydraDelegation is IHydraDelegation, System, Delegation, LiquidDelegati
__Liquid_init(liquidToken);
__Vesting_init_unchained();
__VestingManagerFactoryConnector_init(vestingManagerFactoryAddr);
__VestedDelegation_init_unchained();
}

// _______________ External functions _______________
Expand All @@ -60,7 +59,7 @@ contract HydraDelegation is IHydraDelegation, System, Delegation, LiquidDelegati
address staker,
address delegator,
uint256 amount
) internal virtual override(Delegation, LiquidDelegation, VestedDelegation) {
) internal virtual override(Delegation, LiquidDelegation) {
super._delegate(staker, delegator, amount);
}

Expand All @@ -71,7 +70,7 @@ contract HydraDelegation is IHydraDelegation, System, Delegation, LiquidDelegati
address staker,
address delegator,
uint256 amount
) internal virtual override(Delegation, LiquidDelegation, VestedDelegation) {
) internal virtual override(Delegation, LiquidDelegation) {
super._undelegate(staker, delegator, amount);
}

Expand All @@ -83,7 +82,18 @@ contract HydraDelegation is IHydraDelegation, System, Delegation, LiquidDelegati
*/
function _distributeTokens(address staker, address account, uint256 amount) internal virtual override {
VestingPosition memory position = vestedDelegationPositions[staker][msg.sender];
// This check works because if position has already been opened, the restrictions on delegateWithVesting()
// will prevent entering this check again
if (_isOpeningPosition(position)) {
uint256 previousDelegation = delegationOf(staker, account) - amount;
if (previousDelegation != 0) {
// We want all previously distributed tokens to be collected,
// because the new position vesting period can be different from the previous one
// meaning the tokens to distribute amount will be different
_collectTokens(staker, previousDelegation);
amount += previousDelegation;
}

uint256 debt = _calculatePositionDebt(amount, position.duration);
liquidityDebts[account] -= debt.toInt256Safe(); // Add negative debt
amount -= debt;
Expand Down
4 changes: 2 additions & 2 deletions contracts/HydraDelegation/modules/DelegationPoolLib/DelegationPoolLib.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,6 @@ library DelegationPoolLib {
* @param currentEpochNum the current epoch number
* @return bool whether the balance change is made
*/
// TODO: Check if the commitEpoch is the last transaction in the epoch, otherwise bug may occur
function isBalanceChangeMade(
DelegationPool storage pool,
address delegator,
Expand Down Expand Up @@ -277,7 +276,8 @@ library DelegationPoolLib {
// _______________ Private functions _______________

/**
* @notice Saves the RPS for the given staker for the epoch
* @notice Saves the RPS for the given staker's delegation pool
* @dev must be called when new reward is distributed (at the end of every epoch in our case)
* @param pool the DelegationPool to save the RPS for
* @param rewardPerShare Amount of tokens to be withdrawn
* @param epochNumber Epoch number
Expand Down
36 changes: 4 additions & 32 deletions contracts/HydraDelegation/modules/VestedDelegation/VestedDelegation.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve
using DelegationPoolLib for DelegationPool;
using VestedPositionLib for VestingPosition;

/**
* @notice The threshold for the maximum number of allowed balance changes
* @dev We are using this to restrict unlimited changes of the balance (delegationPoolParamsHistory)
*/
uint256 public balanceChangeThreshold;

/**
* @notice The vesting positions for every delegator
* @dev Staker => Delegator => VestingPosition
Expand Down Expand Up @@ -52,12 +46,6 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve
);
__Vesting_init(governance, aprCalculatorAddr);
__VestingManagerFactoryConnector_init(vestingManagerFactoryAddr);
__VestedDelegation_init_unchained();
}

// solhint-disable-next-line func-name-mixedcase
function __VestedDelegation_init_unchained() internal onlyInitializing {
balanceChangeThreshold = 32;
}

// _______________ Modifiers _______________
Expand Down Expand Up @@ -202,7 +190,6 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve
delegation.cleanDelegatorHistoricalData(msg.sender);

uint256 duration = durationWeeks * 1 weeks;
// TODO: calculate end of period instead of write in the cold storage. It is cheaper
vestedDelegationPositions[staker][msg.sender] = VestingPosition({
duration: duration,
start: block.timestamp,
Expand All @@ -223,7 +210,7 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve
*/
function swapVestedPositionStaker(address oldStaker, address newStaker) external onlyManager {
VestingPosition memory oldPosition = vestedDelegationPositions[oldStaker][msg.sender];
// ensure that the old position is active in order to continue the swap
// ensure that the old position is active
if (!oldPosition.isActive()) {
revert DelegateRequirement({src: "vesting", msg: "OLD_POSITION_INACTIVE"});
}
Expand Down Expand Up @@ -341,7 +328,6 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve

// _______________ Public functions _______________

// TODO: Check if the commitEpoch is the last transaction in the epoch, otherwise bug may occur
/**
* @inheritdoc IVestedDelegation
*/
Expand Down Expand Up @@ -388,13 +374,6 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve

// _______________ Internal functions _______________

/**
* @inheritdoc Delegation
*/
function _delegate(address staker, address delegator, uint256 amount) internal virtual override {
super._delegate(staker, delegator, amount);
}

/**
* @inheritdoc Delegation
*/
Expand All @@ -404,9 +383,9 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve
address delegator,
uint256 amount
) internal virtual override {
// If it is a vested delegation, withdraw by keeping the change in the delegation pool params
// If it is a vested delegation, deposit by keeping the change in the delegation pool params
// so vested rewards claiming is possible
if (vestedDelegationPositions[staker][delegator].isInVestingCycle()) {
if (vestedDelegationPositions[staker][delegator].isActive()) {
return delegation.deposit(delegator, amount, hydraChainContract.getCurrentEpochId());
}

Expand All @@ -424,20 +403,13 @@ abstract contract VestedDelegation is IVestedDelegation, Vesting, Delegation, Ve
) internal virtual override {
// If it is an vested delegation, withdraw by keeping the change in the delegation pool params
// so vested rewards claiming is possible
if (vestedDelegationPositions[staker][delegator].isInVestingCycle()) {
if (vestedDelegationPositions[staker][delegator].isActive()) {
return delegation.withdraw(delegator, amount, hydraChainContract.getCurrentEpochId());
}

super._withdrawDelegation(staker, delegation, delegator, amount);
}

/**
* @inheritdoc Delegation
*/
function _undelegate(address staker, address delegator, uint256 amount) internal virtual override {
super._undelegate(staker, delegator, amount);
}

/**
* @notice Checks if the position has no reward conditions
* @param position The vesting position
Expand Down
Loading
Loading