ICoolerLtvOracle

Git Source

Title: Cooler LTV Oracle

It is a custom oracle (not dependant on external markets/AMMs/dependencies) to give the serve both the Origination LTV and Liquidation LTV

• They are both quoted in [debtToken / collateralToken] units
• It is a fixed 18dp price
• Origination LTV updates on a per second basis according to a policy set rate of change (and is up only or flat)
• Liquidation LTV is a policy set percentage above the Origination LTV

Functions

collateralToken

The collateral asset of the LTV [debtToken / collateralToken]

function collateralToken() external view returns (IERC20);

Returns

Name	Type	Description
<none>	IERC20

debtToken

The debt asset of the LTV [debtToken / collateralToken]

function debtToken() external view returns (IERC20);

Returns

Name	Type	Description
<none>	IERC20

currentLtvs

The current Origination LTV and Liquidation LTV

function currentLtvs() external view returns (uint96 originationLtv, uint96 liquidationLtv);

Returns

Name	Type	Description
originationLtv	uint96
liquidationLtv	uint96

currentOriginationLtv

The current Origination LTV

function currentOriginationLtv() external view returns (uint96);

Returns

Name	Type	Description
<none>	uint96

currentLiquidationLtv

The current Liquidation LTV

function currentLiquidationLtv() external view returns (uint96);

Returns

Name	Type	Description
<none>	uint96

maxOriginationLtvDelta

The maximum allowed Origination LTV change on any single setOriginationLtvAt(), in absolute terms between the Origination LTV as of now and the targetOriginationLtv

18 decimal places, 0.20e18 == $0.20. Used as a bound to avoid unintended/fat fingering when updating Origination LTV

function maxOriginationLtvDelta() external view returns (uint96);

Returns

Name	Type	Description
<none>	uint96

minOriginationLtvTargetTimeDelta

The minimum time delta required for Origination LTV to reach it's target value when setOriginationLtvAt() is called.

In seconds. Used as a bound to avoid unintended/fat fingering when updating Origination LTV

function minOriginationLtvTargetTimeDelta() external view returns (uint32);

Returns

Name	Type	Description
<none>	uint32

maxOriginationLtvRateOfChange

The maximum (positive) rate of change of Origination LTV allowed, when setOriginationLtvAt() is called.

Units: [Origination LTV / second]

function maxOriginationLtvRateOfChange() external view returns (uint96);

Returns

Name	Type	Description
<none>	uint96

originationLtvData

The current Origination LTV state data

function originationLtvData()
        external
        view
        returns (
            uint96 startingValue,
            uint40 startTime,
            uint96 targetValue,
            uint40 targetTime,
            uint96 slope
        );

Returns

Name	Type	Description
startingValue	uint96
startTime	uint40
targetValue	uint96
targetTime	uint40
slope	uint96

maxLiquidationLtvPremiumBps

The maximum Liquidation LTV premium (in basis points) which is allowed to be set when calling setLiquidationLtvPremiumBps()

function maxLiquidationLtvPremiumBps() external view returns (uint16);

Returns

Name	Type	Description
<none>	uint16

liquidationLtvPremiumBps

The premium (in basis points) of the Liquidation LTV above the Origination LTV

function liquidationLtvPremiumBps() external view returns (uint16);

Returns

Name	Type	Description
<none>	uint16

setLiquidationLtvPremiumBps

Set maximum Liquidation LTV premium (in basis points) which is allowed to be set when calling setLiquidationLtvPremiumBps().

function setLiquidationLtvPremiumBps(uint16 premiumBps) external;

Parameters

Name	Type	Description
premiumBps	uint16

setMaxLiquidationLtvPremiumBps

Set Liquidation LTV premium (in basis points) of the Liquidation LTV above the Origination LTV

function setMaxLiquidationLtvPremiumBps(uint16 premiumBps) external;

Parameters

Name	Type	Description
premiumBps	uint16

setMaxOriginationLtvDelta

Set the maximum allowed Origination LTV change on any single setOriginationLtvAt(), in absolute terms between the Origination LTV as of now and the targetOriginationLtv

18 decimal places, 0.20e18 == $0.20

function setMaxOriginationLtvDelta(uint96 maxDelta) external;

Parameters

Name	Type	Description
maxDelta	uint96

setMinOriginationLtvTargetTimeDelta

Set the minimum time delta required for Origination LTV to reach it's target value when setOriginationLtvAt() is called.

In seconds.

function setMinOriginationLtvTargetTimeDelta(uint32 minTargetTimeDelta) external;

Parameters

Name	Type	Description
minTargetTimeDelta	uint32

setMaxOriginationLtvRateOfChange

Set the maximum (positive) rate of change of Origination LTV allowed, when setOriginationLtvAt() is called.

Units: [Origination LTV / second]

function setMaxOriginationLtvRateOfChange(
        uint96 originationLtvDelta,
        uint32 timeDelta
    ) external;

Parameters

Name	Type	Description
originationLtvDelta	uint96
timeDelta	uint32

setOriginationLtvAt

Set the target Origination LTV which will incrementally increase from it's current value to targetOriginationLtv between now and targetTime.

targetTime is unixtime, targetOriginationLtv is 18 decimal places, 1.05e18 == $1.05

function setOriginationLtvAt(uint96 targetOriginationLtv, uint40 targetTime) external;

Parameters

Name	Type	Description
targetOriginationLtv	uint96
targetTime	uint40

DECIMALS

The decimal precision of both the Origination LTV and Liquidation LTV

function DECIMALS() external view returns (uint8);

Returns

Name	Type	Description
<none>	uint8

Events

OriginationLtvSetAt

event OriginationLtvSetAt(
        uint96 oldOriginationLtv,
        uint96 newOriginationLtvTarget,
        uint256 targetTime
    );

Parameters

Name	Type	Description
oldOriginationLtv	uint96
newOriginationLtvTarget	uint96
targetTime	uint256

MaxOriginationLtvDeltaSet

event MaxOriginationLtvDeltaSet(uint256 maxDelta);

Parameters

Name	Type	Description
maxDelta	uint256

MinOriginationLtvTargetTimeDeltaSet

event MinOriginationLtvTargetTimeDeltaSet(uint32 maxTargetTimeDelta);

Parameters

Name	Type	Description
maxTargetTimeDelta	uint32

MaxOriginationLtvRateOfChangeSet

event MaxOriginationLtvRateOfChangeSet(uint96 maxRateOfChange);

Parameters

Name	Type	Description
maxRateOfChange	uint96

MaxLiquidationLtvPremiumBpsSet

event MaxLiquidationLtvPremiumBpsSet(uint96 maxPremiumBps);

Parameters

Name	Type	Description
maxPremiumBps	uint96

LiquidationLtvPremiumBpsSet

event LiquidationLtvPremiumBpsSet(uint96 premiumBps);

Parameters

Name	Type	Description
premiumBps	uint96

Errors

BreachedMaxOriginationLtvDelta

error BreachedMaxOriginationLtvDelta(
        uint96 oldOriginationLtv,
        uint96 newOriginationLtv,
        uint256 maxDelta
    );

Parameters

Name	Type	Description
oldOriginationLtv	uint96
newOriginationLtv	uint96
maxDelta	uint256

BreachedMinDateDelta

error BreachedMinDateDelta(uint40 targetTime, uint40 currentDate, uint32 maxTargetTimeDelta);

Parameters

Name	Type	Description
targetTime	uint40
currentDate	uint40
maxTargetTimeDelta	uint32

BreachedMaxOriginationLtvRateOfChange

error BreachedMaxOriginationLtvRateOfChange(uint96 targetRateOfChange, uint96 maxRateOfChange);

Parameters

Name	Type	Description
targetRateOfChange	uint96
maxRateOfChange	uint96

CannotDecreaseLtv

error CannotDecreaseLtv();

InvalidParam

error InvalidParam();