Burn a token

Burns fungible and non-fungible tokens owned by the Treasury Account. If no Supply Key is defined, the transaction will resolve to TOKEN_HAS_NO_SUPPLY_KEY.

• The operation decreases the Total Supply of the Token.
• Total supply cannot go below zero.
• The amount provided must be in the lowest denomination possible.
  • Example: Token A has 2 decimals. In order to burn 100 tokens, one must provide an amount of 10000. In order to burn 100.55 tokens, one must provide an amount of 10055.
• This transaction accepts zero unit token burn operations for fungible tokens (HIP-564)

Transaction Signing Requirements

• Supply key
• Transaction fee payer account key

Transaction Fees

• Please see the transaction and query fees table for base transaction fee
• Please use the Hedera fee estimator to estimate your transaction fee cost

Methods

Method	Type	Description	Requirement
setTokenId(<tokenId>)	TokenId	The ID of the token to burn supply	Required
setAmount(<amount>)	long	The number of tokens to burn (fungible tokens)	Optional
setSerials(<serials>)	List<long>	Applicable to tokens of type NON_FUNGIBLE_UNIQUE.The list of NFT serial IDs to burn.	Optional
addSerial(<serial>)	long	Applicable to tokens of type NON_FUNGIBLE_UNIQUE.The serial ID to burn.	Optional

Java

//Burn 1,000 tokens
TokenBurnTransaction transaction = new TokenBurnTransaction()
     .setTokenId(tokenId)
     .setAmount(1000);

//Freeze the unsigned transaction, sign with the supply private key of the token, submit the transaction to a Hedera network
TransactionResponse txResponse = transaction.freezeWith(client).sign(supplyKey).execute(client);

//Request the receipt of the transaction
TransactionReceipt receipt = txResponse.getReceipt(client);

//Obtain the transaction consensus status
Status transactionStatus = receipt.status;

System.out.println("The transaction consensus status is " +transactionStatus);

//v2.0.1