1#include <test/jtx/Account.h>
3#include <xrpl/basics/Number.h>
4#include <xrpl/basics/base_uint.h>
5#include <xrpl/beast/unit_test/suite.h>
6#include <xrpl/ledger/helpers/VaultHelpers.h>
7#include <xrpl/protocol/Asset.h>
8#include <xrpl/protocol/Indexes.h>
9#include <xrpl/protocol/Issue.h>
10#include <xrpl/protocol/MPTIssue.h>
11#include <xrpl/protocol/Protocol.h>
12#include <xrpl/protocol/SField.h>
13#include <xrpl/protocol/STAmount.h>
14#include <xrpl/protocol/STIssue.h>
15#include <xrpl/protocol/STLedgerEntry.h>
16#include <xrpl/protocol/STNumber.h>
17#include <xrpl/protocol/STTakesAsset.h>
18#include <xrpl/protocol/TER.h>
19#include <xrpl/protocol/UintTypes.h>
58 char const*
name =
nullptr;
76 vault->setFieldIssue(sfAsset,
STIssue{sfAsset, asset});
77 vault->at(sfAssetsTotal) = assetsTotal;
82 vault->at(sfScale) = *fixedScale;
84 vault->at(sfAssetsAvailable) = assetsTotal;
85 vault->at(sfAssetsDeployed) =
Number{0};
95 template <std::
size_t N>
101 bool viaClampVaultOutflow =
false)
110 for (
auto const& c : cases)
114 auto const vault =
makeVault(asset, c.assetsTotal, fixedScale);
116 Number(vault->at(sfAssetsTotal)) == c.assetsTotal,
118 ": assetsTotal is not a genuine on-grid STAmount value (associateAsset "
121 STAmount const delta{asset, c.delta};
124 std::string(c.name) +
": delta is not a genuine on-grid STAmount value");
127 for (
auto const mode : modes)
143 result.has_value() == reference->has_value(),
144 std::string(c.name) +
": result depends on ambient rounding mode");
145 if (result.has_value() && reference->has_value())
148 *result == **reference,
149 std::string(c.name) +
": value depends on ambient rounding mode");
151 else if (!result.has_value() && !reference->has_value())
154 result.error() == reference->error(),
155 std::string(c.name) +
": error depends on ambient rounding mode");
163 std::string(c.name) +
": expected tecPRECISION_LOSS, got success value " +
164 (result.has_value() ? result->getText() :
std::string()));
165 if (!result.has_value())
169 std::string(c.name) +
": expected tecPRECISION_LOSS, got " +
219 bool const isDebit = c.delta.mantissa() < 0;
221 isDebit ? c.assetsTotal -
Number(*result) : c.assetsTotal +
Number(*result);
222 int const postScale =
scale(posterior, asset);
223 int const checkScale =
224 isDebit ? postScale :
std::min(postScale,
scale(c.assetsTotal, asset));
228 reFloored == *result,
229 std::string(c.name) +
": result " + result->getText() +
230 " is not exact on the posterior grid (scale " +
244 testcase(
"probe: default Number regime is Large330 (19-digit mantissa)");
252 Number const probe{9'223'372'036'854'775'807LL, 0};
253 BEAST_EXPECT(probe.
mantissa() == 9'223'372'036'854'775'807LL);
254 BEAST_EXPECT(probe.
exponent() == 0);
271 .name =
"IOU debit: on-grid, same decade",
272 .assetsTotal =
Number{1'000'000'000'000'005LL, -9},
274 .expected =
Number{1, -9},
290 .name =
"IOU debit: sub-ULP at the naive scale, but not at the true postScale",
291 .assetsTotal =
Number{1'000'000, 0},
292 .delta =
Number{-73, -11},
293 .expected =
Number{7, -10},
304 .name =
"IOU debit: exact at the true (finer) postScale",
305 .assetsTotal =
Number{1'000'000, 0},
306 .delta =
Number{-53, -10},
307 .expected =
Number{53, -10},
317 .name =
"IOU debit: decade-crossing debit, floored (not exact) at finer grid",
318 .assetsTotal =
Number{1, 0},
319 .delta =
Number{-73, -17},
320 .expected =
Number{7, -16},
329 .name =
"IOU debit: near-total debit, unchanged (finer postScale than magnitude)",
330 .assetsTotal =
Number{1'000'000, 0},
331 .delta =
Number{-9'999'999'999'999'999LL, -10},
332 .expected =
Number{9'999'999'999'999'999LL, -10},
353 .name =
"IOU credit: on-grid",
354 .assetsTotal =
Number{1'000'000, 0},
356 .expected =
Number{2, -9},
379 .name =
"IOU credit: overcredit fix across a scale boundary",
380 .assetsTotal =
Number{9'999'999'999'999'999LL, -15},
382 .expected =
Number{4'999'999'999'999'991LL, -15},
406 .name =
"IOU credit: Finding-1 regression, ToNearest sum would overcredit",
407 .assetsTotal =
Number{1'000'000, 0},
408 .delta =
Number{9'999'999'999'999'999LL, -25},
409 .expected = std::nullopt,
419 .name =
"IOU credit: Finding-1 regression, 19-digit half-even tie",
420 .assetsTotal =
Number{1'000'000, 0},
421 .delta =
Number{9'995, -13},
422 .expected = std::nullopt,
428 .name =
"IOU credit: zero-total vault",
431 .expected =
Number{37, -6},
441 .name =
"IOU credit: sub-ULP credit",
442 .assetsTotal =
Number{1'000'000, 0},
444 .expected = std::nullopt,
462 .name =
"MPT debit: magnitude is positive, not the signed delta",
463 .assetsTotal =
Number{1'000'000},
468 .name =
"MPT credit: unchanged",
469 .assetsTotal =
Number{1'000'000},
478 .name =
"XRP debit: magnitude is positive, not the signed delta",
479 .assetsTotal =
Number{100'000},
484 .name =
"XRP credit: unchanged",
485 .assetsTotal =
Number{100'000},
509 Number const onGrid{3'234'567, -6};
515 .name =
"FixedPrecision credit: exact on the base grid",
516 .assetsTotal = onGrid,
518 .expected =
Number{2, -6},
522 .name =
"FixedPrecision credit: truncated toward zero on the base grid",
523 .assetsTotal = onGrid,
525 .expected =
Number{2, -6},
530 .name =
"FixedPrecision credit: sub-ULP dust rejected at the base grid",
531 .assetsTotal = onGrid,
533 .expected = std::nullopt,
552 Number const onGrid{3'234'567, -6};
558 .name =
"FixedPrecision debit: exact on the base grid",
559 .assetsTotal = onGrid,
561 .expected =
Number{1, -6},
569 .name =
"FixedPrecision debit: truncated toward zero on the base grid",
570 .assetsTotal = onGrid,
572 .expected =
Number{1, -6},
577 .name =
"FixedPrecision debit: sub-ULP dust rejected at the base grid",
578 .assetsTotal = onGrid,
580 .expected = std::nullopt,
584 runCases(iou, cases, fixedScale,
true);
TestcaseT testcase
Memberspace for declaring test cases.
A currency issued by an account.
Number is a floating point type that can represent a wide range of values.
constexpr rep mantissa() const noexcept
Returns the mantissa of the external view of the Number.
static MantissaRange::MantissaScale getMantissaScale()
Returns which mantissa scale is currently in use for normalization.
constexpr int exponent() const noexcept
Returns the exponent of the external view of the Number.
std::string getText() const override
void testFixedPrecisionCredit(Asset const &iou)
void testIntegralAssets(Asset const &mpt, Asset const &xrp)
void testIouCredits(Asset const &iou)
void run() override
Runs the suite.
void testIouDebits(Asset const &iou)
void runCases(Asset const &asset, std::array< Case, N > const &cases, std::optional< std::uint8_t > fixedScale=std::nullopt, bool viaClampVaultOutflow=false)
void testProbeLarge330Regime()
static std::shared_ptr< SLE > makeVault(Asset const &asset, Number const &assetsTotal, std::optional< std::uint8_t > fixedScale=std::nullopt)
void testFixedPrecisionDebit(Asset const &iou)
Immutable cryptographic account descriptor.
AccountID id() const
Returns the Account ID.
Keylet vault(AccountID const &owner, SeqProxy const &seq) noexcept
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Issue const & xrpIssue()
Returns an asset specifier that represents XRP.
std::expected< STAmount, TER > clampVaultOutflow(SLE::ConstRef vault, STAmount const &delta)
Outflow clamp dispatcher for VaultWithdraw and VaultClawback: rounds a negative delta to the scale ap...
int scale(Number const &number, Asset const &asset)
Get the scale of a Number for a given asset.
std::expected< STAmount, TER > clampToAssetsTotalScale(SLE::ConstRef vault, STAmount const &delta)
Adjusts a requested asset change (delta) to match the decimal scale of the updated total vault assets...
bool toCurrency(Currency &, std::string const &)
Tries to convert a string to a Currency, returns true on success.
std::string transToken(TER code)
STAmount roundToScale(STAmount const &value, std::int32_t scale, Number::RoundingMode rounding=Number::getround())
Round an arbitrary precision Amount to the precision of an STAmount that has a given exponent.
MPTID makeMptID(std::uint32_t const sequence, AccountID const &account)
constexpr Number abs(Number x) noexcept
void associateAsset(STLedgerEntry &sle, Asset const &asset)
Associate an Asset with all sMD_NeedsAsset fields in a ledger entry.
BEAST_DEFINE_TESTSUITE(AccountTxPaging, app, xrpl)
std::optional< Number > expected