/** * # Crypto Create * Messages to create a new end-user account within the distributed ledger. * * ### 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"; /* * Create a new account. * * If the auto_renew_account field is set, the key of the referenced account * MUST sign this transaction.
* Current limitations REQUIRE that `shardID` and `realmID` both MUST be `0`. * This is expected to change in the future. * * ### Block Stream Effects * The newly created account SHALL be included in State Changes. */ message CryptoCreateTransactionBody { // Removed prior to oldest available history reserved 4,5; /** * The identifying key for this account. * This key represents the account owner, and is required for most actions * involving this account that do not modify the account itself. This key * may also identify the account for smart contracts. *

* This field is REQUIRED. * This `Key` MUST NOT be an empty `KeyList` and MUST contain at least one * "primitive" (i.e. cryptographic) key value. */ Key key = 1; /** * An amount, in tinybar, to deposit to the newly created account. *

* The deposited amount SHALL be debited to the "payer" account for this * transaction. */ uint64 initialBalance = 2; /** * Use `staked_id` instead.
* An account identifier for a staking proxy. */ AccountID proxyAccountID = 3 [deprecated = true]; /** * Removed prior to the first available history, and may be related to an * early design dead-end.
* An amount below which record stream records would not be created for * a transaction that reduces this account balance. */ uint64 sendRecordThreshold = 6 [deprecated = true]; /** * Removed prior to the first available history, and may be related to an * early design dead-end.
* An amount below which record stream records would not be created for * a transaction that increases this account balance. */ uint64 receiveRecordThreshold = 7 [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).
* If this flag is set, then the account key (`key` field) MUST sign * this create transaction, in addition to the transaction payer. */ bool receiverSigRequired = 8; /** * The duration between account automatic renewals.
* All entities in state may be charged "rent" occasionally (typically * every 90 days) to prevent unnecessary growth of the ledger. This value * sets the interval between such events for this account. *

* If the account balance (in HBAR) is insufficient to pay the full renewal * fee, the entire HBAR balance SHALL be consumed and the expiration for * the account SHALL be extended as far as the available balance can * support.
* If the account HBAR balance is `0` when the account must be renewed, then * the account SHALL be deleted, and subsequently removed from state. */ Duration autoRenewPeriod = 9; /** * The shard in which this account is created *

* Currently, this MUST be `0`.
* If the desired shard is `0`, this SHOULD NOT be set. */ ShardID shardID = 10; /** * The realm in which this account is created. *

* The shard number for this realm MUST match the value in `shardID`.
* Currently, this MUST be `0` for both fields.
* If the desired realm is `0`, this SHOULD NOT be set. */ RealmID realmID = 11; /** * This field was never actually used or enabled, and is not expected to * ever be used in the future.
*/ Key newRealmAdminKey = 12 [deprecated = true]; /** * A short description of this Account. *

* This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` * (default 100) bytes when encoded as UTF-8. */ string memo = 13; /** * 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 (e.g. 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.
* This value MUST NOT be less than `-1`. */ int32 max_automatic_token_associations = 14; 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 = 15; /** * 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 = 16; } /** * 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. */ bool decline_reward = 17; /** * Bytes to be used as the account's alias. *

* This value, if set, MUST be one of the following values
*

* All aliases within the network MUST be unique. If this value matches an * existing account alias, this `create` transaction SHALL fail.
* If an account exists with a particular alias value, any transaction to * transfer value _to_ that alias SHALL deposit the transferred value in * the existing account, and SHALL NOT assess an account creation fee.
* Once set, an account alias is immutable and MUST NOT be changed. */ bytes alias = 18; /** * Details of hooks to add immediately after creating this account. */ repeated com.hedera.hapi.node.hooks.HookCreationDetails hook_creation_details = 19; }