Hooks
useGetSingleTokenBalanceSummary
Hook para obtener el balance de un token específico de una cuenta en una cadena
Importar
Uso
Tipo de retorno: UseQueryResult<TokenBalance>
El hook retorna todas las propiedades de UseQueryResult
de React Query con los datos de balances de tokens. Esta es la estructura detallada:
Propiedades
data
TokenBalance | undefined
Objeto de balance de token que contiene:
contractType
: El tipo de contrato (ERC20, ERC721, ERC1155)contractAddress
: Dirección del contrato del token- La dirección cuyo balance fue consultado
balance
: El monto del balance en las unidades base del tokenchainId
: El ID de la cadena de donde se obtuvo el balanceblockHash
: Hash del bloque que contiene el balanceblockNumber
: Número del bloque que contiene el balancetokenID
: ID de token opcional para NFTsuniqueCollectibles
: Cantidad de coleccionables únicosisSummary
: Indica si este es un balance de resumencontractInfo
: Información opcional del contratotokenMetadata
: Metadatos opcionales del token
isLoading
boolean
Estado de carga para la obtención de datos.
isError
boolean
Estado de error que indica si la consulta falló.
error
Error | null
Cualquier error que ocurrió durante la obtención de datos.
Parámetros
El hook acepta dos parámetros:
args: GetSingleTokenBalanceSummaryArgs
Parámetro | Type | Description |
---|---|---|
chainId | number | El chain ID del cual obtener el balance |
accountAddress | string | La dirección para la cual obtener el balance |
contractAddress | string | La dirección del contrato del token (use ZERO_ADDRESS para tokens nativos) |
options: BalanceHookOptions
Parámetro | Type | Description |
---|---|---|
disabled | boolean | (Opcional) Deshabilitar la consulta para que no se ejecute automáticamente |
retry | boolean | (Opcional) Indica si se deben reintentar las consultas fallidas |
hideCollectibles | boolean | (Opcional) Si es true, filtra tokens ERC721 y ERC1155 |