Created
April 27, 2022 21:02
-
-
Save SibghatUllah1997/db641df865753bc0f1871562510b5af1 to your computer and use it in GitHub Desktop.
Created using remix-ide: Realtime Ethereum Contract Compiler and Runtime. Load this file by pasting this gists URL or ID at https://remix.ethereum.org/#version=soljson-v0.5.16+commit.9c3226ce.js&optimize=true&runs=200&gist=
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deployment Flow | |
i. We have to deploy Comptroller | |
ii: Then Deploy White paper Interest Rate Model arguments can be seen from https://docs.google.com/spreadsheets/d/101xdxBvdAQBcrbCL31QSgrYxbWjLN3Bz/edit#gid=1662325606 | |
iii: Deploy Chain Link | |
iv: Deploy CErc20Delegate.sol | |
v: Deploy the underlying asset | |
vi: Deploy CErc20 or CErc20Delegator and pass the underlying contract address and other params | |
vii: Set Market Comptroller | |
viii: Support Market Comptroller | |
ix: Set Collateral Factor | |
x: Chain Link set direct and set underlying price and set feed by passing CToken or CErc20Delegator address | |
xi: approve from underlying asset by passing CErc20Delegator address | |
xii: mint from CErc20Delegator | |
xii: Borrow from delegator |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// address 0x9284214ab91477A5E3910edF091A6de57D3e821b | |
/** | |
*Submitted for verification at BscScan.com on 2020-09-22 | |
*/ | |
pragma solidity 0.6.12; | |
// | |
/* | |
* @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 GSN 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. | |
*/ | |
contract Context { | |
// Empty internal constructor, to prevent people from mistakenly deploying | |
// an instance of this contract, which should be used via inheritance. | |
constructor() internal {} | |
function _msgSender() internal view returns (address payable) { | |
return msg.sender; | |
} | |
function _msgData() internal view returns (bytes memory) { | |
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691 | |
return msg.data; | |
} | |
} | |
// | |
/** | |
* @dev Contract module which provides a basic access control mechanism, where | |
* there is an account (an owner) that can be granted exclusive access to | |
* specific functions. | |
* | |
* By default, the owner account will be the one that deploys the contract. This | |
* can later be changed with {transferOwnership}. | |
* | |
* This module is used through inheritance. It will make available the modifier | |
* `onlyOwner`, which can be applied to your functions to restrict their use to | |
* the owner. | |
*/ | |
contract Ownable is Context { | |
address private _owner; | |
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); | |
/** | |
* @dev Initializes the contract setting the deployer as the initial owner. | |
*/ | |
constructor() internal { | |
address msgSender = _msgSender(); | |
_owner = msgSender; | |
emit OwnershipTransferred(address(0), msgSender); | |
} | |
/** | |
* @dev Returns the address of the current owner. | |
*/ | |
function owner() public view returns (address) { | |
return _owner; | |
} | |
/** | |
* @dev Throws if called by any account other than the owner. | |
*/ | |
modifier onlyOwner() { | |
require(_owner == _msgSender(), 'Ownable: caller is not the owner'); | |
_; | |
} | |
/** | |
* @dev Leaves the contract without owner. It will not be possible to call | |
* `onlyOwner` functions anymore. Can only be called by the current owner. | |
* | |
* NOTE: Renouncing ownership will leave the contract without an owner, | |
* thereby removing any functionality that is only available to the owner. | |
*/ | |
function renounceOwnership() public onlyOwner { | |
emit OwnershipTransferred(_owner, address(0)); | |
_owner = address(0); | |
} | |
/** | |
* @dev Transfers ownership of the contract to a new account (`newOwner`). | |
* Can only be called by the current owner. | |
*/ | |
function transferOwnership(address newOwner) public onlyOwner { | |
_transferOwnership(newOwner); | |
} | |
/** | |
* @dev Transfers ownership of the contract to a new account (`newOwner`). | |
*/ | |
function _transferOwnership(address newOwner) internal { | |
require(newOwner != address(0), 'Ownable: new owner is the zero address'); | |
emit OwnershipTransferred(_owner, newOwner); | |
_owner = newOwner; | |
} | |
} | |
// | |
interface IBEP20 { | |
/** | |
* @dev Returns the amount of tokens in existence. | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @dev Returns the token decimals. | |
*/ | |
function decimals() external view returns (uint8); | |
/** | |
* @dev Returns the token symbol. | |
*/ | |
function symbol() external view returns (string memory); | |
/** | |
* @dev Returns the token name. | |
*/ | |
function name() external view returns (string memory); | |
/** | |
* @dev Returns the bep token owner. | |
*/ | |
function getOwner() external view returns (address); | |
/** | |
* @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 `recipient`. | |
* | |
* Returns a boolean value indicating whether the operation succeeded. | |
* | |
* Emits a {Transfer} event. | |
*/ | |
function transfer(address recipient, 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 `sender` to `recipient` 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 sender, | |
address recipient, | |
uint256 amount | |
) external returns (bool); | |
/** | |
* @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 Wrappers over Solidity's arithmetic operations with added overflow | |
* checks. | |
* | |
* Arithmetic operations in Solidity wrap on overflow. This can easily result | |
* in bugs, because programmers usually assume that an overflow raises an | |
* error, which is the standard behavior in high level programming languages. | |
* `SafeMath` restores this intuition by reverting the transaction when an | |
* operation overflows. | |
* | |
* Using this library instead of the unchecked operations eliminates an entire | |
* class of bugs, so it's recommended to use it always. | |
*/ | |
library SafeMath { | |
/** | |
* @dev Returns the addition of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `+` operator. | |
* | |
* Requirements: | |
* | |
* - Addition cannot overflow. | |
*/ | |
function add(uint256 a, uint256 b) internal pure returns (uint256) { | |
uint256 c = a + b; | |
require(c >= a, 'SafeMath: addition overflow'); | |
return c; | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b) internal pure returns (uint256) { | |
return sub(a, b, 'SafeMath: subtraction overflow'); | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* | |
* - Subtraction cannot overflow. | |
*/ | |
function sub( | |
uint256 a, | |
uint256 b, | |
string memory errorMessage | |
) internal pure returns (uint256) { | |
require(b <= a, errorMessage); | |
uint256 c = a - b; | |
return c; | |
} | |
/** | |
* @dev Returns the multiplication of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `*` operator. | |
* | |
* Requirements: | |
* | |
* - Multiplication cannot overflow. | |
*/ | |
function mul(uint256 a, uint256 b) internal pure returns (uint256) { | |
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the | |
// benefit is lost if 'b' is also tested. | |
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 | |
if (a == 0) { | |
return 0; | |
} | |
uint256 c = a * b; | |
require(c / a == b, 'SafeMath: multiplication overflow'); | |
return c; | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b) internal pure returns (uint256) { | |
return div(a, b, 'SafeMath: division by zero'); | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts with custom message on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function div( | |
uint256 a, | |
uint256 b, | |
string memory errorMessage | |
) internal pure returns (uint256) { | |
require(b > 0, errorMessage); | |
uint256 c = a / b; | |
// assert(a == b * c + a % b); // There is no case in which this doesn't hold | |
return c; | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b) internal pure returns (uint256) { | |
return mod(a, b, 'SafeMath: modulo by zero'); | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts with custom message when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function mod( | |
uint256 a, | |
uint256 b, | |
string memory errorMessage | |
) internal pure returns (uint256) { | |
require(b != 0, errorMessage); | |
return a % b; | |
} | |
function min(uint256 x, uint256 y) internal pure returns (uint256 z) { | |
z = x < y ? x : y; | |
} | |
// babylonian method (https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Babylonian_method) | |
function sqrt(uint256 y) internal pure returns (uint256 z) { | |
if (y > 3) { | |
z = y; | |
uint256 x = y / 2 + 1; | |
while (x < z) { | |
z = x; | |
x = (y / x + x) / 2; | |
} | |
} else if (y != 0) { | |
z = 1; | |
} | |
} | |
} | |
// | |
/** | |
* @dev Collection of functions related to the address type | |
*/ | |
library Address { | |
/** | |
* @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 | |
* ==== | |
*/ | |
function isContract(address account) internal view returns (bool) { | |
// According to EIP-1052, 0x0 is the value returned for not-yet created accounts | |
// and 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470 is returned | |
// for accounts without code, i.e. `keccak256('')` | |
bytes32 codehash; | |
bytes32 accountHash = 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470; | |
// solhint-disable-next-line no-inline-assembly | |
assembly { | |
codehash := extcodehash(account) | |
} | |
return (codehash != accountHash && codehash != 0x0); | |
} | |
/** | |
* @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'); | |
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value | |
(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'); | |
return _functionCallWithValue(target, data, value, errorMessage); | |
} | |
function _functionCallWithValue( | |
address target, | |
bytes memory data, | |
uint256 weiValue, | |
string memory errorMessage | |
) private returns (bytes memory) { | |
require(isContract(target), 'Address: call to non-contract'); | |
// solhint-disable-next-line avoid-low-level-calls | |
(bool success, bytes memory returndata) = target.call{value: weiValue}(data); | |
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 | |
// solhint-disable-next-line no-inline-assembly | |
assembly { | |
let returndata_size := mload(returndata) | |
revert(add(32, returndata), returndata_size) | |
} | |
} else { | |
revert(errorMessage); | |
} | |
} | |
} | |
} | |
// | |
/** | |
* @dev Implementation of the {IBEP20} interface. | |
* | |
* This implementation is agnostic to the way tokens are created. This means | |
* that a supply mechanism has to be added in a derived contract using {_mint}. | |
* For a generic mechanism see {BEP20PresetMinterPauser}. | |
* | |
* TIP: For a detailed writeup see our guide | |
* https://forum.zeppelin.solutions/t/how-to-implement-BEP20-supply-mechanisms/226[How | |
* to implement supply mechanisms]. | |
* | |
* We have followed general OpenZeppelin guidelines: functions revert instead | |
* of returning `false` on failure. This behavior is nonetheless conventional | |
* and does not conflict with the expectations of BEP20 applications. | |
* | |
* Additionally, an {Approval} event is emitted on calls to {transferFrom}. | |
* This allows applications to reconstruct the allowance for all accounts just | |
* by listening to said events. Other implementations of the EIP may not emit | |
* these events, as it isn't required by the specification. | |
* | |
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance} | |
* functions have been added to mitigate the well-known issues around setting | |
* allowances. See {IBEP20-approve}. | |
*/ | |
contract BEP20 is Context, IBEP20, Ownable { | |
using SafeMath for uint256; | |
using Address for address; | |
mapping(address => uint256) private _balances; | |
mapping(address => mapping(address => uint256)) private _allowances; | |
uint256 private _totalSupply; | |
string private _name; | |
string private _symbol; | |
uint8 private _decimals; | |
/** | |
* @dev Sets the values for {name} and {symbol}, initializes {decimals} with | |
* a default value of 18. | |
* | |
* To select a different value for {decimals}, use {_setupDecimals}. | |
* | |
* All three of these values are immutable: they can only be set once during | |
* construction. | |
*/ | |
constructor(string memory name, string memory symbol) public { | |
_name = name; | |
_symbol = symbol; | |
_decimals = 18; | |
} | |
/** | |
* @dev Returns the bep token owner. | |
*/ | |
function getOwner() external override view returns (address) { | |
return owner(); | |
} | |
/** | |
* @dev Returns the token name. | |
*/ | |
function name() public override view returns (string memory) { | |
return _name; | |
} | |
/** | |
* @dev Returns the token decimals. | |
*/ | |
function decimals() public override view returns (uint8) { | |
return _decimals; | |
} | |
/** | |
* @dev Returns the token symbol. | |
*/ | |
function symbol() public override view returns (string memory) { | |
return _symbol; | |
} | |
/** | |
* @dev See {BEP20-totalSupply}. | |
*/ | |
function totalSupply() public override view returns (uint256) { | |
return _totalSupply; | |
} | |
/** | |
* @dev See {BEP20-balanceOf}. | |
*/ | |
function balanceOf(address account) public override view returns (uint256) { | |
return _balances[account]; | |
} | |
/** | |
* @dev See {BEP20-transfer}. | |
* | |
* Requirements: | |
* | |
* - `recipient` cannot be the zero address. | |
* - the caller must have a balance of at least `amount`. | |
*/ | |
function transfer(address recipient, uint256 amount) public override returns (bool) { | |
_transfer(_msgSender(), recipient, amount); | |
return true; | |
} | |
/** | |
* @dev See {BEP20-allowance}. | |
*/ | |
function allowance(address owner, address spender) public override view returns (uint256) { | |
return _allowances[owner][spender]; | |
} | |
/** | |
* @dev See {BEP20-approve}. | |
* | |
* Requirements: | |
* | |
* - `spender` cannot be the zero address. | |
*/ | |
function approve(address spender, uint256 amount) public override returns (bool) { | |
_approve(_msgSender(), spender, amount); | |
return true; | |
} | |
/** | |
* @dev See {BEP20-transferFrom}. | |
* | |
* Emits an {Approval} event indicating the updated allowance. This is not | |
* required by the EIP. See the note at the beginning of {BEP20}; | |
* | |
* Requirements: | |
* - `sender` and `recipient` cannot be the zero address. | |
* - `sender` must have a balance of at least `amount`. | |
* - the caller must have allowance for `sender`'s tokens of at least | |
* `amount`. | |
*/ | |
function transferFrom( | |
address sender, | |
address recipient, | |
uint256 amount | |
) public override returns (bool) { | |
_transfer(sender, recipient, amount); | |
_approve( | |
sender, | |
_msgSender(), | |
_allowances[sender][_msgSender()].sub(amount, 'BEP20: transfer amount exceeds allowance') | |
); | |
return true; | |
} | |
/** | |
* @dev Atomically increases the allowance granted to `spender` by the caller. | |
* | |
* This is an alternative to {approve} that can be used as a mitigation for | |
* problems described in {BEP20-approve}. | |
* | |
* Emits an {Approval} event indicating the updated allowance. | |
* | |
* Requirements: | |
* | |
* - `spender` cannot be the zero address. | |
*/ | |
function increaseAllowance(address spender, uint256 addedValue) public returns (bool) { | |
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].add(addedValue)); | |
return true; | |
} | |
/** | |
* @dev Atomically decreases the allowance granted to `spender` by the caller. | |
* | |
* This is an alternative to {approve} that can be used as a mitigation for | |
* problems described in {BEP20-approve}. | |
* | |
* Emits an {Approval} event indicating the updated allowance. | |
* | |
* Requirements: | |
* | |
* - `spender` cannot be the zero address. | |
* - `spender` must have allowance for the caller of at least | |
* `subtractedValue`. | |
*/ | |
function decreaseAllowance(address spender, uint256 subtractedValue) public returns (bool) { | |
_approve( | |
_msgSender(), | |
spender, | |
_allowances[_msgSender()][spender].sub(subtractedValue, 'BEP20: decreased allowance below zero') | |
); | |
return true; | |
} | |
/** | |
* @dev Creates `amount` tokens and assigns them to `msg.sender`, increasing | |
* the total supply. | |
* | |
* Requirements | |
* | |
* - `msg.sender` must be the token owner | |
*/ | |
function mint(uint256 amount) public onlyOwner returns (bool) { | |
_mint(_msgSender(), amount); | |
return true; | |
} | |
/** | |
* @dev Moves tokens `amount` from `sender` to `recipient`. | |
* | |
* This is internal function is equivalent to {transfer}, and can be used to | |
* e.g. implement automatic token fees, slashing mechanisms, etc. | |
* | |
* Emits a {Transfer} event. | |
* | |
* Requirements: | |
* | |
* - `sender` cannot be the zero address. | |
* - `recipient` cannot be the zero address. | |
* - `sender` must have a balance of at least `amount`. | |
*/ | |
function _transfer( | |
address sender, | |
address recipient, | |
uint256 amount | |
) internal { | |
require(sender != address(0), 'BEP20: transfer from the zero address'); | |
require(recipient != address(0), 'BEP20: transfer to the zero address'); | |
_balances[sender] = _balances[sender].sub(amount, 'BEP20: transfer amount exceeds balance'); | |
_balances[recipient] = _balances[recipient].add(amount); | |
emit Transfer(sender, recipient, amount); | |
} | |
/** @dev Creates `amount` tokens and assigns them to `account`, increasing | |
* the total supply. | |
* | |
* Emits a {Transfer} event with `from` set to the zero address. | |
* | |
* Requirements | |
* | |
* - `to` cannot be the zero address. | |
*/ | |
function _mint(address account, uint256 amount) internal { | |
require(account != address(0), 'BEP20: mint to the zero address'); | |
_totalSupply = _totalSupply.add(amount); | |
_balances[account] = _balances[account].add(amount); | |
emit Transfer(address(0), account, amount); | |
} | |
/** | |
* @dev Destroys `amount` tokens from `account`, reducing the | |
* total supply. | |
* | |
* Emits a {Transfer} event with `to` set to the zero address. | |
* | |
* Requirements | |
* | |
* - `account` cannot be the zero address. | |
* - `account` must have at least `amount` tokens. | |
*/ | |
function _burn(address account, uint256 amount) internal { | |
require(account != address(0), 'BEP20: burn from the zero address'); | |
_balances[account] = _balances[account].sub(amount, 'BEP20: burn amount exceeds balance'); | |
_totalSupply = _totalSupply.sub(amount); | |
emit Transfer(account, address(0), amount); | |
} | |
/** | |
* @dev Sets `amount` as the allowance of `spender` over the `owner`s tokens. | |
* | |
* This is internal function is equivalent to `approve`, and can be used to | |
* e.g. set automatic allowances for certain subsystems, etc. | |
* | |
* Emits an {Approval} event. | |
* | |
* Requirements: | |
* | |
* - `owner` cannot be the zero address. | |
* - `spender` cannot be the zero address. | |
*/ | |
function _approve( | |
address owner, | |
address spender, | |
uint256 amount | |
) internal { | |
require(owner != address(0), 'BEP20: approve from the zero address'); | |
require(spender != address(0), 'BEP20: approve to the zero address'); | |
_allowances[owner][spender] = amount; | |
emit Approval(owner, spender, amount); | |
} | |
/** | |
* @dev Destroys `amount` tokens from `account`.`amount` is then deducted | |
* from the caller's allowance. | |
* | |
* See {_burn} and {_approve}. | |
*/ | |
function _burnFrom(address account, uint256 amount) internal { | |
_burn(account, amount); | |
_approve( | |
account, | |
_msgSender(), | |
_allowances[account][_msgSender()].sub(amount, 'BEP20: burn amount exceeds allowance') | |
); | |
} | |
} | |
// CakeToken with Governance. | |
contract CakeToken is BEP20('PancakeSwap Token', 'Cake') { | |
/// @notice Creates `_amount` token to `_to`. Must only be called by the owner (MasterChef). | |
function mint(address _to, uint256 _amount) public onlyOwner { | |
_mint(_to, _amount); | |
_moveDelegates(address(0), _delegates[_to], _amount); | |
} | |
// Copied and modified from YAM code: | |
// https://github.com/yam-finance/yam-protocol/blob/master/contracts/token/YAMGovernanceStorage.sol | |
// https://github.com/yam-finance/yam-protocol/blob/master/contracts/token/YAMGovernance.sol | |
// Which is copied and modified from COMPOUND: | |
// https://github.com/compound-finance/compound-protocol/blob/master/contracts/Governance/Comp.sol | |
/// @notice A record of each accounts delegate | |
mapping (address => address) internal _delegates; | |
/// @notice A checkpoint for marking number of votes from a given block | |
struct Checkpoint { | |
uint32 fromBlock; | |
uint256 votes; | |
} | |
/// @notice A record of votes checkpoints for each account, by index | |
mapping (address => mapping (uint32 => Checkpoint)) public checkpoints; | |
/// @notice The number of checkpoints for each account | |
mapping (address => uint32) public numCheckpoints; | |
/// @notice The EIP-712 typehash for the contract's domain | |
bytes32 public constant DOMAIN_TYPEHASH = keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)"); | |
/// @notice The EIP-712 typehash for the delegation struct used by the contract | |
bytes32 public constant DELEGATION_TYPEHASH = keccak256("Delegation(address delegatee,uint256 nonce,uint256 expiry)"); | |
/// @notice A record of states for signing / validating signatures | |
mapping (address => uint) public nonces; | |
/// @notice An event thats emitted when an account changes its delegate | |
event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate); | |
/// @notice An event thats emitted when a delegate account's vote balance changes | |
event DelegateVotesChanged(address indexed delegate, uint previousBalance, uint newBalance); | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegator The address to get delegatee for | |
*/ | |
function delegates(address delegator) | |
external | |
view | |
returns (address) | |
{ | |
return _delegates[delegator]; | |
} | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegatee The address to delegate votes to | |
*/ | |
function delegate(address delegatee) external { | |
return _delegate(msg.sender, delegatee); | |
} | |
/** | |
* @notice Delegates votes from signatory to `delegatee` | |
* @param delegatee The address to delegate votes to | |
* @param nonce The contract state required to match the signature | |
* @param expiry The time at which to expire the signature | |
* @param v The recovery byte of the signature | |
* @param r Half of the ECDSA signature pair | |
* @param s Half of the ECDSA signature pair | |
*/ | |
function delegateBySig( | |
address delegatee, | |
uint nonce, | |
uint expiry, | |
uint8 v, | |
bytes32 r, | |
bytes32 s | |
) | |
external | |
{ | |
bytes32 domainSeparator = keccak256( | |
abi.encode( | |
DOMAIN_TYPEHASH, | |
keccak256(bytes(name())), | |
getChainId(), | |
address(this) | |
) | |
); | |
bytes32 structHash = keccak256( | |
abi.encode( | |
DELEGATION_TYPEHASH, | |
delegatee, | |
nonce, | |
expiry | |
) | |
); | |
bytes32 digest = keccak256( | |
abi.encodePacked( | |
"\x19\x01", | |
domainSeparator, | |
structHash | |
) | |
); | |
address signatory = ecrecover(digest, v, r, s); | |
require(signatory != address(0), "CAKE::delegateBySig: invalid signature"); | |
require(nonce == nonces[signatory]++, "CAKE::delegateBySig: invalid nonce"); | |
require(now <= expiry, "CAKE::delegateBySig: signature expired"); | |
return _delegate(signatory, delegatee); | |
} | |
/** | |
* @notice Gets the current votes balance for `account` | |
* @param account The address to get votes balance | |
* @return The number of current votes for `account` | |
*/ | |
function getCurrentVotes(address account) | |
external | |
view | |
returns (uint256) | |
{ | |
uint32 nCheckpoints = numCheckpoints[account]; | |
return nCheckpoints > 0 ? checkpoints[account][nCheckpoints - 1].votes : 0; | |
} | |
/** | |
* @notice Determine the prior number of votes for an account as of a block number | |
* @dev Block number must be a finalized block or else this function will revert to prevent misinformation. | |
* @param account The address of the account to check | |
* @param blockNumber The block number to get the vote balance at | |
* @return The number of votes the account had as of the given block | |
*/ | |
function getPriorVotes(address account, uint blockNumber) | |
external | |
view | |
returns (uint256) | |
{ | |
require(blockNumber < block.number, "CAKE::getPriorVotes: not yet determined"); | |
uint32 nCheckpoints = numCheckpoints[account]; | |
if (nCheckpoints == 0) { | |
return 0; | |
} | |
// First check most recent balance | |
if (checkpoints[account][nCheckpoints - 1].fromBlock <= blockNumber) { | |
return checkpoints[account][nCheckpoints - 1].votes; | |
} | |
// Next check implicit zero balance | |
if (checkpoints[account][0].fromBlock > blockNumber) { | |
return 0; | |
} | |
uint32 lower = 0; | |
uint32 upper = nCheckpoints - 1; | |
while (upper > lower) { | |
uint32 center = upper - (upper - lower) / 2; // ceil, avoiding overflow | |
Checkpoint memory cp = checkpoints[account][center]; | |
if (cp.fromBlock == blockNumber) { | |
return cp.votes; | |
} else if (cp.fromBlock < blockNumber) { | |
lower = center; | |
} else { | |
upper = center - 1; | |
} | |
} | |
return checkpoints[account][lower].votes; | |
} | |
function _delegate(address delegator, address delegatee) | |
internal | |
{ | |
address currentDelegate = _delegates[delegator]; | |
uint256 delegatorBalance = balanceOf(delegator); // balance of underlying CAKEs (not scaled); | |
_delegates[delegator] = delegatee; | |
emit DelegateChanged(delegator, currentDelegate, delegatee); | |
_moveDelegates(currentDelegate, delegatee, delegatorBalance); | |
} | |
function _moveDelegates(address srcRep, address dstRep, uint256 amount) internal { | |
if (srcRep != dstRep && amount > 0) { | |
if (srcRep != address(0)) { | |
// decrease old representative | |
uint32 srcRepNum = numCheckpoints[srcRep]; | |
uint256 srcRepOld = srcRepNum > 0 ? checkpoints[srcRep][srcRepNum - 1].votes : 0; | |
uint256 srcRepNew = srcRepOld.sub(amount); | |
_writeCheckpoint(srcRep, srcRepNum, srcRepOld, srcRepNew); | |
} | |
if (dstRep != address(0)) { | |
// increase new representative | |
uint32 dstRepNum = numCheckpoints[dstRep]; | |
uint256 dstRepOld = dstRepNum > 0 ? checkpoints[dstRep][dstRepNum - 1].votes : 0; | |
uint256 dstRepNew = dstRepOld.add(amount); | |
_writeCheckpoint(dstRep, dstRepNum, dstRepOld, dstRepNew); | |
} | |
} | |
} | |
function _writeCheckpoint( | |
address delegatee, | |
uint32 nCheckpoints, | |
uint256 oldVotes, | |
uint256 newVotes | |
) | |
internal | |
{ | |
uint32 blockNumber = safe32(block.number, "CAKE::_writeCheckpoint: block number exceeds 32 bits"); | |
if (nCheckpoints > 0 && checkpoints[delegatee][nCheckpoints - 1].fromBlock == blockNumber) { | |
checkpoints[delegatee][nCheckpoints - 1].votes = newVotes; | |
} else { | |
checkpoints[delegatee][nCheckpoints] = Checkpoint(blockNumber, newVotes); | |
numCheckpoints[delegatee] = nCheckpoints + 1; | |
} | |
emit DelegateVotesChanged(delegatee, oldVotes, newVotes); | |
} | |
function safe32(uint n, string memory errorMessage) internal pure returns (uint32) { | |
require(n < 2**32, errorMessage); | |
return uint32(n); | |
} | |
function getChainId() internal pure returns (uint) { | |
uint256 chainId; | |
assembly { chainId := chainid() } | |
return chainId; | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// address 0x88929e5f22a1dC859f6d556d466a1b4A078920BE | |
/** | |
*Submitted for verification at Etherscan.io on 2019-05-03 | |
*/ | |
// File: contracts/ComptrollerInterface.sol | |
pragma solidity ^0.5.8; | |
interface ComptrollerInterface { | |
/** | |
* @notice Marker function used for light validation when updating the comptroller of a market | |
* @dev Implementations should simply return true. | |
* @return true | |
*/ | |
function isComptroller() external view returns (bool); | |
/*** Assets You Are In ***/ | |
function enterMarkets(address[] calldata cTokens) external returns (uint[] memory); | |
function exitMarket(address cToken) external returns (uint); | |
/*** Policy Hooks ***/ | |
function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint); | |
function mintVerify(address cToken, address minter, uint mintAmount, uint mintTokens) external; | |
function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint); | |
function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external; | |
function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint); | |
function borrowVerify(address cToken, address borrower, uint borrowAmount) external; | |
function repayBorrowAllowed( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function repayBorrowVerify( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount, | |
uint borrowerIndex) external; | |
function liquidateBorrowAllowed( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function liquidateBorrowVerify( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount, | |
uint seizeTokens) external; | |
function seizeAllowed( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external returns (uint); | |
function seizeVerify( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external; | |
function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint); | |
function transferVerify(address cToken, address src, address dst, uint transferTokens) external; | |
/*** Liquidity/Liquidation Calculations ***/ | |
function liquidateCalculateSeizeTokens( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
uint repayAmount) external view returns (uint, uint); | |
} | |
// File: contracts/ErrorReporter.sol | |
pragma solidity ^0.5.8; | |
contract ComptrollerErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
COMPTROLLER_MISMATCH, | |
INSUFFICIENT_SHORTFALL, | |
INSUFFICIENT_LIQUIDITY, | |
INVALID_CLOSE_FACTOR, | |
INVALID_COLLATERAL_FACTOR, | |
INVALID_LIQUIDATION_INCENTIVE, | |
MARKET_NOT_ENTERED, | |
MARKET_NOT_LISTED, | |
MARKET_ALREADY_LISTED, | |
MATH_ERROR, | |
NONZERO_BORROW_BALANCE, | |
PRICE_ERROR, | |
REJECTION, | |
SNAPSHOT_ERROR, | |
TOO_MANY_ASSETS, | |
TOO_MUCH_REPAY | |
} | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
EXIT_MARKET_BALANCE_OWED, | |
EXIT_MARKET_REJECTION, | |
SET_CLOSE_FACTOR_OWNER_CHECK, | |
SET_CLOSE_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_NO_EXISTS, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_WITHOUT_PRICE, | |
SET_IMPLEMENTATION_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_VALIDATION, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_OWNER_CHECK, | |
SET_PRICE_ORACLE_OWNER_CHECK, | |
SUPPORT_MARKET_EXISTS, | |
SUPPORT_MARKET_OWNER_CHECK, | |
ZUNUSED | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
contract TokenErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
BAD_INPUT, | |
COMPTROLLER_REJECTION, | |
COMPTROLLER_CALCULATION_ERROR, | |
INTEREST_RATE_MODEL_ERROR, | |
INVALID_ACCOUNT_PAIR, | |
INVALID_CLOSE_AMOUNT_REQUESTED, | |
INVALID_COLLATERAL_FACTOR, | |
MATH_ERROR, | |
MARKET_NOT_FRESH, | |
MARKET_NOT_LISTED, | |
TOKEN_INSUFFICIENT_ALLOWANCE, | |
TOKEN_INSUFFICIENT_BALANCE, | |
TOKEN_INSUFFICIENT_CASH, | |
TOKEN_TRANSFER_IN_FAILED, | |
TOKEN_TRANSFER_OUT_FAILED | |
} | |
/* | |
* Note: FailureInfo (but not Error) is kept in alphabetical order | |
* This is because FailureInfo grows significantly faster, and | |
* the order of Error has some meaning, while the order of FailureInfo | |
* is entirely arbitrary. | |
*/ | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, | |
ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, | |
ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, | |
BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
BORROW_ACCRUE_INTEREST_FAILED, | |
BORROW_CASH_NOT_AVAILABLE, | |
BORROW_FRESHNESS_CHECK, | |
BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
BORROW_MARKET_NOT_LISTED, | |
BORROW_COMPTROLLER_REJECTION, | |
LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED, | |
LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED, | |
LIQUIDATE_COLLATERAL_FRESHNESS_CHECK, | |
LIQUIDATE_COMPTROLLER_REJECTION, | |
LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, | |
LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX, | |
LIQUIDATE_CLOSE_AMOUNT_IS_ZERO, | |
LIQUIDATE_FRESHNESS_CHECK, | |
LIQUIDATE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_REPAY_BORROW_FRESH_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, | |
LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, | |
LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_SEIZE_TOO_MUCH, | |
MINT_ACCRUE_INTEREST_FAILED, | |
MINT_COMPTROLLER_REJECTION, | |
MINT_EXCHANGE_CALCULATION_FAILED, | |
MINT_EXCHANGE_RATE_READ_FAILED, | |
MINT_FRESHNESS_CHECK, | |
MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
MINT_TRANSFER_IN_FAILED, | |
MINT_TRANSFER_IN_NOT_POSSIBLE, | |
REDEEM_ACCRUE_INTEREST_FAILED, | |
REDEEM_COMPTROLLER_REJECTION, | |
REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_RATE_READ_FAILED, | |
REDEEM_FRESHNESS_CHECK, | |
REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
REDEEM_TRANSFER_OUT_NOT_POSSIBLE, | |
REDUCE_RESERVES_ACCRUE_INTEREST_FAILED, | |
REDUCE_RESERVES_ADMIN_CHECK, | |
REDUCE_RESERVES_CASH_NOT_AVAILABLE, | |
REDUCE_RESERVES_FRESH_CHECK, | |
REDUCE_RESERVES_VALIDATION, | |
REPAY_BEHALF_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_COMPTROLLER_REJECTION, | |
REPAY_BORROW_FRESHNESS_CHECK, | |
REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COMPTROLLER_OWNER_CHECK, | |
SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED, | |
SET_INTEREST_RATE_MODEL_FRESH_CHECK, | |
SET_INTEREST_RATE_MODEL_OWNER_CHECK, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_ORACLE_MARKET_NOT_LISTED, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED, | |
SET_RESERVE_FACTOR_ADMIN_CHECK, | |
SET_RESERVE_FACTOR_FRESH_CHECK, | |
SET_RESERVE_FACTOR_BOUNDS_CHECK, | |
TRANSFER_COMPTROLLER_REJECTION, | |
TRANSFER_NOT_ALLOWED, | |
TRANSFER_NOT_ENOUGH, | |
TRANSFER_TOO_MUCH | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
// File: contracts/CarefulMath.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Careful Math | |
* @author Compound | |
* @notice Derived from OpenZeppelin's SafeMath library | |
* https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/math/SafeMath.sol | |
*/ | |
contract CarefulMath { | |
/** | |
* @dev Possible error codes that we can return | |
*/ | |
enum MathError { | |
NO_ERROR, | |
DIVISION_BY_ZERO, | |
INTEGER_OVERFLOW, | |
INTEGER_UNDERFLOW | |
} | |
/** | |
* @dev Multiplies two numbers, returns an error on overflow. | |
*/ | |
function mulUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (a == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
uint c = a * b; | |
if (c / a != b) { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} else { | |
return (MathError.NO_ERROR, c); | |
} | |
} | |
/** | |
* @dev Integer division of two numbers, truncating the quotient. | |
*/ | |
function divUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b == 0) { | |
return (MathError.DIVISION_BY_ZERO, 0); | |
} | |
return (MathError.NO_ERROR, a / b); | |
} | |
/** | |
* @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). | |
*/ | |
function subUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b <= a) { | |
return (MathError.NO_ERROR, a - b); | |
} else { | |
return (MathError.INTEGER_UNDERFLOW, 0); | |
} | |
} | |
/** | |
* @dev Adds two numbers, returns an error on overflow. | |
*/ | |
function addUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
uint c = a + b; | |
if (c >= a) { | |
return (MathError.NO_ERROR, c); | |
} else { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} | |
} | |
/** | |
* @dev add a and b and then subtract c | |
*/ | |
function addThenSubUInt(uint a, uint b, uint c) internal pure returns (MathError, uint) { | |
(MathError err0, uint sum) = addUInt(a, b); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, 0); | |
} | |
return subUInt(sum, c); | |
} | |
} | |
// File: contracts/Exponential.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Exponential module for storing fixed-decision decimals | |
* @author Compound | |
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. | |
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: | |
* `Exp({mantissa: 5100000000000000000})`. | |
*/ | |
contract Exponential is CarefulMath { | |
uint constant expScale = 1e18; | |
uint constant halfExpScale = expScale/2; | |
uint constant mantissaOne = expScale; | |
struct Exp { | |
uint mantissa; | |
} | |
/** | |
* @dev Creates an exponential from numerator and denominator values. | |
* Note: Returns an error if (`num` * 10e18) > MAX_INT, | |
* or if `denom` is zero. | |
*/ | |
function getExp(uint num, uint denom) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledNumerator) = mulUInt(num, expScale); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
(MathError err1, uint rational) = divUInt(scaledNumerator, denom); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: rational})); | |
} | |
/** | |
* @dev Adds two exponentials, returning a new exponential. | |
*/ | |
function addExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = addUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Subtracts two exponentials, returning a new exponential. | |
*/ | |
function subExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = subUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, returning a new Exp. | |
*/ | |
function mulScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledMantissa) = mulUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: scaledMantissa})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. | |
*/ | |
function mulScalarTruncate(Exp memory a, uint scalar) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(product)); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. | |
*/ | |
function mulScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return addUInt(truncate(product), addend); | |
} | |
/** | |
* @dev Divide an Exp by a scalar, returning a new Exp. | |
*/ | |
function divScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint descaledMantissa) = divUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: descaledMantissa})); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, returning a new Exp. | |
*/ | |
function divScalarByExp(uint scalar, Exp memory divisor) pure internal returns (MathError, Exp memory) { | |
/* | |
We are doing this as: | |
getExp(mulUInt(expScale, scalar), divisor.mantissa) | |
How it works: | |
Exp = a / b; | |
Scalar = s; | |
`s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` | |
*/ | |
(MathError err0, uint numerator) = mulUInt(expScale, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return getExp(numerator, divisor.mantissa); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, then truncate to return an unsigned integer. | |
*/ | |
function divScalarByExpTruncate(uint scalar, Exp memory divisor) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory fraction) = divScalarByExp(scalar, divisor); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(fraction)); | |
} | |
/** | |
* @dev Multiplies two exponentials, returning a new exponential. | |
*/ | |
function mulExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint doubleScaledProduct) = mulUInt(a.mantissa, b.mantissa); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
// We add half the scale before dividing so that we get rounding instead of truncation. | |
// See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 | |
// Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. | |
(MathError err1, uint doubleScaledProductWithHalfScale) = addUInt(halfExpScale, doubleScaledProduct); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
(MathError err2, uint product) = divUInt(doubleScaledProductWithHalfScale, expScale); | |
// The only error `div` can return is MathError.DIVISION_BY_ZERO but we control `expScale` and it is not zero. | |
assert(err2 == MathError.NO_ERROR); | |
return (MathError.NO_ERROR, Exp({mantissa: product})); | |
} | |
/** | |
* @dev Multiplies two exponentials given their mantissas, returning a new exponential. | |
*/ | |
function mulExp(uint a, uint b) pure internal returns (MathError, Exp memory) { | |
return mulExp(Exp({mantissa: a}), Exp({mantissa: b})); | |
} | |
/** | |
* @dev Multiplies three exponentials, returning a new exponential. | |
*/ | |
function mulExp3(Exp memory a, Exp memory b, Exp memory c) pure internal returns (MathError, Exp memory) { | |
(MathError err, Exp memory ab) = mulExp(a, b); | |
if (err != MathError.NO_ERROR) { | |
return (err, ab); | |
} | |
return mulExp(ab, c); | |
} | |
/** | |
* @dev Divides two exponentials, returning a new exponential. | |
* (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, | |
* which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) | |
*/ | |
function divExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
return getExp(a.mantissa, b.mantissa); | |
} | |
/** | |
* @dev Truncates the given exp to a whole number value. | |
* For example, truncate(Exp{mantissa: 15 * expScale}) = 15 | |
*/ | |
function truncate(Exp memory exp) pure internal returns (uint) { | |
// Note: We are not using careful math here as we're performing a division that cannot fail | |
return exp.mantissa / expScale; | |
} | |
/** | |
* @dev Checks if first Exp is less than second Exp. | |
*/ | |
function lessThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa < right.mantissa; //TODO: Add some simple tests and this in another PR yo. | |
} | |
/** | |
* @dev Checks if left Exp <= right Exp. | |
*/ | |
function lessThanOrEqualExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa <= right.mantissa; | |
} | |
/** | |
* @dev returns true if Exp is exactly zero | |
*/ | |
function isZeroExp(Exp memory value) pure internal returns (bool) { | |
return value.mantissa == 0; | |
} | |
} | |
// File: contracts/EIP20Interface.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title ERC 20 Token Standard Interface | |
* https://eips.ethereum.org/EIPS/eip-20 | |
*/ | |
interface EIP20Interface { | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
// XXX docs/verify | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: contracts/EIP20NonStandardInterface.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title EIP20NonStandardInterface | |
* @dev Version of ERC20 with no return values for `transfer` and `transferFrom` | |
* See https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
interface EIP20NonStandardInterface { | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transfer` does not return a value, in violation of the ERC-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transfer(address dst, uint256 amount) external; | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transferFrom` does not return a value, in violation of the ERC-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external; | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: contracts/ReentrancyGuard.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Helps contracts guard against reentrancy attacks. | |
* @author Remco Bloemen <remco@2π.com>, Eenae <alexey@mixbytes.io> | |
* @dev If you mark a function `nonReentrant`, you should also | |
* mark it `external`. | |
*/ | |
contract ReentrancyGuard { | |
/// @dev counter to allow mutex lock with only one SSTORE operation | |
uint256 private _guardCounter; | |
constructor () internal { | |
// The counter starts at one to prevent changing it from zero to a non-zero | |
// value, which is a more expensive operation. | |
_guardCounter = 1; | |
} | |
/** | |
* @dev Prevents a contract from calling itself, directly or indirectly. | |
* Calling a `nonReentrant` function from another `nonReentrant` | |
* function is not supported. It is possible to prevent this from happening | |
* by making the `nonReentrant` function external, and make it call a | |
* `private` function that does the actual work. | |
*/ | |
modifier nonReentrant() { | |
_guardCounter += 1; | |
uint256 localCounter = _guardCounter; | |
_; | |
require(localCounter == _guardCounter, "re-entered"); | |
} | |
} | |
// File: contracts/InterestRateModel.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title The Compound InterestRateModel Interface | |
* @author Compound | |
* @notice Any interest rate model should derive from this contract. | |
* @dev These functions are specifically not marked `pure` as implementations of this | |
* contract may read from storage variables. | |
*/ | |
interface InterestRateModel { | |
/** | |
* @notice Gets the current borrow interest rate based on the given asset, total cash, total borrows | |
* and total reserves. | |
* @dev The return value should be scaled by 1e18, thus a return value of | |
* `(true, 1000000000000)` implies an interest rate of 0.000001 or 0.0001% *per block*. | |
* @param cash The total cash of the underlying asset in the CToken | |
* @param borrows The total borrows of the underlying asset in the CToken | |
* @param reserves The total reserves of the underlying asset in the CToken | |
* @return Success or failure and the borrow interest rate per block scaled by 10e18 | |
*/ | |
function getBorrowRate(uint cash, uint borrows, uint reserves) external view returns (uint, uint); | |
/** | |
* @notice Marker function used for light validation when updating the interest rate model of a market | |
* @dev Marker function used for light validation when updating the interest rate model of a market. Implementations should simply return true. | |
* @return Success or failure | |
*/ | |
function isInterestRateModel() external view returns (bool); | |
} | |
// File: contracts/CToken.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Compound's CToken Contract | |
* @notice Abstract base for CTokens | |
* @author Compound | |
*/ | |
contract CToken is EIP20Interface, Exponential, TokenErrorReporter, ReentrancyGuard { | |
/** | |
* @notice Indicator that this is a CToken contract (for inspection) | |
*/ | |
bool public constant isCToken = true; | |
/** | |
* @notice EIP-20 token name for this token | |
*/ | |
string public name; | |
/** | |
* @notice EIP-20 token symbol for this token | |
*/ | |
string public symbol; | |
/** | |
* @notice EIP-20 token decimals for this token | |
*/ | |
uint public decimals; | |
/** | |
* @notice Maximum borrow rate that can ever be applied (.0005% / block) | |
*/ | |
uint constant borrowRateMaxMantissa = 5e14; | |
/** | |
* @notice Maximum fraction of interest that can be set aside for reserves | |
*/ | |
uint constant reserveFactorMaxMantissa = 1e18; | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address payable public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address payable public pendingAdmin; | |
/** | |
* @notice Contract which oversees inter-cToken operations | |
*/ | |
ComptrollerInterface public comptroller; | |
/** | |
* @notice Model which tells what the current interest rate should be | |
*/ | |
InterestRateModel public interestRateModel; | |
/** | |
* @notice Initial exchange rate used when minting the first CTokens (used when totalSupply = 0) | |
*/ | |
uint public initialExchangeRateMantissa; | |
/** | |
* @notice Fraction of interest currently set aside for reserves | |
*/ | |
uint public reserveFactorMantissa; | |
/** | |
* @notice Block number that interest was last accrued at | |
*/ | |
uint public accrualBlockNumber; | |
/** | |
* @notice Accumulator of total earned interest since the opening of the market | |
*/ | |
uint public borrowIndex; | |
/** | |
* @notice Total amount of outstanding borrows of the underlying in this market | |
*/ | |
uint public totalBorrows; | |
/** | |
* @notice Total amount of reserves of the underlying held in this market | |
*/ | |
uint public totalReserves; | |
/** | |
* @notice Total number of tokens in circulation | |
*/ | |
uint256 public totalSupply; | |
/** | |
* @notice Official record of token balances for each account | |
*/ | |
mapping (address => uint256) accountTokens; | |
/** | |
* @notice Approved token transfer amounts on behalf of others | |
*/ | |
mapping (address => mapping (address => uint256)) transferAllowances; | |
/** | |
* @notice Container for borrow balance information | |
* @member principal Total balance (with accrued interest), after applying the most recent balance-changing action | |
* @member interestIndex Global borrowIndex as of the most recent balance-changing action | |
*/ | |
struct BorrowSnapshot { | |
uint principal; | |
uint interestIndex; | |
} | |
/** | |
* @notice Mapping of account addresses to outstanding borrow balances | |
*/ | |
mapping(address => BorrowSnapshot) accountBorrows; | |
/*** Market Events ***/ | |
/** | |
* @notice Event emitted when interest is accrued | |
*/ | |
event AccrueInterest(uint interestAccumulated, uint borrowIndex, uint totalBorrows); | |
/** | |
* @notice Event emitted when tokens are minted | |
*/ | |
event Mint(address minter, uint mintAmount, uint mintTokens); | |
/** | |
* @notice Event emitted when tokens are redeemed | |
*/ | |
event Redeem(address redeemer, uint redeemAmount, uint redeemTokens); | |
/** | |
* @notice Event emitted when underlying is borrowed | |
*/ | |
event Borrow(address borrower, uint borrowAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is repaid | |
*/ | |
event RepayBorrow(address payer, address borrower, uint repayAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is liquidated | |
*/ | |
event LiquidateBorrow(address liquidator, address borrower, uint repayAmount, address cTokenCollateral, uint seizeTokens); | |
/*** Admin Events ***/ | |
/** | |
* @notice Event emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Event emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
/** | |
* @notice Event emitted when comptroller is changed | |
*/ | |
event NewComptroller(ComptrollerInterface oldComptroller, ComptrollerInterface newComptroller); | |
/** | |
* @notice Event emitted when interestRateModel is changed | |
*/ | |
event NewMarketInterestRateModel(InterestRateModel oldInterestRateModel, InterestRateModel newInterestRateModel); | |
/** | |
* @notice Event emitted when the reserve factor is changed | |
*/ | |
event NewReserveFactor(uint oldReserveFactorMantissa, uint newReserveFactorMantissa); | |
/** | |
* @notice Event emitted when the reserves are reduced | |
*/ | |
event ReservesReduced(address admin, uint reduceAmount, uint newTotalReserves); | |
/** | |
* @notice Construct a new money market | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ EIP-20 name of this token | |
* @param symbol_ EIP-20 symbol of this token | |
* @param decimals_ EIP-20 decimal precision of this token | |
*/ | |
constructor(ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint decimals_) internal { | |
// Set admin to msg.sender | |
admin = msg.sender; | |
// Set initial exchange rate | |
initialExchangeRateMantissa = initialExchangeRateMantissa_; | |
require(initialExchangeRateMantissa > 0, "Initial exchange rate must be greater than zero."); | |
// Set the comptroller | |
uint err = _setComptroller(comptroller_); | |
require(err == uint(Error.NO_ERROR), "Setting comptroller failed"); | |
// Initialize block number and borrow index (block number mocks depend on comptroller being set) | |
accrualBlockNumber = getBlockNumber(); | |
borrowIndex = mantissaOne; | |
// Set the interest rate model (depends on block number / borrow index) | |
err = _setInterestRateModelFresh(interestRateModel_); | |
require(err == uint(Error.NO_ERROR), "Setting interest rate model failed"); | |
name = name_; | |
symbol = symbol_; | |
decimals = decimals_; | |
} | |
/** | |
* @notice Transfer `tokens` tokens from `src` to `dst` by `spender` | |
* @dev Called by both `transfer` and `transferFrom` internally | |
* @param spender The address of the account performing the transfer | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param tokens The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferTokens(address spender, address src, address dst, uint tokens) internal returns (uint) { | |
/* Fail if transfer not allowed */ | |
uint allowed = comptroller.transferAllowed(address(this), src, dst, tokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.TRANSFER_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Do not allow self-transfers */ | |
if (src == dst) { | |
return fail(Error.BAD_INPUT, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
/* Get the allowance, infinite for the account owner */ | |
uint startingAllowance = 0; | |
if (spender == src) { | |
startingAllowance = uint(-1); | |
} else { | |
startingAllowance = transferAllowances[src][spender]; | |
} | |
/* Do the calculations, checking for {under,over}flow */ | |
MathError mathErr; | |
uint allowanceNew; | |
uint srcTokensNew; | |
uint dstTokensNew; | |
(mathErr, allowanceNew) = subUInt(startingAllowance, tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
(mathErr, srcTokensNew) = subUInt(accountTokens[src], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ENOUGH); | |
} | |
(mathErr, dstTokensNew) = addUInt(accountTokens[dst], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_TOO_MUCH); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
accountTokens[src] = srcTokensNew; | |
accountTokens[dst] = dstTokensNew; | |
/* Eat some of the allowance (if necessary) */ | |
if (startingAllowance != uint(-1)) { | |
transferAllowances[src][spender] = allowanceNew; | |
} | |
/* We emit a Transfer event */ | |
emit Transfer(src, dst, tokens); | |
/* We call the defense hook (which checks for under-collateralization) */ | |
comptroller.transferVerify(address(this), src, dst, tokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, msg.sender, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, src, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool) { | |
address src = msg.sender; | |
transferAllowances[src][spender] = amount; | |
emit Approval(src, spender, amount); | |
return true; | |
} | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256) { | |
return transferAllowances[owner][spender]; | |
} | |
/** | |
* @notice Get the token balance of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of tokens owned by `owner` | |
*/ | |
function balanceOf(address owner) external view returns (uint256) { | |
return accountTokens[owner]; | |
} | |
/** | |
* @notice Get the underlying balance of the `owner` | |
* @dev This also accrues interest in a transaction | |
* @param owner The address of the account to query | |
* @return The amount of underlying owned by `owner` | |
*/ | |
function balanceOfUnderlying(address owner) external returns (uint) { | |
Exp memory exchangeRate = Exp({mantissa: exchangeRateCurrent()}); | |
(MathError mErr, uint balance) = mulScalarTruncate(exchangeRate, accountTokens[owner]); | |
require(mErr == MathError.NO_ERROR); | |
return balance; | |
} | |
/** | |
* @notice Get a snapshot of the account's balances, and the cached exchange rate | |
* @dev This is used by comptroller to more efficiently perform liquidity checks. | |
* @param account Address of the account to snapshot | |
* @return (possible error, token balance, borrow balance, exchange rate mantissa) | |
*/ | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { | |
uint cTokenBalance = accountTokens[account]; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
MathError mErr; | |
(mErr, borrowBalance) = borrowBalanceStoredInternal(account); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
(mErr, exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
return (uint(Error.NO_ERROR), cTokenBalance, borrowBalance, exchangeRateMantissa); | |
} | |
/** | |
* @dev Function to simply retrieve block number | |
* This exists mainly for inheriting test contracts to stub this result. | |
*/ | |
function getBlockNumber() internal view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Returns the current per-block borrow interest rate for this cToken | |
* @return The borrow interest rate per block, scaled by 1e18 | |
*/ | |
function borrowRatePerBlock() external view returns (uint) { | |
(uint opaqueErr, uint borrowRateMantissa) = interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
require(opaqueErr == 0, "borrowRatePerBlock: interestRateModel.borrowRate failed"); // semi-opaque | |
return borrowRateMantissa; | |
} | |
/** | |
* @notice Returns the current per-block supply interest rate for this cToken | |
* @return The supply interest rate per block, scaled by 1e18 | |
*/ | |
function supplyRatePerBlock() external view returns (uint) { | |
/* We calculate the supply rate: | |
* underlying = totalSupply × exchangeRate | |
* borrowsPer = totalBorrows ÷ underlying | |
* supplyRate = borrowRate × (1-reserveFactor) × borrowsPer | |
*/ | |
uint exchangeRateMantissa = exchangeRateStored(); | |
(uint e0, uint borrowRateMantissa) = interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
require(e0 == 0, "supplyRatePerBlock: calculating borrowRate failed"); // semi-opaque | |
(MathError e1, Exp memory underlying) = mulScalar(Exp({mantissa: exchangeRateMantissa}), totalSupply); | |
require(e1 == MathError.NO_ERROR, "supplyRatePerBlock: calculating underlying failed"); | |
(MathError e2, Exp memory borrowsPer) = divScalarByExp(totalBorrows, underlying); | |
require(e2 == MathError.NO_ERROR, "supplyRatePerBlock: calculating borrowsPer failed"); | |
(MathError e3, Exp memory oneMinusReserveFactor) = subExp(Exp({mantissa: mantissaOne}), Exp({mantissa: reserveFactorMantissa})); | |
require(e3 == MathError.NO_ERROR, "supplyRatePerBlock: calculating oneMinusReserveFactor failed"); | |
(MathError e4, Exp memory supplyRate) = mulExp3(Exp({mantissa: borrowRateMantissa}), oneMinusReserveFactor, borrowsPer); | |
require(e4 == MathError.NO_ERROR, "supplyRatePerBlock: calculating supplyRate failed"); | |
return supplyRate.mantissa; | |
} | |
/** | |
* @notice Returns the current total borrows plus accrued interest | |
* @return The total borrows with interest | |
*/ | |
function totalBorrowsCurrent() external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return totalBorrows; | |
} | |
/** | |
* @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex | |
* @param account The address whose balance should be calculated after updating borrowIndex | |
* @return The calculated balance | |
*/ | |
function borrowBalanceCurrent(address account) external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return borrowBalanceStored(account); | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return The calculated balance | |
*/ | |
function borrowBalanceStored(address account) public view returns (uint) { | |
(MathError err, uint result) = borrowBalanceStoredInternal(account); | |
require(err == MathError.NO_ERROR, "borrowBalanceStored: borrowBalanceStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return (error code, the calculated balance or 0 if error code is non-zero) | |
*/ | |
function borrowBalanceStoredInternal(address account) internal view returns (MathError, uint) { | |
/* Note: we do not assert that the market is up to date */ | |
MathError mathErr; | |
uint principalTimesIndex; | |
uint result; | |
/* Get borrowBalance and borrowIndex */ | |
BorrowSnapshot storage borrowSnapshot = accountBorrows[account]; | |
/* If borrowBalance = 0 then borrowIndex is likely also 0. | |
* Rather than failing the calculation with a division by 0, we immediately return 0 in this case. | |
*/ | |
if (borrowSnapshot.principal == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
/* Calculate new borrow balance using the interest index: | |
* recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex | |
*/ | |
(mathErr, principalTimesIndex) = mulUInt(borrowSnapshot.principal, borrowIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, result) = divUInt(principalTimesIndex, borrowSnapshot.interestIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, result); | |
} | |
/** | |
* @notice Accrue interest then return the up-to-date exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateCurrent() public nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return exchangeRateStored(); | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the CToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateStored() public view returns (uint) { | |
(MathError err, uint result) = exchangeRateStoredInternal(); | |
require(err == MathError.NO_ERROR, "exchangeRateStored: exchangeRateStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the CToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return (error code, calculated exchange rate scaled by 1e18) | |
*/ | |
function exchangeRateStoredInternal() internal view returns (MathError, uint) { | |
if (totalSupply == 0) { | |
/* | |
* If there are no tokens minted: | |
* exchangeRate = initialExchangeRate | |
*/ | |
return (MathError.NO_ERROR, initialExchangeRateMantissa); | |
} else { | |
/* | |
* Otherwise: | |
* exchangeRate = (totalCash + totalBorrows - totalReserves) / totalSupply | |
*/ | |
uint totalCash = getCashPrior(); | |
uint cashPlusBorrowsMinusReserves; | |
Exp memory exchangeRate; | |
MathError mathErr; | |
(mathErr, cashPlusBorrowsMinusReserves) = addThenSubUInt(totalCash, totalBorrows, totalReserves); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, exchangeRate) = getExp(cashPlusBorrowsMinusReserves, totalSupply); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, exchangeRate.mantissa); | |
} | |
} | |
/** | |
* @notice Get cash balance of this cToken in the underlying asset | |
* @return The quantity of underlying asset owned by this contract | |
*/ | |
function getCash() external view returns (uint) { | |
return getCashPrior(); | |
} | |
struct AccrueInterestLocalVars { | |
MathError mathErr; | |
uint opaqueErr; | |
uint borrowRateMantissa; | |
uint currentBlockNumber; | |
uint blockDelta; | |
Exp simpleInterestFactor; | |
uint interestAccumulated; | |
uint totalBorrowsNew; | |
uint totalReservesNew; | |
uint borrowIndexNew; | |
} | |
/** | |
* @notice Applies accrued interest to total borrows and reserves. | |
* @dev This calculates interest accrued from the last checkpointed block | |
* up to the current block and writes new checkpoint to storage. | |
*/ | |
function accrueInterest() public returns (uint) { | |
AccrueInterestLocalVars memory vars; | |
/* Calculate the current borrow interest rate */ | |
(vars.opaqueErr, vars.borrowRateMantissa) = interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
require(vars.borrowRateMantissa <= borrowRateMaxMantissa, "borrow rate is absurdly high"); | |
if (vars.opaqueErr != 0) { | |
return failOpaque(Error.INTEREST_RATE_MODEL_ERROR, FailureInfo.ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, vars.opaqueErr); | |
} | |
/* Remember the initial block number */ | |
vars.currentBlockNumber = getBlockNumber(); | |
/* Calculate the number of blocks elapsed since the last accrual */ | |
(vars.mathErr, vars.blockDelta) = subUInt(vars.currentBlockNumber, accrualBlockNumber); | |
assert(vars.mathErr == MathError.NO_ERROR); // Block delta should always succeed and if it doesn't, blow up. | |
/* | |
* Calculate the interest accumulated into borrows and reserves and the new index: | |
* simpleInterestFactor = borrowRate * blockDelta | |
* interestAccumulated = simpleInterestFactor * totalBorrows | |
* totalBorrowsNew = interestAccumulated + totalBorrows | |
* totalReservesNew = interestAccumulated * reserveFactor + totalReserves | |
* borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex | |
*/ | |
(vars.mathErr, vars.simpleInterestFactor) = mulScalar(Exp({mantissa: vars.borrowRateMantissa}), vars.blockDelta); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.interestAccumulated) = mulScalarTruncate(vars.simpleInterestFactor, totalBorrows); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = addUInt(vars.interestAccumulated, totalBorrows); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalReservesNew) = mulScalarTruncateAddUInt(Exp({mantissa: reserveFactorMantissa}), vars.interestAccumulated, totalReserves); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.borrowIndexNew) = mulScalarTruncateAddUInt(vars.simpleInterestFactor, borrowIndex, borrowIndex); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accrualBlockNumber = vars.currentBlockNumber; | |
borrowIndex = vars.borrowIndexNew; | |
totalBorrows = vars.totalBorrowsNew; | |
totalReserves = vars.totalReservesNew; | |
/* We emit an AccrueInterest event */ | |
emit AccrueInterest(vars.interestAccumulated, vars.borrowIndexNew, totalBorrows); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender supplies assets into the market and receives cTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mintInternal(uint mintAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.MINT_ACCRUE_INTEREST_FAILED); | |
} | |
// mintFresh emits the actual Mint event if successful and logs on errors, so we don't need to | |
return mintFresh(msg.sender, mintAmount); | |
} | |
struct MintLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint mintTokens; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
} | |
/** | |
* @notice User supplies assets into the market and receives cTokens in exchange | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param minter The address of the account which is supplying the assets | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mintFresh(address minter, uint mintAmount) internal returns (uint) { | |
/* Fail if mint not allowed */ | |
uint allowed = comptroller.mintAllowed(address(this), minter, mintAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.MINT_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.MINT_FRESHNESS_CHECK); | |
} | |
MintLocalVars memory vars; | |
/* Fail if checkTransferIn fails */ | |
vars.err = checkTransferIn(minter, mintAmount); | |
if (vars.err != Error.NO_ERROR) { | |
return fail(vars.err, FailureInfo.MINT_TRANSFER_IN_NOT_POSSIBLE); | |
} | |
/* | |
* We get the current exchange rate and calculate the number of cTokens to be minted: | |
* mintTokens = mintAmount / exchangeRate | |
*/ | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(mintAmount, Exp({mantissa: vars.exchangeRateMantissa})); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* | |
* We calculate the new total supply of cTokens and minter token balance, checking for overflow: | |
* totalSupplyNew = totalSupply + mintTokens | |
* accountTokensNew = accountTokens[minter] + mintTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = addUInt(totalSupply, vars.mintTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountTokensNew) = addUInt(accountTokens[minter], vars.mintTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the minter and the mintAmount | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken holds an additional mintAmount of cash. | |
* If doTransferIn fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferIn(minter, mintAmount); | |
if (vars.err != Error.NO_ERROR) { | |
return fail(vars.err, FailureInfo.MINT_TRANSFER_IN_FAILED); | |
} | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[minter] = vars.accountTokensNew; | |
/* We emit a Mint event, and a Transfer event */ | |
emit Mint(minter, mintAmount, vars.mintTokens); | |
emit Transfer(address(this), minter, vars.mintTokens); | |
/* We call the defense hook */ | |
comptroller.mintVerify(address(this), minter, mintAmount, vars.mintTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of cTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemInternal(uint redeemTokens) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, redeemTokens, 0); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to redeem | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlyingInternal(uint redeemAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, 0, redeemAmount); | |
} | |
struct RedeemLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint redeemTokens; | |
uint redeemAmount; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
} | |
/** | |
* @notice User redeems cTokens in exchange for the underlying asset | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param redeemer The address of the account which is redeeming the tokens | |
* @param redeemTokensIn The number of cTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be zero) | |
* @param redeemAmountIn The number of cTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be zero) | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemFresh(address payable redeemer, uint redeemTokensIn, uint redeemAmountIn) internal returns (uint) { | |
require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero"); | |
RedeemLocalVars memory vars; | |
/* exchangeRate = invoke Exchange Rate Stored() */ | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); | |
} | |
/* If redeemTokensIn > 0: */ | |
if (redeemTokensIn > 0) { | |
/* | |
* We calculate the exchange rate and the amount of underlying to be redeemed: | |
* redeemTokens = redeemTokensIn | |
* redeemAmount = redeemTokensIn x exchangeRateCurrent | |
*/ | |
vars.redeemTokens = redeemTokensIn; | |
(vars.mathErr, vars.redeemAmount) = mulScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), redeemTokensIn); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
} else { | |
/* | |
* We get the current exchange rate and calculate the amount to be redeemed: | |
* redeemTokens = redeemAmountIn / exchangeRate | |
* redeemAmount = redeemAmountIn | |
*/ | |
(vars.mathErr, vars.redeemTokens) = divScalarByExpTruncate(redeemAmountIn, Exp({mantissa: vars.exchangeRateMantissa})); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
vars.redeemAmount = redeemAmountIn; | |
} | |
/* Fail if redeem not allowed */ | |
uint allowed = comptroller.redeemAllowed(address(this), redeemer, vars.redeemTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REDEEM_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDEEM_FRESHNESS_CHECK); | |
} | |
/* | |
* We calculate the new total supply and redeemer balance, checking for underflow: | |
* totalSupplyNew = totalSupply - redeemTokens | |
* accountTokensNew = accountTokens[redeemer] - redeemTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = subUInt(totalSupply, vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountTokensNew) = subUInt(accountTokens[redeemer], vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* Fail gracefully if protocol has insufficient cash */ | |
if (getCashPrior() < vars.redeemAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDEEM_TRANSFER_OUT_NOT_POSSIBLE); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the redeemer and the redeemAmount. | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken has redeemAmount less of cash. | |
* If doTransferOut fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferOut(redeemer, vars.redeemAmount); | |
require(vars.err == Error.NO_ERROR, "redeem transfer out failed"); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[redeemer] = vars.accountTokensNew; | |
/* We emit a Transfer event, and a Redeem event */ | |
emit Transfer(redeemer, address(this), vars.redeemTokens); | |
emit Redeem(redeemer, vars.redeemAmount, vars.redeemTokens); | |
/* We call the defense hook */ | |
comptroller.redeemVerify(address(this), redeemer, vars.redeemAmount, vars.redeemTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowInternal(uint borrowAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.BORROW_ACCRUE_INTEREST_FAILED); | |
} | |
// borrowFresh emits borrow-specific logs on errors, so we don't need to | |
return borrowFresh(msg.sender, borrowAmount); | |
} | |
struct BorrowLocalVars { | |
Error err; | |
MathError mathErr; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
} | |
/** | |
* @notice Users borrow assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowFresh(address payable borrower, uint borrowAmount) internal returns (uint) { | |
/* Fail if borrow not allowed */ | |
uint allowed = comptroller.borrowAllowed(address(this), borrower, borrowAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.BORROW_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.BORROW_FRESHNESS_CHECK); | |
} | |
/* Fail gracefully if protocol has insufficient underlying cash */ | |
if (getCashPrior() < borrowAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.BORROW_CASH_NOT_AVAILABLE); | |
} | |
BorrowLocalVars memory vars; | |
/* | |
* We calculate the new borrower and total borrow balances, failing on overflow: | |
* accountBorrowsNew = accountBorrows + borrowAmount | |
* totalBorrowsNew = totalBorrows + borrowAmount | |
*/ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountBorrowsNew) = addUInt(vars.accountBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = addUInt(totalBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the borrower and the borrowAmount. | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken borrowAmount less of cash. | |
* If doTransferOut fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferOut(borrower, borrowAmount); | |
require(vars.err == Error.NO_ERROR, "borrow transfer out failed"); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a Borrow event */ | |
emit Borrow(borrower, borrowAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.borrowVerify(address(this), borrower, borrowAmount); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowInternal(uint repayAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.REPAY_BORROW_ACCRUE_INTEREST_FAILED); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, msg.sender, repayAmount); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowBehalfInternal(address borrower, uint repayAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.REPAY_BEHALF_ACCRUE_INTEREST_FAILED); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, borrower, repayAmount); | |
} | |
struct RepayBorrowLocalVars { | |
Error err; | |
MathError mathErr; | |
uint repayAmount; | |
uint borrowerIndex; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
} | |
/** | |
* @notice Borrows are repaid by another user (possibly the borrower). | |
* @param payer the account paying off the borrow | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount the amount of undelrying tokens being returned | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowFresh(address payer, address borrower, uint repayAmount) internal returns (uint) { | |
/* Fail if repayBorrow not allowed */ | |
uint allowed = comptroller.repayBorrowAllowed(address(this), payer, borrower, repayAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REPAY_BORROW_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REPAY_BORROW_FRESHNESS_CHECK); | |
} | |
RepayBorrowLocalVars memory vars; | |
/* We remember the original borrowerIndex for verification purposes */ | |
vars.borrowerIndex = accountBorrows[borrower].interestIndex; | |
/* We fetch the amount the borrower owes, with accumulated interest */ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* If repayAmount == -1, repayAmount = accountBorrows */ | |
if (repayAmount == uint(-1)) { | |
vars.repayAmount = vars.accountBorrows; | |
} else { | |
vars.repayAmount = repayAmount; | |
} | |
/* Fail if checkTransferIn fails */ | |
vars.err = checkTransferIn(payer, vars.repayAmount); | |
if (vars.err != Error.NO_ERROR) { | |
return fail(vars.err, FailureInfo.REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE); | |
} | |
/* | |
* We calculate the new borrower and total borrow balances, failing on underflow: | |
* accountBorrowsNew = accountBorrows - repayAmount | |
* totalBorrowsNew = totalBorrows - repayAmount | |
*/ | |
(vars.mathErr, vars.accountBorrowsNew) = subUInt(vars.accountBorrows, vars.repayAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = subUInt(totalBorrows, vars.repayAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the payer and the repayAmount | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken holds an additional repayAmount of cash. | |
* If doTransferIn fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferIn(payer, vars.repayAmount); | |
require(vars.err == Error.NO_ERROR, "repay borrow transfer in failed"); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a RepayBorrow event */ | |
emit RepayBorrow(payer, borrower, vars.repayAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.repayBorrowVerify(address(this), payer, borrower, vars.repayAmount, vars.borrowerIndex); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrowInternal(address borrower, uint repayAmount, CToken cTokenCollateral) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED); | |
} | |
error = cTokenCollateral.accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED); | |
} | |
// liquidateBorrowFresh emits borrow-specific logs on errors, so we don't need to | |
return liquidateBorrowFresh(msg.sender, borrower, repayAmount, cTokenCollateral); | |
} | |
/** | |
* @notice The liquidator liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param liquidator The address repaying the borrow and seizing collateral | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrowFresh(address liquidator, address borrower, uint repayAmount, CToken cTokenCollateral) internal returns (uint) { | |
/* Fail if liquidate not allowed */ | |
uint allowed = comptroller.liquidateBorrowAllowed(address(this), address(cTokenCollateral), liquidator, borrower, repayAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_FRESHNESS_CHECK); | |
} | |
/* Verify cTokenCollateral market's block number equals current block number */ | |
if (cTokenCollateral.accrualBlockNumber() != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_COLLATERAL_FRESHNESS_CHECK); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_LIQUIDATOR_IS_BORROWER); | |
} | |
/* Fail if repayAmount = 0 */ | |
if (repayAmount == 0) { | |
return fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_ZERO); | |
} | |
/* Fail if repayAmount = -1 */ | |
if (repayAmount == uint(-1)) { | |
return fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX); | |
} | |
/* We calculate the number of collateral tokens that will be seized */ | |
(uint amountSeizeError, uint seizeTokens) = comptroller.liquidateCalculateSeizeTokens(address(this), address(cTokenCollateral), repayAmount); | |
if (amountSeizeError != 0) { | |
return failOpaque(Error.COMPTROLLER_CALCULATION_ERROR, FailureInfo.LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, amountSeizeError); | |
} | |
/* Fail if seizeTokens > borrower collateral token balance */ | |
if (seizeTokens > cTokenCollateral.balanceOf(borrower)) { | |
return fail(Error.TOKEN_INSUFFICIENT_BALANCE, FailureInfo.LIQUIDATE_SEIZE_TOO_MUCH); | |
} | |
/* Fail if repayBorrow fails */ | |
uint repayBorrowError = repayBorrowFresh(liquidator, borrower, repayAmount); | |
if (repayBorrowError != uint(Error.NO_ERROR)) { | |
return fail(Error(repayBorrowError), FailureInfo.LIQUIDATE_REPAY_BORROW_FRESH_FAILED); | |
} | |
/* Revert if seize tokens fails (since we cannot be sure of side effects) */ | |
uint seizeError = cTokenCollateral.seize(liquidator, borrower, seizeTokens); | |
require(seizeError == uint(Error.NO_ERROR), "token seizure failed"); | |
/* We emit a LiquidateBorrow event */ | |
emit LiquidateBorrow(liquidator, borrower, repayAmount, address(cTokenCollateral), seizeTokens); | |
/* We call the defense hook */ | |
comptroller.liquidateBorrowVerify(address(this), address(cTokenCollateral), liquidator, borrower, repayAmount, seizeTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Will fail unless called by another cToken during the process of liquidation. | |
* Its absolutely critical to use msg.sender as the borrowed cToken and not a parameter. | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of cTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seize(address liquidator, address borrower, uint seizeTokens) external nonReentrant returns (uint) { | |
/* Fail if seize not allowed */ | |
uint allowed = comptroller.seizeAllowed(address(this), msg.sender, liquidator, borrower, seizeTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER); | |
} | |
MathError mathErr; | |
uint borrowerTokensNew; | |
uint liquidatorTokensNew; | |
/* | |
* We calculate the new borrower and liquidator token balances, failing on underflow/overflow: | |
* borrowerTokensNew = accountTokens[borrower] - seizeTokens | |
* liquidatorTokensNew = accountTokens[liquidator] + seizeTokens | |
*/ | |
(mathErr, borrowerTokensNew) = subUInt(accountTokens[borrower], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, uint(mathErr)); | |
} | |
(mathErr, liquidatorTokensNew) = addUInt(accountTokens[liquidator], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, uint(mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accountTokens[borrower] = borrowerTokensNew; | |
accountTokens[liquidator] = liquidatorTokensNew; | |
/* Emit a Transfer event */ | |
emit Transfer(borrower, liquidator, seizeTokens); | |
/* We call the defense hook */ | |
comptroller.seizeVerify(address(this), msg.sender, liquidator, borrower, seizeTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
* | |
* TODO: Should we add a second arg to verify, like a checksum of `newAdmin` address? | |
*/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() external returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets a new comptroller for the market | |
* @dev Admin function to set a new comptroller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); | |
} | |
ComptrollerInterface oldComptroller = comptroller; | |
// Ensure invoke comptroller.isComptroller() returns true | |
require(newComptroller.isComptroller(), "marker method returned false"); | |
// Set market's comptroller to newComptroller | |
comptroller = newComptroller; | |
// Emit NewComptroller(oldComptroller, newComptroller) | |
emit NewComptroller(oldComptroller, newComptroller); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh | |
* @dev Admin function to accrue interest and set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactor(uint newReserveFactorMantissa) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reserve factor change failed. | |
return fail(Error(error), FailureInfo.SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED); | |
} | |
// _setReserveFactorFresh emits reserve-factor-specific logs on errors, so we don't need to. | |
return _setReserveFactorFresh(newReserveFactorMantissa); | |
} | |
/** | |
* @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual) | |
* @dev Admin function to set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactorFresh(uint newReserveFactorMantissa) internal returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_RESERVE_FACTOR_ADMIN_CHECK); | |
} | |
// Verify market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
// TODO: static_assert + no error code? | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_RESERVE_FACTOR_FRESH_CHECK); | |
} | |
// Check newReserveFactor ≤ maxReserveFactor | |
if (newReserveFactorMantissa > reserveFactorMaxMantissa) { | |
return fail(Error.BAD_INPUT, FailureInfo.SET_RESERVE_FACTOR_BOUNDS_CHECK); | |
} | |
uint oldReserveFactorMantissa = reserveFactorMantissa; | |
reserveFactorMantissa = newReserveFactorMantissa; | |
emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring to admin | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReserves(uint reduceAmount) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.REDUCE_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _reduceReservesFresh emits reserve-reduction-specific logs on errors, so we don't need to. | |
return _reduceReservesFresh(reduceAmount); | |
} | |
/** | |
* @notice Reduces reserves by transferring to admin | |
* @dev Requires fresh interest accrual | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReservesFresh(uint reduceAmount) internal returns (uint) { | |
Error err; | |
// totalReserves - reduceAmount | |
uint totalReservesNew; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.REDUCE_RESERVES_ADMIN_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
// TODO: static_assert + no error code? | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDUCE_RESERVES_FRESH_CHECK); | |
} | |
// Fail gracefully if protocol has insufficient underlying cash | |
if (getCashPrior() < reduceAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDUCE_RESERVES_CASH_NOT_AVAILABLE); | |
} | |
// Check reduceAmount ≤ reserves[n] (totalReserves) | |
// TODO: I'm following the spec literally here but I think we should we just use SafeMath instead and fail on an error (which would be underflow) | |
if (reduceAmount > totalReserves) { | |
return fail(Error.BAD_INPUT, FailureInfo.REDUCE_RESERVES_VALIDATION); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
totalReservesNew = totalReserves - reduceAmount; | |
// We checked reduceAmount <= totalReserves above, so this should never revert. | |
require(totalReservesNew <= totalReserves, "reduce reserves unexpected underflow"); | |
// Store reserves[n+1] = reserves[n] - reduceAmount | |
totalReserves = totalReservesNew; | |
// invoke doTransferOut(reduceAmount, admin) | |
err = doTransferOut(admin, reduceAmount); | |
// we revert on the failure of this command | |
require(err == Error.NO_ERROR, "reduce reserves transfer out failed"); | |
emit ReservesReduced(admin, reduceAmount, totalReservesNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and updates the interest rate model using _setInterestRateModelFresh | |
* @dev Admin function to accrue interest and update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted change of interest rate model failed | |
return fail(Error(error), FailureInfo.SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED); | |
} | |
// _setInterestRateModelFresh emits interest-rate-model-update-specific logs on errors, so we don't need to. | |
return _setInterestRateModelFresh(newInterestRateModel); | |
} | |
/** | |
* @notice updates the interest rate model (*requires fresh interest accrual) | |
* @dev Admin function to update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal returns (uint) { | |
// Used to store old model for use in the event that is emitted on success | |
InterestRateModel oldInterestRateModel; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_INTEREST_RATE_MODEL_OWNER_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
// TODO: static_assert + no error code? | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_INTEREST_RATE_MODEL_FRESH_CHECK); | |
} | |
// Track the market's current interest rate model | |
oldInterestRateModel = interestRateModel; | |
// Ensure invoke newInterestRateModel.isInterestRateModel() returns true | |
require(newInterestRateModel.isInterestRateModel(), "marker method returned false"); | |
// Set the interest rate model to newInterestRateModel | |
interestRateModel = newInterestRateModel; | |
// Emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel) | |
emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint); | |
/** | |
* @dev Checks whether or not there is sufficient allowance for this contract to move amount from `from` and | |
* whether or not `from` has a balance of at least `amount`. Does NOT do a transfer. | |
*/ | |
function checkTransferIn(address from, uint amount) internal view returns (Error); | |
/** | |
* @dev Performs a transfer in, ideally returning an explanatory error code upon failure rather than reverting. | |
* If caller has not called `checkTransferIn`, this may revert due to insufficient balance or insufficient allowance. | |
* If caller has called `checkTransferIn` successfully, this should not revert in normal conditions. | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (Error); | |
/** | |
* @dev Performs a transfer out, ideally returning an explanatory error code upon failure tather than reverting. | |
* If caller has not called checked protocol's balance, may revert due to insufficient cash held in the contract. | |
* If caller has checked protocol's balance, and verified it is >= amount, this should not revert in normal conditions. | |
*/ | |
function doTransferOut(address payable to, uint amount) internal returns (Error); | |
} | |
// File: contracts/CErc20.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Compound's CErc20 Contract | |
* @notice CTokens which wrap an EIP-20 underlying | |
* @author Compound | |
*/ | |
contract CErc20 is CToken { | |
/** | |
* @notice Underlying asset for this CToken | |
*/ | |
address public underlying; | |
/** | |
* @notice Construct a new money market | |
* @param underlying_ The address of the underlying asset | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ ERC-20 name of this token | |
* @param symbol_ ERC-20 symbol of this token | |
* @param decimals_ ERC-20 decimal precision of this token | |
*/ | |
constructor(address underlying_, | |
ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint decimals_) public | |
CToken(comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_) { | |
// Set underlying | |
underlying = underlying_; | |
EIP20Interface(underlying).totalSupply(); // Sanity check the underlying | |
} | |
/*** User Interface ***/ | |
/** | |
* @notice Sender supplies assets into the market and receives cTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mint(uint mintAmount) external returns (uint) { | |
return mintInternal(mintAmount); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of cTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeem(uint redeemTokens) external returns (uint) { | |
return redeemInternal(redeemTokens); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to redeem | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlying(uint redeemAmount) external returns (uint) { | |
return redeemUnderlyingInternal(redeemAmount); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrow(uint borrowAmount) external returns (uint) { | |
return borrowInternal(borrowAmount); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrow(uint repayAmount) external returns (uint) { | |
return repayBorrowInternal(repayAmount); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint) { | |
return repayBorrowBehalfInternal(borrower, repayAmount); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrow(address borrower, uint repayAmount, CToken cTokenCollateral) external returns (uint) { | |
return liquidateBorrowInternal(borrower, repayAmount, cTokenCollateral); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying tokens owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint) { | |
EIP20Interface token = EIP20Interface(underlying); | |
return token.balanceOf(address(this)); | |
} | |
/** | |
* @dev Checks whether or not there is sufficient allowance for this contract to move amount from `from` and | |
* whether or not `from` has a balance of at least `amount`. Does NOT do a transfer. | |
*/ | |
function checkTransferIn(address from, uint amount) internal view returns (Error) { | |
EIP20Interface token = EIP20Interface(underlying); | |
if (token.allowance(from, address(this)) < amount) { | |
return Error.TOKEN_INSUFFICIENT_ALLOWANCE; | |
} | |
if (token.balanceOf(from) < amount) { | |
return Error.TOKEN_INSUFFICIENT_BALANCE; | |
} | |
return Error.NO_ERROR; | |
} | |
/** | |
* @dev Similar to EIP20 transfer, except it handles a False result from `transferFrom` and returns an explanatory | |
* error code rather than reverting. If caller has not called `checkTransferIn`, this may revert due to | |
* insufficient balance or insufficient allowance. If caller has called `checkTransferIn` prior to this call, | |
* and it returned Error.NO_ERROR, this should not revert in normal conditions. | |
* | |
* Note: This wrapper safely handles non-standard ERC-20 tokens that do not return a value. | |
* See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (Error) { | |
EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); | |
bool result; | |
token.transferFrom(from, address(this), amount); | |
// solium-disable-next-line security/no-inline-assembly | |
assembly { | |
switch returndatasize() | |
case 0 { // This is a non-standard ERC-20 | |
result := not(0) // set result to true | |
} | |
case 32 { // This is a complaint ERC-20 | |
returndatacopy(0, 0, 32) | |
result := mload(0) // Set `result = returndata` of external call | |
} | |
default { // This is an excessively non-compliant ERC-20, revert. | |
revert(0, 0) | |
} | |
} | |
if (!result) { | |
return Error.TOKEN_TRANSFER_IN_FAILED; | |
} | |
return Error.NO_ERROR; | |
} | |
/** | |
* @dev Similar to EIP20 transfer, except it handles a False result from `transfer` and returns an explanatory | |
* error code rather than reverting. If caller has not called checked protocol's balance, this may revert due to | |
* insufficient cash held in this contract. If caller has checked protocol's balance prior to this call, and verified | |
* it is >= amount, this should not revert in normal conditions. | |
* | |
* Note: This wrapper safely handles non-standard ERC-20 tokens that do not return a value. | |
* See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
function doTransferOut(address payable to, uint amount) internal returns (Error) { | |
EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); | |
bool result; | |
token.transfer(to, amount); | |
// solium-disable-next-line security/no-inline-assembly | |
assembly { | |
switch returndatasize() | |
case 0 { // This is a non-standard ERC-20 | |
result := not(0) // set result to true | |
} | |
case 32 { // This is a complaint ERC-20 | |
returndatacopy(0, 0, 32) | |
result := mload(0) // Set `result = returndata` of external call | |
} | |
default { // This is an excessively non-compliant ERC-20, revert. | |
revert(0, 0) | |
} | |
} | |
if (!result) { | |
return Error.TOKEN_TRANSFER_OUT_FAILED; | |
} | |
return Error.NO_ERROR; | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pragma solidity ^0.5.16; | |
import "https://github.com/compound-finance/compound-protocol/blob/master/contracts/CErc20.sol"; | |
/** | |
* @title Compound's CErc20Delegate Contract | |
* @notice CTokens which wrap an EIP-20 underlying and are delegated to | |
* @author Compound | |
*/ | |
contract CErc20Delegate is CErc20, CDelegateInterface { | |
/** | |
* @notice Construct an empty delegate | |
*/ | |
constructor() public {} | |
/** | |
* @notice Called by the delegator on a delegate to initialize it for duty | |
* @param data The encoded bytes data for any initialization | |
*/ | |
function _becomeImplementation(bytes memory data) public { | |
// Shh -- currently unused | |
data; | |
// Shh -- we don't ever want this hook to be marked pure | |
if (false) { | |
implementation = address(0); | |
} | |
require(msg.sender == admin, "only the admin may call _becomeImplementation"); | |
} | |
/** | |
* @notice Called by the delegator on a delegate to forfeit its responsibility | |
*/ | |
function _resignImplementation() public { | |
// Shh -- we don't ever want this hook to be marked pure | |
if (false) { | |
implementation = address(0); | |
} | |
require(msg.sender == admin, "only the admin may call _resignImplementation"); | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pragma solidity ^0.5.16; | |
import "https://github.com/compound-finance/compound-protocol/blob/master/contracts/CTokenInterfaces.sol"; | |
/** | |
* @title Compound's CErc20Delegator Contract | |
* @notice CTokens which wrap an EIP-20 underlying and delegate to an implementation | |
* @author Compound | |
*/ | |
contract CErc20Delegator is CTokenInterface, CErc20Interface, CDelegatorInterface { | |
/** | |
* @notice Construct a new money market | |
* @param underlying_ The address of the underlying asset | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ ERC-20 name of this token | |
* @param symbol_ ERC-20 symbol of this token | |
* @param decimals_ ERC-20 decimal precision of this token | |
* @param admin_ Address of the administrator of this token | |
* @param implementation_ The address of the implementation the contract delegates to | |
* @param becomeImplementationData The encoded args for becomeImplementation | |
*/ | |
constructor(address underlying_, | |
ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_, | |
address payable admin_, | |
address implementation_, | |
bytes memory becomeImplementationData) public { | |
// Creator of the contract is admin during initialization | |
admin = msg.sender; | |
// First delegate gets to initialize the delegator (i.e. storage contract) | |
delegateTo(implementation_, abi.encodeWithSignature("initialize(address,address,address,uint256,string,string,uint8)", | |
underlying_, | |
comptroller_, | |
interestRateModel_, | |
initialExchangeRateMantissa_, | |
name_, | |
symbol_, | |
decimals_)); | |
// New implementations always get set via the settor (post-initialize) | |
_setImplementation(implementation_, false, becomeImplementationData); | |
// Set the proper admin now that initialization is done | |
admin = admin_; | |
} | |
/** | |
* @notice Called by the admin to update the implementation of the delegator | |
* @param implementation_ The address of the new implementation for delegation | |
* @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation | |
* @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation | |
*/ | |
function _setImplementation(address implementation_, bool allowResign, bytes memory becomeImplementationData) public { | |
require(msg.sender == admin, "CErc20Delegator::_setImplementation: Caller must be admin"); | |
if (allowResign) { | |
delegateToImplementation(abi.encodeWithSignature("_resignImplementation()")); | |
} | |
address oldImplementation = implementation; | |
implementation = implementation_; | |
delegateToImplementation(abi.encodeWithSignature("_becomeImplementation(bytes)", becomeImplementationData)); | |
emit NewImplementation(oldImplementation, implementation); | |
} | |
/** | |
* @notice Sender supplies assets into the market and receives cTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mint(uint mintAmount) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("mint(uint256)", mintAmount)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of cTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeem(uint redeemTokens) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("redeem(uint256)", redeemTokens)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to redeem | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlying(uint redeemAmount) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("redeemUnderlying(uint256)", redeemAmount)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrow(uint borrowAmount) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("borrow(uint256)", borrowAmount)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrow(uint repayAmount) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("repayBorrow(uint256)", repayAmount)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("repayBorrowBehalf(address,uint256)", borrower, repayAmount)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrow(address borrower, uint repayAmount, CTokenInterface cTokenCollateral) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("liquidateBorrow(address,uint256,address)", borrower, repayAmount, cTokenCollateral)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint amount) external returns (bool) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("transfer(address,uint256)", dst, amount)); | |
return abi.decode(data, (bool)); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external returns (bool) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("transferFrom(address,address,uint256)", src, dst, amount)); | |
return abi.decode(data, (bool)); | |
} | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("approve(address,uint256)", spender, amount)); | |
return abi.decode(data, (bool)); | |
} | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("allowance(address,address)", owner, spender)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Get the token balance of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of tokens owned by `owner` | |
*/ | |
function balanceOf(address owner) external view returns (uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("balanceOf(address)", owner)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Get the underlying balance of the `owner` | |
* @dev This also accrues interest in a transaction | |
* @param owner The address of the account to query | |
* @return The amount of underlying owned by `owner` | |
*/ | |
function balanceOfUnderlying(address owner) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("balanceOfUnderlying(address)", owner)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Get a snapshot of the account's balances, and the cached exchange rate | |
* @dev This is used by comptroller to more efficiently perform liquidity checks. | |
* @param account Address of the account to snapshot | |
* @return (possible error, token balance, borrow balance, exchange rate mantissa) | |
*/ | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("getAccountSnapshot(address)", account)); | |
return abi.decode(data, (uint, uint, uint, uint)); | |
} | |
/** | |
* @notice Returns the current per-block borrow interest rate for this cToken | |
* @return The borrow interest rate per block, scaled by 1e18 | |
*/ | |
function borrowRatePerBlock() external view returns (uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("borrowRatePerBlock()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Returns the current per-block supply interest rate for this cToken | |
* @return The supply interest rate per block, scaled by 1e18 | |
*/ | |
function supplyRatePerBlock() external view returns (uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("supplyRatePerBlock()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Returns the current total borrows plus accrued interest | |
* @return The total borrows with interest | |
*/ | |
function totalBorrowsCurrent() external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("totalBorrowsCurrent()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex | |
* @param account The address whose balance should be calculated after updating borrowIndex | |
* @return The calculated balance | |
*/ | |
function borrowBalanceCurrent(address account) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("borrowBalanceCurrent(address)", account)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return The calculated balance | |
*/ | |
function borrowBalanceStored(address account) public view returns (uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("borrowBalanceStored(address)", account)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Accrue interest then return the up-to-date exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateCurrent() public returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("exchangeRateCurrent()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the CToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateStored() public view returns (uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("exchangeRateStored()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Get cash balance of this cToken in the underlying asset | |
* @return The quantity of underlying asset owned by this contract | |
*/ | |
function getCash() external view returns (uint) { | |
bytes memory data = delegateToViewImplementation(abi.encodeWithSignature("getCash()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Applies accrued interest to total borrows and reserves. | |
* @dev This calculates interest accrued from the last checkpointed block | |
* up to the current block and writes new checkpoint to storage. | |
*/ | |
function accrueInterest() public returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("accrueInterest()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Will fail unless called by another cToken during the process of liquidation. | |
* Its absolutely critical to use msg.sender as the borrowed cToken and not a parameter. | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of cTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seize(address liquidator, address borrower, uint seizeTokens) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("seize(address,address,uint256)", liquidator, borrower, seizeTokens)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice A public function to sweep accidental ERC-20 transfers to this contract. Tokens are sent to admin (timelock) | |
* @param token The address of the ERC-20 token to sweep | |
*/ | |
function sweepToken(EIP20NonStandardInterface token) external { | |
delegateToImplementation(abi.encodeWithSignature("sweepToken(address)", token)); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("_setPendingAdmin(address)", newPendingAdmin)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Sets a new comptroller for the market | |
* @dev Admin function to set a new comptroller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("_setComptroller(address)", newComptroller)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh | |
* @dev Admin function to accrue interest and set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactor(uint newReserveFactorMantissa) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("_setReserveFactor(uint256)", newReserveFactorMantissa)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("_acceptAdmin()")); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Accrues interest and adds reserves by transferring from admin | |
* @param addAmount Amount of reserves to add | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _addReserves(uint addAmount) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("_addReserves(uint256)", addAmount)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring to admin | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReserves(uint reduceAmount) external returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("_reduceReserves(uint256)", reduceAmount)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Accrues interest and updates the interest rate model using _setInterestRateModelFresh | |
* @dev Admin function to accrue interest and update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { | |
bytes memory data = delegateToImplementation(abi.encodeWithSignature("_setInterestRateModel(address)", newInterestRateModel)); | |
return abi.decode(data, (uint)); | |
} | |
/** | |
* @notice Internal method to delegate execution to another contract | |
* @dev It returns to the external caller whatever the implementation returns or forwards reverts | |
* @param callee The contract to delegatecall | |
* @param data The raw data to delegatecall | |
* @return The returned bytes from the delegatecall | |
*/ | |
function delegateTo(address callee, bytes memory data) internal returns (bytes memory) { | |
(bool success, bytes memory returnData) = callee.delegatecall(data); | |
assembly { | |
if eq(success, 0) { | |
revert(add(returnData, 0x20), returndatasize) | |
} | |
} | |
return returnData; | |
} | |
/** | |
* @notice Delegates execution to the implementation contract | |
* @dev It returns to the external caller whatever the implementation returns or forwards reverts | |
* @param data The raw data to delegatecall | |
* @return The returned bytes from the delegatecall | |
*/ | |
function delegateToImplementation(bytes memory data) public returns (bytes memory) { | |
return delegateTo(implementation, data); | |
} | |
/** | |
* @notice Delegates execution to an implementation contract | |
* @dev It returns to the external caller whatever the implementation returns or forwards reverts | |
* There are an additional 2 prefix uints from the wrapper returndata, which we ignore since we make an extra hop. | |
* @param data The raw data to delegatecall | |
* @return The returned bytes from the delegatecall | |
*/ | |
function delegateToViewImplementation(bytes memory data) public view returns (bytes memory) { | |
(bool success, bytes memory returnData) = address(this).staticcall(abi.encodeWithSignature("delegateToImplementation(bytes)", data)); | |
assembly { | |
if eq(success, 0) { | |
revert(add(returnData, 0x20), returndatasize) | |
} | |
} | |
return abi.decode(returnData, (bytes)); | |
} | |
/** | |
* @notice Delegates execution to an implementation contract | |
* @dev It returns to the external caller whatever the implementation returns or forwards reverts | |
*/ | |
function () external payable { | |
require(msg.value == 0,"CErc20Delegator:fallback: cannot send value to fallback"); | |
// delegate all other functions to current implementation | |
(bool success, ) = implementation.delegatecall(msg.data); | |
assembly { | |
let free_mem_ptr := mload(0x40) | |
returndatacopy(free_mem_ptr, 0, returndatasize) | |
switch success | |
case 0 { revert(free_mem_ptr, returndatasize) } | |
default { return(free_mem_ptr, returndatasize) } | |
} | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
*Submitted for verification at BscScan.com on 2021-04-26 | |
*/ | |
// File: ComptrollerInterface.sol | |
pragma solidity ^0.5.16; | |
contract ComptrollerInterface { | |
/// @notice Indicator that this is a Comptroller contract (for inspection) | |
bool public constant isComptroller = true; | |
/*** Assets You Are In ***/ | |
function enterMarkets(address[] calldata vTokens) external returns (uint[] memory); | |
function exitMarket(address vToken) external returns (uint); | |
/*** Policy Hooks ***/ | |
function mintAllowed(address vToken, address minter, uint mintAmount) external returns (uint); | |
function mintVerify(address vToken, address minter, uint mintAmount, uint mintTokens) external; | |
function redeemAllowed(address vToken, address redeemer, uint redeemTokens) external returns (uint); | |
function redeemVerify(address vToken, address redeemer, uint redeemAmount, uint redeemTokens) external; | |
function borrowAllowed(address vToken, address borrower, uint borrowAmount) external returns (uint); | |
function borrowVerify(address vToken, address borrower, uint borrowAmount) external; | |
function repayBorrowAllowed( | |
address vToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function repayBorrowVerify( | |
address vToken, | |
address payer, | |
address borrower, | |
uint repayAmount, | |
uint borrowerIndex) external; | |
function liquidateBorrowAllowed( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function liquidateBorrowVerify( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount, | |
uint seizeTokens) external; | |
function seizeAllowed( | |
address vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external returns (uint); | |
function seizeVerify( | |
address vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external; | |
function transferAllowed(address vToken, address src, address dst, uint transferTokens) external returns (uint); | |
function transferVerify(address vToken, address src, address dst, uint transferTokens) external; | |
/*** Liquidity/Liquidation Calculations ***/ | |
function liquidateCalculateSeizeTokens( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
uint repayAmount) external view returns (uint, uint); | |
function setMintedVAIOf(address owner, uint amount) external returns (uint); | |
} | |
interface IVAIVault { | |
function updatePendingRewards() external; | |
} | |
// File: InterestRateModel.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Venus's InterestRateModel Interface | |
* @author Venus | |
*/ | |
contract InterestRateModel { | |
/// @notice Indicator that this is an InterestRateModel contract (for inspection) | |
bool public constant isInterestRateModel = true; | |
/** | |
* @notice Calculates the current borrow interest rate per block | |
* @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 amnount of reserves the market has | |
* @return The borrow rate per block (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 block | |
* @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 amnount of reserves the market has | |
* @param reserveFactorMantissa The current reserve factor the market has | |
* @return The supply rate per block (as a percentage, and scaled by 1e18) | |
*/ | |
function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) external view returns (uint); | |
} | |
// File: VTokenInterfaces.sol | |
pragma solidity ^0.5.16; | |
contract VTokenStorage { | |
/** | |
* @dev Guard variable for re-entrancy checks | |
*/ | |
bool internal _notEntered; | |
/** | |
* @notice EIP-20 token name for this token | |
*/ | |
string public name; | |
/** | |
* @notice EIP-20 token symbol for this token | |
*/ | |
string public symbol; | |
/** | |
* @notice EIP-20 token decimals for this token | |
*/ | |
uint8 public decimals; | |
/** | |
* @notice Maximum borrow rate that can ever be applied (.0005% / block) | |
*/ | |
uint internal constant borrowRateMaxMantissa = 0.0005e16; | |
/** | |
* @notice Maximum fraction of interest that can be set aside for reserves | |
*/ | |
uint internal constant reserveFactorMaxMantissa = 1e18; | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address payable public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address payable public pendingAdmin; | |
/** | |
* @notice Contract which oversees inter-vToken operations | |
*/ | |
ComptrollerInterface public comptroller; | |
/** | |
* @notice Model which tells what the current interest rate should be | |
*/ | |
InterestRateModel public interestRateModel; | |
/** | |
* @notice Initial exchange rate used when minting the first VTokens (used when totalSupply = 0) | |
*/ | |
uint internal initialExchangeRateMantissa; | |
/** | |
* @notice Fraction of interest currently set aside for reserves | |
*/ | |
uint public reserveFactorMantissa; | |
/** | |
* @notice Block number that interest was last accrued at | |
*/ | |
uint public accrualBlockNumber; | |
/** | |
* @notice Accumulator of the total earned interest rate since the opening of the market | |
*/ | |
uint public borrowIndex; | |
/** | |
* @notice Total amount of outstanding borrows of the underlying in this market | |
*/ | |
uint public totalBorrows; | |
/** | |
* @notice Total amount of reserves of the underlying held in this market | |
*/ | |
uint public totalReserves; | |
/** | |
* @notice Total number of tokens in circulation | |
*/ | |
uint public totalSupply; | |
/** | |
* @notice Official record of token balances for each account | |
*/ | |
mapping (address => uint) internal accountTokens; | |
/** | |
* @notice Approved token transfer amounts on behalf of others | |
*/ | |
mapping (address => mapping (address => uint)) internal transferAllowances; | |
/** | |
* @notice Container for borrow balance information | |
* @member principal Total balance (with accrued interest), after applying the most recent balance-changing action | |
* @member interestIndex Global borrowIndex as of the most recent balance-changing action | |
*/ | |
struct BorrowSnapshot { | |
uint principal; | |
uint interestIndex; | |
} | |
/** | |
* @notice Mapping of account addresses to outstanding borrow balances | |
*/ | |
mapping(address => BorrowSnapshot) internal accountBorrows; | |
} | |
contract VTokenInterface is VTokenStorage { | |
/** | |
* @notice Indicator that this is a VToken contract (for inspection) | |
*/ | |
bool public constant isVToken = true; | |
/*** Market Events ***/ | |
/** | |
* @notice Event emitted when interest is accrued | |
*/ | |
event AccrueInterest(uint cashPrior, uint interestAccumulated, uint borrowIndex, uint totalBorrows); | |
/** | |
* @notice Event emitted when tokens are minted | |
*/ | |
event Mint(address minter, uint mintAmount, uint mintTokens); | |
/** | |
* @notice Event emitted when tokens are redeemed | |
*/ | |
event Redeem(address redeemer, uint redeemAmount, uint redeemTokens); | |
/** | |
* @notice Event emitted when underlying is borrowed | |
*/ | |
event Borrow(address borrower, uint borrowAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is repaid | |
*/ | |
event RepayBorrow(address payer, address borrower, uint repayAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is liquidated | |
*/ | |
event LiquidateBorrow(address liquidator, address borrower, uint repayAmount, address vTokenCollateral, uint seizeTokens); | |
/*** Admin Events ***/ | |
/** | |
* @notice Event emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Event emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
/** | |
* @notice Event emitted when comptroller is changed | |
*/ | |
event NewComptroller(ComptrollerInterface oldComptroller, ComptrollerInterface newComptroller); | |
/** | |
* @notice Event emitted when interestRateModel is changed | |
*/ | |
event NewMarketInterestRateModel(InterestRateModel oldInterestRateModel, InterestRateModel newInterestRateModel); | |
/** | |
* @notice Event emitted when the reserve factor is changed | |
*/ | |
event NewReserveFactor(uint oldReserveFactorMantissa, uint newReserveFactorMantissa); | |
/** | |
* @notice Event emitted when the reserves are added | |
*/ | |
event ReservesAdded(address benefactor, uint addAmount, uint newTotalReserves); | |
/** | |
* @notice Event emitted when the reserves are reduced | |
*/ | |
event ReservesReduced(address admin, uint reduceAmount, uint newTotalReserves); | |
/** | |
* @notice EIP20 Transfer event | |
*/ | |
event Transfer(address indexed from, address indexed to, uint amount); | |
/** | |
* @notice EIP20 Approval event | |
*/ | |
event Approval(address indexed owner, address indexed spender, uint amount); | |
/** | |
* @notice Failure event | |
*/ | |
event Failure(uint error, uint info, uint detail); | |
/*** User Interface ***/ | |
function transfer(address dst, uint amount) external returns (bool); | |
function transferFrom(address src, address dst, uint amount) external returns (bool); | |
function approve(address spender, uint amount) external returns (bool); | |
function allowance(address owner, address spender) external view returns (uint); | |
function balanceOf(address owner) external view returns (uint); | |
function balanceOfUnderlying(address owner) external returns (uint); | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint); | |
function borrowRatePerBlock() external view returns (uint); | |
function supplyRatePerBlock() external view returns (uint); | |
function totalBorrowsCurrent() external returns (uint); | |
function borrowBalanceCurrent(address account) external returns (uint); | |
function borrowBalanceStored(address account) public view returns (uint); | |
function exchangeRateCurrent() public returns (uint); | |
function exchangeRateStored() public view returns (uint); | |
function getCash() external view returns (uint); | |
function accrueInterest() public returns (uint); | |
function seize(address liquidator, address borrower, uint seizeTokens) external returns (uint); | |
/*** Admin Functions ***/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint); | |
function _acceptAdmin() external returns (uint); | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint); | |
function _setReserveFactor(uint newReserveFactorMantissa) external returns (uint); | |
function _reduceReserves(uint reduceAmount) external returns (uint); | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint); | |
} | |
contract VBep20Storage { | |
/** | |
* @notice Underlying asset for this VToken | |
*/ | |
address public underlying; | |
} | |
contract VBep20Interface is VBep20Storage { | |
/*** User Interface ***/ | |
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, VTokenInterface vTokenCollateral) external returns (uint); | |
/*** Admin Functions ***/ | |
function _addReserves(uint addAmount) external returns (uint); | |
} | |
contract VDelegationStorage { | |
/** | |
* @notice Implementation address for this contract | |
*/ | |
address public implementation; | |
} | |
contract VDelegatorInterface is VDelegationStorage { | |
/** | |
* @notice Emitted when implementation is changed | |
*/ | |
event NewImplementation(address oldImplementation, address newImplementation); | |
/** | |
* @notice Called by the admin to update the implementation of the delegator | |
* @param implementation_ The address of the new implementation for delegation | |
* @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation | |
* @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation | |
*/ | |
function _setImplementation(address implementation_, bool allowResign, bytes memory becomeImplementationData) public; | |
} | |
contract VDelegateInterface is VDelegationStorage { | |
/** | |
* @notice Called by the delegator on a delegate to initialize it for duty | |
* @dev Should revert if any issues arise which make it unfit for delegation | |
* @param data The encoded bytes data for any initialization | |
*/ | |
function _becomeImplementation(bytes memory data) public; | |
/** | |
* @notice Called by the delegator on a delegate to forfeit its responsibility | |
*/ | |
function _resignImplementation() public; | |
} | |
// File: ErrorReporter.sol | |
pragma solidity ^0.5.16; | |
contract ComptrollerErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
COMPTROLLER_MISMATCH, | |
INSUFFICIENT_SHORTFALL, | |
INSUFFICIENT_LIQUIDITY, | |
INVALID_CLOSE_FACTOR, | |
INVALID_COLLATERAL_FACTOR, | |
INVALID_LIQUIDATION_INCENTIVE, | |
MARKET_NOT_ENTERED, // no longer possible | |
MARKET_NOT_LISTED, | |
MARKET_ALREADY_LISTED, | |
MATH_ERROR, | |
NONZERO_BORROW_BALANCE, | |
PRICE_ERROR, | |
REJECTION, | |
SNAPSHOT_ERROR, | |
TOO_MANY_ASSETS, | |
TOO_MUCH_REPAY, | |
INSUFFICIENT_BALANCE_FOR_VAI | |
} | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
EXIT_MARKET_BALANCE_OWED, | |
EXIT_MARKET_REJECTION, | |
SET_CLOSE_FACTOR_OWNER_CHECK, | |
SET_CLOSE_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_NO_EXISTS, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_WITHOUT_PRICE, | |
SET_IMPLEMENTATION_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_VALIDATION, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_OWNER_CHECK, | |
SET_PRICE_ORACLE_OWNER_CHECK, | |
SUPPORT_MARKET_EXISTS, | |
SUPPORT_MARKET_OWNER_CHECK, | |
SET_PAUSE_GUARDIAN_OWNER_CHECK, | |
SET_VAI_MINT_RATE_CHECK, | |
SET_VAICONTROLLER_OWNER_CHECK, | |
SET_MINTED_VAI_REJECTION, | |
VAI_CONTROLLER_MISMATCH | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
contract TokenErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
BAD_INPUT, | |
COMPTROLLER_REJECTION, | |
COMPTROLLER_CALCULATION_ERROR, | |
INTEREST_RATE_MODEL_ERROR, | |
INVALID_ACCOUNT_PAIR, | |
INVALID_CLOSE_AMOUNT_REQUESTED, | |
INVALID_COLLATERAL_FACTOR, | |
MATH_ERROR, | |
MARKET_NOT_FRESH, | |
MARKET_NOT_LISTED, | |
TOKEN_INSUFFICIENT_ALLOWANCE, | |
TOKEN_INSUFFICIENT_BALANCE, | |
TOKEN_INSUFFICIENT_CASH, | |
TOKEN_TRANSFER_IN_FAILED, | |
TOKEN_TRANSFER_OUT_FAILED, | |
TOKEN_PRICE_ERROR | |
} | |
/* | |
* Note: FailureInfo (but not Error) is kept in alphabetical order | |
* This is because FailureInfo grows significantly faster, and | |
* the order of Error has some meaning, while the order of FailureInfo | |
* is entirely arbitrary. | |
*/ | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, | |
ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, | |
ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, | |
BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
BORROW_ACCRUE_INTEREST_FAILED, | |
BORROW_CASH_NOT_AVAILABLE, | |
BORROW_FRESHNESS_CHECK, | |
BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
BORROW_MARKET_NOT_LISTED, | |
BORROW_COMPTROLLER_REJECTION, | |
LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED, | |
LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED, | |
LIQUIDATE_COLLATERAL_FRESHNESS_CHECK, | |
LIQUIDATE_COMPTROLLER_REJECTION, | |
LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, | |
LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX, | |
LIQUIDATE_CLOSE_AMOUNT_IS_ZERO, | |
LIQUIDATE_FRESHNESS_CHECK, | |
LIQUIDATE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_REPAY_BORROW_FRESH_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, | |
LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, | |
LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_SEIZE_TOO_MUCH, | |
MINT_ACCRUE_INTEREST_FAILED, | |
MINT_COMPTROLLER_REJECTION, | |
MINT_EXCHANGE_CALCULATION_FAILED, | |
MINT_EXCHANGE_RATE_READ_FAILED, | |
MINT_FRESHNESS_CHECK, | |
MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
MINT_TRANSFER_IN_FAILED, | |
MINT_TRANSFER_IN_NOT_POSSIBLE, | |
REDEEM_ACCRUE_INTEREST_FAILED, | |
REDEEM_COMPTROLLER_REJECTION, | |
REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_RATE_READ_FAILED, | |
REDEEM_FRESHNESS_CHECK, | |
REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
REDEEM_TRANSFER_OUT_NOT_POSSIBLE, | |
REDUCE_RESERVES_ACCRUE_INTEREST_FAILED, | |
REDUCE_RESERVES_ADMIN_CHECK, | |
REDUCE_RESERVES_CASH_NOT_AVAILABLE, | |
REDUCE_RESERVES_FRESH_CHECK, | |
REDUCE_RESERVES_VALIDATION, | |
REPAY_BEHALF_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_COMPTROLLER_REJECTION, | |
REPAY_BORROW_FRESHNESS_CHECK, | |
REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COMPTROLLER_OWNER_CHECK, | |
SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED, | |
SET_INTEREST_RATE_MODEL_FRESH_CHECK, | |
SET_INTEREST_RATE_MODEL_OWNER_CHECK, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_ORACLE_MARKET_NOT_LISTED, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED, | |
SET_RESERVE_FACTOR_ADMIN_CHECK, | |
SET_RESERVE_FACTOR_FRESH_CHECK, | |
SET_RESERVE_FACTOR_BOUNDS_CHECK, | |
TRANSFER_COMPTROLLER_REJECTION, | |
TRANSFER_NOT_ALLOWED, | |
TRANSFER_NOT_ENOUGH, | |
TRANSFER_TOO_MUCH, | |
ADD_RESERVES_ACCRUE_INTEREST_FAILED, | |
ADD_RESERVES_FRESH_CHECK, | |
ADD_RESERVES_TRANSFER_IN_NOT_POSSIBLE, | |
TOKEN_GET_UNDERLYING_PRICE_ERROR, | |
REPAY_VAI_COMPTROLLER_REJECTION, | |
REPAY_VAI_FRESHNESS_CHECK, | |
VAI_MINT_EXCHANGE_CALCULATION_FAILED, | |
VAI_MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
contract VAIControllerErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
REJECTION, | |
SNAPSHOT_ERROR, | |
PRICE_ERROR, | |
MATH_ERROR, | |
INSUFFICIENT_BALANCE_FOR_VAI | |
} | |
enum FailureInfo { | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_OWNER_CHECK, | |
SET_COMPTROLLER_OWNER_CHECK, | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
VAI_MINT_REJECTION, | |
VAI_BURN_REJECTION | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
// File: CarefulMath.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Careful Math | |
* @author Venus | |
* @notice Derived from OpenZeppelin's SafeMath library | |
* https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/math/SafeMath.sol | |
*/ | |
contract CarefulMath { | |
/** | |
* @dev Possible error codes that we can return | |
*/ | |
enum MathError { | |
NO_ERROR, | |
DIVISION_BY_ZERO, | |
INTEGER_OVERFLOW, | |
INTEGER_UNDERFLOW | |
} | |
/** | |
* @dev Multiplies two numbers, returns an error on overflow. | |
*/ | |
function mulUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (a == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
uint c = a * b; | |
if (c / a != b) { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} else { | |
return (MathError.NO_ERROR, c); | |
} | |
} | |
/** | |
* @dev Integer division of two numbers, truncating the quotient. | |
*/ | |
function divUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b == 0) { | |
return (MathError.DIVISION_BY_ZERO, 0); | |
} | |
return (MathError.NO_ERROR, a / b); | |
} | |
/** | |
* @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). | |
*/ | |
function subUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b <= a) { | |
return (MathError.NO_ERROR, a - b); | |
} else { | |
return (MathError.INTEGER_UNDERFLOW, 0); | |
} | |
} | |
/** | |
* @dev Adds two numbers, returns an error on overflow. | |
*/ | |
function addUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
uint c = a + b; | |
if (c >= a) { | |
return (MathError.NO_ERROR, c); | |
} else { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} | |
} | |
/** | |
* @dev add a and b and then subtract c | |
*/ | |
function addThenSubUInt(uint a, uint b, uint c) internal pure returns (MathError, uint) { | |
(MathError err0, uint sum) = addUInt(a, b); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, 0); | |
} | |
return subUInt(sum, c); | |
} | |
} | |
// File: Exponential.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Exponential module for storing fixed-precision decimals | |
* @author Venus | |
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. | |
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: | |
* `Exp({mantissa: 5100000000000000000})`. | |
*/ | |
contract Exponential is CarefulMath { | |
uint constant expScale = 1e18; | |
uint constant doubleScale = 1e36; | |
uint constant halfExpScale = expScale/2; | |
uint constant mantissaOne = expScale; | |
struct Exp { | |
uint mantissa; | |
} | |
struct Double { | |
uint mantissa; | |
} | |
/** | |
* @dev Creates an exponential from numerator and denominator values. | |
* Note: Returns an error if (`num` * 10e18) > MAX_INT, | |
* or if `denom` is zero. | |
*/ | |
function getExp(uint num, uint denom) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint scaledNumerator) = mulUInt(num, expScale); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
(MathError err1, uint rational) = divUInt(scaledNumerator, denom); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: rational})); | |
} | |
/** | |
* @dev Adds two exponentials, returning a new exponential. | |
*/ | |
function addExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
(MathError error, uint result) = addUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Subtracts two exponentials, returning a new exponential. | |
*/ | |
function subExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
(MathError error, uint result) = subUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, returning a new Exp. | |
*/ | |
function mulScalar(Exp memory a, uint scalar) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint scaledMantissa) = mulUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: scaledMantissa})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. | |
*/ | |
function mulScalarTruncate(Exp memory a, uint scalar) internal pure returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(product)); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. | |
*/ | |
function mulScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) internal pure returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return addUInt(truncate(product), addend); | |
} | |
/** | |
* @dev Divide an Exp by a scalar, returning a new Exp. | |
*/ | |
function divScalar(Exp memory a, uint scalar) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint descaledMantissa) = divUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: descaledMantissa})); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, returning a new Exp. | |
*/ | |
function divScalarByExp(uint scalar, Exp memory divisor) internal pure returns (MathError, Exp memory) { | |
/* | |
We are doing this as: | |
getExp(mulUInt(expScale, scalar), divisor.mantissa) | |
How it works: | |
Exp = a / b; | |
Scalar = s; | |
`s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` | |
*/ | |
(MathError err0, uint numerator) = mulUInt(expScale, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return getExp(numerator, divisor.mantissa); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, then truncate to return an unsigned integer. | |
*/ | |
function divScalarByExpTruncate(uint scalar, Exp memory divisor) internal pure returns (MathError, uint) { | |
(MathError err, Exp memory fraction) = divScalarByExp(scalar, divisor); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(fraction)); | |
} | |
/** | |
* @dev Multiplies two exponentials, returning a new exponential. | |
*/ | |
function mulExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint doubleScaledProduct) = mulUInt(a.mantissa, b.mantissa); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
// We add half the scale before dividing so that we get rounding instead of truncation. | |
// See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 | |
// Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. | |
(MathError err1, uint doubleScaledProductWithHalfScale) = addUInt(halfExpScale, doubleScaledProduct); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
(MathError err2, uint product) = divUInt(doubleScaledProductWithHalfScale, expScale); | |
// The only error `div` can return is MathError.DIVISION_BY_ZERO but we control `expScale` and it is not zero. | |
assert(err2 == MathError.NO_ERROR); | |
return (MathError.NO_ERROR, Exp({mantissa: product})); | |
} | |
/** | |
* @dev Multiplies two exponentials given their mantissas, returning a new exponential. | |
*/ | |
function mulExp(uint a, uint b) internal pure returns (MathError, Exp memory) { | |
return mulExp(Exp({mantissa: a}), Exp({mantissa: b})); | |
} | |
/** | |
* @dev Multiplies three exponentials, returning a new exponential. | |
*/ | |
function mulExp3(Exp memory a, Exp memory b, Exp memory c) internal pure returns (MathError, Exp memory) { | |
(MathError err, Exp memory ab) = mulExp(a, b); | |
if (err != MathError.NO_ERROR) { | |
return (err, ab); | |
} | |
return mulExp(ab, c); | |
} | |
/** | |
* @dev Divides two exponentials, returning a new exponential. | |
* (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, | |
* which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) | |
*/ | |
function divExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
return getExp(a.mantissa, b.mantissa); | |
} | |
/** | |
* @dev Truncates the given exp to a whole number value. | |
* For example, truncate(Exp{mantissa: 15 * expScale}) = 15 | |
*/ | |
function truncate(Exp memory exp) internal pure returns (uint) { | |
// Note: We are not using careful math here as we're performing a division that cannot fail | |
return exp.mantissa / expScale; | |
} | |
/** | |
* @dev Checks if first Exp is less than second Exp. | |
*/ | |
function lessThanExp(Exp memory left, Exp memory right) internal pure returns (bool) { | |
return left.mantissa < right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp <= right Exp. | |
*/ | |
function lessThanOrEqualExp(Exp memory left, Exp memory right) internal pure returns (bool) { | |
return left.mantissa <= right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp > right Exp. | |
*/ | |
function greaterThanExp(Exp memory left, Exp memory right) internal pure returns (bool) { | |
return left.mantissa > right.mantissa; | |
} | |
/** | |
* @dev returns true if Exp is exactly zero | |
*/ | |
function isZeroExp(Exp memory value) internal pure returns (bool) { | |
return value.mantissa == 0; | |
} | |
function safe224(uint n, string memory errorMessage) internal pure returns (uint224) { | |
require(n < 2**224, errorMessage); | |
return uint224(n); | |
} | |
function safe32(uint n, string memory errorMessage) internal pure returns (uint32) { | |
require(n < 2**32, errorMessage); | |
return uint32(n); | |
} | |
function add_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: add_(a.mantissa, b.mantissa)}); | |
} | |
function add_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: add_(a.mantissa, b.mantissa)}); | |
} | |
function add_(uint a, uint b) internal pure returns (uint) { | |
return add_(a, b, "addition overflow"); | |
} | |
function add_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
uint c = a + b; | |
require(c >= a, errorMessage); | |
return c; | |
} | |
function sub_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: sub_(a.mantissa, b.mantissa)}); | |
} | |
function sub_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: sub_(a.mantissa, b.mantissa)}); | |
} | |
function sub_(uint a, uint b) internal pure returns (uint) { | |
return sub_(a, b, "subtraction underflow"); | |
} | |
function sub_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
require(b <= a, errorMessage); | |
return a - b; | |
} | |
function mul_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: mul_(a.mantissa, b.mantissa) / expScale}); | |
} | |
function mul_(Exp memory a, uint b) internal pure returns (Exp memory) { | |
return Exp({mantissa: mul_(a.mantissa, b)}); | |
} | |
function mul_(uint a, Exp memory b) internal pure returns (uint) { | |
return mul_(a, b.mantissa) / expScale; | |
} | |
function mul_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: mul_(a.mantissa, b.mantissa) / doubleScale}); | |
} | |
function mul_(Double memory a, uint b) internal pure returns (Double memory) { | |
return Double({mantissa: mul_(a.mantissa, b)}); | |
} | |
function mul_(uint a, Double memory b) internal pure returns (uint) { | |
return mul_(a, b.mantissa) / doubleScale; | |
} | |
function mul_(uint a, uint b) internal pure returns (uint) { | |
return mul_(a, b, "multiplication overflow"); | |
} | |
function mul_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
if (a == 0 || b == 0) { | |
return 0; | |
} | |
uint c = a * b; | |
require(c / a == b, errorMessage); | |
return c; | |
} | |
function div_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: div_(mul_(a.mantissa, expScale), b.mantissa)}); | |
} | |
function div_(Exp memory a, uint b) internal pure returns (Exp memory) { | |
return Exp({mantissa: div_(a.mantissa, b)}); | |
} | |
function div_(uint a, Exp memory b) internal pure returns (uint) { | |
return div_(mul_(a, expScale), b.mantissa); | |
} | |
function div_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: div_(mul_(a.mantissa, doubleScale), b.mantissa)}); | |
} | |
function div_(Double memory a, uint b) internal pure returns (Double memory) { | |
return Double({mantissa: div_(a.mantissa, b)}); | |
} | |
function div_(uint a, Double memory b) internal pure returns (uint) { | |
return div_(mul_(a, doubleScale), b.mantissa); | |
} | |
function div_(uint a, uint b) internal pure returns (uint) { | |
return div_(a, b, "divide by zero"); | |
} | |
function div_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
require(b > 0, errorMessage); | |
return a / b; | |
} | |
function fraction(uint a, uint b) internal pure returns (Double memory) { | |
return Double({mantissa: div_(mul_(a, doubleScale), b)}); | |
} | |
} | |
// File: EIP20Interface.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title BEP 20 Token Standard Interface | |
* https://eips.ethereum.org/EIPS/eip-20 | |
*/ | |
interface EIP20Interface { | |
function name() external view returns (string memory); | |
function symbol() external view returns (string memory); | |
function decimals() external view returns (uint8); | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: EIP20NonStandardInterface.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title EIP20NonStandardInterface | |
* @dev Version of BEP20 with no return values for `transfer` and `transferFrom` | |
* See https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
interface EIP20NonStandardInterface { | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transfer` does not return a value, in violation of the BEP-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transfer(address dst, uint256 amount) external; | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transferFrom` does not return a value, in violation of the BEP-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external; | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: VToken.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Venus's VToken Contract | |
* @notice Abstract base for VTokens | |
* @author Venus | |
*/ | |
contract VToken is VTokenInterface, Exponential, TokenErrorReporter { | |
/** | |
* @notice Initialize the money market | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ EIP-20 name of this token | |
* @param symbol_ EIP-20 symbol of this token | |
* @param decimals_ EIP-20 decimal precision of this token | |
*/ | |
function initialize(ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_) public { | |
require(msg.sender == admin, "only admin may initialize the market"); | |
require(accrualBlockNumber == 0 && borrowIndex == 0, "market may only be initialized once"); | |
// Set initial exchange rate | |
initialExchangeRateMantissa = initialExchangeRateMantissa_; | |
require(initialExchangeRateMantissa > 0, "initial exchange rate must be greater than zero."); | |
// Set the comptroller | |
uint err = _setComptroller(comptroller_); | |
require(err == uint(Error.NO_ERROR), "setting comptroller failed"); | |
// Initialize block number and borrow index (block number mocks depend on comptroller being set) | |
accrualBlockNumber = getBlockNumber(); | |
borrowIndex = mantissaOne; | |
// Set the interest rate model (depends on block number / borrow index) | |
err = _setInterestRateModelFresh(interestRateModel_); | |
require(err == uint(Error.NO_ERROR), "setting interest rate model failed"); | |
name = name_; | |
symbol = symbol_; | |
decimals = decimals_; | |
// The counter starts true to prevent changing it from zero to non-zero (i.e. smaller cost/refund) | |
_notEntered = true; | |
} | |
/** | |
* @notice Transfer `tokens` tokens from `src` to `dst` by `spender` | |
* @dev Called by both `transfer` and `transferFrom` internally | |
* @param spender The address of the account performing the transfer | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param tokens The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferTokens(address spender, address src, address dst, uint tokens) internal returns (uint) { | |
/* Fail if transfer not allowed */ | |
uint allowed = comptroller.transferAllowed(address(this), src, dst, tokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.TRANSFER_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Do not allow self-transfers */ | |
if (src == dst) { | |
return fail(Error.BAD_INPUT, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
/* Get the allowance, infinite for the account owner */ | |
uint startingAllowance = 0; | |
if (spender == src) { | |
startingAllowance = uint(-1); | |
} else { | |
startingAllowance = transferAllowances[src][spender]; | |
} | |
/* Do the calculations, checking for {under,over}flow */ | |
MathError mathErr; | |
uint allowanceNew; | |
uint srvTokensNew; | |
uint dstTokensNew; | |
(mathErr, allowanceNew) = subUInt(startingAllowance, tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
(mathErr, srvTokensNew) = subUInt(accountTokens[src], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ENOUGH); | |
} | |
(mathErr, dstTokensNew) = addUInt(accountTokens[dst], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_TOO_MUCH); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
accountTokens[src] = srvTokensNew; | |
accountTokens[dst] = dstTokensNew; | |
/* Eat some of the allowance (if necessary) */ | |
if (startingAllowance != uint(-1)) { | |
transferAllowances[src][spender] = allowanceNew; | |
} | |
/* We emit a Transfer event */ | |
emit Transfer(src, dst, tokens); | |
comptroller.transferVerify(address(this), src, dst, tokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, msg.sender, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, src, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool) { | |
address src = msg.sender; | |
transferAllowances[src][spender] = amount; | |
emit Approval(src, spender, amount); | |
return true; | |
} | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256) { | |
return transferAllowances[owner][spender]; | |
} | |
/** | |
* @notice Get the token balance of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of tokens owned by `owner` | |
*/ | |
function balanceOf(address owner) external view returns (uint256) { | |
return accountTokens[owner]; | |
} | |
/** | |
* @notice Get the underlying balance of the `owner` | |
* @dev This also accrues interest in a transaction | |
* @param owner The address of the account to query | |
* @return The amount of underlying owned by `owner` | |
*/ | |
function balanceOfUnderlying(address owner) external returns (uint) { | |
Exp memory exchangeRate = Exp({mantissa: exchangeRateCurrent()}); | |
(MathError mErr, uint balance) = mulScalarTruncate(exchangeRate, accountTokens[owner]); | |
require(mErr == MathError.NO_ERROR, "balance could not be calculated"); | |
return balance; | |
} | |
/** | |
* @notice Get a snapshot of the account's balances, and the cached exchange rate | |
* @dev This is used by comptroller to more efficiently perform liquidity checks. | |
* @param account Address of the account to snapshot | |
* @return (possible error, token balance, borrow balance, exchange rate mantissa) | |
*/ | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { | |
uint vTokenBalance = accountTokens[account]; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
MathError mErr; | |
(mErr, borrowBalance) = borrowBalanceStoredInternal(account); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
(mErr, exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
return (uint(Error.NO_ERROR), vTokenBalance, borrowBalance, exchangeRateMantissa); | |
} | |
/** | |
* @dev Function to simply retrieve block number | |
* This exists mainly for inheriting test contracts to stub this result. | |
*/ | |
function getBlockNumber() internal view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Returns the current per-block borrow interest rate for this vToken | |
* @return The borrow interest rate per block, scaled by 1e18 | |
*/ | |
function borrowRatePerBlock() external view returns (uint) { | |
return interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
} | |
/** | |
* @notice Returns the current per-block supply interest rate for this vToken | |
* @return The supply interest rate per block, scaled by 1e18 | |
*/ | |
function supplyRatePerBlock() external view returns (uint) { | |
return interestRateModel.getSupplyRate(getCashPrior(), totalBorrows, totalReserves, reserveFactorMantissa); | |
} | |
/** | |
* @notice Returns the current total borrows plus accrued interest | |
* @return The total borrows with interest | |
*/ | |
function totalBorrowsCurrent() external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return totalBorrows; | |
} | |
/** | |
* @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex | |
* @param account The address whose balance should be calculated after updating borrowIndex | |
* @return The calculated balance | |
*/ | |
function borrowBalanceCurrent(address account) external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return borrowBalanceStored(account); | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return The calculated balance | |
*/ | |
function borrowBalanceStored(address account) public view returns (uint) { | |
(MathError err, uint result) = borrowBalanceStoredInternal(account); | |
require(err == MathError.NO_ERROR, "borrowBalanceStored: borrowBalanceStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return (error code, the calculated balance or 0 if error code is non-zero) | |
*/ | |
function borrowBalanceStoredInternal(address account) internal view returns (MathError, uint) { | |
/* Note: we do not assert that the market is up to date */ | |
MathError mathErr; | |
uint principalTimesIndex; | |
uint result; | |
/* Get borrowBalance and borrowIndex */ | |
BorrowSnapshot storage borrowSnapshot = accountBorrows[account]; | |
/* If borrowBalance = 0 then borrowIndex is likely also 0. | |
* Rather than failing the calculation with a division by 0, we immediately return 0 in this case. | |
*/ | |
if (borrowSnapshot.principal == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
/* Calculate new borrow balance using the interest index: | |
* recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex | |
*/ | |
(mathErr, principalTimesIndex) = mulUInt(borrowSnapshot.principal, borrowIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, result) = divUInt(principalTimesIndex, borrowSnapshot.interestIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, result); | |
} | |
/** | |
* @notice Accrue interest then return the up-to-date exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateCurrent() public nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return exchangeRateStored(); | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the VToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateStored() public view returns (uint) { | |
(MathError err, uint result) = exchangeRateStoredInternal(); | |
require(err == MathError.NO_ERROR, "exchangeRateStored: exchangeRateStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the VToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return (error code, calculated exchange rate scaled by 1e18) | |
*/ | |
function exchangeRateStoredInternal() internal view returns (MathError, uint) { | |
uint _totalSupply = totalSupply; | |
if (_totalSupply == 0) { | |
/* | |
* If there are no tokens minted: | |
* exchangeRate = initialExchangeRate | |
*/ | |
return (MathError.NO_ERROR, initialExchangeRateMantissa); | |
} else { | |
/* | |
* Otherwise: | |
* exchangeRate = (totalCash + totalBorrows - totalReserves) / totalSupply | |
*/ | |
uint totalCash = getCashPrior(); | |
uint cashPlusBorrowsMinusReserves; | |
Exp memory exchangeRate; | |
MathError mathErr; | |
(mathErr, cashPlusBorrowsMinusReserves) = addThenSubUInt(totalCash, totalBorrows, totalReserves); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, exchangeRate) = getExp(cashPlusBorrowsMinusReserves, _totalSupply); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, exchangeRate.mantissa); | |
} | |
} | |
/** | |
* @notice Get cash balance of this vToken in the underlying asset | |
* @return The quantity of underlying asset owned by this contract | |
*/ | |
function getCash() external view returns (uint) { | |
return getCashPrior(); | |
} | |
/** | |
* @notice Applies accrued interest to total borrows and reserves | |
* @dev This calculates interest accrued from the last checkpointed block | |
* up to the current block and writes new checkpoint to storage. | |
*/ | |
function accrueInterest() public returns (uint) { | |
/* Remember the initial block number */ | |
uint currentBlockNumber = getBlockNumber(); | |
uint accrualBlockNumberPrior = accrualBlockNumber; | |
/* Short-circuit accumulating 0 interest */ | |
if (accrualBlockNumberPrior == currentBlockNumber) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Read the previous values out of storage */ | |
uint cashPrior = getCashPrior(); | |
uint borrowsPrior = totalBorrows; | |
uint reservesPrior = totalReserves; | |
uint borrowIndexPrior = borrowIndex; | |
/* Calculate the current borrow interest rate */ | |
uint borrowRateMantissa = interestRateModel.getBorrowRate(cashPrior, borrowsPrior, reservesPrior); | |
require(borrowRateMantissa <= borrowRateMaxMantissa, "borrow rate is absurdly high"); | |
/* Calculate the number of blocks elapsed since the last accrual */ | |
(MathError mathErr, uint blockDelta) = subUInt(currentBlockNumber, accrualBlockNumberPrior); | |
require(mathErr == MathError.NO_ERROR, "could not calculate block delta"); | |
/* | |
* Calculate the interest accumulated into borrows and reserves and the new index: | |
* simpleInterestFactor = borrowRate * blockDelta | |
* interestAccumulated = simpleInterestFactor * totalBorrows | |
* totalBorrowsNew = interestAccumulated + totalBorrows | |
* totalReservesNew = interestAccumulated * reserveFactor + totalReserves | |
* borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex | |
*/ | |
Exp memory simpleInterestFactor; | |
uint interestAccumulated; | |
uint totalBorrowsNew; | |
uint totalReservesNew; | |
uint borrowIndexNew; | |
(mathErr, simpleInterestFactor) = mulScalar(Exp({mantissa: borrowRateMantissa}), blockDelta); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, interestAccumulated) = mulScalarTruncate(simpleInterestFactor, borrowsPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, totalBorrowsNew) = addUInt(interestAccumulated, borrowsPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, totalReservesNew) = mulScalarTruncateAddUInt(Exp({mantissa: reserveFactorMantissa}), interestAccumulated, reservesPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, borrowIndexNew) = mulScalarTruncateAddUInt(simpleInterestFactor, borrowIndexPrior, borrowIndexPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, uint(mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accrualBlockNumber = currentBlockNumber; | |
borrowIndex = borrowIndexNew; | |
totalBorrows = totalBorrowsNew; | |
totalReserves = totalReservesNew; | |
/* We emit an AccrueInterest event */ | |
emit AccrueInterest(cashPrior, interestAccumulated, borrowIndexNew, totalBorrowsNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender supplies assets into the market and receives vTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. | |
*/ | |
function mintInternal(uint mintAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.MINT_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// mintFresh emits the actual Mint event if successful and logs on errors, so we don't need to | |
return mintFresh(msg.sender, mintAmount); | |
} | |
struct MintLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint mintTokens; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
uint actualMintAmount; | |
} | |
/** | |
* @notice User supplies assets into the market and receives vTokens in exchange | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param minter The address of the account which is supplying the assets | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. | |
*/ | |
function mintFresh(address minter, uint mintAmount) internal returns (uint, uint) { | |
/* Fail if mint not allowed */ | |
uint allowed = comptroller.mintAllowed(address(this), minter, mintAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.MINT_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.MINT_FRESHNESS_CHECK), 0); | |
} | |
MintLocalVars memory vars; | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return (failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)), 0); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call `doTransferIn` for the minter and the mintAmount. | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* `doTransferIn` reverts if anything goes wrong, since we can't be sure if | |
* side-effects occurred. The function returns the amount actually transferred, | |
* in case of a fee. On success, the vToken holds an additional `actualMintAmount` | |
* of cash. | |
*/ | |
vars.actualMintAmount = doTransferIn(minter, mintAmount); | |
/* | |
* We get the current exchange rate and calculate the number of vTokens to be minted: | |
* mintTokens = actualMintAmount / exchangeRate | |
*/ | |
(vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(vars.actualMintAmount, Exp({mantissa: vars.exchangeRateMantissa})); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_EXCHANGE_CALCULATION_FAILED"); | |
/* | |
* We calculate the new total supply of vTokens and minter token balance, checking for overflow: | |
* totalSupplyNew = totalSupply + mintTokens | |
* accountTokensNew = accountTokens[minter] + mintTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = addUInt(totalSupply, vars.mintTokens); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED"); | |
(vars.mathErr, vars.accountTokensNew) = addUInt(accountTokens[minter], vars.mintTokens); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED"); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[minter] = vars.accountTokensNew; | |
/* We emit a Mint event, and a Transfer event */ | |
emit Mint(minter, vars.actualMintAmount, vars.mintTokens); | |
emit Transfer(address(this), minter, vars.mintTokens); | |
/* We call the defense hook */ | |
comptroller.mintVerify(address(this), minter, vars.actualMintAmount, vars.mintTokens); | |
return (uint(Error.NO_ERROR), vars.actualMintAmount); | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of vTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemInternal(uint redeemTokens) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, redeemTokens, 0); | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to receive from redeeming vTokens | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlyingInternal(uint redeemAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, 0, redeemAmount); | |
} | |
struct RedeemLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint redeemTokens; | |
uint redeemAmount; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
} | |
/** | |
* @notice User redeems vTokens in exchange for the underlying asset | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param redeemer The address of the account which is redeeming the tokens | |
* @param redeemTokensIn The number of vTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @param redeemAmountIn The number of underlying tokens to receive from redeeming vTokens (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemFresh(address payable redeemer, uint redeemTokensIn, uint redeemAmountIn) internal returns (uint) { | |
require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero"); | |
RedeemLocalVars memory vars; | |
/* exchangeRate = invoke Exchange Rate Stored() */ | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); | |
} | |
/* If redeemTokensIn > 0: */ | |
if (redeemTokensIn > 0) { | |
/* | |
* We calculate the exchange rate and the amount of underlying to be redeemed: | |
* redeemTokens = redeemTokensIn | |
* redeemAmount = redeemTokensIn x exchangeRateCurrent | |
*/ | |
vars.redeemTokens = redeemTokensIn; | |
(vars.mathErr, vars.redeemAmount) = mulScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), redeemTokensIn); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
} else { | |
/* | |
* We get the current exchange rate and calculate the amount to be redeemed: | |
* redeemTokens = redeemAmountIn / exchangeRate | |
* redeemAmount = redeemAmountIn | |
*/ | |
(vars.mathErr, vars.redeemTokens) = divScalarByExpTruncate(redeemAmountIn, Exp({mantissa: vars.exchangeRateMantissa})); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
vars.redeemAmount = redeemAmountIn; | |
} | |
/* Fail if redeem not allowed */ | |
uint allowed = comptroller.redeemAllowed(address(this), redeemer, vars.redeemTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REDEEM_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDEEM_FRESHNESS_CHECK); | |
} | |
/* | |
* We calculate the new total supply and redeemer balance, checking for underflow: | |
* totalSupplyNew = totalSupply - redeemTokens | |
* accountTokensNew = accountTokens[redeemer] - redeemTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = subUInt(totalSupply, vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountTokensNew) = subUInt(accountTokens[redeemer], vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* Fail gracefully if protocol has insufficient cash */ | |
if (getCashPrior() < vars.redeemAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDEEM_TRANSFER_OUT_NOT_POSSIBLE); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the redeemer and the redeemAmount. | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken has redeemAmount less of cash. | |
* doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
*/ | |
doTransferOut(redeemer, vars.redeemAmount); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[redeemer] = vars.accountTokensNew; | |
/* We emit a Transfer event, and a Redeem event */ | |
emit Transfer(redeemer, address(this), vars.redeemTokens); | |
emit Redeem(redeemer, vars.redeemAmount, vars.redeemTokens); | |
/* We call the defense hook */ | |
comptroller.redeemVerify(address(this), redeemer, vars.redeemAmount, vars.redeemTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowInternal(uint borrowAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.BORROW_ACCRUE_INTEREST_FAILED); | |
} | |
// borrowFresh emits borrow-specific logs on errors, so we don't need to | |
return borrowFresh(msg.sender, borrowAmount); | |
} | |
struct BorrowLocalVars { | |
MathError mathErr; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
} | |
/** | |
* @notice Users borrow assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowFresh(address payable borrower, uint borrowAmount) internal returns (uint) { | |
/* Fail if borrow not allowed */ | |
uint allowed = comptroller.borrowAllowed(address(this), borrower, borrowAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.BORROW_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.BORROW_FRESHNESS_CHECK); | |
} | |
/* Fail gracefully if protocol has insufficient underlying cash */ | |
if (getCashPrior() < borrowAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.BORROW_CASH_NOT_AVAILABLE); | |
} | |
BorrowLocalVars memory vars; | |
/* | |
* We calculate the new borrower and total borrow balances, failing on overflow: | |
* accountBorrowsNew = accountBorrows + borrowAmount | |
* totalBorrowsNew = totalBorrows + borrowAmount | |
*/ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountBorrowsNew) = addUInt(vars.accountBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = addUInt(totalBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the borrower and the borrowAmount. | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken borrowAmount less of cash. | |
* doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
*/ | |
doTransferOut(borrower, borrowAmount); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a Borrow event */ | |
emit Borrow(borrower, borrowAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.borrowVerify(address(this), borrower, borrowAmount); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowInternal(uint repayAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.REPAY_BORROW_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, msg.sender, repayAmount); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowBehalfInternal(address borrower, uint repayAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.REPAY_BEHALF_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, borrower, repayAmount); | |
} | |
struct RepayBorrowLocalVars { | |
Error err; | |
MathError mathErr; | |
uint repayAmount; | |
uint borrowerIndex; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
uint actualRepayAmount; | |
} | |
/** | |
* @notice Borrows are repaid by another user (possibly the borrower). | |
* @param payer the account paying off the borrow | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount the amount of undelrying tokens being returned | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowFresh(address payer, address borrower, uint repayAmount) internal returns (uint, uint) { | |
/* Fail if repayBorrow not allowed */ | |
uint allowed = comptroller.repayBorrowAllowed(address(this), payer, borrower, repayAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REPAY_BORROW_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.REPAY_BORROW_FRESHNESS_CHECK), 0); | |
} | |
RepayBorrowLocalVars memory vars; | |
/* We remember the original borrowerIndex for verification purposes */ | |
vars.borrowerIndex = accountBorrows[borrower].interestIndex; | |
/* We fetch the amount the borrower owes, with accumulated interest */ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return (failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)), 0); | |
} | |
/* If repayAmount == -1, repayAmount = accountBorrows */ | |
if (repayAmount == uint(-1)) { | |
vars.repayAmount = vars.accountBorrows; | |
} else { | |
vars.repayAmount = repayAmount; | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the payer and the repayAmount | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken holds an additional repayAmount of cash. | |
* doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
* it returns the amount actually transferred, in case of a fee. | |
*/ | |
vars.actualRepayAmount = doTransferIn(payer, vars.repayAmount); | |
/* | |
* We calculate the new borrower and total borrow balances, failing on underflow: | |
* accountBorrowsNew = accountBorrows - actualRepayAmount | |
* totalBorrowsNew = totalBorrows - actualRepayAmount | |
*/ | |
(vars.mathErr, vars.accountBorrowsNew) = subUInt(vars.accountBorrows, vars.actualRepayAmount); | |
require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED"); | |
(vars.mathErr, vars.totalBorrowsNew) = subUInt(totalBorrows, vars.actualRepayAmount); | |
require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED"); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a RepayBorrow event */ | |
emit RepayBorrow(payer, borrower, vars.actualRepayAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.repayBorrowVerify(address(this), payer, borrower, vars.actualRepayAmount, vars.borrowerIndex); | |
return (uint(Error.NO_ERROR), vars.actualRepayAmount); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this vToken to be liquidated | |
* @param vTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function liquidateBorrowInternal(address borrower, uint repayAmount, VTokenInterface vTokenCollateral) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED), 0); | |
} | |
error = vTokenCollateral.accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED), 0); | |
} | |
// liquidateBorrowFresh emits borrow-specific logs on errors, so we don't need to | |
return liquidateBorrowFresh(msg.sender, borrower, repayAmount, vTokenCollateral); | |
} | |
/** | |
* @notice The liquidator liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this vToken to be liquidated | |
* @param liquidator The address repaying the borrow and seizing collateral | |
* @param vTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function liquidateBorrowFresh(address liquidator, address borrower, uint repayAmount, VTokenInterface vTokenCollateral) internal returns (uint, uint) { | |
/* Fail if liquidate not allowed */ | |
uint allowed = comptroller.liquidateBorrowAllowed(address(this), address(vTokenCollateral), liquidator, borrower, repayAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_FRESHNESS_CHECK), 0); | |
} | |
/* Verify vTokenCollateral market's block number equals current block number */ | |
if (vTokenCollateral.accrualBlockNumber() != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_COLLATERAL_FRESHNESS_CHECK), 0); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return (fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_LIQUIDATOR_IS_BORROWER), 0); | |
} | |
/* Fail if repayAmount = 0 */ | |
if (repayAmount == 0) { | |
return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_ZERO), 0); | |
} | |
/* Fail if repayAmount = -1 */ | |
if (repayAmount == uint(-1)) { | |
return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX), 0); | |
} | |
/* Fail if repayBorrow fails */ | |
(uint repayBorrowError, uint actualRepayAmount) = repayBorrowFresh(liquidator, borrower, repayAmount); | |
if (repayBorrowError != uint(Error.NO_ERROR)) { | |
return (fail(Error(repayBorrowError), FailureInfo.LIQUIDATE_REPAY_BORROW_FRESH_FAILED), 0); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We calculate the number of collateral tokens that will be seized */ | |
(uint amountSeizeError, uint seizeTokens) = comptroller.liquidateCalculateSeizeTokens(address(this), address(vTokenCollateral), actualRepayAmount); | |
require(amountSeizeError == uint(Error.NO_ERROR), "LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED"); | |
/* Revert if borrower collateral token balance < seizeTokens */ | |
require(vTokenCollateral.balanceOf(borrower) >= seizeTokens, "LIQUIDATE_SEIZE_TOO_MUCH"); | |
// If this is also the collateral, run seizeInternal to avoid re-entrancy, otherwise make an external call | |
uint seizeError; | |
if (address(vTokenCollateral) == address(this)) { | |
seizeError = seizeInternal(address(this), liquidator, borrower, seizeTokens); | |
} else { | |
seizeError = vTokenCollateral.seize(liquidator, borrower, seizeTokens); | |
} | |
/* Revert if seize tokens fails (since we cannot be sure of side effects) */ | |
require(seizeError == uint(Error.NO_ERROR), "token seizure failed"); | |
/* We emit a LiquidateBorrow event */ | |
emit LiquidateBorrow(liquidator, borrower, actualRepayAmount, address(vTokenCollateral), seizeTokens); | |
/* We call the defense hook */ | |
comptroller.liquidateBorrowVerify(address(this), address(vTokenCollateral), liquidator, borrower, actualRepayAmount, seizeTokens); | |
return (uint(Error.NO_ERROR), actualRepayAmount); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Will fail unless called by another vToken during the process of liquidation. | |
* Its absolutely critical to use msg.sender as the borrowed vToken and not a parameter. | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of vTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seize(address liquidator, address borrower, uint seizeTokens) external nonReentrant returns (uint) { | |
return seizeInternal(msg.sender, liquidator, borrower, seizeTokens); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Called only during an in-kind liquidation, or by liquidateBorrow during the liquidation of another VToken. | |
* Its absolutely critical to use msg.sender as the seizer vToken and not a parameter. | |
* @param seizerToken The contract seizing the collateral (i.e. borrowed vToken) | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of vTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seizeInternal(address seizerToken, address liquidator, address borrower, uint seizeTokens) internal returns (uint) { | |
/* Fail if seize not allowed */ | |
uint allowed = comptroller.seizeAllowed(address(this), seizerToken, liquidator, borrower, seizeTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER); | |
} | |
MathError mathErr; | |
uint borrowerTokensNew; | |
uint liquidatorTokensNew; | |
/* | |
* We calculate the new borrower and liquidator token balances, failing on underflow/overflow: | |
* borrowerTokensNew = accountTokens[borrower] - seizeTokens | |
* liquidatorTokensNew = accountTokens[liquidator] + seizeTokens | |
*/ | |
(mathErr, borrowerTokensNew) = subUInt(accountTokens[borrower], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, uint(mathErr)); | |
} | |
(mathErr, liquidatorTokensNew) = addUInt(accountTokens[liquidator], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, uint(mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accountTokens[borrower] = borrowerTokensNew; | |
accountTokens[liquidator] = liquidatorTokensNew; | |
/* Emit a Transfer event */ | |
emit Transfer(borrower, liquidator, seizeTokens); | |
/* We call the defense hook */ | |
comptroller.seizeVerify(address(this), seizerToken, liquidator, borrower, seizeTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() external returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets a new comptroller for the market | |
* @dev Admin function to set a new comptroller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); | |
} | |
ComptrollerInterface oldComptroller = comptroller; | |
// Ensure invoke comptroller.isComptroller() returns true | |
require(newComptroller.isComptroller(), "marker method returned false"); | |
// Set market's comptroller to newComptroller | |
comptroller = newComptroller; | |
// Emit NewComptroller(oldComptroller, newComptroller) | |
emit NewComptroller(oldComptroller, newComptroller); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh | |
* @dev Admin function to accrue interest and set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactor(uint newReserveFactorMantissa) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reserve factor change failed. | |
return fail(Error(error), FailureInfo.SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED); | |
} | |
// _setReserveFactorFresh emits reserve-factor-specific logs on errors, so we don't need to. | |
return _setReserveFactorFresh(newReserveFactorMantissa); | |
} | |
/** | |
* @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual) | |
* @dev Admin function to set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactorFresh(uint newReserveFactorMantissa) internal returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_RESERVE_FACTOR_ADMIN_CHECK); | |
} | |
// Verify market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_RESERVE_FACTOR_FRESH_CHECK); | |
} | |
// Check newReserveFactor ≤ maxReserveFactor | |
if (newReserveFactorMantissa > reserveFactorMaxMantissa) { | |
return fail(Error.BAD_INPUT, FailureInfo.SET_RESERVE_FACTOR_BOUNDS_CHECK); | |
} | |
uint oldReserveFactorMantissa = reserveFactorMantissa; | |
reserveFactorMantissa = newReserveFactorMantissa; | |
emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring from msg.sender | |
* @param addAmount Amount of addition to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _addReservesInternal(uint addAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.ADD_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _addReservesFresh emits reserve-addition-specific logs on errors, so we don't need to. | |
(error, ) = _addReservesFresh(addAmount); | |
return error; | |
} | |
/** | |
* @notice Add reserves by transferring from caller | |
* @dev Requires fresh interest accrual | |
* @param addAmount Amount of addition to reserves | |
* @return (uint, uint) An error code (0=success, otherwise a failure (see ErrorReporter.sol for details)) and the actual amount added, net token fees | |
*/ | |
function _addReservesFresh(uint addAmount) internal returns (uint, uint) { | |
// totalReserves + actualAddAmount | |
uint totalReservesNew; | |
uint actualAddAmount; | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.ADD_RESERVES_FRESH_CHECK), actualAddAmount); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the caller and the addAmount | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken holds an additional addAmount of cash. | |
* doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
* it returns the amount actually transferred, in case of a fee. | |
*/ | |
actualAddAmount = doTransferIn(msg.sender, addAmount); | |
totalReservesNew = totalReserves + actualAddAmount; | |
/* Revert on overflow */ | |
require(totalReservesNew >= totalReserves, "add reserves unexpected overflow"); | |
// Store reserves[n+1] = reserves[n] + actualAddAmount | |
totalReserves = totalReservesNew; | |
/* Emit NewReserves(admin, actualAddAmount, reserves[n+1]) */ | |
emit ReservesAdded(msg.sender, actualAddAmount, totalReservesNew); | |
/* Return (NO_ERROR, actualAddAmount) */ | |
return (uint(Error.NO_ERROR), actualAddAmount); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring to admin | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReserves(uint reduceAmount) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.REDUCE_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _reduceReservesFresh emits reserve-reduction-specific logs on errors, so we don't need to. | |
return _reduceReservesFresh(reduceAmount); | |
} | |
/** | |
* @notice Reduces reserves by transferring to admin | |
* @dev Requires fresh interest accrual | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReservesFresh(uint reduceAmount) internal returns (uint) { | |
// totalReserves - reduceAmount | |
uint totalReservesNew; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.REDUCE_RESERVES_ADMIN_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDUCE_RESERVES_FRESH_CHECK); | |
} | |
// Fail gracefully if protocol has insufficient underlying cash | |
if (getCashPrior() < reduceAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDUCE_RESERVES_CASH_NOT_AVAILABLE); | |
} | |
// Check reduceAmount ≤ reserves[n] (totalReserves) | |
if (reduceAmount > totalReserves) { | |
return fail(Error.BAD_INPUT, FailureInfo.REDUCE_RESERVES_VALIDATION); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
totalReservesNew = totalReserves - reduceAmount; | |
// We checked reduceAmount <= totalReserves above, so this should never revert. | |
require(totalReservesNew <= totalReserves, "reduce reserves unexpected underflow"); | |
// Store reserves[n+1] = reserves[n] - reduceAmount | |
totalReserves = totalReservesNew; | |
// doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
doTransferOut(admin, reduceAmount); | |
emit ReservesReduced(admin, reduceAmount, totalReservesNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and updates the interest rate model using _setInterestRateModelFresh | |
* @dev Admin function to accrue interest and update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted change of interest rate model failed | |
return fail(Error(error), FailureInfo.SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED); | |
} | |
// _setInterestRateModelFresh emits interest-rate-model-update-specific logs on errors, so we don't need to. | |
return _setInterestRateModelFresh(newInterestRateModel); | |
} | |
/** | |
* @notice updates the interest rate model (*requires fresh interest accrual) | |
* @dev Admin function to update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal returns (uint) { | |
// Used to store old model for use in the event that is emitted on success | |
InterestRateModel oldInterestRateModel; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_INTEREST_RATE_MODEL_OWNER_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_INTEREST_RATE_MODEL_FRESH_CHECK); | |
} | |
// Track the market's current interest rate model | |
oldInterestRateModel = interestRateModel; | |
// Ensure invoke newInterestRateModel.isInterestRateModel() returns true | |
require(newInterestRateModel.isInterestRateModel(), "marker method returned false"); | |
// Set the interest rate model to newInterestRateModel | |
interestRateModel = newInterestRateModel; | |
// Emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel) | |
emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint); | |
/** | |
* @dev Performs a transfer in, reverting upon failure. Returns the amount actually transferred to the protocol, in case of a fee. | |
* This may revert due to insufficient balance or insufficient allowance. | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (uint); | |
/** | |
* @dev Performs a transfer out, ideally returning an explanatory error code upon failure tather than reverting. | |
* If caller has not called checked protocol's balance, may revert due to insufficient cash held in the contract. | |
* If caller has checked protocol's balance, and verified it is >= amount, this should not revert in normal conditions. | |
*/ | |
function doTransferOut(address payable to, uint amount) internal; | |
/*** Reentrancy Guard ***/ | |
/** | |
* @dev Prevents a contract from calling itself, directly or indirectly. | |
*/ | |
modifier nonReentrant() { | |
require(_notEntered, "re-entered"); | |
_notEntered = false; | |
_; | |
_notEntered = true; // get a gas-refund post-Istanbul | |
} | |
} | |
// File: PriceOracle.sol | |
pragma solidity ^0.5.16; | |
contract PriceOracle { | |
/// @notice Indicator that this is a PriceOracle contract (for inspection) | |
bool public constant isPriceOracle = true; | |
/** | |
* @notice Get the underlying price of a vToken asset | |
* @param vToken The vToken to get the underlying price of | |
* @return The underlying asset price mantissa (scaled by 1e18). | |
* Zero means the price is unavailable. | |
*/ | |
function getUnderlyingPrice(VToken vToken) external view returns (uint); | |
} | |
// File: VBep20.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Venus's VBep20 Contract | |
* @notice VTokens which wrap an EIP-20 underlying | |
* @author Venus | |
*/ | |
contract VBep20 is VToken, VBep20Interface { | |
/** | |
* @notice Initialize the new money market | |
* @param underlying_ The address of the underlying asset | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ BEP-20 name of this token | |
* @param symbol_ BEP-20 symbol of this token | |
* @param decimals_ BEP-20 decimal precision of this token | |
*/ | |
function initialize(address underlying_, | |
ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_) public { | |
// VToken initialize does the bulk of the work | |
super.initialize(comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_); | |
// Set underlying and sanity check it | |
underlying = underlying_; | |
EIP20Interface(underlying).totalSupply(); | |
} | |
/*** User Interface ***/ | |
/** | |
* @notice Sender supplies assets into the market and receives vTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mint(uint mintAmount) external returns (uint) { | |
(uint err,) = mintInternal(mintAmount); | |
return err; | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of vTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeem(uint redeemTokens) external returns (uint) { | |
return redeemInternal(redeemTokens); | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to redeem | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlying(uint redeemAmount) external returns (uint) { | |
return redeemUnderlyingInternal(redeemAmount); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrow(uint borrowAmount) external returns (uint) { | |
return borrowInternal(borrowAmount); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrow(uint repayAmount) external returns (uint) { | |
(uint err,) = repayBorrowInternal(repayAmount); | |
return err; | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint) { | |
(uint err,) = repayBorrowBehalfInternal(borrower, repayAmount); | |
return err; | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this vToken to be liquidated | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @param vTokenCollateral The market in which to seize collateral from the borrower | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrow(address borrower, uint repayAmount, VTokenInterface vTokenCollateral) external returns (uint) { | |
(uint err,) = liquidateBorrowInternal(borrower, repayAmount, vTokenCollateral); | |
return err; | |
} | |
/** | |
* @notice The sender adds to reserves. | |
* @param addAmount The amount fo underlying token to add as reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _addReserves(uint addAmount) external returns (uint) { | |
return _addReservesInternal(addAmount); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying tokens owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint) { | |
EIP20Interface token = EIP20Interface(underlying); | |
return token.balanceOf(address(this)); | |
} | |
/** | |
* @dev Similar to EIP20 transfer, except it handles a False result from `transferFrom` and reverts in that case. | |
* This will revert due to insufficient balance or insufficient allowance. | |
* This function returns the actual amount received, | |
* which may be less than `amount` if there is a fee attached to the transfer. | |
* | |
* Note: This wrapper safely handles non-standard BEP-20 tokens that do not return a value. | |
* See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (uint) { | |
EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); | |
uint balanceBefore = EIP20Interface(underlying).balanceOf(address(this)); | |
token.transferFrom(from, address(this), amount); | |
bool success; | |
assembly { | |
switch returndatasize() | |
case 0 { // This is a non-standard BEP-20 | |
success := not(0) // set success to true | |
} | |
case 32 { // This is a compliant BEP-20 | |
returndatacopy(0, 0, 32) | |
success := mload(0) // Set `success = returndata` of external call | |
} | |
default { // This is an excessively non-compliant BEP-20, revert. | |
revert(0, 0) | |
} | |
} | |
require(success, "TOKEN_TRANSFER_IN_FAILED"); | |
// Calculate the amount that was *actually* transferred | |
uint balanceAfter = EIP20Interface(underlying).balanceOf(address(this)); | |
require(balanceAfter >= balanceBefore, "TOKEN_TRANSFER_IN_OVERFLOW"); | |
return balanceAfter - balanceBefore; // underflow already checked above, just subtract | |
} | |
/** | |
* @dev Similar to EIP20 transfer, except it handles a False success from `transfer` and returns an explanatory | |
* error code rather than reverting. If caller has not called checked protocol's balance, this may revert due to | |
* insufficient cash held in this contract. If caller has checked protocol's balance prior to this call, and verified | |
* it is >= amount, this should not revert in normal conditions. | |
* | |
* Note: This wrapper safely handles non-standard BEP-20 tokens that do not return a value. | |
* See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
function doTransferOut(address payable to, uint amount) internal { | |
EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); | |
token.transfer(to, amount); | |
bool success; | |
assembly { | |
switch returndatasize() | |
case 0 { // This is a non-standard BEP-20 | |
success := not(0) // set success to true | |
} | |
case 32 { // This is a complaint BEP-20 | |
returndatacopy(0, 0, 32) | |
success := mload(0) // Set `success = returndata` of external call | |
} | |
default { // This is an excessively non-compliant BEP-20, revert. | |
revert(0, 0) | |
} | |
} | |
require(success, "TOKEN_TRANSFER_OUT_FAILED"); | |
} | |
} | |
// File: BEP20Interface.sol | |
pragma solidity ^0.5.16; | |
interface BEP20Interface { | |
/** | |
* @dev Returns the amount of tokens in existence. | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @dev Returns the token decimals. | |
*/ | |
function decimals() external view returns (uint8); | |
/** | |
* @dev Returns the token symbol. | |
*/ | |
function symbol() external view returns (string memory); | |
/** | |
* @dev Returns the token name. | |
*/ | |
function name() external view returns (string memory); | |
/** | |
* @dev Returns the bep token owner. | |
*/ | |
function getOwner() external view returns (address); | |
/** | |
* @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 `recipient`. | |
* | |
* Returns a boolean value indicating whether the operation succeeded. | |
* | |
* Emits a {Transfer} event. | |
*/ | |
function transfer(address recipient, 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 `sender` to `recipient` 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 sender, address recipient, uint256 amount) external returns (bool); | |
/** | |
* @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); | |
} | |
// File: SafeMath.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @dev Wrappers over Solidity's arithmetic operations with added overflow | |
* checks. | |
* | |
* Arithmetic operations in Solidity wrap on overflow. This can easily result | |
* in bugs, because programmers usually assume that an overflow raises an | |
* error, which is the standard behavior in high level programming languages. | |
* `SafeMath` restores this intuition by reverting the transaction when an | |
* operation overflows. | |
* | |
* Using this library instead of the unchecked operations eliminates an entire | |
* class of bugs, so it's recommended to use it always. | |
*/ | |
library SafeMath { | |
/** | |
* @dev Returns the addition of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `+` operator. | |
* | |
* Requirements: | |
* - Addition cannot overflow. | |
*/ | |
function add(uint256 a, uint256 b) internal pure returns (uint256) { | |
return add(a, b, "SafeMath: addition overflow"); | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* - Subtraction cannot overflow. | |
*/ | |
function add(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
uint256 c = a + b; | |
require(c >= a, errorMessage); | |
return c; | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b) internal pure returns (uint256) { | |
return sub(a, b, "SafeMath: subtraction overflow"); | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b <= a, errorMessage); | |
uint256 c = a - b; | |
return c; | |
} | |
/** | |
* @dev Returns the multiplication of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `*` operator. | |
* | |
* Requirements: | |
* - Multiplication cannot overflow. | |
*/ | |
function mul(uint256 a, uint256 b) internal pure returns (uint256) { | |
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the | |
// benefit is lost if 'b' is also tested. | |
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 | |
if (a == 0) { | |
return 0; | |
} | |
uint256 c = a * b; | |
require(c / a == b, "SafeMath: multiplication overflow"); | |
return c; | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b) internal pure returns (uint256) { | |
return div(a, b, "SafeMath: division by zero"); | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts with custom message on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
// Solidity only automatically asserts when dividing by 0 | |
require(b > 0, errorMessage); | |
uint256 c = a / b; | |
// assert(a == b * c + a % b); // There is no case in which this doesn't hold | |
return c; | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b) internal pure returns (uint256) { | |
return mod(a, b, "SafeMath: modulo by zero"); | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts with custom message when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b != 0, errorMessage); | |
return a % b; | |
} | |
} | |
// File: AggregatorV2V3Interface.sol | |
pragma solidity >=0.5.0; | |
/** | |
* @title The V2 & V3 Aggregator Interface | |
* @notice Solidity V0.5 does not allow interfaces to inherit from other | |
* interfaces so this contract is a combination of v0.5 AggregatorInterface.sol | |
* and v0.5 AggregatorV3Interface.sol. | |
*/ | |
interface AggregatorV2V3Interface { | |
// | |
// V2 Interface: | |
// | |
function latestAnswer() external view returns (int256); | |
function latestTimestamp() external view returns (uint256); | |
function latestRound() external view returns (uint256); | |
function getAnswer(uint256 roundId) external view returns (int256); | |
function getTimestamp(uint256 roundId) external view returns (uint256); | |
event AnswerUpdated(int256 indexed current, uint256 indexed roundId, uint256 timestamp); | |
event NewRound(uint256 indexed roundId, address indexed startedBy, uint256 startedAt); | |
// | |
// V3 Interface: | |
// | |
function decimals() external view returns (uint8); | |
function description() external view returns (string memory); | |
function version() external view returns (uint256); | |
// getRoundData and latestRoundData should both raise "No data present" | |
// if they do not have data to report, instead of returning unset values | |
// which could be misinterpreted as actual reported values. | |
function getRoundData(uint80 _roundId) | |
external | |
view | |
returns ( | |
uint80 roundId, | |
int256 answer, | |
uint256 startedAt, | |
uint256 updatedAt, | |
uint80 answeredInRound | |
); | |
function latestRoundData() | |
external | |
view | |
returns ( | |
uint80 roundId, | |
int256 answer, | |
uint256 startedAt, | |
uint256 updatedAt, | |
uint80 answeredInRound | |
); | |
} | |
// File: VenusChainlinkOracle.sol | |
pragma solidity 0.5.16; | |
contract VenusChainlinkOracle is PriceOracle { | |
using SafeMath for uint; | |
uint public constant VAI_VALUE = 1e18; | |
address public admin; | |
mapping(address => uint) internal prices; | |
mapping(bytes32 => AggregatorV2V3Interface) internal feeds; | |
event PricePosted(address asset, uint previousPriceMantissa, uint requestedPriceMantissa, uint newPriceMantissa); | |
event NewAdmin(address oldAdmin, address newAdmin); | |
event FeedSet(address feed, string symbol); | |
constructor() public { | |
admin = msg.sender; | |
} | |
function getUnderlyingPrice(VToken vToken) public view returns (uint) { | |
string memory symbol = vToken.symbol(); | |
if (compareStrings(symbol, "vBNB")) { | |
return getChainlinkPrice(getFeed(symbol)); | |
} else if (compareStrings(symbol, "VAI")) { | |
return VAI_VALUE; | |
} else if (compareStrings(symbol, "XVS")) { | |
return prices[address(vToken)]; | |
} else { | |
return getPrice(vToken); | |
} | |
} | |
function getPrice(VToken vToken) internal view returns (uint price) { | |
BEP20Interface token = BEP20Interface(VBep20(address(vToken)).underlying()); | |
if (prices[address(token)] != 0) { | |
price = prices[address(token)]; | |
} else { | |
price = getChainlinkPrice(getFeed(token.symbol())); | |
} | |
uint decimalDelta = uint(18).sub(uint(token.decimals())); | |
// Ensure that we don't multiply the result by 0 | |
if (decimalDelta > 0) { | |
return price.mul(10**decimalDelta); | |
} else { | |
return price; | |
} | |
} | |
function getChainlinkPrice(AggregatorV2V3Interface feed) internal view returns (uint) { | |
// Chainlink USD-denominated feeds store answers at 8 decimals | |
uint decimalDelta = uint(18).sub(feed.decimals()); | |
// Ensure that we don't multiply the result by 0 | |
if (decimalDelta > 0) { | |
return uint(feed.latestAnswer()).mul(10**decimalDelta); | |
} else { | |
return uint(feed.latestAnswer()); | |
} | |
} | |
function setUnderlyingPrice(VToken vToken, uint underlyingPriceMantissa) external onlyAdmin() { | |
address asset = address(VBep20(address(vToken)).underlying()); | |
emit PricePosted(asset, prices[asset], underlyingPriceMantissa, underlyingPriceMantissa); | |
prices[asset] = underlyingPriceMantissa; | |
} | |
function setDirectPrice(address asset, uint price) external onlyAdmin() { | |
emit PricePosted(asset, prices[asset], price, price); | |
prices[asset] = price; | |
} | |
function setFeed(string calldata symbol, address feed) external onlyAdmin() { | |
require(feed != address(0) && feed != address(this), "invalid feed address"); | |
emit FeedSet(feed, symbol); | |
feeds[keccak256(abi.encodePacked(symbol))] = AggregatorV2V3Interface(feed); | |
} | |
function getFeed(string memory symbol) public view returns (AggregatorV2V3Interface) { | |
return feeds[keccak256(abi.encodePacked(symbol))]; | |
} | |
function assetPrices(address asset) external view returns (uint) { | |
return prices[asset]; | |
} | |
function compareStrings(string memory a, string memory b) internal pure returns (bool) { | |
return (keccak256(abi.encodePacked((a))) == keccak256(abi.encodePacked((b)))); | |
} | |
function setAdmin(address newAdmin) external onlyAdmin() { | |
address oldAdmin = admin; | |
admin = newAdmin; | |
emit NewAdmin(oldAdmin, newAdmin); | |
} | |
modifier onlyAdmin() { | |
require(msg.sender == admin, "only admin may call"); | |
_; | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// address 0x290af388Eca91d27C18D85C60A002053d2eE6927 | |
/** | |
*Submitted for verification at Etherscan.io on 2019-10-11 | |
*/ | |
// File: contracts/ComptrollerInterface.sol | |
pragma solidity ^0.5.8; | |
interface ComptrollerInterface { | |
/** | |
* @notice Marker function used for light validation when updating the comptroller of a market | |
* @dev Implementations should simply return true. | |
* @return true | |
*/ | |
function isComptroller() external view returns (bool); | |
/*** Assets You Are In ***/ | |
function enterMarkets(address[] calldata cTokens) external returns (uint[] memory); | |
function exitMarket(address cToken) external returns (uint); | |
/*** Policy Hooks ***/ | |
function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint); | |
function mintVerify(address cToken, address minter, uint mintAmount, uint mintTokens) external; | |
function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint); | |
function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external; | |
function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint); | |
function borrowVerify(address cToken, address borrower, uint borrowAmount) external; | |
function repayBorrowAllowed( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function repayBorrowVerify( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount, | |
uint borrowerIndex) external; | |
function liquidateBorrowAllowed( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function liquidateBorrowVerify( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount, | |
uint seizeTokens) external; | |
function seizeAllowed( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external returns (uint); | |
function seizeVerify( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external; | |
function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint); | |
function transferVerify(address cToken, address src, address dst, uint transferTokens) external; | |
/*** Liquidity/Liquidation Calculations ***/ | |
function liquidateCalculateSeizeTokens( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
uint repayAmount) external view returns (uint, uint); | |
} | |
// File: contracts/ErrorReporter.sol | |
pragma solidity ^0.5.8; | |
contract ComptrollerErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
COMPTROLLER_MISMATCH, | |
INSUFFICIENT_SHORTFALL, | |
INSUFFICIENT_LIQUIDITY, | |
INVALID_CLOSE_FACTOR, | |
INVALID_COLLATERAL_FACTOR, | |
INVALID_LIQUIDATION_INCENTIVE, | |
MARKET_NOT_ENTERED, // no longer possible | |
MARKET_NOT_LISTED, | |
MARKET_ALREADY_LISTED, | |
MATH_ERROR, | |
NONZERO_BORROW_BALANCE, | |
PRICE_ERROR, | |
REJECTION, | |
SNAPSHOT_ERROR, | |
TOO_MANY_ASSETS, | |
TOO_MUCH_REPAY | |
} | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
EXIT_MARKET_BALANCE_OWED, | |
EXIT_MARKET_REJECTION, | |
SET_CLOSE_FACTOR_OWNER_CHECK, | |
SET_CLOSE_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_NO_EXISTS, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_WITHOUT_PRICE, | |
SET_IMPLEMENTATION_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_VALIDATION, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_OWNER_CHECK, | |
SET_PRICE_ORACLE_OWNER_CHECK, | |
SUPPORT_MARKET_EXISTS, | |
SUPPORT_MARKET_OWNER_CHECK, | |
SET_PAUSE_GUARDIAN_OWNER_CHECK | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
contract TokenErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
BAD_INPUT, | |
COMPTROLLER_REJECTION, | |
COMPTROLLER_CALCULATION_ERROR, | |
INTEREST_RATE_MODEL_ERROR, | |
INVALID_ACCOUNT_PAIR, | |
INVALID_CLOSE_AMOUNT_REQUESTED, | |
INVALID_COLLATERAL_FACTOR, | |
MATH_ERROR, | |
MARKET_NOT_FRESH, | |
MARKET_NOT_LISTED, | |
TOKEN_INSUFFICIENT_ALLOWANCE, | |
TOKEN_INSUFFICIENT_BALANCE, | |
TOKEN_INSUFFICIENT_CASH, | |
TOKEN_TRANSFER_IN_FAILED, | |
TOKEN_TRANSFER_OUT_FAILED | |
} | |
/* | |
* Note: FailureInfo (but not Error) is kept in alphabetical order | |
* This is because FailureInfo grows significantly faster, and | |
* the order of Error has some meaning, while the order of FailureInfo | |
* is entirely arbitrary. | |
*/ | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, | |
ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, | |
ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, | |
BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
BORROW_ACCRUE_INTEREST_FAILED, | |
BORROW_CASH_NOT_AVAILABLE, | |
BORROW_FRESHNESS_CHECK, | |
BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
BORROW_MARKET_NOT_LISTED, | |
BORROW_COMPTROLLER_REJECTION, | |
LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED, | |
LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED, | |
LIQUIDATE_COLLATERAL_FRESHNESS_CHECK, | |
LIQUIDATE_COMPTROLLER_REJECTION, | |
LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, | |
LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX, | |
LIQUIDATE_CLOSE_AMOUNT_IS_ZERO, | |
LIQUIDATE_FRESHNESS_CHECK, | |
LIQUIDATE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_REPAY_BORROW_FRESH_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, | |
LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, | |
LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_SEIZE_TOO_MUCH, | |
MINT_ACCRUE_INTEREST_FAILED, | |
MINT_COMPTROLLER_REJECTION, | |
MINT_EXCHANGE_CALCULATION_FAILED, | |
MINT_EXCHANGE_RATE_READ_FAILED, | |
MINT_FRESHNESS_CHECK, | |
MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
MINT_TRANSFER_IN_FAILED, | |
MINT_TRANSFER_IN_NOT_POSSIBLE, | |
REDEEM_ACCRUE_INTEREST_FAILED, | |
REDEEM_COMPTROLLER_REJECTION, | |
REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_RATE_READ_FAILED, | |
REDEEM_FRESHNESS_CHECK, | |
REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
REDEEM_TRANSFER_OUT_NOT_POSSIBLE, | |
REDUCE_RESERVES_ACCRUE_INTEREST_FAILED, | |
REDUCE_RESERVES_ADMIN_CHECK, | |
REDUCE_RESERVES_CASH_NOT_AVAILABLE, | |
REDUCE_RESERVES_FRESH_CHECK, | |
REDUCE_RESERVES_VALIDATION, | |
REPAY_BEHALF_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_COMPTROLLER_REJECTION, | |
REPAY_BORROW_FRESHNESS_CHECK, | |
REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COMPTROLLER_OWNER_CHECK, | |
SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED, | |
SET_INTEREST_RATE_MODEL_FRESH_CHECK, | |
SET_INTEREST_RATE_MODEL_OWNER_CHECK, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_ORACLE_MARKET_NOT_LISTED, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED, | |
SET_RESERVE_FACTOR_ADMIN_CHECK, | |
SET_RESERVE_FACTOR_FRESH_CHECK, | |
SET_RESERVE_FACTOR_BOUNDS_CHECK, | |
TRANSFER_COMPTROLLER_REJECTION, | |
TRANSFER_NOT_ALLOWED, | |
TRANSFER_NOT_ENOUGH, | |
TRANSFER_TOO_MUCH | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
// File: contracts/CarefulMath.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Careful Math | |
* @author Compound | |
* @notice Derived from OpenZeppelin's SafeMath library | |
* https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/math/SafeMath.sol | |
*/ | |
contract CarefulMath { | |
/** | |
* @dev Possible error codes that we can return | |
*/ | |
enum MathError { | |
NO_ERROR, | |
DIVISION_BY_ZERO, | |
INTEGER_OVERFLOW, | |
INTEGER_UNDERFLOW | |
} | |
/** | |
* @dev Multiplies two numbers, returns an error on overflow. | |
*/ | |
function mulUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (a == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
uint c = a * b; | |
if (c / a != b) { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} else { | |
return (MathError.NO_ERROR, c); | |
} | |
} | |
/** | |
* @dev Integer division of two numbers, truncating the quotient. | |
*/ | |
function divUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b == 0) { | |
return (MathError.DIVISION_BY_ZERO, 0); | |
} | |
return (MathError.NO_ERROR, a / b); | |
} | |
/** | |
* @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). | |
*/ | |
function subUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b <= a) { | |
return (MathError.NO_ERROR, a - b); | |
} else { | |
return (MathError.INTEGER_UNDERFLOW, 0); | |
} | |
} | |
/** | |
* @dev Adds two numbers, returns an error on overflow. | |
*/ | |
function addUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
uint c = a + b; | |
if (c >= a) { | |
return (MathError.NO_ERROR, c); | |
} else { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} | |
} | |
/** | |
* @dev add a and b and then subtract c | |
*/ | |
function addThenSubUInt(uint a, uint b, uint c) internal pure returns (MathError, uint) { | |
(MathError err0, uint sum) = addUInt(a, b); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, 0); | |
} | |
return subUInt(sum, c); | |
} | |
} | |
// File: contracts/Exponential.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Exponential module for storing fixed-precision decimals | |
* @author Compound | |
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. | |
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: | |
* `Exp({mantissa: 5100000000000000000})`. | |
*/ | |
contract Exponential is CarefulMath { | |
uint constant expScale = 1e18; | |
uint constant halfExpScale = expScale/2; | |
uint constant mantissaOne = expScale; | |
struct Exp { | |
uint mantissa; | |
} | |
/** | |
* @dev Creates an exponential from numerator and denominator values. | |
* Note: Returns an error if (`num` * 10e18) > MAX_INT, | |
* or if `denom` is zero. | |
*/ | |
function getExp(uint num, uint denom) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledNumerator) = mulUInt(num, expScale); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
(MathError err1, uint rational) = divUInt(scaledNumerator, denom); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: rational})); | |
} | |
/** | |
* @dev Adds two exponentials, returning a new exponential. | |
*/ | |
function addExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = addUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Subtracts two exponentials, returning a new exponential. | |
*/ | |
function subExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = subUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, returning a new Exp. | |
*/ | |
function mulScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledMantissa) = mulUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: scaledMantissa})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. | |
*/ | |
function mulScalarTruncate(Exp memory a, uint scalar) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(product)); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. | |
*/ | |
function mulScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return addUInt(truncate(product), addend); | |
} | |
/** | |
* @dev Divide an Exp by a scalar, returning a new Exp. | |
*/ | |
function divScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint descaledMantissa) = divUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: descaledMantissa})); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, returning a new Exp. | |
*/ | |
function divScalarByExp(uint scalar, Exp memory divisor) pure internal returns (MathError, Exp memory) { | |
/* | |
We are doing this as: | |
getExp(mulUInt(expScale, scalar), divisor.mantissa) | |
How it works: | |
Exp = a / b; | |
Scalar = s; | |
`s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` | |
*/ | |
(MathError err0, uint numerator) = mulUInt(expScale, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return getExp(numerator, divisor.mantissa); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, then truncate to return an unsigned integer. | |
*/ | |
function divScalarByExpTruncate(uint scalar, Exp memory divisor) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory fraction) = divScalarByExp(scalar, divisor); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(fraction)); | |
} | |
/** | |
* @dev Multiplies two exponentials, returning a new exponential. | |
*/ | |
function mulExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint doubleScaledProduct) = mulUInt(a.mantissa, b.mantissa); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
// We add half the scale before dividing so that we get rounding instead of truncation. | |
// See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 | |
// Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. | |
(MathError err1, uint doubleScaledProductWithHalfScale) = addUInt(halfExpScale, doubleScaledProduct); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
(MathError err2, uint product) = divUInt(doubleScaledProductWithHalfScale, expScale); | |
// The only error `div` can return is MathError.DIVISION_BY_ZERO but we control `expScale` and it is not zero. | |
assert(err2 == MathError.NO_ERROR); | |
return (MathError.NO_ERROR, Exp({mantissa: product})); | |
} | |
/** | |
* @dev Multiplies two exponentials given their mantissas, returning a new exponential. | |
*/ | |
function mulExp(uint a, uint b) pure internal returns (MathError, Exp memory) { | |
return mulExp(Exp({mantissa: a}), Exp({mantissa: b})); | |
} | |
/** | |
* @dev Multiplies three exponentials, returning a new exponential. | |
*/ | |
function mulExp3(Exp memory a, Exp memory b, Exp memory c) pure internal returns (MathError, Exp memory) { | |
(MathError err, Exp memory ab) = mulExp(a, b); | |
if (err != MathError.NO_ERROR) { | |
return (err, ab); | |
} | |
return mulExp(ab, c); | |
} | |
/** | |
* @dev Divides two exponentials, returning a new exponential. | |
* (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, | |
* which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) | |
*/ | |
function divExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
return getExp(a.mantissa, b.mantissa); | |
} | |
/** | |
* @dev Truncates the given exp to a whole number value. | |
* For example, truncate(Exp{mantissa: 15 * expScale}) = 15 | |
*/ | |
function truncate(Exp memory exp) pure internal returns (uint) { | |
// Note: We are not using careful math here as we're performing a division that cannot fail | |
return exp.mantissa / expScale; | |
} | |
/** | |
* @dev Checks if first Exp is less than second Exp. | |
*/ | |
function lessThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa < right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp <= right Exp. | |
*/ | |
function lessThanOrEqualExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa <= right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp > right Exp. | |
*/ | |
function greaterThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa > right.mantissa; | |
} | |
/** | |
* @dev returns true if Exp is exactly zero | |
*/ | |
function isZeroExp(Exp memory value) pure internal returns (bool) { | |
return value.mantissa == 0; | |
} | |
} | |
// File: contracts/EIP20Interface.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title ERC 20 Token Standard Interface | |
* https://eips.ethereum.org/EIPS/eip-20 | |
*/ | |
interface EIP20Interface { | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: contracts/EIP20NonStandardInterface.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title EIP20NonStandardInterface | |
* @dev Version of ERC20 with no return values for `transfer` and `transferFrom` | |
* See https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
interface EIP20NonStandardInterface { | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transfer` does not return a value, in violation of the ERC-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transfer(address dst, uint256 amount) external; | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transferFrom` does not return a value, in violation of the ERC-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external; | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: contracts/ReentrancyGuard.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Helps contracts guard against reentrancy attacks. | |
* @author Remco Bloemen <remco@2π.com>, Eenae <alexey@mixbytes.io> | |
* @dev If you mark a function `nonReentrant`, you should also | |
* mark it `external`. | |
*/ | |
contract ReentrancyGuard { | |
/// @dev counter to allow mutex lock with only one SSTORE operation | |
uint256 private _guardCounter; | |
constructor () internal { | |
// The counter starts at one to prevent changing it from zero to a non-zero | |
// value, which is a more expensive operation. | |
_guardCounter = 1; | |
} | |
/** | |
* @dev Prevents a contract from calling itself, directly or indirectly. | |
* Calling a `nonReentrant` function from another `nonReentrant` | |
* function is not supported. It is possible to prevent this from happening | |
* by making the `nonReentrant` function external, and make it call a | |
* `private` function that does the actual work. | |
*/ | |
modifier nonReentrant() { | |
_guardCounter += 1; | |
uint256 localCounter = _guardCounter; | |
_; | |
require(localCounter == _guardCounter, "re-entered"); | |
} | |
} | |
// File: contracts/InterestRateModel.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title The Compound InterestRateModel Interface | |
* @author Compound | |
* @notice Any interest rate model should derive from this contract. | |
* @dev These functions are specifically not marked `pure` as implementations of this | |
* contract may read from storage variables. | |
*/ | |
interface InterestRateModel { | |
/** | |
* @notice Gets the current borrow interest rate based on the given asset, total cash, total borrows | |
* and total reserves. | |
* @dev The return value should be scaled by 1e18, thus a return value of | |
* `(true, 1000000000000)` implies an interest rate of 0.000001 or 0.0001% *per block*. | |
* @param cash The total cash of the underlying asset in the CToken | |
* @param borrows The total borrows of the underlying asset in the CToken | |
* @param reserves The total reserves of the underlying asset in the CToken | |
* @return Success or failure and the borrow interest rate per block scaled by 10e18 | |
*/ | |
function getBorrowRate(uint cash, uint borrows, uint reserves) external view returns (uint, uint); | |
/** | |
* @notice Marker function used for light validation when updating the interest rate model of a market | |
* @dev Marker function used for light validation when updating the interest rate model of a market. Implementations should simply return true. | |
* @return Success or failure | |
*/ | |
function isInterestRateModel() external view returns (bool); | |
} | |
// File: contracts/CToken.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Compound's CToken Contract | |
* @notice Abstract base for CTokens | |
* @author Compound | |
*/ | |
contract CToken is EIP20Interface, Exponential, TokenErrorReporter, ReentrancyGuard { | |
/** | |
* @notice Indicator that this is a CToken contract (for inspection) | |
*/ | |
bool public constant isCToken = true; | |
/** | |
* @notice EIP-20 token name for this token | |
*/ | |
string public name; | |
/** | |
* @notice EIP-20 token symbol for this token | |
*/ | |
string public symbol; | |
/** | |
* @notice EIP-20 token decimals for this token | |
*/ | |
uint8 public decimals; | |
/** | |
* @notice Maximum borrow rate that can ever be applied (.0005% / block) | |
*/ | |
uint internal constant borrowRateMaxMantissa = 0.0005e16; | |
/** | |
* @notice Maximum fraction of interest that can be set aside for reserves | |
*/ | |
uint internal constant reserveFactorMaxMantissa = 1e18; | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address payable public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address payable public pendingAdmin; | |
/** | |
* @notice Contract which oversees inter-cToken operations | |
*/ | |
ComptrollerInterface public comptroller; | |
/** | |
* @notice Model which tells what the current interest rate should be | |
*/ | |
InterestRateModel public interestRateModel; | |
/** | |
* @notice Initial exchange rate used when minting the first CTokens (used when totalSupply = 0) | |
*/ | |
uint public initialExchangeRateMantissa; | |
/** | |
* @notice Fraction of interest currently set aside for reserves | |
*/ | |
uint public reserveFactorMantissa; | |
/** | |
* @notice Block number that interest was last accrued at | |
*/ | |
uint public accrualBlockNumber; | |
/** | |
* @notice Accumulator of the total earned interest rate since the opening of the market | |
*/ | |
uint public borrowIndex; | |
/** | |
* @notice Total amount of outstanding borrows of the underlying in this market | |
*/ | |
uint public totalBorrows; | |
/** | |
* @notice Total amount of reserves of the underlying held in this market | |
*/ | |
uint public totalReserves; | |
/** | |
* @notice Total number of tokens in circulation | |
*/ | |
uint256 public totalSupply; | |
/** | |
* @notice Official record of token balances for each account | |
*/ | |
mapping (address => uint256) internal accountTokens; | |
/** | |
* @notice Approved token transfer amounts on behalf of others | |
*/ | |
mapping (address => mapping (address => uint256)) internal transferAllowances; | |
/** | |
* @notice Container for borrow balance information | |
* @member principal Total balance (with accrued interest), after applying the most recent balance-changing action | |
* @member interestIndex Global borrowIndex as of the most recent balance-changing action | |
*/ | |
struct BorrowSnapshot { | |
uint principal; | |
uint interestIndex; | |
} | |
/** | |
* @notice Mapping of account addresses to outstanding borrow balances | |
*/ | |
mapping(address => BorrowSnapshot) internal accountBorrows; | |
/*** Market Events ***/ | |
/** | |
* @notice Event emitted when interest is accrued | |
*/ | |
event AccrueInterest(uint interestAccumulated, uint borrowIndex, uint totalBorrows); | |
/** | |
* @notice Event emitted when tokens are minted | |
*/ | |
event Mint(address minter, uint mintAmount, uint mintTokens); | |
/** | |
* @notice Event emitted when tokens are redeemed | |
*/ | |
event Redeem(address redeemer, uint redeemAmount, uint redeemTokens); | |
/** | |
* @notice Event emitted when underlying is borrowed | |
*/ | |
event Borrow(address borrower, uint borrowAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is repaid | |
*/ | |
event RepayBorrow(address payer, address borrower, uint repayAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is liquidated | |
*/ | |
event LiquidateBorrow(address liquidator, address borrower, uint repayAmount, address cTokenCollateral, uint seizeTokens); | |
/*** Admin Events ***/ | |
/** | |
* @notice Event emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Event emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
/** | |
* @notice Event emitted when comptroller is changed | |
*/ | |
event NewComptroller(ComptrollerInterface oldComptroller, ComptrollerInterface newComptroller); | |
/** | |
* @notice Event emitted when interestRateModel is changed | |
*/ | |
event NewMarketInterestRateModel(InterestRateModel oldInterestRateModel, InterestRateModel newInterestRateModel); | |
/** | |
* @notice Event emitted when the reserve factor is changed | |
*/ | |
event NewReserveFactor(uint oldReserveFactorMantissa, uint newReserveFactorMantissa); | |
/** | |
* @notice Event emitted when the reserves are reduced | |
*/ | |
event ReservesReduced(address admin, uint reduceAmount, uint newTotalReserves); | |
/** | |
* @notice Construct a new money market | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ EIP-20 name of this token | |
* @param symbol_ EIP-20 symbol of this token | |
* @param decimals_ EIP-20 decimal precision of this token | |
* @param admin_ Administrator of this token | |
*/ | |
constructor(ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_, | |
address payable admin_) internal { | |
// Set initial exchange rate | |
initialExchangeRateMantissa = initialExchangeRateMantissa_; | |
require(initialExchangeRateMantissa > 0, "Initial exchange rate must be greater than zero."); | |
// Temporarily set msg.sender to admin to set comptroller and interest rate model | |
admin = msg.sender; | |
// Set the comptroller | |
uint err = _setComptroller(comptroller_); | |
require(err == uint(Error.NO_ERROR), "Setting comptroller failed"); | |
// Initialize block number and borrow index (block number mocks depend on comptroller being set) | |
accrualBlockNumber = getBlockNumber(); | |
borrowIndex = mantissaOne; | |
// Set the interest rate model (depends on block number / borrow index) | |
err = _setInterestRateModelFresh(interestRateModel_); | |
require(err == uint(Error.NO_ERROR), "Setting interest rate model failed"); | |
name = name_; | |
symbol = symbol_; | |
decimals = decimals_; | |
// Set the proper admin now that initialization is done | |
admin = admin_; | |
} | |
/** | |
* @notice Transfer `tokens` tokens from `src` to `dst` by `spender` | |
* @dev Called by both `transfer` and `transferFrom` internally | |
* @param spender The address of the account performing the transfer | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param tokens The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferTokens(address spender, address src, address dst, uint tokens) internal returns (uint) { | |
/* Fail if transfer not allowed */ | |
uint allowed = comptroller.transferAllowed(address(this), src, dst, tokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.TRANSFER_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Do not allow self-transfers */ | |
if (src == dst) { | |
return fail(Error.BAD_INPUT, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
/* Get the allowance, infinite for the account owner */ | |
uint startingAllowance = 0; | |
if (spender == src) { | |
startingAllowance = uint(-1); | |
} else { | |
startingAllowance = transferAllowances[src][spender]; | |
} | |
/* Do the calculations, checking for {under,over}flow */ | |
MathError mathErr; | |
uint allowanceNew; | |
uint srcTokensNew; | |
uint dstTokensNew; | |
(mathErr, allowanceNew) = subUInt(startingAllowance, tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
(mathErr, srcTokensNew) = subUInt(accountTokens[src], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ENOUGH); | |
} | |
(mathErr, dstTokensNew) = addUInt(accountTokens[dst], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_TOO_MUCH); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
accountTokens[src] = srcTokensNew; | |
accountTokens[dst] = dstTokensNew; | |
/* Eat some of the allowance (if necessary) */ | |
if (startingAllowance != uint(-1)) { | |
transferAllowances[src][spender] = allowanceNew; | |
} | |
/* We emit a Transfer event */ | |
emit Transfer(src, dst, tokens); | |
comptroller.transferVerify(address(this), src, dst, tokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, msg.sender, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, src, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool) { | |
address src = msg.sender; | |
transferAllowances[src][spender] = amount; | |
emit Approval(src, spender, amount); | |
return true; | |
} | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256) { | |
return transferAllowances[owner][spender]; | |
} | |
/** | |
* @notice Get the token balance of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of tokens owned by `owner` | |
*/ | |
function balanceOf(address owner) external view returns (uint256) { | |
return accountTokens[owner]; | |
} | |
/** | |
* @notice Get the underlying balance of the `owner` | |
* @dev This also accrues interest in a transaction | |
* @param owner The address of the account to query | |
* @return The amount of underlying owned by `owner` | |
*/ | |
function balanceOfUnderlying(address owner) external returns (uint) { | |
Exp memory exchangeRate = Exp({mantissa: exchangeRateCurrent()}); | |
(MathError mErr, uint balance) = mulScalarTruncate(exchangeRate, accountTokens[owner]); | |
require(mErr == MathError.NO_ERROR); | |
return balance; | |
} | |
/** | |
* @notice Get a snapshot of the account's balances, and the cached exchange rate | |
* @dev This is used by comptroller to more efficiently perform liquidity checks. | |
* @param account Address of the account to snapshot | |
* @return (possible error, token balance, borrow balance, exchange rate mantissa) | |
*/ | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { | |
uint cTokenBalance = accountTokens[account]; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
MathError mErr; | |
(mErr, borrowBalance) = borrowBalanceStoredInternal(account); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
(mErr, exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
return (uint(Error.NO_ERROR), cTokenBalance, borrowBalance, exchangeRateMantissa); | |
} | |
/** | |
* @dev Function to simply retrieve block number | |
* This exists mainly for inheriting test contracts to stub this result. | |
*/ | |
function getBlockNumber() internal view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Returns the current per-block borrow interest rate for this cToken | |
* @return The borrow interest rate per block, scaled by 1e18 | |
*/ | |
function borrowRatePerBlock() external view returns (uint) { | |
(uint opaqueErr, uint borrowRateMantissa) = interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
require(opaqueErr == 0, "borrowRatePerBlock: interestRateModel.borrowRate failed"); // semi-opaque | |
return borrowRateMantissa; | |
} | |
/** | |
* @notice Returns the current per-block supply interest rate for this cToken | |
* @return The supply interest rate per block, scaled by 1e18 | |
*/ | |
function supplyRatePerBlock() external view returns (uint) { | |
/* We calculate the supply rate: | |
* underlying = totalSupply × exchangeRate | |
* borrowsPer = totalBorrows ÷ underlying | |
* supplyRate = borrowRate × (1-reserveFactor) × borrowsPer | |
*/ | |
uint exchangeRateMantissa = exchangeRateStored(); | |
(uint e0, uint borrowRateMantissa) = interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
require(e0 == 0, "supplyRatePerBlock: calculating borrowRate failed"); // semi-opaque | |
(MathError e1, Exp memory underlying) = mulScalar(Exp({mantissa: exchangeRateMantissa}), totalSupply); | |
require(e1 == MathError.NO_ERROR, "supplyRatePerBlock: calculating underlying failed"); | |
(MathError e2, Exp memory borrowsPer) = divScalarByExp(totalBorrows, underlying); | |
require(e2 == MathError.NO_ERROR, "supplyRatePerBlock: calculating borrowsPer failed"); | |
(MathError e3, Exp memory oneMinusReserveFactor) = subExp(Exp({mantissa: mantissaOne}), Exp({mantissa: reserveFactorMantissa})); | |
require(e3 == MathError.NO_ERROR, "supplyRatePerBlock: calculating oneMinusReserveFactor failed"); | |
(MathError e4, Exp memory supplyRate) = mulExp3(Exp({mantissa: borrowRateMantissa}), oneMinusReserveFactor, borrowsPer); | |
require(e4 == MathError.NO_ERROR, "supplyRatePerBlock: calculating supplyRate failed"); | |
return supplyRate.mantissa; | |
} | |
/** | |
* @notice Returns the current total borrows plus accrued interest | |
* @return The total borrows with interest | |
*/ | |
function totalBorrowsCurrent() external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return totalBorrows; | |
} | |
/** | |
* @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex | |
* @param account The address whose balance should be calculated after updating borrowIndex | |
* @return The calculated balance | |
*/ | |
function borrowBalanceCurrent(address account) external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return borrowBalanceStored(account); | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return The calculated balance | |
*/ | |
function borrowBalanceStored(address account) public view returns (uint) { | |
(MathError err, uint result) = borrowBalanceStoredInternal(account); | |
require(err == MathError.NO_ERROR, "borrowBalanceStored: borrowBalanceStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return (error code, the calculated balance or 0 if error code is non-zero) | |
*/ | |
function borrowBalanceStoredInternal(address account) internal view returns (MathError, uint) { | |
/* Note: we do not assert that the market is up to date */ | |
MathError mathErr; | |
uint principalTimesIndex; | |
uint result; | |
/* Get borrowBalance and borrowIndex */ | |
BorrowSnapshot storage borrowSnapshot = accountBorrows[account]; | |
/* If borrowBalance = 0 then borrowIndex is likely also 0. | |
* Rather than failing the calculation with a division by 0, we immediately return 0 in this case. | |
*/ | |
if (borrowSnapshot.principal == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
/* Calculate new borrow balance using the interest index: | |
* recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex | |
*/ | |
(mathErr, principalTimesIndex) = mulUInt(borrowSnapshot.principal, borrowIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, result) = divUInt(principalTimesIndex, borrowSnapshot.interestIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, result); | |
} | |
/** | |
* @notice Accrue interest then return the up-to-date exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateCurrent() public nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return exchangeRateStored(); | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the CToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateStored() public view returns (uint) { | |
(MathError err, uint result) = exchangeRateStoredInternal(); | |
require(err == MathError.NO_ERROR, "exchangeRateStored: exchangeRateStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the CToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return (error code, calculated exchange rate scaled by 1e18) | |
*/ | |
function exchangeRateStoredInternal() internal view returns (MathError, uint) { | |
if (totalSupply == 0) { | |
/* | |
* If there are no tokens minted: | |
* exchangeRate = initialExchangeRate | |
*/ | |
return (MathError.NO_ERROR, initialExchangeRateMantissa); | |
} else { | |
/* | |
* Otherwise: | |
* exchangeRate = (totalCash + totalBorrows - totalReserves) / totalSupply | |
*/ | |
uint totalCash = getCashPrior(); | |
uint cashPlusBorrowsMinusReserves; | |
Exp memory exchangeRate; | |
MathError mathErr; | |
(mathErr, cashPlusBorrowsMinusReserves) = addThenSubUInt(totalCash, totalBorrows, totalReserves); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, exchangeRate) = getExp(cashPlusBorrowsMinusReserves, totalSupply); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, exchangeRate.mantissa); | |
} | |
} | |
/** | |
* @notice Get cash balance of this cToken in the underlying asset | |
* @return The quantity of underlying asset owned by this contract | |
*/ | |
function getCash() external view returns (uint) { | |
return getCashPrior(); | |
} | |
struct AccrueInterestLocalVars { | |
MathError mathErr; | |
uint opaqueErr; | |
uint borrowRateMantissa; | |
uint currentBlockNumber; | |
uint blockDelta; | |
Exp simpleInterestFactor; | |
uint interestAccumulated; | |
uint totalBorrowsNew; | |
uint totalReservesNew; | |
uint borrowIndexNew; | |
} | |
/** | |
* @notice Applies accrued interest to total borrows and reserves. | |
* @dev This calculates interest accrued from the last checkpointed block | |
* up to the current block and writes new checkpoint to storage. | |
*/ | |
function accrueInterest() public returns (uint) { | |
AccrueInterestLocalVars memory vars; | |
/* Calculate the current borrow interest rate */ | |
(vars.opaqueErr, vars.borrowRateMantissa) = interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
require(vars.borrowRateMantissa <= borrowRateMaxMantissa, "borrow rate is absurdly high"); | |
if (vars.opaqueErr != 0) { | |
return failOpaque(Error.INTEREST_RATE_MODEL_ERROR, FailureInfo.ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, vars.opaqueErr); | |
} | |
/* Remember the initial block number */ | |
vars.currentBlockNumber = getBlockNumber(); | |
/* Calculate the number of blocks elapsed since the last accrual */ | |
(vars.mathErr, vars.blockDelta) = subUInt(vars.currentBlockNumber, accrualBlockNumber); | |
assert(vars.mathErr == MathError.NO_ERROR); // Block delta should always succeed and if it doesn't, blow up. | |
/* | |
* Calculate the interest accumulated into borrows and reserves and the new index: | |
* simpleInterestFactor = borrowRate * blockDelta | |
* interestAccumulated = simpleInterestFactor * totalBorrows | |
* totalBorrowsNew = interestAccumulated + totalBorrows | |
* totalReservesNew = interestAccumulated * reserveFactor + totalReserves | |
* borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex | |
*/ | |
(vars.mathErr, vars.simpleInterestFactor) = mulScalar(Exp({mantissa: vars.borrowRateMantissa}), vars.blockDelta); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.interestAccumulated) = mulScalarTruncate(vars.simpleInterestFactor, totalBorrows); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = addUInt(vars.interestAccumulated, totalBorrows); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalReservesNew) = mulScalarTruncateAddUInt(Exp({mantissa: reserveFactorMantissa}), vars.interestAccumulated, totalReserves); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.borrowIndexNew) = mulScalarTruncateAddUInt(vars.simpleInterestFactor, borrowIndex, borrowIndex); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accrualBlockNumber = vars.currentBlockNumber; | |
borrowIndex = vars.borrowIndexNew; | |
totalBorrows = vars.totalBorrowsNew; | |
totalReserves = vars.totalReservesNew; | |
/* We emit an AccrueInterest event */ | |
emit AccrueInterest(vars.interestAccumulated, vars.borrowIndexNew, totalBorrows); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender supplies assets into the market and receives cTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mintInternal(uint mintAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.MINT_ACCRUE_INTEREST_FAILED); | |
} | |
// mintFresh emits the actual Mint event if successful and logs on errors, so we don't need to | |
return mintFresh(msg.sender, mintAmount); | |
} | |
struct MintLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint mintTokens; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
} | |
/** | |
* @notice User supplies assets into the market and receives cTokens in exchange | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param minter The address of the account which is supplying the assets | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mintFresh(address minter, uint mintAmount) internal returns (uint) { | |
/* Fail if mint not allowed */ | |
uint allowed = comptroller.mintAllowed(address(this), minter, mintAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.MINT_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.MINT_FRESHNESS_CHECK); | |
} | |
MintLocalVars memory vars; | |
/* Fail if checkTransferIn fails */ | |
vars.err = checkTransferIn(minter, mintAmount); | |
if (vars.err != Error.NO_ERROR) { | |
return fail(vars.err, FailureInfo.MINT_TRANSFER_IN_NOT_POSSIBLE); | |
} | |
/* | |
* We get the current exchange rate and calculate the number of cTokens to be minted: | |
* mintTokens = mintAmount / exchangeRate | |
*/ | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(mintAmount, Exp({mantissa: vars.exchangeRateMantissa})); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* | |
* We calculate the new total supply of cTokens and minter token balance, checking for overflow: | |
* totalSupplyNew = totalSupply + mintTokens | |
* accountTokensNew = accountTokens[minter] + mintTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = addUInt(totalSupply, vars.mintTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountTokensNew) = addUInt(accountTokens[minter], vars.mintTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the minter and the mintAmount | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken holds an additional mintAmount of cash. | |
* If doTransferIn fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferIn(minter, mintAmount); | |
if (vars.err != Error.NO_ERROR) { | |
return fail(vars.err, FailureInfo.MINT_TRANSFER_IN_FAILED); | |
} | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[minter] = vars.accountTokensNew; | |
/* We emit a Mint event, and a Transfer event */ | |
emit Mint(minter, mintAmount, vars.mintTokens); | |
emit Transfer(address(this), minter, vars.mintTokens); | |
/* We call the defense hook */ | |
comptroller.mintVerify(address(this), minter, mintAmount, vars.mintTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of cTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemInternal(uint redeemTokens) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, redeemTokens, 0); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to receive from redeeming cTokens | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlyingInternal(uint redeemAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, 0, redeemAmount); | |
} | |
struct RedeemLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint redeemTokens; | |
uint redeemAmount; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
} | |
/** | |
* @notice User redeems cTokens in exchange for the underlying asset | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param redeemer The address of the account which is redeeming the tokens | |
* @param redeemTokensIn The number of cTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @param redeemAmountIn The number of underlying tokens to receive from redeeming cTokens (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemFresh(address payable redeemer, uint redeemTokensIn, uint redeemAmountIn) internal returns (uint) { | |
require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero"); | |
RedeemLocalVars memory vars; | |
/* exchangeRate = invoke Exchange Rate Stored() */ | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); | |
} | |
/* If redeemTokensIn > 0: */ | |
if (redeemTokensIn > 0) { | |
/* | |
* We calculate the exchange rate and the amount of underlying to be redeemed: | |
* redeemTokens = redeemTokensIn | |
* redeemAmount = redeemTokensIn x exchangeRateCurrent | |
*/ | |
vars.redeemTokens = redeemTokensIn; | |
(vars.mathErr, vars.redeemAmount) = mulScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), redeemTokensIn); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
} else { | |
/* | |
* We get the current exchange rate and calculate the amount to be redeemed: | |
* redeemTokens = redeemAmountIn / exchangeRate | |
* redeemAmount = redeemAmountIn | |
*/ | |
(vars.mathErr, vars.redeemTokens) = divScalarByExpTruncate(redeemAmountIn, Exp({mantissa: vars.exchangeRateMantissa})); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
vars.redeemAmount = redeemAmountIn; | |
} | |
/* Fail if redeem not allowed */ | |
uint allowed = comptroller.redeemAllowed(address(this), redeemer, vars.redeemTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REDEEM_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDEEM_FRESHNESS_CHECK); | |
} | |
/* | |
* We calculate the new total supply and redeemer balance, checking for underflow: | |
* totalSupplyNew = totalSupply - redeemTokens | |
* accountTokensNew = accountTokens[redeemer] - redeemTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = subUInt(totalSupply, vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountTokensNew) = subUInt(accountTokens[redeemer], vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* Fail gracefully if protocol has insufficient cash */ | |
if (getCashPrior() < vars.redeemAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDEEM_TRANSFER_OUT_NOT_POSSIBLE); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the redeemer and the redeemAmount. | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken has redeemAmount less of cash. | |
* If doTransferOut fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferOut(redeemer, vars.redeemAmount); | |
require(vars.err == Error.NO_ERROR, "redeem transfer out failed"); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[redeemer] = vars.accountTokensNew; | |
/* We emit a Transfer event, and a Redeem event */ | |
emit Transfer(redeemer, address(this), vars.redeemTokens); | |
emit Redeem(redeemer, vars.redeemAmount, vars.redeemTokens); | |
/* We call the defense hook */ | |
comptroller.redeemVerify(address(this), redeemer, vars.redeemAmount, vars.redeemTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowInternal(uint borrowAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.BORROW_ACCRUE_INTEREST_FAILED); | |
} | |
// borrowFresh emits borrow-specific logs on errors, so we don't need to | |
return borrowFresh(msg.sender, borrowAmount); | |
} | |
struct BorrowLocalVars { | |
Error err; | |
MathError mathErr; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
} | |
/** | |
* @notice Users borrow assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowFresh(address payable borrower, uint borrowAmount) internal returns (uint) { | |
/* Fail if borrow not allowed */ | |
uint allowed = comptroller.borrowAllowed(address(this), borrower, borrowAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.BORROW_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.BORROW_FRESHNESS_CHECK); | |
} | |
/* Fail gracefully if protocol has insufficient underlying cash */ | |
if (getCashPrior() < borrowAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.BORROW_CASH_NOT_AVAILABLE); | |
} | |
BorrowLocalVars memory vars; | |
/* | |
* We calculate the new borrower and total borrow balances, failing on overflow: | |
* accountBorrowsNew = accountBorrows + borrowAmount | |
* totalBorrowsNew = totalBorrows + borrowAmount | |
*/ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountBorrowsNew) = addUInt(vars.accountBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = addUInt(totalBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the borrower and the borrowAmount. | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken borrowAmount less of cash. | |
* If doTransferOut fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferOut(borrower, borrowAmount); | |
require(vars.err == Error.NO_ERROR, "borrow transfer out failed"); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a Borrow event */ | |
emit Borrow(borrower, borrowAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.borrowVerify(address(this), borrower, borrowAmount); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowInternal(uint repayAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.REPAY_BORROW_ACCRUE_INTEREST_FAILED); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, msg.sender, repayAmount); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowBehalfInternal(address borrower, uint repayAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.REPAY_BEHALF_ACCRUE_INTEREST_FAILED); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, borrower, repayAmount); | |
} | |
struct RepayBorrowLocalVars { | |
Error err; | |
MathError mathErr; | |
uint repayAmount; | |
uint borrowerIndex; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
} | |
/** | |
* @notice Borrows are repaid by another user (possibly the borrower). | |
* @param payer the account paying off the borrow | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount the amount of undelrying tokens being returned | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowFresh(address payer, address borrower, uint repayAmount) internal returns (uint) { | |
/* Fail if repayBorrow not allowed */ | |
uint allowed = comptroller.repayBorrowAllowed(address(this), payer, borrower, repayAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REPAY_BORROW_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REPAY_BORROW_FRESHNESS_CHECK); | |
} | |
RepayBorrowLocalVars memory vars; | |
/* We remember the original borrowerIndex for verification purposes */ | |
vars.borrowerIndex = accountBorrows[borrower].interestIndex; | |
/* We fetch the amount the borrower owes, with accumulated interest */ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* If repayAmount == -1, repayAmount = accountBorrows */ | |
if (repayAmount == uint(-1)) { | |
vars.repayAmount = vars.accountBorrows; | |
} else { | |
vars.repayAmount = repayAmount; | |
} | |
/* Fail if checkTransferIn fails */ | |
vars.err = checkTransferIn(payer, vars.repayAmount); | |
if (vars.err != Error.NO_ERROR) { | |
return fail(vars.err, FailureInfo.REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE); | |
} | |
/* | |
* We calculate the new borrower and total borrow balances, failing on underflow: | |
* accountBorrowsNew = accountBorrows - repayAmount | |
* totalBorrowsNew = totalBorrows - repayAmount | |
*/ | |
(vars.mathErr, vars.accountBorrowsNew) = subUInt(vars.accountBorrows, vars.repayAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = subUInt(totalBorrows, vars.repayAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the payer and the repayAmount | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken holds an additional repayAmount of cash. | |
* If doTransferIn fails despite the fact we checked pre-conditions, | |
* we revert because we can't be sure if side effects occurred. | |
*/ | |
vars.err = doTransferIn(payer, vars.repayAmount); | |
require(vars.err == Error.NO_ERROR, "repay borrow transfer in failed"); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a RepayBorrow event */ | |
emit RepayBorrow(payer, borrower, vars.repayAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.repayBorrowVerify(address(this), payer, borrower, vars.repayAmount, vars.borrowerIndex); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrowInternal(address borrower, uint repayAmount, CToken cTokenCollateral) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED); | |
} | |
error = cTokenCollateral.accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED); | |
} | |
// liquidateBorrowFresh emits borrow-specific logs on errors, so we don't need to | |
return liquidateBorrowFresh(msg.sender, borrower, repayAmount, cTokenCollateral); | |
} | |
/** | |
* @notice The liquidator liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param liquidator The address repaying the borrow and seizing collateral | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrowFresh(address liquidator, address borrower, uint repayAmount, CToken cTokenCollateral) internal returns (uint) { | |
/* Fail if liquidate not allowed */ | |
uint allowed = comptroller.liquidateBorrowAllowed(address(this), address(cTokenCollateral), liquidator, borrower, repayAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_FRESHNESS_CHECK); | |
} | |
/* Verify cTokenCollateral market's block number equals current block number */ | |
if (cTokenCollateral.accrualBlockNumber() != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_COLLATERAL_FRESHNESS_CHECK); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_LIQUIDATOR_IS_BORROWER); | |
} | |
/* Fail if repayAmount = 0 */ | |
if (repayAmount == 0) { | |
return fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_ZERO); | |
} | |
/* Fail if repayAmount = -1 */ | |
if (repayAmount == uint(-1)) { | |
return fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX); | |
} | |
/* We calculate the number of collateral tokens that will be seized */ | |
(uint amountSeizeError, uint seizeTokens) = comptroller.liquidateCalculateSeizeTokens(address(this), address(cTokenCollateral), repayAmount); | |
if (amountSeizeError != 0) { | |
return failOpaque(Error.COMPTROLLER_CALCULATION_ERROR, FailureInfo.LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, amountSeizeError); | |
} | |
/* Fail if seizeTokens > borrower collateral token balance */ | |
if (seizeTokens > cTokenCollateral.balanceOf(borrower)) { | |
return fail(Error.TOKEN_INSUFFICIENT_BALANCE, FailureInfo.LIQUIDATE_SEIZE_TOO_MUCH); | |
} | |
/* Fail if repayBorrow fails */ | |
uint repayBorrowError = repayBorrowFresh(liquidator, borrower, repayAmount); | |
if (repayBorrowError != uint(Error.NO_ERROR)) { | |
return fail(Error(repayBorrowError), FailureInfo.LIQUIDATE_REPAY_BORROW_FRESH_FAILED); | |
} | |
/* Revert if seize tokens fails (since we cannot be sure of side effects) */ | |
uint seizeError = cTokenCollateral.seize(liquidator, borrower, seizeTokens); | |
require(seizeError == uint(Error.NO_ERROR), "token seizure failed"); | |
/* We emit a LiquidateBorrow event */ | |
emit LiquidateBorrow(liquidator, borrower, repayAmount, address(cTokenCollateral), seizeTokens); | |
/* We call the defense hook */ | |
comptroller.liquidateBorrowVerify(address(this), address(cTokenCollateral), liquidator, borrower, repayAmount, seizeTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Will fail unless called by another cToken during the process of liquidation. | |
* Its absolutely critical to use msg.sender as the borrowed cToken and not a parameter. | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of cTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seize(address liquidator, address borrower, uint seizeTokens) external nonReentrant returns (uint) { | |
/* Fail if seize not allowed */ | |
uint allowed = comptroller.seizeAllowed(address(this), msg.sender, liquidator, borrower, seizeTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER); | |
} | |
MathError mathErr; | |
uint borrowerTokensNew; | |
uint liquidatorTokensNew; | |
/* | |
* We calculate the new borrower and liquidator token balances, failing on underflow/overflow: | |
* borrowerTokensNew = accountTokens[borrower] - seizeTokens | |
* liquidatorTokensNew = accountTokens[liquidator] + seizeTokens | |
*/ | |
(mathErr, borrowerTokensNew) = subUInt(accountTokens[borrower], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, uint(mathErr)); | |
} | |
(mathErr, liquidatorTokensNew) = addUInt(accountTokens[liquidator], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, uint(mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accountTokens[borrower] = borrowerTokensNew; | |
accountTokens[liquidator] = liquidatorTokensNew; | |
/* Emit a Transfer event */ | |
emit Transfer(borrower, liquidator, seizeTokens); | |
/* We call the defense hook */ | |
comptroller.seizeVerify(address(this), msg.sender, liquidator, borrower, seizeTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() external returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets a new comptroller for the market | |
* @dev Admin function to set a new comptroller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); | |
} | |
ComptrollerInterface oldComptroller = comptroller; | |
// Ensure invoke comptroller.isComptroller() returns true | |
require(newComptroller.isComptroller(), "marker method returned false"); | |
// Set market's comptroller to newComptroller | |
comptroller = newComptroller; | |
// Emit NewComptroller(oldComptroller, newComptroller) | |
emit NewComptroller(oldComptroller, newComptroller); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh | |
* @dev Admin function to accrue interest and set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactor(uint newReserveFactorMantissa) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reserve factor change failed. | |
return fail(Error(error), FailureInfo.SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED); | |
} | |
// _setReserveFactorFresh emits reserve-factor-specific logs on errors, so we don't need to. | |
return _setReserveFactorFresh(newReserveFactorMantissa); | |
} | |
/** | |
* @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual) | |
* @dev Admin function to set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactorFresh(uint newReserveFactorMantissa) internal returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_RESERVE_FACTOR_ADMIN_CHECK); | |
} | |
// Verify market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_RESERVE_FACTOR_FRESH_CHECK); | |
} | |
// Check newReserveFactor ≤ maxReserveFactor | |
if (newReserveFactorMantissa > reserveFactorMaxMantissa) { | |
return fail(Error.BAD_INPUT, FailureInfo.SET_RESERVE_FACTOR_BOUNDS_CHECK); | |
} | |
uint oldReserveFactorMantissa = reserveFactorMantissa; | |
reserveFactorMantissa = newReserveFactorMantissa; | |
emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring to admin | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReserves(uint reduceAmount) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.REDUCE_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _reduceReservesFresh emits reserve-reduction-specific logs on errors, so we don't need to. | |
return _reduceReservesFresh(reduceAmount); | |
} | |
/** | |
* @notice Reduces reserves by transferring to admin | |
* @dev Requires fresh interest accrual | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReservesFresh(uint reduceAmount) internal returns (uint) { | |
Error err; | |
// totalReserves - reduceAmount | |
uint totalReservesNew; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.REDUCE_RESERVES_ADMIN_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDUCE_RESERVES_FRESH_CHECK); | |
} | |
// Fail gracefully if protocol has insufficient underlying cash | |
if (getCashPrior() < reduceAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDUCE_RESERVES_CASH_NOT_AVAILABLE); | |
} | |
// Check reduceAmount ≤ reserves[n] (totalReserves) | |
if (reduceAmount > totalReserves) { | |
return fail(Error.BAD_INPUT, FailureInfo.REDUCE_RESERVES_VALIDATION); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
totalReservesNew = totalReserves - reduceAmount; | |
// We checked reduceAmount <= totalReserves above, so this should never revert. | |
require(totalReservesNew <= totalReserves, "reduce reserves unexpected underflow"); | |
// Store reserves[n+1] = reserves[n] - reduceAmount | |
totalReserves = totalReservesNew; | |
// invoke doTransferOut(reduceAmount, admin) | |
err = doTransferOut(admin, reduceAmount); | |
// we revert on the failure of this command | |
require(err == Error.NO_ERROR, "reduce reserves transfer out failed"); | |
emit ReservesReduced(admin, reduceAmount, totalReservesNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and updates the interest rate model using _setInterestRateModelFresh | |
* @dev Admin function to accrue interest and update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted change of interest rate model failed | |
return fail(Error(error), FailureInfo.SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED); | |
} | |
// _setInterestRateModelFresh emits interest-rate-model-update-specific logs on errors, so we don't need to. | |
return _setInterestRateModelFresh(newInterestRateModel); | |
} | |
/** | |
* @notice updates the interest rate model (*requires fresh interest accrual) | |
* @dev Admin function to update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal returns (uint) { | |
// Used to store old model for use in the event that is emitted on success | |
InterestRateModel oldInterestRateModel; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_INTEREST_RATE_MODEL_OWNER_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_INTEREST_RATE_MODEL_FRESH_CHECK); | |
} | |
// Track the market's current interest rate model | |
oldInterestRateModel = interestRateModel; | |
// Ensure invoke newInterestRateModel.isInterestRateModel() returns true | |
require(newInterestRateModel.isInterestRateModel(), "marker method returned false"); | |
// Set the interest rate model to newInterestRateModel | |
interestRateModel = newInterestRateModel; | |
// Emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel) | |
emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint); | |
/** | |
* @dev Checks whether or not there is sufficient allowance for this contract to move amount from `from` and | |
* whether or not `from` has a balance of at least `amount`. Does NOT do a transfer. | |
*/ | |
function checkTransferIn(address from, uint amount) internal view returns (Error); | |
/** | |
* @dev Performs a transfer in, ideally returning an explanatory error code upon failure rather than reverting. | |
* If caller has not called `checkTransferIn`, this may revert due to insufficient balance or insufficient allowance. | |
* If caller has called `checkTransferIn` successfully, this should not revert in normal conditions. | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (Error); | |
/** | |
* @dev Performs a transfer out, ideally returning an explanatory error code upon failure tather than reverting. | |
* If caller has not called checked protocol's balance, may revert due to insufficient cash held in the contract. | |
* If caller has checked protocol's balance, and verified it is >= amount, this should not revert in normal conditions. | |
*/ | |
function doTransferOut(address payable to, uint amount) internal returns (Error); | |
} | |
// File: contracts/PriceOracle.sol | |
pragma solidity ^0.5.8; | |
interface PriceOracle { | |
/** | |
* @notice Indicator that this is a PriceOracle contract (for inspection) | |
*/ | |
function isPriceOracle() external pure returns (bool); | |
/** | |
* @notice Get the underlying price of a cToken asset | |
* @param cToken The cToken to get the underlying price of | |
* @return The underlying asset price mantissa (scaled by 1e18). | |
* Zero means the price is unavailable. | |
*/ | |
function getUnderlyingPrice(CToken cToken) external view returns (uint); | |
} | |
// File: contracts/ComptrollerStorage.sol | |
pragma solidity ^0.5.8; | |
contract UnitrollerAdminStorage { | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address public pendingAdmin; | |
/** | |
* @notice Active brains of Unitroller | |
*/ | |
address public comptrollerImplementation; | |
/** | |
* @notice Pending brains of Unitroller | |
*/ | |
address public pendingComptrollerImplementation; | |
} | |
contract ComptrollerV1Storage is UnitrollerAdminStorage { | |
/** | |
* @notice Oracle which gives the price of any given asset | |
*/ | |
PriceOracle public oracle; | |
/** | |
* @notice Multiplier used to calculate the maximum repayAmount when liquidating a borrow | |
*/ | |
uint public closeFactorMantissa; | |
/** | |
* @notice Multiplier representing the discount on collateral that a liquidator receives | |
*/ | |
uint public liquidationIncentiveMantissa; | |
/** | |
* @notice Max number of assets a single account can participate in (borrow or use as collateral) | |
*/ | |
uint public maxAssets; | |
/** | |
* @notice Per-account mapping of "assets you are in", capped by maxAssets | |
*/ | |
mapping(address => CToken[]) public accountAssets; | |
} | |
contract ComptrollerV2Storage is ComptrollerV1Storage { | |
struct Market { | |
/** | |
* @notice Whether or not this market is listed | |
*/ | |
bool isListed; | |
/** | |
* @notice Multiplier representing the most one can borrow against their collateral in this market. | |
* For instance, 0.9 to allow borrowing 90% of collateral value. | |
* Must be between 0 and 1, and stored as a mantissa. | |
*/ | |
uint collateralFactorMantissa; | |
/** | |
* @notice Per-market mapping of "accounts in this asset" | |
*/ | |
mapping(address => bool) accountMembership; | |
} | |
/** | |
* @notice Official mapping of cTokens -> Market metadata | |
* @dev Used e.g. to determine if a market is supported | |
*/ | |
mapping(address => Market) public markets; | |
/** | |
* @notice The Pause Guardian can pause certain actions as a safety mechanism. Actions which allow users to remove their own assets cannot be paused. | |
*/ | |
address public pauseGuardian; | |
bool public mintGuardianPaused; | |
bool public borrowGuardianPaused; | |
bool public transferGuardianPaused; | |
bool public seizeGuardianPaused; | |
} | |
// File: contracts/Unitroller.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title ComptrollerCore | |
* @dev Storage for the comptroller is at this address, while execution is delegated to the `comptrollerImplementation`. | |
* CTokens should reference this contract as their comptroller. | |
*/ | |
contract Unitroller is UnitrollerAdminStorage, ComptrollerErrorReporter { | |
/** | |
* @notice Emitted when pendingComptrollerImplementation is changed | |
*/ | |
event NewPendingImplementation(address oldPendingImplementation, address newPendingImplementation); | |
/** | |
* @notice Emitted when pendingComptrollerImplementation is accepted, which means comptroller implementation is updated | |
*/ | |
event NewImplementation(address oldImplementation, address newImplementation); | |
/** | |
* @notice Emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
constructor() public { | |
// Set admin to caller | |
admin = msg.sender; | |
} | |
/*** Admin Functions ***/ | |
function _setPendingImplementation(address newPendingImplementation) public returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_IMPLEMENTATION_OWNER_CHECK); | |
} | |
address oldPendingImplementation = pendingComptrollerImplementation; | |
pendingComptrollerImplementation = newPendingImplementation; | |
emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts new implementation of comptroller. msg.sender must be pendingImplementation | |
* @dev Admin function for new implementation to accept it's role as implementation | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptImplementation() public returns (uint) { | |
// Check caller is pendingImplementation and pendingImplementation ≠ address(0) | |
if (msg.sender != pendingComptrollerImplementation || pendingComptrollerImplementation == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldImplementation = comptrollerImplementation; | |
address oldPendingImplementation = pendingComptrollerImplementation; | |
comptrollerImplementation = pendingComptrollerImplementation; | |
pendingComptrollerImplementation = address(0); | |
emit NewImplementation(oldImplementation, comptrollerImplementation); | |
emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address newPendingAdmin) public returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() public returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @dev Delegates execution to an implementation contract. | |
* It returns to the external caller whatever the implementation returns | |
* or forwards reverts. | |
*/ | |
function () payable external { | |
// delegate all other functions to current implementation | |
(bool success, ) = comptrollerImplementation.delegatecall(msg.data); | |
// solium-disable-next-line security/no-inline-assembly | |
assembly { | |
let free_mem_ptr := mload(0x40) | |
returndatacopy(free_mem_ptr, 0, returndatasize) | |
switch success | |
case 0 { revert(free_mem_ptr, returndatasize) } | |
default { return(free_mem_ptr, returndatasize) } | |
} | |
} | |
} | |
// File: contracts/Comptroller.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Compound's Comptroller Contract | |
* @author Compound | |
*/ | |
contract Comptroller is ComptrollerV2Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { | |
/** | |
* @notice Emitted when an admin supports a market | |
*/ | |
event MarketListed(CToken cToken); | |
/** | |
* @notice Emitted when an account enters a market | |
*/ | |
event MarketEntered(CToken cToken, address account); | |
/** | |
* @notice Emitted when an account exits a market | |
*/ | |
event MarketExited(CToken cToken, address account); | |
/** | |
* @notice Emitted when close factor is changed by admin | |
*/ | |
event NewCloseFactor(uint oldCloseFactorMantissa, uint newCloseFactorMantissa); | |
/** | |
* @notice Emitted when a collateral factor is changed by admin | |
*/ | |
event NewCollateralFactor(CToken cToken, uint oldCollateralFactorMantissa, uint newCollateralFactorMantissa); | |
/** | |
* @notice Emitted when liquidation incentive is changed by admin | |
*/ | |
event NewLiquidationIncentive(uint oldLiquidationIncentiveMantissa, uint newLiquidationIncentiveMantissa); | |
/** | |
* @notice Emitted when maxAssets is changed by admin | |
*/ | |
event NewMaxAssets(uint oldMaxAssets, uint newMaxAssets); | |
/** | |
* @notice Emitted when price oracle is changed | |
*/ | |
event NewPriceOracle(PriceOracle oldPriceOracle, PriceOracle newPriceOracle); | |
/** | |
* @notice Emitted when pause guardian is changed | |
*/ | |
event NewPauseGuardian(address oldPauseGuardian, address newPauseGuardian); | |
/** | |
* @notice Emitted when an action is paused | |
*/ | |
event ActionPaused(string action, bool pauseState); | |
/** | |
* @notice Indicator that this is a Comptroller contract (for inspection) | |
*/ | |
bool public constant isComptroller = true; | |
// closeFactorMantissa must be strictly greater than this value | |
uint internal constant closeFactorMinMantissa = 0.05e18; // 0.05 | |
// closeFactorMantissa must not exceed this value | |
uint internal constant closeFactorMaxMantissa = 0.9e18; // 0.9 | |
// No collateralFactorMantissa may exceed this value | |
uint internal constant collateralFactorMaxMantissa = 0.9e18; // 0.9 | |
// liquidationIncentiveMantissa must be no less than this value | |
uint internal constant liquidationIncentiveMinMantissa = 1.0e18; // 1.0 | |
// liquidationIncentiveMantissa must be no greater than this value | |
uint internal constant liquidationIncentiveMaxMantissa = 1.5e18; // 1.5 | |
constructor() public { | |
admin = msg.sender; | |
} | |
/*** Assets You Are In ***/ | |
/** | |
* @notice Returns the assets an account has entered | |
* @param account The address of the account to pull assets for | |
* @return A dynamic list with the assets the account has entered | |
*/ | |
function getAssetsIn(address account) external view returns (CToken[] memory) { | |
CToken[] memory assetsIn = accountAssets[account]; | |
return assetsIn; | |
} | |
/** | |
* @notice Returns whether the given account is entered in the given asset | |
* @param account The address of the account to check | |
* @param cToken The cToken to check | |
* @return True if the account is in the asset, otherwise false. | |
*/ | |
function checkMembership(address account, CToken cToken) external view returns (bool) { | |
return markets[address(cToken)].accountMembership[account]; | |
} | |
/** | |
* @notice Add assets to be included in account liquidity calculation | |
* @param cTokens The list of addresses of the cToken markets to be enabled | |
* @return Success indicator for whether each corresponding market was entered | |
*/ | |
function enterMarkets(address[] memory cTokens) public returns (uint[] memory) { | |
uint len = cTokens.length; | |
uint[] memory results = new uint[](len); | |
for (uint i = 0; i < len; i++) { | |
CToken cToken = CToken(cTokens[i]); | |
results[i] = uint(addToMarketInternal(cToken, msg.sender)); | |
} | |
return results; | |
} | |
/** | |
* @notice Add the market to the borrower's "assets in" for liquidity calculations | |
* @param cToken The market to enter | |
* @param borrower The address of the account to modify | |
* @return Success indicator for whether the market was entered | |
*/ | |
function addToMarketInternal(CToken cToken, address borrower) internal returns (Error) { | |
Market storage marketToJoin = markets[address(cToken)]; | |
if (!marketToJoin.isListed) { | |
// market is not listed, cannot join | |
return Error.MARKET_NOT_LISTED; | |
} | |
if (marketToJoin.accountMembership[borrower] == true) { | |
// already joined | |
return Error.NO_ERROR; | |
} | |
if (accountAssets[borrower].length >= maxAssets) { | |
// no space, cannot join | |
return Error.TOO_MANY_ASSETS; | |
} | |
// survived the gauntlet, add to list | |
// NOTE: we store these somewhat redundantly as a significant optimization | |
// this avoids having to iterate through the list for the most common use cases | |
// that is, only when we need to perform liquidity checks | |
// and not whenever we want to check if an account is in a particular market | |
marketToJoin.accountMembership[borrower] = true; | |
accountAssets[borrower].push(cToken); | |
emit MarketEntered(cToken, borrower); | |
return Error.NO_ERROR; | |
} | |
/** | |
* @notice Removes asset from sender's account liquidity calculation | |
* @dev Sender must not have an outstanding borrow balance in the asset, | |
* or be providing neccessary collateral for an outstanding borrow. | |
* @param cTokenAddress The address of the asset to be removed | |
* @return Whether or not the account successfully exited the market | |
*/ | |
function exitMarket(address cTokenAddress) external returns (uint) { | |
CToken cToken = CToken(cTokenAddress); | |
/* Get sender tokensHeld and amountOwed underlying from the cToken */ | |
(uint oErr, uint tokensHeld, uint amountOwed, ) = cToken.getAccountSnapshot(msg.sender); | |
require(oErr == 0, "exitMarket: getAccountSnapshot failed"); // semi-opaque error code | |
/* Fail if the sender has a borrow balance */ | |
if (amountOwed != 0) { | |
return fail(Error.NONZERO_BORROW_BALANCE, FailureInfo.EXIT_MARKET_BALANCE_OWED); | |
} | |
/* Fail if the sender is not permitted to redeem all of their tokens */ | |
uint allowed = redeemAllowedInternal(cTokenAddress, msg.sender, tokensHeld); | |
if (allowed != 0) { | |
return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); | |
} | |
Market storage marketToExit = markets[address(cToken)]; | |
/* Return true if the sender is not already ‘in’ the market */ | |
if (!marketToExit.accountMembership[msg.sender]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Set cToken account membership to false */ | |
delete marketToExit.accountMembership[msg.sender]; | |
/* Delete cToken from the account’s list of assets */ | |
// load into memory for faster iteration | |
CToken[] memory userAssetList = accountAssets[msg.sender]; | |
uint len = userAssetList.length; | |
uint assetIndex = len; | |
for (uint i = 0; i < len; i++) { | |
if (userAssetList[i] == cToken) { | |
assetIndex = i; | |
break; | |
} | |
} | |
// We *must* have found the asset in the list or our redundant data structure is broken | |
assert(assetIndex < len); | |
// copy last item in list to location of item to be removed, reduce length by 1 | |
CToken[] storage storedList = accountAssets[msg.sender]; | |
storedList[assetIndex] = storedList[storedList.length - 1]; | |
storedList.length--; | |
emit MarketExited(cToken, msg.sender); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Policy Hooks ***/ | |
/** | |
* @notice Checks if the account should be allowed to mint tokens in the given market | |
* @param cToken The market to verify the mint against | |
* @param minter The account which would get the minted tokens | |
* @param mintAmount The amount of underlying being supplied to the market in exchange for tokens | |
* @return 0 if the mint is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintGuardianPaused, "mint is paused"); | |
// Shh - currently unused | |
minter; | |
mintAmount; | |
if (!markets[cToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// *may include Policy Hook-type checks | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates mint and reverts on rejection. May emit logs. | |
* @param cToken Asset being minted | |
* @param minter The address minting the tokens | |
* @param mintAmount The amount of the underlying asset being minted | |
* @param mintTokens The number of tokens being minted | |
*/ | |
function mintVerify(address cToken, address minter, uint mintAmount, uint mintTokens) external { | |
// Shh - currently unused | |
cToken; | |
minter; | |
mintAmount; | |
mintTokens; | |
// Shh - we don't ever want this hook to be marked pure | |
if (false) { | |
maxAssets = maxAssets; | |
} | |
} | |
/** | |
* @notice Checks if the account should be allowed to redeem tokens in the given market | |
* @param cToken The market to verify the redeem against | |
* @param redeemer The account which would redeem the tokens | |
* @param redeemTokens The number of cTokens to exchange for the underlying asset in the market | |
* @return 0 if the redeem is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint) { | |
return redeemAllowedInternal(cToken, redeemer, redeemTokens); | |
} | |
function redeemAllowedInternal(address cToken, address redeemer, uint redeemTokens) internal view returns (uint) { | |
if (!markets[cToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// *may include Policy Hook-type checks | |
/* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ | |
if (!markets[cToken].accountMembership[redeemer]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, CToken(cToken), redeemTokens, 0); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
if (shortfall > 0) { | |
return uint(Error.INSUFFICIENT_LIQUIDITY); | |
} | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates redeem and reverts on rejection. May emit logs. | |
* @param cToken Asset being redeemed | |
* @param redeemer The address redeeming the tokens | |
* @param redeemAmount The amount of the underlying asset being redeemed | |
* @param redeemTokens The number of tokens being redeemed | |
*/ | |
function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external { | |
// Shh - currently unused | |
cToken; | |
redeemer; | |
// Require tokens is zero or amount is also zero | |
if (redeemTokens == 0 && redeemAmount > 0) { | |
revert("redeemTokens zero"); | |
} | |
} | |
/** | |
* @notice Checks if the account should be allowed to borrow the underlying asset of the given market | |
* @param cToken The market to verify the borrow against | |
* @param borrower The account which would borrow the asset | |
* @param borrowAmount The amount of underlying the account would borrow | |
* @return 0 if the borrow is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!borrowGuardianPaused, "borrow is paused"); | |
if (!markets[cToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// *may include Policy Hook-type checks | |
if (!markets[cToken].accountMembership[borrower]) { | |
// only cTokens may call borrowAllowed if borrower not in market | |
require(msg.sender == cToken, "sender must be cToken"); | |
// attempt to add borrower to the market | |
Error err = addToMarketInternal(CToken(msg.sender), borrower); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
// it should be impossible to break the important invariant | |
assert(markets[cToken].accountMembership[borrower]); | |
} | |
if (oracle.getUnderlyingPrice(CToken(cToken)) == 0) { | |
return uint(Error.PRICE_ERROR); | |
} | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, CToken(cToken), 0, borrowAmount); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
if (shortfall > 0) { | |
return uint(Error.INSUFFICIENT_LIQUIDITY); | |
} | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates borrow and reverts on rejection. May emit logs. | |
* @param cToken Asset whose underlying is being borrowed | |
* @param borrower The address borrowing the underlying | |
* @param borrowAmount The amount of the underlying asset requested to borrow | |
*/ | |
function borrowVerify(address cToken, address borrower, uint borrowAmount) external { | |
// Shh - currently unused | |
cToken; | |
borrower; | |
borrowAmount; | |
// Shh - we don't ever want this hook to be marked pure | |
if (false) { | |
maxAssets = maxAssets; | |
} | |
} | |
/** | |
* @notice Checks if the account should be allowed to repay a borrow in the given market | |
* @param cToken The market to verify the repay against | |
* @param payer The account which would repay the asset | |
* @param borrower The account which would borrowed the asset | |
* @param repayAmount The amount of the underlying asset the account would repay | |
* @return 0 if the repay is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function repayBorrowAllowed( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external returns (uint) { | |
// Shh - currently unused | |
payer; | |
borrower; | |
repayAmount; | |
if (!markets[cToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// *may include Policy Hook-type checks | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates repayBorrow and reverts on rejection. May emit logs. | |
* @param cToken Asset being repaid | |
* @param payer The address repaying the borrow | |
* @param borrower The address of the borrower | |
* @param repayAmount The amount of underlying being repaid | |
*/ | |
function repayBorrowVerify( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount, | |
uint borrowerIndex) external { | |
// Shh - currently unused | |
cToken; | |
payer; | |
borrower; | |
repayAmount; | |
borrowerIndex; | |
// Shh - we don't ever want this hook to be marked pure | |
if (false) { | |
maxAssets = maxAssets; | |
} | |
} | |
/** | |
* @notice Checks if the liquidation should be allowed to occur | |
* @param cTokenBorrowed Asset which was borrowed by the borrower | |
* @param cTokenCollateral Asset which was used as collateral and will be seized | |
* @param liquidator The address repaying the borrow and seizing the collateral | |
* @param borrower The address of the borrower | |
* @param repayAmount The amount of underlying being repaid | |
*/ | |
function liquidateBorrowAllowed( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external returns (uint) { | |
// Shh - currently unused | |
liquidator; | |
if (!markets[cTokenBorrowed].isListed || !markets[cTokenCollateral].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// *may include Policy Hook-type checks | |
/* The borrower must have shortfall in order to be liquidatable */ | |
(Error err, , uint shortfall) = getAccountLiquidityInternal(borrower); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
if (shortfall == 0) { | |
return uint(Error.INSUFFICIENT_SHORTFALL); | |
} | |
/* The liquidator may not repay more than what is allowed by the closeFactor */ | |
uint borrowBalance = CToken(cTokenBorrowed).borrowBalanceStored(borrower); | |
(MathError mathErr, uint maxClose) = mulScalarTruncate(Exp({mantissa: closeFactorMantissa}), borrowBalance); | |
if (mathErr != MathError.NO_ERROR) { | |
return uint(Error.MATH_ERROR); | |
} | |
if (repayAmount > maxClose) { | |
return uint(Error.TOO_MUCH_REPAY); | |
} | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates liquidateBorrow and reverts on rejection. May emit logs. | |
* @param cTokenBorrowed Asset which was borrowed by the borrower | |
* @param cTokenCollateral Asset which was used as collateral and will be seized | |
* @param liquidator The address repaying the borrow and seizing the collateral | |
* @param borrower The address of the borrower | |
* @param repayAmount The amount of underlying being repaid | |
*/ | |
function liquidateBorrowVerify( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
cTokenBorrowed; | |
cTokenCollateral; | |
liquidator; | |
borrower; | |
repayAmount; | |
seizeTokens; | |
// Shh - we don't ever want this hook to be marked pure | |
if (false) { | |
maxAssets = maxAssets; | |
} | |
} | |
/** | |
* @notice Checks if the seizing of assets should be allowed to occur | |
* @param cTokenCollateral Asset which was used as collateral and will be seized | |
* @param cTokenBorrowed Asset which was borrowed by the borrower | |
* @param liquidator The address repaying the borrow and seizing the collateral | |
* @param borrower The address of the borrower | |
* @param seizeTokens The number of collateral tokens to seize | |
*/ | |
function seizeAllowed( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!seizeGuardianPaused, "seize is paused"); | |
// Shh - currently unused | |
liquidator; | |
borrower; | |
seizeTokens; | |
if (!markets[cTokenCollateral].isListed || !markets[cTokenBorrowed].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
if (CToken(cTokenCollateral).comptroller() != CToken(cTokenBorrowed).comptroller()) { | |
return uint(Error.COMPTROLLER_MISMATCH); | |
} | |
// *may include Policy Hook-type checks | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates seize and reverts on rejection. May emit logs. | |
* @param cTokenCollateral Asset which was used as collateral and will be seized | |
* @param cTokenBorrowed Asset which was borrowed by the borrower | |
* @param liquidator The address repaying the borrow and seizing the collateral | |
* @param borrower The address of the borrower | |
* @param seizeTokens The number of collateral tokens to seize | |
*/ | |
function seizeVerify( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
cTokenCollateral; | |
cTokenBorrowed; | |
liquidator; | |
borrower; | |
seizeTokens; | |
// Shh - we don't ever want this hook to be marked pure | |
if (false) { | |
maxAssets = maxAssets; | |
} | |
} | |
/** | |
* @notice Checks if the account should be allowed to transfer tokens in the given market | |
* @param cToken The market to verify the transfer against | |
* @param src The account which sources the tokens | |
* @param dst The account which receives the tokens | |
* @param transferTokens The number of cTokens to transfer | |
* @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!transferGuardianPaused, "transfer is paused"); | |
// Shh - currently unused | |
dst; | |
// *may include Policy Hook-type checks | |
// Currently the only consideration is whether or not | |
// the src is allowed to redeem this many tokens | |
return redeemAllowedInternal(cToken, src, transferTokens); | |
} | |
/** | |
* @notice Validates transfer and reverts on rejection. May emit logs. | |
* @param cToken Asset being transferred | |
* @param src The account which sources the tokens | |
* @param dst The account which receives the tokens | |
* @param transferTokens The number of cTokens to transfer | |
*/ | |
function transferVerify(address cToken, address src, address dst, uint transferTokens) external { | |
// Shh - currently unused | |
cToken; | |
src; | |
dst; | |
transferTokens; | |
// Shh - we don't ever want this hook to be marked pure | |
if (false) { | |
maxAssets = maxAssets; | |
} | |
} | |
/*** Liquidity/Liquidation Calculations ***/ | |
/** | |
* @dev Local vars for avoiding stack-depth limits in calculating account liquidity. | |
* Note that `cTokenBalance` is the number of cTokens the account owns in the market, | |
* whereas `borrowBalance` is the amount of underlying that the account has borrowed. | |
*/ | |
struct AccountLiquidityLocalVars { | |
uint sumCollateral; | |
uint sumBorrowPlusEffects; | |
uint cTokenBalance; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
uint oraclePriceMantissa; | |
Exp collateralFactor; | |
Exp exchangeRate; | |
Exp oraclePrice; | |
Exp tokensToEther; | |
} | |
/** | |
* @notice Determine the current account liquidity wrt collateral requirements | |
* @return (possible error code (semi-opaque), | |
account liquidity in excess of collateral requirements, | |
* account shortfall below collateral requirements) | |
*/ | |
function getAccountLiquidity(address account) public view returns (uint, uint, uint) { | |
(Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); | |
return (uint(err), liquidity, shortfall); | |
} | |
/** | |
* @notice Determine the current account liquidity wrt collateral requirements | |
* @return (possible error code, | |
account liquidity in excess of collateral requirements, | |
* account shortfall below collateral requirements) | |
*/ | |
function getAccountLiquidityInternal(address account) internal view returns (Error, uint, uint) { | |
return getHypotheticalAccountLiquidityInternal(account, CToken(0), 0, 0); | |
} | |
/** | |
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed | |
* @param cTokenModify The market to hypothetically redeem/borrow in | |
* @param account The account to determine liquidity for | |
* @param redeemTokens The number of tokens to hypothetically redeem | |
* @param borrowAmount The amount of underlying to hypothetically borrow | |
* @dev Note that we calculate the exchangeRateStored for each collateral cToken using stored data, | |
* without calculating accumulated interest. | |
* @return (possible error code, | |
hypothetical account liquidity in excess of collateral requirements, | |
* hypothetical account shortfall below collateral requirements) | |
*/ | |
function getHypotheticalAccountLiquidityInternal( | |
address account, | |
CToken cTokenModify, | |
uint redeemTokens, | |
uint borrowAmount) internal view returns (Error, uint, uint) { | |
AccountLiquidityLocalVars memory vars; // Holds all our calculation results | |
uint oErr; | |
MathError mErr; | |
// For each asset the account is in | |
CToken[] memory assets = accountAssets[account]; | |
for (uint i = 0; i < assets.length; i++) { | |
CToken asset = assets[i]; | |
// Read the balances and exchange rate from the cToken | |
(oErr, vars.cTokenBalance, vars.borrowBalance, vars.exchangeRateMantissa) = asset.getAccountSnapshot(account); | |
if (oErr != 0) { // semi-opaque error code, we assume NO_ERROR == 0 is invariant between upgrades | |
return (Error.SNAPSHOT_ERROR, 0, 0); | |
} | |
vars.collateralFactor = Exp({mantissa: markets[address(asset)].collateralFactorMantissa}); | |
vars.exchangeRate = Exp({mantissa: vars.exchangeRateMantissa}); | |
// Get the normalized price of the asset | |
vars.oraclePriceMantissa = oracle.getUnderlyingPrice(asset); | |
if (vars.oraclePriceMantissa == 0) { | |
return (Error.PRICE_ERROR, 0, 0); | |
} | |
vars.oraclePrice = Exp({mantissa: vars.oraclePriceMantissa}); | |
// Pre-compute a conversion factor from tokens -> ether (normalized price value) | |
(mErr, vars.tokensToEther) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
// sumCollateral += tokensToEther * cTokenBalance | |
(mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToEther, vars.cTokenBalance, vars.sumCollateral); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
// sumBorrowPlusEffects += oraclePrice * borrowBalance | |
(mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, vars.borrowBalance, vars.sumBorrowPlusEffects); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
// Calculate effects of interacting with cTokenModify | |
if (asset == cTokenModify) { | |
// redeem effect | |
// sumBorrowPlusEffects += tokensToEther * redeemTokens | |
(mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToEther, redeemTokens, vars.sumBorrowPlusEffects); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
// borrow effect | |
// sumBorrowPlusEffects += oraclePrice * borrowAmount | |
(mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, borrowAmount, vars.sumBorrowPlusEffects); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
} | |
} | |
// These are safe, as the underflow condition is checked first | |
if (vars.sumCollateral > vars.sumBorrowPlusEffects) { | |
return (Error.NO_ERROR, vars.sumCollateral - vars.sumBorrowPlusEffects, 0); | |
} else { | |
return (Error.NO_ERROR, 0, vars.sumBorrowPlusEffects - vars.sumCollateral); | |
} | |
} | |
/** | |
* @notice Calculate number of tokens of collateral asset to seize given an underlying amount | |
* @dev Used in liquidation (called in cToken.liquidateBorrowFresh) | |
* @param cTokenBorrowed The address of the borrowed cToken | |
* @param cTokenCollateral The address of the collateral cToken | |
* @param repayAmount The amount of cTokenBorrowed underlying to convert into cTokenCollateral tokens | |
* @return (errorCode, number of cTokenCollateral tokens to be seized in a liquidation) | |
*/ | |
function liquidateCalculateSeizeTokens(address cTokenBorrowed, address cTokenCollateral, uint repayAmount) external view returns (uint, uint) { | |
/* Read oracle prices for borrowed and collateral markets */ | |
uint priceBorrowedMantissa = oracle.getUnderlyingPrice(CToken(cTokenBorrowed)); | |
uint priceCollateralMantissa = oracle.getUnderlyingPrice(CToken(cTokenCollateral)); | |
if (priceBorrowedMantissa == 0 || priceCollateralMantissa == 0) { | |
return (uint(Error.PRICE_ERROR), 0); | |
} | |
/* | |
* Get the exchange rate and calculate the number of collateral tokens to seize: | |
* seizeAmount = repayAmount * liquidationIncentive * priceBorrowed / priceCollateral | |
* seizeTokens = seizeAmount / exchangeRate | |
* = repayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) | |
*/ | |
uint exchangeRateMantissa = CToken(cTokenCollateral).exchangeRateStored(); // Note: reverts on error | |
uint seizeTokens; | |
Exp memory numerator; | |
Exp memory denominator; | |
Exp memory ratio; | |
MathError mathErr; | |
(mathErr, numerator) = mulExp(liquidationIncentiveMantissa, priceBorrowedMantissa); | |
if (mathErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
(mathErr, denominator) = mulExp(priceCollateralMantissa, exchangeRateMantissa); | |
if (mathErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
(mathErr, ratio) = divExp(numerator, denominator); | |
if (mathErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
(mathErr, seizeTokens) = mulScalarTruncate(ratio, repayAmount); | |
if (mathErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
return (uint(Error.NO_ERROR), seizeTokens); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Sets a new price oracle for the comptroller | |
* @dev Admin function to set a new price oracle | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPriceOracle(PriceOracle newOracle) public returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PRICE_ORACLE_OWNER_CHECK); | |
} | |
// Track the old oracle for the comptroller | |
PriceOracle oldOracle = oracle; | |
// Set comptroller's oracle to newOracle | |
oracle = newOracle; | |
// Emit NewPriceOracle(oldOracle, newOracle) | |
emit NewPriceOracle(oldOracle, newOracle); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets the closeFactor used when liquidating borrows | |
* @dev Admin function to set closeFactor | |
* @param newCloseFactorMantissa New close factor, scaled by 1e18 | |
* @return uint 0=success, otherwise a failure. (See ErrorReporter for details) | |
*/ | |
function _setCloseFactor(uint newCloseFactorMantissa) external returns (uint256) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_CLOSE_FACTOR_OWNER_CHECK); | |
} | |
Exp memory newCloseFactorExp = Exp({mantissa: newCloseFactorMantissa}); | |
Exp memory lowLimit = Exp({mantissa: closeFactorMinMantissa}); | |
if (lessThanOrEqualExp(newCloseFactorExp, lowLimit)) { | |
return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); | |
} | |
Exp memory highLimit = Exp({mantissa: closeFactorMaxMantissa}); | |
if (lessThanExp(highLimit, newCloseFactorExp)) { | |
return fail(Error.INVALID_CLOSE_FACTOR, FailureInfo.SET_CLOSE_FACTOR_VALIDATION); | |
} | |
uint oldCloseFactorMantissa = closeFactorMantissa; | |
closeFactorMantissa = newCloseFactorMantissa; | |
emit NewCloseFactor(oldCloseFactorMantissa, closeFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets the collateralFactor for a market | |
* @dev Admin function to set per-market collateralFactor | |
* @param cToken The market to set the factor on | |
* @param newCollateralFactorMantissa The new collateral factor, scaled by 1e18 | |
* @return uint 0=success, otherwise a failure. (See ErrorReporter for details) | |
*/ | |
function _setCollateralFactor(CToken cToken, uint newCollateralFactorMantissa) external returns (uint256) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COLLATERAL_FACTOR_OWNER_CHECK); | |
} | |
// Verify market is listed | |
Market storage market = markets[address(cToken)]; | |
if (!market.isListed) { | |
return fail(Error.MARKET_NOT_LISTED, FailureInfo.SET_COLLATERAL_FACTOR_NO_EXISTS); | |
} | |
Exp memory newCollateralFactorExp = Exp({mantissa: newCollateralFactorMantissa}); | |
// Check collateral factor <= 0.9 | |
Exp memory highLimit = Exp({mantissa: collateralFactorMaxMantissa}); | |
if (lessThanExp(highLimit, newCollateralFactorExp)) { | |
return fail(Error.INVALID_COLLATERAL_FACTOR, FailureInfo.SET_COLLATERAL_FACTOR_VALIDATION); | |
} | |
// If collateral factor != 0, fail if price == 0 | |
if (newCollateralFactorMantissa != 0 && oracle.getUnderlyingPrice(cToken) == 0) { | |
return fail(Error.PRICE_ERROR, FailureInfo.SET_COLLATERAL_FACTOR_WITHOUT_PRICE); | |
} | |
// Set market's collateral factor to new collateral factor, remember old value | |
uint oldCollateralFactorMantissa = market.collateralFactorMantissa; | |
market.collateralFactorMantissa = newCollateralFactorMantissa; | |
// Emit event with asset, old collateral factor, and new collateral factor | |
emit NewCollateralFactor(cToken, oldCollateralFactorMantissa, newCollateralFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets maxAssets which controls how many markets can be entered | |
* @dev Admin function to set maxAssets | |
* @param newMaxAssets New max assets | |
* @return uint 0=success, otherwise a failure. (See ErrorReporter for details) | |
*/ | |
function _setMaxAssets(uint newMaxAssets) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_MAX_ASSETS_OWNER_CHECK); | |
} | |
uint oldMaxAssets = maxAssets; | |
maxAssets = newMaxAssets; | |
emit NewMaxAssets(oldMaxAssets, newMaxAssets); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets liquidationIncentive | |
* @dev Admin function to set liquidationIncentive | |
* @param newLiquidationIncentiveMantissa New liquidationIncentive scaled by 1e18 | |
* @return uint 0=success, otherwise a failure. (See ErrorReporter for details) | |
*/ | |
function _setLiquidationIncentive(uint newLiquidationIncentiveMantissa) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_LIQUIDATION_INCENTIVE_OWNER_CHECK); | |
} | |
// Check de-scaled min <= newLiquidationIncentive <= max | |
Exp memory newLiquidationIncentive = Exp({mantissa: newLiquidationIncentiveMantissa}); | |
Exp memory minLiquidationIncentive = Exp({mantissa: liquidationIncentiveMinMantissa}); | |
if (lessThanExp(newLiquidationIncentive, minLiquidationIncentive)) { | |
return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); | |
} | |
Exp memory maxLiquidationIncentive = Exp({mantissa: liquidationIncentiveMaxMantissa}); | |
if (lessThanExp(maxLiquidationIncentive, newLiquidationIncentive)) { | |
return fail(Error.INVALID_LIQUIDATION_INCENTIVE, FailureInfo.SET_LIQUIDATION_INCENTIVE_VALIDATION); | |
} | |
// Save current value for use in log | |
uint oldLiquidationIncentiveMantissa = liquidationIncentiveMantissa; | |
// Set liquidation incentive to new incentive | |
liquidationIncentiveMantissa = newLiquidationIncentiveMantissa; | |
// Emit event with old incentive, new incentive | |
emit NewLiquidationIncentive(oldLiquidationIncentiveMantissa, newLiquidationIncentiveMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Add the market to the markets mapping and set it as listed | |
* @dev Admin function to set isListed and add support for the market | |
* @param cToken The address of the market (token) to list | |
* @return uint 0=success, otherwise a failure. (See enum Error for details) | |
*/ | |
function _supportMarket(CToken cToken) external returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); | |
} | |
if (markets[address(cToken)].isListed) { | |
return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); | |
} | |
cToken.isCToken(); // Sanity check to make sure its really a CToken | |
markets[address(cToken)] = Market({isListed: true, collateralFactorMantissa: 0}); | |
emit MarketListed(cToken); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Admin function to change the Pause Guardian | |
* @param newPauseGuardian The address of the new Pause Guardian | |
* @return uint 0=success, otherwise a failure. (See enum Error for details) | |
*/ | |
function _setPauseGuardian(address newPauseGuardian) public returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PAUSE_GUARDIAN_OWNER_CHECK); | |
} | |
// Save current value for inclusion in log | |
address oldPauseGuardian = pauseGuardian; | |
// Store pauseGuardian with value newPauseGuardian | |
pauseGuardian = newPauseGuardian; | |
// Emit NewPauseGuardian(OldPauseGuardian, NewPauseGuardian) | |
emit NewPauseGuardian(oldPauseGuardian, pauseGuardian); | |
return uint(Error.NO_ERROR); | |
} | |
function _setMintPaused(bool state) public returns (bool) { | |
require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); | |
require(msg.sender == admin || state == true, "only admin can unpause"); | |
mintGuardianPaused = state; | |
emit ActionPaused("Mint", state); | |
return state; | |
} | |
function _setBorrowPaused(bool state) public returns (bool) { | |
require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); | |
require(msg.sender == admin || state == true, "only admin can unpause"); | |
borrowGuardianPaused = state; | |
emit ActionPaused("Borrow", state); | |
return state; | |
} | |
function _setTransferPaused(bool state) public returns (bool) { | |
require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); | |
require(msg.sender == admin || state == true, "only admin can unpause"); | |
transferGuardianPaused = state; | |
emit ActionPaused("Transfer", state); | |
return state; | |
} | |
function _setSeizePaused(bool state) public returns (bool) { | |
require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can pause"); | |
require(msg.sender == admin || state == true, "only admin can unpause"); | |
seizeGuardianPaused = state; | |
emit ActionPaused("Seize", state); | |
return state; | |
} | |
function _become(Unitroller unitroller) public { | |
require(msg.sender == unitroller.admin(), "only unitroller admin can change brains"); | |
uint changeStatus = unitroller._acceptImplementation(); | |
require(changeStatus == 0, "change not authorized"); | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// SPDX-License-Identifier: MIT | |
pragma solidity 0.6.12; | |
import "https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v3.4.1/contracts/token/ERC20/ERC20.sol"; | |
import "https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v3.4.1/contracts/access/Ownable.sol"; | |
// Denarius with Governance. | |
contract Denarius is ERC20('T Token', 'Tee'), Ownable { | |
// Creating initial supply on 200m | |
constructor() public { | |
_mint(msg.sender, (200*(10 ** 6))* (10 ** uint256(decimals()))); | |
} | |
/// @notice Creates `_amount` token to `_to`. Must only be called by the owner (MasterChef). | |
function mint(address _to, uint256 _amount) public onlyOwner { | |
_mint(_to, _amount); | |
_moveDelegates(address(0), _delegates[_to], _amount); | |
} | |
// Copied and modified from YAM code: | |
// https://github.com/yam-finance/yam-protocol/blob/master/contracts/token/YAMGovernanceStorage.sol | |
// https://github.com/yam-finance/yam-protocol/blob/master/contracts/token/YAMGovernance.sol | |
// Which is copied and modified from COMPOUND: | |
// https://github.com/compound-finance/compound-protocol/blob/master/contracts/Governance/Comp.sol | |
mapping (address => address) internal _delegates; | |
/// @notice A checkpoint for marking number of votes from a given block | |
struct Checkpoint { | |
uint32 fromBlock; | |
uint256 votes; | |
} | |
/// @notice A record of votes checkpoints for each account, by index | |
mapping (address => mapping (uint32 => Checkpoint)) public checkpoints; | |
/// @notice The number of checkpoints for each account | |
mapping (address => uint32) public numCheckpoints; | |
/// @notice The EIP-712 typehash for the contract's domain | |
bytes32 public constant DOMAIN_TYPEHASH = keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)"); | |
/// @notice The EIP-712 typehash for the delegation struct used by the contract | |
bytes32 public constant DELEGATION_TYPEHASH = keccak256("Delegation(address delegatee,uint256 nonce,uint256 expiry)"); | |
/// @notice A record of states for signing / validating signatures | |
mapping (address => uint) public nonces; | |
/// @notice An event thats emitted when an account changes its delegate | |
event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate); | |
/// @notice An event thats emitted when a delegate account's vote balance changes | |
event DelegateVotesChanged(address indexed delegate, uint previousBalance, uint newBalance); | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegator The address to get delegatee for | |
*/ | |
function delegates(address delegator) | |
external | |
view | |
returns (address) | |
{ | |
return _delegates[delegator]; | |
} | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegatee The address to delegate votes to | |
*/ | |
function delegate(address delegatee) external { | |
return _delegate(msg.sender, delegatee); | |
} | |
/** | |
* @notice Delegates votes from signatory to `delegatee` | |
* @param delegatee The address to delegate votes to | |
* @param nonce The contract state required to match the signature | |
* @param expiry The time at which to expire the signature | |
* @param v The recovery byte of the signature | |
* @param r Half of the ECDSA signature pair | |
* @param s Half of the ECDSA signature pair | |
*/ | |
function delegateBySig( | |
address delegatee, | |
uint nonce, | |
uint expiry, | |
uint8 v, | |
bytes32 r, | |
bytes32 s | |
) | |
external | |
{ | |
bytes32 domainSeparator = keccak256( | |
abi.encode( | |
DOMAIN_TYPEHASH, | |
keccak256(bytes(name())), | |
getChainId(), | |
address(this) | |
) | |
); | |
bytes32 structHash = keccak256( | |
abi.encode( | |
DELEGATION_TYPEHASH, | |
delegatee, | |
nonce, | |
expiry | |
) | |
); | |
bytes32 digest = keccak256( | |
abi.encodePacked( | |
"\x19\x01", | |
domainSeparator, | |
structHash | |
) | |
); | |
address signatory = ecrecover(digest, v, r, s); | |
require(signatory != address(0), "DENA::delegateBySig: invalid signature"); | |
require(nonce == nonces[signatory]++, "DENA::delegateBySig: invalid nonce"); | |
require(now <= expiry, "DENA::delegateBySig: signature expired"); | |
return _delegate(signatory, delegatee); | |
} | |
/** | |
* @notice Gets the current votes balance for `account` | |
* @param account The address to get votes balance | |
* @return The number of current votes for `account` | |
*/ | |
function getCurrentVotes(address account) | |
external | |
view | |
returns (uint256) | |
{ | |
uint32 nCheckpoints = numCheckpoints[account]; | |
return nCheckpoints > 0 ? checkpoints[account][nCheckpoints - 1].votes : 0; | |
} | |
/** | |
* @notice Determine the prior number of votes for an account as of a block number | |
* @dev Block number must be a finalized block or else this function will revert to prevent misinformation. | |
* @param account The address of the account to check | |
* @param blockNumber The block number to get the vote balance at | |
* @return The number of votes the account had as of the given block | |
*/ | |
function getPriorVotes(address account, uint blockNumber) | |
external | |
view | |
returns (uint256) | |
{ | |
require(blockNumber < block.number, "DENA::getPriorVotes: not yet determined"); | |
uint32 nCheckpoints = numCheckpoints[account]; | |
if (nCheckpoints == 0) { | |
return 0; | |
} | |
// First check most recent balance | |
if (checkpoints[account][nCheckpoints - 1].fromBlock <= blockNumber) { | |
return checkpoints[account][nCheckpoints - 1].votes; | |
} | |
// Next check implicit zero balance | |
if (checkpoints[account][0].fromBlock > blockNumber) { | |
return 0; | |
} | |
uint32 lower = 0; | |
uint32 upper = nCheckpoints - 1; | |
while (upper > lower) { | |
uint32 center = upper - (upper - lower) / 2; // ceil, avoiding overflow | |
Checkpoint memory cp = checkpoints[account][center]; | |
if (cp.fromBlock == blockNumber) { | |
return cp.votes; | |
} else if (cp.fromBlock < blockNumber) { | |
lower = center; | |
} else { | |
upper = center - 1; | |
} | |
} | |
return checkpoints[account][lower].votes; | |
} | |
function _delegate(address delegator, address delegatee) | |
internal | |
{ | |
address currentDelegate = _delegates[delegator]; | |
uint256 delegatorBalance = balanceOf(delegator); // balance of underlying DENAs (not scaled); | |
_delegates[delegator] = delegatee; | |
emit DelegateChanged(delegator, currentDelegate, delegatee); | |
_moveDelegates(currentDelegate, delegatee, delegatorBalance); | |
} | |
function _moveDelegates(address srcRep, address dstRep, uint256 amount) internal { | |
if (srcRep != dstRep && amount > 0) { | |
if (srcRep != address(0)) { | |
// decrease old representative | |
uint32 srcRepNum = numCheckpoints[srcRep]; | |
uint256 srcRepOld = srcRepNum > 0 ? checkpoints[srcRep][srcRepNum - 1].votes : 0; | |
uint256 srcRepNew = srcRepOld.sub(amount); | |
_writeCheckpoint(srcRep, srcRepNum, srcRepOld, srcRepNew); | |
} | |
if (dstRep != address(0)) { | |
// increase new representative | |
uint32 dstRepNum = numCheckpoints[dstRep]; | |
uint256 dstRepOld = dstRepNum > 0 ? checkpoints[dstRep][dstRepNum - 1].votes : 0; | |
uint256 dstRepNew = dstRepOld.add(amount); | |
_writeCheckpoint(dstRep, dstRepNum, dstRepOld, dstRepNew); | |
} | |
} | |
} | |
function _writeCheckpoint( | |
address delegatee, | |
uint32 nCheckpoints, | |
uint256 oldVotes, | |
uint256 newVotes | |
) | |
internal | |
{ | |
uint32 blockNumber = safe32(block.number, "DENA::_writeCheckpoint: block number exceeds 32 bits"); | |
if (nCheckpoints > 0 && checkpoints[delegatee][nCheckpoints - 1].fromBlock == blockNumber) { | |
checkpoints[delegatee][nCheckpoints - 1].votes = newVotes; | |
} else { | |
checkpoints[delegatee][nCheckpoints] = Checkpoint(blockNumber, newVotes); | |
numCheckpoints[delegatee] = nCheckpoints + 1; | |
} | |
emit DelegateVotesChanged(delegatee, oldVotes, newVotes); | |
} | |
function safe32(uint n, string memory errorMessage) internal pure returns (uint32) { | |
require(n < 2**32, errorMessage); | |
return uint32(n); | |
} | |
function getChainId() internal pure returns (uint) { | |
uint256 chainId; | |
assembly { chainId := chainid() } | |
return chainId; | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// File: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v3.4.1/contracts/math/SafeMath.sol | |
pragma solidity >=0.6.0 <0.8.0; | |
/** | |
* @dev Wrappers over Solidity's arithmetic operations with added overflow | |
* checks. | |
* | |
* Arithmetic operations in Solidity wrap on overflow. This can easily result | |
* in bugs, because programmers usually assume that an overflow raises an | |
* error, which is the standard behavior in high level programming languages. | |
* `SafeMath` restores this intuition by reverting the transaction when an | |
* operation overflows. | |
* | |
* Using this library instead of the unchecked operations eliminates an entire | |
* class of bugs, so it's recommended to use it always. | |
*/ | |
library SafeMath { | |
/** | |
* @dev Returns the addition of two unsigned integers, with an overflow flag. | |
* | |
* _Available since v3.4._ | |
*/ | |
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) { | |
uint256 c = a + b; | |
if (c < a) return (false, 0); | |
return (true, c); | |
} | |
/** | |
* @dev Returns the substraction of two unsigned integers, with an overflow flag. | |
* | |
* _Available since v3.4._ | |
*/ | |
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) { | |
if (b > a) return (false, 0); | |
return (true, a - b); | |
} | |
/** | |
* @dev Returns the multiplication of two unsigned integers, with an overflow flag. | |
* | |
* _Available since v3.4._ | |
*/ | |
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) { | |
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the | |
// benefit is lost if 'b' is also tested. | |
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 | |
if (a == 0) return (true, 0); | |
uint256 c = a * b; | |
if (c / a != b) return (false, 0); | |
return (true, c); | |
} | |
/** | |
* @dev Returns the division of two unsigned integers, with a division by zero flag. | |
* | |
* _Available since v3.4._ | |
*/ | |
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) { | |
if (b == 0) return (false, 0); | |
return (true, a / b); | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag. | |
* | |
* _Available since v3.4._ | |
*/ | |
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) { | |
if (b == 0) return (false, 0); | |
return (true, a % b); | |
} | |
/** | |
* @dev Returns the addition of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `+` operator. | |
* | |
* Requirements: | |
* | |
* - Addition cannot overflow. | |
*/ | |
function add(uint256 a, uint256 b) internal pure returns (uint256) { | |
uint256 c = a + b; | |
require(c >= a, "SafeMath: addition overflow"); | |
return c; | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b) internal pure returns (uint256) { | |
require(b <= a, "SafeMath: subtraction overflow"); | |
return a - b; | |
} | |
/** | |
* @dev Returns the multiplication of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `*` operator. | |
* | |
* Requirements: | |
* | |
* - Multiplication cannot overflow. | |
*/ | |
function mul(uint256 a, uint256 b) internal pure returns (uint256) { | |
if (a == 0) return 0; | |
uint256 c = a * b; | |
require(c / a == b, "SafeMath: multiplication overflow"); | |
return c; | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers, reverting on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b) internal pure returns (uint256) { | |
require(b > 0, "SafeMath: division by zero"); | |
return a / b; | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* reverting when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b) internal pure returns (uint256) { | |
require(b > 0, "SafeMath: modulo by zero"); | |
return a % b; | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on | |
* overflow (when the result is negative). | |
* | |
* CAUTION: This function is deprecated because it requires allocating memory for the error | |
* message unnecessarily. For custom revert reasons use {trySub}. | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b <= a, errorMessage); | |
return a - b; | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers, reverting with custom message on | |
* division by zero. The result is rounded towards zero. | |
* | |
* CAUTION: This function is deprecated because it requires allocating memory for the error | |
* message unnecessarily. For custom revert reasons use {tryDiv}. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b > 0, errorMessage); | |
return a / b; | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* reverting with custom message when dividing by zero. | |
* | |
* CAUTION: This function is deprecated because it requires allocating memory for the error | |
* message unnecessarily. For custom revert reasons use {tryMod}. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b > 0, errorMessage); | |
return a % b; | |
} | |
} | |
// File: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v3.4.1/contracts/token/ERC20/IERC20.sol | |
pragma solidity >=0.6.0 <0.8.0; | |
/** | |
* @dev Interface of the ERC20 standard as defined in the EIP. | |
*/ | |
interface IERC20 { | |
/** | |
* @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 `recipient`. | |
* | |
* Returns a boolean value indicating whether the operation succeeded. | |
* | |
* Emits a {Transfer} event. | |
*/ | |
function transfer(address recipient, 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 `sender` to `recipient` 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 sender, address recipient, uint256 amount) external returns (bool); | |
/** | |
* @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); | |
} | |
// File: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v3.4.1/contracts/utils/Context.sol | |
pragma solidity >=0.6.0 <0.8.0; | |
/* | |
* @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 GSN 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 Context { | |
function _msgSender() internal view virtual returns (address payable) { | |
return msg.sender; | |
} | |
function _msgData() internal view virtual returns (bytes memory) { | |
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691 | |
return msg.data; | |
} | |
} | |
// File: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v3.4.1/contracts/access/Ownable.sol | |
pragma solidity >=0.6.0 <0.8.0; | |
/** | |
* @dev Contract module which provides a basic access control mechanism, where | |
* there is an account (an owner) that can be granted exclusive access to | |
* specific functions. | |
* | |
* By default, the owner account will be the one that deploys the contract. This | |
* can later be changed with {transferOwnership}. | |
* | |
* This module is used through inheritance. It will make available the modifier | |
* `onlyOwner`, which can be applied to your functions to restrict their use to | |
* the owner. | |
*/ | |
abstract contract Ownable is Context { | |
address private _owner; | |
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); | |
/** | |
* @dev Initializes the contract setting the deployer as the initial owner. | |
*/ | |
constructor () internal { | |
address msgSender = _msgSender(); | |
_owner = msgSender; | |
emit OwnershipTransferred(address(0), msgSender); | |
} | |
/** | |
* @dev Returns the address of the current owner. | |
*/ | |
function owner() public view virtual returns (address) { | |
return _owner; | |
} | |
/** | |
* @dev Throws if called by any account other than the owner. | |
*/ | |
modifier onlyOwner() { | |
require(owner() == _msgSender(), "Ownable: caller is not the owner"); | |
_; | |
} | |
/** | |
* @dev Leaves the contract without owner. It will not be possible to call | |
* `onlyOwner` functions anymore. Can only be called by the current owner. | |
* | |
* NOTE: Renouncing ownership will leave the contract without an owner, | |
* thereby removing any functionality that is only available to the owner. | |
*/ | |
function renounceOwnership() public virtual onlyOwner { | |
emit OwnershipTransferred(_owner, address(0)); | |
_owner = address(0); | |
} | |
/** | |
* @dev Transfers ownership of the contract to a new account (`newOwner`). | |
* Can only be called by the current owner. | |
*/ | |
function transferOwnership(address newOwner) public virtual onlyOwner { | |
require(newOwner != address(0), "Ownable: new owner is the zero address"); | |
emit OwnershipTransferred(_owner, newOwner); | |
_owner = newOwner; | |
} | |
} | |
// File: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v3.4.1/contracts/token/ERC20/ERC20.sol | |
pragma solidity >=0.6.0 <0.8.0; | |
/** | |
* @dev Implementation of the {IERC20} interface. | |
* | |
* This implementation is agnostic to the way tokens are created. This means | |
* that a supply mechanism has to be added in a derived contract using {_mint}. | |
* For a generic mechanism see {ERC20PresetMinterPauser}. | |
* | |
* TIP: For a detailed writeup see our guide | |
* https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How | |
* to implement supply mechanisms]. | |
* | |
* We have followed general OpenZeppelin guidelines: functions revert instead | |
* of returning `false` on failure. This behavior is nonetheless conventional | |
* and does not conflict with the expectations of ERC20 applications. | |
* | |
* Additionally, an {Approval} event is emitted on calls to {transferFrom}. | |
* This allows applications to reconstruct the allowance for all accounts just | |
* by listening to said events. Other implementations of the EIP may not emit | |
* these events, as it isn't required by the specification. | |
* | |
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance} | |
* functions have been added to mitigate the well-known issues around setting | |
* allowances. See {IERC20-approve}. | |
*/ | |
contract ERC20 is Context, IERC20 { | |
using SafeMath for uint256; | |
mapping (address => uint256) private _balances; | |
mapping (address => mapping (address => uint256)) private _allowances; | |
uint256 private _totalSupply; | |
string private _name; | |
string private _symbol; | |
uint8 private _decimals; | |
/** | |
* @dev Sets the values for {name} and {symbol}, initializes {decimals} with | |
* a default value of 18. | |
* | |
* To select a different value for {decimals}, use {_setupDecimals}. | |
* | |
* All three of these values are immutable: they can only be set once during | |
* construction. | |
*/ | |
constructor (string memory name_, string memory symbol_) public { | |
_name = name_; | |
_symbol = symbol_; | |
_decimals = 18; | |
} | |
/** | |
* @dev Returns the name of the token. | |
*/ | |
function name() public view virtual returns (string memory) { | |
return _name; | |
} | |
/** | |
* @dev Returns the symbol of the token, usually a shorter version of the | |
* name. | |
*/ | |
function symbol() public view virtual returns (string memory) { | |
return _symbol; | |
} | |
/** | |
* @dev Returns the number of decimals used to get its user representation. | |
* For example, if `decimals` equals `2`, a balance of `505` tokens should | |
* be displayed to a user as `5,05` (`505 / 10 ** 2`). | |
* | |
* Tokens usually opt for a value of 18, imitating the relationship between | |
* Ether and Wei. This is the value {ERC20} uses, unless {_setupDecimals} is | |
* called. | |
* | |
* NOTE: This information is only used for _display_ purposes: it in | |
* no way affects any of the arithmetic of the contract, including | |
* {IERC20-balanceOf} and {IERC20-transfer}. | |
*/ | |
function decimals() public view virtual returns (uint8) { | |
return _decimals; | |
} | |
/** | |
* @dev See {IERC20-totalSupply}. | |
*/ | |
function totalSupply() public view virtual override returns (uint256) { | |
return _totalSupply; | |
} | |
/** | |
* @dev See {IERC20-balanceOf}. | |
*/ | |
function balanceOf(address account) public view virtual override returns (uint256) { | |
return _balances[account]; | |
} | |
/** | |
* @dev See {IERC20-transfer}. | |
* | |
* Requirements: | |
* | |
* - `recipient` cannot be the zero address. | |
* - the caller must have a balance of at least `amount`. | |
*/ | |
function transfer(address recipient, uint256 amount) public virtual override returns (bool) { | |
_transfer(_msgSender(), recipient, amount); | |
return true; | |
} | |
/** | |
* @dev See {IERC20-allowance}. | |
*/ | |
function allowance(address owner, address spender) public view virtual override returns (uint256) { | |
return _allowances[owner][spender]; | |
} | |
/** | |
* @dev See {IERC20-approve}. | |
* | |
* Requirements: | |
* | |
* - `spender` cannot be the zero address. | |
*/ | |
function approve(address spender, uint256 amount) public virtual override returns (bool) { | |
_approve(_msgSender(), spender, amount); | |
return true; | |
} | |
/** | |
* @dev See {IERC20-transferFrom}. | |
* | |
* Emits an {Approval} event indicating the updated allowance. This is not | |
* required by the EIP. See the note at the beginning of {ERC20}. | |
* | |
* Requirements: | |
* | |
* - `sender` and `recipient` cannot be the zero address. | |
* - `sender` must have a balance of at least `amount`. | |
* - the caller must have allowance for ``sender``'s tokens of at least | |
* `amount`. | |
*/ | |
function transferFrom(address sender, address recipient, uint256 amount) public virtual override returns (bool) { | |
_transfer(sender, recipient, amount); | |
_approve(sender, _msgSender(), _allowances[sender][_msgSender()].sub(amount, "ERC20: transfer amount exceeds allowance")); | |
return true; | |
} | |
/** | |
* @dev Atomically increases the allowance granted to `spender` by the caller. | |
* | |
* This is an alternative to {approve} that can be used as a mitigation for | |
* problems described in {IERC20-approve}. | |
* | |
* Emits an {Approval} event indicating the updated allowance. | |
* | |
* Requirements: | |
* | |
* - `spender` cannot be the zero address. | |
*/ | |
function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) { | |
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].add(addedValue)); | |
return true; | |
} | |
/** | |
* @dev Atomically decreases the allowance granted to `spender` by the caller. | |
* | |
* This is an alternative to {approve} that can be used as a mitigation for | |
* problems described in {IERC20-approve}. | |
* | |
* Emits an {Approval} event indicating the updated allowance. | |
* | |
* Requirements: | |
* | |
* - `spender` cannot be the zero address. | |
* - `spender` must have allowance for the caller of at least | |
* `subtractedValue`. | |
*/ | |
function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) { | |
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].sub(subtractedValue, "ERC20: decreased allowance below zero")); | |
return true; | |
} | |
/** | |
* @dev Moves tokens `amount` from `sender` to `recipient`. | |
* | |
* This is internal function is equivalent to {transfer}, and can be used to | |
* e.g. implement automatic token fees, slashing mechanisms, etc. | |
* | |
* Emits a {Transfer} event. | |
* | |
* Requirements: | |
* | |
* - `sender` cannot be the zero address. | |
* - `recipient` cannot be the zero address. | |
* - `sender` must have a balance of at least `amount`. | |
*/ | |
function _transfer(address sender, address recipient, uint256 amount) internal virtual { | |
require(sender != address(0), "ERC20: transfer from the zero address"); | |
require(recipient != address(0), "ERC20: transfer to the zero address"); | |
_beforeTokenTransfer(sender, recipient, amount); | |
_balances[sender] = _balances[sender].sub(amount, "ERC20: transfer amount exceeds balance"); | |
_balances[recipient] = _balances[recipient].add(amount); | |
emit Transfer(sender, recipient, amount); | |
} | |
/** @dev Creates `amount` tokens and assigns them to `account`, increasing | |
* the total supply. | |
* | |
* Emits a {Transfer} event with `from` set to the zero address. | |
* | |
* Requirements: | |
* | |
* - `to` cannot be the zero address. | |
*/ | |
function _mint(address account, uint256 amount) internal virtual { | |
require(account != address(0), "ERC20: mint to the zero address"); | |
_beforeTokenTransfer(address(0), account, amount); | |
_totalSupply = _totalSupply.add(amount); | |
_balances[account] = _balances[account].add(amount); | |
emit Transfer(address(0), account, amount); | |
} | |
/** | |
* @dev Destroys `amount` tokens from `account`, reducing the | |
* total supply. | |
* | |
* Emits a {Transfer} event with `to` set to the zero address. | |
* | |
* Requirements: | |
* | |
* - `account` cannot be the zero address. | |
* - `account` must have at least `amount` tokens. | |
*/ | |
function _burn(address account, uint256 amount) internal virtual { | |
require(account != address(0), "ERC20: burn from the zero address"); | |
_beforeTokenTransfer(account, address(0), amount); | |
_balances[account] = _balances[account].sub(amount, "ERC20: burn amount exceeds balance"); | |
_totalSupply = _totalSupply.sub(amount); | |
emit Transfer(account, address(0), amount); | |
} | |
/** | |
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens. | |
* | |
* This internal function is equivalent to `approve`, and can be used to | |
* e.g. set automatic allowances for certain subsystems, etc. | |
* | |
* Emits an {Approval} event. | |
* | |
* Requirements: | |
* | |
* - `owner` cannot be the zero address. | |
* - `spender` cannot be the zero address. | |
*/ | |
function _approve(address owner, address spender, uint256 amount) internal virtual { | |
require(owner != address(0), "ERC20: approve from the zero address"); | |
require(spender != address(0), "ERC20: approve to the zero address"); | |
_allowances[owner][spender] = amount; | |
emit Approval(owner, spender, amount); | |
} | |
/** | |
* @dev Sets {decimals} to a value other than the default one of 18. | |
* | |
* WARNING: This function should only be called from the constructor. Most | |
* applications that interact with token contracts will not expect | |
* {decimals} to ever change, and may work incorrectly if it does. | |
*/ | |
function _setupDecimals(uint8 decimals_) internal virtual { | |
_decimals = decimals_; | |
} | |
/** | |
* @dev Hook that is called before any transfer of tokens. This includes | |
* minting and burning. | |
* | |
* Calling conditions: | |
* | |
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens | |
* will be to transferred to `to`. | |
* - when `from` is zero, `amount` tokens will be minted for `to`. | |
* - when `to` is zero, `amount` of ``from``'s tokens will be burned. | |
* - `from` and `to` are never both zero. | |
* | |
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. | |
*/ | |
function _beforeTokenTransfer(address from, address to, uint256 amount) internal virtual { } | |
} | |
// File: gist-c2555f63e0ad756e8ad58f3b7461f950/Dena.sol | |
pragma solidity 0.6.12; | |
// Denarius with Governance. | |
contract Denarius is ERC20('T Token', 'Tee'), Ownable { | |
// Creating initial supply on 200m | |
constructor() public { | |
_mint(msg.sender, (200*(10 ** 6))* (10 ** uint256(decimals()))); | |
} | |
/// @notice Creates `_amount` token to `_to`. Must only be called by the owner (MasterChef). | |
function mint(address _to, uint256 _amount) public onlyOwner { | |
_mint(_to, _amount); | |
_moveDelegates(address(0), _delegates[_to], _amount); | |
} | |
// Copied and modified from YAM code: | |
// https://github.com/yam-finance/yam-protocol/blob/master/contracts/token/YAMGovernanceStorage.sol | |
// https://github.com/yam-finance/yam-protocol/blob/master/contracts/token/YAMGovernance.sol | |
// Which is copied and modified from COMPOUND: | |
// https://github.com/compound-finance/compound-protocol/blob/master/contracts/Governance/Comp.sol | |
mapping (address => address) internal _delegates; | |
/// @notice A checkpoint for marking number of votes from a given block | |
struct Checkpoint { | |
uint32 fromBlock; | |
uint256 votes; | |
} | |
/// @notice A record of votes checkpoints for each account, by index | |
mapping (address => mapping (uint32 => Checkpoint)) public checkpoints; | |
/// @notice The number of checkpoints for each account | |
mapping (address => uint32) public numCheckpoints; | |
/// @notice The EIP-712 typehash for the contract's domain | |
bytes32 public constant DOMAIN_TYPEHASH = keccak256("EIP712Domain(string name,uint256 chainId,address verifyingContract)"); | |
/// @notice The EIP-712 typehash for the delegation struct used by the contract | |
bytes32 public constant DELEGATION_TYPEHASH = keccak256("Delegation(address delegatee,uint256 nonce,uint256 expiry)"); | |
/// @notice A record of states for signing / validating signatures | |
mapping (address => uint) public nonces; | |
/// @notice An event thats emitted when an account changes its delegate | |
event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate); | |
/// @notice An event thats emitted when a delegate account's vote balance changes | |
event DelegateVotesChanged(address indexed delegate, uint previousBalance, uint newBalance); | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegator The address to get delegatee for | |
*/ | |
function delegates(address delegator) | |
external | |
view | |
returns (address) | |
{ | |
return _delegates[delegator]; | |
} | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegatee The address to delegate votes to | |
*/ | |
function delegate(address delegatee) external { | |
return _delegate(msg.sender, delegatee); | |
} | |
/** | |
* @notice Delegates votes from signatory to `delegatee` | |
* @param delegatee The address to delegate votes to | |
* @param nonce The contract state required to match the signature | |
* @param expiry The time at which to expire the signature | |
* @param v The recovery byte of the signature | |
* @param r Half of the ECDSA signature pair | |
* @param s Half of the ECDSA signature pair | |
*/ | |
function delegateBySig( | |
address delegatee, | |
uint nonce, | |
uint expiry, | |
uint8 v, | |
bytes32 r, | |
bytes32 s | |
) | |
external | |
{ | |
bytes32 domainSeparator = keccak256( | |
abi.encode( | |
DOMAIN_TYPEHASH, | |
keccak256(bytes(name())), | |
getChainId(), | |
address(this) | |
) | |
); | |
bytes32 structHash = keccak256( | |
abi.encode( | |
DELEGATION_TYPEHASH, | |
delegatee, | |
nonce, | |
expiry | |
) | |
); | |
bytes32 digest = keccak256( | |
abi.encodePacked( | |
"\x19\x01", | |
domainSeparator, | |
structHash | |
) | |
); | |
address signatory = ecrecover(digest, v, r, s); | |
require(signatory != address(0), "DENA::delegateBySig: invalid signature"); | |
require(nonce == nonces[signatory]++, "DENA::delegateBySig: invalid nonce"); | |
require(now <= expiry, "DENA::delegateBySig: signature expired"); | |
return _delegate(signatory, delegatee); | |
} | |
/** | |
* @notice Gets the current votes balance for `account` | |
* @param account The address to get votes balance | |
* @return The number of current votes for `account` | |
*/ | |
function getCurrentVotes(address account) | |
external | |
view | |
returns (uint256) | |
{ | |
uint32 nCheckpoints = numCheckpoints[account]; | |
return nCheckpoints > 0 ? checkpoints[account][nCheckpoints - 1].votes : 0; | |
} | |
/** | |
* @notice Determine the prior number of votes for an account as of a block number | |
* @dev Block number must be a finalized block or else this function will revert to prevent misinformation. | |
* @param account The address of the account to check | |
* @param blockNumber The block number to get the vote balance at | |
* @return The number of votes the account had as of the given block | |
*/ | |
function getPriorVotes(address account, uint blockNumber) | |
external | |
view | |
returns (uint256) | |
{ | |
require(blockNumber < block.number, "DENA::getPriorVotes: not yet determined"); | |
uint32 nCheckpoints = numCheckpoints[account]; | |
if (nCheckpoints == 0) { | |
return 0; | |
} | |
// First check most recent balance | |
if (checkpoints[account][nCheckpoints - 1].fromBlock <= blockNumber) { | |
return checkpoints[account][nCheckpoints - 1].votes; | |
} | |
// Next check implicit zero balance | |
if (checkpoints[account][0].fromBlock > blockNumber) { | |
return 0; | |
} | |
uint32 lower = 0; | |
uint32 upper = nCheckpoints - 1; | |
while (upper > lower) { | |
uint32 center = upper - (upper - lower) / 2; // ceil, avoiding overflow | |
Checkpoint memory cp = checkpoints[account][center]; | |
if (cp.fromBlock == blockNumber) { | |
return cp.votes; | |
} else if (cp.fromBlock < blockNumber) { | |
lower = center; | |
} else { | |
upper = center - 1; | |
} | |
} | |
return checkpoints[account][lower].votes; | |
} | |
function _delegate(address delegator, address delegatee) | |
internal | |
{ | |
address currentDelegate = _delegates[delegator]; | |
uint256 delegatorBalance = balanceOf(delegator); // balance of underlying DENAs (not scaled); | |
_delegates[delegator] = delegatee; | |
emit DelegateChanged(delegator, currentDelegate, delegatee); | |
_moveDelegates(currentDelegate, delegatee, delegatorBalance); | |
} | |
function _moveDelegates(address srcRep, address dstRep, uint256 amount) internal { | |
if (srcRep != dstRep && amount > 0) { | |
if (srcRep != address(0)) { | |
// decrease old representative | |
uint32 srcRepNum = numCheckpoints[srcRep]; | |
uint256 srcRepOld = srcRepNum > 0 ? checkpoints[srcRep][srcRepNum - 1].votes : 0; | |
uint256 srcRepNew = srcRepOld.sub(amount); | |
_writeCheckpoint(srcRep, srcRepNum, srcRepOld, srcRepNew); | |
} | |
if (dstRep != address(0)) { | |
// increase new representative | |
uint32 dstRepNum = numCheckpoints[dstRep]; | |
uint256 dstRepOld = dstRepNum > 0 ? checkpoints[dstRep][dstRepNum - 1].votes : 0; | |
uint256 dstRepNew = dstRepOld.add(amount); | |
_writeCheckpoint(dstRep, dstRepNum, dstRepOld, dstRepNew); | |
} | |
} | |
} | |
function _writeCheckpoint( | |
address delegatee, | |
uint32 nCheckpoints, | |
uint256 oldVotes, | |
uint256 newVotes | |
) | |
internal | |
{ | |
uint32 blockNumber = safe32(block.number, "DENA::_writeCheckpoint: block number exceeds 32 bits"); | |
if (nCheckpoints > 0 && checkpoints[delegatee][nCheckpoints - 1].fromBlock == blockNumber) { | |
checkpoints[delegatee][nCheckpoints - 1].votes = newVotes; | |
} else { | |
checkpoints[delegatee][nCheckpoints] = Checkpoint(blockNumber, newVotes); | |
numCheckpoints[delegatee] = nCheckpoints + 1; | |
} | |
emit DelegateVotesChanged(delegatee, oldVotes, newVotes); | |
} | |
function safe32(uint n, string memory errorMessage) internal pure returns (uint32) { | |
require(n < 2**32, errorMessage); | |
return uint32(n); | |
} | |
function getChainId() internal pure returns (uint) { | |
uint256 chainId; | |
assembly { chainId := chainid() } | |
return chainId; | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pragma solidity ^0.5.16; | |
import "https://github.com/compound-finance/compound-protocol/blob/master/contracts/SafeMath.sol"; | |
/** | |
* @title Logic for Compound's JumpRateModel Contract V2. | |
* @author Compound (modified by Dharma Labs, refactored by Arr00) | |
* @notice Version 2 modifies Version 1 by enabling updateable parameters. | |
*/ | |
contract BaseJumpRateModelV2 { | |
using SafeMath for uint; | |
event NewInterestParams(uint baseRatePerBlock, uint multiplierPerBlock, uint jumpMultiplierPerBlock, uint kink); | |
/** | |
* @notice The address of the owner, i.e. the Timelock contract, which can update parameters directly | |
*/ | |
address public owner; | |
/** | |
* @notice The approximate number of blocks per year that is assumed by the interest rate model | |
*/ | |
uint public constant blocksPerYear = 2102400; | |
/** | |
* @notice The multiplier of utilization rate that gives the slope of the interest rate | |
*/ | |
uint public multiplierPerBlock; | |
/** | |
* @notice The base interest rate which is the y-intercept when utilization rate is 0 | |
*/ | |
uint public baseRatePerBlock; | |
/** | |
* @notice The multiplierPerBlock after hitting a specified utilization point | |
*/ | |
uint public jumpMultiplierPerBlock; | |
/** | |
* @notice The utilization point at which the jump multiplier is applied | |
*/ | |
uint public kink; | |
/** | |
* @notice Construct an interest rate model | |
* @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) | |
* @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) | |
* @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point | |
* @param kink_ The utilization point at which the jump multiplier is applied | |
* @param owner_ The address of the owner, i.e. the Timelock contract (which has the ability to update parameters directly) | |
*/ | |
constructor(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_, address owner_) internal { | |
owner = owner_; | |
updateJumpRateModelInternal(baseRatePerYear, multiplierPerYear, jumpMultiplierPerYear, kink_); | |
} | |
/** | |
* @notice Update the parameters of the interest rate model (only callable by owner, i.e. Timelock) | |
* @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) | |
* @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) | |
* @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point | |
* @param kink_ The utilization point at which the jump multiplier is applied | |
*/ | |
function updateJumpRateModel(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_) external { | |
require(msg.sender == owner, "only the owner may call this function."); | |
updateJumpRateModelInternal(baseRatePerYear, multiplierPerYear, jumpMultiplierPerYear, kink_); | |
} | |
/** | |
* @notice Calculates the utilization rate of the market: `borrows / (cash + borrows - reserves)` | |
* @param cash The amount of cash in the market | |
* @param borrows The amount of borrows in the market | |
* @param reserves The amount of reserves in the market (currently unused) | |
* @return The utilization rate as a mantissa between [0, 1e18] | |
*/ | |
function utilizationRate(uint cash, uint borrows, uint reserves) public pure returns (uint) { | |
// Utilization rate is 0 when there are no borrows | |
if (borrows == 0) { | |
return 0; | |
} | |
return borrows.mul(1e18).div(cash.add(borrows).sub(reserves)); | |
} | |
/** | |
* @notice Calculates the current borrow rate per block, with the error code expected by the market | |
* @param cash The amount of cash in the market | |
* @param borrows The amount of borrows in the market | |
* @param reserves The amount of reserves in the market | |
* @return The borrow rate percentage per block as a mantissa (scaled by 1e18) | |
*/ | |
function getBorrowRateInternal(uint cash, uint borrows, uint reserves) internal view returns (uint) { | |
uint util = utilizationRate(cash, borrows, reserves); | |
if (util <= kink) { | |
return util.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); | |
} else { | |
uint normalRate = kink.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); | |
uint excessUtil = util.sub(kink); | |
return excessUtil.mul(jumpMultiplierPerBlock).div(1e18).add(normalRate); | |
} | |
} | |
/** | |
* @notice Calculates the current supply rate per block | |
* @param cash The amount of cash in the market | |
* @param borrows The amount of borrows in the market | |
* @param reserves The amount of reserves in the market | |
* @param reserveFactorMantissa The current reserve factor for the market | |
* @return The supply rate percentage per block as a mantissa (scaled by 1e18) | |
*/ | |
function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) public view returns (uint) { | |
uint oneMinusReserveFactor = uint(1e18).sub(reserveFactorMantissa); | |
uint borrowRate = getBorrowRateInternal(cash, borrows, reserves); | |
uint rateToPool = borrowRate.mul(oneMinusReserveFactor).div(1e18); | |
return utilizationRate(cash, borrows, reserves).mul(rateToPool).div(1e18); | |
} | |
/** | |
* @notice Internal function to update the parameters of the interest rate model | |
* @param baseRatePerYear The approximate target base APR, as a mantissa (scaled by 1e18) | |
* @param multiplierPerYear The rate of increase in interest rate wrt utilization (scaled by 1e18) | |
* @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point | |
* @param kink_ The utilization point at which the jump multiplier is applied | |
*/ | |
function updateJumpRateModelInternal(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_) internal { | |
baseRatePerBlock = baseRatePerYear.div(blocksPerYear); | |
multiplierPerBlock = (multiplierPerYear.mul(1e18)).div(blocksPerYear.mul(kink_)); | |
jumpMultiplierPerBlock = jumpMultiplierPerYear.div(blocksPerYear); | |
kink = kink_; | |
emit NewInterestParams(baseRatePerBlock, multiplierPerBlock, jumpMultiplierPerBlock, kink); | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
*Submitted for verification at BscScan.com on 2021-04-26 | |
*/ | |
// File: ComptrollerInterface.sol | |
pragma solidity ^0.5.16; | |
contract ComptrollerInterface { | |
/// @notice Indicator that this is a Comptroller contract (for inspection) | |
bool public constant isComptroller = true; | |
/*** Assets You Are In ***/ | |
function enterMarkets(address[] calldata vTokens) external returns (uint[] memory); | |
function exitMarket(address vToken) external returns (uint); | |
/*** Policy Hooks ***/ | |
function mintAllowed(address vToken, address minter, uint mintAmount) external returns (uint); | |
function mintVerify(address vToken, address minter, uint mintAmount, uint mintTokens) external; | |
function redeemAllowed(address vToken, address redeemer, uint redeemTokens) external returns (uint); | |
function redeemVerify(address vToken, address redeemer, uint redeemAmount, uint redeemTokens) external; | |
function borrowAllowed(address vToken, address borrower, uint borrowAmount) external returns (uint); | |
function borrowVerify(address vToken, address borrower, uint borrowAmount) external; | |
function repayBorrowAllowed( | |
address vToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function repayBorrowVerify( | |
address vToken, | |
address payer, | |
address borrower, | |
uint repayAmount, | |
uint borrowerIndex) external; | |
function liquidateBorrowAllowed( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function liquidateBorrowVerify( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount, | |
uint seizeTokens) external; | |
function seizeAllowed( | |
address vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external returns (uint); | |
function seizeVerify( | |
address vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external; | |
function transferAllowed(address vToken, address src, address dst, uint transferTokens) external returns (uint); | |
function transferVerify(address vToken, address src, address dst, uint transferTokens) external; | |
/*** Liquidity/Liquidation Calculations ***/ | |
function liquidateCalculateSeizeTokens( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
uint repayAmount) external view returns (uint, uint); | |
function setMintedVAIOf(address owner, uint amount) external returns (uint); | |
} | |
interface IVAIVault { | |
function updatePendingRewards() external; | |
} | |
// File: InterestRateModel.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Benqi's InterestRateModel Interface | |
* @author Benqi | |
*/ | |
contract InterestRateModel { | |
/// @notice Indicator that this is an InterestRateModel contract (for inspection) | |
bool public constant isInterestRateModel = true; | |
/** | |
* @notice Calculates the current borrow interest rate per block | |
* @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 amnount of reserves the market has | |
* @return The borrow rate per block (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 block | |
* @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 amnount of reserves the market has | |
* @param reserveFactorMantissa The current reserve factor the market has | |
* @return The supply rate per block (as a percentage, and scaled by 1e18) | |
*/ | |
function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) external view returns (uint); | |
} | |
// File: VTokenInterfaces.sol | |
pragma solidity ^0.5.16; | |
contract VTokenStorage { | |
/** | |
* @dev Guard variable for re-entrancy checks | |
*/ | |
bool internal _notEntered; | |
/** | |
* @notice EIP-20 token name for this token | |
*/ | |
string public name; | |
/** | |
* @notice EIP-20 token symbol for this token | |
*/ | |
string public symbol; | |
/** | |
* @notice EIP-20 token decimals for this token | |
*/ | |
uint8 public decimals; | |
/** | |
* @notice Maximum borrow rate that can ever be applied (.0005% / block) | |
*/ | |
uint internal constant borrowRateMaxMantissa = 0.0005e16; | |
/** | |
* @notice Maximum fraction of interest that can be set aside for reserves | |
*/ | |
uint internal constant reserveFactorMaxMantissa = 1e18; | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address payable public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address payable public pendingAdmin; | |
/** | |
* @notice Contract which oversees inter-vToken operations | |
*/ | |
ComptrollerInterface public comptroller; | |
/** | |
* @notice Model which tells what the current interest rate should be | |
*/ | |
InterestRateModel public interestRateModel; | |
/** | |
* @notice Initial exchange rate used when minting the first VTokens (used when totalSupply = 0) | |
*/ | |
uint internal initialExchangeRateMantissa; | |
/** | |
* @notice Fraction of interest currently set aside for reserves | |
*/ | |
uint public reserveFactorMantissa; | |
/** | |
* @notice Block number that interest was last accrued at | |
*/ | |
uint public accrualBlockNumber; | |
/** | |
* @notice Accumulator of the total earned interest rate since the opening of the market | |
*/ | |
uint public borrowIndex; | |
/** | |
* @notice Total amount of outstanding borrows of the underlying in this market | |
*/ | |
uint public totalBorrows; | |
/** | |
* @notice Total amount of reserves of the underlying held in this market | |
*/ | |
uint public totalReserves; | |
/** | |
* @notice Total number of tokens in circulation | |
*/ | |
uint public totalSupply; | |
/** | |
* @notice Official record of token balances for each account | |
*/ | |
mapping (address => uint) internal accountTokens; | |
/** | |
* @notice Approved token transfer amounts on behalf of others | |
*/ | |
mapping (address => mapping (address => uint)) internal transferAllowances; | |
/** | |
* @notice Container for borrow balance information | |
* @member principal Total balance (with accrued interest), after applying the most recent balance-changing action | |
* @member interestIndex Global borrowIndex as of the most recent balance-changing action | |
*/ | |
struct BorrowSnapshot { | |
uint principal; | |
uint interestIndex; | |
} | |
/** | |
* @notice Mapping of account addresses to outstanding borrow balances | |
*/ | |
mapping(address => BorrowSnapshot) internal accountBorrows; | |
} | |
contract VTokenInterface is VTokenStorage { | |
/** | |
* @notice Indicator that this is a VToken contract (for inspection) | |
*/ | |
bool public constant isVToken = true; | |
/*** Market Events ***/ | |
/** | |
* @notice Event emitted when interest is accrued | |
*/ | |
event AccrueInterest(uint cashPrior, uint interestAccumulated, uint borrowIndex, uint totalBorrows); | |
/** | |
* @notice Event emitted when tokens are minted | |
*/ | |
event Mint(address minter, uint mintAmount, uint mintTokens); | |
/** | |
* @notice Event emitted when tokens are redeemed | |
*/ | |
event Redeem(address redeemer, uint redeemAmount, uint redeemTokens); | |
/** | |
* @notice Event emitted when underlying is borrowed | |
*/ | |
event Borrow(address borrower, uint borrowAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is repaid | |
*/ | |
event RepayBorrow(address payer, address borrower, uint repayAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is liquidated | |
*/ | |
event LiquidateBorrow(address liquidator, address borrower, uint repayAmount, address vTokenCollateral, uint seizeTokens); | |
/*** Admin Events ***/ | |
/** | |
* @notice Event emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Event emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
/** | |
* @notice Event emitted when comptroller is changed | |
*/ | |
event NewComptroller(ComptrollerInterface oldComptroller, ComptrollerInterface newComptroller); | |
/** | |
* @notice Event emitted when interestRateModel is changed | |
*/ | |
event NewMarketInterestRateModel(InterestRateModel oldInterestRateModel, InterestRateModel newInterestRateModel); | |
/** | |
* @notice Event emitted when the reserve factor is changed | |
*/ | |
event NewReserveFactor(uint oldReserveFactorMantissa, uint newReserveFactorMantissa); | |
/** | |
* @notice Event emitted when the reserves are added | |
*/ | |
event ReservesAdded(address benefactor, uint addAmount, uint newTotalReserves); | |
/** | |
* @notice Event emitted when the reserves are reduced | |
*/ | |
event ReservesReduced(address admin, uint reduceAmount, uint newTotalReserves); | |
/** | |
* @notice EIP20 Transfer event | |
*/ | |
event Transfer(address indexed from, address indexed to, uint amount); | |
/** | |
* @notice EIP20 Approval event | |
*/ | |
event Approval(address indexed owner, address indexed spender, uint amount); | |
/** | |
* @notice Failure event | |
*/ | |
event Failure(uint error, uint info, uint detail); | |
/*** User Interface ***/ | |
function transfer(address dst, uint amount) external returns (bool); | |
function transferFrom(address src, address dst, uint amount) external returns (bool); | |
function approve(address spender, uint amount) external returns (bool); | |
function allowance(address owner, address spender) external view returns (uint); | |
function balanceOf(address owner) external view returns (uint); | |
function balanceOfUnderlying(address owner) external returns (uint); | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint); | |
function borrowRatePerBlock() external view returns (uint); | |
function supplyRatePerBlock() external view returns (uint); | |
function totalBorrowsCurrent() external returns (uint); | |
function borrowBalanceCurrent(address account) external returns (uint); | |
function borrowBalanceStored(address account) public view returns (uint); | |
function exchangeRateCurrent() public returns (uint); | |
function exchangeRateStored() public view returns (uint); | |
function getCash() external view returns (uint); | |
function accrueInterest() public returns (uint); | |
function seize(address liquidator, address borrower, uint seizeTokens) external returns (uint); | |
/*** Admin Functions ***/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint); | |
function _acceptAdmin() external returns (uint); | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint); | |
function _setReserveFactor(uint newReserveFactorMantissa) external returns (uint); | |
function _reduceReserves(uint reduceAmount) external returns (uint); | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint); | |
} | |
contract VBep20Storage { | |
/** | |
* @notice Underlying asset for this VToken | |
*/ | |
address public underlying; | |
} | |
contract VBep20Interface is VBep20Storage { | |
/*** User Interface ***/ | |
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, VTokenInterface vTokenCollateral) external returns (uint); | |
/*** Admin Functions ***/ | |
function _addReserves(uint addAmount) external returns (uint); | |
} | |
contract VDelegationStorage { | |
/** | |
* @notice Implementation address for this contract | |
*/ | |
address public implementation; | |
} | |
contract VDelegatorInterface is VDelegationStorage { | |
/** | |
* @notice Emitted when implementation is changed | |
*/ | |
event NewImplementation(address oldImplementation, address newImplementation); | |
/** | |
* @notice Called by the admin to update the implementation of the delegator | |
* @param implementation_ The address of the new implementation for delegation | |
* @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation | |
* @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation | |
*/ | |
function _setImplementation(address implementation_, bool allowResign, bytes memory becomeImplementationData) public; | |
} | |
contract VDelegateInterface is VDelegationStorage { | |
/** | |
* @notice Called by the delegator on a delegate to initialize it for duty | |
* @dev Should revert if any issues arise which make it unfit for delegation | |
* @param data The encoded bytes data for any initialization | |
*/ | |
function _becomeImplementation(bytes memory data) public; | |
/** | |
* @notice Called by the delegator on a delegate to forfeit its responsibility | |
*/ | |
function _resignImplementation() public; | |
} | |
// File: ErrorReporter.sol | |
pragma solidity ^0.5.16; | |
contract ComptrollerErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
COMPTROLLER_MISMATCH, | |
INSUFFICIENT_SHORTFALL, | |
INSUFFICIENT_LIQUIDITY, | |
INVALID_CLOSE_FACTOR, | |
INVALID_COLLATERAL_FACTOR, | |
INVALID_LIQUIDATION_INCENTIVE, | |
MARKET_NOT_ENTERED, // no longer possible | |
MARKET_NOT_LISTED, | |
MARKET_ALREADY_LISTED, | |
MATH_ERROR, | |
NONZERO_BORROW_BALANCE, | |
PRICE_ERROR, | |
REJECTION, | |
SNAPSHOT_ERROR, | |
TOO_MANY_ASSETS, | |
TOO_MUCH_REPAY, | |
INSUFFICIENT_BALANCE_FOR_VAI | |
} | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
EXIT_MARKET_BALANCE_OWED, | |
EXIT_MARKET_REJECTION, | |
SET_CLOSE_FACTOR_OWNER_CHECK, | |
SET_CLOSE_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_NO_EXISTS, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_WITHOUT_PRICE, | |
SET_IMPLEMENTATION_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_VALIDATION, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_OWNER_CHECK, | |
SET_PRICE_ORACLE_OWNER_CHECK, | |
SUPPORT_MARKET_EXISTS, | |
SUPPORT_MARKET_OWNER_CHECK, | |
SET_PAUSE_GUARDIAN_OWNER_CHECK, | |
SET_VAI_MINT_RATE_CHECK, | |
SET_VAICONTROLLER_OWNER_CHECK, | |
SET_MINTED_VAI_REJECTION, | |
VAI_CONTROLLER_MISMATCH | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
contract TokenErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
BAD_INPUT, | |
COMPTROLLER_REJECTION, | |
COMPTROLLER_CALCULATION_ERROR, | |
INTEREST_RATE_MODEL_ERROR, | |
INVALID_ACCOUNT_PAIR, | |
INVALID_CLOSE_AMOUNT_REQUESTED, | |
INVALID_COLLATERAL_FACTOR, | |
MATH_ERROR, | |
MARKET_NOT_FRESH, | |
MARKET_NOT_LISTED, | |
TOKEN_INSUFFICIENT_ALLOWANCE, | |
TOKEN_INSUFFICIENT_BALANCE, | |
TOKEN_INSUFFICIENT_CASH, | |
TOKEN_TRANSFER_IN_FAILED, | |
TOKEN_TRANSFER_OUT_FAILED, | |
TOKEN_PRICE_ERROR | |
} | |
/* | |
* Note: FailureInfo (but not Error) is kept in alphabetical order | |
* This is because FailureInfo grows significantly faster, and | |
* the order of Error has some meaning, while the order of FailureInfo | |
* is entirely arbitrary. | |
*/ | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, | |
ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, | |
ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, | |
BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
BORROW_ACCRUE_INTEREST_FAILED, | |
BORROW_CASH_NOT_AVAILABLE, | |
BORROW_FRESHNESS_CHECK, | |
BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
BORROW_MARKET_NOT_LISTED, | |
BORROW_COMPTROLLER_REJECTION, | |
LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED, | |
LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED, | |
LIQUIDATE_COLLATERAL_FRESHNESS_CHECK, | |
LIQUIDATE_COMPTROLLER_REJECTION, | |
LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, | |
LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX, | |
LIQUIDATE_CLOSE_AMOUNT_IS_ZERO, | |
LIQUIDATE_FRESHNESS_CHECK, | |
LIQUIDATE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_REPAY_BORROW_FRESH_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, | |
LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, | |
LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_SEIZE_TOO_MUCH, | |
MINT_ACCRUE_INTEREST_FAILED, | |
MINT_COMPTROLLER_REJECTION, | |
MINT_EXCHANGE_CALCULATION_FAILED, | |
MINT_EXCHANGE_RATE_READ_FAILED, | |
MINT_FRESHNESS_CHECK, | |
MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
MINT_TRANSFER_IN_FAILED, | |
MINT_TRANSFER_IN_NOT_POSSIBLE, | |
REDEEM_ACCRUE_INTEREST_FAILED, | |
REDEEM_COMPTROLLER_REJECTION, | |
REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_RATE_READ_FAILED, | |
REDEEM_FRESHNESS_CHECK, | |
REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
REDEEM_TRANSFER_OUT_NOT_POSSIBLE, | |
REDUCE_RESERVES_ACCRUE_INTEREST_FAILED, | |
REDUCE_RESERVES_ADMIN_CHECK, | |
REDUCE_RESERVES_CASH_NOT_AVAILABLE, | |
REDUCE_RESERVES_FRESH_CHECK, | |
REDUCE_RESERVES_VALIDATION, | |
REPAY_BEHALF_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_COMPTROLLER_REJECTION, | |
REPAY_BORROW_FRESHNESS_CHECK, | |
REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COMPTROLLER_OWNER_CHECK, | |
SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED, | |
SET_INTEREST_RATE_MODEL_FRESH_CHECK, | |
SET_INTEREST_RATE_MODEL_OWNER_CHECK, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_ORACLE_MARKET_NOT_LISTED, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED, | |
SET_RESERVE_FACTOR_ADMIN_CHECK, | |
SET_RESERVE_FACTOR_FRESH_CHECK, | |
SET_RESERVE_FACTOR_BOUNDS_CHECK, | |
TRANSFER_COMPTROLLER_REJECTION, | |
TRANSFER_NOT_ALLOWED, | |
TRANSFER_NOT_ENOUGH, | |
TRANSFER_TOO_MUCH, | |
ADD_RESERVES_ACCRUE_INTEREST_FAILED, | |
ADD_RESERVES_FRESH_CHECK, | |
ADD_RESERVES_TRANSFER_IN_NOT_POSSIBLE, | |
TOKEN_GET_UNDERLYING_PRICE_ERROR, | |
REPAY_VAI_COMPTROLLER_REJECTION, | |
REPAY_VAI_FRESHNESS_CHECK, | |
VAI_MINT_EXCHANGE_CALCULATION_FAILED, | |
VAI_MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
contract VAIControllerErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
REJECTION, | |
SNAPSHOT_ERROR, | |
PRICE_ERROR, | |
MATH_ERROR, | |
INSUFFICIENT_BALANCE_FOR_VAI | |
} | |
enum FailureInfo { | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_OWNER_CHECK, | |
SET_COMPTROLLER_OWNER_CHECK, | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
VAI_MINT_REJECTION, | |
VAI_BURN_REJECTION | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
// File: CarefulMath.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Careful Math | |
* @author Benqi | |
* @notice Derived from OpenZeppelin's SafeMath library | |
* https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/math/SafeMath.sol | |
*/ | |
contract CarefulMath { | |
/** | |
* @dev Possible error codes that we can return | |
*/ | |
enum MathError { | |
NO_ERROR, | |
DIVISION_BY_ZERO, | |
INTEGER_OVERFLOW, | |
INTEGER_UNDERFLOW | |
} | |
/** | |
* @dev Multiplies two numbers, returns an error on overflow. | |
*/ | |
function mulUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (a == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
uint c = a * b; | |
if (c / a != b) { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} else { | |
return (MathError.NO_ERROR, c); | |
} | |
} | |
/** | |
* @dev Integer division of two numbers, truncating the quotient. | |
*/ | |
function divUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b == 0) { | |
return (MathError.DIVISION_BY_ZERO, 0); | |
} | |
return (MathError.NO_ERROR, a / b); | |
} | |
/** | |
* @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). | |
*/ | |
function subUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b <= a) { | |
return (MathError.NO_ERROR, a - b); | |
} else { | |
return (MathError.INTEGER_UNDERFLOW, 0); | |
} | |
} | |
/** | |
* @dev Adds two numbers, returns an error on overflow. | |
*/ | |
function addUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
uint c = a + b; | |
if (c >= a) { | |
return (MathError.NO_ERROR, c); | |
} else { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} | |
} | |
/** | |
* @dev add a and b and then subtract c | |
*/ | |
function addThenSubUInt(uint a, uint b, uint c) internal pure returns (MathError, uint) { | |
(MathError err0, uint sum) = addUInt(a, b); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, 0); | |
} | |
return subUInt(sum, c); | |
} | |
} | |
// File: Exponential.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Exponential module for storing fixed-precision decimals | |
* @author Benqi | |
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. | |
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: | |
* `Exp({mantissa: 5100000000000000000})`. | |
*/ | |
contract Exponential is CarefulMath { | |
uint constant expScale = 1e18; | |
uint constant doubleScale = 1e36; | |
uint constant halfExpScale = expScale/2; | |
uint constant mantissaOne = expScale; | |
struct Exp { | |
uint mantissa; | |
} | |
struct Double { | |
uint mantissa; | |
} | |
/** | |
* @dev Creates an exponential from numerator and denominator values. | |
* Note: Returns an error if (`num` * 10e18) > MAX_INT, | |
* or if `denom` is zero. | |
*/ | |
function getExp(uint num, uint denom) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint scaledNumerator) = mulUInt(num, expScale); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
(MathError err1, uint rational) = divUInt(scaledNumerator, denom); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: rational})); | |
} | |
/** | |
* @dev Adds two exponentials, returning a new exponential. | |
*/ | |
function addExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
(MathError error, uint result) = addUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Subtracts two exponentials, returning a new exponential. | |
*/ | |
function subExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
(MathError error, uint result) = subUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, returning a new Exp. | |
*/ | |
function mulScalar(Exp memory a, uint scalar) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint scaledMantissa) = mulUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: scaledMantissa})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. | |
*/ | |
function mulScalarTruncate(Exp memory a, uint scalar) internal pure returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(product)); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. | |
*/ | |
function mulScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) internal pure returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return addUInt(truncate(product), addend); | |
} | |
/** | |
* @dev Divide an Exp by a scalar, returning a new Exp. | |
*/ | |
function divScalar(Exp memory a, uint scalar) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint descaledMantissa) = divUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: descaledMantissa})); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, returning a new Exp. | |
*/ | |
function divScalarByExp(uint scalar, Exp memory divisor) internal pure returns (MathError, Exp memory) { | |
/* | |
We are doing this as: | |
getExp(mulUInt(expScale, scalar), divisor.mantissa) | |
How it works: | |
Exp = a / b; | |
Scalar = s; | |
`s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` | |
*/ | |
(MathError err0, uint numerator) = mulUInt(expScale, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return getExp(numerator, divisor.mantissa); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, then truncate to return an unsigned integer. | |
*/ | |
function divScalarByExpTruncate(uint scalar, Exp memory divisor) internal pure returns (MathError, uint) { | |
(MathError err, Exp memory fraction) = divScalarByExp(scalar, divisor); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(fraction)); | |
} | |
/** | |
* @dev Multiplies two exponentials, returning a new exponential. | |
*/ | |
function mulExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
(MathError err0, uint doubleScaledProduct) = mulUInt(a.mantissa, b.mantissa); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
// We add half the scale before dividing so that we get rounding instead of truncation. | |
// See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 | |
// Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. | |
(MathError err1, uint doubleScaledProductWithHalfScale) = addUInt(halfExpScale, doubleScaledProduct); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
(MathError err2, uint product) = divUInt(doubleScaledProductWithHalfScale, expScale); | |
// The only error `div` can return is MathError.DIVISION_BY_ZERO but we control `expScale` and it is not zero. | |
assert(err2 == MathError.NO_ERROR); | |
return (MathError.NO_ERROR, Exp({mantissa: product})); | |
} | |
/** | |
* @dev Multiplies two exponentials given their mantissas, returning a new exponential. | |
*/ | |
function mulExp(uint a, uint b) internal pure returns (MathError, Exp memory) { | |
return mulExp(Exp({mantissa: a}), Exp({mantissa: b})); | |
} | |
/** | |
* @dev Multiplies three exponentials, returning a new exponential. | |
*/ | |
function mulExp3(Exp memory a, Exp memory b, Exp memory c) internal pure returns (MathError, Exp memory) { | |
(MathError err, Exp memory ab) = mulExp(a, b); | |
if (err != MathError.NO_ERROR) { | |
return (err, ab); | |
} | |
return mulExp(ab, c); | |
} | |
/** | |
* @dev Divides two exponentials, returning a new exponential. | |
* (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, | |
* which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) | |
*/ | |
function divExp(Exp memory a, Exp memory b) internal pure returns (MathError, Exp memory) { | |
return getExp(a.mantissa, b.mantissa); | |
} | |
/** | |
* @dev Truncates the given exp to a whole number value. | |
* For example, truncate(Exp{mantissa: 15 * expScale}) = 15 | |
*/ | |
function truncate(Exp memory exp) internal pure returns (uint) { | |
// Note: We are not using careful math here as we're performing a division that cannot fail | |
return exp.mantissa / expScale; | |
} | |
/** | |
* @dev Checks if first Exp is less than second Exp. | |
*/ | |
function lessThanExp(Exp memory left, Exp memory right) internal pure returns (bool) { | |
return left.mantissa < right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp <= right Exp. | |
*/ | |
function lessThanOrEqualExp(Exp memory left, Exp memory right) internal pure returns (bool) { | |
return left.mantissa <= right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp > right Exp. | |
*/ | |
function greaterThanExp(Exp memory left, Exp memory right) internal pure returns (bool) { | |
return left.mantissa > right.mantissa; | |
} | |
/** | |
* @dev returns true if Exp is exactly zero | |
*/ | |
function isZeroExp(Exp memory value) internal pure returns (bool) { | |
return value.mantissa == 0; | |
} | |
function safe224(uint n, string memory errorMessage) internal pure returns (uint224) { | |
require(n < 2**224, errorMessage); | |
return uint224(n); | |
} | |
function safe32(uint n, string memory errorMessage) internal pure returns (uint32) { | |
require(n < 2**32, errorMessage); | |
return uint32(n); | |
} | |
function add_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: add_(a.mantissa, b.mantissa)}); | |
} | |
function add_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: add_(a.mantissa, b.mantissa)}); | |
} | |
function add_(uint a, uint b) internal pure returns (uint) { | |
return add_(a, b, "addition overflow"); | |
} | |
function add_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
uint c = a + b; | |
require(c >= a, errorMessage); | |
return c; | |
} | |
function sub_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: sub_(a.mantissa, b.mantissa)}); | |
} | |
function sub_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: sub_(a.mantissa, b.mantissa)}); | |
} | |
function sub_(uint a, uint b) internal pure returns (uint) { | |
return sub_(a, b, "subtraction underflow"); | |
} | |
function sub_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
require(b <= a, errorMessage); | |
return a - b; | |
} | |
function mul_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: mul_(a.mantissa, b.mantissa) / expScale}); | |
} | |
function mul_(Exp memory a, uint b) internal pure returns (Exp memory) { | |
return Exp({mantissa: mul_(a.mantissa, b)}); | |
} | |
function mul_(uint a, Exp memory b) internal pure returns (uint) { | |
return mul_(a, b.mantissa) / expScale; | |
} | |
function mul_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: mul_(a.mantissa, b.mantissa) / doubleScale}); | |
} | |
function mul_(Double memory a, uint b) internal pure returns (Double memory) { | |
return Double({mantissa: mul_(a.mantissa, b)}); | |
} | |
function mul_(uint a, Double memory b) internal pure returns (uint) { | |
return mul_(a, b.mantissa) / doubleScale; | |
} | |
function mul_(uint a, uint b) internal pure returns (uint) { | |
return mul_(a, b, "multiplication overflow"); | |
} | |
function mul_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
if (a == 0 || b == 0) { | |
return 0; | |
} | |
uint c = a * b; | |
require(c / a == b, errorMessage); | |
return c; | |
} | |
function div_(Exp memory a, Exp memory b) internal pure returns (Exp memory) { | |
return Exp({mantissa: div_(mul_(a.mantissa, expScale), b.mantissa)}); | |
} | |
function div_(Exp memory a, uint b) internal pure returns (Exp memory) { | |
return Exp({mantissa: div_(a.mantissa, b)}); | |
} | |
function div_(uint a, Exp memory b) internal pure returns (uint) { | |
return div_(mul_(a, expScale), b.mantissa); | |
} | |
function div_(Double memory a, Double memory b) internal pure returns (Double memory) { | |
return Double({mantissa: div_(mul_(a.mantissa, doubleScale), b.mantissa)}); | |
} | |
function div_(Double memory a, uint b) internal pure returns (Double memory) { | |
return Double({mantissa: div_(a.mantissa, b)}); | |
} | |
function div_(uint a, Double memory b) internal pure returns (uint) { | |
return div_(mul_(a, doubleScale), b.mantissa); | |
} | |
function div_(uint a, uint b) internal pure returns (uint) { | |
return div_(a, b, "divide by zero"); | |
} | |
function div_(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
require(b > 0, errorMessage); | |
return a / b; | |
} | |
function fraction(uint a, uint b) internal pure returns (Double memory) { | |
return Double({mantissa: div_(mul_(a, doubleScale), b)}); | |
} | |
} | |
// File: EIP20Interface.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title BEP 20 Token Standard Interface | |
* https://eips.ethereum.org/EIPS/eip-20 | |
*/ | |
interface EIP20Interface { | |
function name() external view returns (string memory); | |
function symbol() external view returns (string memory); | |
function decimals() external view returns (uint8); | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: EIP20NonStandardInterface.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title EIP20NonStandardInterface | |
* @dev Version of BEP20 with no return values for `transfer` and `transferFrom` | |
* See https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
interface EIP20NonStandardInterface { | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transfer` does not return a value, in violation of the BEP-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transfer(address dst, uint256 amount) external; | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transferFrom` does not return a value, in violation of the BEP-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external; | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: VToken.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Benqi's VToken Contract | |
* @notice Abstract base for VTokens | |
* @author Benqi | |
*/ | |
contract VToken is VTokenInterface, Exponential, TokenErrorReporter { | |
/** | |
* @notice Initialize the money market | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ EIP-20 name of this token | |
* @param symbol_ EIP-20 symbol of this token | |
* @param decimals_ EIP-20 decimal precision of this token | |
*/ | |
function initialize(ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_) public { | |
require(msg.sender == admin, "only admin may initialize the market"); | |
require(accrualBlockNumber == 0 && borrowIndex == 0, "market may only be initialized once"); | |
// Set initial exchange rate | |
initialExchangeRateMantissa = initialExchangeRateMantissa_; | |
require(initialExchangeRateMantissa > 0, "initial exchange rate must be greater than zero."); | |
// Set the comptroller | |
uint err = _setComptroller(comptroller_); | |
require(err == uint(Error.NO_ERROR), "setting comptroller failed"); | |
// Initialize block number and borrow index (block number mocks depend on comptroller being set) | |
accrualBlockNumber = getBlockNumber(); | |
borrowIndex = mantissaOne; | |
// Set the interest rate model (depends on block number / borrow index) | |
err = _setInterestRateModelFresh(interestRateModel_); | |
require(err == uint(Error.NO_ERROR), "setting interest rate model failed"); | |
name = name_; | |
symbol = symbol_; | |
decimals = decimals_; | |
// The counter starts true to prevent changing it from zero to non-zero (i.e. smaller cost/refund) | |
_notEntered = true; | |
} | |
/** | |
* @notice Transfer `tokens` tokens from `src` to `dst` by `spender` | |
* @dev Called by both `transfer` and `transferFrom` internally | |
* @param spender The address of the account performing the transfer | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param tokens The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferTokens(address spender, address src, address dst, uint tokens) internal returns (uint) { | |
/* Fail if transfer not allowed */ | |
uint allowed = comptroller.transferAllowed(address(this), src, dst, tokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.TRANSFER_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Do not allow self-transfers */ | |
if (src == dst) { | |
return fail(Error.BAD_INPUT, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
/* Get the allowance, infinite for the account owner */ | |
uint startingAllowance = 0; | |
if (spender == src) { | |
startingAllowance = uint(-1); | |
} else { | |
startingAllowance = transferAllowances[src][spender]; | |
} | |
/* Do the calculations, checking for {under,over}flow */ | |
MathError mathErr; | |
uint allowanceNew; | |
uint srvTokensNew; | |
uint dstTokensNew; | |
(mathErr, allowanceNew) = subUInt(startingAllowance, tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
(mathErr, srvTokensNew) = subUInt(accountTokens[src], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ENOUGH); | |
} | |
(mathErr, dstTokensNew) = addUInt(accountTokens[dst], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_TOO_MUCH); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
accountTokens[src] = srvTokensNew; | |
accountTokens[dst] = dstTokensNew; | |
/* Eat some of the allowance (if necessary) */ | |
if (startingAllowance != uint(-1)) { | |
transferAllowances[src][spender] = allowanceNew; | |
} | |
/* We emit a Transfer event */ | |
emit Transfer(src, dst, tokens); | |
comptroller.transferVerify(address(this), src, dst, tokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, msg.sender, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, src, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool) { | |
address src = msg.sender; | |
transferAllowances[src][spender] = amount; | |
emit Approval(src, spender, amount); | |
return true; | |
} | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256) { | |
return transferAllowances[owner][spender]; | |
} | |
/** | |
* @notice Get the token balance of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of tokens owned by `owner` | |
*/ | |
function balanceOf(address owner) external view returns (uint256) { | |
return accountTokens[owner]; | |
} | |
/** | |
* @notice Get the underlying balance of the `owner` | |
* @dev This also accrues interest in a transaction | |
* @param owner The address of the account to query | |
* @return The amount of underlying owned by `owner` | |
*/ | |
function balanceOfUnderlying(address owner) external returns (uint) { | |
Exp memory exchangeRate = Exp({mantissa: exchangeRateCurrent()}); | |
(MathError mErr, uint balance) = mulScalarTruncate(exchangeRate, accountTokens[owner]); | |
require(mErr == MathError.NO_ERROR, "balance could not be calculated"); | |
return balance; | |
} | |
/** | |
* @notice Get a snapshot of the account's balances, and the cached exchange rate | |
* @dev This is used by comptroller to more efficiently perform liquidity checks. | |
* @param account Address of the account to snapshot | |
* @return (possible error, token balance, borrow balance, exchange rate mantissa) | |
*/ | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { | |
uint vTokenBalance = accountTokens[account]; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
MathError mErr; | |
(mErr, borrowBalance) = borrowBalanceStoredInternal(account); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
(mErr, exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
return (uint(Error.NO_ERROR), vTokenBalance, borrowBalance, exchangeRateMantissa); | |
} | |
/** | |
* @dev Function to simply retrieve block number | |
* This exists mainly for inheriting test contracts to stub this result. | |
*/ | |
function getBlockNumber() internal view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Returns the current per-block borrow interest rate for this vToken | |
* @return The borrow interest rate per block, scaled by 1e18 | |
*/ | |
function borrowRatePerBlock() external view returns (uint) { | |
return interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
} | |
/** | |
* @notice Returns the current per-block supply interest rate for this vToken | |
* @return The supply interest rate per block, scaled by 1e18 | |
*/ | |
function supplyRatePerBlock() external view returns (uint) { | |
return interestRateModel.getSupplyRate(getCashPrior(), totalBorrows, totalReserves, reserveFactorMantissa); | |
} | |
/** | |
* @notice Returns the current total borrows plus accrued interest | |
* @return The total borrows with interest | |
*/ | |
function totalBorrowsCurrent() external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return totalBorrows; | |
} | |
/** | |
* @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex | |
* @param account The address whose balance should be calculated after updating borrowIndex | |
* @return The calculated balance | |
*/ | |
function borrowBalanceCurrent(address account) external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return borrowBalanceStored(account); | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return The calculated balance | |
*/ | |
function borrowBalanceStored(address account) public view returns (uint) { | |
(MathError err, uint result) = borrowBalanceStoredInternal(account); | |
require(err == MathError.NO_ERROR, "borrowBalanceStored: borrowBalanceStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return (error code, the calculated balance or 0 if error code is non-zero) | |
*/ | |
function borrowBalanceStoredInternal(address account) internal view returns (MathError, uint) { | |
/* Note: we do not assert that the market is up to date */ | |
MathError mathErr; | |
uint principalTimesIndex; | |
uint result; | |
/* Get borrowBalance and borrowIndex */ | |
BorrowSnapshot storage borrowSnapshot = accountBorrows[account]; | |
/* If borrowBalance = 0 then borrowIndex is likely also 0. | |
* Rather than failing the calculation with a division by 0, we immediately return 0 in this case. | |
*/ | |
if (borrowSnapshot.principal == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
/* Calculate new borrow balance using the interest index: | |
* recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex | |
*/ | |
(mathErr, principalTimesIndex) = mulUInt(borrowSnapshot.principal, borrowIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, result) = divUInt(principalTimesIndex, borrowSnapshot.interestIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, result); | |
} | |
/** | |
* @notice Accrue interest then return the up-to-date exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateCurrent() public nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return exchangeRateStored(); | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the VToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateStored() public view returns (uint) { | |
(MathError err, uint result) = exchangeRateStoredInternal(); | |
require(err == MathError.NO_ERROR, "exchangeRateStored: exchangeRateStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the VToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return (error code, calculated exchange rate scaled by 1e18) | |
*/ | |
function exchangeRateStoredInternal() internal view returns (MathError, uint) { | |
uint _totalSupply = totalSupply; | |
if (_totalSupply == 0) { | |
/* | |
* If there are no tokens minted: | |
* exchangeRate = initialExchangeRate | |
*/ | |
return (MathError.NO_ERROR, initialExchangeRateMantissa); | |
} else { | |
/* | |
* Otherwise: | |
* exchangeRate = (totalCash + totalBorrows - totalReserves) / totalSupply | |
*/ | |
uint totalCash = getCashPrior(); | |
uint cashPlusBorrowsMinusReserves; | |
Exp memory exchangeRate; | |
MathError mathErr; | |
(mathErr, cashPlusBorrowsMinusReserves) = addThenSubUInt(totalCash, totalBorrows, totalReserves); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, exchangeRate) = getExp(cashPlusBorrowsMinusReserves, _totalSupply); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, exchangeRate.mantissa); | |
} | |
} | |
/** | |
* @notice Get cash balance of this vToken in the underlying asset | |
* @return The quantity of underlying asset owned by this contract | |
*/ | |
function getCash() external view returns (uint) { | |
return getCashPrior(); | |
} | |
/** | |
* @notice Applies accrued interest to total borrows and reserves | |
* @dev This calculates interest accrued from the last checkpointed block | |
* up to the current block and writes new checkpoint to storage. | |
*/ | |
function accrueInterest() public returns (uint) { | |
/* Remember the initial block number */ | |
uint currentBlockNumber = getBlockNumber(); | |
uint accrualBlockNumberPrior = accrualBlockNumber; | |
/* Short-circuit accumulating 0 interest */ | |
if (accrualBlockNumberPrior == currentBlockNumber) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Read the previous values out of storage */ | |
uint cashPrior = getCashPrior(); | |
uint borrowsPrior = totalBorrows; | |
uint reservesPrior = totalReserves; | |
uint borrowIndexPrior = borrowIndex; | |
/* Calculate the current borrow interest rate */ | |
uint borrowRateMantissa = interestRateModel.getBorrowRate(cashPrior, borrowsPrior, reservesPrior); | |
require(borrowRateMantissa <= borrowRateMaxMantissa, "borrow rate is absurdly high"); | |
/* Calculate the number of blocks elapsed since the last accrual */ | |
(MathError mathErr, uint blockDelta) = subUInt(currentBlockNumber, accrualBlockNumberPrior); | |
require(mathErr == MathError.NO_ERROR, "could not calculate block delta"); | |
/* | |
* Calculate the interest accumulated into borrows and reserves and the new index: | |
* simpleInterestFactor = borrowRate * blockDelta | |
* interestAccumulated = simpleInterestFactor * totalBorrows | |
* totalBorrowsNew = interestAccumulated + totalBorrows | |
* totalReservesNew = interestAccumulated * reserveFactor + totalReserves | |
* borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex | |
*/ | |
Exp memory simpleInterestFactor; | |
uint interestAccumulated; | |
uint totalBorrowsNew; | |
uint totalReservesNew; | |
uint borrowIndexNew; | |
(mathErr, simpleInterestFactor) = mulScalar(Exp({mantissa: borrowRateMantissa}), blockDelta); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, interestAccumulated) = mulScalarTruncate(simpleInterestFactor, borrowsPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, totalBorrowsNew) = addUInt(interestAccumulated, borrowsPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, totalReservesNew) = mulScalarTruncateAddUInt(Exp({mantissa: reserveFactorMantissa}), interestAccumulated, reservesPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, borrowIndexNew) = mulScalarTruncateAddUInt(simpleInterestFactor, borrowIndexPrior, borrowIndexPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, uint(mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accrualBlockNumber = currentBlockNumber; | |
borrowIndex = borrowIndexNew; | |
totalBorrows = totalBorrowsNew; | |
totalReserves = totalReservesNew; | |
/* We emit an AccrueInterest event */ | |
emit AccrueInterest(cashPrior, interestAccumulated, borrowIndexNew, totalBorrowsNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender supplies assets into the market and receives vTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. | |
*/ | |
function mintInternal(uint mintAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.MINT_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// mintFresh emits the actual Mint event if successful and logs on errors, so we don't need to | |
return mintFresh(msg.sender, mintAmount); | |
} | |
struct MintLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint mintTokens; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
uint actualMintAmount; | |
} | |
/** | |
* @notice User supplies assets into the market and receives vTokens in exchange | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param minter The address of the account which is supplying the assets | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. | |
*/ | |
function mintFresh(address minter, uint mintAmount) internal returns (uint, uint) { | |
/* Fail if mint not allowed */ | |
uint allowed = comptroller.mintAllowed(address(this), minter, mintAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.MINT_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.MINT_FRESHNESS_CHECK), 0); | |
} | |
MintLocalVars memory vars; | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return (failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)), 0); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call `doTransferIn` for the minter and the mintAmount. | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* `doTransferIn` reverts if anything goes wrong, since we can't be sure if | |
* side-effects occurred. The function returns the amount actually transferred, | |
* in case of a fee. On success, the vToken holds an additional `actualMintAmount` | |
* of cash. | |
*/ | |
vars.actualMintAmount = doTransferIn(minter, mintAmount); | |
/* | |
* We get the current exchange rate and calculate the number of vTokens to be minted: | |
* mintTokens = actualMintAmount / exchangeRate | |
*/ | |
(vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(vars.actualMintAmount, Exp({mantissa: vars.exchangeRateMantissa})); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_EXCHANGE_CALCULATION_FAILED"); | |
/* | |
* We calculate the new total supply of vTokens and minter token balance, checking for overflow: | |
* totalSupplyNew = totalSupply + mintTokens | |
* accountTokensNew = accountTokens[minter] + mintTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = addUInt(totalSupply, vars.mintTokens); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED"); | |
(vars.mathErr, vars.accountTokensNew) = addUInt(accountTokens[minter], vars.mintTokens); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED"); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[minter] = vars.accountTokensNew; | |
/* We emit a Mint event, and a Transfer event */ | |
emit Mint(minter, vars.actualMintAmount, vars.mintTokens); | |
emit Transfer(address(this), minter, vars.mintTokens); | |
/* We call the defense hook */ | |
comptroller.mintVerify(address(this), minter, vars.actualMintAmount, vars.mintTokens); | |
return (uint(Error.NO_ERROR), vars.actualMintAmount); | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of vTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemInternal(uint redeemTokens) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, redeemTokens, 0); | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to receive from redeeming vTokens | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlyingInternal(uint redeemAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, 0, redeemAmount); | |
} | |
struct RedeemLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint redeemTokens; | |
uint redeemAmount; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
} | |
/** | |
* @notice User redeems vTokens in exchange for the underlying asset | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param redeemer The address of the account which is redeeming the tokens | |
* @param redeemTokensIn The number of vTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @param redeemAmountIn The number of underlying tokens to receive from redeeming vTokens (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemFresh(address payable redeemer, uint redeemTokensIn, uint redeemAmountIn) internal returns (uint) { | |
require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero"); | |
RedeemLocalVars memory vars; | |
/* exchangeRate = invoke Exchange Rate Stored() */ | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); | |
} | |
/* If redeemTokensIn > 0: */ | |
if (redeemTokensIn > 0) { | |
/* | |
* We calculate the exchange rate and the amount of underlying to be redeemed: | |
* redeemTokens = redeemTokensIn | |
* redeemAmount = redeemTokensIn x exchangeRateCurrent | |
*/ | |
vars.redeemTokens = redeemTokensIn; | |
(vars.mathErr, vars.redeemAmount) = mulScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), redeemTokensIn); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
} else { | |
/* | |
* We get the current exchange rate and calculate the amount to be redeemed: | |
* redeemTokens = redeemAmountIn / exchangeRate | |
* redeemAmount = redeemAmountIn | |
*/ | |
(vars.mathErr, vars.redeemTokens) = divScalarByExpTruncate(redeemAmountIn, Exp({mantissa: vars.exchangeRateMantissa})); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
vars.redeemAmount = redeemAmountIn; | |
} | |
/* Fail if redeem not allowed */ | |
uint allowed = comptroller.redeemAllowed(address(this), redeemer, vars.redeemTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REDEEM_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDEEM_FRESHNESS_CHECK); | |
} | |
/* | |
* We calculate the new total supply and redeemer balance, checking for underflow: | |
* totalSupplyNew = totalSupply - redeemTokens | |
* accountTokensNew = accountTokens[redeemer] - redeemTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = subUInt(totalSupply, vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountTokensNew) = subUInt(accountTokens[redeemer], vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* Fail gracefully if protocol has insufficient cash */ | |
if (getCashPrior() < vars.redeemAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDEEM_TRANSFER_OUT_NOT_POSSIBLE); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the redeemer and the redeemAmount. | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken has redeemAmount less of cash. | |
* doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
*/ | |
doTransferOut(redeemer, vars.redeemAmount); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[redeemer] = vars.accountTokensNew; | |
/* We emit a Transfer event, and a Redeem event */ | |
emit Transfer(redeemer, address(this), vars.redeemTokens); | |
emit Redeem(redeemer, vars.redeemAmount, vars.redeemTokens); | |
/* We call the defense hook */ | |
comptroller.redeemVerify(address(this), redeemer, vars.redeemAmount, vars.redeemTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowInternal(uint borrowAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.BORROW_ACCRUE_INTEREST_FAILED); | |
} | |
// borrowFresh emits borrow-specific logs on errors, so we don't need to | |
return borrowFresh(msg.sender, borrowAmount); | |
} | |
struct BorrowLocalVars { | |
MathError mathErr; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
} | |
/** | |
* @notice Users borrow assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowFresh(address payable borrower, uint borrowAmount) internal returns (uint) { | |
/* Fail if borrow not allowed */ | |
uint allowed = comptroller.borrowAllowed(address(this), borrower, borrowAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.BORROW_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.BORROW_FRESHNESS_CHECK); | |
} | |
/* Fail gracefully if protocol has insufficient underlying cash */ | |
if (getCashPrior() < borrowAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.BORROW_CASH_NOT_AVAILABLE); | |
} | |
BorrowLocalVars memory vars; | |
/* | |
* We calculate the new borrower and total borrow balances, failing on overflow: | |
* accountBorrowsNew = accountBorrows + borrowAmount | |
* totalBorrowsNew = totalBorrows + borrowAmount | |
*/ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountBorrowsNew) = addUInt(vars.accountBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = addUInt(totalBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the borrower and the borrowAmount. | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken borrowAmount less of cash. | |
* doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
*/ | |
doTransferOut(borrower, borrowAmount); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a Borrow event */ | |
emit Borrow(borrower, borrowAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.borrowVerify(address(this), borrower, borrowAmount); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowInternal(uint repayAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.REPAY_BORROW_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, msg.sender, repayAmount); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowBehalfInternal(address borrower, uint repayAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.REPAY_BEHALF_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, borrower, repayAmount); | |
} | |
struct RepayBorrowLocalVars { | |
Error err; | |
MathError mathErr; | |
uint repayAmount; | |
uint borrowerIndex; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
uint actualRepayAmount; | |
} | |
/** | |
* @notice Borrows are repaid by another user (possibly the borrower). | |
* @param payer the account paying off the borrow | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount the amount of undelrying tokens being returned | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowFresh(address payer, address borrower, uint repayAmount) internal returns (uint, uint) { | |
/* Fail if repayBorrow not allowed */ | |
uint allowed = comptroller.repayBorrowAllowed(address(this), payer, borrower, repayAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REPAY_BORROW_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.REPAY_BORROW_FRESHNESS_CHECK), 0); | |
} | |
RepayBorrowLocalVars memory vars; | |
/* We remember the original borrowerIndex for verification purposes */ | |
vars.borrowerIndex = accountBorrows[borrower].interestIndex; | |
/* We fetch the amount the borrower owes, with accumulated interest */ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return (failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)), 0); | |
} | |
/* If repayAmount == -1, repayAmount = accountBorrows */ | |
if (repayAmount == uint(-1)) { | |
vars.repayAmount = vars.accountBorrows; | |
} else { | |
vars.repayAmount = repayAmount; | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the payer and the repayAmount | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken holds an additional repayAmount of cash. | |
* doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
* it returns the amount actually transferred, in case of a fee. | |
*/ | |
vars.actualRepayAmount = doTransferIn(payer, vars.repayAmount); | |
/* | |
* We calculate the new borrower and total borrow balances, failing on underflow: | |
* accountBorrowsNew = accountBorrows - actualRepayAmount | |
* totalBorrowsNew = totalBorrows - actualRepayAmount | |
*/ | |
(vars.mathErr, vars.accountBorrowsNew) = subUInt(vars.accountBorrows, vars.actualRepayAmount); | |
require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED"); | |
(vars.mathErr, vars.totalBorrowsNew) = subUInt(totalBorrows, vars.actualRepayAmount); | |
require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED"); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a RepayBorrow event */ | |
emit RepayBorrow(payer, borrower, vars.actualRepayAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
comptroller.repayBorrowVerify(address(this), payer, borrower, vars.actualRepayAmount, vars.borrowerIndex); | |
return (uint(Error.NO_ERROR), vars.actualRepayAmount); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this vToken to be liquidated | |
* @param vTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function liquidateBorrowInternal(address borrower, uint repayAmount, VTokenInterface vTokenCollateral) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED), 0); | |
} | |
error = vTokenCollateral.accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED), 0); | |
} | |
// liquidateBorrowFresh emits borrow-specific logs on errors, so we don't need to | |
return liquidateBorrowFresh(msg.sender, borrower, repayAmount, vTokenCollateral); | |
} | |
/** | |
* @notice The liquidator liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this vToken to be liquidated | |
* @param liquidator The address repaying the borrow and seizing collateral | |
* @param vTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function liquidateBorrowFresh(address liquidator, address borrower, uint repayAmount, VTokenInterface vTokenCollateral) internal returns (uint, uint) { | |
/* Fail if liquidate not allowed */ | |
uint allowed = comptroller.liquidateBorrowAllowed(address(this), address(vTokenCollateral), liquidator, borrower, repayAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_FRESHNESS_CHECK), 0); | |
} | |
/* Verify vTokenCollateral market's block number equals current block number */ | |
if (vTokenCollateral.accrualBlockNumber() != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_COLLATERAL_FRESHNESS_CHECK), 0); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return (fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_LIQUIDATOR_IS_BORROWER), 0); | |
} | |
/* Fail if repayAmount = 0 */ | |
if (repayAmount == 0) { | |
return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_ZERO), 0); | |
} | |
/* Fail if repayAmount = -1 */ | |
if (repayAmount == uint(-1)) { | |
return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX), 0); | |
} | |
/* Fail if repayBorrow fails */ | |
(uint repayBorrowError, uint actualRepayAmount) = repayBorrowFresh(liquidator, borrower, repayAmount); | |
if (repayBorrowError != uint(Error.NO_ERROR)) { | |
return (fail(Error(repayBorrowError), FailureInfo.LIQUIDATE_REPAY_BORROW_FRESH_FAILED), 0); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We calculate the number of collateral tokens that will be seized */ | |
(uint amountSeizeError, uint seizeTokens) = comptroller.liquidateCalculateSeizeTokens(address(this), address(vTokenCollateral), actualRepayAmount); | |
require(amountSeizeError == uint(Error.NO_ERROR), "LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED"); | |
/* Revert if borrower collateral token balance < seizeTokens */ | |
require(vTokenCollateral.balanceOf(borrower) >= seizeTokens, "LIQUIDATE_SEIZE_TOO_MUCH"); | |
// If this is also the collateral, run seizeInternal to avoid re-entrancy, otherwise make an external call | |
uint seizeError; | |
if (address(vTokenCollateral) == address(this)) { | |
seizeError = seizeInternal(address(this), liquidator, borrower, seizeTokens); | |
} else { | |
seizeError = vTokenCollateral.seize(liquidator, borrower, seizeTokens); | |
} | |
/* Revert if seize tokens fails (since we cannot be sure of side effects) */ | |
require(seizeError == uint(Error.NO_ERROR), "token seizure failed"); | |
/* We emit a LiquidateBorrow event */ | |
emit LiquidateBorrow(liquidator, borrower, actualRepayAmount, address(vTokenCollateral), seizeTokens); | |
/* We call the defense hook */ | |
comptroller.liquidateBorrowVerify(address(this), address(vTokenCollateral), liquidator, borrower, actualRepayAmount, seizeTokens); | |
return (uint(Error.NO_ERROR), actualRepayAmount); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Will fail unless called by another vToken during the process of liquidation. | |
* Its absolutely critical to use msg.sender as the borrowed vToken and not a parameter. | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of vTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seize(address liquidator, address borrower, uint seizeTokens) external nonReentrant returns (uint) { | |
return seizeInternal(msg.sender, liquidator, borrower, seizeTokens); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Called only during an in-kind liquidation, or by liquidateBorrow during the liquidation of another VToken. | |
* Its absolutely critical to use msg.sender as the seizer vToken and not a parameter. | |
* @param seizerToken The contract seizing the collateral (i.e. borrowed vToken) | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of vTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seizeInternal(address seizerToken, address liquidator, address borrower, uint seizeTokens) internal returns (uint) { | |
/* Fail if seize not allowed */ | |
uint allowed = comptroller.seizeAllowed(address(this), seizerToken, liquidator, borrower, seizeTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER); | |
} | |
MathError mathErr; | |
uint borrowerTokensNew; | |
uint liquidatorTokensNew; | |
/* | |
* We calculate the new borrower and liquidator token balances, failing on underflow/overflow: | |
* borrowerTokensNew = accountTokens[borrower] - seizeTokens | |
* liquidatorTokensNew = accountTokens[liquidator] + seizeTokens | |
*/ | |
(mathErr, borrowerTokensNew) = subUInt(accountTokens[borrower], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, uint(mathErr)); | |
} | |
(mathErr, liquidatorTokensNew) = addUInt(accountTokens[liquidator], seizeTokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, uint(mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accountTokens[borrower] = borrowerTokensNew; | |
accountTokens[liquidator] = liquidatorTokensNew; | |
/* Emit a Transfer event */ | |
emit Transfer(borrower, liquidator, seizeTokens); | |
/* We call the defense hook */ | |
comptroller.seizeVerify(address(this), seizerToken, liquidator, borrower, seizeTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() external returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets a new comptroller for the market | |
* @dev Admin function to set a new comptroller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); | |
} | |
ComptrollerInterface oldComptroller = comptroller; | |
// Ensure invoke comptroller.isComptroller() returns true | |
require(newComptroller.isComptroller(), "marker method returned false"); | |
// Set market's comptroller to newComptroller | |
comptroller = newComptroller; | |
// Emit NewComptroller(oldComptroller, newComptroller) | |
emit NewComptroller(oldComptroller, newComptroller); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh | |
* @dev Admin function to accrue interest and set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactor(uint newReserveFactorMantissa) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reserve factor change failed. | |
return fail(Error(error), FailureInfo.SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED); | |
} | |
// _setReserveFactorFresh emits reserve-factor-specific logs on errors, so we don't need to. | |
return _setReserveFactorFresh(newReserveFactorMantissa); | |
} | |
/** | |
* @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual) | |
* @dev Admin function to set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactorFresh(uint newReserveFactorMantissa) internal returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_RESERVE_FACTOR_ADMIN_CHECK); | |
} | |
// Verify market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_RESERVE_FACTOR_FRESH_CHECK); | |
} | |
// Check newReserveFactor ≤ maxReserveFactor | |
if (newReserveFactorMantissa > reserveFactorMaxMantissa) { | |
return fail(Error.BAD_INPUT, FailureInfo.SET_RESERVE_FACTOR_BOUNDS_CHECK); | |
} | |
uint oldReserveFactorMantissa = reserveFactorMantissa; | |
reserveFactorMantissa = newReserveFactorMantissa; | |
emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring from msg.sender | |
* @param addAmount Amount of addition to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _addReservesInternal(uint addAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.ADD_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _addReservesFresh emits reserve-addition-specific logs on errors, so we don't need to. | |
(error, ) = _addReservesFresh(addAmount); | |
return error; | |
} | |
/** | |
* @notice Add reserves by transferring from caller | |
* @dev Requires fresh interest accrual | |
* @param addAmount Amount of addition to reserves | |
* @return (uint, uint) An error code (0=success, otherwise a failure (see ErrorReporter.sol for details)) and the actual amount added, net token fees | |
*/ | |
function _addReservesFresh(uint addAmount) internal returns (uint, uint) { | |
// totalReserves + actualAddAmount | |
uint totalReservesNew; | |
uint actualAddAmount; | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.ADD_RESERVES_FRESH_CHECK), actualAddAmount); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the caller and the addAmount | |
* Note: The vToken must handle variations between BEP-20 and BNB underlying. | |
* On success, the vToken holds an additional addAmount of cash. | |
* doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
* it returns the amount actually transferred, in case of a fee. | |
*/ | |
actualAddAmount = doTransferIn(msg.sender, addAmount); | |
totalReservesNew = totalReserves + actualAddAmount; | |
/* Revert on overflow */ | |
require(totalReservesNew >= totalReserves, "add reserves unexpected overflow"); | |
// Store reserves[n+1] = reserves[n] + actualAddAmount | |
totalReserves = totalReservesNew; | |
/* Emit NewReserves(admin, actualAddAmount, reserves[n+1]) */ | |
emit ReservesAdded(msg.sender, actualAddAmount, totalReservesNew); | |
/* Return (NO_ERROR, actualAddAmount) */ | |
return (uint(Error.NO_ERROR), actualAddAmount); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring to admin | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReserves(uint reduceAmount) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.REDUCE_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _reduceReservesFresh emits reserve-reduction-specific logs on errors, so we don't need to. | |
return _reduceReservesFresh(reduceAmount); | |
} | |
/** | |
* @notice Reduces reserves by transferring to admin | |
* @dev Requires fresh interest accrual | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReservesFresh(uint reduceAmount) internal returns (uint) { | |
// totalReserves - reduceAmount | |
uint totalReservesNew; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.REDUCE_RESERVES_ADMIN_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDUCE_RESERVES_FRESH_CHECK); | |
} | |
// Fail gracefully if protocol has insufficient underlying cash | |
if (getCashPrior() < reduceAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDUCE_RESERVES_CASH_NOT_AVAILABLE); | |
} | |
// Check reduceAmount ≤ reserves[n] (totalReserves) | |
if (reduceAmount > totalReserves) { | |
return fail(Error.BAD_INPUT, FailureInfo.REDUCE_RESERVES_VALIDATION); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
totalReservesNew = totalReserves - reduceAmount; | |
// We checked reduceAmount <= totalReserves above, so this should never revert. | |
require(totalReservesNew <= totalReserves, "reduce reserves unexpected underflow"); | |
// Store reserves[n+1] = reserves[n] - reduceAmount | |
totalReserves = totalReservesNew; | |
// doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
doTransferOut(admin, reduceAmount); | |
emit ReservesReduced(admin, reduceAmount, totalReservesNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and updates the interest rate model using _setInterestRateModelFresh | |
* @dev Admin function to accrue interest and update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted change of interest rate model failed | |
return fail(Error(error), FailureInfo.SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED); | |
} | |
// _setInterestRateModelFresh emits interest-rate-model-update-specific logs on errors, so we don't need to. | |
return _setInterestRateModelFresh(newInterestRateModel); | |
} | |
/** | |
* @notice updates the interest rate model (*requires fresh interest accrual) | |
* @dev Admin function to update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal returns (uint) { | |
// Used to store old model for use in the event that is emitted on success | |
InterestRateModel oldInterestRateModel; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_INTEREST_RATE_MODEL_OWNER_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_INTEREST_RATE_MODEL_FRESH_CHECK); | |
} | |
// Track the market's current interest rate model | |
oldInterestRateModel = interestRateModel; | |
// Ensure invoke newInterestRateModel.isInterestRateModel() returns true | |
require(newInterestRateModel.isInterestRateModel(), "marker method returned false"); | |
// Set the interest rate model to newInterestRateModel | |
interestRateModel = newInterestRateModel; | |
// Emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel) | |
emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint); | |
/** | |
* @dev Performs a transfer in, reverting upon failure. Returns the amount actually transferred to the protocol, in case of a fee. | |
* This may revert due to insufficient balance or insufficient allowance. | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (uint); | |
/** | |
* @dev Performs a transfer out, ideally returning an explanatory error code upon failure tather than reverting. | |
* If caller has not called checked protocol's balance, may revert due to insufficient cash held in the contract. | |
* If caller has checked protocol's balance, and verified it is >= amount, this should not revert in normal conditions. | |
*/ | |
function doTransferOut(address payable to, uint amount) internal; | |
/*** Reentrancy Guard ***/ | |
/** | |
* @dev Prevents a contract from calling itself, directly or indirectly. | |
*/ | |
modifier nonReentrant() { | |
require(_notEntered, "re-entered"); | |
_notEntered = false; | |
_; | |
_notEntered = true; // get a gas-refund post-Istanbul | |
} | |
} | |
// File: PriceOracle.sol | |
pragma solidity ^0.5.16; | |
contract PriceOracle { | |
/// @notice Indicator that this is a PriceOracle contract (for inspection) | |
bool public constant isPriceOracle = true; | |
/** | |
* @notice Get the underlying price of a vToken asset | |
* @param vToken The vToken to get the underlying price of | |
* @return The underlying asset price mantissa (scaled by 1e18). | |
* Zero means the price is unavailable. | |
*/ | |
function getUnderlyingPrice(VToken vToken) external view returns (uint); | |
} | |
// File: VBep20.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Benqi's VBep20 Contract | |
* @notice VTokens which wrap an EIP-20 underlying | |
* @author Benqi | |
*/ | |
contract VBep20 is VToken, VBep20Interface { | |
/** | |
* @notice Initialize the new money market | |
* @param underlying_ The address of the underlying asset | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ BEP-20 name of this token | |
* @param symbol_ BEP-20 symbol of this token | |
* @param decimals_ BEP-20 decimal precision of this token | |
*/ | |
function initialize(address underlying_, | |
ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_) public { | |
// VToken initialize does the bulk of the work | |
super.initialize(comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_); | |
// Set underlying and sanity check it | |
underlying = underlying_; | |
EIP20Interface(underlying).totalSupply(); | |
} | |
/*** User Interface ***/ | |
/** | |
* @notice Sender supplies assets into the market and receives vTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function mint(uint mintAmount) external returns (uint) { | |
(uint err,) = mintInternal(mintAmount); | |
return err; | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of vTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeem(uint redeemTokens) external returns (uint) { | |
return redeemInternal(redeemTokens); | |
} | |
/** | |
* @notice Sender redeems vTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to redeem | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlying(uint redeemAmount) external returns (uint) { | |
return redeemUnderlyingInternal(redeemAmount); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrow(uint borrowAmount) external returns (uint) { | |
return borrowInternal(borrowAmount); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrow(uint repayAmount) external returns (uint) { | |
(uint err,) = repayBorrowInternal(repayAmount); | |
return err; | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function repayBorrowBehalf(address borrower, uint repayAmount) external returns (uint) { | |
(uint err,) = repayBorrowBehalfInternal(borrower, repayAmount); | |
return err; | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this vToken to be liquidated | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @param vTokenCollateral The market in which to seize collateral from the borrower | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrow(address borrower, uint repayAmount, VTokenInterface vTokenCollateral) external returns (uint) { | |
(uint err,) = liquidateBorrowInternal(borrower, repayAmount, vTokenCollateral); | |
return err; | |
} | |
/** | |
* @notice The sender adds to reserves. | |
* @param addAmount The amount fo underlying token to add as reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _addReserves(uint addAmount) external returns (uint) { | |
return _addReservesInternal(addAmount); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying tokens owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint) { | |
EIP20Interface token = EIP20Interface(underlying); | |
return token.balanceOf(address(this)); | |
} | |
/** | |
* @dev Similar to EIP20 transfer, except it handles a False result from `transferFrom` and reverts in that case. | |
* This will revert due to insufficient balance or insufficient allowance. | |
* This function returns the actual amount received, | |
* which may be less than `amount` if there is a fee attached to the transfer. | |
* | |
* Note: This wrapper safely handles non-standard BEP-20 tokens that do not return a value. | |
* See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (uint) { | |
EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); | |
uint balanceBefore = EIP20Interface(underlying).balanceOf(address(this)); | |
token.transferFrom(from, address(this), amount); | |
bool success; | |
assembly { | |
switch returndatasize() | |
case 0 { // This is a non-standard BEP-20 | |
success := not(0) // set success to true | |
} | |
case 32 { // This is a compliant BEP-20 | |
returndatacopy(0, 0, 32) | |
success := mload(0) // Set `success = returndata` of external call | |
} | |
default { // This is an excessively non-compliant BEP-20, revert. | |
revert(0, 0) | |
} | |
} | |
require(success, "TOKEN_TRANSFER_IN_FAILED"); | |
// Calculate the amount that was *actually* transferred | |
uint balanceAfter = EIP20Interface(underlying).balanceOf(address(this)); | |
require(balanceAfter >= balanceBefore, "TOKEN_TRANSFER_IN_OVERFLOW"); | |
return balanceAfter - balanceBefore; // underflow already checked above, just subtract | |
} | |
/** | |
* @dev Similar to EIP20 transfer, except it handles a False success from `transfer` and returns an explanatory | |
* error code rather than reverting. If caller has not called checked protocol's balance, this may revert due to | |
* insufficient cash held in this contract. If caller has checked protocol's balance prior to this call, and verified | |
* it is >= amount, this should not revert in normal conditions. | |
* | |
* Note: This wrapper safely handles non-standard BEP-20 tokens that do not return a value. | |
* See here: https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
function doTransferOut(address payable to, uint amount) internal { | |
EIP20NonStandardInterface token = EIP20NonStandardInterface(underlying); | |
token.transfer(to, amount); | |
bool success; | |
assembly { | |
switch returndatasize() | |
case 0 { // This is a non-standard BEP-20 | |
success := not(0) // set success to true | |
} | |
case 32 { // This is a complaint BEP-20 | |
returndatacopy(0, 0, 32) | |
success := mload(0) // Set `success = returndata` of external call | |
} | |
default { // This is an excessively non-compliant BEP-20, revert. | |
revert(0, 0) | |
} | |
} | |
require(success, "TOKEN_TRANSFER_OUT_FAILED"); | |
} | |
} | |
// File: BEP20Interface.sol | |
pragma solidity ^0.5.16; | |
interface BEP20Interface { | |
/** | |
* @dev Returns the amount of tokens in existence. | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @dev Returns the token decimals. | |
*/ | |
function decimals() external view returns (uint8); | |
/** | |
* @dev Returns the token symbol. | |
*/ | |
function symbol() external view returns (string memory); | |
/** | |
* @dev Returns the token name. | |
*/ | |
function name() external view returns (string memory); | |
/** | |
* @dev Returns the bep token owner. | |
*/ | |
function getOwner() external view returns (address); | |
/** | |
* @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 `recipient`. | |
* | |
* Returns a boolean value indicating whether the operation succeeded. | |
* | |
* Emits a {Transfer} event. | |
*/ | |
function transfer(address recipient, 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 `sender` to `recipient` 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 sender, address recipient, uint256 amount) external returns (bool); | |
/** | |
* @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); | |
} | |
// File: SafeMath.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @dev Wrappers over Solidity's arithmetic operations with added overflow | |
* checks. | |
* | |
* Arithmetic operations in Solidity wrap on overflow. This can easily result | |
* in bugs, because programmers usually assume that an overflow raises an | |
* error, which is the standard behavior in high level programming languages. | |
* `SafeMath` restores this intuition by reverting the transaction when an | |
* operation overflows. | |
* | |
* Using this library instead of the unchecked operations eliminates an entire | |
* class of bugs, so it's recommended to use it always. | |
*/ | |
library SafeMath { | |
/** | |
* @dev Returns the addition of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `+` operator. | |
* | |
* Requirements: | |
* - Addition cannot overflow. | |
*/ | |
function add(uint256 a, uint256 b) internal pure returns (uint256) { | |
return add(a, b, "SafeMath: addition overflow"); | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* - Subtraction cannot overflow. | |
*/ | |
function add(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
uint256 c = a + b; | |
require(c >= a, errorMessage); | |
return c; | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b) internal pure returns (uint256) { | |
return sub(a, b, "SafeMath: subtraction overflow"); | |
} | |
/** | |
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on | |
* overflow (when the result is negative). | |
* | |
* Counterpart to Solidity's `-` operator. | |
* | |
* Requirements: | |
* - Subtraction cannot overflow. | |
*/ | |
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b <= a, errorMessage); | |
uint256 c = a - b; | |
return c; | |
} | |
/** | |
* @dev Returns the multiplication of two unsigned integers, reverting on | |
* overflow. | |
* | |
* Counterpart to Solidity's `*` operator. | |
* | |
* Requirements: | |
* - Multiplication cannot overflow. | |
*/ | |
function mul(uint256 a, uint256 b) internal pure returns (uint256) { | |
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the | |
// benefit is lost if 'b' is also tested. | |
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 | |
if (a == 0) { | |
return 0; | |
} | |
uint256 c = a * b; | |
require(c / a == b, "SafeMath: multiplication overflow"); | |
return c; | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b) internal pure returns (uint256) { | |
return div(a, b, "SafeMath: division by zero"); | |
} | |
/** | |
* @dev Returns the integer division of two unsigned integers. Reverts with custom message on | |
* division by zero. The result is rounded towards zero. | |
* | |
* Counterpart to Solidity's `/` operator. Note: this function uses a | |
* `revert` opcode (which leaves remaining gas untouched) while Solidity | |
* uses an invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
// Solidity only automatically asserts when dividing by 0 | |
require(b > 0, errorMessage); | |
uint256 c = a / b; | |
// assert(a == b * c + a % b); // There is no case in which this doesn't hold | |
return c; | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b) internal pure returns (uint256) { | |
return mod(a, b, "SafeMath: modulo by zero"); | |
} | |
/** | |
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), | |
* Reverts with custom message when dividing by zero. | |
* | |
* Counterpart to Solidity's `%` operator. This function uses a `revert` | |
* opcode (which leaves remaining gas untouched) while Solidity uses an | |
* invalid opcode to revert (consuming all remaining gas). | |
* | |
* Requirements: | |
* - The divisor cannot be zero. | |
*/ | |
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { | |
require(b != 0, errorMessage); | |
return a % b; | |
} | |
} | |
// File: AggregatorV2V3Interface.sol | |
pragma solidity >=0.5.0; | |
/** | |
* @title The V2 & V3 Aggregator Interface | |
* @notice Solidity V0.5 does not allow interfaces to inherit from other | |
* interfaces so this contract is a combination of v0.5 AggregatorInterface.sol | |
* and v0.5 AggregatorV3Interface.sol. | |
*/ | |
interface AggregatorV2V3Interface { | |
// | |
// V2 Interface: | |
// | |
function latestAnswer() external view returns (int256); | |
function latestTimestamp() external view returns (uint256); | |
function latestRound() external view returns (uint256); | |
function getAnswer(uint256 roundId) external view returns (int256); | |
function getTimestamp(uint256 roundId) external view returns (uint256); | |
event AnswerUpdated(int256 indexed current, uint256 indexed roundId, uint256 timestamp); | |
event NewRound(uint256 indexed roundId, address indexed startedBy, uint256 startedAt); | |
// | |
// V3 Interface: | |
// | |
function decimals() external view returns (uint8); | |
function description() external view returns (string memory); | |
function version() external view returns (uint256); | |
// getRoundData and latestRoundData should both raise "No data present" | |
// if they do not have data to report, instead of returning unset values | |
// which could be misinterpreted as actual reported values. | |
function getRoundData(uint80 _roundId) | |
external | |
view | |
returns ( | |
uint80 roundId, | |
int256 answer, | |
uint256 startedAt, | |
uint256 updatedAt, | |
uint80 answeredInRound | |
); | |
function latestRoundData() | |
external | |
view | |
returns ( | |
uint80 roundId, | |
int256 answer, | |
uint256 startedAt, | |
uint256 updatedAt, | |
uint80 answeredInRound | |
); | |
} | |
// File: ChainlinkOracle.sol | |
pragma solidity 0.5.16; | |
contract ChainlinkOracle is PriceOracle { | |
using SafeMath for uint; | |
uint public constant VAI_VALUE = 1e18; | |
address public admin; | |
mapping(address => uint) internal prices; | |
mapping(bytes32 => AggregatorV2V3Interface) internal feeds; | |
event PricePosted(address asset, uint previousPriceMantissa, uint requestedPriceMantissa, uint newPriceMantissa); | |
event NewAdmin(address oldAdmin, address newAdmin); | |
event FeedSet(address feed, string symbol); | |
constructor() public { | |
admin = msg.sender; | |
} | |
function getUnderlyingPrice(VToken vToken) public view returns (uint) { | |
string memory symbol = vToken.symbol(); | |
if (compareStrings(symbol, "vBNB")) { | |
return getChainlinkPrice(getFeed(symbol)); | |
} else if (compareStrings(symbol, "VAI")) { | |
return VAI_VALUE; | |
} else if (compareStrings(symbol, "XVS")) { | |
return prices[address(vToken)]; | |
} else { | |
return getPrice(vToken); | |
} | |
} | |
function getPrice(VToken vToken) internal view returns (uint price) { | |
BEP20Interface token = BEP20Interface(VBep20(address(vToken)).underlying()); | |
if (prices[address(token)] != 0) { | |
price = prices[address(token)]; | |
} else { | |
price = getChainlinkPrice(getFeed(token.symbol())); | |
} | |
uint decimalDelta = uint(18).sub(uint(token.decimals())); | |
// Ensure that we don't multiply the result by 0 | |
if (decimalDelta > 0) { | |
return price.mul(10**decimalDelta); | |
} else { | |
return price; | |
} | |
} | |
function getChainlinkPrice(AggregatorV2V3Interface feed) internal view returns (uint) { | |
// Chainlink USD-denominated feeds store answers at 8 decimals | |
uint decimalDelta = uint(18).sub(feed.decimals()); | |
// Ensure that we don't multiply the result by 0 | |
if (decimalDelta > 0) { | |
return uint(feed.latestAnswer()).mul(10**decimalDelta); | |
} else { | |
return uint(feed.latestAnswer()); | |
} | |
} | |
function setUnderlyingPrice(VToken vToken, uint underlyingPriceMantissa) external onlyAdmin() { | |
address asset = address(VBep20(address(vToken)).underlying()); | |
emit PricePosted(asset, prices[asset], underlyingPriceMantissa, underlyingPriceMantissa); | |
prices[asset] = underlyingPriceMantissa; | |
} | |
function setDirectPrice(address asset, uint price) external onlyAdmin() { | |
emit PricePosted(asset, prices[asset], price, price); | |
prices[asset] = price; | |
} | |
function setFeed(string calldata symbol, address feed) external onlyAdmin() { | |
require(feed != address(0) && feed != address(this), "invalid feed address"); | |
emit FeedSet(feed, symbol); | |
feeds[keccak256(abi.encodePacked(symbol))] = AggregatorV2V3Interface(feed); | |
} | |
function getFeed(string memory symbol) public view returns (AggregatorV2V3Interface) { | |
return feeds[keccak256(abi.encodePacked(symbol))]; | |
} | |
function assetPrices(address asset) external view returns (uint) { | |
return prices[asset]; | |
} | |
function compareStrings(string memory a, string memory b) internal pure returns (bool) { | |
return (keccak256(abi.encodePacked((a))) == keccak256(abi.encodePacked((b)))); | |
} | |
function setAdmin(address newAdmin) external onlyAdmin() { | |
address oldAdmin = admin; | |
admin = newAdmin; | |
emit NewAdmin(oldAdmin, newAdmin); | |
} | |
modifier onlyAdmin() { | |
require(msg.sender == admin, "only admin may call"); | |
_; | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pragma solidity ^0.5.16; | |
import "https://github.com/compound-finance/compound-protocol/blob/master/contracts/ErrorReporter.sol"; | |
import "https://github.com/compound-finance/compound-protocol/blob/master/contracts/ComptrollerStorage.sol"; | |
/** | |
* @title ComptrollerCore | |
* @dev Storage for the comptroller is at this address, while execution is delegated to the `comptrollerImplementation`. | |
* CTokens should reference this contract as their comptroller. | |
*/ | |
contract Unitroller is UnitrollerAdminStorage, ComptrollerErrorReporter { | |
/** | |
* @notice Emitted when pendingComptrollerImplementation is changed | |
*/ | |
event NewPendingImplementation(address oldPendingImplementation, address newPendingImplementation); | |
/** | |
* @notice Emitted when pendingComptrollerImplementation is accepted, which means comptroller implementation is updated | |
*/ | |
event NewImplementation(address oldImplementation, address newImplementation); | |
/** | |
* @notice Emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
constructor() public { | |
// Set admin to caller | |
admin = msg.sender; | |
} | |
/*** Admin Functions ***/ | |
function _setPendingImplementation(address newPendingImplementation) public returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_IMPLEMENTATION_OWNER_CHECK); | |
} | |
address oldPendingImplementation = pendingComptrollerImplementation; | |
pendingComptrollerImplementation = newPendingImplementation; | |
emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts new implementation of comptroller. msg.sender must be pendingImplementation | |
* @dev Admin function for new implementation to accept it's role as implementation | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptImplementation() public returns (uint) { | |
// Check caller is pendingImplementation and pendingImplementation ≠ address(0) | |
if (msg.sender != pendingComptrollerImplementation || pendingComptrollerImplementation == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldImplementation = comptrollerImplementation; | |
address oldPendingImplementation = pendingComptrollerImplementation; | |
comptrollerImplementation = pendingComptrollerImplementation; | |
pendingComptrollerImplementation = address(0); | |
emit NewImplementation(oldImplementation, comptrollerImplementation); | |
emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address newPendingAdmin) public returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() public returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @dev Delegates execution to an implementation contract. | |
* It returns to the external caller whatever the implementation returns | |
* or forwards reverts. | |
*/ | |
function () payable external { | |
// delegate all other functions to current implementation | |
(bool success, ) = comptrollerImplementation.delegatecall(msg.data); | |
assembly { | |
let free_mem_ptr := mload(0x40) | |
returndatacopy(free_mem_ptr, 0, returndatasize) | |
switch success | |
case 0 { revert(free_mem_ptr, returndatasize) } | |
default { return(free_mem_ptr, returndatasize) } | |
} | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/EIP20Interface.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title ERC 20 Token Standard Interface | |
* https://eips.ethereum.org/EIPS/eip-20 | |
*/ | |
interface EIP20Interface { | |
function name() external view returns (string memory); | |
function symbol() external view returns (string memory); | |
function decimals() external view returns (uint8); | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external returns (bool success); | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/ExponentialNoError.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Exponential module for storing fixed-precision decimals | |
* @author Compound | |
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. | |
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: | |
* `Exp({mantissa: 5100000000000000000})`. | |
*/ | |
contract ExponentialNoError { | |
uint constant expScale = 1e18; | |
uint constant doubleScale = 1e36; | |
uint constant halfExpScale = expScale/2; | |
uint constant mantissaOne = expScale; | |
struct Exp { | |
uint mantissa; | |
} | |
struct Double { | |
uint mantissa; | |
} | |
/** | |
* @dev Truncates the given exp to a whole number value. | |
* For example, truncate(Exp{mantissa: 15 * expScale}) = 15 | |
*/ | |
function truncate(Exp memory exp) pure internal returns (uint) { | |
// Note: We are not using careful math here as we're performing a division that cannot fail | |
return exp.mantissa / expScale; | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. | |
*/ | |
function mul_ScalarTruncate(Exp memory a, uint scalar) pure internal returns (uint) { | |
Exp memory product = mul_(a, scalar); | |
return truncate(product); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. | |
*/ | |
function mul_ScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) pure internal returns (uint) { | |
Exp memory product = mul_(a, scalar); | |
return add_(truncate(product), addend); | |
} | |
/** | |
* @dev Checks if first Exp is less than second Exp. | |
*/ | |
function lessThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa < right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp <= right Exp. | |
*/ | |
function lessThanOrEqualExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa <= right.mantissa; | |
} | |
/** | |
* @dev Checks if left Exp > right Exp. | |
*/ | |
function greaterThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa > right.mantissa; | |
} | |
/** | |
* @dev returns true if Exp is exactly zero | |
*/ | |
function isZeroExp(Exp memory value) pure internal returns (bool) { | |
return value.mantissa == 0; | |
} | |
function safe224(uint n, string memory errorMessage) pure internal returns (uint224) { | |
require(n < 2**224, errorMessage); | |
return uint224(n); | |
} | |
function safe32(uint n, string memory errorMessage) pure internal returns (uint32) { | |
require(n < 2**32, errorMessage); | |
return uint32(n); | |
} | |
function add_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { | |
return Exp({mantissa: add_(a.mantissa, b.mantissa)}); | |
} | |
function add_(Double memory a, Double memory b) pure internal returns (Double memory) { | |
return Double({mantissa: add_(a.mantissa, b.mantissa)}); | |
} | |
function add_(uint a, uint b) pure internal returns (uint) { | |
return add_(a, b, "addition overflow"); | |
} | |
function add_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { | |
uint c = a + b; | |
require(c >= a, errorMessage); | |
return c; | |
} | |
function sub_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { | |
return Exp({mantissa: sub_(a.mantissa, b.mantissa)}); | |
} | |
function sub_(Double memory a, Double memory b) pure internal returns (Double memory) { | |
return Double({mantissa: sub_(a.mantissa, b.mantissa)}); | |
} | |
function sub_(uint a, uint b) pure internal returns (uint) { | |
return sub_(a, b, "subtraction underflow"); | |
} | |
function sub_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { | |
require(b <= a, errorMessage); | |
return a - b; | |
} | |
function mul_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { | |
return Exp({mantissa: mul_(a.mantissa, b.mantissa) / expScale}); | |
} | |
function mul_(Exp memory a, uint b) pure internal returns (Exp memory) { | |
return Exp({mantissa: mul_(a.mantissa, b)}); | |
} | |
function mul_(uint a, Exp memory b) pure internal returns (uint) { | |
return mul_(a, b.mantissa) / expScale; | |
} | |
function mul_(Double memory a, Double memory b) pure internal returns (Double memory) { | |
return Double({mantissa: mul_(a.mantissa, b.mantissa) / doubleScale}); | |
} | |
function mul_(Double memory a, uint b) pure internal returns (Double memory) { | |
return Double({mantissa: mul_(a.mantissa, b)}); | |
} | |
function mul_(uint a, Double memory b) pure internal returns (uint) { | |
return mul_(a, b.mantissa) / doubleScale; | |
} | |
function mul_(uint a, uint b) pure internal returns (uint) { | |
return mul_(a, b, "multiplication overflow"); | |
} | |
function mul_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { | |
if (a == 0 || b == 0) { | |
return 0; | |
} | |
uint c = a * b; | |
require(c / a == b, errorMessage); | |
return c; | |
} | |
function div_(Exp memory a, Exp memory b) pure internal returns (Exp memory) { | |
return Exp({mantissa: div_(mul_(a.mantissa, expScale), b.mantissa)}); | |
} | |
function div_(Exp memory a, uint b) pure internal returns (Exp memory) { | |
return Exp({mantissa: div_(a.mantissa, b)}); | |
} | |
function div_(uint a, Exp memory b) pure internal returns (uint) { | |
return div_(mul_(a, expScale), b.mantissa); | |
} | |
function div_(Double memory a, Double memory b) pure internal returns (Double memory) { | |
return Double({mantissa: div_(mul_(a.mantissa, doubleScale), b.mantissa)}); | |
} | |
function div_(Double memory a, uint b) pure internal returns (Double memory) { | |
return Double({mantissa: div_(a.mantissa, b)}); | |
} | |
function div_(uint a, Double memory b) pure internal returns (uint) { | |
return div_(mul_(a, doubleScale), b.mantissa); | |
} | |
function div_(uint a, uint b) pure internal returns (uint) { | |
return div_(a, b, "divide by zero"); | |
} | |
function div_(uint a, uint b, string memory errorMessage) pure internal returns (uint) { | |
require(b > 0, errorMessage); | |
return a / b; | |
} | |
function fraction(uint a, uint b) pure internal returns (Double memory) { | |
return Double({mantissa: div_(mul_(a, doubleScale), b)}); | |
} | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/CarefulMath.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Careful Math | |
* @author Compound | |
* @notice Derived from OpenZeppelin's SafeMath library | |
* https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/math/SafeMath.sol | |
*/ | |
contract CarefulMath { | |
/** | |
* @dev Possible error codes that we can return | |
*/ | |
enum MathError { | |
NO_ERROR, | |
DIVISION_BY_ZERO, | |
INTEGER_OVERFLOW, | |
INTEGER_UNDERFLOW | |
} | |
/** | |
* @dev Multiplies two numbers, returns an error on overflow. | |
*/ | |
function mulUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (a == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
uint c = a * b; | |
if (c / a != b) { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} else { | |
return (MathError.NO_ERROR, c); | |
} | |
} | |
/** | |
* @dev Integer division of two numbers, truncating the quotient. | |
*/ | |
function divUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b == 0) { | |
return (MathError.DIVISION_BY_ZERO, 0); | |
} | |
return (MathError.NO_ERROR, a / b); | |
} | |
/** | |
* @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). | |
*/ | |
function subUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b <= a) { | |
return (MathError.NO_ERROR, a - b); | |
} else { | |
return (MathError.INTEGER_UNDERFLOW, 0); | |
} | |
} | |
/** | |
* @dev Adds two numbers, returns an error on overflow. | |
*/ | |
function addUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
uint c = a + b; | |
if (c >= a) { | |
return (MathError.NO_ERROR, c); | |
} else { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} | |
} | |
/** | |
* @dev add a and b and then subtract c | |
*/ | |
function addThenSubUInt(uint a, uint b, uint c) internal pure returns (MathError, uint) { | |
(MathError err0, uint sum) = addUInt(a, b); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, 0); | |
} | |
return subUInt(sum, c); | |
} | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/Exponential.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Exponential module for storing fixed-precision decimals | |
* @author Compound | |
* @dev Legacy contract for compatibility reasons with existing contracts that still use MathError | |
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. | |
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: | |
* `Exp({mantissa: 5100000000000000000})`. | |
*/ | |
contract Exponential is CarefulMath, ExponentialNoError { | |
/** | |
* @dev Creates an exponential from numerator and denominator values. | |
* Note: Returns an error if (`num` * 10e18) > MAX_INT, | |
* or if `denom` is zero. | |
*/ | |
function getExp(uint num, uint denom) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledNumerator) = mulUInt(num, expScale); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
(MathError err1, uint rational) = divUInt(scaledNumerator, denom); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: rational})); | |
} | |
/** | |
* @dev Adds two exponentials, returning a new exponential. | |
*/ | |
function addExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = addUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Subtracts two exponentials, returning a new exponential. | |
*/ | |
function subExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = subUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, returning a new Exp. | |
*/ | |
function mulScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledMantissa) = mulUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: scaledMantissa})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. | |
*/ | |
function mulScalarTruncate(Exp memory a, uint scalar) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(product)); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. | |
*/ | |
function mulScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return addUInt(truncate(product), addend); | |
} | |
/** | |
* @dev Divide an Exp by a scalar, returning a new Exp. | |
*/ | |
function divScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint descaledMantissa) = divUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: descaledMantissa})); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, returning a new Exp. | |
*/ | |
function divScalarByExp(uint scalar, Exp memory divisor) pure internal returns (MathError, Exp memory) { | |
/* | |
We are doing this as: | |
getExp(mulUInt(expScale, scalar), divisor.mantissa) | |
How it works: | |
Exp = a / b; | |
Scalar = s; | |
`s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` | |
*/ | |
(MathError err0, uint numerator) = mulUInt(expScale, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return getExp(numerator, divisor.mantissa); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, then truncate to return an unsigned integer. | |
*/ | |
function divScalarByExpTruncate(uint scalar, Exp memory divisor) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory fraction) = divScalarByExp(scalar, divisor); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(fraction)); | |
} | |
/** | |
* @dev Multiplies two exponentials, returning a new exponential. | |
*/ | |
function mulExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint doubleScaledProduct) = mulUInt(a.mantissa, b.mantissa); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
// We add half the scale before dividing so that we get rounding instead of truncation. | |
// See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 | |
// Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. | |
(MathError err1, uint doubleScaledProductWithHalfScale) = addUInt(halfExpScale, doubleScaledProduct); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
(MathError err2, uint product) = divUInt(doubleScaledProductWithHalfScale, expScale); | |
// The only error `div` can return is MathError.DIVISION_BY_ZERO but we control `expScale` and it is not zero. | |
assert(err2 == MathError.NO_ERROR); | |
return (MathError.NO_ERROR, Exp({mantissa: product})); | |
} | |
/** | |
* @dev Multiplies two exponentials given their mantissas, returning a new exponential. | |
*/ | |
function mulExp(uint a, uint b) pure internal returns (MathError, Exp memory) { | |
return mulExp(Exp({mantissa: a}), Exp({mantissa: b})); | |
} | |
/** | |
* @dev Multiplies three exponentials, returning a new exponential. | |
*/ | |
function mulExp3(Exp memory a, Exp memory b, Exp memory c) pure internal returns (MathError, Exp memory) { | |
(MathError err, Exp memory ab) = mulExp(a, b); | |
if (err != MathError.NO_ERROR) { | |
return (err, ab); | |
} | |
return mulExp(ab, c); | |
} | |
/** | |
* @dev Divides two exponentials, returning a new exponential. | |
* (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, | |
* which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) | |
*/ | |
function divExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
return getExp(a.mantissa, b.mantissa); | |
} | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/EIP20NonStandardInterface.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title EIP20NonStandardInterface | |
* @dev Version of ERC20 with no return values for `transfer` and `transferFrom` | |
* See https://medium.com/coinmonks/missing-return-value-bug-at-least-130-tokens-affected-d67bf08521ca | |
*/ | |
interface EIP20NonStandardInterface { | |
/** | |
* @notice Get the total number of tokens in circulation | |
* @return The supply of tokens | |
*/ | |
function totalSupply() external view returns (uint256); | |
/** | |
* @notice Gets the balance of the specified address | |
* @param owner The address from which the balance will be retrieved | |
* @return The balance | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transfer` does not return a value, in violation of the ERC-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transfer(address dst, uint256 amount) external; | |
/// | |
/// !!!!!!!!!!!!!! | |
/// !!! NOTICE !!! `transferFrom` does not return a value, in violation of the ERC-20 specification | |
/// !!!!!!!!!!!!!! | |
/// | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external; | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool success); | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256 remaining); | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/InterestRateModel.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Compound's InterestRateModel Interface | |
* @author Compound | |
*/ | |
contract InterestRateModel { | |
/// @notice Indicator that this is an InterestRateModel contract (for inspection) | |
bool public constant isInterestRateModel = true; | |
/** | |
* @notice Calculates the current borrow interest rate per block | |
* @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 block (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 block | |
* @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 block (as a percentage, and scaled by 1e18) | |
*/ | |
function getSupplyRate(uint cash, uint borrows, uint reserves, uint reserveFactorMantissa) external view returns (uint); | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/ComptrollerInterface.sol | |
pragma solidity ^0.5.16; | |
contract ComptrollerInterface { | |
/// @notice Indicator that this is a Comptroller contract (for inspection) | |
bool public constant isComptroller = true; | |
/*** Assets You Are In ***/ | |
function enterMarkets(address[] calldata cTokens) external returns (uint[] memory); | |
function exitMarket(address cToken) external returns (uint); | |
/*** Policy Hooks ***/ | |
function mintAllowed(address cToken, address minter, uint mintAmount) external returns (uint); | |
function mintVerify(address cToken, address minter, uint mintAmount, uint mintTokens) external; | |
function redeemAllowed(address cToken, address redeemer, uint redeemTokens) external returns (uint); | |
function redeemVerify(address cToken, address redeemer, uint redeemAmount, uint redeemTokens) external; | |
function borrowAllowed(address cToken, address borrower, uint borrowAmount) external returns (uint); | |
function borrowVerify(address cToken, address borrower, uint borrowAmount) external; | |
function repayBorrowAllowed( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function repayBorrowVerify( | |
address cToken, | |
address payer, | |
address borrower, | |
uint repayAmount, | |
uint borrowerIndex) external; | |
function liquidateBorrowAllowed( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external returns (uint); | |
function liquidateBorrowVerify( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount, | |
uint seizeTokens) external; | |
function seizeAllowed( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external returns (uint); | |
function seizeVerify( | |
address cTokenCollateral, | |
address cTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external; | |
function transferAllowed(address cToken, address src, address dst, uint transferTokens) external returns (uint); | |
function transferVerify(address cToken, address src, address dst, uint transferTokens) external; | |
/*** Liquidity/Liquidation Calculations ***/ | |
function liquidateCalculateSeizeTokens( | |
address cTokenBorrowed, | |
address cTokenCollateral, | |
uint repayAmount) external view returns (uint, uint); | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/CTokenInterfaces.sol | |
pragma solidity ^0.5.16; | |
contract CTokenStorage { | |
/** | |
* @dev Guard variable for re-entrancy checks | |
*/ | |
bool internal _notEntered; | |
/** | |
* @notice EIP-20 token name for this token | |
*/ | |
string public name; | |
/** | |
* @notice EIP-20 token symbol for this token | |
*/ | |
string public symbol; | |
/** | |
* @notice EIP-20 token decimals for this token | |
*/ | |
uint8 public decimals; | |
/** | |
* @notice Maximum borrow rate that can ever be applied (.0005% / block) | |
*/ | |
uint internal constant borrowRateMaxMantissa = 0.0005e16; | |
/** | |
* @notice Maximum fraction of interest that can be set aside for reserves | |
*/ | |
uint internal constant reserveFactorMaxMantissa = 1e18; | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address payable public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address payable public pendingAdmin; | |
/** | |
* @notice Contract which oversees inter-cToken operations | |
*/ | |
ComptrollerInterface public comptroller; | |
/** | |
* @notice Model which tells what the current interest rate should be | |
*/ | |
InterestRateModel public interestRateModel; | |
/** | |
* @notice Initial exchange rate used when minting the first CTokens (used when totalSupply = 0) | |
*/ | |
uint internal initialExchangeRateMantissa; | |
/** | |
* @notice Fraction of interest currently set aside for reserves | |
*/ | |
uint public reserveFactorMantissa; | |
/** | |
* @notice Block number that interest was last accrued at | |
*/ | |
uint public accrualBlockNumber; | |
/** | |
* @notice Accumulator of the total earned interest rate since the opening of the market | |
*/ | |
uint public borrowIndex; | |
/** | |
* @notice Total amount of outstanding borrows of the underlying in this market | |
*/ | |
uint public totalBorrows; | |
/** | |
* @notice Total amount of reserves of the underlying held in this market | |
*/ | |
uint public totalReserves; | |
/** | |
* @notice Total number of tokens in circulation | |
*/ | |
uint public totalSupply; | |
/** | |
* @notice Official record of token balances for each account | |
*/ | |
mapping (address => uint) internal accountTokens; | |
/** | |
* @notice Approved token transfer amounts on behalf of others | |
*/ | |
mapping (address => mapping (address => uint)) internal transferAllowances; | |
/** | |
* @notice Container for borrow balance information | |
* @member principal Total balance (with accrued interest), after applying the most recent balance-changing action | |
* @member interestIndex Global borrowIndex as of the most recent balance-changing action | |
*/ | |
struct BorrowSnapshot { | |
uint principal; | |
uint interestIndex; | |
} | |
/** | |
* @notice Mapping of account addresses to outstanding borrow balances | |
*/ | |
mapping(address => BorrowSnapshot) internal accountBorrows; | |
/** | |
* @notice Share of seized collateral that is added to reserves | |
*/ | |
uint public constant protocolSeizeShareMantissa = 2.8e16; //2.8% | |
} | |
contract CTokenInterface is CTokenStorage { | |
/** | |
* @notice Indicator that this is a CToken contract (for inspection) | |
*/ | |
bool public constant isCToken = true; | |
/*** Market Events ***/ | |
/** | |
* @notice Event emitted when interest is accrued | |
*/ | |
event AccrueInterest(uint cashPrior, uint interestAccumulated, uint borrowIndex, uint totalBorrows); | |
/** | |
* @notice Event emitted when tokens are minted | |
*/ | |
event Mint(address minter, uint mintAmount, uint mintTokens); | |
/** | |
* @notice Event emitted when tokens are redeemed | |
*/ | |
event Redeem(address redeemer, uint redeemAmount, uint redeemTokens); | |
/** | |
* @notice Event emitted when underlying is borrowed | |
*/ | |
event Borrow(address borrower, uint borrowAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is repaid | |
*/ | |
event RepayBorrow(address payer, address borrower, uint repayAmount, uint accountBorrows, uint totalBorrows); | |
/** | |
* @notice Event emitted when a borrow is liquidated | |
*/ | |
event LiquidateBorrow(address liquidator, address borrower, uint repayAmount, address cTokenCollateral, uint seizeTokens); | |
/*** Admin Events ***/ | |
/** | |
* @notice Event emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Event emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
/** | |
* @notice Event emitted when comptroller is changed | |
*/ | |
event NewComptroller(ComptrollerInterface oldComptroller, ComptrollerInterface newComptroller); | |
/** | |
* @notice Event emitted when interestRateModel is changed | |
*/ | |
event NewMarketInterestRateModel(InterestRateModel oldInterestRateModel, InterestRateModel newInterestRateModel); | |
/** | |
* @notice Event emitted when the reserve factor is changed | |
*/ | |
event NewReserveFactor(uint oldReserveFactorMantissa, uint newReserveFactorMantissa); | |
/** | |
* @notice Event emitted when the reserves are added | |
*/ | |
event ReservesAdded(address benefactor, uint addAmount, uint newTotalReserves); | |
/** | |
* @notice Event emitted when the reserves are reduced | |
*/ | |
event ReservesReduced(address admin, uint reduceAmount, uint newTotalReserves); | |
/** | |
* @notice EIP20 Transfer event | |
*/ | |
event Transfer(address indexed from, address indexed to, uint amount); | |
/** | |
* @notice EIP20 Approval event | |
*/ | |
event Approval(address indexed owner, address indexed spender, uint amount); | |
/** | |
* @notice Failure event | |
*/ | |
event Failure(uint error, uint info, uint detail); | |
/*** User Interface ***/ | |
function transfer(address dst, uint amount) external returns (bool); | |
function transferFrom(address src, address dst, uint amount) external returns (bool); | |
function approve(address spender, uint amount) external returns (bool); | |
function allowance(address owner, address spender) external view returns (uint); | |
function balanceOf(address owner) external view returns (uint); | |
function balanceOfUnderlying(address owner) external returns (uint); | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint); | |
function borrowRatePerBlock() external view returns (uint); | |
function supplyRatePerBlock() external view returns (uint); | |
function totalBorrowsCurrent() external returns (uint); | |
function borrowBalanceCurrent(address account) external returns (uint); | |
function borrowBalanceStored(address account) public view returns (uint); | |
function exchangeRateCurrent() public returns (uint); | |
function exchangeRateStored() public view returns (uint); | |
function getCash() external view returns (uint); | |
function accrueInterest() public returns (uint); | |
function seize(address liquidator, address borrower, uint seizeTokens) external returns (uint); | |
/*** Admin Functions ***/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint); | |
function _acceptAdmin() external returns (uint); | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint); | |
function _setReserveFactor(uint newReserveFactorMantissa) external returns (uint); | |
function _reduceReserves(uint reduceAmount) external returns (uint); | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint); | |
} | |
contract CErc20Storage { | |
/** | |
* @notice Underlying asset for this CToken | |
*/ | |
address public underlying; | |
} | |
contract CErc20Interface is CErc20Storage { | |
/*** User Interface ***/ | |
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, CTokenInterface cTokenCollateral) external returns (uint); | |
function sweepToken(EIP20NonStandardInterface token) external; | |
/*** Admin Functions ***/ | |
function _addReserves(uint addAmount) external returns (uint); | |
} | |
contract CDelegationStorage { | |
/** | |
* @notice Implementation address for this contract | |
*/ | |
address public implementation; | |
} | |
contract CDelegatorInterface is CDelegationStorage { | |
/** | |
* @notice Emitted when implementation is changed | |
*/ | |
event NewImplementation(address oldImplementation, address newImplementation); | |
/** | |
* @notice Called by the admin to update the implementation of the delegator | |
* @param implementation_ The address of the new implementation for delegation | |
* @param allowResign Flag to indicate whether to call _resignImplementation on the old implementation | |
* @param becomeImplementationData The encoded bytes data to be passed to _becomeImplementation | |
*/ | |
function _setImplementation(address implementation_, bool allowResign, bytes memory becomeImplementationData) public; | |
} | |
contract CDelegateInterface is CDelegationStorage { | |
/** | |
* @notice Called by the delegator on a delegate to initialize it for duty | |
* @dev Should revert if any issues arise which make it unfit for delegation | |
* @param data The encoded bytes data for any initialization | |
*/ | |
function _becomeImplementation(bytes memory data) public; | |
/** | |
* @notice Called by the delegator on a delegate to forfeit its responsibility | |
*/ | |
function _resignImplementation() public; | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/ErrorReporter.sol | |
pragma solidity ^0.5.16; | |
contract ComptrollerErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
COMPTROLLER_MISMATCH, | |
INSUFFICIENT_SHORTFALL, | |
INSUFFICIENT_LIQUIDITY, | |
INVALID_CLOSE_FACTOR, | |
INVALID_COLLATERAL_FACTOR, | |
INVALID_LIQUIDATION_INCENTIVE, | |
MARKET_NOT_ENTERED, // no longer possible | |
MARKET_NOT_LISTED, | |
MARKET_ALREADY_LISTED, | |
MATH_ERROR, | |
NONZERO_BORROW_BALANCE, | |
PRICE_ERROR, | |
REJECTION, | |
SNAPSHOT_ERROR, | |
TOO_MANY_ASSETS, | |
TOO_MUCH_REPAY | |
} | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
EXIT_MARKET_BALANCE_OWED, | |
EXIT_MARKET_REJECTION, | |
SET_CLOSE_FACTOR_OWNER_CHECK, | |
SET_CLOSE_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_NO_EXISTS, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COLLATERAL_FACTOR_WITHOUT_PRICE, | |
SET_IMPLEMENTATION_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_OWNER_CHECK, | |
SET_LIQUIDATION_INCENTIVE_VALIDATION, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_OWNER_CHECK, | |
SET_PRICE_ORACLE_OWNER_CHECK, | |
SUPPORT_MARKET_EXISTS, | |
SUPPORT_MARKET_OWNER_CHECK, | |
SET_PAUSE_GUARDIAN_OWNER_CHECK | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
contract TokenErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED, | |
BAD_INPUT, | |
COMPTROLLER_REJECTION, | |
COMPTROLLER_CALCULATION_ERROR, | |
INTEREST_RATE_MODEL_ERROR, | |
INVALID_ACCOUNT_PAIR, | |
INVALID_CLOSE_AMOUNT_REQUESTED, | |
INVALID_COLLATERAL_FACTOR, | |
MATH_ERROR, | |
MARKET_NOT_FRESH, | |
MARKET_NOT_LISTED, | |
TOKEN_INSUFFICIENT_ALLOWANCE, | |
TOKEN_INSUFFICIENT_BALANCE, | |
TOKEN_INSUFFICIENT_CASH, | |
TOKEN_TRANSFER_IN_FAILED, | |
TOKEN_TRANSFER_OUT_FAILED | |
} | |
/* | |
* Note: FailureInfo (but not Error) is kept in alphabetical order | |
* This is because FailureInfo grows significantly faster, and | |
* the order of Error has some meaning, while the order of FailureInfo | |
* is entirely arbitrary. | |
*/ | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, | |
ACCRUE_INTEREST_BORROW_RATE_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, | |
ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, | |
ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, | |
BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
BORROW_ACCRUE_INTEREST_FAILED, | |
BORROW_CASH_NOT_AVAILABLE, | |
BORROW_FRESHNESS_CHECK, | |
BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
BORROW_MARKET_NOT_LISTED, | |
BORROW_COMPTROLLER_REJECTION, | |
LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED, | |
LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED, | |
LIQUIDATE_COLLATERAL_FRESHNESS_CHECK, | |
LIQUIDATE_COMPTROLLER_REJECTION, | |
LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED, | |
LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX, | |
LIQUIDATE_CLOSE_AMOUNT_IS_ZERO, | |
LIQUIDATE_FRESHNESS_CHECK, | |
LIQUIDATE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_REPAY_BORROW_FRESH_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, | |
LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, | |
LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, | |
LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER, | |
LIQUIDATE_SEIZE_TOO_MUCH, | |
MINT_ACCRUE_INTEREST_FAILED, | |
MINT_COMPTROLLER_REJECTION, | |
MINT_EXCHANGE_CALCULATION_FAILED, | |
MINT_EXCHANGE_RATE_READ_FAILED, | |
MINT_FRESHNESS_CHECK, | |
MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
MINT_TRANSFER_IN_FAILED, | |
MINT_TRANSFER_IN_NOT_POSSIBLE, | |
REDEEM_ACCRUE_INTEREST_FAILED, | |
REDEEM_COMPTROLLER_REJECTION, | |
REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, | |
REDEEM_EXCHANGE_RATE_READ_FAILED, | |
REDEEM_FRESHNESS_CHECK, | |
REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, | |
REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, | |
REDEEM_TRANSFER_OUT_NOT_POSSIBLE, | |
REDUCE_RESERVES_ACCRUE_INTEREST_FAILED, | |
REDUCE_RESERVES_ADMIN_CHECK, | |
REDUCE_RESERVES_CASH_NOT_AVAILABLE, | |
REDUCE_RESERVES_FRESH_CHECK, | |
REDUCE_RESERVES_VALIDATION, | |
REPAY_BEHALF_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCRUE_INTEREST_FAILED, | |
REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_COMPTROLLER_REJECTION, | |
REPAY_BORROW_FRESHNESS_CHECK, | |
REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, | |
REPAY_BORROW_TRANSFER_IN_NOT_POSSIBLE, | |
SET_COLLATERAL_FACTOR_OWNER_CHECK, | |
SET_COLLATERAL_FACTOR_VALIDATION, | |
SET_COMPTROLLER_OWNER_CHECK, | |
SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED, | |
SET_INTEREST_RATE_MODEL_FRESH_CHECK, | |
SET_INTEREST_RATE_MODEL_OWNER_CHECK, | |
SET_MAX_ASSETS_OWNER_CHECK, | |
SET_ORACLE_MARKET_NOT_LISTED, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED, | |
SET_RESERVE_FACTOR_ADMIN_CHECK, | |
SET_RESERVE_FACTOR_FRESH_CHECK, | |
SET_RESERVE_FACTOR_BOUNDS_CHECK, | |
TRANSFER_COMPTROLLER_REJECTION, | |
TRANSFER_NOT_ALLOWED, | |
TRANSFER_NOT_ENOUGH, | |
TRANSFER_TOO_MUCH, | |
ADD_RESERVES_ACCRUE_INTEREST_FAILED, | |
ADD_RESERVES_FRESH_CHECK, | |
ADD_RESERVES_TRANSFER_IN_NOT_POSSIBLE | |
} | |
/** | |
* @dev `error` corresponds to enum Error; `info` corresponds to enum FailureInfo, and `detail` is an arbitrary | |
* contract-specific code that enables us to report opaque error codes from upgradeable contracts. | |
**/ | |
event Failure(uint error, uint info, uint detail); | |
/** | |
* @dev use this when reporting a known error from the money market or a non-upgradeable collaborator | |
*/ | |
function fail(Error err, FailureInfo info) internal returns (uint) { | |
emit Failure(uint(err), uint(info), 0); | |
return uint(err); | |
} | |
/** | |
* @dev use this when reporting an opaque error from an upgradeable collaborator contract | |
*/ | |
function failOpaque(Error err, FailureInfo info, uint opaqueError) internal returns (uint) { | |
emit Failure(uint(err), uint(info), opaqueError); | |
return uint(err); | |
} | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/CToken.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title Compound's CToken Contract | |
* @notice Abstract base for CTokens | |
* @author Compound | |
*/ | |
contract CToken is CTokenInterface, Exponential, TokenErrorReporter { | |
/** | |
* @notice Initialize the money market | |
* @param comptroller_ The address of the Comptroller | |
* @param interestRateModel_ The address of the interest rate model | |
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18 | |
* @param name_ EIP-20 name of this token | |
* @param symbol_ EIP-20 symbol of this token | |
* @param decimals_ EIP-20 decimal precision of this token | |
*/ | |
function initialize(ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_) public { | |
require(msg.sender == admin, "only admin may initialize the market"); | |
require(accrualBlockNumber == 0 && borrowIndex == 0, "market may only be initialized once"); | |
// Set initial exchange rate | |
initialExchangeRateMantissa = initialExchangeRateMantissa_; | |
require(initialExchangeRateMantissa > 0, "initial exchange rate must be greater than zero."); | |
// Set the comptroller | |
uint err = _setComptroller(comptroller_); | |
require(err == uint(Error.NO_ERROR), "setting comptroller failed"); | |
// Initialize block number and borrow index (block number mocks depend on comptroller being set) | |
accrualBlockNumber = getBlockNumber(); | |
borrowIndex = mantissaOne; | |
// Set the interest rate model (depends on block number / borrow index) | |
err = _setInterestRateModelFresh(interestRateModel_); | |
require(err == uint(Error.NO_ERROR), "setting interest rate model failed"); | |
name = name_; | |
symbol = symbol_; | |
decimals = decimals_; | |
// The counter starts true to prevent changing it from zero to non-zero (i.e. smaller cost/refund) | |
_notEntered = true; | |
} | |
/** | |
* @notice Transfer `tokens` tokens from `src` to `dst` by `spender` | |
* @dev Called by both `transfer` and `transferFrom` internally | |
* @param spender The address of the account performing the transfer | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param tokens The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferTokens(address spender, address src, address dst, uint tokens) internal returns (uint) { | |
/* Fail if transfer not allowed */ | |
uint allowed = comptroller.transferAllowed(address(this), src, dst, tokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.TRANSFER_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Do not allow self-transfers */ | |
if (src == dst) { | |
return fail(Error.BAD_INPUT, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
/* Get the allowance, infinite for the account owner */ | |
uint startingAllowance = 0; | |
if (spender == src) { | |
startingAllowance = uint(-1); | |
} else { | |
startingAllowance = transferAllowances[src][spender]; | |
} | |
/* Do the calculations, checking for {under,over}flow */ | |
MathError mathErr; | |
uint allowanceNew; | |
uint srcTokensNew; | |
uint dstTokensNew; | |
(mathErr, allowanceNew) = subUInt(startingAllowance, tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ALLOWED); | |
} | |
(mathErr, srcTokensNew) = subUInt(accountTokens[src], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_NOT_ENOUGH); | |
} | |
(mathErr, dstTokensNew) = addUInt(accountTokens[dst], tokens); | |
if (mathErr != MathError.NO_ERROR) { | |
return fail(Error.MATH_ERROR, FailureInfo.TRANSFER_TOO_MUCH); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
accountTokens[src] = srcTokensNew; | |
accountTokens[dst] = dstTokensNew; | |
/* Eat some of the allowance (if necessary) */ | |
if (startingAllowance != uint(-1)) { | |
transferAllowances[src][spender] = allowanceNew; | |
} | |
/* We emit a Transfer event */ | |
emit Transfer(src, dst, tokens); | |
// unused function | |
// comptroller.transferVerify(address(this), src, dst, tokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, msg.sender, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param src The address of the source account | |
* @param dst The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint256 amount) external nonReentrant returns (bool) { | |
return transferTokens(msg.sender, src, dst, amount) == uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Approve `spender` to transfer up to `amount` from `src` | |
* @dev This will overwrite the approval amount for `spender` | |
* and is subject to issues noted [here](https://eips.ethereum.org/EIPS/eip-20#approve) | |
* @param spender The address of the account which may transfer tokens | |
* @param amount The number of tokens that are approved (-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external returns (bool) { | |
address src = msg.sender; | |
transferAllowances[src][spender] = amount; | |
emit Approval(src, spender, amount); | |
return true; | |
} | |
/** | |
* @notice Get the current allowance from `owner` for `spender` | |
* @param owner The address of the account which owns the tokens to be spent | |
* @param spender The address of the account which may transfer tokens | |
* @return The number of tokens allowed to be spent (-1 means infinite) | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256) { | |
return transferAllowances[owner][spender]; | |
} | |
/** | |
* @notice Get the token balance of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of tokens owned by `owner` | |
*/ | |
function balanceOf(address owner) external view returns (uint256) { | |
return accountTokens[owner]; | |
} | |
/** | |
* @notice Get the underlying balance of the `owner` | |
* @dev This also accrues interest in a transaction | |
* @param owner The address of the account to query | |
* @return The amount of underlying owned by `owner` | |
*/ | |
function balanceOfUnderlying(address owner) external returns (uint) { | |
Exp memory exchangeRate = Exp({mantissa: exchangeRateCurrent()}); | |
(MathError mErr, uint balance) = mulScalarTruncate(exchangeRate, accountTokens[owner]); | |
require(mErr == MathError.NO_ERROR, "balance could not be calculated"); | |
return balance; | |
} | |
/** | |
* @notice Get a snapshot of the account's balances, and the cached exchange rate | |
* @dev This is used by comptroller to more efficiently perform liquidity checks. | |
* @param account Address of the account to snapshot | |
* @return (possible error, token balance, borrow balance, exchange rate mantissa) | |
*/ | |
function getAccountSnapshot(address account) external view returns (uint, uint, uint, uint) { | |
uint cTokenBalance = accountTokens[account]; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
MathError mErr; | |
(mErr, borrowBalance) = borrowBalanceStoredInternal(account); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
(mErr, exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0, 0, 0); | |
} | |
return (uint(Error.NO_ERROR), cTokenBalance, borrowBalance, exchangeRateMantissa); | |
} | |
/** | |
* @dev Function to simply retrieve block number | |
* This exists mainly for inheriting test contracts to stub this result. | |
*/ | |
function getBlockNumber() internal view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Returns the current per-block borrow interest rate for this cToken | |
* @return The borrow interest rate per block, scaled by 1e18 | |
*/ | |
function borrowRatePerBlock() external view returns (uint) { | |
return interestRateModel.getBorrowRate(getCashPrior(), totalBorrows, totalReserves); | |
} | |
/** | |
* @notice Returns the current per-block supply interest rate for this cToken | |
* @return The supply interest rate per block, scaled by 1e18 | |
*/ | |
function supplyRatePerBlock() external view returns (uint) { | |
return interestRateModel.getSupplyRate(getCashPrior(), totalBorrows, totalReserves, reserveFactorMantissa); | |
} | |
/** | |
* @notice Returns the current total borrows plus accrued interest | |
* @return The total borrows with interest | |
*/ | |
function totalBorrowsCurrent() external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return totalBorrows; | |
} | |
/** | |
* @notice Accrue interest to updated borrowIndex and then calculate account's borrow balance using the updated borrowIndex | |
* @param account The address whose balance should be calculated after updating borrowIndex | |
* @return The calculated balance | |
*/ | |
function borrowBalanceCurrent(address account) external nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return borrowBalanceStored(account); | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return The calculated balance | |
*/ | |
function borrowBalanceStored(address account) public view returns (uint) { | |
(MathError err, uint result) = borrowBalanceStoredInternal(account); | |
require(err == MathError.NO_ERROR, "borrowBalanceStored: borrowBalanceStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Return the borrow balance of account based on stored data | |
* @param account The address whose balance should be calculated | |
* @return (error code, the calculated balance or 0 if error code is non-zero) | |
*/ | |
function borrowBalanceStoredInternal(address account) internal view returns (MathError, uint) { | |
/* Note: we do not assert that the market is up to date */ | |
MathError mathErr; | |
uint principalTimesIndex; | |
uint result; | |
/* Get borrowBalance and borrowIndex */ | |
BorrowSnapshot storage borrowSnapshot = accountBorrows[account]; | |
/* If borrowBalance = 0 then borrowIndex is likely also 0. | |
* Rather than failing the calculation with a division by 0, we immediately return 0 in this case. | |
*/ | |
if (borrowSnapshot.principal == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
/* Calculate new borrow balance using the interest index: | |
* recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex | |
*/ | |
(mathErr, principalTimesIndex) = mulUInt(borrowSnapshot.principal, borrowIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, result) = divUInt(principalTimesIndex, borrowSnapshot.interestIndex); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, result); | |
} | |
/** | |
* @notice Accrue interest then return the up-to-date exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateCurrent() public nonReentrant returns (uint) { | |
require(accrueInterest() == uint(Error.NO_ERROR), "accrue interest failed"); | |
return exchangeRateStored(); | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the CToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateStored() public view returns (uint) { | |
(MathError err, uint result) = exchangeRateStoredInternal(); | |
require(err == MathError.NO_ERROR, "exchangeRateStored: exchangeRateStoredInternal failed"); | |
return result; | |
} | |
/** | |
* @notice Calculates the exchange rate from the underlying to the CToken | |
* @dev This function does not accrue interest before calculating the exchange rate | |
* @return (error code, calculated exchange rate scaled by 1e18) | |
*/ | |
function exchangeRateStoredInternal() internal view returns (MathError, uint) { | |
uint _totalSupply = totalSupply; | |
if (_totalSupply == 0) { | |
/* | |
* If there are no tokens minted: | |
* exchangeRate = initialExchangeRate | |
*/ | |
return (MathError.NO_ERROR, initialExchangeRateMantissa); | |
} else { | |
/* | |
* Otherwise: | |
* exchangeRate = (totalCash + totalBorrows - totalReserves) / totalSupply | |
*/ | |
uint totalCash = getCashPrior(); | |
uint cashPlusBorrowsMinusReserves; | |
Exp memory exchangeRate; | |
MathError mathErr; | |
(mathErr, cashPlusBorrowsMinusReserves) = addThenSubUInt(totalCash, totalBorrows, totalReserves); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
(mathErr, exchangeRate) = getExp(cashPlusBorrowsMinusReserves, _totalSupply); | |
if (mathErr != MathError.NO_ERROR) { | |
return (mathErr, 0); | |
} | |
return (MathError.NO_ERROR, exchangeRate.mantissa); | |
} | |
} | |
/** | |
* @notice Get cash balance of this cToken in the underlying asset | |
* @return The quantity of underlying asset owned by this contract | |
*/ | |
function getCash() external view returns (uint) { | |
return getCashPrior(); | |
} | |
/** | |
* @notice Applies accrued interest to total borrows and reserves | |
* @dev This calculates interest accrued from the last checkpointed block | |
* up to the current block and writes new checkpoint to storage. | |
*/ | |
function accrueInterest() public returns (uint) { | |
/* Remember the initial block number */ | |
uint currentBlockNumber = getBlockNumber(); | |
uint accrualBlockNumberPrior = accrualBlockNumber; | |
/* Short-circuit accumulating 0 interest */ | |
if (accrualBlockNumberPrior == currentBlockNumber) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Read the previous values out of storage */ | |
uint cashPrior = getCashPrior(); | |
uint borrowsPrior = totalBorrows; | |
uint reservesPrior = totalReserves; | |
uint borrowIndexPrior = borrowIndex; | |
/* Calculate the current borrow interest rate */ | |
uint borrowRateMantissa = interestRateModel.getBorrowRate(cashPrior, borrowsPrior, reservesPrior); | |
require(borrowRateMantissa <= borrowRateMaxMantissa, "borrow rate is absurdly high"); | |
/* Calculate the number of blocks elapsed since the last accrual */ | |
(MathError mathErr, uint blockDelta) = subUInt(currentBlockNumber, accrualBlockNumberPrior); | |
require(mathErr == MathError.NO_ERROR, "could not calculate block delta"); | |
/* | |
* Calculate the interest accumulated into borrows and reserves and the new index: | |
* simpleInterestFactor = borrowRate * blockDelta | |
* interestAccumulated = simpleInterestFactor * totalBorrows | |
* totalBorrowsNew = interestAccumulated + totalBorrows | |
* totalReservesNew = interestAccumulated * reserveFactor + totalReserves | |
* borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex | |
*/ | |
Exp memory simpleInterestFactor; | |
uint interestAccumulated; | |
uint totalBorrowsNew; | |
uint totalReservesNew; | |
uint borrowIndexNew; | |
(mathErr, simpleInterestFactor) = mulScalar(Exp({mantissa: borrowRateMantissa}), blockDelta); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_SIMPLE_INTEREST_FACTOR_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, interestAccumulated) = mulScalarTruncate(simpleInterestFactor, borrowsPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_ACCUMULATED_INTEREST_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, totalBorrowsNew) = addUInt(interestAccumulated, borrowsPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_BORROWS_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, totalReservesNew) = mulScalarTruncateAddUInt(Exp({mantissa: reserveFactorMantissa}), interestAccumulated, reservesPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_TOTAL_RESERVES_CALCULATION_FAILED, uint(mathErr)); | |
} | |
(mathErr, borrowIndexNew) = mulScalarTruncateAddUInt(simpleInterestFactor, borrowIndexPrior, borrowIndexPrior); | |
if (mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.ACCRUE_INTEREST_NEW_BORROW_INDEX_CALCULATION_FAILED, uint(mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
accrualBlockNumber = currentBlockNumber; | |
borrowIndex = borrowIndexNew; | |
totalBorrows = totalBorrowsNew; | |
totalReserves = totalReservesNew; | |
/* We emit an AccrueInterest event */ | |
emit AccrueInterest(cashPrior, interestAccumulated, borrowIndexNew, totalBorrowsNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender supplies assets into the market and receives cTokens in exchange | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. | |
*/ | |
function mintInternal(uint mintAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.MINT_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// mintFresh emits the actual Mint event if successful and logs on errors, so we don't need to | |
return mintFresh(msg.sender, mintAmount); | |
} | |
struct MintLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint mintTokens; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
uint actualMintAmount; | |
} | |
/** | |
* @notice User supplies assets into the market and receives cTokens in exchange | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param minter The address of the account which is supplying the assets | |
* @param mintAmount The amount of the underlying asset to supply | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual mint amount. | |
*/ | |
function mintFresh(address minter, uint mintAmount) internal returns (uint, uint) { | |
/* Fail if mint not allowed */ | |
uint allowed = comptroller.mintAllowed(address(this), minter, mintAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.MINT_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.MINT_FRESHNESS_CHECK), 0); | |
} | |
MintLocalVars memory vars; | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return (failOpaque(Error.MATH_ERROR, FailureInfo.MINT_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)), 0); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call `doTransferIn` for the minter and the mintAmount. | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* `doTransferIn` reverts if anything goes wrong, since we can't be sure if | |
* side-effects occurred. The function returns the amount actually transferred, | |
* in case of a fee. On success, the cToken holds an additional `actualMintAmount` | |
* of cash. | |
*/ | |
vars.actualMintAmount = doTransferIn(minter, mintAmount); | |
/* | |
* We get the current exchange rate and calculate the number of cTokens to be minted: | |
* mintTokens = actualMintAmount / exchangeRate | |
*/ | |
(vars.mathErr, vars.mintTokens) = divScalarByExpTruncate(vars.actualMintAmount, Exp({mantissa: vars.exchangeRateMantissa})); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_EXCHANGE_CALCULATION_FAILED"); | |
/* | |
* We calculate the new total supply of cTokens and minter token balance, checking for overflow: | |
* totalSupplyNew = totalSupply + mintTokens | |
* accountTokensNew = accountTokens[minter] + mintTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = addUInt(totalSupply, vars.mintTokens); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_TOTAL_SUPPLY_CALCULATION_FAILED"); | |
(vars.mathErr, vars.accountTokensNew) = addUInt(accountTokens[minter], vars.mintTokens); | |
require(vars.mathErr == MathError.NO_ERROR, "MINT_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED"); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[minter] = vars.accountTokensNew; | |
/* We emit a Mint event, and a Transfer event */ | |
emit Mint(minter, vars.actualMintAmount, vars.mintTokens); | |
emit Transfer(address(this), minter, vars.mintTokens); | |
/* We call the defense hook */ | |
// unused function | |
// comptroller.mintVerify(address(this), minter, vars.actualMintAmount, vars.mintTokens); | |
return (uint(Error.NO_ERROR), vars.actualMintAmount); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for the underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemTokens The number of cTokens to redeem into underlying | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemInternal(uint redeemTokens) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, redeemTokens, 0); | |
} | |
/** | |
* @notice Sender redeems cTokens in exchange for a specified amount of underlying asset | |
* @dev Accrues interest whether or not the operation succeeds, unless reverted | |
* @param redeemAmount The amount of underlying to receive from redeeming cTokens | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemUnderlyingInternal(uint redeemAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted redeem failed | |
return fail(Error(error), FailureInfo.REDEEM_ACCRUE_INTEREST_FAILED); | |
} | |
// redeemFresh emits redeem-specific logs on errors, so we don't need to | |
return redeemFresh(msg.sender, 0, redeemAmount); | |
} | |
struct RedeemLocalVars { | |
Error err; | |
MathError mathErr; | |
uint exchangeRateMantissa; | |
uint redeemTokens; | |
uint redeemAmount; | |
uint totalSupplyNew; | |
uint accountTokensNew; | |
} | |
/** | |
* @notice User redeems cTokens in exchange for the underlying asset | |
* @dev Assumes interest has already been accrued up to the current block | |
* @param redeemer The address of the account which is redeeming the tokens | |
* @param redeemTokensIn The number of cTokens to redeem into underlying (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @param redeemAmountIn The number of underlying tokens to receive from redeeming cTokens (only one of redeemTokensIn or redeemAmountIn may be non-zero) | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function redeemFresh(address payable redeemer, uint redeemTokensIn, uint redeemAmountIn) internal returns (uint) { | |
require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero"); | |
RedeemLocalVars memory vars; | |
/* exchangeRate = invoke Exchange Rate Stored() */ | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_RATE_READ_FAILED, uint(vars.mathErr)); | |
} | |
/* If redeemTokensIn > 0: */ | |
if (redeemTokensIn > 0) { | |
/* | |
* We calculate the exchange rate and the amount of underlying to be redeemed: | |
* redeemTokens = redeemTokensIn | |
* redeemAmount = redeemTokensIn x exchangeRateCurrent | |
*/ | |
vars.redeemTokens = redeemTokensIn; | |
(vars.mathErr, vars.redeemAmount) = mulScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), redeemTokensIn); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_TOKENS_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
} else { | |
/* | |
* We get the current exchange rate and calculate the amount to be redeemed: | |
* redeemTokens = redeemAmountIn / exchangeRate | |
* redeemAmount = redeemAmountIn | |
*/ | |
(vars.mathErr, vars.redeemTokens) = divScalarByExpTruncate(redeemAmountIn, Exp({mantissa: vars.exchangeRateMantissa})); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_EXCHANGE_AMOUNT_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
vars.redeemAmount = redeemAmountIn; | |
} | |
/* Fail if redeem not allowed */ | |
uint allowed = comptroller.redeemAllowed(address(this), redeemer, vars.redeemTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REDEEM_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDEEM_FRESHNESS_CHECK); | |
} | |
/* | |
* We calculate the new total supply and redeemer balance, checking for underflow: | |
* totalSupplyNew = totalSupply - redeemTokens | |
* accountTokensNew = accountTokens[redeemer] - redeemTokens | |
*/ | |
(vars.mathErr, vars.totalSupplyNew) = subUInt(totalSupply, vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_TOTAL_SUPPLY_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountTokensNew) = subUInt(accountTokens[redeemer], vars.redeemTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.REDEEM_NEW_ACCOUNT_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
/* Fail gracefully if protocol has insufficient cash */ | |
if (getCashPrior() < vars.redeemAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDEEM_TRANSFER_OUT_NOT_POSSIBLE); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the redeemer and the redeemAmount. | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken has redeemAmount less of cash. | |
* doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
*/ | |
doTransferOut(redeemer, vars.redeemAmount); | |
/* We write previously calculated values into storage */ | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[redeemer] = vars.accountTokensNew; | |
/* We emit a Transfer event, and a Redeem event */ | |
emit Transfer(redeemer, address(this), vars.redeemTokens); | |
emit Redeem(redeemer, vars.redeemAmount, vars.redeemTokens); | |
/* We call the defense hook */ | |
comptroller.redeemVerify(address(this), redeemer, vars.redeemAmount, vars.redeemTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender borrows assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowInternal(uint borrowAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return fail(Error(error), FailureInfo.BORROW_ACCRUE_INTEREST_FAILED); | |
} | |
// borrowFresh emits borrow-specific logs on errors, so we don't need to | |
return borrowFresh(msg.sender, borrowAmount); | |
} | |
struct BorrowLocalVars { | |
MathError mathErr; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
} | |
/** | |
* @notice Users borrow assets from the protocol to their own address | |
* @param borrowAmount The amount of the underlying asset to borrow | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function borrowFresh(address payable borrower, uint borrowAmount) internal returns (uint) { | |
/* Fail if borrow not allowed */ | |
uint allowed = comptroller.borrowAllowed(address(this), borrower, borrowAmount); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.BORROW_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.BORROW_FRESHNESS_CHECK); | |
} | |
/* Fail gracefully if protocol has insufficient underlying cash */ | |
if (getCashPrior() < borrowAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.BORROW_CASH_NOT_AVAILABLE); | |
} | |
BorrowLocalVars memory vars; | |
/* | |
* We calculate the new borrower and total borrow balances, failing on overflow: | |
* accountBorrowsNew = accountBorrows + borrowAmount | |
* totalBorrowsNew = totalBorrows + borrowAmount | |
*/ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.accountBorrowsNew) = addUInt(vars.accountBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
(vars.mathErr, vars.totalBorrowsNew) = addUInt(totalBorrows, borrowAmount); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We invoke doTransferOut for the borrower and the borrowAmount. | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken borrowAmount less of cash. | |
* doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
*/ | |
doTransferOut(borrower, borrowAmount); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a Borrow event */ | |
emit Borrow(borrower, borrowAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
// unused function | |
// comptroller.borrowVerify(address(this), borrower, borrowAmount); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sender repays their own borrow | |
* @param repayAmount The amount to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowInternal(uint repayAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.REPAY_BORROW_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, msg.sender, repayAmount); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount The amount to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowBehalfInternal(address borrower, uint repayAmount) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted borrow failed | |
return (fail(Error(error), FailureInfo.REPAY_BEHALF_ACCRUE_INTEREST_FAILED), 0); | |
} | |
// repayBorrowFresh emits repay-borrow-specific logs on errors, so we don't need to | |
return repayBorrowFresh(msg.sender, borrower, repayAmount); | |
} | |
struct RepayBorrowLocalVars { | |
Error err; | |
MathError mathErr; | |
uint repayAmount; | |
uint borrowerIndex; | |
uint accountBorrows; | |
uint accountBorrowsNew; | |
uint totalBorrowsNew; | |
uint actualRepayAmount; | |
} | |
/** | |
* @notice Borrows are repaid by another user (possibly the borrower). | |
* @param payer the account paying off the borrow | |
* @param borrower the account with the debt being payed off | |
* @param repayAmount the amount of undelrying tokens being returned | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function repayBorrowFresh(address payer, address borrower, uint repayAmount) internal returns (uint, uint) { | |
/* Fail if repayBorrow not allowed */ | |
uint allowed = comptroller.repayBorrowAllowed(address(this), payer, borrower, repayAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.REPAY_BORROW_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.REPAY_BORROW_FRESHNESS_CHECK), 0); | |
} | |
RepayBorrowLocalVars memory vars; | |
/* We remember the original borrowerIndex for verification purposes */ | |
vars.borrowerIndex = accountBorrows[borrower].interestIndex; | |
/* We fetch the amount the borrower owes, with accumulated interest */ | |
(vars.mathErr, vars.accountBorrows) = borrowBalanceStoredInternal(borrower); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return (failOpaque(Error.MATH_ERROR, FailureInfo.REPAY_BORROW_ACCUMULATED_BALANCE_CALCULATION_FAILED, uint(vars.mathErr)), 0); | |
} | |
/* If repayAmount == -1, repayAmount = accountBorrows */ | |
if (repayAmount == uint(-1)) { | |
vars.repayAmount = vars.accountBorrows; | |
} else { | |
vars.repayAmount = repayAmount; | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the payer and the repayAmount | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken holds an additional repayAmount of cash. | |
* doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
* it returns the amount actually transferred, in case of a fee. | |
*/ | |
vars.actualRepayAmount = doTransferIn(payer, vars.repayAmount); | |
/* | |
* We calculate the new borrower and total borrow balances, failing on underflow: | |
* accountBorrowsNew = accountBorrows - actualRepayAmount | |
* totalBorrowsNew = totalBorrows - actualRepayAmount | |
*/ | |
(vars.mathErr, vars.accountBorrowsNew) = subUInt(vars.accountBorrows, vars.actualRepayAmount); | |
require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_ACCOUNT_BORROW_BALANCE_CALCULATION_FAILED"); | |
(vars.mathErr, vars.totalBorrowsNew) = subUInt(totalBorrows, vars.actualRepayAmount); | |
require(vars.mathErr == MathError.NO_ERROR, "REPAY_BORROW_NEW_TOTAL_BALANCE_CALCULATION_FAILED"); | |
/* We write the previously calculated values into storage */ | |
accountBorrows[borrower].principal = vars.accountBorrowsNew; | |
accountBorrows[borrower].interestIndex = borrowIndex; | |
totalBorrows = vars.totalBorrowsNew; | |
/* We emit a RepayBorrow event */ | |
emit RepayBorrow(payer, borrower, vars.actualRepayAmount, vars.accountBorrowsNew, vars.totalBorrowsNew); | |
/* We call the defense hook */ | |
// unused function | |
// comptroller.repayBorrowVerify(address(this), payer, borrower, vars.actualRepayAmount, vars.borrowerIndex); | |
return (uint(Error.NO_ERROR), vars.actualRepayAmount); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function liquidateBorrowInternal(address borrower, uint repayAmount, CTokenInterface cTokenCollateral) internal nonReentrant returns (uint, uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_BORROW_INTEREST_FAILED), 0); | |
} | |
error = cTokenCollateral.accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed | |
return (fail(Error(error), FailureInfo.LIQUIDATE_ACCRUE_COLLATERAL_INTEREST_FAILED), 0); | |
} | |
// liquidateBorrowFresh emits borrow-specific logs on errors, so we don't need to | |
return liquidateBorrowFresh(msg.sender, borrower, repayAmount, cTokenCollateral); | |
} | |
/** | |
* @notice The liquidator liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @param borrower The borrower of this cToken to be liquidated | |
* @param liquidator The address repaying the borrow and seizing collateral | |
* @param cTokenCollateral The market in which to seize collateral from the borrower | |
* @param repayAmount The amount of the underlying borrowed asset to repay | |
* @return (uint, uint) An error code (0=success, otherwise a failure, see ErrorReporter.sol), and the actual repayment amount. | |
*/ | |
function liquidateBorrowFresh(address liquidator, address borrower, uint repayAmount, CTokenInterface cTokenCollateral) internal returns (uint, uint) { | |
/* Fail if liquidate not allowed */ | |
uint allowed = comptroller.liquidateBorrowAllowed(address(this), address(cTokenCollateral), liquidator, borrower, repayAmount); | |
if (allowed != 0) { | |
return (failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_COMPTROLLER_REJECTION, allowed), 0); | |
} | |
/* Verify market's block number equals current block number */ | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_FRESHNESS_CHECK), 0); | |
} | |
/* Verify cTokenCollateral market's block number equals current block number */ | |
if (cTokenCollateral.accrualBlockNumber() != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.LIQUIDATE_COLLATERAL_FRESHNESS_CHECK), 0); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return (fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_LIQUIDATOR_IS_BORROWER), 0); | |
} | |
/* Fail if repayAmount = 0 */ | |
if (repayAmount == 0) { | |
return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_ZERO), 0); | |
} | |
/* Fail if repayAmount = -1 */ | |
if (repayAmount == uint(-1)) { | |
return (fail(Error.INVALID_CLOSE_AMOUNT_REQUESTED, FailureInfo.LIQUIDATE_CLOSE_AMOUNT_IS_UINT_MAX), 0); | |
} | |
/* Fail if repayBorrow fails */ | |
(uint repayBorrowError, uint actualRepayAmount) = repayBorrowFresh(liquidator, borrower, repayAmount); | |
if (repayBorrowError != uint(Error.NO_ERROR)) { | |
return (fail(Error(repayBorrowError), FailureInfo.LIQUIDATE_REPAY_BORROW_FRESH_FAILED), 0); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We calculate the number of collateral tokens that will be seized */ | |
(uint amountSeizeError, uint seizeTokens) = comptroller.liquidateCalculateSeizeTokens(address(this), address(cTokenCollateral), actualRepayAmount); | |
require(amountSeizeError == uint(Error.NO_ERROR), "LIQUIDATE_COMPTROLLER_CALCULATE_AMOUNT_SEIZE_FAILED"); | |
/* Revert if borrower collateral token balance < seizeTokens */ | |
require(cTokenCollateral.balanceOf(borrower) >= seizeTokens, "LIQUIDATE_SEIZE_TOO_MUCH"); | |
// If this is also the collateral, run seizeInternal to avoid re-entrancy, otherwise make an external call | |
uint seizeError; | |
if (address(cTokenCollateral) == address(this)) { | |
seizeError = seizeInternal(address(this), liquidator, borrower, seizeTokens); | |
} else { | |
seizeError = cTokenCollateral.seize(liquidator, borrower, seizeTokens); | |
} | |
/* Revert if seize tokens fails (since we cannot be sure of side effects) */ | |
require(seizeError == uint(Error.NO_ERROR), "token seizure failed"); | |
/* We emit a LiquidateBorrow event */ | |
emit LiquidateBorrow(liquidator, borrower, actualRepayAmount, address(cTokenCollateral), seizeTokens); | |
/* We call the defense hook */ | |
// unused function | |
// comptroller.liquidateBorrowVerify(address(this), address(cTokenCollateral), liquidator, borrower, actualRepayAmount, seizeTokens); | |
return (uint(Error.NO_ERROR), actualRepayAmount); | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Will fail unless called by another cToken during the process of liquidation. | |
* Its absolutely critical to use msg.sender as the borrowed cToken and not a parameter. | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of cTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seize(address liquidator, address borrower, uint seizeTokens) external nonReentrant returns (uint) { | |
return seizeInternal(msg.sender, liquidator, borrower, seizeTokens); | |
} | |
struct SeizeInternalLocalVars { | |
MathError mathErr; | |
uint borrowerTokensNew; | |
uint liquidatorTokensNew; | |
uint liquidatorSeizeTokens; | |
uint protocolSeizeTokens; | |
uint protocolSeizeAmount; | |
uint exchangeRateMantissa; | |
uint totalReservesNew; | |
uint totalSupplyNew; | |
} | |
/** | |
* @notice Transfers collateral tokens (this market) to the liquidator. | |
* @dev Called only during an in-kind liquidation, or by liquidateBorrow during the liquidation of another CToken. | |
* Its absolutely critical to use msg.sender as the seizer cToken and not a parameter. | |
* @param seizerToken The contract seizing the collateral (i.e. borrowed cToken) | |
* @param liquidator The account receiving seized collateral | |
* @param borrower The account having collateral seized | |
* @param seizeTokens The number of cTokens to seize | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function seizeInternal(address seizerToken, address liquidator, address borrower, uint seizeTokens) internal returns (uint) { | |
/* Fail if seize not allowed */ | |
uint allowed = comptroller.seizeAllowed(address(this), seizerToken, liquidator, borrower, seizeTokens); | |
if (allowed != 0) { | |
return failOpaque(Error.COMPTROLLER_REJECTION, FailureInfo.LIQUIDATE_SEIZE_COMPTROLLER_REJECTION, allowed); | |
} | |
/* Fail if borrower = liquidator */ | |
if (borrower == liquidator) { | |
return fail(Error.INVALID_ACCOUNT_PAIR, FailureInfo.LIQUIDATE_SEIZE_LIQUIDATOR_IS_BORROWER); | |
} | |
SeizeInternalLocalVars memory vars; | |
/* | |
* We calculate the new borrower and liquidator token balances, failing on underflow/overflow: | |
* borrowerTokensNew = accountTokens[borrower] - seizeTokens | |
* liquidatorTokensNew = accountTokens[liquidator] + seizeTokens | |
*/ | |
(vars.mathErr, vars.borrowerTokensNew) = subUInt(accountTokens[borrower], seizeTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_DECREMENT_FAILED, uint(vars.mathErr)); | |
} | |
vars.protocolSeizeTokens = mul_(seizeTokens, Exp({mantissa: protocolSeizeShareMantissa})); | |
vars.liquidatorSeizeTokens = sub_(seizeTokens, vars.protocolSeizeTokens); | |
(vars.mathErr, vars.exchangeRateMantissa) = exchangeRateStoredInternal(); | |
require(vars.mathErr == MathError.NO_ERROR, "exchange rate math error"); | |
vars.protocolSeizeAmount = mul_ScalarTruncate(Exp({mantissa: vars.exchangeRateMantissa}), vars.protocolSeizeTokens); | |
vars.totalReservesNew = add_(totalReserves, vars.protocolSeizeAmount); | |
vars.totalSupplyNew = sub_(totalSupply, vars.protocolSeizeTokens); | |
(vars.mathErr, vars.liquidatorTokensNew) = addUInt(accountTokens[liquidator], vars.liquidatorSeizeTokens); | |
if (vars.mathErr != MathError.NO_ERROR) { | |
return failOpaque(Error.MATH_ERROR, FailureInfo.LIQUIDATE_SEIZE_BALANCE_INCREMENT_FAILED, uint(vars.mathErr)); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* We write the previously calculated values into storage */ | |
totalReserves = vars.totalReservesNew; | |
totalSupply = vars.totalSupplyNew; | |
accountTokens[borrower] = vars.borrowerTokensNew; | |
accountTokens[liquidator] = vars.liquidatorTokensNew; | |
/* Emit a Transfer event */ | |
emit Transfer(borrower, liquidator, vars.liquidatorSeizeTokens); | |
emit Transfer(borrower, address(this), vars.protocolSeizeTokens); | |
emit ReservesAdded(address(this), vars.protocolSeizeAmount, vars.totalReservesNew); | |
/* We call the defense hook */ | |
// unused function | |
// comptroller.seizeVerify(address(this), seizerToken, liquidator, borrower, seizeTokens); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address payable newPendingAdmin) external returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() external returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets a new comptroller for the market | |
* @dev Admin function to set a new comptroller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setComptroller(ComptrollerInterface newComptroller) public returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); | |
} | |
ComptrollerInterface oldComptroller = comptroller; | |
// Ensure invoke comptroller.isComptroller() returns true | |
require(newComptroller.isComptroller(), "marker method returned false"); | |
// Set market's comptroller to newComptroller | |
comptroller = newComptroller; | |
// Emit NewComptroller(oldComptroller, newComptroller) | |
emit NewComptroller(oldComptroller, newComptroller); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and sets a new reserve factor for the protocol using _setReserveFactorFresh | |
* @dev Admin function to accrue interest and set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactor(uint newReserveFactorMantissa) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reserve factor change failed. | |
return fail(Error(error), FailureInfo.SET_RESERVE_FACTOR_ACCRUE_INTEREST_FAILED); | |
} | |
// _setReserveFactorFresh emits reserve-factor-specific logs on errors, so we don't need to. | |
return _setReserveFactorFresh(newReserveFactorMantissa); | |
} | |
/** | |
* @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual) | |
* @dev Admin function to set a new reserve factor | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setReserveFactorFresh(uint newReserveFactorMantissa) internal returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_RESERVE_FACTOR_ADMIN_CHECK); | |
} | |
// Verify market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_RESERVE_FACTOR_FRESH_CHECK); | |
} | |
// Check newReserveFactor ≤ maxReserveFactor | |
if (newReserveFactorMantissa > reserveFactorMaxMantissa) { | |
return fail(Error.BAD_INPUT, FailureInfo.SET_RESERVE_FACTOR_BOUNDS_CHECK); | |
} | |
uint oldReserveFactorMantissa = reserveFactorMantissa; | |
reserveFactorMantissa = newReserveFactorMantissa; | |
emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring from msg.sender | |
* @param addAmount Amount of addition to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _addReservesInternal(uint addAmount) internal nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.ADD_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _addReservesFresh emits reserve-addition-specific logs on errors, so we don't need to. | |
(error, ) = _addReservesFresh(addAmount); | |
return error; | |
} | |
/** | |
* @notice Add reserves by transferring from caller | |
* @dev Requires fresh interest accrual | |
* @param addAmount Amount of addition to reserves | |
* @return (uint, uint) An error code (0=success, otherwise a failure (see ErrorReporter.sol for details)) and the actual amount added, net token fees | |
*/ | |
function _addReservesFresh(uint addAmount) internal returns (uint, uint) { | |
// totalReserves + actualAddAmount | |
uint totalReservesNew; | |
uint actualAddAmount; | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return (fail(Error.MARKET_NOT_FRESH, FailureInfo.ADD_RESERVES_FRESH_CHECK), actualAddAmount); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
/* | |
* We call doTransferIn for the caller and the addAmount | |
* Note: The cToken must handle variations between ERC-20 and ETH underlying. | |
* On success, the cToken holds an additional addAmount of cash. | |
* doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
* it returns the amount actually transferred, in case of a fee. | |
*/ | |
actualAddAmount = doTransferIn(msg.sender, addAmount); | |
totalReservesNew = totalReserves + actualAddAmount; | |
/* Revert on overflow */ | |
require(totalReservesNew >= totalReserves, "add reserves unexpected overflow"); | |
// Store reserves[n+1] = reserves[n] + actualAddAmount | |
totalReserves = totalReservesNew; | |
/* Emit NewReserves(admin, actualAddAmount, reserves[n+1]) */ | |
emit ReservesAdded(msg.sender, actualAddAmount, totalReservesNew); | |
/* Return (NO_ERROR, actualAddAmount) */ | |
return (uint(Error.NO_ERROR), actualAddAmount); | |
} | |
/** | |
* @notice Accrues interest and reduces reserves by transferring to admin | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReserves(uint reduceAmount) external nonReentrant returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted reduce reserves failed. | |
return fail(Error(error), FailureInfo.REDUCE_RESERVES_ACCRUE_INTEREST_FAILED); | |
} | |
// _reduceReservesFresh emits reserve-reduction-specific logs on errors, so we don't need to. | |
return _reduceReservesFresh(reduceAmount); | |
} | |
/** | |
* @notice Reduces reserves by transferring to admin | |
* @dev Requires fresh interest accrual | |
* @param reduceAmount Amount of reduction to reserves | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _reduceReservesFresh(uint reduceAmount) internal returns (uint) { | |
// totalReserves - reduceAmount | |
uint totalReservesNew; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.REDUCE_RESERVES_ADMIN_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.REDUCE_RESERVES_FRESH_CHECK); | |
} | |
// Fail gracefully if protocol has insufficient underlying cash | |
if (getCashPrior() < reduceAmount) { | |
return fail(Error.TOKEN_INSUFFICIENT_CASH, FailureInfo.REDUCE_RESERVES_CASH_NOT_AVAILABLE); | |
} | |
// Check reduceAmount ≤ reserves[n] (totalReserves) | |
if (reduceAmount > totalReserves) { | |
return fail(Error.BAD_INPUT, FailureInfo.REDUCE_RESERVES_VALIDATION); | |
} | |
///////////////////////// | |
// EFFECTS & INTERACTIONS | |
// (No safe failures beyond this point) | |
totalReservesNew = totalReserves - reduceAmount; | |
// We checked reduceAmount <= totalReserves above, so this should never revert. | |
require(totalReservesNew <= totalReserves, "reduce reserves unexpected underflow"); | |
// Store reserves[n+1] = reserves[n] - reduceAmount | |
totalReserves = totalReservesNew; | |
// doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred. | |
doTransferOut(admin, reduceAmount); | |
emit ReservesReduced(admin, reduceAmount, totalReservesNew); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice accrues interest and updates the interest rate model using _setInterestRateModelFresh | |
* @dev Admin function to accrue interest and update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModel(InterestRateModel newInterestRateModel) public returns (uint) { | |
uint error = accrueInterest(); | |
if (error != uint(Error.NO_ERROR)) { | |
// accrueInterest emits logs on errors, but on top of that we want to log the fact that an attempted change of interest rate model failed | |
return fail(Error(error), FailureInfo.SET_INTEREST_RATE_MODEL_ACCRUE_INTEREST_FAILED); | |
} | |
// _setInterestRateModelFresh emits interest-rate-model-update-specific logs on errors, so we don't need to. | |
return _setInterestRateModelFresh(newInterestRateModel); | |
} | |
/** | |
* @notice updates the interest rate model (*requires fresh interest accrual) | |
* @dev Admin function to update the interest rate model | |
* @param newInterestRateModel the new interest rate model to use | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal returns (uint) { | |
// Used to store old model for use in the event that is emitted on success | |
InterestRateModel oldInterestRateModel; | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_INTEREST_RATE_MODEL_OWNER_CHECK); | |
} | |
// We fail gracefully unless market's block number equals current block number | |
if (accrualBlockNumber != getBlockNumber()) { | |
return fail(Error.MARKET_NOT_FRESH, FailureInfo.SET_INTEREST_RATE_MODEL_FRESH_CHECK); | |
} | |
// Track the market's current interest rate model | |
oldInterestRateModel = interestRateModel; | |
// Ensure invoke newInterestRateModel.isInterestRateModel() returns true | |
require(newInterestRateModel.isInterestRateModel(), "marker method returned false"); | |
// Set the interest rate model to newInterestRateModel | |
interestRateModel = newInterestRateModel; | |
// Emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel) | |
emit NewMarketInterestRateModel(oldInterestRateModel, newInterestRateModel); | |
return uint(Error.NO_ERROR); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of the underlying | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of underlying owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint); | |
/** | |
* @dev Performs a transfer in, reverting upon failure. Returns the amount actually transferred to the protocol, in case of a fee. | |
* This may revert due to insufficient balance or insufficient allowance. | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (uint); | |
/** | |
* @dev Performs a transfer out, ideally returning an explanatory error code upon failure tather than reverting. | |
* If caller has not called checked protocol's balance, may revert due to insufficient cash held in the contract. | |
* If caller has checked protocol's balance, and verified it is >= amount, this should not revert in normal conditions. | |
*/ | |
function doTransferOut(address payable to, uint amount) internal; | |
/*** Reentrancy Guard ***/ | |
/** | |
* @dev Prevents a contract from calling itself, directly or indirectly. | |
*/ | |
modifier nonReentrant() { | |
require(_notEntered, "re-entered"); | |
_notEntered = false; | |
_; | |
_notEntered = true; // get a gas-refund post-Istanbul | |
} | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/PriceOracle.sol | |
pragma solidity ^0.5.16; | |
contract PriceOracle { | |
/// @notice Indicator that this is a PriceOracle contract (for inspection) | |
bool public constant isPriceOracle = true; | |
/** | |
* @notice Get the underlying price of a cToken asset | |
* @param cToken The cToken to get the underlying price of | |
* @return The underlying asset price mantissa (scaled by 1e18). | |
* Zero means the price is unavailable. | |
*/ | |
function getUnderlyingPrice(CToken cToken) external view returns (uint); | |
} | |
// File: https://github.com/compound-finance/compound-protocol/blob/master/contracts/ComptrollerStorage.sol | |
pragma solidity ^0.5.16; | |
contract UnitrollerAdminStorage { | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address public pendingAdmin; | |
/** | |
* @notice Active brains of Unitroller | |
*/ | |
address public comptrollerImplementation; | |
/** | |
* @notice Pending brains of Unitroller | |
*/ | |
address public pendingComptrollerImplementation; | |
} | |
contract ComptrollerV1Storage is UnitrollerAdminStorage { | |
/** | |
* @notice Oracle which gives the price of any given asset | |
*/ | |
PriceOracle public oracle; | |
/** | |
* @notice Multiplier used to calculate the maximum repayAmount when liquidating a borrow | |
*/ | |
uint public closeFactorMantissa; | |
/** | |
* @notice Multiplier representing the discount on collateral that a liquidator receives | |
*/ | |
uint public liquidationIncentiveMantissa; | |
/** | |
* @notice Max number of assets a single account can participate in (borrow or use as collateral) | |
*/ | |
uint public maxAssets; | |
/** | |
* @notice Per-account mapping of "assets you are in", capped by maxAssets | |
*/ | |
mapping(address => CToken[]) public accountAssets; | |
} | |
contract ComptrollerV2Storage is ComptrollerV1Storage { | |
struct Market { | |
/// @notice Whether or not this market is listed | |
bool isListed; | |
/** | |
* @notice Multiplier representing the most one can borrow against their collateral in this market. | |
* For instance, 0.9 to allow borrowing 90% of collateral value. | |
* Must be between 0 and 1, and stored as a mantissa. | |
*/ | |
uint collateralFactorMantissa; | |
/// @notice Per-market mapping of "accounts in this asset" | |
mapping(address => bool) accountMembership; | |
/// @notice Whether or not this market receives COMP | |
bool isComped; | |
} | |
/** | |
* @notice Official mapping of cTokens -> Market metadata | |
* @dev Used e.g. to determine if a market is supported | |
*/ | |
mapping(address => Market) public markets; | |
/** | |
* @notice The Pause Guardian can pause certain actions as a safety mechanism. | |
* Actions which allow users to remove their own assets cannot be paused. | |
* Liquidation / seizing / transfer can only be paused globally, not by market. | |
*/ | |
address public pauseGuardian; | |
bool public _mintGuardianPaused; | |
bool public _borrowGuardianPaused; | |
bool public transferGuardianPaused; | |
bool public seizeGuardianPaused; | |
mapping(address => bool) public mintGuardianPaused; | |
mapping(address => bool) public borrowGuardianPaused; | |
} | |
contract ComptrollerV3Storage is ComptrollerV2Storage { | |
struct CompMarketState { | |
/// @notice The market's last updated compBorrowIndex or compSupplyIndex | |
uint224 index; | |
/// @notice The block number the index was last updated at | |
uint32 block; | |
} | |
/// @notice A list of all markets | |
CToken[] public allMarkets; | |
/// @notice The rate at which the flywheel distributes COMP, per block | |
uint public compRate; | |
/// @notice The portion of compRate that each market currently receives | |
mapping(address => uint) public compSpeeds; | |
/// @notice The COMP market supply state for each market | |
mapping(address => CompMarketState) public compSupplyState; | |
/// @notice The COMP market borrow state for each market | |
mapping(address => CompMarketState) public compBorrowState; | |
/// @notice The COMP borrow index for each market for each supplier as of the last time they accrued COMP | |
mapping(address => mapping(address => uint)) public compSupplierIndex; | |
/// @notice The COMP borrow index for each market for each borrower as of the last time they accrued COMP | |
mapping(address => mapping(address => uint)) public compBorrowerIndex; | |
/// @notice The COMP accrued but not yet transferred to each user | |
mapping(address => uint) public compAccrued; | |
} | |
contract ComptrollerV4Storage is ComptrollerV3Storage { | |
// @notice The borrowCapGuardian can set borrowCaps to any number for any market. Lowering the borrow cap could disable borrowing on the given market. | |
address public borrowCapGuardian; | |
// @notice Borrow caps enforced by borrowAllowed for each cToken address. Defaults to zero which corresponds to unlimited borrowing. | |
mapping(address => uint) public borrowCaps; | |
} | |
contract ComptrollerV5Storage is ComptrollerV4Storage { | |
/// @notice The portion of COMP that each contributor receives per block | |
mapping(address => uint) public compContributorSpeeds; | |
/// @notice Last block at which a contributor's COMP rewards have been allocated | |
mapping(address => uint) public lastContributorBlock; | |
} | |
contract ComptrollerV6Storage is ComptrollerV5Storage { | |
/// @notice The rate at which comp is distributed to the corresponding borrow market (per block) | |
mapping(address => uint) public compBorrowSpeeds; | |
/// @notice The rate at which comp is distributed to the corresponding supply market (per block) | |
mapping(address => uint) public compSupplySpeeds; | |
} | |
contract ComptrollerV7Storage is ComptrollerV6Storage { | |
/// @notice Flag indicating whether the function to fix COMP accruals has been executed (RE: proposal 62 bug) | |
bool public proposal65FixExecuted; | |
/// @notice Accounting storage mapping account addresses to how much COMP they owe the protocol. | |
mapping(address => uint) public compReceivable; | |
} | |
// File: gist-c2555f63e0ad756e8ad58f3b7461f950/Unitroller.sol | |
pragma solidity ^0.5.16; | |
/** | |
* @title ComptrollerCore | |
* @dev Storage for the comptroller is at this address, while execution is delegated to the `comptrollerImplementation`. | |
* CTokens should reference this contract as their comptroller. | |
*/ | |
contract Unitroller is UnitrollerAdminStorage, ComptrollerErrorReporter { | |
/** | |
* @notice Emitted when pendingComptrollerImplementation is changed | |
*/ | |
event NewPendingImplementation(address oldPendingImplementation, address newPendingImplementation); | |
/** | |
* @notice Emitted when pendingComptrollerImplementation is accepted, which means comptroller implementation is updated | |
*/ | |
event NewImplementation(address oldImplementation, address newImplementation); | |
/** | |
* @notice Emitted when pendingAdmin is changed | |
*/ | |
event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); | |
/** | |
* @notice Emitted when pendingAdmin is accepted, which means admin is updated | |
*/ | |
event NewAdmin(address oldAdmin, address newAdmin); | |
constructor() public { | |
// Set admin to caller | |
admin = msg.sender; | |
} | |
/*** Admin Functions ***/ | |
function _setPendingImplementation(address newPendingImplementation) public returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_IMPLEMENTATION_OWNER_CHECK); | |
} | |
address oldPendingImplementation = pendingComptrollerImplementation; | |
pendingComptrollerImplementation = newPendingImplementation; | |
emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts new implementation of comptroller. msg.sender must be pendingImplementation | |
* @dev Admin function for new implementation to accept it's role as implementation | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptImplementation() public returns (uint) { | |
// Check caller is pendingImplementation and pendingImplementation ≠ address(0) | |
if (msg.sender != pendingComptrollerImplementation || pendingComptrollerImplementation == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldImplementation = comptrollerImplementation; | |
address oldPendingImplementation = pendingComptrollerImplementation; | |
comptrollerImplementation = pendingComptrollerImplementation; | |
pendingComptrollerImplementation = address(0); | |
emit NewImplementation(oldImplementation, comptrollerImplementation); | |
emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. | |
* @param newPendingAdmin New pending admin. | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setPendingAdmin(address newPendingAdmin) public returns (uint) { | |
// Check caller = admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_ADMIN_OWNER_CHECK); | |
} | |
// Save current value, if any, for inclusion in log | |
address oldPendingAdmin = pendingAdmin; | |
// Store pendingAdmin with value newPendingAdmin | |
pendingAdmin = newPendingAdmin; | |
// Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) | |
emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin | |
* @dev Admin function for pending admin to accept role and update admin | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _acceptAdmin() public returns (uint) { | |
// Check caller is pendingAdmin and pendingAdmin ≠ address(0) | |
if (msg.sender != pendingAdmin || msg.sender == address(0)) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_ADMIN_PENDING_ADMIN_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldAdmin = admin; | |
address oldPendingAdmin = pendingAdmin; | |
// Store admin with value pendingAdmin | |
admin = pendingAdmin; | |
// Clear the pending value | |
pendingAdmin = address(0); | |
emit NewAdmin(oldAdmin, admin); | |
emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @dev Delegates execution to an implementation contract. | |
* It returns to the external caller whatever the implementation returns | |
* or forwards reverts. | |
*/ | |
function () payable external { | |
// delegate all other functions to current implementation | |
(bool success, ) = comptrollerImplementation.delegatecall(msg.data); | |
assembly { | |
let free_mem_ptr := mload(0x40) | |
returndatacopy(free_mem_ptr, 0, returndatasize) | |
switch success | |
case 0 { revert(free_mem_ptr, returndatasize) } | |
default { return(free_mem_ptr, returndatasize) } | |
} | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// SPDX-License-Identifier: MIT | |
pragma solidity ^0.8.0; | |
/** | |
* @title The ConfirmedOwner contract | |
* @notice A contract with helpers for basic contract ownership. | |
*/ | |
contract ConfirmedOwner { | |
address private s_owner; | |
address private s_pendingOwner; | |
event OwnershipTransferRequested( | |
address indexed from, | |
address indexed to | |
); | |
event OwnershipTransferred( | |
address indexed from, | |
address indexed to | |
); | |
constructor(address newOwner) { | |
s_owner = newOwner; | |
} | |
/** | |
* @notice Allows an owner to begin transferring ownership to a new address, | |
* pending. | |
*/ | |
function transferOwnership( | |
address to | |
) | |
external | |
onlyOwner() | |
{ | |
require(to != msg.sender, "Cannot transfer to self"); | |
s_pendingOwner = to; | |
emit OwnershipTransferRequested(s_owner, to); | |
} | |
/** | |
* @notice Allows an ownership transfer to be completed by the recipient. | |
*/ | |
function acceptOwnership() | |
external | |
{ | |
require(msg.sender == s_pendingOwner, "Must be proposed owner"); | |
address oldOwner = s_owner; | |
s_owner = msg.sender; | |
s_pendingOwner = address(0); | |
emit OwnershipTransferred(oldOwner, msg.sender); | |
} | |
/** | |
* @notice Get the current owner | |
*/ | |
function owner() | |
public | |
view | |
returns ( | |
address | |
) | |
{ | |
return s_owner; | |
} | |
/** | |
* @notice Reverts if called by anyone other than the contract owner. | |
*/ | |
modifier onlyOwner() { | |
require(msg.sender == s_owner, "Only callable by owner"); | |
_; | |
} | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// address 0xbd5527b683d724DF2050f38A18A8FFb8B73850d3 | |
/** | |
*Submitted for verification at Etherscan.io on 2019-05-03 | |
*/ | |
// File: contracts/CarefulMath.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Careful Math | |
* @author Compound | |
* @notice Derived from OpenZeppelin's SafeMath library | |
* https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/contracts/math/SafeMath.sol | |
*/ | |
contract CarefulMath { | |
/** | |
* @dev Possible error codes that we can return | |
*/ | |
enum MathError { | |
NO_ERROR, | |
DIVISION_BY_ZERO, | |
INTEGER_OVERFLOW, | |
INTEGER_UNDERFLOW | |
} | |
/** | |
* @dev Multiplies two numbers, returns an error on overflow. | |
*/ | |
function mulUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (a == 0) { | |
return (MathError.NO_ERROR, 0); | |
} | |
uint c = a * b; | |
if (c / a != b) { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} else { | |
return (MathError.NO_ERROR, c); | |
} | |
} | |
/** | |
* @dev Integer division of two numbers, truncating the quotient. | |
*/ | |
function divUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b == 0) { | |
return (MathError.DIVISION_BY_ZERO, 0); | |
} | |
return (MathError.NO_ERROR, a / b); | |
} | |
/** | |
* @dev Subtracts two numbers, returns an error on overflow (i.e. if subtrahend is greater than minuend). | |
*/ | |
function subUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
if (b <= a) { | |
return (MathError.NO_ERROR, a - b); | |
} else { | |
return (MathError.INTEGER_UNDERFLOW, 0); | |
} | |
} | |
/** | |
* @dev Adds two numbers, returns an error on overflow. | |
*/ | |
function addUInt(uint a, uint b) internal pure returns (MathError, uint) { | |
uint c = a + b; | |
if (c >= a) { | |
return (MathError.NO_ERROR, c); | |
} else { | |
return (MathError.INTEGER_OVERFLOW, 0); | |
} | |
} | |
/** | |
* @dev add a and b and then subtract c | |
*/ | |
function addThenSubUInt(uint a, uint b, uint c) internal pure returns (MathError, uint) { | |
(MathError err0, uint sum) = addUInt(a, b); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, 0); | |
} | |
return subUInt(sum, c); | |
} | |
} | |
// File: contracts/Exponential.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title Exponential module for storing fixed-decision decimals | |
* @author Compound | |
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places. | |
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is: | |
* `Exp({mantissa: 5100000000000000000})`. | |
*/ | |
contract Exponential is CarefulMath { | |
uint constant expScale = 1e18; | |
uint constant halfExpScale = expScale/2; | |
uint constant mantissaOne = expScale; | |
struct Exp { | |
uint mantissa; | |
} | |
/** | |
* @dev Creates an exponential from numerator and denominator values. | |
* Note: Returns an error if (`num` * 10e18) > MAX_INT, | |
* or if `denom` is zero. | |
*/ | |
function getExp(uint num, uint denom) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledNumerator) = mulUInt(num, expScale); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
(MathError err1, uint rational) = divUInt(scaledNumerator, denom); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: rational})); | |
} | |
/** | |
* @dev Adds two exponentials, returning a new exponential. | |
*/ | |
function addExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = addUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Subtracts two exponentials, returning a new exponential. | |
*/ | |
function subExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError error, uint result) = subUInt(a.mantissa, b.mantissa); | |
return (error, Exp({mantissa: result})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, returning a new Exp. | |
*/ | |
function mulScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint scaledMantissa) = mulUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: scaledMantissa})); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer. | |
*/ | |
function mulScalarTruncate(Exp memory a, uint scalar) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(product)); | |
} | |
/** | |
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer. | |
*/ | |
function mulScalarTruncateAddUInt(Exp memory a, uint scalar, uint addend) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory product) = mulScalar(a, scalar); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return addUInt(truncate(product), addend); | |
} | |
/** | |
* @dev Divide an Exp by a scalar, returning a new Exp. | |
*/ | |
function divScalar(Exp memory a, uint scalar) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint descaledMantissa) = divUInt(a.mantissa, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return (MathError.NO_ERROR, Exp({mantissa: descaledMantissa})); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, returning a new Exp. | |
*/ | |
function divScalarByExp(uint scalar, Exp memory divisor) pure internal returns (MathError, Exp memory) { | |
/* | |
We are doing this as: | |
getExp(mulUInt(expScale, scalar), divisor.mantissa) | |
How it works: | |
Exp = a / b; | |
Scalar = s; | |
`s / (a / b)` = `b * s / a` and since for an Exp `a = mantissa, b = expScale` | |
*/ | |
(MathError err0, uint numerator) = mulUInt(expScale, scalar); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
return getExp(numerator, divisor.mantissa); | |
} | |
/** | |
* @dev Divide a scalar by an Exp, then truncate to return an unsigned integer. | |
*/ | |
function divScalarByExpTruncate(uint scalar, Exp memory divisor) pure internal returns (MathError, uint) { | |
(MathError err, Exp memory fraction) = divScalarByExp(scalar, divisor); | |
if (err != MathError.NO_ERROR) { | |
return (err, 0); | |
} | |
return (MathError.NO_ERROR, truncate(fraction)); | |
} | |
/** | |
* @dev Multiplies two exponentials, returning a new exponential. | |
*/ | |
function mulExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
(MathError err0, uint doubleScaledProduct) = mulUInt(a.mantissa, b.mantissa); | |
if (err0 != MathError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0})); | |
} | |
// We add half the scale before dividing so that we get rounding instead of truncation. | |
// See "Listing 6" and text above it at https://accu.org/index.php/journals/1717 | |
// Without this change, a result like 6.6...e-19 will be truncated to 0 instead of being rounded to 1e-18. | |
(MathError err1, uint doubleScaledProductWithHalfScale) = addUInt(halfExpScale, doubleScaledProduct); | |
if (err1 != MathError.NO_ERROR) { | |
return (err1, Exp({mantissa: 0})); | |
} | |
(MathError err2, uint product) = divUInt(doubleScaledProductWithHalfScale, expScale); | |
// The only error `div` can return is MathError.DIVISION_BY_ZERO but we control `expScale` and it is not zero. | |
assert(err2 == MathError.NO_ERROR); | |
return (MathError.NO_ERROR, Exp({mantissa: product})); | |
} | |
/** | |
* @dev Multiplies two exponentials given their mantissas, returning a new exponential. | |
*/ | |
function mulExp(uint a, uint b) pure internal returns (MathError, Exp memory) { | |
return mulExp(Exp({mantissa: a}), Exp({mantissa: b})); | |
} | |
/** | |
* @dev Multiplies three exponentials, returning a new exponential. | |
*/ | |
function mulExp3(Exp memory a, Exp memory b, Exp memory c) pure internal returns (MathError, Exp memory) { | |
(MathError err, Exp memory ab) = mulExp(a, b); | |
if (err != MathError.NO_ERROR) { | |
return (err, ab); | |
} | |
return mulExp(ab, c); | |
} | |
/** | |
* @dev Divides two exponentials, returning a new exponential. | |
* (a/scale) / (b/scale) = (a/scale) * (scale/b) = a/b, | |
* which we can scale as an Exp by calling getExp(a.mantissa, b.mantissa) | |
*/ | |
function divExp(Exp memory a, Exp memory b) pure internal returns (MathError, Exp memory) { | |
return getExp(a.mantissa, b.mantissa); | |
} | |
/** | |
* @dev Truncates the given exp to a whole number value. | |
* For example, truncate(Exp{mantissa: 15 * expScale}) = 15 | |
*/ | |
function truncate(Exp memory exp) pure internal returns (uint) { | |
// Note: We are not using careful math here as we're performing a division that cannot fail | |
return exp.mantissa / expScale; | |
} | |
/** | |
* @dev Checks if first Exp is less than second Exp. | |
*/ | |
function lessThanExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa < right.mantissa; //TODO: Add some simple tests and this in another PR yo. | |
} | |
/** | |
* @dev Checks if left Exp <= right Exp. | |
*/ | |
function lessThanOrEqualExp(Exp memory left, Exp memory right) pure internal returns (bool) { | |
return left.mantissa <= right.mantissa; | |
} | |
/** | |
* @dev returns true if Exp is exactly zero | |
*/ | |
function isZeroExp(Exp memory value) pure internal returns (bool) { | |
return value.mantissa == 0; | |
} | |
} | |
// File: contracts/InterestRateModel.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title The Compound InterestRateModel Interface | |
* @author Compound | |
* @notice Any interest rate model should derive from this contract. | |
* @dev These functions are specifically not marked `pure` as implementations of this | |
* contract may read from storage variables. | |
*/ | |
interface InterestRateModel { | |
/** | |
* @notice Gets the current borrow interest rate based on the given asset, total cash, total borrows | |
* and total reserves. | |
* @dev The return value should be scaled by 1e18, thus a return value of | |
* `(true, 1000000000000)` implies an interest rate of 0.000001 or 0.0001% *per block*. | |
* @param cash The total cash of the underlying asset in the CToken | |
* @param borrows The total borrows of the underlying asset in the CToken | |
* @param reserves The total reserves of the underlying asset in the CToken | |
* @return Success or failure and the borrow interest rate per block scaled by 10e18 | |
*/ | |
function getBorrowRate(uint cash, uint borrows, uint reserves) external view returns (uint, uint); | |
/** | |
* @notice Marker function used for light validation when updating the interest rate model of a market | |
* @dev Marker function used for light validation when updating the interest rate model of a market. Implementations should simply return true. | |
* @return Success or failure | |
*/ | |
function isInterestRateModel() external view returns (bool); | |
} | |
// File: contracts/WhitePaperInterestRateModel.sol | |
pragma solidity ^0.5.8; | |
/** | |
* @title The Compound Standard Interest Rate Model with pluggable constants | |
* @author Compound | |
* @notice See Section 2.4 of the Compound Whitepaper | |
*/ | |
contract WhitePaperInterestRateModel is InterestRateModel, Exponential { | |
/** | |
* @notice Indicator that this is an InterestRateModel contract (for inspection) | |
*/ | |
bool public constant isInterestRateModel = true; | |
/** | |
* @notice The multiplier of utilization rate that gives the slope of the interest rate | |
*/ | |
uint public multiplier; | |
/** | |
* @notice The base interest rate which is the y-intercept when utilization rate is 0 | |
*/ | |
uint public baseRate; | |
/** | |
* @notice The approximate number of blocks per year that is assumed by the interest rate model | |
*/ | |
uint public constant blocksPerYear = 2102400; | |
constructor(uint baseRate_, uint multiplier_) public { | |
baseRate = baseRate_; | |
multiplier = multiplier_; | |
} | |
enum IRError { | |
NO_ERROR, | |
FAILED_TO_ADD_CASH_PLUS_BORROWS, | |
FAILED_TO_GET_EXP, | |
FAILED_TO_MUL_UTILIZATION_RATE, | |
FAILED_TO_ADD_BASE_RATE | |
} | |
/* | |
* @dev Calculates the utilization rate (borrows / (cash + borrows)) as an Exp | |
*/ | |
function getUtilizationRate(uint cash, uint borrows) pure internal returns (IRError, Exp memory) { | |
if (borrows == 0) { | |
// Utilization rate is zero when there's no borrows | |
return (IRError.NO_ERROR, Exp({mantissa: 0})); | |
} | |
(MathError err0, uint cashPlusBorrows) = addUInt(cash, borrows); | |
if (err0 != MathError.NO_ERROR) { | |
return (IRError.FAILED_TO_ADD_CASH_PLUS_BORROWS, Exp({mantissa: 0})); | |
} | |
(MathError err1, Exp memory utilizationRate) = getExp(borrows, cashPlusBorrows); | |
if (err1 != MathError.NO_ERROR) { | |
return (IRError.FAILED_TO_GET_EXP, Exp({mantissa: 0})); | |
} | |
return (IRError.NO_ERROR, utilizationRate); | |
} | |
/* | |
* @dev Calculates the utilization and borrow rates for use by getBorrowRate function | |
*/ | |
function getUtilizationAndAnnualBorrowRate(uint cash, uint borrows) view internal returns (IRError, Exp memory, Exp memory) { | |
(IRError err0, Exp memory utilizationRate) = getUtilizationRate(cash, borrows); | |
if (err0 != IRError.NO_ERROR) { | |
return (err0, Exp({mantissa: 0}), Exp({mantissa: 0})); | |
} | |
// Borrow Rate is 5% + UtilizationRate * 45% (baseRate + UtilizationRate * multiplier); | |
// 45% of utilizationRate, is `rate * 45 / 100` | |
(MathError err1, Exp memory utilizationRateMuled) = mulScalar(utilizationRate, multiplier); | |
// `mulScalar` only overflows when the product is >= 2^256. | |
// utilizationRate is a real number on the interval [0,1], which means that | |
// utilizationRate.mantissa is in the interval [0e18,1e18], which means that 45 times | |
// that is in the interval [0e18,45e18]. That interval has no intersection with 2^256, and therefore | |
// this can never overflow for the standard rates. | |
if (err1 != MathError.NO_ERROR) { | |
return (IRError.FAILED_TO_MUL_UTILIZATION_RATE, Exp({mantissa: 0}), Exp({mantissa: 0})); | |
} | |
(MathError err2, Exp memory utilizationRateScaled) = divScalar(utilizationRateMuled, mantissaOne); | |
// 100 is a constant, and therefore cannot be zero, which is the only error case of divScalar. | |
assert(err2 == MathError.NO_ERROR); | |
// Add the 5% for (5% + 45% * Ua) | |
(MathError err3, Exp memory annualBorrowRate) = addExp(utilizationRateScaled, Exp({mantissa: baseRate})); | |
// `addExp` only fails when the addition of mantissas overflow. | |
// As per above, utilizationRateMuled is capped at 45e18, | |
// and utilizationRateScaled is capped at 4.5e17. mantissaFivePercent = 0.5e17, and thus the addition | |
// is capped at 5e17, which is less than 2^256. This only applies to the standard rates | |
if (err3 != MathError.NO_ERROR) { | |
return (IRError.FAILED_TO_ADD_BASE_RATE, Exp({mantissa: 0}), Exp({mantissa: 0})); | |
} | |
return (IRError.NO_ERROR, utilizationRate, annualBorrowRate); | |
} | |
/** | |
* @notice Gets the current borrow interest rate based on the given asset, total cash, total borrows | |
* and total reserves. | |
* @dev The return value should be scaled by 1e18, thus a return value of | |
* `(true, 1000000000000)` implies an interest rate of 0.000001 or 0.0001% *per block*. | |
* @param cash The total cash of the underlying asset in the CToken | |
* @param borrows The total borrows of the underlying asset in the CToken | |
* @param _reserves The total reserves of the underlying asset in the CToken | |
* @return Success or failure and the borrow interest rate per block scaled by 10e18 | |
*/ | |
function getBorrowRate(uint cash, uint borrows, uint _reserves) public view returns (uint, uint) { | |
_reserves; // pragma ignore unused argument | |
(IRError err0, Exp memory _utilizationRate, Exp memory annualBorrowRate) = getUtilizationAndAnnualBorrowRate(cash, borrows); | |
if (err0 != IRError.NO_ERROR) { | |
return (uint(err0), 0); | |
} | |
// And then divide down by blocks per year. | |
(MathError err1, Exp memory borrowRate) = divScalar(annualBorrowRate, blocksPerYear); // basis points * blocks per year | |
// divScalar only fails when divisor is zero. This is clearly not the case. | |
assert(err1 == MathError.NO_ERROR); | |
_utilizationRate; // pragma ignore unused variable | |
// Note: mantissa is the rate scaled 1e18, which matches the expected result | |
return (uint(IRError.NO_ERROR), borrowRate.mantissa); | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment