#include <Batch.h>
|
| 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 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 bool | checkExtraFeatures (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.
|
| |
◆ ConsequencesFactoryType
| Enumerator |
|---|
| Normal | |
| Blocker | |
| Custom | |
Definition at line 138 of file Transactor.h.
◆ Batch()
◆ calculateBaseFee()
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
-
Definition at line 35 of file Batch.cpp.
◆ getFlagsMask()
◆ preflight()
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
-
- Returns
- NotTEC Returns tesSUCCESS if all checks pass, or an appropriate error code otherwise.
Definition at line 188 of file Batch.cpp.
◆ preflightSigValidated()
◆ checkSign() [1/2]
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
-
- Returns
- NotTEC Returns tesSUCCESS if all signature checks pass, or an error code otherwise.
Definition at line 497 of file Batch.cpp.
◆ doApply()
| TER xrpl::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 xrpl::Transactor.
Definition at line 519 of file Batch.cpp.
◆ operator()()
◆ view() [1/2]
◆ view() [2/2]
| ApplyView const & xrpl::Transactor::view |
( |
| ) |
const |
|
inherited |
◆ checkSeqProxy()
◆ checkPriorTxAndLastLedger()
◆ checkFee()
◆ checkSign() [2/2]
◆ checkBatchSign()
◆ invokePreflight() [1/3]
◆ invokePreflight() [2/3]
◆ invokePreflight() [3/3]
◆ preclaim()
◆ checkPermission()
◆ ticketDelete()
◆ apply()
| TER xrpl::Transactor::apply |
( |
| ) |
|
|
protectedinherited |
◆ preCompute()
| void xrpl::Transactor::preCompute |
( |
| ) |
|
|
protectedvirtualinherited |
◆ minimumFee()
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
- xrpl::calculateBaseFee
- Parameters
-
| fees | Fee settings from the current ledger |
| flags | Transaction processing fees |
Definition at line 322 of file Transactor.cpp.
◆ calculateOwnerReserveFee()
◆ checkExtraFeatures()
◆ validDataLength()
◆ validNumericRange() [1/2]
template<class T >
| bool xrpl::Transactor::validNumericRange |
( |
std::optional< T > |
value, |
|
|
T |
max, |
|
|
T |
min = T{} |
|
) |
| |
|
staticprotectedinherited |
◆ validNumericRange() [2/2]
template<class T , class Unit >
◆ validNumericMinimum() [1/2]
template<class T >
| bool xrpl::Transactor::validNumericMinimum |
( |
std::optional< T > |
value, |
|
|
T |
min = T{} |
|
) |
| |
|
staticprotectedinherited |
◆ validNumericMinimum() [2/2]
template<class T , class Unit >
◆ reset()
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 1073 of file Transactor.cpp.
◆ consumeSeqProxy()
◆ payFee()
| TER xrpl::Transactor::payFee |
( |
| ) |
|
|
privateinherited |
◆ checkSingleSign()
◆ checkMultiSign()
◆ trapTransaction()
| void xrpl::Transactor::trapTransaction |
( |
uint256 |
txHash | ) |
const |
|
privateinherited |
◆ preflight1()
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()
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.
◆ ConsequencesFactory
◆ disabledTxTypes
| constexpr auto xrpl::Batch::disabledTxTypes |
|
staticconstexpr |
Initial value:
ttVAULT_CREATE,
ttVAULT_SET,
ttVAULT_DELETE,
ttVAULT_DEPOSIT,
ttVAULT_WITHDRAW,
ttVAULT_CLAWBACK,
ttLOAN_BROKER_SET,
ttLOAN_BROKER_DELETE,
ttLOAN_BROKER_COVER_DEPOSIT,
ttLOAN_BROKER_COVER_WITHDRAW,
ttLOAN_BROKER_COVER_CLAWBACK,
ttLOAN_SET,
ttLOAN_DELETE,
ttLOAN_MANAGE,
ttLOAN_PAY,
})
Definition at line 39 of file src/xrpld/app/tx/detail/Batch.h.
◆ ctx_
◆ sink_
◆ j_
◆ account_
◆ mPriorBalance
◆ mSourceBalance
