marginpy 0.1.0a0

marginfi Python SDK

marginpy

◼️ The marginfi Python SDK ◼️

marginpy is the python library for interacting with marginfi, the decentralized portfolio margin protocol on Solana.

🏎 Quickstart

Installation

pip install marginpy

:warning: If you are using M1: marginpy is not currently available natively on M1, and only availble through Rosetta which impacts performance. The easiest way to work with the marginpy library is to make sure you are working out of an x86_64 terminal/editor, including the installation step.

General Usage

import marginpy

Check out the examples for more details.

👷‍♀️ Development

Setup local development environment

1. Spare yourself some pain and setup your default python command to point to 3.10+

2. Install poetry: $ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -

3. Install nox-poetry: $ pip install nox-poetry

4. Initialize Python 3.10 virtual environment: $ poetry env use 3.10

5. Install project dependencies: $ poetry install

6. Activate virtual environment: $ poetry shell

7. Build the rust crate and install it locally: $ maturin develop

Running tests

As of writing, only a small subset of tests can be run by the user, due to initially private dependencies. They can be run like so:

1. Activate virtual environment:

$ poetry shell

2. Run desired task:
   • unit tests only: $ make test-unit
   • type check + lint: $ make lint

Feel free to check the Makefile for other available actions.