@gearbox-protocol/sdk 0.0.99 → 0.0.102

package/src/contracts/contracts.ts

@@ -3,7 +3,12 @@
  * Gearbox. Generalized leverage protocol, which allows to take leverage and then use it across other DeFi protocols and platforms in a composable way.
  * (c) Gearbox.fi, 2021
  */
-import { keyToLowercase, objectEntries, swapKeyValue } from "../utils/mappers";
+import {
+  keyToLowercase,
+  objectEntries,
+  swapKeyValue,
+  filterEmptyKeys
+} from "../utils/mappers";
 import { AdapterInterface } from "./adapters";
 import { NetworkType } from "../core/constants";
 import { Protocols } from "./protocols";
@@ -122,7 +127,7 @@ export const contractsByNetwork: Record<
     CONVEX_STECRV_POOL: "0x25edfea00131DAF9b23a8E07720Eea2382d58E71",
     CONVEX_SUSD_POOL: "0xE9998a1c357dc62550f2ED72b736a7CaEB262823",
     CONVEX_FRAX3CRV_POOL: "0xEBE0A1B948eB83333906EB80eE4b87Ee0b5CC84f",
-    CONVEX_LUSD3CRV_POOL: "0xb099D099286CB7483dbc7D62b5C91656bd15DBF0",
+    CONVEX_LUSD3CRV_POOL: "0x493Bd59EEcFfCa1BF88611CEd478aA5b74427e06",
     CONVEX_GUSD_POOL: "0xE7370DA7FD3d511dAB095Dd7d10388653d5cDE21",
     CONVEX_CLAIM_ZAP: "0x1330C2E5Cd8c333683aE511550f82d25918FFdd5",
 
@@ -179,10 +184,16 @@ type ConvexParams = {
     | AdapterInterface.CONVEX_V1_CLAIM_ZAP;
 } & BaseContractParams;
 
-type ConvexPoolParams = {
+type ConvexExtraPoolParams = {
+  rewardToken: NormalToken;
+  poolAddress: Record<NetworkType, string>;
+};
+
+export type ConvexPoolParams = {
   protocol: Protocols.Convex;
   type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL;
   stakedToken: ConvexStakedPhantomToken;
+  extraRewards: Array<ConvexExtraPoolParams>;
 } & BaseContractParams;
 
 export type LidoParams = {
@@ -314,46 +325,85 @@ export const contractParams: Record<SupportedContract, ContractParams> = {
     protocol: Protocols.Convex,
     type: AdapterInterface.CONVEX_V1_BOOSTER
   },
+  CONVEX_CLAIM_ZAP: {
+    name: "Convex ZAP",
+    protocol: Protocols.Convex,
+    type: AdapterInterface.CONVEX_V1_CLAIM_ZAP
+  },
+
   CONVEX_3CRV_POOL: {
     name: "Convex 3crv",
     protocol: Protocols.Convex,
     type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL,
-    stakedToken: "stkcvx3Crv"
+    stakedToken: "stkcvx3Crv",
+    extraRewards: []
   },
   CONVEX_GUSD_POOL: {
     name: "Convex GUSD",
     protocol: Protocols.Convex,
     type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL,
-    stakedToken: "stkcvxgusd3CRV"
+    stakedToken: "stkcvxgusd3CRV",
+    extraRewards: []
   },
   CONVEX_SUSD_POOL: {
     name: "Convex SUSD",
     protocol: Protocols.Convex,
     type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL,
-    stakedToken: "stkcvxcrvPlain3andSUSD"
+    stakedToken: "stkcvxcrvPlain3andSUSD",
+    extraRewards: [
+      {
+        rewardToken: "SNX",
+        poolAddress: {
+          Mainnet: "0x81fCe3E10D12Da6c7266a1A169c4C96813435263",
+          Kovan: "0x26a535146557FA58FA37e3078FEAc523b554939C"
+        }
+      }
+    ]
   },
   CONVEX_STECRV_POOL: {
     name: "Convex STECRV",
     protocol: Protocols.Convex,
     type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL,
-    stakedToken: "stkcvxsteCRV"
+    stakedToken: "stkcvxsteCRV",
+    extraRewards: [
+      {
+        rewardToken: "LDO",
+        poolAddress: {
+          Mainnet: "0x008aEa5036b819B4FEAEd10b2190FBb3954981E8",
+          Kovan: "0xd0B1CC3B4839363b1eC92F35eF45794CB07B1183"
+        }
+      }
+    ]
   },
   CONVEX_FRAX3CRV_POOL: {
     name: "Convex FRAX3CRV",
     protocol: Protocols.Convex,
     type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL,
-    stakedToken: "stkcvxFRAX3CRV"
+    stakedToken: "stkcvxFRAX3CRV",
+    extraRewards: [
+      {
+        rewardToken: "FXS",
+        poolAddress: {
+          Mainnet: "0xcDEC6714eB482f28f4889A0c122868450CDBF0b0",
+          Kovan: "0x89869c2e79FC6EFf51e714F1239D53702B5CDFCD"
+        }
+      }
+    ]
   },
   CONVEX_LUSD3CRV_POOL: {
     name: "Convex LUSD3CRV",
     protocol: Protocols.Convex,
     type: AdapterInterface.CONVEX_V1_BASE_REWARD_POOL,
-    stakedToken: "stkcvxLUSD3CRV"
-  },
-  CONVEX_CLAIM_ZAP: {
-    name: "Convex ZAP",
-    protocol: Protocols.Convex,
-    type: AdapterInterface.CONVEX_V1_CLAIM_ZAP
+    stakedToken: "stkcvxLUSD3CRV",
+    extraRewards: [
+      {
+        rewardToken: "LQTY",
+        poolAddress: {
+          Mainnet: "0x55d59b791f06dc519B176791c4E037E8Cf2f6361",
+          Kovan: ""
+        }
+      }
+    ]
   },
 
   LIDO_STETH_GATEWAY: {
@@ -370,6 +420,9 @@ export const contractParams: Record<SupportedContract, ContractParams> = {
 
 export const contractsByAddress = objectEntries(contractsByNetwork).reduce<
   Record<string, SupportedContract>
->((sum, [_, contracts]) => {
-  return { ...sum, ...keyToLowercase(swapKeyValue(contracts)) };
+>((acc, [_, contracts]) => {
+  return {
+    ...acc,
+    ...filterEmptyKeys(keyToLowercase(swapKeyValue(contracts)))
+  };
 }, {});

package/src/contracts/contractsRegister.ts

@@ -27,19 +27,34 @@ export const deployedContracts: Record<string, string> = {
   "0xe04b4db67127d1930D36f16B51653120C4285708": "WBTC",
   "0x600073357c29d169aAF3E543A4519749830553F1": "WETH",
   "0xdBAd1361d9A03B81Be8D3a54Ef0dc9e39a1bA5b3": "USDC",
-  "0x50d1fA47b0D88BA0D108148B8481b4A762eFB99e": "DAI"
+  "0x50d1fA47b0D88BA0D108148B8481b4A762eFB99e": "DAI",
   // [YEARN_DAI_VAULT_KOVAN_MOCK]: "Yearn DAI",
   // [YEARN_USDC_VAULT_KOVAN_MOCK]: "Yearn USDC",
   // [SUSHISWAP_KOVAN]: "Sushiswap"
+
+  "0x94cd5F09727ae04d7D6fd36A9c9DD96D0d54646B": "DAI",
+  "0x53B4a7389EA369a9299DfF524f916EC3cB77ffF4": "USDC",
+  "0xE6631f7b18744651A385a02ea2C89634d20D7819": "WETH",
+  "0x4d2cBA0E43Ad3B3E1C3B1922fe6E8e910b8C3ae0": "WBTC",
+
+  "0x6Ae9Ed829AF469Df9526FA7443E876bfaBC79eff": "DAI V2",
+  "0x8E0a874E3475de1C16490E386b7E2904CdC03086": "USDC V2",
+  "0x816a74B75D60839247C848518545fb17cedDC460": "WETH V2",
+
+  // pools
+  "0xA7b1C8f322596C40A04dBd3DffaE37a0849B8b59": "DAI",
+  "0xb8ecDB926F07FCbd870eafE72d116413A0BEb236": "USDC",
+  "0xAda6b2747295b2ba6ba52ce2d0D5e681D25D63D8": "WETH",
+  "0x85c54CCCf27466eEa1C74a73F75CbE385C271EE4": "WBTC"
 };
 
 const contractNames = Object.entries(contractsByAddress).reduce<
   Record<string, string>
->((sum, [addr, cSymbol]) => {
+>((acc, [addr, cSymbol]) => {
   const params = contractParams[cSymbol];
-  if (!params) return sum;
+  if (!params) return acc;
 
-  return { ...sum, [addr]: params.name };
+  return { ...acc, [addr]: params.name };
 }, {});
 
 const contractsFullList = {

package/src/core/constants.ts

@@ -22,12 +22,18 @@ export const getNetworkType = (chainId: number): NetworkType => {
   }
 };
 
-export const RAY = BigNumber.from(10).pow(27);
+export const RAY_DECIMALS_POW = 27;
+export const RAY = BigNumber.from(10).pow(RAY_DECIMALS_POW);
 export const halfRAY = RAY.div(2);
-export const WAD = BigNumber.from(10).pow(18);
+export const WAD_DECIMALS_POW = 18;
+export const WAD = BigNumber.from(10).pow(WAD_DECIMALS_POW);
+
+export const PRICE_DECIMALS_POW = 8;
+export const PRICE_DECIMALS = BigNumber.from(10).pow(PRICE_DECIMALS_POW);
 
 export const SECONDS_PER_YEAR = 365 * 24 * 3600;
 
+export const PERCENTAGE_DECIMALS = 100;
 export const PERCENTAGE_FACTOR = 1e4;
 export const LIQUIDATION_DISCOUNTED_SUM = 9500;
 export const UNDERLYING_TOKEN_LIQUIDATION_THRESHOLD = 9300;
@@ -37,8 +43,9 @@ export const timeRanges: Record<string, number> = {
   "1D": 3600 * 24,
   "1W": 3600 * 24 * 7,
   "1M": 3600 * 24 * 30,
-  "1Y": 3600 * 24 * 365,
+  "1Y": 3600 * 24 * 365
 };
 
 export const LEVERAGE_DECIMALS = 100;
+export const SLIPPAGE_DECIMALS = 100;
 export const ADDRESS_0x0 = "0x0000000000000000000000000000000000000000";

package/src/core/creditAccount.ts

@@ -3,8 +3,14 @@ import {
   CreditAccountDataExtendedPayload,
   CreditAccountDataPayload
 } from "../payload/creditAccount";
-import { PERCENTAGE_FACTOR, RAY } from "./constants";
+import {
+  PERCENTAGE_FACTOR,
+  RAY,
+  PERCENTAGE_DECIMALS,
+  PRICE_DECIMALS
+} from "./constants";
 import { TokenData } from "../tokens/tokenData";
+import { calcTotalPrice } from "./price";
 
 export type Balance = { address: string; balance: BigNumber };
 
@@ -33,7 +39,7 @@ export class CreditAccountData {
     this.borrower = payload.borrower;
     this.inUse = payload.inUse;
     this.creditManager = payload.creditManager;
-    this.underlyingToken = payload.underlyingToken;
+    this.underlyingToken = payload.underlying;
     this.borrowedAmountPlusInterest = BigNumber.from(
       payload.borrowedAmountPlusInterest
     );
@@ -43,7 +49,7 @@ export class CreditAccountData {
     this.borrowRate =
       BigNumber.from(payload.borrowRate)
         .mul(PERCENTAGE_FACTOR)
-        .mul(100)
+        .mul(PERCENTAGE_DECIMALS)
         .div(RAY)
         .toNumber() / PERCENTAGE_FACTOR;
 
@@ -61,45 +67,48 @@ export class CreditAccountData {
   }
 
   balancesSorted(
-    prices: Record<string, number>,
+    prices: Record<string, BigNumber>,
     tokens: Record<string, TokenData>
   ): Array<Balance> {
-    const priceCalc = (addr: string, amount: BigNumber) => {
-      const price = prices[addr] || 0;
-      const { decimals = 18 } = tokens[addr] || {};
-
-      return amount
-        .mul(Math.floor(1000 * price))
-        .div(BigNumber.from(10).pow(decimals));
-    };
-
-    const tokensAbcComparator = (t1?: TokenData, t2?: TokenData) => {
-      const { symbol: symbol1 = "" } = t1 || {};
-      const { symbol: symbol2 = "" } = t2 || {};
-
-      return symbol1 > symbol2 ? 1 : -1;
-    };
-
-    const safeBalances = this.balances || [];
-
-    return Object.entries(safeBalances)
-      .sort(([addr1, amount1], [addr2, amount2]) => {
-        const addr1Lc = addr1.toLowerCase();
-        const addr2Lc = addr2.toLowerCase();
-
-        const price1 = priceCalc(addr1Lc, amount1);
-        const price2 = priceCalc(addr2Lc, amount2);
-
-        return price1.eq(price2)
-          ? tokensAbcComparator(tokens[addr1Lc], tokens[addr2Lc])
-          : price1.gt(price2)
-          ? -1
-          : 1;
-      })
-      .map(([address, balance]) => ({ address, balance }));
+    return sortBalances(this.balances, prices, tokens).map(
+      ([address, balance]) => ({ address, balance })
+    );
   }
 }
 
+export function sortBalances(
+  balances: Record<string, BigNumber>,
+  prices: Record<string, BigNumber>,
+  tokens: Record<string, TokenData>
+) {
+  return Object.entries(balances).sort(([addr1, amount1], [addr2, amount2]) => {
+    const addr1Lc = addr1.toLowerCase();
+    const addr2Lc = addr2.toLowerCase();
+
+    const token1 = tokens[addr1Lc];
+    const token2 = tokens[addr2Lc];
+
+    const price1 = prices[addr1Lc] || PRICE_DECIMALS;
+    const price2 = prices[addr2Lc] || PRICE_DECIMALS;
+
+    const totalPrice1 = calcTotalPrice(price1, amount1, token1?.decimals);
+    const totalPrice2 = calcTotalPrice(price2, amount2, token2?.decimals);
+
+    return totalPrice1.eq(totalPrice2)
+      ? tokensAbcComparator(token1, token2)
+      : totalPrice1.gt(totalPrice2)
+      ? -1
+      : 1;
+  });
+}
+
+export function tokensAbcComparator(t1?: TokenData, t2?: TokenData) {
+  const { symbol: symbol1 = "" } = t1 || {};
+  const { symbol: symbol2 = "" } = t2 || {};
+
+  return symbol1 > symbol2 ? 1 : -1;
+}
+
 export class CreditAccountDataExtended extends CreditAccountData {
   public readonly repayAmount: BigNumber;
   public readonly liquidationAmount: BigNumber;