Feat/staked gho sm

README.md

@@ -2640,4 +2640,4 @@ welcome();
 
 ```
 
-</details>
+</details>

jest.config.js

@@ -40,7 +40,8 @@ module.exports = {
     'packages/contract-helpers/src/lendingPool-contract/typechain',
     'packages/contract-helpers/src/v3-migration-contract/typechain',
     'packages/contract-helpers/src/index.ts',
-    'packages/math-utils/src/formatters/reserve/index.ts', // TODO: remove
+    'packages/math-utils/src/formatters/reserve/index.ts',
+    'packages/contract-helpers/src/V3-uiStakeDataProvider-contract/index.ts',
   ],
   modulePathIgnorePatterns: ['node_modules'],
   testEnvironment: 'node',

packages/contract-helpers/src/V3-uiStakeDataProvider-contract/_mocks.ts

@@ -0,0 +1,185 @@
+/* istanbul ignore file */
+import { BigNumber } from 'ethers';
+
+export const GeneralStakeUIDataHumanized = {
+  stakeData: [
+    {
+      inPostSlashingPeriod: false,
+      stakeTokenTotalSupply: '0',
+      stakeTokenTotalRedeemableAmount: '0',
+      stakeCooldownSeconds: 0,
+      stakeUnstakeWindow: 0,
+      stakeTokenPriceUSD: '0',
+      rewardTokenPriceUSD: '0',
+      stakeApy: '0',
+      distributionPerSecond: '0',
+      distributionEnd: '0',
+    },
+  ],
+  ethPriceUsd: '0',
+};
+
+export const GetUserStakeUIDataHumanized = {
+  stakeUserData: [
+    {
+      stakeTokenUserBalance: '0',
+      underlyingTokenUserBalance: '0',
+      stakeTokenRedeemableAmount: '0',
+      userCooldownAmount: '0',
+      userCooldownTimestamp: 0,
+      userIncentivesToClaim: '0',
+    },
+  ],
+  ethPriceUsd: '0',
+};
+
+export const stakedUserDataRaw = [
+  [{}],
+  [
+    {
+      stakedTokenUserBalance: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      underlyingTokenUserBalance: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      stakedTokenRedeemableAmount: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      userCooldownAmount: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      userIncentivesToClaim: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      userCooldownTimestamp: 0,
+      rewardsToClaim: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      0: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      1: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      2: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      3: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      4: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      5: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      // 6: BigNumber.from({
+      //   _hex: '0x0',
+      //   _isBigNumber: true,
+      // }),
+      // 7: 0,
+      // 8: BigNumber.from({
+      //   _hex: '0x0',
+      //   _isBigNumber: true,
+      // }),
+    },
+  ],
+];
+
+export const mockStakedData = [
+  [
+    {
+      stakedTokenTotalSupply: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      stakedTokenTotalRedeemableAmount: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      stakeCooldownSeconds: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      stakeUnstakeWindow: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      stakedTokenPriceUsd: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      rewardTokenPriceUsd: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      stakeApy: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      distributionPerSecond: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      distributionEnd: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      0: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      1: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      2: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      3: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      4: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      5: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      6: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      7: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+      8: BigNumber.from({
+        _hex: '0x0',
+        _isBigNumber: true,
+      }),
+    },
+  ],
+  [
+    BigNumber.from({
+      _hex: '0x0',
+      _isBigNumber: true,
+    }),
+  ],
+];

packages/contract-helpers/src/V3-uiStakeDataProvider-contract/index.ts

@@ -0,0 +1,115 @@
+/* istanbul ignore file */
+import { providers } from 'ethers';
+
+import { Abi as IStakedTokenDataProvider } from './typechain/Abi';
+import { Abi__factory } from './typechain/factories/Abi__factory';
+
+import {
+  StakedTokenData,
+  GeneralStakeUIDataHumanized,
+  StakedContractUserData,
+  GetUserStakeUIDataHumanized,
+} from './types';
+
+type EthAddress = string;
+
+export interface UiStakeDataProviderInterfaceV3 {
+  getStakedAssetDataBatch: (
+    stakedAssets: EthAddress[],
+    oracles: EthAddress[],
+  ) => Promise<GeneralStakeUIDataHumanized>;
+  getUserStakeUIDataHumanized: (params: {
+    user: string;
+    stakedAssets: EthAddress[];
+    oracles: EthAddress[];
+  }) => Promise<GetUserStakeUIDataHumanized>;
+}
+
+export type UiStakeDataProviderContext = {
+  uiStakeDataProvider: string;
+  provider: providers.Provider;
+};
+
+export class UiStakeDataProviderV3 implements UiStakeDataProviderInterfaceV3 {
+  private readonly _contract: IStakedTokenDataProvider;
+
+  public constructor(context: UiStakeDataProviderContext) {
+    this._contract = Abi__factory.connect(
+      context.uiStakeDataProvider,
+      context.provider,
+    );
+  }
+
+  public async getUserStakeUIDataHumanized({
+    user,
+    stakedAssets,
+    oracles,
+  }: {
+    user: string;
+    stakedAssets: EthAddress[];
+    oracles: EthAddress[];
+  }): Promise<GetUserStakeUIDataHumanized> {
+    const [, stakedUserData] = await this._contract.getStakedUserDataBatch(
+      stakedAssets,
+      oracles,
+      user,
+    );
+
+    // // NOTE only fetching eth price here, should we call oracle directly?
+    const [, ethPrice] = await this._contract.getStakedAssetDataBatch(
+      stakedAssets,
+      oracles,
+    );
+
+    const parsedUserStakedData = handleUserStakedData(stakedUserData);
+
+    return {
+      stakeUserData: parsedUserStakedData,
+      ethPriceUsd: ethPrice.toString(),
+    };
+  }
+
+  public async getStakedAssetDataBatch(
+    stakedAssets: EthAddress[],
+    oracles: EthAddress[],
+  ): Promise<GeneralStakeUIDataHumanized> {
+    const [stakedData, ethPrice] = await this._contract.getStakedAssetDataBatch(
+      stakedAssets,
+      oracles,
+    );
+
+    const parsedStakedData = handleParsedStakedData(stakedData);
+    return { stakeData: parsedStakedData, ethPriceUsd: ethPrice.toString() };
+  }
+}
+
+function handleUserStakedData(stakeUserData: StakedContractUserData[]) {
+  return stakeUserData.map((data: StakedContractUserData) => {
+    return {
+      stakeTokenUserBalance: data.stakedTokenUserBalance.toString(),
+      underlyingTokenUserBalance: data.underlyingTokenUserBalance.toString(),
+      stakeTokenRedeemableAmount: data.stakedTokenRedeemableAmount.toString(),
+      userCooldownAmount: data.userCooldownAmount.toString(),
+      userCooldownTimestamp: data.userCooldownTimestamp,
+      userIncentivesToClaim: data.rewardsToClaim.toString(),
+    };
+  });
+}
+
+function handleParsedStakedData(stakedData: StakedTokenData[]) {
+  return stakedData.map((data: StakedTokenData) => {
+    return {
+      inPostSlashingPeriod: data.inPostSlashingPeriod || false,
+      stakeTokenTotalSupply: data.stakedTokenTotalSupply.toString(),
+      stakeTokenTotalRedeemableAmount:
+        data.stakedTokenTotalRedeemableAmount.toString(),
+      stakeCooldownSeconds: data.stakeCooldownSeconds.toNumber(),
+      stakeUnstakeWindow: data.stakeUnstakeWindow.toNumber(),
+      stakeTokenPriceUSD: data.stakedTokenPriceUsd.toString(),
+      rewardTokenPriceUSD: data.rewardTokenPriceUsd.toString(),
+      stakeApy: data.stakeApy.toString(),
+      distributionPerSecond: data.distributionPerSecond.toString(),
+      distributionEnd: data.distributionEnd.toString(),
+    };
+  });
+}