#include <MPTokenIssuance.h>

Inheritance diagram for xrpl::ledger_entries::MPTokenIssuance:

Collaboration diagram for xrpl::ledger_entries::MPTokenIssuance:

[legend]

Public Member Functions
	MPTokenIssuance (SLE::const_pointer sle)
	Construct a MPTokenIssuance ledger entry wrapper from an existing SLE object.
SF_ACCOUNT::type::value_type	getIssuer () const
	Get sfIssuer (SoeRequired).
SF_UINT32::type::value_type	getSequence () const
	Get sfSequence (SoeRequired).
protocol_autogen::Optional< SF_UINT16::type::value_type >	getTransferFee () const
	Get sfTransferFee (SoeDefault).
bool	hasTransferFee () const
	Check if sfTransferFee is present.
SF_UINT64::type::value_type	getOwnerNode () const
	Get sfOwnerNode (SoeRequired).
protocol_autogen::Optional< SF_UINT8::type::value_type >	getAssetScale () const
	Get sfAssetScale (SoeDefault).
bool	hasAssetScale () const
	Check if sfAssetScale is present.
protocol_autogen::Optional< SF_UINT64::type::value_type >	getMaximumAmount () const
	Get sfMaximumAmount (SoeOptional).
bool	hasMaximumAmount () const
	Check if sfMaximumAmount is present.
SF_UINT64::type::value_type	getOutstandingAmount () const
	Get sfOutstandingAmount (SoeRequired).
protocol_autogen::Optional< SF_UINT64::type::value_type >	getLockedAmount () const
	Get sfLockedAmount (SoeOptional).
bool	hasLockedAmount () const
	Check if sfLockedAmount is present.
protocol_autogen::Optional< SF_VL::type::value_type >	getMPTokenMetadata () const
	Get sfMPTokenMetadata (SoeOptional).
bool	hasMPTokenMetadata () const
	Check if sfMPTokenMetadata is present.
SF_UINT256::type::value_type	getPreviousTxnID () const
	Get sfPreviousTxnID (SoeRequired).
SF_UINT32::type::value_type	getPreviousTxnLgrSeq () const
	Get sfPreviousTxnLgrSeq (SoeRequired).
protocol_autogen::Optional< SF_UINT256::type::value_type >	getDomainID () const
	Get sfDomainID (SoeOptional).
bool	hasDomainID () const
	Check if sfDomainID is present.
protocol_autogen::Optional< SF_UINT32::type::value_type >	getMutableFlags () const
	Get sfMutableFlags (SoeDefault).
bool	hasMutableFlags () const
	Check if sfMutableFlags is present.
protocol_autogen::Optional< SF_UINT256::type::value_type >	getReferenceHolding () const
	Get sfReferenceHolding (SoeOptional).
bool	hasReferenceHolding () const
	Check if sfReferenceHolding is present.
protocol_autogen::Optional< SF_VL::type::value_type >	getIssuerEncryptionKey () const
	Get sfIssuerEncryptionKey (SoeOptional).
bool	hasIssuerEncryptionKey () const
	Check if sfIssuerEncryptionKey is present.
protocol_autogen::Optional< SF_VL::type::value_type >	getAuditorEncryptionKey () const
	Get sfAuditorEncryptionKey (SoeOptional).
bool	hasAuditorEncryptionKey () const
	Check if sfAuditorEncryptionKey is present.
protocol_autogen::Optional< SF_UINT64::type::value_type >	getConfidentialOutstandingAmount () const
	Get sfConfidentialOutstandingAmount (SoeDefault).
bool	hasConfidentialOutstandingAmount () const
	Check if sfConfidentialOutstandingAmount is present.
bool	validate () const
	Validate the ledger entry.
LedgerEntryType	getType () const
	Get the ledger entry type.
uint256 const &	getKey () const
	Get the key (index) of this ledger entry.
std::optional< uint256 >	getLedgerIndex () const
	Get the ledger index (sfLedgerIndex).
bool	hasLedgerIndex () const
	Check if the ledger entry has a ledger index.
uint16_t	getLedgerEntryType () const
	Get the ledger entry type field (sfLedgerEntryType).
std::uint32_t	getFlags () const
	Get the flags field (sfFlags).
bool	isFlag (std::uint32_t f) const
	Check if a specific flag is set.
SLE::const_pointer	getSle () const
	Get the underlying SLE object.

Static Public Attributes
static constexpr LedgerEntryType	entryType = ltMPTOKEN_ISSUANCE

Protected Attributes
SLE::const_pointer	sle_
	The underlying serialized ledger entry being wrapped.

Detailed Description

Ledger Entry: MPTokenIssuance.

Type: ltMPTOKEN_ISSUANCE (0x007e) RPC Name: mpt_issuance

Immutable wrapper around SLE providing type-safe field access. Use MPTokenIssuanceBuilder to construct new ledger entries.

Definition at line 27 of file MPTokenIssuance.h.

Constructor & Destructor Documentation

◆ MPTokenIssuance()

xrpl::ledger_entries::MPTokenIssuance::MPTokenIssuance ( SLE::const_pointer sle )

explicit

Construct a MPTokenIssuance ledger entry wrapper from an existing SLE object.

Exceptions

std::runtime_error if the ledger entry type doesn't match.

Definition at line 36 of file MPTokenIssuance.h.

Member Function Documentation

◆ getIssuer()

SF_ACCOUNT::type::value_type xrpl::ledger_entries::MPTokenIssuance::getIssuer ( ) const

nodiscard

Get sfIssuer (SoeRequired).

Returns: The field value.

Definition at line 54 of file MPTokenIssuance.h.

◆ getSequence()

SF_UINT32::type::value_type xrpl::ledger_entries::MPTokenIssuance::getSequence ( ) const

nodiscard

Get sfSequence (SoeRequired).

Returns: The field value.

Definition at line 65 of file MPTokenIssuance.h.

◆ getTransferFee()

protocol_autogen::Optional< SF_UINT16::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getTransferFee ( ) const

nodiscard

Get sfTransferFee (SoeDefault).

Returns: The field value, or std::nullopt if not present.

Definition at line 76 of file MPTokenIssuance.h.

◆ hasTransferFee()

bool xrpl::ledger_entries::MPTokenIssuance::hasTransferFee ( ) const

nodiscard

Check if sfTransferFee is present.

Returns: True if the field is present, false otherwise.

Definition at line 89 of file MPTokenIssuance.h.

◆ getOwnerNode()

SF_UINT64::type::value_type xrpl::ledger_entries::MPTokenIssuance::getOwnerNode ( ) const

nodiscard

Get sfOwnerNode (SoeRequired).

Returns: The field value.

Definition at line 100 of file MPTokenIssuance.h.

◆ getAssetScale()

protocol_autogen::Optional< SF_UINT8::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getAssetScale ( ) const

nodiscard

Get sfAssetScale (SoeDefault).

Returns: The field value, or std::nullopt if not present.

Definition at line 111 of file MPTokenIssuance.h.

◆ hasAssetScale()

bool xrpl::ledger_entries::MPTokenIssuance::hasAssetScale ( ) const

nodiscard

Check if sfAssetScale is present.

Returns: True if the field is present, false otherwise.

Definition at line 124 of file MPTokenIssuance.h.

◆ getMaximumAmount()

protocol_autogen::Optional< SF_UINT64::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getMaximumAmount ( ) const

nodiscard

Get sfMaximumAmount (SoeOptional).

Returns: The field value, or std::nullopt if not present.

Definition at line 135 of file MPTokenIssuance.h.

◆ hasMaximumAmount()

bool xrpl::ledger_entries::MPTokenIssuance::hasMaximumAmount ( ) const

nodiscard

Check if sfMaximumAmount is present.

Returns: True if the field is present, false otherwise.

Definition at line 148 of file MPTokenIssuance.h.

◆ getOutstandingAmount()

SF_UINT64::type::value_type xrpl::ledger_entries::MPTokenIssuance::getOutstandingAmount ( ) const

nodiscard

Get sfOutstandingAmount (SoeRequired).

Returns: The field value.

Definition at line 159 of file MPTokenIssuance.h.

◆ getLockedAmount()

protocol_autogen::Optional< SF_UINT64::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getLockedAmount ( ) const

nodiscard

Get sfLockedAmount (SoeOptional).

Returns: The field value, or std::nullopt if not present.

Definition at line 170 of file MPTokenIssuance.h.

◆ hasLockedAmount()

bool xrpl::ledger_entries::MPTokenIssuance::hasLockedAmount ( ) const

nodiscard

Check if sfLockedAmount is present.

Returns: True if the field is present, false otherwise.

Definition at line 183 of file MPTokenIssuance.h.

◆ getMPTokenMetadata()

protocol_autogen::Optional< SF_VL::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getMPTokenMetadata ( ) const

nodiscard

Get sfMPTokenMetadata (SoeOptional).

Returns: The field value, or std::nullopt if not present.

Definition at line 194 of file MPTokenIssuance.h.

◆ hasMPTokenMetadata()

bool xrpl::ledger_entries::MPTokenIssuance::hasMPTokenMetadata ( ) const

nodiscard

Check if sfMPTokenMetadata is present.

Returns: True if the field is present, false otherwise.

Definition at line 207 of file MPTokenIssuance.h.

◆ getPreviousTxnID()

SF_UINT256::type::value_type xrpl::ledger_entries::MPTokenIssuance::getPreviousTxnID ( ) const

nodiscard

Get sfPreviousTxnID (SoeRequired).

Returns: The field value.

Definition at line 218 of file MPTokenIssuance.h.

◆ getPreviousTxnLgrSeq()

SF_UINT32::type::value_type xrpl::ledger_entries::MPTokenIssuance::getPreviousTxnLgrSeq ( ) const

nodiscard

Get sfPreviousTxnLgrSeq (SoeRequired).

Returns: The field value.

Definition at line 229 of file MPTokenIssuance.h.

◆ getDomainID()

protocol_autogen::Optional< SF_UINT256::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getDomainID ( ) const

nodiscard

Get sfDomainID (SoeOptional).

Returns: The field value, or std::nullopt if not present.

Definition at line 240 of file MPTokenIssuance.h.

◆ hasDomainID()

bool xrpl::ledger_entries::MPTokenIssuance::hasDomainID ( ) const

nodiscard

Check if sfDomainID is present.

Returns: True if the field is present, false otherwise.

Definition at line 253 of file MPTokenIssuance.h.

◆ getMutableFlags()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getMutableFlags ( ) const

nodiscard

Get sfMutableFlags (SoeDefault).

Returns: The field value, or std::nullopt if not present.

Definition at line 264 of file MPTokenIssuance.h.

◆ hasMutableFlags()

bool xrpl::ledger_entries::MPTokenIssuance::hasMutableFlags ( ) const

nodiscard

Check if sfMutableFlags is present.

Returns: True if the field is present, false otherwise.

Definition at line 277 of file MPTokenIssuance.h.

◆ getReferenceHolding()

protocol_autogen::Optional< SF_UINT256::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getReferenceHolding ( ) const

nodiscard

Get sfReferenceHolding (SoeOptional).

Returns: The field value, or std::nullopt if not present.

Definition at line 288 of file MPTokenIssuance.h.

◆ hasReferenceHolding()

bool xrpl::ledger_entries::MPTokenIssuance::hasReferenceHolding ( ) const

nodiscard

Check if sfReferenceHolding is present.

Returns: True if the field is present, false otherwise.

Definition at line 301 of file MPTokenIssuance.h.

◆ getIssuerEncryptionKey()

protocol_autogen::Optional< SF_VL::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getIssuerEncryptionKey ( ) const

nodiscard

Get sfIssuerEncryptionKey (SoeOptional).

Returns: The field value, or std::nullopt if not present.

Definition at line 312 of file MPTokenIssuance.h.

◆ hasIssuerEncryptionKey()

bool xrpl::ledger_entries::MPTokenIssuance::hasIssuerEncryptionKey ( ) const

nodiscard

Check if sfIssuerEncryptionKey is present.

Returns: True if the field is present, false otherwise.

Definition at line 325 of file MPTokenIssuance.h.

◆ getAuditorEncryptionKey()

protocol_autogen::Optional< SF_VL::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getAuditorEncryptionKey ( ) const

nodiscard

Get sfAuditorEncryptionKey (SoeOptional).

Returns: The field value, or std::nullopt if not present.

Definition at line 336 of file MPTokenIssuance.h.

◆ hasAuditorEncryptionKey()

bool xrpl::ledger_entries::MPTokenIssuance::hasAuditorEncryptionKey ( ) const

nodiscard

Check if sfAuditorEncryptionKey is present.

Returns: True if the field is present, false otherwise.

Definition at line 349 of file MPTokenIssuance.h.

◆ getConfidentialOutstandingAmount()

protocol_autogen::Optional< SF_UINT64::type::value_type > xrpl::ledger_entries::MPTokenIssuance::getConfidentialOutstandingAmount ( ) const

nodiscard

Get sfConfidentialOutstandingAmount (SoeDefault).

Returns: The field value, or std::nullopt if not present.

Definition at line 360 of file MPTokenIssuance.h.

◆ hasConfidentialOutstandingAmount()

bool xrpl::ledger_entries::MPTokenIssuance::hasConfidentialOutstandingAmount ( ) const

nodiscard

Check if sfConfidentialOutstandingAmount is present.

Returns: True if the field is present, false otherwise.

Definition at line 373 of file MPTokenIssuance.h.

◆ validate()

bool xrpl::ledger_entries::LedgerEntryBase::validate ( ) const

nodiscardinherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 40 of file LedgerEntryBase.h.

◆ getType()

LedgerEntryType xrpl::ledger_entries::LedgerEntryBase::getType ( ) const

nodiscardinherited

Get the ledger entry type.

Returns: The type of this ledger entry

Definition at line 57 of file LedgerEntryBase.h.

◆ getKey()

uint256 const & xrpl::ledger_entries::LedgerEntryBase::getKey ( ) const

nodiscardinherited

Get the key (index) of this ledger entry.

The key uniquely identifies this ledger entry in the ledger state.

Returns: A constant reference to the 256-bit key

Definition at line 70 of file LedgerEntryBase.h.

◆ getLedgerIndex()

std::optional< uint256 > xrpl::ledger_entries::LedgerEntryBase::getLedgerIndex ( ) const

nodiscardinherited

Get the ledger index (sfLedgerIndex).

This field is OPTIONAL and represents the index of the ledger entry.

Returns: The ledger index if present, std::nullopt otherwise

Definition at line 85 of file LedgerEntryBase.h.

◆ hasLedgerIndex()

bool xrpl::ledger_entries::LedgerEntryBase::hasLedgerIndex ( ) const

nodiscardinherited

Check if the ledger entry has a ledger index.

Returns: true if sfLedgerIndex is present, false otherwise

Definition at line 100 of file LedgerEntryBase.h.

◆ getLedgerEntryType()

uint16_t xrpl::ledger_entries::LedgerEntryBase::getLedgerEntryType ( ) const

nodiscardinherited

Get the ledger entry type field (sfLedgerEntryType).

This field is REQUIRED for all ledger entries and indicates the type of the ledger entry (e.g., AccountRoot, RippleState, Offer, etc.).

Returns: The ledger entry type as a 16-bit unsigned integer

Definition at line 114 of file LedgerEntryBase.h.

◆ getFlags()

std::uint32_t xrpl::ledger_entries::LedgerEntryBase::getFlags ( ) const

nodiscardinherited

Get the flags field (sfFlags).

This field is REQUIRED for all ledger entries and contains type-specific flags that modify the behavior of the ledger entry.

Returns: The flags value as a 32-bit unsigned integer

Definition at line 128 of file LedgerEntryBase.h.

◆ isFlag()

bool xrpl::ledger_entries::LedgerEntryBase::isFlag ( std::uint32_t f ) const

nodiscardinherited

Check if a specific flag is set.

Parameters

f	The flag bitmask to check

Returns: true if all bits in f are set in the flags field

Definition at line 141 of file LedgerEntryBase.h.

◆ getSle()

SLE::const_pointer xrpl::ledger_entries::LedgerEntryBase::getSle ( ) const

nodiscardinherited

Get the underlying SLE object.

Provides direct access to the wrapped serialized ledger entry object for cases where the type-safe accessors are insufficient.

Returns: A constant reference to the underlying SLE object

Definition at line 155 of file LedgerEntryBase.h.

Member Data Documentation

◆ entryType

LedgerEntryType xrpl::ledger_entries::MPTokenIssuance::entryType = ltMPTOKEN_ISSUANCE

staticconstexpr

Definition at line 30 of file MPTokenIssuance.h.

◆ sle_

SLE::const_pointer xrpl::ledger_entries::LedgerEntryBase::sle_

protectedinherited

The underlying serialized ledger entry being wrapped.

Definition at line 162 of file LedgerEntryBase.h.

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MPTokenIssuance()

Member Function Documentation

◆ getIssuer()

◆ getSequence()

◆ getTransferFee()

◆ hasTransferFee()

◆ getOwnerNode()

◆ getAssetScale()

◆ hasAssetScale()

◆ getMaximumAmount()

◆ hasMaximumAmount()

◆ getOutstandingAmount()

◆ getLockedAmount()

◆ hasLockedAmount()

◆ getMPTokenMetadata()

◆ hasMPTokenMetadata()

◆ getPreviousTxnID()

◆ getPreviousTxnLgrSeq()

◆ getDomainID()

◆ hasDomainID()

◆ getMutableFlags()

◆ hasMutableFlags()

◆ getReferenceHolding()

◆ hasReferenceHolding()

◆ getIssuerEncryptionKey()

◆ hasIssuerEncryptionKey()

◆ getAuditorEncryptionKey()

◆ hasAuditorEncryptionKey()

◆ getConfidentialOutstandingAmount()

◆ hasConfidentialOutstandingAmount()

◆ validate()

◆ getType()

◆ getKey()

◆ getLedgerIndex()

◆ hasLedgerIndex()

◆ getLedgerEntryType()

◆ getFlags()

◆ isFlag()

◆ getSle()

Member Data Documentation

◆ entryType

◆ sle_