xrpl::RCLValidation Class Reference

Wrapper over STValidation for generic Validation code. More...

#include <RCLValidations.h>

Collaboration diagram for xrpl::RCLValidation:

Public Types
using	NodeKey = xrpl::PublicKey
using	NodeID = xrpl::NodeID

Public Member Functions
	RCLValidation (std::shared_ptr< STValidation > v)
	Constructor.
uint256	ledgerID () const
	Validated ledger's hash.
std::uint32_t	seq () const
	Validated ledger's sequence number (0 if none).
NetClock::time_point	signTime () const
	Validation's signing time.
NetClock::time_point	seenTime () const
	Validated ledger's first seen time.
PublicKey	key () const
	Public key of validator that published the validation.
NodeID	nodeID () const
	NodeID of validator that published the validation.
bool	trusted () const
	Whether the validation is considered trusted.
void	setTrusted ()
void	setUntrusted ()
bool	full () const
	Whether the validation is full (not-partial).
std::optional< std::uint32_t >	loadFee () const
	Get the load fee of the validation if it exists.
std::uint64_t	cookie () const
	Get the cookie specified in the validation (0 if not set).
std::shared_ptr< STValidation >	unwrap () const
	Extract the underlying STValidation being wrapped.

Private Attributes
std::shared_ptr< STValidation >	val_

Detailed Description

Wrapper over STValidation for generic Validation code.

Wraps an STValidation for compatibility with the generic validation code.

Definition at line 34 of file RCLValidations.h.

Member Typedef Documentation

NodeKey

using xrpl::RCLValidation::NodeKey = xrpl::PublicKey

Definition at line 39 of file RCLValidations.h.

NodeID

using xrpl::RCLValidation::NodeID = xrpl::NodeID

Definition at line 40 of file RCLValidations.h.

Constructor & Destructor Documentation

RCLValidation()

xrpl::RCLValidation::RCLValidation

(

std::shared_ptr< STValidation >

v

)

Constructor.

Parameters

v	The validation to wrap.

Definition at line 47 of file RCLValidations.h.

Member Function Documentation

ledgerID()

uint256 xrpl::RCLValidation::ledgerID ( ) const

nodiscard

Validated ledger's hash.

Definition at line 55 of file RCLValidations.h.

seq()

std::uint32_t xrpl::RCLValidation::seq ( ) const

nodiscard

Validated ledger's sequence number (0 if none).

Definition at line 64 of file RCLValidations.h.

signTime()

NetClock::time_point xrpl::RCLValidation::signTime ( ) const

nodiscard

Validation's signing time.

Definition at line 73 of file RCLValidations.h.

seenTime()

NetClock::time_point xrpl::RCLValidation::seenTime ( ) const

nodiscard

Validated ledger's first seen time.

Definition at line 82 of file RCLValidations.h.

key()

PublicKey xrpl::RCLValidation::key ( ) const

nodiscard

Public key of validator that published the validation.

Definition at line 91 of file RCLValidations.h.

nodeID()

NodeID xrpl::RCLValidation::nodeID ( ) const

nodiscard

NodeID of validator that published the validation.

Definition at line 100 of file RCLValidations.h.

trusted()

bool xrpl::RCLValidation::trusted ( ) const

nodiscard

Whether the validation is considered trusted.

Definition at line 109 of file RCLValidations.h.

setTrusted()

void xrpl::RCLValidation::setTrusted

(

)

Definition at line 115 of file RCLValidations.h.

setUntrusted()

void xrpl::RCLValidation::setUntrusted

(

)

Definition at line 121 of file RCLValidations.h.

full()

bool xrpl::RCLValidation::full ( ) const

nodiscard

Whether the validation is full (not-partial).

Definition at line 130 of file RCLValidations.h.

loadFee()

std::optional< std::uint32_t > xrpl::RCLValidation::loadFee ( ) const

nodiscard

Get the load fee of the validation if it exists.

Definition at line 139 of file RCLValidations.h.

cookie()

std::uint64_t xrpl::RCLValidation::cookie ( ) const

nodiscard

Get the cookie specified in the validation (0 if not set).

Definition at line 148 of file RCLValidations.h.

unwrap()

std::shared_ptr< STValidation > xrpl::RCLValidation::unwrap ( ) const

nodiscard

Extract the underlying STValidation being wrapped.

Definition at line 157 of file RCLValidations.h.

Member Data Documentation

val_

std::shared_ptr<STValidation> xrpl::RCLValidation::val_

private

Definition at line 36 of file RCLValidations.h.