Wipe a token

Wipes the provided amount of fungible or non-fungible tokens from the specified Hedera account. This transaction does not delete tokens from the treasury account. This transaction must be signed by the token's Wipe Key. Wiping an account's tokens burns the tokens and decreases the total supply.

• If the provided account is not found, the transaction will resolve to INVALID_ACCOUNT_ID.

• If the provided account has been deleted, the transaction will resolve to ACCOUNT_DELETED

• If the provided token is not found, the transaction will resolve to INVALID_TOKEN_ID.

• If the provided token has been deleted, the transaction will resolve to TOKEN_WAS_DELETED.

• If an Association between the provided token and the account is not found, the transaction will resolve to TOKEN_NOT_ASSOCIATED_TO_ACCOUNT.

• If Wipe Key is not present in the Token, the transaction results in TOKEN_HAS_NO_WIPE_KEY.

• If the provided account is the token's Treasury Account, the transaction results in CANNOT_WIPE_TOKEN_TREASURY_ACCOUNT

• On success, tokens are removed from the account and the total supply of the token is decreased by the wiped amount.

• The amount provided is in the lowest denomination possible.

  • Example: Token A has 2 decimals. In order to wipe 100 tokens from an account, one must provide an amount of 10000. In order to wipe 100.55 tokens, one must provide an amount of 10055.

• This transaction accepts zero-unit token wipe operations for fungible tokens (HIP-564)

Transaction Signing Requirements:

• Wipe key

• Transaction fee payer account key

Transaction Fees

• Please see the transaction and query fees table for the 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 fungible or non-fungible token to remove from the account.	Required
setAmount(<amount>)	long	Applicable to tokens of type FUNGIBLE_COMMON.The amount of token to wipe from the specified account. The amount must be a positive non-zero number in the lowest denomination possible, not bigger than the token balance of the account.	Optional
setAccount(<accountId>)	AccountId	The account the specified fungible or non-fungible token should be removed from.	Required
setSerials(<serials>)	List<long>	Applicable to tokens of type NON_FUNGIBLE_UNIQUE.The list of NFTs to wipe.	Optional
addSerial(<serial>)	long	Applicable to tokens of type NON_FUNGIBLE_UNIQUE.The NFT to wipe.	Optional

Java

//Wipe 100 tokens from an account
TokenWipeTransaction transaction = new TokenWipeTransaction()
    .setAccountId(accountId)
    .setTokenId(tokenId)
    .setAmount(100);

//Freeze the unsigned transaction, signing with the private key of the payer and the token's wipe key; submit the transaction to a Hedera network
TransactionResponse txResponse = transaction.freezeWith(client).sign(accountKey).sign(wipeKey).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

JavaScript

//Wipe 100 tokens from an account and freeze the unsigned transaction for manual signing
const transaction = await new TokenWipeTransaction()
    .setAccountId(accountId)
    .setTokenId(tokenId)
    .setAmount(100)
    .freezeWith(client);

//Sign with the payer account private key, sign with the wipe private key of the token
const signTx = await (await transaction.sign(accountKey)).sign(wipeKey);    

//Submit the transaction to a Hedera network    
const txResponse = await signTx.execute(client);

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

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

console.log("The transaction consensus status is " +transactionStatus.toString());

Go

//Wipe 100 tokens and freeze the unsigned transaction for manual signing
transaction, err = hedera.NewTokenBurnTransaction().
        SetAccountId(accountId).
        SetTokenID(tokenId).
        SetAmount(1000).
        FreezeWith(client)

if err != nil {
        panic(err)
}

//Sign with the payer account private key, sign with the wipe private key of the token
txResponse, err := transaction.Sign(accountKey).Sign(wipeKey).Execute(client)

if err != nil {
        panic(err)
}

//Request the receipt of the transaction
receipt, err = txResponse.GetReceipt(client)

if err != nil {
        panic(err)
}

//Get the transaction consensus status
status := receipt.Status

fmt.Printf("The transaction consensus status is %v\n", status)

//v2.1.0

Rust

// Wipe 100 tokens from an account
let transaction = TokenWipeTransaction::new()
    .account_id(account_id)
    .token_id(token_id)
    .amount(100);

// Freeze the unsigned transaction, signing with the private key of the payer and the token's wipe key
let tx_response = transaction
    .freeze_with(&client)?
    .sign(account_key)
    .sign(wipe_key)
    .execute(&client).await?;

// Request the receipt of the transaction
let receipt = tx_response.get_receipt(&client).await?;

// Get the transaction consensus status
let status = receipt.status;

println!("The transaction consensus status is {:?}", status);

// v0.34.0