#include <Transaction.h>

Inheritance diagram for ripple::Transaction:

[legend]

Collaboration diagram for ripple::Transaction:

[legend]

Classes
struct	CurrentLedgerState

struct	Locator

struct	SubmitResult

Public Types
using	pointer = std::shared_ptr< Transaction >

using	ref = pointer const &

Public Member Functions
	Transaction (std::shared_ptr< STTx const > const &, std::string &, Application &) noexcept

std::shared_ptr< STTx const > const &	getSTransaction ()

uint256 const &	getID () const

LedgerIndex	getLedger () const

bool	isValidated () const

TransStatus	getStatus () const

TER	getResult ()

void	setResult (TER terResult)

void	setStatus (TransStatus status, std::uint32_t ledgerSeq, std::optional< uint32_t > transactionSeq=std::nullopt, std::optional< uint32_t > networkID=std::nullopt)

void	setStatus (TransStatus status)

void	setLedger (LedgerIndex ledger)

void	setApplying ()
	Set this flag once added to a batch.

bool	getApplying ()
	Detect if transaction is being batched.

void	clearApplying ()
	Indicate that transaction application has been attempted.

SubmitResult	getSubmitResult () const
	getSubmitResult Return submit result

void	clearSubmitResult ()
	clearSubmitResult Clear all flags in SubmitResult

void	setApplied ()
	setApplied Set this flag once was applied to open ledger

void	setQueued ()
	setQueued Set this flag once was put into heldtxns queue

void	setBroadcast ()
	setBroadcast Set this flag once was broadcasted via network

void	setKept ()
	setKept Set this flag once was put to localtxns queue

std::optional< CurrentLedgerState >	getCurrentLedgerState () const
	getCurrentLedgerState Get current ledger state of transaction

void	setCurrentLedgerState (LedgerIndex validatedLedger, XRPAmount fee, std::uint32_t accountSeq, std::uint32_t availableSeq)
	setCurrentLedgerState Set current ledger state of transaction

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

T	shared_from_this (T... args)

T	weak_from_this (T... args)

Static Public Member Functions
static Transaction::pointer	transactionFromSQL (boost::optional< std::uint64_t > const &ledgerSeq, boost::optional< std::string > const &status, Blob const &rawTxn, Application &app)

static TransStatus	sqlTransactionStatus (boost::optional< std::string > const &status)

static Locator	locate (uint256 const &id, Application &app)

static std::variant< std::pair< std::shared_ptr< Transaction >, std::shared_ptr< TxMeta > >, TxSearched >	load (uint256 const &id, Application &app, error_code_i &ec)

static std::variant< std::pair< std::shared_ptr< Transaction >, std::shared_ptr< TxMeta > >, TxSearched >	load (uint256 const &id, Application &app, ClosedInterval< uint32_t > const &range, error_code_i &ec)

Static Private Member Functions
static std::variant< std::pair< std::shared_ptr< Transaction >, std::shared_ptr< TxMeta > >, TxSearched >	load (uint256 const &id, Application &app, std::optional< ClosedInterval< uint32_t > > const &range, error_code_i &ec)

static auto &	getCounter () noexcept

Private Attributes
uint256	mTransactionID

LedgerIndex	mLedgerIndex = 0

std::optional< uint32_t >	mTxnSeq

std::optional< uint32_t >	mNetworkID

TransStatus	mStatus = INVALID

TER	mResult = temUNCERTAIN

bool	mApplying = false

SubmitResult	submitResult_
	different ways for transaction to be accepted

std::optional< CurrentLedgerState >	currentLedgerState_

std::shared_ptr< STTx const >	mTransaction

Application &	mApp

beast::Journal	j_

Detailed Description

Definition at line 43 of file Transaction.h.

Member Typedef Documentation

◆ pointer

using ripple::Transaction::pointer = std::shared_ptr<Transaction>

Definition at line 47 of file Transaction.h.

◆ ref

using ripple::Transaction::ref = pointer const&

Definition at line 48 of file Transaction.h.

Constructor & Destructor Documentation

◆ Transaction()

ripple::Transaction::Transaction	(	std::shared_ptr< STTx const > const &	stx,
		std::string &	reason,
		Application &	app
	)

noexcept

Definition at line 15 of file Transaction.cpp.

Member Function Documentation

◆ transactionFromSQL()

Transaction::pointer ripple::Transaction::transactionFromSQL	(	boost::optional< std::uint64_t > const &	ledgerSeq,
		boost::optional< std::string > const &	status,
		Blob const &	rawTxn,
		Application &	app
	)

static

Definition at line 80 of file Transaction.cpp.

◆ sqlTransactionStatus()

TransStatus ripple::Transaction::sqlTransactionStatus ( boost::optional< std::string > const & status )

static

Definition at line 54 of file Transaction.cpp.

◆ getSTransaction()

std::shared_ptr< STTx const > const & ripple::Transaction::getSTransaction ( )

Definition at line 70 of file Transaction.h.

◆ getID()

uint256 const & ripple::Transaction::getID ( ) const

Definition at line 76 of file Transaction.h.

◆ getLedger()

LedgerIndex ripple::Transaction::getLedger ( ) const

Definition at line 82 of file Transaction.h.

◆ isValidated()

bool ripple::Transaction::isValidated ( ) const

Definition at line 88 of file Transaction.h.

◆ getStatus()

TransStatus ripple::Transaction::getStatus ( ) const

Definition at line 94 of file Transaction.h.

◆ getResult()

TER ripple::Transaction::getResult ( )

Definition at line 100 of file Transaction.h.

◆ setResult()

void ripple::Transaction::setResult ( TER terResult )

Definition at line 106 of file Transaction.h.

◆ setStatus() [1/2]

void ripple::Transaction::setStatus	(	TransStatus	status,
		std::uint32_t	ledgerSeq,
		std::optional< uint32_t >	transactionSeq = `std::nullopt`,
		std::optional< uint32_t >	networkID = `std::nullopt`
	)

◆ setStatus() [2/2]

void ripple::Transaction::setStatus ( TransStatus status )

Definition at line 119 of file Transaction.h.

◆ setLedger()

void ripple::Transaction::setLedger ( LedgerIndex ledger )

Definition at line 125 of file Transaction.h.

◆ setApplying()

void ripple::Transaction::setApplying ( )

Set this flag once added to a batch.

Definition at line 134 of file Transaction.h.

◆ getApplying()

bool ripple::Transaction::getApplying ( )

Detect if transaction is being batched.

Returns: Whether transaction is being applied within a batch.

Definition at line 147 of file Transaction.h.

◆ clearApplying()

void ripple::Transaction::clearApplying ( )

Indicate that transaction application has been attempted.

Definition at line 158 of file Transaction.h.

◆ getSubmitResult()

SubmitResult ripple::Transaction::getSubmitResult ( ) const

getSubmitResult Return submit result

Returns: SubmitResult struct

Definition at line 200 of file Transaction.h.

◆ clearSubmitResult()

void ripple::Transaction::clearSubmitResult ( )

clearSubmitResult Clear all flags in SubmitResult

Definition at line 209 of file Transaction.h.

◆ setApplied()

void ripple::Transaction::setApplied ( )

setApplied Set this flag once was applied to open ledger

Definition at line 218 of file Transaction.h.

◆ setQueued()

void ripple::Transaction::setQueued ( )

setQueued Set this flag once was put into heldtxns queue

Definition at line 227 of file Transaction.h.

◆ setBroadcast()

void ripple::Transaction::setBroadcast ( )

setBroadcast Set this flag once was broadcasted via network

Definition at line 236 of file Transaction.h.

◆ setKept()

void ripple::Transaction::setKept ( )

setKept Set this flag once was put to localtxns queue

Definition at line 245 of file Transaction.h.

◆ getCurrentLedgerState()

std::optional< CurrentLedgerState > ripple::Transaction::getCurrentLedgerState ( ) const

getCurrentLedgerState Get current ledger state of transaction

Returns: Current ledger state

Definition at line 277 of file Transaction.h.

◆ setCurrentLedgerState()

void ripple::Transaction::setCurrentLedgerState	(	LedgerIndex	validatedLedger,
		XRPAmount	fee,
		std::uint32_t	accountSeq,
		std::uint32_t	availableSeq
	)

setCurrentLedgerState Set current ledger state of transaction

Parameters

validatedLedger	Number of last validated ledger
fee	minimum Fee required for the transaction
accountSeq	First valid account sequence in current ledger
availableSeq	First available sequence for the transaction

Definition at line 290 of file Transaction.h.

◆ getJson()

Json::Value ripple::Transaction::getJson	(	JsonOptions	options,
		bool	binary = `false`
	)		const

Definition at line 142 of file Transaction.cpp.

◆ locate()

static Locator ripple::Transaction::locate	(	uint256 const &	id,
		Application &	app
	)

static

◆ load() [1/3]

std::variant< std::pair< std::shared_ptr< Transaction >, std::shared_ptr< TxMeta > >, TxSearched > ripple::Transaction::load	(	uint256 const &	id,
		Application &	app,
		error_code_i &	ec
	)

static

Definition at line 102 of file Transaction.cpp.

◆ load() [2/3]

std::variant< std::pair< std::shared_ptr< Transaction >, std::shared_ptr< TxMeta > >, TxSearched > ripple::Transaction::load	(	uint256 const &	id,
		Application &	app,
		ClosedInterval< uint32_t > const &	range,
		error_code_i &	ec
	)

static

Definition at line 110 of file Transaction.cpp.

◆ load() [3/3]

std::variant< std::pair< std::shared_ptr< Transaction >, std::shared_ptr< TxMeta > >, TxSearched > ripple::Transaction::load	(	uint256 const &	id,
		Application &	app,
		std::optional< ClosedInterval< uint32_t > > const &	range,
		error_code_i &	ec
	)

staticprivate

Definition at line 124 of file Transaction.cpp.

◆ getCounter()

static auto & ripple::CountedObject< Transaction >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 110 of file CountedObject.h.

Member Data Documentation

◆ mTransactionID

uint256 ripple::Transaction::mTransactionID

private

Definition at line 379 of file Transaction.h.

◆ mLedgerIndex

LedgerIndex ripple::Transaction::mLedgerIndex = 0

private

Definition at line 381 of file Transaction.h.

◆ mTxnSeq

std::optional<uint32_t> ripple::Transaction::mTxnSeq

private

Definition at line 382 of file Transaction.h.

◆ mNetworkID

std::optional<uint32_t> ripple::Transaction::mNetworkID

private

Definition at line 383 of file Transaction.h.

◆ mStatus

TransStatus ripple::Transaction::mStatus = INVALID

private

Definition at line 384 of file Transaction.h.

◆ mResult

TER ripple::Transaction::mResult = temUNCERTAIN

private

Definition at line 385 of file Transaction.h.

◆ mApplying

bool ripple::Transaction::mApplying = false

private

Definition at line 404 of file Transaction.h.

◆ submitResult_

SubmitResult ripple::Transaction::submitResult_

private

different ways for transaction to be accepted

Definition at line 407 of file Transaction.h.

◆ currentLedgerState_

std::optional<CurrentLedgerState> ripple::Transaction::currentLedgerState_

private

Definition at line 409 of file Transaction.h.

◆ mTransaction

std::shared_ptr<STTx const> ripple::Transaction::mTransaction

private

Definition at line 411 of file Transaction.h.

◆ mApp

Application& ripple::Transaction::mApp

private

Definition at line 412 of file Transaction.h.

◆ j_

beast::Journal ripple::Transaction::j_

private

Definition at line 413 of file Transaction.h.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ pointer

◆ ref

Constructor & Destructor Documentation

◆ Transaction()

Member Function Documentation

◆ transactionFromSQL()

◆ sqlTransactionStatus()

◆ getSTransaction()

◆ getID()

◆ getLedger()

◆ isValidated()

◆ getStatus()

◆ getResult()

◆ setResult()

◆ setStatus() [1/2]

◆ setStatus() [2/2]

◆ setLedger()

◆ setApplying()

◆ getApplying()

◆ clearApplying()

◆ getSubmitResult()

◆ clearSubmitResult()

◆ setApplied()

◆ setQueued()

◆ setBroadcast()

◆ setKept()

◆ getCurrentLedgerState()

◆ setCurrentLedgerState()

◆ getJson()

◆ locate()

◆ load() [1/3]

◆ load() [2/3]

◆ load() [3/3]

◆ getCounter()

Member Data Documentation

◆ mTransactionID

◆ mLedgerIndex

◆ mTxnSeq

◆ mNetworkID

◆ mStatus

◆ mResult

◆ mApplying

◆ submitResult_

◆ currentLedgerState_

◆ mTransaction

◆ mApp

◆ j_