Skip to main content

A Python SDK for interacting with Orion Finance smart contracts

Project description

orion-finance-sdk Github Actions

About

A Python Software Development Kit (SDK) to ease interactions with the Orion Finance protocol and its Vaults. This repository provides tools and utilities for quants and developers to seamlessly integrate with Orion's portfolio management on-chain infrastructure.

For additional information, please refer to the Orion documentation, and the curator section in particular.

Licences

This project is licensed under the MIT License. See the LICENSE file for the full text.

Environment Variables Setup

cp .env.example .env

Visit the Orion Vault Curation guide for more information on how to set up the environment variables.

Installation

curl -LsSf https://astral.sh/uv/install.sh | sh
uv venv
source .venv/bin/activate
uv pip install -e .

or, with make:

make uv-download
make venv
source .venv/bin/activate
make install

Examples of Usage

List available commands

orion --help
orion deploy-vault --help
orion submit-order --help

Deploy a new Transparent Orion vault

orion deploy-vault --vault-type transparent --name "Algorithmic Liquidity Provision & Hedging Agent" --symbol "ALPHA" --fee-type hard_hurdle --performance-fee 100 --management-fee 10

Deploy a new Encrypted Orion vault

orion deploy-vault --vault-type encrypted --name "Quantitative Uncertainty Analysis of Network Topologies" --symbol "QUANT" --fee-type high_water_mark --performance-fee 0 --management-fee 20

Submit an order intent to a vault

# Use off-chain stack to generate an order intent
echo '{"0x5BA134aBc8BA11Cf7868F4Dfb02497A3f1544Eb5": 0.25, "0x490a81a1939762E6AA87C68C346A0be5E21B466c": 0.02, "0x8A359aAfbf0DF440B34bb97445d981C1944CD053": 0.015, "0xbD39EeAd46c3f28EB8309A74641ab9Ef947FFc83": 0.0255, "0x6b2741F97Ea3EA9C5bFeEa33575d1E73c4481010": 0.06, "0x58f7aaE7B2c017F74B7403C9e89537f43B13bE87": 0.40, "0x28345814d210f2FE11C8de03236f0Ba7b603D282": 0.22, "0x484fF4FB5Ca053b47e5e0490C363b5ea38bB2adF": 0.0095}' > order_intent.json

# Submit the order intent to the Orion vault
orion submit-order --order-intent-path order_intent.json

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orion_finance_sdk-0.3.1.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orion_finance_sdk-0.3.1-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file orion_finance_sdk-0.3.1.tar.gz.

File metadata

  • Download URL: orion_finance_sdk-0.3.1.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for orion_finance_sdk-0.3.1.tar.gz
Algorithm Hash digest
SHA256 32fbd7fd0ff6eab8249d760d7c08fae5cc35082314aefc39328c27f52fac49c3
MD5 29c00732a338038abb43108df46eae74
BLAKE2b-256 0e8fde1e2fe537679f48076046482ca859c0cc46e37ef7a07b06e5aeb1608a26

See more details on using hashes here.

File details

Details for the file orion_finance_sdk-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for orion_finance_sdk-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b97f7fc6c5ab58b04798be88ff033b23d4cb41b6050b3fa475d3bfa07de2d293
MD5 bfc47881054dc8381d84e8e4e68b6d23
BLAKE2b-256 38486f3a86c5de11ebf9af24319225f6f3e8a9b2223bd70f8cda8387fcd9103a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page