Rubicon Router

Contract Source Code (opens in a new tab)

Overview

RubiconRouter.sol is a high-level contract that adds convenient functionality for interacting with low-level Rubicon smart contracts.

It primarily serves as a router for ERC-20/ERC-20 token swaps on RubiconMarket.sol, and enables multi-hop swaps if two tokens do not have an underlying order book.

The contract has wrapper functions for handling native ETH throughout the protocol. This includes functions for buying and swapping ETH with/for ERC-20 tokens, and for depositing/withdrawing ETH in Rubicon Pools.

It also has helpful view functions for reading order book data from the low-level RubiconMarket.sol contract.

Functions

swap()

function swap(
        uint256 pay_amt,
        uint256 buy_amt_min,
        address[] memory route,
        address to
    ) public returns (uint256)

Swaps pay_amt quantity of tokens for at least buy_amt_min quantity of the last token in the specified route.

multiswap()

    function multiswap(
        address[][] memory routes,
        uint256[] memory pay_amts,
        uint256[] memory buy_amts_min,
        address to
    ) public

Swaps tokens across multiple routes of token addresses with a minimum received quantity. It enables token swaps across multiple order books on RubiconMarket, in case the tokens do not have an existing order book.

swapWithETH()

    function swapWithETH(
        uint256 pay_amt,
        uint256 buy_amt_min,
        address[] calldata route,
        address to
    ) external payable returns (uint256)

Swaps pay_amt quantity of ETH for at least buy_amt_min quantity of the last token in the specified route.

swapForETH()

    function swapForETH(
        uint256 pay_amt,
        uint256 buy_amt_min,
        address[] calldata route
    ) external beGoneReentrantScum returns (uint256 fill)

Swaps the pay_amt quantity of the first token in the route for at least buy_amt_min quantity of ETH.

buyAllAmountWithETH()

 function buyAllAmountWithETH(
        IERC20 buy_gem,
        uint256 buy_amt,
        uint256 max_fill_amount
    ) external payable beGoneReentrantScum returns (uint256 fill)

Attempts to buy buy_amt tokens of the buy_gem token for at most the max_fill_amount quantity of ETH. Transaction will revert if the caller would spend more than the specified maximum amount.

buyAllAmountForETH()

function buyAllAmountForETH(
        uint256 buy_amt,
        IERC20 pay_gem,
        uint256 max_fill_amount
    ) external beGoneReentrantScum returns (uint256 fill)

Attempts to buy buy_amt ETH for at most the max_fill_amount quantity of pay_gem tokens. Transaction will revert if the caller would spend more than the specified maximum amount.

sellAllAmountWithETH()

function sellAllAmountWithETH(
        uint256 pay_amt,
        IERC20 buy_gem,
        uint256 min_fill_amount
    ) external payable beGoneReentrantScum returns (uint256 fill)

Attempts to sell pay_amt ETH for at least the min_fill_amount quantity of buy_gem tokens. Transaction will revert if the caller would receive less than the specified minimum amount.

sellAllAmountForETH()

    function sellAllAmountForETH(
        IERC20 pay_gem,
        uint256 pay_amt,
        // buy_gem = ETH,
        uint256 min_fill_amount
    ) external beGoneReentrantScum returns (uint256 fill)

Attempts to sell pay_amt tokens of the pay_gem token for at least the min_fill_amount quantity of ETH. Transaction will revert if the caller would receive less than the specified minimum amount.

View Functions

getExpectedSwapFill()

 function getExpectedSwapFill(
        uint256 pay_amt,
        uint256 buy_amt_min,
        address[] calldata route
    ) public view returns (uint256 currentAmount)

Uses the same parameters as swap() and returns the expected amount received.

getExpectedMultiswapFill()

    function getExpectedMultiswapFill(
        uint256[] memory pay_amts,
        uint256[] memory buy_amt_mins,
        address[][] memory routes
    ) public view returns (uint256 outputAmount)

Uses the same parameters as multiswap() and returns the expected amount received.

getBookFromPair()

    function getBookFromPair(
        IERC20 asset,
        IERC20 quote
    ) public view returns (uint256[3][] memory asks, uint256[3][] memory bids)

Returns all outstanding offers on the book for a given token pair. The asset/quote pair ordering will affect the sorted return values - asset should be the top of the pair: for example, (ETH, USDC) will return (ETH asks, USDC bids)

getOffersFromPair()

    function getOffersFromPair(
        IERC20 tokenIn,
        IERC20 tokenOut
    ) public view returns (uint256[3][] memory offers)

Returns offers from one side of the specified order book.

getBookDepth()

    function getBookDepth(
        IERC20 tokenIn,
        IERC20 tokenOut
    ) public view returns (uint256 depth, uint256 bestOfferID)

Returns depth of one side of the order book and the ID of the best offer().

getOfferIDsFromPair()

    function getOfferIDsFromPair(
        IERC20 tokenIn,
        IERC20 tokenOut
    ) public view returns (uint256[] memory IDs)

Returns all offer() IDs from the tokenIn/tokenOut pair.

getBestOfferAndInfo()

    function getBestOfferAndInfo(
        address asset,
        address quote
    )
        public
        view
        returns (
            uint256,
            uint256,
            IERC20,
            uint256,
            IERC20
        )

Returns the ID and info for the best offer() on a given asset/quote token pair.

Events

    event emitSwap(
        address indexed recipient,
        address indexed inputERC20,
        address indexed targetERC20,
        bytes32 pair,
        uint256 inputAmount,
        uint256 realizedFill,
        uint256 hurdleBuyAmtMin
    );