com.hederahashgraph.api.proto.java.AccountOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: state/token/account.proto
package com.hederahashgraph.api.proto.java;
public interface AccountOrBuilder extends
// @@protoc_insertion_point(interface_extends:proto.Account)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* The unique entity id of the account.
*
*
* .proto.AccountID account_id = 1;
* @return Whether the accountId field is set.
*/
boolean hasAccountId();
/**
*
**
* The unique entity id of the account.
*
*
* .proto.AccountID account_id = 1;
* @return The accountId.
*/
com.hederahashgraph.api.proto.java.AccountID getAccountId();
/**
*
**
* The unique entity id of the account.
*
*
* .proto.AccountID account_id = 1;
*/
com.hederahashgraph.api.proto.java.AccountIDOrBuilder getAccountIdOrBuilder();
/**
*
**
* The alias to use for this account, if any.
*
*
* bytes alias = 2;
* @return The alias.
*/
com.google.protobuf.ByteString getAlias();
/**
*
**
* (Optional) The key to be used to sign transactions from the account, if any.
* This key will not be set for hollow accounts until the account is finalized.
* This key should be set on all the accounts, except for immutable accounts (0.0.800 and 0.0.801).
*
*
* .proto.Key key = 3;
* @return Whether the key field is set.
*/
boolean hasKey();
/**
*
**
* (Optional) The key to be used to sign transactions from the account, if any.
* This key will not be set for hollow accounts until the account is finalized.
* This key should be set on all the accounts, except for immutable accounts (0.0.800 and 0.0.801).
*
*
* .proto.Key key = 3;
* @return The key.
*/
com.hederahashgraph.api.proto.java.Key getKey();
/**
*
**
* (Optional) The key to be used to sign transactions from the account, if any.
* This key will not be set for hollow accounts until the account is finalized.
* This key should be set on all the accounts, except for immutable accounts (0.0.800 and 0.0.801).
*
*
* .proto.Key key = 3;
*/
com.hederahashgraph.api.proto.java.KeyOrBuilder getKeyOrBuilder();
/**
*
**
* The expiration time of the account, in seconds since the epoch.
*
*
* int64 expiration_second = 4;
* @return The expirationSecond.
*/
long getExpirationSecond();
/**
*
**
* The balance of the account, in tiny-bars.
*
*
* int64 tinybar_balance = 5;
* @return The tinybarBalance.
*/
long getTinybarBalance();
/**
*
**
* An optional description of the account with UTF-8 encoding up to 100 bytes.
*
*
* string memo = 6;
* @return The memo.
*/
java.lang.String getMemo();
/**
*
**
* An optional description of the account with UTF-8 encoding up to 100 bytes.
*
*
* string memo = 6;
* @return The bytes for memo.
*/
com.google.protobuf.ByteString
getMemoBytes();
/**
*
**
* A boolean marking if the account has been deleted.
*
*
* bool deleted = 7;
* @return The deleted.
*/
boolean getDeleted();
/**
*
**
* The amount of hbars staked to the account.
*
*
* int64 staked_to_me = 8;
* @return The stakedToMe.
*/
long getStakedToMe();
/**
*
**
* If this account stakes to another account, its value will be -1. It will
* be set to the time when the account starts staking to a node.
*
*
* int64 stake_period_start = 9;
* @return The stakePeriodStart.
*/
long getStakePeriodStart();
/**
*
**
* ID of the new account to which this account is staking. If set to the sentinel <tt>0.0.0</tt> AccountID,
* this field removes this account's staked account ID.
*
*
* .proto.AccountID staked_account_id = 10;
* @return Whether the stakedAccountId field is set.
*/
boolean hasStakedAccountId();
/**
*
**
* ID of the new account to which this account is staking. If set to the sentinel <tt>0.0.0</tt> AccountID,
* this field removes this account's staked account ID.
*
*
* .proto.AccountID staked_account_id = 10;
* @return The stakedAccountId.
*/
com.hederahashgraph.api.proto.java.AccountID getStakedAccountId();
/**
*
**
* ID of the new account to which this account is staking. If set to the sentinel <tt>0.0.0</tt> AccountID,
* this field removes this account's staked account ID.
*
*
* .proto.AccountID staked_account_id = 10;
*/
com.hederahashgraph.api.proto.java.AccountIDOrBuilder getStakedAccountIdOrBuilder();
/**
*
**
* ID of the new node this account is staked to. If set to the sentinel <tt>-1</tt>, this field
* removes this account's staked node ID.
*
*
* int64 staked_node_id = 11;
* @return Whether the stakedNodeId field is set.
*/
boolean hasStakedNodeId();
/**
*
**
* ID of the new node this account is staked to. If set to the sentinel <tt>-1</tt>, this field
* removes this account's staked node ID.
*
*
* int64 staked_node_id = 11;
* @return The stakedNodeId.
*/
long getStakedNodeId();
/**
*
**
* A boolean marking if the account declines rewards.
*
*
* bool decline_reward = 12;
* @return The declineReward.
*/
boolean getDeclineReward();
/**
*
**
* A boolean marking if the account requires a receiver signature.
*
*
* bool receiver_sig_required = 13;
* @return The receiverSigRequired.
*/
boolean getReceiverSigRequired();
/**
*
**
* The token ID of the head of the linked list from token relations map for the account.
*
*
* .proto.TokenID head_token_id = 14;
* @return Whether the headTokenId field is set.
*/
boolean hasHeadTokenId();
/**
*
**
* The token ID of the head of the linked list from token relations map for the account.
*
*
* .proto.TokenID head_token_id = 14;
* @return The headTokenId.
*/
com.hederahashgraph.api.proto.java.TokenID getHeadTokenId();
/**
*
**
* The token ID of the head of the linked list from token relations map for the account.
*
*
* .proto.TokenID head_token_id = 14;
*/
com.hederahashgraph.api.proto.java.TokenIDOrBuilder getHeadTokenIdOrBuilder();
/**
*
**
* The NftID of the head of the linked list from unique tokens map for the account.
*
*
* .proto.NftID head_nft_id = 15;
* @return Whether the headNftId field is set.
*/
boolean hasHeadNftId();
/**
*
**
* The NftID of the head of the linked list from unique tokens map for the account.
*
*
* .proto.NftID head_nft_id = 15;
* @return The headNftId.
*/
com.hederahashgraph.api.proto.java.NftID getHeadNftId();
/**
*
**
* The NftID of the head of the linked list from unique tokens map for the account.
*
*
* .proto.NftID head_nft_id = 15;
*/
com.hederahashgraph.api.proto.java.NftIDOrBuilder getHeadNftIdOrBuilder();
/**
*
**
* The serial number of the head NftID of the linked list from unique tokens map for the account.
*
*
* int64 head_nft_serial_number = 16;
* @return The headNftSerialNumber.
*/
long getHeadNftSerialNumber();
/**
*
**
* The number of NFTs owned by the account.
*
*
* int64 number_owned_nfts = 17;
* @return The numberOwnedNfts.
*/
long getNumberOwnedNfts();
/**
*
**
* The maximum number of tokens that can be auto-associated with the account.
*
*
* int32 max_auto_associations = 18;
* @return The maxAutoAssociations.
*/
int getMaxAutoAssociations();
/**
*
**
* The number of used auto-association slots.
*
*
* int32 used_auto_associations = 19;
* @return The usedAutoAssociations.
*/
int getUsedAutoAssociations();
/**
*
**
* The number of tokens associated with the account. This number is used for
* fee calculation during renewal of the account.
*
*
* int32 number_associations = 20;
* @return The numberAssociations.
*/
int getNumberAssociations();
/**
*
**
* A boolean marking if the account is a smart contract.
*
*
* bool smart_contract = 21;
* @return The smartContract.
*/
boolean getSmartContract();
/**
*
**
* The number of tokens with a positive balance associated with the account.
* If the account has positive balance in a token, it can not be deleted.
*
*
* int32 number_positive_balances = 22;
* @return The numberPositiveBalances.
*/
int getNumberPositiveBalances();
/**
*
**
* The nonce of the account, used for Ethereum interoperability.
*
*
* int64 ethereum_nonce = 23;
* @return The ethereumNonce.
*/
long getEthereumNonce();
/**
*
**
* The amount of hbars staked to the account at the start of the last rewarded period.
*
*
* int64 stake_at_start_of_last_rewarded_period = 24;
* @return The stakeAtStartOfLastRewardedPeriod.
*/
long getStakeAtStartOfLastRewardedPeriod();
/**
*
**
* (Optional) The id of an auto-renew account, in the same shard and realm as the account, that
* has signed a transaction allowing the network to use its balance to automatically extend the account's
* expiration time when it passes.
*
*
* .proto.AccountID auto_renew_account_id = 25;
* @return Whether the autoRenewAccountId field is set.
*/
boolean hasAutoRenewAccountId();
/**
*
**
* (Optional) The id of an auto-renew account, in the same shard and realm as the account, that
* has signed a transaction allowing the network to use its balance to automatically extend the account's
* expiration time when it passes.
*
*
* .proto.AccountID auto_renew_account_id = 25;
* @return The autoRenewAccountId.
*/
com.hederahashgraph.api.proto.java.AccountID getAutoRenewAccountId();
/**
*
**
* (Optional) The id of an auto-renew account, in the same shard and realm as the account, that
* has signed a transaction allowing the network to use its balance to automatically extend the account's
* expiration time when it passes.
*
*
* .proto.AccountID auto_renew_account_id = 25;
*/
com.hederahashgraph.api.proto.java.AccountIDOrBuilder getAutoRenewAccountIdOrBuilder();
/**
*
**
* The number of seconds the network should automatically extend the account's expiration by, if the
* account has a valid auto-renew account, and is not deleted upon expiration.
* If this is not provided in an allowed range on account creation, the transaction will fail with INVALID_AUTO_RENEWAL_PERIOD.
* The default values for the minimum period and maximum period are 30 days and 90 days, respectively.
*
*
* int64 auto_renew_seconds = 26;
* @return The autoRenewSeconds.
*/
long getAutoRenewSeconds();
/**
*
**
* If this account is a smart-contract, number of key-value pairs stored on the contract.
* This is used to determine the storage rent for the contract.
*
*
* int32 contract_kv_pairs_number = 27;
* @return The contractKvPairsNumber.
*/
int getContractKvPairsNumber();
/**
*
**
* (Optional) List of crypto allowances approved by the account.
* It contains account number for which the allowance is approved to and
* the amount approved for that account.
*
*
* repeated .proto.AccountCryptoAllowance crypto_allowances = 28;
*/
java.util.List
getCryptoAllowancesList();
/**
*
**
* (Optional) List of crypto allowances approved by the account.
* It contains account number for which the allowance is approved to and
* the amount approved for that account.
*
*
* repeated .proto.AccountCryptoAllowance crypto_allowances = 28;
*/
com.hederahashgraph.api.proto.java.AccountCryptoAllowance getCryptoAllowances(int index);
/**
*
**
* (Optional) List of crypto allowances approved by the account.
* It contains account number for which the allowance is approved to and
* the amount approved for that account.
*
*
* repeated .proto.AccountCryptoAllowance crypto_allowances = 28;
*/
int getCryptoAllowancesCount();
/**
*
**
* (Optional) List of crypto allowances approved by the account.
* It contains account number for which the allowance is approved to and
* the amount approved for that account.
*
*
* repeated .proto.AccountCryptoAllowance crypto_allowances = 28;
*/
java.util.List
getCryptoAllowancesOrBuilderList();
/**
*
**
* (Optional) List of crypto allowances approved by the account.
* It contains account number for which the allowance is approved to and
* the amount approved for that account.
*
*
* repeated .proto.AccountCryptoAllowance crypto_allowances = 28;
*/
com.hederahashgraph.api.proto.java.AccountCryptoAllowanceOrBuilder getCryptoAllowancesOrBuilder(
int index);
/**
*
**
* (Optional) List of non-fungible token allowances approved for all by the account.
* It contains account number approved for spending all serial numbers for the given
* NFT token number using approved_for_all flag.
* Allowances for a specific serial number is stored in the NFT itself in state.
*
*
* repeated .proto.AccountApprovalForAllAllowance approve_for_all_nft_allowances = 29;
*/
java.util.List
getApproveForAllNftAllowancesList();
/**
*
**
* (Optional) List of non-fungible token allowances approved for all by the account.
* It contains account number approved for spending all serial numbers for the given
* NFT token number using approved_for_all flag.
* Allowances for a specific serial number is stored in the NFT itself in state.
*
*
* repeated .proto.AccountApprovalForAllAllowance approve_for_all_nft_allowances = 29;
*/
com.hederahashgraph.api.proto.java.AccountApprovalForAllAllowance getApproveForAllNftAllowances(int index);
/**
*
**
* (Optional) List of non-fungible token allowances approved for all by the account.
* It contains account number approved for spending all serial numbers for the given
* NFT token number using approved_for_all flag.
* Allowances for a specific serial number is stored in the NFT itself in state.
*
*
* repeated .proto.AccountApprovalForAllAllowance approve_for_all_nft_allowances = 29;
*/
int getApproveForAllNftAllowancesCount();
/**
*
**
* (Optional) List of non-fungible token allowances approved for all by the account.
* It contains account number approved for spending all serial numbers for the given
* NFT token number using approved_for_all flag.
* Allowances for a specific serial number is stored in the NFT itself in state.
*
*
* repeated .proto.AccountApprovalForAllAllowance approve_for_all_nft_allowances = 29;
*/
java.util.List
getApproveForAllNftAllowancesOrBuilderList();
/**
*
**
* (Optional) List of non-fungible token allowances approved for all by the account.
* It contains account number approved for spending all serial numbers for the given
* NFT token number using approved_for_all flag.
* Allowances for a specific serial number is stored in the NFT itself in state.
*
*
* repeated .proto.AccountApprovalForAllAllowance approve_for_all_nft_allowances = 29;
*/
com.hederahashgraph.api.proto.java.AccountApprovalForAllAllowanceOrBuilder getApproveForAllNftAllowancesOrBuilder(
int index);
/**
*
**
* (Optional) List of fungible token allowances approved by the account.
* It contains account number for which the allowance is approved to and the token number.
* It also contains and the amount approved for that account.
*
*
* repeated .proto.AccountFungibleTokenAllowance token_allowances = 30;
*/
java.util.List
getTokenAllowancesList();
/**
*
**
* (Optional) List of fungible token allowances approved by the account.
* It contains account number for which the allowance is approved to and the token number.
* It also contains and the amount approved for that account.
*
*
* repeated .proto.AccountFungibleTokenAllowance token_allowances = 30;
*/
com.hederahashgraph.api.proto.java.AccountFungibleTokenAllowance getTokenAllowances(int index);
/**
*
**
* (Optional) List of fungible token allowances approved by the account.
* It contains account number for which the allowance is approved to and the token number.
* It also contains and the amount approved for that account.
*
*
* repeated .proto.AccountFungibleTokenAllowance token_allowances = 30;
*/
int getTokenAllowancesCount();
/**
*
**
* (Optional) List of fungible token allowances approved by the account.
* It contains account number for which the allowance is approved to and the token number.
* It also contains and the amount approved for that account.
*
*
* repeated .proto.AccountFungibleTokenAllowance token_allowances = 30;
*/
java.util.List
getTokenAllowancesOrBuilderList();
/**
*
**
* (Optional) List of fungible token allowances approved by the account.
* It contains account number for which the allowance is approved to and the token number.
* It also contains and the amount approved for that account.
*
*
* repeated .proto.AccountFungibleTokenAllowance token_allowances = 30;
*/
com.hederahashgraph.api.proto.java.AccountFungibleTokenAllowanceOrBuilder getTokenAllowancesOrBuilder(
int index);
/**
*
**
* The number of tokens for which this account is treasury
*
*
* uint32 number_treasury_titles = 31;
* @return The numberTreasuryTitles.
*/
int getNumberTreasuryTitles();
/**
*
**
* A flag indicating if the account is expired and pending removal.
* Only the entity expiration system task toggles this flag when it reaches this account
* and finds it expired. Before setting the flag the system task checks if the account has
* an auto-renew account with balance. This is done to prevent a zero-balance account with a funded
* auto-renew account from being treated as expired in the interval between its expiration
* and the time the system task actually auto-renews it.
*
*
* bool expired_and_pending_removal = 32;
* @return The expiredAndPendingRemoval.
*/
boolean getExpiredAndPendingRemoval();
/**
*
**
* The first key in the doubly-linked list of this contract's storage mappings;
* It will be null if if the account is not a contract or the contract has no storage mappings.
*
*
* bytes first_contract_storage_key = 33;
* @return The firstContractStorageKey.
*/
com.google.protobuf.ByteString getFirstContractStorageKey();
/**
*
**
* A pending airdrop ID at the head of the linked list for this account
* from the account airdrops map.<br/>
* The account airdrops are connected by including the "next" and "previous"
* `PendingAirdropID` in each `AccountAirdrop` message.
* <p>
* This value SHALL NOT be empty if this account is "sender" for any
* pending airdrop, and SHALL be empty otherwise.
*
*
* .proto.PendingAirdropId head_pending_airdrop_id = 34;
* @return Whether the headPendingAirdropId field is set.
*/
boolean hasHeadPendingAirdropId();
/**
*
**
* A pending airdrop ID at the head of the linked list for this account
* from the account airdrops map.<br/>
* The account airdrops are connected by including the "next" and "previous"
* `PendingAirdropID` in each `AccountAirdrop` message.
* <p>
* This value SHALL NOT be empty if this account is "sender" for any
* pending airdrop, and SHALL be empty otherwise.
*
*
* .proto.PendingAirdropId head_pending_airdrop_id = 34;
* @return The headPendingAirdropId.
*/
com.hederahashgraph.api.proto.java.PendingAirdropId getHeadPendingAirdropId();
/**
*
**
* A pending airdrop ID at the head of the linked list for this account
* from the account airdrops map.<br/>
* The account airdrops are connected by including the "next" and "previous"
* `PendingAirdropID` in each `AccountAirdrop` message.
* <p>
* This value SHALL NOT be empty if this account is "sender" for any
* pending airdrop, and SHALL be empty otherwise.
*
*
* .proto.PendingAirdropId head_pending_airdrop_id = 34;
*/
com.hederahashgraph.api.proto.java.PendingAirdropIdOrBuilder getHeadPendingAirdropIdOrBuilder();
/**
*
**
* The number of pending airdrops owned by the account. This number is used to collect rent
* for the account.
*
*
* uint64 number_pending_airdrops = 35;
* @return The numberPendingAirdrops.
*/
long getNumberPendingAirdrops();
public com.hederahashgraph.api.proto.java.Account.StakedIdCase getStakedIdCase();
}