Skip to main content

IYieldRepo

Git Source

Functions

endEpoch

Triggers the yield repurchase facility functionality Access controlled to the "heart" role

Increments the epoch and triggers various actions depending on the new epoch number When epoch == epochLength (21), withdraws the last week's yield and interest from the treasury When epoch % 3 == 0 (once a day), triggers the creation of a bond market with the currently bid amount Otherwise, does nothing. The contract can be shutdown and this function will still work, but executes no logic.

function endEpoch() external;

epoch

========== VIEWS ========== //

Returns the current epoch

function epoch() external view returns (uint48);

isShutdown

Returns whether the contract is shutdown

function isShutdown() external view returns (bool);

getReserveBalance

Returns the current balance of yield generating reserves in the treasury and clearinghouse

function getReserveBalance() external view returns (uint256);

getNextYield

Returns the next yield amount which is converted to the bid budget

This value uses the current sDAI balance, but always assumes a week's worth of interest for the clearinghouse Therefore, it's only accurate when called close to the end of the epoch

function getNextYield() external view returns (uint256);

getOhmBalanceAndBacking

Returns the contract's OHM balance and the DAI balance to be returned for burning the OHM

This computes a DAI amount using contract ohm balance and backing of 11.33 DAI

function getOhmBalanceAndBacking() external view returns (uint256, uint256);