Package org.xrpl.xrpl4j.model.ledger
Interface AccountRootObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableAccountRootObject
Represents the AccountRoot ledger object, which describes a single account, its settings, and XRP balance.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionaccount()The unique classicAddressof this account.The identifying hash of the transaction most recently sent by this account.ammId()The ledger entry ID of the corresponding AMM ledger entry.balance()The account's current XRP balance in drops, represented as anXrpCurrencyAmount.builder()Construct a builder for this class.Optional<com.google.common.primitives.UnsignedInteger> How many total of this account's issued non-fungible tokens have been burned.domain()A domain associated with this account.The md5 hash of an email address.flags()A bit-map of booleanAccountRootFlagsenabled for this account.index()The unique ID of thisAccountRootObjectledger object.default LedgerObject.LedgerEntryTypeThe type of ledger object, which will always be "AccountRoot" in this case.A public key that may be used to send encrypted messages to this account.Optional<com.google.common.primitives.UnsignedInteger> How many total non-fungible tokens have been minted by and on behalf of this account.Another account that can mint non-fungible tokens on behalf of this account.com.google.common.primitives.UnsignedIntegerThe number of objects this account owns in the ledger, which contributes to its owner reserve.The identifying hash of the transaction that most recently modified this object.com.google.common.primitives.UnsignedIntegerThe index of the ledger that contains the transaction that most recently modified this object.The address of a key pair that can be used to signTransactions for this account instead of the master key.com.google.common.primitives.UnsignedIntegersequence()The sequence number of the next valid transaction for this account.(Omitted unless the request specified signer_lists and at least one SignerList is associated with the account.) Array ofSignerListObjectledger objects associated with this account for Multi-Signing.Optional<com.google.common.primitives.UnsignedInteger> How many Tickets this account owns in the ledger.Optional<com.google.common.primitives.UnsignedInteger> tickSize()How many significant digits to use for exchange rates of Offers involving currencies issued by this address.Optional<com.google.common.primitives.UnsignedInteger> A transfer fee to charge other users for sending currency issued by this account to each other.An arbitrary 256-bit value that users can set.
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableAccountRootObject.Builder.
-
ledgerEntryType
The type of ledger object, which will always be "AccountRoot" in this case.- Returns:
- Always returns
LedgerObject.LedgerEntryType.ACCOUNT_ROOT.
-
account
Address account()The unique classicAddressof this account.- Returns:
- The
Addressof this account.
-
balance
XrpCurrencyAmount balance()The account's current XRP balance in drops, represented as anXrpCurrencyAmount.- Returns:
- An
XrpCurrencyAmountrepresenting the account's XRP balance.
-
flags
AccountRootFlags flags()A bit-map of booleanAccountRootFlagsenabled for this account.- Returns:
- An
AccountRootFlags.
-
ownerCount
com.google.common.primitives.UnsignedInteger ownerCount()The number of objects this account owns in the ledger, which contributes to its owner reserve.- Returns:
- An
UnsignedIntegerrepresenting the number of objects.
-
previousTransactionId
Hash256 previousTransactionId()The identifying hash of the transaction that most recently modified this object.- Returns:
- A
Hash256containing the previous transaction hash.
-
previousTransactionLedgerSequence
com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()The index of the ledger that contains the transaction that most recently modified this object.- Returns:
- An
UnsignedIntegerrepresenting the previous transaction ledger sequence.
-
sequence
com.google.common.primitives.UnsignedInteger sequence()The sequence number of the next valid transaction for this account. (Each account starts with Sequence = 1 and increases each time a transaction is made.)- Returns:
- An
UnsignedIntegerrepresenting the account sequence number.
-
accountTransactionId
The identifying hash of the transaction most recently sent by this account. This field must be enabled to use theTransaction.accountTransactionId()field. To enable it, send anAccountSettransaction withAccountSet.setFlag()equal toAccountSet.AccountSetFlag.ACCOUNT_TXN_ID. -
domain
A domain associated with this account. In JSON, this is the hexadecimal for the ASCII representation of the domain. -
emailHash
The md5 hash of an email address. Clients can use this to look up an avatar through services such as Gravatar. -
messageKey
A public key that may be used to send encrypted messages to this account. No more than 33 bytes. -
regularKey
The address of a key pair that can be used to signTransactions for this account instead of the master key. -
tickSize
Optional<com.google.common.primitives.UnsignedInteger> tickSize()How many significant digits to use for exchange rates of Offers involving currencies issued by this address. Valid values are 3 to 15, inclusive.- Returns:
- An
Optionalof typeUnsignedInteger.
-
transferRate
Optional<com.google.common.primitives.UnsignedInteger> transferRate()A transfer fee to charge other users for sending currency issued by this account to each other.- Returns:
- An
Optionalof typeUnsignedInteger.
-
signerLists
List<SignerListObject> signerLists()(Omitted unless the request specified signer_lists and at least one SignerList is associated with the account.) Array ofSignerListObjectledger objects associated with this account for Multi-Signing. Since an account can own at most one SignerList, this array must have exactly one member if it is present.- Returns:
- A
ListofSignerListObjects.
-
ticketCount
Optional<com.google.common.primitives.UnsignedInteger> ticketCount()How many Tickets this account owns in the ledger. This is updated automatically to ensure that the account stays within the hard limit of 250 Tickets at a time. This field is omitted if the account has zero Tickets.- Returns:
- An optionally-present
UnsignedIntegerrepresenting the number of tickets this account owns.
-
burnedNfTokens
Optional<com.google.common.primitives.UnsignedInteger> burnedNfTokens()How many total of this account's issued non-fungible tokens have been burned. This number is always equal or less thanmintedNfTokens().- Returns:
- An optionally-present
UnsignedIntegerrepresenting the number of NFTs this account has burned.
-
mintedNfTokens
Optional<com.google.common.primitives.UnsignedInteger> mintedNfTokens()How many total non-fungible tokens have been minted by and on behalf of this account.- Returns:
- An optionally-present
UnsignedIntegerrepresenting the number of NFTs this account has minted.
-
nfTokenMinter
Another account that can mint non-fungible tokens on behalf of this account.- Returns:
- The optionally-present
Addressof the account that can mint NFTs on behalf of this account.
-
ammId
The ledger entry ID of the corresponding AMM ledger entry. Set during account creation; cannot be modified. If present, indicates that this is a special AMM AccountRoot; always omitted on non-AMM accounts.This method will be marked
Betauntil the AMM amendment is enabled on mainnet. Its API is subject to change.- Returns:
- An optionally-present
Hash256.
-
walletLocator
An arbitrary 256-bit value that users can set. -
index
Hash256 index()The unique ID of thisAccountRootObjectledger object.- Returns:
- A
Hash256. - See Also:
-