/** * # Crypto Update * Modify a single account. * * ### Keywords * The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", * "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this * document are to be interpreted as described in * [RFC2119](https://www.ietf.org/rfc/rfc2119) and clarified in * [RFC8174](https://www.ietf.org/rfc/rfc8174). */ syntax = "proto3"; package proto; // SPDX-License-Identifier: Apache-2.0 option java_package = "com.hederahashgraph.api.proto.java"; // <<>> This comment is special code for setting PBJ Compiler java package option java_multiple_files = true; import "services_basic_types.proto"; import "services_duration.proto"; import "services_hook_types.proto"; import "services_timestamp.proto"; import "google/protobuf/wrappers.proto"; /** * Modify the current state of an account. * * ### Requirements * - The `key` for this account MUST sign all account update transactions. * - If the `key` field is set for this transaction, then _both_ the current * `key` and the new `key` MUST sign this transaction, for security and to * prevent setting the `key` field to an invalid value. * - If the `auto_renew_account` field is set for this transaction, the account * identified in that field MUST sign this transaction. * - Fields set to non-default values in this transaction SHALL be updated on * success. Fields not set to non-default values SHALL NOT be * updated on success. * - All fields that may be modified in this transaction SHALL have a * default value of unset (a.k.a. `null`). * * ### Block Stream Effects * None */ message CryptoUpdateTransactionBody { // NOTE: Seven deprecated fields should probably be removed and the // field names reserved. // reserved 4,5,6,7,10,11,12 // Also, the `receiverSigRequiredField` oneOf should be removed // around `receiverSigRequiredWrapper` and the field renamed // (both actions are "safe" in protobuf) to `receiver_signature_required`. /** * An account identifier.
* This identifies the account which is to be modified in this transaction. *

* This field is REQUIRED. */ AccountID accountIDToUpdate = 2; /** * An account key.
* This may be a "primitive" key (a singly cryptographic key), or a * composite key. *

* If set, this key MUST be a valid key.
* If set, the previous key and new key MUST both sign this transaction. */ Key key = 3; /** * Removed in favor of the `staked_id` oneOf.
* An account identifier for a "proxy" account. This account's HBAR are * staked to a node selected by the proxy account. */ AccountID proxyAccountID = 4 [deprecated = true]; /** * Removed prior to the first available history.
* A fraction to split staking rewards between this account and the proxy * account. */ int32 proxyFraction = 5 [deprecated = true]; // This entire oneOf is deprecated, and the concept is not implemented. oneof sendRecordThresholdField { /** * Removed prior to the first available history, and may be related * to an early design dead-end.
* The new threshold amount (in tinybars) for which an account record is * created for any send/withdraw transaction */ uint64 sendRecordThreshold = 6 [deprecated = true]; /** * Removed prior to the first available history, and may be related * to an early design dead-end.
* The new threshold amount (in tinybars) for which an account record is * created for any send/withdraw transaction */ google.protobuf.UInt64Value sendRecordThresholdWrapper = 11 [deprecated = true]; } // This entire oneOf is deprecated, and the concept is not implemented. oneof receiveRecordThresholdField { /** * Removed prior to the first available history, and may be related * to an early design dead-end.
* The new threshold amount (in tinybars) for which an account record is * created for any receive/deposit transaction. */ uint64 receiveRecordThreshold = 7 [deprecated = true]; /** * Removed prior to the first available history, and may be related * to an early design dead-end.
* The new threshold amount (in tinybars) for which an account record is * created for any receive/deposit transaction. */ google.protobuf.UInt64Value receiveRecordThresholdWrapper = 12 [deprecated = true]; } /** * A duration to extend account expiration.
* An amount of time, in seconds, to extend the expiration date for this * account when _automatically_ renewed. *

* This duration MUST be between the current configured minimum and maximum * values defined for the network.
* This duration SHALL be applied only when _automatically_ extending the * account expiration. */ Duration autoRenewPeriod = 8; /** * A new account expiration time, in seconds since the epoch. *

* For this purpose, `epoch` SHALL be the UNIX epoch with 0 * at `1970-01-01T00:00:00.000Z`.
* If set, this value MUST be later than the current consensus time.
* If set, this value MUST be earlier than the current consensus time * extended by the current maximum expiration time configured for the * network. */ Timestamp expirationTime = 9; oneof receiverSigRequiredField { /** * Removed to distinguish between unset and a default value.
* Do NOT use this field to set a false value because the server cannot * distinguish from the default value. Use receiverSigRequiredWrapper * field for this purpose. */ bool receiverSigRequired = 10 [deprecated = true]; /** * A flag indicating the account holder must authorize all incoming * token transfers. *

* If this flag is set then any transaction that would result in adding * hbar or other tokens to this account balance MUST be signed by the * identifying key of this account (that is, the `key` field). */ google.protobuf.BoolValue receiverSigRequiredWrapper = 13; } /** * A short description of this Account. *

* This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` * (default 100) bytes when encoded as UTF-8. */ google.protobuf.StringValue memo = 14; /** * A maximum number of tokens that can be auto-associated * with this account.
* By default this value is 0 for all accounts except for automatically * created accounts (i.e smart contracts) which default to -1. *

* If this value is `0`, then this account MUST manually associate to * a token before holding or transacting in that token.
* This value MAY also be `-1` to indicate no limit.
* If set, this value MUST NOT be less than `-1`.
*/ google.protobuf.Int32Value max_automatic_token_associations = 15; oneof staked_id { /** * ID of the account to which this account is staking its balances. *

* If this account is not currently staking its balances, then this * field, if set, MUST be the sentinel value of `0.0.0`. */ AccountID staked_account_id = 16; /** * ID of the node this account is staked to. *

* If this account is not currently staking its balances, then this * field, if set, SHALL be the sentinel value of `-1`.
* Wallet software SHOULD surface staking issues to users and provide a * simple mechanism to update staking to a new node ID in the event the * prior staked node ID ceases to be valid. */ int64 staked_node_id = 17; } /** * A boolean indicating that this account has chosen to decline rewards for * staking its balances. *

* This account MAY still stake its balances, but SHALL NOT receive reward * payments for doing so, if this value is set, and `true`. */ google.protobuf.BoolValue decline_reward = 18; /** * The ids the hooks to delete from the account. */ repeated int64 hook_ids_to_delete = 19; /** * The hooks to create for the account. */ repeated com.hedera.hapi.node.hooks.HookCreationDetails hook_creation_details = 20; }