getObject
32バイトの16進数オブジェクトIDを指定して、1つのSuiオブジェクトに関するオンチェーンの詳細情報とメタデータを取得します。
このメソッドを使用して、Moveパッケージやオブジェクトの所有権を確認できます。また、構造体のフィールドも確認可能です。読み取り操作ではオブジェクトを変更することはできません。getObjectはフルノードの状態から読み取ります。トランザクション、ガス、ウォレットの署名なしで実行されます。
- クラス:
SuiClient - パッケージ:
@mysten/sui/client
署名
Signature
client.getObject(input: GetObjectParams): Promise<SuiObjectResponse>
パラメータ
このメソッドは1つのオブジェクトを受け取ります。以下のプロパティが含まれます。
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 32バイトの16進数オブジェクトID(例:0x123...)。 |
options | SuiObjectDataOptions | いいえ | 応答データフィールドに関するフラグ。各フラグのデフォルト値は false です。 |
SuiObjectDataOptions
デフォルトでは、getObject は ID、バージョン、およびダイジェストを返します。より多くのデータを取得するには、各フラグを true に設定してください。
| オプション | 説明 |
|---|---|
showType | Moveのタイプ(例:0x2::coin::Coin<0x2::sui::SUI>)を返します。 |
showContent | オブジェクトの内部状態を表す、解析済みの Move データフィールドを返します。 |
showOwner | このアイテムの所有権を持つアドレスまたはオブジェクトを返します。 |
showDisplay | UI レンダリング用の Display 標準メタデータを返します。このメタデータには、名前、説明、画像 URL が含まれます。 |
showStorageRebate | オブジェクトに関連付けられたストレージリベートを返します。 |
showBcs | クライアント側でのデコード用に、生のバイナリカノニカルシリアライゼーション(BCS)バイト列を返します。 |
showPreviousTransaction | このオブジェクトを最後に変更したトランザクションのダイジェストを返します。 |
戻り値
SuiObjectResponse に解決される Promise を返します。レスポンスには、成功またはエラーのデータが含まれます。
SuiObjectResponse envelope
┌─────────────────────────────────────────────────────────────┐
│ SuiObjectResponse │
├──────────────────────────────┬──────────────────────────────┤
│ Success: `response.data` │ Error: `response.error` │
│ - objectId, version │ - code: "notExists" │
│ - type, digest │ - code: "deleted" │
│ - content, owner, display │ - object_id │
└──────────────────────────────┴──────────────────────────────┘
成功時のレスポンス: data
オブジェクトが存在する場合、その data プロパティには SuiObjectData が格納されます。
Response: success
{
"data": {
"objectId": "0x...",
"version": "10",
"digest": "...",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"content": {
"dataType": "moveObject",
"fields": { "balance": "1000000000" }
},
"owner": {
"AddressOwner": "0xabc..."
}
}
}
エラーレスポンス: error
トランザクションによってオブジェクトが削除されたり、別のオブジェクトにラップされたりした場合、error プロパティが詳細を返します。また、ID が存在しない場合にも詳細が返されます。
Response: error
{
"error": {
"code": "notExists",
"object_id": "0x..."
}
}
使用例
オブジェクトの存在確認
この軽量なクエリはデータフィールドを要求しません。ダイジェストとバージョン番号のみを返します。
checkExists.js
const response = await client.getObject({
id: '0x123...'
});
if (response.error) {
console.log("Object doesn't exist.");
} else if (response.data) {
console.log("Object exists at version:", response.data.version);
} else {
console.log("The response didn't include object data.");
}
非代替性トークン(NFT)のメタデータと表示フィールドの取得
このリクエストでは、showContent を設定してオンチェーンのフィールドを読み取り、showDisplay を設定して UI アセットを取得します。
fetchNFT.js
const nft = await client.getObject({
id: '0x123...',
options: {
showContent: true,
showDisplay: true
}
});
if (nft.data) {
const name = nft.data.content?.fields?.name;
const imageUrl = nft.data.display?.data?.image_url;
console.log(`NFT Name: ${name}, Image: ${imageUrl}`);
} else {
console.warn("Item failed to load:", nft.error);
}
オブジェクトの所有権を確認する
このコードを使用して、特定のアカウントアドレスがアイテムを管理しているかどうかを確認します。
verifyOwnership.js
const item = await client.getObject({
id: '0x123...',
options: { showOwner: true }
});
const owner = item.data?.owner;
if (owner && owner.AddressOwner === '0xMyAddress...') {
console.log("You own this item.");
}
よくあるエラー
| エラーコード | 原因 | 解決方法 |
|---|---|---|
notExists | オブジェクト ID には有効な 16 進数が含まれていますが、ネットワークがオブジェクトを特定できません。 | ID を確認するか、以前のトランザクションによってオブジェクトが削除されていないか確認してください。 |
deleted | トランザクションによって、オブジェクトがアクティブな状態から削除、バーン、またはプルーニングされました。 | getObject を通じて、削除されたオブジェクトの履歴データを取得することはできません。 |
invalid_param | オブジェクト ID の 32 バイトの 16 進数形式が不正です。 | ID が 0x で始まり、長さが正しいことを確認してください。 |
関連項目
multiGetObjectsは、1回のバッチリクエストで4つのオブジェクトの詳細を取得します。getOwnedObjectsは、特定のアドレスが所有するすべてのオブジェクトを一覧表示します。- オブジェクトデータの取得方法 では、Node.js スクリプトで
getObjectを使用するチュートリアルを提供しています。 - SuiClient のアーキテクチャ では、
SuiClientおよび読み取り操作の概念設計について説明しています。