SushiSwap V2 (sushiswap-v2)

In a Sauce program, swap with @sauce/router’s function for the venue (uniswapV2, uniswapV3, uniswapV4, curve, balancerV2, …; Slipstream, PancakeSwap V3 and Algebra pools through uniswapV3), with a minimum output and, where the pool takes one, a price limit (the @sauce/router reference; several pools under one limit, the distributed swap).

​

When to use it

• A Uniswap V2 fork: constant-product pairs, 0.3% fee, the same Router interface. Use it where its pair is deeper than Uniswap V2’s on the chain.

​

Pitfalls for a program

• As Uniswap V2: amountOutMin is the only bound; through the Router, approve exactly amountIn and pass a deadline.

​

In a Sauce program

import { uniswapV2 } from "@sauce/router";

function main(amountIn: Uint256, minOut: Uint256, recipient: Address) {
  const pair = SushiswapV2.Factory.getPair(USDC, WETH);
  require(pair != 0, "no USDC/WETH pair");
  uniswapV2(pair, USDC, WETH, amountIn, 3000, minOut, recipient);
}

​

What it offers

• swap: Swap exact input tokens through a routing path
• addLiquidity: Deposit two tokens to mint SLP (SushiSwap LP) tokens
• removeLiquidity: Burn SLP tokens to withdraw underlying tokens

​

Notes

• Interface is identical to Uniswap V2; same 0.3% fee per hop
• Factory and Router addresses are consistent across Arbitrum, Polygon, BSC, Avalanche, and Fantom
• SLP tokens can be staked in SushiSwap’s MasterChef/MiniChef contracts for SUSHI rewards (not in SDK)
• Both tokens must be ERC20-approved to the Router before swap/addLiquidity
• Use SushiSwap when Uniswap V2 is not deployed on the target chain, or when SUSHI farming incentives are active
• From a Pot program, @sauce/router trades a SushiSwap V2 pair directly, with no router and no approval: uniswapV2(pair, tokenIn, tokenOut, amountIn, 3000, minOut, recipient) reads the pair’s getReserves, prices the output in the program with the pair’s fee in parts per million, transfers the input to the pair and calls pair.swap with empty data, returning the amount out. The direction is the sort order of tokenIn and tokenOut (token0 is the lower address), so there is no argument to get wrong. The swap consumes its whole input or reverts; there is no refund path. tryUniswapV2 takes the same arguments and returns 0, moving nothing, when the pair cannot fill the whole input at the floor. The uniswapV2Swap action is the same call

​

Its names in a program

function main() {
  // Ethereum's factory, `0xC0AEe478e3658e2610c5F7A4A2E1777cE9e4f2Ac`.
  require(SushiswapV2.Factory != 0);
}

​

Deployments

​

ABI

​

SushiSwapV2FactoryABI

• getPair(address tokenA, address tokenB) view returns (address pair): the address is a SushiswapV2.Pair
• createPair(address tokenA, address tokenB) returns (address pair)

​

SushiSwapV2PairABI

• getReserves() view returns (uint112 _reserve0, uint112 _reserve1, uint32 _blockTimestampLast)
• token0() view returns (address): the address is a token
• token1() view returns (address): the address is a token
• swap(uint256 amount0Out, uint256 amount1Out, address to, bytes data)

​

SushiSwapV2RouterABI

• swapExactTokensForTokens(uint256 amountIn, uint256 amountOutMin, address[] path, address to, uint256 deadline) returns (uint256[] amounts)
• swapTokensForExactTokens(uint256 amountOut, uint256 amountInMax, address[] path, address to, uint256 deadline) returns (uint256[] amounts)
• addLiquidity(address tokenA, address tokenB, uint256 amountADesired, uint256 amountBDesired, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) returns (uint256 amountA, uint256 amountB, uint256 liquidity)
• removeLiquidity(address tokenA, address tokenB, uint256 liquidity, uint256 amountAMin, uint256 amountBMin, address to, uint256 deadline) returns (uint256 amountA, uint256 amountB)
• getAmountsOut(uint256 amountIn, address[] path) view returns (uint256[] amounts)

​

Next steps

• Protocols: the other protocols, by what they do.
• Protocols and tokens: calling a contract by its namespace, or through its ABI.
• Glossary: the words these pages use, in plain terms.