ripple::Batch Class Reference

#include <Batch.h>

Inheritance diagram for ripple::Batch:

Collaboration diagram for ripple::Batch:

Public Types
enum	ConsequencesFactoryType { Normal , Blocker , Custom }

Public Member Functions
	Batch (ApplyContext &ctx)
TER	doApply () override
	Applies the outer batch transaction.
ApplyResult	operator() ()
	Process the transaction.
ApplyView &	view ()
ApplyView const &	view () const

Static Public Member Functions
static XRPAmount	calculateBaseFee (ReadView const &view, STTx const &tx)
	Calculates the total base fee for a batch transaction.
static NotTEC	preflight (PreflightContext const &ctx)
	Performs preflight validation checks for a Batch transaction.
static NotTEC	checkSign (PreclaimContext const &ctx)
	Checks the validity of signatures for a batch transaction.
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	checkBatchSign (PreclaimContext const &ctx)
static TER	preclaim (PreclaimContext const &ctx)
static TER	checkPermission (ReadView const &view, STTx const &tx)
static TER	ticketDelete (ApplyView &view, AccountID const &account, uint256 const &ticketIndex, beast::Journal j)

Static Public Attributes
static constexpr ConsequencesFactoryType	ConsequencesFactory {Normal}

Protected Member Functions
TER	apply ()
virtual void	preCompute ()

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.

Protected Attributes
ApplyContext &	ctx_
beast::WrappedSink	sink_
beast::Journal const	j_
AccountID const	account_
XRPAmount	mPriorBalance
XRPAmount	mSourceBalance

Private Member Functions
std::pair< TER, XRPAmount >	reset (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 (AccountID const &idSigner, AccountID const &idAccount, std::shared_ptr< SLE const > sleAccount, Rules const &rules, beast::Journal j)
static NotTEC	checkMultiSign (ReadView const &view, AccountID const &idAccount, STArray const &txSigners, ApplyFlags const &flags, beast::Journal j)

Detailed Description

Definition at line 31 of file src/xrpld/app/tx/detail/Batch.h.

Member Enumeration Documentation

ConsequencesFactoryType

enum ripple::Transactor::ConsequencesFactoryType

inherited

Enumerator
Normal
Blocker
Custom

Definition at line 155 of file Transactor.h.

Constructor & Destructor Documentation

Batch()

ripple::Batch::Batch ( ApplyContext &  ctx )

explicit

Definition at line 36 of file src/xrpld/app/tx/detail/Batch.h.

Member Function Documentation

calculateBaseFee()

XRPAmount ripple::Batch::calculateBaseFee ( ReadView const &  view, STTx const &  tx  )

static

Calculates the total base fee for a batch transaction.

This function computes the required base fee for a batch transaction, including the base fee for the batch itself, the sum of base fees for all inner transactions, and additional fees for each batch signer. It performs overflow checks and validates the structure of the batch and its signers.

Parameters

view	The ledger view providing fee and state information.
tx	The batch transaction to calculate the fee for.

Returns

XRPAmount The total base fee required for the batch transaction.

Exceptions

std::overflow_error	If any fee calculation would overflow the XRPAmount type.
std::length_error	If the number of inner transactions or signers exceeds the allowed maximum.
std::invalid_argument	If an inner transaction is itself a batch transaction.

Definition at line 54 of file Batch.cpp.

preflight()

NotTEC ripple::Batch::preflight ( PreflightContext const &  ctx )

static

Performs preflight validation checks for a Batch transaction.

This function validates the structure and contents of a Batch transaction before it is processed. It ensures that the Batch feature is enabled, checks for valid flags, validates the number and uniqueness of inner transactions, and enforces correct signing and fee requirements.

The following validations are performed:

• The Batch feature must be enabled in the current rules.
• Only one of the mutually exclusive batch flags must be set.
• The batch must contain at least two and no more than the maximum allowed inner transactions.
• Each inner transaction must:
  • Be unique within the batch.
  • Not itself be a Batch transaction.
  • Have the tfInnerBatchTxn flag set.
  • Not include a TxnSignature or Signers field.
  • Have an empty SigningPubKey.
  • Pass its own preflight checks.
  • Have a fee of zero.
  • Have either Sequence or TicketSequence set, but not both or neither.
  • Not duplicate Sequence or TicketSequence values for the same account (for certain flags).
• Validates that all required inner transaction accounts are present in the batch signers array, and that all batch signers are unique and not the outer account.
• Verifies the batch signature if batch signers are present.

Parameters

ctx	The PreflightContext containing the transaction and environment.

Returns

NotTEC Returns tesSUCCESS if all checks pass, or an appropriate error code otherwise.

Definition at line 201 of file Batch.cpp.

checkSign()

NotTEC ripple::Batch::checkSign ( PreclaimContext const &  ctx )

static

Checks the validity of signatures for a batch transaction.

This method first verifies the standard transaction signature by calling Transactor::checkSign. If the signature is not valid it returns the corresponding error code.

Next, it verifies the batch-specific signature requirements by calling Transactor::checkBatchSign. If this check fails, it also returns the corresponding error code.

If both checks succeed, the function returns tesSUCCESS.

Parameters

ctx	The PreclaimContext containing transaction and environment data.

Returns

NotTEC Returns tesSUCCESS if all signature checks pass, or an error code otherwise.

Definition at line 475 of file Batch.cpp.

doApply()

TER ripple::Batch::doApply ( )

overridevirtual

Applies the outer batch transaction.

This method is responsible for applying the outer batch transaction. The inner transactions within the batch are applied separately in the applyBatchTransactions method after the outer transaction is processed.

Returns

TER Returns tesSUCCESS to indicate successful application of the outer batch transaction.

Implements ripple::Transactor.

Definition at line 497 of file Batch.cpp.

operator()()

ApplyResult ripple::Transactor::operator() ( )

inherited

Process the transaction.

Definition at line 1064 of file Transactor.cpp.

view() [1/2]

ApplyView & ripple::Transactor::view ( )

inherited

Definition at line 161 of file Transactor.h.

view() [2/2]

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

inherited

Definition at line 167 of file Transactor.h.

checkSeqProxy()

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

staticinherited

Definition at line 361 of file Transactor.cpp.

checkPriorTxAndLastLedger()

NotTEC ripple::Transactor::checkPriorTxAndLastLedger ( PreclaimContext const &  ctx )

staticinherited

Definition at line 433 of file Transactor.cpp.

checkFee()

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

staticinherited

Definition at line 261 of file Transactor.cpp.

checkBatchSign()

NotTEC ripple::Transactor::checkBatchSign ( PreclaimContext const &  ctx )

staticinherited

Definition at line 638 of file Transactor.cpp.

preclaim()

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

staticinherited

Definition at line 202 of file Transactor.h.

checkPermission()

TER ripple::Transactor::checkPermission ( ReadView const &  view, STTx const &  tx  )

staticinherited

Definition at line 217 of file Transactor.cpp.

ticketDelete()

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

staticinherited

Definition at line 482 of file Transactor.cpp.

apply()

TER ripple::Transactor::apply ( )

protectedinherited

Definition at line 544 of file Transactor.cpp.

preCompute()

void ripple::Transactor::preCompute ( )

protectedvirtualinherited

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

Definition at line 536 of file Transactor.cpp.

minimumFee()

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

staticprotectedinherited

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

Parameters

app	The application hosting the server
baseFee	The base fee of a candidate transaction

See also

ripple::calculateBaseFee

Parameters

fees	Fee settings from the current ledger
flags	Transaction processing fees

Definition at line 251 of file Transactor.cpp.

reset()

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

privateinherited

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

Parameters

fee	The transaction fee to be charged.

Returns

A pair containing the transaction result and the actual fee charged.

Definition at line 1002 of file Transactor.cpp.

consumeSeqProxy()

TER ripple::Transactor::consumeSeqProxy ( SLE::pointer const &  sleAccount )

privateinherited

Definition at line 463 of file Transactor.cpp.

payFee()

TER ripple::Transactor::payFee ( )

privateinherited

Definition at line 326 of file Transactor.cpp.

checkSingleSign()

NotTEC ripple::Transactor::checkSingleSign ( AccountID const &  idSigner, AccountID const &  idAccount, std::shared_ptr< SLE const >  sleAccount, Rules const &  rules, beast::Journal  j  )

staticprivateinherited

Definition at line 685 of file Transactor.cpp.

checkMultiSign()

NotTEC ripple::Transactor::checkMultiSign ( ReadView const &  view, AccountID const &  idAccount, STArray const &  txSigners, ApplyFlags const &  flags, beast::Journal  j  )

staticprivateinherited

Definition at line 746 of file Transactor.cpp.

trapTransaction()

void ripple::Transactor::trapTransaction ( uint256  txHash ) const

privateinherited

Definition at line 1057 of file Transactor.cpp.

Member Data Documentation

ConsequencesFactory

constexpr ConsequencesFactoryType ripple::Batch::ConsequencesFactory {Normal}

staticconstexpr

Definition at line 34 of file src/xrpld/app/tx/detail/Batch.h.

ctx_

ApplyContext& ripple::Transactor::ctx_

protectedinherited

Definition at line 141 of file Transactor.h.

sink_

beast::WrappedSink ripple::Transactor::sink_

protectedinherited

Definition at line 142 of file Transactor.h.

j_

beast::Journal const ripple::Transactor::j_

protectedinherited

Definition at line 143 of file Transactor.h.

account_

AccountID const ripple::Transactor::account_

protectedinherited

Definition at line 145 of file Transactor.h.

mPriorBalance

XRPAmount ripple::Transactor::mPriorBalance

protectedinherited

Definition at line 146 of file Transactor.h.

mSourceBalance

XRPAmount ripple::Transactor::mSourceBalance

protectedinherited

Definition at line 147 of file Transactor.h.