Use IRC metadata in examples (#1180)

* Use metadata in examples * Update sdk/examples/how_tos/nft_collection/01_mint_collection_nft.rs Co-authored-by: Thoralf-M <[email protected]> * fix and add more * Update sdk/examples/how_tos/native_tokens/create.rs Co-authored-by: Thoralf-M <[email protected]> * fmt * changelog * impls --------- Co-authored-by: Thoralf-M <[email protected]>
iotaledger · Sep 8, 2023 · c3c0cf8 · c3c0cf8
1 parent b78019e
commit c3c0cf8
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 25 deletions.
diff --git a/sdk/CHANGELOG.md b/sdk/CHANGELOG.md
@@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Output::kind_str()` method;
 - `ConflictReason` display implementation with an explanation of the conflict;
 - `TokenScheme` methods `is_simple` and `as_simple`;
+- `Irc27Metadata` and `Irc30Metadata` helpers;
 
 ### Changed
 

diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml
@@ -305,14 +305,14 @@ required-features = ["wallet", "storage", "stronghold"]
 [[example]]
 name = "mint_collection_nft"
 path = "examples/how_tos/nft_collection/01_mint_collection_nft.rs"
-required-features = ["wallet", "stronghold"]
+required-features = ["wallet", "stronghold", "irc_27"]
 
 # Native Tokens Examples
 
 [[example]]
 name = "create_native_token"
 path = "examples/how_tos/native_tokens/create.rs"
-required-features = ["rocksdb", "stronghold"]
+required-features = ["rocksdb", "stronghold", "irc_30"]
 
 [[example]]
 name = "destroy_foundry"
@@ -788,7 +788,7 @@ required-features = ["wallet", "storage"]
 [[example]]
 name = "mint_nft"
 path = "examples/how_tos/nfts/mint_nft.rs"
-required-features = ["wallet", "stronghold"]
+required-features = ["wallet", "stronghold", "irc_27"]
 
 [[example]]
 name = "send_nft"

diff --git a/sdk/examples/how_tos/native_tokens/create.rs b/sdk/examples/how_tos/native_tokens/create.rs
@@ -12,6 +12,7 @@
 //! ```
 
 use iota_sdk::{
+    types::block::output::feature::Irc30Metadata,
     wallet::{CreateNativeTokenParams, Result},
     Wallet, U256,
 };
@@ -59,13 +60,16 @@ async fn main() -> Result<()> {
         println!("Account synced");
     }
 
+    let metadata =
+        Irc30Metadata::new("My Native Token", "MNT", 10).with_description("A native token to test the iota-sdk.");
+
     println!("Preparing transaction to create native token...");
 
     let params = CreateNativeTokenParams {
         alias_id: None,
         circulating_supply: U256::from(CIRCULATING_SUPPLY),
         maximum_supply: U256::from(MAXIMUM_SUPPLY),
-        foundry_metadata: None,
+        foundry_metadata: Some(metadata.to_bytes()),
     };
 
     let transaction = account.create_native_token(params, None).await?;

diff --git a/sdk/examples/how_tos/nft_collection/01_mint_collection_nft.rs b/sdk/examples/how_tos/nft_collection/01_mint_collection_nft.rs
@@ -17,7 +17,7 @@
 use iota_sdk::{
     types::block::{
         address::{Bech32Address, NftAddress},
-        output::NftId,
+        output::{feature::Irc27Metadata, NftId},
         payload::transaction::TransactionId,
     },
     wallet::{Account, MintNftParams, Result},
@@ -60,7 +60,7 @@ async fn main() -> Result<()> {
     let nft_mint_params = (0..NFT_COLLECTION_SIZE)
         .map(|index| {
             MintNftParams::new()
-                .with_immutable_metadata(get_immutable_metadata(index, issuer_nft_id).as_bytes().to_vec())
+                .with_immutable_metadata(get_immutable_metadata(index).to_bytes())
                 // The NFT address from the NFT we minted in mint_issuer_nft example
                 .with_issuer(issuer)
         })
@@ -89,21 +89,20 @@ async fn main() -> Result<()> {
     Ok(())
 }
 
-fn get_immutable_metadata(index: usize, issuer_nft_id: NftId) -> String {
-    // Note: we use `serde_json::from_str` to remove all unnecessary whitespace
-    serde_json::from_str::<serde_json::Value>(&format!(
-        r#"{{
-        "standard":"IRC27",
-        "version":"v1.0",
-        "type":"video/mp4",
-        "uri":"ipfs://wrongcVm9fx47YXNTkhpMEYSxCD3Bqh7PJYr7eo5Ywrong",
-        "name":"Shimmer OG NFT #{index}",
-        "description":"The Shimmer OG NFT was handed out 1337 times by the IOTA Foundation to celebrate the official launch of the Shimmer Network.",
-        "issuerName":"IOTA Foundation",
-        "collectionId":"{issuer_nft_id}",
-        "collectionName":"Shimmer OG"
-    }}"#
-    )).unwrap().to_string()
+fn get_immutable_metadata(index: usize) -> Irc27Metadata {
+    Irc27Metadata::new(
+        "video/mp4",
+        "https://ipfs.io/ipfs/QmPoYcVm9fx47YXNTkhpMEYSxCD3Bqh7PJYr7eo5YjLgiT"
+            .parse()
+            .unwrap(),
+        format!("Shimmer OG NFT #{index}"),
+    )
+    .with_description(
+        "The Shimmer OG NFT was handed out 1337 times by the IOTA Foundation \
+        to celebrate the official launch of the Shimmer Network.",
+    )
+    .with_issuer_name("IOTA Foundation")
+    .with_collection_name("Shimmer OG")
 }
 
 async fn wait_for_inclusion(transaction_id: &TransactionId, account: &Account) -> Result<()> {

diff --git a/sdk/examples/how_tos/nfts/mint_nft.rs b/sdk/examples/how_tos/nfts/mint_nft.rs
@@ -13,7 +13,7 @@
 
 use iota_sdk::{
     types::block::output::{
-        feature::{IssuerFeature, SenderFeature},
+        feature::{Irc27Metadata, IssuerFeature, SenderFeature},
         unlock_condition::AddressUnlockCondition,
         NftId, NftOutputBuilder,
     },
@@ -25,8 +25,6 @@ use iota_sdk::{
 const NFT1_OWNER_ADDRESS: &str = "rms1qpszqzadsym6wpppd6z037dvlejmjuke7s24hm95s9fg9vpua7vluaw60xu";
 // The metadata of the first minted NFT
 const NFT1_METADATA: &str = "some NFT metadata";
-// The immutable metadata of the first minted NFT
-const NFT1_IMMUTABLE_METADATA: &str = "some NFT immutable metadata";
 // The tag of the first minted NFT
 const NFT1_TAG: &str = "some NFT tag";
 // The base coin amount we sent with the second NFT
@@ -57,13 +55,22 @@ async fn main() -> Result<()> {
         .set_stronghold_password(std::env::var("STRONGHOLD_PASSWORD").unwrap())
         .await?;
 
+    let metadata = Irc27Metadata::new(
+        "video/mp4",
+        "https://ipfs.io/ipfs/QmPoYcVm9fx47YXNTkhpMEYSxCD3Bqh7PJYr7eo5YjLgiT"
+            .parse()
+            .unwrap(),
+        "Shimmer OG NFT",
+    )
+    .with_description("The original Shimmer NFT");
+
     let nft_params = [MintNftParams::new()
         .try_with_address(NFT1_OWNER_ADDRESS)?
         .try_with_sender(sender_address)?
         .with_metadata(NFT1_METADATA.as_bytes().to_vec())
         .with_tag(NFT1_TAG.as_bytes().to_vec())
         .try_with_issuer(sender_address)?
-        .with_immutable_metadata(NFT1_IMMUTABLE_METADATA.as_bytes().to_vec())];
+        .with_immutable_metadata(metadata.to_bytes())];
 
     let transaction = account.mint_nfts(nft_params, None).await?;
     println!("Transaction sent: {}", transaction.transaction_id);

diff --git a/sdk/src/types/block/output/feature/metadata.rs b/sdk/src/types/block/output/feature/metadata.rs
@@ -201,6 +201,7 @@ pub(crate) mod irc_27 {
         }
 
         pub fn to_bytes(&self) -> Vec<u8> {
+            // Unwrap: Safe because this struct is known to be valid
             serde_json::to_string(self).unwrap().into_bytes()
         }
     }
@@ -212,6 +213,12 @@ pub(crate) mod irc_27 {
         }
     }
 
+    impl From<Irc27Metadata> for Vec<u8> {
+        fn from(value: Irc27Metadata) -> Self {
+            value.to_bytes()
+        }
+    }
+
     #[derive(Clone, Debug, Serialize, Deserialize, Getters, PartialEq, Eq)]
     #[getset(get = "pub")]
     pub struct Attribute {
@@ -365,6 +372,7 @@ pub(crate) mod irc_30 {
         }
 
         pub fn to_bytes(&self) -> Vec<u8> {
+            // Unwrap: Safe because this struct is known to be valid
             serde_json::to_string(self).unwrap().into_bytes()
         }
     }
@@ -376,6 +384,12 @@ pub(crate) mod irc_30 {
         }
     }
 
+    impl From<Irc30Metadata> for Vec<u8> {
+        fn from(value: Irc30Metadata) -> Self {
+            value.to_bytes()
+        }
+    }
+
     #[cfg(test)]
     mod test {
         use super::*;