From f2f91f281db38f33aeb6e9f34967a002d1de3c35 Mon Sep 17 00:00:00 2001 From: tinkle-community Date: Thu, 27 Nov 2025 03:05:19 +0800 Subject: [PATCH] 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) --- README.md | 5 +- docs/getting-started/bybit-api.md | 63 +++++++++++++++ docs/getting-started/lighter-agent-wallet.md | 83 ++++++++++++++++++++ docs/getting-started/okx-api.md | 75 ++++++++++++++++++ docs/i18n/ja/README.md | 5 +- docs/i18n/ko/README.md | 5 +- docs/i18n/zh-CN/README.md | 5 +- 7 files changed, 233 insertions(+), 8 deletions(-) create mode 100644 docs/getting-started/bybit-api.md create mode 100644 docs/getting-started/lighter-agent-wallet.md create mode 100644 docs/getting-started/okx-api.md diff --git a/README.md b/README.md index e952d0a2..c1525eaf 100644 --- a/README.md +++ b/README.md @@ -189,8 +189,8 @@ NOFX is built with a modern, modular architecture: | Exchange | Status | Register (Fee Discount) | API Setup | |----------|--------|-------------------------|-----------| | **Binance** | ✅ Supported | [Register](https://www.binance.com/join?ref=NOFXENG) | [API Guide](docs/getting-started/binance-api.md) | -| **OKX** | 🚧 Coming Soon | [Register](https://www.okx.com/join/1865360) | Coming Soon | -| **Bybit** | 🚧 Coming Soon | [Register](https://partner.bybit.com/b/83856) | Coming Soon | +| **Bybit** | ✅ Supported | [Register](https://partner.bybit.com/b/83856) | [API Guide](docs/getting-started/bybit-api.md) | +| **OKX** | ✅ Supported | [Register](https://www.okx.com/join/1865360) | [API Guide](docs/getting-started/okx-api.md) | ### Perp-DEX (Decentralized Perpetual Exchanges) @@ -198,6 +198,7 @@ NOFX is built with a modern, modular architecture: |----------|--------|-------------------------|--------------------| | **Hyperliquid** | ✅ Supported | [Register](https://app.hyperliquid.xyz/join/AITRADING) | [Agent Wallet Guide](docs/getting-started/hyperliquid-agent-wallet.md) | | **Aster DEX** | ✅ Supported | [Register](https://www.asterdex.com/en/referral/fdfc0e) | [API Wallet Guide](docs/getting-started/aster-api-wallet.md) | +| **Lighter** | ✅ Supported | [Register](https://lighter.xyz) | [Agent Wallet Guide](docs/getting-started/lighter-agent-wallet.md) | --- diff --git a/docs/getting-started/bybit-api.md b/docs/getting-started/bybit-api.md new file mode 100644 index 00000000..485e7b7c --- /dev/null +++ b/docs/getting-started/bybit-api.md @@ -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 diff --git a/docs/getting-started/lighter-agent-wallet.md b/docs/getting-started/lighter-agent-wallet.md new file mode 100644 index 00000000..a970ba23 --- /dev/null +++ b/docs/getting-started/lighter-agent-wallet.md @@ -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 | diff --git a/docs/getting-started/okx-api.md b/docs/getting-started/okx-api.md new file mode 100644 index 00000000..ed45a6af --- /dev/null +++ b/docs/getting-started/okx-api.md @@ -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 diff --git a/docs/i18n/ja/README.md b/docs/i18n/ja/README.md index 3e37c649..612922f4 100644 --- a/docs/i18n/ja/README.md +++ b/docs/i18n/ja/README.md @@ -219,8 +219,8 @@ nofx/ | 取引所 | ステータス | 登録（手数料割引） | API設定 | |--------|------------|-------------------|---------| | **Binance** | ✅ 対応済み | [登録](https://www.binance.com/join?ref=NOFXJAPAN) | [APIガイド](../../getting-started/binance-api.md) | -| **OKX** | 🚧 近日対応 | [登録](https://www.okx.com/join/1865360) | 近日公開 | -| **Bybit** | 🚧 近日対応 | [登録](https://partner.bybit.com/b/83856) | 近日公開 | +| **Bybit** | ✅ 対応済み | [登録](https://partner.bybit.com/b/83856) | [APIガイド](../../getting-started/bybit-api.md) | +| **OKX** | ✅ 対応済み | [登録](https://www.okx.com/join/1865360) | [APIガイド](../../getting-started/okx-api.md) | ### Perp-DEX（分散型無期限取引所） @@ -228,6 +228,7 @@ nofx/ |--------|------------|-------------------|---------------------------| | **Hyperliquid** | ✅ 対応済み | [登録](https://app.hyperliquid.xyz/join/AITRADING) | [エージェントウォレットガイド](../../getting-started/hyperliquid-agent-wallet.md) | | **Aster DEX** | ✅ 対応済み | [登録](https://www.asterdex.com/en/referral/fdfc0e) | [APIウォレットガイド](../../getting-started/aster-api-wallet.md) | +| **Lighter** | ✅ 対応済み | [登録](https://lighter.xyz) | [エージェントウォレットガイド](../../getting-started/lighter-agent-wallet.md) | --- diff --git a/docs/i18n/ko/README.md b/docs/i18n/ko/README.md index 58826533..9a19498c 100644 --- a/docs/i18n/ko/README.md +++ b/docs/i18n/ko/README.md @@ -192,8 +192,8 @@ NOFX는 현대적이고 모듈화된 아키텍처로 구축되었습니다: | 거래소 | 상태 | 등록 (수수료 할인) | API 설정 | |--------|------|-------------------|----------| | **Binance** | ✅ 지원됨 | [등록](https://www.binance.com/join?ref=NOFXKOREA) | [API 가이드](../../getting-started/binance-api.md) | -| **OKX** | 🚧 곧 지원 | [등록](https://www.okx.com/join/1865360) | 곧 공개 | -| **Bybit** | 🚧 곧 지원 | [등록](https://partner.bybit.com/b/83856) | 곧 공개 | +| **Bybit** | ✅ 지원됨 | [등록](https://partner.bybit.com/b/83856) | [API 가이드](../../getting-started/bybit-api.md) | +| **OKX** | ✅ 지원됨 | [등록](https://www.okx.com/join/1865360) | [API 가이드](../../getting-started/okx-api.md) | ### Perp-DEX (탈중앙화 무기한 거래소) @@ -201,6 +201,7 @@ NOFX는 현대적이고 모듈화된 아키텍처로 구축되었습니다: |--------|------|-------------------|-------------------| | **Hyperliquid** | ✅ 지원됨 | [등록](https://app.hyperliquid.xyz/join/AITRADING) | [에이전트 지갑 가이드](../../getting-started/hyperliquid-agent-wallet.md) | | **Aster DEX** | ✅ 지원됨 | [등록](https://www.asterdex.com/en/referral/fdfc0e) | [API 지갑 가이드](../../getting-started/aster-api-wallet.md) | +| **Lighter** | ✅ 지원됨 | [등록](https://lighter.xyz) | [에이전트 지갑 가이드](../../getting-started/lighter-agent-wallet.md) | --- diff --git a/docs/i18n/zh-CN/README.md b/docs/i18n/zh-CN/README.md index dc44dd06..f4c850e7 100644 --- a/docs/i18n/zh-CN/README.md +++ b/docs/i18n/zh-CN/README.md @@ -191,8 +191,8 @@ NOFX 采用现代化的模块化架构： | 交易所 | 状态 | 注册（手续费优惠） | API设置 | |--------|------|-------------------|---------| | **Binance** | ✅ 已支持 | [注册](https://www.binance.com/join?ref=NOFXCHI) | [API指南](../../getting-started/binance-api.md) | -| **OKX** | 🚧 即将支持 | [注册](https://www.okx.com/join/1865360) | 即将推出 | -| **Bybit** | 🚧 即将支持 | [注册](https://partner.bybit.com/b/83856) | 即将推出 | +| **Bybit** | ✅ 已支持 | [注册](https://partner.bybit.com/b/83856) | [API指南](../../getting-started/bybit-api.md) | +| **OKX** | ✅ 已支持 | [注册](https://www.okx.com/join/1865360) | [API指南](../../getting-started/okx-api.md) | ### Perp-DEX（去中心化永续交易所） @@ -200,6 +200,7 @@ NOFX 采用现代化的模块化架构： |--------|------|-------------------|--------------| | **Hyperliquid** | ✅ 已支持 | [注册](https://app.hyperliquid.xyz/join/AITRADING) | [代理钱包指南](../../getting-started/hyperliquid-agent-wallet.md) | | **Aster DEX** | ✅ 已支持 | [注册](https://www.asterdex.com/en/referral/fdfc0e) | [API钱包指南](../../getting-started/aster-api-wallet.md) | +| **Lighter** | ✅ 已支持 | [注册](https://lighter.xyz) | [代理钱包指南](../../getting-started/lighter-agent-wallet.md) | ---