フック
useGetNativeTokenBalance
複数チェーンにおけるネイティブトークン残高を取得するためのフック
インポート
使い方
返却型:UseQueryResult<TokenBalance[]>
このフックはReact QueryのUseQueryResult
の全プロパティと、トークン残高データを返します。詳細な構造は以下の通りです:
プロパティ
data
TokenBalance[] | undefined
以下を含むトークン残高オブジェクトの配列:
chainId
: 残高が取得されたチェーンIDaccountAddress
: 残高を照会したアドレスcontractAddress
: ネイティブトークンのアドレス(通常はゼロアドレス)balance
: トークンの基準単位での残高金額contractType
: コントラクトの種類(例:ERC20、ERC721、ERC1155)contractInfo
: 追加のコントラクト情報tokenMetadata
: トークンに関するメタデータblockHash
: 残高が記録されたブロックのハッシュ値blockNumber
: 残高が記録されたブロック番号uniqueCollectibles
: ユニークコレクティブルの数isSummary
: 残高がサマリーかどうかtokenID
: トークンID(ERC721およびERC1155トークンの場合)
isLoading
boolean
データ取得時のローディング状態。
isError
boolean
クエリが失敗した場合のエラー状態。
エラー
Error | null
データ取得中に発生したエラー内容。
パラメータ
このフックは2つのパラメータを受け取ります:
args: GetNativeTokenBalanceArgs
パラメータ | 型 | 説明 |
---|---|---|
accountAddress | string | 残高を取得するアドレス |
chainIds | number[] | 残高を取得するチェーンIDの配列 |
networks | string[] | 残高を取得するネットワーク名の配列 |
options: HooksOptions
パラメータ | 型 | 説明 |
---|---|---|
disabled | boolean | (オプション)クエリの自動実行を無効にします |
retry | boolean | (オプション)失敗したクエリを再試行するかどうか |