npm.io
5.15.0 • Published 2 weeks ago

@uniswap/universal-router-sdk

Licence
MIT
Version
5.15.0
Deps
17
Size
780 kB
Vulns
12
Weekly
0
SummaryDependencyVersions

universal-router-sdk

This SDK facilitates interactions with the contracts in Universal Router

Usage

Install latest version of universal-router-sdk. Then import the corresponding Trade class and Data object for each protocol you'd like to interact with.

Trading on Uniswap

warning: swapERC20CallParameters() to be deprecated in favor of swapCallParameters()

import { TradeType } from '@uniswap/sdk-core'
import { Trade as V2TradeSDK } from '@uniswap/v2-sdk'
import { Trade as V3TradeSDK } from '@uniswap/v3-sdk'
import { MixedRouteTrade, MixedRouteSDK, Trade as RouterTrade } from '@uniswap/router-sdk'

const options = { slippageTolerance, recipient }
const routerTrade = new RouterTrade({ v2Routes, v3Routes, mixedRoutes, tradeType: TradeType.EXACT_INPUT })
// Use the raw calldata and value returned to call into Universal Swap Router contracts
const { calldata, value } = SwapRouter.swapCallParameters(routerTrade, options)

This SDK has two entry points for encoding swap calldata:

  • SwapRouter.swapCallParameters(trade, options) — builds calldata from a high-level RouterTrade (shown above). Best when your swap fits as one or more independent linear routes through pools.
  • SwapRouter.encodeSwaps(spec, swapSteps) — takes Universal Router commands directly, with the SDK adding ingress, fee, and settlement calldata around them. Best for topologies that don't fit a Trade, routing-service integrations, or advanced V4 compositions. See Encoding Router-Provided Swap Steps.

Running this package

Make sure you are running node v18 Install dependencies and run typescript unit tests

yarn install
yarn test:hardhat

Run forge integration tests

forge install
yarn test:forge

Encoding Router-Provided Swap Steps (encodeSwaps)

SwapRouter.encodeSwaps(spec, swapSteps) is an alternative entry point for callers that already produce explicit SwapStep[] plans (e.g. routing services) and want the SDK to wrap them in a safety envelope. It decouples route topology from SDK trade construction.

The router owns swapSteps (V2/V3/V4 swaps + any WRAP_ETH / UNWRAP_WETH). The SDK owns ingress, fees, final settlement, exact-output refund, and optional safeMode.

Swap Step Types

Each SwapStep is a 1:1 representation of a Universal Router command:

  • V2_SWAP_EXACT_IN / V2_SWAP_EXACT_OUT — V2 swap (multi-hop via path: address[])
  • V3_SWAP_EXACT_IN / V3_SWAP_EXACT_OUT — V3 swap (multi-hop via packed path: bytes)
  • V4_SWAP — wraps a sequence of V4 actions (SWAP_EXACT_IN, SETTLE, TAKE, etc.) for the V4 router module
  • WRAP_ETH / UNWRAP_WETH — required when the route bridges native ETH and WETH

Routers compose these to express any supported route topology. The SDK does not infer wrap/unwrap commands — routers must include them when their route depends on it.

Basic Usage
import { SwapRouter, ROUTER_AS_RECIPIENT } from '@uniswap/universal-router-sdk'
import { CurrencyAmount, Percent, TradeType } from '@uniswap/sdk-core'

const { calldata, value } = SwapRouter.encodeSwaps(
  {
    tradeType: TradeType.EXACT_INPUT,
    routing: {
      inputToken: USDC,
      outputToken: WETH,
      amount: CurrencyAmount.fromRawAmount(USDC, '1000000000'),
      quote: CurrencyAmount.fromRawAmount(WETH, '500000000000000000'),
    },
    slippageTolerance: new Percent(50, 10000), // 0.5%
    recipient: '0x...',
  },
  [
    {
      type: 'V3_SWAP_EXACT_IN',
      recipient: ROUTER_AS_RECIPIENT,
      amountIn: '1000000000',
      amountOutMin: '0', // SDK enforces final slippage via the trailing SWEEP
      path: '0x...', // packed V3 path
    },
  ]
)
What the SDK adds around swapSteps
  1. Ingress: PERMIT2_TRANSFER_FROM for ERC20 input, or proxy.execute() wrapping for ApproveProxy. Native input flows through msg.value.
  2. Fee deduction before settlement: portion (PAY_PORTION / PAY_PORTION_FULL_PRECISION) on exact-input, flat (TRANSFER) on exact-output.
  3. Final SWEEP of outputToken to recipient with the slippage-bounded floor.
  4. Exact-output refund: SWEEPs unused input back to recipient.
  5. safeMode (optional): trailing zero-min ETH SWEEP to recover dust or unintended msg.value.
Constraints
  • By default, all swap step recipients must be ROUTER_AS_RECIPIENT and payerIsUser is false (ingress runs once up-front via PERMIT2_TRANSFER_FROM) — the SDK's settlement sweeps need router custody to see the funds. The optional allowDirectTransfers regime relaxes both (see Direct Transfers).
  • Routers must end with output in routing.outputToken. For exact-output, unused input must end in routing.inputToken.
  • The final top-level SWEEP is appended by the SDK — don't include it in swapSteps.
Direct Transfers (allowDirectTransfers)

By default every transfer routes through router custody. Setting allowDirectTransfers: true on the spec lets routing-supplied steps move funds directly between the user and the pools — pulling input straight from the user (payerIsUser on V2/V3 swaps and v4 SETTLE) and paying output straight to recipient — which removes the Permit2 ingress and the final sweep transfer for a simple swap.

The safety contract is unchanged (the user pays at most exactOrMaxAmountIn; the recipient receives at least the slippage-bounded minimum), but it's enforced by counting instead of custody:

  • Inbound budget — contract-enforced direct pulls must sum within exactOrMaxAmountIn; the SDK ingress pulls only the remainder.
  • Outbound coverage — contract-enforced direct-output minimums reduce the final SWEEP floor. Since independently-floored per-leg minimums can sum a few wei below the trade minimum, the floor forgives a bounded, sub-economic rounding shortfall (max(min(0.5bps of the minimum, 1% of slippage), a small per-leg allowance), zero at zero slippage); a larger, real gap still reverts.

Step amounts are never trusted — only counted or capped.

Per-Hop Slippage

Per-hop bounds require Universal Router v2.1.1+ — set urVersion: UniversalRouterVersion.V2_1_1 on spec to enable.

encodeSwaps accepts per-hop bounds as minHopPriceX36 on each swap step, matching the contract parameter name. The value is a 1e36-scaled price floor.

{
  type: 'V3_SWAP_EXACT_IN',
  // ...
  minHopPriceX36: ['995000000000000000000000000000000000', ...], // one per hop
}

Signed Routes (Universal Router v2.1)

Universal Router v2.1 supports EIP712-signed route execution, enabling gasless transactions and intent-based trading.

Important: The SDK does not perform signing. It provides utilities to prepare EIP712 payloads and encode signed calldata. You sign with your own mechanism (wallet, KMS, hardware, etc.).

Basic Flow
import { SwapRouter, NONCE_SKIP_CHECK } from '@uniswap/universal-router-sdk'
import { Wallet } from '@ethersproject/wallet'

const wallet = new Wallet('0x...')
const chainId = 1
const routerAddress = '0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD'
const deadline = Math.floor(Date.now() / 1000) + 60 * 20

// 1. Generate regular swap calldata
const { calldata, value } = SwapRouter.swapCallParameters(trade, {
  slippageTolerance: new Percent(50, 10000),
  recipient: wallet.address,
  deadline,
})

// 2. Get EIP712 payload to sign
const payload = SwapRouter.getExecuteSignedPayload(
  calldata,
  {
    intent: '0x' + '0'.repeat(64), // Application-specific intent
    data: '0x' + '0'.repeat(64), // Application-specific data
    sender: wallet.address, // Or address(0) to skip sender verification
  },
  deadline,
  chainId,
  routerAddress
)

// 3. Sign externally (wallet/KMS/hardware)
const signature = await wallet._signTypedData(payload.domain, payload.types, payload.value)

// 4. Encode for executeSigned()
const { calldata: signedCalldata, value: signedValue } = SwapRouter.encodeExecuteSigned(
  calldata,
  signature,
  {
    intent: payload.value.intent,
    data: payload.value.data,
    sender: payload.value.sender,
    nonce: payload.value.nonce, // Must match what was signed
  },
  deadline,
  BigNumber.from(value)
)

// 5. Submit transaction
await wallet.sendTransaction({
  to: routerAddress,
  data: signedCalldata,
  value: signedValue,
})
Nonce Management
  • Random nonce (default): Omit nonce parameter - SDK generates random nonce
  • Skip nonce check: Use NONCE_SKIP_CHECK sentinel to allow signature reuse
  • Custom nonce: Provide your own nonce for ordering
import { NONCE_SKIP_CHECK } from '@uniswap/universal-router-sdk'

// Reusable signature (no nonce check)
const payload = SwapRouter.getExecuteSignedPayload(
  calldata,
  {
    intent: '0x...',
    data: '0x...',
    sender: '0x0000000000000000000000000000000000000000', // Skip sender verification too
    nonce: NONCE_SKIP_CHECK, // Allow signature reuse
  },
  deadline,
  chainId,
  routerAddress
)
Sender Verification
  • Verify sender: Pass the actual sender address (e.g., wallet.address)
  • Skip verification: Pass '0x0000000000000000000000000000000000000000'

The SDK automatically sets verifySender based on whether sender is address(0).

Cross-Chain Bridging with Across (Universal Router v2.1)

Universal Router v2.1 integrates with Across Protocol V3 to enable seamless cross-chain bridging after swaps. This allows you to swap tokens on one chain and automatically bridge them to another chain in a single transaction.

Basic Usage
import { SwapRouter } from '@uniswap/universal-router-sdk'
import { BigNumber } from 'ethers'

// 1. Prepare your swap (e.g., USDC → WETH on mainnet)
const { calldata, value } = SwapRouter.swapCallParameters(trade, swapOptions, [
  {
    // Bridge configuration
    depositor: userAddress,
    recipient: userAddress, // Recipient on destination chain
    inputToken: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', // WETH mainnet
    outputToken: '0x4200000000000000000000000000000000000006', // WETH optimism
    inputAmount: BigNumber.from('1000000000000000000'), // 1 WETH
    outputAmount: BigNumber.from('990000000000000000'), // 0.99 WETH (with fees)
    destinationChainId: 10, // Optimism
    exclusiveRelayer: '0x0000000000000000000000000000000000000000',
    quoteTimestamp: Math.floor(Date.now() / 1000),
    fillDeadline: Math.floor(Date.now() / 1000) + 3600,
    exclusivityDeadline: 0,
    message: '0x',
    useNative: false,
  },
])
Swap + Bridge Example
// Swap USDC to WETH, then bridge WETH to Optimism
const bridgeParams = {
  depositor: userAddress,
  recipient: userAddress, // Can be different address on destination
  inputToken: WETH_MAINNET,
  outputToken: WETH_OPTIMISM,
  inputAmount: CONTRACT_BALANCE, // Use entire swap output
  outputAmount: expectedOutputAmount,
  destinationChainId: 10,
  exclusiveRelayer: '0x0000000000000000000000000000000000000000',
  quoteTimestamp: Math.floor(Date.now() / 1000),
  fillDeadline: Math.floor(Date.now() / 1000) + 3600,
  exclusivityDeadline: 0,
  message: '0x', // Optional message to execute on destination
  useNative: false, // Set to true to bridge native ETH
}

const { calldata, value } = SwapRouter.swapCallParameters(
  trade,
  swapOptions,
  [bridgeParams] // Array of bridge operations
)
Using CONTRACT_BALANCE

When bridging after a swap, you often don't know the exact output amount. Use CONTRACT_BALANCE to bridge the entire contract balance:

import { CONTRACT_BALANCE } from '@uniswap/universal-router-sdk'

const bridgeParams = {
  // ... other params
  inputAmount: CONTRACT_BALANCE, // Bridge entire balance after swap
  // ... other params
}
Multiple Bridge Operations

You can perform multiple bridge operations after a swap:

const { calldata, value } = SwapRouter.swapCallParameters(trade, swapOptions, [
  {
    // Bridge 50% to Optimism
    inputToken: WETH_MAINNET,
    outputToken: WETH_OPTIMISM,
    inputAmount: BigNumber.from('500000000000000000'),
    destinationChainId: 10,
    // ... other params
  },
  {
    // Bridge remaining USDC to Arbitrum
    inputToken: USDC_MAINNET,
    outputToken: USDC_ARBITRUM,
    inputAmount: CONTRACT_BALANCE,
    destinationChainId: 42161,
    // ... other params
  },
])
Native ETH Bridging

To bridge native ETH instead of WETH:

const bridgeParams = {
  inputToken: WETH_ADDRESS, // Must be WETH address
  outputToken: WETH_ON_DESTINATION,
  useNative: true, // Bridge as native ETH
  // ... other params
}
Important Notes
  1. Across Quote: Bridge parameters (especially outputAmount, quoteTimestamp, fillDeadline) should come from the Across API quote
  2. Recipient Address: Can be different from the sender, allowing cross-chain transfers to other addresses
  3. Message Passing: The message field allows executing arbitrary calls on the destination chain
  4. Slippage: The outputAmount already accounts for bridge fees and slippage

Keywords

uniswapethereum