Package org.xrpl.xrpl4j.model.ledger
Interface MpTokenIssuanceObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableMpTokenIssuanceObject
Represents an
MPTokenIssuance.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptiondefault AssetScaleTheAssetScaleof the issuance.builder()Construct aMetaMpTokenIssuanceObjectbuilder.flags()TheMpTokenIssuanceFlagsfor this issuance.index()The unique ID of thisMpTokenIssuanceObject.issuer()TheAddressof the issuer of this token.default LedgerObject.LedgerEntryTypeThe total amount of this MPT that is locked in escrows across all holders.The maximum number of this issuance that can be distributed to non-issuing accounts.TheMpTokenIssuanceIdof the issuance.Arbitrary hex-encoded metadata about this issuance.The sum of all token amounts that have been minted to all token holders.A hint indicating which page of the owner directory links to this object, in case the directory consists of multiple pages.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.com.google.common.primitives.UnsignedIntegersequence()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.default TransferFeeThe fee that this issuance charges for secondary sales of the token.
-
Method Details
-
builder
Construct aMetaMpTokenIssuanceObjectbuilder.- Returns:
- An
ImmutableMpTokenIssuanceObject.Builder.
-
ledgerEntryType
-
flags
MpTokenIssuanceFlags flags()TheMpTokenIssuanceFlagsfor this issuance.- Returns:
- An
MpTokenIssuanceFlags.
-
issuer
Address issuer()TheAddressof 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
UnsignedIntegerrepresenting the account sequence number.
-
transferFee
The fee that this issuance charges for secondary sales of the token.- Returns:
- A
TransferFee.
-
assetScale
TheAssetScaleof 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
Optional<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 thatoutstandingAmount()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
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.
-
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.
-
index
Hash256 index()The unique ID of thisMpTokenIssuanceObject.- Returns:
- A
Hash256containing the ID.
-
mpTokenIssuanceId
Optional<MpTokenIssuanceId> mpTokenIssuanceId()TheMpTokenIssuanceIdof the issuance. Only present in responses toledger_dataandaccount_objectsRPC calls.- Returns:
- An
OptionalMpTokenIssuanceId.
-