Builder for Sponsorship ledger entries. More...

#include <Sponsorship.h>

Inheritance diagram for xrpl::ledger_entries::SponsorshipBuilder:

Collaboration diagram for xrpl::ledger_entries::SponsorshipBuilder:

[legend]

Public Member Functions
	SponsorshipBuilder (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, std::decay_t< typename SF_ACCOUNT::type::value_type > const &sponsee, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, std::decay_t< typename SF_UINT64::type::value_type > const &sponseeNode)
	Construct a new SponsorshipBuilder with required fields.
	SponsorshipBuilder (SLE::const_pointer sle)
	Construct a SponsorshipBuilder from an existing SLE object.
SponsorshipBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Ledger entry-specific field setters.
SponsorshipBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (SoeRequired).
SponsorshipBuilder &	setOwner (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfOwner (SoeRequired).
SponsorshipBuilder &	setSponsee (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfSponsee (SoeRequired).
SponsorshipBuilder &	setFeeAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfFeeAmount (SoeOptional).
SponsorshipBuilder &	setMaxFee (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfMaxFee (SoeOptional).
SponsorshipBuilder &	setRemainingOwnerCount (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfRemainingOwnerCount (SoeDefault).
SponsorshipBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (SoeRequired).
SponsorshipBuilder &	setSponseeNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfSponseeNode (SoeRequired).
Sponsorship	build (uint256 const &index)
	Build and return the completed Sponsorship wrapper.
bool	validate () const
	Validate the ledger entry.
SponsorshipBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
SponsorshipBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for Sponsorship 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 194 of file Sponsorship.h.

Constructor & Destructor Documentation

◆ SponsorshipBuilder() [1/2]

xrpl::ledger_entries::SponsorshipBuilder::SponsorshipBuilder	(	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,
		std::decay_t< typename SF_ACCOUNT::type::value_type > const &	sponsee,
		std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode,
		std::decay_t< typename SF_UINT64::type::value_type > const &	sponseeNode )

Construct a new SponsorshipBuilder with required fields.

Parameters

previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.
owner	The sfOwner field value.
sponsee	The sfSponsee field value.
ownerNode	The sfOwnerNode field value.
sponseeNode	The sfSponseeNode field value.

Definition at line 206 of file Sponsorship.h.

◆ SponsorshipBuilder() [2/2]

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

Construct a SponsorshipBuilder 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 222 of file Sponsorship.h.

Member Function Documentation

◆ setPreviousTxnID()

SponsorshipBuilder & xrpl::ledger_entries::SponsorshipBuilder::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 240 of file Sponsorship.h.

◆ setPreviousTxnLgrSeq()

SponsorshipBuilder & xrpl::ledger_entries::SponsorshipBuilder::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 251 of file Sponsorship.h.

◆ setOwner()

SponsorshipBuilder & xrpl::ledger_entries::SponsorshipBuilder::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 262 of file Sponsorship.h.

◆ setSponsee()

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

Set sfSponsee (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 273 of file Sponsorship.h.

◆ setFeeAmount()

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

Set sfFeeAmount (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 284 of file Sponsorship.h.

◆ setMaxFee()

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

Set sfMaxFee (SoeOptional).

Returns: Reference to this builder for method chaining.

Definition at line 295 of file Sponsorship.h.

◆ setRemainingOwnerCount()

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

Set sfRemainingOwnerCount (SoeDefault).

Returns: Reference to this builder for method chaining.

Definition at line 306 of file Sponsorship.h.

◆ setOwnerNode()

SponsorshipBuilder & xrpl::ledger_entries::SponsorshipBuilder::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 317 of file Sponsorship.h.

◆ setSponseeNode()

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

Set sfSponseeNode (SoeRequired).

Returns: Reference to this builder for method chaining.

Definition at line 328 of file Sponsorship.h.

◆ build()

Sponsorship xrpl::ledger_entries::SponsorshipBuilder::build ( uint256 const & index )

Build and return the completed Sponsorship wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 340 of file Sponsorship.h.

◆ validate()

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

nodiscardinherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SponsorshipBuilder() [1/2]

◆ SponsorshipBuilder() [2/2]

Member Function Documentation

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setOwner()

◆ setSponsee()

◆ setFeeAmount()

◆ setMaxFee()

◆ setRemainingOwnerCount()

◆ setOwnerNode()

◆ setSponseeNode()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_