feature: update metadata field of fungible and non-fungible tokens, and dynamic NFTs

examples/hts-nftP1-fee-create-mint-burn-associate-transfer.js

@@ -77,7 +77,6 @@ async function main() {
             .setCustomFees([nftCustomFee])
             .setAdminKey(adminKey)
             .setSupplyKey(supplyKey)
-            // .setPauseKey(pauseKey)
             .setFreezeKey(freezeKey)
             .setWipeKey(wipeKey)
             .freezeWith(client)

examples/update-fungible-token-metadata-with-admin-key.js

@@ -0,0 +1,104 @@
+import {
+    TokenCreateTransaction,
+    TokenInfoQuery,
+    TokenType,
+    PrivateKey,
+    Client,
+    AccountId,
+    TokenUpdateTransaction,
+} from "@hashgraph/sdk";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+/**
+ * @summary E2E-HIP-646 https://hips.hedera.com/hip/hip-646
+ * @description Update fungible token metadata with admin key
+ */
+async function main() {
+    if (
+        !process.env.OPERATOR_KEY ||
+        !process.env.OPERATOR_ID ||
+        !process.env.HEDERA_NETWORK
+    ) {
+        throw new Error("Please set required keys in .env file.");
+    }
+
+    const operatorId = AccountId.fromString(process.env.OPERATOR_ID);
+    const operatorKey = PrivateKey.fromStringDer(process.env.OPERATOR_KEY);
+    const network = process.env.HEDERA_NETWORK;
+    const client = Client.forName(network).setOperator(operatorId, operatorKey);
+
+    // Generate a admin key
+    const adminKey = PrivateKey.generateED25519();
+    // Initial metadata
+    const metadata = new Uint8Array([1]);
+    // New metadata
+    const newMetadata = new Uint8Array([1, 2]);
+
+    let tokenInfo;
+
+    try {
+        // Create a non fungible token
+        let createTokenTx = new TokenCreateTransaction()
+            .setTokenName("Test")
+            .setTokenSymbol("T")
+            .setMetadata(metadata)
+            .setTokenType(TokenType.FungibleCommon) // The same flow can be executed with a TokenType.NON_FUNGIBLE_UNIQUE (i.e. HIP-765)
+            .setDecimals(3)
+            .setInitialSupply(10000)
+            .setTreasuryAccountId(operatorId)
+            .setAdminKey(adminKey)
+            .freezeWith(client);
+
+        // Sign and execute create token transaction
+        const tokenCreateTxResponse = await (
+            await createTokenTx.sign(adminKey)
+        ).execute(client);
+
+        // Get receipt for create token transaction
+        const tokenCreateTxReceipt =
+            await tokenCreateTxResponse.getReceipt(client);
+        console.log(
+            `Status of token create transction: ${tokenCreateTxReceipt.status.toString()}`,
+        );
+
+        // Get token id
+        const tokenId = tokenCreateTxReceipt.tokenId;
+        console.log(`Token id: ${tokenId.toString()}`);
+
+        // Get token info
+        tokenInfo = await new TokenInfoQuery()
+            .setTokenId(tokenId)
+            .execute(client);
+        console.log(`Token metadata:`, tokenInfo.metadata);
+
+        const tokenUpdateTx = new TokenUpdateTransaction()
+            .setTokenId(tokenId)
+            .setMetadata(newMetadata)
+            .freezeWith(client);
+
+        // Sign transactions with admin key and execute it
+        const tokenUpdateTxResponse = await (
+            await tokenUpdateTx.sign(adminKey)
+        ).execute(client);
+
+        // Get receipt for token update transaction
+        const tokenUpdateTxReceipt =
+            await tokenUpdateTxResponse.getReceipt(client);
+        console.log(
+            `Status of token update transction: ${tokenUpdateTxReceipt.status.toString()}`,
+        );
+
+        tokenInfo = await new TokenInfoQuery()
+            .setTokenId(tokenId)
+            .execute(client);
+        console.log(`Token updated metadata:`, tokenInfo.metadata);
+    } catch (error) {
+        console.log(error);
+    }
+
+    client.close();
+}
+
+void main();

examples/update-fungible-token-metadata-with-metadata-key.js

@@ -0,0 +1,104 @@
+import {
+    TokenCreateTransaction,
+    TokenInfoQuery,
+    TokenType,
+    PrivateKey,
+    Client,
+    AccountId,
+    TokenUpdateTransaction,
+} from "@hashgraph/sdk";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+/**
+ * @summary E2E-HIP-646 https://hips.hedera.com/hip/hip-646
+ * @description Update fungible token metadata with metadata key
+ */
+async function main() {
+    if (
+        !process.env.OPERATOR_KEY ||
+        !process.env.OPERATOR_ID ||
+        !process.env.HEDERA_NETWORK
+    ) {
+        throw new Error("Please set required keys in .env file.");
+    }
+
+    const operatorId = AccountId.fromString(process.env.OPERATOR_ID);
+    const operatorKey = PrivateKey.fromStringDer(process.env.OPERATOR_KEY);
+    const network = process.env.HEDERA_NETWORK;
+    const client = Client.forName(network).setOperator(operatorId, operatorKey);
+
+    // Generate a metadata key
+    const metadataKey = PrivateKey.generateED25519();
+    // Initial metadata
+    const metadata = new Uint8Array([1]);
+    // New metadata
+    const newMetadata = new Uint8Array([1, 2]);
+
+    let tokenInfo;
+
+    try {
+        // Create a non fungible token
+        let createTokenTx = new TokenCreateTransaction()
+            .setTokenName("Test")
+            .setTokenSymbol("T")
+            .setMetadata(metadata)
+            .setTokenType(TokenType.FungibleCommon) // The same flow can be executed with a TokenType.NON_FUNGIBLE_UNIQUE (i.e. HIP-765)
+            .setDecimals(3)
+            .setInitialSupply(10000)
+            .setTreasuryAccountId(operatorId)
+            .setMetadataKey(metadataKey)
+            .freezeWith(client);
+
+        // Sign and execute create token transaction
+        const tokenCreateTxResponse = await (
+            await createTokenTx.sign(operatorKey)
+        ).execute(client);
+
+        // Get receipt for create token transaction
+        const tokenCreateTxReceipt =
+            await tokenCreateTxResponse.getReceipt(client);
+        console.log(
+            `Status of token create transction: ${tokenCreateTxReceipt.status.toString()}`,
+        );
+
+        // Get token id
+        const tokenId = tokenCreateTxReceipt.tokenId;
+        console.log(`Token id: ${tokenId.toString()}`);
+
+        // Get token info
+        tokenInfo = await new TokenInfoQuery()
+            .setTokenId(tokenId)
+            .execute(client);
+        console.log(`Token metadata:`, tokenInfo.metadata);
+
+        const tokenUpdateTx = new TokenUpdateTransaction()
+            .setTokenId(tokenId)
+            .setMetadata(newMetadata)
+            .freezeWith(client);
+
+        // Sign transactions with metadata key and execute it
+        const tokenUpdateTxResponse = await (
+            await tokenUpdateTx.sign(metadataKey)
+        ).execute(client);
+
+        // Get receipt for token update transaction
+        const tokenUpdateTxReceipt =
+            await tokenUpdateTxResponse.getReceipt(client);
+        console.log(
+            `Status of token update transction: ${tokenUpdateTxReceipt.status.toString()}`,
+        );
+
+        tokenInfo = await new TokenInfoQuery()
+            .setTokenId(tokenId)
+            .execute(client);
+        console.log(`Token updated metadata:`, tokenInfo.metadata);
+    } catch (error) {
+        console.log(error);
+    }
+
+    client.close();
+}
+
+void main();

examples/update-nfts-metadata-of-non-fungible-token.js

@@ -0,0 +1,178 @@
+import {
+    TokenCreateTransaction,
+    TokenInfoQuery,
+    TokenType,
+    PrivateKey,
+    Client,
+    AccountId,
+    TokenMintTransaction,
+    TokenNftsUpdateTransaction,
+    TokenNftInfoQuery,
+    NftId,
+    AccountCreateTransaction,
+    Hbar,
+    TransferTransaction,
+    TokenAssociateTransaction,
+} from "@hashgraph/sdk";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+/**
+ * @summary E2E-HIP-657 https://hips.hedera.com/hip/hip-657
+ * @description Update nfts metadata of fungible token with metadata key
+ */
+async function main() {
+    if (
+        !process.env.OPERATOR_KEY ||
+        !process.env.OPERATOR_ID ||
+        !process.env.HEDERA_NETWORK
+    ) {
+        throw new Error("Please set required keys in .env file.");
+    }
+
+    const operatorId = AccountId.fromString(process.env.OPERATOR_ID);
+    const operatorKey = PrivateKey.fromStringDer(process.env.OPERATOR_KEY);
+    const network = process.env.HEDERA_NETWORK;
+    const client = Client.forName(network).setOperator(operatorId, operatorKey);
+
+    // Generate a metadata key
+    const metadataKey = PrivateKey.generateED25519();
+    // Generate a supply key
+    const supplyKey = PrivateKey.generateED25519();
+    // Initial metadata
+    const metadata = new Uint8Array([1]);
+    // New metadata
+    const newMetadata = new Uint8Array([1, 2]);
+
+    let tokenNftsInfo, nftInfo;
+
+    try {
+        // Create a non fungible token
+        let createTokenTx = new TokenCreateTransaction()
+            .setTokenName("Test")
+            .setTokenSymbol("T")
+            .setTokenType(TokenType.NonFungibleUnique)
+            .setTreasuryAccountId(operatorId)
+            .setSupplyKey(supplyKey)
+            .setMetadataKey(metadataKey)
+            .freezeWith(client);
+
+        // Sign and execute create token transaction
+        const tokenCreateTxResponse = await (
+            await createTokenTx.sign(operatorKey)
+        ).execute(client);
+
+        // Get receipt for create token transaction
+        const tokenCreateTxReceipt =
+            await tokenCreateTxResponse.getReceipt(client);
+        console.log(
+            `Status of token create transction: ${tokenCreateTxReceipt.status.toString()}`,
+        );
+
+        // Get token id
+        const tokenId = tokenCreateTxReceipt.tokenId;
+        console.log(`Token id: ${tokenId.toString()}`);
+
+        // Get token info
+        const tokenInfo = await new TokenInfoQuery()
+            .setTokenId(tokenId)
+            .execute(client);
+        console.log(`Token metadata key: ${tokenInfo.metadataKey?.toString()}`);
+
+        // Mint token
+        const tokenMintTx = new TokenMintTransaction()
+            .setMetadata([metadata])
+            .setTokenId(tokenId)
+            .freezeWith(client);
+
+        const tokenMintTxResponse = await (
+            await tokenMintTx.sign(supplyKey)
+        ).execute(client);
+        const tokenMintTxReceipt = await tokenMintTxResponse.getReceipt(client);
+        console.log(
+            `Status of token mint transction: ${tokenMintTxReceipt.status.toString()}`,
+        );
+
+        const nftSerial = tokenMintTxReceipt.serials[0];
+
+        // Get TokenNftInfo to show the metadata on the NFT created
+        tokenNftsInfo = await new TokenNftInfoQuery()
+            .setNftId(new NftId(tokenId, nftSerial))
+            .execute(client);
+        nftInfo = tokenNftsInfo[0];
+        console.log(`Set token NFT metadata:`, nftInfo.metadata);
+
+        // Create an account to transfer the NFT to
+        const accountCreateTx = new AccountCreateTransaction()
+            .setKey(operatorKey)
+            .setMaxAutomaticTokenAssociations(10)
+            .setInitialBalance(new Hbar(100))
+            .freezeWith(client);
+
+        const accountCreateTxResponse = await (
+            await accountCreateTx.sign(operatorKey)
+        ).execute(client);
+        const accountCreateTxReceipt =
+            await accountCreateTxResponse.getReceipt(client);
+        const newAccountId = accountCreateTxReceipt.accountId;
+        console.log(`New account id: ${newAccountId.toString()}`);
+
+        const tokenAssociateTx = new TokenAssociateTransaction()
+            .setAccountId(newAccountId)
+            .setTokenIds([tokenId])
+            .freezeWith(client);
+
+        const tokenAssociateTxResponse = await (
+            await tokenAssociateTx.sign(operatorKey)
+        ).execute(client);
+        const tokenAssociateTxReceipt =
+            await tokenAssociateTxResponse.getReceipt(client);
+        console.log(
+            `Status of token associate transaction: ${tokenAssociateTxReceipt.status.toString()}`,
+        );
+
+        // Transfer nft to the new account
+        const transferNftTx = new TransferTransaction()
+            .addNftTransfer(tokenId, nftSerial, operatorId, newAccountId)
+            .freezeWith(client);
+
+        const transferNftTxResponse = await (
+            await transferNftTx.sign(operatorKey)
+        ).execute(client);
+        const transferNftTxReceipt =
+            await transferNftTxResponse.getReceipt(client);
+        console.log(
+            `Status of transfer NFT transaction: ${transferNftTxReceipt.status.toString()}`,
+        );
+
+        // Update nfts metadata
+        const tokenUpdateNftsTx = new TokenNftsUpdateTransaction()
+            .setTokenId(tokenId)
+            .setSerialNumbers([nftSerial])
+            .setMetadata(newMetadata)
+            .freezeWith(client);
+
+        const tokenUpdateNftsTxResponse = await (
+            await tokenUpdateNftsTx.sign(metadataKey)
+        ).execute(client);
+        const tokenUpdateNftsTxReceipt =
+            await tokenUpdateNftsTxResponse.getReceipt(client);
+        console.log(
+            `Status of token update nfts transction: ${tokenUpdateNftsTxReceipt.status.toString()}`,
+        );
+
+        // Get token nfts info in order to show the metadata on the NFT created
+        tokenNftsInfo = await new TokenNftInfoQuery()
+            .setNftId(new NftId(tokenId, nftSerial))
+            .execute(client);
+        nftInfo = tokenNftsInfo[0];
+        console.log(`Updated token NFT metadata:`, nftInfo.metadata);
+    } catch (error) {
+        console.log(error);
+    }
+
+    client.close();
+}
+
+void main();