xrpl::ledger_entries::Amendments Class Reference

Ledger Entry: Amendments. More...

#include <Amendments.h>

Inheritance diagram for xrpl::ledger_entries::Amendments:

Collaboration diagram for xrpl::ledger_entries::Amendments:

Public Member Functions
	Amendments (SLE::const_pointer sle)
	Construct a Amendments ledger entry wrapper from an existing SLE object.
protocol_autogen::Optional< SF_VECTOR256::type::value_type >	getAmendments () const
	Get sfAmendments (SoeOptional).
bool	hasAmendments () const
	Check if sfAmendments is present.
std::optional< std::reference_wrapper< STArray const > >	getMajorities () const
	Get sfMajorities (SoeOptional).
bool	hasMajorities () const
	Check if sfMajorities is present.
protocol_autogen::Optional< SF_UINT256::type::value_type >	getPreviousTxnID () const
	Get sfPreviousTxnID (SoeOptional).
bool	hasPreviousTxnID () const
	Check if sfPreviousTxnID is present.
protocol_autogen::Optional< SF_UINT32::type::value_type >	getPreviousTxnLgrSeq () const
	Get sfPreviousTxnLgrSeq (SoeOptional).
bool	hasPreviousTxnLgrSeq () const
	Check if sfPreviousTxnLgrSeq is present.
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).
bool	isFlag (std::uint32_t f) const
	Check if a specific flag is set.
SLE::const_pointer	getSle () const
	Get the underlying SLE object.

Static Public Attributes
static constexpr LedgerEntryType	entryType = ltAMENDMENTS

Protected Attributes
SLE::const_pointer	sle_
	The underlying serialized ledger entry being wrapped.

Detailed Description

Ledger Entry: Amendments.

Type: ltAMENDMENTS (0x0066) RPC Name: amendments

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

Definition at line 27 of file Amendments.h.

Constructor & Destructor Documentation

Amendments()

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

explicit

Construct a Amendments 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 Amendments.h.

Member Function Documentation

getAmendments()

protocol_autogen::Optional< SF_VECTOR256::type::value_type > xrpl::ledger_entries::Amendments::getAmendments ( ) const

nodiscard

Get sfAmendments (SoeOptional).

Returns

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

Definition at line 54 of file Amendments.h.

hasAmendments()

bool xrpl::ledger_entries::Amendments::hasAmendments ( ) const

nodiscard

Check if sfAmendments is present.

Returns

True if the field is present, false otherwise.

Definition at line 67 of file Amendments.h.

getMajorities()

std::optional< std::reference_wrapper< STArray const > > xrpl::ledger_entries::Amendments::getMajorities ( ) const

nodiscard

Get sfMajorities (SoeOptional).

Note

This is an untyped field (unknown).

Returns

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

Definition at line 79 of file Amendments.h.

hasMajorities()

bool xrpl::ledger_entries::Amendments::hasMajorities ( ) const

nodiscard

Check if sfMajorities is present.

Returns

True if the field is present, false otherwise.

Definition at line 92 of file Amendments.h.

getPreviousTxnID()

protocol_autogen::Optional< SF_UINT256::type::value_type > xrpl::ledger_entries::Amendments::getPreviousTxnID ( ) const

nodiscard

Get sfPreviousTxnID (SoeOptional).

Returns

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

Definition at line 103 of file Amendments.h.

hasPreviousTxnID()

bool xrpl::ledger_entries::Amendments::hasPreviousTxnID ( ) const

nodiscard

Check if sfPreviousTxnID is present.

Returns

True if the field is present, false otherwise.

Definition at line 116 of file Amendments.h.

getPreviousTxnLgrSeq()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::Amendments::getPreviousTxnLgrSeq ( ) const

nodiscard

Get sfPreviousTxnLgrSeq (SoeOptional).

Returns

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

Definition at line 127 of file Amendments.h.

hasPreviousTxnLgrSeq()

bool xrpl::ledger_entries::Amendments::hasPreviousTxnLgrSeq ( ) const

nodiscard

Check if sfPreviousTxnLgrSeq is present.

Returns

True if the field is present, false otherwise.

Definition at line 140 of file Amendments.h.

validate()

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

nodiscardinherited

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

nodiscardinherited

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

nodiscardinherited

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

nodiscardinherited

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

nodiscardinherited

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

nodiscardinherited

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

nodiscardinherited

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.

isFlag()

bool xrpl::ledger_entries::LedgerEntryBase::isFlag ( std::uint32_t f ) const

nodiscardinherited

Check if a specific flag is set.

Parameters

f	The flag bitmask to check

Returns

true if all bits in f are set in the flags field

Definition at line 141 of file LedgerEntryBase.h.

getSle()

SLE::const_pointer xrpl::ledger_entries::LedgerEntryBase::getSle ( ) const

nodiscardinherited

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 155 of file LedgerEntryBase.h.

Member Data Documentation

entryType

LedgerEntryType xrpl::ledger_entries::Amendments::entryType = ltAMENDMENTS

staticconstexpr

Definition at line 30 of file Amendments.h.

sle_

SLE::const_pointer xrpl::ledger_entries::LedgerEntryBase::sle_

protectedinherited

The underlying serialized ledger entry being wrapped.

Definition at line 162 of file LedgerEntryBase.h.