Wipe a token

Wipes the provided amount of tokens from the specified Hedera account. This transaction must be signed by the token's Wipe Key and the key of the account is being wiped. Wiping an accounts 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 account is not found, the transaction will resolve to TOKEN_NOT_ASSOCIATED_TO_ACCOUNT.

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

  • If the provided account is the token's Treasury Account, 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 account, one must provide amount of 10000. In order to wipe 100.55 tokens, one must provide amount of 10055.

Constructor

Description

new TokenWipeTransaction()

Initializes a TokenWipeAccountTransaction object

new TokenWipeAccountTransaction()

Methods

V2
V1
V2

Method

Type

Description

Requirement

setTokenId(<tokenId>)

TokenId

The ID of the token to wipe from the account

Required

setAmount(<amount>)

long

The amount of token to wipe from the specified account. Amount must be a positive non-zero number in the lowest denomination possible, not bigger than the token balance of the account (0; balance]

Required

setAccount(<accountId>)

AccountId

The account ID to wipe the tokens from

Required

Java
//Wipe 100 tokens from an account
TokenWipeTransaction transaction = new TokenWipeTransaction()
.setAccountId(accountId)
.setTokenId(tokenId)
.setAmount(100);
//Freeze the unsigned transaction, sign with the private key of the account that is being wiped, sign with the wipe private key of the token, 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 private key of the account that is being wiped, 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 private key of the account that is being wiped, 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
V1

Method

Type

Description

Requirement

setTokenId(<tokenId>)

TokenId

The ID of the token to wipe from the account

Required

setAmount(<amount>)

long

The amount of token to wipe from the specified account. Amount must be a positive non-zero number in the lowest denomination possible, not bigger than the token balance of the account (0; balance]

Required

setAccount(<accountId>)

AccountId

The account ID to wipe the tokens from

Required

Java
//Wipe 100 tokens from an account
TokenWipeTransaction transaction = new TokenWipeTransaction()
.setAccountId(accountId)
.setTokenId(tokenId)
.setAmount(100);
//Build the unsigned transaction, sign with the private key of the account that is being wiped, sign with the wipe private key of the token, submit the transaction to a Hedera network
TransactionId transactionId = transaction.build(client).sign(accountKey).sign(wipeKey).execute(client);
//Request the receipt of the transaction
TransactionReceipt getReceipt = transactionId.getReceipt(client);
//Obtain the transaction consensus status
Status transactionStatus = getReceipt.status;
System.out.println("The transaction consensus status is " +transactionStatus);
//Version: 1.2.2
JavaScript
//Wipe 100 tokens from an account
const transaction = new TokenWipeTransaction()
.setAccountId(accountId)
.setTokenId(tokenId)
.setAmount(100);
//Build the unsigned transaction, sign with the accounnt private key of the token, sign with the wipe private key, submit the transaction to a Hedera network
const transactionId = await transaction.build(client).sign(accountKey).sign(wipeKey).execute(client);
//Request the receipt of the transaction
const getReceipt = await transactionId.getReceipt(client);
//Obtain the transaction consensus status
const transactionStatus = getReceipt.status;
console.log("The transaction consensus status is " +transactionStatus);
//Version 1.4.2