From 96bd41335e31dbd94f837dd5ac63b2a4eee0efaf Mon Sep 17 00:00:00 2001 From: tinkle-community Date: Thu, 30 Oct 2025 21:27:53 +0800 Subject: [PATCH] Docs: Complete exchange configuration documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update configuration documentation across all 4 languages (Chinese, English, Russian, Ukrainian) with comprehensive exchange-related fields: Configuration field table updates: - Add `exchange` field (binance/hyperliquid/aster) - Add `hyperliquid_private_key` field with 0x prefix warning - Add `hyperliquid_wallet_addr` field - Add `hyperliquid_testnet` field (optional, defaults to false) - Update `ai_model` to include "custom" option - Change Binance API key fields to show conditional requirement (only required when using Binance exchange) config.json.example updates: - Add `enabled` field to all trader configurations - Set appropriate enabled states for example traders - Ensure all traders have exchange field properly configured This makes it clear to users which configuration fields are required for each exchange option (Binance, Hyperliquid, or Aster DEX). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: tinkle-community --- README.md | 18 +++++++++++++----- README.ru.md | 18 +++++++++++++----- README.uk.md | 18 +++++++++++++----- README.zh-CN.md | 18 +++++++++++++----- config.json.example | 10 +++++++--- 5 files changed, 59 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index ba9305fa..04073116 100644 --- a/README.md +++ b/README.md @@ -465,9 +465,11 @@ cp config.json.example config.json { "id": "hyperliquid_trader", "name": "My Hyperliquid Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "hyperliquid", "hyperliquid_private_key": "your_private_key_without_0x", + "hyperliquid_wallet_addr": "your_ethereum_address", "hyperliquid_testnet": false, "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, @@ -517,13 +519,14 @@ cp config.json.example config.json { "id": "aster_deepseek", "name": "Aster DeepSeek Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "aster", - + "aster_user": "0x63DD5aCC6b1aa0f563956C0e534DD30B6dcF7C4e", "aster_signer": "0x21cF8Ae13Bb72632562c6Fff438652Ba1a151bb0", "aster_private_key": "4fd0a42218f3eae43a6ce26d22544e986139a01e5b34a62db53757ffca81bae1", - + "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, "scan_interval_minutes": 3 @@ -605,9 +608,14 @@ For running multiple AI traders competing against each other: |-------|-------------|---------------|-----------| | `id` | Unique identifier for this trader | `"my_trader"` | ✅ Yes | | `name` | Display name | `"My AI Trader"` | ✅ Yes | -| `ai_model` | AI provider to use | `"deepseek"` or `"qwen"` | ✅ Yes | -| `binance_api_key` | Binance API key | `"abc123..."` | ✅ Yes | -| `binance_secret_key` | Binance Secret key | `"xyz789..."` | ✅ Yes | +| `enabled` | Whether this trader is enabled
Set to `false` to skip startup | `true` or `false` | ✅ Yes | +| `ai_model` | AI provider to use | `"deepseek"` or `"qwen"` or `"custom"` | ✅ Yes | +| `exchange` | Exchange to use | `"binance"` or `"hyperliquid"` or `"aster"` | ✅ Yes | +| `binance_api_key` | Binance API key | `"abc123..."` | Required when using Binance | +| `binance_secret_key` | Binance Secret key | `"xyz789..."` | Required when using Binance | +| `hyperliquid_private_key` | Hyperliquid private key
⚠️ Remove `0x` prefix | `"your_key..."` | Required when using Hyperliquid | +| `hyperliquid_wallet_addr` | Hyperliquid wallet address | `"0xabc..."` | Required when using Hyperliquid | +| `hyperliquid_testnet` | Use testnet | `true` or `false` | ❌ No (defaults to false) | | `use_qwen` | Whether to use Qwen | `true` or `false` | ✅ Yes | | `deepseek_key` | DeepSeek API key | `"sk-xxx"` | If using DeepSeek | | `qwen_key` | Qwen API key | `"sk-xxx"` | If using Qwen | diff --git a/README.ru.md b/README.ru.md index 51d8054a..4761e106 100644 --- a/README.ru.md +++ b/README.ru.md @@ -398,9 +398,11 @@ cp config.json.example config.json { "id": "hyperliquid_trader", "name": "My Hyperliquid Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "hyperliquid", "hyperliquid_private_key": "your_private_key_without_0x", + "hyperliquid_wallet_addr": "your_ethereum_address", "hyperliquid_testnet": false, "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, @@ -450,13 +452,14 @@ cp config.json.example config.json { "id": "aster_deepseek", "name": "Aster DeepSeek Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "aster", - + "aster_user": "0x63DD5aCC6b1aa0f563956C0e534DD30B6dcF7C4e", "aster_signer": "0x21cF8Ae13Bb72632562c6Fff438652Ba1a151bb0", "aster_private_key": "4fd0a42218f3eae43a6ce26d22544e986139a01e5b34a62db53757ffca81bae1", - + "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, "scan_interval_minutes": 3 @@ -536,9 +539,14 @@ cp config.json.example config.json |------|----------|-----------------|--------------| | `id` | Уникальный идентификатор для этого трейдера | `"my_trader"` | ✅ Да | | `name` | Отображаемое имя | `"Мой AI Трейдер"` | ✅ Да | -| `ai_model` | Используемый AI провайдер | `"deepseek"` или `"qwen"` | ✅ Да | -| `binance_api_key` | Binance API ключ | `"abc123..."` | ✅ Да | -| `binance_secret_key` | Binance Secret ключ | `"xyz789..."` | ✅ Да | +| `enabled` | Включен ли этот трейдер
Установите в `false` для пропуска запуска | `true` или `false` | ✅ Да | +| `ai_model` | Используемый AI провайдер | `"deepseek"` или `"qwen"` или `"custom"` | ✅ Да | +| `exchange` | Используемая биржа | `"binance"` или `"hyperliquid"` или `"aster"` | ✅ Да | +| `binance_api_key` | Binance API ключ | `"abc123..."` | Требуется при использовании Binance | +| `binance_secret_key` | Binance Secret ключ | `"xyz789..."` | Требуется при использовании Binance | +| `hyperliquid_private_key` | Hyperliquid приватный ключ
⚠️ Удалите префикс `0x` | `"your_key..."` | Требуется при использовании Hyperliquid | +| `hyperliquid_wallet_addr` | Hyperliquid адрес кошелька | `"0xabc..."` | Требуется при использовании Hyperliquid | +| `hyperliquid_testnet` | Использовать тестнет | `true` или `false` | ❌ Нет (по умолчанию false) | | `use_qwen` | Использовать ли Qwen | `true` или `false` | ✅ Да | | `deepseek_key` | DeepSeek API ключ | `"sk-xxx"` | Требуется при использовании DeepSeek | | `qwen_key` | Qwen API ключ | `"sk-xxx"` | Требуется при использовании Qwen | diff --git a/README.uk.md b/README.uk.md index d47c5921..55ef2584 100644 --- a/README.uk.md +++ b/README.uk.md @@ -398,9 +398,11 @@ cp config.json.example config.json { "id": "hyperliquid_trader", "name": "My Hyperliquid Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "hyperliquid", "hyperliquid_private_key": "your_private_key_without_0x", + "hyperliquid_wallet_addr": "your_ethereum_address", "hyperliquid_testnet": false, "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, @@ -450,13 +452,14 @@ cp config.json.example config.json { "id": "aster_deepseek", "name": "Aster DeepSeek Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "aster", - + "aster_user": "0x63DD5aCC6b1aa0f563956C0e534DD30B6dcF7C4e", "aster_signer": "0x21cF8Ae13Bb72632562c6Fff438652Ba1a151bb0", "aster_private_key": "4fd0a42218f3eae43a6ce26d22544e986139a01e5b34a62db53757ffca81bae1", - + "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, "scan_interval_minutes": 3 @@ -536,9 +539,14 @@ cp config.json.example config.json |------|------|------------------|--------------| | `id` | Унікальний ідентифікатор для цього трейдера | `"my_trader"` | ✅ Так | | `name` | Відображуване ім'я | `"Мій AI Трейдер"` | ✅ Так | -| `ai_model` | Використовуваний AI провайдер | `"deepseek"` або `"qwen"` | ✅ Так | -| `binance_api_key` | Binance API ключ | `"abc123..."` | ✅ Так | -| `binance_secret_key` | Binance Secret ключ | `"xyz789..."` | ✅ Так | +| `enabled` | Чи увімкнений цей трейдер
Встановіть в `false` для пропуску запуску | `true` або `false` | ✅ Так | +| `ai_model` | Використовуваний AI провайдер | `"deepseek"` або `"qwen"` або `"custom"` | ✅ Так | +| `exchange` | Використовувана біржа | `"binance"` або `"hyperliquid"` або `"aster"` | ✅ Так | +| `binance_api_key` | Binance API ключ | `"abc123..."` | Потрібно при використанні Binance | +| `binance_secret_key` | Binance Secret ключ | `"xyz789..."` | Потрібно при використанні Binance | +| `hyperliquid_private_key` | Hyperliquid приватний ключ
⚠️ Видаліть префікс `0x` | `"your_key..."` | Потрібно при використанні Hyperliquid | +| `hyperliquid_wallet_addr` | Hyperliquid адреса гаманця | `"0xabc..."` | Потрібно при використанні Hyperliquid | +| `hyperliquid_testnet` | Використовувати тестнет | `true` або `false` | ❌ Ні (за замовчуванням false) | | `use_qwen` | Використовувати чи Qwen | `true` або `false` | ✅ Так | | `deepseek_key` | DeepSeek API ключ | `"sk-xxx"` | Потрібно при використанні DeepSeek | | `qwen_key` | Qwen API ключ | `"sk-xxx"` | Потрібно при використанні Qwen | diff --git a/README.zh-CN.md b/README.zh-CN.md index 9b47fa04..dbdb2df9 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -461,9 +461,11 @@ cp config.json.example config.json { "id": "hyperliquid_trader", "name": "My Hyperliquid Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "hyperliquid", "hyperliquid_private_key": "your_private_key_without_0x", + "hyperliquid_wallet_addr": "your_ethereum_address", "hyperliquid_testnet": false, "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, @@ -513,13 +515,14 @@ cp config.json.example config.json { "id": "aster_deepseek", "name": "Aster DeepSeek Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "aster", - + "aster_user": "0x63DD5aCC6b1aa0f563956C0e534DD30B6dcF7C4e", "aster_signer": "0x21cF8Ae13Bb72632562c6Fff438652Ba1a151bb0", "aster_private_key": "4fd0a42218f3eae43a6ce26d22544e986139a01e5b34a62db53757ffca81bae1", - + "deepseek_key": "sk-xxxxxxxxxxxxx", "initial_balance": 1000.0, "scan_interval_minutes": 3 @@ -599,9 +602,14 @@ cp config.json.example config.json |-----|------|--------|-----------| | `id` | 此trader的唯一标识符 | `"my_trader"` | ✅ 是 | | `name` | 显示名称 | `"我的AI交易员"` | ✅ 是 | -| `ai_model` | 使用的AI提供商 | `"deepseek"` 或 `"qwen"` | ✅ 是 | -| `binance_api_key` | 币安API密钥 | `"abc123..."` | ✅ 是 | -| `binance_secret_key` | 币安Secret密钥 | `"xyz789..."` | ✅ 是 | +| `enabled` | 是否启用此trader
设为`false`可跳过启动 | `true` 或 `false` | ✅ 是 | +| `ai_model` | 使用的AI提供商 | `"deepseek"` 或 `"qwen"` 或 `"custom"` | ✅ 是 | +| `exchange` | 使用的交易所 | `"binance"` 或 `"hyperliquid"` 或 `"aster"` | ✅ 是 | +| `binance_api_key` | 币安API密钥 | `"abc123..."` | 使用Binance时必填 | +| `binance_secret_key` | 币安Secret密钥 | `"xyz789..."` | 使用Binance时必填 | +| `hyperliquid_private_key` | Hyperliquid私钥
⚠️ 去掉`0x`前缀 | `"your_key..."` | 使用Hyperliquid时必填 | +| `hyperliquid_wallet_addr` | Hyperliquid钱包地址 | `"0xabc..."` | 使用Hyperliquid时必填 | +| `hyperliquid_testnet` | 是否使用测试网 | `true` 或 `false` | ❌ 否（默认false） | | `use_qwen` | 是否使用Qwen | `true` 或 `false` | ✅ 是 | | `deepseek_key` | DeepSeek API密钥 | `"sk-xxx"` | 使用DeepSeek时必填 | | `qwen_key` | Qwen API密钥 | `"sk-xxx"` | 使用Qwen时必填 | diff --git a/config.json.example b/config.json.example index 8f41523e..1dfc1786 100644 --- a/config.json.example +++ b/config.json.example @@ -3,6 +3,7 @@ { "id": "hyperliquid_deepseek", "name": "Hyperliquid DeepSeek Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "hyperliquid", "hyperliquid_private_key": "your_ethereum_private_key_without_0x_prefix", @@ -15,6 +16,7 @@ { "id": "binance_qwen", "name": "Binance Qwen Trader", + "enabled": true, "ai_model": "qwen", "exchange": "binance", "binance_api_key": "your_binance_api_key", @@ -26,6 +28,7 @@ { "id": "binance_custom", "name": "Binance Custom API Trader", + "enabled": false, "ai_model": "custom", "exchange": "binance", "binance_api_key": "your_binance_api_key", @@ -35,10 +38,11 @@ "custom_model_name": "gpt-4o", "initial_balance": 1000, "scan_interval_minutes": 3 - }， + }, { "id": "aster_deepseek", "name": "Aster DeepSeek Trader", + "enabled": true, "ai_model": "deepseek", "exchange": "aster", @@ -47,7 +51,7 @@ // signer: API钱包地址 (点击生成地址后生成的地址) // privateKey: API钱包私钥 (生成地址对应的私钥) - "aster_user": "0x63DD5aCC6b1aa0f563956C0e534DD30B6dcF7C4e", + "aster_user": "0x63DD5aCC6b1aa0f563956C0e534DD30B6dcF7C4e", "aster_signer": "0x21cF8Ae13Bb72632562c6Fff438652Ba1a151bb0", "aster_private_key": "your_aster_api_wallet_private_key_without_0x_prefix", @@ -69,7 +73,7 @@ "XRPUSDT", "DOGEUSDT", "ADAUSDT", - "HYPEUSDT", + "HYPEUSDT" ], "coin_pool_api_url": "", "oi_top_api_url": "",