352 auto const& tx =
ctx_.tx;
355 auto const amount = tx[sfAmount];
357 auto const loanID = tx[sfLoanID];
361 std::int32_t const loanScale = loanSle->at(sfLoanScale);
363 auto const brokerID = loanSle->at(sfLoanBrokerID);
367 auto const brokerOwner = brokerSle->at(sfOwner);
368 auto const brokerPseudoAccount = brokerSle->at(sfAccount);
369 auto const vaultID = brokerSle->at(sfVaultID);
373 auto const vaultPseudoAccount = vaultSle->at(sfAccount);
374 auto const asset = *vaultSle->at(sfAsset);
377 TenthBips32 const coverRateMinimum{brokerSle->at(sfCoverRateMinimum)};
378 auto debtTotalProxy = brokerSle->at(sfDebtTotal);
391 bool const sendBrokerFeeToOwner = [&] {
395 auto const minCover = [&] {
396 if (
view.rules().enabled(fixCleanup3_2_0))
405 asset,
tenthBipsOfValue(debtTotalProxy.value(), coverRateMinimum), loanScale);
407 return brokerSle->at(sfCoverAvailable) >= minCover &&
412 auto const brokerPayee = sendBrokerFeeToOwner ? brokerOwner : brokerPseudoAccount;
414 if (!sendBrokerFeeToOwner)
420 JLOG(
j_.warn()) <<
"Both Loan Broker and Loan Broker pseudo-account "
421 "can not receive funds (deep frozen).";
432 if (loanSle->isFlag(lsfLoanImpaired))
436 JLOG(
j_.fatal()) <<
"Failed to unimpair loan before payment.";
441 auto const scheduledInterest = [&loanSle] {
442 return loanSle->at(sfTotalValueOutstanding) - loanSle->at(sfPrincipalOutstanding) -
443 loanSle->at(sfManagementFeeOutstanding);
445 Number const scheduledInterestBefore = fixedPrecision ? scheduledInterest() :
kNumZero;
449 if (tx.isFlag(tfLoanLatePayment))
451 if (tx.isFlag(tfLoanFullPayment))
453 if (tx.isFlag(tfLoanOverpayment))
458 std::expected<LoanPaymentParts, TER>
const paymentParts =
463 paymentParts.error(),
"xrpl::LoanPay::doApply",
"payment error is an error");
464 return paymentParts.error();
468 view.update(loanSle);
470 Number const scheduledInterestDelta =
471 fixedPrecision ? scheduledInterest() - scheduledInterestBefore :
kNumZero;
475 paymentParts->principalPaid >= 0,
476 "xrpl::LoanPay::doApply",
477 "valid principal paid");
480 paymentParts->interestPaid >= 0,
481 "xrpl::LoanPay::doApply",
482 "valid interest paid");
485 paymentParts->principalPaid + paymentParts->interestPaid > 0,
486 "xrpl::LoanPay::doApply",
488 XRPL_ASSERT_PARTS(paymentParts->feePaid >= 0,
"xrpl::LoanPay::doApply",
"valid fee paid");
490 if (paymentParts->principalPaid < 0 || paymentParts->interestPaid < 0 ||
491 paymentParts->feePaid < 0)
494 JLOG(
j_.fatal()) <<
"Loan payment computation returned invalid values.";
501 view.update(brokerSle);
503 Number const assetsAvailableBefore = *vaultSle->at(sfAssetsAvailable);
504 Number const assetsTotalBefore = vaultSle->at(sfAssetsTotal);
506 auto const totalPaidToVaultRaw = paymentParts->principalPaid + paymentParts->interestPaid;
511 Number const assetsTotalDelta = fixedPrecision ?
kNumZero : deltas.assetsTotalDelta;
512 Number const debtTotalDelta = deltas.debtTotalDelta;
513 STAmount const totalPaidToVaultRounded = fixedPrecision
522 !asset.integral() || totalPaidToVaultRaw ==
Number(totalPaidToVaultRounded),
523 "xrpl::LoanPay::doApply",
524 "rounding does nothing for integral asset");
525 Number const totalPaidToBrokerRaw = paymentParts->feePaid;
530 Number const totalPaidToBroker = fixedPrecision && !sendBrokerFeeToOwner
534 : totalPaidToBrokerRaw;
536 JLOG(
j_.debug()) <<
"Loan Pay: principal paid: " << paymentParts->principalPaid
537 <<
", interest paid: " << paymentParts->interestPaid
538 <<
", fee paid: " << paymentParts->feePaid
539 <<
", assets total delta: " << assetsTotalDelta
540 <<
", debt total delta: " << debtTotalDelta
541 <<
", scheduled interest delta: " << scheduledInterestDelta;
547 isRounded(asset, debtTotalDelta, loanScale),
548 "xrpl::LoanPay::doApply",
549 "debtTotalDelta rounding good");
557 view.update(vaultSle);
567 .cash = totalPaidToVaultRounded,
568 .deployed = -paymentParts->principalPaid,
569 .yield = scheduledInterestDelta,
577 vaultSle->at(sfAssetsAvailable) += totalPaidToVaultRounded;
578 vaultSle->at(sfAssetsTotal) += assetsTotalDelta;
583 totalPaidToVaultRounded + totalPaidToBroker <= amount,
584 "xrpl::LoanPay::doApply",
585 "amount is sufficient");
587 if (!sendBrokerFeeToOwner)
594 brokerSle->at(sfCoverAvailable) += totalPaidToBroker;
602 Number const assetsAvailableAfter = vaultSle->at(sfAssetsAvailable);
603 Number const assetsTotalAfter = vaultSle->at(sfAssetsTotal);
605 if (assetsAvailableAfter == assetsAvailableBefore)
614 if (fixedPrecision && loanSle->at(sfPaymentRemaining) == 0)
616 JLOG(
j_.debug()) <<
"LoanPay: terminal payment closed the Loan with a zero cash "
617 "credit; the sub-unit remainder is forgiven. Principal: "
618 << paymentParts->principalPaid
619 <<
", Interest: " << paymentParts->interestPaid;
633 JLOG(
j_.warn()) <<
"LoanPay: Vault assets available unchanged after rounding: "
634 <<
"Before: " << assetsAvailableBefore
635 <<
", After: " << assetsAvailableAfter
636 <<
", Credit: " << totalPaidToVaultRounded
637 <<
", Principal: " << paymentParts->principalPaid
638 <<
", Interest: " << paymentParts->interestPaid;
642 if (!fixedPrecision && assetsTotalDelta !=
beast::kZero &&
643 assetsTotalAfter == assetsTotalBefore)
652 <<
"LoanPay: Vault assets expected change, but unchanged after rounding: "
653 <<
"Before: " << assetsTotalBefore
654 <<
", After: " << assetsTotalAfter
655 <<
", AssetsTotalDelta: " << assetsTotalDelta;
659 if (!fixedPrecision && assetsTotalDelta ==
beast::kZero &&
660 assetsTotalAfter != assetsTotalBefore)
667 JLOG(
j_.fatal()) <<
"LoanPay: Vault assets changed unexpectedly after rounding: "
668 <<
"Before: " << assetsTotalBefore
669 <<
", After: " << assetsTotalAfter
670 <<
", AssetsTotalDelta: " << assetsTotalDelta;
674 if (assetsAvailableAfter > assetsTotalAfter)
678 JLOG(
j_.fatal()) <<
"LoanPay: Vault assets available must not be greater "
679 "than assets outstanding. Available: "
680 << assetsAvailableAfter <<
", Total: " << assetsTotalAfter;
686 auto const accountBalanceBefore = conservationBalance(
view,
accountID_, asset,
j_);
687 auto const vaultBalanceBefore =
accountID_ == vaultPseudoAccount
689 : conservationBalance(
view, vaultPseudoAccount, asset,
j_);
690 auto const brokerBalanceBefore =
accountID_ == brokerPayee
692 : conservationBalance(
view, brokerPayee, asset,
j_);
697 bool const skipPayeeAuth =
view.rules().enabled(fixCleanup3_4_0);
699 if (!skipPayeeAuth && totalPaidToVaultRounded !=
beast::kZero)
711 ctx_.getApplyViewContext(),
713 brokerPayeeSle->at(sfBalance).value().xrp(),
734 {{vaultPseudoAccount, totalPaidToVaultRounded}, {brokerPayee, totalPaidToBroker}},
740 auto const accountBalanceAfter = conservationBalance(
view,
accountID_, asset,
j_);
741 auto const vaultBalanceAfter =
accountID_ == vaultPseudoAccount
743 : conservationBalance(
view, vaultPseudoAccount, asset,
j_);
744 auto const brokerBalanceAfter =
accountID_ == brokerPayee
746 : conservationBalance(
view, brokerPayee, asset,
j_);
747 auto const balanceScale = [&] {
757 for (
auto const& a : {
758 accountBalanceBefore,
770 if (exponents.
empty())
772 UNREACHABLE(
"xrpl::LoanPay::doApply : all zeroes");
776 auto const min = *minItr;
777 auto const max = *maxItr;
778 JLOG(
j_.trace()) <<
"Min scale: " << min <<
", max scale: " << max;
789 auto const accountBalanceBeforeRounded =
roundToScale(accountBalanceBefore, balanceScale);
790 auto const vaultBalanceBeforeRounded =
roundToScale(vaultBalanceBefore, balanceScale);
791 auto const brokerBalanceBeforeRounded =
roundToScale(brokerBalanceBefore, balanceScale);
793 auto const totalBalanceBefore = accountBalanceBefore + vaultBalanceBefore + brokerBalanceBefore;
794 auto const totalBalanceBeforeRounded =
roundToScale(totalBalanceBefore, balanceScale);
796 JLOG(
j_.trace()) <<
"Before: "
797 <<
"account " <<
Number(accountBalanceBeforeRounded) <<
" ("
798 <<
Number(accountBalanceBefore) <<
")"
799 <<
", vault " <<
Number(vaultBalanceBeforeRounded) <<
" ("
800 <<
Number(vaultBalanceBefore) <<
")"
801 <<
", broker " <<
Number(brokerBalanceBeforeRounded) <<
" ("
802 <<
Number(brokerBalanceBefore) <<
")"
803 <<
", total " <<
Number(totalBalanceBeforeRounded) <<
" ("
804 <<
Number(totalBalanceBefore) <<
")";
806 auto const accountBalanceAfterRounded =
roundToScale(accountBalanceAfter, balanceScale);
807 auto const vaultBalanceAfterRounded =
roundToScale(vaultBalanceAfter, balanceScale);
808 auto const brokerBalanceAfterRounded =
roundToScale(brokerBalanceAfter, balanceScale);
810 auto const totalBalanceAfter = accountBalanceAfter + vaultBalanceAfter + brokerBalanceAfter;
811 auto const totalBalanceAfterRounded =
roundToScale(totalBalanceAfter, balanceScale);
813 JLOG(
j_.trace()) <<
"After: "
814 <<
"account " <<
Number(accountBalanceAfterRounded) <<
" ("
815 <<
Number(accountBalanceAfter) <<
")"
816 <<
", vault " <<
Number(vaultBalanceAfterRounded) <<
" ("
817 <<
Number(vaultBalanceAfter) <<
")"
818 <<
", broker " <<
Number(brokerBalanceAfterRounded) <<
" ("
819 <<
Number(brokerBalanceAfter) <<
")"
820 <<
", total " <<
Number(totalBalanceAfterRounded) <<
" ("
821 <<
Number(totalBalanceAfter) <<
")";
823 auto const accountBalanceChange = accountBalanceAfter - accountBalanceBefore;
824 auto const vaultBalanceChange = vaultBalanceAfter - vaultBalanceBefore;
825 auto const brokerBalanceChange = brokerBalanceAfter - brokerBalanceBefore;
827 auto const totalBalanceChange = accountBalanceChange + vaultBalanceChange + brokerBalanceChange;
828 auto const totalBalanceChangeRounded =
roundToScale(totalBalanceChange, balanceScale);
830 JLOG(
j_.trace()) <<
"Changes: "
831 <<
"account " <<
to_string(accountBalanceChange)
832 <<
", vault " <<
to_string(vaultBalanceChange)
833 <<
", broker " <<
to_string(brokerBalanceChange)
834 <<
", total " <<
to_string(totalBalanceChangeRounded) <<
" ("
835 <<
Number(totalBalanceChange) <<
")";
841 if (asset.integral())
843 for (
auto const& balance : {before,
after})
850 Number const accountUnit = roundingUnit(accountBalanceBefore, accountBalanceAfter);
851 Number const vaultUnit = roundingUnit(vaultBalanceBefore, vaultBalanceAfter);
852 Number const brokerUnit = roundingUnit(brokerBalanceBefore, brokerBalanceAfter);
854 bool const goodRounding = totalBalanceBeforeRounded == totalBalanceAfterRounded ||
856 abs(
Number(totalBalanceChange)) <= accountUnit + vaultUnit + brokerUnit;
857 if (totalBalanceBeforeRounded != totalBalanceAfterRounded)
859 JLOG((goodRounding ?
j_.debug() :
j_.warn()))
860 <<
"Total rounded balances don't match"
861 << (totalBalanceChangeRounded ==
beast::kZero ?
", but total changes do" :
"");
865 JLOG((goodRounding ?
j_.debug() :
j_.warn()))
866 <<
"Total balance changes don't match"
867 << (totalBalanceBeforeRounded == totalBalanceAfterRounded ?
", but total balances do"
874 goodRounding,
"xrpl::LoanPay::doApply",
"funds are conserved (with rounding)");
879 accountBalanceAfter < accountBalanceBefore ||
accountID_ == asset.getIssuer() ||
880 (accountBalanceAfter == accountBalanceBefore &&
881 totalPaidToVaultRounded +
884 "xrpl::LoanPay::doApply",
885 "account balance decreased");
890 (brokerBalanceAfter >=
beast::kZero || (sendBrokerFeeToOwner && !asset.integral())),
891 "xrpl::LoanPay::doApply",
892 "non-negative vault and broker balances");
894 vaultBalanceAfter >= vaultBalanceBefore,
895 "xrpl::LoanPay::doApply",
896 "vault balance did not decrease");
898 brokerBalanceAfter >= brokerBalanceBefore,
899 "xrpl::LoanPay::doApply",
900 "broker balance did not decrease");
904 vaultBalanceAfter > vaultBalanceBefore || brokerBalanceAfter > brokerBalanceBefore ||
905 brokerPayee == asset.getIssuer() ||
906 (
Number(totalPaidToVaultRounded) <= vaultUnit && totalPaidToBroker <= brokerUnit),
907 "xrpl::LoanPay::doApply",
908 "vault and/or broker balance increased");