Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Loan

Hierarchy

  • Loan

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Loan(loan: ILoanTuple, loanManagerAddress: string, tokenAddress: string): Loan

  • Parameters

    • loan: ILoanTuple
    • loanManagerAddress: string
    • tokenAddress: string

    Returns Loan

Properties

Readonly borrower

borrower: string

Readonly collateralAmount

collateralAmount: Wei

Readonly disbursementTime

disbursementTime: number

Readonly id

id: number

Readonly interestAmount

interestAmount: Tokens

Readonly loanAmount

loanAmount: Tokens

Readonly loanManagerAddress

loanManagerAddress: string

Readonly marginCallRate

marginCallRate: Tokens

Readonly maturity

maturity: number

Readonly productId

productId: number

Readonly repaymentAmount

repaymentAmount: Tokens

Readonly state

state: number

Readonly tokenAddress

tokenAddress: string

Accessors

collateralStatus

  • get collateralStatus(): string

  • Returns string

dueState

  • get dueState(): string

  • Returns string

isCollectable

  • get isCollectable(): boolean

  • Returns boolean

isCollected

  • get isCollected(): boolean

  • Returns boolean

isDue

  • get isDue(): boolean

  • Returns boolean

isExpired

  • get isExpired(): boolean

  • Returns boolean

isMarginLoan

  • get isMarginLoan(): boolean

  • Returns boolean

isRepaid

  • get isRepaid(): boolean

  • Returns boolean

isRepayable

  • get isRepayable(): boolean

  • Returns boolean

term

  • get term(): number

  • Returns number

Methods

calculateCollateralChange

  • calculateCollateralChange(currentRate: Tokens, targetRatio: Ratio): Wei

  • Parameters

    Returns Wei

calculateCollateralRatio

  • Parameters

    Returns Ratio

calculateCollateralRatioChange

  • calculateCollateralRatioChange(currentRate: Tokens, collateralChange: Wei): Ratio

  • Parameters

    Returns Ratio

Generated using TypeDoc