#include <Sponsorship.h>

Inheritance diagram for xrpl::ledger_entries::Sponsorship:

Collaboration diagram for xrpl::ledger_entries::Sponsorship:

[legend]

Public Member Functions
	Sponsorship (SLE::const_pointer sle)
	Construct a Sponsorship ledger entry wrapper from an existing SLE object.
SF_UINT256::type::value_type	getPreviousTxnID () const
	Get sfPreviousTxnID (SoeRequired).
SF_UINT32::type::value_type	getPreviousTxnLgrSeq () const
	Get sfPreviousTxnLgrSeq (SoeRequired).
SF_ACCOUNT::type::value_type	getOwner () const
	Get sfOwner (SoeRequired).
SF_ACCOUNT::type::value_type	getSponsee () const
	Get sfSponsee (SoeRequired).
protocol_autogen::Optional< SF_AMOUNT::type::value_type >	getFeeAmount () const
	Get sfFeeAmount (SoeOptional).
bool	hasFeeAmount () const
	Check if sfFeeAmount is present.
protocol_autogen::Optional< SF_AMOUNT::type::value_type >	getMaxFee () const
	Get sfMaxFee (SoeOptional).
bool	hasMaxFee () const
	Check if sfMaxFee is present.
protocol_autogen::Optional< SF_UINT32::type::value_type >	getRemainingOwnerCount () const
	Get sfRemainingOwnerCount (SoeDefault).
bool	hasRemainingOwnerCount () const
	Check if sfRemainingOwnerCount is present.
SF_UINT64::type::value_type	getOwnerNode () const
	Get sfOwnerNode (SoeRequired).
SF_UINT64::type::value_type	getSponseeNode () const
	Get sfSponseeNode (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).
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 = ltSPONSORSHIP

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

Detailed Description

Ledger Entry: Sponsorship.

Type: ltSPONSORSHIP (0x0090) RPC Name: sponsorship

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

Definition at line 27 of file Sponsorship.h.

Constructor & Destructor Documentation

◆ Sponsorship()

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

explicit

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

Member Function Documentation

◆ getPreviousTxnID()

SF_UINT256::type::value_type xrpl::ledger_entries::Sponsorship::getPreviousTxnID ( ) const

nodiscard

Get sfPreviousTxnID (SoeRequired).

Returns: The field value.

Definition at line 54 of file Sponsorship.h.

◆ getPreviousTxnLgrSeq()

SF_UINT32::type::value_type xrpl::ledger_entries::Sponsorship::getPreviousTxnLgrSeq ( ) const

nodiscard

Get sfPreviousTxnLgrSeq (SoeRequired).

Returns: The field value.

Definition at line 65 of file Sponsorship.h.

◆ getOwner()

SF_ACCOUNT::type::value_type xrpl::ledger_entries::Sponsorship::getOwner ( ) const

nodiscard

Get sfOwner (SoeRequired).

Returns: The field value.

Definition at line 76 of file Sponsorship.h.

◆ getSponsee()

SF_ACCOUNT::type::value_type xrpl::ledger_entries::Sponsorship::getSponsee ( ) const

nodiscard

Get sfSponsee (SoeRequired).

Returns: The field value.

Definition at line 87 of file Sponsorship.h.

◆ getFeeAmount()

protocol_autogen::Optional< SF_AMOUNT::type::value_type > xrpl::ledger_entries::Sponsorship::getFeeAmount ( ) const

nodiscard

Get sfFeeAmount (SoeOptional).

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

Definition at line 98 of file Sponsorship.h.

◆ hasFeeAmount()

bool xrpl::ledger_entries::Sponsorship::hasFeeAmount ( ) const

nodiscard

Check if sfFeeAmount is present.

Returns: True if the field is present, false otherwise.

Definition at line 111 of file Sponsorship.h.

◆ getMaxFee()

protocol_autogen::Optional< SF_AMOUNT::type::value_type > xrpl::ledger_entries::Sponsorship::getMaxFee ( ) const

nodiscard

Get sfMaxFee (SoeOptional).

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

Definition at line 122 of file Sponsorship.h.

◆ hasMaxFee()

bool xrpl::ledger_entries::Sponsorship::hasMaxFee ( ) const

nodiscard

Check if sfMaxFee is present.

Returns: True if the field is present, false otherwise.

Definition at line 135 of file Sponsorship.h.

◆ getRemainingOwnerCount()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::Sponsorship::getRemainingOwnerCount ( ) const

nodiscard

Get sfRemainingOwnerCount (SoeDefault).

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

Definition at line 146 of file Sponsorship.h.

◆ hasRemainingOwnerCount()

bool xrpl::ledger_entries::Sponsorship::hasRemainingOwnerCount ( ) const

nodiscard

Check if sfRemainingOwnerCount is present.

Returns: True if the field is present, false otherwise.

Definition at line 159 of file Sponsorship.h.

◆ getOwnerNode()

SF_UINT64::type::value_type xrpl::ledger_entries::Sponsorship::getOwnerNode ( ) const

nodiscard

Get sfOwnerNode (SoeRequired).

Returns: The field value.

Definition at line 170 of file Sponsorship.h.

◆ getSponseeNode()

SF_UINT64::type::value_type xrpl::ledger_entries::Sponsorship::getSponseeNode ( ) const

nodiscard

Get sfSponseeNode (SoeRequired).

Returns: The field value.

Definition at line 181 of file Sponsorship.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::Sponsorship::entryType = ltSPONSORSHIP

staticconstexpr

Definition at line 30 of file Sponsorship.h.

◆ sle_

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

protectedinherited

The underlying serialized ledger entry being wrapped.

Definition at line 164 of file LedgerEntryBase.h.

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Sponsorship()

Member Function Documentation

◆ getPreviousTxnID()

◆ getPreviousTxnLgrSeq()

◆ getOwner()

◆ getSponsee()

◆ getFeeAmount()

◆ hasFeeAmount()

◆ getMaxFee()

◆ hasMaxFee()

◆ getRemainingOwnerCount()

◆ hasRemainingOwnerCount()

◆ getOwnerNode()

◆ getSponseeNode()

◆ validate()

◆ getType()

◆ getKey()

◆ getLedgerIndex()

◆ hasLedgerIndex()

◆ getLedgerEntryType()

◆ getFlags()

◆ isFlag()

◆ getSle()

Member Data Documentation

◆ entryType

◆ sle_