Interface MpTokenObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableMpTokenObject

@Immutable public interface MpTokenObject extends LedgerObject
Represents an MPToken ledger object.
  • Method Details

    • builder

      Construct a MpTokenObject builder.
      Returns:
      An ImmutableMpTokenObject.Builder.
    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
    • flags

      MpTokenFlags flags()
      The MpTokenFlags for this token.
      Returns:
      An MpTokenFlags.
    • account

      Address account()
      The Address of the owner of this MPToken.
      Returns:
      An Address.
    • mpTokenIssuanceId

      MpTokenIssuanceId mpTokenIssuanceId()
      The MpTokenIssuanceId of the MPTokenIssuance that this token corresponds to.
      Returns:
      An MpTokenIssuanceId.
    • mptAmount

      @Default default MpTokenNumericAmount mptAmount()
      The balance of this MPToken. Defaults to 0.
      Returns:
      An MpTokenNumericAmount.
    • lockedAmount

      The amount of this MPToken that is locked in escrows. This field tracks the total amount held in escrows for this specific holder.
      Returns:
      An optionally-present MpTokenNumericAmount.
    • 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.
    • ownerNode

      Optional<String> ownerNode()
      A hint indicating which page of the owner directory links to this object, in case the directory consists of multiple pages.

      Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.

      Returns:
      An Optional of type String containing the owner node hint.
    • index

      Hash256 index()
      The unique ID of this MpTokenObject.
      Returns:
      A Hash256 containing the ID.