#include <Vault.h>

Inheritance diagram for xrpl::ledger_entries::Vault:

Collaboration diagram for xrpl::ledger_entries::Vault:

[legend]

Public Member Functions
	Vault (std::shared_ptr< SLE const > sle)
	Construct a Vault 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_UINT32::type::value_type	getSequence () const
	Get sfSequence (soeREQUIRED)

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

SF_ACCOUNT::type::value_type	getOwner () const
	Get sfOwner (soeREQUIRED)

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

protocol_autogen::Optional< SF_VL::type::value_type >	getData () const
	Get sfData (soeOPTIONAL)

bool	hasData () const
	Check if sfData is present.

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

protocol_autogen::Optional< SF_NUMBER::type::value_type >	getAssetsTotal () const
	Get sfAssetsTotal (soeDEFAULT)

bool	hasAssetsTotal () const
	Check if sfAssetsTotal is present.

protocol_autogen::Optional< SF_NUMBER::type::value_type >	getAssetsAvailable () const
	Get sfAssetsAvailable (soeDEFAULT)

bool	hasAssetsAvailable () const
	Check if sfAssetsAvailable is present.

protocol_autogen::Optional< SF_NUMBER::type::value_type >	getAssetsMaximum () const
	Get sfAssetsMaximum (soeDEFAULT)

bool	hasAssetsMaximum () const
	Check if sfAssetsMaximum is present.

protocol_autogen::Optional< SF_NUMBER::type::value_type >	getLossUnrealized () const
	Get sfLossUnrealized (soeDEFAULT)

bool	hasLossUnrealized () const
	Check if sfLossUnrealized is present.

SF_UINT192::type::value_type	getShareMPTID () const
	Get sfShareMPTID (soeREQUIRED)

SF_UINT8::type::value_type	getWithdrawalPolicy () const
	Get sfWithdrawalPolicy (soeREQUIRED)

protocol_autogen::Optional< SF_UINT8::type::value_type >	getScale () const
	Get sfScale (soeDEFAULT)

bool	hasScale () const
	Check if sfScale 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 = ltVAULT

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

Detailed Description

Ledger Entry: Vault.

Type: ltVAULT (0x0084) RPC Name: vault

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

Definition at line 27 of file Vault.h.

Constructor & Destructor Documentation

◆ Vault()

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

explicit

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

Member Function Documentation

◆ getPreviousTxnID()

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

Get sfPreviousTxnID (soeREQUIRED)

Returns: The field value.

Definition at line 54 of file Vault.h.

◆ getPreviousTxnLgrSeq()

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

Get sfPreviousTxnLgrSeq (soeREQUIRED)

Returns: The field value.

Definition at line 65 of file Vault.h.

◆ getSequence()

SF_UINT32::type::value_type xrpl::ledger_entries::Vault::getSequence ( ) const

Get sfSequence (soeREQUIRED)

Returns: The field value.

Definition at line 76 of file Vault.h.

◆ getOwnerNode()

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

Get sfOwnerNode (soeREQUIRED)

Returns: The field value.

Definition at line 87 of file Vault.h.

◆ getOwner()

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

Get sfOwner (soeREQUIRED)

Returns: The field value.

Definition at line 98 of file Vault.h.

◆ getAccount()

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

Get sfAccount (soeREQUIRED)

Returns: The field value.

Definition at line 109 of file Vault.h.

◆ getData()

protocol_autogen::Optional< SF_VL::type::value_type > xrpl::ledger_entries::Vault::getData ( ) const

Get sfData (soeOPTIONAL)

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

Definition at line 120 of file Vault.h.

◆ hasData()

bool xrpl::ledger_entries::Vault::hasData ( ) const

Check if sfData is present.

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

Definition at line 133 of file Vault.h.

◆ getAsset()

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

Get sfAsset (soeREQUIRED)

Returns: The field value.

Definition at line 144 of file Vault.h.

◆ getAssetsTotal()

protocol_autogen::Optional< SF_NUMBER::type::value_type > xrpl::ledger_entries::Vault::getAssetsTotal ( ) const

Get sfAssetsTotal (soeDEFAULT)

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

Definition at line 155 of file Vault.h.

◆ hasAssetsTotal()

bool xrpl::ledger_entries::Vault::hasAssetsTotal ( ) const

Check if sfAssetsTotal is present.

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

Definition at line 168 of file Vault.h.

◆ getAssetsAvailable()

protocol_autogen::Optional< SF_NUMBER::type::value_type > xrpl::ledger_entries::Vault::getAssetsAvailable ( ) const

Get sfAssetsAvailable (soeDEFAULT)

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

Definition at line 179 of file Vault.h.

◆ hasAssetsAvailable()

bool xrpl::ledger_entries::Vault::hasAssetsAvailable ( ) const

Check if sfAssetsAvailable is present.

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

Definition at line 192 of file Vault.h.

◆ getAssetsMaximum()

protocol_autogen::Optional< SF_NUMBER::type::value_type > xrpl::ledger_entries::Vault::getAssetsMaximum ( ) const

Get sfAssetsMaximum (soeDEFAULT)

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

Definition at line 203 of file Vault.h.

◆ hasAssetsMaximum()

bool xrpl::ledger_entries::Vault::hasAssetsMaximum ( ) const

Check if sfAssetsMaximum is present.

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

Definition at line 216 of file Vault.h.

◆ getLossUnrealized()

protocol_autogen::Optional< SF_NUMBER::type::value_type > xrpl::ledger_entries::Vault::getLossUnrealized ( ) const

Get sfLossUnrealized (soeDEFAULT)

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

Definition at line 227 of file Vault.h.

◆ hasLossUnrealized()

bool xrpl::ledger_entries::Vault::hasLossUnrealized ( ) const

Check if sfLossUnrealized is present.

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

Definition at line 240 of file Vault.h.

◆ getShareMPTID()

SF_UINT192::type::value_type xrpl::ledger_entries::Vault::getShareMPTID ( ) const

Get sfShareMPTID (soeREQUIRED)

Returns: The field value.

Definition at line 251 of file Vault.h.

◆ getWithdrawalPolicy()

SF_UINT8::type::value_type xrpl::ledger_entries::Vault::getWithdrawalPolicy ( ) const

Get sfWithdrawalPolicy (soeREQUIRED)

Returns: The field value.

Definition at line 262 of file Vault.h.

◆ getScale()

protocol_autogen::Optional< SF_UINT8::type::value_type > xrpl::ledger_entries::Vault::getScale ( ) const

Get sfScale (soeDEFAULT)

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

Definition at line 273 of file Vault.h.

◆ hasScale()

bool xrpl::ledger_entries::Vault::hasScale ( ) const

Check if sfScale is present.

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

Definition at line 286 of file Vault.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::Vault::entryType = ltVAULT

staticconstexpr

Definition at line 30 of file Vault.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

◆ Vault()

Member Function Documentation

◆ getPreviousTxnID()

◆ getPreviousTxnLgrSeq()

◆ getSequence()

◆ getOwnerNode()

◆ getOwner()

◆ getAccount()

◆ getData()

◆ hasData()

◆ getAsset()

◆ getAssetsTotal()

◆ hasAssetsTotal()

◆ getAssetsAvailable()

◆ hasAssetsAvailable()

◆ getAssetsMaximum()

◆ hasAssetsMaximum()

◆ getLossUnrealized()

◆ hasLossUnrealized()

◆ getShareMPTID()

◆ getWithdrawalPolicy()

◆ getScale()

◆ hasScale()

◆ validate()

◆ getType()

◆ getKey()

◆ getLedgerIndex()

◆ hasLedgerIndex()

◆ getLedgerEntryType()

◆ getFlags()

◆ getSle()

Member Data Documentation

◆ entryType

◆ sle_