| Name | yield-analysis-sdk JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | A Python SDK for analyzing DeFi vault performance and yield metrics |
| upload_time | 2025-07-17 12:47:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
ai
analysis
defi
yield
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```bash
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
```python
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
- **Email**: dev@logarithm.fi
- **Issues**: [GitHub Issues](https://github.com/yourusername/yield-analysis-sdk/issues)
Raw data
{
"_id": null,
"home_page": null,
"name": "yield-analysis-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "AI, analysis, defi, yield",
"author": null,
"author_email": "Tal <talcrypto@logarithm.fi>",
"download_url": "https://files.pythonhosted.org/packages/c4/5c/a6714bc98efefc42677a8bc81d61ea9b3b4ec111700949e8e1f7a19b291c/yield_analysis_sdk-0.3.1.tar.gz",
"platform": null,
"description": "# Yield Analysis SDK\n\nA Python SDK for DeFi vault registration and yield analysis services within the Agent Commerce Protocol (ACP) ecosystem.\n\n## \ud83d\ude80 Features\n\n- **ACP Integration**: Built-in support for Virtuals ACP (Agent Commerce Protocol)\n- **Vault Registration**: Complete workflow for registering DeFi vaults in the ACP ecosystem\n- **Yield Analysis Service**: Vault performance analysis and metrics calculation\n- **Multi-chain Support**: Ethereum, Arbitrum, Base, Optimism, Polygon, BSC, and more\n- **Comprehensive Metrics**: APY calculations, volatility analysis, Sharpe ratios, and drawdown tracking\n- **Real-time Data**: Fetch vault performance from blockchain subgraphs\n- **Type Safety**: Full Pydantic validation and type hints\n\n## \ud83d\udce6 Installation\n\n```bash\npip install yield_analysis_sdk\n```\n\n## \ud83d\udd27 Quick Start\n\nFor detailed usage examples, see the `examples/` directory:\n\n- **`examples/analysis_service.py`**: Analysis service implementation\n - Note: Do NOT add input/output requirements through the ACP UI when using this SDK setup\n - Flexible data sources: Uses subgraph for price fetching, but alternative data sources can be configured\n- **`examples/registration.py`**: Vault registration and job management\n\n### Basic Usage\n\n```python\nfrom yield_analysis_sdk import Chain, analyze_yield_with_daily_share_price\n\n# See examples/analysis_service.py for complete implementation\n```\n\n## \ud83c\udfd7\ufe0f ACP Ecosystem Integration\n\nThis SDK provides two main services within the ACP ecosystem:\n\n### Vault Registration Service\n- Register new DeFi vaults for analysis\n- Validate vault addresses and chain compatibility\n- Manage registration workflow through ACP jobs\n\n### Yield Analysis Service\n- Provide vault performance analysis as an ACP service\n- Calculate comprehensive yield metrics\n- Deliver analysis results through ACP job completion\n\n## \ud83d\udcca Supported Metrics\n\n- **APY Calculations**: 7-day, 30-day, 90-day annualized yields\n- **Risk Metrics**: Volatility, maximum drawdown, Sharpe ratio\n- **Vault Info**: Fees, capacity limits\n- **Multi-chain**: Cross-chain vault comparison\n\n\n## \ud83e\udd1d Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Add tests\n5. Submit a pull request\n\n## \ud83d\udcde Support\n\n- **Email**: dev@logarithm.fi\n- **Issues**: [GitHub Issues](https://github.com/yourusername/yield-analysis-sdk/issues)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python SDK for analyzing DeFi vault performance and yield metrics",
"version": "0.3.1",
"project_urls": {
"Documentation": "https://yield-analysis-sdk.readthedocs.io/",
"Homepage": "https://github.com/Logarithm-Labs/yield-analysis-sdk",
"Issues": "https://github.com/Logarithm-Labs/yield-analysis-sdk/issues",
"Repository": "https://github.com/Logarithm-Labs/yield-analysis-sdk"
},
"split_keywords": [
"ai",
" analysis",
" defi",
" yield"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "186b7557030399c85d8ad8a1d34a805a8d05ab8dcebf3a38bf942220a642d0c2",
"md5": "0db863fb68ae652c464b9b838f3315ed",
"sha256": "eff84af89c814c442132fb8005729e9a5356336acf73b83eb6cd5dd041604d34"
},
"downloads": -1,
"filename": "yield_analysis_sdk-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0db863fb68ae652c464b9b838f3315ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10034,
"upload_time": "2025-07-17T12:47:07",
"upload_time_iso_8601": "2025-07-17T12:47:07.572029Z",
"url": "https://files.pythonhosted.org/packages/18/6b/7557030399c85d8ad8a1d34a805a8d05ab8dcebf3a38bf942220a642d0c2/yield_analysis_sdk-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c45ca6714bc98efefc42677a8bc81d61ea9b3b4ec111700949e8e1f7a19b291c",
"md5": "3e773468cf434050352d1537b015d348",
"sha256": "4732d2ec920b8a5a9ccd9a7a9c4a4d5f355db256a07551dd67931c5fc45e0f31"
},
"downloads": -1,
"filename": "yield_analysis_sdk-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "3e773468cf434050352d1537b015d348",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 174736,
"upload_time": "2025-07-17T12:47:13",
"upload_time_iso_8601": "2025-07-17T12:47:13.066924Z",
"url": "https://files.pythonhosted.org/packages/c4/5c/a6714bc98efefc42677a8bc81d61ea9b3b4ec111700949e8e1f7a19b291c/yield_analysis_sdk-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 12:47:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Logarithm-Labs",
"github_project": "yield-analysis-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "yield-analysis-sdk"
}
