xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
tx
transactors
vault
tx/transactors/vault/VaultClawback.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/AccountID.h>
7
#include <xrpl/protocol/STAmount.h>
8
#include <xrpl/protocol/STTx.h>
9
#include <xrpl/protocol/TER.h>
10
#include <xrpl/protocol/XRPAmount.h>
11
#include <xrpl/tx/ApplyContext.h>
12
#include <xrpl/tx/Transactor.h>
13
14
#include <expected>
15
#include <
utility
>
16
17
namespace
xrpl
{
18
19
class
VaultClawback
:
public
Transactor
20
{
21
public
:
22
static
constexpr
auto
kConsequencesFactory
=
ConsequencesFactoryType::Normal
;
23
24
explicit
VaultClawback
(
ApplyContext
& ctx) :
Transactor
(ctx)
25
{
26
}
27
28
static
NotTEC
29
preflight
(
PreflightContext
const
& ctx);
30
31
static
TER
32
preclaim
(
PreclaimContext
const
& ctx);
33
34
TER
35
doApply
()
override
;
36
37
void
38
visitInvariantEntry
(
bool
isDelete,
SLE::ConstRef
before,
SLE::ConstRef
after
)
override
;
39
40
[[nodiscard]]
bool
41
finalizeInvariants
(
42
STTx
const
& tx,
43
TER
result,
44
XRPAmount
fee,
45
ReadView
const
&
view
,
46
beast::Journal
const
& j)
override
;
47
48
private
:
49
std::expected<std::pair<STAmount, STAmount>,
TER
>
50
assetsToClawback
(
51
SLE::Ref
vault,
52
SLE::ConstRef
sleShareIssuance,
53
AccountID
const
& holder,
54
STAmount
const
&
clawbackAmount
);
55
};
56
57
}
// 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::ReadView
A view into a ledger.
Definition
ReadView.h:41
xrpl::STAmount
Definition
STAmount.h:46
xrpl::STLedgerEntry::ConstRef
std::shared_ptr< STLedgerEntry const > const & ConstRef
Definition
STLedgerEntry.h:37
xrpl::STLedgerEntry::Ref
std::shared_ptr< STLedgerEntry > const & Ref
Definition
STLedgerEntry.h:35
xrpl::STTx
Definition
STTx.h:43
xrpl::Transactor::ConsequencesFactoryType::Normal
@ Normal
Definition
Transactor.h:175
xrpl::Transactor::view
ApplyView & view()
Definition
Transactor.h:184
xrpl::Transactor::Transactor
Transactor(Transactor const &)=delete
xrpl::VaultClawback::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
VaultClawback.cpp:551
xrpl::VaultClawback::VaultClawback
VaultClawback(ApplyContext &ctx)
Definition
tx/transactors/vault/VaultClawback.h:24
xrpl::VaultClawback::preflight
static NotTEC preflight(PreflightContext const &ctx)
Definition
VaultClawback.cpp:36
xrpl::VaultClawback::assetsToClawback
std::expected< std::pair< STAmount, STAmount >, TER > assetsToClawback(SLE::Ref vault, SLE::ConstRef sleShareIssuance, AccountID const &holder, STAmount const &clawbackAmount)
Definition
VaultClawback.cpp:234
xrpl::VaultClawback::visitInvariantEntry
void visitInvariantEntry(bool isDelete, SLE::ConstRef before, SLE::ConstRef after) override
Inspect a single ledger entry modified by this transaction.
Definition
VaultClawback.cpp:545
xrpl::VaultClawback::preclaim
static TER preclaim(PreclaimContext const &ctx)
Definition
VaultClawback.cpp:79
xrpl::VaultClawback::kConsequencesFactory
static constexpr auto kConsequencesFactory
Definition
tx/transactors/vault/VaultClawback.h:22
xrpl::VaultClawback::doApply
TER doApply() override
Definition
VaultClawback.cpp:390
xrpl::XRPAmount
Definition
XRPAmount.h:28
xrpl
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition
algorithm.h:5
xrpl::clawbackAmount
STAmount clawbackAmount(SLE::ConstRef vault, std::optional< STAmount > const &maybeAmount, AccountID const &account)
Definition
VaultClawback.cpp:63
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::AccountID
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition
AccountID.h:34
xrpl::TER
TERSubset< CanCvtToTER > TER
Definition
TER.h:654
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
utility
Generated by
1.17.0