Contract Address Details

// Sources flattened with hardhat v2.10.1 https://hardhat.org

// File openzeppelin-contracts-upgradeable/proxy/utils/Initializable.sol


// OpenZeppelin Contracts v4.4.0 (proxy/utils/Initializable.sol)

pragma solidity ^0.8.0;

/**
 * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
 * behind a proxy. Since a proxied contract can't have a constructor, it's common to move constructor logic to an
 * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
 * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
 *
 * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
 * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
 *
 * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
 * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
 *
 * [CAUTION]
 * ====
 * Avoid leaving a contract uninitialized.
 *
 * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
 * contract, which may impact the proxy. To initialize the implementation contract, you can either invoke the
 * initializer manually, or you can include a constructor to automatically mark it as initialized when it is deployed:
 *
 * [.hljs-theme-light.nopadding]
 * ```
 * /// @custom:oz-upgrades-unsafe-allow constructor
 * constructor() initializer {}
 * ```
 * ====
 */
abstract contract Initializable {
    /**
     * @dev Indicates that the contract has been initialized.
     */
    bool private _initialized;

    /**
     * @dev Indicates that the contract is in the process of being initialized.
     */
    bool private _initializing;

    /**
     * @dev Modifier to protect an initializer function from being invoked twice.
     */
    modifier initializer() {
        require(_initializing || !_initialized, "Initializable: contract is already initialized");

        bool isTopLevelCall = !_initializing;
        if (isTopLevelCall) {
            _initializing = true;
            _initialized = true;
        }

        _;

        if (isTopLevelCall) {
            _initializing = false;
        }
    }
}


// File openzeppelin-contracts-upgradeable/utils/StringsUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (utils/Strings.sol)

pragma solidity ^0.8.0;

/**
 * @dev String operations.
 */
library StringsUpgradeable {
    bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";

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


// File openzeppelin-contracts-upgradeable/utils/cryptography/ECDSAUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (utils/cryptography/ECDSA.sol)

pragma solidity ^0.8.0;

/**
 * @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
 *
 * These functions can be used to verify that a message was signed by the holder
 * of the private keys of a given address.
 */
library ECDSAUpgradeable {
    enum RecoverError {
        NoError,
        InvalidSignature,
        InvalidSignatureLength,
        InvalidSignatureS,
        InvalidSignatureV
    }

    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");
        } else if (error == RecoverError.InvalidSignatureV) {
            revert("ECDSA: invalid signature 'v' 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) {
        // Check the signature length
        // - case 65: r,s,v signature (standard)
        // - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098) _Available since v4.1._
        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.
            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 if (signature.length == 64) {
            bytes32 r;
            bytes32 vs;
            // ecrecover takes the signature parameters, and the only way to get them
            // currently is to use assembly.
            assembly {
                r := mload(add(signature, 0x20))
                vs := mload(add(signature, 0x40))
            }
            return tryRecover(hash, r, vs);
        } 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;
        uint8 v;
        assembly {
            s := and(vs, 0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff)
            v := add(shr(255, vs), 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 (v != 27 && v != 28) {
            return (address(0), RecoverError.InvalidSignatureV);
        }

        // 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) {
        // 32 is the length in bytes of hash,
        // enforced by the type signature above
        return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n32", hash));
    }

    /**
     * @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", StringsUpgradeable.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) {
        return keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash));
    }
}


// File openzeppelin-contracts-upgradeable/utils/cryptography/draft-EIP712Upgradeable.sol


// OpenZeppelin Contracts v4.4.0 (utils/cryptography/draft-EIP712.sol)

pragma solidity ^0.8.0;


/**
 * @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data.
 *
 * The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible,
 * thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding
 * they need in their contracts using a combination of `abi.encode` and `keccak256`.
 *
 * This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
 * scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
 * ({_hashTypedDataV4}).
 *
 * The implementation of the domain separator was designed to be as efficient as possible while still properly updating
 * the chain id to protect against replay attacks on an eventual fork of the chain.
 *
 * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
 * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
 *
 * _Available since v3.4._
 */
abstract contract EIP712Upgradeable is Initializable {
    /* solhint-disable var-name-mixedcase */
    bytes32 private _HASHED_NAME;
    bytes32 private _HASHED_VERSION;
    bytes32 private constant _TYPE_HASH = keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");

    /* solhint-enable var-name-mixedcase */

    /**
     * @dev Initializes the domain separator and parameter caches.
     *
     * The meaning of `name` and `version` is specified in
     * https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]:
     *
     * - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
     * - `version`: the current major version of the signing domain.
     *
     * NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
     * contract upgrade].
     */
    function __EIP712_init(string memory name, string memory version) internal initializer {
        __EIP712_init_unchained(name, version);
    }

    function __EIP712_init_unchained(string memory name, string memory version) internal initializer {
        bytes32 hashedName = keccak256(bytes(name));
        bytes32 hashedVersion = keccak256(bytes(version));
        _HASHED_NAME = hashedName;
        _HASHED_VERSION = hashedVersion;
    }

    /**
     * @dev Returns the domain separator for the current chain.
     */
    function _domainSeparatorV4() internal view returns (bytes32) {
        return _buildDomainSeparator(_TYPE_HASH, _EIP712NameHash(), _EIP712VersionHash());
    }

    function _buildDomainSeparator(
        bytes32 typeHash,
        bytes32 nameHash,
        bytes32 versionHash
    ) private view returns (bytes32) {
        return keccak256(abi.encode(typeHash, nameHash, versionHash, block.chainid, address(this)));
    }

    /**
     * @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
     * function returns the hash of the fully encoded EIP712 message for this domain.
     *
     * This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
     *
     * ```solidity
     * bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
     *     keccak256("Mail(address to,string contents)"),
     *     mailTo,
     *     keccak256(bytes(mailContents))
     * )));
     * address signer = ECDSA.recover(digest, signature);
     * ```
     */
    function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
        return ECDSAUpgradeable.toTypedDataHash(_domainSeparatorV4(), structHash);
    }

    /**
     * @dev The hash of the name parameter for the EIP712 domain.
     *
     * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
     * are a concern.
     */
    function _EIP712NameHash() internal virtual view returns (bytes32) {
        return _HASHED_NAME;
    }

    /**
     * @dev The hash of the version parameter for the EIP712 domain.
     *
     * NOTE: This function reads from storage by default, but can be redefined to return a constant value if gas costs
     * are a concern.
     */
    function _EIP712VersionHash() internal virtual view returns (bytes32) {
        return _HASHED_VERSION;
    }
    uint256[50] private __gap;
}


// File openzeppelin-contracts-upgradeable/utils/introspection/IERC165Upgradeable.sol


// OpenZeppelin Contracts v4.4.0 (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 IERC165Upgradeable {
    /**
     * @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-upgradeable/token/ERC721/IERC721Upgradeable.sol


// OpenZeppelin Contracts v4.4.0 (token/ERC721/IERC721.sol)

pragma solidity ^0.8.0;

/**
 * @dev Required interface of an ERC721 compliant contract.
 */
interface IERC721Upgradeable is IERC165Upgradeable {
    /**
     * @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`, 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 be 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 Returns the account approved for `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function getApproved(uint256 tokenId) external view returns (address operator);

    /**
     * @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 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);

    /**
     * @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;
}


// File openzeppelin-contracts-upgradeable/token/ERC721/IERC721ReceiverUpgradeable.sol


// OpenZeppelin Contracts v4.4.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 IERC721ReceiverUpgradeable {
    /**
     * @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 `IERC721.onERC721Received.selector`.
     */
    function onERC721Received(
        address operator,
        address from,
        uint256 tokenId,
        bytes calldata data
    ) external returns (bytes4);
}


// File openzeppelin-contracts-upgradeable/token/ERC721/extensions/IERC721MetadataUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (token/ERC721/extensions/IERC721Metadata.sol)

pragma solidity ^0.8.0;

/**
 * @title ERC-721 Non-Fungible Token Standard, optional metadata extension
 * @dev See https://eips.ethereum.org/EIPS/eip-721
 */
interface IERC721MetadataUpgradeable is IERC721Upgradeable {
    /**
     * @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-upgradeable/utils/AddressUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (utils/Address.sol)

pragma solidity ^0.8.0;

/**
 * @dev Collection of functions related to the address type
 */
library AddressUpgradeable {
    /**
     * @dev Returns true if `account` is a contract.
     *
     * [IMPORTANT]
     * ====
     * It is unsafe to assume that an address for which this function returns
     * false is an externally-owned account (EOA) and not a contract.
     *
     * Among others, `isContract` will return false for the following
     * types of addresses:
     *
     *  - an externally-owned account
     *  - a contract in construction
     *  - an address where a contract will be created
     *  - an address where a contract lived, but was destroyed
     * ====
     */
    function isContract(address account) internal view returns (bool) {
        // This method relies on extcodesize, which returns 0 for contracts in
        // construction, since the code is only stored at the end of the
        // constructor execution.

        uint256 size;
        assembly {
            size := extcodesize(account)
        }
        return size > 0;
    }

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

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

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

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

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

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

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

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

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

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

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

                assembly {
                    let returndata_size := mload(returndata)
                    revert(add(32, returndata), returndata_size)
                }
            } else {
                revert(errorMessage);
            }
        }
    }
}


// File openzeppelin-contracts-upgradeable/utils/ContextUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (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 ContextUpgradeable is Initializable {
    function __Context_init() internal initializer {
        __Context_init_unchained();
    }

    function __Context_init_unchained() internal initializer {
    }
    function _msgSender() internal view virtual returns (address) {
        return msg.sender;
    }

    function _msgData() internal view virtual returns (bytes calldata) {
        return msg.data;
    }
    uint256[50] private __gap;
}


// File openzeppelin-contracts-upgradeable/utils/introspection/ERC165Upgradeable.sol


// OpenZeppelin Contracts v4.4.0 (utils/introspection/ERC165.sol)

pragma solidity ^0.8.0;


/**
 * @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 ERC165Upgradeable is Initializable, IERC165Upgradeable {
    function __ERC165_init() internal initializer {
        __ERC165_init_unchained();
    }

    function __ERC165_init_unchained() internal initializer {
    }
    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
        return interfaceId == type(IERC165Upgradeable).interfaceId;
    }
    uint256[50] private __gap;
}


// File openzeppelin-contracts-upgradeable/token/ERC721/ERC721Upgradeable.sol


// OpenZeppelin Contracts v4.4.0 (token/ERC721/ERC721.sol)

pragma solidity ^0.8.0;








/**
 * @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 ERC721Upgradeable is Initializable, ContextUpgradeable, ERC165Upgradeable, IERC721Upgradeable, IERC721MetadataUpgradeable {
    using AddressUpgradeable for address;
    using StringsUpgradeable 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.
     */
    function __ERC721_init(string memory name_, string memory symbol_) internal initializer {
        __Context_init_unchained();
        __ERC165_init_unchained();
        __ERC721_init_unchained(name_, symbol_);
    }

    function __ERC721_init_unchained(string memory name_, string memory symbol_) internal initializer {
        _name = name_;
        _symbol = symbol_;
    }

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

    /**
     * @dev See {IERC721-balanceOf}.
     */
    function balanceOf(address owner) public view virtual override returns (uint256) {
        require(owner != address(0), "ERC721: balance query for the zero address");
        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: owner query for nonexistent token");
        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) {
        require(_exists(tokenId), "ERC721Metadata: URI query for nonexistent token");

        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 overriden 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 = ERC721Upgradeable.ownerOf(tokenId);
        require(to != owner, "ERC721: approval to current owner");

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

        _approve(to, tokenId);
    }

    /**
     * @dev See {IERC721-getApproved}.
     */
    function getApproved(uint256 tokenId) public view virtual override returns (address) {
        require(_exists(tokenId), "ERC721: approved query for nonexistent token");

        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: transfer caller is not 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: transfer caller is not 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) {
        require(_exists(tokenId), "ERC721: operator query for nonexistent token");
        address owner = ERC721Upgradeable.ownerOf(tokenId);
        return (spender == owner || getApproved(tokenId) == spender || isApprovedForAll(owner, 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);
    }

    /**
     * @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 = ERC721Upgradeable.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);
    }

    /**
     * @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(ERC721Upgradeable.ownerOf(tokenId) == from, "ERC721: transfer of token that is not own");
        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);
    }

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

    /**
     * @dev Approve `operator` to operate on all of `owner` tokens
     *
     * Emits a {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 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 IERC721ReceiverUpgradeable(to).onERC721Received(_msgSender(), from, tokenId, _data) returns (bytes4 retval) {
                return retval == IERC721ReceiverUpgradeable.onERC721Received.selector;
            } catch (bytes memory reason) {
                if (reason.length == 0) {
                    revert("ERC721: transfer to non ERC721Receiver implementer");
                } else {
                    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 {}
    uint256[44] private __gap;
}


// File openzeppelin-contracts-upgradeable/token/ERC721/extensions/ERC721BurnableUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (token/ERC721/extensions/ERC721Burnable.sol)

pragma solidity ^0.8.0;



/**
 * @title ERC721 Burnable Token
 * @dev ERC721 Token that can be irreversibly burned (destroyed).
 */
abstract contract ERC721BurnableUpgradeable is Initializable, ContextUpgradeable, ERC721Upgradeable {
    function __ERC721Burnable_init() internal initializer {
        __Context_init_unchained();
        __ERC165_init_unchained();
        __ERC721Burnable_init_unchained();
    }

    function __ERC721Burnable_init_unchained() internal initializer {
    }
    /**
     * @dev Burns `tokenId`. See {ERC721-_burn}.
     *
     * Requirements:
     *
     * - The caller must own `tokenId` or be an approved operator.
     */
    function burn(uint256 tokenId) public virtual {
        //solhint-disable-next-line max-line-length
        require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721Burnable: caller is not owner nor approved");
        _burn(tokenId);
    }
    uint256[50] private __gap;
}


// File openzeppelin-contracts-upgradeable/access/IAccessControlUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (access/IAccessControl.sol)

pragma solidity ^0.8.0;

/**
 * @dev External interface of AccessControl declared to support ERC165 detection.
 */
interface IAccessControlUpgradeable {
    /**
     * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
     *
     * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
     * {RoleAdminChanged} not being emitted signaling this.
     *
     * _Available since v3.1._
     */
    event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);

    /**
     * @dev Emitted when `account` is granted `role`.
     *
     * `sender` is the account that originated the contract call, an admin role
     * bearer except when using {AccessControl-_setupRole}.
     */
    event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);

    /**
     * @dev Emitted when `account` is revoked `role`.
     *
     * `sender` is the account that originated the contract call:
     *   - if using `revokeRole`, it is the admin role bearer
     *   - if using `renounceRole`, it is the role bearer (i.e. `account`)
     */
    event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);

    /**
     * @dev Returns `true` if `account` has been granted `role`.
     */
    function hasRole(bytes32 role, address account) external view returns (bool);

    /**
     * @dev Returns the admin role that controls `role`. See {grantRole} and
     * {revokeRole}.
     *
     * To change a role's admin, use {AccessControl-_setRoleAdmin}.
     */
    function getRoleAdmin(bytes32 role) external view returns (bytes32);

    /**
     * @dev Grants `role` to `account`.
     *
     * If `account` had not been already granted `role`, emits a {RoleGranted}
     * event.
     *
     * Requirements:
     *
     * - the caller must have ``role``'s admin role.
     */
    function grantRole(bytes32 role, address account) external;

    /**
     * @dev Revokes `role` from `account`.
     *
     * If `account` had been granted `role`, emits a {RoleRevoked} event.
     *
     * Requirements:
     *
     * - the caller must have ``role``'s admin role.
     */
    function revokeRole(bytes32 role, address account) external;

    /**
     * @dev Revokes `role` from the calling account.
     *
     * Roles are often managed via {grantRole} and {revokeRole}: this function's
     * purpose is to provide a mechanism for accounts to lose their privileges
     * if they are compromised (such as when a trusted device is misplaced).
     *
     * If the calling account had been granted `role`, emits a {RoleRevoked}
     * event.
     *
     * Requirements:
     *
     * - the caller must be `account`.
     */
    function renounceRole(bytes32 role, address account) external;
}


// File openzeppelin-contracts-upgradeable/access/AccessControlUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (access/AccessControl.sol)

pragma solidity ^0.8.0;





/**
 * @dev Contract module that allows children to implement role-based access
 * control mechanisms. This is a lightweight version that doesn't allow enumerating role
 * members except through off-chain means by accessing the contract event logs. Some
 * applications may benefit from on-chain enumerability, for those cases see
 * {AccessControlEnumerable}.
 *
 * Roles are referred to by their `bytes32` identifier. These should be exposed
 * in the external API and be unique. The best way to achieve this is by
 * using `public constant` hash digests:
 *
 * ```
 * bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
 * ```
 *
 * Roles can be used to represent a set of permissions. To restrict access to a
 * function call, use {hasRole}:
 *
 * ```
 * function foo() public {
 *     require(hasRole(MY_ROLE, msg.sender));
 *     ...
 * }
 * ```
 *
 * Roles can be granted and revoked dynamically via the {grantRole} and
 * {revokeRole} functions. Each role has an associated admin role, and only
 * accounts that have a role's admin role can call {grantRole} and {revokeRole}.
 *
 * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
 * that only accounts with this role will be able to grant or revoke other
 * roles. More complex role relationships can be created by using
 * {_setRoleAdmin}.
 *
 * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
 * grant and revoke this role. Extra precautions should be taken to secure
 * accounts that have been granted it.
 */
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {
    function __AccessControl_init() internal initializer {
        __Context_init_unchained();
        __ERC165_init_unchained();
        __AccessControl_init_unchained();
    }

    function __AccessControl_init_unchained() internal initializer {
    }
    struct RoleData {
        mapping(address => bool) members;
        bytes32 adminRole;
    }

    mapping(bytes32 => RoleData) private _roles;

    bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;

    /**
     * @dev Modifier that checks that an account has a specific role. Reverts
     * with a standardized message including the required role.
     *
     * The format of the revert reason is given by the following regular expression:
     *
     *  /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
     *
     * _Available since v4.1._
     */
    modifier onlyRole(bytes32 role) {
        _checkRole(role, _msgSender());
        _;
    }

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

    /**
     * @dev Returns `true` if `account` has been granted `role`.
     */
    function hasRole(bytes32 role, address account) public view override returns (bool) {
        return _roles[role].members[account];
    }

    /**
     * @dev Revert with a standard message if `account` is missing `role`.
     *
     * The format of the revert reason is given by the following regular expression:
     *
     *  /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
     */
    function _checkRole(bytes32 role, address account) internal view {
        if (!hasRole(role, account)) {
            revert(
                string(
                    abi.encodePacked(
                        "AccessControl: account ",
                        StringsUpgradeable.toHexString(uint160(account), 20),
                        " is missing role ",
                        StringsUpgradeable.toHexString(uint256(role), 32)
                    )
                )
            );
        }
    }

    /**
     * @dev Returns the admin role that controls `role`. See {grantRole} and
     * {revokeRole}.
     *
     * To change a role's admin, use {_setRoleAdmin}.
     */
    function getRoleAdmin(bytes32 role) public view override returns (bytes32) {
        return _roles[role].adminRole;
    }

    /**
     * @dev Grants `role` to `account`.
     *
     * If `account` had not been already granted `role`, emits a {RoleGranted}
     * event.
     *
     * Requirements:
     *
     * - the caller must have ``role``'s admin role.
     */
    function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
        _grantRole(role, account);
    }

    /**
     * @dev Revokes `role` from `account`.
     *
     * If `account` had been granted `role`, emits a {RoleRevoked} event.
     *
     * Requirements:
     *
     * - the caller must have ``role``'s admin role.
     */
    function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) {
        _revokeRole(role, account);
    }

    /**
     * @dev Revokes `role` from the calling account.
     *
     * Roles are often managed via {grantRole} and {revokeRole}: this function's
     * purpose is to provide a mechanism for accounts to lose their privileges
     * if they are compromised (such as when a trusted device is misplaced).
     *
     * If the calling account had been revoked `role`, emits a {RoleRevoked}
     * event.
     *
     * Requirements:
     *
     * - the caller must be `account`.
     */
    function renounceRole(bytes32 role, address account) public virtual override {
        require(account == _msgSender(), "AccessControl: can only renounce roles for self");

        _revokeRole(role, account);
    }

    /**
     * @dev Grants `role` to `account`.
     *
     * If `account` had not been already granted `role`, emits a {RoleGranted}
     * event. Note that unlike {grantRole}, this function doesn't perform any
     * checks on the calling account.
     *
     * [WARNING]
     * ====
     * This function should only be called from the constructor when setting
     * up the initial roles for the system.
     *
     * Using this function in any other way is effectively circumventing the admin
     * system imposed by {AccessControl}.
     * ====
     *
     * NOTE: This function is deprecated in favor of {_grantRole}.
     */
    function _setupRole(bytes32 role, address account) internal virtual {
        _grantRole(role, account);
    }

    /**
     * @dev Sets `adminRole` as ``role``'s admin role.
     *
     * Emits a {RoleAdminChanged} event.
     */
    function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
        bytes32 previousAdminRole = getRoleAdmin(role);
        _roles[role].adminRole = adminRole;
        emit RoleAdminChanged(role, previousAdminRole, adminRole);
    }

    /**
     * @dev Grants `role` to `account`.
     *
     * Internal function without access restriction.
     */
    function _grantRole(bytes32 role, address account) internal virtual {
        if (!hasRole(role, account)) {
            _roles[role].members[account] = true;
            emit RoleGranted(role, account, _msgSender());
        }
    }

    /**
     * @dev Revokes `role` from `account`.
     *
     * Internal function without access restriction.
     */
    function _revokeRole(bytes32 role, address account) internal virtual {
        if (hasRole(role, account)) {
            _roles[role].members[account] = false;
            emit RoleRevoked(role, account, _msgSender());
        }
    }
    uint256[49] private __gap;
}


// File openzeppelin-contracts-upgradeable/security/PausableUpgradeable.sol


// OpenZeppelin Contracts v4.4.0 (security/Pausable.sol)

pragma solidity ^0.8.0;


/**
 * @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 PausableUpgradeable is Initializable, ContextUpgradeable {
    /**
     * @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.
     */
    function __Pausable_init() internal initializer {
        __Context_init_unchained();
        __Pausable_init_unchained();
    }

    function __Pausable_init_unchained() internal initializer {
        _paused = false;
    }

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

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

    /**
     * @dev Modifier to make a function callable only when the contract is paused.
     *
     * Requirements:
     *
     * - The contract must be paused.
     */
    modifier whenPaused() {
        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());
    }
    uint256[49] private __gap;
}


// File contracts/PlatformSettings.sol


pragma solidity ^0.8.0;



/// @title A platform settings for OTG contracts
/// @notice Admin can use this contract for granting and revoking roles, pause and unpause platform, set new wallets for fee receiving
/// @dev This contract inherits 'Initializable', 'AccessControlUpgradeable', 'PausableUpgradeable' contracts form openzeppelin library
contract PlatformSettings is Initializable, AccessControlUpgradeable, PausableUpgradeable{
    bytes32 public constant SECONDARY_ADMIN_ROLE = keccak256("SECONDARY_ADMIN_ROLE");
    bytes32 public constant BACKEND_ROLE = keccak256("BACKEND_ROLE");
    uint256 public constant gunDecimals = 10**18;
    uint256 public constant PERCENT_DENOMINATOR = 100;

    // address of main admin
    address public initialAdmin;
    // address of financial wallet (withdraws GUNs from contract)
    address payable public financialWallet;

    // percentage that represents validator fee during decoding process
    uint256 public validatorFeePercentageForDecoding;
    // percentage that represents platform fee during decoding process
    uint256 public platformFeePercentageForDecoding;


    bytes32 public constant BRIDGE_ROLE = keccak256("BRIDGE_ROLE");

    /// @notice this event is emitted when new financial wallet is set
    /// @param newWallet address of new financial wallet
    event newFinancialWallet(
        address indexed newWallet
    );


    error InvalidRole(address caller, bytes32 role);

    error IncorrectFeeDistribution();


    error AlreadyHasRole(address account, bytes32 role);


    error AlreadyHasNotRole(address account, bytes32 role);


    /// @notice A disposable function for initializing contract
    /// @param _admin address of initial admin of contract
    /// @dev Grants caller with admin role
    /// @dev Also calls initializers of AccessControl and Pausable contracts.
    /// @dev Sets caller as an initialAdmin and financeWallet(wallet for receiving fees and royalties)
    /// @dev Sets initial fee percentage for decoding process
    function initialize(
        address _admin
    )public initializer{
        __AccessControl_init();
        __Pausable_init_unchained();
        _setupRole(DEFAULT_ADMIN_ROLE, _admin);
        initialAdmin = _admin;
        financialWallet = payable(msg.sender);
        validatorFeePercentageForDecoding = 50;
        platformFeePercentageForDecoding = 50;
    }
// *********************** MODIFIERS *********************************************
    /// @notice verifies if message sender is an admin or secondary admin
    modifier onlyAdmin{
        if(!(hasRole(DEFAULT_ADMIN_ROLE, msg.sender) || hasRole(SECONDARY_ADMIN_ROLE,msg.sender))){
            revert InvalidRole(msg.sender, SECONDARY_ADMIN_ROLE);
        }
        _;
    }

    // *********************** VIEW FUNCTIONS *********************************************
    /// TODO restrict function visibility from view to pure
    function version() public pure returns (uint32){
        //version in format aaa.bbb.ccc => aaa*1E6+bbb*1E3+ccc;
        return uint32(1000001);
    }

// *********************** FUNCTIONS *********************************************
    /// @notice checks account for admin roles
    function isAdmin(address account) public view returns(bool){
        return (hasRole(DEFAULT_ADMIN_ROLE, account)||hasRole(SECONDARY_ADMIN_ROLE, account));
    }

    /// @notice checks account for backend role
    function isBackendRole(address account) public view returns(bool){
        return hasRole(BACKEND_ROLE, account);
    }

    function isBridgeRole(address account) public view returns(bool){
        return hasRole(BRIDGE_ROLE, account);
    }

    /// @notice checks account for admin roles or if platform is not paused
    function isAdminOrNotPaused(address caller) public view returns(bool){
        return(!paused()||hasRole(DEFAULT_ADMIN_ROLE,caller)||hasRole(SECONDARY_ADMIN_ROLE,caller));
    }

    /// TODO check if this function must exist
    /// @notice returns a number, that represents amount of fee, which validator will receive after decoding process
    function getValidatorFeeForDecoding(uint256 _price)public view returns(uint256){
        if((platformFeePercentageForDecoding + validatorFeePercentageForDecoding)!=100){
            revert IncorrectFeeDistribution();
        }
        return (_price* gunDecimals * validatorFeePercentageForDecoding)/PERCENT_DENOMINATOR;
    }

    /// TODO check if this function must exist
    /// @notice returns a number, that represents amount of fee, which financialWallet will receive after decoding process
    function getPlatformFeeForDecoding(uint256 _price)public view returns(uint256){
        if((platformFeePercentageForDecoding + validatorFeePercentageForDecoding)!=100){
            revert IncorrectFeeDistribution();
        }
        return (_price* gunDecimals * platformFeePercentageForDecoding)/PERCENT_DENOMINATOR;
    }
    /// @notice suspends most functions in contracts
    /// @dev Caller must be admin
    function pause() public onlyAdmin{
        _pause();
    }

    /// @notice restores most functions in contracts
    /// @dev Caller must be admin
    function unpause() public onlyAdmin{
        _unpause();
    }

    /// @notice sets new address as a payable financialWallet
    /// @dev caller must be admin, emits 'newFinancialWallet' 
    function setNewFinancialWallet(address _newWalletAddress) public onlyAdmin{
        financialWallet = payable(_newWalletAddress);
        emit newFinancialWallet(_newWalletAddress);
    }

    /// @notice granting secondary admin role to a specific address
    /// @param account address of a specific account 
    function grantSecondaryAdminRole(address account) public onlyRole(DEFAULT_ADMIN_ROLE){
        if(hasRole(SECONDARY_ADMIN_ROLE, account)){
            revert AlreadyHasRole(account, SECONDARY_ADMIN_ROLE); 
        }
        grantRole(SECONDARY_ADMIN_ROLE, account);
    }

    /// @notice revoking secondary admin role from a specific address
    /// @param account address of a specific account
    function revokeSecondaryAdminRole(address account) public onlyRole(DEFAULT_ADMIN_ROLE){
        if(!hasRole(SECONDARY_ADMIN_ROLE, account)){
            revert AlreadyHasNotRole(account, SECONDARY_ADMIN_ROLE); 
        }
        revokeRole(SECONDARY_ADMIN_ROLE, account);
    }

    /// @notice granting backend admin role from a specific address
    /// @param account address of a specific account 
    function grantBackendRole(address account) public onlyRole(DEFAULT_ADMIN_ROLE){
        if(hasRole(BACKEND_ROLE, account)){
            revert AlreadyHasRole(account, BACKEND_ROLE); 
        }
        grantRole(BACKEND_ROLE, account);
    }

    /// @notice revoking backend admin role from a specific address
    /// @param account address of a specific account 
    function revokeBackendRole(address account) public onlyRole(DEFAULT_ADMIN_ROLE){
        if(!hasRole(BACKEND_ROLE, account)){
            revert AlreadyHasNotRole(account, BACKEND_ROLE); 
        }
        revokeRole(BACKEND_ROLE, account);
    }

    function grantBridgeRole(address account) public onlyRole(DEFAULT_ADMIN_ROLE){
        if(hasRole(BRIDGE_ROLE, account)){
            revert AlreadyHasRole(account, BRIDGE_ROLE); 
        }
        grantRole(BRIDGE_ROLE, account);
    }

    function revokeBridgeRole(address account) public onlyRole(DEFAULT_ADMIN_ROLE){
        if(!hasRole(BRIDGE_ROLE, account)){
            revert AlreadyHasNotRole(account, BRIDGE_ROLE); 
        }
        revokeRole(BRIDGE_ROLE, account);
    }

    /// TODO maybe it will be better, to set validatorFeePercentageForDecoding and platformFeePercentageForDecoding with one function
    /// @notice Sets a number, that represents amount of fee, which validator will receive after 
    /// @dev caller must be admin
    function setValidatorFeePercentageForDecoding(uint256 _percentage) public onlyAdmin{
        validatorFeePercentageForDecoding = _percentage;
    }
    
    /// @notice Sets a number, that represents amount of fee, which financialWallet will receive after 
    /// @dev caller must be admin
    function setPlatformFeePercentageForDecoding(uint256 _percentage) public onlyAdmin{
        platformFeePercentageForDecoding = _percentage;
    }

    // TODO DEPRECATED, will be deleted sooner
    function getValidatorFeePercentageForDecoding() external view returns(uint256){
        return(validatorFeePercentageForDecoding);
    }

    // TODO DEPRECATED, will be deleted sooner
    function getPlatformFeePercentageForDecoding() external view returns(uint256){
        return(platformFeePercentageForDecoding);
    }
}


// File contracts/utils/EIP712Custom.sol

// contracts/Market.sol

pragma solidity ^0.8.0;

/// @title Contract for game Item sale
/// @notice User can use this contract for selling and buying game Items
/// @dev this's an upgradeable contract with creating item for sale, selling and unlisting gameItem from sale 
/// @dev Marketplace is inheriting from IMarketplace and EIP712Upgradeable
contract EIP712Custom is EIP712Upgradeable {

    error IncorrectSigner(address signer);

    error DeadlineExpired(uint256 deadline, uint256 currentTimestamp);

}


// File contracts/interfaces/IBattlePass.sol


pragma solidity ^0.8.0;

/// @notice Interface for BattlePassContract
interface IBattlePass{
    /// @notice this event is emitted when user activates BattlePass
    /// @param account owner of BatlePass
    /// @param tokenID token id of specific BattlePass
    event BattlePassActivated(address indexed account, uint256 indexed tokenID);
    /// @notice this event is emitted when user deactivates BattlePass
    /// @param account owner of BatlePass
    /// @param tokenID token id of specific BattlePass
    event BattlePassDeactivated(address indexed account, uint256 indexed tokenID);
    /// @notice this event is emitted when admin mints BattlePass
    /// @param to receiver of new BatlePass
    /// @param tokenID token id of BattlePass
    /// @param rarity rarity(0-4) of BattlePass
    event BattlePassMinted(address indexed to, uint256 indexed tokenID, uint8 rarity);
    /// @notice this event is emitted when admin creates season
    /// @param seasonID id of created season
    /// @param startDate unix time of season beginning
    /// @param duration duration of season in seconds
    event SeasonCreated(uint256 indexed seasonID, uint256 startDate, uint256 duration);
    /// @notice this event is emitted when admin starts current season
    /// @param seasonID id of current season
    event SeasonStarted(uint256 indexed seasonID);


    function version() external view returns (uint32);
    
    /// @notice gets current season id
    /// @return id of current season 
    function getCurrentSeason() external view returns(uint256);
    /// @notice gets mode(activated or deactivated) of specific BattlePass
    /// @param _tokenID token id of specific BattlePass
    /// @return bool mode of specific BattlePass
    function getMode(uint256 _tokenID) external view returns(bool);
    /// @notice gets rarity of specific BattlePass
    /// @param _tokenID token id of specific BattlePass
    /// @return uint8 rarity parameter of specific BattlePass
    function getRarity(uint256 _tokenID) external view returns(uint8);
    /// @notice gets start date(in seconds) of specific season
    /// @param _seasonID token id of specific season
    /// @return uint64 parameter, startDate of specific season
    function getSeasonStartDate(uint256 _seasonID) external view returns(uint64);
    /// @notice gets end date(in seconds) of specific season
    /// @param _seasonID token id of specific season
    /// @return uint64 parameter, endDate of specific season
    function getSeasonEndDate(uint256 _seasonID) external view returns(uint64);
    /// @notice gets duration(in seconds) of specific season
    /// @param _seasonID token id of specific season
    /// @return uint64 parameter, duration of specific season
    function getSeasonDuration(uint256 _seasonID) external view returns(uint64);
}


// File contracts/interfaces/IDataCube.sol


pragma solidity ^0.8.0;

/// @notice Interface for DataCubeContract
interface IDataCube {
    /// @notice this event is emitted when admin mints NFT DataCube
    /// @param to receiver of new DataCube
    /// @param tokenID id of new DataCube
    /// @param quality quality of new DataCube
    /// @param season BattlePass season of new DataCube
    event DataCubeMinted(
        address indexed to,
        uint256 indexed tokenID,
        uint8 quality,
        uint256 season);
    /// @notice this event is emitted when DataCube is burnt
    /// @param DCTokenID id of NFT DataCube
    /// @param DCBackendTokenID if of backend nonNFT DataCube
    event DataCubeBurnt(
        uint256 indexed DCTokenID,
        uint256 DCBackendTokenID);

    /// Deprecated, will be deleted sooner
    event DataCubeMintable(
        bool indexed
    );

    function version() external view returns (uint32);

    /// @notice during decoding, ValidatorLicenseContract calls this function to open DataCube and mint GameItem
    /// @dev data cube will be burned. Emits "Burnt" event. Calls "mintFromCube" function from GameItemContract via IGameItem interface
    /// @param _DCTokenID token id of specific DataCube
    /// @param _VLTokenID token id of specific Validator License
    /// @param _seasonID token id of season
    /// @param _DCQuality DataCube quality
    /// @param _receiver receiver's address of new item
    /// @param _DCBackendTokenID backend token id of specific DataCube
    /// @param _data metadata URL 
    function open(
        uint256 _DCTokenID,
        uint256 _VLTokenID,
        uint256 _seasonID,
        uint8 _DCQuality,
        address _receiver,
        uint256 _DCBackendTokenID,
        string memory _data) external;
    /// @notice gets season of specific DataCube
    /// @return uint256 id of specific DataCube 
    function getCubeSeason(uint256 _tokenID) external view returns(uint256);
    /// @notice gets lever of minting for DataCubes
    /// @return bool parameter, lever is on or not
    function getLeverMintable() external view returns(bool);
    /// @notice gets quality of specific DataCube
    /// @return uint8 quality parameter of specific DataCube 
    function getCubeQuality(uint256 _tokenID) external view  returns(uint8);
    /// @notice gets initial owner of specific DataCube
    /// @return address of initial owner of specific DataCube 
    function getCubeInitialOwner(uint256 _tokenID) external view  returns(address);

    function getFeeDepensOnQuality(uint8 _quality) external view  returns(uint256);
    /// @notice changes state of minting lever for dataCubes
    function changeLeverMintable() external;
    
    function burn(uint256 _tokenID) external;


}


// File contracts/interfaces/IGameItem.sol


pragma solidity ^0.8.0;

/// @notice Interface for GameItemContract
interface IGameItem {
    /// @notice this event is emitted when NFT GameItem is minted
    /// @param to new owner of GameItem
    /// @param tokenID id ow new GameItem
    /// @param quality quality(0-4) of new GameItem
    /// @param seasonID BattlePass season of new GameItem
    /// @param hacker the hacker who minted this item
    event Minted(
        address indexed to,
        uint256 indexed tokenID,
        uint8 quality,
        uint256 seasonID,
        address hacker);

    event MintedForUser(
        address indexed to,
        uint256 indexed tokenID,
        uint8 quality,
        uint256 financialWalletPayment,
        uint256 seasonID,
        address hacker);

    function version() external view returns (uint32);


    /// @notice gets creator's address of specific GameItem
    /// @param _tokenID token id of specific GameItem
    /// @return minter's address 
    function getItemCreator(uint256 _tokenID) external view returns(address);
    /// @notice gets (hacker) address of specific GameItem
    /// @param _tokenID token id of specific GameItem
    /// @return hacker's address 
    function getItemHacker(uint256 _tokenID) external view returns(address);
    /// @notice gets validator's(hacker) address of specific GameItem
    /// @param _tokenID token id of specific GameItem
    /// @return validator's address 
    function getItemValidator(uint256 _tokenID) external view returns(uint256);
    /// @notice gets quality of specific GameItem
    /// @param _tokenID token id of specific GameItem
    /// @return uint8 parameter. quality of GameItem 
    function getItemQuality(uint256 _tokenID) external view returns(uint8);
    /// @notice gets season of specific GameItem
    /// @param _tokenID token id of specific GameItem
    /// @return uint256 parameter. season id
    function getItemSeason(uint256 _tokenID) external view returns(uint256);
    /// @notice gets market state of specific GameItem
    /// @param _tokenID token id of specific GameItem
    /// @return uint8 parameter. Market state of GameItem 
    function getItemState(uint256 _tokenID) external view returns(uint8);
    /// @notice changes market state of specific GameItem
    /// @param _tokenID token id of specific GameItem
    /// @param _state (0-2) new item state
    function changeItemState(uint256 _tokenID, uint8 _state) external;

    /// @notice mints new GameItem
    /// @dev can be called only via DataCubeContract or ValidatorLicenseContract
    /// @dev emits "Minted" event
    /// @param _receiver receiver's address of new GameItem
    /// @param _VLTokenID token id of specific ValidatorLicense
    /// @param _seasonID token id of season
    /// @param _DCQuality quality of new GameItem
    /// @param _metadataURL URL to metadata storage
    function mintFromCube(
        address _receiver, 
        uint256 _VLTokenID, 
        uint256 _seasonID, 
        uint8 _DCQuality, 
        string memory _metadataURL) external;

    /// @notice mints new GameItem
    /// @dev can be called by user, with signature
    /// @dev sends GUNs to this contract address
    /// @param _VLTokenID token id of specific ValidatorLicense
    /// @param _seasonID token id of season
    /// @param _quality quality of new GameItem
    /// @param _price price(in GUNs) od DataCube decoding
    /// @param _metadataURL URL to metadata storage
    /// @param _deadline date of expiring signature(in unix time)
    /// @param _signature signature of signed data by backender
    function mintForUser(
        uint256 _VLTokenID,
        uint256 _seasonID,
        uint8 _quality,
        uint256 _price,
        string memory _metadataURL,
        uint256 _deadline,
        bytes memory _signature) payable external;

    function burn(uint256 _tokenID) external;

    function bridgeBurn(uint256 _tokenID) external;
    
    function bridgeMint(address to, uint256 _tokenID) external;
}


// File contracts/interfaces/IValidatorLicense.sol


pragma solidity ^0.8.0;

/// @notice Interface for ValidatorLicenseContract
interface IValidatorLicense{
    /// @notice this event is emitted when admin mints ValidatorLicense
    /// @param account receiver of ValidatorLicense
    /// @param tokenID id of new ValidatorLicense
    /// @param rarity rarity of new ValidatorLicense
    /// @param activeMode - state of activation switcher
    event ValidatorLicenseMinted(address indexed account, uint256 indexed tokenID, uint8 indexed rarity, bool activeMode);
    /// @notice this event is emitted when hacker activates ValidatorLicense
    /// @param account owner(hacker) of ValidatorLicense
    event ValidatorLicenseActivated(address indexed account, uint256 indexed tokenID);
    /// @notice this event is emitted when hacker deactivates ValidatorLicense
    /// @param account owner(hacker) of ValidatorLicense
    event ValidatorLicenseDeactivated(address indexed account, uint256 indexed tokenID);


    function version() external view returns (uint32);

    /// @notice gets mode(activated or deactivated) of specific ValidatorLicense
    /// @param _tokenID token id of specific ValidatorLicense
    /// @return bool mode of specific ValidatorLicense
    function getLicenseMode(uint256 _tokenID) external view returns(bool);

    /// @notice gets rarity of specific ValidatorLicense
    /// @param _tokenID token id of specific ValidatorLicense
    /// @return uint8 rarity parameter of specific ValidatorLicense
    function getLicenseRarity(uint256 _tokenID) external view returns(uint8);

    function deactivateByLicenseStorage(uint256 _tokenID) external;
  
}


// File contracts/interfaces/ILicenseStorage.sol


pragma solidity ^0.8.0;


interface ILicenseStorage{


    function version() external view returns (uint32);

    /// @notice initializes storage for specific VL, depends on rarity
    /// @param _tokenID token id of specific ValidatorLicense
    /// @param _rarity rarity of ValidatorLicense
    function initializeStorage(uint256 _tokenID, uint8 _rarity) payable external;
    /// @notice withdraws payment from specific VL storage during decoding process
    /// @param _tokenID token id of specific ValidatorLicense
    /// @param _amount amount of GUNs that will be transferred
    /// @param _to payment receiver
    function getPaymentFromLicenseStorage(uint256 _tokenID, uint256 _amount, address payable _to) external payable returns(bool);

    function getStorageCurrentValue(uint256 _tokenID) external view returns(uint256);

    function getStorageThreshold() external view returns(uint256);

}


// File contracts/Decoder.sol


pragma solidity ^0.8.0;












/// @title contract for decode functions 
/// @notice User or admin can decode hex in eight different ways
/// @dev This contract is inherits 'EIP&12Upgradeable' contract from openzeppelin library
/// Abbreviations: DC - DataCube; VL - ValidatorLicense; GI - GameItem
contract Decoder is EIP712Custom {
    uint256 public constant PERCENT_DENOMINATOR = 100;
    // address of PlatformSettings contract
    address public platformSettingsContractAddress;
    // address of ValidatorLicenseContract
    address public validatorLicenseContractAddress;
    // address of DataCubeContract
    address public dataCubeContractAddress;
    // address of GameItemContract
    address public gameItemContractAddress;
    // address of LicenseStorage contract
    address public licenseStorageAddress;



    event NFTCubeDecodedForNFTItemWithVL(uint256 indexed VLTokenID, address indexed receiver, uint256 indexed DCTokenID, uint256 DCBackendTokenID, uint256 validatorFeeFromUser, uint256 platformFee, uint256 validatorFeeFromHackerLicense, uint8 hexQuality);
    event NFTCubeDecodedForNonNFTItemWithVL(uint256 indexed VLTokenID, address indexed receiver, uint256 indexed DCTokenID, uint256 DCBackendTokenID, uint256 validatorFeeFromUser, uint256 platformFee, uint256 validatorFeeFromHackerLicense);
    event CubeDecodedForNFTItemWithVL(uint256 indexed VLTokenID, address indexed receiver, uint256 DCBackendTokenID, uint256 validatorFeeFromUser, uint256 platformFee, uint256 validatorFeeFromHackerLicense);
    event CubeDecodedForNonNFTItemWithVL(uint256 indexed VLTokenID, address indexed receiver, uint256 DCBackendTokenID, uint256 validatorFeeFromUser, uint256 platformFee, uint256 validatorFeeFromHackerLicense);
    event NFTCubeDecodedForNFTItemWithoutVL(address indexed receiver, uint256 DCBackendTokenID, uint256 DCTokenID, uint256 platformFee);
    event NFTCubeDecodedForNonNFTItemWithoutVL(address indexed receiver, uint256 DCBackendTokenID, uint256 DCTokenID, uint256 platformFee);
    event CubeDecodedForNFTItemWithoutVL(address indexed receiver, uint256 DCBackendTokenID, uint256 platformFee);
    event CubeDecodedForNonNFTItemWithoutVL(address indexed receiver, uint256 DCBackendTokenID, uint256 platformFee);
    event CreateItemFromParts(uint256 indexed VLTokenID, address indexed receiver, uint256[4] partsIDs, uint256 validatorFeeFromUser, uint256 platformFee, uint256 validatorFeeFromHackerLicense);

    error ContractsIsPaused();

    error InvalidRole(address caller, bytes32 role);

    error CallerNotOwner(address caller, address owner, uint256 tokenID);

    error InactiveLicense();

    error IncorrectValue(uint256 value, uint256 price);

    error IncorrectFeeDistribution();

    error UnsuccessfulPayment(address from, address to, uint256 amount);



    /// @notice A disposable function for intializing contract
    /// @param _platformSettingsContractAddress address of PlatformSettings contract
    /// @param _validatorLicenseContractAddress address of ValidatorLicenseContract
    /// @param _dataCubeContractAddress address of DataCubeContract
    /// @param _gameItemContractAddress address of GameItemContract
    /// @param _licenseStorageAddress address of LicenseStorage Contract
    /// @dev calls initializer  from EIP712Upgradeable contract
    function initialize(
        address _platformSettingsContractAddress,
        address _validatorLicenseContractAddress,
        address _dataCubeContractAddress,
        address _gameItemContractAddress,
        address _licenseStorageAddress
    ) public initializer {
        __EIP712_init('Decoder','1');
        platformSettingsContractAddress = _platformSettingsContractAddress;
        validatorLicenseContractAddress = _validatorLicenseContractAddress;
        dataCubeContractAddress = _dataCubeContractAddress;
        gameItemContractAddress = _gameItemContractAddress;
        licenseStorageAddress = _licenseStorageAddress;
    }

// *********************** MODIFIERS *********************************************
    /// @notice verifies if switch "_paused" in PlatformSettings contract is off
    modifier whenNotPaused{
        if(PlatformSettings(platformSettingsContractAddress).paused()){
            revert ContractsIsPaused();
        }
        _;
    }

    /// @notice verifies if message sender is an admin or secondary admin
    modifier onlyAdmin{
        if(!(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).DEFAULT_ADMIN_ROLE(),msg.sender)||PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).SECONDARY_ADMIN_ROLE(),msg.sender))){
            revert InvalidRole(msg.sender, PlatformSettings(platformSettingsContractAddress).SECONDARY_ADMIN_ROLE());
        }
        _;
    }

// *********************** VIEW FUNCTIONS *********************************************
    /// TODO restrict function visibility from view to pure
    function version() public pure returns (uint32){
        //version in format aaa.bbb.ccc => aaa*1E6+bbb*1E3+ccc;
        return uint32(1000002);
    }
// *********************** Decode functions with VLicense *********************************************

    /// @notice Decodes NFT DC and burns it; mints new NFT GI; sends fee to VL owner and financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev distributes fee to VL owner and financial wallet via 'call' function
    /// @dev withdraws payment from 'LicenseStorage' contract via function 'getPaymentFromLicenseStorage'
    /// TODO tech debt - requirement from 'LicenseStorage.getPaymentFromLicenseStorage' that checks current value of GUNs in storage must be replaced to this function, before fee distribution
    /// TODO modify LicenseStorage.getPaymentFromLicenseStorage function in order to change amount of fee
    /// @dev calls function 'open' via 'IDataCube' interface
    /// @dev emits 'NFTCubeDecodedForNFTItemWithVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - parameter season must be the same as NFT DataCube's season
    /// @dev    - caller must be owner of NFT DataCube
    /// @dev    - ValidatorLicense must be activated
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _DCTokenID token id of NFT DataCube, that will be opened and burned during decoding process
    /// @param _VLTokenID token id of ValidatorLIcense, that takes part in decoding process
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _metadataURL link to metadata storage
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeNFTCubeForNFTItemWithVL(
        uint256 _DCTokenID, 
        uint256 _VLTokenID, 
        uint256 _seasonID, 
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        string memory _metadataURL,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeNFTCubeForNFTItemWithVL(uint256 _DCTokenID,uint256 _VLTokenID,uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,string _metadataURL,uint256 _deadline)"),
                    _DCTokenID,
                    _VLTokenID,
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    keccak256(bytes(_metadataURL)),
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            if(!PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer)){
                revert IncorrectSigner(__signer);
            }
        }
        // function must be executed earlier than signature expires  
        IDataCube dataCubeContract = IDataCube(dataCubeContractAddress);
        if(block.timestamp > _deadline){
            revert DeadlineExpired(_deadline, block.timestamp);
        }
        // Checking NFT-DataCube owner
        if(IERC721Upgradeable(dataCubeContractAddress).ownerOf(_DCTokenID) != msg.sender){
            revert CallerNotOwner(msg.sender, IERC721Upgradeable(dataCubeContractAddress).ownerOf(_DCTokenID), _DCTokenID);
        }
        // Checking VL validity
        if(IValidatorLicense(validatorLicenseContractAddress).getLicenseMode(_VLTokenID) != true){
            revert InactiveLicense();
        }
        uint8 hexQuality = dataCubeContract.getCubeQuality(_DCTokenID);
        uint256 licenseStorageFee = dataCubeContract.getFeeDepensOnQuality(hexQuality);
        // Fee distribution
        feeDistribution(_price, _VLTokenID, licenseStorageFee);
        // Opening DC via 'DataCubeContract'
        IDataCube(dataCubeContractAddress).open(
            _DCTokenID,
            _VLTokenID,
            _seasonID,
            _DCQuality,
            msg.sender,
            _DCBackendTokenID,
            _metadataURL);
        
        emit NFTCubeDecodedForNFTItemWithVL(
            _VLTokenID,
            msg.sender,
            _DCTokenID,
            _DCBackendTokenID,
            (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            licenseStorageFee,
            hexQuality);
    }


    /// @notice Decodes NFT DC and burns it; emits event about new nonNFT GI; sends fee to VL owner and financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev distributes fee to VL owner and financial wallet via 'call' function
    /// @dev withdraws payment from 'LicenseStorage' contract via function 'getPaymentFromLicenseStorage'
    /// TODO tech debt - requirement from 'LicenseStorage.getPaymentFromLicenseStorage' that checks current value of GUNs in storage must be replaced to this function, before fee distribution
    /// TODO modify LicenseStorage.getPaymentFromLicenseStorage function in order to change amount of fee
    /// @dev calls function 'burn' via 'IDataCube' interface
    /// @dev emits 'NFTCubeDecodedForNonNFTItemWithVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - parameter season must be the same as NFT DataCube's season
    /// @dev    - caller must be owner of NFT DataCube
    /// @dev    - ValidatorLicense must be activated
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _DCTokenID token id of NFT DataCube, that will be opened and burned during decoding process
    /// @param _VLTokenID token id of ValidatorLIcense, that takes part in decoding process
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeNFTCubeForNonNFTItemWithVL(
        uint256 _DCTokenID,
        uint256 _VLTokenID,
        uint256 _seasonID,
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeNFTCubeForNonNFTItemWithVL(uint256 _DCTokenID,uint256 _VLTokenID,uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,uint256 _deadline)"),
                    _DCTokenID,
                    _VLTokenID,
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            // require(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).BACKEND_ROLE(), __signer),"IS3");
            require(PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer),"IS7");
        }
        // function must be executed earlier than signature expires  
        require(block.timestamp<_deadline,"ES7");
        // parameter season must be the same as NFT DataCube's season
        require(_seasonID==IDataCube(dataCubeContractAddress).getCubeSeason(_DCTokenID),"IT4");
        // Checking NFT-DataCube owner
        require(IERC721Upgradeable(dataCubeContractAddress).ownerOf(_DCTokenID)==msg.sender, "IR17");
        // Checking VL validity
        require(
            IValidatorLicense(validatorLicenseContractAddress).getLicenseMode(_VLTokenID)==true ,"IL6");

        uint256 licenseStorageFee = IDataCube(dataCubeContractAddress).getFeeDepensOnQuality(_DCQuality);
        
        // Fee distribution
        {
            // Checking receiver`s balance
            require(msg.value==_price, "IF12");
            uint256 validatorPayment = (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            uint256 platformPayment = (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            // Checking fee distribution
            require((validatorPayment+ platformPayment)==_price,"IF13");
            (bool successValidator,) = IERC721Upgradeable(validatorLicenseContractAddress).ownerOf(_VLTokenID).call{value:validatorPayment}("");
            require(successValidator, "TF13");
            (bool successPlatform,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:platformPayment}("");
            require(successPlatform, "TF14");
            // Checking license payment
            bool successfulPayment = ILicenseStorage(licenseStorageAddress).getPaymentFromLicenseStorage(_VLTokenID, licenseStorageFee, PlatformSettings(platformSettingsContractAddress).financialWallet());
            require(successfulPayment, "TF15");
        }
        // Burning DC via 'DataCube'
        IDataCube(dataCubeContractAddress).burn(_DCTokenID);
        
        emit NFTCubeDecodedForNonNFTItemWithVL(
            _VLTokenID,
            msg.sender,
            _DCTokenID,
            _DCBackendTokenID,
            (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            licenseStorageFee);
    }


    /// @notice Decodes nonNFT DC; mints new NFT GI; sends fee to VL owner and financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev distributes fee to VL owner and financial wallet via 'call' function
    /// @dev withdraws payment from 'LicenseStorage' contract via function 'getPaymentFromLicenseStorage'
    /// TODO tech debt - requirement from 'LicenseStorage.getPaymentFromLicenseStorage' that checks current value of GUNs in storage must be replaced to this function, before fee distribution
    /// TODO modify LicenseStorage.getPaymentFromLicenseStorage function in order to change amount of fee
    /// @dev calls function 'mintFromCube' via 'IGameItem' interface
    /// @dev emits 'CubeDecodedForNFTItemWithVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - ValidatorLicense must be activated
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _VLTokenID token id of ValidatorLIcense, that takes part in decoding process
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _metadataURL link to metadata storage
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeCubeForNFTItemWithVL(
        uint256 _VLTokenID, 
        uint256 _seasonID, 
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        string memory _metadataURL,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeCubeForNFTItemWithVL(uint256 _VLTokenID,uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,string _metadataURL,uint256 _deadline)"),
                    _VLTokenID,
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    keccak256(bytes(_metadataURL)),
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            // require(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).BACKEND_ROLE(), __signer),"IS4");
            require(PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer),"IS8");
        }
        // function must be executed earlier than signature expires  
        require(block.timestamp<_deadline,"ES8");
        // Checking VL validity
        require(
            IValidatorLicense(validatorLicenseContractAddress).getLicenseMode(_VLTokenID)==true,"IL7");

        uint256 licenseStorageFee = IDataCube(dataCubeContractAddress).getFeeDepensOnQuality(_DCQuality);
        
        {
            // Checking receiver`s balance 
            require(msg.value==_price, "IF14");
            uint256 validatorPayment = (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            uint256 platformPayment = (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            // Checking fee distribution
            require((validatorPayment+ platformPayment)==_price,"IF15");
            (bool successValidator,) = IERC721Upgradeable(validatorLicenseContractAddress).ownerOf(_VLTokenID).call{value:validatorPayment}("");
            require(successValidator, "TF16");
            (bool successPlatform,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:platformPayment}("");
            require(successPlatform, "TF17");
            // Checkiing license payment
            bool successfulPayment = ILicenseStorage(licenseStorageAddress).getPaymentFromLicenseStorage(_VLTokenID, licenseStorageFee, PlatformSettings(platformSettingsContractAddress).financialWallet());
            require(successfulPayment, "TF18");
        }
        // MInt Item directly via 'GameItem' without agent DC Contract
        IGameItem(gameItemContractAddress).mintFromCube(
            msg.sender,
            _VLTokenID,
            _seasonID,
            _DCQuality,
            _metadataURL);
        emit CubeDecodedForNFTItemWithVL(
            _VLTokenID,
            msg.sender,
            _DCBackendTokenID,
            (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            licenseStorageFee);
    }


    /// @notice Decodes nonNFT DC; emits event about new nonNFT GI; sends fee to VL owner and financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev distributes fee to VL owner and financial wallet via 'call' function
    /// @dev withdraws payment from 'LicenseStorage' contract via function 'getPaymentFromLicenseStorage'
    /// TODO tech debt - requirement from 'LicenseStorage.getPaymentFromLicenseStorage' that checks current value of GUNs in storage must be replaced to this function, before fee distribution
    /// TODO modify LicenseStorage.getPaymentFromLicenseStorage function in order to change amount of fee
    /// @dev emits 'CubeDecodedForNonNFTItemWithVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - ValidatorLicense must be activated
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _VLTokenID token id of ValidatorLIcense, that takes part in decoding process
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeCubeForNonNFTItemWithVL(
        uint256 _VLTokenID, 
        uint256 _seasonID, 
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeCubeForNonNFTItemWithVL(uint256 _VLTokenID,uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,uint256 _deadline)"),
                    _VLTokenID,
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            // require(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).BACKEND_ROLE(), __signer),"IS5");
            require(PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer),"IS9");
        }
        // function must be executed earlier than signature expires  
        require(block.timestamp<_deadline,"ES9");
        // Checking VL validity
        require(IValidatorLicense(validatorLicenseContractAddress).getLicenseMode(_VLTokenID)==true,"IL8");

        uint256 licenseStorageFee = IDataCube(dataCubeContractAddress).getFeeDepensOnQuality(_DCQuality);
        
        {
            // Checking receiver`s balance 
            require(msg.value==_price, "IF16");
            uint256 validatorPayment = (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            uint256 platformPayment = (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            // Checking fee distribution
            require((validatorPayment+ platformPayment)==_price,"IF17");
            (bool successValidator,) = IERC721Upgradeable(validatorLicenseContractAddress).ownerOf(_VLTokenID).call{value:validatorPayment}("");
            require(successValidator, "TF19");
            (bool successPlatform,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:platformPayment}("");
            require(successPlatform, "TF20");
            // Checking license payment
            bool successfulPayment = ILicenseStorage(licenseStorageAddress).getPaymentFromLicenseStorage(_VLTokenID,licenseStorageFee, PlatformSettings(platformSettingsContractAddress).financialWallet());
            require(successfulPayment, "TF21");
        }
        emit CubeDecodedForNonNFTItemWithVL(
            _VLTokenID,
            msg.sender,
            _DCBackendTokenID,
            (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            licenseStorageFee);
    }

// *********************** Decode functions without VLicense *********************************************
    /// @notice Decodes NFT DC and burns it; mints new NFT GI; sends fee to financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev transfers Guns to financial wallet via 'call' function
    /// @dev calls function 'open' via 'IDataCube' interface
    /// @dev emits 'NFTCubeDecodedForNFTItemWithoutVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - parameter season must be the same as NFT DataCube's season
    /// @dev    - caller must be owner of NFT DataCube
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _DCTokenID token id of NFT DataCube, that will be opened and burned during decoding process
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _metadataURL link to metadata storage
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeNFTCubeForNFTItemWithoutVL(
        uint256 _DCTokenID, 
        uint256 _seasonID, 
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        string memory _metadataURL,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeNFTCubeForNFTItemWithoutVL(uint256 _DCTokenID,uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,string _metadataURL,uint256 _deadline)"),
                    _DCTokenID,
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    keccak256(bytes(_metadataURL)),
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
                // require(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).BACKEND_ROLE(), __signer),"IS2");
            require(PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer),"IS10");
        }
        // function must be executed earlier than signature expires  
        require(block.timestamp<_deadline,"ES10");
        // parameter season must be the same as NFT DataCube's season
        require(_seasonID==IDataCube(dataCubeContractAddress).getCubeSeason(_DCTokenID),"IT8");
        // Checking NFT-DataCube owner
        require(IERC721Upgradeable(dataCubeContractAddress).ownerOf(_DCTokenID)==msg.sender, "IR18");

        {
            // Checking receiver's balance
            require(msg.value==_price , "IF18");
            // Checking gun transfer
            (bool successPlatformFee,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:_price}("");
            require(successPlatformFee, "TF22");
        }
        // Opening DC via 'DataCubeContract'
        IDataCube(dataCubeContractAddress).open(
            _DCTokenID,
            0,
            _seasonID,
            _DCQuality,
            msg.sender,
            _DCBackendTokenID,
            _metadataURL);
        
        emit NFTCubeDecodedForNFTItemWithoutVL(
            msg.sender,
            _DCTokenID,
            _DCBackendTokenID,
            _price);
    }

    /// @notice Decodes NFT DC and burns it; emits event about new nonNFT GI; sends fee to financial wallet;
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev transfers GUNs to financial wallet via 'call' function
    /// @dev calls function 'burn' via 'IDataCube' interface
    /// @dev emits 'NFTCubeDecodedForNonNFTItemWithoutVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - parameter season must be the same as NFT DataCube's season
    /// @dev    - caller must be owner of NFT DataCube
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _DCTokenID token id of NFT DataCube, that will be opened and burned during decoding process
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeNFTCubeForNonNFTItemWithoutVL(
        uint256 _DCTokenID,
        uint256 _seasonID,
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeNFTCubeForNonNFTItemWithoutVL(uint256 _DCTokenID,uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,uint256 _deadline)"),
                    _DCTokenID,
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            // require(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).BACKEND_ROLE(), __signer),"IS3");
            require(PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer),"IS11");
        }
        // function must be executed earlier than signature expires  
        require(block.timestamp<_deadline,"ES11");
        // parameter season must be the same as NFT DataCube's season
        require(_seasonID==IDataCube(dataCubeContractAddress).getCubeSeason(_DCTokenID),"IT9");
        // Checking NFT-DataCube owner
        require(IERC721Upgradeable(dataCubeContractAddress).ownerOf(_DCTokenID)==msg.sender, "IR19");

        {
            // Checking receveir's balance
            require(msg.value==_price , "IF19");
            // Checking gun transfer
            (bool successPlatformFee,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:_price}("");
            require(successPlatformFee, "TF23");
        }
        // Burning DC via 'DataCubeContract'
        IDataCube(dataCubeContractAddress).burn(_DCTokenID);
        
       emit NFTCubeDecodedForNonNFTItemWithoutVL(
            msg.sender,
            _DCTokenID,
            _DCBackendTokenID,
            _price);
    }

    /// @notice Decodes nonNFT DC; mints new NFT GI; sends fee to financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev transfers GUNs to financial wallet via 'call' function
    /// @dev calls function 'mintFromCube' via 'IGameItem' interface
    /// @dev emits 'CubeDecodedForNFTItemWithoutVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _metadataURL link to metadata storage
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeCubeForNFTItemWithoutVL(
        uint256 _seasonID, 
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        string memory _metadataURL,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeCubeForNFTItemWithoutVL(uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,string _metadataURL,uint256 _deadline)"),
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    keccak256(bytes(_metadataURL)),
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            // require(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).BACKEND_ROLE(), __signer),"IS4");
            require(PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer),"IS12");
        }
        // function must be executed earlier than signature expires  
        require(block.timestamp<_deadline,"ES12");
        {
            // Checking receiver's balance
            require(msg.value==_price , "IF20");
            // Checking gun transfer
            (bool successPlatformFee,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:_price}("");
            require(successPlatformFee, "TF24");
        }
        // MInt Item directly without agent DC Contract via 'GameItemContract'
        IGameItem(gameItemContractAddress).mintFromCube(
            msg.sender,
            0,
            _seasonID,
            _DCQuality,
            _metadataURL);
        emit CubeDecodedForNFTItemWithoutVL(
            msg.sender,
            _DCBackendTokenID,
            _price);
    }

    /// @notice Decodes nonNFT DC; emits event about new nonNFT GI; sends fee to financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev transfers GUNs to financial wallet via 'call' function
    /// @dev emits 'CubeDecodedForNonNFTItemWithoutVL'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _seasonID id of DataCube season
    /// @param _DCQuality quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _DCBackendTokenID token id of backend nonNFT DataCube
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function decodeCubeForNonNFTItemWithoutVL(
        uint256 _seasonID, 
        uint8 _DCQuality,
        uint256 _price,
        uint256 _DCBackendTokenID,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("DecodeCubeForNonNFTItemWithoutVL(uint256 _seasonID,uint8 _DCQuality,uint256 _price,uint256 _DCBackendTokenID,uint256 _deadline)"),
                    _seasonID,
                    _DCQuality,
                    _price,
                    _DCBackendTokenID,
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            // require(PlatformSettings(platformSettingsContractAddress).hasRole(PlatformSettings(platformSettingsContractAddress).BACKEND_ROLE(), __signer),"IS5");
            require(PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer),"IS13");
        }
        // function must be executed earlier than signature expires  
        require(block.timestamp<_deadline,"ES13");
        
        {
            // Checking receiver's balance
            require(msg.value==_price , "IF21");
            // Checking gun transfer
            (bool successPlatformFee,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:_price}("");
            require(successPlatformFee, "TF25");

            
        }
        emit CubeDecodedForNonNFTItemWithoutVL(
            msg.sender,
            _DCBackendTokenID,
            _price);
    }

    /// @notice Create item from itemParts; emits event about new GI; sends fee to VL owner and financial wallet; withdraws payment from VL storage of GUNs
    /// @dev verifies signer via 'hashTypedDataV4' function from 'EIP712Upgradeable' contract and 'recover' function from 'ECDSAUpgradeable' contract
    /// @dev distributes fee to VL owner and financial wallet via 'call' function
    /// @dev withdraws payment from 'LicenseStorage' contract via function 'getPaymentFromLicenseStorage'
    /// TODO tech debt - requirement from 'LicenseStorage.getPaymentFromLicenseStorage' that checks current value of GUNs in storage must be replaced to this function, before fee distribution
    /// TODO modify LicenseStorage.getPaymentFromLicenseStorage function in order to change amount of fee
    /// @dev emits 'createItemFromParts'
    /// @dev Requirements:
    /// @dev    - signer must have backend role from 'PlatformSettings' contract
    /// @dev    - function must be executed earlier than signature expires 
    /// @dev    - ValidatorLicense must be activated
    /// @dev    - message value of GUNs must be equal to price(with decimals)
    /// @param _VLTokenID token id of ValidatorLIcense, that takes part in decoding process
    /// @param _seasonID id of DataCube season
    /// @param _partsIDs quality of DataCube, represents enumeration of rarity 
    /// @param _price price of decoding process for caller
    /// @param _metadataURL link to metadata storage
    /// @param _deadline expire date of signature; unix time used
    /// @param _signature signed typed data 
    function createItemFromParts(
        uint256 _VLTokenID,
        uint256 _seasonID, 
        uint256[4] memory _partsIDs,
        uint256 _price,
        string memory _metadataURL,
        uint256 _deadline,
        bytes memory _signature
    ) payable public whenNotPaused{
        // verifying signature
        {
            bytes32 __digest = _hashTypedDataV4(keccak256(
                abi.encode(
                    keccak256("createItemFromParts(uint256 _VLTokenID,uint256 _seasonID,uint256[4] _partsIDs,uint256 _price,string _metadataURL,uint256 _deadline)"),
                    _VLTokenID,
                    _seasonID,
                    keccak256(abi.encodePacked(_partsIDs)),
                    _price,
                    keccak256(bytes(_metadataURL)),
                    _deadline
                )
            ));
            address __signer = ECDSAUpgradeable.recover(__digest,_signature);
            if(!PlatformSettings(platformSettingsContractAddress).isBackendRole(__signer)){
                revert IncorrectSigner(__signer);
            }
        }
        // function must be executed earlier than signature expires  
        if(block.timestamp > _deadline){
            revert DeadlineExpired(_deadline, block.timestamp);
        }
        // Checking VL validity
        if(IValidatorLicense(validatorLicenseContractAddress).getLicenseMode(_VLTokenID) != true){
            revert InactiveLicense();
        }
        uint8 quality = IGameItem(gameItemContractAddress).getItemQuality(_partsIDs[0]);
        
        for(uint256 i = 0; i<4; i++){
            IERC721Upgradeable(gameItemContractAddress).transferFrom(msg.sender, address(this), _partsIDs[i]);
        
            IGameItem(gameItemContractAddress).burn(_partsIDs[i]);
        }

        uint256 licenseStorageFee = IDataCube(dataCubeContractAddress).getFeeDepensOnQuality(quality);
        feeDistribution(_price, _VLTokenID, licenseStorageFee);
        

        IGameItem(gameItemContractAddress).mintFromCube(msg.sender, _VLTokenID, _seasonID, quality, _metadataURL);

        emit CreateItemFromParts(
            _VLTokenID,
            msg.sender,
            _partsIDs,
            (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR,
            licenseStorageFee);
    }

    function feeDistribution(uint256 _price, uint256 _VLTokenID, uint256 _licenseStorageFee) internal virtual{
        // Checking receiver`s balance
            if(msg.value != _price){
                revert IncorrectValue(msg.value, _price);
            }
            uint256 validatorPayment = (_price*PlatformSettings(platformSettingsContractAddress).validatorFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            uint256 platformPayment = (_price*PlatformSettings(platformSettingsContractAddress).platformFeePercentageForDecoding())/PERCENT_DENOMINATOR;
            // Checking fee distribution
            if((validatorPayment+ platformPayment)!=_price){
                revert IncorrectFeeDistribution();
            }
            (bool successValidator,) = IERC721Upgradeable(validatorLicenseContractAddress).ownerOf(_VLTokenID).call{value:validatorPayment}("");
            if(!successValidator){
                revert UnsuccessfulPayment(address(this), IERC721Upgradeable(validatorLicenseContractAddress).ownerOf(_VLTokenID), validatorPayment);
            }
            (bool successPlatform,) = PlatformSettings(platformSettingsContractAddress).financialWallet().call{value:platformPayment}("");
            if(!successPlatform){
                revert UnsuccessfulPayment(address(this), PlatformSettings(platformSettingsContractAddress).financialWallet(), platformPayment);
            }
            // Checking license payment
            bool successfulPayment = ILicenseStorage(licenseStorageAddress).getPaymentFromLicenseStorage(_VLTokenID, _licenseStorageFee, PlatformSettings(platformSettingsContractAddress).financialWallet());
            if(!successfulPayment){
                revert UnsuccessfulPayment(licenseStorageAddress, PlatformSettings(platformSettingsContractAddress).financialWallet(), _licenseStorageFee);
            }
    }


}