OkxDexSwift 中文

A Swift library for interacting with OKX DEX aggregator, supporting multi-chain decentralizeddecentralized exchange functionalities.

Overview

OkxDexSwift is a Swift framework that enables seamless integration with OKX DEX services, providing developers with a unified interface to interact with decentralized exchanges across multiple blockchain networks. The library abstracts the complexities of different blockchain protocols, allowing for easy implementation of token swaps, liquidity queries, and cross-chain operations.

Key Features

Multi-Chain Support

• EVM-compatible blockchains: Ethereum, BSC, Polygon, Arbitrum, Optimism, etc.
• Solana: Full support for Solana DEX operations with Address Lookup Table optimization.
• Sui: Integration with Sui blockchain for decentralized exchange functionalities.
• TON: Complete support for TON blockchain swaps, including transaction signing and broadcasting.
• Pre-configured network settings for 20+ blockchains (see Resources/network-configs.json).

Core DEX Functionality

• Get real-time token swap quotes with configurable slippage.
• Execute token swaps across supported blockchains.
• Token approval management for EVM-based chains.
• Query supported tokens, chains, and liquidity pools.
• Support Market API

Dependencies

• swift-collections - For ordered collections
• web3swift - EVM chain interactions
• SolanaSwift - Solana chain interactions
• CryptoSwift - Cryptographic functions
• SuiSwift - Sui chain interactions
• TonSwift - TON chain interactions

Usage Example

Initializing the Client

import OkxDexSwift

let config = OKXConfig(
    apiKey: "your-api-key",
    secretKey: "your-secret-key",
    apiPassphrase: "your-passphrase",
    projectId: "your-project-id"
)
let client = OKXDexClient(config: config)

Getting a Swap Quote

let params = QuoteParams(
    chainIndex: "56", // BSC chain index
    fromTokenAddress: "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c", // BNB
    toTokenAddress: "0xe9e7cea3dedca5984780bafc599bd69add087d56", // BUSD
    amount: "1000000000000000000", // 1 BNB in wei
    slippagePercent: "0.5" // 0.5% slippage
)

do {
    let quote = try await client.dex.getQuote(params: params)
    print("Estimated output: \(quote.data.first?.routerResult?.toTokenAmount ?? "0")")
} catch {
    print("Error getting quote: \(error.localizedDescription)")
}

Executing a Swap (EVM Chain)

// Configure wallet for EVM chain
var clientConfig = client.config
clientConfig.evm = try EVMConfig(
    wallet: PrivateKeyWallet(
        privateKey: Data(hex: "your-private-key"),
        providerUrl: "https://bsc-dataseed.binance.org"
    )
)
client.updateConfig(clientConfig)

// Prepare swap parameters
let swapParams = SwapParams(
    chainIndex: "56",
    fromTokenAddress: "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
    toTokenAddress: "0xe9e7cea3dedca5984780bafc599bd69add087d56",
    amount: "1000000000000000000",
    userWalletAddress: client.config.evm?.wallet.address ?? "",
    slippagePercent: "0.5",
    type: .EIP1559
)

do {
    let result = try await client.dex.executeSwap(params: swapParams)
    print("Swap successful! Tx hash: \(result.transactionId)")
    print("Explorer: \(result.explorerUrl)")
} catch {
    print("Swap failed: \(error.localizedDescription)")
}

Executing a Swap (Solana)

// Configure wallet for Solana
var clientConfig = client.config
clientConfig.solana = try SolanaConfig(
    wallet: SolanaPrivateKeyWallet(
        privateKey: "your-private-key",
        endpoint: "https://solana-rpc.publicnode.com"
    )
)
client.updateConfig(clientConfig)

// Prepare swap parameters
let swapParams = SwapParams(
    chainIndex: "501", // Solana chain index
    fromTokenAddress: "from-token-mint-address",
    toTokenAddress: "to-token-mint-address",
    amount: "1000000", // Token amount in smallest unit
    userWalletAddress: "your-solana-wallet-address",
    slippagePercent: "0.5"
)

do {
    let result = try await client.dex.executeSwap(params: swapParams)
    print("Solana swap successful! Tx hash: \(result.transactionId)")
} catch {
    print("Solana swap failed: \(error.localizedDescription)")
}

Executing a Swap (TON)

// Configure wallet for TON
var clientConfig = client.config
clientConfig.ton = try TonConfig(
    wallet: TonSwapWallet(
        mnemonics: "your-mnemonic-phrase",
        client: TonClient(
            url: URL(string: "https://toncenter.com")!,
            apiKey: "your-ton-api-key"
        ),
        walletVersion: .v4R2
    )
)
client.updateConfig(clientConfig)

// Prepare swap parameters
let swapParams = SwapParams(
    chainIndex: "607", // TON chain index
    fromTokenAddress: "EQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAM9c", // TON
    toTokenAddress: "EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs", // Example token
    amount: "1000", // Token amount in smallest unit
    userWalletAddress: "your-ton-wallet-address",
    slippagePercent: "0.5"
)

do {
    let result = try await client.dex.executeSwap(params: swapParams)
    print("TON swap successful! Tx hash: \(result.transactionId)")
    print("Explorer: \(result.explorerUrl)")
} catch {
    print("TON swap failed: \(error.localizedDescription)")
}

Supported Networks

OkxDexSwift includes pre-configured network support (chain indices):

• Ethereum (1)
• BSC (56)
• Polygon (137)
• Arbitrum (42161)
• Optimism (10)
• Avalanche (43114)
• Solana (501)
• Sui (784)
• TON (607)
• More networks (full list in Resources/network-configs.json)

Each network configuration includes explorer URL, default slippage settings, and transaction parameters.

License

OkxDexSwift is available under the MIT license. See the LICENSE file for more details.

Disclaimer

This library is provided as-is, without any warranty. Always ensure you understand the risks involved with blockchain transactions before using this library in production. Transactions on the blockchain are irreversible.