Contract Name:
Comptroller
Contract Source Code:
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/utils/math/SafeMath.sol";
import "../interfaces/Bank/IComptroller.sol";
import "../interfaces/Bank/IVaultLibrary.sol";
import "../interfaces/Bank/ITreasury.sol";
import "../interfaces/Bank/IfxToken.sol";
import "../interfaces/IValidator.sol";
import "../interfaces/IWETH.sol";
import "../interfaces/Bank/IHandle.sol";
import "../interfaces/Bank/IInterest.sol";
import "../interfaces/Bank/IReferral.sol";
import "../interfaces/rewards/IRewardPool.sol";
import "./HandlePausable.sol";
/**
* @dev Provides mint and burn functions for vaults.
*/
contract Comptroller is
IComptroller,
IValidator,
Initializable,
UUPSUpgradeable,
OwnableUpgradeable,
ReentrancyGuardUpgradeable,
HandlePausable
{
using SafeMath for uint256;
using SafeERC20 for IERC20;
/** @dev The Handle contract interface */
IHandle private handle;
/** @dev The Treasury contract interface */
ITreasury private treasury;
/** @dev The VaultLibrary contract interface */
IVaultLibrary private vaultLibrary;
/** @dev The canonical WETH address */
address private WETH;
/** @dev The minting threshold amount in ETH */
uint256 public override minimumMintingAmount;
/** @dev Proxy initialisation function */
function initialize() public initializer {
__UUPSUpgradeable_init();
__Ownable_init();
__ReentrancyGuard_init();
}
/**
* @dev Setter for Handle contract reference
* @param _handle The Handle contract address
*/
function setHandleContract(address _handle) public override onlyOwner {
handle = IHandle(_handle);
treasury = ITreasury(handle.treasury());
vaultLibrary = IVaultLibrary(handle.vaultLibrary());
WETH = handle.WETH();
}
/** @dev Getter for Handle contract address */
function handleAddress() public view override returns (address) {
return address(handle);
}
/** @dev Only allows ETH transfers from WETH withdrawals */
receive() external payable {
assert(msg.sender == WETH);
}
modifier validFxToken(address token) {
require(handle.isFxTokenValid(token), "IF");
_;
}
/**
* @dev Setter for the minimum minting amount
* @param amount The minimum minting amount in ETH
*/
function setMinimumMintingAmount(uint256 amount)
external
override
onlyOwner
{
minimumMintingAmount = amount;
}
/**
* @dev Wraps received ETH and mints with WETH as collateral
* @param tokenAmount The amount of fxTokens the user wants
* @param token The token to mint
* @param deadline The time on which the transaction is invalid.
* @param referral The referral account
*/
function mintWithEth(
uint256 tokenAmount,
address token,
uint256 deadline,
address referral
)
external
payable
override
dueBy(deadline)
validFxToken(token)
nonReentrant
{
require(handle.isCollateralValid(WETH), "WE");
require(tokenAmount > 0 && msg.value > 0, "IA");
IWETH(WETH).deposit{value: msg.value}();
_mintAndDeposit(tokenAmount, token, WETH, msg.value, referral);
}
/**
* @dev Mints with a valid ERC20 as collateral.
Must have pre-approved ERC20 allowance.
* @param tokenAmount The amount of fxTokens the user wants
* @param token The token to mint
* @param deadline The time on which the transaction is invalid.
* @param referral The referral account
*/
function mint(
uint256 tokenAmount,
address token,
address collateralToken,
uint256 collateralAmount,
uint256 deadline,
address referral
) external override dueBy(deadline) validFxToken(token) nonReentrant {
require(handle.isCollateralValid(collateralToken), "IC");
require(tokenAmount > 0 && collateralAmount > 0, "IA");
IERC20(collateralToken).safeTransferFrom(
msg.sender,
address(this),
collateralAmount
);
_mintAndDeposit(
tokenAmount,
token,
collateralToken,
collateralAmount,
referral
);
}
/**
* @dev Mints the requested amount accounting for mint fees and deposits
collateral into the vault via the Treasury.
* @param tokenAmount The token amount to mint, excluding the mint fee.
* @param token The fxToken to mint
* @param collateralToken The collateral token to deposit.
* @param collateralAmount The amount of collateral to deposit.
* @param referral The referral account.
*/
function _mintAndDeposit(
uint256 tokenAmount,
address token,
address collateralToken,
uint256 collateralAmount,
address referral
) private {
IERC20(collateralToken).safeApprove(address(treasury), 0);
IERC20(collateralToken).safeApprove(
address(treasury),
collateralAmount
);
// Calculate fee with current amount and increase token amount to include fee.
uint256 feeTokens = tokenAmount.mul(handle.mintFeePerMille()).div(1000);
uint256 feeCollateral =
collateralAmount.mul(handle.depositFeePerMille()).div(1000);
uint256 tokenQuote = handle.getTokenPrice(token);
_ensureMinimumMintingAmount(
msg.sender,
token,
tokenQuote,
tokenAmount,
true
);
require(
vaultLibrary.canMint(
msg.sender,
token,
collateralToken,
collateralAmount.sub(feeCollateral),
tokenAmount.add(feeTokens),
tokenQuote,
handle.getTokenPrice(collateralToken)
),
"CR"
);
// Deposit in the treasury
treasury.depositCollateral(
msg.sender,
collateralAmount,
collateralToken,
token,
referral
);
_mint(tokenAmount, token, tokenQuote, feeTokens);
}
/**
* @dev Mints fxTokens for the user and protocol as fees.
* @param tokenAmount The token amount to mint for the user, excluding fee.
* @param token The fxToken address to mint.
* @param tokenQuote The unit price in ETH for the fxToken.
* @param feeTokenAmount The amount of fxTokens to be minted as a fee.
*/
function _mint(
uint256 tokenAmount,
address token,
uint256 tokenQuote,
uint256 feeTokenAmount
) private notPaused {
// Mint tokens and fee
uint256 balanceBefore = IfxToken(token).balanceOf(msg.sender);
IfxToken(token).mint(msg.sender, tokenAmount);
IfxToken(token).mint(handle.FeeRecipient(), feeTokenAmount);
assert(
IfxToken(token).balanceOf(msg.sender) ==
balanceBefore.add(tokenAmount)
);
// Update debt position
uint256 debtPosition = handle.getDebt(msg.sender, token);
uint256 totalMintedAmount = tokenAmount.add(feeTokenAmount);
handle.updateDebtPosition(msg.sender, totalMintedAmount, token, true);
assert(
debtPosition.add(totalMintedAmount) ==
handle.getDebt(msg.sender, token)
);
// Stake into the reward pool.
IRewardPool rewards = IRewardPool(handle.rewards());
(bool found, uint256 rewardPoolId) =
rewards.getPoolIdByAlias(
rewards.getFxTokenPoolAlias(
token,
uint256(RewardPoolCategory.Mint)
)
);
if (found) rewards.stake(msg.sender, totalMintedAmount, rewardPoolId);
emit MintToken(tokenQuote, totalMintedAmount, token);
}
/**
* @dev Allows an user to mint fxTokens with existing collateral.
* @param tokenAmount The amount of fxTokens the user wants.
* @param token The fxToken to mint.
* @param deadline The time on which the transaction is invalid.
* @param referral The referral account.
*/
function mintWithoutCollateral(
uint256 tokenAmount,
address token,
uint256 deadline,
address referral
) public override dueBy(deadline) validFxToken(token) nonReentrant {
require(tokenAmount > 0, "IA");
// Check the vault ratio is correct (fxToken <-> collateral)
uint256 quote = handle.getTokenPrice(token);
_ensureMinimumMintingAmount(
msg.sender,
token,
quote,
tokenAmount,
true
);
_trySetReferral(msg.sender, referral);
// Update interest rates according to cache time.
IInterest(handle.interest()).tryUpdateRates();
// Calculate fee with current amount and increase token amount to include fee.
uint256 feeTokens = tokenAmount.mul(handle.mintFeePerMille()).div(1000);
require(
vaultLibrary.getFreeCollateralAsEth(msg.sender, token) >=
vaultLibrary.getMinimumCollateral(
tokenAmount.add(feeTokens),
vaultLibrary.getMinimumRatio(msg.sender, token),
quote
),
"CR"
);
_mint(tokenAmount, token, quote, feeTokens);
}
/**
* @dev Burns fxToken debt from sender's vault.
* @param amount The amount of fxTokens to burn.
* @param token The token to burn.
* @param deadline The time on which the transaction is invalid.
*/
function burn(
uint256 amount,
address token,
uint256 deadline
)
external
override
dueBy(deadline)
validFxToken(token)
notPaused
nonReentrant
{
require(amount > 0, "IA");
// Token balance must be higher or equal than burn amount.
require(IfxToken(token).balanceOf(msg.sender) >= amount, "IA");
uint256 quote = handle.getTokenPrice(token);
{
// Treasury debt must be higher or equal to burn amount.
uint256 maxAmount = handle.getDebt(msg.sender, token);
if (amount > maxAmount) amount = maxAmount;
if (amount != maxAmount)
_ensureMinimumMintingAmount(
msg.sender,
token,
quote,
amount,
false
);
}
// Update interest rates according to cache time.
IInterest(handle.interest()).tryUpdateRates();
// Store balance for assertion purposes.
uint256 balanceBefore = IfxToken(token).balanceOf(msg.sender);
// Charge burn fee as collateral Ether equivalent of fxToken amount.
uint256 fee =
amount
.mul(handle.burnFeePerMille())
.mul(quote)
// Cancel out fee ratio unit after fee multiplication.
.div(1000)
// Cancel out token unit after price multiplication.
.div(vaultLibrary.getTokenUnit(token));
// Withdraw any available collateral type for fee.
treasury.forceWithdrawAnyCollateral(
msg.sender,
handle.FeeRecipient(),
fee,
token,
true
);
// Burn tokens
IfxToken(token).burn(msg.sender, amount);
assert(
IfxToken(token).balanceOf(msg.sender) == balanceBefore.sub(amount)
);
// Update debt position
uint256 debtPositionBefore = handle.getDebt(msg.sender, token);
handle.updateDebtPosition(msg.sender, amount, token, false);
assert(
handle.getDebt(msg.sender, token) == debtPositionBefore.sub(amount)
);
// Unstake from the reward pool.
IRewardPool rewards = IRewardPool(handle.rewards());
(bool found, uint256 rewardPoolId) =
rewards.getPoolIdByAlias(
rewards.getFxTokenPoolAlias(
token,
uint256(RewardPoolCategory.Mint)
)
);
if (found) rewards.unstake(msg.sender, amount, rewardPoolId);
emit BurnToken(amount, token);
}
/**
* @dev Reverts the transaction if the resulting vault debt does not
meet the configured minimum mint amount set by the protocol.
* @param account The vault account
* @param fxToken The vault fxToken
* @param tokenPrice The fxToken price
* @param deltaAmount The amount to be minted or burned.
* @param isMinting Whether the transaction will mint or burn the fxToken.
*/
function _ensureMinimumMintingAmount(
address account,
address fxToken,
uint256 tokenPrice,
uint256 deltaAmount,
bool isMinting
) private {
if (minimumMintingAmount == 0) return;
// Check that new principal will meet minimum mint amount after mint.
uint256 principal = handle.getPrincipalDebt(account, fxToken);
if (isMinting) {
principal = principal.add(deltaAmount);
} else if (principal <= deltaAmount) {
revert("IA");
} else {
principal = principal.sub(deltaAmount);
}
// Convert minimum amount to fxToken equivalent.
uint256 minimumFxAmount =
minimumMintingAmount.mul(1 ether).div(tokenPrice);
// Round fxAmount up to the nearest 100.
uint256 roundBy = 100 ether;
minimumFxAmount = ((minimumFxAmount + roundBy - 1) / roundBy) * roundBy;
require(principal >= minimumFxAmount, "IA");
}
/**
* @dev Calls the referral function to set a referral if this is the first
time the user interacts with the protocol.
* @param user The user address.
* @param referral The referrer address.
*/
function _trySetReferral(address user, address referral) private {
IReferral(handle.referral()).setReferral(user, referral);
}
/** @dev Protected UUPS upgrade authorization fuction */
function _authorizeUpgrade(address) internal override onlyOwner {}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @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 a proxied contract can't have 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.
*
* 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.
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
*/
bool private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Modifier to protect an initializer function from being invoked twice.
*/
modifier initializer() {
require(_initializing || !_initialized, "Initializable: contract is already initialized");
bool isTopLevelCall = !_initializing;
if (isTopLevelCall) {
_initializing = true;
_initialized = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../ERC1967/ERC1967UpgradeUpgradeable.sol";
import "./Initializable.sol";
/**
* @dev An upgradeability mechanism designed for UUPS proxies. The functions included here can perform an upgrade of an
* {ERC1967Proxy}, when this contract is set as the implementation behind such a proxy.
*
* A security mechanism ensures that an upgrade does not turn off upgradeability accidentally, although this risk is
* reinstated if the upgrade retains upgradeability but removes the security mechanism, e.g. by replacing
* `UUPSUpgradeable` with a custom implementation of upgrades.
*
* The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.
*
* _Available since v4.1._
*/
abstract contract UUPSUpgradeable is Initializable, ERC1967UpgradeUpgradeable {
function __UUPSUpgradeable_init() internal initializer {
__ERC1967Upgrade_init_unchained();
__UUPSUpgradeable_init_unchained();
}
function __UUPSUpgradeable_init_unchained() internal initializer {
}
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
address private immutable __self = address(this);
/**
* @dev Check that the execution is being performed through a delegatecall call and that the execution context is
* a proxy contract with an implementation (as defined in ERC1967) pointing to self. This should only be the case
* for UUPS and transparent proxies that are using the current contract as their implementation. Execution of a
* function through ERC1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to
* fail.
*/
modifier onlyProxy() {
require(address(this) != __self, "Function must be called through delegatecall");
require(_getImplementation() == __self, "Function must be called through active proxy");
_;
}
/**
* @dev Upgrade the implementation of the proxy to `newImplementation`.
*
* Calls {_authorizeUpgrade}.
*
* Emits an {Upgraded} event.
*/
function upgradeTo(address newImplementation) external virtual onlyProxy {
_authorizeUpgrade(newImplementation);
_upgradeToAndCallSecure(newImplementation, new bytes(0), false);
}
/**
* @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call
* encoded in `data`.
*
* Calls {_authorizeUpgrade}.
*
* Emits an {Upgraded} event.
*/
function upgradeToAndCall(address newImplementation, bytes memory data) external payable virtual onlyProxy {
_authorizeUpgrade(newImplementation);
_upgradeToAndCallSecure(newImplementation, data, true);
}
/**
* @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by
* {upgradeTo} and {upgradeToAndCall}.
*
* Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.
*
* ```solidity
* function _authorizeUpgrade(address) internal override onlyOwner {}
* ```
*/
function _authorizeUpgrade(address newImplementation) internal virtual;
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../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 initializer {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal initializer {
_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 make it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
// On the first call to nonReentrant, _notEntered will be true
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../utils/ContextUpgradeable.sol";
import "../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 initializer {
__Context_init_unchained();
__Ownable_init_unchained();
}
function __Ownable_init_unchained() internal initializer {
_setOwner(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_setOwner(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");
_setOwner(newOwner);
}
function _setOwner(address newOwner) private {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../../../utils/Address.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 SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(
IERC20 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(
IERC20 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));
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 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");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
// CAUTION
// This version of SafeMath should only be used with Solidity 0.8 or later,
// because it relies on the compiler's built in overflow checks.
/**
* @dev Wrappers over Solidity's arithmetic operations.
*
* NOTE: `SafeMath` is no longer needed starting with Solidity 0.8. The compiler
* now has built in overflow checking.
*/
library SafeMath {
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the substraction of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @dev Returns the addition of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
*
* - Addition cannot overflow.
*/
function add(uint256 a, uint256 b) internal pure returns (uint256) {
return a + b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b) internal pure returns (uint256) {
return a - b;
}
/**
* @dev Returns the multiplication of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
*
* - Multiplication cannot overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
return a * b;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator.
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b) internal pure returns (uint256) {
return a % b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {trySub}.
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
unchecked {
require(b <= a, errorMessage);
return a - b;
}
}
/**
* @dev Returns the integer division of two unsigned integers, reverting with custom message on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
unchecked {
require(b > 0, errorMessage);
return a / b;
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting with custom message when dividing by zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryMod}.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
unchecked {
require(b > 0, errorMessage);
return a % b;
}
}
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
interface IComptroller {
event MintToken(
uint256 tokenRate,
uint256 amountMinted,
address indexed token
);
event BurnToken(uint256 amountBurned, address indexed token);
function mintWithEth(
uint256 tokenAmountDesired,
address fxToken,
uint256 deadline,
address referral
) external payable;
function mint(
uint256 amountDesired,
address fxToken,
address collateralToken,
uint256 collateralAmount,
uint256 deadline,
address referral
) external;
function mintWithoutCollateral(
uint256 tokenAmountDesired,
address token,
uint256 deadline,
address referral
) external;
function burn(
uint256 amount,
address token,
uint256 deadline
) external;
function setMinimumMintingAmount(uint256 amount) external;
function minimumMintingAmount() external view returns (uint256);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
interface IVaultLibrary {
function doesMeetRatio(address account, address fxToken)
external
view
returns (bool);
function getFreeCollateralAsEth(address account, address fxToken)
external
view
returns (uint256);
function getFreeCollateralAsEthFromMinimumRatio(
address account,
address fxToken,
uint256 minimumRatio
) external view returns (uint256);
function getMinimumRatio(address account, address fxToken)
external
view
returns (uint256 ratio);
function getMinimumCollateral(
uint256 tokenAmount,
uint256 ratio,
uint256 unitPrice
) external view returns (uint256 minimum);
function getDebtAsEth(address account, address fxToken)
external
view
returns (uint256 debt);
function getTotalCollateralBalanceAsEth(address account, address fxToken)
external
view
returns (uint256 balance);
function getCurrentRatio(address account, address fxToken)
external
view
returns (uint256 ratio);
function getCollateralForAmount(
address account,
address fxToken,
uint256 amountEth
)
external
view
returns (
address[] memory collateralTypes,
uint256[] memory collateralAmounts,
bool metAmount
);
function getDecimalsAmount(
uint256 amount,
uint8 fromDecimals,
uint8 toDecimals
) external pure returns (uint256);
function calculateInterest(address account, address fxToken)
external
view
returns (uint256 interest);
function getInterestRate(address account, address fxToken)
external
view
returns (uint256 rate);
function getInterestDeltaR(address account, address fxToken)
external
view
returns (uint256 dR);
function getLiquidationFee(address account, address fxToken)
external
view
returns (uint256 fee);
function getCollateralShares(address account, address fxToken)
external
view
returns (uint256[] memory shares);
function getCollateralTypesSortedByLiquidationRank()
external
view
returns (address[] memory sortedCollateralTypes);
function getNewMinimumRatio(
address account,
address fxToken,
address collateralToken,
uint256 collateralAmount,
uint256 collateralQuote,
bool isDeposit
) external view returns (uint256 ratio, uint256 newCollateralAsEther);
function canMint(
address account,
address fxToken,
address collateralToken,
uint256 collateralAmount,
uint256 tokenAmount,
uint256 fxQuote,
uint256 collateralQuote
) external view returns (bool);
function quickSort(
uint256[] memory array,
int256 left,
int256 right
) external pure;
function getTokenUnit(address token) external view returns (uint256);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
interface ITreasury {
function depositCollateral(
address account,
uint256 depositAmount,
address collateralType,
address fxToken,
address referral
) external;
function depositCollateralETH(
address account,
address fxToken,
address referral
) external payable;
function withdrawCollateral(
address collateralToken,
address to,
uint256 amount,
address fxToken
) external;
function withdrawCollateralETH(
address to,
uint256 amount,
address fxToken
) external;
function withdrawCollateralFrom(
address from,
address collateralToken,
address to,
uint256 amount,
address fxToken
) external;
function forceWithdrawCollateral(
address from,
address collateralToken,
address to,
uint256 amount,
address fxToken
) external;
function forceWithdrawAnyCollateral(
address from,
address to,
uint256 amount,
address fxToken,
bool requireFullAmount
)
external
returns (
address[] memory collateralTypes,
uint256[] memory collateralAmounts
);
function requestFundsPCT(address token, uint256 amount) external;
function setMaximumTotalDepositAllowed(uint256 value) external;
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
interface IfxToken is IERC20 {
function mint(address account, uint256 amount) external;
function burn(address account, uint256 amount) external;
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
interface IValidator {
modifier dueBy(uint256 date) {
require(block.timestamp <= date, "Transaction has exceeded deadline");
_;
}
modifier validAddress(address _address) {
require(_address != address(0), "Invalid Address");
_;
}
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
interface IWETH {
function deposit() external payable;
function transfer(address to, uint256 value) external returns (bool);
function withdraw(uint256) external;
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
interface IHandle {
struct Vault {
// Collateral token address => balance
mapping(address => uint256) collateralBalance;
uint256 debt;
// Collateral token address => R0
mapping(address => uint256) R0;
}
struct CollateralData {
uint256 mintCR;
uint256 liquidationFee;
uint256 interestRate;
}
event UpdateDebt(address indexed account, address indexed fxToken);
event UpdateCollateral(
address indexed account,
address indexed fxToken,
address indexed collateralToken
);
event ConfigureCollateralToken(address indexed collateralToken);
event ConfigureFxToken(address indexed fxToken, bool removed);
function setCollateralUpperBoundPCT(uint256 ratio) external;
function setPaused(bool value) external;
function setFxToken(address token) external;
function removeFxToken(address token) external;
function setCollateralToken(
address token,
uint256 mintCR,
uint256 liquidationFee,
uint256 interestRatePerMille
) external;
function removeCollateralToken(address token) external;
function getAllCollateralTypes()
external
view
returns (address[] memory collateral);
function getCollateralDetails(address collateral)
external
view
returns (CollateralData memory);
function WETH() external view returns (address);
function treasury() external view returns (address payable);
function comptroller() external view returns (address);
function vaultLibrary() external view returns (address);
function fxKeeperPool() external view returns (address);
function pct() external view returns (address);
function liquidator() external view returns (address);
function interest() external view returns (address);
function referral() external view returns (address);
function forex() external view returns (address);
function rewards() external view returns (address);
function pctCollateralUpperBound() external view returns (uint256);
function isFxTokenValid(address fxToken) external view returns (bool);
function isCollateralValid(address collateral) external view returns (bool);
function setComponents(address[] memory components) external;
function updateDebtPosition(
address account,
uint256 amount,
address fxToken,
bool increase
) external;
function updateCollateralBalance(
address account,
uint256 amount,
address fxToken,
address collateralToken,
bool increase
) external;
function setFeeRecipient(address feeRecipient) external;
function setFees(
uint256 withdrawFeePerMille,
uint256 depositFeePerMille,
uint256 mintFeePerMille,
uint256 burnFeePerMille
) external;
function getCollateralBalance(
address account,
address collateralType,
address fxToken
) external view returns (uint256 balance);
function getBalance(address account, address fxToken)
external
view
returns (address[] memory collateral, uint256[] memory balances);
function getDebt(address owner, address fxToken)
external
view
returns (uint256 _debt);
function getPrincipalDebt(address owner, address fxToken)
external
view
returns (uint256 _debt);
function getCollateralR0(
address account,
address fxToken,
address collateral
) external view returns (uint256 R0);
function getTokenPrice(address token) external view returns (uint256 quote);
function setOracle(address fxToken, address oracle) external;
function FeeRecipient() external view returns (address);
function mintFeePerMille() external view returns (uint256);
function burnFeePerMille() external view returns (uint256);
function withdrawFeePerMille() external view returns (uint256);
function depositFeePerMille() external view returns (uint256);
function isPaused() external view returns (bool);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
interface IInterest {
struct ExternalAssetData {
bytes32 makerDaoCollateralIlk;
}
function setCollateralExternalAssetData(
address collateral,
bytes32 makerDaoCollateralIlk
) external;
function unsetCollateralExternalAssetData(address collateral) external;
function setMaxExternalSourceInterest(uint256 interestPerMille) external;
function charge() external;
function getCurrentR()
external
view
returns (uint256[] memory R, address[] memory collateralTokens);
function setDataSource(address source) external;
function tryUpdateRates() external;
function updateRates() external;
function fetchRate(address token) external view returns (uint256);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
interface IReferral {
function setReferral(address userAccount, address referralAccount) external;
function getReferral(address userAccount) external view returns (address);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
/**
* @dev Established pool categories to be used internally by the
* protocol for the users.
* This enum is used to get the correct pool ID from the pool alias
* which consists of an fxToken address and a category number.
*/
enum RewardPoolCategory {Mint, Deposit, Keeper}
interface IRewardPool {
/** Reward category e.g. Keepers or Liquidity Providers */
struct Pool {
// Pool reward weight. The amount of FOREX allocated to this
// category is given by the ratio of this weight to the sum of all
// weights for enabled pools.
// A category is enabled if the weight is not zero.
uint256 weight;
// Asset is used for pools that require token staking,
// such as LP tokens. Could be e.g. None, ERC20 or ERC721.
AssetType assetType;
// For pools with no token (AssetType::None), this value is zero.
address assetAddress;
// If AssetType == None, whitelist with this map from staker address.
mapping(address => bool) stakerWhitelist;
// Account -> Deposit
mapping(address => Deposit) deposits;
// Total amount deposited.
uint256 totalDeposits;
// Current pool reward ratio over total deposits.
uint256 S;
}
/** Reward pool deposit for tracking user contributions */
struct Deposit {
// Amount contributed.
// e.g. for Keepers, the total amount staked.
// for minters, the total amount minted.
// for LPs, the total liquidity provided.
uint256 amount;
// Reward ratio over total deposits during deposit.
uint256 S;
}
enum AssetType {None, ERC20, ERC721}
event Stake(address indexed account, uint256 poolId, uint256 amount);
event Unstake(address indexed account, uint256 poolId, uint256 amount);
event CreatePool(
uint256 id,
AssetType assetType,
address asset,
uint256 weight
);
event SetPoolWeights(uint256[] poolIds, uint256[] weights);
event SetFxTokenWeights(address[] fxTokens, uint256[] weights);
event ForexDistributed(
uint256 duration,
uint256 rate,
uint256 totalAmount,
uint256[] poolIds,
uint256[] amounts
);
event SetForexDistributionRate(uint256 ratePerSecond);
event Claim(
address indexed acount,
uint256 amount,
uint256[] poolIds,
uint256[] amounts
);
event WhitelistChanged(address staker, uint256 poolId, bool whitelisted);
event PoolAliasChanged(uint256 poolId, bytes32 aliasHash);
function stake(
address account,
uint256 value,
uint256 poolId
) external returns (uint256 errorCode);
function unstake(
address account,
uint256 value,
uint256 poolId
) external returns (uint256 errorCode);
function claim() external;
function distribute() external;
function createPool(
uint256 weight,
AssetType assetType,
address assetAddress,
uint256[] memory poolIds,
uint256[] memory weights
) external;
function setupPools(
AssetType[] memory assetTypes,
address[] memory assetAddresses,
uint256[] memory weights,
bytes32[] memory aliases
) external;
// Used to enable and disable pools.
// To disable, a weight must be set to zero.
// Will emit events accordingly.
function setPools(uint256[] memory poolIds, uint256[] memory weights)
external;
function setWhitelistedStaker(
address staker,
uint256 poolId,
bool isWhitelisted
) external;
function setForexDistributionRate(uint256 rate) external;
function setPoolAlias(bytes32 hash, uint256 poolId) external;
function getPoolsData()
external
view
returns (
uint256[] memory poolRatios,
uint256[] memory accruedAmounts,
uint256[] memory deltaS
);
function getPoolIdByAlias(bytes32 hash)
external
view
returns (bool found, uint256 poolId);
function getFxTokenPoolAlias(address token, uint256 category)
external
view
returns (bytes32);
// Return allowed parameters only (no mappings)
// because Solidity is a Special Snowflake (tm)
function getPool(uint256 poolId)
external
view
returns (
uint256 weight,
AssetType assetType,
address assetAddress,
uint256 totalDeposits,
uint256 S
);
function getDeposit(address account, uint256 poolId)
external
view
returns (Deposit memory);
function balanceOf(address account) external view returns (uint256 balance);
function forex() external view returns (IERC20);
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
import "../interfaces/Bank/IHandle.sol";
import "../interfaces/Bank/IHandleComponent.sol";
abstract contract HandlePausable is IHandleComponent {
function handleAddress() public view virtual override returns (address);
modifier notPaused() {
require(!IHandle(handleAddress()).isPaused(), "Paused");
_;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.2;
import "../beacon/IBeaconUpgradeable.sol";
import "../../utils/AddressUpgradeable.sol";
import "../../utils/StorageSlotUpgradeable.sol";
import "../utils/Initializable.sol";
/**
* @dev This abstract contract provides getters and event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
*
* _Available since v4.1._
*
* @custom:oz-upgrades-unsafe-allow delegatecall
*/
abstract contract ERC1967UpgradeUpgradeable is Initializable {
function __ERC1967Upgrade_init() internal initializer {
__ERC1967Upgrade_init_unchained();
}
function __ERC1967Upgrade_init_unchained() internal initializer {
}
// This is the keccak-256 hash of "eip1967.proxy.rollback" subtracted by 1
bytes32 private constant _ROLLBACK_SLOT = 0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143;
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev Emitted when the implementation is upgraded.
*/
event Upgraded(address indexed implementation);
/**
* @dev Returns the current implementation address.
*/
function _getImplementation() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 implementation slot.
*/
function _setImplementation(address newImplementation) private {
require(AddressUpgradeable.isContract(newImplementation), "ERC1967: new implementation is not a contract");
StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
}
/**
* @dev Perform implementation upgrade
*
* Emits an {Upgraded} event.
*/
function _upgradeTo(address newImplementation) internal {
_setImplementation(newImplementation);
emit Upgraded(newImplementation);
}
/**
* @dev Perform implementation upgrade with additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCall(
address newImplementation,
bytes memory data,
bool forceCall
) internal {
_upgradeTo(newImplementation);
if (data.length > 0 || forceCall) {
_functionDelegateCall(newImplementation, data);
}
}
/**
* @dev Perform implementation upgrade with security checks for UUPS proxies, and additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCallSecure(
address newImplementation,
bytes memory data,
bool forceCall
) internal {
address oldImplementation = _getImplementation();
// Initial upgrade and setup call
_setImplementation(newImplementation);
if (data.length > 0 || forceCall) {
_functionDelegateCall(newImplementation, data);
}
// Perform rollback test if not already in progress
StorageSlotUpgradeable.BooleanSlot storage rollbackTesting = StorageSlotUpgradeable.getBooleanSlot(_ROLLBACK_SLOT);
if (!rollbackTesting.value) {
// Trigger rollback using upgradeTo from the new implementation
rollbackTesting.value = true;
_functionDelegateCall(
newImplementation,
abi.encodeWithSignature("upgradeTo(address)", oldImplementation)
);
rollbackTesting.value = false;
// Check rollback was effective
require(oldImplementation == _getImplementation(), "ERC1967Upgrade: upgrade breaks further upgrades");
// Finally reset to the new implementation and log the upgrade
_upgradeTo(newImplementation);
}
}
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Emitted when the admin account has changed.
*/
event AdminChanged(address previousAdmin, address newAdmin);
/**
* @dev Returns the current admin.
*/
function _getAdmin() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 admin slot.
*/
function _setAdmin(address newAdmin) private {
require(newAdmin != address(0), "ERC1967: new admin is the zero address");
StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value = newAdmin;
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {AdminChanged} event.
*/
function _changeAdmin(address newAdmin) internal {
emit AdminChanged(_getAdmin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
* This is bytes32(uint256(keccak256('eip1967.proxy.beacon')) - 1)) and is validated in the constructor.
*/
bytes32 internal constant _BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
/**
* @dev Emitted when the beacon is upgraded.
*/
event BeaconUpgraded(address indexed beacon);
/**
* @dev Returns the current beacon.
*/
function _getBeacon() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value;
}
/**
* @dev Stores a new beacon in the EIP1967 beacon slot.
*/
function _setBeacon(address newBeacon) private {
require(AddressUpgradeable.isContract(newBeacon), "ERC1967: new beacon is not a contract");
require(
AddressUpgradeable.isContract(IBeaconUpgradeable(newBeacon).implementation()),
"ERC1967: beacon implementation is not a contract"
);
StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value = newBeacon;
}
/**
* @dev Perform beacon upgrade with additional setup call. Note: This upgrades the address of the beacon, it does
* not upgrade the implementation contained in the beacon (see {UpgradeableBeacon-_setImplementation} for that).
*
* Emits a {BeaconUpgraded} event.
*/
function _upgradeBeaconToAndCall(
address newBeacon,
bytes memory data,
bool forceCall
) internal {
_setBeacon(newBeacon);
emit BeaconUpgraded(newBeacon);
if (data.length > 0 || forceCall) {
_functionDelegateCall(IBeaconUpgradeable(newBeacon).implementation(), data);
}
}
/**
* @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) private returns (bytes memory) {
require(AddressUpgradeable.isContract(target), "Address: delegate call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.delegatecall(data);
return AddressUpgradeable.verifyCallResult(success, returndata, "Address: low-level delegate call failed");
}
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeaconUpgradeable {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {BeaconProxy} will check that this address is a contract.
*/
function implementation() external view returns (address);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @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
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in
// construction, since the code is only stored at the end of the
// constructor execution.
uint256 size;
assembly {
size := extcodesize(account)
}
return size > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC1967 implementation slot:
* ```
* contract ERC1967 {
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract");
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* _Available since v4.1 for `address`, `bool`, `bytes32`, and `uint256`._
*/
library StorageSlotUpgradeable {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
assembly {
r.slot := slot
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal initializer {
__Context_init_unchained();
}
function __Context_init_unchained() internal initializer {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
uint256[50] private __gap;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `sender` to `recipient` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) external returns (bool);
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in
// construction, since the code is only stored at the end of the
// constructor execution.
uint256 size;
assembly {
size := extcodesize(account)
}
return size > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev 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) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
pragma abicoder v2;
interface IHandleComponent {
function setHandleContract(address hanlde) external;
function handleAddress() external view returns (address);
}