フック
useGetSingleTokenBalanceSummary
アカウントの特定チェーン上での特定トークン残高を取得するためのフック
インポート
使い方
返却型:UseQueryResult<TokenBalance>
このフックはReact QueryのUseQueryResult
の全プロパティと、トークン残高データを返します。詳細な構造は以下の通りです:
プロパティ
data
TokenBalance | undefined
以下を含むトークン残高オブジェクト:
contractType
: コントラクトの種類(ERC20、ERC721、ERC1155)contractAddress
: トークンコントラクトのアドレスaccountAddress
: 残高を照会したアドレスbalance
: トークンの基準単位での残高金額chainId
: 残高が取得されたチェーンIDblockHash
: 残高を含むブロックのハッシュ値blockNumber
: 残高を含むブロック番号tokenID
: NFTの場合の任意のトークンIDuniqueCollectibles
: ユニークコレクティブルの数isSummary
: これがサマリー残高かどうかcontractInfo
: 任意のコントラクト情報tokenMetadata
: 任意のトークンメタデータ
isLoading
boolean
データ取得時のローディング状態。
isError
boolean
クエリが失敗した場合のエラー状態。
エラー
Error | null
データ取得中に発生したエラー内容。
パラメータ
このフックは2つのパラメータを受け取ります:
args: GetSingleTokenBalanceSummaryArgs
パラメータ | 型 | 説明 |
---|---|---|
chainId | number | 残高を取得するチェーンID |
accountAddress | string | 残高を取得するアドレス |
contractAddress | string | トークンコントラクトのアドレス(ネイティブトークンの場合はZERO_ADDRESSを使用) |
options: BalanceHookOptions
パラメータ | 型 | 説明 |
---|---|---|
disabled | boolean | (オプション)クエリの自動実行を無効にします |
retry | boolean | (オプション)失敗したクエリを再試行するかどうか |
hideCollectibles | boolean | (オプション)trueの場合、ERC721およびERC1155トークンを除外します |