BuniCornRouter02

Code

BuniCornRouter02.sol

Address

BuniCornRouter02 is deployed at 0x689E37aFb4236A5cF808cA05a8D1c564200fA0E4 on the Binance SmartChain mainnet.

Read-Only Functions

factory

function factory() external pure returns (address);

Returns the factory address.

quote

function quote(uint256 amountA, uint256 reserveA, uint256 reserveB) external pure returns (uint256 amountB);

Given some asset amount and reserves, returns an amount of the other asset representing equivalent value.

getAmountsOut

function getAmountsOut(uint256 amountIn, address[] memory poolsPath, IERC20[] memory path) external view returns (uint256[] memory amounts);

First calls verifyPoolsPathSwap to verify the validity of the poolsPath and path variables.

Then, given an input asset amount and an array of token and corresponding pool addresses, calculates all subsequent maximum output token amounts by calling getTradeInfo for each pair of token addresses in the path in turn, and using these to call getAmountOut.

getAmountsIn

function getAmountsIn(uint256 amountOut, address[] memory poolsPath, IERC20[] memory path) external view returns (uint256[] memory amounts);

First calls verifyPoolsPathSwap to verify the validity of the poolsPath and path variables.

Then, given an output asset amount and an array of token addresses, calculates all preceding minimum input token amounts by calling getTradeInfo for each pair of token addresses in the path in turn, and using these to call getAmountIn.

State-Changing Functions

addLiquidity

function addLiquidity(
  IERC20 tokenA,
  IERC20 tokenB,
  address pool,
  uint256 amountADesired,
  uint256 amountBDesired,
  uint256 amountAMin,
  uint256 amountBMin,
  uint256[2] memory vReserveRatioBounds,
  address to,
  uint256 deadline
) external returns (uint256 amountA, uint256 amountB, uint256 liquidity);

Adds liquidity to an existing stable pool.

• pool should already be an existing pool of the token pair of tokenA and tokenB. Otherwise, the transaction will revert.

• 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.

Name	Type
tokenA	IERC20	The contract address of the desired token.
tokenB	IERC20	The contract address of the desired token.
pool	address	The contract address of the desired pool to add liquidity to.
amountADesired	uint256	The amount of tokenA to add as liquidity if the B/A price is <= amountBDesired/amountADesired (A depreciates).
amountBDesired	uint256	The amount of tokenB to add as liquidity if the A/B price is <= amountADesired/amountBDesired (B depreciates).
amountAMin	uint256	Bounds the extent to which the B/A price can go up before the transaction reverts. Must be <= amountADesired.
amountBMin	uint256	Bounds the extent to which the A/B price can go up before the transaction reverts. Must be <= amountBDesired.
vReserveRatioBounds	uint256[2]	Bounds the extent to which the virtual B/A price can move before the transaction reverts.
to	address	Recipient of the liquidity tokens.
deadline	uint256	Unix timestamp after which the transaction will revert.
amountA	uint256	The amount of tokenA sent to the pool.
amountB	uint256	The amount of tokenB sent to the pool.
liquidity	uint256	The amount of liquidity tokens minted.

removeLiquidity

function removeLiquidity(
  IERC20 tokenA,
  IERC20 tokenB,
  address pool,
  uint256 liquidity,
  uint256 amountAMin,
  uint256 amountBMin,
  address to,
  uint256 deadline
) external returns (uint256 amountA, uint256 amountB);

Removes liquidity from a specified stable pool.

• msg.sender should have already given the router an allowance of at least liquidity on the pool.

Name	Type
tokenA	IERC20	The contract address of the desired token.
tokenB	IERC20	The contract address of the desired token.
pool	address	The contract address of the desired pool to remove liquidity from.
liquidity	uint256	The amount of liquidity tokens to remove.
amountAMin	uint256	The minimum amount of tokenA that must be received for the transaction not to revert.
amountBMin	uint256	The minimum amount of tokenB that must be received for the transaction not to revert.
to	address	Recipient of the underlying assets.
deadline	uint256	Unix timestamp after which the transaction will revert.
amountA	uint256	The amount of tokenA received.
amountB	uint256	The amount of tokenB received.

removeLiquidityWithPermit

function removeLiquidityWithPermit(
  IERC20 tokenA,
  IERC20 tokenB,
  address pool,
  uint256 liquidity,
  uint256 amountAMin,
  uint256 amountBMin,
  address to,
  uint256 deadline,
  bool approveMax, uint8 v, bytes32 r, bytes32 s
) external returns (uint256 amountA, uint256 amountB);

Removes liquidity from an ERC-20⇄ERC-20 pool without pre-approval, thanks to permit.

Name	Type
tokenA	IERC20	The contract address of the desired token.
tokenB	IERC20	The contract address of the desired token.
pool	address	The contract address of the desired pool to remove liquidity from.
liquidity	uint256	The amount of liquidity tokens to remove.
amountAMin	uint256	The minimum amount of tokenA that must be received for the transaction not to revert.
amountBMin	uint256	The minimum amount of tokenB that must be received for the transaction not to revert.
to	address	Recipient of the underlying assets.
deadline	uint256	Unix timestamp after which the transaction will revert.
approveMax	bool	Whether or not the approval amount in the signature is for liquidity or uint256(-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	uint256	The amount of tokenA received.
amountB	uint256	The amount of tokenB received.

swapExactTokensForTokens

function swapExactTokensForTokens(
  uint256 amountIn,
  uint256 amountOutMin,
  address[] calldata poolsPath,
  IERC20[] calldata path,
  address to,
  uint256 deadline
) external returns (uint256[] memory amounts);

Swaps an exact amount of input tokens for as many output tokens as possible. The token and pool routes are specified by the poolsPath and path variables respectively.

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). The nth element of poolsPath is the first pool to be used for the nth and (n+1)th elements of path. It therefore is a requirement for poolsPath to be a size smaller than path, ie. poolsPath.length = path.length - 1.

• msg.sender should have already given the router an allowance of at least amountIn on the input token.

Name	Type
amountIn	uint256	The amount of input tokens to send.
amountOutMin	uint256	The minimum amount of output tokens that must be received for the transaction not to revert.
poolsPath	address[] calldata	An array of pool addresses. poolsPath.length must be smaller than path.length by 1. Each pool specified is a pool for each consecutive pair of addresses and must have liquidity.
path	IERC20[] 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	uint256	Unix timestamp after which the transaction will revert.
amounts	uint256[] memory	The input token amount and all subsequent output token amounts.

swapTokensForExactTokens

function swapTokensForExactTokens(
  uint256 amountOut,
  uint256 amountInMax,
  address[] calldata poolsPath,
  IERC20[] calldata path,
  address to,
  uint256 deadline
) external returns (uint256[] memory amounts);

Receive an exact amount of output tokens for as few input tokens as possible. The token and pool routes are specified by the poolsPath and path variables respectively.

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). The nth element of poolsPath is the first pool to be used for the nth and (n+1)th elements of path. It therefore is a requirement for poolsPath to be a size smaller than path, ie. poolsPath.length = path.length - 1.

• msg.sender should have already given the router an allowance of at least amountInMax on the input token.

Name	Type
amountOut	uint256	The amount of output tokens to receive.
amountInMax	uint256	The maximum amount of input tokens that can be required before the transaction reverts.
poolsPath	address[] calldata	An array of pool addresses. poolsPath.length must be smaller than path.length by 1. Each pool specified is a pool for each consecutive pair of addresses and must have liquidity.
path	IERC20[] 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	uint256	Unix timestamp after which the transaction will revert.
amounts	uint256[] memory	The input token amount and all subsequent output token amounts.

Interface

pragma solidity 0.6.12;

import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

/// @dev an simple interface for integration dApp to swap
interface IBuniCornExchangeRouter {
    function swapExactTokensForTokens(
        uint256 amountIn,
        uint256 amountOutMin,
        address[] calldata poolsPath,
        IERC20[] calldata path,
        address to,
        uint256 deadline
    ) external returns (uint256[] memory amounts);

    function swapTokensForExactTokens(
        uint256 amountOut,
        uint256 amountInMax,
        address[] calldata poolsPath,
        IERC20[] calldata path,
        address to,
        uint256 deadline
    ) external returns (uint256[] memory amounts);

    function getAmountsOut(
        uint256 amountIn,
        address[] calldata poolsPath,
        IERC20[] calldata path
    ) external view returns (uint256[] memory amounts);

    function getAmountsIn(
        uint256 amountOut,
        address[] calldata poolsPath,
        IERC20[] calldata path
    ) external view returns (uint256[] memory amounts);
}

/// @dev an simple interface for integration dApp to contribute liquidity
interface IBuniCornLiquidityRouter {
    /**
     * @param tokenA address of token in the pool
     * @param tokenB address of token in the pool
     * @param pool the address of the pool
     * @param amountADesired the amount of tokenA users want to add to the pool
     * @param amountBDesired the amount of tokenB users want to add to the pool
     * @param amountAMin bounds to the extents to which amountB/amountA can go up
     * @param amountBMin bounds to the extents to which amountB/amountA can go down
     * @param vReserveRatioBounds bounds to the extents to which vReserveB/vReserveA can go (precision: 2 ** 112)
     * @param to Recipient of the liquidity tokens.
     * @param deadline Unix timestamp after which the transaction will revert.
     */
    function addLiquidity(
        IERC20 tokenA,
        IERC20 tokenB,
        address pool,
        uint256 amountADesired,
        uint256 amountBDesired,
        uint256 amountAMin,
        uint256 amountBMin,
        uint256[2] calldata vReserveRatioBounds,
        address to,
        uint256 deadline
    )
        external
        returns (
            uint256 amountA,
            uint256 amountB,
            uint256 liquidity
        );

    function addLiquidityNewPool(
        IERC20 tokenA,
        IERC20 tokenB,
        uint32 ampBps,
        uint256 amountADesired,
        uint256 amountBDesired,
        uint256 amountAMin,
        uint256 amountBMin,
        address to,
        uint256 deadline
    )
        external
        returns (
            uint256 amountA,
            uint256 amountB,
            uint256 liquidity
        );

    /**
     * @param tokenA address of token in the pool
     * @param tokenB address of token in the pool
     * @param pool the address of the pool
     * @param liquidity the amount of lp token users want to burn
     * @param amountAMin the minimum token retuned after burning
     * @param amountBMin the minimum token retuned after burning
     * @param to Recipient of the returned tokens.
     * @param deadline Unix timestamp after which the transaction will revert.
     */
    function removeLiquidity(
        IERC20 tokenA,
        IERC20 tokenB,
        address pool,
        uint256 liquidity,
        uint256 amountAMin,
        uint256 amountBMin,
        address to,
        uint256 deadline
    ) external returns (uint256 amountA, uint256 amountB);

    /**
     * @param tokenA address of token in the pool
     * @param tokenB address of token in the pool
     * @param pool the address of the pool
     * @param liquidity the amount of lp token users want to burn
     * @param amountAMin the minimum token retuned after burning
     * @param amountBMin the minimum token retuned after burning
     * @param to Recipient of the returned tokens.
     * @param deadline Unix timestamp after which the transaction will revert.
     * @param approveMax whether users permit the router spending max lp token or not.
     * @param r s v Signature of user to permit the router spending lp token
     */
    function removeLiquidityWithPermit(
        IERC20 tokenA,
        IERC20 tokenB,
        address pool,
        uint256 liquidity,
        uint256 amountAMin,
        uint256 amountBMin,
        address to,
        uint256 deadline,
        bool approveMax,
        uint8 v,
        bytes32 r,
        bytes32 s
    ) external returns (uint256 amountA, uint256 amountB);

    /**
     * @param amountA amount of 1 side token added to the pool
     * @param reserveA current reserve of the pool
     * @param reserveB current reserve of the pool
     * @return amountB amount of the other token added to the pool
     */
    function quote(
        uint256 amountA,
        uint256 reserveA,
        uint256 reserveB
    ) external pure returns (uint256 amountB);
}

/// @dev full interface for router
interface IBuniCornRouter01 is IBuniCornExchangeRouter, IBuniCornLiquidityRouter {
    function factory() external pure returns (address);
}