V3 SDK

The V3 SDK (@uniswap/v3-sdk-next) provides tools for building on Uniswap V3's concentrated liquidity protocol. It includes entities for pools, positions, and trades, along with comprehensive contract interfaces.

Features

• Concentrated Liquidity: Position liquidity in specific price ranges
• Multiple Fee Tiers: Choose from 0.01%, 0.05%, 0.3%, or 1% fee tiers
• NFT Positions: Manage positions as unique NFTs
• Full Math Library: Tick math, sqrt price math, and liquidity calculations

Installation

npm install @uniswap/v3-sdk-next

pnpm add @uniswap/v3-sdk-next

yarn add @uniswap/v3-sdk-next

Quick Start

import { Pool, Position, nearestUsableTick, FeeAmount } from '@uniswap/v3-sdk-next'
import { Token, CurrencyAmount } from '@uniswap/sdk-core-next'
 
// Define tokens
const WETH = new Token(1, '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', 18, 'WETH')
const USDC = new Token(1, '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', 6, 'USDC')
 
// Create a pool (data typically fetched from chain)
const pool = new Pool(
  WETH,
  USDC,
  FeeAmount.MEDIUM,      // 0.3% fee
  '1234567890123456789', // sqrtPriceX96
  '1000000000000000000', // liquidity
  -58000                 // tickCurrent
)
 
// Get the pool price
console.log(pool.token0Price.toSignificant(6))
 
// Create a position in a price range
const position = new Position({
  pool,
  liquidity: 1000000n,
  tickLower: nearestUsableTick(-60000, pool.tickSpacing),
  tickUpper: nearestUsableTick(-56000, pool.tickSpacing),
})
 
// Get position amounts
console.log(position.amount0.toSignificant(6))
console.log(position.amount1.toSignificant(6))

How V3 Works

Uniswap V3 introduces concentrated liquidity:

• Price Ranges: LPs provide liquidity within specific price ranges
• Capital Efficiency: Up to 4000x more capital efficient than V2
• Tick-based Pricing: Prices are tracked in discrete "ticks"
• NFT Positions: Each position is a unique NFT with its own range

Fee Tiers

Modules

Entities

• Pool - V3 pool representation with tick-based pricing
• Position - LP position in a specific price range
• Route - Sequence of pools for a trade path
• Trade - Represents a swap with slippage handling
• Tick - Tick data structure
• TickDataProvider - Interface for tick data access

Contracts

• SwapRouter - Swap execution interface
• NFTPositionManager - Position management
• Quoter - Quote swap amounts
• Staker - Liquidity mining interface
• Multicall - Batch multiple calls
• Payments - ETH and token payment helpers
• SelfPermit - Permit2 integration

Utilities

• computePoolAddress - Calculate pool addresses
• encodeSqrtRatioX96 - Encode prices
• tickMath - Tick to price conversions
• sqrtPriceMath - Sqrt price calculations
• maxLiquidityForAmounts - Liquidity calculations
• priceTickConversions - Price/tick helpers
• encodeRouteToPath - Encode routes for contracts

Reference

• Constants - Fee amounts, factory addresses, and more