Feat: Update docs

- 重构文档结构 - 更新文档内容 - 制定roadmap - 提供中/EN 双语文档
2026-06-04 09:58:22 +08:00 · 2025-11-01 15:05:24 -04:00
parent ba35d29eee
commit fcacfbd79d
36 changed files with 5756 additions and 1149 deletions
@@ -0,0 +1,145 @@
+# 🚀 [BOUNTY] Integrate Hyperliquid Exchange Support
+
+## 💰 Bounty Reward
+**To be discussed** - Open to proposals from contributors
+
+## 📋 Overview
+We're looking for contributors to add Hyperliquid exchange support to NOFX AI Trading System. Currently supports Binance Futures, seeking to expand to Hyperliquid perpetual contracts.
+
+## 🎯 Task Requirements
+
+### Core Features to Implement
+
+#### 1. **Hyperliquid API Integration**
+- [ ] Account management (balance, positions, margin)
+- [ ] Market data fetching (K-lines, order book, trades)
+- [ ] Order execution (market/limit orders)
+- [ ] Position management (open, close, modify)
+- [ ] Websocket real-time data stream
+
+#### 2. **Adapter Layer**
+- [ ] Create `trader/hyperliquid_perpetual.go` adapter
+- [ ] Implement unified interface compatible with existing `BinanceFuturesClient`
+- [ ] Handle Hyperliquid-specific features (if any)
+
+#### 3. **Configuration Support**
+```json
+{
+  "traders": [
+    {
+      "id": "hyperliquid_trader",
+      "name": "Hyperliquid AI Trader",
+      "exchange": "hyperliquid",  // NEW
+      "hyperliquid_api_key": "xxx",
+      "hyperliquid_secret_key": "xxx",
+      "ai_model": "deepseek",
+      "initial_balance": 1000.0
+    }
+  ]
+}
+```
+
+#### 4. **Risk Control Adaptation**
+- [ ] Adapt position limits for Hyperliquid specs
+- [ ] Handle leverage rules (may differ from Binance)
+- [ ] Implement liquidation price calculation
+- [ ] Funding rate integration
+
+#### 5. **Testing & Documentation**
+- [ ] Unit tests for API wrapper
+- [ ] Integration tests with testnet
+- [ ] Update README with Hyperliquid setup guide
+- [ ] Add Hyperliquid-specific troubleshooting docs
+
+## 📚 Technical References
+
+**Hyperliquid Resources:**
+- Official Docs: https://hyperliquid.gitbook.io/hyperliquid-docs
+- API Documentation: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api
+- SDK Examples: https://github.com/hyperliquid-dex
+
+**NOFX Architecture:**
+- See `trader/binance_futures.go` as reference implementation
+- Main trading logic: `trader/auto_trader.go`
+- Configuration: `config.json` structure
+
+## 🔧 Implementation Guidelines
+
+### File Structure
+```
+trader/
+├── binance_futures.go     (existing reference)
+├── hyperliquid_perpetual.go  (NEW - to implement)
+└── exchange_interface.go  (NEW - unified interface)
+
+config/
+└── config.go              (UPDATE - add Hyperliquid config)
+```
+
+### Interface to Implement
+```go
+type ExchangeClient interface {
+    // Account
+    GetAccount() (*AccountInfo, error)
+    GetPositions() ([]*Position, error)
+
+    // Market Data
+    GetKlines(symbol, interval string, limit int) ([]*Kline, error)
+    GetTicker(symbol string) (*Ticker, error)
+
+    // Trading
+    CreateOrder(params *OrderParams) (*Order, error)
+    ClosePosition(symbol, side string) error
+
+    // Risk Management
+    SetLeverage(symbol string, leverage int) error
+    GetLiquidationPrice(position *Position) (float64, error)
+}
+```
+
+## ✅ Acceptance Criteria
+
+**Minimum Requirements:**
+- [ ] Can connect to Hyperliquid testnet/mainnet
+- [ ] Fetch real-time account balance and positions
+- [ ] Execute market orders successfully
+- [ ] Close positions correctly
+- [ ] Calculate accurate P/L
+- [ ] No breaking changes to existing Binance integration
+
+**Bonus Points:**
+- [ ] Websocket streaming for real-time data
+- [ ] Support for limit orders and stop-loss/take-profit
+- [ ] Multi-exchange competition mode (Binance vs Hyperliquid)
+- [ ] Performance comparison dashboard
+
+## 📝 How to Contribute
+
+1. **Comment on this issue** to express interest
+2. **Fork the repository** and create a feature branch
+3. **Implement the integration** following guidelines above
+4. **Test thoroughly** on testnet before mainnet
+5. **Submit a Pull Request** with:
+   - Code changes
+   - Tests
+   - Documentation updates
+   - Demo video/screenshots
+
+## 🤝 Support & Questions
+
+- Ask questions in this issue's comments
+- Join our Telegram: [NOFX Developer Community](https://t.me/nofx_dev_community)
+- Reference existing code: `trader/binance_futures.go`
+
+## ⚠️ Important Notes
+
+- **Test on testnet first** - Do NOT test with real funds initially
+- **Maintain backward compatibility** - Existing Binance users should not be affected
+- **Code quality** - Follow existing code style and patterns
+- **Security** - Handle API keys securely, no hardcoded credentials
+
+---
+
+**Ready to contribute?** Comment below or start working and submit a PR!
+
+**Questions?** Feel free to ask in the comments or on Telegram.