getObject
किसी एक Sui ऑब्जेक्ट के 32-बाइट हेक्साडेसिमल ऑब्जेक्ट आईडी के माध्यम से ऑन-चेन विवरण और मेटाडेटा प्राप्त करता है।
Move पैकेज और ऑब्जेक्ट के स्वामित्व की जाँच करने के लिए इस मेथड का उपयोग करें। आप struct फ़ील्ड की भी जाँच कर सकते हैं। एक रीड ऑपरेशन ऑब्जेक्ट को नहीं बदल सकता है। getObject फुलनोड स्टेट से रीड करता है। यह लेनदेन, गैस, या वॉलेट सिग्नेचर के बिना चलता है।
- क्लास:
SuiClient - पैकेज:
@mysten/sui/client
सिग्नेचर
client.getObject(input: GetObjectParams): Promise<SuiObjectResponse>
पैरामीटर
यह मेथड एक ऑब्जेक्ट स्वीकार करता है। इसमें नीचे दी गई प्रॉपर्टीज़ शामिल हैं।
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
id | string | हाँ | 32-बाइट हेक्साडेसिमल ऑब्जेक्ट आईडी, जैसे 0x123...। |
options | SuiObjectDataOptions | नहीं | प्रतिक्रिया डेटा फ़ील्ड के लिए फ़्लैग। प्रत्येक फ़्लैग डिफ़ॉल्ट रूप से false होता है। |
SuiObjectDataOptions
डिफ़ॉल्ट रूप से, getObject एक आईडी, संस्करण और डाइजेस्ट लौटाता है। अधिक डेटा प्राप्त करने के लिए प्रत्येक फ़्लैग को true पर सेट करें।
| विकल्प | विवरण |
|---|---|
showType | Move प्रकार लौटाता है, जैसे 0x2::coin::Coin<0x2::sui::SUI>. |
showContent | पार्स किए गए Move डेटा फ़ील्ड्स को लौटाता है, जो ऑब्जेक्ट की आंतरिक स्थिति का प्रतिनिधित्व करते हैं। |
showOwner | इस आइटम के स्वामित्व वाले पते या ऑब्जेक्ट को लौटाता है। |
showDisplay | UI रेंडरिंग के लिए डिस्प्ले मानक मेटाडेटा लौटाता है। इस मेटाडेटा में नाम, विवरण और इमेज URL शामिल हैं। |
showStorageRebate | ऑब्जेक्ट से जुड़ी स्टोरेज रिबेट लौटाता है। |
showBcs | क्लाइंट-साइड डीकोडिंग के लिए कच्चे बाइनरी कैनोनिकल सीरियलाइज़ेशन बाइट्स लौटाता है। |
showPreviousTransaction | इस ऑब्जेक्ट को संशोधित करने वाले अंतिम लेनदेन का डाइजेस्ट लौटाता है। |
रिटर्न मान
एक Promise लौटाता है जो एक SuiObjectResponse में रिज़ॉल्व होता है। प्रतिक्रिया में सफलता या त्रुटि डेटा होता है:
┌─────────────────────────────────────────────────────────────┐
│ SuiObjectResponse │
├──────────────────────────────┬──────────────────────────────┤
│ Success: `response.data` │ Error: `response.error` │
│ - objectId, version │ - code: "notExists" │
│ - type, digest │ - code: "deleted" │
│ - content, owner, display │ - object_id │
└──────────────────────────────┴──────────────────────────────┘
सफलता प्रतिक्रिया: data
जब ऑब्जेक्ट मौजूद होता है, तो इसकी data प्रॉपर्टी में SuiObjectData होता है।
{
"data": {
"objectId": "0x...",
"version": "10",
"digest": "...",
"type": "0x2::coin::Coin<0x2::sui::SUI>",
"content": {
"dataType": "moveObject",
"fields": { "balance": "1000000000" }
},
"owner": {
"AddressOwner": "0xabc..."
}
}
}
त्रुटि प्रतिक्रिया: error
error प्रॉपर्टी तब विवरण लौटाती है जब कोई ट्रांजैक्शन ऑब्जेक्ट को हटा देता है या इसे किसी दूसरे ऑब्जेक्ट में लपेट देता है। यह तब भी विवरण लौटाती है जब आईडी मौजूद नहीं होती है।
{
"error": {
"code": "notExists",
"object_id": "0x..."
}
}
उपयोग के उदाहरण
जाँचें कि कोई ऑब्जेक्ट मौजूद है या नहीं
यह हल्का क्वेरी डेटा फ़ील्ड का अनुरोध नहीं करता है। यह केवल डिजिस्ट और संस्करण संख्या लौटाता है।
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.");
}
नॉन-फंजिबल टोकन मेटाडेटा और डिस्प्ले फ़ील्ड प्राप्त करें
यह अनुरोध ऑन-चेन फ़ील्ड को पढ़ने के लिए showContent और UI एसेट्स को प्राप्त करने के लिए showDisplay सेट करता है।
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);
}
ऑब्जेक्ट के स्वामित्व की पुष्टि करें
यह कोड यह जांचने के लिए उपयोग करें कि क्या एक विशिष्ट खाता पता किसी आइटम को नियंत्रित करता है।
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 | ऑब्जेक्ट आईडी में मान्य हेक्स है, लेकिन नेटवर्क ऑब्जेक्ट का पता नहीं लगा सकता है। | आईडी सत्यापित करें या पुष्टि करें कि पिछले लेनदेन ने ऑब्जेक्ट को नहीं हटाया है। |
deleted | किसी लेनदेन ने ऑब्जेक्ट को सक्रिय स्थिति से हटा दिया, जला दिया, या छाँट दिया है। | आप getObject के माध्यम से हटाए गए ऑब्जेक्ट के लिए ऐतिहासिक डेटा पुनः प्राप्त नहीं कर सकते। |
invalid_param | ऑब्जेक्ट आईडी का 32-बाइट हेक्स प्रारूप गलत है। | जांचें कि आईडी 0x से शुरू होता है और इसकी लंबाई सही है। |
यह भी देखें
multiGetObjectsएक बैच अनुरोध में चार ऑब्जेक्ट्स का विवरण प्राप्त करता है।getOwnedObjectsएक विशिष्ट पते के स्वामित्व वाले सभी ऑब्जेक्ट्स को सूचीबद्ध करता है।- ऑब्जेक्ट डेटा कैसे प्राप्त करें एक ट्यूटोरियल प्रदान करता है जो एक Node.js स्क्रिप्ट में
getObjectका उपयोग करता है। - SuiClient आर्किटेक्चर
SuiClientऔर रीड ऑपरेशंस के कॉन्सेप्चुअल डिज़ाइन को समझाता है।