Skip to main content

A Python SDK for analyzing DeFi vault performance and yield metrics

Project description

Yield Analysis SDK

A Python SDK for DeFi vault registration and yield analysis services within the Agent Commerce Protocol (ACP) ecosystem.

🚀 Features

  • ACP Integration: Built-in support for Virtuals ACP (Agent Commerce Protocol)
  • Vault Registration: Complete workflow for registering DeFi vaults in the ACP ecosystem
  • Yield Analysis Service: Vault performance analysis and metrics calculation
  • Multi-chain Support: Ethereum, Arbitrum, Base, Optimism, Polygon, BSC, and more
  • Comprehensive Metrics: APY calculations, volatility analysis, Sharpe ratios, and drawdown tracking
  • Real-time Data: Fetch vault performance from blockchain subgraphs
  • Type Safety: Full Pydantic validation and type hints

📦 Installation

pip install yield_analysis_sdk

🔧 Quick Start

For detailed usage examples, see the examples/ directory:

  • examples/analysis_service.py: Analysis service implementation
    • Note: Do NOT add input/output requirements through the ACP UI when using this SDK setup
    • Flexible data sources: Uses subgraph for price fetching, but alternative data sources can be configured
  • examples/registration.py: Vault registration and job management

Basic Usage

from yield_analysis_sdk import Chain, analyze_yield_with_daily_share_price

# See examples/analysis_service.py for complete implementation

🏗️ ACP Ecosystem Integration

This SDK provides two main services within the ACP ecosystem:

Vault Registration Service

  • Register new DeFi vaults for analysis
  • Validate vault addresses and chain compatibility
  • Manage registration workflow through ACP jobs

Yield Analysis Service

  • Provide vault performance analysis as an ACP service
  • Calculate comprehensive yield metrics
  • Deliver analysis results through ACP job completion

📊 Supported Metrics

  • APY Calculations: 7-day, 30-day, 90-day annualized yields
  • Risk Metrics: Volatility, maximum drawdown, Sharpe ratio
  • Vault Info: Fees, capacity limits
  • Multi-chain: Cross-chain vault comparison

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests
  5. Submit a pull request

📞 Support

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

yield_analysis_sdk-0.3.0.tar.gz (174.7 kB view details)

Uploaded Source

Built Distribution

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

yield_analysis_sdk-0.3.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file yield_analysis_sdk-0.3.0.tar.gz.

File metadata

  • Download URL: yield_analysis_sdk-0.3.0.tar.gz
  • Upload date:
  • Size: 174.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.12

File hashes

Hashes for yield_analysis_sdk-0.3.0.tar.gz
Algorithm Hash digest
SHA256 c9606388a07d15b54cefd34e02ad62c67677e1a9a27ae9314d48e79c7b2b6ca1
MD5 46d11e9d5e5edc9fbf3c8986115be724
BLAKE2b-256 e1de6e1bc7e5d984e39104a5ce9943bc8c4685dbc9ab68db383c78e93a21a47b

See more details on using hashes here.

File details

Details for the file yield_analysis_sdk-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for yield_analysis_sdk-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89a1d1026efa84a3d14d8f8aa5e74d6b6d928c2791038236dbb8447248f72fe5
MD5 4f3a1f5b434097c187a7853033e322e8
BLAKE2b-256 833caf9f5267c7a40b02500e71a4a94b51ced3a29d003f439274d19b6b30451b

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