1#include <xrpl/basics/Number.h>
2#include <xrpl/basics/base_uint.h>
3#include <xrpl/protocol/Asset.h>
4#include <xrpl/protocol/Indexes.h>
5#include <xrpl/protocol/Issue.h>
6#include <xrpl/protocol/MPTIssue.h>
7#include <xrpl/protocol/Protocol.h>
8#include <xrpl/protocol/SField.h>
9#include <xrpl/protocol/STAmount.h>
10#include <xrpl/protocol/STLedgerEntry.h>
11#include <xrpl/protocol/STNumber.h>
12#include <xrpl/protocol/STTakesAsset.h>
13#include <xrpl/protocol/UintTypes.h>
14#include <xrpl/protocol/Units.h>
15#include <xrpl/tx/transactors/lending/LoanManage.h>
17#include <gtest/gtest.h>
18#include <helpers/Account.h>
19#include <protocol/VaultTestHelpers.h>
36 Number const& coverAvailable,
42 broker->at(sfCoverAvailable) = coverAvailable;
43 broker->at(sfDebtTotal) = debtTotal;
44 broker->at(sfCoverRateMinimum) = coverRateMinimum.value();
45 broker->at(sfCoverRateLiquidation) = coverRateLiquidation.value();
53makeLoan(
Asset const& asset,
Number const& principalOutstanding)
56 loan->at(sfPrincipalOutstanding) = principalOutstanding;
70 Number const& principalOutstanding)
79 Number assetsAvailable;
80 Number coverAvailable;
84 Number principalOutstanding;
95checkCoverCase(
Asset const& asset, std::uint8_t
scale, CoverCase
const& in)
104 auto const broker = makeBroker(
105 asset, in.coverAvailable, in.debtTotal, in.coverRateMinimum, in.coverRateLiquidation);
106 auto const loan = makeLoan(asset, in.principalOutstanding);
110 Number const rawCover = rawCoverFor(
111 in.debtTotal, in.coverRateMinimum, in.coverRateLiquidation, in.principalOutstanding);
113 std::ostringstream context;
114 context <<
"scale=" << int(
scale) <<
" assetsAvailable=" << in.assetsAvailable
115 <<
" coverAvailable=" << in.coverAvailable <<
" debtTotal=" << in.debtTotal
116 <<
" coverRateMinimum=" << in.coverRateMinimum.value()
117 <<
" coverRateLiquidation=" << in.coverRateLiquidation.value()
118 <<
" principalOutstanding=" << in.principalOutstanding <<
" rawCover=" << rawCover
119 <<
" cover=" <<
Number(cover);
122 EXPECT_LE(
Number(cover), rawCover) <<
"cover exceeds uncapped XLS-66 amount: " << context.
str();
123 EXPECT_LE(
Number(cover), in.coverAvailable)
124 <<
"cover exceeds CoverAvailable: " << context.
str();
129 Number const vaultSum = in.assetsAvailable +
Number(cover);
130 STAmount const vaultRounded{asset, vaultSum};
131 bool const coverCanCarryAssetsAvailable =
137 if (coverCanCarryAssetsAvailable)
139 EXPECT_EQ(
Number(vaultRounded), vaultSum)
140 <<
"AssetsAvailable + cover not exactly 16-digit representable: " << context.
str();
144 Number const vaultRoundingError =
abs(
Number(vaultRounded) - vaultSum);
146 <<
"AssetsAvailable + cover rounding error exceeds half a posterior ulp: "
152 Number const brokerSum = in.coverAvailable -
Number(cover);
153 STAmount const brokerRounded{asset, brokerSum};
154 Number const brokerRoundingError =
abs(
Number(brokerRounded) - brokerSum);
156 <<
"CoverAvailable - cover rounding error exceeds half a posterior ulp: " << context.
str();
161TEST(LoanDefaultCover, hand_picked_cases)
177 .assetsAvailable =
Number{1000},
178 .coverAvailable =
Number{5000},
179 .debtTotal =
Number{10000},
180 .coverRateMinimum = halfRate,
181 .coverRateLiquidation = halfRate,
182 .principalOutstanding =
Number{2000},
187 Number const coarseCoverAvailable{2'000'000'000'000'000, -5};
192 .assetsAvailable =
Number{100},
193 .coverAvailable = coarseCoverAvailable,
194 .debtTotal =
Number{1000},
195 .coverRateMinimum = fullRate,
196 .coverRateLiquidation = fullRate,
197 .principalOutstanding =
Number{500},
202 Number const coarseAssetsAvailable{9'999'999'999'999'999, -6};
207 .assetsAvailable = coarseAssetsAvailable,
208 .coverAvailable =
Number{50},
209 .debtTotal =
Number{1000},
210 .coverRateMinimum = fullRate,
211 .coverRateLiquidation = fullRate,
212 .principalOutstanding =
Number{30},
220 .assetsAvailable = coarseAssetsAvailable,
221 .coverAvailable = coarseCoverAvailable,
222 .debtTotal =
Number{1000},
223 .coverRateMinimum = fullRate,
224 .coverRateLiquidation = fullRate,
225 .principalOutstanding =
Number{900},
234 .assetsAvailable =
Number{1000},
235 .coverAvailable =
Number{1},
236 .debtTotal =
Number{1'000'000},
237 .coverRateMinimum = fullRate,
238 .coverRateLiquidation = fullRate,
239 .principalOutstanding =
Number{1'000'000},
248 .assetsAvailable =
Number{1000},
249 .coverAvailable =
Number{1'000'000},
250 .debtTotal =
Number{1'000'000},
251 .coverRateMinimum = fullRate,
252 .coverRateLiquidation = fullRate,
253 .principalOutstanding =
Number{5},
261TEST(LoanDefaultCover, uses_exact_raw_cover)
267 Number const assetsAvailable{5, -6};
268 Number const coverAvailable{2, 11};
269 Number const debtTotal{1'234'567'890'123'457LL, -4};
271 Number const principalOutstanding{2, 11};
275 auto const broker = makeBroker(iou, coverAvailable, debtTotal, rate, rate);
276 auto const loan = makeLoan(iou, principalOutstanding);
278 Number const rawCover = rawCoverFor(debtTotal, rate, rate, principalOutstanding);
288 Number const sum = assetsAvailable + rawCover;
291 return STAmount{iou, flooredSum - assetsAvailable};
293 EXPECT_EQ(cover, expected) <<
"rawCover=" << rawCover <<
" cover=" <<
Number(cover);
296TEST(LoanDefaultCover, integral_asset_cases)
310 .assetsAvailable =
Number{1000},
311 .coverAvailable =
Number{200},
313 .coverRateMinimum = fullRate,
314 .coverRateLiquidation = fullRate,
315 .principalOutstanding =
Number{150},
320TEST(LoanDefaultCover, randomized_sweep)
327 constexpr int kIterations = 5000;
343 int const digits = digitsDist(rng);
345 for (
int i = 0; i < digits - 1; ++i)
349 int const shape = shapeDist(rng);
353 return (powerOfTen * 10) - 1;
356 return mantissaDist(rng);
361 auto const pickExponent = [&rng](
int minExponent) ->
int {
365 auto const pickNumber = [&](
int minExponent) ->
Number {
366 return Number{pickMantissa(), pickExponent(minExponent)};
369 for (
int i = 0; i < kIterations; ++i)
372 int const minExponent = -
static_cast<int>(
scale);
374 .assetsAvailable = pickNumber(minExponent),
375 .coverAvailable = pickNumber(minExponent),
376 .debtTotal = pickNumber(minExponent),
377 .coverRateMinimum = pickRate(),
378 .coverRateLiquidation = pickRate(),
379 .principalOutstanding = pickNumber(minExponent),
382 checkCoverCase(iou,
scale, in);
A currency issued by an account.
static STAmount calculateDefaultCover(SLE::Ref loanSle, SLE::Ref brokerSle, SLE::Ref vaultSle)
Compute the First-Loss Capital cover amount for a defaulted Loan on a FixedPrecision Vault,...
Number is a floating point type that can represent a wide range of values.
Immutable cryptographic account descriptor.
AccountID id() const
Returns the Account ID.
Keylet vault(AccountID const &owner, SeqProxy const &seq) noexcept
Keylet loanBroker(AccountID const &owner, SeqProxy const &seq) noexcept
Keylet loan(UInt256 const &loanBrokerID, SeqProxy const &loanSeq) noexcept
constexpr TenthBips32 kMaxCoverRate
The maximum coverage rate required of a loan broker in 1/10 bips.
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Issue const & xrpIssue()
Returns an asset specifier that represents XRP.
static auto sum(TCollection const &col)
TEST(FileUtilitiesTest, get_file_contents)
constexpr TenthBips32 percentageToTenthBips(std::uint32_t percentage)
constexpr T tenthBipsOfValue(T value, TenthBips< TBips > bips)
int scale(Number const &number, Asset const &asset)
Get the scale of a Number for a given asset.
std::shared_ptr< SLE > makeVault(Asset const &asset, Number const &assetsTotal, std::optional< VaultVersion > version, std::uint8_t scaleValue=kVaultDefaultIouScale, Number const &assetsDeployed=Number{0}, std::optional< Number > assetsAvailable=std::nullopt)
bool toCurrency(Currency &, std::string const &)
Tries to convert a string to a Currency, returns true on success.
TenthBips< std::uint32_t > TenthBips32
constexpr std::uint8_t kFixedPrecisionVaultMaximumIouScale
Maximum Scale for a Vault created under featureLendingProtocolV1_2.
MPTID makeMptID(std::uint32_t const sequence, AccountID const &account)
constexpr Number abs(Number x) noexcept
void roundToAsset(A const &asset, Number &value)
Round an arbitrary precision Number IN PLACE to the precision of a given Asset.
void associateAsset(STLedgerEntry &sle, Asset const &asset)
Associate an Asset with all sMD_NeedsAsset fields in a ledger entry.