Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @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 ReentrancyGuard {
// 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;
constructor() {
_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;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.0;
import "./IERC20.sol";
import "./extensions/IERC20Metadata.sol";
import "../../utils/Context.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 ERC20 is Context, IERC20, IERC20Metadata {
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.
*/
constructor(string memory name_, string memory symbol_) {
_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 {}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20 {
/**
* @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.0) (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.
*/
interface IERC20Permit {
/**
* @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].
*/
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 IERC20 {
/**
* @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 "../IERC20.sol";
import "../extensions/IERC20Permit.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;
/**
* @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(IERC20 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(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));
}
/**
* @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(IERC20 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(IERC20 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(IERC20 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(
IERC20Permit 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(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");
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(IERC20 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))) && Address.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 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
*
* 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 v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
interface IOTOKEN {
/*---------- FUNCTIONS --------------------------------------------*/
function burnFrom(address account, uint256 amount) external;
/*---------- RESTRICTED FUNCTIONS ---------------------------------*/
function mint(address account, uint amount) external returns (bool);
/*---------- VIEW FUNCTIONS ---------------------------------------*/
function minter() external view returns (address);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
interface IOTOKENFactory {
/*---------- FUNCTIONS --------------------------------------------*/
function createOToken(address _owner) external returns (address);
/*---------- RESTRICTED FUNCTIONS ---------------------------------*/
/*---------- VIEW FUNCTIONS ---------------------------------------*/
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
interface ITOKENFeesFactory {
/*---------- FUNCTIONS --------------------------------------------*/
function createTokenFees(address _rewarder, address _TOKEN, address _BASE, address _OTOKEN) external returns (address);
/*---------- RESTRICTED FUNCTIONS ---------------------------------*/
/*---------- VIEW FUNCTIONS ---------------------------------------*/
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
interface IVTOKEN {
/*---------- FUNCTIONS --------------------------------------------*/
/*---------- RESTRICTED FUNCTIONS ---------------------------------*/
/*---------- VIEW FUNCTIONS ---------------------------------------*/
function OTOKEN() external view returns (address);
function balanceOf(address account) external view returns (uint256);
function balanceOfTOKEN(address account) external view returns (uint256);
function totalSupply() external view returns (uint256);
function totalSupplyTOKEN() external view returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
interface IVTOKENFactory {
/*---------- FUNCTIONS --------------------------------------------*/
function createVToken(address _TOKEN, address _OTOKEN, address _VTOKENRewarderFactory, address _owner) external returns (address, address);
/*---------- RESTRICTED FUNCTIONS ---------------------------------*/
/*---------- VIEW FUNCTIONS ---------------------------------------*/
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "contracts/interfaces/IOTOKEN.sol";
import "contracts/interfaces/IVTOKEN.sol";
import "contracts/interfaces/IOTOKENFactory.sol";
import "contracts/interfaces/IVTOKENFactory.sol";
import "contracts/interfaces/ITOKENFeesFactory.sol";
/**
* @title TOKEN Bonding Curve
* @author akita
*
* This contract governs the price dynamics of an ERC20 TOKEN via a dual bonding curve mechanism:
* 1. A fixed-price curve, y = c, where the TOKEN price is invariant at 1 BASE/TOKEN (the floor price).
* TOKENs are minted from floor reserves by exercising OTOKEN call options equivalent to the BASE amount.
* TOKENs can be consistently redeemed from floor reserves at the floor price.
* 2. A variable-price curve that employs the xy=k formula for TOKEN price discovery. An initial TOKEN supply
* is minted into market reserves, balanced by a corresponding quantity of virtual BASE. TOKEN pricing on the
* market reserves spans a range of 1 BASE/TOKEN (lower bound) to infinity BASE/TOKEN (upper bound). The market
* reserve facilitates the buying and selling of TOKENs.
*
* The integration of these reserves forms the comprehensive bonding curve for the TOKEN.
* _____________________
* | | /|
* | | / |
* | | / |
* | | / |
* | | / |
* | | / |
* | | / |
* | | / |
* |___________|/ |
* | FLOOR | MARKET |
* | RESERVE | RESERVE |
* |___________|_________|
* |<----Cf--->|<---Cm-->|
*
* The constructs of floor reserves and market reserves underpin this contract.
* Floor reserves are BASE pools allowing TOKEN redemption at a static floor price.
* TOKENs are exclusively minted from floor reserves via exercising OTOKEN call options using BASE.
* Market reserves incorporate variable amounts of BASE and TOKEN subjected to market-driven pricing
* derived from a virtual xy=k invariant. An initial TOKEN supply is minted into the market reserves,
* with an equal virtual BASE reserve amount. TOKEN pricing in the market reserves varies from a minimum
* of 1 BASE/TOKEN (floor price) to an upper limit of infinity BASE/TOKEN.
*
* The contract is designed to interact with external contracts including: OTOKEN, VTOKEN, and a FEES contract.
* It is also equipped to levy protocol and UI hosting provider fees. The TOKEN's initial supply is minted to the
* bonding curve balanced by an equal amount of virtual BASE. For the bonding curve to operate correctly, BASE must
* be an 18 decimal ERC20 token.
*/
contract TOKEN is ERC20, ReentrancyGuard {
using SafeERC20 for IERC20;
/*===================================================================*/
/*=========================== SETTINGS ============================*/
string internal constant NAME = 'Hen'; // Name of TOKEN
string internal constant SYMBOL = 'HEN'; // Symbol of TOKEN
uint256 public constant PROTOCOL_FEE = 50; // Swap and borrow fee: buy, sell, borrow
uint256 public constant PROVIDER_FEE = 4000; // Fee for the UI hosting provider
/*=========================== END SETTINGS ========================*/
/*===================================================================*/
/*---------- CONSTANTS --------------------------------------------*/
uint256 public constant DIVISOR = 10000; // Divisor for fee calculation
uint256 public constant FLOOR_PRICE = 1e18; // Floor price of TOKEN in BASE
uint256 public constant PRECISION = 1e18; // Precision
uint8 public constant DECIMALS = 18; // Required BASE decimals
/*---------- STATE VARIABLES --------------------------------------*/
// Address state variables
IERC20 public immutable BASE; // ERC20 token that backs TOKEN with liquidity in Bonding Curve. Must be 18 decimals
address public immutable OTOKEN; // Call option on TOKEN that can be exercised at the floor price of the bonding curve
address public immutable VTOKEN; // Staking contract for TOKEN to earn fees, rewards, voting power, and collateral for loans
address public immutable FEES; // Fees contract collects fees swaps and loans to distribute through rewarder
// Bonding Curve state variables
uint256 public frBASE; // floor reserve BASE
uint256 public immutable mrvBASE; // market reserve virtual BASE, also is the max amount of TOKEN allowed in the market reserve
uint256 public mrrBASE; // market reserve real BASE
uint256 public mrrTOKEN; // market reserve real TOKEN
// Lending state variables
uint256 public debtTotal; // total debt in BASE owed to the bonding curve
mapping(address => uint256) public debts; // debt in BASE owed to the bonding curve per account
/*---------- ERRORS ------------------------------------------------*/
error TOKEN__InvalidDecimals();
error TOKEN__InvalidZeroInput();
error TOKEN__SwapExpired();
error TOKEN__ExceedsSwapSlippageTolerance();
error TOKEN__ExceedsSwapMarketReserves();
error TOKEN__ExceedsBorrowCreditLimit();
error TOKEN__InvalidZeroAddress();
/*---------- EVENTS ------------------------------------------------*/
event TOKEN__Buy(address indexed account, address indexed to, uint256 amount);
event TOKEN__Sell(address indexed account, address indexed to, uint256 amount);
event TOKEN__Exercise(address indexed account, address indexed to, uint256 amount);
event TOKEN__Redeem(address indexed account, address indexed to, uint256 amount);
event TOKEN__Borrow(address indexed account, uint256 amount);
event TOKEN__Repay(address indexed account, uint256 amount);
/*---------- MODIFIERS --------------------------------------------*/
modifier nonZeroInput(uint256 _amount) {
if (_amount == 0) revert TOKEN__InvalidZeroInput();
_;
}
modifier nonExpiredSwap(uint256 expireTimestamp) {
if (expireTimestamp < block.timestamp) revert TOKEN__SwapExpired();
_;
}
modifier nonZeroAddress(address _account) {
if (_account == address(0)) revert TOKEN__InvalidZeroAddress();
_;
}
/*---------- FUNCTIONS --------------------------------------------*/
/**
* @notice Construct a new TOKEN Bonding Curve. TOKEN and BASE reserves will be equal.
* The initial supply of TOKEN will be minted to the bonding curve with an equal amount of virtual BASE.
* @dev The BASE must be an 18 decimal ERC20 token, otherwise the bonding curve will not function correctly
* @param _BASE The ERC20 in the bonding curve reserves
* @param _supplyTOKEN The initial supply of TOKEN to mint to the bonding curve
* @param _OTOKENFactory The factory contract to create the OTOKEN
* @param _VTOKENFactory The factory contract to create the VTOKEN
* @param _VTOKENRewarderFactory The factory contract to create the VTOKENRewarder
* @param _TOKENFeesFactory The factory contract to create the TOKENFees
*/
constructor(
address _BASE,
uint256 _supplyTOKEN,
address _OTOKENFactory,
address _VTOKENFactory,
address _VTOKENRewarderFactory,
address _TOKENFeesFactory
)
ERC20(NAME, SYMBOL)
nonZeroAddress(_BASE)
nonZeroInput(_supplyTOKEN)
{
if (IERC20Metadata(_BASE).decimals() != DECIMALS) revert TOKEN__InvalidDecimals();
address _owner = msg.sender;
BASE = IERC20(_BASE);
mrvBASE = _supplyTOKEN;
mrrTOKEN = _supplyTOKEN;
OTOKEN = IOTOKENFactory(_OTOKENFactory).createOToken(_owner);
(address vToken, address rewarder) = IVTOKENFactory(_VTOKENFactory).createVToken(address(this), OTOKEN, _VTOKENRewarderFactory, _owner);
VTOKEN = vToken;
FEES = ITOKENFeesFactory(_TOKENFeesFactory).createTokenFees(rewarder, address(this), _BASE, OTOKEN);
}
/**
* @notice Buy TOKEN from the bonding curve market reserves with BASE
* @param amountBase Amount of BASE to spend
* @param minToken Minimum amount of TOKEN to receive, reverts when outTOKEN < minToken
* @param expireTimestamp Expiration timestamp of the swap, reverts when block.timestamp > expireTimestamp
* @param toAccount Account address to receive TOKEN
* @param provider Account address (UI provider) to receive provider fee, address(0) does not take a fee
* @return bool true=success, otherwise false
*/
function buy(uint256 amountBase, uint256 minToken, uint256 expireTimestamp, address toAccount, address provider)
external
nonReentrant
nonZeroInput(amountBase)
nonExpiredSwap(expireTimestamp)
returns (bool)
{
uint256 feeBASE = amountBase * PROTOCOL_FEE / DIVISOR;
uint256 newMrBASE = (mrvBASE + mrrBASE) + amountBase - feeBASE;
uint256 newMrTOKEN = (mrvBASE + mrrBASE) * mrrTOKEN / newMrBASE;
uint256 outTOKEN = mrrTOKEN - newMrTOKEN;
if (outTOKEN < minToken) revert TOKEN__ExceedsSwapSlippageTolerance();
mrrBASE = newMrBASE - mrvBASE;
mrrTOKEN = newMrTOKEN;
emit TOKEN__Buy(msg.sender, toAccount, amountBase);
if (provider != address(0)) {
uint256 providerFee = feeBASE * PROVIDER_FEE / DIVISOR;
BASE.safeTransferFrom(msg.sender, provider, providerFee);
BASE.safeTransferFrom(msg.sender, FEES, feeBASE - providerFee);
} else {
BASE.safeTransferFrom(msg.sender, FEES, feeBASE);
}
IERC20(BASE).safeTransferFrom(msg.sender, address(this), amountBase - feeBASE);
_mint(toAccount, outTOKEN);
return true;
}
/**
* @notice Sell TOKEN to the bonding curve market reserves for BASE
* @param amountToken Amount of TOKEN to spend
* @param minBase Minimum amount of BASE to receive, reverts when outBase < minBase
* @param expireTimestamp Expiration timestamp of the swap, reverts when block.timestamp > expireTimestamp
* @param toAccount Account address to receive BASE
* @param provider Account address (UI provider) to receive provider fee, address(0) does not take a fee
* @return bool true=success, otherwise false
*/
function sell(uint256 amountToken, uint256 minBase, uint256 expireTimestamp, address toAccount, address provider)
external
nonReentrant
nonZeroInput(amountToken)
nonExpiredSwap(expireTimestamp)
returns (bool)
{
if (amountToken > getMaxSell()) revert TOKEN__ExceedsSwapMarketReserves();
uint256 feeTOKEN = amountToken * PROTOCOL_FEE / DIVISOR;
uint256 newMrTOKEN = mrrTOKEN + amountToken - feeTOKEN;
uint256 newMrBASE = (mrvBASE + mrrBASE) * mrrTOKEN / newMrTOKEN;
uint256 outBASE = (mrvBASE + mrrBASE) - newMrBASE;
if (outBASE < minBase) revert TOKEN__ExceedsSwapSlippageTolerance();
mrrBASE = newMrBASE - mrvBASE;
mrrTOKEN = newMrTOKEN;
emit TOKEN__Sell(msg.sender, toAccount, amountToken);
if (provider != address(0)) {
uint256 providerFee = feeTOKEN * PROVIDER_FEE / DIVISOR;
IERC20(address(this)).transferFrom(msg.sender, provider, providerFee);
IERC20(address(this)).transferFrom(msg.sender, FEES, feeTOKEN - providerFee);
} else {
IERC20(address(this)).transferFrom(msg.sender, FEES, feeTOKEN);
}
_burn(msg.sender, amountToken - feeTOKEN);
BASE.safeTransfer(toAccount, outBASE);
return true;
}
/**
* @notice Exercise equal amounts of OTOKEN with BASE to receive and an equal amount of TOKEN.
* OTOKEN is a call option with no expiry that can be exercised to purchase TOKEN
* with BASE at the constant floor price from the floor reserves.
* @param amountOToken Amount of OTOKEN to exercise, an equal amount of BASE will be required
* @param toAccount Account address to receive TOKEN
* @return bool true=success, otherwise false
*/
function exercise(uint256 amountOToken, address toAccount)
external
nonReentrant
nonZeroInput(amountOToken)
returns (bool)
{
address account = msg.sender;
frBASE += amountOToken;
_mint(toAccount, amountOToken);
emit TOKEN__Exercise(account, toAccount, amountOToken);
IOTOKEN(OTOKEN).burnFrom(account, amountOToken);
BASE.safeTransferFrom(account, address(this), amountOToken);
return true;
}
/**
* @notice Redeem TOKEN for an equal amount of BASE from the floor reserves at the constant floor price
* @param amountToken Amount of TOKEN to redeem, an equal amount of BASE will be received
* @param toAccount Account address to receive BASE
* @return bool true=success, otherwise false
*/
function redeem(uint256 amountToken, address toAccount)
external
nonReentrant
nonZeroInput(amountToken)
returns (bool)
{
address account = msg.sender;
frBASE -= amountToken;
_burn(account, amountToken);
emit TOKEN__Redeem(account, toAccount, amountToken);
BASE.safeTransfer(toAccount, amountToken);
return true;
}
/**
* @notice Borrow BASE from the bonding curve against VTOKEN collateral at the floor price of TOKEN.
* VTOKEN collateral is locked until the debt is repaid. No bad debt is possible because TOKEN can
* never go below the floor price. Therefore, no oracle or liquidation mechanism is required.
* @param amountBase Amount of BASE to borrow, must be less than the account's borrow credit limit
* (VTOKEN balance * floor price of TOKEN)
* @return bool true=success, otherwise false
*/
function borrow(uint256 amountBase)
external
nonReentrant
nonZeroInput(amountBase)
returns (bool)
{
address account = msg.sender;
uint256 credit = getAccountCredit(account);
if (credit < amountBase) revert TOKEN__ExceedsBorrowCreditLimit();
debts[account] += amountBase;
debtTotal += amountBase;
uint256 feeBASE = amountBase * PROTOCOL_FEE / DIVISOR;
emit TOKEN__Borrow(account, amountBase);
BASE.safeTransfer(FEES, feeBASE);
BASE.safeTransfer(account, amountBase - feeBASE);
return true;
}
/**
* @notice Repay BASE to the bonding curve to reduce the account's borrow credit limit and unlock VTOKEN collateral
* @param amountBase Amount of BASE to repay, must be less than or equal to the account's debt
* @return bool true=success, otherwise false
*/
function repay(uint256 amountBase)
external
nonReentrant
nonZeroInput(amountBase)
returns (bool)
{
address account = msg.sender;
debts[account] -= amountBase;
debtTotal -= amountBase;
emit TOKEN__Repay(account, amountBase);
BASE.safeTransferFrom(account, address(this), amountBase);
return true;
}
/*---------- VIEW FUNCTIONS ---------------------------------------*/
function getFloorPrice() public pure returns (uint256) {
return FLOOR_PRICE;
}
function getMarketPrice() public view returns (uint256) {
return ((mrvBASE + mrrBASE) * PRECISION) / mrrTOKEN;
}
function getOTokenPrice() public view returns (uint256) {
return getMarketPrice() - getFloorPrice();
}
function getMaxSell() public view returns (uint256) {
return (mrrTOKEN * mrrBASE / mrvBASE);
}
function getTotalValueLocked() public view returns (uint256) {
return frBASE + mrrBASE;
}
function getAccountCredit(address account) public view returns (uint256) {
return IVTOKEN(VTOKEN).balanceOfTOKEN(account) - debts[account];
}
}