Contract Source Code (Solidity Standard Json-Input format)

IDE

• Blockscan IDE
• 🤖 Code ReaderBeta

More Options

• Is this a proxy?
• Similar
• Submit Audit
• Compare

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

import {AccessControlEnumerable} from "openzeppelin-contracts/access/AccessControlEnumerable.sol";
// import {Clones} from "openzeppelin-contracts/proxy/Clones.sol";
import {ReentrancyGuard} from "openzeppelin-contracts/security/ReentrancyGuard.sol";

import {IINOFactory} from "./IINOFactory.sol";
import {IINOFactoryInternal} from "./IINOFactoryInternal.sol";
import {IHost} from "../lzApp/interfaces/IHost.sol";
import {IRestrictedWritable} from "../common/writable/restricted/IRestrictedWritable.sol";
import {IINORestricted} from "../ino/writable/restricted/IINORestricted.sol";
import {INO} from "../ino/INO.sol";
import {INOPhase} from "../ino/INOStruct.sol";

import {LzStorage} from "../lzApp/LzStorage.sol";

import {INOStorage} from "../ino/INOStorage.sol";
import {SaleStorage} from "../common/SaleStorage.sol";

/**
 * @title INOFactory
 * @notice Deploy {INO} in single transaction through {createINO}.
 */
contract INOFactory is
    IINOFactory, // 1 inherited component
    IINOFactoryInternal, // 1 inherited component
    AccessControlEnumerable, // 7 inherited component
    ReentrancyGuard // 1 inherited component
{
    /// @inheritdoc IINOFactory
    uint256 public override maxLoop = 100;

    INODetail[] internal _inoDetails;
    mapping(string => address) internal _inoNames;

    /// @inheritdoc IINOFactory
    address public override defaultINO;

    constructor() {
        _grantRole(DEFAULT_ADMIN_ROLE, _msgSender());
    }

    /// @inheritdoc IINOFactory
    function createINO(
        string calldata inoName,
        INOStorage.SetUp calldata inoSetUp,
        SaleStorage.SetUp memory saleSetUp,
        string[] calldata phaseIds,
        INOPhase[] calldata phases
    )
        external
        override
        nonReentrant
        onlyRole(DEFAULT_ADMIN_ROLE)
        returns (address ino)
    {
        (ino) = _createINO(inoName, inoSetUp, saleSetUp, phaseIds, phases);

        emit INOCreated(inoName, ino);
    }

    /// @inheritdoc IINOFactory
    function updateDefaultINO(
        address newDefaultINO
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        if (newDefaultINO == address(0))
            revert INOFactory_DefaultINO_ZeroAddr();

        emit DefaultINOUpdated(defaultINO, newDefaultINO);
        defaultINO = newDefaultINO;
    }

    /// @inheritdoc IINOFactory
    function setMaxLoop(
        uint256 newMaxLoop
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        maxLoop = newMaxLoop;
    }

    /// @inheritdoc IINOFactory
    function getInosDetails(
        uint256 from,
        uint256 to
    )
        external
        view
        override
        returns (
            INODetail[] memory inos,
            uint256 lastEvaludatedIndex,
            uint256 totalItems
        )
    {
        if (from > to) revert INOFactory_IndexesReversed();

        unchecked {
            if ((to - from) > maxLoop) to = from + maxLoop;

            inos = new INODetail[](to - from);
            for (uint256 i = from; i < to; ++i) {
                inos[i - from] = _inoDetails[i];
            }
            // loop end when i == to, but last call is _inoDetails[to - 1]
            lastEvaludatedIndex = --to;
        }

        totalItems = _inoDetails.length;
    }

    ///  @dev `saleSetUp` must be `memory` type as it is updated inside the function.
    function _createINO(
        string calldata inoName,
        INOStorage.SetUp calldata inoSetUp,
        SaleStorage.SetUp memory saleSetUp,
        string[] calldata phaseIds,
        INOPhase[] calldata phases
    ) internal returns (address ino) {
        if (address(_inoNames[inoName]) != address(0)) {
            revert INOFactory_INONameExists(inoName);
        }
        if (defaultINO == address(0)) {
            revert INOFactory_DefaultINO_NotSet();
        }

        bytes32 salt = keccak256(abi.encodePacked(_msgSender(), inoName));

        // ino = Clones.cloneDeterministic(defaultINO, salt);
        ino = address(new INO());

        _inoNames[inoName] = ino;
        _inoDetails.push(INODetail(inoName, ino, inoSetUp, saleSetUp));

        IINORestricted(ino).initialize(
            saleSetUp,
            _msgSender(),
            inoSetUp,
            phaseIds,
            phases
        );
    }
}

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

pragma solidity ^0.8.0;

import "./IAccessControlEnumerable.sol";
import "./AccessControl.sol";
import "../utils/structs/EnumerableSet.sol";

/**
 * @dev Extension of {AccessControl} that allows enumerating the members of each role.
 */
abstract contract AccessControlEnumerable is IAccessControlEnumerable, AccessControl {
    using EnumerableSet for EnumerableSet.AddressSet;

    mapping(bytes32 => EnumerableSet.AddressSet) private _roleMembers;

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

    /**
     * @dev Returns one of the accounts that have `role`. `index` must be a
     * value between 0 and {getRoleMemberCount}, non-inclusive.
     *
     * Role bearers are not sorted in any particular way, and their ordering may
     * change at any point.
     *
     * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
     * you perform all queries on the same block. See the following
     * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
     * for more information.
     */
    function getRoleMember(bytes32 role, uint256 index) public view virtual override returns (address) {
        return _roleMembers[role].at(index);
    }

    /**
     * @dev Returns the number of accounts that have `role`. Can be used
     * together with {getRoleMember} to enumerate all bearers of a role.
     */
    function getRoleMemberCount(bytes32 role) public view virtual override returns (uint256) {
        return _roleMembers[role].length();
    }

    /**
     * @dev Overload {_grantRole} to track enumerable memberships
     */
    function _grantRole(bytes32 role, address account) internal virtual override {
        super._grantRole(role, account);
        _roleMembers[role].add(account);
    }

    /**
     * @dev Overload {_revokeRole} to track enumerable memberships
     */
    function _revokeRole(bytes32 role, address account) internal virtual override {
        super._revokeRole(role, account);
        _roleMembers[role].remove(account);
    }
}

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

pragma solidity ^0.8.0;

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

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

    uint256 private _status;

    constructor() {
        _status = _NOT_ENTERED;
    }

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

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

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

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

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

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

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

import {INOStorage} from "../ino/INOStorage.sol";
import {SaleStorage} from "../common/SaleStorage.sol";

import {INOPhase} from "../ino/INOStruct.sol";

/**
 * @title IINOFactory
 * @notice Defines external and public functions for {INOFactory}.
 */
interface IINOFactory {
    /**
     * @notice Clone (minimal proxy - gas saving) and configure an {INO} with its {INOVesting} in a single
     *         transaction.
     * @dev `saleSetUp` must be `memory` type as it is updated in {_createINO}.
     *
     * @param inoName Name of the INO to create and configure.
     * @param inoSetUp Struct to initialize {INO} contract.
     * @param saleSetUp Struct to initialize {INO} contract with shared sale variables from
     *        {SaleWritableInternal}.
     * @param phaseIds Default phases/phase name to create at INO initialization.
     * @param phases Default phases/phase object to create at INO initialization.
     *
     * @return ino New cloned and configured {INO} contract.
     */
    function createINO(
        string calldata inoName,
        INOStorage.SetUp calldata inoSetUp,
        SaleStorage.SetUp memory saleSetUp,
        string[] calldata phaseIds,
        INOPhase[] calldata phases
    ) external returns (address ino);

    /**
     * @notice Update default {INO} to use in {createINO}.
     * @dev If not one of these or both not set, {createINO} will fail with:
     *      - {INOFactory_DefaultINO_NotSet} error.
     *
     * @param newDefaultINO Default {INO} to use for next {createINO} call.
     */
    function updateDefaultINO(address newDefaultINO) external;

    /// @notice Set the maxium amount of loops to be used in {getInosDetails}.
    function setMaxLoop(uint256 newMaxLoop) external;

    /**
     * @notice Get details of many {INO} by batch to index items on frontend.
     *
     * @param from Index to start reading from {_inoDetails}.
     * @param to Index to finish reading from {_inoDetails}.
     *
     * @return inos Details of {INO} requested, from `from` to `to`.
     * @return lastEvaludatedIndex Last index evaluated within the loop - should be `from`.
     * @return totalItems Total amount of {INODetail} fetched.
     */
    function getInosDetails(
        uint256 from,
        uint256 to
    )
        external
        view
        returns (
            IINOFactoryInternal.INODetail[] memory inos,
            uint256 lastEvaludatedIndex,
            uint256 totalItems
        );

    ///////////////// PUBLIC /////////////////
    /// @return return Default {INO}.
    function defaultINO() external returns (address);

    /// @return Maximum amount of loops to use per {getInosDetails} call.
    function maxLoop() external returns (uint256);
}

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

import {INOStorage} from "../ino/INOStorage.sol";
import {SaleStorage} from "../common/SaleStorage.sol";

/**
 * @title IINOFactoryInternal
 * @notice Internal interface of {INOFactory} which defines structures, events and errors.
 */
interface IINOFactoryInternal {
    /**
     * @notice Struct representing an INO cloned and created by {_createINO} function.
     *
     * @param name Name of the INO.
     * @param ino Address of the {INO} contract cloned.
     * @param inoSetUp Struct to set up newly deployed {INO}.
     * @param saleSetUp Struct to set up newly deployed {INO} with common sale variables.
     */
    struct INODetail {
        string name;
        address ino;
        INOStorage.SetUp inoSetUp;
        SaleStorage.SetUp saleSetUp;
    }

    /**
     * @notice Emitted only in {updateDefaultINO}.
     *
     * @param defaultINO Address of the old default {INO} contract.
     * @param newDefaultINO Address of the new default {INO} contract.
     */
    event DefaultINOUpdated(
        address indexed defaultINO,
        address indexed newDefaultINO
    );
    /**
     * @notice Emitted only in {createINO}.
     *
     * @param inoName Name of the INO.
     * @param ino Address of the {INO} contract cloned and initialized.
     */
    event INOCreated(string indexed inoName, address indexed ino);

    /// @notice Thrown when {defaultINO} is not set.
    error INOFactory_DefaultINO_NotSet();
    /// @notice Thrown when trying to set {defaultINO} as `address(0)` in {updateDefaultINO}.
    error INOFactory_DefaultINO_ZeroAddr();
    /// @notice Thrown when an INO with `name` has already been created.
    error INOFactory_INONameExists(string name);
    /// @notice Thrown when `from` is > `to` in {getInosDetails}.
    error INOFactory_IndexesReversed();
}

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

/**
 * @title IHost
 * @notice Defines external and public functions for {LzVestingHostChain}.
 */
interface IHost {
    /**
     * @notice Initialize {LzVestingHostChain} contract.
     * @dev Use `reinitializer(2)` as we initialize contract in 2 times:
     * 1. Common parts shared between crosschain and not crosschain IGOVesting
     *    with `initializeCrowdfunding`
     * 2. Crosschain configuration with `init`
     *
     * We could have refactor this into a single function though this would
     * prevent us from using a common method in IGOFactory to deploy IGOs and
     * IGOVesting not matter if crosschain compatible or not.
     *
     * @param lzEndpoint_ Address of the {ILayerZeroEndpoint}, see the official doc:
     * https://layerzero.gitbook.io/docs/technical-reference/mainnet/supported-chain-ids
     * @param hostChain_ Current chain id of where the {IGO} and {LzVestingHostChain} are deployed, using
     *        nomenclature LayerZero.
     * @param targetChain_ Chain id where {LzClaimRefundTargetChain} is deployed, using LayerZero nomenclature.
     */
    function init(
        address lzEndpoint_,
        uint16 hostChain_,
        uint16 targetChain_
    ) external;

    /**
     * @notice Estimate fees for a crosschain transaction by requesting LayerZero endpoint.
     *
     * @param _dstChainId Chain id where the call will be made to, using  LayerZero nomenclature.
     * @param _payload Payload to send to the destination chain - abi.encode(...).
     * @param _useZro Whether to use ZERO token for fees or native (ETH, BNB, ARB, etc...).
     * @param _adapterParams Params to send to the destination chain adapter - abi.encode(...).
     */
    function estimateFee(
        uint16 _dstChainId,
        bytes calldata _payload,
        bool _useZro,
        bytes calldata _adapterParams
    ) external view returns (uint nativeFee, uint zroFee);

    /**
     * @notice Host chain where call are made from, using LayerZero nomenclature.
     */
    function getHostChain() external view returns (uint16);

    /**
     * @notice Target chain where call are made to, using LayerZero nomenclature.
     */
    function getTargetChain() external view returns (uint16);

    ///////////////// PUBLIC /////////////////
    /**
     * @notice Update vesting from crosschain call of {LzClaimRefundTargetChain} contract.
     * @dev Send a call back to target chain to release the right amount of tokens to `_wallet`. Only
     *      LayerZero endpoint can call this function.
     * @custom:audit The only reason this function is made public is to receive native tokens from
     *               LayerZero endpoint. This is a requirement for crosschain ping-pong calls.
     *
     * @param _wallet Address of the wallet which requested to claim their due on target chain from
     *        {LzClaimRefundTargetChain.claim}.
     */
    function hostClaimUpdate(address _wallet) external payable;
}

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

import {IGOStorage} from "../../../igo/IGOStorage.sol";
import {SaleStorage} from "../../SaleStorage.sol";

// import struct
import {Phase} from "../../SaleStruct.sol";

/**
 * @title IRestrictedWritable
 * @notice Only the owner of the contract can call these methods.
 */
interface IRestrictedWritable {
    //////////////////////////// SHARED Sale DATA ////////////////////////////
    function openSale() external;

    function pauseSale() external;

    function resumeSale() external;

    /// @dev Retrieve any ERC20 sent to the contract by mistake.
    function recoverLostERC20(address token, address to) external;

    /**
     * @notice Update the grand total of the sale.
     * @dev Expressed in {SaleStorage.SetUp.paymentToken}.
     */
    function updateGrandTotal(uint256 grandTotal_) external;

    // TODO: UX choice to make here, do we need both phase single field update and phase batch update?
    //////////////////////////// PHASE SINGLE UPDATE ////////////////////////////
    /**
     * @custom:audit phase can be opened even if it does not exists but as only the owner can update this
     * method we make the asumption that the owner will always be aware of this to save gast costs and it
     * can be paused at any time to update its data so it does not pose a security risk.
     */
    function openPhase(string calldata phaseId) external;

    function pausePhase(string calldata phaseId) external;

    function resumePhase(string calldata phaseId) external;

    function updatePhaseEndDate(
        string calldata phaseId,
        uint128 endAt
    ) external;

    /**
     * @notice Update `maxPhaseCap` which is the maximum amount of tokens that can be sold in a phase
     *         and the merkle root of a phase to update a single or multiple wallet allocation,
     *         refund fee, etc.
     * @dev `maxPhaseCap` is expressed in {SaleStorage.SetUp.paymentToken}.
     *
     * @param phaseId Identifier of the phase.
     * @param merkleRoot New merkle root to be saved for this phase.
     */
    function updatePhaseMaxCapAndMerkleRoot(
        string calldata phaseId,
        uint256 maxPhaseCap,
        bytes32 merkleRoot
    ) external;

    /**
     * @notice Update the merkle root of a phase to update a single or multiple wallet allocation,
     *         refund fee, payment token etc.
     *
     * @param phaseId Identifier of the phase.
     * @param merkleRoot New merkle root to be saved for this phase.
     */
    function updatePhaseMerkleRoot(
        string calldata phaseId,
        bytes32 merkleRoot
    ) external;

    function updatePhaseStartDate(
        string calldata phaseId,
        uint128 startAt
    ) external;
}

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

// import struct
import {Phase} from "../../../common/SaleStruct.sol";
import {INOPhase} from "../../INOStruct.sol";

// storage
import {INOStorage} from "../../INOStorage.sol";
import {SaleStorage} from "../../../common/SaleStorage.sol";

/**
 * @title IINORestricted
 * @notice Only the owner of the contract can call these methods.
 */
interface IINORestricted {
    /**
     * @notice Some projects will only do the sale through INO and will handle the NFT minting themselves.
     *         Others will do the mint and sale through INO. This function is used to deploy the NFT
     *         collection for the second case.
     * @dev Use {reinitializer(2)} as {initialize} is called first.
     *
     * @param nftToClone The address of the NFT to use as an NFT base.
     * @param data Data of the NFT collection to be deployed.
     */
    function deployNftToSell(
        address nftToClone,
        INOStorage.NFTCollectionData calldata data
    ) external returns (address collection);

    /**
     * @notice Use a single token for the whole INO (never changed once set here).
     *
     * @param saleSetUp Data of the sale to be deployed - common logic shared between IGOs and INOs.
     * @param owner Owner of the INO.
     * @param inoSetUp Data of the INO to be deployed.
     * @param phaseIds Default list of phase identifiers - can be empty array `new string[](0)`
     * @param phases Default list of phases - can be empty array `new INOPhase[](0)`
     */
    function initialize(
        SaleStorage.SetUp calldata saleSetUp,
        address owner,
        INOStorage.SetUp calldata inoSetUp,
        string[] calldata phaseIds,
        INOPhase[] calldata phases
    ) external;

    /**
     * @dev Update or create a phase with all its data.
     *
     * @param phaseId_ Identifier of phase to set or update.
     * @param phase_ Struct {INOPhase} containing INO phase's data to be saved.
     */
    function updateSetPhase(
        string calldata phaseId_,
        INOPhase calldata phase_
    ) external;

    /**
     * @dev Update or create multiple phases with all their data.
     *
     * @param phaseIdentifiers_ Array of identifiers of `phases`.
     * @param phases_ Array of struct {INOPhase} containing phases' data to be saved.
     */
    function updateSetPhases(
        string[] calldata phaseIdentifiers_,
        INOPhase[] calldata phases_
    ) external;

    function updatePhaseMaxMintAndMerkleRoot(
        string calldata phaseId,
        uint256 phaseMaxMint,
        bytes32 merkleRoot
    ) external;
}

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

import {INOWritable} from "./writable/INOWritable.sol";
import {INOReadable} from "./readable/INOReadable.sol";

/**
 * @title INO
 * @notice Initial NFT Offering contract.
 * @dev Constructor replaced by the `initialize` function in {INOWritable}.
 */
contract INO is
    INOWritable, // 21 inherited component
    INOReadable // 7 inherited components
{

}

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

import {Phase} from "../common/SaleStruct.sol";

/**
 * @notice Struct representing a free allocation and user based for a specific phase of a sale.
 *         Whitelisted addresses will mint NFTs for free.
 *
 * @param phaseId Phase identifier of the current sale.
 * @param toMint Amount of NFT to be minted.
 * @param account Wallet address of the buyer.
 */
struct FreeAllocation {
    string phaseId;
    uint256 toMint;
    address account;
}

/**
 * @notice Struct representing a phase of an INO sale.
 *
 * @param base Phase struct from {SaleStruct} shared with IGO sales.
 * @param phaseMaxMint Maximum amount of NFTs that can be minted in this phase.
 */
struct INOPhase {
    Phase base;
    uint256 phaseMaxMint;
}

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

/**
 * @title LzStorage
 * @notice Mapps the storage layout of LayerZero dependend contracts:
 *         - {LzClaimRefundTargetChain};
 *         - {LzVestingHostChain} contract;
 * @dev Diamond proxy (ERC-2535) storage style.
 */
library LzStorage {
    /**
     * @notice Struct reprensenting data required by all LayerZero calls.
     *
     * @param hostChain Chain id of where the {LzVestingHostChain} is deployed, using LayerZero's
     *        nomenclature.
     * @param targetChain Chain id of where the {LzClaimRefundTargetChain} is deployed, using
     *        LayerZero's nomenclature.
     * @param vestedToken Address of the token to release to the user in {LzClaimRefundTargetChain}.
     */
    struct LzStruct {
        uint16 hostChain;
        uint16 targetChain;
        address vestedToken;
    }

    /// @notice Storage position of {LzStorage} in contracts using it.
    bytes32 public constant LZ_STORAGE = keccak256("lz.storage");

    /**
     * @notice Custom selector to clone and configure {LzClaimRefundTargetChain}.
     * @dev `_crosschainCloneClaim` does not exists, though it helps to identify the
     *      methods to call in {ClaimFactory._nonblockingLzReceive}.
     */
    bytes4 public constant CROSSCHAIN_CLONE_CLAIM_SELECTOR =
        bytes4(
            keccak256(
                "_crosschainCloneClaim(string,address,address,uint16,uint16,address)"
            )
        );
    /**
     * @notice Custom selector to save cloned {LzClaimRefundTargetChain} in {IGOFactory} through
     *         crosschain call from {ClaimFactory.saveCrosschainClaimInHostFactory}.
     */
    bytes4 public constant LINK_CLAIM_TO_IGO__CALLBACK =
        bytes4(keccak256("LINK_CLAIM_TO_IGO__CALLBACK"));

    /// @dev Custom selector to update vesting schedule on host from crosschain call.
    bytes4 public constant LZ_HOSTCLAIM_SELECTOR =
        bytes4(keccak256("hostClaimUpdate(address)"));
    /// @dev Custom selector to release token to user on target chain from crosschain call.
    bytes4 public constant LZ_RELEASE_TOKEN_SELECTOR =
        bytes4(keccak256("_releaseTokenToUser(address,uint256)"));

    /// @dev Custom selector to refun tokens to user on host chain from crosschain call.
    bytes4 public constant LZ_REFUND_SELECTOR =
        bytes4(keccak256("_refundLz(string,address)"));

    /// @return lzStruct Whole storage of {LzClaimRefundTargetChain} and {LzVestingHostChain} contracts.
    function layout() internal pure returns (LzStruct storage lzStruct) {
        bytes32 position = LZ_STORAGE;
        assembly {
            lzStruct.slot := position
        }
    }
}

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

/**
 * @title INOStorage
 * @notice Mapps the storage layout of the {INO} contract.
 * @dev Diamond proxy (ERC-2535) storage style.
 */
library INOStorage {
    /**
     * @notice Struct reprensenting the main setup of the INO.
     *
     * @param paymentReceiver The address which will receive the funds from the INO.
     * @param projectWallet The address of the project issuing NFTs - transfer ownership once sale closed.
     */
    struct SetUp {
        address paymentReceiver;
        address projectWallet;
    }

    /**
     * @notice Struct reprensenting the data of the NFT collection to be deployed through INO.
     *
     * @param name The name of the NFTs to be minted during the INO.
     * @param symbol The symbol of the NFTs to be minted during the INO.
     * @param uri The base URI of the NFTs to be minted during the INO - only used for reveal on minint,
     *        otherwise the uri will be an empty string (blackbox and reveal date cases).
     * @param maxCap The maximum number of NFTs to be minted during and after (if not sold out) the INO.
     * @param startTokenId The first token id to be minted during the INO.
     */
    struct NFTCollectionData {
        string name;
        string symbol;
        string uri;
        uint256 maxCap;
        uint256 startTokenId;
    }

    /**
     * @notice Struct reprensenting the whole storage layout of the INO contract.
     *
     * @param setUp Struct reprensenting the main setup of the INO - modified by owner interactions only.
     * @param nftData Struct reprensenting the data of the NFT collection to be deployed through INO
     *                - modified by owner interactions only.
     * @param collection The address of the NFT collection to be deployed and minted through INO - modified
     *                   by owner interactions only.
     * @param phaseMaxMint Maximum number of NFTs to be minted in a specific phase - modified by owner
     *                     interactions only.
     * @param mintedInPhase Number of NFTs minted in a specific phase - modified by INO contract
     *                      interaction.
     * @param totalMinted Total number of NFTs minted in the whole INO - modified by INO contract
     *                    interaction.
     */
    struct INOStruct {
        // modified by owner interactions only
        SetUp setUp;
        NFTCollectionData nftData;
        address collection;
        mapping(string => uint256) phaseMaxMint;
        // modified by INO contract interaction
        mapping(string => uint256) mintedInPhase;
        uint256 totalMinted;
    }

    /// @notice Storage position of {INOStruct} in {INO} contract.
    bytes32 public constant INO_STORAGE = keccak256("ino.storage");

    /**
     * @return inoStruct Whole storage of {INO} contract.
     */
    function layout() internal pure returns (INOStruct storage inoStruct) {
        bytes32 position = INO_STORAGE;
        assembly {
            inoStruct.slot := position
        }
    }
}

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

// import struct
import {Status, Phase} from "./SaleStruct.sol";

/**
 * @author https://github.com/Theo6890
 * @title SaleStorage
 * @notice Mapps the storage layout of the {Sale} contract.
 * @dev Diamond proxy (ERC-2535) storage style.
 */
library SaleStorage {
    /**
     * @notice Struct reprensenting the main setup of the Sale.
     *
     * @param paymentToken Address of the default token used to reserve allocation through the Sale.
     *                     If `address(0)`, it means native token of the chain (ETH, BNB, etc...).
     * @param permit2 Official address of the {Permit2} library deployed by Uniswap.
     * @param grandTotal Maximum amount of `paymentToken` that can be raised for this Sale accross all phases.
     */
    struct SetUp {
        address paymentToken;
        address permit2;
        uint256 grandTotal;
    }

    /**
     * @notice Struct reprensenting the setup of each phase of the Sale.
     * @dev Status of the phase is the only value that can be updated by Sale contract itself due to user's
     *      interactions with the contract.
     *
     * @param ids List of all phases identifiers.
     * @param data Mapping of data of each phases.
     */
    struct Phases {
        string[] ids;
        mapping(string => Phase) data;
    }

    /**
     * @notice Struct reprensenting data of the Sale which are always updated by user's interactions with
     *         the Sale contract.
     *
     * @param status Enum representing the current status of the Sale.
     * @param summedMaxPhaseCap Sum of maximum cap of each phase, which can be lower or equal to
     *                          `SetUp.grandTotal`, expressed in {SetUp.paymentToken}.
     * @param totalRaised Total amount of paymentToken raised for this Sale,
     *                    expressed in {SetUp.paymentToken}.
     * @param raisedInPhase Amount of paymentToken raised for each phase, expressed in {SetUp.paymentToken}.
     * @param allocationReservedByIn Amount of paymentToken paid by phase by each user,
     *                               expressed in {SetUp.paymentToken}.
     */
    struct Ledger {
        Status status;
        uint256 summedMaxPhaseCap;
        uint256 totalRaised;
        mapping(string => uint256) raisedInPhase;
        mapping(address => mapping(string => uint256)) allocationReservedByIn;
    }

    /**
     * @notice Struct reprensenting the whole storage layout of the Sale contract.
     *
     * @param setUp reprensenting the main setup of the Sale.
     * @param phases reprensenting the setup of each phase of the Sale.
     * @param ledger reprensenting data of the Sale which are always updated by user's interactions with
     *        the Sale contract.
     */
    struct SaleStruct {
        SetUp setUp;
        Phases phases;
        Ledger ledger;
    }

    /// @notice Storage position of {SaleStruct} in {Sale} contract.
    bytes32 public constant Sale_STORAGE = keccak256("common.storage");

    /**
     * @return igoStruct Whole storage of {Sale} contract.
     */
    function layout() internal pure returns (SaleStruct storage igoStruct) {
        bytes32 position = Sale_STORAGE;
        assembly {
            igoStruct.slot := position
        }
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControlEnumerable.sol)

pragma solidity ^0.8.0;

import "./IAccessControl.sol";

/**
 * @dev External interface of AccessControlEnumerable declared to support ERC165 detection.
 */
interface IAccessControlEnumerable is IAccessControl {
    /**
     * @dev Returns one of the accounts that have `role`. `index` must be a
     * value between 0 and {getRoleMemberCount}, non-inclusive.
     *
     * Role bearers are not sorted in any particular way, and their ordering may
     * change at any point.
     *
     * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
     * you perform all queries on the same block. See the following
     * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
     * for more information.
     */
    function getRoleMember(bytes32 role, uint256 index) external view returns (address);

    /**
     * @dev Returns the number of accounts that have `role`. Can be used
     * together with {getRoleMember} to enumerate all bearers of a role.
     */
    function getRoleMemberCount(bytes32 role) external view returns (uint256);
}

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

pragma solidity ^0.8.0;

import "./IAccessControl.sol";
import "../utils/Context.sol";
import "../utils/Strings.sol";
import "../utils/introspection/ERC165.sol";

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

    mapping(bytes32 => RoleData) private _roles;

    bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;

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

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

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

    /**
     * @dev Revert with a standard message if `_msgSender()` is missing `role`.
     * Overriding this function changes the behavior of the {onlyRole} modifier.
     *
     * Format of the revert message is described in {_checkRole}.
     *
     * _Available since v4.6._
     */
    function _checkRole(bytes32 role) internal view virtual {
        _checkRole(role, _msgSender());
    }

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

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

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

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

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

        _revokeRole(role, account);
    }

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

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/structs/EnumerableSet.sol)
// This file was procedurally generated from scripts/generate/templates/EnumerableSet.js.

pragma solidity ^0.8.0;

/**
 * @dev Library for managing
 * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
 * types.
 *
 * Sets have the following properties:
 *
 * - Elements are added, removed, and checked for existence in constant time
 * (O(1)).
 * - Elements are enumerated in O(n). No guarantees are made on the ordering.
 *
 * ```solidity
 * contract Example {
 *     // Add the library methods
 *     using EnumerableSet for EnumerableSet.AddressSet;
 *
 *     // Declare a set state variable
 *     EnumerableSet.AddressSet private mySet;
 * }
 * ```
 *
 * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
 * and `uint256` (`UintSet`) are supported.
 *
 * [WARNING]
 * ====
 * Trying to delete such a structure from storage will likely result in data corruption, rendering the structure
 * unusable.
 * See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
 *
 * In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an
 * array of EnumerableSet.
 * ====
 */
library EnumerableSet {
    // To implement this library for multiple types with as little code
    // repetition as possible, we write it in terms of a generic Set type with
    // bytes32 values.
    // The Set implementation uses private functions, and user-facing
    // implementations (such as AddressSet) are just wrappers around the
    // underlying Set.
    // This means that we can only create new EnumerableSets for types that fit
    // in bytes32.

    struct Set {
        // Storage of set values
        bytes32[] _values;
        // Position of the value in the `values` array, plus 1 because index 0
        // means a value is not in the set.
        mapping(bytes32 => uint256) _indexes;
    }

    /**
     * @dev Add a value to a set. O(1).
     *
     * Returns true if the value was added to the set, that is if it was not
     * already present.
     */
    function _add(Set storage set, bytes32 value) private returns (bool) {
        if (!_contains(set, value)) {
            set._values.push(value);
            // The value is stored at length-1, but we add 1 to all indexes
            // and use 0 as a sentinel value
            set._indexes[value] = set._values.length;
            return true;
        } else {
            return false;
        }
    }

    /**
     * @dev Removes a value from a set. O(1).
     *
     * Returns true if the value was removed from the set, that is if it was
     * present.
     */
    function _remove(Set storage set, bytes32 value) private returns (bool) {
        // We read and store the value's index to prevent multiple reads from the same storage slot
        uint256 valueIndex = set._indexes[value];

        if (valueIndex != 0) {
            // Equivalent to contains(set, value)
            // To delete an element from the _values array in O(1), we swap the element to delete with the last one in
            // the array, and then remove the last element (sometimes called as 'swap and pop').
            // This modifies the order of the array, as noted in {at}.

            uint256 toDeleteIndex = valueIndex - 1;
            uint256 lastIndex = set._values.length - 1;

            if (lastIndex != toDeleteIndex) {
                bytes32 lastValue = set._values[lastIndex];

                // Move the last value to the index where the value to delete is
                set._values[toDeleteIndex] = lastValue;
                // Update the index for the moved value
                set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
            }

            // Delete the slot where the moved value was stored
            set._values.pop();

            // Delete the index for the deleted slot
            delete set._indexes[value];

            return true;
        } else {
            return false;
        }
    }

    /**
     * @dev Returns true if the value is in the set. O(1).
     */
    function _contains(Set storage set, bytes32 value) private view returns (bool) {
        return set._indexes[value] != 0;
    }

    /**
     * @dev Returns the number of values on the set. O(1).
     */
    function _length(Set storage set) private view returns (uint256) {
        return set._values.length;
    }

    /**
     * @dev Returns the value stored at position `index` in the set. O(1).
     *
     * Note that there are no guarantees on the ordering of values inside the
     * array, and it may change when more values are added or removed.
     *
     * Requirements:
     *
     * - `index` must be strictly less than {length}.
     */
    function _at(Set storage set, uint256 index) private view returns (bytes32) {
        return set._values[index];
    }

    /**
     * @dev Return the entire set in an array
     *
     * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
     * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
     * this function has an unbounded cost, and using it as part of a state-changing function may render the function
     * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
     */
    function _values(Set storage set) private view returns (bytes32[] memory) {
        return set._values;
    }

    // Bytes32Set

    struct Bytes32Set {
        Set _inner;
    }

    /**
     * @dev Add a value to a set. O(1).
     *
     * Returns true if the value was added to the set, that is if it was not
     * already present.
     */
    function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
        return _add(set._inner, value);
    }

    /**
     * @dev Removes a value from a set. O(1).
     *
     * Returns true if the value was removed from the set, that is if it was
     * present.
     */
    function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
        return _remove(set._inner, value);
    }

    /**
     * @dev Returns true if the value is in the set. O(1).
     */
    function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
        return _contains(set._inner, value);
    }

    /**
     * @dev Returns the number of values in the set. O(1).
     */
    function length(Bytes32Set storage set) internal view returns (uint256) {
        return _length(set._inner);
    }

    /**
     * @dev Returns the value stored at position `index` in the set. O(1).
     *
     * Note that there are no guarantees on the ordering of values inside the
     * array, and it may change when more values are added or removed.
     *
     * Requirements:
     *
     * - `index` must be strictly less than {length}.
     */
    function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
        return _at(set._inner, index);
    }

    /**
     * @dev Return the entire set in an array
     *
     * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
     * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
     * this function has an unbounded cost, and using it as part of a state-changing function may render the function
     * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
     */
    function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
        bytes32[] memory store = _values(set._inner);
        bytes32[] memory result;

        /// @solidity memory-safe-assembly
        assembly {
            result := store
        }

        return result;
    }

    // AddressSet

    struct AddressSet {
        Set _inner;
    }

    /**
     * @dev Add a value to a set. O(1).
     *
     * Returns true if the value was added to the set, that is if it was not
     * already present.
     */
    function add(AddressSet storage set, address value) internal returns (bool) {
        return _add(set._inner, bytes32(uint256(uint160(value))));
    }

    /**
     * @dev Removes a value from a set. O(1).
     *
     * Returns true if the value was removed from the set, that is if it was
     * present.
     */
    function remove(AddressSet storage set, address value) internal returns (bool) {
        return _remove(set._inner, bytes32(uint256(uint160(value))));
    }

    /**
     * @dev Returns true if the value is in the set. O(1).
     */
    function contains(AddressSet storage set, address value) internal view returns (bool) {
        return _contains(set._inner, bytes32(uint256(uint160(value))));
    }

    /**
     * @dev Returns the number of values in the set. O(1).
     */
    function length(AddressSet storage set) internal view returns (uint256) {
        return _length(set._inner);
    }

    /**
     * @dev Returns the value stored at position `index` in the set. O(1).
     *
     * Note that there are no guarantees on the ordering of values inside the
     * array, and it may change when more values are added or removed.
     *
     * Requirements:
     *
     * - `index` must be strictly less than {length}.
     */
    function at(AddressSet storage set, uint256 index) internal view returns (address) {
        return address(uint160(uint256(_at(set._inner, index))));
    }

    /**
     * @dev Return the entire set in an array
     *
     * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
     * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
     * this function has an unbounded cost, and using it as part of a state-changing function may render the function
     * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
     */
    function values(AddressSet storage set) internal view returns (address[] memory) {
        bytes32[] memory store = _values(set._inner);
        address[] memory result;

        /// @solidity memory-safe-assembly
        assembly {
            result := store
        }

        return result;
    }

    // UintSet

    struct UintSet {
        Set _inner;
    }

    /**
     * @dev Add a value to a set. O(1).
     *
     * Returns true if the value was added to the set, that is if it was not
     * already present.
     */
    function add(UintSet storage set, uint256 value) internal returns (bool) {
        return _add(set._inner, bytes32(value));
    }

    /**
     * @dev Removes a value from a set. O(1).
     *
     * Returns true if the value was removed from the set, that is if it was
     * present.
     */
    function remove(UintSet storage set, uint256 value) internal returns (bool) {
        return _remove(set._inner, bytes32(value));
    }

    /**
     * @dev Returns true if the value is in the set. O(1).
     */
    function contains(UintSet storage set, uint256 value) internal view returns (bool) {
        return _contains(set._inner, bytes32(value));
    }

    /**
     * @dev Returns the number of values in the set. O(1).
     */
    function length(UintSet storage set) internal view returns (uint256) {
        return _length(set._inner);
    }

    /**
     * @dev Returns the value stored at position `index` in the set. O(1).
     *
     * Note that there are no guarantees on the ordering of values inside the
     * array, and it may change when more values are added or removed.
     *
     * Requirements:
     *
     * - `index` must be strictly less than {length}.
     */
    function at(UintSet storage set, uint256 index) internal view returns (uint256) {
        return uint256(_at(set._inner, index));
    }

    /**
     * @dev Return the entire set in an array
     *
     * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
     * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
     * this function has an unbounded cost, and using it as part of a state-changing function may render the function
     * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
     */
    function values(UintSet storage set) internal view returns (uint256[] memory) {
        bytes32[] memory store = _values(set._inner);
        uint256[] memory result;

        /// @solidity memory-safe-assembly
        assembly {
            result := store
        }

        return result;
    }
}

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

/**
 * @author https://github.com/Theo6890
 * @title IGOStorage
 * @notice Mapps the storage layout of the {IGO} contract.
 * @dev Diamond proxy (ERC-2535) storage style.
 */
library IGOStorage {
    /**
     * @notice Struct reprensenting the main setup of the IGO.
     *
     * @param vestingContract Address of the {IGOVesting} contract.
     * @param refundFeeDecimals Number of decimals used for {IIGOWritableInternal.Allocation.refundFee}.
     */
    struct SetUp {
        address vestingContract;
        uint256 refundFeeDecimals;
    }

    /**
     * @notice Struct reprensenting the whole storage layout of the IGO contract.
     *
     * @param setUp Struct reprensenting the main setup of the IGO.
     */
    struct IGOStruct {
        SetUp setUp;
    }

    /// @notice Storage position of {IGOStruct} in {IGO} contract.
    bytes32 public constant IGO_STORAGE = keccak256("igo.storage");

    /**
     * @return igoStruct Whole storage of {IGO} contract.
     */
    function layout() internal pure returns (IGOStruct storage igoStruct) {
        bytes32 position = IGO_STORAGE;
        assembly {
            igoStruct.slot := position
        }
    }
}

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

/**
 * @notice Shared enum representing the different status of a phase or the whole IGO.
 *
 * @custom:value NOT_STARTED IGO/Phase created but not started; allocations/buyAndMint are allowed.
 * @custom:value OPENED IGO/Phase started according to start date; allocations/buyAndMint are allowed.
 * @custom:value COMPLETED IGO/Phase everything has been sold or time has been elapsed;
 *               allocations/buyAndMint can't be reserved anymore.
 * @custom:value PAUSED IGO/Phase has been paused by the owner; allocations/buyAndMint can't be
 *               reserved until further notice.
 */
enum Status {
    NOT_STARTED,
    OPENED,
    COMPLETED,
    PAUSED
}

/**
 * @notice Struct representing an allocation of a wallet for a specific phase of a sale.
 *
 * @param phaseId Phase identifier of the in the current sale, e.g. "vpr-social-task",
 *        "sale-public-phase-1", "ino-public" etc...
 * @param maxAllocation Maximum amount to spend in {SaleStorage.SetUp.paymentToken}.
 * @param saleTokenPerPaymentToken Price per token/nft of the project behind the Sale, expressed in
 *        {SaleStorage.SetUp.paymentToken}.
 */
struct Allocation {
    string phaseId;
    uint256 maxAllocation;
    uint256 saleTokenPerPaymentToken;
}

/**
 * @notice Struct representing a buy permission signed by `msg.sender` for
 *         {SaleWritable.reserveAllocation} function to use with {Permit2} library.
 *
 * @dev Compulsory to interact with {Permit2.permitTransferFrom} in
 *      {SaleWritableInternal._reserveAllocation}.
 *
 * @param signature {Permit2} signature to transfer tokens from the buyer to {SaleVesting}.
 * @param deadline Seadline on the permit signature.
 * @param nonce Unique value for every token owner's signature to prevent signature replays.
 */
struct BuyPermission {
    bytes signature;
    uint256 deadline;
    uint256 nonce;
}

/**
 * @notice Shared struct representing the data of a phase.
 *
 * @param status Enum representing the current status of the phase.
 * @param merkleRoot Merkle root of the merkle tree containing whitelisted data.
 * @param startAt Timestamp at which the phase will be opened to reserve allocation.
 * @param endAt Timestamp at which the phase will not accept allocation reservation anymore.
 * @param maxPhaseCap Maximum amount of {SaleStorage.SetUp.paymentToken} for this phase.
 */
struct Phase {
    Status status;
    // contains wallet and allocation per wallet
    bytes32 merkleRoot;
    uint128 startAt;
    uint128 endAt;
    uint256 maxPhaseCap;
}

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

import {Clones} from "openzeppelin-contracts/proxy/Clones.sol";
import {MerkleProof} from "openzeppelin-contracts/utils/cryptography/MerkleProof.sol";

import {IINOWritable} from "./IINOWritable.sol";
import {INFT} from "../nft/interfaces/INFT.sol";

import {INOWritableInternal} from "./INOWritableInternal.sol";
import {SaleWritableInternal} from "../../common/writable/SaleWritableInternal.sol";

import {INORestricted} from "./restricted/INORestricted.sol";

import {SaleStorage} from "../../common/SaleStorage.sol";
import {INOStorage} from "../INOStorage.sol";
import {FreeAllocation} from "../INOStruct.sol";

// import struct
import {BuyPermission, Phase} from "../../common/SaleStruct.sol";
import {UserAllocationFee} from "../../common/UserAllocationStruct.sol";

/**
 * @title INO
 * @notice Initial NFT Offering contract.
 * @dev This contract is used to deploy the NFT collection to mint/sale and handle the sale.
 */
contract INOWritable is
    IINOWritable, // 1 inherited component
    INOWritableInternal, // 6 inherited components
    INORestricted // 13 inherited components
{
    function buyAndMintWithERC20(
        uint256 spendNow,
        UserAllocationFee calldata allocation,
        bytes32[] calldata proof,
        BuyPermission calldata permission
    ) external override {
        SaleStorage.SetUp memory saleSetUp = SaleStorage.layout().setUp;

        if (saleSetUp.paymentToken == address(0)) {
            revert INO_UseInstead("buyAndMintWithNative");
        }

        __mintAndUpdateStorage(spendNow, allocation, proof, saleSetUp);

        /**
         * @dev transfer selected {paymentToken} to receiver wallet via permit2
         * read from storage as there is not point to pass `setUp`s as parameters, cost a bit more BUT
         * better dev experience
         */
        _permit2ApproveAndTransfer(
            saleSetUp.permit2,
            msg.sender, // allow delegate to spend
            INOStorage.layout().setUp.paymentReceiver,
            saleSetUp.paymentToken,
            spendNow,
            permission
        );
    }

    /// @inheritdoc IINOWritable
    function buyAndMintWithNative(
        UserAllocationFee calldata allocation,
        bytes32[] calldata proof
    ) external payable override {
        uint256 spendNow = msg.value;
        SaleStorage.SetUp memory saleSetUp = SaleStorage.layout().setUp;

        if (saleSetUp.paymentToken != address(0)) {
            revert INO_UseInstead("buyAndMintWithERC20");
        }

        __mintAndUpdateStorage(spendNow, allocation, proof, saleSetUp);

        // transfer ETH to receiver wallet
        (bool ok, bytes memory data) = INOStorage
            .layout()
            .setUp
            .paymentReceiver
            .call{value: msg.value}(""); // delegate can also spend on behalf of the user
        if (!ok) {
            revert INO_NativePaymentFailed(data);
        }
    }

    function freeMint(
        FreeAllocation calldata allocation,
        bytes32[] calldata proof
    ) external override {
        __checkFreeMintParams(allocation, proof);

        _updateMintedAmount(allocation.phaseId, allocation.toMint);

        INFT(INOStorage.layout().collection).mint(
            msg.sender,
            allocation.toMint
        );
    }

    function __checkBuyAndMintParams(
        uint256 toMint,
        uint256 reserveNow,
        UserAllocationFee calldata allocation,
        uint256 grandTotal,
        uint256 maxPhaseCap,
        bytes32[] calldata proof
    ) private {
        _checkMaxMintInPhase(allocation.usrData.base.phaseId, toMint);
        _checkMaxMintWholeINO(toMint);

        _checkBuyReserveParams(
            reserveNow,
            allocation,
            allocation.usrData.base.phaseId,
            grandTotal,
            maxPhaseCap,
            proof
        );
    }

    function __checkFreeMintParams(
        FreeAllocation calldata allocation,
        bytes32[] calldata proof
    ) private {
        _checkMaxMintInPhase(allocation.phaseId, allocation.toMint);
        _checkMaxMintWholeINO(allocation.toMint);

        _requireOpenedSaleAndPhase(allocation.phaseId);

        __requireValidFreeAllocation(allocation, proof);
    }

    function __mintAndUpdateStorage(
        uint256 spendNow,
        UserAllocationFee calldata allocation,
        bytes32[] calldata proof,
        SaleStorage.SetUp memory saleSetUp
    ) private {
        string calldata phaseId = allocation.usrData.base.phaseId;
        Phase memory phase = SaleStorage.layout().phases.data[phaseId];
        INOStorage.SetUp memory inoSetUp = INOStorage.layout().setUp;

        uint256 unitPrice = allocation.usrData.base.saleTokenPerPaymentToken;
        /**
         * @custom:audit When backend creates the allocation, `maxAllocation` will be a multiple of
         *               `saleTokenPerPaymentToken` to avoid round down issue. In any case,
         *               the most important is that `spendNow` is a multiple of `saleTokenPerPaymentToken`.
         */
        uint256 maxAllocation = allocation.usrData.base.maxAllocation;
        uint256 bought = SaleStorage.layout().ledger.allocationReservedByIn[
            msg.sender
        ][phaseId];

        /**
         * @dev Solidity round down towards zero:
         *               - CAN NOT over-mint due to round up issue
         *               - CAN under-mint due to round down issue
         *
         * e.g.:
         * - maxAllocation = 100 ether
         * - saleTokenPerPaymentToken = 3 ether
         * user will mint 33 NFTs max, instead of 33.3333333333 NFTs.
         *
         * @dev To avoid under-mint issue, only allow a round down to happen if this transaction is the last one to mint all NFTs
         *      left allocated to the user in this phase.
         */
        // if not the last mint
        if (bought + spendNow != maxAllocation) {
            if (spendNow % unitPrice != 0) {
                revert INO_OnlyUseMultipleOf(unitPrice);
            }
        }

        uint256 toMint = spendNow / unitPrice;

        __checkBuyAndMintParams(
            toMint,
            spendNow,
            allocation,
            saleSetUp.grandTotal,
            phase.maxPhaseCap,
            proof
        );
        _updateStorageOnBuy( /// @custom:audit CEI pattern
            spendNow,
            phaseId,
            allocation.usrData.account,
            saleSetUp.grandTotal,
            phase.maxPhaseCap,
            toMint
        );

        // allow to spend on behalf of the user AND mint NFTs to the user
        INFT(INOStorage.layout().collection).mint(
            allocation.usrData.account,
            toMint
        );
    }

    /// @dev Different params from `SaleWritableInternal._requireValidAllocation` BUT same logic
    function __requireValidFreeAllocation(
        FreeAllocation calldata allocation,
        bytes32[] calldata proof
    ) private view returns (bool) {
        if (
            !MerkleProof.verify(
                proof,
                SaleStorage
                    .layout()
                    .phases
                    .data[allocation.phaseId]
                    .merkleRoot,
                keccak256(abi.encode(address(this), block.chainid, allocation))
            )
        ) revert SaleWritableInternal_AllocationNotFound();

        return true;
    }
}

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

import {SaleReadable} from "../../common/readable/SaleReadable.sol";

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

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

/**
 * @title INOReadable
 * @notice Initial NFT Offering contract.
 * @dev Constructor replaced by the `initialize` function in {INOWritable}.
 */
contract INOReadable is
    IINOReadable, // 1 inherited component
    SaleReadable // 5 inherited components
{
    function inoSetUp()
        public
        view
        override
        returns (INOStorage.SetUp memory)
    {
        return INOStorage.layout().setUp;
    }

    /// @inheritdoc IINOReadable
    function mintedInPhase(
        string calldata phaseId
    ) public view override returns (uint256) {
        return INOStorage.layout().mintedInPhase[phaseId];
    }

    /// @inheritdoc IINOReadable
    function nftCollection() public view override returns (address) {
        return INOStorage.layout().collection;
    }

    function nftCollectionData()
        public
        view
        override
        returns (INOStorage.NFTCollectionData memory)
    {
        return INOStorage.layout().nftData;
    }

    /// @inheritdoc IINOReadable
    function totalMinted() public view override returns (uint256) {
        return INOStorage.layout().totalMinted;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)

pragma solidity ^0.8.0;

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

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

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

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

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

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

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

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

// 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
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Strings.sol)

pragma solidity ^0.8.0;

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

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

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

    /**
     * @dev Converts a `int256` to its ASCII `string` decimal representation.
     */
    function toString(int256 value) internal pure returns (string memory) {
        return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMath.abs(value))));
    }

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

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

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

    /**
     * @dev Returns true if the two strings are equal.
     */
    function equal(string memory a, string memory b) internal pure returns (bool) {
        return keccak256(bytes(a)) == keccak256(bytes(b));
    }
}

// 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.8.0) (proxy/Clones.sol)

pragma solidity ^0.8.0;

/**
 * @dev https://eips.ethereum.org/EIPS/eip-1167[EIP 1167] is a standard for
 * deploying minimal proxy contracts, also known as "clones".
 *
 * > To simply and cheaply clone contract functionality in an immutable way, this standard specifies
 * > a minimal bytecode implementation that delegates all calls to a known, fixed address.
 *
 * The library includes functions to deploy a proxy using either `create` (traditional deployment) or `create2`
 * (salted deterministic deployment). It also includes functions to predict the addresses of clones deployed using the
 * deterministic method.
 *
 * _Available since v3.4._
 */
library Clones {
    /**
     * @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation`.
     *
     * This function uses the create opcode, which should never revert.
     */
    function clone(address implementation) internal returns (address instance) {
        /// @solidity memory-safe-assembly
        assembly {
            // Cleans the upper 96 bits of the `implementation` word, then packs the first 3 bytes
            // of the `implementation` address with the bytecode before the address.
            mstore(0x00, or(shr(0xe8, shl(0x60, implementation)), 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000))
            // Packs the remaining 17 bytes of `implementation` with the bytecode after the address.
            mstore(0x20, or(shl(0x78, implementation), 0x5af43d82803e903d91602b57fd5bf3))
            instance := create(0, 0x09, 0x37)
        }
        require(instance != address(0), "ERC1167: create failed");
    }

    /**
     * @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation`.
     *
     * This function uses the create2 opcode and a `salt` to deterministically deploy
     * the clone. Using the same `implementation` and `salt` multiple time will revert, since
     * the clones cannot be deployed twice at the same address.
     */
    function cloneDeterministic(address implementation, bytes32 salt) internal returns (address instance) {
        /// @solidity memory-safe-assembly
        assembly {
            // Cleans the upper 96 bits of the `implementation` word, then packs the first 3 bytes
            // of the `implementation` address with the bytecode before the address.
            mstore(0x00, or(shr(0xe8, shl(0x60, implementation)), 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000))
            // Packs the remaining 17 bytes of `implementation` with the bytecode after the address.
            mstore(0x20, or(shl(0x78, implementation), 0x5af43d82803e903d91602b57fd5bf3))
            instance := create2(0, 0x09, 0x37, salt)
        }
        require(instance != address(0), "ERC1167: create2 failed");
    }

    /**
     * @dev Computes the address of a clone deployed using {Clones-cloneDeterministic}.
     */
    function predictDeterministicAddress(
        address implementation,
        bytes32 salt,
        address deployer
    ) internal pure returns (address predicted) {
        /// @solidity memory-safe-assembly
        assembly {
            let ptr := mload(0x40)
            mstore(add(ptr, 0x38), deployer)
            mstore(add(ptr, 0x24), 0x5af43d82803e903d91602b57fd5bf3ff)
            mstore(add(ptr, 0x14), implementation)
            mstore(ptr, 0x3d602d80600a3d3981f3363d3d373d3d3d363d73)
            mstore(add(ptr, 0x58), salt)
            mstore(add(ptr, 0x78), keccak256(add(ptr, 0x0c), 0x37))
            predicted := keccak256(add(ptr, 0x43), 0x55)
        }
    }

    /**
     * @dev Computes the address of a clone deployed using {Clones-cloneDeterministic}.
     */
    function predictDeterministicAddress(
        address implementation,
        bytes32 salt
    ) internal view returns (address predicted) {
        return predictDeterministicAddress(implementation, salt, address(this));
    }
}

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

pragma solidity ^0.8.0;

/**
 * @dev These functions deal with verification of Merkle Tree proofs.
 *
 * The tree and the proofs can be generated using our
 * https://github.com/OpenZeppelin/merkle-tree[JavaScript library].
 * You will find a quickstart guide in the readme.
 *
 * WARNING: You should avoid using leaf values that are 64 bytes long prior to
 * hashing, or use a hash function other than keccak256 for hashing leaves.
 * This is because the concatenation of a sorted pair of internal nodes in
 * the merkle tree could be reinterpreted as a leaf value.
 * OpenZeppelin's JavaScript library generates merkle trees that are safe
 * against this attack out of the box.
 */
library MerkleProof {
    /**
     * @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
     * defined by `root`. For this, a `proof` must be provided, containing
     * sibling hashes on the branch from the leaf to the root of the tree. Each
     * pair of leaves and each pair of pre-images are assumed to be sorted.
     */
    function verify(bytes32[] memory proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
        return processProof(proof, leaf) == root;
    }

    /**
     * @dev Calldata version of {verify}
     *
     * _Available since v4.7._
     */
    function verifyCalldata(bytes32[] calldata proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
        return processProofCalldata(proof, leaf) == root;
    }

    /**
     * @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
     * from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
     * hash matches the root of the tree. When processing the proof, the pairs
     * of leafs & pre-images are assumed to be sorted.
     *
     * _Available since v4.4._
     */
    function processProof(bytes32[] memory proof, bytes32 leaf) internal pure returns (bytes32) {
        bytes32 computedHash = leaf;
        for (uint256 i = 0; i < proof.length; i++) {
            computedHash = _hashPair(computedHash, proof[i]);
        }
        return computedHash;
    }

    /**
     * @dev Calldata version of {processProof}
     *
     * _Available since v4.7._
     */
    function processProofCalldata(bytes32[] calldata proof, bytes32 leaf) internal pure returns (bytes32) {
        bytes32 computedHash = leaf;
        for (uint256 i = 0; i < proof.length; i++) {
            computedHash = _hashPair(computedHash, proof[i]);
        }
        return computedHash;
    }

    /**
     * @dev Returns true if the `leaves` can be simultaneously proven to be a part of a merkle tree defined by
     * `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
     *
     * CAUTION: Not all merkle trees admit multiproofs. See {processMultiProof} for details.
     *
     * _Available since v4.7._
     */
    function multiProofVerify(
        bytes32[] memory proof,
        bool[] memory proofFlags,
        bytes32 root,
        bytes32[] memory leaves
    ) internal pure returns (bool) {
        return processMultiProof(proof, proofFlags, leaves) == root;
    }

    /**
     * @dev Calldata version of {multiProofVerify}
     *
     * CAUTION: Not all merkle trees admit multiproofs. See {processMultiProof} for details.
     *
     * _Available since v4.7._
     */
    function multiProofVerifyCalldata(
        bytes32[] calldata proof,
        bool[] calldata proofFlags,
        bytes32 root,
        bytes32[] memory leaves
    ) internal pure returns (bool) {
        return processMultiProofCalldata(proof, proofFlags, leaves) == root;
    }

    /**
     * @dev Returns the root of a tree reconstructed from `leaves` and sibling nodes in `proof`. The reconstruction
     * proceeds by incrementally reconstructing all inner nodes by combining a leaf/inner node with either another
     * leaf/inner node or a proof sibling node, depending on whether each `proofFlags` item is true or false
     * respectively.
     *
     * CAUTION: Not all merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree
     * is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order they are in the
     * tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
     *
     * _Available since v4.7._
     */
    function processMultiProof(
        bytes32[] memory proof,
        bool[] memory proofFlags,
        bytes32[] memory leaves
    ) internal pure returns (bytes32 merkleRoot) {
        // This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
        // consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
        // `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
        // the merkle tree.
        uint256 leavesLen = leaves.length;
        uint256 totalHashes = proofFlags.length;

        // Check proof validity.
        require(leavesLen + proof.length - 1 == totalHashes, "MerkleProof: invalid multiproof");

        // The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
        // `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
        bytes32[] memory hashes = new bytes32[](totalHashes);
        uint256 leafPos = 0;
        uint256 hashPos = 0;
        uint256 proofPos = 0;
        // At each step, we compute the next hash using two values:
        // - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
        //   get the next hash.
        // - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
        //   `proof` array.
        for (uint256 i = 0; i < totalHashes; i++) {
            bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
            bytes32 b = proofFlags[i]
                ? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
                : proof[proofPos++];
            hashes[i] = _hashPair(a, b);
        }

        if (totalHashes > 0) {
            unchecked {
                return hashes[totalHashes - 1];
            }
        } else if (leavesLen > 0) {
            return leaves[0];
        } else {
            return proof[0];
        }
    }

    /**
     * @dev Calldata version of {processMultiProof}.
     *
     * CAUTION: Not all merkle trees admit multiproofs. See {processMultiProof} for details.
     *
     * _Available since v4.7._
     */
    function processMultiProofCalldata(
        bytes32[] calldata proof,
        bool[] calldata proofFlags,
        bytes32[] memory leaves
    ) internal pure returns (bytes32 merkleRoot) {
        // This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
        // consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
        // `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
        // the merkle tree.
        uint256 leavesLen = leaves.length;
        uint256 totalHashes = proofFlags.length;

        // Check proof validity.
        require(leavesLen + proof.length - 1 == totalHashes, "MerkleProof: invalid multiproof");

        // The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
        // `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
        bytes32[] memory hashes = new bytes32[](totalHashes);
        uint256 leafPos = 0;
        uint256 hashPos = 0;
        uint256 proofPos = 0;
        // At each step, we compute the next hash using two values:
        // - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
        //   get the next hash.
        // - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
        //   `proof` array.
        for (uint256 i = 0; i < totalHashes; i++) {
            bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
            bytes32 b = proofFlags[i]
                ? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
                : proof[proofPos++];
            hashes[i] = _hashPair(a, b);
        }

        if (totalHashes > 0) {
            unchecked {
                return hashes[totalHashes - 1];
            }
        } else if (leavesLen > 0) {
            return leaves[0];
        } else {
            return proof[0];
        }
    }

    function _hashPair(bytes32 a, bytes32 b) private pure returns (bytes32) {
        return a < b ? _efficientHash(a, b) : _efficientHash(b, a);
    }

    function _efficientHash(bytes32 a, bytes32 b) private pure returns (bytes32 value) {
        /// @solidity memory-safe-assembly
        assembly {
            mstore(0x00, a)
            mstore(0x20, b)
            value := keccak256(0x00, 0x40)
        }
    }
}

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

// import struct
import {BuyPermission} from "../../common/SaleStruct.sol";
import {UserAllocationFee} from "../../common/UserAllocationStruct.sol";
import {FreeAllocation} from "../INOStruct.sol";

/**
 * @title IINOWritable
 * @notice Defines external and public functions for {INOWritable}.
 */
interface IINOWritable {
    /**
     * @notice Buy and mint NFTs with ERC20 tokens. If {SaleStorage.SetUp.paymentToken} is not set,
     *         this function will revert and tell the user to use {buyAndMintWithNative} instead.
     *
     * @param spendNow Amount of ERC20 tokens to spend now.
     * @param allocation Allocation data of an `acount`.
     * @param proof Merkle tree proof of an `acount`'s allocation.
     * @param permission Permission data of an `acount`.
     */
    function buyAndMintWithERC20(
        uint256 spendNow,
        UserAllocationFee calldata allocation,
        bytes32[] calldata proof,
        BuyPermission calldata permission
    ) external;

    /**
     * @notice Buy and mint NFTs with blockchain's native currency (ETH, BNB, MATIC, etc...). If
     *         {SaleStorage.SetUp.paymentToken} is set, this function will revert and tell the user to use
     *         {buyAndMintWithERC20} instead.
     *
     * @param allocation Allocation data of an `acount`.
     * @param proof Merkle tree proof of an `acount`'s allocation.
     */
    function buyAndMintWithNative(
        UserAllocationFee calldata allocation,
        bytes32[] calldata proof
    ) external payable;

    /**
     * @notice Allows whitelisted addresses to mint NFTs for free/giveaways.
     *
     * @param allocation Allocation data of an `acount`.
     * @param proof Merkle tree proof of an `acount`'s allocation.
     */
    function freeMint(
        FreeAllocation calldata allocation,
        bytes32[] calldata proof
    ) external;
}

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

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

/**
 * @title INFT
 * @notice Define external and public functions used by NFTs listed in INOs.
 */
interface INFT {
    /// @dev Removes default royalty information.
    function deleteDefaultRoyalty() external;

    /**
     * @notice Initialize a clones NFT to sell & mint for an INO.
     * @dev Need to be public as childs override it while calling {super.initialize()}.
     *
     * @param data The NFT collection data.
     * @param initialOwner The initial owner of the NFT collection.
     * @param ino_ The linked INO contract address.
     */
    function initialize(
        INOStorage.NFTCollectionData calldata data,
        address initialOwner,
        address ino_
    ) external;

    /**
     * @notice Mint tokens, restricted to the INO contract.
     *
     * @dev    If the implementing token uses _safeMint(), or a feeRecipient with a malicious receive()
     *         hook is specified, the token or fee recipients may be able to execute another mint in the
     *         same transaction via a separate INO contract.
     *         This is dangerous if an implementing token does not correctly update the minterNumMinted
     *         and currentTotalSupply values before transferring minted tokens, as INO references these
     *         values to enforce token limits on a per-wallet and per-stage basis.
     *
     *         ERC721A tracks these values automatically, but this note and nonReentrant modifier are left
     *         here to encourage best-practices when referencing this contract.
     *
     * @param minter The address to mint to.
     * @param quantity The number of tokens to mint.
     */
    function mint(address minter, uint256 quantity) external;

    /**
     * @notice Mint all unsold NFTs to `receiver`.
     */
    function postmintAllUnsold(address receiver) external;

    /// @notice Mints `toMint` to `receiver` and reduces the max supply if does not mint all left.
    function postmintAndReduceSupply(
        address receiver,
        uint256 toMint
    ) external returns (uint256 reducedBy);

    /**
     * @notice Allow NFT collection owner to mint NFTs to his wallet BEFORE the INO starts. Mostly used to
     *         reward the team behind the project. Can also be used if airdrops/giveaway are introduced
     *         after the INO contract has been deployed.
     * @dev Can not be called even if INO is paused.
     */
    function premint(address receiver, uint256 amount) external;

    /**
     * @notice BE CAREFUL: once max supply is reduced it can never be increased again.
     * @dev Can only reduce the max supply between `totalSupply()` and `maxSupply()`.
     */
    function reduceSupplyTo(uint256 newMaxSupply) external;

    /// @dev Resets royalty information for the token id back to the global default.
    function resetTokenRoyalty(uint256 tokenId) external;

    /**
     * @dev Sets the royalty information that all ids in this contract will default to.
     *
     * @param receiver Address receiving royalties.
     * @param feeNumerator Royalties in basis points.
     */
    function setDefaultRoyalty(address receiver, uint96 feeNumerator) external;

    function setTokenRoyalty(
        uint256 tokenId,
        address receiver,
        uint96 feeNumerator
    ) external;

    /**
     * @notice Returns a set of mint stats for the address.
     *
     * @dev NOTE: Implementing contracts should always update these numbers before transferring any tokens
     *            with _safeMint() to mitigate consequences of malicious onERC721Received() hooks.
     *
     * @param minter The minter address.
     *
     * @return minterNumMinted The number of tokens minted by `minter`.
     * @return currentTotalSupply The current total supply of NFT.
     * @return maxSupply The maximum supply of NFT.
     */
    function getMintStats(
        address minter
    )
        external
        view
        returns (
            uint256 minterNumMinted,
            uint256 currentTotalSupply,
            uint256 maxSupply
        );
}

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

import {SaleWritableInternal} from "../../common/writable/SaleWritableInternal.sol";
import {IINOWritable} from "./IINOWritable.sol";
import {IINOWritableInternal} from "./IINOWritableInternal.sol";
import {INFT} from "../nft/interfaces/INFT.sol";

import {RestrictedWritable} from "../../common/writable/restricted/RestrictedWritable.sol";

import {SaleStorage} from "../../common/SaleStorage.sol";
import {INOStorage} from "../INOStorage.sol";

// import struct
import {Status} from "../../common/SaleStruct.sol";

/**
 * @title INO
 * @notice Initial NFT Offering contract.
 * @notice Defines internal functions for `INOWritable`.
 */
contract INOWritableInternal is
    SaleWritableInternal, // 4 inherited components
    IINOWritableInternal // 1 inherited component
{
    function _buyAndMint() internal {}

    /// @custom:audit when total raised reached, it will close the phase and/or the whole sale
    function _updateStorageOnBuy(
        uint256 toSpend,
        string calldata phaseId,
        address buyer,
        uint256 grandTotal,
        uint256 maxMintPhaseCap,
        uint256 toMint
    ) internal {
        SaleWritableInternal._updateStorageOnBuy(
            toSpend,
            phaseId,
            buyer,
            grandTotal,
            maxMintPhaseCap
        );
        _updateMintedAmount(phaseId, toMint);
    }

    /// @custom:audit NFT minted in phase and total minted do not close the phase or the whole sale
    function _updateMintedAmount(
        string calldata phaseId,
        uint256 toMint
    ) internal {
        INOStorage.layout().mintedInPhase[phaseId] += toMint;
        INOStorage.layout().totalMinted += toMint;
    }

    function _checkMaxMintInPhase(
        string calldata phaseId,
        uint256 toMint
    ) internal view {
        uint256 maxMintInPhase = INOStorage.layout().phaseMaxMint[phaseId];

        uint256 mintedInPhase = INOStorage.layout().mintedInPhase[phaseId];
        uint256 newTotal = mintedInPhase + toMint;

        if (newTotal > maxMintInPhase) {
            revert INO_MaxMintInPhaseReached(
                maxMintInPhase,
                newTotal - maxMintInPhase
            );
        }
    }

    function _checkMaxMintWholeINO(uint256 toMint) internal view {
        uint256 maxMint = INOStorage.layout().nftData.maxCap;
        uint256 minted = INOStorage.layout().totalMinted;
        uint256 newTotal = minted + toMint;

        if (newTotal > maxMint) {
            revert INO_MaxMintINOReached(maxMint, newTotal - maxMint);
        }
    }
}

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

import {ISignatureTransfer} from "permit2/interfaces/ISignatureTransfer.sol";
import {MerkleProof} from "openzeppelin-contracts/utils/cryptography/MerkleProof.sol";

import {RestrictedWritableInternal} from "./restricted/RestrictedWritableInternal.sol";
import {ISaleWritableInternal} from "./ISaleWritableInternal.sol";

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

// struct import
import {Status, Phase, BuyPermission} from "../SaleStruct.sol";
import {UserAllocationFee} from "../UserAllocationStruct.sol";

/**
 * @title SaleWritableInternal
 * @notice Defines internal functions for `SaleWritable`.
 */
contract SaleWritableInternal is
    ISaleWritableInternal, // 1 inherited component
    RestrictedWritableInternal // 2 inherited components
{
    function _checkBuyReserveParams(
        uint256 reserveNow,
        UserAllocationFee calldata allocation,
        string calldata phaseId,
        uint256 grandTotal,
        uint256 maxPhaseCap,
        bytes32[] calldata proof
    ) internal {
        _requireAllocationNotExceededInPhase(
            reserveNow,
            allocation.usrData.account,
            allocation.usrData.base.maxAllocation,
            phaseId
        );
        _requireGrandTotalNotExceeded(reserveNow, grandTotal);
        _requireOpenedSaleAndPhase(allocation.usrData.base.phaseId);
        _requirePhaseCapNotExceeded(phaseId, maxPhaseCap, reserveNow);
        _requireValidAllocation(allocation, proof);
    }

    /// @param phaseId Phase identifier to close.
    function _closePhase(string memory phaseId) internal {
        SaleStorage.layout().phases.data[phaseId].status = Status.COMPLETED;
    }

    function _closeSale() internal {
        SaleStorage.layout().ledger.status = Status.COMPLETED;
    }

    /**
     * @notice Update storage of the Sale when an allocation is reserved on-chain: total raised, total raised
     *      in phase, allocation reserved by buyer in phase, etc...
     *
     * @param amount Amount of tokens spent in this transaction, expressed in 
     *        {SaleStorage.SetUp.paymentToken}.
     * @param phaseId Phase linked to current allocation used by buyer.
     * @param buyer Wallet buying tokens.
     * @param grandTotal Total amount of tokens to be sold in this Sale, expressed in 
     *        {SaleStorage.SetUp.paymentToken}.
     * @param maxPhaseCap Maximum amount of tokens to be sold in this phase, expressed in 
              {SaleStorage.SetUp.paymentToken}.
     */
    function _updateStorageOnBuy(
        uint256 amount,
        string calldata phaseId,
        address buyer,
        uint256 grandTotal,
        uint256 maxPhaseCap
    ) internal virtual {
        SaleStorage.Ledger storage ledger = SaleStorage.layout().ledger;

        // update raised amount
        ledger.totalRaised += amount;
        ledger.raisedInPhase[phaseId] += amount;
        ledger.allocationReservedByIn[buyer][phaseId] += amount;
        // close whole SALE if sold out
        if (ledger.totalRaised == grandTotal) _closeSale();
        // close PHASE if sold out
        if (ledger.raisedInPhase[phaseId] == maxPhaseCap) {
            _closePhase(phaseId);
        }
        // otherwise close PHASE if time elapsed
        else if (
            block.timestamp >= SaleStorage.layout().phases.data[phaseId].endAt
        ) {
            _closePhase(phaseId);
        }
    }

    /// @notice Verify phase is opened. If the sale has not been opened before the phase, open it.
    function _requireOpenedSaleAndPhase(string memory phaseId) internal {
        Phase memory phase = SaleStorage.layout().phases.data[phaseId];
        Status saleStatus = SaleStorage.layout().ledger.status;
        // open phase if necessary
        if (
            phase.status == Status.NOT_STARTED &&
            block.timestamp >= phase.startAt &&
            block.timestamp < phase.endAt
        ) {
            if (saleStatus == Status.NOT_STARTED) _openSale();
            _openPhase(phaseId);
            return;
        }
        // revert if phase can not be opened
        if (phase.status != Status.OPENED) {
            revert SaleWritableInternal_PhaseNotOpened(phaseId, phase.status);
        }
    }

    /**
     * @notice Ensure a wallet can not spend more than their allocation for the given phase.
     *
     * @param toSpend Amount of tokens to spend in this transaction, expressed in
     *        {SaleStorage.SetUp.paymentToken}.
     * @param buyer Wallet buying tokens.
     * @param allocated Maximum amount of tokens this wallet can spend in this phase, expressed in
     *        {SaleStorage.SetUp.paymentToken}.
     */
    function _requireAllocationNotExceededInPhase(
        uint256 toSpend,
        address buyer,
        uint256 allocated,
        string calldata phaseId
    ) internal view {
        uint256 totalAfterPurchase = toSpend +
            SaleStorage.layout().ledger.allocationReservedByIn[buyer][phaseId];
        if (totalAfterPurchase > allocated) {
            revert SaleWritable_AllocationExceeded(
                allocated,
                totalAfterPurchase - allocated
            );
        }
    }

    /**
     * @notice Verify `grandTotal` will not be exceeded after purchase.
     *
     * @param toSpend Amount of tokens to spend in this transaction, expressed in
     *        {SaleStorage.SetUp.paymentToken}.
     * @param grandTotal Total amount of tokens to be sold in this Sale, expressed in
     *        {SaleStorage.SetUp.paymentToken}.
     */
    function _requireGrandTotalNotExceeded(
        uint256 toSpend,
        uint256 grandTotal
    ) internal view {
        uint256 totalAfterPurchase = toSpend +
            SaleStorage.layout().ledger.totalRaised;
        if (totalAfterPurchase > grandTotal) {
            revert SaleWritable_GrandTotalExceeded(
                grandTotal,
                // by how much`grandTotal` is exceeded
                totalAfterPurchase - grandTotal
            );
        }
    }

    /// @notice Verify Sale is opened.
    function _requireOpenedSale() internal view {
        Status current = SaleStorage.layout().ledger.status;
        if (current != Status.OPENED) {
            revert SaleWritableInternal_SaleNotOpened(current);
        }
    }

    /**
     * @notice Verify `maxPhaseCap` will not be exceeded after purchase.
     *
     * @param phaseId Phase linked to current allocation used by buyer.
     * @param maxPhaseCap Maximum amount of tokens to be sold in this phase, expressed in
     *        {SaleStorage.SetUp.paymentToken}.
     * @param toSpend Amount of tokens to spend in this transaction, expressed in
     *        {SaleStorage.SetUp.paymentToken}.
     */
    function _requirePhaseCapNotExceeded(
        string calldata phaseId,
        uint256 maxPhaseCap,
        uint256 toSpend
    ) internal view {
        uint256 raisedAfterPurchase = toSpend +
            SaleStorage.layout().ledger.raisedInPhase[phaseId];
        if (raisedAfterPurchase > maxPhaseCap) {
            revert SaleWritable_MaxPhaseCapExceeded(
                phaseId,
                maxPhaseCap,
                // by how much `maxPhaseCap` is exceeded
                raisedAfterPurchase - maxPhaseCap
            );
        }
    }

    /**
     * @notice Verify allocation is valid.
     *
     * @param allocation Allocation to verify.
     * @param proof Merkle proof of the allocation.
     */
    function _requireValidAllocation(
        UserAllocationFee calldata allocation,
        bytes32[] calldata proof
    ) internal view {
        if (
            !MerkleProof.verify(
                proof,
                SaleStorage
                    .layout()
                    .phases
                    .data[allocation.usrData.base.phaseId]
                    .merkleRoot,
                keccak256(abi.encode(address(this), block.chainid, allocation))
            )
        ) revert SaleWritableInternal_AllocationNotFound();
    }

    /**
     * @notice ERC20 permit and transfer in one call.
     * @param permit2 Address of the permit2 contract.
     * @param from address to transfer tokens from.
     * @param to address to transfer tokens to.
     * @param token address of the token to transfer.
     * @param amount amount of tokens to transfer.
     * @param permission BuyPermission struct containing permit signature and deadline.
     */
    function _permit2ApproveAndTransfer(
        address permit2,
        address from,
        address to,
        address token,
        uint256 amount,
        BuyPermission calldata permission
    ) internal {
        /// @dev declare {Permit2.permitTransferFrom} parameters
        ISignatureTransfer.TokenPermissions memory permitted;
        ISignatureTransfer.PermitTransferFrom memory permit;
        ISignatureTransfer.SignatureTransferDetails memory transferDetails;

        /// @dev configure {Permit2.permitTransferFrom} parameters using IGO and allocation parameters
        permitted = ISignatureTransfer.TokenPermissions({
            token: token,
            amount: amount
        });
        permit = ISignatureTransfer.PermitTransferFrom({
            permitted: permitted,
            nonce: permission.nonce,
            deadline: permission.deadline
        });
        transferDetails = ISignatureTransfer.SignatureTransferDetails({
            to: to,
            requestedAmount: amount
        });

        /// @dev {Permit2} library call
        ISignatureTransfer(permit2).permitTransferFrom(
            permit,
            transferDetails,
            from,
            permission.signature
        );
    }
}

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

// import {Clones} from "openzeppelin-contracts/proxy/Clones.sol";
import {ERC721SequentialId} from "../../nft/ERC721SequentialId.sol";
import {INFT} from "../../nft/interfaces/INFT.sol";
import {IINORestricted} from "./IINORestricted.sol";
import {IINORestrictedInternal} from "./IINORestrictedInternal.sol";

import {RestrictedWritable} from "../../../common/writable/restricted/RestrictedWritable.sol";

// import struct
import {Status, Phase} from "../../../common/SaleStruct.sol";
import {INOPhase} from "../../INOStruct.sol";

// storage
import {INOStorage} from "../../INOStorage.sol";
import {SaleStorage} from "../../../common/SaleStorage.sol";

/**
 * @title IRestrictedWritable
 * @notice Only the owner of the contract can call these methods.
 */
contract INORestricted is
    IINORestricted,
    IINORestrictedInternal,
    RestrictedWritable
{
    /// @inheritdoc IINORestricted
    function initialize(
        SaleStorage.SetUp calldata saleSetUp,
        address owner,
        INOStorage.SetUp calldata inoSetUp,
        string[] calldata phaseIds,
        INOPhase[] calldata phases
    ) external override initializer {
        if (inoSetUp.paymentReceiver == address(0)) {
            revert INORestricted_Init_PaymentReceiverIsZeroAddr();
        }
        if (inoSetUp.projectWallet == address(0)) {
            revert INORestricted_Init_ProjectWalletIsZeroAddr();
        }

        // inherited from {RestrictedWritable.}
        _initializeSale(saleSetUp);
        _setOwnerRights(owner);

        INOStorage.layout().setUp = inoSetUp;

        // inherited from {RestrictedWritable.}
        _updateSetINOPhases(phaseIds, phases);

        emit INO_Initialized(saleSetUp, owner, inoSetUp, phaseIds, phases);
    }

    /// @inheritdoc IINORestricted
    function deployNftToSell(
        address nftToClone,
        INOStorage.NFTCollectionData calldata data
    )
        external
        override
        onlyRole(DEFAULT_ADMIN_ROLE)
        reinitializer(2)
        returns (address collection)
    {
        _requireSaleNotStarted();
        _checkValidClone(nftToClone);
        _checkNFTData(data);

        // collection = _clone(nftToClone, data);
        collection = address(new ERC721SequentialId());
        INOStorage.layout().nftData = data;
        INOStorage.layout().collection = collection;

        INFT(collection).initialize(data, _msgSender(), address(this));

        emit INO_DeployedNftToSell(collection, data);
    }

    /// @inheritdoc IINORestricted
    function updateSetPhase(
        string calldata phaseId_,
        INOPhase calldata phase_
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isSaleNot(Status.COMPLETED);

        emit INO_SinglePhaseUpdate(
            phaseId_,
            SaleStorage.layout().phases.data[phaseId_],
            phase_
        );

        _updateSetINOPhase(phaseId_, phase_);
    } // TODO: gas report + testnet txs

    function updatePhaseMaxMintAndMerkleRoot(
        string calldata phaseId,
        uint256 phaseMaxMint,
        bytes32 merkleRoot
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        /// @custom:audit verifies underneath the phase is not completed
        updatePhaseMerkleRoot(phaseId, merkleRoot);

        emit INO_PhaseMaxMintUpdated(
            phaseId,
            INOStorage.layout().phaseMaxMint[phaseId],
            phaseMaxMint
        );

        INOStorage.layout().phaseMaxMint[phaseId] = phaseMaxMint;
    }

    /// @inheritdoc IINORestricted
    function updateSetPhases(
        string[] calldata phaseIdentifiers_,
        INOPhase[] calldata phases_
    ) public override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isSaleNot(Status.COMPLETED);

        // inherited from {RestrictedWritable}
        _updateSetINOPhases(phaseIdentifiers_, phases_);

        emit IGO_BatchPhaseUpdate(phaseIdentifiers_, phases_);
    }

    // function _clone(
    //     address nftToClone,
    //     INOStorage.NFTCollectionData calldata data
    // ) internal returns (address) {
    //     bytes32 salt = keccak256(
    //         abi.encode(msg.sender, data, block.timestamp)
    //     );
    //     return Clones.cloneDeterministic(nftToClone, salt);
    // }

    function _requireSaleNotStarted() internal view {
        Status current = SaleStorage.layout().ledger.status;
        if (current != Status.NOT_STARTED) {
            revert INORestricted_SaleStarted(current);
        }
    }

    /// @dev Check name, symbol, and max cap of the NFT collection.
    function _checkNFTData(
        INOStorage.NFTCollectionData calldata data
    ) internal pure {
        if (bytes(data.name).length < 2) {
            revert INORestricted_Deploy_Name2CharsMin();
        }
        if (bytes(data.symbol).length < 1) {
            revert INORestricted_Deploy_Symbole1CharMin();
        }
        if (data.maxCap == 0) {
            revert INORestricted_Deploy_MaxCapNotSet();
        }
    }

    function _checkValidClone(address clone) internal pure {
        if (clone == address(0)) {
            revert INORestricted_Deploy_NftToCloneIsZeroAddr();
        }
    }

    function _updateSetINOPhase(
        string calldata phaseId_,
        INOPhase calldata phase_
    ) internal {
        // inherited from {RestrictedWritable}
        _setPhase(
            SaleStorage.layout().setUp.grandTotal,
            SaleStorage.layout().ledger.summedMaxPhaseCap,
            SaleStorage.layout().phases.data[phaseId_].maxPhaseCap,
            phase_.base,
            phaseId_
        );

        INOStorage.layout().phaseMaxMint[phaseId_] = phase_.phaseMaxMint;
    }

    function _updateSetINOPhases(
        string[] calldata phaseIdentifiers_,
        INOPhase[] calldata phases_
    ) internal {
        if (phaseIdentifiers_.length != phases_.length) {
            revert RestrictedWritableInternal_DifferentArraysLength();
        }

        uint256 length = phaseIdentifiers_.length;

        //slither-disable-next-line uninitialized-local
        for (uint256 i; i < length; ++i) {
            /// @dev less¬ gas efficient, but more readable
            _updateSetINOPhase(phaseIdentifiers_[i], phases_[i]);
        }
    }
}

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

import {Allocation} from "../common/SaleStruct.sol";

/**
 * @notice Struct representing a user based allocation for a specific phase of a sale.
 *
 * @dev Backend is in charge of generating an allocation, which will depends on the sale type:
 *      - IGO: allocation based on the tier from which wallet is part of,
 *      - VPR IGO: off-chain backend lottery + allocation based on off-chain actions, e.g.
 *          * social task: +50% from base price,
 *          * in-game tasks: +33% from base price,
 *          * etc...
 *      - INO: allocation based on SFUND/SFNTS staked-farmed.
 *
 * @param base User based allocation data.
 * @param account Wallet address of the buyer.
 */
struct UserAllocation {
    Allocation base;
    address account;
}

/**
 * @notice Struct representing a user based allocation with a refund fee.
 *
 * @param usrData User based allocation data.
 * @param refundFee Fee to be paid by the buyer in case of refund, expressed in
 *        {SaleStorage.SetUp.paymentToken} - decimals defined in {IGOVesting.decimals}.
 */
struct UserAllocationFee {
    UserAllocation usrData;
    uint256 refundFee;
}

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

import {ISaleReadable} from "../readable/ISaleReadable.sol";
import {IRestrictedWritableInternal} from "../writable/restricted/IRestrictedWritableInternal.sol";
import {ISaleWritableInternal} from "../writable/ISaleWritableInternal.sol";

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

// import struct
import {Status, Phase} from "../SaleStruct.sol";

/**
 * @title SaleReadable
 * @notice Read-only contract of {Sale} data.
 */
contract SaleReadable is
    ISaleReadable, // 1 inherited component
    ISaleWritableInternal, // 1 inherited component
    IRestrictedWritableInternal // 1 inherited component
{
    /// @inheritdoc ISaleReadable
    function allocationReservedByIn(
        address account,
        string calldata phaseId
    ) external view override returns (uint256) {
        return
            SaleStorage.layout().ledger.allocationReservedByIn[account][
                phaseId
            ];
    }

    /// @inheritdoc ISaleReadable
    function phase(
        string memory phaseId
    ) external view override returns (Phase memory phase_) {
        phase_ = SaleStorage.layout().phases.data[phaseId];
    }

    /// @inheritdoc ISaleReadable
    function phaseIds()
        external
        view
        override
        returns (string[] memory phaseIds_)
    {
        phaseIds_ = SaleStorage.layout().phases.ids;
    }

    /// @inheritdoc ISaleReadable
    function raisedInPhase(
        string memory phaseId
    ) external view override returns (uint256) {
        return SaleStorage.layout().ledger.raisedInPhase[phaseId];
    }

    /// @inheritdoc ISaleReadable
    function saleStatus() external view override returns (Status) {
        return SaleStorage.layout().ledger.status;
    }

    /// @inheritdoc ISaleReadable
    function setUp()
        external
        view
        override
        returns (address paymentToken, uint256 grandTotal)
    {
        SaleStorage.SetUp memory setUp_ = SaleStorage.layout().setUp;
        paymentToken = setUp_.paymentToken;
        grandTotal = setUp_.grandTotal;
    }

    /// @inheritdoc ISaleReadable
    function totalRaised() external view override returns (uint256) {
        return SaleStorage.layout().ledger.totalRaised;
    }
}

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

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

interface IINOReadable {
    /**
     * @return 
            - `paymentReceiver` address of the wallet to receive the payments
            - `projectWallet` address of the project which will receive
              the NFT owner rights after the INO ends.
     */
    function inoSetUp() external view returns (INOStorage.SetUp memory);

    /// @dev Amount of NFTs minted by users in a specific phase.
    function mintedInPhase(
        string calldata phaseId
    ) external view returns (uint256);

    /// @dev Address of the NFT collection contract to mint when buying.
    function nftCollection() external view returns (address);

    function nftCollectionData()
        external
        view
        returns (INOStorage.NFTCollectionData memory);

    /// @dev Amount of NFTs minted by users in the whole INO.
    function totalMinted() external view returns (uint256);
}

// 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) {
                // Solidity will revert if denominator == 0, unlike the div opcode on its own.
                // The surrounding unchecked block does not change this fact.
                // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
                return prod0 / denominator;
            }

            // Make sure the result is less than 2^256. Also prevents denominator == 0.
            require(denominator > prod1, "Math: mulDiv overflow");

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.0;

/**
 * @dev Standard signed math utilities missing in the Solidity language.
 */
library SignedMath {
    /**
     * @dev Returns the largest of two signed numbers.
     */
    function max(int256 a, int256 b) internal pure returns (int256) {
        return a > b ? a : b;
    }

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

    /**
     * @dev Returns the average of two signed numbers without overflow.
     * The result is rounded towards zero.
     */
    function average(int256 a, int256 b) internal pure returns (int256) {
        // Formula from the book "Hacker's Delight"
        int256 x = (a & b) + ((a ^ b) >> 1);
        return x + (int256(uint256(x) >> 255) & (a ^ b));
    }

    /**
     * @dev Returns the absolute unsigned value of a signed value.
     */
    function abs(int256 n) internal pure returns (uint256) {
        unchecked {
            // must be unchecked in order to support `n = type(int256).min`
            return uint256(n >= 0 ? n : -n);
        }
    }
}

// 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: UNLICENSED
pragma solidity 0.8.23;

// import struct
import {Status} from "../../common/SaleStruct.sol";

/**
 * @title IINOWritableInternal
 * @notice Defines enum, struct, event and errors for INO.
 */
interface IINOWritableInternal {
    error INO_IncorrectNativeAmount(uint256 sent, uint256 price);
    error INO_IncorrectERC20Amount(uint256 sent, uint256 price);
    error INO_MaxMintINOReached(uint256 maxMint, uint256 exceedBy);
    error INO_MaxMintInPhaseReached(uint256 maxMintInPhase, uint256 exceedBy);
    error INO_NativePaymentFailed(bytes data);
    error INO_OnlyUseMultipleOf(uint256 multiple);
    error INO_UseInstead(string);
}

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

import {IERC20} from "openzeppelin-contracts/token/ERC20/IERC20.sol";

import {SafeERC20} from "openzeppelin-contracts/token/ERC20/utils/SafeERC20.sol";

import {Initializable} from "openzeppelin-contracts/proxy/utils/Initializable.sol";

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

import {IGOStorage} from "../../../igo/IGOStorage.sol";
import {SaleStorage} from "../../SaleStorage.sol";

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

// import struct
import {Status, Phase} from "../../SaleStruct.sol";

/**
 * @title RestrictedWritable
 */
contract RestrictedWritable is
    IRestrictedWritable, // 1 inherited component
    RestrictedWritableInternal, // 2 inherited component
    Initializable // 1 inherited component
{
    using SafeERC20 for IERC20;

    function openSale() external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isSale(Status.NOT_STARTED);
        _openSale();

        emit SaleOpened();
    }

    function pauseSale() external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isSale(Status.OPENED);
        SaleStorage.layout().ledger.status = Status.PAUSED;

        emit SalePaused();
    }

    function resumeSale() external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isSale(Status.PAUSED);
        SaleStorage.layout().ledger.status = Status.OPENED;

        emit SaleResumed();
    }

    /// @inheritdoc IRestrictedWritable
    function recoverLostERC20(
        address token,
        address to
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        if (token == address(0)) revert RestrictedWritable_TokenIsZeroAddr();
        if (to == address(0)) revert RestrictedWritable_ReceiverIsZeroAddr();

        uint256 amount = IERC20(token).balanceOf(address(this));
        IERC20(token).safeTransfer(to, amount);

        emit RecoveredLostERC20(token, to, amount);
    }

    /// @inheritdoc IRestrictedWritable
    function updateGrandTotal(
        uint256 grandTotal_
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isSaleNot(Status.COMPLETED);

        _isSummedMaxPhaseCapLteGrandTotal(
            SaleStorage.layout().ledger.summedMaxPhaseCap,
            grandTotal_
        );

        emit GrandTotalUpdated(
            SaleStorage.layout().setUp.grandTotal,
            grandTotal_
        );
        SaleStorage.layout().setUp.grandTotal = grandTotal_;
    }

    //////////////////////////// PHASE SINGLE UPDATE ////////////////////////////
    /// @inheritdoc IRestrictedWritable
    function openPhase(
        string calldata phaseId
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isPhase(Status.NOT_STARTED, phaseId);
        _openPhase(phaseId);

        emit PhaseOpened(phaseId);
    }

    function pausePhase(
        string calldata phaseId
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isPhase(Status.OPENED, phaseId);
        SaleStorage.layout().phases.data[phaseId].status = Status.PAUSED;

        emit PhasePaused(phaseId);
    }

    function resumePhase(
        string calldata phaseId
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isPhase(Status.PAUSED, phaseId);
        SaleStorage.layout().phases.data[phaseId].status = Status.OPENED;

        emit PhaseResumed(phaseId);
    }

    function updatePhaseEndDate(
        string calldata phaseId,
        uint128 endAt
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isPhaseNot(Status.COMPLETED, phaseId);
        if (endAt <= block.timestamp) revert RestrictedWritable_EndInPast();

        emit PhaseEndDateUpdated(
            phaseId,
            SaleStorage.layout().phases.data[phaseId].endAt,
            endAt
        );
        SaleStorage.layout().phases.data[phaseId].endAt = endAt;
    }

    /// @inheritdoc IRestrictedWritable
    function updatePhaseMaxCapAndMerkleRoot(
        string calldata phaseId,
        uint256 maxPhaseCap,
        bytes32 merkleRoot
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        /// @custom:audit verifies underneath the phase is not completed
        updatePhaseMerkleRoot(phaseId, merkleRoot);

        uint256 summedMaxPhaseCap = SaleStorage
            .layout()
            .ledger
            .summedMaxPhaseCap;

        summedMaxPhaseCap -= SaleStorage
            .layout()
            .phases
            .data[phaseId]
            .maxPhaseCap;
        summedMaxPhaseCap += maxPhaseCap;

        _isSummedMaxPhaseCapLteGrandTotal(
            summedMaxPhaseCap,
            SaleStorage.layout().setUp.grandTotal
        );

        emit PhaseMaxCapUpdated(
            phaseId,
            SaleStorage.layout().phases.data[phaseId].maxPhaseCap,
            maxPhaseCap
        );
        SaleStorage.layout().phases.data[phaseId].maxPhaseCap = maxPhaseCap;
        SaleStorage.layout().ledger.summedMaxPhaseCap = summedMaxPhaseCap;
    }

    /// @inheritdoc IRestrictedWritable
    function updatePhaseMerkleRoot(
        string calldata phaseId,
        bytes32 merkleRoot
    ) public override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isPhaseNot(Status.COMPLETED, phaseId);
        if (merkleRoot == bytes32(0)) {
            revert RestrictedWritable_EmptyMerkleRoot();
        }

        emit PhaseMerkleRootUpdated(
            phaseId,
            SaleStorage.layout().phases.data[phaseId].merkleRoot,
            merkleRoot
        );
        SaleStorage.layout().phases.data[phaseId].merkleRoot = merkleRoot;
    }

    function updatePhaseStartDate(
        string calldata phaseId,
        uint128 startAt
    ) external override onlyRole(DEFAULT_ADMIN_ROLE) {
        _isPhase(Status.NOT_STARTED, phaseId);
        if (startAt < block.timestamp) revert RestrictedWritable_StartInPast();

        emit PhaseStartDateUpdated(
            phaseId,
            SaleStorage.layout().phases.data[phaseId].startAt,
            startAt
        );
        SaleStorage.layout().phases.data[phaseId].startAt = startAt;
    }
}

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

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

/// @title SignatureTransfer
/// @notice Handles ERC20 token transfers through signature based actions
/// @dev Requires user's token approval on the Permit2 contract
interface ISignatureTransfer is IEIP712 {
    /// @notice Thrown when the requested amount for a transfer is larger than the permissioned amount
    /// @param maxAmount The maximum amount a spender can request to transfer
    error InvalidAmount(uint256 maxAmount);

    /// @notice Thrown when the number of tokens permissioned to a spender does not match the number of tokens being transferred
    /// @dev If the spender does not need to transfer the number of tokens permitted, the spender can request amount 0 to be transferred
    error LengthMismatch();

    /// @notice Emits an event when the owner successfully invalidates an unordered nonce.
    event UnorderedNonceInvalidation(address indexed owner, uint256 word, uint256 mask);

    /// @notice The token and amount details for a transfer signed in the permit transfer signature
    struct TokenPermissions {
        // ERC20 token address
        address token;
        // the maximum amount that can be spent
        uint256 amount;
    }

    /// @notice The signed permit message for a single token transfer
    struct PermitTransferFrom {
        TokenPermissions permitted;
        // a unique value for every token owner's signature to prevent signature replays
        uint256 nonce;
        // deadline on the permit signature
        uint256 deadline;
    }

    /// @notice Specifies the recipient address and amount for batched transfers.
    /// @dev Recipients and amounts correspond to the index of the signed token permissions array.
    /// @dev Reverts if the requested amount is greater than the permitted signed amount.
    struct SignatureTransferDetails {
        // recipient address
        address to;
        // spender requested amount
        uint256 requestedAmount;
    }

    /// @notice Used to reconstruct the signed permit message for multiple token transfers
    /// @dev Do not need to pass in spender address as it is required that it is msg.sender
    /// @dev Note that a user still signs over a spender address
    struct PermitBatchTransferFrom {
        // the tokens and corresponding amounts permitted for a transfer
        TokenPermissions[] permitted;
        // a unique value for every token owner's signature to prevent signature replays
        uint256 nonce;
        // deadline on the permit signature
        uint256 deadline;
    }

    /// @notice A map from token owner address and a caller specified word index to a bitmap. Used to set bits in the bitmap to prevent against signature replay protection
    /// @dev Uses unordered nonces so that permit messages do not need to be spent in a certain order
    /// @dev The mapping is indexed first by the token owner, then by an index specified in the nonce
    /// @dev It returns a uint256 bitmap
    /// @dev The index, or wordPosition is capped at type(uint248).max
    function nonceBitmap(address, uint256) external view returns (uint256);

    /// @notice Transfers a token using a signed permit message
    /// @dev Reverts if the requested amount is greater than the permitted signed amount
    /// @param permit The permit data signed over by the owner
    /// @param owner The owner of the tokens to transfer
    /// @param transferDetails The spender's requested transfer details for the permitted token
    /// @param signature The signature to verify
    function permitTransferFrom(
        PermitTransferFrom memory permit,
        SignatureTransferDetails calldata transferDetails,
        address owner,
        bytes calldata signature
    ) external;

    /// @notice Transfers a token using a signed permit message
    /// @notice Includes extra data provided by the caller to verify signature over
    /// @dev The witness type string must follow EIP712 ordering of nested structs and must include the TokenPermissions type definition
    /// @dev Reverts if the requested amount is greater than the permitted signed amount
    /// @param permit The permit data signed over by the owner
    /// @param owner The owner of the tokens to transfer
    /// @param transferDetails The spender's requested transfer details for the permitted token
    /// @param witness Extra data to include when checking the user signature
    /// @param witnessTypeString The EIP-712 type definition for remaining string stub of the typehash
    /// @param signature The signature to verify
    function permitWitnessTransferFrom(
        PermitTransferFrom memory permit,
        SignatureTransferDetails calldata transferDetails,
        address owner,
        bytes32 witness,
        string calldata witnessTypeString,
        bytes calldata signature
    ) external;

    /// @notice Transfers multiple tokens using a signed permit message
    /// @param permit The permit data signed over by the owner
    /// @param owner The owner of the tokens to transfer
    /// @param transferDetails Specifies the recipient and requested amount for the token transfer
    /// @param signature The signature to verify
    function permitTransferFrom(
        PermitBatchTransferFrom memory permit,
        SignatureTransferDetails[] calldata transferDetails,
        address owner,
        bytes calldata signature
    ) external;

    /// @notice Transfers multiple tokens using a signed permit message
    /// @dev The witness type string must follow EIP712 ordering of nested structs and must include the TokenPermissions type definition
    /// @notice Includes extra data provided by the caller to verify signature over
    /// @param permit The permit data signed over by the owner
    /// @param owner The owner of the tokens to transfer
    /// @param transferDetails Specifies the recipient and requested amount for the token transfer
    /// @param witness Extra data to include when checking the user signature
    /// @param witnessTypeString The EIP-712 type definition for remaining string stub of the typehash
    /// @param signature The signature to verify
    function permitWitnessTransferFrom(
        PermitBatchTransferFrom memory permit,
        SignatureTransferDetails[] calldata transferDetails,
        address owner,
        bytes32 witness,
        string calldata witnessTypeString,
        bytes calldata signature
    ) external;

    /// @notice Invalidates the bits specified in mask for the bitmap at the word position
    /// @dev The wordPos is maxed at type(uint248).max
    /// @param wordPos A number to index the nonceBitmap at
    /// @param mask A bitmap masked against msg.sender's current bitmap at the word position
    function invalidateUnorderedNonces(uint256 wordPos, uint256 mask) external;
}

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

import {AccessControlEnumerable} from "openzeppelin-contracts/access/AccessControlEnumerable.sol";

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

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

// import struct
import {Status, Phase} from "../../SaleStruct.sol";

/**
 * @title RestrictedWritableInternal
 * @notice Defines the internal functions of `RestrictedWritable` contract.
 */
contract RestrictedWritableInternal is
    IRestrictedWritableInternal, // 1 inherited component
    AccessControlEnumerable // 8 inherited component
{
    function _initializeSale(SaleStorage.SetUp calldata saleSetUp) internal {
        if (saleSetUp.permit2 == address(0))
            revert RestrictedWritable_Init_Permit2IsZeroAddr();
        if (saleSetUp.grandTotal <= 0)
            revert RestrictedWritable_Init_GrandTotalIsZero();

        SaleStorage.layout().setUp = saleSetUp;
    }

    function _openPhase(string memory phaseId) internal {
        SaleStorage.layout().phases.data[phaseId].status = Status.OPENED;
    }

    function _openSale() internal {
        SaleStorage.layout().ledger.status = Status.OPENED;
    }

    function _setOwnerRights(address owner) internal {
        if (owner == address(0)) {
            revert RestrictedWritable_Init_OwnerIsZeroAddr();
        }

        _grantRole(DEFAULT_ADMIN_ROLE, owner);
        _grantRole(DEFAULT_ADMIN_ROLE, _msgSender());
    }

    /**
     * @notice Set the data of phase or update it if it already exists.
     *
     * @param grandTotal The maximum amount of can be raised for this Sale, over all phase,
     *                   expressed in {SaleStorage.SetUp.paymentToken}.
     * @param summedMaxPhaseCap The sum of all max amount to raise per phase before updating this phase,
     *                          expressed in {SaleStorage.SetUp.paymentToken}. Can be lower than
     *                          `grandTotal` BUT NEVER bigger.
     * @param oldMaxPhaseCap The max amount to raise for the phase before updating it,
     *                       expressed in {SaleStorage.SetUp.paymentToken}.
     * @param phase_ The phase's data to save.
     * @param phaseId_ The phase identifier.
     */
    function _setPhase(
        uint256 grandTotal,
        uint256 summedMaxPhaseCap,
        uint256 oldMaxPhaseCap,
        Phase calldata phase_,
        string calldata phaseId_
    ) internal {
        if (_isEmptyPhase(phase_)) revert RestrictedWritable_EmptyPhase();

        summedMaxPhaseCap -= oldMaxPhaseCap;
        summedMaxPhaseCap += phase_.maxPhaseCap;

        _isSummedMaxPhaseCapLteGrandTotal(summedMaxPhaseCap, grandTotal);

        // if phase does not exist, push to ids
        if (oldMaxPhaseCap == 0)
            SaleStorage.layout().phases.ids.push(phaseId_);
        SaleStorage.layout().phases.data[phaseId_] = phase_;

        SaleStorage.layout().ledger.summedMaxPhaseCap = summedMaxPhaseCap;
    }

    /**
     * @notice Verify that none of the phase's data is empty.
     * @param phase_ The phase's data to verify.
     * @return True if the phase is empty, false otherwise.
     */
    function _isEmptyPhase(
        Phase calldata phase_
    ) internal view returns (bool) {
        return
            phase_.merkleRoot == bytes32(0) ||
            phase_.startAt < block.timestamp ||
            phase_.endAt <= block.timestamp ||
            phase_.maxPhaseCap <= 0;
    }

    function _isPhase(Status expected, string calldata phaseId) internal view {
        Status phaseStatus = SaleStorage.layout().phases.data[phaseId].status;

        if (phaseStatus != expected) {
            revert RestrictedWritable_PhaseNotMatched(expected, phaseStatus);
        }
    }

    /// @dev If **phase status** is NOT equals `avoid` it passes silently, otherwise it reverts.
    function _isPhaseNot(Status avoid, string calldata phaseId) internal view {
        Status phaseStatus = SaleStorage.layout().phases.data[phaseId].status;

        if (phaseStatus == avoid) {
            revert RestrictedWritable_PhaseMatched(avoid, phaseStatus);
        }
    }

    function _isSale(Status expected) internal view {
        Status current = SaleStorage.layout().ledger.status;
        if (current != expected) {
            revert RestrictedWritable_SaleNotMatched(expected, current);
        }
    }

    /// @dev If **sale status** is NOT equals `avoid` it passes silently, otherwise it reverts.
    function _isSaleNot(Status avoid) internal view {
        Status current = SaleStorage.layout().ledger.status;
        if (current == avoid) {
            revert RestrictedWritable_SaleMatched(avoid, current);
        }
    }

    /**
     * @notice Verify whether the sum of all max amount to raise per phase is lower than or equal to the
     *         grand total.
     * @dev reverts if `summedMaxPhaseCap` is greater than `grandTotal`.
     */
    function _isSummedMaxPhaseCapLteGrandTotal(
        uint256 summedMaxPhaseCap,
        uint256 grandTotal
    ) internal pure {
        if (summedMaxPhaseCap > grandTotal) {
            revert RestrictedWritableInternal_SummedMaxPhaseCapGtGrandTotal(
                summedMaxPhaseCap - grandTotal
            );
        }
    }
}

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

// import struct
import {Status} from "../SaleStruct.sol";

/**
 * @title ISaleWritableInternal
 * @notice Internal interface of `SaleWritable` which defines events  and errors.
 */
interface ISaleWritableInternal {
    /// @notice Thrown when the buyer tries to spend more than {Allocation.maxAllocation}.
    error SaleWritable_AllocationExceeded(
        uint256 allocation,
        uint256 exceedsBy
    );
    /// @notice Thrown when the grand total to be raised for this Sale is exceeded.
    error SaleWritable_GrandTotalExceeded(
        uint256 grandTotal,
        uint256 exceedsBy
    );
    /// @notice Thrown when the cap (maximum amount) of the current phase is exceeded.
    error SaleWritable_MaxPhaseCapExceeded(
        string phaseId,
        uint256 maxPhaseCap,
        uint256 exceedsBy
    );

    /// @notice Thrown when `msg.sender` is not the buyer.
    error SaleWritableInternal_AccountNotAuthorized();
    /// @notice Thrown when the allocation is not found in the merkle proof.
    error SaleWritableInternal_AllocationNotFound();
    /// @notice Thrown when the phase is not opened.
    error SaleWritableInternal_PhaseNotOpened(string phaseId, Status current);
    /// @notice Thrown when the Sale is not opened.
    error SaleWritableInternal_SaleNotOpened(Status current);
}

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

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

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

contract ERC721SequentialId is
    ERC721Base // 12 inherited components
{
    function initialize(
        INOStorage.NFTCollectionData calldata data,
        address initialOwner,
        address ino_
    ) public override {
        super.initialize(data, initialOwner, ino_);
        emit NFTDeployed(
            Type.Sequential,
            initialOwner,
            data.name,
            data.symbol
        );
    }
}

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

import {INOStorage} from "../../INOStorage.sol";
import {SaleStorage} from "../../../common/SaleStorage.sol";

// import struct
import {Status, Phase} from "../../../common/SaleStruct.sol";
import {INOPhase} from "../../INOStruct.sol";

/**
 * @title IINORestrictedInternal
 */
interface IINORestrictedInternal {
    error INORestricted_Init_PaymentReceiverIsZeroAddr();
    error INORestricted_Init_ProjectWalletIsZeroAddr();

    error INORestricted_SaleStarted(Status current);
    error INORestricted_Deploy_MaxCapNotSet();
    error INORestricted_Deploy_Name2CharsMin();
    error INORestricted_Deploy_NftToCloneIsZeroAddr();
    // error INORestricted_Deploy_SaleAlreadyStarted();
    error INORestricted_Deploy_Symbole1CharMin();

    event INO_DeployedNftToSell(
        address indexed collection,
        INOStorage.NFTCollectionData indexed data
    );
    event INO_Initialized(
        SaleStorage.SetUp indexed saleSetUp,
        address indexed owner,
        INOStorage.SetUp indexed igoSetUp,
        string[] phaseIds_,
        INOPhase[] phases
    );
    event INO_PhaseMaxMintUpdated(
        string indexed phaseId,
        uint256 indexed oldPhaseMaxMint,
        uint256 indexed newPhaseMaxMint
    );
    event INO_SinglePhaseUpdate(
        string indexed phaseId,
        Phase indexed oldData,
        INOPhase indexed newData
    );
    event IGO_BatchPhaseUpdate(
        string[] indexed phaseId,
        INOPhase[] indexed phase
    );
}

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

// import struct
import {Status, Phase} from "../SaleStruct.sol";

/**
 * @title ISaleReadable
 * @notice Interface made for read-only data from {Sale}.
 */
interface ISaleReadable {
    /**
     * @param account Address of the user.
     * @param phaseId Identifier of the phase.
     *
     * @return Amount of {SaleStorage.SetUp.paymentToken} paid by `account` for the phase `phaseId`.
     *         If `address(0)` is returned, it means native (ETH, BNB, MATCI, etc...).
     */
    function allocationReservedByIn(
        address account,
        string calldata phaseId
    ) external view returns (uint256);

    /**
     * @param phaseId Identifier of the phase.
     * @return phase_ Phase struct representing the data of the phase `phaseId`.
     */
    function phase(
        string memory phaseId
    ) external view returns (Phase memory phase_);

    /// @return phaseIds_ List of all phases identifiers.
    function phaseIds() external view returns (string[] memory phaseIds_);

    /**
     * @param phaseId Identifier of the phase.
     *
     * @return Amount of {SaleStorage.SetUp.paymentToken} raised for the phase `phaseId`.
     *         If `address(0)` is returned, it means native (ETH, BNB, MATCI, etc...).
     */
    function raisedInPhase(
        string memory phaseId
    ) external view returns (uint256);

    /// @return Enum representing the current status of the Sale.
    function saleStatus() external view returns (Status);

    /**
     * @return paymentToken Address of the default token used to reserve allocation through the Sale.
     *         If `address(0)` is returned, it means native (ETH, BNB, MATCI, etc...).
     * @return grandTotal Maximum amount of paymentToken that can be raised for this Sale accross all phases.
     */
    function setUp()
        external
        view
        returns (address paymentToken, uint256 grandTotal);

    /// @return Total amount of {SaleStorage.SetUp.paymentToken} raised for this Sale.
    function totalRaised() external view returns (uint256);
}

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

import {Status} from "../../SaleStruct.sol";

/**
 * @title IRestrictedWritableInternal
 * @notice Defines event and error used in {RestrictedWritableInternal} & {RestrictedWritable}.
 */
interface IRestrictedWritableInternal {
    // @notice Thrown when `phaseIds` and `phases` arrays have different lengths.
    error RestrictedWritableInternal_DifferentArraysLength();
    // @notice Thrown when a phase {IGOStruct.Phase} is empty is {RestrictedWritableInternal._setPhases}.
    error RestrictedWritableInternal_EmptyPhase();
    // @notice Thrown when the sum of all max amount to raise per phase is greater than Sale grand total to be raised.
    error RestrictedWritableInternal_SummedMaxPhaseCapGtGrandTotal(
        uint256 greaterBy
    );

    //////////////////////////// THROWN ON Sale INITIALIZATION ////////////////////////////
    error RestrictedWritable_Init_GrandTotalIsZero();
    error RestrictedWritable_Init_OwnerIsZeroAddr();
    error RestrictedWritable_Init_PaymentTokenIsZeroAddr();
    error RestrictedWritable_Init_Permit2IsZeroAddr();

    /// @dev Thrown when merkle root is equal to bytes32(0).
    error RestrictedWritable_EmptyMerkleRoot();
    // @notice Thrown when a phase {IGOStruct.Phase} is empty is {RestrictedWritable.updateSetPhase}.
    error RestrictedWritable_EmptyPhase();
    error RestrictedWritable_EndInPast();
    error RestrictedWritable_ReceiverIsZeroAddr();
    error RestrictedWritable_StartInPast();
    error RestrictedWritable_TokenIsZeroAddr();

    /// @dev Thrown when the phase status is equal to `avoid`.
    error RestrictedWritable_PhaseMatched(Status avoid, Status phaseStatus);
    /// @dev Thrown when the phase status is not equal to the one expected.
    error RestrictedWritable_PhaseNotMatched(Status expected, Status current);
    /// @dev Thrown when the sale status is equal to `avoid`.
    error RestrictedWritable_SaleMatched(Status avoid, Status saleStatus);
    /// @dev Thrown when the sale status is not equal to the one expected.
    error RestrictedWritable_SaleNotMatched(Status expected, Status current);

    event GrandTotalUpdated(
        uint256 indexed oldGrandTotal,
        uint256 indexed newrandTotal
    );
    event PhaseEndDateUpdated(
        string indexed phaseId,
        uint256 indexed oldEndDate,
        uint256 indexed newEndDate
    );
    event PhaseMaxCapUpdated(
        string indexed phaseId,
        uint256 indexed oldMaxCap,
        uint256 indexed newMaxCap
    );
    event PhaseMerkleRootUpdated(
        string indexed phaseId,
        bytes32 indexed oldMerkleRoot,
        bytes32 indexed newMerkleRoot
    );
    event PhaseOpened(string indexed phaseName);
    event PhasePaused(string indexed phaseName);
    event PhaseResumed(string indexed phaseName);
    event PhaseStartDateUpdated(
        string indexed phaseId,
        uint256 indexed oldStartDate,
        uint256 indexed newStartDate
    );
    event RecoveredLostERC20(
        address indexed token,
        address indexed to,
        uint256 indexed amount
    );
    event SaleOpened();
    event SalePaused();
    event SaleResumed();
}

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

pragma solidity ^0.8.0;

/**
 * @dev Interface of the ERC20 standard as defined in the EIP.
 */
interface IERC20 {
    /**
     * @dev Emitted when `value` tokens are moved from one account (`from`) to
     * another (`to`).
     *
     * Note that `value` may be zero.
     */
    event Transfer(address indexed from, address indexed to, uint256 value);

    /**
     * @dev Emitted when the allowance of a `spender` for an `owner` is set by
     * a call to {approve}. `value` is the new allowance.
     */
    event Approval(address indexed owner, address indexed spender, uint256 value);

    /**
     * @dev Returns the amount of tokens in existence.
     */
    function totalSupply() external view returns (uint256);

    /**
     * @dev Returns the amount of tokens owned by `account`.
     */
    function balanceOf(address account) external view returns (uint256);

    /**
     * @dev Moves `amount` tokens from the caller's account to `to`.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transfer(address to, uint256 amount) external returns (bool);

    /**
     * @dev Returns the remaining number of tokens that `spender` will be
     * allowed to spend on behalf of `owner` through {transferFrom}. This is
     * zero by default.
     *
     * This value changes when {approve} or {transferFrom} are called.
     */
    function allowance(address owner, address spender) external view returns (uint256);

    /**
     * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * IMPORTANT: Beware that changing an allowance with this method brings the risk
     * that someone may use both the old and the new allowance by unfortunate
     * transaction ordering. One possible solution to mitigate this race
     * condition is to first reduce the spender's allowance to 0 and set the
     * desired value afterwards:
     * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
     *
     * Emits an {Approval} event.
     */
    function approve(address spender, uint256 amount) external returns (bool);

    /**
     * @dev Moves `amount` tokens from `from` to `to` using the
     * allowance mechanism. `amount` is then deducted from the caller's
     * allowance.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(address from, address to, uint256 amount) external returns (bool);
}

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

pragma solidity ^0.8.0;

import "../IERC20.sol";
import "../extensions/IERC20Permit.sol";
import "../../../utils/Address.sol";

/**
 * @title SafeERC20
 * @dev Wrappers around ERC20 operations that throw on failure (when the token
 * contract returns false). Tokens that return no value (and instead revert or
 * throw on failure) are also supported, non-reverting calls are assumed to be
 * successful.
 * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
 * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
 */
library SafeERC20 {
    using Address for address;

    /**
     * @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
     * non-reverting calls are assumed to be successful.
     */
    function safeTransfer(IERC20 token, address to, uint256 value) internal {
        _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
    }

    /**
     * @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
     * calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
     */
    function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
        _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
    }

    /**
     * @dev Deprecated. This function has issues similar to the ones found in
     * {IERC20-approve}, and its usage is discouraged.
     *
     * Whenever possible, use {safeIncreaseAllowance} and
     * {safeDecreaseAllowance} instead.
     */
    function safeApprove(IERC20 token, address spender, uint256 value) internal {
        // safeApprove should only be called when setting an initial allowance,
        // or when resetting it to zero. To increase and decrease it, use
        // 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
        require(
            (value == 0) || (token.allowance(address(this), spender) == 0),
            "SafeERC20: approve from non-zero to non-zero allowance"
        );
        _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
    }

    /**
     * @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
     * non-reverting calls are assumed to be successful.
     */
    function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
        uint256 oldAllowance = token.allowance(address(this), spender);
        _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
    }

    /**
     * @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
     * non-reverting calls are assumed to be successful.
     */
    function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
        unchecked {
            uint256 oldAllowance = token.allowance(address(this), spender);
            require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
        }
    }

    /**
     * @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
     * non-reverting calls are assumed to be successful. Compatible with tokens that require the approval to be set to
     * 0 before setting it to a non-zero value.
     */
    function forceApprove(IERC20 token, address spender, uint256 value) internal {
        bytes memory approvalCall = abi.encodeWithSelector(token.approve.selector, spender, value);

        if (!_callOptionalReturnBool(token, approvalCall)) {
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
            _callOptionalReturn(token, approvalCall);
        }
    }

    /**
     * @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
     * Revert on invalid signature.
     */
    function safePermit(
        IERC20Permit token,
        address owner,
        address spender,
        uint256 value,
        uint256 deadline,
        uint8 v,
        bytes32 r,
        bytes32 s
    ) internal {
        uint256 nonceBefore = token.nonces(owner);
        token.permit(owner, spender, value, deadline, v, r, s);
        uint256 nonceAfter = token.nonces(owner);
        require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
    }

    /**
     * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
     * on the return value: the return value is optional (but if data is returned, it must not be false).
     * @param token The token targeted by the call.
     * @param data The call data (encoded using abi.encode or one of its variants).
     */
    function _callOptionalReturn(IERC20 token, bytes memory data) private {
        // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
        // we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
        // the target address contains contract code and also asserts for success in the low-level call.

        bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
        require(returndata.length == 0 || abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
    }

    /**
     * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
     * on the return value: the return value is optional (but if data is returned, it must not be false).
     * @param token The token targeted by the call.
     * @param data The call data (encoded using abi.encode or one of its variants).
     *
     * This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
     */
    function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
        // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
        // we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
        // and not revert is the subcall reverts.

        (bool success, bytes memory returndata) = address(token).call(data);
        return
            success && (returndata.length == 0 || abi.decode(returndata, (bool))) && Address.isContract(address(token));
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.1) (proxy/utils/Initializable.sol)

pragma solidity ^0.8.2;

import "../../utils/Address.sol";

/**
 * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
 * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
 * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
 * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
 *
 * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
 * reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
 * case an upgrade adds a module that needs to be initialized.
 *
 * For example:
 *
 * [.hljs-theme-light.nopadding]
 * ```solidity
 * contract MyToken is ERC20Upgradeable {
 *     function initialize() initializer public {
 *         __ERC20_init("MyToken", "MTK");
 *     }
 * }
 *
 * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
 *     function initializeV2() reinitializer(2) public {
 *         __ERC20Permit_init("MyToken");
 *     }
 * }
 * ```
 *
 * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
 * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
 *
 * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
 * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
 *
 * [CAUTION]
 * ====
 * Avoid leaving a contract uninitialized.
 *
 * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
 * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
 * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
 *
 * [.hljs-theme-light.nopadding]
 * ```
 * /// @custom:oz-upgrades-unsafe-allow constructor
 * constructor() {
 *     _disableInitializers();
 * }
 * ```
 * ====
 */
abstract contract Initializable {
    /**
     * @dev Indicates that the contract has been initialized.
     * @custom:oz-retyped-from bool
     */
    uint8 private _initialized;

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

    /**
     * @dev Triggered when the contract has been initialized or reinitialized.
     */
    event Initialized(uint8 version);

    /**
     * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
     * `onlyInitializing` functions can be used to initialize parent contracts.
     *
     * Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
     * constructor.
     *
     * Emits an {Initialized} event.
     */
    modifier initializer() {
        bool isTopLevelCall = !_initializing;
        require(
            (isTopLevelCall && _initialized < 1) || (!Address.isContract(address(this)) && _initialized == 1),
            "Initializable: contract is already initialized"
        );
        _initialized = 1;
        if (isTopLevelCall) {
            _initializing = true;
        }
        _;
        if (isTopLevelCall) {
            _initializing = false;
            emit Initialized(1);
        }
    }

    /**
     * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
     * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
     * used to initialize parent contracts.
     *
     * A reinitializer may be used after the original initialization step. This is essential to configure modules that
     * are added through upgrades and that require initialization.
     *
     * When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
     * cannot be nested. If one is invoked in the context of another, execution will revert.
     *
     * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
     * a contract, executing them in the right order is up to the developer or operator.
     *
     * WARNING: setting the version to 255 will prevent any future reinitialization.
     *
     * Emits an {Initialized} event.
     */
    modifier reinitializer(uint8 version) {
        require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
        _initialized = version;
        _initializing = true;
        _;
        _initializing = false;
        emit Initialized(version);
    }

    /**
     * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
     * {initializer} and {reinitializer} modifiers, directly or indirectly.
     */
    modifier onlyInitializing() {
        require(_initializing, "Initializable: contract is not initializing");
        _;
    }

    /**
     * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
     * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
     * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
     * through proxies.
     *
     * Emits an {Initialized} event the first time it is successfully executed.
     */
    function _disableInitializers() internal virtual {
        require(!_initializing, "Initializable: contract is initializing");
        if (_initialized != type(uint8).max) {
            _initialized = type(uint8).max;
            emit Initialized(type(uint8).max);
        }
    }

    /**
     * @dev Returns the highest version that has been initialized. See {reinitializer}.
     */
    function _getInitializedVersion() internal view returns (uint8) {
        return _initialized;
    }

    /**
     * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
     */
    function _isInitializing() internal view returns (bool) {
        return _initializing;
    }
}

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

interface IEIP712 {
    function DOMAIN_SEPARATOR() external view returns (bytes32);
}

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

import {IERC2981, ERC2981} from "openzeppelin-contracts/token/common/ERC2981.sol";
import {ReentrancyGuardUpgradeable} from "openzeppelin-contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";

import {INFT} from "./interfaces/INFT.sol";
import {INFTInternal} from "./interfaces/INFTInternal.sol";
import {ISaleReadable} from "../../common/readable/ISaleReadable.sol";

/// @custom:audit OpenSea base contract (imported in `seadrop` library) - very few changes
import {ERC721ContractMetadataCloneable} from "./imported/ERC721ContractMetadataCloneable.sol";

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

// import struct
import {Status} from "../../common/SaleStruct.sol";

abstract contract ERC721Base is
    INFT, // 1 inherited component
    INFTInternal, // 1 inherited component
    ERC2981, // 4 inherited components
    ERC721ContractMetadataCloneable, // 7 inherited components
    ReentrancyGuardUpgradeable // 2 inherited components
{
    uint256 public startTokenId;
    address public ino;

    function deleteDefaultRoyalty() external override {
        _onlyOwnerOrSelf();
        _deleteDefaultRoyalty();
    }

    /// @inheritdoc INFT
    function mint(
        address minter,
        uint256 quantity
    ) external virtual override nonReentrant {
        _onlyIno(msg.sender);

        // Extra safety check to ensure the max supply is not exceeded.
        if (_totalMinted() + quantity > maxSupply()) {
            revert ERC721Base_MintQuantityExceedsMaxSupply(
                _totalMinted() + quantity,
                maxSupply()
            );
        }

        // Mint the quantity of tokens to the minter.
        _safeMint(minter, quantity);
    }

    /// @inheritdoc INFT
    function postmintAllUnsold(address receiver) external override onlyOwner {
        _onlyIfInoCompleted();

        uint256 quantity = maxSupply() - _totalMinted();
        _safeMint(receiver, quantity);

        emit MintedAllUnsold(quantity);
    }

    /// @inheritdoc INFT
    function postmintAndReduceSupply(
        address receiver,
        uint256 quantity
    ) external override onlyOwner returns (uint256 reducedBy) {
        _onlyIfInoCompleted();

        uint256 newTotal = _totalMinted() + quantity;
        uint256 oldMaxSupply = _maxSupply;

        if (newTotal > oldMaxSupply) {
            revert ERC721Base_PostmintAndReduceSupply_QuantityExceedsMaxSupply(
                oldMaxSupply,
                newTotal - oldMaxSupply
            );
        }

        reducedBy = oldMaxSupply - newTotal;

        _safeMint(receiver, quantity);
        _setMaxSupply(_totalMinted());

        emit MintedSomeUnsoldAndReducedSupply(quantity, reducedBy, _maxSupply);
    }

    /// @inheritdoc INFT
    function premint(
        address receiver,
        uint256 quantity
    ) external override onlyOwner {
        Status status = ISaleReadable(ino).saleStatus();
        if (status != Status.NOT_STARTED) {
            revert ERC721Base_Premint_INOStarted(status);
        }

        _safeMint(receiver, quantity);

        emit Preminted(receiver, quantity, _startTokenId());
    }

    function resetTokenRoyalty(uint256 tokenId) external override {
        _onlyOwnerOrSelf();
        _resetTokenRoyalty(tokenId);
    }

    function setDefaultRoyalty(
        address receiver,
        uint96 feeNumerator
    ) external override {
        _onlyOwnerOrSelf();

        _setDefaultRoyalty(receiver, feeNumerator);

        emit RoyaltyInfoUpdated(receiver, feeNumerator);
    }

    function setTokenRoyalty(
        uint256 tokenId,
        address receiver,
        uint96 feeNumerator
    ) external override {
        _onlyOwnerOrSelf();

        _setTokenRoyalty(tokenId, receiver, feeNumerator);

        emit TokenRoyaltyInfoUpdated(tokenId, receiver, feeNumerator);
    }

    /// @inheritdoc INFT
    /// @dev Child contract MUST override it to emit an event.
    function initialize(
        INOStorage.NFTCollectionData calldata data,
        address initialOwner,
        address ino_
    ) public virtual override initializer {
        _maxSupply = data.maxCap;
        _tokenBaseURI = data.uri;
        startTokenId = data.startTokenId;
        // init after {startTokenId} is set
        __ERC721ACloneable__init(data.name, data.symbol);
        __ReentrancyGuard_init();
        _transferOwnership(initialOwner);
        ino = ino_;
    }

    /// @inheritdoc ERC721ContractMetadataCloneable
    function setBaseURI(string calldata newBaseURI) public override {
        Status status = ISaleReadable(ino).saleStatus();
        // IF ino is not started OR IF ino is completed AND newBaseURI hash = provenance hash
        if (
            (status == Status.NOT_STARTED) ||
            (status == Status.COMPLETED &&
                keccak256(bytes(newBaseURI)) == _provenanceHash)
        ) super.setBaseURI(newBaseURI);
        else revert ERC721Base_SetBaseURI(status);
    }

    /// @inheritdoc ERC721ContractMetadataCloneable
    function setProvenanceHash(bytes32 newProvenanceHash) public override {
        Status status = ISaleReadable(ino).saleStatus();
        if (status == Status.NOT_STARTED) {
            super.setProvenanceHash(newProvenanceHash);
        } else revert ERC721Base_SetProvenanceHash(status);
    }

    /// @inheritdoc INFT
    function reduceSupplyTo(uint256 newMaxSupply) public override {
        _onlyIfInoCompleted();

        if (newMaxSupply >= _maxSupply) {
            revert ERC721Base_ReduceSupplyTo_NotGreaterEqThan(_maxSupply);
        }
        if (newMaxSupply <= _totalMinted()) {
            revert ERC721Base_ReduceSupplyTo_NotLowerEqThan(_totalMinted());
        }

        emit SupplyReduced(_maxSupply, newMaxSupply);

        _setMaxSupply(newMaxSupply); /// @custom:audit cotains {_onlyOwnerOrSelf()}
    }

    function supportsInterface(
        bytes4 interfaceId
    )
        public
        view
        virtual
        override(ERC721ContractMetadataCloneable, ERC2981)
        returns (bool)
    {
        return
            interfaceId == type(IERC2981).interfaceId ||
            ERC721ContractMetadataCloneable.supportsInterface(interfaceId);
    }

    /// @inheritdoc INFT
    function getMintStats(
        address minter
    )
        external
        view
        override
        returns (
            uint256 minterNumMinted,
            uint256 currentTotalSupply,
            uint256 maxSupply_
        )
    {
        minterNumMinted = _numberMinted(minter);
        currentTotalSupply = _totalMinted();
        maxSupply_ = _maxSupply;
    }

    function _onlyIno(address minter) internal view {
        if (minter != ino) {
            revert ERC721Base_InoOnlyApprovedMinter();
        }
    }

    function _onlyIfInoCompleted() internal view {
        Status status = ISaleReadable(ino).saleStatus();
        if (status != Status.COMPLETED) {
            revert ERC721Base_OnlyIfInoCompleted(status);
        }
    }

    function _startTokenId() internal view override returns (uint256) {
        return startTokenId;
    }
}

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

pragma solidity ^0.8.0;

/**
 * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
 * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
 *
 * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
 * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
 * need to send a transaction, and thus is not required to hold Ether at all.
 */
interface IERC20Permit {
    /**
     * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
     * given ``owner``'s signed approval.
     *
     * IMPORTANT: The same issues {IERC20-approve} has related to transaction
     * ordering also apply here.
     *
     * Emits an {Approval} event.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     * - `deadline` must be a timestamp in the future.
     * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
     * over the EIP712-formatted function arguments.
     * - the signature must use ``owner``'s current nonce (see {nonces}).
     *
     * For more information on the signature format, see the
     * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
     * section].
     */
    function permit(
        address owner,
        address spender,
        uint256 value,
        uint256 deadline,
        uint8 v,
        bytes32 r,
        bytes32 s
    ) external;

    /**
     * @dev Returns the current nonce for `owner`. This value must be
     * included whenever a signature is generated for {permit}.
     *
     * Every successful call to {permit} increases ``owner``'s nonce by one. This
     * prevents a signature from being used multiple times.
     */
    function nonces(address owner) external view returns (uint256);

    /**
     * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
     */
    // solhint-disable-next-line func-name-mixedcase
    function DOMAIN_SEPARATOR() external view returns (bytes32);
}

// 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
     *
     * Furthermore, `isContract` will also return true if the target contract within
     * the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
     * which only has an effect at the end of a transaction.
     * ====
     *
     * [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://consensys.net/diligence/blog/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
// 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.9.0) (security/ReentrancyGuard.sol)

pragma solidity ^0.8.0;
import "../proxy/utils/Initializable.sol";

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

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

    uint256 private _status;

    function __ReentrancyGuard_init() internal onlyInitializing {
        __ReentrancyGuard_init_unchained();
    }

    function __ReentrancyGuard_init_unchained() internal onlyInitializing {
        _status = _NOT_ENTERED;
    }

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

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

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

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

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

    /**
     * @dev This empty reserved space is put in place to allow future versions to add new
     * variables without shifting down storage in the inheritance chain.
     * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
     */
    uint256[49] private __gap;
}

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

import {Status} from "../../../common/SaleStruct.sol";

/**
 * @title INFTInternal
 * @notice Define enum, struct, event and errors used by NFTs listed in INOs.
 */
interface INFTInternal {
    /// @ notice Define the type of NFT according to INO needs.
    enum Type {
        Sequential,
        RandomisedUri,
        ConfigRoyalty
    }

    /// @notice Thrown when someone other than the INO tries to mint.
    error ERC721Base_InoOnlyApprovedMinter();
    /// @notice Thrown when trying to mint more than maximum supply.
    error ERC721Base_MintQuantityExceedsMaxSupply(
        uint256 total,
        uint256 maxSupply
    );
    /// @notice Thrown when trying to make an action BUT INO is not completed.
    error ERC721Base_OnlyIfInoCompleted(Status current);
    error ERC721Base_PostmintAndReduceSupply_QuantityExceedsMaxSupply(
        uint256 maxSupply,
        uint256 exceededBy
    );
    /// @notice Thrown when trying to premint wheras INO already started, even if paused.
    error ERC721Base_Premint_INOStarted(Status current);
    /// @notice Thrown when updating provenance hash once INO is opened, paused or closed.
    error ERC721Base_SetProvenanceHash(Status current);
    /**
     * @notice Thrown when updating base URI once INO is opened, paused or closed, except if reveal date
     *         and new uri equls provenan hash.
     */
    error ERC721Base_SetBaseURI(Status current);
    /// @notice Thrown when trying to increase maximum supply.
    error ERC721Base_ReduceSupplyTo_NotGreaterEqThan(uint256 maxSupply);
    /// @notice Thrown when trying to decrease maximum supply below total quantity supply.
    error ERC721Base_ReduceSupplyTo_NotLowerEqThan(uint256 totalSupply);

    event MintedAllUnsold(uint256 indexed quantity);
    event MintedSomeUnsoldAndReducedSupply(
        uint256 indexed quantity,
        uint256 indexed reducedBy,
        uint256 indexed newSupply
    );
    event NFTDeployed(
        Type indexed nftType,
        address indexed initialOwner,
        string indexed name,
        string symbol
    );
    event Preminted(
        address indexed receiver,
        uint256 indexed quantity,
        uint256 indexed startTokenId
    );
    /// @dev Emit an event when the royalties info is updated.
    event RoyaltyInfoUpdated(address receiver, uint256 bps);
    /// @dev Emit an event when the royalties info for a token is updated.
    event TokenRoyaltyInfoUpdated(
        uint256 tokenId,
        address receiver,
        uint256 bps
    );
    event SupplyReduced(uint256 indexed oldSupply, uint256 indexed newSupply);
}

// SPDX-License-Identifier: MIT
pragma solidity 0.8.23;

import {IERC165} from "openzeppelin-contracts/utils/introspection/IERC165.sol";

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

import {ERC721ACloneable} from "seadrop/src/clones/ERC721ACloneable.sol";

import {TwoStepOwnable} from "utility-contracts/TwoStepOwnable.sol";

/**
 * @title  ERC721ContractMetadataCloneable
 * @author James Wenzel (emo.eth)
 * @author Ryan Ghods (ralxz.eth)
 * @author Stephan Min (stephanm.eth)
 * @notice ERC721ContractMetadata is a token contract that extends ERC721A
 *         with additional metadata and ownership capabilities.
 *
 * @custom:audit Only changes from base contract in `seadrop` library are located in {setBaseURI} and
 *               {_setMaxSupply}.
 */
abstract contract ERC721ContractMetadataCloneable is
    ERC721ACloneable, // 3 inherited components
    TwoStepOwnable, // 2 inherited components
    INFTContractMetadata // 1 inherited component
{
    /// @notice Track the max supply.
    uint256 _maxSupply;

    /// @notice Track the base URI for token metadata.
    string _tokenBaseURI;

    /// @notice Track the contract URI for contract metadata.
    string _contractURI;

    /// @notice Track the provenance hash for guaranteeing metadata order
    ///         for random reveals.
    /// @custom:audit Made `internal` compared to `seadrop` library.
    bytes32 internal _provenanceHash;

    /**
     * @dev Reverts if the sender is not the owner or the contract itself.
     *      This function is inlined instead of being a modifier
     *      to save contract space from being inlined N times.
     */
    function _onlyOwnerOrSelf() internal view {
        if (
            _cast(msg.sender == owner()) |
                _cast(msg.sender == address(this)) ==
            0
        ) {
            revert OnlyOwner();
        }
    }

    /**
     * @notice Sets the base URI for the token metadata and emits an event.
     *
     * @param newBaseURI The new base URI to set.
     *
     * @custom:audit Only changed visibility function (external to public) + `virtual` keyword compared
     *               to `seadrop` library.
     *               Made public to call through {super.setBaseURI}
     */
    function setBaseURI(string calldata newBaseURI) public virtual override {
        // Ensure the sender is only the owner or contract itself.
        _onlyOwnerOrSelf();

        // Set the new base URI.
        _tokenBaseURI = newBaseURI;

        // Emit an event with the update.
        if (totalSupply() != 0) {
            emit BatchMetadataUpdate(_startTokenId(), _nextTokenId() - 1);
        }
    }

    /**
     * @notice Sets the contract URI for contract metadata.
     *
     * @param newContractURI The new contract URI.
     */
    function setContractURI(string calldata newContractURI) external override {
        // Ensure the sender is only the owner or contract itself.
        _onlyOwnerOrSelf();

        // Set the new contract URI.
        _contractURI = newContractURI;

        // Emit an event with the update.
        emit ContractURIUpdated(newContractURI);
    }

    /**
     * @notice Emit an event notifying metadata updates for
     *         a range of token ids, according to EIP-4906.
     *
     * @param fromTokenId The start token id.
     * @param toTokenId   The end token id.
     */
    function emitBatchMetadataUpdate(
        uint256 fromTokenId,
        uint256 toTokenId
    ) external {
        // Ensure the sender is only the owner or contract itself.
        _onlyOwnerOrSelf();

        // Emit an event with the update.
        emit BatchMetadataUpdate(fromTokenId, toTokenId);
    }

    /**
     * @notice Sets the max token supply and emits an event.
     *
     * @param newMaxSupply The new max supply to set.
     *
     *
     * @custom:audit Only changed visibility function (external to internal) compared
     *               to `seadrop` library.
     */
    function _setMaxSupply(uint256 newMaxSupply) internal {
        // Ensure the sender is only the owner or contract itself.
        _onlyOwnerOrSelf();

        // Ensure the max supply does not exceed the maximum value of uint64.
        if (newMaxSupply > 2 ** 64 - 1) {
            revert CannotExceedMaxSupplyOfUint64(newMaxSupply);
        }

        // Set the new max supply.
        _maxSupply = newMaxSupply;

        // Emit an event with the update.
        emit MaxSupplyUpdated(newMaxSupply);
    }

    /**
     * @notice Sets the provenance hash and emits an event.
     *
     *         The provenance hash is used for random reveals, which
     *         is a hash of the ordered metadata to show it has not been
     *         modified after mint started.
     *
     *         In INO case, only useful for mint strategies with reveal date. Blackbox and reveal on mint
     *         will not use this.
     *
     *         This function will revert after the first item has been minted.
     *
     * @param newProvenanceHash The new provenance hash to set.
     *
     *
     * @custom:audit Only added `virtual` and changed from `external` to `public` compared to `seadrop`
     *               library.
     */
    function setProvenanceHash(bytes32 newProvenanceHash) public virtual {
        // Ensure the sender is only the owner or contract itself.
        _onlyOwnerOrSelf();

        // Revert if any items have been minted.
        if (_totalMinted() > 0) {
            revert ProvenanceHashCannotBeSetAfterMintStarted();
        }

        // Keep track of the old provenance hash for emitting with the event.
        bytes32 oldProvenanceHash = _provenanceHash;

        // Set the new provenance hash.
        _provenanceHash = newProvenanceHash;

        // Emit an event with the update.
        emit ProvenanceHashUpdated(oldProvenanceHash, newProvenanceHash);
    }

    /**
     * @notice Returns the base URI for token metadata.
     */
    function baseURI() external view override returns (string memory) {
        return _baseURI();
    }

    /**
     * @notice Returns the base URI for the contract, which ERC721A uses
     *         to return tokenURI.
     */
    function _baseURI()
        internal
        view
        virtual
        override
        returns (string memory)
    {
        return _tokenBaseURI;
    }

    /**
     * @notice Returns the contract URI for contract metadata.
     */
    function contractURI() external view override returns (string memory) {
        return _contractURI;
    }

    /**
     * @notice Returns the max token supply.
     */
    function maxSupply() public view returns (uint256) {
        return _maxSupply;
    }

    /**
     * @notice Returns the provenance hash.
     *         The provenance hash is used for random reveals, which
     *         is a hash of the ordered metadata to show it is unmodified
     *         after mint has started.
     */
    function provenanceHash() external view override returns (bytes32) {
        return _provenanceHash;
    }

    /**
     * @notice Returns whether the interface is supported.
     *
     * @param interfaceId The interface id to check against.
     */
    function supportsInterface(
        bytes4 interfaceId
    ) public view virtual override(ERC721ACloneable) returns (bool) {
        return
            interfaceId == 0x49064906 || // ERC-4906
            super.supportsInterface(interfaceId);
    }

    /**
     * @dev Internal pure function to cast a `bool` value to a `uint256` value.
     *
     * @param b The `bool` value to cast.
     *
     * @return u The `uint256` value.
     */
    function _cast(bool b) internal pure returns (uint256 u) {
        assembly {
            u := b
        }
    }
}

// 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.9.0) (proxy/utils/Initializable.sol)

pragma solidity ^0.8.2;

import "../../utils/AddressUpgradeable.sol";

/**
 * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
 * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
 * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
 * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
 *
 * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
 * reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
 * case an upgrade adds a module that needs to be initialized.
 *
 * For example:
 *
 * [.hljs-theme-light.nopadding]
 * ```solidity
 * contract MyToken is ERC20Upgradeable {
 *     function initialize() initializer public {
 *         __ERC20_init("MyToken", "MTK");
 *     }
 * }
 *
 * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
 *     function initializeV2() reinitializer(2) public {
 *         __ERC20Permit_init("MyToken");
 *     }
 * }
 * ```
 *
 * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
 * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
 *
 * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
 * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
 *
 * [CAUTION]
 * ====
 * Avoid leaving a contract uninitialized.
 *
 * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
 * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
 * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
 *
 * [.hljs-theme-light.nopadding]
 * ```
 * /// @custom:oz-upgrades-unsafe-allow constructor
 * constructor() {
 *     _disableInitializers();
 * }
 * ```
 * ====
 */
abstract contract Initializable {
    /**
     * @dev Indicates that the contract has been initialized.
     * @custom:oz-retyped-from bool
     */
    uint8 private _initialized;

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

    /**
     * @dev Triggered when the contract has been initialized or reinitialized.
     */
    event Initialized(uint8 version);

    /**
     * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
     * `onlyInitializing` functions can be used to initialize parent contracts.
     *
     * Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
     * constructor.
     *
     * Emits an {Initialized} event.
     */
    modifier initializer() {
        bool isTopLevelCall = !_initializing;
        require(
            (isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
            "Initializable: contract is already initialized"
        );
        _initialized = 1;
        if (isTopLevelCall) {
            _initializing = true;
        }
        _;
        if (isTopLevelCall) {
            _initializing = false;
            emit Initialized(1);
        }
    }

    /**
     * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
     * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
     * used to initialize parent contracts.
     *
     * A reinitializer may be used after the original initialization step. This is essential to configure modules that
     * are added through upgrades and that require initialization.
     *
     * When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
     * cannot be nested. If one is invoked in the context of another, execution will revert.
     *
     * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
     * a contract, executing them in the right order is up to the developer or operator.
     *
     * WARNING: setting the version to 255 will prevent any future reinitialization.
     *
     * Emits an {Initialized} event.
     */
    modifier reinitializer(uint8 version) {
        require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
        _initialized = version;
        _initializing = true;
        _;
        _initializing = false;
        emit Initialized(version);
    }

    /**
     * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
     * {initializer} and {reinitializer} modifiers, directly or indirectly.
     */
    modifier onlyInitializing() {
        require(_initializing, "Initializable: contract is not initializing");
        _;
    }

    /**
     * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
     * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
     * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
     * through proxies.
     *
     * Emits an {Initialized} event the first time it is successfully executed.
     */
    function _disableInitializers() internal virtual {
        require(!_initializing, "Initializable: contract is initializing");
        if (_initialized != type(uint8).max) {
            _initialized = type(uint8).max;
            emit Initialized(type(uint8).max);
        }
    }

    /**
     * @dev Returns the highest version that has been initialized. See {reinitializer}.
     */
    function _getInitializedVersion() internal view returns (uint8) {
        return _initialized;
    }

    /**
     * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
     */
    function _isInitializing() internal view returns (bool) {
        return _initializing;
    }
}

// SPDX-License-Identifier: MIT
pragma solidity 0.8.23;

/**
 * @custom:audit Changes from base contract `seadrop/src/interfaces/ISeaDropTokenContractMetadata.sol`:
 * - deleted {setMaxSupply},
 * - deleted everything related to royalties.
 */
interface INFTContractMetadata {
    /**
     * @notice Throw if the max supply exceeds uint64, a limit
     *         due to the storage of bit-packed variables in ERC721A.
     */
    error CannotExceedMaxSupplyOfUint64(uint256 newMaxSupply);

    /**
     * @dev Revert with an error when attempting to set the provenance
     *      hash after the mint has started.
     */
    error ProvenanceHashCannotBeSetAfterMintStarted();

    /**
     * @dev Emit an event for token metadata reveals/updates,
     *      according to EIP-4906.
     *
     * @param _fromTokenId The start token id.
     * @param _toTokenId   The end token id.
     */
    event BatchMetadataUpdate(uint256 _fromTokenId, uint256 _toTokenId);

    /**
     * @dev Emit an event when the URI for the collection-level metadata
     *      is updated.
     */
    event ContractURIUpdated(string newContractURI);

    /**
     * @dev Emit an event when the max token supply is updated.
     */
    event MaxSupplyUpdated(uint256 newMaxSupply);

    /**
     * @dev Emit an event with the previous and new provenance hash after
     *      being updated.
     */
    event ProvenanceHashUpdated(bytes32 previousHash, bytes32 newHash);

    /**
     * @notice Sets the base URI for the token metadata and emits an event.
     *
     * @param tokenURI The new base URI to set.
     */
    function setBaseURI(string calldata tokenURI) external;

    /**
     * @notice Sets the contract URI for contract metadata.
     *
     * @param newContractURI The new contract URI.
     */
    function setContractURI(string calldata newContractURI) external;

    /**
     * @notice Sets the provenance hash and emits an event.
     *
     *         The provenance hash is used for random reveals, which
     *         is a hash of the ordered metadata to show it has not been
     *         modified after mint started.
     *
     *         This function will revert after the first item has been minted.
     *
     * @param newProvenanceHash The new provenance hash to set.
     */
    function setProvenanceHash(bytes32 newProvenanceHash) external;

    /**
     * @notice Returns the base URI for token metadata.
     */
    function baseURI() external view returns (string memory);

    /**
     * @notice Returns the contract URI.
     */
    function contractURI() external view returns (string memory);

    /**
     * @notice Returns the max token supply.
     */
    function maxSupply() external view returns (uint256);

    /**
     * @notice Returns the provenance hash.
     *         The provenance hash is used for random reveals, which
     *         is a hash of the ordered metadata to show it is unmodified
     *         after mint has started.
     */
    function provenanceHash() external view returns (bytes32);
}

// SPDX-License-Identifier: MIT
// ERC721A Contracts v4.2.2
// Creator: Chiru Labs

pragma solidity ^0.8.4;

import { IERC721A } from "ERC721A/IERC721A.sol";

import {
    Initializable
} from "openzeppelin-contracts-upgradeable/proxy/utils/Initializable.sol";

/**
 * @dev Interface of ERC721 token receiver.
 */
interface ERC721A__IERC721Receiver {
    function onERC721Received(
        address operator,
        address from,
        uint256 tokenId,
        bytes calldata data
    ) external returns (bytes4);
}

/**
 * @title ERC721A
 *
 * @dev Implementation of the [ERC721](https://eips.ethereum.org/EIPS/eip-721)
 * Non-Fungible Token Standard, including the Metadata extension.
 * Optimized for lower gas during batch mints.
 *
 * Token IDs are minted in sequential order (e.g. 0, 1, 2, 3, ...)
 * starting from `_startTokenId()`.
 *
 * Assumptions:
 *
 * - An owner cannot have more than 2**64 - 1 (max value of uint64) of supply.
 * - The maximum token ID cannot exceed 2**256 - 1 (max value of uint256).
 */
contract ERC721ACloneable is IERC721A, Initializable {
    // Bypass for a `--via-ir` bug (https://github.com/chiru-labs/ERC721A/pull/364).
    struct TokenApprovalRef {
        address value;
    }

    // =============================================================
    //                           CONSTANTS
    // =============================================================

    // Mask of an entry in packed address data.
    uint256 private constant _BITMASK_ADDRESS_DATA_ENTRY = (1 << 64) - 1;

    // The bit position of `numberMinted` in packed address data.
    uint256 private constant _BITPOS_NUMBER_MINTED = 64;

    // The bit position of `numberBurned` in packed address data.
    uint256 private constant _BITPOS_NUMBER_BURNED = 128;

    // The bit position of `aux` in packed address data.
    uint256 private constant _BITPOS_AUX = 192;

    // Mask of all 256 bits in packed address data except the 64 bits for `aux`.
    uint256 private constant _BITMASK_AUX_COMPLEMENT = (1 << 192) - 1;

    // The bit position of `startTimestamp` in packed ownership.
    uint256 private constant _BITPOS_START_TIMESTAMP = 160;

    // The bit mask of the `burned` bit in packed ownership.
    uint256 private constant _BITMASK_BURNED = 1 << 224;

    // The bit position of the `nextInitialized` bit in packed ownership.
    uint256 private constant _BITPOS_NEXT_INITIALIZED = 225;

    // The bit mask of the `nextInitialized` bit in packed ownership.
    uint256 private constant _BITMASK_NEXT_INITIALIZED = 1 << 225;

    // The bit position of `extraData` in packed ownership.
    uint256 private constant _BITPOS_EXTRA_DATA = 232;

    // Mask of all 256 bits in a packed ownership except the 24 bits for `extraData`.
    uint256 private constant _BITMASK_EXTRA_DATA_COMPLEMENT = (1 << 232) - 1;

    // The mask of the lower 160 bits for addresses.
    uint256 private constant _BITMASK_ADDRESS = (1 << 160) - 1;

    // The maximum `quantity` that can be minted with {_mintERC2309}.
    // This limit is to prevent overflows on the address data entries.
    // For a limit of 5000, a total of 3.689e15 calls to {_mintERC2309}
    // is required to cause an overflow, which is unrealistic.
    uint256 private constant _MAX_MINT_ERC2309_QUANTITY_LIMIT = 5000;

    // The `Transfer` event signature is given by:
    // `keccak256(bytes("Transfer(address,address,uint256)"))`.
    bytes32 private constant _TRANSFER_EVENT_SIGNATURE =
        0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef;

    // =============================================================
    //                            STORAGE
    // =============================================================

    // The next token ID to be minted.
    uint256 private _currentIndex;

    // The number of tokens burned.
    uint256 private _burnCounter;

    // Token name
    string private _name;

    // Token symbol
    string private _symbol;

    // Mapping from token ID to ownership details
    // An empty struct value does not necessarily mean the token is unowned.
    // See {_packedOwnershipOf} implementation for details.
    //
    // Bits Layout:
    // - [0..159]   `addr`
    // - [160..223] `startTimestamp`
    // - [224]      `burned`
    // - [225]      `nextInitialized`
    // - [232..255] `extraData`
    mapping(uint256 => uint256) private _packedOwnerships;

    // Mapping owner address to address data.
    //
    // Bits Layout:
    // - [0..63]    `balance`
    // - [64..127]  `numberMinted`
    // - [128..191] `numberBurned`
    // - [192..255] `aux`
    mapping(address => uint256) private _packedAddressData;

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

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

    // =============================================================
    //                          CONSTRUCTOR
    // =============================================================

    function __ERC721ACloneable__init(
        string memory name_,
        string memory symbol_
    ) internal onlyInitializing {
        _name = name_;
        _symbol = symbol_;
        _currentIndex = _startTokenId();
    }

    // =============================================================
    //                   TOKEN COUNTING OPERATIONS
    // =============================================================

    /**
     * @dev Returns the starting token ID.
     * To change the starting token ID, please override this function.
     */
    function _startTokenId() internal view virtual returns (uint256) {
        return 0;
    }

    /**
     * @dev Returns the next token ID to be minted.
     */
    function _nextTokenId() internal view virtual returns (uint256) {
        return _currentIndex;
    }

    /**
     * @dev Returns the total number of tokens in existence.
     * Burned tokens will reduce the count.
     * To get the total number of tokens minted, please see {_totalMinted}.
     */
    function totalSupply() public view virtual override returns (uint256) {
        // Counter underflow is impossible as _burnCounter cannot be incremented
        // more than `_currentIndex - _startTokenId()` times.
        unchecked {
            return _currentIndex - _burnCounter - _startTokenId();
        }
    }

    /**
     * @dev Returns the total amount of tokens minted in the contract.
     */
    function _totalMinted() internal view virtual returns (uint256) {
        // Counter underflow is impossible as `_currentIndex` does not decrement,
        // and it is initialized to `_startTokenId()`.
        unchecked {
            return _currentIndex - _startTokenId();
        }
    }

    /**
     * @dev Returns the total number of tokens burned.
     */
    function _totalBurned() internal view virtual returns (uint256) {
        return _burnCounter;
    }

    // =============================================================
    //                    ADDRESS DATA OPERATIONS
    // =============================================================

    /**
     * @dev Returns the number of tokens in `owner`'s account.
     */
    function balanceOf(address owner)
        public
        view
        virtual
        override
        returns (uint256)
    {
        if (owner == address(0)) revert BalanceQueryForZeroAddress();
        return _packedAddressData[owner] & _BITMASK_ADDRESS_DATA_ENTRY;
    }

    /**
     * Returns the number of tokens minted by `owner`.
     */
    function _numberMinted(address owner) internal view returns (uint256) {
        return
            (_packedAddressData[owner] >> _BITPOS_NUMBER_MINTED) &
            _BITMASK_ADDRESS_DATA_ENTRY;
    }

    /**
     * Returns the number of tokens burned by or on behalf of `owner`.
     */
    function _numberBurned(address owner) internal view returns (uint256) {
        return
            (_packedAddressData[owner] >> _BITPOS_NUMBER_BURNED) &
            _BITMASK_ADDRESS_DATA_ENTRY;
    }

    /**
     * Returns the auxiliary data for `owner`. (e.g. number of whitelist mint slots used).
     */
    function _getAux(address owner) internal view returns (uint64) {
        return uint64(_packedAddressData[owner] >> _BITPOS_AUX);
    }

    /**
     * Sets the auxiliary data for `owner`. (e.g. number of whitelist mint slots used).
     * If there are multiple variables, please pack them into a uint64.
     */
    function _setAux(address owner, uint64 aux) internal virtual {
        uint256 packed = _packedAddressData[owner];
        uint256 auxCasted;
        // Cast `aux` with assembly to avoid redundant masking.
        assembly {
            auxCasted := aux
        }
        packed =
            (packed & _BITMASK_AUX_COMPLEMENT) |
            (auxCasted << _BITPOS_AUX);
        _packedAddressData[owner] = packed;
    }

    // =============================================================
    //                            IERC165
    // =============================================================

    /**
     * @dev Returns true if this contract implements the interface defined by
     * `interfaceId`. See the corresponding
     * [EIP section](https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified)
     * to learn more about how these ids are created.
     *
     * This function call must use less than 30000 gas.
     */
    function supportsInterface(bytes4 interfaceId)
        public
        view
        virtual
        override
        returns (bool)
    {
        // The interface IDs are constants representing the first 4 bytes
        // of the XOR of all function selectors in the interface.
        // See: [ERC165](https://eips.ethereum.org/EIPS/eip-165)
        // (e.g. `bytes4(i.functionA.selector ^ i.functionB.selector ^ ...)`)
        return
            interfaceId == 0x01ffc9a7 || // ERC165 interface ID for ERC165.
            interfaceId == 0x80ac58cd || // ERC165 interface ID for ERC721.
            interfaceId == 0x5b5e139f; // ERC165 interface ID for ERC721Metadata.
    }

    // =============================================================
    //                        IERC721Metadata
    // =============================================================

    /**
     * @dev Returns the token collection name.
     */
    function name() public view virtual override returns (string memory) {
        return _name;
    }

    /**
     * @dev Returns the token collection symbol.
     */
    function symbol() public view virtual override returns (string memory) {
        return _symbol;
    }

    /**
     * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
     */
    function tokenURI(uint256 tokenId)
        public
        view
        virtual
        override
        returns (string memory)
    {
        if (!_exists(tokenId)) revert URIQueryForNonexistentToken();

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

    /**
     * @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, it can be overridden in child contracts.
     */
    function _baseURI() internal view virtual returns (string memory) {
        return "";
    }

    // =============================================================
    //                     OWNERSHIPS OPERATIONS
    // =============================================================

    /**
     * @dev Returns the owner of the `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function ownerOf(uint256 tokenId)
        public
        view
        virtual
        override
        returns (address)
    {
        return address(uint160(_packedOwnershipOf(tokenId)));
    }

    /**
     * @dev Gas spent here starts off proportional to the maximum mint batch size.
     * It gradually moves to O(1) as tokens get transferred around over time.
     */
    function _ownershipOf(uint256 tokenId)
        internal
        view
        virtual
        returns (TokenOwnership memory)
    {
        return _unpackedOwnership(_packedOwnershipOf(tokenId));
    }

    /**
     * @dev Returns the unpacked `TokenOwnership` struct at `index`.
     */
    function _ownershipAt(uint256 index)
        internal
        view
        virtual
        returns (TokenOwnership memory)
    {
        return _unpackedOwnership(_packedOwnerships[index]);
    }

    /**
     * @dev Initializes the ownership slot minted at `index` for efficiency purposes.
     */
    function _initializeOwnershipAt(uint256 index) internal virtual {
        if (_packedOwnerships[index] == 0) {
            _packedOwnerships[index] = _packedOwnershipOf(index);
        }
    }

    /**
     * Returns the packed ownership data of `tokenId`.
     */
    function _packedOwnershipOf(uint256 tokenId)
        private
        view
        returns (uint256)
    {
        uint256 curr = tokenId;

        unchecked {
            if (_startTokenId() <= curr) {
                if (curr < _currentIndex) {
                    uint256 packed = _packedOwnerships[curr];
                    // If not burned.
                    if (packed & _BITMASK_BURNED == 0) {
                        // Invariant:
                        // There will always be an initialized ownership slot
                        // (i.e. `ownership.addr != address(0) && ownership.burned == false`)
                        // before an unintialized ownership slot
                        // (i.e. `ownership.addr == address(0) && ownership.burned == false`)
                        // Hence, `curr` will not underflow.
                        //
                        // We can directly compare the packed value.
                        // If the address is zero, packed will be zero.
                        while (packed == 0) {
                            packed = _packedOwnerships[--curr];
                        }
                        return packed;
                    }
                }
            }
        }
        revert OwnerQueryForNonexistentToken();
    }

    /**
     * @dev Returns the unpacked `TokenOwnership` struct from `packed`.
     */
    function _unpackedOwnership(uint256 packed)
        private
        pure
        returns (TokenOwnership memory ownership)
    {
        ownership.addr = address(uint160(packed));
        ownership.startTimestamp = uint64(packed >> _BITPOS_START_TIMESTAMP);
        ownership.burned = packed & _BITMASK_BURNED != 0;
        ownership.extraData = uint24(packed >> _BITPOS_EXTRA_DATA);
    }

    /**
     * @dev Packs ownership data into a single uint256.
     */
    function _packOwnershipData(address owner, uint256 flags)
        private
        view
        returns (uint256 result)
    {
        assembly {
            // Mask `owner` to the lower 160 bits, in case the upper bits somehow aren't clean.
            owner := and(owner, _BITMASK_ADDRESS)
            // `owner | (block.timestamp << _BITPOS_START_TIMESTAMP) | flags`.
            result := or(
                owner,
                or(shl(_BITPOS_START_TIMESTAMP, timestamp()), flags)
            )
        }
    }

    /**
     * @dev Returns the `nextInitialized` flag set if `quantity` equals 1.
     */
    function _nextInitializedFlag(uint256 quantity)
        private
        pure
        returns (uint256 result)
    {
        // For branchless setting of the `nextInitialized` flag.
        assembly {
            // `(quantity == 1) << _BITPOS_NEXT_INITIALIZED`.
            result := shl(_BITPOS_NEXT_INITIALIZED, eq(quantity, 1))
        }
    }

    // =============================================================
    //                      APPROVAL OPERATIONS
    // =============================================================

    /**
     * @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) public virtual override {
        address owner = ownerOf(tokenId);

        if (_msgSenderERC721A() != owner) {
            if (!isApprovedForAll(owner, _msgSenderERC721A())) {
                revert ApprovalCallerNotOwnerNorApproved();
            }
        }

        _tokenApprovals[tokenId].value = to;
        emit Approval(owner, to, tokenId);
    }

    /**
     * @dev Returns the account approved for `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function getApproved(uint256 tokenId)
        public
        view
        virtual
        override
        returns (address)
    {
        if (!_exists(tokenId)) revert ApprovalQueryForNonexistentToken();

        return _tokenApprovals[tokenId].value;
    }

    /**
     * @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)
        public
        virtual
        override
    {
        _operatorApprovals[_msgSenderERC721A()][operator] = approved;
        emit ApprovalForAll(_msgSenderERC721A(), operator, approved);
    }

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

    /**
     * @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. See {_mint}.
     */
    function _exists(uint256 tokenId) internal view virtual returns (bool) {
        return
            _startTokenId() <= tokenId &&
            tokenId < _currentIndex && // If within bounds,
            _packedOwnerships[tokenId] & _BITMASK_BURNED == 0; // and not burned.
    }

    /**
     * @dev Returns whether `msgSender` is equal to `approvedAddress` or `owner`.
     */
    function _isSenderApprovedOrOwner(
        address approvedAddress,
        address owner,
        address msgSender
    ) private pure returns (bool result) {
        assembly {
            // Mask `owner` to the lower 160 bits, in case the upper bits somehow aren't clean.
            owner := and(owner, _BITMASK_ADDRESS)
            // Mask `msgSender` to the lower 160 bits, in case the upper bits somehow aren't clean.
            msgSender := and(msgSender, _BITMASK_ADDRESS)
            // `msgSender == owner || msgSender == approvedAddress`.
            result := or(eq(msgSender, owner), eq(msgSender, approvedAddress))
        }
    }

    /**
     * @dev Returns the storage slot and value for the approved address of `tokenId`.
     */
    function _getApprovedSlotAndAddress(uint256 tokenId)
        private
        view
        returns (uint256 approvedAddressSlot, address approvedAddress)
    {
        TokenApprovalRef storage tokenApproval = _tokenApprovals[tokenId];
        // The following is equivalent to `approvedAddress = _tokenApprovals[tokenId].value`.
        assembly {
            approvedAddressSlot := tokenApproval.slot
            approvedAddress := sload(approvedAddressSlot)
        }
    }

    // =============================================================
    //                      TRANSFER OPERATIONS
    // =============================================================

    /**
     * @dev Transfers `tokenId` from `from` to `to`.
     *
     * 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
    ) public virtual override {
        uint256 prevOwnershipPacked = _packedOwnershipOf(tokenId);

        if (address(uint160(prevOwnershipPacked)) != from)
            revert TransferFromIncorrectOwner();

        (
            uint256 approvedAddressSlot,
            address approvedAddress
        ) = _getApprovedSlotAndAddress(tokenId);

        // The nested ifs save around 20+ gas over a compound boolean condition.
        if (
            !_isSenderApprovedOrOwner(
                approvedAddress,
                from,
                _msgSenderERC721A()
            )
        ) {
            if (!isApprovedForAll(from, _msgSenderERC721A()))
                revert TransferCallerNotOwnerNorApproved();
        }

        if (to == address(0)) revert TransferToZeroAddress();

        _beforeTokenTransfers(from, to, tokenId, 1);

        // Clear approvals from the previous owner.
        assembly {
            if approvedAddress {
                // This is equivalent to `delete _tokenApprovals[tokenId]`.
                sstore(approvedAddressSlot, 0)
            }
        }

        // Underflow of the sender's balance is impossible because we check for
        // ownership above and the recipient's balance can't realistically overflow.
        // Counter overflow is incredibly unrealistic as `tokenId` would have to be 2**256.
        unchecked {
            // We can directly increment and decrement the balances.
            --_packedAddressData[from]; // Updates: `balance -= 1`.
            ++_packedAddressData[to]; // Updates: `balance += 1`.

            // Updates:
            // - `address` to the next owner.
            // - `startTimestamp` to the timestamp of transfering.
            // - `burned` to `false`.
            // - `nextInitialized` to `true`.
            _packedOwnerships[tokenId] = _packOwnershipData(
                to,
                _BITMASK_NEXT_INITIALIZED |
                    _nextExtraData(from, to, prevOwnershipPacked)
            );

            // If the next slot may not have been initialized (i.e. `nextInitialized == false`) .
            if (prevOwnershipPacked & _BITMASK_NEXT_INITIALIZED == 0) {
                uint256 nextTokenId = tokenId + 1;
                // If the next slot's address is zero and not burned (i.e. packed value is zero).
                if (_packedOwnerships[nextTokenId] == 0) {
                    // If the next slot is within bounds.
                    if (nextTokenId != _currentIndex) {
                        // Initialize the next slot to maintain correctness for `ownerOf(tokenId + 1)`.
                        _packedOwnerships[nextTokenId] = prevOwnershipPacked;
                    }
                }
            }
        }

        emit Transfer(from, to, tokenId);
        _afterTokenTransfers(from, to, tokenId, 1);
    }

    /**
     * @dev Equivalent to `safeTransferFrom(from, to, tokenId, '')`.
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 tokenId
    ) public virtual override {
        safeTransferFrom(from, to, tokenId, "");
    }

    /**
     * @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 memory _data
    ) public virtual override {
        transferFrom(from, to, tokenId);
        if (to.code.length != 0) {
            if (!_checkContractOnERC721Received(from, to, tokenId, _data)) {
                revert TransferToNonERC721ReceiverImplementer();
            }
        }
    }

    /**
     * @dev Hook that is called before a set of serially-ordered token IDs
     * are about to be transferred. This includes minting.
     * And also called before burning one token.
     *
     * `startTokenId` - the first token ID to be transferred.
     * `quantity` - the amount to be transferred.
     *
     * Calling conditions:
     *
     * - When `from` and `to` are both non-zero, `from`'s `tokenId` will be
     * transferred to `to`.
     * - When `from` is zero, `tokenId` will be minted for `to`.
     * - When `to` is zero, `tokenId` will be burned by `from`.
     * - `from` and `to` are never both zero.
     */
    function _beforeTokenTransfers(
        address from,
        address to,
        uint256 startTokenId,
        uint256 quantity
    ) internal virtual {}

    /**
     * @dev Hook that is called after a set of serially-ordered token IDs
     * have been transferred. This includes minting.
     * And also called after one token has been burned.
     *
     * `startTokenId` - the first token ID to be transferred.
     * `quantity` - the amount to be transferred.
     *
     * Calling conditions:
     *
     * - When `from` and `to` are both non-zero, `from`'s `tokenId` has been
     * transferred to `to`.
     * - When `from` is zero, `tokenId` has been minted for `to`.
     * - When `to` is zero, `tokenId` has been burned by `from`.
     * - `from` and `to` are never both zero.
     */
    function _afterTokenTransfers(
        address from,
        address to,
        uint256 startTokenId,
        uint256 quantity
    ) internal virtual {}

    /**
     * @dev Private function to invoke {IERC721Receiver-onERC721Received} on a target contract.
     *
     * `from` - Previous owner of the given token ID.
     * `to` - Target address that will receive the token.
     * `tokenId` - Token ID to be transferred.
     * `_data` - Optional data to send along with the call.
     *
     * Returns whether the call correctly returned the expected magic value.
     */
    function _checkContractOnERC721Received(
        address from,
        address to,
        uint256 tokenId,
        bytes memory _data
    ) private returns (bool) {
        try
            ERC721A__IERC721Receiver(to).onERC721Received(
                _msgSenderERC721A(),
                from,
                tokenId,
                _data
            )
        returns (bytes4 retval) {
            return
                retval ==
                ERC721A__IERC721Receiver(to).onERC721Received.selector;
        } catch (bytes memory reason) {
            if (reason.length == 0) {
                revert TransferToNonERC721ReceiverImplementer();
            } else {
                assembly {
                    revert(add(32, reason), mload(reason))
                }
            }
        }
    }

    // =============================================================
    //                        MINT OPERATIONS
    // =============================================================

    /**
     * @dev Mints `quantity` tokens and transfers them to `to`.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - `quantity` must be greater than 0.
     *
     * Emits a {Transfer} event for each mint.
     */
    function _mint(address to, uint256 quantity) internal virtual {
        uint256 startTokenId = _currentIndex;
        if (quantity == 0) revert MintZeroQuantity();

        _beforeTokenTransfers(address(0), to, startTokenId, quantity);

        // Overflows are incredibly unrealistic.
        // `balance` and `numberMinted` have a maximum limit of 2**64.
        // `tokenId` has a maximum limit of 2**256.
        unchecked {
            // Updates:
            // - `balance += quantity`.
            // - `numberMinted += quantity`.
            //
            // We can directly add to the `balance` and `numberMinted`.
            _packedAddressData[to] +=
                quantity *
                ((1 << _BITPOS_NUMBER_MINTED) | 1);

            // Updates:
            // - `address` to the owner.
            // - `startTimestamp` to the timestamp of minting.
            // - `burned` to `false`.
            // - `nextInitialized` to `quantity == 1`.
            _packedOwnerships[startTokenId] = _packOwnershipData(
                to,
                _nextInitializedFlag(quantity) |
                    _nextExtraData(address(0), to, 0)
            );

            uint256 toMasked;
            uint256 end = startTokenId + quantity;

            // Use assembly to loop and emit the `Transfer` event for gas savings.
            // The duplicated `log4` removes an extra check and reduces stack juggling.
            // The assembly, together with the surrounding Solidity code, have been
            // delicately arranged to nudge the compiler into producing optimized opcodes.
            assembly {
                // Mask `to` to the lower 160 bits, in case the upper bits somehow aren't clean.
                toMasked := and(to, _BITMASK_ADDRESS)
                // Emit the `Transfer` event.
                log4(
                    0, // Start of data (0, since no data).
                    0, // End of data (0, since no data).
                    _TRANSFER_EVENT_SIGNATURE, // Signature.
                    0, // `address(0)`.
                    toMasked, // `to`.
                    startTokenId // `tokenId`.
                )

                // The `iszero(eq(,))` check ensures that large values of `quantity`
                // that overflows uint256 will make the loop run out of gas.
                // The compiler will optimize the `iszero` away for performance.
                for {
                    let tokenId := add(startTokenId, 1)
                } iszero(eq(tokenId, end)) {
                    tokenId := add(tokenId, 1)
                } {
                    // Emit the `Transfer` event. Similar to above.
                    log4(0, 0, _TRANSFER_EVENT_SIGNATURE, 0, toMasked, tokenId)
                }
            }
            if (toMasked == 0) revert MintToZeroAddress();

            _currentIndex = end;
        }
        _afterTokenTransfers(address(0), to, startTokenId, quantity);
    }

    /**
     * @dev Mints `quantity` tokens and transfers them to `to`.
     *
     * This function is intended for efficient minting only during contract creation.
     *
     * It emits only one {ConsecutiveTransfer} as defined in
     * [ERC2309](https://eips.ethereum.org/EIPS/eip-2309),
     * instead of a sequence of {Transfer} event(s).
     *
     * Calling this function outside of contract creation WILL make your contract
     * non-compliant with the ERC721 standard.
     * For full ERC721 compliance, substituting ERC721 {Transfer} event(s) with the ERC2309
     * {ConsecutiveTransfer} event is only permissible during contract creation.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - `quantity` must be greater than 0.
     *
     * Emits a {ConsecutiveTransfer} event.
     */
    function _mintERC2309(address to, uint256 quantity) internal virtual {
        uint256 startTokenId = _currentIndex;
        if (to == address(0)) revert MintToZeroAddress();
        if (quantity == 0) revert MintZeroQuantity();
        if (quantity > _MAX_MINT_ERC2309_QUANTITY_LIMIT)
            revert MintERC2309QuantityExceedsLimit();

        _beforeTokenTransfers(address(0), to, startTokenId, quantity);

        // Overflows are unrealistic due to the above check for `quantity` to be below the limit.
        unchecked {
            // Updates:
            // - `balance += quantity`.
            // - `numberMinted += quantity`.
            //
            // We can directly add to the `balance` and `numberMinted`.
            _packedAddressData[to] +=
                quantity *
                ((1 << _BITPOS_NUMBER_MINTED) | 1);

            // Updates:
            // - `address` to the owner.
            // - `startTimestamp` to the timestamp of minting.
            // - `burned` to `false`.
            // - `nextInitialized` to `quantity == 1`.
            _packedOwnerships[startTokenId] = _packOwnershipData(
                to,
                _nextInitializedFlag(quantity) |
                    _nextExtraData(address(0), to, 0)
            );

            emit ConsecutiveTransfer(
                startTokenId,
                startTokenId + quantity - 1,
                address(0),
                to
            );

            _currentIndex = startTokenId + quantity;
        }
        _afterTokenTransfers(address(0), to, startTokenId, quantity);
    }

    /**
     * @dev Safely mints `quantity` tokens and transfers them to `to`.
     *
     * Requirements:
     *
     * - If `to` refers to a smart contract, it must implement
     * {IERC721Receiver-onERC721Received}, which is called for each safe transfer.
     * - `quantity` must be greater than 0.
     *
     * See {_mint}.
     *
     * Emits a {Transfer} event for each mint.
     */
    function _safeMint(
        address to,
        uint256 quantity,
        bytes memory _data
    ) internal virtual {
        _mint(to, quantity);

        unchecked {
            if (to.code.length != 0) {
                uint256 end = _currentIndex;
                uint256 index = end - quantity;
                do {
                    if (
                        !_checkContractOnERC721Received(
                            address(0),
                            to,
                            index++,
                            _data
                        )
                    ) {
                        revert TransferToNonERC721ReceiverImplementer();
                    }
                } while (index < end);
                // Reentrancy protection.
                if (_currentIndex != end) revert();
            }
        }
    }

    /**
     * @dev Equivalent to `_safeMint(to, quantity, '')`.
     */
    function _safeMint(address to, uint256 quantity) internal virtual {
        _safeMint(to, quantity, "");
    }

    // =============================================================
    //                        BURN OPERATIONS
    // =============================================================

    /**
     * @dev Equivalent to `_burn(tokenId, false)`.
     */
    function _burn(uint256 tokenId) internal virtual {
        _burn(tokenId, false);
    }

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

        address from = address(uint160(prevOwnershipPacked));

        (
            uint256 approvedAddressSlot,
            address approvedAddress
        ) = _getApprovedSlotAndAddress(tokenId);

        if (approvalCheck) {
            // The nested ifs save around 20+ gas over a compound boolean condition.
            if (
                !_isSenderApprovedOrOwner(
                    approvedAddress,
                    from,
                    _msgSenderERC721A()
                )
            ) {
                if (!isApprovedForAll(from, _msgSenderERC721A()))
                    revert TransferCallerNotOwnerNorApproved();
            }
        }

        _beforeTokenTransfers(from, address(0), tokenId, 1);

        // Clear approvals from the previous owner.
        assembly {
            if approvedAddress {
                // This is equivalent to `delete _tokenApprovals[tokenId]`.
                sstore(approvedAddressSlot, 0)
            }
        }

        // Underflow of the sender's balance is impossible because we check for
        // ownership above and the recipient's balance can't realistically overflow.
        // Counter overflow is incredibly unrealistic as `tokenId` would have to be 2**256.
        unchecked {
            // Updates:
            // - `balance -= 1`.
            // - `numberBurned += 1`.
            //
            // We can directly decrement the balance, and increment the number burned.
            // This is equivalent to `packed -= 1; packed += 1 << _BITPOS_NUMBER_BURNED;`.
            _packedAddressData[from] += (1 << _BITPOS_NUMBER_BURNED) - 1;

            // Updates:
            // - `address` to the last owner.
            // - `startTimestamp` to the timestamp of burning.
            // - `burned` to `true`.
            // - `nextInitialized` to `true`.
            _packedOwnerships[tokenId] = _packOwnershipData(
                from,
                (_BITMASK_BURNED | _BITMASK_NEXT_INITIALIZED) |
                    _nextExtraData(from, address(0), prevOwnershipPacked)
            );

            // If the next slot may not have been initialized (i.e. `nextInitialized == false`) .
            if (prevOwnershipPacked & _BITMASK_NEXT_INITIALIZED == 0) {
                uint256 nextTokenId = tokenId + 1;
                // If the next slot's address is zero and not burned (i.e. packed value is zero).
                if (_packedOwnerships[nextTokenId] == 0) {
                    // If the next slot is within bounds.
                    if (nextTokenId != _currentIndex) {
                        // Initialize the next slot to maintain correctness for `ownerOf(tokenId + 1)`.
                        _packedOwnerships[nextTokenId] = prevOwnershipPacked;
                    }
                }
            }
        }

        emit Transfer(from, address(0), tokenId);
        _afterTokenTransfers(from, address(0), tokenId, 1);

        // Overflow not possible, as _burnCounter cannot be exceed _currentIndex times.
        unchecked {
            _burnCounter++;
        }
    }

    // =============================================================
    //                     EXTRA DATA OPERATIONS
    // =============================================================

    /**
     * @dev Directly sets the extra data for the ownership data `index`.
     */
    function _setExtraDataAt(uint256 index, uint24 extraData) internal virtual {
        uint256 packed = _packedOwnerships[index];
        if (packed == 0) revert OwnershipNotInitializedForExtraData();
        uint256 extraDataCasted;
        // Cast `extraData` with assembly to avoid redundant masking.
        assembly {
            extraDataCasted := extraData
        }
        packed =
            (packed & _BITMASK_EXTRA_DATA_COMPLEMENT) |
            (extraDataCasted << _BITPOS_EXTRA_DATA);
        _packedOwnerships[index] = packed;
    }

    /**
     * @dev Called during each token transfer to set the 24bit `extraData` field.
     * Intended to be overridden by the cosumer contract.
     *
     * `previousExtraData` - the value of `extraData` before transfer.
     *
     * Calling conditions:
     *
     * - When `from` and `to` are both non-zero, `from`'s `tokenId` will be
     * transferred to `to`.
     * - When `from` is zero, `tokenId` will be minted for `to`.
     * - When `to` is zero, `tokenId` will be burned by `from`.
     * - `from` and `to` are never both zero.
     */
    function _extraData(
        address from,
        address to,
        uint24 previousExtraData
    ) internal view virtual returns (uint24) {}

    /**
     * @dev Returns the next extra data for the packed ownership data.
     * The returned result is shifted into position.
     */
    function _nextExtraData(
        address from,
        address to,
        uint256 prevOwnershipPacked
    ) private view returns (uint256) {
        uint24 extraData = uint24(prevOwnershipPacked >> _BITPOS_EXTRA_DATA);
        return uint256(_extraData(from, to, extraData)) << _BITPOS_EXTRA_DATA;
    }

    // =============================================================
    //                       OTHER OPERATIONS
    // =============================================================

    /**
     * @dev Returns the message sender (defaults to `msg.sender`).
     *
     * If you are writing GSN compatible contracts, you need to override this function.
     */
    function _msgSenderERC721A() internal view virtual returns (address) {
        return msg.sender;
    }

    /**
     * @dev Converts a uint256 to its ASCII string decimal representation.
     */
    function _toString(uint256 value)
        internal
        pure
        virtual
        returns (string memory str)
    {
        assembly {
            // The maximum value of a uint256 contains 78 digits (1 byte per digit), but
            // we allocate 0xa0 bytes to keep the free memory pointer 32-byte word aligned.
            // We will need 1 word for the trailing zeros padding, 1 word for the length,
            // and 3 words for a maximum of 78 digits. Total: 5 * 0x20 = 0xa0.
            let m := add(mload(0x40), 0xa0)
            // Update the free memory pointer to allocate.
            mstore(0x40, m)
            // Assign the `str` to the end.
            str := sub(m, 0x20)
            // Zeroize the slot after the string.
            mstore(str, 0)

            // Cache the end of the memory to calculate the length later.
            let end := str

            // We write the string from rightmost digit to leftmost digit.
            // The following is essentially a do-while loop that also handles the zero case.
            // prettier-ignore
            for { let temp := value } 1 {} {
                str := sub(str, 1)
                // Write the character to the pointer.
                // The ASCII index of the '0' character is 48.
                mstore8(str, add(48, mod(temp, 10)))
                // Keep dividing `temp` until zero.
                temp := div(temp, 10)
                // prettier-ignore
                if iszero(temp) { break }
            }

            let length := sub(end, str)
            // Move the pointer 32 bytes leftwards to make room for the length.
            str := sub(str, 0x20)
            // Store the length.
            mstore(str, length)
        }
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.4;

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

/**
@notice A two-step extension of Ownable, where the new owner must claim ownership of the contract after owner initiates transfer
Owner can cancel the transfer at any point before the new owner claims ownership.
Helpful in guarding against transferring ownership to an address that is unable to act as the Owner.
*/
abstract contract TwoStepOwnable is ConstructorInitializable {
    address private _owner;

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

    address internal potentialOwner;

    event PotentialOwnerUpdated(address newPotentialAdministrator);

    error NewOwnerIsZeroAddress();
    error NotNextOwner();
    error OnlyOwner();

    modifier onlyOwner() {
        _checkOwner();
        _;
    }

    constructor() {
        _initialize();
    }

    function _initialize() private onlyConstructor {
        _transferOwnership(msg.sender);
    }

    ///@notice Initiate ownership transfer to newPotentialOwner. Note: new owner will have to manually acceptOwnership
    ///@param newPotentialOwner address of potential new owner
    function transferOwnership(address newPotentialOwner)
        public
        virtual
        onlyOwner
    {
        if (newPotentialOwner == address(0)) {
            revert NewOwnerIsZeroAddress();
        }
        potentialOwner = newPotentialOwner;
        emit PotentialOwnerUpdated(newPotentialOwner);
    }

    ///@notice Claim ownership of smart contract, after the current owner has initiated the process with transferOwnership
    function acceptOwnership() public virtual {
        address _potentialOwner = potentialOwner;
        if (msg.sender != _potentialOwner) {
            revert NotNextOwner();
        }
        delete potentialOwner;
        emit PotentialOwnerUpdated(address(0));
        _transferOwnership(_potentialOwner);
    }

    ///@notice cancel ownership transfer
    function cancelOwnershipTransfer() public virtual onlyOwner {
        delete potentialOwner;
        emit PotentialOwnerUpdated(address(0));
    }

    function owner() public view virtual returns (address) {
        return _owner;
    }

    /**
     * @dev Throws if the sender is not the owner.
     */
    function _checkOwner() internal view virtual {
        if (_owner != msg.sender) {
            revert OnlyOwner();
        }
    }

    /**
     * @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`).
     * Internal function without access restriction.
     */
    function _transferOwnership(address newOwner) internal virtual {
        address oldOwner = _owner;
        _owner = newOwner;
        emit OwnershipTransferred(oldOwner, newOwner);
    }
}

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

pragma solidity ^0.8.1;

/**
 * @dev Collection of functions related to the address type
 */
library AddressUpgradeable {
    /**
     * @dev Returns true if `account` is a contract.
     *
     * [IMPORTANT]
     * ====
     * It is unsafe to assume that an address for which this function returns
     * false is an externally-owned account (EOA) and not a contract.
     *
     * Among others, `isContract` will return false for the following
     * types of addresses:
     *
     *  - an externally-owned account
     *  - a contract in construction
     *  - an address where a contract will be created
     *  - an address where a contract lived, but was destroyed
     *
     * Furthermore, `isContract` will also return true if the target contract within
     * the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
     * which only has an effect at the end of a transaction.
     * ====
     *
     * [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://consensys.net/diligence/blog/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.8.0/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
// ERC721A Contracts v4.2.2
// Creator: Chiru Labs

pragma solidity ^0.8.4;

/**
 * @dev Interface of ERC721A.
 */
interface IERC721A {
    /**
     * The caller must own the token or be an approved operator.
     */
    error ApprovalCallerNotOwnerNorApproved();

    /**
     * The token does not exist.
     */
    error ApprovalQueryForNonexistentToken();

    /**
     * The caller cannot approve to their own address.
     */
    error ApproveToCaller();

    /**
     * Cannot query the balance for the zero address.
     */
    error BalanceQueryForZeroAddress();

    /**
     * Cannot mint to the zero address.
     */
    error MintToZeroAddress();

    /**
     * The quantity of tokens minted must be more than zero.
     */
    error MintZeroQuantity();

    /**
     * The token does not exist.
     */
    error OwnerQueryForNonexistentToken();

    /**
     * The caller must own the token or be an approved operator.
     */
    error TransferCallerNotOwnerNorApproved();

    /**
     * The token must be owned by `from`.
     */
    error TransferFromIncorrectOwner();

    /**
     * Cannot safely transfer to a contract that does not implement the
     * ERC721Receiver interface.
     */
    error TransferToNonERC721ReceiverImplementer();

    /**
     * Cannot transfer to the zero address.
     */
    error TransferToZeroAddress();

    /**
     * The token does not exist.
     */
    error URIQueryForNonexistentToken();

    /**
     * The `quantity` minted with ERC2309 exceeds the safety limit.
     */
    error MintERC2309QuantityExceedsLimit();

    /**
     * The `extraData` cannot be set on an unintialized ownership slot.
     */
    error OwnershipNotInitializedForExtraData();

    // =============================================================
    //                            STRUCTS
    // =============================================================

    struct TokenOwnership {
        // The address of the owner.
        address addr;
        // Stores the start time of ownership with minimal overhead for tokenomics.
        uint64 startTimestamp;
        // Whether the token has been burned.
        bool burned;
        // Arbitrary data similar to `startTimestamp` that can be set via {_extraData}.
        uint24 extraData;
    }

    // =============================================================
    //                         TOKEN COUNTERS
    // =============================================================

    /**
     * @dev Returns the total number of tokens in existence.
     * Burned tokens will reduce the count.
     * To get the total number of tokens minted, please see {_totalMinted}.
     */
    function totalSupply() external view returns (uint256);

    // =============================================================
    //                            IERC165
    // =============================================================

    /**
     * @dev Returns true if this contract implements the interface defined by
     * `interfaceId`. See the corresponding
     * [EIP section](https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified)
     * to learn more about how these ids are created.
     *
     * This function call must use less than 30000 gas.
     */
    function supportsInterface(bytes4 interfaceId) external view returns (bool);

    // =============================================================
    //                            IERC721
    // =============================================================

    /**
     * @dev Emitted when `tokenId` token is transferred from `from` to `to`.
     */
    event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);

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

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

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

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

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

    /**
     * @dev Equivalent to `safeTransferFrom(from, to, tokenId, '')`.
     */
    function safeTransferFrom(
        address from,
        address to,
        uint256 tokenId
    ) external;

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

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

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

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

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

    // =============================================================
    //                        IERC721Metadata
    // =============================================================

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

    // =============================================================
    //                           IERC2309
    // =============================================================

    /**
     * @dev Emitted when tokens in `fromTokenId` to `toTokenId`
     * (inclusive) is transferred from `from` to `to`, as defined in the
     * [ERC2309](https://eips.ethereum.org/EIPS/eip-2309) standard.
     *
     * See {_mintERC2309} for more details.
     */
    event ConsecutiveTransfer(uint256 indexed fromTokenId, uint256 toTokenId, address indexed from, address indexed to);
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.4;

/**
 * @author emo.eth
 * @notice Abstract smart contract that provides an onlyUninitialized modifier which only allows calling when
 *         from within a constructor of some sort, whether directly instantiating an inherting contract,
 *         or when delegatecalling from a proxy
 */
abstract contract ConstructorInitializable {
    error AlreadyInitialized();

    modifier onlyConstructor() {
        if (address(this).code.length != 0) {
            revert AlreadyInitialized();
        }
        _;
    }
}

{
  "viaIR": true,
  "codegen": "yul",
  "remappings": [
    "forge-std/=lib/forge-std/src/",
    "hardhat/=node_modules/hardhat/",
    "murky/=lib/murky/",
    "permit2/=lib/permit2/src/",
    "solmate/=lib/solmate/",
    "vesting-schedule/=lib/vesting-schedule/src/",
    "layer0/=lib/layer-zero-examples/contracts/",
    "seadrop/=lib/seadrop/",
    "utility-contracts/=lib/utility-contracts/src/",
    "ERC721A/=lib/ERC721A/contracts/",
    "openzeppelin-contracts/=lib/openzeppelin-contracts/contracts/",
    "openzeppelin-contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
    "permit2-test/=lib/permit2/test/",
    "@ensdomains/=lib/vesting-schedule/node_modules/@ensdomains/",
    "@openzeppelin/=node_modules/@openzeppelin/",
    "@prb/test/=lib/vesting-schedule/lib/prb-test/src/",
    "@uniswap/=lib/layer-zero-examples/node_modules/@uniswap/",
    "ERC721A-Upgradeable/=lib/seadrop/lib/ERC721A-Upgradeable/contracts/",
    "create2-helpers/=lib/seadrop/lib/create2-helpers/",
    "create2-scripts/=lib/seadrop/lib/create2-helpers/script/",
    "ds-test/=lib/forge-std/lib/ds-test/src/",
    "erc4626-tests/=lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests/",
    "eth-gas-reporter/=node_modules/eth-gas-reporter/",
    "forge-gas-snapshot/=lib/permit2/lib/forge-gas-snapshot/src/",
    "hardhat-deploy/=lib/layer-zero-examples/node_modules/hardhat-deploy/",
    "layer-zero-examples/=lib/layer-zero-examples/contracts/",
    "openzeppelin/=lib/openzeppelin-contracts-upgradeable/contracts/",
    "operator-filter-registry/=lib/seadrop/lib/operator-filter-registry/",
    "prb-test/=lib/vesting-schedule/lib/prb-test/src/"
  ],
  "evmVersion": "paris",
  "outputSelection": {
    "*": {
      "*": [
        "abi",
        "metadata"
      ],
      "": [
        "ast"
      ]
    }
  },
  "optimizer": {
    "enabled": true,
    "mode": "3",
    "fallback_to_optimizing_for_size": false,
    "disable_system_request_memoization": true
  },
  "metadata": {},
  "libraries": {},
  "enableEraVMExtensions": false,
  "forceEVMLA": false
}

• No Contract Security Audit Submitted- Submit Audit Here

[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"INOFactory_DefaultINO_NotSet","type":"error"},{"inputs":[],"name":"INOFactory_DefaultINO_ZeroAddr","type":"error"},{"inputs":[{"internalType":"string","name":"name","type":"string"}],"name":"INOFactory_INONameExists","type":"error"},{"inputs":[],"name":"INOFactory_IndexesReversed","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"defaultINO","type":"address"},{"indexed":true,"internalType":"address","name":"newDefaultINO","type":"address"}],"name":"DefaultINOUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"string","name":"inoName","type":"string"},{"indexed":true,"internalType":"address","name":"ino","type":"address"}],"name":"INOCreated","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"previousAdminRole","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"newAdminRole","type":"bytes32"}],"name":"RoleAdminChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"sender","type":"address"}],"name":"RoleGranted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"sender","type":"address"}],"name":"RoleRevoked","type":"event"},{"inputs":[],"name":"DEFAULT_ADMIN_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"string","name":"inoName","type":"string"},{"components":[{"internalType":"address","name":"paymentReceiver","type":"address"},{"internalType":"address","name":"projectWallet","type":"address"}],"internalType":"struct INOStorage.SetUp","name":"inoSetUp","type":"tuple"},{"components":[{"internalType":"address","name":"paymentToken","type":"address"},{"internalType":"address","name":"permit2","type":"address"},{"internalType":"uint256","name":"grandTotal","type":"uint256"}],"internalType":"struct SaleStorage.SetUp","name":"saleSetUp","type":"tuple"},{"internalType":"string[]","name":"phaseIds","type":"string[]"},{"components":[{"components":[{"internalType":"enum Status","name":"status","type":"uint8"},{"internalType":"bytes32","name":"merkleRoot","type":"bytes32"},{"internalType":"uint128","name":"startAt","type":"uint128"},{"internalType":"uint128","name":"endAt","type":"uint128"},{"internalType":"uint256","name":"maxPhaseCap","type":"uint256"}],"internalType":"struct Phase","name":"base","type":"tuple"},{"internalType":"uint256","name":"phaseMaxMint","type":"uint256"}],"internalType":"struct INOPhase[]","name":"phases","type":"tuple[]"}],"name":"createINO","outputs":[{"internalType":"address","name":"ino","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"defaultINO","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"from","type":"uint256"},{"internalType":"uint256","name":"to","type":"uint256"}],"name":"getInosDetails","outputs":[{"components":[{"internalType":"string","name":"name","type":"string"},{"internalType":"address","name":"ino","type":"address"},{"components":[{"internalType":"address","name":"paymentReceiver","type":"address"},{"internalType":"address","name":"projectWallet","type":"address"}],"internalType":"struct INOStorage.SetUp","name":"inoSetUp","type":"tuple"},{"components":[{"internalType":"address","name":"paymentToken","type":"address"},{"internalType":"address","name":"permit2","type":"address"},{"internalType":"uint256","name":"grandTotal","type":"uint256"}],"internalType":"struct SaleStorage.SetUp","name":"saleSetUp","type":"tuple"}],"internalType":"struct IINOFactoryInternal.INODetail[]","name":"inos","type":"tuple[]"},{"internalType":"uint256","name":"lastEvaludatedIndex","type":"uint256"},{"internalType":"uint256","name":"totalItems","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"}],"name":"getRoleAdmin","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"uint256","name":"index","type":"uint256"}],"name":"getRoleMember","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"}],"name":"getRoleMemberCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"grantRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"hasRole","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"maxLoop","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"renounceRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"revokeRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"newMaxLoop","type":"uint256"}],"name":"setMaxLoop","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newDefaultINO","type":"address"}],"name":"updateDefaultINO","outputs":[],"stateMutability":"nonpayable","type":"function"}]

9c4d535b0000000000000000000000000000000000000000000000000000000000000000010002ed7ee1b892c999f230c06c31be2ccd7c57e38b12a5cd6cdabde71adf1800000000000000000000000000000000000000000000000000000000000000600000000000000000000000000000000000000000000000000000000000000000

0x0004000000000002000c0000000000020000006004100270000002910340019700030000003103550002000000010355000002910040019d0000008004000039000000400040043f0000000100200190000000380000c13d000000040030008c0000055f0000413d000000000201043b000000e002200270000002980020009c000000d40000a13d000002990020009c0000018e0000213d0000029f0020009c0000021a0000213d000002a20020009c000002620000613d000002a30020009c0000055f0000c13d000000440030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000000402100370000000000202043b000000000020043f0000000102000039000000200020043f0000002401100370000000000101043b000c00000001001d000000400200003900000000010000190a410a220000040f0000000c020000290a410a060000040f0000000302200210000000000101041a000000000121022f000002b501100197000000ff0020008c0000000001002019000000400200043d0000000000120435000002910020009c00000291020080410000004001200210000002c0011001c700000a420001042e0000000001000416000000000001004b0000055f0000c13d00000001020000390000000201000039000000000021041b00000064010000390000000302000039000000000012041b000000000000043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000002000411000000000020043f000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b000000000101041a000000ff00100190000000880000c13d000000000000043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000002000411000000000020043f000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b000000000201041a000002dc0220019700000001022001bf000000000021041b0000000001000414000002910010009c0000029101008041000000c00110021000000293011001c70000800d02000039000000040300003900000294040000410000000005000019000000000600041100000000070600190a410a370000040f00000001002001900000055f0000613d000000000000043f0000000101000039000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000201043b0000000001000411000000000010043f000c00000002001d0000000101200039000b00000001001d000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b000000000101041a000000000001004b000000cf0000c13d0000000c02000029000000000102041a000002950010009c000002c10000813d000a00000001001d0000000101100039000000000012041b000000000020043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000a011000290000000002000411000000000021041b0000000c01000029000000000101041a000c00000001001d000000000020043f0000000b01000029000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000c02000029000000000021041b000000200100003900000100001004430000012000000443000002970100004100000a420001042e000002a40020009c000001ae0000a13d000002a50020009c000001c20000213d000002a80020009c000002370000613d000002a90020009c0000055f0000c13d000000440030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000000402100370000000000202043b000c00000002001d0000002401100370000000000101043b000b00000001001d000002b50010009c0000055f0000213d0000000c01000029000000000010043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000101100039000000000101041a0a41083e0000040f0000000c01000029000000000010043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000b02000029000000000020043f000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b000000000101041a000000ff00100190000001420000c13d0000000c01000029000000000010043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000b02000029000000000020043f000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b000000000201041a000002dc0220019700000001022001bf000000000021041b0000000001000414000002910010009c0000029101008041000000c00110021000000293011001c70000800d020000390000000403000039000000000700041100000294040000410000000c050000290000000b060000290a410a370000040f00000001002001900000055f0000613d0000000c01000029000000000010043f0000000101000039000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000201043b0000000b01000029000000000010043f000c00000002001d0000000101200039000a00000001001d000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b000000000101041a000000000001004b0000018c0000c13d0000000c01000029000000000101041a000900000001001d000002ad0010009c000002c10000213d000000090100002900000001011000390000000c02000029000000000012041b000000000020043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b00000009011000290000000b02000029000000000021041b0000000c01000029000000000101041a000c00000001001d000000000020043f0000000a01000029000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000101043b0000000c02000029000000000021041b000000000100001900000a420001042e0000029a0020009c000002240000213d0000029d0020009c000002730000613d0000029e0020009c0000055f0000c13d000000440030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000002402100370000000000202043b000c00000002001d000002b50020009c0000055f0000213d0000000401100370000000000101043b000b00000001001d000000000010043f000000200000043f000000400200003900000000010000190a410a220000040f0000000101100039000000000101041a0a41083e0000040f0000000b010000290000000c020000290a4109240000040f000000000100001900000a420001042e000002aa0020009c000002a70000613d000002ab0020009c000002550000613d000002ac0020009c0000055f0000c13d000000240030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000000401100370000000000101043b000000000010043f000000200000043f000000400200003900000000010000190a410a220000040f0000000101100039000002a30000013d000002a60020009c0000024c0000613d000002a70020009c0000055f0000c13d000001040030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000000402100370000000000202043b000002ad0020009c0000055f0000213d0000002304200039000000000034004b0000055f0000813d000c00040020003d0000000c04100360000000000404043b000002ad0040009c0000055f0000213d000b00240020003d0000000b02400029000000000032004b0000055f0000213d000000e002000039000000400020043f0000006402100370000000000202043b000002b50020009c0000055f0000213d000000800020043f0000008402100370000000000202043b000002b50020009c0000055f0000213d000000a00020043f000000a402100370000000000202043b000000c00020043f000000c402100370000000000202043b000002ad0020009c0000055f0000213d0000002304200039000000000034004b0000055f0000813d0000000404200039000000000441034f000000000404043b000002ad0040009c0000055f0000213d000000050440021000000000024200190000002402200039000000000032004b0000055f0000213d000000e402100370000000000202043b000002ad0020009c0000055f0000213d0000002304200039000000000034004b0000055f0000813d0000000404200039000000000141034f000000000101043b000002ad0010009c0000055f0000213d000000c0011000c900000000011200190000002401100039000000000031004b0000055f0000213d0000000201000039000000000101041a000000020010008c000004100000c13d000002c101000041000000e00010043f0000002001000039000000e40010043f0000001f01000039000001040010043f000002d401000041000001240010043f000002d50100004100000a4300010430000002a00020009c000002810000613d000002a10020009c0000055f0000c13d0000000001000416000000000001004b0000055f0000c13d000000800000043f000002bf0100004100000a420001042e0000029b0020009c0000029f0000613d0000029c0020009c0000055f0000c13d000000440030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000002402100370000000000202043b0000000401100370000000000801043b000000000382004b000002b40000813d000002bd01000041000000800010043f000002be0100004100000a4300010430000000240030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000000401100370000000000101043b000002b50010009c0000055f0000213d000c02b50010019b0a41078e0000040f0000000c0000006b000002c70000c13d000000400100043d000002d7020000410000000000210435000002910010009c00000291010080410000004001100210000002d3011001c700000a43000104300000000001000416000000000001004b0000055f0000c13d0000000601000039000000000101041a000002b501100197000000800010043f000002bf0100004100000a420001042e000000240030008c0000055f0000413d0000000001000416000000000001004b0000055f0000c13d0a41078e0000040f00000004010000390000000201100367000000000101043b0000000302000039000000000012041b000000000100001900000a420001042e000000440030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000002402100370000000000302043b000002b50030009c0000055f0000213d0000000002000411000000000023004b000002de0000c13d0000000401100370000000000101043b0a4109240000040f000000000100001900000a420001042e000000240030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000000401100370000000000101043b000000000010043f0000000101000039000000200010043f000000400200003900000000010000190a410a220000040f000002a30000013d000000440030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000002402100370000000000202043b000c00000002001d000002b50020009c0000055f0000213d0000000401100370000000000101043b000000000010043f000000200000043f000000400200003900000000010000190a410a220000040f0000000c02000029000000000020043f000000200010043f000000000100001900000040020000390a410a220000040f000000000101041a000000ff001001900000000001000039000000010100c039000000800010043f000002bf0100004100000a420001042e0000000001000416000000000001004b0000055f0000c13d0000000301000039000000000101041a000000800010043f000002bf0100004100000a420001042e000000240030008c0000055f0000413d0000000002000416000000000002004b0000055f0000c13d0000000401100370000000000101043b000002d8001001980000055f0000c13d000002d90010009c000002ea0000c13d0000000102000039000002ef0000013d0000000301000039000000000101041a0000000007810019000000000013004b000000000702a0190000000003018019000002ad0030009c000002c10000213d00000005013002100000003f02100039000002ae04200197000002af0040009c000002f30000a13d000002bb01000041000000000010043f0000004101000039000000040010043f000002bc0100004100000a43000104300000000601000039000000000201041a0000000001000414000002910010009c0000029101008041000000c00110021000000293011001c7000b00000002001d000002b5052001970000800d020000390000000303000039000002d6040000410000000c060000290a410a370000040f00000001002001900000055f0000613d0000000b01000029000002ca011001970000000c011001af0000000602000039000000000012041b000000000100001900000a420001042e000002c101000041000000800010043f0000002001000039000000840010043f0000002f01000039000000a40010043f000002c201000041000000c40010043f000002c301000041000000e40010043f000002c40100004100000a4300010430000002da0010009c00000000020000390000000102006039000002db0010009c00000001022061bf000000010120018f000000800010043f000002bf0100004100000a420001042e0000008002400039000000400020043f000000800030043f000000000087004b000003a70000c13d0000000401000039000000000601041a000000000078004b000700000007001d0000038a0000813d000000200500008a0000000009080019000600000008001d000000000096004b0000040a0000a13d0000000401000039000000000010043f000000400a00043d000002af00a0009c000002c10000213d000000070b9000c9000002b301b0009a000000800ca000390000004000c0043f000000000301041a0000000104300190000000010d3002700000007f0dd0618f0000001f00d0008c00000000020000390000000102002039000000000223013f0000000100200190000005840000c13d0000000000dc0435000000000004004b0000033e0000613d00080000000d001d00090000000c001d000a0000000b001d000b0000000a001d000c00000009001d000000000010043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d0000000402000039000000000602041a000000080d00002900000000000d004b00000007070000290000000608000029000003450000613d0000000b0a000029000000a003a00039000000000401043b00000000010000190000000c090000290000000a0b000029000000090c0000290000000002130019000000000504041a0000000000520435000000010440003900000020011000390000000000d1004b000003350000413d000000200500008a0000034b0000013d000002dc01300197000000a002a00039000000000012043500000000000d004b000000200100003900000000010060390000034b0000013d0000000001000019000000200500008a0000000c090000290000000b0a0000290000000a0b000029000000090c0000290000003f01100039000000000251016f0000000001c20019000000000021004b00000000020000390000000102004039000002ad0010009c000002c10000213d0000000100200190000002c10000c13d000000400010043f0000000001ca0436000002b402b0009a000000000202041a000002b5022001970000000000210435000000400100043d000002b10010009c000002c10000213d0000004002100039000000400020043f000002b602b0009a000000000202041a000002b5022001970000000002210436000002b703b0009a000000000303041a000002b50330019700000000003204350000004002a000390000000000120435000000400300043d000002b20030009c000002c10000213d00000000018900490000006002300039000000400020043f000002b802b0009a000000000202041a000002b5022001970000000002230436000002b904b0009a000000000404041a000002b5044001970000000000420435000002ba02b0009a000000000202041a000000400430003900000000002404350000006002a000390000000000320435000000800200043d000000000012004b0000040a0000a13d0000000502100210000000a0022000390000000000a20435000000800200043d000000000012004b0000040a0000a13d0000000109900039000000000079004b000003000000413d000c00000006001d000000400100043d000000600200003900000000032104360000006002100039000000800400043d0000000000420435000000800610003900000005024002100000000005620019000000000004004b000b00000003001d000003ce0000c13d00000040021000390000000c0300002900000000003204350000000702000029000000010220008a0000000b0300002900000000002304350000000002150049000002910020009c00000291020080410000006002200210000002910010009c00000291010080410000004001100210000000000112019f00000a420001042e000002b00040009c000002c10000213d000000600300003900000000040000190000008005200039000000400050043f00000000053204360000000000050435000000400500043d000002b10050009c000002c10000213d0000004006500039000000400060043f00000020065000390000000000060435000000000005043500000040062000390000000000560435000000400500043d000002b20050009c000002c10000213d0000006006500039000000400060043f0000004006500039000000000006043500000020065000390000000000060435000000000005043500000060062000390000000000560435000000a00540003900000000002504350000002004400039000000000014004b000002f80000813d000000400200043d000002af0020009c000003ab0000a13d000002c10000013d000000a007000039000000000a000019000003f40000013d0000000002cb0019000000000002043500000000020f0433000002b50220019700000000002e04350000004002d0003900000000020204330000000032020434000002b502200197000000400850003900000000002804350000000002030433000002b502200197000000600350003900000000002304350000006002d0003900000000020204330000000083020434000002b503300197000000800950003900000000003904350000000003080433000002b503300197000000a0085000390000000000380435000000c0035000390000004002200039000000000202043300000000002304350000001f02b00039000002dd022001970000000005c20019000000010aa0003900000000004a004b000003970000813d0000000002150049000000800220008a0000000006260436000000007d07043400000000f20d0434000000e003000039000000000e350436000000e00c500039000000003b0204340000000000bc0435000001000c50003900000000000b004b000003d10000613d00000000020000190000000008c2001900000000092300190000000009090433000000000098043500000020022000390000000000b2004b000004020000413d000003d10000013d000002bb01000041000000000010043f0000003201000039000000040010043f000002bc0100004100000a43000104300000000201000039000000000011041b0a41078e0000040f0000000c0300002900000002023003670000002003300039000a00000003001d0000000204300367000000000102043b000002dd051001980000001f0610018f000000400200043d0000000003520019000004240000613d000000000704034f0000000008020019000000007907043c0000000008980436000000000038004b000004200000c13d000000000006004b000004310000613d000000000454034f0000000305600210000000000603043300000000065601cf000000000656022f000000000404043b0000010005500089000000000454022f00000000045401cf000000000464019f0000000000430435000000000321001900000005040000390000000000430435000002910020009c000002910200804100000040022002100000002001100039000002910010009c00000291010080410000006001100210000000000121019f0000000002000414000002910020009c0000029102008041000000c002200210000000000112019f00000293011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000400a00043d000000000101043b000000000101041a000002b500100198000004560000c13d0000000601000039000000000101041a000002b5001001980000046c0000c13d000002d20100004100000000001a04350000029100a0009c000002910a0080410000004001a00210000002d3011001c700000a4300010430000002c50100004100090000000a001d00000000001a04350000000401a00039000000200200003900000000002104350000000c010000290000000201100367000000000201043b0000002403a000390000000b010000290a4109050000040f00000009020000290000000001210049000002910020009c00000291020080410000004002200210000002910010009c00000291010080410000006001100210000000000121019f00000a4300010430000000000100041100000060011002100000002002a0003900000000001204350000000a0200002900000002042003670000000c020000290000000201200367000000000101043b000002dd051001980000001f0610018f0000003402a000390000000003520019000004800000613d000000000704034f0000000008020019000000007907043c0000000008980436000000000038004b0000047c0000c13d000000000006004b0000048d0000613d000000000454034f0000000305600210000000000603043300000000065601cf000000000656022f000000000404043b0000010005500089000000000454022f00000000045401cf000000000464019f000000000043043500000000022100190000000000020435000000140210003900000000002a04350000005301100039000002dd021001970000000001a20019000000000021004b00000000020000390000000102004039000002ad0010009c000002c10000213d0000000100200190000002c10000c13d000000400010043f000002c60010009c000002c10000213d0000002402100039000002c70300004100000000003204350000004402100039000000000300041400000060040000390000000000420435000002c80200004100000000002104350000006402100039000000000002043500000004021000390000000000020435000002910010009c00000291010080410000004001100210000002910030009c0000029103008041000000c002300210000000000112019f000002c9011001c700008006020000390a410a370000040f0000000100200190000004be0000613d000000000101043b000b00000001001d000000000001004b000004e20000c13d00000003010003670000000102000031000004c20000013d00030000000103550000006002100270000102910020019d0000029102200197000002dd052001980000001f0620018f000000400300043d0000000004530019000004cd0000613d000000000701034f0000000008030019000000007907043c0000000008980436000000000048004b000004c90000c13d000000000006004b000004da0000613d000000000151034f0000000305600210000000000604043300000000065601cf000000000656022f000000000101043b0000010005500089000000000151022f00000000015101cf000000000161019f0000000000140435000002910020009c00000291020080410000006001200210000002910030009c00000291030080410000004002300210000000000112019f00000a43000104300000000a0200002900000002042003670000000c020000290000000201200367000000000101043b000002dd051001980000001f0610018f000000400200043d0000000003520019000004f20000613d000000000704034f0000000008020019000000007907043c0000000008980436000000000038004b000004ee0000c13d000000000006004b000004ff0000613d000000000454034f0000000305600210000000000603043300000000065601cf000000000656022f000000000404043b0000010005500089000000000454022f00000000045401cf000000000464019f0000000000430435000000000321001900000005040000390000000000430435000002910020009c000002910200804100000040022002100000002001100039000002910010009c00000291010080410000006001100210000000000121019f0000000002000414000002910020009c0000029102008041000000c002200210000000000112019f00000293011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d0000000b02000029000702b50020019b000000000101043b000000000201041a000002ca0220019700000007022001af000000000021041b000000400100043d000002af0010009c000002c10000213d0000008003100039000000400030043f00000002020003670000000c04200360000000000404043b0000001f05400039000002dd055001970000003f05500039000002dd065001970000000005360019000000000065004b00000000060000390000000106004039000002ad0050009c000002c10000213d0000000100600190000002c10000c13d000000400050043f0000000a072003600000000000430435000002dd084001980000001f0940018f000000a00510003900000000068500190000053d0000613d000000000a07034f000000000b05001900000000ac0a043c000000000bcb043600000000006b004b000005390000c13d000000000009004b0000054a0000613d000000000787034f0000000308900210000000000906043300000000098901cf000000000989022f000000000707043b0000010008800089000000000787022f00000000078701cf000000000797019f00000000007604350000000004540019000000000004043500000000043104360000000703000029000900000004001d0000000000340435000000400300043d000002b10030009c000002c10000213d0000004004300039000000400040043f0000002404200370000000000404043b000002b50040009c00000080050000390000055f0000213d00000000044304360000004402200370000000000202043b000002b50020009c000005610000a13d000000000100001900000a430001043000000000002404350000006002100039000800000002001d00000000005204350000004002100039000600000002001d00000000003204350000000403000039000000000203041a000002ad0020009c000002c10000213d0000000104200039000000000043041b000000000030043f0000000001010433000b00000001001d0000000031010434000400000003001d000500000001001d000002ad0010009c000002c10000213d00000007012000c9000100000001001d000002b30110009a000300000001001d000000000101041a000000010210019000000001011002700000007f0110618f000200000001001d0000001f0010008c00000000010000390000000101002039000000000012004b0000058a0000613d000002bb01000041000000000010043f0000002201000039000000040010043f000002bc0100004100000a43000104300000000201000029000000200010008c000005a90000413d0000000301000029000000000010043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d00000005030000290000001f023000390000000502200270000000200030008c0000000002004019000000000301043b00000002010000290000001f01100039000000050110027000000000011300190000000002230019000000000012004b000005a90000813d000000000002041b0000000102200039000000000012004b000005a50000413d00000005010000290000001f0010008c000005bd0000a13d0000000301000029000000000010043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000200200008a0000000503200180000000000101043b000005ca0000c13d0000002002000039000005d60000013d000000050000006b0000000001000019000005c20000613d0000000401000029000000000101043300000005040000290000000302400210000002de0220027f000002de02200167000000000121016f0000000102400210000000000121019f000005e40000013d000000010230008a00000005022002700000000004210019000000200200003900000001044000390000000b052000290000000005050433000000000051041b00000020022000390000000101100039000000000041004b000005cf0000c13d000000050030006c000005e10000813d00000005030000290000000303300210000000f80330018f000002de0330027f000002de033001670000000b022000290000000002020433000000000232016f000000000021041b0000000501000029000000010110021000000001011001bf0000000302000029000000000012041b00000009010000290000000001010433000002b5011001970000000106000029000002b40260009a000000000302041a000002ca03300197000000000113019f000000000012041b000002b60160009a000000000201041a000002ca02200197000000060300002900000000030304330000000043030434000002b503300197000000000232019f000000000021041b0000000001040433000002b501100197000002b70260009a000000000302041a000002ca03300197000000000113019f000000000012041b000002b80160009a000000000201041a000002ca02200197000000080300002900000000030304330000000054030434000002b504400197000000000242019f000000000021041b0000000001050433000002b501100197000002b90260009a000000000402041a000002ca04400197000000000114019f000000000012041b000002ba0160009a00000040023000390000000002020433000000000021041b000002cb010000410000000000100443000000070100002900000004001004430000000001000414000002910010009c0000029101008041000000c001100210000002cc011001c700008002020000390a410a3c0000040f0000000100200190000006ec0000613d000000000101043b000000000001004b0000055f0000613d000000400400043d000002cd010000410000000000140435000000800100043d000002b50110019700000004024000390000000000120435000000a00100043d000002b501100197000000240240003900000000001204350000006401400039000000c00200043d00000000030004110000000000310435000b00000004001d0000004401400039000000000021043500000002010003670000002402100370000000000202043b000002b50020009c0000055f0000213d0000000b03000029000000840330003900000000002304350000004402100370000000000202043b000002b50020009c0000055f0000213d0000000b060000290000010404600039000000c40360003900000100050000390000000000530435000000a4036000390000000000230435000000c402100370000000000202043b000900000002001d0000000402200039000000000221034f000000000302043b000000000034043500000124046000390000000502300210000000000a420019000800000003001d000000000003004b000006ed0000c13d0000000b0300002900000000023a0049000000040220008a000000e4033000390000000000230435000000e402100370000000000402043b0000000402400039000000000221034f000000000302043b00000000023a0436000000000003004b0000068a0000613d00000024044000390000000005000019000000000641034f000000000606043b000000030060008c0000055f0000213d00000000066204360000002007400039000000000771034f000000000707043b00000000007604350000004006400039000000000761034f000000000707043b000002cf0070009c0000055f0000213d000000400820003900000000007804350000002006600039000000000761034f000000000707043b000002cf0070009c0000055f0000213d000000600820003900000000007804350000002007600039000000000771034f000000000707043b000000800820003900000000007804350000004006600039000000000661034f000000000606043b000000a0072000390000000000670435000000c004400039000000c0022000390000000105500039000000000035004b000006640000413d00000000010004140000000703000029000000040030008c000006a20000613d0000000b030000290000000002320049000002910020009c00000291020080410000006002200210000002910030009c00000291030080410000004003300210000000000232019f000002910010009c0000029101008041000000c001100210000000000112019f00000007020000290a410a370000040f0000006003100270000102910030019d000300000001035500000001002001900000073e0000613d0000000b01000029000002ad0010009c000002c10000213d0000000b06000029000000400060043f0000000a0200002900000002032003670000000c020000290000000201200367000000000101043b000002dd041001980000001f0510018f0000000002460019000006b60000613d000000000603034f0000000b07000029000000006806043c0000000007870436000000000027004b000006b20000c13d000000000005004b000006c30000613d000000000343034f0000000304500210000000000502043300000000054501cf000000000545022f000000000303043b0000010004400089000000000343022f00000000034301cf000000000353019f00000000003204350000000b0300002900000000023100190000000000020435000002910030009c00000291030080410000004002300210000002910010009c00000291010080410000006001100210000000000121019f0000000002000414000002910020009c0000029102008041000000c002200210000000000112019f00000293011001c700008010020000390a410a3c0000040f00000001002001900000055f0000613d000000000501043b000000400100043d000c00000001001d0000000001000414000002910010009c0000029101008041000000c00110021000000293011001c70000800d020000390000000303000039000002d10400004100000007060000290a410a370000040f00000001002001900000055f0000613d00000001010000390000000202000039000000000012041b00000007010000290000000c02000029000000320000013d000000000001042f0000000005000031000000090300002900000000023500490000002406300039000000430720008a000002ce087001970000000009000019000006fe0000013d0000001f03b00039000002dd03300197000000000a2b001900000000000a0435000000000a23001900000020066000390000000109900039000000080090006c000006550000813d0000000b02a0006a000001240220008a0000000004240436000000000261034f000000000b02043b000002ce02b00197000000000c82013f000000000082004b0000000002000019000002ce0200204100000000007b004b000000000d000019000002ce0d004041000002ce00c0009c00000000020dc019000000000002004b0000055f0000613d0000000902b00029000000240c200039000000000bc1034f000000000b0b043b000002ad00b0009c0000055f0000213d000000000db5004900000044022000390000000000d2004b000000000e000019000002ce0e002041000002ce0dd00197000002ce02200197000000000fd2013f0000000000d2004b0000000002000019000002ce02004041000002ce00f0009c00000000020ec019000000000002004b0000055f0000c13d0000002002c00039000000000d21034f0000000002ba0436000002dd0eb00198000000000ce20019000007300000613d000000000f0d034f000000000a02001900000000f30f043c000000000a3a04360000000000ca004b0000072c0000c13d0000001f0ab00190000006f50000613d0000000003ed034f000000030aa00210000000000d0c0433000000000dad01cf000000000dad022f000000000303043b000001000aa000890000000003a3022f0000000003a301cf0000000003d3019f00000000003c0435000006f50000013d00000291033001970000001f0530018f000002d006300198000000400200043d00000000046200190000074a0000613d000000000701034f0000000008020019000000007907043c0000000008980436000000000048004b000007460000c13d000000000005004b000007570000613d000000000161034f0000000305500210000000000604043300000000065601cf000000000656022f000000000101043b0000010005500089000000000151022f00000000015101cf000000000161019f00000000001404350000006001300210000002910020009c00000291020080410000004002200210000000000112019f00000a43000104300000001f02200039000002dd022001970000000001120019000000000021004b00000000020000390000000102004039000002ad0010009c000007690000213d0000000100200190000007690000c13d000000400010043f000000000001042d000002bb01000041000000000010043f0000004101000039000000040010043f000002bc0100004100000a4300010430000000000003004b000007790000613d000000000400001900000000052400190000000006140019000000000606043300000000006504350000002004400039000000000034004b000007720000413d00000000012300190000000000010435000000000001042d00000000430104340000000001320436000000000003004b000007880000613d000000000200001900000000051200190000000006240019000000000606043300000000006504350000002002200039000000000032004b000007810000413d000000000213001900000000000204350000001f02300039000002dd022001970000000001210019000000000001042d00040000000000020000000001000411000000000010043f000002df01000041000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000007a10000613d000000000101043b000000000101041a000000ff00100190000007a30000613d000000000001042d000000000100001900000a4300010430000000400200043d000002e00020009c000007ac0000413d000002bb01000041000000000010043f0000004101000039000000040010043f000002bc0100004100000a43000104300000006004200039000000400040043f0000002a01000039000000000112043600000000030000310000000203300367000000000503034f0000000006010019000000005705043c0000000006760436000000000046004b000007b40000c13d0000000004010433000002e104400197000002e2044001c7000000000041043500000021042000390000000005040433000002e105500197000002e3055001c700000000005404350000002904000039000000000600041100000000050600190000000006020433000000000046004b000008290000a13d00000000061400190000000007060433000002e1077001970000000308500210000000780880018f000002e40880021f000002e508800197000000000787019f00000000007604350000000406500270000000010440008a000000010040008c000007c30000213d000000400700043d000000100050008c0000082f0000813d000002af0070009c000007a60000213d0000008004700039000000400040043f000000420500003900000000055704360000000008050019000000003603043c0000000005650436000000000045004b000007de0000c13d0000000003080433000002e103300197000002e2033001c70000000000380435000000000607001900000021037000390000000004030433000002e104400197000002e3044001c7000000000043043500000041030000390000000004060433000000000034004b000008290000a13d00000000048300190000000005040433000002e105500197000002e2055001c70000000000540435000000010330008a000000010030008c000007ed0000213d000000400500043d000400000005001d0000002003500039000002e80400004100000000004304350000000003020433000300000003001d0000003702500039000100000006001d000200000008001d0a41076f0000040f000000030200002900000004012000290000003702100039000002e9030000410000000000320435000000480210003900000001010000290000000003010433000100000003001d00000002010000290a41076f0000040f0000000102000029000000030320002900000028023000390000000401000029000000000021043500000048023000390a41075d0000040f000002c101000041000000400300043d000300000003001d0000000000130435000000200100003900000004023000390000000000120435000000240230003900000004010000290a41077c0000040f00000003020000290000000001210049000002910010009c0000029101008041000002910020009c000002910200804100000060011002100000004002200210000000000121019f00000a4300010430000002bb01000041000000000010043f0000003201000039000000040010043f000002bc0100004100000a43000104300000004401700039000002e6020000410000000000210435000002c101000041000000000017043500000024017000390000002002000039000000000021043500000004017000390000000000210435000002910070009c00000291070080410000004001700210000002e7011001c700000a43000104300004000000000002000400000001001d000000000010043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000085d0000613d000000000101043b0000000002000411000000000020043f000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f00000001002001900000085d0000613d000000000101043b000000000101041a000000ff001001900000085f0000613d000000000001042d000000000100001900000a4300010430000000400200043d000002e00020009c000008680000413d000002bb01000041000000000010043f0000004101000039000000040010043f000002bc0100004100000a43000104300000006004200039000000400040043f0000002a01000039000000000112043600000000030000310000000203300367000000000503034f0000000006010019000000005705043c0000000006760436000000000046004b000008700000c13d0000000004010433000002e104400197000002e2044001c7000000000041043500000021042000390000000005040433000002e105500197000002e3055001c700000000005404350000002904000039000000000600041100000000050600190000000006020433000000000046004b000008ef0000a13d00000000061400190000000007060433000002e1077001970000000308500210000000780880018f000002e40880021f000002e508800197000000000787019f00000000007604350000000406500270000000010440008a000000010040008c0000087f0000213d000000100050008c000008f50000813d000000400400043d000300000004001d000002af0040009c000008620000213d00000003060000290000008004600039000000400040043f00000042050000390000000005560436000200000005001d000000003603043c0000000005650436000000000045004b0000089c0000c13d00000002090000290000000003090433000002e103300197000002e2033001c70000000000390435000000030800002900000021038000390000000004030433000002e104400197000002e3044001c700000000004304350000004103000039000000040500002900000000040500190000000005080433000000000035004b000008ef0000a13d00000000059300190000000006050433000002e1066001970000000307400210000000780770018f000002e40770021f000002e507700197000000000667019f00000000006504350000000405400270000000010330008a000000010030008c000008ad0000213d000000100040008c000008f50000813d000000400500043d000400000005001d0000002003500039000002e80400004100000000004304350000000003020433000100000003001d00000037025000390a41076f0000040f000000010200002900000004012000290000003702100039000002e9030000410000000000320435000000480210003900000003010000290000000003010433000300000003001d00000002010000290a41076f0000040f0000000302000029000000010320002900000028023000390000000401000029000000000021043500000048023000390a41075d0000040f000002c101000041000000400300043d000300000003001d0000000000130435000000200100003900000004023000390000000000120435000000240230003900000004010000290a41077c0000040f00000003020000290000000001210049000002910010009c0000029101008041000002910020009c000002910200804100000060011002100000004002200210000000000121019f00000a4300010430000002bb01000041000000000010043f0000003201000039000000040010043f000002bc0100004100000a4300010430000000400100043d0000004402100039000002e6030000410000000000320435000002c102000041000000000021043500000024021000390000002003000039000000000032043500000004021000390000000000320435000002910010009c00000291010080410000004001100210000002e7011001c700000a43000104300000000003230436000002dd062001980000001f0720018f00000000056300190000000201100367000009110000613d000000000801034f0000000009030019000000008a08043c0000000009a90436000000000059004b0000090d0000c13d000000000007004b0000091e0000613d000000000161034f0000000306700210000000000705043300000000076701cf000000000767022f000000000101043b0000010006600089000000000161022f00000000016101cf000000000171019f0000000000150435000000000123001900000000000104350000001f01200039000002dd011001970000000001130019000000000001042d0006000000000002000600000002001d000500000001001d000000000010043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000101043b0000000602000029000002b502200197000600000002001d000000000020043f000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000101043b000000000101041a000000ff00100190000009700000613d0000000501000029000000000010043f000000200000043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000101043b0000000602000029000000000020043f000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000101043b000000000201041a000002dc02200197000000000021041b0000000001000414000002910010009c0000029101008041000000c00110021000000293011001c70000800d0200003900000004030000390000000007000411000002ea04000041000000050500002900000006060000290a410a370000040f0000000100200190000009f20000613d0000000501000029000000000010043f0000000101000039000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000201043b0000000601000029000000000010043f000500000002001d0000000101200039000300000001001d000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d0000000503000029000000000101043b000000000101041a000000000001004b000009f10000613d000000000203041a000000000002004b000009f40000613d000000000012004b000400000001001d000009d10000613d000200000002001d000000000030043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d00000004020000290001000100200092000000000101043b0000000504000029000000000204041a000000010020006c000009fa0000a13d0000000202000029000000010220008a0000000001120019000000000101041a000200000001001d000000000040043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000101043b00000001011000290000000202000029000000000021041b000000000020043f0000000301000029000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000101043b0000000402000029000000000021041b0000000503000029000000000103041a000400000001001d000000000001004b00000a000000613d000000000030043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d0000000402000029000000010220008a000000000101043b0000000001210019000000000001041b0000000501000029000000000021041b0000000601000029000000000010043f0000000301000029000000200010043f0000000001000414000002910010009c0000029101008041000000c00110021000000292011001c700008010020000390a410a3c0000040f0000000100200190000009f20000613d000000000101043b000000000001041b000000000001042d000000000100001900000a4300010430000002bb01000041000000000010043f0000001101000039000000040010043f000002bc0100004100000a4300010430000002bb01000041000000000010043f0000003201000039000000040010043f000002bc0100004100000a4300010430000002bb01000041000000000010043f0000003101000039000000040010043f000002bc0100004100000a43000104300001000000000002000000000301041a000100000002001d000000000023004b00000a190000a13d000000000010043f0000000001000414000002910010009c0000029101008041000000c00110021000000296011001c700008010020000390a410a3c0000040f000000010020019000000a1f0000613d000000000101043b00000001011000290000000002000019000000000001042d000002bb01000041000000000010043f0000003201000039000000040010043f000002bc0100004100000a4300010430000000000100001900000a4300010430000000000001042f000002910010009c00000291010080410000004001100210000002910020009c00000291020080410000006002200210000000000112019f0000000002000414000002910020009c0000029102008041000000c002200210000000000112019f00000293011001c700008010020000390a410a3c0000040f000000010020019000000a350000613d000000000101043b000000000001042d000000000100001900000a430001043000000a3a002104210000000102000039000000000001042d0000000002000019000000000001042d00000a3f002104230000000102000039000000000001042d0000000002000019000000000001042d00000a410000043200000a420001042e00000a430001043000000000000000000000000000000000000000000000000000000000ffffffff020000000000000000000000000000000000004000000000000000000000000002000000000000000000000000000000000000000000000000000000000000002f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d0000000000000000000000000000000000000000000000010000000000000000020000000000000000000000000000000000002000000000000000000000000000000002000000000000000000000000000000400000010000000000000000000000000000000000000000000000000000000000000000000000000036568abd00000000000000000000000000000000000000000000000000000000ca15c87200000000000000000000000000000000000000000000000000000000ed4fe58800000000000000000000000000000000000000000000000000000000ed4fe58900000000000000000000000000000000000000000000000000000000f9f60f4100000000000000000000000000000000000000000000000000000000ca15c87300000000000000000000000000000000000000000000000000000000d547741f0000000000000000000000000000000000000000000000000000000091d148530000000000000000000000000000000000000000000000000000000091d1485400000000000000000000000000000000000000000000000000000000a217fddf0000000000000000000000000000000000000000000000000000000036568abe000000000000000000000000000000000000000000000000000000009010d07c00000000000000000000000000000000000000000000000000000000296f5adf0000000000000000000000000000000000000000000000000000000031d66b610000000000000000000000000000000000000000000000000000000031d66b620000000000000000000000000000000000000000000000000000000034748c5000000000000000000000000000000000000000000000000000000000296f5ae0000000000000000000000000000000000000000000000000000000002f2ff15d0000000000000000000000000000000000000000000000000000000001ffc9a70000000000000000000000000000000000000000000000000000000005f6711f00000000000000000000000000000000000000000000000000000000248a9ca3000000000000000000000000000000000000000000000000ffffffffffffffff7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0000000000000000000000000000000000000000000000000ffffffffffffff7f000000000000000000000000000000000000000000000000fffffffffffffeff000000000000000000000000000000000000000000000000ffffffffffffffbf000000000000000000000000000000000000000000000000ffffffffffffff9f75ca53043ea007e5c65182cbb028f60d7179ff4b55739a3949b401801c942e6575ca53043ea007e5c65182cbb028f60d7179ff4b55739a3949b401801c942e64000000000000000000000000ffffffffffffffffffffffffffffffffffffffff75ca53043ea007e5c65182cbb028f60d7179ff4b55739a3949b401801c942e6375ca53043ea007e5c65182cbb028f60d7179ff4b55739a3949b401801c942e6275ca53043ea007e5c65182cbb028f60d7179ff4b55739a3949b401801c942e6175ca53043ea007e5c65182cbb028f60d7179ff4b55739a3949b401801c942e6075ca53043ea007e5c65182cbb028f60d7179ff4b55739a3949b401801c942e5f4e487b7100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002400000000000000000000000072f893640000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000008000000000000000000000000000000000000000000000000000000020000000800000000000000000000000000000000000000000000000000000002000000000000000000000000008c379a000000000000000000000000000000000000000000000000000000000416363657373436f6e74726f6c3a2063616e206f6e6c792072656e6f756e636520726f6c657320666f722073656c660000000000000000000000000000000000000000000000000000000000000000000000008400000080000000000000000041e2f3f800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000ffffffffffffff7b01000befcc44085b6911db43ffb42164a487541a53cc5c8d12239b437eb5a8dc9c4d535bdea7cd8a978f128b93471df48c7dbab89d703809115bdc118c235bfd0200000000000000000000000000000000000084000000000000000000000000ffffffffffffffffffffffff00000000000000000000000000000000000000001806aa1896bbf26568e884a7374b41e002500962caba6a15023a8d90e8508b8302000002000000000000000000000000000000240000000000000000000000007c18573100000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000ffffffffffffffffffffffffffffffff00000000000000000000000000000000000000000000000000000000ffffffe04b33c752e09f31d0dd77ae123750c1ac8e0636dd352b53f14c15104e973127a14db522090000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000000000000000000000005265656e7472616e637947756172643a207265656e7472616e742063616c6c000000000000000000000000000000000000000064000000e00000000000000000b0a7b376836a16413995648d87348fb89d57f4bf17fac35f55708e81f2be6140ce49214a0000000000000000000000000000000000000000000000000000000000000000ffffffffffffffffffffffffffffffffffffffffffffffffffffffff5a05180f0000000000000000000000000000000000000000000000000000000001ffc9a7000000000000000000000000000000000000000000000000000000007965db0b00000000000000000000000000000000000000000000000000000000ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb5000000000000000000000000000000000000000000000000ffffffffffffffa000ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff3000000000000000000000000000000000000000000000000000000000000000780000000000000000000000000000000000000000000000000000000000000030313233343536373839616263646566000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000537472696e67733a20686578206c656e67746820696e73756666696369656e740000000000000000000000000000000000000064000000000000000000000000416363657373436f6e74726f6c3a206163636f756e7420000000000000000000206973206d697373696e6720726f6c6520000000000000000000000000000000f6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b00000000000000000000000000000000000000000000000000000000000000002021f15daf75960ab2814e1bb378363cc701d46e89e1ef09db6aa837179198b2