フック
useSwapModal
スワップモーダルを開くためのフック
インポート
使い方
返り値の型:UseSwapModalReturnType
このフックは以下のプロパティを持つオブジェクトを返します。
プロパティ
openSwapModal
(settings: SwapModalSettings) => void
指定した設定でスワップモーダルを開く関数です。
パラメータ:
settings
オブジェクトには以下のプロパティを含めることができます:
パラメータ | 型 | 説明 |
---|---|---|
chainId | number | スワップを行うブロックチェーンネットワークID |
toTokenAddress | string | 対象トークンコントラクトのアドレス |
toTokenAmount | string | 対象トークンの最小単位での数量 |
postSwapTransactions | Array<{to: string, data: string}> | (オプション)スワップ完了後に実行するトランザクションの配列 |
disableMainCurrency | boolean | (オプション)trueの場合、チェーンのメイン通貨でのスワップを無効化します |
title | string | (オプション)スワップモーダルのカスタムタイトル |
description | string | (オプション)スワップモーダルのカスタム説明文 |
onSuccess | () => void | (オプション)スワップが成功した際のコールバック |
onError | (error: Error) => void | (オプション)エラー発生時のコールバック |
onClose | () => void | (オプション)モーダルが閉じられたときのコールバック |
blockConfirmations | number | (オプション)スワップ完了までに待機するブロック承認数 |
closeSwapModal
() => void
スワップモーダルを閉じる関数です。
swapModalSettings
SwapModalSettings | undefined
現在のスワップモーダルの設定内容です。
補足
このフックは、ウォレット内のトークンを指定した通貨にスワップするためのスワップモーダルを操作するメソッドを提供します。ユーザーはウォレット内のトークンを選択して指定したトークンにスワップでき、スワップ完了後に追加のトランザクションを実行することも可能です。