laoxong/nofx
1
0
Fork 0
mirror of https://github.com/laoxong/nofx.git synced 2026-06-04 09:58:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: simplify exchange sections, consolidate into Supported Exchanges table

Browse Source 
- Remove individual exchange registration sections from all READMEs
- Remove redundant Binance, Hyperliquid, Aster DEX detailed setup sections
- Consolidate all exchange info into Supported Exchanges table with register links and setup guides
- Rename section to "Supported Exchanges (DEX/CEX Tutorials)" in respective languages
This commit is contained in:
tinkle-community
2025-11-27 03:19:59 +08:00
parent f2f91f281d
commit 3ce631292a
4 changed files with 8 additions and 681 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -219
View File
@@ -20,10 +20,7 @@
- [✨ Current Implementation](#-current-implementation---crypto-markets)
- [🔮 Roadmap](#-roadmap---universal-market-expansion)
- [🏗️ Technical Architecture](#️-technical-architecture)
- [🏦 Supported Exchanges](#-supported-exchanges)
- [💰 Register Binance Account](#-register-binance-account-save-on-fees)
- [🔷 Register Hyperliquid Account](#-using-hyperliquid-exchange)
- [🔶 Register Aster DEX Account](#-using-aster-dex-exchange)
- [🏦 Supported Exchanges (DEX/CEX Tutorials)](#-supported-exchanges-dexcex-tutorials)
- [🚀 Quick Start](#-quick-start)
- [📖 AI Decision Flow](#-ai-decision-flow)
- [🧠 AI Self-Learning](#-ai-self-learning-example)
@@ -182,7 +179,7 @@ NOFX is built with a modern, modular architecture:
---
## 🏦 Supported Exchanges
## 🏦 Supported Exchanges (DEX/CEX Tutorials)
### CEX (Centralized Exchanges)
@@ -202,34 +199,6 @@ NOFX is built with a modern, modular architecture:
---
## 💰 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:**
**🎁 [Register Binance - Get Fee Discount](https://www.binance.com/join?ref=NOFXENG)**
### Registration Steps:
1. **Click the link above** to visit Binance registration page
2. **Complete registration** with email/phone number
3. **Complete KYC verification** (required for futures trading)
4. **Enable Futures account**:
- Go to Binance homepage → Derivatives → USD-M Futures
- Click "Open Now" to activate futures trading
5. **Create API Key**:
- Go to Account → API Management
- Create new API key, **enable "Futures" permission**
- Save API Key and Secret Key (~~needed for config.json~~) *needed for web interface*
- **Important**: Whitelist your IP address for security
### Fee Discount Benefits:
- ✅ **Spot trading**: Up to 30% fee discount
- ✅ **Futures trading**: Up to 30% fee discount
- ✅ **Lifetime validity**: Permanent discount on all trades
---
## 🚀 Quick Start
### 🐳 Option A: Docker One-Click Deployment (EASIEST - Recommended!)
@@ -449,192 +418,6 @@ Open your browser and visit: **🌐 http://localhost:3000**
---
#### 🔷 Using Hyperliquid Exchange
**NOFX supports Hyperliquid** - a high-performance decentralized perpetual futures exchange!
**Why Choose Hyperliquid?**
- 🚀 **High Performance**: Lightning-fast execution on L1 blockchain
- 💰 **Low Fees**: Competitive maker/taker fees
- 🔐 **Non-Custodial**: Your keys, your coins
- 🌐 **No KYC**: Anonymous trading
- 💎 **Deep Liquidity**: Institutional-grade order book
---
### 📝 Registration & Setup Guide
**Step 1: Register Hyperliquid Account**
1. **Visit Hyperliquid with Referral Link** (get benefits!):
**🎁 [Register Hyperliquid - Join AITRADING](https://app.hyperliquid.xyz/join/AITRADING)**
2. **Connect Your Wallet**:
- Click "Connect Wallet" on the top right
- Choose MetaMask, WalletConnect, or other Web3 wallets
- Approve the connection
3. **Enable Trading**:
- First connection will prompt you to sign a message
- This authorizes your wallet for trading (no gas fees)
- You'll see your wallet address displayed
**Step 2: Fund Your Wallet**
1. **Bridge Assets to Arbitrum**:
- Hyperliquid runs on Arbitrum L2
- Bridge USDC from Ethereum mainnet or other chains
- Or directly withdraw USDC from exchanges to Arbitrum
2. **Deposit to Hyperliquid**:
- Click "Deposit" on Hyperliquid interface
- Select USDC amount to deposit
- Confirm the transaction (small gas fee on Arbitrum)
- Funds appear in your Hyperliquid account within seconds
**Step 3: Set Up Agent Wallet (Recommended)**
Hyperliquid supports **Agent Wallets** - secure sub-wallets specifically for trading automation!
⚠️ **Why Use Agent Wallet:**
- ✅ **More Secure**: Never expose your main wallet private key
- ✅ **Limited Access**: Agent only has trading permissions
- ✅ **Revocable**: Can be disabled anytime from Hyperliquid interface
- ✅ **Separate Funds**: Keep main holdings safe
**How to Create Agent Wallet:**
1. **Log in to Hyperliquid** using your main wallet
- Visit [https://app.hyperliquid.xyz](https://app.hyperliquid.xyz)
- Connect with the wallet you registered (from referral link)
2. **Navigate to Agent Settings**:
- Click on your wallet address (top right)
- Go to "Settings" → "API & Agents"
- Or visit: [https://app.hyperliquid.xyz/agents](https://app.hyperliquid.xyz/agents)
3. **Create New Agent**:
- Click "Create Agent" or "Add Agent"
- System will generate a new agent wallet automatically
- **Save the agent wallet address** (starts with `0x`)
- **Save the agent private key** (shown only once!)
4. **Agent Wallet Details**:
- Main Wallet: Your connected wallet (holds funds)
- Agent Wallet: The sub-wallet for trading (NOFX will use this)
- Private Key: Only needed for NOFX configuration
5. **Fund Your Agent** (Optional):
- Transfer USDC from main wallet to agent wallet
- Or keep funds in main wallet (agent can trade from it)
6. **Save Credentials for NOFX**:
- Main Wallet Address: `0xYourMainWalletAddress` (with `0x`)
- Agent Private Key: `YourAgentPrivateKeyWithout0x` (remove `0x` prefix)
---
~~Configure `config.json` for Hyperliquid~~ *Configure through web interface*
```json
{
"traders": [
{
"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,
"scan_interval_minutes": 3
}
],
"use_default_coins": true,
"api_server_port": 8080
}
```
**Key Differences from Binance Config:**
- Replace `binance_api_key` + `binance_secret_key` with `hyperliquid_private_key`
- Add `"exchange": "hyperliquid"` field
- Set `hyperliquid_testnet: false` for mainnet (or `true` for testnet)
**⚠️ Security Warning**: Never share your private key! Use a dedicated wallet for trading, not your main wallet.
---
#### 🔶 Using Aster DEX Exchange
**NOFX supports Aster DEX** - a Binance-compatible decentralized perpetual futures exchange!
**Why Choose Aster?**
- 🎯 Binance-compatible API (easy migration)
- 🔐 API Wallet security system
- 💰 Lower trading fees
- 🌐 Multi-chain support (ETH, BSC, Polygon)
- 🌍 No KYC required
**Step 1**: Register and Create Aster API Wallet
1. Register via [Aster Referral Link](https://www.asterdex.com/en/referral/fdfc0e) (get fee discounts!)
2. Visit [Aster API Wallet](https://www.asterdex.com/en/api-wallet)
3. Connect your main wallet (MetaMask, WalletConnect, etc.)
4. Click "Create API Wallet"
5. **Save these 3 items immediately:**
- Main Wallet address (User)
- API Wallet address (Signer)
- API Wallet Private Key (⚠️ shown only once!)
**Step 2**: ~~Configure `config.json` for Aster~~ *Configure through web interface*
```json
{
"traders": [
{
"id": "aster_deepseek",
"name": "Aster DeepSeek Trader",
"enabled": true,
"ai_model": "deepseek",
"exchange": "aster",
"aster_user": "0xYOUR_MAIN_WALLET_ADDRESS_HERE",
"aster_signer": "0xYOUR_API_WALLET_SIGNER_ADDRESS_HERE",
"aster_private_key": "your_api_wallet_private_key_without_0x_prefix",
"deepseek_key": "sk-xxxxxxxxxxxxx",
"initial_balance": 1000.0,
"scan_interval_minutes": 3
}
],
"use_default_coins": true,
"api_server_port": 8080,
"leverage": {
"btc_eth_leverage": 5,
"altcoin_leverage": 5
}
}
```
**Key Configuration Fields:**
- `"exchange": "aster"` - Set exchange to Aster
- `aster_user` - Your main wallet address
- `aster_signer` - API wallet address (from Step 1)
- `aster_private_key` - API wallet private key (without `0x` prefix)
**📖 For detailed setup instructions, see**: [Aster Integration Guide](ASTER_INTEGRATION.md)
**⚠️ Security Notes**:
- API wallet is separate from your main wallet (extra security layer)
- Never share your API private key
- You can revoke API wallet access anytime at [asterdex.com](https://www.asterdex.com/en/api-wallet)
---
#### ⚔️ Expert Mode: Multi-Trader Competition
For running multiple AI traders competing against each other: