SwapRouter
Router for stateless execution of swaps against Pegasys V3
Input parameters are viewable on the Swap Router Interface
Functions
constructor
function constructor(
) public
pegasysV3SwapCallback
function pegasysV3SwapCallback(
int256 amount0Delta,
int256 amount1Delta,
bytes data
) external
Called to msg.sender after executing a swap via IPegasysV3Pool#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 PegasysV3Pool deployed by the canonical PegasysV3Factory. amount0Delta and amount1Delta can both be 0 if no tokens were swapped.
Parameters:
| 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 | Any data passed through by the caller via the IPegasysV3PoolActions#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:
| Name | Type | Description |
|---|---|---|
params | struct ISwapRouter.ExactInputSingleParams | The parameters necessary for the swap, encoded as ExactInputSingleParams in calldata |
Return Values:
| Name | Type | Description |
|---|---|---|
amountOut | uint256 | The 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:
| Name | Type | Description |
|---|---|---|
params | struct ISwapRouter.ExactInputParams | The parameters necessary for the multi-hop swap, encoded as ExactInputParams in calldata |
Return Values:
| Name | Type | Description |
|---|---|---|
amountOut | uint256 | The 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:
| Name | Type | Description |
|---|---|---|
params | struct ISwapRouter.ExactOutputSingleParams | The parameters necessary for the swap, encoded as ExactOutputSingleParams in calldata |
Return Values:
| Name | Type | Description |
|---|---|---|
amountIn | uint256 | The 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:
| Name | Type | Description |
|---|---|---|
params | struct ISwapRouter.ExactOutputParams | The parameters necessary for the multi-hop swap, encoded as ExactOutputParams in calldata |
Return Values:
| Name | Type | Description |
|---|---|---|
amountIn | uint256 | The amount of the input token |