Class MarginfiClientReadonly

Entrypoint to interact with the marginfi contract.

Hierarchy

MarginfiClientReadonly

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Private constructor

new MarginfiClientReadonly(config: MarginfiConfig, program: MarginfiProgram, group: MarginfiGroup): MarginfiClientReadonly

- Defined in clientReadonly.ts:22
internal
Parameters
- config: MarginfiConfig
- program: MarginfiProgram
- group: MarginfiGroup
Returns MarginfiClientReadonly

Properties

Private _group

_group: MarginfiGroup

Readonly config

config: MarginfiConfig

Readonly program

program: MarginfiProgram

Readonly programId

programId: PublicKey

Accessors

group

get group(): MarginfiGroup

- Defined in clientReadonly.ts:97
Marginfi account group address

Returns MarginfiGroup

provider

get provider(): AnchorProvider

- Defined in clientReadonly.ts:101
Returns AnchorProvider

Methods

getAllMarginfiAccountAddresses

getAllMarginfiAccountAddresses(): Promise<PublicKey[]>

- Defined in clientReadonly.ts:112
Retrieves the addresses of all marginfi accounts in the udnerlying group.

Returns Promise<PublicKey[]>
Account addresses

getAllProgramAccountAddresses

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

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

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

getMarginfiAccountsForAuthority

getMarginfiAccountsForAuthority(authority: Address): Promise<MarginfiAccountReadonly[]>

- Defined in clientReadonly.ts:143
Retrieves all marginfi accounts under the specified authority.

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

Static fetch

fetch(config: MarginfiConfig, connection: Connection, opts?: ConfirmOptions): Promise<MarginfiClientReadonly>

- Defined in clientReadonly.ts:39
MarginfiClient factory

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

Parameters
- config: MarginfiConfig
  
  marginfi config
- connection: Connection
  
  Solana web.js Connection object
- Optional opts: ConfirmOptions
  
  Solana web.js ConfirmOptions object
Returns Promise<MarginfiClientReadonly>
MarginfiClient instance

Static fromEnv

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

- Defined in clientReadonly.ts:59
Parameters
- Optional overrides: Partial<{ connection: Connection; env: Environment; marginfiGroup: Address; programId: Address }>
Returns Promise<MarginfiClientReadonly>

Generated using TypeDoc