Update an Account
A transaction that updates the properties of an existing account. The network will store the latest updates on the account. If you would like to retrieve the state of an account in the past, you can query a mirror node.
Transaction Fees
Transaction Signing Requirements
- The account key(s) are required to sign the transaction
- If you are updating the keys on the account the OLD KEY and NEW KEY must sign
- If either is a key list then the key list keys are all required to sign
- If either is a threshold key, the threshold value is required to sign
- If you do not have the required signatures, the network will throw an INVALID_SIGNATURE error
Account Properties
Field | Description |
|---|---|
Key | The new key for the account. The old key and new key must sign the transaction. If the old key or new key is a threshold key then only the threshold of the old key and new key are required to sign the transaction. |
Expiration | The new expiration for the account |
Receiver Signature Required | If true, all the account keys must sign any transaction depositing into this account (in addition to all withdrawals). default: false |
Max Automatic Token Associations | Setting this account property will modify the existing automatic token association value. If you are trying to reduce the number of auto-token association slots, please make sure those slots are empty. If those slots are not empty, please dissociate tokens that were auto-associated. The max automatic token association is 1,000 token IDs. |
Staked ID | Update the node or account this account is staked to. See HIP-406.
Note: Accounts cannot stake to contract accounts. This will be fixed in a future release. |
Decline Rewards | Some accounts may stake to a node and decline earning rewards. If set to true, the account will not receive staking rewards. The default value is false. See HIP-406. |
Memo | Add or update a short description that should be recorded with the state of the account entity (maximum length of 100 characters). Anyone can view this memo on the network. |
Auto Renew Period | The new period of time in which the account will auto-renew in seconds. The account is charged tinybars for every auto-renew period. Duration time is in seconds. For example, one hour would result in an input value of 3,600 seconds.
NOTE: This is fixed to approximately 3 months (7890000 seconds). Any other value will return the following error: AUTORENEW_DURATION_NOT_IN_RANGE. default: 2,592,000 seconds |
Constructor | Description |
|---|---|
new AccountUpdateTransaction() | Initializes the AccountUpdateTransaction object |
new AccountUpdateTransaction()
Method | Type | Requirement |
|---|---|---|
setAccountId(<accountId>) | AccountId | Required |
setKey(<key>) | Key | Optional |
setReceiverSignatureRequired(<boolean>) | Boolean | Optional |
setMaxAutomaticTokenAssociations(<amount>) | int | Optional |
setAccountMemo(<memo>) | String | Optional |
setAutoRenewPeriod(<duration>) | Duration | Disabled |
setStakedAccountId(<stakedAccountId>) | AccountId | Optional |
setStakedNodeId(<stakedNodeId>) | long | Optional |
setDeclineStakingReward(<declineStakingReward>) | boolean | Optional |
setExpirationTime(<expirationTime>) | Instant | Disabled |
Java
JavaScript
Go
//Create the transaction to update the key on the account
AccountUpdateTransaction transaction = new AccountUpdateTransaction()
.setAccountId(accountId)
.setKey(updateKey);
//Sign the transaction with the old key and new key, submit to a Hedera network
TransactionResponse txResponse = transaction.freezeWith(client).sign(oldKey).sign(newKey).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);
//Version 2.0.0
//Create the transaction to update the key on the account
const transaction = await new AccountUpdateTransaction()
.setAccountId(accountId)
.setKey(updateKey)
.freezeWith(client);
//Sign the transaction with the old key and new key
const signTx = await (await transaction.sign(oldKey)).sign(newKey);
//SIgn the transaction with the client operator private key and submit 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;
console.log("The transaction consensus status is " +transactionStatus.toString());
//v2.0.5
//Create the transaction to update the key on the account
transaction, err := hedera.NewAccountUpdateTransaction().
SetAccountID(newAccountId).
SetKey(updateKey.PublicKey()).
FreezeWith(client)
if err != nil {
panic(err)
}
//Sign the transaction with the old key and new key, submit to a Hedera network
txResponse, err := transaction.Sign(newKey).Sign(updateKey).Execute(client)
//Request the receipt of the transaction
receipt, err := txResponse.GetReceipt(client)
if err != nil {
panic(err)
}
//Get the transaction consensus status
transactionStatus := receipt.Status
println("The transaction consensus status is ", transactionStatus)
//Version 2.0.0
Return the properties of an account create transaction.
Method | Type | Description |
|---|---|---|
getKey() | Key | Returns the public key on the account |
getInitialBalance() | Hbar | Returns the initial balance of the account |
getReceiverSignatureRequired() | boolean | Returns whether the receiver signature is required or not |
getExpirationTime() | Instant | Returns the expiration time |
getAccountMemo() | String | Returns the account memo |
getDeclineStakingReward() | boolean | Returns whether or not the account is declining rewards |
getStakedNodeId() | long | Returns the node ID the account is staked to |
getStakedAccountId() | AccountId | Returns the account ID the node is staked to |
getAutoRenewPeriod() | Duration | Returns the auto renew period on the account |
Java
JavaScript
Go
//Create a transaction
AccountUpdateTransaction transaction = new AccountUpdateTransaction()
.setAccountId(accountId)
.setKey(newKeyUpdate);
//Get the key on the account
Key accountKey = transaction.getKey();
//v2.0.0
//Create a transaction
const transaction = new AccountUpdateTransaction()
.setAccountId(accountId)
.setKey(newKeyUpdate);
//Get the key of an account
const accountKey = transaction.getKey();
//v2.0.0
//Create the transaction
transaction, err := hedera.NewAccountUpdateTransaction().
SetAccountID(newAccountId).
SetKey(updateKey.PublicKey())
//Get the key of an account
accountKey := transaction.GetKey()
//v2.0.0
Last modified 6d ago