Class RepaymentSchedule

Hierarchy

RepaymentSchedule

Index

Constructors

constructor

new RepaymentSchedule(programVersion: AnchorTypeDef<Object, AnchorDefined<Credix, {
    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<...>; })>;
}>>, address: PublicKey): RepaymentSchedule
Parameters
- programVersion: AnchorTypeDef<Object, AnchorDefined<Credix, {
      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<...>; })>;
  }>>
- address: PublicKey
Returns RepaymentSchedule
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:17

Properties

address

address: PublicKey

periods

periods: RepaymentPeriod[]

Accessors

activePeriod

get activePeriod(): undefined | RepaymentPeriod
The first unrepaid period

Returns undefined | RepaymentPeriod
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:51

daysInYear

get daysInYear(): number
Returns number
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:28

duration

get duration(): number
Returns number
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:36

periodDuration

get periodDuration(): number
Returns number
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:32

totalInterest

get totalInterest(): TokenAmount
Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:44

totalPeriods

get totalPeriods(): number
Returns number
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:24

totalPrincipal

get totalPrincipal(): TokenAmount
Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:40

Methods

calculateFinancingFee

calculateFinancingFee(): Fraction
Returns
the financing fee

Returns Fraction
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:176

currentPeriod

currentPeriod(deal: Deal): null | RepaymentPeriod
The period that, from a time perspective, is the period that is active
Parameters
- deal: Deal
  
  The deal to get the current period for
Returns null | RepaymentPeriod
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:94

currentPeriodIndex

currentPeriodIndex(deal: Deal): null | number
Parameters
- deal: Deal
  
  The deal to get the current period index for
Returns null | number
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:77

currentlyMissing

currentlyMissing(deal: Deal): null | TokenAmount
The sum of the missing principal and interest for all periods up to and including the current period.
Parameters
- deal: Deal
  
  The deal to get the total missing amount for
Returns null | TokenAmount
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:108

interestMissing

interestMissing(): TokenAmount
The sum of the missing interest for all periods.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:148

interestRepaid

interestRepaid(): TokenAmount
The sum of the interest repaid.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:136

isRepaid

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

principalMissing

principalMissing(): TokenAmount
The sum of the missing principal for all periods.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:160

principalRepaid

principalRepaid(): TokenAmount
The sum of the principal repaid.

Returns TokenAmount
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:124

toRepaymentScheduleConfig

toRepaymentScheduleConfig(): RepaymentScheduleConfig
Returns RepaymentScheduleConfig
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:55

`Static` generatePDA

generatePDA(deal: Deal): Promise<[PublicKey, number]>
Parameters
- deal: Deal
Returns Promise<[PublicKey, number]>
- Defined in packages/client/src/accounts/RepaymentSchedule.ts:181

Class RepaymentSchedule

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: PublicKey

Returns RepaymentSchedule

Properties

address

periods

Accessors

activePeriod

Returns undefined | RepaymentPeriod

daysInYear

Returns number

duration

Returns number

periodDuration

Returns number

totalInterest

Returns TokenAmount

totalPeriods

Returns number

totalPrincipal

Returns TokenAmount

Methods

calculateFinancingFee

Returns

Returns Fraction

currentPeriod

Parameters

deal: Deal

Returns null | RepaymentPeriod

currentPeriodIndex

Parameters

deal: Deal

Returns null | number

currentlyMissing

Parameters

deal: Deal

Returns null | TokenAmount

interestMissing

Returns TokenAmount

interestRepaid

Returns TokenAmount

isRepaid

Returns boolean

principalMissing

Returns TokenAmount

principalRepaid

Returns TokenAmount

toRepaymentScheduleConfig

Returns RepaymentScheduleConfig

Static generatePDA

Parameters

deal: Deal

Returns Promise<[PublicKey, number]>

Settings

Member Visibility

Theme

`Static` generatePDA