Skip to main content

A Python SDK for interacting with Orion Finance smart contracts

Project description

Orion

codecov Sourcery Github Actions Ape

LinkedIn X Telegram Discord

About

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

Documentation

For comprehensive documentation, including setup guides, API references, and developer resources, visit sdk.orionfinance.ai.

License

This software is distributed under the BSD-3-Clause license. See the LICENSE file for the full text.

Setup for Development

If you're working on the SDK itself:

# Clone the repository
git clone https://github.com/OrionFinanceAI/orion-finance-sdk-py.git
cd orion-finance-sdk-py

# Install dependencies
make uv-download
make venv
source .venv/bin/activate
make install

# Run tests (includes coverage)
make test

# Run code style checks
make codestyle

# Run docstring checks
make docs

Installation from PyPI

For end users, install the latest stable version from PyPI:

pip install orion-finance-sdk-py

Environment Variables Setup

The SDK uses RPC_URL from your .env if set; otherwise it uses a default public RPC. See SDK Installation for optional RPC setup.

Additional variables depend on what you do:

  • Deploy a vault: STRATEGIST_ADDRESS, MANAGER_PRIVATE_KEY
  • Submit orders: ORION_VAULT_ADDRESS, STRATEGIST_PRIVATE_KEY
  • Update strategist / fee model / deposit access: ORION_VAULT_ADDRESS, MANAGER_PRIVATE_KEY

Examples of Usage

The SDK supports transparent Orion vaults: deploy, read state, submit order intents, and manage fees/strategist via the CLI or Python API.

List available commands

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

Deploy a new Orion vault

orion deploy-vault --strategist-address 0x... --name "Algorithmic Liquidity Provision & Hedging Agent" --symbol "ALPHA" --fee-type hard_hurdle --performance-fee 10 --management-fee 1

Submit an order intent to a vault

# Use off-chain stack to generate an order intent
echo '{"0x...": 0.4, "0x...": 0.2, "0x...": 0.15, "0x...": 0.15, "0x...": 0.1}' > order_intent.json

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

Update the strategist address for a vault

orion update-strategist --new-strategist-address 0x...

Update the fee model for a vault

orion update-fee-model --fee-type high_water_mark --performance-fee 5.5 --management-fee 0.1

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_py-1.2.2.tar.gz (2.0 MB 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_py-1.2.2-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file orion_finance_sdk_py-1.2.2.tar.gz.

File metadata

  • Download URL: orion_finance_sdk_py-1.2.2.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for orion_finance_sdk_py-1.2.2.tar.gz
Algorithm Hash digest
SHA256 2fa4ff895cfeb52227b17620fa0f68a8b4b801950bd2f6938d4e7e3fe20c5b0b
MD5 8b5ad368d6dfcba611dab916b3d9bb31
BLAKE2b-256 41fd28b048a5bbcf25ae54112eecada8ba10fd28efd0729076e686a23fa05591

See more details on using hashes here.

File details

Details for the file orion_finance_sdk_py-1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for orion_finance_sdk_py-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f765207bc104bffce2593cf14485a1cac9c9b2c99c1364bca2bd5ac547b6f371
MD5 b50f4082e06217098c318a515489f6bd
BLAKE2b-256 79ff9662234e934193fc272af3b935fec33c43e2071baa62cd231db14ad14552

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