Source Code
Overview
ETH Balance
0 ETH
More Info
ContractCreator
Multichain Info
N/A
Loading...
Loading
Contract Source Code Verified (Exact Match)
Contract Name:
VenusERC4626
Compiler Version
v0.8.25+commit.b61c2a91
Optimization Enabled:
Yes with 200 runs
Other Settings:
paris EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { ERC4626Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC4626Upgradeable.sol";
import { SafeERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
import { IERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import { ERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
import { ReentrancyGuardUpgradeable } from "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import { MathUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/math/MathUpgradeable.sol";
import { AccessControlledV8 } from "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
import { IProtocolShareReserve } from "./Interfaces/IProtocolShareReserve.sol";
import { RewardsDistributor } from ".././Rewards/RewardsDistributor.sol";
import { MaxLoopsLimitHelper } from "../MaxLoopsLimitHelper.sol";
import { IComptroller } from "./Interfaces/IComptroller.sol";
import { ensureNonzeroAddress } from "@venusprotocol/solidity-utilities/contracts/validators.sol";
import { Action } from "../ComptrollerInterface.sol";
import { EXP_SCALE } from ".././lib/constants.sol";
import { VToken } from "../VToken.sol";
/// @title VenusERC4626
/// @notice ERC4626 wrapper for Venus vTokens, enabling standard ERC4626 vault interactions with Venus Protocol.
contract VenusERC4626 is ERC4626Upgradeable, AccessControlledV8, MaxLoopsLimitHelper, ReentrancyGuardUpgradeable {
using MathUpgradeable for uint256;
using SafeERC20Upgradeable for ERC20Upgradeable;
/// @notice Error code representing no errors in Venus operations.
uint256 internal constant NO_ERROR = 0;
/// @notice The Venus vToken associated with this ERC4626 vault.
VToken public vToken;
/// @notice The Venus Comptroller contract, responsible for market operations.
IComptroller public comptroller;
/// @notice The recipient of rewards distributed by the Venus Protocol.
address public rewardRecipient;
/// @notice Emitted when rewards are claimed.
/// @param amount The amount of reward tokens claimed.
/// @param rewardToken The address of the reward token claimed.
event ClaimRewards(uint256 amount, address indexed rewardToken);
/// @notice Emitted when the reward recipient address is updated.
/// @param oldRecipient The previous reward recipient address.
/// @param newRecipient The new reward recipient address.
event RewardRecipientUpdated(address indexed oldRecipient, address indexed newRecipient);
/// @notice Event emitted when tokens are swept
event SweepToken(address indexed token, address indexed receiver, uint256 amount);
/// @notice Thrown when a Venus protocol call returns an error.
/// @dev This error is triggered if a Venus operation (such as minting or redeeming vTokens) fails.
/// @param errorCode The error code returned by the Venus protocol.
error VenusERC4626__VenusError(uint256 errorCode);
/// @notice Thrown when a deposit exceeds the maximum allowed limit.
/// @dev This error is triggered if the deposit amount is greater than `maxDeposit(receiver)`.
error ERC4626__DepositMoreThanMax();
/// @notice Thrown when a mint operation exceeds the maximum allowed limit.
/// @dev This error is triggered if the mint amount is greater than `maxMint(receiver)`.
error ERC4626__MintMoreThanMax();
/// @notice Thrown when a withdrawal exceeds the maximum available assets.
/// @dev This error is triggered if the withdrawal amount is greater than `maxWithdraw(owner)`.
error ERC4626__WithdrawMoreThanMax();
/// @notice Thrown when a redemption exceeds the maximum redeemable shares.
/// @dev This error is triggered if the redemption amount is greater than `maxRedeem(owner)`.
error ERC4626__RedeemMoreThanMax();
/// @notice Thrown when attempting an operation with a zero amount.
/// @dev This error prevents unnecessary transactions with zero amounts in deposit, withdraw, mint, or redeem operations.
/// @param operation The name of the operation that failed (e.g., "deposit", "withdraw", "mint", "redeem").
error ERC4626__ZeroAmount(string operation);
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
// Note that the contract is upgradeable. Use initialize() or reinitializers
// to set the state variables.
_disableInitializers();
}
/// @notice Initializes the VenusERC4626 vault, only with the VToken address associated to the vault
/// @dev `initialize2` should be invoked to complete the configuration of the vault
/// @param vToken_ The VToken associated with the vault, representing the yield-bearing asset.
function initialize(address vToken_) public initializer {
ensureNonzeroAddress(vToken_);
vToken = VToken(vToken_);
comptroller = IComptroller(address(vToken.comptroller()));
ERC20Upgradeable asset = ERC20Upgradeable(vToken.underlying());
__ERC20_init(_generateVaultName(asset), _generateVaultSymbol(asset));
__ERC4626_init(asset);
__ReentrancyGuard_init();
}
/**
* @notice Set the limit for the loops can iterate to avoid the DOS
* @param loopsLimit Number of loops limit
* @custom:event Emits MaxLoopsLimitUpdated event on success
* @custom:access Controlled by ACM
*/
function setMaxLoopsLimit(uint256 loopsLimit) external {
_checkAccessAllowed("setMaxLoopsLimit(uint256)");
_setMaxLoopsLimit(loopsLimit);
}
/// @notice Sets a new reward recipient address
/// @param newRecipient The address of the new reward recipient
/// @custom:access Controlled by ACM
function setRewardRecipient(address newRecipient) external {
_checkAccessAllowed("setRewardRecipient(address)");
_setRewardRecipient(newRecipient);
}
/// @notice Sweeps the input token address tokens from the contract and sends them to the owner
/// @param token Address of the token
/// @custom:event SweepToken emits on success
/// @custom:access Only owner
function sweepToken(IERC20Upgradeable token) external onlyOwner {
uint256 balance = token.balanceOf(address(this));
if (balance > 0) {
address owner_ = owner();
SafeERC20Upgradeable.safeTransfer(token, owner_, balance);
emit SweepToken(address(token), owner_, balance);
}
}
/// @notice Claims rewards from all reward distributors associated with the VToken and transfers them to the reward recipient.
/// @dev Iterates through all reward distributors fetched from the comptroller, claims rewards, and transfers them if available.
function claimRewards() external {
IComptroller _comptroller = comptroller;
VToken _vToken = vToken;
address _rewardRecipient = rewardRecipient;
RewardsDistributor[] memory rewardDistributors = _comptroller.getRewardDistributors();
_ensureMaxLoops(rewardDistributors.length);
for (uint256 i = 0; i < rewardDistributors.length; i++) {
RewardsDistributor rewardDistributor = rewardDistributors[i];
IERC20Upgradeable rewardToken = IERC20Upgradeable(address(rewardDistributor.rewardToken()));
VToken[] memory vTokens = new VToken[](1);
vTokens[0] = _vToken;
RewardsDistributor(rewardDistributor).claimRewardToken(address(this), vTokens);
uint256 rewardBalance = rewardToken.balanceOf(address(this));
if (rewardBalance > 0) {
SafeERC20Upgradeable.safeTransfer(rewardToken, _rewardRecipient, rewardBalance);
// Try to update the asset state on the recipient if reward recipient is a protocol share reserve
// reward recipient cannot be an EOA
try
IProtocolShareReserve(_rewardRecipient).updateAssetsState(
address(_comptroller),
address(rewardToken),
IProtocolShareReserve.IncomeType.ERC4626_WRAPPER_REWARDS
)
{} catch {}
}
emit ClaimRewards(rewardBalance, address(rewardToken));
}
}
/// @notice Second function to invoke to complete the configuration of the vault, setting the rest of the attributes
/// @param accessControlManager_ Address of the ACM contract
/// @param rewardRecipient_ The address that will receive rewards generated by the vault.
/// @param loopsLimit_ The maximum number of loops allowed for reward distribution.
/// @param vaultOwner_ The owner that will be set for the created vault
function initialize2(
address accessControlManager_,
address rewardRecipient_,
uint256 loopsLimit_,
address vaultOwner_
) public reinitializer(2) {
ensureNonzeroAddress(vaultOwner_);
__AccessControlled_init(accessControlManager_);
_setMaxLoopsLimit(loopsLimit_);
_setRewardRecipient(rewardRecipient_);
_transferOwnership(vaultOwner_);
}
/// @inheritdoc ERC4626Upgradeable
function deposit(uint256 assets, address receiver) public override nonReentrant returns (uint256) {
ensureNonzeroAddress(receiver);
vToken.accrueInterest();
if (assets == 0) {
revert ERC4626__ZeroAmount("deposit");
}
if (assets > maxDeposit(receiver)) {
revert ERC4626__DepositMoreThanMax();
}
uint256 shares = previewDeposit(assets);
if (shares == 0) {
revert ERC4626__ZeroAmount("deposit");
}
uint256 totalSupplyBefore = totalSupply();
_deposit(_msgSender(), receiver, assets, shares);
uint256 actualShares = totalSupply() - totalSupplyBefore;
return actualShares;
}
/// @dev The minted shares are calculated considering the minted VTokens
/// @dev It can mint slightly fewer shares than requested, because VToken.mint rounds down
/// @inheritdoc ERC4626Upgradeable
function mint(uint256 shares, address receiver) public override nonReentrant returns (uint256) {
ensureNonzeroAddress(receiver);
vToken.accrueInterest();
if (shares == 0) {
revert ERC4626__ZeroAmount("mint");
}
if (shares > maxMint(receiver)) {
revert ERC4626__MintMoreThanMax();
}
uint256 assets = previewMint(shares);
if (assets == 0) {
revert ERC4626__ZeroAmount("mint");
}
_deposit(_msgSender(), receiver, assets, shares);
return assets;
}
/// @dev Receiver can receive slightly more assets than requested, because VToken.redeemUnderlying rounds up
/// @dev The shares to burn are calculated considering the actual transferred assets, not the requested ones
/// @inheritdoc ERC4626Upgradeable
function withdraw(uint256 assets, address receiver, address owner) public override nonReentrant returns (uint256) {
ensureNonzeroAddress(receiver);
ensureNonzeroAddress(owner);
vToken.accrueInterest();
if (assets == 0) {
revert ERC4626__ZeroAmount("withdraw");
}
if (assets > maxWithdraw(owner)) {
revert ERC4626__WithdrawMoreThanMax();
}
(uint256 actualAssets, uint256 actualShares) = _beforeWithdraw(assets);
_withdraw(_msgSender(), receiver, owner, actualAssets, actualShares);
return actualShares;
}
/// @inheritdoc ERC4626Upgradeable
function redeem(uint256 shares, address receiver, address owner) public override nonReentrant returns (uint256) {
ensureNonzeroAddress(receiver);
ensureNonzeroAddress(owner);
vToken.accrueInterest();
if (shares == 0) {
revert ERC4626__ZeroAmount("redeem");
}
if (shares > maxRedeem(owner)) {
revert ERC4626__RedeemMoreThanMax();
}
uint256 actualAssets = _beforeRedeem(shares);
if (actualAssets == 0) {
revert ERC4626__ZeroAmount("redeem");
}
_withdraw(_msgSender(), receiver, owner, actualAssets, shares);
return actualAssets;
}
/// @notice Returns the total amount of assets deposited
/// @return Amount of assets deposited
function totalAssets() public view virtual override returns (uint256) {
return (vToken.balanceOf(address(this)) * vToken.exchangeRateStored()) / EXP_SCALE;
}
/// @notice Returns the maximum deposit allowed based on Venus supply caps.
/// @dev If minting is paused or the supply cap is reached, returns 0.
/// @param /*account*/ The address of the account.
/// @return The maximum amount of assets that can be deposited.
function maxDeposit(address /*account*/) public view virtual override returns (uint256) {
if (comptroller.actionPaused(address(vToken), Action.MINT)) {
return 0;
}
uint256 supplyCap = comptroller.supplyCaps(address(vToken));
uint256 totalSupply_ = (vToken.totalSupply() * vToken.exchangeRateStored()) / EXP_SCALE;
return supplyCap > totalSupply_ ? supplyCap - totalSupply_ : 0;
}
/// @notice Returns the maximum amount of shares that can be minted.
/// @dev This is derived from the maximum deposit amount converted to shares.
/// @param /*account*/ The address of the account.
/// @return The maximum number of shares that can be minted.
function maxMint(address /*account*/) public view virtual override returns (uint256) {
return convertToShares(maxDeposit(address(0)));
}
/// @notice Returns the maximum amount that can be withdrawn.
/// @dev The withdrawable amount is limited by the available cash in the vault.
/// @param receiver The address of the account withdrawing.
/// @return The maximum amount of assets that can be withdrawn.
function maxWithdraw(address receiver) public view virtual override returns (uint256) {
if (comptroller.actionPaused(address(vToken), Action.REDEEM)) {
return 0;
}
uint256 cash = vToken.getCash();
uint256 totalReserves = vToken.totalReserves();
uint256 assetsBalance = convertToAssets(balanceOf(receiver));
if (cash < totalReserves) {
return 0;
} else {
uint256 availableCash = cash - totalReserves;
return availableCash < assetsBalance ? availableCash : assetsBalance;
}
}
/// @notice Returns the maximum amount of shares that can be redeemed.
/// @dev Redemption is limited by the available cash in the vault.
/// @param receiver The address of the account redeeming.
/// @return The maximum number of shares that can be redeemed.
function maxRedeem(address receiver) public view virtual override returns (uint256) {
if (comptroller.actionPaused(address(vToken), Action.REDEEM)) {
return 0;
}
uint256 cash = vToken.getCash();
uint256 totalReserves = vToken.totalReserves();
if (cash < totalReserves) {
return 0;
} else {
uint256 availableCash = cash - totalReserves;
uint256 availableCashInShares = convertToShares(availableCash);
uint256 shareBalance = balanceOf(receiver);
return availableCashInShares < shareBalance ? availableCashInShares : shareBalance;
}
}
/// @notice Redeems the amount of vTokens equivalent to the provided shares.
/// @dev Calls `redeem` on the vToken contract. Reverts on error.
/// @param shares The amount of shares to redeem.
/// @return The amount of assets transferred in
function _beforeRedeem(uint256 shares) internal returns (uint256) {
IERC20Upgradeable token = IERC20Upgradeable(asset());
uint256 balanceBefore = token.balanceOf(address(this));
// Calculate the amount of vTokens equivalent to the amount of shares, rounding it down
uint256 vTokens = shares.mulDiv(
vToken.balanceOf(address(this)),
totalSupply() + 10 ** _decimalsOffset(),
MathUpgradeable.Rounding.Down
);
uint256 errorCode = vToken.redeem(vTokens);
if (errorCode != NO_ERROR) {
revert VenusERC4626__VenusError(errorCode);
}
uint256 balanceAfter = token.balanceOf(address(this));
// Return the amount of assets that was *actually* transferred in
return balanceAfter - balanceBefore;
}
/// @notice Redeems underlying assets before withdrawing from the vault.
/// @dev Calls `redeemUnderlying` on the vToken contract. Reverts on error.
/// @param assets The amount of underlying assets to redeem.
/// @return actualAssets The amount of assets transferred in
/// @return actualShares The shares equivalent to `actualAssets`, to be burned, rounded up
/// @custom:error ERC4626__ZeroAmount is thrown when the redeemed VTokens are zero
function _beforeWithdraw(uint256 assets) internal returns (uint256 actualAssets, uint256 actualShares) {
IERC20Upgradeable token = IERC20Upgradeable(asset());
uint256 balanceBefore = token.balanceOf(address(this));
uint256 vTokenBalanceBefore = vToken.balanceOf(address(this));
uint256 errorCode = vToken.redeemUnderlying(assets);
if (errorCode != NO_ERROR) {
revert VenusERC4626__VenusError(errorCode);
}
// Return the amount of assets *actually* transferred in
actualAssets = token.balanceOf(address(this)) - balanceBefore;
uint256 actualVTokens = vTokenBalanceBefore - vToken.balanceOf(address(this));
if (actualVTokens == 0) {
revert ERC4626__ZeroAmount("actualVTokens at _beforeWithdraw");
}
// Return the shares equivalent to the burned vTokens
actualShares = actualVTokens.mulDiv(
totalSupply() + 10 ** _decimalsOffset(),
vTokenBalanceBefore,
MathUpgradeable.Rounding.Up
);
}
/// @notice Mints vTokens after depositing assets.
/// @dev Calls `mint` on the vToken contract. Reverts on error.
/// @param assets The amount of underlying assets to deposit.
function _mintVTokens(uint256 assets) internal {
ERC20Upgradeable(asset()).safeApprove(address(vToken), assets);
uint256 errorCode = vToken.mint(assets);
if (errorCode != NO_ERROR) {
revert VenusERC4626__VenusError(errorCode);
}
}
/// @notice Sets a new reward recipient address
/// @param newRecipient The address of the new reward recipient
/// @custom:error ZeroAddressNotAllowed is thrown when the new recipient address is zero
/// @custom:event RewardRecipientUpdated is emitted when the reward recipient address is updated
function _setRewardRecipient(address newRecipient) internal {
ensureNonzeroAddress(newRecipient);
emit RewardRecipientUpdated(rewardRecipient, newRecipient);
rewardRecipient = newRecipient;
}
/// @notice Deposits the assets into the VToken and calculates the shares to mint based on the
/// underlying assets equivalent to the new VTokens minted
/// @custom:error ERC4626__ZeroAmount is thrown when the minted VTokens are zero
/// @inheritdoc ERC4626Upgradeable
function _deposit(address caller, address receiver, uint256 assets, uint256 shares) internal override {
// 1. Track pre-transfer balances
uint256 assetBalanceBefore = IERC20Upgradeable(asset()).balanceOf(address(this));
uint256 vTokenBalanceBefore = vToken.balanceOf(address(this));
// 2. Perform asset transfer (original OZ 4626 logic)
SafeERC20Upgradeable.safeTransferFrom(IERC20Upgradeable(asset()), caller, address(this), assets);
// 3. Calculate actual assets received (protects against fee-on-transfer)
uint256 assetsReceived = IERC20Upgradeable(asset()).balanceOf(address(this)) - assetBalanceBefore;
// 4. Mint vTokens with received assets
_mintVTokens(assetsReceived);
// 5. Verify actual vTokens received
uint256 vTokensReceived = vToken.balanceOf(address(this)) - vTokenBalanceBefore;
if (vTokensReceived == 0) {
revert ERC4626__ZeroAmount("vTokensReceived at _deposit");
}
uint256 actualAssetsValue = (vTokensReceived * vToken.exchangeRateStored()) / EXP_SCALE;
// 6. Recalculate shares based on actual received value
// This is the same operation performed by previewDeposit, adjusting the total assets
uint256 actualShares = actualAssetsValue.mulDiv(
totalSupply() + 10 ** _decimalsOffset(),
totalAssets() + 1 - actualAssetsValue, // remove the new assets deposited to the VToken in this operation
MathUpgradeable.Rounding.Down
);
// 7. Mint the corrected share amount
_mint(receiver, actualShares);
emit Deposit(caller, receiver, assets, actualShares);
}
/// @notice Override `_decimalsOffset` to normalize decimals to 18 for all VenusERC4626 vaults.
/// @return Gap between 18 and the decimals of the asset token
function _decimalsOffset() internal view virtual override returns (uint8) {
return 18 - ERC20Upgradeable(asset()).decimals();
}
/// @notice Generates and returns the derived name of the vault considering the asset name
/// @param asset_ Asset to be accepted in the vault whose name this function will return
/// @return Name of the vault considering the asset name
function _generateVaultName(ERC20Upgradeable asset_) internal view returns (string memory) {
return string(abi.encodePacked("ERC4626-Wrapped Venus ", asset_.name()));
}
/// @notice Generates and returns the derived symbol of the vault considering the asset symbol
/// @param asset_ Asset to be accepted in the vault whose symbol this function will return
/// @return Symbol of the vault considering the asset name
function _generateVaultSymbol(ERC20Upgradeable asset_) internal view returns (string memory) {
return string(abi.encodePacked("v4626", asset_.symbol()));
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.0;
import "./OwnableUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which provides 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} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2StepUpgradeable is Initializable, OwnableUpgradeable {
address private _pendingOwner;
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
function __Ownable2Step_init() internal onlyInitializing {
__Ownable_init_unchained();
}
function __Ownable2Step_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() public virtual {
address sender = _msgSender();
require(pendingOwner() == sender, "Ownable2Step: caller is not the new owner");
_transferOwnership(sender);
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.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.
*/
abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
function __Ownable_init() internal onlyInitializing {
__Ownable_init_unchained();
}
function __Ownable_init_unchained() internal onlyInitializing {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (interfaces/IERC4626.sol)
pragma solidity ^0.8.0;
import "../token/ERC20/IERC20Upgradeable.sol";
import "../token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
/**
* @dev Interface of the ERC4626 "Tokenized Vault Standard", as defined in
* https://eips.ethereum.org/EIPS/eip-4626[ERC-4626].
*
* _Available since v4.7._
*/
interface IERC4626Upgradeable is IERC20Upgradeable, IERC20MetadataUpgradeable {
event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);
event Withdraw(
address indexed sender,
address indexed receiver,
address indexed owner,
uint256 assets,
uint256 shares
);
/**
* @dev Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
*
* - MUST be an ERC-20 token contract.
* - MUST NOT revert.
*/
function asset() external view returns (address assetTokenAddress);
/**
* @dev Returns the total amount of the underlying asset that is “managed” by Vault.
*
* - SHOULD include any compounding that occurs from yield.
* - MUST be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT revert.
*/
function totalAssets() external view returns (uint256 totalManagedAssets);
/**
* @dev Returns the amount of shares that the Vault would exchange for the amount of assets provided, in an ideal
* scenario where all the conditions are met.
*
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT show any variations depending on the caller.
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
* - MUST NOT revert.
*
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
* from.
*/
function convertToShares(uint256 assets) external view returns (uint256 shares);
/**
* @dev Returns the amount of assets that the Vault would exchange for the amount of shares provided, in an ideal
* scenario where all the conditions are met.
*
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT show any variations depending on the caller.
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
* - MUST NOT revert.
*
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
* from.
*/
function convertToAssets(uint256 shares) external view returns (uint256 assets);
/**
* @dev Returns the maximum amount of the underlying asset that can be deposited into the Vault for the receiver,
* through a deposit call.
*
* - MUST return a limited value if receiver is subject to some deposit limit.
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
* - MUST NOT revert.
*/
function maxDeposit(address receiver) external view returns (uint256 maxAssets);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given
* current on-chain conditions.
*
* - MUST return as close to and no more than the exact amount of Vault shares that would be minted in a deposit
* call in the same transaction. I.e. deposit should return the same or more shares as previewDeposit if called
* in the same transaction.
* - MUST NOT account for deposit limits like those returned from maxDeposit and should always act as though the
* deposit would be accepted, regardless if the user has enough tokens approved, etc.
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToShares and previewDeposit SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewDeposit(uint256 assets) external view returns (uint256 shares);
/**
* @dev Mints shares Vault shares to receiver by depositing exactly amount of underlying tokens.
*
* - MUST emit the Deposit event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* deposit execution, and are accounted for during deposit.
* - MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function deposit(uint256 assets, address receiver) external returns (uint256 shares);
/**
* @dev Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.
* - MUST return a limited value if receiver is subject to some mint limit.
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
* - MUST NOT revert.
*/
function maxMint(address receiver) external view returns (uint256 maxShares);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given
* current on-chain conditions.
*
* - MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call
* in the same transaction. I.e. mint should return the same or fewer assets as previewMint if called in the
* same transaction.
* - MUST NOT account for mint limits like those returned from maxMint and should always act as though the mint
* would be accepted, regardless if the user has enough tokens approved, etc.
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by minting.
*/
function previewMint(uint256 shares) external view returns (uint256 assets);
/**
* @dev Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.
*
* - MUST emit the Deposit event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint
* execution, and are accounted for during mint.
* - MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function mint(uint256 shares, address receiver) external returns (uint256 assets);
/**
* @dev Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the
* Vault, through a withdraw call.
*
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
* - MUST NOT revert.
*/
function maxWithdraw(address owner) external view returns (uint256 maxAssets);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block,
* given current on-chain conditions.
*
* - MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw
* call in the same transaction. I.e. withdraw should return the same or fewer shares as previewWithdraw if
* called
* in the same transaction.
* - MUST NOT account for withdrawal limits like those returned from maxWithdraw and should always act as though
* the withdrawal would be accepted, regardless if the user has enough shares, etc.
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewWithdraw(uint256 assets) external view returns (uint256 shares);
/**
* @dev Burns shares from owner and sends exactly assets of underlying tokens to receiver.
*
* - MUST emit the Withdraw event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* withdraw execution, and are accounted for during withdraw.
* - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
* not having enough shares, etc).
*
* Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
/**
* @dev Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault,
* through a redeem call.
*
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
* - MUST return balanceOf(owner) if owner is not subject to any withdrawal limit or timelock.
* - MUST NOT revert.
*/
function maxRedeem(address owner) external view returns (uint256 maxShares);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their redeemption at the current block,
* given current on-chain conditions.
*
* - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call
* in the same transaction. I.e. redeem should return the same or more assets as previewRedeem if called in the
* same transaction.
* - MUST NOT account for redemption limits like those returned from maxRedeem and should always act as though the
* redemption would be accepted, regardless if the user has enough shares, etc.
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToAssets and previewRedeem SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by redeeming.
*/
function previewRedeem(uint256 shares) external view returns (uint256 assets);
/**
* @dev Burns exactly shares from owner and sends assets of underlying tokens to receiver.
*
* - MUST emit the Withdraw event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* redeem execution, and are accounted for during redeem.
* - MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner
* not having enough shares, etc).
*
* NOTE: some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
* constructor.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
bool isTopLevelCall = !_initializing;
require(
(isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
"Initializable: contract is already initialized"
);
_initialized = 1;
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: setting the version to 255 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint8 version) {
require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
_initialized = version;
_initializing = true;
_;
_initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized != type(uint8).max) {
_initialized = type(uint8).max;
emit Initialized(type(uint8).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint8) {
return _initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _initializing;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuardUpgradeable is Initializable {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.0;
import "./IERC20Upgradeable.sol";
import "./extensions/IERC20MetadataUpgradeable.sol";
import "../../utils/ContextUpgradeable.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC20
* applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
* functions have been added to mitigate the well-known issues around setting
* allowances. See {IERC20-approve}.
*/
contract ERC20Upgradeable is Initializable, ContextUpgradeable, IERC20Upgradeable, IERC20MetadataUpgradeable {
mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
function __ERC20_init(string memory name_, string memory symbol_) internal onlyInitializing {
__ERC20_init_unchained(name_, symbol_);
}
function __ERC20_init_unchained(string memory name_, string memory symbol_) internal onlyInitializing {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual override returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual override returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address to, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_transfer(owner, to, amount);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual override returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_approve(owner, spender, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
* - the caller must have allowance for ``from``'s tokens of at least
* `amount`.
*/
function transferFrom(address from, address to, uint256 amount) public virtual override returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, amount);
_transfer(from, to, amount);
return true;
}
/**
* @dev Atomically increases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, allowance(owner, spender) + addedValue);
return true;
}
/**
* @dev Atomically decreases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `spender` must have allowance for the caller of at least
* `subtractedValue`.
*/
function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
address owner = _msgSender();
uint256 currentAllowance = allowance(owner, spender);
require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
unchecked {
_approve(owner, spender, currentAllowance - subtractedValue);
}
return true;
}
/**
* @dev Moves `amount` of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
*/
function _transfer(address from, address to, uint256 amount) internal virtual {
require(from != address(0), "ERC20: transfer from the zero address");
require(to != address(0), "ERC20: transfer to the zero address");
_beforeTokenTransfer(from, to, amount);
uint256 fromBalance = _balances[from];
require(fromBalance >= amount, "ERC20: transfer amount exceeds balance");
unchecked {
_balances[from] = fromBalance - amount;
// Overflow not possible: the sum of all balances is capped by totalSupply, and the sum is preserved by
// decrementing then incrementing.
_balances[to] += amount;
}
emit Transfer(from, to, amount);
_afterTokenTransfer(from, to, amount);
}
/** @dev Creates `amount` tokens and assigns them to `account`, increasing
* the total supply.
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function _mint(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: mint to the zero address");
_beforeTokenTransfer(address(0), account, amount);
_totalSupply += amount;
unchecked {
// Overflow not possible: balance + amount is at most totalSupply + amount, which is checked above.
_balances[account] += amount;
}
emit Transfer(address(0), account, amount);
_afterTokenTransfer(address(0), account, amount);
}
/**
* @dev Destroys `amount` tokens from `account`, reducing the
* total supply.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
* - `account` must have at least `amount` tokens.
*/
function _burn(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: burn from the zero address");
_beforeTokenTransfer(account, address(0), amount);
uint256 accountBalance = _balances[account];
require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
unchecked {
_balances[account] = accountBalance - amount;
// Overflow not possible: amount <= accountBalance <= totalSupply.
_totalSupply -= amount;
}
emit Transfer(account, address(0), amount);
_afterTokenTransfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(address owner, address spender, uint256 amount) internal virtual {
require(owner != address(0), "ERC20: approve from the zero address");
require(spender != address(0), "ERC20: approve to the zero address");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `amount`.
*
* Does not update the allowance amount in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Might emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 amount) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
require(currentAllowance >= amount, "ERC20: insufficient allowance");
unchecked {
_approve(owner, spender, currentAllowance - amount);
}
}
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(address from, address to, uint256 amount) internal virtual {}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* has been transferred to `to`.
* - when `from` is zero, `amount` tokens have been minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens have been burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(address from, address to, uint256 amount) internal virtual {}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[45] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/extensions/ERC4626.sol)
pragma solidity ^0.8.0;
import "../ERC20Upgradeable.sol";
import "../utils/SafeERC20Upgradeable.sol";
import "../../../interfaces/IERC4626Upgradeable.sol";
import "../../../utils/math/MathUpgradeable.sol";
import {Initializable} from "../../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the ERC4626 "Tokenized Vault Standard" as defined in
* https://eips.ethereum.org/EIPS/eip-4626[EIP-4626].
*
* This extension allows the minting and burning of "shares" (represented using the ERC20 inheritance) in exchange for
* underlying "assets" through standardized {deposit}, {mint}, {redeem} and {burn} workflows. This contract extends
* the ERC20 standard. Any additional extensions included along it would affect the "shares" token represented by this
* contract and not the "assets" token which is an independent contract.
*
* [CAUTION]
* ====
* In empty (or nearly empty) ERC-4626 vaults, deposits are at high risk of being stolen through frontrunning
* with a "donation" to the vault that inflates the price of a share. This is variously known as a donation or inflation
* attack and is essentially a problem of slippage. Vault deployers can protect against this attack by making an initial
* deposit of a non-trivial amount of the asset, such that price manipulation becomes infeasible. Withdrawals may
* similarly be affected by slippage. Users can protect against this attack as well as unexpected slippage in general by
* verifying the amount received is as expected, using a wrapper that performs these checks such as
* https://github.com/fei-protocol/ERC4626#erc4626router-and-base[ERC4626Router].
*
* Since v4.9, this implementation uses virtual assets and shares to mitigate that risk. The `_decimalsOffset()`
* corresponds to an offset in the decimal representation between the underlying asset's decimals and the vault
* decimals. This offset also determines the rate of virtual shares to virtual assets in the vault, which itself
* determines the initial exchange rate. While not fully preventing the attack, analysis shows that the default offset
* (0) makes it non-profitable, as a result of the value being captured by the virtual shares (out of the attacker's
* donation) matching the attacker's expected gains. With a larger offset, the attack becomes orders of magnitude more
* expensive than it is profitable. More details about the underlying math can be found
* xref:erc4626.adoc#inflation-attack[here].
*
* The drawback of this approach is that the virtual shares do capture (a very small) part of the value being accrued
* to the vault. Also, if the vault experiences losses, the users try to exit the vault, the virtual shares and assets
* will cause the first user to exit to experience reduced losses in detriment to the last users that will experience
* bigger losses. Developers willing to revert back to the pre-v4.9 behavior just need to override the
* `_convertToShares` and `_convertToAssets` functions.
*
* To learn more, check out our xref:ROOT:erc4626.adoc[ERC-4626 guide].
* ====
*
* _Available since v4.7._
*/
abstract contract ERC4626Upgradeable is Initializable, ERC20Upgradeable, IERC4626Upgradeable {
using MathUpgradeable for uint256;
IERC20Upgradeable private _asset;
uint8 private _underlyingDecimals;
/**
* @dev Set the underlying asset contract. This must be an ERC20-compatible contract (ERC20 or ERC777).
*/
function __ERC4626_init(IERC20Upgradeable asset_) internal onlyInitializing {
__ERC4626_init_unchained(asset_);
}
function __ERC4626_init_unchained(IERC20Upgradeable asset_) internal onlyInitializing {
(bool success, uint8 assetDecimals) = _tryGetAssetDecimals(asset_);
_underlyingDecimals = success ? assetDecimals : 18;
_asset = asset_;
}
/**
* @dev Attempts to fetch the asset decimals. A return value of false indicates that the attempt failed in some way.
*/
function _tryGetAssetDecimals(IERC20Upgradeable asset_) private view returns (bool, uint8) {
(bool success, bytes memory encodedDecimals) = address(asset_).staticcall(
abi.encodeWithSelector(IERC20MetadataUpgradeable.decimals.selector)
);
if (success && encodedDecimals.length >= 32) {
uint256 returnedDecimals = abi.decode(encodedDecimals, (uint256));
if (returnedDecimals <= type(uint8).max) {
return (true, uint8(returnedDecimals));
}
}
return (false, 0);
}
/**
* @dev Decimals are computed by adding the decimal offset on top of the underlying asset's decimals. This
* "original" value is cached during construction of the vault contract. If this read operation fails (e.g., the
* asset has not been created yet), a default of 18 is used to represent the underlying asset's decimals.
*
* See {IERC20Metadata-decimals}.
*/
function decimals() public view virtual override(IERC20MetadataUpgradeable, ERC20Upgradeable) returns (uint8) {
return _underlyingDecimals + _decimalsOffset();
}
/** @dev See {IERC4626-asset}. */
function asset() public view virtual override returns (address) {
return address(_asset);
}
/** @dev See {IERC4626-totalAssets}. */
function totalAssets() public view virtual override returns (uint256) {
return _asset.balanceOf(address(this));
}
/** @dev See {IERC4626-convertToShares}. */
function convertToShares(uint256 assets) public view virtual override returns (uint256) {
return _convertToShares(assets, MathUpgradeable.Rounding.Down);
}
/** @dev See {IERC4626-convertToAssets}. */
function convertToAssets(uint256 shares) public view virtual override returns (uint256) {
return _convertToAssets(shares, MathUpgradeable.Rounding.Down);
}
/** @dev See {IERC4626-maxDeposit}. */
function maxDeposit(address) public view virtual override returns (uint256) {
return type(uint256).max;
}
/** @dev See {IERC4626-maxMint}. */
function maxMint(address) public view virtual override returns (uint256) {
return type(uint256).max;
}
/** @dev See {IERC4626-maxWithdraw}. */
function maxWithdraw(address owner) public view virtual override returns (uint256) {
return _convertToAssets(balanceOf(owner), MathUpgradeable.Rounding.Down);
}
/** @dev See {IERC4626-maxRedeem}. */
function maxRedeem(address owner) public view virtual override returns (uint256) {
return balanceOf(owner);
}
/** @dev See {IERC4626-previewDeposit}. */
function previewDeposit(uint256 assets) public view virtual override returns (uint256) {
return _convertToShares(assets, MathUpgradeable.Rounding.Down);
}
/** @dev See {IERC4626-previewMint}. */
function previewMint(uint256 shares) public view virtual override returns (uint256) {
return _convertToAssets(shares, MathUpgradeable.Rounding.Up);
}
/** @dev See {IERC4626-previewWithdraw}. */
function previewWithdraw(uint256 assets) public view virtual override returns (uint256) {
return _convertToShares(assets, MathUpgradeable.Rounding.Up);
}
/** @dev See {IERC4626-previewRedeem}. */
function previewRedeem(uint256 shares) public view virtual override returns (uint256) {
return _convertToAssets(shares, MathUpgradeable.Rounding.Down);
}
/** @dev See {IERC4626-deposit}. */
function deposit(uint256 assets, address receiver) public virtual override returns (uint256) {
require(assets <= maxDeposit(receiver), "ERC4626: deposit more than max");
uint256 shares = previewDeposit(assets);
_deposit(_msgSender(), receiver, assets, shares);
return shares;
}
/** @dev See {IERC4626-mint}.
*
* As opposed to {deposit}, minting is allowed even if the vault is in a state where the price of a share is zero.
* In this case, the shares will be minted without requiring any assets to be deposited.
*/
function mint(uint256 shares, address receiver) public virtual override returns (uint256) {
require(shares <= maxMint(receiver), "ERC4626: mint more than max");
uint256 assets = previewMint(shares);
_deposit(_msgSender(), receiver, assets, shares);
return assets;
}
/** @dev See {IERC4626-withdraw}. */
function withdraw(uint256 assets, address receiver, address owner) public virtual override returns (uint256) {
require(assets <= maxWithdraw(owner), "ERC4626: withdraw more than max");
uint256 shares = previewWithdraw(assets);
_withdraw(_msgSender(), receiver, owner, assets, shares);
return shares;
}
/** @dev See {IERC4626-redeem}. */
function redeem(uint256 shares, address receiver, address owner) public virtual override returns (uint256) {
require(shares <= maxRedeem(owner), "ERC4626: redeem more than max");
uint256 assets = previewRedeem(shares);
_withdraw(_msgSender(), receiver, owner, assets, shares);
return assets;
}
/**
* @dev Internal conversion function (from assets to shares) with support for rounding direction.
*/
function _convertToShares(uint256 assets, MathUpgradeable.Rounding rounding) internal view virtual returns (uint256) {
return assets.mulDiv(totalSupply() + 10 ** _decimalsOffset(), totalAssets() + 1, rounding);
}
/**
* @dev Internal conversion function (from shares to assets) with support for rounding direction.
*/
function _convertToAssets(uint256 shares, MathUpgradeable.Rounding rounding) internal view virtual returns (uint256) {
return shares.mulDiv(totalAssets() + 1, totalSupply() + 10 ** _decimalsOffset(), rounding);
}
/**
* @dev Deposit/mint common workflow.
*/
function _deposit(address caller, address receiver, uint256 assets, uint256 shares) internal virtual {
// If _asset is ERC777, `transferFrom` can trigger a reentrancy BEFORE the transfer happens through the
// `tokensToSend` hook. On the other hand, the `tokenReceived` hook, that is triggered after the transfer,
// calls the vault, which is assumed not malicious.
//
// Conclusion: we need to do the transfer before we mint so that any reentrancy would happen before the
// assets are transferred and before the shares are minted, which is a valid state.
// slither-disable-next-line reentrancy-no-eth
SafeERC20Upgradeable.safeTransferFrom(_asset, caller, address(this), assets);
_mint(receiver, shares);
emit Deposit(caller, receiver, assets, shares);
}
/**
* @dev Withdraw/redeem common workflow.
*/
function _withdraw(
address caller,
address receiver,
address owner,
uint256 assets,
uint256 shares
) internal virtual {
if (caller != owner) {
_spendAllowance(owner, caller, shares);
}
// If _asset is ERC777, `transfer` can trigger a reentrancy AFTER the transfer happens through the
// `tokensReceived` hook. On the other hand, the `tokensToSend` hook, that is triggered before the transfer,
// calls the vault, which is assumed not malicious.
//
// Conclusion: we need to do the transfer after the burn so that any reentrancy would happen after the
// shares are burned and after the assets are transferred, which is a valid state.
_burn(owner, shares);
SafeERC20Upgradeable.safeTransfer(_asset, receiver, assets);
emit Withdraw(caller, receiver, owner, assets, shares);
}
function _decimalsOffset() internal view virtual returns (uint8) {
return 0;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20MetadataUpgradeable is IERC20Upgradeable {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20PermitUpgradeable {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20Upgradeable {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 amount) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.3) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
import "../extensions/IERC20PermitUpgradeable.sol";
import "../../../utils/AddressUpgradeable.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 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 SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20Upgradeable {
using AddressUpgradeable for address;
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20Upgradeable token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20Upgradeable token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(IERC20Upgradeable 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'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20Upgradeable token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20Upgradeable token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/
function forceApprove(IERC20Upgradeable token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeWithSelector(token.approve.selector, spender, value);
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
* Revert on invalid signature.
*/
function safePermit(
IERC20PermitUpgradeable token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @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(IERC20Upgradeable 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. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
require(returndata.length == 0 || abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
/**
* @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).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20Upgradeable token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return
success && (returndata.length == 0 || abi.decode(returndata, (bool))) && AddressUpgradeable.isContract(address(token));
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library AddressUpgradeable {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/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.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (utils/Context.sol)
pragma solidity ^0.8.0;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/math/Math.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library MathUpgradeable {
enum Rounding {
Down, // Toward negative infinity
Up, // Toward infinity
Zero // Toward zero
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds up instead
* of rounding down.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
* with further edits by Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1, "Math: mulDiv overflow");
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
// See https://cs.stackexchange.com/q/138556/92363.
// Does not overflow because the denominator cannot be zero at this stage in the function.
uint256 twos = denominator & (~denominator + 1);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (rounding == Rounding.Up && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256, rounded down, of a positive value.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (rounding == Rounding.Up && 1 << (result << 3) < value ? 1 : 0);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
pragma solidity ^0.8.0;
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControl {
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {AccessControl-_setupRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) external;
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
import "./IAccessControlManagerV8.sol";
/**
* @title AccessControlledV8
* @author Venus
* @notice This contract is helper between access control manager and actual contract. This contract further inherited by other contract (using solidity 0.8.13)
* to integrate access controlled mechanism. It provides initialise methods and verifying access methods.
*/
abstract contract AccessControlledV8 is Initializable, Ownable2StepUpgradeable {
/// @notice Access control manager contract
IAccessControlManagerV8 internal _accessControlManager;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
/// @notice Emitted when access control manager contract address is changed
event NewAccessControlManager(address oldAccessControlManager, address newAccessControlManager);
/// @notice Thrown when the action is prohibited by AccessControlManager
error Unauthorized(address sender, address calledContract, string methodSignature);
function __AccessControlled_init(address accessControlManager_) internal onlyInitializing {
__Ownable2Step_init();
__AccessControlled_init_unchained(accessControlManager_);
}
function __AccessControlled_init_unchained(address accessControlManager_) internal onlyInitializing {
_setAccessControlManager(accessControlManager_);
}
/**
* @notice Sets the address of AccessControlManager
* @dev Admin function to set address of AccessControlManager
* @param accessControlManager_ The new address of the AccessControlManager
* @custom:event Emits NewAccessControlManager event
* @custom:access Only Governance
*/
function setAccessControlManager(address accessControlManager_) external onlyOwner {
_setAccessControlManager(accessControlManager_);
}
/**
* @notice Returns the address of the access control manager contract
*/
function accessControlManager() external view returns (IAccessControlManagerV8) {
return _accessControlManager;
}
/**
* @dev Internal function to set address of AccessControlManager
* @param accessControlManager_ The new address of the AccessControlManager
*/
function _setAccessControlManager(address accessControlManager_) internal {
require(address(accessControlManager_) != address(0), "invalid acess control manager address");
address oldAccessControlManager = address(_accessControlManager);
_accessControlManager = IAccessControlManagerV8(accessControlManager_);
emit NewAccessControlManager(oldAccessControlManager, accessControlManager_);
}
/**
* @notice Reverts if the call is not allowed by AccessControlManager
* @param signature Method signature
*/
function _checkAccessAllowed(string memory signature) internal view {
bool isAllowedToCall = _accessControlManager.isAllowedToCall(msg.sender, signature);
if (!isAllowedToCall) {
revert Unauthorized(msg.sender, address(this), signature);
}
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity ^0.8.25;
import "@openzeppelin/contracts/access/IAccessControl.sol";
/**
* @title IAccessControlManagerV8
* @author Venus
* @notice Interface implemented by the `AccessControlManagerV8` contract.
*/
interface IAccessControlManagerV8 is IAccessControl {
function giveCallPermission(address contractAddress, string calldata functionSig, address accountToPermit) external;
function revokeCallPermission(
address contractAddress,
string calldata functionSig,
address accountToRevoke
) external;
function isAllowedToCall(address account, string calldata functionSig) external view returns (bool);
function hasPermission(
address account,
address contractAddress,
string calldata functionSig
) external view returns (bool);
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity ^0.8.25;
interface OracleInterface {
function getPrice(address asset) external view returns (uint256);
}
interface ResilientOracleInterface is OracleInterface {
function updatePrice(address vToken) external;
function updateAssetPrice(address asset) external;
function getUnderlyingPrice(address vToken) external view returns (uint256);
}
interface TwapInterface is OracleInterface {
function updateTwap(address asset) external returns (uint256);
}
interface BoundValidatorInterface {
function validatePriceWithAnchorPrice(
address asset,
uint256 reporterPrice,
uint256 anchorPrice
) external view returns (bool);
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity ^0.8.25;
interface IProtocolShareReserve {
/// @notice it represents the type of vToken income
enum IncomeType {
SPREAD,
LIQUIDATION
}
function updateAssetsState(
address comptroller,
address asset,
IncomeType incomeType
) external;
}// SPDX-License-Identifier: BSD-3-Clause pragma solidity ^0.8.25; /// @dev Base unit for computations, usually used in scaling (multiplications, divisions) uint256 constant EXP_SCALE = 1e18; /// @dev A unit (literal one) in EXP_SCALE, usually used in additions/subtractions uint256 constant MANTISSA_ONE = EXP_SCALE; /// @dev The approximate number of seconds per year uint256 constant SECONDS_PER_YEAR = 31_536_000;
// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { SECONDS_PER_YEAR } from "./constants.sol";
abstract contract TimeManagerV8 {
/// @notice Stores blocksPerYear if isTimeBased is true else secondsPerYear is stored
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
uint256 public immutable blocksOrSecondsPerYear;
/// @notice Acknowledges if a contract is time based or not
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
bool public immutable isTimeBased;
/// @notice Stores the current block timestamp or block number depending on isTimeBased
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
function() view returns (uint256) private immutable _getCurrentSlot;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[48] private __gap;
/// @notice Thrown when blocks per year is invalid
error InvalidBlocksPerYear();
/// @notice Thrown when time based but blocks per year is provided
error InvalidTimeBasedConfiguration();
/**
* @param timeBased_ A boolean indicating whether the contract is based on time or block
* If timeBased is true than blocksPerYear_ param is ignored as blocksOrSecondsPerYear is set to SECONDS_PER_YEAR
* @param blocksPerYear_ The number of blocks per year
* @custom:error InvalidBlocksPerYear is thrown if blocksPerYear entered is zero and timeBased is false
* @custom:error InvalidTimeBasedConfiguration is thrown if blocksPerYear entered is non zero and timeBased is true
* @custom:oz-upgrades-unsafe-allow constructor
*/
constructor(bool timeBased_, uint256 blocksPerYear_) {
if (!timeBased_ && blocksPerYear_ == 0) {
revert InvalidBlocksPerYear();
}
if (timeBased_ && blocksPerYear_ != 0) {
revert InvalidTimeBasedConfiguration();
}
isTimeBased = timeBased_;
blocksOrSecondsPerYear = timeBased_ ? SECONDS_PER_YEAR : blocksPerYear_;
_getCurrentSlot = timeBased_ ? _getBlockTimestamp : _getBlockNumber;
}
/**
* @dev Function to simply retrieve block number or block timestamp
* @return Current block number or block timestamp
*/
function getBlockNumberOrTimestamp() public view virtual returns (uint256) {
return _getCurrentSlot();
}
/**
* @dev Returns the current timestamp in seconds
* @return The current timestamp
*/
function _getBlockTimestamp() private view returns (uint256) {
return block.timestamp;
}
/**
* @dev Returns the current block number
* @return The current block number
*/
function _getBlockNumber() private view returns (uint256) {
return block.number;
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
/// @notice Thrown if the supplied address is a zero address where it is not allowed
error ZeroAddressNotAllowed();
/// @notice Thrown if the supplied value is 0 where it is not allowed
error ZeroValueNotAllowed();
/// @notice Checks if the provided address is nonzero, reverts otherwise
/// @param address_ Address to check
/// @custom:error ZeroAddressNotAllowed is thrown if the provided address is a zero address
function ensureNonzeroAddress(address address_) pure {
if (address_ == address(0)) {
revert ZeroAddressNotAllowed();
}
}
/// @notice Checks if the provided value is nonzero, reverts otherwise
/// @param value_ Value to check
/// @custom:error ZeroValueNotAllowed is thrown if the provided value is 0
function ensureNonzeroValue(uint256 value_) pure {
if (value_ == 0) {
revert ZeroValueNotAllowed();
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity ^0.8.25;
import { PrimeStorageV1 } from "../PrimeStorage.sol";
/**
* @title IPrime
* @author Venus
* @notice Interface for Prime Token
*/
interface IPrime {
struct APRInfo {
// supply APR of the user in BPS
uint256 supplyAPR;
// borrow APR of the user in BPS
uint256 borrowAPR;
// total score of the market
uint256 totalScore;
// score of the user
uint256 userScore;
// capped XVS balance of the user
uint256 xvsBalanceForScore;
// capital of the user
uint256 capital;
// capped supply of the user
uint256 cappedSupply;
// capped borrow of the user
uint256 cappedBorrow;
// capped supply of user in USD
uint256 supplyCapUSD;
// capped borrow of user in USD
uint256 borrowCapUSD;
}
struct Capital {
// capital of the user
uint256 capital;
// capped supply of the user
uint256 cappedSupply;
// capped borrow of the user
uint256 cappedBorrow;
// capped supply of user in USD
uint256 supplyCapUSD;
// capped borrow of user in USD
uint256 borrowCapUSD;
}
/**
* @notice Returns boosted pending interest accrued for a user for all markets
* @param user the account for which to get the accrued interests
* @return pendingRewards the number of underlying tokens accrued by the user for all markets
*/
function getPendingRewards(address user) external returns (PrimeStorageV1.PendingReward[] memory pendingRewards);
/**
* @notice Update total score of multiple users and market
* @param users accounts for which we need to update score
*/
function updateScores(address[] memory users) external;
/**
* @notice Update value of alpha
* @param _alphaNumerator numerator of alpha. If alpha is 0.5 then numerator is 1
* @param _alphaDenominator denominator of alpha. If alpha is 0.5 then denominator is 2
*/
function updateAlpha(uint128 _alphaNumerator, uint128 _alphaDenominator) external;
/**
* @notice Update multipliers for a market
* @param market address of the market vToken
* @param supplyMultiplier new supply multiplier for the market, scaled by 1e18
* @param borrowMultiplier new borrow multiplier for the market, scaled by 1e18
*/
function updateMultipliers(address market, uint256 supplyMultiplier, uint256 borrowMultiplier) external;
/**
* @notice Add a market to prime program
* @param comptroller address of the comptroller
* @param market address of the market vToken
* @param supplyMultiplier the multiplier for supply cap. It should be converted to 1e18
* @param borrowMultiplier the multiplier for borrow cap. It should be converted to 1e18
*/
function addMarket(
address comptroller,
address market,
uint256 supplyMultiplier,
uint256 borrowMultiplier
) external;
/**
* @notice Set limits for total tokens that can be minted
* @param _irrevocableLimit total number of irrevocable tokens that can be minted
* @param _revocableLimit total number of revocable tokens that can be minted
*/
function setLimit(uint256 _irrevocableLimit, uint256 _revocableLimit) external;
/**
* @notice Directly issue prime tokens to users
* @param isIrrevocable are the tokens being issued
* @param users list of address to issue tokens to
*/
function issue(bool isIrrevocable, address[] calldata users) external;
/**
* @notice Executed by XVSVault whenever user's XVSVault balance changes
* @param user the account address whose balance was updated
*/
function xvsUpdated(address user) external;
/**
* @notice accrues interest and updates score for an user for a specific market
* @param user the account address for which to accrue interest and update score
* @param market the market for which to accrue interest and update score
*/
function accrueInterestAndUpdateScore(address user, address market) external;
/**
* @notice For claiming prime token when staking period is completed
*/
function claim() external;
/**
* @notice For burning any prime token
* @param user the account address for which the prime token will be burned
*/
function burn(address user) external;
/**
* @notice To pause or unpause claiming of interest
*/
function togglePause() external;
/**
* @notice For user to claim boosted yield
* @param vToken the market for which claim the accrued interest
* @return amount the amount of tokens transferred to the user
*/
function claimInterest(address vToken) external returns (uint256);
/**
* @notice For user to claim boosted yield
* @param vToken the market for which claim the accrued interest
* @param user the user for which to claim the accrued interest
* @return amount the amount of tokens transferred to the user
*/
function claimInterest(address vToken, address user) external returns (uint256);
/**
* @notice Distributes income from market since last distribution
* @param vToken the market for which to distribute the income
*/
function accrueInterest(address vToken) external;
/**
* @notice Returns boosted interest accrued for a user
* @param vToken the market for which to fetch the accrued interest
* @param user the account for which to get the accrued interest
* @return interestAccrued the number of underlying tokens accrued by the user since the last accrual
*/
function getInterestAccrued(address vToken, address user) external returns (uint256);
/**
* @notice Retrieves an array of all available markets
* @return an array of addresses representing all available markets
*/
function getAllMarkets() external view returns (address[] memory);
/**
* @notice fetch the numbers of seconds remaining for staking period to complete
* @param user the account address for which we are checking the remaining time
* @return timeRemaining the number of seconds the user needs to wait to claim prime token
*/
function claimTimeRemaining(address user) external view returns (uint256);
/**
* @notice Returns supply and borrow APR for user for a given market
* @param market the market for which to fetch the APR
* @param user the account for which to get the APR
* @return aprInfo APR information for the user for the given market
*/
function calculateAPR(address market, address user) external view returns (APRInfo memory aprInfo);
/**
* @notice Returns supply and borrow APR for estimated supply, borrow and XVS staked
* @param market the market for which to fetch the APR
* @param user the account for which to get the APR
* @param borrow hypothetical borrow amount
* @param supply hypothetical supply amount
* @param xvsStaked hypothetical staked XVS amount
* @return aprInfo APR information for the user for the given market
*/
function estimateAPR(
address market,
address user,
uint256 borrow,
uint256 supply,
uint256 xvsStaked
) external view returns (APRInfo memory aprInfo);
/**
* @notice the total income that's going to be distributed in a year to prime token holders
* @param vToken the market for which to fetch the total income that's going to distributed in a year
* @return amount the total income
*/
function incomeDistributionYearly(address vToken) external view returns (uint256 amount);
/**
* @notice Returns if user is a prime holder
* @return isPrimeHolder true if user is a prime holder
*/
function isUserPrimeHolder(address user) external view returns (bool);
/**
* @notice Set the limit for the loops can iterate to avoid the DOS
* @param loopsLimit Number of loops limit
*/
function setMaxLoopsLimit(uint256 loopsLimit) external;
/**
* @notice Update staked at timestamp for multiple users
* @param users accounts for which we need to update staked at timestamp
* @param timestamps new staked at timestamp for the users
*/
function setStakedAt(address[] calldata users, uint256[] calldata timestamps) external;
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { ResilientOracleInterface } from "@venusprotocol/oracle/contracts/interfaces/OracleInterface.sol";
/**
* @title PrimeStorageV1
* @author Venus
* @notice Storage for Prime Token
*/
contract PrimeStorageV1 {
struct Token {
bool exists;
bool isIrrevocable;
}
struct Market {
uint256 supplyMultiplier;
uint256 borrowMultiplier;
uint256 rewardIndex;
uint256 sumOfMembersScore;
bool exists;
}
struct Interest {
uint256 accrued;
uint256 score;
uint256 rewardIndex;
}
struct PendingReward {
address vToken;
address rewardToken;
uint256 amount;
}
/// @notice Base unit for computations, usually used in scaling (multiplications, divisions)
uint256 internal constant EXP_SCALE = 1e18;
/// @notice maximum BPS = 100%
uint256 internal constant MAXIMUM_BPS = 1e4;
/// @notice Mapping to get prime token's metadata
mapping(address => Token) public tokens;
/// @notice Tracks total irrevocable tokens minted
uint256 public totalIrrevocable;
/// @notice Tracks total revocable tokens minted
uint256 public totalRevocable;
/// @notice Indicates maximum revocable tokens that can be minted
uint256 public revocableLimit;
/// @notice Indicates maximum irrevocable tokens that can be minted
uint256 public irrevocableLimit;
/// @notice Tracks when prime token eligible users started staking for claiming prime token
mapping(address => uint256) public stakedAt;
/// @notice vToken to market configuration
mapping(address => Market) public markets;
/// @notice vToken to user to user index
mapping(address => mapping(address => Interest)) public interests;
/// @notice A list of boosted markets
address[] internal _allMarkets;
/// @notice numerator of alpha. Ex: if alpha is 0.5 then this will be 1
uint128 public alphaNumerator;
/// @notice denominator of alpha. Ex: if alpha is 0.5 then this will be 2
uint128 public alphaDenominator;
/// @notice address of XVS vault
address public xvsVault;
/// @notice address of XVS vault reward token
address public xvsVaultRewardToken;
/// @notice address of XVS vault pool id
uint256 public xvsVaultPoolId;
/// @notice mapping to check if a account's score was updated in the round
mapping(uint256 => mapping(address => bool)) public isScoreUpdated;
/// @notice unique id for next round
uint256 public nextScoreUpdateRoundId;
/// @notice total number of accounts whose score needs to be updated
uint256 public totalScoreUpdatesRequired;
/// @notice total number of accounts whose score is yet to be updated
uint256 public pendingScoreUpdates;
/// @notice mapping used to find if an asset is part of prime markets
mapping(address => address) public vTokenForAsset;
/// @notice Address of core pool comptroller contract
address internal corePoolComptroller;
/// @notice unreleased income from PLP that's already distributed to prime holders
/// @dev mapping of asset address => amount
mapping(address => uint256) public unreleasedPLPIncome;
/// @notice The address of PLP contract
address public primeLiquidityProvider;
/// @notice The address of ResilientOracle contract
ResilientOracleInterface public oracle;
/// @notice The address of PoolRegistry contract
address public poolRegistry;
/// @dev This empty reserved space is put in place to allow future versions to add new
/// variables without shifting down storage in the inheritance chain.
uint256[26] private __gap;
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { Ownable2StepUpgradeable } from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
import { ResilientOracleInterface } from "@venusprotocol/oracle/contracts/interfaces/OracleInterface.sol";
import { AccessControlledV8 } from "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
import { IPrime } from "@venusprotocol/venus-protocol/contracts/Tokens/Prime/Interfaces/IPrime.sol";
import { ComptrollerInterface, Action } from "./ComptrollerInterface.sol";
import { ComptrollerStorage } from "./ComptrollerStorage.sol";
import { ExponentialNoError } from "./ExponentialNoError.sol";
import { VToken } from "./VToken.sol";
import { RewardsDistributor } from "./Rewards/RewardsDistributor.sol";
import { MaxLoopsLimitHelper } from "./MaxLoopsLimitHelper.sol";
import { ensureNonzeroAddress } from "./lib/validators.sol";
/**
* @title Comptroller
* @author Venus
* @notice The Comptroller is designed to provide checks for all minting, redeeming, transferring, borrowing, lending, repaying, liquidating,
* and seizing done by the `vToken` contract. Each pool has one `Comptroller` checking these interactions across markets. When a user interacts
* with a given market by one of these main actions, a call is made to a corresponding hook in the associated `Comptroller`, which either allows
* or reverts the transaction. These hooks also update supply and borrow rewards as they are called. The comptroller holds the logic for assessing
* liquidity snapshots of an account via the collateral factor and liquidation threshold. This check determines the collateral needed for a borrow,
* as well as how much of a borrow may be liquidated. A user may borrow a portion of their collateral with the maximum amount determined by the
* markets collateral factor. However, if their borrowed amount exceeds an amount calculated using the market’s corresponding liquidation threshold,
* the borrow is eligible for liquidation.
*
* The `Comptroller` also includes two functions `liquidateAccount()` and `healAccount()`, which are meant to handle accounts that do not exceed
* the `minLiquidatableCollateral` for the `Comptroller`:
*
* - `healAccount()`: This function is called to seize all of a given user’s collateral, requiring the `msg.sender` repay a certain percentage
* of the debt calculated by `collateral/(borrows*liquidationIncentive)`. The function can only be called if the calculated percentage does not exceed
* 100%, because otherwise no `badDebt` would be created and `liquidateAccount()` should be used instead. The difference in the actual amount of debt
* and debt paid off is recorded as `badDebt` for each market, which can then be auctioned off for the risk reserves of the associated pool.
* - `liquidateAccount()`: This function can only be called if the collateral seized will cover all borrows of an account, as well as the liquidation
* incentive. Otherwise, the pool will incur bad debt, in which case the function `healAccount()` should be used instead. This function skips the logic
* verifying that the repay amount does not exceed the close factor.
*/
contract Comptroller is
Ownable2StepUpgradeable,
AccessControlledV8,
ComptrollerStorage,
ComptrollerInterface,
ExponentialNoError,
MaxLoopsLimitHelper
{
// PoolRegistry, immutable to save on gas
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
address public immutable poolRegistry;
/// @notice Emitted when an account enters a market
event MarketEntered(VToken indexed vToken, address indexed account);
/// @notice Emitted when an account exits a market
event MarketExited(VToken indexed vToken, address indexed account);
/// @notice Emitted when close factor is changed by admin
event NewCloseFactor(uint256 oldCloseFactorMantissa, uint256 newCloseFactorMantissa);
/// @notice Emitted when a collateral factor is changed by admin
event NewCollateralFactor(VToken vToken, uint256 oldCollateralFactorMantissa, uint256 newCollateralFactorMantissa);
/// @notice Emitted when liquidation threshold is changed by admin
event NewLiquidationThreshold(
VToken vToken,
uint256 oldLiquidationThresholdMantissa,
uint256 newLiquidationThresholdMantissa
);
/// @notice Emitted when liquidation incentive is changed by admin
event NewLiquidationIncentive(uint256 oldLiquidationIncentiveMantissa, uint256 newLiquidationIncentiveMantissa);
/// @notice Emitted when price oracle is changed
event NewPriceOracle(ResilientOracleInterface oldPriceOracle, ResilientOracleInterface newPriceOracle);
/// @notice Emitted when an action is paused on a market
event ActionPausedMarket(VToken vToken, Action action, bool pauseState);
/// @notice Emitted when borrow cap for a vToken is changed
event NewBorrowCap(VToken indexed vToken, uint256 newBorrowCap);
/// @notice Emitted when the collateral threshold (in USD) for non-batch liquidations is changed
event NewMinLiquidatableCollateral(uint256 oldMinLiquidatableCollateral, uint256 newMinLiquidatableCollateral);
/// @notice Emitted when supply cap for a vToken is changed
event NewSupplyCap(VToken indexed vToken, uint256 newSupplyCap);
/// @notice Emitted when a rewards distributor is added
event NewRewardsDistributor(address indexed rewardsDistributor, address indexed rewardToken);
/// @notice Emitted when a market is supported
event MarketSupported(VToken vToken);
/// @notice Emitted when prime token contract address is changed
event NewPrimeToken(IPrime oldPrimeToken, IPrime newPrimeToken);
/// @notice Emitted when forced liquidation is enabled or disabled for a market
event IsForcedLiquidationEnabledUpdated(address indexed vToken, bool enable);
/// @notice Emitted when a market is unlisted
event MarketUnlisted(address indexed vToken);
/// @notice Emitted when the borrowing or redeeming delegate rights are updated for an account
event DelegateUpdated(address indexed approver, address indexed delegate, bool approved);
/// @notice Thrown when collateral factor exceeds the upper bound
error InvalidCollateralFactor();
/// @notice Thrown when liquidation threshold exceeds the collateral factor
error InvalidLiquidationThreshold();
/// @notice Thrown when the action is only available to specific sender, but the real sender was different
error UnexpectedSender(address expectedSender, address actualSender);
/// @notice Thrown when the oracle returns an invalid price for some asset
error PriceError(address vToken);
/// @notice Thrown if VToken unexpectedly returned a nonzero error code while trying to get account snapshot
error SnapshotError(address vToken, address user);
/// @notice Thrown when the market is not listed
error MarketNotListed(address market);
/// @notice Thrown when a market has an unexpected comptroller
error ComptrollerMismatch();
/// @notice Thrown when user is not member of market
error MarketNotCollateral(address vToken, address user);
/// @notice Thrown when borrow action is not paused
error BorrowActionNotPaused();
/// @notice Thrown when mint action is not paused
error MintActionNotPaused();
/// @notice Thrown when redeem action is not paused
error RedeemActionNotPaused();
/// @notice Thrown when repay action is not paused
error RepayActionNotPaused();
/// @notice Thrown when seize action is not paused
error SeizeActionNotPaused();
/// @notice Thrown when exit market action is not paused
error ExitMarketActionNotPaused();
/// @notice Thrown when transfer action is not paused
error TransferActionNotPaused();
/// @notice Thrown when enter market action is not paused
error EnterMarketActionNotPaused();
/// @notice Thrown when liquidate action is not paused
error LiquidateActionNotPaused();
/// @notice Thrown when borrow cap is not zero
error BorrowCapIsNotZero();
/// @notice Thrown when supply cap is not zero
error SupplyCapIsNotZero();
/// @notice Thrown when collateral factor is not zero
error CollateralFactorIsNotZero();
/**
* @notice Thrown during the liquidation if user's total collateral amount is lower than
* a predefined threshold. In this case only batch liquidations (either liquidateAccount
* or healAccount) are available.
*/
error MinimalCollateralViolated(uint256 expectedGreaterThan, uint256 actual);
error CollateralExceedsThreshold(uint256 expectedLessThanOrEqualTo, uint256 actual);
error InsufficientCollateral(uint256 collateralToSeize, uint256 availableCollateral);
/// @notice Thrown when the account doesn't have enough liquidity to redeem or borrow
error InsufficientLiquidity();
/// @notice Thrown when trying to liquidate a healthy account
error InsufficientShortfall();
/// @notice Thrown when trying to repay more than allowed by close factor
error TooMuchRepay();
/// @notice Thrown if the user is trying to exit a market in which they have an outstanding debt
error NonzeroBorrowBalance();
/// @notice Thrown when trying to perform an action that is paused
error ActionPaused(address market, Action action);
/// @notice Thrown when trying to add a market that is already listed
error MarketAlreadyListed(address market);
/// @notice Thrown if the supply cap is exceeded
error SupplyCapExceeded(address market, uint256 cap);
/// @notice Thrown if the borrow cap is exceeded
error BorrowCapExceeded(address market, uint256 cap);
/// @notice Thrown if delegate approval status is already set to the requested value
error DelegationStatusUnchanged();
/// @param poolRegistry_ Pool registry address
/// @custom:oz-upgrades-unsafe-allow constructor
/// @custom:error ZeroAddressNotAllowed is thrown when pool registry address is zero
constructor(address poolRegistry_) {
ensureNonzeroAddress(poolRegistry_);
poolRegistry = poolRegistry_;
_disableInitializers();
}
/**
* @param loopLimit Limit for the loops can iterate to avoid the DOS
* @param accessControlManager Access control manager contract address
*/
function initialize(uint256 loopLimit, address accessControlManager) external initializer {
__Ownable2Step_init();
__AccessControlled_init_unchained(accessControlManager);
_setMaxLoopsLimit(loopLimit);
}
/**
* @notice Add assets to be included in account liquidity calculation; enabling them to be used as collateral
* @param vTokens The list of addresses of the vToken markets to be enabled
* @return errors An array of NO_ERROR for compatibility with Venus core tooling
* @custom:event MarketEntered is emitted for each market on success
* @custom:error ActionPaused error is thrown if entering any of the markets is paused
* @custom:error MarketNotListed error is thrown if any of the markets is not listed
* @custom:access Not restricted
*/
function enterMarkets(address[] memory vTokens) external override returns (uint256[] memory) {
uint256 len = vTokens.length;
uint256[] memory results = new uint256[](len);
for (uint256 i; i < len; ++i) {
VToken vToken = VToken(vTokens[i]);
_addToMarket(vToken, msg.sender);
results[i] = NO_ERROR;
}
return results;
}
/**
* @notice Unlist a market by setting isListed to false
* @dev Checks if all actions are paused, borrow/supply caps is set to 0 and collateral factor is to 0.
* @param market The address of the market (token) to unlist
* @return uint256 Always NO_ERROR for compatibility with Venus core tooling
* @custom:event MarketUnlisted is emitted on success
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:error BorrowActionNotPaused error is thrown if borrow action is not paused
* @custom:error MintActionNotPaused error is thrown if mint action is not paused
* @custom:error RedeemActionNotPaused error is thrown if redeem action is not paused
* @custom:error RepayActionNotPaused error is thrown if repay action is not paused
* @custom:error EnterMarketActionNotPaused error is thrown if enter market action is not paused
* @custom:error LiquidateActionNotPaused error is thrown if liquidate action is not paused
* @custom:error BorrowCapIsNotZero error is thrown if borrow cap is not zero
* @custom:error SupplyCapIsNotZero error is thrown if supply cap is not zero
* @custom:error CollateralFactorIsNotZero error is thrown if collateral factor is not zero
*/
function unlistMarket(address market) external returns (uint256) {
_checkAccessAllowed("unlistMarket(address)");
Market storage _market = markets[market];
if (!_market.isListed) {
revert MarketNotListed(market);
}
if (!actionPaused(market, Action.BORROW)) {
revert BorrowActionNotPaused();
}
if (!actionPaused(market, Action.MINT)) {
revert MintActionNotPaused();
}
if (!actionPaused(market, Action.REDEEM)) {
revert RedeemActionNotPaused();
}
if (!actionPaused(market, Action.REPAY)) {
revert RepayActionNotPaused();
}
if (!actionPaused(market, Action.SEIZE)) {
revert SeizeActionNotPaused();
}
if (!actionPaused(market, Action.ENTER_MARKET)) {
revert EnterMarketActionNotPaused();
}
if (!actionPaused(market, Action.LIQUIDATE)) {
revert LiquidateActionNotPaused();
}
if (!actionPaused(market, Action.TRANSFER)) {
revert TransferActionNotPaused();
}
if (!actionPaused(market, Action.EXIT_MARKET)) {
revert ExitMarketActionNotPaused();
}
if (borrowCaps[market] != 0) {
revert BorrowCapIsNotZero();
}
if (supplyCaps[market] != 0) {
revert SupplyCapIsNotZero();
}
if (_market.collateralFactorMantissa != 0) {
revert CollateralFactorIsNotZero();
}
_market.isListed = false;
emit MarketUnlisted(market);
return NO_ERROR;
}
/**
* @notice Grants or revokes the borrowing or redeeming delegate rights to / from an account
* If allowed, the delegate will be able to borrow funds on behalf of the sender
* Upon a delegated borrow, the delegate will receive the funds, and the borrower
* will see the debt on their account
* Upon a delegated redeem, the delegate will receive the redeemed amount and the approver
* will see a deduction in his vToken balance
* @param delegate The address to update the rights for
* @param approved Whether to grant (true) or revoke (false) the borrowing or redeeming rights
* @custom:event DelegateUpdated emits on success
* @custom:error ZeroAddressNotAllowed is thrown when delegate address is zero
* @custom:error DelegationStatusUnchanged is thrown if approval status is already set to the requested value
* @custom:access Not restricted
*/
function updateDelegate(address delegate, bool approved) external {
ensureNonzeroAddress(delegate);
if (approvedDelegates[msg.sender][delegate] == approved) {
revert DelegationStatusUnchanged();
}
approvedDelegates[msg.sender][delegate] = approved;
emit DelegateUpdated(msg.sender, delegate, approved);
}
/**
* @notice Removes asset from sender's account liquidity calculation; disabling them as collateral
* @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 error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event MarketExited is emitted on success
* @custom:error ActionPaused error is thrown if exiting the market is paused
* @custom:error NonzeroBorrowBalance error is thrown if the user has an outstanding borrow in this market
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:error InsufficientLiquidity error is thrown if exiting the market would lead to user's insolvency
* @custom:error SnapshotError is thrown if some vToken fails to return the account's supply and borrows
* @custom:error PriceError is thrown if the oracle returns an incorrect price for some asset
* @custom:access Not restricted
*/
function exitMarket(address vTokenAddress) external override returns (uint256) {
_checkActionPauseState(vTokenAddress, Action.EXIT_MARKET);
VToken vToken = VToken(vTokenAddress);
/* Get sender tokensHeld and amountOwed underlying from the vToken */
(uint256 tokensHeld, uint256 amountOwed, ) = _safeGetAccountSnapshot(vToken, msg.sender);
/* Fail if the sender has a borrow balance */
if (amountOwed != 0) {
revert NonzeroBorrowBalance();
}
/* Fail if the sender is not permitted to redeem all of their tokens */
_checkRedeemAllowed(vTokenAddress, msg.sender, tokensHeld);
Market storage marketToExit = markets[address(vToken)];
/* Return true if the sender is not already ‘in’ the market */
if (!marketToExit.accountMembership[msg.sender]) {
return NO_ERROR;
}
/* Set vToken account membership to false */
delete marketToExit.accountMembership[msg.sender];
/* Delete vToken from the account’s list of assets */
// load into memory for faster iteration
VToken[] memory userAssetList = accountAssets[msg.sender];
uint256 len = userAssetList.length;
uint256 assetIndex = len;
for (uint256 i; i < len; ++i) {
if (userAssetList[i] == vToken) {
assetIndex = i;
break;
}
}
// We *must* have found the asset in the list or our redundant data structure is broken
assert(assetIndex < len);
// copy last item in list to location of item to be removed, reduce length by 1
VToken[] storage storedList = accountAssets[msg.sender];
storedList[assetIndex] = storedList[storedList.length - 1];
storedList.pop();
emit MarketExited(vToken, msg.sender);
return 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
* @custom:error ActionPaused error is thrown if supplying to this market is paused
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:error SupplyCapExceeded error is thrown if the total supply exceeds the cap after minting
* @custom:access Not restricted
*/
function preMintHook(address vToken, address minter, uint256 mintAmount) external override {
_checkActionPauseState(vToken, Action.MINT);
if (!markets[vToken].isListed) {
revert MarketNotListed(address(vToken));
}
uint256 supplyCap = supplyCaps[vToken];
// Skipping the cap check for uncapped coins to save some gas
if (supplyCap != type(uint256).max) {
uint256 vTokenSupply = VToken(vToken).totalSupply();
Exp memory exchangeRate = Exp({ mantissa: VToken(vToken).exchangeRateStored() });
uint256 nextTotalSupply = mul_ScalarTruncateAddUInt(exchangeRate, vTokenSupply, mintAmount);
if (nextTotalSupply > supplyCap) {
revert SupplyCapExceeded(vToken, supplyCap);
}
}
// Keep the flywheel moving
uint256 rewardDistributorsCount = rewardsDistributors.length;
for (uint256 i; i < rewardDistributorsCount; ++i) {
RewardsDistributor rewardsDistributor = rewardsDistributors[i];
rewardsDistributor.updateRewardTokenSupplyIndex(vToken);
rewardsDistributor.distributeSupplierRewardToken(vToken, minter);
}
}
/**
* @notice Validates mint, accrues interest and updates score in prime. 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
*/
// solhint-disable-next-line no-unused-vars
function mintVerify(address vToken, address minter, uint256 actualMintAmount, uint256 mintTokens) external {
if (address(prime) != address(0)) {
prime.accrueInterestAndUpdateScore(minter, vToken);
}
}
/**
* @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
* @custom:error ActionPaused error is thrown if withdrawals are paused in this market
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:error InsufficientLiquidity error is thrown if the withdrawal would lead to user's insolvency
* @custom:error SnapshotError is thrown if some vToken fails to return the account's supply and borrows
* @custom:error PriceError is thrown if the oracle returns an incorrect price for some asset
* @custom:access Not restricted
*/
function preRedeemHook(address vToken, address redeemer, uint256 redeemTokens) external override {
_checkActionPauseState(vToken, Action.REDEEM);
_checkRedeemAllowed(vToken, redeemer, redeemTokens);
// Keep the flywheel moving
uint256 rewardDistributorsCount = rewardsDistributors.length;
for (uint256 i; i < rewardDistributorsCount; ++i) {
RewardsDistributor rewardsDistributor = rewardsDistributors[i];
rewardsDistributor.updateRewardTokenSupplyIndex(vToken);
rewardsDistributor.distributeSupplierRewardToken(vToken, redeemer);
}
}
/**
* @notice Validates redeem, accrues interest and updates score in prime. 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, uint256 redeemAmount, uint256 redeemTokens) external {
if (address(prime) != address(0)) {
prime.accrueInterestAndUpdateScore(redeemer, vToken);
}
}
/**
* @notice Validates repayBorrow, accrues interest and updates score in prime. 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, // solhint-disable-line no-unused-vars
address borrower,
uint256 actualRepayAmount, // solhint-disable-line no-unused-vars
uint256 borrowerIndex // solhint-disable-line no-unused-vars
) external {
if (address(prime) != address(0)) {
prime.accrueInterestAndUpdateScore(borrower, vToken);
}
}
/**
* @notice Validates liquidateBorrow, accrues interest and updates score in prime. 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
* @param seizeTokens The amount of collateral token that will be seized
*/
function liquidateBorrowVerify(
address vTokenBorrowed,
address vTokenCollateral, // solhint-disable-line no-unused-vars
address liquidator,
address borrower,
uint256 actualRepayAmount, // solhint-disable-line no-unused-vars
uint256 seizeTokens // solhint-disable-line no-unused-vars
) external {
if (address(prime) != address(0)) {
prime.accrueInterestAndUpdateScore(borrower, vTokenBorrowed);
prime.accrueInterestAndUpdateScore(liquidator, vTokenBorrowed);
}
}
/**
* @notice Validates seize, accrues interest and updates score in prime. 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, // solhint-disable-line no-unused-vars
address liquidator,
address borrower,
uint256 seizeTokens // solhint-disable-line no-unused-vars
) external {
if (address(prime) != address(0)) {
prime.accrueInterestAndUpdateScore(borrower, vTokenCollateral);
prime.accrueInterestAndUpdateScore(liquidator, vTokenCollateral);
}
}
/**
* @notice Validates transfer, accrues interest and updates score in prime. 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
*/
// solhint-disable-next-line no-unused-vars
function transferVerify(address vToken, address src, address dst, uint256 transferTokens) external {
if (address(prime) != address(0)) {
prime.accrueInterestAndUpdateScore(src, vToken);
prime.accrueInterestAndUpdateScore(dst, vToken);
}
}
/**
* @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
* @custom:error ActionPaused error is thrown if borrowing is paused in this market
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:error InsufficientLiquidity error is thrown if there is not enough collateral to borrow
* @custom:error BorrowCapExceeded is thrown if the borrow cap will be exceeded should this borrow succeed
* @custom:error SnapshotError is thrown if some vToken fails to return the account's supply and borrows
* @custom:error PriceError is thrown if the oracle returns an incorrect price for some asset
* @custom:access Not restricted if vToken is enabled as collateral, otherwise only vToken
*/
/// disable-eslint
function preBorrowHook(address vToken, address borrower, uint256 borrowAmount) external override {
_checkActionPauseState(vToken, Action.BORROW);
if (!markets[vToken].isListed) {
revert MarketNotListed(address(vToken));
}
if (!markets[vToken].accountMembership[borrower]) {
// only vTokens may call borrowAllowed if borrower not in market
_checkSenderIs(vToken);
// attempt to add borrower to the market or revert
_addToMarket(VToken(msg.sender), borrower);
}
// Update the prices of tokens
updatePrices(borrower);
if (oracle.getUnderlyingPrice(vToken) == 0) {
revert PriceError(address(vToken));
}
uint256 borrowCap = borrowCaps[vToken];
// Skipping the cap check for uncapped coins to save some gas
if (borrowCap != type(uint256).max) {
uint256 totalBorrows = VToken(vToken).totalBorrows();
uint256 badDebt = VToken(vToken).badDebt();
uint256 nextTotalBorrows = totalBorrows + borrowAmount + badDebt;
if (nextTotalBorrows > borrowCap) {
revert BorrowCapExceeded(vToken, borrowCap);
}
}
AccountLiquiditySnapshot memory snapshot = _getHypotheticalLiquiditySnapshot(
borrower,
VToken(vToken),
0,
borrowAmount,
_getCollateralFactor
);
if (snapshot.shortfall > 0) {
revert InsufficientLiquidity();
}
Exp memory borrowIndex = Exp({ mantissa: VToken(vToken).borrowIndex() });
// Keep the flywheel moving
uint256 rewardDistributorsCount = rewardsDistributors.length;
for (uint256 i; i < rewardDistributorsCount; ++i) {
RewardsDistributor rewardsDistributor = rewardsDistributors[i];
rewardsDistributor.updateRewardTokenBorrowIndex(vToken, borrowIndex);
rewardsDistributor.distributeBorrowerRewardToken(vToken, borrower, borrowIndex);
}
}
/**
* @notice Validates borrow, accrues interest and updates score in prime. 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
*/
// solhint-disable-next-line no-unused-vars
function borrowVerify(address vToken, address borrower, uint256 borrowAmount) external {
if (address(prime) != address(0)) {
prime.accrueInterestAndUpdateScore(borrower, vToken);
}
}
/**
* @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 borrower The account which would borrowed the asset
* @custom:error ActionPaused error is thrown if repayments are paused in this market
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:access Not restricted
*/
function preRepayHook(address vToken, address borrower) external override {
_checkActionPauseState(vToken, Action.REPAY);
oracle.updatePrice(vToken);
if (!markets[vToken].isListed) {
revert MarketNotListed(address(vToken));
}
// Keep the flywheel moving
uint256 rewardDistributorsCount = rewardsDistributors.length;
for (uint256 i; i < rewardDistributorsCount; ++i) {
Exp memory borrowIndex = Exp({ mantissa: VToken(vToken).borrowIndex() });
RewardsDistributor rewardsDistributor = rewardsDistributors[i];
rewardsDistributor.updateRewardTokenBorrowIndex(vToken, borrowIndex);
rewardsDistributor.distributeBorrowerRewardToken(vToken, borrower, borrowIndex);
}
}
/**
* @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 borrower The address of the borrower
* @param repayAmount The amount of underlying being repaid
* @param skipLiquidityCheck Allows the borrow to be liquidated regardless of the account liquidity
* @custom:error ActionPaused error is thrown if liquidations are paused in this market
* @custom:error MarketNotListed error is thrown if either collateral or borrowed token is not listed
* @custom:error TooMuchRepay error is thrown if the liquidator is trying to repay more than allowed by close factor
* @custom:error MinimalCollateralViolated is thrown if the users' total collateral is lower than the threshold for non-batch liquidations
* @custom:error InsufficientShortfall is thrown when trying to liquidate a healthy account
* @custom:error SnapshotError is thrown if some vToken fails to return the account's supply and borrows
* @custom:error PriceError is thrown if the oracle returns an incorrect price for some asset
*/
function preLiquidateHook(
address vTokenBorrowed,
address vTokenCollateral,
address borrower,
uint256 repayAmount,
bool skipLiquidityCheck
) external override {
// Pause Action.LIQUIDATE on BORROWED TOKEN to prevent liquidating it.
// If we want to pause liquidating to vTokenCollateral, we should pause
// Action.SEIZE on it
_checkActionPauseState(vTokenBorrowed, Action.LIQUIDATE);
// Update the prices of tokens
updatePrices(borrower);
if (!markets[vTokenBorrowed].isListed) {
revert MarketNotListed(address(vTokenBorrowed));
}
if (!markets[vTokenCollateral].isListed) {
revert MarketNotListed(address(vTokenCollateral));
}
uint256 borrowBalance = VToken(vTokenBorrowed).borrowBalanceStored(borrower);
/* Allow accounts to be liquidated if it is a forced liquidation */
if (skipLiquidityCheck || isForcedLiquidationEnabled[vTokenBorrowed]) {
if (repayAmount > borrowBalance) {
revert TooMuchRepay();
}
return;
}
/* The borrower must have shortfall and collateral > threshold in order to be liquidatable */
AccountLiquiditySnapshot memory snapshot = _getCurrentLiquiditySnapshot(borrower, _getLiquidationThreshold);
if (snapshot.totalCollateral <= minLiquidatableCollateral) {
/* The liquidator should use either liquidateAccount or healAccount */
revert MinimalCollateralViolated(minLiquidatableCollateral, snapshot.totalCollateral);
}
if (snapshot.shortfall == 0) {
revert InsufficientShortfall();
}
/* The liquidator may not repay more than what is allowed by the closeFactor */
uint256 maxClose = mul_ScalarTruncate(Exp({ mantissa: closeFactorMantissa }), borrowBalance);
if (repayAmount > maxClose) {
revert TooMuchRepay();
}
}
/**
* @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 seizerContract Contract that tries to seize the asset (either borrowed vToken or Comptroller)
* @param liquidator The address repaying the borrow and seizing the collateral
* @param borrower The address of the borrower
* @custom:error ActionPaused error is thrown if seizing this type of collateral is paused
* @custom:error MarketNotListed error is thrown if either collateral or borrowed token is not listed
* @custom:error ComptrollerMismatch error is when seizer contract or seized asset belong to different pools
* @custom:access Not restricted
*/
function preSeizeHook(
address vTokenCollateral,
address seizerContract,
address liquidator,
address borrower
) external override {
// Pause Action.SEIZE on COLLATERAL to prevent seizing it.
// If we want to pause liquidating vTokenBorrowed, we should pause
// Action.LIQUIDATE on it
_checkActionPauseState(vTokenCollateral, Action.SEIZE);
Market storage market = markets[vTokenCollateral];
if (!market.isListed) {
revert MarketNotListed(vTokenCollateral);
}
if (seizerContract == address(this)) {
// If Comptroller is the seizer, just check if collateral's comptroller
// is equal to the current address
if (address(VToken(vTokenCollateral).comptroller()) != address(this)) {
revert ComptrollerMismatch();
}
} else {
// If the seizer is not the Comptroller, check that the seizer is a
// listed market, and that the markets' comptrollers match
if (!markets[seizerContract].isListed) {
revert MarketNotListed(seizerContract);
}
if (VToken(vTokenCollateral).comptroller() != VToken(seizerContract).comptroller()) {
revert ComptrollerMismatch();
}
}
if (!market.accountMembership[borrower]) {
revert MarketNotCollateral(vTokenCollateral, borrower);
}
// Keep the flywheel moving
uint256 rewardDistributorsCount = rewardsDistributors.length;
for (uint256 i; i < rewardDistributorsCount; ++i) {
RewardsDistributor rewardsDistributor = rewardsDistributors[i];
rewardsDistributor.updateRewardTokenSupplyIndex(vTokenCollateral);
rewardsDistributor.distributeSupplierRewardToken(vTokenCollateral, borrower);
rewardsDistributor.distributeSupplierRewardToken(vTokenCollateral, liquidator);
}
}
/**
* @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
* @custom:error ActionPaused error is thrown if withdrawals are paused in this market
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:error InsufficientLiquidity error is thrown if the withdrawal would lead to user's insolvency
* @custom:error SnapshotError is thrown if some vToken fails to return the account's supply and borrows
* @custom:error PriceError is thrown if the oracle returns an incorrect price for some asset
* @custom:access Not restricted
*/
function preTransferHook(address vToken, address src, address dst, uint256 transferTokens) external override {
_checkActionPauseState(vToken, Action.TRANSFER);
// Currently the only consideration is whether or not
// the src is allowed to redeem this many tokens
_checkRedeemAllowed(vToken, src, transferTokens);
// Keep the flywheel moving
uint256 rewardDistributorsCount = rewardsDistributors.length;
for (uint256 i; i < rewardDistributorsCount; ++i) {
RewardsDistributor rewardsDistributor = rewardsDistributors[i];
rewardsDistributor.updateRewardTokenSupplyIndex(vToken);
rewardsDistributor.distributeSupplierRewardToken(vToken, src);
rewardsDistributor.distributeSupplierRewardToken(vToken, dst);
}
}
/*** Pool-level operations ***/
/**
* @notice Seizes all the remaining collateral, makes msg.sender repay the existing
* borrows, and treats the rest of the debt as bad debt (for each market).
* The sender has to repay a certain percentage of the debt, computed as
* collateral / (borrows * liquidationIncentive).
* @param user account to heal
* @custom:error CollateralExceedsThreshold error is thrown when the collateral is too big for healing
* @custom:error SnapshotError is thrown if some vToken fails to return the account's supply and borrows
* @custom:error PriceError is thrown if the oracle returns an incorrect price for some asset
* @custom:access Not restricted
*/
function healAccount(address user) external {
VToken[] memory userAssets = getAssetsIn(user);
uint256 userAssetsCount = userAssets.length;
address liquidator = msg.sender;
{
ResilientOracleInterface oracle_ = oracle;
// We need all user's markets to be fresh for the computations to be correct
for (uint256 i; i < userAssetsCount; ++i) {
userAssets[i].accrueInterest();
oracle_.updatePrice(address(userAssets[i]));
}
}
AccountLiquiditySnapshot memory snapshot = _getCurrentLiquiditySnapshot(user, _getLiquidationThreshold);
if (snapshot.totalCollateral > minLiquidatableCollateral) {
revert CollateralExceedsThreshold(minLiquidatableCollateral, snapshot.totalCollateral);
}
if (snapshot.shortfall == 0) {
revert InsufficientShortfall();
}
// percentage = collateral / (borrows * liquidation incentive)
Exp memory collateral = Exp({ mantissa: snapshot.totalCollateral });
Exp memory scaledBorrows = mul_(
Exp({ mantissa: snapshot.borrows }),
Exp({ mantissa: liquidationIncentiveMantissa })
);
Exp memory percentage = div_(collateral, scaledBorrows);
if (lessThanExp(Exp({ mantissa: MANTISSA_ONE }), percentage)) {
revert CollateralExceedsThreshold(scaledBorrows.mantissa, collateral.mantissa);
}
for (uint256 i; i < userAssetsCount; ++i) {
VToken market = userAssets[i];
(uint256 tokens, uint256 borrowBalance, ) = _safeGetAccountSnapshot(market, user);
uint256 repaymentAmount = mul_ScalarTruncate(percentage, borrowBalance);
// Seize the entire collateral
if (tokens != 0) {
market.seize(liquidator, user, tokens);
}
// Repay a certain percentage of the borrow, forgive the rest
if (borrowBalance != 0) {
market.healBorrow(liquidator, user, repaymentAmount);
}
}
}
/**
* @notice Liquidates all borrows of the borrower. Callable only if the collateral is less than
* a predefined threshold, and the account collateral can be seized to cover all borrows. If
* the collateral is higher than the threshold, use regular liquidations. If the collateral is
* below the threshold, and the account is insolvent, use healAccount.
* @param borrower the borrower address
* @param orders an array of liquidation orders
* @custom:error CollateralExceedsThreshold error is thrown when the collateral is too big for a batch liquidation
* @custom:error InsufficientCollateral error is thrown when there is not enough collateral to cover the debt
* @custom:error SnapshotError is thrown if some vToken fails to return the account's supply and borrows
* @custom:error PriceError is thrown if the oracle returns an incorrect price for some asset
* @custom:access Not restricted
*/
function liquidateAccount(address borrower, LiquidationOrder[] calldata orders) external {
// We will accrue interest and update the oracle prices later during the liquidation
AccountLiquiditySnapshot memory snapshot = _getCurrentLiquiditySnapshot(borrower, _getLiquidationThreshold);
if (snapshot.totalCollateral > minLiquidatableCollateral) {
// You should use the regular vToken.liquidateBorrow(...) call
revert CollateralExceedsThreshold(minLiquidatableCollateral, snapshot.totalCollateral);
}
uint256 collateralToSeize = mul_ScalarTruncate(
Exp({ mantissa: liquidationIncentiveMantissa }),
snapshot.borrows
);
if (collateralToSeize >= snapshot.totalCollateral) {
// There is not enough collateral to seize. Use healBorrow to repay some part of the borrow
// and record bad debt.
revert InsufficientCollateral(collateralToSeize, snapshot.totalCollateral);
}
if (snapshot.shortfall == 0) {
revert InsufficientShortfall();
}
uint256 ordersCount = orders.length;
_ensureMaxLoops(ordersCount / 2);
for (uint256 i; i < ordersCount; ++i) {
if (!markets[address(orders[i].vTokenBorrowed)].isListed) {
revert MarketNotListed(address(orders[i].vTokenBorrowed));
}
if (!markets[address(orders[i].vTokenCollateral)].isListed) {
revert MarketNotListed(address(orders[i].vTokenCollateral));
}
LiquidationOrder calldata order = orders[i];
order.vTokenBorrowed.forceLiquidateBorrow(
msg.sender,
borrower,
order.repayAmount,
order.vTokenCollateral,
true
);
}
VToken[] memory borrowMarkets = getAssetsIn(borrower);
uint256 marketsCount = borrowMarkets.length;
for (uint256 i; i < marketsCount; ++i) {
(, uint256 borrowBalance, ) = _safeGetAccountSnapshot(borrowMarkets[i], borrower);
require(borrowBalance == 0, "Nonzero borrow balance after liquidation");
}
}
/**
* @notice Sets the closeFactor to use when liquidating borrows
* @param newCloseFactorMantissa New close factor, scaled by 1e18
* @custom:event Emits NewCloseFactor on success
* @custom:access Controlled by AccessControlManager
*/
function setCloseFactor(uint256 newCloseFactorMantissa) external {
_checkAccessAllowed("setCloseFactor(uint256)");
require(MAX_CLOSE_FACTOR_MANTISSA >= newCloseFactorMantissa, "Close factor greater than maximum close factor");
require(MIN_CLOSE_FACTOR_MANTISSA <= newCloseFactorMantissa, "Close factor smaller than minimum close factor");
uint256 oldCloseFactorMantissa = closeFactorMantissa;
closeFactorMantissa = newCloseFactorMantissa;
emit NewCloseFactor(oldCloseFactorMantissa, newCloseFactorMantissa);
}
/**
* @notice Sets the collateralFactor for a market
* @dev This function is restricted by the AccessControlManager
* @param vToken The market to set the factor on
* @param newCollateralFactorMantissa The new collateral factor, scaled by 1e18
* @param newLiquidationThresholdMantissa The new liquidation threshold, scaled by 1e18
* @custom:event Emits NewCollateralFactor when collateral factor is updated
* and NewLiquidationThreshold when liquidation threshold is updated
* @custom:error MarketNotListed error is thrown when the market is not listed
* @custom:error InvalidCollateralFactor error is thrown when collateral factor is too high
* @custom:error InvalidLiquidationThreshold error is thrown when liquidation threshold is lower than collateral factor
* @custom:error PriceError is thrown when the oracle returns an invalid price for the asset
* @custom:access Controlled by AccessControlManager
*/
function setCollateralFactor(
VToken vToken,
uint256 newCollateralFactorMantissa,
uint256 newLiquidationThresholdMantissa
) external {
_checkAccessAllowed("setCollateralFactor(address,uint256,uint256)");
// Verify market is listed
Market storage market = markets[address(vToken)];
if (!market.isListed) {
revert MarketNotListed(address(vToken));
}
// Check collateral factor <= 0.9
if (newCollateralFactorMantissa > MAX_COLLATERAL_FACTOR_MANTISSA) {
revert InvalidCollateralFactor();
}
// Ensure that liquidation threshold <= 1
if (newLiquidationThresholdMantissa > MANTISSA_ONE) {
revert InvalidLiquidationThreshold();
}
// Ensure that liquidation threshold >= CF
if (newLiquidationThresholdMantissa < newCollateralFactorMantissa) {
revert InvalidLiquidationThreshold();
}
// If collateral factor != 0, fail if price == 0
if (newCollateralFactorMantissa != 0 && oracle.getUnderlyingPrice(address(vToken)) == 0) {
revert PriceError(address(vToken));
}
uint256 oldCollateralFactorMantissa = market.collateralFactorMantissa;
if (newCollateralFactorMantissa != oldCollateralFactorMantissa) {
market.collateralFactorMantissa = newCollateralFactorMantissa;
emit NewCollateralFactor(vToken, oldCollateralFactorMantissa, newCollateralFactorMantissa);
}
uint256 oldLiquidationThresholdMantissa = market.liquidationThresholdMantissa;
if (newLiquidationThresholdMantissa != oldLiquidationThresholdMantissa) {
market.liquidationThresholdMantissa = newLiquidationThresholdMantissa;
emit NewLiquidationThreshold(vToken, oldLiquidationThresholdMantissa, newLiquidationThresholdMantissa);
}
}
/**
* @notice Sets liquidationIncentive
* @dev This function is restricted by the AccessControlManager
* @param newLiquidationIncentiveMantissa New liquidationIncentive scaled by 1e18
* @custom:event Emits NewLiquidationIncentive on success
* @custom:access Controlled by AccessControlManager
*/
function setLiquidationIncentive(uint256 newLiquidationIncentiveMantissa) external {
require(newLiquidationIncentiveMantissa >= MANTISSA_ONE, "liquidation incentive should be greater than 1e18");
_checkAccessAllowed("setLiquidationIncentive(uint256)");
// Save current value for use in log
uint256 oldLiquidationIncentiveMantissa = liquidationIncentiveMantissa;
// Set liquidation incentive to new incentive
liquidationIncentiveMantissa = newLiquidationIncentiveMantissa;
// Emit event with old incentive, new incentive
emit NewLiquidationIncentive(oldLiquidationIncentiveMantissa, newLiquidationIncentiveMantissa);
}
/**
* @notice Add the market to the markets mapping and set it as listed
* @dev Only callable by the PoolRegistry
* @param vToken The address of the market (token) to list
* @custom:error MarketAlreadyListed is thrown if the market is already listed in this pool
* @custom:access Only PoolRegistry
*/
function supportMarket(VToken vToken) external {
_checkSenderIs(poolRegistry);
if (markets[address(vToken)].isListed) {
revert MarketAlreadyListed(address(vToken));
}
require(vToken.isVToken(), "Comptroller: Invalid vToken"); // Sanity check to make sure its really a VToken
Market storage newMarket = markets[address(vToken)];
newMarket.isListed = true;
newMarket.collateralFactorMantissa = 0;
newMarket.liquidationThresholdMantissa = 0;
_addMarket(address(vToken));
uint256 rewardDistributorsCount = rewardsDistributors.length;
for (uint256 i; i < rewardDistributorsCount; ++i) {
rewardsDistributors[i].initializeMarket(address(vToken));
}
emit MarketSupported(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 This function is restricted by the AccessControlManager
* @dev A borrow cap of type(uint256).max corresponds to unlimited borrowing.
* @dev Borrow caps smaller than the current total borrows are accepted. This way, new borrows will not be allowed
until the total borrows amount goes below the new borrow cap
* @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 type(uint256).max corresponds to unlimited borrowing.
* @custom:access Controlled by AccessControlManager
*/
function setMarketBorrowCaps(VToken[] calldata vTokens, uint256[] calldata newBorrowCaps) external {
_checkAccessAllowed("setMarketBorrowCaps(address[],uint256[])");
uint256 numMarkets = vTokens.length;
uint256 numBorrowCaps = newBorrowCaps.length;
require(numMarkets != 0 && numMarkets == numBorrowCaps, "invalid input");
_ensureMaxLoops(numMarkets);
for (uint256 i; i < numMarkets; ++i) {
borrowCaps[address(vTokens[i])] = newBorrowCaps[i];
emit NewBorrowCap(vTokens[i], newBorrowCaps[i]);
}
}
/**
* @notice Set the given supply caps for the given vToken markets. Supply that brings total Supply to or above supply cap will revert.
* @dev This function is restricted by the AccessControlManager
* @dev A supply cap of type(uint256).max corresponds to unlimited supply.
* @dev Supply caps smaller than the current total supplies are accepted. This way, new supplies will not be allowed
until the total supplies amount goes below the new supply cap
* @param vTokens The addresses of the markets (tokens) to change the supply caps for
* @param newSupplyCaps The new supply cap values in underlying to be set. A value of type(uint256).max corresponds to unlimited supply.
* @custom:access Controlled by AccessControlManager
*/
function setMarketSupplyCaps(VToken[] calldata vTokens, uint256[] calldata newSupplyCaps) external {
_checkAccessAllowed("setMarketSupplyCaps(address[],uint256[])");
uint256 vTokensCount = vTokens.length;
require(vTokensCount != 0, "invalid number of markets");
require(vTokensCount == newSupplyCaps.length, "invalid number of markets");
_ensureMaxLoops(vTokensCount);
for (uint256 i; i < vTokensCount; ++i) {
supplyCaps[address(vTokens[i])] = newSupplyCaps[i];
emit NewSupplyCap(vTokens[i], newSupplyCaps[i]);
}
}
/**
* @notice Pause/unpause specified actions
* @dev This function is restricted by the AccessControlManager
* @param marketsList Markets to pause/unpause the actions on
* @param actionsList List of action ids to pause/unpause
* @param paused The new paused state (true=paused, false=unpaused)
* @custom:access Controlled by AccessControlManager
*/
function setActionsPaused(VToken[] calldata marketsList, Action[] calldata actionsList, bool paused) external {
_checkAccessAllowed("setActionsPaused(address[],uint256[],bool)");
uint256 marketsCount = marketsList.length;
uint256 actionsCount = actionsList.length;
_ensureMaxLoops(marketsCount * actionsCount);
for (uint256 marketIdx; marketIdx < marketsCount; ++marketIdx) {
for (uint256 actionIdx; actionIdx < actionsCount; ++actionIdx) {
_setActionPaused(address(marketsList[marketIdx]), actionsList[actionIdx], paused);
}
}
}
/**
* @notice Set the given collateral threshold for non-batch liquidations. Regular liquidations
* will fail if the collateral amount is less than this threshold. Liquidators should use batch
* operations like liquidateAccount or healAccount.
* @dev This function is restricted by the AccessControlManager
* @param newMinLiquidatableCollateral The new min liquidatable collateral (in USD).
* @custom:access Controlled by AccessControlManager
*/
function setMinLiquidatableCollateral(uint256 newMinLiquidatableCollateral) external {
_checkAccessAllowed("setMinLiquidatableCollateral(uint256)");
uint256 oldMinLiquidatableCollateral = minLiquidatableCollateral;
minLiquidatableCollateral = newMinLiquidatableCollateral;
emit NewMinLiquidatableCollateral(oldMinLiquidatableCollateral, newMinLiquidatableCollateral);
}
/**
* @notice Add a new RewardsDistributor and initialize it with all markets. We can add several RewardsDistributor
* contracts with the same rewardToken, and there could be overlaping among them considering the last reward slot (block or second)
* @dev Only callable by the admin
* @param _rewardsDistributor Address of the RewardDistributor contract to add
* @custom:access Only Governance
* @custom:event Emits NewRewardsDistributor with distributor address
*/
function addRewardsDistributor(RewardsDistributor _rewardsDistributor) external onlyOwner {
require(!rewardsDistributorExists[address(_rewardsDistributor)], "already exists");
uint256 rewardsDistributorsLen = rewardsDistributors.length;
_ensureMaxLoops(rewardsDistributorsLen + 1);
rewardsDistributors.push(_rewardsDistributor);
rewardsDistributorExists[address(_rewardsDistributor)] = true;
uint256 marketsCount = allMarkets.length;
for (uint256 i; i < marketsCount; ++i) {
_rewardsDistributor.initializeMarket(address(allMarkets[i]));
}
emit NewRewardsDistributor(address(_rewardsDistributor), address(_rewardsDistributor.rewardToken()));
}
/**
* @notice Sets a new price oracle for the Comptroller
* @dev Only callable by the admin
* @param newOracle Address of the new price oracle to set
* @custom:event Emits NewPriceOracle on success
* @custom:error ZeroAddressNotAllowed is thrown when the new oracle address is zero
*/
function setPriceOracle(ResilientOracleInterface newOracle) external onlyOwner {
ensureNonzeroAddress(address(newOracle));
ResilientOracleInterface oldOracle = oracle;
oracle = newOracle;
emit NewPriceOracle(oldOracle, newOracle);
}
/**
* @notice Set the for loop iteration limit to avoid DOS
* @param limit Limit for the max loops can execute at a time
*/
function setMaxLoopsLimit(uint256 limit) external onlyOwner {
_setMaxLoopsLimit(limit);
}
/**
* @notice Sets the prime token contract for the comptroller
* @param _prime Address of the Prime contract
*/
function setPrimeToken(IPrime _prime) external onlyOwner {
ensureNonzeroAddress(address(_prime));
emit NewPrimeToken(prime, _prime);
prime = _prime;
}
/**
* @notice Enables forced liquidations for a market. If forced liquidation is enabled,
* borrows in the market may be liquidated regardless of the account liquidity
* @param vTokenBorrowed Borrowed vToken
* @param enable Whether to enable forced liquidations
*/
function setForcedLiquidation(address vTokenBorrowed, bool enable) external {
_checkAccessAllowed("setForcedLiquidation(address,bool)");
ensureNonzeroAddress(vTokenBorrowed);
if (!markets[vTokenBorrowed].isListed) {
revert MarketNotListed(vTokenBorrowed);
}
isForcedLiquidationEnabled[vTokenBorrowed] = enable;
emit IsForcedLiquidationEnabledUpdated(vTokenBorrowed, enable);
}
/**
* @notice Determine the current account liquidity with respect to liquidation threshold requirements
* @dev The interface of this function is intentionally kept compatible with Compound and Venus Core
* @param account The account get liquidity for
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @return liquidity Account liquidity in excess of liquidation threshold requirements,
* @return shortfall Account shortfall below liquidation threshold requirements
*/
function getAccountLiquidity(
address account
) external view returns (uint256 error, uint256 liquidity, uint256 shortfall) {
AccountLiquiditySnapshot memory snapshot = _getCurrentLiquiditySnapshot(account, _getLiquidationThreshold);
return (NO_ERROR, snapshot.liquidity, snapshot.shortfall);
}
/**
* @notice Determine the current account liquidity with respect to collateral requirements
* @dev The interface of this function is intentionally kept compatible with Compound and Venus Core
* @param account The account get liquidity for
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @return liquidity Account liquidity in excess of collateral requirements,
* @return shortfall Account shortfall below collateral requirements
*/
function getBorrowingPower(
address account
) external view returns (uint256 error, uint256 liquidity, uint256 shortfall) {
AccountLiquiditySnapshot memory snapshot = _getCurrentLiquiditySnapshot(account, _getCollateralFactor);
return (NO_ERROR, snapshot.liquidity, snapshot.shortfall);
}
/**
* @notice Determine what the account liquidity would be if the given amounts were redeemed/borrowed
* @dev The interface of this function is intentionally kept compatible with Compound and Venus Core
* @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 error Always NO_ERROR for compatibility with Venus core tooling
* @return liquidity Hypothetical account liquidity in excess of collateral requirements,
* @return shortfall Hypothetical account shortfall below collateral requirements
*/
function getHypotheticalAccountLiquidity(
address account,
address vTokenModify,
uint256 redeemTokens,
uint256 borrowAmount
) external view returns (uint256 error, uint256 liquidity, uint256 shortfall) {
AccountLiquiditySnapshot memory snapshot = _getHypotheticalLiquiditySnapshot(
account,
VToken(vTokenModify),
redeemTokens,
borrowAmount,
_getCollateralFactor
);
return (NO_ERROR, snapshot.liquidity, snapshot.shortfall);
}
/**
* @notice Return all of the markets
* @dev The automatic getter may be used to access an individual market.
* @return markets The list of market addresses
*/
function getAllMarkets() external view override returns (VToken[] memory) {
return allMarkets;
}
/**
* @notice Check if a market is marked as listed (active)
* @param vToken vToken Address for the market to check
* @return listed True if listed otherwise false
*/
function isMarketListed(VToken vToken) external view returns (bool) {
return markets[address(vToken)].isListed;
}
/*** Assets You Are In ***/
/**
* @notice Returns whether the given account is entered in a given market
* @param account The address of the account to check
* @param vToken The vToken to check
* @return True if the account is in the market specified, otherwise false.
*/
function checkMembership(address account, VToken vToken) external view returns (bool) {
return markets[address(vToken)].accountMembership[account];
}
/**
* @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 error Always NO_ERROR for compatibility with Venus core tooling
* @return tokensToSeize Number of vTokenCollateral tokens to be seized in a liquidation
* @custom:error PriceError if the oracle returns an invalid price
*/
function liquidateCalculateSeizeTokens(
address vTokenBorrowed,
address vTokenCollateral,
uint256 actualRepayAmount
) external view override returns (uint256 error, uint256 tokensToSeize) {
/* Read oracle prices for borrowed and collateral markets */
uint256 priceBorrowedMantissa = _safeGetUnderlyingPrice(VToken(vTokenBorrowed));
uint256 priceCollateralMantissa = _safeGetUnderlyingPrice(VToken(vTokenCollateral));
/*
* 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)
*/
uint256 exchangeRateMantissa = VToken(vTokenCollateral).exchangeRateStored(); // Note: reverts on error
uint256 seizeTokens;
Exp memory numerator;
Exp memory denominator;
Exp memory ratio;
numerator = mul_(Exp({ mantissa: liquidationIncentiveMantissa }), Exp({ mantissa: priceBorrowedMantissa }));
denominator = mul_(Exp({ mantissa: priceCollateralMantissa }), Exp({ mantissa: exchangeRateMantissa }));
ratio = div_(numerator, denominator);
seizeTokens = mul_ScalarTruncate(ratio, actualRepayAmount);
return (NO_ERROR, seizeTokens);
}
/**
* @notice Returns reward speed given a vToken
* @param vToken The vToken to get the reward speeds for
* @return rewardSpeeds Array of total supply and borrow speeds and reward token for all reward distributors
*/
function getRewardsByMarket(address vToken) external view returns (RewardSpeeds[] memory rewardSpeeds) {
uint256 rewardsDistributorsLength = rewardsDistributors.length;
rewardSpeeds = new RewardSpeeds[](rewardsDistributorsLength);
for (uint256 i; i < rewardsDistributorsLength; ++i) {
RewardsDistributor rewardsDistributor = rewardsDistributors[i];
address rewardToken = address(rewardsDistributor.rewardToken());
rewardSpeeds[i] = RewardSpeeds({
rewardToken: rewardToken,
supplySpeed: rewardsDistributor.rewardTokenSupplySpeeds(vToken),
borrowSpeed: rewardsDistributor.rewardTokenBorrowSpeeds(vToken)
});
}
return rewardSpeeds;
}
/**
* @notice Return all reward distributors for this pool
* @return Array of RewardDistributor addresses
*/
function getRewardDistributors() external view returns (RewardsDistributor[] memory) {
return rewardsDistributors;
}
/**
* @notice A marker method that returns true for a valid Comptroller contract
* @return Always true
*/
function isComptroller() external pure override returns (bool) {
return true;
}
/**
* @notice Update the prices of all the tokens associated with the provided account
* @param account Address of the account to get associated tokens with
*/
function updatePrices(address account) public {
VToken[] memory vTokens = getAssetsIn(account);
uint256 vTokensCount = vTokens.length;
ResilientOracleInterface oracle_ = oracle;
for (uint256 i; i < vTokensCount; ++i) {
oracle_.updatePrice(address(vTokens[i]));
}
}
/**
* @notice Checks if a certain action is paused on a market
* @param market vToken address
* @param action Action to check
* @return paused True if the action is paused otherwise false
*/
function actionPaused(address market, Action action) public view returns (bool) {
return _actionPaused[market][action];
}
/**
* @notice Returns the assets an account has entered
* @param account The address of the account to pull assets for
* @return A list with the assets the account has entered
*/
function getAssetsIn(address account) public view returns (VToken[] memory) {
uint256 len;
VToken[] memory _accountAssets = accountAssets[account];
uint256 _accountAssetsLength = _accountAssets.length;
VToken[] memory assetsIn = new VToken[](_accountAssetsLength);
for (uint256 i; i < _accountAssetsLength; ++i) {
Market storage market = markets[address(_accountAssets[i])];
if (market.isListed) {
assetsIn[len] = _accountAssets[i];
++len;
}
}
assembly {
mstore(assetsIn, len)
}
return assetsIn;
}
/**
* @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
*/
function _addToMarket(VToken vToken, address borrower) internal {
_checkActionPauseState(address(vToken), Action.ENTER_MARKET);
Market storage marketToJoin = markets[address(vToken)];
if (!marketToJoin.isListed) {
revert MarketNotListed(address(vToken));
}
if (marketToJoin.accountMembership[borrower]) {
// already joined
return;
}
// 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);
}
/**
* @notice Internal function to validate that a market hasn't already been added
* and if it hasn't adds it
* @param vToken The market to support
*/
function _addMarket(address vToken) internal {
uint256 marketsCount = allMarkets.length;
for (uint256 i; i < marketsCount; ++i) {
if (allMarkets[i] == VToken(vToken)) {
revert MarketAlreadyListed(vToken);
}
}
allMarkets.push(VToken(vToken));
marketsCount = allMarkets.length;
_ensureMaxLoops(marketsCount);
}
/**
* @dev Pause/unpause an action on a market
* @param market Market to pause/unpause the action on
* @param action Action id to pause/unpause
* @param paused The new paused state (true=paused, false=unpaused)
*/
function _setActionPaused(address market, Action action, bool paused) internal {
require(markets[market].isListed, "cannot pause a market that is not listed");
_actionPaused[market][action] = paused;
emit ActionPausedMarket(VToken(market), action, paused);
}
/**
* @dev Internal function to check that vTokens can be safely redeemed for the underlying asset.
* @param vToken Address of the vTokens to redeem
* @param redeemer Account redeeming the tokens
* @param redeemTokens The number of tokens to redeem
*/
function _checkRedeemAllowed(address vToken, address redeemer, uint256 redeemTokens) internal {
Market storage market = markets[vToken];
if (!market.isListed) {
revert MarketNotListed(address(vToken));
}
/* If the redeemer is not 'in' the market, then we can bypass the liquidity check */
if (!market.accountMembership[redeemer]) {
return;
}
// Update the prices of tokens
updatePrices(redeemer);
/* Otherwise, perform a hypothetical liquidity check to guard against shortfall */
AccountLiquiditySnapshot memory snapshot = _getHypotheticalLiquiditySnapshot(
redeemer,
VToken(vToken),
redeemTokens,
0,
_getCollateralFactor
);
if (snapshot.shortfall > 0) {
revert InsufficientLiquidity();
}
}
/**
* @notice Get the total collateral, weighted collateral, borrow balance, liquidity, shortfall
* @param account The account to get the snapshot for
* @param weight The function to compute the weight of the collateral – either collateral factor or
* liquidation threshold. Accepts the address of the vToken and returns the weight as Exp.
* @dev Note that we calculate the exchangeRateStored for each collateral vToken using stored data,
* without calculating accumulated interest.
* @return snapshot Account liquidity snapshot
*/
function _getCurrentLiquiditySnapshot(
address account,
function(VToken) internal view returns (Exp memory) weight
) internal view returns (AccountLiquiditySnapshot memory snapshot) {
return _getHypotheticalLiquiditySnapshot(account, VToken(address(0)), 0, 0, weight);
}
/**
* @notice Determine what the supply/borrow balances 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
* @param weight The function to compute the weight of the collateral – either collateral factor or
liquidation threshold. Accepts the address of the VToken and returns the weight
* @dev Note that we calculate the exchangeRateStored for each collateral vToken using stored data,
* without calculating accumulated interest.
* @return snapshot Account liquidity snapshot
*/
function _getHypotheticalLiquiditySnapshot(
address account,
VToken vTokenModify,
uint256 redeemTokens,
uint256 borrowAmount,
function(VToken) internal view returns (Exp memory) weight
) internal view returns (AccountLiquiditySnapshot memory snapshot) {
// For each asset the account is in
VToken[] memory assets = getAssetsIn(account);
uint256 assetsCount = assets.length;
for (uint256 i; i < assetsCount; ++i) {
VToken asset = assets[i];
// Read the balances and exchange rate from the vToken
(uint256 vTokenBalance, uint256 borrowBalance, uint256 exchangeRateMantissa) = _safeGetAccountSnapshot(
asset,
account
);
// Get the normalized price of the asset
Exp memory oraclePrice = Exp({ mantissa: _safeGetUnderlyingPrice(asset) });
// Pre-compute conversion factors from vTokens -> usd
Exp memory vTokenPrice = mul_(Exp({ mantissa: exchangeRateMantissa }), oraclePrice);
Exp memory weightedVTokenPrice = mul_(weight(asset), vTokenPrice);
// weightedCollateral += weightedVTokenPrice * vTokenBalance
snapshot.weightedCollateral = mul_ScalarTruncateAddUInt(
weightedVTokenPrice,
vTokenBalance,
snapshot.weightedCollateral
);
// totalCollateral += vTokenPrice * vTokenBalance
snapshot.totalCollateral = mul_ScalarTruncateAddUInt(vTokenPrice, vTokenBalance, snapshot.totalCollateral);
// borrows += oraclePrice * borrowBalance
snapshot.borrows = mul_ScalarTruncateAddUInt(oraclePrice, borrowBalance, snapshot.borrows);
// Calculate effects of interacting with vTokenModify
if (asset == vTokenModify) {
// redeem effect
// effects += tokensToDenom * redeemTokens
snapshot.effects = mul_ScalarTruncateAddUInt(weightedVTokenPrice, redeemTokens, snapshot.effects);
// borrow effect
// effects += oraclePrice * borrowAmount
snapshot.effects = mul_ScalarTruncateAddUInt(oraclePrice, borrowAmount, snapshot.effects);
}
}
uint256 borrowPlusEffects = snapshot.borrows + snapshot.effects;
// These are safe, as the underflow condition is checked first
unchecked {
if (snapshot.weightedCollateral > borrowPlusEffects) {
snapshot.liquidity = snapshot.weightedCollateral - borrowPlusEffects;
snapshot.shortfall = 0;
} else {
snapshot.liquidity = 0;
snapshot.shortfall = borrowPlusEffects - snapshot.weightedCollateral;
}
}
return snapshot;
}
/**
* @dev Retrieves price from oracle for an asset and checks it is nonzero
* @param asset Address for asset to query price
* @return Underlying price
*/
function _safeGetUnderlyingPrice(VToken asset) internal view returns (uint256) {
uint256 oraclePriceMantissa = oracle.getUnderlyingPrice(address(asset));
if (oraclePriceMantissa == 0) {
revert PriceError(address(asset));
}
return oraclePriceMantissa;
}
/**
* @dev Return collateral factor for a market
* @param asset Address for asset
* @return Collateral factor as exponential
*/
function _getCollateralFactor(VToken asset) internal view returns (Exp memory) {
return Exp({ mantissa: markets[address(asset)].collateralFactorMantissa });
}
/**
* @dev Retrieves liquidation threshold for a market as an exponential
* @param asset Address for asset to liquidation threshold
* @return Liquidation threshold as exponential
*/
function _getLiquidationThreshold(VToken asset) internal view returns (Exp memory) {
return Exp({ mantissa: markets[address(asset)].liquidationThresholdMantissa });
}
/**
* @dev Returns supply and borrow balances of user in vToken, reverts on failure
* @param vToken Market to query
* @param user Account address
* @return vTokenBalance Balance of vTokens, the same as vToken.balanceOf(user)
* @return borrowBalance Borrowed amount, including the interest
* @return exchangeRateMantissa Stored exchange rate
*/
function _safeGetAccountSnapshot(
VToken vToken,
address user
) internal view returns (uint256 vTokenBalance, uint256 borrowBalance, uint256 exchangeRateMantissa) {
uint256 err;
(err, vTokenBalance, borrowBalance, exchangeRateMantissa) = vToken.getAccountSnapshot(user);
if (err != 0) {
revert SnapshotError(address(vToken), user);
}
return (vTokenBalance, borrowBalance, exchangeRateMantissa);
}
/// @notice Reverts if the call is not from expectedSender
/// @param expectedSender Expected transaction sender
function _checkSenderIs(address expectedSender) internal view {
if (msg.sender != expectedSender) {
revert UnexpectedSender(expectedSender, msg.sender);
}
}
/// @notice Reverts if a certain action is paused on a market
/// @param market Market to check
/// @param action Action to check
function _checkActionPauseState(address market, Action action) private view {
if (actionPaused(market, action)) {
revert ActionPaused(market, action);
}
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity ^0.8.25;
import { ResilientOracleInterface } from "@venusprotocol/oracle/contracts/interfaces/OracleInterface.sol";
import { VToken } from "./VToken.sol";
import { RewardsDistributor } from "./Rewards/RewardsDistributor.sol";
enum Action {
MINT,
REDEEM,
BORROW,
REPAY,
SEIZE,
LIQUIDATE,
TRANSFER,
ENTER_MARKET,
EXIT_MARKET
}
/**
* @title ComptrollerInterface
* @author Venus
* @notice Interface implemented by the `Comptroller` contract.
*/
interface ComptrollerInterface {
/*** Assets You Are In ***/
function enterMarkets(address[] calldata vTokens) external returns (uint256[] memory);
function exitMarket(address vToken) external returns (uint256);
/*** Policy Hooks ***/
function preMintHook(address vToken, address minter, uint256 mintAmount) external;
function preRedeemHook(address vToken, address redeemer, uint256 redeemTokens) external;
function preBorrowHook(address vToken, address borrower, uint256 borrowAmount) external;
function preRepayHook(address vToken, address borrower) external;
function preLiquidateHook(
address vTokenBorrowed,
address vTokenCollateral,
address borrower,
uint256 repayAmount,
bool skipLiquidityCheck
) external;
function preSeizeHook(
address vTokenCollateral,
address vTokenBorrowed,
address liquidator,
address borrower
) external;
function borrowVerify(address vToken, address borrower, uint borrowAmount) external;
function mintVerify(address vToken, address minter, uint mintAmount, uint mintTokens) external;
function redeemVerify(address vToken, address redeemer, uint redeemAmount, uint redeemTokens) external;
function repayBorrowVerify(
address vToken,
address payer,
address borrower,
uint repayAmount,
uint borrowerIndex
) external;
function liquidateBorrowVerify(
address vTokenBorrowed,
address vTokenCollateral,
address liquidator,
address borrower,
uint repayAmount,
uint seizeTokens
) external;
function seizeVerify(
address vTokenCollateral,
address vTokenBorrowed,
address liquidator,
address borrower,
uint seizeTokens
) external;
function transferVerify(address vToken, address src, address dst, uint transferTokens) external;
function preTransferHook(address vToken, address src, address dst, uint256 transferTokens) external;
function isComptroller() external view returns (bool);
/*** Liquidity/Liquidation Calculations ***/
function liquidateCalculateSeizeTokens(
address vTokenBorrowed,
address vTokenCollateral,
uint256 repayAmount
) external view returns (uint256, uint256);
function getAllMarkets() external view returns (VToken[] memory);
function actionPaused(address market, Action action) external view returns (bool);
}
/**
* @title ComptrollerViewInterface
* @author Venus
* @notice Interface implemented by the `Comptroller` contract, including only some util view functions.
*/
interface ComptrollerViewInterface {
function markets(address) external view returns (bool, uint256);
function oracle() external view returns (ResilientOracleInterface);
function getAssetsIn(address) external view returns (VToken[] memory);
function closeFactorMantissa() external view returns (uint256);
function liquidationIncentiveMantissa() external view returns (uint256);
function minLiquidatableCollateral() external view returns (uint256);
function getRewardDistributors() external view returns (RewardsDistributor[] memory);
function getAllMarkets() external view returns (VToken[] memory);
function borrowCaps(address) external view returns (uint256);
function supplyCaps(address) external view returns (uint256);
function approvedDelegates(address user, address delegate) external view returns (bool);
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { ResilientOracleInterface } from "@venusprotocol/oracle/contracts/interfaces/OracleInterface.sol";
import { VToken } from "./VToken.sol";
import { RewardsDistributor } from "./Rewards/RewardsDistributor.sol";
import { IPrime } from "@venusprotocol/venus-protocol/contracts/Tokens/Prime/Interfaces/IPrime.sol";
import { Action } from "./ComptrollerInterface.sol";
/**
* @title ComptrollerStorage
* @author Venus
* @notice Storage layout for the `Comptroller` contract.
*/
contract ComptrollerStorage {
struct LiquidationOrder {
VToken vTokenCollateral;
VToken vTokenBorrowed;
uint256 repayAmount;
}
struct AccountLiquiditySnapshot {
uint256 totalCollateral;
uint256 weightedCollateral;
uint256 borrows;
uint256 effects;
uint256 liquidity;
uint256 shortfall;
}
struct RewardSpeeds {
address rewardToken;
uint256 supplySpeed;
uint256 borrowSpeed;
}
struct Market {
// Whether or not this market is listed
bool isListed;
// 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.
uint256 collateralFactorMantissa;
// Multiplier representing the collateralization after which the borrow is eligible
// for liquidation. For instance, 0.8 liquidate when the borrow is 80% of collateral
// value. Must be between 0 and collateral factor, stored as a mantissa.
uint256 liquidationThresholdMantissa;
// Per-market mapping of "accounts in this asset"
mapping(address => bool) accountMembership;
}
/**
* @notice Oracle which gives the price of any given asset
*/
ResilientOracleInterface public oracle;
/**
* @notice Multiplier used to calculate the maximum repayAmount when liquidating a borrow
*/
uint256 public closeFactorMantissa;
/**
* @notice Multiplier representing the discount on collateral that a liquidator receives
*/
uint256 public liquidationIncentiveMantissa;
/**
* @notice Per-account mapping of "assets you are in"
*/
mapping(address => VToken[]) public accountAssets;
/**
* @notice Official mapping of vTokens -> Market metadata
* @dev Used e.g. to determine if a market is supported
*/
mapping(address => Market) public markets;
/// @notice A list of all markets
VToken[] public allMarkets;
/// @notice Borrow caps enforced by borrowAllowed for each vToken address. Defaults to zero which restricts borrowing.
mapping(address => uint256) public borrowCaps;
/// @notice Minimal collateral required for regular (non-batch) liquidations
uint256 public minLiquidatableCollateral;
/// @notice Supply caps enforced by mintAllowed for each vToken address. Defaults to zero which corresponds to minting not allowed
mapping(address => uint256) public supplyCaps;
/// @notice True if a certain action is paused on a certain market
mapping(address => mapping(Action => bool)) internal _actionPaused;
// List of Reward Distributors added
RewardsDistributor[] internal rewardsDistributors;
// Used to check if rewards distributor is added
mapping(address => bool) internal rewardsDistributorExists;
/// @notice Flag indicating whether forced liquidation enabled for a market
mapping(address => bool) public isForcedLiquidationEnabled;
uint256 internal constant NO_ERROR = 0;
// closeFactorMantissa must be strictly greater than this value
uint256 internal constant MIN_CLOSE_FACTOR_MANTISSA = 0.05e18; // 0.05
// closeFactorMantissa must not exceed this value
uint256 internal constant MAX_CLOSE_FACTOR_MANTISSA = 0.9e18; // 0.9
// No collateralFactorMantissa may exceed this value
uint256 internal constant MAX_COLLATERAL_FACTOR_MANTISSA = 0.95e18; // 0.95
/// Prime token address
IPrime public prime;
/// @notice Whether the delegate is allowed to borrow or redeem on behalf of the user
//mapping(address user => mapping (address delegate => bool approved)) public approvedDelegates;
mapping(address => mapping(address => bool)) public approvedDelegates;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[47] private __gap;
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { Action } from "../../ComptrollerInterface.sol";
import { RewardsDistributor } from "../../Rewards/RewardsDistributor.sol";
/**
* @title IComptroller
* @author Venus
* @notice Combined interface for the `Comptroller` contract, including both core and view functions.
*/
interface IComptroller {
function actionPaused(address market, Action action) external view returns (bool);
function getRewardDistributors() external view returns (RewardsDistributor[] memory);
function supplyCaps(address) external view returns (uint256);
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity ^0.8.25;
interface IProtocolShareReserve {
/// @notice it represents the type of vToken income
enum IncomeType {
SPREAD,
LIQUIDATION,
ERC4626_WRAPPER_REWARDS,
FLASHLOAN
}
function updateAssetsState(address comptroller, address asset, IncomeType incomeType) external;
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
/**
* @title TokenErrorReporter
* @author Venus
* @notice Errors that can be thrown by the `VToken` contract.
*/
contract TokenErrorReporter {
uint256 public constant NO_ERROR = 0; // support legacy return codes
error TransferNotAllowed();
error MintFreshnessCheck();
error RedeemFreshnessCheck();
error RedeemTransferOutNotPossible();
error BorrowFreshnessCheck();
error BorrowCashNotAvailable();
error DelegateNotApproved();
error RepayBorrowFreshnessCheck();
error HealBorrowUnauthorized();
error ForceLiquidateBorrowUnauthorized();
error LiquidateFreshnessCheck();
error LiquidateCollateralFreshnessCheck();
error LiquidateAccrueCollateralInterestFailed(uint256 errorCode);
error LiquidateLiquidatorIsBorrower();
error LiquidateCloseAmountIsZero();
error LiquidateCloseAmountIsUintMax();
error LiquidateSeizeLiquidatorIsBorrower();
error ProtocolSeizeShareTooBig();
error SetReserveFactorFreshCheck();
error SetReserveFactorBoundsCheck();
error AddReservesFactorFreshCheck(uint256 actualAddAmount);
error ReduceReservesFreshCheck();
error ReduceReservesCashNotAvailable();
error ReduceReservesCashValidation();
error SetInterestRateModelFreshCheck();
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { EXP_SCALE as EXP_SCALE_, MANTISSA_ONE as MANTISSA_ONE_ } from "./lib/constants.sol";
/**
* @title Exponential module for storing fixed-precision decimals
* @author Compound
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places.
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is:
* `Exp({mantissa: 5100000000000000000})`.
*/
contract ExponentialNoError {
struct Exp {
uint256 mantissa;
}
struct Double {
uint256 mantissa;
}
uint256 internal constant EXP_SCALE = EXP_SCALE_;
uint256 internal constant DOUBLE_SCALE = 1e36;
uint256 internal constant HALF_EXP_SCALE = EXP_SCALE / 2;
uint256 internal constant MANTISSA_ONE = MANTISSA_ONE_;
/**
* @dev Truncates the given exp to a whole number value.
* For example, truncate(Exp{mantissa: 15 * EXP_SCALE}) = 15
*/
function truncate(Exp memory exp) internal pure returns (uint256) {
// Note: We are not using careful math here as we're performing a division that cannot fail
return exp.mantissa / EXP_SCALE;
}
/**
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer.
*/
// solhint-disable-next-line func-name-mixedcase
function mul_ScalarTruncate(Exp memory a, uint256 scalar) internal pure returns (uint256) {
Exp memory product = mul_(a, scalar);
return truncate(product);
}
/**
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer.
*/
// solhint-disable-next-line func-name-mixedcase
function mul_ScalarTruncateAddUInt(Exp memory a, uint256 scalar, uint256 addend) internal pure returns (uint256) {
Exp memory product = mul_(a, scalar);
return add_(truncate(product), addend);
}
/**
* @dev Checks if first Exp is less than second Exp.
*/
function lessThanExp(Exp memory left, Exp memory right) internal pure returns (bool) {
return left.mantissa < right.mantissa;
}
function safe224(uint256 n, string memory errorMessage) internal pure returns (uint224) {
require(n <= type(uint224).max, errorMessage);
return uint224(n);
}
function safe32(uint256 n, string memory errorMessage) internal pure returns (uint32) {
require(n <= type(uint32).max, 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_(uint256 a, uint256 b) internal pure returns (uint256) {
return a + b;
}
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_(uint256 a, uint256 b) internal pure returns (uint256) {
return a - b;
}
function mul_(Exp memory a, Exp memory b) internal pure returns (Exp memory) {
return Exp({ mantissa: mul_(a.mantissa, b.mantissa) / EXP_SCALE });
}
function mul_(Exp memory a, uint256 b) internal pure returns (Exp memory) {
return Exp({ mantissa: mul_(a.mantissa, b) });
}
function mul_(uint256 a, Exp memory b) internal pure returns (uint256) {
return mul_(a, b.mantissa) / EXP_SCALE;
}
function mul_(Double memory a, Double memory b) internal pure returns (Double memory) {
return Double({ mantissa: mul_(a.mantissa, b.mantissa) / DOUBLE_SCALE });
}
function mul_(Double memory a, uint256 b) internal pure returns (Double memory) {
return Double({ mantissa: mul_(a.mantissa, b) });
}
function mul_(uint256 a, Double memory b) internal pure returns (uint256) {
return mul_(a, b.mantissa) / DOUBLE_SCALE;
}
function mul_(uint256 a, uint256 b) internal pure returns (uint256) {
return a * b;
}
function div_(Exp memory a, Exp memory b) internal pure returns (Exp memory) {
return Exp({ mantissa: div_(mul_(a.mantissa, EXP_SCALE), b.mantissa) });
}
function div_(Exp memory a, uint256 b) internal pure returns (Exp memory) {
return Exp({ mantissa: div_(a.mantissa, b) });
}
function div_(uint256 a, Exp memory b) internal pure returns (uint256) {
return div_(mul_(a, EXP_SCALE), b.mantissa);
}
function div_(Double memory a, Double memory b) internal pure returns (Double memory) {
return Double({ mantissa: div_(mul_(a.mantissa, DOUBLE_SCALE), b.mantissa) });
}
function div_(Double memory a, uint256 b) internal pure returns (Double memory) {
return Double({ mantissa: div_(a.mantissa, b) });
}
function div_(uint256 a, Double memory b) internal pure returns (uint256) {
return div_(mul_(a, DOUBLE_SCALE), b.mantissa);
}
function div_(uint256 a, uint256 b) internal pure returns (uint256) {
return a / b;
}
function fraction(uint256 a, uint256 b) internal pure returns (Double memory) {
return Double({ mantissa: div_(mul_(a, DOUBLE_SCALE), b) });
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
/**
* @title Compound's InterestRateModel Interface
* @author Compound
*/
abstract contract InterestRateModel {
/**
* @notice Calculates the current borrow interest rate per slot (block or second)
* @param cash The total amount of cash the market has
* @param borrows The total amount of borrows the market has outstanding
* @param reserves The total amount of reserves the market has
* @param badDebt The amount of badDebt in the market
* @return The borrow rate percentage per slot (block or second) as a mantissa (scaled by EXP_SCALE)
*/
function getBorrowRate(
uint256 cash,
uint256 borrows,
uint256 reserves,
uint256 badDebt
) external view virtual returns (uint256);
/**
* @notice Calculates the current supply interest rate per slot (block or second)
* @param cash The total amount of cash the market has
* @param borrows The total amount of borrows the market has outstanding
* @param reserves The total amount of reserves the market has
* @param reserveFactorMantissa The current reserve factor the market has
* @param badDebt The amount of badDebt in the market
* @return The supply rate percentage per slot (block or second) as a mantissa (scaled by EXP_SCALE)
*/
function getSupplyRate(
uint256 cash,
uint256 borrows,
uint256 reserves,
uint256 reserveFactorMantissa,
uint256 badDebt
) external view virtual returns (uint256);
/**
* @notice Indicator that this is an InterestRateModel contract (for inspection)
* @return Always true
*/
function isInterestRateModel() external pure virtual returns (bool) {
return true;
}
}// SPDX-License-Identifier: BSD-3-Clause pragma solidity ^0.8.25; /// @dev The approximate number of seconds per year uint256 constant SECONDS_PER_YEAR = 31_536_000; /// @dev Base unit for computations, usually used in scaling (multiplications, divisions) uint256 constant EXP_SCALE = 1e18; /// @dev A unit (literal one) in EXP_SCALE, usually used in additions/subtractions uint256 constant MANTISSA_ONE = EXP_SCALE;
// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
/// @notice Thrown if the supplied address is a zero address where it is not allowed
error ZeroAddressNotAllowed();
/// @notice Checks if the provided address is nonzero, reverts otherwise
/// @param address_ Address to check
/// @custom:error ZeroAddressNotAllowed is thrown if the provided address is a zero address
function ensureNonzeroAddress(address address_) pure {
if (address_ == address(0)) {
revert ZeroAddressNotAllowed();
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
/**
* @title MaxLoopsLimitHelper
* @author Venus
* @notice Abstract contract used to avoid collection with too many items that would generate gas errors and DoS.
*/
abstract contract MaxLoopsLimitHelper {
// Limit for the loops to avoid the DOS
uint256 public maxLoopsLimit;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
/// @notice Emitted when max loops limit is set
event MaxLoopsLimitUpdated(uint256 oldMaxLoopsLimit, uint256 newmaxLoopsLimit);
/// @notice Thrown an error on maxLoopsLimit exceeds for any loop
error MaxLoopsLimitExceeded(uint256 loopsLimit, uint256 requiredLoops);
/**
* @notice Set the limit for the loops can iterate to avoid the DOS
* @param limit Limit for the max loops can execute at a time
*/
function _setMaxLoopsLimit(uint256 limit) internal {
require(limit > maxLoopsLimit, "Comptroller: Invalid maxLoopsLimit");
uint256 oldMaxLoopsLimit = maxLoopsLimit;
maxLoopsLimit = limit;
emit MaxLoopsLimitUpdated(oldMaxLoopsLimit, limit);
}
/**
* @notice Compare the maxLoopsLimit with number of the times loop iterate
* @param len Length of the loops iterate
* @custom:error MaxLoopsLimitExceeded error is thrown when loops length exceeds maxLoopsLimit
*/
function _ensureMaxLoops(uint256 len) internal view {
if (len > maxLoopsLimit) {
revert MaxLoopsLimitExceeded(maxLoopsLimit, len);
}
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { Ownable2StepUpgradeable } from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
import { IERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import { SafeERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
import { AccessControlledV8 } from "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
import { TimeManagerV8 } from "@venusprotocol/solidity-utilities/contracts/TimeManagerV8.sol";
import { ExponentialNoError } from "../ExponentialNoError.sol";
import { VToken } from "../VToken.sol";
import { Comptroller } from "../Comptroller.sol";
import { MaxLoopsLimitHelper } from "../MaxLoopsLimitHelper.sol";
import { RewardsDistributorStorage } from "./RewardsDistributorStorage.sol";
/**
* @title `RewardsDistributor`
* @author Venus
* @notice Contract used to configure, track and distribute rewards to users based on their actions (borrows and supplies) in the protocol.
* Users can receive additional rewards through a `RewardsDistributor`. Each `RewardsDistributor` proxy is initialized with a specific reward
* token and `Comptroller`, which can then distribute the reward token to users that supply or borrow in the associated pool.
* Authorized users can set the reward token borrow and supply speeds for each market in the pool. This sets a fixed amount of reward
* token to be released each slot (block or second) for borrowers and suppliers, which is distributed based on a user’s percentage of the borrows or supplies
* respectively. The owner can also set up reward distributions to contributor addresses (distinct from suppliers and borrowers) by setting
* their contributor reward token speed, which similarly allocates a fixed amount of reward token per slot (block or second).
*
* The owner has the ability to transfer any amount of reward tokens held by the contract to any other address. Rewards are not distributed
* automatically and must be claimed by a user calling `claimRewardToken()`. Users should be aware that it is up to the owner and other centralized
* entities to ensure that the `RewardsDistributor` holds enough tokens to distribute the accumulated rewards of users and contributors.
*/
contract RewardsDistributor is
ExponentialNoError,
Ownable2StepUpgradeable,
AccessControlledV8,
MaxLoopsLimitHelper,
RewardsDistributorStorage,
TimeManagerV8
{
using SafeERC20Upgradeable for IERC20Upgradeable;
/// @notice The initial REWARD TOKEN index for a market
uint224 public constant INITIAL_INDEX = 1e36;
/// @notice Emitted when REWARD TOKEN is distributed to a supplier
event DistributedSupplierRewardToken(
VToken indexed vToken,
address indexed supplier,
uint256 rewardTokenDelta,
uint256 rewardTokenTotal,
uint256 rewardTokenSupplyIndex
);
/// @notice Emitted when REWARD TOKEN is distributed to a borrower
event DistributedBorrowerRewardToken(
VToken indexed vToken,
address indexed borrower,
uint256 rewardTokenDelta,
uint256 rewardTokenTotal,
uint256 rewardTokenBorrowIndex
);
/// @notice Emitted when a new supply-side REWARD TOKEN speed is calculated for a market
event RewardTokenSupplySpeedUpdated(VToken indexed vToken, uint256 newSpeed);
/// @notice Emitted when a new borrow-side REWARD TOKEN speed is calculated for a market
event RewardTokenBorrowSpeedUpdated(VToken indexed vToken, uint256 newSpeed);
/// @notice Emitted when REWARD TOKEN is granted by admin
event RewardTokenGranted(address indexed recipient, uint256 amount);
/// @notice Emitted when a new REWARD TOKEN speed is set for a contributor
event ContributorRewardTokenSpeedUpdated(address indexed contributor, uint256 newSpeed);
/// @notice Emitted when a market is initialized
event MarketInitialized(address indexed vToken);
/// @notice Emitted when a reward token supply index is updated
event RewardTokenSupplyIndexUpdated(address indexed vToken);
/// @notice Emitted when a reward token borrow index is updated
event RewardTokenBorrowIndexUpdated(address indexed vToken, Exp marketBorrowIndex);
/// @notice Emitted when a reward for contributor is updated
event ContributorRewardsUpdated(address indexed contributor, uint256 rewardAccrued);
/// @notice Emitted when a reward token last rewarding block for supply is updated
event SupplyLastRewardingBlockUpdated(address indexed vToken, uint32 newBlock);
/// @notice Emitted when a reward token last rewarding block for borrow is updated
event BorrowLastRewardingBlockUpdated(address indexed vToken, uint32 newBlock);
/// @notice Emitted when a reward token last rewarding timestamp for supply is updated
event SupplyLastRewardingBlockTimestampUpdated(address indexed vToken, uint256 newTimestamp);
/// @notice Emitted when a reward token last rewarding timestamp for borrow is updated
event BorrowLastRewardingBlockTimestampUpdated(address indexed vToken, uint256 newTimestamp);
modifier onlyComptroller() {
require(address(comptroller) == msg.sender, "Only comptroller can call this function");
_;
}
/**
* @param timeBased_ A boolean indicating whether the contract is based on time or block.
* @param blocksPerYear_ The number of blocks per year
* @custom:oz-upgrades-unsafe-allow constructor
*/
constructor(bool timeBased_, uint256 blocksPerYear_) TimeManagerV8(timeBased_, blocksPerYear_) {
// Note that the contract is upgradeable. Use initialize() or reinitializers
// to set the state variables.
_disableInitializers();
}
/**
* @notice RewardsDistributor initializer
* @dev Initializes the deployer to owner
* @param comptroller_ Comptroller to attach the reward distributor to
* @param rewardToken_ Reward token to distribute
* @param loopsLimit_ Maximum number of iterations for the loops in this contract
* @param accessControlManager_ AccessControlManager contract address
*/
function initialize(
Comptroller comptroller_,
IERC20Upgradeable rewardToken_,
uint256 loopsLimit_,
address accessControlManager_
) external initializer {
comptroller = comptroller_;
rewardToken = rewardToken_;
__Ownable2Step_init();
__AccessControlled_init_unchained(accessControlManager_);
_setMaxLoopsLimit(loopsLimit_);
}
/**
* @notice Initializes the market state for a specific vToken
* @param vToken The address of the vToken to be initialized
* @custom:event MarketInitialized emits on success
* @custom:access Only Comptroller
*/
function initializeMarket(address vToken) external onlyComptroller {
uint256 blockNumberOrTimestamp = getBlockNumberOrTimestamp();
isTimeBased
? _initializeMarketTimestampBased(vToken, blockNumberOrTimestamp)
: _initializeMarketBlockBased(vToken, safe32(blockNumberOrTimestamp, "block number exceeds 32 bits"));
emit MarketInitialized(vToken);
}
/*** Reward Token Distribution ***/
/**
* @notice Calculate reward token accrued by a borrower and possibly transfer it to them
* Borrowers will begin to accrue after the first interaction with the protocol.
* @dev This function should only be called when the user has a borrow position in the market
* (e.g. Comptroller.preBorrowHook, and Comptroller.preRepayHook)
* We avoid an external call to check if they are in the market to save gas because this function is called in many places
* @param vToken The market in which the borrower is interacting
* @param borrower The address of the borrower to distribute REWARD TOKEN to
* @param marketBorrowIndex The current global borrow index of vToken
*/
function distributeBorrowerRewardToken(
address vToken,
address borrower,
Exp memory marketBorrowIndex
) external onlyComptroller {
_distributeBorrowerRewardToken(vToken, borrower, marketBorrowIndex);
}
function updateRewardTokenSupplyIndex(address vToken) external onlyComptroller {
_updateRewardTokenSupplyIndex(vToken);
}
/**
* @notice Transfer REWARD TOKEN to the recipient
* @dev Note: If there is not enough REWARD TOKEN, we do not perform the transfer all
* @param recipient The address of the recipient to transfer REWARD TOKEN to
* @param amount The amount of REWARD TOKEN to (possibly) transfer
*/
function grantRewardToken(address recipient, uint256 amount) external onlyOwner {
uint256 amountLeft = _grantRewardToken(recipient, amount);
require(amountLeft == 0, "insufficient rewardToken for grant");
emit RewardTokenGranted(recipient, amount);
}
function updateRewardTokenBorrowIndex(address vToken, Exp memory marketBorrowIndex) external onlyComptroller {
_updateRewardTokenBorrowIndex(vToken, marketBorrowIndex);
}
/**
* @notice Set REWARD TOKEN borrow and supply speeds for the specified markets
* @param vTokens The markets whose REWARD TOKEN speed to update
* @param supplySpeeds New supply-side REWARD TOKEN speed for the corresponding market
* @param borrowSpeeds New borrow-side REWARD TOKEN speed for the corresponding market
*/
function setRewardTokenSpeeds(
VToken[] memory vTokens,
uint256[] memory supplySpeeds,
uint256[] memory borrowSpeeds
) external {
_checkAccessAllowed("setRewardTokenSpeeds(address[],uint256[],uint256[])");
uint256 numTokens = vTokens.length;
require(numTokens == supplySpeeds.length && numTokens == borrowSpeeds.length, "invalid setRewardTokenSpeeds");
for (uint256 i; i < numTokens; ++i) {
_setRewardTokenSpeed(vTokens[i], supplySpeeds[i], borrowSpeeds[i]);
}
}
/**
* @notice Set REWARD TOKEN last rewarding block for the specified markets, used when contract is block based
* @param vTokens The markets whose REWARD TOKEN last rewarding block to update
* @param supplyLastRewardingBlocks New supply-side REWARD TOKEN last rewarding block for the corresponding market
* @param borrowLastRewardingBlocks New borrow-side REWARD TOKEN last rewarding block for the corresponding market
*/
function setLastRewardingBlocks(
VToken[] calldata vTokens,
uint32[] calldata supplyLastRewardingBlocks,
uint32[] calldata borrowLastRewardingBlocks
) external {
_checkAccessAllowed("setLastRewardingBlocks(address[],uint32[],uint32[])");
require(!isTimeBased, "Block-based operation only");
uint256 numTokens = vTokens.length;
require(
numTokens == supplyLastRewardingBlocks.length && numTokens == borrowLastRewardingBlocks.length,
"RewardsDistributor::setLastRewardingBlocks invalid input"
);
for (uint256 i; i < numTokens; ) {
_setLastRewardingBlock(vTokens[i], supplyLastRewardingBlocks[i], borrowLastRewardingBlocks[i]);
unchecked {
++i;
}
}
}
/**
* @notice Set REWARD TOKEN last rewarding block timestamp for the specified markets, used when contract is time based
* @param vTokens The markets whose REWARD TOKEN last rewarding block to update
* @param supplyLastRewardingBlockTimestamps New supply-side REWARD TOKEN last rewarding block timestamp for the corresponding market
* @param borrowLastRewardingBlockTimestamps New borrow-side REWARD TOKEN last rewarding block timestamp for the corresponding market
*/
function setLastRewardingBlockTimestamps(
VToken[] calldata vTokens,
uint256[] calldata supplyLastRewardingBlockTimestamps,
uint256[] calldata borrowLastRewardingBlockTimestamps
) external {
_checkAccessAllowed("setLastRewardingBlockTimestamps(address[],uint256[],uint256[])");
require(isTimeBased, "Time-based operation only");
uint256 numTokens = vTokens.length;
require(
numTokens == supplyLastRewardingBlockTimestamps.length &&
numTokens == borrowLastRewardingBlockTimestamps.length,
"RewardsDistributor::setLastRewardingBlockTimestamps invalid input"
);
for (uint256 i; i < numTokens; ) {
_setLastRewardingBlockTimestamp(
vTokens[i],
supplyLastRewardingBlockTimestamps[i],
borrowLastRewardingBlockTimestamps[i]
);
unchecked {
++i;
}
}
}
/**
* @notice Set REWARD TOKEN speed for a single contributor
* @param contributor The contributor whose REWARD TOKEN speed to update
* @param rewardTokenSpeed New REWARD TOKEN speed for contributor
*/
function setContributorRewardTokenSpeed(address contributor, uint256 rewardTokenSpeed) external onlyOwner {
// note that REWARD TOKEN speed could be set to 0 to halt liquidity rewards for a contributor
updateContributorRewards(contributor);
if (rewardTokenSpeed == 0) {
// release storage
delete lastContributorBlock[contributor];
} else {
lastContributorBlock[contributor] = getBlockNumberOrTimestamp();
}
rewardTokenContributorSpeeds[contributor] = rewardTokenSpeed;
emit ContributorRewardTokenSpeedUpdated(contributor, rewardTokenSpeed);
}
function distributeSupplierRewardToken(address vToken, address supplier) external onlyComptroller {
_distributeSupplierRewardToken(vToken, supplier);
}
/**
* @notice Claim all the rewardToken accrued by holder in all markets
* @param holder The address to claim REWARD TOKEN for
*/
function claimRewardToken(address holder) external {
return claimRewardToken(holder, comptroller.getAllMarkets());
}
/**
* @notice Set the limit for the loops can iterate to avoid the DOS
* @param limit Limit for the max loops can execute at a time
*/
function setMaxLoopsLimit(uint256 limit) external onlyOwner {
_setMaxLoopsLimit(limit);
}
/**
* @notice Calculate additional accrued REWARD TOKEN for a contributor since last accrual
* @param contributor The address to calculate contributor rewards for
*/
function updateContributorRewards(address contributor) public {
uint256 rewardTokenSpeed = rewardTokenContributorSpeeds[contributor];
uint256 blockNumberOrTimestamp = getBlockNumberOrTimestamp();
uint256 deltaBlocksOrTimestamp = sub_(blockNumberOrTimestamp, lastContributorBlock[contributor]);
if (deltaBlocksOrTimestamp > 0 && rewardTokenSpeed > 0) {
uint256 newAccrued = mul_(deltaBlocksOrTimestamp, rewardTokenSpeed);
uint256 contributorAccrued = add_(rewardTokenAccrued[contributor], newAccrued);
rewardTokenAccrued[contributor] = contributorAccrued;
lastContributorBlock[contributor] = blockNumberOrTimestamp;
emit ContributorRewardsUpdated(contributor, rewardTokenAccrued[contributor]);
}
}
/**
* @notice Claim all the rewardToken accrued by holder in the specified markets
* @param holder The address to claim REWARD TOKEN for
* @param vTokens The list of markets to claim REWARD TOKEN in
*/
function claimRewardToken(address holder, VToken[] memory vTokens) public {
uint256 vTokensCount = vTokens.length;
_ensureMaxLoops(vTokensCount);
for (uint256 i; i < vTokensCount; ++i) {
VToken vToken = vTokens[i];
require(comptroller.isMarketListed(vToken), "market must be listed");
Exp memory borrowIndex = Exp({ mantissa: vToken.borrowIndex() });
_updateRewardTokenBorrowIndex(address(vToken), borrowIndex);
_distributeBorrowerRewardToken(address(vToken), holder, borrowIndex);
_updateRewardTokenSupplyIndex(address(vToken));
_distributeSupplierRewardToken(address(vToken), holder);
}
rewardTokenAccrued[holder] = _grantRewardToken(holder, rewardTokenAccrued[holder]);
}
/**
* @notice Set REWARD TOKEN last rewarding block for a single market.
* @param vToken market's whose reward token last rewarding block to be updated
* @param supplyLastRewardingBlock New supply-side REWARD TOKEN last rewarding block for market
* @param borrowLastRewardingBlock New borrow-side REWARD TOKEN last rewarding block for market
*/
function _setLastRewardingBlock(
VToken vToken,
uint32 supplyLastRewardingBlock,
uint32 borrowLastRewardingBlock
) internal {
require(comptroller.isMarketListed(vToken), "rewardToken market is not listed");
uint256 blockNumber = getBlockNumberOrTimestamp();
require(supplyLastRewardingBlock > blockNumber, "setting last rewarding block in the past is not allowed");
require(borrowLastRewardingBlock > blockNumber, "setting last rewarding block in the past is not allowed");
uint32 currentSupplyLastRewardingBlock = rewardTokenSupplyState[address(vToken)].lastRewardingBlock;
uint32 currentBorrowLastRewardingBlock = rewardTokenBorrowState[address(vToken)].lastRewardingBlock;
require(
currentSupplyLastRewardingBlock == 0 || currentSupplyLastRewardingBlock > blockNumber,
"this RewardsDistributor is already locked"
);
require(
currentBorrowLastRewardingBlock == 0 || currentBorrowLastRewardingBlock > blockNumber,
"this RewardsDistributor is already locked"
);
if (currentSupplyLastRewardingBlock != supplyLastRewardingBlock) {
rewardTokenSupplyState[address(vToken)].lastRewardingBlock = supplyLastRewardingBlock;
emit SupplyLastRewardingBlockUpdated(address(vToken), supplyLastRewardingBlock);
}
if (currentBorrowLastRewardingBlock != borrowLastRewardingBlock) {
rewardTokenBorrowState[address(vToken)].lastRewardingBlock = borrowLastRewardingBlock;
emit BorrowLastRewardingBlockUpdated(address(vToken), borrowLastRewardingBlock);
}
}
/**
* @notice Set REWARD TOKEN last rewarding timestamp for a single market.
* @param vToken market's whose reward token last rewarding timestamp to be updated
* @param supplyLastRewardingBlockTimestamp New supply-side REWARD TOKEN last rewarding timestamp for market
* @param borrowLastRewardingBlockTimestamp New borrow-side REWARD TOKEN last rewarding timestamp for market
*/
function _setLastRewardingBlockTimestamp(
VToken vToken,
uint256 supplyLastRewardingBlockTimestamp,
uint256 borrowLastRewardingBlockTimestamp
) internal {
require(comptroller.isMarketListed(vToken), "rewardToken market is not listed");
uint256 blockTimestamp = getBlockNumberOrTimestamp();
require(
supplyLastRewardingBlockTimestamp > blockTimestamp,
"setting last rewarding timestamp in the past is not allowed"
);
require(
borrowLastRewardingBlockTimestamp > blockTimestamp,
"setting last rewarding timestamp in the past is not allowed"
);
uint256 currentSupplyLastRewardingBlockTimestamp = rewardTokenSupplyStateTimeBased[address(vToken)]
.lastRewardingTimestamp;
uint256 currentBorrowLastRewardingBlockTimestamp = rewardTokenBorrowStateTimeBased[address(vToken)]
.lastRewardingTimestamp;
require(
currentSupplyLastRewardingBlockTimestamp == 0 || currentSupplyLastRewardingBlockTimestamp > blockTimestamp,
"this RewardsDistributor is already locked"
);
require(
currentBorrowLastRewardingBlockTimestamp == 0 || currentBorrowLastRewardingBlockTimestamp > blockTimestamp,
"this RewardsDistributor is already locked"
);
if (currentSupplyLastRewardingBlockTimestamp != supplyLastRewardingBlockTimestamp) {
rewardTokenSupplyStateTimeBased[address(vToken)].lastRewardingTimestamp = supplyLastRewardingBlockTimestamp;
emit SupplyLastRewardingBlockTimestampUpdated(address(vToken), supplyLastRewardingBlockTimestamp);
}
if (currentBorrowLastRewardingBlockTimestamp != borrowLastRewardingBlockTimestamp) {
rewardTokenBorrowStateTimeBased[address(vToken)].lastRewardingTimestamp = borrowLastRewardingBlockTimestamp;
emit BorrowLastRewardingBlockTimestampUpdated(address(vToken), borrowLastRewardingBlockTimestamp);
}
}
/**
* @notice Set REWARD TOKEN speed for a single market.
* @param vToken market's whose reward token rate to be updated
* @param supplySpeed New supply-side REWARD TOKEN speed for market
* @param borrowSpeed New borrow-side REWARD TOKEN speed for market
*/
function _setRewardTokenSpeed(VToken vToken, uint256 supplySpeed, uint256 borrowSpeed) internal {
require(comptroller.isMarketListed(vToken), "rewardToken market is not listed");
if (rewardTokenSupplySpeeds[address(vToken)] != supplySpeed) {
// Supply speed updated so let's update supply state to ensure that
// 1. REWARD TOKEN accrued properly for the old speed, and
// 2. REWARD TOKEN accrued at the new speed starts after this block.
_updateRewardTokenSupplyIndex(address(vToken));
// Update speed and emit event
rewardTokenSupplySpeeds[address(vToken)] = supplySpeed;
emit RewardTokenSupplySpeedUpdated(vToken, supplySpeed);
}
if (rewardTokenBorrowSpeeds[address(vToken)] != borrowSpeed) {
// Borrow speed updated so let's update borrow state to ensure that
// 1. REWARD TOKEN accrued properly for the old speed, and
// 2. REWARD TOKEN accrued at the new speed starts after this block.
Exp memory borrowIndex = Exp({ mantissa: vToken.borrowIndex() });
_updateRewardTokenBorrowIndex(address(vToken), borrowIndex);
// Update speed and emit event
rewardTokenBorrowSpeeds[address(vToken)] = borrowSpeed;
emit RewardTokenBorrowSpeedUpdated(vToken, borrowSpeed);
}
}
/**
* @notice Calculate REWARD TOKEN 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 REWARD TOKEN to
*/
function _distributeSupplierRewardToken(address vToken, address supplier) internal {
RewardToken storage supplyState = rewardTokenSupplyState[vToken];
TimeBasedRewardToken storage supplyStateTimeBased = rewardTokenSupplyStateTimeBased[vToken];
uint256 supplyIndex = isTimeBased ? supplyStateTimeBased.index : supplyState.index;
uint256 supplierIndex = rewardTokenSupplierIndex[vToken][supplier];
// Update supplier's index to the current index since we are distributing accrued REWARD TOKEN
rewardTokenSupplierIndex[vToken][supplier] = supplyIndex;
if (supplierIndex == 0 && supplyIndex >= INITIAL_INDEX) {
// Covers the case where users supplied tokens before the market's supply state index was set.
// Rewards the user with REWARD TOKEN accrued from the start of when supplier rewards were first
// set for the market.
supplierIndex = INITIAL_INDEX;
}
// Calculate change in the cumulative sum of the REWARD TOKEN per vToken accrued
Double memory deltaIndex = Double({ mantissa: sub_(supplyIndex, supplierIndex) });
uint256 supplierTokens = VToken(vToken).balanceOf(supplier);
// Calculate REWARD TOKEN accrued: vTokenAmount * accruedPerVToken
uint256 supplierDelta = mul_(supplierTokens, deltaIndex);
uint256 supplierAccrued = add_(rewardTokenAccrued[supplier], supplierDelta);
rewardTokenAccrued[supplier] = supplierAccrued;
emit DistributedSupplierRewardToken(VToken(vToken), supplier, supplierDelta, supplierAccrued, supplyIndex);
}
/**
* @notice Calculate reward token accrued by a borrower and possibly transfer it to them.
* @param vToken The market in which the borrower is interacting
* @param borrower The address of the borrower to distribute REWARD TOKEN to
* @param marketBorrowIndex The current global borrow index of vToken
*/
function _distributeBorrowerRewardToken(address vToken, address borrower, Exp memory marketBorrowIndex) internal {
RewardToken storage borrowState = rewardTokenBorrowState[vToken];
TimeBasedRewardToken storage borrowStateTimeBased = rewardTokenBorrowStateTimeBased[vToken];
uint256 borrowIndex = isTimeBased ? borrowStateTimeBased.index : borrowState.index;
uint256 borrowerIndex = rewardTokenBorrowerIndex[vToken][borrower];
// Update borrowers's index to the current index since we are distributing accrued REWARD TOKEN
rewardTokenBorrowerIndex[vToken][borrower] = borrowIndex;
if (borrowerIndex == 0 && borrowIndex >= INITIAL_INDEX) {
// Covers the case where users borrowed tokens before the market's borrow state index was set.
// Rewards the user with REWARD TOKEN accrued from the start of when borrower rewards were first
// set for the market.
borrowerIndex = INITIAL_INDEX;
}
// Calculate change in the cumulative sum of the REWARD TOKEN per borrowed unit accrued
Double memory deltaIndex = Double({ mantissa: sub_(borrowIndex, borrowerIndex) });
uint256 borrowerAmount = div_(VToken(vToken).borrowBalanceStored(borrower), marketBorrowIndex);
// Calculate REWARD TOKEN accrued: vTokenAmount * accruedPerBorrowedUnit
if (borrowerAmount != 0) {
uint256 borrowerDelta = mul_(borrowerAmount, deltaIndex);
uint256 borrowerAccrued = add_(rewardTokenAccrued[borrower], borrowerDelta);
rewardTokenAccrued[borrower] = borrowerAccrued;
emit DistributedBorrowerRewardToken(VToken(vToken), borrower, borrowerDelta, borrowerAccrued, borrowIndex);
}
}
/**
* @notice Transfer REWARD TOKEN to the user.
* @dev Note: If there is not enough REWARD TOKEN, we do not perform the transfer all.
* @param user The address of the user to transfer REWARD TOKEN to
* @param amount The amount of REWARD TOKEN to (possibly) transfer
* @return The amount of REWARD TOKEN which was NOT transferred to the user
*/
function _grantRewardToken(address user, uint256 amount) internal returns (uint256) {
uint256 rewardTokenRemaining = rewardToken.balanceOf(address(this));
if (amount > 0 && amount <= rewardTokenRemaining) {
rewardToken.safeTransfer(user, amount);
return 0;
}
return amount;
}
/**
* @notice Accrue REWARD TOKEN to the market by updating the supply index
* @param vToken The market whose supply index to update
* @dev Index is a cumulative sum of the REWARD TOKEN per vToken accrued
*/
function _updateRewardTokenSupplyIndex(address vToken) internal {
RewardToken storage supplyState = rewardTokenSupplyState[vToken];
TimeBasedRewardToken storage supplyStateTimeBased = rewardTokenSupplyStateTimeBased[vToken];
uint256 supplySpeed = rewardTokenSupplySpeeds[vToken];
uint256 blockNumberOrTimestamp = getBlockNumberOrTimestamp();
if (!isTimeBased) {
safe32(blockNumberOrTimestamp, "block number exceeds 32 bits");
}
uint256 lastRewardingBlockOrTimestamp = isTimeBased
? supplyStateTimeBased.lastRewardingTimestamp
: uint256(supplyState.lastRewardingBlock);
if (lastRewardingBlockOrTimestamp > 0 && blockNumberOrTimestamp > lastRewardingBlockOrTimestamp) {
blockNumberOrTimestamp = lastRewardingBlockOrTimestamp;
}
uint256 deltaBlocksOrTimestamp = sub_(
blockNumberOrTimestamp,
(isTimeBased ? supplyStateTimeBased.timestamp : uint256(supplyState.block))
);
if (deltaBlocksOrTimestamp > 0 && supplySpeed > 0) {
uint256 supplyTokens = VToken(vToken).totalSupply();
uint256 accruedSinceUpdate = mul_(deltaBlocksOrTimestamp, supplySpeed);
Double memory ratio = supplyTokens > 0
? fraction(accruedSinceUpdate, supplyTokens)
: Double({ mantissa: 0 });
uint224 supplyIndex = isTimeBased ? supplyStateTimeBased.index : supplyState.index;
uint224 index = safe224(
add_(Double({ mantissa: supplyIndex }), ratio).mantissa,
"new index exceeds 224 bits"
);
if (isTimeBased) {
supplyStateTimeBased.index = index;
supplyStateTimeBased.timestamp = blockNumberOrTimestamp;
} else {
supplyState.index = index;
supplyState.block = uint32(blockNumberOrTimestamp);
}
} else if (deltaBlocksOrTimestamp > 0) {
isTimeBased ? supplyStateTimeBased.timestamp = blockNumberOrTimestamp : supplyState.block = uint32(
blockNumberOrTimestamp
);
}
emit RewardTokenSupplyIndexUpdated(vToken);
}
/**
* @notice Accrue REWARD TOKEN to the market by updating the borrow index
* @param vToken The market whose borrow index to update
* @param marketBorrowIndex The current global borrow index of vToken
* @dev Index is a cumulative sum of the REWARD TOKEN per vToken accrued
*/
function _updateRewardTokenBorrowIndex(address vToken, Exp memory marketBorrowIndex) internal {
RewardToken storage borrowState = rewardTokenBorrowState[vToken];
TimeBasedRewardToken storage borrowStateTimeBased = rewardTokenBorrowStateTimeBased[vToken];
uint256 borrowSpeed = rewardTokenBorrowSpeeds[vToken];
uint256 blockNumberOrTimestamp = getBlockNumberOrTimestamp();
if (!isTimeBased) {
safe32(blockNumberOrTimestamp, "block number exceeds 32 bits");
}
uint256 lastRewardingBlockOrTimestamp = isTimeBased
? borrowStateTimeBased.lastRewardingTimestamp
: uint256(borrowState.lastRewardingBlock);
if (lastRewardingBlockOrTimestamp > 0 && blockNumberOrTimestamp > lastRewardingBlockOrTimestamp) {
blockNumberOrTimestamp = lastRewardingBlockOrTimestamp;
}
uint256 deltaBlocksOrTimestamp = sub_(
blockNumberOrTimestamp,
(isTimeBased ? borrowStateTimeBased.timestamp : uint256(borrowState.block))
);
if (deltaBlocksOrTimestamp > 0 && borrowSpeed > 0) {
uint256 borrowAmount = div_(VToken(vToken).totalBorrows(), marketBorrowIndex);
uint256 accruedSinceUpdate = mul_(deltaBlocksOrTimestamp, borrowSpeed);
Double memory ratio = borrowAmount > 0
? fraction(accruedSinceUpdate, borrowAmount)
: Double({ mantissa: 0 });
uint224 borrowIndex = isTimeBased ? borrowStateTimeBased.index : borrowState.index;
uint224 index = safe224(
add_(Double({ mantissa: borrowIndex }), ratio).mantissa,
"new index exceeds 224 bits"
);
if (isTimeBased) {
borrowStateTimeBased.index = index;
borrowStateTimeBased.timestamp = blockNumberOrTimestamp;
} else {
borrowState.index = index;
borrowState.block = uint32(blockNumberOrTimestamp);
}
} else if (deltaBlocksOrTimestamp > 0) {
if (isTimeBased) {
borrowStateTimeBased.timestamp = blockNumberOrTimestamp;
} else {
borrowState.block = uint32(blockNumberOrTimestamp);
}
}
emit RewardTokenBorrowIndexUpdated(vToken, marketBorrowIndex);
}
/**
* @notice Initializes the market state for a specific vToken called when contract is block-based
* @param vToken The address of the vToken to be initialized
* @param blockNumber current block number
*/
function _initializeMarketBlockBased(address vToken, uint32 blockNumber) internal {
RewardToken storage supplyState = rewardTokenSupplyState[vToken];
RewardToken storage borrowState = rewardTokenBorrowState[vToken];
/*
* Update market state indices
*/
if (supplyState.index == 0) {
// Initialize supply state index with default value
supplyState.index = INITIAL_INDEX;
}
if (borrowState.index == 0) {
// Initialize borrow state index with default value
borrowState.index = INITIAL_INDEX;
}
/*
* Update market state block numbers
*/
supplyState.block = borrowState.block = blockNumber;
}
/**
* @notice Initializes the market state for a specific vToken called when contract is time-based
* @param vToken The address of the vToken to be initialized
* @param blockTimestamp current block timestamp
*/
function _initializeMarketTimestampBased(address vToken, uint256 blockTimestamp) internal {
TimeBasedRewardToken storage supplyState = rewardTokenSupplyStateTimeBased[vToken];
TimeBasedRewardToken storage borrowState = rewardTokenBorrowStateTimeBased[vToken];
/*
* Update market state indices
*/
if (supplyState.index == 0) {
// Initialize supply state index with default value
supplyState.index = INITIAL_INDEX;
}
if (borrowState.index == 0) {
// Initialize borrow state index with default value
borrowState.index = INITIAL_INDEX;
}
/*
* Update market state block timestamp
*/
supplyState.timestamp = borrowState.timestamp = blockTimestamp;
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { IERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import { Comptroller } from "../Comptroller.sol";
/**
* @title RewardsDistributorStorage
* @author Venus
* @dev Storage for RewardsDistributor
*/
contract RewardsDistributorStorage {
struct RewardToken {
// The market's last updated rewardTokenBorrowIndex or rewardTokenSupplyIndex
uint224 index;
// The block number the index was last updated at
uint32 block;
// The block number at which to stop rewards
uint32 lastRewardingBlock;
}
struct TimeBasedRewardToken {
// The market's last updated rewardTokenBorrowIndex or rewardTokenSupplyIndex
uint224 index;
// The block timestamp the index was last updated at
uint256 timestamp;
// The block timestamp at which to stop rewards
uint256 lastRewardingTimestamp;
}
/// @notice The REWARD TOKEN market supply state for each market
mapping(address => RewardToken) public rewardTokenSupplyState;
/// @notice The REWARD TOKEN borrow index for each market for each supplier as of the last time they accrued REWARD TOKEN
mapping(address => mapping(address => uint256)) public rewardTokenSupplierIndex;
/// @notice The REWARD TOKEN accrued but not yet transferred to each user
mapping(address => uint256) public rewardTokenAccrued;
/// @notice The rate at which rewardToken is distributed to the corresponding borrow market per slot (block or second)
mapping(address => uint256) public rewardTokenBorrowSpeeds;
/// @notice The rate at which rewardToken is distributed to the corresponding supply market per slot (block or second)
mapping(address => uint256) public rewardTokenSupplySpeeds;
/// @notice The REWARD TOKEN market borrow state for each market
mapping(address => RewardToken) public rewardTokenBorrowState;
/// @notice The portion of REWARD TOKEN that each contributor receives per slot (block or second)
mapping(address => uint256) public rewardTokenContributorSpeeds;
/// @notice Last slot (block or second) at which a contributor's REWARD TOKEN rewards have been allocated
mapping(address => uint256) public lastContributorBlock;
/// @notice The REWARD TOKEN borrow index for each market for each borrower as of the last time they accrued REWARD TOKEN
mapping(address => mapping(address => uint256)) public rewardTokenBorrowerIndex;
Comptroller internal comptroller;
IERC20Upgradeable public rewardToken;
/// @notice The REWARD TOKEN market supply state for each market
mapping(address => TimeBasedRewardToken) public rewardTokenSupplyStateTimeBased;
/// @notice The REWARD TOKEN market borrow state for each market
mapping(address => TimeBasedRewardToken) public rewardTokenBorrowStateTimeBased;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[37] private __gap;
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { Ownable2StepUpgradeable } from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
import { IERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import { SafeERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
import { AccessControlledV8 } from "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
import { IProtocolShareReserve } from "@venusprotocol/protocol-reserve/contracts/Interfaces/IProtocolShareReserve.sol";
import { VTokenInterface } from "./VTokenInterfaces.sol";
import { ComptrollerInterface, ComptrollerViewInterface } from "./ComptrollerInterface.sol";
import { TokenErrorReporter } from "./ErrorReporter.sol";
import { InterestRateModel } from "./InterestRateModel.sol";
import { ExponentialNoError } from "./ExponentialNoError.sol";
import { TimeManagerV8 } from "@venusprotocol/solidity-utilities/contracts/TimeManagerV8.sol";
import { ensureNonzeroAddress } from "./lib/validators.sol";
/**
* @title VToken
* @author Venus
* @notice Each asset that is supported by a pool is integrated through an instance of the `VToken` contract. As outlined in the protocol overview,
* each isolated pool creates its own `vToken` corresponding to an asset. Within a given pool, each included `vToken` is referred to as a market of
* the pool. The main actions a user regularly interacts with in a market are:
- mint/redeem of vTokens;
- transfer of vTokens;
- borrow/repay a loan on an underlying asset;
- liquidate a borrow or liquidate/heal an account.
* A user supplies the underlying asset to a pool by minting `vTokens`, where the corresponding `vToken` amount is determined by the `exchangeRate`.
* The `exchangeRate` will change over time, dependent on a number of factors, some of which accrue interest. Additionally, once users have minted
* `vToken` in a pool, they can borrow any asset in the isolated pool by using their `vToken` as collateral. In order to borrow an asset or use a `vToken`
* as collateral, the user must be entered into each corresponding market (else, the `vToken` will not be considered collateral for a borrow). Note that
* a user may borrow up to a portion of their collateral determined by the market’s collateral factor. However, if their borrowed amount exceeds an amount
* calculated using the market’s corresponding liquidation threshold, the borrow is eligible for liquidation. When a user repays a borrow, they must also
* pay off interest accrued on the borrow.
*
* The Venus protocol includes unique mechanisms for healing an account and liquidating an account. These actions are performed in the `Comptroller`
* and consider all borrows and collateral for which a given account is entered within a market. These functions may only be called on an account with a
* total collateral amount that is no larger than a universal `minLiquidatableCollateral` value, which is used for all markets within a `Comptroller`.
* Both functions settle all of an account’s borrows, but `healAccount()` may add `badDebt` to a vToken. For more detail, see the description of
* `healAccount()` and `liquidateAccount()` in the `Comptroller` summary section below.
*/
contract VToken is
Ownable2StepUpgradeable,
AccessControlledV8,
VTokenInterface,
ExponentialNoError,
TokenErrorReporter,
TimeManagerV8
{
using SafeERC20Upgradeable for IERC20Upgradeable;
uint256 internal constant DEFAULT_PROTOCOL_SEIZE_SHARE_MANTISSA = 5e16; // 5%
// Maximum fraction of interest that can be set aside for reserves
uint256 internal constant MAX_RESERVE_FACTOR_MANTISSA = 1e18;
// Maximum borrow rate that can ever be applied per slot(block or second)
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable
uint256 internal immutable MAX_BORROW_RATE_MANTISSA;
/**
* 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
}
/**
* @param timeBased_ A boolean indicating whether the contract is based on time or block.
* @param blocksPerYear_ The number of blocks per year
* @param maxBorrowRateMantissa_ The maximum value of borrowing rate mantissa
* @custom:oz-upgrades-unsafe-allow constructor
*/
constructor(
bool timeBased_,
uint256 blocksPerYear_,
uint256 maxBorrowRateMantissa_
) TimeManagerV8(timeBased_, blocksPerYear_) {
// Note that the contract is upgradeable. Use initialize() or reinitializers
// to set the state variables.
require(maxBorrowRateMantissa_ <= 1e18, "Max borrow rate must be <= 1e18");
MAX_BORROW_RATE_MANTISSA = maxBorrowRateMantissa_;
_disableInitializers();
}
/**
* @notice Construct a new money market
* @param underlying_ The address of the underlying asset
* @param comptroller_ The address of the Comptroller
* @param interestRateModel_ The address of the interest rate model
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18
* @param name_ ERC-20 name of this token
* @param symbol_ ERC-20 symbol of this token
* @param decimals_ ERC-20 decimal precision of this token
* @param admin_ Address of the administrator of this token
* @param accessControlManager_ AccessControlManager contract address
* @param riskManagement Addresses of risk & income related contracts
* @param reserveFactorMantissa_ Percentage of borrow interest that goes to reserves (from 0 to 1e18)
* @custom:error ZeroAddressNotAllowed is thrown when admin address is zero
* @custom:error ZeroAddressNotAllowed is thrown when shortfall contract address is zero
* @custom:error ZeroAddressNotAllowed is thrown when protocol share reserve address is zero
*/
function initialize(
address underlying_,
ComptrollerInterface comptroller_,
InterestRateModel interestRateModel_,
uint256 initialExchangeRateMantissa_,
string memory name_,
string memory symbol_,
uint8 decimals_,
address admin_,
address accessControlManager_,
RiskManagementInit memory riskManagement,
uint256 reserveFactorMantissa_
) external initializer {
ensureNonzeroAddress(admin_);
// Initialize the market
_initialize(
underlying_,
comptroller_,
interestRateModel_,
initialExchangeRateMantissa_,
name_,
symbol_,
decimals_,
admin_,
accessControlManager_,
riskManagement,
reserveFactorMantissa_
);
}
/**
* @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 success True if the transfer succeeded, reverts otherwise
* @custom:event Emits Transfer event on success
* @custom:error TransferNotAllowed is thrown if trying to transfer to self
* @custom:access Not restricted
*/
function transfer(address dst, uint256 amount) external override nonReentrant returns (bool) {
_transferTokens(msg.sender, 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 amount The number of tokens to transfer
* @return success True if the transfer succeeded, reverts otherwise
* @custom:event Emits Transfer event on success
* @custom:error TransferNotAllowed is thrown if trying to transfer to self
* @custom:access Not restricted
*/
function transferFrom(address src, address dst, uint256 amount) external override nonReentrant returns (bool) {
_transferTokens(msg.sender, src, dst, amount);
return true;
}
/**
* @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 (uint256.max means infinite)
* @return success Whether or not the approval succeeded
* @custom:event Emits Approval event
* @custom:access Not restricted
* @custom:error ZeroAddressNotAllowed is thrown when spender address is zero
*/
function approve(address spender, uint256 amount) external override returns (bool) {
ensureNonzeroAddress(spender);
address src = msg.sender;
transferAllowances[src][spender] = amount;
emit Approval(src, spender, amount);
return true;
}
/**
* @notice Increase approval for `spender`
* @param spender The address of the account which may transfer tokens
* @param addedValue The number of additional tokens spender can transfer
* @return success Whether or not the approval succeeded
* @custom:event Emits Approval event
* @custom:access Not restricted
* @custom:error ZeroAddressNotAllowed is thrown when spender address is zero
*/
function increaseAllowance(address spender, uint256 addedValue) external override returns (bool) {
ensureNonzeroAddress(spender);
address src = msg.sender;
uint256 newAllowance = transferAllowances[src][spender];
newAllowance += addedValue;
transferAllowances[src][spender] = newAllowance;
emit Approval(src, spender, newAllowance);
return true;
}
/**
* @notice Decreases approval for `spender`
* @param spender The address of the account which may transfer tokens
* @param subtractedValue The number of tokens to remove from total approval
* @return success Whether or not the approval succeeded
* @custom:event Emits Approval event
* @custom:access Not restricted
* @custom:error ZeroAddressNotAllowed is thrown when spender address is zero
*/
function decreaseAllowance(address spender, uint256 subtractedValue) external override returns (bool) {
ensureNonzeroAddress(spender);
address src = msg.sender;
uint256 currentAllowance = transferAllowances[src][spender];
require(currentAllowance >= subtractedValue, "decreased allowance below zero");
unchecked {
currentAllowance -= subtractedValue;
}
transferAllowances[src][spender] = currentAllowance;
emit Approval(src, spender, currentAllowance);
return true;
}
/**
* @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 amount The amount of underlying owned by `owner`
*/
function balanceOfUnderlying(address owner) external override returns (uint256) {
Exp memory exchangeRate = Exp({ mantissa: exchangeRateCurrent() });
return mul_ScalarTruncate(exchangeRate, accountTokens[owner]);
}
/**
* @notice Returns the current total borrows plus accrued interest
* @return totalBorrows The total borrows with interest
*/
function totalBorrowsCurrent() external override nonReentrant returns (uint256) {
accrueInterest();
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 borrowBalance The calculated balance
*/
function borrowBalanceCurrent(address account) external override nonReentrant returns (uint256) {
accrueInterest();
return _borrowBalanceStored(account);
}
/**
* @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 error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event Emits Mint and Transfer events; may emit AccrueInterest
* @custom:access Not restricted
*/
function mint(uint256 mintAmount) external override nonReentrant returns (uint256) {
accrueInterest();
_mintFresh(msg.sender, msg.sender, mintAmount);
return NO_ERROR;
}
/**
* @notice Sender calls on-behalf of minter. minter supplies assets into the market and receives vTokens in exchange
* @dev Accrues interest whether or not the operation succeeds, unless reverted
* @param minter User whom the supply will be attributed to
* @param mintAmount The amount of the underlying asset to supply
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event Emits Mint and Transfer events; may emit AccrueInterest
* @custom:access Not restricted
* @custom:error ZeroAddressNotAllowed is thrown when minter address is zero
*/
function mintBehalf(address minter, uint256 mintAmount) external override nonReentrant returns (uint256) {
ensureNonzeroAddress(minter);
accrueInterest();
_mintFresh(msg.sender, minter, mintAmount);
return NO_ERROR;
}
/**
* @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 error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event Emits Redeem and Transfer events; may emit AccrueInterest
* @custom:error RedeemTransferOutNotPossible is thrown when the protocol has insufficient cash
* @custom:access Not restricted
*/
function redeem(uint256 redeemTokens) external override nonReentrant returns (uint256) {
accrueInterest();
_redeemFresh(msg.sender, msg.sender, redeemTokens, 0);
return NO_ERROR;
}
/**
* @notice Sender redeems assets on behalf of some other address. This function is only available
* for senders, explicitly marked as delegates of the supplier using `comptroller.updateDelegate`
* @dev Accrues interest whether or not the operation succeeds, unless reverted
* @param redeemer The user on behalf of whom to redeem
* @param redeemTokens The number of vTokens to redeem into underlying
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @custom:error InsufficientRedeemApproval is thrown when sender is not approved by the redeemer for the given amount
* @custom:error RedeemTransferOutNotPossible is thrown when the protocol has insufficient cash
* @custom:event Emits Redeem and Transfer events; may emit AccrueInterest
* @custom:access Not restricted
*/
function redeemBehalf(address redeemer, uint256 redeemTokens) external override nonReentrant returns (uint256) {
_ensureSenderIsDelegateOf(redeemer);
accrueInterest();
_redeemFresh(redeemer, msg.sender, redeemTokens, 0);
return NO_ERROR;
}
/**
* @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 error Always NO_ERROR for compatibility with Venus core tooling
*/
function redeemUnderlying(uint256 redeemAmount) external override nonReentrant returns (uint256) {
accrueInterest();
_redeemFresh(msg.sender, msg.sender, 0, redeemAmount);
return NO_ERROR;
}
/**
* @notice Sender redeems underlying assets on behalf of some other address. This function is only available
* for senders, explicitly marked as delegates of the supplier using `comptroller.updateDelegate`
* @dev Accrues interest whether or not the operation succeeds, unless reverted
* @param redeemer, on behalf of whom to redeem
* @param redeemAmount The amount of underlying to receive from redeeming vTokens
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @custom:error InsufficientRedeemApproval is thrown when sender is not approved by the redeemer for the given amount
* @custom:event Emits Redeem and Transfer events; may emit AccrueInterest
* @custom:access Not restricted
*/
function redeemUnderlyingBehalf(
address redeemer,
uint256 redeemAmount
) external override nonReentrant returns (uint256) {
_ensureSenderIsDelegateOf(redeemer);
accrueInterest();
_redeemFresh(redeemer, msg.sender, 0, redeemAmount);
return NO_ERROR;
}
/**
* @notice Sender borrows assets from the protocol to their own address
* @param borrowAmount The amount of the underlying asset to borrow
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event Emits Borrow event; may emit AccrueInterest
* @custom:error BorrowCashNotAvailable is thrown when the protocol has insufficient cash
* @custom:access Not restricted
*/
function borrow(uint256 borrowAmount) external override nonReentrant returns (uint256) {
accrueInterest();
_borrowFresh(msg.sender, msg.sender, borrowAmount);
return NO_ERROR;
}
/**
* @notice Sender borrows assets on behalf of some other address. This function is only available
* for senders, explicitly marked as delegates of the borrower using `comptroller.updateDelegate`
* @param borrower The borrower, on behalf of whom to borrow
* @param borrowAmount The amount of the underlying asset to borrow
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @custom:error DelegateNotApproved is thrown if caller is not approved delegate
* @custom:error BorrowCashNotAvailable is thrown when the protocol has insufficient cash
* @custom:event Emits Borrow event; may emit AccrueInterest
* @custom:access Not restricted
*/
function borrowBehalf(address borrower, uint256 borrowAmount) external override returns (uint256) {
_ensureSenderIsDelegateOf(borrower);
accrueInterest();
_borrowFresh(borrower, msg.sender, borrowAmount);
return NO_ERROR;
}
/**
* @notice Sender repays their own borrow
* @param repayAmount The amount to repay, or type(uint256).max for the full outstanding amount
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event Emits RepayBorrow event; may emit AccrueInterest
* @custom:access Not restricted
*/
function repayBorrow(uint256 repayAmount) external override nonReentrant returns (uint256) {
accrueInterest();
_repayBorrowFresh(msg.sender, msg.sender, repayAmount);
return NO_ERROR;
}
/**
* @notice Sender repays a borrow belonging to borrower
* @param borrower the account with the debt being payed off
* @param repayAmount The amount to repay, or type(uint256).max for the full outstanding amount
* @return error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event Emits RepayBorrow event; may emit AccrueInterest
* @custom:access Not restricted
*/
function repayBorrowBehalf(address borrower, uint256 repayAmount) external override nonReentrant returns (uint256) {
accrueInterest();
_repayBorrowFresh(msg.sender, borrower, repayAmount);
return NO_ERROR;
}
/**
* @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 error Always NO_ERROR for compatibility with Venus core tooling
* @custom:event Emits LiquidateBorrow event; may emit AccrueInterest
* @custom:error LiquidateAccrueCollateralInterestFailed is thrown when it is not possible to accrue interest on the collateral vToken
* @custom:error LiquidateCollateralFreshnessCheck is thrown when interest has not been accrued on the collateral vToken
* @custom:error LiquidateLiquidatorIsBorrower is thrown when trying to liquidate self
* @custom:error LiquidateCloseAmountIsZero is thrown when repayment amount is zero
* @custom:error LiquidateCloseAmountIsUintMax is thrown when repayment amount is UINT_MAX
* @custom:access Not restricted
*/
function liquidateBorrow(
address borrower,
uint256 repayAmount,
VTokenInterface vTokenCollateral
) external override returns (uint256) {
_liquidateBorrow(msg.sender, borrower, repayAmount, vTokenCollateral, false);
return NO_ERROR;
}
/**
* @notice sets protocol share accumulated from liquidations
* @dev must be equal or less than liquidation incentive - 1
* @param newProtocolSeizeShareMantissa_ new protocol share mantissa
* @custom:event Emits NewProtocolSeizeShare event on success
* @custom:error Unauthorized error is thrown when the call is not authorized by AccessControlManager
* @custom:error ProtocolSeizeShareTooBig is thrown when the new seize share is too high
* @custom:access Controlled by AccessControlManager
*/
function setProtocolSeizeShare(uint256 newProtocolSeizeShareMantissa_) external {
_checkAccessAllowed("setProtocolSeizeShare(uint256)");
uint256 liquidationIncentive = ComptrollerViewInterface(address(comptroller)).liquidationIncentiveMantissa();
if (newProtocolSeizeShareMantissa_ + MANTISSA_ONE > liquidationIncentive) {
revert ProtocolSeizeShareTooBig();
}
uint256 oldProtocolSeizeShareMantissa = protocolSeizeShareMantissa;
protocolSeizeShareMantissa = newProtocolSeizeShareMantissa_;
emit NewProtocolSeizeShare(oldProtocolSeizeShareMantissa, newProtocolSeizeShareMantissa_);
}
/**
* @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
* @param newReserveFactorMantissa New reserve factor (from 0 to 1e18)
* @custom:event Emits NewReserveFactor event; may emit AccrueInterest
* @custom:error Unauthorized error is thrown when the call is not authorized by AccessControlManager
* @custom:error SetReserveFactorBoundsCheck is thrown when the new reserve factor is too high
* @custom:access Controlled by AccessControlManager
*/
function setReserveFactor(uint256 newReserveFactorMantissa) external override nonReentrant {
_checkAccessAllowed("setReserveFactor(uint256)");
accrueInterest();
_setReserveFactorFresh(newReserveFactorMantissa);
}
/**
* @notice Accrues interest and reduces reserves by transferring to the protocol reserve contract
* @dev Gracefully return if reserves already reduced in accrueInterest
* @param reduceAmount Amount of reduction to reserves
* @custom:event Emits ReservesReduced event; may emit AccrueInterest
* @custom:error ReduceReservesCashNotAvailable is thrown when the vToken does not have sufficient cash
* @custom:error ReduceReservesCashValidation is thrown when trying to withdraw more cash than the reserves have
* @custom:access Not restricted
*/
function reduceReserves(uint256 reduceAmount) external override nonReentrant {
accrueInterest();
if (reduceReservesBlockNumber == getBlockNumberOrTimestamp()) return;
_reduceReservesFresh(reduceAmount);
}
/**
* @notice The sender adds to reserves.
* @param addAmount The amount of underlying token to add as reserves
* @custom:event Emits ReservesAdded event; may emit AccrueInterest
* @custom:access Not restricted
*/
function addReserves(uint256 addAmount) external override nonReentrant {
accrueInterest();
_addReservesFresh(addAmount);
}
/**
* @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
* @custom:event Emits NewMarketInterestRateModel event; may emit AccrueInterest
* @custom:error Unauthorized error is thrown when the call is not authorized by AccessControlManager
* @custom:access Controlled by AccessControlManager
*/
function setInterestRateModel(InterestRateModel newInterestRateModel) external override {
_checkAccessAllowed("setInterestRateModel(address)");
accrueInterest();
_setInterestRateModelFresh(newInterestRateModel);
}
/**
* @notice Repays a certain amount of debt, treats the rest of the borrow as bad debt, essentially
* "forgiving" the borrower. Healing is a situation that should rarely happen. However, some pools
* may list risky assets or be configured improperly – we want to still handle such cases gracefully.
* We assume that Comptroller does the seizing, so this function is only available to Comptroller.
* @dev This function does not call any Comptroller hooks (like "healAllowed"), because we assume
* the Comptroller does all the necessary checks before calling this function.
* @param payer account who repays the debt
* @param borrower account to heal
* @param repayAmount amount to repay
* @custom:event Emits RepayBorrow, BadDebtIncreased events; may emit AccrueInterest
* @custom:error HealBorrowUnauthorized is thrown when the request does not come from Comptroller
* @custom:access Only Comptroller
*/
function healBorrow(address payer, address borrower, uint256 repayAmount) external override nonReentrant {
if (repayAmount != 0) {
comptroller.preRepayHook(address(this), borrower);
}
if (msg.sender != address(comptroller)) {
revert HealBorrowUnauthorized();
}
uint256 accountBorrowsPrev = _borrowBalanceStored(borrower);
uint256 totalBorrowsNew = totalBorrows;
uint256 actualRepayAmount;
if (repayAmount != 0) {
// _doTransferIn reverts if anything goes wrong, since we can't be sure if side effects occurred.
// We violate checks-effects-interactions here to account for tokens that take transfer fees
actualRepayAmount = _doTransferIn(payer, repayAmount);
totalBorrowsNew = totalBorrowsNew - actualRepayAmount;
emit RepayBorrow(
payer,
borrower,
actualRepayAmount,
accountBorrowsPrev - actualRepayAmount,
totalBorrowsNew
);
}
// The transaction will fail if trying to repay too much
uint256 badDebtDelta = accountBorrowsPrev - actualRepayAmount;
if (badDebtDelta != 0) {
uint256 badDebtOld = badDebt;
uint256 badDebtNew = badDebtOld + badDebtDelta;
totalBorrowsNew = totalBorrowsNew - badDebtDelta;
badDebt = badDebtNew;
// We treat healing as "repayment", where vToken is the payer
emit RepayBorrow(address(this), borrower, badDebtDelta, 0, totalBorrowsNew);
emit BadDebtIncreased(borrower, badDebtDelta, badDebtOld, badDebtNew);
}
accountBorrows[borrower].principal = 0;
accountBorrows[borrower].interestIndex = borrowIndex;
totalBorrows = totalBorrowsNew;
emit HealBorrow(payer, borrower, repayAmount);
}
/**
* @notice The extended version of liquidations, callable only by Comptroller. May skip
* the close factor check. The collateral seized is transferred to the liquidator.
* @param liquidator The address repaying the borrow and seizing collateral
* @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
* @param skipLiquidityCheck If set to true, allows to liquidate up to 100% of the borrow
* regardless of the account liquidity
* @custom:event Emits LiquidateBorrow event; may emit AccrueInterest
* @custom:error ForceLiquidateBorrowUnauthorized is thrown when the request does not come from Comptroller
* @custom:error LiquidateAccrueCollateralInterestFailed is thrown when it is not possible to accrue interest on the collateral vToken
* @custom:error LiquidateCollateralFreshnessCheck is thrown when interest has not been accrued on the collateral vToken
* @custom:error LiquidateLiquidatorIsBorrower is thrown when trying to liquidate self
* @custom:error LiquidateCloseAmountIsZero is thrown when repayment amount is zero
* @custom:error LiquidateCloseAmountIsUintMax is thrown when repayment amount is UINT_MAX
* @custom:access Only Comptroller
*/
function forceLiquidateBorrow(
address liquidator,
address borrower,
uint256 repayAmount,
VTokenInterface vTokenCollateral,
bool skipLiquidityCheck
) external override {
if (msg.sender != address(comptroller)) {
revert ForceLiquidateBorrowUnauthorized();
}
_liquidateBorrow(liquidator, borrower, repayAmount, vTokenCollateral, skipLiquidityCheck);
}
/**
* @notice Transfers collateral tokens (this market) to the liquidator.
* @dev Will fail unless called by another vToken during the process of liquidation.
* It's 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
* @custom:event Emits Transfer, ReservesAdded events
* @custom:error LiquidateSeizeLiquidatorIsBorrower is thrown when trying to liquidate self
* @custom:access Not restricted
*/
function seize(address liquidator, address borrower, uint256 seizeTokens) external override nonReentrant {
_seize(msg.sender, liquidator, borrower, seizeTokens);
}
/**
* @notice Updates bad debt
* @dev Called only when bad debt is recovered from auction
* @param recoveredAmount_ The amount of bad debt recovered
* @custom:event Emits BadDebtRecovered event
* @custom:access Only Shortfall contract
*/
function badDebtRecovered(uint256 recoveredAmount_) external {
require(msg.sender == shortfall, "only shortfall contract can update bad debt");
require(recoveredAmount_ <= badDebt, "more than bad debt recovered from auction");
uint256 badDebtOld = badDebt;
uint256 badDebtNew = badDebtOld - recoveredAmount_;
badDebt = badDebtNew;
emit BadDebtRecovered(badDebtOld, badDebtNew);
}
/**
* @notice Sets protocol share reserve contract address
* @param protocolShareReserve_ The address of the protocol share reserve contract
* @custom:error ZeroAddressNotAllowed is thrown when protocol share reserve address is zero
* @custom:access Only Governance
*/
function setProtocolShareReserve(address payable protocolShareReserve_) external onlyOwner {
_setProtocolShareReserve(protocolShareReserve_);
}
/**
* @notice Sets shortfall contract address
* @param shortfall_ The address of the shortfall contract
* @custom:error ZeroAddressNotAllowed is thrown when shortfall contract address is zero
* @custom:access Only Governance
*/
function setShortfallContract(address shortfall_) external onlyOwner {
_setShortfallContract(shortfall_);
}
/**
* @notice A public function to sweep accidental ERC-20 transfers to this contract. Tokens are sent to admin (timelock)
* @param token The address of the ERC-20 token to sweep
* @custom:access Only Governance
*/
function sweepToken(IERC20Upgradeable token) external override {
require(msg.sender == owner(), "VToken::sweepToken: only admin can sweep tokens");
require(address(token) != underlying, "VToken::sweepToken: can not sweep underlying token");
uint256 balance = token.balanceOf(address(this));
token.safeTransfer(owner(), balance);
emit SweepToken(address(token));
}
/**
* @notice A public function to set new threshold of slot(block or second) difference after which funds will be sent to the protocol share reserve
* @param _newReduceReservesBlockOrTimestampDelta slot(block or second) difference value
* @custom:access Only Governance
*/
function setReduceReservesBlockDelta(uint256 _newReduceReservesBlockOrTimestampDelta) external {
_checkAccessAllowed("setReduceReservesBlockDelta(uint256)");
require(_newReduceReservesBlockOrTimestampDelta > 0, "Invalid Input");
emit NewReduceReservesBlockDelta(reduceReservesBlockDelta, _newReduceReservesBlockOrTimestampDelta);
reduceReservesBlockDelta = _newReduceReservesBlockOrTimestampDelta;
}
/**
* @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 amount The number of tokens allowed to be spent (type(uint256).max means infinite)
*/
function allowance(address owner, address spender) external view override returns (uint256) {
return transferAllowances[owner][spender];
}
/**
* @notice Get the token balance of the `owner`
* @param owner The address of the account to query
* @return amount The number of tokens owned by `owner`
*/
function balanceOf(address owner) external view override returns (uint256) {
return accountTokens[owner];
}
/**
* @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 error Always NO_ERROR for compatibility with Venus core tooling
* @return vTokenBalance User's balance of vTokens
* @return borrowBalance Amount owed in terms of underlying
* @return exchangeRate Stored exchange rate
*/
function getAccountSnapshot(
address account
)
external
view
override
returns (uint256 error, uint256 vTokenBalance, uint256 borrowBalance, uint256 exchangeRate)
{
return (NO_ERROR, accountTokens[account], _borrowBalanceStored(account), _exchangeRateStored());
}
/**
* @notice Get cash balance of this vToken in the underlying asset
* @return cash The quantity of underlying asset owned by this contract
*/
function getCash() external view override returns (uint256) {
return _getCashPrior();
}
/**
* @notice Returns the current per slot(block or second) borrow interest rate for this vToken
* @return rate The borrow interest rate per slot(block or second), scaled by 1e18
*/
function borrowRatePerBlock() external view override returns (uint256) {
return interestRateModel.getBorrowRate(_getCashPrior(), totalBorrows, totalReserves, badDebt);
}
/**
* @notice Returns the current per-slot(block or second) supply interest rate for this v
* @return rate The supply interest rate per slot(block or second), scaled by 1e18
*/
function supplyRatePerBlock() external view override returns (uint256) {
return
interestRateModel.getSupplyRate(
_getCashPrior(),
totalBorrows,
totalReserves,
reserveFactorMantissa,
badDebt
);
}
/**
* @notice Return the borrow balance of account based on stored data
* @param account The address whose balance should be calculated
* @return borrowBalance The calculated balance
*/
function borrowBalanceStored(address account) external view override returns (uint256) {
return _borrowBalanceStored(account);
}
/**
* @notice Calculates the exchange rate from the underlying to the VToken
* @dev This function does not accrue interest before calculating the exchange rate
* @return exchangeRate Calculated exchange rate scaled by 1e18
*/
function exchangeRateStored() external view override returns (uint256) {
return _exchangeRateStored();
}
/**
* @notice Accrue interest then return the up-to-date exchange rate
* @return exchangeRate Calculated exchange rate scaled by 1e18
*/
function exchangeRateCurrent() public override nonReentrant returns (uint256) {
accrueInterest();
return _exchangeRateStored();
}
/**
* @notice Applies accrued interest to total borrows and reserves
* @dev This calculates interest accrued from the last checkpointed slot(block or second)
* up to the current slot(block or second) and writes new checkpoint to storage and
* reduce spread reserves to protocol share reserve
* if currentSlot - reduceReservesBlockNumber >= slotDelta
* @return Always NO_ERROR
* @custom:event Emits AccrueInterest event on success
* @custom:access Not restricted
*/
function accrueInterest() public virtual override returns (uint256) {
/* Remember the initial block number or timestamp */
uint256 currentSlotNumber = getBlockNumberOrTimestamp();
uint256 accrualSlotNumberPrior = accrualBlockNumber;
/* Short-circuit accumulating 0 interest */
if (accrualSlotNumberPrior == currentSlotNumber) {
return NO_ERROR;
}
/* Read the previous values out of storage */
uint256 cashPrior = _getCashPrior();
uint256 borrowsPrior = totalBorrows;
uint256 reservesPrior = totalReserves;
uint256 borrowIndexPrior = borrowIndex;
/* Calculate the current borrow interest rate */
uint256 borrowRateMantissa = interestRateModel.getBorrowRate(cashPrior, borrowsPrior, reservesPrior, badDebt);
require(borrowRateMantissa <= MAX_BORROW_RATE_MANTISSA, "borrow rate is absurdly high");
/* Calculate the number of slots elapsed since the last accrual */
uint256 slotDelta = currentSlotNumber - accrualSlotNumberPrior;
/*
* Calculate the interest accumulated into borrows and reserves and the new index:
* simpleInterestFactor = borrowRate * slotDelta
* interestAccumulated = simpleInterestFactor * totalBorrows
* totalBorrowsNew = interestAccumulated + totalBorrows
* totalReservesNew = interestAccumulated * reserveFactor + totalReserves
* borrowIndexNew = simpleInterestFactor * borrowIndex + borrowIndex
*/
Exp memory simpleInterestFactor = mul_(Exp({ mantissa: borrowRateMantissa }), slotDelta);
uint256 interestAccumulated = mul_ScalarTruncate(simpleInterestFactor, borrowsPrior);
uint256 totalBorrowsNew = interestAccumulated + borrowsPrior;
uint256 totalReservesNew = mul_ScalarTruncateAddUInt(
Exp({ mantissa: reserveFactorMantissa }),
interestAccumulated,
reservesPrior
);
uint256 borrowIndexNew = mul_ScalarTruncateAddUInt(simpleInterestFactor, borrowIndexPrior, borrowIndexPrior);
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
/* We write the previously calculated values into storage */
accrualBlockNumber = currentSlotNumber;
borrowIndex = borrowIndexNew;
totalBorrows = totalBorrowsNew;
totalReserves = totalReservesNew;
if (currentSlotNumber - reduceReservesBlockNumber >= reduceReservesBlockDelta) {
reduceReservesBlockNumber = currentSlotNumber;
if (cashPrior < totalReservesNew) {
_reduceReservesFresh(cashPrior);
} else {
_reduceReservesFresh(totalReservesNew);
}
}
/* We emit an AccrueInterest event */
emit AccrueInterest(cashPrior, interestAccumulated, borrowIndexNew, totalBorrowsNew);
return NO_ERROR;
}
/**
* @notice User supplies assets into the market and receives vTokens in exchange
* @dev Assumes interest has already been accrued up to the current block or timestamp
* @param payer The address of the account which is sending the assets for supply
* @param minter The address of the account which is supplying the assets
* @param mintAmount The amount of the underlying asset to supply
*/
function _mintFresh(address payer, address minter, uint256 mintAmount) internal {
/* Fail if mint not allowed */
comptroller.preMintHook(address(this), minter, mintAmount);
/* Verify market's slot(block or second) number equals current slot(block or second) number */
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert MintFreshnessCheck();
}
Exp memory exchangeRate = Exp({ mantissa: _exchangeRateStored() });
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
/*
* We call `_doTransferIn` for the minter and the mintAmount.
* `_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.
*/
uint256 actualMintAmount = _doTransferIn(payer, mintAmount);
/*
* We get the current exchange rate and calculate the number of vTokens to be minted:
* mintTokens = actualMintAmount / exchangeRate
*/
uint256 mintTokens = div_(actualMintAmount, exchangeRate);
/*
* We calculate the new total supply of vTokens and minter token balance, checking for overflow:
* totalSupplyNew = totalSupply + mintTokens
* accountTokensNew = accountTokens[minter] + mintTokens
* And write them into storage
*/
totalSupply = totalSupply + mintTokens;
uint256 balanceAfter = accountTokens[minter] + mintTokens;
accountTokens[minter] = balanceAfter;
/* We emit a Mint event, and a Transfer event */
emit Mint(minter, actualMintAmount, mintTokens, balanceAfter);
emit Transfer(address(0), minter, mintTokens);
/* We call the defense and prime accrue interest hook */
comptroller.mintVerify(address(this), minter, actualMintAmount, mintTokens);
}
/**
* @notice Redeemer redeems vTokens in exchange for the underlying assets, transferred to the receiver. Redeemer and receiver can be the same
* address, or different addresses if the receiver was previously approved by the redeemer as a valid delegate (see Comptroller.updateDelegate)
* @dev Assumes interest has already been accrued up to the current slot(block or second)
* @param redeemer The address of the account which is redeeming the tokens
* @param receiver The receiver of the underlying 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)
*/
function _redeemFresh(address redeemer, address receiver, uint256 redeemTokensIn, uint256 redeemAmountIn) internal {
require(redeemTokensIn == 0 || redeemAmountIn == 0, "one of redeemTokensIn or redeemAmountIn must be zero");
/* Verify market's slot(block or second) number equals current slot(block or second) number */
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert RedeemFreshnessCheck();
}
/* exchangeRate = invoke Exchange Rate Stored() */
Exp memory exchangeRate = Exp({ mantissa: _exchangeRateStored() });
uint256 redeemTokens;
uint256 redeemAmount;
/* If redeemTokensIn > 0: */
if (redeemTokensIn > 0) {
/*
* We calculate the exchange rate and the amount of underlying to be redeemed:
* redeemTokens = redeemTokensIn
*/
redeemTokens = redeemTokensIn;
} else {
/*
* We get the current exchange rate and calculate the amount to be redeemed:
* redeemTokens = redeemAmountIn / exchangeRate
*/
redeemTokens = div_(redeemAmountIn, exchangeRate);
uint256 _redeemAmount = mul_(redeemTokens, exchangeRate);
if (_redeemAmount != 0 && _redeemAmount != redeemAmountIn) redeemTokens++; // round up
}
// redeemAmount = exchangeRate * redeemTokens
redeemAmount = mul_ScalarTruncate(exchangeRate, redeemTokens);
// Revert if amount is zero
if (redeemAmount == 0) {
revert("redeemAmount is zero");
}
/* Fail if redeem not allowed */
comptroller.preRedeemHook(address(this), redeemer, redeemTokens);
/* Fail gracefully if protocol has insufficient cash */
if (_getCashPrior() - totalReserves < redeemAmount) {
revert RedeemTransferOutNotPossible();
}
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
/*
* We write the previously calculated values into storage.
* Note: Avoid token reentrancy attacks by writing reduced supply before external transfer.
*/
totalSupply = totalSupply - redeemTokens;
uint256 balanceAfter = accountTokens[redeemer] - redeemTokens;
accountTokens[redeemer] = balanceAfter;
/*
* We invoke _doTransferOut for the receiver and the redeemAmount.
* 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(receiver, redeemAmount);
/* We emit a Transfer event, and a Redeem event */
emit Transfer(redeemer, address(this), redeemTokens);
emit Redeem(redeemer, redeemAmount, redeemTokens, balanceAfter);
/* We call the defense and prime accrue interest hook */
comptroller.redeemVerify(address(this), redeemer, redeemAmount, redeemTokens);
}
/**
* @notice Users or their delegates borrow assets from the protocol
* @param borrower User who borrows the assets
* @param receiver The receiver of the tokens, if called by a delegate
* @param borrowAmount The amount of the underlying asset to borrow
*/
function _borrowFresh(address borrower, address receiver, uint256 borrowAmount) internal {
/* Fail if borrow not allowed */
comptroller.preBorrowHook(address(this), borrower, borrowAmount);
/* Verify market's slot(block or second) number equals current slot(block or second) number */
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert BorrowFreshnessCheck();
}
/* Fail gracefully if protocol has insufficient underlying cash */
if (_getCashPrior() - totalReserves < borrowAmount) {
revert BorrowCashNotAvailable();
}
/*
* We calculate the new borrower and total borrow balances, failing on overflow:
* accountBorrowNew = accountBorrow + borrowAmount
* totalBorrowsNew = totalBorrows + borrowAmount
*/
uint256 accountBorrowsPrev = _borrowBalanceStored(borrower);
uint256 accountBorrowsNew = accountBorrowsPrev + borrowAmount;
uint256 totalBorrowsNew = totalBorrows + borrowAmount;
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
/*
* We write the previously calculated values into storage.
* Note: Avoid token reentrancy attacks by writing increased borrow before external transfer.
`*/
accountBorrows[borrower].principal = accountBorrowsNew;
accountBorrows[borrower].interestIndex = borrowIndex;
totalBorrows = totalBorrowsNew;
/*
* We invoke _doTransferOut for the receiver and the borrowAmount.
* 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(receiver, borrowAmount);
/* We emit a Borrow event */
emit Borrow(borrower, borrowAmount, accountBorrowsNew, totalBorrowsNew);
/* We call the defense and prime accrue interest hook */
comptroller.borrowVerify(address(this), borrower, borrowAmount);
}
/**
* @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 underlying tokens being returned, or type(uint256).max for the full outstanding amount
* @return (uint) the actual repayment amount.
*/
function _repayBorrowFresh(address payer, address borrower, uint256 repayAmount) internal returns (uint256) {
/* Fail if repayBorrow not allowed */
comptroller.preRepayHook(address(this), borrower);
/* Verify market's slot(block or second) number equals current slot(block or second) number */
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert RepayBorrowFreshnessCheck();
}
/* We fetch the amount the borrower owes, with accumulated interest */
uint256 accountBorrowsPrev = _borrowBalanceStored(borrower);
uint256 repayAmountFinal = repayAmount >= accountBorrowsPrev ? accountBorrowsPrev : repayAmount;
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
/*
* We call _doTransferIn for the payer and the repayAmount
* 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.
*/
uint256 actualRepayAmount = _doTransferIn(payer, repayAmountFinal);
/*
* We calculate the new borrower and total borrow balances, failing on underflow:
* accountBorrowsNew = accountBorrows - actualRepayAmount
* totalBorrowsNew = totalBorrows - actualRepayAmount
*/
uint256 accountBorrowsNew = accountBorrowsPrev - actualRepayAmount;
uint256 totalBorrowsNew = totalBorrows - actualRepayAmount;
/* We write the previously calculated values into storage */
accountBorrows[borrower].principal = accountBorrowsNew;
accountBorrows[borrower].interestIndex = borrowIndex;
totalBorrows = totalBorrowsNew;
/* We emit a RepayBorrow event */
emit RepayBorrow(payer, borrower, actualRepayAmount, accountBorrowsNew, totalBorrowsNew);
/* We call the defense and prime accrue interest hook */
comptroller.repayBorrowVerify(address(this), payer, borrower, actualRepayAmount, borrowIndex);
return actualRepayAmount;
}
/**
* @notice The sender liquidates the borrowers collateral.
* The collateral seized is transferred to the liquidator.
* @param liquidator The address repaying the borrow and seizing collateral
* @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
* @param skipLiquidityCheck If set to true, allows to liquidate up to 100% of the borrow
* regardless of the account liquidity
*/
function _liquidateBorrow(
address liquidator,
address borrower,
uint256 repayAmount,
VTokenInterface vTokenCollateral,
bool skipLiquidityCheck
) internal nonReentrant {
accrueInterest();
uint256 error = vTokenCollateral.accrueInterest();
if (error != NO_ERROR) {
// accrueInterest emits logs on errors, but we still want to log the fact that an attempted liquidation failed
revert LiquidateAccrueCollateralInterestFailed(error);
}
_liquidateBorrowFresh(liquidator, borrower, repayAmount, vTokenCollateral, skipLiquidityCheck);
}
/**
* @notice The liquidator liquidates the borrowers collateral.
* The collateral seized is transferred to the liquidator.
* @param liquidator The address repaying the borrow and seizing collateral
* @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
* @param skipLiquidityCheck If set to true, allows to liquidate up to 100% of the borrow
* regardless of the account liquidity
*/
function _liquidateBorrowFresh(
address liquidator,
address borrower,
uint256 repayAmount,
VTokenInterface vTokenCollateral,
bool skipLiquidityCheck
) internal {
/* Fail if liquidate not allowed */
comptroller.preLiquidateHook(
address(this),
address(vTokenCollateral),
borrower,
repayAmount,
skipLiquidityCheck
);
/* Verify market's slot(block or second) number equals current slot(block or second) number */
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert LiquidateFreshnessCheck();
}
/* Verify vTokenCollateral market's slot(block or second) number equals current slot(block or second) number */
if (vTokenCollateral.accrualBlockNumber() != getBlockNumberOrTimestamp()) {
revert LiquidateCollateralFreshnessCheck();
}
/* Fail if borrower = liquidator */
if (borrower == liquidator) {
revert LiquidateLiquidatorIsBorrower();
}
/* Fail if repayAmount = 0 */
if (repayAmount == 0) {
revert LiquidateCloseAmountIsZero();
}
/* Fail if repayAmount = type(uint256).max */
if (repayAmount == type(uint256).max) {
revert LiquidateCloseAmountIsUintMax();
}
/* Fail if repayBorrow fails */
uint256 actualRepayAmount = _repayBorrowFresh(liquidator, borrower, repayAmount);
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
/* We calculate the number of collateral tokens that will be seized */
(uint256 amountSeizeError, uint256 seizeTokens) = comptroller.liquidateCalculateSeizeTokens(
address(this),
address(vTokenCollateral),
actualRepayAmount
);
require(amountSeizeError == 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, call _seize internally to avoid re-entrancy, otherwise make an external call
if (address(vTokenCollateral) == address(this)) {
_seize(address(this), liquidator, borrower, seizeTokens);
} else {
vTokenCollateral.seize(liquidator, borrower, seizeTokens);
}
/* We emit a LiquidateBorrow event */
emit LiquidateBorrow(liquidator, borrower, actualRepayAmount, address(vTokenCollateral), seizeTokens);
/* We call the defense and prime accrue interest hook */
comptroller.liquidateBorrowVerify(
address(this),
address(vTokenCollateral),
liquidator,
borrower,
actualRepayAmount,
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.
* It's absolutely critical to use msg.sender as the seizer vToken and not a parameter.
* @param seizerContract The contract seizing the collateral (either borrowed vToken or Comptroller)
* @param liquidator The account receiving seized collateral
* @param borrower The account having collateral seized
* @param seizeTokens The number of vTokens to seize
*/
function _seize(address seizerContract, address liquidator, address borrower, uint256 seizeTokens) internal {
/* Fail if seize not allowed */
comptroller.preSeizeHook(address(this), seizerContract, liquidator, borrower);
/* Fail if borrower = liquidator */
if (borrower == liquidator) {
revert LiquidateSeizeLiquidatorIsBorrower();
}
/*
* We calculate the new borrower and liquidator token balances, failing on underflow/overflow:
* borrowerTokensNew = accountTokens[borrower] - seizeTokens
* liquidatorTokensNew = accountTokens[liquidator] + seizeTokens
*/
uint256 liquidationIncentiveMantissa = ComptrollerViewInterface(address(comptroller))
.liquidationIncentiveMantissa();
uint256 numerator = mul_(seizeTokens, Exp({ mantissa: protocolSeizeShareMantissa }));
uint256 protocolSeizeTokens = div_(numerator, Exp({ mantissa: liquidationIncentiveMantissa }));
uint256 liquidatorSeizeTokens = seizeTokens - protocolSeizeTokens;
Exp memory exchangeRate = Exp({ mantissa: _exchangeRateStored() });
uint256 protocolSeizeAmount = mul_ScalarTruncate(exchangeRate, protocolSeizeTokens);
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
/* We write the calculated values into storage */
totalSupply = totalSupply - protocolSeizeTokens;
accountTokens[borrower] = accountTokens[borrower] - seizeTokens;
accountTokens[liquidator] = accountTokens[liquidator] + liquidatorSeizeTokens;
// _doTransferOut reverts if anything goes wrong, since we can't be sure if side effects occurred.
// Transferring an underlying asset to the protocolShareReserve contract to channel the funds for different use.
_doTransferOut(protocolShareReserve, protocolSeizeAmount);
// Update the pool asset's state in the protocol share reserve for the above transfer.
IProtocolShareReserve(protocolShareReserve).updateAssetsState(
address(comptroller),
underlying,
IProtocolShareReserve.IncomeType.LIQUIDATION
);
/* Emit a Transfer event */
emit Transfer(borrower, liquidator, liquidatorSeizeTokens);
emit ProtocolSeize(borrower, protocolShareReserve, protocolSeizeAmount);
/* We call the defense and prime accrue interest hook */
comptroller.seizeVerify(address(this), seizerContract, liquidator, borrower, seizeTokens);
}
function _setComptroller(ComptrollerInterface newComptroller) internal {
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);
}
/**
* @notice Sets a new reserve factor for the protocol (*requires fresh interest accrual)
* @dev Admin function to set a new reserve factor
* @param newReserveFactorMantissa New reserve factor (from 0 to 1e18)
*/
function _setReserveFactorFresh(uint256 newReserveFactorMantissa) internal {
// Verify market's slot(block or second) number equals current slot(block or second) number
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert SetReserveFactorFreshCheck();
}
// Check newReserveFactor ≤ maxReserveFactor
if (newReserveFactorMantissa > MAX_RESERVE_FACTOR_MANTISSA) {
revert SetReserveFactorBoundsCheck();
}
uint256 oldReserveFactorMantissa = reserveFactorMantissa;
reserveFactorMantissa = newReserveFactorMantissa;
emit NewReserveFactor(oldReserveFactorMantissa, newReserveFactorMantissa);
}
/**
* @notice Add reserves by transferring from caller
* @dev Requires fresh interest accrual
* @param addAmount Amount of addition to reserves
* @return actualAddAmount The actual amount added, excluding the potential token fees
*/
function _addReservesFresh(uint256 addAmount) internal returns (uint256) {
// totalReserves + actualAddAmount
uint256 totalReservesNew;
uint256 actualAddAmount;
// We fail gracefully unless market's slot(block or second) number equals current slot(block or second) number
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert AddReservesFactorFreshCheck(actualAddAmount);
}
actualAddAmount = _doTransferIn(msg.sender, addAmount);
totalReservesNew = totalReserves + actualAddAmount;
totalReserves = totalReservesNew;
emit ReservesAdded(msg.sender, actualAddAmount, totalReservesNew);
return actualAddAmount;
}
/**
* @notice Reduces reserves by transferring to the protocol reserve contract
* @dev Requires fresh interest accrual
* @param reduceAmount Amount of reduction to reserves
*/
function _reduceReservesFresh(uint256 reduceAmount) internal {
if (reduceAmount == 0) {
return;
}
// totalReserves - reduceAmount
uint256 totalReservesNew;
// We fail gracefully unless market's slot(block or second) number equals current slot(block or second) number
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert ReduceReservesFreshCheck();
}
// Fail gracefully if protocol has insufficient underlying cash
if (_getCashPrior() < reduceAmount) {
revert ReduceReservesCashNotAvailable();
}
// Check reduceAmount ≤ reserves[n] (totalReserves)
if (reduceAmount > totalReserves) {
revert ReduceReservesCashValidation();
}
/////////////////////////
// EFFECTS & INTERACTIONS
// (No safe failures beyond this point)
totalReservesNew = totalReserves - reduceAmount;
// 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.
// Transferring an underlying asset to the protocolShareReserve contract to channel the funds for different use.
_doTransferOut(protocolShareReserve, reduceAmount);
// Update the pool asset's state in the protocol share reserve for the above transfer.
IProtocolShareReserve(protocolShareReserve).updateAssetsState(
address(comptroller),
underlying,
IProtocolShareReserve.IncomeType.SPREAD
);
emit SpreadReservesReduced(protocolShareReserve, reduceAmount, totalReservesNew);
}
/**
* @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
*/
function _setInterestRateModelFresh(InterestRateModel newInterestRateModel) internal {
// Used to store old model for use in the event that is emitted on success
InterestRateModel oldInterestRateModel;
// We fail gracefully unless market's slot(block or second) number equals current slot(block or second) number
if (accrualBlockNumber != getBlockNumberOrTimestamp()) {
revert SetInterestRateModelFreshCheck();
}
// 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);
}
/**
* Safe Token **
*/
/**
* @dev Similar to ERC-20 transfer, but handles tokens that have transfer fees.
* This function returns the actual amount received,
* which may be less than `amount` if there is a fee attached to the transfer.
* @param from Sender of the underlying tokens
* @param amount Amount of underlying to transfer
* @return Actual amount received
*/
function _doTransferIn(address from, uint256 amount) internal virtual returns (uint256) {
IERC20Upgradeable token = IERC20Upgradeable(underlying);
uint256 balanceBefore = token.balanceOf(address(this));
token.safeTransferFrom(from, address(this), amount);
uint256 balanceAfter = token.balanceOf(address(this));
// Return the amount that was *actually* transferred
return balanceAfter - balanceBefore;
}
/**
* @dev Just a regular ERC-20 transfer, reverts on failure
* @param to Receiver of the underlying tokens
* @param amount Amount of underlying to transfer
*/
function _doTransferOut(address to, uint256 amount) internal virtual {
IERC20Upgradeable token = IERC20Upgradeable(underlying);
token.safeTransfer(to, amount);
}
/**
* @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
*/
function _transferTokens(address spender, address src, address dst, uint256 tokens) internal {
/* Fail if transfer not allowed */
comptroller.preTransferHook(address(this), src, dst, tokens);
/* Do not allow self-transfers */
if (src == dst) {
revert TransferNotAllowed();
}
/* Get the allowance, infinite for the account owner */
uint256 startingAllowance;
if (spender == src) {
startingAllowance = type(uint256).max;
} else {
startingAllowance = transferAllowances[src][spender];
}
/* Do the calculations, checking for {under,over}flow */
uint256 allowanceNew = startingAllowance - tokens;
uint256 srcTokensNew = accountTokens[src] - tokens;
uint256 dstTokensNew = accountTokens[dst] + tokens;
/////////////////////////
// EFFECTS & INTERACTIONS
accountTokens[src] = srcTokensNew;
accountTokens[dst] = dstTokensNew;
/* Eat some of the allowance (if necessary) */
if (startingAllowance != type(uint256).max) {
transferAllowances[src][spender] = allowanceNew;
}
/* We emit a Transfer event */
emit Transfer(src, dst, tokens);
comptroller.transferVerify(address(this), src, dst, tokens);
}
/**
* @notice Initialize the money market
* @param underlying_ The address of the underlying asset
* @param comptroller_ The address of the Comptroller
* @param interestRateModel_ The address of the interest rate model
* @param initialExchangeRateMantissa_ The initial exchange rate, scaled by 1e18
* @param name_ ERC-20 name of this token
* @param symbol_ ERC-20 symbol of this token
* @param decimals_ ERC-20 decimal precision of this token
* @param admin_ Address of the administrator of this token
* @param accessControlManager_ AccessControlManager contract address
* @param riskManagement Addresses of risk & income related contracts
* @param reserveFactorMantissa_ Percentage of borrow interest that goes to reserves (from 0 to 1e18)
*/
function _initialize(
address underlying_,
ComptrollerInterface comptroller_,
InterestRateModel interestRateModel_,
uint256 initialExchangeRateMantissa_,
string memory name_,
string memory symbol_,
uint8 decimals_,
address admin_,
address accessControlManager_,
RiskManagementInit memory riskManagement,
uint256 reserveFactorMantissa_
) internal onlyInitializing {
__Ownable2Step_init();
__AccessControlled_init_unchained(accessControlManager_);
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.");
_setComptroller(comptroller_);
// Initialize slot(block or second) number and borrow index (slot(block or second) number mocks depend on comptroller being set)
accrualBlockNumber = getBlockNumberOrTimestamp();
borrowIndex = MANTISSA_ONE;
// Set the interest rate model (depends on slot(block or second) number / borrow index)
_setInterestRateModelFresh(interestRateModel_);
_setReserveFactorFresh(reserveFactorMantissa_);
name = name_;
symbol = symbol_;
decimals = decimals_;
_setShortfallContract(riskManagement.shortfall);
_setProtocolShareReserve(riskManagement.protocolShareReserve);
protocolSeizeShareMantissa = DEFAULT_PROTOCOL_SEIZE_SHARE_MANTISSA;
// Set underlying and sanity check it
underlying = underlying_;
IERC20Upgradeable(underlying).totalSupply();
// The counter starts true to prevent changing it from zero to non-zero (i.e. smaller cost/refund)
_notEntered = true;
_transferOwnership(admin_);
}
function _setShortfallContract(address shortfall_) internal {
ensureNonzeroAddress(shortfall_);
address oldShortfall = shortfall;
shortfall = shortfall_;
emit NewShortfallContract(oldShortfall, shortfall_);
}
function _setProtocolShareReserve(address payable protocolShareReserve_) internal {
ensureNonzeroAddress(protocolShareReserve_);
address oldProtocolShareReserve = address(protocolShareReserve);
protocolShareReserve = protocolShareReserve_;
emit NewProtocolShareReserve(oldProtocolShareReserve, address(protocolShareReserve_));
}
function _ensureSenderIsDelegateOf(address user) internal view {
if (!ComptrollerViewInterface(address(comptroller)).approvedDelegates(user, msg.sender)) {
revert DelegateNotApproved();
}
}
/**
* @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 virtual returns (uint256) {
return IERC20Upgradeable(underlying).balanceOf(address(this));
}
/**
* @notice Return the borrow balance of account based on stored data
* @param account The address whose balance should be calculated
* @return borrowBalance the calculated balance
*/
function _borrowBalanceStored(address account) internal view returns (uint256) {
/* Get borrowBalance and borrowIndex */
BorrowSnapshot memory 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 0;
}
/* Calculate new borrow balance using the interest index:
* recentBorrowBalance = borrower.borrowBalance * market.borrowIndex / borrower.borrowIndex
*/
uint256 principalTimesIndex = borrowSnapshot.principal * borrowIndex;
return principalTimesIndex / borrowSnapshot.interestIndex;
}
/**
* @notice Calculates the exchange rate from the underlying to the VToken
* @dev This function does not accrue interest before calculating the exchange rate
* @return exchangeRate Calculated exchange rate scaled by 1e18
*/
function _exchangeRateStored() internal view virtual returns (uint256) {
uint256 _totalSupply = totalSupply;
if (_totalSupply == 0) {
/*
* If there are no tokens minted:
* exchangeRate = initialExchangeRate
*/
return initialExchangeRateMantissa;
}
/*
* Otherwise:
* exchangeRate = (totalCash + totalBorrows + badDebt - totalReserves) / totalSupply
*/
uint256 totalCash = _getCashPrior();
uint256 cashPlusBorrowsMinusReserves = totalCash + totalBorrows + badDebt - totalReserves;
uint256 exchangeRate = (cashPlusBorrowsMinusReserves * EXP_SCALE) / _totalSupply;
return exchangeRate;
}
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity 0.8.25;
import { IERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import { ResilientOracleInterface } from "@venusprotocol/oracle/contracts/interfaces/OracleInterface.sol";
import { ComptrollerInterface } from "./ComptrollerInterface.sol";
import { InterestRateModel } from "./InterestRateModel.sol";
/**
* @title VTokenStorage
* @author Venus
* @notice Storage layout used by the `VToken` contract
*/
// solhint-disable-next-line max-states-count
contract VTokenStorage {
/**
* @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 {
uint256 principal;
uint256 interestIndex;
}
/**
* @dev Guard variable for re-entrancy checks
*/
bool internal _notEntered;
/**
* @notice Underlying asset for this VToken
*/
address public underlying;
/**
* @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 Protocol share Reserve contract address
*/
address payable public protocolShareReserve;
/**
* @notice Contract which oversees inter-vToken operations
*/
ComptrollerInterface public comptroller;
/**
* @notice Model which tells what the current interest rate should be
*/
InterestRateModel public interestRateModel;
// Initial exchange rate used when minting the first VTokens (used when totalSupply = 0)
uint256 internal initialExchangeRateMantissa;
/**
* @notice Fraction of interest currently set aside for reserves
*/
uint256 public reserveFactorMantissa;
/**
* @notice Slot(block or second) number that interest was last accrued at
*/
uint256 public accrualBlockNumber;
/**
* @notice Accumulator of the total earned interest rate since the opening of the market
*/
uint256 public borrowIndex;
/**
* @notice Total amount of outstanding borrows of the underlying in this market
*/
uint256 public totalBorrows;
/**
* @notice Total amount of reserves of the underlying held in this market
*/
uint256 public totalReserves;
/**
* @notice Total number of tokens in circulation
*/
uint256 public totalSupply;
/**
* @notice Total bad debt of the market
*/
uint256 public badDebt;
// Official record of token balances for each account
mapping(address => uint256) internal accountTokens;
// Approved token transfer amounts on behalf of others
mapping(address => mapping(address => uint256)) internal transferAllowances;
// Mapping of account addresses to outstanding borrow balances
mapping(address => BorrowSnapshot) internal accountBorrows;
/**
* @notice Share of seized collateral that is added to reserves
*/
uint256 public protocolSeizeShareMantissa;
/**
* @notice Storage of Shortfall contract address
*/
address public shortfall;
/**
* @notice delta slot (block or second) after which reserves will be reduced
*/
uint256 public reduceReservesBlockDelta;
/**
* @notice last slot (block or second) number at which reserves were reduced
*/
uint256 public reduceReservesBlockNumber;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[48] private __gap;
}
/**
* @title VTokenInterface
* @author Venus
* @notice Interface implemented by the `VToken` contract
*/
abstract contract VTokenInterface is VTokenStorage {
struct RiskManagementInit {
address shortfall;
address payable protocolShareReserve;
}
/*** Market Events ***/
/**
* @notice Event emitted when interest is accrued
*/
event AccrueInterest(uint256 cashPrior, uint256 interestAccumulated, uint256 borrowIndex, uint256 totalBorrows);
/**
* @notice Event emitted when tokens are minted
*/
event Mint(address indexed minter, uint256 mintAmount, uint256 mintTokens, uint256 accountBalance);
/**
* @notice Event emitted when tokens are redeemed
*/
event Redeem(address indexed redeemer, uint256 redeemAmount, uint256 redeemTokens, uint256 accountBalance);
/**
* @notice Event emitted when underlying is borrowed
*/
event Borrow(address indexed borrower, uint256 borrowAmount, uint256 accountBorrows, uint256 totalBorrows);
/**
* @notice Event emitted when a borrow is repaid
*/
event RepayBorrow(
address indexed payer,
address indexed borrower,
uint256 repayAmount,
uint256 accountBorrows,
uint256 totalBorrows
);
/**
* @notice Event emitted when bad debt is accumulated on a market
* @param borrower borrower to "forgive"
* @param badDebtDelta amount of new bad debt recorded
* @param badDebtOld previous bad debt value
* @param badDebtNew new bad debt value
*/
event BadDebtIncreased(address indexed borrower, uint256 badDebtDelta, uint256 badDebtOld, uint256 badDebtNew);
/**
* @notice Event emitted when bad debt is recovered via an auction
* @param badDebtOld previous bad debt value
* @param badDebtNew new bad debt value
*/
event BadDebtRecovered(uint256 badDebtOld, uint256 badDebtNew);
/**
* @notice Event emitted when a borrow is liquidated
*/
event LiquidateBorrow(
address indexed liquidator,
address indexed borrower,
uint256 repayAmount,
address indexed vTokenCollateral,
uint256 seizeTokens
);
/*** Admin Events ***/
/**
* @notice Event emitted when comptroller is changed
*/
event NewComptroller(ComptrollerInterface indexed oldComptroller, ComptrollerInterface indexed newComptroller);
/**
* @notice Event emitted when shortfall contract address is changed
*/
event NewShortfallContract(address indexed oldShortfall, address indexed newShortfall);
/**
* @notice Event emitted when protocol share reserve contract address is changed
*/
event NewProtocolShareReserve(address indexed oldProtocolShareReserve, address indexed newProtocolShareReserve);
/**
* @notice Event emitted when interestRateModel is changed
*/
event NewMarketInterestRateModel(
InterestRateModel indexed oldInterestRateModel,
InterestRateModel indexed newInterestRateModel
);
/**
* @notice Event emitted when protocol seize share is changed
*/
event NewProtocolSeizeShare(uint256 oldProtocolSeizeShareMantissa, uint256 newProtocolSeizeShareMantissa);
/**
* @notice Event emitted when the reserve factor is changed
*/
event NewReserveFactor(uint256 oldReserveFactorMantissa, uint256 newReserveFactorMantissa);
/**
* @notice Event emitted when the reserves are added
*/
event ReservesAdded(address indexed benefactor, uint256 addAmount, uint256 newTotalReserves);
/**
* @notice Event emitted when the spread reserves are reduced
*/
event SpreadReservesReduced(address indexed protocolShareReserve, uint256 reduceAmount, uint256 newTotalReserves);
/**
* @notice EIP20 Transfer event
*/
event Transfer(address indexed from, address indexed to, uint256 amount);
/**
* @notice EIP20 Approval event
*/
event Approval(address indexed owner, address indexed spender, uint256 amount);
/**
* @notice Event emitted when healing the borrow
*/
event HealBorrow(address indexed payer, address indexed borrower, uint256 repayAmount);
/**
* @notice Event emitted when tokens are swept
*/
event SweepToken(address indexed token);
/**
* @notice Event emitted when reduce reserves slot (block or second) delta is changed
*/
event NewReduceReservesBlockDelta(
uint256 oldReduceReservesBlockOrTimestampDelta,
uint256 newReduceReservesBlockOrTimestampDelta
);
/**
* @notice Event emitted when liquidation reserves are reduced
*/
event ProtocolSeize(address indexed from, address indexed to, uint256 amount);
/*** User Interface ***/
function mint(uint256 mintAmount) external virtual returns (uint256);
function mintBehalf(address minter, uint256 mintAllowed) external virtual returns (uint256);
function redeem(uint256 redeemTokens) external virtual returns (uint256);
function redeemBehalf(address redeemer, uint256 redeemTokens) external virtual returns (uint256);
function redeemUnderlying(uint256 redeemAmount) external virtual returns (uint256);
function redeemUnderlyingBehalf(address redeemer, uint256 redeemAmount) external virtual returns (uint256);
function borrow(uint256 borrowAmount) external virtual returns (uint256);
function borrowBehalf(address borrwwer, uint256 borrowAmount) external virtual returns (uint256);
function repayBorrow(uint256 repayAmount) external virtual returns (uint256);
function repayBorrowBehalf(address borrower, uint256 repayAmount) external virtual returns (uint256);
function liquidateBorrow(
address borrower,
uint256 repayAmount,
VTokenInterface vTokenCollateral
) external virtual returns (uint256);
function healBorrow(address payer, address borrower, uint256 repayAmount) external virtual;
function forceLiquidateBorrow(
address liquidator,
address borrower,
uint256 repayAmount,
VTokenInterface vTokenCollateral,
bool skipCloseFactorCheck
) external virtual;
function seize(address liquidator, address borrower, uint256 seizeTokens) external virtual;
function transfer(address dst, uint256 amount) external virtual returns (bool);
function transferFrom(address src, address dst, uint256 amount) external virtual returns (bool);
function accrueInterest() external virtual returns (uint256);
function sweepToken(IERC20Upgradeable token) external virtual;
/*** Admin Functions ***/
function setReserveFactor(uint256 newReserveFactorMantissa) external virtual;
function reduceReserves(uint256 reduceAmount) external virtual;
function exchangeRateCurrent() external virtual returns (uint256);
function borrowBalanceCurrent(address account) external virtual returns (uint256);
function setInterestRateModel(InterestRateModel newInterestRateModel) external virtual;
function addReserves(uint256 addAmount) external virtual;
function totalBorrowsCurrent() external virtual returns (uint256);
function balanceOfUnderlying(address owner) external virtual returns (uint256);
function approve(address spender, uint256 amount) external virtual returns (bool);
function increaseAllowance(address spender, uint256 addedValue) external virtual returns (bool);
function decreaseAllowance(address spender, uint256 subtractedValue) external virtual returns (bool);
function allowance(address owner, address spender) external view virtual returns (uint256);
function balanceOf(address owner) external view virtual returns (uint256);
function getAccountSnapshot(address account) external view virtual returns (uint256, uint256, uint256, uint256);
function borrowRatePerBlock() external view virtual returns (uint256);
function supplyRatePerBlock() external view virtual returns (uint256);
function borrowBalanceStored(address account) external view virtual returns (uint256);
function exchangeRateStored() external view virtual returns (uint256);
function getCash() external view virtual returns (uint256);
/**
* @notice Indicator that this is a VToken contract (for inspection)
* @return Always true
*/
function isVToken() external pure virtual returns (bool) {
return true;
}
}{
"optimizer": {
"enabled": true,
"runs": 200,
"details": {
"yul": true
}
},
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"metadata": {
"useLiteralContent": true
},
"libraries": {}
}Contract ABI
API[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"ERC4626__DepositMoreThanMax","type":"error"},{"inputs":[],"name":"ERC4626__MintMoreThanMax","type":"error"},{"inputs":[],"name":"ERC4626__RedeemMoreThanMax","type":"error"},{"inputs":[],"name":"ERC4626__WithdrawMoreThanMax","type":"error"},{"inputs":[{"internalType":"string","name":"operation","type":"string"}],"name":"ERC4626__ZeroAmount","type":"error"},{"inputs":[{"internalType":"uint256","name":"loopsLimit","type":"uint256"},{"internalType":"uint256","name":"requiredLoops","type":"uint256"}],"name":"MaxLoopsLimitExceeded","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"address","name":"calledContract","type":"address"},{"internalType":"string","name":"methodSignature","type":"string"}],"name":"Unauthorized","type":"error"},{"inputs":[{"internalType":"uint256","name":"errorCode","type":"uint256"}],"name":"VenusERC4626__VenusError","type":"error"},{"inputs":[],"name":"ZeroAddressNotAllowed","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"},{"indexed":true,"internalType":"address","name":"rewardToken","type":"address"}],"name":"ClaimRewards","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":false,"internalType":"uint256","name":"assets","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"shares","type":"uint256"}],"name":"Deposit","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint8","name":"version","type":"uint8"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"oldMaxLoopsLimit","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"newmaxLoopsLimit","type":"uint256"}],"name":"MaxLoopsLimitUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"oldAccessControlManager","type":"address"},{"indexed":false,"internalType":"address","name":"newAccessControlManager","type":"address"}],"name":"NewAccessControlManager","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferStarted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"oldRecipient","type":"address"},{"indexed":true,"internalType":"address","name":"newRecipient","type":"address"}],"name":"RewardRecipientUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":true,"internalType":"address","name":"receiver","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"SweepToken","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"receiver","type":"address"},{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":false,"internalType":"uint256","name":"assets","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"shares","type":"uint256"}],"name":"Withdraw","type":"event"},{"inputs":[],"name":"acceptOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"accessControlManager","outputs":[{"internalType":"contract IAccessControlManagerV8","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"asset","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"claimRewards","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"comptroller","outputs":[{"internalType":"contract IComptroller","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"shares","type":"uint256"}],"name":"convertToAssets","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"assets","type":"uint256"}],"name":"convertToShares","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"subtractedValue","type":"uint256"}],"name":"decreaseAllowance","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"assets","type":"uint256"},{"internalType":"address","name":"receiver","type":"address"}],"name":"deposit","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"addedValue","type":"uint256"}],"name":"increaseAllowance","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"vToken_","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"accessControlManager_","type":"address"},{"internalType":"address","name":"rewardRecipient_","type":"address"},{"internalType":"uint256","name":"loopsLimit_","type":"uint256"},{"internalType":"address","name":"vaultOwner_","type":"address"}],"name":"initialize2","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"maxDeposit","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"maxLoopsLimit","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"maxMint","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"maxRedeem","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"maxWithdraw","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"shares","type":"uint256"},{"internalType":"address","name":"receiver","type":"address"}],"name":"mint","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pendingOwner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"assets","type":"uint256"}],"name":"previewDeposit","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"shares","type":"uint256"}],"name":"previewMint","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"shares","type":"uint256"}],"name":"previewRedeem","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"assets","type":"uint256"}],"name":"previewWithdraw","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"shares","type":"uint256"},{"internalType":"address","name":"receiver","type":"address"},{"internalType":"address","name":"owner","type":"address"}],"name":"redeem","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"rewardRecipient","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"accessControlManager_","type":"address"}],"name":"setAccessControlManager","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"loopsLimit","type":"uint256"}],"name":"setMaxLoopsLimit","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newRecipient","type":"address"}],"name":"setRewardRecipient","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"contract IERC20Upgradeable","name":"token","type":"address"}],"name":"sweepToken","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalAssets","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"vToken","outputs":[{"internalType":"contract VToken","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"assets","type":"uint256"},{"internalType":"address","name":"receiver","type":"address"},{"internalType":"address","name":"owner","type":"address"}],"name":"withdraw","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]Contract Creation Code
6080604052348015600f57600080fd5b506016601a565b60d7565b600054610100900460ff161560855760405162461bcd60e51b815260206004820152602760248201527f496e697469616c697a61626c653a20636f6e747261637420697320696e697469604482015266616c697a696e6760c81b606482015260840160405180910390fd5b60005460ff9081161460d5576000805460ff191660ff9081179091556040519081527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15b565b614402806100e66000396000f3fe608060405234801561001057600080fd5b50600436106102745760003560e01c806380d45a2d11610151578063be26317e116100c3578063d905777e11610087578063d905777e14610546578063dd62ed3e14610559578063e30c39781461056c578063e521136f1461057d578063ef8b30f714610520578063f2fde38b1461059057600080fd5b8063be26317e146104f0578063c4d66de8146104fa578063c63d75b61461050d578063c6e6f59214610520578063ce96cb771461053357600080fd5b8063a457c2d711610115578063a457c2d714610480578063a9059cbb14610493578063b3d7f6b9146104a6578063b460af94146104b9578063b4a0bdf3146104cc578063ba087652146104dd57600080fd5b806380d45a2d1461042d5780638da5cb5b1461044057806394bf804d1461045157806395d89b41146104645780639bb1a99c1461046c57600080fd5b8063372500ab116101ea5780634cdad506116101ae5780634cdad506146102a95780635fe3b567146103cd5780636e553f65146103e157806370a08231146103f4578063715018a61461041d57806379ba50971461042557600080fd5b8063372500ab1461037b57806338d52e0f146103835780633950935114610394578063402d267d146103a757806341e11a5a146103ba57600080fd5b80630e32cb861161023c5780630e32cb86146102f257806317f333401461030757806318160ddd146103335780631be195601461033b57806323b872dd1461034e578063313ce5671461036157600080fd5b806301e1d1141461027957806306fdde031461029457806307a2d13a146102a9578063095ea7b3146102bc5780630a28a477146102df575b600080fd5b6102816105a3565b6040519081526020015b60405180910390f35b61029c6106ac565b60405161028b9190613ab1565b6102816102b7366004613ac4565b61073e565b6102cf6102ca366004613af2565b610751565b604051901515815260200161028b565b6102816102ed366004613ac4565b610769565b610305610300366004613b1e565b610776565b005b6101935461031b906001600160a01b031681565b6040516001600160a01b03909116815260200161028b565b603554610281565b610305610349366004613b1e565b61078a565b6102cf61035c366004613b3b565b610879565b61036961089f565b60405160ff909116815260200161028b565b6103056108c0565b6065546001600160a01b031661031b565b6102cf6103a2366004613af2565b610bbf565b6102816103b5366004613b1e565b610be1565b6103056103c8366004613b7c565b610e15565b6101925461031b906001600160a01b031681565b6102816103ef366004613bcf565b610ee5565b610281610402366004613b1e565b6001600160a01b031660009081526033602052604090205490565b61030561105e565b610305611072565b61030561043b366004613ac4565b6110e9565b6097546001600160a01b031661031b565b61028161045f366004613bcf565b611130565b61029c611281565b6101915461031b906001600160a01b031681565b6102cf61048e366004613af2565b611290565b6102cf6104a1366004613af2565b611316565b6102816104b4366004613ac4565b611324565b6102816104c7366004613bff565b611331565b60fb546001600160a01b031661031b565b6102816104eb366004613bff565b61145e565b61028161012d5481565b610305610508366004613b1e565b6115b9565b61028161051b366004613b1e565b6117b9565b61028161052e366004613ac4565b6117c8565b610281610541366004613b1e565b6117d5565b610281610554366004613b1e565b6119ad565b610281610567366004613c41565b611b8f565b60c9546001600160a01b031661031b565b61030561058b366004613b1e565b611bba565b61030561059e366004613b1e565b611c01565b6000670de0b6b3a764000061019160009054906101000a90046001600160a01b03166001600160a01b031663182df0f56040518163ffffffff1660e01b8152600401602060405180830381865afa158015610602573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106269190613c6f565b610191546040516370a0823160e01b81523060048201526001600160a01b03909116906370a0823190602401602060405180830381865afa15801561066f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106939190613c6f565b61069d9190613c9e565b6106a79190613ccb565b905090565b6060603680546106bb90613ced565b80601f01602080910402602001604051908101604052809291908181526020018280546106e790613ced565b80156107345780601f1061070957610100808354040283529160200191610734565b820191906000526020600020905b81548152906001019060200180831161071757829003601f168201915b5050505050905090565b600061074b826000611c72565b92915050565b60003361075f818585611cb3565b5060019392505050565b600061074b826001611dcf565b61077e611e07565b61078781611e61565b50565b610792611e07565b6040516370a0823160e01b81523060048201526000906001600160a01b038316906370a0823190602401602060405180830381865afa1580156107d9573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107fd9190613c6f565b905080156108755760006108196097546001600160a01b031690565b9050610826838284611f1f565b806001600160a01b0316836001600160a01b03167f6d25be279134f4ecaa4770aff0c3d916d9e7c5ef37b65ed95dbdba411f5d54d58460405161086b91815260200190565b60405180910390a3505b5050565b600033610887858285611f87565b610892858585612001565b60019150505b9392505050565b60006108a96121ac565b6065546106a79190600160a01b900460ff16613d27565b610192546101915461019354604080516361252fd160e01b815290516001600160a01b0394851694938416939092169160009185916361252fd19160048082019286929091908290030181865afa15801561091f573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526109479190810190613d87565b9050610953815161222c565b60005b8151811015610bb857600082828151811061097357610973613e39565b602002602001015190506000816001600160a01b031663f7c618c16040518163ffffffff1660e01b8152600401602060405180830381865afa1580156109bd573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109e19190613e4f565b60408051600180825281830190925291925060009190602080830190803683370190505090508681600081518110610a1b57610a1b613e39565b6001600160a01b039283166020918202929092010152604051624caeb160e41b8152908416906304caeb1090610a579030908590600401613e6c565b600060405180830381600087803b158015610a7157600080fd5b505af1158015610a85573d6000803e3d6000fd5b50506040516370a0823160e01b8152306004820152600092506001600160a01b03851691506370a0823190602401602060405180830381865afa158015610ad0573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610af49190613c6f565b90508015610b6557610b07838883611f1f565b6040516305bebb3b60e21b81526001600160a01b038816906316faecec90610b38908c908790600290600401613ede565b600060405180830381600087803b158015610b5257600080fd5b505af1925050508015610b63575060015b505b826001600160a01b03167fba56c3ab1f752776eef60db959a4e6b643e89595315edbbd945e104623fa03ba82604051610ba091815260200190565b60405180910390a25050600190920191506109569050565b5050505050565b60003361075f818585610bd28383611b8f565b610bdc9190613f14565b611cb3565b6101925461019154604051630742d14b60e51b81526000926001600160a01b039081169263e85a296092610c1d92909116908590600401613f27565b602060405180830381865afa158015610c3a573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c5e9190613f54565b15610c6b57506000919050565b61019254610191546040516302c3bcbb60e01b81526001600160a01b03918216600482015260009291909116906302c3bcbb90602401602060405180830381865afa158015610cbe573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ce29190613c6f565b90506000670de0b6b3a764000061019160009054906101000a90046001600160a01b03166001600160a01b031663182df0f56040518163ffffffff1660e01b8152600401602060405180830381865afa158015610d43573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d679190613c6f565b61019160009054906101000a90046001600160a01b03166001600160a01b03166318160ddd6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610dbb573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ddf9190613c6f565b610de99190613c9e565b610df39190613ccb565b9050808211610e03576000610e0d565b610e0d8183613f76565b949350505050565b600054600290610100900460ff16158015610e37575060005460ff8083169116105b610e5c5760405162461bcd60e51b8152600401610e5390613f89565b60405180910390fd5b6000805461ffff191660ff831617610100179055610e798261225f565b610e8285612286565b610e8b836122be565b610e948461235a565b610e9d826123c1565b6000805461ff001916905560405160ff821681527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15050505050565b6000610eef6123da565b610ef88261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af1158015610f4e573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610f729190613c6f565b5082600003610fae576040516304dd32c560e11b815260206004820152600760248201526619195c1bdcda5d60ca1b6044820152606401610e53565b610fb782610be1565b831115610fd7576040516326ac6ee160e01b815260040160405180910390fd5b6000610fe2846117c8565b90508060000361101f576040516304dd32c560e11b815260206004820152600760248201526619195c1bdcda5d60ca1b6044820152606401610e53565b600061102a60355490565b905061103833858785612435565b60008161104460355490565b61104e9190613f76565b935050505061074b600161015f55565b611066611e07565b61107060006123c1565b565b60c95433906001600160a01b031681146110e05760405162461bcd60e51b815260206004820152602960248201527f4f776e61626c6532537465703a2063616c6c6572206973206e6f7420746865206044820152683732bb9037bbb732b960b91b6064820152608401610e53565b610787816123c1565b6111276040518060400160405280601981526020017f7365744d61784c6f6f70734c696d69742875696e743235362900000000000000815250612804565b610787816122be565b600061113a6123da565b6111438261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af1158015611199573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906111bd9190613c6f565b50826000036111f8576040516304dd32c560e11b8152600401610e53906020808252600490820152631b5a5b9d60e21b604082015260600190565b611201826117b9565b831115611221576040516340868f7960e01b815260040160405180910390fd5b600061122c84611324565b905080600003611268576040516304dd32c560e11b8152600401610e53906020808252600490820152631b5a5b9d60e21b604082015260600190565b61127433848387612435565b905061074b600161015f55565b6060603780546106bb90613ced565b6000338161129e8286611b8f565b9050838110156112fe5760405162461bcd60e51b815260206004820152602560248201527f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77604482015264207a65726f60d81b6064820152608401610e53565b61130b8286868403611cb3565b506001949350505050565b60003361075f818585612001565b600061074b826001611c72565b600061133b6123da565b6113448361225f565b61134d8261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af11580156113a3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906113c79190613c6f565b5083600003611404576040516304dd32c560e11b8152602060048201526008602482015267776974686472617760c01b6044820152606401610e53565b61140d826117d5565b84111561142d5760405163e9ed951560e01b815260040160405180910390fd5b6000806114398661289e565b915091506114506114473390565b86868585612bad565b915050610898600161015f55565b60006114686123da565b6114718361225f565b61147a8261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af11580156114d0573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906114f49190613c6f565b508360000361152f576040516304dd32c560e11b815260206004820152600660248201526572656465656d60d01b6044820152606401610e53565b611538826119ad565b84111561155857604051638890247960e01b815260040160405180910390fd5b600061156385612c59565b90508060000361159f576040516304dd32c560e11b815260206004820152600660248201526572656465656d60d01b6044820152606401610e53565b6115ac3385858489612bad565b9050610898600161015f55565b600054610100900460ff16158080156115d95750600054600160ff909116105b806115f35750303b1580156115f3575060005460ff166001145b61160f5760405162461bcd60e51b8152600401610e5390613f89565b6000805460ff191660011790558015611632576000805461ff0019166101001790555b61163b8261225f565b61019180546001600160a01b0319166001600160a01b03841690811790915560408051635fe3b56760e01b81529051635fe3b567916004808201926020929091908290030181865afa158015611695573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116b99190613e4f565b61019280546001600160a01b0319166001600160a01b039283161790556101915460408051636f307dc360e01b815290516000939290921691636f307dc3916004808201926020929091908290030181865afa15801561171d573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906117419190613e4f565b905061175d61174f82612e8c565b61175883612f1a565b612f92565b61176681612fc3565b61176e612ff3565b508015610875576000805461ff0019169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb3847402498906020015b60405180910390a15050565b600061074b61052e6000610be1565b600061074b826000611dcf565b6101925461019154604051630742d14b60e51b81526000926001600160a01b039081169263e85a2960926118129290911690600190600401613f27565b602060405180830381865afa15801561182f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906118539190613f54565b1561186057506000919050565b6101915460408051631d8e90d160e11b815290516000926001600160a01b031691633b1d21a29160048083019260209291908290030181865afa1580156118ab573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906118cf9190613c6f565b9050600061019160009054906101000a90046001600160a01b03166001600160a01b0316638f840ddd6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611927573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061194b9190613c6f565b905060006119716102b7866001600160a01b031660009081526033602052604090205490565b90508183101561198657506000949350505050565b60006119928385613f76565b90508181106119a157816119a3565b805b9695505050505050565b6101925461019154604051630742d14b60e51b81526000926001600160a01b039081169263e85a2960926119ea9290911690600190600401613f27565b602060405180830381865afa158015611a07573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611a2b9190613f54565b15611a3857506000919050565b6101915460408051631d8e90d160e11b815290516000926001600160a01b031691633b1d21a29160048083019260209291908290030181865afa158015611a83573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611aa79190613c6f565b9050600061019160009054906101000a90046001600160a01b03166001600160a01b0316638f840ddd6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611aff573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611b239190613c6f565b905080821015611b37575060009392505050565b6000611b438284613f76565b90506000611b50826117c8565b90506000611b73876001600160a01b031660009081526033602052604090205490565b9050808210611b825780611b84565b815b979650505050505050565b6001600160a01b03918216600090815260346020908152604080832093909416825291909152205490565b611bf86040518060400160405280601b81526020017f736574526577617264526563697069656e742861646472657373290000000000815250612804565b6107878161235a565b611c09611e07565b60c980546001600160a01b0383166001600160a01b03199091168117909155611c3a6097546001600160a01b031690565b6001600160a01b03167f38d16b8cac22d99fc7c124b9cd0de2d3fa1faef420bfe791d8c362d765e2270060405160405180910390a350565b6000610898611c7f6105a3565b611c8a906001613f14565b611c926121ac565b611c9d90600a6140bb565b603554611caa9190613f14565b85919085613022565b6001600160a01b038316611d155760405162461bcd60e51b8152602060048201526024808201527f45524332303a20617070726f76652066726f6d20746865207a65726f206164646044820152637265737360e01b6064820152608401610e53565b6001600160a01b038216611d765760405162461bcd60e51b815260206004820152602260248201527f45524332303a20617070726f766520746f20746865207a65726f206164647265604482015261737360f01b6064820152608401610e53565b6001600160a01b0383811660008181526034602090815260408083209487168084529482529182902085905590518481527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910161086b565b6000610898611ddc6121ac565b611de790600a6140bb565b603554611df49190613f14565b611dfc6105a3565b611caa906001613f14565b6097546001600160a01b031633146110705760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401610e53565b6001600160a01b038116611ec55760405162461bcd60e51b815260206004820152602560248201527f696e76616c696420616365737320636f6e74726f6c206d616e61676572206164604482015264647265737360d81b6064820152608401610e53565b60fb80546001600160a01b038381166001600160a01b031983168117909355604080519190921680825260208201939093527f66fd58e82f7b31a2a5c30e0888f3093efe4e111b00cd2b0c31fe014601293aa091016117ad565b6040516001600160a01b038316602482015260448101829052611f8290849063a9059cbb60e01b906064015b60408051601f198184030181529190526020810180516001600160e01b03166001600160e01b03199093169290921790915261307f565b505050565b6000611f938484611b8f565b90506000198114611ffb5781811015611fee5760405162461bcd60e51b815260206004820152601d60248201527f45524332303a20696e73756666696369656e7420616c6c6f77616e63650000006044820152606401610e53565b611ffb8484848403611cb3565b50505050565b6001600160a01b0383166120655760405162461bcd60e51b815260206004820152602560248201527f45524332303a207472616e736665722066726f6d20746865207a65726f206164604482015264647265737360d81b6064820152608401610e53565b6001600160a01b0382166120c75760405162461bcd60e51b815260206004820152602360248201527f45524332303a207472616e7366657220746f20746865207a65726f206164647260448201526265737360e81b6064820152608401610e53565b6001600160a01b0383166000908152603360205260409020548181101561213f5760405162461bcd60e51b815260206004820152602660248201527f45524332303a207472616e7366657220616d6f756e7420657863656564732062604482015265616c616e636560d01b6064820152608401610e53565b6001600160a01b0380851660008181526033602052604080822086860390559286168082529083902080548601905591517fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9061219f9086815260200190565b60405180910390a3611ffb565b60006121c06065546001600160a01b031690565b6001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa1580156121fd573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061222191906140ca565b6106a79060126140ed565b61012d548111156107875761012d5460405163792bfb1b60e11b8152600481019190915260248101829052604401610e53565b6001600160a01b038116610787576040516342bcdf7f60e11b815260040160405180910390fd5b600054610100900460ff166122ad5760405162461bcd60e51b8152600401610e5390614106565b6122b5613154565b61078781613183565b61012d54811161231b5760405162461bcd60e51b815260206004820152602260248201527f436f6d7074726f6c6c65723a20496e76616c6964206d61784c6f6f70734c696d6044820152611a5d60f21b6064820152608401610e53565b61012d80549082905560408051828152602081018490527fc2d09fef144f7c8a86f71ea459f8fc17f675768eb1ae369cbd77fb31d467aafa91016117ad565b6123638161225f565b610193546040516001600160a01b038084169216907fc8c11bb97ac2ffa10ce2e2a98f4c1fd8df84cfa2e1a15e013ed2383ab1f527ad90600090a361019380546001600160a01b0319166001600160a01b0392909216919091179055565b60c980546001600160a01b0319169055610787816131aa565b600261015f540361242d5760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c006044820152606401610e53565b600261015f55565b60006124496065546001600160a01b031690565b6040516370a0823160e01b81523060048201526001600160a01b0391909116906370a0823190602401602060405180830381865afa15801561248f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906124b39190613c6f565b610191546040516370a0823160e01b81523060048201529192506000916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612502573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906125269190613c6f565b905061254561253d6065546001600160a01b031690565b8730876131fc565b60008261255a6065546001600160a01b031690565b6040516370a0823160e01b81523060048201526001600160a01b0391909116906370a0823190602401602060405180830381865afa1580156125a0573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906125c49190613c6f565b6125ce9190613f76565b90506125d981613234565b610191546040516370a0823160e01b815230600482015260009184916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612627573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061264b9190613c6f565b6126559190613f76565b9050806000036126a8576040516304dd32c560e11b815260206004820152601b60248201527f76546f6b656e735265636569766564206174205f6465706f73697400000000006044820152606401610e53565b6000670de0b6b3a764000061019160009054906101000a90046001600160a01b03166001600160a01b031663182df0f56040518163ffffffff1660e01b8152600401602060405180830381865afa158015612707573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061272b9190613c6f565b6127359084613c9e565b61273f9190613ccb565b9050600061278e61274e6121ac565b61275990600a6140bb565b6035546127669190613f14565b8361276f6105a3565b61277a906001613f14565b6127849190613f76565b8491906000613022565b905061279a89826132fd565b886001600160a01b03168a6001600160a01b03167fdcbc1c05240f31ff3ad067ef1ee35ce4997762752e3a095284754544f4c709d78a846040516127e8929190918252602082015260400190565b60405180910390a350505050505050505050565b600161015f55565b60fb546040516318c5e8ab60e01b81526000916001600160a01b0316906318c5e8ab906128379033908690600401614151565b602060405180830381865afa158015612854573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906128789190613f54565b90508061087557333083604051634a3fa29360e01b8152600401610e5393929190614175565b60008060006128b56065546001600160a01b031690565b6040516370a0823160e01b81523060048201529091506000906001600160a01b038316906370a0823190602401602060405180830381865afa1580156128ff573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906129239190613c6f565b610191546040516370a0823160e01b81523060048201529192506000916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612972573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906129969190613c6f565b6101915460405163852a12e360e01b8152600481018990529192506000916001600160a01b039091169063852a12e3906024016020604051808303816000875af11580156129e8573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612a0c9190613c6f565b90508015612a3057604051630864657760e21b815260048101829052602401610e53565b6040516370a0823160e01b815230600482015283906001600160a01b038616906370a0823190602401602060405180830381865afa158015612a76573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612a9a9190613c6f565b612aa49190613f76565b610191546040516370a0823160e01b81523060048201529197506000916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612af3573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612b179190613c6f565b612b219084613f76565b905080600003612b74576040516304dd32c560e11b815260206004820181905260248201527f61637475616c56546f6b656e73206174205f6265666f726557697468647261776044820152606401610e53565b612ba1612b7f6121ac565b612b8a90600a6140bb565b603554612b979190613f14565b8290856001613022565b95505050505050915091565b826001600160a01b0316856001600160a01b031614612bd157612bd1838683611f87565b612bdb83826133be565b606554612bf2906001600160a01b03168584611f1f565b826001600160a01b0316846001600160a01b0316866001600160a01b03167ffbde797d201c681b91056529119e0b02407c7bb96a4a2c75c01fc9667232c8db8585604051612c4a929190918252602082015260400190565b60405180910390a45050505050565b600080612c6e6065546001600160a01b031690565b6040516370a0823160e01b81523060048201529091506000906001600160a01b038316906370a0823190602401602060405180830381865afa158015612cb8573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612cdc9190613c6f565b610191546040516370a0823160e01b8152306004820152919250600091612d7b916001600160a01b0316906370a0823190602401602060405180830381865afa158015612d2d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612d519190613c6f565b612d596121ac565b612d6490600a6140bb565b603554612d719190613f14565b8791906000613022565b6101915460405163db006a7560e01b8152600481018390529192506000916001600160a01b039091169063db006a75906024016020604051808303816000875af1158015612dcd573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612df19190613c6f565b90508015612e1557604051630864657760e21b815260048101829052602401610e53565b6040516370a0823160e01b81523060048201526000906001600160a01b038616906370a0823190602401602060405180830381865afa158015612e5c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612e809190613c6f565b9050611b848482613f76565b6060816001600160a01b03166306fdde036040518163ffffffff1660e01b8152600401600060405180830381865afa158015612ecc573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052612ef491908101906141a1565b604051602001612f049190614235565b6040516020818303038152906040529050919050565b6060816001600160a01b03166395d89b416040518163ffffffff1660e01b8152600401600060405180830381865afa158015612f5a573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052612f8291908101906141a1565b604051602001612f049190614273565b600054610100900460ff16612fb95760405162461bcd60e51b8152600401610e5390614106565b61087582826134f2565b600054610100900460ff16612fea5760405162461bcd60e51b8152600401610e5390614106565b61078781613532565b600054610100900460ff1661301a5760405162461bcd60e51b8152600401610e5390614106565b6110706135b7565b6000806130308686866135de565b9050600183600281111561304657613046613ec8565b14801561306357506000848061305e5761305e613cb5565b868809115b1561307657613073600182613f14565b90505b95945050505050565b60006130d4826040518060400160405280602081526020017f5361666545524332303a206c6f772d6c6576656c2063616c6c206661696c6564815250856001600160a01b03166136c89092919063ffffffff16565b90508051600014806130f55750808060200190518101906130f59190613f54565b611f825760405162461bcd60e51b815260206004820152602a60248201527f5361666545524332303a204552433230206f7065726174696f6e20646964206e6044820152691bdd081cdd58d8d9595960b21b6064820152608401610e53565b600054610100900460ff1661317b5760405162461bcd60e51b8152600401610e5390614106565b6110706136d7565b600054610100900460ff1661077e5760405162461bcd60e51b8152600401610e5390614106565b609780546001600160a01b038381166001600160a01b0319831681179093556040519116919082907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e090600090a35050565b6040516001600160a01b0380851660248301528316604482015260648101829052611ffb9085906323b872dd60e01b90608401611f4b565b61019154613268906001600160a01b0316826132586065546001600160a01b031690565b6001600160a01b03169190613707565b6101915460405163140e25ad60e31b8152600481018390526000916001600160a01b03169063a0712d68906024016020604051808303816000875af11580156132b5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906132d99190613c6f565b9050801561087557604051630864657760e21b815260048101829052602401610e53565b6001600160a01b0382166133535760405162461bcd60e51b815260206004820152601f60248201527f45524332303a206d696e7420746f20746865207a65726f2061646472657373006044820152606401610e53565b80603560008282546133659190613f14565b90915550506001600160a01b0382166000818152603360209081526040808320805486019055518481527fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef910160405180910390a35050565b6001600160a01b03821661341e5760405162461bcd60e51b815260206004820152602160248201527f45524332303a206275726e2066726f6d20746865207a65726f206164647265736044820152607360f81b6064820152608401610e53565b6001600160a01b038216600090815260336020526040902054818110156134925760405162461bcd60e51b815260206004820152602260248201527f45524332303a206275726e20616d6f756e7420657863656564732062616c616e604482015261636560f01b6064820152608401610e53565b6001600160a01b03831660008181526033602090815260408083208686039055603580548790039055518581529192917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef910160405180910390a3505050565b600054610100900460ff166135195760405162461bcd60e51b8152600401610e5390614106565b603661352583826142f0565b506037611f8282826142f0565b600054610100900460ff166135595760405162461bcd60e51b8152600401610e5390614106565b6000806135658361381c565b9150915081613575576012613577565b805b606580546001600160a01b039095166001600160a01b031960ff93909316600160a01b02929092166001600160a81b031990951694909417179092555050565b600054610100900460ff166127fc5760405162461bcd60e51b8152600401610e5390614106565b60008080600019858709858702925082811083820303915050806000036136185783828161360e5761360e613cb5565b0492505050610898565b80841161365f5760405162461bcd60e51b81526020600482015260156024820152744d6174683a206d756c446976206f766572666c6f7760581b6044820152606401610e53565b60008486880960026001871981018816978890046003810283188082028403028082028403028082028403028082028403028082028403029081029092039091026000889003889004909101858311909403939093029303949094049190911702949350505050565b6060610e0d84846000856138f8565b600054610100900460ff166136fe5760405162461bcd60e51b8152600401610e5390614106565b611070336123c1565b8015806137815750604051636eb1769f60e11b81523060048201526001600160a01b03838116602483015284169063dd62ed3e90604401602060405180830381865afa15801561375b573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061377f9190613c6f565b155b6137ec5760405162461bcd60e51b815260206004820152603660248201527f5361666545524332303a20617070726f76652066726f6d206e6f6e2d7a65726f60448201527520746f206e6f6e2d7a65726f20616c6c6f77616e636560501b6064820152608401610e53565b6040516001600160a01b038316602482015260448101829052611f8290849063095ea7b360e01b90606401611f4b565b60408051600481526024810182526020810180516001600160e01b031663313ce56760e01b17905290516000918291829182916001600160a01b03871691613863916143b0565b600060405180830381855afa9150503d806000811461389e576040519150601f19603f3d011682016040523d82523d6000602084013e6138a3565b606091505b50915091508180156138b757506020815110155b156138eb576000818060200190518101906138d29190613c6f565b905060ff81116138e9576001969095509350505050565b505b5060009485945092505050565b6060824710156139595760405162461bcd60e51b815260206004820152602660248201527f416464726573733a20696e73756666696369656e742062616c616e636520666f6044820152651c8818d85b1b60d21b6064820152608401610e53565b600080866001600160a01b0316858760405161397591906143b0565b60006040518083038185875af1925050503d80600081146139b2576040519150601f19603f3d011682016040523d82523d6000602084013e6139b7565b606091505b5091509150611b848783838760608315613a32578251600003613a2b576001600160a01b0385163b613a2b5760405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606401610e53565b5081610e0d565b610e0d8383815115613a475781518083602001fd5b8060405162461bcd60e51b8152600401610e539190613ab1565b60005b83811015613a7c578181015183820152602001613a64565b50506000910152565b60008151808452613a9d816020860160208601613a61565b601f01601f19169290920160200192915050565b6020815260006108986020830184613a85565b600060208284031215613ad657600080fd5b5035919050565b6001600160a01b038116811461078757600080fd5b60008060408385031215613b0557600080fd5b8235613b1081613add565b946020939093013593505050565b600060208284031215613b3057600080fd5b813561089881613add565b600080600060608486031215613b5057600080fd5b8335613b5b81613add565b92506020840135613b6b81613add565b929592945050506040919091013590565b60008060008060808587031215613b9257600080fd5b8435613b9d81613add565b93506020850135613bad81613add565b9250604085013591506060850135613bc481613add565b939692955090935050565b60008060408385031215613be257600080fd5b823591506020830135613bf481613add565b809150509250929050565b600080600060608486031215613c1457600080fd5b833592506020840135613c2681613add565b91506040840135613c3681613add565b809150509250925092565b60008060408385031215613c5457600080fd5b8235613c5f81613add565b91506020830135613bf481613add565b600060208284031215613c8157600080fd5b5051919050565b634e487b7160e01b600052601160045260246000fd5b808202811582820484141761074b5761074b613c88565b634e487b7160e01b600052601260045260246000fd5b600082613ce857634e487b7160e01b600052601260045260246000fd5b500490565b600181811c90821680613d0157607f821691505b602082108103613d2157634e487b7160e01b600052602260045260246000fd5b50919050565b60ff818116838216019081111561074b5761074b613c88565b634e487b7160e01b600052604160045260246000fd5b604051601f8201601f1916810167ffffffffffffffff81118282101715613d7f57613d7f613d40565b604052919050565b60006020808385031215613d9a57600080fd5b825167ffffffffffffffff80821115613db257600080fd5b818501915085601f830112613dc657600080fd5b815181811115613dd857613dd8613d40565b8060051b9150613de9848301613d56565b8181529183018401918481019088841115613e0357600080fd5b938501935b83851015613e2d5784519250613e1d83613add565b8282529385019390850190613e08565b98975050505050505050565b634e487b7160e01b600052603260045260246000fd5b600060208284031215613e6157600080fd5b815161089881613add565b6001600160a01b038381168252604060208084018290528451918401829052600092858201929091906060860190855b81811015613eba578551851683529483019491830191600101613e9c565b509098975050505050505050565b634e487b7160e01b600052602160045260246000fd5b6001600160a01b038481168252831660208201526060810160048310613f0657613f06613ec8565b826040830152949350505050565b8082018082111561074b5761074b613c88565b6001600160a01b03831681526040810160098310613f4757613f47613ec8565b8260208301529392505050565b600060208284031215613f6657600080fd5b8151801515811461089857600080fd5b8181038181111561074b5761074b613c88565b6020808252602e908201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160408201526d191e481a5b9a5d1a585b1a5e995960921b606082015260800190565b600181815b80851115614012578160001904821115613ff857613ff8613c88565b8085161561400557918102915b93841c9390800290613fdc565b509250929050565b6000826140295750600161074b565b816140365750600061074b565b816001811461404c576002811461405657614072565b600191505061074b565b60ff84111561406757614067613c88565b50506001821b61074b565b5060208310610133831016604e8410600b8410161715614095575081810a61074b565b61409f8383613fd7565b80600019048211156140b3576140b3613c88565b029392505050565b600061089860ff84168361401a565b6000602082840312156140dc57600080fd5b815160ff8116811461089857600080fd5b60ff828116828216039081111561074b5761074b613c88565b6020808252602b908201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960408201526a6e697469616c697a696e6760a81b606082015260800190565b6001600160a01b0383168152604060208201819052600090610e0d90830184613a85565b6001600160a01b0384811682528316602082015260606040820181905260009061307690830184613a85565b6000602082840312156141b357600080fd5b815167ffffffffffffffff808211156141cb57600080fd5b818401915084601f8301126141df57600080fd5b8151818111156141f1576141f1613d40565b614204601f8201601f1916602001613d56565b915080825285602082850101111561421b57600080fd5b61422c816020840160208601613a61565b50949350505050565b75022a9219a1b191b16abb930b83832b2102b32b73ab9960551b815260008251614266816016850160208701613a61565b9190910160160192915050565b643b1a1b191b60d91b815260008251614293816005850160208701613a61565b9190910160050192915050565b601f821115611f82576000816000526020600020601f850160051c810160208610156142c95750805b601f850160051c820191505b818110156142e8578281556001016142d5565b505050505050565b815167ffffffffffffffff81111561430a5761430a613d40565b61431e816143188454613ced565b846142a0565b602080601f831160018114614353576000841561433b5750858301515b600019600386901b1c1916600185901b1785556142e8565b600085815260208120601f198616915b8281101561438257888601518255948401946001909101908401614363565b50858210156143a05787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b600082516143c2818460208701613a61565b919091019291505056fea26469706673582212205ac92a1a47ea36429a0bb96c49ac2f3a4d2e5c42f69e2fb71d0ac58f5c2790d064736f6c63430008190033
Deployed Bytecode
0x608060405234801561001057600080fd5b50600436106102745760003560e01c806380d45a2d11610151578063be26317e116100c3578063d905777e11610087578063d905777e14610546578063dd62ed3e14610559578063e30c39781461056c578063e521136f1461057d578063ef8b30f714610520578063f2fde38b1461059057600080fd5b8063be26317e146104f0578063c4d66de8146104fa578063c63d75b61461050d578063c6e6f59214610520578063ce96cb771461053357600080fd5b8063a457c2d711610115578063a457c2d714610480578063a9059cbb14610493578063b3d7f6b9146104a6578063b460af94146104b9578063b4a0bdf3146104cc578063ba087652146104dd57600080fd5b806380d45a2d1461042d5780638da5cb5b1461044057806394bf804d1461045157806395d89b41146104645780639bb1a99c1461046c57600080fd5b8063372500ab116101ea5780634cdad506116101ae5780634cdad506146102a95780635fe3b567146103cd5780636e553f65146103e157806370a08231146103f4578063715018a61461041d57806379ba50971461042557600080fd5b8063372500ab1461037b57806338d52e0f146103835780633950935114610394578063402d267d146103a757806341e11a5a146103ba57600080fd5b80630e32cb861161023c5780630e32cb86146102f257806317f333401461030757806318160ddd146103335780631be195601461033b57806323b872dd1461034e578063313ce5671461036157600080fd5b806301e1d1141461027957806306fdde031461029457806307a2d13a146102a9578063095ea7b3146102bc5780630a28a477146102df575b600080fd5b6102816105a3565b6040519081526020015b60405180910390f35b61029c6106ac565b60405161028b9190613ab1565b6102816102b7366004613ac4565b61073e565b6102cf6102ca366004613af2565b610751565b604051901515815260200161028b565b6102816102ed366004613ac4565b610769565b610305610300366004613b1e565b610776565b005b6101935461031b906001600160a01b031681565b6040516001600160a01b03909116815260200161028b565b603554610281565b610305610349366004613b1e565b61078a565b6102cf61035c366004613b3b565b610879565b61036961089f565b60405160ff909116815260200161028b565b6103056108c0565b6065546001600160a01b031661031b565b6102cf6103a2366004613af2565b610bbf565b6102816103b5366004613b1e565b610be1565b6103056103c8366004613b7c565b610e15565b6101925461031b906001600160a01b031681565b6102816103ef366004613bcf565b610ee5565b610281610402366004613b1e565b6001600160a01b031660009081526033602052604090205490565b61030561105e565b610305611072565b61030561043b366004613ac4565b6110e9565b6097546001600160a01b031661031b565b61028161045f366004613bcf565b611130565b61029c611281565b6101915461031b906001600160a01b031681565b6102cf61048e366004613af2565b611290565b6102cf6104a1366004613af2565b611316565b6102816104b4366004613ac4565b611324565b6102816104c7366004613bff565b611331565b60fb546001600160a01b031661031b565b6102816104eb366004613bff565b61145e565b61028161012d5481565b610305610508366004613b1e565b6115b9565b61028161051b366004613b1e565b6117b9565b61028161052e366004613ac4565b6117c8565b610281610541366004613b1e565b6117d5565b610281610554366004613b1e565b6119ad565b610281610567366004613c41565b611b8f565b60c9546001600160a01b031661031b565b61030561058b366004613b1e565b611bba565b61030561059e366004613b1e565b611c01565b6000670de0b6b3a764000061019160009054906101000a90046001600160a01b03166001600160a01b031663182df0f56040518163ffffffff1660e01b8152600401602060405180830381865afa158015610602573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106269190613c6f565b610191546040516370a0823160e01b81523060048201526001600160a01b03909116906370a0823190602401602060405180830381865afa15801561066f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106939190613c6f565b61069d9190613c9e565b6106a79190613ccb565b905090565b6060603680546106bb90613ced565b80601f01602080910402602001604051908101604052809291908181526020018280546106e790613ced565b80156107345780601f1061070957610100808354040283529160200191610734565b820191906000526020600020905b81548152906001019060200180831161071757829003601f168201915b5050505050905090565b600061074b826000611c72565b92915050565b60003361075f818585611cb3565b5060019392505050565b600061074b826001611dcf565b61077e611e07565b61078781611e61565b50565b610792611e07565b6040516370a0823160e01b81523060048201526000906001600160a01b038316906370a0823190602401602060405180830381865afa1580156107d9573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107fd9190613c6f565b905080156108755760006108196097546001600160a01b031690565b9050610826838284611f1f565b806001600160a01b0316836001600160a01b03167f6d25be279134f4ecaa4770aff0c3d916d9e7c5ef37b65ed95dbdba411f5d54d58460405161086b91815260200190565b60405180910390a3505b5050565b600033610887858285611f87565b610892858585612001565b60019150505b9392505050565b60006108a96121ac565b6065546106a79190600160a01b900460ff16613d27565b610192546101915461019354604080516361252fd160e01b815290516001600160a01b0394851694938416939092169160009185916361252fd19160048082019286929091908290030181865afa15801561091f573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526109479190810190613d87565b9050610953815161222c565b60005b8151811015610bb857600082828151811061097357610973613e39565b602002602001015190506000816001600160a01b031663f7c618c16040518163ffffffff1660e01b8152600401602060405180830381865afa1580156109bd573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109e19190613e4f565b60408051600180825281830190925291925060009190602080830190803683370190505090508681600081518110610a1b57610a1b613e39565b6001600160a01b039283166020918202929092010152604051624caeb160e41b8152908416906304caeb1090610a579030908590600401613e6c565b600060405180830381600087803b158015610a7157600080fd5b505af1158015610a85573d6000803e3d6000fd5b50506040516370a0823160e01b8152306004820152600092506001600160a01b03851691506370a0823190602401602060405180830381865afa158015610ad0573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610af49190613c6f565b90508015610b6557610b07838883611f1f565b6040516305bebb3b60e21b81526001600160a01b038816906316faecec90610b38908c908790600290600401613ede565b600060405180830381600087803b158015610b5257600080fd5b505af1925050508015610b63575060015b505b826001600160a01b03167fba56c3ab1f752776eef60db959a4e6b643e89595315edbbd945e104623fa03ba82604051610ba091815260200190565b60405180910390a25050600190920191506109569050565b5050505050565b60003361075f818585610bd28383611b8f565b610bdc9190613f14565b611cb3565b6101925461019154604051630742d14b60e51b81526000926001600160a01b039081169263e85a296092610c1d92909116908590600401613f27565b602060405180830381865afa158015610c3a573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c5e9190613f54565b15610c6b57506000919050565b61019254610191546040516302c3bcbb60e01b81526001600160a01b03918216600482015260009291909116906302c3bcbb90602401602060405180830381865afa158015610cbe573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ce29190613c6f565b90506000670de0b6b3a764000061019160009054906101000a90046001600160a01b03166001600160a01b031663182df0f56040518163ffffffff1660e01b8152600401602060405180830381865afa158015610d43573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d679190613c6f565b61019160009054906101000a90046001600160a01b03166001600160a01b03166318160ddd6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610dbb573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ddf9190613c6f565b610de99190613c9e565b610df39190613ccb565b9050808211610e03576000610e0d565b610e0d8183613f76565b949350505050565b600054600290610100900460ff16158015610e37575060005460ff8083169116105b610e5c5760405162461bcd60e51b8152600401610e5390613f89565b60405180910390fd5b6000805461ffff191660ff831617610100179055610e798261225f565b610e8285612286565b610e8b836122be565b610e948461235a565b610e9d826123c1565b6000805461ff001916905560405160ff821681527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15050505050565b6000610eef6123da565b610ef88261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af1158015610f4e573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610f729190613c6f565b5082600003610fae576040516304dd32c560e11b815260206004820152600760248201526619195c1bdcda5d60ca1b6044820152606401610e53565b610fb782610be1565b831115610fd7576040516326ac6ee160e01b815260040160405180910390fd5b6000610fe2846117c8565b90508060000361101f576040516304dd32c560e11b815260206004820152600760248201526619195c1bdcda5d60ca1b6044820152606401610e53565b600061102a60355490565b905061103833858785612435565b60008161104460355490565b61104e9190613f76565b935050505061074b600161015f55565b611066611e07565b61107060006123c1565b565b60c95433906001600160a01b031681146110e05760405162461bcd60e51b815260206004820152602960248201527f4f776e61626c6532537465703a2063616c6c6572206973206e6f7420746865206044820152683732bb9037bbb732b960b91b6064820152608401610e53565b610787816123c1565b6111276040518060400160405280601981526020017f7365744d61784c6f6f70734c696d69742875696e743235362900000000000000815250612804565b610787816122be565b600061113a6123da565b6111438261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af1158015611199573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906111bd9190613c6f565b50826000036111f8576040516304dd32c560e11b8152600401610e53906020808252600490820152631b5a5b9d60e21b604082015260600190565b611201826117b9565b831115611221576040516340868f7960e01b815260040160405180910390fd5b600061122c84611324565b905080600003611268576040516304dd32c560e11b8152600401610e53906020808252600490820152631b5a5b9d60e21b604082015260600190565b61127433848387612435565b905061074b600161015f55565b6060603780546106bb90613ced565b6000338161129e8286611b8f565b9050838110156112fe5760405162461bcd60e51b815260206004820152602560248201527f45524332303a2064656372656173656420616c6c6f77616e63652062656c6f77604482015264207a65726f60d81b6064820152608401610e53565b61130b8286868403611cb3565b506001949350505050565b60003361075f818585612001565b600061074b826001611c72565b600061133b6123da565b6113448361225f565b61134d8261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af11580156113a3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906113c79190613c6f565b5083600003611404576040516304dd32c560e11b8152602060048201526008602482015267776974686472617760c01b6044820152606401610e53565b61140d826117d5565b84111561142d5760405163e9ed951560e01b815260040160405180910390fd5b6000806114398661289e565b915091506114506114473390565b86868585612bad565b915050610898600161015f55565b60006114686123da565b6114718361225f565b61147a8261225f565b61019160009054906101000a90046001600160a01b03166001600160a01b031663a6afed956040518163ffffffff1660e01b81526004016020604051808303816000875af11580156114d0573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906114f49190613c6f565b508360000361152f576040516304dd32c560e11b815260206004820152600660248201526572656465656d60d01b6044820152606401610e53565b611538826119ad565b84111561155857604051638890247960e01b815260040160405180910390fd5b600061156385612c59565b90508060000361159f576040516304dd32c560e11b815260206004820152600660248201526572656465656d60d01b6044820152606401610e53565b6115ac3385858489612bad565b9050610898600161015f55565b600054610100900460ff16158080156115d95750600054600160ff909116105b806115f35750303b1580156115f3575060005460ff166001145b61160f5760405162461bcd60e51b8152600401610e5390613f89565b6000805460ff191660011790558015611632576000805461ff0019166101001790555b61163b8261225f565b61019180546001600160a01b0319166001600160a01b03841690811790915560408051635fe3b56760e01b81529051635fe3b567916004808201926020929091908290030181865afa158015611695573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116b99190613e4f565b61019280546001600160a01b0319166001600160a01b039283161790556101915460408051636f307dc360e01b815290516000939290921691636f307dc3916004808201926020929091908290030181865afa15801561171d573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906117419190613e4f565b905061175d61174f82612e8c565b61175883612f1a565b612f92565b61176681612fc3565b61176e612ff3565b508015610875576000805461ff0019169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb3847402498906020015b60405180910390a15050565b600061074b61052e6000610be1565b600061074b826000611dcf565b6101925461019154604051630742d14b60e51b81526000926001600160a01b039081169263e85a2960926118129290911690600190600401613f27565b602060405180830381865afa15801561182f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906118539190613f54565b1561186057506000919050565b6101915460408051631d8e90d160e11b815290516000926001600160a01b031691633b1d21a29160048083019260209291908290030181865afa1580156118ab573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906118cf9190613c6f565b9050600061019160009054906101000a90046001600160a01b03166001600160a01b0316638f840ddd6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611927573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061194b9190613c6f565b905060006119716102b7866001600160a01b031660009081526033602052604090205490565b90508183101561198657506000949350505050565b60006119928385613f76565b90508181106119a157816119a3565b805b9695505050505050565b6101925461019154604051630742d14b60e51b81526000926001600160a01b039081169263e85a2960926119ea9290911690600190600401613f27565b602060405180830381865afa158015611a07573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611a2b9190613f54565b15611a3857506000919050565b6101915460408051631d8e90d160e11b815290516000926001600160a01b031691633b1d21a29160048083019260209291908290030181865afa158015611a83573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611aa79190613c6f565b9050600061019160009054906101000a90046001600160a01b03166001600160a01b0316638f840ddd6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611aff573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611b239190613c6f565b905080821015611b37575060009392505050565b6000611b438284613f76565b90506000611b50826117c8565b90506000611b73876001600160a01b031660009081526033602052604090205490565b9050808210611b825780611b84565b815b979650505050505050565b6001600160a01b03918216600090815260346020908152604080832093909416825291909152205490565b611bf86040518060400160405280601b81526020017f736574526577617264526563697069656e742861646472657373290000000000815250612804565b6107878161235a565b611c09611e07565b60c980546001600160a01b0383166001600160a01b03199091168117909155611c3a6097546001600160a01b031690565b6001600160a01b03167f38d16b8cac22d99fc7c124b9cd0de2d3fa1faef420bfe791d8c362d765e2270060405160405180910390a350565b6000610898611c7f6105a3565b611c8a906001613f14565b611c926121ac565b611c9d90600a6140bb565b603554611caa9190613f14565b85919085613022565b6001600160a01b038316611d155760405162461bcd60e51b8152602060048201526024808201527f45524332303a20617070726f76652066726f6d20746865207a65726f206164646044820152637265737360e01b6064820152608401610e53565b6001600160a01b038216611d765760405162461bcd60e51b815260206004820152602260248201527f45524332303a20617070726f766520746f20746865207a65726f206164647265604482015261737360f01b6064820152608401610e53565b6001600160a01b0383811660008181526034602090815260408083209487168084529482529182902085905590518481527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910161086b565b6000610898611ddc6121ac565b611de790600a6140bb565b603554611df49190613f14565b611dfc6105a3565b611caa906001613f14565b6097546001600160a01b031633146110705760405162461bcd60e51b815260206004820181905260248201527f4f776e61626c653a2063616c6c6572206973206e6f7420746865206f776e65726044820152606401610e53565b6001600160a01b038116611ec55760405162461bcd60e51b815260206004820152602560248201527f696e76616c696420616365737320636f6e74726f6c206d616e61676572206164604482015264647265737360d81b6064820152608401610e53565b60fb80546001600160a01b038381166001600160a01b031983168117909355604080519190921680825260208201939093527f66fd58e82f7b31a2a5c30e0888f3093efe4e111b00cd2b0c31fe014601293aa091016117ad565b6040516001600160a01b038316602482015260448101829052611f8290849063a9059cbb60e01b906064015b60408051601f198184030181529190526020810180516001600160e01b03166001600160e01b03199093169290921790915261307f565b505050565b6000611f938484611b8f565b90506000198114611ffb5781811015611fee5760405162461bcd60e51b815260206004820152601d60248201527f45524332303a20696e73756666696369656e7420616c6c6f77616e63650000006044820152606401610e53565b611ffb8484848403611cb3565b50505050565b6001600160a01b0383166120655760405162461bcd60e51b815260206004820152602560248201527f45524332303a207472616e736665722066726f6d20746865207a65726f206164604482015264647265737360d81b6064820152608401610e53565b6001600160a01b0382166120c75760405162461bcd60e51b815260206004820152602360248201527f45524332303a207472616e7366657220746f20746865207a65726f206164647260448201526265737360e81b6064820152608401610e53565b6001600160a01b0383166000908152603360205260409020548181101561213f5760405162461bcd60e51b815260206004820152602660248201527f45524332303a207472616e7366657220616d6f756e7420657863656564732062604482015265616c616e636560d01b6064820152608401610e53565b6001600160a01b0380851660008181526033602052604080822086860390559286168082529083902080548601905591517fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9061219f9086815260200190565b60405180910390a3611ffb565b60006121c06065546001600160a01b031690565b6001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa1580156121fd573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061222191906140ca565b6106a79060126140ed565b61012d548111156107875761012d5460405163792bfb1b60e11b8152600481019190915260248101829052604401610e53565b6001600160a01b038116610787576040516342bcdf7f60e11b815260040160405180910390fd5b600054610100900460ff166122ad5760405162461bcd60e51b8152600401610e5390614106565b6122b5613154565b61078781613183565b61012d54811161231b5760405162461bcd60e51b815260206004820152602260248201527f436f6d7074726f6c6c65723a20496e76616c6964206d61784c6f6f70734c696d6044820152611a5d60f21b6064820152608401610e53565b61012d80549082905560408051828152602081018490527fc2d09fef144f7c8a86f71ea459f8fc17f675768eb1ae369cbd77fb31d467aafa91016117ad565b6123638161225f565b610193546040516001600160a01b038084169216907fc8c11bb97ac2ffa10ce2e2a98f4c1fd8df84cfa2e1a15e013ed2383ab1f527ad90600090a361019380546001600160a01b0319166001600160a01b0392909216919091179055565b60c980546001600160a01b0319169055610787816131aa565b600261015f540361242d5760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c006044820152606401610e53565b600261015f55565b60006124496065546001600160a01b031690565b6040516370a0823160e01b81523060048201526001600160a01b0391909116906370a0823190602401602060405180830381865afa15801561248f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906124b39190613c6f565b610191546040516370a0823160e01b81523060048201529192506000916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612502573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906125269190613c6f565b905061254561253d6065546001600160a01b031690565b8730876131fc565b60008261255a6065546001600160a01b031690565b6040516370a0823160e01b81523060048201526001600160a01b0391909116906370a0823190602401602060405180830381865afa1580156125a0573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906125c49190613c6f565b6125ce9190613f76565b90506125d981613234565b610191546040516370a0823160e01b815230600482015260009184916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612627573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061264b9190613c6f565b6126559190613f76565b9050806000036126a8576040516304dd32c560e11b815260206004820152601b60248201527f76546f6b656e735265636569766564206174205f6465706f73697400000000006044820152606401610e53565b6000670de0b6b3a764000061019160009054906101000a90046001600160a01b03166001600160a01b031663182df0f56040518163ffffffff1660e01b8152600401602060405180830381865afa158015612707573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061272b9190613c6f565b6127359084613c9e565b61273f9190613ccb565b9050600061278e61274e6121ac565b61275990600a6140bb565b6035546127669190613f14565b8361276f6105a3565b61277a906001613f14565b6127849190613f76565b8491906000613022565b905061279a89826132fd565b886001600160a01b03168a6001600160a01b03167fdcbc1c05240f31ff3ad067ef1ee35ce4997762752e3a095284754544f4c709d78a846040516127e8929190918252602082015260400190565b60405180910390a350505050505050505050565b600161015f55565b60fb546040516318c5e8ab60e01b81526000916001600160a01b0316906318c5e8ab906128379033908690600401614151565b602060405180830381865afa158015612854573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906128789190613f54565b90508061087557333083604051634a3fa29360e01b8152600401610e5393929190614175565b60008060006128b56065546001600160a01b031690565b6040516370a0823160e01b81523060048201529091506000906001600160a01b038316906370a0823190602401602060405180830381865afa1580156128ff573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906129239190613c6f565b610191546040516370a0823160e01b81523060048201529192506000916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612972573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906129969190613c6f565b6101915460405163852a12e360e01b8152600481018990529192506000916001600160a01b039091169063852a12e3906024016020604051808303816000875af11580156129e8573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612a0c9190613c6f565b90508015612a3057604051630864657760e21b815260048101829052602401610e53565b6040516370a0823160e01b815230600482015283906001600160a01b038616906370a0823190602401602060405180830381865afa158015612a76573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612a9a9190613c6f565b612aa49190613f76565b610191546040516370a0823160e01b81523060048201529197506000916001600160a01b03909116906370a0823190602401602060405180830381865afa158015612af3573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612b179190613c6f565b612b219084613f76565b905080600003612b74576040516304dd32c560e11b815260206004820181905260248201527f61637475616c56546f6b656e73206174205f6265666f726557697468647261776044820152606401610e53565b612ba1612b7f6121ac565b612b8a90600a6140bb565b603554612b979190613f14565b8290856001613022565b95505050505050915091565b826001600160a01b0316856001600160a01b031614612bd157612bd1838683611f87565b612bdb83826133be565b606554612bf2906001600160a01b03168584611f1f565b826001600160a01b0316846001600160a01b0316866001600160a01b03167ffbde797d201c681b91056529119e0b02407c7bb96a4a2c75c01fc9667232c8db8585604051612c4a929190918252602082015260400190565b60405180910390a45050505050565b600080612c6e6065546001600160a01b031690565b6040516370a0823160e01b81523060048201529091506000906001600160a01b038316906370a0823190602401602060405180830381865afa158015612cb8573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612cdc9190613c6f565b610191546040516370a0823160e01b8152306004820152919250600091612d7b916001600160a01b0316906370a0823190602401602060405180830381865afa158015612d2d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612d519190613c6f565b612d596121ac565b612d6490600a6140bb565b603554612d719190613f14565b8791906000613022565b6101915460405163db006a7560e01b8152600481018390529192506000916001600160a01b039091169063db006a75906024016020604051808303816000875af1158015612dcd573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612df19190613c6f565b90508015612e1557604051630864657760e21b815260048101829052602401610e53565b6040516370a0823160e01b81523060048201526000906001600160a01b038616906370a0823190602401602060405180830381865afa158015612e5c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612e809190613c6f565b9050611b848482613f76565b6060816001600160a01b03166306fdde036040518163ffffffff1660e01b8152600401600060405180830381865afa158015612ecc573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052612ef491908101906141a1565b604051602001612f049190614235565b6040516020818303038152906040529050919050565b6060816001600160a01b03166395d89b416040518163ffffffff1660e01b8152600401600060405180830381865afa158015612f5a573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052612f8291908101906141a1565b604051602001612f049190614273565b600054610100900460ff16612fb95760405162461bcd60e51b8152600401610e5390614106565b61087582826134f2565b600054610100900460ff16612fea5760405162461bcd60e51b8152600401610e5390614106565b61078781613532565b600054610100900460ff1661301a5760405162461bcd60e51b8152600401610e5390614106565b6110706135b7565b6000806130308686866135de565b9050600183600281111561304657613046613ec8565b14801561306357506000848061305e5761305e613cb5565b868809115b1561307657613073600182613f14565b90505b95945050505050565b60006130d4826040518060400160405280602081526020017f5361666545524332303a206c6f772d6c6576656c2063616c6c206661696c6564815250856001600160a01b03166136c89092919063ffffffff16565b90508051600014806130f55750808060200190518101906130f59190613f54565b611f825760405162461bcd60e51b815260206004820152602a60248201527f5361666545524332303a204552433230206f7065726174696f6e20646964206e6044820152691bdd081cdd58d8d9595960b21b6064820152608401610e53565b600054610100900460ff1661317b5760405162461bcd60e51b8152600401610e5390614106565b6110706136d7565b600054610100900460ff1661077e5760405162461bcd60e51b8152600401610e5390614106565b609780546001600160a01b038381166001600160a01b0319831681179093556040519116919082907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e090600090a35050565b6040516001600160a01b0380851660248301528316604482015260648101829052611ffb9085906323b872dd60e01b90608401611f4b565b61019154613268906001600160a01b0316826132586065546001600160a01b031690565b6001600160a01b03169190613707565b6101915460405163140e25ad60e31b8152600481018390526000916001600160a01b03169063a0712d68906024016020604051808303816000875af11580156132b5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906132d99190613c6f565b9050801561087557604051630864657760e21b815260048101829052602401610e53565b6001600160a01b0382166133535760405162461bcd60e51b815260206004820152601f60248201527f45524332303a206d696e7420746f20746865207a65726f2061646472657373006044820152606401610e53565b80603560008282546133659190613f14565b90915550506001600160a01b0382166000818152603360209081526040808320805486019055518481527fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef910160405180910390a35050565b6001600160a01b03821661341e5760405162461bcd60e51b815260206004820152602160248201527f45524332303a206275726e2066726f6d20746865207a65726f206164647265736044820152607360f81b6064820152608401610e53565b6001600160a01b038216600090815260336020526040902054818110156134925760405162461bcd60e51b815260206004820152602260248201527f45524332303a206275726e20616d6f756e7420657863656564732062616c616e604482015261636560f01b6064820152608401610e53565b6001600160a01b03831660008181526033602090815260408083208686039055603580548790039055518581529192917fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef910160405180910390a3505050565b600054610100900460ff166135195760405162461bcd60e51b8152600401610e5390614106565b603661352583826142f0565b506037611f8282826142f0565b600054610100900460ff166135595760405162461bcd60e51b8152600401610e5390614106565b6000806135658361381c565b9150915081613575576012613577565b805b606580546001600160a01b039095166001600160a01b031960ff93909316600160a01b02929092166001600160a81b031990951694909417179092555050565b600054610100900460ff166127fc5760405162461bcd60e51b8152600401610e5390614106565b60008080600019858709858702925082811083820303915050806000036136185783828161360e5761360e613cb5565b0492505050610898565b80841161365f5760405162461bcd60e51b81526020600482015260156024820152744d6174683a206d756c446976206f766572666c6f7760581b6044820152606401610e53565b60008486880960026001871981018816978890046003810283188082028403028082028403028082028403028082028403028082028403029081029092039091026000889003889004909101858311909403939093029303949094049190911702949350505050565b6060610e0d84846000856138f8565b600054610100900460ff166136fe5760405162461bcd60e51b8152600401610e5390614106565b611070336123c1565b8015806137815750604051636eb1769f60e11b81523060048201526001600160a01b03838116602483015284169063dd62ed3e90604401602060405180830381865afa15801561375b573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061377f9190613c6f565b155b6137ec5760405162461bcd60e51b815260206004820152603660248201527f5361666545524332303a20617070726f76652066726f6d206e6f6e2d7a65726f60448201527520746f206e6f6e2d7a65726f20616c6c6f77616e636560501b6064820152608401610e53565b6040516001600160a01b038316602482015260448101829052611f8290849063095ea7b360e01b90606401611f4b565b60408051600481526024810182526020810180516001600160e01b031663313ce56760e01b17905290516000918291829182916001600160a01b03871691613863916143b0565b600060405180830381855afa9150503d806000811461389e576040519150601f19603f3d011682016040523d82523d6000602084013e6138a3565b606091505b50915091508180156138b757506020815110155b156138eb576000818060200190518101906138d29190613c6f565b905060ff81116138e9576001969095509350505050565b505b5060009485945092505050565b6060824710156139595760405162461bcd60e51b815260206004820152602660248201527f416464726573733a20696e73756666696369656e742062616c616e636520666f6044820152651c8818d85b1b60d21b6064820152608401610e53565b600080866001600160a01b0316858760405161397591906143b0565b60006040518083038185875af1925050503d80600081146139b2576040519150601f19603f3d011682016040523d82523d6000602084013e6139b7565b606091505b5091509150611b848783838760608315613a32578251600003613a2b576001600160a01b0385163b613a2b5760405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606401610e53565b5081610e0d565b610e0d8383815115613a475781518083602001fd5b8060405162461bcd60e51b8152600401610e539190613ab1565b60005b83811015613a7c578181015183820152602001613a64565b50506000910152565b60008151808452613a9d816020860160208601613a61565b601f01601f19169290920160200192915050565b6020815260006108986020830184613a85565b600060208284031215613ad657600080fd5b5035919050565b6001600160a01b038116811461078757600080fd5b60008060408385031215613b0557600080fd5b8235613b1081613add565b946020939093013593505050565b600060208284031215613b3057600080fd5b813561089881613add565b600080600060608486031215613b5057600080fd5b8335613b5b81613add565b92506020840135613b6b81613add565b929592945050506040919091013590565b60008060008060808587031215613b9257600080fd5b8435613b9d81613add565b93506020850135613bad81613add565b9250604085013591506060850135613bc481613add565b939692955090935050565b60008060408385031215613be257600080fd5b823591506020830135613bf481613add565b809150509250929050565b600080600060608486031215613c1457600080fd5b833592506020840135613c2681613add565b91506040840135613c3681613add565b809150509250925092565b60008060408385031215613c5457600080fd5b8235613c5f81613add565b91506020830135613bf481613add565b600060208284031215613c8157600080fd5b5051919050565b634e487b7160e01b600052601160045260246000fd5b808202811582820484141761074b5761074b613c88565b634e487b7160e01b600052601260045260246000fd5b600082613ce857634e487b7160e01b600052601260045260246000fd5b500490565b600181811c90821680613d0157607f821691505b602082108103613d2157634e487b7160e01b600052602260045260246000fd5b50919050565b60ff818116838216019081111561074b5761074b613c88565b634e487b7160e01b600052604160045260246000fd5b604051601f8201601f1916810167ffffffffffffffff81118282101715613d7f57613d7f613d40565b604052919050565b60006020808385031215613d9a57600080fd5b825167ffffffffffffffff80821115613db257600080fd5b818501915085601f830112613dc657600080fd5b815181811115613dd857613dd8613d40565b8060051b9150613de9848301613d56565b8181529183018401918481019088841115613e0357600080fd5b938501935b83851015613e2d5784519250613e1d83613add565b8282529385019390850190613e08565b98975050505050505050565b634e487b7160e01b600052603260045260246000fd5b600060208284031215613e6157600080fd5b815161089881613add565b6001600160a01b038381168252604060208084018290528451918401829052600092858201929091906060860190855b81811015613eba578551851683529483019491830191600101613e9c565b509098975050505050505050565b634e487b7160e01b600052602160045260246000fd5b6001600160a01b038481168252831660208201526060810160048310613f0657613f06613ec8565b826040830152949350505050565b8082018082111561074b5761074b613c88565b6001600160a01b03831681526040810160098310613f4757613f47613ec8565b8260208301529392505050565b600060208284031215613f6657600080fd5b8151801515811461089857600080fd5b8181038181111561074b5761074b613c88565b6020808252602e908201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160408201526d191e481a5b9a5d1a585b1a5e995960921b606082015260800190565b600181815b80851115614012578160001904821115613ff857613ff8613c88565b8085161561400557918102915b93841c9390800290613fdc565b509250929050565b6000826140295750600161074b565b816140365750600061074b565b816001811461404c576002811461405657614072565b600191505061074b565b60ff84111561406757614067613c88565b50506001821b61074b565b5060208310610133831016604e8410600b8410161715614095575081810a61074b565b61409f8383613fd7565b80600019048211156140b3576140b3613c88565b029392505050565b600061089860ff84168361401a565b6000602082840312156140dc57600080fd5b815160ff8116811461089857600080fd5b60ff828116828216039081111561074b5761074b613c88565b6020808252602b908201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960408201526a6e697469616c697a696e6760a81b606082015260800190565b6001600160a01b0383168152604060208201819052600090610e0d90830184613a85565b6001600160a01b0384811682528316602082015260606040820181905260009061307690830184613a85565b6000602082840312156141b357600080fd5b815167ffffffffffffffff808211156141cb57600080fd5b818401915084601f8301126141df57600080fd5b8151818111156141f1576141f1613d40565b614204601f8201601f1916602001613d56565b915080825285602082850101111561421b57600080fd5b61422c816020840160208601613a61565b50949350505050565b75022a9219a1b191b16abb930b83832b2102b32b73ab9960551b815260008251614266816016850160208701613a61565b9190910160160192915050565b643b1a1b191b60d91b815260008251614293816005850160208701613a61565b9190910160050192915050565b601f821115611f82576000816000526020600020601f850160051c810160208610156142c95750805b601f850160051c820191505b818110156142e8578281556001016142d5565b505050505050565b815167ffffffffffffffff81111561430a5761430a613d40565b61431e816143188454613ced565b846142a0565b602080601f831160018114614353576000841561433b5750858301515b600019600386901b1c1916600185901b1785556142e8565b600085815260208120601f198616915b8281101561438257888601518255948401946001909101908401614363565b50858210156143a05787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b600082516143c2818460208701613a61565b919091019291505056fea26469706673582212205ac92a1a47ea36429a0bb96c49ac2f3a4d2e5c42f69e2fb71d0ac58f5c2790d064736f6c63430008190033
Loading...
Loading
Loading...
Loading
0x3442ACDbCc927cC401236C69a14ca909fC5B14ba
Loading...
Loading
Loading...
Loading
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.