@defisaver/positions-sdk 0.0.16 → 0.0.18

package/src/types/common.ts

@@ -1,84 +1,84 @@
-// General
-export type EthAddress = string;
-export type Blockish = number | 'latest';
-export type AssetSymbol = string;
-export type Amount = string | number;
-
-export enum NetworkNumber {
-  Eth = 1,
-  Opt = 10,
-  Arb = 42161,
-  Base = 8453,
-}
-export type Networkish = string | NetworkNumber;
-
-// Common
-export interface MMAssetData {
-  symbol: string,
-  supplyRate: string,
-  borrowRate: string,
-  price: string,
-  collateralFactor: string,
-  underlyingTokenAddress: string,
-  marketLiquidity: string,
-  utilization: string,
-  borrowCap: string,
-  totalSupply: string,
-  canBeBorrowed: boolean,
-  canBeSupplied: boolean,
-  totalBorrow: string,
-  incentiveBorrowApy?: string,
-  incentiveBorrowToken?: string,
-  incentiveSupplyApy?: string,
-  incentiveSupplyToken?: string,
-  borrowRateP2P?: string,
-  supplyRateP2P?: string,
-}
-
-export interface MMAssetsData {
-  [token: string]: MMAssetData,
-}
-export interface MMMarketData {
-  assetsData: MMAssetData[],
-}
-export interface MMUsedAsset {
-  symbol: string,
-  supplied: string,
-  suppliedUsd: string,
-  isSupplied: boolean,
-  borrowed: string,
-  borrowedUsd: string,
-  isBorrowed: boolean,
-  debt: string,
-  supplyRate?: string,
-  borrowRate?: string,
-  discountedBorrowRate?: string,
-  stableBorrowRate?: string,
-  interestMode?: string,
-  collateral?: boolean,
-}
-export interface MMUsedAssets {
-  [token: string]: MMUsedAsset,
-}
-export interface MMUsedAssetWStableB extends MMUsedAsset {
-  stableBorrowRate: string,
-  borrowedStable: string,
-  borrowedVariable: string,
-  borrowedUsdStable: string,
-  borrowedUsdVariable: string,
-  interestMode: string,
-}
-export interface MMPositionData {
-  usedAssets: any,
-  netApy: string,
-  lastUpdated: number,
-  // ...
-}
-
-export type Balances = Record<AssetSymbol, Amount>;
-export interface PositionBalances {
-  collateral?: Balances,
-  debt?: Balances,
-  selling?: Balances,
-  deposited?: Balances,
+// General
+export type EthAddress = string;
+export type Blockish = number | 'latest';
+export type AssetSymbol = string;
+export type Amount = string | number;
+
+export enum NetworkNumber {
+  Eth = 1,
+  Opt = 10,
+  Arb = 42161,
+  Base = 8453,
+}
+export type Networkish = string | NetworkNumber;
+
+// Common
+export interface MMAssetData {
+  symbol: string,
+  supplyRate: string,
+  borrowRate: string,
+  price: string,
+  collateralFactor: string,
+  underlyingTokenAddress: string,
+  marketLiquidity: string,
+  utilization: string,
+  borrowCap: string,
+  totalSupply: string,
+  canBeBorrowed: boolean,
+  canBeSupplied: boolean,
+  totalBorrow: string,
+  incentiveBorrowApy?: string,
+  incentiveBorrowToken?: string,
+  incentiveSupplyApy?: string,
+  incentiveSupplyToken?: string,
+  borrowRateP2P?: string,
+  supplyRateP2P?: string,
+}
+
+export interface MMAssetsData {
+  [token: string]: MMAssetData,
+}
+export interface MMMarketData {
+  assetsData: MMAssetData[],
+}
+export interface MMUsedAsset {
+  symbol: string,
+  supplied: string,
+  suppliedUsd: string,
+  isSupplied: boolean,
+  borrowed: string,
+  borrowedUsd: string,
+  isBorrowed: boolean,
+  debt: string,
+  supplyRate?: string,
+  borrowRate?: string,
+  discountedBorrowRate?: string,
+  stableBorrowRate?: string,
+  interestMode?: string,
+  collateral?: boolean,
+}
+export interface MMUsedAssets {
+  [token: string]: MMUsedAsset,
+}
+export interface MMUsedAssetWStableB extends MMUsedAsset {
+  stableBorrowRate: string,
+  borrowedStable: string,
+  borrowedVariable: string,
+  borrowedUsdStable: string,
+  borrowedUsdVariable: string,
+  interestMode: string,
+}
+export interface MMPositionData {
+  usedAssets: any,
+  netApy: string,
+  lastUpdated: number,
+  // ...
+}
+
+export type Balances = Record<AssetSymbol, Amount>;
+export interface PositionBalances {
+  collateral?: Balances,
+  debt?: Balances,
+  selling?: Balances,
+  deposited?: Balances,
 }

package/src/types/compound.ts

@@ -1,122 +1,123 @@
-import {
-  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
-} from './common';
-
-export enum CompoundVersions {
-  'CompoundV2' = 'v2',
-  'CompoundV3USDC' = 'v3-USDC',
-  'CompoundV3ETH' = 'v3-ETH',
-  'CompoundV3USDbC' = 'v3-USDbC',
-}
-
-export interface CompoundMarketData {
-  chainIds: NetworkNumber[],
-  label: string,
-  shortLabel: string,
-  value: CompoundVersions,
-  baseAsset: string,
-  collAssets: readonly string[],
-  baseMarket: string,
-  baseMarketAddress: string,
-  secondLabel: string,
-  bulkerName: string,
-  bulkerAddress: string,
-  bulkerOptions: { supply: string | number, withdraw: string | number },
-  // icon: Function,
-}
-
-export interface CompoundUsedAsset extends MMUsedAsset {
-  collateral: boolean,
-  limit?: string,
-}
-
-export interface CompoundV2UsedAsset extends CompoundUsedAsset {
-}
-export interface CompoundV3UsedAsset extends CompoundUsedAsset {
-}
-
-export interface CompoundUsedAssets<T> {
-  [token: string]: T,
-}
-
-export type CompoundV2UsedAssets = CompoundUsedAssets<CompoundV2UsedAsset>;
-export type CompoundV3UsedAssets = CompoundUsedAssets<CompoundV3UsedAsset>;
-
-export interface CompoundAssetData extends MMAssetData {
-  supplyCapAlternative?: string,
-  totalSupplyAlternative?: string,
-  priceAlternative?: string,
-  sortIndex?: number,
-}
-
-export interface CompoundV2AssetData extends CompoundAssetData {
-}
-export interface CompoundV3AssetData extends CompoundAssetData {
-  borrowCollateralFactor: string,
-  liquidateCollateralFactor: string,
-  minDebt: string,
-  liquidationRatio: string,
-  supplyCap: string,
-}
-
-export interface CompoundAssetsData<T> {
-  [token: string]: T
-}
-export type CompoundV2AssetsData = CompoundAssetsData<CompoundV2AssetData>;
-export type CompoundV3AssetsData = CompoundAssetsData<CompoundV3AssetData>;
-
-export type CompoundMarketsData<T> = { assetsData: T };
-export type CompoundV2MarketsData = CompoundMarketsData<CompoundV2AssetsData>;
-export type CompoundV3MarketsData = CompoundMarketsData<CompoundV3AssetsData>;
-
-export interface BaseAdditionalAssetData {
-  totalBorrow: string,
-  utilization: string,
-  marketLiquidity: string,
-  rewardSupplySpeed: string,
-  rewardBorrowSpeed: string,
-  minDebt: string,
-  isBase: boolean,
-}
-
-export interface CompoundAggregatedPositionData {
-  suppliedUsd: string,
-  suppliedCollateralUsd: string,
-  borrowedUsd: string,
-  borrowLimitUsd: string,
-  liquidationLimitUsd: string,
-  leftToBorrowUsd: string,
-  ratio: string,
-  collRatio: string,
-  netApy: string,
-  incentiveUsd: string,
-  totalInterestUsd: string,
-  liqRatio: string,
-  liqPercent: string,
-  leveragedType: string,
-  leveragedAsset?: string,
-  leveragedLsdAssetRatio?: string,
-  liquidationPrice?: string,
-  minRatio: string,
-  debtTooLow: boolean,
-  minDebt: string,
-}
-
-export interface CompoundPositionData extends MMPositionData {
-  ratio: string,
-  minRatio: string,
-  borrowedUsd: string,
-  borrowLimitUsd: string,
-  incentiveUsd: string,
-  totalInterestUsd: string,
-  isSubscribedToAutomation?: boolean,
-  automationResubscribeRequired?: boolean,
-}
-
-export interface CompoundV2PositionData extends CompoundPositionData {
-  usedAssets: CompoundV2UsedAssets,
-}
-
-export interface CompoundV3PositionData extends CompoundPositionData {
-  usedAssets: CompoundV3UsedAssets,
+import {
+  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
+} from './common';
+
+export enum CompoundVersions {
+  'CompoundV2' = 'v2',
+  'CompoundV3USDC' = 'v3-USDC',
+  'CompoundV3ETH' = 'v3-ETH',
+  'CompoundV3USDbC' = 'v3-USDbC',
+}
+
+export interface CompoundMarketData {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  value: CompoundVersions,
+  baseAsset: string,
+  collAssets: readonly string[],
+  baseMarket: string,
+  baseMarketAddress: string,
+  secondLabel: string,
+  bulkerName: string,
+  bulkerAddress: string,
+  bulkerOptions: { supply: string | number, withdraw: string | number },
+  // icon: Function,
+}
+
+export interface CompoundUsedAsset extends MMUsedAsset {
+  collateral: boolean,
+  limit?: string,
+}
+
+export interface CompoundV2UsedAsset extends CompoundUsedAsset {
+}
+export interface CompoundV3UsedAsset extends CompoundUsedAsset {
+}
+
+export interface CompoundUsedAssets<T> {
+  [token: string]: T,
+}
+
+export type CompoundV2UsedAssets = CompoundUsedAssets<CompoundV2UsedAsset>;
+export type CompoundV3UsedAssets = CompoundUsedAssets<CompoundV3UsedAsset>;
+
+export interface CompoundAssetData extends MMAssetData {
+  supplyCapAlternative?: string,
+  totalSupplyAlternative?: string,
+  priceAlternative?: string,
+  sortIndex?: number,
+}
+
+export interface CompoundV2AssetData extends CompoundAssetData {
+}
+export interface CompoundV3AssetData extends CompoundAssetData {
+  borrowCollateralFactor: string,
+  liquidateCollateralFactor: string,
+  minDebt: string,
+  liquidationRatio: string,
+  supplyCap: string,
+  priceInBaseAsset: string,
+}
+
+export interface CompoundAssetsData<T> {
+  [token: string]: T
+}
+export type CompoundV2AssetsData = CompoundAssetsData<CompoundV2AssetData>;
+export type CompoundV3AssetsData = CompoundAssetsData<CompoundV3AssetData>;
+
+export type CompoundMarketsData<T> = { assetsData: T };
+export type CompoundV2MarketsData = CompoundMarketsData<CompoundV2AssetsData>;
+export type CompoundV3MarketsData = CompoundMarketsData<CompoundV3AssetsData>;
+
+export interface BaseAdditionalAssetData {
+  totalBorrow: string,
+  utilization: string,
+  marketLiquidity: string,
+  rewardSupplySpeed: string,
+  rewardBorrowSpeed: string,
+  minDebt: string,
+  isBase: boolean,
+}
+
+export interface CompoundAggregatedPositionData {
+  suppliedUsd: string,
+  suppliedCollateralUsd: string,
+  borrowedUsd: string,
+  borrowLimitUsd: string,
+  liquidationLimitUsd: string,
+  leftToBorrowUsd: string,
+  ratio: string,
+  collRatio: string,
+  netApy: string,
+  incentiveUsd: string,
+  totalInterestUsd: string,
+  liqRatio: string,
+  liqPercent: string,
+  leveragedType: string,
+  leveragedAsset?: string,
+  leveragedLsdAssetRatio?: string,
+  liquidationPrice?: string,
+  minRatio: string,
+  debtTooLow: boolean,
+  minDebt: string,
+}
+
+export interface CompoundPositionData extends MMPositionData {
+  ratio: string,
+  minRatio: string,
+  borrowedUsd: string,
+  borrowLimitUsd: string,
+  incentiveUsd: string,
+  totalInterestUsd: string,
+  isSubscribedToAutomation?: boolean,
+  automationResubscribeRequired?: boolean,
+}
+
+export interface CompoundV2PositionData extends CompoundPositionData {
+  usedAssets: CompoundV2UsedAssets,
+}
+
+export interface CompoundV3PositionData extends CompoundPositionData {
+  usedAssets: CompoundV3UsedAssets,
 }

package/src/types/curveUsd.ts

@@ -1,113 +1,113 @@
-import { NetworkNumber } from './common';
-
-export enum CrvUSDVersions {
-  'wstETH' = 'wstETH',
-  'WBTC' = 'WBTC',
-  'ETH' = 'ETH',
-  'tBTC' = 'tBTC',
-  'sfrxETH' = 'sfrxETH',
-}
-
-export enum CrvUSDStatus {
-  Nonexistant = 'Nonexistant',
-  Safe = 'Safe',
-  Risk = 'Risk',
-  SoftLiquidating = 'SoftLiquidating',
-  SoftLiquidated = 'SoftLiquidated',
-}
-
-export interface CrvUSDMarketData {
-  chainIds: NetworkNumber[],
-  label: string,
-  shortLabel: string,
-  value: CrvUSDVersions,
-  collAsset: string,
-  baseAsset: string,
-  controllerAddress: string,
-  ammAddress: string,
-  createCollAssets: string[],
-}
-
-export interface BandData {
-  id: string,
-  collAmount: string,
-  debtAmount: string,
-  lowPrice: string,
-  highPrice: string,
-}
-
-export interface UserBandData {
-  id: string,
-  collAmount: string,
-  debtAmount: string,
-  lowPrice: string,
-  highPrice: string,
-  userDebtAmount: string,
-  userCollAmount: string,
-}
-
-export interface CrvUSDGlobalMarketData {
-  collateral: string,
-  decimals: string,
-  activeBand: string,
-  totalDebt: string,
-  ammPrice: string,
-  basePrice: string,
-  oraclePrice: string,
-  minted: string,
-  redeemed: string,
-  monetaryPolicyRate: string,
-  ammRate: string,
-  minBand: string,
-  maxBand: string,
-  debtCeiling: string,
-  borrowRate: string,
-  futureBorrowRate: string,
-  leftToBorrow: string,
-  bands: BandData[],
-}
-
-export interface CrvUSDAggregatedPositionData {
-  ratio: string,
-  supplied: string,
-  suppliedUsd: string,
-  borrowedUsd: string,
-  borrowed: string,
-  safetyRatio: string,
-}
-
-export interface CrvUSDUsedAsset {
-  isSupplied: boolean,
-  supplied: string,
-  suppliedUsd: string,
-  borrowed: string,
-  borrowedUsd: string,
-  isBorrowed: boolean,
-  symbol: string,
-  collateral: boolean,
-  price: string,
-  interestRate?: string,
-}
-
-export interface CrvUSDUsedAssets {
-  [key: string]: CrvUSDUsedAsset,
-}
-
-export interface CrvUSDUserData {
-  debtAmount: string,
-  health: string,
-  healthPercent: string,
-  priceHigh: string,
-  priceLow: string,
-  liquidationDiscount: string,
-  numOfBands: string,
-  usedAssets: CrvUSDUsedAssets,
-  status: CrvUSDStatus,
-  ratio: string,
-  supplied: string,
-  suppliedUsd: string,
-  borrowedUsd: string,
-  borrowed: string,
-  safetyRatio: string,
-  userBands: UserBandData[],
+import { NetworkNumber } from './common';
+
+export enum CrvUSDVersions {
+  'wstETH' = 'wstETH',
+  'WBTC' = 'WBTC',
+  'ETH' = 'ETH',
+  'tBTC' = 'tBTC',
+  'sfrxETH' = 'sfrxETH',
+}
+
+export enum CrvUSDStatus {
+  Nonexistant = 'Nonexistant',
+  Safe = 'Safe',
+  Risk = 'Risk',
+  SoftLiquidating = 'SoftLiquidating',
+  SoftLiquidated = 'SoftLiquidated',
+}
+
+export interface CrvUSDMarketData {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  value: CrvUSDVersions,
+  collAsset: string,
+  baseAsset: string,
+  controllerAddress: string,
+  ammAddress: string,
+  createCollAssets: string[],
+}
+
+export interface BandData {
+  id: string,
+  collAmount: string,
+  debtAmount: string,
+  lowPrice: string,
+  highPrice: string,
+}
+
+export interface UserBandData {
+  id: string,
+  collAmount: string,
+  debtAmount: string,
+  lowPrice: string,
+  highPrice: string,
+  userDebtAmount: string,
+  userCollAmount: string,
+}
+
+export interface CrvUSDGlobalMarketData {
+  collateral: string,
+  decimals: string,
+  activeBand: string,
+  totalDebt: string,
+  ammPrice: string,
+  basePrice: string,
+  oraclePrice: string,
+  minted: string,
+  redeemed: string,
+  monetaryPolicyRate: string,
+  ammRate: string,
+  minBand: string,
+  maxBand: string,
+  debtCeiling: string,
+  borrowRate: string,
+  futureBorrowRate: string,
+  leftToBorrow: string,
+  bands: BandData[],
+}
+
+export interface CrvUSDAggregatedPositionData {
+  ratio: string,
+  supplied: string,
+  suppliedUsd: string,
+  borrowedUsd: string,
+  borrowed: string,
+  safetyRatio: string,
+}
+
+export interface CrvUSDUsedAsset {
+  isSupplied: boolean,
+  supplied: string,
+  suppliedUsd: string,
+  borrowed: string,
+  borrowedUsd: string,
+  isBorrowed: boolean,
+  symbol: string,
+  collateral: boolean,
+  price: string,
+  interestRate?: string,
+}
+
+export interface CrvUSDUsedAssets {
+  [key: string]: CrvUSDUsedAsset,
+}
+
+export interface CrvUSDUserData {
+  debtAmount: string,
+  health: string,
+  healthPercent: string,
+  priceHigh: string,
+  priceLow: string,
+  liquidationDiscount: string,
+  numOfBands: string,
+  usedAssets: CrvUSDUsedAssets,
+  status: CrvUSDStatus,
+  ratio: string,
+  supplied: string,
+  suppliedUsd: string,
+  borrowedUsd: string,
+  borrowed: string,
+  safetyRatio: string,
+  userBands: UserBandData[],
 }

package/src/types/index.ts

@@ -1,7 +1,7 @@
-export * from './aave';
-export * from './compound';
-export * from './spark';
-export * from './curveUsd';
-export * from './liquity';
-export * from './maker';
+export * from './aave';
+export * from './compound';
+export * from './spark';
+export * from './curveUsd';
+export * from './liquity';
+export * from './maker';
 export * from './chickenBonds';