mirror of
https://github.com/NoFxAiOS/nofx.git
synced 2026-07-06 04:20:59 +08:00
docs: add Bybit, OKX, and Lighter exchange support
- Mark Bybit, OKX as supported in CEX section - Mark Lighter as supported in Perp-DEX section - Add Bybit API setup guide - Add OKX API setup guide - Add Lighter agent wallet setup guide - Update all READMEs (EN, ZH-CN, JA, KO)
This commit is contained in:
tinkle-community
63
docs/getting-started/bybit-api.md
Normal file
63
docs/getting-started/bybit-api.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# Bybit API Setup Guide
|
||||
|
||||
This guide explains how to create and configure Bybit API keys for use with NOFX.
|
||||
|
||||
## Create API Key
|
||||
|
||||
1. Log in to your [Bybit account](https://partner.bybit.com/b/83856)
|
||||
2. Go to **Account & Security** → **API Management**
|
||||
3. Click **Create New Key**
|
||||
4. Select **System-generated API Keys**
|
||||
5. Complete 2FA verification
|
||||
6. Name your API key (e.g., "NOFX Trading")
|
||||
|
||||
## Configure API Permissions
|
||||
|
||||
Enable the following permissions:
|
||||
|
||||
- ✅ **Read-Write** - Required for trading
|
||||
- ✅ **Contract** - Required for futures/perpetual trading
|
||||
- ❌ **Withdrawals** - Keep disabled for security
|
||||
|
||||
## IP Whitelist (Recommended)
|
||||
|
||||
For enhanced security:
|
||||
|
||||
1. Click **Edit** on your API key
|
||||
2. Add your server's IP address to the whitelist
|
||||
3. Save changes
|
||||
|
||||
## Save Your Keys
|
||||
|
||||
After creation, you'll see:
|
||||
- **API Key**: `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
|
||||
- **API Secret**: `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
|
||||
|
||||
⚠️ **Important**: Save the API Secret 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 **Bybit**
|
||||
4. Enter your API Key and API Secret
|
||||
5. Save configuration
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Error | Solution |
|
||||
|-------|----------|
|
||||
| `Invalid API key` | Check if API key is correct |
|
||||
| `Signature error` | Check if API Secret is correct |
|
||||
| `IP not allowed` | Add your IP to whitelist |
|
||||
| `Permission denied` | Enable Contract trading permission |
|
||||
|
||||
## 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
|
||||
83
docs/getting-started/lighter-agent-wallet.md
Normal file
83
docs/getting-started/lighter-agent-wallet.md
Normal file
@@ -0,0 +1,83 @@
|
||||
# Lighter Agent Wallet Setup Guide
|
||||
|
||||
This guide explains how to create and configure an Agent Wallet for secure trading on Lighter.
|
||||
|
||||
## 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
|
||||
- ✅ **Separate Funds**: Keep main holdings safe
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Web3 wallet (MetaMask, WalletConnect, etc.)
|
||||
- Access to [Lighter](https://lighter.xyz)
|
||||
|
||||
## Step 1: Connect Your Main Wallet
|
||||
|
||||
1. Visit [Lighter](https://lighter.xyz)
|
||||
2. Click **Connect Wallet**
|
||||
3. Choose MetaMask, WalletConnect, or other Web3 wallet
|
||||
4. Approve the connection
|
||||
|
||||
## Step 2: Create Agent Wallet
|
||||
|
||||
1. Navigate to **Settings** or **API** section
|
||||
2. Look for **Agent Wallet** or **Trading Wallet** option
|
||||
3. Click **Create Agent** or **Generate New Wallet**
|
||||
4. Approve the transaction if required
|
||||
|
||||
## Step 3: Save Agent Credentials
|
||||
|
||||
After creation, save these immediately:
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **Main Wallet Address** | Your connected wallet address |
|
||||
| **Agent Wallet Address** | Generated agent wallet address |
|
||||
| **Agent Private Key** | Private key for the agent wallet |
|
||||
|
||||
⚠️ **Important**: The private key is only shown 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 **Lighter**
|
||||
4. Enter:
|
||||
- **Wallet Address**: Your main wallet address (with `0x`)
|
||||
- **Private Key**: Agent private key (remove `0x` prefix)
|
||||
5. Save configuration
|
||||
|
||||
## Managing Your Agent
|
||||
|
||||
### Revoke Agent Access
|
||||
|
||||
1. Go to Lighter Settings
|
||||
2. Find your agent in the list
|
||||
3. Click **Revoke** or **Delete**
|
||||
|
||||
### Fund Your Account
|
||||
|
||||
1. Deposit supported assets to Lighter
|
||||
2. Agent wallet will trade using deposited funds
|
||||
|
||||
## 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 |
|
||||
| Invalid signature | Ensure private key doesn't have `0x` prefix |
|
||||
| Insufficient funds | Deposit funds to your Lighter account |
|
||||
| Connection error | Check network settings |
|
||||
75
docs/getting-started/okx-api.md
Normal file
75
docs/getting-started/okx-api.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# OKX API Setup Guide
|
||||
|
||||
This guide explains how to create and configure OKX API keys for use with NOFX.
|
||||
|
||||
## Create API Key
|
||||
|
||||
1. Log in to your [OKX account](https://www.okx.com/join/1865360)
|
||||
2. Go to **Account** → **API**
|
||||
3. Click **Create API Key**
|
||||
4. Select **Trade** as the purpose
|
||||
5. Complete 2FA verification
|
||||
6. Name your API key (e.g., "NOFX Trading")
|
||||
|
||||
## Configure API Permissions
|
||||
|
||||
Enable the following permissions:
|
||||
|
||||
- ✅ **Read** - Required
|
||||
- ✅ **Trade** - Required for trading
|
||||
- ❌ **Withdraw** - Keep disabled for security
|
||||
|
||||
## Passphrase
|
||||
|
||||
OKX requires a passphrase in addition to API Key and Secret:
|
||||
|
||||
1. Create a strong passphrase during API creation
|
||||
2. Save it securely - you'll need it for configuration
|
||||
|
||||
## IP Whitelist (Recommended)
|
||||
|
||||
For enhanced security:
|
||||
|
||||
1. Click **Edit** on your API key
|
||||
2. Enable **IP Whitelist**
|
||||
3. Add your server's IP address
|
||||
4. Save changes
|
||||
|
||||
## Save Your Keys
|
||||
|
||||
After creation, you'll have:
|
||||
- **API Key**: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
|
||||
- **Secret Key**: `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
|
||||
- **Passphrase**: Your created passphrase
|
||||
|
||||
⚠️ **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 **OKX**
|
||||
4. Enter:
|
||||
- **API Key**
|
||||
- **Secret Key**
|
||||
- **Passphrase**
|
||||
5. Save configuration
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Error | Solution |
|
||||
|-------|----------|
|
||||
| `Invalid API key` | Check if API key is correct |
|
||||
| `Invalid signature` | Check if Secret key and Passphrase are correct |
|
||||
| `IP not whitelisted` | Add your IP to whitelist or disable IP restriction |
|
||||
| `Permission denied` | Enable Trade permission in API settings |
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
- Never share your API keys or passphrase
|
||||
- Use IP whitelisting
|
||||
- Don't enable withdrawal permissions
|
||||
- Create separate API keys for different applications
|
||||
- Regularly rotate your API keys
|
||||
Reference in New Issue
Block a user