-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loans: principal and interest separation (#1435)
* add fields * loan repayment schema * external pricing with interest * add type for active interest rates * pricing based on interest rate module * minor changes * update diagram with max borrow amount * update diagram with PR changes * minor method renamed * rename normalized_debt field * rename interest_rate to interest * legacy tests passing * add new tests for external interest * support interest rate mutation for external pricing * fix benchmarks * rename unchecked to unscheduled amount * update diagram with RepaidAmount * fix integration tests * minor diagram layout change * fix runtime common issue * fix integration tests * add missing docs * remove Once part from RepayRestriction::FullOnce
- Loading branch information
Showing
20 changed files
with
950 additions
and
308 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,263 @@ | ||
| ```plantuml | ||
| @startuml | ||
| set namespaceSeparator :: | ||
| hide methods | ||
| enum Maturity { | ||
| Fixed: Moment | ||
| } | ||
| enum CalendarEvent { | ||
| End | ||
| } | ||
| enum ReferenceDate{ | ||
| CalendarDate: CalendarEvent, | ||
| OriginationDate | ||
| } | ||
| ReferenceDate *--> CalendarEvent | ||
| enum InterestPayments { | ||
| None | ||
| Monthly: ReferenceDate | ||
| SemiAnnually: ReferenceDate | ||
| } | ||
| InterestPayments *--> ReferenceDate | ||
| enum PayDownSchedule { | ||
| None | ||
| } | ||
| class RepaymentSchedule { | ||
| maturity: Maturity | ||
| interest_payments: InterestPayments | ||
| pay_down_schedule: PayDownSchedule | ||
| } | ||
| RepaymentSchedule *--> Maturity | ||
| RepaymentSchedule *--> PayDownSchedule | ||
| RepaymentSchedule *-----> InterestPayments | ||
| enum BorrowRestrictions { | ||
| NoWrittenOff | ||
| FullOnce | ||
| } | ||
| enum RepayRestrictions { | ||
| None | ||
| Full | ||
| } | ||
| class LoanRestrictions { | ||
| borrows: BorrowRestrictions | ||
| repayments: RepayRestrictions | ||
| } | ||
| LoanRestrictions *--> BorrowRestrictions | ||
| LoanRestrictions *--> RepayRestrictions | ||
| enum CompoundingCadence { | ||
| Secondly: ReferenceDate | ||
| } | ||
| CompoundingCadence *--> ReferenceDate | ||
| enum InterestRate { | ||
| Fixed: Rate, CompoundingCadence | ||
| } | ||
| InterestRate *--> CompoundingCadence | ||
| class RepaidAmount { | ||
| principal: Balance | ||
| interest: Balance | ||
| unscheduled: Balance | ||
| } | ||
| package portfolio { | ||
| class PortfolioValuation { | ||
| value: Balance | ||
| last_updated: Moment | ||
| values: Vec<Tuple<LoanId, Balance>> | ||
| } | ||
| } | ||
| package valuation { | ||
| class DiscountedCashFlows { | ||
| probability_of_default: Rate | ||
| loss_given_default: Rate | ||
| discount_rate: Rate | ||
| } | ||
| ValuationMethod *--> DiscountedCashFlows | ||
| enum ValuationMethod { | ||
| DiscountedCashFlows: DiscountedCashFlows | ||
| OutstandingDebt | ||
| } | ||
| } | ||
| package policy { | ||
| class WriteOffStatus { | ||
| percentage: Rate | ||
| penalty: Rate | ||
| } | ||
| enum WriteOffTrigger { | ||
| PrincipalOverdueDays, | ||
| PriceOutdated, | ||
| } | ||
| class WriteOffRule { | ||
| triggers: Vec<WriteOffTrigger> | ||
| status: WriteOffStatus | ||
| } | ||
| WriteOffRule *--> WriteOffTrigger | ||
| WriteOffRule *--> WriteOffStatus | ||
| } | ||
| package interest { | ||
| class ActiveInterestRate { | ||
| rate: InterestRate, | ||
| normalized_debt: Balance, | ||
| penalty: Rate | ||
| } | ||
| ActiveInterestRate *--> InterestRate | ||
| } | ||
| package pricing { | ||
| package internal { | ||
| enum MaxBorrowAmount { | ||
| UpToTotalBorrows::advance_rate: Rate | ||
| UpToOutstandingDebt::advance_rate: Rate | ||
| } | ||
| class InternalPricing { | ||
| collateral_value: Balance | ||
| valuation_method: ValuationMethod | ||
| max_borrow_amount: MaxBorrowAmount | ||
| } | ||
| InternalPricing *-l-> MaxBorrowAmount | ||
| InternalPricing *-d-> valuation::ValuationMethod | ||
| class InternalActivePricing { | ||
| info: InternalPricing | ||
| interest: ActiveInterestRate | ||
| } | ||
| InternalActivePricing *-r-> ActiveInterestRate | ||
| InternalActivePricing *--> InternalPricing | ||
| } | ||
| package external { | ||
| enum MaxBorrowAmount { | ||
| Quantity: Rate | ||
| NoLimit | ||
| } | ||
| class ExternalPricing { | ||
| price_id: Price, | ||
| max_borrow_quantity: Balance, | ||
| notional: Rate, | ||
| } | ||
| ExternalPricing *-l-> MaxBorrowAmount | ||
| class ExternalActivePricing { | ||
| info: ExternalPricing | ||
| outstanding_quantity: Balance, | ||
| interest: ActiveInterestRate | ||
| } | ||
| ExternalActivePricing *-r-> ActiveInterestRate | ||
| ExternalActivePricing *--> ExternalPricing | ||
| } | ||
| enum Pricing { | ||
| Internal: InternalPricing | ||
| External: ExternalPricing | ||
| } | ||
| enum ActivePricing { | ||
| Internal: InternalActivePricing | ||
| External: ExternalActivePricing | ||
| } | ||
| Pricing *--> InternalPricing | ||
| Pricing *--> ExternalPricing | ||
| ActivePricing *----> InternalActivePricing | ||
| ActivePricing *--> ExternalActivePricing | ||
| } | ||
| package loan { | ||
| class LoanInfo { | ||
| schedule: RepaymentSchedule | ||
| collateral: Asset | ||
| restrictions: LoanRestrictions | ||
| pricing: Pricing | ||
| } | ||
| class CreatedLoan { | ||
| info: LoanInfo | ||
| borrower: AccountId | ||
| } | ||
| class ActiveLoan { | ||
| loan_id: LoanId | ||
| borrower: AccountId | ||
| schedule: RepaymentSchedule | ||
| collateral: Asset | ||
| restrictions: LoanRestrictions | ||
| pricing: ActivePricing | ||
| write_off_percentage: Rate | ||
| origination_date: Moment | ||
| total_borrowed: Balance | ||
| total_repaid: RepaidAmount | ||
| } | ||
| class ClosedLoan { | ||
| closed_at: BlockNumber | ||
| info: LoanInfo | ||
| total_borrowed: Balance | ||
| total_repaid: Balance | ||
| } | ||
| LoanInfo *--> RepaymentSchedule | ||
| LoanInfo *-r-> LoanRestrictions | ||
| LoanInfo *--> pricing::Pricing | ||
| LoanInfo *--> ActiveInterestRate | ||
| CreatedLoan *--> LoanInfo | ||
| ActiveLoan *--> pricing::ActivePricing | ||
| ActiveLoan *-d--> RepaymentSchedule | ||
| ActiveLoan *-r-> LoanRestrictions | ||
| ActiveLoan *-r-> RepaidAmount | ||
| ClosedLoan *--> LoanInfo | ||
| } | ||
| class Storage <<(P, orange)>> { | ||
| CreatedLoan: Map<PoolId, LoanId, CreatedLoan> | ||
| ActiveLoans: Map<PoolId, Vec<Tuple<LoanId, ActiveLoan>>> | ||
| ClosedLoan: Map<PoolId, LoanId, ClosedLoan> | ||
| LastLoanId: Map<PoolId, LoanId> | ||
| WriteOffPolicy: Map<PoolId, Vec<WriteOffRule>> | ||
| PortfolioValuation: Map<PoolId, PortfolioValuation> | ||
| } | ||
| Storage *--> "n" CreatedLoan | ||
| Storage *--> "n" ActiveLoan | ||
| Storage *--> "n" ClosedLoan | ||
| Storage *-u-> "n" WriteOffRule | ||
| Storage *-u-> "n" PortfolioValuation | ||
| @enduml | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.