1#include <xrpl/tx/transactors/lending/LoanBrokerCoverClawback.h>
3#include <xrpl/basics/Log.h>
4#include <xrpl/basics/Number.h>
5#include <xrpl/basics/base_uint.h>
6#include <xrpl/beast/utility/Zero.h>
7#include <xrpl/core/ServiceRegistry.h>
8#include <xrpl/ledger/ReadView.h>
9#include <xrpl/ledger/helpers/LendingHelpers.h>
10#include <xrpl/ledger/helpers/TokenHelpers.h>
11#include <xrpl/ledger/helpers/VaultHelpers.h>
12#include <xrpl/protocol/AccountID.h>
13#include <xrpl/protocol/Asset.h>
14#include <xrpl/protocol/Concepts.h>
15#include <xrpl/protocol/Feature.h>
16#include <xrpl/protocol/Indexes.h>
17#include <xrpl/protocol/Issue.h>
18#include <xrpl/protocol/LedgerFormats.h>
19#include <xrpl/protocol/MPTIssue.h>
20#include <xrpl/protocol/Protocol.h>
21#include <xrpl/protocol/SField.h>
22#include <xrpl/protocol/STAmount.h>
23#include <xrpl/protocol/STLedgerEntry.h>
24#include <xrpl/protocol/STTakesAsset.h>
25#include <xrpl/protocol/STTx.h>
26#include <xrpl/protocol/TER.h>
27#include <xrpl/protocol/Units.h>
28#include <xrpl/protocol/XRPAmount.h>
29#include <xrpl/tx/Transactor.h>
46 auto const brokerID = ctx.
tx[~sfLoanBrokerID];
47 auto const amount = ctx.
tx[~sfAmount];
49 if (!brokerID && !amount)
74 auto const account = ctx.
tx[sfAccount];
78 auto const holder = amount->getIssuer();
87std::expected<UInt256, TER>
92 if (
auto const brokerID = tx[~sfLoanBrokerID])
98 auto const dstAmount = tx[~sfAmount];
99 if (!dstAmount || !dstAmount->holds<
Issue>())
111 auto const maybePseudo = dstAmount->getIssuer();
121 if (
auto const brokerID = sle->at(~sfLoanBrokerID))
130std::expected<Asset, TER>
138 return amount.
asset();
146 if (holder == account)
148 return amount.
asset();
150 if (holder == brokerPseudoAccountID)
160std::expected<STAmount, TER>
163 Asset const& vaultAsset,
168 auto const maxClawAmount = [&] {
169 auto const minRequiredCover = [&] {
170 if (rules.
enabled(fixCleanup3_2_0))
173 sleBroker->at(sfDebtTotal),
181 sleBroker->at(sfDebtTotal),
TenthBips32(sleBroker->at(sfCoverRateMinimum)));
185 return sleBroker->at(sfCoverAvailable) - minRequiredCover;
195 return STAmount{vaultAsset, maxClawAmount};
196 Number const magnitude{*amount};
197 if (magnitude > maxClawAmount)
198 return STAmount{vaultAsset, maxClawAmount};
199 return STAmount{vaultAsset, magnitude};
212template <Val
idIssueType T>
222 if (!sleIssuer.
isFlag(lsfAllowTrustLineClawback) || sleIssuer.
isFlag(lsfNoFreeze))
232 SLE const& sleIssuer,
236 auto const sleIssuance = ctx.
view.
read(issuanceKey);
240 if (!sleIssuance->isFlag(lsfMPTCanClawback))
244 if (sleIssuance->at(sfIssuer) != sleIssuer[sfAccount])
253 auto const& tx = ctx.
tx;
255 auto const account = tx[sfAccount];
258 return findBrokerID.error();
259 auto const brokerID = *findBrokerID;
260 auto const amount = tx[~sfAmount];
265 JLOG(ctx.
j.
warn()) <<
"LoanBroker does not exist.";
269 auto const brokerPseudoAccountID = sleBroker->at(sfAccount);
275 JLOG(ctx.
j.
fatal()) <<
"Vault is missing for Broker " << brokerID;
280 auto const vaultAsset = vault->at(sfAsset);
282 if (vaultAsset.native())
284 JLOG(ctx.
j.
warn()) <<
"Cannot clawback native asset.";
290 if (vaultAsset.getIssuer() != account)
292 JLOG(ctx.
j.
warn()) <<
"Account is not the issuer of the vault asset.";
298 auto const findAsset =
determineAsset(ctx.
view, account, brokerPseudoAccountID, *amount);
300 return findAsset.error();
301 auto const txAsset = *findAsset;
302 if (txAsset != vaultAsset)
304 JLOG(ctx.
j.
warn()) <<
"Account is the correct issuer, but trying "
305 "to clawback the wrong asset from LoanBroker";
310 auto const findClawAmount =
314 JLOG(ctx.
j.
warn()) <<
"LoanBroker cover is already at minimum, or the claw amount "
317 return findClawAmount.error();
319 STAmount const& clawAmount = *findClawAmount;
327 ctx.
view, sleBroker, vaultAsset, clawAmount, ctx.
j,
"LoanBrokerCoverClawback"))
336 brokerPseudoAccountID,
348 JLOG(ctx.
j.
fatal()) <<
"Issuer account does not exist.";
354 [&]<
typename T>(T
const&) {
return preclaimHelper<T>(ctx, *sleIssuer, clawAmount); },
361 auto const& tx =
ctx_.tx;
362 auto const account = tx[sfAccount];
366 auto const brokerID = *findBrokerID;
367 auto const amount = tx[~sfAmount];
373 auto const brokerPseudoID = *sleBroker->at(sfAccount);
379 auto const vaultAsset = vault->at(sfAsset);
381 auto const findClawAmount =
385 STAmount const& clawAmount = *findClawAmount;
391 sleBroker->at(sfCoverAvailable) -= clawAmount;
A generic endpoint for log messages.
virtual SLE::pointer peek(Keylet const &k)=0
Prepare to modify the SLE associated with key.
virtual void update(SLE::Ref sle)=0
Indicate changes to a peeked SLE.
A currency issued by an account.
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.
static TER preclaim(PreclaimContext const &ctx)
void visitInvariantEntry(bool isDelete, SLE::ConstRef before, SLE::ConstRef after) override
Inspect a single ledger entry modified by this transaction.
static NotTEC preflight(PreflightContext const &ctx)
static bool checkExtraFeatures(PreflightContext const &ctx)
constexpr MPTID const & getMptID() const
Number is a floating point type that can represent a wide range of values.
virtual Rules const & rules() const =0
Returns the tx processing rules.
virtual SLE::const_pointer read(Keylet const &k) const =0
Return the state item associated with a key.
Rules controlling protocol behavior.
bool enabled(UInt256 const &feature) const
Returns true if a feature is enabled.
constexpr bool holds() const noexcept
constexpr TIss const & get() const
bool native() const noexcept
Asset const & asset() const
AccountID const & getIssuer() const
std::shared_ptr< STLedgerEntry const > const & ConstRef
bool isFlag(std::uint32_t) const
Keylet vault(AccountID const &owner, SeqProxy const &seq) noexcept
Keylet loanBroker(AccountID const &owner, SeqProxy const &seq) noexcept
Keylet account(AccountID const &id) noexcept
AccountID root.
Keylet mptokenIssuance(MPTID const &issuanceID) noexcept
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
STAmount debitToPosteriorBrokerCoverScale(SLE::ConstRef vault, SLE::ConstRef broker, STAmount const &amount, Number::RoundingMode roundingMode)
Round a cover debit (cover withdraw, cover clawback, the broker-side decrease of a default's cover cr...
constexpr T tenthBipsOfValue(T value, TenthBips< TBips > bips)
bool isLegalNet(STAmount const &value)
TenthBips< std::uint32_t > TenthBips32
std::string transToken(TER code)
std::expected< STAmount, TER > determineClawAmount(SLE::ConstRef sleBroker, Asset const &vaultAsset, std::optional< STAmount > const &amount, SLE::ConstRef vaultSle, Rules const &rules)
Number minimumBrokerCover(Number const &debtTotal, TenthBips32 coverRateMinimum, SLE::ConstRef vaultSle)
Minimum required broker cover, rounded up.
TERSubset< CanCvtToNotTEC > NotTEC
TER accountSend(ApplyView &view, AccountID const &from, AccountID const &to, STAmount const &saAmount, beast::Journal j, SLE::Ref sponsorSle={}, WaiveTransferFee waiveFee=WaiveTransferFee::No, AllowMPTOverflow allowOverflow=AllowMPTOverflow::No)
Calls static accountSendIOU if saAmount represents Issue.
std::expected< UInt256, TER > determineBrokerID(ReadView const &view, STTx const &tx)
TER preclaimHelper< Issue >(PreclaimContext const &ctx, SLE const &sleIssuer, STAmount const &clawAmount)
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
TERSubset< CanCvtToTER > TER
TER preclaimHelper< MPTIssue >(PreclaimContext const &ctx, SLE const &sleIssuer, STAmount const &clawAmount)
void associateAsset(STLedgerEntry &sle, Asset const &asset)
Associate an Asset with all sMD_NeedsAsset fields in a ledger entry.
VaultVersion getVaultVersion(SLE::ConstRef vault)
Resolves a Vault's LEVersion.
TER canApplyToBrokerCover(ReadView const &view, SLE::ConstRef sleBroker, Asset const &vaultAsset, STAmount const &amount, beast::Journal j, std::string_view logPrefix)
Broker cover preclaim precision guard (fixCleanup3_2_0).
STAmount accountHolds(ReadView const &view, AccountID const &account, Currency const ¤cy, AccountID const &issuer, FreezeHandling zeroIfFrozen, beast::Journal j, SpendableHandling includeFullBalance=SpendableHandling::SimpleBalance)
static TER preclaimHelper(PreclaimContext const &ctx, SLE const &sleIssuer, STAmount const &clawAmount)
bool checkLendingProtocolDependencies(Rules const &rules, STTx const &tx)
std::expected< Asset, TER > determineAsset(ReadView const &view, AccountID const &account, AccountID const &brokerPseudoAccountID, STAmount const &amount)
State information when determining if a tx is likely to claim a fee.
State information when preflighting a tx.