ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-01 00:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleans up loanstate docs

Browse Source
This commit is contained in:
Vito
2025-11-15 13:18:57 +01:00
parent a54b03b4b6
commit 850c38a107
1 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
src/xrpld/app/misc/LendingHelpers.h
View File

@@ -50,7 +50,7 @@ struct LoanPaymentParts
operator==(LoanPaymentParts const& other) const; operator==(LoanPaymentParts const& other) const;
}; };
/** This structure describes the initial "computed" properties of a loan. /** This structure describes the initial computed properties of a loan.
* *
* It is used at loan creation and when the terms of a loan change, such as * It is used at loan creation and when the terms of a loan change, such as
* after an overpayment. * after an overpayment.
@@ -64,32 +64,31 @@ struct LoanProperties
Number firstPaymentPrincipal; Number firstPaymentPrincipal;
}; };
/** This structure captures the current state of a loan and all the /** This structure captures the parts of a loan state.
relevant parts. *
* Whether the values are raw (unrounded) or rounded will depend on how it was
Whether the values are raw (unrounded) or rounded will * computed.
depend on how it was computed. *
* Many of the fields can be derived from each other, but they're all provided
Many of the fields can be derived from each other, but they're all provided * here to reduce code duplication and possible mistakes.
here to reduce code duplication and possible mistakes. * e.g.
e.g. * * interestOutstanding = valueOutstanding - principalOutstanding
* interestOutstanding = valueOutstanding - principalOutstanding * * interestDue = interestOutstanding - managementFeeDue
* interestDue = interestOutstanding - managementFeeDue
*/ */
struct LoanState struct LoanState
{ {
/// Total value still due to be paid by the borrower. // Total value still due to be paid by the borrower.
Number valueOutstanding; Number valueOutstanding;
/// Prinicipal still due to be paid by the borrower. // Principal still due to be paid by the borrower.
Number principalOutstanding; Number principalOutstanding;
/// Interest still due to be paid TO the Vault. // Interest still due to be paid to the Vault.
// This is a portion of interestOutstanding // This is a portion of interestOutstanding
Number interestDue; Number interestDue;
/// Management fee still due to be paid TO the broker. // Management fee still due to be paid to the broker.
// This is a portion of interestOutstanding // This is a portion of interestOutstanding
Number managementFeeDue; Number managementFeeDue;
/// Interest still due to be paid by the borrower. // Interest still due to be paid by the borrower.
Number Number
interestOutstanding() const interestOutstanding() const
{ {