fix(suite): add staking to the total balance

Author: dev-pvl

packages/suite/src/components/wallet/WalletLayout/AccountsMenu/AccountItemsGroup.tsx

@@ -4,7 +4,7 @@ import { Account } from 'src/types/wallet';
 import { borders, spacingsPx } from '@trezor/theme';
 import { useSelector } from 'src/hooks/suite';
 import { selectCurrentFiatRates } from '@suite-common/wallet-core';
-import { getAccountAutocompoundBalance, getTokensFiatBalance } from '@suite-common/wallet-utils';
+import { getAccountTotalStakingBalance, getTokensFiatBalance } from '@suite-common/wallet-utils';
 import { selectLocalCurrency } from 'src/reducers/wallet/settingsReducer';
 import { selectRouteName } from 'src/reducers/suite/routerReducer';
 
@@ -52,7 +52,7 @@ export const AccountItemsGroup = ({
     tokens,
     dataTestKey,
 }: AccountItemsGroupProps) => {
-    const autocompoundBalance = getAccountAutocompoundBalance(account);
+    const stakingBalance = getAccountTotalStakingBalance(account);
 
     const routeName = useSelector(selectRouteName);
     const localCurrency = useSelector(selectLocalCurrency);
@@ -85,7 +85,7 @@ export const AccountItemsGroup = ({
                         account={account}
                         type="staking"
                         isSelected={selected && routeName === 'wallet-staking'}
-                        formattedBalance={autocompoundBalance}
+                        formattedBalance={stakingBalance}
                         isGroup
                         isGroupSelected={selected}
                     />

packages/suite/src/views/dashboard/components/PortfolioCard/index.tsx

@@ -46,15 +46,15 @@ const Wrapper = styled.div`
 `;
 
 const PortfolioCard = memo(() => {
-    const currentRiatRates = useSelector(selectCurrentFiatRates);
+    const currentFiatRates = useSelector(selectCurrentFiatRates);
     const localCurrency = useSelector(selectLocalCurrency);
     const { discovery, getDiscoveryStatus, isDiscoveryRunning } = useDiscovery();
     const accounts = useFastAccounts();
     const { dashboardGraphHidden } = useSelector(s => s.suite.flags);
     const dispatch = useDispatch();
 
     const isDeviceEmpty = useMemo(() => accounts.every(a => a.empty), [accounts]);
-    const fiatAmount = getTotalFiatBalance(accounts, localCurrency, currentRiatRates).toString();
+    const fiatAmount = getTotalFiatBalance(accounts, localCurrency, currentFiatRates).toString();
 
     const discoveryStatus = getDiscoveryStatus();
 

suite-common/wallet-utils/src/__fixtures__/stakingUtils.ts

@@ -143,3 +143,73 @@ export const getAccountAutocompoundBalanceFixtures = [
         expectedBalance: '0',
     },
 ];
+
+export const getAccountTotalStakingBalanceFixtures = [
+    {
+        description: 'Ethereum account with valid Everstake pool',
+        account: {
+            networkType: 'ethereum',
+            misc: {
+                stakingPools: [
+                    {
+                        name: 'Everstake',
+                        autocompoundBalance: '1000000000000000000', // 1 Ether in wei
+                        claimableAmount: '500000000000000000', // 0.5 Ether in wei
+                        depositedBalance: '3000000000000000000', // 3 Ether in wei
+                        pendingBalance: '100000000000000000', // 0.1 Ether in wei
+                        pendingDepositedBalance: '200000000000000000', // 0.2 Ether in wei
+                        restakedReward: '150000000000000000', // 0.15 Ether in wei
+                        withdrawTotalAmount: '500000000000000000', // 0.5 Ether in wei
+                    },
+                ],
+            },
+        },
+        expectedBalance: '1.8', // 1 + 0.1 + 0.2 + 0.5 Ether
+    },
+    {
+        description: 'Ethereum account with zero balances',
+        account: {
+            networkType: 'ethereum',
+            misc: {
+                stakingPools: [
+                    {
+                        name: 'Everstake',
+                        autocompoundBalance: '0',
+                        claimableAmount: '0',
+                        depositedBalance: '0',
+                        pendingBalance: '0',
+                        pendingDepositedBalance: '0',
+                        restakedReward: '0',
+                        withdrawTotalAmount: '0',
+                    },
+                ],
+            },
+        },
+        expectedBalance: '0',
+    },
+    {
+        description: 'Ethereum account without Everstake pool',
+        account: {
+            networkType: 'ethereum',
+            misc: {
+                stakingPools: [],
+            },
+        },
+        expectedBalance: '0',
+    },
+    {
+        description: 'Non-Ethereum network with Everstake pool',
+        account: {
+            networkType: 'bitcoin',
+            misc: {
+                stakingPools: [
+                    {
+                        name: 'Everstake',
+                        autocompoundBalance: '1000000000000000000',
+                    },
+                ],
+            },
+        },
+        expectedBalance: '0',
+    },
+];

suite-common/wallet-utils/src/__tests__/stakingUtils.test.ts

@@ -1,9 +1,14 @@
 import { Account } from '@suite-common/wallet-types';
 
-import { getAccountAutocompoundBalance, getAccountEverstakeStakingPool } from '../stakingUtils';
+import {
+    getAccountAutocompoundBalance,
+    getAccountTotalStakingBalance,
+    getAccountEverstakeStakingPool,
+} from '../stakingUtils';
 import {
     getAccountAutocompoundBalanceFixtures,
     getAccountEverstakeStakingPoolFixtures,
+    getAccountTotalStakingBalanceFixtures,
 } from '../__fixtures__/stakingUtils';
 
 describe('getAccountEverstakeStakingPool', () => {
@@ -23,3 +28,12 @@ describe('getAccountAutocompoundBalance', () => {
         });
     });
 });
+
+describe('getAccountTotalStakingBalance', () => {
+    getAccountTotalStakingBalanceFixtures.forEach(({ description, account, expectedBalance }) => {
+        it(description, () => {
+            const result = getAccountTotalStakingBalance(account as unknown as Account);
+            expect(result).toEqual(expectedBalance);
+        });
+    });
+});

suite-common/wallet-utils/src/accountUtils.ts

@@ -36,6 +36,7 @@ import {
 
 import { toFiatCurrency } from './fiatConverterUtils';
 import { getFiatRateKey } from './fiatRatesUtils';
+import { getAccountTotalStakingBalance } from './stakingUtils';
 
 export const isEthereumAccountSymbol = (symbol: NetworkSymbol) => symbol === 'eth';
 
@@ -590,6 +591,12 @@ export const getTokensFiatBalance = (
     return totalBalance.toFixed();
 };
 
+export const getStakingFiatBalance = (account: Account, rate: number | undefined) => {
+    const balanceInEther = getAccountTotalStakingBalance(account);
+
+    return toFiatCurrency(balanceInEther, rate, 2);
+};
+
 export const getAccountFiatBalance = (
     account: Account,
     localCurrency: string,
@@ -600,6 +607,7 @@ export const getAccountFiatBalance = (
         localCurrency as FiatCurrencyCode,
     );
     const coinFiatRate = rates?.[coinFiatRateKey];
+
     if (!coinFiatRate?.rate) return null;
 
     let totalBalance = new BigNumber(0);
@@ -610,8 +618,12 @@ export const getAccountFiatBalance = (
     // sum fiat value of all tokens
     const tokensBalance = getTokensFiatBalance(account, localCurrency, rates, account.tokens);
 
+    // account staking balance
+    const stakingBalance = getStakingFiatBalance(account, coinFiatRate.rate);
+
     totalBalance = totalBalance.plus(accountBalance ?? 0);
     totalBalance = totalBalance.plus(tokensBalance ?? 0);
+    totalBalance = totalBalance.plus(stakingBalance ?? 0);
 
     return totalBalance.toFixed();
 };

suite-common/wallet-utils/src/stakingUtils.ts

@@ -42,3 +42,13 @@ export const getAccountAutocompoundBalance = (account?: Account) => {
 
     return pool?.autocompoundBalance ?? '0';
 };
+
+export const getAccountTotalStakingBalance = (account?: Account) => {
+    const pool = getAccountEverstakeStakingPool(account);
+
+    return new BigNumber(pool?.autocompoundBalance ?? '0')
+        .plus(pool?.pendingBalance ?? '0')
+        .plus(pool?.pendingDepositedBalance ?? '0')
+        .plus(pool?.withdrawTotalAmount ?? '0')
+        .toFixed();
+};