Skip to content

Latest commit

 

History

History
197 lines (141 loc) · 5.02 KB

AlkemiRateModel.md

File metadata and controls

197 lines (141 loc) · 5.02 KB
layout title
default
AlkemiRateModel

Earn Interest Rate Model (AlkemiRateModel.sol)

View Source: contracts/AlkemiRateModel.sol

↗ Extends: Exponential

{{ContractName}}

See Model here

Enums

IRError

enum IRError {
 NO_ERROR,
 FAILED_TO_ADD_CASH_PLUS_BORROWS,
 FAILED_TO_GET_EXP,
 FAILED_TO_MUL_PRODUCT_TIMES_BORROW_RATE
}

Contract Members

Constants & Variables

//internal members
uint256 internal constant blocksPerYear;
struct Exponential.Exp internal SpreadLow;
struct Exponential.Exp internal BreakPointLow;
struct Exponential.Exp internal ReserveLow;
struct Exponential.Exp internal ReserveMid;
struct Exponential.Exp internal SpreadMid;
struct Exponential.Exp internal BreakPointHigh;
struct Exponential.Exp internal ReserveHigh;
struct Exponential.ExpNegative internal SpreadHigh;
struct Exponential.Exp internal MinRateActual;
struct Exponential.Exp internal HealthyMinURActual;
struct Exponential.Exp internal HealthyMinRateActual;
struct Exponential.Exp internal MaxRateActual;
struct Exponential.Exp internal HealthyMaxURActual;
struct Exponential.Exp internal HealthyMaxRateActual;

//public members
address public owner;
address public newOwner;
string public contractName;

Events

event OwnerUpdate(address indexed owner, address indexed newOwner);

Modifiers

onlyOwner

modifier onlyOwner() internal

Arguments

Name Type Description

Functions

changeRates

function changeRates(string _contractName, uint256 MinRate, uint256 HealthyMinUR, uint256 HealthyMinRate, uint256 HealthyMaxUR, uint256 HealthyMaxRate, uint256 MaxRate) public nonpayable onlyOwner

Arguments

Name Type Description
_contractName string
MinRate uint256
HealthyMinUR uint256
HealthyMinRate uint256
HealthyMaxUR uint256
HealthyMaxRate uint256
MaxRate uint256

transferOwnership

function transferOwnership(address newOwner_) external nonpayable onlyOwner

Arguments

Name Type Description
newOwner_ address

acceptOwnership

function acceptOwnership() external nonpayable

Arguments

Name Type Description

getUtilizationRate

function getUtilizationRate(uint256 cash, uint256 borrows) internal pure
returns(enum AlkemiRateModel.IRError, struct Exponential.Exp)

Arguments

Name Type Description
cash uint256
borrows uint256

getUtilizationAndAnnualBorrowRate

function getUtilizationAndAnnualBorrowRate(uint256 cash, uint256 borrows) internal view
returns(enum AlkemiRateModel.IRError, struct Exponential.Exp, struct Exponential.Exp)

Arguments

Name Type Description
cash uint256
borrows uint256

getSupplyRate

Gets the current supply interest rate based on the given asset, total cash and total borrows

function getSupplyRate(address _asset, uint256 cash, uint256 borrows) public view
returns(uint256, uint256)

Returns

Success or failure and the supply interest rate per block scaled by 10e18

Arguments

Name Type Description
_asset address The asset to get the interest rate of
cash uint256 The total cash of the asset in the market
borrows uint256 The total borrows of the asset in the market

getBorrowRate

Gets the current borrow interest rate based on the given asset, total cash and total borrows

function getBorrowRate(address asset, uint256 cash, uint256 borrows) public view
returns(uint256, uint256)

Returns

Success or failure and the borrow interest rate per block scaled by 10e18

Arguments

Name Type Description
asset address The asset to get the interest rate of
cash uint256 The total cash of the asset in the market
borrows uint256 The total borrows of the asset in the market