Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MarginfiAccount

Wrapper class around a specific marginfi marginfi account.

Hierarchy

  • MarginfiAccount

Index

Properties

Accessors

Methods

Properties

Private _authority

_authority: PublicKey

Private _borrowRecord

_borrowRecord: BigNumber

Private _depositRecord

_depositRecord: BigNumber

Readonly client

client: MarginfiClient

group

group: MarginfiGroup

Readonly mango

mango: UtpMangoAccount

observationCache

observationCache: ObservationCache = ...

Readonly publicKey

publicKey: PublicKey

Readonly zo

zo: UtpZoAccount

Accessors

activeUtps

  • get activeUtps(): UtpAccount[]

allUtps

  • get allUtps(): UtpAccount[]

authority

  • get authority(): PublicKey

  • Marginfi account authority address

    Returns PublicKey

borrows

  • get borrows(): BigNumber

deposits

  • get deposits(): BigNumber

Methods

[customInspectSymbol]

  • [customInspectSymbol](_depth: number, _inspectOptions: any, _inspect: any): string

  • Parameters

    • _depth: number
    • _inspectOptions: any
    • _inspect: any

    Returns string

Private _updateFromAccountData

canBeLiquidated

  • canBeLiquidated(): boolean

checkBankruptcy

  • checkBankruptcy(): Promise<void>

checkRebalance

  • checkRebalance(): Promise<void>

Private checkRebalanceDeposit

  • checkRebalanceDeposit(): Promise<void>

Private checkRebalanceWithdraw

  • checkRebalanceWithdraw(): Promise<void>

computeBalances

computeMarginRequirement

computeMaxRebalanceDepositAmount

  • computeMaxRebalanceDepositAmount(utp: UtpAccount): BigNumber

computeMaxRebalanceWithdrawAmount

  • computeMaxRebalanceWithdrawAmount(utp: UtpAccount): BigNumber

deposit

  • deposit(amount: UiAmount): Promise<string>

  • Deposit collateral into the marginfi account.

    Parameters

    • amount: UiAmount

      Amount to deposit (mint native unit)

    Returns Promise<string>

    Transaction signature

getObservationAccounts

  • getObservationAccounts(): Promise<AccountMeta[]>

  • Create ordered list of account metas required to observe all active UTPs.

    Returns Promise<AccountMeta[]>

    AccountMeta[] list of account metas

handleBankruptcy

  • handleBankruptcy(): Promise<string>

  • Handle a bankrupt account.

    Returns Promise<string>

    Transaction signature

isBankrupt

  • isBankrupt(): boolean

isRebalanceWithdrawNeeded

  • isRebalanceWithdrawNeeded(): boolean

isUtpActive

  • isUtpActive(utpIndex: UtpIndex): boolean

liquidate

Private loadGroupAndAccountAi

  • loadGroupAndAccountAi(): Promise<AccountInfo<Buffer>[]>

makeDepositIx

  • makeDepositIx(amount: UiAmount): Promise<TransactionInstruction[]>

  • Create transaction instruction to deposit collateral into the marginfi account.

    Parameters

    • amount: UiAmount

      Amount to deposit (mint native unit)

    Returns Promise<TransactionInstruction[]>

    MarginDepositCollateral transaction instruction

makeHandleBankruptcyIx

makeWithdrawIx

  • makeWithdrawIx(amount: UiAmount): Promise<TransactionInstruction[]>

  • Create transaction instruction to withdraw collateral from the marginfi account.

    Parameters

    • amount: UiAmount

      Amount to withdraw (mint native unit)

    Returns Promise<TransactionInstruction[]>

    MarginWithdrawCollateral transaction instruction

meetsMarginRequirement

observeUtps

  • Refresh and retrieve the health cache for all active UTPs directly from the UTPs.

    Returns Promise<ObservationCache>

    List of health caches for all active UTPs

reload

  • reload(observeUtps?: boolean): Promise<void>

  • Update instance data by fetching and storing the latest on-chain state.

    Parameters

    • observeUtps: boolean = false

    Returns Promise<void>

toString

  • toString(): string

Private utpFromIndex

  • utpFromIndex(utpIndex: UtpIndex): UtpAccount

  • Retrieve the UTP interface instance from its index

    Parameters

    Returns UtpAccount

    UTP interface instance

withdraw

  • withdraw(amount: UiAmount): Promise<string>

  • Withdraw collateral from the marginfi account.

    Parameters

    • amount: UiAmount

      Amount to withdraw (mint native unit)

    Returns Promise<string>

    Transaction signature

Static Private _fetchAccountData

  • Fetch marginfi account data. Check sanity against provided config.

    Parameters

    Returns Promise<MarginfiAccountData>

    Decoded marginfi account data struct

Static Private _packUtpData

Static decode

  • Decode marginfi account data according to the Anchor IDL.

    Parameters

    • encoded: Buffer

      Raw data buffer

    Returns MarginfiAccountData

    Decoded marginfi account data struct

Static encode

  • Decode marginfi account data according to the Anchor IDL.

    Parameters

    Returns Promise<Buffer>

    Raw data buffer

Static fetch

  • MarginfiAccount network factory

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

    Parameters

    • marginfiAccountPk: PublicKey

      Address of the target account

    • client: MarginfiClient

      marginfi client

    Returns Promise<MarginfiAccount>

    MarginfiAccount instance

Static fromAccountData

  • MarginfiAccount local factory (decoded)

    Instantiate a MarginfiAccount according to the provided decoded data. Check sanity against provided config.

    Parameters

    Returns MarginfiAccount

    MarginfiAccount instance

Static fromAccountDataRaw

  • MarginfiAccount local factory (encoded)

    Instantiate a MarginfiAccount according to the provided encoded data. Check sanity against provided config.

    Parameters

    • marginfiAccountPk: PublicKey

      Address of the target account

    • client: MarginfiClient
    • marginfiAccountRawData: Buffer

      Encoded marginfi marginfi account data

    • marginfiGroup: MarginfiGroup

      MarginfiGroup instance

    Returns MarginfiAccount

    MarginfiAccount instance

Generated using TypeDoc