xrpld
Loading...
Searching...
No Matches
xrpl::ledger_entries::MPTokenIssuanceBuilder Class Reference

Builder for MPTokenIssuance ledger entries. More...

#include <MPTokenIssuance.h>

Inheritance diagram for xrpl::ledger_entries::MPTokenIssuanceBuilder:
Collaboration diagram for xrpl::ledger_entries::MPTokenIssuanceBuilder:

Public Member Functions

 MPTokenIssuanceBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &issuer, std::decay_t< typename SF_UINT32::type::value_type > const &sequence, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, std::decay_t< typename SF_UINT64::type::value_type > const &outstandingAmount, 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 MPTokenIssuanceBuilder with required fields.
 MPTokenIssuanceBuilder (SLE::const_pointer sle)
 Construct a MPTokenIssuanceBuilder from an existing SLE object.
MPTokenIssuanceBuilder & setIssuer (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Ledger entry-specific field setters.
MPTokenIssuanceBuilder & setSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfSequence (SoeRequired).
MPTokenIssuanceBuilder & setTransferFee (std::decay_t< typename SF_UINT16::type::value_type > const &value)
 Set sfTransferFee (SoeDefault).
MPTokenIssuanceBuilder & setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfOwnerNode (SoeRequired).
MPTokenIssuanceBuilder & setAssetScale (std::decay_t< typename SF_UINT8::type::value_type > const &value)
 Set sfAssetScale (SoeDefault).
MPTokenIssuanceBuilder & setMaximumAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfMaximumAmount (SoeOptional).
MPTokenIssuanceBuilder & setOutstandingAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfOutstandingAmount (SoeRequired).
MPTokenIssuanceBuilder & setLockedAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfLockedAmount (SoeOptional).
MPTokenIssuanceBuilder & setMPTokenMetadata (std::decay_t< typename SF_VL::type::value_type > const &value)
 Set sfMPTokenMetadata (SoeOptional).
MPTokenIssuanceBuilder & setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Set sfPreviousTxnID (SoeRequired).
MPTokenIssuanceBuilder & setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfPreviousTxnLgrSeq (SoeRequired).
MPTokenIssuanceBuilder & setDomainID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Set sfDomainID (SoeOptional).
MPTokenIssuanceBuilder & setImmutableFlags (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfImmutableFlags (SoeDefault).
MPTokenIssuanceBuilder & setReferenceHolding (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Set sfReferenceHolding (SoeOptional).
MPTokenIssuanceBuilder & setIssuerEncryptionKey (std::decay_t< typename SF_VL::type::value_type > const &value)
 Set sfIssuerEncryptionKey (SoeOptional).
MPTokenIssuanceBuilder & setAuditorEncryptionKey (std::decay_t< typename SF_VL::type::value_type > const &value)
 Set sfAuditorEncryptionKey (SoeOptional).
MPTokenIssuanceBuilder & setIssuerKeyEpoch (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfIssuerKeyEpoch (SoeOptional).
MPTokenIssuanceBuilder & setAuditorKeyEpoch (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfAuditorKeyEpoch (SoeOptional).
MPTokenIssuanceBuilder & setConfidentialOutstandingAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfConfidentialOutstandingAmount (SoeDefault).
MPTokenIssuance build (UInt256 const &index)
 Build and return the completed MPTokenIssuance wrapper.
bool validate () const
 Validate the ledger entry.
MPTokenIssuanceBuilder & setLedgerIndex (UInt256 const &value)
 Set the ledger index.
MPTokenIssuanceBuilder & setFlags (uint32_t value)
 Set the flags.

Protected Attributes

STObject object_

Detailed Description

Builder for MPTokenIssuance 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 434 of file MPTokenIssuance.h.

Constructor & Destructor Documentation

◆ MPTokenIssuanceBuilder() [1/2]

xrpl::ledger_entries::MPTokenIssuanceBuilder::MPTokenIssuanceBuilder ( std::decay_t< typename SF_ACCOUNT::type::value_type > const & issuer,
std::decay_t< typename SF_UINT32::type::value_type > const & sequence,
std::decay_t< typename SF_UINT64::type::value_type > const & ownerNode,
std::decay_t< typename SF_UINT64::type::value_type > const & outstandingAmount,
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 MPTokenIssuanceBuilder with required fields.

Parameters
issuerThe sfIssuer field value.
sequenceThe sfSequence field value.
ownerNodeThe sfOwnerNode field value.
outstandingAmountThe sfOutstandingAmount field value.
previousTxnIDThe sfPreviousTxnID field value.
previousTxnLgrSeqThe sfPreviousTxnLgrSeq field value.

Definition at line 446 of file MPTokenIssuance.h.

◆ MPTokenIssuanceBuilder() [2/2]

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

Construct a MPTokenIssuanceBuilder from an existing SLE object.

Parameters
sleThe existing ledger entry to copy from.
Exceptions
std::runtime_errorif the ledger entry type doesn't match.

Definition at line 462 of file MPTokenIssuance.h.

Member Function Documentation

◆ setIssuer()

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

Ledger entry-specific field setters.

Set sfIssuer (SoeRequired)

Returns
Reference to this builder for method chaining.

Definition at line 480 of file MPTokenIssuance.h.

◆ setSequence()

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

Set sfSequence (SoeRequired).

Returns
Reference to this builder for method chaining.

Definition at line 491 of file MPTokenIssuance.h.

◆ setTransferFee()

MPTokenIssuanceBuilder & xrpl::ledger_entries::MPTokenIssuanceBuilder::setTransferFee ( std::decay_t< typename SF_UINT16::type::value_type > const & value)

Set sfTransferFee (SoeDefault).

Returns
Reference to this builder for method chaining.

Definition at line 502 of file MPTokenIssuance.h.

◆ setOwnerNode()

MPTokenIssuanceBuilder & xrpl::ledger_entries::MPTokenIssuanceBuilder::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 513 of file MPTokenIssuance.h.

◆ setAssetScale()

MPTokenIssuanceBuilder & xrpl::ledger_entries::MPTokenIssuanceBuilder::setAssetScale ( std::decay_t< typename SF_UINT8::type::value_type > const & value)

Set sfAssetScale (SoeDefault).

Returns
Reference to this builder for method chaining.

Definition at line 524 of file MPTokenIssuance.h.

◆ setMaximumAmount()

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

Set sfMaximumAmount (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 535 of file MPTokenIssuance.h.

◆ setOutstandingAmount()

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

Set sfOutstandingAmount (SoeRequired).

Returns
Reference to this builder for method chaining.

Definition at line 546 of file MPTokenIssuance.h.

◆ setLockedAmount()

MPTokenIssuanceBuilder & xrpl::ledger_entries::MPTokenIssuanceBuilder::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 557 of file MPTokenIssuance.h.

◆ setMPTokenMetadata()

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

Set sfMPTokenMetadata (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 568 of file MPTokenIssuance.h.

◆ setPreviousTxnID()

MPTokenIssuanceBuilder & xrpl::ledger_entries::MPTokenIssuanceBuilder::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 579 of file MPTokenIssuance.h.

◆ setPreviousTxnLgrSeq()

MPTokenIssuanceBuilder & xrpl::ledger_entries::MPTokenIssuanceBuilder::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 590 of file MPTokenIssuance.h.

◆ setDomainID()

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

Set sfDomainID (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 601 of file MPTokenIssuance.h.

◆ setImmutableFlags()

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

Set sfImmutableFlags (SoeDefault).

Returns
Reference to this builder for method chaining.

Definition at line 612 of file MPTokenIssuance.h.

◆ setReferenceHolding()

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

Set sfReferenceHolding (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 623 of file MPTokenIssuance.h.

◆ setIssuerEncryptionKey()

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

Set sfIssuerEncryptionKey (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 634 of file MPTokenIssuance.h.

◆ setAuditorEncryptionKey()

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

Set sfAuditorEncryptionKey (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 645 of file MPTokenIssuance.h.

◆ setIssuerKeyEpoch()

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

Set sfIssuerKeyEpoch (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 656 of file MPTokenIssuance.h.

◆ setAuditorKeyEpoch()

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

Set sfAuditorKeyEpoch (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 667 of file MPTokenIssuance.h.

◆ setConfidentialOutstandingAmount()

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

Set sfConfidentialOutstandingAmount (SoeDefault).

Returns
Reference to this builder for method chaining.

Definition at line 678 of file MPTokenIssuance.h.

◆ build()

MPTokenIssuance xrpl::ledger_entries::MPTokenIssuanceBuilder::build ( UInt256 const & index)

Build and return the completed MPTokenIssuance wrapper.

Parameters
indexThe ledger entry index.
Returns
The constructed ledger entry wrapper.

Definition at line 690 of file MPTokenIssuance.h.

◆ validate()

bool xrpl::ledger_entries::LedgerEntryBuilderBase< MPTokenIssuanceBuilder >::validate ( ) const
nodiscardinherited

Validate the ledger entry.

Returns
true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

Set the ledger index.

Parameters
valueLedger index
Returns
Reference to the derived builder for method chaining.

Definition at line 62 of file LedgerEntryBuilderBase.h.

◆ setFlags()

Set the flags.

Parameters
valueFlags value
Returns
Reference to the derived builder for method chaining.

Definition at line 74 of file LedgerEntryBuilderBase.h.

Member Data Documentation

◆ object_