Router
Last updated
Last updated
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.
Returns factory address.
Returns the canonical WSEI address on the SEI V2 mainnet.
See .
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
See .
See .
See .
See .
Removes liquidity from an ERC-20โERC-20 pool without pre-approval, thanks to .
Removes liquidity from an ERC-20โWSEI pool and receive SEI without pre-approval, thanks to .
Identical to , but succeeds for tokens that take a fee on transfer.
Identical to , but succeeds for tokens that take a fee on transfer.
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 , 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).
Identical to , but succeeds for tokens that take a fee on transfer.
Identical to , but succeeds for tokens that take a fee on transfer.
Identical to , but succeeds for tokens that take a fee on transfer.