xrpl::Lending Namespace Reference

Functions
TenthBips16 constexpr	maxManagementFeeRate (unsafe_cast< std::uint16_t >(percentageToTenthBips(10).value()))
	The maximum management fee rate allowed by a loan broker in 1/10 bips.

Variables
TenthBips32 constexpr	maxCoverRate = percentageToTenthBips(100)
	The maximum coverage rate required of a loan broker in 1/10 bips.
TenthBips32 constexpr	maxOverpaymentFee = percentageToTenthBips(100)
	The maximum overpayment fee on a loan in 1/10 bips.
TenthBips32 constexpr	maxInterestRate = percentageToTenthBips(100)
	Annualized interest rate of the Loan in 1/10 bips.
TenthBips32 constexpr	maxLateInterestRate = percentageToTenthBips(100)
	The maximum premium added to the interest rate for late payments on a loan in 1/10 bips.
TenthBips32 constexpr	maxCloseInterestRate = percentageToTenthBips(100)
	The maximum close interest rate charged for repaying a loan early in 1/10 bips.
TenthBips32 constexpr	maxOverpaymentInterestRate = percentageToTenthBips(100)
	The maximum overpayment interest rate charged on loan overpayments in 1/10 bips.
static constexpr int	loanPaymentsPerFeeIncrement = 5
	LoanPay transaction cost will be one base fee per X combined payments.
static constexpr int	loanMaximumPaymentsPerTransaction = 100
	Maximum number of combined payments that a LoanPay transaction will process.

Function Documentation

maxManagementFeeRate()

TenthBips16 constexpr xrpl::Lending::maxManagementFeeRate ( unsafe_cast< std::uint16_t >  percentageToTenthBips(10).value() )

constexpr

The maximum management fee rate allowed by a loan broker in 1/10 bips.

Valid values are between 0 and 10% inclusive.

Variable Documentation

maxCoverRate

TenthBips32 constexpr xrpl::Lending::maxCoverRate = percentageToTenthBips(100)

constexpr

The maximum coverage rate required of a loan broker in 1/10 bips.

Valid values are between 0 and 100% inclusive.

Definition at line 126 of file Protocol.h.

maxOverpaymentFee

TenthBips32 constexpr xrpl::Lending::maxOverpaymentFee = percentageToTenthBips(100)

constexpr

The maximum overpayment fee on a loan in 1/10 bips.

Valid values are between 0 and 100% inclusive.

Definition at line 133 of file Protocol.h.

maxInterestRate

TenthBips32 constexpr xrpl::Lending::maxInterestRate = percentageToTenthBips(100)

constexpr

Annualized interest rate of the Loan in 1/10 bips.

Valid values are between 0 and 100% inclusive.

Definition at line 140 of file Protocol.h.

maxLateInterestRate

TenthBips32 constexpr xrpl::Lending::maxLateInterestRate = percentageToTenthBips(100)

constexpr

The maximum premium added to the interest rate for late payments on a loan in 1/10 bips.

Valid values are between 0 and 100% inclusive.

Definition at line 148 of file Protocol.h.

maxCloseInterestRate

TenthBips32 constexpr xrpl::Lending::maxCloseInterestRate = percentageToTenthBips(100)

constexpr

The maximum close interest rate charged for repaying a loan early in 1/10 bips.

Valid values are between 0 and 100% inclusive.

Definition at line 156 of file Protocol.h.

maxOverpaymentInterestRate

TenthBips32 constexpr xrpl::Lending::maxOverpaymentInterestRate = percentageToTenthBips(100)

constexpr

The maximum overpayment interest rate charged on loan overpayments in 1/10 bips.

Valid values are between 0 and 100% inclusive.

Definition at line 164 of file Protocol.h.

loanPaymentsPerFeeIncrement

constexpr int xrpl::Lending::loanPaymentsPerFeeIncrement = 5

staticconstexpr

LoanPay transaction cost will be one base fee per X combined payments.

The number of payments is estimated based on the Amount paid and the Loan's Fixed Payment size. Overpayments (indicated with the tfLoanOverpayment flag) count as one more payment.

This number was chosen arbitrarily, but should not be changed once released without an amendment

Definition at line 176 of file Protocol.h.

loanMaximumPaymentsPerTransaction

constexpr int xrpl::Lending::loanMaximumPaymentsPerTransaction = 100

staticconstexpr

Maximum number of combined payments that a LoanPay transaction will process.

This limit is enforced during the loan payment process, and thus is not estimated. If the limit is hit, no further payments or overpayments will be processed, no matter how much of the transaction Amount is left, but the transaction will succeed with the payments that have been processed up to that point.

This limit is independent of loanPaymentsPerFeeIncrement, so a transaction could potentially be charged for many more payments than actually get processed. Users should take care not to submit a transaction paying more than loanMaximumPaymentsPerTransaction * Loan.PeriodicPayment. Because overpayments are charged as a payment, if submitting loanMaximumPaymentsPerTransaction * Loan.PeriodicPayment, users should not set the tfLoanOverpayment flag.

Even though they're independent, loanMaximumPaymentsPerTransaction should be a multiple of loanPaymentsPerFeeIncrement.

This number was chosen arbitrarily, but should not be changed once released without an amendment

Definition at line 200 of file Protocol.h.