IEarnerRateModel

Inherits: IRateModel

Author: M^0 Labs

Functions

The interval over which there's confidence cash flow to earners will not exceed cash flows from minters.

function RATE_CONFIDENCE_INTERVAL() external view returns (uint32);

The percent (in basis points) of the earner rate that will be effectively used.

function RATE_MULTIPLIER() external view returns (uint32);

100% in basis points.

function ONE() external view returns (uint32);

The M Token contract address.

function mToken() external view returns (address);

The Minter Gateway contract address.

function minterGateway() external view returns (address);

The TTG Registrar contract address.

function ttgRegistrar() external view returns (address);

The max rate in basis points.

function maxRate() external view returns (uint256);

Returns the safe earner rate.

function getSafeEarnerRate(uint240 totalActiveOwedM, uint240 totalEarningSupply, uint32 minterRate)
    external
    pure
    returns (uint32);

Parameters

Name

Type

Description

totalActiveOwedM

uint240

The total active owed M.

totalEarningSupply

uint240

The total earning supply of M Token.

minterRate

uint32

The minter rate.

Returns

Name

Type

Description

<none>

uint32

The safe earner rate.

Emitted when M Token contract address is zero.

error ZeroMToken();

Emitted when Minter Gateway contract address is zero.

error ZeroMinterGateway();

Emitted when TTG Registrar contract address is zero.

error ZeroTTGRegistrar();