xrpld
Loading...
Searching...
No Matches
tx/transactors/payment/Payment.h
1#pragma once
2
3#include <xrpl/beast/utility/Journal.h>
4#include <xrpl/core/ServiceRegistry.h>
5#include <xrpl/ledger/ReadView.h>
6#include <xrpl/protocol/Permissions.h>
7#include <xrpl/protocol/STTx.h>
8#include <xrpl/protocol/TER.h>
9#include <xrpl/protocol/XRPAmount.h>
10#include <xrpl/tx/ApplyContext.h>
11#include <xrpl/tx/Transactor.h>
12
13#include <cstddef>
14#include <cstdint>
15#include <unordered_set>
16
17namespace xrpl {
18
19class Payment : public Transactor
20{
21 /* The largest number of paths we allow */
22 static std::size_t const kMaxPathSize = 6;
23
24 /* The longest path we allow */
25 static std::size_t const kMaxPathLength = 8;
26
27public:
29
30 explicit Payment(ApplyContext& ctx) : Transactor(ctx)
31 {
32 }
33
34 static TxConsequences
36
37 static bool
39
40 static std::uint32_t
42
43 static NotTEC
44 preflight(PreflightContext const& ctx);
45
46 static NotTEC
48 ReadView const& view,
49 STTx const& tx,
50 std::unordered_set<GranularPermissionType> const& heldGranularPermissions);
51
52 static TER
53 preclaim(PreclaimContext const& ctx);
54
55 TER
56 doApply() override;
57
58 void
59 visitInvariantEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after) override;
60
61 [[nodiscard]] bool
63 STTx const& tx,
64 TER result,
65 XRPAmount fee,
66 ReadView const& view,
67 beast::Journal const& j) override;
68};
69
70} // namespace xrpl
A generic endpoint for log messages.
Definition Journal.h:44
State information when applying a tx.
static constexpr auto kConsequencesFactory
static std::size_t const kMaxPathLength
static TxConsequences makeTxConsequences(PreflightContext const &ctx)
Definition Payment.cpp:49
static NotTEC preflight(PreflightContext const &ctx)
Definition Payment.cpp:113
static std::uint32_t getFlagsMask(PreflightContext const &ctx)
Definition Payment.cpp:97
static bool checkExtraFeatures(PreflightContext const &ctx)
Definition Payment.cpp:86
void visitInvariantEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after) override
Inspect a single ledger entry modified by this transaction.
Definition Payment.cpp:766
bool finalizeInvariants(STTx const &tx, TER result, XRPAmount fee, ReadView const &view, beast::Journal const &j) override
Check transaction-specific post-conditions after all entries have been visited.
Definition Payment.cpp:772
static std::size_t const kMaxPathSize
TER doApply() override
Definition Payment.cpp:472
static NotTEC checkGranularSemantics(ReadView const &view, STTx const &tx, std::unordered_set< GranularPermissionType > const &heldGranularPermissions)
Definition Payment.cpp:291
static TER preclaim(PreclaimContext const &ctx)
Definition Payment.cpp:359
A view into a ledger.
Definition ReadView.h:41
std::shared_ptr< STLedgerEntry const > const & const_ref
ApplyView & view()
Definition Transactor.h:175
Transactor(Transactor const &)=delete
Class describing the consequences to the account of applying a transaction if the transaction consume...
Definition applySteps.h:52
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:5
TERSubset< CanCvtToNotTEC > NotTEC
Definition TER.h:607
bool after(NetClock::time_point now, std::uint32_t mark)
Has the specified time passed?
Definition View.cpp:572
TERSubset< CanCvtToTER > TER
Definition TER.h:647
State information when determining if a tx is likely to claim a fee.
Definition Transactor.h:83
State information when preflighting a tx.
Definition Transactor.h:38