API reference v1.0
Introduction
periphery
tokenomics
SwapRouter

SwapRouter

SwapRouter

Algebra Swap Router Router for stateless execution of swaps against Algebra

Functions

constructor

PeripheryImmutableState

constructor(address,address,address) public

NameTypeDescription
_factoryaddress
_WNativeTokenaddress
_poolDeployeraddress

algebraSwapCallback

algebraSwapCallback(int256,int256,bytes) external

Called to `msg.sender` after executing a swap via IAlgebraPool#swap.

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.
amount1Deltaint256The 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.
_databytes

exactInputSingle

checkDeadline

exactInputSingle(struct ISwapRouter.ExactInputSingleParams) payable external

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

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

Returns:

NameTypeDescription
amountOutuint256

exactInput

checkDeadline

exactInput(struct ISwapRouter.ExactInputParams) payable external

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

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

Returns:

NameTypeDescription
amountOutuint256

exactInputSingleSupportingFeeOnTransferTokens

checkDeadline

exactInputSingleSupportingFeeOnTransferTokens(struct ISwapRouter.ExactInputSingleParams) external

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

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

Returns:

NameTypeDescription
amountOutuint256

exactOutputSingle

checkDeadline

exactOutputSingle(struct ISwapRouter.ExactOutputSingleParams) payable external

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

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

Returns:

NameTypeDescription
amountInuint256

exactOutput

checkDeadline

exactOutput(struct ISwapRouter.ExactOutputParams) payable external

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

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

Returns:

NameTypeDescription
amountInuint256