UnifiRouter.sol
Primary Uses - The uTrade V2 Router is the 'brain' of uTrade. The router finds the optimal path for exchanging one token for another. Whenever a trade is made, your wallet sends funds to the router address. The router will then carry out as many transactions as necessary to acquire the desired token. The router also handles adding liquidity to liquidity pools, and sending the corresponding LP tokens to liquidity providers.
Primary Uses - The uTrade V2 Router is the 'brain' of uTrade. The router finds the optimal path for exchanging one token for another. Whenever a trade is made, your wallet sends funds to the router address. The router will then carry out as many transactions as necessary to acquire the desired token. The router also handles adding liquidity to liquidity pools, and sending the corresponding LP tokens to liquidity providers.
Network | Address |
BitTorrent Chain | |
​ | ​ |
function factory() external pure returns (address);
A call to the
factory
function returns the address of the current Factory used by uTrade v2. The current factory address for uTrade V2 on BTTC is 0xCAaB36C77841647dC9955B3b1D03710E9B9F127f
.function WETH() external pure returns (address);
A call to the
WETH
function returns the address of Wrapped BTT (WBTT) on BitTorrent Chain. As this address does not change, it will always return 0x8D193c6efa90BCFf940A98785d1Ce9D093d3DC8A
.function quote(uint amountA, uint reserveA, uint reserveB) external pure returns (uint amountB);
A call to the
quote
function returns the amount of tokenB that will be received for an amount of tokenA. This can be used to calculate the exchange rate between two tokens without factoring in slippage or fees. By entering the amount of tokenA, the total amount of reserves of tokenA as reserveA, and the total amount of reserves of tokenB as reserveB, the call will return the equivalent amount of tokenB.function getAmountOut(uint amountIn, uint reserveIn, uint reserveOut, uint fee) external pure returns (uint amountOut);
A call to the
getAmountOut
function with the amount of the token being sent will return the maximum amount of a token to be received, accounting for fees and the total amount of reserves.function getAmountIn(uint amountOut, uint reserveIn, uint reserveOut, uint fee) external pure returns (uint amountIn);
A call to the
getAmountIn
function with the amount of the token you wish to receive will return the minimum amount required of the token you wish to send, accounting for fees and the total amount of reserves.function getAmountsOut(uint amountIn, address[] calldata path) external view returns (uint[] memory amounts);
A call to the
getAmountsOut
function with the amount of the token being sent will return the maximum amount to be received of multiple different tokens. By entering multiple LP addresses in the address array, the function will return the maximum amount of each token that will be received. A call to this function uses the getReserves
function from UnifiPair.sol to determine the reserves of the liquidity pool. Then, it calls the getAmountOut
function to determine the amount of each token in the array that will be received for the amountIn value of a token.function getAmountsIn(uint amountOut, address[] calldata path) external view returns (uint[] memory amounts);
A call to the
getAmountsIn
function with the desired amount of the token to be received will return the minimum amount required to be sent of multiple tokens. By entering multiple LP addresses in the address array, the function will return the minimum amount of each token that will need to be sent to receive the desired amount of a token. A call to this function uses the getReserves
function from UnifiPair.sol to determine the reserves of the liquidity pool. Then, it calls the getAmountIn
function to determine the amount of each token in the array that will need to be sent for the amountOut value of a token. 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);
The
addLiquidity
function adds the two tokens that make up the liquidity pool - tokenA and tokenB - at the proper ratio based on the reserves of the pool. For example, if the pool contains 100 USDT.t / 100,000 BTT, a user's liquidity will be added at the ratio of 1 USDT.t to 1000 BTT, provided there is no price movements in the pair between when the user broadcasts the transaction to when it is mined. In the event of a price movement, the amountADesired, amountBDesired, amountAMin, and amountBMin act as a security measure against an adverse price movement. After the liquidity is added, the function sends the corresponding LP tokens to the sender.In the case of a pool not existing for the two assets, one will be created using UnifiFactory.sol at the ratio of the assets supplied.
Parameter | Type | Description |
tokenA | address | Token address of the first asset in the token pair. |
tokenB | address | Token address of the second asset in the token pair. |
amountADesired | uint | The amount of tokenA to be added to liquidity if the value of tokenA goes down in comparison to tokenB. |
amountBDesired | uint | The amount of tokenB to be added to liquidity if the value of tokenB goes down in comparison to tokenA. |
amountAMin | uint | Sets the minimum amount of tokenA that can added to the pool before the transaction reverts. This acts as a safeguard.
|
amountBMin | uint | Sets the minimum amount of tokenB that can added to the pool before the transaction reverts. This acts as a safeguard. ​
|
to | address | The address to which the LP tokens for the uTrade V2 pool will be sent. |
deadline | uint | The UNIX timestamp for which this transaction must be completed. If the transaction is mined after this deadline, the transaction will revert. |
Parameter | Type | Description |
amountA | uint | The exact amount of tokenA that was sent to the pool. |
amountB | uint | The exact amount of tokenB that was sent to the pool. |
liquidity | uint | The exact amount of liquidity tokens minted and sent to the address provided in the to parameter. |
function addLiquidityETH(
address token,
uint amountTokenDesired,
uint amountTokenMin,
uint amountETHMin,
address to,
uint deadline
) external payable returns (uint amountToken, uint amountETH, uint liquidity);
The
addLiquidityEth
function is similar to the addLiquidity
function except it accounts for one token being a native asset. In the case of BitTorrent Chain, this native asset would be BTT. This function will convert BTT to WBTT, will pair that WBTT with the supplied other token, and add the liquidity to the pool. This function will add at the ideal ratio based on when the transaction is mined.
In the case of a pool not existing for BTT and the token provided, one will be created using UnifiFactory.sol at the ratio of the assets supplied.- This function requires a msg.value with the amount of BTT to be added.
- The msg.value acts as the amountETHDesired. As in, if the ratio between BTT and the token being paired with it change, this is the number of BTT that will be added to the pool.
- Any leftover BTT is returned to the msg.sender address.
Parameter | Type | Description |
token | address | The address of the supplied token for the liquidity pool. In other words, the asset that BTT is paired with. |
amountTokenDesired | uint | The amount of the supplied token to be added to liquidity if the value of token goes down in comparison to BTT. |
(amountETHDesired) msg.value | uint | Sent as the msg.value, the amount of BTT to be added to liquidity if the value of BTT goes down in comparison to token. |
amountTokenMin | uint | Sets the minimum amount of the supplied token that can added to the pool before the transaction reverts. This acts as a safeguard. ​
|
amountETHMin | uint | ​ Sets the minimum amount of BTT that can added to the pool before the transaction reverts. This acts as a safeguard. |