Router

The Router is a contract that computes optimal paths to enter, exit and convert positions. Given an input token, output token and the amount, the Router will return the expected output amount, and a path (array of MultiCall structs) with a slippage check included. The path can then be passed to any multicall-compatible function to execute it.

All Router functions return the RouterResult struct:

struct RouterResult {
    uint256 amount;
    uint256 minAmount;
    uint256 gasUsage;
    MultiCall[] calls;
}

Router functions

findOpenStrategyPath

Returns a path that converts the expected balances after account opening into a single output asset.

function findOpenStrategyPath(
    address creditManager,
    Balance[] calldata balances,
    Balance[] calldata leftoverBalances,
    address target,
    address[] calldata connectors,
    uint256 slippage
) external override returns (Balance[] memory, RouterResult memory)

The Router will return an array of balances expected to be on the Credit Account after all operations, as well as RouterResult.

findBestClosePath

Returns a path that converts all assets on the account into underlying. Can be used for Credit Account closures and liquidations.

function findBestClosePath(
    address creditAccount,
    Balance[] calldata expectedBalances,
    Balance[] calldata leftoverBalances,
    address[] calldata connectors,
    uint256 slippage,
    PathOption[] memory pathOptions,
    uint256 loops,
    bool force
) external returns (RouterResult memory result, uint256 gasPriceTargetRAY);

pathOptions is an array of PathOption objects:

struct PathOption {
    address target;
    uint8 option;
    uint8 totalOptions;
}

These structs are defined for each pool that can have several underlying assets to withdraw (examples are Curve and Balancer). target is the pool's LP token, while totalOptions is the number of withdrawal paths (this is usually equal to the number of assets in the pool). E.g., for 3Crv this would be:

pathOptions[0] = PathOption({
    target: 0x6c3F90f043a72FA612cbac8115EE7e52BDe6E490,
    option: 0,
    totalOptions: 3
});
 
`option` must always be set to 0.

findOneTokenPath

Returns a path that converts a given amount of one token to another token.

Note that the Router can swap any DEX-tradable token to another DEX-tradable token, and a DEX-tradable token to any farm. However, conversions between farms are generally not possible, unless the input token is in the direct deposit path of the output token (e.g., converting a Curve token to a corresponding Convex token).

function findOneTokenPath(
    address tokenIn,
    uint256 amount,
    address tokenOut,
    address creditAccount,
    address[] calldata connectors,
    uint256 slippage
) external override returns (RouterResult memory);