Class MarginfiClient

Entrypoint to interact with the marginfi contract.

Hierarchy

MarginfiClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Private constructor

new MarginfiClient(config: MarginfiConfig, program: MarginfiProgram, wallet: Wallet, group: MarginfiGroup): MarginfiClient

- Defined in client.ts:40
internal
Parameters
- config: MarginfiConfig
- program: MarginfiProgram
- wallet: Wallet
- group: MarginfiGroup
Returns MarginfiClient

Properties

Private _group

_group: MarginfiGroup

Readonly config

config: MarginfiConfig

Readonly program

program: MarginfiProgram

Readonly programId

programId: PublicKey

Readonly wallet

wallet: Wallet

Accessors

group

get group(): MarginfiGroup

- Defined in client.ts:128
Marginfi account group address

Returns MarginfiGroup

provider

get provider(): AnchorProvider

- Defined in client.ts:132
Returns AnchorProvider

Methods

createMarginfiAccount

createMarginfiAccount(opts?: TransactionOptions): Promise<MarginfiAccount>

- Defined in client.ts:169
Create a new marginfi account under the authority of the user.

Parameters
- Optional opts: TransactionOptions
Returns Promise<MarginfiAccount>
MarginfiAccount instance

getAllMarginfiAccountAddresses

getAllMarginfiAccountAddresses(): Promise<PublicKey[]>

- Defined in client.ts:190
Retrieves the addresses of all marginfi accounts in the underlying group.

Returns Promise<PublicKey[]>
Account addresses

getAllProgramAccountAddresses

getAllProgramAccountAddresses(type: AccountType): Promise<PublicKey[]>

- Defined in client.ts:248
Retrieves the addresses of all accounts owned by the marginfi program.

Parameters
- type: AccountType
Returns Promise<PublicKey[]>
Account addresses

getMarginfiAccountsForAuthority

getMarginfiAccountsForAuthority(authority?: Address): Promise<MarginfiAccount[]>

- Defined in client.ts:221
Retrieves all marginfi accounts under the specified authority.

Parameters
- Optional authority: Address
Returns Promise<MarginfiAccount[]>
MarginfiAccount instances

makeCreateMarginfiAccountIx

makeCreateMarginfiAccountIx(marginfiAccountKeypair?: Keypair): Promise<InstructionsWrapper>

- Defined in client.ts:143
Create transaction instruction to create a new marginfi account under the authority of the user.

Parameters
- Optional marginfiAccountKeypair: Keypair
Returns Promise<InstructionsWrapper>
transaction instruction

processTransaction

processTransaction(transaction: Transaction, signers?: Signer[], opts?: TransactionOptions): Promise<string>

- Defined in client.ts:268
Parameters
- transaction: Transaction
- Optional signers: Signer[]
- Optional opts: TransactionOptions
Returns Promise<string>

Static fetch

fetch(config: MarginfiConfig, wallet: Wallet, connection: Connection, opts?: ConfirmOptions): Promise<MarginfiClient>

- Defined in client.ts:63
MarginfiClient factory

Fetch account data according to the config and instantiate the corresponding MarginfiAccount.

Parameters
- config: MarginfiConfig
  
  marginfi config
- wallet: Wallet
  
  User wallet (used to pay fees and sign transactions)
- connection: Connection
  
  Solana web.js Connection object
- Optional opts: ConfirmOptions
  
  Solana web.js ConfirmOptions object
Returns Promise<MarginfiClient>
MarginfiClient instance

Static fromEnv

fromEnv(overrides?: Partial<{ connection: Connection; env: Environment; marginfiGroup: Address; programId: Address; wallet: Wallet }>): Promise<MarginfiClient>

- Defined in client.ts:82
Parameters
- Optional overrides: Partial<{ connection: Connection; env: Environment; marginfiGroup: Address; programId: Address; wallet: Wallet }>
Returns Promise<MarginfiClient>

Generated using TypeDoc