Cryo Explorer Ethereum Mainnet

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

/**
 * @title ArbitrageV2_Mainnet
 * @notice 2–3 hop arbitrage across curated pools on Ethereum Mainnet.
 * @dev ADAPTED FOR ETHEREUM MAINNET.
 */

import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/security/Pausable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";

import "./interfaces/ethInterfaces.sol";
import "./libraries/EthPoolRegistry.sol";

contract EthArb is ReentrancyGuard, Pausable {
    using SafeERC20 for IERC20;

    // ====== OWNER / TOKENS (Ethereum Mainnet) ======
    // SECURITY WARNING: Do not hardcode this in production if you want transferability.
    // Use Ownable.sol instead.
    address private constant OWNER_ADDRESS = 0x680D92E2AE066648aEd78e6d6E468aD4514636fC;

    // USDC (Mainnet): 6 decimals
    address private constant USDC = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
    // WETH (Mainnet): 18 decimals
    address private constant WETH = 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2;

    // ====== SQRT PRICE LIMITS ======
    uint160 private constant MIN_SQRT_RATIO = 4295128739;
    uint160 private constant MAX_SQRT_RATIO = 1461446703485210103287273052203988822378723970342;

    // ====== QUOTERS (Ethereum Mainnet) ======
    // Uniswap V3 QuoterV2
    address private constant UNISWAP_QUOTER = 0x61fFE014bA17989E743c5F6cB21bF9697530B21e;
    // Pancake V3 QuoterV2 (Same deployment address as Base)
    address private constant PANCAKE_QUOTER = 0xB048Bbc1Ee6b733FFfCFb9e9CeF7375518e25997;

    address public algebraQuoter = address(0);

    // ====== REGISTRY / STATE ======
    mapping(address => PoolRegistry.PoolInfo) public poolRegistry;
    mapping(address => bool) private activeSwaps;

    bool public useLimitedAllowances = true;
    mapping(address => mapping(address => bool)) private hasInfiniteAllowance;

    // ====== EVENTS ======
    event ArbitrageExecuted(
        address[3] pools,
        uint256 inAmt,
        uint256 outAmt,
        int256 profit,
        uint256 gasUsed
    );
    event EmergencyWithdrawal(address token, uint256 amount);
    event UseLimitedAllowancesSet(bool enabled);
    event AlgebraQuoterSet(address quoter);

    modifier onlyOwner() {
        require(msg.sender == OWNER_ADDRESS, "Only owner");
        _;
    }

    constructor() {
        PoolRegistry.initializeAllPools(poolRegistry);
    }

    // ====== ADMIN ======
    function pause() external onlyOwner {
        _pause();
    }
    function unpause() external onlyOwner {
        _unpause();
    }

    function setUseLimitedAllowances(bool _useLimited) external onlyOwner {
        useLimitedAllowances = _useLimited;
        emit UseLimitedAllowancesSet(_useLimited);
    }

    function setAlgebraQuoter(address q) external onlyOwner {
        algebraQuoter = q;
        emit AlgebraQuoterSet(q);
    }

    function sweep(address token) external onlyOwner nonReentrant {
        uint256 bal = IERC20(token).balanceOf(address(this));
        if (bal > 0) IERC20(token).safeTransfer(OWNER_ADDRESS, bal);
        emit EmergencyWithdrawal(token, bal);
    }

    function withdrawAll() external onlyOwner nonReentrant {
        uint256 u = IERC20(USDC).balanceOf(address(this));
        if (u > 0) IERC20(USDC).safeTransfer(OWNER_ADDRESS, u);
        uint256 w = IERC20(WETH).balanceOf(address(this));
        if (w > 0) IERC20(WETH).safeTransfer(OWNER_ADDRESS, w);
        if (u > 0) emit EmergencyWithdrawal(USDC, u);
        if (w > 0) emit EmergencyWithdrawal(WETH, w);
    }

    function addPool(address pool, uint8 dex) external onlyOwner {
        require(pool != address(0), "zero");
        require(dex <= uint8(PoolRegistry.Dex.Algebra), "bad dex");
        PoolRegistry._set(poolRegistry, pool, PoolRegistry.Dex(dex));
    }

    // ====== PREVIEW ======
    function preview(address[3] calldata pools, uint256 usdcAmount)
        external
        whenNotPaused
        returns (uint256 expectedOut, int256 profit)
    {
        require(usdcAmount > 0, "Invalid amount");
        _validatePools(pools);

        uint256 outAmt = _simulatePath(pools, usdcAmount);
        return (outAmt, int256(outAmt) - int256(usdcAmount));
    }

    // ====== EXECUTE ======
    function execute(
        address[3] calldata pools,
        uint256 usdcAmount,
        uint256 minProfit,
        uint256 maxSlippageBps
    ) external nonReentrant whenNotPaused returns (int256 profit) {
        require(usdcAmount > 0, "Invalid amount");
        _validatePools(pools);

        // SAFETY MODE
        if (minProfit > 0) {
            uint256 expected = _simulatePath(pools, usdcAmount);
            require(expected >= usdcAmount + minProfit, "Not profitable");
        }

        uint256 gasStart = gasleft();
        uint256 outAmt;

        if (pools[2] == address(0)) {
            outAmt = _execute2Hop(
                pools[0],
                pools[1],
                usdcAmount,
                maxSlippageBps
            );
        } else {
            outAmt = _execute3Hop(
                pools[0],
                pools[1],
                pools[2],
                usdcAmount,
                maxSlippageBps
            );
        }

        profit = int256(outAmt) - int256(usdcAmount);
        emit ArbitrageExecuted(
            [pools[0], pools[1], pools[2]],
            usdcAmount,
            outAmt,
            profit,
            gasStart - gasleft()
        );
    }

    // ====== INTERNAL: SIMULATION ======
    function _validatePools(address[3] calldata pools) internal view {
        require(poolRegistry[pools[0]].exists, "Pool1 !exists");
        require(poolRegistry[pools[1]].exists, "Pool2 !exists");
        if (pools[2] != address(0))
            require(poolRegistry[pools[2]].exists, "Pool3 !exists");
    }

    function _simulatePath(address[3] calldata pools, uint256 amountIn)
        internal
        returns (uint256)
    {
        if (pools[2] == address(0)) {
            return _simulate2Hop(pools[0], pools[1], amountIn);
        } else {
            return _simulate3Hop(pools[0], pools[1], pools[2], amountIn);
        }
    }

    function _simulate2Hop(
        address pool0,
        address pool1,
        uint256 amountIn
    ) internal returns (uint256) {
        address mid = _midToken(pool0, poolRegistry[pool0].dex);
        uint256 amt = _quoteExactInputSingle(
            pool0,
            poolRegistry[pool0].dex,
            USDC,
            mid,
            amountIn
        );
        return
            _quoteExactInputSingle(
                pool1,
                poolRegistry[pool1].dex,
                mid,
                USDC,
                amt
            );
    }

    function _simulate3Hop(
        address pool0,
        address pool1,
        address pool2,
        uint256 amountIn
    ) internal returns (uint256) {
        address token1 = _midToken(pool0, poolRegistry[pool0].dex);
        uint256 amt = _quoteExactInputSingle(
            pool0,
            poolRegistry[pool0].dex,
            USDC,
            token1,
            amountIn
        );
        address token2 = _nextToken(pool1, poolRegistry[pool1].dex, token1);
        amt = _quoteExactInputSingle(
            pool1,
            poolRegistry[pool1].dex,
            token1,
            token2,
            amt
        );
        _assertEndsInUSDC(pool2, poolRegistry[pool2].dex, token2);
        return
            _quoteExactInputSingle(
                pool2,
                poolRegistry[pool2].dex,
                token2,
                USDC,
                amt
            );
    }

    function _quoteExactInputSingle(
        address pool,
        PoolRegistry.Dex dex,
        address tokenIn,
        address tokenOut,
        uint256 amountIn
    ) internal returns (uint256 out) {
        (address t0, address t1) = _tokens(pool, dex);
        require(
            (tokenIn == t0 && tokenOut == t1) ||
                (tokenIn == t1 && tokenOut == t0),
            "quote: token pair not in pool"
        );

        if (
            dex == PoolRegistry.Dex.UniswapV3 ||
            dex == PoolRegistry.Dex.PancakeV3
        ) {
            uint24 fee = IUniswapV3Pool(pool).fee();
            bytes memory path = _encodeV3Path(tokenIn, tokenOut, fee);
            address quoter = dex == PoolRegistry.Dex.UniswapV3
                ? UNISWAP_QUOTER
                : PANCAKE_QUOTER;

            try
                IV3QuoterV2Bytes(quoter).quoteExactInput(path, amountIn)
            returns (uint256 amountOut, uint160, uint32, uint256) {
                out = amountOut;
            } catch {
                out = 0;
            }
        } else {
            require(algebraQuoter != address(0), "Algebra quoter not set");
            IAlgebraQuoterV2.QuoteExactInputSingleParams
                memory p = IAlgebraQuoterV2.QuoteExactInputSingleParams({
                    tokenIn: tokenIn,
                    tokenOut: tokenOut,
                    amountIn: amountIn,
                    limitSqrtPrice: 0
                });
            try
                IAlgebraQuoterV2(algebraQuoter).quoteExactInputSingle(p)
            returns (uint256 amountOut, uint160, uint32, uint256) {
                out = amountOut;
            } catch {
                out = 0;
            }
        }
    }

    // ====== INTERNAL: REAL EXECUTION ======
    function _execute2Hop(
        address pool0,
        address pool1,
        uint256 amountInUSDC,
        uint256 maxSlippageBps
    ) internal returns (uint256) {
        address mid = _midToken(pool0, poolRegistry[pool0].dex);
        uint256 amt = _executeSwap(
            pool0,
            poolRegistry[pool0].dex,
            USDC,
            mid,
            amountInUSDC,
            maxSlippageBps
        );
        return
            _executeSwap(
                pool1,
                poolRegistry[pool1].dex,
                mid,
                USDC,
                amt,
                maxSlippageBps
            );
    }

    function _execute3Hop(
        address pool0,
        address pool1,
        address pool2,
        uint256 amountInUSDC,
        uint256 maxSlippageBps
    ) internal returns (uint256) {
        address token1 = _midToken(pool0, poolRegistry[pool0].dex);
        uint256 amt = _executeSwap(
            pool0,
            poolRegistry[pool0].dex,
            USDC,
            token1,
            amountInUSDC,
            maxSlippageBps
        );
        address token2 = _nextToken(pool1, poolRegistry[pool1].dex, token1);
        amt = _executeSwap(
            pool1,
            poolRegistry[pool1].dex,
            token1,
            token2,
            amt,
            maxSlippageBps
        );
        _assertEndsInUSDC(pool2, poolRegistry[pool2].dex, token2);
        return
            _executeSwap(
                pool2,
                poolRegistry[pool2].dex,
                token2,
                USDC,
                amt,
                maxSlippageBps
            );
    }

    function _executeSwap(
        address pool,
        PoolRegistry.Dex dex,
        address tokenIn,
        address tokenOut,
        uint256 amountIn,
        uint256 maxSlippageBps
    ) internal returns (uint256 amountOut) {
        activeSwaps[pool] = true;

        if (useLimitedAllowances) {
            uint256 cur = IERC20(tokenIn).allowance(address(this), pool);
            if (cur < amountIn) {
                if (cur > 0) IERC20(tokenIn).approve(pool, 0);
                IERC20(tokenIn).approve(pool, amountIn);
            }
        } else {
            if (!hasInfiniteAllowance[tokenIn][pool]) {
                IERC20(tokenIn).approve(pool, type(uint256).max);
                hasInfiniteAllowance[tokenIn][pool] = true;
            }
        }

        bool zeroForOne = tokenIn < tokenOut;
        uint160 sqrtLimit = _computeSqrtPriceLimitX96(
            pool,
            dex,
            maxSlippageBps,
            zeroForOne
        );

        int256 amount0;
        int256 amount1;

        if (
            dex == PoolRegistry.Dex.UniswapV3 ||
            dex == PoolRegistry.Dex.PancakeV3
        ) {
            (amount0, amount1) = IUniswapV3Pool(pool).swap(
                address(this),
                zeroForOne,
                int256(amountIn),
                sqrtLimit,
                abi.encode(tokenIn)
            );
        } else {
            (amount0, amount1) = IAlgebraPool(pool).swap(
                address(this),
                zeroForOne,
                int256(amountIn),
                sqrtLimit,
                abi.encode(tokenIn)
            );
        }

        if (useLimitedAllowances) IERC20(tokenIn).approve(pool, 0);
        activeSwaps[pool] = false;

        if (zeroForOne) {
            amountOut = uint256(-amount1);
        } else {
            amountOut = uint256(-amount0);
        }
    }

    function _computeSqrtPriceLimitX96(
        address pool,
        PoolRegistry.Dex dex,
        uint256 maxSlippageBps,
        bool zeroForOne
    ) internal view returns (uint160) {
        if (maxSlippageBps == 0) {
            return zeroForOne ? (MIN_SQRT_RATIO + 1) : (MAX_SQRT_RATIO - 1);
        }

        uint160 sqrtP;
        if (
            dex == PoolRegistry.Dex.UniswapV3 ||
            dex == PoolRegistry.Dex.PancakeV3
        ) {
            (sqrtP, , , , , , ) = IUniswapV3Pool(pool).slot0();
        } else {
            (sqrtP, , , , ) = IAlgebraPool(pool).globalState();
        }

        if (zeroForOne) {
            uint256 limit = (uint256(sqrtP) * (10_000 - maxSlippageBps)) /
                10_000;
            if (limit < MIN_SQRT_RATIO) return MIN_SQRT_RATIO + 1;
            return uint160(limit);
        } else {
            uint256 limit = (uint256(sqrtP) * (10_000 + maxSlippageBps)) /
                10_000;
            if (limit > MAX_SQRT_RATIO) return MAX_SQRT_RATIO - 1;
            return uint160(limit);
        }
    }

    // ====== CALLBACKS ======
    function uniswapV3SwapCallback(
        int256 amount0Delta,
        int256 amount1Delta,
        bytes calldata data
    ) external {
        _payCallback(msg.sender, amount0Delta, amount1Delta, data);
    }
    function pancakeV3SwapCallback(
        int256 amount0Delta,
        int256 amount1Delta,
        bytes calldata data
    ) external {
        _payCallback(msg.sender, amount0Delta, amount1Delta, data);
    }
    function algebraSwapCallback(
        int256 amount0Delta,
        int256 amount1Delta,
        bytes calldata data
    ) external {
        _payCallback(msg.sender, amount0Delta, amount1Delta, data);
    }

    function _payCallback(
        address pool,
        int256 amount0Delta,
        int256 amount1Delta,
        bytes calldata data
    ) internal {
        require(activeSwaps[pool], "callback-invalid");
        address tokenIn = abi.decode(data, (address));
        if (amount0Delta > 0)
            IERC20(tokenIn).safeTransfer(pool, uint256(amount0Delta));
        if (amount1Delta > 0)
            IERC20(tokenIn).safeTransfer(pool, uint256(amount1Delta));
    }

    // ====== HELPERS ======
    function _tokens(address pool, PoolRegistry.Dex dex)
        internal
        view
        returns (address t0, address t1)
    {
        if (
            dex == PoolRegistry.Dex.UniswapV3 ||
            dex == PoolRegistry.Dex.PancakeV3
        ) {
            t0 = IUniswapV3Pool(pool).token0();
            t1 = IUniswapV3Pool(pool).token1();
        } else {
            t0 = IAlgebraPool(pool).token0();
            t1 = IAlgebraPool(pool).token1();
        }
    }

    function _midToken(address pool, PoolRegistry.Dex dex)
        internal
        view
        returns (address)
    {
        (address t0, address t1) = _tokens(pool, dex);
        return (t0 == USDC) ? t1 : t0;
    }

    function _nextToken(address pool, PoolRegistry.Dex dex, address prev)
        internal
        view
        returns (address)
    {
        (address t0, address t1) = _tokens(pool, dex);
        return (t0 == prev) ? t1 : t0;
    }

    function _assertEndsInUSDC(
        address pool,
        PoolRegistry.Dex dex,
        address token2
    ) internal view {
        (address t0, address t1) = _tokens(pool, dex);
        require(
            (t0 == token2 && t1 == USDC) || (t1 == token2 && t0 == USDC),
            "Invalid 3-hop path"
        );
    }

    function _encodeV3Path(
        address tokenIn,
        address tokenOut,
        uint24 fee
    ) internal pure returns (bytes memory) {
        return abi.encodePacked(tokenIn, fee, tokenOut);
    }
}

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

library PoolRegistry {
    enum Dex { UniswapV3, PancakeV3, Algebra }

    struct PoolInfo {
        Dex dex;
        bool exists;
    }

    function _set(
        mapping(address => PoolInfo) storage reg,
        address pool,
        Dex dex
    ) internal {
        reg[pool] = PoolInfo({ dex: dex, exists: true });
    }

    function initializeAllPools(mapping(address => PoolInfo) storage reg) external {
        _set(reg, 0x88e6A0c2dDD26FEEb64F039a2c41296FcB3f5640, Dex.UniswapV3);
    }
}

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

/// ---------- UniswapV3 / PancakeV3 Pool ----------
interface IUniswapV3Pool {
    function swap(
        address recipient,
        bool zeroForOne,
        int256 amountSpecified,
        uint160 sqrtPriceLimitX96,
        bytes calldata data
    ) external returns (int256 amount0, int256 amount1);

    function fee() external view returns (uint24);
    function token0() external view returns (address);
    function token1() external view returns (address);
    function slot0()
        external
        view
        returns (
            uint160 sqrtPriceX96,
            int24 tick,
            uint16 observationIndex,
            uint16 observationCardinality,
            uint16 observationCardinalityNext,
            uint8 feeProtocol,
            bool unlocked
        );
}

/// ---------- Uniswap/Pancake QuoterV2 Interfaces ----------
// Consolidated for brevity as they share signatures
interface IV3QuoterV2Bytes {
    function quoteExactInput(bytes memory path, uint256 amountIn)
        external
        returns (
            uint256 amountOut,
            uint160 sqrtPriceX96After,
            uint32 initializedTicksCrossed,
            uint256 gasEstimate
        );
}

/// ---------- Algebra (Slipstream/QuickSwap) Interfaces ----------
// Note: Algebra is less common on Mainnet than Base (Aerodrome).
// Ensure you are targeting valid Algebra pools if using this Dex ID.
interface IAlgebraPool {
    function swap(
        address recipient,
        bool zeroToOne,
        int256 amountSpecified,
        uint160 limitSqrtPrice,
        bytes calldata data
    ) external returns (int256 amount0, int256 amount1);

    function token0() external view returns (address);
    function token1() external view returns (address);
    function globalState()
        external
        view
        returns (
            uint160 price,
            int24 tick,
            uint16 lastFee,
            uint8 pluginConfig,
            uint8 communityFee
        );
}

interface IAlgebraQuoterV2 {
    struct QuoteExactInputSingleParams {
        address tokenIn;
        address tokenOut;
        uint256 amountIn;
        uint160 limitSqrtPrice;
    }
    function quoteExactInputSingle(QuoteExactInputSingleParams memory params)
        external
        returns (
            uint256 amountOut,
            uint160 sqrtPriceX96After,
            uint32 initializedTicksCrossed,
            uint256 gasEstimate
        );
}

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
     * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
     * on the return value: the return value is optional (but if data is returned, it must not be false).
     * @param token The token targeted by the call.
     * @param data The call data (encoded using abi.encode or one of its variants).
     *
     * This is a variant of {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
     */
    function _callOptionalReturn(IERC20 token, bytes memory data) private {
        uint256 returnSize;
        uint256 returnValue;
        assembly ("memory-safe") {
            let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
            // bubble errors
            if iszero(success) {
                let ptr := mload(0x40)
                returndatacopy(ptr, 0, returndatasize())
                revert(ptr, returndatasize())
            }
            returnSize := returndatasize()
            returnValue := mload(0)
        }

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

    /**
     * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
     * on the return value: the return value is optional (but if data is returned, it must not be false).
     * @param token The token targeted by the call.
     * @param data The call data (encoded using abi.encode or one of its variants).
     *
     * This is a variant of {_callOptionalReturn} that silently catches all reverts and returns a bool instead.
     */
    function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
        bool success;
        uint256 returnSize;
        uint256 returnValue;
        assembly ("memory-safe") {
            success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
            returnSize := returndatasize()
            returnValue := mload(0)
        }
        return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
    }
}

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

pragma solidity >=0.4.16;

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.0;

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

/**
 * @dev Contract module which allows children to implement an emergency stop
 * mechanism that can be triggered by an authorized account.
 *
 * This module is used through inheritance. It will make available the
 * modifiers `whenNotPaused` and `whenPaused`, which can be applied to
 * the functions of your contract. Note that they will not be pausable by
 * simply including this module, only once the modifiers are put in place.
 */
abstract contract Pausable is Context {
    /**
     * @dev Emitted when the pause is triggered by `account`.
     */
    event Paused(address account);

    /**
     * @dev Emitted when the pause is lifted by `account`.
     */
    event Unpaused(address account);

    bool private _paused;

    /**
     * @dev Initializes the contract in unpaused state.
     */
    constructor() {
        _paused = false;
    }

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

    /**
     * @dev Modifier to make a function callable only when the contract is paused.
     *
     * Requirements:
     *
     * - The contract must be paused.
     */
    modifier whenPaused() {
        _requirePaused();
        _;
    }

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

    /**
     * @dev Throws if the contract is paused.
     */
    function _requireNotPaused() internal view virtual {
        require(!paused(), "Pausable: paused");
    }

    /**
     * @dev Throws if the contract is not paused.
     */
    function _requirePaused() internal view virtual {
        require(paused(), "Pausable: not paused");
    }

    /**
     * @dev Triggers stopped state.
     *
     * Requirements:
     *
     * - The contract must not be paused.
     */
    function _pause() internal virtual whenNotPaused {
        _paused = true;
        emit Paused(_msgSender());
    }

    /**
     * @dev Returns to normal state.
     *
     * Requirements:
     *
     * - The contract must be paused.
     */
    function _unpause() internal virtual whenPaused {
        _paused = false;
        emit Unpaused(_msgSender());
    }
}

// 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 v5.4.0) (interfaces/IERC1363.sol)

pragma solidity >=0.6.2;

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

pragma solidity >=0.4.16;

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

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

pragma solidity >=0.4.16;

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

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

pragma solidity >=0.4.16;

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