Contract Address Details

// SPDX-License-Identifier: GPL-3.0-only
pragma solidity ^0.8.0;

import "./interface/ISwitchRouter.sol";
import "./interface/IERC20.sol";
import "./interface/IERC1271.sol";
import "./interface/IWETH.sol";
import "./lib/SafeERC20.sol";
import "./lib/Maintainable.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";

/**
 * @title SwitchLimitOrder
 * @notice Gasless EIP-712 signed limit orders for Switch DEX aggregator.
 *
 *         Users approve once and sign order messages off-chain. Operators (fillers)
 *         fill orders by routing through SwitchRouter.
 *
 *         Four execution modes (feeOnOutput × excessOnInput):
 *
 *         ┌────────────────┬─────────────────────────────────────────────────┐
 *         │ feeOnInput     │ Tokens pulled to this contract first.           │
 *         │ excessOnInput  │ Fee deducted from input. Filler keeps unswapped │
 *         │                │ input. Output → recipient directly.             │
 *         │                │ BEST FOR: tax output tokens, regular tokens.    │
 *         ├────────────────┼─────────────────────────────────────────────────┤
 *         │ feeOnInput     │ Tokens pulled to this contract first.           │
 *         │ excessOnOutput │ Fee deducted from input. All remaining input    │
 *         │                │ routed. Output → contract. Maker gets           │
 *         │                │ minAmountOut, filler keeps output surplus.      │
 *         ├────────────────┼─────────────────────────────────────────────────┤
 *         │ feeOnOutput    │ Router pulls from maker directly via            │
 *         │ excessOnInput  │ goSwitchFrom (1 transfer for tax input).        │
 *         │                │ Excess input pulled to filler separately.       │
 *         │                │ Output → contract for fee deduction → maker.    │
 *         ├────────────────┼─────────────────────────────────────────────────┤
 *         │ feeOnOutput    │ Router pulls ALL input from maker directly.     │
 *         │ excessOnOutput │ Output → contract. Fee deducted from output.    │
 *         │                │ Maker gets minAmountOut, filler keeps surplus.  │
 *         │                │ BEST FOR: tax input tokens.                     │
 *         └────────────────┴─────────────────────────────────────────────────┘
 *
 *         Tax token guidelines (enforced by frontend):
 *           - Tax input token  → use feeOnOutput (avoids double-taxing input)
 *           - Tax output token → use feeOnInput + excessOnInput (output direct to recipient)
 *           - Both tax         → not supported (frontend blocks order creation)
 *
 *         This contract must be set as FEE_EXEMPT on the SwitchRouter.
 *         This contract must be set as LIMIT_ORDER_CONTRACT on the SwitchRouter.
 */
contract SwitchLimitOrder is Maintainable, ReentrancyGuard, EIP712 {
    using SafeERC20 for IERC20;

    // ═══════════════════════════════════════════════════════════════════════════
    // CONSTANTS
    // ═══════════════════════════════════════════════════════════════════════════

    uint256 public constant FEE_DENOMINATOR = 1e4;
    uint256 public constant MAX_FEE = 100; // 1% maximum fee
    uint256 public constant PARTNER_FEE_SHARE = 5000; // 50% of fee goes to partner (in basis points of fee)

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

    bytes32 public constant LIMIT_ORDER_TYPEHASH = keccak256(
        "LimitOrder(address maker,address tokenIn,address tokenOut,uint256 amountIn,uint256 minAmountOut,uint256 deadline,uint256 nonce,bool feeOnOutput,address recipient,bool unwrapOutput,address partnerAddress)"
    );

    // ═══════════════════════════════════════════════════════════════════════════
    // STATE
    // ═══════════════════════════════════════════════════════════════════════════

    address public immutable SWITCH_ROUTER;
    address public immutable WNATIVE;
    uint256 private fee;

    /// @notice Address of the SwitchPLSFlow contract (only caller allowed for placeOrder)
    address public plsFlowContract;

    /// @notice When true, only OPERATOR_ROLE can call fillOrder. Disable when private RPCs are available.
    bool public operatorGateEnabled = true;

    /// @notice Tracks used nonces per maker to prevent replay attacks
    mapping(address => mapping(uint256 => bool)) public noncesUsed;

    // ═══════════════════════════════════════════════════════════════════════════
    // TYPES
    // ═══════════════════════════════════════════════════════════════════════════

    /// @notice EIP-712 signed order — never stored on-chain, passed in calldata
    struct LimitOrder {
        address maker;           // Signer / token owner
        address tokenIn;         // ERC20 to sell (use WPLS for native PLS)
        address tokenOut;        // ERC20 to buy (use WPLS + unwrapOutput for native PLS)
        uint256 amountIn;        // Maximum input amount
        uint256 minAmountOut;    // Minimum output the maker must receive
        uint256 deadline;        // Unix timestamp expiry (0 = no expiry)
        uint256 nonce;           // Unique per-maker (prevents double-fill)
        bool feeOnOutput;        // true = fee from output, false = fee from input
        address recipient;       // Output recipient (usually maker's address)
        bool unwrapOutput;       // true = unwrap WPLS to native PLS for recipient
        address partnerAddress;  // Partner to receive 50% of fees (address(0) = no partner)
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // EVENTS
    // ═══════════════════════════════════════════════════════════════════════════

    event OrderPlaced(
        address indexed maker,
        uint256 indexed nonce,
        address tokenIn,
        address tokenOut,
        uint256 amountIn,
        uint256 minAmountOut,
        uint256 deadline,
        bool feeOnOutput,
        address recipient,
        bool unwrapOutput,
        address partnerAddress,
        bytes signature
    );

    event OrderFilled(
        address indexed maker,
        address indexed filler,
        uint256 indexed nonce,
        address tokenIn,
        address tokenOut,
        uint256 amountIn,
        uint256 makerAmountOut,
        uint256 fillerProfit,
        bool excessOnInput,
        address partnerAddress
    );

    event NonceCancelled(address indexed maker, uint256 indexed nonce);
    event FeeUpdated(uint256 newFee);
    event PLSFlowContractUpdated(address newPLSFlowContract);
    event OperatorGateToggled(bool enabled);

    // ═══════════════════════════════════════════════════════════════════════════
    // ERRORS
    // ═══════════════════════════════════════════════════════════════════════════

    error InvalidSignature();
    error NonceAlreadyUsed();
    error OrderExpired();
    error InsufficientOutput();
    error InvalidAmount();
    error ExcessiveFee();
    error RouteInputExceedsMax();
    error InvalidTokens();
    error TransferFailed();
    error OperatorOnly();

    // ═══════════════════════════════════════════════════════════════════════════
    // CONSTRUCTOR
    // ═══════════════════════════════════════════════════════════════════════════

    constructor(
        address _switchRouter,
        address _wnative,
        uint256 _fee
    ) EIP712("SwitchLimitOrder", "2") {
        require(_switchRouter != address(0), "Invalid router");
        require(_wnative != address(0), "Invalid WNATIVE");
        if (_fee > MAX_FEE) revert ExcessiveFee();
        SWITCH_ROUTER = _switchRouter;
        WNATIVE = _wnative;
        fee = _fee;
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // PLACE ORDER (PLSFlow only — on-chain announcement)
    // ═══════════════════════════════════════════════════════════════════════════

    /**
     * @notice Announce a PLS limit order on-chain.
     *         Only callable by the PLSFlow contract. PLSFlow.createOrder()
     *         calls this after wrapping PLS → WPLS so the backend can
     *         index the OrderPlaced event as the source of truth.
     *
     *         Does NOT consume the nonce (that only happens during fill).
     *         No signature verification — PLSFlow is trusted.
     *
     * @param order      The order parameters (maker = PLSFlow contract)
     * @param signature  Empty bytes (PLSFlow uses ERC-1271, not ECDSA)
     */
    function placeOrder(
        LimitOrder calldata order,
        bytes calldata signature
    ) external {
        require(msg.sender == plsFlowContract, "Only PLSFlow");

        // Basic sanity checks
        if (order.amountIn == 0 || order.minAmountOut == 0) revert InvalidAmount();
        if (order.tokenIn == order.tokenOut) revert InvalidTokens();
        if (noncesUsed[order.maker][order.nonce]) revert NonceAlreadyUsed();

        emit OrderPlaced(
            order.maker,
            order.nonce,
            order.tokenIn,
            order.tokenOut,
            order.amountIn,
            order.minAmountOut,
            order.deadline,
            order.feeOnOutput,
            order.recipient,
            order.unwrapOutput,
            order.partnerAddress,
            signature
        );
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // FILL ORDER
    // ═══════════════════════════════════════════════════════════════════════════

    /**
     * @notice Fill a signed limit order via SwitchRouter routing.
     *
     * @param order          The maker's signed order parameters
     * @param signature      The maker's EIP-712 signature (65 bytes: r, s, v)
     * @param routes         Routing allocation for the swap through SwitchRouter
     * @param excessOnInput  true: filler profit = unswapped input tokens
     *                       false: filler profit = output surplus above minAmountOut
     *                       (Filler chooses; maker controls feeOnOutput in signed order)
     */
    function fillOrder(
        LimitOrder calldata order,
        bytes calldata signature,
        RouteAllocation[] calldata routes,
        bool excessOnInput
    ) external nonReentrant {
        if (operatorGateEnabled && !hasRole(OPERATOR_ROLE, msg.sender)) revert OperatorOnly();
        _verifyOrder(order, signature);

        if (order.feeOnOutput) {
            _fillFeeOnOutput(order, routes, excessOnInput);
        } else {
            _fillFeeOnInput(order, routes, excessOnInput);
        }
    }

    /**
     * @notice Direct-fill a signed limit order.
     *         The filler provides output tokens from their own liquidity and receives
     *         the maker's input tokens. No SwitchRouter routing needed.
     *
     *         The maker always receives exactly minAmountOut. Protocol fee is deducted
     *         from the input (feeOnOutput=false) or output (feeOnOutput=true).
     *         The filler receives all input tokens (minus input fee if applicable).
     *
     *         For feeOnOutput=true orders, the maker must have also approved this
     *         contract (not just the Router) for the direct pull to succeed.
     *
     * @param order          The maker's signed order parameters
     * @param signature      The maker's EIP-712 signature (65 bytes: r, s, v)
     * @param outputAmount   Amount of output token to pull from the filler.
     *                       Must be >= minAmountOut (plus fee for feeOnOutput orders).
     *                       For tax output tokens with directToMaker=false, oversend to cover the transfer tax.
     * @param directToMaker  If true and feeOnOutput=false and unwrapOutput=false,
     *                       output is sent directly from filler to the recipient
     *                       in a single transfer — saving one tax hit for tax output tokens.
     *                       Ignored when feeOnOutput=true (output needs fee deduction)
     *                       or unwrapOutput=true (output needs unwrapping).
     *                       Surplus output goes to maker (no refund to filler).
     */
    function directFillOrder(
        LimitOrder calldata order,
        bytes calldata signature,
        uint256 outputAmount,
        bool directToMaker
    ) external nonReentrant {
        if (operatorGateEnabled && !hasRole(OPERATOR_ROLE, msg.sender)) revert OperatorOnly();
        _verifyOrder(order, signature);
        _directFill(order, outputAmount, directToMaker);
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // DIRECT FILL PATH
    // ═══════════════════════════════════════════════════════════════════════════

    /**
     * @dev Direct-fill execution: operator provides output tokens, receives input tokens.
     *      Works with both feeOnOutput modes. Tax-safe via balanceOf deltas.
     *
     *      feeOnOutput=false: Fee from input. Filler provides >= minAmountOut of output.
     *      feeOnOutput=true:  Fee from output. Filler provides enough output to cover
     *                         minAmountOut + fee after tax (if any).
     *
     *      directToMaker=true (feeOnInput only, !unwrapOutput):
     *        Output goes filler → recipient directly (1 transfer instead of 2).
     *        Saves one tax hit for tax output tokens. Surplus goes to maker.
     */
    function _directFill(
        LimitOrder calldata order,
        uint256 outputAmount,
        bool directToMaker
    ) internal {
        // directToMaker only works when fee is on input and no unwrap needed
        // (feeOnOutput requires output at contract for fee deduction;
        //  unwrapOutput requires WPLS at contract for unwrapping)
        bool useDirect = directToMaker && !order.feeOnOutput && !order.unwrapOutput;

        address outToken = order.unwrapOutput ? WNATIVE : order.tokenOut;

        // ─── 1. Pull input from maker ────────────────────────────────
        // feeOnOutput=false: maker approved this contract → direct safeTransferFrom
        // feeOnOutput=true:  maker approved the Router   → use Router's pullTokens
        uint256 actualInputReceived;
        {
            uint256 bal = IERC20(order.tokenIn).balanceOf(address(this));
            if (order.feeOnOutput) {
                ISwitchRouter(SWITCH_ROUTER).pullTokens(
                    order.tokenIn, order.maker, address(this), order.amountIn
                );
            } else {
                IERC20(order.tokenIn).safeTransferFrom(order.maker, address(this), order.amountIn);
            }
            actualInputReceived = IERC20(order.tokenIn).balanceOf(address(this)) - bal;
        }

        // ─── 2. Transfer output ──────────────────────────────────────
        uint256 fillerInputAmount;

        if (useDirect) {
            // Direct-to-maker: filler → recipient in 1 transfer (saves 1 tax hit)
            uint256 recipientBal = IERC20(outToken).balanceOf(order.recipient);
            IERC20(outToken).safeTransferFrom(msg.sender, order.recipient, outputAmount);
            uint256 actualDelivered = IERC20(outToken).balanceOf(order.recipient) - recipientBal;
            if (actualDelivered < order.minAmountOut) revert InsufficientOutput();

            // Fee deducted from input
            uint256 inputFee = (actualInputReceived * fee) / FEE_DENOMINATOR;
            if (inputFee > 0) _distributeTokenFee(order.tokenIn, inputFee, order.partnerAddress);

            fillerInputAmount = actualInputReceived - inputFee;
        } else {
            // Standard path: filler → contract → fee/validation → recipient
            uint256 actualOutputReceived;
            {
                uint256 bal = IERC20(outToken).balanceOf(address(this));
                IERC20(outToken).safeTransferFrom(msg.sender, address(this), outputAmount);
                actualOutputReceived = IERC20(outToken).balanceOf(address(this)) - bal;
            }

            // ─── 3. Fee, validation, settlement ──────────────────────────
            if (order.feeOnOutput) {
                // Fee deducted from output
                uint256 outputFee = (actualOutputReceived * fee) / FEE_DENOMINATOR;
                uint256 afterFee = actualOutputReceived - outputFee;
                if (afterFee < order.minAmountOut) revert InsufficientOutput();

                if (outputFee > 0) _distributeTokenFee(outToken, outputFee, order.partnerAddress);
                _deliverOutput(order, order.minAmountOut);

                // Return surplus output to filler (if any)
                uint256 outputSurplus = afterFee - order.minAmountOut;
                if (outputSurplus > 0) IERC20(outToken).safeTransfer(msg.sender, outputSurplus);

                fillerInputAmount = actualInputReceived;
            } else {
                // Fee deducted from input
                if (actualOutputReceived < order.minAmountOut) revert InsufficientOutput();

                uint256 inputFee = (actualInputReceived * fee) / FEE_DENOMINATOR;
                if (inputFee > 0) _distributeTokenFee(order.tokenIn, inputFee, order.partnerAddress);

                _deliverOutput(order, order.minAmountOut);

                // Return surplus output to filler (if any)
                uint256 outputSurplus = actualOutputReceived - order.minAmountOut;
                if (outputSurplus > 0) IERC20(outToken).safeTransfer(msg.sender, outputSurplus);

                fillerInputAmount = actualInputReceived - inputFee;
            }
        }

        // ─── 4. Send input tokens to filler ──────────────────────────
        if (fillerInputAmount > 0) {
            IERC20(order.tokenIn).safeTransfer(msg.sender, fillerInputAmount);
        }

        _emitOrderFilled(order, order.minAmountOut, fillerInputAmount, true);
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // FEE ON INPUT PATH
    // ═══════════════════════════════════════════════════════════════════════════

    /**
     * @dev Fee-on-input execution path.
     *      Tokens are pulled from maker → this contract first.
     *      Fee is deducted from the input token.
     *
     *      excessOnInput=true:  output → recipient directly (best for tax output)
     *      excessOnInput=false: output → contract → split between maker & filler
     */
    function _fillFeeOnInput(
        LimitOrder calldata order,
        RouteAllocation[] calldata routes,
        bool excessOnInput
    ) internal {
        // ─── 1. Pull all tokens from maker ─────────────────────────────
        uint256 actualReceived;
        {
            uint256 bal = IERC20(order.tokenIn).balanceOf(address(this));
            IERC20(order.tokenIn).safeTransferFrom(order.maker, address(this), order.amountIn);
            actualReceived = IERC20(order.tokenIn).balanceOf(address(this)) - bal;
        }

        // ─── 2. Calculate & distribute input fee ───────────────────────
        uint256 feeAmount = (actualReceived * fee) / FEE_DENOMINATOR;
        if (feeAmount > 0) {
            _distributeTokenFee(order.tokenIn, feeAmount, order.partnerAddress);
        }
        uint256 maxSwap = actualReceived - feeAmount;

        // ─── 3. Validate routes ────────────────────────────────────────
        uint256 totalRouteInput;
        for (uint256 i = 0; i < routes.length; i++) {
            totalRouteInput += routes[i].amountIn;
        }
        if (totalRouteInput > maxSwap) revert RouteInputExceedsMax();

        // ─── 4. Approve router ─────────────────────────────────────────
        IERC20(order.tokenIn).safeApprove(SWITCH_ROUTER, 0);
        IERC20(order.tokenIn).safeApprove(SWITCH_ROUTER, totalRouteInput);

        // ─── 5. Execute swap ───────────────────────────────────────────
        // Output goes directly to recipient ONLY when excessOnInput AND !unwrapOutput
        bool needsSettlement = !excessOnInput || order.unwrapOutput;
        uint256 amountOut = _swapViaGoSwitch(order, routes, needsSettlement);

        if (amountOut < order.minAmountOut) revert InsufficientOutput();

        // ─── 6. Settle ─────────────────────────────────────────────────
        uint256 fillerProfit;
        if (excessOnInput) {
            // Filler takes unswapped input
            fillerProfit = maxSwap - totalRouteInput;
            if (fillerProfit > 0) {
                IERC20(order.tokenIn).safeTransfer(msg.sender, fillerProfit);
            }
            // If unwrapOutput, output is at contract — deliver to recipient
            if (order.unwrapOutput) {
                _deliverOutput(order, amountOut);
            }
            // else: output already at recipient (sent directly by router)
        } else {
            // Filler takes output surplus; return any unswapped input to maker
            uint256 leftoverInput = maxSwap - totalRouteInput;
            if (leftoverInput > 0) {
                IERC20(order.tokenIn).safeTransfer(order.maker, leftoverInput);
            }
            // Deliver minAmountOut to maker
            _deliverOutput(order, order.minAmountOut);
            // Filler gets output surplus
            fillerProfit = amountOut - order.minAmountOut;
            if (fillerProfit > 0) {
                // Filler receives output token (WPLS if unwrapOutput, not unwrapped)
                address outToken = order.unwrapOutput ? WNATIVE : order.tokenOut;
                IERC20(outToken).safeTransfer(msg.sender, fillerProfit);
            }
        }

        _emitOrderFilled(order, excessOnInput ? amountOut : order.minAmountOut, fillerProfit, excessOnInput);
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // FEE ON OUTPUT PATH
    // ═══════════════════════════════════════════════════════════════════════════

    /**
     * @dev Fee-on-output execution path.
     *      Router pulls input directly from maker via goSwitchFrom (1 transfer).
     *      Output comes to this contract for fee deduction.
     *      Best for tax input tokens (avoids double-taxing input).
     *
     *      Requires: maker has approved the SwitchRouter for tokenIn.
     *      Requires: SwitchRouter.LIMIT_ORDER_CONTRACT == address(this).
     *
     *      excessOnInput=true:  excess input pulled from maker → filler
     *      excessOnInput=false: all input routed; filler takes output surplus
     */
    function _fillFeeOnOutput(
        LimitOrder calldata order,
        RouteAllocation[] calldata routes,
        bool excessOnInput
    ) internal {
        // ─── 1. Compute route totals ───────────────────────────────────
        uint256 totalRouteInput;
        for (uint256 i = 0; i < routes.length; i++) {
            totalRouteInput += routes[i].amountIn;
        }
        if (totalRouteInput > order.amountIn) revert RouteInputExceedsMax();

        // ─── 2. Handle excess on input (if applicable) ─────────────────
        if (excessOnInput) {
            uint256 excessAmount = order.amountIn - totalRouteInput;
            if (excessAmount > 0) {
                // Pull excess from maker → filler (uses maker's approval on this contract)
                IERC20(order.tokenIn).safeTransferFrom(order.maker, msg.sender, excessAmount);
            }
        }

        // ─── 3. Execute swap via goSwitchFrom ──────────────────────────
        // Router pulls totalRouteInput from maker → pair(s) directly.
        // Output comes to this contract for fee processing.
        uint256 amountOut = _swapViaGoSwitchFrom(order, routes);

        // ─── 4. Fee on actual output ───────────────────────────────────
        uint256 feeAmount = (amountOut * fee) / FEE_DENOMINATOR;
        if (feeAmount > 0) {
            address outToken = order.unwrapOutput ? WNATIVE : order.tokenOut;
            _distributeTokenFee(outToken, feeAmount, order.partnerAddress);
        }
        uint256 afterFee = amountOut - feeAmount;

        if (afterFee < order.minAmountOut) revert InsufficientOutput();

        // ─── 5. Settle ─────────────────────────────────────────────────
        uint256 fillerProfit;
        if (excessOnInput) {
            // All afterFee goes to maker
            _deliverOutput(order, afterFee);
            fillerProfit = order.amountIn - totalRouteInput; // in tokenIn
        } else {
            // Maker gets minAmountOut, filler gets surplus
            _deliverOutput(order, order.minAmountOut);
            fillerProfit = afterFee - order.minAmountOut; // in tokenOut
            if (fillerProfit > 0) {
                address outToken = order.unwrapOutput ? WNATIVE : order.tokenOut;
                IERC20(outToken).safeTransfer(msg.sender, fillerProfit);
            }
        }

        _emitOrderFilled(order, excessOnInput ? afterFee : order.minAmountOut, fillerProfit, excessOnInput);
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // INTERNAL SWAP HELPERS
    // ═══════════════════════════════════════════════════════════════════════════

    /**
     * @dev Execute swap via goSwitch (tokens already at this contract).
     *      Used for feeOnInput path where this contract holds the input.
     */
    function _swapViaGoSwitch(
        LimitOrder calldata order,
        RouteAllocation[] calldata routes,
        bool needsSettlement
    ) internal returns (uint256 amountOut) {
        address outToken = order.unwrapOutput ? WNATIVE : order.tokenOut;
        address target = needsSettlement ? address(this) : order.recipient;
        uint256 outBefore = IERC20(outToken).balanceOf(target);

        ISwitchRouter(SWITCH_ROUTER).goSwitch(
            routes,
            target,
            order.minAmountOut,    // Router-level sanity floor
            0,                     // No router fee (we handle fees)
            false,                 // N/A
            false,                 // We handle unwrap ourselves
            address(0)             // No partner (we handle partner split)
        );

        amountOut = IERC20(outToken).balanceOf(target) - outBefore;
    }

    /**
     * @dev Execute swap via goSwitchFrom (router pulls from maker directly).
     *      Used for feeOnOutput path to minimize input token transfers.
     *      Output always comes to this contract (for fee processing).
     */
    function _swapViaGoSwitchFrom(
        LimitOrder calldata order,
        RouteAllocation[] calldata routes
    ) internal returns (uint256 amountOut) {
        address outToken = order.unwrapOutput ? WNATIVE : order.tokenOut;
        uint256 outBefore = IERC20(outToken).balanceOf(address(this));

        ISwitchRouter(SWITCH_ROUTER).goSwitchFrom(
            order.maker,
            routes,
            address(this),         // Output to this contract for fee processing
            order.minAmountOut,    // Router-level sanity floor
            false                  // We handle unwrap ourselves
        );

        amountOut = IERC20(outToken).balanceOf(address(this)) - outBefore;
    }

    /**
     * @dev Deliver output tokens to the recipient, unwrapping WPLS if needed.
     */
    function _deliverOutput(
        LimitOrder calldata order,
        uint256 amount
    ) internal {
        if (order.unwrapOutput) {
            IWETH(WNATIVE).withdraw(amount);
            (bool ok, ) = payable(order.recipient).call{value: amount}("");
            if (!ok) revert TransferFailed();
        } else {
            IERC20(order.tokenOut).safeTransfer(order.recipient, amount);
        }
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // SIGNATURE VERIFICATION
    // ═══════════════════════════════════════════════════════════════════════════

    /**
     * @dev Verify EIP-712 signature, nonce, deadline, and basic field validation.
     *      Supports both EOA (ECDSA) and contract (ERC-1271) signers.
     */
    function _verifyOrder(
        LimitOrder calldata order,
        bytes calldata signature
    ) internal {
        bytes32 structHash = keccak256(abi.encode(
            LIMIT_ORDER_TYPEHASH,
            order.maker,
            order.tokenIn,
            order.tokenOut,
            order.amountIn,
            order.minAmountOut,
            order.deadline,
            order.nonce,
            order.feeOnOutput,
            order.recipient,
            order.unwrapOutput,
            order.partnerAddress
        ));
        bytes32 digest = _hashTypedDataV4(structHash);

        // Try ECDSA first (EOA makers) — may revert for short/empty signatures
        bool ecdsaValid = false;
        if (signature.length >= 65) {
            address signer = ECDSA.recover(digest, signature);
            ecdsaValid = (signer == order.maker);
        }

        if (!ecdsaValid) {
            // Fallback: ERC-1271 for contract makers (e.g. SwitchPLSFlow)
            if (order.maker.code.length == 0) revert InvalidSignature();
            bytes4 result = IERC1271(order.maker).isValidSignature(digest, signature);
            if (result != bytes4(0x1626ba7e)) revert InvalidSignature();
        }

        if (noncesUsed[order.maker][order.nonce]) revert NonceAlreadyUsed();
        noncesUsed[order.maker][order.nonce] = true;

        if (order.deadline != 0 && block.timestamp > order.deadline) revert OrderExpired();
        if (order.amountIn == 0 || order.minAmountOut == 0) revert InvalidAmount();
        if (order.tokenIn == order.tokenOut) revert InvalidTokens();
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // CANCELLATION
    // ═══════════════════════════════════════════════════════════════════════════

    function invalidateNonce(uint256 _nonce) external {
        noncesUsed[msg.sender][_nonce] = true;
        emit NonceCancelled(msg.sender, _nonce);
    }

    function invalidateNonces(uint256[] calldata _nonces) external {
        for (uint256 i = 0; i < _nonces.length; i++) {
            noncesUsed[msg.sender][_nonces[i]] = true;
            emit NonceCancelled(msg.sender, _nonces[i]);
        }
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // VIEW FUNCTIONS
    // ═══════════════════════════════════════════════════════════════════════════

    function canFillOrder(
        LimitOrder calldata order,
        bytes calldata signature
    ) external view returns (bool) {
        bytes32 structHash = keccak256(abi.encode(
            LIMIT_ORDER_TYPEHASH,
            order.maker,
            order.tokenIn,
            order.tokenOut,
            order.amountIn,
            order.minAmountOut,
            order.deadline,
            order.nonce,
            order.feeOnOutput,
            order.recipient,
            order.unwrapOutput,
            order.partnerAddress
        ));
        bytes32 digest = _hashTypedDataV4(structHash);

        // Verify signature: ECDSA for EOA, ERC-1271 for contracts
        bool sigValid = false;
        if (signature.length >= 65) {
            address signer = ECDSA.recover(digest, signature);
            sigValid = (signer == order.maker);
        }
        if (!sigValid) {
            if (order.maker.code.length == 0) return false;
            try IERC1271(order.maker).isValidSignature(digest, signature) returns (bytes4 result) {
                if (result != bytes4(0x1626ba7e)) return false;
            } catch {
                return false;
            }
        }
        if (noncesUsed[order.maker][order.nonce]) return false;
        if (order.deadline != 0 && block.timestamp > order.deadline) return false;
        if (IERC20(order.tokenIn).balanceOf(order.maker) < order.amountIn) return false;
        // Check allowance on this contract (needed for feeOnInput, and feeOnOutput+excessOnInput)
        if (IERC20(order.tokenIn).allowance(order.maker, address(this)) < order.amountIn) {
            // For feeOnOutput without excessOnInput, maker only needs router approval
            if (!order.feeOnOutput) return false;
            if (IERC20(order.tokenIn).allowance(order.maker, SWITCH_ROUTER) < order.amountIn) return false;
        }
        return true;
    }

    function isNonceUsed(address maker, uint256 nonce) external view returns (bool) {
        return noncesUsed[maker][nonce];
    }

    function domainSeparator() external view returns (bytes32) {
        return _domainSeparatorV4();
    }

    function getFee() external view returns (uint256) {
        return fee;
    }



    // ═══════════════════════════════════════════════════════════════════════════
    // ADMIN
    // ═══════════════════════════════════════════════════════════════════════════

    function setFee(uint256 _fee) external onlyMaintainer {
        if (_fee > MAX_FEE) revert ExcessiveFee();
        fee = _fee;
        emit FeeUpdated(_fee);
    }

    function setPLSFlowContract(address _plsFlow) external onlyMaintainer {
        plsFlowContract = _plsFlow;
        emit PLSFlowContractUpdated(_plsFlow);
    }

    /// @notice Toggle the operator gate. When disabled, fillOrder is permissionless.
    function setOperatorGate(bool _enabled) external onlyMaintainer {
        operatorGateEnabled = _enabled;
        emit OperatorGateToggled(_enabled);
    }

    /// @notice Grant OPERATOR_ROLE to an address (only admin).
    function addOperator(address _operator) external {
        grantRole(OPERATOR_ROLE, _operator);
    }

    /// @notice Revoke OPERATOR_ROLE from an address (only admin).
    function removeOperator(address _operator) external {
        revokeRole(OPERATOR_ROLE, _operator);
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // INTERNALS
    // ═══════════════════════════════════════════════════════════════════════════

    function _emitOrderFilled(
        LimitOrder calldata order,
        uint256 makerAmountOut,
        uint256 fillerProfit,
        bool excessOnInput
    ) private {
        emit OrderFilled(
            order.maker,
            msg.sender,
            order.nonce,
            order.tokenIn,
            order.tokenOut,
            order.amountIn,
            makerAmountOut,
            fillerProfit,
            excessOnInput,
            order.partnerAddress
        );
    }

    function _distributeTokenFee(address _token, uint256 _feeAmount, address _partner) private {
        address feeClaimer = ISwitchRouter(SWITCH_ROUTER).FEE_CLAIMER();
        if (_partner != address(0)) {
            uint256 partnerShare = (_feeAmount * PARTNER_FEE_SHARE) / FEE_DENOMINATOR;
            uint256 protocolShare = _feeAmount - partnerShare;
            if (partnerShare > 0) IERC20(_token).safeTransfer(_partner, partnerShare);
            if (protocolShare > 0) IERC20(_token).safeTransfer(feeClaimer, protocolShare);
        } else {
            IERC20(_token).safeTransfer(feeClaimer, _feeAmount);
        }
    }

    // ═══════════════════════════════════════════════════════════════════════════
    // EMERGENCY
    // ═══════════════════════════════════════════════════════════════════════════

    function recoverTokens(address _token, uint256 _amount) external onlyMaintainer {
        IERC20(_token).safeTransfer(msg.sender, _amount);
    }

    function recoverNative(uint256 _amount) external onlyMaintainer {
        (bool ok, ) = payable(msg.sender).call{value: _amount}("");
        require(ok, "Native transfer failed");
    }

    receive() external payable {}
}
        

// This is a simplified version of OpenZepplin's SafeERC20 library
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
pragma experimental ABIEncoderV2;

import "../interface/IERC20.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 ERC20;` statement to your contract,
 * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
 */
library SafeERC20 {
    function safeTransfer(
        IERC20 token,
        address to,
        uint256 value
    ) internal {
        _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
    }

    function safeTransferFrom(
        IERC20 token,
        address from,
        address to,
        uint256 value
    ) internal {
        _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
    }

    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'
        // solhint-disable-next-line max-line-length
        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 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.

        // A Solidity high level call has three parts:
        //  1. The target address is checked to verify it contains contract code
        //  2. The call itself is made, and success asserted
        //  3. The return value is decoded, which in turn checks the size of the returned data.
        // solhint-disable-next-line max-line-length

        // solhint-disable-next-line avoid-low-level-calls
        (bool success, bytes memory returndata) = address(token).call(data);
        require(success, "SafeERC20: low-level call failed");

        if (returndata.length > 0) {
            // Return data is optional
            // solhint-disable-next-line max-line-length
            require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
        }
    }
}
          

// SPDX-License-Identifier: MIT

pragma solidity ^0.8.0;

import "@openzeppelin/contracts/access/AccessControl.sol";

/**
 * @dev Contract module which extends the basic access control mechanism of Ownable
 * to include many maintainers, whom only the owner (DEFAULT_ADMIN_ROLE) may add and
 * remove.
 *
 * By default, the owner account will be the one that deploys the contract. This can
 * later be changed with {transferOwnership}.
 *
 * This module is used through inheritance. It will make available this modifier:
 * `onlyMaintainer`, which can be applied to your functions to restrict their use to
 * the accounts with the role of maintainer.
 */

abstract contract Maintainable is Context, AccessControl {
    bytes32 public constant MAINTAINER_ROLE = keccak256("MAINTAINER_ROLE");

    constructor() {
        address msgSender = _msgSender();
        // members of the DEFAULT_ADMIN_ROLE alone may revoke and grant role membership
        _setupRole(DEFAULT_ADMIN_ROLE, msgSender);
        _setupRole(MAINTAINER_ROLE, msgSender);
    }

    function addMaintainer(address addedMaintainer) public virtual {
        grantRole(MAINTAINER_ROLE, addedMaintainer);
    }

    function removeMaintainer(address removedMaintainer) public virtual {
        revokeRole(MAINTAINER_ROLE, removedMaintainer);
    }

    function renounceRole(bytes32 role) public virtual {
        address msgSender = _msgSender();
        renounceRole(role, msgSender);
    }

    function transferOwnership(address newOwner) public virtual {
        address msgSender = _msgSender();
        grantRole(DEFAULT_ADMIN_ROLE, newOwner);
        renounceRole(DEFAULT_ADMIN_ROLE, msgSender);
    }

    modifier onlyMaintainer() {
        address msgSender = _msgSender();
        require(hasRole(MAINTAINER_ROLE, msgSender), "Maintainable: Caller is not a maintainer");
        _;
    }
}
          

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

import "./IERC20.sol";

interface IWETH is IERC20 {
    function withdraw(uint256 amount) external;

    function deposit() external payable;
}
          

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


struct Query {
    address adapter;
    address tokenIn;
    address tokenOut;
    uint256 amountOut;
}
struct Offer {
    bytes amounts;
    bytes adapters;
    bytes path;
    uint256 gasEstimate;
}
struct FormattedOffer {
    uint256[] amounts;
    address[] adapters;
    address[] path;
    uint256 gasEstimate;
}
struct Trade {
    uint256 amountIn;
    uint256 amountOut;
    address[] path;
    address[] adapters;
}

struct HopAdapterAllocation {
    address adapter;
    uint256 amountIn;
}

struct HopAllocation {
    address tokenIn;
    address tokenOut;
    HopAdapterAllocation[] legs;
}

struct RouteAllocation {
    uint256 amountIn;
    HopAllocation[] hops;
}

interface ISwitchRouter {

    event UpdatedAdapters(address[] _newAdapters);
    event UpdatedMinFee(uint256 _oldMinFee, uint256 _newMinFee);
    event UpdatedFeeClaimer(address _oldFeeClaimer, address _newFeeClaimer);
    event Switched(address indexed _tokenIn, address indexed _tokenOut, uint256 _amountIn, uint256 _amountOut, address _partnerAddress);
    event UpdatedFeeExempt(address indexed account, bool exempt);

    // admin
    function setAdapters(address[] memory _adapters) external;
    function setFeeClaimer(address _claimer) external;
    function setMinFee(uint256 _fee) external;
    function setFeeExempt(address account, bool exempt) external;
    function setMinFeeExempt(address account, bool exempt) external;
    function setFeeExemptBatch(address[] calldata accounts, bool[] calldata flags) external;
    function adaptersCount() external view returns (uint256);
    function ADAPTERS(uint256 index) external view returns (address);
    function MIN_FEE() external view returns (uint256);
    function MIN_FEE_EXEMPT(address account) external view returns (bool);
    function FEE_CLAIMER() external view returns (address);
    function FEE_EXEMPT(address account) external view returns (bool);

    // query

    function queryAdapter(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut,
        uint8 _index
    ) external returns (uint256);

    function queryNoSplit(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut,
        uint8[] calldata _options
    ) external view returns (Query memory);

    function queryNoSplit(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut
    ) external view returns (Query memory);

    function findBestPathWithGas(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut,
        uint256 _maxSteps,
        uint256 _gasPrice
    ) external view returns (FormattedOffer memory);

    function findBestPath(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut,
        uint256 _maxSteps
    ) external view returns (FormattedOffer memory);

    function findBestPathRange(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut,
        uint256 _maxSteps,
        uint256 _trustedStart,
        uint256 _trustedCount
    ) external view returns (FormattedOffer memory);

    function findBestPathRangeWithGas(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut,
        uint256 _maxSteps,
        uint256 _gasPrice,
        uint256 _trustedStart,
        uint256 _trustedCount
    ) external view returns (FormattedOffer memory);

    function queryAdaptersRange(
        uint256 _amountIn,
        address _tokenIn,
        address _tokenOut,
        uint256 _start,
        uint256 _count
    ) external view returns (Query[] memory results);

    function quoteSplit(Trade[] calldata _trades) external view returns (uint256 totalOut);

    // Unified swap function
    function goSwitch(
        RouteAllocation[] calldata _routes,
        address _to,
        uint256 _minTotalAmountOut,
        uint256 _fee,
        bool _feeOnOutput,
        bool _unwrapOutput,
        address _partnerAddress
    ) external payable;

    // Pull-from-payer swap (only callable by the limit order contract)
    function goSwitchFrom(
        address _payer,
        RouteAllocation[] calldata _routes,
        address _to,
        uint256 _minTotalAmountOut,
        bool _unwrapOutput
    ) external;

    // Pull tokens from a payer to a recipient (only callable by the limit order contract)
    function pullTokens(
        address _token,
        address _from,
        address _to,
        uint256 _amount
    ) external;

    function LIMIT_ORDER_CONTRACT() external view returns (address);
}
          

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

interface IERC20 {
    event Approval(address, address, uint256);
    event Transfer(address, address, uint256);

    function name() external view returns (string memory);

    function decimals() external view returns (uint8);

    function transferFrom(
        address,
        address,
        uint256
    ) external returns (bool);

    function allowance(address, address) external view returns (uint256);

    function approve(address, uint256) external returns (bool);

    function transfer(address, uint256) external returns (bool);

    function balanceOf(address) external view returns (uint256);

    function nonces(address) external view returns (uint256); // Only tokens that support permit

    function permit(
        address,
        address,
        uint256,
        uint256,
        uint8,
        bytes32,
        bytes32
    ) external; // Only tokens that support permit

    function swap(address, uint256) external; // Only Avalanche bridge tokens

    function swapSupply(address) external view returns (uint256); // Only Avalanche bridge tokens

    function totalSupply() external view returns (uint256);
}
          

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

/**
 * @dev Interface for ERC-1271: Standard Signature Validation Method for Contracts.
 *      See https://eips.ethereum.org/EIPS/eip-1271
 */
interface IERC1271 {
    /**
     * @dev Returns `0x1626ba7e` if the signature is valid for the given hash.
     */
    function isValidSignature(
        bytes32 hash,
        bytes calldata signature
    ) external view returns (bytes4);
}
          

// 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 (last updated v4.9.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 v4.4.1 (utils/introspection/IERC165.sol)

pragma solidity ^0.8.0;

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts 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.9.0) (utils/cryptography/EIP712.sol)

pragma solidity ^0.8.8;

import "./ECDSA.sol";
import "../ShortStrings.sol";
import "../../interfaces/IERC5267.sol";

/**
 * @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data.
 *
 * The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible,
 * thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding
 * they need in their contracts using a combination of `abi.encode` and `keccak256`.
 *
 * This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
 * scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
 * ({_hashTypedDataV4}).
 *
 * The implementation of the domain separator was designed to be as efficient as possible while still properly updating
 * the chain id to protect against replay attacks on an eventual fork of the chain.
 *
 * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
 * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
 *
 * NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain
 * separator of the implementation contract. This will cause the `_domainSeparatorV4` function to always rebuild the
 * separator from the immutable values, which is cheaper than accessing a cached version in cold storage.
 *
 * _Available since v3.4._
 *
 * @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
 */
abstract contract EIP712 is IERC5267 {
    using ShortStrings for *;

    bytes32 private constant _TYPE_HASH =
        keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");

    // Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
    // invalidate the cached domain separator if the chain id changes.
    bytes32 private immutable _cachedDomainSeparator;
    uint256 private immutable _cachedChainId;
    address private immutable _cachedThis;

    bytes32 private immutable _hashedName;
    bytes32 private immutable _hashedVersion;

    ShortString private immutable _name;
    ShortString private immutable _version;
    string private _nameFallback;
    string private _versionFallback;

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

        _cachedChainId = block.chainid;
        _cachedDomainSeparator = _buildDomainSeparator();
        _cachedThis = address(this);
    }

    /**
     * @dev Returns the domain separator for the current chain.
     */
    function _domainSeparatorV4() internal view returns (bytes32) {
        if (address(this) == _cachedThis && block.chainid == _cachedChainId) {
            return _cachedDomainSeparator;
        } else {
            return _buildDomainSeparator();
        }
    }

    function _buildDomainSeparator() private view returns (bytes32) {
        return keccak256(abi.encode(_TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));
    }

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

    /**
     * @dev See {EIP-5267}.
     *
     * _Available since v4.9._
     */
    function eip712Domain()
        public
        view
        virtual
        override
        returns (
            bytes1 fields,
            string memory name,
            string memory version,
            uint256 chainId,
            address verifyingContract,
            bytes32 salt,
            uint256[] memory extensions
        )
    {
        return (
            hex"0f", // 01111
            _name.toStringWithFallback(_nameFallback),
            _version.toStringWithFallback(_versionFallback),
            block.chainid,
            address(this),
            bytes32(0),
            new uint256[](0)
        );
    }
}
          

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

pragma solidity ^0.8.0;

import "../Strings.sol";

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

    function _throwError(RecoverError error) private pure {
        if (error == RecoverError.NoError) {
            return; // no error: do nothing
        } else if (error == RecoverError.InvalidSignature) {
            revert("ECDSA: invalid signature");
        } else if (error == RecoverError.InvalidSignatureLength) {
            revert("ECDSA: invalid signature length");
        } else if (error == RecoverError.InvalidSignatureS) {
            revert("ECDSA: invalid signature 's' value");
        }
    }

    /**
     * @dev Returns the address that signed a hashed message (`hash`) with
     * `signature` or error string. This address can then be used for verification purposes.
     *
     * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
     * this function rejects them by requiring the `s` value to be in the lower
     * half order, and the `v` value to be either 27 or 28.
     *
     * IMPORTANT: `hash` _must_ be the result of a hash operation for the
     * verification to be secure: it is possible to craft signatures that
     * recover to arbitrary addresses for non-hashed data. A safe way to ensure
     * this is by receiving a hash of the original message (which may otherwise
     * be too long), and then calling {toEthSignedMessageHash} on it.
     *
     * Documentation for signature generation:
     * - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
     * - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
     *
     * _Available since v4.3._
     */
    function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError) {
        if (signature.length == 65) {
            bytes32 r;
            bytes32 s;
            uint8 v;
            // ecrecover takes the signature parameters, and the only way to get them
            // currently is to use assembly.
            /// @solidity memory-safe-assembly
            assembly {
                r := mload(add(signature, 0x20))
                s := mload(add(signature, 0x40))
                v := byte(0, mload(add(signature, 0x60)))
            }
            return tryRecover(hash, v, r, s);
        } else {
            return (address(0), RecoverError.InvalidSignatureLength);
        }
    }

    /**
     * @dev Returns the address that signed a hashed message (`hash`) with
     * `signature`. This address can then be used for verification purposes.
     *
     * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
     * this function rejects them by requiring the `s` value to be in the lower
     * half order, and the `v` value to be either 27 or 28.
     *
     * IMPORTANT: `hash` _must_ be the result of a hash operation for the
     * verification to be secure: it is possible to craft signatures that
     * recover to arbitrary addresses for non-hashed data. A safe way to ensure
     * this is by receiving a hash of the original message (which may otherwise
     * be too long), and then calling {toEthSignedMessageHash} on it.
     */
    function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
        (address recovered, RecoverError error) = tryRecover(hash, signature);
        _throwError(error);
        return recovered;
    }

    /**
     * @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
     *
     * See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures]
     *
     * _Available since v4.3._
     */
    function tryRecover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address, RecoverError) {
        bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
        uint8 v = uint8((uint256(vs) >> 255) + 27);
        return tryRecover(hash, v, r, s);
    }

    /**
     * @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
     *
     * _Available since v4.2._
     */
    function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) {
        (address recovered, RecoverError error) = tryRecover(hash, r, vs);
        _throwError(error);
        return recovered;
    }

    /**
     * @dev Overload of {ECDSA-tryRecover} that receives the `v`,
     * `r` and `s` signature fields separately.
     *
     * _Available since v4.3._
     */
    function tryRecover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address, RecoverError) {
        // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
        // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
        // the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
        // signatures from current libraries generate a unique signature with an s-value in the lower half order.
        //
        // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
        // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
        // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
        // these malleable signatures as well.
        if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
            return (address(0), RecoverError.InvalidSignatureS);
        }

        // If the signature is valid (and not malleable), return the signer address
        address signer = ecrecover(hash, v, r, s);
        if (signer == address(0)) {
            return (address(0), RecoverError.InvalidSignature);
        }

        return (signer, RecoverError.NoError);
    }

    /**
     * @dev Overload of {ECDSA-recover} that receives the `v`,
     * `r` and `s` signature fields separately.
     */
    function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
        (address recovered, RecoverError error) = tryRecover(hash, v, r, s);
        _throwError(error);
        return recovered;
    }

    /**
     * @dev Returns an Ethereum Signed Message, created from a `hash`. This
     * produces hash corresponding to the one signed with the
     * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
     * JSON-RPC method as part of EIP-191.
     *
     * See {recover}.
     */
    function toEthSignedMessageHash(bytes32 hash) internal pure returns (bytes32 message) {
        // 32 is the length in bytes of hash,
        // enforced by the type signature above
        /// @solidity memory-safe-assembly
        assembly {
            mstore(0x00, "\x19Ethereum Signed Message:\n32")
            mstore(0x1c, hash)
            message := keccak256(0x00, 0x3c)
        }
    }

    /**
     * @dev Returns an Ethereum Signed Message, created from `s`. This
     * produces hash corresponding to the one signed with the
     * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
     * JSON-RPC method as part of EIP-191.
     *
     * See {recover}.
     */
    function toEthSignedMessageHash(bytes memory s) internal pure returns (bytes32) {
        return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n", Strings.toString(s.length), s));
    }

    /**
     * @dev Returns an Ethereum Signed Typed Data, created from a
     * `domainSeparator` and a `structHash`. This produces hash corresponding
     * to the one signed with the
     * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`]
     * JSON-RPC method as part of EIP-712.
     *
     * See {recover}.
     */
    function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 data) {
        /// @solidity memory-safe-assembly
        assembly {
            let ptr := mload(0x40)
            mstore(ptr, "\x19\x01")
            mstore(add(ptr, 0x02), domainSeparator)
            mstore(add(ptr, 0x22), structHash)
            data := keccak256(ptr, 0x42)
        }
    }

    /**
     * @dev Returns an Ethereum Signed Data with intended validator, created from a
     * `validator` and `data` according to the version 0 of EIP-191.
     *
     * See {recover}.
     */
    function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
        return keccak256(abi.encodePacked("\x19\x00", validator, data));
    }
}
          

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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 (last updated v4.9.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.

pragma solidity ^0.8.0;

/**
 * @dev Library for reading and writing primitive types to specific storage slots.
 *
 * Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
 * This library helps with reading and writing to such slots without the need for inline assembly.
 *
 * The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
 *
 * Example usage to set ERC1967 implementation slot:
 * ```solidity
 * contract ERC1967 {
 *     bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
 *
 *     function _getImplementation() internal view returns (address) {
 *         return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
 *     }
 *
 *     function _setImplementation(address newImplementation) internal {
 *         require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract");
 *         StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
 *     }
 * }
 * ```
 *
 * _Available since v4.1 for `address`, `bool`, `bytes32`, `uint256`._
 * _Available since v4.9 for `string`, `bytes`._
 */
library StorageSlot {
    struct AddressSlot {
        address value;
    }

    struct BooleanSlot {
        bool value;
    }

    struct Bytes32Slot {
        bytes32 value;
    }

    struct Uint256Slot {
        uint256 value;
    }

    struct StringSlot {
        string value;
    }

    struct BytesSlot {
        bytes value;
    }

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.8;

import "./StorageSlot.sol";

// | string  | 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA   |
// | length  | 0x                                                              BB |
type ShortString is bytes32;

/**
 * @dev This library provides functions to convert short memory strings
 * into a `ShortString` type that can be used as an immutable variable.
 *
 * Strings of arbitrary length can be optimized using this library if
 * they are short enough (up to 31 bytes) by packing them with their
 * length (1 byte) in a single EVM word (32 bytes). Additionally, a
 * fallback mechanism can be used for every other case.
 *
 * Usage example:
 *
 * ```solidity
 * contract Named {
 *     using ShortStrings for *;
 *
 *     ShortString private immutable _name;
 *     string private _nameFallback;
 *
 *     constructor(string memory contractName) {
 *         _name = contractName.toShortStringWithFallback(_nameFallback);
 *     }
 *
 *     function name() external view returns (string memory) {
 *         return _name.toStringWithFallback(_nameFallback);
 *     }
 * }
 * ```
 */
library ShortStrings {
    // Used as an identifier for strings longer than 31 bytes.
    bytes32 private constant _FALLBACK_SENTINEL = 0x00000000000000000000000000000000000000000000000000000000000000FF;

    error StringTooLong(string str);
    error InvalidShortString();

    /**
     * @dev Encode a string of at most 31 chars into a `ShortString`.
     *
     * This will trigger a `StringTooLong` error is the input string is too long.
     */
    function toShortString(string memory str) internal pure returns (ShortString) {
        bytes memory bstr = bytes(str);
        if (bstr.length > 31) {
            revert StringTooLong(str);
        }
        return ShortString.wrap(bytes32(uint256(bytes32(bstr)) | bstr.length));
    }

    /**
     * @dev Decode a `ShortString` back to a "normal" string.
     */
    function toString(ShortString sstr) internal pure returns (string memory) {
        uint256 len = byteLength(sstr);
        // using `new string(len)` would work locally but is not memory safe.
        string memory str = new string(32);
        /// @solidity memory-safe-assembly
        assembly {
            mstore(str, len)
            mstore(add(str, 0x20), sstr)
        }
        return str;
    }

    /**
     * @dev Return the length of a `ShortString`.
     */
    function byteLength(ShortString sstr) internal pure returns (uint256) {
        uint256 result = uint256(ShortString.unwrap(sstr)) & 0xFF;
        if (result > 31) {
            revert InvalidShortString();
        }
        return result;
    }

    /**
     * @dev Encode a string into a `ShortString`, or write it to storage if it is too long.
     */
    function toShortStringWithFallback(string memory value, string storage store) internal returns (ShortString) {
        if (bytes(value).length < 32) {
            return toShortString(value);
        } else {
            StorageSlot.getStringSlot(store).value = value;
            return ShortString.wrap(_FALLBACK_SENTINEL);
        }
    }

    /**
     * @dev Decode a string that was encoded to `ShortString` or written to storage using {setWithFallback}.
     */
    function toStringWithFallback(ShortString value, string storage store) internal pure returns (string memory) {
        if (ShortString.unwrap(value) != _FALLBACK_SENTINEL) {
            return toString(value);
        } else {
            return store;
        }
    }

    /**
     * @dev Return the length of a string that was encoded to `ShortString` or written to storage using {setWithFallback}.
     *
     * WARNING: This will return the "byte length" of the string. This may not reflect the actual length in terms of
     * actual characters as the UTF-8 encoding of a single character can span over multiple bytes.
     */
    function byteLengthWithFallback(ShortString value, string storage store) internal view returns (uint256) {
        if (ShortString.unwrap(value) != _FALLBACK_SENTINEL) {
            return byteLength(value);
        } else {
            return bytes(store).length;
        }
    }
}
          

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.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: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (interfaces/IERC5267.sol)

pragma solidity ^0.8.0;

interface IERC5267 {
    /**
     * @dev MAY be emitted to signal that the domain could have changed.
     */
    event EIP712DomainChanged();

    /**
     * @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
     * signature.
     */
    function eip712Domain()
        external
        view
        returns (
            bytes1 fields,
            string memory name,
            string memory version,
            uint256 chainId,
            address verifyingContract,
            bytes32 salt,
            uint256[] memory extensions
        );
}
          

// 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 (last updated v4.9.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());
        }
    }
}