Liquidator

\

Functions

collateralAsset

Returns the address of the collateral asset.

    function collateralAsset()
        view
        returns (
            address
        );

Return Values:

Index	Name	Type	Internal Type	Description
0		address	address

\

collateralRemaining

Returns the amount of collateral yet to be liquidated.

    function collateralRemaining()
        view
        returns (
            uint256
        );

Return Values:

Index	Name	Type	Internal Type	Description
0		uint256	uint256

\

factory

The address of the proxy factory.

    function factory()
        view
        returns (
            address factory_
        );

Return Values:

Index	Name	Type	Internal Type	Description
0	factory_	address	address

\

fundsAsset

Returns the address of the funding asset.

    function fundsAsset()
        view
        returns (
            address
        );

Return Values:

Index	Name	Type	Internal Type	Description
0		address	address

\

getExpectedAmount

Returns the expected amount to be returned from a flash loan given a certain amount of `collateralAsset`.

    function getExpectedAmount(
        uint256 swapAmount_
    )
        view
        returns (
            uint256 expectedAmount_
        );

Parameters:

Index	Name	Type	Internal Type	Description
0	swapAmount_	uint256	uint256	Amount of `collateralAsset` to be flash-borrowed.

Return Values:

Index	Name	Type	Internal Type	Description
0	expectedAmount_	uint256	uint256	Amount of `fundsAsset` that must be returned in the same transaction.

\

globals

    function globals()
        view
        returns (
            address globals_
        );

Return Values:

Index	Name	Type	Internal Type	Description
0	globals_	address	address

\

governor

    function governor()
        view
        returns (
            address governor_
        );

Return Values:

Index	Name	Type	Internal Type	Description
0	governor_	address	address

\

implementation

The address of the implementation contract being proxied.

    function implementation()
        view
        returns (
            address implementation_
        );

Return Values:

Index	Name	Type	Internal Type	Description
0	implementation_	address	address

\

liquidatePortion

Flash loan function that: 1. Transfers a specified amount of `collateralAsset` to `msg.sender`. 2. Performs an arbitrary call to `msg.sender`, to trigger logic necessary to get `fundsAsset` (e.g., AMM swap). 3. Performs a `transferFrom`, taking the corresponding amount of `fundsAsset` from the user. If the required amount of `fundsAsset` is not returned in step 3, the entire transaction reverts.

    function liquidatePortion(
        uint256 collateralAmount_,
        uint256 maxReturnAmount_,
        bytes data_
    )
        nonpayable;

Parameters:

Index	Name	Type	Internal Type	Description
0	collateralAmount_	uint256	uint256
1	maxReturnAmount_	uint256	uint256	Max amount of `fundsAsset` that can be returned to the liquidator contract.
2	data_	bytes	bytes	ABI-encoded arguments to be used in the low-level call to perform step 2.

\

loanManager

Returns the address of the loan manager contract.

    function loanManager()
        view
        returns (
            address
        );

Return Values:

Index	Name	Type	Internal Type	Description
0		address	address

\

migrate

Modifies the proxy's storage by delegate-calling a migrator contract with some arguments. Access control logic critical since caller can force a selfdestruct via a malicious `migrator_` which is delegatecalled.

    function migrate(
        address migrator_,
        bytes arguments_
    )
        nonpayable;

Parameters:

Index	Name	Type	Internal Type	Description
0	migrator_	address	address	The address of a migrator contract.
1	arguments_	bytes	bytes	Some encoded arguments to use for the migration.

\

poolDelegate

    function poolDelegate()
        view
        returns (
            address poolDelegate_
        );

Return Values:

Index	Name	Type	Internal Type	Description
0	poolDelegate_	address	address

\

pullFunds

Pulls a specified amount of ERC-20 tokens from the contract. Can only be called by `owner`.

    function pullFunds(
        address token_,
        address destination_,
        uint256 amount_
    )
        nonpayable;

Parameters:

Index	Name	Type	Internal Type	Description
0	token_	address	address	The ERC-20 token contract address.
1	destination_	address	address	The destination of the transfer.
2	amount_	uint256	uint256	The amount to transfer.

\

setCollateralRemaining

Sets the initial amount of collateral to be liquidated.

    function setCollateralRemaining(
        uint256 collateralAmount_
    )
        nonpayable;

Parameters:

Index	Name	Type	Internal Type	Description
0	collateralAmount_	uint256	uint256	The amount of collateral to be liquidated.

\

setImplementation

Modifies the proxy's implementation address.

    function setImplementation(
        address implementation_
    )
        nonpayable;

Parameters:

Index	Name	Type	Internal Type	Description
0	implementation_	address	address

\

upgrade

Upgrades a contract implementation to a specific version. Access control logic critical since caller can force a selfdestruct via a malicious `migrator_` which is delegatecalled.

    function upgrade(
        uint256 version_,
        bytes arguments_
    )
        nonpayable;

Parameters:

Index	Name	Type	Internal Type	Description
0	version_	uint256	uint256
1	arguments_	bytes	bytes	Some encoded arguments to use for the upgrade.

\

Events

FundsPulled

Funds were withdrawn from the liquidator.

    event FundsPulled(
        address token_,
        address destination_,
        uint256 amount_
    );

Parameters:

Index	Name	Type	Internal Type	Description
0	token_	address	address	Address of the token that was withdrawn.
1	destination_	address	address	Address of where tokens were sent.
2	amount_	uint256	uint256	Amount of tokens that were sent.

\

PortionLiquidated

Portion of collateral was liquidated.

    event PortionLiquidated(
        uint256 swapAmount_,
        uint256 returnedAmount_
    );

Parameters:

Index	Name	Type	Internal Type	Description
0	swapAmount_	uint256	uint256	Amount of collateralAsset that was liquidated.
1	returnedAmount_	uint256	uint256	Amount of fundsAsset that was returned.

\

Upgraded

The instance was upgraded.

    event Upgraded(
        uint256 toVersion_,
        bytes arguments_
    );

Parameters:

Index	Name	Type	Internal Type	Description
0	toVersion_	uint256	uint256	The new version of the loan.
1	arguments_	bytes	bytes	The upgrade arguments, if any.

\