Synthetix staking rewards by Joeysantoro · Pull Request #68 · fei-protocol/fei-protocol-core

Joeysantoro · 2021-02-16T02:47:45Z

Update the Pool contracts to use Synthetix StakingRewards instead.

Basically split out the pool logic related to stake, claim, withdraw and instead use FeiStakingRewards which wraps StakingRewardsV2. We can assume this contract works as intended.

The risk is in FeiRewardsDistributor which inherits the distribution schedule logic from the old FeiPool + Pool contracts. The primary risk of the change is in the drip() function of FeiRewardsDistributor as well as double checking all of the wiring.

Joeysantoro · 2021-02-17T07:06:27Z

contracts/external/RewardsDistributionRecipient.sol

@@ -0,0 +1,12 @@
+pragma solidity ^0.6.6;
+
+abstract contract RewardsDistributionRecipient {


out of the box contract

Joeysantoro · 2021-02-17T07:06:42Z

contracts/external/StakingRewardsV2.sol

+
+// forked from https://github.com/SetProtocol/index-coop-contracts/blob/master/contracts/staking/StakingRewardsV2.sol
+// NOTE: V2 allows setting of rewardsDuration in constructor
+contract StakingRewardsV2 is RewardsDistributionRecipient, ReentrancyGuard {


out of the box contract with a minor change

Joeysantoro · 2021-02-17T07:07:04Z

contracts/external/StakingRewardsV2.sol

+    // Added to support recovering LP Rewards from other systems such as BAL to be distributed to holders
+    function recoverERC20(address tokenAddress, address to, uint256 tokenAmount) external onlyRewardsDistribution {
+        require(tokenAddress != address(stakingToken), "Cannot withdraw the staking token");
+        require(tokenAddress != address(rewardsToken), "Cannot withdraw the rewards token");
+
+        IERC20(tokenAddress).safeTransfer(to, tokenAmount);
+        emit Recovered(tokenAddress, to, tokenAmount);
+    }


Added this method from StakingRewards v1

Joeysantoro · 2021-02-17T07:08:58Z

contracts/genesis/GenesisGroup.sol

 import "./IDOInterface.sol";
 import "../utils/Timed.sol";
 import "../refs/CoreRef.sol";
-import "../pool/IPool.sol";


removed Pool init logic because now we can simply drip publicly from the FeiRewardsDistributor post the first dripFrequency window. This removes the risk of the new stakingRewards contract bricking launch

Joeysantoro · 2021-02-17T07:09:54Z

contracts/orchestration/CoreOrchestrator.sol


    uint256 public constant POOL_DURATION = 2 * 365 days;
-    uint256 public constant THAWING_DURATION = 4 weeks;
+    uint256 public constant DRIP_FREQUENCY = 1 weeks;


This is both the frequency with which FeiRewardsDistributor can drip and the expected duration of FeiStakingRewards

Joeysantoro · 2021-02-17T07:10:32Z

contracts/orchestration/CoreOrchestrator.sol

+        core.grantMinter(feiRewardsDistributor);
+
+        IRewardsDistributor(feiRewardsDistributor).setStakingContract(feiStakingRewards);
+


set the distributor as a minter to incentivize drips, and complete the wiring

Joeysantoro · 2021-02-17T07:10:54Z

contracts/orchestration/GenesisOrchestrator.sol

 pragma solidity ^0.6.0;

 import "@openzeppelin/contracts/access/Ownable.sol";
-import "../pool/FeiPool.sol";


remove pool from this orchestrator to make a separate one

Joeysantoro · 2021-02-17T07:12:25Z

contracts/staking/FeiStakingRewards.sol

+/// @title A StakingRewards contract for earning TRIBE with staked FEI/TRIBE LP tokens
+/// @author Fei Protocol
+/// @notice deposited LP tokens will earn TRIBE over time at a linearly decreasing rate
+contract FeiStakingRewards is StakingRewardsV2 {


simple wrapper around StakingRewardsV2, not really necessary

Joeysantoro · 2021-02-17T07:14:42Z

contracts/staking/FeiRewardsDistributor.sol

+    /// @notice the total amount of rewards owned by contract and unlocked for release
+    function releasedReward() public view override returns (uint256) {
+        uint256 total = rewardBalance();
+        uint256 unreleased = unreleasedReward();
+        return total.sub(unreleased, "Pool: Released Reward underflow");
+    }
+
+    /// @notice the total amount of rewards distributed by the contract over entire period
+    function totalReward() public view override returns (uint256) {
+        return rewardBalance().add(distributedRewards);
+    }
+
+    /// @notice the total balance of rewards owned by contract, locked or unlocked
+    function rewardBalance() public view override returns (uint256) {
+        return tribeBalance();
+    }
+
+    /// @notice the total amount of rewards owned by contract and locked
+    function unreleasedReward() public view override returns (uint256) {
+        if (isTimeEnded()) {
+            return 0;
+        }
+
+        return
+            _unreleasedReward(
+                totalReward(),
+                duration,
+                timeSinceStart()
+            );
+    }
+
+    // Represents the integral of 2R/d - 2R/d^2 x dx from t to d
+    // Integral equals 2Rx/d - Rx^2/d^2
+    // Evaluated at t = 2R*t/d (start) - R*t^2/d^2 (end)
+    // Evaluated at d = 2R - R = R
+    // Solution = R - (start - end) or equivalently end + R - start (latter more convenient to code)
+    function _unreleasedReward(
+        uint256 _totalReward,
+        uint256 _duration,
+        uint256 _time
+    ) internal pure returns (uint256) {
+        // 2R*t/d
+        Decimal.D256 memory start =
+            Decimal.ratio(_totalReward, _duration).mul(2).mul(_time);
+
+        // R*t^2/d^2
+        Decimal.D256 memory end =
+            Decimal.ratio(_totalReward, _duration).div(_duration).mul(


audited logic from Pool.sol and FeiPool.sol for calculating the amount distributed over a window

Joeysantoro · 2021-02-17T07:15:00Z

contracts/staking/FeiRewardsDistributor.sol

+    function drip() public override postGenesis returns(uint256) {
+        require(!killSwitch, "FeiRewardsDistributor: drip disabled");
+
+        // solhint-disable-next-line not-rely-on-time
+        require(block.timestamp >= nextDripAvailable(), "FeiRewardsDistributor: Not passed drip frequency");
+        // solhint-disable-next-line not-rely-on-time
+        lastDistributionTime = block.timestamp;
+
+        uint amount = releasedReward();
+        require(amount != 0, "FeiRewardsDistributor: no rewards");
+        distributedRewards = distributedRewards.add(amount);
+
+        tribe().transfer(address(stakingContract), amount);
+        stakingContract.notifyRewardAmount(amount);
+
+        _incentivize();
+
+        emit Drip(msg.sender, amount);
+        return amount;
+    }


The main risk in the change is this method

Joeysantoro force-pushed the POZ-Synthetix-StakingRewards branch from 1ebf180 to 4276123 Compare February 16, 2021 07:11

Joey Santoro added 3 commits February 16, 2021 14:15

swap for synthetix StakingRewards

a642abb

testing and fixes

3576276

staking orchestration

f14ffae

Joeysantoro force-pushed the POZ-Synthetix-StakingRewards branch from 2946aca to f14ffae Compare February 16, 2021 22:16

update deploy and e2e scripts

dda6903

Joeysantoro commented Feb 17, 2021

View reviewed changes

Joey Santoro and others added 2 commits February 17, 2021 08:52

cleanup npm

ccd2bb1

Merge branch 'POZ-Fixes' into POZ-Synthetix-StakingRewards

131d468

Joeysantoro changed the base branch from POZ-Fixes to Release February 18, 2021 20:38

Merge branch 'Release' into POZ-Synthetix-StakingRewards

4415154

Joeysantoro merged commit 1bc5edf into Release Feb 18, 2021

xklob deleted the POZ-Synthetix-StakingRewards branch September 19, 2021 18:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Synthetix staking rewards#68

Synthetix staking rewards#68
Joeysantoro merged 7 commits intoReleasefrom
POZ-Synthetix-StakingRewards

Joeysantoro commented Feb 16, 2021 •

edited

Loading

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Joeysantoro Feb 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

		@@ -0,0 +1,12 @@
		pragma solidity ^0.6.6;

		abstract contract RewardsDistributionRecipient {

		core.grantMinter(feiRewardsDistributor);

		IRewardsDistributor(feiRewardsDistributor).setStakingContract(feiStakingRewards);

Conversation

Joeysantoro commented Feb 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

Joeysantoro commented Feb 16, 2021 •

edited

Loading