SDK Getting Started
Set up the Uniswap v2 SDK in your project and run your first TypeScript integration flow.
The Uniswap SDK exists to help developers build on top of Uniswap. It's designed to run in any environment that can execute JavaScript (think websites, node scripts, etc.). While simple enough to use in a hackathon project, it's also robust enough to power production applications.
Installation
The easiest way to consume the SDK is via npm. To install it in your project, simply run yarn add @uniswap/v2-sdk (or npm install @uniswap/v2-sdk). This also installs the sdk-core package used by the v2, v3 and v4 SDKs, plus ethers as a dependency.
Usage
To run code from the SDK in your application, use an import or require statement, depending on which your environment supports. Note that the guides following this page will use ES6Â syntax.
ES6 (Import)
import { ChainId } from '@uniswap/sdk-core'
import {Pair} from '@uniswap/v2-sdk'
console.log(`The chainId of mainnet is ${ChainId.MAINNET}.`)CommonJS (Require)
const CORE = require('@uniswap/sdk-core')
const V2_SDK = require('@uniswap/v2-sdk')
console.log(`The chainId of mainnet is ${CORE.ChainId.MAINNET}.`)Reference
Comprehensive reference material for the SDK is publicly available on the Uniswap Labs GitHub.
Where to Go Next
- Fetch token and pair state in Fetching Data
- Calculate route pricing in Pricing
- Build swap params in Trading
- Compute deterministic addresses in Pair Addresses