Skip to main content

インポート

このフックは、v5.2.3 で削除された useGetSwapPrices フックの代替です。

使い方

返り値の型: UseQueryResult<LifiSwapRoute[]>

このフックは、React Query の UseQueryResult すべてのプロパティとスワップルートデータを返します。LifiSwapRoute オブジェクトの詳細な構造は以下の通りです。

プロパティ

data

LifiSwapRoute[] | undefined 以下を含むスワップルートオブジェクトの配列:
route
  • fromChainId: 売却するトークンのチェーンID
  • toChainId: 購入するトークンのチェーンID
  • fromTokens: スワップの支払いに利用できるトークンの配列
  • toTokens: スワップで受け取れるトークンの配列

isLoading

boolean データ取得時のローディング状態。

isError

boolean クエリが失敗した場合のエラー状態。

エラー

Error | null データ取得中に発生したエラー内容。

パラメータ

このフックは2つのパラメータを受け取ります:

引数: UseGetSwapRoutesArgs

options: HooksOptions

補足事項

  • このフックは React Query を使って Sequence API からスワップルートを取得・キャッシュします。
  • ユーザーが取引を完了する間に見積もりが更新されないよう、デフォルトでキャッシュの有効期間は1時間に設定されています。
  • このフックは、ユーザーのウォレットに存在しない “fromTokens” は返しません。