Builder for PayChannel ledger entries. More...

#include <PayChannel.h>

Inheritance diagram for xrpl::ledger_entries::PayChannelBuilder:

Collaboration diagram for xrpl::ledger_entries::PayChannelBuilder:

[legend]

Public Member Functions
	PayChannelBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, std::decay_t< typename SF_ACCOUNT::type::value_type > const &destination, std::decay_t< typename SF_AMOUNT::type::value_type > const &amount, std::decay_t< typename SF_AMOUNT::type::value_type > const &balance, std::decay_t< typename SF_VL::type::value_type > const &publicKey, std::decay_t< typename SF_UINT32::type::value_type > const &settleDelay, 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 PayChannelBuilder with required fields.

	PayChannelBuilder (std::shared_ptr< SLE const > sle)
	Construct a PayChannelBuilder from an existing SLE object.

PayChannelBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.

PayChannelBuilder &	setDestination (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfDestination (soeREQUIRED)

PayChannelBuilder &	setSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSequence (soeOPTIONAL)

PayChannelBuilder &	setAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfAmount (soeREQUIRED)

PayChannelBuilder &	setBalance (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfBalance (soeREQUIRED)

PayChannelBuilder &	setPublicKey (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfPublicKey (soeREQUIRED)

PayChannelBuilder &	setSettleDelay (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSettleDelay (soeREQUIRED)

PayChannelBuilder &	setExpiration (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfExpiration (soeOPTIONAL)

PayChannelBuilder &	setCancelAfter (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfCancelAfter (soeOPTIONAL)

PayChannelBuilder &	setSourceTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSourceTag (soeOPTIONAL)

PayChannelBuilder &	setDestinationTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfDestinationTag (soeOPTIONAL)

PayChannelBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)

PayChannelBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)

PayChannelBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)

PayChannelBuilder &	setDestinationNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfDestinationNode (soeOPTIONAL)

PayChannel	build (uint256 const &index)
	Build and return the completed PayChannel wrapper.

bool	validate () const
	Validate the ledger entry.

PayChannelBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.

PayChannelBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for PayChannel 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 299 of file PayChannel.h.

Constructor & Destructor Documentation

◆ PayChannelBuilder() [1/2]

xrpl::ledger_entries::PayChannelBuilder::PayChannelBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		std::decay_t< typename SF_ACCOUNT::type::value_type > const &	destination,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	amount,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	balance,
		std::decay_t< typename SF_VL::type::value_type > const &	publicKey,
		std::decay_t< typename SF_UINT32::type::value_type > const &	settleDelay,
		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 PayChannelBuilder with required fields.

Parameters

account	The sfAccount field value.
destination	The sfDestination field value.
amount	The sfAmount field value.
balance	The sfBalance field value.
publicKey	The sfPublicKey field value.
settleDelay	The sfSettleDelay field value.
ownerNode	The sfOwnerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 314 of file PayChannel.h.

◆ PayChannelBuilder() [2/2]

xrpl::ledger_entries::PayChannelBuilder::PayChannelBuilder ( std::shared_ptr< SLE const > sle )

Construct a PayChannelBuilder 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 333 of file PayChannel.h.

Member Function Documentation

◆ setAccount()

PayChannelBuilder & xrpl::ledger_entries::PayChannelBuilder::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 349 of file PayChannel.h.

◆ setDestination()

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

Set sfDestination (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 360 of file PayChannel.h.

◆ setSequence()

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

Set sfSequence (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 371 of file PayChannel.h.

◆ setAmount()

PayChannelBuilder & xrpl::ledger_entries::PayChannelBuilder::setAmount ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Set sfAmount (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 382 of file PayChannel.h.

◆ setBalance()

PayChannelBuilder & xrpl::ledger_entries::PayChannelBuilder::setBalance ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Set sfBalance (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 393 of file PayChannel.h.

◆ setPublicKey()

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

Set sfPublicKey (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 404 of file PayChannel.h.

◆ setSettleDelay()

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

Set sfSettleDelay (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 415 of file PayChannel.h.

◆ setExpiration()

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

Set sfExpiration (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 426 of file PayChannel.h.

◆ setCancelAfter()

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

Set sfCancelAfter (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 437 of file PayChannel.h.

◆ setSourceTag()

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

Set sfSourceTag (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 448 of file PayChannel.h.

◆ setDestinationTag()

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

Set sfDestinationTag (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 459 of file PayChannel.h.

◆ setOwnerNode()

PayChannelBuilder & xrpl::ledger_entries::PayChannelBuilder::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 470 of file PayChannel.h.

◆ setPreviousTxnID()

PayChannelBuilder & xrpl::ledger_entries::PayChannelBuilder::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 481 of file PayChannel.h.

◆ setPreviousTxnLgrSeq()

PayChannelBuilder & xrpl::ledger_entries::PayChannelBuilder::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 492 of file PayChannel.h.

◆ setDestinationNode()

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

Set sfDestinationNode (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 503 of file PayChannel.h.

◆ build()

PayChannel xrpl::ledger_entries::PayChannelBuilder::build ( uint256 const & index )

Build and return the completed PayChannel wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 515 of file PayChannel.h.

◆ validate()

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

inherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PayChannelBuilder() [1/2]

◆ PayChannelBuilder() [2/2]

Member Function Documentation

◆ setAccount()

◆ setDestination()

◆ setSequence()

◆ setAmount()

◆ setBalance()

◆ setPublicKey()

◆ setSettleDelay()

◆ setExpiration()

◆ setCancelAfter()

◆ setSourceTag()

◆ setDestinationTag()

◆ setOwnerNode()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setDestinationNode()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_