OKX DEX SDK

TypeScript SDK for the OKX DEX API, currently supporting Solana network DEX operations. This SDK provides easy integration for getting quotes, executing swaps, and managing liquidity on Solana, with built-in authentication, retries, and error handling.

Features

• Execute token swaps on Solana
• Get real-time quotes and liquidity info
• Built-in retry mechanism and error handling
• Full TypeScript support
• Solana transaction handling and signing

Installation

1. Install:

npm install @okx-dex/okx-dex-sdk

2. Get your API credentials from OKX Developer Portal

3. Create .env:

# OKX
OKX_PROJECT_ID=
OKX_API_KEY=
OKX_SECRET_KEY=
OKX_API_PASSPHRASE=

# Solana
SOLANA_WALLET_ADDRESS=
SOLANA_PRIVATE_KEY=
SOLANA_RPC_URL=
WS_ENDPONT=

# Sui
SUI_WALLET_ADDRESS=
SUI_PRIVATE_KEY=
SUI_RPC_URL=

# Evm
EVM_WALLET_ADDRESS=
EVM_PRIVATE_KEY=
EVM_RPC_URL=

Usage Examples

Initialize Client

import { OKXDexClient } from '@okx-dex/okx-dex-sdk';
import 'dotenv/config';

const client = new OKXDexClient({
    apiKey: process.env.OKX_API_KEY!,
    secretKey: process.env.OKX_SECRET_KEY!,
    apiPassphrase: process.env.OKX_API_PASSPHRASE!,
    projectId: process.env.OKX_PROJECT_ID!,
    // Required for executing swaps
    solana: {
        connection: {
            rpcUrl: process.env.SOLANA_RPC_URL!,
            confirmTransactionInitialTimeout: 60000
        },
        privateKey: process.env.SOLANA_PRIVATE_KEY!,
        walletAddress: process.env.SOLANA_WALLET_ADDRESS!
    }
});

Get Quote (SOL → USDC)

const quote = await client.dex.getQuote({
    chainId: '501',
    fromTokenAddress: 'So11111111111111111111111111111111111111112',  // SOL
    toTokenAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',  // USDC
    amount: '1000000000',  // 1 SOL (in lamports)
    slippage: '0.001'      // 0.1%
});

Execute Swap

const swapResult = await client.dex.executeSwap({
    chainId: '501',
    fromTokenAddress: 'So11111111111111111111111111111111111111112',
    toTokenAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
    amount: '1000000000',
    autoSlippage: true,
    maxAutoSlippageBps: '100'  // 1% max auto slippage
    userAddress: process.env.SOLANA_WALLET_ADDRESS!
});

Common Solana Token Addresses

const TOKENS = {
    SOL: 'So11111111111111111111111111111111111111112',   // Wrapped SOL
    USDC: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
    USDT: 'Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB'
};

API Reference

Available Methods

// Get supported chains
const chains = await client.dex.getSupportedChains();

// Get Solana tokens
const tokens = await client.dex.getTokens('501');

// Get liquidity sources
const liquidity = await client.dex.getLiquidity('501');

// Get swap quote
const quote = await client.dex.getQuote({...});

// Get swap data (transaction details)
const swapData = await client.dex.getSwapData({...});

// Execute swap
const swapResult = await client.dex.executeSwap({...});

Error Handling

The SDK includes built-in retries for transient errors:

try {
    const result = await client.dex.getSwapData(params);
} catch (error) {
    if (error instanceof Error) {
        console.error('Error message:', error.message);
        // API errors include details in the message
        if (error.message.includes('API Error:')) {
            const match = error.message.match(/API Error: (.*)/);
            if (match) console.error('API Error Details:', match[1]);
        }
    }
}

Important Notes (Solana)

• Amount values should be in lamports (1 SOL = 1e9 lamports)
• Use a reliable RPC URL for best performance
• Default compute units for transactions is 300,000 (configurable)
• Default retry count is 3 (configurable)

Useful Links

• OKX DEX API Docs
• Developer Portal