📚SDK Examples

SummitX DEX Integration Examples

This section provides comprehensive examples for integrating with the SummitX DEX protocol. Our SDK examples demonstrate best practices for token swaps, liquidity provision, and smart routing.

🚀 Quick Start Example

For a complete working example, check out our summitx-example repository which includes:

Features

• Token Swapping: Native to ERC20, ERC20 to Native, and ERC20 to ERC20 swaps

• Wrap/Unwrap: Convert between native tokens and wrapped tokens

• Smart Routing: Automatic route finding across V3 and Stable pools

• Quote System: Real-time quotes with price impact and slippage calculations

• Multi-hop Support: Find optimal routes through multiple pools

• Rate Limit Protection: Built-in delays to avoid RPC rate limiting

Installation

# Clone the example repository
git clone https://github.com/summitx/summitx-example
cd summitx-example

# Install dependencies
npm install

# Copy environment file
cp .env.example .env

# Add your private key to .env
# PRIVATE_KEY=your_private_key_here

Basic Usage

# Check your wallet balances
npm run check:balance

# Run all examples with 5s delays
npm start

# Run individual examples
npm run wrap-unwrap      # Wrap/unwrap native tokens
npm run swap            # Run all swap examples

📝 Code Examples

Native to ERC20 Swap

import { TokenQuoter } from './quoter/token-quoter';
import { parseUnits } from 'viem';

// Initialize quoter
const quoter = new TokenQuoter({
  rpcUrl: "https://rpc-campnetwork.xyz",
  slippageTolerance: 1.0, // 1% slippage
  maxHops: 2,
  enableV3: true
});

// Get quote for swapping 0.01 native token to USDC
const quote = await quoter.getQuote(
  wrapToken,  // Use wrapped version for native
  usdcToken,
  "0.01",
  TradeType.EXACT_INPUT,
  false
);

// Execute swap with native value
const swapValue = parseUnits("0.01", 18);
const tx = await walletClient.sendTransaction({
  to: SMART_ROUTER_ADDRESS,
  data: methodParameters.calldata,
  value: swapValue // Native token value
});

ERC20 to ERC20 Swap

// Get quote for swapping 1 USDC to USDT
const quote = await quoter.getQuote(
  usdcToken,
  usdtToken,
  "1",
  TradeType.EXACT_INPUT,
  false
);

// Approve token first
await checkAndApproveToken(
  walletClient,
  publicClient,
  usdcAddress,
  amount,
  walletAddress,
  SMART_ROUTER_ADDRESS
);

// Execute swap (no value needed for ERC20 swaps)
const tx = await walletClient.sendTransaction({
  to: SMART_ROUTER_ADDRESS,
  data: methodParameters.calldata,
  value: 0n
});

Wrap and Unwrap Native Tokens

// Wrap native token to wrapped token
const wrapHash = await walletClient.writeContract({
  address: WRAPPED_TOKEN_ADDRESS,
  abi: WETH_ABI,
  functionName: "deposit",
  value: parseUnits("0.01", 18)
});

// Unwrap wrapped token to native
const unwrapHash = await walletClient.writeContract({
  address: WRAPPED_TOKEN_ADDRESS,
  abi: WETH_ABI,
  functionName: "withdraw",
  args: [parseUnits("0.01", 18)]
});

⚙️ Configuration

TokenQuoter Options

const quoter = new TokenQuoter({
  rpcUrl: string,           // RPC endpoint URL
  slippageTolerance: number, // Slippage tolerance (e.g., 1.0 for 1%)
  maxHops: number,          // Maximum route hops (default: 2)
  maxSplits: number,        // Maximum split routes (default: 2)
  enableV2: boolean,        // Enable V2 pools
  enableV3: boolean,        // Enable V3 pools
  enableStable: boolean     // Enable stable pools
});

Environment Variables

# Required
PRIVATE_KEY=your_private_key_here

# Optional (defaults provided)
RPC_URL=https://your-rpc-endpoint
SMART_ROUTER_ADDRESS=0x...

🏗️ Architecture Overview

TokenQuoter

The main class for getting swap quotes:

• Fetches pool information from subgraphs

• Calculates optimal routes using SmartRouter

• Returns quotes with price impact and slippage

• Supports both trade and rawTrade properties for compatibility

SmartRouter Integration

• Uses @summitx/smart-router for route finding

• Supports V3 and Stable pools

• Automatic route optimization

• Multi-hop and split route support

Transaction Flow

1. Get Quote: Fetch quote from TokenQuoter

2. Generate Parameters: Create swap parameters using SwapRouter

3. Token Approval: For ERC20 swaps, approve token spending

4. Execute Swap: Send transaction to Smart Router contract

5. Router Processing: Router handles the actual swap execution

🔧 Troubleshooting

Common Issues and Solutions

Rate Limiting (429 errors)

• Implement delays between operations (5 seconds recommended)

• Consider using a private RPC endpoint for high-frequency operations

Insufficient Balance

• Check balances before attempting swaps

• Ensure enough native tokens for gas fees

• Native swaps need value + gas, not just gas

No Route Found

• Some token pairs may not have sufficient liquidity

• Try smaller amounts or different token pairs

• Check pool availability on the relevant network

Gas Estimation Failed

• May indicate insufficient balance

• Check token approvals are in place

• Verify swap parameters are correct

Debug Tools

The example repository includes debug utilities:

# Check gas estimation issues
npm run debug:gas

# Test quoter with various token pairs
npm run debug:quote

# Debug swap parameters and calldata
npm run debug:swap

🤝 Support

For additional help:

• Check the complete example repository

• Review our Smart Contracts documentation

• Visit our API documentation

⚠️ Security Notice

• Never share or commit private keys

• Always test on testnet first

• Verify contract addresses before mainnet deployment

• Use appropriate slippage settings for your use case