xrpl::ledger_entries::SignerList Class Reference

Ledger Entry: SignerList. More...

#include <SignerList.h>

Inheritance diagram for xrpl::ledger_entries::SignerList:

Collaboration diagram for xrpl::ledger_entries::SignerList:

Public Member Functions
	SignerList (std::shared_ptr< SLE const > sle)
	Construct a SignerList ledger entry wrapper from an existing SLE object.
protocol_autogen::Optional< SF_ACCOUNT::type::value_type >	getOwner () const
	Get sfOwner (soeOPTIONAL)
bool	hasOwner () const
	Check if sfOwner is present.
SF_UINT64::type::value_type	getOwnerNode () const
	Get sfOwnerNode (soeREQUIRED)
SF_UINT32::type::value_type	getSignerQuorum () const
	Get sfSignerQuorum (soeREQUIRED)
STArray const &	getSignerEntries () const
	Get sfSignerEntries (soeREQUIRED)
SF_UINT32::type::value_type	getSignerListID () const
	Get sfSignerListID (soeREQUIRED)
SF_UINT256::type::value_type	getPreviousTxnID () const
	Get sfPreviousTxnID (soeREQUIRED)
SF_UINT32::type::value_type	getPreviousTxnLgrSeq () const
	Get sfPreviousTxnLgrSeq (soeREQUIRED)
bool	validate () const
	Validate the ledger entry.
LedgerEntryType	getType () const
	Get the ledger entry type.
uint256 const &	getKey () const
	Get the key (index) of this ledger entry.
std::optional< uint256 >	getLedgerIndex () const
	Get the ledger index (sfLedgerIndex).
bool	hasLedgerIndex () const
	Check if the ledger entry has a ledger index.
uint16_t	getLedgerEntryType () const
	Get the ledger entry type field (sfLedgerEntryType).
std::uint32_t	getFlags () const
	Get the flags field (sfFlags).
std::shared_ptr< SLE const >	getSle () const
	Get the underlying SLE object.

Static Public Attributes
static constexpr LedgerEntryType	entryType = ltSIGNER_LIST

Protected Attributes
std::shared_ptr< SLE const >	sle_
	The underlying serialized ledger entry being wrapped.

Detailed Description

Ledger Entry: SignerList.

Type: ltSIGNER_LIST (0x0053) RPC Name: signer_list

Immutable wrapper around SLE providing type-safe field access. Use SignerListBuilder to construct new ledger entries.

Definition at line 27 of file SignerList.h.

Constructor & Destructor Documentation

SignerList()

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

explicit

Construct a SignerList ledger entry wrapper from an existing SLE object.

Exceptions

std::runtime_error

if the ledger entry type doesn't match.

Definition at line 36 of file SignerList.h.

Member Function Documentation

getOwner()

protocol_autogen::Optional< SF_ACCOUNT::type::value_type > xrpl::ledger_entries::SignerList::getOwner

(

)

const

Get sfOwner (soeOPTIONAL)

Returns

The field value, or std::nullopt if not present.

Definition at line 54 of file SignerList.h.

hasOwner()

bool xrpl::ledger_entries::SignerList::hasOwner

(

)

const

Check if sfOwner is present.

Returns

True if the field is present, false otherwise.

Definition at line 67 of file SignerList.h.

getOwnerNode()

SF_UINT64::type::value_type xrpl::ledger_entries::SignerList::getOwnerNode

(

)

const

Get sfOwnerNode (soeREQUIRED)

Returns

The field value.

Definition at line 78 of file SignerList.h.

getSignerQuorum()

SF_UINT32::type::value_type xrpl::ledger_entries::SignerList::getSignerQuorum

(

)

const

Get sfSignerQuorum (soeREQUIRED)

Returns

The field value.

Definition at line 89 of file SignerList.h.

getSignerEntries()

STArray const & xrpl::ledger_entries::SignerList::getSignerEntries

(

)

const

Get sfSignerEntries (soeREQUIRED)

Note

This is an untyped field (unknown).

Returns

The field value.

Definition at line 101 of file SignerList.h.

getSignerListID()

SF_UINT32::type::value_type xrpl::ledger_entries::SignerList::getSignerListID

(

)

const

Get sfSignerListID (soeREQUIRED)

Returns

The field value.

Definition at line 112 of file SignerList.h.

getPreviousTxnID()

SF_UINT256::type::value_type xrpl::ledger_entries::SignerList::getPreviousTxnID

(

)

const

Get sfPreviousTxnID (soeREQUIRED)

Returns

The field value.

Definition at line 123 of file SignerList.h.

getPreviousTxnLgrSeq()

SF_UINT32::type::value_type xrpl::ledger_entries::SignerList::getPreviousTxnLgrSeq

(

)

const

Get sfPreviousTxnLgrSeq (soeREQUIRED)

Returns

The field value.

Definition at line 134 of file SignerList.h.

validate()

bool xrpl::ledger_entries::LedgerEntryBase::validate ( ) const

inherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 40 of file LedgerEntryBase.h.

getType()

LedgerEntryType xrpl::ledger_entries::LedgerEntryBase::getType ( ) const

inherited

Get the ledger entry type.

Returns

The type of this ledger entry

Definition at line 57 of file LedgerEntryBase.h.

getKey()

uint256 const & xrpl::ledger_entries::LedgerEntryBase::getKey ( ) const

inherited

Get the key (index) of this ledger entry.

The key uniquely identifies this ledger entry in the ledger state.

Returns

A constant reference to the 256-bit key

Definition at line 70 of file LedgerEntryBase.h.

getLedgerIndex()

std::optional< uint256 > xrpl::ledger_entries::LedgerEntryBase::getLedgerIndex ( ) const

inherited

Get the ledger index (sfLedgerIndex).

This field is OPTIONAL and represents the index of the ledger entry.

Returns

The ledger index if present, std::nullopt otherwise

Definition at line 85 of file LedgerEntryBase.h.

hasLedgerIndex()

bool xrpl::ledger_entries::LedgerEntryBase::hasLedgerIndex ( ) const

inherited

Check if the ledger entry has a ledger index.

Returns

true if sfLedgerIndex is present, false otherwise

Definition at line 100 of file LedgerEntryBase.h.

getLedgerEntryType()

uint16_t xrpl::ledger_entries::LedgerEntryBase::getLedgerEntryType ( ) const

inherited

Get the ledger entry type field (sfLedgerEntryType).

This field is REQUIRED for all ledger entries and indicates the type of the ledger entry (e.g., AccountRoot, RippleState, Offer, etc.).

Returns

The ledger entry type as a 16-bit unsigned integer

Definition at line 114 of file LedgerEntryBase.h.

getFlags()

std::uint32_t xrpl::ledger_entries::LedgerEntryBase::getFlags ( ) const

inherited

Get the flags field (sfFlags).

This field is REQUIRED for all ledger entries and contains type-specific flags that modify the behavior of the ledger entry.

Returns

The flags value as a 32-bit unsigned integer

Definition at line 128 of file LedgerEntryBase.h.

getSle()

std::shared_ptr< SLE const > xrpl::ledger_entries::LedgerEntryBase::getSle ( ) const

inherited

Get the underlying SLE object.

Provides direct access to the wrapped serialized ledger entry object for cases where the type-safe accessors are insufficient.

Returns

A constant reference to the underlying SLE object

Definition at line 142 of file LedgerEntryBase.h.

Member Data Documentation

entryType

constexpr LedgerEntryType xrpl::ledger_entries::SignerList::entryType = ltSIGNER_LIST

staticconstexpr

Definition at line 30 of file SignerList.h.

sle_

std::shared_ptr<SLE const> xrpl::ledger_entries::LedgerEntryBase::sle_

protectedinherited

The underlying serialized ledger entry being wrapped.

Definition at line 149 of file LedgerEntryBase.h.