Skip to main content

​
OKXConfig

Main configuration interface for the OKX DEX SDK.
​
apiKey
string
required
OKX API key for authentication
​
secretKey
string
required
OKX secret key for signing requests
​
apiPassphrase
string
required
OKX API passphrase for authentication
​
projectId
string
required
OKX project ID for the DEX API
​
baseUrl
string
Custom base URL for API requests. Defaults to OKX production endpoint
​
networks
NetworkConfigs
Chain-specific configuration settings
​
solana
SolanaConfig
Solana-specific configuration
​
sui
SuiConfig
Sui-specific configuration
​
evm
EVMConfig
EVM-specific configuration
​
timeout
number
Request timeout in milliseconds
​
maxRetries
number
Maximum number of retry attempts for failed requests
interface OKXConfig {
  apiKey: string;
  secretKey: string;
  apiPassphrase: string;
  projectId: string;
  baseUrl?: string;
  networks?: NetworkConfigs;
  solana?: SolanaConfig;
  sui?: SuiConfig;
  evm?: EVMConfig;
  timeout?: number;
  maxRetries?: number;
}

​
EVMConfig

Configuration for EVM-compatible chains.
​
wallet
EVMWallet
EVM wallet instance for transaction signing
interface EVMConfig {
  wallet?: EVMWallet;
}

​
SolanaConfig

Configuration for Solana chain.
​
wallet
Wallet
required
Solana wallet instance for transaction signing
​
computeUnits
number
Compute units for Solana transactions
​
maxRetries
number
Maximum number of retry attempts for failed transactions
interface SolanaConfig {
  wallet: Wallet;
  computeUnits?: number;
  maxRetries?: number;
}

​
SuiConfig

Configuration for Sui chain.
​
privateKey
string
required
Private key for Sui wallet
​
walletAddress
string
required
Sui wallet address
​
connection
object
Sui connection settings
​
connection.rpcUrl
string
required
RPC endpoint URL for Sui network
​
connection.wsEndpoint
string
WebSocket endpoint URL for Sui network
interface SuiConfig {
  privateKey: string;
  walletAddress: string;
  connection?: {
    rpcUrl: string;
    wsEndpoint?: string;
  };
}

​
ChainConfig

Chain-specific configuration settings.
​
id
string
required
Chain identifier
​
explorer
string
required
Block explorer base URL
​
defaultSlippage
string
required
Default slippage tolerance percentage
​
maxSlippage
string
required
Maximum allowed slippage percentage
​
computeUnits
number
Compute units for transactions (Solana-specific)
​
confirmationTimeout
number
Transaction confirmation timeout in milliseconds
​
maxRetries
number
Maximum number of retry attempts
​
dexContractAddress
string
DEX contract address for the chain
interface ChainConfig {
  id: string;
  explorer: string;
  defaultSlippage: string;
  maxSlippage: string;
  computeUnits?: number;
  confirmationTimeout?: number;
  maxRetries?: number;
  dexContractAddress?: string;
}

​
NetworkConfigs

Mapping of chain indexes to chain configurations. 
interface NetworkConfigs {
  [chainIndex: string]: ChainConfig;
}

Build docs developers (and LLMs) love

Get started for freeTalk to us