@pendle/core-v2 3.0.0-beta-10 → 3.0.0-beta-12

package/contracts/core/RewardManager/PendleLinearDistributor.sol

@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity ^0.8.17;
+
+import "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
+import "../libraries/BoringOwnableUpgradeable.sol";
+import "../libraries/TokenHelper.sol";
+import "../libraries/math/PMath.sol";
+import "../../interfaces/IPLinearDistributor.sol";
+
+contract PendleLinearDistributor is UUPSUpgradeable, AccessControlUpgradeable, TokenHelper, IPLinearDistributor {
+    using PMath for uint128;
+    using PMath for uint192;
+    using PMath for uint256;
+
+    bytes32 public constant MAINTAINER = keccak256("MAINTAINER");
+
+    mapping(address => bool) internal isWhitelisted;
+
+    // [token, addr] => distribution
+    mapping(address => mapping(address => DistributionData)) public distributionDatas;
+
+    constructor() {
+        _disableInitializers();
+    }
+
+    modifier onlyWhitelisted() {
+        require(isWhitelisted[msg.sender], "not whitelisted");
+        _;
+    }
+
+    function isMaintainer(address addr) public view returns (bool) {
+        return (hasRole(DEFAULT_ADMIN_ROLE, addr) || hasRole(MAINTAINER, addr));
+    }
+
+    modifier onlyMaintainer() {
+        require(isMaintainer(msg.sender), "not maintainer");
+        _;
+    }
+
+    modifier onlyAdmin() {
+        require(hasRole(DEFAULT_ADMIN_ROLE, msg.sender), "not admin");
+        _;
+    }
+
+    // ----------------- core-logic ----------------------
+
+    function queueVestAndClaim(address token, uint256 amountVestToQueue) external onlyWhitelisted returns (uint256) {
+        require(amountVestToQueue > 0, "invalid amountVestToQueue");
+
+        uint256 amountOut = _getClaimableRewardAndUpdate(token, msg.sender, amountVestToQueue);
+
+        // dodging extreme case of amountOut = amountVestToQueue
+        if (amountOut > amountVestToQueue) {
+            _transferOut(token, msg.sender, amountOut - amountVestToQueue);
+        } else if (amountVestToQueue > amountOut) {
+            _transferIn(token, msg.sender, amountVestToQueue - amountOut);
+        }
+
+        emit VestQueued(token, msg.sender, amountVestToQueue);
+        emit Claim(token, msg.sender, amountOut);
+
+        return amountOut;
+    }
+
+    function claim(address token) external returns (uint256) {
+        uint256 amountOut = _getClaimableRewardAndUpdate(token, msg.sender, 0);
+        if (amountOut > 0) {
+            _transferOut(token, msg.sender, amountOut);
+        }
+        emit Claim(token, msg.sender, amountOut);
+        return amountOut;
+    }
+
+    function applyVestRewards(
+        address[] memory tokens,
+        address[] memory addrs,
+        uint256[] memory durations
+    ) external onlyMaintainer {
+        require(tokens.length == addrs.length, "invalid array length");
+        require(tokens.length == durations.length, "invalid array length");
+
+        for (uint256 i = 0; i < tokens.length; ++i) {
+            _applyVestReward(tokens[i], addrs[i], durations[i]);
+        }
+    }
+
+    function _applyVestReward(address token, address addr, uint256 duration) internal {
+        DistributionData memory data = _updateRewardView(token, addr);
+
+        uint256 amountVesting = data.unvestedReward;
+        if (amountVesting == 0) {
+            return;
+        }
+
+        uint256 leftOver = data.rewardPerSec.mulDown((data.endTime - PMath.min(block.timestamp, data.endTime)));
+        uint256 undistrbutedReward = amountVesting + leftOver;
+
+        data.unvestedReward = 0;
+        data.endTime = (block.timestamp + duration).Uint32();
+        data.rewardPerSec = undistrbutedReward.divDown(duration).Uint192();
+        distributionDatas[token][addr] = data;
+
+        emit Vested(token, addr, amountVesting, duration);
+    }
+
+    // data.lastDistributedTime is guaranteed to be block.timestamp after calling this
+    function _getClaimableRewardAndUpdate(
+        address token,
+        address addr,
+        uint256 amountVestToQueue
+    ) internal returns (uint256 amountOut) {
+        DistributionData memory data = _updateRewardView(token, addr);
+        amountOut = data.accruedReward;
+
+        data.accruedReward = 0;
+        data.unvestedReward += amountVestToQueue.Uint128();
+
+        distributionDatas[token][addr] = data;
+    }
+
+    function _updateRewardView(address token, address addr) internal view returns (DistributionData memory data) {
+        data = distributionDatas[token][addr];
+        uint256 distributeFrom = PMath.min(data.lastDistributedTime, data.endTime);
+        uint256 distributeTo = PMath.min(block.timestamp, data.endTime);
+        data.accruedReward += data.rewardPerSec.mulDown(distributeTo - distributeFrom).Uint128();
+        data.lastDistributedTime = block.timestamp.Uint32();
+    }
+
+    // ----------------- governance-related --------------
+
+    function setWhitelisted(address addr, bool status) external onlyAdmin {
+        isWhitelisted[addr] = status;
+    }
+
+    function initialize() external initializer {
+        _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
+    }
+
+    // ----------------- upgrade-related -----------------
+
+    function _authorizeUpgrade(address) internal override onlyAdmin {}
+}

package/contracts/core/RewardManager/RewardManager.sol

@@ -13,7 +13,6 @@ abstract contract RewardManager is RewardManagerAbstract {
 
     mapping(address => RewardState) public rewardState;
 
-
     function _updateRewardIndex()
         internal
         virtual
@@ -37,18 +36,26 @@ abstract contract RewardManager is RewardManagerAbstract {
                 address token = tokens[i];
 
                 // the entire token balance of the contract must be the rewards of the contract
-                uint256 accrued = _selfBalance(tokens[i]) - rewardState[token].lastBalance;
-                uint256 index = rewardState[token].index;
+
+                RewardState memory _state = rewardState[token];
+                (uint256 lastBalance, uint256 index) = (_state.lastBalance, _state.index);
+
+                uint256 accrued = _selfBalance(tokens[i]) - lastBalance;
 
                 if (index == 0) index = INITIAL_REWARD_INDEX;
                 if (totalShares != 0) index += accrued.divDown(totalShares);
 
-                rewardState[token].index = index.Uint128();
-                rewardState[token].lastBalance += accrued.Uint128();
+                rewardState[token] = RewardState({
+                    index: index.Uint128(),
+                    lastBalance: (lastBalance + accrued).Uint128()
+                });
+                indexes[i] = index;
+            }
+        } else {
+            for (uint256 i = 0; i < tokens.length; i++) {
+                indexes[i] = rewardState[tokens[i]].index;
             }
         }
-
-        for (uint256 i = 0; i < tokens.length; i++) indexes[i] = rewardState[tokens[i]].index;
     }
 
     /// @dev this function doesn't need redeemExternal since redeemExternal is bundled in updateRewardIndex

package/contracts/core/RewardManager/RewardManagerAbstract.sol

@@ -36,18 +36,12 @@ abstract contract RewardManagerAbstract is IRewardManager, TokenHelper {
         (address[] memory tokens, uint256[] memory indexes) = _updateRewardIndex();
         if (tokens.length == 0) return;
 
-        if (user1 != address(0) && user1 != address(this))
-            _distributeRewardsPrivate(user1, tokens, indexes);
-        if (user2 != address(0) && user2 != address(this))
-            _distributeRewardsPrivate(user2, tokens, indexes);
+        if (user1 != address(0) && user1 != address(this)) _distributeRewardsPrivate(user1, tokens, indexes);
+        if (user2 != address(0) && user2 != address(this)) _distributeRewardsPrivate(user2, tokens, indexes);
     }
 
     // should only be callable from `_updateAndDistributeRewardsForTwo` to guarantee user != address(0) && user != address(this)
-    function _distributeRewardsPrivate(
-        address user,
-        address[] memory tokens,
-        uint256[] memory indexes
-    ) private {
+    function _distributeRewardsPrivate(address user, address[] memory tokens, uint256[] memory indexes) private {
         assert(user != address(0) && user != address(this));
 
         uint256 userShares = _rewardSharesUser(user);
@@ -67,17 +61,11 @@ abstract contract RewardManagerAbstract is IRewardManager, TokenHelper {
             uint256 rewardDelta = userShares.mulDown(deltaIndex);
             uint256 rewardAccrued = userReward[token][user].accrued + rewardDelta;
 
-            userReward[token][user] = UserReward({
-                index: index.Uint128(),
-                accrued: rewardAccrued.Uint128()
-            });
+            userReward[token][user] = UserReward({index: index.Uint128(), accrued: rewardAccrued.Uint128()});
         }
     }
 
-    function _updateRewardIndex()
-        internal
-        virtual
-        returns (address[] memory tokens, uint256[] memory indexes);
+    function _updateRewardIndex() internal virtual returns (address[] memory tokens, uint256[] memory indexes);
 
     function _redeemExternalReward() internal virtual;
 

package/contracts/core/StandardizedYield/SYBase.sol

@@ -6,17 +6,12 @@ import "../erc20/PendleERC20Permit.sol";
 
 import "../libraries/math/PMath.sol";
 import "../libraries/TokenHelper.sol";
+import "../libraries/ArrayLib.sol";
 import "../libraries/Errors.sol";
 import "../libraries/BoringOwnableUpgradeable.sol";
 import "@openzeppelin/contracts/security/Pausable.sol";
 
-abstract contract SYBase is
-    IStandardizedYield,
-    PendleERC20Permit,
-    TokenHelper,
-    BoringOwnableUpgradeable,
-    Pausable
-{
+abstract contract SYBase is IStandardizedYield, PendleERC20Permit, TokenHelper, BoringOwnableUpgradeable, Pausable {
     using PMath for uint256;
 
     address public immutable yieldToken;
@@ -52,8 +47,7 @@ abstract contract SYBase is
         _transferIn(tokenIn, msg.sender, amountTokenToDeposit);
 
         amountSharesOut = _deposit(tokenIn, amountTokenToDeposit);
-        if (amountSharesOut < minSharesOut)
-            revert Errors.SYInsufficientSharesOut(amountSharesOut, minSharesOut);
+        if (amountSharesOut < minSharesOut) revert Errors.SYInsufficientSharesOut(amountSharesOut, minSharesOut);
 
         _mint(receiver, amountSharesOut);
         emit Deposit(msg.sender, receiver, tokenIn, amountTokenToDeposit, amountSharesOut);
@@ -79,8 +73,7 @@ abstract contract SYBase is
         }
 
         amountTokenOut = _redeem(receiver, tokenOut, amountSharesToRedeem);
-        if (amountTokenOut < minTokenOut)
-            revert Errors.SYInsufficientTokenOut(amountTokenOut, minTokenOut);
+        if (amountTokenOut < minTokenOut) revert Errors.SYInsufficientTokenOut(amountTokenOut, minTokenOut);
         emit Redeem(msg.sender, receiver, tokenOut, amountSharesToRedeem, amountTokenOut);
     }
 
@@ -90,10 +83,7 @@ abstract contract SYBase is
      * @param amountDeposited amount of base tokens deposited
      * @return amountSharesOut amount of shares minted
      */
-    function _deposit(
-        address tokenIn,
-        uint256 amountDeposited
-    ) internal virtual returns (uint256 amountSharesOut);
+    function _deposit(address tokenIn, uint256 amountDeposited) internal virtual returns (uint256 amountSharesOut);
 
     /**
      * @notice redeems base tokens based on amount of shares to be burned
@@ -123,31 +113,21 @@ abstract contract SYBase is
     /**
      * @dev See {IStandardizedYield-claimRewards}
      */
-    function claimRewards(
-        address /*user*/
-    ) external virtual override returns (uint256[] memory rewardAmounts) {
+    function claimRewards(address /*user*/) external virtual override returns (uint256[] memory rewardAmounts) {
         rewardAmounts = new uint256[](0);
     }
 
     /**
      * @dev See {IStandardizedYield-getRewardTokens}
      */
-    function getRewardTokens()
-        external
-        view
-        virtual
-        override
-        returns (address[] memory rewardTokens)
-    {
+    function getRewardTokens() external view virtual override returns (address[] memory rewardTokens) {
         rewardTokens = new address[](0);
     }
 
     /**
      * @dev See {IStandardizedYield-accruedRewards}
      */
-    function accruedRewards(
-        address /*user*/
-    ) external view virtual override returns (uint256[] memory rewardAmounts) {
+    function accruedRewards(address /*user*/) external view virtual override returns (uint256[] memory rewardAmounts) {
         rewardAmounts = new uint256[](0);
     }
 
@@ -155,13 +135,7 @@ abstract contract SYBase is
         indexes = new uint256[](0);
     }
 
-    function rewardIndexesStored()
-        external
-        view
-        virtual
-        override
-        returns (uint256[] memory indexes)
-    {
+    function rewardIndexesStored() external view virtual override returns (uint256[] memory indexes) {
         indexes = new uint256[](0);
     }
 
@@ -193,11 +167,7 @@ abstract contract SYBase is
         _unpause();
     }
 
-    function _beforeTokenTransfer(
-        address,
-        address,
-        uint256
-    ) internal virtual override whenNotPaused {}
+    function _beforeTokenTransfer(address, address, uint256) internal virtual override whenNotPaused {}
 
     function _previewDeposit(
         address tokenIn,

package/contracts/core/StandardizedYield/SYBaseUpg.sol

@@ -0,0 +1,197 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity ^0.8.17;
+
+import "../../interfaces/IStandardizedYield.sol";
+
+import "../erc20/PendleERC20PermitUpg.sol";
+
+import "../libraries/math/PMath.sol";
+import "../libraries/TokenHelper.sol";
+import "../libraries/Errors.sol";
+import "../libraries/BoringOwnableUpgradeable.sol";
+import "@openzeppelin/contracts/security/Pausable.sol";
+
+abstract contract SYBaseUpg is
+    IStandardizedYield,
+    PendleERC20PermitUpg,
+    TokenHelper,
+    BoringOwnableUpgradeable,
+    Pausable
+{
+    using PMath for uint256;
+
+    address public immutable yieldToken;
+
+    uint256[100] private __gap;
+
+    constructor(address _yieldToken) PendleERC20Upg(IERC20Metadata(_yieldToken).decimals()) {
+        yieldToken = _yieldToken;
+    }
+
+    function __SYBaseUpg_init(string memory name_, string memory symbol_) internal onlyInitializing {
+        __ERC20PermitUpg_init(name_, symbol_);
+        __BoringOwnable_init();
+    }
+
+    // solhint-disable no-empty-blocks
+    receive() external payable {}
+
+    /*///////////////////////////////////////////////////////////////
+                    DEPOSIT/REDEEM USING BASE TOKENS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     * @dev See {IStandardizedYield-deposit}
+     */
+    function deposit(
+        address receiver,
+        address tokenIn,
+        uint256 amountTokenToDeposit,
+        uint256 minSharesOut
+    ) external payable nonReentrant returns (uint256 amountSharesOut) {
+        if (!isValidTokenIn(tokenIn)) revert Errors.SYInvalidTokenIn(tokenIn);
+        if (amountTokenToDeposit == 0) revert Errors.SYZeroDeposit();
+
+        _transferIn(tokenIn, msg.sender, amountTokenToDeposit);
+
+        amountSharesOut = _deposit(tokenIn, amountTokenToDeposit);
+        if (amountSharesOut < minSharesOut) revert Errors.SYInsufficientSharesOut(amountSharesOut, minSharesOut);
+
+        _mint(receiver, amountSharesOut);
+        emit Deposit(msg.sender, receiver, tokenIn, amountTokenToDeposit, amountSharesOut);
+    }
+
+    /**
+     * @dev See {IStandardizedYield-redeem}
+     */
+    function redeem(
+        address receiver,
+        uint256 amountSharesToRedeem,
+        address tokenOut,
+        uint256 minTokenOut,
+        bool burnFromInternalBalance
+    ) external nonReentrant returns (uint256 amountTokenOut) {
+        if (!isValidTokenOut(tokenOut)) revert Errors.SYInvalidTokenOut(tokenOut);
+        if (amountSharesToRedeem == 0) revert Errors.SYZeroRedeem();
+
+        if (burnFromInternalBalance) {
+            _burn(address(this), amountSharesToRedeem);
+        } else {
+            _burn(msg.sender, amountSharesToRedeem);
+        }
+
+        amountTokenOut = _redeem(receiver, tokenOut, amountSharesToRedeem);
+        if (amountTokenOut < minTokenOut) revert Errors.SYInsufficientTokenOut(amountTokenOut, minTokenOut);
+        emit Redeem(msg.sender, receiver, tokenOut, amountSharesToRedeem, amountTokenOut);
+    }
+
+    /**
+     * @notice mint shares based on the deposited base tokens
+     * @param tokenIn base token address used to mint shares
+     * @param amountDeposited amount of base tokens deposited
+     * @return amountSharesOut amount of shares minted
+     */
+    function _deposit(address tokenIn, uint256 amountDeposited) internal virtual returns (uint256 amountSharesOut);
+
+    /**
+     * @notice redeems base tokens based on amount of shares to be burned
+     * @param tokenOut address of the base token to be redeemed
+     * @param amountSharesToRedeem amount of shares to be burned
+     * @return amountTokenOut amount of base tokens redeemed
+     */
+    function _redeem(
+        address receiver,
+        address tokenOut,
+        uint256 amountSharesToRedeem
+    ) internal virtual returns (uint256 amountTokenOut);
+
+    /*///////////////////////////////////////////////////////////////
+                               EXCHANGE-RATE
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     * @dev See {IStandardizedYield-exchangeRate}
+     */
+    function exchangeRate() external view virtual override returns (uint256 res);
+
+    /*///////////////////////////////////////////////////////////////
+                               REWARDS-RELATED
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     * @dev See {IStandardizedYield-claimRewards}
+     */
+    function claimRewards(address /*user*/) external virtual override returns (uint256[] memory rewardAmounts) {
+        rewardAmounts = new uint256[](0);
+    }
+
+    /**
+     * @dev See {IStandardizedYield-getRewardTokens}
+     */
+    function getRewardTokens() external view virtual override returns (address[] memory rewardTokens) {
+        rewardTokens = new address[](0);
+    }
+
+    /**
+     * @dev See {IStandardizedYield-accruedRewards}
+     */
+    function accruedRewards(address /*user*/) external view virtual override returns (uint256[] memory rewardAmounts) {
+        rewardAmounts = new uint256[](0);
+    }
+
+    function rewardIndexesCurrent() external virtual override returns (uint256[] memory indexes) {
+        indexes = new uint256[](0);
+    }
+
+    function rewardIndexesStored() external view virtual override returns (uint256[] memory indexes) {
+        indexes = new uint256[](0);
+    }
+
+    /*///////////////////////////////////////////////////////////////
+                MISC METADATA FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    function previewDeposit(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) external view virtual returns (uint256 amountSharesOut) {
+        if (!isValidTokenIn(tokenIn)) revert Errors.SYInvalidTokenIn(tokenIn);
+        return _previewDeposit(tokenIn, amountTokenToDeposit);
+    }
+
+    function previewRedeem(
+        address tokenOut,
+        uint256 amountSharesToRedeem
+    ) external view virtual returns (uint256 amountTokenOut) {
+        if (!isValidTokenOut(tokenOut)) revert Errors.SYInvalidTokenOut(tokenOut);
+        return _previewRedeem(tokenOut, amountSharesToRedeem);
+    }
+
+    function pause() external onlyOwner {
+        _pause();
+    }
+
+    function unpause() external onlyOwner {
+        _unpause();
+    }
+
+    function _beforeTokenTransfer(address, address, uint256) internal virtual override whenNotPaused {}
+
+    function _previewDeposit(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal view virtual returns (uint256 amountSharesOut);
+
+    function _previewRedeem(
+        address tokenOut,
+        uint256 amountSharesToRedeem
+    ) internal view virtual returns (uint256 amountTokenOut);
+
+    function getTokensIn() public view virtual returns (address[] memory res);
+
+    function getTokensOut() public view virtual returns (address[] memory res);
+
+    function isValidTokenIn(address token) public view virtual returns (bool);
+
+    function isValidTokenOut(address token) public view virtual returns (bool);
+}

package/contracts/core/StandardizedYield/SYBaseWithRewards.sol

@@ -24,13 +24,9 @@ abstract contract SYBaseWithRewards is SYBase, RewardManager {
     /**
      * @dev See {IStandardizedYield-claimRewards}
      */
-    function claimRewards(address user)
-        external
-        virtual
-        override
-        nonReentrant
-        returns (uint256[] memory rewardAmounts)
-    {
+    function claimRewards(
+        address user
+    ) external virtual override nonReentrant whenNotPaused returns (uint256[] memory rewardAmounts) {
         _updateAndDistributeRewards(user);
         rewardAmounts = _doTransferOutRewards(user, user);
 
@@ -40,26 +36,14 @@ abstract contract SYBaseWithRewards is SYBase, RewardManager {
     /**
      * @dev See {IStandardizedYield-getRewardTokens}
      */
-    function getRewardTokens()
-        external
-        view
-        virtual
-        override
-        returns (address[] memory rewardTokens)
-    {
+    function getRewardTokens() external view virtual override returns (address[] memory rewardTokens) {
         rewardTokens = _getRewardTokens();
     }
 
     /**
      * @dev See {IStandardizedYield-accruedRewards}
      */
-    function accruedRewards(address user)
-        external
-        view
-        virtual
-        override
-        returns (uint256[] memory rewardAmounts)
-    {
+    function accruedRewards(address user) external view virtual override returns (uint256[] memory rewardAmounts) {
         address[] memory rewardTokens = _getRewardTokens();
         rewardAmounts = new uint256[](rewardTokens.length);
         for (uint256 i = 0; i < rewardTokens.length; ) {
@@ -70,23 +54,11 @@ abstract contract SYBaseWithRewards is SYBase, RewardManager {
         }
     }
 
-    function rewardIndexesCurrent()
-        external
-        override
-        nonReentrant
-        returns (uint256[] memory indexes)
-    {
-        _updateRewardIndex();
-        return rewardIndexesStored();
+    function rewardIndexesCurrent() external override nonReentrant whenNotPaused returns (uint256[] memory indexes) {
+        (, indexes) = _updateRewardIndex();
     }
 
-    function rewardIndexesStored()
-        public
-        view
-        virtual
-        override
-        returns (uint256[] memory indexes)
-    {
+    function rewardIndexesStored() public view virtual override returns (uint256[] memory indexes) {
         address[] memory rewardTokens = _getRewardTokens();
         indexes = new uint256[](rewardTokens.length);
         for (uint256 i = 0; i < rewardTokens.length; ) {
@@ -116,11 +88,7 @@ abstract contract SYBaseWithRewards is SYBase, RewardManager {
     /*///////////////////////////////////////////////////////////////
                             TRANSFER HOOKS
     //////////////////////////////////////////////////////////////*/
-    function _beforeTokenTransfer(
-        address from,
-        address to,
-        uint256
-    ) internal virtual override whenNotPaused {
+    function _beforeTokenTransfer(address from, address to, uint256) internal virtual override whenNotPaused {
         _updateAndDistributeRewardsForTwo(from, to);
     }
 }