Builder for MPToken ledger entries. More...

#include <MPToken.h>

Inheritance diagram for xrpl::ledger_entries::MPTokenBuilder:

Collaboration diagram for xrpl::ledger_entries::MPTokenBuilder:

[legend]

Public Member Functions
	MPTokenBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, std::decay_t< typename SF_UINT192::type::value_type > const &mPTokenIssuanceID, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, std::decay_t< typename SF_UINT256::type::value_type > const &previousTxnID, std::decay_t< typename SF_UINT32::type::value_type > const &previousTxnLgrSeq)
	Construct a new MPTokenBuilder with required fields.
	MPTokenBuilder (SLE::const_pointer sle)
	Construct a MPTokenBuilder from an existing SLE object.
MPTokenBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
MPTokenBuilder &	setMPTokenIssuanceID (std::decay_t< typename SF_UINT192::type::value_type > const &value)
	Set sfMPTokenIssuanceID (SoeRequired).
MPTokenBuilder &	setMPTAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfMPTAmount (SoeDefault).
MPTokenBuilder &	setLockedAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfLockedAmount (SoeOptional).
MPTokenBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (SoeRequired).
MPTokenBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (SoeRequired).
MPTokenBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (SoeRequired).
MPTokenBuilder &	setConfidentialBalanceInbox (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfConfidentialBalanceInbox (SoeOptional).
MPTokenBuilder &	setConfidentialBalanceSpending (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfConfidentialBalanceSpending (SoeOptional).
MPTokenBuilder &	setConfidentialBalanceVersion (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfConfidentialBalanceVersion (SoeDefault).
MPTokenBuilder &	setIssuerEncryptedBalance (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfIssuerEncryptedBalance (SoeOptional).
MPTokenBuilder &	setAuditorEncryptedBalance (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfAuditorEncryptedBalance (SoeOptional).
MPTokenBuilder &	setIssuerKeyMirrorEpoch (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfIssuerKeyMirrorEpoch (SoeOptional).
MPTokenBuilder &	setAuditorKeyMirrorEpoch (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfAuditorKeyMirrorEpoch (SoeOptional).
MPTokenBuilder &	setHolderEncryptionKey (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfHolderEncryptionKey (SoeOptional).
MPTokenBuilder &	setRecoveryKey (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfRecoveryKey (SoeOptional).
MPToken	build (UInt256 const &index)
	Build and return the completed MPToken wrapper.
bool	validate () const
	Validate the ledger entry.
MPTokenBuilder &	setLedgerIndex (UInt256 const &value)
	Set the ledger index.
MPTokenBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for MPToken ledger entries.

Provides a fluent interface for constructing ledger entries with method chaining. Uses STObject internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 375 of file MPToken.h.

Constructor & Destructor Documentation

◆ MPTokenBuilder() [1/2]

xrpl::ledger_entries::MPTokenBuilder::MPTokenBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		std::decay_t< typename SF_UINT192::type::value_type > const &	mPTokenIssuanceID,
		std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode,
		std::decay_t< typename SF_UINT256::type::value_type > const &	previousTxnID,
		std::decay_t< typename SF_UINT32::type::value_type > const &	previousTxnLgrSeq )

Construct a new MPTokenBuilder with required fields.

Parameters

account	The sfAccount field value.
mPTokenIssuanceID	The sfMPTokenIssuanceID field value.
ownerNode	The sfOwnerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 386 of file MPToken.h.

◆ MPTokenBuilder() [2/2]

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

Construct a MPTokenBuilder from an existing SLE object.

Parameters

sle	The existing ledger entry to copy from.

Exceptions

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

Definition at line 401 of file MPToken.h.

Member Function Documentation

◆ setAccount()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setAccount ( std::decay_t< typename SF_ACCOUNT::type::value_type > const & value )

Ledger entry-specific field setters.

Set sfAccount (SoeRequired)

Returns: Reference to this builder for method chaining.

Definition at line 419 of file MPToken.h.

◆ setMPTokenIssuanceID()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setMPTokenIssuanceID ( std::decay_t< typename SF_UINT192::type::value_type > const & value )

Set sfMPTokenIssuanceID (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 430 of file MPToken.h.

◆ setMPTAmount()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setMPTAmount ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfMPTAmount (SoeDefault).

Returns: Reference to this builder for method chaining.

Definition at line 441 of file MPToken.h.

◆ setLockedAmount()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setLockedAmount ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfLockedAmount (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 452 of file MPToken.h.

◆ setOwnerNode()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setOwnerNode ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfOwnerNode (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 463 of file MPToken.h.

◆ setPreviousTxnID()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setPreviousTxnID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfPreviousTxnID (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 474 of file MPToken.h.

◆ setPreviousTxnLgrSeq()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setPreviousTxnLgrSeq ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfPreviousTxnLgrSeq (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 485 of file MPToken.h.

◆ setConfidentialBalanceInbox()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setConfidentialBalanceInbox ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfConfidentialBalanceInbox (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 496 of file MPToken.h.

◆ setConfidentialBalanceSpending()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setConfidentialBalanceSpending ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfConfidentialBalanceSpending (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 507 of file MPToken.h.

◆ setConfidentialBalanceVersion()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setConfidentialBalanceVersion ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfConfidentialBalanceVersion (SoeDefault).

Returns: Reference to this builder for method chaining.

Definition at line 518 of file MPToken.h.

◆ setIssuerEncryptedBalance()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setIssuerEncryptedBalance ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfIssuerEncryptedBalance (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 529 of file MPToken.h.

◆ setAuditorEncryptedBalance()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setAuditorEncryptedBalance ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfAuditorEncryptedBalance (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 540 of file MPToken.h.

◆ setIssuerKeyMirrorEpoch()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setIssuerKeyMirrorEpoch ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfIssuerKeyMirrorEpoch (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 551 of file MPToken.h.

◆ setAuditorKeyMirrorEpoch()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setAuditorKeyMirrorEpoch ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfAuditorKeyMirrorEpoch (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 562 of file MPToken.h.

◆ setHolderEncryptionKey()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setHolderEncryptionKey ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfHolderEncryptionKey (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 573 of file MPToken.h.

◆ setRecoveryKey()

MPTokenBuilder & xrpl::ledger_entries::MPTokenBuilder::setRecoveryKey ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfRecoveryKey (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 584 of file MPToken.h.

◆ build()

MPToken xrpl::ledger_entries::MPTokenBuilder::build ( UInt256 const & index )

Build and return the completed MPToken wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 596 of file MPToken.h.

◆ validate()

bool xrpl::ledger_entries::LedgerEntryBuilderBase< MPTokenBuilder >::validate ( ) const

nodiscardinherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

MPTokenBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< MPTokenBuilder >::setLedgerIndex ( UInt256 const & value )

inherited

Set the ledger index.

Parameters

value Ledger index

Returns: Reference to the derived builder for method chaining.

Definition at line 62 of file LedgerEntryBuilderBase.h.

◆ setFlags()

MPTokenBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< MPTokenBuilder >::setFlags ( uint32_t value )

inherited

Set the flags.

Parameters

value Flags value

Returns: Reference to the derived builder for method chaining.

Definition at line 74 of file LedgerEntryBuilderBase.h.

Member Data Documentation

◆ object_

STObject xrpl::ledger_entries::LedgerEntryBuilderBase< MPTokenBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MPTokenBuilder() [1/2]

◆ MPTokenBuilder() [2/2]

Member Function Documentation

◆ setAccount()

◆ setMPTokenIssuanceID()

◆ setMPTAmount()

◆ setLockedAmount()

◆ setOwnerNode()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setConfidentialBalanceInbox()

◆ setConfidentialBalanceSpending()

◆ setConfidentialBalanceVersion()

◆ setIssuerEncryptedBalance()

◆ setAuditorEncryptedBalance()

◆ setIssuerKeyMirrorEpoch()

◆ setAuditorKeyMirrorEpoch()

◆ setHolderEncryptionKey()

◆ setRecoveryKey()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_