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

package/src/types/spark.ts

@@ -1,137 +1,137 @@
-import {
-  EthAddress,
-  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
-} from './common';
-import { IncentiveData } from './aave';
-
-export enum SparkVersions {
-  SparkV1 = 'v1default',
-}
-
-export interface SparkEModeCategoryData {
-  label: string,
-  liquidationBonus: string,
-  liquidationRatio: string,
-  collateralFactor: string,
-  priceSource: string,
-}
-
-export interface SparkEModeCategoryDataMapping {
-  enteringTerms: boolean[],
-  canEnterCategory: boolean,
-  id: number,
-  data: SparkEModeCategoryData,
-  assets: string[],
-  enabledData: {
-    ratio: string,
-    liqRatio: string,
-    liqPercent: string,
-    collRatio: string,
-  }
-}
-
-export interface SparkMarketData {
-  chainIds: NetworkNumber[],
-  label: string,
-  shortLabel: string,
-  url: string,
-  value: SparkVersions,
-  assets: readonly string[],
-  provider: '' | 'SparkPoolAddressesProvider',
-  providerAddress: EthAddress,
-  lendingPool: 'SparkLendingPool',
-  lendingPoolAddress: EthAddress,
-  protocolData: '' | 'SparkProtocolDataProvider',
-  protocolDataAddress: EthAddress,
-  subVersionLabel?: string
-  // icon: Function,
-  protocolName: string,
-  disabled?: boolean,
-}
-
-export interface SparkAssetData extends MMAssetData {
-  totalBorrowVar: string,
-  sortIndex?: number,
-  usageAsCollateralEnabled: boolean,
-  isIsolated: boolean,
-  eModeCategory: number,
-  eModeCategoryData: SparkEModeCategoryData,
-  liquidationRatio: string,
-  supplyIncentives?: IncentiveData[];
-  borrowIncentives?: IncentiveData[];
-}
-
-export interface SparkAssetsData {
-  [token: string]: SparkAssetData,
-}
-
-export type SparkMarketsData = { assetsData: SparkAssetsData };
-
-export interface SparkUsedAsset extends MMUsedAsset {
-  stableBorrowRate: string,
-  borrowedStable: string,
-  borrowedVariable: string,
-  borrowedUsdStable: string,
-  borrowedUsdVariable: string,
-  stableLimit: string,
-  variableLimit: string,
-  limit: string,
-  eModeCategory: number,
-}
-
-export interface SparkUsedAssets {
-  [token: string]: SparkUsedAsset,
-}
-
-export interface SparkHelperCommon {
-  usedAssets: SparkUsedAssets,
-  eModeCategory: number,
-  eModeCategories?: object,
-  assetsData: SparkAssetsData,
-  selectedMarket?: SparkMarketData,
-  network?: NetworkNumber,
-}
-
-export interface SparkAggregatedPositionData {
-  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 SparkPositionData 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,
-  usedAssets: SparkUsedAssets,
-  eModeCategory: number,
-  isInIsolationMode: boolean,
-  isInSiloedMode: boolean,
-  eModeCategories: { [key: number]: SparkEModeCategoryDataMapping },
-}
+import {
+  EthAddress,
+  MMAssetData, MMPositionData, MMUsedAsset, NetworkNumber,
+} from './common';
+import { IncentiveData } from './aave';
+
+export enum SparkVersions {
+  SparkV1 = 'v1default',
+}
+
+export interface SparkEModeCategoryData {
+  label: string,
+  liquidationBonus: string,
+  liquidationRatio: string,
+  collateralFactor: string,
+  priceSource: string,
+}
+
+export interface SparkEModeCategoryDataMapping {
+  enteringTerms: boolean[],
+  canEnterCategory: boolean,
+  id: number,
+  data: SparkEModeCategoryData,
+  assets: string[],
+  enabledData: {
+    ratio: string,
+    liqRatio: string,
+    liqPercent: string,
+    collRatio: string,
+  }
+}
+
+export interface SparkMarketData {
+  chainIds: NetworkNumber[],
+  label: string,
+  shortLabel: string,
+  url: string,
+  value: SparkVersions,
+  assets: readonly string[],
+  provider: '' | 'SparkPoolAddressesProvider',
+  providerAddress: EthAddress,
+  lendingPool: 'SparkLendingPool',
+  lendingPoolAddress: EthAddress,
+  protocolData: '' | 'SparkProtocolDataProvider',
+  protocolDataAddress: EthAddress,
+  subVersionLabel?: string
+  // icon: Function,
+  protocolName: string,
+  disabled?: boolean,
+}
+
+export interface SparkAssetData extends MMAssetData {
+  totalBorrowVar: string,
+  sortIndex?: number,
+  usageAsCollateralEnabled: boolean,
+  isIsolated: boolean,
+  eModeCategory: number,
+  eModeCategoryData: SparkEModeCategoryData,
+  liquidationRatio: string,
+  supplyIncentives?: IncentiveData[];
+  borrowIncentives?: IncentiveData[];
+}
+
+export interface SparkAssetsData {
+  [token: string]: SparkAssetData,
+}
+
+export type SparkMarketsData = { assetsData: SparkAssetsData };
+
+export interface SparkUsedAsset extends MMUsedAsset {
+  stableBorrowRate: string,
+  borrowedStable: string,
+  borrowedVariable: string,
+  borrowedUsdStable: string,
+  borrowedUsdVariable: string,
+  stableLimit: string,
+  variableLimit: string,
+  limit: string,
+  eModeCategory: number,
+}
+
+export interface SparkUsedAssets {
+  [token: string]: SparkUsedAsset,
+}
+
+export interface SparkHelperCommon {
+  usedAssets: SparkUsedAssets,
+  eModeCategory: number,
+  eModeCategories?: object,
+  assetsData: SparkAssetsData,
+  selectedMarket?: SparkMarketData,
+  network?: NetworkNumber,
+}
+
+export interface SparkAggregatedPositionData {
+  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 SparkPositionData 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,
+  usedAssets: SparkUsedAssets,
+  eModeCategory: number,
+  isInIsolationMode: boolean,
+  isInSiloedMode: boolean,
+  eModeCategories: { [key: number]: SparkEModeCategoryDataMapping },
+}

package/src/umbrella/index.ts

@@ -0,0 +1,70 @@
+import { Client } from 'viem';
+import { AaveUmbrellaViewViem, AaveV3ViewContractViem } from '../contracts';
+import { EthAddress, NetworkNumber } from '../types/common';
+import { compareAddresses, convertHybridArraysToObjects, getEthAmountForDecimals } from '../services/utils';
+import { findMatching, tokenEntries } from './umbrellaUtils';
+
+const umbrella = '0xD400fc38ED4732893174325693a63C30ee3881a8';
+const aaveOracle = '0x54586bE62E3c3580375aE3723C145253060Ca0C2';
+
+export const getUmbrellaData = async (provider: Client, network: NetworkNumber, address: EthAddress) => {
+  const umbrellaView = AaveUmbrellaViewViem(provider, network);
+  const aaveV3View = AaveV3ViewContractViem(provider, network);
+  const [tokensAggregatedData, additionalUmbrellaStakingData, userAggregatedData] = await Promise.all([
+    umbrellaView.read.getTokensAggregatedData([umbrella, aaveOracle]),
+    aaveV3View.read.getAdditionalUmbrellaStakingData([umbrella, address]),
+    umbrellaView.read.getUserAggregatedData([umbrella, address]),
+  ]);
+
+  return Object.fromEntries(
+    tokenEntries.map(([symbol, tokenAddr]) => {
+      // @ts-ignore
+      const fromTokens = convertHybridArraysToObjects(findMatching(tokensAggregatedData, tokenAddr));
+      // @ts-ignore
+      const fromUser = convertHybridArraysToObjects(findMatching(userAggregatedData, tokenAddr));
+      // @ts-ignore
+      const fromAdditionalData = convertHybridArraysToObjects(findMatching(additionalUmbrellaStakingData, tokenAddr));
+      const data = {
+        ...fromTokens,
+        ...fromUser,
+        ...fromAdditionalData,
+        account: {
+          stakeUserBalance: fromUser?.stakeUserBalance || '0',
+          rewardsTokenUserData: convertHybridArraysToObjects(fromUser?.rewardsTokenUserData) || [],
+          userCooldownAmount: fromAdditionalData?.userCooldownAmount || '0',
+          userEndOfCooldown: fromAdditionalData?.userEndOfCooldown || '0',
+          userWithdrawalWindow: fromAdditionalData?.userWithdrawalWindow || '0',
+        },
+      };
+
+      const stakeTokenData = data.stakeTokenData;
+
+      return [symbol, {
+        ...data,
+        stakeTokenData: { ...stakeTokenData, price: getEthAmountForDecimals(stakeTokenData.price, 8) },
+        stkTokenToWaTokenRate: getEthAmountForDecimals(data.stkTokenToWaTokenRate, stakeTokenData.decimals),
+        waTokenToATokenRate: getEthAmountForDecimals(data.waTokenToATokenRate, stakeTokenData.decimals),
+        totalShares: getEthAmountForDecimals(data.totalShares, stakeTokenData.decimals),
+        totalAssets: getEthAmountForDecimals(data.totalAssets, stakeTokenData.decimals),
+        targetLiquidity: getEthAmountForDecimals(data.targetLiquidity, stakeTokenData.decimals),
+        rewardsTokenData: data.rewardsTokenData.map((tokenData: { rewardTokenData: { price: string | number; }; }) => ({ ...tokenData, rewardTokenData: { ...tokenData.rewardTokenData, price: getEthAmountForDecimals(tokenData.rewardTokenData.price, 8) } })),
+        rewardsEmissionRates: data.rewardsEmissionRates.map((rate: string, i: number) => {
+          const tokenData = data.rewardsTokenData[i].rewardTokenData;
+          return getEthAmountForDecimals(rate, tokenData.decimals);
+        }),
+        account: {
+          ...data.account,
+          stakeUserBalance: getEthAmountForDecimals(data.account.stakeUserBalance, stakeTokenData.decimals),
+          userCooldownAmount: getEthAmountForDecimals(data.account.userCooldownAmount, stakeTokenData.decimals),
+          rewardsTokenUserData: data.account.rewardsTokenUserData.map((reward: any) => {
+            const tokenData = data.rewardsTokenData.find((tknData: { rewardTokenData: { token: string | undefined; }; }) => compareAddresses(tknData.rewardTokenData.token, reward.reward));
+            return ({
+              ...reward,
+              currentReward: getEthAmountForDecimals(reward.currentReward, tokenData.rewardTokenData.decimals),
+            });
+          }),
+        },
+      }];
+    }),
+  );
+};

package/src/umbrella/umbrellaUtils.ts

@@ -0,0 +1,30 @@
+export enum UmbrellaStaking {
+  UmbrellaGHO = 'UmbrellaGHO',
+  UmbrellaUSDC = 'UmbrellaUSDC',
+  UmbrellaUSDT = 'UmbrellaUSDT',
+  UmbrellaETH = 'UmbrellaETH',
+}
+
+export const tokenMapping = {
+  [UmbrellaStaking.UmbrellaUSDC]: '0x6bf183243FdD1e306ad2C4450BC7dcf6f0bf8Aa6',
+  [UmbrellaStaking.UmbrellaUSDT]: '0xA484Ab92fe32B143AEE7019fC1502b1dAA522D31',
+  [UmbrellaStaking.UmbrellaETH]: '0xaAFD07D53A7365D3e9fb6F3a3B09EC19676B73Ce',
+  [UmbrellaStaking.UmbrellaGHO]: '0x4f827A63755855cDf3e8f3bcD20265C833f15033',
+} as const;
+
+// ----- chat gpt code for result mapping ---------
+export const normalize = (addr?: string) => addr?.toLowerCase?.() ?? '';
+
+export const tokenEntries = Object.entries(tokenMapping).map(([symbol, address]) => [
+  symbol,
+  normalize(address),
+]);
+
+// 👇 Define how to extract the token address from each source type
+export const extractAddress = (item?: { stakeToken?: string, stkToken?: string, stakeTokenData?: { token?: string } }): string => normalize(item?.stakeToken
+        || item?.stkToken
+        || item?.stakeTokenData?.token,
+);
+
+// 👇 Utility to find the matching object in a dataset
+export const findMatching = (dataset: any[], targetAddr: string) => dataset.find((item) => extractAddress(item) === targetAddr);