xrpl::LoanState Struct Reference

This structure captures the parts of a loan state. More...

#include <LendingHelpers.h>

Collaboration diagram for xrpl::LoanState:

Public Member Functions
Number	interestOutstanding () const

Public Attributes
Number	valueOutstanding
Number	principalOutstanding
Number	interestDue
Number	managementFeeDue

Detailed Description

This structure captures the parts of a loan state.

Whether the values are theoretical (unrounded) or rounded will depend on how it was computed.

Many of the fields can be derived from each other, but they're all provided here to reduce code duplication and possible mistakes. e.g.

• interestOutstanding = valueOutstanding - principalOutstanding
• interestDue = interestOutstanding - managementFeeDue

Definition at line 182 of file LendingHelpers.h.

Member Function Documentation

interestOutstanding()

Number xrpl::LoanState::interestOutstanding ( ) const

nodiscard

Definition at line 197 of file LendingHelpers.h.

Member Data Documentation

valueOutstanding

Number xrpl::LoanState::valueOutstanding

Definition at line 185 of file LendingHelpers.h.

principalOutstanding

Number xrpl::LoanState::principalOutstanding

Definition at line 187 of file LendingHelpers.h.

interestDue

Number xrpl::LoanState::interestDue

Definition at line 190 of file LendingHelpers.h.

managementFeeDue

Number xrpl::LoanState::managementFeeDue

Definition at line 193 of file LendingHelpers.h.