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.
Address
ZeniqSwapRouter
is deployed at 0x7963c1bd24E4511A0b14bf148F93e2556AFe3C27
on the Zeniq Smart Chain.
Read-Only Functions
factoryβ
function factory() external pure returns (address);
Returns factory address.
WZENIQβ
function WETH() external pure returns (address);
Returns the WZENIQ Address: 0x74DC1C4ec10abE9F5C8A3EabF1A90b97cDc3Ead8
deployed on the Zeniq Smart Chain
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 ZEN-20βZEN-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.
Name | Type | |
---|---|---|
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. |
addLiquidityETHβ
function addLiquidityETH(
address token,
uint amountTokenDesired,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external payable returns (uint amountToken, uint amountETH, uint liquidity);
Adds liquidity to an ZEN-20βWZENIQ pool with ETH.
- 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 amountZENIQDesired.- Leftover ZENIQ, if any, is returned to
msg.sender
. - If a pool for the passed token and WZENIQ does not exists, one is created automatically, and exactly amountTokenDesired/
msg.value
tokens are added.
Name | Type | |
---|---|---|
token | address | A pool token. |
amountTokenDesired | uint | The amount of token to add as liquidity if the WZENIQ/token price is <= msg.value /amountTokenDesired (token depreciates). |
msg.value (amountZENIQDesired) | uint | The amount of ZENIQ to add as liquidity if the token/WZENIQ price is <= amountTokenDesired/msg.value (WZENIQ depreciates). |
amountTokenMin | uint | Bounds the extent to which the WZENIQ/token price can go up before the transaction reverts. Must be <= amountTokenDesired. |
amountETHMin | uint | Bounds the extent to which the token/WZENIQ 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. |
amountETH | uint | The amount of ZENIQ converted to WZENIQ 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 ZEN-20βZEN-20 pool.
msg.sender
should have already given the router an allowance of at least liquidity on the pool.
Name | Type | |
---|---|---|
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. |
removeLiquidityETHβ
function removeLiquidityETH(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountToken, uint amountETH);
Removes liquidity from an ZEN-20βWZENIQ pool and receive ZENIQ.
msg.sender
should have already given the router an allowance of at least liquidity on the pool.
Name | Type | |
---|---|---|
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. |
amountETHMin | uint | The minimum amount of ZENIQ 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. |
amountETH | uint | The amount of ZENIQ 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 ZEN-20βZEN-20 pool without pre-approval.
Name | Type | |
---|---|---|
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. |
removeLiquidityETHWithPermitβ
function removeLiquidityETHWithPermit(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountToken, uint amountETH);
Removes liquidity from an ZEN-20βWZENIQ pool and receive ZENIQ without pre-approval.
Name | Type | |
---|---|---|
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. |
amountETHMin | uint | The minimum amount of ZENIQ 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. |
amountETH | uint | The amount of ZENIQ received. |
removeLiquidityETHSupportingFeeOnTransferTokensβ
function removeLiquidityETHSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountETH);
Identical to removeLiquidityETH, 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.
Name | Type | |
---|---|---|
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. |
amountETHMin | uint | The minimum amount of ZENIQ 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. |
amountETH | uint | The amount of ZENIQ received. |
removeLiquidityETHWithPermitSupportingFeeOnTransferTokensβ
function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountETH);
Identical to removeLiquidityETHWithPermit, but succeeds for tokens that take a fee on transfer.
Name | Type | |
---|---|---|
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. |
amountETHMin | uint | The minimum amount of ZENIQ 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. |
amountETH | uint | The amount of ZENIQ 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.
Name | Type | |
---|---|---|
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.
Name | Type | |
---|---|---|
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. |
swapExactETHForTokensβ
function swapExactETHForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
Swaps an exact amount of ZENIQ for as many output tokens as possible, along the route determined by the path. The first element of path must be WZENIQ, 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).
Name | Type | |
---|---|---|
msg.value (amountIn) | uint | The amount of ZENIQ 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. |
swapTokensForExactETHβ
function swapTokensForExactETH(uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
Receive an exact amount of ZENIQ 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 WZENIQ, 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 ZENIQ.
Name | Type | |
---|---|---|
amountOut | uint | The amount of ZENIQ 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 ZENIQ. |
deadline | uint | Unix timestamp after which the transaction will revert. |
amounts | uint[] memory | The input token amount and all subsequent output token amounts. |
swapExactTokensForETHβ
function swapExactTokensForETH(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 ZENIQ as possible, along the route determined by the path. The first element of path is the input token, the last must be WZENIQ, 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 ZENIQ.
Name | Type | |
---|---|---|
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 ZENIQ. |
deadline | uint | Unix timestamp after which the transaction will revert. |
amounts | uint[] memory | The input token amount and all subsequent output token amounts. |
swapETHForExactTokensβ
function swapETHForExactTokens(uint amountOut, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
Receive an exact amount of tokens for as little ZENIQ as possible, along the route determined by the path. The first element of path must be WZENIQ, 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 ZENIQ, if any, is returned to
msg.sender
.
Name | Type | |
---|---|---|
amountOut | uint | The amount of tokens to receive. |
msg.value (amountInMax) | uint | The maximum amount of ZENIQ 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.
Name | Type | |
---|---|---|
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. |
swapExactETHForTokensSupportingFeeOnTransferTokensβ
function swapExactETHForTokensSupportingFeeOnTransferTokens(
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external payable;
Identical to swapExactETHForTokens, but succeeds for tokens that take a fee on transfer.
Name | Type | |
---|---|---|
msg.value (amountIn) | uint | The amount of ZENIQ 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. |
swapExactTokensForETHSupportingFeeOnTransferTokensβ
function swapExactTokensForETHSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
Identical to swapExactTokensForETH, 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 ZENIQ.
Name | Type | |
---|---|---|
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 ZENIQ. |
deadline | uint | Unix timestamp after which the transaction will revert. |
Interface
pragma solidity >=0.6.2;
interface IZeniqSwapRouter01 {
function factory() external pure returns (address);
function WETH() external pure returns (address);
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 addLiquidityETH(
address token,
uint amountTokenDesired,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external payable returns (uint amountToken, uint amountETH, 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 removeLiquidityETH(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountToken, uint amountETH);
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 removeLiquidityETHWithPermit(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountToken, uint amountETH);
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 swapExactETHForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
function swapTokensForExactETH(uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapExactTokensForETH(uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
external
returns (uint[] memory amounts);
function swapETHForExactTokens(uint amountOut, address[] calldata path, address to, uint deadline)
external
payable
returns (uint[] memory amounts);
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);
}
interface IZeniqSwapRouter02 is IZeniqSwapRouter01 {
function removeLiquidityETHSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external returns (uint amountETH);
function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
address token,
uint liquidity,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline,
bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint amountETH);
function swapExactTokensForTokensSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
function swapExactETHForTokensSupportingFeeOnTransferTokens(
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external payable;
function swapExactTokensForETHSupportingFeeOnTransferTokens(
uint amountIn,
uint amountOutMin,
address[] calldata path,
address to,
uint deadline
) external;
}