Hooks
useGetSwapRoutes
Hook para obtener rutas disponibles para un swap
Importar
Este hook reemplaza al hook useGetSwapPrices
, que fue eliminado en la versión v5.2.3.
Uso
Tipo de retorno: UseQueryResult<LifiSwapRoute[]>
El hook retorna todas las propiedades de UseQueryResult
de React Query con los datos de rutas de swap. Aquí está la estructura detallada del objeto LifiSwapRoute
:
Propiedades
data
LifiSwapRoute[] | undefined
Arreglo de objetos de rutas de swap que contienen:
route
fromChainId
: El chain ID del token a vendertoChainId
: El chain ID del token a comprarfromTokens
: Arreglo de tokens que se pueden usar para pagar el swaptoTokens
: Arreglo de tokens que se pueden recibir del swap
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: UseGetSwapRoutesArgs
Parámetro | Type | Description |
---|---|---|
walletAddress | string | La dirección del wallet del usuario |
toTokenAddress | string | La dirección del token a comprar |
chainId | number | El chain ID donde se realizará el swap |
toTokenAmount | string | La cantidad de token a comprar (en wei) |
options: HooksOptions
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 (por defecto es true) |
Notas adicionales
- Este hook utiliza React Query para obtener y almacenar en caché las rutas de swap desde la API de Sequence.
- El tiempo de expiración está configurado en una hora por defecto para evitar actualizar cotizaciones mientras el usuario completa transacciones.
- Este hook no retornará “fromTokens” que el usuario no tenga en su wallet.