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



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.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 anymore. Can only be called by the current owner.
     *
     * NOTE: Renouncing ownership will leave the contract without an owner,
     * thereby removing any functionality that is only available to the owner.
     */
    function renounceOwnership() public virtual onlyOwner {
        _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/ReentrancyGuard.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (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() {
        // On the first call to nonReentrant, _notEntered will be true
        require(_status != _ENTERED, "ReentrancyGuard: reentrant call");

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

        _;

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

// File: @openzeppelin/contracts/token/ERC721/ERC721.sol



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

pragma solidity ^0.8.0;

import "./IERC721.sol";
import "./IERC721Receiver.sol";
import "./extensions/IERC721Metadata.sol";
import "../../utils/Address.sol";
import "../../utils/Context.sol";
import "../../utils/Strings.sol";
import "../../utils/introspection/ERC165.sol";

/**
 * @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
 * the Metadata extension, but not including the Enumerable extension, which is available separately as
 * {ERC721Enumerable}.
 */
contract ERC721 is Context, ERC165, IERC721, IERC721Metadata {
    using Address for address;
    using Strings for uint256;

    // Token name
    string private _name;

    // Token symbol
    string private _symbol;

    // Mapping from token ID to owner address
    mapping(uint256 => address) private _owners;

    // Mapping owner address to token count
    mapping(address => uint256) private _balances;

    // Mapping from token ID to approved address
    mapping(uint256 => address) private _tokenApprovals;

    // Mapping from owner to operator approvals
    mapping(address => mapping(address => bool)) private _operatorApprovals;

    /**
     * @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
     */
    constructor(string memory name_, string memory symbol_) {
        _name = name_;
        _symbol = symbol_;
    }

    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
        return
            interfaceId == type(IERC721).interfaceId ||
            interfaceId == type(IERC721Metadata).interfaceId ||
            super.supportsInterface(interfaceId);
    }

    /**
     * @dev See {IERC721-balanceOf}.
     */
    function balanceOf(address owner) public view virtual override returns (uint256) {
        require(owner != address(0), "ERC721: address zero is not a valid owner");
        return _balances[owner];
    }

    /**
     * @dev See {IERC721-ownerOf}.
     */
    function ownerOf(uint256 tokenId) public view virtual override returns (address) {
        address owner = _owners[tokenId];
        require(owner != address(0), "ERC721: invalid token ID");
        return owner;
    }

    /**
     * @dev See {IERC721Metadata-name}.
     */
    function name() public view virtual override returns (string memory) {
        return _name;
    }

    /**
     * @dev See {IERC721Metadata-symbol}.
     */
    function symbol() public view virtual override returns (string memory) {
        return _symbol;
    }

    /**
     * @dev See {IERC721Metadata-tokenURI}.
     */
    function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
        _requireMinted(tokenId);

        string memory baseURI = _baseURI();
        return bytes(baseURI).length > 0 ? string(abi.encodePacked(baseURI, tokenId.toString())) : "";
    }

    /**
     * @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
     * token will be the concatenation of the `baseURI` and the `tokenId`. Empty
     * by default, can be overridden in child contracts.
     */
    function _baseURI() internal view virtual returns (string memory) {
        return "";
    }

    /**
     * @dev See {IERC721-approve}.
     */
    function approve(address to, uint256 tokenId) public virtual override {
        address owner = ERC721.ownerOf(tokenId);
        require(to != owner, "ERC721: approval to current owner");

        require(
            _msgSender() == owner || isApprovedForAll(owner, _msgSender()),
            "ERC721: approve caller is not token owner nor approved for all"
        );

        _approve(to, tokenId);
    }

    /**
     * @dev See {IERC721-getApproved}.
     */
    function getApproved(uint256 tokenId) public view virtual override returns (address) {
        _requireMinted(tokenId);

        return _tokenApprovals[tokenId];
    }

    /**
     * @dev See {IERC721-setApprovalForAll}.
     */
    function setApprovalForAll(address operator, bool approved) public virtual override {
        _setApprovalForAll(_msgSender(), operator, approved);
    }

    /**
     * @dev See {IERC721-isApprovedForAll}.
     */
    function isApprovedForAll(address owner, address operator) public view virtual override returns (bool) {
        return _operatorApprovals[owner][operator];
    }

    /**
     * @dev See {IERC721-transferFrom}.
     */
    function transferFrom(
        address from,
        address to,
        uint256 tokenId
    ) public virtual override {
        //solhint-disable-next-line max-line-length
        require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved");

        _transfer(from, to, tokenId);
    }

    /**
     * @dev See {IERC721-safeTransferFrom}.
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 tokenId
    ) public virtual override {
        safeTransferFrom(from, to, tokenId, "");
    }

    /**
     * @dev See {IERC721-safeTransferFrom}.
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 tokenId,
        bytes memory data
    ) public virtual override {
        require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner nor approved");
        _safeTransfer(from, to, tokenId, data);
    }

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
     * are aware of the ERC721 protocol to prevent tokens from being forever locked.
     *
     * `data` is additional data, it has no specified format and it is sent in call to `to`.
     *
     * This internal function is equivalent to {safeTransferFrom}, and can be used to e.g.
     * implement alternative mechanisms to perform token transfer, such as signature-based.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeTransfer(
        address from,
        address to,
        uint256 tokenId,
        bytes memory data
    ) internal virtual {
        _transfer(from, to, tokenId);
        require(_checkOnERC721Received(from, to, tokenId, data), "ERC721: transfer to non ERC721Receiver implementer");
    }

    /**
     * @dev Returns whether `tokenId` exists.
     *
     * Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}.
     *
     * Tokens start existing when they are minted (`_mint`),
     * and stop existing when they are burned (`_burn`).
     */
    function _exists(uint256 tokenId) internal view virtual returns (bool) {
        return _owners[tokenId] != address(0);
    }

    /**
     * @dev Returns whether `spender` is allowed to manage `tokenId`.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function _isApprovedOrOwner(address spender, uint256 tokenId) internal view virtual returns (bool) {
        address owner = ERC721.ownerOf(tokenId);
        return (spender == owner || isApprovedForAll(owner, spender) || getApproved(tokenId) == spender);
    }

    /**
     * @dev Safely mints `tokenId` and transfers it to `to`.
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeMint(address to, uint256 tokenId) internal virtual {
        _safeMint(to, tokenId, "");
    }

    /**
     * @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
     * forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
     */
    function _safeMint(
        address to,
        uint256 tokenId,
        bytes memory data
    ) internal virtual {
        _mint(to, tokenId);
        require(
            _checkOnERC721Received(address(0), to, tokenId, data),
            "ERC721: transfer to non ERC721Receiver implementer"
        );
    }

    /**
     * @dev Mints `tokenId` and transfers it to `to`.
     *
     * WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - `to` cannot be the zero address.
     *
     * Emits a {Transfer} event.
     */
    function _mint(address to, uint256 tokenId) internal virtual {
        require(to != address(0), "ERC721: mint to the zero address");
        require(!_exists(tokenId), "ERC721: token already minted");

        _beforeTokenTransfer(address(0), to, tokenId);

        _balances[to] += 1;
        _owners[tokenId] = to;

        emit Transfer(address(0), to, tokenId);

        _afterTokenTransfer(address(0), to, tokenId);
    }

    /**
     * @dev Destroys `tokenId`.
     * The approval is cleared when the token is burned.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     *
     * Emits a {Transfer} event.
     */
    function _burn(uint256 tokenId) internal virtual {
        address owner = ERC721.ownerOf(tokenId);

        _beforeTokenTransfer(owner, address(0), tokenId);

        // Clear approvals
        _approve(address(0), tokenId);

        _balances[owner] -= 1;
        delete _owners[tokenId];

        emit Transfer(owner, address(0), tokenId);

        _afterTokenTransfer(owner, address(0), tokenId);
    }

    /**
     * @dev Transfers `tokenId` from `from` to `to`.
     *  As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     *
     * Emits a {Transfer} event.
     */
    function _transfer(
        address from,
        address to,
        uint256 tokenId
    ) internal virtual {
        require(ERC721.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner");
        require(to != address(0), "ERC721: transfer to the zero address");

        _beforeTokenTransfer(from, to, tokenId);

        // Clear approvals from the previous owner
        _approve(address(0), tokenId);

        _balances[from] -= 1;
        _balances[to] += 1;
        _owners[tokenId] = to;

        emit Transfer(from, to, tokenId);

        _afterTokenTransfer(from, to, tokenId);
    }

    /**
     * @dev Approve `to` to operate on `tokenId`
     *
     * Emits an {Approval} event.
     */
    function _approve(address to, uint256 tokenId) internal virtual {
        _tokenApprovals[tokenId] = to;
        emit Approval(ERC721.ownerOf(tokenId), to, tokenId);
    }

    /**
     * @dev Approve `operator` to operate on all of `owner` tokens
     *
     * Emits an {ApprovalForAll} event.
     */
    function _setApprovalForAll(
        address owner,
        address operator,
        bool approved
    ) internal virtual {
        require(owner != operator, "ERC721: approve to caller");
        _operatorApprovals[owner][operator] = approved;
        emit ApprovalForAll(owner, operator, approved);
    }

    /**
     * @dev Reverts if the `tokenId` has not been minted yet.
     */
    function _requireMinted(uint256 tokenId) internal view virtual {
        require(_exists(tokenId), "ERC721: invalid token ID");
    }

    /**
     * @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address.
     * The call is not executed if the target address is not a contract.
     *
     * @param from address representing the previous owner of the given token ID
     * @param to target address that will receive the tokens
     * @param tokenId uint256 ID of the token to be transferred
     * @param data bytes optional data to send along with the call
     * @return bool whether the call correctly returned the expected magic value
     */
    function _checkOnERC721Received(
        address from,
        address to,
        uint256 tokenId,
        bytes memory data
    ) private returns (bool) {
        if (to.isContract()) {
            try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) {
                return retval == IERC721Receiver.onERC721Received.selector;
            } catch (bytes memory reason) {
                if (reason.length == 0) {
                    revert("ERC721: transfer to non ERC721Receiver implementer");
                } else {
                    /// @solidity memory-safe-assembly
                    assembly {
                        revert(add(32, reason), mload(reason))
                    }
                }
            }
        } else {
            return true;
        }
    }

    /**
     * @dev Hook that is called before any token transfer. This includes minting
     * and burning.
     *
     * Calling conditions:
     *
     * - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be
     * transferred to `to`.
     * - When `from` is zero, `tokenId` will be minted for `to`.
     * - When `to` is zero, ``from``'s `tokenId` 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 tokenId
    ) 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.
     * - `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 tokenId
    ) internal virtual {}
}

// File: @openzeppelin/contracts/token/ERC721/IERC721.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC721/IERC721.sol)

pragma solidity ^0.8.0;

import "../../utils/introspection/IERC165.sol";

/**
 * @dev Required interface of an ERC721 compliant contract.
 */
interface IERC721 is IERC165 {
    /**
     * @dev Emitted when `tokenId` token is transferred from `from` to `to`.
     */
    event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
     */
    event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
     */
    event ApprovalForAll(address indexed owner, address indexed operator, bool approved);

    /**
     * @dev Returns the number of tokens in ``owner``'s account.
     */
    function balanceOf(address owner) external view returns (uint256 balance);

    /**
     * @dev Returns the owner of the `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function ownerOf(uint256 tokenId) external view returns (address owner);

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 tokenId,
        bytes calldata data
    ) external;

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
     * are aware of the ERC721 protocol to prevent tokens from being forever locked.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must have been allowed to move this token by either {approve} or {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 tokenId
    ) external;

    /**
     * @dev Transfers `tokenId` token from `from` to `to`.
     *
     * WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(
        address from,
        address to,
        uint256 tokenId
    ) external;

    /**
     * @dev Gives permission to `to` to transfer `tokenId` token to another account.
     * The approval is cleared when the token is transferred.
     *
     * Only a single account can be approved at a time, so approving the zero address clears previous approvals.
     *
     * Requirements:
     *
     * - The caller must own the token or be an approved operator.
     * - `tokenId` must exist.
     *
     * Emits an {Approval} event.
     */
    function approve(address to, uint256 tokenId) external;

    /**
     * @dev Approve or remove `operator` as an operator for the caller.
     * Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
     *
     * Requirements:
     *
     * - The `operator` cannot be the caller.
     *
     * Emits an {ApprovalForAll} event.
     */
    function setApprovalForAll(address operator, bool _approved) external;

    /**
     * @dev Returns the account approved for `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function getApproved(uint256 tokenId) external view returns (address operator);

    /**
     * @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
     *
     * See {setApprovalForAll}
     */
    function isApprovedForAll(address owner, address operator) external view returns (bool);
}

// File: @openzeppelin/contracts/token/ERC721/IERC721Receiver.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC721/IERC721Receiver.sol)

pragma solidity ^0.8.0;

/**
 * @title ERC721 token receiver interface
 * @dev Interface for any contract that wants to support safeTransfers
 * from ERC721 asset contracts.
 */
interface IERC721Receiver {
    /**
     * @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
     * by `operator` from `from`, this function is called.
     *
     * It must return its Solidity selector to confirm the token transfer.
     * If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted.
     *
     * The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
     */
    function onERC721Received(
        address operator,
        address from,
        uint256 tokenId,
        bytes calldata data
    ) external returns (bytes4);
}

// File: @openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol)

pragma solidity ^0.8.0;

import "../IERC721.sol";

/**
 * @title ERC-721 Non-Fungible Token Standard, optional metadata extension
 * @dev See https://eips.ethereum.org/EIPS/eip-721
 */
interface IERC721Metadata is IERC721 {
    /**
     * @dev Returns the token collection name.
     */
    function name() external view returns (string memory);

    /**
     * @dev Returns the token collection symbol.
     */
    function symbol() external view returns (string memory);

    /**
     * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
     */
    function tokenURI(uint256 tokenId) external view returns (string memory);
}

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



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

pragma solidity ^0.8.1;

/**
 * @dev Collection of functions related to the address type
 */
library Address {
    /**
     * @dev Returns true if `account` is a contract.
     *
     * [IMPORTANT]
     * ====
     * It is unsafe to assume that an address for which this function returns
     * false is an externally-owned account (EOA) and not a contract.
     *
     * Among others, `isContract` will return false for the following
     * types of addresses:
     *
     *  - an externally-owned account
     *  - a contract in construction
     *  - an address where a contract will be created
     *  - an address where a contract lived, but was destroyed
     * ====
     *
     * [IMPORTANT]
     * ====
     * You shouldn't rely on `isContract` to protect against flash loan attacks!
     *
     * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
     * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
     * constructor.
     * ====
     */
    function isContract(address account) internal view returns (bool) {
        // This method relies on extcodesize/address.code.length, which returns 0
        // for contracts in construction, since the code is only stored at the end
        // of the constructor execution.

        return account.code.length > 0;
    }

    /**
     * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
     * `recipient`, forwarding all available gas and reverting on errors.
     *
     * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
     * of certain opcodes, possibly making contracts go over the 2300 gas limit
     * imposed by `transfer`, making them unable to receive funds via
     * `transfer`. {sendValue} removes this limitation.
     *
     * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
     *
     * IMPORTANT: because control is transferred to `recipient`, care must be
     * taken to not create reentrancy vulnerabilities. Consider using
     * {ReentrancyGuard} or the
     * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
     */
    function sendValue(address payable recipient, uint256 amount) internal {
        require(address(this).balance >= amount, "Address: insufficient balance");

        (bool success, ) = recipient.call{value: amount}("");
        require(success, "Address: unable to send value, recipient may have reverted");
    }

    /**
     * @dev Performs a Solidity function call using a low level `call`. A
     * plain `call` is an unsafe replacement for a function call: use this
     * function instead.
     *
     * If `target` reverts with a revert reason, it is bubbled up by this
     * function (like regular Solidity function calls).
     *
     * Returns the raw returned data. To convert to the expected return value,
     * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
     *
     * Requirements:
     *
     * - `target` must be a contract.
     * - calling `target` with `data` must not revert.
     *
     * _Available since v3.1._
     */
    function functionCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionCall(target, data, "Address: low-level call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
     * `errorMessage` as a fallback revert reason when `target` reverts.
     *
     * _Available since v3.1._
     */
    function functionCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal returns (bytes memory) {
        return functionCallWithValue(target, data, 0, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but also transferring `value` wei to `target`.
     *
     * Requirements:
     *
     * - the calling contract must have an ETH balance of at least `value`.
     * - the called Solidity function must be `payable`.
     *
     * _Available since v3.1._
     */
    function functionCallWithValue(
        address target,
        bytes memory data,
        uint256 value
    ) internal returns (bytes memory) {
        return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
    }

    /**
     * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
     * with `errorMessage` as a fallback revert reason when `target` reverts.
     *
     * _Available since v3.1._
     */
    function functionCallWithValue(
        address target,
        bytes memory data,
        uint256 value,
        string memory errorMessage
    ) internal returns (bytes memory) {
        require(address(this).balance >= value, "Address: insufficient balance for call");
        require(isContract(target), "Address: call to non-contract");

        (bool success, bytes memory returndata) = target.call{value: value}(data);
        return verifyCallResult(success, returndata, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a static call.
     *
     * _Available since v3.3._
     */
    function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
        return functionStaticCall(target, data, "Address: low-level static call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a static call.
     *
     * _Available since v3.3._
     */
    function functionStaticCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal view returns (bytes memory) {
        require(isContract(target), "Address: static call to non-contract");

        (bool success, bytes memory returndata) = target.staticcall(data);
        return verifyCallResult(success, returndata, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a delegate call.
     *
     * _Available since v3.4._
     */
    function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionDelegateCall(target, data, "Address: low-level delegate call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a delegate call.
     *
     * _Available since v3.4._
     */
    function functionDelegateCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal returns (bytes memory) {
        require(isContract(target), "Address: delegate call to non-contract");

        (bool success, bytes memory returndata) = target.delegatecall(data);
        return verifyCallResult(success, returndata, errorMessage);
    }

    /**
     * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
     * revert reason using the provided one.
     *
     * _Available since v4.3._
     */
    function verifyCallResult(
        bool success,
        bytes memory returndata,
        string memory errorMessage
    ) internal pure returns (bytes memory) {
        if (success) {
            return returndata;
        } else {
            // Look for revert reason and bubble it up if present
            if (returndata.length > 0) {
                // The easiest way to bubble the revert reason is using memory via assembly
                /// @solidity memory-safe-assembly
                assembly {
                    let returndata_size := mload(returndata)
                    revert(add(32, returndata), returndata_size)
                }
            } else {
                revert(errorMessage);
            }
        }
    }
}

// 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/Strings.sol



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

pragma solidity ^0.8.0;

/**
 * @dev String operations.
 */
library Strings {
    bytes16 private constant _HEX_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) {
        // Inspired by OraclizeAPI's implementation - MIT licence
        // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol

        if (value == 0) {
            return "0";
        }
        uint256 temp = value;
        uint256 digits;
        while (temp != 0) {
            digits++;
            temp /= 10;
        }
        bytes memory buffer = new bytes(digits);
        while (value != 0) {
            digits -= 1;
            buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
            value /= 10;
        }
        return string(buffer);
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
     */
    function toHexString(uint256 value) internal pure returns (string memory) {
        if (value == 0) {
            return "0x00";
        }
        uint256 temp = value;
        uint256 length = 0;
        while (temp != 0) {
            length++;
            temp >>= 8;
        }
        return toHexString(value, length);
    }

    /**
     * @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] = _HEX_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);
    }
}

// File: @openzeppelin/contracts/utils/introspection/ERC165.sol



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

pragma solidity ^0.8.0;

import "./IERC165.sol";

/**
 * @dev Implementation of the {IERC165} interface.
 *
 * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
 * for the additional interface id that will be supported. For example:
 *
 * ```solidity
 * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
 *     return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
 * }
 * ```
 *
 * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
 */
abstract contract ERC165 is IERC165 {
    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
        return interfaceId == type(IERC165).interfaceId;
    }
}

// File: @openzeppelin/contracts/utils/introspection/IERC165.sol



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

pragma solidity ^0.8.0;

/**
 * @dev Interface of the ERC165 standard, as defined in the
 * https://eips.ethereum.org/EIPS/eip-165[EIP].
 *
 * Implementers can declare support of contract interfaces, which can then be
 * queried by others ({ERC165Checker}).
 *
 * For an implementation, see {ERC165}.
 */
interface IERC165 {
    /**
     * @dev Returns true if this contract implements the interface defined by
     * `interfaceId`. See the corresponding
     * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
     * to learn more about how these ids are created.
     *
     * This function call must use less than 30 000 gas.
     */
    function supportsInterface(bytes4 interfaceId) external view returns (bool);
}

// File: @openzeppelin/contracts/utils/math/Math.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.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) {
                return prod0 / denominator;
            }

            // Make sure the result is less than 2^256. Also prevents denominator == 0.
            require(denominator > prod1);

            ///////////////////////////////////////////////
            // 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. It 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)`.
        // We also know that `k`, the position of the most significant bit, is such that `msb(a) = 2**k`.
        // This gives `2**k < a <= 2**(k+1)` → `2**(k/2) <= sqrt(a) < 2 ** (k/2+1)`.
        // Using an algorithm similar to the msb conmputation, we are able to compute `result = 2**(k/2)` which is a
        // good first aproximation of `sqrt(a)` with at least 1 correct bit.
        uint256 result = 1;
        uint256 x = a;
        if (x >> 128 > 0) {
            x >>= 128;
            result <<= 64;
        }
        if (x >> 64 > 0) {
            x >>= 64;
            result <<= 32;
        }
        if (x >> 32 > 0) {
            x >>= 32;
            result <<= 16;
        }
        if (x >> 16 > 0) {
            x >>= 16;
            result <<= 8;
        }
        if (x >> 8 > 0) {
            x >>= 8;
            result <<= 4;
        }
        if (x >> 4 > 0) {
            x >>= 4;
            result <<= 2;
        }
        if (x >> 2 > 0) {
            result <<= 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) {
        uint256 result = sqrt(a);
        if (rounding == Rounding.Up && result * result < a) {
            result += 1;
        }
        return result;
    }
}

// File: @openzeppelin/contracts/utils/math/SafeMath.sol



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

pragma solidity ^0.8.0;

// CAUTION
// This version of SafeMath should only be used with Solidity 0.8 or later,
// because it relies on the compiler's built in overflow checks.

/**
 * @dev Wrappers over Solidity's arithmetic operations.
 *
 * NOTE: `SafeMath` is generally not needed starting with Solidity 0.8, since the compiler
 * now has built in overflow checking.
 */
library SafeMath {
    /**
     * @dev Returns the addition of two unsigned integers, with an overflow flag.
     *
     * _Available since v3.4._
     */
    function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            uint256 c = a + b;
            if (c < a) return (false, 0);
            return (true, c);
        }
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, with an overflow flag.
     *
     * _Available since v3.4._
     */
    function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b > a) return (false, 0);
            return (true, a - b);
        }
    }

    /**
     * @dev Returns the multiplication of two unsigned integers, with an overflow flag.
     *
     * _Available since v3.4._
     */
    function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
            // benefit is lost if 'b' is also tested.
            // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
            if (a == 0) return (true, 0);
            uint256 c = a * b;
            if (c / a != b) return (false, 0);
            return (true, c);
        }
    }

    /**
     * @dev Returns the division of two unsigned integers, with a division by zero flag.
     *
     * _Available since v3.4._
     */
    function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b == 0) return (false, 0);
            return (true, a / b);
        }
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
     *
     * _Available since v3.4._
     */
    function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b == 0) return (false, 0);
            return (true, a % b);
        }
    }

    /**
     * @dev Returns the addition of two unsigned integers, reverting on
     * overflow.
     *
     * Counterpart to Solidity's `+` operator.
     *
     * Requirements:
     *
     * - Addition cannot overflow.
     */
    function add(uint256 a, uint256 b) internal pure returns (uint256) {
        return a + b;
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, reverting on
     * overflow (when the result is negative).
     *
     * Counterpart to Solidity's `-` operator.
     *
     * Requirements:
     *
     * - Subtraction cannot overflow.
     */
    function sub(uint256 a, uint256 b) internal pure returns (uint256) {
        return a - b;
    }

    /**
     * @dev Returns the multiplication of two unsigned integers, reverting on
     * overflow.
     *
     * Counterpart to Solidity's `*` operator.
     *
     * Requirements:
     *
     * - Multiplication cannot overflow.
     */
    function mul(uint256 a, uint256 b) internal pure returns (uint256) {
        return a * b;
    }

    /**
     * @dev Returns the integer division of two unsigned integers, reverting on
     * division by zero. The result is rounded towards zero.
     *
     * Counterpart to Solidity's `/` operator.
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function div(uint256 a, uint256 b) internal pure returns (uint256) {
        return a / b;
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
     * reverting when dividing by zero.
     *
     * Counterpart to Solidity's `%` operator. This function uses a `revert`
     * opcode (which leaves remaining gas untouched) while Solidity uses an
     * invalid opcode to revert (consuming all remaining gas).
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function mod(uint256 a, uint256 b) internal pure returns (uint256) {
        return a % b;
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, reverting with custom message on
     * overflow (when the result is negative).
     *
     * CAUTION: This function is deprecated because it requires allocating memory for the error
     * message unnecessarily. For custom revert reasons use {trySub}.
     *
     * Counterpart to Solidity's `-` operator.
     *
     * Requirements:
     *
     * - Subtraction cannot overflow.
     */
    function sub(
        uint256 a,
        uint256 b,
        string memory errorMessage
    ) internal pure returns (uint256) {
        unchecked {
            require(b <= a, errorMessage);
            return a - b;
        }
    }

    /**
     * @dev Returns the integer division of two unsigned integers, reverting with custom message on
     * division by zero. The result is rounded towards zero.
     *
     * Counterpart to Solidity's `/` operator. Note: this function uses a
     * `revert` opcode (which leaves remaining gas untouched) while Solidity
     * uses an invalid opcode to revert (consuming all remaining gas).
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function div(
        uint256 a,
        uint256 b,
        string memory errorMessage
    ) internal pure returns (uint256) {
        unchecked {
            require(b > 0, errorMessage);
            return a / b;
        }
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
     * reverting with custom message when dividing by zero.
     *
     * CAUTION: This function is deprecated because it requires allocating memory for the error
     * message unnecessarily. For custom revert reasons use {tryMod}.
     *
     * Counterpart to Solidity's `%` operator. This function uses a `revert`
     * opcode (which leaves remaining gas untouched) while Solidity uses an
     * invalid opcode to revert (consuming all remaining gas).
     *
     * Requirements:
     *
     * - The divisor cannot be zero.
     */
    function mod(
        uint256 a,
        uint256 b,
        string memory errorMessage
    ) internal pure returns (uint256) {
        unchecked {
            require(b > 0, errorMessage);
            return a % b;
        }
    }
}

// File: base64-sol/base64.sol



// SPDX-License-Identifier: MIT

pragma solidity >=0.6.0;

/// @title Base64
/// @author Brecht Devos - <brecht@loopring.org>
/// @notice Provides functions for encoding/decoding base64
library Base64 {
    string internal constant TABLE_ENCODE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
    bytes  internal constant TABLE_DECODE = hex"0000000000000000000000000000000000000000000000000000000000000000"
                                            hex"00000000000000000000003e0000003f3435363738393a3b3c3d000000000000"
                                            hex"00000102030405060708090a0b0c0d0e0f101112131415161718190000000000"
                                            hex"001a1b1c1d1e1f202122232425262728292a2b2c2d2e2f303132330000000000";

    function encode(bytes memory data) internal pure returns (string memory) {
        if (data.length == 0) return '';

        // load the table into memory
        string memory table = TABLE_ENCODE;

        // multiply by 4/3 rounded up
        uint256 encodedLen = 4 * ((data.length + 2) / 3);

        // add some extra buffer at the end required for the writing
        string memory result = new string(encodedLen + 32);

        assembly {
            // set the actual output length
            mstore(result, encodedLen)

            // prepare the lookup table
            let tablePtr := add(table, 1)

            // input ptr
            let dataPtr := data
            let endPtr := add(dataPtr, mload(data))

            // result ptr, jump over length
            let resultPtr := add(result, 32)

            // run over the input, 3 bytes at a time
            for {} lt(dataPtr, endPtr) {}
            {
                // read 3 bytes
                dataPtr := add(dataPtr, 3)
                let input := mload(dataPtr)

                // write 4 characters
                mstore8(resultPtr, mload(add(tablePtr, and(shr(18, input), 0x3F))))
                resultPtr := add(resultPtr, 1)
                mstore8(resultPtr, mload(add(tablePtr, and(shr(12, input), 0x3F))))
                resultPtr := add(resultPtr, 1)
                mstore8(resultPtr, mload(add(tablePtr, and(shr( 6, input), 0x3F))))
                resultPtr := add(resultPtr, 1)
                mstore8(resultPtr, mload(add(tablePtr, and(        input,  0x3F))))
                resultPtr := add(resultPtr, 1)
            }

            // padding with '='
            switch mod(mload(data), 3)
            case 1 { mstore(sub(resultPtr, 2), shl(240, 0x3d3d)) }
            case 2 { mstore(sub(resultPtr, 1), shl(248, 0x3d)) }
        }

        return result;
    }

    function decode(string memory _data) internal pure returns (bytes memory) {
        bytes memory data = bytes(_data);

        if (data.length == 0) return new bytes(0);
        require(data.length % 4 == 0, "invalid base64 decoder input");

        // load the table into memory
        bytes memory table = TABLE_DECODE;

        // every 4 characters represent 3 bytes
        uint256 decodedLen = (data.length / 4) * 3;

        // add some extra buffer at the end required for the writing
        bytes memory result = new bytes(decodedLen + 32);

        assembly {
            // padding with '='
            let lastBytes := mload(add(data, mload(data)))
            if eq(and(lastBytes, 0xFF), 0x3d) {
                decodedLen := sub(decodedLen, 1)
                if eq(and(lastBytes, 0xFFFF), 0x3d3d) {
                    decodedLen := sub(decodedLen, 1)
                }
            }

            // set the actual output length
            mstore(result, decodedLen)

            // prepare the lookup table
            let tablePtr := add(table, 1)

            // input ptr
            let dataPtr := data
            let endPtr := add(dataPtr, mload(data))

            // result ptr, jump over length
            let resultPtr := add(result, 32)

            // run over the input, 4 characters at a time
            for {} lt(dataPtr, endPtr) {}
            {
               // read 4 characters
               dataPtr := add(dataPtr, 4)
               let input := mload(dataPtr)

               // write 3 bytes
               let output := add(
                   add(
                       shl(18, and(mload(add(tablePtr, and(shr(24, input), 0xFF))), 0xFF)),
                       shl(12, and(mload(add(tablePtr, and(shr(16, input), 0xFF))), 0xFF))),
                   add(
                       shl( 6, and(mload(add(tablePtr, and(shr( 8, input), 0xFF))), 0xFF)),
                               and(mload(add(tablePtr, and(        input , 0xFF))), 0xFF)
                    )
                )
                mstore(resultPtr, shl(232, output))
                resultPtr := add(resultPtr, 3)
            }
        }

        return result;
    }
}

// File: contracts/ArtCreator.sol



// SPDX-License-Identifier: MIT

pragma solidity ^0.8.9;

import "@openzeppelin/contracts/utils/Strings.sol";
import "base64-sol/base64.sol";

abstract contract ArtCreator {
    using Strings for string;

    struct colorHSL {
        uint8 h;
        uint8 s;
        uint8 l;
    }

    struct iconStyle {
        string fillTl;
        string fillTr;
        string fillMl;
        string fillMr;
        string fillBl;
        string fillBr;
        string stroke;
        uint8 strokeWidth;
    }

    struct svgStyle {
        colorHSL baseColor;
        colorHSL textColorStart;
        colorHSL textColorEnd;
        bool motion;
        iconStyle iconstyle;
    }

    /***************
     * Main Methods *
     ***************/

    function generateMetadata(uint256 tokenId, uint256 MAX_TOKENS) internal view virtual returns (string memory) {
        svgStyle memory style = getStyles(tokenId);

        return
            string(
                abi.encodePacked(
                    "data:application/json;base64,",
                    Base64.encode(
                        bytes(
                            abi.encodePacked(
                                '{"name":"Historical Moments: The Merge - Token',
                                " #",
                                Strings.toString(tokenId),
                                '", "description":"',
                                "The image of this NFT is created by its first 16 transfers, populating a 4x4 grid of squares. A new colored square is added on each transfer. The `to` address of the transfer determines the color. Each of the first 16 `transfered to` addresses get a copy of this NFT. The image is entirely Solidity generated.",
                                '", "attributes":[',
                                getTraitsString(style),
                                '], "image": "',
                                "data:image/svg+xml;base64,",
                                Base64.encode(bytes(generateSVG(tokenId, MAX_TOKENS, style))),
                                '"}'
                            )
                        )
                    )
                )
            );
    }

    function generateSVG(
        uint256 tokenId,
        uint256 MAX_TOKENS,
        svgStyle memory style
    ) internal view virtual returns (string memory) {
        return
            string(
                abi.encodePacked(
                    '<svg version="1.1" ',
                    ' style="background:linear-gradient(to bottom, ',
                    hslToString(style.baseColor),
                    ", ",
                    hslToString(style.baseColor),
                    ')" ',
                    ' id="Layer_1" x="0px" y="0px" viewBox="0 0 500 500" width="500" height="500" ',
                    ' xml:space="preserve" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">',
                    "<defs>",
                    '    <linearGradient id="textGrad" x1="0" y1="0" x2="0" y2="100%">',
                    '        <stop offset="0%" stop-color="',
                    hslToString(style.textColorStart),
                    '" />',
                    '        <stop offset="100%" stop-color="',
                    hslToString(style.textColorEnd),
                    '" />',
                    "    </linearGradient>",
                    "</defs>",
                    generateTextDifficulty(),
                    style.motion ? generateEthIconAnimated(style) : generateEthIconStill(style),
                    generateTextOneOf(tokenId, MAX_TOKENS),
                    "</svg>"
                )
            );
    }

    function generateEthIconAnimated(svgStyle memory style) internal view virtual returns (string memory) {
        return
            string(
                abi.encodePacked(
                    '<g transform="matrix(.74 0 0 0.74 154 93)" opacity=".5" stroke="',
                    style.iconstyle.stroke,
                    '" stroke-width="',
                    Strings.toString(style.iconstyle.strokeWidth),
                    '">',
                    '  <animate attributeName="opacity" from="0.5" to="0.95" begin="0s" dur="10s" fill="freeze" />',
                    '  <polygon points="127,0 125,9.5 125,285 127,287 255,212" fill="',
                    style.iconstyle.fillTr,
                    '">',
                    '    <animateTransform id="tr" attributeName="transform" type="translate" from="200 -50" to="0 0" begin="0s;tr.end+5s" dur="5s" />',
                    "  </polygon>",
                    '  <polygon points="127,0 0,212 127,287 127,154" fill="',
                    style.iconstyle.fillTl,
                    '">',
                    '    <animateTransform id="tl" attributeName="transform" type="translate" from="-140 -100" to="0 0" begin="0s;tl.end+5s" dur="5s" />',
                    "  </polygon>",
                    '  <polygon points="127,287 255,212 127,154" fill="',
                    style.iconstyle.fillMr,
                    '">',
                    '    <animateTransform id="mr" attributeName="transform" type="translate" from="100 50" to="0 0" begin="0s;mr.end+5s" dur="5s" />',
                    "  </polygon>",
                    '  <polygon points="0,212 127,287 127,154" fill="',
                    style.iconstyle.fillMl,
                    '">',
                    '    <animateTransform id="ml" attributeName="transform" type="translate" from="-120 60" to="0 0" begin="0s;ml.end+5s" dur="5s" />',
                    "  </polygon>",
                    '  <polygon points="127,312 126,314 126,412 127,416 255,236" fill="',
                    style.iconstyle.fillBr,
                    '">',
                    '    <animateTransform id="br" attributeName="transform" type="translate" from="150 150" to="0 0" begin="0s;br.end+5s" dur="5s" />',
                    "  </polygon>",
                    '  <polygon points="127,416 127,312 0,236" fill="',
                    style.iconstyle.fillBl,
                    '">',
                    '    <animateTransform id="bl" attributeName="transform" type="translate" from="-150 120" to="0 0" begin="0s;bl.end+5s" dur="5s"  />',
                    "  </polygon>",
                    "</g>"
                )
            );
    }

    function generateEthIconStill(svgStyle memory style) internal view virtual returns (string memory) {
        return
            string(
                abi.encodePacked(
                    '<g transform="matrix(.74 0 0 0.74 154 93)" opacity=".95" stroke="',
                    style.iconstyle.stroke,
                    '" stroke-width="',
                    Strings.toString(style.iconstyle.strokeWidth),
                    '">',
                    '  <polygon points="127,0 125,9.5 125,285 127,287 255,212" fill="',
                    style.iconstyle.fillTr,
                    '">',
                    "  </polygon>",
                    '  <polygon points="127,0 0,212 127,287 127,154" fill="',
                    style.iconstyle.fillTl,
                    '">',
                    "  </polygon>",
                    '  <polygon points="127,287 255,212 127,154" fill="',
                    style.iconstyle.fillMr,
                    '">',
                    "  </polygon>",
                    '  <polygon points="0,212 127,287 127,154" fill="',
                    style.iconstyle.fillMl,
                    '">',
                    "  </polygon>",
                    '  <polygon points="127,312 126,314 126,412 127,416 255,236" fill="',
                    style.iconstyle.fillBr,
                    '">',
                    "  </polygon>",
                    '  <polygon points="127,416 127,312 0,236" fill="',
                    style.iconstyle.fillBl,
                    '">',
                    "  </polygon>",
                    "</g>"
                )
            );
    }

    function generateTextDifficulty() internal pure virtual returns (string memory) {
        return
            string(
                abi.encodePacked(
                    '<text fill="url(#textGrad)" ',
                    ' fill-opacity="0.8" font-size="100" letter-spacing="10" transform="translate(75 139)">',
                    '    <tspan y="0">587500</tspan>',
                    '    <tspan x="0" y="100">000000</tspan>',
                    '    <tspan x="0" y="200">000000</tspan>',
                    '    <tspan x="30" y="300">00000</tspan>',
                    "</text>"
                )
            );
    }

    function generateTextOneOf(uint256 tokenId, uint256 MAX_TOKENS) internal view virtual returns (string memory) {
        return
            string(
                abi.encodePacked(
                    '<text dx="0" dy="0" font-size="12" dominant-baseline="middle" text-anchor="middle" transform="translate(250 480)" fill="#fff" stroke-width="0" opacity=".6">',
                    "  <![CDATA[#",
                    Strings.toString(tokenId),
                    " / ",
                    Strings.toString(MAX_TOKENS),
                    " ]]>",
                    "</text>"
                )
            );
    }

    /***************
     * Helpers *
     ***************/

    function getTraitsString(svgStyle memory style) internal view virtual returns (string memory) {
        return
            string(
                abi.encodePacked(
                    '{"trait_type": "Base Color", "value": "',
                    getColorNameFromHsl(style.baseColor),
                    '"},',
                    '{"trait_type": "ETH Icon Color", "value": "',
                    (keccak256(bytes(style.iconstyle.fillTl)) == keccak256(bytes("#FFE94D")) ? "Rainbow" : "Grey"),
                    '"},',
                    '{"trait_type": "Motion", "value": "',
                    style.motion ? "Yes" : "No",
                    '"},',
                    '{"trait_type": "Gradient", "value": "',
                    (style.textColorStart.h != style.textColorEnd.h) ? "Yes" : "No",
                    '"}'
                )
            );
    }

    function getStyles(uint256 seed) internal view virtual returns (svgStyle memory) {
        uint8 baseH = uint8(randNum(6, 360, seed++));
        uint8 baseS = uint8(randNum(20, 85, seed++));
        uint8 baseL = uint8(randNum(45, 95, seed++));
        iconStyle memory iconstyle;

        colorHSL memory baseColor = colorHSL(baseH, baseS, baseL);
        colorHSL memory textColorStart = colorHSL(baseH, baseS, 30);
        colorHSL memory textColorEnd = colorHSL(baseH, baseS, ((baseL <= 35) ? 50 : 30));
        // iconStyle memory iconStyleBlack = iconStyle("#000", "#000", "#000", "#000", "#000", "#000", "#000", 1);
        // iconStyle memory iconStyleGrey = iconStyle('#8C8C8C', '#333333', '#383838', '#141414', '#8C8C8C', '#333333', "#000", 1);
        if (baseH % 10 == 1) {
            // rainbow - 10%
            iconstyle = iconStyle("#FFE94D", "#FF9C92", "#88D848", "#CC71C2", "#53D3E0", "#5A9DED", "#000", 1);
        } else {
            // grey
            iconstyle = iconStyle("#8C8C8C", "#333333", "#383838", "#141414", "#8C8C8C", "#333333", "#000", 1);
        }
        bool motion = (baseH <= 231); // ~65% get motion

        svgStyle memory style = svgStyle(baseColor, textColorStart, textColorEnd, motion, iconstyle);
        return style;
    }

    function getColorNameFromHsl(colorHSL memory hsl) private pure returns (string memory) {
        if (hsl.h >= 170 && hsl.h <= 190 && hsl.s >= 75 && hsl.s <= 85 && hsl.l >= 80 && hsl.l <= 95) {
            return "Alien Blue";
        } else if (
            (hsl.h >= 80 && hsl.h <= 85 && hsl.s >= 25 && hsl.s <= 35 && hsl.l >= 40 && hsl.l <= 50) ||
            (hsl.h >= 100 && hsl.h <= 105 && hsl.s >= 40 && hsl.s <= 50 && hsl.l >= 58 && hsl.l <= 63)
        ) {
            return "Zombie Green";
        } else if (hsl.h >= 36 && hsl.h <= 38 && hsl.s >= 65 && hsl.s <= 80 && hsl.l >= 45 && hsl.l <= 48) {
            return "Ape Brown";
        } else if (hsl.s <= 10 && hsl.l >= 90) {
            return "White";
        } else if (hsl.l <= 15) {
            return "Black";
        } else if ((hsl.s <= 10 && hsl.l <= 70) || hsl.s == 0) {
            return "Gray";
        } else if ((hsl.h >= 0 && hsl.h <= 16) || hsl.h >= 346) {
            return "Red";
        } else if (hsl.h >= 17 && hsl.h <= 35) {
            if (hsl.s < 40) {
                return "Brown";
            } else {
                return "Orange";
            }
        } else if (hsl.h >= 36 && hsl.h <= 63) {
            if (hsl.s <= 50) {
                return "Brown";
            } else {
                return "Yellow";
            }
        } else if (hsl.h >= 55 && hsl.h <= 165) {
            return "Green";
        } else if (hsl.h >= 166 && hsl.h <= 260) {
            if (hsl.s >= 29) {
                return "Blue";
            } else {
                return "Purple";
            }
        } else if (hsl.h >= 250 && hsl.h <= 290) {
            return "Purple";
        } else if (hsl.h >= 291 && hsl.h <= 345) {
            return "Pink";
        } else {
            return "Unknown";
        }
    }

    function hslToString(colorHSL memory hsl) private pure returns (string memory) {
        return
            string(
                abi.encodePacked(
                    "hsl(",
                    Strings.toString(hsl.h),
                    ", ",
                    Strings.toString(hsl.s),
                    "%, ",
                    Strings.toString(hsl.l),
                    "%)"
                )
            );
    }

    function randNum(
        uint256 min,
        uint256 max,
        uint256 seed
    ) private pure returns (uint256) {
        return (uint256(keccak256(abi.encodePacked(seed))) % (max - min)) + min;
    }
}

// File: contracts/HM_Merge.sol



// SPDX-License-Identifier: MIT

pragma solidity ^0.8.9;

// @title: Historical Moments: The Merge
// @author: @todo fill this out
// @see Ethereum Logo originally sourced from https://commons.wikimedia.org/wiki/File:Ethereum_logo_2014.svg
//      by Ethereum Foundation is licensed under CC BY 3.0

//
// 555555555555555555      888888888     77777777777777777777555555555555555555      000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000
// 5::::::::::::::::5    88:::::::::88   7::::::::::::::::::75::::::::::::::::5    00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00
// 5::::::::::::::::5  88:::::::::::::88 7::::::::::::::::::75::::::::::::::::5  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00
// 5:::::555555555555 8::::::88888::::::8777777777777:::::::75:::::555555555555 0:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::0
// 5:::::5            8:::::8     8:::::8           7::::::7 5:::::5            0::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::0
// 5:::::5            8:::::8     8:::::8          7::::::7  5:::::5            0:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::0
// 5:::::5555555555    8:::::88888:::::8          7::::::7   5:::::5555555555   0:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::0
// 5:::::::::::::::5    8:::::::::::::8          7::::::7    5:::::::::::::::5  0:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::0
// 555555555555:::::5  8:::::88888:::::8        7::::::7     555555555555:::::5 0:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::00:::::0 000 0:::::0
//             5:::::58:::::8     8:::::8      7::::::7                  5:::::50:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::0
//             5:::::58:::::8     8:::::8     7::::::7                   5:::::50:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::00:::::0     0:::::0
// 5555555     5:::::58:::::8     8:::::8    7::::::7        5555555     5:::::50::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::00::::::0   0::::::0
// 5::::::55555::::::58::::::88888::::::8   7::::::7         5::::::55555::::::50:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::00:::::::000:::::::0
//  55:::::::::::::55  88:::::::::::::88   7::::::7           55:::::::::::::55  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00  00:::::::::::::00
//    55:::::::::55      88:::::::::88    7::::::7              55:::::::::55      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00      00:::::::::00
//      555555555          888888888     77777777                 555555555          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000          000000000
//

// Note from Author:
// Will likely just open it via Etherscan minting until a frontend can be built
// Wanna watch the countdown live too and not code and test this rn...
//
// But here's the gist:
// Have wanted to explore generative art (like many of you) for a while, but no time
// Had time during BM this year, many were on the Playa, while these contracts were getting buitl
// Celebrating the TDD in style with some fun SVG motions, colors, randomization and generative metadata traits
//
// 100 free mints (max 1 per addy, plz dont sybil attack this)  =)
// Max 487 @ 0.05875 ETH
//
// Then the exciting bits (if anyone cares)...
// Once (if) the first 587 sell out, then a waitlist forms
// Waitlist is 0.069 ETH
// BUT... existing Collectors are the only ones that get to decide whether to let waitlisters join
// There's a cost to call this method, so the contract will keep its base fee (0.05875 ETH) and the rest (the tip)
// Goes to the Collector that let the waitlister(s) in by calling `mintFromWaitlist(1)`
// Tip should cover gas cost, plus a little more as a thank you from those waitlisted and let in
// 
// If you're on the waitlist, you may exit and get back your mint fee (less gas)
// any time until an existing Collector let's you in
//
// Thank you to all the devs and larger community for getting us this far!!!
// <3

import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/math/SafeMath.sol";
import "@openzeppelin/contracts/utils/math/Math.sol";
import "./ArtCreator.sol";

contract HM_Merge is ERC721, Ownable, ReentrancyGuard, ArtCreator {
    using SafeMath for uint8;
    using SafeMath for uint16;
    using SafeMath for uint128;
    using SafeMath for uint256;

    uint16 public constant MAX_TOKENS = 5875;
    uint16 public constant MAX_TOKENS_INITIAL = 587;
    uint8 public constant FREE_MINT_LIMIT = 100;
    uint256 public constant MAX_BLOCK = 15750000;
    uint128 private _mintFeeWei = 58750000000000000; // .05875 ETH
    uint128 private _mintWaitlistFeeWei = 69000000000000000; // .069 ETH

    // Need quick lookup for user to withdraw
    mapping(address => bool) public waitlistMap;

    // FIFO queue for getting minted from waitlist
    address[] public waitlist;
    uint16 private _nextWaitlistPos = 0;

    // to keep track of unspent bal
    uint256 private _pendingWaitlist = 0;

    // Keep track of the total number of NFTs minted.
    // Each NFT will have an unique Id.
    uint256 private _nextTokenId = 1;

    // Allow for starting/pausing sale
    bool public mintActive = true;

    modifier onlyCollector() {
        require(balanceOf(msg.sender) > 0, "Caller is not a collector");
        _;
    }

    modifier onlyWaitlist() {
        require(isWaitlist(msg.sender));
        _;
    }

    constructor() ERC721("Historical Moments: The Merge", "HMMERGE") {}

    /***************
     * Public Mint *
     ***************/

    function mint() external payable nonReentrant {
        require(totalSupply() < MAX_TOKENS_INITIAL, "All minted, try waitlist");
        uint256 mintPrice = getMintPrice();
        require(msg.value >= mintPrice, "Mint fee too low");

        _safeMint(msg.sender, _nextTokenId++);
    }

    function getMintPrice() public view returns (uint256) {
        require(mintActive, "Sale hasn't started");

        // limit free mint to 1 per address
        if (totalSupply() < FREE_MINT_LIMIT && balanceOf(msg.sender) == 0) {
            return 0;
        } else if (totalSupply() < MAX_TOKENS_INITIAL) {
            return _mintFeeWei;
        } else {
            return _mintWaitlistFeeWei;
        }
    }

    /**********************
     * Waitlist post-mint *
     **********************/

    function joinWaitlist() external payable nonReentrant {
        require(totalSupply() >= MAX_TOKENS_INITIAL, "Waitlist not started, use mint");
        require(totalSupply() < MAX_TOKENS, "All art in collection was minted");
        require(block.number <= MAX_BLOCK, "Waitlist period ended");
        require(msg.value >= _mintWaitlistFeeWei, "Mint fee too low");
        require(isWaitlist(msg.sender) == false, "Already on waitlist");

        // address is active waitlist (again)
        waitlistMap[msg.sender] = true;

        // pushes address, even if existed before and minted
        waitlist.push(msg.sender);

        _pendingWaitlist++;
    }

    function mintFromWaitlist(uint256 _quantity) external onlyCollector {
        // bound by arr size
        require(_quantity > 0, "Quantity cannot be zero");
        uint256 quantity = Math.min(_quantity, waitlist.length - _nextWaitlistPos);
        require(quantity > 0, "No one in queue");
        uint256 end = _nextWaitlistPos.add(quantity);

        while (_nextWaitlistPos < end) {
            address account = waitlist[_nextWaitlistPos];
            if (isWaitlist(account)) {
                waitlistMap[account] = false;
                _safeMint(account, _nextTokenId++);
            }
            _nextWaitlistPos++;
        }
        _pendingWaitlist -= quantity;

        // send tips to caller
        uint256 tipPerMint = _mintWaitlistFeeWei.sub(_mintFeeWei);
        uint256 amount = tipPerMint.mul(quantity);
        payable(msg.sender).transfer(amount);
    }

    function isWaitlist(address account) public view returns (bool) {
        if (waitlistMap[account]) {
            return true;
        }
        return false;
    }

    /************
     * Metadata *
     ************/

    function tokenURI(uint256 tokenId) public view override returns (string memory) {
        _requireMinted(tokenId);
        return generateMetadata(tokenId, MAX_TOKENS);
    }

    /****************
     * Mint Helpers *
     ****************/

    function totalSupply() public view virtual returns (uint256) {
        return _nextTokenId - 1;
    }

    function setMintActive(bool _active) public onlyOwner {
        mintActive = _active;
    }

    /**************
     * Withdrawal *
     **************/

    // for waitlist
    function exitWaitlist() public payable nonReentrant {
        require(isWaitlist(msg.sender), "Not on waitlist");
        waitlistMap[msg.sender] = false;
        _pendingWaitlist--;
        payable(msg.sender).transfer(_mintWaitlistFeeWei);
    }

    function withdrawAll() public payable onlyOwner {
        // dont allow transfer of un-minted waitlist
        uint256 reserved = _mintWaitlistFeeWei.mul(_pendingWaitlist);
        uint256 amount = address(this).balance.sub(reserved);
        payable(msg.sender).transfer(amount);
    }

    function withdrawAllLost() public payable onlyOwner {
        // only enable withdrawal of waitlist eth if left here for ~5 yrs
        require(block.number > MAX_BLOCK.add(10**7), "Period not started");
        uint256 amount = address(this).balance;
        payable(msg.sender).transfer(amount);
    }
}