Class MarginfiClient

Entrypoint to interact with the marginfi contract.

Hierarchy

MarginfiClient

Index

Properties

Accessors

group

Methods

Properties

Private _group

_group: MarginfiGroup

Readonly config

config: MarginfiConfig

Readonly program

program: Program<MarginfiIdl>

Readonly programId

programId: PublicKey

Accessors

group

get group(): MarginfiGroup

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

Returns MarginfiGroup

Methods

createMarginfiAccount

createMarginfiAccount(): Promise<MarginfiAccount>

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

Returns Promise<MarginfiAccount>
MarginfiAccount instance

getAllMarginfiAccountAddresses

getAllMarginfiAccountAddresses(): Promise<PublicKey[]>

- Defined in client.ts:191
Retrieves the addresses of all marginfi accounts in the udnerlying group.

Returns Promise<PublicKey[]>
Account addresses

getAllMarginfiAccounts

getAllMarginfiAccounts(): Promise<MarginfiAccount[]>

- Defined in client.ts:166
Retrieves all marginfi accounts in the underlying group.

Returns Promise<MarginfiAccount[]>
MarginfiAccount instances

getAllProgramAccountAddresses

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

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

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

getMarginfiAccount

getMarginfiAccount(address: PublicKey): Promise<MarginfiAccount>

- Defined in client.ts:182
Parameters
- address: PublicKey
Returns Promise<MarginfiAccount>

getOwnMarginfiAccounts

getOwnMarginfiAccounts(): Promise<MarginfiAccount[]>

- Defined in client.ts:141
Retrieves all marginfi accounts under the authority of the user.

Returns Promise<MarginfiAccount[]>
MarginfiAccount instances

Static fetch

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

- Defined in client.ts:46
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 transations)
- 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: PublicKey; programId: PublicKey; wallet: Wallet }>): Promise<MarginfiClient>

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

Generated using TypeDoc