#include <STTx.h>

Inheritance diagram for xrpl::STTx:

[legend]

Collaboration diagram for xrpl::STTx:

[legend]

Public Types
using	iterator = boost::transform_iterator< Transform, STObject::list_type::const_iterator >

Public Member Functions
	STTx ()=delete

	STTx (STTx const &other)=default

STTx &	operator= (STTx const &other)=delete

	STTx (SerialIter &sit)

	STTx (SerialIter &&sit)

	STTx (STObject &&object)

	STTx (TxType type, std::function< void(STObject &)> assembler)
	Constructs a transaction.

SerializedTypeID	getSType () const override

std::string	getFullText () const override

Blob	getSignature () const

uint256	getSigningHash () const

TxType	getTxnType () const

Blob	getSigningPubKey () const

SeqProxy	getSeqProxy () const

std::uint32_t	getSeqValue () const
	Returns the first non-zero value of (Sequence, TicketSequence).

AccountID	getFeePayer () const

boost::container::flat_set< AccountID >	getMentionedAccounts () const

uint256	getTransactionID () const

Json::Value	getJson (JsonOptions options) const override

Json::Value	getJson (JsonOptions options, bool binary) const

void	sign (PublicKey const &publicKey, SecretKey const &secretKey, std::optional< std::reference_wrapper< SField const > > signatureTarget={})

Expected< void, std::string >	checkSign (Rules const &rules) const
	Check the signature.

Expected< void, std::string >	checkBatchSign (Rules const &rules) const

std::string	getMetaSQL (std::uint32_t inLedger, std::string const &escapedMetaData) const

std::string	getMetaSQL (Serializer rawTxn, std::uint32_t inLedger, TxnSql status, std::string const &escapedMetaData) const

std::vector< uint256 > const &	getBatchTransactionIDs () const
	Retrieves a batch of transaction IDs from the STTx.

iterator	begin () const

iterator	end () const

bool	empty () const

void	reserve (std::size_t n)

void	applyTemplate (SOTemplate const &type)

void	applyTemplateFromSField (SField const &)

bool	isFree () const

void	set (SOTemplate const &)

bool	set (SerialIter &u, int depth=0)

void	set (std::unique_ptr< STBase > v)
	Set a field.

void	set (STBase &&v)

bool	isEquivalent (STBase const &t) const override

bool	isDefault () const override

void	add (Serializer &s) const override

std::string	getText () const override

void	addWithoutSigningFields (Serializer &s) const

Serializer	getSerializer () const

template<class... Args>
std::size_t	emplace_back (Args &&... args)

int	getCount () const

bool	setFlag (std::uint32_t)

bool	clearFlag (std::uint32_t)

bool	isFlag (std::uint32_t) const

std::uint32_t	getFlags () const

uint256	getHash (HashPrefix prefix) const

uint256	getSigningHash (HashPrefix prefix) const

STBase const &	peekAtIndex (int offset) const

STBase &	getIndex (int offset)

STBase const *	peekAtPIndex (int offset) const

STBase *	getPIndex (int offset)

int	getFieldIndex (SField const &field) const

SField const &	getFieldSType (int index) const

STBase const &	peekAtField (SField const &field) const

STBase &	getField (SField const &field)

STBase const *	peekAtPField (SField const &field) const

STBase *	getPField (SField const &field, bool createOkay=false)

unsigned char	getFieldU8 (SField const &field) const

std::uint16_t	getFieldU16 (SField const &field) const

std::uint32_t	getFieldU32 (SField const &field) const

std::uint64_t	getFieldU64 (SField const &field) const

uint128	getFieldH128 (SField const &field) const

uint160	getFieldH160 (SField const &field) const

uint192	getFieldH192 (SField const &field) const

uint256	getFieldH256 (SField const &field) const

std::int32_t	getFieldI32 (SField const &field) const

AccountID	getAccountID (SField const &field) const

Blob	getFieldVL (SField const &field) const

STAmount const &	getFieldAmount (SField const &field) const

STPathSet const &	getFieldPathSet (SField const &field) const

STVector256 const &	getFieldV256 (SField const &field) const

STObject	getFieldObject (SField const &field) const

STArray const &	getFieldArray (SField const &field) const

STCurrency const &	getFieldCurrency (SField const &field) const

STNumber const &	getFieldNumber (SField const &field) const

template<class T >
T::value_type	operator[] (TypedField< T > const &f) const
	Get the value of a field.

template<class T >
std::optional< std::decay_t< typename T::value_type > >	operator[] (OptionaledField< T > const &of) const
	Get the value of a field as a std::optional.

template<class T >
ValueProxy< T >	operator[] (TypedField< T > const &f)
	Get a modifiable field value.

template<class T >
OptionalProxy< T >	operator[] (OptionaledField< T > const &of)
	Return a modifiable field value as std::optional.

template<class T >
auto	operator[] (TypedField< T > const &f) -> ValueProxy< T >

template<class T >
auto	operator[] (OptionaledField< T > const &of) -> OptionalProxy< T >

template<class T >
T::value_type	at (TypedField< T > const &f) const
	Get the value of a field.

template<class T >
std::optional< std::decay_t< typename T::value_type > >	at (OptionaledField< T > const &of) const
	Get the value of a field as std::optional.

template<class T >
ValueProxy< T >	at (TypedField< T > const &f)
	Get a modifiable field value.

template<class T >
OptionalProxy< T >	at (OptionaledField< T > const &of)
	Return a modifiable field value as std::optional.

template<class T >
auto	at (TypedField< T > const &f) -> ValueProxy< T >

template<class T >
auto	at (OptionaledField< T > const &of) -> OptionalProxy< T >

void	setFieldU8 (SField const &field, unsigned char)

void	setFieldU16 (SField const &field, std::uint16_t)

void	setFieldU32 (SField const &field, std::uint32_t)

void	setFieldU64 (SField const &field, std::uint64_t)

void	setFieldH128 (SField const &field, uint128 const &)

void	setFieldH256 (SField const &field, uint256 const &)

void	setFieldI32 (SField const &field, std::int32_t)

void	setFieldVL (SField const &field, Blob const &)

void	setFieldVL (SField const &field, Slice const &)

void	setAccountID (SField const &field, AccountID const &)

void	setFieldAmount (SField const &field, STAmount const &)

void	setFieldIssue (SField const &field, STIssue const &)

void	setFieldCurrency (SField const &field, STCurrency const &)

void	setFieldNumber (SField const &field, STNumber const &)

void	setFieldPathSet (SField const &field, STPathSet const &)

void	setFieldV256 (SField const &field, STVector256 const &v)

void	setFieldArray (SField const &field, STArray const &v)

void	setFieldObject (SField const &field, STObject const &v)

template<class Tag >
void	setFieldH160 (SField const &field, base_uint< 160, Tag > const &v)

STObject &	peekFieldObject (SField const &field)

STArray &	peekFieldArray (SField const &field)

bool	isFieldPresent (SField const &field) const

STBase *	makeFieldPresent (SField const &field)

void	makeFieldAbsent (SField const &field)

bool	delField (SField const &field)

void	delField (int index)

SOEStyle	getStyle (SField const &field) const

bool	hasMatchingEntry (STBase const &) const

bool	operator== (STObject const &o) const

bool	operator== (STBase const &t) const

bool	operator!= (STObject const &o) const

bool	operator!= (STBase const &t) const

template<typename T , typename V >
V	getFieldByValue (SField const &field) const

template<typename T , typename V >
V const &	getFieldByConstRef (SField const &field, V const &empty) const

template<class D >
D &	downcast ()

template<class D >
D const &	downcast () const

template<class D >
D const &	downcast () const

void	setFName (SField const &n)
	A STBase is a field.

SField const &	getFName () const

void	addFieldID (Serializer &s) const

Static Public Member Functions
static Blob	getSignature (STObject const &sigObject)

static std::string const &	getMetaSQLInsertReplaceHeader ()

static STObject	makeInnerObject (SField const &name)

Static Public Attributes
static constexpr std::size_t	minMultiSigners = 1

static constexpr std::size_t	maxMultiSigners = 32

Static Protected Member Functions
template<class T >
static STBase *	emplace (std::size_t n, void *buf, T &&val)

Private Types
enum	WhichFields : bool { omitSigningFields = false , withAllFields = true }

using	list_type = std::vector< detail::STVar >

Private Member Functions
Expected< void, std::string >	checkSign (Rules const &rules, STObject const &sigObject) const
	Check the signature.

Expected< void, std::string >	checkSingleSign (STObject const &sigObject) const

Expected< void, std::string >	checkMultiSign (Rules const &rules, STObject const &sigObject) const

Expected< void, std::string >	checkBatchSingleSign (STObject const &batchSigner) const

Expected< void, std::string >	checkBatchMultiSign (STObject const &batchSigner, Rules const &rules) const

STBase *	copy (std::size_t n, void *buf) const override

STBase *	move (std::size_t n, void *buf) override

void	add (Serializer &s, WhichFields whichFields) const

template<typename T , typename V = typename std::remove_cv< typename std::remove_reference<decltype(std::declval<T>().value())>::type, ::type >
V	getFieldByValue (SField const &field) const

template<typename T , typename V >
V const &	getFieldByConstRef (SField const &field, V const &empty) const

template<typename T , typename V >
void	setFieldUsingSetValue (SField const &field, V value)

template<typename T >
void	setFieldUsingAssignment (SField const &field, T const &value)

template<typename T >
T &	peekField (SField const &field)

Static Private Member Functions
static std::vector< STBase const * >	getSortedFields (STObject const &objToSort, WhichFields whichFields)

static auto &	getCounter () noexcept

Private Attributes
uint256	tid_

TxType	tx_type_

std::vector< uint256 >	batchTxnIds_

list_type	v_

SOTemplate const *	mType {}

SField const *	fName

Friends
class	detail::STVar

Detailed Description

Definition at line 27 of file STTx.h.

Member Typedef Documentation

◆ list_type

using xrpl::STObject::list_type = std::vector<detail::STVar>

privateinherited

Definition at line 57 of file STObject.h.

◆ iterator

using xrpl::STObject::iterator = boost::transform_iterator<Transform, STObject::list_type::const_iterator>

inherited

Definition at line 63 of file STObject.h.

Member Enumeration Documentation

◆ WhichFields

enum xrpl::STObject::WhichFields : bool

privateinherited

Enumerator
omitSigningFields
withAllFields

Definition at line 414 of file STObject.h.

Constructor & Destructor Documentation

◆ STTx() [1/6]

xrpl::STTx::STTx ( )

delete

◆ STTx() [2/6]

xrpl::STTx::STTx ( STTx const & other )

default

◆ STTx() [3/6]

xrpl::STTx::STTx ( SerialIter & sit )

explicit

Definition at line 78 of file STTx.cpp.

◆ STTx() [4/6]

xrpl::STTx::STTx ( SerialIter && sit )

explicit

Definition at line 182 of file STTx.h.

◆ STTx() [5/6]

xrpl::STTx::STTx ( STObject && object )

explicit

Definition at line 71 of file STTx.cpp.

◆ STTx() [6/6]

xrpl::STTx::STTx	(	TxType	type,
		std::function< void(STObject &)>	assembler
	)

Constructs a transaction.

The returned transaction will have the specified type and any fields that the callback function adds to the object that's passed in.

Definition at line 94 of file STTx.cpp.

Member Function Documentation

◆ operator=()

STTx & xrpl::STTx::operator= ( STTx const & other )

delete

◆ getSType()

SerializedTypeID xrpl::STTx::getSType ( ) const

overridevirtual

Reimplemented from xrpl::STObject.

Definition at line 125 of file STTx.cpp.

◆ getFullText()

std::string xrpl::STTx::getFullText ( ) const

overridevirtual

Reimplemented from xrpl::STObject.

Definition at line 131 of file STTx.cpp.

◆ getSignature() [1/2]

Blob xrpl::STTx::getSignature ( STObject const & sigObject )

static

Definition at line 181 of file STTx.cpp.

◆ getSignature() [2/2]

Blob xrpl::STTx::getSignature ( ) const

Definition at line 65 of file STTx.h.

◆ getSigningHash() [1/2]

uint256 xrpl::STTx::getSigningHash ( ) const

Definition at line 175 of file STTx.cpp.

◆ getTxnType()

TxType xrpl::STTx::getTxnType ( ) const

Definition at line 188 of file STTx.h.

◆ getSigningPubKey()

Blob xrpl::STTx::getSigningPubKey ( ) const

Definition at line 194 of file STTx.h.

◆ getSeqProxy()

SeqProxy xrpl::STTx::getSeqProxy ( ) const

Definition at line 194 of file STTx.cpp.

◆ getSeqValue()

std::uint32_t xrpl::STTx::getSeqValue ( ) const

Returns the first non-zero value of (Sequence, TicketSequence).

Definition at line 211 of file STTx.cpp.

◆ getFeePayer()

AccountID xrpl::STTx::getFeePayer ( ) const

Definition at line 217 of file STTx.cpp.

◆ getMentionedAccounts()

boost::container::flat_set< AccountID > xrpl::STTx::getMentionedAccounts ( ) const

Definition at line 142 of file STTx.cpp.

◆ getTransactionID()

uint256 xrpl::STTx::getTransactionID ( ) const

Definition at line 200 of file STTx.h.

◆ getJson() [1/2]

Json::Value xrpl::STTx::getJson ( JsonOptions options ) const

overridevirtual

Reimplemented from xrpl::STObject.

Definition at line 317 of file STTx.cpp.

◆ getJson() [2/2]

Json::Value xrpl::STTx::getJson	(	JsonOptions	options,
		bool	binary
	)		const

Definition at line 326 of file STTx.cpp.

◆ sign()

void xrpl::STTx::sign	(	PublicKey const &	publicKey,
		SecretKey const &	secretKey,
		std::optional< std::reference_wrapper< SField const > >	signatureTarget = `{}`
	)

Definition at line 231 of file STTx.cpp.

◆ checkSign() [1/2]

Expected< void, std::string > xrpl::STTx::checkSign ( Rules const & rules ) const

Check the signature.

Parameters

rules The current ledger rules.

Returns: true if valid signature. If invalid, the error message string.

Definition at line 272 of file STTx.cpp.

◆ checkBatchSign()

Expected< void, std::string > xrpl::STTx::checkBatchSign ( Rules const & rules ) const

Definition at line 287 of file STTx.cpp.

◆ getMetaSQLInsertReplaceHeader()

std::string const & xrpl::STTx::getMetaSQLInsertReplaceHeader ( )

static

Definition at line 354 of file STTx.cpp.

◆ getMetaSQL() [1/2]

std::string xrpl::STTx::getMetaSQL	(	std::uint32_t	inLedger,
		std::string const &	escapedMetaData
	)		const

Definition at line 366 of file STTx.cpp.

◆ getMetaSQL() [2/2]

std::string xrpl::STTx::getMetaSQL	(	Serializer	rawTxn,
		std::uint32_t	inLedger,
		TxnSql	status,
		std::string const &	escapedMetaData
	)		const

Definition at line 375 of file STTx.cpp.

◆ getBatchTransactionIDs()

std::vector< uint256 > const & xrpl::STTx::getBatchTransactionIDs ( ) const

Retrieves a batch of transaction IDs from the STTx.

This function returns a vector of transaction IDs by extracting them from the field array sfRawTransactions within the STTx. If the batch transaction IDs have already been computed and cached in batchTxnIds_, it returns the cached vector. Otherwise, it computes the transaction IDs, caches them, and then returns the vector.

Returns: A vector of uint256 containing the batch transaction IDs.

Note: The function asserts that the sfRawTransactions field array is not empty and that the size of the computed batch transaction IDs matches the size of the sfRawTransactions field array.

Definition at line 573 of file STTx.cpp.

◆ checkSign() [2/2]

Expected< void, std::string > xrpl::STTx::checkSign	(	Rules const &	rules,
		STObject const &	sigObject
	)		const

private

Check the signature.

Parameters

rules	The current ledger rules.
sigObject	Reference to object that contains the signature fields. Will be *this more often than not.

Returns: true if valid signature. If invalid, the error message string.

Definition at line 253 of file STTx.cpp.

◆ checkSingleSign()

Expected< void, std::string > xrpl::STTx::checkSingleSign ( STObject const & sigObject ) const

private

Definition at line 424 of file STTx.cpp.

◆ checkMultiSign()

Expected< void, std::string > xrpl::STTx::checkMultiSign	(	Rules const &	rules,
		STObject const &	sigObject
	)		const

private

Definition at line 535 of file STTx.cpp.

◆ checkBatchSingleSign()

Expected< void, std::string > xrpl::STTx::checkBatchSingleSign ( STObject const & batchSigner ) const

private

Definition at line 431 of file STTx.cpp.

◆ checkBatchMultiSign()

Expected< void, std::string > xrpl::STTx::checkBatchMultiSign	(	STObject const &	batchSigner,
		Rules const &	rules
	)		const

private

Definition at line 516 of file STTx.cpp.

◆ copy()

STBase * xrpl::STTx::copy	(	std::size_t	n,
		void *	buf
	)		const

overrideprivatevirtual

Reimplemented from xrpl::STObject.

Definition at line 112 of file STTx.cpp.

◆ move()

STBase * xrpl::STTx::move	(	std::size_t	n,
		void *	buf
	)

overrideprivatevirtual

Reimplemented from xrpl::STObject.

Definition at line 118 of file STTx.cpp.

◆ makeInnerObject()

STObject xrpl::STObject::makeInnerObject ( SField const & name )

staticinherited

Definition at line 73 of file STObject.cpp.

◆ begin()

STObject::iterator xrpl::STObject::begin ( ) const

inherited

Definition at line 941 of file STObject.h.

◆ end()

STObject::iterator xrpl::STObject::end ( ) const

inherited

Definition at line 947 of file STObject.h.

◆ empty()

bool xrpl::STObject::empty ( ) const

inherited

Definition at line 953 of file STObject.h.

◆ reserve()

void xrpl::STObject::reserve ( std::size_t n )

inherited

Definition at line 959 of file STObject.h.

◆ applyTemplate()

void xrpl::STObject::applyTemplate ( SOTemplate const & type )

inherited

Definition at line 154 of file STObject.cpp.

◆ applyTemplateFromSField()

void xrpl::STObject::applyTemplateFromSField ( SField const & sField )

inherited

Definition at line 204 of file STObject.cpp.

◆ isFree()

bool xrpl::STObject::isFree ( ) const

inherited

Definition at line 965 of file STObject.h.

◆ set() [1/4]

void xrpl::STObject::set ( SOTemplate const & type )

inherited

Definition at line 134 of file STObject.cpp.

◆ set() [2/4]

bool xrpl::STObject::set	(	SerialIter &	u,
		int	depth = `0`
	)

inherited

Definition at line 213 of file STObject.cpp.

◆ set() [3/4]

void xrpl::STObject::set ( std::unique_ptr< STBase > v )

inherited

Set a field.

if the field already exists, it is replaced.

Definition at line 701 of file STObject.cpp.

◆ set() [4/4]

void xrpl::STObject::set ( STBase && v )

inherited

Definition at line 707 of file STObject.cpp.

◆ isEquivalent()

bool xrpl::STObject::isEquivalent ( STBase const & t ) const

overridevirtualinherited

Reimplemented from xrpl::STBase.

Definition at line 342 of file STObject.cpp.

◆ isDefault()

bool xrpl::STObject::isDefault ( ) const

overridevirtualinherited

Reimplemented from xrpl::STBase.

Definition at line 113 of file STObject.cpp.

◆ add() [1/2]

void xrpl::STObject::add ( Serializer & s ) const

overridevirtualinherited

Reimplemented from xrpl::STBase.

Definition at line 119 of file STObject.cpp.

◆ add() [2/2]

void xrpl::STObject::add	(	Serializer &	s,
		WhichFields	whichFields
	)		const

privateinherited

Definition at line 884 of file STObject.cpp.

◆ getText()

std::string xrpl::STObject::getText ( ) const

overridevirtualinherited

Reimplemented from xrpl::STBase.

Definition at line 323 of file STObject.cpp.

◆ addWithoutSigningFields()

void xrpl::STObject::addWithoutSigningFields ( Serializer & s ) const

inherited

Definition at line 971 of file STObject.h.

◆ getSerializer()

Serializer xrpl::STObject::getSerializer ( ) const

inherited

Definition at line 980 of file STObject.h.

◆ emplace_back()

template<class... Args>

std::size_t xrpl::STObject::emplace_back ( Args &&... args )

inherited

Definition at line 989 of file STObject.h.

◆ getCount()

int xrpl::STObject::getCount ( ) const

inherited

Definition at line 996 of file STObject.h.

◆ setFlag()

bool xrpl::STObject::setFlag ( std::uint32_t f )

inherited

Definition at line 479 of file STObject.cpp.

◆ clearFlag()

bool xrpl::STObject::clearFlag ( std::uint32_t f )

inherited

Definition at line 491 of file STObject.cpp.

◆ isFlag()

bool xrpl::STObject::isFlag ( std::uint32_t f ) const

inherited

Definition at line 503 of file STObject.cpp.

◆ getFlags()

std::uint32_t xrpl::STObject::getFlags ( void ) const

inherited

Definition at line 509 of file STObject.cpp.

◆ getHash()

uint256 xrpl::STObject::getHash ( HashPrefix prefix ) const

inherited

Definition at line 367 of file STObject.cpp.

◆ getSigningHash() [2/2]

uint256 xrpl::STObject::getSigningHash ( HashPrefix prefix ) const

inherited

Definition at line 376 of file STObject.cpp.

◆ peekAtIndex()

STBase const & xrpl::STObject::peekAtIndex ( int offset ) const

inherited

Definition at line 1002 of file STObject.h.

◆ getIndex()

STBase & xrpl::STObject::getIndex ( int offset )

inherited

Definition at line 1008 of file STObject.h.

◆ peekAtPIndex()

STBase const * xrpl::STObject::peekAtPIndex ( int offset ) const

inherited

Definition at line 1014 of file STObject.h.

◆ getPIndex()

STBase * xrpl::STObject::getPIndex ( int offset )

inherited

Definition at line 1020 of file STObject.h.

◆ getFieldIndex()

int xrpl::STObject::getFieldIndex ( SField const & field ) const

inherited

Definition at line 385 of file STObject.cpp.

◆ getFieldSType()

SField const & xrpl::STObject::getFieldSType ( int index ) const

inherited

Definition at line 423 of file STObject.cpp.

◆ peekAtField()

STBase const & xrpl::STObject::peekAtField ( SField const & field ) const

inherited

Definition at line 401 of file STObject.cpp.

◆ getField()

STBase & xrpl::STObject::getField ( SField const & field )

inherited

Definition at line 412 of file STObject.cpp.

◆ peekAtPField()

STBase const * xrpl::STObject::peekAtPField ( SField const & field ) const

inherited

Definition at line 429 of file STObject.cpp.

◆ getPField()

STBase * xrpl::STObject::getPField	(	SField const &	field,
		bool	createOkay = `false`
	)

inherited

Definition at line 440 of file STObject.cpp.

◆ getFieldU8()

unsigned char xrpl::STObject::getFieldU8 ( SField const & field ) const

inherited

Definition at line 581 of file STObject.cpp.

◆ getFieldU16()

std::uint16_t xrpl::STObject::getFieldU16 ( SField const & field ) const

inherited

Definition at line 587 of file STObject.cpp.

◆ getFieldU32()

std::uint32_t xrpl::STObject::getFieldU32 ( SField const & field ) const

inherited

Definition at line 593 of file STObject.cpp.

◆ getFieldU64()

std::uint64_t xrpl::STObject::getFieldU64 ( SField const & field ) const

inherited

Definition at line 599 of file STObject.cpp.

◆ getFieldH128()

uint128 xrpl::STObject::getFieldH128 ( SField const & field ) const

inherited

Definition at line 605 of file STObject.cpp.

◆ getFieldH160()

uint160 xrpl::STObject::getFieldH160 ( SField const & field ) const

inherited

Definition at line 611 of file STObject.cpp.

◆ getFieldH192()

uint192 xrpl::STObject::getFieldH192 ( SField const & field ) const

inherited

Definition at line 617 of file STObject.cpp.

◆ getFieldH256()

uint256 xrpl::STObject::getFieldH256 ( SField const & field ) const

inherited

Definition at line 623 of file STObject.cpp.

◆ getFieldI32()

std::int32_t xrpl::STObject::getFieldI32 ( SField const & field ) const

inherited

Definition at line 629 of file STObject.cpp.

◆ getAccountID()

AccountID xrpl::STObject::getAccountID ( SField const & field ) const

inherited

Definition at line 635 of file STObject.cpp.

◆ getFieldVL()

Blob xrpl::STObject::getFieldVL ( SField const & field ) const

inherited

Definition at line 641 of file STObject.cpp.

◆ getFieldAmount()

STAmount const & xrpl::STObject::getFieldAmount ( SField const & field ) const

inherited

Definition at line 649 of file STObject.cpp.

◆ getFieldPathSet()

STPathSet const & xrpl::STObject::getFieldPathSet ( SField const & field ) const

inherited

Definition at line 656 of file STObject.cpp.

◆ getFieldV256()

STVector256 const & xrpl::STObject::getFieldV256 ( SField const & field ) const

inherited

Definition at line 663 of file STObject.cpp.

◆ getFieldObject()

STObject xrpl::STObject::getFieldObject ( SField const & field ) const

inherited

Definition at line 670 of file STObject.cpp.

◆ getFieldArray()

STArray const & xrpl::STObject::getFieldArray ( SField const & field ) const

inherited

Definition at line 680 of file STObject.cpp.

◆ getFieldCurrency()

STCurrency const & xrpl::STObject::getFieldCurrency ( SField const & field ) const

inherited

Definition at line 687 of file STObject.cpp.

◆ getFieldNumber()

STNumber const & xrpl::STObject::getFieldNumber ( SField const & field ) const

inherited

Definition at line 694 of file STObject.cpp.

◆ operator[]() [1/6]

template<class T >

T::value_type xrpl::STObject::operator[] ( TypedField< T > const & f ) const

inherited

Get the value of a field.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: The value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

Definition at line 1027 of file STObject.h.

◆ operator[]() [2/6]

template<class T >

std::optional< std::decay_t< typename T::value_type > > xrpl::STObject::operator[] ( OptionaledField< T > const & of ) const

inherited

Get the value of a field as a std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: std::nullopt if the field is not present, else the value of the specified field.

Definition at line 1034 of file STObject.h.

◆ operator[]() [3/6]

template<class T >

ValueProxy< T > xrpl::STObject::operator[] ( TypedField< T > const & f )

inherited

Get a modifiable field value.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: A modifiable reference to the value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

◆ operator[]() [4/6]

template<class T >

OptionalProxy< T > xrpl::STObject::operator[] ( OptionaledField< T > const & of )

inherited

Return a modifiable field value as std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: Transparent proxy object to an optional holding a modifiable reference to the value of the specified field. Returns std::nullopt if the field is not present.

◆ operator[]() [5/6]

template<class T >

auto xrpl::STObject::operator[] ( TypedField< T > const & f ) -> ValueProxy<T>

inherited

Definition at line 1041 of file STObject.h.

◆ operator[]() [6/6]

template<class T >

auto xrpl::STObject::operator[] ( OptionaledField< T > const & of ) -> OptionalProxy<T>

inherited

Definition at line 1048 of file STObject.h.

◆ at() [1/6]

template<class T >

T::value_type xrpl::STObject::at ( TypedField< T > const & f ) const

inherited

Get the value of a field.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: The value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

Definition at line 1055 of file STObject.h.

◆ at() [2/6]

template<class T >

std::optional< std::decay_t< typename T::value_type > > xrpl::STObject::at ( OptionaledField< T > const & of ) const

inherited

Get the value of a field as std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: std::nullopt if the field is not present, else the value of the specified field.

Definition at line 1085 of file STObject.h.

◆ at() [3/6]

template<class T >

ValueProxy< T > xrpl::STObject::at ( TypedField< T > const & f )

inherited

Get a modifiable field value.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: A modifiable reference to the value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

◆ at() [4/6]

template<class T >

OptionalProxy< T > xrpl::STObject::at ( OptionaledField< T > const & of )

inherited

Return a modifiable field value as std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: Transparent proxy object to an optional holding a modifiable reference to the value of the specified field. Returns std::nullopt if the field is not present.

◆ at() [5/6]

template<class T >

auto xrpl::STObject::at ( TypedField< T > const & f ) -> ValueProxy<T>

inherited

Definition at line 1113 of file STObject.h.

◆ at() [6/6]

template<class T >

auto xrpl::STObject::at ( OptionaledField< T > const & of ) -> OptionalProxy<T>

inherited

Definition at line 1120 of file STObject.h.

◆ setFieldU8()

void xrpl::STObject::setFieldU8	(	SField const &	field,
		unsigned char	v
	)

inherited

Definition at line 723 of file STObject.cpp.

◆ setFieldU16()

void xrpl::STObject::setFieldU16	(	SField const &	field,
		std::uint16_t	v
	)

inherited

Definition at line 729 of file STObject.cpp.

◆ setFieldU32()

void xrpl::STObject::setFieldU32	(	SField const &	field,
		std::uint32_t	v
	)

inherited

Definition at line 735 of file STObject.cpp.

◆ setFieldU64()

void xrpl::STObject::setFieldU64	(	SField const &	field,
		std::uint64_t	v
	)

inherited

Definition at line 741 of file STObject.cpp.

◆ setFieldH128()

void xrpl::STObject::setFieldH128	(	SField const &	field,
		uint128 const &	v
	)

inherited

Definition at line 747 of file STObject.cpp.

◆ setFieldH256()

void xrpl::STObject::setFieldH256	(	SField const &	field,
		uint256 const &	v
	)

inherited

Definition at line 753 of file STObject.cpp.

◆ setFieldI32()

void xrpl::STObject::setFieldI32	(	SField const &	field,
		std::int32_t	v
	)

inherited

Definition at line 759 of file STObject.cpp.

◆ setFieldVL() [1/2]

void xrpl::STObject::setFieldVL	(	SField const &	field,
		Blob const &	v
	)

inherited

Definition at line 777 of file STObject.cpp.

◆ setFieldVL() [2/2]

void xrpl::STObject::setFieldVL	(	SField const &	field,
		Slice const &	s
	)

inherited

Definition at line 783 of file STObject.cpp.

◆ setAccountID()

void xrpl::STObject::setAccountID	(	SField const &	field,
		AccountID const &	v
	)

inherited

Definition at line 771 of file STObject.cpp.

◆ setFieldAmount()

void xrpl::STObject::setFieldAmount	(	SField const &	field,
		STAmount const &	v
	)

inherited

Definition at line 789 of file STObject.cpp.

◆ setFieldIssue()

void xrpl::STObject::setFieldIssue	(	SField const &	field,
		STIssue const &	v
	)

inherited

Definition at line 801 of file STObject.cpp.

◆ setFieldCurrency()

void xrpl::STObject::setFieldCurrency	(	SField const &	field,
		STCurrency const &	v
	)

inherited

Definition at line 795 of file STObject.cpp.

◆ setFieldNumber()

void xrpl::STObject::setFieldNumber	(	SField const &	field,
		STNumber const &	v
	)

inherited

Definition at line 807 of file STObject.cpp.

◆ setFieldPathSet()

void xrpl::STObject::setFieldPathSet	(	SField const &	field,
		STPathSet const &	v
	)

inherited

Definition at line 813 of file STObject.cpp.

◆ setFieldV256()

void xrpl::STObject::setFieldV256	(	SField const &	field,
		STVector256 const &	v
	)

inherited

Definition at line 765 of file STObject.cpp.

◆ setFieldArray()

void xrpl::STObject::setFieldArray	(	SField const &	field,
		STArray const &	v
	)

inherited

Definition at line 819 of file STObject.cpp.

◆ setFieldObject()

void xrpl::STObject::setFieldObject	(	SField const &	field,
		STObject const &	v
	)

inherited

Definition at line 825 of file STObject.cpp.

◆ setFieldH160()

template<class Tag >

void xrpl::STObject::setFieldH160	(	SField const &	field,
		base_uint< 160, Tag > const &	v
	)

inherited

Definition at line 1127 of file STObject.h.

◆ peekFieldObject()

STObject & xrpl::STObject::peekFieldObject ( SField const & field )

inherited

Definition at line 467 of file STObject.cpp.

◆ peekFieldArray()

STArray & xrpl::STObject::peekFieldArray ( SField const & field )

inherited

Definition at line 473 of file STObject.cpp.

◆ isFieldPresent()

bool xrpl::STObject::isFieldPresent ( SField const & field ) const

inherited

Definition at line 456 of file STObject.cpp.

◆ makeFieldPresent()

STBase * xrpl::STObject::makeFieldPresent ( SField const & field )

inherited

Definition at line 520 of file STObject.cpp.

◆ makeFieldAbsent()

void xrpl::STObject::makeFieldAbsent ( SField const & field )

inherited

Definition at line 542 of file STObject.cpp.

◆ delField() [1/2]

bool xrpl::STObject::delField ( SField const & field )

inherited

Definition at line 557 of file STObject.cpp.

◆ delField() [2/2]

void xrpl::STObject::delField ( int index )

inherited

Definition at line 569 of file STObject.cpp.

◆ getStyle()

SOEStyle xrpl::STObject::getStyle ( SField const & field ) const

inherited

Definition at line 575 of file STObject.cpp.

◆ hasMatchingEntry()

bool xrpl::STObject::hasMatchingEntry ( STBase const & t ) const

inherited

Definition at line 275 of file STObject.cpp.

◆ operator==() [1/2]

bool xrpl::STObject::operator== ( STObject const & o ) const

inherited

Definition at line 844 of file STObject.cpp.

◆ operator==() [2/2]

bool xrpl::STBase::operator== ( STBase const & t ) const

inherited

Definition at line 35 of file STBase.cpp.

◆ operator!=() [1/2]

bool xrpl::STObject::operator!= ( STObject const & o ) const

inherited

Definition at line 1145 of file STObject.h.

◆ operator!=() [2/2]

bool xrpl::STBase::operator!= ( STBase const & t ) const

inherited

Definition at line 41 of file STBase.cpp.

◆ getSortedFields()

std::vector< STBase const * > xrpl::STObject::getSortedFields	(	STObject const &	objToSort,
		WhichFields	whichFields
	)

staticprivateinherited

Definition at line 908 of file STObject.cpp.

◆ getFieldByValue() [1/2]

template<typename T , typename V = typename std::remove_cv< typename std::remove_reference<decltype(std::declval<T>().value())>::type, ::type >

V xrpl::STObject::getFieldByValue ( SField const & field ) const

privateinherited

◆ getFieldByValue() [2/2]

template<typename T , typename V >

V xrpl::STObject::getFieldByValue ( SField const & field ) const

inherited

Definition at line 1152 of file STObject.h.

◆ getFieldByConstRef() [1/2]

template<typename T , typename V >

V const & xrpl::STObject::getFieldByConstRef	(	SField const &	field,
		V const &	empty
	)		const

privateinherited

◆ getFieldByConstRef() [2/2]

template<typename T , typename V >

V const & xrpl::STObject::getFieldByConstRef	(	SField const &	field,
		V const &	empty
	)		const

inherited

Definition at line 1179 of file STObject.h.

◆ setFieldUsingSetValue()

template<typename T , typename V >

void xrpl::STObject::setFieldUsingSetValue	(	SField const &	field,
		V	value
	)

privateinherited

Definition at line 1202 of file STObject.h.

◆ setFieldUsingAssignment()

template<typename T >

void xrpl::STObject::setFieldUsingAssignment	(	SField const &	field,
		T const &	value
	)

privateinherited

Definition at line 1225 of file STObject.h.

◆ peekField()

template<typename T >

T & xrpl::STObject::peekField ( SField const & field )

privateinherited

Definition at line 1246 of file STObject.h.

◆ downcast() [1/3]

template<class D >

D & xrpl::STBase::downcast ( )

inherited

Definition at line 193 of file STBase.h.

◆ downcast() [2/3]

template<class D >

D const & xrpl::STBase::downcast ( ) const

inherited

◆ downcast() [3/3]

template<class D >

D const & xrpl::STBase::downcast ( ) const

inherited

Definition at line 203 of file STBase.h.

◆ setFName()

void xrpl::STBase::setFName ( SField const & n )

inherited

A STBase is a field.

This sets the name.

Definition at line 118 of file STBase.cpp.

◆ getFName()

SField const & xrpl::STBase::getFName ( ) const

inherited

Definition at line 125 of file STBase.cpp.

◆ addFieldID()

void xrpl::STBase::addFieldID ( Serializer & s ) const

inherited

Definition at line 131 of file STBase.cpp.

◆ emplace()

template<class T >

STBase * xrpl::STBase::emplace	(	std::size_t	n,
		void *	buf,
		T &&	val
	)

staticprotectedinherited

Definition at line 213 of file STBase.h.

◆ getCounter()

static auto & xrpl::CountedObject< STObject >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 109 of file CountedObject.h.

Friends And Related Symbol Documentation

◆ detail::STVar

friend class detail::STVar

friend

Definition at line 161 of file STTx.h.

Member Data Documentation

◆ tid_

uint256 xrpl::STTx::tid_

private

Definition at line 29 of file STTx.h.

◆ tx_type_

TxType xrpl::STTx::tx_type_

private

Definition at line 30 of file STTx.h.

◆ minMultiSigners

constexpr std::size_t xrpl::STTx::minMultiSigners = 1

staticconstexpr

Definition at line 33 of file STTx.h.

◆ maxMultiSigners

constexpr std::size_t xrpl::STTx::maxMultiSigners = 32

staticconstexpr

Definition at line 34 of file STTx.h.

◆ batchTxnIds_

std::vector<uint256> xrpl::STTx::batchTxnIds_

mutableprivate

Definition at line 162 of file STTx.h.

◆ v_

list_type xrpl::STObject::v_

privateinherited

Definition at line 59 of file STObject.h.

◆ mType

SOTemplate const* xrpl::STObject::mType {}

privateinherited

Definition at line 60 of file STObject.h.

◆ fName

SField const* xrpl::STBase::fName

privateinherited

Definition at line 116 of file STBase.h.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ list_type

◆ iterator

Member Enumeration Documentation

◆ WhichFields

Constructor & Destructor Documentation

◆ STTx() [1/6]

◆ STTx() [2/6]

◆ STTx() [3/6]

◆ STTx() [4/6]

◆ STTx() [5/6]

◆ STTx() [6/6]

Member Function Documentation

◆ operator=()

◆ getSType()

◆ getFullText()

◆ getSignature() [1/2]

◆ getSignature() [2/2]

◆ getSigningHash() [1/2]

◆ getTxnType()

◆ getSigningPubKey()

◆ getSeqProxy()

◆ getSeqValue()

◆ getFeePayer()

◆ getMentionedAccounts()

◆ getTransactionID()

◆ getJson() [1/2]

◆ getJson() [2/2]

◆ sign()

◆ checkSign() [1/2]

◆ checkBatchSign()

◆ getMetaSQLInsertReplaceHeader()

◆ getMetaSQL() [1/2]

◆ getMetaSQL() [2/2]

◆ getBatchTransactionIDs()

◆ checkSign() [2/2]

◆ checkSingleSign()

◆ checkMultiSign()

◆ checkBatchSingleSign()

◆ checkBatchMultiSign()

◆ copy()

◆ move()

◆ makeInnerObject()

◆ begin()

◆ end()

◆ empty()

◆ reserve()

◆ applyTemplate()

◆ applyTemplateFromSField()

◆ isFree()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ isEquivalent()

◆ isDefault()

◆ add() [1/2]

◆ add() [2/2]

◆ getText()

◆ addWithoutSigningFields()

◆ getSerializer()

◆ emplace_back()

◆ getCount()

◆ setFlag()

◆ clearFlag()

◆ isFlag()

◆ getFlags()

◆ getHash()

◆ getSigningHash() [2/2]