Class RepaymentPeriod

Hierarchy

RepaymentPeriod

Index

Constructors

Accessors

cumulative cumulativeInterest cumulativePrincipal interest interestRepaid interestToRepay principal principalRepaid principalToRepay totalRepaid totalToRepay

Methods

dueAt isInterestRepaid isPrincipalRepaid isRepaid

Constructors

constructor

new RepaymentPeriod(programVersion: AnchorTypeDef<Object, {
    DealTranche: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
    Fraction: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
    LpClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
    RepaymentPeriod: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
    RepaymentPeriodInput: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
    TrancheClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
    TrancheConfig: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
}>): RepaymentPeriod
Parameters
- programVersion: AnchorTypeDef<Object, {
      DealTranche: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
      Fraction: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
      LpClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
      RepaymentPeriod: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
      RepaymentPeriodInput: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
      TrancheClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
      TrancheConfig: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 5 more ...; TrancheClaim: AnchorTypeDef<...>; })>;
  }>
Returns RepaymentPeriod
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:8

Accessors

cumulative

get cumulative(): TokenAmount
Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:74

cumulativeInterest

get cumulativeInterest(): TokenAmount
interest cum sum upto this repayment.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:70

cumulativePrincipal

get cumulativePrincipal(): TokenAmount
principal cum sum upto this repayment.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:63

interest

get interest(): TokenAmount
interest to return in this repayment.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:31

interestRepaid

get interestRepaid(): TokenAmount
interest repaid in this repayment.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:38

interestToRepay

get interestToRepay(): TokenAmount
Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:42

principal

get principal(): TokenAmount
principal to return in this repayment.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:13

principalRepaid

get principalRepaid(): TokenAmount
principal repaid in this repayment.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:20

principalToRepay

get principalToRepay(): TokenAmount
Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:24

totalRepaid

get totalRepaid(): TokenAmount
Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:46

totalToRepay

get totalToRepay(): TokenAmount
The sum of the missing principal and interest for this period

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:53

Methods

dueAt

dueAt(goLiveAt: number, index: number, periodDuration?: number): Date
The date the repayment period starts being due.

Returns
Parameters
- goLiveAt: number
  
  the deal's go live date (in seconds)
- index: number
  
  the repayment period index
- periodDuration: number = 30
  
  the duration of each period, 30 by default
Returns Date
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:88

isInterestRepaid

isInterestRepaid(): boolean
Returns boolean
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:100

isPrincipalRepaid

isPrincipalRepaid(): boolean
Returns boolean
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:96

isRepaid

isRepaid(): boolean
Returns boolean
- Defined in packages/client/src/accounts/RepaymentPeriod.ts:92

Class RepaymentPeriod

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns RepaymentPeriod

Accessors

cumulative

Returns TokenAmount

cumulativeInterest

Returns TokenAmount

cumulativePrincipal

Returns TokenAmount

interest

Returns TokenAmount

interestRepaid

Returns TokenAmount

interestToRepay

Returns TokenAmount

principal

Returns TokenAmount

principalRepaid

Returns TokenAmount

principalToRepay

Returns TokenAmount

totalRepaid

Returns TokenAmount

totalToRepay

Returns TokenAmount

Methods

dueAt

Returns

Parameters

goLiveAt: number

index: number

periodDuration: number = 30

Returns Date

isInterestRepaid

Returns boolean

isPrincipalRepaid

Returns boolean

isRepaid

Returns boolean

Settings

Member Visibility

Theme