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.
uTrade V2 Router Code / Interfaces
uTrade V2 Router Contract Addresses
factory
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 Polygon is 0x4FEE52912f81B78C3CdcB723728926ED6a893D27
.
WETH
A call to the WETH
function returns the address of Wrapped Matic (WMATIC) on Polygon. As this address does not change, it will always return 0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270
.
quote
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.
getAmountOut
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.
getAmountIn
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.
getAmountsOut
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.
getAmountsIn
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.
State-Changing Functions - Liquidity
addLiquidity
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 200 USDT / 100 WMATIC, a user's liquidity will be added at the ratio of 2 USDT to 1 WMATIC, 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.
Function Parameters Breakdown
Function Return Parameter Breakdown
addLiquidityETH
The addLiquidityEth
function is similar to the addLiquidity
function except it accounts for one token being a native asset. In the case of Polygon, this native asset would be MATIC. This function will convert MATIC to WMATIC, will pair that WMATIC 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 WMATIC 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 MATIC to be added.
The msg.value acts as the amountETHDesired. As in, if the ratio between MATIC and the token being paired with it change, this is the number of MATIC that will be added to the pool.
Any leftover MATIC is returned to the msg.sender address.
Function Parameter Breakdown
Function Return Parameter Breakdown
removeLiquidity
The removeLiquidity
function removes the two tokens that make up liquidity from a pool. In other words, this function is used when the pool consists of two ERC-20 tokens.
In the event one of the assets is paired with MATIC, MATIC will have been wrapped and paired with WMATIC (Wrapped Matic). If the user wishes to withdraw WMATIC instead of withdrawing as MATIC, this function should be used instead of
removeLiquidityETH
.
Function Parameter Breakdown
Function Return Parameter Breakdown
removeLiquidityETH
The removeLiquidityETH
function removes MATIC as well as the corresponding paired token in the liquidity pool. In other words, this function is used when the pool consists of WMATIC and an ERC-20 token.
In the event one of the assets is paired with MATIC, MATIC has been wrapped into WMATIC (Wrapped MATIC). This function will unwrap the WMATIC as the liquidity removed. If the user wishes to withdraw WMATIC instead of withdrawing as MATIC, the
removeLiquidity
function should be used.
Function Parameter Breakdown
Function Return Parameter Breakdown
removeLiquidityWithPermit
The removeLiquidityWithPermit
functions removes the two tokens that make up liquidity from a pool. In other words, this function is used when the pool consists of two ERC-20 tokens. This function operates similarly to the removeLiquidity
function with the added benefit of not requiring pre-approvals using permit.
In the event one of the assets is paired with MATIC, MATIC will have been wrapped and paired with WMATIC (Wrapped MATIC). If the user wishes to withdraw WMATIC instead of withdrawing as MATIC, this function should be used instead of
removeLiquidityETHWithPermit
.
Function Parameter Breakdown
Function Return Parameter Breakdown
removeLiquidityETHWithPermit
The removeLiquidityETHWithPermit
function removes MATIC as well as the corresponding paired token in the liquidity pool. In other words, this function is used when the pool consists of WMATIC and a ERC-20 token. This function operates similarly to the removeLiquidityETH
function with the added benefit of not requiring pre-approvals using permit.
In the event one of the assets is paired with MATIC, MATIC has been wrapped into WMATIC (Wrapped Matic). This function will unwrap the WMATIC as the liquidity removed. If the user wishes to withdraw WMATIC instead of withdrawing as MATIC, the
removeLiquidityWithPermit
function should be used.
Function Parameter Breakdown
Function Return Parameter Breakdown
removeLiquidityETHSupportingFeeOnTransferTokens
The removeLiquidityETHSupportingFeeOnTransferTokens
function is similar to the removeLiquidityETH
function, and contains the same call parameters. This function removes ETH as well as the corresponding paired token in the liquidity pool. In other words, this function is used when the pool consists of WMATIC and a ERC-20 token.
However, this function allows for fee on transfer tokens, such as PAXG, to be used on uTrade.
Function Parameter Breakdown
Function Return Parameter Breakdown
removeLiquidityETHWithPermitSupportingFeeOnTransferTokens
The removeLiquidityETHWithPermitSupportingFeeOnTransferTokens
function is similar to the removeLiquidityETHWithPermit
function. This function removes MATIC as well as the corresponding paired token in the liquidity pool. In other words, this function is used when the pool consists of WMATIC and an ERC-20 token. This function operates similarly to the removeLiquidityETHfunction
with the added benefit of not requiring pre-approvals using permit In addition, this function allows for fee on transfer tokens, such as PAXG, to be used on uTrade.
Function Parameter Breakdown
Function Return Parameter Breakdown
State-Changing Functions - Swap
swapExactTokensForTokens
The swapExactTokensForTokens
function sends an exact amount of tokens for the maximum amount of another token.
Function Parameter Breakdown
Function Return Parameter Breakdown
swapTokensForExactTokens
The swapTokensForExactTokens
function sends the minimum amount of tokens for the exact amount of another token.
Function Parameter Breakdown
Function Return Parameter Breakdown
swapExactETHForTokens
The swapExactETHForTokens
function sends an exact amount of MATIC for a desired token.
Function Parameter Breakdown
Function Return Parameter Breakdown
swapTokensForExactETH
The swapTokensForExactETH
function sends an amount of tokens for an exact amount of MATIC.
Function Parameter Breakdown
Function Return Parameter Breakdown
swapExactTokensForETH
The swapExactTokensForETH
function sends an exact amount of tokens for MATIC.
Function Parameter Breakdown
Function Parameter Return Breakdown
swapETHForExactTokens
The swapETHForExactTokens
function swaps an exact amount of MATIC for an amount of the desired token.
Function Parameter Breakdown
Function Return Parameter Breakdown
swapExactTokensForTokensSupportingFeeOnTransferTokens
The swapExactTokensForTokensSupportingFeeOnTransferTokens
function is similar to swapExactTokensForTokens
as it swaps one ERC-20 token for another ERC-20 token. In addition, this function allows for fee on transfer tokens, such as PAXG, to be used on uTrade.
Function Parameter Breakdown
swapExactETHForTokensSupportingFeeOnTransferTokens
The swapExactETHForTokensSupportingFeeOnTransferTokens
function is similar to swapExactETHForTokens
function as it swaps an exact amount of MATIC for ERC-20 tokens. In addition, this function allows for fee on transfer tokens, such as PAXG, to be used on uTrade.
Function Parameter Breakdown
swapExactTokensForETHSupportingFeeOnTransferTokens
The function swapExactTokensForETHSupportingFeeOnTransferTokens
is similar to the swapExactTokensForETH
function, as it swaps an exact amount of ERC-20 tokens for MATIC. In addition, this function allows for fee on transfer tokens, such as PAXG, to be used on uTrade.
Function Parameter Breakdown
Interface Code
Last updated