Builder for TransactionProposal ledger entries. More...

#include <TransactionProposal.h>

Inheritance diagram for xrpl::ledger_entries::TransactionProposalBuilder:

Collaboration diagram for xrpl::ledger_entries::TransactionProposalBuilder:

[legend]

Public Member Functions
	TransactionProposalBuilder (std::decay_t< typename SF_UINT256::type::value_type > const &previousTxnID, std::decay_t< typename SF_UINT32::type::value_type > const &previousTxnLgrSeq, std::decay_t< typename SF_ACCOUNT::type::value_type > const &owner, STObject const &proposedTransaction, std::decay_t< typename SF_UINT32::type::value_type > const &expiration, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode)
	Construct a new TransactionProposalBuilder with required fields.
	TransactionProposalBuilder (SLE::const_pointer sle)
	Construct a TransactionProposalBuilder from an existing SLE object.
TransactionProposalBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Ledger entry-specific field setters.
TransactionProposalBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (SoeRequired).
TransactionProposalBuilder &	setOwner (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfOwner (SoeRequired).
TransactionProposalBuilder &	setProposedTransaction (STObject const &value)
	Set sfProposedTransaction (SoeRequired).
TransactionProposalBuilder &	setExpiration (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfExpiration (SoeRequired).
TransactionProposalBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (SoeRequired).
TransactionProposal	build (UInt256 const &index)
	Build and return the completed TransactionProposal wrapper.
bool	validate () const
	Validate the ledger entry.
TransactionProposalBuilder &	setLedgerIndex (UInt256 const &value)
	Set the ledger index.
TransactionProposalBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for TransactionProposal 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 123 of file TransactionProposal.h.

Constructor & Destructor Documentation

◆ TransactionProposalBuilder() [1/2]

xrpl::ledger_entries::TransactionProposalBuilder::TransactionProposalBuilder	(	std::decay_t< typename SF_UINT256::type::value_type > const &	previousTxnID,
		std::decay_t< typename SF_UINT32::type::value_type > const &	previousTxnLgrSeq,
		std::decay_t< typename SF_ACCOUNT::type::value_type > const &	owner,
		STObject const &	proposedTransaction,
		std::decay_t< typename SF_UINT32::type::value_type > const &	expiration,
		std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode )

Construct a new TransactionProposalBuilder with required fields.

Parameters

previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.
owner	The sfOwner field value.
proposedTransaction	The sfProposedTransaction field value.
expiration	The sfExpiration field value.
ownerNode	The sfOwnerNode field value.

Definition at line 135 of file TransactionProposal.h.

◆ TransactionProposalBuilder() [2/2]

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

Construct a TransactionProposalBuilder 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 151 of file TransactionProposal.h.

Member Function Documentation

◆ setPreviousTxnID()

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

Ledger entry-specific field setters.

Set sfPreviousTxnID (SoeRequired)

Returns: Reference to this builder for method chaining.

Definition at line 169 of file TransactionProposal.h.

◆ setPreviousTxnLgrSeq()

TransactionProposalBuilder & xrpl::ledger_entries::TransactionProposalBuilder::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 180 of file TransactionProposal.h.

◆ setOwner()

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

Set sfOwner (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 191 of file TransactionProposal.h.

◆ setProposedTransaction()

TransactionProposalBuilder & xrpl::ledger_entries::TransactionProposalBuilder::setProposedTransaction ( STObject const & value )

Set sfProposedTransaction (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 202 of file TransactionProposal.h.

◆ setExpiration()

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

Set sfExpiration (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 213 of file TransactionProposal.h.

◆ setOwnerNode()

TransactionProposalBuilder & xrpl::ledger_entries::TransactionProposalBuilder::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 224 of file TransactionProposal.h.

◆ build()

TransactionProposal xrpl::ledger_entries::TransactionProposalBuilder::build ( UInt256 const & index )

Build and return the completed TransactionProposal wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 236 of file TransactionProposal.h.

◆ validate()

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

nodiscardinherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

TransactionProposalBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< TransactionProposalBuilder >::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()

TransactionProposalBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< TransactionProposalBuilder >::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< TransactionProposalBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TransactionProposalBuilder() [1/2]

◆ TransactionProposalBuilder() [2/2]

Member Function Documentation

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setOwner()

◆ setProposedTransaction()

◆ setExpiration()

◆ setOwnerNode()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_