changed token balances hooks to optionally remove 0 balance native tokens

Author: andrewlee348

packages/hooks/README.md

@@ -180,7 +180,7 @@ const { data, isLoading, error } = useGetTokenBalancesSummary(
     networks: ['mainnet'],
     filter: {
       accountAddresses: ['0x0123456789012345678901234567890123456789'],
-      contractWhitelist: ['0x0123456789012345678901234567890123456789'],
+      contractWhitelist: ['0x0123456789012345678901234567890123456789'], // If zeroAddress is not included in contractWhitelist, native tokens with a balance of 0 will be filtered out
       contractBlacklist: ['0x0000000000000000000000000000000000000000'],
       contractStatus: ContractVerificationStatus.VERIFIED,
       omitNativeBalances: false
@@ -212,7 +212,7 @@ const { data, isLoading, error } = useGetTokenBalancesDetails(
     networks: ['mainnet'],
     filter: {
       accountAddresses: ['0x0123456789012345678901234567890123456789'],
-      contractWhitelist: ['0x0123456789012345678901234567890123456789'],
+      contractWhitelist: ['0x0123456789012345678901234567890123456789'], // If zeroAddress is not included in contractWhitelist, native tokens with a balance of 0 will be filtered out
       contractBlacklist: ['0x0000000000000000000000000000000000000000'],
       contractStatus: ContractVerificationStatus.VERIFIED,
       omitNativeBalances: false

packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesDetails.ts

@@ -1,5 +1,6 @@
 import { ContractType, IndexerGateway, SequenceIndexerGateway, TokenBalance } from '@0xsequence/indexer'
 import { useQuery } from '@tanstack/react-query'
+import { zeroAddress } from 'viem'
 
 import { QUERY_KEYS, time } from '../../constants'
 import { BalanceHookOptions } from '../../types'
@@ -23,10 +24,24 @@ const getTokenBalancesDetails = async (
       }
     }
 
-    const nativeTokens: TokenBalance[] = res.nativeBalances.flatMap(nativeChainBalance =>
-      nativeChainBalance.results.map(nativeTokenBalance =>
-        createNativeTokenBalance(nativeChainBalance.chainId, nativeTokenBalance.accountAddress, nativeTokenBalance.balance)
-      )
+    const isNativeContractWhitelisted = getTokenBalancesDetailsArgs.filter.contractWhitelist?.includes(zeroAddress)
+
+    const nativeTokens = res.nativeBalances.flatMap(
+      nativeChainBalance =>
+        nativeChainBalance.results
+          .map(nativeTokenBalance => {
+            if (!isNativeContractWhitelisted) {
+              if (nativeTokenBalance.balance.toString() === '0') {
+                return null
+              }
+            }
+            return createNativeTokenBalance(
+              nativeChainBalance.chainId,
+              nativeTokenBalance.accountAddress,
+              nativeTokenBalance.balance
+            )
+          })
+          .filter(Boolean) as TokenBalance[]
     )
 
     const tokens: TokenBalance[] = res.balances.flatMap(chainBalance => chainBalance.results)

packages/hooks/src/hooks/IndexerGateway/useGetTokenBalancesSummary.ts

@@ -1,5 +1,6 @@
 import { ContractType, IndexerGateway, SequenceIndexerGateway, TokenBalance } from '@0xsequence/indexer'
 import { useQuery } from '@tanstack/react-query'
+import { zeroAddress } from 'viem'
 
 import { QUERY_KEYS, time } from '../../constants'
 import { BalanceHookOptions } from '../../types'
@@ -23,10 +24,24 @@ const getTokenBalancesSummary = async (
       }
     }
 
-    const nativeTokens: TokenBalance[] = res.nativeBalances.flatMap(nativeChainBalance =>
-      nativeChainBalance.results.map(nativeTokenBalance =>
-        createNativeTokenBalance(nativeChainBalance.chainId, nativeTokenBalance.accountAddress, nativeTokenBalance.balance)
-      )
+    const isNativeContractWhitelisted = getTokenBalancesSummaryArgs.filter.contractWhitelist?.includes(zeroAddress)
+
+    const nativeTokens = res.nativeBalances.flatMap(
+      nativeChainBalance =>
+        nativeChainBalance.results
+          .map(nativeTokenBalance => {
+            if (!isNativeContractWhitelisted) {
+              if (nativeTokenBalance.balance.toString() === '0') {
+                return null
+              }
+            }
+            return createNativeTokenBalance(
+              nativeChainBalance.chainId,
+              nativeTokenBalance.accountAddress,
+              nativeTokenBalance.balance
+            )
+          })
+          .filter(Boolean) as TokenBalance[]
     )
 
     const tokens: TokenBalance[] = res.balances.flatMap(chainBalance => chainBalance.results)