Cardano Send Transaction Tool

Introduction

The Cardano Send Transaction Tool allows you to send assets from one account to another on the Cardano blockchain. Additionally, it offers the option to embed form data into the transaction metadata according to the CIP-20 standard.

Get started

Prerequisites

• The sender’s account has enough funds.
• You have access to the necessary project keys and account information.

Where to get the plugin

You can download the Cardano Send Transaction 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 send transaction tool properties

To configure Cardano Send Transaction Tool properties, go to Settings > Advanced into the Form Builder, and in the field post processing tool, select the Cardano Send Transaction Tool.

Fields to configure:

• Network Type: Select the type of Cardano network:
  • Mainnet
  • Preview Testnet
  • Pre-production Testnet
    See the Cardano Default Backend Plugin for network settings.
• 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.

Transaction properties

• Form: Select the Joget form where the account data will be stored. All fields from the selected form will be available for mapping.

Asset configuration

• Payment Type: Select the asset type to transfer:
  • ADA
  • Native Token
  • NFT
• Policy ID: This property will only appear when the Payment Type is Native Token or NFT.
  The policy ID that minted the token. You can use a Hash Variable or hardcoded.
• Asset Name: This property will only appear when the Payment Type is Native Token or NFT.

  The asset name of the token, e.g., MyTestToken, My-First-NFT. Typically, a Hash Variable is used here.

Payment configuration

• Sender Address: Address from which to send assets.
• Sender Account Mnemonic Phrase: This is the sender's account secret key, which is required to perform actions with the sender's account. Only accepts a Hash Variable that points to the sender'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.
• Enable Multiple Receivers: This property will only appear when Payment Type is ADA or Native Token.

  When this option is checked, you can pull multiple rows of data from a datalist to send assets to multiple receivers with their respective amounts.

  With this feature, all the receivers are compiled into a single transaction and executed atomically.

  Datalist To Retrieve Receivers property will appear for you to select an existing datalist in the current app.

  After then, the Datalist Column Mapping (Multiple Receivers Mode) configuration tab will be available for you to map datalist columns accordingly.

• Datalist To Retrieve Receivers: This property will only appear when Enable Multiple Receivers is checked.

  Select an existing datalist in the current app.

  The plugin will reference the selected datalist here and automatically retrieve data via the List Data Store of the selected datalist.

• Receiver Address: This property will only appear when Enable Multiple Receivers is not checked. It is the address to which assets should be sent.
• Amount to Send: This property will only appear when Enable Multiple Receivers is not checked. If Payment Type is NFT, it is automatically hidden and always set to 1. Amount of tokens to send.
  The amount can only contain a maximum of 6 decimal places. This rule applies to both ADA and native tokens.
• 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.

Additional metadata

• Metadata: The fields available here depend on the Form selected. Select the field(s) you wish to embed into the transaction metadata. Written transaction metadata follows the CIP-20 standard. To learn more about transaction metadata, see Build with transaction metadata.
  
  Transactions performed on the blockchain, including their metadata, are publicly viewable, as it is intended primarily as an always-accessible proof of existence.
  Do NOT directly embed sensitive information in the transaction metadata.

Datalist column mapping (multiple receivers mode)

This configuration tab will only appear when the Enable Multiple Receivers property is checked.

The columns available here depend on the datalist selected in the Datalist To Retrieve Receivers property.

• Receiver Address: Select the respective column that represents the receiver addresses.
• Amount: Select the respective column representing the amount of assets to send to the respective receivers.

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 to reflect your transactions.

Download plugin

• Cardano Blockchain Pack