Interface AccountRootObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableAccountRootObject

@Immutable public interface AccountRootObject extends LedgerObject
Represents the AccountRoot ledger object, which describes a single account, its settings, and XRP balance.
  • Method Details

    • builder

      Construct a builder for this class.
      Returns:
      An ImmutableAccountRootObject.Builder.
    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType 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 classic Address of this account.
      Returns:
      The Address of this account.
    • balance

      The account's current XRP balance in drops, represented as an XrpCurrencyAmount.
      Returns:
      An XrpCurrencyAmount representing the account's XRP balance.
    • flags

      A bit-map of boolean AccountRootFlags enabled 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 UnsignedInteger representing the number of objects.
    • previousTransactionId

      Hash256 previousTransactionId()
      The identifying hash of the transaction that most recently modified this object.
      Returns:
      A Hash256 containing 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 UnsignedInteger representing 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 UnsignedInteger representing the account sequence number.
    • accountTransactionId

      Optional<Hash256> accountTransactionId()
      The identifying hash of the transaction most recently sent by this account. This field must be enabled to use the Transaction.accountTransactionId() field. To enable it, send an AccountSet transaction with AccountSet.setFlag() equal to AccountSet.AccountSetFlag.ACCOUNT_TXN_ID.
      Returns:
      An Optional of type Hash256.
    • domain

      Optional<String> domain()
      A domain associated with this account. In JSON, this is the hexadecimal for the ASCII representation of the domain.
      Returns:
      An Optional of type String containing the domain.
    • emailHash

      Optional<String> emailHash()
      The md5 hash of an email address. Clients can use this to look up an avatar through services such as Gravatar.
      Returns:
      An Optional of type String.
    • messageKey

      Optional<String> messageKey()
      A public key that may be used to send encrypted messages to this account. No more than 33 bytes.
      Returns:
      An Optional of type String.
    • regularKey

      Optional<Address> regularKey()
      The address of a key pair that can be used to sign Transactions for this account instead of the master key.
      Returns:
      An Optional of type Address.
    • 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 Optional of type UnsignedInteger.
    • 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 Optional of type UnsignedInteger.
    • signerLists

      List<SignerListObject> signerLists()
      (Omitted unless the request specified signer_lists and at least one SignerList is associated with the account.) Array of SignerListObject ledger 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 List of SignerListObjects.
    • 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 UnsignedInteger representing 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 than mintedNfTokens().
      Returns:
      An optionally-present UnsignedInteger representing 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 UnsignedInteger representing the number of NFTs this account has minted.
    • nfTokenMinter

      Optional<Address> nfTokenMinter()
      Another account that can mint non-fungible tokens on behalf of this account.
      Returns:
      The optionally-present Address of the account that can mint NFTs on behalf of this account.
    • ammId

      @Beta Optional<Hash256> 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 Beta until the AMM amendment is enabled on mainnet. Its API is subject to change.

      Returns:
      An optionally-present Hash256.
    • walletLocator

      Optional<String> walletLocator()
      An arbitrary 256-bit value that users can set.
      Returns:
      An Optional String.
    • index

      Hash256 index()
      The unique ID of this AccountRootObject ledger object.
      Returns:
      A Hash256.
      See Also:
      • "https://xrpl.org/ledger-object-ids.html"