Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chipipay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Usage

const {
  data,
  isLoading,
  isError,
  isSuccess,
  error,
  refetch,
  fetchTokenBalance,
} = useGetTokenBalance({
  params: {
    chainToken: ChainToken.USDC,
    chain: Chain.STARKNET,
    walletPublicKey: "0x...",
  },
  getBearerToken: getToken,
});

​
Input Parameters

ParameterTypeRequiredDescription
params.chainTokenChainTokenYesToken identifier. Use ChainToken.USDC
params.chainChainYesBlockchain network. Use Chain.STARKNET
params.walletPublicKeystringNoWallet address to check balance for
params.externalUserIdstringNoExternal user ID (alternative to walletPublicKey)
getBearerToken() => Promise<string>YesFunction returning the auth token
queryOptionsUseQueryOptionsNoReact Query options (e.g. staleTime, enabled)

​
Return Value

PropertyTypeDescription
dataGetTokenBalanceResponse | undefinedBalance data
isLoadingbooleanTrue while fetching
isErrorbooleanTrue if an error occurred
isSuccessbooleanTrue if the query succeeded
errorError | nullError when isError is true
refetch() => voidRe-run the query
fetchTokenBalance(input) => Promise<GetTokenBalanceResponse>Imperatively fetch balance with custom params

​
Example Implementation

import { useGetTokenBalance, Chain, ChainToken } from "@chipi-stack/chipi-react";
import { useAuth } from "@clerk/nextjs";

export function TokenBalance({ walletPublicKey }: { walletPublicKey: string }) {
  const { getToken } = useAuth();

  const { data, isLoading, error } = useGetTokenBalance({
    params: {
      chainToken: ChainToken.USDC,
      chain: Chain.STARKNET,
      walletPublicKey,
    },
    getBearerToken: getToken,
  });

  if (isLoading) return <p>Loading balance...</p>;
  if (error) return <p>Error: {error.message}</p>;

  return (
    <div>
      <p>Balance: {data?.balance} USDC</p>
    </div>
  );
}
Either walletPublicKey or externalUserId must be provided to identify the wallet.