/** * # Get Account Information * A standard query to inspect the full detail of an 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_timestamp.proto"; import "services_duration.proto"; import "services_basic_types.proto"; import "services_query_header.proto"; import "services_response_header.proto"; import "services_crypto_add_live_hash.proto"; /** * A query to read information for an account. * * The returned information SHALL include balance.
* The returned information SHALL NOT include allowances.
* The returned information SHALL NOT include token relationships.
* The returned information SHALL NOT include account records. */ message CryptoGetInfoQuery { /** * Standard information sent with every query operation.
* This includes the signed payment and what kind of response is requested * (cost, state proof, both, or neither). */ QueryHeader header = 1; /** * The account ID for which information is requested */ AccountID accountID = 2; } /** * Response when the client sends the node CryptoGetInfoQuery */ message CryptoGetInfoResponse { /** * The standard response information for queries.
* This includes the values requested in the `QueryHeader` * (cost, state proof, both, or neither). */ ResponseHeader header = 1; /** * Information describing A single Account in the Hedera distributed ledger. * * #### Attributes * Each Account may have a unique three-part identifier, a Key, and one or * more token balances. Accounts also have an alias, which has multiple * forms, and may be set automatically. Several additional items are * associated with the Account to enable full functionality. * * #### Expiration * Accounts, as most items in the network, have an expiration time, recorded * as a `Timestamp`, and must be "renewed" for a small fee at expiration. * This helps to reduce the amount of inactive accounts retained in state. * Another account may be designated to pay any renewal fees and * automatically renew the account for (by default) 30-90 days at a time as * a means to optionally ensure important accounts remain active. * * ### Staking * Accounts may participate in securing the network by "staking" the account * balances to a particular network node, and receive a portion of network * fees as a reward. An account may optionally decline these rewards but * still stake its balances. * * #### Transfer Restrictions * An account may optionally require that inbound transfer transactions be * signed by that account as receiver (in addition to any other signatures * required, including sender). * */ message AccountInfo { // Removed prior to oldest available history reserved 5; /** * a unique identifier for this account. *

* An account identifier, when assigned to this field, SHALL be of * the form `shard.realm.number`. */ AccountID accountID = 1; /** * A Solidity ID. *

* This SHALL be populated if this account is a smart contract, and * SHALL NOT be populated otherwise.
* This SHALL be formatted as a string according to Solidity ID * standards. */ string contractAccountID = 2; /** * A boolean indicating that this account is deleted. *

* Any transaction involving a deleted account SHALL fail. */ bool deleted = 3; /** * Replaced by StakingInfo.
* 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, SHALL be the sentinel value of `0.0.0`. */ AccountID proxyAccountID = 4 [deprecated = true]; /** * Replaced by StakingInfo.
* The total amount of tinybar proxy staked to this account. */ int64 proxyReceived = 6 [deprecated = true]; /** * The key to be used to sign transactions from this account, if any. *

* This key SHALL NOT be set for hollow accounts until the account * is finalized.
* This key SHALL be set on all other accounts, except for certain * immutable accounts (0.0.800 and 0.0.801) necessary for network * function and otherwise secured by the governing council. */ Key key = 7; /** * The HBAR balance of this account, in tinybar (10-8 HBAR). *

* This value SHALL always be a whole number. */ uint64 balance = 8; /** * Obsolete and unused.
* The threshold amount, in tinybars, at which a record was created for * any transaction that decreased the balance of this account. */ uint64 generateSendRecordThreshold = 9 [deprecated = true]; /** * Obsolete and unused.
* The threshold amount, in tinybars, at which a record was created for * any transaction that increased the balance of this account. */ uint64 generateReceiveRecordThreshold = 10 [deprecated = true]; /** * A boolean indicating that the account requires a receiver signature * for inbound token transfer transactions. *

* If this value is `true` then a transaction to transfer tokens to this * account SHALL NOT succeed unless this account has signed the * transfer transaction. */ bool receiverSigRequired = 11; /** * The current expiration time for this account. *

* This account SHALL be due standard renewal fees when the network * consensus time exceeds this time.
* If rent and expiration are enabled for the network, and automatic * renewal is enabled for this account, renewal fees SHALL be charged * after this time, and, if charged, the expiration time SHALL be * extended for another renewal period.
* This account MAY be expired and removed from state at any point * after this time if not renewed.
* An account holder MAY extend this time by submitting an account * update transaction to modify expiration time, subject to the current * maximum expiration time for the network. */ Timestamp expirationTime = 12; /** * A duration to extend this account's expiration. *

* The network SHALL extend the account's expiration by this * duration, if funds are available, upon automatic renewal.
* This SHALL NOT apply if the account is already deleted * upon expiration.
* If this is not provided in an allowed range on account creation, the * transaction SHALL fail with INVALID_AUTO_RENEWAL_PERIOD. The default * values for the minimum period and maximum period are currently * 30 days and 90 days, respectively. */ Duration autoRenewPeriod = 13; /** * All of the livehashes attached to the account (each of which is a * hash along with the keys that authorized it and can delete it) */ repeated LiveHash liveHashes = 14; /** * As of `HIP-367`, which enabled unlimited token associations, the * potential scale for this value requires that users consult a mirror * node for this information. */ repeated TokenRelationship tokenRelationships = 15 [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 = 16; /** * The total number of non-fungible/unique tokens owned by this account. */ int64 ownedNfts = 17; /** * The maximum number of tokens that can be auto-associated with the * account. *

* If this is less than or equal to `used_auto_associations` (or 0), * then this account MUST manually associate with a token before * transacting in that token.
* Following HIP-904 This value may also be `-1` to indicate no * limit.
* This value MUST NOT be less than `-1`. */ int32 max_automatic_token_associations = 18; /** * An account alias.
* This is a value used in some contexts to reference an account when * the tripartite account identifier is not available. *

* This field, when set to a non-default value, is immutable and * SHALL NOT be changed. */ bytes alias = 19; /** * The ledger ID of the network that generated this response. *

* This value SHALL identify the distributed ledger that responded to * this query. */ bytes ledger_id = 20; /** * The ethereum transaction nonce associated with this account. */ int64 ethereum_nonce = 21; /** * Staking information for this account. */ StakingInfo staking_info = 22; } /** * Details of the account. *

* A state proof MAY be generated for this field. */ AccountInfo accountInfo = 2; }