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.5.5.tar.gz (139.4 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.5.5-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yield_analysis_sdk-0.5.5.tar.gz
  • Upload date:
  • Size: 139.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for yield_analysis_sdk-0.5.5.tar.gz
Algorithm Hash digest
SHA256 c7fa1e7328f620491d61d4a3b509e16e38edadccf77618fd9b1eeb4a6ee89a8d
MD5 871b7e405b4198beb6a7619ded6b537a
BLAKE2b-256 92ab928eabba2c6e6226ed280b2271a049dce4e516e5c24b594e0496accc1669

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for yield_analysis_sdk-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 359c0c05f4555a9ce9f4281d592d55420f48e1206bc9b5d21cb5d235bec39e33
MD5 7b7300b8ad9a86ae5e1774acfad7e53a
BLAKE2b-256 7496f460bf66764a662f91767b0cee8bbb60fa380f2d392aff4cf24e95ceef1c

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