Router
Because routers are stateless and do not hold token balances, they can be replaced safely and trustlessly, if necessary. This may happen if more efficient smart contract patterns are discovered, or if additional functionality is desired.
Code
Read-Only Functions
factory
function factory() external pure returns (address);
Returns factory address.
WSEI
function WSEI() external pure returns (address);
Returns the canonical WSEI address on the SEI V2 mainnet.
quote
See quote.
getAmountOut
See getAmountOut.
getAmountIn
See getAmountIn.
getAmountsOut
function getAmountsOut(uint amountIn, address[] memory path) public view returns (uint[] memory amounts);
See getAmountsOut.
getAmountsIn
function getAmountsIn(uint amountOut, address[] memory path) public view returns (uint[] memory amounts);
See getAmountsIn.
State-Changing Functions
addLiquidity
function addLiquidity(
address tokenA,
address tokenB,
uint amountADesired,
uint amountBDesired,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB, uint liquidity);
Adds liquidity to an ERC-20⇄ERC-20 pool.
To cover all possible scenarios,
msg.sender
should have already given the router an allowance of at least amountADesired/amountBDesired on tokenA/tokenB.Always adds assets at the ideal ratio, according to the price when the transaction is executed.
If a pool for the passed tokens does not exists, one is created automatically, and exactly amountADesired/amountBDesired tokens are added.
tokenA
address
A pool token.
tokenB
address
A pool token.
amountADesired
uint
The amount of tokenA to add as liquidity if the B/A price is <= amountBDesired/amountADesired (A depreciates).
amountBDesired
uint
The amount of tokenB to add as liquidity if the A/B price is <= amountADesired/amountBDesired (B depreciates).
amountAMin
uint
Bounds the extent to which the B/A price can go up before the transaction reverts. Must be <= amountADesired.
amountBMin
uint
Bounds the extent to which the A/B price can go up before the transaction reverts. Must be <= amountBDesired.
to
address
Recipient of the liquidity tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
amountA
uint
The amount of tokenA sent to the pool.
amountB
uint
The amount of tokenB sent to the pool.
liquidity
uint
The amount of liquidity tokens minted.
addLiquiditySEI
function addLiquiditySEI(
address token,
uint amountTokenDesired,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline
) external payable returns (uint amountToken, uint amountSEI, uint liquidity);
Adds liquidity to an ERC-20⇄WSEI pool with SEI.
To cover all possible scenarios,
msg.sender
should have already given the router an allowance of at least amountTokenDesired on token.Always adds assets at the ideal ratio, according to the price when the transaction is executed.
msg.value
is treated as a amountSEIDesired.Leftover SEI, if any, is returned to
msg.sender
.If a pool for the passed token and WSEI does not exists, one is created automatically, and exactly amountTokenDesired/
msg.value
tokens are added.
token
address
A pool token.
amountTokenDesired
uint
The amount of token to add as liquidity if the WSEI/token price is <= msg.value
/amountTokenDesired (token depreciates).
msg.value
(amountSEIDesired)
uint
The amount of SEI to add as liquidity if the token/WSEI price is <= amountTokenDesired/msg.value
(WSEI depreciates).
amountTokenMin
uint
Bounds the extent to which the WSEI/token price can go up before the transaction reverts. Must be <= amountTokenDesired.
amountSEIMin
uint
Bounds the extent to which the token/WSEI price can go up before the transaction reverts. Must be <= msg.value
.
to
address
Recipient of the liquidity tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
amountToken
uint
The amount of token sent to the pool.
amountSEI
uint
The amount of SEI converted to WSEI and sent to the pool.
liquidity
uint
The amount of liquidity tokens minted.
removeLiquidity
function removeLiquidity(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB);
Removes liquidity from an ERC-20⇄ERC-20 pool.
msg.sender
should have already given the router an allowance of at least liquidity on the pool.
tokenA
address
A pool token.
tokenB
address
A pool token.
liquidity
uint
The amount of liquidity tokens to remove.
amountAMin
uint
The minimum amount of tokenA that must be received for the transaction not to revert.
amountBMin
uint
The minimum amount of tokenB that must be received for the transaction not to revert.
to
address
Recipient of the underlying assets.
deadline
uint
Unix timestamp after which the transaction will revert.
amountA
uint
The amount of tokenA received.
amountB
uint
The amount of tokenB received.
removeLiquiditySEI
function removeLiquiditySEI(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline
) external returns (uint amountToken, uint amountSEI);
Removes liquidity from an ERC-20⇄WSEI pool and receive SEI.
msg.sender
should have already given the router an allowance of at least liquidity on the pool.
token
address
A pool token.
liquidity
uint
The amount of liquidity tokens to remove.
amountTokenMin
uint
The minimum amount of token that must be received for the transaction not to revert.
amountSEIMin
uint
The minimum amount of SEI that must be received for the transaction not to revert.
to
address
Recipient of the underlying assets.
deadline
uint
Unix timestamp after which the transaction will revert.
amountToken
uint
The amount of token received.
amountSEI
uint
The amount of SEI received.
removeLiquidityWithPermit
function removeLiquidityWithPermit(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountA, uint amountB);
Removes liquidity from an ERC-20⇄ERC-20 pool without pre-approval, thanks to permit.
tokenA
address
A pool token.
tokenB
address
A pool token.
liquidity
uint
The amount of liquidity tokens to remove.
amountAMin
uint
The minimum amount of tokenA that must be received for the transaction not to revert.
amountBMin
uint
The minimum amount of tokenB that must be received for the transaction not to revert.
to
address
Recipient of the underlying assets.
deadline
uint
Unix timestamp after which the transaction will revert.
approveMax
bool
Whether or not the approval amount in the signature is for liquidity or uint(-1)
.
v
uint8
The v component of the permit signature.
r
bytes32
The r component of the permit signature.
s
bytes32
The s component of the permit signature.
amountA
uint
The amount of tokenA received.
amountB
uint
The amount of tokenB received.
removeLiquiditySEIWithPermit
function removeLiquiditySEIWithPermit(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountToken, uint amountSEI);
Removes liquidity from an ERC-20⇄WSEI pool and receive SEI without pre-approval, thanks to permit.
token
address
A pool token.
liquidity
uint
The amount of liquidity tokens to remove.
amountTokenMin
uint
The minimum amount of token that must be received for the transaction not to revert.
amountSEIMin
uint
The minimum amount of SEI that must be received for the transaction not to revert.
to
address
Recipient of the underlying assets.
deadline
uint
Unix timestamp after which the transaction will revert.
approveMax
bool
Whether or not the approval amount in the signature is for liquidity or uint(-1)
.
v
uint8
The v component of the permit signature.
r
bytes32
The r component of the permit signature.
s
bytes32
The s component of the permit signature.
amountToken
uint
The amount of token received.
amountSEI
uint
The amount of SEI received.
removeLiquiditySEISupportingFeeOnTransferTokens
function removeLiquiditySEISupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline
) external returns (uint amountSEI);
Identical to removeLiquiditySEI, but succeeds for tokens that take a fee on transfer.
msg.sender
should have already given the router an allowance of at least liquidity on the pool.
token
address
A pool token.
liquidity
uint
The amount of liquidity tokens to remove.
amountTokenMin
uint
The minimum amount of token that must be received for the transaction not to revert.
amountSEIMin
uint
The minimum amount of SEI that must be received for the transaction not to revert.
to
address
Recipient of the underlying assets.
deadline
uint
Unix timestamp after which the transaction will revert.
amountSEI
uint
The amount of SEI received.
removeLiquiditySEIWithPermitSupportingFeeOnTransferTokens
function removeLiquiditySEIWithPermitSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountSEI);
Identical to removeLiquiditySEIWithPermit, but succeeds for tokens that take a fee on transfer.
token
address
A pool token.
liquidity
uint
The amount of liquidity tokens to remove.
amountTokenMin
uint
The minimum amount of token that must be received for the transaction not to revert.
amountSEIMin
uint
The minimum amount of SEI that must be received for the transaction not to revert.
to
address
Recipient of the underlying assets.
deadline
uint
Unix timestamp after which the transaction will revert.
approveMax
bool
Whether or not the approval amount in the signature is for liquidity or uint(-1)
.
v
uint8
The v component of the permit signature.
r
bytes32
The r component of the permit signature.
s
bytes32
The s component of the permit signature.
amountSEI
uint
The amount of SEI received.
swapExactTokensForTokens
function swapExactTokensForTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
Swaps an exact amount of input tokens for as many output tokens as possible, along the route determined by the path. The first element of path is the input token, the last is the output token, and any intermediate elements represent intermediate pairs to trade through (if, for example, a direct pair does not exist).
msg.sender
should have already given the router an allowance of at least amountIn on the input token.
amountIn
uint
The amount of input tokens to send.
amountOutMin
uint
The minimum amount of output tokens that must be received for the transaction not to revert.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the output tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
amounts
uint[] memory
The input token amount and all subsequent output token amounts.
swapTokensForExactTokens
function swapTokensForExactTokens(
uint amountOut,
uint amountInMax,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
Receive an exact amount of output tokens for as few input tokens as possible, along the route determined by the path. The first element of path is the input token, the last is the output token, and any intermediate elements represent intermediate tokens to trade through (if, for example, a direct pair does not exist).
msg.sender
should have already given the router an allowance of at least amountInMax on the input token.
amountOut
uint
The amount of output tokens to receive.
amountInMax
uint
The maximum amount of input tokens that can be required before the transaction reverts.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the output tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
amounts
uint[] memory
The input token amount and all subsequent output token amounts.
swapExactSEIForTokens
function swapExactSEIForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
Swaps an exact amount of SEI for as many output tokens as possible, along the route determined by the path. The first element of path must be WSEI, the last is the output token, and any intermediate elements represent intermediate pairs to trade through (if, for example, a direct pair does not exist).
msg.value
(amountIn)
uint
The amount of SEI to send.
amountOutMin
uint
The minimum amount of output tokens that must be received for the transaction not to revert.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the output tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
amounts
uint[] memory
The input token amount and all subsequent output token amounts.
swapTokensForExactSEI
function swapTokensForExactSEI(uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
Receive an exact amount of SEI for as few input tokens as possible, along the route determined by the path. The first element of path is the input token, the last must be WSEI, and any intermediate elements represent intermediate pairs to trade through (if, for example, a direct pair does not exist).
msg.sender
should have already given the router an allowance of at least amountInMax on the input token.If the to address is a smart contract, it must have the ability to receive SEI.
amountOut
uint
The amount of SEI to receive.
amountInMax
uint
The maximum amount of input tokens that can be required before the transaction reverts.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of SEI.
deadline
uint
Unix timestamp after which the transaction will revert.
amounts
uint[] memory
The input token amount and all subsequent output token amounts.
swapExactTokensForSEI
function swapExactTokensForSEI(uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
Swaps an exact amount of tokens for as much SEI as possible, along the route determined by the path. The first element of path is the input token, the last must be WSEI, and any intermediate elements represent intermediate pairs to trade through (if, for example, a direct pair does not exist).
If the to address is a smart contract, it must have the ability to receive SEI.
amountIn
uint
The amount of input tokens to send.
amountOutMin
uint
The minimum amount of output tokens that must be received for the transaction not to revert.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the SEI.
deadline
uint
Unix timestamp after which the transaction will revert.
amounts
uint[] memory
The input token amount and all subsequent output token amounts.
swapSEIForExactTokens
function swapSEIForExactTokens(uint amountOut, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
Receive an exact amount of tokens for as little SEIas possible, along the route determined by the path. The first element of path must be WETH, the last is the output token and any intermediate elements represent intermediate pairs to trade through (if, for example, a direct pair does not exist).
Leftover SEI, if any, is returned to
msg.sender
.
amountOut
uint
The amount of tokens to receive.
msg.value
(amountInMax)
uint
The maximum amount of SEI that can be required before the transaction reverts.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the output tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
amounts
uint[] memory
The input token amount and all subsequent output token amounts.
swapExactTokensForTokensSupportingFeeOnTransferTokens
function swapExactTokensForTokensSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
Identical to swapExactTokensForTokens, but succeeds for tokens that take a fee on transfer.
msg.sender
should have already given the router an allowance of at least amountIn on the input token.
amountIn
uint
The amount of input tokens to send.
amountOutMin
uint
The minimum amount of output tokens that must be received for the transaction not to revert.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the output tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
swapExactSEIForTokensSupportingFeeOnTransferTokens
function swapExactSEIForTokensSupportingFeeOnTransferTokens(
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external payable;
Identical to swapExactSEIForTokens, but succeeds for tokens that take a fee on transfer.
msg.value
(amountIn)
uint
The amount of SEI to send.
amountOutMin
uint
The minimum amount of output tokens that must be received for the transaction not to revert.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the output tokens.
deadline
uint
Unix timestamp after which the transaction will revert.
swapExactTokensForSEISupportingFeeOnTransferTokens
function swapExactTokensForSEISupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
Identical to swapExactTokensForSEI, but succeeds for tokens that take a fee on transfer.
If the to address is a smart contract, it must have the ability to receive SEI.
amountIn
uint
The amount of input tokens to send.
amountOutMin
uint
The minimum amount of output tokens that must be received for the transaction not to revert.
path
address[] calldata
An array of token addresses. path.length
must be >= 2. Pools for each consecutive pair of addresses must exist and have liquidity.
to
address
Recipient of the SEI.
deadline
uint
Unix timestamp after which the transaction will revert.
Interface
pragma solidity >=0.6.2;
interface IDragonswapRouter {
function factory() external pure returns (address);
function WSEI() external pure returns (address);
function quote(uint amountA, uint reserveA, uint reserveB) external pure returns (uint amountB);
function getAmountOut(uint amountIn, uint reserveIn, uint reserveOut) external pure returns (uint amountOut);
function getAmountIn(uint amountOut, uint reserveIn, uint reserveOut) external pure returns (uint amountIn);
function getAmountsOut(uint amountIn, address[] calldata path) external view returns (uint[] memory amounts);
function getAmountsIn(uint amountOut, address[] calldata path) external view returns (uint[] memory amounts);
function addLiquidity(
address tokenA,
address tokenB,
uint amountADesired,
uint amountBDesired,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB, uint liquidity);
function addLiquiditySEI(
address token,
uint amountTokenDesired,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline
) external payable returns (uint amountToken, uint amountSEI, uint liquidity);
function removeLiquidity(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline
) external returns (uint amountA, uint amountB);
function removeLiquiditySEI(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline
) external returns (uint amountToken, uint amountSEI);
function removeLiquidityWithPermit(
address tokenA,
address tokenB,
uint liquidity,
uint amountAMin,
uint amountBMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountA, uint amountB);
function removeLiquiditySEIWithPermit(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountToken, uint amountSEI);
function swapExactTokensForTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
function swapTokensForExactTokens(
uint amountOut,
uint amountInMax,
address[] calldata path,
address to,
uint deadline
) external returns (uint[] memory amounts);
function swapExactSEIForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
function swapTokensForExactSEI(uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapExactTokensForSEI(uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapSEIForExactTokens(uint amountOut, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
function removeLiquiditySEISupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline
) external returns (uint amountSEI);
function removeLiquiditySEIWithPermitSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountSEIMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountSEI);
function swapExactTokensForTokensSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
function swapExactSEIForTokensSupportingFeeOnTransferTokens(
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external payable;
function swapExactTokensForSEISupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
}
ABI
Last updated