フック
useGetTransactionHistory
トランザクション履歴を取得し、ページネーションするためのフック
インポート
使い方
返却型: UseGetTransactionHistoryReturnType
このフックはReact QueryのUseInfiniteQueryResult
の全プロパティと、トランザクション履歴データを返します。詳細な構造は以下の通りです:
プロパティ
data
InfiniteData<GetTransactionHistoryReturn> | undefined
複数ページを含むページネーションされたトランザクション履歴データ。各ページには以下が含まれます:
transactions
次のプロパティを持つトランザクションオブジェクトの配列:
txnHash
: トランザクションハッシュblockNumber
: トランザクションがマイニングされたブロック番号blockHash
: ブロックのハッシュchainId
: トランザクションが発生したチェーンIDmetaTxnID
: メタトランザクションID(オプション)transfers
: トランザクションの転送情報配列(オプション)timestamp
: トランザクションのタイムスタンプ
ページ
ページネーション情報オブジェクト:
page
: 次のページ番号more
: 次のページにさらに結果が存在するかどうかpageSize
: 1ページあたりの結果数
fetchNextPage
() => Promise<unknown>
次のページのトランザクションを読み込むための関数。
hasNextPage
boolean
さらに読み込めるトランザクションがあるかどうかを示すブール値。
isLoading
boolean
初回データ取得時のローディング状態。
isFetching
boolean
データ取得中(初回または追加取得時)のローディング状態。
isFetchingNextPage
boolean
次ページ取得時のローディング状態。
エラー
Error | null
データ取得中に発生したエラー内容。
パラメータ
このフックは2つのパラメータを受け取ります:
引数: UseGetTransactionHistoryArgs
パラメータ | 型 | 説明 |
---|---|---|
chainId | number | トランザクションを取得するチェーンID |
accountAddress | string | トランザクション履歴を取得するアドレス |
contractAddress | string | (オプション)コントラクトアドレスでトランザクションを絞り込み |
tokenId | string | (オプション)トークンIDでトランザクションを絞り込み |
page | object | (オプション)ページネーション設定 |
options: HooksOptions
パラメータ | 型 | 説明 |
---|---|---|
disabled | boolean | (オプション)クエリの自動実行を無効にします |
retry | boolean | (オプション)失敗したクエリを再試行するかどうか |
補足
このフックは無限スクロール対応のトランザクション履歴取得メソッドを提供します。コントラクトアドレスやトークンIDでの絞り込みも可能なため、一般的なアカウント履歴や特定アセットの履歴表示に便利です。
このフックは内部的に@tanstack/react-query
を使用してデータ取得とキャッシュを行い、stale timeは30秒です。