Skip to main content

インポート

使い方

返り値の型: UseQueryResult<LifiSwapQuote>

このフックは、React Query の UseQueryResult すべてのプロパティとスワップ見積もりデータを返します。swapQuote の詳細な構造は以下の通りです。

プロパティ

data

SwapQuote | undefined スワップ見積もりオブジェクト(以下を含む):
  • currencyAddress: スワップ対象通貨のアドレス
  • currencyBalance: ユーザーのウォレット内の通貨残高
  • price: 現在のスワップ価格
  • maxPrice: スリッページを含むスワップの最大許容価格
  • to: スワップを処理する対象コントラクトのアドレス
  • transactionData: スワップ実行用のエンコード済みトランザクションデータ
  • transactionValue: トランザクションと一緒に送信される値(ネイティブトークンの場合)
  • approveData: 承認トランザクションのエンコード済みデータ(includeApprove が true かつ必要な場合)
  • amount: 受け取る通貨の数量
  • amountMin: スリッページ後に受け取る最小数量

isLoading

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

isError

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

エラー

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

パラメータ

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

引数: GetLifiSwapQuoteArgs

注意: fromTokenAmount または toTokenAmount のいずれか一方を必ず指定してください。両方同時には指定できません。

options: HooksOptions