{"id":22695988,"url":"https://github.com/carlton-source/bitcoin_yield_aggregator","last_synced_at":"2025-10-28T01:05:41.072Z","repository":{"id":259587796,"uuid":"878998955","full_name":"carlton-source/bitcoin_yield_aggregator","owner":"carlton-source","description":"A sophisticated yield optimization platform built for BTC-based assets, enabling automated yield farming and portfolio management across multiple DeFi protocols on the Stacks blockchain.","archived":false,"fork":false,"pushed_at":"2024-10-31T19:19:45.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-06T10:04:44.046Z","etag":null,"topics":["blockchain","btc","defi","protocol","smart-contracts"],"latest_commit_sha":null,"homepage":"","language":"Clarity","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/carlton-source.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-26T17:23:42.000Z","updated_at":"2024-10-31T19:19:52.000Z","dependencies_parsed_at":"2024-10-26T18:57:02.255Z","dependency_job_id":"c2d5543a-bf59-483b-ac39-54ab2ac098c0","html_url":"https://github.com/carlton-source/bitcoin_yield_aggregator","commit_stats":null,"previous_names":["carlton-source/bitcoin_yield_aggregator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/carlton-source/bitcoin_yield_aggregator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlton-source%2Fbitcoin_yield_aggregator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlton-source%2Fbitcoin_yield_aggregator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlton-source%2Fbitcoin_yield_aggregator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlton-source%2Fbitcoin_yield_aggregator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/carlton-source","download_url":"https://codeload.github.com/carlton-source/bitcoin_yield_aggregator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carlton-source%2Fbitcoin_yield_aggregator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275583377,"owners_count":25490651,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-17T02:00:09.119Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","btc","defi","protocol","smart-contracts"],"created_at":"2024-12-10T04:13:06.145Z","updated_at":"2025-09-17T10:54:23.492Z","avatar_url":"https://github.com/carlton-source.png","language":"Clarity","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bitcoin Yield Aggregator Smart Contract\n\nA sophisticated yield optimization platform built for BTC-based assets, enabling automated yield farming and portfolio management across multiple DeFi protocols on the Stacks blockchain.\n\n## Overview\n\nThe Bitcoin Yield Aggregator is a smart contract system that automatically maximizes yields for Bitcoin-based assets by dynamically allocating funds across various DeFi protocols. It implements a secure, efficient, and flexible architecture for managing deposits, calculating rewards, and optimizing returns while maintaining strong security guarantees.\n\n## Features\n\n### Core Functionality\n\n- **Multi-Protocol Yield Optimization**: Automatically distributes funds across different protocols based on APY\n- **Dynamic APY Tracking**: Real-time monitoring and adjustment of yield strategies\n- **SIP-010 Token Support**: Compatible with any Bitcoin-based token implementing the SIP-010 standard\n- **Flexible Protocol Management**: Support for adding, updating, and managing multiple yield protocols\n- **Emergency Controls**: Built-in emergency shutdown mechanism for risk management\n\n### Security Features\n\n- **Token Whitelisting**: Only approved tokens can interact with the contract\n- **Deposit Limits**: Configurable minimum and maximum deposit amounts\n- **Owner Controls**: Protected administrative functions\n- **Safe Transfer Mechanisms**: Secure token transfer implementation\n- **Protocol Validation**: Comprehensive validation for all protocol interactions\n\n### Yield Management\n\n- **Automated Rebalancing**: Smart rebalancing of funds across protocols\n- **Weighted APY Calculation**: Sophisticated APY calculations based on protocol allocations\n- **Reward Distribution**: Fair and efficient reward calculation and distribution system\n- **Platform Fee Management**: Configurable platform fees with upper limits\n\n## Technical Architecture\n\n### Constants\n\n```clarity\nERR-NOT-AUTHORIZED (u1000)\nERR-INVALID-AMOUNT (u1001)\nERR-INSUFFICIENT-BALANCE (u1002)\n...\n```\n\n### Data Structures\n\n#### Maps\n\n- **user-deposits**: Tracks user deposit amounts and timestamps\n- **user-rewards**: Manages pending and claimed rewards\n- **protocols**: Stores protocol configurations and status\n- **strategy-allocations**: Manages protocol allocation percentages\n- **whitelisted-tokens**: Tracks approved tokens\n\n#### Variables\n\n- **total-tvl**: Total Value Locked in the contract\n- **platform-fee-rate**: Current platform fee percentage\n- **min-deposit**: Minimum allowed deposit amount\n- **max-deposit**: Maximum allowed deposit amount\n- **emergency-shutdown**: Emergency shutdown status\n\n## Core Functions\n\n### Deposit Management\n\n```clarity\n(define-public (deposit (token-trait \u003csip-010-trait\u003e) (amount uint)))\n(define-public (withdraw (token-trait \u003csip-010-trait\u003e) (amount uint)))\n```\n\n- Handles user deposits and withdrawals\n- Validates token and amount constraints\n- Updates TVL and user balances\n- Triggers protocol rebalancing when needed\n\n### Protocol Management\n\n```clarity\n(define-public (add-protocol (protocol-id uint) (name (string-ascii 64)) (initial-apy uint)))\n(define-public (update-protocol-status (protocol-id uint) (active bool)))\n(define-public (update-protocol-apy (protocol-id uint) (new-apy uint)))\n```\n\n- Manages protocol configurations\n- Updates protocol status and APY\n- Handles protocol allocation strategies\n\n### Reward Distribution\n\n```clarity\n(define-public (claim-rewards (token-trait \u003csip-010-trait\u003e)))\n```\n\n- Calculates user rewards based on deposit amount and time\n- Handles reward distribution\n- Updates reward tracking\n\n## Administrative Functions\n\n### Platform Management\n\n```clarity\n(define-public (set-platform-fee (new-fee uint)))\n(define-public (set-emergency-shutdown (shutdown bool)))\n(define-public (whitelist-token (token principal)))\n```\n\n- Controls platform parameters\n- Manages emergency situations\n- Handles token whitelisting\n\n## Usage Guidelines\n\n### For Users\n\n1. Ensure your tokens are whitelisted\n2. Deposit funds within the min/max limits\n3. Monitor your rewards using the provided getter functions\n4. Claim rewards when desired\n5. Withdraw funds with proper validation\n\n### For Administrators\n\n1. Manage protocol configurations\n2. Monitor and update APY rates\n3. Handle emergency situations\n4. Manage platform fees\n5. Maintain token whitelist\n\n## Error Handling\n\nThe contract implements comprehensive error handling with specific error codes:\n\n- `ERR-NOT-AUTHORIZED (u1000)`: Unauthorized access attempt\n- `ERR-INVALID-AMOUNT (u1001)`: Invalid amount specified\n- `ERR-INSUFFICIENT-BALANCE (u1002)`: Insufficient funds\n- And more...\n\n## Security Considerations\n\n### Best Practices\n\n- Always verify token whitelist status\n- Monitor protocol allocations\n- Regular APY verification\n- Maintain safe deposit limits\n\n### Risk Management\n\n- Emergency shutdown capability\n- Deposit/withdrawal limits\n- Protocol validation\n- Safe transfer mechanisms\n\n## Integration Guide\n\n### Required Interfaces\n\n- SIP-010 Token Interface\n- Protocol-specific interfaces\n\n### Implementation Steps\n\n1. Deploy contract\n2. Configure initial protocols\n3. Set platform parameters\n4. Whitelist tokens\n5. Monitor and maintain\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Contributing\n\nWe welcome contributions from the community. To get started, fork this repository, make your changes, and submit a pull request. For significant changes, please open an issue first to discuss the proposed changes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlton-source%2Fbitcoin_yield_aggregator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarlton-source%2Fbitcoin_yield_aggregator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarlton-source%2Fbitcoin_yield_aggregator/lists"}