Skip to content

Latest commit

 

History

History
228 lines (159 loc) · 8.76 KB

swaprouter.md

File metadata and controls

228 lines (159 loc) · 8.76 KB
Raw

Swap Router

Algebra Swap Router

Router for stateless execution of swaps against Algebra

Developer note: Credit to Uniswap Labs under GPL-2.0-or-later license: https://github.com/Uniswap/v3-periphery

Inherits: ISwapRouter PeripheryImmutableState PeripheryValidation PeripheryPaymentsWithFee Multicall SelfPermit

Structs

ExactInputSingleParams

struct ExactInputSingleParams {
  address tokenIn;
  address tokenOut;
  address recipient;
  uint256 deadline;
  uint256 amountIn;
  uint256 amountOutMinimum;
  uint160 limitSqrtPrice;
}

ExactInputParams

struct ExactInputParams {
  bytes path;
  address recipient;
  uint256 deadline;
  uint256 amountIn;
  uint256 amountOutMinimum;
}

ExactOutputSingleParams

struct ExactOutputSingleParams {
  address tokenIn;
  address tokenOut;
  address recipient;
  uint256 deadline;
  uint256 amountOut;
  uint256 amountInMaximum;
  uint160 limitSqrtPrice;
}

ExactOutputParams

struct ExactOutputParams {
  bytes path;
  address recipient;
  uint256 deadline;
  uint256 amountOut;
  uint256 amountInMaximum;
}

SwapCallbackData

struct SwapCallbackData {
  bytes path;
  address payer;
}

Functions

constructor

constructor(address _factory, address _WNativeToken, address _poolDeployer) public
Name Type Description
_factory address
_WNativeToken address
_poolDeployer address

algebraSwapCallback

function algebraSwapCallback(int256 amount0Delta, int256 amount1Delta, bytes _data) external

Selector: 0x2c8958f6

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

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

Name Type Description
amount0Delta int256 The 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

multicall

function multicall(bytes[] data) external payable returns (bytes[] results)

Selector: 0xac9650d8

Call multiple functions in the current contract and return the data from all of them if they all succeed

Developer note: The `msg.value` should not be trusted for any method callable from multicall.

Name Type Description
data bytes[] The encoded function data for each of the calls to make to this contract

Returns:

Name Type Description
results bytes[] The results from each of the calls passed in via data

exactInputSingle

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

Selector: 0xbc651188

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

Name Type Description
params struct ISwapRouter.ExactInputSingleParams The parameters necessary for the swap, encoded as ExactInputSingleParams in calldata

Returns:

Name Type Description
amountOut uint256 The amount of the received token

exactInput

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

Selector: 0xc04b8d59

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

Name Type Description
params struct ISwapRouter.ExactInputParams The parameters necessary for the multi-hop swap, encoded as ExactInputParams in calldata

Returns:

Name Type Description
amountOut uint256 The amount of the received token

exactInputSingleSupportingFeeOnTransferTokens

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

Selector: 0xb87d2524

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

Developer note: Unlike standard swaps, handles transferring from user before the actual swap.

Name Type Description
params struct ISwapRouter.ExactInputSingleParams The parameters necessary for the swap, encoded as ExactInputSingleParams in calldata

Returns:

Name Type Description
amountOut uint256 The amount of the received token

exactOutputSingle

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

Selector: 0x61d4d5b3

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

Name Type Description
params struct ISwapRouter.ExactOutputSingleParams The parameters necessary for the swap, encoded as ExactOutputSingleParams in calldata

Returns:

Name Type Description
amountIn uint256 The amount of the input token

exactOutput

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

Selector: 0xf28c0498

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

Name Type Description
params struct ISwapRouter.ExactOutputParams The parameters necessary for the multi-hop swap, encoded as ExactOutputParams in calldata

Returns:

Name Type Description
amountIn uint256 The amount of the input token