1#include <xrpl/tx/transactors/lending/LoanBrokerSet.h>
3#include <xrpl/basics/Log.h>
4#include <xrpl/basics/Number.h>
5#include <xrpl/beast/utility/Zero.h>
6#include <xrpl/core/ServiceRegistry.h>
7#include <xrpl/ledger/View.h>
8#include <xrpl/ledger/helpers/AccountRootHelpers.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/Feature.h>
15#include <xrpl/protocol/Indexes.h>
16#include <xrpl/protocol/LedgerFormats.h>
17#include <xrpl/protocol/Protocol.h>
18#include <xrpl/protocol/SField.h>
19#include <xrpl/protocol/STAmount.h>
20#include <xrpl/protocol/STLedgerEntry.h>
21#include <xrpl/protocol/STNumber.h>
22#include <xrpl/protocol/STTakesAsset.h>
23#include <xrpl/protocol/STTx.h>
24#include <xrpl/protocol/TER.h>
25#include <xrpl/protocol/TxFlags.h>
26#include <xrpl/protocol/XRPAmount.h>
27#include <xrpl/tx/Transactor.h>
48 auto const& tx = ctx.
tx;
49 if (
auto const data = tx[~sfData];
61 if (tx.isFieldPresent(sfLoanBrokerID))
66 if (tx.isFieldPresent(sfManagementFeeRate) || tx.isFieldPresent(sfCoverRateMinimum) ||
67 tx.isFieldPresent(sfCoverRateLiquidation))
74 if (tx.isFlag(tfLoanBrokerPrivate))
82 if (
auto const domainID = tx[~sfDomainID])
89 if (!tx.isFlag(tfLoanBrokerPrivate))
97 if (
auto const vaultID = tx.at(~sfVaultID))
104 auto const minimumZero = tx[~sfCoverRateMinimum].value_or(0) == 0;
105 auto const liquidationZero = tx[~sfCoverRateLiquidation].value_or(0) == 0;
107 if (minimumZero != liquidationZero)
129 return tfLoanBrokerSetMask;
137 auto const& tx = ctx.
tx;
139 auto const account = tx[sfAccount];
140 auto const vaultID = tx[sfVaultID];
145 JLOG(ctx.
j.
warn()) <<
"Vault does not exist.";
148 Asset const asset = sleVault->at(sfAsset);
150 if (account != sleVault->at(sfOwner))
152 JLOG(ctx.
j.
warn()) <<
"Account is not the owner of the Vault.";
156 if (
auto const brokerID = tx[~sfLoanBrokerID])
163 JLOG(ctx.
j.
warn()) <<
"LoanBroker does not exist.";
166 if (vaultID != sleBroker->at(sfVaultID))
168 JLOG(ctx.
j.
warn()) <<
"Can not change VaultID on an existing LoanBroker.";
171 if (account != sleBroker->at(sfOwner))
173 JLOG(ctx.
j.
warn()) <<
"Account is not the owner of the LoanBroker.";
177 if (
auto const debtMax = tx[~sfDebtMaximum])
180 auto const currentDebtTotal = sleBroker->at(sfDebtTotal);
181 if (*debtMax != 0 && *debtMax < currentDebtTotal)
183 JLOG(ctx.
j.
warn()) <<
"Cannot reduce DebtMaximum below current DebtTotal.";
188 if (!sleBroker->isFlag(lsfLoanBrokerPrivate) && tx.isFieldPresent(sfDomainID))
203 JLOG(ctx.
j.
warn()) <<
"LoanBroker requires a closed-ended Vault.";
210 if (
auto const ter =
checkFrozen(ctx.
view, sleVault->at(sfAccount), sleVault->at(sfAsset)))
212 JLOG(ctx.
j.
warn()) <<
"Vault pseudo-account is frozen.";
217 if (
auto const domainID = tx[~sfDomainID]; domainID && *domainID !=
beast::kZero)
221 JLOG(ctx.
j.
warn()) <<
"Domain does not exist.";
233 if (
auto const value = tx[field]; value &&
235 STAmount{asset, *value} != *value ||
239 JLOG(ctx.
j.
warn()) << field.f->getName() <<
" (" << *value
240 <<
") can not be represented as a(n) " <<
to_string(asset) <<
".";
251 auto const& tx =
ctx_.tx;
254 if (
auto const brokerID = tx[~sfLoanBrokerID])
262 JLOG(
j_.fatal()) <<
"LoanBroker does not exist.";
271 auto const vaultAsset = vault->at(sfAsset);
273 if (
auto const data = tx[~sfData])
274 broker->at(sfData) = *data;
275 if (
auto const debtMax = tx[~sfDebtMaximum])
276 broker->at(sfDebtMaximum) = *debtMax;
278 if (
auto const domainID = tx[~sfDomainID])
282 broker->setFieldH256(sfDomainID, *domainID);
284 else if (broker->isFieldPresent(sfDomainID))
286 broker->makeFieldAbsent(sfDomainID);
297 auto const vaultID = tx[sfVaultID];
303 JLOG(
j_.fatal()) <<
"Vault does not exist.";
307 auto const vaultPseudoID = sleVault->at(sfAccount);
308 auto const vaultAsset = sleVault->at(sfAsset);
309 auto const sequence = tx.getSeqProxy();
316 JLOG(
j_.fatal()) <<
"Account does not exist.";
324 if (
auto const ter =
dirLink(
view, vaultPseudoID, broker, sfVaultNode))
335 return maybePseudo.error();
336 auto const& pseudo = *maybePseudo;
337 AccountID const pseudoId = pseudo->at(sfAccount);
344 broker->at(sfSequence) = sequence.value();
345 broker->at(sfVaultID) = vaultID;
347 broker->at(sfAccount) = pseudoId;
349 broker->at(sfLoanSequence) = 1;
350 if (
auto const data = tx[~sfData])
351 broker->at(sfData) = *data;
352 if (
auto const rate = tx[~sfManagementFeeRate])
353 broker->at(sfManagementFeeRate) = *rate;
354 if (
auto const debtMax = tx[~sfDebtMaximum])
355 broker->at(sfDebtMaximum) = *debtMax;
356 if (
auto const coverMin = tx[~sfCoverRateMinimum])
357 broker->at(sfCoverRateMinimum) = *coverMin;
358 if (
auto const coverLiq = tx[~sfCoverRateLiquidation])
359 broker->at(sfCoverRateLiquidation) = *coverLiq;
361 if (tx.isFlag(tfLoanBrokerPrivate))
363 broker->setFlag(lsfLoanBrokerPrivate);
364 if (
auto const domainID = tx[~sfDomainID])
365 broker->setFieldH256(sfDomainID, *domainID);
A generic endpoint for log messages.
static NotTEC preflight(PreflightContext const &ctx)
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 std::uint32_t getFlagsMask(PreflightContext const &ctx)
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 std::vector< OptionaledField< STNumber > > const & getValueFields()
static bool checkExtraFeatures(PreflightContext const &ctx)
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 bool exists(Keylet const &k) const =0
Determine if a state item exists.
virtual SLE::const_pointer read(Keylet const &k) const =0
Return the state item associated with a key.
bool enabled(UInt256 const &feature) const
Returns true if a feature is enabled.
std::shared_ptr< STLedgerEntry const > const & ConstRef
bool isFieldPresent(SField const &field) const
AccountID const accountID_
static bool validDataLength(std::optional< Slice > const &slice, std::size_t maxLength)
static bool validNumericRange(std::optional< T > value, T max, T min=T{})
Keylet vault(AccountID const &owner, SeqProxy const &seq) noexcept
Keylet permissionedDomain(AccountID const &account, SeqProxy const &seq) noexcept
Keylet loanBroker(AccountID const &owner, SeqProxy const &seq) noexcept
Keylet account(AccountID const &id) noexcept
AccountID root.
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
bool isOnVaultBaseGrid(Asset const &asset, Number const &value, int baseScale)
Returns true iff value is exactly representable both as an STAmount of asset and on the base grid at ...
TER checkFrozen(ReadView const &view, AccountID const &account, Issue const &issue)
std::expected< SLE::pointer, TER > createPseudoAccount(ApplyView &view, UInt256 const &pseudoOwnerKey, SField const &ownerField)
Create pseudo-account, storing pseudoOwnerKey into ownerField.
TER addEmptyHolding(ApplyViewContext ctx, AccountID const &accountID, XRPAmount priorBalance, MPTIssue const &mptIssue, beast::Journal journal)
void increaseOwnerCount(ApplyView &view, SLE::Ref accountSle, SLE::Ref sponsorSle, std::uint32_t count, beast::Journal j)
Increase owner-count fields when the caller supplies the sponsor.
std::string to_string(BaseUInt< Bits, Tag > const &a)
constexpr std::size_t kMaxDataPayloadLength
The maximum length of Data payload.
TER canAddHolding(ReadView const &view, MPTIssue const &mptIssue)
TERSubset< CanCvtToNotTEC > NotTEC
int getVaultBaseScale(SLE::ConstRef vault)
Return the Vault's base exponent.
VaultKind getVaultKind(SLE::ConstRef vault)
Resolves the VaultKind of a vault SLE.
bool isRepresentable(Asset const &asset, Number const &value)
Check whether an arbitrary precision Number can be converted to an STAmount of a given Asset without ...
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
TER dirLink(ApplyView &view, AccountID const &owner, SLE::pointer const &object, SF_UINT64 const &node=sfOwnerNode)
TERSubset< CanCvtToTER > TER
XRPAmount accountReserve(ReadView const &view, SLE::ConstRef sle, beast::Journal j, Adjustment adj={})
Returns the account reserve, in drops.
@ tecINSUFFICIENT_RESERVE
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.
constexpr std::uint64_t kMaxMpTokenAmount
The maximum amount of MPTokenIssuance.
constexpr FlagValue tfUniversalMask
bool checkLendingProtocolDependencies(Rules const &rules, STTx const &tx)
State information when determining if a tx is likely to claim a fee.
State information when preflighting a tx.