Cardano Burn Token Tool

Introduction

The Cardano Burn Token Tool allows you to burn native tokens and NFTs previously minted on the Cardano blockchain. This tool is useful for reducing the supply of tokens or removing NFTs from circulation.

Note:

  • Ensure that the minter account has sufficient native tokens or NFTs for the specified amount to burn.
  • Ensure that the minter account has enough balance to cover the transaction fee for burning assets.

Get started

Prerequisites

  • You must have a Cardano account with a sufficient token balance.
  • The account must have enough ADA to cover transaction fees.

Where to get the plugin

You can download the Cardano Burn Token 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.

Configure cardano burn token tool

To configure Cardano Burn Token Tool properties, go to Settings > Advanced into the Form Builderand in the field post processing tool, select the Cardano Burn Token Tool.

Fields to configure:

  • Network Type: Select the type of Cardano network:
  • Backend Service: Configure the backend service. 
    Type
    • Blockfrost
    • Koios
  • Blockfrost Project Key: Use the Blockfrost Project Key to connect your app with the Cardano blockchain.

Token burning properties

  • Form: Select a form from which to retrieve token-burning data.

    All fields from the selected form will be available for field mapping in the below sections.

Minting account details

  • Account Address: The account's address that wishes to burn minted assets that this account possesses.
  • Account Mnemonic Phrase: This is the minter's account secret key required to perform actions with the account.

    Only accepts Hash Variable that points to the account's encrypted stored mnemonic phrase.

    Caution: Ensure that the Account Mnemonic Phrase is always kept secure. Anyone with access to this phrase has complete control over the account and can cause irreparable damage.

Token burning configuration

  • Burn Type: Select the type of asset to burn:
    • Native Token
    • NFT
  • Asset ID: The asset ID combines the policy ID and hex-encoded asset name.
    The asset name is automatically derived from this value.
  • Minting Policy ID: The policy ID previously used to mint such an asset.
    The value retrieved here will be used to verify against the Asset ID value retrieved before continuing plugin execution.
  • Minting Policy Secret Key (encrypted): The secret key that signed the minting policy.
    Only accepts Hash Variable that points to the encrypted, stored policy secret key.
  • Amount To Burn: This property will only appear when the Burn Type is Native Token.

    If Burn Type is NFT, this property is automatically hidden and is always set to 1.

    Amount of native tokens to remove from total supply.

    Note that the account must possess at least the exact amount of such asset in order to burn.

  • Fee Limit (ADA): The maximum limit for transaction fees in units of ADA.
    Note:
    Value can only contain a maximum of 6 decimal places.
    If this is empty, no limit is applied.

Store response to workflow variable

  • Is Transaction Successful: To indicate if this transaction has been executed successfully. Returns true if successful, otherwise it returns false. You can use this value in your process to route your business logic and fully customize the user experience flow. 
  • Is Transaction Validated: To indicate if this transaction has been successfully validated. 
    This value will typically start with a false value. Only after the transaction has been confirmed/validated on the blockchain will this value automatically be changed to true.
  • Transaction ID: To store the transaction ID of the transaction performed.
  • Transaction Explorer URL: To store an auto-generated URL to see transaction details on the official Cardano blockchain explorer.

    Note that explorers typically have a short delay in syncing to the latest blockchain state in order to reflect your transactions.

Download plugin

Created by Julieth Last modified by Aadrian on Nov 19, 2024