フック
useWaasFeeOptions
ガス支払い用のWaaS手数料オプションを扱うためのフック
インポート
使い方
パラメータ
このフックは、以下のプロパティを持つオプションの設定オブジェクトを受け取ります:
パラメータ | 型 | 説明 |
---|---|---|
skipFeeBalanceCheck | boolean | トークン残高の確認をスキップするかどうか(デフォルト:false ) |
返り値の型:UseWaasFeeOptionsReturnType
このフックは、以下の要素を持つタプルを返します:
プロパティ
pendingFeeOptionConfirmation
WaasFeeOptionConfirmation | undefined
トランザクションが保留中の場合は現在の手数料確認の詳細を含むオブジェクト、保留中でない場合はundefined
。
skipFeeBalanceCheck
がfalse
の場合、オプションは残高情報を含むFeeOptionExtended
型になります:
confirmPendingFeeOption
(id: string, feeTokenAddress: string | null) => void
選択した手数料オプションを確定する関数です。
パラメータ | 型 | 説明 | |
---|---|---|---|
id | string | 手数料確認ID | |
feeTokenAddress | `string | null` | 手数料支払いに使用するトークンのアドレス(ネイティブトークンの場合はnull を指定) |
rejectPendingFeeOption
(id: string) => void
現在の手数料オプション選択を却下する関数です。
パラメータ | 型 | 説明 |
---|---|---|
id | string | 却下する手数料確認ID |
補足
このフックは、WaaS(Wallet as a Service)でスポンサーされていないトランザクションの手数料オプションを扱う機能を提供します。
主な特徴:
- ネイティブトークンやERC20トークンでのトランザクション手数料オプションを取得
- (
skipFeeBalanceCheck
がtrue
でない限り)各手数料オプションごとにユーザーのウォレット残高を自動取得 - ユーザーが希望する手数料トークンを選択可能
- 手数料選択の確定・却下が可能
このフックはSequence WaaSプロバイダーと連携し、手数料確認リクエストを受け取り、ユーザーが手数料トークンを選択できるUIを表示します。
フックの使い方について詳しくは、ERC20でガスを支払うガイドをご覧ください。