1#include <xrpl/beast/unit_test/suite.h>
3#include <test/jtx/Account.h>
4#include <test/jtx/Env.h>
5#include <test/jtx/TestHelpers.h>
6#include <test/jtx/amount.h>
7#include <test/jtx/fee.h>
8#include <test/jtx/pay.h>
9#include <test/jtx/sig.h>
10#include <test/jtx/vault.h>
12#include <xrpl/basics/Number.h>
13#include <xrpl/basics/chrono.h>
14#include <xrpl/ledger/helpers/LendingHelpers.h>
15#include <xrpl/protocol/Feature.h>
16#include <xrpl/protocol/Indexes.h>
17#include <xrpl/protocol/Issue.h>
18#include <xrpl/protocol/LedgerFormats.h>
19#include <xrpl/protocol/Protocol.h>
20#include <xrpl/protocol/SField.h>
21#include <xrpl/protocol/STAmount.h>
22#include <xrpl/protocol/STLedgerEntry.h>
23#include <xrpl/protocol/STTakesAsset.h>
24#include <xrpl/protocol/SeqProxy.h>
25#include <xrpl/protocol/TER.h>
26#include <xrpl/protocol/TxFlags.h>
27#include <xrpl/protocol/Units.h>
46 auto const& rules = env.
current()->rules();
52 Number expectedPaymentFactor;
57 .name =
"Zero periodic rate",
59 .paymentsRemaining = 4,
60 .expectedPaymentFactor =
Number{25, -2},
63 .name =
"One payment remaining",
64 .periodicRate =
Number{5, -2},
65 .paymentsRemaining = 1,
66 .expectedPaymentFactor =
Number{105, -2},
69 .name =
"Multiple payments remaining",
70 .periodicRate =
Number{5, -2},
71 .paymentsRemaining = 3,
72 .expectedPaymentFactor =
Number{3672085646312450436, -19},
75 .name =
"Zero payments remaining",
76 .periodicRate =
Number{5, -2},
77 .paymentsRemaining = 0,
78 .expectedPaymentFactor =
Number{0},
82 for (
auto const& tc : testCases)
84 testcase(
"computePaymentFactor: " + tc.name);
86 auto const computedPaymentFactor =
89 computedPaymentFactor == tc.expectedPaymentFactor,
90 "Payment factor mismatch: expected " +
to_string(tc.expectedPaymentFactor) +
91 ", got " +
to_string(computedPaymentFactor));
100 Env const env{*
this};
101 auto const& rules = env.
current()->rules();
106 Number principalOutstanding;
109 Number expectedPeriodicPayment;
114 .name =
"Zero principal outstanding",
115 .principalOutstanding =
Number{0},
116 .periodicRate =
Number{5, -2},
117 .paymentsRemaining = 5,
118 .expectedPeriodicPayment =
Number{0},
121 .name =
"Zero payments remaining",
122 .principalOutstanding =
Number{1'000},
123 .periodicRate =
Number{5, -2},
124 .paymentsRemaining = 0,
125 .expectedPeriodicPayment =
Number{0},
128 .name =
"Zero periodic rate",
129 .principalOutstanding =
Number{1'000},
130 .periodicRate =
Number{0},
131 .paymentsRemaining = 4,
132 .expectedPeriodicPayment =
Number{250},
135 .name =
"Standard case",
136 .principalOutstanding =
Number{1'000},
138 .paymentsRemaining = 3,
139 .expectedPeriodicPayment =
Number{389569066396123265, -15},
143 for (
auto const& tc : testCases)
145 testcase(
"loanPeriodicPayment: " + tc.name);
148 rules, tc.principalOutstanding, tc.periodicRate, tc.paymentsRemaining);
150 computedPeriodicPayment == tc.expectedPeriodicPayment,
151 "Periodic payment mismatch: expected " +
to_string(tc.expectedPeriodicPayment) +
152 ", got " +
to_string(computedPeriodicPayment));
161 Env const env{*
this};
162 auto const& rules = env.
current()->rules();
170 Number expectedPrincipalOutstanding;
175 .name =
"Zero periodic payment",
176 .periodicPayment =
Number{0},
177 .periodicRate =
Number{5, -2},
178 .paymentsRemaining = 5,
179 .expectedPrincipalOutstanding =
Number{0},
182 .name =
"Zero payments remaining",
183 .periodicPayment =
Number{1'000},
184 .periodicRate =
Number{5, -2},
185 .paymentsRemaining = 0,
186 .expectedPrincipalOutstanding =
Number{0},
189 .name =
"Zero periodic rate",
190 .periodicPayment =
Number{250},
191 .periodicRate =
Number{0},
192 .paymentsRemaining = 4,
193 .expectedPrincipalOutstanding =
Number{1'000},
196 .name =
"Standard case",
197 .periodicPayment =
Number{389569066396123265, -15},
199 .paymentsRemaining = 3,
200 .expectedPrincipalOutstanding =
Number{1'000},
204 for (
auto const& tc : testCases)
206 testcase(
"loanPrincipalFromPeriodicPayment: " + tc.name);
209 rules, tc.periodicPayment, tc.periodicRate, tc.paymentsRemaining);
211 computedPrincipalOutstanding == tc.expectedPrincipalOutstanding,
212 "Principal outstanding mismatch: expected " +
213 to_string(tc.expectedPrincipalOutstanding) +
", got " +
214 to_string(computedPrincipalOutstanding));
226 testcase(
"computePowerMinusOne: zero rate returns zero");
230 testcase(
"computePowerMinusOne: zero paymentsRemaining returns zero");
231 Number const fivePercent{5, -2};
236 testcase(
"computePowerMinusOne: standard case (1.05)^3 - 1 = 0.157625");
238 Number const expected{157625, -6};
243 testcase(
"computePowerMinusOne: r=1, n=1");
253 testcase(
"computePowerMinusOne: near-zero rate matches independent 2r + r^2");
257 Number const independentExpected = 2 * r + r * r;
262 testcase(
"computePowerMinusOne: near-zero rate matches independent 3r + 3r^2 + r^3");
264 Number const independentExpected = 3 * r + 3 * r * r + r * r * r;
275 testcase(
"computePowerMinusOne: large n, early termination matches hybrid output");
300 testcase(
"computePowerMinusOneHybrid: r*n >= 1e-9 uses closed form (bit-exact match)");
302 struct AboveThreshold
309 {.name =
"r=5%, n=3", .r =
Number{5, -2}, .n = 3},
310 {.name =
"r=0.1%, n=1000", .r =
Number{1, -3}, .n = 1'000},
311 {.name =
"r=1e-7, n=100 (above threshold by 10x)", .r =
Number{1, -7}, .n = 100},
313 for (
auto const& tc : cases)
329 "computePowerMinusOneHybrid: r*n < 1e-9 uses binomial expansion (bit-exact match)");
331 struct BelowThreshold
341 .name =
"bug regime: r~1.9e-10, n=2",
345 {.name =
"r=1e-12, n=100", .r =
Number{1, -12}, .n = 100},
347 for (
auto const& tc : cases)
359 testcase(
"computePowerMinusOneHybrid: edge cases");
360 Number const fivePercent{5, -2};
372 testcase(
"computePowerMinusOneHybrid: threshold boundary r*n = 1e-9");
382 {.name =
"r=1e-9, n=1", .r =
Number{1, -9}, .n = 1},
383 {.name =
"r=1e-12, n=1000", .r =
Number{1, -12}, .n = 1'000},
386 for (
auto const& tc : cases)
396 tc.name +
": hybrid should equal closed at threshold; got hybrid=" +
402 Number const tolerance{1, -18};
406 tc.name +
": closed and binomial diverge at threshold by " +
to_string(diff));
418 testcase(
"loanPrincipalFromPeriodicPayment: principal <= payment*n at near-zero rate");
421 Env const env{*
this};
422 auto const& rules = env.
current()->rules();
431 for (
auto const n : {3u, 2u, 1u})
433 auto const computed =
435 auto const upperBound = periodicPayment *
Number{n};
437 computed <= upperBound,
450 testcase(
"computeTheoreticalLoanState: non-negative interestDue at near-zero rate");
453 Env const env{*
this};
454 auto const& rules = env.
current()->rules();
462 BEAST_EXPECT(state.principalOutstanding <= state.valueOutstanding);
463 BEAST_EXPECT(state.interestDue >= 0);
464 BEAST_EXPECT(state.managementFeeDue == 0);
475 testcase(
"computePaymentFactor: near-zero rate, amendment disabled vs enabled");
487 Number const reference = (1 + 3 * r + 3 * r * r + r * r * r) / (3 + 3 * r + r * r);
495 Env const envFix{*
this};
499 BEAST_EXPECT(buggyFactor != correctFactor);
503 BEAST_EXPECT(
abs(correctFactor - reference) <
Number(1, -15));
507 BEAST_EXPECT(
abs(buggyFactor - reference) >
Number(1, -12));
513 testcase(
"computeOverpaymentComponents");
517 Account const issuer{
"issuer"};
519 int32_t
const loanScale = 1;
520 auto const overpayment =
Number{1'000};
521 auto const overpaymentInterestRate =
TenthBips32{10'000};
522 auto const overpaymentFeeRate =
TenthBips32{50'000};
523 auto const managementFeeRate =
TenthBips16{10'000};
525 auto const expectedOverpaymentFee =
Number{500};
526 auto const expectedOverpaymentInterestGross =
Number{100};
527 auto const expectedOverpaymentInterestNet =
Number{90};
528 auto const expectedOverpaymentManagementFee =
Number{10};
529 auto const expectedPrincipalPortion =
Number{400};
531 Env const env{*
this};
537 overpaymentInterestRate,
541 BEAST_EXPECT(components.untrackedManagementFee == expectedOverpaymentFee);
543 BEAST_EXPECT(components.untrackedInterest == expectedOverpaymentInterestNet);
545 BEAST_EXPECT(components.trackedInterestPart() == expectedOverpaymentInterestNet);
547 BEAST_EXPECT(components.trackedManagementFeeDelta == expectedOverpaymentManagementFee);
548 BEAST_EXPECT(components.trackedPrincipalDelta == expectedPrincipalPortion);
550 components.trackedManagementFeeDelta + components.untrackedInterest ==
551 expectedOverpaymentInterestGross);
554 components.trackedManagementFeeDelta + components.untrackedInterest +
555 components.trackedPrincipalDelta + components.untrackedManagementFee ==
570 Number expectedInterestPart;
574 Account const issuer{
"issuer"};
580 .name =
"Zero interest",
583 .expectedInterestPart =
Number{0},
584 .expectedFeePart =
Number{0},
587 .name =
"Zero fee rate",
588 .interest =
Number{1'000},
590 .expectedInterestPart =
Number{1'000},
591 .expectedFeePart =
Number{0},
594 .name =
"10% fee rate",
595 .interest =
Number{1'000},
597 .expectedInterestPart =
Number{900},
598 .expectedFeePart =
Number{100},
602 for (
auto const& tc : testCases)
604 testcase(
"computeInterestAndFeeParts: " + tc.name);
606 auto const [computedInterestPart, computedFeePart] =
609 computedInterestPart == tc.expectedInterestPart,
610 "Interest part mismatch: expected " +
to_string(tc.expectedInterestPart) +
611 ", got " +
to_string(computedInterestPart));
613 computedFeePart == tc.expectedFeePart,
614 "Fee part mismatch: expected " +
to_string(tc.expectedFeePart) +
", got " +
627 Number principalOutstanding;
631 Number expectedLateInterest;
636 .name =
"On-time payment",
637 .principalOutstanding =
Number{1'000},
640 .nextPaymentDueDate = 3'000,
641 .expectedLateInterest =
Number{0},
644 .name =
"Early payment",
645 .principalOutstanding =
Number{1'000},
648 .nextPaymentDueDate = 4'000,
649 .expectedLateInterest =
Number{0},
652 .name =
"No principal outstanding",
653 .principalOutstanding =
Number{0},
656 .nextPaymentDueDate = 2'000,
657 .expectedLateInterest =
Number{0},
660 .name =
"No late interest rate",
661 .principalOutstanding =
Number{1'000},
664 .nextPaymentDueDate = 2'000,
665 .expectedLateInterest =
Number{0},
668 .name =
"Late payment",
669 .principalOutstanding =
Number{1'000},
672 .nextPaymentDueDate = 2'000,
673 .expectedLateInterest =
Number{317097919837645865, -19},
677 for (
auto const& tc : testCases)
679 testcase(
"loanLatePaymentInterest: " + tc.name);
682 tc.principalOutstanding,
685 tc.nextPaymentDueDate);
687 computedLateInterest == tc.expectedLateInterest,
688 "Late interest mismatch: expected " +
to_string(tc.expectedLateInterest) +
689 ", got " +
to_string(computedLateInterest));
701 Number principalOutstanding;
707 Number expectedAccruedInterest;
712 .name =
"Zero principal outstanding",
713 .principalOutstanding =
Number{0},
714 .periodicRate =
Number{5, -2},
717 .prevPaymentDate = 2'500,
718 .paymentInterval = 30 * 24 * 60 * 60,
719 .expectedAccruedInterest =
Number{0},
722 .name =
"Before start date",
723 .principalOutstanding =
Number{1'000},
724 .periodicRate =
Number{5, -2},
727 .prevPaymentDate = 1'500,
728 .paymentInterval = 30 * 24 * 60 * 60,
729 .expectedAccruedInterest =
Number{0},
732 .name =
"Zero periodic rate",
733 .principalOutstanding =
Number{1'000},
734 .periodicRate =
Number{0},
737 .prevPaymentDate = 2'500,
738 .paymentInterval = 30 * 24 * 60 * 60,
739 .expectedAccruedInterest =
Number{0},
742 .name =
"Zero payment interval",
743 .principalOutstanding =
Number{1'000},
744 .periodicRate =
Number{5, -2},
747 .prevPaymentDate = 2'500,
748 .paymentInterval = 0,
749 .expectedAccruedInterest =
Number{0},
752 .name =
"Standard case",
753 .principalOutstanding =
Number{1'000},
754 .periodicRate =
Number{5, -2},
757 .prevPaymentDate = 2'000,
758 .paymentInterval = 30 * 24 * 60 * 60,
759 .expectedAccruedInterest =
Number{1929012345679012346, -20},
763 for (
auto const& tc : testCases)
765 testcase(
"loanAccruedInterest: " + tc.name);
768 tc.principalOutstanding,
775 computedAccruedInterest == tc.expectedAccruedInterest,
776 "Accrued interest mismatch: expected " +
to_string(tc.expectedAccruedInterest) +
777 ", got " +
to_string(computedAccruedInterest));
792 Number rawPrincipalOutstanding;
799 Number expectedFullPaymentInterest;
804 .name =
"Zero principal outstanding",
805 .rawPrincipalOutstanding =
Number{0},
806 .periodicRate =
Number{5, -2},
808 .paymentInterval = 30 * 24 * 60 * 60,
809 .prevPaymentDate = 2'000,
812 .expectedFullPaymentInterest =
Number{0},
815 .name =
"Zero close interest rate",
816 .rawPrincipalOutstanding =
Number{1'000},
817 .periodicRate =
Number{5, -2},
819 .paymentInterval = 30 * 24 * 60 * 60,
820 .prevPaymentDate = 2'000,
823 .expectedFullPaymentInterest =
Number{1929012345679012346, -20},
826 .name =
"Standard case",
827 .rawPrincipalOutstanding =
Number{1'000},
828 .periodicRate =
Number{5, -2},
830 .paymentInterval = 30 * 24 * 60 * 60,
831 .prevPaymentDate = 2'000,
834 .expectedFullPaymentInterest =
Number{1000192901234567901, -16},
838 for (
auto const& tc : testCases)
840 testcase(
"computeFullPaymentInterest: " + tc.name);
843 tc.rawPrincipalOutstanding,
849 tc.closeInterestRate);
851 computedFullPaymentInterest == tc.expectedFullPaymentInterest,
852 "Full payment interest mismatch: expected " +
853 to_string(tc.expectedFullPaymentInterest) +
", got " +
862 testcase(
"tryOverpayment - No Interest No Fee");
867 Env const env{*
this};
868 Account const issuer{
"issuer"};
873 Number const loanPrincipal{1'000};
876 auto const periodicRate =
loanPeriodicRate(loanInterestRate, paymentInterval);
877 Number const overpaymentAmount{50};
902 overpaymentComponents,
903 loanProperties.loanState,
904 loanProperties.periodicPayment,
912 auto const& [actualPaymentParts, newLoanProperties] = *ret;
913 auto const& newState = newLoanProperties.loanState;
917 actualPaymentParts.valueChange == 0,
918 " valueChange mismatch: expected 0, got " +
to_string(actualPaymentParts.valueChange));
921 actualPaymentParts.feePaid == 0,
922 " feePaid mismatch: expected 0, got " +
to_string(actualPaymentParts.feePaid));
925 actualPaymentParts.interestPaid == 0,
926 " interestPaid mismatch: expected 0, got " +
927 to_string(actualPaymentParts.interestPaid));
930 actualPaymentParts.principalPaid == overpaymentAmount,
931 " principalPaid mismatch: expected " +
to_string(overpaymentAmount) +
", got " +
932 to_string(actualPaymentParts.principalPaid));
936 loanProperties.loanState.interestDue - newState.interestDue == 0,
937 " interest change mismatch: expected 0, got " +
938 to_string(loanProperties.loanState.interestDue - newState.interestDue));
941 loanProperties.loanState.managementFeeDue - newState.managementFeeDue == 0,
942 " management fee change mismatch: expected 0, got " +
943 to_string(loanProperties.loanState.managementFeeDue - newState.managementFeeDue));
946 actualPaymentParts.principalPaid ==
947 loanProperties.loanState.principalOutstanding - newState.principalOutstanding,
948 " principalPaid mismatch: expected " +
950 loanProperties.loanState.principalOutstanding - newState.principalOutstanding) +
951 ", got " +
to_string(actualPaymentParts.principalPaid));
957 testcase(
"tryOverpayment - No Interest With Overpayment Fee");
962 Env const env{*
this};
963 Account const issuer{
"issuer"};
968 Number const loanPrincipal{1'000};
971 auto const periodicRate =
loanPeriodicRate(loanInterestRate, paymentInterval);
996 overpaymentComponents,
997 loanProperties.loanState,
998 loanProperties.periodicPayment,
1006 auto const& [actualPaymentParts, newLoanProperties] = *ret;
1007 auto const& newState = newLoanProperties.loanState;
1011 actualPaymentParts.valueChange == 0,
1012 " valueChange mismatch: expected 0, got " +
to_string(actualPaymentParts.valueChange));
1015 actualPaymentParts.feePaid == 5,
1016 " feePaid mismatch: expected 5, got " +
to_string(actualPaymentParts.feePaid));
1019 actualPaymentParts.principalPaid == 45,
1020 " principalPaid mismatch: expected 45, got `" +
1021 to_string(actualPaymentParts.principalPaid));
1024 actualPaymentParts.interestPaid == 0,
1025 " interestPaid mismatch: expected 0, got " +
1026 to_string(actualPaymentParts.interestPaid));
1031 loanProperties.loanState.interestDue - newState.interestDue == 0,
1032 " interest change mismatch: expected 0, got " +
1033 to_string(loanProperties.loanState.interestDue - newState.interestDue));
1037 loanProperties.loanState.managementFeeDue - newState.managementFeeDue == 0,
1038 " management fee change mismatch: expected 0, got " +
1039 to_string(loanProperties.loanState.managementFeeDue - newState.managementFeeDue));
1042 actualPaymentParts.principalPaid ==
1043 loanProperties.loanState.principalOutstanding - newState.principalOutstanding,
1044 " principalPaid mismatch: expected " +
1046 loanProperties.loanState.principalOutstanding - newState.principalOutstanding) +
1047 ", got " +
to_string(actualPaymentParts.principalPaid));
1053 testcase(
"tryOverpayment - Loan Interest, No Overpayment Fees");
1055 using namespace jtx;
1058 Env const env{*
this};
1059 Account const issuer{
"issuer"};
1064 Number const loanPrincipal{1'000};
1067 auto const periodicRate =
loanPeriodicRate(loanInterestRate, paymentInterval);
1092 overpaymentComponents,
1093 loanProperties.loanState,
1094 loanProperties.periodicPayment,
1102 auto const& [actualPaymentParts, newLoanProperties] = *ret;
1103 auto const& newState = newLoanProperties.loanState;
1109 (actualPaymentParts.valueChange ==
Number{-228802, -5}),
1110 " valueChange mismatch: expected " +
to_string(
Number{-228802, -5}) +
", got " +
1111 to_string(actualPaymentParts.valueChange));
1115 actualPaymentParts.feePaid == 0,
1116 " feePaid mismatch: expected 0, got " +
to_string(actualPaymentParts.feePaid));
1119 actualPaymentParts.principalPaid == 50,
1120 " principalPaid mismatch: expected 50, got `" +
1121 to_string(actualPaymentParts.principalPaid));
1125 actualPaymentParts.interestPaid == 0,
1126 " interestPaid mismatch: expected 0, got " +
1127 to_string(actualPaymentParts.interestPaid));
1131 actualPaymentParts.principalPaid ==
1132 loanProperties.loanState.principalOutstanding - newState.principalOutstanding,
1133 " principalPaid mismatch: expected " +
1135 loanProperties.loanState.principalOutstanding - newState.principalOutstanding) +
1136 ", got " +
to_string(actualPaymentParts.principalPaid));
1139 actualPaymentParts.valueChange ==
1140 newState.interestDue - loanProperties.loanState.interestDue,
1141 " valueChange mismatch: expected " +
1142 to_string(newState.interestDue - loanProperties.loanState.interestDue) +
", got " +
1143 to_string(actualPaymentParts.valueChange));
1147 loanProperties.loanState.managementFeeDue - newState.managementFeeDue == 0,
1148 " management fee change mismatch: expected 0, got " +
1149 to_string(loanProperties.loanState.managementFeeDue - newState.managementFeeDue));
1155 testcase(
"tryOverpayment - Loan Interest, Overpayment Interest, No Fee");
1157 using namespace jtx;
1160 Env const env{*
this};
1161 Account const issuer{
"issuer"};
1166 Number const loanPrincipal{1'000};
1169 auto const periodicRate =
loanPeriodicRate(loanInterestRate, paymentInterval);
1194 overpaymentComponents,
1195 loanProperties.loanState,
1196 loanProperties.periodicPayment,
1204 auto const& [actualPaymentParts, newLoanProperties] = *ret;
1205 auto const& newState = newLoanProperties.loanState;
1210 actualPaymentParts.interestPaid == 5,
1211 " interestPaid mismatch: expected 5, got " +
1212 to_string(actualPaymentParts.interestPaid));
1217 (actualPaymentParts.valueChange ==
1218 Number{-205922, -5} + actualPaymentParts.interestPaid),
1219 " valueChange mismatch: expected " +
1220 to_string(actualPaymentParts.valueChange - actualPaymentParts.interestPaid) +
1221 ", got " +
to_string(actualPaymentParts.valueChange));
1225 actualPaymentParts.feePaid == 0,
1226 " feePaid mismatch: expected 0, got " +
to_string(actualPaymentParts.feePaid));
1229 actualPaymentParts.principalPaid == 45,
1230 " principalPaid mismatch: expected 45, got `" +
1231 to_string(actualPaymentParts.principalPaid));
1235 actualPaymentParts.principalPaid ==
1236 loanProperties.loanState.principalOutstanding - newState.principalOutstanding,
1237 " principalPaid mismatch: expected " +
1239 loanProperties.loanState.principalOutstanding - newState.principalOutstanding) +
1240 ", got " +
to_string(actualPaymentParts.principalPaid));
1245 actualPaymentParts.valueChange - actualPaymentParts.interestPaid ==
1246 newState.interestDue - loanProperties.loanState.interestDue,
1247 " valueChange mismatch: expected " +
1249 newState.interestDue - loanProperties.loanState.interestDue +
1250 actualPaymentParts.interestPaid) +
1251 ", got " +
to_string(actualPaymentParts.valueChange));
1255 loanProperties.loanState.managementFeeDue - newState.managementFeeDue == 0,
1256 " management fee change mismatch: expected 0, got " +
1257 to_string(loanProperties.loanState.managementFeeDue - newState.managementFeeDue));
1264 "tryOverpayment - Loan Interest and Fee, Overpayment Interest, No "
1267 using namespace jtx;
1270 Env const env{*
this};
1271 Account const issuer{
"issuer"};
1276 Number const loanPrincipal{1'000};
1279 auto const periodicRate =
loanPeriodicRate(loanInterestRate, paymentInterval);
1304 overpaymentComponents,
1305 loanProperties.loanState,
1306 loanProperties.periodicPayment,
1314 auto const& [actualPaymentParts, newLoanProperties] = *ret;
1315 auto const& newState = newLoanProperties.loanState;
1322 (actualPaymentParts.interestPaid ==
Number{45, -1}),
1323 " interestPaid mismatch: expected 4.5, got " +
1324 to_string(actualPaymentParts.interestPaid));
1329 (actualPaymentParts.valueChange ==
1330 Number{-18533, -4} + actualPaymentParts.interestPaid),
1331 " valueChange mismatch: expected " +
1332 to_string(
Number{-18533, -4} + actualPaymentParts.interestPaid) +
", got " +
1333 to_string(actualPaymentParts.valueChange));
1338 (actualPaymentParts.feePaid ==
Number{5, -1}),
1339 " feePaid mismatch: expected 0.5, got " +
to_string(actualPaymentParts.feePaid));
1342 actualPaymentParts.principalPaid == 45,
1343 " principalPaid mismatch: expected 45, got `" +
1344 to_string(actualPaymentParts.principalPaid));
1348 actualPaymentParts.principalPaid ==
1349 loanProperties.loanState.principalOutstanding - newState.principalOutstanding,
1350 " principalPaid mismatch: expected " +
1352 loanProperties.loanState.principalOutstanding - newState.principalOutstanding) +
1353 ", got " +
to_string(actualPaymentParts.principalPaid));
1358 (newState.managementFeeDue - loanProperties.loanState.managementFeeDue ==
1360 " management fee change mismatch: expected " +
to_string(
Number{-20592, -5}) +
1362 to_string(newState.managementFeeDue - loanProperties.loanState.managementFeeDue));
1365 actualPaymentParts.valueChange - actualPaymentParts.interestPaid ==
1366 newState.interestDue - loanProperties.loanState.interestDue,
1367 " valueChange mismatch: expected " +
1368 to_string(newState.interestDue - loanProperties.loanState.interestDue) +
", got " +
1369 to_string(actualPaymentParts.valueChange - actualPaymentParts.interestPaid));
1375 testcase(
"tryOverpayment - Loan Interest, Fee, Overpayment Interest, Fee");
1377 using namespace jtx;
1380 Account const issuer{
"issuer"};
1385 Number const loanPrincipal{1'000};
1388 auto const periodicRate =
loanPeriodicRate(loanInterestRate, paymentInterval);
1390 Env const env{*
this};
1413 Env const env{*
this, features};
1427 overpaymentComponents,
1428 loanProperties.loanState,
1429 loanProperties.periodicPayment,
1434 if (!BEAST_EXPECT(ret))
1435 return std::nullopt;
1437 .parts = ret->first,
1438 .oldState = loanProperties.loanState,
1439 .newState = ret->second.loanState,
1445 if (!fixedOpt || !legacyOpt)
1447 BEAST_EXPECT(fixedOpt.has_value());
1448 BEAST_EXPECT(legacyOpt.has_value());
1451 Outcome
const&
fixed = *fixedOpt;
1452 Outcome
const& legacy = *legacyOpt;
1457 auto const checkCommon = [&](Outcome
const& o,
char const* tag) {
1459 (o.parts.interestPaid ==
Number{45, -1}),
1462 (o.parts.feePaid ==
Number{55, -1}),
1465 o.parts.principalPaid == 40,
1468 o.parts.principalPaid ==
1469 o.oldState.principalOutstanding - o.newState.principalOutstanding);
1473 o.parts.valueChange - o.parts.interestPaid ==
1474 o.newState.interestDue - o.oldState.interestDue);
1476 checkCommon(
fixed,
"fixed");
1477 checkCommon(legacy,
"legacy");
1484 BEAST_EXPECT((
fixed.parts.valueChange ==
Number{-164738, -5} +
fixed.parts.interestPaid));
1486 (
fixed.newState.managementFeeDue -
fixed.oldState.managementFeeDue ==
1488 BEAST_EXPECT((legacy.parts.valueChange ==
Number{-164737, -5} + legacy.parts.interestPaid));
1490 (legacy.newState.managementFeeDue - legacy.oldState.managementFeeDue ==
1502 Number principalRequested;
1508 .name =
"Zero interest",
1509 .principalRequested =
Number{1'000},
1510 .interestDue =
Number{0},
1513 .name =
"Nonzero interest",
1514 .principalRequested =
Number{1'000},
1515 .interestDue =
Number{75},
1519 for (
auto const& tc : testCases)
1521 testcase(
"instant_recognition::loanOriginationDeltas: " + tc.name);
1525 deltas.assetsTotalDelta == tc.interestDue,
1526 "assetsTotalDelta mismatch: expected " +
to_string(tc.interestDue) +
", got " +
1529 deltas.debtTotalDelta == tc.principalRequested + tc.interestDue,
1530 "debtTotalDelta mismatch: expected " +
1531 to_string(tc.principalRequested + tc.interestDue) +
", got " +
1541 testcase(
"cash_basis::loanOriginationDeltas: interestDue is ignored");
1543 Number const principalRequested{1'000};
1544 Number const interestDue{75};
1548 deltas.assetsTotalDelta == 0,
1549 "assetsTotalDelta mismatch: expected 0, got " +
to_string(deltas.assetsTotalDelta));
1551 deltas.debtTotalDelta == principalRequested,
1552 "debtTotalDelta mismatch: expected " +
to_string(principalRequested) +
", got " +
1572 .name =
"No maximum configured",
1573 .vaultMaximum =
Number{0},
1574 .vaultTotal =
Number{900},
1575 .interestDue =
Number{1'000},
1579 .name =
"Interest fits under headroom",
1580 .vaultMaximum =
Number{1'000},
1581 .vaultTotal =
Number{900},
1582 .interestDue =
Number{50},
1586 .name =
"Interest exactly fills headroom",
1587 .vaultMaximum =
Number{1'000},
1588 .vaultTotal =
Number{900},
1589 .interestDue =
Number{100},
1593 .name =
"Interest exceeds headroom",
1594 .vaultMaximum =
Number{1'000},
1595 .vaultTotal =
Number{900},
1596 .interestDue =
Number{101},
1601 for (
auto const& tc : testCases)
1603 testcase(
"instant_recognition::loanOriginationExceedsVaultMaximum: " + tc.name);
1606 tc.vaultMaximum, tc.vaultTotal, tc.interestDue) == tc.expected);
1615 Number const& totalValueOutstanding,
1616 Number const& principalOutstanding,
1617 Number const& managementFeeOutstanding)
1620 sle->at(sfTotalValueOutstanding) = totalValueOutstanding;
1621 sle->at(sfPrincipalOutstanding) = principalOutstanding;
1622 sle->at(sfManagementFeeOutstanding) = managementFeeOutstanding;
1636 sle->at(sfLEVersion) = std::to_underlying(*leVersion);
1638 sle->at(sfAssetsMaximum) = *assetsMaximum;
1640 sle->at(sfAssetsTotal) = *assetsTotal;
1647 testcase(
"instant_recognition::loanVaultExposure");
1656 testcase(
"cash_basis::loanVaultExposure");
1669 .principalPaid =
Number{100},
1670 .interestPaid =
Number{20},
1671 .valueChange =
Number{5},
1676 testcase(
"instant_recognition::loanPaymentDeltas: nonzero valueChange");
1678 BEAST_EXPECT(deltas.assetsTotalDelta == parts.
valueChange);
1680 deltas.debtTotalDelta ==
1685 testcase(
"cash_basis::loanPaymentDeltas: nonzero valueChange ignored");
1687 BEAST_EXPECT(deltas.assetsTotalDelta == parts.
interestPaid);
1695 using namespace jtx;
1697 Number const principalRequested{1'000};
1698 Number const interestDue{75};
1704 "loanOriginationDeltas dispatcher: amendment enabled, legacy vault picks "
1705 "InstantRecognition");
1706 Env const env{*
this};
1708 auto const expected =
1710 BEAST_EXPECT(deltas.assetsTotalDelta == expected.assetsTotalDelta);
1711 BEAST_EXPECT(deltas.debtTotalDelta == expected.debtTotalDelta);
1716 "loanOriginationDeltas dispatcher: CashBasis and FixedPrecision "
1717 "Vaults pick cash-basis accounting");
1718 Env const env{*
this};
1724 BEAST_EXPECT(deltas.assetsTotalDelta == expected.assetsTotalDelta);
1725 BEAST_EXPECT(deltas.debtTotalDelta == expected.debtTotalDelta);
1733 using namespace jtx;
1735 Number const vaultMaximum{1'000};
1736 Number const vaultTotal{900};
1738 Number const interestDue{101};
1740 auto const legacyVault =
makeVaultSle(std::nullopt, vaultMaximum, vaultTotal);
1744 "loanOriginationExceedsVaultMaximum dispatcher: amendment enabled, legacy vault "
1745 "picks InstantRecognition");
1746 Env const env{*
this};
1750 vaultMaximum, vaultTotal, interestDue));
1755 "loanOriginationExceedsVaultMaximum dispatcher: CashBasis and "
1756 "FixedPrecision Vaults pick cash-basis accounting");
1757 Env const env{*
this};
1762 makeVaultSle(version, vaultMaximum, vaultTotal), vaultTotal, interestDue) ==
1771 using namespace jtx;
1777 "loanVaultExposure dispatcher: amendment enabled, legacy vault picks "
1778 "InstantRecognition");
1779 Env const env{*
this};
1788 "loanVaultExposure dispatcher: CashBasis and FixedPrecision "
1789 "Vaults pick cash-basis accounting");
1790 Env const env{*
this};
1804 using namespace jtx;
1807 .principalPaid =
Number{100},
1808 .interestPaid =
Number{20},
1809 .valueChange =
Number{5},
1817 "loanPaymentDeltas dispatcher: amendment enabled, legacy vault picks "
1818 "InstantRecognition");
1819 Env const env{*
this};
1822 BEAST_EXPECT(deltas.assetsTotalDelta == expected.assetsTotalDelta);
1823 BEAST_EXPECT(deltas.debtTotalDelta == expected.debtTotalDelta);
1828 "loanPaymentDeltas dispatcher: CashBasis and FixedPrecision "
1829 "Vaults pick cash-basis accounting");
1830 Env const env{*
this};
1835 BEAST_EXPECT(deltas.assetsTotalDelta == expected.assetsTotalDelta);
1836 BEAST_EXPECT(deltas.debtTotalDelta == expected.debtTotalDelta);
1845 using namespace jtx;
1847 Account const issuer{
"issuer"};
1864 .name =
"Zero amount",
1865 .coverAvailable =
Number{10},
1870 .name =
"Rounds to zero at cover scale",
1871 .coverAvailable =
Number{10},
1876 .name =
"Zero coverAvailable, whole-unit amount",
1879 .coverAvailable =
Number{0},
1884 .name =
"Supra-ULP amount",
1885 .coverAvailable =
Number{10},
1895 .name =
"Coarsened live scale rejects re-fining amount",
1896 .coverAvailable =
Number{1, 10},
1902 Env const env{*
this};
1904 for (
auto const& tc : testCases)
1906 testcase(
"canApplyToBrokerCover: " + tc.name);
1908 sle->at(sfCoverAvailable) = tc.coverAvailable;
1916 testcase(
"canApplyToBrokerCover: amendment disabled");
1919 sle->at(sfCoverAvailable) =
Number{10};
1930 testcase(
"minimumBrokerCover: FixedPrecision uses base scale");
1933 vault->setFieldIssue(sfAsset,
STIssue{sfAsset, iou});
1934 vault->at(sfAssetsTotal) =
Number{1};
1935 vault->at(sfScale) = 6;
1936 vault->at(sfLEVersion) = std::to_underlying(version);
1941 Number
const debtTotal{15, -2};
1959 using namespace jtx;
1960 using namespace loan;
1962 testcase(
"getLoanDefaultFreezeExemptAccounts");
1964 Account const lender{
"lender"};
1965 Account const borrower{
"borrower"};
1968 Vault const vault{env};
1969 env.
fund(
XRP(10'000), lender, borrower);
1976 auto [vaultTx, vaultKeylet, subscriptionDate] =
1977 vault.createClosedEnded({.owner = lender, .asset =
xrpIssue()});
1980 env(vault.deposit({.depositor = lender, .id = vaultKeylet.key, .amount = XRP(1'000)}));
1983 vault.closePastSubscription(subscriptionDate);
1985 auto const brokerKeylet =
1990 env(
set(borrower, brokerKeylet.key,
Number{200'000}),
1991 Sig(sfCounterpartySignature, lender),
2005 auto const jt = env.
jt(manage(lender, loanKeylet.key, tfLoanImpair));
2012 auto const jt = env.
jt(manage(lender, loanKeylet.key, tfLoanDefault));
2021 auto const jt = env.
jt(manage(lender, brokerKeylet.key, tfLoanDefault));
2028 auto const jt = env.
jt(manage(lender, loanKeylet.key, tfLoanDefault));
2030 auto const brokerSle = env.
le(brokerKeylet);
2031 auto const vaultSle = env.
le(vaultKeylet);
2032 BEAST_EXPECT(result);
2033 BEAST_EXPECT(brokerSle);
2034 BEAST_EXPECT(vaultSle);
2035 if (result && brokerSle && vaultSle)
2037 BEAST_EXPECT(result->issuer == vaultSle->at(sfAsset).getIssuer());
2038 BEAST_EXPECT(result->broker == brokerSle->at(sfAccount));
2039 BEAST_EXPECT(result->vault == vaultSle->at(sfAccount));
2040 BEAST_EXPECT(result->asset == vaultSle->at(sfAsset));
TestcaseT testcase
Memberspace for declaring test cases.
std::chrono::time_point< NetClock > time_point
std::chrono::duration< rep, period > duration
Number is a floating point type that can represent a wide range of values.
static constexpr SeqProxy rawSequence(std::uint32_t v)
Factory function to return a sequence-based SeqProxy.
void testComputePaymentFactor()
void testLoanOriginationExceedsVaultMaximumDispatcher()
void testInstantRecognitionLoanOriginationDeltas()
void testComputeTheoreticalLoanStateNearZeroRate()
void testInstantRecognitionLoanVaultExposure()
void testLoanPrincipalFromPeriodicPayment()
void testTryOverpaymentLoanInterestNoOverpaymentFees()
void testLoanPaymentDeltas()
void testLoanVaultExposureDispatcher()
void testComputePowerMinusOne()
void testCashBasisLoanVaultExposure()
void testComputeInterestAndFeeParts()
void testTryOverpaymentNoInterestOverpaymentFee()
void testLoanDefaultFreezeExemptAccounts()
void testTryOverpaymentNoInterestNoFee()
void testInstantRecognitionLoanOriginationExceedsVaultMaximum()
void testTryOverpaymentLoanInterestFeeOverpaymentInterestNoFee()
void testTryOverpaymentLoanInterestFeeOverpaymentInterestFee()
void testComputeFullPaymentInterest()
void testLoanPaymentDeltasDispatcher()
void testCashBasisLoanOriginationDeltas()
void testLoanPeriodicPayment()
void testCanApplyToBrokerCover()
void testComputeOverpaymentComponents()
void testLoanPrincipalFromPeriodicPaymentNearZeroRate()
void testTryOverpaymentLoanInterestOverpaymentInterest()
static std::shared_ptr< SLE > makeVaultSle(std::optional< VaultVersion > leVersion=std::nullopt, std::optional< Number > assetsMaximum=std::nullopt, std::optional< Number > assetsTotal=std::nullopt)
void testComputePaymentFactorNearZeroRate()
static std::shared_ptr< SLE > makeLoanSle(Number const &totalValueOutstanding, Number const &principalOutstanding, Number const &managementFeeOutstanding)
void run() override
Runs the suite.
void testComputePowerMinusOneHybrid()
void testLoanOriginationDeltasDispatcher()
void testLoanAccruedInterest()
void testLoanLatePaymentInterest()
Immutable cryptographic account descriptor.
AccountID id() const
Returns the Account ID.
A transaction testing environment.
bool close(NetClock::time_point closeTime, std::optional< std::chrono::milliseconds > consensusDelay=std::nullopt)
Close and advance the ledger.
SLE::const_pointer le(Account const &account) const
Return an account root.
void fund(bool setDefaultRipple, STAmount const &amount, Account const &account)
std::uint32_t seq(Account const &account) const
Returns the next sequence number on account.
JTx jt(JsonValue &&jv, FN const &... fN)
Create a JTx from parameters.
void disableFeature(UInt256 const feature)
void enableFeature(UInt256 const feature)
beast::Journal const journal
std::shared_ptr< OpenView const > current() const
Returns the current ledger.
Set the regular signature on a JTx.
AccountingDeltas loanPaymentDeltas(LoanPaymentParts const &parts)
AccountingDeltas loanOriginationDeltas(Number const &principalRequested)
Number loanVaultExposure(SLE::ConstRef loanSle)
Number computePaymentFactor(Rules const &rules, Number const &periodicRate, std::uint32_t paymentsRemaining)
Number loanPrincipalFromPeriodicPayment(Rules const &rules, Number const &periodicPayment, Number const &periodicRate, std::uint32_t paymentsRemaining)
Number computePowerMinusOneHybrid(Number const &periodicRate, std::uint32_t paymentsRemaining)
Number loanPeriodicPayment(Rules const &rules, Number const &principalOutstanding, Number const &periodicRate, std::uint32_t paymentsRemaining)
Number loanAccruedInterest(Number const &principalOutstanding, Number const &periodicRate, NetClock::time_point parentCloseTime, std::uint32_t startDate, std::uint32_t prevPaymentDate, std::uint32_t paymentInterval)
std::pair< Number, Number > computeInterestAndFeeParts(Asset const &asset, Number const &interest, TenthBips16 managementFeeRate, std::int32_t loanScale)
Number loanLatePaymentInterest(Number const &principalOutstanding, TenthBips32 lateInterestRate, NetClock::time_point parentCloseTime, std::uint32_t nextPaymentDueDate)
std::expected< std::pair< LoanPaymentParts, LoanProperties >, TER > tryOverpayment(Rules const &rules, Asset const &asset, std::int32_t loanScale, ExtendedPaymentComponents const &overpaymentComponents, LoanState const &roundedLoanState, Number const &periodicPayment, Number const &periodicRate, std::uint32_t paymentRemaining, TenthBips16 const managementFeeRate, beast::Journal j)
ExtendedPaymentComponents computeOverpaymentComponents(Rules const &rules, Asset const &asset, int32_t const loanScale, Number const &overpayment, TenthBips32 const overpaymentInterestRate, TenthBips32 const overpaymentFeeRate, TenthBips16 const managementFeeRate)
Number computePowerMinusOne(Number const &periodicRate, std::uint32_t paymentsRemaining)
AccountingDeltas loanPaymentDeltas(LoanPaymentParts const &parts)
Number loanVaultExposure(SLE::ConstRef loanSle)
AccountingDeltas loanOriginationDeltas(Number const &principalRequested, Number const &interestDue)
bool loanOriginationExceedsVaultMaximum(Number const &vaultMaximum, Number const &vaultTotal, Number const &interestDue)
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
json::Value set(AccountID const &account, UInt256 const &vaultId, uint32_t flags)
json::Value pay(AccountID const &account, AccountID const &to, AnyAmount amount)
Create a payment.
XrpT const XRP
Converts to XRP Issue or STAmount.
FeatureBitset testableAmendments()
BEAST_DEFINE_TESTSUITE(AMMClawback, app, xrpl)
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
bool set(T &target, std::string const &name, Section const §ion)
Set a value from a configuration Section If the named value is not found or doesn't parse as a T,...
Issue const & xrpIssue()
Returns an asset specifier that represents XRP.
Number loanPeriodicRate(TenthBips32 interestRate, std::uint32_t paymentInterval)
bool loanOriginationExceedsVaultMaximum(SLE::ConstRef vaultSle, Number const &vaultTotal, Number const &interestDue)
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)
Number power(Number const &f, unsigned n)
TenthBips< std::uint32_t > TenthBips32
static FunctionType fixed(Keylet const &keylet)
TenthBips< std::uint16_t > TenthBips16
std::string to_string(BaseUInt< Bits, Tag > const &a)
Number minimumBrokerCover(Number const &debtTotal, TenthBips32 coverRateMinimum, SLE::ConstRef vaultSle)
Minimum required broker cover, rounded up.
VaultVersion
Vault ledger-entry schema versions, persisted as sfLEVersion.
std::optional< LoanDefaultFreezeExemptAccounts > getLoanDefaultFreezeExemptAccounts(ReadView const &view, STTx const &tx)
Resolves the accounts and asset a LoanManage default transaction is exempt from freeze/lock for.
LoanState computeTheoreticalLoanState(Rules const &rules, Number const &periodicPayment, Number const &periodicRate, std::uint32_t const paymentRemaining, TenthBips32 const managementFeeRate)
AccountingDeltas loanPaymentDeltas(SLE::ConstRef vaultSle, LoanPaymentParts const &parts)
constexpr Number abs(Number x) noexcept
TERSubset< CanCvtToTER > TER
Number loanVaultExposure(SLE::ConstRef vaultSle, SLE::ConstRef loanSle)
void associateAsset(STLedgerEntry &sle, Asset const &asset)
Associate an Asset with all sMD_NeedsAsset fields in a ledger entry.
LoanProperties computeLoanProperties(Rules const &rules, Asset const &asset, Number const &principalOutstanding, TenthBips32 interestRate, std::uint32_t paymentInterval, std::uint32_t paymentsRemaining, TenthBips32 managementFeeRate, std::int32_t minimumScale)
AccountingDeltas loanOriginationDeltas(SLE::ConstRef vaultSle, Number const &principalRequested, Number const &interestDue)
TER canApplyToBrokerCover(ReadView const &view, SLE::ConstRef sleBroker, Asset const &vaultAsset, STAmount const &amount, beast::Journal j, std::string_view logPrefix)
Broker cover preclaim precision guard (fixCleanup3_2_0).
Number computeFullPaymentInterest(Number const &theoreticalPrincipalOutstanding, Number const &periodicRate, NetClock::time_point parentCloseTime, std::uint32_t paymentInterval, std::uint32_t prevPaymentDate, std::uint32_t startDate, TenthBips32 closeInterestRate)
This structure captures the parts of a loan state.