Liquidator

Description

Source: contracts/Liquidator.sol

Structs

LiquidationEntry

_Source

Field	Type	Description
deadline	uint256	TBA
caller	address	TBA

Variables

CONTRACT_NAME

_Source

Type: bytes32

LIQUIDATION_CALLER

_Source

Type: bytes32

LIQUIDATION_DEADLINE

_Source

Type: bytes32

Constructor

constructor

_Source

Details

Signature

constructor(address _owner, address _resolver)

Visibility

public

State Mutability

``

Views

calculateAmountToFixCollateral

_Source

Details

Signature

calculateAmountToFixCollateral(uint256 debtBalance, uint256 collateral, uint256 penalty) view returns (uint256)

Visibility

external

State Mutability

view

flagReward

_Source

Details

Signature

flagReward() view returns (uint256)

Visibility

external

State Mutability

view

getLiquidationCallerForAccount

_Source

Details

Signature

getLiquidationCallerForAccount(address account) view returns (address)

Visibility

external

State Mutability

view

getLiquidationDeadlineForAccount

_Source

Details

Signature

getLiquidationDeadlineForAccount(address account) view returns (uint256)

Visibility

external

State Mutability

view

isLiquidationDeadlinePassed

_Source

Details

Signature

isLiquidationDeadlinePassed(address account) view returns (bool)

Visibility

external

State Mutability

view

isLiquidationOpen

_Source

Details

Signature

isLiquidationOpen(address account, bool isSelfLiquidation) view returns (bool)

Visibility

external

State Mutability

view

issuanceRatio

_Source

Details

Signature

issuanceRatio() view returns (uint256)

Visibility

external

State Mutability

view

liquidateReward

_Source

Details

Signature

liquidateReward() view returns (uint256)

Visibility

external

State Mutability

view

liquidationAmounts

_Source

Details

Signature

liquidationAmounts(address account, bool isSelfLiquidation) view returns (uint256 totalRedeemed, uint256 debtToRemove, uint256 escrowToLiquidate, uint256 initialDebtBalance)

Visibility

external

State Mutability

view

liquidationCollateralRatio

_Source

Details

Signature

liquidationCollateralRatio() view returns (uint256)

Visibility

external

State Mutability

view

liquidationDelay

_Source

Details

Signature

liquidationDelay() view returns (uint256)

Visibility

external

State Mutability

view

liquidationEscrowDuration

_Source

Details

Signature

liquidationEscrowDuration() view returns (uint256)

Visibility

external

State Mutability

view

liquidationPenalty

_Source

Details

Signature

liquidationPenalty() view returns (uint256)

Visibility

external

State Mutability

view

liquidationRatio

_Source

Details

Signature

liquidationRatio() view returns (uint256)

Visibility

external

State Mutability

view

resolverAddressesRequired

_Source

Details

Signature

resolverAddressesRequired() view returns (bytes32[] addresses)

Visibility

public

State Mutability

view

selfLiquidationPenalty

_Source

Details

Signature

selfLiquidationPenalty() view returns (uint256)

Visibility

external

State Mutability

view

Restricted Functions

removeAccountInLiquidation

_Source

Details

Signature

removeAccountInLiquidation(address account)

Visibility

external

State Mutability

``

Modifiers

• onlyIssuer

Internal Functions

_deadlinePassed

_Source

Details

Signature

_deadlinePassed(uint256 deadline) view returns (bool)

Visibility

internal

State Mutability

view

_getKey

_Source

Details

Signature

_getKey(bytes32 _scope, address _account) pure returns (bytes32)

Visibility

internal

State Mutability

pure

_getLiquidationEntryForAccount

_Source

Details

Signature

_getLiquidationEntryForAccount(address account) view returns (struct Liquidator.LiquidationEntry _liquidation)

Visibility

internal

State Mutability

view

_hasEnoughSNXForRewards

_Source

Details

Signature

_hasEnoughSNXForRewards(address account) view returns (bool)

Visibility

internal

State Mutability

view

_removeLiquidationEntry

_Source

Details

Signature

_removeLiquidationEntry(address _account)

Visibility

internal

State Mutability

``

Emits

• AccountRemovedFromLiquidation

_storeLiquidationEntry

_Source

Details

Signature

_storeLiquidationEntry(address _account, uint256 _deadline, address _caller)

Visibility

internal

State Mutability

``

exchangeRates

_Source

Details

Signature

exchangeRates() view returns (contract IExchangeRates)

Visibility

internal

State Mutability

view

issuer

_Source

Details

Signature

issuer() view returns (contract IIssuer)

Visibility

internal

State Mutability

view

synthetix

_Source

Details

Signature

synthetix() view returns (contract ISynthetix)

Visibility

internal

State Mutability

view

systemStatus

_Source

Details

Signature

systemStatus() view returns (contract ISystemStatus)

Visibility

internal

State Mutability

view

External Functions

checkAndRemoveAccountInLiquidation

_Source

Details

Signature

checkAndRemoveAccountInLiquidation(address account)

Visibility

external

State Mutability

``

Requires

• require(..., "Account has no liquidation set")

Modifiers

• rateNotInvalid

flagAccountForLiquidation

_Source

Details

Signature

flagAccountForLiquidation(address account)

Visibility

external

State Mutability

``

Requires

• require(..., "Must liquidate using V3")

• require(..., "Liquidation ratio not set")

• require(..., "Liquidation delay not set")

• require(..., "Account already flagged for liquidation")

• require(..., "Account issuance ratio is less than liquidation ratio")

• require(..., "not enough SNX for rewards")

Modifiers

• rateNotInvalid

Emits

• AccountFlaggedForLiquidation

Modifiers

onlyIssuer

_Source

rateNotInvalid

_Source

Signature: rateNotInvalid(bytes32 currencyKey)

Events

AccountFlaggedForLiquidation

_Source

Signature: AccountFlaggedForLiquidation(address account, uint256 deadline)

AccountRemovedFromLiquidation

_Source

Signature: AccountRemovedFromLiquidation(address account, uint256 time)