xrpld
Loading...
Searching...
No Matches
xrpl::ledger_entries::XChainOwnedCreateAccountClaimID Class Reference

Ledger Entry: XChainOwnedCreateAccountClaimID. More...

#include <XChainOwnedCreateAccountClaimID.h>

Inheritance diagram for xrpl::ledger_entries::XChainOwnedCreateAccountClaimID:
Collaboration diagram for xrpl::ledger_entries::XChainOwnedCreateAccountClaimID:

Public Member Functions

 XChainOwnedCreateAccountClaimID (SLE::const_pointer sle)
 Construct a XChainOwnedCreateAccountClaimID ledger entry wrapper from an existing SLE object.
SF_ACCOUNT::type::value_type getAccount () const
 Get sfAccount (SoeRequired).
SF_XCHAIN_BRIDGE::type::value_type getXChainBridge () const
 Get sfXChainBridge (SoeRequired).
SF_UINT64::type::value_type getXChainAccountCreateCount () const
 Get sfXChainAccountCreateCount (SoeRequired).
STArray const & getXChainCreateAccountAttestations () const
 Get sfXChainCreateAccountAttestations (SoeRequired).
SF_UINT64::type::value_type getOwnerNode () const
 Get sfOwnerNode (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< uint256getLedgerIndex () 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 = ltXCHAIN_OWNED_CREATE_ACCOUNT_CLAIM_ID

Protected Attributes

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

Detailed Description

Ledger Entry: XChainOwnedCreateAccountClaimID.

Type: ltXCHAIN_OWNED_CREATE_ACCOUNT_CLAIM_ID (0x0074) RPC Name: xchain_owned_create_account_claim_id

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

Definition at line 27 of file XChainOwnedCreateAccountClaimID.h.

Constructor & Destructor Documentation

◆ XChainOwnedCreateAccountClaimID()

xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::XChainOwnedCreateAccountClaimID ( SLE::const_pointer sle)
explicit

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

Exceptions
std::runtime_errorif the ledger entry type doesn't match.

Definition at line 36 of file XChainOwnedCreateAccountClaimID.h.

Member Function Documentation

◆ getAccount()

SF_ACCOUNT::type::value_type xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::getAccount ( ) const
nodiscard

Get sfAccount (SoeRequired).

Returns
The field value.

Definition at line 54 of file XChainOwnedCreateAccountClaimID.h.

◆ getXChainBridge()

SF_XCHAIN_BRIDGE::type::value_type xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::getXChainBridge ( ) const
nodiscard

Get sfXChainBridge (SoeRequired).

Returns
The field value.

Definition at line 65 of file XChainOwnedCreateAccountClaimID.h.

◆ getXChainAccountCreateCount()

SF_UINT64::type::value_type xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::getXChainAccountCreateCount ( ) const
nodiscard

Get sfXChainAccountCreateCount (SoeRequired).

Returns
The field value.

Definition at line 76 of file XChainOwnedCreateAccountClaimID.h.

◆ getXChainCreateAccountAttestations()

STArray const & xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::getXChainCreateAccountAttestations ( ) const
nodiscard

Get sfXChainCreateAccountAttestations (SoeRequired).

Note
This is an untyped field (unknown).
Returns
The field value.

Definition at line 88 of file XChainOwnedCreateAccountClaimID.h.

◆ getOwnerNode()

SF_UINT64::type::value_type xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::getOwnerNode ( ) const
nodiscard

Get sfOwnerNode (SoeRequired).

Returns
The field value.

Definition at line 99 of file XChainOwnedCreateAccountClaimID.h.

◆ getPreviousTxnID()

SF_UINT256::type::value_type xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::getPreviousTxnID ( ) const
nodiscard

Get sfPreviousTxnID (SoeRequired).

Returns
The field value.

Definition at line 110 of file XChainOwnedCreateAccountClaimID.h.

◆ getPreviousTxnLgrSeq()

SF_UINT32::type::value_type xrpl::ledger_entries::XChainOwnedCreateAccountClaimID::getPreviousTxnLgrSeq ( ) const
nodiscard

Get sfPreviousTxnLgrSeq (SoeRequired).

Returns
The field value.

Definition at line 121 of file XChainOwnedCreateAccountClaimID.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
fThe 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::XChainOwnedCreateAccountClaimID::entryType = ltXCHAIN_OWNED_CREATE_ACCOUNT_CLAIM_ID
staticconstexpr

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