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

pragma solidity ^0.8.1;

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

        return account.code.length > 0;
    }

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

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

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

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

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

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

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

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a static call.
     *
     * _Available since v3.3._
     */
    function functionStaticCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal view returns (bytes memory) {
        (bool success, bytes memory returndata) = target.staticcall(data);
        return verifyCallResultFromTarget(target, success, returndata, errorMessage);
    }

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

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a delegate call.
     *
     * _Available since v3.4._
     */
    function functionDelegateCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal returns (bytes memory) {
        (bool success, bytes memory returndata) = target.delegatecall(data);
        return verifyCallResultFromTarget(target, success, returndata, errorMessage);
    }

    /**
     * @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
     * the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
     *
     * _Available since v4.8._
     */
    function verifyCallResultFromTarget(
        address target,
        bool success,
        bytes memory returndata,
        string memory errorMessage
    ) internal view returns (bytes memory) {
        if (success) {
            if (returndata.length == 0) {
                // only check isContract if the call was successful and the return data is empty
                // otherwise we already know that it was a contract
                require(isContract(target), "Address: call to non-contract");
            }
            return returndata;
        } else {
            _revert(returndata, errorMessage);
        }
    }

    /**
     * @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
     * revert reason or using the provided one.
     *
     * _Available since v4.3._
     */
    function verifyCallResult(
        bool success,
        bytes memory returndata,
        string memory errorMessage
    ) internal pure returns (bytes memory) {
        if (success) {
            return returndata;
        } else {
            _revert(returndata, errorMessage);
        }
    }

    function _revert(bytes memory returndata, string memory errorMessage) private pure {
        // Look for revert reason and bubble it up if present
        if (returndata.length > 0) {
            // The easiest way to bubble the revert reason is using memory via assembly
            /// @solidity memory-safe-assembly
            assembly {
                let returndata_size := mload(returndata)
                revert(add(32, returndata), returndata_size)
            }
        } else {
            revert(errorMessage);
        }
    }
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import "../access/OwnablePermissions.sol";

/**
 * @title AutomaticValidatorTransferApproval
 * @author Limit Break, Inc.
 * @notice Base contract mix-in that provides boilerplate code giving the contract owner the
 *         option to automatically approve a 721-C transfer validator implementation for transfers.
 */
abstract contract AutomaticValidatorTransferApproval is OwnablePermissions {

    /// @dev Emitted when the automatic approval flag is modified by the creator.
    event AutomaticApprovalOfTransferValidatorSet(bool autoApproved);

    /// @dev If true, the collection's transfer validator is automatically approved to transfer holder's tokens.
    bool public autoApproveTransfersFromValidator;

    /**
     * @notice Sets if the transfer validator is automatically approved as an operator for all token owners.
     * 
     * @dev    Throws when the caller is not the contract owner.
     * 
     * @param autoApprove If true, the collection's transfer validator will be automatically approved to
     *                    transfer holder's tokens.
     */
    function setAutomaticApprovalOfTransfersFromValidator(bool autoApprove) external {
        _requireCallerIsContractOwner();
        autoApproveTransfersFromValidator = autoApprove;
        emit AutomaticApprovalOfTransferValidatorSet(autoApprove);
    }
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import "@openzeppelin/contracts/token/common/ERC2981.sol";

/**
 * @title BasicRoyaltiesBase
 * @author Limit Break, Inc.
 * @dev Base functionality of an NFT mix-in contract implementing the most basic form of programmable royalties.
 */
abstract contract BasicRoyaltiesBase is ERC2981 {

    event DefaultRoyaltySet(address indexed receiver, uint96 feeNumerator);
    event TokenRoyaltySet(uint256 indexed tokenId, address indexed receiver, uint96 feeNumerator);

    function _setDefaultRoyalty(address receiver, uint96 feeNumerator) internal virtual override {
        super._setDefaultRoyalty(receiver, feeNumerator);
        emit DefaultRoyaltySet(receiver, feeNumerator);
    }

    function _setTokenRoyalty(uint256 tokenId, address receiver, uint96 feeNumerator) internal virtual override {
        super._setTokenRoyalty(tokenId, receiver, feeNumerator);
        emit TokenRoyaltySet(tokenId, receiver, feeNumerator);
    }
}

/**
 * @title BasicRoyalties
 * @author Limit Break, Inc.
 * @notice Constructable BasicRoyalties Contract implementation.
 */
abstract contract BasicRoyalties is BasicRoyaltiesBase {
    constructor(address receiver, uint96 feeNumerator) {
        _setDefaultRoyalty(receiver, feeNumerator);
    }
}

/**
 * @title BasicRoyaltiesInitializable
 * @author Limit Break, Inc.
 * @notice Initializable BasicRoyalties Contract implementation to allow for EIP-1167 clones. 
 */
abstract contract BasicRoyaltiesInitializable is BasicRoyaltiesBase {}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

/// @dev Constant bytes32 value of 0x000...000
bytes32 constant ZERO_BYTES32 = bytes32(0);

/// @dev Constant value of 0
uint256 constant ZERO = 0;
/// @dev Constant value of 1
uint256 constant ONE = 1;

/// @dev Constant value representing an open order in storage
uint8 constant ORDER_STATE_OPEN = 0;
/// @dev Constant value representing a filled order in storage
uint8 constant ORDER_STATE_FILLED = 1;
/// @dev Constant value representing a cancelled order in storage
uint8 constant ORDER_STATE_CANCELLED = 2;

/// @dev Constant value representing the ERC721 token type for signatures and transfer hooks
uint256 constant TOKEN_TYPE_ERC721 = 721;
/// @dev Constant value representing the ERC1155 token type for signatures and transfer hooks
uint256 constant TOKEN_TYPE_ERC1155 = 1155;
/// @dev Constant value representing the ERC20 token type for signatures and transfer hooks
uint256 constant TOKEN_TYPE_ERC20 = 20;

/// @dev Constant value to mask the upper bits of a signature that uses a packed `vs` value to extract `s`
bytes32 constant UPPER_BIT_MASK = 0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff;

/// @dev EIP-712 typehash used for validating signature based stored approvals
bytes32 constant UPDATE_APPROVAL_TYPEHASH =
    keccak256("UpdateApprovalBySignature(uint256 tokenType,address token,uint256 id,uint256 amount,uint256 nonce,address operator,uint256 approvalExpiration,uint256 sigDeadline,uint256 masterNonce)");

/// @dev EIP-712 typehash used for validating a single use permit without additional data
bytes32 constant SINGLE_USE_PERMIT_TYPEHASH =
    keccak256("PermitTransferFrom(uint256 tokenType,address token,uint256 id,uint256 amount,uint256 nonce,address operator,uint256 expiration,uint256 masterNonce)");

/// @dev EIP-712 typehash used for validating a single use permit with additional data
string constant SINGLE_USE_PERMIT_TRANSFER_ADVANCED_TYPEHASH_STUB =
    "PermitTransferFromWithAdditionalData(uint256 tokenType,address token,uint256 id,uint256 amount,uint256 nonce,address operator,uint256 expiration,uint256 masterNonce,";

/// @dev EIP-712 typehash used for validating an order permit that updates storage as it fills
string constant PERMIT_ORDER_ADVANCED_TYPEHASH_STUB =
    "PermitOrderWithAdditionalData(uint256 tokenType,address token,uint256 id,uint256 amount,uint256 salt,address operator,uint256 expiration,uint256 masterNonce,";

/// @dev Pausable flag for stored approval transfers of ERC721 assets
uint256 constant PAUSABLE_APPROVAL_TRANSFER_FROM_ERC721 = 1 << 0;
/// @dev Pausable flag for stored approval transfers of ERC1155 assets
uint256 constant PAUSABLE_APPROVAL_TRANSFER_FROM_ERC1155 = 1 << 1;
/// @dev Pausable flag for stored approval transfers of ERC20 assets
uint256 constant PAUSABLE_APPROVAL_TRANSFER_FROM_ERC20 = 1 << 2;

/// @dev Pausable flag for single use permit transfers of ERC721 assets
uint256 constant PAUSABLE_PERMITTED_TRANSFER_FROM_ERC721 = 1 << 3;
/// @dev Pausable flag for single use permit transfers of ERC1155 assets
uint256 constant PAUSABLE_PERMITTED_TRANSFER_FROM_ERC1155 = 1 << 4;
/// @dev Pausable flag for single use permit transfers of ERC20 assets
uint256 constant PAUSABLE_PERMITTED_TRANSFER_FROM_ERC20 = 1 << 5;

/// @dev Pausable flag for order fill transfers of ERC1155 assets
uint256 constant PAUSABLE_ORDER_TRANSFER_FROM_ERC1155 = 1 << 6;
/// @dev Pausable flag for order fill transfers of ERC20 assets
uint256 constant PAUSABLE_ORDER_TRANSFER_FROM_ERC20 = 1 << 7;

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

pragma solidity ^0.8.0;

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

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

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import "../access/OwnablePermissions.sol";
import "../interfaces/ICreatorToken.sol";
import "../interfaces/ICreatorTokenLegacy.sol";
import "../interfaces/ITransferValidator.sol";
import "./TransferValidation.sol";
import "../interfaces/ITransferValidatorSetTokenType.sol";

/**
 * @title CreatorTokenBase
 * @author Limit Break, Inc.
 * @notice CreatorTokenBaseV3 is an abstract contract that provides basic functionality for managing token 
 * transfer policies through an implementation of ICreatorTokenTransferValidator/ICreatorTokenTransferValidatorV2/ICreatorTokenTransferValidatorV3. 
 * This contract is intended to be used as a base for creator-specific token contracts, enabling customizable transfer 
 * restrictions and security policies.
 *
 * <h4>Features:</h4>
 * <ul>Ownable: This contract can have an owner who can set and update the transfer validator.</ul>
 * <ul>TransferValidation: Implements the basic token transfer validation interface.</ul>
 *
 * <h4>Benefits:</h4>
 * <ul>Provides a flexible and modular way to implement custom token transfer restrictions and security policies.</ul>
 * <ul>Allows creators to enforce policies such as account and codehash blacklists, whitelists, and graylists.</ul>
 * <ul>Can be easily integrated into other token contracts as a base contract.</ul>
 *
 * <h4>Intended Usage:</h4>
 * <ul>Use as a base contract for creator token implementations that require advanced transfer restrictions and 
 *   security policies.</ul>
 * <ul>Set and update the ICreatorTokenTransferValidator implementation contract to enforce desired policies for the 
 *   creator token.</ul>
 *
 * <h4>Compatibility:</h4>
 * <ul>Backward and Forward Compatible - V1/V2/V3 Creator Token Base will work with V1/V2/V3 Transfer Validators.</ul>
 */
abstract contract CreatorTokenBase is OwnablePermissions, TransferValidation, ICreatorToken {

    /// @dev Thrown when setting a transfer validator address that has no deployed code.
    error CreatorTokenBase__InvalidTransferValidatorContract();

    /// @dev The default transfer validator that will be used if no transfer validator has been set by the creator.
    address public constant DEFAULT_TRANSFER_VALIDATOR = address(0x721C0078c2328597Ca70F5451ffF5A7B38D4E947);

    /// @dev Used to determine if the default transfer validator is applied.
    /// @dev Set to true when the creator sets a transfer validator address.
    bool private isValidatorInitialized;
    /// @dev Address of the transfer validator to apply to transactions.
    address private transferValidator;

    constructor() {
        _emitDefaultTransferValidator();
        _registerTokenType(DEFAULT_TRANSFER_VALIDATOR);
    }

    /**
     * @notice Sets the transfer validator for the token contract.
     *
     * @dev    Throws when provided validator contract is not the zero address and does not have code.
     * @dev    Throws when the caller is not the contract owner.
     *
     * @dev    <h4>Postconditions:</h4>
     *         1. The transferValidator address is updated.
     *         2. The `TransferValidatorUpdated` event is emitted.
     *
     * @param transferValidator_ The address of the transfer validator contract.
     */
    function setTransferValidator(address transferValidator_) public {
        _requireCallerIsContractOwner();

        bool isValidTransferValidator = transferValidator_.code.length > 0;

        if(transferValidator_ != address(0) && !isValidTransferValidator) {
            revert CreatorTokenBase__InvalidTransferValidatorContract();
        }

        emit TransferValidatorUpdated(address(getTransferValidator()), transferValidator_);

        isValidatorInitialized = true;
        transferValidator = transferValidator_;

        _registerTokenType(transferValidator_);
    }

    /**
     * @notice Returns the transfer validator contract address for this token contract.
     */
    function getTransferValidator() public view override returns (address validator) {
        validator = transferValidator;

        if (validator == address(0)) {
            if (!isValidatorInitialized) {
                validator = DEFAULT_TRANSFER_VALIDATOR;
            }
        }
    }

    /**
     * @dev Pre-validates a token transfer, reverting if the transfer is not allowed by this token's security policy.
     *      Inheriting contracts are responsible for overriding the _beforeTokenTransfer function, or its equivalent
     *      and calling _validateBeforeTransfer so that checks can be properly applied during token transfers.
     *
     * @dev Be aware that if the msg.sender is the transfer validator, the transfer is automatically permitted, as the
     *      transfer validator is expected to pre-validate the transfer.
     *
     * @dev Throws when the transfer doesn't comply with the collection's transfer policy, if the transferValidator is
     *      set to a non-zero address.
     *
     * @param caller  The address of the caller.
     * @param from    The address of the sender.
     * @param to      The address of the receiver.
     * @param tokenId The token id being transferred.
     */
    function _preValidateTransfer(
        address caller, 
        address from, 
        address to, 
        uint256 tokenId, 
        uint256 /*value*/) internal virtual override {
        address validator = getTransferValidator();

        if (validator != address(0)) {
            if (msg.sender == validator) {
                return;
            }

            ITransferValidator(validator).validateTransfer(caller, from, to, tokenId);
        }
    }

    /**
     * @dev Pre-validates a token transfer, reverting if the transfer is not allowed by this token's security policy.
     *      Inheriting contracts are responsible for overriding the _beforeTokenTransfer function, or its equivalent
     *      and calling _validateBeforeTransfer so that checks can be properly applied during token transfers.
     *
     * @dev Be aware that if the msg.sender is the transfer validator, the transfer is automatically permitted, as the
     *      transfer validator is expected to pre-validate the transfer.
     * 
     * @dev Used for ERC20 and ERC1155 token transfers which have an amount value to validate in the transfer validator.
     * @dev The `tokenId` for ERC20 tokens should be set to `0`.
     *
     * @dev Throws when the transfer doesn't comply with the collection's transfer policy, if the transferValidator is
     *      set to a non-zero address.
     *
     * @param caller  The address of the caller.
     * @param from    The address of the sender.
     * @param to      The address of the receiver.
     * @param tokenId The token id being transferred.
     * @param amount  The amount of token being transferred.
     */
    function _preValidateTransfer(
        address caller, 
        address from, 
        address to, 
        uint256 tokenId, 
        uint256 amount,
        uint256 /*value*/) internal virtual override {
        address validator = getTransferValidator();

        if (validator != address(0)) {
            if (msg.sender == validator) {
                return;
            }

            ITransferValidator(validator).validateTransfer(caller, from, to, tokenId, amount);
        }
    }

    function _tokenType() internal virtual pure returns(uint16);

    function _registerTokenType(address validator) internal {
        if (validator != address(0)) {
            uint256 validatorCodeSize;
            assembly {
                validatorCodeSize := extcodesize(validator)
            }
            if(validatorCodeSize > 0) {
                try ITransferValidatorSetTokenType(validator).setTokenTypeOfCollection(address(this), _tokenType()) {
                } catch { }
            }
        }
    }

    /**
     * @dev  Used during contract deployment for constructable and cloneable creator tokens
     * @dev  to emit the `TransferValidatorUpdated` event signaling the validator for the contract
     * @dev  is the default transfer validator.
     */
    function _emitDefaultTransferValidator() internal {
        emit TransferValidatorUpdated(address(0), DEFAULT_TRANSFER_VALIDATOR);
    }
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

/// @title Library for reverting with custom errors efficiently
/// @notice Contains functions for reverting with custom errors with different argument types efficiently
/// @dev To use this library, declare `using CustomRevert for bytes4;` and replace `revert CustomError()` with
/// `CustomError.selector.revertWith()`
/// @dev The functions may tamper with the free memory pointer but it is fine since the call context is exited
/// immediately
library CustomRevert {
  /// @dev Reverts with the selector of a custom error in the scratch space
  function revertWith(bytes4 selector) internal pure {
    assembly ("memory-safe") {
      mstore(0, selector)
      revert(0, 0x04)
    }
  }

  /// @dev Reverts with a custom error with an address argument in the scratch space
  function revertWith(bytes4 selector, address addr) internal pure {
    assembly ("memory-safe") {
      mstore(0, selector)
      mstore(0x04, and(addr, 0xffffffffffffffffffffffffffffffffffffffff))
      revert(0, 0x24)
    }
  }

  /// @dev Reverts with a custom error with an int24 argument in the scratch space
  function revertWith(bytes4 selector, int24 value) internal pure {
    assembly ("memory-safe") {
      mstore(0, selector)
      mstore(0x04, signextend(2, value))
      revert(0, 0x24)
    }
  }

  /// @dev Reverts with a custom error with a uint160 argument in the scratch space
  function revertWith(bytes4 selector, uint160 value) internal pure {
    assembly ("memory-safe") {
      mstore(0, selector)
      mstore(0x04, and(value, 0xffffffffffffffffffffffffffffffffffffffff))
      revert(0, 0x24)
    }
  }

  /// @dev Reverts with a custom error with two int24 arguments
  function revertWith(bytes4 selector, int24 value1, int24 value2) internal pure {
    assembly ("memory-safe") {
      let fmp := mload(0x40)
      mstore(fmp, selector)
      mstore(add(fmp, 0x04), signextend(2, value1))
      mstore(add(fmp, 0x24), signextend(2, value2))
      revert(fmp, 0x44)
    }
  }

  /// @dev Reverts with a custom error with two uint160 arguments
  function revertWith(bytes4 selector, uint160 value1, uint160 value2) internal pure {
    assembly ("memory-safe") {
      let fmp := mload(0x40)
      mstore(fmp, selector)
      mstore(add(fmp, 0x04), and(value1, 0xffffffffffffffffffffffffffffffffffffffff))
      mstore(add(fmp, 0x24), and(value2, 0xffffffffffffffffffffffffffffffffffffffff))
      revert(fmp, 0x44)
    }
  }

  /// @dev Reverts with a custom error with two address arguments
  function revertWith(bytes4 selector, address value1, address value2) internal pure {
    assembly ("memory-safe") {
      let fmp := mload(0x40)
      mstore(fmp, selector)
      mstore(add(fmp, 0x04), and(value1, 0xffffffffffffffffffffffffffffffffffffffff))
      mstore(add(fmp, 0x24), and(value2, 0xffffffffffffffffffffffffffffffffffffffff))
      revert(fmp, 0x44)
    }
  }

  /// @notice bubble up the revert message returned by a call and revert with the selector provided
  /// @dev this function should only be used with custom errors of the type `CustomError(address target, bytes
  /// revertReason)`
  function bubbleUpAndRevertWith(bytes4 selector, address addr) internal pure {
    assembly ("memory-safe") {
      let size := returndatasize()
      let fmp := mload(0x40)

      // Encode selector, address, offset, size, data
      mstore(fmp, selector)
      mstore(add(fmp, 0x04), addr)
      mstore(add(fmp, 0x24), 0x40)
      mstore(add(fmp, 0x44), size)
      returndatacopy(add(fmp, 0x64), 0, size)

      // Ensure the size is a multiple of 32 bytes
      let encodedSize := add(0x64, mul(div(add(size, 31), 32), 32))
      revert(fmp, encodedSize)
    }
  }
}

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

pragma solidity ^0.8.0;

import "./IERC165.sol";

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

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

pragma solidity ^0.8.0;

import "../../interfaces/IERC2981.sol";
import "../../utils/introspection/ERC165.sol";

/**
 * @dev Implementation of the NFT Royalty Standard, a standardized way to retrieve royalty payment information.
 *
 * Royalty information can be specified globally for all token ids via {_setDefaultRoyalty}, and/or individually for
 * specific token ids via {_setTokenRoyalty}. The latter takes precedence over the first.
 *
 * Royalty is specified as a fraction of sale price. {_feeDenominator} is overridable but defaults to 10000, meaning the
 * fee is specified in basis points by default.
 *
 * IMPORTANT: ERC-2981 only specifies a way to signal royalty information and does not enforce its payment. See
 * https://eips.ethereum.org/EIPS/eip-2981#optional-royalty-payments[Rationale] in the EIP. Marketplaces are expected to
 * voluntarily pay royalties together with sales, but note that this standard is not yet widely supported.
 *
 * _Available since v4.5._
 */
abstract contract ERC2981 is IERC2981, ERC165 {
    struct RoyaltyInfo {
        address receiver;
        uint96 royaltyFraction;
    }

    RoyaltyInfo private _defaultRoyaltyInfo;
    mapping(uint256 => RoyaltyInfo) private _tokenRoyaltyInfo;

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

    /**
     * @inheritdoc IERC2981
     */
    function royaltyInfo(uint256 _tokenId, uint256 _salePrice) public view virtual override returns (address, uint256) {
        RoyaltyInfo memory royalty = _tokenRoyaltyInfo[_tokenId];

        if (royalty.receiver == address(0)) {
            royalty = _defaultRoyaltyInfo;
        }

        uint256 royaltyAmount = (_salePrice * royalty.royaltyFraction) / _feeDenominator();

        return (royalty.receiver, royaltyAmount);
    }

    /**
     * @dev The denominator with which to interpret the fee set in {_setTokenRoyalty} and {_setDefaultRoyalty} as a
     * fraction of the sale price. Defaults to 10000 so fees are expressed in basis points, but may be customized by an
     * override.
     */
    function _feeDenominator() internal pure virtual returns (uint96) {
        return 10000;
    }

    /**
     * @dev Sets the royalty information that all ids in this contract will default to.
     *
     * Requirements:
     *
     * - `receiver` cannot be the zero address.
     * - `feeNumerator` cannot be greater than the fee denominator.
     */
    function _setDefaultRoyalty(address receiver, uint96 feeNumerator) internal virtual {
        require(feeNumerator <= _feeDenominator(), "ERC2981: royalty fee will exceed salePrice");
        require(receiver != address(0), "ERC2981: invalid receiver");

        _defaultRoyaltyInfo = RoyaltyInfo(receiver, feeNumerator);
    }

    /**
     * @dev Removes default royalty information.
     */
    function _deleteDefaultRoyalty() internal virtual {
        delete _defaultRoyaltyInfo;
    }

    /**
     * @dev Sets the royalty information for a specific token id, overriding the global default.
     *
     * Requirements:
     *
     * - `receiver` cannot be the zero address.
     * - `feeNumerator` cannot be greater than the fee denominator.
     */
    function _setTokenRoyalty(
        uint256 tokenId,
        address receiver,
        uint96 feeNumerator
    ) internal virtual {
        require(feeNumerator <= _feeDenominator(), "ERC2981: royalty fee will exceed salePrice");
        require(receiver != address(0), "ERC2981: Invalid parameters");

        _tokenRoyaltyInfo[tokenId] = RoyaltyInfo(receiver, feeNumerator);
    }

    /**
     * @dev Resets royalty information for the token id back to the global default.
     */
    function _resetTokenRoyalty(uint256 tokenId) internal virtual {
        delete _tokenRoyaltyInfo[tokenId];
    }
}

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

pragma solidity ^0.8.0;

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

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

    // Token name
    string private _name;

    // Token symbol
    string private _symbol;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        _approve(to, tokenId);
    }

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

        return _tokenApprovals[tokenId];
    }

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

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

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

        _transfer(from, to, tokenId);
    }

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

    /**
     * @dev See {IERC721-safeTransferFrom}.
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 tokenId,
        bytes memory data
    ) public virtual override {
        require(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: caller is not token owner or 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 the owner of the `tokenId`. Does NOT revert if token doesn't exist
     */
    function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
        return _owners[tokenId];
    }

    /**
     * @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 _ownerOf(tokenId) != address(0);
    }

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

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

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

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

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

        // Check that tokenId was not minted by `_beforeTokenTransfer` hook
        require(!_exists(tokenId), "ERC721: token already minted");

        unchecked {
            // Will not overflow unless all 2**256 token ids are minted to the same owner.
            // Given that tokens are minted one by one, it is impossible in practice that
            // this ever happens. Might change if we allow batch minting.
            // The ERC fails to describe this case.
            _balances[to] += 1;
        }

        _owners[tokenId] = to;

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

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

    /**
     * @dev Destroys `tokenId`.
     * The approval is cleared when the token is burned.
     * This is an internal function that does not check if the sender is authorized to operate on the token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     *
     * Emits a {Transfer} event.
     */
    function _burn(uint256 tokenId) internal virtual {
        address owner = ERC721.ownerOf(tokenId);

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

        // Update ownership in case tokenId was transferred by `_beforeTokenTransfer` hook
        owner = ERC721.ownerOf(tokenId);

        // Clear approvals
        delete _tokenApprovals[tokenId];

        unchecked {
            // Cannot overflow, as that would require more tokens to be burned/transferred
            // out than the owner initially received through minting and transferring in.
            _balances[owner] -= 1;
        }
        delete _owners[tokenId];

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

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

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

        _beforeTokenTransfer(from, to, tokenId, 1);

        // Check that tokenId was not transferred by `_beforeTokenTransfer` hook
        require(ERC721.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner");

        // Clear approvals from the previous owner
        delete _tokenApprovals[tokenId];

        unchecked {
            // `_balances[from]` cannot overflow for the same reason as described in `_burn`:
            // `from`'s balance is the number of token held, which is at least one before the current
            // transfer.
            // `_balances[to]` could overflow in the conditions described in `_mint`. That would require
            // all 2**256 token ids to be minted, which in practice is impossible.
            _balances[from] -= 1;
            _balances[to] += 1;
        }
        _owners[tokenId] = to;

        emit Transfer(from, to, tokenId);

        _afterTokenTransfer(from, to, tokenId, 1);
    }

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

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

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

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

    /**
     * @dev Hook that is called before any token transfer. This includes minting and burning. If {ERC721Consecutive} is
     * used, the hook may be called as part of a consecutive (batch) mint, as indicated by `batchSize` greater than 1.
     *
     * Calling conditions:
     *
     * - When `from` and `to` are both non-zero, ``from``'s tokens will be transferred to `to`.
     * - When `from` is zero, the tokens will be minted for `to`.
     * - When `to` is zero, ``from``'s tokens will be burned.
     * - `from` and `to` are never both zero.
     * - `batchSize` is non-zero.
     *
     * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
     */
    function _beforeTokenTransfer(
        address from,
        address to,
        uint256 firstTokenId,
        uint256 batchSize
    ) internal virtual {}

    /**
     * @dev Hook that is called after any token transfer. This includes minting and burning. If {ERC721Consecutive} is
     * used, the hook may be called as part of a consecutive (batch) mint, as indicated by `batchSize` greater than 1.
     *
     * Calling conditions:
     *
     * - When `from` and `to` are both non-zero, ``from``'s tokens were transferred to `to`.
     * - When `from` is zero, the tokens were minted for `to`.
     * - When `to` is zero, ``from``'s tokens were burned.
     * - `from` and `to` are never both zero.
     * - `batchSize` is non-zero.
     *
     * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
     */
    function _afterTokenTransfer(
        address from,
        address to,
        uint256 firstTokenId,
        uint256 batchSize
    ) internal virtual {}

    /**
     * @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
     *
     * WARNING: Anyone calling this MUST ensure that the balances remain consistent with the ownership. The invariant
     * being that for any address `a` the value returned by `balanceOf(a)` must be equal to the number of tokens such
     * that `ownerOf(tokenId)` is `a`.
     */
    // solhint-disable-next-line func-name-mixedcase
    function __unsafe_increaseBalance(address account, uint256 amount) internal {
        _balances[account] += amount;
    }
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import "../utils/AutomaticValidatorTransferApproval.sol";
import "../utils/CreatorTokenBase.sol";
import "../token/erc721/ERC721OpenZeppelin.sol";
import "../interfaces/ITransferValidatorSetTokenType.sol";
import {TOKEN_TYPE_ERC721} from "@limitbreak/permit-c/Constants.sol";

/**
 * @title ERC721C
 * @author Limit Break, Inc.
 * @notice Extends OpenZeppelin's ERC721 implementation with Creator Token functionality, which
 *         allows the contract owner to update the transfer validation logic by managing a security policy in
 *         an external transfer validation security policy registry.  See {CreatorTokenTransferValidator}.
 */
abstract contract ERC721C is ERC721OpenZeppelin, CreatorTokenBase, AutomaticValidatorTransferApproval {

    /**
     * @notice Overrides behavior of isApprovedFor all such that if an operator is not explicitly approved
     *         for all, the contract owner can optionally auto-approve the 721-C transfer validator for transfers.
     */
    function isApprovedForAll(address owner, address operator) public view virtual override returns (bool isApproved) {
        isApproved = super.isApprovedForAll(owner, operator);

        if (!isApproved) {
            if (autoApproveTransfersFromValidator) {
                isApproved = operator == address(getTransferValidator());
            }
        }
    }

    /**
     * @notice Indicates whether the contract implements the specified interface.
     * @dev Overrides supportsInterface in ERC165.
     * @param interfaceId The interface id
     * @return true if the contract implements the specified interface, false otherwise
     */
    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
        return 
        interfaceId == type(ICreatorToken).interfaceId || 
        interfaceId == type(ICreatorTokenLegacy).interfaceId || 
        super.supportsInterface(interfaceId);
    }

    /**
     * @notice Returns the function selector for the transfer validator's validation function to be called 
     * @notice for transaction simulation. 
     */
    function getTransferValidationFunction() external pure returns (bytes4 functionSignature, bool isViewFunction) {
        functionSignature = bytes4(keccak256("validateTransfer(address,address,address,uint256)"));
        isViewFunction = true;
    }

    /// @dev Ties the open-zeppelin _beforeTokenTransfer hook to more granular transfer validation logic
    function _beforeTokenTransfer(
        address from,
        address to,
        uint256 firstTokenId,
        uint256 batchSize) internal virtual override {
        for (uint256 i = 0; i < batchSize;) {
            _validateBeforeTransfer(from, to, firstTokenId + i);
            unchecked {
                ++i;
            }
        }
    }

    /// @dev Ties the open-zeppelin _afterTokenTransfer hook to more granular transfer validation logic
    function _afterTokenTransfer(
        address from,
        address to,
        uint256 firstTokenId,
        uint256 batchSize) internal virtual override {
        for (uint256 i = 0; i < batchSize;) {
            _validateAfterTransfer(from, to, firstTokenId + i);
            unchecked {
                ++i;
            }
        }
    }

    function _tokenType() internal pure override returns(uint16) {
        return uint16(TOKEN_TYPE_ERC721);
    }
}

/**
 * @title ERC721CInitializable
 * @author Limit Break, Inc.
 * @notice Initializable implementation of ERC721C to allow for EIP-1167 proxy clones.
 */
abstract contract ERC721CInitializable is ERC721OpenZeppelinInitializable, CreatorTokenBase, AutomaticValidatorTransferApproval {

    function initializeERC721(string memory name_, string memory symbol_) public override {
        super.initializeERC721(name_, symbol_);

        _emitDefaultTransferValidator();
        _registerTokenType(getTransferValidator());
    }

    /**
     * @notice Overrides behavior of isApprovedFor all such that if an operator is not explicitly approved
     *         for all, the contract owner can optionally auto-approve the 721-C transfer validator for transfers.
     */
    function isApprovedForAll(address owner, address operator) public view virtual override returns (bool isApproved) {
        isApproved = super.isApprovedForAll(owner, operator);

        if (!isApproved) {
            if (autoApproveTransfersFromValidator) {
                isApproved = operator == address(getTransferValidator());
            }
        }
    }

    /**
     * @notice Indicates whether the contract implements the specified interface.
     * @dev Overrides supportsInterface in ERC165.
     * @param interfaceId The interface id
     * @return true if the contract implements the specified interface, false otherwise
     */
    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
        return 
        interfaceId == type(ICreatorToken).interfaceId || 
        interfaceId == type(ICreatorTokenLegacy).interfaceId || 
        super.supportsInterface(interfaceId);
    }

    /**
     * @notice Returns the function selector for the transfer validator's validation function to be called 
     * @notice for transaction simulation. 
     */
    function getTransferValidationFunction() external pure returns (bytes4 functionSignature, bool isViewFunction) {
        functionSignature = bytes4(keccak256("validateTransfer(address,address,address,uint256)"));
        isViewFunction = true;
    }

    /// @dev Ties the open-zeppelin _beforeTokenTransfer hook to more granular transfer validation logic
    function _beforeTokenTransfer(
        address from,
        address to,
        uint256 firstTokenId,
        uint256 batchSize) internal virtual override {
        for (uint256 i = 0; i < batchSize;) {
            _validateBeforeTransfer(from, to, firstTokenId + i);
            unchecked {
                ++i;
            }
        }
    }

    /// @dev Ties the open-zeppelin _afterTokenTransfer hook to more granular transfer validation logic
    function _afterTokenTransfer(
        address from,
        address to,
        uint256 firstTokenId,
        uint256 batchSize) internal virtual override {
        for (uint256 i = 0; i < batchSize;) {
            _validateAfterTransfer(from, to, firstTokenId + i);
            unchecked {
                ++i;
            }
        }
    }

    function _tokenType() internal pure override returns(uint16) {
        return uint16(TOKEN_TYPE_ERC721);
    }
}

// SPDX-License-Identifier: MIT

pragma solidity ^0.8.4;

import "../../access/OwnablePermissions.sol";
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";

abstract contract ERC721OpenZeppelinBase is ERC721 {

    // Token name
    string internal _contractName;

    // Token symbol
    string internal _contractSymbol;

    function name() public view virtual override returns (string memory) {
        return _contractName;
    }

    function symbol() public view virtual override returns (string memory) {
        return _contractSymbol;
    }

    function _setNameAndSymbol(string memory name_, string memory symbol_) internal {
        _contractName = name_;
        _contractSymbol = symbol_;
    }
}

abstract contract ERC721OpenZeppelin is ERC721OpenZeppelinBase {
    constructor(string memory name_, string memory symbol_) ERC721("", "") {
        _setNameAndSymbol(name_, symbol_);
    }
}

abstract contract ERC721OpenZeppelinInitializable is OwnablePermissions, ERC721OpenZeppelinBase {

    error ERC721OpenZeppelinInitializable__AlreadyInitializedERC721();

    /// @notice Specifies whether or not the contract is initialized
    bool private _erc721Initialized;

    /// @dev Initializes parameters of ERC721 tokens.
    /// These cannot be set in the constructor because this contract is optionally compatible with EIP-1167.
    function initializeERC721(string memory name_, string memory symbol_) public virtual {
        _requireCallerIsContractOwner();

        if(_erc721Initialized) {
            revert ERC721OpenZeppelinInitializable__AlreadyInitializedERC721();
        }

        _erc721Initialized = true;

        _setNameAndSymbol(name_, symbol_);
    }
}

// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.26;

/// @author EARN'M Loyalty Ecosystem - EARN'M Copyright ©
/// @title Errors Library
library Errors {
  /// @notice Errors

  /// @notice Unauthorized.
  /// @dev Used when a user is not authorized to perform an action.
  /// Used in:
  /// - "SmartNodes.sol": _sendFee
  error Unauthorized();

  /// @notice Invalid mint amount.
  /// @dev Used when the mint amount is invalid.
  /// Used in:
  /// - "SmartNodes.sol": mint
  error InvalidMintAmount();

  /// @notice No more tiers available.
  /// @dev Used when no more tiers are available.
  /// Used in:
  /// - "SmartNodes.sol": _getTier
  error NoMoreTiersAvailable();

  /// @notice Bad request.
  /// @dev Used when the request is bad.
  /// Used in:
  /// - "SmartNodes.sol": setContractURI, setBaseTokenURI, setConversionUSDPrice
  error BadRequest();

  /// @notice Mints exhausted.
  /// @dev Used when the mints are exhausted.
  /// Used in:
  /// - "SmartNodes.sol": mint
  error MintsExhausted();

  /// @notice Invalid launch timestamp.
  /// @dev Used when the launch timestamp is invalid.
  /// Used in:
  /// - "SmartNodes.sol": constructor
  error InvalidLaunchTimestamp();

  /// @notice Incorrect fee.
  /// @dev Used when the fee is incorrect.
  /// Used in:
  /// - "SmartNodes.sol": mint
  error IncorrectFee();

  /// @notice Mint not allowed.
  /// @dev Used when the mint is not allowed.
  /// Used in:
  /// - "SmartNodes.sol": mint
  error MintNotAllowed();

  /// @notice Invalid bonus criteria.
  /// @dev Used when the bonus criteria is invalid.
  /// Used in:
  /// - "SmartNodes.sol": mint
  error InvalidBonusCriteria();
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

interface ICreatorToken {
    event TransferValidatorUpdated(address oldValidator, address newValidator);
    function getTransferValidator() external view returns (address validator);
    function setTransferValidator(address validator) external;
    function getTransferValidationFunction() external view returns (bytes4 functionSignature, bool isViewFunction);
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

interface ICreatorTokenLegacy {
    event TransferValidatorUpdated(address oldValidator, address newValidator);
    function getTransferValidator() external view returns (address validator);
    function setTransferValidator(address validator) external;
}

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

pragma solidity ^0.8.0;

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (interfaces/IERC2981.sol)

pragma solidity ^0.8.0;

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

/**
 * @dev Interface for the NFT Royalty Standard.
 *
 * A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
 * support for royalty payments across all NFT marketplaces and ecosystem participants.
 *
 * _Available since v4.5._
 */
interface IERC2981 is IERC165 {
    /**
     * @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
     * exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
     */
    function royaltyInfo(uint256 tokenId, uint256 salePrice)
        external
        view
        returns (address receiver, uint256 royaltyAmount);
}

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

pragma solidity ^0.8.0;

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

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

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

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

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

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

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

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

    /**
     * @dev Transfers `tokenId` token from `from` to `to`.
     *
     * WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721
     * or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
     * understand this adds an external call which potentially creates a reentrancy vulnerability.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(
        address from,
        address to,
        uint256 tokenId
    ) external;

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

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

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

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

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

pragma solidity ^0.8.0;

import "../IERC721.sol";

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

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

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

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

pragma solidity ^0.8.0;

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

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

interface ITransferValidator {
    function applyCollectionTransferPolicy(address caller, address from, address to) external view;
    function validateTransfer(address caller, address from, address to) external view;
    function validateTransfer(address caller, address from, address to, uint256 tokenId) external view;
    function validateTransfer(address caller, address from, address to, uint256 tokenId, uint256 amount) external;

    function beforeAuthorizedTransfer(address operator, address token, uint256 tokenId) external;
    function afterAuthorizedTransfer(address token, uint256 tokenId) external;
    function beforeAuthorizedTransfer(address operator, address token) external;
    function afterAuthorizedTransfer(address token) external;
    function beforeAuthorizedTransfer(address token, uint256 tokenId) external;
    function beforeAuthorizedTransferWithAmount(address token, uint256 tokenId, uint256 amount) external;
    function afterAuthorizedTransferWithAmount(address token, uint256 tokenId) external;
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

interface ITransferValidatorSetTokenType {
    function setTokenTypeOfCollection(address collection, uint16 tokenType) external;
}

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

pragma solidity ^0.8.0;

/**
 * @dev Standard math utilities missing in the Solidity language.
 */
library Math {
    enum Rounding {
        Down, // Toward negative infinity
        Up, // Toward infinity
        Zero // Toward zero
    }

    /**
     * @dev Returns the largest of two numbers.
     */
    function max(uint256 a, uint256 b) internal pure returns (uint256) {
        return a > b ? a : b;
    }

    /**
     * @dev Returns the smallest of two numbers.
     */
    function min(uint256 a, uint256 b) internal pure returns (uint256) {
        return a < b ? a : b;
    }

    /**
     * @dev Returns the average of two numbers. The result is rounded towards
     * zero.
     */
    function average(uint256 a, uint256 b) internal pure returns (uint256) {
        // (a + b) / 2 can overflow.
        return (a & b) + (a ^ b) / 2;
    }

    /**
     * @dev Returns the ceiling of the division of two numbers.
     *
     * This differs from standard division with `/` in that it rounds up instead
     * of rounding down.
     */
    function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
        // (a + b - 1) / b can overflow on addition, so we distribute.
        return a == 0 ? 0 : (a - 1) / b + 1;
    }

    /**
     * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
     * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
     * with further edits by Uniswap Labs also under MIT license.
     */
    function mulDiv(
        uint256 x,
        uint256 y,
        uint256 denominator
    ) internal pure returns (uint256 result) {
        unchecked {
            // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
            // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
            // variables such that product = prod1 * 2^256 + prod0.
            uint256 prod0; // Least significant 256 bits of the product
            uint256 prod1; // Most significant 256 bits of the product
            assembly {
                let mm := mulmod(x, y, not(0))
                prod0 := mul(x, y)
                prod1 := sub(sub(mm, prod0), lt(mm, prod0))
            }

            // Handle non-overflow cases, 256 by 256 division.
            if (prod1 == 0) {
                return prod0 / denominator;
            }

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

            ///////////////////////////////////////////////
            // 512 by 256 division.
            ///////////////////////////////////////////////

            // Make division exact by subtracting the remainder from [prod1 prod0].
            uint256 remainder;
            assembly {
                // Compute remainder using mulmod.
                remainder := mulmod(x, y, denominator)

                // Subtract 256 bit number from 512 bit number.
                prod1 := sub(prod1, gt(remainder, prod0))
                prod0 := sub(prod0, remainder)
            }

            // Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
            // See https://cs.stackexchange.com/q/138556/92363.

            // Does not overflow because the denominator cannot be zero at this stage in the function.
            uint256 twos = denominator & (~denominator + 1);
            assembly {
                // Divide denominator by twos.
                denominator := div(denominator, twos)

                // Divide [prod1 prod0] by twos.
                prod0 := div(prod0, twos)

                // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
                twos := add(div(sub(0, twos), twos), 1)
            }

            // Shift in bits from prod1 into prod0.
            prod0 |= prod1 * twos;

            // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
            // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
            // four bits. That is, denominator * inv = 1 mod 2^4.
            uint256 inverse = (3 * denominator) ^ 2;

            // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
            // in modular arithmetic, doubling the correct bits in each step.
            inverse *= 2 - denominator * inverse; // inverse mod 2^8
            inverse *= 2 - denominator * inverse; // inverse mod 2^16
            inverse *= 2 - denominator * inverse; // inverse mod 2^32
            inverse *= 2 - denominator * inverse; // inverse mod 2^64
            inverse *= 2 - denominator * inverse; // inverse mod 2^128
            inverse *= 2 - denominator * inverse; // inverse mod 2^256

            // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
            // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
            // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
            // is no longer required.
            result = prod0 * inverse;
            return result;
        }
    }

    /**
     * @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
     */
    function mulDiv(
        uint256 x,
        uint256 y,
        uint256 denominator,
        Rounding rounding
    ) internal pure returns (uint256) {
        uint256 result = mulDiv(x, y, denominator);
        if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
            result += 1;
        }
        return result;
    }

    /**
     * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
     *
     * Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
     */
    function sqrt(uint256 a) internal pure returns (uint256) {
        if (a == 0) {
            return 0;
        }

        // For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
        //
        // We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
        // `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
        //
        // This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
        // → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
        // → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
        //
        // Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
        uint256 result = 1 << (log2(a) >> 1);

        // At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
        // since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
        // every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
        // into the expected uint128 result.
        unchecked {
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            result = (result + a / result) >> 1;
            return min(result, a / result);
        }
    }

    /**
     * @notice Calculates sqrt(a), following the selected rounding direction.
     */
    function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = sqrt(a);
            return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
        }
    }

    /**
     * @dev Return the log in base 2, rounded down, of a positive value.
     * Returns 0 if given 0.
     */
    function log2(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >> 128 > 0) {
                value >>= 128;
                result += 128;
            }
            if (value >> 64 > 0) {
                value >>= 64;
                result += 64;
            }
            if (value >> 32 > 0) {
                value >>= 32;
                result += 32;
            }
            if (value >> 16 > 0) {
                value >>= 16;
                result += 16;
            }
            if (value >> 8 > 0) {
                value >>= 8;
                result += 8;
            }
            if (value >> 4 > 0) {
                value >>= 4;
                result += 4;
            }
            if (value >> 2 > 0) {
                value >>= 2;
                result += 2;
            }
            if (value >> 1 > 0) {
                result += 1;
            }
        }
        return result;
    }

    /**
     * @dev Return the log in base 2, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log2(value);
            return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
        }
    }

    /**
     * @dev Return the log in base 10, rounded down, of a positive value.
     * Returns 0 if given 0.
     */
    function log10(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >= 10**64) {
                value /= 10**64;
                result += 64;
            }
            if (value >= 10**32) {
                value /= 10**32;
                result += 32;
            }
            if (value >= 10**16) {
                value /= 10**16;
                result += 16;
            }
            if (value >= 10**8) {
                value /= 10**8;
                result += 8;
            }
            if (value >= 10**4) {
                value /= 10**4;
                result += 4;
            }
            if (value >= 10**2) {
                value /= 10**2;
                result += 2;
            }
            if (value >= 10**1) {
                result += 1;
            }
        }
        return result;
    }

    /**
     * @dev Return the log in base 10, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log10(value);
            return result + (rounding == Rounding.Up && 10**result < value ? 1 : 0);
        }
    }

    /**
     * @dev Return the log in base 256, rounded down, of a positive value.
     * Returns 0 if given 0.
     *
     * Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
     */
    function log256(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >> 128 > 0) {
                value >>= 128;
                result += 16;
            }
            if (value >> 64 > 0) {
                value >>= 64;
                result += 8;
            }
            if (value >> 32 > 0) {
                value >>= 32;
                result += 4;
            }
            if (value >> 16 > 0) {
                value >>= 16;
                result += 2;
            }
            if (value >> 8 > 0) {
                result += 1;
            }
        }
        return result;
    }

    /**
     * @dev Return the log in base 10, following the selected rounding direction, of a positive value.
     * Returns 0 if given 0.
     */
    function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
        unchecked {
            uint256 result = log256(value);
            return result + (rounding == Rounding.Up && 1 << (result * 8) < value ? 1 : 0);
        }
    }
}

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

pragma solidity ^0.8.0;

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

/**
 * @dev Contract module which provides a basic access control mechanism, where
 * there is an account (an owner) that can be granted exclusive access to
 * specific functions.
 *
 * By default, the owner account will be the one that deploys the contract. This
 * can later be changed with {transferOwnership}.
 *
 * This module is used through inheritance. It will make available the modifier
 * `onlyOwner`, which can be applied to your functions to restrict their use to
 * the owner.
 */
abstract contract Ownable is Context {
    address private _owner;

    event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

    /**
     * @dev Initializes the contract setting the deployer as the initial owner.
     */
    constructor() {
        _transferOwnership(_msgSender());
    }

    /**
     * @dev Throws if called by any account other than the owner.
     */
    modifier onlyOwner() {
        _checkOwner();
        _;
    }

    /**
     * @dev Returns the address of the current owner.
     */
    function owner() public view virtual returns (address) {
        return _owner;
    }

    /**
     * @dev Throws if the sender is not the owner.
     */
    function _checkOwner() internal view virtual {
        require(owner() == _msgSender(), "Ownable: caller is not the owner");
    }

    /**
     * @dev Leaves the contract without owner. It will not be possible to call
     * `onlyOwner` functions anymore. Can only be called by the current owner.
     *
     * NOTE: Renouncing ownership will leave the contract without an owner,
     * thereby removing any functionality that is only available to the owner.
     */
    function renounceOwnership() public virtual onlyOwner {
        _transferOwnership(address(0));
    }

    /**
     * @dev Transfers ownership of the contract to a new account (`newOwner`).
     * Can only be called by the current owner.
     */
    function transferOwnership(address newOwner) public virtual onlyOwner {
        require(newOwner != address(0), "Ownable: new owner is the zero address");
        _transferOwnership(newOwner);
    }

    /**
     * @dev Transfers ownership of the contract to a new account (`newOwner`).
     * Internal function without access restriction.
     */
    function _transferOwnership(address newOwner) internal virtual {
        address oldOwner = _owner;
        _owner = newOwner;
        emit OwnershipTransferred(oldOwner, newOwner);
    }
}

// SPDX-License-Identifier: MIT

pragma solidity ^0.8.4;

import "./OwnablePermissions.sol";
import "@openzeppelin/contracts/access/Ownable.sol";

abstract contract OwnableBasic is OwnablePermissions, Ownable {
    function _requireCallerIsContractOwner() internal view virtual override {
        _checkOwner();
    }
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import "@openzeppelin/contracts/utils/Context.sol";

abstract contract OwnablePermissions is Context {
    function _requireCallerIsContractOwner() internal view virtual;
}

// SPDX-License-Identifier: MIT
// https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/ReentrancyGuardTransient.sol

pragma solidity ^0.8.24;

import { StorageSlot } from "./StorageSlot.sol";

/**
 * @dev Variant of {ReentrancyGuard} that uses transient storage.
 *
 * NOTE: This variant only works on networks where EIP-1153 is available.
 */
abstract contract ReentrancyGuardTransient {
  using StorageSlot for *;

  // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
  bytes32 private constant REENTRANCY_GUARD_STORAGE = 0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;

  /**
   * @dev Unauthorized reentrant call.
   */
  error ReentrancyGuardReentrantCall();

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

  function _nonReentrantBefore() private {
    // On the first call to nonReentrant, _status will be NOT_ENTERED
    if (_reentrancyGuardEntered()) revert ReentrancyGuardReentrantCall();

    // Any calls to nonReentrant after this point will fail
    REENTRANCY_GUARD_STORAGE.asBoolean().tstore(true);
  }

  function _nonReentrantAfter() private {
    REENTRANCY_GUARD_STORAGE.asBoolean().tstore(false);
  }

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

// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.26;

// Reeentrancy Guard
import { ReentrancyGuardTransient } from "./ReentrancyGuardTransient.sol";

// LimitBreak implementations of ERC721C and Programmable Royalties
import { OwnableBasic, OwnablePermissions } from "@limitbreak/creator-token-standards/src/access/OwnableBasic.sol";
import { ERC721C, ERC721OpenZeppelin } from "@limitbreak/creator-token-standards/src/erc721c/ERC721C.sol";
import {
  BasicRoyalties, ERC2981
} from "@limitbreak/creator-token-standards/src/programmable-royalties/BasicRoyalties.sol";

// OpenZeppelin imports
import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";

// CustomRevert
import { CustomRevert } from "./CustomRevert.sol";

// Errors
import { Errors } from "./Errors.sol";

/// @author EARN'M Loyalty Ecosystem - EARN'M Copyright ©
/// @title SmartNodes
contract SmartNodes is ReentrancyGuardTransient, OwnableBasic, BasicRoyalties, ERC721C {
  using CustomRevert for bytes4;

  /// @notice SmartNode Struct
  struct SmartNode {
    uint16 tier;
    uint40 blockTs;
  }

  /*//////////////////////////////////////////////////////////////
                Public Variables
  //////////////////////////////////////////////////////////////*/

  /// @notice OpenSea Contract-level metadata
  string public _contractURI;

  /// @notice ERC721 Base Token metadata
  string public _baseTokenURI;

  /// @notice OpenSea Asset-level metadata
  string public _assetURI;

  /*//////////////////////////////////////////////////////////////
                SmartNode Variables
  //////////////////////////////////////////////////////////////*/

  /// @notice Tier IDs length
  uint16 internal constant TIER_IDS_LENGTH = 9;

  /// @notice Tier IDs array length; This is used to have arrays with a length of
  /// tier IDs + 1, so we can access the array with the tier ID directly.
  uint16 internal constant TIER_IDS_ARRAY_LEN = TIER_IDS_LENGTH + 1;

  /// @notice this array stores index: tier ID, value: supply
  /// element [0] never used since tier ID : [1, 9].
  ///
  /// Leftover supply from an unsold tier within its availability period is carried forward to the next tier.
  ///
  /// For example, if Tier 3 is not completely sold out within 6 days, the remaining supply
  /// will be added to Tier 4's supply.
  ///
  /// This array should not be modified.
  uint16[TIER_IDS_ARRAY_LEN] internal tierMaxSupply = [
    0,
    450, /*    Tier 1 Max Supply */
    9000, /*   Tier 2 Max Supply */
    31_050, /* Tier 3 Max Supply */
    1800, /*   Tier 4 Max Supply */
    1000, /*   Tier 5 Max Supply */
    675, /*    Tier 6 Max Supply */
    450, /*    Tier 7 Max Supply */
    350, /*    Tier 8 Max Supply */
    225 /*     Tier 9 Max Supply */
  ];

  /// @notice Tier supply to be modified during mint given availability periods
  /// and carried forward supply from unsold tiers.
  /// This array stores index: tier ID, value: supply.
  /// element [0] never used since tier ID : [1, 9].
  uint16[TIER_IDS_ARRAY_LEN] internal tierSupply = tierMaxSupply;

  /// @notice this array stores index: tier ID, value: price in USD.
  /// element [0] never used since tier ID : [1, 9].
  uint128[TIER_IDS_ARRAY_LEN] internal tierFee = [
    0,
    150, /* Tier 1 fee USD */
    175, /* Tier 2 fee USD */
    200, /* Tier 3 fee USD */
    250, /* Tier 4 fee USD */
    275, /* Tier 5 fee USD */
    325, /* Tier 6 fee USD */
    425, /* Tier 7 fee USD */
    500, /* Tier 8 fee USD */
    750 /*  Tier 9 fee USD */
  ];

  /// @notice Tier availability periods in days, starting from the contract launch timestamp.
  /// - Index 0 is not used.
  /// - Tiers become unavailable after their respective max age (availability period),
  /// - Leftover supply from an unsold tier is carried forward to the next tier.
  ///
  /// Tier Availability Periods, starting from launch timestamp:
  /// - Tier 1: 1 day (Oct 1 - Oct 2)
  /// - Tier 2: 1 day (Oct 2 - Oct 3)
  /// - Tier 3: 6 days (Oct 3 - Oct 9)
  /// - Tier 4: 6 days (Oct 9 - Oct 15)
  /// - Tier 5: 3 days (Oct 15 - Oct 18)
  /// - Tier 6: 4 days (Oct 18 - Oct 22)
  /// - Tier 7: 3 days (Oct 22 - Oct 25)
  /// - Tier 8: 3 days (Oct 25 - Oct 28)
  /// - Tier 9: Ongoing (from Oct 28 onwards)
  ///
  /// @notice this array stores index: tier ID, value: availability period timestamp
  /// element [0] never used since tier ID : [1, 9].
  uint40[TIER_IDS_ARRAY_LEN] internal tierAvailabilityPeriodTimestamps;

  /*//////////////////////////////////////////////////////////////
                Internal Variables
  //////////////////////////////////////////////////////////////*/

  /// @notice IsMintAllowed flag
  bool internal isMintAllowed;

  /// @notice this array stores index: tier ID, value: minted amount
  /// element [0] never used since tier ID : [1, 9]
  uint16[TIER_IDS_ARRAY_LEN] internal mintedTierAmount;

  /// @notice Default royalties receiver
  address internal feesReceiverAddress;

  /// @notice Max supply of SmartNodes
  uint16 internal immutable MAX_SUPPLY = 45_500;

  /// @notice SmartNodes remaining
  uint16 internal smartNodesRemaining = MAX_SUPPLY;

  /// @notice Token Id counter; using uint16 since supply is 45,500.
  uint16 internal tokenIdCounter = 1;

  /// @notice Helper to access more efficiently to the current tier
  uint16 internal currentTier = 1;

  /// @notice The initial conversion rate used to convert the mint fee from USD to the native network currency (ETH).
  /// @dev The scope of this contract doesn't include price conversion feeds, so this goal is to achieve an approximate
  /// conversion rate not an exact conversion from USD to ETH.
  uint16 internal conversionUSDPrice;

  /// @notice Launch timestamp
  uint40 internal launchTimestamp;

  /// @notice Mapping of token Ids to SmartNodes
  mapping(uint16 tokenId => SmartNode sn) internal smartNodes;

  /// @notice Mapping of amount of smart nodes minted for users
  mapping(address user => uint16 amount) internal userToMintedAmount;

  /// @notice Mapping of users that at before launch time have a BLUE CHIP NFT and are granted with free smart nodes
  /// BLUE CHIP NFT: https://etherscan.io/address/0xfa41c1138f34e7f88c692ef3b345b03550bb2659
  /// SmartNodes per BLU3CHIP Rarity:
  /// - Bored = 2 SmartNodes
  /// - Mutant = 3 SmartNodes
  /// - Kong = 4 SmartNodes
  /// - Cat = 5 SmartNodes
  mapping(address user => uint16 freeSmartNodes) internal userToFreeSmartNodes;

  /*//////////////////////////////////////////////////////////////
                Events
  //////////////////////////////////////////////////////////////*/

  event FeesReceiverUpdated(address receiver);
  event TokenRoyaltyUpdated(uint256 tokenId, address receiver, uint96 feeNumerator);
  event MintAllowedUpdated(bool isMintAllowed);
  event ContractURIUpdated(string contractURI);
  event BaseTokenURIUpdated(string baseTokenURI);
  event AssetURIUpdated(string assetURI);
  event TierFeeUpdated(uint16 tierId, uint128 fee);
  event Minted(address indexed user, uint16[] tokenIdsMinted, uint16 bonusSmartNodes, uint128 mintFee);
  event ConversionUSDPriceUpdated(uint16 conversionUSDPrice);
  event FreeSmartNodesUpdated(address indexed user, uint16 bonusSmartNodes);

  /// @notice SmartNode constructor
  /// @dev - SmartNodes is OwnableBasic, which inherits OpenZeppelin's OwnablePermissions and Ownable. Making the
  /// deployer
  /// of the contract as the initial owner.
  ///
  /// @param royaltyReceiver_ - the address of the royalties receiver
  /// @param royaltyFeeNumerator_ - the fee numerator
  /// @param baseTokenURI_ - the token metadata URI
  /// @param contractURI_ - the contract metadata URI
  /// @param launchTimestamp_ - the launch timestamp
  /// @param conversionUSDPrice_ - the conversion USD price
  constructor(
    address royaltyReceiver_,
    uint96 royaltyFeeNumerator_,
    string memory baseTokenURI_,
    string memory contractURI_,
    uint40 launchTimestamp_,
    uint16 conversionUSDPrice_
  )
    ERC721OpenZeppelin("Earnm SmartNodes", "ENMSN")
    BasicRoyalties(royaltyReceiver_, royaltyFeeNumerator_)
  {
    // URIs for metadata
    _baseTokenURI = baseTokenURI_;
    _assetURI = baseTokenURI_;
    _contractURI = contractURI_;

    // Default royalties receiver
    feesReceiverAddress = royaltyReceiver_;

    // Launch timestamp must be valid. Must be non-zero and after the current timestamp.
    if (launchTimestamp_ <= block.timestamp) Errors.InvalidLaunchTimestamp.selector.revertWith();

    // Launch timestamp
    launchTimestamp = launchTimestamp_;

    // Conversion USD price
    conversionUSDPrice = conversionUSDPrice_;

    // Tier availability period timestamps
    // Expected launch timestamp: `1727740800` (Oct 1, 2024, 00:00:00 UTC)
    // Tier 1: launch timestamp + 1 day = Oct 2, 2024, 00:00:00 UTC
    // From Oct 1, 2024, 00:00:00 UTC to Oct 2, 2024, 00:00:00 UTC is 1 day
    uint40 _tier1AvailabilityPeriodTimestamp = launchTimestamp + 1 days;

    // Tier 2: Tier 1 availability period timestamp + 1 day = Oct 3, 2024, 00:00:00 UTC
    // From Oct 2, 2024, 00:00:00 UTC to Oct 3, 2024, 00:00:00 UTC is 1 day
    uint40 _tier2AvailabilityPeriodTimestamp = _tier1AvailabilityPeriodTimestamp + 1 days;

    // Tier 3: Tier 2 availability period timestamp + 6 days = Oct 9, 2024, 00:00:00 UTC
    // From Oct 3, 2024, 00:00:00 UTC to Oct 9, 2024, 00:00:00 UTC is 6 days
    uint40 _tier3AvailabilityPeriodTimestamp = _tier2AvailabilityPeriodTimestamp + 6 days;

    // Tier 4: Tier 3 availability period timestamp + 6 days = Oct 15, 2024, 00:00:00 UTC
    // From Oct 9, 2024, 00:00:00 UTC to Oct 15, 2024, 00:00:00 UTC is 6 days
    uint40 _tier4AvailabilityPeriodTimestamp = _tier3AvailabilityPeriodTimestamp + 6 days;

    // Tier 5: Tier 4 availability period timestamp + 3 days = Oct 18, 2024, 00:00:00 UTC
    // From Oct 15, 2024, 00:00:00 UTC to Oct 18, 2024, 00:00:00 UTC is 3 days
    uint40 _tier5AvailabilityPeriodTimestamp = _tier4AvailabilityPeriodTimestamp + 3 days;

    // Tier 6: Tier 5 availability period timestamp + 4 days = Oct 22, 2024, 00:00:00 UTC
    // From Oct 18, 2024, 00:00:00 UTC to Oct 22, 2024, 00:00:00 UTC is 4 days
    uint40 _tier6AvailabilityPeriodTimestamp = _tier5AvailabilityPeriodTimestamp + 4 days;

    // Tier 7: Tier 6 availability period timestamp + 3 days = Oct 25, 2024, 00:00:00 UTC
    // From Oct 22, 2024, 00:00:00 UTC to Oct 25, 2024, 00:00:00 UTC is 3 days
    uint40 _tier7AvailabilityPeriodTimestamp = _tier6AvailabilityPeriodTimestamp + 3 days;

    // Tier 8: Tier 7 availability period timestamp + 3 days = Oct 28, 2024, 00:00:00 UTC
    // From Oct 25, 2024, 00:00:00 UTC to Oct 28, 2024, 00:00:00 UTC is 3 days
    uint40 _tier8AvailabilityPeriodTimestamp = _tier7AvailabilityPeriodTimestamp + 3 days;

    // Tier 9: uint40 max value - 1 = Oct 28, 2024, 00:00:00 UTC
    // From Oct 28, 2024, 00:00:00 UTC to `1099511627775` epoch ~ 2/19/36812, 9:36:15 PM
    uint40 _tier9AvailabilityPeriodTimestamp = type(uint40).max - 1;

    /// @notice this array stores index: tier ID, value: availability period timestamp
    /// element [0] never used since tier ID : [1, 9].
    tierAvailabilityPeriodTimestamps = [
      0,
      _tier1AvailabilityPeriodTimestamp,
      _tier2AvailabilityPeriodTimestamp,
      _tier3AvailabilityPeriodTimestamp,
      _tier4AvailabilityPeriodTimestamp,
      _tier5AvailabilityPeriodTimestamp,
      _tier6AvailabilityPeriodTimestamp,
      _tier7AvailabilityPeriodTimestamp,
      _tier8AvailabilityPeriodTimestamp,
      _tier9AvailabilityPeriodTimestamp
    ];
  }

  /*//////////////////////////////////////////////////////////////
                ERC721-C
  //////////////////////////////////////////////////////////////*/

  function supportsInterface(bytes4 interfaceId) public view virtual override(ERC721C, ERC2981) returns (bool) {
    return ERC721C.supportsInterface(interfaceId);
  }

  /// @dev `OwnablePermissions` is a contract that defines the permissions for the owner of the contract.
  function _requireCallerIsContractOwner() internal view virtual override(OwnableBasic, OwnablePermissions) {
    if (msg.sender != owner()) Errors.BadRequest.selector.revertWith();
  }

  /*//////////////////////////////////////////////////////////////
                END-USER FUNCTION: MINT
  //////////////////////////////////////////////////////////////*/

  /// @notice Mint a new token; Tier assignment is FIFO based on the current balance of each tier, starting from the
  /// lowest to the highest tier.
  /// @param amountRequested The amount of tokens to mint.
  /// @param bonusCriteria The bonus criteria to be used.
  function mint(
    uint16 amountRequested,
    uint16 bonusCriteria
  )
    external
    payable
    nonReentrant
    returns (uint16[] memory tokenIdsMinted)
  {
    //
    //
    //
    //  Request Checks: Validate minting permissions and ensure supply remains
    // ---------------------------------------------------------------------------------------------

    if (!isMintAllowed) Errors.MintNotAllowed.selector.revertWith();

    uint16 smartNodesRemainingCache = smartNodesRemaining;

    if (smartNodesRemainingCache == 0) Errors.MintsExhausted.selector.revertWith();

    //
    //
    //
    //  Calculate the amount to pay for the mint transaction, the free and bonus smart nodes
    // ---------------------------------------------------------------------------------------------

    // Get the user's free smart nodes
    uint16 userFreeSmartNodesCache = userToFreeSmartNodes[msg.sender];

    // Amount of smart nodes that the user will have to pay for.
    // Starts with the amount requested, then will be reduced by the user's free smart nodes.
    (uint16 amountToPayFor, uint16 updatedUserFreeSmartNodes) =
      _calculateAmountToPayFor(amountRequested, userFreeSmartNodesCache);

    // Update the user's free smart nodes storage variable only if it changed after calculating the amount to pay for
    if (updatedUserFreeSmartNodes != userFreeSmartNodesCache) {
      userToFreeSmartNodes[msg.sender] = updatedUserFreeSmartNodes;
    }

    // Get the bonus smart nodes to be minted. Bonus smart nodes are counted based on the amount of smart nodes to mint
    // that the user has to pay for.
    uint16 bonusSmartNodes = _countBonusSmartNodes(amountToPayFor, bonusCriteria);

    // Total amount to mint including bonus and free smart nodes
    uint16 amountToMint = amountRequested + bonusSmartNodes;

    // If the amount to mint is 0 or greater than the remaining smart nodes, revert
    if (amountToMint == 0 || amountToMint > smartNodesRemainingCache) Errors.InvalidMintAmount.selector.revertWith();

    // ---------------------------------------------------------------------------------------------

    //
    //
    //
    // Cache state variables to prevent re-reading them from storage multiple times
    // ---------------------------------------------------------------------------------------------

    // [Gas] Cache the tier fees
    uint128[TIER_IDS_ARRAY_LEN] memory tierFeeCache = tierFee;

    // [Gas] Cache the tier availability period timestamps
    uint40[TIER_IDS_ARRAY_LEN] memory tierAvailabilityPeriodTimestampsCache = tierAvailabilityPeriodTimestamps;

    // [Gas] Cache the tier supplies
    uint16[TIER_IDS_ARRAY_LEN] memory tierSupplyCache = tierSupply;

    // [Gas] Cache the minted tier amounts
    uint16[TIER_IDS_ARRAY_LEN] memory mintedTierAmountCache = mintedTierAmount;

    // [Gas] Cache the initial current tier
    uint16 initialCurrentTierCache = currentTier;

    // [Gas] Cache the current tier
    uint16 currentTierCache = initialCurrentTierCache;

    // [Gas] Cache the token Id counter
    uint16 tokenIdCounterCache = tokenIdCounter;

    // ---------------------------------------------------------------------------------------------

    //
    //
    //
    //  Mint the SmartNodes
    // ---------------------------------------------------------------------------------------------

    // [Gas] The array of token Ids minted by the transaction
    tokenIdsMinted = new uint16[](amountToMint);

    // Current timestamp
    uint40 currentTimestamp = uint40(block.timestamp);

    // Fee to be paid for the mint.
    // Based on the amount of tokens to mint and their corresponding tiers, this will be
    // calculated during the loop and will be used to validate that the transaction
    // paid the correct amount of fee for the mint.
    uint128 mintFee;

    for (uint16 i; i < amountToMint; i++) {
      // Increment the token Id counter cache and store the token Id in the array
      // of token Ids minted by the transaction
      unchecked {
        tokenIdsMinted[i] = tokenIdCounterCache++;
      }

      // Get the tier that the new token will belong to. Will never return a lower tier than the current tier cache.
      // Updates the "tierSupplyCache" with the remaining supply of the current tier
      uint16 newTokenTier = _getTier(
        currentTierCache,
        currentTimestamp,
        tierSupplyCache,
        mintedTierAmountCache,
        tierAvailabilityPeriodTimestampsCache
      );

      // If the tier of the new token is different from the current tier, update the current tier cache
      // We'll later update the state variable with the cached value
      // Check is > since tiers are increasing order
      if (newTokenTier > currentTierCache) currentTierCache = newTokenTier;

      unchecked {
        // Increment the minted tier amount
        mintedTierAmountCache[newTokenTier]++;

        // Decrement the SmartNodes remaining
        smartNodesRemainingCache--;

        // Only count the mint fee for the amount the user has to pay for.
        if (i /* i is 0-based */ < amountToPayFor) mintFee += tierFeeCache[newTokenTier];
      }

      // Mint the nft; explicitly not using `_safeMint` to prevent re-entrancy issues
      _mint(msg.sender, tokenIdsMinted[i]);

      // Store the SmartNode
      smartNodes[tokenIdsMinted[i]] = SmartNode(newTokenTier, currentTimestamp);
    }

    // ---------------------------------------------------------------------------------------------

    //
    //
    //
    //  Update the state variables in storage
    // ---------------------------------------------------------------------------------------------

    // If during the for loop that mints the SmartNodes, the following condition was met:
    // ```
    // uint16 newTokenTier = _getTier(...);
    // if (newTokenTier > currentTierCache) currentTierCache = newTokenTier;
    // ```
    //
    // Means there was a change in the current tier, so update the state variables accordingly
    // considering the previous tier.
    if (currentTierCache != initialCurrentTierCache) {
      //
      // In case the for loop that mints the SmartNodes went through more than one tier, update the state variables
      // accordingly.
      //
      // Start from the initial tier and go through all the tiers that the loop went through
      for (uint16 i = initialCurrentTierCache; i <= currentTierCache; i++) {
        //
        // If there was a change in the current tier, update the minted tier amount and the current tier
        mintedTierAmount[i] = mintedTierAmountCache[i];

        // If there was a change in the current tier, update the tier supply
        tierSupply[i] = tierSupplyCache[i];
      }

      // Update the current tier
      currentTier = currentTierCache;
    }
    // If there wasn't a change in the current tier, only update the minted tier amount
    else {
      mintedTierAmount[currentTierCache] = mintedTierAmountCache[currentTierCache];
    }

    // Update the token Id counter
    tokenIdCounter = tokenIdCounterCache;

    // Update the SmartNodes remaining
    smartNodesRemaining = smartNodesRemainingCache;

    // Increment the smart nodes minted for the user
    userToMintedAmount[msg.sender] += amountToMint;

    // ---------------------------------------------------------------------------------------------

    //
    //
    //
    //  Send the fee to the fees receiver
    // ---------------------------------------------------------------------------------------------

    // Convert the mint fee (USD) to the native network currency (ETH) and compare it with the msg.value
    uint128 expectedFee = _convertToEther(mintFee);

    if (msg.value != expectedFee) Errors.IncorrectFee.selector.revertWith();

    _sendFee(expectedFee);

    // ---------------------------------------------------------------------------------------------

    emit Minted(msg.sender, tokenIdsMinted, bonusSmartNodes, mintFee);
  }

  /*//////////////////////////////////////////////////////////////
                GETTERS
  //////////////////////////////////////////////////////////////*/

  /// @notice Get the SmartNode data for a given token Id.
  /// @param tokenId The token Id to get the SmartNode data for.
  function getSmartNode(uint16 tokenId) external view returns (uint16 tier, uint128 blockTs) {
    _requireMinted(tokenId);

    SmartNode memory smartNode = smartNodes[tokenId];
    tier = smartNode.tier;
    blockTs = smartNode.blockTs;
  }

  /// @notice Get the remaining free smart nodes for a given user.
  /// @param user The user to get the remaining free smart nodes for.
  function getRemainingFreeSmartNodes(address user) external view returns (uint16) {
    return userToFreeSmartNodes[user];
  }

  /// @notice Get the total amount of smart nodes minted for a given user.
  /// @param user The user to get the total amount of smart nodes minted for.
  function getTotalMintedSmartNodes(address user) external view returns (uint16) {
    return userToMintedAmount[user];
  }

  /// @notice Get the tier availability period timestamp for a given tier.
  /// @param tierId The tier ID to get the availability period timestamp for.
  function getTierAvailabilityPeriodTimestamp(uint16 tierId) external view returns (uint40) {
    return tierAvailabilityPeriodTimestamps[tierId];
  }

  /// @notice Get the minted tier amounts so far.
  /// @param tierId The tier ID to get the minted amount for.
  function getMintedTierAmount(uint16 tierId) external view returns (uint16) {
    return mintedTierAmount[tierId];
  }

  /// @notice Get the tier supplies so far.
  /// @param tierId The tier ID to get the supply for.
  function getTierSupply(uint16 tierId) external view returns (uint16) {
    return tierSupply[tierId];
  }

  /// @notice Get the initial tier supply.
  /// @param tierId The tier ID to get the initial supply for.
  function getInitialTierSupply(uint16 tierId) external view returns (uint16) {
    return tierMaxSupply[tierId];
  }

  /// @notice Get the tier fees.
  /// @param tierId The tier ID to get the fee for.
  function getTierFee(uint16 tierId) external view returns (uint128) {
    return tierFee[tierId];
  }

  /// @notice Get the current tier.
  function getCurrentTier() external view returns (uint16) {
    return currentTier;
  }

  /// @notice Get the launch timestamp.
  function getLaunchTimestamp() external view returns (uint40) {
    return launchTimestamp;
  }

  /// @notice Get the eth price in USD that is being used to calculate the mint fees.
  function getConversionUSDPrice() external view returns (uint128) {
    return conversionUSDPrice;
  }

  /// @notice Get the mint fees receiver address.
  function getFeesReceiverAddress() external view returns (address) {
    return feesReceiverAddress;
  }

  /// @notice Calculates the next mint fee given the amount.
  /// @param amountRequested The amount of tokens to mint.
  function calculateMintFee(uint16 amountRequested) external view returns (uint128 mintFee) {
    // [Gas] Current tier
    uint16 currentTierCache = currentTier;

    // [Gas] Cache the minted tier amounts
    uint16[TIER_IDS_ARRAY_LEN] memory mintedTierAmountsCache = mintedTierAmount;

    // [Gas] Cache the tier supplies
    uint16[TIER_IDS_ARRAY_LEN] memory tierSupplyCache = tierSupply;

    // [Gas] Cache the tier availability period timestamps
    uint40[TIER_IDS_ARRAY_LEN] memory tierAvailabilityPeriodTimestampsCache = tierAvailabilityPeriodTimestamps;

    // Get the user's free smart nodes
    uint16 userFreeSmartNodesCache = userToFreeSmartNodes[msg.sender];

    // Calculate the amount to pay for and the updated user's free smart nodes
    (uint16 amountToPayFor,) = _calculateAmountToPayFor(amountRequested, userFreeSmartNodesCache);

    // Calculate the mint fee for the amount of tokens to mint
    for (uint16 i; i < amountRequested; i++) {
      uint16 tier = _getTier(
        currentTierCache,
        uint40(block.timestamp),
        tierSupplyCache,
        mintedTierAmountsCache,
        tierAvailabilityPeriodTimestampsCache
      );

      mintedTierAmountsCache[tier]++;

      // Only count the mint fee for the amount the user has to pay for.
      if (i /* i is 0-based */ < amountToPayFor) mintFee += tierFee[tier];

      currentTierCache = tier;
    }

    mintFee = _convertToEther(mintFee);
  }

  /// @notice [Public View] Returns the tokenURI for a given tokenId
  /// @param tokenId The tokenId to get the tokenURI for
  function tokenURI(uint256 tokenId) public view override returns (string memory tokenURI_) {
    _requireMinted(tokenId);
    if (bytes(_assetURI).length > 0) tokenURI_ = string(abi.encodePacked(bytes(_assetURI)));
    else tokenURI_ = string(abi.encodePacked(bytes(_baseTokenURI), Strings.toString(tokenId), ".json"));
  }

  /// @notice [Public View] OpenSea URL for the storefront-level metadata for the contract.
  function contractURI() public view returns (string memory contractURI_) {
    contractURI_ = string(abi.encodePacked(bytes(_contractURI)));
  }

  /*//////////////////////////////////////////////////////////////
                UTILS
  //////////////////////////////////////////////////////////////*/

  /// @notice Calculates the amount of ETH for a given amount in USD
  /// @param amountUSD The amount in USD
  /// @return amountEth The amount in ETH (wei units)
  function _convertToEther(uint128 amountUSD) internal view returns (uint128 amountEth) {
    // 1 ether = conversionUSDPrice
    uint128 oneEthInUSD = 1 ether / conversionUSDPrice;

    // amountUSD * oneEthInUSD = amountEth
    amountEth = amountUSD * oneEthInUSD;
  }

  /// @notice Calculates the amount to pay for a given amount to mint and free smart nodes.
  /// @param amountRequested The amount of tokens to mint.
  /// @param userFreeSmartNodes The number of free smart nodes the user has.
  function _calculateAmountToPayFor(
    uint16 amountRequested,
    uint16 userFreeSmartNodesCache
  )
    internal
    pure
    returns (uint16 amountToPayFor, uint16 userFreeSmartNodes)
  {
    // Cache the user's free smart nodes and return the updated free smart nodes after the amount to pay for is
    // calculated.
    userFreeSmartNodes = userFreeSmartNodesCache;

    // Amount of smart nodes that the user will have to pay for.
    // Starts with the amount requested, then will be reduced by the user's free smart nodes.
    amountToPayFor = amountRequested;

    // If the user has free smart nodes, let's update the amount to pay for
    if (userFreeSmartNodes > 0) {
      //
      // If the user has enough free smart nodes to cover the amount requested
      if (userFreeSmartNodes >= amountRequested) {
        //
        // Update the amount to pay for will be 0, since the user has enough free smart nodes to cover the amount
        // requested
        amountToPayFor = 0;

        // Update the user's free smart nodes remaining
        userFreeSmartNodes -= amountRequested;
      }
      //
      // Else if the user has less free smart nodes than the amount requested
      else {
        //
        // Update the amount the user has to pay for by subtracting the user's free smart nodes
        amountToPayFor -= userFreeSmartNodes;

        // Reset the user's free smart nodes to 0
        userFreeSmartNodes = 0;
      }
    }
  }

  /// @notice Calculates the bonus smart nodes for a given amount to mint and bonus criteria.
  /// @param amountRequested The amount of tokens to mint.
  /// @param bonusCriteria The bonus criteria.
  function _countBonusSmartNodes(
    uint16 amountRequested,
    uint16 bonusCriteria
  )
    internal
    pure
    returns (uint16 bonusSmartNodes)
  {
    //
    //
    //
    //  Bonus Criteria Checks
    //
    //  Bonus are granted based on the amount to mint. Per transaction.
    // ---------------------------------------------------------------------------------------------

    if (bonusCriteria != 1 && bonusCriteria != 2) Errors.InvalidBonusCriteria.selector.revertWith();

    // If bonus criteria is 1:
    //
    // if "amountRequested" is >= 3 but < 6, bonus smart nodes is 1
    // if "amountRequested" is >= 6 but < 9, bonus smart nodes is 2
    // if "amountRequested" is >= 9, bonus smart nodes is 3
    if (bonusCriteria == 1) {
      if (amountRequested >= 3 && amountRequested < 6) bonusSmartNodes = 1;
      else if (amountRequested >= 6 && amountRequested < 9) bonusSmartNodes = 2;
      else if (amountRequested >= 9) bonusSmartNodes = 3;
    }
    // If bonus criteria is 2:
    //
    // if "amountRequested" is >= 4 but < 8, bonus smart nodes is 2
    // if "amountRequested" is >= 8, bonus smart nodes is 4
    else if (bonusCriteria == 2) {
      if (amountRequested >= 4 && amountRequested < 8) bonusSmartNodes = 2;
      else if (amountRequested >= 8) bonusSmartNodes = 4;
    }

    // ---------------------------------------------------------------------------------------------
  }

  /// @notice Determines the appropriate tier for the next mint based on availability and supply.
  /// @dev
  ///     The function uses a First-In-First-Out (FIFO) strategy to assign tokens to tiers. It starts from
  ///     the current cached tier and checks each subsequent tier for availability. It ensures that:
  ///     - The tier is not fully minted.
  ///     - The tier has not surpassed its maximum availability period (age in days).
  ///
  ///     The function updates the tier supply cache with the remaining supply of the current tier, so the next
  ///     iteration of this loop will use the updated supply.
  ///
  /// @param currentTierCache The current tier from which to start checking availability.
  /// @param timestampCache The current timestamp.
  /// @param tierSupplyCache Cached array containing the supply for each tier.
  /// @param mintedTierAmountsCache Cached array containing the number of minted tokens for each tier.
  /// @param tierAvailabilityPeriodTimestampsCache Cached array containing the availability period timestamps for each
  /// tier.
  /// @return Returns the tier ID that is available for minting.
  ///
  /// @dev The function loops through the available tiers, starting from the current tier, and ensures
  ///      that it doesn't select a tier that is either fully minted or whose availability period has ended.
  function _getTier(
    uint16 currentTierCache,
    uint40 timestampCache,
    uint16[TIER_IDS_ARRAY_LEN] memory tierSupplyCache,
    uint16[TIER_IDS_ARRAY_LEN] memory mintedTierAmountsCache,
    uint40[TIER_IDS_ARRAY_LEN] memory tierAvailabilityPeriodTimestampsCache
  )
    internal
    pure
    returns (uint16)
  {
    // Iterate through each tier, starting from the current cached tier.
    for (uint16 tier = currentTierCache; tier <= TIER_IDS_LENGTH; tier++) {
      // Check if the tier has available supply left, by comparing the tier supply (left) with
      // the tier amounts minted (right).
      bool tierHasSupplyRemaining = tierSupplyCache[tier] > mintedTierAmountsCache[tier];

      // Regardles of the availability period, if the tier has no supply remaining, continue to the next tier.
      if (!tierHasSupplyRemaining) continue;

      // ---------------------------------------------------------------------------------------------
      // There is supply in the tier.
      // ---------------------------------------------------------------------------------------------

      // Check if the tier is still within its valid availability period (not exceeded max age).
      bool withinAvailabilityPeriod = timestampCache <= tierAvailabilityPeriodTimestampsCache[tier];

      // If it is within the availability period, return the current tier as valid for minting, since
      // there is supply remaining too.
      if (withinAvailabilityPeriod) return tier;

      // ---------------------------------------------------------------------------------------------
      // There is supply in the tier, but the availability period has ended.
      // ---------------------------------------------------------------------------------------------

      // Calculate the leftover supply in the current tier
      uint16 leftoverSupply = tierSupplyCache[tier] - mintedTierAmountsCache[tier];

      // Add the leftover supply to the next tier's supply. So the next iteration of this loop
      // will use the updated supply.
      if (tier < TIER_IDS_LENGTH) {
        tierSupplyCache[tier + 1] += leftoverSupply;
        tierSupplyCache[tier] = mintedTierAmountsCache[tier];
      }
    }

    // If no valid tier is found (i.e., all are either full or their max age has expired), revert with an error.
    Errors.NoMoreTiersAvailable.selector.revertWith();
  }

  /// @notice Send the fee to the fees receiver address.
  /// @param amount The amount to send.
  function _sendFee(uint128 amount) private {
    bool sent;
    address feesReceiver = feesReceiverAddress;
    // Use low level call to send fee to the fee receiver address
    assembly {
      sent := call(gas(), feesReceiver, amount, 0, 0, 0, 0)
    }
    if (!sent) Errors.Unauthorized.selector.revertWith();
  }

  /*//////////////////////////////////////////////////////////////
                ONLY OWNER
  //////////////////////////////////////////////////////////////*/

  /// @notice Function to update the royalties fee numerator
  /// @param receiver The address of the receiver
  /// @param feeNumerator The fee numerator
  function setDefaultRoyalty(address receiver, uint96 feeNumerator) external onlyOwner {
    _setDefaultRoyalty(receiver, feeNumerator);

    feesReceiverAddress = receiver;

    emit FeesReceiverUpdated(receiver);
  }

  /// @notice Function to update the royalties fee numerator
  /// @param tokenId The token id
  /// @param receiver The address of the receiver
  /// @param feeNumerator The fee numerator
  function setTokenRoyalty(uint256 tokenId, address receiver, uint96 feeNumerator) external onlyOwner {
    _setTokenRoyalty(tokenId, receiver, feeNumerator);

    emit TokenRoyaltyUpdated(tokenId, receiver, feeNumerator);
  }

  /// @notice Function to update the minting status
  /// @param isMintAllowed_ The minting status
  function setIsMintAllowed(bool isMintAllowed_) external onlyOwner {
    isMintAllowed = isMintAllowed_;

    emit MintAllowedUpdated(isMintAllowed_);
  }

  /// @notice Function to update the contract URI, only owner access
  /// @param __contractURI The new contract URI.
  function setContractURI(string calldata __contractURI) external onlyOwner {
    if (bytes(__contractURI).length == 0) Errors.BadRequest.selector.revertWith();

    _contractURI = __contractURI;

    emit ContractURIUpdated(__contractURI);
  }

  /// @notice Function to set the base token URI, only owner access
  function setBaseTokenURI(string calldata __baseTokenURI) external onlyOwner {
    if (bytes(__baseTokenURI).length == 0) Errors.BadRequest.selector.revertWith();

    _baseTokenURI = __baseTokenURI;

    emit BaseTokenURIUpdated(__baseTokenURI);
  }

  /// @notice Function to set the asset URI, only owner access
  function setAssetURI(string calldata __assetURI) external onlyOwner {
    _assetURI = __assetURI;

    emit AssetURIUpdated(__assetURI);
  }

  /// @notice Function to modify mint fees
  /// @param tierId The tier ID to set the fee for
  /// @param fee The fee to set for the given tier ID
  function setTierFee(uint16 tierId, uint128 fee) external onlyOwner {
    tierFee[tierId] = fee;

    emit TierFeeUpdated(tierId, fee);
  }

  /// @notice Function to modify conversion USD price
  /// @param conversionUSDPrice_ The new conversion USD price
  function setConversionUSDPrice(uint16 conversionUSDPrice_) external onlyOwner {
    if (conversionUSDPrice_ == 0) Errors.BadRequest.selector.revertWith();

    conversionUSDPrice = conversionUSDPrice_;

    emit ConversionUSDPriceUpdated(conversionUSDPrice_);
  }

  /// @notice Function to modify the bonus smart nodes for blue chip nfts holders
  /// @param user The user to set the bonus smart nodes for
  /// @param bonusSmartNodes The bonus smart nodes to set for the user
  function setFreeSmartNodes(address user, uint16 bonusSmartNodes) external onlyOwner {
    userToFreeSmartNodes[user] = bonusSmartNodes;

    emit FreeSmartNodesUpdated(user, bonusSmartNodes);
  }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
// https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/StorageSlot.sol

pragma solidity ^0.8.24;

/**
 * @dev Library for reading and writing primitive types to specific storage slots.
 *
 * Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
 * This library helps with reading and writing to such slots without the need for inline assembly.
 *
 * The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
 *
 * Example usage to set ERC-1967 implementation slot:
 * ```solidity
 * contract ERC1967 {
 *     // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
 *     bytes32 internal constant _IMPLEMENTATION_SLOT =
 * 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
 *
 *     function _getImplementation() internal view returns (address) {
 *         return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
 *     }
 *
 *     function _setImplementation(address newImplementation) internal {
 *         require(newImplementation.code.length > 0);
 *         StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
 *     }
 * }
 * ```
 *
 * Since version 5.1, this library also support writing and reading value types to and from transient storage.
 *
 *  * Example using transient storage:
 * ```solidity
 * contract Lock {
 *     // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
 *     bytes32 internal constant _LOCK_SLOT = 0xf4678858b2b588224636b8522b729e7722d32fc491da849ed75b3fdf3c84f542;
 *
 *     modifier locked() {
 *         require(!_LOCK_SLOT.asBoolean().tload());
 *
 *         _LOCK_SLOT.asBoolean().tstore(true);
 *         _;
 *         _LOCK_SLOT.asBoolean().tstore(false);
 *     }
 * }
 * ```
 *
 * TIP: Consider using this library along with {SlotDerivation}.
 */
library StorageSlot {
  struct AddressSlot {
    address value;
  }

  struct BooleanSlot {
    bool value;
  }

  struct Bytes32Slot {
    bytes32 value;
  }

  struct Uint256Slot {
    uint256 value;
  }

  struct Int256Slot {
    int256 value;
  }

  struct StringSlot {
    string value;
  }

  struct BytesSlot {
    bytes value;
  }

  /**
   * @dev Returns an `AddressSlot` with member `value` located at `slot`.
   */
  function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := slot
    }
  }

  /**
   * @dev Returns an `BooleanSlot` with member `value` located at `slot`.
   */
  function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := slot
    }
  }

  /**
   * @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
   */
  function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := slot
    }
  }

  /**
   * @dev Returns an `Uint256Slot` with member `value` located at `slot`.
   */
  function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := slot
    }
  }

  /**
   * @dev Returns an `Int256Slot` with member `value` located at `slot`.
   */
  function getInt256Slot(bytes32 slot) internal pure returns (Int256Slot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := slot
    }
  }

  /**
   * @dev Returns an `StringSlot` with member `value` located at `slot`.
   */
  function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := slot
    }
  }

  /**
   * @dev Returns an `StringSlot` representation of the string storage pointer `store`.
   */
  function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := store.slot
    }
  }

  /**
   * @dev Returns an `BytesSlot` with member `value` located at `slot`.
   */
  function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := slot
    }
  }

  /**
   * @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
   */
  function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
    /// @solidity memory-safe-assembly
    assembly {
      r.slot := store.slot
    }
  }

  /**
   * @dev UDVT that represent a slot holding a address.
   */
  type AddressSlotType is bytes32;

  /**
   * @dev Cast an arbitrary slot to a AddressSlotType.
   */
  function asAddress(bytes32 slot) internal pure returns (AddressSlotType) {
    return AddressSlotType.wrap(slot);
  }

  /**
   * @dev UDVT that represent a slot holding a bool.
   */
  type BooleanSlotType is bytes32;

  /**
   * @dev Cast an arbitrary slot to a BooleanSlotType.
   */
  function asBoolean(bytes32 slot) internal pure returns (BooleanSlotType) {
    return BooleanSlotType.wrap(slot);
  }

  /**
   * @dev UDVT that represent a slot holding a bytes32.
   */
  type Bytes32SlotType is bytes32;

  /**
   * @dev Cast an arbitrary slot to a Bytes32SlotType.
   */
  function asBytes32(bytes32 slot) internal pure returns (Bytes32SlotType) {
    return Bytes32SlotType.wrap(slot);
  }

  /**
   * @dev UDVT that represent a slot holding a uint256.
   */
  type Uint256SlotType is bytes32;

  /**
   * @dev Cast an arbitrary slot to a Uint256SlotType.
   */
  function asUint256(bytes32 slot) internal pure returns (Uint256SlotType) {
    return Uint256SlotType.wrap(slot);
  }

  /**
   * @dev UDVT that represent a slot holding a int256.
   */
  type Int256SlotType is bytes32;

  /**
   * @dev Cast an arbitrary slot to a Int256SlotType.
   */
  function asInt256(bytes32 slot) internal pure returns (Int256SlotType) {
    return Int256SlotType.wrap(slot);
  }

  /**
   * @dev Load the value held at location `slot` in transient storage.
   */
  function tload(AddressSlotType slot) internal view returns (address value) {
    /// @solidity memory-safe-assembly
    assembly {
      value := tload(slot)
    }
  }

  /**
   * @dev Store `value` at location `slot` in transient storage.
   */
  function tstore(AddressSlotType slot, address value) internal {
    /// @solidity memory-safe-assembly
    assembly {
      tstore(slot, value)
    }
  }

  /**
   * @dev Load the value held at location `slot` in transient storage.
   */
  function tload(BooleanSlotType slot) internal view returns (bool value) {
    /// @solidity memory-safe-assembly
    assembly {
      value := tload(slot)
    }
  }

  /**
   * @dev Store `value` at location `slot` in transient storage.
   */
  function tstore(BooleanSlotType slot, bool value) internal {
    /// @solidity memory-safe-assembly
    assembly {
      tstore(slot, value)
    }
  }

  /**
   * @dev Load the value held at location `slot` in transient storage.
   */
  function tload(Bytes32SlotType slot) internal view returns (bytes32 value) {
    /// @solidity memory-safe-assembly
    assembly {
      value := tload(slot)
    }
  }

  /**
   * @dev Store `value` at location `slot` in transient storage.
   */
  function tstore(Bytes32SlotType slot, bytes32 value) internal {
    /// @solidity memory-safe-assembly
    assembly {
      tstore(slot, value)
    }
  }

  /**
   * @dev Load the value held at location `slot` in transient storage.
   */
  function tload(Uint256SlotType slot) internal view returns (uint256 value) {
    /// @solidity memory-safe-assembly
    assembly {
      value := tload(slot)
    }
  }

  /**
   * @dev Store `value` at location `slot` in transient storage.
   */
  function tstore(Uint256SlotType slot, uint256 value) internal {
    /// @solidity memory-safe-assembly
    assembly {
      tstore(slot, value)
    }
  }

  /**
   * @dev Load the value held at location `slot` in transient storage.
   */
  function tload(Int256SlotType slot) internal view returns (int256 value) {
    /// @solidity memory-safe-assembly
    assembly {
      value := tload(slot)
    }
  }

  /**
   * @dev Store `value` at location `slot` in transient storage.
   */
  function tstore(Int256SlotType slot, int256 value) internal {
    /// @solidity memory-safe-assembly
    assembly {
      tstore(slot, value)
    }
  }
}

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

pragma solidity ^0.8.0;

import "./math/Math.sol";

/**
 * @dev String operations.
 */
library Strings {
    bytes16 private constant _SYMBOLS = "0123456789abcdef";
    uint8 private constant _ADDRESS_LENGTH = 20;

    /**
     * @dev Converts a `uint256` to its ASCII `string` decimal representation.
     */
    function toString(uint256 value) internal pure returns (string memory) {
        unchecked {
            uint256 length = Math.log10(value) + 1;
            string memory buffer = new string(length);
            uint256 ptr;
            /// @solidity memory-safe-assembly
            assembly {
                ptr := add(buffer, add(32, length))
            }
            while (true) {
                ptr--;
                /// @solidity memory-safe-assembly
                assembly {
                    mstore8(ptr, byte(mod(value, 10), _SYMBOLS))
                }
                value /= 10;
                if (value == 0) break;
            }
            return buffer;
        }
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
     */
    function toHexString(uint256 value) internal pure returns (string memory) {
        unchecked {
            return toHexString(value, Math.log256(value) + 1);
        }
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
     */
    function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
        bytes memory buffer = new bytes(2 * length + 2);
        buffer[0] = "0";
        buffer[1] = "x";
        for (uint256 i = 2 * length + 1; i > 1; --i) {
            buffer[i] = _SYMBOLS[value & 0xf];
            value >>= 4;
        }
        require(value == 0, "Strings: hex length insufficient");
        return string(buffer);
    }

    /**
     * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
     */
    function toHexString(address addr) internal pure returns (string memory) {
        return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
    }
}

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;

import "@openzeppelin/contracts/utils/Context.sol";

/**
 * @title TransferValidation
 * @author Limit Break, Inc.
 * @notice A mix-in that can be combined with ERC-721 contracts to provide more granular hooks.
 * Openzeppelin's ERC721 contract only provides hooks for before and after transfer.  This allows
 * developers to validate or customize transfers within the context of a mint, a burn, or a transfer.
 */
abstract contract TransferValidation is Context {
    
    /// @dev Thrown when the from and to address are both the zero address.
    error ShouldNotMintToBurnAddress();

    /*************************************************************************/
    /*                      Transfers Without Amounts                        */
    /*************************************************************************/

    /// @dev Inheriting contracts should call this function in the _beforeTokenTransfer function to get more granular hooks.
    function _validateBeforeTransfer(address from, address to, uint256 tokenId) internal virtual {
        bool fromZeroAddress = from == address(0);
        bool toZeroAddress = to == address(0);

        if(fromZeroAddress && toZeroAddress) {
            revert ShouldNotMintToBurnAddress();
        } else if(fromZeroAddress) {
            _preValidateMint(_msgSender(), to, tokenId, msg.value);
        } else if(toZeroAddress) {
            _preValidateBurn(_msgSender(), from, tokenId, msg.value);
        } else {
            _preValidateTransfer(_msgSender(), from, to, tokenId, msg.value);
        }
    }

    /// @dev Inheriting contracts should call this function in the _afterTokenTransfer function to get more granular hooks.
    function _validateAfterTransfer(address from, address to, uint256 tokenId) internal virtual {
        bool fromZeroAddress = from == address(0);
        bool toZeroAddress = to == address(0);

        if(fromZeroAddress && toZeroAddress) {
            revert ShouldNotMintToBurnAddress();
        } else if(fromZeroAddress) {
            _postValidateMint(_msgSender(), to, tokenId, msg.value);
        } else if(toZeroAddress) {
            _postValidateBurn(_msgSender(), from, tokenId, msg.value);
        } else {
            _postValidateTransfer(_msgSender(), from, to, tokenId, msg.value);
        }
    }

    /// @dev Optional validation hook that fires before a mint
    function _preValidateMint(address caller, address to, uint256 tokenId, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires after a mint
    function _postValidateMint(address caller, address to, uint256 tokenId, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires before a burn
    function _preValidateBurn(address caller, address from, uint256 tokenId, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires after a burn
    function _postValidateBurn(address caller, address from, uint256 tokenId, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires before a transfer
    function _preValidateTransfer(address caller, address from, address to, uint256 tokenId, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires after a transfer
    function _postValidateTransfer(address caller, address from, address to, uint256 tokenId, uint256 value) internal virtual {}

    /*************************************************************************/
    /*                         Transfers With Amounts                        */
    /*************************************************************************/

    /// @dev Inheriting contracts should call this function in the _beforeTokenTransfer function to get more granular hooks.
    function _validateBeforeTransfer(address from, address to, uint256 tokenId, uint256 amount) internal virtual {
        bool fromZeroAddress = from == address(0);
        bool toZeroAddress = to == address(0);

        if(fromZeroAddress && toZeroAddress) {
            revert ShouldNotMintToBurnAddress();
        } else if(fromZeroAddress) {
            _preValidateMint(_msgSender(), to, tokenId, amount, msg.value);
        } else if(toZeroAddress) {
            _preValidateBurn(_msgSender(), from, tokenId, amount, msg.value);
        } else {
            _preValidateTransfer(_msgSender(), from, to, tokenId, amount, msg.value);
        }
    }

    /// @dev Inheriting contracts should call this function in the _afterTokenTransfer function to get more granular hooks.
    function _validateAfterTransfer(address from, address to, uint256 tokenId, uint256 amount) internal virtual {
        bool fromZeroAddress = from == address(0);
        bool toZeroAddress = to == address(0);

        if(fromZeroAddress && toZeroAddress) {
            revert ShouldNotMintToBurnAddress();
        } else if(fromZeroAddress) {
            _postValidateMint(_msgSender(), to, tokenId, amount, msg.value);
        } else if(toZeroAddress) {
            _postValidateBurn(_msgSender(), from, tokenId, amount, msg.value);
        } else {
            _postValidateTransfer(_msgSender(), from, to, tokenId, amount, msg.value);
        }
    }

    /// @dev Optional validation hook that fires before a mint
    function _preValidateMint(address caller, address to, uint256 tokenId, uint256 amount, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires after a mint
    function _postValidateMint(address caller, address to, uint256 tokenId, uint256 amount, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires before a burn
    function _preValidateBurn(address caller, address from, uint256 tokenId, uint256 amount, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires after a burn
    function _postValidateBurn(address caller, address from, uint256 tokenId, uint256 amount, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires before a transfer
    function _preValidateTransfer(address caller, address from, address to, uint256 tokenId, uint256 amount, uint256 value) internal virtual {}

    /// @dev Optional validation hook that fires after a transfer
    function _postValidateTransfer(address caller, address from, address to, uint256 tokenId, uint256 amount, uint256 value) internal virtual {}
}

{
  "compilationTarget": {
    "src/SmartNodes.sol": "SmartNodes"
  },
  "evmVersion": "cancun",
  "libraries": {},
  "metadata": {
    "bytecodeHash": "ipfs"
  },
  "optimizer": {
    "enabled": true,
    "runs": 10000
  },
  "remappings": [
    ":@chimera/=lib/chimera/src/",
    ":@limitbreak/creator-token-standards/=lib/creator-token-standards/",
    ":@limitbreak/permit-c/=lib/creator-token-standards/lib/PermitC/src/",
    ":@opensea/tstorish/=lib/creator-token-standards/lib/tstorish/src/",
    ":@openzeppelin/=lib/creator-token-standards/lib/openzeppelin-contracts/",
    ":@prb/test/=lib/prb-test/src/",
    ":@rari-capital/solmate/=lib/creator-token-standards/lib/PermitC/lib/solmate/",
    ":ERC721A/=lib/creator-token-standards/lib/ERC721A/contracts/",
    ":PermitC/=lib/creator-token-standards/lib/PermitC/",
    ":chainlink/=lib/chainlink/",
    ":chimera/=lib/chimera/src/",
    ":creator-token-standards/=lib/creator-token-standards/",
    ":ds-test/=lib/forge-std/lib/ds-test/src/",
    ":erc4626-tests/=lib/creator-token-standards/lib/PermitC/lib/openzeppelin-contracts/lib/erc4626-tests/",
    ":erc721a/=lib/creator-token-standards/lib/ERC721A/",
    ":forge-gas-metering/=lib/creator-token-standards/lib/PermitC/lib/forge-gas-metering/",
    ":forge-std/=lib/forge-std/src/",
    ":murky/=lib/creator-token-standards/lib/murky/",
    ":openzeppelin-contracts/=lib/creator-token-standards/lib/openzeppelin-contracts/",
    ":openzeppelin/=lib/creator-token-standards/lib/PermitC/lib/openzeppelin-contracts/contracts/",
    ":prb-test/=lib/prb-test/src/",
    ":script/=script/",
    ":solady/=lib/creator-token-standards/lib/PermitC/lib/forge-gas-metering/lib/solady/",
    ":solmate/=lib/creator-token-standards/lib/PermitC/lib/solmate/src/",
    ":src/=src/",
    ":test/=test/",
    ":tstorish/=lib/creator-token-standards/lib/tstorish/src/"
  ],
  "viaIR": true
}