@defisaver/positions-sdk 0.0.27 → 0.0.29

package/src/helpers/makerHelpers/index.ts

@@ -1,95 +1,95 @@
-import Web3 from 'web3';
-import Dec from 'decimal.js';
-import { Blockish, NetworkNumber } from '../../types/common';
-import {
-  McdDogContract, McdJugContract, McdSpotterContract, McdVatContract,
-} from '../../contracts';
-import { multicall } from '../../multicall';
-import { SECONDS_PER_YEAR } from '../../constants';
-import { bytesToString } from '../../services/utils';
-import { IlkInfo } from '../../types';
-
-export const getUnclaimedCollateral = async (web3: Web3, network: NetworkNumber, urn: string, ilk: string) => {
-  const vatContract = McdVatContract(web3, network);
-  const coll = await vatContract.methods.gem(ilk, urn).call();
-  return coll;
-};
-
-export const getCollateralInfo = async (ilk: string, web3: Web3, network: NetworkNumber, block: Blockish = 'latest'): Promise<IlkInfo> => {
-  const spotterContract = McdSpotterContract(web3, network);
-  const vatContract = McdVatContract(web3, network);
-  const dogContract = McdDogContract(web3, network);
-  const jugContract = McdJugContract(web3, network);
-
-  const multicallData = [
-    {
-      target: spotterContract.options.address,
-      abiItem: spotterContract.options.jsonInterface.find(({ name }) => name === 'par'),
-      params: [],
-    },
-    {
-      target: spotterContract.options.address,
-      abiItem: spotterContract.options.jsonInterface.find(({ name }) => name === 'ilks'),
-      params: [ilk],
-    },
-    {
-      target: vatContract.options.address,
-      abiItem: vatContract.options.jsonInterface.find(({ name }) => name === 'ilks'),
-      params: [ilk],
-    },
-    {
-      target: jugContract.options.address,
-      abiItem: jugContract.options.jsonInterface.find(({ name }) => name === 'ilks'),
-      params: [ilk],
-    },
-    {
-      target: jugContract.options.address,
-      abiItem: jugContract.options.jsonInterface.find(({ name }) => name === 'drip'),
-      params: [ilk],
-    },
-    {
-      target: dogContract.options.address,
-      abiItem: dogContract.options.jsonInterface.find(({ name }) => name === 'chop'),
-      params: [ilk],
-    },
-  ];
-
-  const multiRes = await multicall(multicallData, web3, network, block);
-
-  const par = new Dec(multiRes[0][0].toString()).div(1e27).toString();
-  const mat = new Dec(multiRes[1][1].toString()).div(1e27).toString();
-  const art = new Dec(multiRes[2][0].toString()).toString();
-  const rate = new Dec(multiRes[2][1].toString()).toString();
-  const spot = new Dec(multiRes[2][2].toString()).div(1e27).toString();
-  const line = new Dec(multiRes[2][3].toString()).div(1e45).toString();
-  const dust = new Dec(multiRes[2][1].toString()).div(1e45).toString();
-  const duty = new Dec(multiRes[3][0].toString()).toString();
-  const futureRate = new Dec(multiRes[4][0].toString()).toString();
-  const chop = new Dec(multiRes[5][0].toString()).div(1e18).toString();
-
-  const stabilityFee = new Dec(duty.toString())
-    .div(1e27)
-    .pow(SECONDS_PER_YEAR)
-    .minus(1)
-    .mul(100)
-    .toNumber();
-  const liquidationFee = new Dec(chop).mul(100).sub(100).toString();
-  const globalDebtCurrent = new Dec(art).div(1e18).mul(new Dec(futureRate).div(1e27)).toString();
-  const globalDebtCeiling = line;
-  const creatableDebt = new Dec(globalDebtCeiling).sub(globalDebtCurrent).toString();
-
-  return {
-    ilkLabel: bytesToString(ilk),
-    currentRate: rate,
-    futureRate,
-    minDebt: dust,
-    globalDebtCurrent,
-    globalDebtCeiling,
-    assetPrice: new Dec(spot).times(par).times(mat).toString(),
-    liqRatio: mat,
-    liqPercent: +mat * 100,
-    stabilityFee,
-    liquidationFee: new Dec(liquidationFee).lt(0) ? '0' : liquidationFee,
-    creatableDebt,
-  };
+import Web3 from 'web3';
+import Dec from 'decimal.js';
+import { Blockish, NetworkNumber } from '../../types/common';
+import {
+  McdDogContract, McdJugContract, McdSpotterContract, McdVatContract,
+} from '../../contracts';
+import { multicall } from '../../multicall';
+import { SECONDS_PER_YEAR } from '../../constants';
+import { bytesToString } from '../../services/utils';
+import { IlkInfo } from '../../types';
+
+export const getUnclaimedCollateral = async (web3: Web3, network: NetworkNumber, urn: string, ilk: string) => {
+  const vatContract = McdVatContract(web3, network);
+  const coll = await vatContract.methods.gem(ilk, urn).call();
+  return coll;
+};
+
+export const getCollateralInfo = async (ilk: string, web3: Web3, network: NetworkNumber, block: Blockish = 'latest'): Promise<IlkInfo> => {
+  const spotterContract = McdSpotterContract(web3, network);
+  const vatContract = McdVatContract(web3, network);
+  const dogContract = McdDogContract(web3, network);
+  const jugContract = McdJugContract(web3, network);
+
+  const multicallData = [
+    {
+      target: spotterContract.options.address,
+      abiItem: spotterContract.options.jsonInterface.find(({ name }) => name === 'par'),
+      params: [],
+    },
+    {
+      target: spotterContract.options.address,
+      abiItem: spotterContract.options.jsonInterface.find(({ name }) => name === 'ilks'),
+      params: [ilk],
+    },
+    {
+      target: vatContract.options.address,
+      abiItem: vatContract.options.jsonInterface.find(({ name }) => name === 'ilks'),
+      params: [ilk],
+    },
+    {
+      target: jugContract.options.address,
+      abiItem: jugContract.options.jsonInterface.find(({ name }) => name === 'ilks'),
+      params: [ilk],
+    },
+    {
+      target: jugContract.options.address,
+      abiItem: jugContract.options.jsonInterface.find(({ name }) => name === 'drip'),
+      params: [ilk],
+    },
+    {
+      target: dogContract.options.address,
+      abiItem: dogContract.options.jsonInterface.find(({ name }) => name === 'chop'),
+      params: [ilk],
+    },
+  ];
+
+  const multiRes = await multicall(multicallData, web3, network, block);
+
+  const par = new Dec(multiRes[0][0].toString()).div(1e27).toString();
+  const mat = new Dec(multiRes[1][1].toString()).div(1e27).toString();
+  const art = new Dec(multiRes[2][0].toString()).toString();
+  const rate = new Dec(multiRes[2][1].toString()).toString();
+  const spot = new Dec(multiRes[2][2].toString()).div(1e27).toString();
+  const line = new Dec(multiRes[2][3].toString()).div(1e45).toString();
+  const dust = new Dec(multiRes[2][1].toString()).div(1e45).toString();
+  const duty = new Dec(multiRes[3][0].toString()).toString();
+  const futureRate = new Dec(multiRes[4][0].toString()).toString();
+  const chop = new Dec(multiRes[5][0].toString()).div(1e18).toString();
+
+  const stabilityFee = new Dec(duty.toString())
+    .div(1e27)
+    .pow(SECONDS_PER_YEAR)
+    .minus(1)
+    .mul(100)
+    .toNumber();
+  const liquidationFee = new Dec(chop).mul(100).sub(100).toString();
+  const globalDebtCurrent = new Dec(art).div(1e18).mul(new Dec(futureRate).div(1e27)).toString();
+  const globalDebtCeiling = line;
+  const creatableDebt = new Dec(globalDebtCeiling).sub(globalDebtCurrent).toString();
+
+  return {
+    ilkLabel: bytesToString(ilk),
+    currentRate: rate,
+    futureRate,
+    minDebt: dust,
+    globalDebtCurrent,
+    globalDebtCeiling,
+    assetPrice: new Dec(spot).times(par).times(mat).toString(),
+    liqRatio: mat,
+    liqPercent: +mat * 100,
+    stabilityFee,
+    liquidationFee: new Dec(liquidationFee).lt(0) ? '0' : liquidationFee,
+    creatableDebt,
+  };
 };

package/src/helpers/sparkHelpers/index.ts

@@ -1,107 +1,107 @@
-import Dec from 'decimal.js';
-import { calcLeverageLiqPrice, getAssetsTotal, isLeveragedPos } from '../../moneymarket';
-import {
-  SparkAggregatedPositionData,
-  SparkAssetsData, SparkHelperCommon, SparkUsedAssets,
-} from '../../types';
-import { calculateNetApy } from '../../staking';
-import { wethToEth } from '../../services/utils';
-
-export const sparkIsInIsolationMode = ({ usedAssets, assetsData }: { usedAssets: SparkUsedAssets, assetsData: SparkAssetsData }) => Object.values(usedAssets).some(({ symbol, collateral }) => collateral && assetsData[symbol].isIsolated);
-
-export const sparkGetCollSuppliedAssets = ({ usedAssets }: { usedAssets: SparkUsedAssets }) => Object.values(usedAssets).filter(({ isSupplied, collateral }) => isSupplied && collateral);
-
-export const sparkGetSuppliableAssets = ({
-  usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest
-}: SparkHelperCommon) => {
-  const data = {
-    usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest,
-  };
-
-  const collAccountAssets = sparkGetCollSuppliedAssets(data);
-  const marketAssets = Object.values(assetsData);
-
-  if (sparkIsInIsolationMode(data)) {
-    const collAsset = collAccountAssets[0].symbol;
-    return marketAssets.filter(d => d.canBeSupplied).map(({ symbol }) => ({ symbol, canBeCollateral: symbol === collAsset }));
-  }
-
-  return marketAssets.filter(d => d.canBeSupplied).map(({ symbol, isIsolated }) => ({ symbol, canBeCollateral: !isIsolated }));
-};
-
-export const sparkGetSuppliableAsCollAssets = ({
-  usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest
-}: SparkHelperCommon) => sparkGetSuppliableAssets({
-  usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest,
-}).filter(({ canBeCollateral }) => canBeCollateral);
-
-export const sparkGetEmodeMutableProps = ({
-  eModeCategory,
-  assetsData,
-}: SparkHelperCommon,
-_asset: string) => {
-  const asset = wethToEth(_asset);
-
-  const assetData = assetsData[asset];
-  if (
-    eModeCategory === 0
-    || assetData.eModeCategory !== eModeCategory
-    || new Dec(assetData?.eModeCategoryData?.collateralFactor || 0).eq(0)
-  ) {
-    const { liquidationRatio, collateralFactor } = assetData;
-    return ({ liquidationRatio, collateralFactor });
-  }
-  const { liquidationRatio, collateralFactor } = assetData.eModeCategoryData;
-  return ({ liquidationRatio, collateralFactor });
-};
-
-export const sparkGetAggregatedPositionData = ({
-  usedAssets,
-  eModeCategory,
-  eModeCategories,
-  assetsData,
-  selectedMarket,
-  network,
-  ...rest
-}: SparkHelperCommon): SparkAggregatedPositionData => {
-  const data = {
-    usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest,
-  };
-  const payload = {} as SparkAggregatedPositionData;
-  payload.suppliedUsd = getAssetsTotal(usedAssets, ({ isSupplied }: { isSupplied: boolean }) => isSupplied, ({ suppliedUsd }: { suppliedUsd: string }) => suppliedUsd);
-  payload.suppliedCollateralUsd = getAssetsTotal(usedAssets, ({ isSupplied, collateral }: { isSupplied: boolean, collateral: boolean }) => isSupplied && collateral, ({ suppliedUsd }: { suppliedUsd: string }) => suppliedUsd);
-  payload.borrowedUsd = getAssetsTotal(usedAssets, ({ isBorrowed }: { isBorrowed: boolean }) => isBorrowed, ({ borrowedUsd }: { borrowedUsd: string }) => borrowedUsd);
-  payload.borrowLimitUsd = getAssetsTotal(
-    usedAssets,
-    ({ isSupplied, collateral }: { isSupplied: boolean, collateral: boolean }) => isSupplied && collateral,
-    ({ symbol, suppliedUsd }: { symbol: string, suppliedUsd: string }) => new Dec(suppliedUsd).mul(sparkGetEmodeMutableProps(data, symbol).collateralFactor),
-  );
-  payload.liquidationLimitUsd = getAssetsTotal(
-    usedAssets,
-    ({ isSupplied, collateral }: { isSupplied: boolean, collateral: boolean }) => isSupplied && collateral,
-    ({ symbol, suppliedUsd }: { symbol: string, suppliedUsd: string }) => new Dec(suppliedUsd).mul(sparkGetEmodeMutableProps(data, symbol).liquidationRatio),
-  );
-  const leftToBorrowUsd = new Dec(payload.borrowLimitUsd).sub(payload.borrowedUsd);
-  payload.leftToBorrowUsd = leftToBorrowUsd.lte('0') ? '0' : leftToBorrowUsd.toString();
-  payload.ratio = +payload.suppliedUsd ? new Dec(payload.borrowLimitUsd).div(payload.borrowedUsd).mul(100).toString() : '0';
-  payload.collRatio = +payload.suppliedUsd ? new Dec(payload.suppliedCollateralUsd).div(payload.borrowedUsd).mul(100).toString() : '0';
-  const { netApy, incentiveUsd, totalInterestUsd } = calculateNetApy(usedAssets, assetsData);
-  payload.netApy = netApy;
-  payload.incentiveUsd = incentiveUsd;
-  payload.totalInterestUsd = totalInterestUsd;
-  payload.liqRatio = new Dec(payload.borrowLimitUsd).div(payload.liquidationLimitUsd).toString();
-  payload.liqPercent = new Dec(payload.borrowLimitUsd).div(payload.liquidationLimitUsd).mul(100).toString();
-  const { leveragedType, leveragedAsset } = isLeveragedPos(usedAssets);
-  payload.leveragedType = leveragedType;
-  if (leveragedType !== '') {
-    payload.leveragedAsset = leveragedAsset;
-    let assetPrice = data.assetsData[leveragedAsset].price; // TODO sparkPrice or price??
-    if (leveragedType === 'lsd-leverage') {
-      // Treat ETH like a stablecoin in a long stETH position
-      payload.leveragedLsdAssetRatio = new Dec(assetsData[leveragedAsset].price).div(assetsData.ETH.price).toDP(18).toString();
-      assetPrice = new Dec(assetPrice).div(assetsData.ETH.price).toString();
-    }
-    payload.liquidationPrice = calcLeverageLiqPrice(leveragedType, assetPrice, payload.borrowedUsd, payload.liquidationLimitUsd);
-  }
-  return payload;
+import Dec from 'decimal.js';
+import { calcLeverageLiqPrice, getAssetsTotal, isLeveragedPos } from '../../moneymarket';
+import {
+  SparkAggregatedPositionData,
+  SparkAssetsData, SparkHelperCommon, SparkUsedAssets,
+} from '../../types';
+import { calculateNetApy } from '../../staking';
+import { wethToEth } from '../../services/utils';
+
+export const sparkIsInIsolationMode = ({ usedAssets, assetsData }: { usedAssets: SparkUsedAssets, assetsData: SparkAssetsData }) => Object.values(usedAssets).some(({ symbol, collateral }) => collateral && assetsData[symbol].isIsolated);
+
+export const sparkGetCollSuppliedAssets = ({ usedAssets }: { usedAssets: SparkUsedAssets }) => Object.values(usedAssets).filter(({ isSupplied, collateral }) => isSupplied && collateral);
+
+export const sparkGetSuppliableAssets = ({
+  usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest
+}: SparkHelperCommon) => {
+  const data = {
+    usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest,
+  };
+
+  const collAccountAssets = sparkGetCollSuppliedAssets(data);
+  const marketAssets = Object.values(assetsData);
+
+  if (sparkIsInIsolationMode(data)) {
+    const collAsset = collAccountAssets[0].symbol;
+    return marketAssets.filter(d => d.canBeSupplied).map(({ symbol }) => ({ symbol, canBeCollateral: symbol === collAsset }));
+  }
+
+  return marketAssets.filter(d => d.canBeSupplied).map(({ symbol, isIsolated }) => ({ symbol, canBeCollateral: !isIsolated }));
+};
+
+export const sparkGetSuppliableAsCollAssets = ({
+  usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest
+}: SparkHelperCommon) => sparkGetSuppliableAssets({
+  usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest,
+}).filter(({ canBeCollateral }) => canBeCollateral);
+
+export const sparkGetEmodeMutableProps = ({
+  eModeCategory,
+  assetsData,
+}: SparkHelperCommon,
+_asset: string) => {
+  const asset = wethToEth(_asset);
+
+  const assetData = assetsData[asset];
+  if (
+    eModeCategory === 0
+    || assetData.eModeCategory !== eModeCategory
+    || new Dec(assetData?.eModeCategoryData?.collateralFactor || 0).eq(0)
+  ) {
+    const { liquidationRatio, collateralFactor } = assetData;
+    return ({ liquidationRatio, collateralFactor });
+  }
+  const { liquidationRatio, collateralFactor } = assetData.eModeCategoryData;
+  return ({ liquidationRatio, collateralFactor });
+};
+
+export const sparkGetAggregatedPositionData = ({
+  usedAssets,
+  eModeCategory,
+  eModeCategories,
+  assetsData,
+  selectedMarket,
+  network,
+  ...rest
+}: SparkHelperCommon): SparkAggregatedPositionData => {
+  const data = {
+    usedAssets, eModeCategory, eModeCategories, assetsData, selectedMarket, network, ...rest,
+  };
+  const payload = {} as SparkAggregatedPositionData;
+  payload.suppliedUsd = getAssetsTotal(usedAssets, ({ isSupplied }: { isSupplied: boolean }) => isSupplied, ({ suppliedUsd }: { suppliedUsd: string }) => suppliedUsd);
+  payload.suppliedCollateralUsd = getAssetsTotal(usedAssets, ({ isSupplied, collateral }: { isSupplied: boolean, collateral: boolean }) => isSupplied && collateral, ({ suppliedUsd }: { suppliedUsd: string }) => suppliedUsd);
+  payload.borrowedUsd = getAssetsTotal(usedAssets, ({ isBorrowed }: { isBorrowed: boolean }) => isBorrowed, ({ borrowedUsd }: { borrowedUsd: string }) => borrowedUsd);
+  payload.borrowLimitUsd = getAssetsTotal(
+    usedAssets,
+    ({ isSupplied, collateral }: { isSupplied: boolean, collateral: boolean }) => isSupplied && collateral,
+    ({ symbol, suppliedUsd }: { symbol: string, suppliedUsd: string }) => new Dec(suppliedUsd).mul(sparkGetEmodeMutableProps(data, symbol).collateralFactor),
+  );
+  payload.liquidationLimitUsd = getAssetsTotal(
+    usedAssets,
+    ({ isSupplied, collateral }: { isSupplied: boolean, collateral: boolean }) => isSupplied && collateral,
+    ({ symbol, suppliedUsd }: { symbol: string, suppliedUsd: string }) => new Dec(suppliedUsd).mul(sparkGetEmodeMutableProps(data, symbol).liquidationRatio),
+  );
+  const leftToBorrowUsd = new Dec(payload.borrowLimitUsd).sub(payload.borrowedUsd);
+  payload.leftToBorrowUsd = leftToBorrowUsd.lte('0') ? '0' : leftToBorrowUsd.toString();
+  payload.ratio = +payload.suppliedUsd ? new Dec(payload.borrowLimitUsd).div(payload.borrowedUsd).mul(100).toString() : '0';
+  payload.collRatio = +payload.suppliedUsd ? new Dec(payload.suppliedCollateralUsd).div(payload.borrowedUsd).mul(100).toString() : '0';
+  const { netApy, incentiveUsd, totalInterestUsd } = calculateNetApy(usedAssets, assetsData);
+  payload.netApy = netApy;
+  payload.incentiveUsd = incentiveUsd;
+  payload.totalInterestUsd = totalInterestUsd;
+  payload.liqRatio = new Dec(payload.borrowLimitUsd).div(payload.liquidationLimitUsd).toString();
+  payload.liqPercent = new Dec(payload.borrowLimitUsd).div(payload.liquidationLimitUsd).mul(100).toString();
+  const { leveragedType, leveragedAsset } = isLeveragedPos(usedAssets);
+  payload.leveragedType = leveragedType;
+  if (leveragedType !== '') {
+    payload.leveragedAsset = leveragedAsset;
+    let assetPrice = data.assetsData[leveragedAsset].price; // TODO sparkPrice or price??
+    if (leveragedType === 'lsd-leverage') {
+      // Treat ETH like a stablecoin in a long stETH position
+      payload.leveragedLsdAssetRatio = new Dec(assetsData[leveragedAsset].price).div(assetsData.ETH.price).toDP(18).toString();
+      assetPrice = new Dec(assetPrice).div(assetsData.ETH.price).toString();
+    }
+    payload.liquidationPrice = calcLeverageLiqPrice(leveragedType, assetPrice, payload.borrowedUsd, payload.liquidationLimitUsd);
+  }
+  return payload;
 };

package/src/index.ts

@@ -1,40 +1,40 @@
-import * as aaveV3 from './aaveV3';
-import * as morphoAaveV3 from './morphoAaveV3';
-import * as aaveV2 from './aaveV2';
-import * as morphoAaveV2 from './morphoAaveV2';
-import * as compoundV3 from './compoundV3';
-import * as compoundV2 from './compoundV2';
-import * as spark from './spark';
-import * as curveUsd from './curveUsd';
-import * as liquity from './liquity';
-import * as maker from './maker';
-import * as staking from './staking';
-import * as multicall from './multicall';
-import * as moneymarket from './moneymarket';
-import * as assets from './assets';
-import * as markets from './markets';
-import * as helpers from './helpers';
-import * as chickenBonds from './chickenBonds';
-import * as exchange from './exchange';
-
-export * from './types';
-
-export {
-  aaveV2,
-  aaveV3,
-  morphoAaveV2,
-  morphoAaveV3,
-  compoundV2,
-  compoundV3,
-  spark,
-  curveUsd,
-  liquity,
-  maker,
-  chickenBonds,
-  exchange,
-  staking,
-  multicall,
-  moneymarket,
-  markets,
-  helpers,
-};
+import * as aaveV3 from './aaveV3';
+import * as morphoAaveV3 from './morphoAaveV3';
+import * as aaveV2 from './aaveV2';
+import * as morphoAaveV2 from './morphoAaveV2';
+import * as compoundV3 from './compoundV3';
+import * as compoundV2 from './compoundV2';
+import * as spark from './spark';
+import * as curveUsd from './curveUsd';
+import * as liquity from './liquity';
+import * as maker from './maker';
+import * as staking from './staking';
+import * as multicall from './multicall';
+import * as moneymarket from './moneymarket';
+import * as assets from './assets';
+import * as markets from './markets';
+import * as helpers from './helpers';
+import * as chickenBonds from './chickenBonds';
+import * as exchange from './exchange';
+
+export * from './types';
+
+export {
+  aaveV2,
+  aaveV3,
+  morphoAaveV2,
+  morphoAaveV3,
+  compoundV2,
+  compoundV3,
+  spark,
+  curveUsd,
+  liquity,
+  maker,
+  chickenBonds,
+  exchange,
+  staking,
+  multicall,
+  moneymarket,
+  markets,
+  helpers,
+};