Official Python SDK for the Algofi Lending Protocol

https://algofi-py-sdk.readthedocs.io/en/latest/index.html

This SDK is useful for developers who want to programatically interact with the Algofi lending protocol.

This SDK is currently under active early development and should not be considered stable.

algofi-py-sdk is not yet released on PYPI. It can be installed directly from this repository with pip:

pip install git+https://github.com/Algofiorg/algofi-py-sdk

To run examples:

1. create an examples/.env file mnemonic=[25 char mnemonic] storage_mnemonic="" (leave empty string, examples/setup.py will set)
2. Fund the account for mnemonic with 20 test ALGO
3. Run python3 examples/setup.py
4. Run examples e.g. examples/add_collateral.py

mint.py

This example shows how to add liquidity to the platform

burn.py

This example shows how to burn bank assets to redeem for underlying liquidity

add_collateral.py

This example shows how to add minted bank assets to collateral

mint_to_collateral.py

This example shows how to add liquidity to the platform collateral

remove_collateral.py

This example shows how to remove bank asset collateral from platform

remove_collateral_underlying.py

This example shows how to remove bank asset collateral from platform to underlying asset

borrow.py

This example shows how to borrow an underlying asset against provided collateral

repay_borrow.py

This example shows how to repay borrowed assets

staking.py

This example shows how to stake and unstake in a staking contract

algofi-py-sdk is licensed under a MIT license except for the exceptions listed below. See the LICENSE file for details.