// File: @openzeppelin/contracts/access/Ownable.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable.sol)

pragma solidity ^0.8.0;

import "../utils/Context.sol";

/**
 * @dev Contract module which provides a basic access control mechanism, where
 * there is an account (an owner) that can be granted exclusive access to
 * specific functions.
 *
 * By default, the owner account will be the one that deploys the contract. This
 * can later be changed with {transferOwnership}.
 *
 * This module is used through inheritance. It will make available the modifier
 * `onlyOwner`, which can be applied to your functions to restrict their use to
 * the owner.
 */
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/security/Pausable.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (security/Pausable.sol)

pragma solidity ^0.8.0;

import "../utils/Context.sol";

/**
 * @dev Contract module which allows children to implement an emergency stop
 * mechanism that can be triggered by an authorized account.
 *
 * This module is used through inheritance. It will make available the
 * modifiers `whenNotPaused` and `whenPaused`, which can be applied to
 * the functions of your contract. Note that they will not be pausable by
 * simply including this module, only once the modifiers are put in place.
 */
abstract contract Pausable is Context {
    /**
     * @dev Emitted when the pause is triggered by `account`.
     */
    event Paused(address account);

    /**
     * @dev Emitted when the pause is lifted by `account`.
     */
    event Unpaused(address account);

    bool private _paused;

    /**
     * @dev Initializes the contract in unpaused state.
     */
    constructor() {
        _paused = false;
    }

    /**
     * @dev Modifier to make a function callable only when the contract is not paused.
     *
     * Requirements:
     *
     * - The contract must not be paused.
     */
    modifier whenNotPaused() {
        _requireNotPaused();
        _;
    }

    /**
     * @dev Modifier to make a function callable only when the contract is paused.
     *
     * Requirements:
     *
     * - The contract must be paused.
     */
    modifier whenPaused() {
        _requirePaused();
        _;
    }

    /**
     * @dev Returns true if the contract is paused, and false otherwise.
     */
    function paused() public view virtual returns (bool) {
        return _paused;
    }

    /**
     * @dev Throws if the contract is paused.
     */
    function _requireNotPaused() internal view virtual {
        require(!paused(), "Pausable: paused");
    }

    /**
     * @dev Throws if the contract is not paused.
     */
    function _requirePaused() internal view virtual {
        require(paused(), "Pausable: not paused");
    }

    /**
     * @dev Triggers stopped state.
     *
     * Requirements:
     *
     * - The contract must not be paused.
     */
    function _pause() internal virtual whenNotPaused {
        _paused = true;
        emit Paused(_msgSender());
    }

    /**
     * @dev Returns to normal state.
     *
     * Requirements:
     *
     * - The contract must be paused.
     */
    function _unpause() internal virtual whenPaused {
        _paused = false;
        emit Unpaused(_msgSender());
    }
}

// File: @openzeppelin/contracts/security/ReentrancyGuard.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)

pragma solidity ^0.8.0;

/**
 * @dev Contract module that helps prevent reentrant calls to a function.
 *
 * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
 * available, which can be applied to functions to make sure there are no nested
 * (reentrant) calls to them.
 *
 * Note that because there is a single `nonReentrant` guard, functions marked as
 * `nonReentrant` may not call one another. This can be worked around by making
 * those functions `private`, and then adding `external` `nonReentrant` entry
 * points to them.
 *
 * TIP: If you would like to learn more about reentrancy and alternative ways
 * to protect against it, check out our blog post
 * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
 */
abstract contract ReentrancyGuard {
    // Booleans are more expensive than uint256 or any type that takes up a full
    // word because each write operation emits an extra SLOAD to first read the
    // slot's contents, replace the bits taken up by the boolean, and then write
    // back. This is the compiler's defense against contract upgrades and
    // pointer aliasing, and it cannot be disabled.

    // The values being non-zero value makes deployment a bit more expensive,
    // but in exchange the refund on every call to nonReentrant will be lower in
    // amount. Since refunds are capped to a percentage of the total
    // transaction's gas, it is best to keep them low in cases like this one, to
    // increase the likelihood of the full refund coming into effect.
    uint256 private constant _NOT_ENTERED = 1;
    uint256 private constant _ENTERED = 2;

    uint256 private _status;

    constructor() {
        _status = _NOT_ENTERED;
    }

    /**
     * @dev Prevents a contract from calling itself, directly or indirectly.
     * Calling a `nonReentrant` function from another `nonReentrant`
     * function is not supported. It is possible to prevent this from happening
     * by making the `nonReentrant` function external, and making it call a
     * `private` function that does the actual work.
     */
    modifier nonReentrant() {
        _nonReentrantBefore();
        _;
        _nonReentrantAfter();
    }

    function _nonReentrantBefore() private {
        // On the first call to nonReentrant, _status will be _NOT_ENTERED
        require(_status != _ENTERED, "ReentrancyGuard: reentrant call");

        // Any calls to nonReentrant after this point will fail
        _status = _ENTERED;
    }

    function _nonReentrantAfter() private {
        // By storing the original value once again, a refund is triggered (see
        // https://eips.ethereum.org/EIPS/eip-2200)
        _status = _NOT_ENTERED;
    }

    /**
     * @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
     * `nonReentrant` function in the call stack.
     */
    function _reentrancyGuardEntered() internal view returns (bool) {
        return _status == _ENTERED;
    }
}

// File: @openzeppelin/contracts/utils/Context.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)

pragma solidity ^0.8.0;

/**
 * @dev Provides information about the current execution context, including the
 * sender of the transaction and its data. While these are generally available
 * via msg.sender and msg.data, they should not be accessed in such a direct
 * manner, since when dealing with meta-transactions the account sending and
 * paying for execution may not be the actual sender (as far as an application
 * is concerned).
 *
 * This contract is only required for intermediate, library-like contracts.
 */
abstract contract Context {
    function _msgSender() internal view virtual returns (address) {
        return msg.sender;
    }

    function _msgData() internal view virtual returns (bytes calldata) {
        return msg.data;
    }
}

// File: @openzeppelin/contracts/utils/cryptography/ECDSA.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/cryptography/ECDSA.sol)

pragma solidity ^0.8.0;

import "../Strings.sol";

/**
 * @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/utils/math/Math.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/math/Math.sol)

pragma solidity ^0.8.0;

/**
 * @dev Standard math utilities missing in the Solidity language.
 */
library 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/utils/math/SignedMath.sol



// SPDX-License-Identifier: MIT
// 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/utils/Strings.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Strings.sol)

pragma solidity ^0.8.0;

import "./math/Math.sol";
import "./math/SignedMath.sol";

/**
 * @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: contracts/admin/IAdminBeaconUpgradeable.sol



// SPDX-License-Identifier: MIT

pragma solidity ^0.8.17;

interface IAdminBeaconUpgradeable {
  function isAdmin(address account) external view returns (bool);
}
// File: contracts/admin/UseAdminBeacon.sol



// SPDX-License-Identifier: MIT

pragma solidity ^0.8.17;

import '@openzeppelin/contracts/access/Ownable.sol';

import "./IAdminBeaconUpgradeable.sol";

contract UseAdminBeacon is Ownable {

  /// @notice Emitted when a non-admin tries to call an admin function
  error OnlyAdmin();

  error OnlyAdminOrOwner();

  IAdminBeaconUpgradeable public adminBeacon;

  modifier onlyAdmin() {
    if (!_isAdmin(msg.sender)) revert OnlyAdmin();
    _;
  }

  modifier onlyAdminOrOwner() {
    if (!_isAdmin(msg.sender) && msg.sender != owner()) revert OnlyAdminOrOwner();
    _;
  }

  function _isAdmin(address _address) internal view returns (bool) {
    return adminBeacon.isAdmin(_address);
  }

  function _setAdminBeacon(IAdminBeaconUpgradeable _adminBeacon) internal {
    adminBeacon = _adminBeacon;
  }

  function setAdminBeacon(IAdminBeaconUpgradeable _adminBeacon) public virtual onlyOwner {
    _setAdminBeacon(_adminBeacon);
  }
}
// File: contracts/minters/utils/IDelegationRegistry.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// ░██╗░░░░░░░██╗░██╗░██╗░░░░░░██████╗░░██╗░░██╗░██╗░░░██╗░███████╗
// ░██║░░██╗░░██║░██║░██║░░░░░░██╔══██╗░╚██╗██╔╝░╚██╗░██╔╝░╚════██║
// ░╚██╗████╗██╔╝░██║░██║░░░░░░██║░░██║░░╚███╔╝░░░╚████╔╝░░░░███╔═╝
// ░░████╔═████║░░██║░██║░░░░░░██║░░██║░░██╔██╗░░░░╚██╔╝░░░██╔══╝░░
// ░░╚██╔╝░╚██╔╝░░██║░███████╗░██████╔╝░██╔╝╚██╗░░░░██║░░░░███████╗
// ░░░╚═╝░░░╚═╝░░░╚═╝░╚══════╝░╚═════╝░░╚═╝░░╚═╝░░░░╚═╝░░░░╚══════╝

pragma solidity ^0.8.17;

interface IDelegationRegistry {
    /** @notice Returns true if the address is delegated to act on your behalf for a token contract or an entire vault
     * @param delegate The hotwallet to act on your behalf
     * @param contract_ The address for the contract you're delegating
     * @param vault The cold wallet who issued the delegation
     */
    function checkDelegateForContract(
        address delegate,
        address vault,
        address contract_
    ) external view returns (bool);
}

// File: contracts/minters/utils/IOasis.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// IOasis.sol - Simplified interface for the Oasis NFT contract

pragma solidity ^0.8.17;

interface IOasis {
    function balanceOf(address _address) external view returns (uint256);

    function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);
}
// File: contracts/minters/utils/ISanctionsList.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// ISanctionsList.sol - Simplified interface for the SanctionsList contract

pragma solidity ^0.8.17;

interface ISanctionsList {
    function isSanctioned(address addr) external view returns (bool);
}
// File: contracts/minters/utils/PresaleMintable/IPresaleMintableMulti.sol



// SPDX-License-Identifier: GPL-3.0-or-later

pragma solidity ^0.8.17;

interface IPresaleMintableMulti {
  function presaleMint(uint256 _id, address _receiver, uint256 _amount) external payable;
}
// File: contracts/minters/utils/PresaleMintable/IPresaleMintableSingle.sol



// SPDX-License-Identifier: GPL-3.0-or-later

pragma solidity ^0.8.17;

interface IPresaleMintableSingle {
  function presaleMint(address _receiver, uint256 _amount) external payable;
}
// File: contracts/minters/utils/PresaleMintable/ProcessPresaleMintable.sol



// SPDX-License-Identifier: GPL-3.0-or-later

pragma solidity ^0.8.17;

import './IPresaleMintableMulti.sol';
import './IPresaleMintableSingle.sol';

abstract contract ProcessPresaleMintable {
  enum PresaleType {
    Single,
    Multi
  }

  struct PresaleMinterInfo {
    PresaleType presaleType;
    address minterAddress; // casted as IPresaleMintableSingle or IPresaleMintableMulti
    uint256 collectionId;
    uint256 price;
  }

  // TODO: send value along with this method
  function _processPresaleMinter(PresaleMinterInfo memory _presaleMinter, address _receiver, uint256 _amount, uint256 _price) internal {
    if (_presaleMinter.presaleType == PresaleType.Multi) {
      IPresaleMintableMulti(_presaleMinter.minterAddress).presaleMint{value: _price}(_presaleMinter.collectionId, _receiver, _amount);
    } else if (_presaleMinter.presaleType == PresaleType.Single) {
      IPresaleMintableSingle(_presaleMinter.minterAddress).presaleMint{value: _price}(_receiver, _amount);
    }
  }
}
// File: contracts/minters/WildxyzGroup/extensions/WildxyzGroupAllowlistSigner.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// ░██╗░░░░░░░██╗░██╗░██╗░░░░░░██████╗░░██╗░░██╗░██╗░░░██╗░███████╗
// ░██║░░██╗░░██║░██║░██║░░░░░░██╔══██╗░╚██╗██╔╝░╚██╗░██╔╝░╚════██║
// ░╚██╗████╗██╔╝░██║░██║░░░░░░██║░░██║░░╚███╔╝░░░╚████╔╝░░░░███╔═╝
// ░░████╔═████║░░██║░██║░░░░░░██║░░██║░░██╔██╗░░░░╚██╔╝░░░██╔══╝░░
// ░░╚██╔╝░╚██╔╝░░██║░███████╗░██████╔╝░██╔╝╚██╗░░░░██║░░░░███████╗
// ░░░╚═╝░░░╚═╝░░░╚═╝░╚══════╝░╚═════╝░░╚═╝░░╚═╝░░░░╚═╝░░░░╚══════╝

// It ain't much, but it's honest work.

pragma solidity ^0.8.17;

import '@openzeppelin/contracts/utils/Strings.sol';
import '@openzeppelin/contracts/utils/cryptography/ECDSA.sol';

import '../WildxyzGroup.sol';

abstract contract WildxyzGroupAllowlistSigner is WildxyzGroup {
  
  address allowlistSigner;

  uint256[] public groupIds_AllowlistSigners;

  error InvalidSignature(bytes signature, uint256 groupId);

  // modifier validation hooks

  modifier validateSigner(address _receiver, bytes memory _signature) {
    _validateSignature(_receiver, _signature);
    _;
  }

  // internal functions

  function _setupGroupAllowlistSigner(string memory _name, uint256 _startTime, uint256 _endTime, uint256 _price, uint256 _reserveSupply) internal returns (uint256) {
    uint256 groupId = _createGroup(_name, _startTime, _endTime, _price, _reserveSupply);

    groupIds_AllowlistSigners.push(groupId);

    return groupId;
  }

  function _isAllowlistSignerGroup(uint256 _groupId) internal view returns (bool validGroup) {
    for (uint256 i = 0; i < groupIds_AllowlistSigners.length; i++) {
      if (groupIds_AllowlistSigners[i] == _groupId) {
        validGroup = true;
        break;
      }
    }
  }

  function _verifySignature(address _receiver, bytes memory _signature) internal view returns (bool, uint256) {
    if (_signature.length != 65) return (false, 0);

    for (uint256 i = 0; i < groupIds_AllowlistSigners.length; i++) {
      uint256 groupId = groupIds_AllowlistSigners[i];

      bytes32 addressHash = keccak256(abi.encodePacked(_receiver, address(this), Strings.toString(groupId)));
      bytes32 message = ECDSA.toEthSignedMessageHash(addressHash);
      address signer = ECDSA.recover(message, _signature);

      if (signer != address(0) && signer == allowlistSigner) {
        return (true, groupId);
      }
    }

    return (false, 0);
  }

  function _validateSignature(address _receiver, bytes memory _signature) internal view {
    (bool valid, uint256 groupId) = _verifySignature(_receiver, _signature);
    if (!valid) revert InvalidSignature(_signature, groupId);
  }

  function _validateSignatureAndGetGroupId(address _receiver, bytes memory _signature) internal view returns (uint256) {
    (bool valid, uint256 groupId) = _verifySignature(_receiver, _signature);
    if (!valid) revert InvalidSignature(_signature, groupId);

    return groupId;
  }

  function _setAllowlistSigner(address _signer) internal {
    allowlistSigner = _signer;
  }

  // only admin

  function setAllowlistSigner(address _signer) public onlyAdmin {
    _setAllowlistSigner(_signer);
  }

  // public functions

  /** @notice Verifies the signature of the signer for a given address.
   * @param _receiver The address the message was signed for.
   * @param _signature The signature to verify.
   * @return valid True if the signature is valid, false otherwise.
   */
  function verifySignature(address _receiver, bytes memory _signature) public view returns (bool, uint256) {
    return _verifySignature(_receiver, _signature);
  }

  // minting implemented in child contract
}
// File: contracts/minters/WildxyzGroup/extensions/WildxyzGroupOasis.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// ░██╗░░░░░░░██╗░██╗░██╗░░░░░░██████╗░░██╗░░██╗░██╗░░░██╗░███████╗
// ░██║░░██╗░░██║░██║░██║░░░░░░██╔══██╗░╚██╗██╔╝░╚██╗░██╔╝░╚════██║
// ░╚██╗████╗██╔╝░██║░██║░░░░░░██║░░██║░░╚███╔╝░░░╚████╔╝░░░░███╔═╝
// ░░████╔═████║░░██║░██║░░░░░░██║░░██║░░██╔██╗░░░░╚██╔╝░░░██╔══╝░░
// ░░╚██╔╝░╚██╔╝░░██║░███████╗░██████╔╝░██╔╝╚██╗░░░░██║░░░░███████╗
// ░░░╚═╝░░░╚═╝░░░╚═╝░╚══════╝░╚═════╝░░╚═╝░░╚═╝░░░░╚═╝░░░░╚══════╝

// It ain't much, but it's honest work.

pragma solidity ^0.8.17;

import '../../utils/IOasis.sol';

import '../WildxyzGroup.sol';

abstract contract WildxyzGroupOasis is WildxyzGroup {

  uint256 public groupId_Oasis;

  /// @notice Oasis NFT address.
  IOasis public oasis;

  mapping(address => uint256) public addressTotalOasisSupply; // oasis specific total minted

  uint256 public maxPerOasis;

  mapping(uint256 => uint8) private oasisPassMints;

  // setup

  function _setupGroupOasis(uint256 _startTime, uint256 _endTime, uint256 _price, uint256 _reserveSupply, IOasis _oasis, uint256 _maxPerOasis) internal {
    groupId_Oasis = _createGroup('Oasis', _startTime, _endTime, _price, _reserveSupply);
    
    oasis = _oasis;
    maxPerOasis = _maxPerOasis;
  }

  // callback to override to implement minting/purchase logic

  function _processUseOasisCallback(address _receiver) internal virtual returns (uint256 tokenId) {}

  // internal helpers

  function _getOasisMintAllowance(address _oasisOwner, uint256 _oasisBalance) internal view returns (uint256 quantity) {
    for (uint256 i = 0; i < _oasisBalance; i++) {
      uint256 oasisId = oasis.tokenOfOwnerByIndex(_oasisOwner, i);
      quantity += (maxPerOasis > oasisPassMints[oasisId] ? maxPerOasis - oasisPassMints[oasisId] : 0);
    }
  }

  function _processUseOasis(address _receiver, address _requester, uint256 _amount) internal virtual returns (uint256[] memory tokenIds, uint256[] memory oasisIds) {
    uint256 oasisBalance = oasis.balanceOf(_requester);

    if (_getOasisMintAllowance(_requester, oasisBalance) == 0) revert ZeroOasisAllowance(_receiver);

    uint256 mintsLeft = _amount;
    uint256 totalMinted = 0;

    tokenIds = new uint256[](_amount);
    oasisIds = new uint256[](_amount);

    for (uint256 i = 0; i < oasisBalance; i++) {
      uint256 oasisId = oasis.tokenOfOwnerByIndex(_requester, i);
      uint256 tokenAllowance = maxPerOasis - oasisPassMints[oasisId];

      if (tokenAllowance == 0) {
        // Oasis pass been fully minted
        continue;
      }

      uint8 quantityMintedWithOasis = uint8(Math.min(tokenAllowance, mintsLeft));

      oasisPassMints[oasisId] += quantityMintedWithOasis;
      mintsLeft -= quantityMintedWithOasis;

      for (uint256 j = 0; j < quantityMintedWithOasis; j++) {
        uint256 tokenId = _processUseOasisCallback(_receiver);

        tokenIds[totalMinted + j] = tokenId;
        oasisIds[totalMinted + j] = oasisId;
      }

      totalMinted += quantityMintedWithOasis;
    }

    if (mintsLeft != 0) revert NotEnoughOasisMints(_requester);
  }

  function _addOasisTotalSupply(address _receiver, uint256 _amount) internal virtual {
    // just in case they move their oasis and try to get into a different group
    _addAddressTotalSupply(_receiver, _amount);

    addressTotalOasisSupply[_receiver] += _amount;
  }

  // overrides
  
  function getUserGroupAllowance(address _user, uint256 _groupId) public view virtual override returns (uint256) {
    uint256 supplyRemaining = _remainingSupply();
    if (supplyRemaining == 0) {
      return 0;
    }

    uint256 oasisBalance = oasis.balanceOf(_user);

    if (oasisBalance > 0 || _groupId == groupId_Oasis) {
      // Y = # oasis * S (S = maxPerOasis)
      if (oasisBalance > 0) {
        // if user owns oasis, count max allowance as num. oasis * maxPerOasis
        return Math.min(_getOasisMintAllowance(_user, oasisBalance), supplyRemaining);
      }

      return 0;
    }

    // Y = R (R = maxPerAddress)
    return Math.min(maxPerAddress - addressTotalSupply[_user], supplyRemaining);
  }

  function getUserGroupTotalSupply(address _user, uint256 _groupId) public view virtual override returns (uint256) {
    if (_groupId == groupId_Oasis) {
      return addressTotalOasisSupply[_user];
    } else {
      return addressTotalSupply[_user];
    }
  }

  // only admin functions

  function setMaxPerOasis(uint256 _maxPerOasis) public onlyAdmin {
    maxPerOasis = _maxPerOasis;
  }
}
// File: contracts/minters/WildxyzGroup/IWildxyzGroup.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// ░██╗░░░░░░░██╗░██╗░██╗░░░░░░██████╗░░██╗░░██╗░██╗░░░██╗░███████╗
// ░██║░░██╗░░██║░██║░██║░░░░░░██╔══██╗░╚██╗██╔╝░╚██╗░██╔╝░╚════██║
// ░╚██╗████╗██╔╝░██║░██║░░░░░░██║░░██║░░╚███╔╝░░░╚████╔╝░░░░███╔═╝
// ░░████╔═████║░░██║░██║░░░░░░██║░░██║░░██╔██╗░░░░╚██╔╝░░░██╔══╝░░
// ░░╚██╔╝░╚██╔╝░░██║░███████╗░██████╔╝░██╔╝╚██╗░░░░██║░░░░███████╗
// ░░░╚═╝░░░╚═╝░░░╚═╝░╚══════╝░╚═════╝░░╚═╝░░╚═╝░░░░╚═╝░░░░╚══════╝

pragma solidity ^0.8.17;

interface IWildxyzGroup {
    // enums

    /// @dev States for the minter
    enum State {
        Setup, // also "comingsoon"
        Live, // defer to phases for state name
        Complete, // also "soldout"
        Paused // temporary paused state
    }

    // structs

    /// @dev Represents a minting group
    struct Group {
        string name;
        uint256 id;
        uint256 startTime;
        uint256 endTime;
        uint256 price;

        uint256 reserveSupply; // supply reserved for this group until reserveEndTime (>= 0 and < maxSupply)
    }

    // events


    // errors

    /// @notice Emitted when trying to call setup twice
    error AlreadySetup();

    /// @notice Emitted when not in live state
    error NotLive();

    /// @notice Emitted when not in complete state
    error NotComplete();

    /// @notice Emitted when group is not allowed to mint yet
    error GroupNotLive(uint256 _groupId);

    /// @notice Emitted when given a zero address
    error ZeroAddress();

    /// @notice Emitted when given a zero amount
    error ZeroAmount();

    /// @notice Emitted when setting group start time to an invalid value
    error InvalidGroupStartTime(uint256 _startTime);

    /// @notice Emitted when an OFAC sanctioned address tries to interact with a function
    error SanctionedAddress(address _to);

    /// @notice Emitted when a function is called by a non-delegated address
    error NotDelegated(address _sender, address _vault, address _contract);

    /// @notice Emitted when failing to withdraw to wallet
    error FailedToWithdraw(string _walletName, address _wallet);

    /// @notice Emitted when given a non-existing groupId
    error GroupDoesNotExist(uint256 _groupId);

    /// @notice Emitted when amount requested exceeds nft max supply
    error MaxSupplyExceeded();

    /// @notice Emitted when the value provided is not enough for the function
    error InsufficientFunds();

    /// @notice Emitted when two or more arrays do not match in size
    error ArraySizeMismatch();

    error NotEnoughOasisMints(address _receiver);
    error ZeroOasisAllowance(address _receiver);

    error FailedToMint(address _receiver);

    /// @notice Emitted when a user tries to mint too many toksns
    error MaxPerAddressExceeded(address _receiver, uint256 _amount);

    /// @notice Emitted when a non-admin or non-manager tries to call an admin or manager function
    error OnlyAdminOrManager();

    error ReserveSupplyExceedsMaxSupply(uint256 reserveSupply, uint256 maxSupply);
}

// File: contracts/minters/WildxyzGroup/presets/WildxyzBundlePurchase.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// ░██╗░░░░░░░██╗░██╗░██╗░░░░░░██████╗░░██╗░░██╗░██╗░░░██╗░███████╗
// ░██║░░██╗░░██║░██║░██║░░░░░░██╔══██╗░╚██╗██╔╝░╚██╗░██╔╝░╚════██║
// ░╚██╗████╗██╔╝░██║░██║░░░░░░██║░░██║░░╚███╔╝░░░╚████╔╝░░░░███╔═╝
// ░░████╔═████║░░██║░██║░░░░░░██║░░██║░░██╔██╗░░░░╚██╔╝░░░██╔══╝░░
// ░░╚██╔╝░╚██╔╝░░██║░███████╗░██████╔╝░██╔╝╚██╗░░░░██║░░░░███████╗
// ░░░╚═╝░░░╚═╝░░░╚═╝░╚══════╝░╚═════╝░░╚═╝░░╚═╝░░░░╚═╝░░░░╚══════╝

// It ain't much, but it's honest work.

pragma solidity ^0.8.17;

import '../extensions/WildxyzGroupOasis.sol';
import '../extensions/WildxyzGroupAllowlistSigner.sol';

import '../../utils/PresaleMintable/ProcessPresaleMintable.sol';

contract WildxyzBundlePurchase is WildxyzGroupOasis, WildxyzGroupAllowlistSigner, ProcessPresaleMintable {

  uint256 public groupId_ArtistCollectors;
  uint256 public groupId_PartnersA;
  uint256 public groupId_PartnersB;

  struct ContractInfo {
    State state;
    uint256 maxSupply;
    uint256 totalSupply;
    uint256 remainingSupply;
    uint256 maxPerAddress;
    uint256 maxPerOasis;
    uint256 extraTokensPerBundle;
    uint256 extraTokenPrice;
    uint256 extraTokensTotalSupply;
    address allowlistSigner;
    Group[] groups;
  }

  struct UserInfo {
    uint256 userGroupId;
    uint256 bundleAllowance;
    uint256 extraTokenAllowance;
    bool isGroupLive;
    BundlePurchaseInfo bundlePurchaseInfo;
  }

  // bundle variables

  struct BundlePurchaseInfo {
    address owner;

    uint256 numBundles;
    uint256 numExtraTokens;

    uint256 value; // total eth value sent for this bundle + extra tokens

    uint256 numExtraTokensProcessed;

    bool processed;
  }

  enum PurchaseType {
    Oasis,
    ArtistCollectors,
    PartnersA,
    PartnersB
  }

  uint256 public extraTokensPerBundle = 2;

  mapping(address => BundlePurchaseInfo) private bundlePurchaseInfo;

  mapping(address => mapping(uint256 => uint256)) public numBundlesProcessedPerCollectionId;

  address[] public bundleOwners;

  uint256 public numBundleOwners;

  uint256 public bundleTotalSupply;
  uint256 public extraTokensTotalSupply;

  // presale minting logic

  PresaleMinterInfo[] public presaleMinters; // minter to use to mint in the bundle
  PresaleMinterInfo public extraTokenMinter; // minter to use to mint for extra tokens

  uint256 public numPresaleMinters;

  uint256 public extraTokenPrice;

  // events

  event BundlePurchased(address indexed to, uint256 quantity, uint256 extraTokens, uint256 amount, PurchaseType purchaseType, bool isDelegated, address vault);

  event ExtraTokensPurchased(address indexed to, uint256 quantity, uint256 amount);

  event BundlePurchaseProcessed(address indexed to, uint256 indexed amount, uint256 indexed extraTokens);

  // errors

  error MustPurchaseBundleBeforeAddingExtraTokens(address to);

  error MaxExtraTokensPerBundleExceeded(address to);

  error NFTAlreadyExistsInBundle(address nft);

  error NFTDoesNotExistInBundle(address nft);

  error AlreadyProcessedBundlePurchase(address to);

  // constructor

  constructor (uint256 _maxSupply, uint256 _maxPerAddress, uint256 _wildRoyalty, address _wildWallet, address _artistWallet, IAdminBeaconUpgradeable _adminBeacon, ISanctionsList _sanctions, PresaleMinterInfo[] memory _presaleMinters, PresaleMinterInfo memory _extraTokenMinter)
    WildxyzGroup(_maxSupply, _maxPerAddress, _wildRoyalty, _wildWallet, _artistWallet, _adminBeacon, _sanctions)
  {
    for (uint256 i = 0; i < _presaleMinters.length; i++) {
      presaleMinters.push(_presaleMinters[i]);
    }

    numPresaleMinters = _presaleMinters.length;

    extraTokenMinter = _extraTokenMinter;
  }
  
  function setup(
    uint256[4] memory _startTimes,
    uint256[4] memory _endTimes,
    uint256[4] memory _prices,
    uint256[4] memory _reserveSupply,
    uint256 _extraTokenPrice,
    IOasis _oasis,
    uint256 _maxPerOasis,
    address _allowlistSigner
  ) public onlyOwner setupOnce {
    _setupGroupOasis(_startTimes[0], _endTimes[0], _prices[0], _reserveSupply[0], _oasis, _maxPerOasis);

    groupId_ArtistCollectors = _setupGroupAllowlistSigner('Artist Collectors', _startTimes[1], _endTimes[1], _prices[1], _reserveSupply[1]);

    groupId_PartnersA = _setupGroupAllowlistSigner('Partners Wave 1', _startTimes[2], _endTimes[2], _prices[2], _reserveSupply[2]);
    groupId_PartnersB = _setupGroupAllowlistSigner('Partners Wave 2', _startTimes[3], _endTimes[3], _prices[3], _reserveSupply[3]);

    _setAllowlistSigner(_allowlistSigner);

    extraTokenPrice = _extraTokenPrice;
  }

  // required overrides

  function _totalSupply() internal view virtual override(WildxyzGroup) returns (uint256) {
    return bundleTotalSupply;
  }

  function getUserGroupAllowance(address _user, uint256 _groupId) public view virtual override(WildxyzGroup, WildxyzGroupOasis) returns (uint256) {
    return WildxyzGroupOasis.getUserGroupAllowance(_user, _groupId);
  }

  function getUserGroupTotalSupply(address _user, uint256 _groupId) public view virtual override(WildxyzGroup, WildxyzGroupOasis) returns (uint256) {
    return WildxyzGroupOasis.getUserGroupTotalSupply(_user, _groupId);
  }

  // internal functions

  // in addition to group price checking we check this method,
  // maybe in the future we should override something in the base contract
  function _validPurchasePrice(uint256 _groupId, uint256 _value, uint256 _numBundles, uint256 _numExtraTokens) internal view {
    uint256 groupPrice = getGroupPrice(_groupId);
    uint256 totalValue = _numBundles * groupPrice + _numExtraTokens * extraTokenPrice;

    if (_value < totalValue) revert InsufficientFunds();
  }

  function _validExtraTokenAllowance(address _receiver, uint256 _amount) internal view {
    if (bundlePurchaseInfo[_receiver].numExtraTokens + _amount > bundlePurchaseInfo[_receiver].numBundles * extraTokensPerBundle) revert MaxExtraTokensPerBundleExceeded(_receiver);
  }

  function _onBundlePurchase(address _receiver, uint256 _amount, uint256 _extraTokens, PurchaseType _purchaseType, uint256 _value) internal {
    BundlePurchaseInfo storage purchaseInfo = bundlePurchaseInfo[_receiver];

    if (purchaseInfo.owner == address(0)) {
      purchaseInfo.owner = _receiver;

      bundleOwners.push(_receiver);

      numBundleOwners++;
    }

    purchaseInfo.numBundles += _amount;
    purchaseInfo.value += _value;

    // check extra token allowance
    _validExtraTokenAllowance(_receiver, _extraTokens);

    purchaseInfo.numExtraTokens += _extraTokens;

    // add to total supply trackers
    extraTokensTotalSupply += _extraTokens;

    bundleTotalSupply += _amount;

    _addAddressTotalSupply(_receiver, _amount);

    // emit event
    emit BundlePurchased(_receiver, _amount, _extraTokens, _value, _purchaseType, false, address(0));
  }

  function _onExtraTokensPurchased(address _receiver, uint256 _amount, uint256 _value) internal {
    BundlePurchaseInfo storage purchaseInfo = bundlePurchaseInfo[_receiver];

    if (purchaseInfo.owner == address(0)) revert MustPurchaseBundleBeforeAddingExtraTokens(_receiver);

    _validExtraTokenAllowance(_receiver, _amount);

    purchaseInfo.numExtraTokens += _amount;

    extraTokensTotalSupply += _amount;

    purchaseInfo.value += _value;
  }

  // override

  function _processUseOasisCallback(address _receiver) internal virtual override returns (uint256 tokenId) {
    BundlePurchaseInfo storage purchaseInfo = bundlePurchaseInfo[_receiver];

    if (purchaseInfo.owner == address(0)) {
      purchaseInfo.owner = _receiver;

      bundleOwners.push(_receiver);

      numBundleOwners++;
    }

    purchaseInfo.numBundles++;

    bundleTotalSupply++;

    return 0;
  }

  function _purchaseWithOasis(address _receiver, uint256 _amount, uint256 _extraTokens, uint256 _value, bool isDelegated, address vault) internal {
    _processUseOasis(_receiver, vault, _amount); // this calls the '_processUseOasisCallback' method

    _onExtraTokensPurchased(msg.sender, _extraTokens, 0);

    bundlePurchaseInfo[msg.sender].value += _value;

    emit BundlePurchased(msg.sender, _amount, _extraTokens, _value, PurchaseType.Oasis, isDelegated, vault);

    _addOasisTotalSupply(msg.sender, _amount);
  }

 function _withdraw() internal virtual override {
    (bool successWild, ) = wildWallet.call{value: address(this).balance}('');
    if (!successWild) revert FailedToWithdraw('wild', wildWallet);
 }

  // public functions

  function getUserGroup(address _user, bytes memory _signature) public view virtual override returns (uint256) {
    // oasis takes priority
    if (oasis.balanceOf(_user) > 0) {
      return groupId_Oasis;
    }

    // get and validate signer
    (bool isValidSigner, uint256 signerGroupId) = _verifySignature(_user, _signature);
    if (isValidSigner) {
      return signerGroupId;
    }

    return numGroups; // an invalid group id
  }

  function getUserExtraTokenAllowance(address _user) public view returns (uint256) {
    BundlePurchaseInfo storage purchaseInfo = bundlePurchaseInfo[_user];
    uint256 numBundles = purchaseInfo.numBundles;
    uint256 numExtraTokens = purchaseInfo.numExtraTokens;

    if (numBundles == 0) return 0;

    // in case we change the extra tokens per bundle
    if (numBundles * extraTokensPerBundle < numExtraTokens) return 0;

    return numBundles * extraTokensPerBundle - numExtraTokens;
  }

  function getBundleInfo(address _user) public view returns (BundlePurchaseInfo memory) {
    return bundlePurchaseInfo[_user];
  }

  function getContractInfo() public view virtual returns (ContractInfo memory) {
    return ContractInfo(getState(), maxSupply, _totalSupply(), _remainingSupply(), maxPerAddress, maxPerOasis, extraTokensPerBundle, extraTokenPrice, extraTokensTotalSupply, allowlistSigner, _getGroupsArray());
  }

  function getUserInfo(address _user, bytes memory _signature) public view virtual returns (UserInfo memory) {
    uint256 userGroupId = getUserGroup(_user, _signature);

    return UserInfo(userGroupId, getUserGroupAllowance(_user, userGroupId), getUserExtraTokenAllowance(_user), _isGroupLive(userGroupId), getBundleInfo(_user));
  }

  function getUserContractInfo(address _user, bytes memory _signature) public view returns (UserInfo memory userInfo, ContractInfo memory contractInfo) {
    userInfo = getUserInfo(_user, _signature);
    contractInfo = getContractInfo();
  }

  // only admin

  function setExtraTokensPerBundle(uint256 _extraTokensPerBundle) public onlyAdmin {
    extraTokensPerBundle = _extraTokensPerBundle;
  }

  function setExtraTokenMinter(PresaleMinterInfo memory _extraTokenMinter) public onlyAdmin {
    extraTokenMinter = _extraTokenMinter;
  }

  function addPresaleMinter(PresaleMinterInfo memory _presaleMinter) public onlyAdmin {
    // check if nft already exists
    for (uint256 i = 0; i < presaleMinters.length; i++) {
      if (presaleMinters[i].minterAddress == _presaleMinter.minterAddress) revert NFTAlreadyExistsInBundle(_presaleMinter.minterAddress);
    }

    presaleMinters.push(_presaleMinter);

    numPresaleMinters = presaleMinters.length;
  }

  function removePresaleMinter(PresaleMinterInfo memory _presaleMinter) public onlyAdmin {
    // check if nft exists
    bool found = false;
    for (uint256 i = 0; i < presaleMinters.length; i++) {
      if (presaleMinters[i].minterAddress == _presaleMinter.minterAddress) {
        found = true;
        break;
      }
    }

    if (!found) revert NFTDoesNotExistInBundle(_presaleMinter.minterAddress);

    // remove nft
    for (uint256 i = 0; i < presaleMinters.length; i++) {
      if (presaleMinters[i].minterAddress == _presaleMinter.minterAddress) {
        presaleMinters[i] = presaleMinters[presaleMinters.length - 1];
        presaleMinters.pop();
        break;
      }
    }

    numPresaleMinters = presaleMinters.length;
  }

  function closeBundle() public onlyAdmin {
    // set all group end times to now
    for (uint256 i = 0; i < numGroups; i++) {
      groups[i].endTime = block.timestamp;
    }
  }

  function setAllEndTimes(uint256 _endTime) public onlyAdmin {
    for (uint256 i = 0; i < numGroups; i++) {
      groups[i].endTime = _endTime;
    }
  }

  function setAllPrices(uint256 _price) public onlyAdmin {
    for (uint256 i = 0; i < numGroups; i++) {
      groups[i].price = _price;
    }
  }

  // only owner
  
  // function processBundleMintPerCollection(uint256 _index, uint256 _collectionId) public onlyAdmin {
  //   address receiver = bundleOwners[_index];

  //   if (bundlePurchaseInfo[receiver].processed) revert AlreadyProcessedBundlePurchase(receiver);

  //   BundlePurchaseInfo storage purchaseInfo = bundlePurchaseInfo[receiver];

  //   uint256 numBundles = purchaseInfo.numBundles - numBundlesProcessedPerCollectionId[receiver][_collectionId];
  //   uint256 numExtraTokens = purchaseInfo.numExtraTokens;

  //   // mint _collectionId presale minter
  //   if (numBundles > 0) {
  //     for (uint256 i = 0; i < presaleMinters.length; i++) {
  //       if (presaleMinters[i].collectionId == _collectionId) {
  //         _processPresaleMinter(presaleMinters[i], receiver, numBundles);
  //         break;
  //       }
  //     }
  //   }

  //   // mint extra tokens
  //   if (numExtraTokens > 0 && extraTokenMinter.collectionId == _collectionId) {
  //     _processPresaleMinter(extraTokenMinter, receiver, numExtraTokens);
  //   }

  //   emit BundlePurchaseProcessed(receiver, numBundles, numExtraTokens);

  //   numBundlesProcessedPerCollectionId[receiver][_collectionId] += numBundles;
  //   purchaseInfo.numExtraTokensProcessed += numExtraTokens;

  //   // if all collections have been processed and all extra tokens have been processed
  //   bool allPresaleMintersProcessed = true;
  //   for (uint256 i = 0; i < presaleMinters.length; i++) {
  //     if (numBundlesProcessedPerCollectionId[receiver][presaleMinters[i].collectionId] < purchaseInfo.numBundles) {
  //       allPresaleMintersProcessed = false;
  //       break;
  //     }
  //   }
  //   purchaseInfo.processed = allPresaleMintersProcessed && purchaseInfo.numExtraTokensProcessed == purchaseInfo.numExtraTokens;
  // }

  // function processBundleMintBatchPerCollection(uint256 _fromIndex, uint256 _toIndex, uint256 _collectionId) public onlyAdmin {
  //   for (uint256 i = _fromIndex; i < _toIndex; i++) {
  //     processBundleMintPerCollection(i, _collectionId);
  //   }
  // }

  function processBundleMint(uint256 _index) public onlyAdmin {
    address receiver = bundleOwners[_index];

    if (bundlePurchaseInfo[receiver].processed) revert AlreadyProcessedBundlePurchase(receiver);

    BundlePurchaseInfo storage purchaseInfo = bundlePurchaseInfo[receiver];

    uint256 numBundles = purchaseInfo.numBundles;
    uint256 numExtraTokens = purchaseInfo.numExtraTokens;

    // mint presale minters
    if (numBundles > 0) {
      for (uint256 i = 0; i < presaleMinters.length; i++) {
        uint256 collectionValue = numBundles * presaleMinters[i].price;
        uint256 tokensToMint = numBundles;

        if (presaleMinters[i].collectionId == extraTokenMinter.collectionId) {
          collectionValue += numExtraTokens * extraTokenMinter.price;
          tokensToMint += numExtraTokens;
        }

        _processPresaleMinter(presaleMinters[i], receiver, tokensToMint, collectionValue);
      }
    }

    emit BundlePurchaseProcessed(receiver, numBundles, numExtraTokens);

    purchaseInfo.processed = true;
  }

  function processBundleMintBatch(uint256 _fromIndex, uint256 _toIndex) public onlyAdmin {
    for (uint256 i = _fromIndex; i < _toIndex; i++) {
      processBundleMint(i);
    }
  }

  // public purchase

  function purchaseExtraTokens(uint256 _amount)
    public payable virtual
    onlyUnsanctioned(msg.sender)
    whenNotPaused nonReentrant beforeEndTime
  {
    uint256 totalValue = _amount * extraTokenPrice;
    if (msg.value < totalValue) revert InsufficientFunds();

    _onExtraTokensPurchased(msg.sender, _amount, msg.value);

    emit ExtraTokensPurchased(msg.sender, _amount, msg.value);
  }

  function oasisPurchase(uint256 _amount, uint256 _extraTokens)
    public payable virtual
    onlyUnsanctioned(msg.sender)
    whenNotPaused nonReentrant onlyLive
    validGroupPriceSupply(_amount, groupId_Oasis)
  {
    _validPurchasePrice(groupId_Oasis, msg.value, _amount, _extraTokens);

    _purchaseWithOasis(msg.sender, _amount, _extraTokens, msg.value, false, msg.sender);
  }

  function oasisPurchaseDelegated(uint256 _amount, uint256 _extraTokens, address _vault) 
    public payable virtual
    onlyUnsanctioned(msg.sender)
    whenNotPaused nonReentrant onlyLive
    onlyDelegated(_vault, address(oasis))
    validGroupPriceSupply(_amount, groupId_Oasis)
  {
    _validPurchasePrice(groupId_Oasis, msg.value, _amount, _extraTokens);

    _purchaseWithOasis(msg.sender, _amount, _extraTokens, msg.value, true, _vault);
  }

  // general allowlist mint, looks up group id from signature
  function allowlistPurchase(uint256 _amount, uint256 _extraTokens, bytes memory _signature)
    public payable virtual
    onlyUnsanctioned(msg.sender)
    whenNotPaused nonReentrant onlyLive
  {
    uint256 groupId = _validateSignatureAndGetGroupId(msg.sender, _signature);
    _validGroupPriceSupplyAllowance(msg.sender, _amount, groupId);

    PurchaseType purchaseType;
    if (groupId == groupId_ArtistCollectors) {
      purchaseType = PurchaseType.ArtistCollectors;
    } else if (groupId == groupId_PartnersA) {
      purchaseType = PurchaseType.PartnersA;
    } else if (groupId == groupId_PartnersB) {
      purchaseType = PurchaseType.PartnersB;
    }

    _validPurchasePrice(groupId, msg.value, _amount, _extraTokens);

    _onBundlePurchase(msg.sender, _amount, _extraTokens, purchaseType, msg.value);
  }
}
// File: contracts/minters/WildxyzGroup/WildxyzGroup.sol



// SPDX-License-Identifier: GPL-3.0-or-later

// ░██╗░░░░░░░██╗░██╗░██╗░░░░░░██████╗░░██╗░░██╗░██╗░░░██╗░███████╗
// ░██║░░██╗░░██║░██║░██║░░░░░░██╔══██╗░╚██╗██╔╝░╚██╗░██╔╝░╚════██║
// ░╚██╗████╗██╔╝░██║░██║░░░░░░██║░░██║░░╚███╔╝░░░╚████╔╝░░░░███╔═╝
// ░░████╔═████║░░██║░██║░░░░░░██║░░██║░░██╔██╗░░░░╚██╔╝░░░██╔══╝░░
// ░░╚██╔╝░╚██╔╝░░██║░███████╗░██████╔╝░██╔╝╚██╗░░░░██║░░░░███████╗
// ░░░╚═╝░░░╚═╝░░░╚═╝░╚══════╝░╚═════╝░░╚═╝░░╚═╝░░░░╚═╝░░░░╚══════╝

// It ain't much, but it's honest work.

pragma solidity ^0.8.17;

import '@openzeppelin/contracts/access/Ownable.sol';
import '@openzeppelin/contracts/security/Pausable.sol';
import '@openzeppelin/contracts/security/ReentrancyGuard.sol';

import '@openzeppelin/contracts/utils/math/Math.sol';

import '../../admin/UseAdminBeacon.sol';

import '../utils/ISanctionsList.sol';
import '../utils/IDelegationRegistry.sol';

import './IWildxyzGroup.sol';

abstract contract WildxyzGroup is IWildxyzGroup, UseAdminBeacon, Pausable, ReentrancyGuard {
  // private variables

  mapping(uint256 => Group) internal groups;
  uint256 internal numGroups;

  /// @dev One-time variable used to set up the contract.
  bool private isSetup = false;

  // drop variables

  /// @notice Max supply of NFTs available. Same as NFT contract.
  uint256 public maxSupply;

  /// @notice Wildxyz royalty percentage.
  /// @dev Wildxyz royalty is `wildRoyalty`%. Artist royalty is `100 - wildRoyalty`% (100 - wildRoyalty).
  uint256 public wildRoyalty;

  /// @notice Royalty total denominator.
  uint256 public royaltyTotal = 100;

  /// @notice Wildxyz royalty wallet
  /// @dev This is the wallet that will receive the `wildRoyalty`% of the primary sale eth.
  address payable public wildWallet;

  /// @notice Artist royalty wallet
  /// @dev This is the wallet that will receive the `100 - wildRoyalty`% of the primary sale eth.
  address payable public artistWallet;

  /// @notice The OFAC sanctions list contract address.
  /// @dev Used to block unsanctioned addresses from minting NFTs.
  ISanctionsList public sanctionsList;

  /// @notice The DelegateCash registry address.
  IDelegationRegistry public delegationRegistry = IDelegationRegistry(0x00000000000076A84feF008CDAbe6409d2FE638B);

  // minter variables

  uint256 public maxPerAddress;

  mapping(address => uint256) public addressTotalSupply;

  // modifiers

  modifier setupOnce() {
    if (isSetup) revert AlreadySetup();
    isSetup = true;
    _;
  }
  
  modifier onlyLive() {
    if (getState() != State.Live) revert NotLive();
    _;
  }

  modifier beforeEndTime() {
    uint256 lastGroupId = numGroups - 1;
    if (groups[lastGroupId].endTime != 0 && block.timestamp >= groups[lastGroupId].endTime) revert NotLive();
    _;
  }

  modifier validGroup(uint256 _groupId) {
    _validGroup(_groupId);
    _;
  }

  modifier onlyUnsanctioned(address _to) {
    if (sanctionsList.isSanctioned(_to)) revert SanctionedAddress(_to);
    _;
  }

  modifier onlyDelegated(address _vault, address _contract) {
    if (!delegationRegistry.checkDelegateForContract(msg.sender, _vault, _contract)) revert NotDelegated(msg.sender, _vault, _contract);
    _;
  }

  modifier nonZeroAmount(uint256 _amount) {
    _nonZeroAmount(_amount);
    _;
  }

  modifier validGroupPriceSupplyAllowance(address _receiver, uint256 _amount, uint256 _groupId) {
    _validGroupPriceSupplyAllowance(_receiver, _amount, _groupId);
    _;
  }

  modifier validGroupPriceSupply(uint256 _amount, uint256 _groupId) {
    _validGroupPriceSupply(_amount, _groupId);
    _;
  }

  /** @notice Base constructor
   * @param _maxSupply The max supply of the NFT (same as WildNFT)
   * @param _maxPerAddress The max number of NFTs that can be minted per address
   * @param _wildRoyalty The royalty percentage for Wildxyz
   * @param _wildWallet The wallet address for Wildxyz
   * @param _artistWallet The wallet address for the artist
   * @param _adminBeacon The admin address
   * @param _sanctions The sanctions list contract address
   */
  constructor(uint256 _maxSupply, uint256 _maxPerAddress, uint256 _wildRoyalty, address _wildWallet, address _artistWallet, IAdminBeaconUpgradeable _adminBeacon, ISanctionsList _sanctions) {
    maxSupply = _maxSupply;
    maxPerAddress = _maxPerAddress;

    wildRoyalty = _wildRoyalty;
    wildWallet = payable(_wildWallet);
    artistWallet = payable(_artistWallet);

    _setAdminBeacon(_adminBeacon);

    sanctionsList = _sanctions;
  }

  // internal functions

  function _createGroup(string memory _name, uint256 _startTime, uint256 _endTime, uint256 _price, uint256 _reserveSupply) internal onlyOwner returns (uint256 groupId) {
    groupId = numGroups;

    // check if total reserve supply exceeds max supply
    if (_reserveSupply > maxSupply) revert ReserveSupplyExceedsMaxSupply(_reserveSupply, maxSupply);

    groups[groupId] = Group(_name, groupId, _startTime, _endTime, _price, _reserveSupply);

    numGroups++;
  }

  // function validation hooks

  function _isGroupLive(uint256 _groupId) internal view returns (bool) {
    if (_groupId >= numGroups) return false;
    return block.timestamp >= groups[_groupId].startTime && (groups[_groupId].endTime == 0 || block.timestamp < groups[_groupId].endTime);
  }

  function _nonZeroAmount(uint256 _amount) internal pure {
    if (_amount < 1) revert ZeroAmount();
  }

  function _validGroup(uint256 _groupId) internal view {
    if (_groupId >= numGroups) revert GroupDoesNotExist(_groupId);
  }

  function _groupAllowed(uint256 _group) internal view {
    if (!_isGroupLive(_group)) revert GroupNotLive(_group);
  }

  function _validPrice(uint256 _amount, uint256 _groupId) internal view {
    if (msg.value < _amount * groups[_groupId].price) revert InsufficientFunds();
  }

  function _validSupply(uint256 _amount) internal view {
    if (_amount > _remainingSupply()) revert MaxSupplyExceeded();
  }

  function _validAllowance(address _receiver, uint256 _amount) internal view {
    if (addressTotalSupply[_receiver] + _amount > maxPerAddress) revert MaxPerAddressExceeded(_receiver, _amount);
  }

  function _validGroupPriceSupplyAllowance(address _receiver, uint256 _amount, uint256 _groupId) internal view virtual {
    _groupAllowed(_groupId);
    _validPrice(_amount, _groupId);
    _validSupply(_amount);
    _validAllowance(_receiver, _amount);
  }

  function _validGroupPriceSupply(uint256 _amount, uint256 _groupId) internal view virtual {
    _groupAllowed(_groupId);
    _validPrice(_amount, _groupId);
    _validSupply(_amount);
  }

  // helpers

  /// @dev Withdraws the funds to wild and artist wallets acconting for royalty fees. Only callable by owner.
  function _withdraw() internal virtual {
    // send a fraction of the balance to wild first
    if (wildRoyalty > 0) {
      (bool successWild, ) = wildWallet.call{value: ((address(this).balance * wildRoyalty) / royaltyTotal)}('');
      if (!successWild) revert FailedToWithdraw('wild', wildWallet);
    }

    // then, send the rest to payee
    (bool successPayee, ) = artistWallet.call{value: address(this).balance}('');
    if (!successPayee) revert FailedToWithdraw('artist', artistWallet);
  }

  /// @dev Implemented in child contracts to hold total supply logic.
  function _totalSupply() internal view virtual returns (uint256) {}

  /// @dev Returns adjusted maxSupply for reserve quantities.
  function _remainingSupply() internal view virtual returns (uint256) {
    if (groups[0].reserveSupply == 0 || groups[0].reserveSupply == maxSupply) return maxSupply - _totalSupply();

    uint256 _currentGroupId; // get the last group that is live based on start time
    for (uint256 i = 0; i < numGroups; i++) {
      if (block.timestamp >= groups[i].startTime) {
        _currentGroupId = i;
      }
    }

    uint256 cumulativeReserveSupply = 0; // including current _currentGroupId

    if (_currentGroupId == numGroups - 1) {
      return maxSupply - _totalSupply();
    } else {
      for (uint256 i = 0; i <= _currentGroupId; i++) {
        cumulativeReserveSupply += groups[i].reserveSupply;
      }
      cumulativeReserveSupply = Math.min(maxSupply, cumulativeReserveSupply);
    }

    return cumulativeReserveSupply - _totalSupply();
  }

  function _addAddressTotalSupply(address _receiver, uint256 _amount) internal {
    addressTotalSupply[_receiver] += _amount;
  }

  function _getGroupsArray() internal view virtual returns (Group[] memory _groups) {
    _groups = new Group[](numGroups);
    for (uint256 i = 0; i < numGroups; i++) {
      _groups[i] = groups[i];
    }
  }

  // public admin-only functions

  /** @notice Pause the minter.
   * @dev Sets the minter state to Paused and pauses the minter and any mint functions. Only callable by admin.
   */
  function pause() public virtual onlyAdmin {
    _pause();
  }

  /** @notice Unpause the minter.
   * @dev Resumes normal minter state and any mint functions. Only callable by admin.
   */
  function unpause() public virtual onlyAdmin {
    _unpause();
  }

  /** @notice Sets the DelegateCash contract address.
   * @dev Can only be called by the contract admin.
   * @param _delegationRegistry The new delegation registry contract address.
   */
  function setDelegationRegistry(address _delegationRegistry) external onlyAdmin {
    delegationRegistry = IDelegationRegistry(_delegationRegistry);
  }

  /** @notice Sets the max per address.
   * @dev Sets the given max per address. Only callable by admin.
   * @param _maxPerAddress The new max per address.
   */
  function setMaxPerAddress(uint256 _maxPerAddress) public onlyAdmin {
    maxPerAddress = _maxPerAddress;
  }

  /** @notice Sets the group price.
   * @dev Sets the given group price. Only callable by admin.
   * @param _groupId The group ID. Must be a valid group ID.
   * @param _price The new price of the group. Must be non-zero.
   */
  function setGroupPrice(uint256 _groupId, uint256 _price) public virtual validGroup(_groupId) nonZeroAmount(_price) onlyAdmin {
    groups[_groupId].price = _price;
  }

  /** @notice Sets the group start time.
   * @dev Sets the given group start time. Only callable by admin.
   * @param _groupId The group ID. Must be a valid group ID.
   * @param _startTime The new start time of the group.
   */
  function setGroupStartTime(uint256 _groupId, uint256 _startTime) public virtual validGroup(_groupId) onlyAdmin {
    groups[_groupId].startTime = _startTime;
  }

  /** @notice Sets the group end time.
   * @dev Sets the given group end time. Only callable by admin.
   * @param _groupId The group ID. Must be a valid group ID.
   * @param _endTime The new end time of the group.
   */
  function setGroupEndTime(uint256 _groupId, uint256 _endTime) public virtual validGroup(_groupId) onlyAdmin {
    groups[_groupId].endTime = _endTime;
  }

  function setGroupName(uint256 _groupId, string memory _name) public virtual validGroup(_groupId) onlyAdmin {
    groups[_groupId].name = _name;
  }

  // public only-owner functions

  /** @notice Withdraws funds to wild and artist wallets.
   * @dev Withdraws the funds to wild and artist wallets acconting for royalty fees. Only callable by owner.
   */
  function withdraw() public virtual onlyOwner {
    _withdraw();
  }

  // public functions

  /** @notice Get the current minter state.
   * @dev Returns the current minter state. If groups are not directly one after another (ie presale), it is possible to re-enter Setup state.
   * @return state Minter state (0 = Setup, 1 = Live, 2 = Complete, 3 = Paused).
   */
  function getState() public view virtual returns (State) {
    if (paused()) {
      return State.Paused;
    }

    // if sold out, return Complete state
    // NOTE: this would not work with a ReserveAuction where this minter holds the token!!!!
    if (_totalSupply() == maxSupply) {
      return State.Complete;
    }

    bool allGroupsEnded = true;

    // check if we are in any group using _isGroupLive
    // if we are in a group, return Live state
    // note: if groups are not directly one after another (ie presale), it is possible to re-enter Setup state
    for (uint256 groupId = 0; groupId < numGroups; groupId++) {
      if (_isGroupLive(groupId)) {
        return State.Live;
      }

      if (groups[groupId].endTime == 0 || block.timestamp < groups[groupId].endTime) {
        allGroupsEnded = false;
      }
    }

    if (allGroupsEnded) {
      return State.Complete;
    } else {
      return State.Setup;
    }
  }

  function getUserGroup(address _user, bytes memory _signature) public view virtual returns (uint256) {}

  // returns user allowance: Y
  function getUserGroupAllowance(address _user, uint256 /*_groupId*/) public view virtual returns (uint256) {
    uint256 supplyRemaining = _remainingSupply();
    if (supplyRemaining == 0) {
      return 0;
    }

    // Y = R (R = maxPerAddress)
    return Math.min(maxPerAddress - addressTotalSupply[_user], supplyRemaining);
  }

  function getUserGroupTotalSupply(address _user, uint256 /*_groupId*/) public view virtual returns (uint256) {
    return addressTotalSupply[_user];
  }

  function getGroups() public view returns (Group[] memory _groups) {
    _groups = new Group[](numGroups);
    for (uint256 i = 0; i < numGroups; i++) {
      _groups[i] = groups[i];
    }
  }

  function getGroup(uint256 _groupId) public view validGroup(_groupId) returns (Group memory) {
    return groups[_groupId];
  }

  function getGroupStartTime(uint256 _groupId) public view validGroup(_groupId) returns (uint256) {
    return groups[_groupId].startTime;
  }

  function getGroupEndTime(uint256 _groupId) public view validGroup(_groupId) returns (uint256) {
    return groups[_groupId].endTime;
  }

  function getGroupPrice(uint256 _groupId) public view validGroup(_groupId) returns (uint256) {
    return groups[_groupId].price;
  }

  // generic deposit

  receive() external payable {}
}