@pendle/core-v2 2.1.2-mainnet → 2.2.0-mainnet

package/contracts/core/StandardizedYield/implementations/BalancerStable/PendleAuraWethWstethSY.sol

@@ -16,12 +16,10 @@ contract PendleAuraWethWstethSY is PendleAuraBalancerStableLPSY, StEthHelper {
         MetaStablePreview _previewHelper
     ) PendleAuraBalancerStableLPSY(_name, _symbol, LP, AURA_PID, _previewHelper) StEthHelper() {}
 
-    function _deposit(address tokenIn, uint256 amount)
-        internal
-        virtual
-        override
-        returns (uint256 amountSharesOut)
-    {
+    function _deposit(
+        address tokenIn,
+        uint256 amount
+    ) internal virtual override returns (uint256 amountSharesOut) {
         if (tokenIn == NATIVE) {
             IWETH(WETH).deposit{ value: amount }();
             amountSharesOut = super._deposit(WETH, amount);
@@ -50,13 +48,10 @@ contract PendleAuraWethWstethSY is PendleAuraBalancerStableLPSY, StEthHelper {
         }
     }
 
-    function _previewDeposit(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        view
-        virtual
-        override
-        returns (uint256 amountSharesOut)
-    {
+    function _previewDeposit(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal view virtual override returns (uint256 amountSharesOut) {
         if (tokenIn == NATIVE) {
             amountSharesOut = super._previewDeposit(WETH, amountTokenToDeposit);
         } else if (tokenIn == STETH) {
@@ -67,13 +62,10 @@ contract PendleAuraWethWstethSY is PendleAuraBalancerStableLPSY, StEthHelper {
         }
     }
 
-    function _previewRedeem(address tokenOut, uint256 amountSharesToRedeem)
-        internal
-        view
-        virtual
-        override
-        returns (uint256 amountTokenOut)
-    {
+    function _previewRedeem(
+        address tokenOut,
+        uint256 amountSharesToRedeem
+    ) internal view virtual override returns (uint256 amountTokenOut) {
         if (tokenOut == NATIVE) {
             amountTokenOut = super._previewRedeem(WETH, amountSharesToRedeem);
         } else if (tokenOut == STETH) {

package/contracts/core/StandardizedYield/implementations/BalancerStable/base/MetaStable/MetaStableMath.sol

@@ -293,11 +293,7 @@ library MetaStableMath {
         }
     }
 
-    function div(
-        uint256 a,
-        uint256 b,
-        bool roundUp
-    ) internal pure returns (uint256) {
+    function div(uint256 a, uint256 b, bool roundUp) internal pure returns (uint256) {
         return roundUp ? divUp(a, b) : divDown(a, b);
     }
 

package/contracts/core/StandardizedYield/implementations/BalancerStable/base/MetaStable/MetaStablePreview.sol

@@ -120,15 +120,7 @@ contract MetaStablePreview is StablePreviewBase, BoringOwnableUpgradeable, UUPSU
         uint256[] memory scalingFactors,
         bytes memory userData,
         ImmutableData memory imd
-    )
-        internal
-        view
-        returns (
-            uint256,
-            uint256[] memory,
-            uint256[] memory
-        )
-    {
+    ) internal view returns (uint256, uint256[] memory, uint256[] memory) {
         // skip _updateOracle
 
         uint256[] memory dueProtocolFeeAmounts = _getDueProtocolFeeAmounts(
@@ -291,12 +283,10 @@ contract MetaStablePreview is StablePreviewBase, BoringOwnableUpgradeable, UUPSU
         return (bptAmountIn, amountsOut);
     }
 
-    function _scalingFactors(ImmutableData memory imd, uint256[] memory caches)
-        internal
-        view
-        virtual
-        returns (uint256[] memory)
-    {
+    function _scalingFactors(
+        ImmutableData memory imd,
+        uint256[] memory caches
+    ) internal view virtual returns (uint256[] memory) {
         uint256[] memory scalingFactors = new uint256[](2);
 
         for (uint256 i = 0; i < 2; ++i) {
@@ -306,30 +296,25 @@ contract MetaStablePreview is StablePreviewBase, BoringOwnableUpgradeable, UUPSU
         return scalingFactors;
     }
 
-    function _priceRate(uint256[] memory caches, uint256 index)
-        internal
-        view
-        virtual
-        returns (uint256)
-    {
+    function _priceRate(
+        uint256[] memory caches,
+        uint256 index
+    ) internal view virtual returns (uint256) {
         return caches[index] == 0 ? FixedPoint.ONE : caches[index];
     }
 
-    function _cachePriceRatesIfNecessary(ImmutableData memory imd)
-        internal
-        view
-        returns (uint256[] memory res)
-    {
+    function _cachePriceRatesIfNecessary(
+        ImmutableData memory imd
+    ) internal view returns (uint256[] memory res) {
         res = new uint256[](2);
         res[0] = _cachePriceRateIfNecessary(0, imd);
         res[1] = _cachePriceRateIfNecessary(1, imd);
     }
 
-    function _cachePriceRateIfNecessary(uint256 index, ImmutableData memory imd)
-        internal
-        view
-        returns (uint256 res)
-    {
+    function _cachePriceRateIfNecessary(
+        uint256 index,
+        ImmutableData memory imd
+    ) internal view returns (uint256 res) {
         if (!_hasRateProvider(imd, index)) return res;
 
         uint256 expires;
@@ -346,10 +331,10 @@ contract MetaStablePreview is StablePreviewBase, BoringOwnableUpgradeable, UUPSU
                                Helpers functions
     //////////////////////////////////////////////////////////////*/
 
-    function _upscaleArray(uint256[] memory amounts, uint256[] memory scalingFactors)
-        internal
-        pure
-    {
+    function _upscaleArray(
+        uint256[] memory amounts,
+        uint256[] memory scalingFactors
+    ) internal pure {
         require(amounts.length == scalingFactors.length, "Array length mismatch");
 
         uint256 length = amounts.length;
@@ -358,10 +343,10 @@ contract MetaStablePreview is StablePreviewBase, BoringOwnableUpgradeable, UUPSU
         }
     }
 
-    function _downscaleDownArray(uint256[] memory amounts, uint256[] memory scalingFactors)
-        internal
-        pure
-    {
+    function _downscaleDownArray(
+        uint256[] memory amounts,
+        uint256[] memory scalingFactors
+    ) internal pure {
         require(amounts.length == scalingFactors.length, "Array length mismatch");
 
         uint256 length = amounts.length;
@@ -380,11 +365,10 @@ contract MetaStablePreview is StablePreviewBase, BoringOwnableUpgradeable, UUPSU
         }
     }
 
-    function _hasRateProvider(ImmutableData memory imd, uint256 index)
-        internal
-        pure
-        returns (bool)
-    {
+    function _hasRateProvider(
+        ImmutableData memory imd,
+        uint256 index
+    ) internal pure returns (bool) {
         return address(imd.rateProviders[index]) != address(0);
     }
 }

package/contracts/core/StandardizedYield/implementations/BalancerStable/base/PendleAuraBalancerStableLPSY.sol

@@ -55,11 +55,9 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
         previewHelper = _previewHelper;
     }
 
-    function _getPoolInfo(uint256 _auraPid)
-        internal
-        view
-        returns (address _auraLp, address _auraRewardManager)
-    {
+    function _getPoolInfo(
+        uint256 _auraPid
+    ) internal view returns (address _auraLp, address _auraRewardManager) {
         if (_auraPid > IBooster(AURA_BOOSTER).poolLength()) revert Errors.SYBalancerInvalidPid();
         (_auraLp, , , _auraRewardManager, , ) = IBooster(AURA_BOOSTER).poolInfo(_auraPid);
     }
@@ -71,12 +69,10 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
     /**
      * @notice Either wraps LP, or also joins pool using exact tokenIn
      */
-    function _deposit(address tokenIn, uint256 amount)
-        internal
-        virtual
-        override
-        returns (uint256 amountSharesOut)
-    {
+    function _deposit(
+        address tokenIn,
+        uint256 amount
+    ) internal virtual override returns (uint256 amountSharesOut) {
         if (tokenIn == balLp) {
             amountSharesOut = amount;
         } else {
@@ -111,11 +107,10 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
                     BALANCER-RELATED FUNCTIONS
     //////////////////////////////////////////////////////////////*/
 
-    function _depositToBalancer(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        virtual
-        returns (uint256)
-    {
+    function _depositToBalancer(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal virtual returns (uint256) {
         IVault.JoinPoolRequest memory request = _assembleJoinRequest(
             tokenIn,
             amountTokenToDeposit
@@ -126,12 +121,10 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
         return _selfBalance(balLp);
     }
 
-    function _assembleJoinRequest(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        view
-        virtual
-        returns (IVault.JoinPoolRequest memory request)
-    {
+    function _assembleJoinRequest(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal view virtual returns (IVault.JoinPoolRequest memory request) {
         // max amounts in
         address[] memory assets = _getPoolTokenAddresses();
 
@@ -173,12 +166,10 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
         return balanceAfter - balanceBefore;
     }
 
-    function _assembleExitRequest(address tokenOut, uint256 amountLpToRedeem)
-        internal
-        view
-        virtual
-        returns (IVault.ExitPoolRequest memory request)
-    {
+    function _assembleExitRequest(
+        address tokenOut,
+        uint256 amountLpToRedeem
+    ) internal view virtual returns (IVault.ExitPoolRequest memory request) {
         address[] memory assets = _getPoolTokenAddresses();
         uint256[] memory minAmountsOut = new uint256[](assets.length);
 
@@ -210,13 +201,10 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
                    PREVIEW FUNCTIONS
     //////////////////////////////////////////////////////////////*/
 
-    function _previewDeposit(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        view
-        virtual
-        override
-        returns (uint256 amountSharesOut)
-    {
+    function _previewDeposit(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal view virtual override returns (uint256 amountSharesOut) {
         if (tokenIn == balLp) {
             amountSharesOut = amountTokenToDeposit;
         } else {
@@ -234,13 +222,10 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
         }
     }
 
-    function _previewRedeem(address tokenOut, uint256 amountSharesToRedeem)
-        internal
-        view
-        virtual
-        override
-        returns (uint256 amountTokenOut)
-    {
+    function _previewRedeem(
+        address tokenOut,
+        uint256 amountSharesToRedeem
+    ) internal view virtual override returns (uint256 amountTokenOut) {
         if (tokenOut == balLp) {
             amountTokenOut = amountSharesToRedeem;
         } else {
@@ -318,11 +303,7 @@ abstract contract PendleAuraBalancerStableLPSY is SYBaseWithRewards {
     function assetInfo()
         external
         view
-        returns (
-            AssetType assetType,
-            address assetAddress,
-            uint8 assetDecimals
-        )
+        returns (AssetType assetType, address assetAddress, uint8 assetDecimals)
     {
         return (AssetType.LIQUIDITY, balLp, IERC20Metadata(balLp).decimals());
     }

package/contracts/core/StandardizedYield/implementations/BalancerStable/base/StablePoolUserData.sol

@@ -12,19 +12,15 @@ library StablePoolUserData {
         BPT_IN_FOR_EXACT_TOKENS_OUT
     }
 
-    function exactTokensInForBptOut(bytes memory self)
-        internal
-        pure
-        returns (uint256[] memory amountsIn, uint256 minBPTAmountOut)
-    {
+    function exactTokensInForBptOut(
+        bytes memory self
+    ) internal pure returns (uint256[] memory amountsIn, uint256 minBPTAmountOut) {
         (, amountsIn, minBPTAmountOut) = abi.decode(self, (JoinKind, uint256[], uint256));
     }
 
-    function exactBptInForTokenOut(bytes memory self)
-        internal
-        pure
-        returns (uint256 bptAmountIn, uint256 tokenIndex)
-    {
+    function exactBptInForTokenOut(
+        bytes memory self
+    ) internal pure returns (uint256 bptAmountIn, uint256 tokenIndex) {
         (, bptAmountIn, tokenIndex) = abi.decode(self, (ExitKind, uint256, uint256));
     }
 }

package/contracts/core/StandardizedYield/implementations/BalancerStable/base/StablePreviewBase.sol

@@ -143,22 +143,18 @@ abstract contract StablePreviewBase is IBalancerStablePreview {
         return address(asset) == address(0) ? IERC20(WETH) : IERC20(address(asset));
     }
 
-    function _toPoolBalanceChange(IVault.JoinPoolRequest memory request)
-        private
-        pure
-        returns (PoolBalanceChange memory change)
-    {
+    function _toPoolBalanceChange(
+        IVault.JoinPoolRequest memory request
+    ) private pure returns (PoolBalanceChange memory change) {
         // solhint-disable-next-line no-inline-assembly
         assembly {
             change := request
         }
     }
 
-    function _toPoolBalanceChange(IVault.ExitPoolRequest memory request)
-        private
-        pure
-        returns (PoolBalanceChange memory change)
-    {
+    function _toPoolBalanceChange(
+        IVault.ExitPoolRequest memory request
+    ) private pure returns (PoolBalanceChange memory change) {
         // solhint-disable-next-line no-inline-assembly
         assembly {
             change := request

package/contracts/core/StandardizedYield/implementations/BenQi/PendleQiTokenSY.sol

@@ -50,11 +50,10 @@ contract PendleQiTokenSY is SYBaseWithRewards, PendleQiTokenHelper {
      *
      * The exchange rate of qiToken to shares is 1:1
      */
-    function _deposit(address tokenIn, uint256 amount)
-        internal
-        override
-        returns (uint256 amountSharesOut)
-    {
+    function _deposit(
+        address tokenIn,
+        uint256 amount
+    ) internal override returns (uint256 amountSharesOut) {
         if (tokenIn == qiToken) {
             amountSharesOut = amount;
         } else {
@@ -155,22 +154,18 @@ contract PendleQiTokenSY is SYBaseWithRewards, PendleQiTokenHelper {
                     MISC FUNCTIONS FOR METADATA
     //////////////////////////////////////////////////////////////*/
 
-    function _previewDeposit(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        view
-        override
-        returns (uint256 amountSharesOut)
-    {
+    function _previewDeposit(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal view override returns (uint256 amountSharesOut) {
         if (tokenIn == qiToken) amountSharesOut = amountTokenToDeposit;
         else amountSharesOut = (amountTokenToDeposit * 1e18) / exchangeRate();
     }
 
-    function _previewRedeem(address tokenOut, uint256 amountSharesToRedeem)
-        internal
-        view
-        override
-        returns (uint256 amountTokenOut)
-    {
+    function _previewRedeem(
+        address tokenOut,
+        uint256 amountSharesToRedeem
+    ) internal view override returns (uint256 amountTokenOut) {
         if (tokenOut == qiToken) amountTokenOut = amountSharesToRedeem;
         else amountTokenOut = (amountSharesToRedeem * exchangeRate()) / 1e18;
     }
@@ -198,11 +193,7 @@ contract PendleQiTokenSY is SYBaseWithRewards, PendleQiTokenHelper {
     function assetInfo()
         external
         view
-        returns (
-            AssetType assetType,
-            address assetAddress,
-            uint8 assetDecimals
-        )
+        returns (AssetType assetType, address assetAddress, uint8 assetDecimals)
     {
         return (
             AssetType.TOKEN,

package/contracts/core/StandardizedYield/implementations/Convex/PendleCurveFraxUsdcSY.sol

@@ -13,7 +13,10 @@ contract PendleCurveFraxUsdcSY is PendleConvexLPSY {
     address public constant FRAX = CurveFraxUsdcPoolHelper.FRAX;
     address public constant USDC = CurveFraxUsdcPoolHelper.USDC;
 
-    constructor(string memory _name, string memory _symbol)
+    constructor(
+        string memory _name,
+        string memory _symbol
+    )
         PendleConvexLPSY(
             _name,
             _symbol,
@@ -26,23 +29,19 @@ contract PendleCurveFraxUsdcSY is PendleConvexLPSY {
         _safeApproveInf(USDC, crvPool);
     }
 
-    function _depositToCurve(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        virtual
-        override
-        returns (uint256 amountLpOut)
-    {
+    function _depositToCurve(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal virtual override returns (uint256 amountLpOut) {
         uint256[2] memory amounts;
         amounts[_getIndex(tokenIn)] = amountTokenToDeposit;
         amountLpOut = ICrvPool(crvPool).add_liquidity(amounts, 0);
     }
 
-    function _redeemFromCurve(address tokenOut, uint256 amountLpToRedeem)
-        internal
-        virtual
-        override
-        returns (uint256 amountTokenOut)
-    {
+    function _redeemFromCurve(
+        address tokenOut,
+        uint256 amountLpToRedeem
+    ) internal virtual override returns (uint256 amountTokenOut) {
         amountTokenOut = ICrvPool(crvPool).remove_liquidity_one_coin(
             amountLpToRedeem,
             Math.Int128(_getIndex(tokenOut)),
@@ -50,23 +49,17 @@ contract PendleCurveFraxUsdcSY is PendleConvexLPSY {
         );
     }
 
-    function _previewDepositToCurve(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        view
-        virtual
-        override
-        returns (uint256)
-    {
+    function _previewDepositToCurve(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal view virtual override returns (uint256) {
         return CurveFraxUsdcPoolHelper.previewAddLiquidity(tokenIn, amountTokenToDeposit);
     }
 
-    function _previewRedeemFromCurve(address tokenOut, uint256 amountLpToRedeem)
-        internal
-        view
-        virtual
-        override
-        returns (uint256)
-    {
+    function _previewRedeemFromCurve(
+        address tokenOut,
+        uint256 amountLpToRedeem
+    ) internal view virtual override returns (uint256) {
         return
             ICrvPool(crvPool).calc_withdraw_one_coin(
                 amountLpToRedeem,

package/contracts/core/StandardizedYield/implementations/Convex/PendleCurveUsdd3CrvSY.sol

@@ -17,7 +17,10 @@ contract PendleCurveUsdd3CrvSY is PendleConvexLPSY {
     address public constant POOL_3CRV = Curve3CrvPoolHelper.POOL;
     uint256 public constant INDEX_OF_3CRV = 1;
 
-    constructor(string memory _name, string memory _symbol)
+    constructor(
+        string memory _name,
+        string memory _symbol
+    )
         PendleConvexLPSY(
             _name,
             _symbol,
@@ -33,12 +36,10 @@ contract PendleCurveUsdd3CrvSY is PendleConvexLPSY {
         _safeApproveInf(USDT, POOL_3CRV);
     }
 
-    function _depositToCurve(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        virtual
-        override
-        returns (uint256 amountLpOut)
-    {
+    function _depositToCurve(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal virtual override returns (uint256 amountLpOut) {
         uint256 preBalanceLp = _selfBalance(crvLp);
 
         uint256[2] memory amounts;
@@ -56,12 +57,10 @@ contract PendleCurveUsdd3CrvSY is PendleConvexLPSY {
         amountLpOut = _selfBalance(crvLp) - preBalanceLp;
     }
 
-    function _redeemFromCurve(address tokenOut, uint256 amountLpToRedeem)
-        internal
-        virtual
-        override
-        returns (uint256 amountTokenOut)
-    {
+    function _redeemFromCurve(
+        address tokenOut,
+        uint256 amountLpToRedeem
+    ) internal virtual override returns (uint256 amountTokenOut) {
         address tokenToRemove = (tokenOut == USDD) ? USDD : LP_3CRV;
 
         uint256 preBalanceToken = _selfBalance(tokenToRemove);
@@ -82,23 +81,17 @@ contract PendleCurveUsdd3CrvSY is PendleConvexLPSY {
         }
     }
 
-    function _previewDepositToCurve(address tokenIn, uint256 amountTokenToDeposit)
-        internal
-        view
-        virtual
-        override
-        returns (uint256)
-    {
+    function _previewDepositToCurve(
+        address tokenIn,
+        uint256 amountTokenToDeposit
+    ) internal view virtual override returns (uint256) {
         return CurveUsdd3CrvPoolHelper.previewAddLiquidity(tokenIn, amountTokenToDeposit);
     }
 
-    function _previewRedeemFromCurve(address tokenOut, uint256 amountLpToRedeem)
-        internal
-        view
-        virtual
-        override
-        returns (uint256)
-    {
+    function _previewRedeemFromCurve(
+        address tokenOut,
+        uint256 amountLpToRedeem
+    ) internal view virtual override returns (uint256) {
         address tokenToRemove = tokenOut == USDD ? USDD : LP_3CRV;
         uint256 amountTokenRemoved = ICrvPool(crvPool).calc_withdraw_one_coin(
             amountLpToRedeem,

package/contracts/core/StandardizedYield/implementations/Convex/README.md

@@ -1,4 +1,4 @@
-# PENDLE Curve/Convex SY 
+# PENDLE Curve/Convex SY
 
 For the simplicity of the writeup, we will describe only the noticable properties of `PendleCurveUSDD3CrvSY`. `PendleCurveFraxUsdcSY` contract should contain only a subset of those properties compared to USDD one.
 
@@ -22,8 +22,8 @@ Before getting to this, we would like to note that preview functions will play a
 
 For preview redeem, Curve provides a view function of `calc_withdraw_one_coin` which accurately returns the amount of token can be redeem by user with a particular amount of LP.
 
-For previde deposit, Curve's provided function `calc_token_amount` does not take into account the fee, thus, it does not return the actual amount of lp token user can get. 
+For previde deposit, Curve's provided function `calc_token_amount` does not take into account the fee, thus, it does not return the actual amount of lp token user can get.
 
-We implemented a workaround for previewDeposit in `CurveUsdd3CrvPoolHelper` and `Curve3CrvPoolHelper` to simulate the calculation happened in Curve's code base. 
+We implemented a workaround for previewDeposit in `CurveUsdd3CrvPoolHelper` and `Curve3CrvPoolHelper` to simulate the calculation happened in Curve's code base.
 
-Another thing to note is that `CurveUsdd3CrvPoolHelper`'s preivew deposit result has a dependency on the `3crv.get_virtual_price`. So the simulation should also take into account the case when user deposits with DAI/USDC/USDT, the state of 3Crv pool changes, and thus the `get_virtual_price` of 3crv changes.
+Another thing to note is that `CurveUsdd3CrvPoolHelper`'s preivew deposit result has a dependency on the `3crv.get_virtual_price`. So the simulation should also take into account the case when user deposits with DAI/USDC/USDT, the state of 3Crv pool changes, and thus the `get_virtual_price` of 3crv changes.