ConstantVariables
GOVERNANCE_SLOT
bytes32 GOVERNANCE_SLOTStorage slot with the admin of the contract. Logic from "proxy.sol". This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is validated in the constructor.
EXCHANGE_PRICES_PRECISION
uint256 EXCHANGE_PRICES_PRECISIONNATIVE_TOKEN_ADDRESS
address NATIVE_TOKEN_ADDRESSaddress that is mapped to the chain native token
NATIVE_AMOUNT_EXCESS_LIMIT
uint256 NATIVE_AMOUNT_EXCESS_LIMITlimit for triggering a revert if sent along excess msg.value is bigger than this amount
SECONDS_PER_YEAR
uint256 SECONDS_PER_YEARIgnoring leap years
MAX_TOKEN_AMOUNT_CAP
uint256 MAX_TOKEN_AMOUNT_CAPlimit any total amount to be half of type(uint128).max (~3.4e38) at type(int128).max (~1.7e38) as safety measure for any potential overflows / unexpected outcomes. This is checked for total borrow / supply.
FORCE_STORAGE_WRITE_AFTER_TIME
uint256 FORCE_STORAGE_WRITE_AFTER_TIMEtime after which a write to storage of exchangePricesAndConfig will happen always.
SMALL_COEFFICIENT_SIZE
uint256 SMALL_COEFFICIENT_SIZEconstants used for BigMath conversion from and to storage
DEFAULT_COEFFICIENT_SIZE
uint256 DEFAULT_COEFFICIENT_SIZEDEFAULT_EXPONENT_SIZE
uint256 DEFAULT_EXPONENT_SIZEDEFAULT_EXPONENT_MASK
uint256 DEFAULT_EXPONENT_MASKFOUR_DECIMALS
uint256 FOUR_DECIMALSconstants to increase readability for using bit masks
TWELVE_DECIMALS
uint256 TWELVE_DECIMALSX8
uint256 X8X14
uint256 X14X15
uint256 X15X16
uint256 X16X18
uint256 X18X24
uint256 X24X33
uint256 X33X64
uint256 X64Variables
_revenueCollector
address _revenueCollectoraddress of contract that gets sent the revenue. Configurable by governance
_status
uint256 _statuspaused status: status = 1 -> normal. status = 2 -> paused. not tightly packed with revenueCollector address to allow for potential changes later that improve gas more (revenueCollector is only rarely used by admin methods, where optimization is not as important). to be replaced with transient storage once EIP-1153 Transient storage becomes available with dencun upgrade.
_isAuth
mapping(address => uint256) _isAuthAuths can set most config values. E.g. contracts that automate certain flows like e.g. adding a new fToken. Governance can add/remove auths. Governance is auth by default
_isGuardian
mapping(address => uint256) _isGuardianGuardians can pause lower class users Governance can add/remove guardians Governance is guardian by default
_userClass
mapping(address => uint256) _userClassclass defines which protocols can be paused by guardians Currently there are 2 classes: 0 can be paused by guardians. 1 cannot be paused by guardians. New protocols are added as class 0 and will be upgraded to 1 over time.
_exchangePricesAndConfig
mapping(address => uint256) _exchangePricesAndConfigexchange prices and token config per token: token -> exchange prices & config
First 16 bits => 0- 15 => borrow rate (in 1e2: 100% = 10_000; 1% = 100 -> max value 65535)
Next 14 bits => 16- 29 => fee on interest from borrowers to lenders (in 1e2: 100% = 10_000; 1% = 100 -> max value 16_383). configurable.
Next 14 bits => 30- 43 => last stored utilization (in 1e2: 100% = 10_000; 1% = 100 -> max value 16_383)
Next 14 bits => 44- 57 => update on storage threshold (in 1e2: 100% = 10_000; 1% = 100 -> max value 16_383). configurable.
Next 33 bits => 58- 90 => last update timestamp (enough until 16 March 2242 -> max value 8589934591)
Next 64 bits => 91-154 => supply exchange price (1e12 -> max value 18_446_744,073709551615)
Next 64 bits => 155-218 => borrow exchange price (1e12 -> max value 18_446_744,073709551615)
Next 1 bit => 219-219 => if 0 then ratio is supplyInterestFree / supplyWithInterest else ratio is supplyWithInterest / supplyInterestFree
Next 14 bits => 220-233 => supplyRatio: supplyInterestFree / supplyWithInterest (in 1e2: 100% = 10_000; 1% = 100 -> max value 16_383)
Next 1 bit => 234-234 => if 0 then ratio is borrowInterestFree / borrowWithInterest else ratio is borrowWithInterest / borrowInterestFree
Next 14 bits => 235-248 => borrowRatio: borrowInterestFree / borrowWithInterest (in 1e2: 100% = 10_000; 1% = 100 -> max value 16_383)
Last 7 bits => 249-255 => empty for future use
if more free bits are needed in the future, update on storage threshold bits could be reduced to 7 bits
(can plan to add MAX_TOKEN_CONFIG_UPDATE_THRESHOLD but need to adjust more bits)
if more bits absolutely needed then we can convert fee, utilization, update on storage threshold,
supplyRatio & borrowRatio from 14 bits to 10bits (1023 max number) where 1000 = 100% & 1 = 0.1%
_rateData
mapping(address => uint256) _rateDataFor rate v2 (two kinks) ----------------------------------------------------- Next 16 bits => 4 - 19 => Rate at utilization 0% (in 1e2: 100% = 10_000; 1% = 100 -> max value 65535) Next 16 bits => 20- 35 => Utilization at kink1 (in 1e2: 100% = 10_000; 1% = 100 -> max value 65535) Next 16 bits => 36- 51 => Rate at utilization kink1 (in 1e2: 100% = 10_000; 1% = 100 -> max value 65535) Next 16 bits => 52- 67 => Utilization at kink2 (in 1e2: 100% = 10_000; 1% = 100 -> max value 65535) Next 16 bits => 68- 83 => Rate at utilization kink2 (in 1e2: 100% = 10_000; 1% = 100 -> max value 65535) Next 16 bits => 84- 99 => Rate at utilization 100% (in 1e2: 100% = 10_000; 1% = 100 -> max value 65535) Last 156 bits => 100-255 => empty for future use
_totalAmounts
mapping(address => uint256) _totalAmountstotal supply / borrow amounts for with / without interest per token: token -> amounts First 64 bits => 0- 63 => total supply with interest in raw (totalSupply = totalSupplyRaw * supplyExchangePrice); BigMath: 56 | 8 Next 64 bits => 64-127 => total interest free supply in normal token amount (totalSupply = totalSupply); BigMath: 56 | 8 Next 64 bits => 128-191 => total borrow with interest in raw (totalBorrow = totalBorrowRaw * borrowExchangePrice); BigMath: 56 | 8 Next 64 bits => 192-255 => total interest free borrow in normal token amount (totalBorrow = totalBorrow); BigMath: 56 | 8
_userSupplyData
mapping(address => mapping(address => uint256)) _userSupplyDatauser supply data per token: user -> token -> data First 1 bit => 0 => mode: user supply with or without interest 0 = without, amounts are in normal (i.e. no need to multiply with exchange price) 1 = with interest, amounts are in raw (i.e. must multiply with exchange price to get actual token amounts) Next 64 bits => 1- 64 => user supply amount (normal or raw depends on 1st bit); BigMath: 56 | 8 Next 64 bits => 65-128 => previous user withdrawal limit (normal or raw depends on 1st bit); BigMath: 56 | 8 Next 33 bits => 129-161 => last triggered process timestamp (enough until 16 March 2242 -> max value 8589934591) Next 14 bits => 162-175 => expand withdrawal limit percentage (in 1e2: 100% = 10_000; 1% = 100 -> max value 16_383). @dev shrinking is instant Next 24 bits => 176-199 => withdrawal limit expand duration in seconds.(Max value 16_777_215; ~4_660 hours, ~194 days) Next 18 bits => 200-217 => base withdrawal limit: below this, 100% withdrawals can be done (normal or raw depends on 1st bit); BigMath: 10 | 8 Next 37 bits => 218-254 => empty for future use Last bit => 255-255 => is user paused (1 = paused, 0 = not paused)
_userBorrowData
mapping(address => mapping(address => uint256)) _userBorrowDatauser borrow data per token: user -> token -> data First 1 bit => 0 => mode: user borrow with or without interest 0 = without, amounts are in normal (i.e. no need to multiply with exchange price) 1 = with interest, amounts are in raw (i.e. must multiply with exchange price to get actual token amounts) Next 64 bits => 1- 64 => user borrow amount (normal or raw depends on 1st bit); BigMath: 56 | 8 Next 64 bits => 65-128 => previous user debt ceiling (normal or raw depends on 1st bit); BigMath: 56 | 8 Next 33 bits => 129-161 => last triggered process timestamp (enough until 16 March 2242 -> max value 8589934591) Next 14 bits => 162-175 => expand debt ceiling percentage (in 1e2: 100% = 10_000; 1% = 100 -> max value 16_383) @dev shrinking is instant Next 24 bits => 176-199 => debt ceiling expand duration in seconds (Max value 16_777_215; ~4_660 hours, ~194 days) Next 18 bits => 200-217 => base debt ceiling: below this, there's no debt ceiling limits (normal or raw depends on 1st bit); BigMath: 10 | 8 Next 18 bits => 218-235 => max debt ceiling: absolute maximum debt ceiling can expand to (normal or raw depends on 1st bit); BigMath: 10 | 8 Next 19 bits => 236-254 => empty for future use Last bit => 255-255 => is user paused (1 = paused, 0 = not paused)
_listedTokens
address[] _listedTokenslist of allowed tokens at Liquidity. tokens that are once configured can never be completely removed. so this array is append-only.