Contract Name:
QPriceOracle
Contract Source Code:
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import {IERC20Upgradeable as IERC20} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import {IERC20MetadataUpgradeable as IERC20Metadata} from "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
import "./interfaces/chainlink/AggregatorV3Interface.sol";
import "./interfaces/moonwell/MTokenInterfaces.sol";
import "./interfaces/IQPriceOracle.sol";
import "./libraries/QTypes.sol";
import "./QAdmin.sol";
contract QPriceOracle is Initializable, IQPriceOracle {
/// @notice Contract storing all global Qoda parameters
QAdmin private _qAdmin;
/// @notice Constructor for upgradeable contracts
/// @param qAdminAddress_ Address of the `QAdmin` contract
function initialize(address qAdminAddress_) public initializer {
_qAdmin = QAdmin(qAdminAddress_);
}
/// @notice Converts any local value into its value in USD using oracle feed price
/// @param token ERC20 token
/// @param amountLocal Amount denominated in terms of the ERC20 token
/// @return uint Amount in USD (6 digit precision)
function localToUSD(IERC20 token, uint amountLocal) external view returns(uint){
return _localToUSD(token, amountLocal);
}
/// @notice Converts any value in USD into its value in local using oracle feed price
/// @param token ERC20 token
/// @param valueUSD Amount in USD (6 digit precision)
/// @return uint Amount denominated in terms of the ERC20 token
function USDToLocal(IERC20 token, uint valueUSD) external view returns(uint){
return _USDToLocal(token, valueUSD);
}
/// @notice Convenience function for getting price feed from Chainlink oracle
/// @param oracleFeed Address of the chainlink oracle feed
/// @return answer uint256, decimals uint8
function priceFeed(address oracleFeed) external view returns(uint256, uint8){
return _priceFeed(oracleFeed);
}
/// @notice Compound/Moonwell do not provide a view function for retrieving the
/// current exchange rate between the yield bearing token and the underlying
/// token. The protocol includes an exchangeRateCurrent() function which gives
/// the value that we need, but it includes writes to storage, which is not gas
/// efficient for our usage. Hence, we need this function to manually calculate
/// the current exchange rate as a view function from the last stored exchange
/// rate using 1) the interest accrual and 2) exchange rate formulas.
/// @param mTokenAddress Address of the mToken contract
function mTokenExchRateCurrent(address mTokenAddress) external view returns(uint){
return _mTokenExchRateCurrent(mTokenAddress);
}
/// @notice Converts any local value into its value in USD using oracle feed price
/// @param token ERC20 token
/// @param amountLocal Amount denominated in terms of the ERC20 token
/// @return uint Amount in USD (6 decimal place precision)
function _localToUSD(IERC20 token, uint amountLocal) internal view returns(uint){
// Check that the token is an enabled asset
QTypes.Asset memory asset = _qAdmin.assets(token);
require(asset.isEnabled, "QollateralManager: asset not supported");
// Instantiate the underlying token ERC20 with decimal data
IERC20Metadata underlyingMetadata = IERC20Metadata(asset.underlying);
if(asset.isYieldBearing){
// If the asset is yield-bearing, we need one extra step first
// to convert from the amount of yield bearing tokens to
// the amount of underlying tokens
// mTokenExchRate is value of 1 mToken in underlying token
uint mTokenExchRate = _mTokenExchRateCurrent(address(token));
// amountUnderlying = mTokenAmount * mTokenExchRate / 10^18
uint amountUnderlying = amountLocal * mTokenExchRate / (10 ** 18);
// amountLocal now represents the amount of underlying tokens
amountLocal = amountUnderlying;
}
// Get the oracle feed
address oracleFeed = asset.oracleFeed;
(uint exchRate, uint8 exchDecimals) = _priceFeed(oracleFeed);
// Initialize all the necessary mantissas first
uint exchRateMantissa = 10 ** exchDecimals;
uint tokenMantissa = 10 ** underlyingMetadata.decimals();
// Apply exchange rate to convert from amount of underlying tokens to value in USD
uint valueUSD = amountLocal * exchRate * _qAdmin.MANTISSA_STABLECOIN();
// Divide by mantissas last for maximum precision
valueUSD = valueUSD / tokenMantissa / exchRateMantissa;
return valueUSD;
}
/// @notice Converts any value in USD into its amount in local using oracle feed price.
/// For yield-bearing tokens, it will convert the value in USD directly into the
/// amount of yield-bearing token (NOT the amount of underlying token)
/// @param token ERC20 token
/// @param valueUSD Amount in USD (6 digit precision)
/// @return uint Amount denominated in terms of the ERC20 token
function _USDToLocal(IERC20 token, uint valueUSD) internal view returns(uint){
// Check that the token is an enabled asset
QTypes.Asset memory asset = _qAdmin.assets(token);
require(asset.isEnabled, "QollateralManager: token not supported");
// Instantiate the underlying token ERC20 with decimal data
IERC20Metadata underlyingMetadata = IERC20Metadata(asset.underlying);
// Get the oracle feed
address oracleFeed = asset.oracleFeed;
(uint exchRate, uint8 exchDecimals) = _priceFeed(oracleFeed);
// Initialize all the necessary mantissas first
uint exchRateMantissa = 10 ** exchDecimals;
uint tokenMantissa = 10 ** underlyingMetadata.decimals();
// Multiply by mantissas first for maximum precision
uint amountUnderlying = valueUSD * tokenMantissa * exchRateMantissa;
// Apply exchange rate to convert from value in USD to amount of underlying tokens
amountUnderlying = amountUnderlying / exchRate / _qAdmin.MANTISSA_STABLECOIN();
if(asset.isYieldBearing){
// If the asset is yield-bearing, we need one extra step to convert
// from the amount of underlying tokens to the amount of yield-bearing
// tokens
// mTokenExchRate is value of 1 mToken in underlying tokens
uint mTokenExchRate = _mTokenExchRateCurrent(address(token));
// Multiply by mantissa first for maximum precision
uint amountMToken = amountUnderlying * (10 ** 18) / mTokenExchRate;
return amountMToken;
}else{
// The asset is already the native underlying token, so we can just
// return the amount of underlying tokens directly
return amountUnderlying;
}
}
/// @notice Convenience function for getting price feed from Chainlink oracle
/// @param oracleFeed Address of the chainlink oracle feed
/// @return answer uint256, decimals uint8
function _priceFeed(address oracleFeed) internal view returns(uint256, uint8){
AggregatorV3Interface aggregator = AggregatorV3Interface(oracleFeed);
(, int256 answer,,,) = aggregator.latestRoundData();
uint8 decimals = aggregator.decimals();
return (uint(answer), decimals);
}
/// @notice Compound/Moonwell do not provide a view function for retrieving the
/// current exchange rate between the yield bearing token and the underlying
/// token. The protocol includes an exchangeRateCurrent() function which gives
/// the value that we need, but it includes writes to storage, which is not gas
/// efficient for our usage. Hence, we need this function to manually calculate
/// the current exchange rate as a view function from the last stored exchange
/// rate using 1) the interest accrual and 2) exchange rate formulas.
/// @param mTokenAddress Address of the mToken contract
function _mTokenExchRateCurrent(address mTokenAddress) internal view returns(uint){
MTokenInterface mToken = MTokenInterface(mTokenAddress);
// Step 1. Calculate Interest Accruals
// See the accrueInterest() function in MToken.sol for implementation details
// NOTE: Moonwell fork uses timestamps for interest calcs, NOT block as
// per Compound. We will need to change the function call to
// accrualBlockNumber() if we want to be compatible with Compound
uint latestAccrualTimestamp = mToken.accrualBlockTimestamp();
uint currentTimestamp = block.timestamp;
if(currentTimestamp <= latestAccrualTimestamp){
// No blocks have passed since the last interest accrual, so
// we can just return the stored exchange rate directly
return mToken.exchangeRateStored();
}
uint borrowRateMantissa = mToken.interestRateModel().getBorrowRate(mToken.getCash(),
mToken.totalBorrows(),
mToken.totalReserves()
);
uint simpleInterestFactor = borrowRateMantissa * (currentTimestamp - latestAccrualTimestamp);
uint interestAccumulated = simpleInterestFactor * mToken.totalBorrows() / 1e18;
uint totalBorrowsNew = interestAccumulated + mToken.totalBorrows();
uint totalReservesNew = mToken.reserveFactorMantissa() * interestAccumulated / 1e18 + mToken.totalReserves();
// Step 2. Calculate Exchange Rate
// See exchangeRateCurrent(), exchangeRateStored(), and
// exchangeRateStoredInternal() in MToken.sol for implementation details
uint totalSupply = mToken.totalSupply();
uint cashPlusBorrowsMinusReserves = (mToken.getCash() + totalBorrowsNew - totalReservesNew);
uint exchRateCurrent = cashPlusBorrowsMinusReserves * 1e18 / totalSupply;
// Step 3. Perform sanity checks. `exchangeRateCurrent` should not deviate
// by too much from `exchangeRateStored`
require(
exchRateCurrent <= mToken.exchangeRateStored() * 11 / 10,
"QPriceOracle: currentExchangeRate out of bounds"
);
require(
exchRateCurrent >= mToken.exchangeRateStored() * 10 / 11,
"QPriceOracle: currentExchangeRate out of bounds"
);
return exchRateCurrent;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts. Equivalent to `reinitializer(1)`.
*/
modifier initializer() {
bool isTopLevelCall = _setInitializedVersion(1);
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* `initializer` is equivalent to `reinitializer(1)`, so a reinitializer may be used after the original
* initialization step. This is essential to configure modules that are added through upgrades and that require
* initialization.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*/
modifier reinitializer(uint8 version) {
bool isTopLevelCall = _setInitializedVersion(version);
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(version);
}
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*/
function _disableInitializers() internal virtual {
_setInitializedVersion(type(uint8).max);
}
function _setInitializedVersion(uint8 version) private returns (bool) {
// If the contract is initializing we ignore whether _initialized is set in order to support multiple
// inheritance patterns, but we only do this in the context of a constructor, and for the lowest level
// of initializers, because in other contexts the contract may have been reentered.
if (_initializing) {
require(
version == 1 && !AddressUpgradeable.isContract(address(this)),
"Initializable: contract is already initialized"
);
return false;
} else {
require(_initialized < version, "Initializable: contract is already initialized");
_initialized = version;
return true;
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20Upgradeable {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address from,
address to,
uint256 amount
) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20MetadataUpgradeable is IERC20Upgradeable {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.9;
interface AggregatorV3Interface {
/**
* Returns the decimals to offset on the getLatestPrice call
*/
function decimals() external view returns (uint8);
/**
* Returns the description of the underlying price feed aggregator
*/
function description() external view returns (string memory);
/**
* Returns the version number representing the type of aggregator the proxy points to
*/
function version() external view returns (uint256);
/**
* Returns price data about a specific round
*/
function getRoundData(uint80 _roundId) external view returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
/**
* Returns price data from the latest round
*/
function latestRoundData() external view returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
import {IERC20Upgradeable as IERC20} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import "./InterestRateModel.sol";
interface MTokenInterface is IERC20 {
function accrualBlockTimestamp() external view returns(uint);
function exchangeRateStored() external view returns(uint);
function getCash() external view returns(uint);
function totalBorrows() external view returns(uint);
function totalReserves() external view returns(uint);
function reserveFactorMantissa() external view returns(uint);
function interestRateModel() external view returns(InterestRateModel);
}
interface MErc20Interface is MTokenInterface {
function mint(uint mintAmount) external returns (uint);
function redeem(uint redeemTokens) external returns (uint);
function redeemUnderlying(uint redeemAmount) external returns (uint);
function borrow(uint borrowAmount) external returns (uint);
function repayBorrow(uint repayAmount) external returns (uint);
function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint);
function liquidateBorrow(address borrower, uint repayAmount, MTokenInterface mTokenCollateral) external returns (uint);
}
interface MGlimmerInterface is MTokenInterface {
function mint() external payable;
function redeem(uint redeemTokens) external returns (uint);
function redeemUnderlying(uint redeemAmount) external returns (uint);
function borrow(uint borrowAmount) external returns (uint);
function repayBorrow() external payable;
function repayBorrowBehalf(address borrower) external payable;
function liquidateBorrow(address borrower, MTokenInterface mTokenCollateral) external payable;
}
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
import {IERC20Upgradeable as IERC20} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
interface IQPriceOracle {
/// @notice Converts any local value into its value in USD using oracle feed price
/// @param token ERC20 token
/// @param amountLocal Amount denominated in terms of the ERC20 token
/// @return uint Amount in USD
function localToUSD(IERC20 token, uint amountLocal) external view returns(uint);
/// @notice Converts any value in USD into its value in local using oracle feed price
/// @param token ERC20 token
/// @param valueUSD Amount in USD
/// @return uint Amount denominated in terms of the ERC20 token
function USDToLocal(IERC20 token, uint valueUSD) external view returns(uint);
/// @notice Convenience function for getting price feed from Chainlink oracle
/// @param oracleFeed Address of the chainlink oracle feed
/// @return answer uint256, decimals uint8
function priceFeed(address oracleFeed) external view returns(uint256, uint8);
}
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
library QTypes {
/// @notice Contains all the details of an Asset. Assets must be defined
/// before they can be used as collateral.
/// @member isEnabled True if an asset is defined, false otherwise
/// @member isYieldBearing True if token bears interest (eg aToken, cToken, mToken, etc)
/// @member underlying Address of the underlying token
/// @member oracleFeed Address of the corresponding chainlink oracle feed
/// @member collateralFactor 0.0 to 1.0 (scaled to 1e8) for discounting risky assets
/// @member marketFactor 0.0 1.0 for premium on risky borrows
/// @member maturities Iterable storage for all enabled maturities
struct Asset {
bool isEnabled;
bool isYieldBearing;
address underlying;
address oracleFeed;
uint collateralFactor;
uint marketFactor;
uint[] maturities;
}
/// @notice Contains all the fields of a published Quote
/// @notice quoteId ID of the quote - this is the keccak256 hash of signature
/// @param marketAddress Address of `FixedRateLoanMarket` contract
/// @param quoter Account of the Quoter
/// @param quoteType 0 for PV+APR, 1 for FV+APR
/// @param side 0 if Quoter is borrowing, 1 if Quoter is lending
/// @param quoteExpiryTime Timestamp after which the quote is no longer valid
/// @param APR In decimal form scaled by 1e4 (ex. 10.52% = 1052)
/// @param cashflow Can be PV or FV depending on `quoteType`
/// @param nonce For uniqueness of signature
/// @param signature Signed hash of the Quote message
struct Quote {
bytes32 quoteId;
address marketAddress;
address quoter;
uint8 quoteType;
uint8 side;
uint64 quoteExpiryTime; //if 0, then quote never expires
uint64 APR;
uint cashflow;
uint nonce;
bytes signature;
}
}
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
import {AccessControlEnumerableUpgradeable as AccessControlEnumerable} from "@openzeppelin/contracts-upgradeable/access/AccessControlEnumerableUpgradeable.sol";
import {IERC20Upgradeable as IERC20} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "./interfaces/IFixedRateMarket.sol";
import "./interfaces/IQollateralManager.sol";
import "./interfaces/IQAdmin.sol";
import "./libraries/QTypes.sol";
contract QAdmin is Initializable, AccessControlEnumerable, IQAdmin {
/// @notice Identifier of the admin role
bytes32 public constant ADMIN_ROLE = keccak256("ADMIN");
/// @notice Identifier of the market role
bytes32 public constant MARKET_ROLE = keccak256("MARKET");
/// @notice Contract for managing user collateral
IQollateralManager private _qollateralManager;
/// @notice If collateral ratio falls below `_minCollateralRatio`, it is subject to liquidation
/// Scaled by 1e8
uint private _minCollateralRatio;
/// @notice When initially taking a loan, collateral ratio must be higher than this.
/// `_initCollateralRatio` should always be higher than `_minCollateralRatio`
/// Scaled by 1e8
uint private _initCollateralRatio;
/// @notice The percent, ranging from 0% to 100%, of a liquidatable account's
/// borrow that can be repaid in a single liquidate transaction.
/// Scaled by 1e8
uint private _closeFactor;
/// @notice Grace period (in seconds) after maturity before lenders are allowed to
/// redeem their qTokens for underlying tokens
uint private _maturityGracePeriod;
/// @notice Additional collateral given to liquidator as incentive to liquidate
/// underwater accounts. For example, if liquidation incentive is 1.1, liquidator
/// receives extra 10% of borrowers' collateral
/// Scaled by 1e8
uint private _liquidationIncentive;
/// @notice Annualized fee for loans in basis points. The fee is charged to
/// both the lender and the borrower on any given deal. The fee rate will
/// need to be scaled for loans that mature outside of 1 year.
/// Scaled by 1e4
uint private _protocolFee;
/// @notice All enabled `Asset`s
/// tokenAddress => Asset
mapping(IERC20 => QTypes.Asset) private _assets;
/// @notice Get the `FixedRateMarket` contract address for any given
/// token and maturity time
/// tokenAddress => maturity => fixedRateMarket
mapping(IERC20 => mapping(uint => IFixedRateMarket)) private _fixedRateMarkets;
/// @notice Mapping for the MToken market corresponding to any underlying ERC20
/// tokenAddress => mTokenAddress
mapping(IERC20 => address) private _underlyingToMToken;
/// @notice Mapping to determine whether a `FixedRateMarket` address
/// is enabled or not
/// fixedRateMarket => bool
mapping(IFixedRateMarket => bool) private _enabledMarkets;
/// @notice Mapping to determine the minimum quote size for any `FixedRateMarket`
/// in PV terms, denominated in local currency
/// fixedRateMarket => minQuoteSize
mapping(IFixedRateMarket => uint) private _minQuoteSize;
/// @notice Constructor for upgradeable contracts
function initialize(address admin) public initializer {
// Initialize access control
__AccessControlEnumerable_init();
_setupRole(ADMIN_ROLE, admin);
_setRoleAdmin(ADMIN_ROLE, ADMIN_ROLE);
// Set initial values for parameters
_minCollateralRatio = 1e8;
_initCollateralRatio = 1.1e8;
_closeFactor = 0.5e8;
_maturityGracePeriod = 28800;
_liquidationIncentive = 1.1e8;
_protocolFee = .0020e4;
}
modifier onlyAdmin() {
require(hasRole(ADMIN_ROLE, msg.sender), "QAdmin: only admin");
_;
}
modifier onlyMarket() {
require(hasRole(MARKET_ROLE, msg.sender), "QAdmin: only market");
_;
}
/** ADMIN FUNCTIONS **/
/// @notice Call upon initialization after deploying `QollateralManager` contract
/// @param qollateralManagerAddress Address of `QollateralManager` deployment
function _initializeQollateralManager(address qollateralManagerAddress) external onlyAdmin {
// Initialize the value
_qollateralManager = IQollateralManager(qollateralManagerAddress);
}
/// @notice Admin function for adding new Assets. An Asset must be added before it
/// can be used as collateral or borrowed. Note: We can create functionality for
/// allowing borrows of a token but not using it as collateral by setting
/// `collateralFactor` to zero.
/// @param token ERC20 token corresponding to the Asset
/// @param isYieldBearing True if token bears interest (eg aToken, cToken, mToken, etc)
/// @param underlying Address of the underlying token
/// @param oracleFeed Chainlink price feed address
/// @param collateralFactor 0.0 to 1.0 (scaled to 1e8) for discounting risky assets
/// @param marketFactor 0.0 to 1.0 (scaled to 1e8) for premium on risky borrows
function _addAsset(
IERC20 token,
bool isYieldBearing,
address underlying,
address oracleFeed,
uint collateralFactor,
uint marketFactor
) external onlyAdmin {
// Cannot add the same asset twice
require(!_assets[token].isEnabled, "QAdmin: asset already exists");
// `collateralFactor` must be between 0 and 1 (scaled to 1e8)
require(
collateralFactor <= MAX_COLLATERAL_FACTOR(),
"QAdmin: invalid collateral factor"
);
// `marketFactor` must be between 0 and 1 (scaled to 1e8)
require(
marketFactor <= MAX_MARKET_FACTOR(),
"QAdmin: invalid market factor"
);
// Initialize the `Asset` with the given parameters, and no enabled
// maturities to begin with
uint[] memory maturities;
QTypes.Asset memory asset = QTypes.Asset(
true,
isYieldBearing,
underlying,
oracleFeed,
collateralFactor,
marketFactor,
maturities
);
_assets[token] = asset;
// Add yield-bearing assets to the (underlying => MToken) mapping
if(isYieldBearing) {
_underlyingToMToken[IERC20(underlying)]= address(token);
}
// Emit the event
emit AddAsset(address(token), isYieldBearing, oracleFeed, collateralFactor, marketFactor);
}
/// @notice Adds a new `FixedRateMarket` contract into the internal mapping of
/// whitelisted market addresses
/// @param market New `FixedRateMarket` contract
function _addFixedRateMarket(IFixedRateMarket market) external onlyAdmin {
// Get athe values from the corresponding `FixedRateMarket` contract
uint maturity = market.maturity();
IERC20 token = market.underlyingToken();
// Don't allow zero address
require(address(token) != address(0), "QAdmin: invalid token address");
// Only allow `Markets` where the corresponding `Asset` is enabled
require(_assets[token].isEnabled, "QAdmin: unsupported asset");
// Check that this market hasn't already been instantiated before
require(
address(_fixedRateMarkets[token][maturity]) == address(0),
"QAdmin: market already exists"
);
// Add the maturity as enabled to the corresponding Asset
QTypes.Asset storage asset = _assets[token];
asset.maturities.push(maturity);
// Add newly-created `FixedRateMarket` to the lookup list
_fixedRateMarkets[token][maturity] = market;
// Enable newly-created `FixedRateMarket`
_enabledMarkets[market] = true;
// Give `FixedRateMarket` the MARKET access control role
_setupRole(MARKET_ROLE, address(market));
// Emit the event
emit CreateFixedRateMarket(
address(market),
address(token),
maturity
);
}
/// @notice Update the `collateralFactor` for a given `Asset`
/// @param token ERC20 token corresponding to the Asset
/// @param collateralFactor 0.0 to 1.0 (scaled to 1e8) for discounting risky assets
function _setCollateralFactor(
IERC20 token,
uint collateralFactor
) external onlyAdmin {
// Asset must already be enabled
require(_assets[token].isEnabled, "QAdmin: asset not enabled");
// `collateralFactor` must be between 0 and 1 (scaled to 1e8)
require(
collateralFactor <= MAX_COLLATERAL_FACTOR(),
"QAdmin: invalid collateral factor"
);
// Look up the corresponding asset
QTypes.Asset storage asset = _assets[token];
// Emit the event
emit SetCollateralFactor(address(token), asset.collateralFactor, collateralFactor);
// Set `collateralFactor`
asset.collateralFactor = collateralFactor;
}
/// @notice Update the `marketFactor` for a given `Asset`
/// @param token Address of the token corresponding to the Asset
/// @param marketFactor 0.0 to 1.0 (scaled to 1e8) for discounting risky assets
function _setMarketFactor(
IERC20 token,
uint marketFactor
) external onlyAdmin {
// Asset must already be enabled
require(_assets[token].isEnabled, "QAdmin: asset not enabled");
// `marketFactor` must be between 0 and 1 (scaled to 1e8)
require(
marketFactor <= MAX_MARKET_FACTOR(),
"QAdmin: invalid asset factor"
);
// Look up the corresponding asset
QTypes.Asset storage asset = _assets[token];
// Emit the event
emit SetMarketFactor(address(token), asset.marketFactor, marketFactor);
// Set `marketFactor`
asset.marketFactor = marketFactor;
}
/// @notice Set the minimum quote size for a particular `FixedRateMarket`
/// @param market Address of the `FixedRateMarket` contract
/// @param minQuoteSize_ Size in PV terms, local currency
function _setMinQuoteSize(IFixedRateMarket market, uint minQuoteSize_) external onlyAdmin {
// `FixedRateMarket` must already exist
require(
address(_fixedRateMarkets[market.underlyingToken()][market.maturity()]) != address(0),
"QAdmin: market doesn't exist"
);
// Emit the event
emit SetMinQuoteSize(address(market), _minQuoteSize[market], minQuoteSize_);
// Set `minQuoteSize`
_minQuoteSize[market] = minQuoteSize_;
}
/// @notice Set the global initial collateral ratio
/// @param initCollateralRatio_ New collateral ratio value
function _setInitCollateralRatio(uint initCollateralRatio_) external onlyAdmin {
// `_initCollateralRatio` cannot be below `_minCollateralRatio`
require(
initCollateralRatio_ >= _minCollateralRatio,
"QAdmin: init collateral ratio must be greater than min collateral ratio"
);
// Emit the event
emit SetInitCollateralRatio(_initCollateralRatio, initCollateralRatio_);
// Set `_initialCollateralRatio` to new value
_initCollateralRatio = initCollateralRatio_;
}
/// @notice Set the global close factor
/// @param closeFactor_ New close factor value
function _setCloseFactor(uint closeFactor_) external onlyAdmin {
// `_closeFactor` needs to be between 0 and 1
require(closeFactor_ <= MANTISSA_FACTORS(), "QAdmin: must be between 0 and 1");
// Emit the event
emit SetCloseFactor(_closeFactor, closeFactor_);
// Set `_closeFactor` to new value
_closeFactor = closeFactor_;
}
function _setMaturityGracePeriod(uint maturityGracePeriod_) external onlyAdmin {
// `_maturityGracePeriod` needs to be <= 60*60*24 (ie 24 hours)
require(maturityGracePeriod_ <= 86400, "QAdmin: must be below 1 day");
// Emit the event
emit SetMaturityGracePeriod(_maturityGracePeriod, maturityGracePeriod_);
// set `_maturityGracePeriod` to new value
_maturityGracePeriod = maturityGracePeriod_;
}
/// @notice Set the global liquidation incetive
/// @param liquidationIncentive_ New liquidation incentive value
function _setLiquidationIncentive(uint liquidationIncentive_) external onlyAdmin {
// `_liquidationIncentive` needs to be greater than or equal to 1
require(
liquidationIncentive_ >= MANTISSA_FACTORS(),
"QAdmin: must be greater than or equal to 1"
);
// Emit the event
emit SetLiquidationIncentive(_liquidationIncentive, liquidationIncentive_);
// Set `_liquidationIncentive` to new value
_liquidationIncentive = liquidationIncentive_;
}
/// @notice Set the global annualized protocol fees in basis points
/// @param protocolFee_ New protocol fee value (scaled to 1e4)
function _setProtocolFee(uint protocolFee_) external onlyAdmin {
// Max annual protocol fees of 250 basis points
require(protocolFee_ <= 250, "QAdmin: must be less than 2.5%");
// Min annual protocol fees of 1 basis point
require(protocolFee_ >= 1, "QAdmin: must be greater than .01%");
// Emit the event
emit SetProtocolFee(_protocolFee, protocolFee_);
// Set `_protocolFee` to new value
_protocolFee = protocolFee_;
}
/** VIEW FUNCTIONS **/
/// @notice Get the address of the `QollateralManager` contract
function qollateralManager() external view returns(address) {
return address(_qollateralManager);
}
/// @notice Gets the `Asset` mapped to the address of a ERC20 token
/// @param token ERC20 token
/// @return QTypes.Asset Associated `Asset`
function assets(IERC20 token) external view returns(QTypes.Asset memory) {
return _assets[token];
}
/// @notice Get the MToken market corresponding to any underlying ERC20
/// tokenAddress => mTokenAddress
function underlyingToMToken(IERC20 token) external view returns(address) {
return _underlyingToMToken[token];
}
/// @notice Gets the address of the `FixedRateMarket` contract
/// @param token ERC20 token
/// @param maturity UNIX timestamp of the maturity date
/// @return IFixedRateMarket Address of `FixedRateMarket` contract
function fixedRateMarkets(
IERC20 token,
uint maturity
) external view returns(IFixedRateMarket){
return _fixedRateMarkets[token][maturity];
}
/// @notice Check whether an address is a valid FixedRateMarket address.
/// Can be used for checks for inter-contract admin/restricted function call.
/// @param market `FixedRateMarket` contract
/// @return bool True if valid false otherwise
function isMarketEnabled(IFixedRateMarket market) external view returns(bool){
return _enabledMarkets[market];
}
function minQuoteSize(IFixedRateMarket market) external view returns(uint) {
return _minQuoteSize[market];
}
function minCollateralRatio() public view returns(uint){
return _minCollateralRatio;
}
function initCollateralRatio() public view returns(uint){
return _initCollateralRatio;
}
function closeFactor() public view returns(uint){
return _closeFactor;
}
function maturityGracePeriod() public view returns(uint){
return _maturityGracePeriod;
}
function liquidationIncentive() public view returns(uint){
return _liquidationIncentive;
}
function protocolFee() public view returns(uint){
return _protocolFee;
}
/// @notice 2**256 - 1
function UINT_MAX() public pure returns(uint){
return type(uint).max;
}
/// @notice Generic mantissa corresponding to ETH decimals
function MANTISSA_DEFAULT() public pure returns(uint){
return 1e18;
}
/// @notice Mantissa for stablecoins
function MANTISSA_STABLECOIN() public pure returns(uint){
return 1e6;
}
/// @notice Mantissa for collateral ratio
function MANTISSA_COLLATERAL_RATIO() public pure returns(uint){
return 1e8;
}
/// @notice `assetFactor` and `marketFactor` have up to 8 decimal places precision
function MANTISSA_FACTORS() public pure returns(uint){
return 1e8;
}
/// @notice Basis points have 4 decimal place precision
function MANTISSA_BPS() public pure returns(uint){
return 1e4;
}
/// @notice `collateralFactor` cannot be above 1.0
function MAX_COLLATERAL_FACTOR() public pure returns(uint){
return 1e8;
}
/// @notice `marketFactor` cannot be above 1.0
function MAX_MARKET_FACTOR() public pure returns(uint){
return 1e8;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library AddressUpgradeable {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
interface InterestRateModel {
/**
* @notice Calculates the current borrow interest rate per timestmp
* @param cash The total amount of cash the market has
* @param borrows The total amount of borrows the market has outstanding
* @param reserves The total amount of reserves the market has
* @return The borrow rate per timestmp (as a percentage, and scaled by 1e18)
*/
function getBorrowRate(uint cash, uint borrows, uint reserves) external view returns (uint);
/**
* @notice Calculates the current supply interest rate per timestmp
* @param cash The total amount of cash the market has
* @param borrows The total amount of borrows the market has outstanding
* @param reserves The total amount of reserves the market has
* @param reserveFactorMantissa The current reserve factor the market has
* @return The supply rate per timestmp (as a percentage, and scaled by 1e18)
*/
function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) external view returns (uint);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (access/AccessControlEnumerable.sol)
pragma solidity ^0.8.0;
import "./IAccessControlEnumerableUpgradeable.sol";
import "./AccessControlUpgradeable.sol";
import "../utils/structs/EnumerableSetUpgradeable.sol";
import "../proxy/utils/Initializable.sol";
/**
* @dev Extension of {AccessControl} that allows enumerating the members of each role.
*/
abstract contract AccessControlEnumerableUpgradeable is Initializable, IAccessControlEnumerableUpgradeable, AccessControlUpgradeable {
function __AccessControlEnumerable_init() internal onlyInitializing {
}
function __AccessControlEnumerable_init_unchained() internal onlyInitializing {
}
using EnumerableSetUpgradeable for EnumerableSetUpgradeable.AddressSet;
mapping(bytes32 => EnumerableSetUpgradeable.AddressSet) private _roleMembers;
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControlEnumerableUpgradeable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns one of the accounts that have `role`. `index` must be a
* value between 0 and {getRoleMemberCount}, non-inclusive.
*
* Role bearers are not sorted in any particular way, and their ordering may
* change at any point.
*
* WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
* you perform all queries on the same block. See the following
* https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
* for more information.
*/
function getRoleMember(bytes32 role, uint256 index) public view virtual override returns (address) {
return _roleMembers[role].at(index);
}
/**
* @dev Returns the number of accounts that have `role`. Can be used
* together with {getRoleMember} to enumerate all bearers of a role.
*/
function getRoleMemberCount(bytes32 role) public view virtual override returns (uint256) {
return _roleMembers[role].length();
}
/**
* @dev Overload {_grantRole} to track enumerable memberships
*/
function _grantRole(bytes32 role, address account) internal virtual override {
super._grantRole(role, account);
_roleMembers[role].add(account);
}
/**
* @dev Overload {_revokeRole} to track enumerable memberships
*/
function _revokeRole(bytes32 role, address account) internal virtual override {
super._revokeRole(role, account);
_roleMembers[role].remove(account);
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
import {IERC20Upgradeable as IERC20} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import {IERC20MetadataUpgradeable as IERC20Metadata} from "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
interface IFixedRateMarket is IERC20, IERC20Metadata {
/// @notice Emitted when a borrower repays borrow.
/// Boolean flag `withQTokens`= true if repaid via qTokens, false otherwise.
event RepayBorrow(address indexed borrower, uint amount, bool withQTokens);
/// @notice Emitted when a borrower is liquidated
event LiquidateBorrow(
address indexed borrower,
address indexed liquidator,
uint amount,
address collateralTokenAddress,
uint reward
);
/// @notice Emitted when a borrower and lender are matched for a fixed rate loan
event FixedRateLoan(
bytes32 indexed quoteId,
address indexed borrower,
address indexed lender,
uint amountPV,
uint amountFV);
/// @notice Emitted when an account cancels their Quote
event CancelQuote(address indexed account, uint nonce);
/// @notice Emitted when an account redeems their qTokens
event RedeemQTokens(address indexed account, uint amount);
/** USER INTERFACE **/
/// @notice Execute against Quote as a borrower.
/// @param amountPV Amount that the borrower wants to execute as PV
/// @param lender Account of the lender
/// @param quoteType *Lender's* type preference, 0 for PV+APR, 1 for FV+APR
/// @param quoteExpiryTime Timestamp after which the quote is no longer valid
/// @param APR In decimal form scaled by 1e4 (ex. 10.52% = 1052)
/// @param cashflow Can be PV or FV depending on `quoteType`
/// @param nonce For uniqueness of signature
/// @param signature signed hash of the Quote message
/// @return uint, uint Loan amount (`amountPV`) and repayment amount (`amountFV`)
function borrow(
uint amountPV,
address lender,
uint8 quoteType,
uint64 quoteExpiryTime,
uint64 APR,
uint cashflow,
uint nonce,
bytes memory signature
) external returns(uint, uint);
/// @notice Execute against Quote as a lender.
/// @param amountPV Amount that the lender wants to execute as PV
/// @param borrower Account of the borrower
/// @param quoteType *Borrower's* type preference, 0 for PV+APR, 1 for FV+APR
/// @param quoteExpiryTime Timestamp after which the quote is no longer valid
/// @param APR In decimal form scaled by 1e4 (ex. 10.52% = 1052)
/// @param cashflow Can be PV or FV depending on `quoteType`
/// @param nonce For uniqueness of signature
/// @param signature signed hash of the Quote message
/// @return uint, uint Loan amount (`amountPV`) and repayment amount (`amountFV`)
function lend(
uint amountPV,
address borrower,
uint8 quoteType,
uint64 quoteExpiryTime,
uint64 APR,
uint cashflow,
uint nonce,
bytes memory signature
) external returns(uint, uint);
/// @notice Borrower will make repayments to the smart contract, which
/// holds the value in escrow until maturity to release to lenders.
/// @param amount Amount to repay
/// @return uint Remaining account borrow amount
function repayBorrow(uint amount) external returns(uint);
/// @notice By setting the nonce in `_voidNonces` to true, this is equivalent to
/// invalidating the Quote (i.e. cancelling the quote)
/// param nonce Nonce of the Quote to be cancelled
function cancelQuote(uint nonce) external;
/// @notice This function allows net lenders to redeem qTokens for the
/// underlying token. Redemptions may only be permitted after loan maturity
/// plus `_maturityGracePeriod`. The public interface redeems the entire qToken
/// balance.
/// @param amount Amount of qTokens to redeem
function redeemQTokens(uint amount) external;
/// @notice If an account is in danger of being undercollateralized (i.e.
/// liquidityRatio < 1.0), any user may liquidate that account by paying
/// back the loan on behalf of the account. In return, the liquidator receives
/// collateral belonging to the account equal in value to the repayment amount
/// in USD plus the liquidation incentive amount as a bonus.
/// @param borrower Address of account that is undercollateralized
/// @param amount Amount to repay on behalf of account
/// @param collateralToken Liquidator's choice of which currency to be paid in
function liquidateBorrow(
address borrower,
uint amount,
IERC20 collateralToken
) external;
/** VIEW FUNCTIONS **/
/// @notice Get the address of the `QollateralManager`
/// @return address
function qollateralManager() external view returns(address);
/// @notice Get the address of the ERC20 token which the loan will be denominated
/// @return IERC20
function underlyingToken() external view returns(IERC20);
/// @notice Get the UNIX timestamp (in seconds) when the market matures
/// @return uint
function maturity() external view returns(uint);
/// @notice Get the minimum quote size for this market
/// @return uint Minimum quote size, in PV terms, local currency
function minQuoteSize() external view returns(uint);
/// @notice True if a nonce for a Quote is voided, false otherwise.
/// Used for checking if a Quote is a duplicated.
/// @param account Account to query
/// @param nonce Nonce to query
/// @return bool True if used, false otherwise
function isNonceVoid(address account, uint nonce) external view returns(bool);
/// @notice Get the total balance of borrows by user
/// @param account Account to query
/// @return uint Borrows
function accountBorrows(address account) external view returns(uint);
/// @notice Get the current total partial fill for a Quote
/// @param quoteId ID of the Quote - this is the keccak256 hash of the signature
/// @return uint Partial fill
function quoteFill(bytes32 quoteId) external view returns(uint);
}
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
import {IERC20Upgradeable as IERC20} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import "./IFixedRateMarket.sol";
interface IQollateralManager {
/// @notice Emitted when an account deposits collateral into the contract
event DepositCollateral(address indexed account, address tokenAddress, uint amount);
/// @notice Emitted when an account withdraws collateral from the contract
event WithdrawCollateral(address indexed account, address tokenAddress, uint amount);
/// @notice Emitted when an account first interacts with the `Market`
event AddAccountMarket(address indexed account, address indexed market);
/// @notice Emitted when collateral is transferred from one account to another
event TransferCollateral(address indexed tokenAddress, address indexed from, address indexed to, uint amount);
/// @notice Constructor for upgradeable contracts
/// @param qAdminAddress_ Address of the `QAdmin` contract
/// @param qPriceOracleAddress_ Address of the `QPriceOracle` contract
function initialize(address qAdminAddress_, address qPriceOracleAddress_) external;
/** ADMIN/RESTRICTED FUNCTIONS **/
/// @notice Record when an account has either borrowed or lent into a
/// `FixedRateMarket`. This is necessary because we need to iterate
/// across all markets that an account has borrowed/lent to to calculate their
/// `borrowValue`. Only the `FixedRateMarket` contract itself may call
/// this function
/// @param account User account
/// @param market Address of the `FixedRateMarket` market
function _addAccountMarket(address account, IFixedRateMarket market) external;
/// @notice Transfer collateral balances from one account to another. Only
/// `FixedRateMarket` contracts can call this restricted function. This is used
/// for when a liquidator liquidates an account.
/// @param token ERC20 token
/// @param from Sender address
/// @param to Recipient address
/// @param amount Amount to transfer
function _transferCollateral(IERC20 token, address from, address to, uint amount) external;
/** USER INTERFACE **/
/// @notice Users call this to deposit collateral to fund their borrows
/// @param token ERC20 token
/// @param amount Amount to deposit (in local ccy)
/// @return uint New collateral balance
function depositCollateral(IERC20 token, uint amount) external returns(uint);
/// @notice Users call this to deposit collateral to fund their borrows, where their
/// collateral is automatically wrapped into MTokens for convenience so users can
/// automatically earn interest on their collateral.
/// @param underlying Underlying ERC20 token
/// @param amount Amount to deposit (in underlying local currency)
/// @return uint New collateral balance (in MToken balance)
function depositCollateralWithMTokenWrap(IERC20 underlying, uint amount) external returns(uint);
/// @notice Users call this to withdraw collateral
/// @param token ERC20 token
/// @param amount Amount to withdraw (in local ccy)
/// @return uint New collateral balance
function withdrawCollateral(IERC20 token, uint amount) external returns(uint);
/// @notice Users call this to withdraw mToken collateral, where their
/// collateral is automatically unwrapped into underlying tokens for
/// convenience.
/// @param mTokenAddress Yield-bearing token address
/// @param amount Amount to withdraw (in mToken local currency)
/// @return uint New collateral balance (in MToken balance)
function withdrawCollateralWithMTokenUnwrap(
address mTokenAddress,
uint amount
) external returns(uint);
/** VIEW FUNCTIONS **/
/// @notice Get the address of the `QAdmin` contract
/// @return address Address of `QAdmin` contract
function qAdmin() external view returns(address);
/// @notice Return what the collateral ratio for an account would be
/// with a hypothetical collateral withdraw and/or token borrow.
/// The collateral ratio is calculated as:
/// (`virtualCollateralValue` / `virtualBorrowValue`)
/// If the returned value falls below 1e8, the account can be liquidated
/// @param account User account
/// @param withdrawToken Currency of hypothetical withdraw
/// @param withdrawAmount Amount of hypothetical withdraw in local currency
/// @param borrowMarket Market of hypothetical borrow
/// @param borrowAmount Amount of hypothetical borrow in local ccy
/// @return uint Hypothetical collateral ratio
function hypotheticalCollateralRatio(
address account,
IERC20 withdrawToken,
uint withdrawAmount,
IFixedRateMarket borrowMarket,
uint borrowAmount
) external view returns(uint);
/// @notice Return the current collateral ratio for an account.
/// The collateral ratio is calculated as:
/// (`virtualCollateralValue` / `virtualBorrowValue`)
/// If the returned value falls below 1e8, the account can be liquidated
/// @param account User account
/// @return uint Collateral ratio
function collateralRatio(address account) external view returns(uint);
/// @notice Get the `collateralFactor` weighted value (in USD) of all the
/// collateral deposited for an account
/// @param account Account to query
/// @return uint Total value of account in USD
function virtualCollateralValue(address account) external view returns(uint);
/// @notice Get the `collateralFactor` weighted value (in USD) for the tokens
/// deposited for an account
/// @param account Account to query
/// @param token ERC20 token
/// @return uint Value of token collateral of account in USD
function virtualCollateralValueByToken(
address account,
IERC20 token
) external view returns(uint);
/// @notice Get the `marketFactor` weighted net borrows (i.e. borrows - lends)
/// in USD summed across all `Market`s participated in by the user
/// @param account Account to query
/// @return uint Borrow value of account in USD
function virtualBorrowValue(address account) external view returns(uint);
/// @notice Get the `marketFactor` weighted net borrows (i.e. borrows - lends)
/// in USD for a particular `Market`
/// @param account Account to query
/// @param market `FixedRateMarket` contract
/// @return uint Borrow value of account in USD
function virtualBorrowValueByMarket(
address account,
IFixedRateMarket market
) external view returns(uint);
/// @notice Get the unweighted value (in USD) of all the collateral deposited
/// for an account
/// @param account Account to query
/// @return uint Total value of account in USD
function realCollateralValue(address account) external view returns(uint);
/// @notice Get the unweighted value (in USD) of the tokens deposited
/// for an account
/// @param account Account to query
/// @param token ERC20 token
/// @return uint Value of token collateral of account in USD
function realCollateralValueByToken(
address account,
IERC20 token
) external view returns(uint);
/// @notice Get the unweighted current net value borrowed (i.e. borrows - lends)
/// in USD summed across all `Market`s participated in by the user
/// @param account Account to query
/// @return uint Borrow value of account in USD
function realBorrowValue(address account) external view returns(uint);
/// @notice Get the unweighted current net value borrowed (i.e. borrows - lends)
/// in USD for a particular `Market`
/// @param account Account to query
/// @param market `FixedRateMarket` contract
/// @return uint Borrow value of account in USD
function realBorrowValueByMarket(
address account,
IFixedRateMarket market
) external view returns(uint);
/// @notice Get the minimum collateral ratio. Scaled by 1e8.
/// @return uint Minimum collateral ratio
function minCollateralRatio() external view returns(uint);
/// @notice Get the initial collateral ratio. Scaled by 1e8
/// @return uint Initial collateral ratio
function initCollateralRatio() external view returns(uint);
/// @notice Get the close factor. Scaled by 1e8
/// @return uint Close factor
function closeFactor() external view returns(uint);
/// @notice Get the liquidation incentive. Scaled by 1e8
/// @return uint Liquidation incentive
function liquidationIncentive() external view returns(uint);
/// @notice Use this for quick lookups of collateral balances by asset
/// @param account User account
/// @param token ERC20 token
/// @return uint Balance in local
function collateralBalance(address account, IERC20 token) external view returns(uint);
/// @notice Get iterable list of collateral addresses which an account has nonzero balance.
/// @param account User account
/// @return address[] Iterable list of ERC20 token addresses
function iterableCollateralAddresses(address account) external view returns(IERC20[] memory);
/// @notice Quick lookup of whether an account has a particular collateral
/// @param account User account
/// @param token ERC20 token addresses
/// @return bool True if account has collateralized with given ERC20 token, false otherwise
function accountCollateral(address account, IERC20 token) external view returns(bool);
/// @notice Get iterable list of all Markets which an account has participated
/// @param account User account
/// @return address[] Iterable list of `FixedRateLoanMarket` contract addresses
function iterableAccountMarkets(address account) external view returns(IFixedRateMarket[] memory);
/// @notice Quick lookup of whether an account has participated in a Market
/// @param account User account
/// @param market`FixedRateLoanMarket` contract
/// @return bool True if participated, false otherwise
function accountMarkets(address account, IFixedRateMarket market) external view returns(bool);
/// @notice Converts any local value into its value in USD using oracle feed price
/// @param token ERC20 token
/// @param amountLocal Amount denominated in terms of the ERC20 token
/// @return uint Amount in USD
function localToUSD(IERC20 token, uint amountLocal) external view returns(uint);
/// @notice Converts any value in USD into its value in local using oracle feed price
/// @param token ERC20 token
/// @param valueUSD Amount in USD
/// @return uint Amount denominated in terms of the ERC20 token
function USDToLocal(IERC20 token, uint valueUSD) external view returns(uint);
}
//SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.9;
import {IERC20Upgradeable as IERC20} from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import {IAccessControlUpgradeable} from "@openzeppelin/contracts-upgradeable/access/IAccessControlUpgradeable.sol";
import "./IFixedRateMarket.sol";
import "../libraries/QTypes.sol";
interface IQAdmin is IAccessControlUpgradeable {
/// @notice Emitted when a new FixedRateMarket is deployed
event CreateFixedRateMarket(address indexed marketAddress, address indexed tokenAddress, uint maturity);
/// @notice Emitted when a new `Asset` is added
event AddAsset(
address indexed tokenAddress,
bool isYieldBearing,
address oracleFeed,
uint collateralFactor,
uint marketFactor);
/// @notice Emitted when setting `collateralFactor`
event SetCollateralFactor(address indexed tokenAddress, uint oldValue, uint newValue);
/// @notice Emitted when setting `marketFactor`
event SetMarketFactor(address indexed tokenAddress, uint oldValue, uint newValue);
/// @notice Emitted when setting `minQuoteSize`
event SetMinQuoteSize(address indexed tokenAddress, uint oldValue, uint newValue);
/// @notice Emitted when `_initCollateralRatio` gets updated
event SetInitCollateralRatio(uint oldValue, uint newValue);
/// @notice Emitted when `_closeFactor` gets updated
event SetCloseFactor(uint oldValue, uint newValue);
/// @notice Emitted when `_maturityGracePeriod` gets updated
event SetMaturityGracePeriod(uint oldValue, uint newValue);
/// @notice Emitted when `_liquidationIncentive` gets updated
event SetLiquidationIncentive(uint oldValue, uint newValue);
/// @notice Emitted when `_protocolFee` gets updated
event SetProtocolFee(uint oldValue, uint newValue);
/** ADMIN FUNCTIONS **/
/// @notice Call upon initialization after deploying `QollateralManager` contract
/// @param qollateralManagerAddress Address of `QollateralManager` deployment
function _initializeQollateralManager(address qollateralManagerAddress) external;
/// @notice Admin function for adding new Assets. An Asset must be added before it
/// can be used as collateral or borrowed. Note: We can create functionality for
/// allowing borrows of a token but not using it as collateral by setting
/// `collateralFactor` to zero.
/// @param token ERC20 token corresponding to the Asset
/// @param isYieldBearing True if token bears interest (eg aToken, cToken, mToken, etc)
/// @param underlying Address of the underlying token
/// @param oracleFeed Chainlink price feed address
/// @param collateralFactor 0.0 to 1.0 (scaled to 1e8) for discounting risky assets
/// @param marketFactor 0.0 to 1.0 (scaled to 1e8) for premium on risky borrows
function _addAsset(
IERC20 token,
bool isYieldBearing,
address underlying,
address oracleFeed,
uint collateralFactor,
uint marketFactor
) external;
/// @notice Adds a new `FixedRateMarket` contract into the internal mapping of
/// whitelisted market addresses
/// @param market New `FixedRateMarket` contract
function _addFixedRateMarket(IFixedRateMarket market) external;
/// @notice Update the `collateralFactor` for a given `Asset`
/// @param token ERC20 token corresponding to the Asset
/// @param collateralFactor 0.0 to 1.0 (scaled to 1e8) for discounting risky assets
function _setCollateralFactor(IERC20 token, uint collateralFactor) external;
/// @notice Update the `marketFactor` for a given `Asset`
/// @param token Address of the token corresponding to the Asset
/// @param marketFactor 0.0 to 1.0 (scaled to 1e8) for discounting risky assets
function _setMarketFactor(IERC20 token, uint marketFactor) external;
/// @notice Set the minimum quote size for a particular `FixedRateMarket`
/// @param market Address of the `FixedRateMarket` contract
/// @param minQuoteSize_ Size in PV terms, local currency
function _setMinQuoteSize(IFixedRateMarket market, uint minQuoteSize_) external;
/// @notice Set the global initial collateral ratio
/// @param initCollateralRatio_ New collateral ratio value
function _setInitCollateralRatio(uint initCollateralRatio_) external;
/// @notice Set the global close factor
/// @param closeFactor_ New close factor value
function _setCloseFactor(uint closeFactor_) external;
function _setMaturityGracePeriod(uint maturityGracePeriod_) external;
/// @notice Set the global liquidation incetive
/// @param liquidationIncentive_ New liquidation incentive value
function _setLiquidationIncentive(uint liquidationIncentive_) external;
/// @notice Set the global annualized protocol fees in basis points
/// @param protocolFee_ New protocol fee value (scaled to 1e4)
function _setProtocolFee(uint protocolFee_) external;
/** VIEW FUNCTIONS **/
function ADMIN_ROLE() external view returns(bytes32);
function MARKET_ROLE() external view returns(bytes32);
/// @notice Get the address of the `QollateralManager` contract
function qollateralManager() external view returns(address);
/// @notice Gets the `Asset` mapped to the address of a ERC20 token
/// @param token ERC20 token
/// @return QTypes.Asset Associated `Asset`
function assets(IERC20 token) external view returns(QTypes.Asset memory);
/// @notice Get the MToken market corresponding to any underlying ERC20
/// tokenAddress => mTokenAddress
function underlyingToMToken(IERC20 token) external view returns(address);
/// @notice Gets the address of the `FixedRateMarket` contract
/// @param token ERC20 token
/// @param maturity UNIX timestamp of the maturity date
/// @return IFixedRateMarket Address of `FixedRateMarket` contract
function fixedRateMarkets(IERC20 token, uint maturity) external view returns(IFixedRateMarket);
/// @notice Check whether an address is a valid FixedRateMarket address.
/// Can be used for checks for inter-contract admin/restricted function call.
/// @param market `FixedRateMarket` contract
/// @return bool True if valid false otherwise
function isMarketEnabled(IFixedRateMarket market) external view returns(bool);
function minQuoteSize(IFixedRateMarket market) external view returns(uint);
function minCollateralRatio() external view returns(uint);
function initCollateralRatio() external view returns(uint);
function closeFactor() external view returns(uint);
function maturityGracePeriod() external view returns(uint);
function liquidationIncentive() external view returns(uint);
function protocolFee() external view returns(uint);
/// @notice 2**256 - 1
function UINT_MAX() external pure returns(uint);
/// @notice Generic mantissa corresponding to ETH decimals
function MANTISSA_DEFAULT() external pure returns(uint);
/// @notice Mantissa for stablecoins
function MANTISSA_STABLECOIN() external pure returns(uint);
/// @notice Mantissa for collateral ratio
function MANTISSA_COLLATERAL_RATIO() external pure returns(uint);
/// @notice `assetFactor` and `marketFactor` have up to 8 decimal places precision
function MANTISSA_FACTORS() external pure returns(uint);
/// @notice Basis points have 4 decimal place precision
function MANTISSA_BPS() external pure returns(uint);
/// @notice `collateralFactor` cannot be above 1.0
function MAX_COLLATERAL_FACTOR() external pure returns(uint);
/// @notice `marketFactor` cannot be above 1.0
function MAX_MARKET_FACTOR() external pure returns(uint);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControlEnumerable.sol)
pragma solidity ^0.8.0;
import "./IAccessControlUpgradeable.sol";
/**
* @dev External interface of AccessControlEnumerable declared to support ERC165 detection.
*/
interface IAccessControlEnumerableUpgradeable is IAccessControlUpgradeable {
/**
* @dev Returns one of the accounts that have `role`. `index` must be a
* value between 0 and {getRoleMemberCount}, non-inclusive.
*
* Role bearers are not sorted in any particular way, and their ordering may
* change at any point.
*
* WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
* you perform all queries on the same block. See the following
* https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
* for more information.
*/
function getRoleMember(bytes32 role, uint256 index) external view returns (address);
/**
* @dev Returns the number of accounts that have `role`. Can be used
* together with {getRoleMember} to enumerate all bearers of a role.
*/
function getRoleMemberCount(bytes32 role) external view returns (uint256);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (access/AccessControl.sol)
pragma solidity ^0.8.0;
import "./IAccessControlUpgradeable.sol";
import "../utils/ContextUpgradeable.sol";
import "../utils/StringsUpgradeable.sol";
import "../utils/introspection/ERC165Upgradeable.sol";
import "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it.
*/
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {
function __AccessControl_init() internal onlyInitializing {
}
function __AccessControl_init_unchained() internal onlyInitializing {
}
struct RoleData {
mapping(address => bool) members;
bytes32 adminRole;
}
mapping(bytes32 => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with a standardized message including the required role.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*
* _Available since v4.1._
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual override returns (bool) {
return _roles[role].members[account];
}
/**
* @dev Revert with a standard message if `_msgSender()` is missing `role`.
* Overriding this function changes the behavior of the {onlyRole} modifier.
*
* Format of the revert message is described in {_checkRole}.
*
* _Available since v4.6._
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Revert with a standard message if `account` is missing `role`.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert(
string(
abi.encodePacked(
"AccessControl: account ",
StringsUpgradeable.toHexString(uint160(account), 20),
" is missing role ",
StringsUpgradeable.toHexString(uint256(role), 32)
)
)
);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) public virtual override {
require(account == _msgSender(), "AccessControl: can only renounce roles for self");
_revokeRole(role, account);
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event. Note that unlike {grantRole}, this function doesn't perform any
* checks on the calling account.
*
* [WARNING]
* ====
* This function should only be called from the constructor when setting
* up the initial roles for the system.
*
* Using this function in any other way is effectively circumventing the admin
* system imposed by {AccessControl}.
* ====
*
* NOTE: This function is deprecated in favor of {_grantRole}.
*/
function _setupRole(bytes32 role, address account) internal virtual {
_grantRole(role, account);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
bytes32 previousAdminRole = getRoleAdmin(role);
_roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Grants `role` to `account`.
*
* Internal function without access restriction.
*/
function _grantRole(bytes32 role, address account) internal virtual {
if (!hasRole(role, account)) {
_roles[role].members[account] = true;
emit RoleGranted(role, account, _msgSender());
}
}
/**
* @dev Revokes `role` from `account`.
*
* Internal function without access restriction.
*/
function _revokeRole(bytes32 role, address account) internal virtual {
if (hasRole(role, account)) {
_roles[role].members[account] = false;
emit RoleRevoked(role, account, _msgSender());
}
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (utils/structs/EnumerableSet.sol)
pragma solidity ^0.8.0;
/**
* @dev Library for managing
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
* types.
*
* Sets have the following properties:
*
* - Elements are added, removed, and checked for existence in constant time
* (O(1)).
* - Elements are enumerated in O(n). No guarantees are made on the ordering.
*
* ```
* contract Example {
* // Add the library methods
* using EnumerableSet for EnumerableSet.AddressSet;
*
* // Declare a set state variable
* EnumerableSet.AddressSet private mySet;
* }
* ```
*
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
* and `uint256` (`UintSet`) are supported.
*/
library EnumerableSetUpgradeable {
// To implement this library for multiple types with as little code
// repetition as possible, we write it in terms of a generic Set type with
// bytes32 values.
// The Set implementation uses private functions, and user-facing
// implementations (such as AddressSet) are just wrappers around the
// underlying Set.
// This means that we can only create new EnumerableSets for types that fit
// in bytes32.
struct Set {
// Storage of set values
bytes32[] _values;
// Position of the value in the `values` array, plus 1 because index 0
// means a value is not in the set.
mapping(bytes32 => uint256) _indexes;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function _add(Set storage set, bytes32 value) private returns (bool) {
if (!_contains(set, value)) {
set._values.push(value);
// The value is stored at length-1, but we add 1 to all indexes
// and use 0 as a sentinel value
set._indexes[value] = set._values.length;
return true;
} else {
return false;
}
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function _remove(Set storage set, bytes32 value) private returns (bool) {
// We read and store the value's index to prevent multiple reads from the same storage slot
uint256 valueIndex = set._indexes[value];
if (valueIndex != 0) {
// Equivalent to contains(set, value)
// To delete an element from the _values array in O(1), we swap the element to delete with the last one in
// the array, and then remove the last element (sometimes called as 'swap and pop').
// This modifies the order of the array, as noted in {at}.
uint256 toDeleteIndex = valueIndex - 1;
uint256 lastIndex = set._values.length - 1;
if (lastIndex != toDeleteIndex) {
bytes32 lastValue = set._values[lastIndex];
// Move the last value to the index where the value to delete is
set._values[toDeleteIndex] = lastValue;
// Update the index for the moved value
set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
}
// Delete the slot where the moved value was stored
set._values.pop();
// Delete the index for the deleted slot
delete set._indexes[value];
return true;
} else {
return false;
}
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function _contains(Set storage set, bytes32 value) private view returns (bool) {
return set._indexes[value] != 0;
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function _length(Set storage set) private view returns (uint256) {
return set._values.length;
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function _at(Set storage set, uint256 index) private view returns (bytes32) {
return set._values[index];
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function _values(Set storage set) private view returns (bytes32[] memory) {
return set._values;
}
// Bytes32Set
struct Bytes32Set {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _add(set._inner, value);
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _remove(set._inner, value);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
return _contains(set._inner, value);
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(Bytes32Set storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
return _at(set._inner, index);
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
return _values(set._inner);
}
// AddressSet
struct AddressSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(AddressSet storage set, address value) internal returns (bool) {
return _add(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(AddressSet storage set, address value) internal returns (bool) {
return _remove(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(AddressSet storage set, address value) internal view returns (bool) {
return _contains(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(AddressSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(AddressSet storage set, uint256 index) internal view returns (address) {
return address(uint160(uint256(_at(set._inner, index))));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(AddressSet storage set) internal view returns (address[] memory) {
bytes32[] memory store = _values(set._inner);
address[] memory result;
assembly {
result := store
}
return result;
}
// UintSet
struct UintSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(UintSet storage set, uint256 value) internal returns (bool) {
return _add(set._inner, bytes32(value));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(UintSet storage set, uint256 value) internal returns (bool) {
return _remove(set._inner, bytes32(value));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(UintSet storage set, uint256 value) internal view returns (bool) {
return _contains(set._inner, bytes32(value));
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function length(UintSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(UintSet storage set, uint256 index) internal view returns (uint256) {
return uint256(_at(set._inner, index));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(UintSet storage set) internal view returns (uint256[] memory) {
bytes32[] memory store = _values(set._inner);
uint256[] memory result;
assembly {
result := store
}
return result;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
pragma solidity ^0.8.0;
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControlUpgradeable {
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {AccessControl-_setupRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
import "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Strings.sol)
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library StringsUpgradeable {
bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
// Inspired by OraclizeAPI's implementation - MIT licence
// https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
if (value == 0) {
return "0";
}
uint256 temp = value;
uint256 digits;
while (temp != 0) {
digits++;
temp /= 10;
}
bytes memory buffer = new bytes(digits);
while (value != 0) {
digits -= 1;
buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
value /= 10;
}
return string(buffer);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
if (value == 0) {
return "0x00";
}
uint256 temp = value;
uint256 length = 0;
while (temp != 0) {
length++;
temp >>= 8;
}
return toHexString(value, length);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _HEX_SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165Upgradeable.sol";
import "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165Upgradeable).interfaceId;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165Upgradeable {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}