Class CredixClient

Client for interacting with Credix programs

Hierarchy

CredixClient

Index

Constructors

Properties

repaymentScheduleLoader tranchesLoader

Accessors

Methods

fetchCredixPasses fetchDealByPublicKey fetchMarket fetchMarkets fetchProgramState initializeMarket initializeMarketIx initializeProgramState

Constructors

constructor

new CredixClient(connection: Connection, wallet: Wallet, config: CredixClientConfig): CredixClient
Parameters
- connection: Connection
  
  The connection to be used by the client
- wallet: Wallet
  
  The wallet to be used by the client
- config: CredixClientConfig
  
  Configuration of the client. If no confirm options are present the client will use the default options from the connection
Returns CredixClient
- Defined in packages/client/src/rpc/CredixClient.ts:104

Properties

repaymentScheduleLoader

repaymentScheduleLoader: RepaymentScheduleLoader

tranchesLoader

tranchesLoader: TranchesLoader

Accessors

user

get user(): undefined | PublicKey
Returns undefined | PublicKey
- Defined in packages/client/src/rpc/CredixClient.ts:113

Methods

fetchCredixPasses

fetchCredixPasses(): Promise<CredixPass[]>
Returns Promise<CredixPass[]>
- Defined in packages/client/src/rpc/CredixClient.ts:254

fetchDealByPublicKey

fetchDealByPublicKey(publicKey: PublicKey): Promise<null | Deal>
Fetches a deal by public key

Returns
Parameters
- publicKey: PublicKey
Returns Promise<null | Deal>
- Defined in packages/client/src/rpc/CredixClient.ts:298

fetchMarket

fetchMarket(marketName: string): Promise<null | Market>
Fetches a market. This market is the main entrypoint for the Credix market program.

Returns
Parameters
- marketName: string
  
  Name of the market to fetch
Returns Promise<null | Market>
- Defined in packages/client/src/rpc/CredixClient.ts:241

fetchMarkets

fetchMarkets(): Promise<Market[]>
Returns Promise<Market[]>
- Defined in packages/client/src/rpc/CredixClient.ts:316

fetchProgramState

fetchProgramState(): Promise<ProgramState>
Returns Promise<ProgramState>
- Defined in packages/client/src/rpc/CredixClient.ts:324

initializeMarket

initializeMarket(marketConfiguration: MarketConfig): Promise<string>
Parameters
- marketConfiguration: MarketConfig
Returns Promise<string>
- Defined in packages/client/src/rpc/CredixClient.ts:216

initializeMarketIx

initializeMarketIx(marketConfiguration: MarketConfig, owner?: PublicKey): Promise<TransactionInstruction>
Parameters
- marketConfiguration: MarketConfig
- Optional owner: PublicKey
Returns Promise<TransactionInstruction>
- Defined in packages/client/src/rpc/CredixClient.ts:225

initializeProgramState

initializeProgramState(credixMultisigKey: PublicKey, credixManagers: PublicKey[], credixPerformanceFeePercentage: Fraction, credixServiceFeePercentage: Fraction): Promise<string>
Parameters
- credixMultisigKey: PublicKey
- credixManagers: PublicKey[]
- credixPerformanceFeePercentage: Fraction
- credixServiceFeePercentage: Fraction
Returns Promise<string>
- Defined in packages/client/src/rpc/CredixClient.ts:117

Generated using TypeDoc