#include <AMM.h>

Inheritance diagram for xrpl::ledger_entries::AMM:

Collaboration diagram for xrpl::ledger_entries::AMM:

[legend]

Public Member Functions
	AMM (std::shared_ptr< SLE const > sle)
	Construct a AMM ledger entry wrapper from an existing SLE object.

SF_ACCOUNT::type::value_type	getAccount () const
	Get sfAccount (soeREQUIRED)

protocol_autogen::Optional< SF_UINT16::type::value_type >	getTradingFee () const
	Get sfTradingFee (soeDEFAULT)

bool	hasTradingFee () const
	Check if sfTradingFee is present.

std::optional< std::reference_wrapper< STArray const > >	getVoteSlots () const
	Get sfVoteSlots (soeOPTIONAL)

bool	hasVoteSlots () const
	Check if sfVoteSlots is present.

std::optional< STObject >	getAuctionSlot () const
	Get sfAuctionSlot (soeOPTIONAL)

bool	hasAuctionSlot () const
	Check if sfAuctionSlot is present.

SF_AMOUNT::type::value_type	getLPTokenBalance () const
	Get sfLPTokenBalance (soeREQUIRED)

SF_ISSUE::type::value_type	getAsset () const
	Get sfAsset (soeREQUIRED)

SF_ISSUE::type::value_type	getAsset2 () const
	Get sfAsset2 (soeREQUIRED)

SF_UINT64::type::value_type	getOwnerNode () const
	Get sfOwnerNode (soeREQUIRED)

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).

std::shared_ptr< SLE const >	getSle () const
	Get the underlying SLE object.

Static Public Attributes
static constexpr LedgerEntryType	entryType = ltAMM

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

Detailed Description

Ledger Entry: AMM.

Type: ltAMM (0x0079) RPC Name: amm

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

Definition at line 27 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

Constructor & Destructor Documentation

◆ AMM()

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

explicit

Construct a AMM 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 include/xrpl/protocol_autogen/ledger_entries/AMM.h.

Member Function Documentation

◆ getAccount()

SF_ACCOUNT::type::value_type xrpl::ledger_entries::AMM::getAccount ( ) const

Get sfAccount (soeREQUIRED)

Returns: The field value.

Definition at line 54 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getTradingFee()

protocol_autogen::Optional< SF_UINT16::type::value_type > xrpl::ledger_entries::AMM::getTradingFee ( ) const

Get sfTradingFee (soeDEFAULT)

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

Definition at line 65 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ hasTradingFee()

bool xrpl::ledger_entries::AMM::hasTradingFee ( ) const

Check if sfTradingFee is present.

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

Definition at line 78 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getVoteSlots()

std::optional< std::reference_wrapper< STArray const > > xrpl::ledger_entries::AMM::getVoteSlots ( ) const

Get sfVoteSlots (soeOPTIONAL)

Note: This is an untyped field (unknown).

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

Definition at line 90 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ hasVoteSlots()

bool xrpl::ledger_entries::AMM::hasVoteSlots ( ) const

Check if sfVoteSlots is present.

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

Definition at line 103 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getAuctionSlot()

std::optional< STObject > xrpl::ledger_entries::AMM::getAuctionSlot ( ) const

Get sfAuctionSlot (soeOPTIONAL)

Note: This is an untyped field (unknown).

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

Definition at line 115 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ hasAuctionSlot()

bool xrpl::ledger_entries::AMM::hasAuctionSlot ( ) const

Check if sfAuctionSlot is present.

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

Definition at line 128 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getLPTokenBalance()

SF_AMOUNT::type::value_type xrpl::ledger_entries::AMM::getLPTokenBalance ( ) const

Get sfLPTokenBalance (soeREQUIRED)

Returns: The field value.

Definition at line 139 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getAsset()

SF_ISSUE::type::value_type xrpl::ledger_entries::AMM::getAsset ( ) const

Get sfAsset (soeREQUIRED)

Returns: The field value.

Definition at line 150 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getAsset2()

SF_ISSUE::type::value_type xrpl::ledger_entries::AMM::getAsset2 ( ) const

Get sfAsset2 (soeREQUIRED)

Returns: The field value.

Definition at line 161 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getOwnerNode()

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

Get sfOwnerNode (soeREQUIRED)

Returns: The field value.

Definition at line 172 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getPreviousTxnID()

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

Get sfPreviousTxnID (soeOPTIONAL)

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

Definition at line 183 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ hasPreviousTxnID()

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

Check if sfPreviousTxnID is present.

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

Definition at line 196 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ getPreviousTxnLgrSeq()

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

Get sfPreviousTxnLgrSeq (soeOPTIONAL)

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

Definition at line 207 of file include/xrpl/protocol_autogen/ledger_entries/AMM.h.

◆ hasPreviousTxnLgrSeq()

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

Check if sfPreviousTxnLgrSeq is present.

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

Definition at line 220 of file include/xrpl/protocol_autogen/ledger_entries/AMM.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::AMM::entryType = ltAMM

staticconstexpr

Definition at line 30 of file include/xrpl/protocol_autogen/ledger_entries/AMM.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.

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AMM()

Member Function Documentation

◆ getAccount()

◆ getTradingFee()

◆ hasTradingFee()

◆ getVoteSlots()

◆ hasVoteSlots()

◆ getAuctionSlot()

◆ hasAuctionSlot()

◆ getLPTokenBalance()

◆ getAsset()

◆ getAsset2()

◆ getOwnerNode()

◆ getPreviousTxnID()

◆ hasPreviousTxnID()

◆ getPreviousTxnLgrSeq()

◆ hasPreviousTxnLgrSeq()

◆ validate()

◆ getType()

◆ getKey()

◆ getLedgerIndex()

◆ hasLedgerIndex()

◆ getLedgerEntryType()

◆ getFlags()

◆ getSle()

Member Data Documentation

◆ entryType

◆ sle_