1#include <xrpl/basics/Number.h>
2#include <xrpl/beast/utility/Journal.h>
3#include <xrpl/ledger/helpers/VaultHelpers.h>
4#include <xrpl/protocol/Asset.h>
5#include <xrpl/protocol/Indexes.h>
6#include <xrpl/protocol/Issue.h>
7#include <xrpl/protocol/MPTIssue.h>
8#include <xrpl/protocol/Protocol.h>
9#include <xrpl/protocol/SField.h>
10#include <xrpl/protocol/STAmount.h>
11#include <xrpl/protocol/STLedgerEntry.h>
12#include <xrpl/protocol/STNumber.h>
13#include <xrpl/protocol/TER.h>
14#include <xrpl/protocol/UintTypes.h>
16#include <gtest/gtest.h>
17#include <helpers/Account.h>
18#include <protocol/VaultTestHelpers.h>
34 Number assetsDeployed;
39 static BalanceSnapshot
43 .available =
vault->at(sfAssetsAvailable),
44 .assetsDeployed =
vault->at(sfAssetsDeployed),
45 .loss =
vault->at(sfLossUnrealized),
46 .yield =
vault->at(sfYieldUnrealized),
47 .total =
vault->at(sfAssetsTotal),
52 operator==(BalanceSnapshot
const&)
const =
default;
55class VaultBalance :
public ::testing::Test
58 test::Account
const issuer_{
"issuer"};
59 Issue
const iou_{
toCurrency(
"USD"), issuer_.id()};
63 [[nodiscard]] std::shared_ptr<SLE>
65 Number
const& assetsDeployed,
66 Number
const& available,
67 Number
const& stored = Number{0},
68 std::uint8_t
scale = 6)
const
75 [[nodiscard]] std::shared_ptr<SLE>
78 return iouVault(Number{500}, Number{100});
81 [[nodiscard]] STAmount
82 iouAmount(Number
const& n)
const
84 return STAmount{iou_, n};
89 syncTotal(std::shared_ptr<SLE>
const& vault)
98 expectCacheFloorsExactTotal(std::shared_ptr<SLE>
const& vault)
const
101 Number
const cached =
vault->at(sfAssetsTotal);
102 EXPECT_LE(cached, exact);
103 int const liveExponent =
scale(cached, iou_);
104 EXPECT_LE(exact - cached, (Number{1, liveExponent}));
109 checkIntegralControl(Asset
const& asset)
117 EXPECT_EQ(
vault->at(sfAssetsAvailable), Number{125});
130TEST_F(VaultBalance, get_assets_total_stored_for_non_fixed_precision)
134 std::string_view name;
136 std::int64_t stored = 0;
137 std::int64_t available = 0;
139 std::vector<Row>
const rows{
149 for (
auto const& row : rows)
151 SCOPED_TRACE(row.name);
155 EXPECT_FALSE(
vault->isFieldPresent(sfAssetsDeployed));
159TEST_F(VaultBalance, get_assets_total_fixed_precision_derived_sum)
163 std::string_view name;
164 Number assetsDeployed;
167 bool cacheExact =
false;
169 std::vector<Row>
const rows{
172 .assetsDeployed =
Number{250'000},
173 .available =
Number{1'000'000},
179 .name =
"ExactPastSixteenDigits",
180 .assetsDeployed =
Number{8, -6},
181 .available =
Number{9'999'999'999'999'999, -6},
185 for (
auto const& row : rows)
187 SCOPED_TRACE(row.name);
188 auto const vault = iouVault(row.assetsDeployed, row.available);
189 Number const exact = row.available + row.assetsDeployed;
200 expectCacheFloorsExactTotal(vault);
204TEST_F(VaultBalance, get_assets_total_fixed_precision_integral_exact)
211TEST_F(VaultBalance, get_assets_total_ignores_stale_cache)
213 Number const available{4'000'000};
214 Number const assetsDeployed{1'000'000};
215 auto const vault = iouVault(assetsDeployed, available,
Number{99});
222TEST_F(VaultBalance, get_assets_total_never_below_available)
224 Number const available{9'999'999'999'999'999, -6};
225 Number const assetsDeployed{5'000'000'000, -6};
226 auto const vault = iouVault(assetsDeployed, available);
231 EXPECT_GE(
Number(
vault->at(sfAssetsTotal)), available);
238TEST_F(VaultBalance, live_scale_downward_keeps_lower_exponent_at_carry_boundary)
242 int const downwardExponent = [&] {
246 int const toNearestExponent = [&] {
250 EXPECT_LT(downwardExponent, toNearestExponent);
254 EXPECT_EQ(
scale(
vault->at(sfAssetsTotal), iou_), downwardExponent);
258TEST_F(VaultBalance, scale_and_open_include_assets_deployed)
261 Number const available{1'000'000'000};
262 Number const assetsDeployed{9'000'000'000};
263 auto const vault = iouVault(assetsDeployed, available, available);
270 auto const nearOpen = iouVault(
Number{1, 9},
Number{8, 9});
278TEST_F(VaultBalance, fixed_precision_adjust_balances)
280 Number const assetsDeployed{300};
285 EXPECT_EQ(
vault->at(sfAssetsAvailable),
Number{150});
286 EXPECT_EQ(
vault->at(sfAssetsDeployed), assetsDeployed);
292 EXPECT_EQ(
vault->at(sfAssetsAvailable),
Number{130});
293 EXPECT_EQ(
vault->at(sfAssetsDeployed), assetsDeployed);
301 {.cash = iouAmount(
Number{-130}), .deployed = -
Number(assetsDeployed)},
304 EXPECT_EQ(
vault->at(sfAssetsAvailable),
Number{0});
310TEST_F(VaultBalance, fixed_precision_add_above_coarsening_syncs)
312 Number const assetsDeployed{5, -6};
313 auto const vault = iouVault(assetsDeployed,
Number{9'999'999'999'999'990, -6});
317 EXPECT_EQ(
vault->at(sfAssetsDeployed), assetsDeployed);
318 expectCacheFloorsExactTotal(vault);
324TEST_F(VaultBalance, trust_line_arithmetic_mirror)
328 std::string_view name;
332 std::vector<Row>
const rows{
333 {.name =
"Plain", .balance =
Number{1'000'000}, .delta =
Number{500'000}},
335 .name =
"CreditCrossesPowerOfTenUp",
336 .balance =
Number{9'999'999'999'999'999, -9},
340 .name =
"DebitCrossesPowerOfTenDown",
341 .balance =
Number{1'000'000'000'000'000, -9},
344 {.name =
"DebitPartial", .balance =
Number{5'000'000}, .delta =
Number{-3'000'000}},
345 {.name =
"DebitToZero", .balance =
Number{2'000'000}, .delta =
Number{-2'000'000}},
347 .name =
"CreditFinerThanBalanceGrid",
348 .balance =
Number{1'873'013'129'122'272LL, -9},
353 for (
auto const& row : rows)
355 SCOPED_TRACE(row.name);
356 STAmount const balance{iou_, row.balance};
357 STAmount const delta{iou_, row.delta};
367TEST_F(VaultBalance, fields_move)
371 std::string_view name;
372 std::int64_t
cash = 0;
373 std::int64_t deployed = 0;
374 std::int64_t
yield = 0;
375 std::int64_t loss = 0;
376 std::int64_t expectedAvailable = 100;
377 std::int64_t expectedAssetsDeployed = 500;
378 std::int64_t expectedYield = 0;
379 std::int64_t expectedLoss = 0;
381 std::vector<Row>
const rows{
382 {.name =
"CashAlone", .cash = 25, .expectedAvailable = 125},
383 {.name =
"AssetsDeployedAlone", .deployed = -200, .expectedAssetsDeployed = 300},
384 {.name =
"YieldAlone", .yield = 40, .expectedYield = 40},
385 {.name =
"LossAlone", .loss = 150, .expectedLoss = 150},
387 .name =
"AllTogether",
392 .expectedAvailable = 140,
393 .expectedAssetsDeployed = 400,
399 for (
auto const& row : rows)
401 SCOPED_TRACE(row.name);
402 auto const vault = standardVault();
406 {.cash = iouAmount(
Number{row.cash}),
407 .deployed =
Number{row.deployed},
408 .yield =
Number{row.yield},
409 .loss =
Number{row.loss}},
412 EXPECT_EQ(
vault->at(sfAssetsAvailable),
Number{row.expectedAvailable});
413 EXPECT_EQ(
vault->at(sfAssetsDeployed),
Number{row.expectedAssetsDeployed});
414 EXPECT_EQ(
vault->at(sfYieldUnrealized),
Number{row.expectedYield});
415 EXPECT_EQ(
vault->at(sfLossUnrealized),
Number{row.expectedLoss});
422TEST_F(VaultBalance, invalid_change_fails_atomically)
426 std::string_view name;
427 std::int64_t
cash = 0;
428 std::int64_t deployed = 0;
429 std::int64_t loss = 0;
432 std::vector<Row>
const rows{
433 {.name =
"AssetsAvailableNegative", .cash = -200, .expected =
tefBAD_LEDGER},
434 {.name =
"AssetsDeployedNegative", .deployed = -600, .expected =
tefBAD_LEDGER},
437 .name =
"AssetsDeployedNegativeWithValidCash",
445 .name =
"LossExceedsAssetsDeployedWithValidCash",
450 {.name =
"LossUnrealizedNegative", .loss = -1, .expected =
tefBAD_LEDGER},
451 {.name =
"LossExceedsAssetsDeployed", .loss = 600, .expected =
tecLIMIT_EXCEEDED},
454 for (
auto const& row : rows)
456 SCOPED_TRACE(row.name);
457 auto const vault = standardVault();
458 BalanceSnapshot
const before = BalanceSnapshot::of(vault);
463 {.cash = iouAmount(
Number{row.cash}),
464 .deployed =
Number{row.deployed},
465 .loss =
Number{row.loss}},
468 EXPECT_EQ(BalanceSnapshot::of(vault), before);
472TEST_F(VaultBalance, loss_at_assets_deployed_boundary_allowed)
474 auto const vault = standardVault();
476 EXPECT_EQ(
vault->at(sfLossUnrealized),
Number{500});
479TEST_F(VaultBalance, negative_yield_unrealized_rejected)
481 auto const vault = standardVault();
483 auto const before = BalanceSnapshot::of(vault);
486 EXPECT_EQ(BalanceSnapshot::of(vault), before);
489TEST_F(VaultBalance, assets_total_equals_floor16_of_available_plus_assets_deployed)
491 Number const assetsDeployed{7, -9};
492 auto vault = iouVault(assetsDeployed,
Number{9'999'999'999'999'999, -9},
Number{0}, 9);
496 Number const expected = [&] {
500 EXPECT_EQ(
Number(
vault->at(sfAssetsTotal)), expected);
507TEST_F(VaultBalance, xrp_control)
512TEST_F(VaultBalance, mpt_control)
517TEST_F(VaultBalance, credit_to_posterior_scale_ignores_ambient_rounding_mode)
524 Number const reference{4'218'667'505'995'833LL, -10};
525 STAmount const raw{iou_, std::int64_t{4'004'426'170'440'612LL}, -8};
526 int const atScale = -7;
531 Number const exactDownwardCredit = [&] {
537 EXPECT_LT(exactDownwardCredit,
Number(raw));
546 EXPECT_EQ(
Number(credit), exactDownwardCredit);
549TEST_F(VaultBalance, credit_to_posterior_scale_just_under_power_of_ten_is_not_negative)
555 Number const reference{9'999'999'999'999'999LL, -10};
556 Number const raw{9'970'000'001LL, -20};
557 int const baseScale = -10;
562 EXPECT_EQ(credit,
STAmount(iou_, 0));
568TEST_F(VaultBalance, credit_to_posterior_available_scale_integral_passes_through)
576TEST_F(VaultBalance, credit_to_posterior_available_scale_floors_to_base_grid)
583 EXPECT_EQ(credit, iouAmount(
Number{1'234'567, -6}));
586TEST_F(VaultBalance, credit_to_posterior_available_scale_floors_the_sum_across_power_of_ten)
594 EXPECT_EQ(credit, iouAmount(
Number{11, -6}));
597 iouAmount(
Number{1'000'000'000'000'001, -5}));
600TEST_F(VaultBalance, credit_to_posterior_available_scale_uses_the_exact_raw_amount)
610 EXPECT_EQ(credit, iouAmount(
Number{1'234'567'890'123'456, -5}));
static Sink & getNullSink()
Returns a Sink which does nothing.
Number is a floating point type that can represent a wide range of values.
std::shared_ptr< STLedgerEntry const > const & ConstRef
STAmount creditToPosteriorScale(Asset const &asset, Number const &reference, int baseScale, Number const &raw, Number::RoundingMode roundingMode)
Shared core of creditToPosteriorAvailableScale and creditToPosteriorBrokerCoverScale: floors referenc...
Keylet vault(AccountID const &owner, SeqProxy const &seq) noexcept
json::Value cash(jtx::Account const &dest, UInt256 const &checkId, STAmount const &amount)
Cash a check requiring that a specific amount be delivered.
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Issue const & xrpIssue()
Returns an asset specifier that represents XRP.
constexpr bool operator==(BaseUInt< Bits, Tag > const &lhs, BaseUInt< Bits, Tag > const &rhs)
int scale(Number const &number, Asset const &asset)
Get the scale of a Number for a given asset.
int getVaultScale(SLE::ConstRef vault)
Return the Vault's current live exponent.
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)
TEST_F(HardenedHashTest, user_types)
bool toCurrency(Currency &, std::string const &)
Tries to convert a string to a Currency, returns true on success.
TER adjustVaultBalances(SLE::Ref vault, VaultBalanceChange const &change, beast::Journal j)
Apply a balance change to a FixedPrecision Vault.
VaultVersion
Vault ledger-entry schema versions, persisted as sfLEVersion.
int getVaultBaseScale(SLE::ConstRef vault)
Return the Vault's base exponent.
TER checkOptionalVaultInflow(SLE::ConstRef vault, STAmount const &amount)
Check whether amount is an admissible optional inflow.
MPTID makeMptID(std::uint32_t const sequence, AccountID const &account)
void roundToAsset(A const &asset, Number &value)
Round an arbitrary precision Number IN PLACE to the precision of a given Asset.
TERSubset< CanCvtToTER > TER
Number getAssetsTotal(SLE::ConstRef vault)
Return the Vault's current assets total.
STAmount creditToPosteriorAvailableScale(SLE::ConstRef vault, Number const &raw, Number::RoundingMode roundingMode)
Round a FixedPrecision cash inflow (LoanPay's credit, LoanManage's default cover credit) into AssetsA...