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.4.2.tar.gz (175.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.4.2-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yield_analysis_sdk-0.4.2.tar.gz
Algorithm Hash digest
SHA256 1c0fcfe4839a34f116763933af515f7b40d0fa072f35a867c1c826da870bc186
MD5 3664d9b0343f2c705622126f6646491d
BLAKE2b-256 7e616b0bb8382568fabcf1f09431f9c8cb8e0a0f92acfd9e64732dbc600a0696

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for yield_analysis_sdk-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8a5570aeb8c9c080f837fafbf8ccdd397dc1938eb4a81d46f38019e60cb0b489
MD5 b981fd107c82910adeb8817706cd23ad
BLAKE2b-256 49a0db3dc2e366a6e3e1e406501175b54dd0a0d2ba4bf8e80e0b90057c8f4a8c

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