rippled
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
xrpl::ledger_entries::MPTokenIssuanceBuilder Class Reference

Builder for MPTokenIssuance ledger entries. More...

#include <MPTokenIssuance.h>

Inheritance diagram for xrpl::ledger_entries::MPTokenIssuanceBuilder:
Inheritance graph
[legend]
Collaboration diagram for xrpl::ledger_entries::MPTokenIssuanceBuilder:
Collaboration graph
[legend]

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 (std::shared_ptr< SLE const > sle)
 Construct a MPTokenIssuanceBuilder from an existing SLE object.
 
MPTokenIssuanceBuildersetIssuer (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Ledger entry-specific field setters.
 
MPTokenIssuanceBuildersetSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfSequence (soeREQUIRED)
 
MPTokenIssuanceBuildersetTransferFee (std::decay_t< typename SF_UINT16::type::value_type > const &value)
 Set sfTransferFee (soeDEFAULT)
 
MPTokenIssuanceBuildersetOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfOwnerNode (soeREQUIRED)
 
MPTokenIssuanceBuildersetAssetScale (std::decay_t< typename SF_UINT8::type::value_type > const &value)
 Set sfAssetScale (soeDEFAULT)
 
MPTokenIssuanceBuildersetMaximumAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfMaximumAmount (soeOPTIONAL)
 
MPTokenIssuanceBuildersetOutstandingAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfOutstandingAmount (soeREQUIRED)
 
MPTokenIssuanceBuildersetLockedAmount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfLockedAmount (soeOPTIONAL)
 
MPTokenIssuanceBuildersetMPTokenMetadata (std::decay_t< typename SF_VL::type::value_type > const &value)
 Set sfMPTokenMetadata (soeOPTIONAL)
 
MPTokenIssuanceBuildersetPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Set sfPreviousTxnID (soeREQUIRED)
 
MPTokenIssuanceBuildersetPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfPreviousTxnLgrSeq (soeREQUIRED)
 
MPTokenIssuanceBuildersetDomainID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Set sfDomainID (soeOPTIONAL)
 
MPTokenIssuanceBuildersetMutableFlags (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfMutableFlags (soeDEFAULT)
 
MPTokenIssuance build (uint256 const &index)
 Build and return the completed MPTokenIssuance wrapper.
 
bool validate () const
 Validate the ledger entry.
 
MPTokenIssuanceBuildersetLedgerIndex (uint256 const &value)
 Set the ledger index.
 
MPTokenIssuanceBuildersetFlags (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 Json::Value internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 290 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 302 of file MPTokenIssuance.h.

◆ MPTokenIssuanceBuilder() [2/2]

xrpl::ledger_entries::MPTokenIssuanceBuilder::MPTokenIssuanceBuilder ( std::shared_ptr< SLE const >  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 318 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 334 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 345 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 356 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 367 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 378 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 389 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 400 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 411 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 422 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 433 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 444 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 455 of file MPTokenIssuance.h.

◆ setMutableFlags()

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

Set sfMutableFlags (soeDEFAULT)

Returns
Reference to this builder for method chaining.

Definition at line 466 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 478 of file MPTokenIssuance.h.

◆ validate()

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_

Definition at line 81 of file LedgerEntryBuilderBase.h.