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.

Licence

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

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.2.tar.gz (13.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.2-py3-none-any.whl (96.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: orion_finance_sdk-0.3.2.tar.gz
  • Upload date:
  • Size: 13.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.2.tar.gz
Algorithm Hash digest
SHA256 1c01119ab38c912a36eef2aca3e45a558557ef4a6ade6f9025ad831d8bbaaa56
MD5 75713052934287ae842ac5a861ffd255
BLAKE2b-256 3d20724b881b6eb00ef06f7c27d289c884d9359e48c922db8b405a4a66808f78

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for orion_finance_sdk-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b015844f28441d3f06586ce0607e5af76de869f69c0367cd9c19d35100abac0f
MD5 4bbf705f8d54cd22553040dc011e0079
BLAKE2b-256 cee203a72257263f18266f325290259ab41e39bd67a87623e555ac51ffcf7fbf

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