Skip to main content

SwapRouter

Router for stateless execution of swaps against Uniswap V3

Input parameters are viewable on the Swap Router Interface

Functions#

constructor#

function constructor(
) public

uniswapV3SwapCallback#

function uniswapV3SwapCallback(
int256 amount0Delta,
int256 amount1Delta,
bytes data
) external

Called to msg.sender after executing a swap via IUniswapV3Pool#swap.

In the implementation you must pay the pool tokens owed for the swap. The caller of this method must be checked to be a UniswapV3Pool deployed by the canonical UniswapV3Factory. amount0Delta and amount1Delta can both be 0 if no tokens were swapped.

Parameters:#

NameTypeDescription
amount0Deltaint256The amount of token0 that was sent (negative) or must be received (positive) by the pool by

the end of the swap. If positive, the callback must send that amount of token0 to the pool. |amount1Delta | int256 | The amount of token1 that was sent (negative) or must be received (positive) by the pool by the end of the swap. If positive, the callback must send that amount of token1 to the pool. |data | bytes | Any data passed through by the caller via the IUniswapV3PoolActions#swap call

exactInputSingle#

function exactInputSingle(
struct ISwapRouter.ExactInputSingleParams params
) external returns (uint256 amountOut)

Swaps amountIn of one token for as much as possible of another token

Parameters:#

NameTypeDescription
paramsstruct ISwapRouter.ExactInputSingleParamsThe parameters necessary for the swap, encoded as ExactInputSingleParams in calldata

Return Values:#

NameTypeDescription
amountOutuint256The amount of the received token

exactInput#

function exactInput(
struct ISwapRouter.ExactInputParams params
) external returns (uint256 amountOut)

Swaps amountIn of one token for as much as possible of another along the specified path

Parameters:#

NameTypeDescription
paramsstruct ISwapRouter.ExactInputParamsThe parameters necessary for the multi-hop swap, encoded as ExactInputParams in calldata

Return Values:#

NameTypeDescription
amountOutuint256The amount of the received token

exactOutputSingle#

function exactOutputSingle(
struct ISwapRouter.ExactOutputSingleParams params
) external returns (uint256 amountIn)

Swaps as little as possible of one token for amountOut of another token

Parameters:#

NameTypeDescription
paramsstruct ISwapRouter.ExactOutputSingleParamsThe parameters necessary for the swap, encoded as ExactOutputSingleParams in calldata

Return Values:#

NameTypeDescription
amountInuint256The amount of the input token

exactOutput#

function exactOutput(
struct ISwapRouter.ExactOutputParams params
) external returns (uint256 amountIn)

Swaps as little as possible of one token for amountOut of another along the specified path (reversed)

Parameters:#

NameTypeDescription
paramsstruct ISwapRouter.ExactOutputParamsThe parameters necessary for the multi-hop swap, encoded as ExactOutputParams in calldata

Return Values:#

NameTypeDescription
amountInuint256The amount of the input token