Contract Address Details

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

import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "./PlaygroundFactory.sol";
import "./PlaygroundToken.sol";

/**
 * @title IPlaygroundDistributor
 * @dev Interface for PlaygroundDistributor contract
 */
interface IPlaygroundDistributor {
    struct Campaign {
        address depositor;
        address pairAddress;
        uint256 totalAmount;
        uint256 startTime;
        uint256 endTime;
        uint256 duration;
    }

    function getTotalCampaigns() external view returns (uint256);

    function getCampaignDetails(
        uint256 campaignId
    ) external view returns (Campaign memory);

    function createDistribution(
        uint256 amount,
        address pairAddress,
        uint256 durationDays
    ) external returns (uint256);

    function getVestedAmount(
        uint256 campaignId
    ) external view returns (uint256);
}

/**
 * @title IRouter
 * @dev Interface for PulseXRouter (Uniswap V2 style)
 */
interface IRouter {
    function swapExactETHForTokens(
        uint256 amountOutMin,
        address[] calldata path,
        address to,
        uint256 deadline
    ) external payable returns (uint256[] memory amounts);

    function getAmountsOut(
        uint256 amountIn,
        address[] calldata path
    ) external view returns (uint256[] memory amounts);
}

/**
 * @title PlaygroundGateway
 * @dev Gateway contract that wraps PlaygroundFactory operations with PLS fee collection
 * @notice Collects PLS fees for token creation, burn, and claim operations
 */
contract PlaygroundGateway is Ownable, ReentrancyGuard {
    using SafeERC20 for IERC20;

    /// @dev PlaygroundFactory contract reference
    PlaygroundFactory public constant factory =
        PlaygroundFactory(0xABef2874C5Ef165fc2194c180e06894871724b05);

    /// @dev Mandala token contract reference
    IERC20 public constant mandalaToken =
        IERC20(0x3a6c545c9E07e6d3041DC802033400F7fBf96c9a);

    /// @dev Base fee in PLS (wei) - default 10000 ether
    uint256 public baseFee;

    /// @dev Fixed fee for burn/claim operations (1000 PLS)
    uint256 public constant BURN_CLAIM_FEE = 1000 ether;

    /// @dev Dev wallet address (immutable)
    address public immutable devWallet;

    /// @dev Distribution threshold in PLS (wei) - default 2M PLS
    uint256 public distributionThreshold;

    /// @dev PlaygroundDistributor contract reference
    IPlaygroundDistributor public constant distributor =
        IPlaygroundDistributor(0x3Ba90C5a1840dedFDb9838fF4025df240d84A637);

    /// @dev MDALA token contract reference (same as mandalaToken)
    IERC20 public constant mdalaToken =
        IERC20(0x3a6c545c9E07e6d3041DC802033400F7fBf96c9a);

    /// @dev Wrapped PLS address
    address public constant wpls = 0xA1077a294dDE1B09bB078844df40758a5D0f9a27;

    /// @dev PulseXRouter address for swaps
    IRouter public constant router =
        IRouter(0x165C3410fC91EF562C50559f7d2289fEbed552d9);

    /**
     * @dev Event emitted when a token creation is routed through gateway
     * @param token Address of the newly created token
     * @param creator Address that created the token
     * @param feeAmount PLS fee collected
     * @param level Tree level (distance from deepest leaf)
     * @param nodesAtLevel Number of nodes at this level
     */
    event TokenCreationRouted(
        address indexed token,
        address indexed creator,
        uint256 feeAmount,
        uint256 level,
        uint256 nodesAtLevel
    );

    /**
     * @dev Event emitted when a burn operation is routed through gateway
     * @param token Token address
     * @param user User performing burn
     * @param feeAmount PLS fee collected
     */
    event BurnRouted(
        address indexed token,
        address indexed user,
        uint256 feeAmount
    );

    /**
     * @dev Event emitted when a claim operation is routed through gateway
     * @param token Token address
     * @param user User performing claim
     * @param feeAmount PLS fee collected
     */
    event ClaimRouted(
        address indexed token,
        address indexed user,
        uint256 feeAmount
    );

    /**
     * @dev Event emitted when base fee is updated
     * @param oldFee Previous base fee
     * @param newFee New base fee
     */
    event BaseFeeUpdated(uint256 oldFee, uint256 newFee);

    /**
     * @dev Event emitted when fees are withdrawn
     * @param recipient Recipient address
     * @param amount Amount withdrawn
     */
    event FeesWithdrawn(address indexed recipient, uint256 amount);

    /**
     * @dev Event emitted when auto-distribution is triggered
     * @param totalFees Total fees collected
     * @param devAmount Amount sent to dev wallet
     * @param distributedAmount Amount distributed to campaigns
     * @param campaignCount Number of campaigns created
     */
    event AutoDistributionTriggered(
        uint256 totalFees,
        uint256 devAmount,
        uint256 distributedAmount,
        uint256 campaignCount
    );

    /**
     * @dev Event emitted when distribution threshold is updated
     * @param oldThreshold Previous threshold
     * @param newThreshold New threshold
     */
    event DistributionThresholdUpdated(
        uint256 oldThreshold,
        uint256 newThreshold
    );

    /**
     * @dev Constructor
     * @param initialOwner Address of the initial owner
     */
    constructor(address initialOwner) Ownable(initialOwner) {
        require(
            initialOwner != address(0),
            "PlaygroundGateway: Owner cannot be zero address"
        );

        baseFee = 10000 ether; // Default 10,000 PLS
        devWallet = 0x35D360D7d53Cc96DF768fD2Dec2eEFA4C2f01292;
        distributionThreshold = 2_000_000 ether; // Default 2M PLS
    }

    /**
     * @dev Calculate fee for token creation
     * @param level Tree level (distance from deepest leaf)
     * @param nodesAtLevel Number of nodes at this level
     * @return Fee amount in PLS (wei)
     */
    function calculateCreateFee(
        uint256 level,
        uint256 nodesAtLevel
    ) public view returns (uint256) {
        // Formula: (baseFee * level) + ((baseFee / 10) * nodesAtLevel) + (baseFee / 10)
        return
            (baseFee * level) +
            ((baseFee / 10) * nodesAtLevel) +
            (baseFee / 10);
    }

    /**
     * @dev Create a new PlaygroundToken through the gateway
     * @param amount Amount of Mandala tokens to pay
     * @param parent Parent token address
     * @param name ERC20 token name
     * @param symbol ERC20 token symbol
     * @param description Token description
     * @param maxSupply Maximum supply cap
     * @param level Tree level (distance from deepest leaf)
     * @param nodesAtLevel Number of nodes at this level
     * @return tokenAddress Address of the newly created token
     */
    function createToken(
        uint256 amount,
        address parent,
        string memory name,
        string memory symbol,
        string memory description,
        uint256 maxSupply,
        uint256 level,
        uint256 nodesAtLevel
    ) external payable returns (address tokenAddress) {
        // Calculate and validate fee
        uint256 requiredFee = calculateCreateFee(level, nodesAtLevel);
        require(
            msg.value >= requiredFee,
            "PlaygroundGateway: Insufficient PLS fee"
        );

        // Transfer Mandala tokens from user to this contract
        mandalaToken.safeTransferFrom(msg.sender, address(this), amount);

        // Approve factory to spend Mandala tokens
        mandalaToken.approve(address(factory), amount);

        // Call factory to create token
        tokenAddress = factory.create(
            amount,
            parent,
            name,
            symbol,
            description,
            maxSupply
        );

        // Transfer minted tokens to user
        IERC20(tokenAddress).safeTransfer(msg.sender, amount);

        // Emit event
        emit TokenCreationRouted(
            tokenAddress,
            msg.sender,
            requiredFee,
            level,
            nodesAtLevel
        );

        // Refund excess PLS if any
        if (msg.value > requiredFee) {
            (bool success, ) = payable(msg.sender).call{
                value: msg.value - requiredFee
            }("");
            require(success, "PlaygroundGateway: PLS refund failed");
        }

        // Check threshold and trigger auto-distribution if needed
        _checkAndDistribute();

        return tokenAddress;
    }

    /**
     * @dev Burn tokens through the gateway (wrap parent tokens into child tokens)
     * @param token Child token address
     * @param amount Amount to burn (wrap)
     */
    function burn(address token, uint256 amount) external payable {
        require(
            msg.value >= BURN_CLAIM_FEE,
            "PlaygroundGateway: Insufficient PLS fee for burn"
        );

        // Get parent token address from child token
        address parentToken = PlaygroundToken(token).parent();

        // Transfer parent tokens from user to this contract
        IERC20(parentToken).safeTransferFrom(msg.sender, address(this), amount);

        // Approve child token to spend parent tokens
        IERC20(parentToken).approve(token, amount);

        // Call burn on PlaygroundToken (wraps parent tokens, mints child tokens to gateway)
        PlaygroundToken(token).burn(amount);

        // Transfer minted child tokens to user
        IERC20(token).safeTransfer(msg.sender, amount);

        // Emit event
        emit BurnRouted(token, msg.sender, BURN_CLAIM_FEE);

        // Refund excess PLS if any
        if (msg.value > BURN_CLAIM_FEE) {
            (bool success, ) = payable(msg.sender).call{
                value: msg.value - BURN_CLAIM_FEE
            }("");
            require(success, "PlaygroundGateway: PLS refund failed");
        }

        // Check threshold and trigger auto-distribution if needed
        _checkAndDistribute();
    }

    /**
     * @dev Claim tokens through the gateway (unwrap child tokens into parent tokens)
     * @param token Child token address to claim from
     * @param amount Amount to claim (unwrap)
     */
    function claim(address token, uint256 amount) external payable {
        require(
            msg.value >= BURN_CLAIM_FEE,
            "PlaygroundGateway: Insufficient PLS fee for claim"
        );

        // Transfer child tokens from user to this contract
        IERC20(token).safeTransferFrom(msg.sender, address(this), amount);

        // Call claim on PlaygroundToken (burns child tokens, sends parent tokens to gateway)
        PlaygroundToken(token).claim(amount);

        // Get parent token address
        address parentToken = PlaygroundToken(token).parent();

        // Transfer parent tokens to user
        IERC20(parentToken).safeTransfer(msg.sender, amount);

        // Emit event
        emit ClaimRouted(token, msg.sender, BURN_CLAIM_FEE);

        // Refund excess PLS if any
        if (msg.value > BURN_CLAIM_FEE) {
            (bool success, ) = payable(msg.sender).call{
                value: msg.value - BURN_CLAIM_FEE
            }("");
            require(success, "PlaygroundGateway: PLS refund failed");
        }

        // Check threshold and trigger auto-distribution if needed
        _checkAndDistribute();
    }

    /**
     * @dev Set base fee (owner only)
     * @param newBaseFee New base fee in PLS (wei)
     */
    function setBaseFee(uint256 newBaseFee) external onlyOwner {
        uint256 oldFee = baseFee;
        baseFee = newBaseFee;
        emit BaseFeeUpdated(oldFee, newBaseFee);
    }

    /**
     * @dev Get current base fee
     * @return Current base fee in PLS (wei)
     */
    function getBaseFee() external view returns (uint256) {
        return baseFee;
    }

    /**
     * @dev Set distribution threshold (owner only)
     * @param newThreshold New threshold in PLS (wei)
     */
    function setDistributionThreshold(uint256 newThreshold) external onlyOwner {
        uint256 oldThreshold = distributionThreshold;
        distributionThreshold = newThreshold;
        emit DistributionThresholdUpdated(oldThreshold, newThreshold);
    }

    /**
     * @dev Struct to hold campaign information for sorting
     * @param campaignId Campaign ID
     * @param pairAddress LP token pair address
     * @param totalAmount Remaining unvested amount (not yet released by vesting schedule)
     */
    struct CampaignInfo {
        uint256 campaignId;
        address pairAddress;
        uint256 totalAmount;
    }

    /**
     * @dev Get top active campaigns sorted by remaining unvested amount
     * @param count Number of top campaigns to return
     * @return Array of CampaignInfo structs with remaining unvested amounts
     */
    function _getTopActiveCampaigns(
        uint256 count
    ) internal view returns (CampaignInfo[] memory) {
        uint256 totalCampaigns = distributor.getTotalCampaigns();
        if (totalCampaigns == 0) {
            return new CampaignInfo[](0);
        }

        // Collect all active campaigns
        CampaignInfo[] memory activeCampaigns = new CampaignInfo[](
            totalCampaigns
        );
        uint256 activeCount = 0;
        uint256 currentTime = block.timestamp;

        for (uint256 i = 0; i < totalCampaigns; i++) {
            IPlaygroundDistributor.Campaign memory campaign = distributor
                .getCampaignDetails(i);
            // Check if campaign is active (endTime > currentTime)
            if (campaign.endTime > currentTime && campaign.totalAmount > 0) {
                // Calculate remaining unvested amount
                uint256 vestedAmount = distributor.getVestedAmount(i);
                uint256 remainingAmount = campaign.totalAmount - vestedAmount;

                // Only include campaigns with unvested tokens
                if (remainingAmount > 0) {
                    activeCampaigns[activeCount] = CampaignInfo({
                        campaignId: i,
                        pairAddress: campaign.pairAddress,
                        totalAmount: remainingAmount
                    });
                    activeCount++;
                }
            }
        }

        if (activeCount == 0) {
            return new CampaignInfo[](0);
        }

        // Resize array to actual active count
        CampaignInfo[] memory resized = new CampaignInfo[](activeCount);
        for (uint256 i = 0; i < activeCount; i++) {
            resized[i] = activeCampaigns[i];
        }

        // Sort by remaining unvested amount descending (bubble sort for simplicity)
        for (uint256 i = 0; i < resized.length; i++) {
            for (uint256 j = 0; j < resized.length - i - 1; j++) {
                if (resized[j].totalAmount < resized[j + 1].totalAmount) {
                    CampaignInfo memory temp = resized[j];
                    resized[j] = resized[j + 1];
                    resized[j + 1] = temp;
                }
            }
        }

        // Return top count campaigns
        uint256 returnCount = count < resized.length ? count : resized.length;
        CampaignInfo[] memory topCampaigns = new CampaignInfo[](returnCount);
        for (uint256 i = 0; i < returnCount; i++) {
            topCampaigns[i] = resized[i];
        }

        return topCampaigns;
    }

    /**
     * @dev Swap PLS for MDALA tokens using PulseXRouter
     * @param plsAmount Amount of PLS to swap
     * @return mdalaAmount Amount of MDALA tokens received
     */
    function _swapPLSForMDALA(
        uint256 plsAmount
    ) internal returns (uint256 mdalaAmount) {
        require(plsAmount > 0, "PlaygroundGateway: PLS amount must be > 0");

        // Calculate minimum output with 0.5% slippage tolerance
        address[] memory path = new address[](2);
        path[0] = wpls;
        path[1] = address(mdalaToken);

        uint256[] memory amountsOut = router.getAmountsOut(plsAmount, path);
        uint256 expectedMDALA = amountsOut[1];
        uint256 minMDALA = (expectedMDALA * 995) / 1000; // 0.5% slippage

        // Perform swap
        uint256[] memory amounts = router.swapExactETHForTokens{
            value: plsAmount
        }(minMDALA, path, address(this), block.timestamp + 300);

        return amounts[1];
    }

    /**
     * @dev Distribute MDALA tokens proportionally to top campaigns
     * @param totalMDALA Total MDALA amount to distribute
     * @param topCampaigns Array of top campaigns
     */
    function _distributeToCampaigns(
        uint256 totalMDALA,
        CampaignInfo[] memory topCampaigns
    ) internal {
        if (topCampaigns.length == 0 || totalMDALA == 0) {
            return;
        }

        // Calculate total amount across all campaigns for proportional split
        uint256 totalCampaignAmount = 0;
        for (uint256 i = 0; i < topCampaigns.length; i++) {
            totalCampaignAmount += topCampaigns[i].totalAmount;
        }

        if (totalCampaignAmount == 0) {
            return;
        }

        // Approve distributor to spend MDALA tokens
        // Reset allowance to 0 first, then set new allowance
        uint256 currentAllowance = mdalaToken.allowance(
            address(this),
            address(distributor)
        );
        if (currentAllowance > 0) {
            SafeERC20.safeDecreaseAllowance(
                mdalaToken,
                address(distributor),
                currentAllowance
            );
        }
        SafeERC20.safeIncreaseAllowance(
            mdalaToken,
            address(distributor),
            totalMDALA
        );

        // Distribute proportionally to each campaign
        for (uint256 i = 0; i < topCampaigns.length; i++) {
            // Calculate proportional share
            uint256 proportionalShare = (totalMDALA *
                topCampaigns[i].totalAmount) / totalCampaignAmount;

            if (proportionalShare > 0) {
                // Create new 7-day distribution campaign
                distributor.createDistribution(
                    proportionalShare,
                    topCampaigns[i].pairAddress,
                    7 // 7 days duration
                );
            }
        }
    }

    /**
     * @dev Check if threshold is reached and trigger auto-distribution
     */
    function _checkAndDistribute() internal nonReentrant {
        uint256 balance = address(this).balance;
        if (balance < distributionThreshold) {
            return;
        }

        // Calculate 10% for dev wallet
        uint256 devAmount = (balance * 10) / 100;
        uint256 remainingAmount = balance - devAmount;

        // Send 10% to dev wallet
        if (devAmount > 0) {
            (bool success, ) = payable(devWallet).call{value: devAmount}("");
            require(success, "PlaygroundGateway: Dev wallet transfer failed");
        }

        // Get top 5 active campaigns
        CampaignInfo[] memory topCampaigns = _getTopActiveCampaigns(5);

        uint256 distributedAmount = 0;
        uint256 campaignCount = 0;

        if (topCampaigns.length > 0 && remainingAmount > 0) {
            // Swap PLS to MDALA
            uint256 mdalaAmount = _swapPLSForMDALA(remainingAmount);

            if (mdalaAmount > 0) {
                // Distribute MDALA to campaigns
                _distributeToCampaigns(mdalaAmount, topCampaigns);
                distributedAmount = mdalaAmount;
                campaignCount = topCampaigns.length;
            }
        }

        emit AutoDistributionTriggered(
            balance,
            devAmount,
            distributedAmount,
            campaignCount
        );
    }

    /**
     * @dev Withdraw collected PLS fees (owner only)
     * @param recipient Address to receive fees
     */
    function withdrawFees(address payable recipient) external onlyOwner {
        require(
            recipient != address(0),
            "PlaygroundGateway: Recipient cannot be zero address"
        );

        uint256 balance = address(this).balance;
        require(balance > 0, "PlaygroundGateway: No fees to withdraw");

        emit FeesWithdrawn(recipient, balance);

        (bool success, ) = recipient.call{value: balance}("");
        require(success, "PlaygroundGateway: Fee withdrawal failed");
    }

    /**
     * @dev Receive function to accept PLS
     */
    receive() external payable {}
}
        

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol)

pragma solidity >=0.4.16;

/**
 * @dev Interface of the ERC-165 standard, as defined in the
 * https://eips.ethereum.org/EIPS/eip-165[ERC].
 *
 * 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[ERC section]
     * to learn more about how these ids are created.
     *
     * This function call must use less than 30 000 gas.
     */
    function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
          

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC20.sol)

pragma solidity >=0.4.16;

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC165.sol)

pragma solidity >=0.4.16;

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/extensions/IERC20Metadata.sol)

pragma solidity >=0.6.2;

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

/**
 * @dev Interface for the optional metadata functions from the ERC-20 standard.
 */
interface IERC20Metadata is IERC20 {
    /**
     * @dev Returns the name of the token.
     */
    function name() external view returns (string memory);

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

    /**
     * @dev Returns the decimals places of the token.
     */
    function decimals() external view returns (uint8);
}
          

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/draft-IERC6093.sol)
pragma solidity >=0.8.4;

/**
 * @dev Standard ERC-20 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
 */
interface IERC20Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC20InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC20InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     * @param allowance Amount of tokens a `spender` is allowed to operate with.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC20InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `spender` to be approved. Used in approvals.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC20InvalidSpender(address spender);
}

/**
 * @dev Standard ERC-721 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
 */
interface IERC721Errors {
    /**
     * @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20.
     * Used in balance queries.
     * @param owner Address of the current owner of a token.
     */
    error ERC721InvalidOwner(address owner);

    /**
     * @dev Indicates a `tokenId` whose `owner` is the zero address.
     * @param tokenId Identifier number of a token.
     */
    error ERC721NonexistentToken(uint256 tokenId);

    /**
     * @dev Indicates an error related to the ownership over a particular token. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param tokenId Identifier number of a token.
     * @param owner Address of the current owner of a token.
     */
    error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC721InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC721InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param tokenId Identifier number of a token.
     */
    error ERC721InsufficientApproval(address operator, uint256 tokenId);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC721InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC721InvalidOperator(address operator);
}

/**
 * @dev Standard ERC-1155 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
 */
interface IERC1155Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     * @param tokenId Identifier number of a token.
     */
    error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC1155InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC1155InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param owner Address of the current owner of a token.
     */
    error ERC1155MissingApprovalForAll(address operator, address owner);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC1155InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC1155InvalidOperator(address operator);

    /**
     * @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
     * Used in batch transfers.
     * @param idsLength Length of the array of token identifiers
     * @param valuesLength Length of the array of token amounts
     */
    error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}
          

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)

pragma solidity ^0.8.20;

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

    function _contextSuffixLength() internal view virtual returns (uint256) {
        return 0;
    }
}
          

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC1363.sol)

pragma solidity >=0.6.2;

import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";

/**
 * @title IERC1363
 * @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
 *
 * Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
 * after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
 */
interface IERC1363 is IERC20, IERC165 {
    /*
     * Note: the ERC-165 identifier for this interface is 0xb0202a11.
     * 0xb0202a11 ===
     *   bytes4(keccak256('transferAndCall(address,uint256)')) ^
     *   bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
     *   bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
     *   bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
     *   bytes4(keccak256('approveAndCall(address,uint256)')) ^
     *   bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
     */

    /**
     * @dev Moves a `value` amount of tokens from the caller's account to `to`
     * and then calls {IERC1363Receiver-onTransferReceived} on `to`.
     * @param to The address which you want to transfer to.
     * @param value The amount of tokens to be transferred.
     * @return A boolean value indicating whether the operation succeeded unless throwing.
     */
    function transferAndCall(address to, uint256 value) external returns (bool);

    /**
     * @dev Moves a `value` amount of tokens from the caller's account to `to`
     * and then calls {IERC1363Receiver-onTransferReceived} on `to`.
     * @param to The address which you want to transfer to.
     * @param value The amount of tokens to be transferred.
     * @param data Additional data with no specified format, sent in call to `to`.
     * @return A boolean value indicating whether the operation succeeded unless throwing.
     */
    function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);

    /**
     * @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
     * and then calls {IERC1363Receiver-onTransferReceived} on `to`.
     * @param from The address which you want to send tokens from.
     * @param to The address which you want to transfer to.
     * @param value The amount of tokens to be transferred.
     * @return A boolean value indicating whether the operation succeeded unless throwing.
     */
    function transferFromAndCall(address from, address to, uint256 value) external returns (bool);

    /**
     * @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
     * and then calls {IERC1363Receiver-onTransferReceived} on `to`.
     * @param from The address which you want to send tokens from.
     * @param to The address which you want to transfer to.
     * @param value The amount of tokens to be transferred.
     * @param data Additional data with no specified format, sent in call to `to`.
     * @return A boolean value indicating whether the operation succeeded unless throwing.
     */
    function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);

    /**
     * @dev Sets a `value` amount of tokens as the allowance of `spender` over the
     * caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
     * @param spender The address which will spend the funds.
     * @param value The amount of tokens to be spent.
     * @return A boolean value indicating whether the operation succeeded unless throwing.
     */
    function approveAndCall(address spender, uint256 value) external returns (bool);

    /**
     * @dev Sets a `value` amount of tokens as the allowance of `spender` over the
     * caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
     * @param spender The address which will spend the funds.
     * @param value The amount of tokens to be spent.
     * @param data Additional data with no specified format, sent in call to `spender`.
     * @return A boolean value indicating whether the operation succeeded unless throwing.
     */
    function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}
          

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (token/ERC20/ERC20.sol)

pragma solidity ^0.8.20;

import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";

/**
 * @dev Implementation of the {IERC20} interface.
 *
 * This implementation is agnostic to the way tokens are created. This means
 * that a supply mechanism has to be added in a derived contract using {_mint}.
 *
 * TIP: For a detailed writeup see our guide
 * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
 * to implement supply mechanisms].
 *
 * The default value of {decimals} is 18. To change this, you should override
 * this function so it returns a different value.
 *
 * We have followed general OpenZeppelin Contracts guidelines: functions revert
 * instead returning `false` on failure. This behavior is nonetheless
 * conventional and does not conflict with the expectations of ERC-20
 * applications.
 */
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
    mapping(address account => uint256) private _balances;

    mapping(address account => mapping(address spender => uint256)) private _allowances;

    uint256 private _totalSupply;

    string private _name;
    string private _symbol;

    /**
     * @dev Sets the values for {name} and {symbol}.
     *
     * Both values are immutable: they can only be set once during construction.
     */
    constructor(string memory name_, string memory symbol_) {
        _name = name_;
        _symbol = symbol_;
    }

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

    /**
     * @dev Returns the symbol of the token, usually a shorter version of the
     * name.
     */
    function symbol() public view virtual returns (string memory) {
        return _symbol;
    }

    /**
     * @dev Returns the number of decimals used to get its user representation.
     * For example, if `decimals` equals `2`, a balance of `505` tokens should
     * be displayed to a user as `5.05` (`505 / 10 ** 2`).
     *
     * Tokens usually opt for a value of 18, imitating the relationship between
     * Ether and Wei. This is the default value returned by this function, unless
     * it's overridden.
     *
     * NOTE: This information is only used for _display_ purposes: it in
     * no way affects any of the arithmetic of the contract, including
     * {IERC20-balanceOf} and {IERC20-transfer}.
     */
    function decimals() public view virtual returns (uint8) {
        return 18;
    }

    /// @inheritdoc IERC20
    function totalSupply() public view virtual returns (uint256) {
        return _totalSupply;
    }

    /// @inheritdoc IERC20
    function balanceOf(address account) public view virtual returns (uint256) {
        return _balances[account];
    }

    /**
     * @dev See {IERC20-transfer}.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - the caller must have a balance of at least `value`.
     */
    function transfer(address to, uint256 value) public virtual returns (bool) {
        address owner = _msgSender();
        _transfer(owner, to, value);
        return true;
    }

    /// @inheritdoc IERC20
    function allowance(address owner, address spender) public view virtual returns (uint256) {
        return _allowances[owner][spender];
    }

    /**
     * @dev See {IERC20-approve}.
     *
     * NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
     * `transferFrom`. This is semantically equivalent to an infinite approval.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     */
    function approve(address spender, uint256 value) public virtual returns (bool) {
        address owner = _msgSender();
        _approve(owner, spender, value);
        return true;
    }

    /**
     * @dev See {IERC20-transferFrom}.
     *
     * Skips emitting an {Approval} event indicating an allowance update. This is not
     * required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
     *
     * NOTE: Does not update the allowance if the current allowance
     * is the maximum `uint256`.
     *
     * Requirements:
     *
     * - `from` and `to` cannot be the zero address.
     * - `from` must have a balance of at least `value`.
     * - the caller must have allowance for ``from``'s tokens of at least
     * `value`.
     */
    function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
        address spender = _msgSender();
        _spendAllowance(from, spender, value);
        _transfer(from, to, value);
        return true;
    }

    /**
     * @dev Moves a `value` amount of tokens from `from` to `to`.
     *
     * This internal function is equivalent to {transfer}, and can be used to
     * e.g. implement automatic token fees, slashing mechanisms, etc.
     *
     * Emits a {Transfer} event.
     *
     * NOTE: This function is not virtual, {_update} should be overridden instead.
     */
    function _transfer(address from, address to, uint256 value) internal {
        if (from == address(0)) {
            revert ERC20InvalidSender(address(0));
        }
        if (to == address(0)) {
            revert ERC20InvalidReceiver(address(0));
        }
        _update(from, to, value);
    }

    /**
     * @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
     * (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
     * this function.
     *
     * Emits a {Transfer} event.
     */
    function _update(address from, address to, uint256 value) internal virtual {
        if (from == address(0)) {
            // Overflow check required: The rest of the code assumes that totalSupply never overflows
            _totalSupply += value;
        } else {
            uint256 fromBalance = _balances[from];
            if (fromBalance < value) {
                revert ERC20InsufficientBalance(from, fromBalance, value);
            }
            unchecked {
                // Overflow not possible: value <= fromBalance <= totalSupply.
                _balances[from] = fromBalance - value;
            }
        }

        if (to == address(0)) {
            unchecked {
                // Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
                _totalSupply -= value;
            }
        } else {
            unchecked {
                // Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
                _balances[to] += value;
            }
        }

        emit Transfer(from, to, value);
    }

    /**
     * @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
     * Relies on the `_update` mechanism
     *
     * Emits a {Transfer} event with `from` set to the zero address.
     *
     * NOTE: This function is not virtual, {_update} should be overridden instead.
     */
    function _mint(address account, uint256 value) internal {
        if (account == address(0)) {
            revert ERC20InvalidReceiver(address(0));
        }
        _update(address(0), account, value);
    }

    /**
     * @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
     * Relies on the `_update` mechanism.
     *
     * Emits a {Transfer} event with `to` set to the zero address.
     *
     * NOTE: This function is not virtual, {_update} should be overridden instead
     */
    function _burn(address account, uint256 value) internal {
        if (account == address(0)) {
            revert ERC20InvalidSender(address(0));
        }
        _update(account, address(0), value);
    }

    /**
     * @dev Sets `value` as the allowance of `spender` over the `owner`'s tokens.
     *
     * This internal function is equivalent to `approve`, and can be used to
     * e.g. set automatic allowances for certain subsystems, etc.
     *
     * Emits an {Approval} event.
     *
     * Requirements:
     *
     * - `owner` cannot be the zero address.
     * - `spender` cannot be the zero address.
     *
     * Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
     */
    function _approve(address owner, address spender, uint256 value) internal {
        _approve(owner, spender, value, true);
    }

    /**
     * @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
     *
     * By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
     * `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
     * `Approval` event during `transferFrom` operations.
     *
     * Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
     * true using the following override:
     *
     * ```solidity
     * function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
     *     super._approve(owner, spender, value, true);
     * }
     * ```
     *
     * Requirements are the same as {_approve}.
     */
    function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
        if (owner == address(0)) {
            revert ERC20InvalidApprover(address(0));
        }
        if (spender == address(0)) {
            revert ERC20InvalidSpender(address(0));
        }
        _allowances[owner][spender] = value;
        if (emitEvent) {
            emit Approval(owner, spender, value);
        }
    }

    /**
     * @dev Updates `owner`'s allowance for `spender` based on spent `value`.
     *
     * Does not update the allowance value in case of infinite allowance.
     * Revert if not enough allowance is available.
     *
     * Does not emit an {Approval} event.
     */
    function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
        uint256 currentAllowance = allowance(owner, spender);
        if (currentAllowance < type(uint256).max) {
            if (currentAllowance < value) {
                revert ERC20InsufficientAllowance(spender, currentAllowance, value);
            }
            unchecked {
                _approve(owner, spender, currentAllowance - value, false);
            }
        }
    }
}
          

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

pragma solidity ^0.8.20;

import {Context} from "../utils/Context.sol";

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

    /**
     * @dev The caller account is not authorized to perform an operation.
     */
    error OwnableUnauthorizedAccount(address account);

    /**
     * @dev The owner is not a valid owner account. (eg. `address(0)`)
     */
    error OwnableInvalidOwner(address owner);

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

    /**
     * @dev Initializes the contract setting the address provided by the deployer as the initial owner.
     */
    constructor(address initialOwner) {
        if (initialOwner == address(0)) {
            revert OwnableInvalidOwner(address(0));
        }
        _transferOwnership(initialOwner);
    }

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

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

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

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

    /**
     * @dev Transfers ownership of the contract to a new account (`newOwner`).
     * Can only be called by the current owner.
     */
    function transferOwnership(address newOwner) public virtual onlyOwner {
        if (newOwner == address(0)) {
            revert OwnableInvalidOwner(address(0));
        }
        _transferOwnership(newOwner);
    }

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

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

pragma solidity >=0.4.16;

/**
 * @dev Interface of the ERC-20 standard as defined in the ERC.
 */
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 value of tokens in existence.
     */
    function totalSupply() external view returns (uint256);

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

    /**
     * @dev Moves a `value` amount of 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 value) 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 a `value` amount of tokens 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 value) external returns (bool);

    /**
     * @dev Moves a `value` amount of tokens from `from` to `to` using the
     * allowance mechanism. `value` 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 value) external returns (bool);
}
          

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

pragma solidity ^0.8.20;

import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";

/**
 * @title SafeERC20
 * @dev Wrappers around ERC-20 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 {
    /**
     * @dev An operation with an ERC-20 token failed.
     */
    error SafeERC20FailedOperation(address token);

    /**
     * @dev Indicates a failed `decreaseAllowance` request.
     */
    error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);

    /**
     * @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.encodeCall(token.transfer, (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.encodeCall(token.transferFrom, (from, to, value)));
    }

    /**
     * @dev Variant of {safeTransfer} that returns a bool instead of reverting if the operation is not successful.
     */
    function trySafeTransfer(IERC20 token, address to, uint256 value) internal returns (bool) {
        return _callOptionalReturnBool(token, abi.encodeCall(token.transfer, (to, value)));
    }

    /**
     * @dev Variant of {safeTransferFrom} that returns a bool instead of reverting if the operation is not successful.
     */
    function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) internal returns (bool) {
        return _callOptionalReturnBool(token, abi.encodeCall(token.transferFrom, (from, to, 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.
     *
     * IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
     * smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
     * this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
     * that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
     */
    function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
        uint256 oldAllowance = token.allowance(address(this), spender);
        forceApprove(token, spender, oldAllowance + value);
    }

    /**
     * @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
     * value, non-reverting calls are assumed to be successful.
     *
     * IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
     * smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
     * this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
     * that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
     */
    function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
        unchecked {
            uint256 currentAllowance = token.allowance(address(this), spender);
            if (currentAllowance < requestedDecrease) {
                revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
            }
            forceApprove(token, spender, currentAllowance - requestedDecrease);
        }
    }

    /**
     * @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
     * non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
     * to be set to zero before setting it to a non-zero value, such as USDT.
     *
     * NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
     * only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
     * set here.
     */
    function forceApprove(IERC20 token, address spender, uint256 value) internal {
        bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));

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

    /**
     * @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
     * code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
     * targeting contracts.
     *
     * Reverts if the returned value is other than `true`.
     */
    function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
        if (to.code.length == 0) {
            safeTransfer(token, to, value);
        } else if (!token.transferAndCall(to, value, data)) {
            revert SafeERC20FailedOperation(address(token));
        }
    }

    /**
     * @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
     * has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
     * targeting contracts.
     *
     * Reverts if the returned value is other than `true`.
     */
    function transferFromAndCallRelaxed(
        IERC1363 token,
        address from,
        address to,
        uint256 value,
        bytes memory data
    ) internal {
        if (to.code.length == 0) {
            safeTransferFrom(token, from, to, value);
        } else if (!token.transferFromAndCall(from, to, value, data)) {
            revert SafeERC20FailedOperation(address(token));
        }
    }

    /**
     * @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
     * code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
     * targeting contracts.
     *
     * NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
     * Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
     * once without retrying, and relies on the returned value to be true.
     *
     * Reverts if the returned value is other than `true`.
     */
    function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
        if (to.code.length == 0) {
            forceApprove(token, to, value);
        } else if (!token.approveAndCall(to, value, data)) {
            revert SafeERC20FailedOperation(address(token));
        }
    }

    /**
     * @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 {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
     */
    function _callOptionalReturn(IERC20 token, bytes memory data) private {
        uint256 returnSize;
        uint256 returnValue;
        assembly ("memory-safe") {
            let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
            // bubble errors
            if iszero(success) {
                let ptr := mload(0x40)
                returndatacopy(ptr, 0, returndatasize())
                revert(ptr, returndatasize())
            }
            returnSize := returndatasize()
            returnValue := mload(0)
        }

        if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
            revert SafeERC20FailedOperation(address(token));
        }
    }

    /**
     * @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 silently catches all reverts and returns a bool instead.
     */
    function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
        bool success;
        uint256 returnSize;
        uint256 returnValue;
        assembly ("memory-safe") {
            success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
            returnSize := returndatasize()
            returnValue := mload(0)
        }
        return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
    }
}
          

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)

pragma solidity ^0.8.20;

/**
 * @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 EIP-1153 (transient storage) is available on the chain you're deploying at,
 * consider using {ReentrancyGuardTransient} instead.
 *
 * 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;

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

    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
        if (_status == ENTERED) {
            revert ReentrancyGuardReentrantCall();
        }

        // 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: MIT
pragma solidity ^0.8.20;

import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "./PlaygroundToken.sol";

/**
 * @title PlaygroundFactory
 * @dev Factory contract for creating PlaygroundToken instances
 * @notice Users pay Mandala tokens to create new PlaygroundToken instances
 */
contract PlaygroundFactory {
    using SafeERC20 for IERC20;

    /// @dev Dead address for burning tokens
    address private constant DEAD_ADDRESS =
        0x000000000000000000000000000000000000dEaD;

    /// @dev Mandala token address (immutable)
    IERC20 public immutable mandalaToken;

    /// @dev Array of all created PlaygroundToken addresses
    address[] public allTokens;

    /**
     * @dev Event emitted when a new PlaygroundToken is created
     * @param token Address of the newly created token
     * @param creator Address that created the token
     * @param amount Initial amount of PlaygroundTokens minted
     * @param parent Parent token address
     * @param maxSupply Maximum supply of the token
     */
    event TokenCreated(
        address indexed token,
        address indexed creator,
        uint256 amount,
        address parent,
        uint256 maxSupply
    );

    /**
     * @dev Constructor
     * @param mandalaTokenAddress Address of the Mandala token contract
     */
    constructor(address mandalaTokenAddress) {
        require(
            mandalaTokenAddress != address(0),
            "PlaygroundFactory: Mandala token cannot be zero address"
        );
        mandalaToken = IERC20(mandalaTokenAddress);
    }

    /**
     * @dev Create a new PlaygroundToken instance
     * @param amount Amount of Mandala tokens to pay (and initial PlaygroundTokens to mint)
     * @param parent Parent token address for wrapping/unwrapping
     * @param name ERC20 token name
     * @param symbol ERC20 token symbol
     * @param description Token description
     * @param maxSupply Maximum supply cap (must be >= 1 billion tokens)
     * @return tokenAddress Address of the newly created PlaygroundToken
     */
    function create(
        uint256 amount,
        address parent,
        string memory name,
        string memory symbol,
        string memory description,
        uint256 maxSupply
    ) external returns (address tokenAddress) {
        require(
            amount > 0,
            "PlaygroundFactory: amount must be greater than zero"
        );
        require(
            parent != address(0),
            "PlaygroundFactory: parent cannot be zero address"
        );
        require(
            maxSupply >= 1_000_000_000 * 10 ** 18,
            "PlaygroundFactory: maxSupply must be at least 1 billion tokens"
        );
        require(
            amount <= maxSupply,
            "PlaygroundFactory: initial amount cannot exceed maxSupply"
        );

        // Transfer Mandala tokens from user to dead address (burn)
        // Check allowance first
        uint256 allowance = mandalaToken.allowance(msg.sender, address(this));
        require(
            allowance >= amount,
            "PlaygroundFactory: insufficient Mandala token allowance"
        );

        // Check balance
        uint256 balance = mandalaToken.balanceOf(msg.sender);
        require(
            balance >= amount,
            "PlaygroundFactory: insufficient Mandala token balance"
        );

        mandalaToken.safeTransferFrom(msg.sender, DEAD_ADDRESS, amount);

        // Deploy new PlaygroundToken instance
        PlaygroundToken newToken = new PlaygroundToken(
            name,
            symbol,
            address(this), // Factory address for minting access control
            parent,
            description,
            maxSupply
        );

        tokenAddress = address(newToken);

        // Mint initial supply to creator
        newToken.mint(msg.sender, amount);

        // Add token address to array
        allTokens.push(tokenAddress);

        // Emit event
        emit TokenCreated(tokenAddress, msg.sender, amount, parent, maxSupply);

        return tokenAddress;
    }

    /**
     * @dev Get the total number of created tokens
     * @return Total count of created PlaygroundTokens
     */
    function tokenCount() external view returns (uint256) {
        return allTokens.length;
    }
}
          

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

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

/**
 * @title PlaygroundToken
 * @dev ERC20 token with wrap/unwrap functionality using parent tokens
 * @notice Users can wrap parent tokens to receive PlaygroundTokens (burn function)
 *         and unwrap PlaygroundTokens to get back parent tokens (claim function)
 */
contract PlaygroundToken is ERC20, Ownable, ReentrancyGuard {
    using SafeERC20 for IERC20;

    /// @dev Parent token address used for wrapping/unwrapping
    address public parent;

    /// @dev Token description
    string public description;

    /// @dev Maximum supply cap (immutable)
    uint256 public immutable maxSupply;

    /// @dev Factory address that can mint tokens (immutable)
    address public immutable factory;

    /**
     * @dev Constructor
     * @param name ERC20 token name
     * @param symbol ERC20 token symbol
     * @param factoryAddress Factory contract address (for minting access control)
     * @param parentToken Parent token address for wrapping/unwrapping
     * @param tokenDescription Token description
     * @param maxTokenSupply Maximum supply cap (must be >= 1 billion tokens)
     */
    constructor(
        string memory name,
        string memory symbol,
        address factoryAddress,
        address parentToken,
        string memory tokenDescription,
        uint256 maxTokenSupply
    ) ERC20(name, symbol) Ownable(msg.sender) {
        require(parentToken != address(0), "PlaygroundToken: parent token cannot be zero address");
        require(
            maxTokenSupply >= 1_000_000_000 * 10**18,
            "PlaygroundToken: maxSupply must be at least 1 billion tokens"
        );

        parent = parentToken;
        description = tokenDescription;
        maxSupply = maxTokenSupply;
        factory = factoryAddress;
    }

    /**
     * @dev Wrap parent tokens into PlaygroundTokens
     * @notice Transfers parent tokens from user and mints PlaygroundTokens
     * @param amount Amount of parent tokens to wrap
     */
    function burn(uint256 amount) external {
        require(amount > 0, "PlaygroundToken: amount must be greater than zero");

        // Transfer parent tokens from user to this contract
        IERC20(parent).safeTransferFrom(msg.sender, address(this), amount);

        // Check max supply constraint
        require(
            totalSupply() + amount <= maxSupply,
            "PlaygroundToken: would exceed max supply"
        );

        // Mint PlaygroundTokens to user
        _mint(msg.sender, amount);
    }

    /**
     * @dev Unwrap PlaygroundTokens back to parent tokens
     * @notice Burns PlaygroundTokens and transfers parent tokens to user
     * @param amount Amount of PlaygroundTokens to unwrap
     */
    function claim(uint256 amount) external nonReentrant {
        require(amount > 0, "PlaygroundToken: amount must be greater than zero");

        // Burn PlaygroundTokens from user
        _burn(msg.sender, amount);

        // Transfer parent tokens from contract to user
        IERC20(parent).safeTransfer(msg.sender, amount);
    }

    /**
     * @dev Mint tokens (only callable by factory)
     * @notice Used by factory during token creation and for future minting logic
     * @param to Address to mint tokens to
     * @param amount Amount of tokens to mint
     */
    function mint(address to, uint256 amount) external {
        require(msg.sender == factory, "PlaygroundToken: only factory can mint");
        require(amount > 0, "PlaygroundToken: amount must be greater than zero");
        require(
            totalSupply() + amount <= maxSupply,
            "PlaygroundToken: would exceed max supply"
        );

        _mint(to, amount);
    }
}