フック
useGetTokenMetadata
コントラクト内の個別トークンのメタデータを取得するためのフック
インポート
使い方
返却型: UseQueryResult<TokenMetadata[]>
このフックはReact QueryのUseQueryResult
の全プロパティと、トークンメタデータを返します。詳細な構造は以下の通りです:
プロパティ
data
TokenMetadata[] | undefined
リクエストした各トークンのメタデータを含むオブジェクトの配列:
tokenId
: 対象トークンのIDsource
: トークンメタデータの取得元(例: “sequence”, “opensea” など)name
: 対象トークンの名称(例: “Bored Ape #1234”)description
: 対象トークンの説明image
: トークン画像のURL(画像サービス経由で自動プロキシ)video
: トークンに動画コンテンツがある場合の動画URLaudio
: トークンに音声コンテンツがある場合の音声URLproperties
: 追加のメタデータプロパティ(キーと値のペア)attributes
: NFT用の属性オブジェクト配列image_data
: 提供されている場合の生SVG/画像データexternal_url
: トークンに関連付けられた外部URLbackground_color
: 16進数形式の背景色animation_url
: アニメーションコンテンツのURLdecimals
: トークンの小数点(ERC1155の代替可能トークン用)updatedAt
: メタデータが最後に更新されたISOタイムスタンプassets
: 追加のアセットファイルの配列status
: メタデータの現在の状態(“READY”、“PENDING”、“ERROR”)queuedAt
: メタデータのインデックス作成がキューに入ったISOタイムスタンプlastFetched
: 最後に正常に取得されたISOタイムスタンプ
isLoading
boolean
データ取得時のローディング状態。
isError
boolean
クエリが失敗した場合のエラー状態。
エラー
Error | null
データ取得中に発生したエラー内容。
パラメータ
このフックは2つのパラメータを受け取ります:
引数: GetTokenMetadataArgs
パラメータ | 型 | 説明 |
---|---|---|
chainID | string | チェーンID(例:Ethereumメインネットの場合は”1”) |
contractAddress | string | トークン/NFTのコントラクトアドレス |
tokenIDs | string[] | メタデータを取得するトークンIDの配列 |
options: HooksOptions
パラメータ | 型 | 説明 |
---|---|---|
disabled | boolean | (オプション)クエリの自動実行を無効にします |
retry | boolean | (オプション)失敗したクエリを再試行するかどうか |