dAppBooster
    Preparing search index...

    Function useErc20Balance

    • Custom hook to fetch an ERC20 token balance for a specific address.

      Uses TanStack Query to efficiently fetch and cache token balances. The hook handles proper address formatting and ensures the query only runs when all required parameters are available.

      Parameters

      • params: {
            address?: `0x${string}`;
            token?: {
                address: string;
                chainId: number;
                decimals: number;
                extensions?: Record<
                    string,
                    | undefined
                    | null
                    | string
                    | number
                    | bigint
                    | boolean
                    | Record<
                        string,
                        | undefined
                        | null
                        | string
                        | number
                        | bigint
                        | boolean
                        | Record<string, undefined | null | string | number | bigint | boolean>,
                    >,
                >;
                logoURI?: string;
                name: string;
                symbol: string;
            };
        }

        The params object

        • Optionaladdress?: `0x${string}`

          The wallet address to check the balance for

        • Optionaltoken?: {
              address: string;
              chainId: number;
              decimals: number;
              extensions?: Record<
                  string,
                  | undefined
                  | null
                  | string
                  | number
                  | bigint
                  | boolean
                  | Record<
                      string,
                      | undefined
                      | null
                      | string
                      | number
                      | bigint
                      | boolean
                      | Record<string, undefined | null | string | number | bigint | boolean>,
                  >,
              >;
              logoURI?: string;
              name: string;
              symbol: string;
          }

          The ERC20 token object containing address and chainId

      Returns Erc20Balance

      Result object

      const { balance, balanceError, isLoadingBalance } = useErc20Balance({
        address: '0x123...',
        token: { address: '0xabc...', chainId: 1, symbol: 'DAI', decimals: 18 }
      });

    Settings

    Member Visibility