Contract Source Code:
File 1 of 1 : ZeroMoon
// SPDX-License-Identifier: MIT
// File: @openzeppelin/contracts@4.9.3/token/ERC20/IERC20.sol
// 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);
}
// File: @openzeppelin/contracts@4.9.3/token/ERC20/extensions/IERC20Metadata.sol
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
/**
* @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);
}
// File: @openzeppelin/contracts@4.9.3/utils/Context.sol
// 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;
}
}
// File: @openzeppelin/contracts@4.9.3/token/ERC20/ERC20.sol
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.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 {}
}
// File: @openzeppelin/contracts@4.9.3/token/ERC20/extensions/IERC20Permit.sol
// 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);
}
// File: @openzeppelin/contracts@4.9.3/utils/math/Math.sol
// OpenZeppelin Contracts (last updated v4.9.0) (utils/math/Math.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Down, // Toward negative infinity
Up, // Toward infinity
Zero // Toward zero
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds up instead
* of rounding down.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
* with further edits by Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1, "Math: mulDiv overflow");
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
// See https://cs.stackexchange.com/q/138556/92363.
// Does not overflow because the denominator cannot be zero at this stage in the function.
uint256 twos = denominator & (~denominator + 1);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (rounding == Rounding.Up && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256, rounded down, of a positive value.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (rounding == Rounding.Up && 1 << (result << 3) < value ? 1 : 0);
}
}
}
// File: @openzeppelin/contracts@4.9.3/utils/math/SignedMath.sol
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMath {
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// must be unchecked in order to support `n = type(int256).min`
return uint256(n >= 0 ? n : -n);
}
}
}
// File: @openzeppelin/contracts@4.9.3/utils/Strings.sol
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant _SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
/// @solidity memory-safe-assembly
assembly {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
/// @solidity memory-safe-assembly
assembly {
mstore8(ptr, byte(mod(value, 10), _SYMBOLS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toString(int256 value) internal pure returns (string memory) {
return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMath.abs(value))));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return keccak256(bytes(a)) == keccak256(bytes(b));
}
}
// File: @openzeppelin/contracts@4.9.3/utils/cryptography/ECDSA.sol
// OpenZeppelin Contracts (last updated v4.9.0) (utils/cryptography/ECDSA.sol)
pragma solidity ^0.8.0;
/**
* @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
*
* These functions can be used to verify that a message was signed by the holder
* of the private keys of a given address.
*/
library ECDSA {
enum RecoverError {
NoError,
InvalidSignature,
InvalidSignatureLength,
InvalidSignatureS,
InvalidSignatureV // Deprecated in v4.8
}
function _throwError(RecoverError error) private pure {
if (error == RecoverError.NoError) {
return; // no error: do nothing
} else if (error == RecoverError.InvalidSignature) {
revert("ECDSA: invalid signature");
} else if (error == RecoverError.InvalidSignatureLength) {
revert("ECDSA: invalid signature length");
} else if (error == RecoverError.InvalidSignatureS) {
revert("ECDSA: invalid signature 's' value");
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature` or error string. This address can then be used for verification purposes.
*
* The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {toEthSignedMessageHash} on it.
*
* Documentation for signature generation:
* - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
* - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
*
* _Available since v4.3._
*/
function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError) {
if (signature.length == 65) {
bytes32 r;
bytes32 s;
uint8 v;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
/// @solidity memory-safe-assembly
assembly {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
return tryRecover(hash, v, r, s);
} else {
return (address(0), RecoverError.InvalidSignatureLength);
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature`. This address can then be used for verification purposes.
*
* The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {toEthSignedMessageHash} on it.
*/
function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
(address recovered, RecoverError error) = tryRecover(hash, signature);
_throwError(error);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
*
* See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures]
*
* _Available since v4.3._
*/
function tryRecover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address, RecoverError) {
bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
uint8 v = uint8((uint256(vs) >> 255) + 27);
return tryRecover(hash, v, r, s);
}
/**
* @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
*
* _Available since v4.2._
*/
function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) {
(address recovered, RecoverError error) = tryRecover(hash, r, vs);
_throwError(error);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `v`,
* `r` and `s` signature fields separately.
*
* _Available since v4.3._
*/
function tryRecover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address, RecoverError) {
// EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
// unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
// the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
// signatures from current libraries generate a unique signature with an s-value in the lower half order.
//
// If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
// with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
// vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
// these malleable signatures as well.
if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
return (address(0), RecoverError.InvalidSignatureS);
}
// If the signature is valid (and not malleable), return the signer address
address signer = ecrecover(hash, v, r, s);
if (signer == address(0)) {
return (address(0), RecoverError.InvalidSignature);
}
return (signer, RecoverError.NoError);
}
/**
* @dev Overload of {ECDSA-recover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
(address recovered, RecoverError error) = tryRecover(hash, v, r, s);
_throwError(error);
return recovered;
}
/**
* @dev Returns an Ethereum Signed Message, created from a `hash`. This
* produces hash corresponding to the one signed with the
* https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
* JSON-RPC method as part of EIP-191.
*
* See {recover}.
*/
function toEthSignedMessageHash(bytes32 hash) internal pure returns (bytes32 message) {
// 32 is the length in bytes of hash,
// enforced by the type signature above
/// @solidity memory-safe-assembly
assembly {
mstore(0x00, "\x19Ethereum Signed Message:\n32")
mstore(0x1c, hash)
message := keccak256(0x00, 0x3c)
}
}
/**
* @dev Returns an Ethereum Signed Message, created from `s`. This
* produces hash corresponding to the one signed with the
* https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
* JSON-RPC method as part of EIP-191.
*
* See {recover}.
*/
function toEthSignedMessageHash(bytes memory s) internal pure returns (bytes32) {
return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n", Strings.toString(s.length), s));
}
/**
* @dev Returns an Ethereum Signed Typed Data, created from a
* `domainSeparator` and a `structHash`. This produces hash corresponding
* to the one signed with the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`]
* JSON-RPC method as part of EIP-712.
*
* See {recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 data) {
/// @solidity memory-safe-assembly
assembly {
let ptr := mload(0x40)
mstore(ptr, "\x19\x01")
mstore(add(ptr, 0x02), domainSeparator)
mstore(add(ptr, 0x22), structHash)
data := keccak256(ptr, 0x42)
}
}
/**
* @dev Returns an Ethereum Signed Data with intended validator, created from a
* `validator` and `data` according to the version 0 of EIP-191.
*
* See {recover}.
*/
function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
return keccak256(abi.encodePacked("\x19\x00", validator, data));
}
}
// File: @openzeppelin/contracts@4.9.3/utils/StorageSlot.sol
// OpenZeppelin Contracts (last updated v4.9.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
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:
* ```solidity
* 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`, `uint256`._
* _Available since v4.9 for `string`, `bytes`._
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
/**
* @dev Returns an `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
}
// File: @openzeppelin/contracts@4.9.3/utils/ShortStrings.sol
// OpenZeppelin Contracts (last updated v4.9.0) (utils/ShortStrings.sol)
pragma solidity ^0.8.8;
// | string | 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
// | length | 0x BB |
type ShortString is bytes32;
/**
* @dev This library provides functions to convert short memory strings
* into a `ShortString` type that can be used as an immutable variable.
*
* Strings of arbitrary length can be optimized using this library if
* they are short enough (up to 31 bytes) by packing them with their
* length (1 byte) in a single EVM word (32 bytes). Additionally, a
* fallback mechanism can be used for every other case.
*
* Usage example:
*
* ```solidity
* contract Named {
* using ShortStrings for *;
*
* ShortString private immutable _name;
* string private _nameFallback;
*
* constructor(string memory contractName) {
* _name = contractName.toShortStringWithFallback(_nameFallback);
* }
*
* function name() external view returns (string memory) {
* return _name.toStringWithFallback(_nameFallback);
* }
* }
* ```
*/
library ShortStrings {
// Used as an identifier for strings longer than 31 bytes.
bytes32 private constant _FALLBACK_SENTINEL = 0x00000000000000000000000000000000000000000000000000000000000000FF;
error StringTooLong(string str);
error InvalidShortString();
/**
* @dev Encode a string of at most 31 chars into a `ShortString`.
*
* This will trigger a `StringTooLong` error is the input string is too long.
*/
function toShortString(string memory str) internal pure returns (ShortString) {
bytes memory bstr = bytes(str);
if (bstr.length > 31) {
revert StringTooLong(str);
}
return ShortString.wrap(bytes32(uint256(bytes32(bstr)) | bstr.length));
}
/**
* @dev Decode a `ShortString` back to a "normal" string.
*/
function toString(ShortString sstr) internal pure returns (string memory) {
uint256 len = byteLength(sstr);
// using `new string(len)` would work locally but is not memory safe.
string memory str = new string(32);
/// @solidity memory-safe-assembly
assembly {
mstore(str, len)
mstore(add(str, 0x20), sstr)
}
return str;
}
/**
* @dev Return the length of a `ShortString`.
*/
function byteLength(ShortString sstr) internal pure returns (uint256) {
uint256 result = uint256(ShortString.unwrap(sstr)) & 0xFF;
if (result > 31) {
revert InvalidShortString();
}
return result;
}
/**
* @dev Encode a string into a `ShortString`, or write it to storage if it is too long.
*/
function toShortStringWithFallback(string memory value, string storage store) internal returns (ShortString) {
if (bytes(value).length < 32) {
return toShortString(value);
} else {
StorageSlot.getStringSlot(store).value = value;
return ShortString.wrap(_FALLBACK_SENTINEL);
}
}
/**
* @dev Decode a string that was encoded to `ShortString` or written to storage using {setWithFallback}.
*/
function toStringWithFallback(ShortString value, string storage store) internal pure returns (string memory) {
if (ShortString.unwrap(value) != _FALLBACK_SENTINEL) {
return toString(value);
} else {
return store;
}
}
/**
* @dev Return the length of a string that was encoded to `ShortString` or written to storage using {setWithFallback}.
*
* WARNING: This will return the "byte length" of the string. This may not reflect the actual length in terms of
* actual characters as the UTF-8 encoding of a single character can span over multiple bytes.
*/
function byteLengthWithFallback(ShortString value, string storage store) internal view returns (uint256) {
if (ShortString.unwrap(value) != _FALLBACK_SENTINEL) {
return byteLength(value);
} else {
return bytes(store).length;
}
}
}
// File: @openzeppelin/contracts@4.9.3/interfaces/IERC5267.sol
// OpenZeppelin Contracts (last updated v4.9.0) (interfaces/IERC5267.sol)
pragma solidity ^0.8.0;
interface IERC5267 {
/**
* @dev MAY be emitted to signal that the domain could have changed.
*/
event EIP712DomainChanged();
/**
* @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
* signature.
*/
function eip712Domain()
external
view
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
);
}
// File: @openzeppelin/contracts@4.9.3/utils/cryptography/EIP712.sol
// OpenZeppelin Contracts (last updated v4.9.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.8;
/**
* @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data.
*
* The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible,
* thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding
* they need in their contracts using a combination of `abi.encode` and `keccak256`.
*
* This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
* scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
* ({_hashTypedDataV4}).
*
* The implementation of the domain separator was designed to be as efficient as possible while still properly updating
* the chain id to protect against replay attacks on an eventual fork of the chain.
*
* NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
* https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
*
* NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain
* separator of the implementation contract. This will cause the `_domainSeparatorV4` function to always rebuild the
* separator from the immutable values, which is cheaper than accessing a cached version in cold storage.
*
* _Available since v3.4._
*
* @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
*/
abstract contract EIP712 is IERC5267 {
using ShortStrings for *;
bytes32 private constant _TYPE_HASH =
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
// Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
// invalidate the cached domain separator if the chain id changes.
bytes32 private immutable _cachedDomainSeparator;
uint256 private immutable _cachedChainId;
address private immutable _cachedThis;
bytes32 private immutable _hashedName;
bytes32 private immutable _hashedVersion;
ShortString private immutable _name;
ShortString private immutable _version;
string private _nameFallback;
string private _versionFallback;
/**
* @dev Initializes the domain separator and parameter caches.
*
* The meaning of `name` and `version` is specified in
* https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]:
*
* - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
* - `version`: the current major version of the signing domain.
*
* NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
* contract upgrade].
*/
constructor(string memory name, string memory version) {
_name = name.toShortStringWithFallback(_nameFallback);
_version = version.toShortStringWithFallback(_versionFallback);
_hashedName = keccak256(bytes(name));
_hashedVersion = keccak256(bytes(version));
_cachedChainId = block.chainid;
_cachedDomainSeparator = _buildDomainSeparator();
_cachedThis = address(this);
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
if (address(this) == _cachedThis && block.chainid == _cachedChainId) {
return _cachedDomainSeparator;
} else {
return _buildDomainSeparator();
}
}
function _buildDomainSeparator() private view returns (bytes32) {
return keccak256(abi.encode(_TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));
}
/**
* @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
* function returns the hash of the fully encoded EIP712 message for this domain.
*
* This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
*
* ```solidity
* bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
* keccak256("Mail(address to,string contents)"),
* mailTo,
* keccak256(bytes(mailContents))
* )));
* address signer = ECDSA.recover(digest, signature);
* ```
*/
function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
return ECDSA.toTypedDataHash(_domainSeparatorV4(), structHash);
}
/**
* @dev See {EIP-5267}.
*
* _Available since v4.9._
*/
function eip712Domain()
public
view
virtual
override
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
return (
hex"0f", // 01111
_name.toStringWithFallback(_nameFallback),
_version.toStringWithFallback(_versionFallback),
block.chainid,
address(this),
bytes32(0),
new uint256[](0)
);
}
}
// File: @openzeppelin/contracts@4.9.3/utils/Counters.sol
// OpenZeppelin Contracts v4.4.1 (utils/Counters.sol)
pragma solidity ^0.8.0;
/**
* @title Counters
* @author Matt Condon (@shrugs)
* @dev Provides counters that can only be incremented, decremented or reset. This can be used e.g. to track the number
* of elements in a mapping, issuing ERC721 ids, or counting request ids.
*
* Include with `using Counters for Counters.Counter;`
*/
library Counters {
struct Counter {
// This variable should never be directly accessed by users of the library: interactions must be restricted to
// the library's function. As of Solidity v0.5.2, this cannot be enforced, though there is a proposal to add
// this feature: see https://github.com/ethereum/solidity/issues/4637
uint256 _value; // default: 0
}
function current(Counter storage counter) internal view returns (uint256) {
return counter._value;
}
function increment(Counter storage counter) internal {
unchecked {
counter._value += 1;
}
}
function decrement(Counter storage counter) internal {
uint256 value = counter._value;
require(value > 0, "Counter: decrement overflow");
unchecked {
counter._value = value - 1;
}
}
function reset(Counter storage counter) internal {
counter._value = 0;
}
}
// File: @openzeppelin/contracts@4.9.3/token/ERC20/extensions/ERC20Permit.sol
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/extensions/ERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Implementation 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.
*
* _Available since v3.4._
*/
abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712 {
using Counters for Counters.Counter;
mapping(address => Counters.Counter) private _nonces;
// solhint-disable-next-line var-name-mixedcase
bytes32 private constant _PERMIT_TYPEHASH =
keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)");
/**
* @dev In previous versions `_PERMIT_TYPEHASH` was declared as `immutable`.
* However, to ensure consistency with the upgradeable transpiler, we will continue
* to reserve a slot.
* @custom:oz-renamed-from _PERMIT_TYPEHASH
*/
// solhint-disable-next-line var-name-mixedcase
bytes32 private _PERMIT_TYPEHASH_DEPRECATED_SLOT;
/**
* @dev Initializes the {EIP712} domain separator using the `name` parameter, and setting `version` to `"1"`.
*
* It's a good idea to use the same `name` that is defined as the ERC20 token name.
*/
constructor(string memory name) EIP712(name, "1") {}
/**
* @dev See {IERC20Permit-permit}.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) public virtual override {
require(block.timestamp <= deadline, "ERC20Permit: expired deadline");
bytes32 structHash = keccak256(abi.encode(_PERMIT_TYPEHASH, owner, spender, value, _useNonce(owner), deadline));
bytes32 hash = _hashTypedDataV4(structHash);
address signer = ECDSA.recover(hash, v, r, s);
require(signer == owner, "ERC20Permit: invalid signature");
_approve(owner, spender, value);
}
/**
* @dev See {IERC20Permit-nonces}.
*/
function nonces(address owner) public view virtual override returns (uint256) {
return _nonces[owner].current();
}
/**
* @dev See {IERC20Permit-DOMAIN_SEPARATOR}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view override returns (bytes32) {
return _domainSeparatorV4();
}
/**
* @dev "Consume a nonce": return the current value and increment.
*
* _Available since v4.1._
*/
function _useNonce(address owner) internal virtual returns (uint256 current) {
Counters.Counter storage nonce = _nonces[owner];
current = nonce.current();
nonce.increment();
}
}
// File: @openzeppelin/contracts@4.9.3/access/Ownable.sol
// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// File: @openzeppelin/contracts@4.9.3/access/Ownable2Step.sol
// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module which provides access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2Step is Ownable {
address private _pendingOwner;
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() public virtual {
address sender = _msgSender();
require(pendingOwner() == sender, "Ownable2Step: caller is not the new owner");
_transferOwnership(sender);
}
}
// File: @openzeppelin/contracts@4.9.3/security/ReentrancyGuard.sol
// 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;
}
}
// File: Zeromoon.sol
pragma solidity 0.8.30;
/**
* @title ZeroMoon zETH - The Unbreakable Token
* @author ZeroMoon Development Team
* @notice A ETH-backed token with fair dividend distribution and refund mechanism
* @notice Survived Foundry (Forge):
* • 160,000,000+ unit fuzz cases
* • 200,000,000+ invariant calls
* • 20-step attack sequences
* • Zero failures. Ever.
* @dev Auditable, renounced, and battle-proven.
*
* Key Features:
* - ETH-backed token with 99.9% effective backing
* - Fair dividend distribution to EOA users only (contracts auto-excluded)
* - Direct refund mechanism at backing value
* - Controlled token burning (max 20% of total supply)
* - Fee structure: dev (5 BPS), dividend (5-10 BPS), reserve (7.5-15 BPS), burn (7.5 BPS when below limit)
* - Ownership renouncement for true decentralization
*
* Security Features:
* - ReentrancyGuard protection on all external calls
* - OpenZeppelin battle-tested contracts
* - Automatic contract detection for dividend exclusions
* - Precise fee calculations using Math.mulDiv
*
*/
contract ZeroMoon is ReentrancyGuard, ERC20, ERC20Permit, Ownable2Step {
// ============ Immutable Configuration ============
/// @notice Maximum token supply: 1.25 billion tokens
/// @dev Total supply is fixed at construction and reduced by burning
uint256 public immutable TOTAL_SUPPLY;
/// @notice Maximum tokens that can be burned (20% of total supply)
/// @dev Once reached, burning stops and reserve fee doubles
uint256 public immutable BURNING_LIMIT;
/// @notice Minimum ETH required for purchase (0.0001 ETH)
/// @dev Prevents dust attacks and ensures economically viable transactions
uint256 public immutable MINIMUM_PURCHASE_NATIVE;
/// @notice Base token price at launch (0.0001 ETH per token)
/// @dev Used for initial pricing before any tokens are in circulation
uint256 private immutable BASE_PRICE;
/// @notice Precision divisor for fee calculations (10000 = 100%)
/// @dev All BPS (basis points) fees are divided by this for percentage calculation
uint256 private constant PRECISION_DIVISOR = 10000;
/// @notice Effective backing numerator for refund calculations (999/1000 = 99.9%)
/// @dev Provides 99.9% backing ratio for refunds, ensuring protocol sustainability
uint256 private constant EFFECTIVE_BACKING_NUMERATOR = 999;
/// @notice Effective backing denominator for refund calculations
uint256 private constant EFFECTIVE_BACKING_DENOMINATOR = 1000;
// ============ Fee Structure (Basis Points) ============
/// @notice Buy transaction dev fee (5 BPS = 0.05%)
uint256 private immutable BUY_DEV_FEE_BPS;
/// @notice Buy transaction reserve fee (10 BPS = 0.10%)
uint256 private immutable BUY_RESERVE_FEE_BPS;
/// @notice Buy transaction reflection fee for dividends (10 BPS = 0.10%)
uint256 private immutable BUY_REFLECTION_FEE_BPS;
/// @notice Refund transaction dev fee (5 BPS = 0.05%)
uint256 private immutable REFUND_DEV_FEE_BPS;
/// @notice Refund transaction reflection fee for dividends (5 BPS = 0.05%)
uint256 private immutable REFUND_REFLECTION_FEE_BPS;
/// @notice Transfer transaction dev fee (5 BPS = 0.05%)
uint256 private immutable TRANSFER_DEV_FEE_BPS;
/// @notice Transfer transaction reflection fee for dividends (10 BPS = 0.10%)
uint256 private immutable TRANSFER_REFLECTION_FEE_BPS;
/// @notice Transfer transaction reserve fee (10 BPS = 0.10%)
uint256 private immutable TRANSFER_RESERVE_FEE_BPS;
/// @notice DEX swap dev fee (0 BPS = no fees on DEX swaps)
uint256 private immutable DEX_SWAP_DEV_FEE_BPS;
/// @notice DEX swap reflection fee (0 BPS = no fees on DEX swaps)
uint256 private immutable DEX_SWAP_REFLECTION_FEE_BPS;
/// @notice DEX swap reserve fee (0 BPS = no fees on DEX swaps)
uint256 private immutable DEX_SWAP_RESERVE_FEE_BPS;
// ============ State Variables ============
/// @notice Total tokens burned (contributes to deflationary mechanics)
/// @dev Increases with each refund until BURNING_LIMIT is reached
uint256 public totalBurned;
/// @notice Total tokens sold from initial supply
/// @dev Tracks cumulative token sales, cannot exceed TOTAL_SUPPLY
uint256 public tokensSold;
/// @notice Address receiving development fees
/// @dev Can be changed by owner, automatically excluded from fees
address private devAddress;
// ============ Dividend Tracking ============
/// @notice Magnitude for precise dividend calculations (2^128)
/// @dev Used to maintain precision in dividend per share calculations
uint256 private constant MAGNITUDE = 2**128;
/// @notice Magnified dividend per share for all holders
/// @dev Increases monotonically as dividends are distributed
uint256 private magnifiedDividendPerShare;
/// @notice Cumulative dividends distributed to all holders
/// @dev Tracks total reflection fees distributed as dividends
uint256 private totalDividendsDistributed;
/// @notice Last recorded dividend per share for each user
/// @dev Used to calculate pending dividends since last update
mapping(address => uint256) private lastDividendPerShare;
/// @notice Accumulated unclaimed dividends for each user
/// @dev Stored separately to allow claiming at user's convenience
mapping(address => uint256) private accumulatedDividends;
// ============ Fee Exemptions & Liquidity Detection ============
/// @notice Addresses excluded from all transfer fees
/// @dev Contract, owner, and dev addresses are auto-excluded
mapping(address => bool) private _isExcludedFromFee;
/// @notice Cached liquidity pair addresses for gas optimization
/// @dev Pairs detected via token0/token1 interface checks
mapping(address => bool) private _isLiquidityPair;
/// @notice Cached non-liquidity pair addresses for gas optimization
/// @dev Prevents repeated checks on regular contracts
mapping(address => bool) private _isNotLiquidityPair;
// ============ Custom Errors ============
/// @notice Thrown when zero address is provided where not allowed
error ZeroMoonAddress();
/// @notice Thrown when zero amount is provided where not allowed
error ZeroMoonAmount();
/// @notice Thrown when user has insufficient token balance
error InsufficientBalance();
/// @notice Thrown when insufficient ETH is provided or available
error InsufficientNative();
/// @notice Thrown when attempting refund with zero circulating supply
error NoTokensInCirculation();
/// @notice Thrown when ETH transfer to user fails
error NativeTransferFailed();
/// @notice Thrown when dividend calculation would overflow (unused but kept for safety)
error DividendsOverflow();
// ============ Enums ============
/// @notice Type of DEX swap operation
enum SwapType { BUY, SELL }
/// @notice Reason for fee exemption on transfer
enum ExemptionReason { REFUND, EXCLUDED_ADDRESS }
// ============ Events ============
/// @notice Emitted when tokens are purchased with ETH
/// @param buyer Address of the buyer
/// @param nativePaid Amount of ETH paid
/// @param zETHReceived Amount of zETH tokens received (after fees)
event Buy(address indexed buyer, uint256 nativePaid, uint256 zETHReceived);
/// @notice Emitted when tokens are refunded for ETH
/// @param refunder Address receiving the refund
/// @param zETHRefunded Amount of zETH tokens refunded
/// @param nativeReceived Amount of ETH received (after fees and backing calculation)
event Refund(address indexed refunder, uint256 zETHRefunded, uint256 nativeReceived);
/// @notice Emitted when regular transfer fees are applied
/// @param from Sender address
/// @param to Recipient address
/// @param originalAmount Original transfer amount before fees
/// @param devFee Development fee deducted
/// @param reflectionFee Reflection fee distributed as dividends
/// @param reserveFee Reserve fee kept in contract
/// @param netAmount Net amount received by recipient
event TransferFeeApplied(address indexed from, address indexed to, uint256 originalAmount, uint256 devFee, uint256 reflectionFee, uint256 reserveFee, uint256 netAmount);
/// @notice Emitted when DEX swap fees are applied
/// @param swapType Type of swap (BUY or SELL)
/// @param user User involved in the swap
/// @param originalAmount Original swap amount before fees
/// @param devFee Development fee deducted
/// @param reflectionFee Reflection fee distributed as dividends
/// @param reserveFee Reserve fee kept in contract
/// @param netAmount Net amount after fees
event SwapFeeApplied(SwapType swapType, address indexed user, uint256 originalAmount, uint256 devFee, uint256 reflectionFee, uint256 reserveFee, uint256 netAmount);
/// @notice Emitted when transfer is fee-exempt
/// @param from Sender address
/// @param to Recipient address
/// @param amount Transfer amount
/// @param reason Reason for fee exemption
event TransferFeeExempt(address indexed from, address indexed to, uint256 amount, ExemptionReason reason);
/// @notice Emitted when dividends are distributed to holders
/// @param amount Amount of dividends distributed
/// @param magnifiedDividendPerShare New magnified dividend per share value
event DividendsDistributed(uint256 amount, uint256 magnifiedDividendPerShare);
/// @notice Emitted when user claims accumulated dividends
/// @param user Address claiming dividends
/// @param amount Amount of dividends claimed
event DividendWithdrawn(address indexed user, uint256 amount);
/// @notice Emitted when a liquidity pair is detected and cached
/// @param pair Address of the detected liquidity pair
event LiquidityPairDetected(address indexed pair);
/// @notice Emitted when development address is changed
/// @param oldDevAddress Previous development address
/// @param newDevAddress New development address
event DevAddressChanged(address indexed oldDevAddress, address indexed newDevAddress);
/// @notice Emitted when fee exclusion status is set for an account
/// @param account Address whose status is being set
/// @param isExcluded Whether account is excluded from fees
event FeeExclusionSet(address indexed account, bool isExcluded);
/// @notice Initializes the ZeroMoon contract with configuration and initial ownership
/// @dev Mints total supply to contract, sets up fee exclusions, and optionally executes initial buy
/// @param _initialOwner Address that will own the contract (for ownership transfer/renouncement)
/// @param _devAddress Address that will receive development fees
constructor(address _initialOwner, address _devAddress) ERC20("ZeroMoon", "zETH") ERC20Permit("ZeroMoon") Ownable() payable {
if (_initialOwner == address(0)) revert ZeroMoonAddress();
if (_devAddress == address(0)) revert ZeroMoonAddress();
TOTAL_SUPPLY = 1250000000 * 1e18;
BURNING_LIMIT = TOTAL_SUPPLY / 5;
MINIMUM_PURCHASE_NATIVE = 0.0001 ether;
BASE_PRICE = 0.0001 ether;
BUY_DEV_FEE_BPS = 5;
BUY_RESERVE_FEE_BPS = 10;
BUY_REFLECTION_FEE_BPS = 10;
REFUND_DEV_FEE_BPS = 5;
REFUND_REFLECTION_FEE_BPS = 5;
TRANSFER_DEV_FEE_BPS = 5;
TRANSFER_REFLECTION_FEE_BPS = 10;
TRANSFER_RESERVE_FEE_BPS = 10;
DEX_SWAP_DEV_FEE_BPS = 0;
DEX_SWAP_REFLECTION_FEE_BPS = 0;
DEX_SWAP_RESERVE_FEE_BPS = 0;
devAddress = _devAddress;
_mint(address(this), TOTAL_SUPPLY);
_isExcludedFromFee[address(this)] = true;
_isExcludedFromFee[_initialOwner] = true;
_isExcludedFromFee[devAddress] = true;
if (msg.value != 0) {
_buy(_devAddress, msg.value);
}
_transferOwnership(_initialOwner);
}
/// @notice Returns the token balance of an account
/// @param account Address to query balance for
/// @return Token balance of the account
function balanceOf(address account) public view override returns (uint256) {
return super.balanceOf(account);
}
/// @notice Returns the current circulating supply (total supply minus burned tokens)
/// @return Current total supply after burns
/// @dev This decreases as tokens are burned through refunds (up to 20% maximum)
function totalSupply() public view override returns (uint256) {
return TOTAL_SUPPLY - totalBurned;
}
/// @notice Purchases zETH tokens with sent ETH
/// @dev Calls internal _buy function with msg.sender and msg.value
function buy() external payable {
_buy(msg.sender, msg.value);
}
/// @notice Fallback function to purchase tokens when ETH is sent directly
/// @dev Enables simple ETH sends to buy tokens
receive() external payable {
_buy(msg.sender, msg.value);
}
/// @notice Internal transfer function with dividend tracking updates
/// @dev Updates dividend tracking for both sender and recipient before balance changes
/// @param from Sender address
/// @param to Recipient address
/// @param amount Amount to transfer
function _transfer(address from, address to, uint256 amount) internal override {
// Update dividend tracking BEFORE balance changes
if (from != address(0) && !isContract(from)) {
_updateUserDividendTracking(from);
}
if (to != address(0) && !isContract(to)) {
_updateUserDividendTracking(to);
}
_update(from, to, amount);
}
/// @notice Core transfer logic with fee handling
/// @dev Routes to refund, fee-exempt, or taxed transfer based on recipient and exemption status
/// @param from Sender address
/// @param to Recipient address
/// @param amount Amount to transfer
function _update(address from, address to, uint256 amount) private {
if (from == address(0)) revert ZeroMoonAddress();
if (to == address(0)) revert ZeroMoonAddress();
if (amount == 0) revert ZeroMoonAmount();
bool isExempt = _isExcludedFromFee[from] || _isExcludedFromFee[to];
if (to == address(this)) {
super._transfer(from, to, amount);
_handleRefund(from, amount);
emit TransferFeeExempt(from, to, amount, ExemptionReason.REFUND);
} else if (isExempt) {
super._transfer(from, to, amount);
emit TransferFeeExempt(from, to, amount, ExemptionReason.EXCLUDED_ADDRESS);
} else {
_handleTaxedTransfer(from, to, amount);
}
}
/// @notice Detects if an address is a liquidity pair contract
/// @dev Uses interface detection (token0/token1) and caches result for gas optimization
/// @param addr Address to check
/// @return True if address is a liquidity pair, false otherwise
function isLiquidityPair(address addr) internal returns (bool) {
if (addr.code.length == 0) {
return false;
}
if (_isLiquidityPair[addr]) return true;
if (_isNotLiquidityPair[addr]) return false;
(bool s0, bytes memory d0) = addr.staticcall(abi.encodeWithSignature("token0()"));
(bool s1, bytes memory d1) = addr.staticcall(abi.encodeWithSignature("token1()"));
if (s0 && s1 && d0.length == 32 && d1.length == 32) {
address token0 = abi.decode(d0, (address));
address token1 = abi.decode(d1, (address));
if ((token0 == address(this) || token1 == address(this)) && token0 != token1) {
_cacheLiquidityPair(addr);
return true;
}
}
_isNotLiquidityPair[addr] = true;
return false;
}
/// @notice Caches a detected liquidity pair for future gas optimization
/// @param addr Address of the liquidity pair to cache
function _cacheLiquidityPair(address addr) private {
_isLiquidityPair[addr] = true;
emit LiquidityPairDetected(addr);
}
/// @notice Handles transfers with fee application
/// @dev Applies different fee structures for DEX swaps vs regular transfers
/// @param from Sender address
/// @param to Recipient address
/// @param amount Amount to transfer (before fees)
function _handleTaxedTransfer(address from, address to, uint256 amount) private {
if (balanceOf(from) < amount) revert InsufficientBalance();
bool isDexSwap = (isContract(from) && isLiquidityPair(from)) || (isContract(to) && isLiquidityPair(to));
uint256 devFeeBps;
uint256 reflectionFeeBps;
uint256 reserveFeeBps;
if (isDexSwap) {
devFeeBps = DEX_SWAP_DEV_FEE_BPS;
reflectionFeeBps = DEX_SWAP_REFLECTION_FEE_BPS;
reserveFeeBps = DEX_SWAP_RESERVE_FEE_BPS;
} else {
devFeeBps = TRANSFER_DEV_FEE_BPS;
reflectionFeeBps = TRANSFER_REFLECTION_FEE_BPS;
reserveFeeBps = TRANSFER_RESERVE_FEE_BPS;
}
uint256 devFee = Math.mulDiv(amount, devFeeBps, 10000);
uint256 reflectionFee = Math.mulDiv(amount, reflectionFeeBps, 10000);
uint256 reserveFee = Math.mulDiv(amount, reserveFeeBps, 10000);
uint256 netAmount;
unchecked {
netAmount = amount - devFee - reflectionFee - reserveFee;
}
super._transfer(from, address(this), amount);
// Distribute dividends BEFORE transferring to recipient
// This prevents the recipient from earning dividends on newly received tokens from this transfer
_distributeDividends(reflectionFee);
if (netAmount != 0) {
super._transfer(address(this), to, netAmount);
}
if (devFee != 0) {
super._transfer(address(this), devAddress, devFee);
}
if (isDexSwap) {
bool isSell = isContract(to) && isLiquidityPair(to);
address user = isSell ? from : to;
emit SwapFeeApplied(isSell ? SwapType.SELL : SwapType.BUY, user, amount, devFee, reflectionFee, reserveFee, netAmount);
} else {
emit TransferFeeApplied(from, to, amount, devFee, reflectionFee, reserveFee, netAmount);
}
}
/// @notice Internal function to purchase zETH tokens with ETH
/// @dev Protected by nonReentrant. Calculates tokens based on current price, applies fees, and distributes
/// @param buyer Address receiving the tokens
/// @param amountNative Amount of ETH being used to purchase
/// @custom:security Buyer is prevented from earning dividends on their own purchase via lastDividendPerShare update
/// @custom:testing Validated with 160M+ fuzz test cases across all price ranges
function _buy(address buyer, uint256 amountNative) private nonReentrant {
if (amountNative < MINIMUM_PURCHASE_NATIVE) revert InsufficientNative();
uint256 balanceBefore = address(this).balance - amountNative;
uint256 zETHToPurchase = _getzETHForNative(amountNative, balanceBefore);
if (zETHToPurchase == 0) revert InsufficientNative();
if (tokensSold + zETHToPurchase > TOTAL_SUPPLY) revert InsufficientBalance();
uint256 devFee = Math.mulDiv(zETHToPurchase, BUY_DEV_FEE_BPS, 10000);
uint256 reserveFee = Math.mulDiv(zETHToPurchase, BUY_RESERVE_FEE_BPS, 10000);
uint256 reflectionFee = Math.mulDiv(zETHToPurchase, BUY_REFLECTION_FEE_BPS, 10000);
uint256 zETHToUser;
unchecked {
zETHToUser = zETHToPurchase - devFee - reserveFee - reflectionFee;
}
tokensSold = tokensSold + zETHToPurchase;
// Distribute dividends BEFORE transferring tokens to buyer
// This prevents the buyer from earning dividends on newly purchased tokens from their own buy fee
_distributeDividends(reflectionFee);
// CRITICAL FIX: Mark buyer as "caught up" to current dividend distribution
// This prevents them from retroactively earning dividends from their own purchase
if (!isContract(buyer)) {
lastDividendPerShare[buyer] = magnifiedDividendPerShare;
}
super._transfer(address(this), devAddress, devFee);
super._transfer(address(this), buyer, zETHToUser);
emit Buy(buyer, amountNative, zETHToUser);
}
/// @notice Internal function to handle token refunds for ETH
/// @dev Protected by nonReentrant. Calculates ETH return based on 99.9% backing, applies fees, handles burning
/// @param sender Address receiving the ETH refund
/// @param zETHAmount Amount of zETH tokens being refunded
/// @custom:security Minimum refund of 1 token prevents rounding exploits
/// @custom:security Uses Math.mulDiv for precision-safe division
/// @custom:testing Validated with 200M+ invariant calls including complex refund sequences
function _handleRefund(address sender, uint256 zETHAmount) private nonReentrant {
if (zETHAmount == 0) revert ZeroMoonAmount();
// Minimum refund: 1 zETH token (same economic threshold as minimum buy)
// At launch: 0.0001 ETH buys ~1 token, so 1 token refunds to ~0.0001 ETH ($0.40 at $4k ETH)
if (zETHAmount < 1 ether) revert InsufficientBalance();
uint256 _totalBurned = totalBurned;
uint256 devFeezETH = Math.mulDiv(zETHAmount, REFUND_DEV_FEE_BPS, 10000);
uint256 reflectionFeezETH = Math.mulDiv(zETHAmount, REFUND_REFLECTION_FEE_BPS, 10000);
uint256 burnFeezETH = (_totalBurned < BURNING_LIMIT) ? Math.mulDiv(zETHAmount, 75, 100000) : 0;
uint256 reserveFeezETH = (_totalBurned < BURNING_LIMIT) ? Math.mulDiv(zETHAmount, 75, 100000) : Math.mulDiv(zETHAmount, 150, 100000);
uint256 zETHForUserRefund;
unchecked {
zETHForUserRefund = zETHAmount - devFeezETH - reflectionFeezETH - burnFeezETH - reserveFeezETH;
}
uint256 contractBalance = balanceOf(address(this));
uint256 currentCirculatingSupply = (TOTAL_SUPPLY - _totalBurned) - contractBalance + zETHAmount;
if (currentCirculatingSupply == 0) revert NoTokensInCirculation();
uint256 effectiveBacking = (address(this).balance * EFFECTIVE_BACKING_NUMERATOR) / EFFECTIVE_BACKING_DENOMINATOR;
// FIX: Use Math.mulDiv to prevent precision loss on division
uint256 grossNativeValue = Math.mulDiv(zETHForUserRefund, effectiveBacking, currentCirculatingSupply);
uint256 nativeToUser = grossNativeValue;
if (address(this).balance < nativeToUser) revert InsufficientNative();
if (devFeezETH != 0) {
super._transfer(address(this), devAddress, devFeezETH);
}
if (burnFeezETH != 0 && _totalBurned < BURNING_LIMIT) {
uint256 remainingToBurn = BURNING_LIMIT - _totalBurned;
if (burnFeezETH > remainingToBurn) {
burnFeezETH = remainingToBurn;
}
if (burnFeezETH != 0) {
_burn(address(this), burnFeezETH);
totalBurned = totalBurned + burnFeezETH;
}
}
_distributeDividends(reflectionFeezETH);
emit Refund(sender, zETHAmount, nativeToUser);
(bool success, ) = sender.call{value: nativeToUser}("");
if (!success) revert NativeTransferFailed();
}
/// @notice Distributes reflection fees as dividends to all holders
/// @dev Increases magnifiedDividendPerShare proportionally to circulating supply
/// @param amount Amount of tokens to distribute as dividends
/// @custom:security Only EOA holders receive dividends (contracts auto-excluded)
function _distributeDividends(uint256 amount) private {
if (amount == 0) return;
uint256 circulatingSupply = getCirculatingSupply();
if (circulatingSupply == 0) return;
uint256 dividendPerShare = (amount * MAGNITUDE) / circulatingSupply;
magnifiedDividendPerShare += dividendPerShare;
totalDividendsDistributed += amount;
emit DividendsDistributed(amount, magnifiedDividendPerShare);
}
/// @notice Calculates the circulating supply (excludes contract's unsold tokens)
/// @return Circulating supply available for dividend calculations
/// @dev Used for accurate dividend distribution calculations
function getCirculatingSupply() private view returns (uint256) {
uint256 total = totalSupply();
uint256 contractBalance = balanceOf(address(this)); // Contract's unsold tokens
return total - contractBalance;
}
/// @notice Updates dividend tracking for a user before balance changes
/// @dev Calculates and accumulates pending dividends, updates tracking pointer
/// @param user Address to update dividend tracking for
/// @custom:security Contracts are automatically excluded from dividend tracking
function _updateUserDividendTracking(address user) private {
// Exclude contracts from dividend tracking
if (isContract(user)) return;
uint256 userBalance = balanceOf(user);
uint256 currentDividendPerShare = magnifiedDividendPerShare;
uint256 lastUserDividendPerShare = lastDividendPerShare[user];
// Calculate and accumulate dividends if user has balance
if (userBalance > 0 && currentDividendPerShare > lastUserDividendPerShare) {
uint256 dividendDifference = currentDividendPerShare - lastUserDividendPerShare;
uint256 newDividends = (userBalance * dividendDifference) / MAGNITUDE;
if (newDividends > 0) {
accumulatedDividends[user] += newDividends;
}
}
// ALWAYS update lastDividendPerShare to keep tracking synchronized
// This prevents stale data when user's balance goes to 0 and back
lastDividendPerShare[user] = currentDividendPerShare;
}
/// @notice Allows users to claim their accumulated dividends
/// @dev Protected by nonReentrant. Updates tracking, transfers accumulated dividends to user
/// @custom:security Contracts cannot claim dividends
/// @custom:testing Validated through 10M+ claim sequences in invariant tests
function claimDividends() external nonReentrant {
address user = msg.sender;
// Exclude contracts from dividend claiming
if (isContract(user)) return;
uint256 userBalance = balanceOf(user);
uint256 currentDividendPerShare = magnifiedDividendPerShare;
uint256 lastUserDividendPerShare = lastDividendPerShare[user];
// Calculate and accumulate dividends if user has balance
if (userBalance > 0 && currentDividendPerShare > lastUserDividendPerShare) {
uint256 dividendDifference = currentDividendPerShare - lastUserDividendPerShare;
uint256 newDividends = (userBalance * dividendDifference) / MAGNITUDE;
if (newDividends > 0) {
accumulatedDividends[user] += newDividends;
}
}
// ALWAYS update lastDividendPerShare to keep tracking synchronized
lastDividendPerShare[user] = currentDividendPerShare;
// Transfer accumulated dividends to user
uint256 totalAccumulated = accumulatedDividends[user];
if (totalAccumulated > 0) {
accumulatedDividends[user] = 0;
super._transfer(address(this), user, totalAccumulated);
emit DividendWithdrawn(user, totalAccumulated);
}
}
/// @notice Returns the pending (unclaimed) dividends for a user
/// @param user Address to query pending dividends for
/// @return Amount of unclaimed dividends available
/// @dev Calculates based on balance and dividend per share delta
function pendingDividends(address user) external view returns (uint256) {
if (isContract(user)) return 0;
uint256 userBalance = balanceOf(user);
if (userBalance == 0) return accumulatedDividends[user];
uint256 currentDividendPerShare = magnifiedDividendPerShare;
uint256 lastUserDividendPerShare = lastDividendPerShare[user];
if (currentDividendPerShare > lastUserDividendPerShare) {
uint256 dividendDifference = currentDividendPerShare - lastUserDividendPerShare;
uint256 newDividends = (userBalance * dividendDifference) / MAGNITUDE;
return accumulatedDividends[user] + newDividends;
}
return accumulatedDividends[user];
}
/// @notice Calculates zETH tokens receivable for a given ETH amount
/// @param nativeAmount Amount of ETH to query
/// @return Amount of zETH tokens that would be received (before fees)
/// @dev Used by frontends to preview buy amounts
function calculatezETHForNative(uint256 nativeAmount) public view returns (uint256) {
return _getzETHForNative(nativeAmount, address(this).balance);
}
/// @notice Calculates ETH receivable for a given zETH refund amount
/// @param zETHAmount Amount of zETH tokens to query
/// @return Amount of ETH that would be received (after fees and backing calculation)
/// @dev Used by frontends to preview refund amounts. Returns 0 for amounts below 1 token minimum
/// @custom:security Uses same fee and backing logic as actual refund execution
function calculateNativeForZETH(uint256 zETHAmount) public view returns (uint256) {
if (zETHAmount == 0) return 0;
// Match the minimum refund check in _handleRefund
if (zETHAmount < 1 ether) return 0;
uint256 _totalBurned = totalBurned;
// Calculate fees (same as _handleRefund)
uint256 devFeezETH = Math.mulDiv(zETHAmount, REFUND_DEV_FEE_BPS, 10000);
uint256 reflectionFeezETH = Math.mulDiv(zETHAmount, REFUND_REFLECTION_FEE_BPS, 10000);
uint256 burnFeezETH = (_totalBurned < BURNING_LIMIT) ? Math.mulDiv(zETHAmount, 75, 100000) : 0;
uint256 reserveFeezETH = (_totalBurned < BURNING_LIMIT) ? Math.mulDiv(zETHAmount, 75, 100000) : Math.mulDiv(zETHAmount, 150, 100000);
uint256 zETHForUserRefund;
unchecked {
zETHForUserRefund = zETHAmount - devFeezETH - reflectionFeezETH - burnFeezETH - reserveFeezETH;
}
uint256 contractBalance = balanceOf(address(this));
uint256 currentCirculatingSupply = (TOTAL_SUPPLY - _totalBurned) - contractBalance + zETHAmount;
if (currentCirculatingSupply == 0) return 0;
uint256 effectiveBacking = (address(this).balance * EFFECTIVE_BACKING_NUMERATOR) / EFFECTIVE_BACKING_DENOMINATOR;
// FIX: Use Math.mulDiv to prevent precision loss on division
uint256 nativeToUser = Math.mulDiv(zETHForUserRefund, effectiveBacking, currentCirculatingSupply);
return nativeToUser;
}
/// @notice Internal function to calculate zETH tokens for ETH amount
/// @dev Uses dynamic pricing: base price at launch, then refund price + 0.1% markup
/// @param nativeAmount Amount of ETH
/// @param balanceBefore Contract ETH balance before this transaction
/// @return Amount of zETH tokens (capped at available supply)
function _getzETHForNative(uint256 nativeAmount, uint256 balanceBefore) private view returns (uint256) {
if (nativeAmount == 0) return 0;
uint256 availableToSell = balanceOf(address(this));
if (availableToSell == 0) return 0;
uint256 circulating = totalSupply() - availableToSell;
uint256 pricePerToken;
if (circulating == 0 || balanceBefore == 0) {
pricePerToken = BASE_PRICE;
} else {
uint256 refundPrice = (balanceBefore * 1e18) / circulating;
pricePerToken = (refundPrice * 10010) / PRECISION_DIVISOR;
}
uint256 tokensToPurchase = (nativeAmount * 1e18) / pricePerToken;
return Math.min(tokensToPurchase, availableToSell);
}
/// @notice Detects if an address is a contract (DEX, router, lending protocol, etc.)
/// @dev Uses multiple interface checks to identify various contract types
/// @param _addr Address to check
/// @return True if address is identified as a contract, false for EOAs
/// @custom:security Used to auto-exclude contracts from dividend distribution
function isContract(address _addr) internal view returns (bool) {
if (_addr.code.length == 0) return false;
(bool s0, bytes memory d0) = _addr.staticcall(abi.encodeWithSignature("token0()"));
(bool s1, bytes memory d1) = _addr.staticcall(abi.encodeWithSignature("token1()"));
if (s0 && s1 && d0.length == 32 && d1.length == 32) {
return true; // It's a DEX pair contract
}
(bool s2, ) = _addr.staticcall(abi.encodeWithSignature("factory()"));
if (s2) return true; // Router contract
(bool s3, ) = _addr.staticcall(abi.encodeWithSignature("getReserves()"));
if (s3) return true; // Pair contract with reserves
(bool s4, ) = _addr.staticcall(abi.encodeWithSignature("getPair(address,address)", address(0), address(0)));
if (s4) return true; // DEX factory contract
(bool s5, ) = _addr.staticcall(abi.encodeWithSignature("swap(address,uint256,uint256,uint256,bytes)", address(0), 0, 0, 0, ""));
if (s5) return true; // Aggregator/swapper contract
(bool s6, ) = _addr.staticcall(abi.encodeWithSignature("supply(address,uint256,address,uint16,uint256)", address(0), 0, address(0), 0, 0));
if (s6) return true; // Lending protocol contract
(bool s7, ) = _addr.staticcall(abi.encodeWithSignature("deposit(uint256)", 0));
if (s7) return true; // Yield farm/staking contract
(bool s8, ) = _addr.staticcall(abi.encodeWithSignature("sendToChain(address,uint256,uint256)", address(0), 0, 0));
if (s8) return true; // Bridge/cross-chain contract
return false;
}
/// @notice Changes the development fee recipient address
/// @dev Only callable by owner. Automatically updates fee exclusions
/// @param _devAddress New development address
function setDevAddress(address _devAddress) external onlyOwner {
if (_devAddress == address(0)) revert ZeroMoonAddress();
address oldDevAddress = devAddress;
_isExcludedFromFee[devAddress] = false;
devAddress = _devAddress;
_isExcludedFromFee[devAddress] = true;
emit DevAddressChanged(oldDevAddress, _devAddress);
}
/// @notice Sets fee exclusion status for an account
/// @dev Only callable by owner
/// @param account Address to set exclusion for
/// @param isExcluded Whether to exclude from fees
function excludeFromFee(address account, bool isExcluded) external onlyOwner {
if (account == address(0)) revert ZeroMoonAddress();
_isExcludedFromFee[account] = isExcluded;
emit FeeExclusionSet(account, isExcluded);
}
/// @notice Returns total dividends distributed since inception
/// @return Cumulative dividend amount
function getTotalDividendsDistributed() external view returns (uint256) {
return totalDividendsDistributed;
}
/// @notice Returns current magnified dividend per share
/// @return Current magnifiedDividendPerShare value
/// @dev Used for external integrations and analytics
function getMagnifiedDividendPerShare() external view returns (uint256) {
return magnifiedDividendPerShare;
}
/// @notice Returns current circulating supply (public view function)
/// @return Circulating supply (total minus contract balance)
function getCirculatingSupplyPublic() external view returns (uint256) {
return getCirculatingSupply();
}
/// @notice Returns comprehensive dividend information for a user
/// @param user Address to query
/// @return balance User's token balance
/// @return userLastDividendPerShare User's last recorded dividend per share
/// @return userAccumulatedDividends User's accumulated unclaimed dividends
/// @return currentDividendPerShare Current global dividend per share
/// @return isUserContract Whether the address is identified as a contract
function getUserDividendInfo(address user) external view returns (
uint256 balance,
uint256 userLastDividendPerShare,
uint256 userAccumulatedDividends,
uint256 currentDividendPerShare,
bool isUserContract
) {
return (
balanceOf(user),
lastDividendPerShare[user],
accumulatedDividends[user],
magnifiedDividendPerShare,
isContract(user)
);
}
/// @notice Increases the allowance granted to a spender
/// @param spender Address to increase allowance for
/// @param addedValue Amount to add to current allowance
/// @return True if successful
function increaseAllowance(address spender, uint256 addedValue) public virtual override returns (bool) {
address owner = _msgSender();
_approve(owner, spender, allowance(owner, spender) + addedValue);
return true;
}
/// @notice Decreases the allowance granted to a spender
/// @param spender Address to decrease allowance for
/// @param subtractedValue Amount to subtract from current allowance
/// @return True if successful
/// @dev Reverts if subtractedValue exceeds current allowance
function decreaseAllowance(address spender, uint256 subtractedValue) public virtual override returns (bool) {
address owner = _msgSender();
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < subtractedValue) revert InsufficientBalance();
unchecked {
_approve(owner, spender, currentAllowance - subtractedValue);
}
return true;
}
}