Commit Graph

65 Commits

Author SHA1 Message Date
tinkle-community
33dce4edcc update Korean README docs 2025-11-23 21:58:50 +08:00
tinkle-community
52fb1c902c update docs 2025-11-23 21:13:27 +08:00
tinkle-community
c258abb292 update docs 2025-11-23 21:10:37 +08:00
Liu
abfe366720 Update README.md (#1087) 2025-11-21 07:12:41 +08:00
tinkle-community
20aa054bf3 update readme 2025-11-15 22:20:06 -05:00
Lawrence Liu
34cb7b1bbd Revert "fix(api): market/combined_streams: Get Proxy form Environment (#879)" (#985)
This reverts commit 183e9273b8.
2025-11-15 22:20:06 -05:00
Dongyan Qian
e0af0d96e0 fix(api): market/combined_streams: Get Proxy form Environment (#879)
* fix(api): market/combined_streams: Get Proxy form Environment

issues:
 批量订阅流失败: 组合流WebSocket连接失败: dial tcp xxxxxx:443: i/o timeout

Make environment variables effective for
dialer.Dial("wss://fstream.binance.com/stream", nil):

export HTTPS_PROXY=http://ip:port
export HTTP_PROXY=http://ip:port

Signed-off-by: MarsDoge <mars@dogexorg.com>

* docs(WebSocket): add proxy usage guidance for combined streams (#475)

Signed-off-by: MarsDoge <mars@dogexorg.com>

---------

Signed-off-by: MarsDoge <mars@dogexorg.com>
2025-11-15 22:20:06 -05:00
tinkle-community
9fc1870f5f update readme 2025-11-15 22:20:06 -05:00
Shui
970cfaadf3 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>
2025-11-15 22:20:06 -05:00
tinkle-community
f8d1cbb670 update readme 2025-11-15 22:17:11 -05:00
Icy
190b0c29d4 merge dev 2025-11-12 23:40:58 +08:00
tinkle-community
dc678a27bc Feat/hyperliquid agent wallet docs (#936)
* feat(docs): add Hyperliquid Agent Wallet tutorial for all languages

- Add comprehensive Hyperliquid Agent Wallet setup guide with referral link
- Update all 5 language versions (EN, ZH, JA, RU, UK)
- Remove "Alternative" prefix from Hyperliquid and Aster DEX section titles
- Remove direct wallet method, only recommend secure Agent Wallet approach
- Include step-by-step registration, funding, and agent wallet creation
- Add security warnings and best practices for all languages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>

* feat(docs): add Hyperliquid and Aster DEX to Table of Contents in all languages

- Add navigation links for Hyperliquid and Aster DEX registration in all 5 README versions
- Ensure all three exchanges (Binance, Hyperliquid, Aster) have equal visibility in TOC
- Add complete TOC structure to Japanese README (was missing before)
- Maintain consistency across English, Chinese, Japanese, Russian, and Ukrainian versions

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>

---------

Co-authored-by: tinkle <tinkle@tinkle.community>
Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-12 19:05:04 +08:00
tinkle-community
7ea46421c6 feat(docs): add Hyperliquid Agent Wallet tutorial for all languages (#935)
- Add comprehensive Hyperliquid Agent Wallet setup guide with referral link
- Update all 5 language versions (EN, ZH, JA, RU, UK)
- Remove "Alternative" prefix from Hyperliquid and Aster DEX section titles
- Remove direct wallet method, only recommend secure Agent Wallet approach
- Include step-by-step registration, funding, and agent wallet creation
- Add security warnings and best practices for all languages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: tinkle <tinkle@tinkle.community>
Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-12 18:29:37 +08:00
CoderMageFox
e0535d8889 docs(prompt): add comprehensive prompt writing guide (#837)
* docs: 添加 Prompt 编写指南并更新 README 导航

为 NoFx 系统创建完整的 Prompt 编写指南文档,帮助用户编写高质量的自定义 AI 交易策略提示词。

主要内容:
- 📚 快速开始指南(5分钟上手)
- 💡 核心概念和工作原理
- 📋 完整的可用字段参考(系统状态、账户信息、持仓信息等)
- ⚖️ 系统约束和规则说明
- 📦 三种官方策略模板(保守型/平衡型/激进型)
-  质量检查清单(20+ 检查项)
-  10个常见错误案例和最佳实践
- 🎓 高级话题(完全自定义、调试指南)

文档特点:
- 基于实际代码(decision/engine.go)确保字段准确性
- 三层用户分级(新手/进阶/高级)
- 完整的策略模板即拿即用
-  对比示例避免常见错误
- 20,000+ 字完整覆盖所有关键知识点

同时更新 README.md 添加文档导航链接,方便用户快速访问。

Fixes #654

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>

* docs(prompt): add i18n support with complete English translation

完善 Prompt 编写指南的国际化支持,添加完整的英文翻译版本。

主要更改:
- 📝 新增英文版本:docs/prompt-guide.md
- 🇨🇳 中文版本重命名:docs/prompt-guide.zh-CN.md
- 🔗 更新 README.md 文档链接,标注语言选项

文档特点:
- 完整翻译所有章节(20,000+ 字)
- 保持中英文结构完全一致
- 遵循项目 i18n 惯例(参考 docs/guides/)
- 便于不同语言用户使用

Related to #654

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>

---------

Co-authored-by: tinkle-community <tinklefund@gmail.com>
2025-11-10 11:44:17 +08:00
Burt
fce3441aff Fix: 提示词, 竞赛数据接口在管理员模式下转为公开 (#607)
* 提示词, 竞赛数据接口在管理员模式下转为公开

* Fix "go vet" error
2025-11-06 20:42:43 +08:00
icy
706c719248 chore: move shell scripts under scripts/ and update docs 2025-11-06 17:53:27 +08:00
icy
65053518d6 feat: implement hybrid database architecture and frontend encryption
- Add PostgreSQL + SQLite hybrid database support with automatic switching
- Implement frontend AES-GCM + RSA-OAEP encryption for sensitive data
- Add comprehensive DatabaseInterface with all required methods
- Fix compilation issues with interface consistency
- Update all database method signatures to use DatabaseInterface
- Add missing UpdateTraderInitialBalance method to PostgreSQL implementation
- Integrate RSA public key distribution via /api/config endpoint
- Add frontend crypto service with proper error handling
- Support graceful degradation between encrypted and plaintext transmission
- Add directory creation for RSA keys and PEM parsing fixes
- Test both SQLite and PostgreSQL modes successfully

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-06 01:50:06 +08:00
SkywalkerJi
aebdf120b0 fix: Fix README link (#563)
* Resolved front-end linting issues.

* Streamlining Docker Build Scripts

* Leveraging Native ARM64 Runners on GitHub.

* Use lowercase framework names.

* Streamlining dependencies within the README.
2025-11-06 00:31:05 +08:00
Burt
5f98e09920 Feat: Enable admin password in admin mode (#540)
* WIP: save local changes before merging

* Enable admin password in admin mode #374
2025-11-05 21:48:28 +08:00
liangjiahao
186908ff4e docs: config.example.jsonc替换成config.json.example 2025-11-05 09:24:38 +08:00
zbhan
0fb9fa8a2e fix(readme): update readme and pr reviewer 2025-11-03 20:50:56 -05:00
Luna Martinez
26a170935a Merge pull request #226 from xqliu/docs/enhance-bug-report-template
docs: Enhance bug report template and add troubleshooting guide
2025-11-02 21:08:32 -05:00
tinkle-community
0eba15deda docs: Replace sensitive configuration examples with placeholders
Update documentation to use placeholder values instead of real credentials
in example configurations for enhanced security.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-03 03:47:41 +08:00
tinkle-community
13e90118d4 update aster exchange guide 2025-11-02 12:23:33 +08:00
tinkle-community
90f40055d0 update aster exchange guide 2025-11-02 12:15:40 +08:00
Xeron
4210656856 Fix broken DashScope link in README files (fixes #128) 2025-11-02 10:56:24 +08:00
Liu Xiang Qian
b27bad4d74 docs: Enhance bug report template and add comprehensive troubleshooting guide
- Enhanced bug report template with detailed log capture instructions
  - Added bug categorization system (6 main categories)
  - Frontend error capture guide (DevTools Console/Network tabs)
  - Backend log capture for Docker and PM2 deployments
  - Trading/decision logs location and usage
  - Comprehensive environment information checklist
  - Quick diagnostic tips for faster issue resolution

- Created bilingual troubleshooting guides (EN/ZH)
  - Common trading issues (e.g., Issue #202: only short positions)
  - Detailed explanation of Binance position mode requirements
  - AI decision problems and diagnostics
  - Connection and API error solutions
  - Frontend and database issues
  - Complete log capture instructions with commands
  - Emergency reset procedures

- Updated documentation cross-references
  - Added troubleshooting guide links to bug report template
  - Added links in README Common Issues section
  - Bilingual support for better accessibility

This reduces maintainer workload by helping users self-diagnose issues
and submit higher-quality bug reports with all necessary information.

Addresses Issue #202 root cause documentation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 10:19:19 +08:00
zbhan
2351bb95c3 Feat: Update docs
- 重构文档结构
- 更新文档内容
- 制定roadmap
- 提供中/EN 双语文档
2025-11-01 15:05:24 -04:00
icy
a404725379 Resolve merge conflicts in AITradersPage.tsx
- Fixed import statement conflict (using 'type Language')
- Merged exchange configuration logic preserving support for multiple exchange types
- Kept comprehensive form handling for Binance, Hyperliquid, Aster, and OKX exchanges
- Updated security warning messages to use proper translation keys

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-01 19:01:44 +08:00
icy
7674ce1da7 Fixed health check; Fixed dex config; Add rank trader info view; 2025-11-01 18:58:32 +08:00
tinkle-community
ec94e49355 merge main fix Conflict 2025-11-01 13:14:22 +08:00
nobody
6b54dfb979 Simplify team intro and clarify contact channels
- Remove job descriptions, keep only names and Twitter handles
- Investment: DM Tinkle or Zack
- Partnerships: DM official Twitter @nofx_ai
2025-11-01 11:28:11 +08:00
nobody
e27eaa1325 Add official Twitter account @nofx_ai to all READMEs 2025-11-01 10:53:58 +08:00
nobody
4993a9df1e Update README: Add Zack's Twitter handle and refine team/funding info 2025-11-01 10:41:37 +08:00
nobody
3414f874d2 Update README.md 2025-11-01 10:30:24 +08:00
icy
46bf41b3f6 Restore config.json.example 2025-10-31 14:09:28 +08:00
icy
8bf37a09e5 Discard config settings in MD 2025-10-31 13:28:06 +08:00
d0lwl0b
720f24fecf fix(config): rename config example to .jsonc and update all references 2025-10-31 11:51:17 +08:00
icy
87d163340a Merge branch 'main' of github.com:Icyoung/nofx
# Conflicts:
#	config.json.example
#	config/config.go
#	main.go
#	trader/auto_trader.go
#	web/src/App.tsx
#	web/src/components/CompetitionPage.tsx
2025-10-31 03:59:58 +08:00
tinkle-community
96bd41335e Docs: Complete exchange configuration documentation
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 <tinklefund@gmail.com>
2025-10-30 21:27:53 +08:00
icy
a2cded592b Merge remote tracking branch into local development
- Resolved conflicts in README.md: Combined web-based config updates with multi-exchange support
- Resolved conflicts in main.go: Fixed database initialization and default coin settings
- Resolved conflicts in manager/trader_manager.go: Updated trader management for new database structure
- Resolved conflicts in web/src/App.tsx: Combined UI improvements with responsive design
- Resolved conflicts in web/.dockerignore: Merged dependency exclusions
- Removed deprecated files: Dockerfile, config/config.go, web/Dockerfile, ComparisonChart.tsx, CompetitionPage.tsx

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-10-30 20:57:57 +08:00
icy
c64727ffd0 sync fork 2025-10-30 20:51:22 +08:00
d0lwl0b
6a565e5ffa docs: update Docker Compose documentation to V2 syntax 2025-10-30 12:26:00 +08:00
tinkle-community
b40c6d859a Docs: Add screenshots section to all README files
Add professional UI screenshots to demonstrate the trading platform:
- Competition mode: Multi-AI leaderboard with real-time performance charts
- Trader details: Complete dashboard with equity curves and decision logs

Screenshots added to all language versions:
- README.md (English)
- README.zh-CN.md (Chinese)
- README.ru.md (Russian)
- README.uk.md (Ukrainian)

Images organized in screenshots/ directory with descriptive filenames:
- competition-page.png (AI battle interface)
- details-page.png (trader dashboard)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-10-30 01:42:38 +08:00
nobody
6281166403 feat: Add Aster DEX exchange support + fix precision issues
## Features
- Add full Aster DEX integration with Binance-compatible API
- Support Web3 authentication with API wallet system
- Add comprehensive Aster integration guide (ASTER_INTEGRATION.md)
- Add example Aster configuration (config.aster.example.json)

## Bug Fixes
- Fix precision error (code -1111) for all order types
- Implement proper float-to-string conversion with exchange precision
- Add automatic precision fetching from /exchangeInfo endpoint
- Remove trailing zeros from formatted values

## Documentation
- Update README.md with Aster quick start guide
- Add detailed setup instructions for creating API wallet
- Include troubleshooting FAQ and security best practices
- Update core features to mention three supported exchanges

## Technical Details
- Added formatFloatWithPrecision() helper function
- Updated all order functions to use proper precision formatting
- Added precision logging for debugging
- Fully backward compatible with existing configurations

Closes #[issue number if applicable]
2025-10-30 00:27:33 +08:00
PorunC
7bd783f25c Merge upstream/main: Integrate Hyperliquid support with leverage config
Resolved conflicts in manager/trader_manager.go by combining:
- Upstream: Exchange field, Hyperliquid API keys, Hyperliquid testnet
- Local: BTCETHLeverage and AltcoinLeverage fields

Both features are now working together.
2025-10-29 21:01:05 +08:00
PorunC
94696d64bd Docs: Add comprehensive leverage configuration guide (v2.0.3)
- Document new configurable leverage feature in Risk Management section
- Add detailed leverage configuration section with examples
- Explain Binance subaccount restrictions (≤5x leverage)
- Provide recommended settings for different account types and risk levels
- Add leverage fields to configuration table
- Include warnings and best practices

Key documentation updates:
- Clear distinction between subaccount (≤5x) and main account limits
- Example configurations for safe, medium, high, and maximum risk levels
- Explanation of how AI uses leverage within configured limits
- Updated default values from fixed 20x/50x to configurable 5x

This documentation helps users safely configure leverage based on their account type.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-10-29 20:30:30 +08:00
nobody
896fc2ed3a feat: Add Hyperliquid exchange support with unified trader interface
Major changes:
- Add full Hyperliquid trading support (long/short, leverage, SL/TP)
- Create unified Trader interface for multi-exchange support
- Implement automatic precision handling for orders and prices
- Fix balance calculation and unrealized P&L display
- Add comprehensive configuration guide in README

New features:
- Support for both Binance and Hyperliquid exchanges
- Automatic order size precision based on szDecimals
- Price formatting with 5 significant figures
- Non-custodial trading with Ethereum private key
- Seamless exchange switching via configuration

Technical details:
- Add trader/interface.go for unified trader interface
- Add trader/hyperliquid_trader.go for Hyperliquid implementation
- Update manager and auto_trader to support multiple exchanges
- Add go-hyperliquid SDK dependency
- Fix precision errors (float_to_wire, invalid price)

Fixes:
- Correct calculation of wallet balance and unrealized P&L
- Proper handling of AccountValue vs TotalRawUsd
- Frontend display issues for total equity and P&L

Documentation:
- Add Hyperliquid setup guide in README
- Update config.json.example with both exchanges
- Add troubleshooting section for common errors

Tested with live trading on Hyperliquid mainnet.
No breaking changes - backward compatible with existing configs.
2025-10-29 20:00:30 +08:00
tinkle-community
c4b180b369 Docs: Add Docker one-click deployment support for all languages
Complete Docker deployment solution with beginner-friendly documentation:

**New Docker Files:**
- `Dockerfile` - Multi-stage Go backend build with health checks
- `web/Dockerfile` - Frontend build with Nginx and API proxy
- `docker-compose.yml` - Full orchestration with service dependencies
- `.dockerignore` & `web/.dockerignore` - Build optimization
- `start.sh` - Convenient management script (start/stop/logs/status)

**Comprehensive Documentation:**
- `DOCKER_DEPLOY.md` (中文) - Complete Chinese deployment guide
- `DOCKER_DEPLOY.en.md` (English) - Complete English deployment guide
  - Prerequisites & Docker installation (macOS/Windows/Linux)
  - 3-step quick start (config → start → access)
  - Service management commands
  - Advanced configuration (ports, resources, env vars)
  - Data persistence & backups
  - Comprehensive troubleshooting
  - Security recommendations
  - Production deployment (Nginx, HTTPS, Docker Swarm)
  - Monitoring & logging setup

**README Updates (All 4 Languages):**
- README.md (English)
- README.zh-CN.md (中文)
- README.uk.md (Українська)
- README.ru.md (Русский)

Added prominent "Option A: Docker One-Click Deployment" section at the
beginning of Quick Start in all languages. Clearly marked as EASIEST
method for beginners. Shows 3 simple steps with command examples and
links to detailed DOCKER_DEPLOY docs.

**Key Features:**
- One-command deployment: `./start.sh start --build`
- Auto-handles all dependencies (Go, Node.js, TA-Lib)
- Health checks for both services
- Data persistence (logs, cache, config)
- Log rotation (10MB × 3 files)
- Easy service management
- Beginner-friendly for complete newcomers

**User Benefits:**
- No need to install Go, Node.js, or TA-Lib manually
- Works on macOS, Windows, Linux
- Perfect for non-developers
- Production-ready with best practices

This makes NOFX truly accessible to beginners as requested: "真就让小白都能一键开始"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-10-29 18:29:49 +08:00
tinkle-community
9562962574 Docs: Enhance README files with beginner-friendly guides (4 languages)
**Configuration Improvements:**
- Add comprehensive "Get AI API Keys" section (DeepSeek + Qwen)
- Split configuration into Beginner Mode and Expert Mode
- Add step-by-step setup guides with placeholder tables
- Add configuration checklist and field explanations
- Document smart default behavior for use_default_coins (v2.0.2)

**Startup/Monitoring Guides:**
- Add detailed 2-step system startup instructions
- Include expected output and error troubleshooting tables
- Add monitoring and graceful shutdown procedures
- Provide health check commands

**AI Decision Flow Updates:**
- Enhance flow diagram with emojis and wider boxes
- Add v2.0.2 improvement markers throughout
- Document position duration tracking
- Document accurate USDT PnL calculation with leverage
- Document enhanced AI freedom for raw data analysis
- Document improved position tracking (symbol_side keys)
- Add "Key Improvements in v2.0.2" summary section

**Code Changes:**
- Simplify config.json.example to beginner-friendly single trader
- Implement smart default: use_default_coins auto-enables when omitted
- Set default to true if false without coin_pool_api_url

**Files Updated:**
- README.md (English): +559 lines
- README.zh-CN.md (Chinese): +527 lines
- README.ru.md (Russian): +634 lines
- README.uk.md (Ukrainian): +521 lines
- config.json.example: Simplified configuration
- config/config.go: Smart default logic

Total: 2068+ additions across all documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-10-29 17:16:27 +08:00