Hedera Token Management Tool

Introduction

The Hedera Token Management Tool is a process tool plugin that allows you to perform various functions through the Hedera Token Service (HTS) for tokens minted on the Hedera Distributed Ledger Technology (DLT). Some of the available operations include associating tokens, granting KYC, burning tokens, and more.

Get started

Prerequisites

Before you begin using the Hedera Token Management Tool, ensure that:

• You have an existing Hedera account and tokens minted on the Hedera network.
• You have the necessary keys and permissions for the operations you wish to perform.

Where to get the plugin

Download the Hedera Token Management Tool from the JogetOSS GitHub repository.

How to install

1. Click Download on this plugin screen (It will be a .jar file).
2. Go to your Joget localhost or server. In the Joget Console, go to Admin Bar > Systems Settings > Manage Plugins and click the Upload Plugins button.
3. Under Upload Plugin, select the plugin .jar file you downloaded and click Upload.
4. Depending on the plugin type, you can now view your new plugin in your form, List, or UI Builder.
5. Remember to uninstall the old plugin before uploading a new version.
6. The Joget Knowledge Base has more information on managing and developing plugins.

Configure Hedera Token Management Tool Properties

When configuring the tool, you will be presented with several fields, including the following:

• Operator ID: This corresponds to your Hedera Operator ID. For further details, see the Hedera Default Backend Configuration.
• Operator Key: Enter your Hedera Operator Key to create an account.
• Network Type: Choose Previewnet, Testnet, or Mainnet based on your environment.

Token management

• Operation Type: Available operations are:
  • Associate - Associates a token to a target account.
  • Dissociate - Dissociates a token from a target account.
  • Grant KYC - Grants KYC to a target account for a token.
  • Revoke KYC - Revoke KYC from a target account for a token.
  • Freeze - Freeze a target account from all transactions of a token.
  • Unfreeze - Unfreeze a target account to restore participation to a token.
  • Wipe - Wipes a specified amount of fungible or non-fungible tokens of a target account.
  • Pause - Pause all transactions for a token.
  • Unpause - Unpause a token to restore interactions with a token.
  • Delete - Mark the token as deleted, which permanently ceases any further interactions with the token.
  • Burn - Burn a specified amount of fungible or non-fungible tokens from the existing supply.

  For more info on these operations, see Token Service.

• Form: Select a form from which to retrieve data.
  All fields from the selected form will be available for field mapping in the below sections.
•  Token ID: The ID of an existing token with which you wish to apply the selected operation.
• Transaction Memo: Insert your custom note for transactions. It also accepts Hash Variable.
• Target Account ID: This property only applies when the Operation Type is Associate, Dissociate, Grant KYC, Revoke KYC, Freeze, Unfreeze, or Wipe.
  The account is to apply the selected operation type.
• Target Account Mnemonic Phrase: This property only applies when the Operation Type is Associate or Dissociate.
  Mnemonic phrase of the target account.
  Only accepts Hash Variable that points to the target account's encrypted stored mnemonic phrase.
  
  Caution: Ensure that the mnemonic phrases are encrypted and stored securely. Never input the plain-text mnemonic phrase. Anyone who possesses this phrase has unrestricted control over the account and can cause irreparable damage.
• KYC Account Mnemonic Phrase: This property only applies when the Operation Type is Grant KYC or Revoke KYC.

  Mnemonic phrase of the account that holds the KYC key of the defined token.
  Only accepts Hash Variable that points to the encrypted stored mnemonic phrase.

• Freeze Account Mnemonic Phrase: This property only applies when the Operation Type is Freeze or Unfreeze.

  Mnemonic phrase of the account that holds the freeze key of the defined token.
  Only accepts Hash Variable that points to the encrypted stored mnemonic phrase.

• Wipe Account Mnemonic Phrase: This property only applies when the Operation Type is Wipe.

  Mnemonic phrase of the account that holds the wipe key of the defined token.
  Only accepts Hash Variable that points to the encrypted stored mnemonic phrase.

• Wipe Token Type: This property only applies when Operation Type is Wipe.

  Select the token type to wipe from the target account:

  • Fungible Token
  • Non-fungible Token
• Amount of Tokens to Wipe: This property only applies when the Operation Type is Wipe & Wipe Token Type is Fungible Token. Amount of fungible tokens to wipe from the target account.

  Wiped tokens are burned and will decrease the token's total supply.

• NFT Serial Number to Wipe: This property only applies when the Operation Type is Wipe & Wipe Token Type is Non-fungible Token. The serial number of the NFT to wipe from the target account.
  Expect an integer value (e.g., 1).

• Pause Account Mnemonic Phrase: This property only applies when the Operation Type is Pause or Unpause.

  Mnemonic phrase of the account that holds the pause key of the defined token.
  Only accepts Hash Variable that points to the encrypted stored mnemonic phrase.

• Admin Account Mnemonic Phrase: This property only applies when the Operation Type is Delete.

  Mnemonic phrase of the account that holds the admin key of the defined token.
  Only accepts Hash Variable that points to the encrypted stored mnemonic phrase.

• Supply Account Mnemonic Phrase: This property only applies when the Operation Type is Burn.

  Mnemonic phrase of the account that holds the supply key of the defined token.
  Only accepts Hash Variable that points to the encrypted stored mnemonic phrase.

• Burn Token Type: This property only applies when the Operation Type is Burn.

  Select the token type to burn from the existing supply:

  • Fungible Token
  • Non-fungible Token
• Amount to Burn: This property only applies when the Operation Type is Burn & Burn Token Type is Fungible Token.

  Amount of fungible tokens to burn from existing supply.

• NFT Serial Number to Burn: This property is only applicable when the Operation Type is Burn & Burn Token Type is Non-fungible Token. The serial number of the NFT to burn.

  Expect an integer value (e.g., 1).

Store response to workflow variable

The following workflow variables can be configured to store the response of the transaction:

• Is Transaction Validated: To indicate if this transaction has been successfully validated.
• Consensus Timestamp: To store the timestamp of when the majority of the network members received the transaction. At this point, the transaction becomes final and verifiable.
• Transaction ID: To store the transaction ID of the transaction performed.
• Transaction Explorer URL: To store an auto-generated URL to check transaction details on a public ledger explorer. The default is Hashscan.

Download plugin

• Hedera Ledger Pack