Builder for SignerList ledger entries. More...

#include <SignerList.h>

Inheritance diagram for xrpl::ledger_entries::SignerListBuilder:

Collaboration diagram for xrpl::ledger_entries::SignerListBuilder:

[legend]

Public Member Functions
	SignerListBuilder (std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, std::decay_t< typename SF_UINT32::type::value_type > const &signerQuorum, STArray const &signerEntries, std::decay_t< typename SF_UINT32::type::value_type > const &signerListID, 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 SignerListBuilder with required fields.

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

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

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

SignerListBuilder &	setSignerQuorum (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSignerQuorum (soeREQUIRED)

SignerListBuilder &	setSignerEntries (STArray const &value)
	Set sfSignerEntries (soeREQUIRED)

SignerListBuilder &	setSignerListID (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSignerListID (soeREQUIRED)

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

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

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

bool	validate () const
	Validate the ledger entry.

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

SignerListBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for SignerList 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 147 of file SignerList.h.

Constructor & Destructor Documentation

◆ SignerListBuilder() [1/2]

xrpl::ledger_entries::SignerListBuilder::SignerListBuilder	(	std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode,
		std::decay_t< typename SF_UINT32::type::value_type > const &	signerQuorum,
		STArray const &	signerEntries,
		std::decay_t< typename SF_UINT32::type::value_type > const &	signerListID,
		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 SignerListBuilder with required fields.

Parameters

ownerNode	The sfOwnerNode field value.
signerQuorum	The sfSignerQuorum field value.
signerEntries	The sfSignerEntries field value.
signerListID	The sfSignerListID field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 159 of file SignerList.h.

◆ SignerListBuilder() [2/2]

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

Construct a SignerListBuilder 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 175 of file SignerList.h.

Member Function Documentation

◆ setOwner()

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

Ledger entry-specific field setters.

Set sfOwner (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 191 of file SignerList.h.

◆ setOwnerNode()

SignerListBuilder & xrpl::ledger_entries::SignerListBuilder::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 202 of file SignerList.h.

◆ setSignerQuorum()

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

Set sfSignerQuorum (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 213 of file SignerList.h.

◆ setSignerEntries()

SignerListBuilder & xrpl::ledger_entries::SignerListBuilder::setSignerEntries ( STArray const & value )

Set sfSignerEntries (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 224 of file SignerList.h.

◆ setSignerListID()

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

Set sfSignerListID (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 235 of file SignerList.h.

◆ setPreviousTxnID()

SignerListBuilder & xrpl::ledger_entries::SignerListBuilder::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 246 of file SignerList.h.

◆ setPreviousTxnLgrSeq()

SignerListBuilder & xrpl::ledger_entries::SignerListBuilder::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 257 of file SignerList.h.

◆ build()

SignerList xrpl::ledger_entries::SignerListBuilder::build ( uint256 const & index )

Build and return the completed SignerList wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 269 of file SignerList.h.

◆ validate()

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

inherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

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

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

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SignerListBuilder() [1/2]

◆ SignerListBuilder() [2/2]

Member Function Documentation

◆ setOwner()

◆ setOwnerNode()

◆ setSignerQuorum()

◆ setSignerEntries()

◆ setSignerListID()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_