Update a token

A transaction that updates the properties of an existing token. The admin key must sign this transaction to update any of the token properties. With one exception. All secondary keys can sign a transaction to change themselves. The admin key can update existing keys but cannot add new ones if they were not set during the creation of the token. If no value is given for a field, that field is left unchanged. If a TokenUpdateTx is performed we will keep returning TOKEN_IS_IMMUTABLE when it tries to change non-key properties or the expiry without an admin key.

Property	Description
Name	The new name of the token. The token name is specified as a string of UTF-8 characters in Unicode. UTF-8 encoding of this Unicode cannot contain the 0 byte (NUL). Is not required to be unique.
Symbol	The new symbol of the token. The token symbol is specified as a string of UTF-8 characters in Unicode. UTF-8 encoding of this Unicode cannot contain the 0 byte (NUL). Is not required to be unique.
Treasury Account	The new treasury account of the token. If the provided treasury account is not existing or deleted, the response will be INVALID_TREASURY_ACCOUNT_FOR_TOKEN. If successful, the Token balance held in the previous Treasury Account is transferred to the new one.
Admin Key	The new admin key of the token. If the token is immutable (no Admin Key was assigned during token creation), the transaction will resolve to TOKEN_IS_IMMUTABlE. Admin keys cannot update to add new keys that were not specified during the creation of the token.
KYC Key	The new KYC key of the token. If the token does not have currently a KYC key, the transaction will resolve to TOKEN_HAS_NO_KYC_KEY.
Freeze Key	The new freeze key of the token. If the token does not have currently a freeze key, the transaction will resolve to TOKEN_HAS_NO_FREEZE_KEY.
Fee Schedule Key	If set, the new key to use to update the token's custom fee schedule; if the token does not currently have this key, transaction will resolve to TOKEN_HAS_NO_FEE_SCHEDULE_KEY
Pause Key	Update the token's existing pause key. The pause key has the ability to pause or unpause a token.
Wipe Key	The new wipe key of the token. If the token does not have currently a wipe key, the transaction will resolve to TOKEN_HAS_NO_WIPE_KEY.
Supply Key	The new supply key of the token. If the token does not have currently a supply key, the transaction will resolve to TOKEN_HAS_NO_SUPPLY_KEY.
Expiration Time	The new expiry time of the token. Expiry can be updated even if the admin key is not set. If the provided expiry is earlier than the current token expiry, the transaction will resolve to INVALID_EXPIRATION_TIME. NOTE: The maximum expiration time is now + 8,000,001 seconds (approximately 92 days).
Auto Renew Account	The new account which will be automatically charged to renew the token's expiration, at autoRenewPeriod interval.
Auto Renew Period	The new interval at which the auto-renew account will be charged to extend the token's expiry. The default auto-renew period is 7,890,000 seconds. Currently, rent is not enforced for tokens so auto-renew payments will not be made. NOTE: The minimum period of time is approximately 30 days (2592000 seconds) and the maximum period of time is approximately 92 days (8000001 seconds). Any other value outside of this range will return the following error: AUTORENEW_DURATION_NOT_IN_RANGE.
Memo	Short publicly visible memo about the token. No guarantee of uniqueness. (100 characters max)
Metadata Key	The desired new metadata key for the token. This value can be null.
Metadata	The desired new metadata for the token. This value can be null. The admin key or metadata key can be used to update this property.

The sender pays the max_auto_associations fee and the rent for the first auto-renewal period for the association. This is in addition to the typical transfer fees. This ensures the receiver can receive the token without association and makes it a smoother transfer process

Transaction Signing Requirements

• Admin key is required to sign to update any token properties. (except for the expiry and all low priority keys)

• A secondary key can update itself. Meaning it can sign a transaction that changes itself.

  • Example: Wipe Key can sign a transaction that changes only the Wipe Key

• Updating the admin key requires the new admin key to sign.

• If a new treasury account is set, the new treasury key is required to sign.

• The account that is paying for the transaction fee.

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	Requirement
setTokenId(<tokenId>)	TokenId	Required
setTokenName(<name>)	String	Optional
setTokenSymbol(<symbol>)	String	Optional
setTreasuryAccountId(<treasury>)	AccountId	Optional
setAdminKey(<key>)	Key	Optional
setKycKey(<key>)	Key	Optional
setFreezeKey(<key>)	Key	Optional
setFeeScheduleKey(<key>)	Key	Optional
setPauseKey(<key>)	Key	Optional
setWipeKey(<key>)	Key	Optional
setSupplyKey(<key>)	Key	Optional
setExpirationTime(<expirationTime>)	Instant	Optional
setTokenMemo(<memo>)	String	Optional
setAutoRenewAccountId(<account>)	AccountId	Optional
setAutoRenewPeriod(<period>)	Duration	Optional
setMetadataKey(<key>)	Key	Optional
setMetadata(<bytes>)	bytes	Optional

Java

//Create the transaction 
TokenUpdateTransaction transaction = new TokenUpdateTransaction()
     .setTokenId(tokenId)
     .setMetadataKey(metadataKey)
     .setMetadata(newMetadata)
     .setTokenName("Your New Token Name");

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

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

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

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

//v2.0.1

JavaScript

//Create the transaction and freeze for manual signing
const transaction = await new TokenUpdateTransaction()
     .setTokenId(tokenId)
     .setMetadataKey(metadataKey)
     .setMetadata(newMetadata)
     .setTokenName("Your New Token Name")
     .freezeWith(client);

//Sign the transaction with the admin key
const signTx = await transaction.sign(adminKey);

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

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

//Get the transaction consensus status
const transactionStatus = receipt.status.toString();

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

//v2.0.5

Go

//Create the transaction and freeze for manual signing 
tokenUpdateTransaction, err := hedera.NewTokenUpdateTransaction().
      SetTokenID(tokenId).
      SetMetadataKey(metadataKey).
      SetMetadata(newMetadata).
      SetTokenName("Your New Token Name").
      FreezeWith(client)

if err != nil {
    panic(err)
}

//Sign with the admin private key of the token, sign with the client operator private key and submit the transaction to a Hedera network
txResponse, err := tokenUpdateTransaction.Sign(adminKey).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