0xrs / halo-rewards Goto Github PK

Inside describe - "Earn vesting rewards by staking HALO inside HaloChest"
It - I can claim correct xHalo after x months.

add test to prove earning mechanism works at https://github.com/0xRS/halo-rewards/blob/61e706419df6adeb12cd8cf43dd7ceb3d1a60e0a/hardhat/test/reward-test.js#L369

“if i stake HALO in HaloChest and other HALO token holders to deposit HALO and then I withdraw HALO, i will be able to withdraw more HALO then originally deposited”

A way to track all user earned HALO (unclaimed and claimed). Thinking of tracking using events or stored internally but happy to hear any other suggestions.

On (https://github.com/0xRS/halo-rewards/blob/500a0e42b93e54c7cd7ae21efd77a9efaa2b248d/contracts/Rewards.sol#L20)
event should be named WithdrawLPTokens

Should we add an event here? (https://github.com/0xRS/halo-rewards/blob/500a0e42b93e54c7cd7ae21efd77a9efaa2b248d/contracts/Rewards.sol#L95) and (https://github.com/0xRS/halo-rewards/blob/500a0e42b93e54c7cd7ae21efd77a9efaa2b248d/contracts/Rewards.sol#L121)

Change variable -> ammLpUserInfo to minterLpUserInfo in
(https://github.com/0xRS/halo-rewards/blob/main/contracts/Rewards.sol#L266)

Refer to this section of the rewards contract specs.
(https://docs.google.com/document/d/1xF8kiopKTd_KLhmJtAB_H6KpLeqo1_QDw6F11Bb0uQQ/edit?disco=AAAAH9UK7yA)

For consistency, rename removeLp to removeAmmLp
(https://github.com/0xRS/halo-rewards/blob/main/contracts/Rewards.sol#L349)

Any way to know how much tokens we can withdraw right away and how many is still vested?

View function to get data from UserInfo so we can get the total amount of collateral the user. Something like getTotalUserLpTokenAmount() ?

"If I claim my HALO, I get my staked HALO plus earned HALO"

Documentation on how to deploy the contracts locally, such as installing deps and other prereqs before we can run the unit tests.

Based from this comment:
Also 1 currently known issue: there's no function to just withdraw the outstanding rewards. You need deposit or redeem to automatically claim the rewards. I'll add a function to withdraw the outstanding rewards.

Add comments on critical areas of the code, to help us better understand (e.g. calcReward(), updateMinterRewardPool(), updateAmmRewardPool()).