feat: add getAccountHistoricalTransactions

Author: gleiser-oliveira

apps/evm/src/clients/api/index.ts

@@ -231,3 +231,6 @@ export * from './queries/getImportablePositions/useGetImportablePositions';
 
 export * from './queries/getAccountPerformanceHistory';
 export * from './queries/getAccountPerformanceHistory/useGetAccountPerformanceHistory';
+
+export * from './queries/getAccountTransactionHistory';
+export * from './queries/getAccountTransactionHistory/useGetAccountTransactionHistory';

apps/evm/src/clients/api/queries/getAccountTransactionHistory/formatApiTransaction.ts

@@ -0,0 +1,64 @@
+import type { Token } from 'types';
+import {
+  convertDollarsToCents,
+  convertMantissaToTokens,
+  convertPriceMantissaToDollars,
+} from 'utilities';
+import type { Address } from 'viem';
+import type { AmountTransaction, ApiAccountHistoricalTransaction } from './types';
+
+export const formatApiTransaction = ({
+  contractToTokenMap,
+  apiTransaction,
+}: {
+  contractToTokenMap: Record<
+    Address,
+    {
+      token: Token;
+      poolName: string;
+    }
+  >;
+  apiTransaction: ApiAccountHistoricalTransaction;
+}): AmountTransaction => {
+  const {
+    txType,
+    txHash: hash,
+    txTimestamp,
+    blockNumber,
+    accountAddress,
+    contractAddress,
+    chainId,
+    amountUnderlyingMantissa,
+    underlyingTokenPriceMantissa,
+  } = apiTransaction;
+  const { poolName, token } = contractToTokenMap[contractAddress];
+  const tokenPriceDollars = underlyingTokenPriceMantissa
+    ? convertPriceMantissaToDollars({
+        priceMantissa: underlyingTokenPriceMantissa,
+        decimals: token.decimals,
+      })
+    : undefined;
+  const tokenPriceCents = tokenPriceDollars ? convertDollarsToCents(tokenPriceDollars) : undefined;
+  const amountTokens = amountUnderlyingMantissa
+    ? convertMantissaToTokens({
+        value: BigInt(amountUnderlyingMantissa),
+        token: token,
+      })
+    : undefined;
+  const amountCents =
+    amountTokens && tokenPriceCents ? amountTokens.multipliedBy(tokenPriceCents) : undefined;
+
+  return {
+    txType,
+    hash,
+    blockTimestamp: txTimestamp,
+    blockNumber,
+    accountAddress,
+    contractAddress,
+    chainId,
+    poolName,
+    amountTokens,
+    amountCents,
+    token,
+  };
+};

apps/evm/src/clients/api/queries/getAccountTransactionHistory/index.ts

@@ -0,0 +1,79 @@
+import { VError } from 'libs/errors';
+import type { Token } from 'types';
+import { restService } from 'utilities';
+import { type Address, isAddress } from 'viem';
+import { formatApiTransaction } from './formatApiTransaction';
+import type {
+  AccountTransactionHistoryApiResponse,
+  GetAccountTransactionHistoryInput,
+  GetAccountTransactionHistoryOutput,
+} from './types';
+
+export * from './types';
+
+export const getAccountTransactionHistory = async ({
+  chainId,
+  accountAddress,
+  contractAddress,
+  getPoolsData,
+  type,
+  page,
+}: GetAccountTransactionHistoryInput): Promise<GetAccountTransactionHistoryOutput> => {
+  const txsResponse = await restService<AccountTransactionHistoryApiResponse>({
+    endpoint: `/account/${accountAddress}/transactions`,
+    method: 'GET',
+    params: {
+      chainId,
+      type,
+      contractAddress: isAddress(contractAddress) ? contractAddress : undefined,
+      page,
+    },
+  });
+
+  if (txsResponse.data && 'error' in txsResponse.data) {
+    throw new VError({
+      type: 'unexpected',
+      code: 'somethingWentWrong',
+      data: { message: txsResponse.data.error },
+    });
+  }
+
+  if (!txsResponse.data) {
+    throw new VError({ type: 'unexpected', code: 'somethingWentWrong' });
+  }
+
+  const allAssets =
+    getPoolsData?.pools.flatMap(p =>
+      p.assets.map(a => ({
+        ...a,
+        poolName: p.name,
+      })),
+    ) || [];
+
+  const contractToTokenMap = allAssets.reduce<Record<Address, { token: Token; poolName: string }>>(
+    (acc, a) => {
+      const { poolName, vToken } = a;
+
+      return {
+        ...acc,
+        [vToken.address.toLowerCase()]: {
+          poolName,
+          token: vToken.underlyingToken,
+        },
+      };
+    },
+    {},
+  );
+
+  const formattedResponse = txsResponse.data.results.map(apiTransaction =>
+    formatApiTransaction({
+      contractToTokenMap,
+      apiTransaction,
+    }),
+  );
+
+  return {
+    count: Number(txsResponse.data.count),
+    transactions: formattedResponse,
+  };
+};

apps/evm/src/clients/api/queries/getAccountTransactionHistory/types.ts

@@ -0,0 +1,63 @@
+import type { ChainId } from '@venusprotocol/chains';
+import type { Token } from 'types';
+import type { Address } from 'viem';
+import type { GetPoolsOutput } from '../useGetPools/types';
+
+export enum TxType {
+  Mint = 'mint',
+  Borrow = 'borrow',
+  Redeem = 'redeem',
+  Repay = 'repay',
+  EnterMarket = 'enter_market',
+  ExitMarket = 'exit_market',
+  Approve = 'approve',
+}
+
+export interface ApiAccountHistoricalTransaction {
+  id: string;
+  txHash: string;
+  txIndex: number;
+  txTimestamp: Date;
+  blockNumber: string;
+  txType: TxType;
+  accountAddress: Address;
+  contractAddress: Address;
+  amountVTokenMantissa: string | null;
+  amountUnderlyingMantissa: string | null;
+  underlyingAddress: string;
+  underlyingTokenPriceMantissa: string | null;
+  chainId: ChainId;
+}
+
+export interface AmountTransaction {
+  txType: TxType;
+  hash: string;
+  blockTimestamp: Date;
+  blockNumber: string;
+  accountAddress: string;
+  contractAddress: string;
+  chainId: ChainId;
+  poolName: string;
+  amountTokens: BigNumber | undefined;
+  amountCents: BigNumber | undefined;
+  token: Token;
+}
+
+export interface AccountTransactionHistoryApiResponse {
+  count: number;
+  results: ApiAccountHistoricalTransaction[];
+}
+
+export interface GetAccountTransactionHistoryInput {
+  accountAddress: string;
+  contractAddress: string;
+  chainId: ChainId;
+  getPoolsData: GetPoolsOutput | undefined;
+  type?: number;
+  page?: number;
+}
+
+export type GetAccountTransactionHistoryOutput = {
+  count: number;
+  transactions: AmountTransaction[];
+};

apps/evm/src/clients/api/queries/getAccountTransactionHistory/useGetAccountTransactionHistory.ts

@@ -0,0 +1,42 @@
+import { type QueryObserverOptions, useQuery } from '@tanstack/react-query';
+
+import FunctionKey from 'constants/functionKey';
+import { useChainId } from 'libs/wallet';
+import {
+  type GetAccountTransactionHistoryInput,
+  type GetAccountTransactionHistoryOutput,
+  getAccountTransactionHistory,
+} from '.';
+import { useGetPools } from '../useGetPools';
+
+type TrimmedGetAccountTransactionHistoryInput = Omit<
+  GetAccountTransactionHistoryInput,
+  'chainId' | 'getPoolsData'
+>;
+
+type Options = QueryObserverOptions<
+  GetAccountTransactionHistoryOutput,
+  Error,
+  GetAccountTransactionHistoryOutput,
+  GetAccountTransactionHistoryOutput,
+  [FunctionKey.GET_ACCOUNT_HISTORICAL_TRANSACTIONS, TrimmedGetAccountTransactionHistoryInput]
+>;
+
+export const useGetAccountTransactionHistory = (
+  params: TrimmedGetAccountTransactionHistoryInput,
+  options?: Partial<Options>,
+) => {
+  const { chainId } = useChainId();
+  const { data: getPoolsData } = useGetPools();
+  const extendedParams = {
+    ...params,
+    getPoolsData,
+    chainId,
+  };
+
+  return useQuery({
+    queryKey: [FunctionKey.GET_ACCOUNT_HISTORICAL_TRANSACTIONS, params],
+    queryFn: () => getAccountTransactionHistory(extendedParams),
+    ...options,
+  });
+};

apps/evm/src/constants/functionKey.ts

@@ -69,6 +69,7 @@ enum FunctionKey {
   GET_IMPORTABLE_POSITIONS = 'GET_IMPORTABLE_POSITIONS',
   GET_ACCOUNT_PERFORMANCE_HISTORY = 'GET_ACCOUNT_PERFORMANCE_HISTORY',
   GET_ENABLED_E_MODE_GROUP = 'GET_ENABLED_E_MODE_GROUP',
+  GET_ACCOUNT_HISTORICAL_TRANSACTIONS = 'GET_ACCOUNT_HISTORICAL_TRANSACTIONS',
 }
 
 export default FunctionKey;