Concordium Client CLI Tool#

This guide explains how to use concordium-client to perform PLT operations from the command line.

Installation and setup#

Download and install concordium-client v9.1.3-1-alpha:

Downloads (v9.1.3):

Note

With new DevNet releases and features, new concordium-client versions may get released. Follow the communication channels for the most recent versions.

Available PLT commands#

The following PLT operations are available via CLI:

Token Query Operations:

  • raw GetTokenList - Get a list of all PLTs available on DevNet

  • raw GetTokenInfo - Query the gRPC server for the info of a protocol level token

Token Transfer Operations:

  • transaction plt send - Transfer PLT tokens

Token Management Operations:

  • transaction plt mint - Mint protocol-level tokens

  • transaction plt burn - Burn protocol-level tokens

Allow/Deny List Operations:

  • transaction plt add-to-allow-list - Add an account to the allow list

  • transaction plt add-to-deny-list - Add an account to the deny list

  • transaction plt remove-from-allow-list - Remove an account from the allow list

  • transaction plt remove-from-deny-list - Remove an account from the deny list

  • transaction plt pause - Suspend balance transfer operations for a selected PLT

  • transaction plt unpause - Resume balance transfer operations for a selected PLT

Note

All PLT management operations require a governance account.

Command examples#

Get PLT List:

concordium-client raw GetTokenList --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Get PLT Info:

concordium-client raw GetTokenInfo TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Transfer PLT:

concordium-client transaction plt send --sender YOUR_ACCOUNT --receiver RECEIVER_ADDRESS --amount 1 --tokenId TOKEN_SYMBOL --memo "test" --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Mint PLT:

concordium-client transaction plt mint --sender GOVERNANCE_ACCOUNT --amount TOKEN-AMOUNT --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Burn PLT:

concordium-client transaction plt burn --sender GOVERNANCE_ACCOUNT --amount TOKEN-AMOUNT --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Add an Account to the Allow List:

concordium-client transaction plt add-to-allow-list --sender GOVERNANCE_ACCOUNT --account ACCOUNT_ADDRESS --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Add an Account to the Deny List:

concordium-client transaction plt add-to-deny-list --sender GOVERNANCE_ACCOUNT --account ACCOUNT_ADDRESS --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Remove an Account from the Allow List:

concordium-client transaction plt remove-from-allow-list --sender GOVERNANCE_ACCOUNT --account ACCOUNT_ADDRESS --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Remove an Account from the Deny List:

concordium-client transaction plt remove-from-deny-list --sender GOVERNANCE_ACCOUNT --account ACCOUNT_ADDRESS --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Suspend balance transfer operations for the PLT:

concordium-client transaction plt pause --sender GOVERNANCE_ACCOUNT --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure

Resume balance transfer operations for the PLT:

concordium-client transaction plt unpause --sender GOVERNANCE_ACCOUNT --tokenId TOKEN_SYMBOL --grpc-ip grpc.devnet-plt-beta.concordium.com --grpc-port 20000 --secure
Was this article helpful?