Fix(readme): modify docoments (#956)

* fix(trader): get peakPnlPct using posKey

* fix(docs): keep readme at the same page

---------

Co-authored-by: zbhan <zbhan@freewheel.tv>
This commit is contained in:
Shui
2025-11-12 21:36:28 -05:00
committed by tangmengqiu
parent 04889aace1
commit 970cfaadf3
6 changed files with 149 additions and 47 deletions

View File

@@ -469,7 +469,6 @@ Reviewers will check:
- [Project Roadmap](docs/roadmap/README.md)
- [Architecture Documentation](docs/architecture/README.md)
- [API Documentation](docs/api/README.md)
- [Deployment Guide](docs/getting-started/docker-deploy.en.md)
---

View File

@@ -31,7 +31,6 @@
- [🧠 AI Self-Learning](#-ai-self-learning-example)
- [📊 Web Interface Features](#-web-interface-features)
- [🎛️ API Endpoints](#-api-endpoints)
- [🔐 Admin Mode (Single-User)](#-admin-mode-single-user)
- [⚠️ Important Risk Warnings](#-important-risk-warnings)
- [🛠️ Common Issues](#-common-issues)
- [📈 Performance Tips](#-performance-optimization-tips)
@@ -245,48 +244,6 @@ NOFX is built with a modern, modular architecture:
---
## 🔐 Admin Mode (Single-User)
For self-hosted or single-tenant setups, NOFX supports a strict admin-only mode that disables public features and requires an admin password for all access.
### How it works
- All API endpoints require a valid JWT when `admin_mode=true`, except:
- `GET /api/health`
- `GET /api/config`
- `POST /api/admin-login`
- Logout invalidates the current token via an in-memory blacklist (sufficient for single instance; use Redis for multi-instance see Notes).
### Quick setup
1) Set flags in `config.json`:
```jsonc
{
// ... other config
"admin_mode": true,
"jwt_secret": "YOUR_JWT_SCR"
}
```
2) Provide required environment variables:
- `NOFX_ADMIN_PASSWORD` — plaintext admin password (only used at startup to derive a bcrypt hash)
Docker Compose example (already wired):
```yaml
services:
nofx:
environment:
- NOFX_ADMIN_PASSWORD=${NOFX_ADMIN_PASSWORD}
```
1) Login flow (admin mode):
- Open the web UI → youll be redirected to the login page
- Enter admin password → the server returns a JWT
- The UI stores the token and authenticates subsequent API calls
### Notes
- Token lifetime: 24h. On logout, tokens are blacklisted in-memory until expiry. For multi-instance deployments, use a shared store (e.g., Redis) to sync the blacklist.
---
## 💰 Register Binance Account (Save on Fees!)
Before using this system, you need a Binance Futures account. **Use our referral link to save on trading fees:**

View File

@@ -350,9 +350,9 @@ docker compose up -d --build
```
**📖 詳細なDockerデプロイガイド、トラブルシューティング、高度な設定について**
- **English**: See [DOCKER_DEPLOY.en.md](DOCKER_DEPLOY.en.md)
- **中文**: 查看 [DOCKER_DEPLOY.md](DOCKER_DEPLOY.md)
- **日本語**: [DOCKER_DEPLOY.ja.md](DOCKER_DEPLOY.ja.md)を参照
- **English**: See [docker-deploy.md](../../getting-started/docker-deploy.en.md)
- **中文**: 查看 [docker-deploy.zh-CN.md](../../getting-started/docker-deploy.zh-CN.md)
- **日本語**: [docker-deploy.md](docker-deploy.md)を参照
---

View File

@@ -145,6 +145,79 @@ NOFX теперь поддерживает **три основные биржи*
---
## ✨ Текущая реализация - Рынки криптовалют
NOFX в настоящее время **полностью работает на криптовалютных рынках** со следующими проверенными возможностями:
### 🏆 Структура конкуренции Multi-Agent
- **Реальная битва AI-агентов**: Торговое соревнование моделей Qwen vs DeepSeek в реальном времени
- **Независимое управление счетами**: Каждый агент ведет отдельные журналы решений и метрики производительности
- **Сравнение производительности в реальном времени**: Отслеживание ROI в реальном времени, статистика винрейта, прямой анализ
- **Цикл самоэволюции**: Агенты учатся на исторической производительности, постоянно совершенствуясь
### 🧠 AI Самообучение и Оптимизация
- **Система исторической обратной связи**: Анализ последних 20 торговых циклов перед каждым решением
- **Интеллектуальный анализ производительности**:
- Определяет лучшие/худшие активы по производительности
- Рассчитывает винрейт, коэффициент прибыли/убытка, среднюю прибыль в реальных USDT
- Избегает повторяющихся ошибок (паттерны последовательных убытков)
- Усиливает успешные стратегии (высокие паттерны винрейта)
- **Динамическая корректировка стратегии**: AI автономно регулирует торговый стиль на основе результатов бэктеста
### 📊 Универсальный слой рыночных данных (Криптореализация)
- **Многотаймфреймовый анализ**: 3-минутные реальные данные + 4-часовые трендовые данные
- **Технические индикаторы**: EMA20/50, MACD, RSI(7/14), ATR
- **Отслеживание открытого интереса**: Анализ настроений рынка, денежных потоков
- **Фильтрация ликвидности**: Автоматическая фильтрация активов с низкой ликвидностью (<15M USD)
- **Поддержка кросс-биржевой торговли**: Binance, Hyperliquid, Aster DEX, единый интерфейс данных
### 🎯 Единая система контроля рисков
- **Лимиты позиций**: Лимиты на актив (Альткоины≤1.5x капитал, BTC/ETH≤10x капитал)
- **Настраиваемое кредитное плечо**: Динамическая настройка от 1x до 50x на основе класса активов и типа счета
- **Управление маржой**: Общее использование≤90%, AI контролирует распределение
- **Принудительное соотношение риск/вознаграждение**: Обязательное соотношение стоп-лосс/тейк-профит ≥1:2
- **Защита от наслоения**: Предотвращает дублирование позиций по одному активу/направлению
### ⚡ Движок исполнения с низкой задержкой
- **Интеграция API множества бирж**: Binance Futures, Hyperliquid DEX, Aster DEX
- **Автоматическая обработка точности**: Интеллектуальное форматирование размера и цены ордера для каждой биржи
- **Приоритетное исполнение**: Сначала закрытие существующих позиций, затем открытие новых
- **Контроль проскальзывания**: Проверка перед исполнением, проверка точности в реальном времени
### 🎨 Профессиональный интерфейс мониторинга
- **Dashboard в стиле Binance**: Профессиональная темная тема с обновлениями в реальном времени
- **Кривые капитала**: Историческое отслеживание стоимости счета (переключение USD/процент)
- **Графики производительности**: Сравнение ROI множества AI-агентов, обновления в реальном времени
- **Полные журналы решений**: Полное рассуждение цепочки мыслей (CoT) для каждой сделки
- **5-секундное обновление данных**: Обновления счета, позиций и P&L в реальном времени
---
## 🔮 Дорожная карта - Расширение универсального рынка
Миссия NOFX - стать **универсальной AI-торговой ОС для всех финансовых рынков**.
**Видение:** Одна архитектура. Одна агентная структура. Все рынки.
**Расширяемые рынки:**
- 📈 **Фондовые рынки**: Акции США, акции Китая, Гонконгские акции
- 📊 **Фьючерсные рынки**: Товарные фьючерсы, индексные фьючерсы
- 🎯 **Опционная торговля**: Опционы на акции, криптоопционы
- 💱 **Рынок Forex**: Основные валютные пары, кросс-пары
**Предстоящие функции:**
- Расширенные возможности AI (GPT-4, Claude 3, Gemini Pro, гибкие шаблоны промптов)
- Интеграция новых бирж (OKX, Bybit, Lighter, EdgeX + CEX/Perp-DEX)
- Рефакторинг структуры проекта (высокая связность, низкая связанность, принципы SOLID)
- Улучшения безопасности (AES-256 шифрование API-ключей, RBAC, улучшенная 2FA)
- Улучшения UX (отзывчивость мобильных устройств, графики TradingView, система оповещений)
📖 **Для детальной дорожной карты и графиков см.:**
- **English:** [Roadmap Documentation](../../roadmap/README.md)
- **中文:** [路线图文档](../../roadmap/README.zh-CN.md)
---
## ✨ Основные возможности
### 🏆 Режим конкуренции нескольких AI

View File

@@ -146,6 +146,79 @@ NOFX тепер підтримує **три основні біржі**: Binance
---
## ✨ Поточна реалізація - Ринки криптовалют
NOFX наразі **повністю працює на криптовалютних ринках** з наступними перевіреними можливостями:
### 🏆 Структура конкуренції Multi-Agent
- **Реальна битва AI-агентів**: Торгове змагання моделей Qwen vs DeepSeek у реальному часі
- **Незалежне управління рахунками**: Кожен агент веде окремі журнали рішень та метрики продуктивності
- **Порівняння продуктивності в реальному часі**: Відстеження ROI в реальному часі, статистика вінрейту, прямий аналіз
- **Цикл самоеволюції**: Агенти вчаться на історичній продуктивності, постійно вдосконалюючись
### 🧠 AI Самонавчання та Оптимізація
- **Система історичного зворотного зв'язку**: Аналіз останніх 20 торгових циклів перед кожним рішенням
- **Інтелектуальний аналіз продуктивності**:
- Визначає кращі/гірші активи за продуктивністю
- Розраховує вінрейт, коефіцієнт прибутку/збитку, середній прибуток у реальних USDT
- Уникає повторюваних помилок (патерни послідовних збитків)
- Посилює успішні стратегії (високі патерни вінрейту)
- **Динамічне коригування стратегії**: AI автономно регулює торговий стиль на основі результатів бектесту
### 📊 Універсальний шар ринкових даних (Криптореалізація)
- **Багатотаймфреймовий аналіз**: 3-хвилинні реальні дані + 4-годинні трендові дані
- **Технічні індикатори**: EMA20/50, MACD, RSI(7/14), ATR
- **Відстеження відкритого інтересу**: Аналіз настроїв ринку, грошових потоків
- **Фільтрація ліквідності**: Автоматична фільтрація активів з низькою ліквідністю (<15M USD)
- **Підтримка крос-біржової торгівлі**: Binance, Hyperliquid, Aster DEX, єдиний інтерфейс даних
### 🎯 Єдина система контролю ризиків
- **Ліміти позицій**: Ліміти на актив (Альткоїни≤1.5x капітал, BTC/ETH≤10x капітал)
- **Налаштоване кредитне плече**: Динамічне налаштування від 1x до 50x на основі класу активів та типу рахунку
- **Управління маржею**: Загальне використання≤90%, AI контролює розподіл
- **Примусове співвідношення ризик/винагорода**: Обов'язкове співвідношення стоп-лосс/тейк-профіт ≥1:2
- **Захист від нашарування**: Запобігає дублюванню позицій по одному активу/напрямку
### ⚡ Рушій виконання з низькою затримкою
- **Інтеграція API множини бірж**: Binance Futures, Hyperliquid DEX, Aster DEX
- **Автоматична обробка точності**: Інтелектуальне форматування розміру та ціни ордера для кожної біржі
- **Пріоритетне виконання**: Спочатку закриття існуючих позицій, потім відкриття нових
- **Контроль прослизання**: Перевірка перед виконанням, перевірка точності в реальному часі
### 🎨 Професійний інтерфейс моніторингу
- **Dashboard у стилі Binance**: Професійна темна тема з оновленнями в реальному часі
- **Криві капіталу**: Історичне відстеження вартості рахунку (перемикання USD/відсоток)
- **Графіки продуктивності**: Порівняння ROI множини AI-агентів, оновлення в реальному часі
- **Повні журнали рішень**: Повне міркування ланцюга думок (CoT) для кожної угоди
- **5-секундне оновлення даних**: Оновлення рахунку, позицій та P&L у реальному часі
---
## 🔮 Дорожня карта - Розширення універсального ринку
Місія NOFX - стати **універсальною AI-торговою ОС для всіх фінансових ринків**.
**Бачення:** Одна архітектура. Одна агентна структура. Всі ринки.
**Розширювані ринки:**
- 📈 **Фондові ринки**: Акції США, акції Китаю, Гонконгські акції
- 📊 **Ф'ючерсні ринки**: Товарні ф'ючерси, індексні ф'ючерси
- 🎯 **Опціонна торгівля**: Опціони на акції, крипто-опціони
- 💱 **Ринок Forex**: Основні валютні пари, крос-пари
**Майбутні функції:**
- Розширені можливості AI (GPT-4, Claude 3, Gemini Pro, гнучкі шаблони промптів)
- Інтеграція нових бірж (OKX, Bybit, Lighter, EdgeX + CEX/Perp-DEX)
- Рефакторинг структури проекту (висока зв'язність, низька зв'язаність, принципи SOLID)
- Поліпшення безпеки (AES-256 шифрування API-ключів, RBAC, покращена 2FA)
- Поліпшення UX (відгук мобільних пристроїв, графіки TradingView, система сповіщень)
📖 **Для детальної дорожньої карти та графіків див.:**
- **English:** [Roadmap Documentation](../../roadmap/README.md)
- **中文:** [路线图文档](../../roadmap/README.zh-CN.md)
---
## ✨ Основні можливості
### 🏆 Режим змагання кількох AI