Interface MpTokenIssuanceObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableMpTokenIssuanceObject

@Immutable public interface MpTokenIssuanceObject extends LedgerObject
Represents an MPTokenIssuance.
  • Method Details

    • builder

      Construct a MetaMpTokenIssuanceObject builder.
      Returns:
      An ImmutableMpTokenIssuanceObject.Builder.
    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
    • flags

      The MpTokenIssuanceFlags for this issuance.
      Returns:
      An MpTokenIssuanceFlags.
    • issuer

      Address issuer()
      The Address of the issuer of this token.
      Returns:
      An Address.
    • sequence

      com.google.common.primitives.UnsignedInteger sequence()
      A 32-bit unsigned integer that is used to ensure issuances from a given sender may only ever exist once, even if an issuance is later deleted. Whenever a new issuance is created, this value must match the account's current Sequence number.
      Returns:
      An UnsignedInteger representing the account sequence number.
    • transferFee

      @Default default TransferFee transferFee()
      The fee that this issuance charges for secondary sales of the token.
      Returns:
      A TransferFee.
    • assetScale

      @Default default AssetScale assetScale()
      The AssetScale of the issuance.
      Returns:
      An AssetScale.
    • maximumAmount

      Optional<MpTokenNumericAmount> maximumAmount()
      The maximum number of this issuance that can be distributed to non-issuing accounts.
      Returns:
      An optionally present MpTokenNumericAmount.
    • outstandingAmount

      MpTokenNumericAmount outstandingAmount()
      The sum of all token amounts that have been minted to all token holders.
      Returns:
      An MpTokenNumericAmount.
    • lockedAmount

      The total amount of this MPT that is locked in escrows across all holders. This field tracks the aggregate amount held in escrows for this issuance. Note that outstandingAmount() remains unchanged during escrow operations.
      Returns:
      An optionally-present MpTokenNumericAmount.
    • mpTokenMetadata

      Optional<MpTokenMetadata> mpTokenMetadata()
      Arbitrary hex-encoded metadata about this issuance.
      Returns:
      An optionally-present MpTokenMetadata.
    • 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 MpTokenIssuanceObject.
      Returns:
      A Hash256 containing the ID.
    • mpTokenIssuanceId

      Optional<MpTokenIssuanceId> mpTokenIssuanceId()
      The MpTokenIssuanceId of the issuance. Only present in responses to ledger_data and account_objects RPC calls.
      Returns:
      An Optional MpTokenIssuanceId.