@pendle/core-v2 0.5.0 → 0.5.1-beta

package/contracts/core/RouterStatic.sol

@@ -84,7 +84,7 @@ contract RouterStatic is IPRouterStatic {
         return SCYIndexLib.newIndex(IPMarket(market).SCY());
     }
 
-    function getOtImpliedYield(address market) external view returns (int256) {
+    function getOtImpliedYield(address market) public view returns (int256) {
         MarketState memory state = IPMarket(market).readState(false);
 
         int256 lnImpliedRate = (state.lastImpliedRate).Int();
@@ -104,4 +104,131 @@ contract RouterStatic is IPRouterStatic {
         else if (yieldContractFactory.isYT(token)) isYT = true;
         else if (marketFactory.isValidMarket(token)) isMarket = true;
     }
+
+    function getUserYOInfo(address token, address user)
+        public
+        view
+        returns (UserYOInfo memory userYOInfo)
+    {
+        (userYOInfo.yt, userYOInfo.ot) = getYO(token);
+        IPYieldToken YT = IPYieldToken(userYOInfo.yt);
+        userYOInfo.ytBalance = YT.balanceOf(user);
+        userYOInfo.otBalance = IPOwnershipToken(userYOInfo.ot).balanceOf(user);
+        userYOInfo.unclaimedInterest.token = YT.SCY();
+        (, userYOInfo.unclaimedInterest.amount) = YT.getInterestData(user);
+        address[] memory rewardTokens = YT.getRewardTokens();
+        TokenAmount[] memory unclaimedRewards = new TokenAmount[](rewardTokens.length);
+        uint256 length = 0;
+        for (uint256 i = 0; i < rewardTokens.length; ++i) {
+            address rewardToken = rewardTokens[i];
+            (, uint256 amount) = YT.getUserReward(user, rewardToken);
+            if (amount > 0) {
+                unclaimedRewards[length].token = rewardToken;
+                unclaimedRewards[length].amount = amount;
+                ++length;
+            }
+        }
+        userYOInfo.unclaimedRewards = new TokenAmount[](length);
+        for (uint256 i = 0; i < length; ++i) {
+            userYOInfo.unclaimedRewards[i] = unclaimedRewards[i];
+        }
+    }
+
+    function getYOInfo(address token)
+        external
+        returns (
+            uint256 exchangeRate,
+            uint256 totalSupply,
+            RewardIndex[] memory rewardIndexes
+        )
+    {
+        (address yt, ) = getYO(token);
+        IPYieldToken YT = IPYieldToken(yt);
+        exchangeRate = YT.getScyIndexBeforeExpiry();
+        totalSupply = YT.totalSupply();
+        address[] memory rewardTokens = YT.getRewardTokens();
+        rewardIndexes = new RewardIndex[](rewardTokens.length);
+        for (uint256 i = 0; i < rewardTokens.length; ++i) {
+            address rewardToken = rewardTokens[i];
+            rewardIndexes[i].rewardToken = rewardToken;
+            (, rewardIndexes[i].index) = YT.getGlobalReward(rewardToken);
+        }
+    }
+
+    function getYO(address token) public view returns (address ot, address yt) {
+        if (yieldContractFactory.isOT(token)) {
+            yt = IPOwnershipToken(token).YT();
+            ot = token;
+        } else if (yieldContractFactory.isYT(token)) {
+            yt = token;
+            ot = IPYieldToken(token).OT();
+        } else if (marketFactory.isValidMarket(token)) {
+            yt = IPMarket(token).YT();
+            ot = IPMarket(token).OT();
+        }
+    }
+
+    function getMarketInfo(address market)
+        external
+        view
+        returns (
+            address ot,
+            address scy,
+            MarketState memory state,
+            int256 impliedYield,
+            uint256 exchangeRate
+        )
+    {
+        IPMarket _market = IPMarket(market);
+        ot = _market.OT();
+        scy = _market.SCY();
+        state = _market.readState(true);
+        impliedYield = getOtImpliedYield(market);
+        exchangeRate = 0; // TODO: get the actual exchange rate
+    }
+
+    function getUserMarketInfo(address market, address user)
+        public
+        view
+        returns (UserMarketInfo memory userMarketInfo)
+    {
+        IPMarket _market = IPMarket(market);
+        userMarketInfo.market = market;
+        // TODO: What will this return if the user's balance is staked?
+        userMarketInfo.lpBalance = _market.balanceOf(user);
+        // TODO: Is there a way to convert LP to OT and SCY?
+        userMarketInfo.otBalance = TokenAmount(_market.OT(), 0);
+        userMarketInfo.scyBalance = TokenAmount(_market.SCY(), 0);
+        // TODO: Get this from SCY once it is in the interface
+        userMarketInfo.assetBalance = TokenAmount(address(0), 0);
+    }
+
+    function getUserYOPositionsByTokens(address user, address[] calldata tokens)
+        external
+        view
+        returns (UserYOInfo[] memory userYOPositions)
+    {
+        userYOPositions = new UserYOInfo[](tokens.length);
+        for (uint256 i = 0; i < tokens.length; ++i) {
+            userYOPositions[i] = getUserYOInfo(tokens[i], user);
+        }
+    }
+
+    function getUserMarketPositions(address user, address[] calldata markets)
+        external
+        view
+        returns (UserMarketInfo[] memory userMarketPositions)
+    {
+        userMarketPositions = new UserMarketInfo[](markets.length);
+        for (uint256 i = 0; i < markets.length; ++i) {
+            userMarketPositions[i] = getUserMarketInfo(markets[i], user);
+        }
+    }
+
+    function hasYOPosition(UserYOInfo memory userYOInfo) public pure returns (bool hasPosition) {
+        hasPosition = (userYOInfo.ytBalance > 0 ||
+            userYOInfo.otBalance > 0 ||
+            userYOInfo.unclaimedInterest.amount > 0 ||
+            userYOInfo.unclaimedRewards.length > 0);
+    }
 }

package/contracts/interfaces/IPRouterStatic.sol

@@ -4,6 +4,33 @@ pragma solidity 0.8.9;
 import "../libraries/math/MarketMathCore.sol";
 
 interface IPRouterStatic {
+    struct TokenAmount {
+        address token;
+        uint256 amount;
+    }
+
+    struct RewardIndex {
+        address rewardToken;
+        uint256 index;
+    }
+
+    struct UserYOInfo {
+        address yt;
+        address ot;
+        uint256 ytBalance;
+        uint256 otBalance;
+        TokenAmount unclaimedInterest;
+        TokenAmount[] unclaimedRewards;
+    }
+
+    struct UserMarketInfo {
+        address market;
+        uint256 lpBalance;
+        TokenAmount otBalance;
+        TokenAmount scyBalance;
+        TokenAmount assetBalance;
+    }
+
     function addLiquidityStatic(
         address market,
         uint256 scyDesired,

package/package.json

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

package/typechain-types/RouterStatic.ts

@@ -22,126 +22,12 @@ import type {
   OnEvent,
 } from "./common";
 
-export type MarketStateStruct = {
-  totalOt: BigNumberish;
-  totalScy: BigNumberish;
-  totalLp: BigNumberish;
-  oracleRate: BigNumberish;
-  treasury: string;
-  scalarRoot: BigNumberish;
-  feeRateRoot: BigNumberish;
-  rateOracleTimeWindow: BigNumberish;
-  expiry: BigNumberish;
-  reserveFeePercent: BigNumberish;
-  lastImpliedRate: BigNumberish;
-  lastTradeTime: BigNumberish;
-};
-
-export type MarketStateStructOutput = [
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  string,
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber,
-  BigNumber
-] & {
-  totalOt: BigNumber;
-  totalScy: BigNumber;
-  totalLp: BigNumber;
-  oracleRate: BigNumber;
-  treasury: string;
-  scalarRoot: BigNumber;
-  feeRateRoot: BigNumber;
-  rateOracleTimeWindow: BigNumber;
-  expiry: BigNumber;
-  reserveFeePercent: BigNumber;
-  lastImpliedRate: BigNumber;
-  lastTradeTime: BigNumber;
-};
-
-export declare namespace IPRouterStatic {
-  export type TokenAmountStruct = { token: string; amount: BigNumberish };
-
-  export type TokenAmountStructOutput = [string, BigNumber] & {
-    token: string;
-    amount: BigNumber;
-  };
-
-  export type UserMarketInfoStruct = {
-    market: string;
-    lpBalance: BigNumberish;
-    otBalance: IPRouterStatic.TokenAmountStruct;
-    scyBalance: IPRouterStatic.TokenAmountStruct;
-    assetBalance: IPRouterStatic.TokenAmountStruct;
-  };
-
-  export type UserMarketInfoStructOutput = [
-    string,
-    BigNumber,
-    IPRouterStatic.TokenAmountStructOutput,
-    IPRouterStatic.TokenAmountStructOutput,
-    IPRouterStatic.TokenAmountStructOutput
-  ] & {
-    market: string;
-    lpBalance: BigNumber;
-    otBalance: IPRouterStatic.TokenAmountStructOutput;
-    scyBalance: IPRouterStatic.TokenAmountStructOutput;
-    assetBalance: IPRouterStatic.TokenAmountStructOutput;
-  };
-
-  export type UserYOInfoStruct = {
-    yt: string;
-    ot: string;
-    ytBalance: BigNumberish;
-    otBalance: BigNumberish;
-    unclaimedInterest: IPRouterStatic.TokenAmountStruct;
-    unclaimedRewards: IPRouterStatic.TokenAmountStruct[];
-  };
-
-  export type UserYOInfoStructOutput = [
-    string,
-    string,
-    BigNumber,
-    BigNumber,
-    IPRouterStatic.TokenAmountStructOutput,
-    IPRouterStatic.TokenAmountStructOutput[]
-  ] & {
-    yt: string;
-    ot: string;
-    ytBalance: BigNumber;
-    otBalance: BigNumber;
-    unclaimedInterest: IPRouterStatic.TokenAmountStructOutput;
-    unclaimedRewards: IPRouterStatic.TokenAmountStructOutput[];
-  };
-
-  export type RewardIndexStruct = { rewardToken: string; index: BigNumberish };
-
-  export type RewardIndexStructOutput = [string, BigNumber] & {
-    rewardToken: string;
-    index: BigNumber;
-  };
-}
-
 export interface RouterStaticInterface extends utils.Interface {
   contractName: "RouterStatic";
   functions: {
     "addLiquidityStatic(address,uint256,uint256)": FunctionFragment;
-    "getMarketInfo(address)": FunctionFragment;
     "getOtImpliedYield(address)": FunctionFragment;
     "getPendleTokenType(address)": FunctionFragment;
-    "getUserMarketInfo(address,address)": FunctionFragment;
-    "getUserMarketPositions(address,address[])": FunctionFragment;
-    "getUserYOInfo(address,address)": FunctionFragment;
-    "getUserYOPositionsByTokens(address,address[])": FunctionFragment;
-    "getYO(address)": FunctionFragment;
-    "getYOInfo(address)": FunctionFragment;
-    "hasYOPosition((address,address,uint256,uint256,(address,uint256),(address,uint256)[]))": FunctionFragment;
     "marketFactory()": FunctionFragment;
     "removeLiquidityStatic(address,uint256)": FunctionFragment;
     "scyIndex(address)": FunctionFragment;
@@ -154,10 +40,6 @@ export interface RouterStaticInterface extends utils.Interface {
     functionFragment: "addLiquidityStatic",
     values: [string, BigNumberish, BigNumberish]
   ): string;
-  encodeFunctionData(
-    functionFragment: "getMarketInfo",
-    values: [string]
-  ): string;
   encodeFunctionData(
     functionFragment: "getOtImpliedYield",
     values: [string]
@@ -166,28 +48,6 @@ export interface RouterStaticInterface extends utils.Interface {
     functionFragment: "getPendleTokenType",
     values: [string]
   ): string;
-  encodeFunctionData(
-    functionFragment: "getUserMarketInfo",
-    values: [string, string]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "getUserMarketPositions",
-    values: [string, string[]]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "getUserYOInfo",
-    values: [string, string]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "getUserYOPositionsByTokens",
-    values: [string, string[]]
-  ): string;
-  encodeFunctionData(functionFragment: "getYO", values: [string]): string;
-  encodeFunctionData(functionFragment: "getYOInfo", values: [string]): string;
-  encodeFunctionData(
-    functionFragment: "hasYOPosition",
-    values: [IPRouterStatic.UserYOInfoStruct]
-  ): string;
   encodeFunctionData(
     functionFragment: "marketFactory",
     values?: undefined
@@ -214,10 +74,6 @@ export interface RouterStaticInterface extends utils.Interface {
     functionFragment: "addLiquidityStatic",
     data: BytesLike
   ): Result;
-  decodeFunctionResult(
-    functionFragment: "getMarketInfo",
-    data: BytesLike
-  ): Result;
   decodeFunctionResult(
     functionFragment: "getOtImpliedYield",
     data: BytesLike
@@ -226,28 +82,6 @@ export interface RouterStaticInterface extends utils.Interface {
     functionFragment: "getPendleTokenType",
     data: BytesLike
   ): Result;
-  decodeFunctionResult(
-    functionFragment: "getUserMarketInfo",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "getUserMarketPositions",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "getUserYOInfo",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "getUserYOPositionsByTokens",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(functionFragment: "getYO", data: BytesLike): Result;
-  decodeFunctionResult(functionFragment: "getYOInfo", data: BytesLike): Result;
-  decodeFunctionResult(
-    functionFragment: "hasYOPosition",
-    data: BytesLike
-  ): Result;
   decodeFunctionResult(
     functionFragment: "marketFactory",
     data: BytesLike
@@ -308,19 +142,6 @@ export interface RouterStatic extends BaseContract {
       overrides?: Overrides & { from?: string | Promise<string> }
     ): Promise<ContractTransaction>;
 
-    getMarketInfo(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<
-      [string, string, MarketStateStructOutput, BigNumber, BigNumber] & {
-        ot: string;
-        scy: string;
-        state: MarketStateStructOutput;
-        impliedYield: BigNumber;
-        exchangeRate: BigNumber;
-      }
-    >;
-
     getOtImpliedYield(
       market: string,
       overrides?: CallOverrides
@@ -337,61 +158,6 @@ export interface RouterStatic extends BaseContract {
       }
     >;
 
-    getUserMarketInfo(
-      market: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<
-      [IPRouterStatic.UserMarketInfoStructOutput] & {
-        userMarketInfo: IPRouterStatic.UserMarketInfoStructOutput;
-      }
-    >;
-
-    getUserMarketPositions(
-      user: string,
-      markets: string[],
-      overrides?: CallOverrides
-    ): Promise<
-      [IPRouterStatic.UserMarketInfoStructOutput[]] & {
-        userMarketPositions: IPRouterStatic.UserMarketInfoStructOutput[];
-      }
-    >;
-
-    getUserYOInfo(
-      token: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<
-      [IPRouterStatic.UserYOInfoStructOutput] & {
-        userYOInfo: IPRouterStatic.UserYOInfoStructOutput;
-      }
-    >;
-
-    getUserYOPositionsByTokens(
-      user: string,
-      tokens: string[],
-      overrides?: CallOverrides
-    ): Promise<
-      [IPRouterStatic.UserYOInfoStructOutput[]] & {
-        userYOPositions: IPRouterStatic.UserYOInfoStructOutput[];
-      }
-    >;
-
-    getYO(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<[string, string] & { ot: string; yt: string }>;
-
-    getYOInfo(
-      token: string,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<ContractTransaction>;
-
-    hasYOPosition(
-      userYOInfo: IPRouterStatic.UserYOInfoStruct,
-      overrides?: CallOverrides
-    ): Promise<[boolean] & { hasPosition: boolean }>;
-
     marketFactory(overrides?: CallOverrides): Promise<[string]>;
 
     removeLiquidityStatic(
@@ -429,19 +195,6 @@ export interface RouterStatic extends BaseContract {
     overrides?: Overrides & { from?: string | Promise<string> }
   ): Promise<ContractTransaction>;
 
-  getMarketInfo(
-    market: string,
-    overrides?: CallOverrides
-  ): Promise<
-    [string, string, MarketStateStructOutput, BigNumber, BigNumber] & {
-      ot: string;
-      scy: string;
-      state: MarketStateStructOutput;
-      impliedYield: BigNumber;
-      exchangeRate: BigNumber;
-    }
-  >;
-
   getOtImpliedYield(
     market: string,
     overrides?: CallOverrides
@@ -458,45 +211,6 @@ export interface RouterStatic extends BaseContract {
     }
   >;
 
-  getUserMarketInfo(
-    market: string,
-    user: string,
-    overrides?: CallOverrides
-  ): Promise<IPRouterStatic.UserMarketInfoStructOutput>;
-
-  getUserMarketPositions(
-    user: string,
-    markets: string[],
-    overrides?: CallOverrides
-  ): Promise<IPRouterStatic.UserMarketInfoStructOutput[]>;
-
-  getUserYOInfo(
-    token: string,
-    user: string,
-    overrides?: CallOverrides
-  ): Promise<IPRouterStatic.UserYOInfoStructOutput>;
-
-  getUserYOPositionsByTokens(
-    user: string,
-    tokens: string[],
-    overrides?: CallOverrides
-  ): Promise<IPRouterStatic.UserYOInfoStructOutput[]>;
-
-  getYO(
-    token: string,
-    overrides?: CallOverrides
-  ): Promise<[string, string] & { ot: string; yt: string }>;
-
-  getYOInfo(
-    token: string,
-    overrides?: Overrides & { from?: string | Promise<string> }
-  ): Promise<ContractTransaction>;
-
-  hasYOPosition(
-    userYOInfo: IPRouterStatic.UserYOInfoStruct,
-    overrides?: CallOverrides
-  ): Promise<boolean>;
-
   marketFactory(overrides?: CallOverrides): Promise<string>;
 
   removeLiquidityStatic(
@@ -540,19 +254,6 @@ export interface RouterStatic extends BaseContract {
       }
     >;
 
-    getMarketInfo(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<
-      [string, string, MarketStateStructOutput, BigNumber, BigNumber] & {
-        ot: string;
-        scy: string;
-        state: MarketStateStructOutput;
-        impliedYield: BigNumber;
-        exchangeRate: BigNumber;
-      }
-    >;
-
     getOtImpliedYield(
       market: string,
       overrides?: CallOverrides
@@ -569,51 +270,6 @@ export interface RouterStatic extends BaseContract {
       }
     >;
 
-    getUserMarketInfo(
-      market: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<IPRouterStatic.UserMarketInfoStructOutput>;
-
-    getUserMarketPositions(
-      user: string,
-      markets: string[],
-      overrides?: CallOverrides
-    ): Promise<IPRouterStatic.UserMarketInfoStructOutput[]>;
-
-    getUserYOInfo(
-      token: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<IPRouterStatic.UserYOInfoStructOutput>;
-
-    getUserYOPositionsByTokens(
-      user: string,
-      tokens: string[],
-      overrides?: CallOverrides
-    ): Promise<IPRouterStatic.UserYOInfoStructOutput[]>;
-
-    getYO(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<[string, string] & { ot: string; yt: string }>;
-
-    getYOInfo(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, BigNumber, IPRouterStatic.RewardIndexStructOutput[]] & {
-        exchangeRate: BigNumber;
-        totalSupply: BigNumber;
-        rewardIndexes: IPRouterStatic.RewardIndexStructOutput[];
-      }
-    >;
-
-    hasYOPosition(
-      userYOInfo: IPRouterStatic.UserYOInfoStruct,
-      overrides?: CallOverrides
-    ): Promise<boolean>;
-
     marketFactory(overrides?: CallOverrides): Promise<string>;
 
     removeLiquidityStatic(
@@ -655,11 +311,6 @@ export interface RouterStatic extends BaseContract {
       overrides?: Overrides & { from?: string | Promise<string> }
     ): Promise<BigNumber>;
 
-    getMarketInfo(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
     getOtImpliedYield(
       market: string,
       overrides?: CallOverrides
@@ -670,42 +321,6 @@ export interface RouterStatic extends BaseContract {
       overrides?: CallOverrides
     ): Promise<BigNumber>;
 
-    getUserMarketInfo(
-      market: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    getUserMarketPositions(
-      user: string,
-      markets: string[],
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    getUserYOInfo(
-      token: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    getUserYOPositionsByTokens(
-      user: string,
-      tokens: string[],
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    getYO(token: string, overrides?: CallOverrides): Promise<BigNumber>;
-
-    getYOInfo(
-      token: string,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<BigNumber>;
-
-    hasYOPosition(
-      userYOInfo: IPRouterStatic.UserYOInfoStruct,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
     marketFactory(overrides?: CallOverrides): Promise<BigNumber>;
 
     removeLiquidityStatic(
@@ -742,11 +357,6 @@ export interface RouterStatic extends BaseContract {
       overrides?: Overrides & { from?: string | Promise<string> }
     ): Promise<PopulatedTransaction>;
 
-    getMarketInfo(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
     getOtImpliedYield(
       market: string,
       overrides?: CallOverrides
@@ -757,45 +367,6 @@ export interface RouterStatic extends BaseContract {
       overrides?: CallOverrides
     ): Promise<PopulatedTransaction>;
 
-    getUserMarketInfo(
-      market: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getUserMarketPositions(
-      user: string,
-      markets: string[],
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getUserYOInfo(
-      token: string,
-      user: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getUserYOPositionsByTokens(
-      user: string,
-      tokens: string[],
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getYO(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getYOInfo(
-      token: string,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<PopulatedTransaction>;
-
-    hasYOPosition(
-      userYOInfo: IPRouterStatic.UserYOInfoStruct,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
     marketFactory(overrides?: CallOverrides): Promise<PopulatedTransaction>;
 
     removeLiquidityStatic(