Created
April 21, 2021 17:35
-
-
Save AliWisam/955e21f96edb0e7d9ef83f242d0262ac 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=false&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
pragma solidity ^0.5.5; | |
/** | |
* @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 Converts an `address` into `address payable`. Note that this is | |
* simply a type cast: the actual underlying value is not changed. | |
* | |
* _Available since v2.4.0._ | |
*/ | |
function toPayable(address account) internal pure returns (address payable) { | |
return address(uint160(account)); | |
} | |
/** | |
* @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]. | |
* | |
* _Available since v2.4.0._ | |
*/ | |
function sendValue(address payable recipient, uint256 amount) internal { | |
require(address(this).balance >= amount, "Address: insufficient balance"); | |
// solhint-disable-next-line avoid-call-value | |
// solium-disable-next-line security/no-call-value | |
(bool success, ) = recipient.call.value(amount)(""); | |
require(success, "Address: unable to send value, recipient may have reverted"); | |
} | |
} |
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; | |
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); | |
} |
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; | |
/** | |
* @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); | |
} | |
} |
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 "./VToken.sol"; | |
import "./ErrorReporter.sol"; | |
import "./Exponential.sol"; | |
import "./PriceOracle.sol"; | |
import "./ComptrollerInterface.sol"; | |
import "./ComptrollerStorage.sol"; | |
import "./Unitroller.sol"; | |
import "./XVS.sol"; | |
import "./VAI.sol"; | |
/** | |
* @title Venus's Comptroller Contract | |
* @author Venus | |
*/ | |
contract Comptroller is ComptrollerV3Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { | |
/// @notice Emitted when an admin supports a market | |
event MarketListed(VToken vToken); | |
/// @notice Emitted when an account enters a market | |
event MarketEntered(VToken vToken, address account); | |
/// @notice Emitted when an account exits a market | |
event MarketExited(VToken vToken, 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(VToken vToken, 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 VAI Vault info is changed | |
event NewVAIVaultInfo(address vault_, uint releaseStartBlock_, uint releaseInterval_); | |
/// @notice Emitted when pause guardian is changed | |
event NewPauseGuardian(address oldPauseGuardian, address newPauseGuardian); | |
/// @notice Emitted when an action is paused globally | |
event ActionPaused(string action, bool pauseState); | |
/// @notice Emitted when an action is paused on a market | |
event ActionPaused(VToken vToken, string action, bool pauseState); | |
/// @notice Emitted when Venus VAI rate is changed | |
event NewVenusVAIRate(uint oldVenusVAIRate, uint newVenusVAIRate); | |
/// @notice Emitted when Venus VAI Vault rate is changed | |
event NewVenusVAIVaultRate(uint oldVenusVAIVaultRate, uint newVenusVAIVaultRate); | |
/// @notice Emitted when a new Venus speed is calculated for a market | |
event VenusSpeedUpdated(VToken indexed vToken, uint newSpeed); | |
/// @notice Emitted when XVS is distributed to a supplier | |
event DistributedSupplierVenus(VToken indexed vToken, address indexed supplier, uint venusDelta, uint venusSupplyIndex); | |
/// @notice Emitted when XVS is distributed to a borrower | |
event DistributedBorrowerVenus(VToken indexed vToken, address indexed borrower, uint venusDelta, uint venusBorrowIndex); | |
/// @notice Emitted when XVS is distributed to a VAI minter | |
event DistributedVAIMinterVenus(address indexed vaiMinter, uint venusDelta, uint venusVAIMintIndex); | |
/// @notice Emitted when XVS is distributed to VAI Vault | |
event DistributedVAIVaultVenus(uint amount); | |
/// @notice Emitted when VAIController is changed | |
event NewVAIController(VAIControllerInterface oldVAIController, VAIControllerInterface newVAIController); | |
/// @notice Emitted when VAI mint rate is changed by admin | |
event NewVAIMintRate(uint oldVAIMintRate, uint newVAIMintRate); | |
/// @notice Emitted when protocol state is changed by admin | |
event ActionProtocolPaused(bool state); | |
/// @notice Emitted when borrow cap for a vToken is changed | |
event NewBorrowCap(VToken indexed vToken, uint newBorrowCap); | |
/// @notice Emitted when borrow cap guardian is changed | |
event NewBorrowCapGuardian(address oldBorrowCapGuardian, address newBorrowCapGuardian); | |
/// @notice The initial Venus index for a market | |
uint224 public constant venusInitialIndex = 1e36; | |
// 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; | |
} | |
modifier onlyProtocolAllowed { | |
require(!protocolPaused, "protocol is paused"); | |
_; | |
} | |
modifier onlyAdmin() { | |
require(msg.sender == admin, "only admin can"); | |
_; | |
} | |
modifier onlyListedMarket(VToken vToken) { | |
require(markets[address(vToken)].isListed, "venus market is not listed"); | |
_; | |
} | |
modifier validPauseState(bool state) { | |
require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can"); | |
require(msg.sender == admin || state == true, "only admin can unpause"); | |
_; | |
} | |
/*** 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 (VToken[] memory) { | |
return accountAssets[account]; | |
} | |
/** | |
* @notice Returns whether the given account is entered in the given asset | |
* @param account The address of the account to check | |
* @param vToken The vToken to check | |
* @return True if the account is in the asset, otherwise false. | |
*/ | |
function checkMembership(address account, VToken vToken) external view returns (bool) { | |
return markets[address(vToken)].accountMembership[account]; | |
} | |
/** | |
* @notice Add assets to be included in account liquidity calculation | |
* @param vTokens The list of addresses of the vToken markets to be enabled | |
* @return Success indicator for whether each corresponding market was entered | |
*/ | |
function enterMarkets(address[] calldata vTokens) external returns (uint[] memory) { | |
uint len = vTokens.length; | |
uint[] memory results = new uint[](len); | |
for (uint i = 0; i < len; i++) { | |
results[i] = uint(addToMarketInternal(VToken(vTokens[i]), msg.sender)); | |
} | |
return results; | |
} | |
/** | |
* @notice Add the market to the borrower's "assets in" for liquidity calculations | |
* @param vToken The market to enter | |
* @param borrower The address of the account to modify | |
* @return Success indicator for whether the market was entered | |
*/ | |
function addToMarketInternal(VToken vToken, address borrower) internal returns (Error) { | |
Market storage marketToJoin = markets[address(vToken)]; | |
if (!marketToJoin.isListed) { | |
// market is not listed, cannot join | |
return Error.MARKET_NOT_LISTED; | |
} | |
if (marketToJoin.accountMembership[borrower]) { | |
// 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(vToken); | |
emit MarketEntered(vToken, 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 necessary collateral for an outstanding borrow. | |
* @param vTokenAddress The address of the asset to be removed | |
* @return Whether or not the account successfully exited the market | |
*/ | |
function exitMarket(address vTokenAddress) external returns (uint) { | |
VToken vToken = VToken(vTokenAddress); | |
/* Get sender tokensHeld and amountOwed underlying from the vToken */ | |
(uint oErr, uint tokensHeld, uint amountOwed, ) = vToken.getAccountSnapshot(msg.sender); | |
require(oErr == 0, "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(vTokenAddress, msg.sender, tokensHeld); | |
if (allowed != 0) { | |
return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); | |
} | |
Market storage marketToExit = markets[address(vToken)]; | |
/* Return true if the sender is not already ‘in’ the market */ | |
if (!marketToExit.accountMembership[msg.sender]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Set vToken account membership to false */ | |
delete marketToExit.accountMembership[msg.sender]; | |
/* Delete vToken from the account’s list of assets */ | |
// In order to delete vToken, copy last item in list to location of item to be removed, reduce length by 1 | |
VToken[] storage userAssetList = accountAssets[msg.sender]; | |
uint len = userAssetList.length; | |
uint i; | |
for (; i < len; i++) { | |
if (userAssetList[i] == vToken) { | |
userAssetList[i] = userAssetList[len - 1]; | |
userAssetList.length--; | |
break; | |
} | |
} | |
// We *must* have found the asset in the list or our redundant data structure is broken | |
assert(i < len); | |
emit MarketExited(vToken, 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 vToken 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 vToken, address minter, uint mintAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintGuardianPaused[vToken], "mint is paused"); | |
// Shh - currently unused | |
mintAmount; | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, minter); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates mint and reverts on rejection. May emit logs. | |
* @param vToken Asset being minted | |
* @param minter The address minting the tokens | |
* @param actualMintAmount The amount of the underlying asset being minted | |
* @param mintTokens The number of tokens being minted | |
*/ | |
function mintVerify(address vToken, address minter, uint actualMintAmount, uint mintTokens) external { | |
// Shh - currently unused | |
vToken; | |
minter; | |
actualMintAmount; | |
mintTokens; | |
} | |
/** | |
* @notice Checks if the account should be allowed to redeem tokens in the given market | |
* @param vToken The market to verify the redeem against | |
* @param redeemer The account which would redeem the tokens | |
* @param redeemTokens The number of vTokens 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 vToken, address redeemer, uint redeemTokens) external onlyProtocolAllowed returns (uint) { | |
uint allowed = redeemAllowedInternal(vToken, redeemer, redeemTokens); | |
if (allowed != uint(Error.NO_ERROR)) { | |
return allowed; | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, redeemer); | |
return uint(Error.NO_ERROR); | |
} | |
function redeemAllowedInternal(address vToken, address redeemer, uint redeemTokens) internal view returns (uint) { | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
/* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ | |
if (!markets[vToken].accountMembership[redeemer]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, VToken(vToken), 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 vToken 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 vToken, address redeemer, uint redeemAmount, uint redeemTokens) external { | |
// Shh - currently unused | |
vToken; | |
redeemer; | |
// Require tokens is zero or amount is also zero | |
require(redeemTokens != 0 || redeemAmount == 0, "redeemTokens zero"); | |
} | |
/** | |
* @notice Checks if the account should be allowed to borrow the underlying asset of the given market | |
* @param vToken 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 vToken, address borrower, uint borrowAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!borrowGuardianPaused[vToken], "borrow is paused"); | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
if (!markets[vToken].accountMembership[borrower]) { | |
// only vTokens may call borrowAllowed if borrower not in market | |
require(msg.sender == vToken, "sender must be vToken"); | |
// attempt to add borrower to the market | |
Error err = addToMarketInternal(VToken(vToken), borrower); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
} | |
if (oracle.getUnderlyingPrice(VToken(vToken)) == 0) { | |
return uint(Error.PRICE_ERROR); | |
} | |
uint borrowCap = borrowCaps[vToken]; | |
// Borrow cap of 0 corresponds to unlimited borrowing | |
if (borrowCap != 0) { | |
uint totalBorrows = VToken(vToken).totalBorrows(); | |
(MathError mathErr, uint nextTotalBorrows) = addUInt(totalBorrows, borrowAmount); | |
require(mathErr == MathError.NO_ERROR, "total borrows overflow"); | |
require(nextTotalBorrows < borrowCap, "market borrow cap reached"); | |
} | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, VToken(vToken), 0, borrowAmount); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
if (shortfall != 0) { | |
return uint(Error.INSUFFICIENT_LIQUIDITY); | |
} | |
// Keep the flywheel moving | |
Exp memory borrowIndex = Exp({mantissa: VToken(vToken).borrowIndex()}); | |
updateVenusBorrowIndex(vToken, borrowIndex); | |
distributeBorrowerVenus(vToken, borrower, borrowIndex); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates borrow and reverts on rejection. May emit logs. | |
* @param vToken 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 vToken, address borrower, uint borrowAmount) external { | |
// Shh - currently unused | |
vToken; | |
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 vToken The market to verify the repay against | |
* @param payer The account which would repay the asset | |
* @param borrower The account which would repay 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 vToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external onlyProtocolAllowed returns (uint) { | |
// Shh - currently unused | |
payer; | |
borrower; | |
repayAmount; | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// Keep the flywheel moving | |
Exp memory borrowIndex = Exp({mantissa: VToken(vToken).borrowIndex()}); | |
updateVenusBorrowIndex(vToken, borrowIndex); | |
distributeBorrowerVenus(vToken, borrower, borrowIndex); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates repayBorrow and reverts on rejection. May emit logs. | |
* @param vToken Asset being repaid | |
* @param payer The address repaying the borrow | |
* @param borrower The address of the borrower | |
* @param actualRepayAmount The amount of underlying being repaid | |
*/ | |
function repayBorrowVerify( | |
address vToken, | |
address payer, | |
address borrower, | |
uint actualRepayAmount, | |
uint borrowerIndex) external { | |
// Shh - currently unused | |
vToken; | |
payer; | |
borrower; | |
actualRepayAmount; | |
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 vTokenBorrowed Asset which was borrowed by the borrower | |
* @param vTokenCollateral 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 vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external onlyProtocolAllowed returns (uint) { | |
// Shh - currently unused | |
liquidator; | |
if (!markets[vTokenBorrowed].isListed || !markets[vTokenCollateral].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
/* The borrower must have shortfall in order to be liquidatable */ | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, VToken(0), 0, 0); | |
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 = VToken(vTokenBorrowed).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 vTokenBorrowed Asset which was borrowed by the borrower | |
* @param vTokenCollateral 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 actualRepayAmount The amount of underlying being repaid | |
*/ | |
function liquidateBorrowVerify( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint actualRepayAmount, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
vTokenBorrowed; | |
vTokenCollateral; | |
liquidator; | |
borrower; | |
actualRepayAmount; | |
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 vTokenCollateral Asset which was used as collateral and will be seized | |
* @param vTokenBorrowed 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 vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!seizeGuardianPaused, "seize is paused"); | |
// Shh - currently unused | |
seizeTokens; | |
if (!markets[vTokenCollateral].isListed || !markets[vTokenBorrowed].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
if (VToken(vTokenCollateral).comptroller() != VToken(vTokenBorrowed).comptroller()) { | |
return uint(Error.COMPTROLLER_MISMATCH); | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vTokenCollateral); | |
distributeSupplierVenus(vTokenCollateral, borrower); | |
distributeSupplierVenus(vTokenCollateral, liquidator); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates seize and reverts on rejection. May emit logs. | |
* @param vTokenCollateral Asset which was used as collateral and will be seized | |
* @param vTokenBorrowed 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 vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
vTokenCollateral; | |
vTokenBorrowed; | |
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 vToken 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 vTokens to transfer | |
* @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function transferAllowed(address vToken, address src, address dst, uint transferTokens) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!transferGuardianPaused, "transfer is paused"); | |
// Currently the only consideration is whether or not | |
// the src is allowed to redeem this many tokens | |
uint allowed = redeemAllowedInternal(vToken, src, transferTokens); | |
if (allowed != uint(Error.NO_ERROR)) { | |
return allowed; | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, src); | |
distributeSupplierVenus(vToken, dst); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates transfer and reverts on rejection. May emit logs. | |
* @param vToken Asset being transferred | |
* @param src The account which sources the tokens | |
* @param dst The account which receives the tokens | |
* @param transferTokens The number of vTokens to transfer | |
*/ | |
function transferVerify(address vToken, address src, address dst, uint transferTokens) external { | |
// Shh - currently unused | |
vToken; | |
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 `vTokenBalance` is the number of vTokens 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 vTokenBalance; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
uint oraclePriceMantissa; | |
Exp collateralFactor; | |
Exp exchangeRate; | |
Exp oraclePrice; | |
Exp tokensToDenom; | |
} | |
/** | |
* @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, VToken(0), 0, 0); | |
return (uint(err), liquidity, shortfall); | |
} | |
/** | |
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed | |
* @param vTokenModify 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 | |
* @return (possible error code (semi-opaque), | |
hypothetical account liquidity in excess of collateral requirements, | |
* hypothetical account shortfall below collateral requirements) | |
*/ | |
function getHypotheticalAccountLiquidity( | |
address account, | |
address vTokenModify, | |
uint redeemTokens, | |
uint borrowAmount) public view returns (uint, uint, uint) { | |
(Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, VToken(vTokenModify), redeemTokens, borrowAmount); | |
return (uint(err), liquidity, shortfall); | |
} | |
/** | |
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed | |
* @param vTokenModify 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 vToken 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, | |
VToken vTokenModify, | |
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 | |
VToken[] memory assets = accountAssets[account]; | |
for (uint i = 0; i < assets.length; i++) { | |
VToken asset = assets[i]; | |
// Read the balances and exchange rate from the vToken | |
(oErr, vars.vTokenBalance, 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 -> bnb (normalized price value) | |
(mErr, vars.tokensToDenom) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
// sumCollateral += tokensToDenom * vTokenBalance | |
(mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToDenom, vars.vTokenBalance, 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 vTokenModify | |
if (asset == vTokenModify) { | |
// redeem effect | |
// sumBorrowPlusEffects += tokensToDenom * redeemTokens | |
(mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToDenom, 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); | |
} | |
} | |
} | |
/// @dev VAI Integration^ | |
(mErr, vars.sumBorrowPlusEffects) = addUInt(vars.sumBorrowPlusEffects, mintedVAIs[account]); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
/// @dev VAI Integration$ | |
// 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 vToken.liquidateBorrowFresh) | |
* @param vTokenBorrowed The address of the borrowed vToken | |
* @param vTokenCollateral The address of the collateral vToken | |
* @param actualRepayAmount The amount of vTokenBorrowed underlying to convert into vTokenCollateral tokens | |
* @return (errorCode, number of vTokenCollateral tokens to be seized in a liquidation) | |
*/ | |
function liquidateCalculateSeizeTokens(address vTokenBorrowed, address vTokenCollateral, uint actualRepayAmount) external view returns (uint, uint) { | |
/* Read oracle prices for borrowed and collateral markets */ | |
uint priceBorrowedMantissa = oracle.getUnderlyingPrice(VToken(vTokenBorrowed)); | |
uint priceCollateralMantissa = oracle.getUnderlyingPrice(VToken(vTokenCollateral)); | |
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 = actualRepayAmount * liquidationIncentive * priceBorrowed / priceCollateral | |
* seizeTokens = seizeAmount / exchangeRate | |
* = actualRepayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) | |
*/ | |
uint exchangeRateMantissa = VToken(vTokenCollateral).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, actualRepayAmount); | |
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 (uint) { | |
// 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, newCloseFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets the collateralFactor for a market | |
* @dev Admin function to set per-market collateralFactor | |
* @param vToken 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(VToken vToken, uint newCollateralFactorMantissa) external returns (uint) { | |
// 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(vToken)]; | |
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(vToken) == 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(vToken, 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 vToken The address of the market (token) to list | |
* @return uint 0=success, otherwise a failure. (See enum Error for details) | |
*/ | |
function _supportMarket(VToken vToken) external returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); | |
} | |
if (markets[address(vToken)].isListed) { | |
return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); | |
} | |
vToken.isVToken(); // Sanity check to make sure its really a VToken | |
// Note that isVenus is not in active use anymore | |
markets[address(vToken)] = Market({isListed: true, isVenus: false, collateralFactorMantissa: 0}); | |
_addMarketInternal(vToken); | |
emit MarketListed(vToken); | |
return uint(Error.NO_ERROR); | |
} | |
function _addMarketInternal(VToken vToken) internal { | |
for (uint i = 0; i < allMarkets.length; i ++) { | |
require(allMarkets[i] != vToken, "market already added"); | |
} | |
allMarkets.push(vToken); | |
} | |
/** | |
* @notice Set the given borrow caps for the given vToken markets. Borrowing that brings total borrows to or above borrow cap will revert. | |
* @dev Admin or borrowCapGuardian function to set the borrow caps. A borrow cap of 0 corresponds to unlimited borrowing. | |
* @param vTokens The addresses of the markets (tokens) to change the borrow caps for | |
* @param newBorrowCaps The new borrow cap values in underlying to be set. A value of 0 corresponds to unlimited borrowing. | |
*/ | |
function _setMarketBorrowCaps(VToken[] calldata vTokens, uint[] calldata newBorrowCaps) external { | |
require(msg.sender == admin || msg.sender == borrowCapGuardian, "only admin or borrow cap guardian can set borrow caps"); | |
uint numMarkets = vTokens.length; | |
uint numBorrowCaps = newBorrowCaps.length; | |
require(numMarkets != 0 && numMarkets == numBorrowCaps, "invalid input"); | |
for(uint i = 0; i < numMarkets; i++) { | |
borrowCaps[address(vTokens[i])] = newBorrowCaps[i]; | |
emit NewBorrowCap(vTokens[i], newBorrowCaps[i]); | |
} | |
} | |
/** | |
* @notice Admin function to change the Borrow Cap Guardian | |
* @param newBorrowCapGuardian The address of the new Borrow Cap Guardian | |
*/ | |
function _setBorrowCapGuardian(address newBorrowCapGuardian) external { | |
require(msg.sender == admin, "only admin can set borrow cap guardian"); | |
// Save current value for inclusion in log | |
address oldBorrowCapGuardian = borrowCapGuardian; | |
// Store borrowCapGuardian with value newBorrowCapGuardian | |
borrowCapGuardian = newBorrowCapGuardian; | |
// Emit NewBorrowCapGuardian(OldBorrowCapGuardian, NewBorrowCapGuardian) | |
emit NewBorrowCapGuardian(oldBorrowCapGuardian, newBorrowCapGuardian); | |
} | |
/** | |
* @notice Set whole protocol pause/unpause state | |
*/ | |
function _setProtocolPaused(bool state) public onlyAdmin returns(bool) { | |
protocolPaused = state; | |
emit ActionProtocolPaused(state); | |
return state; | |
} | |
/** | |
* @notice Sets a new VAI controller | |
* @dev Admin function to set a new VAI controller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setVAIController(VAIControllerInterface vaiController_) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_VAICONTROLLER_OWNER_CHECK); | |
} | |
VAIControllerInterface oldRate = vaiController; | |
vaiController = vaiController_; | |
emit NewVAIController(oldRate, vaiController_); | |
} | |
function _setVAIMintRate(uint newVAIMintRate) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_VAI_MINT_RATE_CHECK); | |
} | |
uint oldVAIMintRate = vaiMintRate; | |
vaiMintRate = newVAIMintRate; | |
emit NewVAIMintRate(oldVAIMintRate, newVAIMintRate); | |
return uint(Error.NO_ERROR); | |
} | |
function _become(Unitroller unitroller) public { | |
require(msg.sender == unitroller.admin(), "only unitroller admin can"); | |
require(unitroller._acceptImplementation() == 0, "not authorized"); | |
} | |
/** | |
* @notice Checks caller is admin, or this contract is becoming the new implementation | |
*/ | |
function adminOrInitializing() internal view returns (bool) { | |
return msg.sender == admin || msg.sender == comptrollerImplementation; | |
} | |
/*** Venus Distribution ***/ | |
function setVenusSpeedInternal(VToken vToken, uint venusSpeed) internal { | |
uint currentVenusSpeed = venusSpeeds[address(vToken)]; | |
if (currentVenusSpeed != 0) { | |
// note that XVS speed could be set to 0 to halt liquidity rewards for a market | |
Exp memory borrowIndex = Exp({mantissa: vToken.borrowIndex()}); | |
updateVenusSupplyIndex(address(vToken)); | |
updateVenusBorrowIndex(address(vToken), borrowIndex); | |
} else if (venusSpeed != 0) { | |
// Add the XVS market | |
Market storage market = markets[address(vToken)]; | |
require(market.isListed == true, "venus market is not listed"); | |
if (venusSupplyState[address(vToken)].index == 0 && venusSupplyState[address(vToken)].block == 0) { | |
venusSupplyState[address(vToken)] = VenusMarketState({ | |
index: venusInitialIndex, | |
block: safe32(getBlockNumber(), "block number exceeds 32 bits") | |
}); | |
} | |
if (venusBorrowState[address(vToken)].index == 0 && venusBorrowState[address(vToken)].block == 0) { | |
venusBorrowState[address(vToken)] = VenusMarketState({ | |
index: venusInitialIndex, | |
block: safe32(getBlockNumber(), "block number exceeds 32 bits") | |
}); | |
} | |
} | |
if (currentVenusSpeed != venusSpeed) { | |
venusSpeeds[address(vToken)] = venusSpeed; | |
emit VenusSpeedUpdated(vToken, venusSpeed); | |
} | |
} | |
/** | |
* @notice Accrue XVS to the market by updating the supply index | |
* @param vToken The market whose supply index to update | |
*/ | |
function updateVenusSupplyIndex(address vToken) internal { | |
VenusMarketState storage supplyState = venusSupplyState[vToken]; | |
uint supplySpeed = venusSpeeds[vToken]; | |
uint blockNumber = getBlockNumber(); | |
uint deltaBlocks = sub_(blockNumber, uint(supplyState.block)); | |
if (deltaBlocks > 0 && supplySpeed > 0) { | |
uint supplyTokens = VToken(vToken).totalSupply(); | |
uint venusAccrued = mul_(deltaBlocks, supplySpeed); | |
Double memory ratio = supplyTokens > 0 ? fraction(venusAccrued, supplyTokens) : Double({mantissa: 0}); | |
Double memory index = add_(Double({mantissa: supplyState.index}), ratio); | |
venusSupplyState[vToken] = VenusMarketState({ | |
index: safe224(index.mantissa, "new index overflows"), | |
block: safe32(blockNumber, "block number overflows") | |
}); | |
} else if (deltaBlocks > 0) { | |
supplyState.block = safe32(blockNumber, "block number overflows"); | |
} | |
} | |
/** | |
* @notice Accrue XVS to the market by updating the borrow index | |
* @param vToken The market whose borrow index to update | |
*/ | |
function updateVenusBorrowIndex(address vToken, Exp memory marketBorrowIndex) internal { | |
VenusMarketState storage borrowState = venusBorrowState[vToken]; | |
uint borrowSpeed = venusSpeeds[vToken]; | |
uint blockNumber = getBlockNumber(); | |
uint deltaBlocks = sub_(blockNumber, uint(borrowState.block)); | |
if (deltaBlocks > 0 && borrowSpeed > 0) { | |
uint borrowAmount = div_(VToken(vToken).totalBorrows(), marketBorrowIndex); | |
uint venusAccrued = mul_(deltaBlocks, borrowSpeed); | |
Double memory ratio = borrowAmount > 0 ? fraction(venusAccrued, borrowAmount) : Double({mantissa: 0}); | |
Double memory index = add_(Double({mantissa: borrowState.index}), ratio); | |
venusBorrowState[vToken] = VenusMarketState({ | |
index: safe224(index.mantissa, "new index overflows"), | |
block: safe32(blockNumber, "block number overflows") | |
}); | |
} else if (deltaBlocks > 0) { | |
borrowState.block = safe32(blockNumber, "block number overflows"); | |
} | |
} | |
/** | |
* @notice Calculate XVS accrued by a supplier and possibly transfer it to them | |
* @param vToken The market in which the supplier is interacting | |
* @param supplier The address of the supplier to distribute XVS to | |
*/ | |
function distributeSupplierVenus(address vToken, address supplier) internal { | |
if (address(vaiVaultAddress) != address(0)) { | |
releaseToVault(); | |
} | |
VenusMarketState storage supplyState = venusSupplyState[vToken]; | |
Double memory supplyIndex = Double({mantissa: supplyState.index}); | |
Double memory supplierIndex = Double({mantissa: venusSupplierIndex[vToken][supplier]}); | |
venusSupplierIndex[vToken][supplier] = supplyIndex.mantissa; | |
if (supplierIndex.mantissa == 0 && supplyIndex.mantissa > 0) { | |
supplierIndex.mantissa = venusInitialIndex; | |
} | |
Double memory deltaIndex = sub_(supplyIndex, supplierIndex); | |
uint supplierTokens = VToken(vToken).balanceOf(supplier); | |
uint supplierDelta = mul_(supplierTokens, deltaIndex); | |
uint supplierAccrued = add_(venusAccrued[supplier], supplierDelta); | |
venusAccrued[supplier] = supplierAccrued; | |
emit DistributedSupplierVenus(VToken(vToken), supplier, supplierDelta, supplyIndex.mantissa); | |
} | |
/** | |
* @notice Calculate XVS accrued by a borrower and possibly transfer it to them | |
* @dev Borrowers will not begin to accrue until after the first interaction with the protocol. | |
* @param vToken The market in which the borrower is interacting | |
* @param borrower The address of the borrower to distribute XVS to | |
*/ | |
function distributeBorrowerVenus(address vToken, address borrower, Exp memory marketBorrowIndex) internal { | |
if (address(vaiVaultAddress) != address(0)) { | |
releaseToVault(); | |
} | |
VenusMarketState storage borrowState = venusBorrowState[vToken]; | |
Double memory borrowIndex = Double({mantissa: borrowState.index}); | |
Double memory borrowerIndex = Double({mantissa: venusBorrowerIndex[vToken][borrower]}); | |
venusBorrowerIndex[vToken][borrower] = borrowIndex.mantissa; | |
if (borrowerIndex.mantissa > 0) { | |
Double memory deltaIndex = sub_(borrowIndex, borrowerIndex); | |
uint borrowerAmount = div_(VToken(vToken).borrowBalanceStored(borrower), marketBorrowIndex); | |
uint borrowerDelta = mul_(borrowerAmount, deltaIndex); | |
uint borrowerAccrued = add_(venusAccrued[borrower], borrowerDelta); | |
venusAccrued[borrower] = borrowerAccrued; | |
emit DistributedBorrowerVenus(VToken(vToken), borrower, borrowerDelta, borrowIndex.mantissa); | |
} | |
} | |
/** | |
* @notice Calculate XVS accrued by a VAI minter and possibly transfer it to them | |
* @dev VAI minters will not begin to accrue until after the first interaction with the protocol. | |
* @param vaiMinter The address of the VAI minter to distribute XVS to | |
*/ | |
function distributeVAIMinterVenus(address vaiMinter, bool distributeAll) public { | |
if (address(vaiVaultAddress) != address(0)) { | |
releaseToVault(); | |
} | |
if (address(vaiController) != address(0)) { | |
uint vaiMinterAccrued; | |
uint vaiMinterDelta; | |
uint vaiMintIndexMantissa; | |
uint err; | |
(err, vaiMinterAccrued, vaiMinterDelta, vaiMintIndexMantissa) = vaiController.calcDistributeVAIMinterVenus(vaiMinter); | |
if (err == uint(Error.NO_ERROR)) { | |
venusAccrued[vaiMinter] = vaiMinterAccrued; | |
emit DistributedVAIMinterVenus(vaiMinter, vaiMinterDelta, vaiMintIndexMantissa); | |
} | |
} | |
} | |
/** | |
* @notice Claim all the xvs accrued by holder in all markets and VAI | |
* @param holder The address to claim XVS for | |
*/ | |
function claimVenus(address holder) public { | |
return claimVenus(holder, allMarkets); | |
} | |
/** | |
* @notice Claim all the xvs accrued by holder in the specified markets | |
* @param holder The address to claim XVS for | |
* @param vTokens The list of markets to claim XVS in | |
*/ | |
function claimVenus(address holder, VToken[] memory vTokens) public { | |
address[] memory holders = new address[](1); | |
holders[0] = holder; | |
claimVenus(holders, vTokens, true, true); | |
} | |
/** | |
* @notice Claim all xvs accrued by the holders | |
* @param holders The addresses to claim XVS for | |
* @param vTokens The list of markets to claim XVS in | |
* @param borrowers Whether or not to claim XVS earned by borrowing | |
* @param suppliers Whether or not to claim XVS earned by supplying | |
*/ | |
function claimVenus(address[] memory holders, VToken[] memory vTokens, bool borrowers, bool suppliers) public { | |
uint j; | |
if(address(vaiController) != address(0)) { | |
vaiController.updateVenusVAIMintIndex(); | |
} | |
for (j = 0; j < holders.length; j++) { | |
distributeVAIMinterVenus(holders[j], true); | |
venusAccrued[holders[j]] = grantXVSInternal(holders[j], venusAccrued[holders[j]]); | |
} | |
for (uint i = 0; i < vTokens.length; i++) { | |
VToken vToken = vTokens[i]; | |
require(markets[address(vToken)].isListed, "not listed market"); | |
if (borrowers) { | |
Exp memory borrowIndex = Exp({mantissa: vToken.borrowIndex()}); | |
updateVenusBorrowIndex(address(vToken), borrowIndex); | |
for (j = 0; j < holders.length; j++) { | |
distributeBorrowerVenus(address(vToken), holders[j], borrowIndex); | |
venusAccrued[holders[j]] = grantXVSInternal(holders[j], venusAccrued[holders[j]]); | |
} | |
} | |
if (suppliers) { | |
updateVenusSupplyIndex(address(vToken)); | |
for (j = 0; j < holders.length; j++) { | |
distributeSupplierVenus(address(vToken), holders[j]); | |
venusAccrued[holders[j]] = grantXVSInternal(holders[j], venusAccrued[holders[j]]); | |
} | |
} | |
} | |
} | |
/** | |
* @notice Transfer XVS to the user | |
* @dev Note: If there is not enough XVS, we do not perform the transfer all. | |
* @param user The address of the user to transfer XVS to | |
* @param amount The amount of XVS to (possibly) transfer | |
* @return The amount of XVS which was NOT transferred to the user | |
*/ | |
function grantXVSInternal(address user, uint amount) internal returns (uint) { | |
XVS xvs = XVS(getXVSAddress()); | |
uint venusRemaining = xvs.balanceOf(address(this)); | |
if (amount > 0 && amount <= venusRemaining) { | |
xvs.transfer(user, amount); | |
return 0; | |
} | |
return amount; | |
} | |
/*** Venus Distribution Admin ***/ | |
/** | |
* @notice Set the amount of XVS distributed per block to VAI Mint | |
* @param venusVAIRate_ The amount of XVS wei per block to distribute to VAI Mint | |
*/ | |
function _setVenusVAIRate(uint venusVAIRate_) public { | |
require(msg.sender == admin, "only admin can"); | |
uint oldVAIRate = venusVAIRate; | |
venusVAIRate = venusVAIRate_; | |
emit NewVenusVAIRate(oldVAIRate, venusVAIRate_); | |
} | |
/** | |
* @notice Set the amount of XVS distributed per block to VAI Vault | |
* @param venusVAIVaultRate_ The amount of XVS wei per block to distribute to VAI Vault | |
*/ | |
function _setVenusVAIVaultRate(uint venusVAIVaultRate_) public { | |
require(msg.sender == admin, "only admin can"); | |
uint oldVenusVAIVaultRate = venusVAIVaultRate; | |
venusVAIVaultRate = venusVAIVaultRate_; | |
emit NewVenusVAIVaultRate(oldVenusVAIVaultRate, venusVAIVaultRate_); | |
} | |
/** | |
* @notice Set the VAI Vault infos | |
* @param vault_ The address of the VAI Vault | |
* @param releaseStartBlock_ The start block of release to VAI Vault | |
* @param minReleaseAmount_ The minimum release amount to VAI Vault | |
*/ | |
function _setVAIVaultInfo(address vault_, uint256 releaseStartBlock_, uint256 minReleaseAmount_) public { | |
require(msg.sender == admin, "only admin can"); | |
vaiVaultAddress = vault_; | |
releaseStartBlock = releaseStartBlock_; | |
minReleaseAmount = minReleaseAmount_; | |
emit NewVAIVaultInfo(vault_, releaseStartBlock_, minReleaseAmount_); | |
} | |
/** | |
* @notice Set XVS speed for a single market | |
* @param vToken The market whose XVS speed to update | |
* @param venusSpeed New XVS speed for market | |
*/ | |
function _setVenusSpeed(VToken vToken, uint venusSpeed) public { | |
require(adminOrInitializing(), "only admin can set venus speed"); | |
setVenusSpeedInternal(vToken, venusSpeed); | |
} | |
/** | |
* @notice Return all of the markets | |
* @dev The automatic getter may be used to access an individual market. | |
* @return The list of market addresses | |
*/ | |
function getAllMarkets() public view returns (VToken[] memory) { | |
return allMarkets; | |
} | |
function getBlockNumber() public view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Return the address of the XVS token | |
* @return The address of XVS | |
*/ | |
function getXVSAddress() public view returns (address) { | |
return 0xcF6BB5389c92Bdda8a3747Ddb454cB7a64626C63; | |
} | |
/*** VAI functions ***/ | |
/** | |
* @notice Set the minted VAI amount of the `owner` | |
* @param owner The address of the account to set | |
* @param amount The amount of VAI to set to the account | |
* @return The number of minted VAI by `owner` | |
*/ | |
function setMintedVAIOf(address owner, uint amount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintVAIGuardianPaused && !repayVAIGuardianPaused, "VAI is paused"); | |
// Check caller is vaiController | |
if (msg.sender != address(vaiController)) { | |
return fail(Error.REJECTION, FailureInfo.SET_MINTED_VAI_REJECTION); | |
} | |
mintedVAIs[owner] = amount; | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Transfer XVS to VAI Vault | |
*/ | |
function releaseToVault() public { | |
if(releaseStartBlock == 0 || getBlockNumber() < releaseStartBlock) { | |
return; | |
} | |
XVS xvs = XVS(getXVSAddress()); | |
uint256 xvsBalance = xvs.balanceOf(address(this)); | |
if(xvsBalance == 0) { | |
return; | |
} | |
uint256 actualAmount; | |
uint256 deltaBlocks = sub_(getBlockNumber(), releaseStartBlock); | |
// releaseAmount = venusVAIVaultRate * deltaBlocks | |
uint256 _releaseAmount = mul_(venusVAIVaultRate, deltaBlocks); | |
if (_releaseAmount < minReleaseAmount) { | |
return; | |
} | |
if (xvsBalance >= _releaseAmount) { | |
actualAmount = _releaseAmount; | |
} else { | |
actualAmount = xvsBalance; | |
} | |
releaseStartBlock = getBlockNumber(); | |
xvs.transfer(vaiVaultAddress, actualAmount); | |
emit DistributedVAIVaultVenus(actualAmount); | |
IVAIVault(vaiVaultAddress).updatePendingRewards(); | |
} | |
} |
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 "./VToken.sol"; | |
import "./ErrorReporter.sol"; | |
import "./Exponential.sol"; | |
import "./PriceOracle.sol"; | |
import "./ComptrollerInterface.sol"; | |
import "./ComptrollerStorage.sol"; | |
import "./Unitroller.sol"; | |
import "./XVS.sol"; | |
import "./VAI.sol"; | |
/** | |
* @title Venus's Comptroller Contract | |
* @author Venus | |
*/ | |
contract ComptrollerG1 is ComptrollerV1Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { | |
/// @notice Emitted when an admin supports a market | |
event MarketListed(VToken vToken); | |
/// @notice Emitted when an account enters a market | |
event MarketEntered(VToken vToken, address account); | |
/// @notice Emitted when an account exits a market | |
event MarketExited(VToken vToken, 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(VToken vToken, 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 globally | |
event ActionPaused(string action, bool pauseState); | |
/// @notice Emitted when an action is paused on a market | |
event ActionPaused(VToken vToken, string action, bool pauseState); | |
/// @notice Emitted when market venus status is changed | |
event MarketVenus(VToken vToken, bool isVenus); | |
/// @notice Emitted when Venus rate is changed | |
event NewVenusRate(uint oldVenusRate, uint newVenusRate); | |
/// @notice Emitted when Venus VAI rate is changed | |
event NewVenusVAIRate(uint oldVenusVAIRate, uint newVenusVAIRate); | |
/// @notice Emitted when a new Venus speed is calculated for a market | |
event VenusSpeedUpdated(VToken indexed vToken, uint newSpeed); | |
/// @notice Emitted when XVS is distributed to a supplier | |
event DistributedSupplierVenus(VToken indexed vToken, address indexed supplier, uint venusDelta, uint venusSupplyIndex); | |
/// @notice Emitted when XVS is distributed to a borrower | |
event DistributedBorrowerVenus(VToken indexed vToken, address indexed borrower, uint venusDelta, uint venusBorrowIndex); | |
/// @notice Emitted when XVS is distributed to a VAI minter | |
event DistributedVAIMinterVenus(address indexed vaiMinter, uint venusDelta, uint venusVAIMintIndex); | |
/// @notice Emitted when VAIController is changed | |
event NewVAIController(VAIControllerInterface oldVAIController, VAIControllerInterface newVAIController); | |
/// @notice Emitted when VAI mint rate is changed by admin | |
event NewVAIMintRate(uint oldVAIMintRate, uint newVAIMintRate); | |
/// @notice Emitted when protocol state is changed by admin | |
event ActionProtocolPaused(bool state); | |
/// @notice The threshold above which the flywheel transfers XVS, in wei | |
uint public constant venusClaimThreshold = 0.001e18; | |
/// @notice The initial Venus index for a market | |
uint224 public constant venusInitialIndex = 1e36; | |
// 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; | |
} | |
modifier onlyProtocolAllowed { | |
require(!protocolPaused, "protocol is paused"); | |
_; | |
} | |
modifier onlyAdmin() { | |
require(msg.sender == admin, "only admin can"); | |
_; | |
} | |
modifier onlyListedMarket(VToken vToken) { | |
require(markets[address(vToken)].isListed, "venus market is not listed"); | |
_; | |
} | |
modifier validPauseState(bool state) { | |
require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can"); | |
require(msg.sender == admin || state == true, "only admin can unpause"); | |
_; | |
} | |
/*** 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 (VToken[] memory) { | |
return accountAssets[account]; | |
} | |
/** | |
* @notice Returns whether the given account is entered in the given asset | |
* @param account The address of the account to check | |
* @param vToken The vToken to check | |
* @return True if the account is in the asset, otherwise false. | |
*/ | |
function checkMembership(address account, VToken vToken) external view returns (bool) { | |
return markets[address(vToken)].accountMembership[account]; | |
} | |
/** | |
* @notice Add assets to be included in account liquidity calculation | |
* @param vTokens The list of addresses of the vToken markets to be enabled | |
* @return Success indicator for whether each corresponding market was entered | |
*/ | |
function enterMarkets(address[] calldata vTokens) external returns (uint[] memory) { | |
uint len = vTokens.length; | |
uint[] memory results = new uint[](len); | |
for (uint i = 0; i < len; i++) { | |
results[i] = uint(addToMarketInternal(VToken(vTokens[i]), msg.sender)); | |
} | |
return results; | |
} | |
/** | |
* @notice Add the market to the borrower's "assets in" for liquidity calculations | |
* @param vToken The market to enter | |
* @param borrower The address of the account to modify | |
* @return Success indicator for whether the market was entered | |
*/ | |
function addToMarketInternal(VToken vToken, address borrower) internal returns (Error) { | |
Market storage marketToJoin = markets[address(vToken)]; | |
if (!marketToJoin.isListed) { | |
// market is not listed, cannot join | |
return Error.MARKET_NOT_LISTED; | |
} | |
if (marketToJoin.accountMembership[borrower]) { | |
// 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(vToken); | |
emit MarketEntered(vToken, 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 necessary collateral for an outstanding borrow. | |
* @param vTokenAddress The address of the asset to be removed | |
* @return Whether or not the account successfully exited the market | |
*/ | |
function exitMarket(address vTokenAddress) external returns (uint) { | |
VToken vToken = VToken(vTokenAddress); | |
/* Get sender tokensHeld and amountOwed underlying from the vToken */ | |
(uint oErr, uint tokensHeld, uint amountOwed, ) = vToken.getAccountSnapshot(msg.sender); | |
require(oErr == 0, "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(vTokenAddress, msg.sender, tokensHeld); | |
if (allowed != 0) { | |
return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); | |
} | |
Market storage marketToExit = markets[address(vToken)]; | |
/* Return true if the sender is not already ‘in’ the market */ | |
if (!marketToExit.accountMembership[msg.sender]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Set vToken account membership to false */ | |
delete marketToExit.accountMembership[msg.sender]; | |
/* Delete vToken from the account’s list of assets */ | |
// In order to delete vToken, copy last item in list to location of item to be removed, reduce length by 1 | |
VToken[] storage userAssetList = accountAssets[msg.sender]; | |
uint len = userAssetList.length; | |
uint i; | |
for (; i < len; i++) { | |
if (userAssetList[i] == vToken) { | |
userAssetList[i] = userAssetList[len - 1]; | |
userAssetList.length--; | |
break; | |
} | |
} | |
// We *must* have found the asset in the list or our redundant data structure is broken | |
assert(i < len); | |
emit MarketExited(vToken, 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 vToken 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 vToken, address minter, uint mintAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintGuardianPaused[vToken], "mint is paused"); | |
// Shh - currently unused | |
mintAmount; | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, minter, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates mint and reverts on rejection. May emit logs. | |
* @param vToken Asset being minted | |
* @param minter The address minting the tokens | |
* @param actualMintAmount The amount of the underlying asset being minted | |
* @param mintTokens The number of tokens being minted | |
*/ | |
function mintVerify(address vToken, address minter, uint actualMintAmount, uint mintTokens) external { | |
// Shh - currently unused | |
vToken; | |
minter; | |
actualMintAmount; | |
mintTokens; | |
} | |
/** | |
* @notice Checks if the account should be allowed to redeem tokens in the given market | |
* @param vToken The market to verify the redeem against | |
* @param redeemer The account which would redeem the tokens | |
* @param redeemTokens The number of vTokens 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 vToken, address redeemer, uint redeemTokens) external onlyProtocolAllowed returns (uint) { | |
uint allowed = redeemAllowedInternal(vToken, redeemer, redeemTokens); | |
if (allowed != uint(Error.NO_ERROR)) { | |
return allowed; | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, redeemer, false); | |
return uint(Error.NO_ERROR); | |
} | |
function redeemAllowedInternal(address vToken, address redeemer, uint redeemTokens) internal view returns (uint) { | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
/* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ | |
if (!markets[vToken].accountMembership[redeemer]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, VToken(vToken), 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 vToken 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 vToken, address redeemer, uint redeemAmount, uint redeemTokens) external { | |
// Shh - currently unused | |
vToken; | |
redeemer; | |
// Require tokens is zero or amount is also zero | |
require(redeemTokens != 0 || redeemAmount == 0, "redeemTokens zero"); | |
} | |
/** | |
* @notice Checks if the account should be allowed to borrow the underlying asset of the given market | |
* @param vToken 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 vToken, address borrower, uint borrowAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!borrowGuardianPaused[vToken], "borrow is paused"); | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
if (!markets[vToken].accountMembership[borrower]) { | |
// only vTokens may call borrowAllowed if borrower not in market | |
require(msg.sender == vToken, "sender must be vToken"); | |
// attempt to add borrower to the market | |
Error err = addToMarketInternal(VToken(vToken), borrower); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
} | |
if (oracle.getUnderlyingPrice(VToken(vToken)) == 0) { | |
return uint(Error.PRICE_ERROR); | |
} | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, VToken(vToken), 0, borrowAmount); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
if (shortfall != 0) { | |
return uint(Error.INSUFFICIENT_LIQUIDITY); | |
} | |
// Keep the flywheel moving | |
Exp memory borrowIndex = Exp({mantissa: VToken(vToken).borrowIndex()}); | |
updateVenusBorrowIndex(vToken, borrowIndex); | |
distributeBorrowerVenus(vToken, borrower, borrowIndex, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates borrow and reverts on rejection. May emit logs. | |
* @param vToken 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 vToken, address borrower, uint borrowAmount) external { | |
// Shh - currently unused | |
vToken; | |
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 vToken The market to verify the repay against | |
* @param payer The account which would repay the asset | |
* @param borrower The account which would repay 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 vToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external onlyProtocolAllowed returns (uint) { | |
// Shh - currently unused | |
payer; | |
borrower; | |
repayAmount; | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// Keep the flywheel moving | |
Exp memory borrowIndex = Exp({mantissa: VToken(vToken).borrowIndex()}); | |
updateVenusBorrowIndex(vToken, borrowIndex); | |
distributeBorrowerVenus(vToken, borrower, borrowIndex, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates repayBorrow and reverts on rejection. May emit logs. | |
* @param vToken Asset being repaid | |
* @param payer The address repaying the borrow | |
* @param borrower The address of the borrower | |
* @param actualRepayAmount The amount of underlying being repaid | |
*/ | |
function repayBorrowVerify( | |
address vToken, | |
address payer, | |
address borrower, | |
uint actualRepayAmount, | |
uint borrowerIndex) external { | |
// Shh - currently unused | |
vToken; | |
payer; | |
borrower; | |
actualRepayAmount; | |
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 vTokenBorrowed Asset which was borrowed by the borrower | |
* @param vTokenCollateral 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 vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external onlyProtocolAllowed returns (uint) { | |
// Shh - currently unused | |
liquidator; | |
if (!markets[vTokenBorrowed].isListed || !markets[vTokenCollateral].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
/* The borrower must have shortfall in order to be liquidatable */ | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, VToken(0), 0, 0); | |
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 = VToken(vTokenBorrowed).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 vTokenBorrowed Asset which was borrowed by the borrower | |
* @param vTokenCollateral 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 actualRepayAmount The amount of underlying being repaid | |
*/ | |
function liquidateBorrowVerify( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint actualRepayAmount, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
vTokenBorrowed; | |
vTokenCollateral; | |
liquidator; | |
borrower; | |
actualRepayAmount; | |
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 vTokenCollateral Asset which was used as collateral and will be seized | |
* @param vTokenBorrowed 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 vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!seizeGuardianPaused, "seize is paused"); | |
// Shh - currently unused | |
seizeTokens; | |
if (!markets[vTokenCollateral].isListed || !markets[vTokenBorrowed].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
if (VToken(vTokenCollateral).comptroller() != VToken(vTokenBorrowed).comptroller()) { | |
return uint(Error.COMPTROLLER_MISMATCH); | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vTokenCollateral); | |
distributeSupplierVenus(vTokenCollateral, borrower, false); | |
distributeSupplierVenus(vTokenCollateral, liquidator, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates seize and reverts on rejection. May emit logs. | |
* @param vTokenCollateral Asset which was used as collateral and will be seized | |
* @param vTokenBorrowed 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 vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
vTokenCollateral; | |
vTokenBorrowed; | |
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 vToken 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 vTokens to transfer | |
* @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function transferAllowed(address vToken, address src, address dst, uint transferTokens) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!transferGuardianPaused, "transfer is paused"); | |
// Currently the only consideration is whether or not | |
// the src is allowed to redeem this many tokens | |
uint allowed = redeemAllowedInternal(vToken, src, transferTokens); | |
if (allowed != uint(Error.NO_ERROR)) { | |
return allowed; | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, src, false); | |
distributeSupplierVenus(vToken, dst, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates transfer and reverts on rejection. May emit logs. | |
* @param vToken Asset being transferred | |
* @param src The account which sources the tokens | |
* @param dst The account which receives the tokens | |
* @param transferTokens The number of vTokens to transfer | |
*/ | |
function transferVerify(address vToken, address src, address dst, uint transferTokens) external { | |
// Shh - currently unused | |
vToken; | |
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 `vTokenBalance` is the number of vTokens 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 vTokenBalance; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
uint oraclePriceMantissa; | |
Exp collateralFactor; | |
Exp exchangeRate; | |
Exp oraclePrice; | |
Exp tokensToDenom; | |
} | |
/** | |
* @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, VToken(0), 0, 0); | |
return (uint(err), liquidity, shortfall); | |
} | |
/** | |
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed | |
* @param vTokenModify 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 | |
* @return (possible error code (semi-opaque), | |
hypothetical account liquidity in excess of collateral requirements, | |
* hypothetical account shortfall below collateral requirements) | |
*/ | |
function getHypotheticalAccountLiquidity( | |
address account, | |
address vTokenModify, | |
uint redeemTokens, | |
uint borrowAmount) public view returns (uint, uint, uint) { | |
(Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, VToken(vTokenModify), redeemTokens, borrowAmount); | |
return (uint(err), liquidity, shortfall); | |
} | |
/** | |
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed | |
* @param vTokenModify 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 vToken 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, | |
VToken vTokenModify, | |
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 | |
VToken[] memory assets = accountAssets[account]; | |
for (uint i = 0; i < assets.length; i++) { | |
VToken asset = assets[i]; | |
// Read the balances and exchange rate from the vToken | |
(oErr, vars.vTokenBalance, 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 -> bnb (normalized price value) | |
(mErr, vars.tokensToDenom) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
// sumCollateral += tokensToDenom * vTokenBalance | |
(mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToDenom, vars.vTokenBalance, 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 vTokenModify | |
if (asset == vTokenModify) { | |
// redeem effect | |
// sumBorrowPlusEffects += tokensToDenom * redeemTokens | |
(mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToDenom, 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); | |
} | |
} | |
} | |
/// @dev VAI Integration^ | |
(mErr, vars.sumBorrowPlusEffects) = addUInt(vars.sumBorrowPlusEffects, mintedVAIs[account]); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
/// @dev VAI Integration$ | |
// 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 vToken.liquidateBorrowFresh) | |
* @param vTokenBorrowed The address of the borrowed vToken | |
* @param vTokenCollateral The address of the collateral vToken | |
* @param actualRepayAmount The amount of vTokenBorrowed underlying to convert into vTokenCollateral tokens | |
* @return (errorCode, number of vTokenCollateral tokens to be seized in a liquidation) | |
*/ | |
function liquidateCalculateSeizeTokens(address vTokenBorrowed, address vTokenCollateral, uint actualRepayAmount) external view returns (uint, uint) { | |
/* Read oracle prices for borrowed and collateral markets */ | |
uint priceBorrowedMantissa = oracle.getUnderlyingPrice(VToken(vTokenBorrowed)); | |
uint priceCollateralMantissa = oracle.getUnderlyingPrice(VToken(vTokenCollateral)); | |
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 = actualRepayAmount * liquidationIncentive * priceBorrowed / priceCollateral | |
* seizeTokens = seizeAmount / exchangeRate | |
* = actualRepayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) | |
*/ | |
uint exchangeRateMantissa = VToken(vTokenCollateral).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, actualRepayAmount); | |
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 (uint) { | |
// 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, newCloseFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets the collateralFactor for a market | |
* @dev Admin function to set per-market collateralFactor | |
* @param vToken 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(VToken vToken, uint newCollateralFactorMantissa) external returns (uint) { | |
// 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(vToken)]; | |
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(vToken) == 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(vToken, 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 vToken The address of the market (token) to list | |
* @return uint 0=success, otherwise a failure. (See enum Error for details) | |
*/ | |
function _supportMarket(VToken vToken) external returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); | |
} | |
if (markets[address(vToken)].isListed) { | |
return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); | |
} | |
vToken.isVToken(); // Sanity check to make sure its really a VToken | |
markets[address(vToken)] = Market({isListed: true, isVenus: false, collateralFactorMantissa: 0}); | |
_addMarketInternal(vToken); | |
emit MarketListed(vToken); | |
return uint(Error.NO_ERROR); | |
} | |
function _addMarketInternal(VToken vToken) internal { | |
for (uint i = 0; i < allMarkets.length; i ++) { | |
require(allMarkets[i] != vToken, "market already added"); | |
} | |
allMarkets.push(vToken); | |
} | |
/** | |
* @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, newPauseGuardian); | |
return uint(Error.NO_ERROR); | |
} | |
function _setMintPaused(VToken vToken, bool state) public onlyListedMarket(vToken) validPauseState(state) returns (bool) { | |
mintGuardianPaused[address(vToken)] = state; | |
emit ActionPaused(vToken, "Mint", state); | |
return state; | |
} | |
function _setBorrowPaused(VToken vToken, bool state) public onlyListedMarket(vToken) validPauseState(state) returns (bool) { | |
borrowGuardianPaused[address(vToken)] = state; | |
emit ActionPaused(vToken, "Borrow", state); | |
return state; | |
} | |
function _setTransferPaused(bool state) public validPauseState(state) returns (bool) { | |
transferGuardianPaused = state; | |
emit ActionPaused("Transfer", state); | |
return state; | |
} | |
function _setSeizePaused(bool state) public validPauseState(state) returns (bool) { | |
seizeGuardianPaused = state; | |
emit ActionPaused("Seize", state); | |
return state; | |
} | |
function _setMintVAIPaused(bool state) public validPauseState(state) returns (bool) { | |
mintVAIGuardianPaused = state; | |
emit ActionPaused("MintVAI", state); | |
return state; | |
} | |
function _setRepayVAIPaused(bool state) public validPauseState(state) returns (bool) { | |
repayVAIGuardianPaused = state; | |
emit ActionPaused("RepayVAI", state); | |
return state; | |
} | |
/** | |
* @notice Set whole protocol pause/unpause state | |
*/ | |
function _setProtocolPaused(bool state) public onlyAdmin returns(bool) { | |
protocolPaused = state; | |
emit ActionProtocolPaused(state); | |
return state; | |
} | |
/** | |
* @notice Sets a new VAI controller | |
* @dev Admin function to set a new VAI controller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setVAIController(VAIControllerInterface vaiController_) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_VAICONTROLLER_OWNER_CHECK); | |
} | |
VAIControllerInterface oldRate = vaiController; | |
vaiController = vaiController_; | |
emit NewVAIController(oldRate, vaiController_); | |
} | |
function _setVAIMintRate(uint newVAIMintRate) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_VAI_MINT_RATE_CHECK); | |
} | |
uint oldVAIMintRate = vaiMintRate; | |
vaiMintRate = newVAIMintRate; | |
emit NewVAIMintRate(oldVAIMintRate, newVAIMintRate); | |
return uint(Error.NO_ERROR); | |
} | |
function _become(Unitroller unitroller) public { | |
require(msg.sender == unitroller.admin(), "only unitroller admin can"); | |
require(unitroller._acceptImplementation() == 0, "not authorized"); | |
} | |
/*** Venus Distribution ***/ | |
/** | |
* @notice Recalculate and update Venus speeds for all Venus markets | |
*/ | |
function refreshVenusSpeeds() public { | |
require(msg.sender == tx.origin, "only externally owned accounts can"); | |
refreshVenusSpeedsInternal(); | |
} | |
function refreshVenusSpeedsInternal() internal { | |
uint i; | |
VToken vToken; | |
for (i = 0; i < allMarkets.length; i++) { | |
vToken = allMarkets[i]; | |
Exp memory borrowIndex = Exp({mantissa: vToken.borrowIndex()}); | |
updateVenusSupplyIndex(address(vToken)); | |
updateVenusBorrowIndex(address(vToken), borrowIndex); | |
} | |
Exp memory totalUtility = Exp({mantissa: 0}); | |
Exp[] memory utilities = new Exp[](allMarkets.length); | |
for (i = 0; i < allMarkets.length; i++) { | |
vToken = allMarkets[i]; | |
if (markets[address(vToken)].isVenus) { | |
Exp memory assetPrice = Exp({mantissa: oracle.getUnderlyingPrice(vToken)}); | |
Exp memory utility = mul_(assetPrice, vToken.totalBorrows()); | |
utilities[i] = utility; | |
totalUtility = add_(totalUtility, utility); | |
} | |
} | |
for (i = 0; i < allMarkets.length; i++) { | |
vToken = allMarkets[i]; | |
uint newSpeed = totalUtility.mantissa > 0 ? mul_(venusRate, div_(utilities[i], totalUtility)) : 0; | |
venusSpeeds[address(vToken)] = newSpeed; | |
emit VenusSpeedUpdated(vToken, newSpeed); | |
} | |
} | |
/** | |
* @notice Accrue XVS to the market by updating the supply index | |
* @param vToken The market whose supply index to update | |
*/ | |
function updateVenusSupplyIndex(address vToken) internal { | |
VenusMarketState storage supplyState = venusSupplyState[vToken]; | |
uint supplySpeed = venusSpeeds[vToken]; | |
uint blockNumber = getBlockNumber(); | |
uint deltaBlocks = sub_(blockNumber, uint(supplyState.block)); | |
if (deltaBlocks > 0 && supplySpeed > 0) { | |
uint supplyTokens = VToken(vToken).totalSupply(); | |
uint venusAccrued = mul_(deltaBlocks, supplySpeed); | |
Double memory ratio = supplyTokens > 0 ? fraction(venusAccrued, supplyTokens) : Double({mantissa: 0}); | |
Double memory index = add_(Double({mantissa: supplyState.index}), ratio); | |
venusSupplyState[vToken] = VenusMarketState({ | |
index: safe224(index.mantissa, "new index overflows"), | |
block: safe32(blockNumber, "block number overflows") | |
}); | |
} else if (deltaBlocks > 0) { | |
supplyState.block = safe32(blockNumber, "block number overflows"); | |
} | |
} | |
/** | |
* @notice Accrue XVS to the market by updating the borrow index | |
* @param vToken The market whose borrow index to update | |
*/ | |
function updateVenusBorrowIndex(address vToken, Exp memory marketBorrowIndex) internal { | |
VenusMarketState storage borrowState = venusBorrowState[vToken]; | |
uint borrowSpeed = venusSpeeds[vToken]; | |
uint blockNumber = getBlockNumber(); | |
uint deltaBlocks = sub_(blockNumber, uint(borrowState.block)); | |
if (deltaBlocks > 0 && borrowSpeed > 0) { | |
uint borrowAmount = div_(VToken(vToken).totalBorrows(), marketBorrowIndex); | |
uint venusAccrued = mul_(deltaBlocks, borrowSpeed); | |
Double memory ratio = borrowAmount > 0 ? fraction(venusAccrued, borrowAmount) : Double({mantissa: 0}); | |
Double memory index = add_(Double({mantissa: borrowState.index}), ratio); | |
venusBorrowState[vToken] = VenusMarketState({ | |
index: safe224(index.mantissa, "new index overflows"), | |
block: safe32(blockNumber, "block number overflows") | |
}); | |
} else if (deltaBlocks > 0) { | |
borrowState.block = safe32(blockNumber, "block number overflows"); | |
} | |
} | |
/** | |
* @notice Accrue XVS to by updating the VAI minter index | |
*/ | |
function updateVenusVAIMintIndex() internal { | |
if (address(vaiController) != address(0)) { | |
vaiController.updateVenusVAIMintIndex(); | |
} | |
} | |
/** | |
* @notice Calculate XVS accrued by a supplier and possibly transfer it to them | |
* @param vToken The market in which the supplier is interacting | |
* @param supplier The address of the supplier to distribute XVS to | |
*/ | |
function distributeSupplierVenus(address vToken, address supplier, bool distributeAll) internal { | |
VenusMarketState storage supplyState = venusSupplyState[vToken]; | |
Double memory supplyIndex = Double({mantissa: supplyState.index}); | |
Double memory supplierIndex = Double({mantissa: venusSupplierIndex[vToken][supplier]}); | |
venusSupplierIndex[vToken][supplier] = supplyIndex.mantissa; | |
if (supplierIndex.mantissa == 0 && supplyIndex.mantissa > 0) { | |
supplierIndex.mantissa = venusInitialIndex; | |
} | |
Double memory deltaIndex = sub_(supplyIndex, supplierIndex); | |
uint supplierTokens = VToken(vToken).balanceOf(supplier); | |
uint supplierDelta = mul_(supplierTokens, deltaIndex); | |
uint supplierAccrued = add_(venusAccrued[supplier], supplierDelta); | |
venusAccrued[supplier] = transferXVS(supplier, supplierAccrued, distributeAll ? 0 : venusClaimThreshold); | |
emit DistributedSupplierVenus(VToken(vToken), supplier, supplierDelta, supplyIndex.mantissa); | |
} | |
/** | |
* @notice Calculate XVS accrued by a borrower and possibly transfer it to them | |
* @dev Borrowers will not begin to accrue until after the first interaction with the protocol. | |
* @param vToken The market in which the borrower is interacting | |
* @param borrower The address of the borrower to distribute XVS to | |
*/ | |
function distributeBorrowerVenus(address vToken, address borrower, Exp memory marketBorrowIndex, bool distributeAll) internal { | |
VenusMarketState storage borrowState = venusBorrowState[vToken]; | |
Double memory borrowIndex = Double({mantissa: borrowState.index}); | |
Double memory borrowerIndex = Double({mantissa: venusBorrowerIndex[vToken][borrower]}); | |
venusBorrowerIndex[vToken][borrower] = borrowIndex.mantissa; | |
if (borrowerIndex.mantissa > 0) { | |
Double memory deltaIndex = sub_(borrowIndex, borrowerIndex); | |
uint borrowerAmount = div_(VToken(vToken).borrowBalanceStored(borrower), marketBorrowIndex); | |
uint borrowerDelta = mul_(borrowerAmount, deltaIndex); | |
uint borrowerAccrued = add_(venusAccrued[borrower], borrowerDelta); | |
venusAccrued[borrower] = transferXVS(borrower, borrowerAccrued, distributeAll ? 0 : venusClaimThreshold); | |
emit DistributedBorrowerVenus(VToken(vToken), borrower, borrowerDelta, borrowIndex.mantissa); | |
} | |
} | |
/** | |
* @notice Calculate XVS accrued by a VAI minter and possibly transfer it to them | |
* @dev VAI minters will not begin to accrue until after the first interaction with the protocol. | |
* @param vaiMinter The address of the VAI minter to distribute XVS to | |
*/ | |
function distributeVAIMinterVenus(address vaiMinter, bool distributeAll) internal { | |
if (address(vaiController) != address(0)) { | |
uint vaiMinterAccrued; | |
uint vaiMinterDelta; | |
uint vaiMintIndexMantissa; | |
uint err; | |
(err, vaiMinterAccrued, vaiMinterDelta, vaiMintIndexMantissa) = vaiController.calcDistributeVAIMinterVenus(vaiMinter); | |
if (err == uint(Error.NO_ERROR)) { | |
venusAccrued[vaiMinter] = transferXVS(vaiMinter, vaiMinterAccrued, distributeAll ? 0 : venusClaimThreshold); | |
emit DistributedVAIMinterVenus(vaiMinter, vaiMinterDelta, vaiMintIndexMantissa); | |
} | |
} | |
} | |
/** | |
* @notice Transfer XVS to the user, if they are above the threshold | |
* @dev Note: If there is not enough XVS, we do not perform the transfer all. | |
* @param user The address of the user to transfer XVS to | |
* @param userAccrued The amount of XVS to (possibly) transfer | |
* @return The amount of XVS which was NOT transferred to the user | |
*/ | |
function transferXVS(address user, uint userAccrued, uint threshold) internal returns (uint) { | |
if (userAccrued >= threshold && userAccrued > 0) { | |
XVS xvs = XVS(getXVSAddress()); | |
uint xvsRemaining = xvs.balanceOf(address(this)); | |
if (userAccrued <= xvsRemaining) { | |
xvs.transfer(user, userAccrued); | |
return 0; | |
} | |
} | |
return userAccrued; | |
} | |
/** | |
* @notice Claim all the xvs accrued by holder in all markets and VAI | |
* @param holder The address to claim XVS for | |
*/ | |
function claimVenus(address holder) public { | |
return claimVenus(holder, allMarkets); | |
} | |
/** | |
* @notice Claim all the xvs accrued by holder in the specified markets | |
* @param holder The address to claim XVS for | |
* @param vTokens The list of markets to claim XVS in | |
*/ | |
function claimVenus(address holder, VToken[] memory vTokens) public { | |
address[] memory holders = new address[](1); | |
holders[0] = holder; | |
claimVenus(holders, vTokens, true, true); | |
} | |
/** | |
* @notice Claim all xvs accrued by the holders | |
* @param holders The addresses to claim XVS for | |
* @param vTokens The list of markets to claim XVS in | |
* @param borrowers Whether or not to claim XVS earned by borrowing | |
* @param suppliers Whether or not to claim XVS earned by supplying | |
*/ | |
function claimVenus(address[] memory holders, VToken[] memory vTokens, bool borrowers, bool suppliers) public { | |
uint j; | |
updateVenusVAIMintIndex(); | |
for (j = 0; j < holders.length; j++) { | |
distributeVAIMinterVenus(holders[j], true); | |
} | |
for (uint i = 0; i < vTokens.length; i++) { | |
VToken vToken = vTokens[i]; | |
require(markets[address(vToken)].isListed, "not listed market"); | |
if (borrowers) { | |
Exp memory borrowIndex = Exp({mantissa: vToken.borrowIndex()}); | |
updateVenusBorrowIndex(address(vToken), borrowIndex); | |
for (j = 0; j < holders.length; j++) { | |
distributeBorrowerVenus(address(vToken), holders[j], borrowIndex, true); | |
} | |
} | |
if (suppliers) { | |
updateVenusSupplyIndex(address(vToken)); | |
for (j = 0; j < holders.length; j++) { | |
distributeSupplierVenus(address(vToken), holders[j], true); | |
} | |
} | |
} | |
} | |
/*** Venus Distribution Admin ***/ | |
/** | |
* @notice Set the amount of XVS distributed per block | |
* @param venusRate_ The amount of XVS wei per block to distribute | |
*/ | |
function _setVenusRate(uint venusRate_) public onlyAdmin { | |
uint oldRate = venusRate; | |
venusRate = venusRate_; | |
emit NewVenusRate(oldRate, venusRate_); | |
refreshVenusSpeedsInternal(); | |
} | |
/** | |
* @notice Set the amount of XVS distributed per block to VAI Mint | |
* @param venusVAIRate_ The amount of XVS wei per block to distribute to VAI Mint | |
*/ | |
function _setVenusVAIRate(uint venusVAIRate_) public { | |
require(msg.sender == admin, "only admin can"); | |
uint oldVAIRate = venusVAIRate; | |
venusVAIRate = venusVAIRate_; | |
emit NewVenusVAIRate(oldVAIRate, venusVAIRate_); | |
} | |
/** | |
* @notice Add markets to venusMarkets, allowing them to earn XVS in the flywheel | |
* @param vTokens The addresses of the markets to add | |
*/ | |
function _addVenusMarkets(address[] calldata vTokens) external onlyAdmin { | |
for (uint i = 0; i < vTokens.length; i++) { | |
_addVenusMarketInternal(vTokens[i]); | |
} | |
refreshVenusSpeedsInternal(); | |
} | |
function _addVenusMarketInternal(address vToken) internal { | |
Market storage market = markets[vToken]; | |
require(market.isListed, "venus market is not listed"); | |
require(!market.isVenus, "venus market already added"); | |
market.isVenus = true; | |
emit MarketVenus(VToken(vToken), true); | |
if (venusSupplyState[vToken].index == 0 && venusSupplyState[vToken].block == 0) { | |
venusSupplyState[vToken] = VenusMarketState({ | |
index: venusInitialIndex, | |
block: safe32(getBlockNumber(), "block number overflows") | |
}); | |
} | |
if (venusBorrowState[vToken].index == 0 && venusBorrowState[vToken].block == 0) { | |
venusBorrowState[vToken] = VenusMarketState({ | |
index: venusInitialIndex, | |
block: safe32(getBlockNumber(), "block number overflows") | |
}); | |
} | |
} | |
function _initializeVenusVAIState(uint blockNumber) public { | |
require(msg.sender == admin, "only admin can"); | |
if (address(vaiController) != address(0)) { | |
vaiController._initializeVenusVAIState(blockNumber); | |
} | |
} | |
/** | |
* @notice Remove a market from venusMarkets, preventing it from earning XVS in the flywheel | |
* @param vToken The address of the market to drop | |
*/ | |
function _dropVenusMarket(address vToken) public onlyAdmin { | |
Market storage market = markets[vToken]; | |
require(market.isVenus == true, "not venus market"); | |
market.isVenus = false; | |
emit MarketVenus(VToken(vToken), false); | |
refreshVenusSpeedsInternal(); | |
} | |
/** | |
* @notice Return all of the markets | |
* @dev The automatic getter may be used to access an individual market. | |
* @return The list of market addresses | |
*/ | |
function getAllMarkets() public view returns (VToken[] memory) { | |
return allMarkets; | |
} | |
function getBlockNumber() public view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Return the address of the XVS token | |
* @return The address of XVS | |
*/ | |
function getXVSAddress() public view returns (address) { | |
return 0xcF6BB5389c92Bdda8a3747Ddb454cB7a64626C63; | |
} | |
/*** VAI functions ***/ | |
/** | |
* @notice Set the minted VAI amount of the `owner` | |
* @param owner The address of the account to set | |
* @param amount The amount of VAI to set to the account | |
* @return The number of minted VAI by `owner` | |
*/ | |
function setMintedVAIOf(address owner, uint amount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintVAIGuardianPaused && !repayVAIGuardianPaused, "VAI is paused"); | |
// Check caller is vaiController | |
if (msg.sender != address(vaiController)) { | |
return fail(Error.REJECTION, FailureInfo.SET_MINTED_VAI_REJECTION); | |
} | |
mintedVAIs[owner] = amount; | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Mint VAI | |
*/ | |
function mintVAI(uint mintVAIAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintVAIGuardianPaused, "mintVAI is paused"); | |
// Keep the flywheel moving | |
updateVenusVAIMintIndex(); | |
distributeVAIMinterVenus(msg.sender, false); | |
return vaiController.mintVAI(msg.sender, mintVAIAmount); | |
} | |
/** | |
* @notice Repay VAI | |
*/ | |
function repayVAI(uint repayVAIAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!repayVAIGuardianPaused, "repayVAI is paused"); | |
// Keep the flywheel moving | |
updateVenusVAIMintIndex(); | |
distributeVAIMinterVenus(msg.sender, false); | |
return vaiController.repayVAI(msg.sender, repayVAIAmount); | |
} | |
/** | |
* @notice Get the minted VAI amount of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of minted VAI by `owner` | |
*/ | |
function mintedVAIOf(address owner) external view returns (uint) { | |
return mintedVAIs[owner]; | |
} | |
/** | |
* @notice Get Mintable VAI amount | |
*/ | |
function getMintableVAI(address minter) external view returns (uint, uint) { | |
return vaiController.getMintableVAI(minter); | |
} | |
} |
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 "./VToken.sol"; | |
import "./ErrorReporter.sol"; | |
import "./Exponential.sol"; | |
import "./PriceOracle.sol"; | |
import "./ComptrollerInterface.sol"; | |
import "./ComptrollerStorage.sol"; | |
import "./Unitroller.sol"; | |
import "./XVS.sol"; | |
import "./VAI.sol"; | |
/** | |
* @title Venus's Comptroller Contract | |
* @author Venus | |
*/ | |
contract ComptrollerG2 is ComptrollerV1Storage, ComptrollerInterface, ComptrollerErrorReporter, Exponential { | |
/// @notice Emitted when an admin supports a market | |
event MarketListed(VToken vToken); | |
/// @notice Emitted when an account enters a market | |
event MarketEntered(VToken vToken, address account); | |
/// @notice Emitted when an account exits a market | |
event MarketExited(VToken vToken, 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(VToken vToken, 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 globally | |
event ActionPaused(string action, bool pauseState); | |
/// @notice Emitted when an action is paused on a market | |
event ActionPaused(VToken vToken, string action, bool pauseState); | |
/// @notice Emitted when market venus status is changed | |
event MarketVenus(VToken vToken, bool isVenus); | |
/// @notice Emitted when Venus rate is changed | |
event NewVenusRate(uint oldVenusRate, uint newVenusRate); | |
/// @notice Emitted when Venus VAI rate is changed | |
event NewVenusVAIRate(uint oldVenusVAIRate, uint newVenusVAIRate); | |
/// @notice Emitted when a new Venus speed is calculated for a market | |
event VenusSpeedUpdated(VToken indexed vToken, uint newSpeed); | |
/// @notice Emitted when XVS is distributed to a supplier | |
event DistributedSupplierVenus(VToken indexed vToken, address indexed supplier, uint venusDelta, uint venusSupplyIndex); | |
/// @notice Emitted when XVS is distributed to a borrower | |
event DistributedBorrowerVenus(VToken indexed vToken, address indexed borrower, uint venusDelta, uint venusBorrowIndex); | |
/// @notice Emitted when XVS is distributed to a VAI minter | |
event DistributedVAIMinterVenus(address indexed vaiMinter, uint venusDelta, uint venusVAIMintIndex); | |
/// @notice Emitted when VAIController is changed | |
event NewVAIController(VAIControllerInterface oldVAIController, VAIControllerInterface newVAIController); | |
/// @notice Emitted when VAI mint rate is changed by admin | |
event NewVAIMintRate(uint oldVAIMintRate, uint newVAIMintRate); | |
/// @notice Emitted when protocol state is changed by admin | |
event ActionProtocolPaused(bool state); | |
/// @notice The threshold above which the flywheel transfers XVS, in wei | |
uint public constant venusClaimThreshold = 0.001e18; | |
/// @notice The initial Venus index for a market | |
uint224 public constant venusInitialIndex = 1e36; | |
// 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; | |
} | |
modifier onlyProtocolAllowed { | |
require(!protocolPaused, "protocol is paused"); | |
_; | |
} | |
modifier onlyAdmin() { | |
require(msg.sender == admin, "only admin can"); | |
_; | |
} | |
modifier onlyListedMarket(VToken vToken) { | |
require(markets[address(vToken)].isListed, "venus market is not listed"); | |
_; | |
} | |
modifier validPauseState(bool state) { | |
require(msg.sender == pauseGuardian || msg.sender == admin, "only pause guardian and admin can"); | |
require(msg.sender == admin || state == true, "only admin can unpause"); | |
_; | |
} | |
/*** 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 (VToken[] memory) { | |
return accountAssets[account]; | |
} | |
/** | |
* @notice Returns whether the given account is entered in the given asset | |
* @param account The address of the account to check | |
* @param vToken The vToken to check | |
* @return True if the account is in the asset, otherwise false. | |
*/ | |
function checkMembership(address account, VToken vToken) external view returns (bool) { | |
return markets[address(vToken)].accountMembership[account]; | |
} | |
/** | |
* @notice Add assets to be included in account liquidity calculation | |
* @param vTokens The list of addresses of the vToken markets to be enabled | |
* @return Success indicator for whether each corresponding market was entered | |
*/ | |
function enterMarkets(address[] calldata vTokens) external returns (uint[] memory) { | |
uint len = vTokens.length; | |
uint[] memory results = new uint[](len); | |
for (uint i = 0; i < len; i++) { | |
results[i] = uint(addToMarketInternal(VToken(vTokens[i]), msg.sender)); | |
} | |
return results; | |
} | |
/** | |
* @notice Add the market to the borrower's "assets in" for liquidity calculations | |
* @param vToken The market to enter | |
* @param borrower The address of the account to modify | |
* @return Success indicator for whether the market was entered | |
*/ | |
function addToMarketInternal(VToken vToken, address borrower) internal returns (Error) { | |
Market storage marketToJoin = markets[address(vToken)]; | |
if (!marketToJoin.isListed) { | |
// market is not listed, cannot join | |
return Error.MARKET_NOT_LISTED; | |
} | |
if (marketToJoin.accountMembership[borrower]) { | |
// 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(vToken); | |
emit MarketEntered(vToken, 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 necessary collateral for an outstanding borrow. | |
* @param vTokenAddress The address of the asset to be removed | |
* @return Whether or not the account successfully exited the market | |
*/ | |
function exitMarket(address vTokenAddress) external returns (uint) { | |
VToken vToken = VToken(vTokenAddress); | |
/* Get sender tokensHeld and amountOwed underlying from the vToken */ | |
(uint oErr, uint tokensHeld, uint amountOwed, ) = vToken.getAccountSnapshot(msg.sender); | |
require(oErr == 0, "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(vTokenAddress, msg.sender, tokensHeld); | |
if (allowed != 0) { | |
return failOpaque(Error.REJECTION, FailureInfo.EXIT_MARKET_REJECTION, allowed); | |
} | |
Market storage marketToExit = markets[address(vToken)]; | |
/* Return true if the sender is not already ‘in’ the market */ | |
if (!marketToExit.accountMembership[msg.sender]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Set vToken account membership to false */ | |
delete marketToExit.accountMembership[msg.sender]; | |
/* Delete vToken from the account’s list of assets */ | |
// In order to delete vToken, copy last item in list to location of item to be removed, reduce length by 1 | |
VToken[] storage userAssetList = accountAssets[msg.sender]; | |
uint len = userAssetList.length; | |
uint i; | |
for (; i < len; i++) { | |
if (userAssetList[i] == vToken) { | |
userAssetList[i] = userAssetList[len - 1]; | |
userAssetList.length--; | |
break; | |
} | |
} | |
// We *must* have found the asset in the list or our redundant data structure is broken | |
assert(i < len); | |
emit MarketExited(vToken, 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 vToken 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 vToken, address minter, uint mintAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintGuardianPaused[vToken], "mint is paused"); | |
// Shh - currently unused | |
mintAmount; | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, minter, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates mint and reverts on rejection. May emit logs. | |
* @param vToken Asset being minted | |
* @param minter The address minting the tokens | |
* @param actualMintAmount The amount of the underlying asset being minted | |
* @param mintTokens The number of tokens being minted | |
*/ | |
function mintVerify(address vToken, address minter, uint actualMintAmount, uint mintTokens) external { | |
// Shh - currently unused | |
vToken; | |
minter; | |
actualMintAmount; | |
mintTokens; | |
} | |
/** | |
* @notice Checks if the account should be allowed to redeem tokens in the given market | |
* @param vToken The market to verify the redeem against | |
* @param redeemer The account which would redeem the tokens | |
* @param redeemTokens The number of vTokens 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 vToken, address redeemer, uint redeemTokens) external onlyProtocolAllowed returns (uint) { | |
uint allowed = redeemAllowedInternal(vToken, redeemer, redeemTokens); | |
if (allowed != uint(Error.NO_ERROR)) { | |
return allowed; | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, redeemer, false); | |
return uint(Error.NO_ERROR); | |
} | |
function redeemAllowedInternal(address vToken, address redeemer, uint redeemTokens) internal view returns (uint) { | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
/* If the redeemer is not 'in' the market, then we can bypass the liquidity check */ | |
if (!markets[vToken].accountMembership[redeemer]) { | |
return uint(Error.NO_ERROR); | |
} | |
/* Otherwise, perform a hypothetical liquidity check to guard against shortfall */ | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(redeemer, VToken(vToken), 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 vToken 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 vToken, address redeemer, uint redeemAmount, uint redeemTokens) external { | |
// Shh - currently unused | |
vToken; | |
redeemer; | |
// Require tokens is zero or amount is also zero | |
require(redeemTokens != 0 || redeemAmount == 0, "redeemTokens zero"); | |
} | |
/** | |
* @notice Checks if the account should be allowed to borrow the underlying asset of the given market | |
* @param vToken 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 vToken, address borrower, uint borrowAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!borrowGuardianPaused[vToken], "borrow is paused"); | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
if (!markets[vToken].accountMembership[borrower]) { | |
// only vTokens may call borrowAllowed if borrower not in market | |
require(msg.sender == vToken, "sender must be vToken"); | |
// attempt to add borrower to the market | |
Error err = addToMarketInternal(VToken(vToken), borrower); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
} | |
if (oracle.getUnderlyingPrice(VToken(vToken)) == 0) { | |
return uint(Error.PRICE_ERROR); | |
} | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, VToken(vToken), 0, borrowAmount); | |
if (err != Error.NO_ERROR) { | |
return uint(err); | |
} | |
if (shortfall != 0) { | |
return uint(Error.INSUFFICIENT_LIQUIDITY); | |
} | |
// Keep the flywheel moving | |
Exp memory borrowIndex = Exp({mantissa: VToken(vToken).borrowIndex()}); | |
updateVenusBorrowIndex(vToken, borrowIndex); | |
distributeBorrowerVenus(vToken, borrower, borrowIndex, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates borrow and reverts on rejection. May emit logs. | |
* @param vToken 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 vToken, address borrower, uint borrowAmount) external { | |
// Shh - currently unused | |
vToken; | |
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 vToken The market to verify the repay against | |
* @param payer The account which would repay the asset | |
* @param borrower The account which would repay 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 vToken, | |
address payer, | |
address borrower, | |
uint repayAmount) external onlyProtocolAllowed returns (uint) { | |
// Shh - currently unused | |
payer; | |
borrower; | |
repayAmount; | |
if (!markets[vToken].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
// Keep the flywheel moving | |
Exp memory borrowIndex = Exp({mantissa: VToken(vToken).borrowIndex()}); | |
updateVenusBorrowIndex(vToken, borrowIndex); | |
distributeBorrowerVenus(vToken, borrower, borrowIndex, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates repayBorrow and reverts on rejection. May emit logs. | |
* @param vToken Asset being repaid | |
* @param payer The address repaying the borrow | |
* @param borrower The address of the borrower | |
* @param actualRepayAmount The amount of underlying being repaid | |
*/ | |
function repayBorrowVerify( | |
address vToken, | |
address payer, | |
address borrower, | |
uint actualRepayAmount, | |
uint borrowerIndex) external { | |
// Shh - currently unused | |
vToken; | |
payer; | |
borrower; | |
actualRepayAmount; | |
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 vTokenBorrowed Asset which was borrowed by the borrower | |
* @param vTokenCollateral 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 vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint repayAmount) external onlyProtocolAllowed returns (uint) { | |
// Shh - currently unused | |
liquidator; | |
if (!markets[vTokenBorrowed].isListed || !markets[vTokenCollateral].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
/* The borrower must have shortfall in order to be liquidatable */ | |
(Error err, , uint shortfall) = getHypotheticalAccountLiquidityInternal(borrower, VToken(0), 0, 0); | |
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 = VToken(vTokenBorrowed).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 vTokenBorrowed Asset which was borrowed by the borrower | |
* @param vTokenCollateral 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 actualRepayAmount The amount of underlying being repaid | |
*/ | |
function liquidateBorrowVerify( | |
address vTokenBorrowed, | |
address vTokenCollateral, | |
address liquidator, | |
address borrower, | |
uint actualRepayAmount, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
vTokenBorrowed; | |
vTokenCollateral; | |
liquidator; | |
borrower; | |
actualRepayAmount; | |
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 vTokenCollateral Asset which was used as collateral and will be seized | |
* @param vTokenBorrowed 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 vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!seizeGuardianPaused, "seize is paused"); | |
// Shh - currently unused | |
seizeTokens; | |
if (!markets[vTokenCollateral].isListed || !markets[vTokenBorrowed].isListed) { | |
return uint(Error.MARKET_NOT_LISTED); | |
} | |
if (VToken(vTokenCollateral).comptroller() != VToken(vTokenBorrowed).comptroller()) { | |
return uint(Error.COMPTROLLER_MISMATCH); | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vTokenCollateral); | |
distributeSupplierVenus(vTokenCollateral, borrower, false); | |
distributeSupplierVenus(vTokenCollateral, liquidator, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates seize and reverts on rejection. May emit logs. | |
* @param vTokenCollateral Asset which was used as collateral and will be seized | |
* @param vTokenBorrowed 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 vTokenCollateral, | |
address vTokenBorrowed, | |
address liquidator, | |
address borrower, | |
uint seizeTokens) external { | |
// Shh - currently unused | |
vTokenCollateral; | |
vTokenBorrowed; | |
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 vToken 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 vTokens to transfer | |
* @return 0 if the transfer is allowed, otherwise a semi-opaque error code (See ErrorReporter.sol) | |
*/ | |
function transferAllowed(address vToken, address src, address dst, uint transferTokens) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!transferGuardianPaused, "transfer is paused"); | |
// Currently the only consideration is whether or not | |
// the src is allowed to redeem this many tokens | |
uint allowed = redeemAllowedInternal(vToken, src, transferTokens); | |
if (allowed != uint(Error.NO_ERROR)) { | |
return allowed; | |
} | |
// Keep the flywheel moving | |
updateVenusSupplyIndex(vToken); | |
distributeSupplierVenus(vToken, src, false); | |
distributeSupplierVenus(vToken, dst, false); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Validates transfer and reverts on rejection. May emit logs. | |
* @param vToken Asset being transferred | |
* @param src The account which sources the tokens | |
* @param dst The account which receives the tokens | |
* @param transferTokens The number of vTokens to transfer | |
*/ | |
function transferVerify(address vToken, address src, address dst, uint transferTokens) external { | |
// Shh - currently unused | |
vToken; | |
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 `vTokenBalance` is the number of vTokens 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 vTokenBalance; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
uint oraclePriceMantissa; | |
Exp collateralFactor; | |
Exp exchangeRate; | |
Exp oraclePrice; | |
Exp tokensToDenom; | |
} | |
/** | |
* @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, VToken(0), 0, 0); | |
return (uint(err), liquidity, shortfall); | |
} | |
/** | |
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed | |
* @param vTokenModify 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 | |
* @return (possible error code (semi-opaque), | |
hypothetical account liquidity in excess of collateral requirements, | |
* hypothetical account shortfall below collateral requirements) | |
*/ | |
function getHypotheticalAccountLiquidity( | |
address account, | |
address vTokenModify, | |
uint redeemTokens, | |
uint borrowAmount) public view returns (uint, uint, uint) { | |
(Error err, uint liquidity, uint shortfall) = getHypotheticalAccountLiquidityInternal(account, VToken(vTokenModify), redeemTokens, borrowAmount); | |
return (uint(err), liquidity, shortfall); | |
} | |
/** | |
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed | |
* @param vTokenModify 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 vToken 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, | |
VToken vTokenModify, | |
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 | |
VToken[] memory assets = accountAssets[account]; | |
for (uint i = 0; i < assets.length; i++) { | |
VToken asset = assets[i]; | |
// Read the balances and exchange rate from the vToken | |
(oErr, vars.vTokenBalance, 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 -> bnb (normalized price value) | |
(mErr, vars.tokensToDenom) = mulExp3(vars.collateralFactor, vars.exchangeRate, vars.oraclePrice); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
// sumCollateral += tokensToDenom * vTokenBalance | |
(mErr, vars.sumCollateral) = mulScalarTruncateAddUInt(vars.tokensToDenom, vars.vTokenBalance, 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 vTokenModify | |
if (asset == vTokenModify) { | |
// redeem effect | |
// sumBorrowPlusEffects += tokensToDenom * redeemTokens | |
(mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.tokensToDenom, 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); | |
} | |
} | |
} | |
/// @dev VAI Integration^ | |
(mErr, vars.sumBorrowPlusEffects) = addUInt(vars.sumBorrowPlusEffects, mintedVAIs[account]); | |
if (mErr != MathError.NO_ERROR) { | |
return (Error.MATH_ERROR, 0, 0); | |
} | |
/// @dev VAI Integration$ | |
// 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 vToken.liquidateBorrowFresh) | |
* @param vTokenBorrowed The address of the borrowed vToken | |
* @param vTokenCollateral The address of the collateral vToken | |
* @param actualRepayAmount The amount of vTokenBorrowed underlying to convert into vTokenCollateral tokens | |
* @return (errorCode, number of vTokenCollateral tokens to be seized in a liquidation) | |
*/ | |
function liquidateCalculateSeizeTokens(address vTokenBorrowed, address vTokenCollateral, uint actualRepayAmount) external view returns (uint, uint) { | |
/* Read oracle prices for borrowed and collateral markets */ | |
uint priceBorrowedMantissa = oracle.getUnderlyingPrice(VToken(vTokenBorrowed)); | |
uint priceCollateralMantissa = oracle.getUnderlyingPrice(VToken(vTokenCollateral)); | |
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 = actualRepayAmount * liquidationIncentive * priceBorrowed / priceCollateral | |
* seizeTokens = seizeAmount / exchangeRate | |
* = actualRepayAmount * (liquidationIncentive * priceBorrowed) / (priceCollateral * exchangeRate) | |
*/ | |
uint exchangeRateMantissa = VToken(vTokenCollateral).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, actualRepayAmount); | |
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 (uint) { | |
// 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, newCloseFactorMantissa); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Sets the collateralFactor for a market | |
* @dev Admin function to set per-market collateralFactor | |
* @param vToken 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(VToken vToken, uint newCollateralFactorMantissa) external returns (uint) { | |
// 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(vToken)]; | |
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(vToken) == 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(vToken, 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 vToken The address of the market (token) to list | |
* @return uint 0=success, otherwise a failure. (See enum Error for details) | |
*/ | |
function _supportMarket(VToken vToken) external returns (uint) { | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SUPPORT_MARKET_OWNER_CHECK); | |
} | |
if (markets[address(vToken)].isListed) { | |
return fail(Error.MARKET_ALREADY_LISTED, FailureInfo.SUPPORT_MARKET_EXISTS); | |
} | |
vToken.isVToken(); // Sanity check to make sure its really a VToken | |
markets[address(vToken)] = Market({isListed: true, isVenus: false, collateralFactorMantissa: 0}); | |
_addMarketInternal(vToken); | |
emit MarketListed(vToken); | |
return uint(Error.NO_ERROR); | |
} | |
function _addMarketInternal(VToken vToken) internal { | |
for (uint i = 0; i < allMarkets.length; i ++) { | |
require(allMarkets[i] != vToken, "market already added"); | |
} | |
allMarkets.push(vToken); | |
} | |
/** | |
* @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, newPauseGuardian); | |
return uint(Error.NO_ERROR); | |
} | |
function _setMintPaused(VToken vToken, bool state) public onlyListedMarket(vToken) validPauseState(state) returns (bool) { | |
mintGuardianPaused[address(vToken)] = state; | |
emit ActionPaused(vToken, "Mint", state); | |
return state; | |
} | |
function _setBorrowPaused(VToken vToken, bool state) public onlyListedMarket(vToken) validPauseState(state) returns (bool) { | |
borrowGuardianPaused[address(vToken)] = state; | |
emit ActionPaused(vToken, "Borrow", state); | |
return state; | |
} | |
function _setTransferPaused(bool state) public validPauseState(state) returns (bool) { | |
transferGuardianPaused = state; | |
emit ActionPaused("Transfer", state); | |
return state; | |
} | |
function _setSeizePaused(bool state) public validPauseState(state) returns (bool) { | |
seizeGuardianPaused = state; | |
emit ActionPaused("Seize", state); | |
return state; | |
} | |
function _setMintVAIPaused(bool state) public validPauseState(state) returns (bool) { | |
mintVAIGuardianPaused = state; | |
emit ActionPaused("MintVAI", state); | |
return state; | |
} | |
function _setRepayVAIPaused(bool state) public validPauseState(state) returns (bool) { | |
repayVAIGuardianPaused = state; | |
emit ActionPaused("RepayVAI", state); | |
return state; | |
} | |
/** | |
* @notice Set whole protocol pause/unpause state | |
*/ | |
function _setProtocolPaused(bool state) public onlyAdmin returns(bool) { | |
protocolPaused = state; | |
emit ActionProtocolPaused(state); | |
return state; | |
} | |
/** | |
* @notice Sets a new VAI controller | |
* @dev Admin function to set a new VAI controller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setVAIController(VAIControllerInterface vaiController_) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_VAICONTROLLER_OWNER_CHECK); | |
} | |
VAIControllerInterface oldRate = vaiController; | |
vaiController = vaiController_; | |
emit NewVAIController(oldRate, vaiController_); | |
} | |
function _setVAIMintRate(uint newVAIMintRate) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_VAI_MINT_RATE_CHECK); | |
} | |
uint oldVAIMintRate = vaiMintRate; | |
vaiMintRate = newVAIMintRate; | |
emit NewVAIMintRate(oldVAIMintRate, newVAIMintRate); | |
return uint(Error.NO_ERROR); | |
} | |
function _become(Unitroller unitroller) public { | |
require(msg.sender == unitroller.admin(), "only unitroller admin can"); | |
require(unitroller._acceptImplementation() == 0, "not authorized"); | |
} | |
/*** Venus Distribution ***/ | |
/** | |
* @notice Recalculate and update Venus speeds for all Venus markets | |
*/ | |
function refreshVenusSpeeds() public { | |
require(msg.sender == tx.origin, "only externally owned accounts can"); | |
refreshVenusSpeedsInternal(); | |
} | |
function refreshVenusSpeedsInternal() internal { | |
uint i; | |
VToken vToken; | |
for (i = 0; i < allMarkets.length; i++) { | |
vToken = allMarkets[i]; | |
Exp memory borrowIndex = Exp({mantissa: vToken.borrowIndex()}); | |
updateVenusSupplyIndex(address(vToken)); | |
updateVenusBorrowIndex(address(vToken), borrowIndex); | |
} | |
Exp memory totalUtility = Exp({mantissa: 0}); | |
Exp[] memory utilities = new Exp[](allMarkets.length); | |
for (i = 0; i < allMarkets.length; i++) { | |
vToken = allMarkets[i]; | |
if (markets[address(vToken)].isVenus) { | |
Exp memory assetPrice = Exp({mantissa: oracle.getUnderlyingPrice(vToken)}); | |
Exp memory utility = mul_(assetPrice, vToken.totalBorrows()); | |
utilities[i] = utility; | |
totalUtility = add_(totalUtility, utility); | |
} | |
} | |
for (i = 0; i < allMarkets.length; i++) { | |
vToken = allMarkets[i]; | |
uint newSpeed = totalUtility.mantissa > 0 ? mul_(venusRate, div_(utilities[i], totalUtility)) : 0; | |
venusSpeeds[address(vToken)] = newSpeed; | |
emit VenusSpeedUpdated(vToken, newSpeed); | |
} | |
} | |
/** | |
* @notice Accrue XVS to the market by updating the supply index | |
* @param vToken The market whose supply index to update | |
*/ | |
function updateVenusSupplyIndex(address vToken) internal { | |
VenusMarketState storage supplyState = venusSupplyState[vToken]; | |
uint supplySpeed = venusSpeeds[vToken]; | |
uint blockNumber = getBlockNumber(); | |
uint deltaBlocks = sub_(blockNumber, uint(supplyState.block)); | |
if (deltaBlocks > 0 && supplySpeed > 0) { | |
uint supplyTokens = VToken(vToken).totalSupply(); | |
uint venusAccrued = mul_(deltaBlocks, supplySpeed); | |
Double memory ratio = supplyTokens > 0 ? fraction(venusAccrued, supplyTokens) : Double({mantissa: 0}); | |
Double memory index = add_(Double({mantissa: supplyState.index}), ratio); | |
venusSupplyState[vToken] = VenusMarketState({ | |
index: safe224(index.mantissa, "new index overflows"), | |
block: safe32(blockNumber, "block number overflows") | |
}); | |
} else if (deltaBlocks > 0) { | |
supplyState.block = safe32(blockNumber, "block number overflows"); | |
} | |
} | |
/** | |
* @notice Accrue XVS to the market by updating the borrow index | |
* @param vToken The market whose borrow index to update | |
*/ | |
function updateVenusBorrowIndex(address vToken, Exp memory marketBorrowIndex) internal { | |
VenusMarketState storage borrowState = venusBorrowState[vToken]; | |
uint borrowSpeed = venusSpeeds[vToken]; | |
uint blockNumber = getBlockNumber(); | |
uint deltaBlocks = sub_(blockNumber, uint(borrowState.block)); | |
if (deltaBlocks > 0 && borrowSpeed > 0) { | |
uint borrowAmount = div_(VToken(vToken).totalBorrows(), marketBorrowIndex); | |
uint venusAccrued = mul_(deltaBlocks, borrowSpeed); | |
Double memory ratio = borrowAmount > 0 ? fraction(venusAccrued, borrowAmount) : Double({mantissa: 0}); | |
Double memory index = add_(Double({mantissa: borrowState.index}), ratio); | |
venusBorrowState[vToken] = VenusMarketState({ | |
index: safe224(index.mantissa, "new index overflows"), | |
block: safe32(blockNumber, "block number overflows") | |
}); | |
} else if (deltaBlocks > 0) { | |
borrowState.block = safe32(blockNumber, "block number overflows"); | |
} | |
} | |
/** | |
* @notice Accrue XVS to by updating the VAI minter index | |
*/ | |
function updateVenusVAIMintIndex() internal { | |
if (address(vaiController) != address(0)) { | |
vaiController.updateVenusVAIMintIndex(); | |
} | |
} | |
/** | |
* @notice Calculate XVS accrued by a supplier and possibly transfer it to them | |
* @param vToken The market in which the supplier is interacting | |
* @param supplier The address of the supplier to distribute XVS to | |
*/ | |
function distributeSupplierVenus(address vToken, address supplier, bool distributeAll) internal { | |
VenusMarketState storage supplyState = venusSupplyState[vToken]; | |
Double memory supplyIndex = Double({mantissa: supplyState.index}); | |
Double memory supplierIndex = Double({mantissa: venusSupplierIndex[vToken][supplier]}); | |
venusSupplierIndex[vToken][supplier] = supplyIndex.mantissa; | |
if (supplierIndex.mantissa == 0 && supplyIndex.mantissa > 0) { | |
supplierIndex.mantissa = venusInitialIndex; | |
} | |
Double memory deltaIndex = sub_(supplyIndex, supplierIndex); | |
uint supplierTokens = VToken(vToken).balanceOf(supplier); | |
uint supplierDelta = mul_(supplierTokens, deltaIndex); | |
uint supplierAccrued = add_(venusAccrued[supplier], supplierDelta); | |
venusAccrued[supplier] = transferXVS(supplier, supplierAccrued, distributeAll ? 0 : venusClaimThreshold); | |
emit DistributedSupplierVenus(VToken(vToken), supplier, supplierDelta, supplyIndex.mantissa); | |
} | |
/** | |
* @notice Calculate XVS accrued by a borrower and possibly transfer it to them | |
* @dev Borrowers will not begin to accrue until after the first interaction with the protocol. | |
* @param vToken The market in which the borrower is interacting | |
* @param borrower The address of the borrower to distribute XVS to | |
*/ | |
function distributeBorrowerVenus(address vToken, address borrower, Exp memory marketBorrowIndex, bool distributeAll) internal { | |
VenusMarketState storage borrowState = venusBorrowState[vToken]; | |
Double memory borrowIndex = Double({mantissa: borrowState.index}); | |
Double memory borrowerIndex = Double({mantissa: venusBorrowerIndex[vToken][borrower]}); | |
venusBorrowerIndex[vToken][borrower] = borrowIndex.mantissa; | |
if (borrowerIndex.mantissa > 0) { | |
Double memory deltaIndex = sub_(borrowIndex, borrowerIndex); | |
uint borrowerAmount = div_(VToken(vToken).borrowBalanceStored(borrower), marketBorrowIndex); | |
uint borrowerDelta = mul_(borrowerAmount, deltaIndex); | |
uint borrowerAccrued = add_(venusAccrued[borrower], borrowerDelta); | |
venusAccrued[borrower] = transferXVS(borrower, borrowerAccrued, distributeAll ? 0 : venusClaimThreshold); | |
emit DistributedBorrowerVenus(VToken(vToken), borrower, borrowerDelta, borrowIndex.mantissa); | |
} | |
} | |
/** | |
* @notice Calculate XVS accrued by a VAI minter and possibly transfer it to them | |
* @dev VAI minters will not begin to accrue until after the first interaction with the protocol. | |
* @param vaiMinter The address of the VAI minter to distribute XVS to | |
*/ | |
function distributeVAIMinterVenus(address vaiMinter, bool distributeAll) internal { | |
if (address(vaiController) != address(0)) { | |
uint vaiMinterAccrued; | |
uint vaiMinterDelta; | |
uint vaiMintIndexMantissa; | |
uint err; | |
(err, vaiMinterAccrued, vaiMinterDelta, vaiMintIndexMantissa) = vaiController.calcDistributeVAIMinterVenus(vaiMinter); | |
if (err == uint(Error.NO_ERROR)) { | |
venusAccrued[vaiMinter] = transferXVS(vaiMinter, vaiMinterAccrued, distributeAll ? 0 : venusClaimThreshold); | |
emit DistributedVAIMinterVenus(vaiMinter, vaiMinterDelta, vaiMintIndexMantissa); | |
} | |
} | |
} | |
/** | |
* @notice Transfer XVS to the user, if they are above the threshold | |
* @dev Note: If there is not enough XVS, we do not perform the transfer all. | |
* @param user The address of the user to transfer XVS to | |
* @param userAccrued The amount of XVS to (possibly) transfer | |
* @return The amount of XVS which was NOT transferred to the user | |
*/ | |
function transferXVS(address user, uint userAccrued, uint threshold) internal returns (uint) { | |
if (userAccrued >= threshold && userAccrued > 0) { | |
XVS xvs = XVS(getXVSAddress()); | |
uint xvsRemaining = xvs.balanceOf(address(this)); | |
if (userAccrued <= xvsRemaining) { | |
xvs.transfer(user, userAccrued); | |
return 0; | |
} | |
} | |
return userAccrued; | |
} | |
/** | |
* @notice Claim all the xvs accrued by holder in all markets and VAI | |
* @param holder The address to claim XVS for | |
*/ | |
function claimVenus(address holder) public { | |
return claimVenus(holder, allMarkets); | |
} | |
/** | |
* @notice Claim all the xvs accrued by holder in the specified markets | |
* @param holder The address to claim XVS for | |
* @param vTokens The list of markets to claim XVS in | |
*/ | |
function claimVenus(address holder, VToken[] memory vTokens) public { | |
address[] memory holders = new address[](1); | |
holders[0] = holder; | |
claimVenus(holders, vTokens, true, true); | |
} | |
/** | |
* @notice Claim all xvs accrued by the holders | |
* @param holders The addresses to claim XVS for | |
* @param vTokens The list of markets to claim XVS in | |
* @param borrowers Whether or not to claim XVS earned by borrowing | |
* @param suppliers Whether or not to claim XVS earned by supplying | |
*/ | |
function claimVenus(address[] memory holders, VToken[] memory vTokens, bool borrowers, bool suppliers) public { | |
uint j; | |
updateVenusVAIMintIndex(); | |
for (j = 0; j < holders.length; j++) { | |
distributeVAIMinterVenus(holders[j], true); | |
} | |
for (uint i = 0; i < vTokens.length; i++) { | |
VToken vToken = vTokens[i]; | |
require(markets[address(vToken)].isListed, "not listed market"); | |
if (borrowers) { | |
Exp memory borrowIndex = Exp({mantissa: vToken.borrowIndex()}); | |
updateVenusBorrowIndex(address(vToken), borrowIndex); | |
for (j = 0; j < holders.length; j++) { | |
distributeBorrowerVenus(address(vToken), holders[j], borrowIndex, true); | |
} | |
} | |
if (suppliers) { | |
updateVenusSupplyIndex(address(vToken)); | |
for (j = 0; j < holders.length; j++) { | |
distributeSupplierVenus(address(vToken), holders[j], true); | |
} | |
} | |
} | |
} | |
/*** Venus Distribution Admin ***/ | |
/** | |
* @notice Set the amount of XVS distributed per block | |
* @param venusRate_ The amount of XVS wei per block to distribute | |
*/ | |
function _setVenusRate(uint venusRate_) public onlyAdmin { | |
uint oldRate = venusRate; | |
venusRate = venusRate_; | |
emit NewVenusRate(oldRate, venusRate_); | |
refreshVenusSpeedsInternal(); | |
} | |
/** | |
* @notice Set the amount of XVS distributed per block to VAI Mint | |
* @param venusVAIRate_ The amount of XVS wei per block to distribute to VAI Mint | |
*/ | |
function _setVenusVAIRate(uint venusVAIRate_) public { | |
require(msg.sender == admin, "only admin can"); | |
uint oldVAIRate = venusVAIRate; | |
venusVAIRate = venusVAIRate_; | |
emit NewVenusVAIRate(oldVAIRate, venusVAIRate_); | |
} | |
/** | |
* @notice Add markets to venusMarkets, allowing them to earn XVS in the flywheel | |
* @param vTokens The addresses of the markets to add | |
*/ | |
function _addVenusMarkets(address[] calldata vTokens) external onlyAdmin { | |
for (uint i = 0; i < vTokens.length; i++) { | |
_addVenusMarketInternal(vTokens[i]); | |
} | |
refreshVenusSpeedsInternal(); | |
} | |
function _addVenusMarketInternal(address vToken) internal { | |
Market storage market = markets[vToken]; | |
require(market.isListed, "venus market is not listed"); | |
require(!market.isVenus, "venus market already added"); | |
market.isVenus = true; | |
emit MarketVenus(VToken(vToken), true); | |
if (venusSupplyState[vToken].index == 0 && venusSupplyState[vToken].block == 0) { | |
venusSupplyState[vToken] = VenusMarketState({ | |
index: venusInitialIndex, | |
block: safe32(getBlockNumber(), "block number overflows") | |
}); | |
} | |
if (venusBorrowState[vToken].index == 0 && venusBorrowState[vToken].block == 0) { | |
venusBorrowState[vToken] = VenusMarketState({ | |
index: venusInitialIndex, | |
block: safe32(getBlockNumber(), "block number overflows") | |
}); | |
} | |
} | |
function _initializeVenusVAIState(uint blockNumber) public { | |
require(msg.sender == admin, "only admin can"); | |
if (address(vaiController) != address(0)) { | |
vaiController._initializeVenusVAIState(blockNumber); | |
} | |
} | |
/** | |
* @notice Remove a market from venusMarkets, preventing it from earning XVS in the flywheel | |
* @param vToken The address of the market to drop | |
*/ | |
function _dropVenusMarket(address vToken) public onlyAdmin { | |
Market storage market = markets[vToken]; | |
require(market.isVenus == true, "not venus market"); | |
market.isVenus = false; | |
emit MarketVenus(VToken(vToken), false); | |
refreshVenusSpeedsInternal(); | |
} | |
/** | |
* @notice Return all of the markets | |
* @dev The automatic getter may be used to access an individual market. | |
* @return The list of market addresses | |
*/ | |
function getAllMarkets() public view returns (VToken[] memory) { | |
return allMarkets; | |
} | |
function getBlockNumber() public view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Return the address of the XVS token | |
* @return The address of XVS | |
*/ | |
function getXVSAddress() public view returns (address) { | |
return 0xcF6BB5389c92Bdda8a3747Ddb454cB7a64626C63; | |
} | |
/*** VAI functions ***/ | |
/** | |
* @notice Set the minted VAI amount of the `owner` | |
* @param owner The address of the account to set | |
* @param amount The amount of VAI to set to the account | |
* @return The number of minted VAI by `owner` | |
*/ | |
function setMintedVAIOf(address owner, uint amount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintVAIGuardianPaused && !repayVAIGuardianPaused, "VAI is paused"); | |
// Check caller is vaiController | |
if (msg.sender != address(vaiController)) { | |
return fail(Error.REJECTION, FailureInfo.SET_MINTED_VAI_REJECTION); | |
} | |
mintedVAIs[owner] = amount; | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Mint VAI | |
*/ | |
function mintVAI(uint mintVAIAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!mintVAIGuardianPaused, "mintVAI is paused"); | |
// Keep the flywheel moving | |
updateVenusVAIMintIndex(); | |
distributeVAIMinterVenus(msg.sender, false); | |
return vaiController.mintVAI(msg.sender, mintVAIAmount); | |
} | |
/** | |
* @notice Repay VAI | |
*/ | |
function repayVAI(uint repayVAIAmount) external onlyProtocolAllowed returns (uint) { | |
// Pausing is a very serious situation - we revert to sound the alarms | |
require(!repayVAIGuardianPaused, "repayVAI is paused"); | |
// Keep the flywheel moving | |
updateVenusVAIMintIndex(); | |
distributeVAIMinterVenus(msg.sender, false); | |
return vaiController.repayVAI(msg.sender, repayVAIAmount); | |
} | |
/** | |
* @notice Get the minted VAI amount of the `owner` | |
* @param owner The address of the account to query | |
* @return The number of minted VAI by `owner` | |
*/ | |
function mintedVAIOf(address owner) external view returns (uint) { | |
return mintedVAIs[owner]; | |
} | |
/** | |
* @notice Get Mintable VAI amount | |
*/ | |
function getMintableVAI(address minter) external view returns (uint, uint) { | |
return vaiController.getMintableVAI(minter); | |
} | |
} |
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; | |
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; | |
} |
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 "./VToken.sol"; | |
import "./PriceOracle.sol"; | |
import "./VAIControllerInterface.sol"; | |
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 => VToken[]) public accountAssets; | |
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 XVS | |
bool isVenus; | |
} | |
/** | |
* @notice Official mapping of vTokens -> 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; | |
struct VenusMarketState { | |
/// @notice The market's last updated venusBorrowIndex or venusSupplyIndex | |
uint224 index; | |
/// @notice The block number the index was last updated at | |
uint32 block; | |
} | |
/// @notice A list of all markets | |
VToken[] public allMarkets; | |
/// @notice The rate at which the flywheel distributes XVS, per block | |
uint public venusRate; | |
/// @notice The portion of venusRate that each market currently receives | |
mapping(address => uint) public venusSpeeds; | |
/// @notice The Venus market supply state for each market | |
mapping(address => VenusMarketState) public venusSupplyState; | |
/// @notice The Venus market borrow state for each market | |
mapping(address => VenusMarketState) public venusBorrowState; | |
/// @notice The Venus supply index for each market for each supplier as of the last time they accrued XVS | |
mapping(address => mapping(address => uint)) public venusSupplierIndex; | |
/// @notice The Venus borrow index for each market for each borrower as of the last time they accrued XVS | |
mapping(address => mapping(address => uint)) public venusBorrowerIndex; | |
/// @notice The XVS accrued but not yet transferred to each user | |
mapping(address => uint) public venusAccrued; | |
/// @notice The Address of VAIController | |
VAIControllerInterface public vaiController; | |
/// @notice The minted VAI amount to each user | |
mapping(address => uint) public mintedVAIs; | |
/// @notice VAI Mint Rate as a percentage | |
uint public vaiMintRate; | |
/** | |
* @notice The Pause Guardian can pause certain actions as a safety mechanism. | |
*/ | |
bool public mintVAIGuardianPaused; | |
bool public repayVAIGuardianPaused; | |
/** | |
* @notice Pause/Unpause whole protocol actions | |
*/ | |
bool public protocolPaused; | |
/// @notice The rate at which the flywheel distributes XVS to VAI Minters, per block | |
uint public venusVAIRate; | |
} | |
contract ComptrollerV2Storage is ComptrollerV1Storage { | |
/// @notice The rate at which the flywheel distributes XVS to VAI Vault, per block | |
uint public venusVAIVaultRate; | |
// address of VAI Vault | |
address public vaiVaultAddress; | |
// start block of release to VAI Vault | |
uint256 public releaseStartBlock; | |
// minimum release amount to VAI Vault | |
uint256 public minReleaseAmount; | |
} | |
contract ComptrollerV3Storage is ComptrollerV2Storage { | |
/// @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 vToken address. Defaults to zero which corresponds to unlimited borrowing. | |
mapping(address => uint) public borrowCaps; | |
} |
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; | |
/* | |
* @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; | |
} | |
} |
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 "./JumpRateModel.sol"; | |
import "./SafeMath.sol"; | |
/** | |
* @title Venus's DAIInterestRateModel Contract (version 2) | |
* @author Venus (modified by Dharma Labs) | |
* @notice The parameterized model described in section 2.4 of the original Venus Protocol whitepaper. | |
* Version 2 modifies the original interest rate model by increasing the "gap" or slope of the model prior | |
* to the "kink" from 0.05% to 2% with the goal of "smoothing out" interest rate changes as the utilization | |
* rate increases. | |
*/ | |
contract DAIInterestRateModelV2 is JumpRateModel { | |
using SafeMath for uint; | |
/** | |
* @notice The additional margin per block separating the base borrow rate from the roof (2% / block). | |
* Note that this value has been increased from the original value of 0.05% per block. | |
*/ | |
uint public constant gapPerBlock = 2e16 / blocksPerYear; | |
/** | |
* @notice The assumed (1 - reserve factor) used to calculate the minimum borrow rate (reserve factor = 0.05) | |
*/ | |
uint public constant assumedOneMinusReserveFactorMantissa = 0.95e18; | |
PotLike pot; | |
JugLike jug; | |
/** | |
* @notice Construct an interest rate model | |
* @param jumpMultiplierPerYear The multiplierPerBlock after hitting a specified utilization point | |
* @param kink_ The utilization point at which the jump multiplier is applied | |
* @param pot_ The address of the Dai pot (where DSR is earned) | |
* @param jug_ The address of the Dai jug (where SF is kept) | |
*/ | |
constructor(uint jumpMultiplierPerYear, uint kink_, address pot_, address jug_) JumpRateModel(0, 0, jumpMultiplierPerYear, kink_) public { | |
pot = PotLike(pot_); | |
jug = JugLike(jug_); | |
poke(); | |
} | |
/** | |
* @notice Calculates the current supply interest rate per block including the Dai savings rate | |
* @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) public view returns (uint) { | |
uint protocolRate = super.getSupplyRate(cash, borrows, reserves, reserveFactorMantissa); | |
uint underlying = cash.add(borrows).sub(reserves); | |
if (underlying == 0) { | |
return protocolRate; | |
} else { | |
uint cashRate = cash.mul(dsrPerBlock()).div(underlying); | |
return cashRate.add(protocolRate); | |
} | |
} | |
/** | |
* @notice Calculates the Dai savings rate per block | |
* @return The Dai savings rate per block (as a percentage, and scaled by 1e18) | |
*/ | |
function dsrPerBlock() public view returns (uint) { | |
return pot | |
.dsr().sub(1e27) // scaled 1e27 aka RAY, and includes an extra "ONE" before subraction | |
.div(1e9) // descale to 1e18 | |
.mul(15); // 15 seconds per block | |
} | |
/** | |
* @notice Resets the baseRate and multiplier per block based on the stability fee and Dai savings rate | |
*/ | |
function poke() public { | |
(uint duty, ) = jug.ilks("BNB-A"); | |
uint stabilityFeePerBlock = duty.add(jug.base()).sub(1e27).mul(1e18).div(1e27).mul(15); | |
// We ensure the minimum borrow rate >= DSR / (1 - reserve factor) | |
baseRatePerBlock = dsrPerBlock().mul(1e18).div(assumedOneMinusReserveFactorMantissa); | |
// The roof borrow rate is max(base rate, stability fee) + gap, from which we derive the slope | |
if (baseRatePerBlock < stabilityFeePerBlock) { | |
multiplierPerBlock = stabilityFeePerBlock.sub(baseRatePerBlock).add(gapPerBlock).mul(1e18).div(kink); | |
} else { | |
multiplierPerBlock = gapPerBlock.mul(1e18).div(kink); | |
} | |
emit NewInterestParams(baseRatePerBlock, multiplierPerBlock, jumpMultiplierPerBlock, kink); | |
} | |
} | |
/*** Maker Interfaces ***/ | |
contract PotLike { | |
function chi() external view returns (uint); | |
function dsr() external view returns (uint); | |
function rho() external view returns (uint); | |
function pie(address) external view returns (uint); | |
function drip() external returns (uint); | |
function join(uint) external; | |
function exit(uint) external; | |
} | |
contract JugLike { | |
// --- Data --- | |
struct Ilk { | |
uint256 duty; | |
uint256 rho; | |
} | |
mapping (bytes32 => Ilk) public ilks; | |
uint256 public base; | |
} |
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; | |
/** | |
* @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); | |
} |
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; | |
/** | |
* @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); | |
} |
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; | |
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); | |
} | |
} |
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 "./CarefulMath.sol"; | |
/** | |
* @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)}); | |
} | |
} |
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; | |
pragma experimental ABIEncoderV2; | |
contract GovernorAlpha { | |
/// @notice The name of this contract | |
string public constant name = "Venus Governor Alpha"; | |
/// @notice The number of votes in support of a proposal required in order for a quorum to be reached and for a vote to succeed | |
function quorumVotes() public pure returns (uint) { return 600000e18; } // 600,000 = 2% of XVS | |
/// @notice The number of votes required in order for a voter to become a proposer | |
function proposalThreshold() public pure returns (uint) { return 300000e18; } // 300,000 = 1% of XVS | |
/// @notice The maximum number of actions that can be included in a proposal | |
function proposalMaxOperations() public pure returns (uint) { return 10; } // 10 actions | |
/// @notice The delay before voting on a proposal may take place, once proposed | |
function votingDelay() public pure returns (uint) { return 1; } // 1 block | |
/// @notice The duration of voting on a proposal, in blocks | |
function votingPeriod() public pure returns (uint) { return 60 * 60 * 24 * 3 / 3; } // ~3 days in blocks (assuming 3s blocks) | |
/// @notice The address of the Venus Protocol Timelock | |
TimelockInterface public timelock; | |
/// @notice The address of the Venus governance token | |
XVSInterface public xvs; | |
/// @notice The address of the Governor Guardian | |
address public guardian; | |
/// @notice The total number of proposals | |
uint public proposalCount; | |
struct Proposal { | |
/// @notice Unique id for looking up a proposal | |
uint id; | |
/// @notice Creator of the proposal | |
address proposer; | |
/// @notice The timestamp that the proposal will be available for execution, set once the vote succeeds | |
uint eta; | |
/// @notice the ordered list of target addresses for calls to be made | |
address[] targets; | |
/// @notice The ordered list of values (i.e. msg.value) to be passed to the calls to be made | |
uint[] values; | |
/// @notice The ordered list of function signatures to be called | |
string[] signatures; | |
/// @notice The ordered list of calldata to be passed to each call | |
bytes[] calldatas; | |
/// @notice The block at which voting begins: holders must delegate their votes prior to this block | |
uint startBlock; | |
/// @notice The block at which voting ends: votes must be cast prior to this block | |
uint endBlock; | |
/// @notice Current number of votes in favor of this proposal | |
uint forVotes; | |
/// @notice Current number of votes in opposition to this proposal | |
uint againstVotes; | |
/// @notice Flag marking whether the proposal has been canceled | |
bool canceled; | |
/// @notice Flag marking whether the proposal has been executed | |
bool executed; | |
/// @notice Receipts of ballots for the entire set of voters | |
mapping (address => Receipt) receipts; | |
} | |
/// @notice Ballot receipt record for a voter | |
struct Receipt { | |
/// @notice Whether or not a vote has been cast | |
bool hasVoted; | |
/// @notice Whether or not the voter supports the proposal | |
bool support; | |
/// @notice The number of votes the voter had, which were cast | |
uint96 votes; | |
} | |
/// @notice Possible states that a proposal may be in | |
enum ProposalState { | |
Pending, | |
Active, | |
Canceled, | |
Defeated, | |
Succeeded, | |
Queued, | |
Expired, | |
Executed | |
} | |
/// @notice The official record of all proposals ever proposed | |
mapping (uint => Proposal) public proposals; | |
/// @notice The latest proposal for each proposer | |
mapping (address => uint) public latestProposalIds; | |
/// @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 ballot struct used by the contract | |
bytes32 public constant BALLOT_TYPEHASH = keccak256("Ballot(uint256 proposalId,bool support)"); | |
/// @notice An event emitted when a new proposal is created | |
event ProposalCreated(uint id, address proposer, address[] targets, uint[] values, string[] signatures, bytes[] calldatas, uint startBlock, uint endBlock, string description); | |
/// @notice An event emitted when a vote has been cast on a proposal | |
event VoteCast(address voter, uint proposalId, bool support, uint votes); | |
/// @notice An event emitted when a proposal has been canceled | |
event ProposalCanceled(uint id); | |
/// @notice An event emitted when a proposal has been queued in the Timelock | |
event ProposalQueued(uint id, uint eta); | |
/// @notice An event emitted when a proposal has been executed in the Timelock | |
event ProposalExecuted(uint id); | |
constructor(address timelock_, address xvs_, address guardian_) public { | |
timelock = TimelockInterface(timelock_); | |
xvs = XVSInterface(xvs_); | |
guardian = guardian_; | |
} | |
function propose(address[] memory targets, uint[] memory values, string[] memory signatures, bytes[] memory calldatas, string memory description) public returns (uint) { | |
require(xvs.getPriorVotes(msg.sender, sub256(block.number, 1)) > proposalThreshold(), "GovernorAlpha::propose: proposer votes below proposal threshold"); | |
require(targets.length == values.length && targets.length == signatures.length && targets.length == calldatas.length, "GovernorAlpha::propose: proposal function information arity mismatch"); | |
require(targets.length != 0, "GovernorAlpha::propose: must provide actions"); | |
require(targets.length <= proposalMaxOperations(), "GovernorAlpha::propose: too many actions"); | |
uint latestProposalId = latestProposalIds[msg.sender]; | |
if (latestProposalId != 0) { | |
ProposalState proposersLatestProposalState = state(latestProposalId); | |
require(proposersLatestProposalState != ProposalState.Active, "GovernorAlpha::propose: found an already active proposal"); | |
require(proposersLatestProposalState != ProposalState.Pending, "GovernorAlpha::propose: found an already pending proposal"); | |
} | |
uint startBlock = add256(block.number, votingDelay()); | |
uint endBlock = add256(startBlock, votingPeriod()); | |
proposalCount++; | |
Proposal memory newProposal = Proposal({ | |
id: proposalCount, | |
proposer: msg.sender, | |
eta: 0, | |
targets: targets, | |
values: values, | |
signatures: signatures, | |
calldatas: calldatas, | |
startBlock: startBlock, | |
endBlock: endBlock, | |
forVotes: 0, | |
againstVotes: 0, | |
canceled: false, | |
executed: false | |
}); | |
proposals[newProposal.id] = newProposal; | |
latestProposalIds[newProposal.proposer] = newProposal.id; | |
emit ProposalCreated(newProposal.id, msg.sender, targets, values, signatures, calldatas, startBlock, endBlock, description); | |
return newProposal.id; | |
} | |
function queue(uint proposalId) public { | |
require(state(proposalId) == ProposalState.Succeeded, "GovernorAlpha::queue: proposal can only be queued if it is succeeded"); | |
Proposal storage proposal = proposals[proposalId]; | |
uint eta = add256(block.timestamp, timelock.delay()); | |
for (uint i = 0; i < proposal.targets.length; i++) { | |
_queueOrRevert(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], eta); | |
} | |
proposal.eta = eta; | |
emit ProposalQueued(proposalId, eta); | |
} | |
function _queueOrRevert(address target, uint value, string memory signature, bytes memory data, uint eta) internal { | |
require(!timelock.queuedTransactions(keccak256(abi.encode(target, value, signature, data, eta))), "GovernorAlpha::_queueOrRevert: proposal action already queued at eta"); | |
timelock.queueTransaction(target, value, signature, data, eta); | |
} | |
function execute(uint proposalId) public payable { | |
require(state(proposalId) == ProposalState.Queued, "GovernorAlpha::execute: proposal can only be executed if it is queued"); | |
Proposal storage proposal = proposals[proposalId]; | |
proposal.executed = true; | |
for (uint i = 0; i < proposal.targets.length; i++) { | |
timelock.executeTransaction.value(proposal.values[i])(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], proposal.eta); | |
} | |
emit ProposalExecuted(proposalId); | |
} | |
function cancel(uint proposalId) public { | |
ProposalState state = state(proposalId); | |
require(state != ProposalState.Executed, "GovernorAlpha::cancel: cannot cancel executed proposal"); | |
Proposal storage proposal = proposals[proposalId]; | |
require(msg.sender == guardian || xvs.getPriorVotes(proposal.proposer, sub256(block.number, 1)) < proposalThreshold(), "GovernorAlpha::cancel: proposer above threshold"); | |
proposal.canceled = true; | |
for (uint i = 0; i < proposal.targets.length; i++) { | |
timelock.cancelTransaction(proposal.targets[i], proposal.values[i], proposal.signatures[i], proposal.calldatas[i], proposal.eta); | |
} | |
emit ProposalCanceled(proposalId); | |
} | |
function getActions(uint proposalId) public view returns (address[] memory targets, uint[] memory values, string[] memory signatures, bytes[] memory calldatas) { | |
Proposal storage p = proposals[proposalId]; | |
return (p.targets, p.values, p.signatures, p.calldatas); | |
} | |
function getReceipt(uint proposalId, address voter) public view returns (Receipt memory) { | |
return proposals[proposalId].receipts[voter]; | |
} | |
function state(uint proposalId) public view returns (ProposalState) { | |
require(proposalCount >= proposalId && proposalId > 0, "GovernorAlpha::state: invalid proposal id"); | |
Proposal storage proposal = proposals[proposalId]; | |
if (proposal.canceled) { | |
return ProposalState.Canceled; | |
} else if (block.number <= proposal.startBlock) { | |
return ProposalState.Pending; | |
} else if (block.number <= proposal.endBlock) { | |
return ProposalState.Active; | |
} else if (proposal.forVotes <= proposal.againstVotes || proposal.forVotes < quorumVotes()) { | |
return ProposalState.Defeated; | |
} else if (proposal.eta == 0) { | |
return ProposalState.Succeeded; | |
} else if (proposal.executed) { | |
return ProposalState.Executed; | |
} else if (block.timestamp >= add256(proposal.eta, timelock.GRACE_PERIOD())) { | |
return ProposalState.Expired; | |
} else { | |
return ProposalState.Queued; | |
} | |
} | |
function castVote(uint proposalId, bool support) public { | |
return _castVote(msg.sender, proposalId, support); | |
} | |
function castVoteBySig(uint proposalId, bool support, uint8 v, bytes32 r, bytes32 s) public { | |
bytes32 domainSeparator = keccak256(abi.encode(DOMAIN_TYPEHASH, keccak256(bytes(name)), getChainId(), address(this))); | |
bytes32 structHash = keccak256(abi.encode(BALLOT_TYPEHASH, proposalId, support)); | |
bytes32 digest = keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash)); | |
address signatory = ecrecover(digest, v, r, s); | |
require(signatory != address(0), "GovernorAlpha::castVoteBySig: invalid signature"); | |
return _castVote(signatory, proposalId, support); | |
} | |
function _castVote(address voter, uint proposalId, bool support) internal { | |
require(state(proposalId) == ProposalState.Active, "GovernorAlpha::_castVote: voting is closed"); | |
Proposal storage proposal = proposals[proposalId]; | |
Receipt storage receipt = proposal.receipts[voter]; | |
require(receipt.hasVoted == false, "GovernorAlpha::_castVote: voter already voted"); | |
uint96 votes = xvs.getPriorVotes(voter, proposal.startBlock); | |
if (support) { | |
proposal.forVotes = add256(proposal.forVotes, votes); | |
} else { | |
proposal.againstVotes = add256(proposal.againstVotes, votes); | |
} | |
receipt.hasVoted = true; | |
receipt.support = support; | |
receipt.votes = votes; | |
emit VoteCast(voter, proposalId, support, votes); | |
} | |
function __acceptAdmin() public { | |
require(msg.sender == guardian, "GovernorAlpha::__acceptAdmin: sender must be gov guardian"); | |
timelock.acceptAdmin(); | |
} | |
function __abdicate() public { | |
require(msg.sender == guardian, "GovernorAlpha::__abdicate: sender must be gov guardian"); | |
guardian = address(0); | |
} | |
function __queueSetTimelockPendingAdmin(address newPendingAdmin, uint eta) public { | |
require(msg.sender == guardian, "GovernorAlpha::__queueSetTimelockPendingAdmin: sender must be gov guardian"); | |
timelock.queueTransaction(address(timelock), 0, "setPendingAdmin(address)", abi.encode(newPendingAdmin), eta); | |
} | |
function __executeSetTimelockPendingAdmin(address newPendingAdmin, uint eta) public { | |
require(msg.sender == guardian, "GovernorAlpha::__executeSetTimelockPendingAdmin: sender must be gov guardian"); | |
timelock.executeTransaction(address(timelock), 0, "setPendingAdmin(address)", abi.encode(newPendingAdmin), eta); | |
} | |
function add256(uint256 a, uint256 b) internal pure returns (uint) { | |
uint c = a + b; | |
require(c >= a, "addition overflow"); | |
return c; | |
} | |
function sub256(uint256 a, uint256 b) internal pure returns (uint) { | |
require(b <= a, "subtraction underflow"); | |
return a - b; | |
} | |
function getChainId() internal pure returns (uint) { | |
uint chainId; | |
assembly { chainId := chainid() } | |
return chainId; | |
} | |
} | |
interface TimelockInterface { | |
function delay() external view returns (uint); | |
function GRACE_PERIOD() external view returns (uint); | |
function acceptAdmin() external; | |
function queuedTransactions(bytes32 hash) external view returns (bool); | |
function queueTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external returns (bytes32); | |
function cancelTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external; | |
function executeTransaction(address target, uint value, string calldata signature, bytes calldata data, uint eta) external payable returns (bytes memory); | |
} | |
interface XVSInterface { | |
function getPriorVotes(address account, uint blockNumber) external view returns (uint96); | |
} |
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.0; | |
/** | |
* @dev Interface of the BEP20 standard as defined in the EIP. Does not include | |
* the optional functions; to access them see {BEP20Detailed}. | |
*/ | |
interface IBEP20 { | |
/** | |
* @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); | |
} |
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; | |
/** | |
* @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); | |
} |
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 "./InterestRateModel.sol"; | |
import "./SafeMath.sol"; | |
/** | |
* @title Venus's JumpRateModel Contract | |
* @author Venus | |
*/ | |
contract JumpRateModel is InterestRateModel { | |
using SafeMath for uint; | |
event NewInterestParams(uint baseRatePerBlock, uint multiplierPerBlock, uint jumpMultiplierPerBlock, uint kink); | |
/** | |
* @notice The approximate number of blocks per year that is assumed by the interest rate model | |
*/ | |
uint public constant blocksPerYear = 60 * 60 * 24 * 365 / 3; // (assuming 3s blocks) | |
/** | |
* @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 | |
*/ | |
constructor(uint baseRatePerYear, uint multiplierPerYear, uint jumpMultiplierPerYear, uint kink_) public { | |
baseRatePerBlock = baseRatePerYear.div(blocksPerYear); | |
multiplierPerBlock = multiplierPerYear.div(blocksPerYear); | |
jumpMultiplierPerBlock = jumpMultiplierPerYear.div(blocksPerYear); | |
kink = kink_; | |
emit NewInterestParams(baseRatePerBlock, multiplierPerBlock, jumpMultiplierPerBlock, 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 getBorrowRate(uint cash, uint borrows, uint reserves) public 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 = getBorrowRate(cash, borrows, reserves); | |
uint rateToPool = borrowRate.mul(oneMinusReserveFactor).div(1e18); | |
return utilizationRate(cash, borrows, reserves).mul(rateToPool).div(1e18); | |
} | |
} |
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: AGPL-3.0-or-later | |
// This program is free software: you can redistribute it and/or modify | |
// it under the terms of the GNU General Public License as published by | |
// the Free Software Foundation, either version 3 of the License, or | |
// (at your option) any later version. | |
// This program is distributed in the hope that it will be useful, | |
// but WITHOUT ANY WARRANTY; without even the implied warranty of | |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
// GNU General Public License for more details. | |
// You should have received a copy of the GNU General Public License | |
// along with this program. If not, see <http://www.gnu.org/licenses/>. | |
pragma solidity >=0.5.16; | |
contract LibNote { | |
event LogNote( | |
bytes4 indexed sig, | |
address indexed usr, | |
bytes32 indexed arg1, | |
bytes32 indexed arg2, | |
bytes data | |
) anonymous; | |
modifier note { | |
_; | |
assembly { | |
// log an 'anonymous' event with a constant 6 words of calldata | |
// and four indexed topics: selector, caller, arg1 and arg2 | |
let mark := msize() // end of memory ensures zero | |
mstore(0x40, add(mark, 288)) // update free memory pointer | |
mstore(mark, 0x20) // bytes type data offset | |
mstore(add(mark, 0x20), 224) // bytes size (padded) | |
calldatacopy(add(mark, 0x40), 0, 224) // bytes payload | |
log4(mark, 288, // calldata | |
shl(224, shr(224, calldataload(0))), // msg.sig | |
caller(), // msg.sender | |
calldataload(4), // arg1 | |
calldataload(36) // arg2 | |
) | |
} | |
} | |
} |
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 "./VBNB.sol"; | |
/** | |
* @title Venus's Maximillion Contract | |
* @author Venus | |
*/ | |
contract Maximillion { | |
/** | |
* @notice The default vBnb market to repay in | |
*/ | |
VBNB public vBnb; | |
/** | |
* @notice Construct a Maximillion to repay max in a VBNB market | |
*/ | |
constructor(VBNB vBnb_) public { | |
vBnb = vBnb_; | |
} | |
/** | |
* @notice msg.sender sends BNB to repay an account's borrow in the vBnb market | |
* @dev The provided BNB is applied towards the borrow balance, any excess is refunded | |
* @param borrower The address of the borrower account to repay on behalf of | |
*/ | |
function repayBehalf(address borrower) public payable { | |
repayBehalfExplicit(borrower, vBnb); | |
} | |
/** | |
* @notice msg.sender sends BNB to repay an account's borrow in a vBnb market | |
* @dev The provided BNB is applied towards the borrow balance, any excess is refunded | |
* @param borrower The address of the borrower account to repay on behalf of | |
* @param vBnb_ The address of the vBnb contract to repay in | |
*/ | |
function repayBehalfExplicit(address borrower, VBNB vBnb_) public payable { | |
uint received = msg.value; | |
uint borrows = vBnb_.borrowBalanceCurrent(borrower); | |
if (received > borrows) { | |
vBnb_.repayBorrowBehalf.value(borrows)(borrower); | |
msg.sender.transfer(received - borrows); | |
} else { | |
vBnb_.repayBorrowBehalf.value(received)(borrower); | |
} | |
} | |
} |
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 "./Context.sol"; | |
/** | |
* @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; | |
} | |
} |
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 "./VToken.sol"; | |
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); | |
} |
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 "./VBep20.sol"; | |
import "./VToken.sol"; | |
import "./PriceOracle.sol"; | |
interface V1PriceOracleInterface { | |
function assetPrices(address asset) external view returns (uint); | |
} | |
contract PriceOracleProxy is PriceOracle { | |
/// @notice Indicator that this is a PriceOracle contract (for inspection) | |
bool public constant isPriceOracle = true; | |
/// @notice The v1 price oracle, which will continue to serve prices for v1 assets | |
V1PriceOracleInterface public v1PriceOracle; | |
/// @notice Address of the guardian, which may set the SAI price once | |
address public guardian; | |
/// @notice Address of the vBnb contract, which has a constant price | |
address public vBnbAddress; | |
/// @notice Address of the vUSDC contract, which we hand pick a key for | |
address public vUsdcAddress; | |
/// @notice Address of the vUSDT contract, which uses the vUSDC price | |
address public vUsdtAddress; | |
/// @notice Address of the vSAI contract, which may have its price set | |
address public vSaiAddress; | |
/// @notice Address of the vDAI contract, which we hand pick a key for | |
address public vDaiAddress; | |
/// @notice Handpicked key for USDC | |
address public constant usdcOracleKey = address(1); | |
/// @notice Handpicked key for DAI | |
address public constant daiOracleKey = address(2); | |
/// @notice Frozen SAI price (or 0 if not set yet) | |
uint public saiPrice; | |
/** | |
* @param guardian_ The address of the guardian, which may set the SAI price once | |
* @param v1PriceOracle_ The address of the v1 price oracle, which will continue to operate and hold prices for collateral assets | |
* @param vBnbAddress_ The address of vBNB, which will return a constant 1e18, since all prices relative to bnb | |
* @param vUsdcAddress_ The address of vUSDC, which will be read from a special oracle key | |
* @param vSaiAddress_ The address of vSAI, which may be read directly from storage | |
* @param vDaiAddress_ The address of vDAI, which will be read from a special oracle key | |
* @param vUsdtAddress_ The address of vUSDT, which uses the vUSDC price | |
*/ | |
constructor(address guardian_, | |
address v1PriceOracle_, | |
address vBnbAddress_, | |
address vUsdcAddress_, | |
address vSaiAddress_, | |
address vDaiAddress_, | |
address vUsdtAddress_) public { | |
guardian = guardian_; | |
v1PriceOracle = V1PriceOracleInterface(v1PriceOracle_); | |
vBnbAddress = vBnbAddress_; | |
vUsdcAddress = vUsdcAddress_; | |
vSaiAddress = vSaiAddress_; | |
vDaiAddress = vDaiAddress_; | |
vUsdtAddress = vUsdtAddress_; | |
} | |
/** | |
* @notice Get the underlying price of a listed vToken asset | |
* @param vToken The vToken to get the underlying price of | |
* @return The underlying asset price mantissa (scaled by 1e18) | |
*/ | |
function getUnderlyingPrice(VToken vToken) public view returns (uint) { | |
address vTokenAddress = address(vToken); | |
if (vTokenAddress == vBnbAddress) { | |
// bnb always worth 1 | |
return 1e18; | |
} | |
if (vTokenAddress == vUsdcAddress || vTokenAddress == vUsdtAddress) { | |
return v1PriceOracle.assetPrices(usdcOracleKey); | |
} | |
if (vTokenAddress == vDaiAddress) { | |
return v1PriceOracle.assetPrices(daiOracleKey); | |
} | |
if (vTokenAddress == vSaiAddress) { | |
// use the frozen SAI price if set, otherwise use the DAI price | |
return saiPrice > 0 ? saiPrice : v1PriceOracle.assetPrices(daiOracleKey); | |
} | |
// otherwise just read from v1 oracle | |
address underlying = VBep20(vTokenAddress).underlying(); | |
return v1PriceOracle.assetPrices(underlying); | |
} | |
/** | |
* @notice Set the price of SAI, permanently | |
* @param price The price for SAI | |
*/ | |
function setSaiPrice(uint price) public { | |
require(msg.sender == guardian, "only guardian may set the SAI price"); | |
require(saiPrice == 0, "SAI price may only be set once"); | |
require(price < 0.1e18, "SAI price must be < 0.1 BNB"); | |
saiPrice = price; | |
} | |
} |
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; | |
/** | |
* @title Reservoir Contract | |
* @notice Distributes a token to a different contract at a fixed rate. | |
* @dev This contract must be poked via the `drip()` function every so often. | |
* @author Venus | |
*/ | |
contract Reservoir { | |
/// @notice The block number when the Reservoir started (immutable) | |
uint public dripStart; | |
/// @notice Tokens per block that to drip to target (immutable) | |
uint public dripRate; | |
/// @notice Reference to token to drip (immutable) | |
EIP20Interface public token; | |
/// @notice Target to receive dripped tokens (immutable) | |
address public target; | |
/// @notice Amount that has already been dripped | |
uint public dripped; | |
/** | |
* @notice Constructs a Reservoir | |
* @param dripRate_ Numer of tokens per block to drip | |
* @param token_ The token to drip | |
* @param target_ The recipient of dripped tokens | |
*/ | |
constructor(uint dripRate_, EIP20Interface token_, address target_) public { | |
dripStart = block.number; | |
dripRate = dripRate_; | |
token = token_; | |
target = target_; | |
dripped = 0; | |
} | |
/** | |
* @notice Drips the maximum amount of tokens to match the drip rate since inception | |
* @dev Note: this will only drip up to the amount of tokens available. | |
* @return The amount of tokens dripped in this call | |
*/ | |
function drip() public returns (uint) { | |
// First, read storage into memory | |
EIP20Interface token_ = token; | |
uint reservoirBalance_ = token_.balanceOf(address(this)); // TODO: Verify this is a static call | |
uint dripRate_ = dripRate; | |
uint dripStart_ = dripStart; | |
uint dripped_ = dripped; | |
address target_ = target; | |
uint blockNumber_ = block.number; | |
// Next, calculate intermediate values | |
uint dripTotal_ = mul(dripRate_, blockNumber_ - dripStart_, "dripTotal overflow"); | |
uint deltaDrip_ = sub(dripTotal_, dripped_, "deltaDrip underflow"); | |
uint toDrip_ = min(reservoirBalance_, deltaDrip_); | |
uint drippedNext_ = add(dripped_, toDrip_, "tautological"); | |
// Finally, write new `dripped` value and transfer tokens to target | |
dripped = drippedNext_; | |
token_.transfer(target_, toDrip_); | |
return toDrip_; | |
} | |
/* Internal helper functions for safe math */ | |
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(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
require(b <= a, errorMessage); | |
uint c = a - b; | |
return c; | |
} | |
function mul(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
if (a == 0) { | |
return 0; | |
} | |
uint c = a * b; | |
require(c / a == b, errorMessage); | |
return c; | |
} | |
function min(uint a, uint b) internal pure returns (uint) { | |
if (a <= b) { | |
return a; | |
} else { | |
return b; | |
} | |
} | |
} | |
import "./EIP20Interface.sol"; |
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.0; | |
import "./IBEP20.sol"; | |
import "./SafeMath.sol"; | |
import "./Address.sol"; | |
/** | |
* @title SafeBEP20 | |
* @dev Wrappers around BEP20 operations that throw on failure (when the token | |
* contract returns false). Tokens that return no value (and instead revert or | |
* throw on failure) are also supported, non-reverting calls are assumed to be | |
* successful. | |
* To use this library you can add a `using SafeBEP20 for BEP20;` statement to your contract, | |
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc. | |
*/ | |
library SafeBEP20 { | |
using SafeMath for uint256; | |
using Address for address; | |
function safeTransfer(IBEP20 token, address to, uint256 value) internal { | |
callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); | |
} | |
function safeTransferFrom(IBEP20 token, address from, address to, uint256 value) internal { | |
callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); | |
} | |
function safeApprove(IBEP20 token, address spender, uint256 value) internal { | |
// safeApprove should only be called when setting an initial allowance, | |
// or when resetting it to zero. To increase and decrease it, use | |
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance' | |
// solhint-disable-next-line max-line-length | |
require((value == 0) || (token.allowance(address(this), spender) == 0), | |
"SafeBEP20: approve from non-zero to non-zero allowance" | |
); | |
callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); | |
} | |
function safeIncreaseAllowance(IBEP20 token, address spender, uint256 value) internal { | |
uint256 newAllowance = token.allowance(address(this), spender).add(value); | |
callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); | |
} | |
function safeDecreaseAllowance(IBEP20 token, address spender, uint256 value) internal { | |
uint256 newAllowance = token.allowance(address(this), spender).sub(value, "SafeBEP20: decreased allowance below zero"); | |
callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); | |
} | |
/** | |
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement | |
* on the return value: the return value is optional (but if data is returned, it must not be false). | |
* @param token The token targeted by the call. | |
* @param data The call data (encoded using abi.encode or one of its variants). | |
*/ | |
function callOptionalReturn(IBEP20 token, bytes memory data) private { | |
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since | |
// we're implementing it ourselves. | |
// A Solidity high level call has three parts: | |
// 1. The target address is checked to verify it contains contract code | |
// 2. The call itself is made, and success asserted | |
// 3. The return value is decoded, which in turn checks the size of the returned data. | |
// solhint-disable-next-line max-line-length | |
require(address(token).isContract(), "SafeBEP20: call to non-contract"); | |
// solhint-disable-next-line avoid-low-level-calls | |
(bool success, bytes memory returndata) = address(token).call(data); | |
require(success, "SafeBEP20: low-level call failed"); | |
if (returndata.length > 0) { // Return data is optional | |
// solhint-disable-next-line max-line-length | |
require(abi.decode(returndata, (bool)), "SafeBEP20: BEP20 operation did not succeed"); | |
} | |
} | |
} |
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; | |
/** | |
* @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; | |
} | |
} |
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 "./PriceOracle.sol"; | |
import "./VBep20.sol"; | |
contract SimplePriceOracle is PriceOracle { | |
mapping(address => uint) prices; | |
event PricePosted(address asset, uint previousPriceMantissa, uint requestedPriceMantissa, uint newPriceMantissa); | |
function getUnderlyingPrice(VToken vToken) public view returns (uint) { | |
if (compareStrings(vToken.symbol(), "vBNB")) { | |
return 1e18; | |
} else { | |
return prices[address(VBep20(address(vToken)).underlying())]; | |
} | |
} | |
function setUnderlyingPrice(VToken vToken, uint underlyingPriceMantissa) public { | |
address asset = address(VBep20(address(vToken)).underlying()); | |
emit PricePosted(asset, prices[asset], underlyingPriceMantissa, underlyingPriceMantissa); | |
prices[asset] = underlyingPriceMantissa; | |
} | |
function setDirectPrice(address asset, uint price) public { | |
emit PricePosted(asset, prices[asset], price, price); | |
prices[asset] = price; | |
} | |
// v1 price oracle interface for use as backing of proxy | |
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)))); | |
} | |
} |
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; | |
// ---------------------------------------------------------------------------- | |
// 'SXP' 'Swipe' BEP20 token contract | |
// | |
// Symbol : SXP | |
// Name : Swipe | |
// Total supply: 289,714,926.000000000000000000 | |
// Decimals : 18 | |
// Website : https://swipe.io | |
// | |
// ---------------------------------------------------------------------------- | |
import "../SafeMath.sol"; | |
import "../Ownable.sol"; | |
import "../BEP20Interface.sol"; | |
contract Tokenlock is Ownable { | |
/// @notice Indicates if token is locked | |
uint8 isLocked = 0; | |
event Freezed(); | |
event UnFreezed(); | |
modifier validLock { | |
require(isLocked == 0, "Token is locked"); | |
_; | |
} | |
function freeze() public onlyOwner { | |
isLocked = 1; | |
emit Freezed(); | |
} | |
function unfreeze() public onlyOwner { | |
isLocked = 0; | |
emit UnFreezed(); | |
} | |
} | |
// ---------------------------------------------------------------------------- | |
// Contract function to receive approval and execute function in one call | |
// | |
// Borrowed from MiniMeToken | |
// ---------------------------------------------------------------------------- | |
contract ApproveAndCallFallBack { | |
function receiveApproval(address from, uint256 tokens, address token, bytes memory data) public; | |
} | |
// ---------------------------------------------------------------------------- | |
// Limit users in blacklist | |
// ---------------------------------------------------------------------------- | |
contract UserLock is Ownable { | |
mapping(address => bool) blacklist; | |
event LockUser(address indexed who); | |
event UnlockUser(address indexed who); | |
modifier permissionCheck { | |
require(!blacklist[msg.sender], "Blocked user"); | |
_; | |
} | |
function lockUser(address who) public onlyOwner { | |
blacklist[who] = true; | |
emit LockUser(who); | |
} | |
function unlockUser(address who) public onlyOwner { | |
blacklist[who] = false; | |
emit UnlockUser(who); | |
} | |
} | |
contract SXP is BEP20Interface, Tokenlock, UserLock { | |
using SafeMath for uint256; | |
/// @notice Official record of token balances for each account | |
mapping (address => uint256) private _balances; | |
/// @notice Allowance amounts on behalf of others | |
mapping (address => mapping (address => uint256)) private _allowances; | |
/// @notice Total number of tokens in circulation | |
uint256 private _totalSupply; | |
/// @notice BEP-20 token decimals for this token | |
uint8 private _decimals; | |
/// @notice BEP-20 token symbol for this token | |
string private _symbol; | |
/// @notice BEP-20 token name for this token | |
string private _name; | |
/// @notice A record of each accounts delegate | |
mapping (address => address) public 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 => uint256) 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, uint256 previousBalance, uint256 newBalance); | |
/// @notice The standard BEP-20 transfer event | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
/// @notice The standard BEP-20 approval event | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
/** | |
* @notice Construct a new SXP token | |
* @param account The initial account to grant all the tokens | |
*/ | |
constructor(address account) public { | |
_name = "Swipe"; | |
_symbol = "SXP"; | |
_decimals = 18; | |
_totalSupply = 289714926e18; | |
_balances[account] = _totalSupply; | |
emit Transfer(address(0), account, _totalSupply); | |
} | |
/** | |
* @dev Returns the bep token owner. | |
*/ | |
function getOwner() external view returns (address) { | |
return owner(); | |
} | |
/** | |
* @dev Returns the token decimals. | |
*/ | |
function decimals() external view returns (uint8) { | |
return _decimals; | |
} | |
/** | |
* @dev Returns the token symbol. | |
*/ | |
function symbol() external view returns (string memory) { | |
return _symbol; | |
} | |
/** | |
* @dev Returns the token name. | |
*/ | |
function name() external view returns (string memory) { | |
return _name; | |
} | |
/** | |
* @dev Returns the total supply. | |
*/ | |
function totalSupply() external view returns (uint256) { | |
return _totalSupply; | |
} | |
/** | |
* @notice Get the number of tokens held by the `account` | |
* @param account The address of the account to get the balance of | |
* @return The number of tokens held | |
*/ | |
function balanceOf(address account) external view returns (uint256) { | |
return _balances[account]; | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param recipient The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address recipient, uint256 amount) external validLock permissionCheck returns (bool) { | |
_transfer(_msgSender(), recipient, amount); | |
return true; | |
} | |
/** | |
* @notice Get the number of tokens `spender` is approved to spend on behalf of `account` | |
* @param owner The address of the account holding the funds | |
* @param spender The address of the account spending the funds | |
* @return The number of tokens approved | |
*/ | |
function allowance(address owner, address spender) external view returns (uint256) { | |
return _allowances[owner][spender]; | |
} | |
/** | |
* @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 (2^256-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint256 amount) external validLock permissionCheck returns (bool) { | |
_approve(_msgSender(), spender, amount); | |
return true; | |
} | |
/** | |
* @notice Approve the spender to transferFrom(...) with the amount. | |
* @dev receiveApproval(...) is executed. | |
* @param amount The number of tokens that are approved | |
* @param data The data to pass to receiveApproval(...) | |
* @return true | |
*/ | |
function approveAndCall(address spender, uint256 amount, bytes memory data) public validLock permissionCheck returns (bool) { | |
_approve(_msgSender(), spender, amount); | |
ApproveAndCallFallBack(spender).receiveApproval(_msgSender(), amount, address(this), data); | |
return true; | |
} | |
/** | |
* @notice Transfer `amount` tokens from `src` to `dst` | |
* @param sender The address of the source account | |
* @param recipient The address of the destination account | |
* @param amount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address sender, address recipient, uint256 amount) external validLock permissionCheck returns (bool) { | |
_transfer(sender, recipient, amount); | |
address spender = _msgSender(); | |
uint256 spenderAllowance = _allowances[sender][spender]; | |
if (spenderAllowance != uint256(-1)) { | |
_approve(sender, spender, spenderAllowance.sub(amount, "The transfer amount exceeds allowance")); | |
} | |
return true; | |
} | |
/** | |
* @notice Atomically increases the allowance granted to `spender` by the caller | |
* @dev This is an alternative to {approve} that can be used as a mitigation for | |
* problems described in {BEP20-approve}. | |
* @param spender The address of the account which may transfer tokens | |
* @param addedValue The additional number of tokens to allow which may be spent | |
* @return Whether or not the approval succeeded | |
*/ | |
function increaseAllowance(address spender, uint256 addedValue) public validLock permissionCheck returns (bool) { | |
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].add(addedValue, "The increased allowance overflows")); | |
return true; | |
} | |
/** | |
* @notice Atomically increases the allowance granted to `spender` by the caller | |
* @dev This is an alternative to {approve} that can be used as a mitigation for | |
* problems described in {BEP20-approve}. | |
* @param spender The address of the account which may transfer tokens | |
* @param subtractedValue The subtractional number of tokens to allow which may be spent | |
* @return Whether or not the approval succeeded | |
*/ | |
function decreaseAllowance(address spender, uint256 subtractedValue) public validLock permissionCheck returns (bool) { | |
_approve(_msgSender(), spender, _allowances[_msgSender()][spender].sub(subtractedValue, "The decreased allowance below zero")); | |
return true; | |
} | |
/** | |
* @notice Destroy the amount of tokens from the sender, reducing the total supply. | |
* @dev The amount must be greater than balance, total supply. | |
* @param amount The number of tokens that are burnt | |
* @return true | |
*/ | |
function burn(uint256 amount) public validLock permissionCheck returns (bool) { | |
_burn(_msgSender(), amount); | |
return true; | |
} | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegatee The address to delegate votes to | |
*/ | |
function delegate(address delegatee) public validLock permissionCheck { | |
return _delegate(_msgSender(), 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, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s) public validLock permissionCheck { | |
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), "Invalid signature"); | |
require(nonce == nonces[signatory]++, "Invalid nonce"); | |
require(now <= expiry, "The 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 (uint96) { | |
uint32 nCheckpoints = numCheckpoints[account]; | |
return nCheckpoints > 0 ? ceil96(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, uint256 blockNumber) public view returns (uint96) { | |
require(blockNumber < block.number, "Not determined yet"); | |
uint32 nCheckpoints = numCheckpoints[account]; | |
if (nCheckpoints == 0) { | |
return 0; | |
} | |
// First check most recent balance | |
if (checkpoints[account][nCheckpoints - 1].fromBlock <= blockNumber) { | |
return ceil96(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 ceil96(cp.votes); | |
} else if (cp.fromBlock < blockNumber) { | |
lower = center; | |
} else { | |
upper = center - 1; | |
} | |
} | |
return ceil96(checkpoints[account][lower].votes); | |
} | |
function _transfer(address sender, address recipient, uint256 amount) internal { | |
require(sender != address(0), "Cannot transfer from the zero address"); | |
require(recipient != address(0), "Cannot transfer to the zero address"); | |
_balances[sender] = _balances[sender].sub(amount, "The transfer amount exceeds balance"); | |
_balances[recipient] = _balances[recipient].add(amount, "The balance overflows"); | |
emit Transfer(sender, recipient, amount); | |
_moveDelegates(delegates[sender], delegates[recipient], amount); | |
} | |
function _approve(address owner, address spender, uint256 amount) internal { | |
require(owner != address(0), "Cannot approve from the zero address"); | |
require(spender != address(0), "Cannot approve to the zero address"); | |
_allowances[owner][spender] = amount; | |
emit Approval(owner, spender, amount); | |
} | |
function _burn(address account, uint256 amount) internal { | |
require(account != address(0), "Cannot burn from the zero address"); | |
_balances[account] = _balances[account].sub(amount, "The burn amount exceeds balance"); | |
_totalSupply = _totalSupply.sub(amount); | |
emit Transfer(account, address(0), amount); | |
_moveDelegates(delegates[account], address(0), amount); | |
} | |
function _delegate(address delegator, address delegatee) internal { | |
address currentDelegate = delegates[delegator]; | |
uint256 delegatorBalance = _balances[delegator]; | |
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)) { | |
uint32 srcRepNum = numCheckpoints[srcRep]; | |
uint256 srcRepOld = srcRepNum > 0 ? checkpoints[srcRep][srcRepNum - 1].votes : 0; | |
uint256 srcRepNew = srcRepOld.sub(amount, "The vote amount underflows"); | |
_writeCheckpoint(srcRep, srcRepNum, srcRepOld, srcRepNew); | |
} | |
if (dstRep != address(0)) { | |
uint32 dstRepNum = numCheckpoints[dstRep]; | |
uint256 dstRepOld = dstRepNum > 0 ? checkpoints[dstRep][dstRepNum - 1].votes : 0; | |
uint256 dstRepNew = dstRepOld.add(amount, "The vote amount overflows"); | |
_writeCheckpoint(dstRep, dstRepNum, dstRepOld, dstRepNew); | |
} | |
} | |
} | |
function _writeCheckpoint(address delegatee, uint32 nCheckpoints, uint256 oldVotes, uint256 newVotes) internal { | |
uint32 blockNumber = safe32(block.number, "The 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(uint256 n, string memory errorMessage) internal pure returns (uint32) { | |
require(n < 2**32, errorMessage); | |
return uint32(n); | |
} | |
function ceil96(uint256 n) internal pure returns (uint96) { | |
if (n >= 2**96) { | |
return uint96(-1); | |
} | |
return uint96(n); | |
} | |
function getChainId() internal pure returns (uint256) { | |
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 "./SafeMath.sol"; | |
contract Timelock { | |
using SafeMath for uint; | |
event NewAdmin(address indexed newAdmin); | |
event NewPendingAdmin(address indexed newPendingAdmin); | |
event NewDelay(uint indexed newDelay); | |
event CancelTransaction(bytes32 indexed txHash, address indexed target, uint value, string signature, bytes data, uint eta); | |
event ExecuteTransaction(bytes32 indexed txHash, address indexed target, uint value, string signature, bytes data, uint eta); | |
event QueueTransaction(bytes32 indexed txHash, address indexed target, uint value, string signature, bytes data, uint eta); | |
uint public constant GRACE_PERIOD = 14 days; | |
uint public constant MINIMUM_DELAY = 2 days; | |
uint public constant MAXIMUM_DELAY = 30 days; | |
address public admin; | |
address public pendingAdmin; | |
uint public delay; | |
mapping (bytes32 => bool) public queuedTransactions; | |
constructor(address admin_, uint delay_) public { | |
require(delay_ >= MINIMUM_DELAY, "Timelock::constructor: Delay must exceed minimum delay."); | |
require(delay_ <= MAXIMUM_DELAY, "Timelock::setDelay: Delay must not exceed maximum delay."); | |
admin = admin_; | |
delay = delay_; | |
} | |
function() external payable { } | |
function setDelay(uint delay_) public { | |
require(msg.sender == address(this), "Timelock::setDelay: Call must come from Timelock."); | |
require(delay_ >= MINIMUM_DELAY, "Timelock::setDelay: Delay must exceed minimum delay."); | |
require(delay_ <= MAXIMUM_DELAY, "Timelock::setDelay: Delay must not exceed maximum delay."); | |
delay = delay_; | |
emit NewDelay(delay); | |
} | |
function acceptAdmin() public { | |
require(msg.sender == pendingAdmin, "Timelock::acceptAdmin: Call must come from pendingAdmin."); | |
admin = msg.sender; | |
pendingAdmin = address(0); | |
emit NewAdmin(admin); | |
} | |
function setPendingAdmin(address pendingAdmin_) public { | |
require(msg.sender == address(this), "Timelock::setPendingAdmin: Call must come from Timelock."); | |
pendingAdmin = pendingAdmin_; | |
emit NewPendingAdmin(pendingAdmin); | |
} | |
function queueTransaction(address target, uint value, string memory signature, bytes memory data, uint eta) public returns (bytes32) { | |
require(msg.sender == admin, "Timelock::queueTransaction: Call must come from admin."); | |
require(eta >= getBlockTimestamp().add(delay), "Timelock::queueTransaction: Estimated execution block must satisfy delay."); | |
bytes32 txHash = keccak256(abi.encode(target, value, signature, data, eta)); | |
queuedTransactions[txHash] = true; | |
emit QueueTransaction(txHash, target, value, signature, data, eta); | |
return txHash; | |
} | |
function cancelTransaction(address target, uint value, string memory signature, bytes memory data, uint eta) public { | |
require(msg.sender == admin, "Timelock::cancelTransaction: Call must come from admin."); | |
bytes32 txHash = keccak256(abi.encode(target, value, signature, data, eta)); | |
queuedTransactions[txHash] = false; | |
emit CancelTransaction(txHash, target, value, signature, data, eta); | |
} | |
function executeTransaction(address target, uint value, string memory signature, bytes memory data, uint eta) public payable returns (bytes memory) { | |
require(msg.sender == admin, "Timelock::executeTransaction: Call must come from admin."); | |
bytes32 txHash = keccak256(abi.encode(target, value, signature, data, eta)); | |
require(queuedTransactions[txHash], "Timelock::executeTransaction: Transaction hasn't been queued."); | |
require(getBlockTimestamp() >= eta, "Timelock::executeTransaction: Transaction hasn't surpassed time lock."); | |
require(getBlockTimestamp() <= eta.add(GRACE_PERIOD), "Timelock::executeTransaction: Transaction is stale."); | |
queuedTransactions[txHash] = false; | |
bytes memory callData; | |
if (bytes(signature).length == 0) { | |
callData = data; | |
} else { | |
callData = abi.encodePacked(bytes4(keccak256(bytes(signature))), data); | |
} | |
// solium-disable-next-line security/no-call-value | |
(bool success, bytes memory returnData) = target.call.value(value)(callData); | |
require(success, "Timelock::executeTransaction: Transaction execution reverted."); | |
emit ExecuteTransaction(txHash, target, value, signature, data, eta); | |
return returnData; | |
} | |
function getBlockTimestamp() internal view returns (uint) { | |
// solium-disable-next-line security/no-block-members | |
return block.timestamp; | |
} | |
} |
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 "./ErrorReporter.sol"; | |
import "./ComptrollerStorage.sol"; | |
/** | |
* @title ComptrollerCore | |
* @dev Storage for the comptroller is at this address, while execution is delegated to the `comptrollerImplementation`. | |
* VTokens 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 () external payable { | |
// 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: AGPL-3.0-or-later | |
// Copyright (C) 2017, 2018, 2019 dbrock, rain, mrchico | |
// This program is free software: you can redistribute it and/or modify | |
// it under the terms of the GNU Affero General Public License as published by | |
// the Free Software Foundation, either version 3 of the License, or | |
// (at your option) any later version. | |
// | |
// This program is distributed in the hope that it will be useful, | |
// but WITHOUT ANY WARRANTY; without even the implied warranty of | |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
// GNU Affero General Public License for more details. | |
// | |
// You should have received a copy of the GNU Affero General Public License | |
// along with this program. If not, see <https://www.gnu.org/licenses/>. | |
pragma solidity >=0.5.16; | |
import "./lib.sol"; | |
contract VAI is LibNote { | |
// --- Auth --- | |
mapping (address => uint) public wards; | |
function rely(address guy) external note auth { wards[guy] = 1; } | |
function deny(address guy) external note auth { wards[guy] = 0; } | |
modifier auth { | |
require(wards[msg.sender] == 1, "VAI/not-authorized"); | |
_; | |
} | |
// --- BEP20 Data --- | |
string public constant name = "VAI Stablecoin"; | |
string public constant symbol = "VAI"; | |
string public constant version = "1"; | |
uint8 public constant decimals = 18; | |
uint256 public totalSupply; | |
mapping (address => uint) public balanceOf; | |
mapping (address => mapping (address => uint)) public allowance; | |
mapping (address => uint) public nonces; | |
event Approval(address indexed src, address indexed guy, uint wad); | |
event Transfer(address indexed src, address indexed dst, uint wad); | |
// --- Math --- | |
function add(uint x, uint y) internal pure returns (uint z) { | |
require((z = x + y) >= x, "VAI math error"); | |
} | |
function sub(uint x, uint y) internal pure returns (uint z) { | |
require((z = x - y) <= x, "VAI math error"); | |
} | |
// --- EIP712 niceties --- | |
bytes32 public DOMAIN_SEPARATOR; | |
// bytes32 public constant PERMIT_TYPEHASH = keccak256("Permit(address holder,address spender,uint256 nonce,uint256 expiry,bool allowed)"); | |
bytes32 public constant PERMIT_TYPEHASH = 0xea2aa0a1be11a07ed86d755c93467f4f82362b452371d1ba94d1715123511acb; | |
constructor(uint256 chainId_) public { | |
wards[msg.sender] = 1; | |
DOMAIN_SEPARATOR = keccak256(abi.encode( | |
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), | |
keccak256(bytes(name)), | |
keccak256(bytes(version)), | |
chainId_, | |
address(this) | |
)); | |
} | |
// --- Token --- | |
function transfer(address dst, uint wad) external returns (bool) { | |
return transferFrom(msg.sender, dst, wad); | |
} | |
function transferFrom(address src, address dst, uint wad) | |
public returns (bool) | |
{ | |
require(balanceOf[src] >= wad, "VAI/insufficient-balance"); | |
if (src != msg.sender && allowance[src][msg.sender] != uint(-1)) { | |
require(allowance[src][msg.sender] >= wad, "VAI/insufficient-allowance"); | |
allowance[src][msg.sender] = sub(allowance[src][msg.sender], wad); | |
} | |
balanceOf[src] = sub(balanceOf[src], wad); | |
balanceOf[dst] = add(balanceOf[dst], wad); | |
emit Transfer(src, dst, wad); | |
return true; | |
} | |
function mint(address usr, uint wad) external auth { | |
balanceOf[usr] = add(balanceOf[usr], wad); | |
totalSupply = add(totalSupply, wad); | |
emit Transfer(address(0), usr, wad); | |
} | |
function burn(address usr, uint wad) external { | |
require(balanceOf[usr] >= wad, "VAI/insufficient-balance"); | |
if (usr != msg.sender && allowance[usr][msg.sender] != uint(-1)) { | |
require(allowance[usr][msg.sender] >= wad, "VAI/insufficient-allowance"); | |
allowance[usr][msg.sender] = sub(allowance[usr][msg.sender], wad); | |
} | |
balanceOf[usr] = sub(balanceOf[usr], wad); | |
totalSupply = sub(totalSupply, wad); | |
emit Transfer(usr, address(0), wad); | |
} | |
function approve(address usr, uint wad) external returns (bool) { | |
allowance[msg.sender][usr] = wad; | |
emit Approval(msg.sender, usr, wad); | |
return true; | |
} | |
// --- Alias --- | |
function push(address usr, uint wad) external { | |
transferFrom(msg.sender, usr, wad); | |
} | |
function pull(address usr, uint wad) external { | |
transferFrom(usr, msg.sender, wad); | |
} | |
function move(address src, address dst, uint wad) external { | |
transferFrom(src, dst, wad); | |
} | |
// --- Approve by signature --- | |
function permit(address holder, address spender, uint256 nonce, uint256 expiry, | |
bool allowed, uint8 v, bytes32 r, bytes32 s) external | |
{ | |
bytes32 digest = keccak256(abi.encodePacked( | |
"\x19\x01", | |
DOMAIN_SEPARATOR, | |
keccak256(abi.encode(PERMIT_TYPEHASH, | |
holder, | |
spender, | |
nonce, | |
expiry, | |
allowed)) | |
)); | |
require(holder != address(0), "VAI/invalid-address-0"); | |
require(holder == ecrecover(digest, v, r, s), "VAI/invalid-permit"); | |
require(expiry == 0 || now <= expiry, "VAI/permit-expired"); | |
require(nonce == nonces[holder]++, "VAI/invalid-nonce"); | |
uint wad = allowed ? uint(-1) : 0; | |
allowance[holder][spender] = wad; | |
emit Approval(holder, spender, wad); | |
} | |
} |
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 "./VToken.sol"; | |
import "./PriceOracle.sol"; | |
import "./ErrorReporter.sol"; | |
import "./Exponential.sol"; | |
import "./VAIControllerStorage.sol"; | |
import "./VAIUnitroller.sol"; | |
import "./VAI.sol"; | |
interface ComptrollerLensInterface { | |
function protocolPaused() external view returns (bool); | |
function mintedVAIs(address account) external view returns (uint); | |
function vaiMintRate() external view returns (uint); | |
function venusVAIRate() external view returns (uint); | |
function venusAccrued(address account) external view returns(uint); | |
function getAssetsIn(address account) external view returns (VToken[] memory); | |
function oracle() external view returns (PriceOracle); | |
function distributeVAIMinterVenus(address vaiMinter, bool distributeAll) external; | |
} | |
/** | |
* @title Venus's VAI Comptroller Contract | |
* @author Venus | |
*/ | |
contract VAIController is VAIControllerStorage, VAIControllerErrorReporter, Exponential { | |
/// @notice Emitted when Comptroller is changed | |
event NewComptroller(ComptrollerInterface oldComptroller, ComptrollerInterface newComptroller); | |
/** | |
* @notice Event emitted when VAI is minted | |
*/ | |
event MintVAI(address minter, uint mintVAIAmount); | |
/** | |
* @notice Event emitted when VAI is repaid | |
*/ | |
event RepayVAI(address repayer, uint repayVAIAmount); | |
/// @notice The initial Venus index for a market | |
uint224 public constant venusInitialIndex = 1e36; | |
/*** Main Actions ***/ | |
function mintVAI(uint mintVAIAmount) external returns (uint) { | |
if(address(comptroller) != address(0)) { | |
require(!ComptrollerLensInterface(address(comptroller)).protocolPaused(), "protocol is paused"); | |
address minter = msg.sender; | |
// Keep the flywheel moving | |
updateVenusVAIMintIndex(); | |
ComptrollerLensInterface(address(comptroller)).distributeVAIMinterVenus(minter, false); | |
uint oErr; | |
MathError mErr; | |
uint accountMintVAINew; | |
uint accountMintableVAI; | |
(oErr, accountMintableVAI) = getMintableVAI(minter); | |
if (oErr != uint(Error.NO_ERROR)) { | |
return uint(Error.REJECTION); | |
} | |
// check that user have sufficient mintableVAI balance | |
if (mintVAIAmount > accountMintableVAI) { | |
return fail(Error.REJECTION, FailureInfo.VAI_MINT_REJECTION); | |
} | |
(mErr, accountMintVAINew) = addUInt(ComptrollerLensInterface(address(comptroller)).mintedVAIs(minter), mintVAIAmount); | |
require(mErr == MathError.NO_ERROR, "VAI_MINT_AMOUNT_CALCULATION_FAILED"); | |
uint error = comptroller.setMintedVAIOf(minter, accountMintVAINew); | |
if (error != 0 ) { | |
return error; | |
} | |
VAI(getVAIAddress()).mint(minter, mintVAIAmount); | |
emit MintVAI(minter, mintVAIAmount); | |
return uint(Error.NO_ERROR); | |
} | |
} | |
/** | |
* @notice Repay VAI | |
*/ | |
function repayVAI(uint repayVAIAmount) external returns (uint) { | |
if(address(comptroller) != address(0)) { | |
require(!ComptrollerLensInterface(address(comptroller)).protocolPaused(), "protocol is paused"); | |
address repayer = msg.sender; | |
updateVenusVAIMintIndex(); | |
ComptrollerLensInterface(address(comptroller)).distributeVAIMinterVenus(repayer, false); | |
uint actualBurnAmount; | |
uint vaiBalance = ComptrollerLensInterface(address(comptroller)).mintedVAIs(repayer); | |
if(vaiBalance > repayVAIAmount) { | |
actualBurnAmount = repayVAIAmount; | |
} else { | |
actualBurnAmount = vaiBalance; | |
} | |
uint error = comptroller.setMintedVAIOf(repayer, vaiBalance - actualBurnAmount); | |
if (error != 0) { | |
return error; | |
} | |
VAI(getVAIAddress()).burn(repayer, actualBurnAmount); | |
emit RepayVAI(repayer, actualBurnAmount); | |
return uint(Error.NO_ERROR); | |
} | |
} | |
/** | |
* @notice Initialize the VenusVAIState | |
*/ | |
function _initializeVenusVAIState(uint blockNumber) external returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); | |
} | |
if (isVenusVAIInitialized == false) { | |
isVenusVAIInitialized = true; | |
uint vaiBlockNumber = blockNumber == 0 ? getBlockNumber() : blockNumber; | |
venusVAIState = VenusVAIState({ | |
index: venusInitialIndex, | |
block: safe32(vaiBlockNumber, "block number overflows") | |
}); | |
} | |
} | |
/** | |
* @notice Accrue XVS to by updating the VAI minter index | |
*/ | |
function updateVenusVAIMintIndex() public returns (uint) { | |
uint vaiMinterSpeed = ComptrollerLensInterface(address(comptroller)).venusVAIRate(); | |
uint blockNumber = getBlockNumber(); | |
uint deltaBlocks = sub_(blockNumber, uint(venusVAIState.block)); | |
if (deltaBlocks > 0 && vaiMinterSpeed > 0) { | |
uint vaiAmount = VAI(getVAIAddress()).totalSupply(); | |
uint venusAccrued = mul_(deltaBlocks, vaiMinterSpeed); | |
Double memory ratio = vaiAmount > 0 ? fraction(venusAccrued, vaiAmount) : Double({mantissa: 0}); | |
Double memory index = add_(Double({mantissa: venusVAIState.index}), ratio); | |
venusVAIState = VenusVAIState({ | |
index: safe224(index.mantissa, "new index overflows"), | |
block: safe32(blockNumber, "block number overflows") | |
}); | |
} else if (deltaBlocks > 0) { | |
venusVAIState.block = safe32(blockNumber, "block number overflows"); | |
} | |
} | |
/** | |
* @notice Calculate XVS accrued by a VAI minter | |
* @param vaiMinter The address of the VAI minter to distribute XVS to | |
*/ | |
function calcDistributeVAIMinterVenus(address vaiMinter) public returns(uint, uint, uint, uint) { | |
// Check caller is comptroller | |
if (msg.sender != address(comptroller)) { | |
return (fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK), 0, 0, 0); | |
} | |
Double memory vaiMintIndex = Double({mantissa: venusVAIState.index}); | |
Double memory vaiMinterIndex = Double({mantissa: venusVAIMinterIndex[vaiMinter]}); | |
venusVAIMinterIndex[vaiMinter] = vaiMintIndex.mantissa; | |
if (vaiMinterIndex.mantissa == 0 && vaiMintIndex.mantissa > 0) { | |
vaiMinterIndex.mantissa = venusInitialIndex; | |
} | |
Double memory deltaIndex = sub_(vaiMintIndex, vaiMinterIndex); | |
uint vaiMinterAmount = ComptrollerLensInterface(address(comptroller)).mintedVAIs(vaiMinter); | |
uint vaiMinterDelta = mul_(vaiMinterAmount, deltaIndex); | |
uint vaiMinterAccrued = add_(ComptrollerLensInterface(address(comptroller)).venusAccrued(vaiMinter), vaiMinterDelta); | |
return (uint(Error.NO_ERROR), vaiMinterAccrued, vaiMinterDelta, vaiMintIndex.mantissa); | |
} | |
/*** Admin Functions ***/ | |
/** | |
* @notice Sets a new comptroller | |
* @dev Admin function to set a new comptroller | |
* @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function _setComptroller(ComptrollerInterface comptroller_) public returns (uint) { | |
// Check caller is admin | |
if (msg.sender != admin) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.SET_COMPTROLLER_OWNER_CHECK); | |
} | |
ComptrollerInterface oldComptroller = comptroller; | |
comptroller = comptroller_; | |
emit NewComptroller(oldComptroller, comptroller_); | |
return uint(Error.NO_ERROR); | |
} | |
function _become(VAIUnitroller unitroller) public { | |
require(msg.sender == unitroller.admin(), "only unitroller admin can change brains"); | |
require(unitroller._acceptImplementation() == 0, "change not authorized"); | |
} | |
/** | |
* @dev Local vars for avoiding stack-depth limits in calculating account total supply balance. | |
* Note that `vTokenBalance` is the number of vTokens the account owns in the market, | |
* whereas `borrowBalance` is the amount of underlying that the account has borrowed. | |
*/ | |
struct AccountAmountLocalVars { | |
uint totalSupplyAmount; | |
uint sumSupply; | |
uint sumBorrowPlusEffects; | |
uint vTokenBalance; | |
uint borrowBalance; | |
uint exchangeRateMantissa; | |
uint oraclePriceMantissa; | |
Exp collateralFactor; | |
Exp exchangeRate; | |
Exp oraclePrice; | |
Exp tokensToDenom; | |
} | |
function getMintableVAI(address minter) public view returns (uint, uint) { | |
PriceOracle oracle = ComptrollerLensInterface(address(comptroller)).oracle(); | |
VToken[] memory enteredMarkets = ComptrollerLensInterface(address(comptroller)).getAssetsIn(minter); | |
AccountAmountLocalVars memory vars; // Holds all our calculation results | |
uint oErr; | |
MathError mErr; | |
uint accountMintableVAI; | |
uint i; | |
/** | |
* We use this formula to calculate mintable VAI amount. | |
* totalSupplyAmount * VAIMintRate - (totalBorrowAmount + mintedVAIOf) | |
*/ | |
for (i = 0; i < enteredMarkets.length; i++) { | |
(oErr, vars.vTokenBalance, vars.borrowBalance, vars.exchangeRateMantissa) = enteredMarkets[i].getAccountSnapshot(minter); | |
if (oErr != 0) { // semi-opaque error code, we assume NO_ERROR == 0 is invariant between upgrades | |
return (uint(Error.SNAPSHOT_ERROR), 0); | |
} | |
vars.exchangeRate = Exp({mantissa: vars.exchangeRateMantissa}); | |
// Get the normalized price of the asset | |
vars.oraclePriceMantissa = oracle.getUnderlyingPrice(enteredMarkets[i]); | |
if (vars.oraclePriceMantissa == 0) { | |
return (uint(Error.PRICE_ERROR), 0); | |
} | |
vars.oraclePrice = Exp({mantissa: vars.oraclePriceMantissa}); | |
(mErr, vars.tokensToDenom) = mulExp(vars.exchangeRate, vars.oraclePrice); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
// sumSupply += tokensToDenom * vTokenBalance | |
(mErr, vars.sumSupply) = mulScalarTruncateAddUInt(vars.tokensToDenom, vars.vTokenBalance, vars.sumSupply); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
// sumBorrowPlusEffects += oraclePrice * borrowBalance | |
(mErr, vars.sumBorrowPlusEffects) = mulScalarTruncateAddUInt(vars.oraclePrice, vars.borrowBalance, vars.sumBorrowPlusEffects); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
} | |
(mErr, vars.sumBorrowPlusEffects) = addUInt(vars.sumBorrowPlusEffects, ComptrollerLensInterface(address(comptroller)).mintedVAIs(minter)); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.MATH_ERROR), 0); | |
} | |
(mErr, accountMintableVAI) = mulUInt(vars.sumSupply, ComptrollerLensInterface(address(comptroller)).vaiMintRate()); | |
require(mErr == MathError.NO_ERROR, "VAI_MINT_AMOUNT_CALCULATION_FAILED"); | |
(mErr, accountMintableVAI) = divUInt(accountMintableVAI, 10000); | |
require(mErr == MathError.NO_ERROR, "VAI_MINT_AMOUNT_CALCULATION_FAILED"); | |
(mErr, accountMintableVAI) = subUInt(accountMintableVAI, vars.sumBorrowPlusEffects); | |
if (mErr != MathError.NO_ERROR) { | |
return (uint(Error.REJECTION), 0); | |
} | |
return (uint(Error.NO_ERROR), accountMintableVAI); | |
} | |
function getBlockNumber() public view returns (uint) { | |
return block.number; | |
} | |
/** | |
* @notice Return the address of the VAI token | |
* @return The address of VAI | |
*/ | |
function getVAIAddress() public view returns (address) { | |
return 0x4BD17003473389A42DAF6a0a729f6Fdb328BbBd7; | |
} | |
} |
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; | |
contract VAIControllerInterface { | |
function getVAIAddress() public view returns (address); | |
function getMintableVAI(address minter) public view returns (uint, uint); | |
function mintVAI(address minter, uint mintVAIAmount) external returns (uint); | |
function repayVAI(address repayer, uint repayVAIAmount) external returns (uint); | |
function _initializeVenusVAIState(uint blockNumber) external returns (uint); | |
function updateVenusVAIMintIndex() external returns (uint); | |
function calcDistributeVAIMinterVenus(address vaiMinter) external returns(uint, uint, uint, uint); | |
} |
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 "./ComptrollerInterface.sol"; | |
contract VAIUnitrollerAdminStorage { | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address public pendingAdmin; | |
/** | |
* @notice Active brains of Unitroller | |
*/ | |
address public vaiControllerImplementation; | |
/** | |
* @notice Pending brains of Unitroller | |
*/ | |
address public pendingVAIControllerImplementation; | |
} | |
contract VAIControllerStorage is VAIUnitrollerAdminStorage { | |
ComptrollerInterface public comptroller; | |
struct VenusVAIState { | |
/// @notice The last updated venusVAIMintIndex | |
uint224 index; | |
/// @notice The block number the index was last updated at | |
uint32 block; | |
} | |
/// @notice The Venus VAI state | |
VenusVAIState public venusVAIState; | |
/// @notice The Venus VAI state initialized | |
bool public isVenusVAIInitialized; | |
/// @notice The Venus VAI minter index as of the last time they accrued XVS | |
mapping(address => uint) public venusVAIMinterIndex; | |
} |
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 "./ErrorReporter.sol"; | |
import "./VAIControllerStorage.sol"; | |
contract VAIUnitroller is VAIUnitrollerAdminStorage, VAIControllerErrorReporter { | |
/** | |
* @notice Emitted when pendingVAIControllerImplementation is changed | |
*/ | |
event NewPendingImplementation(address oldPendingImplementation, address newPendingImplementation); | |
/** | |
* @notice Emitted when pendingVAIControllerImplementation 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 = pendingVAIControllerImplementation; | |
pendingVAIControllerImplementation = newPendingImplementation; | |
emit NewPendingImplementation(oldPendingImplementation, pendingVAIControllerImplementation); | |
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 | |
if (msg.sender != pendingVAIControllerImplementation) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldImplementation = vaiControllerImplementation; | |
address oldPendingImplementation = pendingVAIControllerImplementation; | |
vaiControllerImplementation = pendingVAIControllerImplementation; | |
pendingVAIControllerImplementation = address(0); | |
emit NewImplementation(oldImplementation, vaiControllerImplementation); | |
emit NewPendingImplementation(oldPendingImplementation, pendingVAIControllerImplementation); | |
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 | |
if (msg.sender != pendingAdmin) { | |
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 () external payable { | |
// delegate all other functions to current implementation | |
(bool success, ) = vaiControllerImplementation.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
pragma solidity ^0.5.16; | |
import "./SafeBEP20.sol"; | |
import "./IBEP20.sol"; | |
import "./VAIVaultProxy.sol"; | |
import "./VAIVaultStorage.sol"; | |
import "./VAIVaultErrorReporter.sol"; | |
contract VAIVault is VAIVaultStorage { | |
using SafeMath for uint256; | |
using SafeBEP20 for IBEP20; | |
/// @notice Event emitted when VAI deposit | |
event Deposit(address indexed user, uint256 amount); | |
/// @notice Event emitted when VAI withrawal | |
event Withdraw(address indexed user, uint256 amount); | |
/// @notice Event emitted when admin changed | |
event AdminTransfered(address indexed oldAdmin, address indexed newAdmin); | |
constructor() public { | |
admin = msg.sender; | |
} | |
modifier onlyAdmin() { | |
require(msg.sender == admin, "only admin can"); | |
_; | |
} | |
/*** 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 | |
} | |
/** | |
* @notice Deposit VAI to VAIVault for XVS allocation | |
* @param _amount The amount to deposit to vault | |
*/ | |
function deposit(uint256 _amount) public nonReentrant { | |
UserInfo storage user = userInfo[msg.sender]; | |
updateVault(); | |
// Transfer pending tokens to user | |
updateAndPayOutPending(msg.sender); | |
// Transfer in the amounts from user | |
if(_amount > 0) { | |
vai.safeTransferFrom(address(msg.sender), address(this), _amount); | |
user.amount = user.amount.add(_amount); | |
} | |
user.rewardDebt = user.amount.mul(accXVSPerShare).div(1e18); | |
emit Deposit(msg.sender, _amount); | |
} | |
/** | |
* @notice Withdraw VAI from VAIVault | |
* @param _amount The amount to withdraw from vault | |
*/ | |
function withdraw(uint256 _amount) public nonReentrant { | |
_withdraw(msg.sender, _amount); | |
} | |
/** | |
* @notice Claim XVS from VAIVault | |
*/ | |
function claim() public nonReentrant { | |
_withdraw(msg.sender, 0); | |
} | |
/** | |
* @notice Low level withdraw function | |
* @param account The account to withdraw from vault | |
* @param _amount The amount to withdraw from vault | |
*/ | |
function _withdraw(address account, uint256 _amount) internal { | |
UserInfo storage user = userInfo[account]; | |
require(user.amount >= _amount, "withdraw: not good"); | |
updateVault(); | |
updateAndPayOutPending(account); // Update balances of account this is not withdrawal but claiming XVS farmed | |
if(_amount > 0) { | |
user.amount = user.amount.sub(_amount); | |
vai.safeTransfer(address(account), _amount); | |
} | |
user.rewardDebt = user.amount.mul(accXVSPerShare).div(1e18); | |
emit Withdraw(account, _amount); | |
} | |
/** | |
* @notice View function to see pending XVS on frontend | |
* @param _user The user to see pending XVS | |
*/ | |
function pendingXVS(address _user) public view returns (uint256) | |
{ | |
UserInfo storage user = userInfo[_user]; | |
return user.amount.mul(accXVSPerShare).div(1e18).sub(user.rewardDebt); | |
} | |
/** | |
* @notice Update and pay out pending XVS to user | |
* @param account The user to pay out | |
*/ | |
function updateAndPayOutPending(address account) internal { | |
uint256 pending = pendingXVS(account); | |
if(pending > 0) { | |
safeXVSTransfer(account, pending); | |
} | |
} | |
/** | |
* @notice Safe XVS transfer function, just in case if rounding error causes pool to not have enough XVS | |
* @param _to The address that XVS to be transfered | |
* @param _amount The amount that XVS to be transfered | |
*/ | |
function safeXVSTransfer(address _to, uint256 _amount) internal { | |
uint256 xvsBal = xvs.balanceOf(address(this)); | |
if (_amount > xvsBal) { | |
xvs.transfer(_to, xvsBal); | |
xvsBalance = xvs.balanceOf(address(this)); | |
} else { | |
xvs.transfer(_to, _amount); | |
xvsBalance = xvs.balanceOf(address(this)); | |
} | |
} | |
/** | |
* @notice Function that updates pending rewards | |
*/ | |
function updatePendingRewards() public { | |
uint256 newRewards = xvs.balanceOf(address(this)).sub(xvsBalance); | |
if(newRewards > 0) { | |
xvsBalance = xvs.balanceOf(address(this)); // If there is no change the balance didn't change | |
pendingRewards = pendingRewards.add(newRewards); | |
} | |
} | |
/** | |
* @notice Update reward variables to be up-to-date | |
*/ | |
function updateVault() internal { | |
uint256 vaiBalance = vai.balanceOf(address(this)); | |
if (vaiBalance == 0) { // avoids division by 0 errors | |
return; | |
} | |
accXVSPerShare = accXVSPerShare.add(pendingRewards.mul(1e18).div(vaiBalance)); | |
pendingRewards = 0; | |
} | |
/** | |
* @dev Returns the address of the current admin | |
*/ | |
function getAdmin() public view returns (address) { | |
return admin; | |
} | |
/** | |
* @dev Burn the current admin | |
*/ | |
function burnAdmin() public onlyAdmin { | |
emit AdminTransfered(admin, address(0)); | |
admin = address(0); | |
} | |
/** | |
* @dev Set the current admin to new address | |
*/ | |
function setNewAdmin(address newAdmin) public onlyAdmin { | |
require(newAdmin != address(0), "new owner is the zero address"); | |
emit AdminTransfered(admin, newAdmin); | |
admin = newAdmin; | |
} | |
/*** Admin Functions ***/ | |
function _become(VAIVaultProxy vaiVaultProxy) public { | |
require(msg.sender == vaiVaultProxy.admin(), "only proxy admin can change brains"); | |
require(vaiVaultProxy._acceptImplementation() == 0, "change not authorized"); | |
} | |
function setVenusInfo(address _xvs, address _vai) public onlyAdmin { | |
xvs = IBEP20(_xvs); | |
vai = IBEP20(_vai); | |
_notEntered = true; | |
} | |
} |
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; | |
contract VAIVaultErrorReporter { | |
enum Error { | |
NO_ERROR, | |
UNAUTHORIZED | |
} | |
enum FailureInfo { | |
ACCEPT_ADMIN_PENDING_ADMIN_CHECK, | |
ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK, | |
SET_PENDING_ADMIN_OWNER_CHECK, | |
SET_PENDING_IMPLEMENTATION_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); | |
} | |
} |
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 "./VAIVaultStorage.sol"; | |
import "./VAIVaultErrorReporter.sol"; | |
contract VAIVaultProxy is VAIVaultAdminStorage, VAIVaultErrorReporter { | |
/** | |
* @notice Emitted when pendingVAIVaultImplementation is changed | |
*/ | |
event NewPendingImplementation(address oldPendingImplementation, address newPendingImplementation); | |
/** | |
* @notice Emitted when pendingVAIVaultImplementation is accepted, which means VAI Vault 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 = pendingVAIVaultImplementation; | |
pendingVAIVaultImplementation = newPendingImplementation; | |
emit NewPendingImplementation(oldPendingImplementation, pendingVAIVaultImplementation); | |
return uint(Error.NO_ERROR); | |
} | |
/** | |
* @notice Accepts new implementation of VAI Vault. 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 | |
if (msg.sender != pendingVAIVaultImplementation) { | |
return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK); | |
} | |
// Save current values for inclusion in log | |
address oldImplementation = vaiVaultImplementation; | |
address oldPendingImplementation = pendingVAIVaultImplementation; | |
vaiVaultImplementation = pendingVAIVaultImplementation; | |
pendingVAIVaultImplementation = address(0); | |
emit NewImplementation(oldImplementation, vaiVaultImplementation); | |
emit NewPendingImplementation(oldPendingImplementation, pendingVAIVaultImplementation); | |
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 | |
if (msg.sender != pendingAdmin) { | |
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 () external payable { | |
// delegate all other functions to current implementation | |
(bool success, ) = vaiVaultImplementation.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
pragma solidity ^0.5.16; | |
import "./SafeMath.sol"; | |
import "./IBEP20.sol"; | |
contract VAIVaultAdminStorage { | |
/** | |
* @notice Administrator for this contract | |
*/ | |
address public admin; | |
/** | |
* @notice Pending administrator for this contract | |
*/ | |
address public pendingAdmin; | |
/** | |
* @notice Active brains of VAI Vault | |
*/ | |
address public vaiVaultImplementation; | |
/** | |
* @notice Pending brains of VAI Vault | |
*/ | |
address public pendingVAIVaultImplementation; | |
} | |
contract VAIVaultStorage is VAIVaultAdminStorage { | |
/// @notice The XVS TOKEN! | |
IBEP20 public xvs; | |
/// @notice The VAI TOKEN! | |
IBEP20 public vai; | |
/// @notice Guard variable for re-entrancy checks | |
bool internal _notEntered; | |
/// @notice XVS balance of vault | |
uint256 public xvsBalance; | |
/// @notice Accumulated XVS per share | |
uint256 public accXVSPerShare; | |
//// pending rewards awaiting anyone to update | |
uint256 public pendingRewards; | |
/// @notice Info of each user. | |
struct UserInfo { | |
uint256 amount; | |
uint256 rewardDebt; | |
} | |
// Info of each user that stakes tokens. | |
mapping(address => UserInfo) public userInfo; | |
} |
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 "./VToken.sol"; | |
/** | |
* @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"); | |
} | |
} |
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 "./VBep20.sol"; | |
/** | |
* @title Venus's VBep20Delegate Contract | |
* @notice VTokens which wrap an EIP-20 underlying and are delegated to | |
* @author Venus | |
*/ | |
contract VBep20Delegate is VBep20, VDelegateInterface { | |
/** | |
* @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 "./VTokenInterfaces.sol"; | |
/** | |
* @title Venus's VBep20Delegator Contract | |
* @notice VTokens which wrap an EIP-20 underlying and delegate to an implementation | |
* @author Venus | |
*/ | |
contract VBep20Delegator is VTokenInterface, VBep20Interface, VDelegatorInterface { | |
/** | |
* @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_ BEP-20 name of this token | |
* @param symbol_ BEP-20 symbol of this token | |
* @param decimals_ BEP-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, "VBep20Delegator::_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 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) { | |
mintAmount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
redeemTokens; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
redeemAmount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
borrowAmount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
repayAmount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
borrower; repayAmount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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 0=success, otherwise a failure (see ErrorReporter.sol for details) | |
*/ | |
function liquidateBorrow(address borrower, uint repayAmount, VTokenInterface vTokenCollateral) external returns (uint) { | |
borrower; repayAmount; vTokenCollateral; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
dst; amount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
src; dst; amount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
spender; amount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
owner; spender; // Shh | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @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) { | |
owner; // Shh | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @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) { | |
owner; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
account; // Shh | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @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) { | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @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) { | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @notice Returns the current total borrows plus accrued interest | |
* @return The total borrows with interest | |
*/ | |
function totalBorrowsCurrent() external returns (uint) { | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
account; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
account; // Shh | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @notice Accrue interest then return the up-to-date exchange rate | |
* @return Calculated exchange rate scaled by 1e18 | |
*/ | |
function exchangeRateCurrent() public returns (uint) { | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @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) { | |
delegateToViewAndReturn(); | |
} | |
/** | |
* @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) { | |
delegateAndReturn(); | |
} | |
/** | |
* @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 returns (uint) { | |
liquidator; borrower; seizeTokens; // Shh | |
delegateAndReturn(); | |
} | |
/*** 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) { | |
newPendingAdmin; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
newComptroller; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
newReserveFactorMantissa; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
addAmount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
reduceAmount; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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) { | |
newInterestRateModel; // Shh | |
delegateAndReturn(); | |
} | |
/** | |
* @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)); | |
} | |
function delegateToViewAndReturn() private view returns (bytes memory) { | |
(bool success, ) = address(this).staticcall(abi.encodeWithSignature("delegateToImplementation(bytes)", 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(add(free_mem_ptr, 0x40), returndatasize) } | |
} | |
} | |
function delegateAndReturn() private returns (bytes memory) { | |
(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) } | |
} | |
} | |
/** | |
* @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,"VBep20Delegator:fallback: cannot send value to fallback"); | |
// delegate all other functions to current implementation | |
delegateAndReturn(); | |
} | |
} |
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 "./VBep20.sol"; | |
/** | |
* @title Venus's VBep20Immutable Contract | |
* @notice VTokens which wrap an EIP-20 underlying and are immutable | |
* @author Venus | |
*/ | |
contract VBep20Immutable is VBep20 { | |
/** | |
* @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_ BEP-20 name of this token | |
* @param symbol_ BEP-20 symbol of this token | |
* @param decimals_ BEP-20 decimal precision of this token | |
* @param admin_ Address of the administrator of this token | |
*/ | |
constructor(address underlying_, | |
ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_, | |
address payable admin_) public { | |
// Creator of the contract is admin during initialization | |
admin = msg.sender; | |
// Initialize the market | |
initialize(underlying_, comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_); | |
// Set the proper admin now that initialization is done | |
admin = admin_; | |
} | |
} |
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 "./VToken.sol"; | |
/** | |
* @title Venus's VBNB Contract | |
* @notice VToken which wraps BNB | |
* @author Venus | |
*/ | |
contract VBNB is VToken { | |
/** | |
* @notice Construct a new VBNB 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_ BEP-20 name of this token | |
* @param symbol_ BEP-20 symbol of this token | |
* @param decimals_ BEP-20 decimal precision of this token | |
* @param admin_ Address of the administrator of this token | |
*/ | |
constructor(ComptrollerInterface comptroller_, | |
InterestRateModel interestRateModel_, | |
uint initialExchangeRateMantissa_, | |
string memory name_, | |
string memory symbol_, | |
uint8 decimals_, | |
address payable admin_) public { | |
// Creator of the contract is admin during initialization | |
admin = msg.sender; | |
initialize(comptroller_, interestRateModel_, initialExchangeRateMantissa_, name_, symbol_, decimals_); | |
// Set the proper admin now that initialization is done | |
admin = admin_; | |
} | |
/*** User Interface ***/ | |
/** | |
* @notice Sender supplies assets into the market and receives vTokens in exchange | |
* @dev Reverts upon any failure | |
*/ | |
function mint() external payable { | |
(uint err,) = mintInternal(msg.value); | |
requireNoError(err, "mint failed"); | |
} | |
/** | |
* @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 | |
* @dev Reverts upon any failure | |
*/ | |
function repayBorrow() external payable { | |
(uint err,) = repayBorrowInternal(msg.value); | |
requireNoError(err, "repayBorrow failed"); | |
} | |
/** | |
* @notice Sender repays a borrow belonging to borrower | |
* @dev Reverts upon any failure | |
* @param borrower the account with the debt being payed off | |
*/ | |
function repayBorrowBehalf(address borrower) external payable { | |
(uint err,) = repayBorrowBehalfInternal(borrower, msg.value); | |
requireNoError(err, "repayBorrowBehalf failed"); | |
} | |
/** | |
* @notice The sender liquidates the borrowers collateral. | |
* The collateral seized is transferred to the liquidator. | |
* @dev Reverts upon any failure | |
* @param borrower The borrower of this vToken to be liquidated | |
* @param vTokenCollateral The market in which to seize collateral from the borrower | |
*/ | |
function liquidateBorrow(address borrower, VToken vTokenCollateral) external payable { | |
(uint err,) = liquidateBorrowInternal(borrower, msg.value, vTokenCollateral); | |
requireNoError(err, "liquidateBorrow failed"); | |
} | |
/** | |
* @notice Send BNB to VBNB to mint | |
*/ | |
function () external payable { | |
(uint err,) = mintInternal(msg.value); | |
requireNoError(err, "mint failed"); | |
} | |
/*** Safe Token ***/ | |
/** | |
* @notice Gets balance of this contract in terms of BNB, before this message | |
* @dev This excludes the value of the current message, if any | |
* @return The quantity of BNB owned by this contract | |
*/ | |
function getCashPrior() internal view returns (uint) { | |
(MathError err, uint startingBalance) = subUInt(address(this).balance, msg.value); | |
require(err == MathError.NO_ERROR, "cash prior math error"); | |
return startingBalance; | |
} | |
/** | |
* @notice Perform the actual transfer in, which is a no-op | |
* @param from Address sending the BNB | |
* @param amount Amount of BNB being sent | |
* @return The actual amount of BNB transferred | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (uint) { | |
// Sanity checks | |
require(msg.sender == from, "sender mismatch"); | |
require(msg.value == amount, "value mismatch"); | |
return amount; | |
} | |
function doTransferOut(address payable to, uint amount) internal { | |
/* Send the BNB, with minimal gas and revert on failure */ | |
to.transfer(amount); | |
} | |
function requireNoError(uint errCode, string memory message) internal pure { | |
if (errCode == uint(Error.NO_ERROR)) { | |
return; | |
} | |
bytes memory fullMessage = new bytes(bytes(message).length + 5); | |
uint i; | |
for (i = 0; i < bytes(message).length; i++) { | |
fullMessage[i] = bytes(message)[i]; | |
} | |
fullMessage[i+0] = byte(uint8(32)); | |
fullMessage[i+1] = byte(uint8(40)); | |
fullMessage[i+2] = byte(uint8(48 + ( errCode / 10 ))); | |
fullMessage[i+3] = byte(uint8(48 + ( errCode % 10 ))); | |
fullMessage[i+4] = byte(uint8(41)); | |
require(errCode == uint(Error.NO_ERROR), string(fullMessage)); | |
} | |
} |
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 "./VBep20Delegate.sol"; | |
/** | |
* @title Venus's VDai Contract | |
* @notice VToken which wraps Multi-Collateral DAI | |
* @author Venus | |
*/ | |
contract VDaiDelegate is VBep20Delegate { | |
/** | |
* @notice DAI adapter address | |
*/ | |
address public daiJoinAddress; | |
/** | |
* @notice DAI Savings Rate (DSR) pot address | |
*/ | |
address public potAddress; | |
/** | |
* @notice DAI vat address | |
*/ | |
address public vatAddress; | |
/** | |
* @notice Delegate interface to become the implementation | |
* @param data The encoded arguments for becoming | |
*/ | |
function _becomeImplementation(bytes memory data) public { | |
require(msg.sender == admin, "only the admin may initialize the implementation"); | |
(address daiJoinAddress_, address potAddress_) = abi.decode(data, (address, address)); | |
return _becomeImplementation(daiJoinAddress_, potAddress_); | |
} | |
/** | |
* @notice Explicit interface to become the implementation | |
* @param daiJoinAddress_ DAI adapter address | |
* @param potAddress_ DAI Savings Rate (DSR) pot address | |
*/ | |
function _becomeImplementation(address daiJoinAddress_, address potAddress_) internal { | |
// Get dai and vat and sanity check the underlying | |
DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress_); | |
PotLike pot = PotLike(potAddress_); | |
GemLike dai = daiJoin.dai(); | |
VatLike vat = daiJoin.vat(); | |
require(address(dai) == underlying, "DAI must be the same as underlying"); | |
// Remember the relevant addresses | |
daiJoinAddress = daiJoinAddress_; | |
potAddress = potAddress_; | |
vatAddress = address(vat); | |
// Approve moving our DAI into the vat through daiJoin | |
dai.approve(daiJoinAddress, uint(-1)); | |
// Approve the pot to transfer our funds within the vat | |
vat.hope(potAddress); | |
vat.hope(daiJoinAddress); | |
// Accumulate DSR interest -- must do this in order to doTransferIn | |
pot.drip(); | |
// Transfer all cash in (doTransferIn does this regardless of amount) | |
doTransferIn(address(this), 0); | |
} | |
/** | |
* @notice Delegate interface to resign the implementation | |
*/ | |
function _resignImplementation() public { | |
require(msg.sender == admin, "only the admin may abandon the implementation"); | |
// Transfer all cash out of the DSR - note that this relies on self-transfer | |
DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress); | |
PotLike pot = PotLike(potAddress); | |
VatLike vat = VatLike(vatAddress); | |
// Accumulate interest | |
pot.drip(); | |
// Calculate the total amount in the pot, and move it out | |
uint pie = pot.pie(address(this)); | |
pot.exit(pie); | |
// Checks the actual balance of DAI in the vat after the pot exit | |
uint bal = vat.dai(address(this)); | |
// Remove our whole balance | |
daiJoin.exit(address(this), bal / RAY); | |
} | |
/*** VToken Overrides ***/ | |
/** | |
* @notice Accrues DSR then 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) { | |
// Accumulate DSR interest | |
PotLike(potAddress).drip(); | |
// Accumulate VToken interest | |
return super.accrueInterest(); | |
} | |
/*** 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) { | |
PotLike pot = PotLike(potAddress); | |
uint pie = pot.pie(address(this)); | |
return mul(pot.chi(), pie) / RAY; | |
} | |
/** | |
* @notice Transfer the underlying to this contract and sweep into DSR pot | |
* @param from Address to transfer funds from | |
* @param amount Amount of underlying to transfer | |
* @return The actual amount that is transferred | |
*/ | |
function doTransferIn(address from, uint amount) internal returns (uint) { | |
// Perform the EIP-20 transfer in | |
EIP20Interface token = EIP20Interface(underlying); | |
require(token.transferFrom(from, address(this), amount), "unexpected EIP-20 transfer in return"); | |
DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress); | |
GemLike dai = GemLike(underlying); | |
PotLike pot = PotLike(potAddress); | |
VatLike vat = VatLike(vatAddress); | |
// Convert all our DAI to internal DAI in the vat | |
daiJoin.join(address(this), dai.balanceOf(address(this))); | |
// Checks the actual balance of DAI in the vat after the join | |
uint bal = vat.dai(address(this)); | |
// Calculate the percentage increase to th pot for the entire vat, and move it in | |
// Note: We may leave a tiny bit of DAI in the vat...but we do the whole thing every time | |
uint pie = bal / pot.chi(); | |
pot.join(pie); | |
return amount; | |
} | |
/** | |
* @notice Transfer the underlying from this contract, after sweeping out of DSR pot | |
* @param to Address to transfer funds to | |
* @param amount Amount of underlying to transfer | |
*/ | |
function doTransferOut(address payable to, uint amount) internal { | |
DaiJoinLike daiJoin = DaiJoinLike(daiJoinAddress); | |
PotLike pot = PotLike(potAddress); | |
// Calculate the percentage decrease from the pot, and move that much out | |
// Note: Use a slightly larger pie size to ensure that we get at least amount in the vat | |
uint pie = add(mul(amount, RAY) / pot.chi(), 1); | |
pot.exit(pie); | |
daiJoin.exit(to, amount); | |
} | |
/*** Maker Internals ***/ | |
uint256 constant RAY = 10 ** 27; | |
function add(uint x, uint y) internal pure returns (uint z) { | |
require((z = x + y) >= x, "add-overflow"); | |
} | |
function mul(uint x, uint y) internal pure returns (uint z) { | |
require(y == 0 || (z = x * y) / y == x, "mul-overflow"); | |
} | |
} | |
/*** Maker Interfaces ***/ | |
interface PotLike { | |
function chi() external view returns (uint); | |
function pie(address) external view returns (uint); | |
function drip() external returns (uint); | |
function join(uint) external; | |
function exit(uint) external; | |
} | |
interface GemLike { | |
function approve(address, uint) external; | |
function balanceOf(address) external view returns (uint); | |
function transferFrom(address, address, uint) external returns (bool); | |
} | |
interface VatLike { | |
function dai(address) external view returns (uint); | |
function hope(address) external; | |
} | |
interface DaiJoinLike { | |
function vat() external returns (VatLike); | |
function dai() external returns (GemLike); | |
function join(address, uint) external payable; | |
function exit(address, uint) external; | |
} |
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; | |
pragma experimental ABIEncoderV2; | |
import "./VBep20.sol"; | |
import "./VToken.sol"; | |
import "./PriceOracle.sol"; | |
import "./EIP20Interface.sol"; | |
import "./Governance/GovernorAlpha.sol"; | |
import "./XVS.sol"; | |
interface ComptrollerLensInterface { | |
function markets(address) external view returns (bool, uint); | |
function oracle() external view returns (PriceOracle); | |
function getAccountLiquidity(address) external view returns (uint, uint, uint); | |
function getAssetsIn(address) external view returns (VToken[] memory); | |
function claimVenus(address) external; | |
function venusAccrued(address) external view returns (uint); | |
} | |
contract VenusLens { | |
struct VTokenMetadata { | |
address vToken; | |
uint exchangeRateCurrent; | |
uint supplyRatePerBlock; | |
uint borrowRatePerBlock; | |
uint reserveFactorMantissa; | |
uint totalBorrows; | |
uint totalReserves; | |
uint totalSupply; | |
uint totalCash; | |
bool isListed; | |
uint collateralFactorMantissa; | |
address underlyingAssetAddress; | |
uint vTokenDecimals; | |
uint underlyingDecimals; | |
} | |
function vTokenMetadata(VToken vToken) public returns (VTokenMetadata memory) { | |
uint exchangeRateCurrent = vToken.exchangeRateCurrent(); | |
ComptrollerLensInterface comptroller = ComptrollerLensInterface(address(vToken.comptroller())); | |
(bool isListed, uint collateralFactorMantissa) = comptroller.markets(address(vToken)); | |
address underlyingAssetAddress; | |
uint underlyingDecimals; | |
if (compareStrings(vToken.symbol(), "vBNB")) { | |
underlyingAssetAddress = address(0); | |
underlyingDecimals = 18; | |
} else { | |
VBep20 vBep20 = VBep20(address(vToken)); | |
underlyingAssetAddress = vBep20.underlying(); | |
underlyingDecimals = EIP20Interface(vBep20.underlying()).decimals(); | |
} | |
return VTokenMetadata({ | |
vToken: address(vToken), | |
exchangeRateCurrent: exchangeRateCurrent, | |
supplyRatePerBlock: vToken.supplyRatePerBlock(), | |
borrowRatePerBlock: vToken.borrowRatePerBlock(), | |
reserveFactorMantissa: vToken.reserveFactorMantissa(), | |
totalBorrows: vToken.totalBorrows(), | |
totalReserves: vToken.totalReserves(), | |
totalSupply: vToken.totalSupply(), | |
totalCash: vToken.getCash(), | |
isListed: isListed, | |
collateralFactorMantissa: collateralFactorMantissa, | |
underlyingAssetAddress: underlyingAssetAddress, | |
vTokenDecimals: vToken.decimals(), | |
underlyingDecimals: underlyingDecimals | |
}); | |
} | |
function vTokenMetadataAll(VToken[] calldata vTokens) external returns (VTokenMetadata[] memory) { | |
uint vTokenCount = vTokens.length; | |
VTokenMetadata[] memory res = new VTokenMetadata[](vTokenCount); | |
for (uint i = 0; i < vTokenCount; i++) { | |
res[i] = vTokenMetadata(vTokens[i]); | |
} | |
return res; | |
} | |
struct VTokenBalances { | |
address vToken; | |
uint balanceOf; | |
uint borrowBalanceCurrent; | |
uint balanceOfUnderlying; | |
uint tokenBalance; | |
uint tokenAllowance; | |
} | |
function vTokenBalances(VToken vToken, address payable account) public returns (VTokenBalances memory) { | |
uint balanceOf = vToken.balanceOf(account); | |
uint borrowBalanceCurrent = vToken.borrowBalanceCurrent(account); | |
uint balanceOfUnderlying = vToken.balanceOfUnderlying(account); | |
uint tokenBalance; | |
uint tokenAllowance; | |
if (compareStrings(vToken.symbol(), "vBNB")) { | |
tokenBalance = account.balance; | |
tokenAllowance = account.balance; | |
} else { | |
VBep20 vBep20 = VBep20(address(vToken)); | |
EIP20Interface underlying = EIP20Interface(vBep20.underlying()); | |
tokenBalance = underlying.balanceOf(account); | |
tokenAllowance = underlying.allowance(account, address(vToken)); | |
} | |
return VTokenBalances({ | |
vToken: address(vToken), | |
balanceOf: balanceOf, | |
borrowBalanceCurrent: borrowBalanceCurrent, | |
balanceOfUnderlying: balanceOfUnderlying, | |
tokenBalance: tokenBalance, | |
tokenAllowance: tokenAllowance | |
}); | |
} | |
function vTokenBalancesAll(VToken[] calldata vTokens, address payable account) external returns (VTokenBalances[] memory) { | |
uint vTokenCount = vTokens.length; | |
VTokenBalances[] memory res = new VTokenBalances[](vTokenCount); | |
for (uint i = 0; i < vTokenCount; i++) { | |
res[i] = vTokenBalances(vTokens[i], account); | |
} | |
return res; | |
} | |
struct VTokenUnderlyingPrice { | |
address vToken; | |
uint underlyingPrice; | |
} | |
function vTokenUnderlyingPrice(VToken vToken) public view returns (VTokenUnderlyingPrice memory) { | |
ComptrollerLensInterface comptroller = ComptrollerLensInterface(address(vToken.comptroller())); | |
PriceOracle priceOracle = comptroller.oracle(); | |
return VTokenUnderlyingPrice({ | |
vToken: address(vToken), | |
underlyingPrice: priceOracle.getUnderlyingPrice(vToken) | |
}); | |
} | |
function vTokenUnderlyingPriceAll(VToken[] calldata vTokens) external view returns (VTokenUnderlyingPrice[] memory) { | |
uint vTokenCount = vTokens.length; | |
VTokenUnderlyingPrice[] memory res = new VTokenUnderlyingPrice[](vTokenCount); | |
for (uint i = 0; i < vTokenCount; i++) { | |
res[i] = vTokenUnderlyingPrice(vTokens[i]); | |
} | |
return res; | |
} | |
struct AccountLimits { | |
VToken[] markets; | |
uint liquidity; | |
uint shortfall; | |
} | |
function getAccountLimits(ComptrollerLensInterface comptroller, address account) public view returns (AccountLimits memory) { | |
(uint errorCode, uint liquidity, uint shortfall) = comptroller.getAccountLiquidity(account); | |
require(errorCode == 0, "account liquidity error"); | |
return AccountLimits({ | |
markets: comptroller.getAssetsIn(account), | |
liquidity: liquidity, | |
shortfall: shortfall | |
}); | |
} | |
struct GovReceipt { | |
uint proposalId; | |
bool hasVoted; | |
bool support; | |
uint96 votes; | |
} | |
function getGovReceipts(GovernorAlpha governor, address voter, uint[] memory proposalIds) public view returns (GovReceipt[] memory) { | |
uint proposalCount = proposalIds.length; | |
GovReceipt[] memory res = new GovReceipt[](proposalCount); | |
for (uint i = 0; i < proposalCount; i++) { | |
GovernorAlpha.Receipt memory receipt = governor.getReceipt(proposalIds[i], voter); | |
res[i] = GovReceipt({ | |
proposalId: proposalIds[i], | |
hasVoted: receipt.hasVoted, | |
support: receipt.support, | |
votes: receipt.votes | |
}); | |
} | |
return res; | |
} | |
struct GovProposal { | |
uint proposalId; | |
address proposer; | |
uint eta; | |
address[] targets; | |
uint[] values; | |
string[] signatures; | |
bytes[] calldatas; | |
uint startBlock; | |
uint endBlock; | |
uint forVotes; | |
uint againstVotes; | |
bool canceled; | |
bool executed; | |
} | |
function setProposal(GovProposal memory res, GovernorAlpha governor, uint proposalId) internal view { | |
( | |
, | |
address proposer, | |
uint eta, | |
uint startBlock, | |
uint endBlock, | |
uint forVotes, | |
uint againstVotes, | |
bool canceled, | |
bool executed | |
) = governor.proposals(proposalId); | |
res.proposalId = proposalId; | |
res.proposer = proposer; | |
res.eta = eta; | |
res.startBlock = startBlock; | |
res.endBlock = endBlock; | |
res.forVotes = forVotes; | |
res.againstVotes = againstVotes; | |
res.canceled = canceled; | |
res.executed = executed; | |
} | |
function getGovProposals(GovernorAlpha governor, uint[] calldata proposalIds) external view returns (GovProposal[] memory) { | |
GovProposal[] memory res = new GovProposal[](proposalIds.length); | |
for (uint i = 0; i < proposalIds.length; i++) { | |
( | |
address[] memory targets, | |
uint[] memory values, | |
string[] memory signatures, | |
bytes[] memory calldatas | |
) = governor.getActions(proposalIds[i]); | |
res[i] = GovProposal({ | |
proposalId: 0, | |
proposer: address(0), | |
eta: 0, | |
targets: targets, | |
values: values, | |
signatures: signatures, | |
calldatas: calldatas, | |
startBlock: 0, | |
endBlock: 0, | |
forVotes: 0, | |
againstVotes: 0, | |
canceled: false, | |
executed: false | |
}); | |
setProposal(res[i], governor, proposalIds[i]); | |
} | |
return res; | |
} | |
struct XVSBalanceMetadata { | |
uint balance; | |
uint votes; | |
address delegate; | |
} | |
function getXVSBalanceMetadata(XVS xvs, address account) external view returns (XVSBalanceMetadata memory) { | |
return XVSBalanceMetadata({ | |
balance: xvs.balanceOf(account), | |
votes: uint256(xvs.getCurrentVotes(account)), | |
delegate: xvs.delegates(account) | |
}); | |
} | |
struct XVSBalanceMetadataExt { | |
uint balance; | |
uint votes; | |
address delegate; | |
uint allocated; | |
} | |
function getXVSBalanceMetadataExt(XVS xvs, ComptrollerLensInterface comptroller, address account) external returns (XVSBalanceMetadataExt memory) { | |
uint balance = xvs.balanceOf(account); | |
comptroller.claimVenus(account); | |
uint newBalance = xvs.balanceOf(account); | |
uint accrued = comptroller.venusAccrued(account); | |
uint total = add(accrued, newBalance, "sum xvs total"); | |
uint allocated = sub(total, balance, "sub allocated"); | |
return XVSBalanceMetadataExt({ | |
balance: balance, | |
votes: uint256(xvs.getCurrentVotes(account)), | |
delegate: xvs.delegates(account), | |
allocated: allocated | |
}); | |
} | |
struct VenusVotes { | |
uint blockNumber; | |
uint votes; | |
} | |
function getVenusVotes(XVS xvs, address account, uint32[] calldata blockNumbers) external view returns (VenusVotes[] memory) { | |
VenusVotes[] memory res = new VenusVotes[](blockNumbers.length); | |
for (uint i = 0; i < blockNumbers.length; i++) { | |
res[i] = VenusVotes({ | |
blockNumber: uint256(blockNumbers[i]), | |
votes: uint256(xvs.getPriorVotes(account, blockNumbers[i])) | |
}); | |
} | |
return res; | |
} | |
function compareStrings(string memory a, string memory b) internal pure returns (bool) { | |
return (keccak256(abi.encodePacked((a))) == keccak256(abi.encodePacked((b)))); | |
} | |
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(uint a, uint b, string memory errorMessage) internal pure returns (uint) { | |
require(b <= a, errorMessage); | |
uint c = a - b; | |
return c; | |
} | |
} |
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; | |
pragma experimental ABIEncoderV2; | |
import "./PriceOracle.sol"; | |
import "./VBep20.sol"; | |
import "./BEP20Interface.sol"; | |
import "./SafeMath.sol"; | |
interface IStdReference { | |
/// A structure returned whenever someone requests for standard reference data. | |
struct ReferenceData { | |
uint256 rate; // base/quote exchange rate, multiplied by 1e18. | |
uint256 lastUpdatedBase; // UNIX epoch of the last time when base price gets updated. | |
uint256 lastUpdatedQuote; // UNIX epoch of the last time when quote price gets updated. | |
} | |
/// Returns the price data for the given base/quote pair. Revert if not available. | |
function getReferenceData(string calldata _base, string calldata _quote) external view returns (ReferenceData memory); | |
/// Similar to getReferenceData, but with multiple base/quote pairs at once. | |
function getReferenceDataBulk(string[] calldata _bases, string[] calldata _quotes) external view returns (ReferenceData[] memory); | |
} | |
contract VenusPriceOracle is PriceOracle { | |
using SafeMath for uint256; | |
address public admin; | |
mapping(address => uint) prices; | |
event PricePosted(address asset, uint previousPriceMantissa, uint requestedPriceMantissa, uint newPriceMantissa); | |
event NewAdmin(address oldAdmin, address newAdmin); | |
IStdReference ref; | |
constructor(IStdReference _ref) public { | |
ref = _ref; | |
admin = msg.sender; | |
} | |
function getUnderlyingPrice(VToken vToken) public view returns (uint) { | |
if (compareStrings(vToken.symbol(), "vBNB")) { | |
IStdReference.ReferenceData memory data = ref.getReferenceData("BNB", "USD"); | |
return data.rate; | |
}else if (compareStrings(vToken.symbol(), "XVS")) { | |
return prices[address(vToken)]; | |
} else { | |
uint256 price; | |
BEP20Interface token = BEP20Interface(VBep20(address(vToken)).underlying()); | |
if(prices[address(token)] != 0) { | |
price = prices[address(token)]; | |
} else { | |
IStdReference.ReferenceData memory data = ref.getReferenceData(token.symbol(), "USD"); | |
price = data.rate; | |
} | |
uint decimalDelta = 18-uint(token.decimals()); | |
return price.mul(10**decimalDelta); | |
} | |
} | |
function setUnderlyingPrice(VToken vToken, uint underlyingPriceMantissa) public { | |
require(msg.sender == admin, "only admin can set underlying price"); | |
address asset = address(VBep20(address(vToken)).underlying()); | |
emit PricePosted(asset, prices[asset], underlyingPriceMantissa, underlyingPriceMantissa); | |
prices[asset] = underlyingPriceMantissa; | |
} | |
function setDirectPrice(address asset, uint price) public { | |
require(msg.sender == admin, "only admin can set price"); | |
emit PricePosted(asset, prices[asset], price, price); | |
prices[asset] = price; | |
} | |
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 { | |
require(msg.sender == admin, "only admin can set new admin"); | |
address oldAdmin = admin; | |
admin = newAdmin; | |
emit NewAdmin(oldAdmin, newAdmin); | |
} | |
} |
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 "./ComptrollerInterface.sol"; | |
import "./VTokenInterfaces.sol"; | |
import "./ErrorReporter.sol"; | |
import "./Exponential.sol"; | |
import "./EIP20Interface.sol"; | |
import "./EIP20NonStandardInterface.sol"; | |
import "./InterestRateModel.sol"; | |
/** | |
* @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 | |
} | |
} |
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 "./ComptrollerInterface.sol"; | |
import "./InterestRateModel.sol"; | |
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; | |
} |
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 "./SafeMath.sol"; | |
import "./BEP20Interface.sol"; | |
import "./Ownable.sol"; | |
/** | |
* @dev Contract for treasury all tokens as fee and transfer to governance | |
*/ | |
contract VTreasury is Ownable { | |
using SafeMath for uint256; | |
/** | |
* @notice Withdraw Treasury Token, Only owner call it | |
* @param tokenAddress The address of treasury token | |
* @param withdrawAmount The withdraw amount to owner | |
* @param withdrawAddress The withdraw address | |
*/ | |
function withdrawTreasury( | |
address tokenAddress, | |
uint256 withdrawAmount, | |
address withdrawAddress | |
) external onlyOwner { | |
// Get Treasury Token Balance | |
uint256 treasuryBalance = BEP20Interface(tokenAddress).balanceOf(address(this)); | |
// Check Withdraw Amount | |
require(treasuryBalance >= withdrawAmount, "The withdraw amount should be less than balance of treasury"); | |
// Transfer withdrawAmount to withdrawAddress | |
BEP20Interface(tokenAddress).transfer(withdrawAddress, withdrawAmount); | |
} | |
} |
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 "./InterestRateModel.sol"; | |
import "./SafeMath.sol"; | |
/** | |
* @title Venus's WhitePaperInterestRateModel Contract | |
* @author Venus | |
* @notice The parameterized model described in section 2.4 of the original Venus Protocol whitepaper | |
*/ | |
contract WhitePaperInterestRateModel is InterestRateModel { | |
using SafeMath for uint; | |
event NewInterestParams(uint baseRatePerBlock, uint multiplierPerBlock); | |
/** | |
* @notice The approximate number of blocks per year that is assumed by the interest rate model | |
*/ | |
uint public constant blocksPerYear = 60 * 60 * 24 * 365 / 3; // (assuming 3s blocks) | |
/** | |
* @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 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) | |
*/ | |
constructor(uint baseRatePerYear, uint multiplierPerYear) public { | |
baseRatePerBlock = baseRatePerYear.div(blocksPerYear); | |
multiplierPerBlock = multiplierPerYear.div(blocksPerYear); | |
emit NewInterestParams(baseRatePerBlock, multiplierPerBlock); | |
} | |
/** | |
* @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 getBorrowRate(uint cash, uint borrows, uint reserves) public view returns (uint) { | |
uint ur = utilizationRate(cash, borrows, reserves); | |
return ur.mul(multiplierPerBlock).div(1e18).add(baseRatePerBlock); | |
} | |
/** | |
* @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 = getBorrowRate(cash, borrows, reserves); | |
uint rateToPool = borrowRate.mul(oneMinusReserveFactor).div(1e18); | |
return utilizationRate(cash, borrows, reserves).mul(rateToPool).div(1e18); | |
} | |
} |
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; | |
contract Owned { | |
address public owner; | |
event OwnershipTransferred(address indexed _from, address indexed _to); | |
constructor() public { | |
owner = msg.sender; | |
} | |
modifier onlyOwner { | |
require(msg.sender == owner, "Should be owner"); | |
_; | |
} | |
function transferOwnership(address newOwner) public onlyOwner { | |
owner = newOwner; | |
emit OwnershipTransferred(owner, newOwner); | |
} | |
} | |
contract Tokenlock is Owned { | |
/// @notice Indicates if token is locked | |
uint8 isLocked = 0; | |
event Freezed(); | |
event UnFreezed(); | |
modifier validLock { | |
require(isLocked == 0, "Token is locked"); | |
_; | |
} | |
function freeze() public onlyOwner { | |
isLocked = 1; | |
emit Freezed(); | |
} | |
function unfreeze() public onlyOwner { | |
isLocked = 0; | |
emit UnFreezed(); | |
} | |
} | |
contract XVS is Tokenlock { | |
/// @notice BEP-20 token name for this token | |
string public constant name = "Venus"; | |
/// @notice BEP-20 token symbol for this token | |
string public constant symbol = "XVS"; | |
/// @notice BEP-20 token decimals for this token | |
uint8 public constant decimals = 18; | |
/// @notice Total number of tokens in circulation | |
uint public constant totalSupply = 30000000e18; // 30 million XVS | |
/// @notice Allowance amounts on behalf of others | |
mapping (address => mapping (address => uint96)) internal allowances; | |
/// @notice Official record of token balances for each account | |
mapping (address => uint96) internal balances; | |
/// @notice A record of each accounts delegate | |
mapping (address => address) public delegates; | |
/// @notice A checkpoint for marking number of votes from a given block | |
struct Checkpoint { | |
uint32 fromBlock; | |
uint96 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 The standard BEP-20 transfer event | |
event Transfer(address indexed from, address indexed to, uint256 amount); | |
/// @notice The standard BEP-20 approval event | |
event Approval(address indexed owner, address indexed spender, uint256 amount); | |
/** | |
* @notice Construct a new XVS token | |
* @param account The initial account to grant all the tokens | |
*/ | |
constructor(address account) public { | |
balances[account] = uint96(totalSupply); | |
emit Transfer(address(0), account, totalSupply); | |
} | |
/** | |
* @notice Get the number of tokens `spender` is approved to spend on behalf of `account` | |
* @param account The address of the account holding the funds | |
* @param spender The address of the account spending the funds | |
* @return The number of tokens approved | |
*/ | |
function allowance(address account, address spender) external view returns (uint) { | |
return allowances[account][spender]; | |
} | |
/** | |
* @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 rawAmount The number of tokens that are approved (2^256-1 means infinite) | |
* @return Whether or not the approval succeeded | |
*/ | |
function approve(address spender, uint rawAmount) external validLock returns (bool) { | |
uint96 amount; | |
if (rawAmount == uint(-1)) { | |
amount = uint96(-1); | |
} else { | |
amount = safe96(rawAmount, "XVS::approve: amount exceeds 96 bits"); | |
} | |
allowances[msg.sender][spender] = amount; | |
emit Approval(msg.sender, spender, amount); | |
return true; | |
} | |
/** | |
* @notice Get the number of tokens held by the `account` | |
* @param account The address of the account to get the balance of | |
* @return The number of tokens held | |
*/ | |
function balanceOf(address account) external view returns (uint) { | |
return balances[account]; | |
} | |
/** | |
* @notice Transfer `amount` tokens from `msg.sender` to `dst` | |
* @param dst The address of the destination account | |
* @param rawAmount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transfer(address dst, uint rawAmount) external validLock returns (bool) { | |
uint96 amount = safe96(rawAmount, "XVS::transfer: amount exceeds 96 bits"); | |
_transferTokens(msg.sender, dst, amount); | |
return true; | |
} | |
/** | |
* @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 rawAmount The number of tokens to transfer | |
* @return Whether or not the transfer succeeded | |
*/ | |
function transferFrom(address src, address dst, uint rawAmount) external validLock returns (bool) { | |
address spender = msg.sender; | |
uint96 spenderAllowance = allowances[src][spender]; | |
uint96 amount = safe96(rawAmount, "XVS::approve: amount exceeds 96 bits"); | |
if (spender != src && spenderAllowance != uint96(-1)) { | |
uint96 newAllowance = sub96(spenderAllowance, amount, "XVS::transferFrom: transfer amount exceeds spender allowance"); | |
allowances[src][spender] = newAllowance; | |
emit Approval(src, spender, newAllowance); | |
} | |
_transferTokens(src, dst, amount); | |
return true; | |
} | |
/** | |
* @notice Delegate votes from `msg.sender` to `delegatee` | |
* @param delegatee The address to delegate votes to | |
*/ | |
function delegate(address delegatee) public validLock { | |
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) public validLock { | |
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), "XVS::delegateBySig: invalid signature"); | |
require(nonce == nonces[signatory]++, "XVS::delegateBySig: invalid nonce"); | |
require(now <= expiry, "XVS::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 (uint96) { | |
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) public view returns (uint96) { | |
require(blockNumber < block.number, "XVS::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]; | |
uint96 delegatorBalance = balances[delegator]; | |
delegates[delegator] = delegatee; | |
emit DelegateChanged(delegator, currentDelegate, delegatee); | |
_moveDelegates(currentDelegate, delegatee, delegatorBalance); | |
} | |
function _transferTokens(address src, address dst, uint96 amount) internal { | |
require(src != address(0), "XVS::_transferTokens: cannot transfer from the zero address"); | |
require(dst != address(0), "XVS::_transferTokens: cannot transfer to the zero address"); | |
balances[src] = sub96(balances[src], amount, "XVS::_transferTokens: transfer amount exceeds balance"); | |
balances[dst] = add96(balances[dst], amount, "XVS::_transferTokens: transfer amount overflows"); | |
emit Transfer(src, dst, amount); | |
_moveDelegates(delegates[src], delegates[dst], amount); | |
} | |
function _moveDelegates(address srcRep, address dstRep, uint96 amount) internal { | |
if (srcRep != dstRep && amount > 0) { | |
if (srcRep != address(0)) { | |
uint32 srcRepNum = numCheckpoints[srcRep]; | |
uint96 srcRepOld = srcRepNum > 0 ? checkpoints[srcRep][srcRepNum - 1].votes : 0; | |
uint96 srcRepNew = sub96(srcRepOld, amount, "XVS::_moveVotes: vote amount underflows"); | |
_writeCheckpoint(srcRep, srcRepNum, srcRepOld, srcRepNew); | |
} | |
if (dstRep != address(0)) { | |
uint32 dstRepNum = numCheckpoints[dstRep]; | |
uint96 dstRepOld = dstRepNum > 0 ? checkpoints[dstRep][dstRepNum - 1].votes : 0; | |
uint96 dstRepNew = add96(dstRepOld, amount, "XVS::_moveVotes: vote amount overflows"); | |
_writeCheckpoint(dstRep, dstRepNum, dstRepOld, dstRepNew); | |
} | |
} | |
} | |
function _writeCheckpoint(address delegatee, uint32 nCheckpoints, uint96 oldVotes, uint96 newVotes) internal { | |
uint32 blockNumber = safe32(block.number, "XVS::_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 safe96(uint n, string memory errorMessage) internal pure returns (uint96) { | |
require(n < 2**96, errorMessage); | |
return uint96(n); | |
} | |
function add96(uint96 a, uint96 b, string memory errorMessage) internal pure returns (uint96) { | |
uint96 c = a + b; | |
require(c >= a, errorMessage); | |
return c; | |
} | |
function sub96(uint96 a, uint96 b, string memory errorMessage) internal pure returns (uint96) { | |
require(b <= a, errorMessage); | |
return a - b; | |
} | |
function getChainId() internal pure returns (uint) { | |
uint256 chainId; | |
assembly { chainId := chainid() } | |
return chainId; | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment