@defisaver/positions-sdk 2.0.12 → 2.0.14-dev-portfolio

package/src/types/aave.ts

@@ -1,194 +1,194 @@
-import {
-  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
-} from './common';
-
-export enum AaveVersions {
-  AaveV1 = 'v1',
-  AaveV2 = 'v2default',
-  AaveV3 = 'v3default',
-  AaveV3Lido = 'v3lido',
-  AaveV3Etherfi = 'v3etherfi',
-}
-export type AaveMarketInfo = {
-  chainIds: NetworkNumber[],
-  label: string,
-  shortLabel: string,
-  url: string,
-  value: AaveVersions,
-  assets: readonly string[],
-  provider: '' | 'LendingPoolAddressesProvider' | 'AaveV3PoolAddressesProvider' | 'AaveV3LidoPoolAddressesProvider' | 'AaveV3EtherfiPoolAddressesProvider',
-  providerAddress: `0x${string}`,
-  lendingPool: '' | 'AaveLendingPoolV2' | 'AaveV3LendingPool' | 'AaveV3LidoLendingPool' | 'AaveV3EtherfiLendingPool',
-  lendingPoolAddress: string,
-  protocolData: '' | 'AaveProtocolDataProvider' | 'AaveV3ProtocolDataProvider' | 'AaveV3LidoProtocolDataProvider' | 'AaveV3EtherfiProtocolDataProvider',
-  protocolDataAddress: string
-  subVersionLabel?: string
-  protocolName: string,
-  disabled?: boolean,
-};
-
-export interface EModeCategoryData {
-  label: string,
-  id: number,
-  liquidationBonus: string,
-  liquidationRatio: string,
-  collateralFactor: string,
-  borrowableBitmap?: string,
-  collateralBitmap?: string,
-  collateralAssets: string[],
-  borrowAssets: string[],
-}
-export interface EModeCategoryDataMapping {
-  enteringTerms: boolean[],
-  canEnterCategory: boolean,
-  id: number,
-  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,
-  isFrozen: boolean,
-}
-
-export interface IncentiveData {
-  token: string,
-  apy: string,
-  incentiveKind?: 'staking' | 'reward';
-}
-
-export interface AaveV3AssetData extends AaveAssetData {
-  isIsolated: boolean,
-  isSiloed: boolean,
-  debtCeilingForIsolationMode: string,
-  isolationModeTotalDebt: string,
-  isolationModeBorrowingEnabled: boolean,
-  supplyRateP2P?: string,
-  borrowRateP2P?: string,
-  isFrozen: boolean,
-  isPaused: boolean,
-  isFlashLoanEnabled: boolean,
-  assetId: string | number | null,
-  liquidationBonus: string,
-  supplyIncentives?: IncentiveData[];
-  borrowIncentives?: IncentiveData[];
-}
-
-export type EModeCategoriesData = Record<number, EModeCategoryData>;
-
-export type AaveAssetsData<T> = { [key: string]: T };
-
-export type AaveV2AssetsData = AaveAssetsData<AaveV2AssetData>;
-
-export type AaveV2MarketData = { assetsData: AaveV2AssetsData };
-
-export type AaveV3AssetsData = AaveAssetsData<AaveV3AssetData>;
-
-export type AaveV3MarketData = { assetsData: AaveV3AssetsData, eModeCategoriesData: EModeCategoriesData };
-
-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 AaveV3UsedAsset extends AaveUsedAsset {
-  supplyRate: string,
-  borrowRate: string,
-  interestMode: string,
-  collateral: boolean,
-}
-
-export type AaveUsedAssets<T> = { [key: string]: T };
-
-export type AaveV2UsedAssets = AaveUsedAssets<AaveV2UsedAsset>;
-
-export type AaveV3UsedAssets = AaveUsedAssets<AaveV3UsedAsset>;
-
-export interface AavePositionData extends MMPositionData {
-  ratio: string,
-  minRatio: string,
-  collRatio: string,
-  suppliedUsd: 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 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,
-  minCollRatio?: string,
-  collLiquidationRatio?: string,
-  healthRatio?: string,
-  minHealthRatio?: string,
-}
-
-export interface AaveHelperCommon {
-  usedAssets: any,
-  eModeCategory: number,
-  eModeCategories?: { [key: number]: EModeCategoryDataMapping },
-  eModeCategoriesData?: EModeCategoriesData,
-  assetsData: any,
-  selectedMarket: Partial<AaveMarketInfo>,
-  network?: NetworkNumber,
-}
+import {
+  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
+} from './common';
+
+export enum AaveVersions {
+  AaveV1 = 'v1',
+  AaveV2 = 'v2default',
+  AaveV3 = 'v3default',
+  AaveV3Lido = 'v3lido',
+  AaveV3Etherfi = 'v3etherfi',
+}
+export type AaveMarketInfo = {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  url: string,
+  value: AaveVersions,
+  assets: readonly string[],
+  provider: '' | 'LendingPoolAddressesProvider' | 'AaveV3PoolAddressesProvider' | 'AaveV3LidoPoolAddressesProvider' | 'AaveV3EtherfiPoolAddressesProvider',
+  providerAddress: `0x${string}`,
+  lendingPool: '' | 'AaveLendingPoolV2' | 'AaveV3LendingPool' | 'AaveV3LidoLendingPool' | 'AaveV3EtherfiLendingPool',
+  lendingPoolAddress: string,
+  protocolData: '' | 'AaveProtocolDataProvider' | 'AaveV3ProtocolDataProvider' | 'AaveV3LidoProtocolDataProvider' | 'AaveV3EtherfiProtocolDataProvider',
+  protocolDataAddress: string
+  subVersionLabel?: string
+  protocolName: string,
+  disabled?: boolean,
+};
+
+export interface EModeCategoryData {
+  label: string,
+  id: number,
+  liquidationBonus: string,
+  liquidationRatio: string,
+  collateralFactor: string,
+  borrowableBitmap?: string,
+  collateralBitmap?: string,
+  collateralAssets: string[],
+  borrowAssets: string[],
+}
+export interface EModeCategoryDataMapping {
+  enteringTerms: boolean[],
+  canEnterCategory: boolean,
+  id: number,
+  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,
+  isFrozen: boolean,
+}
+
+export interface IncentiveData {
+  token: string,
+  apy: string,
+  incentiveKind?: 'staking' | 'reward';
+}
+
+export interface AaveV3AssetData extends AaveAssetData {
+  isIsolated: boolean,
+  isSiloed: boolean,
+  debtCeilingForIsolationMode: string,
+  isolationModeTotalDebt: string,
+  isolationModeBorrowingEnabled: boolean,
+  supplyRateP2P?: string,
+  borrowRateP2P?: string,
+  isFrozen: boolean,
+  isPaused: boolean,
+  isFlashLoanEnabled: boolean,
+  assetId: string | number | null,
+  liquidationBonus: string,
+  supplyIncentives?: IncentiveData[];
+  borrowIncentives?: IncentiveData[];
+}
+
+export type EModeCategoriesData = Record<number, EModeCategoryData>;
+
+export type AaveAssetsData<T> = { [key: string]: T };
+
+export type AaveV2AssetsData = AaveAssetsData<AaveV2AssetData>;
+
+export type AaveV2MarketData = { assetsData: AaveV2AssetsData };
+
+export type AaveV3AssetsData = AaveAssetsData<AaveV3AssetData>;
+
+export type AaveV3MarketData = { assetsData: AaveV3AssetsData, eModeCategoriesData: EModeCategoriesData };
+
+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 AaveV3UsedAsset extends AaveUsedAsset {
+  supplyRate: string,
+  borrowRate: string,
+  interestMode: string,
+  collateral: boolean,
+}
+
+export type AaveUsedAssets<T> = { [key: string]: T };
+
+export type AaveV2UsedAssets = AaveUsedAssets<AaveV2UsedAsset>;
+
+export type AaveV3UsedAssets = AaveUsedAssets<AaveV3UsedAsset>;
+
+export interface AavePositionData extends MMPositionData {
+  ratio: string,
+  minRatio: string,
+  collRatio: string,
+  suppliedUsd: 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 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,
+  minCollRatio?: string,
+  collLiquidationRatio?: string,
+  healthRatio?: string,
+  minHealthRatio?: string,
+}
+
+export interface AaveHelperCommon {
+  usedAssets: any,
+  eModeCategory: number,
+  eModeCategories?: { [key: number]: EModeCategoryDataMapping },
+  eModeCategoriesData?: EModeCategoriesData,
+  assetsData: any,
+  selectedMarket: Partial<AaveMarketInfo>,
+  network?: NetworkNumber,
+}

package/src/types/claiming.ts

@@ -0,0 +1,109 @@
+import { EthAddress } from './common';
+
+export enum ClaimType {
+  /** Rewards from AAVE - various tokens & aTokens (supplied to protocol) */
+  AAVE_REWARDS = 'AAVE_REWARDS',
+  /** Merit rewards from AAVE (various tokens) */
+  AAVE_MERIT_REWARDS = 'AAVE_MERIT_REWARDS',
+  /** Rewards from Compound V3 (only in COMP) */
+  COMPOUND_V3_COMP = 'COMPOUND_V3_COMP',
+  /** Rewards from Spark (wstETH only for now) */
+  SPARK_REWARDS = 'SPARK_REWARDS',
+  /** Rewards from Morpho */
+  MORPHO = 'MORPHO',
+  /** Rewards from King (prev LTR^2 - received for weETH holding) */
+  KING_REWARDS = 'KING_REWARDS',
+  /** Spark Airdrop */
+  SPARK_AIRDROP = 'SPARK_AIRDROP',
+  /** Spark Airdrop */
+  SPARK_WST_ETH_REWARDS = 'SPARK_WST_ETH_REWARDS', // TODO: This will be removed once we fully refactor spark rewards
+}
+
+type _ClaimableTokenPartial = {
+  symbol: string;
+  underlyingSymbol: string;
+  tokenAddress: EthAddress;
+  amount: string;
+  walletAddress: EthAddress;
+  label: string;
+};
+export type AaveRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.AAVE_REWARDS;
+  additionalClaimFields: {
+    marketAddress: EthAddress;
+    aTokenAddresses: string[];
+    isAaveToken: boolean;
+  };
+};
+export type AaveMeritRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.AAVE_MERIT_REWARDS;
+  additionalClaimFields: {
+    accumulated: string;
+    proof: string[];
+    decimals: string;
+    unclaimed: string;
+  };
+};
+
+export type SparkRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.SPARK_REWARDS;
+  additionalClaimFields: {
+    sparkAssetAddresses: string[];
+  };
+};
+
+export type KingRewardsClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.KING_REWARDS;
+  additionalClaimFields: {
+    allRewardsAmount: string;
+    merkleRoot: string;
+    merkleProofs: string[];
+  };
+};
+
+export type MorphoClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.MORPHO,
+  additionalClaimFields: {
+    originalAmount: string,
+    merkleProofs: string[];
+    distributor: EthAddress;
+    isLegacy: boolean;
+    txData: string;
+  }
+};
+
+
+export type CompoundV3CompClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.COMPOUND_V3_COMP,
+  additionalClaimFields: {
+    marketAddress: EthAddress;
+  }
+};
+
+export enum SparkAirdropType {
+  SPARK_IGNITION = 'spark-ignition',
+  PRE_FARMING_AND_SOCIAL = 'pre-farming-and-social',
+}
+
+export type SparkAirdropClaimableToken = _ClaimableTokenPartial & {
+  claimType: ClaimType.SPARK_AIRDROP,
+  additionalClaimFields: {
+    merkleRoot: string;
+    merkleProofs: string[];
+    epoch: number;
+    rewardType: SparkAirdropType;
+    allRewardsAmount: string;
+  };
+};
+
+export type SparkWstEthRewardsClaimableToken = _ClaimableTokenPartial & { claimType: ClaimType.SPARK_WST_ETH_REWARDS };
+
+export type ClaimableToken =
+    AaveRewardsClaimableToken
+    | AaveMeritRewardsClaimableToken
+    | CompoundV3CompClaimableToken
+    | MorphoClaimableToken
+    | SparkRewardsClaimableToken
+    | KingRewardsClaimableToken
+    | SparkAirdropClaimableToken
+    | SparkWstEthRewardsClaimableToken;

package/src/types/common.ts

@@ -1,88 +1,88 @@
-// General
-export type EthAddress = HexString;
-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,
-  Linea = 59144,
-}
-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,
-  stableBorrowRate?: string,
-  debt?: string,
-  supplyRate?: string,
-  borrowRate?: 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,
-}
-
-export type EthereumProvider = { request(...args: any): Promise<any> }; // TODO
-
-export type HexString = `0x${string}`;
+// General
+export type EthAddress = HexString;
+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,
+  Linea = 59144,
+}
+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,
+  stableBorrowRate?: string,
+  debt?: string,
+  supplyRate?: string,
+  borrowRate?: 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,
+}
+
+export type EthereumProvider = { request(...args: any): Promise<any> }; // TODO
+
+export type HexString = `0x${string}`;