ISwapHelperUniswapV3

Interface for SwapHelperUniswapV3 smart contract.

Solidity API

ISwapHelperUniswapV3

SecondsAgoDefaultUpdated

event SecondsAgoDefaultUpdated(uint32 value)

Emitted when seconds ago default updated

Parameters

NameTypeDescription

value

uint32

The new param secondsAgoDefault

SlippageUpdated

event SlippageUpdated(uint256 value)

Emitted when slippage updated

Parameters

NameTypeDescription

value

uint256

The new slippage value, where 100% = 1000000

Swapped

event Swapped(address beneficiary, address tokenIn, address tokenOut, uint128 amountIn, uint256 amountOut)

Emitted when swap confirmed

Parameters

NameTypeDescription

beneficiary

address

Beneficiary output tokens after swap

tokenIn

address

Exchangeable token

tokenOut

address

The other of the two tokens in the desired pool

amountIn

uint128

The desired number of tokens for the exchange

amountOut

uint256

Average number of tokens amountOut in the selected time interval from the current moment and the pool

getAmountOut

function getAmountOut(address tokenIn, address tokenOut, uint128 amountIn, uint24 fee, uint32 secondsAgo) external view returns (uint256 amountOut)

Get the minimum number of tokens for a subsequent swap, taking into account slippage

tokenIn and tokenOut may be passed in either order: token0/token1 or token1/token0. The call will revert if the pool not already exists, the fee is invalid, or the token arguments are invalid. The minimum price is determined by a globally set parameter _slippage

Parameters

NameTypeDescription

tokenIn

address

One of the two tokens in the desired pool

tokenOut

address

The other of the two tokens in the desired pool

amountIn

uint128

The desired number of tokens for the exchange

fee

uint24

The desired fee for the pool

secondsAgo

uint32

The number of seconds from the current moment to calculate the average price

Return Values

NameTypeDescription

amountOut

uint256

Average number of tokens amountOut in the selected time interval from the current moment and the pool

swap

function swap(address beneficiary, address tokenIn, address tokenOut, uint128 amountIn, uint24 fee) external returns (uint256 amountOut)

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

tokenIn and tokenOut may be passed in either order: token0/token1 or token1/token0. The call will revert if the pool not already exists, the fee is invalid, or the token arguments are invalid. The minimum price is determined by a globally set parameter _slippage

Parameters

NameTypeDescription

beneficiary

address

Beneficiary amountOut after swap

tokenIn

address

Exchangeable token

tokenOut

address

Output token during the exchange

amountIn

uint128

The desired number of tokens for the exchange

fee

uint24

The desired fee for the pool

Return Values

NameTypeDescription

amountOut

uint256

The number of tokens at the exit after the swap

Last updated