@pendle/core-v2 0.5.0 → 0.5.1-beta-2

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-2",
   "homepage": "https://pendle.finance",
   "keywords": [
     "pendle",

package/typechain-types/ActionStatic.ts

@@ -1,399 +0,0 @@
-/* Autogenerated file. Do not edit manually. */
-/* tslint:disable */
-/* eslint-disable */
-import {
-  BaseContract,
-  BigNumber,
-  BigNumberish,
-  BytesLike,
-  CallOverrides,
-  ContractTransaction,
-  Overrides,
-  PopulatedTransaction,
-  Signer,
-  utils,
-} from "ethers";
-import { FunctionFragment, Result } from "@ethersproject/abi";
-import { Listener, Provider } from "@ethersproject/providers";
-import type {
-  TypedEventFilter,
-  TypedEvent,
-  TypedListener,
-  OnEvent,
-} from "./common";
-
-export interface ActionStaticInterface extends utils.Interface {
-  contractName: "ActionStatic";
-  functions: {
-    "addLiquidityStatic(address,uint256,uint256)": FunctionFragment;
-    "getOtImpliedYield(address)": FunctionFragment;
-    "getPendleTokenType(address)": FunctionFragment;
-    "marketFactory()": FunctionFragment;
-    "removeLiquidityStatic(address,uint256)": FunctionFragment;
-    "scyIndex(address)": FunctionFragment;
-    "swapOtForScyStatic(address,uint256)": FunctionFragment;
-    "swapScyForOtStatic(address,uint256)": FunctionFragment;
-    "yieldContractFactory()": FunctionFragment;
-  };
-
-  encodeFunctionData(
-    functionFragment: "addLiquidityStatic",
-    values: [string, BigNumberish, BigNumberish]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "getOtImpliedYield",
-    values: [string]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "getPendleTokenType",
-    values: [string]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "marketFactory",
-    values?: undefined
-  ): string;
-  encodeFunctionData(
-    functionFragment: "removeLiquidityStatic",
-    values: [string, BigNumberish]
-  ): string;
-  encodeFunctionData(functionFragment: "scyIndex", values: [string]): string;
-  encodeFunctionData(
-    functionFragment: "swapOtForScyStatic",
-    values: [string, BigNumberish]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "swapScyForOtStatic",
-    values: [string, BigNumberish]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "yieldContractFactory",
-    values?: undefined
-  ): string;
-
-  decodeFunctionResult(
-    functionFragment: "addLiquidityStatic",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "getOtImpliedYield",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "getPendleTokenType",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "marketFactory",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "removeLiquidityStatic",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(functionFragment: "scyIndex", data: BytesLike): Result;
-  decodeFunctionResult(
-    functionFragment: "swapOtForScyStatic",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "swapScyForOtStatic",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "yieldContractFactory",
-    data: BytesLike
-  ): Result;
-
-  events: {};
-}
-
-export interface ActionStatic extends BaseContract {
-  contractName: "ActionStatic";
-  connect(signerOrProvider: Signer | Provider | string): this;
-  attach(addressOrName: string): this;
-  deployed(): Promise<this>;
-
-  interface: ActionStaticInterface;
-
-  queryFilter<TEvent extends TypedEvent>(
-    event: TypedEventFilter<TEvent>,
-    fromBlockOrBlockhash?: string | number | undefined,
-    toBlock?: string | number | undefined
-  ): Promise<Array<TEvent>>;
-
-  listeners<TEvent extends TypedEvent>(
-    eventFilter?: TypedEventFilter<TEvent>
-  ): Array<TypedListener<TEvent>>;
-  listeners(eventName?: string): Array<Listener>;
-  removeAllListeners<TEvent extends TypedEvent>(
-    eventFilter: TypedEventFilter<TEvent>
-  ): this;
-  removeAllListeners(eventName?: string): this;
-  off: OnEvent<this>;
-  on: OnEvent<this>;
-  once: OnEvent<this>;
-  removeListener: OnEvent<this>;
-
-  functions: {
-    addLiquidityStatic(
-      market: string,
-      scyDesired: BigNumberish,
-      otDesired: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<ContractTransaction>;
-
-    getOtImpliedYield(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<[BigNumber]>;
-
-    getPendleTokenType(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<
-      [boolean, boolean, boolean] & {
-        isOT: boolean;
-        isYT: boolean;
-        isMarket: boolean;
-      }
-    >;
-
-    marketFactory(overrides?: CallOverrides): Promise<[string]>;
-
-    removeLiquidityStatic(
-      market: string,
-      lpToRemove: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, BigNumber] & { netScyOut: BigNumber; netOtOut: BigNumber }
-    >;
-
-    scyIndex(
-      market: string,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<ContractTransaction>;
-
-    swapOtForScyStatic(
-      market: string,
-      exactOtIn: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<ContractTransaction>;
-
-    swapScyForOtStatic(
-      market: string,
-      exactOtOut: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<ContractTransaction>;
-
-    yieldContractFactory(overrides?: CallOverrides): Promise<[string]>;
-  };
-
-  addLiquidityStatic(
-    market: string,
-    scyDesired: BigNumberish,
-    otDesired: BigNumberish,
-    overrides?: Overrides & { from?: string | Promise<string> }
-  ): Promise<ContractTransaction>;
-
-  getOtImpliedYield(
-    market: string,
-    overrides?: CallOverrides
-  ): Promise<BigNumber>;
-
-  getPendleTokenType(
-    token: string,
-    overrides?: CallOverrides
-  ): Promise<
-    [boolean, boolean, boolean] & {
-      isOT: boolean;
-      isYT: boolean;
-      isMarket: boolean;
-    }
-  >;
-
-  marketFactory(overrides?: CallOverrides): Promise<string>;
-
-  removeLiquidityStatic(
-    market: string,
-    lpToRemove: BigNumberish,
-    overrides?: CallOverrides
-  ): Promise<
-    [BigNumber, BigNumber] & { netScyOut: BigNumber; netOtOut: BigNumber }
-  >;
-
-  scyIndex(
-    market: string,
-    overrides?: Overrides & { from?: string | Promise<string> }
-  ): Promise<ContractTransaction>;
-
-  swapOtForScyStatic(
-    market: string,
-    exactOtIn: BigNumberish,
-    overrides?: Overrides & { from?: string | Promise<string> }
-  ): Promise<ContractTransaction>;
-
-  swapScyForOtStatic(
-    market: string,
-    exactOtOut: BigNumberish,
-    overrides?: Overrides & { from?: string | Promise<string> }
-  ): Promise<ContractTransaction>;
-
-  yieldContractFactory(overrides?: CallOverrides): Promise<string>;
-
-  callStatic: {
-    addLiquidityStatic(
-      market: string,
-      scyDesired: BigNumberish,
-      otDesired: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, BigNumber, BigNumber] & {
-        netLpOut: BigNumber;
-        scyUsed: BigNumber;
-        otUsed: BigNumber;
-      }
-    >;
-
-    getOtImpliedYield(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    getPendleTokenType(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<
-      [boolean, boolean, boolean] & {
-        isOT: boolean;
-        isYT: boolean;
-        isMarket: boolean;
-      }
-    >;
-
-    marketFactory(overrides?: CallOverrides): Promise<string>;
-
-    removeLiquidityStatic(
-      market: string,
-      lpToRemove: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, BigNumber] & { netScyOut: BigNumber; netOtOut: BigNumber }
-    >;
-
-    scyIndex(market: string, overrides?: CallOverrides): Promise<BigNumber>;
-
-    swapOtForScyStatic(
-      market: string,
-      exactOtIn: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, BigNumber] & { netScyOut: BigNumber; netScyFee: BigNumber }
-    >;
-
-    swapScyForOtStatic(
-      market: string,
-      exactOtOut: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<
-      [BigNumber, BigNumber] & { netScyIn: BigNumber; netScyFee: BigNumber }
-    >;
-
-    yieldContractFactory(overrides?: CallOverrides): Promise<string>;
-  };
-
-  filters: {};
-
-  estimateGas: {
-    addLiquidityStatic(
-      market: string,
-      scyDesired: BigNumberish,
-      otDesired: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<BigNumber>;
-
-    getOtImpliedYield(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    getPendleTokenType(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    marketFactory(overrides?: CallOverrides): Promise<BigNumber>;
-
-    removeLiquidityStatic(
-      market: string,
-      lpToRemove: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<BigNumber>;
-
-    scyIndex(
-      market: string,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<BigNumber>;
-
-    swapOtForScyStatic(
-      market: string,
-      exactOtIn: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<BigNumber>;
-
-    swapScyForOtStatic(
-      market: string,
-      exactOtOut: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<BigNumber>;
-
-    yieldContractFactory(overrides?: CallOverrides): Promise<BigNumber>;
-  };
-
-  populateTransaction: {
-    addLiquidityStatic(
-      market: string,
-      scyDesired: BigNumberish,
-      otDesired: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<PopulatedTransaction>;
-
-    getOtImpliedYield(
-      market: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    getPendleTokenType(
-      token: string,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    marketFactory(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    removeLiquidityStatic(
-      market: string,
-      lpToRemove: BigNumberish,
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    scyIndex(
-      market: string,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<PopulatedTransaction>;
-
-    swapOtForScyStatic(
-      market: string,
-      exactOtIn: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<PopulatedTransaction>;
-
-    swapScyForOtStatic(
-      market: string,
-      exactOtOut: BigNumberish,
-      overrides?: Overrides & { from?: string | Promise<string> }
-    ): Promise<PopulatedTransaction>;
-
-    yieldContractFactory(
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-  };
-}