@pendle/core-v2 1.4.1-testnet → 1.4.2-testnet

package/contracts/interfaces/IPRouterHelper.sol

@@ -0,0 +1,168 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity 0.8.17;
+
+import "../router/base/MarketApproxLib.sol";
+import "../router/base/ActionBaseMintRedeem.sol";
+
+interface IPRouterHelper {
+    /**
+     * @param output This output struct should be filled the same way as the normal removeLiquiditySingleToken
+     operation (This means all BulkSeller, PendleSwap still works the same way). Note that the
+     output.tokenOut will also be used as the input token for the addLiquidity
+     */
+    struct RemoveLiquiditySingleTokenStruct {
+        address market;
+        uint256 netLpToRemove;
+        bool doRedeemRewards;
+        TokenOutput output;
+    }
+
+    /**
+     * @param guessNetTokenIn the predicted amount of tokenIn that will be used to add liquidity. This
+     should be the same amount that was used to generate guessPtReceivedFromSy (if any).
+     * @param guessPtReceivedFromSy the same guess struct in the normal addLiquiditySingleToken operation.
+     Again, note that this struct, if not empty (i.e. if guessOffchain == 0), should be generated
+     using `guessNetTokenIn` amount of tokenIn
+     * @dev tokenIn is the output.tokenOut of the removeLiquiditySingleTokenStruct
+     */
+    struct AddLiquiditySingleTokenStruct {
+        address market;
+        uint256 minLpOut;
+        uint256 guessNetTokenIn;
+        ApproxParams guessPtReceivedFromSy;
+        address bulk;
+    }
+
+    /**
+     * @dev tokenIn is the output.tokenOut of the removeLiquiditySingleTokenStruct
+     */
+    struct AddLiquiditySingleTokenKeepYtStruct {
+        address market;
+        uint256 minLpOut;
+        uint256 minYtOut;
+        address bulk;
+    }
+
+    struct RemoveLiquiditySingleSyStruct {
+        address market;
+        uint256 netLpToRemove;
+        bool doRedeemRewards;
+    }
+
+    /**
+     * @dev guessNetSyIn & guessPtReceivedFromSy have similar meanings to AddLiquiditySingleTokenStruct
+     */
+    struct AddLiquiditySingleSyStruct {
+        address market;
+        uint256 minLpOut;
+        uint256 guessNetSyIn;
+        ApproxParams guessPtReceivedFromSy;
+    }
+
+    struct AddLiquiditySingleSyKeepYtStruct {
+        address market;
+        uint256 minLpOut;
+        uint256 minYtOut;
+    }
+
+    event RemoveLiquiditySingleToken(
+        address indexed caller,
+        address indexed market,
+        address indexed token,
+        address receiver,
+        uint256 netLpToRemove,
+        uint256 netTokenOut
+    );
+
+    event RemoveLiquiditySingleSy(
+        address indexed caller,
+        address indexed market,
+        address indexed receiver,
+        uint256 netLpToRemove,
+        uint256 netSyOut
+    );
+
+    event AddLiquiditySingleToken(
+        address indexed caller,
+        address indexed market,
+        address indexed token,
+        address receiver,
+        uint256 netTokenIn,
+        uint256 netLpOut
+    );
+
+    event AddLiquiditySingleSy(
+        address indexed caller,
+        address indexed market,
+        address indexed receiver,
+        uint256 netSyIn,
+        uint256 netLpOut
+    );
+
+    event AddLiquiditySingleTokenKeepYt(
+        address indexed caller,
+        address indexed market,
+        address indexed token,
+        address receiver,
+        uint256 netTokenIn,
+        uint256 netLpOut,
+        uint256 netYtOut
+    );
+
+    event AddLiquiditySingleSyKeepYt(
+        address indexed caller,
+        address indexed market,
+        address indexed receiver,
+        uint256 netSyIn,
+        uint256 netLpOut,
+        uint256 netYtOut
+    );
+
+    function transferLiquidityDifferentSyNormal(
+        RemoveLiquiditySingleTokenStruct calldata fromMarket,
+        AddLiquiditySingleTokenStruct calldata toMarket
+    )
+        external
+        returns (
+            uint256 netLpOut,
+            uint256 netTokenZapIn,
+            uint256 netSyFeeOfRemove,
+            uint256 netSyFeeOfAdd
+        );
+
+    function transferLiquidityDifferentSyKeepYt(
+        RemoveLiquiditySingleTokenStruct calldata fromMarket,
+        AddLiquiditySingleTokenKeepYtStruct calldata toMarket
+    )
+        external
+        returns (
+            uint256 netLpOut,
+            uint256 netYtOut,
+            uint256 netTokenZapIn,
+            uint256 netSyFeeOfRemove
+        );
+
+    function transferLiquiditySameSyNormal(
+        RemoveLiquiditySingleSyStruct calldata fromMarket,
+        AddLiquiditySingleSyStruct calldata toMarket
+    )
+        external
+        returns (
+            uint256 netLpOut,
+            uint256 netSyZapIn,
+            uint256 netSyFeeOfRemove,
+            uint256 netSyFeeOfAdd
+        );
+
+    function transferLiquiditySameSyKeepYt(
+        RemoveLiquiditySingleSyStruct calldata fromMarket,
+        AddLiquiditySingleSyKeepYtStruct calldata toMarket
+    )
+        external
+        returns (
+            uint256 netLpOut,
+            uint256 netYtOut,
+            uint256 netSyZapIn,
+            uint256 netSyFeeOfRemove
+        );
+}

package/contracts/router/PendleRouterHelper.sol

@@ -3,22 +3,35 @@ pragma solidity 0.8.17;
 
 import "../interfaces/IPAllAction.sol";
 import "../interfaces/IPMarket.sol";
-import "../interfaces/IPLiquidityMigrator.sol";
+import "../interfaces/IPRouterHelper.sol";
 import "./base/ActionBaseMintRedeem.sol";
 import "./base/MarketApproxLib.sol";
+import "../interfaces/IAddressProvider.sol";
 
-contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
-    IPAllAction private immutable ROUTER;
-    address private immutable WETH;
+contract PendleRouterHelper is TokenHelper, IPRouterHelper {
+    IPAllAction public immutable ROUTER;
+    address public immutable WETH;
 
-    constructor(address _ROUTER, address _WETH) {
+    constructor(address _ROUTER, IAddressProvider provider) {
         ROUTER = IPAllAction(_ROUTER);
-        WETH = _WETH;
+        WETH = _getWETHAddress(provider, 1);
+    }
+
+    function _getWETHAddress(IAddressProvider provider, uint256 providerId)
+        internal
+        view
+        returns (address)
+    {
+        return provider.get(providerId);
     }
 
     receive() external payable {}
 
-    /// @dev input should be all based on input token being WETH
+    /**
+     * @dev all the parameters for this function should be generated in the same way as they are
+     generated for the main Router, except that input.tokenIn & swapData should be generated
+     for tokenIn == WETH instead of ETH
+     */
     function addLiquiditySingleTokenKeepYtWithEth(
         address receiver,
         address market,
@@ -26,10 +39,11 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
         uint256 minYtOut,
         TokenInput calldata input
     ) external payable returns (uint256 netLpOut, uint256 netYtOut) {
-        _wrap_unwrap_ETH(NATIVE, WETH, msg.value);
+        require(input.tokenIn == WETH);
 
-        _safeApproveInf(WETH, address(ROUTER));
+        _transferIn(NATIVE, msg.sender, input.netTokenIn);
 
+        _wrap_unwrap_ETH(NATIVE, WETH, input.netTokenIn);
         (netLpOut, netYtOut) = ROUTER.addLiquiditySingleTokenKeepYt(
             receiver,
             market,
@@ -37,11 +51,19 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
             minYtOut,
             input
         );
-    }
 
-    // ============ Same SY ============
+        emit AddLiquiditySingleTokenKeepYt(
+            msg.sender,
+            market,
+            NATIVE,
+            msg.sender,
+            input.netTokenIn,
+            netLpOut,
+            netYtOut
+        );
+    }
 
-    function migrateDifferentSyNormal(
+    function transferLiquidityDifferentSyNormal(
         RemoveLiquiditySingleTokenStruct calldata fromMarket,
         AddLiquiditySingleTokenStruct calldata toMarket
     )
@@ -59,17 +81,9 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
             fromMarket.output.tokenOut,
             netTokenZapIn
         );
-
-        emit MigrateDifferentSyNormal(
-            fromMarket.market,
-            toMarket.market,
-            msg.sender,
-            fromMarket.netLpToRemove,
-            netLpOut
-        );
     }
 
-    function migrateDifferentSyKeepYt(
+    function transferLiquidityDifferentSyKeepYt(
         RemoveLiquiditySingleTokenStruct calldata fromMarket,
         AddLiquiditySingleTokenKeepYtStruct calldata toMarket
     )
@@ -87,41 +101,25 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
             fromMarket.output.tokenOut,
             netTokenZapIn
         );
-
-        emit MigrateDifferentSyKeepYt(
-            fromMarket.market,
-            toMarket.market,
-            msg.sender,
-            fromMarket.netLpToRemove,
-            netLpOut,
-            netYtOut
-        );
     }
 
-    function migrateSameSyNormal(
+    function transferLiquiditySameSyNormal(
         RemoveLiquiditySingleSyStruct calldata fromMarket,
         AddLiquiditySingleSyStruct calldata toMarket
     )
         external
         returns (
             uint256 netLpOut,
-            uint256 netSyMigrated,
+            uint256 netSyZapIn,
             uint256 netSyFeeOfRemove,
             uint256 netSyFeeOfAdd
         )
     {
-        (netSyMigrated, netSyFeeOfRemove) = _removeLiquiditySingleSy(fromMarket);
-        (netLpOut, netSyFeeOfAdd) = _addLiquiditySingleSy(toMarket, netSyMigrated);
-        emit MigrateSameSyNormal(
-            fromMarket.market,
-            toMarket.market,
-            msg.sender,
-            fromMarket.netLpToRemove,
-            netLpOut
-        );
+        (netSyZapIn, netSyFeeOfRemove) = _removeLiquiditySingleSy(fromMarket);
+        (netLpOut, netSyFeeOfAdd) = _addLiquiditySingleSy(toMarket, netSyZapIn);
     }
 
-    function migrateSameSyKeepYt(
+    function transferLiquiditySameSyKeepYt(
         RemoveLiquiditySingleSyStruct calldata fromMarket,
         AddLiquiditySingleSyKeepYtStruct calldata toMarket
     )
@@ -129,20 +127,12 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
         returns (
             uint256 netLpOut,
             uint256 netYtOut,
-            uint256 netSyMigrated,
+            uint256 netSyZapIn,
             uint256 netSyFeeOfRemove
         )
     {
-        (netSyMigrated, netSyFeeOfRemove) = _removeLiquiditySingleSy(fromMarket);
-        (netLpOut, netYtOut) = _addLiquiditySingleSyKeepYt(toMarket, netSyMigrated);
-        emit MigrateSameSyKeepYt(
-            fromMarket.market,
-            toMarket.market,
-            msg.sender,
-            fromMarket.netLpToRemove,
-            netLpOut,
-            netYtOut
-        );
+        (netSyZapIn, netSyFeeOfRemove) = _removeLiquiditySingleSy(fromMarket);
+        (netLpOut, netYtOut) = _addLiquiditySingleSyKeepYt(toMarket, netSyZapIn);
     }
 
     function _removeLiquiditySingleToken(RemoveLiquiditySingleTokenStruct calldata fromMarket)
@@ -168,6 +158,15 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
         if (fromMarket.doRedeemRewards) {
             IPMarket(fromMarket.market).redeemRewards(msg.sender);
         }
+
+        emit RemoveLiquiditySingleToken(
+            msg.sender,
+            fromMarket.market,
+            fromMarket.output.tokenOut,
+            msg.sender,
+            fromMarket.netLpToRemove,
+            netTokenOut
+        );
     }
 
     function _removeLiquiditySingleSy(RemoveLiquiditySingleSyStruct calldata fromMarket)
@@ -193,6 +192,14 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
         if (fromMarket.doRedeemRewards) {
             IPMarket(fromMarket.market).redeemRewards(msg.sender);
         }
+
+        emit RemoveLiquiditySingleSy(
+            msg.sender,
+            fromMarket.market,
+            msg.sender,
+            fromMarket.netLpToRemove,
+            netSyOut
+        );
     }
 
     function _addLiquiditySingleToken(
@@ -218,6 +225,15 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
             ),
             _newTokenInputStruct(tokenToZapIn, actualNetTokenIn, toMarket.bulk)
         );
+
+        emit AddLiquiditySingleToken(
+            msg.sender,
+            toMarket.market,
+            tokenToZapIn,
+            msg.sender,
+            actualNetTokenIn,
+            netLpOut
+        );
     }
 
     function _addLiquiditySingleSy(
@@ -239,13 +255,21 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
                 actualNetSyIn
             )
         );
+
+        emit AddLiquiditySingleSy(
+            msg.sender,
+            toMarket.market,
+            msg.sender,
+            actualNetSyIn,
+            netLpOut
+        );
     }
 
     function _addLiquiditySingleTokenKeepYt(
         AddLiquiditySingleTokenKeepYtStruct calldata toMarket,
         address tokenToZapIn,
         uint256 actualNetTokenIn
-    ) internal returns (uint256 netLpOut, uint256 netSyFee) {
+    ) internal returns (uint256 netLpOut, uint256 netYtOut) {
         if (tokenToZapIn == NATIVE) {
             tokenToZapIn = WETH;
             _wrap_unwrap_ETH(NATIVE, WETH, actualNetTokenIn);
@@ -253,13 +277,23 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
 
         _safeApproveInf(tokenToZapIn, address(ROUTER));
 
-        (netLpOut, netSyFee) = ROUTER.addLiquiditySingleTokenKeepYt(
+        (netLpOut, netYtOut) = ROUTER.addLiquiditySingleTokenKeepYt(
             msg.sender,
             toMarket.market,
             toMarket.minLpOut,
             toMarket.minYtOut,
             _newTokenInputStruct(tokenToZapIn, actualNetTokenIn, toMarket.bulk)
         );
+
+        emit AddLiquiditySingleTokenKeepYt(
+            msg.sender,
+            toMarket.market,
+            tokenToZapIn,
+            msg.sender,
+            actualNetTokenIn,
+            netLpOut,
+            netYtOut
+        );
     }
 
     function _addLiquiditySingleSyKeepYt(
@@ -277,6 +311,15 @@ contract PendleRouterHelper is TokenHelper, IPLiquidityMigrator {
             toMarket.minLpOut,
             toMarket.minYtOut
         );
+
+        emit AddLiquiditySingleSyKeepYt(
+            msg.sender,
+            toMarket.market,
+            msg.sender,
+            actualNetSyIn,
+            netLpOut,
+            netYtOut
+        );
     }
 
     // ============ struct helpers ============

package/contracts/router/base/ActionBaseMintRedeem.sol

@@ -193,10 +193,11 @@ abstract contract ActionBaseMintRedeem is TokenHelper {
         if (netSyOut < minSyOut) revert Errors.RouterInsufficientSyOut(netSyOut, minSyOut);
     }
 
-    function _syOrBulk(
-        address SY,
-        TokenOutput memory output
-    ) internal pure returns (address addr) {
+    function _syOrBulk(address SY, TokenOutput memory output)
+        internal
+        pure
+        returns (address addr)
+    {
         return output.bulk != address(0) ? output.bulk : SY;
     }
 }

package/deployments/43113-core.json

@@ -22,7 +22,7 @@
     "router": "0xFC0F1237961A6ecEacAC86aD407e181Ecd5e673C",
     "pendleSwap": "0xc6404511EF2C4C05A15446aF7D54FB63AFbe4d47",
     "routerStatic": "0x483B13d42f3d72db7C449461289299C095143a05",
-    "routerHelper": "0xc10f77aAf3b4cF67a6094bC37aAC516c9d85cB2F",
+    "routerHelper": "0x2CbebCfAf4e08E153937d7f14FebfD30e038A433",
     "vePendle": "0xB20E3c268C993BC3c9Bc1C1cc5D7491F2268cD91",
     "senderEndpoint": "0x86bD575c36e236386284C035ffeBE66CB6ecd2DD",
     "votingController": "0x40ea97a7E9A4A0520229d1bbdf4D82E36b1a5475",

package/package.json

@@ -2,7 +2,7 @@
   "name": "@pendle/core-v2",
   "description": "Core smart contracts of Pendle Protocol.",
   "license": "BUSL-1.1",
-  "version": "1.4.1-testnet",
+  "version": "1.4.2-testnet",
   "homepage": "https://pendle.finance",
   "keywords": [
     "pendle",