Contract

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

pragma solidity >=0.4.16;

/**
 * @dev ERC-1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified
 * proxy whose upgrades are fully controlled by the current implementation.
 */
interface IERC1822Proxiable {
    /**
     * @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation
     * address.
     *
     * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
     * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
     * function revert if invoked through a proxy.
     */
    function proxiableUUID() external view returns (bytes32);
}

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

/// @title Error Definitions
/// @notice Custom errors for diamond and ERC1363 diamond initialization

/// @notice Error thrown when the diamond contract is not initialized
error DiamondNotInitialized();

/// @notice Error thrown when the ERC1363 diamond contract is not initialized
error ERC1363DiamondNotInitialized();

error ContractError(string);

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

pragma solidity ^0.8.20;

import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";

/**
 * @dev Standard math utilities missing in the Solidity language.
 */
library Math {
    enum Rounding {
        Floor, // Toward negative infinity
        Ceil, // Toward positive infinity
        Trunc, // Toward zero
        Expand // Away from zero
    }

    /**
     * @dev Return the 512-bit addition of two uint256.
     *
     * The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low.
     */
    function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
        assembly ("memory-safe") {
            low := add(a, b)
            high := lt(low, a)
        }
    }

    /**
     * @dev Return the 512-bit multiplication of two uint256.
     *
     * The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low.
     */
    function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
        // 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
        // the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
        // variables such that product = high * 2²⁵⁶ + low.
        assembly ("memory-safe") {
            let mm := mulmod(a, b, not(0))
            low := mul(a, b)
            high := sub(sub(mm, low), lt(mm, low))
        }
    }

    /**
     * @dev Returns the addition of two unsigned integers, with a success flag (no overflow).
     */
    function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            uint256 c = a + b;
            success = c >= a;
            result = c * SafeCast.toUint(success);
        }
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow).
     */
    function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            uint256 c = a - b;
            success = c <= a;
            result = c * SafeCast.toUint(success);
        }
    }

    /**
     * @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow).
     */
    function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            uint256 c = a * b;
            assembly ("memory-safe") {
                // Only true when the multiplication doesn't overflow
                // (c / a == b) || (a == 0)
                success := or(eq(div(c, a), b), iszero(a))
            }
            // equivalent to: success ? c : 0
            result = c * SafeCast.toUint(success);
        }
    }

    /**
     * @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
     */
    function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            success = b > 0;
            assembly ("memory-safe") {
                // The `DIV` opcode returns zero when the denominator is 0.
                result := div(a, b)
            }
        }
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
     */
    function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            success = b > 0;
            assembly ("memory-safe") {
                // The `MOD` opcode returns zero when the denominator is 0.
                result := mod(a, b)
            }
        }
    }

    /**
     * @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing.
     */
    function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) {
        (bool success, uint256 result) = tryAdd(a, b);
        return ternary(success, result, type(uint256).max);
    }

    /**
     * @dev Unsigned saturating subtraction, bounds to zero instead of overflowing.
     */
    function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) {
        (, uint256 result) = trySub(a, b);
        return result;
    }

    /**
     * @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing.
     */
    function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) {
        (bool success, uint256 result) = tryMul(a, b);
        return ternary(success, result, type(uint256).max);
    }

    /**
     * @dev Branchless ternary evaluation for `condition ? a : b`. Gas costs are constant.
     *
     * IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
     * However, the compiler may optimize Solidity ternary operations (i.e. `condition ? a : b`) to only compute
     * one branch when needed, making this function more expensive.
     */
    function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
        unchecked {
            // branchless ternary works because:
            // b ^ (a ^ b) == a
            // b ^ 0 == b
            return b ^ ((a ^ b) * SafeCast.toUint(condition));
        }
    }

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

    /**
     * @dev Returns the smallest of two numbers.
     */
    function min(uint256 a, uint256 b) internal pure returns (uint256) {
        return ternary(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) {
        unchecked {
            // (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 towards infinity instead
     * of rounding towards zero.
     */
    function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
        if (b == 0) {
            // Guarantee the same behavior as in a regular Solidity division.
            Panic.panic(Panic.DIVISION_BY_ZERO);
        }

        // The following calculation ensures accurate ceiling division without overflow.
        // Since a is non-zero, (a - 1) / b will not overflow.
        // The largest possible result occurs when (a - 1) / b is type(uint256).max,
        // but the largest value we can obtain is type(uint256).max - 1, which happens
        // when a = type(uint256).max and b = 1.
        unchecked {
            return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
        }
    }

    /**
     * @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
     * denominator == 0.
     *
     * 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 {
            (uint256 high, uint256 low) = mul512(x, y);

            // Handle non-overflow cases, 256 by 256 division.
            if (high == 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 low / denominator;
            }

            // Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
            if (denominator <= high) {
                Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
            }

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

            // Make division exact by subtracting the remainder from [high low].
            uint256 remainder;
            assembly ("memory-safe") {
                // Compute remainder using mulmod.
                remainder := mulmod(x, y, denominator)

                // Subtract 256 bit number from 512 bit number.
                high := sub(high, gt(remainder, low))
                low := sub(low, 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.

            uint256 twos = denominator & (0 - denominator);
            assembly ("memory-safe") {
                // Divide denominator by twos.
                denominator := div(denominator, twos)

                // Divide [high low] by twos.
                low := div(low, twos)

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

            // Shift in bits from high into low.
            low |= high * twos;

            // Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
            // that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
            // four bits. That is, denominator * inv ≡ 1 mod 2⁴.
            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⁸
            inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
            inverse *= 2 - denominator * inverse; // inverse mod 2³²
            inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
            inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
            inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶

            // 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²⁵⁶. Since the preconditions guarantee that the outcome is
            // less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high
            // is no longer required.
            result = low * inverse;
            return result;
        }
    }

    /**
     * @dev 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) {
        return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
    }

    /**
     * @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256.
     */
    function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) {
        unchecked {
            (uint256 high, uint256 low) = mul512(x, y);
            if (high >= 1 << n) {
                Panic.panic(Panic.UNDER_OVERFLOW);
            }
            return (high << (256 - n)) | (low >> n);
        }
    }

    /**
     * @dev Calculates x * y >> n with full precision, following the selected rounding direction.
     */
    function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) {
        return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0);
    }

    /**
     * @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
     *
     * If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
     * If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
     *
     * If the input value is not inversible, 0 is returned.
     *
     * NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
     * inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
     */
    function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
        unchecked {
            if (n == 0) return 0;

            // The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
            // Used to compute integers x and y such that: ax + ny = gcd(a, n).
            // When the gcd is 1, then the inverse of a modulo n exists and it's x.
            // ax + ny = 1
            // ax = 1 + (-y)n
            // ax ≡ 1 (mod n) # x is the inverse of a modulo n

            // If the remainder is 0 the gcd is n right away.
            uint256 remainder = a % n;
            uint256 gcd = n;

            // Therefore the initial coefficients are:
            // ax + ny = gcd(a, n) = n
            // 0a + 1n = n
            int256 x = 0;
            int256 y = 1;

            while (remainder != 0) {
                uint256 quotient = gcd / remainder;

                (gcd, remainder) = (
                    // The old remainder is the next gcd to try.
                    remainder,
                    // Compute the next remainder.
                    // Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
                    // where gcd is at most n (capped to type(uint256).max)
                    gcd - remainder * quotient
                );

                (x, y) = (
                    // Increment the coefficient of a.
                    y,
                    // Decrement the coefficient of n.
                    // Can overflow, but the result is casted to uint256 so that the
                    // next value of y is "wrapped around" to a value between 0 and n - 1.
                    x - y * int256(quotient)
                );
            }

            if (gcd != 1) return 0; // No inverse exists.
            return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
        }
    }

    /**
     * @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
     *
     * From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
     * prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
     * `a**(p-2)` is the modular multiplicative inverse of a in Fp.
     *
     * NOTE: this function does NOT check that `p` is a prime greater than `2`.
     */
    function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
        unchecked {
            return Math.modExp(a, p - 2, p);
        }
    }

    /**
     * @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
     *
     * Requirements:
     * - modulus can't be zero
     * - underlying staticcall to precompile must succeed
     *
     * IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
     * sure the chain you're using it on supports the precompiled contract for modular exponentiation
     * at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
     * the underlying function will succeed given the lack of a revert, but the result may be incorrectly
     * interpreted as 0.
     */
    function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
        (bool success, uint256 result) = tryModExp(b, e, m);
        if (!success) {
            Panic.panic(Panic.DIVISION_BY_ZERO);
        }
        return result;
    }

    /**
     * @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
     * It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
     * to operate modulo 0 or if the underlying precompile reverted.
     *
     * IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
     * you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
     * https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
     * of a revert, but the result may be incorrectly interpreted as 0.
     */
    function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
        if (m == 0) return (false, 0);
        assembly ("memory-safe") {
            let ptr := mload(0x40)
            // | Offset    | Content    | Content (Hex)                                                      |
            // |-----------|------------|--------------------------------------------------------------------|
            // | 0x00:0x1f | size of b  | 0x0000000000000000000000000000000000000000000000000000000000000020 |
            // | 0x20:0x3f | size of e  | 0x0000000000000000000000000000000000000000000000000000000000000020 |
            // | 0x40:0x5f | size of m  | 0x0000000000000000000000000000000000000000000000000000000000000020 |
            // | 0x60:0x7f | value of b | 0x<.............................................................b> |
            // | 0x80:0x9f | value of e | 0x<.............................................................e> |
            // | 0xa0:0xbf | value of m | 0x<.............................................................m> |
            mstore(ptr, 0x20)
            mstore(add(ptr, 0x20), 0x20)
            mstore(add(ptr, 0x40), 0x20)
            mstore(add(ptr, 0x60), b)
            mstore(add(ptr, 0x80), e)
            mstore(add(ptr, 0xa0), m)

            // Given the result < m, it's guaranteed to fit in 32 bytes,
            // so we can use the memory scratch space located at offset 0.
            success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
            result := mload(0x00)
        }
    }

    /**
     * @dev Variant of {modExp} that supports inputs of arbitrary length.
     */
    function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
        (bool success, bytes memory result) = tryModExp(b, e, m);
        if (!success) {
            Panic.panic(Panic.DIVISION_BY_ZERO);
        }
        return result;
    }

    /**
     * @dev Variant of {tryModExp} that supports inputs of arbitrary length.
     */
    function tryModExp(
        bytes memory b,
        bytes memory e,
        bytes memory m
    ) internal view returns (bool success, bytes memory result) {
        if (_zeroBytes(m)) return (false, new bytes(0));

        uint256 mLen = m.length;

        // Encode call args in result and move the free memory pointer
        result = abi.encodePacked(b.length, e.length, mLen, b, e, m);

        assembly ("memory-safe") {
            let dataPtr := add(result, 0x20)
            // Write result on top of args to avoid allocating extra memory.
            success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
            // Overwrite the length.
            // result.length > returndatasize() is guaranteed because returndatasize() == m.length
            mstore(result, mLen)
            // Set the memory pointer after the returned data.
            mstore(0x40, add(dataPtr, mLen))
        }
    }

    /**
     * @dev Returns whether the provided byte array is zero.
     */
    function _zeroBytes(bytes memory buffer) private pure returns (bool) {
        uint256 chunk;
        for (uint256 i = 0; i < buffer.length; i += 0x20) {
            // See _unsafeReadBytesOffset from utils/Bytes.sol
            assembly ("memory-safe") {
                chunk := mload(add(add(buffer, 0x20), i))
            }
            if (chunk >> (8 * saturatingSub(i + 0x20, buffer.length)) != 0) {
                return false;
            }
        }
        return true;
    }

    /**
     * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
     * towards zero.
     *
     * This method is based on Newton's method for computing square roots; the algorithm is restricted to only
     * using integer operations.
     */
    function sqrt(uint256 a) internal pure returns (uint256) {
        unchecked {
            // Take care of easy edge cases when a == 0 or a == 1
            if (a <= 1) {
                return a;
            }

            // In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
            // sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
            // the current value as `ε_n = | x_n - sqrt(a) |`.
            //
            // For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
            // of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
            // bigger than any uint256.
            //
            // By noticing that
            // `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
            // we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
            // to the msb function.
            uint256 aa = a;
            uint256 xn = 1;

            if (aa >= (1 << 128)) {
                aa >>= 128;
                xn <<= 64;
            }
            if (aa >= (1 << 64)) {
                aa >>= 64;
                xn <<= 32;
            }
            if (aa >= (1 << 32)) {
                aa >>= 32;
                xn <<= 16;
            }
            if (aa >= (1 << 16)) {
                aa >>= 16;
                xn <<= 8;
            }
            if (aa >= (1 << 8)) {
                aa >>= 8;
                xn <<= 4;
            }
            if (aa >= (1 << 4)) {
                aa >>= 4;
                xn <<= 2;
            }
            if (aa >= (1 << 2)) {
                xn <<= 1;
            }

            // We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
            //
            // We can refine our estimation by noticing that the middle of that interval minimizes the error.
            // If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
            // This is going to be our x_0 (and ε_0)
            xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)

            // From here, Newton's method give us:
            // x_{n+1} = (x_n + a / x_n) / 2
            //
            // One should note that:
            // x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
            //              = ((x_n² + a) / (2 * x_n))² - a
            //              = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
            //              = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
            //              = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
            //              = (x_n² - a)² / (2 * x_n)²
            //              = ((x_n² - a) / (2 * x_n))²
            //              ≥ 0
            // Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
            //
            // This gives us the proof of quadratic convergence of the sequence:
            // ε_{n+1} = | x_{n+1} - sqrt(a) |
            //         = | (x_n + a / x_n) / 2 - sqrt(a) |
            //         = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
            //         = | (x_n - sqrt(a))² / (2 * x_n) |
            //         = | ε_n² / (2 * x_n) |
            //         = ε_n² / | (2 * x_n) |
            //
            // For the first iteration, we have a special case where x_0 is known:
            // ε_1 = ε_0² / | (2 * x_0) |
            //     ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
            //     ≤ 2**(2*e-4) / (3 * 2**(e-1))
            //     ≤ 2**(e-3) / 3
            //     ≤ 2**(e-3-log2(3))
            //     ≤ 2**(e-4.5)
            //
            // For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
            // ε_{n+1} = ε_n² / | (2 * x_n) |
            //         ≤ (2**(e-k))² / (2 * 2**(e-1))
            //         ≤ 2**(2*e-2*k) / 2**e
            //         ≤ 2**(e-2*k)
            xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5)  -- special case, see above
            xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9)    -- general case with k = 4.5
            xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18)   -- general case with k = 9
            xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36)   -- general case with k = 18
            xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72)   -- general case with k = 36
            xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144)  -- general case with k = 72

            // Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
            // ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
            // sqrt(a) or sqrt(a) + 1.
            return xn - SafeCast.toUint(xn > a / xn);
        }
    }

    /**
     * @dev 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 + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
        }
    }

    /**
     * @dev Return the log in base 2 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     */
    function log2(uint256 x) internal pure returns (uint256 r) {
        // If value has upper 128 bits set, log2 result is at least 128
        r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
        // If upper 64 bits of 128-bit half set, add 64 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
        // If upper 32 bits of 64-bit half set, add 32 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
        // If upper 16 bits of 32-bit half set, add 16 to result
        r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
        // If upper 8 bits of 16-bit half set, add 8 to result
        r |= SafeCast.toUint((x >> r) > 0xff) << 3;
        // If upper 4 bits of 8-bit half set, add 4 to result
        r |= SafeCast.toUint((x >> r) > 0xf) << 2;

        // Shifts value right by the current result and use it as an index into this lookup table:
        //
        // | x (4 bits) |  index  | table[index] = MSB position |
        // |------------|---------|-----------------------------|
        // |    0000    |    0    |        table[0] = 0         |
        // |    0001    |    1    |        table[1] = 0         |
        // |    0010    |    2    |        table[2] = 1         |
        // |    0011    |    3    |        table[3] = 1         |
        // |    0100    |    4    |        table[4] = 2         |
        // |    0101    |    5    |        table[5] = 2         |
        // |    0110    |    6    |        table[6] = 2         |
        // |    0111    |    7    |        table[7] = 2         |
        // |    1000    |    8    |        table[8] = 3         |
        // |    1001    |    9    |        table[9] = 3         |
        // |    1010    |   10    |        table[10] = 3        |
        // |    1011    |   11    |        table[11] = 3        |
        // |    1100    |   12    |        table[12] = 3        |
        // |    1101    |   13    |        table[13] = 3        |
        // |    1110    |   14    |        table[14] = 3        |
        // |    1111    |   15    |        table[15] = 3        |
        //
        // The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the first 16 bytes (most significant half).
        assembly ("memory-safe") {
            r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000))
        }
    }

    /**
     * @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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
        }
    }

    /**
     * @dev Return the log in base 10 of a positive value rounded towards zero.
     * 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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
        }
    }

    /**
     * @dev Return the log in base 256 of a positive value rounded towards zero.
     * 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 x) internal pure returns (uint256 r) {
        // If value has upper 128 bits set, log2 result is at least 128
        r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
        // If upper 64 bits of 128-bit half set, add 64 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
        // If upper 32 bits of 64-bit half set, add 32 to result
        r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
        // If upper 16 bits of 32-bit half set, add 16 to result
        r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
        // Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8
        return (r >> 3) | SafeCast.toUint((x >> r) > 0xff);
    }

    /**
     * @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 + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
        }
    }

    /**
     * @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
     */
    function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
        return uint8(rounding) % 2 == 1;
    }

    /**
     * @dev Counts the number of leading zero bits in a uint256.
     */
    function clz(uint256 x) internal pure returns (uint256) {
        return ternary(x == 0, 256, 255 - log2(x));
    }
}

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

import { Strings } from "openzeppelin-contracts/contracts/utils/Strings.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { StringsUtil } from "src/utils/Strings.sol";
import { TokenLib } from "src/types/Token.sol";

/// @title CrossChainUserLibrary
/// @notice Library for handling cross-chain user identity and string utilities
library CrossChainUserLibrary {
    using Strings for *;
    using StringsUtil for *;
    using NormalizedPacketLib for *;
    using CrossChainUserLibrary for *;
    using TokenLib for *;

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @notice Struct representing a cross-chain user
    /// @param chain_uid The chain UID
    /// @param sender The lowercase sender address as a string
    struct CrossChainUser {
        string chain_uid;
        string sender;
    }

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Converts an address and chain UID to a CrossChainUser struct
    /// @param sender The address of the user
    /// @param chain_uid The chain UID
    /// @return The CrossChainUser struct
    function toCrossChainUser(address sender, string memory chain_uid) internal pure returns (CrossChainUser memory) {
        return CrossChainUser({ chain_uid: chain_uid, sender: sender.toHexString().toLowerCase() });
    }

    function empty() internal pure returns (CrossChainUser memory) {
        return CrossChainUser({ chain_uid: "", sender: "" });
    }

    /// @notice Checks if a CrossChainUser struct is empty
    /// @param user The CrossChainUser struct
    /// @return True if the CrossChainUser struct is empty, false otherwise
    function isEmpty(CrossChainUser memory user) internal pure returns (bool) {
        return bytes(user.chain_uid).length == 0 || bytes(user.sender).length == 0;
    }

    function toNormalizedPacket(CrossChainUser memory user, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](2);
        normalized_packet[0] = NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "address"), user.sender);
        normalized_packet[1] = NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "chain_uid"), user.chain_uid);
        return normalized_packet;
    }

    function parseCrossChainUser(NormalizedPacketLib.HashedNormalizedPacket[] memory packet, string memory prefix)
        internal
        pure
        returns (CrossChainUser memory)
    {
        string memory chain_uid = packet.findKey(string.concat(prefix, ".chain_uid"));
        string memory user_address = packet.findKey(string.concat(prefix, ".address"));
        return CrossChainUser({ chain_uid: chain_uid, sender: user_address });
    }
}

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

pragma solidity ^0.8.20;

/**
 * @dev Helper library for emitting standardized panic codes.
 *
 * ```solidity
 * contract Example {
 *      using Panic for uint256;
 *
 *      // Use any of the declared internal constants
 *      function foo() { Panic.GENERIC.panic(); }
 *
 *      // Alternatively
 *      function foo() { Panic.panic(Panic.GENERIC); }
 * }
 * ```
 *
 * Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
 *
 * _Available since v5.1._
 */
// slither-disable-next-line unused-state
library Panic {
    /// @dev generic / unspecified error
    uint256 internal constant GENERIC = 0x00;
    /// @dev used by the assert() builtin
    uint256 internal constant ASSERT = 0x01;
    /// @dev arithmetic underflow or overflow
    uint256 internal constant UNDER_OVERFLOW = 0x11;
    /// @dev division or modulo by zero
    uint256 internal constant DIVISION_BY_ZERO = 0x12;
    /// @dev enum conversion error
    uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
    /// @dev invalid encoding in storage
    uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
    /// @dev empty array pop
    uint256 internal constant EMPTY_ARRAY_POP = 0x31;
    /// @dev array out of bounds access
    uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
    /// @dev resource error (too large allocation or too large array)
    uint256 internal constant RESOURCE_ERROR = 0x41;
    /// @dev calling invalid internal function
    uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;

    /// @dev Reverts with a panic code. Recommended to use with
    /// the internal constants with predefined codes.
    function panic(uint256 code) internal pure {
        assembly ("memory-safe") {
            mstore(0x00, 0x4e487b71)
            mstore(0x20, code)
            revert(0x1c, 0x24)
        }
    }
}

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

import { Strings } from "openzeppelin-contracts/contracts/utils/Strings.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { CallHelper } from "src/utils/CallHelper.lib.sol";
import { Modifiers } from "src/Factory/Modifiers.sol";
import { StringsUtil } from "src/utils/Strings.sol";

import { ICrossChainModule as IModule } from "./IModule.sol";
import { CrossChainModuleStorage as ModuleStorage } from "./ModuleStorage.sol";
import { RateLimitStorage } from "./RateLimitStorage.sol";
import { UserPacketsStorage } from "./UserPacketsStorage.sol";
import { PacketsStorage } from "./PacketsStorage.sol";

/// @title CrossChainModuleWrapper
/// @notice Wrapper contract for cross-chain module initialization and packet delegation
contract CrossChainModuleWrapper is IModule, Modifiers {
    using Strings for *;
    using StringsUtil for *;

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @notice Parameters for initializing the cross-chain module extension
    /// @param router_address The router address for the module
    /// @param chain_uid The chain UID for the module
    struct CrossChainModuleWrapperInitializeParams {
        string router_address;
        string chain_uid;
    }

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Initializes the cross-chain module extension with router and chain UID
    /// @param params The initialization parameters
    function __CrossChainModuleWrapper_init(
        address module_address,
        CrossChainModuleWrapperInitializeParams memory params
    ) internal {
        ModuleStorage.set_module_address(module_address);

        ModuleStorage.Layout storage module_state = ModuleStorage.mut_module_state();
        // Create hash of the vsl.router_address to create authorized port
        module_state.authorized_port = string.concat("vsl.", params.router_address);
        module_state.self_port =
            string.concat(string.concat(params.chain_uid, "."), address(this).toHexString().toLowerCase());
    }

    function getCrossChainModule() public view returns (address) {
        return ModuleStorage.get_module_address();
    }

    function updateCrossChainModule(address module_address) external onlyOwner {
        ModuleStorage.set_module_address(module_address);
    }

    /// @inheritdoc IModule
    function receivePacket(
        string calldata, /*source_port*/
        string calldata, /*destination_port*/
        NormalizedPacketLib.NormalizedPacket[] calldata, /*msg_*/
        uint256,
        /*sequence*/
        uint256 /*timeout*/
    ) external override onlyRelayer {
        address cross_chain_module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(cross_chain_module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    /// @inheritdoc IModule
    function acknowledgePacket(
        string calldata, /*source_port*/
        string calldata, /*destination_port*/
        NormalizedPacketLib.NormalizedPacket[] calldata, /*msg_*/
        uint256, /*packet_sequence*/
        NormalizedPacketLib.NormalizedPacket[] calldata /*acknowledgment*/
    ) external override onlyRelayer {
        address cross_chain_module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(cross_chain_module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    function get_router_port() public view returns (string memory) {
        return ModuleStorage.read_router_port();
    }

    function get_self_port() public view returns (string memory) {
        return ModuleStorage.read_self_port();
    }

    /// @notice Returns the global free limit for rate limited packets
    /// @return The free limit value
    function get_free_limit() external view returns (uint256) {
        return RateLimitStorage.mut_rate_limit().free_limit;
    }

    /// @notice Sets the global free limit for rate limited packets
    /// @param free_limit The new free limit value
    function set_free_limit(uint256 free_limit) external onlyOwner {
        RateLimitStorage.mut_rate_limit().free_limit = free_limit;
    }

    /// @notice Returns the custom free limit for a specific user, if set
    /// @param user The address of the user
    /// @return The user-specific free limit value
    function get_user_free_limit(address user) external view returns (uint256) {
        return RateLimitStorage.mut_rate_limit().user_free_limit[user];
    }

    /// @notice Sets the custom free limit for a specific user, if set
    /// @param user The address of the user
    /// @param free_limit The new free limit value
    function set_user_free_limit(address user, uint256 free_limit) external onlyOwner {
        RateLimitStorage.mut_rate_limit().user_free_limit[user] = free_limit;
    }

    /// @notice Returns the total number of packets ever sent by a user
    /// @param user The address of the user
    /// @return The total packet count
    function get_user_total_packets(address user) external view returns (uint256) {
        return UserPacketsStorage.mut_user_packets_state().user_total_packets[user];
    }

    /// @notice Returns the number of packets currently pending for a user
    /// @param user The address of the user
    /// @return The pending packet count
    function get_user_pending_packets(address user) external view returns (uint256) {
        return UserPacketsStorage.mut_user_packets_state().user_pending_packets_count[user];
    }

    /// @notice Returns the sender address of a packet by sequence number
    /// @param packet_sequence The sequence number of the packet
    /// @return The sender address
    function get_packet_sender(uint256 packet_sequence) external view returns (address) {
        return UserPacketsStorage.mut_user_packets_state().packet_sender[packet_sequence];
    }

    function packet_sent_height(uint256 packet_sequence) external view returns (uint256) {
        return PacketsStorage.mut_packets_state().pending_send_packets[packet_sequence];
    }

    function packet_received_height(uint256 packet_sequence) external view returns (uint256) {
        return PacketsStorage.mut_packets_state().processed_received_packets[packet_sequence];
    }

    function current_packet_sequence() external view returns (uint256) {
        return PacketsStorage.mut_packets_state().curr_packet_sequence;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (proxy/ERC1967/ERC1967Utils.sol)

pragma solidity ^0.8.21;

import {IBeacon} from "../beacon/IBeacon.sol";
import {IERC1967} from "../../interfaces/IERC1967.sol";
import {Address} from "../../utils/Address.sol";
import {StorageSlot} from "../../utils/StorageSlot.sol";

/**
 * @dev This library provides getters and event emitting update functions for
 * https://eips.ethereum.org/EIPS/eip-1967[ERC-1967] slots.
 */
library ERC1967Utils {
    /**
     * @dev Storage slot with the address of the current implementation.
     * This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1.
     */
    // solhint-disable-next-line private-vars-leading-underscore
    bytes32 internal constant IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;

    /**
     * @dev The `implementation` of the proxy is invalid.
     */
    error ERC1967InvalidImplementation(address implementation);

    /**
     * @dev The `admin` of the proxy is invalid.
     */
    error ERC1967InvalidAdmin(address admin);

    /**
     * @dev The `beacon` of the proxy is invalid.
     */
    error ERC1967InvalidBeacon(address beacon);

    /**
     * @dev An upgrade function sees `msg.value > 0` that may be lost.
     */
    error ERC1967NonPayable();

    /**
     * @dev Returns the current implementation address.
     */
    function getImplementation() internal view returns (address) {
        return StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value;
    }

    /**
     * @dev Stores a new address in the ERC-1967 implementation slot.
     */
    function _setImplementation(address newImplementation) private {
        if (newImplementation.code.length == 0) {
            revert ERC1967InvalidImplementation(newImplementation);
        }
        StorageSlot.getAddressSlot(IMPLEMENTATION_SLOT).value = newImplementation;
    }

    /**
     * @dev Performs implementation upgrade with additional setup call if data is nonempty.
     * This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
     * to avoid stuck value in the contract.
     *
     * Emits an {IERC1967-Upgraded} event.
     */
    function upgradeToAndCall(address newImplementation, bytes memory data) internal {
        _setImplementation(newImplementation);
        emit IERC1967.Upgraded(newImplementation);

        if (data.length > 0) {
            Address.functionDelegateCall(newImplementation, data);
        } else {
            _checkNonPayable();
        }
    }

    /**
     * @dev Storage slot with the admin of the contract.
     * This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1.
     */
    // solhint-disable-next-line private-vars-leading-underscore
    bytes32 internal constant ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;

    /**
     * @dev Returns the current admin.
     *
     * TIP: To get this value clients can read directly from the storage slot shown below (specified by ERC-1967) using
     * the https://ethereum.org/developers/docs/apis/json-rpc/#eth_getstorageat[`eth_getStorageAt`] RPC call.
     * `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103`
     */
    function getAdmin() internal view returns (address) {
        return StorageSlot.getAddressSlot(ADMIN_SLOT).value;
    }

    /**
     * @dev Stores a new address in the ERC-1967 admin slot.
     */
    function _setAdmin(address newAdmin) private {
        if (newAdmin == address(0)) {
            revert ERC1967InvalidAdmin(address(0));
        }
        StorageSlot.getAddressSlot(ADMIN_SLOT).value = newAdmin;
    }

    /**
     * @dev Changes the admin of the proxy.
     *
     * Emits an {IERC1967-AdminChanged} event.
     */
    function changeAdmin(address newAdmin) internal {
        emit IERC1967.AdminChanged(getAdmin(), newAdmin);
        _setAdmin(newAdmin);
    }

    /**
     * @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
     * This is the keccak-256 hash of "eip1967.proxy.beacon" subtracted by 1.
     */
    // solhint-disable-next-line private-vars-leading-underscore
    bytes32 internal constant BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;

    /**
     * @dev Returns the current beacon.
     */
    function getBeacon() internal view returns (address) {
        return StorageSlot.getAddressSlot(BEACON_SLOT).value;
    }

    /**
     * @dev Stores a new beacon in the ERC-1967 beacon slot.
     */
    function _setBeacon(address newBeacon) private {
        if (newBeacon.code.length == 0) {
            revert ERC1967InvalidBeacon(newBeacon);
        }

        StorageSlot.getAddressSlot(BEACON_SLOT).value = newBeacon;

        address beaconImplementation = IBeacon(newBeacon).implementation();
        if (beaconImplementation.code.length == 0) {
            revert ERC1967InvalidImplementation(beaconImplementation);
        }
    }

    /**
     * @dev Change the beacon and trigger a setup call if data is nonempty.
     * This function is payable only if the setup call is performed, otherwise `msg.value` is rejected
     * to avoid stuck value in the contract.
     *
     * Emits an {IERC1967-BeaconUpgraded} event.
     *
     * CAUTION: Invoking this function has no effect on an instance of {BeaconProxy} since v5, since
     * it uses an immutable beacon without looking at the value of the ERC-1967 beacon slot for
     * efficiency.
     */
    function upgradeBeaconToAndCall(address newBeacon, bytes memory data) internal {
        _setBeacon(newBeacon);
        emit IERC1967.BeaconUpgraded(newBeacon);

        if (data.length > 0) {
            Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data);
        } else {
            _checkNonPayable();
        }
    }

    /**
     * @dev Reverts if `msg.value` is not zero. It can be used to avoid `msg.value` stuck in the contract
     * if an upgrade doesn't perform an initialization call.
     */
    function _checkNonPayable() private {
        if (msg.value > 0) {
            revert ERC1967NonPayable();
        }
    }
}

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

/// @title UserPacketsStorage
/// @notice Library for managing user packet state in cross-chain modules
library UserPacketsStorage {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @notice Layout for user packet state
    /// @param user_total_packets All packets sent by an address
    /// @param user_pending_packets_count Packets currently in processing for an address
    /// @param packet_sender Mapping from packet sequence to sender address
    struct Layout {
        mapping(address => uint256) user_total_packets;
        mapping(address => uint256) user_pending_packets_count;
        mapping(uint256 => address) packet_sender;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    string private constant _NAMESPACE = "euclid.storage.factory.modules.cross_chain.user_packets";
    string private constant _VERSION = "0.1.0";
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Returns the storage layout for user packets
    /// @return l The storage layout
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    /// @notice Returns the version string
    /// @return The version string
    function version() internal pure returns (string memory) {
        return _VERSION;
    }

    /// @notice Returns the namespace string
    /// @return The namespace string
    function namespace() internal pure returns (string memory) {
        return _NAMESPACE;
    }

    /// @notice Returns a mutable reference to the user packets state
    /// @return l The user packets state storage reference
    function mut_user_packets_state() internal pure returns (Layout storage l) {
        Layout storage s = _layout();
        return s;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/utils/UUPSUpgradeable.sol)

pragma solidity ^0.8.22;

import {IERC1822Proxiable} from "@openzeppelin/contracts/interfaces/draft-IERC1822.sol";
import {ERC1967Utils} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Utils.sol";
import {Initializable} from "./Initializable.sol";

/**
 * @dev An upgradeability mechanism designed for UUPS proxies. The functions included here can perform an upgrade of an
 * {ERC1967Proxy}, when this contract is set as the implementation behind such a proxy.
 *
 * A security mechanism ensures that an upgrade does not turn off upgradeability accidentally, although this risk is
 * reinstated if the upgrade retains upgradeability but removes the security mechanism, e.g. by replacing
 * `UUPSUpgradeable` with a custom implementation of upgrades.
 *
 * The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.
 */
abstract contract UUPSUpgradeable is Initializable, IERC1822Proxiable {
    /// @custom:oz-upgrades-unsafe-allow state-variable-immutable
    address private immutable __self = address(this);

    /**
     * @dev The version of the upgrade interface of the contract. If this getter is missing, both `upgradeTo(address)`
     * and `upgradeToAndCall(address,bytes)` are present, and `upgradeTo` must be used if no function should be called,
     * while `upgradeToAndCall` will invoke the `receive` function if the second argument is the empty byte string.
     * If the getter returns `"5.0.0"`, only `upgradeToAndCall(address,bytes)` is present, and the second argument must
     * be the empty byte string if no function should be called, making it impossible to invoke the `receive` function
     * during an upgrade.
     */
    string public constant UPGRADE_INTERFACE_VERSION = "5.0.0";

    /**
     * @dev The call is from an unauthorized context.
     */
    error UUPSUnauthorizedCallContext();

    /**
     * @dev The storage `slot` is unsupported as a UUID.
     */
    error UUPSUnsupportedProxiableUUID(bytes32 slot);

    /**
     * @dev Check that the execution is being performed through a delegatecall call and that the execution context is
     * a proxy contract with an implementation (as defined in ERC-1967) pointing to self. This should only be the case
     * for UUPS and transparent proxies that are using the current contract as their implementation. Execution of a
     * function through ERC-1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to
     * fail.
     */
    modifier onlyProxy() {
        _checkProxy();
        _;
    }

    /**
     * @dev Check that the execution is not being performed through a delegate call. This allows a function to be
     * callable on the implementing contract but not through proxies.
     */
    modifier notDelegated() {
        _checkNotDelegated();
        _;
    }

    function __UUPSUpgradeable_init() internal onlyInitializing {
    }

    function __UUPSUpgradeable_init_unchained() internal onlyInitializing {
    }
    /**
     * @dev Implementation of the ERC-1822 {proxiableUUID} function. This returns the storage slot used by the
     * implementation. It is used to validate the implementation's compatibility when performing an upgrade.
     *
     * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
     * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
     * function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier.
     */
    function proxiableUUID() external view virtual notDelegated returns (bytes32) {
        return ERC1967Utils.IMPLEMENTATION_SLOT;
    }

    /**
     * @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call
     * encoded in `data`.
     *
     * Calls {_authorizeUpgrade}.
     *
     * Emits an {Upgraded} event.
     *
     * @custom:oz-upgrades-unsafe-allow-reachable delegatecall
     */
    function upgradeToAndCall(address newImplementation, bytes memory data) public payable virtual onlyProxy {
        _authorizeUpgrade(newImplementation);
        _upgradeToAndCallUUPS(newImplementation, data);
    }

    /**
     * @dev Reverts if the execution is not performed via delegatecall or the execution
     * context is not of a proxy with an ERC-1967 compliant implementation pointing to self.
     * See {_onlyProxy}.
     */
    function _checkProxy() internal view virtual {
        if (
            address(this) == __self || // Must be called through delegatecall
            ERC1967Utils.getImplementation() != __self // Must be called through an active proxy
        ) {
            revert UUPSUnauthorizedCallContext();
        }
    }

    /**
     * @dev Reverts if the execution is performed via delegatecall.
     * See {notDelegated}.
     */
    function _checkNotDelegated() internal view virtual {
        if (address(this) != __self) {
            // Must not be called through delegatecall
            revert UUPSUnauthorizedCallContext();
        }
    }

    /**
     * @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by
     * {upgradeToAndCall}.
     *
     * Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.
     *
     * ```solidity
     * function _authorizeUpgrade(address) internal onlyOwner {}
     * ```
     */
    function _authorizeUpgrade(address newImplementation) internal virtual;

    /**
     * @dev Performs an implementation upgrade with a security check for UUPS proxies, and additional setup call.
     *
     * As a security check, {proxiableUUID} is invoked in the new implementation, and the return value
     * is expected to be the implementation slot in ERC-1967.
     *
     * Emits an {IERC1967-Upgraded} event.
     */
    function _upgradeToAndCallUUPS(address newImplementation, bytes memory data) private {
        try IERC1822Proxiable(newImplementation).proxiableUUID() returns (bytes32 slot) {
            if (slot != ERC1967Utils.IMPLEMENTATION_SLOT) {
                revert UUPSUnsupportedProxiableUUID(slot);
            }
            ERC1967Utils.upgradeToAndCall(newImplementation, data);
        } catch {
            // The implementation is not UUPS
            revert ERC1967Utils.ERC1967InvalidImplementation(newImplementation);
        }
    }
}

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

// Internal imports
import { Modifiers } from "src/Factory/Modifiers.sol";
import { CallHelper } from "src/utils/CallHelper.lib.sol";
import { TokenLib } from "src/types/Token.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { RecipientLibrary } from "src/types/Recipient.sol";
import { CrossChainConfigLibrary } from "src/types/CrossChainConfig.sol";
// Module-specific imports
import { ISwapModule as IModule } from "./IModule.sol";
import { SwapModuleStorage as ModuleStorage } from "./ModuleStorage.sol";

/**
 * @title SwapModuleWrapper
 * @notice Wrapper contract for swap module initialization and management
 * @dev This contract provides the interface for managing the swap module,
 *      including initialization and module address updates. It acts as a
 *      proxy to the actual swap module implementation.
 * @author Euclid Protocol
 */
contract SwapModuleWrapper is IModule, Modifiers {
    // -------------------------------------------------------------------------
    // Initialization
    // -------------------------------------------------------------------------

    /**
     * @notice Initializes the swap module wrapper with the module address
     * @dev This function should be called during contract initialization
     * @param module_address The address of the swap module implementation
     */
    function __SwapModuleWrapper_init(address module_address) internal {
        ModuleStorage.set_module_address(module_address);
    }

    // -------------------------------------------------------------------------
    // Module Management
    // -------------------------------------------------------------------------

    /**
     * @notice Gets the current swap module implementation address
     * @return The address of the swap module implementation
     */
    function getSwapModule() public view returns (address) {
        return ModuleStorage.get_module_address();
    }

    /**
     * @notice Updates the swap module implementation address
     * @dev Only callable by the contract owner
     * @param module_address The new address of the swap module implementation
     *
     * @custom:requirements
     * - Caller must be the contract owner
     * - `module_address` must not be the zero address
     */
    function updateSwapModule(address module_address) external onlyOwner {
        ModuleStorage.set_module_address(module_address);
    }

    // -------------------------------------------------------------------------
    // Module Interface Delegation
    // -------------------------------------------------------------------------

    /**
     * @inheritdoc IModule
     */
    function swap(
        TokenLib.TokenWithDenom calldata,
        /*asset_in*/
        uint256,
        /*amount_in*/
        string calldata,
        /*asset_out*/
        uint256,
        /*min_amount_out*/
        NextSwapPair[] calldata,
        /*swaps*/
        RecipientLibrary.Recipient[] memory,
        /*recipients*/
        PartnerFee memory,
        /*partner_fee*/
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    ) external payable override {
        address swap_module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(swap_module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    /**
     * @inheritdoc IModule
     */
    function acknowledge_swap(
        uint256,
        /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata,
        /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external pure {
        revert("Direct Call Not Allowed");
    }
}

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

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

// Internal imports
import { StringsUtil } from "src/utils/Strings.sol";
import { TokenLib } from "./Token.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { ContractError } from "src/types/Error.sol";

/**
 * @title PoolLib
 * @notice Library for pool-related functionality and validation
 * @dev This library provides comprehensive pool handling capabilities including
 *      validation, type checking, and conversion between different pool formats.
 *      Supports stable pools and constant product (CP) pools.
 * @author Euclid Protocol
 */
library PoolLib {
    // -------------------------------------------------------------------------
    // Libraries
    // -------------------------------------------------------------------------
    using Strings for *;
    using StringsUtil for *;
    using PoolLib for *;
    using NormalizedPacketLib for *;
    using TokenLib for *;

    // -------------------------------------------------------------------------
    // Errors
    // -------------------------------------------------------------------------

    /// @notice Thrown when pool configuration is invalid
    error InvalidPoolConfig();
    error InvalidCharacter(bytes1 character);

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------

    /// @notice Hash of "stable" used to identify stable pools
    string public constant STABLE_POOL_LITERAL = "stable";

    /// @notice Hash of "cp" used to identify constant product pools
    string public constant CP_POOL_LITERAL = "cp";

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /**
     * @notice Represents a token pair for pool operations
     * @param token_1 The first token in the pair
     * @param token_2 The second token in the pair
     */
    struct Pair {
        string token_1;
        string token_2;
    }

    /**
     * @notice Represents a token pair with denomination and amount information
     * @param token_1 The first token with amount and denomination
     * @param token_2 The second token with amount and denomination
     */
    struct PairWithDenomAndAmount {
        TokenLib.TokenWithDenomAndAmount token_1;
        TokenLib.TokenWithDenomAndAmount token_2;
    }

    /**
     * @notice Represents the configuration for a pool
     * @param pool_type The type of pool (stable or constant product)
     * @param amp_factor The amplification factor for stable pools
     */
    struct PoolConfig {
        string pool_type;
        uint256 amp_factor;
    }

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------

    /// @notice Returns the two tokens from the provided pair as a fixed-size array of length 2
    /// @param pair The pair containing two tokens with denomination and amount
    /// @return arr Array containing the two tokens from the pair
    function getVecTokenInfo(PairWithDenomAndAmount memory pair)
        internal
        pure
        returns (TokenLib.TokenWithDenomAndAmount[] memory arr)
    {
        arr = new TokenLib.TokenWithDenomAndAmount[](2);
        arr[0] = pair.token_1;
        arr[1] = pair.token_2;
        return arr;
    }

    /// @notice Returns the two token IDs from the provided pair as a fixed-size array of length 2
    /// @param pair The pair containing two token IDs
    /// @return arr Array containing the two token IDs from the pair
    function getVecPair(Pair memory pair) internal pure returns (string[2] memory arr) {
        arr[0] = pair.token_1;
        arr[1] = pair.token_2;
    }

    /// @notice Converts a token pair with denomination and amount to a pair
    /// @param pair The token pair with denomination and amount
    /// @return The token pair
    function toPair(PairWithDenomAndAmount memory pair) internal pure returns (Pair memory) {
        return Pair({ token_1: pair.token_1.token, token_2: pair.token_2.token });
    }

    function validate(Pair memory pair) internal pure returns (bool) {
        return validate(pair, false);
    }

    function validate(Pair memory pair, bool revert_on_error) internal pure returns (bool) {
        // Validate token ids
        if (!pair.token_1.validateTokenId(revert_on_error) || !pair.token_2.validateTokenId(revert_on_error)) {
            return false;
        }

        // Validate token order is lexicographically sorted in ascending order
        if (pair.token_1.compare(pair.token_2) != -1) {
            if (revert_on_error) {
                revert TokenLib.InvalidPairOrder();
            }
            return false;
        }

        return true;
    }

    function to_key(Pair memory pair) internal pure returns (string memory) {
        return string.concat(pair.token_1, ":", pair.token_2);
    }

    function to_key(PairWithDenomAndAmount memory pair_with_denom_and_amount) internal pure returns (string memory) {
        return pair_with_denom_and_amount.toPair().to_key();
    }

    function validate(PairWithDenomAndAmount memory pair_with_denom_and_amount) internal pure returns (bool) {
        return validate(pair_with_denom_and_amount, false);
    }

    function validate(PairWithDenomAndAmount memory pair_with_denom_and_amount, bool revert_on_error)
        internal
        pure
        returns (bool)
    {
        if (
            !pair_with_denom_and_amount.token_1.token_type.validate(revert_on_error)
                || !pair_with_denom_and_amount.token_2.token_type.validate(revert_on_error)
        ) {
            if (revert_on_error) {
                revert TokenLib.InvalidTokenType();
            }
            return false;
        }
        return pair_with_denom_and_amount.toPair().validate(revert_on_error);
    }

    /// @notice Checks if a token type is empty
    /// @param pool_config The pool config to check
    /// @return True if token type is empty
    function isPoolConfigEmpty(PoolConfig memory pool_config) internal pure returns (bool) {
        return bytes(pool_config.pool_type).length == 0;
    }

    /// @notice Checks if a token is a voucher type
    /// @param pool_config The pool config to check
    /// @return True if token is voucher type
    function isStable(PoolConfig memory pool_config) internal pure returns (bool) {
        return pool_config.pool_type.equal(STABLE_POOL_LITERAL);
    }

    /// @notice Checks if a token is a smart type
    /// @param pool_config The pool config to check
    /// @return True if token is smart type
    function isCP(PoolConfig memory pool_config) internal pure returns (bool) {
        return pool_config.pool_type.equal(CP_POOL_LITERAL);
    }

    function validate(PoolConfig memory pool_config) internal pure returns (bool) {
        if (pool_config.isPoolConfigEmpty()) {
            return false;
        }
        if (pool_config.isStable()) {
            return validateStablePoolConfig(pool_config);
        } else if (pool_config.isCP()) {
            return validateCPPoolConfig(pool_config);
        } else {
            return false;
        }
    }

    function validateStablePoolConfig(PoolConfig memory pool_config) internal pure returns (bool) {
        if (!pool_config.isStable()) {
            return false;
        }
        return true;
    }

    function validateCPPoolConfig(PoolConfig memory pool_config) internal pure returns (bool) {
        if (!pool_config.isCP()) {
            return false;
        }
        return true;
    }

    function toNormalizedPacket(PoolConfig memory pool_config, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](1);
        if (pool_config.isCP()) {
            normalized_packet[0] = NormalizedPacketLib.NormalizedPacket(
                string.concat(prefix, "constant_product"), NormalizedPacketLib.EMPTY_OBJECT
            );
        } else if (pool_config.isStable()) {
            normalized_packet[0] = NormalizedPacketLib.NormalizedPacket(
                string.concat(prefix, "stable.amp_factor"), pool_config.amp_factor.toString()
            );
        }
        return normalized_packet;
    }

    function toNormalizedPacket(Pair memory pair, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](2);
        normalized_packet[0] = NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "token_1"), pair.token_1);
        normalized_packet[1] = NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "token_2"), pair.token_2);
        return normalized_packet;
    }

    function toNormalizedPacket(PairWithDenomAndAmount memory pair_with_denom_and_amount, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](0);

        normalized_packet = normalized_packet.concat(
            pair_with_denom_and_amount.token_1.toNormalizedPacket(string.concat(prefix, "token_1."))
        );
        normalized_packet = normalized_packet.concat(
            pair_with_denom_and_amount.token_2.toNormalizedPacket(string.concat(prefix, "token_2."))
        );
        return normalized_packet;
    }

    function validateLpName(string memory lp_name) internal pure returns (bool) {
        return validateLpName(lp_name, false);
    }

    function validateLpName(string memory lp_name, bool revert_on_error) internal pure returns (bool) {
        uint256 length = bytes(lp_name).length;
        if (length < 3) {
            if (revert_on_error) {
                revert ContractError("LP name should be at least 3 characters long");
            }
            return false;
        }

        if (length > 50) {
            if (revert_on_error) {
                revert ContractError("LP name should be at most 50 characters long");
            }
            return false;
        }

        return true;
    }

    function validateLpSymbol(string memory lp_symbol) internal pure returns (bool) {
        return validateLpSymbol(lp_symbol, false);
    }

    /**
     * @notice Validates the liquidity pool (LP) symbol according to the protocol's requirements.
     * @dev
     *  Performs basic validation on a candidate LP symbol string. The following constraints apply:
     *  - The symbol must be at least 3 characters long.
     *  - The symbol must be no greater than 12 characters, and will revert if it exceeds 10 characters when revert_on_error is true.
     *  - Only uppercase and lowercase ASCII letters (A-Z, a-z) and the hyphen '-' (0x2d) are allowed.
     *  - If an invalid symbol is detected, the function either returns false or (if `revert_on_error` is true)
     *    reverts with a descriptive ContractError.
     * @param lp_symbol The symbol string to validate.
     * @return bool True if valid, otherwise false (or reverts if requested).
     */
    function validateLpSymbol(string memory lp_symbol, bool revert_on_error) internal pure returns (bool) {
        uint256 length = bytes(lp_symbol).length;
        if (length < 3) {
            if (revert_on_error) {
                revert ContractError("LP symbol should be at least 3 characters long");
            }
            return false;
        }

        if (length > 12) {
            if (revert_on_error) {
                revert ContractError("LP symbol should be at most 10 characters long");
            }
            return false;
        }

        for (uint256 i = 0; i < length; ++i) {
            bytes1 b = bytes(lp_symbol)[i];
            if (
                (b != 0x2d) // not '-'
                    && (b < 0x41 || b > 0x5a) // not 'A'-'Z'
                    && (b < 0x61 || b > 0x7a) // not 'a'-'z'
            ) {
                if (revert_on_error) {
                    revert InvalidCharacter(b);
                }
                return false;
            }
        }
        return true;
    }

    function validateLpDecimals(uint8 lp_decimals) internal pure returns (bool) {
        return validateLpDecimals(lp_decimals, false);
    }

    function validateLpDecimals(uint8 lp_decimals, bool revert_on_error) internal pure returns (bool) {
        if (lp_decimals > 18) {
            if (revert_on_error) {
                revert ContractError("LP decimals must be less than or equal to 18");
            }
            return false;
        }
        return true;
    }
}

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

library CallHelper {
    function delegatecall(address target, bytes memory data) internal returns (bytes memory) {
        (bool success, bytes memory response) = target.delegatecall(data);
        if (!success) {
            _bubbleUpRevertReason(response);
        }
        return response;
    }

    function staticcall(address target, bytes memory data) internal view returns (bytes memory) {
        (bool success, bytes memory response) = target.staticcall(data);
        if (!success) {
            _bubbleUpRevertReason(response);
        }
        return response;
    }

    function call(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
        (bool success, bytes memory response) = target.call{ value: value }(data);
        if (!success) {
            _bubbleUpRevertReason(response);
        }
        return response;
    }

    function _bubbleUpRevertReason(bytes memory response) internal pure {
        revert(string(response));
    }
}

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

// Internal imports
import { PoolLib } from "src/types/Pool.sol";
import { CrossChainUserLibrary } from "src/types/CrossChainUser.sol";
import { CrossChainConfigLibrary } from "src/types/CrossChainConfig.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";

/**
 * @title IPoolModule
 * @notice Interface for the Pool module functionality
 * @dev This interface defines the contract for handling pool operations including
 *      creation, liquidity management, and removal operations.
 * @author Euclid Protocol
 */
interface IPoolModule {
    error InsufficientFunds();
    error SlippageToleranceBpsOutOfRange();

    event PoolCreationError(string indexed tx_id);
    event PoolCreationSuccess(string indexed tx_id);

    event AddLiquidityError(string indexed tx_id);
    event AddLiquiditySuccess(string indexed tx_id);

    event RemoveLiquidityError(string indexed tx_id);
    event RemoveLiquiditySuccess(string indexed tx_id);

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Requests the creation of a new pool
     * @dev Only callable by the relayer
     * @param pair_with_denom_and_amount The token pair with amounts for the pool
     * @param pool_config The configuration for the pool
     * @param lp_token_name The name for the LP token
     * @param lp_token_symbol The symbol for the LP token
     * @param lp_token_decimals The decimals for the LP token
     * @param slippage_tolerance_bps The slippage tolerance in basis points
     * @param cross_chain_config The cross-chain configuration
     */
    function request_pool_creation(
        PoolLib.PairWithDenomAndAmount calldata pair_with_denom_and_amount,
        PoolLib.PoolConfig calldata pool_config,
        string calldata lp_token_name,
        string memory lp_token_symbol,
        uint8 lp_token_decimals,
        uint64 slippage_tolerance_bps,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /**
     * @notice Acknowledge the creation of a new pool
     * @dev Only callable by the relayer
     * @param sequence The sequence number of the packet
     * @param hashed_msg The hashed message
     * @param hashed_acknowledgment The hashed acknowledgment
     */
    function acknowledge_pool_creation(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;

    /**
     * @notice Adds liquidity to an existing pool
     * @dev Only callable by the relayer
     * @param pair_with_denom_and_amount The token pair with amounts to add
     * @param slippage_tolerance_bps The slippage tolerance in basis points
     * @param cross_chain_config The cross-chain configuration
     */
    function add_liquidity(
        PoolLib.PairWithDenomAndAmount calldata pair_with_denom_and_amount,
        uint64 slippage_tolerance_bps,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /**
     * @notice Acknowledge the addition of liquidity to a pool
     * @dev Only callable by the relayer
     * @param sequence The sequence number of the packet
     * @param hashed_msg The hashed message
     * @param hashed_acknowledgment The hashed acknowledgment
     */
    function acknowledge_add_liquidity(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;

    /**
     * @notice Removes liquidity from a pool
     * @dev Only callable by the relayer
     * @param pair The token pair for the pool
     * @param lp_allocation The amount of LP tokens to remove
     * @param cross_chain_config The cross-chain configuration
     */
    function remove_liquidity(
        PoolLib.Pair calldata pair,
        uint256 lp_allocation,
        CrossChainUserLibrary.CrossChainUser memory recipient,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /**
     * @notice Acknowledge the removal of liquidity from a pool
     * @dev Only callable by the relayer
     * @param sequence The sequence number of the packet
     * @param hashed_msg The hashed message
     * @param hashed_acknowledgment The hashed acknowledgment
     */
    function acknowledge_remove_liquidity(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;
}

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

/// @title RateLimitStorage
/// @notice Library for managing rate limit fee configuration and storage
library RateLimitStorage {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /// @custom:storage-location erc7201:euclid.storage.factory.modules.cross_chain.rate_limit
    /// @notice Layout for rate limit configuration
    /// @param free_limit The number of free transactions (packets below this are free)
    /// @param user_free_limit Mapping of user addresses to their custom free limits
    struct Layout {
        uint256 free_limit;
        mapping(address => uint256) user_free_limit;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    string private constant _NAMESPACE = "euclid.storage.factory.modules.cross_chain.rate_limit";
    string private constant _VERSION = "0.1.0";
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Returns the storage layout for rate limit
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    /// @notice Returns the version string
    function version() internal pure returns (string memory) {
        return _VERSION;
    }

    /// @notice Returns the namespace string
    function namespace() internal pure returns (string memory) {
        return _NAMESPACE;
    }

    /// @return l The rate limit layout
    function mut_rate_limit() internal pure returns (Layout storage l) {
        Layout storage s = _layout();
        return s;
    }
}

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

import { Strings } from "openzeppelin-contracts/contracts/utils/Strings.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { StringsUtil } from "src/utils/Strings.sol";
import { ContractError } from "src/types/Error.sol";

/// @title LimitLibrary
/// @notice Library for handling limit identity and string utilities
library LimitLibrary {
    using Strings for *;
    using StringsUtil for *;
    using NormalizedPacketLib for *;
    using LimitLibrary for *;

    // -------------------------------------------------------------------------
    // Errors
    // -------------------------------------------------------------------------
    /// @notice Error thrown when an invalid limit type is provided

    error InvalidLimitType();

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    /// @notice "less_than_or_equal" for comparison operators
    string public constant LESS_THAN_OR_EQUAL = "less_than_or_equal";
    /// @notice "equal" for comparison operators
    string public constant EQUAL = "equal";
    /// @notice "greater_than_or_equal" for comparison operators
    string public constant GREATER_THAN_OR_EQUAL = "greater_than_or_equal";
    /// @notice "dynamic" for comparison operators
    string public constant DYNAMIC = "dynamic";

    /// @notice Struct representing a limit
    /// @param limit_type The type of limit
    /// @param value The value of the limit
    struct Limit {
        string limit_type;
        uint256 value;
    }

    function toEqualLimit(uint256 value) internal pure returns (Limit memory) {
        return Limit({ limit_type: EQUAL, value: value });
    }

    function toLessThanOrEqualLimit(uint256 value) internal pure returns (Limit memory) {
        return Limit({ limit_type: LESS_THAN_OR_EQUAL, value: value });
    }

    function toGreaterThanOrEqualLimit(uint256 value) internal pure returns (Limit memory) {
        return Limit({ limit_type: GREATER_THAN_OR_EQUAL, value: value });
    }

    function toDynamicLimit() internal pure returns (Limit memory) {
        return Limit({ limit_type: DYNAMIC, value: 0 });
    }

    function toNullLimit() internal pure returns (Limit memory) {
        return Limit({ limit_type: "", value: 0 });
    }

    function isEqualLimit(Limit memory limit) internal pure returns (bool) {
        return limit.limit_type.equal(EQUAL);
    }

    function isLessThanOrEqualLimit(Limit memory limit) internal pure returns (bool) {
        return limit.limit_type.equal(LESS_THAN_OR_EQUAL);
    }

    function isGreaterThanOrEqualLimit(Limit memory limit) internal pure returns (bool) {
        return limit.limit_type.equal(GREATER_THAN_OR_EQUAL);
    }

    function isDynamicLimit(Limit memory limit) internal pure returns (bool) {
        return limit.limit_type.equal(DYNAMIC);
    }

    function isNullLimit(Limit memory limit) internal pure returns (bool) {
        return limit.limit_type.equal("");
    }

    /// @notice Validates an equal limit.
    /// @dev The limit value should be greater than zero
    /// @param limit The limit to validate
    /// @param revert_on_error Whether to revert on error
    /// @return True if the limit is valid
    function validateEqualLimit(Limit memory limit, bool revert_on_error) internal pure returns (bool) {
        if (limit.value > 0) {
            return true;
        }
        if (revert_on_error) {
            revert ContractError("Invalid equal limit. Limit value should be greater than zero");
        }
        return false;
    }

    /// @notice Validates a less than or equal limit.
    /// @dev The limit value should be greater than zero
    /// @param limit The limit to validate
    /// @param revert_on_error Whether to revert on error
    /// @return True if the limit is valid
    function validateLessThanOrEqualLimit(Limit memory limit, bool revert_on_error) internal pure returns (bool) {
        if (limit.value > 0) {
            return true;
        }
        if (revert_on_error) {
            revert ContractError("Invalid less than or equal limit. Limit value should be greater than zero");
        }
        return false;
    }

    /// @notice Validates a greater than or equal limit.
    /// @dev The limit value should be greater than zero
    /// @return True if the limit is valid
    function validateGreaterThanOrEqualLimit(
        Limit memory,
        /*limit*/
        bool /*revert_on_error*/
    )
        internal
        pure
        returns (bool)
    {
        return true;
    }

    /// @notice Validates a dynamic limit.
    /// @dev The limit value should be zero
    /// @param limit The limit to validate
    /// @param revert_on_error Whether to revert on error
    /// @return True if the limit is valid
    function validateDynamicLimit(Limit memory limit, bool revert_on_error) internal pure returns (bool) {
        if (limit.value == 0) {
            return true;
        }
        if (revert_on_error) {
            revert ContractError("Invalid dynamic limit. Limit value should be zero");
        }
        return false;
    }

    function validateNullLimit(Limit memory limit, bool revert_on_error) internal pure returns (bool) {
        if (limit.value == 0) {
            return true;
        }
        if (revert_on_error) {
            revert ContractError("Invalid null limit. Limit value should be zero");
        }
        return false;
    }

    function validate(Limit memory limit, bool revert_on_error) internal pure returns (bool) {
        if (limit.isNullLimit() && limit.validateNullLimit(false)) {
            return true;
        }
        if (limit.isEqualLimit() && limit.validateEqualLimit(false)) {
            return true;
        }
        if (limit.isLessThanOrEqualLimit() && limit.validateLessThanOrEqualLimit(false)) {
            return true;
        }
        if (limit.isGreaterThanOrEqualLimit() && limit.validateGreaterThanOrEqualLimit(false)) {
            return true;
        }
        if (limit.isDynamicLimit() && limit.validateDynamicLimit(false)) {
            return true;
        }
        if (revert_on_error) {
            revert InvalidLimitType();
        }
        return false;
    }

    function toNormalizedPacket(Limit memory limit, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        if (limit.isNullLimit()) {
            return new NormalizedPacketLib.NormalizedPacket[](0);
        }
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](1);
        normalized_packet[0] =
            NormalizedPacketLib.NormalizedPacket(string.concat(prefix, limit.limit_type), limit.value.toString());
        return normalized_packet;
    }

    function parseLimit(NormalizedPacketLib.HashedNormalizedPacket[] memory packet, string memory prefix)
        internal
        pure
        returns (Limit memory)
    {
        int256 less_than_or_equal_index = packet.findKeyIndex(string.concat(prefix, ".less_than_or_equal"));
        if (less_than_or_equal_index != -1) {
            string memory value = packet[uint256(less_than_or_equal_index)].value;
            /// forge-lint: disable-line(unsafe-typecast)
            return Limit({ limit_type: LESS_THAN_OR_EQUAL, value: Strings.parseUint(value) });
        }
        int256 equal_index = packet.findKeyIndex(string.concat(prefix, ".equal"));
        if (equal_index != -1) {
            string memory value = packet[uint256(equal_index)].value;
            /// forge-lint: disable-line(unsafe-typecast)
            return Limit({ limit_type: EQUAL, value: Strings.parseUint(value) });
        }
        int256 greater_than_or_equal_index = packet.findKeyIndex(string.concat(prefix, ".greater_than_or_equal"));
        if (greater_than_or_equal_index != -1) {
            string memory value = packet[uint256(greater_than_or_equal_index)].value;
            /// forge-lint: disable-line(unsafe-typecast)
            return Limit({ limit_type: GREATER_THAN_OR_EQUAL, value: Strings.parseUint(value) });
        }
        int256 dynamic_index = packet.findKeyIndex(string.concat(prefix, ".dynamic"));
        if (dynamic_index != -1) {
            string memory value = packet[uint256(dynamic_index)].value;
            /// forge-lint: disable-line(unsafe-typecast)
            return Limit({ limit_type: DYNAMIC, value: Strings.parseUint(value) });
        }
        return toNullLimit();
    }
}

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

import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";

/// @title EuclidReceiveLib
/// @notice Library for euclid receive.
library EuclidReceiveLib {
    using NormalizedPacketLib for *;

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @notice Struct representing a normalized packet key-value pair
    /// @param data The data for the euclid receive
    /// @param meta The meta for the euclid receive

    struct EuclidReceive {
        bytes data;
    }

    function toNormalizedPacket(EuclidReceive memory euclid_receive, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory normalized_packet)
    {
        if (euclid_receive.data.length == 0) {
            return normalized_packet;
        }
        normalized_packet = normalized_packet.push(
            NormalizedPacketLib.NormalizedPacket(
                string.concat(prefix, "data"), string(abi.encodePacked(euclid_receive.data))
            )
        );
        return normalized_packet;
    }

    function parseEuclidReceive(NormalizedPacketLib.HashedNormalizedPacket[] memory packet, string memory prefix)
        internal
        pure
        returns (EuclidReceive memory)
    {
        string memory data = packet.findKey(string.concat(prefix, ".data"));
        bytes memory data_bytes = bytes(data);
        return EuclidReceive({ data: data_bytes });
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (proxy/Proxy.sol)

pragma solidity ^0.8.20;

/**
 * @dev This abstract contract provides a fallback function that delegates all calls to another contract using the EVM
 * instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to
 * be specified by overriding the virtual {_implementation} function.
 *
 * Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a
 * different contract through the {_delegate} function.
 *
 * The success and return data of the delegated call will be returned back to the caller of the proxy.
 */
abstract contract Proxy {
    /**
     * @dev Delegates the current call to `implementation`.
     *
     * This function does not return to its internal call site, it will return directly to the external caller.
     */
    function _delegate(address implementation) internal virtual {
        assembly {
            // Copy msg.data. We take full control of memory in this inline assembly
            // block because it will not return to Solidity code. We overwrite the
            // Solidity scratch pad at memory position 0.
            calldatacopy(0x00, 0x00, calldatasize())

            // Call the implementation.
            // out and outsize are 0 because we don't know the size yet.
            let result := delegatecall(gas(), implementation, 0x00, calldatasize(), 0x00, 0x00)

            // Copy the returned data.
            returndatacopy(0x00, 0x00, returndatasize())

            switch result
            // delegatecall returns 0 on error.
            case 0 {
                revert(0x00, returndatasize())
            }
            default {
                return(0x00, returndatasize())
            }
        }
    }

    /**
     * @dev This is a virtual function that should be overridden so it returns the address to which the fallback
     * function and {_fallback} should delegate.
     */
    function _implementation() internal view virtual returns (address);

    /**
     * @dev Delegates the current call to the address returned by `_implementation()`.
     *
     * This function does not return to its internal call site, it will return directly to the external caller.
     */
    function _fallback() internal virtual {
        _delegate(_implementation());
    }

    /**
     * @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if no other
     * function in the contract matches the call data.
     */
    fallback() external payable virtual {
        _fallback();
    }
}

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

import { TokenLib } from "src/types/Token.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { RecipientLibrary } from "src/types/Recipient.sol";
import { CrossChainUserLibrary } from "src/types/CrossChainUser.sol";
import { CrossChainConfigLibrary } from "src/types/CrossChainConfig.sol";

/// @title ITokenModule
/// @notice Interface for the token module functions
interface ITokenModule {
    event TransferVoucherSuccess(string tx_id);
    event TransferVoucherError(string tx_id);

    /// @notice Register a new denom/token
    function registerDenom(
        TokenLib.TokenWithDenom calldata token_with_denom,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /// @notice Request deregistration of a token/denom
    function deregisterDenom(
        TokenLib.TokenWithDenom calldata token_with_denom,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /// @notice Create a new token escrow
    function createTokenEscrow(TokenLib.TokenWithDenom memory token_with_denom) external returns (address);

    /// @notice Deposit an ERC20 token
    /// @param asset_in The token with denom
    /// @param amount_in The token amount
    /// @param recipients The recipients. Token denoms for all recipients must be voucher.
    function depositToken(
        TokenLib.TokenWithDenom calldata asset_in,
        uint256 amount_in,
        RecipientLibrary.Recipient[] memory recipients,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /// @notice Transfer a voucher to the recipients
    /// @param token_id The token ID
    /// @param amount The token amount
    /// @param recipients The recipients. If recipient token type is not voucher, then it will release voucher for the recipient.
    function transferVoucher(
        string calldata token_id,
        uint256 amount,
        CrossChainUserLibrary.CrossChainUser memory from,
        RecipientLibrary.Recipient[] memory recipients,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /// @notice Acknowledge registration of a new denom/token
    /// @param sequence The sequence number of the packet
    /// @param hashed_msg The hashed message
    /// @param hashed_acknowledgment The hashed acknowledgment
    function acknowledgeRegisterDenom(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;

    /// @notice Acknowledge deregistration of a token/denom
    /// @param sequence The sequence number of the packet
    /// @param hashed_msg The hashed message
    /// @param hashed_acknowledgment The hashed acknowledgment
    function acknowledgeDeregisterDenom(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;

    /// @notice Acknowledge deposit of a token
    function acknowledgeDepositToken(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;

    /// @notice Acknowledge transfer of a voucher
    function acknowledgeTransferVoucher(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;
}

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

pragma solidity ^0.8.20;

import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";

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

    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable")) - 1)) & ~bytes32(uint256(0xff))
    bytes32 private constant OwnableStorageLocation = 0x9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300;

    function _getOwnableStorage() private pure returns (OwnableStorage storage $) {
        assembly {
            $.slot := OwnableStorageLocation
        }
    }

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

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

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

    /**
     * @dev Initializes the contract setting the address provided by the deployer as the initial owner.
     */
    function __Ownable_init(address initialOwner) internal onlyInitializing {
        __Ownable_init_unchained(initialOwner);
    }

    function __Ownable_init_unchained(address initialOwner) internal onlyInitializing {
        if (initialOwner == address(0)) {
            revert OwnableInvalidOwner(address(0));
        }
        _transferOwnership(initialOwner);
    }

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

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

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

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/ERC1967/ERC1967Proxy.sol)

pragma solidity ^0.8.22;

import {Proxy} from "../Proxy.sol";
import {ERC1967Utils} from "./ERC1967Utils.sol";

/**
 * @dev This contract implements an upgradeable proxy. It is upgradeable because calls are delegated to an
 * implementation address that can be changed. This address is stored in storage in the location specified by
 * https://eips.ethereum.org/EIPS/eip-1967[ERC-1967], so that it doesn't conflict with the storage layout of the
 * implementation behind the proxy.
 */
contract ERC1967Proxy is Proxy {
    /**
     * @dev The proxy is left uninitialized.
     */
    error ERC1967ProxyUninitialized();

    /**
     * @dev Initializes the upgradeable proxy with an initial implementation specified by `implementation`.
     *
     * Provided `_data` is passed in a delegate call to `implementation`. This will typically be an encoded function
     * call, and allows initializing the storage of the proxy like a Solidity constructor. By default construction
     * will fail if `_data` is empty. This behavior can be overridden using a custom {_unsafeAllowUninitialized} that
     * returns true. In that case, empty `_data` is ignored and no delegate call to the implementation is performed
     * during construction.
     *
     * Requirements:
     *
     * - If `data` is empty, `msg.value` must be zero.
     */
    constructor(address implementation, bytes memory _data) payable {
        if (!_unsafeAllowUninitialized() && _data.length == 0) {
            revert ERC1967ProxyUninitialized();
        }
        ERC1967Utils.upgradeToAndCall(implementation, _data);
    }

    /**
     * @dev Returns the current implementation address.
     *
     * TIP: To get this value clients can read directly from the storage slot shown below (specified by ERC-1967) using
     * the https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
     * `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc`
     */
    function _implementation() internal view virtual override returns (address) {
        return ERC1967Utils.getImplementation();
    }

    /**
     * @dev Returns whether the proxy can be left uninitialized.
     *
     * NOTE: Override this function to allow the proxy to be left uninitialized.
     * Consider uninitialized proxies might be susceptible to man-in-the-middle threats
     * where the proxy is replaced with a malicious one.
     */
    function _unsafeAllowUninitialized() internal pure virtual returns (bool) {
        return false;
    }
}

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

/**
 * @title StringsUtil
 * @notice Library for string manipulation utilities
 * @dev This library provides utility functions for string operations including
 *      comparison, case conversion, and other string manipulations commonly
 *      needed in smart contracts.
 * @author Euclid Protocol
 */
library StringsUtil {
    // -------------------------------------------------------------------------
    // String Comparison Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Compares two byte arrays lexicographically
     * @dev Performs byte-by-byte comparison of two byte arrays
     * @param a The first byte array
     * @param b The second byte array
     * @return The comparison result:
     *         - -1 if a < b
     *         - 0 if a == b
     *         - 1 if a > b
     */
    function compare(bytes memory a, bytes memory b) internal pure returns (int256) {
        uint256 minLength = a.length < b.length ? a.length : b.length;

        // Compare characters up to the minimum length
        for (uint256 i = 0; i < minLength; i++) {
            if (a[i] < b[i]) {
                return -1;
            } else if (a[i] > b[i]) {
                return 1;
            }
        }

        // If all compared characters are equal, compare lengths
        if (a.length < b.length) return -1;
        else if (a.length > b.length) return 1;
        return 0;
    }

    /**
     * @notice Compares two strings lexicographically
     * @dev Converts strings to bytes and performs comparison
     * @param a The first string
     * @param b The second string
     * @return The comparison result:
     *         - -1 if a < b
     *         - 0 if a == b
     *         - 1 if a > b
     */
    function compare(string memory a, string memory b) internal pure returns (int256) {
        return compare(bytes(a), bytes(b));
    }

    // -------------------------------------------------------------------------
    // String Transformation Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Converts a string to lowercase
     * @dev Converts all uppercase ASCII characters (A-Z) to lowercase (a-z)
     * @param str The string to convert
     * @return The lowercase version of the string
     *
     * @custom:examples
     * - toLowerCase("Hello") returns "hello"
     * - toLowerCase("WORLD") returns "world"
     * - toLowerCase("Mixed123") returns "mixed123"
     */
    function toLowerCase(string memory str) internal pure returns (string memory) {
        bytes memory bStr = bytes(str);
        bytes memory bLower = new bytes(bStr.length);

        for (uint256 i = 0; i < bStr.length; i++) {
            uint8 char = uint8(bStr[i]);
            // Check if character is uppercase A-Z (ASCII 65-90)
            if (char >= 65 && char <= 90) {
                // Convert to lowercase by adding 32
                bLower[i] = bytes1(char + 32);
            } else {
                // Keep character as-is if not uppercase
                bLower[i] = bStr[i];
            }
        }

        return string(bLower);
    }
}

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

library TokenModuleStorage {
    error TokenEscrowAlreadyExists();

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @custom:storage-location erc7201:euclid.storage.factory.modules.token
    /// @notice Layout for token escrow
    struct Layout {
        address module_address;
        address token_escrow_implementation;
        mapping(string => address) token_to_escrow;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    string private constant _NAMESPACE = "euclid.storage.factory.modules.token";
    string private constant _VERSION = "0.1.0";
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Returns the storage layout for token escrow
    /// @return l The storage layout
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    function set_module_address(address module_address) internal {
        _layout().module_address = module_address;
    }

    function get_module_address() internal view returns (address) {
        return _layout().module_address;
    }

    function get_token_escrow(string memory token_id) internal view returns (address) {
        return _layout().token_to_escrow[token_id];
    }

    function set_token_escrow(string memory token_id, address escrow) internal {
        Layout storage l = _layout();
        if (l.token_to_escrow[token_id] != address(0)) {
            revert TokenEscrowAlreadyExists();
        }
        l.token_to_escrow[token_id] = escrow;
    }

    function set_token_escrow_implementation(address token_escrow_implementation) internal {
        _layout().token_escrow_implementation = token_escrow_implementation;
    }

    function get_token_escrow_implementation() internal view returns (address) {
        return _layout().token_escrow_implementation;
    }
}

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

/// @title PausableUtilStorage
/// @notice Storage for the pausable utility
library PausableUtilStorage {
    // -------------------------------------------------------------------------
    // Errors
    // -------------------------------------------------------------------------
    error ErrorIsPaused(bytes4 function_selector);
    error ErrorIsPausedByLabel(string label);
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @custom:storage-location erc7201:euclid.storage.pausableutil
    /// @notice Layout for pausable state
    /// @param paused_selector Paused state for a function selector
    /// @param paused_by_label Paused state for a custom label giving flexibility to pause functions for a specific parameter.
    /// @param contract_paused Paused state for the contract

    struct Layout {
        address pause_admin;
        mapping(bytes4 => bool) paused_selector;
        mapping(string => bool) paused_by_label;
        bool contract_paused;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    string private constant _NAMESPACE = "euclid.storage.pausable";
    string private constant _VERSION = "0.1.0";
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Returns the storage layout for pausable
    /// @return l The storage layout
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    /// @notice Returns the version string
    /// @return The version string
    function version() internal pure returns (string memory) {
        return _VERSION;
    }

    /// @notice Returns the namespace string
    /// @return The namespace string
    function namespace() internal pure returns (string memory) {
        return _NAMESPACE;
    }

    function set_paused_selector(bytes4 function_selector, bool paused) internal {
        _layout().paused_selector[function_selector] = paused;
    }

    function paused_selector(bytes4 function_selector) internal view returns (bool) {
        return _layout().paused_selector[function_selector];
    }

    function set_paused_by_label(string memory label, bool paused) internal {
        _layout().paused_by_label[label] = paused;
    }

    function paused_by_label(string memory label) internal view returns (bool) {
        return _layout().paused_by_label[label];
    }

    function set_contract_paused(bool paused) internal {
        _layout().contract_paused = paused;
    }

    function contract_paused() internal view returns (bool) {
        return _layout().contract_paused;
    }

    function set_pause_admin(address pause_admin_) internal {
        _layout().pause_admin = pause_admin_;
    }

    function pause_admin() internal view returns (address) {
        return _layout().pause_admin;
    }
}

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

pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";

/**
 * @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 ContextUpgradeable is Initializable {
    function __Context_init() internal onlyInitializing {
    }

    function __Context_init_unchained() internal onlyInitializing {
    }
    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/IERC1967.sol)

pragma solidity >=0.4.11;

/**
 * @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
 */
interface IERC1967 {
    /**
     * @dev Emitted when the implementation is upgraded.
     */
    event Upgraded(address indexed implementation);

    /**
     * @dev Emitted when the admin account has changed.
     */
    event AdminChanged(address previousAdmin, address newAdmin);

    /**
     * @dev Emitted when the beacon is changed.
     */
    event BeaconUpgraded(address indexed beacon);
}

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

pragma solidity ^0.8.24;

import {Math} from "./math/Math.sol";
import {SafeCast} from "./math/SafeCast.sol";
import {SignedMath} from "./math/SignedMath.sol";
import {Bytes} from "./Bytes.sol";

/**
 * @dev String operations.
 */
library Strings {
    using SafeCast for *;

    bytes16 private constant HEX_DIGITS = "0123456789abcdef";
    uint8 private constant ADDRESS_LENGTH = 20;
    uint256 private constant SPECIAL_CHARS_LOOKUP =
        (1 << 0x08) | // backspace
            (1 << 0x09) | // tab
            (1 << 0x0a) | // newline
            (1 << 0x0c) | // form feed
            (1 << 0x0d) | // carriage return
            (1 << 0x22) | // double quote
            (1 << 0x5c); // backslash

    /**
     * @dev The `value` string doesn't fit in the specified `length`.
     */
    error StringsInsufficientHexLength(uint256 value, uint256 length);

    /**
     * @dev The string being parsed contains characters that are not in scope of the given base.
     */
    error StringsInvalidChar();

    /**
     * @dev The string being parsed is not a properly formatted address.
     */
    error StringsInvalidAddressFormat();

    /**
     * @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;
            assembly ("memory-safe") {
                ptr := add(add(buffer, 0x20), length)
            }
            while (true) {
                ptr--;
                assembly ("memory-safe") {
                    mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
                }
                value /= 10;
                if (value == 0) break;
            }
            return buffer;
        }
    }

    /**
     * @dev Converts a `int256` to its ASCII `string` decimal representation.
     */
    function toStringSigned(int256 value) internal pure returns (string memory) {
        return string.concat(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) {
        uint256 localValue = value;
        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] = HEX_DIGITS[localValue & 0xf];
            localValue >>= 4;
        }
        if (localValue != 0) {
            revert StringsInsufficientHexLength(value, length);
        }
        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 Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
     * representation, according to EIP-55.
     */
    function toChecksumHexString(address addr) internal pure returns (string memory) {
        bytes memory buffer = bytes(toHexString(addr));

        // hash the hex part of buffer (skip length + 2 bytes, length 40)
        uint256 hashValue;
        assembly ("memory-safe") {
            hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
        }

        for (uint256 i = 41; i > 1; --i) {
            // possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
            if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
                // case shift by xoring with 0x20
                buffer[i] ^= 0x20;
            }
            hashValue >>= 4;
        }
        return string(buffer);
    }

    /**
     * @dev Converts a `bytes` buffer to its ASCII `string` hexadecimal representation.
     */
    function toHexString(bytes memory input) internal pure returns (string memory) {
        unchecked {
            bytes memory buffer = new bytes(2 * input.length + 2);
            buffer[0] = "0";
            buffer[1] = "x";
            for (uint256 i = 0; i < input.length; ++i) {
                uint8 v = uint8(input[i]);
                buffer[2 * i + 2] = HEX_DIGITS[v >> 4];
                buffer[2 * i + 3] = HEX_DIGITS[v & 0xf];
            }
            return string(buffer);
        }
    }

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

    /**
     * @dev Parse a decimal string and returns the value as a `uint256`.
     *
     * Requirements:
     * - The string must be formatted as `[0-9]*`
     * - The result must fit into an `uint256` type
     */
    function parseUint(string memory input) internal pure returns (uint256) {
        return parseUint(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseUint-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `[0-9]*`
     * - The result must fit into an `uint256` type
     */
    function parseUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
        (bool success, uint256 value) = tryParseUint(input, begin, end);
        if (!success) revert StringsInvalidChar();
        return value;
    }

    /**
     * @dev Variant of {parseUint-string} that returns false if the parsing fails because of an invalid character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseUint(string memory input) internal pure returns (bool success, uint256 value) {
        return _tryParseUintUncheckedBounds(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseUint-string-uint256-uint256} that returns false if the parsing fails because of an invalid
     * character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseUint(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, uint256 value) {
        if (end > bytes(input).length || begin > end) return (false, 0);
        return _tryParseUintUncheckedBounds(input, begin, end);
    }

    /**
     * @dev Implementation of {tryParseUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
     * `begin <= end <= input.length`. Other inputs would result in undefined behavior.
     */
    function _tryParseUintUncheckedBounds(
        string memory input,
        uint256 begin,
        uint256 end
    ) private pure returns (bool success, uint256 value) {
        bytes memory buffer = bytes(input);

        uint256 result = 0;
        for (uint256 i = begin; i < end; ++i) {
            uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
            if (chr > 9) return (false, 0);
            result *= 10;
            result += chr;
        }
        return (true, result);
    }

    /**
     * @dev Parse a decimal string and returns the value as a `int256`.
     *
     * Requirements:
     * - The string must be formatted as `[-+]?[0-9]*`
     * - The result must fit in an `int256` type.
     */
    function parseInt(string memory input) internal pure returns (int256) {
        return parseInt(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseInt-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `[-+]?[0-9]*`
     * - The result must fit in an `int256` type.
     */
    function parseInt(string memory input, uint256 begin, uint256 end) internal pure returns (int256) {
        (bool success, int256 value) = tryParseInt(input, begin, end);
        if (!success) revert StringsInvalidChar();
        return value;
    }

    /**
     * @dev Variant of {parseInt-string} that returns false if the parsing fails because of an invalid character or if
     * the result does not fit in a `int256`.
     *
     * NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
     */
    function tryParseInt(string memory input) internal pure returns (bool success, int256 value) {
        return _tryParseIntUncheckedBounds(input, 0, bytes(input).length);
    }

    uint256 private constant ABS_MIN_INT256 = 2 ** 255;

    /**
     * @dev Variant of {parseInt-string-uint256-uint256} that returns false if the parsing fails because of an invalid
     * character or if the result does not fit in a `int256`.
     *
     * NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
     */
    function tryParseInt(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, int256 value) {
        if (end > bytes(input).length || begin > end) return (false, 0);
        return _tryParseIntUncheckedBounds(input, begin, end);
    }

    /**
     * @dev Implementation of {tryParseInt-string-uint256-uint256} that does not check bounds. Caller should make sure that
     * `begin <= end <= input.length`. Other inputs would result in undefined behavior.
     */
    function _tryParseIntUncheckedBounds(
        string memory input,
        uint256 begin,
        uint256 end
    ) private pure returns (bool success, int256 value) {
        bytes memory buffer = bytes(input);

        // Check presence of a negative sign.
        bytes1 sign = begin == end ? bytes1(0) : bytes1(_unsafeReadBytesOffset(buffer, begin)); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
        bool positiveSign = sign == bytes1("+");
        bool negativeSign = sign == bytes1("-");
        uint256 offset = (positiveSign || negativeSign).toUint();

        (bool absSuccess, uint256 absValue) = tryParseUint(input, begin + offset, end);

        if (absSuccess && absValue < ABS_MIN_INT256) {
            return (true, negativeSign ? -int256(absValue) : int256(absValue));
        } else if (absSuccess && negativeSign && absValue == ABS_MIN_INT256) {
            return (true, type(int256).min);
        } else return (false, 0);
    }

    /**
     * @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as a `uint256`.
     *
     * Requirements:
     * - The string must be formatted as `(0x)?[0-9a-fA-F]*`
     * - The result must fit in an `uint256` type.
     */
    function parseHexUint(string memory input) internal pure returns (uint256) {
        return parseHexUint(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseHexUint-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `(0x)?[0-9a-fA-F]*`
     * - The result must fit in an `uint256` type.
     */
    function parseHexUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
        (bool success, uint256 value) = tryParseHexUint(input, begin, end);
        if (!success) revert StringsInvalidChar();
        return value;
    }

    /**
     * @dev Variant of {parseHexUint-string} that returns false if the parsing fails because of an invalid character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseHexUint(string memory input) internal pure returns (bool success, uint256 value) {
        return _tryParseHexUintUncheckedBounds(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseHexUint-string-uint256-uint256} that returns false if the parsing fails because of an
     * invalid character.
     *
     * NOTE: This function will revert if the result does not fit in a `uint256`.
     */
    function tryParseHexUint(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, uint256 value) {
        if (end > bytes(input).length || begin > end) return (false, 0);
        return _tryParseHexUintUncheckedBounds(input, begin, end);
    }

    /**
     * @dev Implementation of {tryParseHexUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
     * `begin <= end <= input.length`. Other inputs would result in undefined behavior.
     */
    function _tryParseHexUintUncheckedBounds(
        string memory input,
        uint256 begin,
        uint256 end
    ) private pure returns (bool success, uint256 value) {
        bytes memory buffer = bytes(input);

        // skip 0x prefix if present
        bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(buffer, begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
        uint256 offset = hasPrefix.toUint() * 2;

        uint256 result = 0;
        for (uint256 i = begin + offset; i < end; ++i) {
            uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
            if (chr > 15) return (false, 0);
            result *= 16;
            unchecked {
                // Multiplying by 16 is equivalent to a shift of 4 bits (with additional overflow check).
                // This guarantees that adding a value < 16 will not cause an overflow, hence the unchecked.
                result += chr;
            }
        }
        return (true, result);
    }

    /**
     * @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as an `address`.
     *
     * Requirements:
     * - The string must be formatted as `(0x)?[0-9a-fA-F]{40}`
     */
    function parseAddress(string memory input) internal pure returns (address) {
        return parseAddress(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseAddress-string} that parses a substring of `input` located between position `begin` (included) and
     * `end` (excluded).
     *
     * Requirements:
     * - The substring must be formatted as `(0x)?[0-9a-fA-F]{40}`
     */
    function parseAddress(string memory input, uint256 begin, uint256 end) internal pure returns (address) {
        (bool success, address value) = tryParseAddress(input, begin, end);
        if (!success) revert StringsInvalidAddressFormat();
        return value;
    }

    /**
     * @dev Variant of {parseAddress-string} that returns false if the parsing fails because the input is not a properly
     * formatted address. See {parseAddress-string} requirements.
     */
    function tryParseAddress(string memory input) internal pure returns (bool success, address value) {
        return tryParseAddress(input, 0, bytes(input).length);
    }

    /**
     * @dev Variant of {parseAddress-string-uint256-uint256} that returns false if the parsing fails because input is not a properly
     * formatted address. See {parseAddress-string-uint256-uint256} requirements.
     */
    function tryParseAddress(
        string memory input,
        uint256 begin,
        uint256 end
    ) internal pure returns (bool success, address value) {
        if (end > bytes(input).length || begin > end) return (false, address(0));

        bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(bytes(input), begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
        uint256 expectedLength = 40 + hasPrefix.toUint() * 2;

        // check that input is the correct length
        if (end - begin == expectedLength) {
            // length guarantees that this does not overflow, and value is at most type(uint160).max
            (bool s, uint256 v) = _tryParseHexUintUncheckedBounds(input, begin, end);
            return (s, address(uint160(v)));
        } else {
            return (false, address(0));
        }
    }

    function _tryParseChr(bytes1 chr) private pure returns (uint8) {
        uint8 value = uint8(chr);

        // Try to parse `chr`:
        // - Case 1: [0-9]
        // - Case 2: [a-f]
        // - Case 3: [A-F]
        // - otherwise not supported
        unchecked {
            if (value > 47 && value < 58) value -= 48;
            else if (value > 96 && value < 103) value -= 87;
            else if (value > 64 && value < 71) value -= 55;
            else return type(uint8).max;
        }

        return value;
    }

    /**
     * @dev Escape special characters in JSON strings. This can be useful to prevent JSON injection in NFT metadata.
     *
     * WARNING: This function should only be used in double quoted JSON strings. Single quotes are not escaped.
     *
     * NOTE: This function escapes all unicode characters, and not just the ones in ranges defined in section 2.5 of
     * RFC-4627 (U+0000 to U+001F, U+0022 and U+005C). ECMAScript's `JSON.parse` does recover escaped unicode
     * characters that are not in this range, but other tooling may provide different results.
     */
    function escapeJSON(string memory input) internal pure returns (string memory) {
        bytes memory buffer = bytes(input);
        bytes memory output = new bytes(2 * buffer.length); // worst case scenario
        uint256 outputLength = 0;

        for (uint256 i = 0; i < buffer.length; ++i) {
            bytes1 char = bytes1(_unsafeReadBytesOffset(buffer, i));
            if (((SPECIAL_CHARS_LOOKUP & (1 << uint8(char))) != 0)) {
                output[outputLength++] = "\\";
                if (char == 0x08) output[outputLength++] = "b";
                else if (char == 0x09) output[outputLength++] = "t";
                else if (char == 0x0a) output[outputLength++] = "n";
                else if (char == 0x0c) output[outputLength++] = "f";
                else if (char == 0x0d) output[outputLength++] = "r";
                else if (char == 0x5c) output[outputLength++] = "\\";
                else if (char == 0x22) {
                    // solhint-disable-next-line quotes
                    output[outputLength++] = '"';
                }
            } else {
                output[outputLength++] = char;
            }
        }
        // write the actual length and deallocate unused memory
        assembly ("memory-safe") {
            mstore(output, outputLength)
            mstore(0x40, add(output, shl(5, shr(5, add(outputLength, 63)))))
        }

        return string(output);
    }

    /**
     * @dev Reads a bytes32 from a bytes array without bounds checking.
     *
     * NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
     * assembly block as such would prevent some optimizations.
     */
    function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
        // This is not memory safe in the general case, but all calls to this private function are within bounds.
        assembly ("memory-safe") {
            value := mload(add(add(buffer, 0x20), offset))
        }
    }
}

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

// OpenZeppelin imports
import { OwnableUpgradeable } from "openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgradeable.sol";
import { Strings } from "openzeppelin-contracts/contracts/utils/Strings.sol";

// Internal imports
import { TokenLib } from "src/types/Token.sol";
import { PausableUtil } from "src/utils/Pausable/Pausable.sol";
import { FactoryStorage as Storage } from "./Storage.sol";

/**
 * @title Modifiers
 * @notice Abstract contract providing access control and pausable functionality modifiers
 * @dev This contract provides a comprehensive set of modifiers for access control,
 *      pausable functionality, and token-specific pause controls. It extends
 *      OpenZeppelin's OwnableUpgradeable for basic ownership functionality.
 * @author Euclid Protocol
 */
abstract contract Modifiers is OwnableUpgradeable, PausableUtil {
    // -------------------------------------------------------------------------
    // Libraries
    // -------------------------------------------------------------------------
    using TokenLib for *;
    using Strings for *;

    // -------------------------------------------------------------------------
    // Errors
    // -------------------------------------------------------------------------

    /// @notice Thrown when caller is not the authorized relayer
    error NotRelayer();

    // -------------------------------------------------------------------------
    // Internal Functions
    // -------------------------------------------------------------------------

    // -------------------------------------------------------------------------
    // Token-Specific Pause Modifiers
    // -------------------------------------------------------------------------

    /**
     * @notice Modifier to ensure a specific token is not paused
     * @dev Reverts if the token is paused
     * @param token_id The token ID to check
     */
    modifier whenTokenNotPaused(string memory token_id) {
        _requireLabelNotPaused(string.concat(token_id, "_token"));
        _;
    }

    /**
     * @notice Modifier to ensure a token type is not paused
     * @dev Reverts if the token type is paused
     * @param token_type The token type to check
     */
    modifier whenTokenTypeNotPaused(TokenLib.TokenType memory token_type) {
        _whenTokenTypeNotPaused(token_type);
        _;
    }

    function _whenTokenTypeNotPaused(TokenLib.TokenType memory token_type) internal view {
        if (token_type.isSmart()) {
            _requireLabelNotPaused(string.concat(token_type.erc20_address, "_token_type"));
        } else if (token_type.isNative()) {
            _requireLabelNotPaused(string.concat(token_type.native_denom, "_token_type"));
        } else if (token_type.isVoucher()) {
            _requireLabelNotPaused("voucher_token_type");
        }
    }

    // -------------------------------------------------------------------------
    // Access Control Modifiers
    // -------------------------------------------------------------------------

    /**
     * @notice Modifier to ensure caller is the authorized relayer
     * @dev Reverts if caller is not the relayer
     */
    modifier onlyRelayer() {
        _onlyRelayer();
        _;
    }

    function _onlyRelayer() internal view {
        address relayer = Storage.get_relayer();
        require(msg.sender == relayer, NotRelayer());
    }
}

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

/// @title PacketsStorage
/// @notice Library for managing cross-chain packet state and storage
library PacketsStorage {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @custom:storage-location erc7201:euclid.storage.factory.modules.cross_chain.packets
    /// @notice Layout for cross-chain packet state
    /// @param authorized_port Authorized port for receiving packets (e.g., vsl.router_address)
    /// @param self_port Self port for sending packets (e.g., vsl.factory_address)
    /// @param curr_packet_sequence Packet sequence number
    /// @param pending_send_packets Packets currently in processing. Stores block number when the packet was sent
    /// @param processed_received_packets Mapping of all received packets to prevent double processing
    struct Layout {
        uint256 curr_packet_sequence;
        uint256 pending_send_packets_count;
        mapping(uint256 => uint256) pending_send_packets;
        mapping(uint256 => uint256) processed_received_packets;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    string private constant _NAMESPACE = "euclid.storage.factory.modules.cross_chain.packets";
    string private constant _VERSION = "0.1.0";
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Returns the storage layout for packets
    /// @return l The storage layout
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    /// @notice Returns the version string
    /// @return The version string
    function version() internal pure returns (string memory) {
        return _VERSION;
    }

    /// @notice Returns the namespace string
    /// @return The namespace string
    function namespace() internal pure returns (string memory) {
        return _NAMESPACE;
    }

    /// @notice Returns a mutable reference to the packets state
    /// @return l The packets state storage reference
    function mut_packets_state() internal pure returns (Layout storage l) {
        Layout storage s = _layout();
        return s;
    }

    /// @notice Verifies if a packet is pending
    /// @param packet_sequence The sequence number of the packet
    /// @return l True if the packet is pending, false otherwise
    function isPacketPending(uint256 packet_sequence) internal view returns (bool l) {
        Layout storage s = _layout();
        return s.pending_send_packets[packet_sequence] != 0;
    }

    /// @notice Verifies if a packet is pending. Throws if the hash does not match.
    /// @param packet_sequence The sequence number of the packet
    function verifyPendingPacket(uint256 packet_sequence) internal view {
        Layout storage s = _layout();
        uint256 expected_block_number = s.pending_send_packets[packet_sequence];
        if (expected_block_number == 0) {
            revert PacketNotFound(packet_sequence);
        }
    }

    function read_pending_send_packets_count() internal view returns (uint256 l) {
        Layout storage s = _layout();
        return s.pending_send_packets_count;
    }

    error PacketNotFound(uint256 packet_sequence);
    error PacketHashMismatch(bytes32 expected_hash, bytes32 actual_hash);
}

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

library PoolModuleStorage {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @custom:storage-location erc7201:euclid.storage.factory.modules.pool
    /// @notice Layout for pool module
    struct Layout {
        address module_address;
        address lp_token_implementation;
        uint256 pool_creation_fee;
        address pool_fee_recipient;
        mapping(string => string) pool_vlp;
        mapping(string => address) vlp_lp_address;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    string private constant _NAMESPACE = "euclid.storage.factory.modules.pool";
    string private constant _VERSION = "0.1.0";
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Returns the storage layout for token escrow
    /// @return l The storage layout
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    function set_module_address(address module_address) internal {
        _layout().module_address = module_address;
    }

    function get_module_address() internal view returns (address) {
        return _layout().module_address;
    }

    function set_pool_creation_fee(uint256 pool_creation_fee) internal {
        _layout().pool_creation_fee = pool_creation_fee;
    }

    function get_pool_creation_fee() internal view returns (uint256) {
        return _layout().pool_creation_fee;
    }

    function set_pool_fee_recipient(address pool_fee_recipient) internal {
        _layout().pool_fee_recipient = pool_fee_recipient;
    }

    function get_pool_fee_recipient() internal view returns (address) {
        return _layout().pool_fee_recipient;
    }

    function set_pool_vlp(string memory pool_key, string memory vlp_key) internal {
        _layout().pool_vlp[pool_key] = vlp_key;
    }

    function get_pool_vlp(string memory pool_key) internal view returns (string memory) {
        return _layout().pool_vlp[pool_key];
    }

    function set_vlp_lp_address(string memory vlp_key, address lp_address) internal {
        _layout().vlp_lp_address[vlp_key] = lp_address;
    }

    function get_vlp_lp_address(string memory vlp_key) internal view returns (address) {
        return _layout().vlp_lp_address[vlp_key];
    }

    function set_lp_token_implementation(address lp_token_implementation) internal {
        _layout().lp_token_implementation = lp_token_implementation;
    }

    function get_lp_token_implementation() internal view returns (address) {
        return _layout().lp_token_implementation;
    }
}

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

import { Modifiers } from "src/Factory/Modifiers.sol";
import { CallHelper } from "src/utils/CallHelper.lib.sol";
import { TokenLib } from "src/types/Token.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { ITokenModule as IModule } from "./IModule.sol";
import { TokenModuleStorage as ModuleStorage } from "./ModuleStorage.sol";
import { RecipientLibrary } from "src/types/Recipient.sol";
import { CrossChainUserLibrary } from "src/types/CrossChainUser.sol";
import { CrossChainConfigLibrary } from "src/types/CrossChainConfig.sol";

/// @title TokenModuleWrapper
/// @notice Wrapper contract for token module delegation
contract TokenModuleWrapper is IModule, Modifiers {
    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    function __TokenModuleWrapper_init(address module_address, address token_escrow_implementation) internal {
        ModuleStorage.set_module_address(module_address);
        ModuleStorage.set_token_escrow_implementation(token_escrow_implementation);
    }

    function getTokenModule() public view returns (address) {
        return ModuleStorage.get_module_address();
    }

    function updateTokenModule(address module_address) external onlyOwner {
        ModuleStorage.set_module_address(module_address);
    }

    function updateTokenEscrowImplementation(address token_escrow_implementation) external onlyOwner {
        ModuleStorage.set_token_escrow_implementation(token_escrow_implementation);
    }

    function getTokenEscrowImplementation() external view returns (address) {
        return ModuleStorage.get_token_escrow_implementation();
    }

    function registerDenom(
        TokenLib.TokenWithDenom calldata,
        /*token_with_denom*/
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    )
        external
        payable
        onlyOwner
    {
        address module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    function createTokenEscrow(TokenLib.TokenWithDenom memory) external view onlyRelayer returns (address) {
        revert("Direct Call Not Allowed");
    }

    function acknowledgeRegisterDenom(
        uint256,
        /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata,
        /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external view onlyRelayer {
        revert("Direct Call Not Allowed");
    }

    function deregisterDenom(
        TokenLib.TokenWithDenom calldata,
        /*token_with_denom*/
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    )
        external
        payable
        onlyOwner
    {
        address module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    function acknowledgeDeregisterDenom(
        uint256,
        /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata,
        /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external view onlyRelayer {
        revert("Direct Call Not Allowed");
    }

    function depositToken(
        TokenLib.TokenWithDenom calldata,
        uint256,
        RecipientLibrary.Recipient[] memory,
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    ) external payable {
        address module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    function transferVoucher(
        string calldata,
        /*token_id*/
        uint256,
        /*amount*/
        CrossChainUserLibrary.CrossChainUser memory,
        /*from*/
        RecipientLibrary.Recipient[] memory,
        /*recipients*/
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    ) external payable {
        address module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    function acknowledgeDepositToken(
        uint256,
        /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata,
        /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external view onlyRelayer {
        revert("Direct Call Not Allowed");
    }

    function acknowledgeTransferVoucher(
        uint256,
        /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata,
        /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external view onlyRelayer {
        revert("Direct Call Not Allowed");
    }

    /// @notice Get the token escrow address
    /// @param token_id The token ID
    function get_token_escrow(string calldata token_id) external view returns (address) {
        return ModuleStorage.get_token_escrow(token_id);
    }
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Standard signed math utilities missing in the Solidity language.
 */
library SignedMath {
    /**
     * @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
     *
     * IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
     * However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
     * one branch when needed, making this function more expensive.
     */
    function ternary(bool condition, int256 a, int256 b) internal pure returns (int256) {
        unchecked {
            // branchless ternary works because:
            // b ^ (a ^ b) == a
            // b ^ 0 == b
            return b ^ ((a ^ b) * int256(SafeCast.toUint(condition)));
        }
    }

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

    /**
     * @dev Returns the smallest of two signed numbers.
     */
    function min(int256 a, int256 b) internal pure returns (int256) {
        return ternary(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 {
            // Formula from the "Bit Twiddling Hacks" by Sean Eron Anderson.
            // Since `n` is a signed integer, the generated bytecode will use the SAR opcode to perform the right shift,
            // taking advantage of the most significant (or "sign" bit) in two's complement representation.
            // This opcode adds new most significant bits set to the value of the previous most significant bit. As a result,
            // the mask will either be `bytes32(0)` (if n is positive) or `~bytes32(0)` (if n is negative).
            int256 mask = n >> 255;

            // A `bytes32(0)` mask leaves the input unchanged, while a `~bytes32(0)` mask complements it.
            return uint256((n + mask) ^ mask);
        }
    }
}

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

// Internal imports
import { Modifiers } from "src/Factory/Modifiers.sol";
import { CallHelper } from "src/utils/CallHelper.lib.sol";
import { PoolLib } from "src/types/Pool.sol";
import { CrossChainUserLibrary } from "src/types/CrossChainUser.sol";
import { CrossChainConfigLibrary } from "src/types/CrossChainConfig.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
// Module-specific imports
import { IPoolModule as IModule } from "./IModule.sol";
import { PoolModuleStorage as ModuleStorage } from "./ModuleStorage.sol";

/**
 * @title PoolModuleWrapper
 * @notice Wrapper contract for pool module initialization and delegation
 * @dev This contract provides the interface for managing the pool module,
 *      including initialization and module address updates. It acts as a
 *      proxy to the actual pool module implementation.
 * @author Euclid Protocol
 */
contract PoolModuleWrapper is IModule, Modifiers {
    using NormalizedPacketLib for *;

    // -------------------------------------------------------------------------
    // Initialization
    // -------------------------------------------------------------------------

    /**
     * @notice Initializes the pool module wrapper with the module address
     * @dev This function should be called during contract initialization
     * @param module_address The address of the pool module implementation
     */
    function __PoolModuleWrapper_init(address module_address, address lp_token_implementation) internal {
        ModuleStorage.set_module_address(module_address);
        ModuleStorage.set_lp_token_implementation(lp_token_implementation);
    }

    // -------------------------------------------------------------------------
    // Module Management
    // -------------------------------------------------------------------------

    /**
     * @notice Gets the current pool module implementation address
     * @return The address of the pool module implementation
     */
    function getPoolModule() public view returns (address) {
        return ModuleStorage.get_module_address();
    }

    /**
     * @notice Updates the pool module implementation address
     * @dev Only callable by the contract owner
     * @param module_address The new address of the pool module implementation
     *
     * @custom:requirements
     * - Caller must be the contract owner
     * - `module_address` must not be the zero address
     */
    function updatePoolModule(address module_address) external onlyOwner {
        ModuleStorage.set_module_address(module_address);
    }

    function updateLpTokenImplementation(address lp_token_implementation) external onlyOwner {
        ModuleStorage.set_lp_token_implementation(lp_token_implementation);
    }

    function getLpTokenImplementation() external view returns (address) {
        return ModuleStorage.get_lp_token_implementation();
    }

    // -------------------------------------------------------------------------
    // Module Interface Delegation
    // -------------------------------------------------------------------------

    /**
     * @inheritdoc IModule
     */
    function request_pool_creation(
        PoolLib.PairWithDenomAndAmount calldata, /*pair_with_denom_and_amount*/
        PoolLib.PoolConfig calldata, /*pool_config*/
        string calldata, /*lp_token_name*/
        string memory, /*lp_token_symbol*/
        uint8, /*lp_token_decimals*/
        uint64,
        /*slippage_tolerance_bps*/
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    ) external payable {
        address pool_module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(pool_module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    /**
     * @inheritdoc IModule
     */
    function acknowledge_pool_creation(
        uint256, /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata, /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external pure {
        revert("Direct Call Not Allowed");
    }

    /**
     * @inheritdoc IModule
     */
    function add_liquidity(
        PoolLib.PairWithDenomAndAmount calldata, /*pair_with_denom_and_amount*/
        uint64,
        /*slippage_tolerance_bps*/
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    ) external payable {
        address pool_module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(pool_module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    function acknowledge_add_liquidity(
        uint256, /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata, /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external pure {
        revert("Direct Call Not Allowed");
    }

    /**
     * @inheritdoc IModule
     */
    function remove_liquidity(
        PoolLib.Pair calldata, /*pair*/
        uint256, /*lp_allocation*/
        CrossChainUserLibrary.CrossChainUser memory,
        /*recipient*/
        CrossChainConfigLibrary.CrossChainConfig calldata /*cross_chain_config*/
    ) external payable override {
        address pool_module = ModuleStorage.get_module_address();
        CallHelper.delegatecall(pool_module, msg.data);
        /// forge-lint: disable-line(unchecked-call)
    }

    function acknowledge_remove_liquidity(
        uint256, /*sequence*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata, /*hashed_msg*/
        NormalizedPacketLib.HashedNormalizedPacket[] calldata /*hashed_acknowledgment*/
    ) external pure {
        revert("Direct Call Not Allowed");
    }

    /// @notice Get the token escrow address
    /// @param pool_key The pool key
    function get_pool_vlp(string calldata pool_key) public view returns (string memory) {
        return ModuleStorage.get_pool_vlp(pool_key);
    }

    /// @notice Get the LP token address
    /// @param vlp_key The VLP key
    function get_vlp_lp_address(string calldata vlp_key) public view returns (address) {
        return ModuleStorage.get_vlp_lp_address(vlp_key);
    }

    function get_lp_token_implementation() public view returns (address) {
        return ModuleStorage.get_lp_token_implementation();
    }

    function get_pool_creation_fee() public view returns (uint256) {
        return ModuleStorage.get_pool_creation_fee();
    }

    function get_pool_fee_recipient() external view returns (address) {
        return ModuleStorage.get_pool_fee_recipient();
    }
}

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

// Internal imports
import { TokenLib } from "src/types/Token.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { RecipientLibrary } from "src/types/Recipient.sol";
import { CrossChainConfigLibrary } from "src/types/CrossChainConfig.sol";

/**
 * @title ISwapModule
 * @notice Interface for the Swap module core functionality
 * @dev This interface defines the contract for handling token swap requests with
 *      cross-chain forwarding capabilities and partner fee integrations. It supports
 *      multi-step swap sequences and optional cross-chain forwarding of output tokens.
 * @author Euclid Protocol
 */
interface ISwapModule {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /**
     * @notice Represents the parameters for a single step in a multi-step swap sequence
     * @param token_in The symbol or denomination of the input token for this step
     * @param token_out The symbol or denomination of the output token for this step
     * @param test_fail If true, this swap step is expected to fail (for testing purposes only)
     */
    struct NextSwapPair {
        string token_in;
        string token_out;
        bool test_fail;
    }

    /**
     * @notice Represents the configuration for partner fees on swap transactions
     * @param partner_fee_bps The partner fee in basis points (e.g., 100 = 1%, 1000 = 10%)
     * @param recipient The address where the partner fee will be sent
     */
    struct PartnerFee {
        uint64 partner_fee_bps;
        address recipient;
    }

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Processes a token swap request with optional partner fees and cross-chain forwarding
     * @dev This function validates the swap parameters, calculates partner fees, and forwards
     *      the request to the VSL router for execution. It supports multi-step swap sequences
     *      and cross-chain forwarding of the output tokens.
     *
     * @param asset_in The input asset with token type and denomination information
     * @param amount_in The amount of input tokens to swap (in smallest unit)
     * @param asset_out The symbol/denomination of the desired output asset
     * @param min_amount_out The minimum amount of output tokens expected (slippage protection)
     * @param swaps Array of swap pairs defining the multi-step swap sequence
     * @param recipients Optional array of recipients for releasing output tokens. If not provided, the output tokens will be sent to the sender.
     * @param partner_fee Partner fee configuration (basis points and recipient)
     * @param cross_chain_config The cross-chain configuration
     */
    function swap(
        TokenLib.TokenWithDenom calldata asset_in,
        uint256 amount_in,
        string calldata asset_out,
        uint256 min_amount_out,
        NextSwapPair[] calldata swaps,
        RecipientLibrary.Recipient[] memory recipients,
        PartnerFee memory partner_fee,
        CrossChainConfigLibrary.CrossChainConfig calldata cross_chain_config
    ) external payable;

    /**
     * @notice Acknowledges a swap request with optional partner fees and cross-chain forwarding
     * @dev This function is called by the VSL router to acknowledge a swap request.
     *      It validates the acknowledgment, updates storage, and handles the partner fee distribution.
     *
     * @param sequence The sequence number of the swap request
     * @param hashed_msg The hashed message containing the swap request details
     * @param hashed_acknowledgment The hashed acknowledgment containing the result of the swap
     */
    function acknowledge_swap(
        uint256 sequence,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_msg,
        NormalizedPacketLib.HashedNormalizedPacket[] calldata hashed_acknowledgment
    ) external;
}

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

/**
 * @title FactoryStorage
 * @notice Library for managing factory state and module addresses using ERC-7201 namespaced storage
 * @dev This library manages the storage layout for the factory contract, including
 *      chain information, router addresses, and fund manager. Uses ERC-7201 for
 *      collision-resistant storage namespacing.
 * @author Euclid Protocol
 */
library FactoryStorage {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /**
     * @notice Storage layout for the factory contract
     * @dev Uses ERC-7201 namespaced storage to prevent storage collisions
     * @custom:storage-location erc7201:euclid.storage.factory
     */
    struct Layout {
        /// @notice The unique identifier for this chain
        string chain_uid;
        /// @notice The VSL Router address for cross-chain communication
        string router_address;
        /// @notice The native denomination for this chain (e.g., "ETH", "MATIC")
        string native_denom;
        /// @notice The fund manager contract address
        address fund_manager;
        /// @notice The relayer contract address
        address relayer;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------

    /// @notice Storage namespace for collision resistance
    string private constant _NAMESPACE = "euclid.storage.factory";

    /// @notice Version identifier for storage layout
    string private constant _VERSION = "0.1.0";

    /// @notice Storage slot calculated from namespace hash
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Internal Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Returns the storage layout for the factory
     * @dev Uses assembly to access the namespaced storage slot
     * @return l The storage layout reference
     */
    function _layout() internal pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    // -------------------------------------------------------------------------
    // Metadata Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Returns the version string
     * @return The version string
     */
    function version() internal pure returns (string memory) {
        return _VERSION;
    }

    /**
     * @notice Returns the namespace string
     * @return The namespace string
     */
    function namespace() internal pure returns (string memory) {
        return _NAMESPACE;
    }

    // -------------------------------------------------------------------------
    // State Access Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Returns a mutable reference to the factory state
     * @dev Use this function when you need to modify the factory state
     * @return l The factory state storage reference
     */
    function mut_factory_state() internal pure returns (Layout storage l) {
        Layout storage s = _layout();
        return s;
    }

    /**
     * @notice Returns a copy of the factory state
     * @dev Use this function when you only need to read the factory state
     * @return l The factory state copy
     */
    function read_factory_state() internal pure returns (Layout memory l) {
        Layout storage s = _layout();
        return s;
    }

    /**
     * @notice Returns the relayer contract address
     * @return The relayer contract address
     */
    function get_relayer() internal view returns (address) {
        return _layout().relayer;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/SafeCast.sol)
// This file was procedurally generated from scripts/generate/templates/SafeCast.js.

pragma solidity ^0.8.20;

/**
 * @dev Wrappers over Solidity's uintXX/intXX/bool casting operators with added overflow
 * checks.
 *
 * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
 * easily result in undesired exploitation or bugs, since developers usually
 * assume that overflows raise errors. `SafeCast` restores this intuition by
 * reverting the transaction when such an operation overflows.
 *
 * Using this library instead of the unchecked operations eliminates an entire
 * class of bugs, so it's recommended to use it always.
 */
library SafeCast {
    /**
     * @dev Value doesn't fit in a uint of `bits` size.
     */
    error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);

    /**
     * @dev An int value doesn't fit in a uint of `bits` size.
     */
    error SafeCastOverflowedIntToUint(int256 value);

    /**
     * @dev Value doesn't fit in an int of `bits` size.
     */
    error SafeCastOverflowedIntDowncast(uint8 bits, int256 value);

    /**
     * @dev A uint value doesn't fit in an int of `bits` size.
     */
    error SafeCastOverflowedUintToInt(uint256 value);

    /**
     * @dev Returns the downcasted uint248 from uint256, reverting on
     * overflow (when the input is greater than largest uint248).
     *
     * Counterpart to Solidity's `uint248` operator.
     *
     * Requirements:
     *
     * - input must fit into 248 bits
     */
    function toUint248(uint256 value) internal pure returns (uint248) {
        if (value > type(uint248).max) {
            revert SafeCastOverflowedUintDowncast(248, value);
        }
        return uint248(value);
    }

    /**
     * @dev Returns the downcasted uint240 from uint256, reverting on
     * overflow (when the input is greater than largest uint240).
     *
     * Counterpart to Solidity's `uint240` operator.
     *
     * Requirements:
     *
     * - input must fit into 240 bits
     */
    function toUint240(uint256 value) internal pure returns (uint240) {
        if (value > type(uint240).max) {
            revert SafeCastOverflowedUintDowncast(240, value);
        }
        return uint240(value);
    }

    /**
     * @dev Returns the downcasted uint232 from uint256, reverting on
     * overflow (when the input is greater than largest uint232).
     *
     * Counterpart to Solidity's `uint232` operator.
     *
     * Requirements:
     *
     * - input must fit into 232 bits
     */
    function toUint232(uint256 value) internal pure returns (uint232) {
        if (value > type(uint232).max) {
            revert SafeCastOverflowedUintDowncast(232, value);
        }
        return uint232(value);
    }

    /**
     * @dev Returns the downcasted uint224 from uint256, reverting on
     * overflow (when the input is greater than largest uint224).
     *
     * Counterpart to Solidity's `uint224` operator.
     *
     * Requirements:
     *
     * - input must fit into 224 bits
     */
    function toUint224(uint256 value) internal pure returns (uint224) {
        if (value > type(uint224).max) {
            revert SafeCastOverflowedUintDowncast(224, value);
        }
        return uint224(value);
    }

    /**
     * @dev Returns the downcasted uint216 from uint256, reverting on
     * overflow (when the input is greater than largest uint216).
     *
     * Counterpart to Solidity's `uint216` operator.
     *
     * Requirements:
     *
     * - input must fit into 216 bits
     */
    function toUint216(uint256 value) internal pure returns (uint216) {
        if (value > type(uint216).max) {
            revert SafeCastOverflowedUintDowncast(216, value);
        }
        return uint216(value);
    }

    /**
     * @dev Returns the downcasted uint208 from uint256, reverting on
     * overflow (when the input is greater than largest uint208).
     *
     * Counterpart to Solidity's `uint208` operator.
     *
     * Requirements:
     *
     * - input must fit into 208 bits
     */
    function toUint208(uint256 value) internal pure returns (uint208) {
        if (value > type(uint208).max) {
            revert SafeCastOverflowedUintDowncast(208, value);
        }
        return uint208(value);
    }

    /**
     * @dev Returns the downcasted uint200 from uint256, reverting on
     * overflow (when the input is greater than largest uint200).
     *
     * Counterpart to Solidity's `uint200` operator.
     *
     * Requirements:
     *
     * - input must fit into 200 bits
     */
    function toUint200(uint256 value) internal pure returns (uint200) {
        if (value > type(uint200).max) {
            revert SafeCastOverflowedUintDowncast(200, value);
        }
        return uint200(value);
    }

    /**
     * @dev Returns the downcasted uint192 from uint256, reverting on
     * overflow (when the input is greater than largest uint192).
     *
     * Counterpart to Solidity's `uint192` operator.
     *
     * Requirements:
     *
     * - input must fit into 192 bits
     */
    function toUint192(uint256 value) internal pure returns (uint192) {
        if (value > type(uint192).max) {
            revert SafeCastOverflowedUintDowncast(192, value);
        }
        return uint192(value);
    }

    /**
     * @dev Returns the downcasted uint184 from uint256, reverting on
     * overflow (when the input is greater than largest uint184).
     *
     * Counterpart to Solidity's `uint184` operator.
     *
     * Requirements:
     *
     * - input must fit into 184 bits
     */
    function toUint184(uint256 value) internal pure returns (uint184) {
        if (value > type(uint184).max) {
            revert SafeCastOverflowedUintDowncast(184, value);
        }
        return uint184(value);
    }

    /**
     * @dev Returns the downcasted uint176 from uint256, reverting on
     * overflow (when the input is greater than largest uint176).
     *
     * Counterpart to Solidity's `uint176` operator.
     *
     * Requirements:
     *
     * - input must fit into 176 bits
     */
    function toUint176(uint256 value) internal pure returns (uint176) {
        if (value > type(uint176).max) {
            revert SafeCastOverflowedUintDowncast(176, value);
        }
        return uint176(value);
    }

    /**
     * @dev Returns the downcasted uint168 from uint256, reverting on
     * overflow (when the input is greater than largest uint168).
     *
     * Counterpart to Solidity's `uint168` operator.
     *
     * Requirements:
     *
     * - input must fit into 168 bits
     */
    function toUint168(uint256 value) internal pure returns (uint168) {
        if (value > type(uint168).max) {
            revert SafeCastOverflowedUintDowncast(168, value);
        }
        return uint168(value);
    }

    /**
     * @dev Returns the downcasted uint160 from uint256, reverting on
     * overflow (when the input is greater than largest uint160).
     *
     * Counterpart to Solidity's `uint160` operator.
     *
     * Requirements:
     *
     * - input must fit into 160 bits
     */
    function toUint160(uint256 value) internal pure returns (uint160) {
        if (value > type(uint160).max) {
            revert SafeCastOverflowedUintDowncast(160, value);
        }
        return uint160(value);
    }

    /**
     * @dev Returns the downcasted uint152 from uint256, reverting on
     * overflow (when the input is greater than largest uint152).
     *
     * Counterpart to Solidity's `uint152` operator.
     *
     * Requirements:
     *
     * - input must fit into 152 bits
     */
    function toUint152(uint256 value) internal pure returns (uint152) {
        if (value > type(uint152).max) {
            revert SafeCastOverflowedUintDowncast(152, value);
        }
        return uint152(value);
    }

    /**
     * @dev Returns the downcasted uint144 from uint256, reverting on
     * overflow (when the input is greater than largest uint144).
     *
     * Counterpart to Solidity's `uint144` operator.
     *
     * Requirements:
     *
     * - input must fit into 144 bits
     */
    function toUint144(uint256 value) internal pure returns (uint144) {
        if (value > type(uint144).max) {
            revert SafeCastOverflowedUintDowncast(144, value);
        }
        return uint144(value);
    }

    /**
     * @dev Returns the downcasted uint136 from uint256, reverting on
     * overflow (when the input is greater than largest uint136).
     *
     * Counterpart to Solidity's `uint136` operator.
     *
     * Requirements:
     *
     * - input must fit into 136 bits
     */
    function toUint136(uint256 value) internal pure returns (uint136) {
        if (value > type(uint136).max) {
            revert SafeCastOverflowedUintDowncast(136, value);
        }
        return uint136(value);
    }

    /**
     * @dev Returns the downcasted uint128 from uint256, reverting on
     * overflow (when the input is greater than largest uint128).
     *
     * Counterpart to Solidity's `uint128` operator.
     *
     * Requirements:
     *
     * - input must fit into 128 bits
     */
    function toUint128(uint256 value) internal pure returns (uint128) {
        if (value > type(uint128).max) {
            revert SafeCastOverflowedUintDowncast(128, value);
        }
        return uint128(value);
    }

    /**
     * @dev Returns the downcasted uint120 from uint256, reverting on
     * overflow (when the input is greater than largest uint120).
     *
     * Counterpart to Solidity's `uint120` operator.
     *
     * Requirements:
     *
     * - input must fit into 120 bits
     */
    function toUint120(uint256 value) internal pure returns (uint120) {
        if (value > type(uint120).max) {
            revert SafeCastOverflowedUintDowncast(120, value);
        }
        return uint120(value);
    }

    /**
     * @dev Returns the downcasted uint112 from uint256, reverting on
     * overflow (when the input is greater than largest uint112).
     *
     * Counterpart to Solidity's `uint112` operator.
     *
     * Requirements:
     *
     * - input must fit into 112 bits
     */
    function toUint112(uint256 value) internal pure returns (uint112) {
        if (value > type(uint112).max) {
            revert SafeCastOverflowedUintDowncast(112, value);
        }
        return uint112(value);
    }

    /**
     * @dev Returns the downcasted uint104 from uint256, reverting on
     * overflow (when the input is greater than largest uint104).
     *
     * Counterpart to Solidity's `uint104` operator.
     *
     * Requirements:
     *
     * - input must fit into 104 bits
     */
    function toUint104(uint256 value) internal pure returns (uint104) {
        if (value > type(uint104).max) {
            revert SafeCastOverflowedUintDowncast(104, value);
        }
        return uint104(value);
    }

    /**
     * @dev Returns the downcasted uint96 from uint256, reverting on
     * overflow (when the input is greater than largest uint96).
     *
     * Counterpart to Solidity's `uint96` operator.
     *
     * Requirements:
     *
     * - input must fit into 96 bits
     */
    function toUint96(uint256 value) internal pure returns (uint96) {
        if (value > type(uint96).max) {
            revert SafeCastOverflowedUintDowncast(96, value);
        }
        return uint96(value);
    }

    /**
     * @dev Returns the downcasted uint88 from uint256, reverting on
     * overflow (when the input is greater than largest uint88).
     *
     * Counterpart to Solidity's `uint88` operator.
     *
     * Requirements:
     *
     * - input must fit into 88 bits
     */
    function toUint88(uint256 value) internal pure returns (uint88) {
        if (value > type(uint88).max) {
            revert SafeCastOverflowedUintDowncast(88, value);
        }
        return uint88(value);
    }

    /**
     * @dev Returns the downcasted uint80 from uint256, reverting on
     * overflow (when the input is greater than largest uint80).
     *
     * Counterpart to Solidity's `uint80` operator.
     *
     * Requirements:
     *
     * - input must fit into 80 bits
     */
    function toUint80(uint256 value) internal pure returns (uint80) {
        if (value > type(uint80).max) {
            revert SafeCastOverflowedUintDowncast(80, value);
        }
        return uint80(value);
    }

    /**
     * @dev Returns the downcasted uint72 from uint256, reverting on
     * overflow (when the input is greater than largest uint72).
     *
     * Counterpart to Solidity's `uint72` operator.
     *
     * Requirements:
     *
     * - input must fit into 72 bits
     */
    function toUint72(uint256 value) internal pure returns (uint72) {
        if (value > type(uint72).max) {
            revert SafeCastOverflowedUintDowncast(72, value);
        }
        return uint72(value);
    }

    /**
     * @dev Returns the downcasted uint64 from uint256, reverting on
     * overflow (when the input is greater than largest uint64).
     *
     * Counterpart to Solidity's `uint64` operator.
     *
     * Requirements:
     *
     * - input must fit into 64 bits
     */
    function toUint64(uint256 value) internal pure returns (uint64) {
        if (value > type(uint64).max) {
            revert SafeCastOverflowedUintDowncast(64, value);
        }
        return uint64(value);
    }

    /**
     * @dev Returns the downcasted uint56 from uint256, reverting on
     * overflow (when the input is greater than largest uint56).
     *
     * Counterpart to Solidity's `uint56` operator.
     *
     * Requirements:
     *
     * - input must fit into 56 bits
     */
    function toUint56(uint256 value) internal pure returns (uint56) {
        if (value > type(uint56).max) {
            revert SafeCastOverflowedUintDowncast(56, value);
        }
        return uint56(value);
    }

    /**
     * @dev Returns the downcasted uint48 from uint256, reverting on
     * overflow (when the input is greater than largest uint48).
     *
     * Counterpart to Solidity's `uint48` operator.
     *
     * Requirements:
     *
     * - input must fit into 48 bits
     */
    function toUint48(uint256 value) internal pure returns (uint48) {
        if (value > type(uint48).max) {
            revert SafeCastOverflowedUintDowncast(48, value);
        }
        return uint48(value);
    }

    /**
     * @dev Returns the downcasted uint40 from uint256, reverting on
     * overflow (when the input is greater than largest uint40).
     *
     * Counterpart to Solidity's `uint40` operator.
     *
     * Requirements:
     *
     * - input must fit into 40 bits
     */
    function toUint40(uint256 value) internal pure returns (uint40) {
        if (value > type(uint40).max) {
            revert SafeCastOverflowedUintDowncast(40, value);
        }
        return uint40(value);
    }

    /**
     * @dev Returns the downcasted uint32 from uint256, reverting on
     * overflow (when the input is greater than largest uint32).
     *
     * Counterpart to Solidity's `uint32` operator.
     *
     * Requirements:
     *
     * - input must fit into 32 bits
     */
    function toUint32(uint256 value) internal pure returns (uint32) {
        if (value > type(uint32).max) {
            revert SafeCastOverflowedUintDowncast(32, value);
        }
        return uint32(value);
    }

    /**
     * @dev Returns the downcasted uint24 from uint256, reverting on
     * overflow (when the input is greater than largest uint24).
     *
     * Counterpart to Solidity's `uint24` operator.
     *
     * Requirements:
     *
     * - input must fit into 24 bits
     */
    function toUint24(uint256 value) internal pure returns (uint24) {
        if (value > type(uint24).max) {
            revert SafeCastOverflowedUintDowncast(24, value);
        }
        return uint24(value);
    }

    /**
     * @dev Returns the downcasted uint16 from uint256, reverting on
     * overflow (when the input is greater than largest uint16).
     *
     * Counterpart to Solidity's `uint16` operator.
     *
     * Requirements:
     *
     * - input must fit into 16 bits
     */
    function toUint16(uint256 value) internal pure returns (uint16) {
        if (value > type(uint16).max) {
            revert SafeCastOverflowedUintDowncast(16, value);
        }
        return uint16(value);
    }

    /**
     * @dev Returns the downcasted uint8 from uint256, reverting on
     * overflow (when the input is greater than largest uint8).
     *
     * Counterpart to Solidity's `uint8` operator.
     *
     * Requirements:
     *
     * - input must fit into 8 bits
     */
    function toUint8(uint256 value) internal pure returns (uint8) {
        if (value > type(uint8).max) {
            revert SafeCastOverflowedUintDowncast(8, value);
        }
        return uint8(value);
    }

    /**
     * @dev Converts a signed int256 into an unsigned uint256.
     *
     * Requirements:
     *
     * - input must be greater than or equal to 0.
     */
    function toUint256(int256 value) internal pure returns (uint256) {
        if (value < 0) {
            revert SafeCastOverflowedIntToUint(value);
        }
        return uint256(value);
    }

    /**
     * @dev Returns the downcasted int248 from int256, reverting on
     * overflow (when the input is less than smallest int248 or
     * greater than largest int248).
     *
     * Counterpart to Solidity's `int248` operator.
     *
     * Requirements:
     *
     * - input must fit into 248 bits
     */
    function toInt248(int256 value) internal pure returns (int248 downcasted) {
        downcasted = int248(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(248, value);
        }
    }

    /**
     * @dev Returns the downcasted int240 from int256, reverting on
     * overflow (when the input is less than smallest int240 or
     * greater than largest int240).
     *
     * Counterpart to Solidity's `int240` operator.
     *
     * Requirements:
     *
     * - input must fit into 240 bits
     */
    function toInt240(int256 value) internal pure returns (int240 downcasted) {
        downcasted = int240(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(240, value);
        }
    }

    /**
     * @dev Returns the downcasted int232 from int256, reverting on
     * overflow (when the input is less than smallest int232 or
     * greater than largest int232).
     *
     * Counterpart to Solidity's `int232` operator.
     *
     * Requirements:
     *
     * - input must fit into 232 bits
     */
    function toInt232(int256 value) internal pure returns (int232 downcasted) {
        downcasted = int232(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(232, value);
        }
    }

    /**
     * @dev Returns the downcasted int224 from int256, reverting on
     * overflow (when the input is less than smallest int224 or
     * greater than largest int224).
     *
     * Counterpart to Solidity's `int224` operator.
     *
     * Requirements:
     *
     * - input must fit into 224 bits
     */
    function toInt224(int256 value) internal pure returns (int224 downcasted) {
        downcasted = int224(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(224, value);
        }
    }

    /**
     * @dev Returns the downcasted int216 from int256, reverting on
     * overflow (when the input is less than smallest int216 or
     * greater than largest int216).
     *
     * Counterpart to Solidity's `int216` operator.
     *
     * Requirements:
     *
     * - input must fit into 216 bits
     */
    function toInt216(int256 value) internal pure returns (int216 downcasted) {
        downcasted = int216(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(216, value);
        }
    }

    /**
     * @dev Returns the downcasted int208 from int256, reverting on
     * overflow (when the input is less than smallest int208 or
     * greater than largest int208).
     *
     * Counterpart to Solidity's `int208` operator.
     *
     * Requirements:
     *
     * - input must fit into 208 bits
     */
    function toInt208(int256 value) internal pure returns (int208 downcasted) {
        downcasted = int208(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(208, value);
        }
    }

    /**
     * @dev Returns the downcasted int200 from int256, reverting on
     * overflow (when the input is less than smallest int200 or
     * greater than largest int200).
     *
     * Counterpart to Solidity's `int200` operator.
     *
     * Requirements:
     *
     * - input must fit into 200 bits
     */
    function toInt200(int256 value) internal pure returns (int200 downcasted) {
        downcasted = int200(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(200, value);
        }
    }

    /**
     * @dev Returns the downcasted int192 from int256, reverting on
     * overflow (when the input is less than smallest int192 or
     * greater than largest int192).
     *
     * Counterpart to Solidity's `int192` operator.
     *
     * Requirements:
     *
     * - input must fit into 192 bits
     */
    function toInt192(int256 value) internal pure returns (int192 downcasted) {
        downcasted = int192(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(192, value);
        }
    }

    /**
     * @dev Returns the downcasted int184 from int256, reverting on
     * overflow (when the input is less than smallest int184 or
     * greater than largest int184).
     *
     * Counterpart to Solidity's `int184` operator.
     *
     * Requirements:
     *
     * - input must fit into 184 bits
     */
    function toInt184(int256 value) internal pure returns (int184 downcasted) {
        downcasted = int184(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(184, value);
        }
    }

    /**
     * @dev Returns the downcasted int176 from int256, reverting on
     * overflow (when the input is less than smallest int176 or
     * greater than largest int176).
     *
     * Counterpart to Solidity's `int176` operator.
     *
     * Requirements:
     *
     * - input must fit into 176 bits
     */
    function toInt176(int256 value) internal pure returns (int176 downcasted) {
        downcasted = int176(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(176, value);
        }
    }

    /**
     * @dev Returns the downcasted int168 from int256, reverting on
     * overflow (when the input is less than smallest int168 or
     * greater than largest int168).
     *
     * Counterpart to Solidity's `int168` operator.
     *
     * Requirements:
     *
     * - input must fit into 168 bits
     */
    function toInt168(int256 value) internal pure returns (int168 downcasted) {
        downcasted = int168(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(168, value);
        }
    }

    /**
     * @dev Returns the downcasted int160 from int256, reverting on
     * overflow (when the input is less than smallest int160 or
     * greater than largest int160).
     *
     * Counterpart to Solidity's `int160` operator.
     *
     * Requirements:
     *
     * - input must fit into 160 bits
     */
    function toInt160(int256 value) internal pure returns (int160 downcasted) {
        downcasted = int160(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(160, value);
        }
    }

    /**
     * @dev Returns the downcasted int152 from int256, reverting on
     * overflow (when the input is less than smallest int152 or
     * greater than largest int152).
     *
     * Counterpart to Solidity's `int152` operator.
     *
     * Requirements:
     *
     * - input must fit into 152 bits
     */
    function toInt152(int256 value) internal pure returns (int152 downcasted) {
        downcasted = int152(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(152, value);
        }
    }

    /**
     * @dev Returns the downcasted int144 from int256, reverting on
     * overflow (when the input is less than smallest int144 or
     * greater than largest int144).
     *
     * Counterpart to Solidity's `int144` operator.
     *
     * Requirements:
     *
     * - input must fit into 144 bits
     */
    function toInt144(int256 value) internal pure returns (int144 downcasted) {
        downcasted = int144(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(144, value);
        }
    }

    /**
     * @dev Returns the downcasted int136 from int256, reverting on
     * overflow (when the input is less than smallest int136 or
     * greater than largest int136).
     *
     * Counterpart to Solidity's `int136` operator.
     *
     * Requirements:
     *
     * - input must fit into 136 bits
     */
    function toInt136(int256 value) internal pure returns (int136 downcasted) {
        downcasted = int136(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(136, value);
        }
    }

    /**
     * @dev Returns the downcasted int128 from int256, reverting on
     * overflow (when the input is less than smallest int128 or
     * greater than largest int128).
     *
     * Counterpart to Solidity's `int128` operator.
     *
     * Requirements:
     *
     * - input must fit into 128 bits
     */
    function toInt128(int256 value) internal pure returns (int128 downcasted) {
        downcasted = int128(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(128, value);
        }
    }

    /**
     * @dev Returns the downcasted int120 from int256, reverting on
     * overflow (when the input is less than smallest int120 or
     * greater than largest int120).
     *
     * Counterpart to Solidity's `int120` operator.
     *
     * Requirements:
     *
     * - input must fit into 120 bits
     */
    function toInt120(int256 value) internal pure returns (int120 downcasted) {
        downcasted = int120(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(120, value);
        }
    }

    /**
     * @dev Returns the downcasted int112 from int256, reverting on
     * overflow (when the input is less than smallest int112 or
     * greater than largest int112).
     *
     * Counterpart to Solidity's `int112` operator.
     *
     * Requirements:
     *
     * - input must fit into 112 bits
     */
    function toInt112(int256 value) internal pure returns (int112 downcasted) {
        downcasted = int112(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(112, value);
        }
    }

    /**
     * @dev Returns the downcasted int104 from int256, reverting on
     * overflow (when the input is less than smallest int104 or
     * greater than largest int104).
     *
     * Counterpart to Solidity's `int104` operator.
     *
     * Requirements:
     *
     * - input must fit into 104 bits
     */
    function toInt104(int256 value) internal pure returns (int104 downcasted) {
        downcasted = int104(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(104, value);
        }
    }

    /**
     * @dev Returns the downcasted int96 from int256, reverting on
     * overflow (when the input is less than smallest int96 or
     * greater than largest int96).
     *
     * Counterpart to Solidity's `int96` operator.
     *
     * Requirements:
     *
     * - input must fit into 96 bits
     */
    function toInt96(int256 value) internal pure returns (int96 downcasted) {
        downcasted = int96(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(96, value);
        }
    }

    /**
     * @dev Returns the downcasted int88 from int256, reverting on
     * overflow (when the input is less than smallest int88 or
     * greater than largest int88).
     *
     * Counterpart to Solidity's `int88` operator.
     *
     * Requirements:
     *
     * - input must fit into 88 bits
     */
    function toInt88(int256 value) internal pure returns (int88 downcasted) {
        downcasted = int88(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(88, value);
        }
    }

    /**
     * @dev Returns the downcasted int80 from int256, reverting on
     * overflow (when the input is less than smallest int80 or
     * greater than largest int80).
     *
     * Counterpart to Solidity's `int80` operator.
     *
     * Requirements:
     *
     * - input must fit into 80 bits
     */
    function toInt80(int256 value) internal pure returns (int80 downcasted) {
        downcasted = int80(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(80, value);
        }
    }

    /**
     * @dev Returns the downcasted int72 from int256, reverting on
     * overflow (when the input is less than smallest int72 or
     * greater than largest int72).
     *
     * Counterpart to Solidity's `int72` operator.
     *
     * Requirements:
     *
     * - input must fit into 72 bits
     */
    function toInt72(int256 value) internal pure returns (int72 downcasted) {
        downcasted = int72(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(72, value);
        }
    }

    /**
     * @dev Returns the downcasted int64 from int256, reverting on
     * overflow (when the input is less than smallest int64 or
     * greater than largest int64).
     *
     * Counterpart to Solidity's `int64` operator.
     *
     * Requirements:
     *
     * - input must fit into 64 bits
     */
    function toInt64(int256 value) internal pure returns (int64 downcasted) {
        downcasted = int64(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(64, value);
        }
    }

    /**
     * @dev Returns the downcasted int56 from int256, reverting on
     * overflow (when the input is less than smallest int56 or
     * greater than largest int56).
     *
     * Counterpart to Solidity's `int56` operator.
     *
     * Requirements:
     *
     * - input must fit into 56 bits
     */
    function toInt56(int256 value) internal pure returns (int56 downcasted) {
        downcasted = int56(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(56, value);
        }
    }

    /**
     * @dev Returns the downcasted int48 from int256, reverting on
     * overflow (when the input is less than smallest int48 or
     * greater than largest int48).
     *
     * Counterpart to Solidity's `int48` operator.
     *
     * Requirements:
     *
     * - input must fit into 48 bits
     */
    function toInt48(int256 value) internal pure returns (int48 downcasted) {
        downcasted = int48(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(48, value);
        }
    }

    /**
     * @dev Returns the downcasted int40 from int256, reverting on
     * overflow (when the input is less than smallest int40 or
     * greater than largest int40).
     *
     * Counterpart to Solidity's `int40` operator.
     *
     * Requirements:
     *
     * - input must fit into 40 bits
     */
    function toInt40(int256 value) internal pure returns (int40 downcasted) {
        downcasted = int40(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(40, value);
        }
    }

    /**
     * @dev Returns the downcasted int32 from int256, reverting on
     * overflow (when the input is less than smallest int32 or
     * greater than largest int32).
     *
     * Counterpart to Solidity's `int32` operator.
     *
     * Requirements:
     *
     * - input must fit into 32 bits
     */
    function toInt32(int256 value) internal pure returns (int32 downcasted) {
        downcasted = int32(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(32, value);
        }
    }

    /**
     * @dev Returns the downcasted int24 from int256, reverting on
     * overflow (when the input is less than smallest int24 or
     * greater than largest int24).
     *
     * Counterpart to Solidity's `int24` operator.
     *
     * Requirements:
     *
     * - input must fit into 24 bits
     */
    function toInt24(int256 value) internal pure returns (int24 downcasted) {
        downcasted = int24(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(24, value);
        }
    }

    /**
     * @dev Returns the downcasted int16 from int256, reverting on
     * overflow (when the input is less than smallest int16 or
     * greater than largest int16).
     *
     * Counterpart to Solidity's `int16` operator.
     *
     * Requirements:
     *
     * - input must fit into 16 bits
     */
    function toInt16(int256 value) internal pure returns (int16 downcasted) {
        downcasted = int16(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(16, value);
        }
    }

    /**
     * @dev Returns the downcasted int8 from int256, reverting on
     * overflow (when the input is less than smallest int8 or
     * greater than largest int8).
     *
     * Counterpart to Solidity's `int8` operator.
     *
     * Requirements:
     *
     * - input must fit into 8 bits
     */
    function toInt8(int256 value) internal pure returns (int8 downcasted) {
        downcasted = int8(value);
        if (downcasted != value) {
            revert SafeCastOverflowedIntDowncast(8, value);
        }
    }

    /**
     * @dev Converts an unsigned uint256 into a signed int256.
     *
     * Requirements:
     *
     * - input must be less than or equal to maxInt256.
     */
    function toInt256(uint256 value) internal pure returns (int256) {
        // Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
        if (value > uint256(type(int256).max)) {
            revert SafeCastOverflowedUintToInt(value);
        }
        return int256(value);
    }

    /**
     * @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
     */
    function toUint(bool b) internal pure returns (uint256 u) {
        assembly ("memory-safe") {
            u := iszero(iszero(b))
        }
    }
}

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

import { Strings } from "openzeppelin-contracts/contracts/utils/Strings.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { StringsUtil } from "src/utils/Strings.sol";
import { EuclidReceiveLib } from "src/types/EuclidReceive.sol";
import { TokenLib } from "src/types/Token.sol";
import { LimitLibrary } from "src/types/Limit.sol";
import { CrossChainUserLibrary } from "src/types/CrossChainUser.sol";

/// @title RecipientLibrary
/// @notice Library for handling recipient identity and string utilities
library RecipientLibrary {
    using Strings for *;
    using StringsUtil for *;
    using NormalizedPacketLib for *;
    using RecipientLibrary for *;
    using TokenLib for *;
    using EuclidReceiveLib for *;
    using LimitLibrary for *;
    using CrossChainUserLibrary for *;

    struct Recipient {
        CrossChainUserLibrary.CrossChainUser recipient;
        LimitLibrary.Limit amount; // Amount to give to the recipient.
        TokenLib.TokenType denom; // Denom to give to the recipient.
        bytes forwarding_message; // Optional message used to trigger a forwarding message to the recipient.
        bool unsafe_refund_as_voucher; // If true, the recipient will be refunded as a voucher if release fail
    }

    function toRecipient(
        CrossChainUserLibrary.CrossChainUser memory recipient,
        LimitLibrary.Limit memory amount,
        TokenLib.TokenType memory denom,
        bytes memory forwarding_message,
        bool unsafe_refund_as_voucher
    ) internal pure returns (Recipient memory) {
        return Recipient({
            recipient: recipient,
            amount: amount,
            denom: denom,
            forwarding_message: forwarding_message,
            unsafe_refund_as_voucher: unsafe_refund_as_voucher
        });
    }

    function toNormalizedPacket(Recipient memory recipient, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](0);
        normalized_packet =
            normalized_packet.concat(recipient.amount.toNormalizedPacket(string.concat(prefix, "amount.")));
        normalized_packet =
            normalized_packet.concat(recipient.denom.toNormalizedPacket(string.concat(prefix, "denom.")));
        if (recipient.forwarding_message.length > 0) {
            normalized_packet = normalized_packet.push(
                NormalizedPacketLib.NormalizedPacket({
                    key: string.concat(prefix, "forwarding_message"), value: string(recipient.forwarding_message)
                })
            );
        }
        normalized_packet =
            normalized_packet.concat(recipient.recipient.toNormalizedPacket(string.concat(prefix, "recipient.")));
        normalized_packet = normalized_packet.push(
            NormalizedPacketLib.NormalizedPacket({
                key: string.concat(prefix, "unsafe_refund_as_voucher"),
                value: recipient.unsafe_refund_as_voucher ? NormalizedPacketLib.TRUE : NormalizedPacketLib.FALSE
            })
        );
        return normalized_packet;
    }

    function parseRecipient(NormalizedPacketLib.HashedNormalizedPacket[] memory packet, string memory prefix)
        internal
        pure
        returns (Recipient memory)
    {
        CrossChainUserLibrary.CrossChainUser memory recipient =
            packet.parseCrossChainUser(string.concat(prefix, ".recipient"));
        LimitLibrary.Limit memory amount = packet.parseLimit(string.concat(prefix, ".amount"));
        TokenLib.TokenType memory denom = packet.parseTokenType(string.concat(prefix, ".denom"));
        bytes memory forwarding_message = bytes(packet.findKey(string.concat(prefix, ".forwarding_message")));
        bool unsafe_refund_as_voucher =
            packet.findKey(string.concat(prefix, ".unsafe_refund_as_voucher")).equal(NormalizedPacketLib.TRUE);
        return Recipient({
            recipient: recipient,
            amount: amount,
            denom: denom,
            forwarding_message: forwarding_message,
            unsafe_refund_as_voucher: unsafe_refund_as_voucher
        });
    }
}

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

pragma solidity ^0.8.20;

/**
 * @dev Collection of common custom errors used in multiple contracts
 *
 * IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
 * It is recommended to avoid relying on the error API for critical functionality.
 *
 * _Available since v5.1._
 */
library Errors {
    /**
     * @dev The ETH balance of the account is not enough to perform the operation.
     */
    error InsufficientBalance(uint256 balance, uint256 needed);

    /**
     * @dev A call to an address target failed. The target may have reverted.
     */
    error FailedCall();

    /**
     * @dev The deployment failed.
     */
    error FailedDeployment();

    /**
     * @dev A necessary precompile is missing.
     */
    error MissingPrecompile(address);
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (proxy/beacon/IBeacon.sol)

pragma solidity >=0.4.16;

/**
 * @dev This is the interface that {BeaconProxy} expects of its beacon.
 */
interface IBeacon {
    /**
     * @dev Must return an address that can be used as a delegate call target.
     *
     * {UpgradeableBeacon} will check that this address is a contract.
     */
    function implementation() external view returns (address);
}

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

import { ContractError } from "src/types/Error.sol";

import { Strings } from "openzeppelin-contracts/contracts/utils/Strings.sol";
import { StringsUtil } from "src/utils/Strings.sol";

import { TokenLib } from "src/types/Token.sol";

/**
 * @title Normalized Packet
 * @notice Library for normalized packet key-value pairs used in cross-chain communication
 * @dev Normalized packets are sorted key-value pairs that are used for cross-chain message passing. Packets contain key-value pairs that
 *      can be serialized and transmitted between chains.
 *      The key is a string that is used to identify the field in the packet.
 *      The value is a string that is used to store the value of the field.
 *      The packets are sorted by key in lexicographical order.
 * @author Euclid Protocol
 */
library NormalizedPacketLib {
    using Strings for *;
    using StringsUtil for *;
    using TokenLib for *;
    using NormalizedPacketLib for *;

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /**
     * @notice Represents a normalized packet key-value pair
     * @param key The key for the packet field
     * @param value The value for the packet field
     */
    struct NormalizedPacket {
        string key;
        string value;
    }

    /**
     * @notice Represents a normalized packet key-value pair
     * @param key The key for the packet field
     * @param value The value for the packet field
     */
    struct HashedNormalizedPacket {
        bytes32 key;
        string value;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------

    /// @notice Empty array representation
    string constant EMPTY_ARRAY = "[]";

    /// @notice Empty object representation
    string constant EMPTY_OBJECT = "{}";

    /// @notice Null value representation
    string constant NULL = "null";

    /// @notice Boolean true representation
    string constant TRUE = "true";

    /// @notice Boolean false representation
    string constant FALSE = "false";

    string public constant TYPE_KEY = "type";

    string public constant ERROR_TYPE_KEY_NOT_FIRST = "type key must be first";
    string public constant ERROR_PACKETS_NOT_SORTED = "packets are not sorted";
    string public constant ERROR_PACKET_EMPTY = "packet is empty";

    // -------------------------------------------------------------------------
    // Array Manipulation Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Concatenates two arrays of normalized packets
     * @dev Creates a new array containing all packets from both input arrays
     * @param packet_1 The first array of normalized packets
     * @param packet_2 The second array of normalized packets
     * @return The concatenated array of normalized packets
     *
     * @custom:examples
     * - concat([packet1], [packet2]) returns [packet1, packet2]
     * - concat([], [packet]) returns [packet]
     */
    function concat(NormalizedPacket[] memory packet_1, NormalizedPacket[] memory packet_2)
        internal
        pure
        returns (NormalizedPacket[] memory)
    {
        NormalizedPacket[] memory result = new NormalizedPacket[](packet_1.length + packet_2.length);

        // Copy packets from first array
        for (uint256 i = 0; i < packet_1.length; i++) {
            result[i] = packet_1[i];
        }

        // Copy packets from second array
        for (uint256 i = 0; i < packet_2.length; i++) {
            result[packet_1.length + i] = packet_2[i];
        }

        return result;
    }

    /**
     * @notice Adds a packet to the end of an array
     * @dev Creates a new array with the additional packet appended
     * @param packet The existing array of normalized packets
     * @param packet_item The packet to add
     * @return A new array containing all original packets plus the new packet
     *
     * @custom:examples
     * - push([packet1], packet2) returns [packet1, packet2]
     * - push([], packet) returns [packet]
     */
    function push(NormalizedPacket[] memory packet, NormalizedPacket memory packet_item)
        internal
        pure
        returns (NormalizedPacket[] memory)
    {
        NormalizedPacket[] memory result = new NormalizedPacket[](packet.length + 1);

        // Copy existing packets
        for (uint256 i = 0; i < packet.length; i++) {
            result[i] = packet[i];
        }

        // Add new packet at the end
        result[packet.length] = packet_item;

        return result;
    }

    function toHashedNormalizedPacket(NormalizedPacket[] memory packet)
        internal
        pure
        returns (HashedNormalizedPacket[] memory)
    {
        HashedNormalizedPacket[] memory result = new HashedNormalizedPacket[](packet.length);
        for (uint256 i = 0; i < packet.length; i++) {
            result[i] =
                HashedNormalizedPacket({ key: keccak256(abi.encodePacked(packet[i].key)), value: packet[i].value });
        }
        return result;
    }

    /**
     * @notice Finds the value of a key in a sorted array of normalized packets
     * @dev Searches for the key in the array and returns the index of the key
     * @param packet The array of normalized packets
     * @param key The key to search for
     * @return The value of the key, or empty string if not found
     */
    function findKeyIndex(HashedNormalizedPacket[] memory packet, string memory key) internal pure returns (int256) {
        bytes32 search_key = keccak256(abi.encodePacked(key));
        /// forge-lint: disable-line(asm-keccak256)
        for (uint256 i = 0; i < packet.length; i++) {
            if (packet[i].key == search_key) {
                return int256(i);
                /// forge-lint: disable-line(unsafe-typecast)
            }
        }
        return -1;
    }

    function findKey(HashedNormalizedPacket[] memory packet, string memory key) internal pure returns (string memory) {
        int256 index = findKeyIndex(packet, key);
        if (index == -1) {
            return "";
        }
        return packet[uint256(index)].value;
        /// forge-lint: disable-line(unsafe-typecast)
    }

    /**
     * @notice Extracts the value of the type key from a sorted array of normalized packets
     * @dev Uses binary search to find the index of the key
     * @param packet The array of normalized packets
     * @return The value of the type key, or empty string if not found
     */
    function extractType(HashedNormalizedPacket[] memory packet) internal pure returns (string memory) {
        int256 index = findKeyIndex(packet, TYPE_KEY);
        if (index == -1) {
            revert ContractError(ERROR_TYPE_KEY_NOT_FIRST);
        }
        return packet[uint256(index)].value;
        /// forge-lint: disable-line(unsafe-typecast)
    }

    function extractTxId(HashedNormalizedPacket[] memory packet, string memory prefix)
        internal
        pure
        returns (string memory)
    {
        return extractTxId(packet, prefix, true);
    }

    /**
     * @notice Extracts the value of the tx_id key from a sorted array of normalized packets
     * @dev Uses binary search to find the index of the key
     * @param packet The array of normalized packets
     * @param prefix The prefix of the tx_id key
     * @param revert_on_error Whether to revert on error
     * @return The value of the tx_id key
     *
     * @custom:examples
     * - extractTxId([packet1], "prefix") returns packet1.tx_id
     * - extractTxId([], "prefix") reverts
     *
     * @custom:requirements
     * - A tx_id with `prefix` must exist in the packet
     * - `prefix` must not be empty
     */
    function extractTxId(HashedNormalizedPacket[] memory packet, string memory prefix, bool revert_on_error)
        internal
        pure
        returns (string memory)
    {
        int256 index = findKeyIndex(packet, string.concat(prefix, ".tx_id"));
        if (index == -1) {
            if (revert_on_error) {
                revert ContractError("tx_id is required in normalized packet");
            }
            return "";
        }
        return packet[uint256(index)].value;
        /// forge-lint: disable-line(unsafe-typecast)
    }

    function validate(NormalizedPacket[] memory packet) internal pure returns (bool, string memory reason) {
        return validate(packet, false);
    }

    function validate(NormalizedPacket[] memory packet, bool revert_on_error)
        internal
        pure
        returns (bool, string memory)
    {
        // Validation: packets should be sorted by key, with "type" key first if present,
        // and all other keys sorted lexicographically.
        if (packet.length == 0) {
            if (revert_on_error) {
                revert ContractError(ERROR_PACKET_EMPTY);
            }
            return (false, ERROR_PACKET_EMPTY);
        }

        if (!packet[0].key.equal(TYPE_KEY)) {
            if (revert_on_error) {
                revert ContractError(ERROR_TYPE_KEY_NOT_FIRST);
            }
            return (false, ERROR_TYPE_KEY_NOT_FIRST);
        }
        // Keys after "type" must be sorted
        (bool is_sorted, string memory reason) = isSorted(packet, 1, revert_on_error);
        if (!is_sorted) {
            return (false, reason);
        }

        return (true, "");
    }

    function isSorted(NormalizedPacket[] memory packet, uint256 start_index, bool revert_on_error)
        internal
        pure
        returns (bool, string memory reason)
    {
        for (uint256 i = start_index; i < packet.length - 1; i++) {
            if (packet[i].key.compare(packet[i + 1].key) > 0) {
                if (revert_on_error) {
                    revert ContractError(ERROR_PACKETS_NOT_SORTED);
                }
                return (false, ERROR_PACKETS_NOT_SORTED);
            }
        }
        return (true, "");
    }

    /**
     * @notice Converts a normalized packet to a keccak256 hash
     * @dev Converts a normalized packet to a keccak256 hash
     * @param packet The normalized packet
     * @return The keccak256 hash of the normalized packet
     */
    function toKeccak256(NormalizedPacket[] memory packet) internal pure returns (bytes32) {
        bytes32 packet_data_hash = keccak256(abi.encode(packet));
        /// forge-lint: disable-line(asm-keccak256)
        return packet_data_hash;
    }

    function toBytes(NormalizedPacket[] memory packet) internal pure returns (bytes memory) {
        return abi.encode(packet);
    }
}

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

import { TokenLib } from "src/types/Token.sol";

interface IFundManager {
    error InsufficientFunds();

    event FundManagerInitialized(address factory);
    event FundsWithdrawn(uint256 amount, TokenLib.TokenType denom);

    function initialize() external;

    // ------------------------------------------------------------------------
    // Withdrawal Functions
    // ------------------------------------------------------------------------
    /**
     * @notice Withdraw funds from the fund manager to the factory
     * @param amount The total amount requested to withdraw.
     * @param denom The enum type of the requested token (Native or Smart).
     */
    function withdraw(uint256 amount, TokenLib.TokenType memory denom) external;

    // ------------------------------------------------------------------------
    // View / Query Functions
    // ------------------------------------------------------------------------

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

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

import { PausableUtilStorage as Storage } from "./Storage.sol";

/// @title PausableUtil
/// @notice Handles the pausable functionality
abstract contract PausableUtil {
    /// @notice Thrown when the caller is not authorized to pause
    error NotAuthorizedToPause();

    /**
     * @notice Checks if the contract is not paused
     * @dev Reverts if the contract is paused
     */
    function _requireContractNotPaused() internal view {
        require(!Storage.contract_paused(), Storage.ErrorIsPausedByLabel("contract"));
    }

    /**
     * @notice Checks if a function selector is not paused
     * @dev Reverts if the function selector is paused
     * @param function_selector The function selector to check
     */
    function _requireSelectorNotPaused(bytes4 function_selector) internal view {
        require(!Storage.paused_selector(function_selector), Storage.ErrorIsPaused(function_selector));
    }

    /**
     * @notice Checks if a label is not paused
     * @dev Reverts if the label is paused
     * @param label The label to check
     */
    function _requireLabelNotPaused(string memory label) internal view {
        require(!Storage.paused_by_label(label), Storage.ErrorIsPausedByLabel(label));
    }

    // -------------------------------------------------------------------------
    // Pause Modifiers
    // -------------------------------------------------------------------------

    /**
     * @notice Modifier to ensure contract is not paused
     * @dev Reverts if the contract is paused
     */
    modifier whenContractNotPaused() {
        _requireContractNotPaused();
        _;
    }

    /**
     * @notice Modifier to ensure function selector is not paused
     * @dev Reverts if the function selector is paused
     * @param function_selector The function selector to check
     */
    modifier whenSelectorNotPaused(bytes4 function_selector) {
        _requireSelectorNotPaused(function_selector);
        _;
    }

    /**
     * @notice Modifier to ensure label is not paused
     * @dev Reverts if the label is paused
     * @param label The label to check
     */
    modifier whenLabelNotPaused(string memory label) {
        _requireLabelNotPaused(label);
        _;
    }

    /**
     * @notice Modifier to ensure contract, function, and label are not paused
     * @dev Reverts if any of the pause conditions are met
     * @param function_selector The function selector to check
     * @param label The label to check
     */
    modifier whenNotPaused(bytes4 function_selector, string memory label) {
        _whenNotPaused(function_selector, label);
        _;
    }

    function _whenNotPaused(bytes4 function_selector, string memory label) internal view {
        _requireContractNotPaused();
        _requireSelectorNotPaused(function_selector);
        _requireLabelNotPaused(label);
    }

    /**
     * @notice Modifier to ensure the caller is the pause admin
     * @dev Reverts if the caller is not the pause admin
     */
    modifier whenAuthorizedToPause() {
        _whenAuthorizedToPause();
        _;
    }

    function _whenAuthorizedToPause() internal view {
        require(msg.sender == Storage.pause_admin(), NotAuthorizedToPause());
    }

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------

    function is_selector_paused(bytes4 function_selector) external view virtual returns (bool) {
        return Storage.paused_selector(function_selector);
    }

    function is_label_paused(string memory label) external view virtual returns (bool) {
        return Storage.paused_by_label(label);
    }

    function is_contract_paused() external view virtual returns (bool) {
        return Storage.contract_paused();
    }

    function pause_selector(bytes4 function_selector) external virtual whenAuthorizedToPause {
        Storage.set_paused_selector(function_selector, true);
    }

    function unpause_selector(bytes4 function_selector) external virtual whenAuthorizedToPause {
        Storage.set_paused_selector(function_selector, false);
    }

    function pause_label(string memory label) external virtual whenAuthorizedToPause {
        Storage.set_paused_by_label(label, true);
    }

    function unpause_label(string memory label) external virtual whenAuthorizedToPause {
        Storage.set_paused_by_label(label, false);
    }

    function pause_contract() external virtual whenAuthorizedToPause {
        Storage.set_contract_paused(true);
    }

    function unpause_contract() external virtual whenAuthorizedToPause {
        Storage.set_contract_paused(false);
    }

    function set_pause_admin(address pause_admin) internal {
        Storage.set_pause_admin(pause_admin);
    }

    function get_pause_admin() external view returns (address) {
        return Storage.pause_admin();
    }
}

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

// Internal imports
import { FactoryStorage } from "./Storage.sol";

/**
 * @title IFactoryContract
 * @notice Interface for the Euclid factory contract
 * @dev This interface defines the contract for the main factory contract,
 *      including initialization parameters and events. It serves as the
 *      central hub for all protocol modules.
 * @author Euclid Protocol
 */
interface IFactoryContract {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /**
     * @notice Represents the module addresses for the factory
     * @param cross_chain_module Address of the cross-chain module
     * @param pool_module Address of the pool module
     * @param swap_module Address of the swap module
     * @param token_module Address of the token module
     */
    struct FactoryModules {
        address cross_chain_module;
        address pool_module;
        address swap_module;
        address token_module;
    }

    /**
     * @notice Parameters for initializing the factory contract
     * @param factory_state The state parameters for the factory
     * @param factory_modules The module addresses for the factory
     */
    struct FactoryInitializeParams {
        string chain_uid;
        string router_address;
        string native_denom;
        address fund_manager_implementation;
        address token_escrow_implementation;
        address lp_token_implementation;
        address relayer;
        FactoryModules factory_modules;
    }

    // -------------------------------------------------------------------------
    // Events
    // -------------------------------------------------------------------------

    /**
     * @notice Emitted when the factory is successfully initialized
     * @param router_address The VSL router address
     * @param chain_uid The unique chain identifier
     */
    event FactoryInitialized(string router_address, string chain_uid);

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Initializes the factory contract with all required modules
     * @dev This function sets up the factory state and initializes all module wrappers.
     *      It must be called exactly once during contract deployment.
     * @param params The initialization parameters containing factory state and module addresses
     *
     * @custom:requirements
     * - Must be called exactly once (initializer modifier)
     * - All module addresses must be valid non-zero addresses
     * - Chain UID and router address must be provided
     */
    function initialize(FactoryInitializeParams calldata params) external;

    /**
     * @notice Returns the factory state
     * @return The factory state
     */
    function get_factory_state() external pure returns (FactoryStorage.Layout memory);

    /**
     * @notice Returns the factory modules
     * @return The factory modules
     */
    function get_factory_modules() external view returns (FactoryModules memory);
}

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

import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";

/// @title ICrossChainModule
/// @notice Interface for cross-chain packet receiving and acknowledgment
interface ICrossChainModule {
    // Events
    event AcknowledgmentErrorString(string ack);
    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Receives a packet from another chain.
    /// @param source_port The port from which the packet was sent. Verify it for router port like vsl.router_address
    /// @param destination_port The port to which the packet is sent. Verify it for self port
    /// @param msg_ The message payload being sent.
    /// @param sequence The sequence number of the packet.
    /// @param timeout The timeout for the packet.

    function receivePacket(
        string calldata source_port,
        string calldata destination_port,
        NormalizedPacketLib.NormalizedPacket[] calldata msg_,
        uint256 sequence,
        uint256 timeout
    ) external;

    /// @notice Acknowledges a packet from another chain.
    /// @param source_port The port from which the packet was sent. Verify it for router port like vsl.router_address
    /// @param destination_port The port to which the packet is sent. Verify it for self port
    /// @param msg_ The message payload being sent.
    /// @param packet_sequence The sequence number of the packet.
    /// @param acknowledgment The acknowledgment payload.
    function acknowledgePacket(
        string calldata source_port,
        string calldata destination_port,
        NormalizedPacketLib.NormalizedPacket[] calldata msg_,
        uint256 packet_sequence,
        NormalizedPacketLib.NormalizedPacket[] calldata acknowledgment
    ) external;
}

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

pragma solidity ^0.8.24;

import {Math} from "./math/Math.sol";

/**
 * @dev Bytes operations.
 */
library Bytes {
    /**
     * @dev Forward search for `s` in `buffer`
     * * If `s` is present in the buffer, returns the index of the first instance
     * * If `s` is not present in the buffer, returns type(uint256).max
     *
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf[Javascript's `Array.indexOf`]
     */
    function indexOf(bytes memory buffer, bytes1 s) internal pure returns (uint256) {
        return indexOf(buffer, s, 0);
    }

    /**
     * @dev Forward search for `s` in `buffer` starting at position `pos`
     * * If `s` is present in the buffer (at or after `pos`), returns the index of the next instance
     * * If `s` is not present in the buffer (at or after `pos`), returns type(uint256).max
     *
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf[Javascript's `Array.indexOf`]
     */
    function indexOf(bytes memory buffer, bytes1 s, uint256 pos) internal pure returns (uint256) {
        uint256 length = buffer.length;
        for (uint256 i = pos; i < length; ++i) {
            if (bytes1(_unsafeReadBytesOffset(buffer, i)) == s) {
                return i;
            }
        }
        return type(uint256).max;
    }

    /**
     * @dev Backward search for `s` in `buffer`
     * * If `s` is present in the buffer, returns the index of the last instance
     * * If `s` is not present in the buffer, returns type(uint256).max
     *
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf[Javascript's `Array.lastIndexOf`]
     */
    function lastIndexOf(bytes memory buffer, bytes1 s) internal pure returns (uint256) {
        return lastIndexOf(buffer, s, type(uint256).max);
    }

    /**
     * @dev Backward search for `s` in `buffer` starting at position `pos`
     * * If `s` is present in the buffer (at or before `pos`), returns the index of the previous instance
     * * If `s` is not present in the buffer (at or before `pos`), returns type(uint256).max
     *
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf[Javascript's `Array.lastIndexOf`]
     */
    function lastIndexOf(bytes memory buffer, bytes1 s, uint256 pos) internal pure returns (uint256) {
        unchecked {
            uint256 length = buffer.length;
            for (uint256 i = Math.min(Math.saturatingAdd(pos, 1), length); i > 0; --i) {
                if (bytes1(_unsafeReadBytesOffset(buffer, i - 1)) == s) {
                    return i - 1;
                }
            }
            return type(uint256).max;
        }
    }

    /**
     * @dev Copies the content of `buffer`, from `start` (included) to the end of `buffer` into a new bytes object in
     * memory.
     *
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice[Javascript's `Array.slice`]
     */
    function slice(bytes memory buffer, uint256 start) internal pure returns (bytes memory) {
        return slice(buffer, start, buffer.length);
    }

    /**
     * @dev Copies the content of `buffer`, from `start` (included) to `end` (excluded) into a new bytes object in
     * memory. The `end` argument is truncated to the length of the `buffer`.
     *
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice[Javascript's `Array.slice`]
     */
    function slice(bytes memory buffer, uint256 start, uint256 end) internal pure returns (bytes memory) {
        // sanitize
        end = Math.min(end, buffer.length);
        start = Math.min(start, end);

        // allocate and copy
        bytes memory result = new bytes(end - start);
        assembly ("memory-safe") {
            mcopy(add(result, 0x20), add(add(buffer, 0x20), start), sub(end, start))
        }

        return result;
    }

    /**
     * @dev Moves the content of `buffer`, from `start` (included) to the end of `buffer` to the start of that buffer.
     *
     * NOTE: This function modifies the provided buffer in place. If you need to preserve the original buffer, use {slice} instead
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice[Javascript's `Array.splice`]
     */
    function splice(bytes memory buffer, uint256 start) internal pure returns (bytes memory) {
        return splice(buffer, start, buffer.length);
    }

    /**
     * @dev Moves the content of `buffer`, from `start` (included) to end (excluded) to the start of that buffer. The
     * `end` argument is truncated to the length of the `buffer`.
     *
     * NOTE: This function modifies the provided buffer in place. If you need to preserve the original buffer, use {slice} instead
     * NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice[Javascript's `Array.splice`]
     */
    function splice(bytes memory buffer, uint256 start, uint256 end) internal pure returns (bytes memory) {
        // sanitize
        end = Math.min(end, buffer.length);
        start = Math.min(start, end);

        // allocate and copy
        assembly ("memory-safe") {
            mcopy(add(buffer, 0x20), add(add(buffer, 0x20), start), sub(end, start))
            mstore(buffer, sub(end, start))
        }

        return buffer;
    }

    /**
     * @dev Replaces bytes in `buffer` starting at `pos` with all bytes from `replacement`.
     *
     * Parameters are clamped to valid ranges (i.e. `pos` is clamped to `[0, buffer.length]`).
     * If `pos >= buffer.length`, no replacement occurs and the buffer is returned unchanged.
     *
     * NOTE: This function modifies the provided buffer in place.
     */
    function replace(bytes memory buffer, uint256 pos, bytes memory replacement) internal pure returns (bytes memory) {
        return replace(buffer, pos, replacement, 0, replacement.length);
    }

    /**
     * @dev Replaces bytes in `buffer` starting at `pos` with bytes from `replacement` starting at `offset`.
     * Copies at most `length` bytes from `replacement` to `buffer`.
     *
     * Parameters are clamped to valid ranges (i.e. `pos` is clamped to `[0, buffer.length]`, `offset` is
     * clamped to `[0, replacement.length]`, and `length` is clamped to `min(length, replacement.length - offset,
     * buffer.length - pos))`. If `pos >= buffer.length` or `offset >= replacement.length`, no replacement occurs
     * and the buffer is returned unchanged.
     *
     * NOTE: This function modifies the provided buffer in place.
     */
    function replace(
        bytes memory buffer,
        uint256 pos,
        bytes memory replacement,
        uint256 offset,
        uint256 length
    ) internal pure returns (bytes memory) {
        // sanitize
        pos = Math.min(pos, buffer.length);
        offset = Math.min(offset, replacement.length);
        length = Math.min(length, Math.min(replacement.length - offset, buffer.length - pos));

        // allocate and copy
        assembly ("memory-safe") {
            mcopy(add(add(buffer, 0x20), pos), add(add(replacement, 0x20), offset), length)
        }

        return buffer;
    }

    /**
     * @dev Concatenate an array of bytes into a single bytes object.
     *
     * For fixed bytes types, we recommend using the solidity built-in `bytes.concat` or (equivalent)
     * `abi.encodePacked`.
     *
     * NOTE: this could be done in assembly with a single loop that expands starting at the FMP, but that would be
     * significantly less readable. It might be worth benchmarking the savings of the full-assembly approach.
     */
    function concat(bytes[] memory buffers) internal pure returns (bytes memory) {
        uint256 length = 0;
        for (uint256 i = 0; i < buffers.length; ++i) {
            length += buffers[i].length;
        }

        bytes memory result = new bytes(length);

        uint256 offset = 0x20;
        for (uint256 i = 0; i < buffers.length; ++i) {
            bytes memory input = buffers[i];
            assembly ("memory-safe") {
                mcopy(add(result, offset), add(input, 0x20), mload(input))
            }
            unchecked {
                offset += input.length;
            }
        }

        return result;
    }

    /**
     * @dev Split each byte in `input` into two nibbles (4 bits each)
     *
     * Example: hex"01234567" → hex"0001020304050607"
     */
    function toNibbles(bytes memory input) internal pure returns (bytes memory output) {
        assembly ("memory-safe") {
            let length := mload(input)
            output := mload(0x40)
            mstore(0x40, add(add(output, 0x20), mul(length, 2)))
            mstore(output, mul(length, 2))
            for {
                let i := 0
            } lt(i, length) {
                i := add(i, 0x10)
            } {
                let chunk := shr(128, mload(add(add(input, 0x20), i)))
                chunk := and(
                    0x0000000000000000ffffffffffffffff0000000000000000ffffffffffffffff,
                    or(shl(64, chunk), chunk)
                )
                chunk := and(
                    0x00000000ffffffff00000000ffffffff00000000ffffffff00000000ffffffff,
                    or(shl(32, chunk), chunk)
                )
                chunk := and(
                    0x0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff,
                    or(shl(16, chunk), chunk)
                )
                chunk := and(
                    0x00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff,
                    or(shl(8, chunk), chunk)
                )
                chunk := and(
                    0x0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f,
                    or(shl(4, chunk), chunk)
                )
                mstore(add(add(output, 0x20), mul(i, 2)), chunk)
            }
        }
    }

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

    /**
     * @dev Reverses the byte order of a bytes32 value, converting between little-endian and big-endian.
     * Inspired by https://graphics.stanford.edu/~seander/bithacks.html#ReverseParallel[Reverse Parallel]
     */
    function reverseBytes32(bytes32 value) internal pure returns (bytes32) {
        value = // swap bytes
            ((value >> 8) & 0x00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF) |
            ((value & 0x00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF) << 8);
        value = // swap 2-byte long pairs
            ((value >> 16) & 0x0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF) |
            ((value & 0x0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF) << 16);
        value = // swap 4-byte long pairs
            ((value >> 32) & 0x00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF) |
            ((value & 0x00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF) << 32);
        value = // swap 8-byte long pairs
            ((value >> 64) & 0x0000000000000000FFFFFFFFFFFFFFFF0000000000000000FFFFFFFFFFFFFFFF) |
            ((value & 0x0000000000000000FFFFFFFFFFFFFFFF0000000000000000FFFFFFFFFFFFFFFF) << 64);
        return (value >> 128) | (value << 128); // swap 16-byte long pairs
    }

    /// @dev Same as {reverseBytes32} but optimized for 128-bit values.
    function reverseBytes16(bytes16 value) internal pure returns (bytes16) {
        value = // swap bytes
            ((value & 0xFF00FF00FF00FF00FF00FF00FF00FF00) >> 8) | ((value & 0x00FF00FF00FF00FF00FF00FF00FF00FF) << 8);
        value = // swap 2-byte long pairs
            ((value & 0xFFFF0000FFFF0000FFFF0000FFFF0000) >> 16) | ((value & 0x0000FFFF0000FFFF0000FFFF0000FFFF) << 16);
        value = // swap 4-byte long pairs
            ((value & 0xFFFFFFFF00000000FFFFFFFF00000000) >> 32) | ((value & 0x00000000FFFFFFFF00000000FFFFFFFF) << 32);
        return (value >> 64) | (value << 64); // swap 8-byte long pairs
    }

    /// @dev Same as {reverseBytes32} but optimized for 64-bit values.
    function reverseBytes8(bytes8 value) internal pure returns (bytes8) {
        value = ((value & 0xFF00FF00FF00FF00) >> 8) | ((value & 0x00FF00FF00FF00FF) << 8); // swap bytes
        value = ((value & 0xFFFF0000FFFF0000) >> 16) | ((value & 0x0000FFFF0000FFFF) << 16); // swap 2-byte long pairs
        return (value >> 32) | (value << 32); // swap 4-byte long pairs
    }

    /// @dev Same as {reverseBytes32} but optimized for 32-bit values.
    function reverseBytes4(bytes4 value) internal pure returns (bytes4) {
        value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8); // swap bytes
        return (value >> 16) | (value << 16); // swap 2-byte long pairs
    }

    /// @dev Same as {reverseBytes32} but optimized for 16-bit values.
    function reverseBytes2(bytes2 value) internal pure returns (bytes2) {
        return (value >> 8) | (value << 8);
    }

    /**
     * @dev Counts the number of leading zero bits a bytes array. Returns `8 * buffer.length`
     * if the buffer is all zeros.
     */
    function clz(bytes memory buffer) internal pure returns (uint256) {
        for (uint256 i = 0; i < buffer.length; i += 0x20) {
            bytes32 chunk = _unsafeReadBytesOffset(buffer, i);
            if (chunk != bytes32(0)) {
                return Math.min(8 * i + Math.clz(uint256(chunk)), 8 * buffer.length);
            }
        }
        return 8 * buffer.length;
    }

    /**
     * @dev Reads a bytes32 from a bytes array without bounds checking.
     *
     * NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
     * assembly block as such would prevent some optimizations.
     */
    function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
        // This is not memory safe in the general case, but all calls to this private function are within bounds.
        assembly ("memory-safe") {
            value := mload(add(add(buffer, 0x20), offset))
        }
    }
}

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

import { Strings } from "openzeppelin-contracts/contracts/utils/Strings.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";
import { StringsUtil } from "src/utils/Strings.sol";
import { TokenLib } from "src/types/Token.sol";

/// @title CrossChainConfigLibrary
/// @notice Library for handling cross-chain config
library CrossChainConfigLibrary {
    using Strings for *;
    using StringsUtil for *;
    using CrossChainConfigLibrary for *;
    using NormalizedPacketLib for *;

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @notice Struct representing a cross-chain user
    /// @param chain_uid The chain UID
    /// @param sender The lowercase sender address as a string
    struct CrossChainConfig {
        uint256 timeout;
        bytes ack_response;
        string meta;
    }

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Converts an address and chain UID to a CrossChainUser struct
    /// @param timeout The timeout for the cross-chain config
    /// @param ack_response The ack response for the cross-chain config
    /// @param meta The meta for the cross-chain config
    /// @return The CrossChainUser struct
    function toCrossChainConfig(uint256 timeout, bytes memory ack_response, string memory meta)
        internal
        pure
        returns (CrossChainConfig memory)
    {
        return CrossChainConfig({ timeout: timeout, ack_response: ack_response, meta: meta });
    }

    function toNormalizedPacket(CrossChainConfig memory config, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](0);
        if (config.timeout > 0) {
            normalized_packet = normalized_packet.push(
                NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "timeout"), config.timeout.toString())
            );
        }
        if (bytes(config.ack_response).length > 0) {
            normalized_packet = normalized_packet.push(
                NormalizedPacketLib.NormalizedPacket(
                    string.concat(prefix, "ack_response"), string(abi.encodePacked(config.ack_response))
                )
            );
        }
        if (bytes(config.meta).length > 0) {
            normalized_packet = normalized_packet.push(
                NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "meta"), config.meta)
            );
        }
        return normalized_packet;
    }

    function empty() internal pure returns (CrossChainConfig memory) {
        return CrossChainConfig({ timeout: 0, ack_response: bytes(""), meta: "" });
    }

    function parseCrossChainConfig(NormalizedPacketLib.HashedNormalizedPacket[] memory packet, string memory prefix)
        internal
        pure
        returns (CrossChainConfig memory)
    {
        string memory timeout_string = packet.findKey(string.concat(prefix, ".timeout"));
        (bool success, uint256 timeout) = Strings.tryParseUint(timeout_string);
        if (!success) {
            timeout = 0;
        }
        bytes memory ack_response = bytes(packet.findKey(string.concat(prefix, ".ack_response")));
        string memory meta = packet.findKey(string.concat(prefix, ".meta"));
        return CrossChainConfig({ timeout: timeout, ack_response: ack_response, meta: meta });
    }
}

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

library CrossChainModuleStorage {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------
    /// @custom:storage-location erc7201:euclid.storage.factory.modules.pool
    /// @notice Layout for pool module
    /// @param module_address The address of the module
    /// @param authorized_port The authorized port for receiving packets
    /// @param self_port The self port for sending packets
    struct Layout {
        address module_address;
        string authorized_port; // vsl.router_address
        string self_port; // chain_uid.factory_address
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------
    string private constant _NAMESPACE = "euclid.storage.factory.modules.cross_chain";
    string private constant _VERSION = "0.1.0";
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------
    /// @notice Returns the storage layout for token escrow
    /// @return l The storage layout
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    /// @notice Returns the storage layout for the module
    /// @return l The storage layout
    function mut_module_state() internal pure returns (Layout storage l) {
        Layout storage s = _layout();
        return s;
    }

    /// @notice Returns the storage layout for the module
    /// @return l The storage layout
    function read_module_state() internal pure returns (Layout memory l) {
        Layout storage s = _layout();
        return s;
    }

    function set_module_address(address module_address) internal {
        _layout().module_address = module_address;
    }

    function get_module_address() internal view returns (address) {
        return _layout().module_address;
    }

    /// @notice Returns the authorized port for receiving packets
    /// @return l The authorized port
    function read_router_port() internal view returns (string memory l) {
        Layout storage s = _layout();
        return s.authorized_port;
    }

    /// @notice Returns the self port for sending packets
    /// @return l The self port
    function read_self_port() internal view returns (string memory l) {
        Layout storage s = _layout();
        return s.self_port;
    }
}

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

/**
 * @title SwapModuleStorage
 * @notice Storage library for the Swap module using ERC-7201 namespaced storage
 * @dev This library manages the storage layout for the swap module, including
 *      module address. Uses ERC-7201 for
 *      collision-resistant storage namespacing.
 * @author Euclid Protocol
 */
library SwapModuleStorage {
    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /**
     * @notice Storage layout for the swap module
     * @dev Uses ERC-7201 namespaced storage to prevent storage collisions
     * @custom:storage-location erc7201:euclid.storage.factory.modules.swap
     */
    struct Layout {
        /// @notice Address of the swap module implementation
        address module_address;
    }

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------

    /// @notice Storage namespace for collision resistance
    string private constant _NAMESPACE = "euclid.storage.factory.modules.swap";

    /// @notice Version identifier for storage layout
    string private constant _VERSION = "0.1.0";

    /// @notice Storage slot calculated from namespace hash
    bytes32 private constant _SLOT =
        keccak256(abi.encode(uint256(keccak256(abi.encodePacked(_NAMESPACE))) - 1)) & ~bytes32(uint256(0xff));

    // -------------------------------------------------------------------------
    // Internal Functions
    // -------------------------------------------------------------------------

    /**
     * @notice Returns the storage layout for the swap module
     * @dev Uses assembly to access the namespaced storage slot
     * @return l The storage layout reference
     */
    function _layout() private pure returns (Layout storage l) {
        bytes32 slot = _SLOT;
        assembly {
            l.slot := slot
        }
    }

    // -------------------------------------------------------------------------
    // Module Address Management
    // -------------------------------------------------------------------------

    /**
     * @notice Sets the swap module implementation address
     * @dev Only callable by authorized contracts
     * @param module_address The address of the swap module implementation
     */
    function set_module_address(address module_address) internal {
        _layout().module_address = module_address;
    }

    /**
     * @notice Gets the current swap module implementation address
     * @return The address of the swap module implementation
     */
    function get_module_address() internal view returns (address) {
        return _layout().module_address;
    }
}

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

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

// Internal imports
import { StringsUtil } from "src/utils/Strings.sol";
import { NormalizedPacketLib } from "src/types/NormalizedPacket.sol";

/**
 * @title TokenLib
 * @notice Library for token-related functionality and validation
 * @dev This library provides comprehensive token handling capabilities including
 *      validation, type checking, and conversion between different token formats.
 *      Supports native tokens, ERC20 tokens, and voucher tokens.
 * @author Euclid Protocol
 */
library TokenLib {
    // -------------------------------------------------------------------------
    // Libraries
    // -------------------------------------------------------------------------
    using Strings for *;
    using TokenLib for *;
    using NormalizedPacketLib for *;
    using StringsUtil for *;

    // -------------------------------------------------------------------------
    // Errors
    // -------------------------------------------------------------------------

    /// @notice Thrown when token ID is empty
    error EmptyTokenId();

    /// @notice Thrown when token ID exceeds maximum allowed length
    error TokenIdTooLong();

    /// @notice Thrown when token ID contains invalid characters
    error InvalidCharacter(bytes1 character);

    /// @notice Thrown when token type is invalid
    error InvalidTokenType();

    /// @notice Thrown when token type is empty
    error EmptyTokenType();

    /// @notice Thrown when token is not a native type
    error NotNativeTokenType();

    /// @notice Thrown when token is not a smart (ERC20) type
    error NotSmartTokenType();

    /// @notice Thrown when token is not a voucher type
    error NotVoucherTokenType();

    /// @notice Thrown when native denomination is invalid
    error InvalidNativeDenom();

    /// @notice Thrown when ERC20 address is invalid
    error InvalidErc20Address();

    /// @notice Thrown when token pair order is invalid
    error InvalidPairOrder();

    // -------------------------------------------------------------------------
    // Constants
    // -------------------------------------------------------------------------

    /// @notice Literal string for native token type
    string public constant NATIVE_TOKEN_LITERAL = "native";

    /// @notice Literal string for smart (ERC20) token type
    string public constant SMART_TOKEN_LITERAL = "smart";

    /// @notice Literal string for voucher token type
    string public constant VOUCHER_TOKEN_LITERAL = "voucher";

    // -------------------------------------------------------------------------
    // Structs
    // -------------------------------------------------------------------------

    /**
     * @notice Represents the type and configuration of a token
     * @param token_type The type of token (native, smart, or voucher)
     * @param native_denom The denomination for native tokens (e.g., "ETH", "MATIC")
     * @param erc20_address The contract address for ERC20 tokens
     */
    struct TokenType {
        string token_type;
        string native_denom;
        string erc20_address;
    }

    /**
     * @notice Represents a token with its type and denomination information
     * @param token The token identifier/symbol
     * @param token_type The type information for the token
     */
    struct TokenWithDenom {
        string token;
        TokenType token_type;
    }

    /**
     * @notice Represents a token with denomination and amount information
     * @param token The token identifier/symbol
     * @param amount The token amount in smallest unit
     * @param token_type The type information for the token
     */
    struct TokenWithDenomAndAmount {
        string token;
        uint256 amount;
        TokenType token_type;
    }

    // -------------------------------------------------------------------------
    // Functions
    // -------------------------------------------------------------------------

    function equal(TokenType memory token_type, TokenType memory other_token_type) internal pure returns (bool) {
        return token_type.token_type.equal(other_token_type.token_type)
            && token_type.native_denom.equal(other_token_type.native_denom)
            && token_type.erc20_address.equal(other_token_type.erc20_address);
    }

    function denomKey(TokenType memory token_type) internal pure returns (string memory) {
        if (token_type.isVoucher()) {
            return string.concat("voucher");
        } else if (token_type.isSmart()) {
            return string.concat("smart:", token_type.erc20_address);
        } else if (token_type.isNative()) {
            return string.concat("native:", token_type.native_denom);
        }
        revert InvalidTokenType();
    }

    /// @notice Checks if a token type is empty
    /// @param token_type The token type to check
    /// @return True if token type is empty
    function isTokenTypeEmpty(TokenType memory token_type) internal pure returns (bool) {
        return token_type.token_type.equal("");
    }

    /// @notice Checks if a token is a voucher type
    /// @param token_type The token type to check
    /// @return True if token is voucher type
    function isVoucher(TokenType memory token_type) internal pure returns (bool) {
        return token_type.token_type.equal(VOUCHER_TOKEN_LITERAL);
    }

    /// @notice Checks if a token is a smart type
    /// @param token_type The token type to check
    /// @return True if token is smart type
    function isSmart(TokenType memory token_type) internal pure returns (bool) {
        return token_type.token_type.equal(SMART_TOKEN_LITERAL);
    }

    /// @notice Checks if a token is a native type
    /// @param token_type The token type to check
    /// @return True if token is native type
    function isNative(TokenType memory token_type) internal pure returns (bool) {
        return token_type.token_type.equal(NATIVE_TOKEN_LITERAL);
    }

    function validateTokenId(string memory token_id) internal pure returns (bool) {
        return validateTokenId(token_id, false);
    }

    /// @notice Validates a token id
    /// @param token_id The token id to validate
    /// @dev The token id must be a valid string of at most 64 characters
    /// @dev The token id must only contain alphanumeric characters and dots
    /// @dev The token id must not be empty
    /// @dev The token id must not be too long
    function validateTokenId(string memory token_id, bool revert_on_error) internal pure returns (bool) {
        bytes memory b = bytes(token_id);
        if (b.length == 0) {
            if (revert_on_error) {
                revert EmptyTokenId();
            }
            return false;
        }
        if (b.length > 64) {
            if (revert_on_error) {
                revert TokenIdTooLong();
            }
            return false;
        }
        for (uint256 i = 0; i < b.length;) {
            bytes1 c = b[i];
            // Check if character is numeric (0-9), lowercase (a-z) or dot (.)
            if (!((c >= 0x30 && c <= 0x39) || (c >= 0x61 && c <= 0x7a) || c == 0x2e)) {
                if (revert_on_error) {
                    revert InvalidCharacter(c);
                }
                return false;
            }
            unchecked {
                ++i;
            }
        }
        return true;
    }

    function validate(TokenType memory token_type) internal pure returns (bool) {
        return validate(token_type, false);
    }

    function validate(TokenType memory token_type, bool revert_on_error) internal pure returns (bool) {
        if (token_type.isTokenTypeEmpty()) {
            if (revert_on_error) {
                revert EmptyTokenType();
            }
            return false;
        }
        if (token_type.isNative()) {
            return validateNativeTokenType(token_type, revert_on_error);
        } else if (token_type.isSmart()) {
            return validateSmartTokenType(token_type, revert_on_error);
        } else if (token_type.isVoucher()) {
            return validateVoucherTokenType(token_type, revert_on_error);
        } else {
            if (revert_on_error) {
                revert InvalidTokenType();
            }
            return false;
        }
    }

    function validateNativeTokenType(TokenType memory token_type) internal pure returns (bool) {
        return validateNativeTokenType(token_type, false);
    }

    function validateNativeTokenType(TokenType memory token_type, bool revert_on_error) internal pure returns (bool) {
        if (!token_type.isNative()) {
            if (revert_on_error) {
                revert NotNativeTokenType();
            }
            return false;
        }
        if (bytes(token_type.native_denom).length == 0) {
            if (revert_on_error) {
                revert InvalidNativeDenom();
            }
            return false;
        }
        return true;
    }

    function validateSmartTokenType(TokenType memory token_type) internal pure returns (bool) {
        return validateSmartTokenType(token_type, false);
    }

    function validateSmartTokenType(TokenType memory token_type, bool revert_on_error) internal pure returns (bool) {
        if (!token_type.isSmart()) {
            if (revert_on_error) {
                revert NotSmartTokenType();
            }
            return false;
        }
        if (token_type.erc20_address.equal("")) {
            if (revert_on_error) {
                revert InvalidErc20Address();
            }
            return false;
        }
        return true;
    }

    function validateVoucherTokenType(TokenType memory token_type) internal pure returns (bool) {
        return validateVoucherTokenType(token_type, false);
    }

    function validateVoucherTokenType(TokenType memory token_type, bool revert_on_error) internal pure returns (bool) {
        if (!token_type.isVoucher()) {
            if (revert_on_error) {
                revert NotVoucherTokenType();
            }
            return false;
        }
        if (!token_type.native_denom.equal("")) {
            if (revert_on_error) {
                revert InvalidTokenType();
            }
            return false;
        }
        if (!token_type.erc20_address.equal("")) {
            if (revert_on_error) {
                revert InvalidTokenType();
            }
            return false;
        }
        return true;
    }

    function validate(TokenWithDenom memory token_with_denom) internal pure returns (bool) {
        return validate(token_with_denom, false);
    }

    function validate(TokenWithDenom memory token_with_denom, bool revert_on_error) internal pure returns (bool) {
        return token_with_denom.token_type.validate(revert_on_error)
            && token_with_denom.token.validateTokenId(revert_on_error);
    }

    function toTokenType(TokenWithDenom memory token_with_denom) internal pure returns (TokenType memory) {
        return TokenType({
            token_type: token_with_denom.token_type.token_type,
            native_denom: token_with_denom.token_type.native_denom,
            erc20_address: token_with_denom.token_type.erc20_address
        });
    }

    function toTokenWithDenom(TokenWithDenomAndAmount memory token_with_denom_and_amount)
        internal
        pure
        returns (TokenWithDenom memory)
    {
        return TokenWithDenom({
            token: token_with_denom_and_amount.token, token_type: token_with_denom_and_amount.token_type
        });
    }

    function toTokenWithDenomAndAmount(TokenWithDenom memory token_with_denom, uint256 amount)
        internal
        pure
        returns (TokenWithDenomAndAmount memory)
    {
        return TokenWithDenomAndAmount({
            token: token_with_denom.token, token_type: token_with_denom.token_type, amount: amount
        });
    }

    function toNormalizedPacket(TokenType memory token_type, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](1);
        if (isVoucher(token_type)) {
            normalized_packet[0] = NormalizedPacketLib.NormalizedPacket(
                string.concat(prefix, "voucher"), NormalizedPacketLib.EMPTY_OBJECT
            );
        } else if (isSmart(token_type)) {
            normalized_packet[0] = NormalizedPacketLib.NormalizedPacket(
                string.concat(prefix, "smart.contract_address"), token_type.erc20_address
            );
        } else if (isNative(token_type)) {
            normalized_packet[0] =
                NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "native.denom"), token_type.native_denom);
        }
        return normalized_packet;
    }

    function parseTokenType(NormalizedPacketLib.HashedNormalizedPacket[] memory packet, string memory prefix)
        internal
        pure
        returns (TokenType memory)
    {
        int256 native_denom_index = packet.findKeyIndex(string.concat(prefix, ".native.denom"));
        if (native_denom_index != -1) {
            return TokenType({
                token_type: NATIVE_TOKEN_LITERAL,
                native_denom: packet[uint256(native_denom_index)].value,
                /// forge-lint: disable-line(unsafe-typecast)
                erc20_address: ""
            });
        }
        int256 smart_contract_address_index = packet.findKeyIndex(string.concat(prefix, ".smart.contract_address"));
        if (smart_contract_address_index != -1) {
            return TokenType({
                token_type: SMART_TOKEN_LITERAL,
                native_denom: "",
                erc20_address: packet[uint256(smart_contract_address_index)].value
            });
            /// forge-lint: disable-line(unsafe-typecast)
        }
        int256 voucher_index = packet.findKeyIndex(string.concat(prefix, ".voucher"));
        if (voucher_index != -1) {
            return TokenType({ token_type: VOUCHER_TOKEN_LITERAL, native_denom: "", erc20_address: "" });
        }
        return TokenType({ token_type: "", native_denom: "", erc20_address: "" });
    }

    function toNormalizedPacket(TokenWithDenom memory token_with_denom, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](1);
        normalized_packet[0] =
            NormalizedPacketLib.NormalizedPacket(string.concat(prefix, "token"), token_with_denom.token);

        // Combine the normalized packet with the token type normalized packet
        normalized_packet = normalized_packet.concat(
            token_with_denom.toTokenType().toNormalizedPacket(string.concat(prefix, "token_type."))
        );
        return normalized_packet;
    }

    function toNormalizedPacket(TokenWithDenomAndAmount memory token_with_denom_and_amount, string memory prefix)
        internal
        pure
        returns (NormalizedPacketLib.NormalizedPacket[] memory)
    {
        NormalizedPacketLib.NormalizedPacket[] memory normalized_packet = new NormalizedPacketLib.NormalizedPacket[](1);
        normalized_packet[0] = NormalizedPacketLib.NormalizedPacket(
            string.concat(prefix, "amount"), token_with_denom_and_amount.amount.toString()
        );

        normalized_packet =
            normalized_packet.concat(token_with_denom_and_amount.toTokenWithDenom().toNormalizedPacket(prefix));

        return normalized_packet;
    }

    function toNativeToken(string memory token_id, string memory native_denom)
        internal
        pure
        returns (TokenWithDenom memory)
    {
        return TokenWithDenom({
            token: token_id,
            token_type: TokenType({ token_type: NATIVE_TOKEN_LITERAL, native_denom: native_denom, erc20_address: "" })
        });
    }

    function toSmartToken(string memory token_id, string memory erc20_address)
        internal
        pure
        returns (TokenWithDenom memory)
    {
        return TokenWithDenom({
            token: token_id,
            token_type: TokenType({ token_type: SMART_TOKEN_LITERAL, native_denom: "", erc20_address: erc20_address })
        });
    }

    function toVoucherToken(string memory token_id) internal pure returns (TokenWithDenom memory) {
        return TokenWithDenom({
            token: token_id,
            token_type: TokenType({ token_type: VOUCHER_TOKEN_LITERAL, native_denom: "", erc20_address: "" })
        });
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.

pragma solidity ^0.8.20;

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

    struct BooleanSlot {
        bool value;
    }

    struct Bytes32Slot {
        bytes32 value;
    }

    struct Uint256Slot {
        uint256 value;
    }

    struct Int256Slot {
        int256 value;
    }

    struct StringSlot {
        string value;
    }

    struct BytesSlot {
        bytes value;
    }

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

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

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

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

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

    /**
     * @dev Returns a `StringSlot` with member `value` located at `slot`.
     */
    function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
        assembly ("memory-safe") {
            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) {
        assembly ("memory-safe") {
            r.slot := store.slot
        }
    }

    /**
     * @dev Returns a `BytesSlot` with member `value` located at `slot`.
     */
    function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
        assembly ("memory-safe") {
            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) {
        assembly ("memory-safe") {
            r.slot := store.slot
        }
    }
}

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

pragma solidity ^0.8.20;

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

    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
    bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;

    /**
     * @dev The contract is already initialized.
     */
    error InvalidInitialization();

    /**
     * @dev The contract is not initializing.
     */
    error NotInitializing();

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

    /**
     * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
     * `onlyInitializing` functions can be used to initialize parent contracts.
     *
     * Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
     * number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
     * production.
     *
     * Emits an {Initialized} event.
     */
    modifier initializer() {
        // solhint-disable-next-line var-name-mixedcase
        InitializableStorage storage $ = _getInitializableStorage();

        // Cache values to avoid duplicated sloads
        bool isTopLevelCall = !$._initializing;
        uint64 initialized = $._initialized;

        // Allowed calls:
        // - initialSetup: the contract is not in the initializing state and no previous version was
        //                 initialized
        // - construction: the contract is initialized at version 1 (no reininitialization) and the
        //                 current contract is just being deployed
        bool initialSetup = initialized == 0 && isTopLevelCall;
        bool construction = initialized == 1 && address(this).code.length == 0;

        if (!initialSetup && !construction) {
            revert InvalidInitialization();
        }
        $._initialized = 1;
        if (isTopLevelCall) {
            $._initializing = true;
        }
        _;
        if (isTopLevelCall) {
            $._initializing = false;
            emit Initialized(1);
        }
    }

    /**
     * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
     * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
     * used to initialize parent contracts.
     *
     * A reinitializer may be used after the original initialization step. This is essential to configure modules that
     * are added through upgrades and that require initialization.
     *
     * When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
     * cannot be nested. If one is invoked in the context of another, execution will revert.
     *
     * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
     * a contract, executing them in the right order is up to the developer or operator.
     *
     * WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization.
     *
     * Emits an {Initialized} event.
     */
    modifier reinitializer(uint64 version) {
        // solhint-disable-next-line var-name-mixedcase
        InitializableStorage storage $ = _getInitializableStorage();

        if ($._initializing || $._initialized >= version) {
            revert InvalidInitialization();
        }
        $._initialized = version;
        $._initializing = true;
        _;
        $._initializing = false;
        emit Initialized(version);
    }

    /**
     * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
     * {initializer} and {reinitializer} modifiers, directly or indirectly.
     */
    modifier onlyInitializing() {
        _checkInitializing();
        _;
    }

    /**
     * @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
     */
    function _checkInitializing() internal view virtual {
        if (!_isInitializing()) {
            revert NotInitializing();
        }
    }

    /**
     * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
     * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
     * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
     * through proxies.
     *
     * Emits an {Initialized} event the first time it is successfully executed.
     */
    function _disableInitializers() internal virtual {
        // solhint-disable-next-line var-name-mixedcase
        InitializableStorage storage $ = _getInitializableStorage();

        if ($._initializing) {
            revert InvalidInitialization();
        }
        if ($._initialized != type(uint64).max) {
            $._initialized = type(uint64).max;
            emit Initialized(type(uint64).max);
        }
    }

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

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

    /**
     * @dev Returns a pointer to the storage namespace.
     */
    // solhint-disable-next-line var-name-mixedcase
    function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
        assembly {
            $.slot := INITIALIZABLE_STORAGE
        }
    }
}

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

pragma solidity ^0.8.20;

/**
 * @dev Library of low level call functions that implement different calling strategies to deal with the return data.
 *
 * WARNING: Using this library requires an advanced understanding of Solidity and how the EVM works. It is recommended
 * to use the {Address} library instead.
 */
library LowLevelCall {
    /// @dev Performs a Solidity function call using a low level `call` and ignoring the return data.
    function callNoReturn(address target, bytes memory data) internal returns (bool success) {
        return callNoReturn(target, 0, data);
    }

    /// @dev Same as {callNoReturn-address-bytes}, but allows specifying the value to be sent in the call.
    function callNoReturn(address target, uint256 value, bytes memory data) internal returns (bool success) {
        assembly ("memory-safe") {
            success := call(gas(), target, value, add(data, 0x20), mload(data), 0x00, 0x00)
        }
    }

    /// @dev Performs a Solidity function call using a low level `call` and returns the first 64 bytes of the result
    /// in the scratch space of memory. Useful for functions that return a tuple of single-word values.
    ///
    /// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
    /// and this function doesn't zero it out.
    function callReturn64Bytes(
        address target,
        bytes memory data
    ) internal returns (bool success, bytes32 result1, bytes32 result2) {
        return callReturn64Bytes(target, 0, data);
    }

    /// @dev Same as {callReturn64Bytes-address-bytes}, but allows specifying the value to be sent in the call.
    function callReturn64Bytes(
        address target,
        uint256 value,
        bytes memory data
    ) internal returns (bool success, bytes32 result1, bytes32 result2) {
        assembly ("memory-safe") {
            success := call(gas(), target, value, add(data, 0x20), mload(data), 0x00, 0x40)
            result1 := mload(0x00)
            result2 := mload(0x20)
        }
    }

    /// @dev Performs a Solidity function call using a low level `staticcall` and ignoring the return data.
    function staticcallNoReturn(address target, bytes memory data) internal view returns (bool success) {
        assembly ("memory-safe") {
            success := staticcall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x00)
        }
    }

    /// @dev Performs a Solidity function call using a low level `staticcall` and returns the first 64 bytes of the result
    /// in the scratch space of memory. Useful for functions that return a tuple of single-word values.
    ///
    /// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
    /// and this function doesn't zero it out.
    function staticcallReturn64Bytes(
        address target,
        bytes memory data
    ) internal view returns (bool success, bytes32 result1, bytes32 result2) {
        assembly ("memory-safe") {
            success := staticcall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x40)
            result1 := mload(0x00)
            result2 := mload(0x20)
        }
    }

    /// @dev Performs a Solidity function call using a low level `delegatecall` and ignoring the return data.
    function delegatecallNoReturn(address target, bytes memory data) internal returns (bool success) {
        assembly ("memory-safe") {
            success := delegatecall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x00)
        }
    }

    /// @dev Performs a Solidity function call using a low level `delegatecall` and returns the first 64 bytes of the result
    /// in the scratch space of memory. Useful for functions that return a tuple of single-word values.
    ///
    /// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
    /// and this function doesn't zero it out.
    function delegatecallReturn64Bytes(
        address target,
        bytes memory data
    ) internal returns (bool success, bytes32 result1, bytes32 result2) {
        assembly ("memory-safe") {
            success := delegatecall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x40)
            result1 := mload(0x00)
            result2 := mload(0x20)
        }
    }

    /// @dev Returns the size of the return data buffer.
    function returnDataSize() internal pure returns (uint256 size) {
        assembly ("memory-safe") {
            size := returndatasize()
        }
    }

    /// @dev Returns a buffer containing the return data from the last call.
    function returnData() internal pure returns (bytes memory result) {
        assembly ("memory-safe") {
            result := mload(0x40)
            mstore(result, returndatasize())
            returndatacopy(add(result, 0x20), 0x00, returndatasize())
            mstore(0x40, add(result, add(0x20, returndatasize())))
        }
    }

    /// @dev Revert with the return data from the last call.
    function bubbleRevert() internal pure {
        assembly ("memory-safe") {
            let fmp := mload(0x40)
            returndatacopy(fmp, 0x00, returndatasize())
            revert(fmp, returndatasize())
        }
    }

    function bubbleRevert(bytes memory returndata) internal pure {
        assembly ("memory-safe") {
            revert(add(returndata, 0x20), mload(returndata))
        }
    }
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Collection of functions related to the address type
 */
library Address {
    /**
     * @dev There's no code at `target` (it is not a contract).
     */
    error AddressEmptyCode(address target);

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

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

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but also transferring `value` wei to `target`.
     *
     * Requirements:
     *
     * - the calling contract must have an ETH balance of at least `value`.
     * - the called Solidity function must be `payable`.
     */
    function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
        if (address(this).balance < value) {
            revert Errors.InsufficientBalance(address(this).balance, value);
        }
        bool success = LowLevelCall.callNoReturn(target, value, data);
        if (success && (LowLevelCall.returnDataSize() > 0 || target.code.length > 0)) {
            return LowLevelCall.returnData();
        } else if (success) {
            revert AddressEmptyCode(target);
        } else if (LowLevelCall.returnDataSize() > 0) {
            LowLevelCall.bubbleRevert();
        } else {
            revert Errors.FailedCall();
        }
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a static call.
     */
    function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
        bool success = LowLevelCall.staticcallNoReturn(target, data);
        if (success && (LowLevelCall.returnDataSize() > 0 || target.code.length > 0)) {
            return LowLevelCall.returnData();
        } else if (success) {
            revert AddressEmptyCode(target);
        } else if (LowLevelCall.returnDataSize() > 0) {
            LowLevelCall.bubbleRevert();
        } else {
            revert Errors.FailedCall();
        }
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a delegate call.
     */
    function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
        bool success = LowLevelCall.delegatecallNoReturn(target, data);
        if (success && (LowLevelCall.returnDataSize() > 0 || target.code.length > 0)) {
            return LowLevelCall.returnData();
        } else if (success) {
            revert AddressEmptyCode(target);
        } else if (LowLevelCall.returnDataSize() > 0) {
            LowLevelCall.bubbleRevert();
        } else {
            revert Errors.FailedCall();
        }
    }

    /**
     * @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
     * was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
     * of an unsuccessful call.
     *
     * NOTE: This function is DEPRECATED and may be removed in the next major release.
     */
    function verifyCallResultFromTarget(
        address target,
        bool success,
        bytes memory returndata
    ) internal view returns (bytes memory) {
        // only check if target is a contract if the call was successful and the return data is empty
        // otherwise we already know that it was a contract
        if (success && (returndata.length > 0 || target.code.length > 0)) {
            return returndata;
        } else if (success) {
            revert AddressEmptyCode(target);
        } else if (returndata.length > 0) {
            LowLevelCall.bubbleRevert(returndata);
        } else {
            revert Errors.FailedCall();
        }
    }

    /**
     * @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
     * revert reason or with a default {Errors.FailedCall} error.
     */
    function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
        if (success) {
            return returndata;
        } else if (returndata.length > 0) {
            LowLevelCall.bubbleRevert(returndata);
        } else {
            revert Errors.FailedCall();
        }
    }
}