use sg721-metadata-onchain #104

taitruong · 2024-08-28T22:32:30Z

This PR uses sg721-metadata-onchain contract. It allows incoming NFTs with onchain metadata. If there is no onchain data, then None is used in Metadata.

taitruong · 2024-08-28T22:35:44Z

packages/ics721/src/execute.rs

-                // parse token data and check whether it is of type NftExtension
-                let extension: Option<NftExtensionMsg> = match data {
-                    Some(data) => from_json::<NftExtension>(data)
-                        .ok()
-                        .map(|ext| NftExtensionMsg {
-                            animation_url: ext.animation_url,
-                            attributes: ext.attributes,
-                            background_color: ext.background_color,
-                            description: ext.description,
-                            external_url: ext.external_url,
-                            image: ext.image,
-                            image_data: ext.image_data,
-                            youtube_url: ext.youtube_url,
-                            name: ext.name,
-                        }),
-                    None => None,
-                };
-
-                let msg = cw721_metadata_onchain::msg::ExecuteMsg::Mint {
-                    token_id: id.into(),
-                    token_uri: uri,
-                    owner: receiver.to_string(),
-                    extension,
-                };


Outsourced to mint_msg() for re-use.

taitruong · 2024-08-28T22:36:50Z

contracts/sg-ics721/src/execute.rs

+    fn mint_msg(
+        &self,
+        token_id: String,
+        token_uri: Option<String>,
+        owner: String,
+        data: Option<Binary>,
+    ) -> StdResult<Binary> {
+        // parse token data and check whether it is of type NftExtension
+        let extension: Metadata = match data {
+            Some(data) => {
+                match from_json::<NftExtension>(data).ok().map(|ext| Metadata {
+                    animation_url: ext.animation_url,
+                    attributes: ext.attributes.map(|traits| {
+                        traits
+                            .into_iter()
+                            .map(|t| Trait {
+                                trait_type: t.trait_type,
+                                value: t.value,
+                                display_type: t.display_type,
+                            })
+                            .collect()
+                    }),
+                    background_color: ext.background_color,
+                    description: ext.description,
+                    external_url: ext.external_url,
+                    image: ext.image,
+                    image_data: ext.image_data,
+                    youtube_url: ext.youtube_url,
+                    name: ext.name,
+                }) {
+                    Some(extension) => extension,
+                    None => Metadata {
+                        animation_url: None,
+                        attributes: None,
+                        background_color: None,
+                        description: None,
+                        external_url: None,
+                        image: None,
+                        image_data: None,
+                        youtube_url: None,
+                        name: None,
+                    },
+                }
+            }
+            None => Metadata {
+                animation_url: None,
+                attributes: None,
+                background_color: None,
+                description: None,
+                external_url: None,
+                image: None,
+                image_data: None,
+                youtube_url: None,
+                name: None,
+            },
+        };
+
+        let msg = sg721_metadata_onchain::ExecuteMsg::Mint {
+            token_id,
+            token_uri,
+            owner,
+            extension,
+        };
+        to_json_binary(&msg)
+    }


sg-ics721 implementation with Metadata

taitruong · 2024-08-28T22:37:43Z

contracts/sg-ics721/src/testing/integration_tests.rs

+                                data: Some(to_json_binary(&NftExtension {
+                                    image: Some("https://ark.pass/image.png".to_string()),
+                                    external_url: Some(
+                                        "https://interchain.arkprotocol.io".to_string(),
+                                    ),
+                                    description: Some("description".to_string()),
+                                    ..Default::default()
+                                }))
+                                .transpose()
+                                .unwrap(),


test case for token 1 with metadata. token 2 is unchanged and has no metadata

taitruong · 2024-08-28T22:38:11Z

contracts/sg-ics721/src/testing/integration_tests.rs

+        assert_eq!(
+            token_info.extension,
+            Some(NftExtension {
+                image: Some("https://ark.pass/image.png".to_string()),
+                external_url: Some("https://interchain.arkprotocol.io".to_string()),
+                description: Some("description".to_string()),
+                ..Default::default()
+            })
+        );
+        let token_info: cw721::msg::NftInfoResponse<DefaultOptionalNftExtension> = test


transferred NFT 1 with onchain data

taitruong · 2024-08-28T22:38:26Z

contracts/sg-ics721/src/testing/integration_tests.rs

+        assert_eq!(
+            token_info.extension,
+            Some(NftExtension {
+                ..Default::default()
+            })
+        );


transferred NFT 2 with no onchain data

humanalgorithm · 2024-09-02T08:42:40Z

contracts/sg-ics721/src/execute.rs

+        // parse token data and check whether it is of type NftExtension
+        let extension: Metadata = match data {
+            Some(data) => {
+                match from_json::<NftExtension>(data).ok().map(|ext| Metadata {


Since everything here is being added from .ext I wonder if we could put this mapping into a helper function

No, we cant, sg-ics721 requires struct of type Metadata, whilst ics721 requires NftExtensionMsg. See comments below.

contracts/sg-ics721/src/execute.rs

humanalgorithm · 2024-09-02T08:47:55Z

packages/ics721/src/execute.rs

+    ) -> StdResult<Binary> {
+        // parse token data and check whether it is of type NftExtension
+        let extension: Option<NftExtensionMsg> = match data {
+            Some(data) => from_json::<NftExtension>(data)


If we put that other parse in a function I think we could re-use it here?

No, we cant, sg-ics721 requires struct of type Metadata, whilst ics721 requires NftExtensionMsg

Out of curiosity how similar are those messages?

There are 100% the same. Created a new issue here: public-awesome/launchpad#695

Great, thanks

humanalgorithm · 2024-09-02T08:49:19Z

contracts/sg-ics721/src/execute.rs

+            },
+        };
+
+        let msg = sg721_metadata_onchain::ExecuteMsg::Mint {


so my question here is, does every meta data load resolve into a metadata_onchain type message? Wondering if there is a different struct for off-chain metadata?

In case of offchain metadata:

extension is empty onchain Metadata (with None values for each prop like image and attributes)

token_uri is used for offchain data, e.g. refers to an IPFS link with offchain metadata. Here JSON file on IPFS is exactly the same type for Metadata (as defined by ERC721).

So SG NFT mint is done by this:

let msg = cw721_metadata_onchain::msg::ExecuteMsg::Mint { token_id, token_uri, // holds off-chain metadata owner, extension, // holds on-chain metadata };

Just wondering here, if off chain metadata is minted in this way, shouldn't we not use an execute message from cw721_onchain such as to not confuse the developer? I think the data is fine just coming from the cw721_metadata_onchain directory might be a bit misleading.

Oh my bad (wrong example given above). This is an sg-implementation, proper code is using this:

let msg = sg721_metadata_onchain::ExecuteMsg::Mint { token_id, token_uri, // holds off-chain metadata owner, extension, // holds on-chain metadata }; to_json_binary(&msg)

Please note that mint_msg() returns StdResult<Binary> for ics721 and sg-ics721.

Resolved in discord, name is coming from external repo

taitruong · 2024-09-04T12:07:46Z

packages/ics721/src/execute.rs

                Ok(WasmMsg::Execute {
                    contract_addr: nft_contract.to_string(),
-                    msg: to_json_binary(&msg)?,
+                    msg: self.mint_msg(id.into(), uri, receiver.to_string(), data)?,


@humanalgorithm look here where mint_msg is called. This happens here in as part of callback_create_vouchers call in Ics721Execute trait.

shanev

LGTM

use sg721-metadata-onchain

eafba9e

taitruong commented Aug 28, 2024

View reviewed changes

taitruong requested review from shanev, jhernandezb and humanalgorithm August 29, 2024 06:23

humanalgorithm reviewed Sep 2, 2024

View reviewed changes

contracts/sg-ics721/src/execute.rs Outdated Show resolved Hide resolved

humanalgorithm reviewed Sep 2, 2024

View reviewed changes

taitruong added 2 commits September 3, 2024 11:48

simplify code

d4aac2e

more comments

21888fc

taitruong commented Sep 4, 2024

View reviewed changes

humanalgorithm approved these changes Sep 4, 2024

View reviewed changes

shanev approved these changes Sep 4, 2024

View reviewed changes

jhernandezb approved these changes Sep 4, 2024

View reviewed changes

taitruong added this pull request to the merge queue Sep 4, 2024

Merged via the queue into main with commit eb47798 Sep 4, 2024
4 checks passed

taitruong deleted the sg_ics721_with_onchain_metadata branch September 4, 2024 20:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use sg721-metadata-onchain #104

use sg721-metadata-onchain #104

taitruong commented Aug 28, 2024 •

edited

Loading

taitruong Aug 28, 2024

taitruong Aug 28, 2024

taitruong Aug 28, 2024

taitruong Aug 28, 2024

taitruong Aug 28, 2024

humanalgorithm Sep 2, 2024

taitruong Sep 3, 2024

humanalgorithm Sep 2, 2024

taitruong Sep 3, 2024

humanalgorithm Sep 4, 2024

taitruong Sep 4, 2024 •

edited

Loading

humanalgorithm Sep 4, 2024

humanalgorithm Sep 2, 2024

taitruong Sep 3, 2024

humanalgorithm Sep 4, 2024

taitruong Sep 4, 2024

humanalgorithm Sep 4, 2024

taitruong Sep 4, 2024

shanev left a comment

use sg721-metadata-onchain #104

use sg721-metadata-onchain #104

Conversation

taitruong commented Aug 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

taitruong Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shanev left a comment

Choose a reason for hiding this comment

taitruong commented Aug 28, 2024 •

edited

Loading

taitruong Sep 4, 2024 •

edited

Loading