mirror of
https://github.com/NoFxAiOS/nofx.git
synced 2026-07-07 13:00:59 +08:00
docs: add supported exchanges table and API/wallet setup guides
- Add supported exchanges table to EN, ZH-CN, JA, KO READMEs - CEX: Binance (supported), OKX (coming soon), Bybit (coming soon) - Perp-DEX: Hyperliquid (supported), Aster DEX (supported) - Include referral links with fee discounts for all exchanges - Remove What's New sections from all READMEs - Create Binance API setup guide - Create Hyperliquid agent wallet setup guide - Create Aster DEX API wallet setup guide
This commit is contained in:
tinkle-community
108
docs/getting-started/aster-api-wallet.md
Normal file
108
docs/getting-started/aster-api-wallet.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# Aster DEX API Wallet Setup Guide
|
||||
|
||||
This guide explains how to create and configure an API Wallet for secure trading on Aster DEX.
|
||||
|
||||
## Why Use API Wallet?
|
||||
|
||||
- ✅ **Binance-compatible API**: Easy migration from Binance
|
||||
- ✅ **Separate Trading Wallet**: Enhanced security
|
||||
- ✅ **Revocable Access**: Can be disabled anytime
|
||||
- ✅ **Lower Fees**: Competitive trading fees
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Web3 wallet (MetaMask, WalletConnect, etc.)
|
||||
- Funds on supported EVM chain (Ethereum, BSC, Polygon, etc.)
|
||||
|
||||
## Step 1: Register on Aster DEX
|
||||
|
||||
1. Visit [Aster DEX](https://www.asterdex.com/en/referral/fdfc0e) (use referral link for fee discount)
|
||||
2. Connect your Web3 wallet
|
||||
3. Complete any required verification
|
||||
|
||||
## Step 2: Create API Wallet
|
||||
|
||||
1. Go to [Aster API Wallet](https://www.asterdex.com/en/api-wallet)
|
||||
2. Connect your main wallet
|
||||
3. Click **Create API Wallet**
|
||||
4. Approve the transaction in your wallet
|
||||
|
||||
## Step 3: Save API Wallet Credentials
|
||||
|
||||
After creation, save these **immediately**:
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **User Address** | Your main wallet address |
|
||||
| **Signer Address** | API wallet address |
|
||||
| **Private Key** | API wallet private key |
|
||||
|
||||
⚠️ **Important**: The private key is only shown once! Save it securely.
|
||||
|
||||
## Step 4: Configure in NOFX
|
||||
|
||||
Add your API wallet through the NOFX web interface:
|
||||
|
||||
1. Open NOFX dashboard (http://localhost:3000)
|
||||
2. Go to **Exchange Configuration**
|
||||
3. Enable **Aster DEX**
|
||||
4. Enter:
|
||||
- **User**: Your main wallet address (with `0x`)
|
||||
- **Signer**: API wallet address (with `0x`)
|
||||
- **Private Key**: API wallet private key (remove `0x` prefix)
|
||||
5. Save configuration
|
||||
|
||||
## Configuration Example
|
||||
|
||||
```
|
||||
User: 0xYOUR_MAIN_WALLET_ADDRESS
|
||||
Signer: 0xYOUR_API_WALLET_SIGNER_ADDRESS
|
||||
Private Key: your_api_wallet_private_key_without_0x
|
||||
```
|
||||
|
||||
## Fund Your Account
|
||||
|
||||
1. Deposit supported assets to Aster DEX
|
||||
2. Transfer to your trading account
|
||||
3. API wallet will trade using these funds
|
||||
|
||||
## Managing Your API Wallet
|
||||
|
||||
### Revoke Access
|
||||
|
||||
1. Go to [Aster API Wallet](https://www.asterdex.com/en/api-wallet)
|
||||
2. Find your API wallet
|
||||
3. Click **Revoke** or **Delete**
|
||||
|
||||
### Create New API Wallet
|
||||
|
||||
You can create multiple API wallets:
|
||||
- Delete old wallet first (recommended)
|
||||
- Or create additional wallet for different purposes
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
- Never share your API wallet private key
|
||||
- Store credentials in a secure password manager
|
||||
- Revoke access when not in use
|
||||
- Use separate wallets for different applications
|
||||
- Monitor API wallet activity regularly
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Authentication failed | Verify User, Signer, and Private Key are correct |
|
||||
| Invalid signature | Ensure private key doesn't have `0x` prefix |
|
||||
| Insufficient balance | Deposit funds to Aster DEX |
|
||||
| API wallet not found | Create new API wallet at asterdex.com |
|
||||
|
||||
## Supported Chains
|
||||
|
||||
Aster DEX supports multiple EVM chains:
|
||||
- Ethereum Mainnet
|
||||
- BNB Smart Chain (BSC)
|
||||
- Polygon
|
||||
- And more...
|
||||
|
||||
Select your preferred chain when depositing funds.
|
||||
64
docs/getting-started/binance-api.md
Normal file
64
docs/getting-started/binance-api.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Binance API Setup Guide
|
||||
|
||||
This guide explains how to create and configure Binance API keys for use with NOFX.
|
||||
|
||||
## Create API Key
|
||||
|
||||
1. Log in to your [Binance account](https://www.binance.com)
|
||||
2. Go to **Account** → **API Management**
|
||||
3. Click **Create API**
|
||||
4. Select **System Generated** API key type
|
||||
5. Complete 2FA verification
|
||||
6. Name your API key (e.g., "NOFX Trading")
|
||||
|
||||
## Configure API Permissions
|
||||
|
||||
Enable the following permissions:
|
||||
|
||||
- ✅ **Enable Reading** - Required
|
||||
- ✅ **Enable Futures** - Required for trading
|
||||
- ❌ **Enable Withdrawals** - Keep disabled for security
|
||||
|
||||
## IP Whitelist (Recommended)
|
||||
|
||||
For enhanced security:
|
||||
|
||||
1. Click **Edit restrictions**
|
||||
2. Select **Restrict access to trusted IPs only**
|
||||
3. Add your server's IP address
|
||||
4. Save changes
|
||||
|
||||
## Save Your Keys
|
||||
|
||||
After creation, you'll see:
|
||||
- **API Key**: `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
|
||||
- **Secret Key**: `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
|
||||
|
||||
⚠️ **Important**: Save the Secret Key immediately - it's only shown once!
|
||||
|
||||
## Configure in NOFX
|
||||
|
||||
Add your API credentials through the NOFX web interface:
|
||||
|
||||
1. Open NOFX dashboard (http://localhost:3000)
|
||||
2. Go to **Exchange Configuration**
|
||||
3. Enable **Binance**
|
||||
4. Enter your API Key and Secret Key
|
||||
5. Save configuration
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Error | Solution |
|
||||
|-------|----------|
|
||||
| `Invalid API-key` | Check if API key is correct |
|
||||
| `Signature verification failed` | Check if Secret key is correct |
|
||||
| `IP not whitelisted` | Add your IP to whitelist or disable IP restriction |
|
||||
| `Futures not enabled` | Enable Futures permission in API settings |
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
- Never share your API keys
|
||||
- Use IP whitelisting
|
||||
- Don't enable withdrawal permissions
|
||||
- Create separate API keys for different applications
|
||||
- Regularly rotate your API keys
|
||||
91
docs/getting-started/hyperliquid-agent-wallet.md
Normal file
91
docs/getting-started/hyperliquid-agent-wallet.md
Normal file
@@ -0,0 +1,91 @@
|
||||
# Hyperliquid Agent Wallet Setup Guide
|
||||
|
||||
This guide explains how to create and configure an Agent Wallet for secure trading on Hyperliquid.
|
||||
|
||||
## 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
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A wallet with funds on Hyperliquid
|
||||
- Access to [Hyperliquid](https://app.hyperliquid.xyz/join/AITRADING)
|
||||
|
||||
## Step 1: Connect Your Main Wallet
|
||||
|
||||
1. Visit [Hyperliquid](https://app.hyperliquid.xyz/join/AITRADING)
|
||||
2. Click **Connect Wallet** (top right)
|
||||
3. Choose MetaMask, WalletConnect, or other Web3 wallet
|
||||
4. Approve the connection
|
||||
|
||||
## Step 2: Create Agent Wallet
|
||||
|
||||
1. Click on your wallet address (top right)
|
||||
2. Go to **Settings** → **API & Agents**
|
||||
3. Or visit directly: [https://app.hyperliquid.xyz/agents](https://app.hyperliquid.xyz/agents)
|
||||
4. Click **Create Agent** or **Add Agent**
|
||||
5. System generates a new agent wallet automatically
|
||||
|
||||
## Step 3: Save Agent Credentials
|
||||
|
||||
After creation, save these immediately:
|
||||
|
||||
- **Agent Wallet Address**: `0x...` (starts with 0x)
|
||||
- **Agent Private Key**: Shown only once!
|
||||
|
||||
⚠️ **Important**: The private key is only displayed once. Save it securely!
|
||||
|
||||
## Step 4: Configure in NOFX
|
||||
|
||||
Add your agent wallet through the NOFX web interface:
|
||||
|
||||
1. Open NOFX dashboard (http://localhost:3000)
|
||||
2. Go to **Exchange Configuration**
|
||||
3. Enable **Hyperliquid**
|
||||
4. Enter:
|
||||
- **Wallet Address**: Your main wallet address (with `0x`)
|
||||
- **Private Key**: Agent private key (remove `0x` prefix)
|
||||
5. Save configuration
|
||||
|
||||
## Agent Wallet Details
|
||||
|
||||
| Field | Description | Example |
|
||||
|-------|-------------|---------|
|
||||
| Main Wallet | Your connected wallet (holds funds) | `0xABC123...` |
|
||||
| Agent Wallet | Sub-wallet for trading | `0xDEF456...` |
|
||||
| Private Key | Only needed for NOFX | `abc123...` (no 0x) |
|
||||
|
||||
## Managing Your Agent
|
||||
|
||||
### Revoke Agent Access
|
||||
|
||||
1. Go to [Hyperliquid Agents](https://app.hyperliquid.xyz/agents)
|
||||
2. Find your agent in the list
|
||||
3. Click **Revoke** or **Delete**
|
||||
|
||||
### Create Multiple Agents
|
||||
|
||||
You can create multiple agents for different purposes:
|
||||
- One for NOFX
|
||||
- One for other trading bots
|
||||
- One for manual API access
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
- Use agent wallet instead of main wallet private key
|
||||
- Store agent private key securely
|
||||
- Revoke unused agents
|
||||
- Monitor agent activity regularly
|
||||
- Keep main wallet funds separate from trading funds
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Agent not working | Check if agent is still active in Hyperliquid settings |
|
||||
| Invalid signature | Ensure private key doesn't have `0x` prefix |
|
||||
| Insufficient funds | Transfer funds to your Hyperliquid account |
|
||||
| Connection error | Check network (mainnet vs testnet) setting |
|
||||
Reference in New Issue
Block a user