#include <PayChannel.h>

Inheritance diagram for xrpl::ledger_entries::PayChannel:

Collaboration diagram for xrpl::ledger_entries::PayChannel:

[legend]

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

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

SF_ACCOUNT::type::value_type	getDestination () const
	Get sfDestination (soeREQUIRED)

protocol_autogen::Optional< SF_UINT32::type::value_type >	getSequence () const
	Get sfSequence (soeOPTIONAL)

bool	hasSequence () const
	Check if sfSequence is present.

SF_AMOUNT::type::value_type	getAmount () const
	Get sfAmount (soeREQUIRED)

SF_AMOUNT::type::value_type	getBalance () const
	Get sfBalance (soeREQUIRED)

SF_VL::type::value_type	getPublicKey () const
	Get sfPublicKey (soeREQUIRED)

SF_UINT32::type::value_type	getSettleDelay () const
	Get sfSettleDelay (soeREQUIRED)

protocol_autogen::Optional< SF_UINT32::type::value_type >	getExpiration () const
	Get sfExpiration (soeOPTIONAL)

bool	hasExpiration () const
	Check if sfExpiration is present.

protocol_autogen::Optional< SF_UINT32::type::value_type >	getCancelAfter () const
	Get sfCancelAfter (soeOPTIONAL)

bool	hasCancelAfter () const
	Check if sfCancelAfter is present.

protocol_autogen::Optional< SF_UINT32::type::value_type >	getSourceTag () const
	Get sfSourceTag (soeOPTIONAL)

bool	hasSourceTag () const
	Check if sfSourceTag is present.

protocol_autogen::Optional< SF_UINT32::type::value_type >	getDestinationTag () const
	Get sfDestinationTag (soeOPTIONAL)

bool	hasDestinationTag () const
	Check if sfDestinationTag is present.

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)

protocol_autogen::Optional< SF_UINT64::type::value_type >	getDestinationNode () const
	Get sfDestinationNode (soeOPTIONAL)

bool	hasDestinationNode () const
	Check if sfDestinationNode 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 = ltPAYCHAN

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

Detailed Description

Ledger Entry: PayChannel.

Type: ltPAYCHAN (0x0078) RPC Name: payment_channel

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

Definition at line 27 of file PayChannel.h.

Constructor & Destructor Documentation

◆ PayChannel()

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

explicit

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

Member Function Documentation

◆ getAccount()

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

Get sfAccount (soeREQUIRED)

Returns: The field value.

Definition at line 54 of file PayChannel.h.

◆ getDestination()

SF_ACCOUNT::type::value_type xrpl::ledger_entries::PayChannel::getDestination ( ) const

Get sfDestination (soeREQUIRED)

Returns: The field value.

Definition at line 65 of file PayChannel.h.

◆ getSequence()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::PayChannel::getSequence ( ) const

Get sfSequence (soeOPTIONAL)

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

Definition at line 76 of file PayChannel.h.

◆ hasSequence()

bool xrpl::ledger_entries::PayChannel::hasSequence ( ) const

Check if sfSequence is present.

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

Definition at line 89 of file PayChannel.h.

◆ getAmount()

SF_AMOUNT::type::value_type xrpl::ledger_entries::PayChannel::getAmount ( ) const

Get sfAmount (soeREQUIRED)

Returns: The field value.

Definition at line 100 of file PayChannel.h.

◆ getBalance()

SF_AMOUNT::type::value_type xrpl::ledger_entries::PayChannel::getBalance ( ) const

Get sfBalance (soeREQUIRED)

Returns: The field value.

Definition at line 111 of file PayChannel.h.

◆ getPublicKey()

SF_VL::type::value_type xrpl::ledger_entries::PayChannel::getPublicKey ( ) const

Get sfPublicKey (soeREQUIRED)

Returns: The field value.

Definition at line 122 of file PayChannel.h.

◆ getSettleDelay()

SF_UINT32::type::value_type xrpl::ledger_entries::PayChannel::getSettleDelay ( ) const

Get sfSettleDelay (soeREQUIRED)

Returns: The field value.

Definition at line 133 of file PayChannel.h.

◆ getExpiration()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::PayChannel::getExpiration ( ) const

Get sfExpiration (soeOPTIONAL)

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

Definition at line 144 of file PayChannel.h.

◆ hasExpiration()

bool xrpl::ledger_entries::PayChannel::hasExpiration ( ) const

Check if sfExpiration is present.

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

Definition at line 157 of file PayChannel.h.

◆ getCancelAfter()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::PayChannel::getCancelAfter ( ) const

Get sfCancelAfter (soeOPTIONAL)

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

Definition at line 168 of file PayChannel.h.

◆ hasCancelAfter()

bool xrpl::ledger_entries::PayChannel::hasCancelAfter ( ) const

Check if sfCancelAfter is present.

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

Definition at line 181 of file PayChannel.h.

◆ getSourceTag()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::PayChannel::getSourceTag ( ) const

Get sfSourceTag (soeOPTIONAL)

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

Definition at line 192 of file PayChannel.h.

◆ hasSourceTag()

bool xrpl::ledger_entries::PayChannel::hasSourceTag ( ) const

Check if sfSourceTag is present.

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

Definition at line 205 of file PayChannel.h.

◆ getDestinationTag()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::PayChannel::getDestinationTag ( ) const

Get sfDestinationTag (soeOPTIONAL)

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

Definition at line 216 of file PayChannel.h.

◆ hasDestinationTag()

bool xrpl::ledger_entries::PayChannel::hasDestinationTag ( ) const

Check if sfDestinationTag is present.

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

Definition at line 229 of file PayChannel.h.

◆ getOwnerNode()

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

Get sfOwnerNode (soeREQUIRED)

Returns: The field value.

Definition at line 240 of file PayChannel.h.

◆ getPreviousTxnID()

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

Get sfPreviousTxnID (soeREQUIRED)

Returns: The field value.

Definition at line 251 of file PayChannel.h.

◆ getPreviousTxnLgrSeq()

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

Get sfPreviousTxnLgrSeq (soeREQUIRED)

Returns: The field value.

Definition at line 262 of file PayChannel.h.

◆ getDestinationNode()

protocol_autogen::Optional< SF_UINT64::type::value_type > xrpl::ledger_entries::PayChannel::getDestinationNode ( ) const

Get sfDestinationNode (soeOPTIONAL)

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

Definition at line 273 of file PayChannel.h.

◆ hasDestinationNode()

bool xrpl::ledger_entries::PayChannel::hasDestinationNode ( ) const

Check if sfDestinationNode is present.

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

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

staticconstexpr

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

◆ PayChannel()

Member Function Documentation

◆ getAccount()

◆ getDestination()

◆ getSequence()

◆ hasSequence()

◆ getAmount()

◆ getBalance()

◆ getPublicKey()

◆ getSettleDelay()

◆ getExpiration()

◆ hasExpiration()

◆ getCancelAfter()

◆ hasCancelAfter()

◆ getSourceTag()

◆ hasSourceTag()

◆ getDestinationTag()

◆ hasDestinationTag()

◆ getOwnerNode()

◆ getPreviousTxnID()

◆ getPreviousTxnLgrSeq()

◆ getDestinationNode()

◆ hasDestinationNode()

◆ validate()

◆ getType()

◆ getKey()

◆ getLedgerIndex()

◆ hasLedgerIndex()

◆ getLedgerEntryType()

◆ getFlags()

◆ getSle()

Member Data Documentation

◆ entryType

◆ sle_