1#include <test/app/vault/VaultPrecisionFixture.h>
2#include <test/jtx/Env.h>
3#include <test/jtx/amount.h>
4#include <test/jtx/envconfig.h>
5#include <test/jtx/ter.h>
6#include <test/jtx/vault.h>
8#include <xrpl/basics/Number.h>
9#include <xrpl/beast/unit_test/suite.h>
10#include <xrpl/beast/utility/Journal.h>
11#include <xrpl/protocol/Feature.h>
12#include <xrpl/protocol/MPTIssue.h>
13#include <xrpl/protocol/STAmount.h>
14#include <xrpl/protocol/TER.h>
48 BEAST_EXPECTS(tDelta == aDelta, tag +
" tDelta != aDelta");
49 BEAST_EXPECTS(tDelta == pDelta, tag +
" tDelta != pDelta");
57 testcase(
"deposit clamp does not over-credit");
61 for (
auto const amount : kAmounts)
71 auto const before =
read(env, f);
75 .depositor = f.depositor,
76 .id = f.vaultKeylet.key,
77 .amount = asset(amount).value(),
86 Number const tDelta =
after.assetsTotal - before.assetsTotal;
87 Number const requested = asset(amount).number();
92 Number const sharesMinted =
after.sharesTotal - before.sharesTotal;
93 if (before.sharesTotal ==
Number{0})
95 Number const shareValue = (before.assetsTotal * sharesMinted) / before.sharesTotal;
103 "amount=" +
std::to_string(amount) +
" discount is not below one unit");
117 .depositor = f.depositor,
118 .id = f.vaultKeylet.key,
119 .amount = asset(99'000'000).value(),
124 auto const before =
read(env, f);
125 Number const kLowerBound{1, 6};
126 BEAST_EXPECT(before.assetsTotal > kLowerBound);
128 auto const tinyAmount = asset(
Number{1, -10}).value();
130 {.depositor = f.depositor, .id = f.vaultKeylet.key, .amount = tinyAmount}),
139 BEAST_EXPECT(
after.assetsTotal == before.assetsTotal);
140 BEAST_EXPECT(
after.assetsAvailable == before.assetsAvailable);
141 BEAST_EXPECT(
after.sharesTotal == before.sharesTotal);
150 testcase(
"withdraw deltas are equal");
162 .depositor = f.depositor,
163 .id = f.vaultKeylet.key,
164 .amount = asset(1'000'000).value(),
170 auto const before =
read(env, f);
171 env(v.
withdraw({.depositor = f.depositor, .id = f.vaultKeylet.key, .amount = amount}),
180 Number const sharesBurned = before.sharesTotal -
after.sharesTotal;
181 if (before.sharesTotal ==
Number{0})
183 Number const shareValue = (before.assetsTotal * sharesBurned) / before.sharesTotal;
184 Number const tDelta = before.assetsTotal -
after.assetsTotal;
185 BEAST_EXPECTS(tDelta <= shareValue, tag + " payout > shareValue
");
188 std::array<std::uint64_t, 3> const kShareCounts{99'999u, 333'333u, 1'234'567u};
189 for (auto const count : kShareCounts)
191 auto const before = read(env, f);
192 if (before.sharesTotal < count)
194 STAmount const shareAmount{MPTIssue{f.share}, Number{static_cast<std::int64_t>(count)}};
195 checkSuccess(shareAmount, "shares=
" + std::to_string(count));
198 std::array<int, 3> const kAssetAmounts{1, 7, 99};
199 for (auto const amount : kAssetAmounts)
200 checkSuccess(asset(amount).value(), "assets=
" + std::to_string(amount));
203 // Withdraw more than sfAssetsAvailable must return tecINSUFFICIENT_FUNDS,
204 // not tecPRECISION_LOSS.
206 testWithdrawInsufficientFundsPrecedence()
210 testcase("withdraw over available returns insufficient funds, not precision loss
");
213 auto f = setupSingleLoanVault(env, /*impairAndPaySibling=*/false);
216 // ready() above guarantees f.asset is engaged; the guard is opaque to clang-tidy.
217 // NOLINTNEXTLINE(bugprone-unchecked-optional-access)
218 jtx::PrettyAsset const& asset = f.asset.value();
222 .depositor = f.depositor,
223 .id = f.vaultKeylet.key,
224 .amount = asset(1'000'000).value(),
229 auto const before = read(env, f);
230 if (!BEAST_EXPECT(before.assetsAvailable > Number{0}))
233 STAmount const request = asset(before.assetsAvailable + Number{1}).value();
234 env(v.withdraw({.depositor = f.depositor, .id = f.vaultKeylet.key, .amount = request}),
239 env.ter() == tecINSUFFICIENT_FUNDS,
248 testcase("clawback deltas are
equal");
251 auto f = setupSingleLoanVault(
253 /*impairAndPaySibling=*/false,
254 /*allowClawback=*/true);
257 // ready() above guarantees f.asset is engaged; the guard is opaque to clang-tidy.
258 // NOLINTNEXTLINE(bugprone-unchecked-optional-access)
259 jtx::PrettyAsset const& asset = f.asset.value();
263 .depositor = f.depositor,
264 .id = f.vaultKeylet.key,
265 .amount = asset(2'000).value(),
270 auto const checkSuccess = [&](std::optional<STAmount> const& amount,
271 std::string const& tag) {
272 auto const before = read(env, f);
273 if (before.sharesTotal == Number{0})
278 .id = f.vaultKeylet.key,
279 .holder = f.depositor,
284 if (env.ter() != tesSUCCESS)
287 assertEqualDeltas(before, read(env, f), tag);
290 std::array<int, 3> const kAmounts{1, 7, 99};
291 for (auto const amount : kAmounts)
292 checkSuccess(asset(amount).value(), "amount=
" + std::to_string(amount));
294 checkSuccess(std::nullopt, "sfAmount absent
");
302 testcase("impaired vault loss stays within assetsTotal - assetsAvailable
");
305 auto f = setupSingleLoanVault(env, /*impairAndPaySibling=*/true);
308 // ready() above guarantees f.asset is engaged; the guard is opaque to clang-tidy.
309 // NOLINTNEXTLINE(bugprone-unchecked-optional-access)
310 jtx::PrettyAsset const& asset = f.asset.value();
314 .depositor = f.depositor,
315 .id = f.vaultKeylet.key,
316 .amount = asset(5'000).value(),
321 auto const checkInvariant = [&](std::string const& tag) {
322 TER const actual = env.ter();
323 BEAST_EXPECTS(actual != tecINVARIANT_FAILED, tag + " unexpected invariant failure
");
324 if (actual != tesSUCCESS)
326 auto const after = read(env, f);
328 after.lossUnrealized <= after.assetsTotal - after.assetsAvailable,
329 tag + " lossUnrealized exceeds assetsTotal - assetsAvailable
");
332 std::array<int, 4> const kAmounts{1, 7, 51, 137};
333 for (std::size_t i = 0; i + 1 < kAmounts.size(); i += 2)
335 int const depositAmount = kAmounts[i];
336 int const withdrawAmount = kAmounts[i + 1];
339 .depositor = f.depositor,
340 .id = f.vaultKeylet.key,
341 .amount = asset(depositAmount).value(),
345 checkInvariant("deposit=
" + std::to_string(depositAmount));
348 .depositor = f.depositor,
349 .id = f.vaultKeylet.key,
350 .amount = asset(withdrawAmount).value(),
354 checkInvariant("withdraw=
" + std::to_string(withdrawAmount));
364 testWithdrawInsufficientFundsPrecedence();
370BEAST_DEFINE_TESTSUITE(VaultTransactorPrecision, app, xrpl);
372} // namespace xrpl::test
bool unexpected(Condition shouldBeFalse, String const &reason)
DEPRECATED.
TestcaseT testcase
Memberspace for declaring test cases.
Number is a floating point type that can represent a wide range of values.
static Number oneUnit(Asset const &asset, Number const &assetsTotalAfter)
static Numbers read(jtx::Env const &env, Fixture const &f)
static Fixture setupSingleLoanVault(jtx::Env &env, bool impairAndPaySibling, bool allowClawback=false)
bool ready(Fixture const &f)
void assertEqualDeltas(Numbers const &before, Numbers const &after, std::string const &tag)
A transaction testing environment.
bool close(NetClock::time_point closeTime, std::optional< std::chrono::milliseconds > consensusDelay=std::nullopt)
Close and advance the ledger.
TER ter() const
Return the TER for the last JTx.
Set the expected result code for a JTx The test will fail if the code doesn't match.
Deposit preauthorize operations.
bool equal(STAmount const &sa1, STAmount const &sa2)
std::unique_ptr< Config > envconfig()
creates and initializes a default configuration for jtx::Env
std::string transToken(TER code)
bool after(NetClock::time_point now, std::uint32_t mark)
Has the specified time passed?
std::optional< BrokerInfo > broker
std::optional< jtx::PrettyAsset > asset
Asset const & raw() const
static json::Value withdraw(WithdrawArgs const &args)
static json::Value deposit(DepositArgs const &args)