xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
tx
transactors
payment
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
17
namespace
xrpl
{
18
19
class
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
27
public
:
28
static
constexpr
auto
kConsequencesFactory
=
ConsequencesFactoryType::Custom
;
29
30
explicit
Payment
(
ApplyContext
& ctx) :
Transactor
(ctx)
31
{
32
}
33
34
static
TxConsequences
35
makeTxConsequences
(
PreflightContext
const
& ctx);
36
37
static
bool
38
checkExtraFeatures
(
PreflightContext
const
& ctx);
39
40
static
std::uint32_t
41
getFlagsMask
(
PreflightContext
const
& ctx);
42
43
static
NotTEC
44
preflight
(
PreflightContext
const
& ctx);
45
46
static
NotTEC
47
checkGranularSemantics
(
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::ConstRef
before,
SLE::ConstRef
after
)
override
;
60
61
[[nodiscard]]
bool
62
finalizeInvariants
(
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
beast::Journal
A generic endpoint for log messages.
Definition
Journal.h:44
xrpl::ApplyContext
State information when applying a tx.
Definition
ApplyContext.h:28
xrpl::Payment::kConsequencesFactory
static constexpr auto kConsequencesFactory
Definition
tx/transactors/payment/Payment.h:28
xrpl::Payment::kMaxPathLength
static std::size_t const kMaxPathLength
Definition
tx/transactors/payment/Payment.h:25
xrpl::Payment::visitInvariantEntry
void visitInvariantEntry(bool isDelete, SLE::ConstRef before, SLE::ConstRef after) override
Inspect a single ledger entry modified by this transaction.
Definition
Payment.cpp:840
xrpl::Payment::makeTxConsequences
static TxConsequences makeTxConsequences(PreflightContext const &ctx)
Definition
Payment.cpp:49
xrpl::Payment::preflight
static NotTEC preflight(PreflightContext const &ctx)
Definition
Payment.cpp:113
xrpl::Payment::getFlagsMask
static std::uint32_t getFlagsMask(PreflightContext const &ctx)
Definition
Payment.cpp:97
xrpl::Payment::checkExtraFeatures
static bool checkExtraFeatures(PreflightContext const &ctx)
Definition
Payment.cpp:86
xrpl::Payment::finalizeInvariants
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:846
xrpl::Payment::kMaxPathSize
static std::size_t const kMaxPathSize
Definition
tx/transactors/payment/Payment.h:22
xrpl::Payment::doApply
TER doApply() override
Definition
Payment.cpp:521
xrpl::Payment::Payment
Payment(ApplyContext &ctx)
Definition
tx/transactors/payment/Payment.h:30
xrpl::Payment::checkGranularSemantics
static NotTEC checkGranularSemantics(ReadView const &view, STTx const &tx, std::unordered_set< GranularPermissionType > const &heldGranularPermissions)
Definition
Payment.cpp:291
xrpl::Payment::preclaim
static TER preclaim(PreclaimContext const &ctx)
Definition
Payment.cpp:378
xrpl::ReadView
A view into a ledger.
Definition
ReadView.h:41
xrpl::STLedgerEntry::ConstRef
std::shared_ptr< STLedgerEntry const > const & ConstRef
Definition
STLedgerEntry.h:37
xrpl::STTx
Definition
STTx.h:43
xrpl::Transactor::ConsequencesFactoryType::Custom
@ Custom
Definition
Transactor.h:175
xrpl::Transactor::view
ApplyView & view()
Definition
Transactor.h:184
xrpl::Transactor::Transactor
Transactor(Transactor const &)=delete
xrpl::TxConsequences
Class describing the consequences to the account of applying a transaction if the transaction consume...
Definition
applySteps.h:53
xrpl::XRPAmount
Definition
XRPAmount.h:28
cstddef
cstdint
std::uint32_t
xrpl
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition
algorithm.h:5
xrpl::NotTEC
TERSubset< CanCvtToNotTEC > NotTEC
Definition
TER.h:614
xrpl::after
bool after(NetClock::time_point now, std::uint32_t mark)
Has the specified time passed?
Definition
View.cpp:644
xrpl::TER
TERSubset< CanCvtToTER > TER
Definition
TER.h:654
std::size_t
xrpl::PreclaimContext
State information when determining if a tx is likely to claim a fee.
Definition
Transactor.h:92
xrpl::PreflightContext
State information when preflighting a tx.
Definition
Transactor.h:39
unordered_set
Generated by
1.17.0