Merge branch 'ximinez/lending-XLS-66-ongoing' into ximinez/lending-vault-payments

Author: ximinez

src/test/app/LendingHelpers_test.cpp

@@ -141,7 +141,7 @@ class Loan_test : public beast::unit_test::suite
             using namespace jtx;
 
             auto const vaultSle = env.le(keylet::vault(vaultID));
-            return getVaultScale(vaultSle);
+            return getAssetsTotalScale(vaultSle);
         }
     };
 
@@ -551,12 +551,15 @@ class Loan_test : public beast::unit_test::suite
                        broker.vaultScale(env),
                        state.principalOutstanding.exponent())));
         BEAST_EXPECT(state.paymentInterval == 600);
-        BEAST_EXPECT(
-            state.totalValue ==
-            roundToAsset(
-                broker.asset,
-                state.periodicPayment * state.paymentRemaining,
-                state.loanScale));
+        {
+            NumberRoundModeGuard mg(Number::upward);
+            BEAST_EXPECT(
+                state.totalValue ==
+                roundToAsset(
+                    broker.asset,
+                    state.periodicPayment * state.paymentRemaining,
+                    state.loanScale));
+        }
         BEAST_EXPECT(
             state.managementFeeOutstanding ==
             computeManagementFee(
@@ -697,7 +700,8 @@ class Loan_test : public beast::unit_test::suite
             interval,
             total,
             feeRate,
-            asset(brokerParams.vaultDeposit).number().exponent());
+            asset(brokerParams.vaultDeposit).number().exponent(),
+            env.journal);
         log << "Loan properties:\n"
             << "\tPrincipal: " << principal << std::endl
             << "\tInterest rate: " << interest << std::endl
@@ -1478,7 +1482,8 @@ class Loan_test : public beast::unit_test::suite
             state.paymentInterval,
             state.paymentRemaining,
             broker.params.managementFeeRate,
-            state.loanScale);
+            state.loanScale,
+            env.journal);
 
         verifyLoanStatus(
             0,
@@ -2449,13 +2454,18 @@ class Loan_test : public beast::unit_test::suite
                 // Make all the payments in one transaction
                 // service fee is 2
                 auto const startingPayments = state.paymentRemaining;
-                auto const rawPayoff = startingPayments *
-                    (state.periodicPayment + broker.asset(2).value());
-                STAmount const payoffAmount{broker.asset, rawPayoff};
-                BEAST_EXPECT(
-                    payoffAmount ==
-                    broker.asset(Number(1024014840139457, -12)));
-                BEAST_EXPECT(payoffAmount > state.principalOutstanding);
+                STAmount const payoffAmount = [&]() {
+                    NumberRoundModeGuard mg(Number::upward);
+                    auto const rawPayoff = startingPayments *
+                        (state.periodicPayment + broker.asset(2).value());
+                    STAmount const payoffAmount{broker.asset, rawPayoff};
+                    BEAST_EXPECTS(
+                        payoffAmount ==
+                            broker.asset(Number(1024014840139457, -12)),
+                        to_string(payoffAmount));
+                    BEAST_EXPECT(payoffAmount > state.principalOutstanding);
+                    return payoffAmount;
+                }();
 
                 singlePayment(
                     loanKeylet,
@@ -4010,7 +4020,7 @@ class Loan_test : public beast::unit_test::suite
         createJson = env.json(createJson, sig(sfCounterpartySignature, lender));
         // Fails in preclaim because principal requested can't be
         // represented as XRP
-        env(createJson, ter(tecPRECISION_LOSS));
+        env(createJson, ter(tecPRECISION_LOSS), THISLINE);
         env.close();
 
         BEAST_EXPECT(!env.le(keylet));
@@ -4022,7 +4032,7 @@ class Loan_test : public beast::unit_test::suite
         createJson = env.json(createJson, sig(sfCounterpartySignature, lender));
         // Fails in doApply because the payment is too small to be
         // represented as XRP.
-        env(createJson, ter(tecPRECISION_LOSS));
+        env(createJson, ter(tecPRECISION_LOSS), THISLINE);
         env.close();
     }
 
@@ -4997,7 +5007,7 @@ class Loan_test : public beast::unit_test::suite
         auto const keylet = keylet::loan(broker.brokerID, loanSequence);
 
         createJson = env.json(createJson, sig(sfCounterpartySignature, lender));
-        env(createJson, ter(tecPRECISION_LOSS));
+        env(createJson, ter(tecPRECISION_LOSS), THISLINE);
         env.close(startDate);
 
         auto loanPayTx = env.json(
@@ -6145,15 +6155,16 @@ class Loan_test : public beast::unit_test::suite
         // Accrued + prepayment-penalty interest based on current periodic
         // schedule
         auto const fullPaymentInterest = computeFullPaymentInterest(
-            after.periodicPayment,
+            detail::loanPrincipalFromPeriodicPayment(
+                after.periodicPayment, periodicRate2, after.paymentRemaining),
             periodicRate2,
-            after.paymentRemaining,
             env.current()->parentCloseTime(),
             after.paymentInterval,
             after.previousPaymentDate,
             static_cast<std::uint32_t>(
                 after.startDate.time_since_epoch().count()),
             closeInterestRate);
+
         // Round to asset scale and split interest/fee parts
         auto const roundedInterest =
             roundToAsset(asset.raw(), fullPaymentInterest, after.loanScale);
@@ -6181,9 +6192,9 @@ class Loan_test : public beast::unit_test::suite
         // window by clamping prevPaymentDate to 'now' for the full-pay path.
         auto const prevClamped = std::min(after.previousPaymentDate, nowSecs);
         auto const fullPaymentInterestClamped = computeFullPaymentInterest(
-            after.periodicPayment,
+            detail::loanPrincipalFromPeriodicPayment(
+                after.periodicPayment, periodicRate2, after.paymentRemaining),
             periodicRate2,
-            after.paymentRemaining,
             env.current()->parentCloseTime(),
             after.paymentInterval,
             prevClamped,

src/test/app/Loan_test.cpp

@@ -179,11 +179,12 @@ adjustImpreciseNumber(
 }
 
 inline int
-getVaultScale(SLE::const_ref vaultSle)
+getAssetsTotalScale(SLE::const_ref vaultSle)
 {
     if (!vaultSle)
         return Number::minExponent - 1;  // LCOV_EXCL_LINE
-    return vaultSle->at(sfAssetsTotal).exponent();
+    return STAmount{vaultSle->at(sfAsset), vaultSle->at(sfAssetsTotal)}
+        .exponent();
 }
 
 TER
@@ -202,14 +203,6 @@ computeRawLoanState(
     std::uint32_t const paymentRemaining,
     TenthBips32 const managementFeeRate);
 
-LoanState
-computeRawLoanState(
-    Number const& periodicPayment,
-    TenthBips32 interestRate,
-    std::uint32_t paymentInterval,
-    std::uint32_t const paymentRemaining,
-    TenthBips32 const managementFeeRate);
-
 // Constructs a valid LoanState object from arbitrary inputs
 LoanState
 constructLoanState(
@@ -239,17 +232,6 @@ computeFullPaymentInterest(
     std::uint32_t startDate,
     TenthBips32 closeInterestRate);
 
-Number
-computeFullPaymentInterest(
-    Number const& periodicPayment,
-    Number const& periodicRate,
-    std::uint32_t paymentRemaining,
-    NetClock::time_point parentCloseTime,
-    std::uint32_t paymentInterval,
-    std::uint32_t prevPaymentDate,
-    std::uint32_t startDate,
-    TenthBips32 closeInterestRate);
-
 namespace detail {
 // These classes and functions should only be accessed by LendingHelper
 // functions and unit tests
@@ -387,6 +369,58 @@ struct LoanStateDeltas
     nonNegative();
 };
 
+Number
+computeRaisedRate(Number const& periodicRate, std::uint32_t paymentsRemaining);
+
+Number
+computePaymentFactor(
+    Number const& periodicRate,
+    std::uint32_t paymentsRemaining);
+
+std::pair<Number, Number>
+computeInterestAndFeeParts(
+    Asset const& asset,
+    Number const& interest,
+    TenthBips16 managementFeeRate,
+    std::int32_t loanScale);
+
+Number
+loanPeriodicPayment(
+    Number const& principalOutstanding,
+    Number const& periodicRate,
+    std::uint32_t paymentsRemaining);
+
+Number
+loanPrincipalFromPeriodicPayment(
+    Number const& periodicPayment,
+    Number const& periodicRate,
+    std::uint32_t paymentsRemaining);
+
+Number
+loanLatePaymentInterest(
+    Number const& principalOutstanding,
+    TenthBips32 lateInterestRate,
+    NetClock::time_point parentCloseTime,
+    std::uint32_t nextPaymentDueDate);
+
+Number
+loanAccruedInterest(
+    Number const& principalOutstanding,
+    Number const& periodicRate,
+    NetClock::time_point parentCloseTime,
+    std::uint32_t startDate,
+    std::uint32_t prevPaymentDate,
+    std::uint32_t paymentInterval);
+
+ExtendedPaymentComponents
+computeOverpaymentComponents(
+    Asset const& asset,
+    int32_t const loanScale,
+    Number const& overpayment,
+    TenthBips32 const overpaymentInterestRate,
+    TenthBips32 const overpaymentFeeRate,
+    TenthBips16 const managementFeeRate);
+
 PaymentComponents
 computePaymentComponents(
     Asset const& asset,
@@ -418,7 +452,8 @@ computeLoanProperties(
     std::uint32_t paymentInterval,
     std::uint32_t paymentsRemaining,
     TenthBips32 managementFeeRate,
-    std::int32_t minimumScale);
+    std::int32_t minimumScale,
+    beast::Journal j);
 
 bool
 isRounded(Asset const& asset, Number const& value, std::int32_t scale);