Builder for DepositPreauth ledger entries. More...

#include <DepositPreauth.h>

Inheritance diagram for xrpl::ledger_entries::DepositPreauthBuilder:

Collaboration diagram for xrpl::ledger_entries::DepositPreauthBuilder:

[legend]

Public Member Functions
	DepositPreauthBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, 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 DepositPreauthBuilder with required fields.

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

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

DepositPreauthBuilder &	setAuthorize (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfAuthorize (soeOPTIONAL)

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

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

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

DepositPreauthBuilder &	setAuthorizeCredentials (STArray const &value)
	Set sfAuthorizeCredentials (soeOPTIONAL)

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

bool	validate () const
	Validate the ledger entry.

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

DepositPreauthBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for DepositPreauth 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 149 of file protocol_autogen/ledger_entries/DepositPreauth.h.

Constructor & Destructor Documentation

◆ DepositPreauthBuilder() [1/2]

xrpl::ledger_entries::DepositPreauthBuilder::DepositPreauthBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		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 DepositPreauthBuilder with required fields.

Parameters

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

Definition at line 159 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ DepositPreauthBuilder() [2/2]

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

Construct a DepositPreauthBuilder 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 173 of file protocol_autogen/ledger_entries/DepositPreauth.h.

Member Function Documentation

◆ setAccount()

DepositPreauthBuilder & xrpl::ledger_entries::DepositPreauthBuilder::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 189 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ setAuthorize()

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

Set sfAuthorize (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 200 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ setOwnerNode()

DepositPreauthBuilder & xrpl::ledger_entries::DepositPreauthBuilder::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 211 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ setPreviousTxnID()

DepositPreauthBuilder & xrpl::ledger_entries::DepositPreauthBuilder::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 222 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ setPreviousTxnLgrSeq()

DepositPreauthBuilder & xrpl::ledger_entries::DepositPreauthBuilder::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 233 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ setAuthorizeCredentials()

DepositPreauthBuilder & xrpl::ledger_entries::DepositPreauthBuilder::setAuthorizeCredentials ( STArray const & value )

Set sfAuthorizeCredentials (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 244 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ build()

DepositPreauth xrpl::ledger_entries::DepositPreauthBuilder::build ( uint256 const & index )

Build and return the completed DepositPreauth wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 256 of file protocol_autogen/ledger_entries/DepositPreauth.h.

◆ validate()

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

inherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DepositPreauthBuilder() [1/2]

◆ DepositPreauthBuilder() [2/2]

Member Function Documentation

◆ setAccount()

◆ setAuthorize()

◆ setOwnerNode()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setAuthorizeCredentials()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_