rippled
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | List of all members
xrpl::Transactor Class Referenceabstract

#include <Transactor.h>

Inherited by xrpl::AMMBid, xrpl::AMMClawback, xrpl::AMMCreate, xrpl::AMMDelete, xrpl::AMMDeposit, xrpl::AMMVote, xrpl::AMMWithdraw, xrpl::Batch, xrpl::BridgeModify, xrpl::CancelCheck, xrpl::CancelOffer, xrpl::CashCheck, xrpl::Change, xrpl::Clawback, xrpl::CreateCheck, xrpl::CreateOffer, xrpl::CreateTicket, xrpl::CredentialAccept, xrpl::CredentialCreate, xrpl::CredentialDelete, xrpl::DIDDelete, xrpl::DIDSet, xrpl::DelegateSet, xrpl::DeleteAccount, xrpl::DeleteOracle, xrpl::DepositPreauth, xrpl::EscrowCancel, xrpl::EscrowCreate, xrpl::EscrowFinish, xrpl::LedgerStateFix, xrpl::LoanBrokerCoverClawback, xrpl::LoanBrokerCoverDeposit, xrpl::LoanBrokerCoverWithdraw, xrpl::LoanBrokerDelete, xrpl::LoanBrokerSet, xrpl::LoanDelete, xrpl::LoanManage, xrpl::LoanPay, xrpl::LoanSet, xrpl::MPTokenAuthorize, xrpl::MPTokenIssuanceCreate, xrpl::MPTokenIssuanceDestroy, xrpl::MPTokenIssuanceSet, xrpl::NFTokenAcceptOffer, xrpl::NFTokenBurn, xrpl::NFTokenCancelOffer, xrpl::NFTokenCreateOffer, xrpl::NFTokenMint, xrpl::NFTokenModify, xrpl::PayChanClaim, xrpl::PayChanCreate, xrpl::PayChanFund, xrpl::Payment, xrpl::PermissionedDomainDelete, xrpl::PermissionedDomainSet, xrpl::SetAccount, xrpl::SetOracle, xrpl::SetRegularKey, xrpl::SetSignerList, xrpl::SetTrust, xrpl::VaultClawback, xrpl::VaultCreate, xrpl::VaultDelete, xrpl::VaultDeposit, xrpl::VaultSet, xrpl::VaultWithdraw, xrpl::XChainAddAccountCreateAttestation, xrpl::XChainAddClaimAttestation, xrpl::XChainClaim, xrpl::XChainCommit, xrpl::XChainCreateAccountCommit, xrpl::XChainCreateBridge, and xrpl::XChainCreateClaimID.

Collaboration diagram for xrpl::Transactor:
Collaboration graph
[legend]

Public Types

enum  ConsequencesFactoryType { Normal , Blocker , Custom }
 

Public Member Functions

ApplyResult operator() ()
 Process the transaction.
 
ApplyViewview ()
 
ApplyView const & view () const
 

Static Public Member Functions

static NotTEC checkSeqProxy (ReadView const &view, STTx const &tx, beast::Journal j)
 
static NotTEC checkPriorTxAndLastLedger (PreclaimContext const &ctx)
 
static TER checkFee (PreclaimContext const &ctx, XRPAmount baseFee)
 
static NotTEC checkSign (PreclaimContext const &ctx)
 
static NotTEC checkBatchSign (PreclaimContext const &ctx)
 
static XRPAmount calculateBaseFee (ReadView const &view, STTx const &tx)
 
template<class T >
static NotTEC invokePreflight (PreflightContext const &ctx)
 
static TER preclaim (PreclaimContext const &ctx)
 
static NotTEC checkPermission (ReadView const &view, STTx const &tx)
 
static TER ticketDelete (ApplyView &view, AccountID const &account, uint256 const &ticketIndex, beast::Journal j)
 
template<>
NotTEC invokePreflight (PreflightContext const &ctx)
 
template<>
NotTEC invokePreflight (PreflightContext const &ctx)
 

Protected Member Functions

virtual ~Transactor ()=default
 
 Transactor (Transactor const &)=delete
 
Transactoroperator= (Transactor const &)=delete
 
TER apply ()
 
 Transactor (ApplyContext &ctx)
 
virtual void preCompute ()
 
virtual TER doApply ()=0
 

Static Protected Member Functions

static XRPAmount minimumFee (Application &app, XRPAmount baseFee, Fees const &fees, ApplyFlags flags)
 Compute the minimum fee required to process a transaction with a given baseFee based on the current server load.
 
static XRPAmount calculateOwnerReserveFee (ReadView const &view, STTx const &tx)
 
static NotTEC checkSign (ReadView const &view, ApplyFlags flags, std::optional< uint256 const > const &parentBatchId, AccountID const &idAccount, STObject const &sigObject, beast::Journal const j)
 
static bool checkExtraFeatures (PreflightContext const &ctx)
 
static std::uint32_t getFlagsMask (PreflightContext const &ctx)
 
static NotTEC preflightSigValidated (PreflightContext const &ctx)
 
static bool validDataLength (std::optional< Slice > const &slice, std::size_t maxLength)
 
template<class T >
static bool validNumericRange (std::optional< T > value, T max, T min=T{})
 
template<class T , class Unit >
static bool validNumericRange (std::optional< T > value, unit::ValueUnit< Unit, T > max, unit::ValueUnit< Unit, T > min=unit::ValueUnit< Unit, T >{})
 
template<class T >
static bool validNumericMinimum (std::optional< T > value, T min=T{})
 Minimum will usually be zero.
 
template<class T , class Unit >
static bool validNumericMinimum (std::optional< T > value, unit::ValueUnit< Unit, T > min=unit::ValueUnit< Unit, T >{})
 Minimum will usually be zero.
 

Protected Attributes

ApplyContextctx_
 
beast::WrappedSink sink_
 
beast::Journal const j_
 
AccountID const account_
 
XRPAmount mPriorBalance
 
XRPAmount mSourceBalance
 

Private Member Functions

std::pair< TER, XRPAmountreset (XRPAmount fee)
 Reset the context, discarding any changes made and adjust the fee.
 
TER consumeSeqProxy (SLE::pointer const &sleAccount)
 
TER payFee ()
 
void trapTransaction (uint256) const
 

Static Private Member Functions

static NotTEC checkSingleSign (ReadView const &view, AccountID const &idSigner, AccountID const &idAccount, std::shared_ptr< SLE const > sleAccount, beast::Journal const j)
 
static NotTEC checkMultiSign (ReadView const &view, ApplyFlags flags, AccountID const &id, STObject const &sigObject, beast::Journal const j)
 
static NotTEC preflight1 (PreflightContext const &ctx, std::uint32_t flagMask)
 Performs early sanity checks on the account and fee fields.
 
static NotTEC preflight2 (PreflightContext const &ctx)
 Checks whether the signature appears valid.
 

Detailed Description

Definition at line 121 of file Transactor.h.

Member Enumeration Documentation

◆ ConsequencesFactoryType

Enumerator
Normal 
Blocker 
Custom 

Definition at line 138 of file Transactor.h.

Constructor & Destructor Documentation

◆ ~Transactor()

virtual xrpl::Transactor::~Transactor ( )
protectedvirtualdefault

◆ Transactor() [1/2]

xrpl::Transactor::Transactor ( Transactor const &  )
protecteddelete

◆ Transactor() [2/2]

xrpl::Transactor::Transactor ( ApplyContext ctx)
explicitprotected

Definition at line 236 of file Transactor.cpp.

Member Function Documentation

◆ operator=()

Transactor & xrpl::Transactor::operator= ( Transactor const &  )
protecteddelete

◆ operator()()

ApplyResult xrpl::Transactor::operator() ( )

Process the transaction.

Definition at line 1135 of file Transactor.cpp.

◆ view() [1/2]

ApplyView & xrpl::Transactor::view ( )

Definition at line 144 of file Transactor.h.

◆ view() [2/2]

ApplyView const & xrpl::Transactor::view ( ) const

Definition at line 150 of file Transactor.h.

◆ checkSeqProxy()

NotTEC xrpl::Transactor::checkSeqProxy ( ReadView const &  view,
STTx const &  tx,
beast::Journal  j 
)
static

Definition at line 432 of file Transactor.cpp.

◆ checkPriorTxAndLastLedger()

NotTEC xrpl::Transactor::checkPriorTxAndLastLedger ( PreclaimContext const &  ctx)
static

Definition at line 503 of file Transactor.cpp.

◆ checkFee()

TER xrpl::Transactor::checkFee ( PreclaimContext const &  ctx,
XRPAmount  baseFee 
)
static

Definition at line 332 of file Transactor.cpp.

◆ checkSign() [1/2]

NotTEC xrpl::Transactor::checkSign ( PreclaimContext const &  ctx)
static

Definition at line 728 of file Transactor.cpp.

◆ checkBatchSign()

NotTEC xrpl::Transactor::checkBatchSign ( PreclaimContext const &  ctx)
static

Definition at line 738 of file Transactor.cpp.

◆ calculateBaseFee()

XRPAmount xrpl::Transactor::calculateBaseFee ( ReadView const &  view,
STTx const &  tx 
)
static

Definition at line 283 of file Transactor.cpp.

◆ invokePreflight() [1/3]

template<class T >
NotTEC xrpl::Transactor::invokePreflight ( PreflightContext const &  ctx)
static

Definition at line 393 of file Transactor.h.

◆ preclaim()

static TER xrpl::Transactor::preclaim ( PreclaimContext const &  ctx)
static

Definition at line 214 of file Transactor.h.

◆ checkPermission()

NotTEC xrpl::Transactor::checkPermission ( ReadView const &  view,
STTx const &  tx 
)
static

Definition at line 267 of file Transactor.cpp.

◆ ticketDelete()

TER xrpl::Transactor::ticketDelete ( ApplyView view,
AccountID const &  account,
uint256 const &  ticketIndex,
beast::Journal  j 
)
static

Definition at line 552 of file Transactor.cpp.

◆ apply()

TER xrpl::Transactor::apply ( )
protected

Definition at line 622 of file Transactor.cpp.

◆ preCompute()

void xrpl::Transactor::preCompute ( )
protectedvirtual

Reimplemented in xrpl::Change, and xrpl::SetSignerList.

Definition at line 614 of file Transactor.cpp.

◆ doApply()

virtual TER xrpl::Transactor::doApply ( )
protectedpure virtual

Implemented in xrpl::AMMBid, xrpl::AMMClawback, xrpl::AMMCreate, xrpl::AMMDelete, xrpl::AMMDeposit, xrpl::AMMVote, xrpl::AMMWithdraw, xrpl::Batch, xrpl::CancelCheck, xrpl::CancelOffer, xrpl::CashCheck, xrpl::Change, xrpl::Clawback, xrpl::CreateCheck, xrpl::CreateOffer, xrpl::CreateTicket, xrpl::CredentialCreate, xrpl::CredentialDelete, xrpl::CredentialAccept, xrpl::DelegateSet, xrpl::DeleteAccount, xrpl::DeleteOracle, xrpl::DepositPreauth, xrpl::DIDSet, xrpl::DIDDelete, xrpl::EscrowCreate, xrpl::EscrowFinish, xrpl::EscrowCancel, xrpl::LedgerStateFix, xrpl::LoanBrokerCoverClawback, xrpl::LoanBrokerCoverDeposit, xrpl::LoanBrokerCoverWithdraw, xrpl::LoanBrokerDelete, xrpl::LoanBrokerSet, xrpl::LoanDelete, xrpl::LoanManage, xrpl::LoanPay, xrpl::LoanSet, xrpl::MPTokenAuthorize, xrpl::MPTokenIssuanceCreate, xrpl::MPTokenIssuanceDestroy, xrpl::MPTokenIssuanceSet, xrpl::NFTokenAcceptOffer, xrpl::NFTokenBurn, xrpl::NFTokenCancelOffer, xrpl::NFTokenCreateOffer, xrpl::NFTokenMint, xrpl::NFTokenModify, xrpl::PayChanCreate, xrpl::PayChanFund, xrpl::PayChanClaim, xrpl::Payment, xrpl::PermissionedDomainDelete, xrpl::PermissionedDomainSet, xrpl::SetAccount, xrpl::SetOracle, xrpl::SetRegularKey, xrpl::SetSignerList, xrpl::SetTrust, xrpl::VaultClawback, xrpl::VaultCreate, xrpl::VaultDelete, xrpl::VaultDeposit, xrpl::VaultSet, xrpl::VaultWithdraw, xrpl::XChainCreateBridge, xrpl::BridgeModify, xrpl::XChainClaim, xrpl::XChainCommit, xrpl::XChainCreateClaimID, xrpl::XChainAddClaimAttestation, xrpl::XChainAddAccountCreateAttestation, and xrpl::XChainCreateAccountCommit.

◆ minimumFee()

XRPAmount xrpl::Transactor::minimumFee ( Application app,
XRPAmount  baseFee,
Fees const &  fees,
ApplyFlags  flags 
)
staticprotected

Compute the minimum fee required to process a transaction with a given baseFee based on the current server load.

Parameters
appThe application hosting the server
baseFeeThe base fee of a candidate transaction
See also
xrpl::calculateBaseFee
Parameters
feesFee settings from the current ledger
flagsTransaction processing fees

Definition at line 322 of file Transactor.cpp.

◆ calculateOwnerReserveFee()

XRPAmount xrpl::Transactor::calculateOwnerReserveFee ( ReadView const &  view,
STTx const &  tx 
)
staticprotected

Definition at line 302 of file Transactor.cpp.

◆ checkSign() [2/2]

NotTEC xrpl::Transactor::checkSign ( ReadView const &  view,
ApplyFlags  flags,
std::optional< uint256 const > const &  parentBatchId,
AccountID const &  idAccount,
STObject const &  sigObject,
beast::Journal const  j 
)
staticprotected

Definition at line 659 of file Transactor.cpp.

◆ checkExtraFeatures()

bool xrpl::Transactor::checkExtraFeatures ( PreflightContext const &  ctx)
staticprotected

Definition at line 357 of file Transactor.h.

◆ getFlagsMask()

std::uint32_t xrpl::Transactor::getFlagsMask ( PreflightContext const &  ctx)
staticprotected

Definition at line 255 of file Transactor.cpp.

◆ preflightSigValidated()

NotTEC xrpl::Transactor::preflightSigValidated ( PreflightContext const &  ctx)
staticprotected

Definition at line 261 of file Transactor.cpp.

◆ validDataLength()

bool xrpl::Transactor::validDataLength ( std::optional< Slice > const &  slice,
std::size_t  maxLength 
)
staticprotected

Definition at line 245 of file Transactor.cpp.

◆ validNumericRange() [1/2]

template<class T >
bool xrpl::Transactor::validNumericRange ( std::optional< T >  value,
max,
min = T{} 
)
staticprotected

Definition at line 420 of file Transactor.h.

◆ validNumericRange() [2/2]

template<class T , class Unit >
bool xrpl::Transactor::validNumericRange ( std::optional< T >  value,
unit::ValueUnit< Unit, T >  max,
unit::ValueUnit< Unit, T >  min = unit::ValueUnit<Unit, T>{} 
)
staticprotected

Definition at line 429 of file Transactor.h.

◆ validNumericMinimum() [1/2]

template<class T >
bool xrpl::Transactor::validNumericMinimum ( std::optional< T >  value,
min = T{} 
)
staticprotected

Minimum will usually be zero.

Definition at line 439 of file Transactor.h.

◆ validNumericMinimum() [2/2]

template<class T , class Unit >
bool xrpl::Transactor::validNumericMinimum ( std::optional< T >  value,
unit::ValueUnit< Unit, T >  min = unit::ValueUnit<Unit, T>{} 
)
staticprotected

Minimum will usually be zero.

Definition at line 448 of file Transactor.h.

◆ reset()

std::pair< TER, XRPAmount > xrpl::Transactor::reset ( XRPAmount  fee)
private

Reset the context, discarding any changes made and adjust the fee.

Parameters
feeThe transaction fee to be charged.
Returns
A pair containing the transaction result and the actual fee charged.

Definition at line 1073 of file Transactor.cpp.

◆ consumeSeqProxy()

TER xrpl::Transactor::consumeSeqProxy ( SLE::pointer const &  sleAccount)
private

Definition at line 533 of file Transactor.cpp.

◆ payFee()

TER xrpl::Transactor::payFee ( )
private

Definition at line 397 of file Transactor.cpp.

◆ checkSingleSign()

NotTEC xrpl::Transactor::checkSingleSign ( ReadView const &  view,
AccountID const &  idSigner,
AccountID const &  idAccount,
std::shared_ptr< SLE const >  sleAccount,
beast::Journal const  j 
)
staticprivate

Definition at line 784 of file Transactor.cpp.

◆ checkMultiSign()

NotTEC xrpl::Transactor::checkMultiSign ( ReadView const &  view,
ApplyFlags  flags,
AccountID const &  id,
STObject const &  sigObject,
beast::Journal const  j 
)
staticprivate

Definition at line 816 of file Transactor.cpp.

◆ trapTransaction()

void xrpl::Transactor::trapTransaction ( uint256  txHash) const
private

Definition at line 1128 of file Transactor.cpp.

◆ preflight1()

NotTEC xrpl::Transactor::preflight1 ( PreflightContext const &  ctx,
std::uint32_t  flagMask 
)
staticprivate

Performs early sanity checks on the account and fee fields.

(And passes flagMask to preflight0)

Do not try to call preflight1 from preflight() in derived classes. See the description of invokePreflight for details.

Definition at line 144 of file Transactor.cpp.

◆ preflight2()

NotTEC xrpl::Transactor::preflight2 ( PreflightContext const &  ctx)
staticprivate

Checks whether the signature appears valid.

Do not try to call preflight2 from preflight() in derived classes. See the description of invokePreflight for details.

Definition at line 199 of file Transactor.cpp.

◆ invokePreflight() [2/3]

template<>
NotTEC xrpl::Transactor::invokePreflight ( PreflightContext const &  ctx)
static

Definition at line 18 of file Change.cpp.

◆ invokePreflight() [3/3]

template<>
NotTEC xrpl::Transactor::invokePreflight ( PreflightContext const &  ctx)
static

Member Data Documentation

◆ ctx_

ApplyContext& xrpl::Transactor::ctx_
protected

Definition at line 124 of file Transactor.h.

◆ sink_

beast::WrappedSink xrpl::Transactor::sink_
protected

Definition at line 125 of file Transactor.h.

◆ j_

beast::Journal const xrpl::Transactor::j_
protected

Definition at line 126 of file Transactor.h.

◆ account_

AccountID const xrpl::Transactor::account_
protected

Definition at line 128 of file Transactor.h.

◆ mPriorBalance

XRPAmount xrpl::Transactor::mPriorBalance
protected

Definition at line 129 of file Transactor.h.

◆ mSourceBalance

XRPAmount xrpl::Transactor::mSourceBalance
protected

Definition at line 130 of file Transactor.h.