Class CredixPass

Hierarchy

CredixPass

Index

Constructors

constructor

new CredixPass(credixPass: AnchorTypeDef<Object, AnchorDefined<Credix, {
    DaycountConvention: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    DealTranche: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    DistributionWaterfall: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    DistributionWaterfallType: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    Fraction: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    LpClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    RepaymentAllocation: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    RepaymentPeriod: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    RepaymentPeriodInput: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    TimeFrame: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    Tranche: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    TrancheAmountsDue: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    TrancheAmountsRepaid: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    TrancheClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    TrancheConfig: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    TrancheRates: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
    WaterfallTier: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
}>>, address: PublicKey, market: Market, holder: PublicKey): CredixPass
Parameters
- credixPass: AnchorTypeDef<Object, AnchorDefined<Credix, {
      DaycountConvention: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      DealTranche: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      DistributionWaterfall: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      DistributionWaterfallType: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      Fraction: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      LpClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      RepaymentAllocation: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      RepaymentPeriod: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      RepaymentPeriodInput: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      TimeFrame: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      Tranche: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      TrancheAmountsDue: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      TrancheAmountsRepaid: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      TrancheClaim: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      TrancheConfig: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      TrancheRates: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
      WaterfallTier: AnchorTypeDef<Object, ({ Fraction: AnchorTypeDef<{ name: "Fraction"; type: { kind: "struct"; fields: [{ name: "numerator"; type: "u32"; }, { name: "denominator"; type: "u32"; }]; }; } & { name: "Fraction"; }, ...>; ... 15 more ...; TimeFrame: AnchorTypeDef<...>; })>;
  }>>
- address: PublicKey
- market: Market
- holder: PublicKey
Returns CredixPass
- Defined in packages/client/src/accounts/CredixPass.ts:14

Properties

address

address: PublicKey

holder

holder: PublicKey

market

market: Market

Accessors

bypassWithdrawEpochs

get bypassWithdrawEpochs(): boolean
If it is true, this user can call the withdraw_funds instruction and skip the withdraw epochs

Returns boolean
- Defined in packages/client/src/accounts/CredixPass.ts:47

isActive

get isActive(): boolean
Returns boolean
- Defined in packages/client/src/accounts/CredixPass.ts:29

isBorrower

get isBorrower(): boolean
Returns boolean
- Defined in packages/client/src/accounts/CredixPass.ts:21

isInvestor

get isInvestor(): boolean
Returns boolean
- Defined in packages/client/src/accounts/CredixPass.ts:25

releaseTimestamp

get releaseTimestamp(): number
The timestamp, in seconds, when the holder of this CredixPass can withdraw their funds.

Returns number
- Defined in packages/client/src/accounts/CredixPass.ts:40

withdrawalFeeDisabled

get withdrawalFeeDisabled(): boolean
Returns boolean
- Defined in packages/client/src/accounts/CredixPass.ts:33

Methods

update

update(credixPassConfig: CredixPassConfig): Promise<string>
Parameters
- credixPassConfig: CredixPassConfig
Returns Promise<string>
- Defined in packages/client/src/accounts/CredixPass.ts:51

`Static` generatePDA

generatePDA(holder: PublicKey, market: Market): [PublicKey, number]
Parameters
- holder: PublicKey
- market: Market
Returns [PublicKey, number]
- Defined in packages/client/src/accounts/CredixPass.ts:55

Class CredixPass

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: PublicKey

market: Market

holder: PublicKey

Returns CredixPass

Properties

address

holder

market

Accessors

bypassWithdrawEpochs

Returns boolean

isActive

Returns boolean

isBorrower

Returns boolean

isInvestor

Returns boolean

releaseTimestamp

Returns number

withdrawalFeeDisabled

Returns boolean

Methods

update

Parameters

credixPassConfig: CredixPassConfig

Returns Promise<string>

Static generatePDA

Parameters

holder: PublicKey

market: Market

Returns [PublicKey, number]

Settings

Member Visibility

Theme

`Static` generatePDA