@defisaver/positions-sdk 0.0.1

package/src/types/aave.ts

@@ -0,0 +1,256 @@
+import {
+  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
+} from './common';
+
+import { IUiIncentiveDataProviderV3 } from './contracts/generated/AaveUiIncentiveDataProviderV3';
+
+export enum AaveVersions {
+  AaveV2 = 'v2default',
+  AaveV3 = 'v3default',
+  MorphoAaveV2 = 'morphoAaveV2',
+  MorphoAaveV3Eth = 'morphoAaveV3Eth',
+}
+export type AaveMarketInfo = {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  url: string,
+  value: AaveVersions,
+  assets: readonly string[],
+  provider: '' | 'LendingPoolAddressesProvider' | 'AaveV3PoolAddressesProvider',
+  providerAddress: string,
+  lendingPool: '' | 'AaveLendingPoolV2' | 'AaveV3LendingPool' | 'MorphoAaveV3ProxyEthMarket',
+  lendingPoolAddress: string,
+  protocolData: '' | 'AaveProtocolDataProvider' | 'AaveV3ProtocolDataProvider',
+  protocolDataAddress: string
+  subVersionLabel?: string
+  protocolName: string,
+  disabled?: boolean,
+};
+
+export interface DiscountData {
+  ghoDiscountedPerDiscountToken: string,
+  discountRate: string,
+  minDiscountTokenBalance: string,
+  minGhoBalanceForDiscount: string,
+}
+
+export interface EModeCategoryData {
+  label: string,
+  liquidationBonus: string,
+  liquidationRatio: string,
+  collateralFactor: string,
+  priceSource: string,
+}
+export interface EModeCategoryDataMapping {
+  enteringTerms: boolean[],
+  canEnterCategory: boolean,
+  id: number,
+  data: EModeCategoryData,
+  assets: string[],
+  enabledData: {
+    ratio: string,
+    liqRatio: string,
+    liqPercent: string,
+    collRatio: string,
+  }
+}
+
+export interface AaveAssetData extends MMAssetData {
+  sortIndex?: number,
+  isIsolated?: boolean,
+  usageAsCollateralEnabled: boolean,
+  isInactive: boolean,
+  canBeWithdrawn: boolean,
+  canBePayBacked: boolean,
+  liquidationRatio: string,
+  supplyCap: string,
+  disabledStableBorrowing: boolean,
+  borrowRateStable: string,
+  totalBorrowVar: string,
+}
+
+
+export interface AaveV2AssetData extends AaveAssetData {
+  priceInEth: string,
+}
+
+export interface MorphoAaveV2AssetData extends AaveV2AssetData {
+}
+
+export interface AaveV3AssetData extends AaveAssetData {
+  isIsolated: boolean,
+  isSiloed: boolean,
+  nativeAsset: boolean,
+  discountData: DiscountData,
+  debtCeilingForIsolationMode: string,
+  eModeCategory: number,
+  isolationModeTotalDebt: string,
+  borrowRateDiscounted: string,
+  isolationModeBorrowingEnabled: boolean,
+  eModeCategoryData: EModeCategoryData,
+  supplyRateP2P?: string,
+  borrowRateP2P?: string,
+  isFrozen: boolean,
+  isPaused: boolean,
+  isFlashLoanEnabled: boolean,
+  assetId: string | null,
+}
+
+export interface MorphoAaveV3AssetData extends Omit<AaveV3AssetData, 'nativeAsset' | 'discountData' | 'borrowRateDiscounted'> {
+}
+
+export type AaveAssetsData<T> = { [key: string]: T };
+
+export type AaveV2AssetsData = AaveAssetsData<AaveV2AssetData>;
+
+export type AaveV2MarketData = { assetsData: AaveV2AssetsData };
+
+export type MorphoAaveV2AssetsData = AaveAssetsData<MorphoAaveV2AssetData>;
+
+export type MorphoAaveV2MarketData = { assetsData: MorphoAaveV2AssetsData };
+
+export type AaveV3AssetsData = AaveAssetsData<AaveV3AssetData>;
+
+export type AaveV3MarketData = { assetsData: AaveV3AssetsData };
+
+export type MorphoAaveV3AssetsData = AaveAssetsData<MorphoAaveV3AssetData>;
+
+export type MorphoAaveV3MarketData = { assetsData: MorphoAaveV3AssetsData };
+
+export interface AaveUsedAsset extends MMUsedAsset {
+  stableBorrowRate: string,
+  borrowedStable: string,
+  borrowedVariable: string,
+  borrowedUsdStable: string,
+  borrowedUsdVariable: string,
+  stableLimit: string,
+  variableLimit: string,
+  limit: string,
+}
+
+export interface AaveV2UsedAsset extends AaveUsedAsset {
+}
+
+export interface MorphoAaveV2UsedAsset extends Omit<AaveV2UsedAsset, 'debt'> {
+  suppliedP2P: string,
+  suppliedPool: string,
+  suppliedMatched: string,
+  borrowedP2P: string,
+  borrowedPool: string,
+  borrowedMatched: string,
+  suppliedP2PUsd: string,
+  suppliedPoolUsd: string,
+  borrowedP2PUsd: string,
+  borrowedPoolUsd: string,
+  eModeCategory: number,
+}
+export interface AaveV3UsedAsset extends AaveUsedAsset {
+  discountedBorrowRate: string,
+  eModeCategory: number,
+  supplyRate: string,
+  borrowRate: string,
+  interestMode: string,
+  collateral: boolean,
+}
+
+export interface MorphoAaveV3UsedAsset extends Omit<AaveV3UsedAsset, 'discountedBorrowRate' | 'debt'> {
+  suppliedP2P: string,
+  suppliedPool: string,
+  suppliedMatched: string,
+  borrowedP2P: string,
+  borrowedPool: string,
+  borrowedMatched: string,
+  suppliedP2PUsd: string,
+  suppliedPoolUsd: string,
+  borrowedP2PUsd: string,
+  borrowedPoolUsd: string,
+}
+
+export type AaveUsedAssets<T> = { [key: string]: T };
+
+export type AaveV2UsedAssets = AaveUsedAssets<AaveV2UsedAsset>;
+
+export type MorphoAaveV2UsedAssets = AaveUsedAssets<MorphoAaveV2UsedAsset>;
+
+export type AaveV3UsedAssets = AaveUsedAssets<AaveV3UsedAsset>;
+
+export type MorphoAaveV3UsedAssets = AaveUsedAssets<MorphoAaveV3UsedAsset>;
+
+export interface AavePositionData extends MMPositionData {
+  ratio: string,
+  minRatio: string,
+  collRatio: string,
+  borrowedUsd: string,
+  borrowLimitUsd: string,
+  suppliedCollateralUsd: string,
+  incentiveUsd: string,
+  totalInterestUsd: string,
+  isSubscribedToAutomation?: boolean,
+  automationResubscribeRequired?: boolean,
+  totalSupplied: string,
+}
+
+export interface AaveV2PositionData extends AavePositionData {
+  usedAssets: AaveV2UsedAssets,
+}
+
+export interface AaveV3PositionData extends AavePositionData {
+  usedAssets: AaveV3UsedAssets,
+  eModeCategory: number,
+  isInIsolationMode: boolean,
+  isInSiloedMode: boolean,
+  eModeCategories: { [key: number]: EModeCategoryDataMapping },
+}
+
+export interface MorphoAaveV3PositionData extends AavePositionData {
+  usedAssets: MorphoAaveV3UsedAssets,
+  approvedManager?: string,
+  eModeCategory: number,
+}
+
+export interface MorphoAaveV2PositionData extends AavePositionData {
+  usedAssets: MorphoAaveV2UsedAssets,
+}
+
+export interface AaveV3IncentiveData {
+  underlyingAsset: string,
+  aIncentiveData: IUiIncentiveDataProviderV3.IncentiveDataStructOutput,
+  vIncentiveData: IUiIncentiveDataProviderV3.IncentiveDataStructOutput,
+  sIncentiveData: IUiIncentiveDataProviderV3.IncentiveDataStructOutput
+}
+
+export interface AaveV3AggregatedPositionData {
+  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,
+}
+
+export interface AaveHelperCommon {
+  usedAssets: any,
+  eModeCategory: number,
+  eModeCategories?: number[],
+  assetsData: any,
+  selectedMarket: Partial<AaveMarketInfo>,
+  network?: NetworkNumber,
+}
+
+export type MorphoAaveV2MarketInfo = Omit<AaveMarketInfo, 'provider' | 'lendingPool' | 'protocolData' | 'protocolDataAddress'>;
+
+export type MorphoAaveV3MarketInfo = Omit<AaveMarketInfo, 'provider'>;
+
+export type MorphoAaveMarketInfo = MorphoAaveV2MarketInfo | MorphoAaveV3MarketInfo;

package/src/types/common.ts

@@ -0,0 +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,
+}

package/src/types/compound.ts

@@ -0,0 +1,122 @@
+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,
+}