marginpy package

The Marginfi python SDK.

class MarginfiAccount(marginfi_account_pk: PublicKey, authority: PublicKey, client: MarginfiClient, group: MarginfiGroup, deposit_record: float, borrow_record: float, mango_utp_data: UtpData, zo_utp_data: UtpData)

Bases: object

Entrypoint to interact with the marginfi contract.

mango: UtpMangoAccount
zo: UtpZoAccount
async classmethod fetch(marginfi_account_pk: PublicKey, client: MarginfiClient) → MarginfiAccount

MarginfiAccount network factory.

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

static from_account_data(marginfi_account_pk: PublicKey, client: MarginfiClient, account_data: MarginfiAccountData, marginfi_group: MarginfiGroup) → MarginfiAccount

MarginfiAccount local factory (decoded).

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

static from_account_data_raw(marginfi_account_pk: PublicKey, client: MarginfiClient, data: bytes, marginfi_group: MarginfiGroup) → MarginfiAccount

MarginfiAccount local factory (encoded).

Instantiates a MarginfiGroup according to the provided encoded data. Check sanity against provided config.

property pubkey: PublicKey
property group: MarginfiGroup
property client: MarginfiClient
property observation_cache: dict[marginpy.types.UtpIndex, marginpy.utp.observation.UtpObservation]
property authority: PublicKey
property all_utps: List[UtpAccount]
property active_utps: List[UtpAccount]
property deposits: float
property borrows: float
static decode(encoded: bytes) → MarginfiAccountData

Decodes marginfi account data according to the Anchor IDL.

async static encode(decoded: MarginfiAccountData) → bytes

Encodes marginfi account data according to the Anchor IDL.

async reload(observe_utps=False) → None

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

Parameters

observe_utps (bool, optional) – flag to request UTP observation as well. Defaults to False.

Raises

Exception – mismatch between the expected group address and the one decoded from the account data

async make_deposit_ix(ui_amount: float) → InstructionsWrapper
async deposit(ui_amount: float) → TransactionSignature
async make_withdraw_ix(ui_amount: float) → InstructionsWrapper
async withdraw(ui_amount: float) → TransactionSignature
async make_handle_bankruptcy_ix() → InstructionsWrapper
async handle_bankruptcy() → TransactionSignature
async get_observation_accounts() → List[AccountMeta]

Gets all account metas required for the observation of active UTPs.

async observe_utps() → dict[marginpy.types.UtpIndex, marginpy.utp.observation.UtpObservation]

Observes all active UTPs and cache the result.

async load_group_and_account_ai() → Tuple[AccountInfo, AccountInfo]

Atomically loads underlying marginfi group and account.

Raises

  • Exception – RPC call errors out

  • Exception – group not found

  • Exception – account not found

Returns

ordered account infos for marginfi group and account

Return type

Tuple[AccountInfo, AccountInfo]

compute_balances(equity_type: EquityType = EquityType.INIT_REQ_ADJUSTED) → AccountBalances
compute_margin_requirement(mreq_type: MarginRequirement) → float
get_logger()
class Bank(data: BankData)

Bases: object

Bank struct mirroring on-chain data.

Contains the state of the marginfi group.

scaling_factor_c: float
fixed_fee: float
interest_fee: float
deposit_accumulator: float
borrow_accumulator: float
last_update: datetime
total_deposits_record: float
total_borrows_record: float
mint: PublicKey
vault: PublicKey
vault_authority_pda_bump: int
insurance_vault: PublicKey
insurance_vault_authority_pda_bump: int
fee_vault: PublicKey
fee_vault_authority_pda_bump: int
init_margin_ratio: float
maint_margin_ratio: float
account_deposit_limit: float
lp_deposit_limit: float
compute_native_amount(record_amount: float, side: LendingSide) → float

Converts the provided record amount to its native amount respective to current accumulator.

Raises

Exception – unknown side

compute_record_amount(native_amount: float, side: LendingSide) → float

Converts the provided native amount to its record amount respective to current accumulator.

Raises

Exception – unknown side

compute_margin_ratio(mreq_type: MarginRequirement) → float
class MarginfiClient(config: MarginfiConfig, program: Program, group: MarginfiGroup)

Bases: object

Entrypoint to interact with the marginfi contract.

async classmethod fetch(config: MarginfiConfig, wallet: Wallet, rpc_client: AsyncClient, opts: Optional[TxOpts] = None) → MarginfiClient

MarginfiClient factory.

Fetches 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)

  • rpc_client (AsyncClient) – RPC client

  • opts (types.TxOpts, optional) – Transaction/commitment options. Defaults to DEFAULT_OPTIONS.

Returns

marginfi client

Return type

MarginfiClient

async classmethod from_env(overrides: Optional[Dict[Literal['env', 'connection', 'program_id', 'group_pk'], Any]] = None) → MarginfiClient

MarginfiClient environment factory.

Fetches account data according to the ENV variables provided (falling back to default config when possible), and instantiate the corresponding MarginfiAccount.

Parameters

overrides (Dict[str, Any], optional) – override to environment variables. Defaults to {}.

Returns

marginfi client

Return type

MarginfiClient

property program: Program
property provider: Provider
property group: MarginfiGroup
property config: MarginfiConfig
property program_id: PublicKey
async create_marginfi_account() → Tuple[MarginfiAccount, TransactionSignature]

Creates a new marginfi account under the authority of the user.

Returns

new marginfi account and creation tx signature

Return type

Tuple[MarginfiAccount, TransactionSignature]

async load_own_marginfi_accounts() → List[MarginfiAccount]

Retrieves all marginfi accounts under the authority of the user.

async load_all_marginfi_account_addresses() → List[PublicKey]

Retrieves the addresses of all marginfi accounts in the underlying group.

Raises

Exception – RPC call errors out

async load_all_marginfi_accounts() → List[MarginfiAccount]

Retrieves all marginfi accounts in the underlying group.

async load_marginfi_account(address: Union[str, PublicKey], observe_utps: bool = True) → MarginfiAccount

Retrieves specified marginfi account.

async load_all_program_account_addresses(account_type: AccountType) → List[PublicKey]

Retrieves the addresses of all accounts of the spcified type, owned by the marginfi program.

Raises

Exception – RPC call errors out

async terminate() → None

Cleans up connections.

class MarginfiConfig(environment: Environment, overrides: Dict[str, Any] = {})

Bases: MarginfiDedicatedConfig

marginfi config.

tx_opts: TxOpts
mango: MangoConfig
zo: ZoConfig
class MarginfiGroup(config: MarginfiConfig, program: Program, admin: PublicKey, bank: Bank)

Bases: object

async static fetch(config: MarginfiConfig, program: Program) → MarginfiGroup

MarginfiGroup network factory.

Fetches account data according to the config and instantiate the coxrresponding MarginfiGroup.

static from_account_data(config: MarginfiConfig, program: Program, account_raw: MarginfiGroupData) → MarginfiGroup

MarginfiGroup local factory (decoded).

Instantiate a MarginfiGroup according to the provided decoded data. Checks sanity against provided config.

static from_account_data_raw(config: MarginfiConfig, program: Program, data: bytes) → MarginfiGroup

MarginfiGroup local factory (encoded).

Instantiates a MarginfiGroup according to the provided encoded data. Checks sanity against provided config.

property pubkey: PublicKey
property admin: PublicKey
property bank: Bank
static decode(encoded: bytes) → MarginfiGroupData

Decodes marginfi group data according to the Anchor IDL.

static encode(decoded: MarginfiGroupData) → bytes

Encodes marginfi group data according to the Anchor IDL.

async reload() → None

Updates instance data by loading the latest on-chain state.

async make_update_interest_accumulator_ix() → TransactionInstruction
async update_interest_accumulator() → TransactionSignature
class Environment(value)

Bases: Enum

An enumeration.

LOCALNET = 'localnet'
DEVNET = 'devnet'
MAINNET = 'mainnet'
class UtpIndex(value)

Bases: Enum

An enumeration.

MANGO = 0
ZO = 1
setup_logging(level: Any = 30) → None

Sets up loggers to provide the specified verbose level, and only let through marginpy logs.

Parameters

level (Any, optional) – verbose level. Defaults to logging.INFO.

Subpackages

Submodules