Contract Source Code (Solidity Standard Json-Input format)

IDE

• Blockscan IDE
• 🤖 Code ReaderBeta
• Remix IDE

More Options

• Similar
• Sol2Uml
• Submit Audit
• Compare

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

contract WithdrawNative {
    event NativeTokenWithdrawn(address indexed sender, address indexed to, uint256 amount);

    function withdrawNativeToken(address payable to) public payable {
        to.transfer(msg.value);
        emit NativeTokenWithdrawn(msg.sender, to, msg.value);
    }

    receive() external payable { }
}

// 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.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.0.0) (token/ERC20/ERC20.sol)

pragma solidity ^0.8.20;

import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {ContextUpgradeable} from "../../utils/ContextUpgradeable.sol";
import {IERC20Errors} from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";

/**
 * @dev Implementation of the {IERC20} interface.
 *
 * This implementation is agnostic to the way tokens are created. This means
 * that a supply mechanism has to be added in a derived contract using {_mint}.
 *
 * TIP: For a detailed writeup see our guide
 * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
 * to implement supply mechanisms].
 *
 * The default value of {decimals} is 18. To change this, you should override
 * this function so it returns a different value.
 *
 * We have followed general OpenZeppelin Contracts guidelines: functions revert
 * instead returning `false` on failure. This behavior is nonetheless
 * conventional and does not conflict with the expectations of ERC20
 * applications.
 *
 * Additionally, an {Approval} event is emitted on calls to {transferFrom}.
 * This allows applications to reconstruct the allowance for all accounts just
 * by listening to said events. Other implementations of the EIP may not emit
 * these events, as it isn't required by the specification.
 */
abstract contract ERC20Upgradeable is Initializable, ContextUpgradeable, IERC20, IERC20Metadata, IERC20Errors {
    /// @custom:storage-location erc7201:openzeppelin.storage.ERC20
    struct ERC20Storage {
        mapping(address account => uint256) _balances;

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

        uint256 _totalSupply;

        string _name;
        string _symbol;
    }

    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC20")) - 1)) & ~bytes32(uint256(0xff))
    bytes32 private constant ERC20StorageLocation = 0x52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace00;

    function _getERC20Storage() private pure returns (ERC20Storage storage $) {
        assembly {
            $.slot := ERC20StorageLocation
        }
    }

    /**
     * @dev Sets the values for {name} and {symbol}.
     *
     * All two of these values are immutable: they can only be set once during
     * construction.
     */
    function __ERC20_init(string memory name_, string memory symbol_) internal onlyInitializing {
        __ERC20_init_unchained(name_, symbol_);
    }

    function __ERC20_init_unchained(string memory name_, string memory symbol_) internal onlyInitializing {
        ERC20Storage storage $ = _getERC20Storage();
        $._name = name_;
        $._symbol = symbol_;
    }

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

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

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

    /**
     * @dev See {IERC20-totalSupply}.
     */
    function totalSupply() public view virtual returns (uint256) {
        ERC20Storage storage $ = _getERC20Storage();
        return $._totalSupply;
    }

    /**
     * @dev See {IERC20-balanceOf}.
     */
    function balanceOf(address account) public view virtual returns (uint256) {
        ERC20Storage storage $ = _getERC20Storage();
        return $._balances[account];
    }

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

    /**
     * @dev See {IERC20-allowance}.
     */
    function allowance(address owner, address spender) public view virtual returns (uint256) {
        ERC20Storage storage $ = _getERC20Storage();
        return $._allowances[owner][spender];
    }

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

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

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

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

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

        emit Transfer(from, to, value);
    }

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

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

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.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.0.0) (utils/ReentrancyGuard.sol)

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

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

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

    /// @custom:storage-location erc7201:openzeppelin.storage.ReentrancyGuard
    struct ReentrancyGuardStorage {
        uint256 _status;
    }

    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
    bytes32 private constant ReentrancyGuardStorageLocation = 0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;

    function _getReentrancyGuardStorage() private pure returns (ReentrancyGuardStorage storage $) {
        assembly {
            $.slot := ReentrancyGuardStorageLocation
        }
    }

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

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

    function __ReentrancyGuard_init_unchained() internal onlyInitializing {
        ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
        $._status = NOT_ENTERED;
    }

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

    function _nonReentrantBefore() private {
        ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
        // On the first call to nonReentrant, _status will be NOT_ENTERED
        if ($._status == ENTERED) {
            revert ReentrancyGuardReentrantCall();
        }

        // Any calls to nonReentrant after this point will fail
        $._status = ENTERED;
    }

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

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

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

pragma solidity ^0.8.20;

import {IAccessControl} from "./IAccessControl.sol";
import {Context} from "../utils/Context.sol";
import {ERC165} from "../utils/introspection/ERC165.sol";

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

    mapping(bytes32 role => RoleData) private _roles;

    bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;

    /**
     * @dev Modifier that checks that an account has a specific role. Reverts
     * with an {AccessControlUnauthorizedAccount} error including the required role.
     */
    modifier onlyRole(bytes32 role) {
        _checkRole(role);
        _;
    }

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

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

    /**
     * @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
     * is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
     */
    function _checkRole(bytes32 role) internal view virtual {
        _checkRole(role, _msgSender());
    }

    /**
     * @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
     * is missing `role`.
     */
    function _checkRole(bytes32 role, address account) internal view virtual {
        if (!hasRole(role, account)) {
            revert AccessControlUnauthorizedAccount(account, role);
        }
    }

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

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

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

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

        _revokeRole(role, callerConfirmation);
    }

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

    /**
     * @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
     *
     * Internal function without access restriction.
     *
     * May emit a {RoleGranted} event.
     */
    function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
        if (!hasRole(role, account)) {
            _roles[role].hasRole[account] = true;
            emit RoleGranted(role, account, _msgSender());
            return true;
        } else {
            return false;
        }
    }

    /**
     * @dev Attempts to revoke `role` to `account` and returns a boolean indicating if `role` was revoked.
     *
     * Internal function without access restriction.
     *
     * May emit a {RoleRevoked} event.
     */
    function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
        if (hasRole(role, account)) {
            _roles[role].hasRole[account] = false;
            emit RoleRevoked(role, account, _msgSender());
            return true;
        } else {
            return false;
        }
    }
}

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

pragma solidity ^0.8.20;

/**
 * @dev External interface of AccessControl declared to support ERC165 detection.
 */
interface IAccessControl {
    /**
     * @dev The `account` is missing a role.
     */
    error AccessControlUnauthorizedAccount(address account, bytes32 neededRole);

    /**
     * @dev The caller of a function is not the expected one.
     *
     * NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
     */
    error AccessControlBadConfirmation();

    /**
     * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
     *
     * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
     * {RoleAdminChanged} not being emitted signaling this.
     */
    event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

/**
 * @dev ERC1822: 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: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

pragma solidity ^0.8.20;

/**
 * @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
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/Clones.sol)

pragma solidity ^0.8.20;

/**
 * @dev https://eips.ethereum.org/EIPS/eip-1167[EIP 1167] is a standard for
 * deploying minimal proxy contracts, also known as "clones".
 *
 * > To simply and cheaply clone contract functionality in an immutable way, this standard specifies
 * > a minimal bytecode implementation that delegates all calls to a known, fixed address.
 *
 * The library includes functions to deploy a proxy using either `create` (traditional deployment) or `create2`
 * (salted deterministic deployment). It also includes functions to predict the addresses of clones deployed using the
 * deterministic method.
 */
library Clones {
    /**
     * @dev A clone instance deployment failed.
     */
    error ERC1167FailedCreateClone();

    /**
     * @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation`.
     *
     * This function uses the create opcode, which should never revert.
     */
    function clone(address implementation) internal returns (address instance) {
        /// @solidity memory-safe-assembly
        assembly {
            // Cleans the upper 96 bits of the `implementation` word, then packs the first 3 bytes
            // of the `implementation` address with the bytecode before the address.
            mstore(0x00, or(shr(0xe8, shl(0x60, implementation)), 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000))
            // Packs the remaining 17 bytes of `implementation` with the bytecode after the address.
            mstore(0x20, or(shl(0x78, implementation), 0x5af43d82803e903d91602b57fd5bf3))
            instance := create(0, 0x09, 0x37)
        }
        if (instance == address(0)) {
            revert ERC1167FailedCreateClone();
        }
    }

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

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

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

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

pragma solidity ^0.8.20;

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[EIP1967], so that it doesn't conflict with the storage layout of the
 * implementation behind the proxy.
 */
contract ERC1967Proxy is Proxy {
    /**
     * @dev Initializes the upgradeable proxy with an initial implementation specified by `implementation`.
     *
     * If `_data` is nonempty, it's used as data 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.
     *
     * Requirements:
     *
     * - If `data` is empty, `msg.value` must be zero.
     */
    constructor(address implementation, bytes memory _data) payable {
        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 EIP1967) 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();
    }
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev This abstract contract provides getters and event emitting update functions for
 * https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
 */
library ERC1967Utils {
    // We re-declare ERC-1967 events here because they can't be used directly from IERC1967.
    // This will be fixed in Solidity 0.8.21. At that point we should remove these events.
    /**
     * @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);

    /**
     * @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 EIP1967 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 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 EIP1967) using
     * the https://eth.wiki/json-rpc/API#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 EIP1967 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 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 EIP1967 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 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
// OpenZeppelin Contracts (last updated v5.0.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(0, 0, calldatasize())

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

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

            switch result
            // delegatecall returns 0 on error.
            case 0 {
                revert(0, returndatasize())
            }
            default {
                return(0, 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
// 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.0.0) (proxy/utils/UUPSUpgradeable.sol)

pragma solidity ^0.8.20;

import {IERC1822Proxiable} from "../../interfaces/draft-IERC1822.sol";
import {ERC1967Utils} from "../ERC1967/ERC1967Utils.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 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 ERC1967) 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 ERC1167 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();
        _;
    }

    /**
     * @dev Implementation of the ERC1822 {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 ERC1967-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 ERC1967.
     *
     * 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
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC1155/IERC1155Receiver.sol)

pragma solidity ^0.8.20;

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

/**
 * @dev Interface that must be implemented by smart contracts in order to receive
 * ERC-1155 token transfers.
 */
interface IERC1155Receiver is IERC165 {
    /**
     * @dev Handles the receipt of a single ERC1155 token type. This function is
     * called at the end of a `safeTransferFrom` after the balance has been updated.
     *
     * NOTE: To accept the transfer, this must return
     * `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
     * (i.e. 0xf23a6e61, or its own function selector).
     *
     * @param operator The address which initiated the transfer (i.e. msg.sender)
     * @param from The address which previously owned the token
     * @param id The ID of the token being transferred
     * @param value The amount of tokens being transferred
     * @param data Additional data with no specified format
     * @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
     */
    function onERC1155Received(
        address operator,
        address from,
        uint256 id,
        uint256 value,
        bytes calldata data
    ) external returns (bytes4);

    /**
     * @dev Handles the receipt of a multiple ERC1155 token types. This function
     * is called at the end of a `safeBatchTransferFrom` after the balances have
     * been updated.
     *
     * NOTE: To accept the transfer(s), this must return
     * `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
     * (i.e. 0xbc197c81, or its own function selector).
     *
     * @param operator The address which initiated the batch transfer (i.e. msg.sender)
     * @param from The address which previously owned the token
     * @param ids An array containing ids of each token being transferred (order and length must match values array)
     * @param values An array containing amounts of each token being transferred (order and length must match ids array)
     * @param data Additional data with no specified format
     * @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
     */
    function onERC1155BatchReceived(
        address operator,
        address from,
        uint256[] calldata ids,
        uint256[] calldata values,
        bytes calldata data
    ) external returns (bytes4);
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Implementation of the {IERC20} interface.
 *
 * This implementation is agnostic to the way tokens are created. This means
 * that a supply mechanism has to be added in a derived contract using {_mint}.
 *
 * TIP: For a detailed writeup see our guide
 * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
 * to implement supply mechanisms].
 *
 * The default value of {decimals} is 18. To change this, you should override
 * this function so it returns a different value.
 *
 * We have followed general OpenZeppelin Contracts guidelines: functions revert
 * instead returning `false` on failure. This behavior is nonetheless
 * conventional and does not conflict with the expectations of ERC20
 * applications.
 *
 * Additionally, an {Approval} event is emitted on calls to {transferFrom}.
 * This allows applications to reconstruct the allowance for all accounts just
 * by listening to said events. Other implementations of the EIP may not emit
 * these events, as it isn't required by the specification.
 */
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
    mapping(address account => uint256) private _balances;

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

    uint256 private _totalSupply;

    string private _name;
    string private _symbol;

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

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

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

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

    /**
     * @dev See {IERC20-totalSupply}.
     */
    function totalSupply() public view virtual returns (uint256) {
        return _totalSupply;
    }

    /**
     * @dev See {IERC20-balanceOf}.
     */
    function balanceOf(address account) public view virtual returns (uint256) {
        return _balances[account];
    }

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

    /**
     * @dev See {IERC20-allowance}.
     */
    function allowance(address owner, address spender) public view virtual returns (uint256) {
        return _allowances[owner][spender];
    }

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

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

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

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

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

        emit Transfer(from, to, value);
    }

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

pragma solidity ^0.8.20;

/**
 * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
 * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
 *
 * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
 * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
 * need to send a transaction, and thus is not required to hold Ether at all.
 *
 * ==== Security Considerations
 *
 * There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
 * expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
 * considered as an intention to spend the allowance in any specific way. The second is that because permits have
 * built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
 * take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
 * generally recommended is:
 *
 * ```solidity
 * function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
 *     try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
 *     doThing(..., value);
 * }
 *
 * function doThing(..., uint256 value) public {
 *     token.safeTransferFrom(msg.sender, address(this), value);
 *     ...
 * }
 * ```
 *
 * Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
 * `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
 * {SafeERC20-safeTransferFrom}).
 *
 * Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
 * contracts should have entry points that don't rely on permit.
 */
interface IERC20Permit {
    /**
     * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
     * given ``owner``'s signed approval.
     *
     * IMPORTANT: The same issues {IERC20-approve} has related to transaction
     * ordering also apply here.
     *
     * Emits an {Approval} event.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     * - `deadline` must be a timestamp in the future.
     * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
     * over the EIP712-formatted function arguments.
     * - the signature must use ``owner``'s current nonce (see {nonces}).
     *
     * For more information on the signature format, see the
     * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
     * section].
     *
     * CAUTION: See Security Considerations above.
     */
    function permit(
        address owner,
        address spender,
        uint256 value,
        uint256 deadline,
        uint8 v,
        bytes32 r,
        bytes32 s
    ) external;

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

import {IERC20} from "../IERC20.sol";
import {IERC20Permit} from "../extensions/IERC20Permit.sol";
import {Address} from "../../../utils/Address.sol";

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

    /**
     * @dev An operation with an ERC20 token failed.
     */
    error SafeERC20FailedOperation(address token);

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

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

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

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

    /**
     * @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
     * value, non-reverting calls are assumed to be successful.
     */
    function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
        unchecked {
            uint256 currentAllowance = token.allowance(address(this), spender);
            if (currentAllowance < requestedDecrease) {
                revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
            }
            forceApprove(token, spender, currentAllowance - requestedDecrease);
        }
    }

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

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

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

        bytes memory returndata = address(token).functionCall(data);
        if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
            revert SafeERC20FailedOperation(address(token));
        }
    }

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/IERC721Receiver.sol)

pragma solidity ^0.8.20;

/**
 * @title ERC721 token receiver interface
 * @dev Interface for any contract that wants to support safeTransfers
 * from ERC721 asset contracts.
 */
interface IERC721Receiver {
    /**
     * @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
     * by `operator` from `from`, this function is called.
     *
     * It must return its Solidity selector to confirm the token transfer.
     * If any other value is returned or the interface is not implemented by the recipient, the transfer will be
     * reverted.
     *
     * The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
     */
    function onERC721Received(
        address operator,
        address from,
        uint256 tokenId,
        bytes calldata data
    ) external returns (bytes4);
}

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

pragma solidity ^0.8.20;

/**
 * @dev Collection of functions related to the address type
 */
library Address {
    /**
     * @dev The ETH balance of the account is not enough to perform the operation.
     */
    error AddressInsufficientBalance(address account);

    /**
     * @dev There's no code at `target` (it is not a contract).
     */
    error AddressEmptyCode(address target);

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

    /**
     * @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 AddressInsufficientBalance(address(this));
        }

        (bool success, ) = recipient.call{value: amount}("");
        if (!success) {
            revert FailedInnerCall();
        }
    }

    /**
     * @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
     * {FailedInnerCall} 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 AddressInsufficientBalance(address(this));
        }
        (bool success, bytes memory returndata) = target.call{value: value}(data);
        return verifyCallResultFromTarget(target, success, returndata);
    }

    /**
     * @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, bytes memory returndata) = target.staticcall(data);
        return verifyCallResultFromTarget(target, success, returndata);
    }

    /**
     * @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, bytes memory returndata) = target.delegatecall(data);
        return verifyCallResultFromTarget(target, success, returndata);
    }

    /**
     * @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 {FailedInnerCall}) in case of an
     * unsuccessful call.
     */
    function verifyCallResultFromTarget(
        address target,
        bool success,
        bytes memory returndata
    ) internal view returns (bytes memory) {
        if (!success) {
            _revert(returndata);
        } else {
            // 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 (returndata.length == 0 && target.code.length == 0) {
                revert AddressEmptyCode(target);
            }
            return returndata;
        }
    }

    /**
     * @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 {FailedInnerCall} error.
     */
    function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
        if (!success) {
            _revert(returndata);
        } else {
            return returndata;
        }
    }

    /**
     * @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
     */
    function _revert(bytes memory returndata) private pure {
        // Look for revert reason and bubble it up if present
        if (returndata.length > 0) {
            // The easiest way to bubble the revert reason is using memory via assembly
            /// @solidity memory-safe-assembly
            assembly {
                let returndata_size := mload(returndata)
                revert(add(32, returndata), returndata_size)
            }
        } else {
            revert FailedInnerCall();
        }
    }
}

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

pragma solidity ^0.8.20;

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

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

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

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

pragma solidity ^0.8.20;

/**
 * @dev Helper to make usage of the `CREATE2` EVM opcode easier and safer.
 * `CREATE2` can be used to compute in advance the address where a smart
 * contract will be deployed, which allows for interesting new mechanisms known
 * as 'counterfactual interactions'.
 *
 * See the https://eips.ethereum.org/EIPS/eip-1014#motivation[EIP] for more
 * information.
 */
library Create2 {
    /**
     * @dev Not enough balance for performing a CREATE2 deploy.
     */
    error Create2InsufficientBalance(uint256 balance, uint256 needed);

    /**
     * @dev There's no code to deploy.
     */
    error Create2EmptyBytecode();

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

    /**
     * @dev Deploys a contract using `CREATE2`. The address where the contract
     * will be deployed can be known in advance via {computeAddress}.
     *
     * The bytecode for a contract can be obtained from Solidity with
     * `type(contractName).creationCode`.
     *
     * Requirements:
     *
     * - `bytecode` must not be empty.
     * - `salt` must have not been used for `bytecode` already.
     * - the factory must have a balance of at least `amount`.
     * - if `amount` is non-zero, `bytecode` must have a `payable` constructor.
     */
    function deploy(uint256 amount, bytes32 salt, bytes memory bytecode) internal returns (address addr) {
        if (address(this).balance < amount) {
            revert Create2InsufficientBalance(address(this).balance, amount);
        }
        if (bytecode.length == 0) {
            revert Create2EmptyBytecode();
        }
        /// @solidity memory-safe-assembly
        assembly {
            addr := create2(amount, add(bytecode, 0x20), mload(bytecode), salt)
        }
        if (addr == address(0)) {
            revert Create2FailedDeployment();
        }
    }

    /**
     * @dev Returns the address where a contract will be stored if deployed via {deploy}. Any change in the
     * `bytecodeHash` or `salt` will result in a new destination address.
     */
    function computeAddress(bytes32 salt, bytes32 bytecodeHash) internal view returns (address) {
        return computeAddress(salt, bytecodeHash, address(this));
    }

    /**
     * @dev Returns the address where a contract will be stored if deployed via {deploy} from a contract located at
     * `deployer`. If `deployer` is this contract's address, returns the same value as {computeAddress}.
     */
    function computeAddress(bytes32 salt, bytes32 bytecodeHash, address deployer) internal pure returns (address addr) {
        /// @solidity memory-safe-assembly
        assembly {
            let ptr := mload(0x40) // Get free memory pointer

            // |                   | ↓ ptr ...  ↓ ptr + 0x0B (start) ...  ↓ ptr + 0x20 ...  ↓ ptr + 0x40 ...   |
            // |-------------------|---------------------------------------------------------------------------|
            // | bytecodeHash      |                                                        CCCCCCCCCCCCC...CC |
            // | salt              |                                      BBBBBBBBBBBBB...BB                   |
            // | deployer          | 000000...0000AAAAAAAAAAAAAAAAAAA...AA                                     |
            // | 0xFF              |            FF                                                             |
            // |-------------------|---------------------------------------------------------------------------|
            // | memory            | 000000...00FFAAAAAAAAAAAAAAAAAAA...AABBBBBBBBBBBBB...BBCCCCCCCCCCCCC...CC |
            // | keccak(start, 85) |            ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑ |

            mstore(add(ptr, 0x40), bytecodeHash)
            mstore(add(ptr, 0x20), salt)
            mstore(ptr, deployer) // Right-aligned with 12 preceding garbage bytes
            let start := add(ptr, 0x0b) // The hashed data starts at the final garbage byte which we will set to 0xff
            mstore8(start, 0xff)
            addr := keccak256(start, 85)
        }
    }
}

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

pragma solidity ^0.8.20;

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

    /**
     * @dev The signature derives the `address(0)`.
     */
    error ECDSAInvalidSignature();

    /**
     * @dev The signature has an invalid length.
     */
    error ECDSAInvalidSignatureLength(uint256 length);

    /**
     * @dev The signature has an S value that is in the upper half order.
     */
    error ECDSAInvalidSignatureS(bytes32 s);

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

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

    /**
     * @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
     *
     * See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures]
     */
    function tryRecover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address, RecoverError, bytes32) {
        unchecked {
            bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
            // We do not check for an overflow here since the shift operation results in 0 or 1.
            uint8 v = uint8((uint256(vs) >> 255) + 27);
            return tryRecover(hash, v, r, s);
        }
    }

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

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

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

        return (signer, RecoverError.NoError, bytes32(0));
    }

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

    /**
     * @dev Optionally reverts with the corresponding custom error according to the `error` argument provided.
     */
    function _throwError(RecoverError error, bytes32 errorArg) private pure {
        if (error == RecoverError.NoError) {
            return; // no error: do nothing
        } else if (error == RecoverError.InvalidSignature) {
            revert ECDSAInvalidSignature();
        } else if (error == RecoverError.InvalidSignatureLength) {
            revert ECDSAInvalidSignatureLength(uint256(errorArg));
        } else if (error == RecoverError.InvalidSignatureS) {
            revert ECDSAInvalidSignatureS(errorArg);
        }
    }
}

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

pragma solidity ^0.8.20;

import {MessageHashUtils} from "./MessageHashUtils.sol";
import {ShortStrings, ShortString} from "../ShortStrings.sol";
import {IERC5267} from "../../interfaces/IERC5267.sol";

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

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

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

    bytes32 private immutable _hashedName;
    bytes32 private immutable _hashedVersion;

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

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

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

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

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

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

    /**
     * @dev See {IERC-5267}.
     */
    function eip712Domain()
        public
        view
        virtual
        returns (
            bytes1 fields,
            string memory name,
            string memory version,
            uint256 chainId,
            address verifyingContract,
            bytes32 salt,
            uint256[] memory extensions
        )
    {
        return (
            hex"0f", // 01111
            _EIP712Name(),
            _EIP712Version(),
            block.chainid,
            address(this),
            bytes32(0),
            new uint256[](0)
        );
    }

    /**
     * @dev The name parameter for the EIP712 domain.
     *
     * NOTE: By default this function reads _name which is an immutable value.
     * It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
     */
    // solhint-disable-next-line func-name-mixedcase
    function _EIP712Name() internal view returns (string memory) {
        return _name.toStringWithFallback(_nameFallback);
    }

    /**
     * @dev The version parameter for the EIP712 domain.
     *
     * NOTE: By default this function reads _version which is an immutable value.
     * It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
     */
    // solhint-disable-next-line func-name-mixedcase
    function _EIP712Version() internal view returns (string memory) {
        return _version.toStringWithFallback(_versionFallback);
    }
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
 *
 * The library provides methods for generating a hash of a message that conforms to the
 * https://eips.ethereum.org/EIPS/eip-191[EIP 191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
 * specifications.
 */
library MessageHashUtils {
    /**
     * @dev Returns the keccak256 digest of an EIP-191 signed data with version
     * `0x45` (`personal_sign` messages).
     *
     * The digest is calculated by prefixing a bytes32 `messageHash` with
     * `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the
     * hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
     *
     * NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with
     * keccak256, although any bytes32 value can be safely used because the final digest will
     * be re-hashed.
     *
     * See {ECDSA-recover}.
     */
    function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
        /// @solidity memory-safe-assembly
        assembly {
            mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
            mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
            digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
        }
    }

    /**
     * @dev Returns the keccak256 digest of an EIP-191 signed data with version
     * `0x45` (`personal_sign` messages).
     *
     * The digest is calculated by prefixing an arbitrary `message` with
     * `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the
     * hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
     *
     * See {ECDSA-recover}.
     */
    function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) {
        return
            keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message));
    }

    /**
     * @dev Returns the keccak256 digest of an EIP-191 signed data with version
     * `0x00` (data with intended validator).
     *
     * The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
     * `validator` address. Then hashing the result.
     *
     * See {ECDSA-recover}.
     */
    function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
        return keccak256(abi.encodePacked(hex"19_00", validator, data));
    }

    /**
     * @dev Returns the keccak256 digest of an EIP-712 typed data (EIP-191 version `0x01`).
     *
     * The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
     * `\x19\x01` and hashing the result. It corresponds to the hash signed by the
     * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712.
     *
     * See {ECDSA-recover}.
     */
    function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
        /// @solidity memory-safe-assembly
        assembly {
            let ptr := mload(0x40)
            mstore(ptr, hex"19_01")
            mstore(add(ptr, 0x02), domainSeparator)
            mstore(add(ptr, 0x22), structHash)
            digest := keccak256(ptr, 0x42)
        }
    }
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Implementation of the {IERC165} interface.
 *
 * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
 * for the additional interface id that will be supported. For example:
 *
 * ```solidity
 * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
 *     return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
 * }
 * ```
 */
abstract contract ERC165 is IERC165 {
    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
        return interfaceId == type(IERC165).interfaceId;
    }
}

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

pragma solidity ^0.8.20;

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

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

pragma solidity ^0.8.20;

/**
 * @dev Standard math utilities missing in the Solidity language.
 */
library Math {
    /**
     * @dev Muldiv operation overflow.
     */
    error MathOverflowedMulDiv();

    enum Rounding {
        Floor, // Toward negative infinity
        Ceil, // Toward positive infinity
        Trunc, // Toward zero
        Expand // Away from zero
    }

    /**
     * @dev Returns the addition of two unsigned integers, with an overflow flag.
     */
    function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            uint256 c = a + b;
            if (c < a) return (false, 0);
            return (true, c);
        }
    }

    /**
     * @dev Returns the subtraction of two unsigned integers, with an overflow flag.
     */
    function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b > a) return (false, 0);
            return (true, a - b);
        }
    }

    /**
     * @dev Returns the multiplication of two unsigned integers, with an overflow flag.
     */
    function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
            // benefit is lost if 'b' is also tested.
            // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
            if (a == 0) return (true, 0);
            uint256 c = a * b;
            if (c / a != b) return (false, 0);
            return (true, c);
        }
    }

    /**
     * @dev Returns the division of two unsigned integers, with a division by zero flag.
     */
    function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b == 0) return (false, 0);
            return (true, a / b);
        }
    }

    /**
     * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
     */
    function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
        unchecked {
            if (b == 0) return (false, 0);
            return (true, a % b);
        }
    }

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

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

    /**
     * @dev Returns the average of two numbers. The result is rounded towards
     * zero.
     */
    function average(uint256 a, uint256 b) internal pure returns (uint256) {
        // (a + b) / 2 can overflow.
        return (a & b) + (a ^ b) / 2;
    }

    /**
     * @dev Returns the ceiling of the division of two numbers.
     *
     * This differs from standard division with `/` in that it rounds 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.
            return a / b;
        }

        // (a + b - 1) / b can overflow on addition, so we distribute.
        return a == 0 ? 0 : (a - 1) / b + 1;
    }

    /**
     * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
     * denominator == 0.
     * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
     * Uniswap Labs also under MIT license.
     */
    function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
        unchecked {
            // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
            // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
            // variables such that product = prod1 * 2^256 + prod0.
            uint256 prod0 = x * y; // Least significant 256 bits of the product
            uint256 prod1; // Most significant 256 bits of the product
            assembly {
                let mm := mulmod(x, y, not(0))
                prod1 := sub(sub(mm, prod0), lt(mm, prod0))
            }

            // Handle non-overflow cases, 256 by 256 division.
            if (prod1 == 0) {
                // Solidity will revert if denominator == 0, unlike the div opcode on its own.
                // The surrounding unchecked block does not change this fact.
                // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
                return prod0 / denominator;
            }

            // Make sure the result is less than 2^256. Also prevents denominator == 0.
            if (denominator <= prod1) {
                revert MathOverflowedMulDiv();
            }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
     * @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 + (unsignedRoundsUp(rounding) && 10 ** result < value ? 1 : 0);
        }
    }

    /**
     * @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 value) internal pure returns (uint256) {
        uint256 result = 0;
        unchecked {
            if (value >> 128 > 0) {
                value >>= 128;
                result += 16;
            }
            if (value >> 64 > 0) {
                value >>= 64;
                result += 8;
            }
            if (value >> 32 > 0) {
                value >>= 32;
                result += 4;
            }
            if (value >> 16 > 0) {
                value >>= 16;
                result += 2;
            }
            if (value >> 8 > 0) {
                result += 1;
            }
        }
        return result;
    }

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.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 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 an uint of `bits` size.
     */
    error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value);

    /**
     * @dev An int value doesn't fit in an 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 An 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);
    }
}

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

pragma solidity ^0.8.20;

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

    /**
     * @dev The operation failed because the contract is paused.
     */
    error EnforcedPause();

    /**
     * @dev The operation failed because the contract is not paused.
     */
    error ExpectedPause();

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

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

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

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

    /**
     * @dev Throws if the contract is paused.
     */
    function _requireNotPaused() internal view virtual {
        if (paused()) {
            revert EnforcedPause();
        }
    }

    /**
     * @dev Throws if the contract is not paused.
     */
    function _requirePaused() internal view virtual {
        if (!paused()) {
            revert ExpectedPause();
        }
    }

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

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

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

pragma solidity ^0.8.20;

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

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

    uint256 private _status;

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

    constructor() {
        _status = NOT_ENTERED;
    }

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

    function _nonReentrantBefore() private {
        // On the first call to nonReentrant, _status will be NOT_ENTERED
        if (_status == ENTERED) {
            revert ReentrancyGuardReentrantCall();
        }

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.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 ERC1967 implementation slot:
 * ```solidity
 * contract ERC1967 {
 *     bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
 *
 *     function _getImplementation() internal view returns (address) {
 *         return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
 *     }
 *
 *     function _setImplementation(address newImplementation) internal {
 *         require(newImplementation.code.length > 0);
 *         StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
 *     }
 * }
 * ```
 */
library StorageSlot {
    struct AddressSlot {
        address value;
    }

    struct BooleanSlot {
        bool value;
    }

    struct Bytes32Slot {
        bytes32 value;
    }

    struct Uint256Slot {
        uint256 value;
    }

    struct StringSlot {
        string value;
    }

    struct BytesSlot {
        bytes value;
    }

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

    /**
     * @dev Converts a `uint256` to its ASCII `string` decimal representation.
     */
    function toString(uint256 value) internal pure returns (string memory) {
        unchecked {
            uint256 length = Math.log10(value) + 1;
            string memory buffer = new string(length);
            uint256 ptr;
            /// @solidity memory-safe-assembly
            assembly {
                ptr := add(buffer, add(32, length))
            }
            while (true) {
                ptr--;
                /// @solidity memory-safe-assembly
                assembly {
                    mstore8(ptr, byte(mod(value, 10), 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 Returns true if the two strings are equal.
     */
    function equal(string memory a, string memory b) internal pure returns (bool) {
        return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
    }
}

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

                // Move the lastValue to the index where the value to delete is
                set._values[valueIndex] = lastValue;
                // Update the tracked position of the lastValue (that was just moved)
                set._positions[lastValue] = position;
            }

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

            // Delete the tracked position for the deleted slot
            delete set._positions[value];

            return true;
        } else {
            return false;
        }
    }

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

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

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

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

    // Bytes32Set

    struct Bytes32Set {
        Set _inner;
    }

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

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

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

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

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

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

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

        return result;
    }

    // AddressSet

    struct AddressSet {
        Set _inner;
    }

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

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

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

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

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

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

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

        return result;
    }

    // UintSet

    struct UintSet {
        Set _inner;
    }

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

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

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

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

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

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

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

        return result;
    }
}

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

import "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "./interfaces/IBankrollController.sol";
import "./interfaces/IBankrollVault.sol";
import "./interfaces/IMintableBankrollShareToken.sol";
import "./interfaces/IVaultEventEmitter.sol";
import "./interfaces/IBankrollFactory.sol";
import "./interfaces/IConfigStruct.sol";

/**
 * @title AccessControlBase
 * @author balding-ghost
 * @notice This contract is the base contract for the bankroll vaults and managers. It provides
 * modifiers and storage that are generalizable to all bankroll contracts.
 */
contract AccessControlBase is ContextUpgradeable, ReentrancyGuardUpgradeable {
    using SafeERC20 for IERC20;

    uint256 public bankrollIndex;

    IBankrollController public controller;

    IVaultEventEmitter public eventEmitter;

    IBankrollFactory public factory;

    IMintableBankrollShareToken public liquidityShareToken;

    IBankrollVault public vaultV2;

    IERC20 public bankrollToken;

    function __AccessControlBase_init(IConfigStruct.AddressConfiguration memory _config)
        internal
        onlyInitializing
    {
        bankrollIndex = _config.bankrollIndex;
        bankrollToken = IERC20(_config.bankrollTokenAddress);
        eventEmitter = IVaultEventEmitter(_config.eventEmitterAddress);
        controller = IBankrollController(_config.controllerAddress);
        factory = IBankrollFactory(_msgSender());
        __ReentrancyGuard_init();
    }

    // Modifiers for the vault deployment

    modifier onlyVaultAdmin() {
        require(
            controller.isBankrollAdmin(_msgSender()),
            "AccessControlBase: Only bankroll admin can call this function"
        );
        _;
    }

    modifier onlyVaultBankroll() {
        require(
            controller.isBankroll(_msgSender()),
            "AccessControlBase: Only bankroll can call this function"
        );
        _;
    }

    modifier onlyBankrollManager() {
        require(
            controller.isBankrollManager(_msgSender()),
            "AccessControlBase: Only bankroll manager can call this function"
        );
        _;
    }

    /**
     * @dev This modifier is used to check if the caller is a registered vault adapter.
     */
    modifier onlyVaultAdapter() {
        require(
            controller.isRegisteredAdapter(_msgSender()),
            "AccessControlBase: Only registered vault adapter can call this function"
        );
        _;
    }

    /**
     * @dev This modifier is used to check if the caller is known to the system, this should
     * protect very unimportant functionst that just not make sense to be called by anybody.
     */
    modifier onlyRegisteredEntity() {
        require(
            controller.isCallerRegisteredEntity(_msgSender()),
            "AccessControlBase: Only registered bankroll can call this function"
        );
        _;
    }

    /**
     * @dev This modifier is used to check if the caller is a trusted contract (like factories and
     * other contracts deployed
     * by WINR).
     */
    modifier onlyProtocolContract() {
        require(controller.isWINRProtocolContract(_msgSender()), "AccessControlBase: Only Protocol");
        _;
    }

    /**
     * @dev This modifier is used to check if the caller is a trusted administrator of the
     * protocol (like WINR or its DAO).
     */
    modifier onlyProtocolAdministrator() {
        require(
            controller.isWINRProtocolAdminstrator(_msgSender()),
            "AccessControlBase: Only protocol admin can call this function"
        );
        _;
    }

    // view function

    function _returnRakeCollectorAddress() internal view returns (address rakeCollectorAddress_) {
        rakeCollectorAddress_ = factory.returnRakeCollectorAddress();
    }

    // configuration function

    function setEventEmitter(address _eventEmitter) external onlyProtocolAdministrator {
        eventEmitter = IVaultEventEmitter(_eventEmitter);
    }
}

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

/* solhint-disable avoid-low-level-calls */
/* solhint-disable no-empty-blocks */

import "./interfaces/IAccount.sol";
import "./interfaces/IEntryPoint.sol";
import "./UserOperationLib.sol";

/**
 * Basic account implementation.
 * This contract provides the basic logic for implementing the IAccount interface - validateUserOp
 * Specific account implementation should inherit it and provide the account-specific logic.
 */
abstract contract BaseAccount is IAccount {
    using UserOperationLib for PackedUserOperation;

    /**
     * Return the account nonce.
     * This method returns the next sequential nonce.
     * For a nonce of a specific key, use `entrypoint.getNonce(account, key)`
     */
    function getNonce() public view virtual returns (uint256) {
        return entryPoint().getNonce(address(this), 0);
    }

    /**
     * Return the entryPoint used by this account.
     * Subclass should return the current entryPoint used by this account.
     */
    function entryPoint() public view virtual returns (IEntryPoint);

    /// @inheritdoc IAccount
    function validateUserOp(
        PackedUserOperation calldata userOp,
        bytes32 userOpHash,
        uint256 missingAccountFunds
    ) external virtual override returns (uint256 validationData) {
        _requireFromEntryPoint();
        validationData = _validateSignature(userOp, userOpHash);
        _validateNonce(userOp.nonce);
        _payPrefund(missingAccountFunds);
    }

    /**
     * Ensure the request comes from the known entrypoint.
     */
    function _requireFromEntryPoint() internal view virtual {
        require(
            msg.sender == address(entryPoint()),
            "account: not from EntryPoint"
        );
    }

    /**
     * Validate the signature is valid for this message.
     * @param userOp          - Validate the userOp.signature field.
     * @param userOpHash      - Convenient field: the hash of the request, to check the signature against.
     *                          (also hashes the entrypoint and chain id)
     * @return validationData - Signature and time-range of this operation.
     *                          <20-byte> aggregatorOrSigFail - 0 for valid signature, 1 to mark signature failure,
     *                                    otherwise, an address of an aggregator contract.
     *                          <6-byte> validUntil - last timestamp this operation is valid. 0 for "indefinite"
     *                          <6-byte> validAfter - first timestamp this operation is valid
     *                          If the account doesn't use time-range, it is enough to return
     *                          SIG_VALIDATION_FAILED value (1) for signature failure.
     *                          Note that the validation code cannot use block.timestamp (or block.number) directly.
     */
    function _validateSignature(
        PackedUserOperation calldata userOp,
        bytes32 userOpHash
    ) internal virtual returns (uint256 validationData);

    /**
     * Validate the nonce of the UserOperation.
     * This method may validate the nonce requirement of this account.
     * e.g.
     * To limit the nonce to use sequenced UserOps only (no "out of order" UserOps):
     *      `require(nonce < type(uint64).max)`
     * For a hypothetical account that *requires* the nonce to be out-of-order:
     *      `require(nonce & type(uint64).max == 0)`
     *
     * The actual nonce uniqueness is managed by the EntryPoint, and thus no other
     * action is needed by the account itself.
     *
     * @param nonce to validate
     *
     * solhint-disable-next-line no-empty-blocks
     */
    function _validateNonce(uint256 nonce) internal view virtual {
    }

    /**
     * Sends to the entrypoint (msg.sender) the missing funds for this transaction.
     * SubClass MAY override this method for better funds management
     * (e.g. send to the entryPoint more than the minimum required, so that in future transactions
     * it will not be required to send again).
     * @param missingAccountFunds - The minimum value this method should send the entrypoint.
     *                              This value MAY be zero, in case there is enough deposit,
     *                              or the userOp has a paymaster.
     */
    function _payPrefund(uint256 missingAccountFunds) internal virtual {
        if (missingAccountFunds != 0) {
            (bool success, ) = payable(msg.sender).call{
                value: missingAccountFunds,
                gas: type(uint256).max
            }("");
            (success);
            //ignore failure (its EntryPoint's job to verify, not account.)
        }
    }
}

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

/* solhint-disable reason-string */

import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import "./interfaces/IPaymaster.sol";
import "./interfaces/IEntryPoint.sol";
import "./UserOperationLib.sol";
/**
 * Helper class for creating a paymaster.
 * provides helper methods for staking.
 * Validates that the postOp is called only by the entryPoint.
 */

abstract contract BasePaymaster is IPaymaster, Ownable {
    IEntryPoint public immutable entryPoint;

    uint256 internal constant PAYMASTER_VALIDATION_GAS_OFFSET =
        UserOperationLib.PAYMASTER_VALIDATION_GAS_OFFSET;
    uint256 internal constant PAYMASTER_POSTOP_GAS_OFFSET =
        UserOperationLib.PAYMASTER_POSTOP_GAS_OFFSET;
    uint256 internal constant PAYMASTER_DATA_OFFSET = UserOperationLib.PAYMASTER_DATA_OFFSET;

    constructor(IEntryPoint _entryPoint, address _owner) Ownable(_owner) {
        _validateEntryPointInterface(_entryPoint);
        entryPoint = _entryPoint;
    }

    //sanity check: make sure this EntryPoint was compiled against the same
    // IEntryPoint of this paymaster
    function _validateEntryPointInterface(IEntryPoint _entryPoint) internal virtual {
        require(
            IERC165(address(_entryPoint)).supportsInterface(type(IEntryPoint).interfaceId),
            "IEntryPoint interface mismatch"
        );
    }

    /// @inheritdoc IPaymaster
    function validatePaymasterUserOp(
        PackedUserOperation calldata userOp,
        bytes32 userOpHash,
        uint256 maxCost
    )
        external
        override
        returns (bytes memory context, uint256 validationData)
    {
        _requireFromEntryPoint();
        return _validatePaymasterUserOp(userOp, userOpHash, maxCost);
    }

    /**
     * Validate a user operation.
     * @param userOp     - The user operation.
     * @param userOpHash - The hash of the user operation.
     * @param maxCost    - The maximum cost of the user operation.
     */
    function _validatePaymasterUserOp(
        PackedUserOperation calldata userOp,
        bytes32 userOpHash,
        uint256 maxCost
    )
        internal
        virtual
        returns (bytes memory context, uint256 validationData);

    /// @inheritdoc IPaymaster
    function postOp(
        PostOpMode mode,
        bytes calldata context,
        uint256 actualGasCost,
        uint256 actualUserOpFeePerGas
    )
        external
        override
    {
        _requireFromEntryPoint();
        _postOp(mode, context, actualGasCost, actualUserOpFeePerGas);
    }

    /**
     * Post-operation handler.
     * (verified to be called only through the entryPoint)
     * @dev If subclass returns a non-empty context from validatePaymasterUserOp,
     *      it must also implement this method.
     * @param mode          - Enum with the following options:
     *                        opSucceeded - User operation succeeded.
     *                        opReverted  - User op reverted. The paymaster still has to pay for
     * gas.
     *                        postOpReverted - never passed in a call to postOp().
     * @param context       - The context value returned by validatePaymasterUserOp
     * @param actualGasCost - Actual gas used so far (without this postOp call).
     * @param actualUserOpFeePerGas - the gas price this UserOp pays. This value is based on the
     * UserOp's maxFeePerGas
     *                        and maxPriorityFee (and basefee)
     *                        It is not the same as tx.gasprice, which is what the bundler pays.
     */
    function _postOp(
        PostOpMode mode,
        bytes calldata context,
        uint256 actualGasCost,
        uint256 actualUserOpFeePerGas
    )
        internal
        virtual
    {
        (mode, context, actualGasCost, actualUserOpFeePerGas); // unused params
        // subclass must override this method if validatePaymasterUserOp returns a context
        revert("must override");
    }

    /**
     * Add a deposit for this paymaster, used for paying for transaction fees.
     */
    function deposit() public payable {
        entryPoint.depositTo{ value: msg.value }(address(this));
    }

    /**
     * Withdraw value from the deposit.
     * @param withdrawAddress - Target to send to.
     * @param amount          - Amount to withdraw.
     */
    function withdrawTo(address payable withdrawAddress, uint256 amount) public onlyOwner {
        entryPoint.withdrawTo(withdrawAddress, amount);
    }

    /**
     * Add stake for this paymaster.
     * This method can also carry eth value to add to the current stake.
     * @param unstakeDelaySec - The unstake delay for this paymaster. Can only be increased.
     */
    function addStake(uint32 unstakeDelaySec) external payable onlyOwner {
        entryPoint.addStake{ value: msg.value }(unstakeDelaySec);
    }

    /**
     * Return current paymaster's deposit on the entryPoint.
     */
    function getDeposit() public view returns (uint256) {
        return entryPoint.balanceOf(address(this));
    }

    /**
     * Unlock the stake, in order to withdraw it.
     * The paymaster can't serve requests once unlocked, until it calls addStake again
     */
    function unlockStake() external onlyOwner {
        entryPoint.unlockStake();
    }

    /**
     * Withdraw the entire paymaster's stake.
     * stake must be unlocked first (and then wait for the unstakeDelay to be over)
     * @param withdrawAddress - The address to send withdrawn value.
     */
    function withdrawStake(address payable withdrawAddress) external onlyOwner {
        entryPoint.withdrawStake(withdrawAddress);
    }

    /**
     * Validate the call is made from a valid entrypoint
     */
    function _requireFromEntryPoint() internal virtual {
        require(msg.sender == address(entryPoint), "Sender not EntryPoint");
    }
}

// SPDX-License-Identifier: BUSL-1.1

pragma solidity ^0.8.20;

import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
import "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import "./BasePaymaster.sol";
import "./UserOperationLib.sol";
import "./Helpers.sol";

/**
 * A sample paymaster that uses external service to decide whether to pay for the UserOp.
 * The paymaster trusts an external signer to sign the transaction.
 * The calling user must pass the UserOp to that external signer first, which performs
 * whatever off-chain verification before signing the UserOp.
 * Note that this signature is NOT a replacement for the account-specific signature:
 * - the paymaster checks a signature to agree to PAY for GAS.
 * - the account checks a signature to prove identity and account ownership.
 */
contract BridgePaymaster is BasePaymaster {
    using ECDSA for bytes32;
    using UserOperationLib for PackedUserOperation;

    event ChangeVerifyingSigner(address signer);
    event SetWhitelistTarget(address target, bool isAllowed);
    event SetWhitelistTargetBatch(address[] targets, bool isAllowed);

    error InvalidSignature(bytes32 messageHash, bytes signature);
    error TargetNotWhitelisted(address target);
    error SignatureExpired(uint256 currentTime, uint256 validTime);
    error DepositAmountMismatch(uint256 msgValue, uint256 amount);
    error TransferFailed();

    mapping(address => bool) public whitelist;

    uint256 private constant VALID_TIMESTAMP_OFFSET = 52;
    uint256 private constant SIGNATURE_OFFSET = 212;

    address public verifyingSigner;
    address[] private wlAddresses;

    constructor(
        IEntryPoint _entryPoint,
        address _verifyingSigner,
        address _owner
    )
        BasePaymaster(_entryPoint, _owner)
    {
        verifyingSigner = _verifyingSigner;
    }

    function changeVerifyingSigner(address newSigner) external onlyOwner {
        verifyingSigner = newSigner;

        emit ChangeVerifyingSigner(newSigner);
    }

    function setWhitelistContract(address target, bool isAllowed) external onlyOwner {
        whitelist[target] = isAllowed;
        wlAddresses.push(target);
        emit SetWhitelistTarget(target, isAllowed);
    }

    function setWhitelistContractBatch(
        address[] memory targets,
        bool isAllowed
    )
        external
        onlyOwner
    {
        for (uint256 i = 0; i < targets.length; i++) {
            whitelist[targets[i]] = isAllowed;
            wlAddresses.push(targets[i]);
        }

        emit SetWhitelistTargetBatch(targets, isAllowed);
    }

    function getWlAddresses() external view returns (address[] memory wl) {
        // Count the number of whitelisted addresses
        uint256 count = 0;
        for (uint256 i = 0; i < wlAddresses.length; i++) {
            if (whitelist[wlAddresses[i]]) {
                count++;
            }
        }

        // Create a fixed-size array to store whitelisted addresses
        wl = new address[](count);

        // Populate the array with whitelisted addresses
        uint256 index = 0;
        for (uint256 i = 0; i < wlAddresses.length; i++) {
            if (whitelist[wlAddresses[i]]) {
                wl[index] = wlAddresses[i];
                index++;
            }
        }
    }

    function _validatePaymasterUserOp(
        PackedUserOperation calldata userOp,
        bytes32,
        uint256
    )
        internal
        override
        returns (bytes memory context, uint256 validationData)
    {
        (
            uint48 validUntil,
            uint48 validAfter,
            address target,
            bytes memory signature,
            address simpleAccount,
            uint256 bridgeFee
        ) = parsePaymasterAndData(userOp.paymasterAndData);

        if (!whitelist[target]) {
            revert TargetNotWhitelisted(target);
        }

        if (validUntil < block.timestamp) {
            revert SignatureExpired(block.timestamp, validUntil);
        }

        if (validAfter > block.timestamp) {
            revert SignatureExpired(block.timestamp, validAfter);
        }

        //don't revert on signature failure: return SIG_VALIDATION_FAILED
        if (
            verifyingSigner
                != verify(validUntil, validAfter, target, simpleAccount, bridgeFee, signature)
        ) {
            return ("", _packValidationData(true, validUntil, validAfter));
        }

        if (bridgeFee > 0) {
            (bool success,) = simpleAccount.call{ value: bridgeFee }("");
            if (!success) {
                revert TransferFailed();
            }
        }
        //no need for other on-chain validation: entire UserOp should have been checked
        // by the external service prior to signing it.
        return ("", _packValidationData(false, validUntil, validAfter));
    }

    function verify(
        uint48 validUntil,
        uint48 validAfter,
        address target,
        address simpleAccount,
        uint256 bridgeFee,
        bytes memory signature
    )
        public
        pure
        returns (address)
    {
        return ECDSA.recover(
            MessageHashUtils.toEthSignedMessageHash(
                keccak256(abi.encode(validUntil, validAfter, target, simpleAccount, bridgeFee))
            ),
            signature
        );
    }

    function parsePaymasterAndData(bytes calldata paymasterAndData)
        public
        pure
        returns (
            uint48 validUntil,
            uint48 validAfter,
            address target,
            bytes memory signature,
            address simpleAccount,
            uint256 bridgeFee
        )
    {
        (validUntil, validAfter, target, simpleAccount, bridgeFee) = abi.decode(
            paymasterAndData[VALID_TIMESTAMP_OFFSET:SIGNATURE_OFFSET],
            (uint48, uint48, address, address, uint256)
        );

        bytes memory _signature = paymasterAndData[SIGNATURE_OFFSET:];

        return (validUntil, validAfter, target, _signature, simpleAccount, bridgeFee);
    }

    function depositForBridge(uint256 amount) external payable {
        if (msg.value != amount) {
            revert DepositAmountMismatch(msg.value, amount);
        }
    }

    function withdrawBridgeFunds(address payable to, uint256 amount) external onlyOwner {
        (bool success,) = to.call{ value: amount }("");
        if (!success) {
            revert TransferFailed();
        }
    }
}

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

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

// contract Caller is AccessControl {

//     bytes32 public constant CALLER_ROLE = keccak256("CALLER_ROLE");

//     constructor() {
//         _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
//     }

//     function callAccount(address account, address dest, uint256 value, bytes memory func) external onlyRole(CALLER_ROLE) {
//         IAccount(account).call(dest, value, func);
//     }
// }

// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.8.23;
/* solhint-disable avoid-low-level-calls */
/* solhint-disable no-inline-assembly */

import "./interfaces/IAccount.sol";
import "./interfaces/IAccountExecute.sol";
import "./interfaces/IPaymaster.sol";
import "./interfaces/IEntryPoint.sol";

import "./Exec.sol";
import "./StakeManager.sol";
import "./SenderCreator.sol";
import "./Helpers.sol";
import "./NonceManager.sol";
import "./UserOperationLib.sol";

import "@openzeppelin/contracts/utils/introspection/ERC165.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";

/*
 * Account-Abstraction (EIP-4337) singleton EntryPoint implementation.
 * Only one instance required on each chain.
 */

/// @custom:security-contact https://bounty.ethereum.org
contract EntryPoint is IEntryPoint, StakeManager, NonceManager, ReentrancyGuard, ERC165 {

    using UserOperationLib for PackedUserOperation;

    SenderCreator private immutable _senderCreator = new SenderCreator();

    function senderCreator() internal view virtual returns (SenderCreator) {
        return _senderCreator;
    }

    //compensate for innerHandleOps' emit message and deposit refund.
    // allow some slack for future gas price changes.
    uint256 private constant INNER_GAS_OVERHEAD = 10000;

    // Marker for inner call revert on out of gas
    bytes32 private constant INNER_OUT_OF_GAS = hex"deaddead";
    bytes32 private constant INNER_REVERT_LOW_PREFUND = hex"deadaa51";

    uint256 private constant REVERT_REASON_MAX_LEN = 2048;
    uint256 private constant PENALTY_PERCENT = 10;

    /// @inheritdoc IERC165
    function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
        // note: solidity "type(IEntryPoint).interfaceId" is without inherited methods but we want to check everything
        return interfaceId == (type(IEntryPoint).interfaceId ^ type(IStakeManager).interfaceId ^ type(INonceManager).interfaceId) ||
            interfaceId == type(IEntryPoint).interfaceId ||
            interfaceId == type(IStakeManager).interfaceId ||
            interfaceId == type(INonceManager).interfaceId ||
            super.supportsInterface(interfaceId);
    }

    /**
     * Compensate the caller's beneficiary address with the collected fees of all UserOperations.
     * @param beneficiary - The address to receive the fees.
     * @param amount      - Amount to transfer.
     */
    function _compensate(address payable beneficiary, uint256 amount) internal {
        require(beneficiary != address(0), "AA90 invalid beneficiary");
        (bool success, ) = beneficiary.call{value: amount}("");
        require(success, "AA91 failed send to beneficiary");
    }

    /**
     * Execute a user operation.
     * @param opIndex    - Index into the opInfo array.
     * @param userOp     - The userOp to execute.
     * @param opInfo     - The opInfo filled by validatePrepayment for this userOp.
     * @return collected - The total amount this userOp paid.
     */
    function _executeUserOp(
        uint256 opIndex,
        PackedUserOperation calldata userOp,
        UserOpInfo memory opInfo
    )
    internal
    returns
    (uint256 collected) {
        uint256 preGas = gasleft();
        bytes memory context = getMemoryBytesFromOffset(opInfo.contextOffset);
        bool success;
        {
            uint256 saveFreePtr;
            assembly ("memory-safe") {
                saveFreePtr := mload(0x40)
            }
            bytes calldata callData = userOp.callData;
            bytes memory innerCall;
            bytes4 methodSig;
            assembly {
                let len := callData.length
                if gt(len, 3) {
                    methodSig := calldataload(callData.offset)
                }
            }
            if (methodSig == IAccountExecute.executeUserOp.selector) {
                bytes memory executeUserOp = abi.encodeCall(IAccountExecute.executeUserOp, (userOp, opInfo.userOpHash));
                innerCall = abi.encodeCall(this.innerHandleOp, (executeUserOp, opInfo, context));
            } else
            {
                innerCall = abi.encodeCall(this.innerHandleOp, (callData, opInfo, context));
            }
            assembly ("memory-safe") {
                success := call(gas(), address(), 0, add(innerCall, 0x20), mload(innerCall), 0, 32)
                collected := mload(0)
                mstore(0x40, saveFreePtr)
            }
        }
        if (!success) {
            bytes32 innerRevertCode;
            assembly ("memory-safe") {
                let len := returndatasize()
                if eq(32,len) {
                    returndatacopy(0, 0, 32)
                    innerRevertCode := mload(0)
                }
            }
            if (innerRevertCode == INNER_OUT_OF_GAS) {
                // handleOps was called with gas limit too low. abort entire bundle.
                //can only be caused by bundler (leaving not enough gas for inner call)
                revert FailedOp(opIndex, "AA95 out of gas");
            } else if (innerRevertCode == INNER_REVERT_LOW_PREFUND) {
                // innerCall reverted on prefund too low. treat entire prefund as "gas cost"
                uint256 actualGas = preGas - gasleft() + opInfo.preOpGas;
                uint256 actualGasCost = opInfo.prefund;
                emitPrefundTooLow(opInfo);
                emitUserOperationEvent(opInfo, false, actualGasCost, actualGas);
                collected = actualGasCost;
            } else {
                emit PostOpRevertReason(
                    opInfo.userOpHash,
                    opInfo.mUserOp.sender,
                    opInfo.mUserOp.nonce,
                    Exec.getReturnData(REVERT_REASON_MAX_LEN)
                );

                uint256 actualGas = preGas - gasleft() + opInfo.preOpGas;
                collected = _postExecution(
                    IPaymaster.PostOpMode.postOpReverted,
                    opInfo,
                    context,
                    actualGas
                );
            }
        }
    }

    function emitUserOperationEvent(UserOpInfo memory opInfo, bool success, uint256 actualGasCost, uint256 actualGas) internal virtual {
        emit UserOperationEvent(
            opInfo.userOpHash,
            opInfo.mUserOp.sender,
            opInfo.mUserOp.paymaster,
            opInfo.mUserOp.nonce,
            success,
            actualGasCost,
            actualGas
        );
    }

    function emitPrefundTooLow(UserOpInfo memory opInfo) internal virtual {
        emit UserOperationPrefundTooLow(
            opInfo.userOpHash,
            opInfo.mUserOp.sender,
            opInfo.mUserOp.nonce
        );
    }

    /// @inheritdoc IEntryPoint
    function handleOps(
        PackedUserOperation[] calldata ops,
        address payable beneficiary
    ) public nonReentrant {
        uint256 opslen = ops.length;
        UserOpInfo[] memory opInfos = new UserOpInfo[](opslen);

        unchecked {
            for (uint256 i = 0; i < opslen; i++) {
                UserOpInfo memory opInfo = opInfos[i];
                (
                    uint256 validationData,
                    uint256 pmValidationData
                ) = _validatePrepayment(i, ops[i], opInfo);
                _validateAccountAndPaymasterValidationData(
                    i,
                    validationData,
                    pmValidationData,
                    address(0)
                );
            }

            uint256 collected = 0;
            emit BeforeExecution();

            for (uint256 i = 0; i < opslen; i++) {
                collected += _executeUserOp(i, ops[i], opInfos[i]);
            }

            _compensate(beneficiary, collected);
        }
    }

    /// @inheritdoc IEntryPoint
    function handleAggregatedOps(
        UserOpsPerAggregator[] calldata opsPerAggregator,
        address payable beneficiary
    ) public nonReentrant {

        uint256 opasLen = opsPerAggregator.length;
        uint256 totalOps = 0;
        for (uint256 i = 0; i < opasLen; i++) {
            UserOpsPerAggregator calldata opa = opsPerAggregator[i];
            PackedUserOperation[] calldata ops = opa.userOps;
            IAggregator aggregator = opa.aggregator;

            //address(1) is special marker of "signature error"
            require(
                address(aggregator) != address(1),
                "AA96 invalid aggregator"
            );

            if (address(aggregator) != address(0)) {
                // solhint-disable-next-line no-empty-blocks
                try aggregator.validateSignatures(ops, opa.signature) {} catch {
                    revert SignatureValidationFailed(address(aggregator));
                }
            }

            totalOps += ops.length;
        }

        UserOpInfo[] memory opInfos = new UserOpInfo[](totalOps);

        uint256 opIndex = 0;
        for (uint256 a = 0; a < opasLen; a++) {
            UserOpsPerAggregator calldata opa = opsPerAggregator[a];
            PackedUserOperation[] calldata ops = opa.userOps;
            IAggregator aggregator = opa.aggregator;

            uint256 opslen = ops.length;
            for (uint256 i = 0; i < opslen; i++) {
                UserOpInfo memory opInfo = opInfos[opIndex];
                (
                    uint256 validationData,
                    uint256 paymasterValidationData
                ) = _validatePrepayment(opIndex, ops[i], opInfo);
                _validateAccountAndPaymasterValidationData(
                    i,
                    validationData,
                    paymasterValidationData,
                    address(aggregator)
                );
                opIndex++;
            }
        }

        emit BeforeExecution();

        uint256 collected = 0;
        opIndex = 0;
        for (uint256 a = 0; a < opasLen; a++) {
            UserOpsPerAggregator calldata opa = opsPerAggregator[a];
            emit SignatureAggregatorChanged(address(opa.aggregator));
            PackedUserOperation[] calldata ops = opa.userOps;
            uint256 opslen = ops.length;

            for (uint256 i = 0; i < opslen; i++) {
                collected += _executeUserOp(opIndex, ops[i], opInfos[opIndex]);
                opIndex++;
            }
        }
        emit SignatureAggregatorChanged(address(0));

        _compensate(beneficiary, collected);
    }

    /**
     * A memory copy of UserOp static fields only.
     * Excluding: callData, initCode and signature. Replacing paymasterAndData with paymaster.
     */
    struct MemoryUserOp {
        address sender;
        uint256 nonce;
        uint256 verificationGasLimit;
        uint256 callGasLimit;
        uint256 paymasterVerificationGasLimit;
        uint256 paymasterPostOpGasLimit;
        uint256 preVerificationGas;
        address paymaster;
        uint256 maxFeePerGas;
        uint256 maxPriorityFeePerGas;
    }

    struct UserOpInfo {
        MemoryUserOp mUserOp;
        bytes32 userOpHash;
        uint256 prefund;
        uint256 contextOffset;
        uint256 preOpGas;
    }

    /**
     * Inner function to handle a UserOperation.
     * Must be declared "external" to open a call context, but it can only be called by handleOps.
     * @param callData - The callData to execute.
     * @param opInfo   - The UserOpInfo struct.
     * @param context  - The context bytes.
     * @return actualGasCost - the actual cost in eth this UserOperation paid for gas
     */
    function innerHandleOp(
        bytes memory callData,
        UserOpInfo memory opInfo,
        bytes calldata context
    ) external returns (uint256 actualGasCost) {
        uint256 preGas = gasleft();
        require(msg.sender == address(this), "AA92 internal call only");
        MemoryUserOp memory mUserOp = opInfo.mUserOp;

        uint256 callGasLimit = mUserOp.callGasLimit;
        unchecked {
            // handleOps was called with gas limit too low. abort entire bundle.
            if (
                gasleft() * 63 / 64 <
                callGasLimit +
                mUserOp.paymasterPostOpGasLimit +
                INNER_GAS_OVERHEAD
            ) {
                assembly ("memory-safe") {
                    mstore(0, INNER_OUT_OF_GAS)
                    revert(0, 32)
                }
            }
        }

        IPaymaster.PostOpMode mode = IPaymaster.PostOpMode.opSucceeded;
        if (callData.length > 0) {
            bool success = Exec.call(mUserOp.sender, 0, callData, callGasLimit);
            if (!success) {
                bytes memory result = Exec.getReturnData(REVERT_REASON_MAX_LEN);
                if (result.length > 0) {
                    emit UserOperationRevertReason(
                        opInfo.userOpHash,
                        mUserOp.sender,
                        mUserOp.nonce,
                        result
                    );
                }
                mode = IPaymaster.PostOpMode.opReverted;
            }
        }

        unchecked {
            uint256 actualGas = preGas - gasleft() + opInfo.preOpGas;
            return _postExecution(mode, opInfo, context, actualGas);
        }
    }

    /// @inheritdoc IEntryPoint
    function getUserOpHash(
        PackedUserOperation calldata userOp
    ) public view returns (bytes32) {
        return
            keccak256(abi.encode(userOp.hash(), address(this), block.chainid));
    }

    /**
     * Copy general fields from userOp into the memory opInfo structure.
     * @param userOp  - The user operation.
     * @param mUserOp - The memory user operation.
     */
    function _copyUserOpToMemory(
        PackedUserOperation calldata userOp,
        MemoryUserOp memory mUserOp
    ) internal pure {
        mUserOp.sender = userOp.sender;
        mUserOp.nonce = userOp.nonce;
        (mUserOp.verificationGasLimit, mUserOp.callGasLimit) = UserOperationLib.unpackUints(userOp.accountGasLimits);
        mUserOp.preVerificationGas = userOp.preVerificationGas;
        (mUserOp.maxPriorityFeePerGas, mUserOp.maxFeePerGas) = UserOperationLib.unpackUints(userOp.gasFees);
        bytes calldata paymasterAndData = userOp.paymasterAndData;
        if (paymasterAndData.length > 0) {
            require(
                paymasterAndData.length >= UserOperationLib.PAYMASTER_DATA_OFFSET,
                "AA93 invalid paymasterAndData"
            );
            (mUserOp.paymaster, mUserOp.paymasterVerificationGasLimit, mUserOp.paymasterPostOpGasLimit) = UserOperationLib.unpackPaymasterStaticFields(paymasterAndData);
        } else {
            mUserOp.paymaster = address(0);
            mUserOp.paymasterVerificationGasLimit = 0;
            mUserOp.paymasterPostOpGasLimit = 0;
        }
    }

    /**
     * Get the required prefunded gas fee amount for an operation.
     * @param mUserOp - The user operation in memory.
     */
    function _getRequiredPrefund(
        MemoryUserOp memory mUserOp
    ) internal pure returns (uint256 requiredPrefund) {
        unchecked {
            uint256 requiredGas = mUserOp.verificationGasLimit +
                mUserOp.callGasLimit +
                mUserOp.paymasterVerificationGasLimit +
                mUserOp.paymasterPostOpGasLimit +
                mUserOp.preVerificationGas;

            requiredPrefund = requiredGas * mUserOp.maxFeePerGas;
        }
    }

    /**
     * Create sender smart contract account if init code is provided.
     * @param opIndex  - The operation index.
     * @param opInfo   - The operation info.
     * @param initCode - The init code for the smart contract account.
     */
    function _createSenderIfNeeded(
        uint256 opIndex,
        UserOpInfo memory opInfo,
        bytes calldata initCode
    ) internal {
        if (initCode.length != 0) {
            address sender = opInfo.mUserOp.sender;
            if (sender.code.length != 0)
                revert FailedOp(opIndex, "AA10 sender already constructed");
            address sender1 = senderCreator().createSender{
                gas: opInfo.mUserOp.verificationGasLimit
            }(initCode);
            if (sender1 == address(0))
                revert FailedOp(opIndex, "AA13 initCode failed or OOG");
            if (sender1 != sender)
                revert FailedOp(opIndex, "AA14 initCode must return sender");
            if (sender1.code.length == 0)
                revert FailedOp(opIndex, "AA15 initCode must create sender");
            address factory = address(bytes20(initCode[0:20]));
            emit AccountDeployed(
                opInfo.userOpHash,
                sender,
                factory,
                opInfo.mUserOp.paymaster
            );
        }
    }

    /// @inheritdoc IEntryPoint
    function getSenderAddress(bytes calldata initCode) public {
        address sender = senderCreator().createSender(initCode);
        revert SenderAddressResult(sender);
    }

    /**
     * Call account.validateUserOp.
     * Revert (with FailedOp) in case validateUserOp reverts, or account didn't send required prefund.
     * Decrement account's deposit if needed.
     * @param opIndex         - The operation index.
     * @param op              - The user operation.
     * @param opInfo          - The operation info.
     * @param requiredPrefund - The required prefund amount.
     */
    function _validateAccountPrepayment(
        uint256 opIndex,
        PackedUserOperation calldata op,
        UserOpInfo memory opInfo,
        uint256 requiredPrefund,
        uint256 verificationGasLimit
    )
        internal
        returns (
            uint256 validationData
        )
    {
        unchecked {
            MemoryUserOp memory mUserOp = opInfo.mUserOp;
            address sender = mUserOp.sender;
            _createSenderIfNeeded(opIndex, opInfo, op.initCode);
            address paymaster = mUserOp.paymaster;
            uint256 missingAccountFunds = 0;
            if (paymaster == address(0)) {
                uint256 bal = balanceOf(sender);
                missingAccountFunds = bal > requiredPrefund
                    ? 0
                    : requiredPrefund - bal;
            }
            try
                IAccount(sender).validateUserOp{
                    gas: verificationGasLimit
                }(op, opInfo.userOpHash, missingAccountFunds)
            returns (uint256 _validationData) {
                validationData = _validationData;
            } catch {
                revert FailedOpWithRevert(opIndex, "AA23 reverted", Exec.getReturnData(REVERT_REASON_MAX_LEN));
            }
            if (paymaster == address(0)) {
                DepositInfo storage senderInfo = deposits[sender];
                uint256 deposit = senderInfo.deposit;
                if (requiredPrefund > deposit) {
                    revert FailedOp(opIndex, "AA21 didn't pay prefund");
                }
                senderInfo.deposit = deposit - requiredPrefund;
            }
        }
    }

    /**
     * In case the request has a paymaster:
     *  - Validate paymaster has enough deposit.
     *  - Call paymaster.validatePaymasterUserOp.
     *  - Revert with proper FailedOp in case paymaster reverts.
     *  - Decrement paymaster's deposit.
     * @param opIndex                            - The operation index.
     * @param op                                 - The user operation.
     * @param opInfo                             - The operation info.
     * @param requiredPreFund                    - The required prefund amount.
     */
    function _validatePaymasterPrepayment(
        uint256 opIndex,
        PackedUserOperation calldata op,
        UserOpInfo memory opInfo,
        uint256 requiredPreFund
    ) internal returns (bytes memory context, uint256 validationData) {
        unchecked {
            uint256 preGas = gasleft();
            MemoryUserOp memory mUserOp = opInfo.mUserOp;
            address paymaster = mUserOp.paymaster;
            DepositInfo storage paymasterInfo = deposits[paymaster];
            uint256 deposit = paymasterInfo.deposit;
            if (deposit < requiredPreFund) {
                revert FailedOp(opIndex, "AA31 paymaster deposit too low");
            }
            paymasterInfo.deposit = deposit - requiredPreFund;
            uint256 pmVerificationGasLimit = mUserOp.paymasterVerificationGasLimit;
            try
                IPaymaster(paymaster).validatePaymasterUserOp{gas: pmVerificationGasLimit}(
                    op,
                    opInfo.userOpHash,
                    requiredPreFund
                )
            returns (bytes memory _context, uint256 _validationData) {
                context = _context;
                validationData = _validationData;
            } catch {
                revert FailedOpWithRevert(opIndex, "AA33 reverted", Exec.getReturnData(REVERT_REASON_MAX_LEN));
            }
            if (preGas - gasleft() > pmVerificationGasLimit) {
                revert FailedOp(opIndex, "AA36 over paymasterVerificationGasLimit");
            }
        }
    }

    /**
     * Revert if either account validationData or paymaster validationData is expired.
     * @param opIndex                 - The operation index.
     * @param validationData          - The account validationData.
     * @param paymasterValidationData - The paymaster validationData.
     * @param expectedAggregator      - The expected aggregator.
     */
    function _validateAccountAndPaymasterValidationData(
        uint256 opIndex,
        uint256 validationData,
        uint256 paymasterValidationData,
        address expectedAggregator
    ) internal view {
        (address aggregator, bool outOfTimeRange) = _getValidationData(
            validationData
        );
        if (expectedAggregator != aggregator) {
            revert FailedOp(opIndex, "AA24 signature error");
        }
        if (outOfTimeRange) {
            revert FailedOp(opIndex, "AA22 expired or not due");
        }
        // pmAggregator is not a real signature aggregator: we don't have logic to handle it as address.
        // Non-zero address means that the paymaster fails due to some signature check (which is ok only during estimation).
        address pmAggregator;
        (pmAggregator, outOfTimeRange) = _getValidationData(
            paymasterValidationData
        );
        if (pmAggregator != address(0)) {
            revert FailedOp(opIndex, "AA34 signature error");
        }
        if (outOfTimeRange) {
            revert FailedOp(opIndex, "AA32 paymaster expired or not due");
        }
    }

    /**
     * Parse validationData into its components.
     * @param validationData - The packed validation data (sigFailed, validAfter, validUntil).
     * @return aggregator the aggregator of the validationData
     * @return outOfTimeRange true if current time is outside the time range of this validationData.
     */
    function _getValidationData(
        uint256 validationData
    ) internal view returns (address aggregator, bool outOfTimeRange) {
        if (validationData == 0) {
            return (address(0), false);
        }
        ValidationData memory data = _parseValidationData(validationData);
        // solhint-disable-next-line not-rely-on-time
        outOfTimeRange = block.timestamp > data.validUntil || block.timestamp < data.validAfter;
        aggregator = data.aggregator;
    }

    /**
     * Validate account and paymaster (if defined) and
     * also make sure total validation doesn't exceed verificationGasLimit.
     * This method is called off-chain (simulateValidation()) and on-chain (from handleOps)
     * @param opIndex - The index of this userOp into the "opInfos" array.
     * @param userOp  - The userOp to validate.
     */
    function _validatePrepayment(
        uint256 opIndex,
        PackedUserOperation calldata userOp,
        UserOpInfo memory outOpInfo
    )
        internal
        returns (uint256 validationData, uint256 paymasterValidationData)
    {
        uint256 preGas = gasleft();
        MemoryUserOp memory mUserOp = outOpInfo.mUserOp;
        _copyUserOpToMemory(userOp, mUserOp);
        outOpInfo.userOpHash = getUserOpHash(userOp);

        // Validate all numeric values in userOp are well below 128 bit, so they can safely be added
        // and multiplied without causing overflow.
        uint256 verificationGasLimit = mUserOp.verificationGasLimit;
        uint256 maxGasValues = mUserOp.preVerificationGas |
            verificationGasLimit |
            mUserOp.callGasLimit |
            mUserOp.paymasterVerificationGasLimit |
            mUserOp.paymasterPostOpGasLimit |
            mUserOp.maxFeePerGas |
            mUserOp.maxPriorityFeePerGas;
        require(maxGasValues <= type(uint120).max, "AA94 gas values overflow");

        uint256 requiredPreFund = _getRequiredPrefund(mUserOp);
        validationData = _validateAccountPrepayment(
            opIndex,
            userOp,
            outOpInfo,
            requiredPreFund,
            verificationGasLimit
        );

        if (!_validateAndUpdateNonce(mUserOp.sender, mUserOp.nonce)) {
            revert FailedOp(opIndex, "AA25 invalid account nonce");
        }

        unchecked {
            if (preGas - gasleft() > verificationGasLimit) {
                revert FailedOp(opIndex, "AA26 over verificationGasLimit");
            }
        }

        bytes memory context;
        if (mUserOp.paymaster != address(0)) {
            (context, paymasterValidationData) = _validatePaymasterPrepayment(
                opIndex,
                userOp,
                outOpInfo,
                requiredPreFund
            );
        }
        unchecked {
            outOpInfo.prefund = requiredPreFund;
            outOpInfo.contextOffset = getOffsetOfMemoryBytes(context);
            outOpInfo.preOpGas = preGas - gasleft() + userOp.preVerificationGas;
        }
    }

    /**
     * Process post-operation, called just after the callData is executed.
     * If a paymaster is defined and its validation returned a non-empty context, its postOp is called.
     * The excess amount is refunded to the account (or paymaster - if it was used in the request).
     * @param mode      - Whether is called from innerHandleOp, or outside (postOpReverted).
     * @param opInfo    - UserOp fields and info collected during validation.
     * @param context   - The context returned in validatePaymasterUserOp.
     * @param actualGas - The gas used so far by this user operation.
     */
    function _postExecution(
        IPaymaster.PostOpMode mode,
        UserOpInfo memory opInfo,
        bytes memory context,
        uint256 actualGas
    ) private returns (uint256 actualGasCost) {
        uint256 preGas = gasleft();
        unchecked {
            address refundAddress;
            MemoryUserOp memory mUserOp = opInfo.mUserOp;
            uint256 gasPrice = getUserOpGasPrice(mUserOp);

            address paymaster = mUserOp.paymaster;
            if (paymaster == address(0)) {
                refundAddress = mUserOp.sender;
            } else {
                refundAddress = paymaster;
                if (context.length > 0) {
                    actualGasCost = actualGas * gasPrice;
                    if (mode != IPaymaster.PostOpMode.postOpReverted) {
                        try IPaymaster(paymaster).postOp{
                            gas: mUserOp.paymasterPostOpGasLimit
                        }(mode, context, actualGasCost, gasPrice)
                        // solhint-disable-next-line no-empty-blocks
                        {} catch {
                            bytes memory reason = Exec.getReturnData(REVERT_REASON_MAX_LEN);
                            revert PostOpReverted(reason);
                        }
                    }
                }
            }
            actualGas += preGas - gasleft();

            // Calculating a penalty for unused execution gas
            {
                uint256 executionGasLimit = mUserOp.callGasLimit + mUserOp.paymasterPostOpGasLimit;
                uint256 executionGasUsed = actualGas - opInfo.preOpGas;
                // this check is required for the gas used within EntryPoint and not covered by explicit gas limits
                if (executionGasLimit > executionGasUsed) {
                    uint256 unusedGas = executionGasLimit - executionGasUsed;
                    uint256 unusedGasPenalty = (unusedGas * PENALTY_PERCENT) / 100;
                    actualGas += unusedGasPenalty;
                }
            }

            actualGasCost = actualGas * gasPrice;
            uint256 prefund = opInfo.prefund;
            if (prefund < actualGasCost) {
                if (mode == IPaymaster.PostOpMode.postOpReverted) {
                    actualGasCost = prefund;
                    emitPrefundTooLow(opInfo);
                    emitUserOperationEvent(opInfo, false, actualGasCost, actualGas);
                } else {
                    assembly ("memory-safe") {
                        mstore(0, INNER_REVERT_LOW_PREFUND)
                        revert(0, 32)
                    }
                }
            } else {
                uint256 refund = prefund - actualGasCost;
                _incrementDeposit(refundAddress, refund);
                bool success = mode == IPaymaster.PostOpMode.opSucceeded;
                emitUserOperationEvent(opInfo, success, actualGasCost, actualGas);
            }
        } // unchecked
    }

    /**
     * The gas price this UserOp agrees to pay.
     * Relayer/block builder might submit the TX with higher priorityFee, but the user should not.
     * @param mUserOp - The userOp to get the gas price from.
     */
    function getUserOpGasPrice(
        MemoryUserOp memory mUserOp
    ) internal view returns (uint256) {
        unchecked {
            uint256 maxFeePerGas = mUserOp.maxFeePerGas;
            uint256 maxPriorityFeePerGas = mUserOp.maxPriorityFeePerGas;
            if (maxFeePerGas == maxPriorityFeePerGas) {
                //legacy mode (for networks that don't support basefee opcode)
                return maxFeePerGas;
            }
            return min(maxFeePerGas, maxPriorityFeePerGas + block.basefee);
        }
    }

    /**
     * The offset of the given bytes in memory.
     * @param data - The bytes to get the offset of.
     */
    function getOffsetOfMemoryBytes(
        bytes memory data
    ) internal pure returns (uint256 offset) {
        assembly {
            offset := data
        }
    }

    /**
     * The bytes in memory at the given offset.
     * @param offset - The offset to get the bytes from.
     */
    function getMemoryBytesFromOffset(
        uint256 offset
    ) internal pure returns (bytes memory data) {
        assembly ("memory-safe") {
            data := offset
        }
    }

    /// @inheritdoc IEntryPoint
    function delegateAndRevert(address target, bytes calldata data) external {
        (bool success, bytes memory ret) = target.delegatecall(data);
        revert DelegateAndRevert(success, ret);
    }
}

// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity ^0.8.23;

// solhint-disable no-inline-assembly

/**
 * Utility functions helpful when making different kinds of contract calls in Solidity.
 */
library Exec {

    function call(
        address to,
        uint256 value,
        bytes memory data,
        uint256 txGas
    ) internal returns (bool success) {
        assembly ("memory-safe") {
            success := call(txGas, to, value, add(data, 0x20), mload(data), 0, 0)
        }
    }

    function staticcall(
        address to,
        bytes memory data,
        uint256 txGas
    ) internal view returns (bool success) {
        assembly ("memory-safe") {
            success := staticcall(txGas, to, add(data, 0x20), mload(data), 0, 0)
        }
    }

    function delegateCall(
        address to,
        bytes memory data,
        uint256 txGas
    ) internal returns (bool success) {
        assembly ("memory-safe") {
            success := delegatecall(txGas, to, add(data, 0x20), mload(data), 0, 0)
        }
    }

    // get returned data from last call or calldelegate
    function getReturnData(uint256 maxLen) internal pure returns (bytes memory returnData) {
        assembly ("memory-safe") {
            let len := returndatasize()
            if gt(len, maxLen) {
                len := maxLen
            }
            let ptr := mload(0x40)
            mstore(0x40, add(ptr, add(len, 0x20)))
            mstore(ptr, len)
            returndatacopy(add(ptr, 0x20), 0, len)
            returnData := ptr
        }
    }

    // revert with explicit byte array (probably reverted info from call)
    function revertWithData(bytes memory returnData) internal pure {
        assembly ("memory-safe") {
            revert(add(returnData, 32), mload(returnData))
        }
    }

    function callAndRevert(address to, bytes memory data, uint256 maxLen) internal {
        bool success = call(to,0,data,gasleft());
        if (!success) {
            revertWithData(getReturnData(maxLen));
        }
    }
}

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

/* solhint-disable no-inline-assembly */


 /*
  * For simulation purposes, validateUserOp (and validatePaymasterUserOp)
  * must return this value in case of signature failure, instead of revert.
  */
uint256 constant SIG_VALIDATION_FAILED = 1;


/*
 * For simulation purposes, validateUserOp (and validatePaymasterUserOp)
 * return this value on success.
 */
uint256 constant SIG_VALIDATION_SUCCESS = 0;


/**
 * Returned data from validateUserOp.
 * validateUserOp returns a uint256, which is created by `_packedValidationData` and
 * parsed by `_parseValidationData`.
 * @param aggregator  - address(0) - The account validated the signature by itself.
 *                      address(1) - The account failed to validate the signature.
 *                      otherwise - This is an address of a signature aggregator that must
 *                                  be used to validate the signature.
 * @param validAfter  - This UserOp is valid only after this timestamp.
 * @param validaUntil - This UserOp is valid only up to this timestamp.
 */
struct ValidationData {
    address aggregator;
    uint48 validAfter;
    uint48 validUntil;
}

/**
 * Extract sigFailed, validAfter, validUntil.
 * Also convert zero validUntil to type(uint48).max.
 * @param validationData - The packed validation data.
 */
function _parseValidationData(
    uint256 validationData
) pure returns (ValidationData memory data) {
    address aggregator = address(uint160(validationData));
    uint48 validUntil = uint48(validationData >> 160);
    if (validUntil == 0) {
        validUntil = type(uint48).max;
    }
    uint48 validAfter = uint48(validationData >> (48 + 160));
    return ValidationData(aggregator, validAfter, validUntil);
}

/**
 * Helper to pack the return value for validateUserOp.
 * @param data - The ValidationData to pack.
 */
function _packValidationData(
    ValidationData memory data
) pure returns (uint256) {
    return
        uint160(data.aggregator) |
        (uint256(data.validUntil) << 160) |
        (uint256(data.validAfter) << (160 + 48));
}

/**
 * Helper to pack the return value for validateUserOp, when not using an aggregator.
 * @param sigFailed  - True for signature failure, false for success.
 * @param validUntil - Last timestamp this UserOperation is valid (or zero for infinite).
 * @param validAfter - First timestamp this UserOperation is valid.
 */
function _packValidationData(
    bool sigFailed,
    uint48 validUntil,
    uint48 validAfter
) pure returns (uint256) {
    return
        (sigFailed ? 1 : 0) |
        (uint256(validUntil) << 160) |
        (uint256(validAfter) << (160 + 48));
}

/**
 * keccak function over calldata.
 * @dev copy calldata into memory, do keccak and drop allocated memory. Strangely, this is more efficient than letting solidity do it.
 */
    function calldataKeccak(bytes calldata data) pure returns (bytes32 ret) {
        assembly ("memory-safe") {
            let mem := mload(0x40)
            let len := data.length
            calldatacopy(mem, data.offset, len)
            ret := keccak256(mem, len)
        }
    }


/**
 * The minimum of two numbers.
 * @param a - First number.
 * @param b - Second number.
 */
    function min(uint256 a, uint256 b) pure returns (uint256) {
        return a < b ? a : b;
    }

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.5;

import "./PackedUserOperation.sol";

interface IAccount {

    struct Permit {
        address authorizedAddress;
        address verifyingContract;
        uint256 nonce;
        uint256 until;
    }

    struct Call {
        address dest;
        address signer;
        uint256 nonce;
        uint256 value;
        bytes data;
    }
    
    /**
     * Validate user's signature and nonce
     * the entryPoint will make the call to the recipient only if this validation call returns successfully.
     * signature failure should be reported by returning SIG_VALIDATION_FAILED (1).
     * This allows making a "simulation call" without a valid signature
     * Other failures (e.g. nonce mismatch, or invalid signature format) should still revert to signal failure.
     *
     * @dev Must validate caller is the entryPoint.
     *      Must validate the signature and nonce
     * @param userOp              - The operation that is about to be executed.
     * @param userOpHash          - Hash of the user's request data. can be used as the basis for signature.
     * @param missingAccountFunds - Missing funds on the account's deposit in the entrypoint.
     *                              This is the minimum amount to transfer to the sender(entryPoint) to be
     *                              able to make the call. The excess is left as a deposit in the entrypoint
     *                              for future calls. Can be withdrawn anytime using "entryPoint.withdrawTo()".
     *                              In case there is a paymaster in the request (or the current deposit is high
     *                              enough), this value will be zero.
     * @return validationData       - Packaged ValidationData structure. use `_packValidationData` and
     *                              `_unpackValidationData` to encode and decode.
     *                              <20-byte> sigAuthorizer - 0 for valid signature, 1 to mark signature failure,
     *                                 otherwise, an address of an "authorizer" contract.
     *                              <6-byte> validUntil - Last timestamp this operation is valid. 0 for "indefinite"
     *                              <6-byte> validAfter - First timestamp this operation is valid
     *                                                    If an account doesn't use time-range, it is enough to
     *                                                    return SIG_VALIDATION_FAILED value (1) for signature failure.
     *                              Note that the validation code cannot use block.timestamp (or block.number) directly.
     */
    function validateUserOp(
        PackedUserOperation calldata userOp,
        bytes32 userOpHash,
        uint256 missingAccountFunds
    ) external returns (uint256 validationData);

    function call(Call calldata _callData,  bytes calldata signature_) external;
}

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.5;

import "./PackedUserOperation.sol";

interface IAccountExecute {
    /**
     * Account may implement this execute method.
     * passing this methodSig at the beginning of callData will cause the entryPoint to pass the full UserOp (and hash)
     * to the account.
     * The account should skip the methodSig, and use the callData (and optionally, other UserOp fields)
     *
     * @param userOp              - The operation that was just validated.
     * @param userOpHash          - Hash of the user's request data.
     */
    function executeUserOp(
        PackedUserOperation calldata userOp,
        bytes32 userOpHash
    ) external;
}

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.5;

import "./PackedUserOperation.sol";

/**
 * Aggregated Signatures validator.
 */
interface IAggregator {
    /**
     * Validate aggregated signature.
     * Revert if the aggregated signature does not match the given list of operations.
     * @param userOps   - Array of UserOperations to validate the signature for.
     * @param signature - The aggregated signature.
     */
    function validateSignatures(
        PackedUserOperation[] calldata userOps,
        bytes calldata signature
    ) external view;

    /**
     * Validate signature of a single userOp.
     * This method should be called by bundler after EntryPointSimulation.simulateValidation() returns
     * the aggregator this account uses.
     * First it validates the signature over the userOp. Then it returns data to be used when creating the handleOps.
     * @param userOp        - The userOperation received from the user.
     * @return sigForUserOp - The value to put into the signature field of the userOp when calling handleOps.
     *                        (usually empty, unless account and aggregator support some kind of "multisig".
     */
    function validateUserOpSignature(
        PackedUserOperation calldata userOp
    ) external view returns (bytes memory sigForUserOp);

    /**
     * Aggregate multiple signatures into a single value.
     * This method is called off-chain to calculate the signature to pass with handleOps()
     * bundler MAY use optimized custom code perform this aggregation.
     * @param userOps              - Array of UserOperations to collect the signatures from.
     * @return aggregatedSignature - The aggregated signature.
     */
    function aggregateSignatures(
        PackedUserOperation[] calldata userOps
    ) external view returns (bytes memory aggregatedSignature);
}

/**
 ** Account-Abstraction (EIP-4337) singleton EntryPoint implementation.
 ** Only one instance required on each chain.
 **/
// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.5;

/* solhint-disable avoid-low-level-calls */
/* solhint-disable no-inline-assembly */
/* solhint-disable reason-string */

import "./PackedUserOperation.sol";
import "./IStakeManager.sol";
import "./IAggregator.sol";
import "./INonceManager.sol";

interface IEntryPoint is IStakeManager, INonceManager {
    /***
     * An event emitted after each successful request.
     * @param userOpHash    - Unique identifier for the request (hash its entire content, except signature).
     * @param sender        - The account that generates this request.
     * @param paymaster     - If non-null, the paymaster that pays for this request.
     * @param nonce         - The nonce value from the request.
     * @param success       - True if the sender transaction succeeded, false if reverted.
     * @param actualGasCost - Actual amount paid (by account or paymaster) for this UserOperation.
     * @param actualGasUsed - Total gas used by this UserOperation (including preVerification, creation,
     *                        validation and execution).
     */
    event UserOperationEvent(
        bytes32 indexed userOpHash,
        address indexed sender,
        address indexed paymaster,
        uint256 nonce,
        bool success,
        uint256 actualGasCost,
        uint256 actualGasUsed
    );

    /**
     * Account "sender" was deployed.
     * @param userOpHash - The userOp that deployed this account. UserOperationEvent will follow.
     * @param sender     - The account that is deployed
     * @param factory    - The factory used to deploy this account (in the initCode)
     * @param paymaster  - The paymaster used by this UserOp
     */
    event AccountDeployed(
        bytes32 indexed userOpHash,
        address indexed sender,
        address factory,
        address paymaster
    );

    /**
     * An event emitted if the UserOperation "callData" reverted with non-zero length.
     * @param userOpHash   - The request unique identifier.
     * @param sender       - The sender of this request.
     * @param nonce        - The nonce used in the request.
     * @param revertReason - The return bytes from the (reverted) call to "callData".
     */
    event UserOperationRevertReason(
        bytes32 indexed userOpHash,
        address indexed sender,
        uint256 nonce,
        bytes revertReason
    );

    /**
     * An event emitted if the UserOperation Paymaster's "postOp" call reverted with non-zero length.
     * @param userOpHash   - The request unique identifier.
     * @param sender       - The sender of this request.
     * @param nonce        - The nonce used in the request.
     * @param revertReason - The return bytes from the (reverted) call to "callData".
     */
    event PostOpRevertReason(
        bytes32 indexed userOpHash,
        address indexed sender,
        uint256 nonce,
        bytes revertReason
    );

    /**
     * UserOp consumed more than prefund. The UserOperation is reverted, and no refund is made.
     * @param userOpHash   - The request unique identifier.
     * @param sender       - The sender of this request.
     * @param nonce        - The nonce used in the request.
     */
    event UserOperationPrefundTooLow(
        bytes32 indexed userOpHash,
        address indexed sender,
        uint256 nonce
    );

    /**
     * An event emitted by handleOps(), before starting the execution loop.
     * Any event emitted before this event, is part of the validation.
     */
    event BeforeExecution();

    /**
     * Signature aggregator used by the following UserOperationEvents within this bundle.
     * @param aggregator - The aggregator used for the following UserOperationEvents.
     */
    event SignatureAggregatorChanged(address indexed aggregator);

    /**
     * A custom revert error of handleOps, to identify the offending op.
     * Should be caught in off-chain handleOps simulation and not happen on-chain.
     * Useful for mitigating DoS attempts against batchers or for troubleshooting of factory/account/paymaster reverts.
     * NOTE: If simulateValidation passes successfully, there should be no reason for handleOps to fail on it.
     * @param opIndex - Index into the array of ops to the failed one (in simulateValidation, this is always zero).
     * @param reason  - Revert reason. The string starts with a unique code "AAmn",
     *                  where "m" is "1" for factory, "2" for account and "3" for paymaster issues,
     *                  so a failure can be attributed to the correct entity.
     */
    error FailedOp(uint256 opIndex, string reason);

    /**
     * A custom revert error of handleOps, to report a revert by account or paymaster.
     * @param opIndex - Index into the array of ops to the failed one (in simulateValidation, this is always zero).
     * @param reason  - Revert reason. see FailedOp(uint256,string), above
     * @param inner   - data from inner cought revert reason
     * @dev note that inner is truncated to 2048 bytes
     */
    error FailedOpWithRevert(uint256 opIndex, string reason, bytes inner);

    error PostOpReverted(bytes returnData);

    /**
     * Error case when a signature aggregator fails to verify the aggregated signature it had created.
     * @param aggregator The aggregator that failed to verify the signature
     */
    error SignatureValidationFailed(address aggregator);

    // Return value of getSenderAddress.
    error SenderAddressResult(address sender);

    // UserOps handled, per aggregator.
    struct UserOpsPerAggregator {
        PackedUserOperation[] userOps;
        // Aggregator address
        IAggregator aggregator;
        // Aggregated signature
        bytes signature;
    }

    /**
     * Execute a batch of UserOperations.
     * No signature aggregator is used.
     * If any account requires an aggregator (that is, it returned an aggregator when
     * performing simulateValidation), then handleAggregatedOps() must be used instead.
     * @param ops         - The operations to execute.
     * @param beneficiary - The address to receive the fees.
     */
    function handleOps(
        PackedUserOperation[] calldata ops,
        address payable beneficiary
    ) external;

    /**
     * Execute a batch of UserOperation with Aggregators
     * @param opsPerAggregator - The operations to execute, grouped by aggregator (or address(0) for no-aggregator accounts).
     * @param beneficiary      - The address to receive the fees.
     */
    function handleAggregatedOps(
        UserOpsPerAggregator[] calldata opsPerAggregator,
        address payable beneficiary
    ) external;

    /**
     * Generate a request Id - unique identifier for this request.
     * The request ID is a hash over the content of the userOp (except the signature), the entrypoint and the chainid.
     * @param userOp - The user operation to generate the request ID for.
     * @return hash the hash of this UserOperation
     */
    function getUserOpHash(
        PackedUserOperation calldata userOp
    ) external view returns (bytes32);

    /**
     * Gas and return values during simulation.
     * @param preOpGas         - The gas used for validation (including preValidationGas)
     * @param prefund          - The required prefund for this operation
     * @param accountValidationData   - returned validationData from account.
     * @param paymasterValidationData - return validationData from paymaster.
     * @param paymasterContext - Returned by validatePaymasterUserOp (to be passed into postOp)
     */
    struct ReturnInfo {
        uint256 preOpGas;
        uint256 prefund;
        uint256 accountValidationData;
        uint256 paymasterValidationData;
        bytes paymasterContext;
    }

    /**
     * Returned aggregated signature info:
     * The aggregator returned by the account, and its current stake.
     */
    struct AggregatorStakeInfo {
        address aggregator;
        StakeInfo stakeInfo;
    }

    /**
     * Get counterfactual sender address.
     * Calculate the sender contract address that will be generated by the initCode and salt in the UserOperation.
     * This method always revert, and returns the address in SenderAddressResult error
     * @param initCode - The constructor code to be passed into the UserOperation.
     */
    function getSenderAddress(bytes memory initCode) external;

    error DelegateAndRevert(bool success, bytes ret);

    /**
     * Helper method for dry-run testing.
     * @dev calling this method, the EntryPoint will make a delegatecall to the given data, and report (via revert) the result.
     *  The method always revert, so is only useful off-chain for dry run calls, in cases where state-override to replace
     *  actual EntryPoint code is less convenient.
     * @param target a target contract to make a delegatecall from entrypoint
     * @param data data to pass to target in a delegatecall
     */
    function delegateAndRevert(address target, bytes calldata data) external;
}

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.5;

interface INonceManager {

    /**
     * Return the next nonce for this sender.
     * Within a given key, the nonce values are sequenced (starting with zero, and incremented by one on each userop)
     * But UserOp with different keys can come with arbitrary order.
     *
     * @param sender the account address
     * @param key the high 192 bit of the nonce
     * @return nonce a full nonce to pass for next UserOp with this sender.
     */
    function getNonce(address sender, uint192 key)
    external view returns (uint256 nonce);

    /**
     * Manually increment the nonce of the sender.
     * This method is exposed just for completeness..
     * Account does NOT need to call it, neither during validation, nor elsewhere,
     * as the EntryPoint will update the nonce regardless.
     * Possible use-case is call it with various keys to "initialize" their nonces to one, so that future
     * UserOperations will not pay extra for the first transaction with a given key.
     */
    function incrementNonce(uint192 key) external;
}

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.5;

import "./PackedUserOperation.sol";

/**
 * The interface exposed by a paymaster contract, who agrees to pay the gas for user's operations.
 * A paymaster must hold a stake to cover the required entrypoint stake and also the gas for the transaction.
 */
interface IPaymaster {
    enum PostOpMode {
        // User op succeeded.
        opSucceeded,
        // User op reverted. Still has to pay for gas.
        opReverted,
        // Only used internally in the EntryPoint (cleanup after postOp reverts). Never calling paymaster with this value
        postOpReverted
    }

    /**
     * Payment validation: check if paymaster agrees to pay.
     * Must verify sender is the entryPoint.
     * Revert to reject this request.
     * Note that bundlers will reject this method if it changes the state, unless the paymaster is trusted (whitelisted).
     * The paymaster pre-pays using its deposit, and receive back a refund after the postOp method returns.
     * @param userOp          - The user operation.
     * @param userOpHash      - Hash of the user's request data.
     * @param maxCost         - The maximum cost of this transaction (based on maximum gas and gas price from userOp).
     * @return context        - Value to send to a postOp. Zero length to signify postOp is not required.
     * @return validationData - Signature and time-range of this operation, encoded the same as the return
     *                          value of validateUserOperation.
     *                          <20-byte> sigAuthorizer - 0 for valid signature, 1 to mark signature failure,
     *                                                    other values are invalid for paymaster.
     *                          <6-byte> validUntil - last timestamp this operation is valid. 0 for "indefinite"
     *                          <6-byte> validAfter - first timestamp this operation is valid
     *                          Note that the validation code cannot use block.timestamp (or block.number) directly.
     */
    function validatePaymasterUserOp(
        PackedUserOperation calldata userOp,
        bytes32 userOpHash,
        uint256 maxCost
    ) external returns (bytes memory context, uint256 validationData);

    /**
     * Post-operation handler.
     * Must verify sender is the entryPoint.
     * @param mode          - Enum with the following options:
     *                        opSucceeded - User operation succeeded.
     *                        opReverted  - User op reverted. The paymaster still has to pay for gas.
     *                        postOpReverted - never passed in a call to postOp().
     * @param context       - The context value returned by validatePaymasterUserOp
     * @param actualGasCost - Actual gas used so far (without this postOp call).
     * @param actualUserOpFeePerGas - the gas price this UserOp pays. This value is based on the UserOp's maxFeePerGas
     *                        and maxPriorityFee (and basefee)
     *                        It is not the same as tx.gasprice, which is what the bundler pays.
     */
    function postOp(
        PostOpMode mode,
        bytes calldata context,
        uint256 actualGasCost,
        uint256 actualUserOpFeePerGas
    ) external;
}

// SPDX-License-Identifier: GPL-3.0-only
pragma solidity >=0.7.5;

/**
 * Manage deposits and stakes.
 * Deposit is just a balance used to pay for UserOperations (either by a paymaster or an account).
 * Stake is value locked for at least "unstakeDelay" by the staked entity.
 */
interface IStakeManager {
    event Deposited(address indexed account, uint256 totalDeposit);

    event Withdrawn(
        address indexed account,
        address withdrawAddress,
        uint256 amount
    );

    // Emitted when stake or unstake delay are modified.
    event StakeLocked(
        address indexed account,
        uint256 totalStaked,
        uint256 unstakeDelaySec
    );

    // Emitted once a stake is scheduled for withdrawal.
    event StakeUnlocked(address indexed account, uint256 withdrawTime);

    event StakeWithdrawn(
        address indexed account,
        address withdrawAddress,
        uint256 amount
    );

    /**
     * @param deposit         - The entity's deposit.
     * @param staked          - True if this entity is staked.
     * @param stake           - Actual amount of ether staked for this entity.
     * @param unstakeDelaySec - Minimum delay to withdraw the stake.
     * @param withdrawTime    - First block timestamp where 'withdrawStake' will be callable, or zero if already locked.
     * @dev Sizes were chosen so that deposit fits into one cell (used during handleOp)
     *      and the rest fit into a 2nd cell (used during stake/unstake)
     *      - 112 bit allows for 10^15 eth
     *      - 48 bit for full timestamp
     *      - 32 bit allows 150 years for unstake delay
     */
    struct DepositInfo {
        uint256 deposit;
        bool staked;
        uint112 stake;
        uint32 unstakeDelaySec;
        uint48 withdrawTime;
    }

    // API struct used by getStakeInfo and simulateValidation.
    struct StakeInfo {
        uint256 stake;
        uint256 unstakeDelaySec;
    }

    /**
     * Get deposit info.
     * @param account - The account to query.
     * @return info   - Full deposit information of given account.
     */
    function getDepositInfo(
        address account
    ) external view returns (DepositInfo memory info);

    /**
     * Get account balance.
     * @param account - The account to query.
     * @return        - The deposit (for gas payment) of the account.
     */
    function balanceOf(address account) external view returns (uint256);

    /**
     * Add to the deposit of the given account.
     * @param account - The account to add to.
     */
    function depositTo(address account) external payable;

    /**
     * Add to the account's stake - amount and delay
     * any pending unstake is first cancelled.
     * @param _unstakeDelaySec - The new lock duration before the deposit can be withdrawn.
     */
    function addStake(uint32 _unstakeDelaySec) external payable;

    /**
     * Attempt to unlock the stake.
     * The value can be withdrawn (using withdrawStake) after the unstake delay.
     */
    function unlockStake() external;

    /**
     * Withdraw from the (unlocked) stake.
     * Must first call unlockStake and wait for the unstakeDelay to pass.
     * @param withdrawAddress - The address to send withdrawn value.
     */
    function withdrawStake(address payable withdrawAddress) external;

    /**
     * Withdraw from the deposit.
     * @param withdrawAddress - The address to send withdrawn value.
     * @param withdrawAmount  - The amount to withdraw.
     */
    function withdrawTo(
        address payable withdrawAddress,
        uint256 withdrawAmount
    ) external;
}

// SPDX-License-Identifier: GPL-3.0
pragma solidity >=0.7.5;

/**
 * User Operation struct
 * @param sender                - The sender account of this request.
 * @param nonce                 - Unique value the sender uses to verify it is not a replay.
 * @param initCode              - If set, the account contract will be created by this constructor/
 * @param callData              - The method call to execute on this account.
 * @param accountGasLimits      - Packed gas limits for validateUserOp and gas limit passed to the callData method call.
 * @param preVerificationGas    - Gas not calculated by the handleOps method, but added to the gas paid.
 *                                Covers batch overhead.
 * @param gasFees               - packed gas fields maxPriorityFeePerGas and maxFeePerGas - Same as EIP-1559 gas parameters.
 * @param paymasterAndData      - If set, this field holds the paymaster address, verification gas limit, postOp gas limit and paymaster-specific extra data
 *                                The paymaster will pay for the transaction instead of the sender.
 * @param signature             - Sender-verified signature over the entire request, the EntryPoint address and the chain ID.
 */
struct PackedUserOperation {
    address sender;
    uint256 nonce;
    bytes initCode;
    bytes callData;
    bytes32 accountGasLimits;
    uint256 preVerificationGas;
    bytes32 gasFees;
    bytes paymasterAndData;
    bytes signature;
}

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

import "./interfaces/INonceManager.sol";

/**
 * nonce management functionality
 */
abstract contract NonceManager is INonceManager {

    /**
     * The next valid sequence number for a given nonce key.
     */
    mapping(address => mapping(uint192 => uint256)) public nonceSequenceNumber;

    /// @inheritdoc INonceManager
    function getNonce(address sender, uint192 key)
    public view override returns (uint256 nonce) {
        return nonceSequenceNumber[sender][key] | (uint256(key) << 64);
    }

    // allow an account to manually increment its own nonce.
    // (mainly so that during construction nonce can be made non-zero,
    // to "absorb" the gas cost of first nonce increment to 1st transaction (construction),
    // not to 2nd transaction)
    function incrementNonce(uint192 key) public override {
        nonceSequenceNumber[msg.sender][key]++;
    }

    /**
     * validate nonce uniqueness for this account.
     * called just after validateUserOp()
     * @return true if the nonce was incremented successfully.
     *         false if the current nonce doesn't match the given one.
     */
    function _validateAndUpdateNonce(address sender, uint256 nonce) internal returns (bool) {

        uint192 key = uint192(nonce >> 64);
        uint64 seq = uint64(nonce);
        return nonceSequenceNumber[sender][key]++ == seq;
    }

}

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

/**
 * Helper contract for EntryPoint, to call userOp.initCode from a "neutral" address,
 * which is explicitly not the entryPoint itself.
 */
contract SenderCreator {
    /**
     * Call the "initCode" factory to create and return the sender account address.
     * @param initCode - The initCode value from a UserOp. contains 20 bytes of factory address,
     *                   followed by calldata.
     * @return sender  - The returned address of the created account, or zero address on failure.
     */
    function createSender(
        bytes calldata initCode
    ) external returns (address sender) {
        address factory = address(bytes20(initCode[0:20]));
        bytes memory initCallData = initCode[20:];
        bool success;
        /* solhint-disable no-inline-assembly */
        assembly ("memory-safe") {
            success := call(
                gas(),
                factory,
                0,
                add(initCallData, 0x20),
                mload(initCallData),
                0,
                32
            )
            sender := mload(0)
        }
        if (!success) {
            sender = address(0);
        }
    }
}

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

/* solhint-disable avoid-low-level-calls */
/* solhint-disable no-inline-assembly */
/* solhint-disable reason-string */

import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
import "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
import "@openzeppelin/contracts/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";
import "./BaseAccount.sol";
import ".//Helpers.sol";
import "./TokenCallbackHandler.sol";

/**
  * minimal account.
  *  this is sample minimal account.
  *  has execute, eth handling methods
  *  has a single signer that can send requests through the entryPoint.
  */
contract SimpleAccount is BaseAccount, TokenCallbackHandler, UUPSUpgradeable, Initializable, EIP712 {
    using ECDSA for bytes32;

    error Expired();
    error InvalidSigner(address recoveredAddress, address signer);
    error InvalidNonce(uint256 nonce);


    bytes32 public constant PERMIT_TYPEHASH =
        keccak256("Permit(address authorizedAddress,address verifyingContract,uint256 nonce,uint256 until)");

    address public owner;

    string public name = "WINR Account";

    string public version = "1";

    uint256 public nonce = 0;

    IEntryPoint private immutable _entryPoint;

    mapping(address authorizedAddress => uint256 until) allowList;
    mapping(address unauthorizer => bool) unauthorizers;

    event SimpleAccountInitialized(IEntryPoint indexed entryPoint, address indexed owner);

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

    /// @inheritdoc BaseAccount
    function entryPoint() public view virtual override returns (IEntryPoint) {
        return _entryPoint;
    }

    // solhint-disable-next-line no-empty-blocks
    receive() external payable {}

    constructor(IEntryPoint anEntryPoint) EIP712(name, version) {
        _entryPoint = anEntryPoint;
        _disableInitializers();
    }

    function verifySigner(Permit memory _permit, bytes calldata signature) public view  {
        if (_permit.until < block.timestamp) revert Expired();

        bytes32 structHash = keccak256(
            abi.encode(
                PERMIT_TYPEHASH,
                _permit.authorizedAddress,
                address(this),
                nonce,
                _permit.until
            )
        );

        bytes32 digest = _hashTypedDataV4(structHash);
        address recoveredAddress = digest.recover(signature);
        if (recoveredAddress != owner) {
            revert InvalidSigner(recoveredAddress, owner);
        }

    }
    function _onlyOwner() internal view {
        //directly from EOA owner, or through the account itself (which gets redirected through execute())
        require(msg.sender == owner || msg.sender == address(this), "only owner");
    }


    function _requireAuth(address signer) internal view {
        uint256 until = allowList[signer];
        require(until > 0 && until > block.timestamp, "account: not authenticated");
    }


    function authorize(Permit memory _permit, bytes calldata signature, address unaouthorizerAddress) external {
        verifySigner(_permit, signature);
        allowList[_permit.authorizedAddress] = _permit.until;
        unauthorizers[unaouthorizerAddress] = true;
        nonce++;
    }

    function unauthorize(address authorizedAddress) external {
        if(!unauthorizers[msg.sender]) {
            _requireFromEntryPointOrOwner();
        }
        unauthorizers[msg.sender] = false;
        allowList[authorizedAddress] = 0;
        nonce++;
    }

    function call(Call calldata _callData,  bytes calldata signature_) external {
        verifySession(_callData, signature_);
        nonce++;
        _call(_callData.dest, _callData.value, _callData.data);
    }

    function isAllowed(address caller) external view returns (bool) {
        return allowList[caller] > block.timestamp;
    }

    function hashCall(Call calldata _callData) public pure returns (bytes32) {    
        // Hash the _call's data using keccak256 and return the resulting bytes32 value
        return keccak256(abi.encode(_callData));
    }


    function verifySession(Call calldata _callData, bytes calldata signature_) public view {
        if(_callData.nonce != nonce) {
            revert InvalidNonce(_callData.nonce);
        }

        // Calculate the Ethereum signed message hash of the order and then recover the signer's address
        address signer = ECDSA.recover(MessageHashUtils.toEthSignedMessageHash(keccak256(abi.encode(_callData))), signature_);
        
        if(signer != _callData.signer) {
            revert InvalidSigner(signer, _callData.signer);
        }

        _requireAuth(signer);
    }

    /**
     * execute a transaction (called directly from owner, or by entryPoint)
     * @param dest destination address to call
     * @param value the value to pass in this call
     * @param func the calldata to pass in this call
     */
    function execute(address dest, uint256 value, bytes calldata func) external {
        _requireFromEntryPointOrOwner();
        _call(dest, value, func);
    }

    /**
     * execute a sequence of transactions
     * @dev to reduce gas consumption for trivial case (no value), use a zero-length array to mean zero value
     * @param dest an array of destination addresses
     * @param value an array of values to pass to each call. can be zero-length for no-value calls
     * @param func an array of calldata to pass to each call
     */
    function executeBatch(address[] calldata dest, uint256[] calldata value, bytes[] calldata func) external {
        _requireFromEntryPointOrOwner();
        require(dest.length == func.length && (value.length == 0 || value.length == func.length), "wrong array lengths");
        if (value.length == 0) {
            for (uint256 i = 0; i < dest.length; i++) {
                _call(dest[i], 0, func[i]);
            }
        } else {
            for (uint256 i = 0; i < dest.length; i++) {
                _call(dest[i], value[i], func[i]);
            }
        }
    }

    /**
     * @dev The _entryPoint member is immutable, to reduce gas consumption.  To upgrade EntryPoint,
     * a new implementation of SimpleAccount must be deployed with the new EntryPoint address, then upgrading
      * the implementation by calling `upgradeTo()`
      * @param anOwner the owner (signer) of this account
     */
    function initialize(address anOwner) public virtual initializer {
        _initialize(anOwner);
    }

    function _initialize(address anOwner) internal virtual {
        owner = anOwner;
        emit SimpleAccountInitialized(_entryPoint, owner);
    }

    // Require the function call went through EntryPoint or owner
    function _requireFromEntryPointOrOwner() internal view {
        require(msg.sender == address(entryPoint()) || msg.sender == owner, "account: not Owner or EntryPoint");
    }

    /// implement template method of BaseAccount
    function _validateSignature(PackedUserOperation calldata userOp, bytes32 userOpHash)
    internal override virtual returns (uint256 validationData) {
        bytes32 hash = MessageHashUtils.toEthSignedMessageHash(userOpHash);
        if (owner != ECDSA.recover(hash, userOp.signature))
            return SIG_VALIDATION_FAILED;
        return SIG_VALIDATION_SUCCESS;
    }

    function _call(address target, uint256 value, bytes memory data) internal {
        (bool success, bytes memory result) = target.call{value: value}(data);
        if (!success) {
            assembly {
                revert(add(result, 32), mload(result))
            }
        }
    }

    /**
     * check current account deposit in the entryPoint
     */
    function getDeposit() public view returns (uint256) {
        return entryPoint().balanceOf(address(this));
    }

    /**
     * deposit more funds for this account in the entryPoint
     */
    function addDeposit() public payable {
        entryPoint().depositTo{value: msg.value}(address(this));
    }

    /**
     * withdraw value from the account's deposit
     * @param withdrawAddress target to send to
     * @param amount to withdraw
     */
    function withdrawDepositTo(address payable withdrawAddress, uint256 amount) public onlyOwner {
        entryPoint().withdrawTo(withdrawAddress, amount);
    }

    function _authorizeUpgrade(address newImplementation) internal view override {
        (newImplementation);
        _onlyOwner();
    }
}

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

import "@openzeppelin/contracts/utils/Create2.sol";
import "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";

import "./SimpleAccount.sol";

/**
 * A sample factory contract for SimpleAccount
 * A UserOperations "initCode" holds the address of the factory, and a method call (to createAccount, in this sample factory).
 * The factory's createAccount returns the target account address even if it is already installed.
 * This way, the entryPoint.getSenderAddress() can be called either before or after the account is created.
 */
contract SimpleAccountFactory {
    SimpleAccount public immutable accountImplementation;

    constructor(IEntryPoint _entryPoint) {
        accountImplementation = new SimpleAccount(_entryPoint);
    }

    /**
     * create an account, and return its address.
     * returns the address even if the account is already deployed.
     * Note that during UserOperation execution, this method is called only if the account is not deployed.
     * This method returns an existing account address so that entryPoint.getSenderAddress() would work even after account creation
     */
    function createAccount(address owner,uint256 salt) public returns (SimpleAccount ret) {
        address addr = getAddress(owner, salt);
        uint256 codeSize = addr.code.length;
        if (codeSize > 0) {
            return SimpleAccount(payable(addr));
        }
        ret = SimpleAccount(payable(new ERC1967Proxy{salt : bytes32(salt)}(
                address(accountImplementation),
                abi.encodeCall(SimpleAccount.initialize, (owner))
            )));
    }

    /**
     * calculate the counterfactual address of this account as it would be returned by createAccount()
     */
    function getAddress(address owner,uint256 salt) public view returns (address) {
        return Create2.computeAddress(bytes32(salt), keccak256(abi.encodePacked(
                type(ERC1967Proxy).creationCode,
                abi.encode(
                    address(accountImplementation),
                    abi.encodeCall(SimpleAccount.initialize, (owner))
                )
            )));
    }
}

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

import "./interfaces/IStakeManager.sol";

/* solhint-disable avoid-low-level-calls */
/* solhint-disable not-rely-on-time */

/**
 * Manage deposits and stakes.
 * Deposit is just a balance used to pay for UserOperations (either by a paymaster or an account).
 * Stake is value locked for at least "unstakeDelay" by a paymaster.
 */
abstract contract StakeManager is IStakeManager {
    /// maps paymaster to their deposits and stakes
    mapping(address => DepositInfo) public deposits;

    /// @inheritdoc IStakeManager
    function getDepositInfo(
        address account
    ) public view returns (DepositInfo memory info) {
        return deposits[account];
    }

    /**
     * Internal method to return just the stake info.
     * @param addr - The account to query.
     */
    function _getStakeInfo(
        address addr
    ) internal view returns (StakeInfo memory info) {
        DepositInfo storage depositInfo = deposits[addr];
        info.stake = depositInfo.stake;
        info.unstakeDelaySec = depositInfo.unstakeDelaySec;
    }

    /// @inheritdoc IStakeManager
    function balanceOf(address account) public view returns (uint256) {
        return deposits[account].deposit;
    }

    receive() external payable {
        depositTo(msg.sender);
    }

    /**
     * Increments an account's deposit.
     * @param account - The account to increment.
     * @param amount  - The amount to increment by.
     * @return the updated deposit of this account
     */
    function _incrementDeposit(address account, uint256 amount) internal returns (uint256) {
        DepositInfo storage info = deposits[account];
        uint256 newAmount = info.deposit + amount;
        info.deposit = newAmount;
        return newAmount;
    }

    /**
     * Add to the deposit of the given account.
     * @param account - The account to add to.
     */
    function depositTo(address account) public virtual payable {
        uint256 newDeposit = _incrementDeposit(account, msg.value);
        emit Deposited(account, newDeposit);
    }

    /**
     * Add to the account's stake - amount and delay
     * any pending unstake is first cancelled.
     * @param unstakeDelaySec The new lock duration before the deposit can be withdrawn.
     */
    function addStake(uint32 unstakeDelaySec) public payable {
        DepositInfo storage info = deposits[msg.sender];
        require(unstakeDelaySec > 0, "must specify unstake delay");
        require(
            unstakeDelaySec >= info.unstakeDelaySec,
            "cannot decrease unstake time"
        );
        uint256 stake = info.stake + msg.value;
        require(stake > 0, "no stake specified");
        require(stake <= type(uint112).max, "stake overflow");
        deposits[msg.sender] = DepositInfo(
            info.deposit,
            true,
            uint112(stake),
            unstakeDelaySec,
            0
        );
        emit StakeLocked(msg.sender, stake, unstakeDelaySec);
    }

    /**
     * Attempt to unlock the stake.
     * The value can be withdrawn (using withdrawStake) after the unstake delay.
     */
    function unlockStake() external {
        DepositInfo storage info = deposits[msg.sender];
        require(info.unstakeDelaySec != 0, "not staked");
        require(info.staked, "already unstaking");
        uint48 withdrawTime = uint48(block.timestamp) + info.unstakeDelaySec;
        info.withdrawTime = withdrawTime;
        info.staked = false;
        emit StakeUnlocked(msg.sender, withdrawTime);
    }

    /**
     * Withdraw from the (unlocked) stake.
     * Must first call unlockStake and wait for the unstakeDelay to pass.
     * @param withdrawAddress - The address to send withdrawn value.
     */
    function withdrawStake(address payable withdrawAddress) external {
        DepositInfo storage info = deposits[msg.sender];
        uint256 stake = info.stake;
        require(stake > 0, "No stake to withdraw");
        require(info.withdrawTime > 0, "must call unlockStake() first");
        require(
            info.withdrawTime <= block.timestamp,
            "Stake withdrawal is not due"
        );
        info.unstakeDelaySec = 0;
        info.withdrawTime = 0;
        info.stake = 0;
        emit StakeWithdrawn(msg.sender, withdrawAddress, stake);
        (bool success,) = withdrawAddress.call{value: stake}("");
        require(success, "failed to withdraw stake");
    }

    /**
     * Withdraw from the deposit.
     * @param withdrawAddress - The address to send withdrawn value.
     * @param withdrawAmount  - The amount to withdraw.
     */
    function withdrawTo(
        address payable withdrawAddress,
        uint256 withdrawAmount
    ) external {
        DepositInfo storage info = deposits[msg.sender];
        require(withdrawAmount <= info.deposit, "Withdraw amount too large");
        info.deposit = info.deposit - withdrawAmount;
        emit Withdrawn(msg.sender, withdrawAddress, withdrawAmount);
        (bool success,) = withdrawAddress.call{value: withdrawAmount}("");
        require(success, "failed to withdraw");
    }
}

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

/* solhint-disable no-empty-blocks */

import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
import "@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol";

/**
 * Token callback handler.
 *   Handles supported tokens' callbacks, allowing account receiving these tokens.
 */
abstract contract TokenCallbackHandler is IERC721Receiver, IERC1155Receiver {

    function onERC721Received(
        address,
        address,
        uint256,
        bytes calldata
    ) external pure override returns (bytes4) {
        return IERC721Receiver.onERC721Received.selector;
    }

    function onERC1155Received(
        address,
        address,
        uint256,
        uint256,
        bytes calldata
    ) external pure override returns (bytes4) {
        return IERC1155Receiver.onERC1155Received.selector;
    }

    function onERC1155BatchReceived(
        address,
        address,
        uint256[] calldata,
        uint256[] calldata,
        bytes calldata
    ) external pure override returns (bytes4) {
        return IERC1155Receiver.onERC1155BatchReceived.selector;
    }

    function supportsInterface(bytes4 interfaceId) external view virtual override returns (bool) {
        return
            interfaceId == type(IERC721Receiver).interfaceId ||
            interfaceId == type(IERC1155Receiver).interfaceId ||
            interfaceId == type(IERC165).interfaceId;
    }
}

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

/* solhint-disable no-inline-assembly */

import "./interfaces/PackedUserOperation.sol";
import {calldataKeccak, min} from "./Helpers.sol";

/**
 * Utility functions helpful when working with UserOperation structs.
 */
library UserOperationLib {

    uint256 public constant PAYMASTER_VALIDATION_GAS_OFFSET = 20;
    uint256 public constant PAYMASTER_POSTOP_GAS_OFFSET = 36;
    uint256 public constant PAYMASTER_DATA_OFFSET = 52;
    /**
     * Get sender from user operation data.
     * @param userOp - The user operation data.
     */
    function getSender(
        PackedUserOperation calldata userOp
    ) internal pure returns (address) {
        address data;
        //read sender from userOp, which is first userOp member (saves 800 gas...)
        assembly {
            data := calldataload(userOp)
        }
        return address(uint160(data));
    }

    /**
     * Relayer/block builder might submit the TX with higher priorityFee,
     * but the user should not pay above what he signed for.
     * @param userOp - The user operation data.
     */
    function gasPrice(
        PackedUserOperation calldata userOp
    ) internal view returns (uint256) {
        unchecked {
            (uint256 maxPriorityFeePerGas, uint256 maxFeePerGas) = unpackUints(userOp.gasFees);
            if (maxFeePerGas == maxPriorityFeePerGas) {
                //legacy mode (for networks that don't support basefee opcode)
                return maxFeePerGas;
            }
            return min(maxFeePerGas, maxPriorityFeePerGas + block.basefee);
        }
    }

    /**
     * Pack the user operation data into bytes for hashing.
     * @param userOp - The user operation data.
     */
    function encode(
        PackedUserOperation calldata userOp
    ) internal pure returns (bytes memory ret) {
        address sender = getSender(userOp);
        uint256 nonce = userOp.nonce;
        bytes32 hashInitCode = calldataKeccak(userOp.initCode);
        bytes32 hashCallData = calldataKeccak(userOp.callData);
        bytes32 hashPaymasterAndData = calldataKeccak(userOp.paymasterAndData);

        return abi.encode(
            sender, nonce,
            hashInitCode, hashCallData,
            hashPaymasterAndData
        );
    }

    function unpackUints(
        bytes32 packed
    ) internal pure returns (uint256 high128, uint256 low128) {
        return (uint128(bytes16(packed)), uint128(uint256(packed)));
    }

    //unpack just the high 128-bits from a packed value
    function unpackHigh128(bytes32 packed) internal pure returns (uint256) {
        return uint256(packed) >> 128;
    }

    // unpack just the low 128-bits from a packed value
    function unpackLow128(bytes32 packed) internal pure returns (uint256) {
        return uint128(uint256(packed));
    }

    function unpackMaxPriorityFeePerGas(PackedUserOperation calldata userOp)
    internal pure returns (uint256) {
        return unpackHigh128(userOp.gasFees);
    }

    function unpackMaxFeePerGas(PackedUserOperation calldata userOp)
    internal pure returns (uint256) {
        return unpackLow128(userOp.gasFees);
    }

    function unpackVerificationGasLimit(PackedUserOperation calldata userOp)
    internal pure returns (uint256) {
        return unpackHigh128(userOp.accountGasLimits);
    }

    function unpackCallGasLimit(PackedUserOperation calldata userOp)
    internal pure returns (uint256) {
        return unpackLow128(userOp.accountGasLimits);
    }

    function unpackPaymasterVerificationGasLimit(PackedUserOperation calldata userOp)
    internal pure returns (uint256) {
        return uint128(bytes16(userOp.paymasterAndData[PAYMASTER_VALIDATION_GAS_OFFSET : PAYMASTER_POSTOP_GAS_OFFSET]));
    }

    function unpackPostOpGasLimit(PackedUserOperation calldata userOp)
    internal pure returns (uint256) {
        return uint128(bytes16(userOp.paymasterAndData[PAYMASTER_POSTOP_GAS_OFFSET : PAYMASTER_DATA_OFFSET]));
    }

    function unpackPaymasterStaticFields(
        bytes calldata paymasterAndData
    ) internal pure returns (address paymaster, uint256 validationGasLimit, uint256 postOpGasLimit) {
        return (
            address(bytes20(paymasterAndData[: PAYMASTER_VALIDATION_GAS_OFFSET])),
            uint128(bytes16(paymasterAndData[PAYMASTER_VALIDATION_GAS_OFFSET : PAYMASTER_POSTOP_GAS_OFFSET])),
            uint128(bytes16(paymasterAndData[PAYMASTER_POSTOP_GAS_OFFSET : PAYMASTER_DATA_OFFSET]))
        );
    }

    /**
     * Hash the user operation data.
     * @param userOp - The user operation data.
     */
    function hash(
        PackedUserOperation calldata userOp
    ) internal pure returns (bytes32) {
        return keccak256(encode(userOp));
    }
}

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

// i,port ownable
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "./interfaces/IVaultEventEmitter.sol";
import "./interfaces/IBankrollController.sol";
import "./interfaces/IBankrollFactory.sol";

/**
 * @title BankrollController
 * @author balding-ghost
 * @notice This contract is the controller for the a bankroll deployment. It is the main contract
 * that is configurd by the admin of a deployment.
 */
contract BankrollController is IBankrollController, OwnableUpgradeable {
    uint256 public bankrollIndex;

    IVaultEventEmitter public eventEmitter;

    IBankrollFactory public factory;

    address public bankrollVault;

    address public liquidityManagerForRakeCollection;

    // note that pausing will not disable withdrawls from LP (as it could be a way to rug or hold
    // hostage the LPs funds by the admim). Pausing only stops deposits and payouts by the bankroll
    bool public isAddingLPOpen; // enabling of lp needs to be stored and configured in the bankroll

    // mapping that stores the cashier contracsts (those allowed to payin/payout)
    mapping(address => bool) public isAdapterContract;

    // mapping that stores the registered entities
    mapping(address => bool) public isRegisteredEntity;

    // address of the manager of the bankroll
    mapping(address => bool) public managerOfBankrollRegistered;

    constructor() {
        _disableInitializers();
    }

    function __initializeBankrollController(
        IConfigStruct.AddressConfiguration memory _initConfig,
        address _vaultAdapter,
        bool _isAddingLPOpen
    )
        external
        initializer
    {
        isAdapterContract[_vaultAdapter] = true;
        bankrollIndex = _initConfig.bankrollIndex;
        managerOfBankrollRegistered[_initConfig.bankrollManagerAddress] = true;
        bankrollVault = _initConfig.bankrollVaultAddress;
        liquidityManagerForRakeCollection = _initConfig.bankrollManagerAddress;
        eventEmitter = IVaultEventEmitter(_initConfig.eventEmitterAddress);
        factory = IBankrollFactory(_msgSender());
        isAddingLPOpen = _isAddingLPOpen;
        __Ownable_init(_initConfig.adminInitial);
    }

    // Configuration functions

    function transferOwnership(address _newAdmin) public override onlyOwner {
        OwnableUpgradeable.transferOwnership(_newAdmin);
        eventEmitter.emitAdminOfBankrollChanged(_newAdmin);
    }

    function renounceOwnership() public view override onlyOwner {
        revert("BankrollController: Ownership renouncement is not allowed");
    }

    function setLiquidityManagerForRakeCollection(address _newLiquidityManagerForRakeCollection)
        external
        override
        onlyOwner
    {
        require(
            _newLiquidityManagerForRakeCollection != address(0),
            "BankrollController: New liquidity manager for rake collection is zero"
        );
        // check if this address is already a manager of a bankroll
        require(
            managerOfBankrollRegistered[_newLiquidityManagerForRakeCollection],
            "BankrollController: New liquidity manager for rake collection is not a manager of a bankroll"
        );
        liquidityManagerForRakeCollection = _newLiquidityManagerForRakeCollection;
        emit LiquidityManagerForRakeCollectionChanged(_newLiquidityManagerForRakeCollection);
    }

    function setManagerOfBankroll(
        address _managerOfBankroll,
        bool _isRegistered
    )
        external
        override
    {
        // an invalid bankroller controller could rug the vault
        require(
            factory.isCallerProtocol(_msgSender()),
            "BankrollController: Only protocol can call this function"
        );
        managerOfBankrollRegistered[_managerOfBankroll] = _isRegistered;
        // if _isRegistered is false, then we need to check if this is the liquidity collector for
        // the rake, if so we revert because a new manager needs to be added first
        if (!_isRegistered && _managerOfBankroll == liquidityManagerForRakeCollection) {
            revert("BankrollController: New manager is the liquidity manager for the rake");
        }
        eventEmitter.emitLiquidityManagerChanged(_managerOfBankroll, _isRegistered);
        emit ManagerOfBankrollChanged(_managerOfBankroll);
    }

    function registerEnity(address _address, bool _isRegistered) external override onlyOwner {
        isRegisteredEntity[_address] = _isRegistered;
        emit EntityRegistered(_address, _isRegistered);
    }

    function registerVaultAdapter(address _address, bool _isRegistered) external override {
        require(
            factory.isCallerProtocol(_msgSender()),
            "BankrollController: Only protocol can call this function"
        );
        isAdapterContract[_address] = _isRegistered;
        eventEmitter.emitVaultAdapterRegistered(_address, _isRegistered);
        emit VaultAdapterRegistered(_address, _isRegistered);
    }

    function setAddingLiquidityOpen(bool _setting) external override onlyOwner {
        // check if the setting is not already set
        require(isAddingLPOpen != _setting, "BankrollController: Setting is already set");
        isAddingLPOpen = _setting;
        eventEmitter.emitAddingLPOpenChanged(_setting);
        emit AddingLPOpenChanged(_setting);
    }

    function setEventEmitter(address _eventEmitter) external {
        require(
            factory.isCallerProtocol(_msgSender()),
            "BankrollController: Only protocol can call this function"
        );
        eventEmitter = IVaultEventEmitter(_eventEmitter);
    }

    // View functions

    function isWINRProtocolAdminstrator(address _address) external view override returns (bool) {
        return factory.isCallerProtocolGovernance(_address);
    }

    function isWINRProtocolContract(address _address) external view override returns (bool) {
        return factory.isCallerProtocol(_address);
    }

    function isBankrollAdmin(address _address) external view override returns (bool) {
        return _address == owner();
    }

    function isBankroll(address _address) external view override returns (bool) {
        return _address == bankrollVault;
    }

    function isBankrollManager(address _address) external view override returns (bool) {
        return managerOfBankrollRegistered[_address];
    }

    function isRegisteredAdapter(address _address) external view override returns (bool) {
        return isAdapterContract[_address];
    }

    function returnBankrollAdmin() external view override returns (address) {
        return owner();
    }

    function checkIfRemovingLPIsHaltedByProtocol()
        external
        view
        override
        returns (bool isAllowed_)
    {
        isAllowed_ = !factory.isBankrollDeploymentHaltedByProtocol();
    }

    function returnIfAddingLPIsOpen() external view override returns (bool isAddingLpOpen_) {
        bool isProtocolHalted_ = factory.isBankrollDeploymentHaltedByProtocol();
        isAddingLpOpen_ = isAddingLPOpen && !isProtocolHalted_;
    }

    function isCallerRegisteredEntity(address _address) external view override returns (bool) {
        return isRegisteredEntity[_address];
    }

    function returnRakeCollectorAddress()
        external
        view
        override
        returns (address rakeCollectorAddress_)
    {
        rakeCollectorAddress_ = factory.returnRakeCollectorAddress();
    }
}

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

import "@openzeppelin/contracts/proxy/Clones.sol";
import "@openzeppelin/contracts/access/AccessControl.sol";
import "@openzeppelin/contracts/utils/Pausable.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "./interfaces/IBankrollVault.sol";
import "./interfaces/IMintableBankrollShareToken.sol";
import "./interfaces/IBankrollFactory.sol";
import "./interfaces/IVaultEventEmitter.sol";
import "./interfaces/IBankrollController.sol";
import "./interfaces/IBankrollLiquidityManager.sol";
import "./interfaces/IRakeCollectorContract.sol";
import "./interfaces/IVaultAdapter.sol";
import "./interfaces/IConfigStruct.sol";
import "./interfaces/IWhitelistPaymaster.sol";
import "./winr-lock/interfaces/IWINRLock.sol";

/**
 * @title BankrollFactory
 * @author balding-ghost
 * @notice This contract is responsible for deploying the vaults and managing the configuration
 * of the vaults.
 */
contract BankrollFactory is IBankrollFactory, AccessControl, Pausable, ReentrancyGuard {
  /*==================== Constants *====================*/
  uint32 public constant BASIS_POINTS_DIVISOR = 1e4;
  bytes32 public constant GOVERANCE_ROLE = keccak256("GOVERANCE_ROLE");
  bytes32 public constant EMERGENCY_ROLE = keccak256("EMERGENCY_ROLE");
  bytes32 public constant PROTOCOL_ROLE = keccak256("PROTOCOL_ROLE");

  IVaultEventEmitter public eventEmitter;

  IWINRLock public winrLock;

  // Configurations for new vaults
  IRakeCollectorContract public rakeCollectionContract;

  address public vaultAdapterAddress;

  // Implementation contracts for proxy contracts
  address public vaultV2Implementation;

  address public liquidityManagerImplementation;

  address public shareTokenImplementation;

  address public controllerImplementation;

  uint256 public epochDurationStandard = 7 days;

  uint256 public rakeRatioForProtocolFallback = 5 * 1e3; // 50%

  uint256 public defaultCooldownDuration = 10;

  uint256 public timestampOfEpochStart;

  // deploymentIndex => VaultDeployment
  mapping(uint256 => VaultDeployment) public vaults;

  mapping(address => uint256) public vaultToIndexBankroll;

  mapping(address => uint256) public shareTokenToVaultIndex;

  // controllerAddress => bankrollIndexCounter
  mapping(address => uint256) public controllerToIndexBankroll;

  // liquidityManager => bankrollIndex
  mapping(address => uint256) public liquidityManagerToIndexBankroll;

  // bankrollIndex => bool (indicating if the deployment is halted or not)
  mapping(uint256 => bool) public protocolHaltOfDeployment;

  uint256 public bankrollIndexCounter;

  address private deployerAddress_;

  address public paymasterAddress;

  constructor(
    address _governance,
    address _eventsEmitter,
    address _rakeCollectionContract,
    uint256 _startOftheEpoch
  ) {
    _grantRole(GOVERANCE_ROLE, _governance);
    _grantRole(EMERGENCY_ROLE, _governance);
    _grantRole(PROTOCOL_ROLE, _governance);
    
    deployerAddress_ = _governance;

    _setRoleAdmin(GOVERANCE_ROLE, GOVERANCE_ROLE);
    _setRoleAdmin(PROTOCOL_ROLE, GOVERANCE_ROLE);
    _setRoleAdmin(EMERGENCY_ROLE, GOVERANCE_ROLE);

    eventEmitter = IVaultEventEmitter(_eventsEmitter);

    rakeCollectionContract = IRakeCollectorContract(_rakeCollectionContract);

    timestampOfEpochStart = _startOftheEpoch;
  }

  // Modifiers

  modifier onlyGovernance() {
    require(
      hasRole(GOVERANCE_ROLE, _msgSender()),
      "BankrollFactory: Only governance can call this function"
    );
    _;
  }

  // Operational functions

  function createVault(
    CreateVaultConfig memory _config
  )
    external
    override
    nonReentrant
    whenNotPaused
    returns (uint256 vaultIndex_, VaultDeployment memory vaultDeployment_)
  {
    // check if the minimalLpTokenAmount is not 100
    require(
      _config.minimalLpTokenAmount > 100,
      "BankrollFactory: Minimal LP token amount cannot be smaller than 100"
    );

    // Clone all the implementation contracts
    address controller_ = Clones.clone(controllerImplementation);
    address vaultManager_ = Clones.clone(liquidityManagerImplementation);
    address shareToken_ = Clones.clone(shareTokenImplementation);
    address vault_ = Clones.clone(vaultV2Implementation);

    IWhitelistPaymaster(paymasterAddress).setWhitelistContract(vaultManager_, true);

    IWhitelistPaymaster(paymasterAddress).setWhitelistContract(shareToken_, true);

    winrLock.registerLpToken(shareToken_, _config.bankrollToken, vaultManager_);

    bankrollIndexCounter++;

    vaults[bankrollIndexCounter] = VaultDeployment({
      label: _config.label,
      adminAddressInitial: _config.vaultAdmin,
      vault: vault_,
      vaultManagerInitial: vaultManager_,
      controller: controller_,
      shareToken: shareToken_,
      bankrollToken: _config.bankrollToken
    });

    IConfigStruct.AddressConfiguration memory _initConfig = IConfigStruct.AddressConfiguration({
      bankrollIndex: bankrollIndexCounter,
      bankrollTokenAddress: _config.bankrollToken,
      bankrollManagerAddress: vaultManager_,
      eventEmitterAddress: address(eventEmitter),
      controllerAddress: controller_,
      liquidityShareTokenAddress: shareToken_,
      bankrollVaultAddress: vault_,
      adminInitial: _config.vaultAdmin
    });

    controllerToIndexBankroll[_initConfig.controllerAddress] = bankrollIndexCounter;
    vaultToIndexBankroll[_initConfig.bankrollVaultAddress] = bankrollIndexCounter;
    shareTokenToVaultIndex[_initConfig.liquidityShareTokenAddress] = bankrollIndexCounter;
    liquidityManagerToIndexBankroll[_initConfig.bankrollManagerAddress] = bankrollIndexCounter;

    IMintableBankrollShareToken(shareToken_).__initializeShareToken(
      _initConfig,
      _config.shareTokenName,
      _config.shareTokenSymbol
    );

    IBankrollLiquidityManager(_initConfig.bankrollManagerAddress).__initializeWLPManager(
      _initConfig,
      _config.removeLiquidityFeeBasisPoints,
      _config.addLiquidityFeeBasisPoints,
      defaultCooldownDuration,
      _config.minimalLpTokenAmount,
      _config.isPrivateVault
    );

    IBankrollController(_initConfig.controllerAddress).__initializeBankrollController(
      _initConfig,
      vaultAdapterAddress,
      _config.isAddingLpOpen
    );

    IBankrollVault(_initConfig.bankrollVaultAddress).__initializeVault(
      _initConfig,
      epochDurationStandard,
      returnRatioForProtocolNextEpoch(bankrollIndexCounter),
      calculateStartOfCurrentEpoch()
    );

    eventEmitter.emitVaultDeployed(_initConfig);

    rakeCollectionContract.registerVaultInRakeCollector(
      bankrollIndexCounter,
      _initConfig.liquidityShareTokenAddress
    );

    emit VaultDeployed(
      bankrollIndexCounter,
      _initConfig.bankrollVaultAddress,
      _initConfig.controllerAddress,
      _initConfig.liquidityShareTokenAddress
    );

    IVaultAdapter(vaultAdapterAddress).registerBankrollDeployment(
      bankrollIndexCounter,
      _initConfig.bankrollVaultAddress,
      _initConfig.bankrollTokenAddress,
      _initConfig.liquidityShareTokenAddress,
      _initConfig.controllerAddress,
      _initConfig.bankrollManagerAddress
    );

    return (bankrollIndexCounter, vaults[bankrollIndexCounter]);
  }

  // function called by the vault to distribute the rake rewards that have been sent to the
  // rakecollector at the end of the epoch
  function distributeEpochRakeRewards() external override {
    uint256 vaultIndex_ = vaultToIndexBankroll[_msgSender()];
    require(vaultIndex_ != 0, "BankrollFactory: Not a valid controller address");
    rakeCollectionContract.distributeRewards(vaultIndex_);
    emit RakeRewardsDistributed(vaultIndex_);
  }

  // Configuraiton contracts

  function setVaultV2Implementation(
    address _vaultV2Implementation
  ) external override onlyGovernance {
    vaultV2Implementation = _vaultV2Implementation;
    emit VaultV2ImplementationSet(_vaultV2Implementation);
  }

  function setLiquidityManagerImplementation(
    address _wlpV2Implementation
  ) external override onlyGovernance {
    liquidityManagerImplementation = _wlpV2Implementation;
    emit LiquidityManagerImplementationSet(_wlpV2Implementation);
  }

  function setShareTokenImplementation(
    address _shareTokenImplementation
  ) external override onlyGovernance {
    shareTokenImplementation = _shareTokenImplementation;
    emit ShareTokenImplementationSet(_shareTokenImplementation);
  }

  function setWinrLock(address _winrLock) external onlyGovernance {
    winrLock = IWINRLock(_winrLock);
    emit WinrLockSet(_winrLock);
  }

  function setControllerImplementation(
    address _controllerImplementation
  ) external override onlyGovernance {
    controllerImplementation = _controllerImplementation;
    emit ControllerImplementationSet(_controllerImplementation);
  }

  function setRakeCollectionContract(
    address _rakeCollectionContract
  ) external override onlyGovernance {
    rakeCollectionContract = IRakeCollectorContract(_rakeCollectionContract);
    emit RakeCollectionContractSet(_rakeCollectionContract);
  }

  function setRakeRatioForProtocolInitial(
    uint256 _rakeRatioForProtocolInitial
  ) external override onlyGovernance {
    require(
      _rakeRatioForProtocolInitial <= BASIS_POINTS_DIVISOR,
      "BankrollFactory: Rake cannot be higher than 100"
    );
    rakeRatioForProtocolFallback = _rakeRatioForProtocolInitial;
    emit RakeRatioForProtocolInitialSet(_rakeRatioForProtocolInitial);
  }

  function setEpochDuration(uint256 _epochDuration) external override onlyGovernance {
    require(_epochDuration > 3600, "BankrollFactory: Epoch duration cannot be less than 1 hour");
    epochDurationStandard = _epochDuration;
    emit EpochDurationSet(_epochDuration);
  }

  function setVaultEventEmitter(address _vaultEventEmitter) external override onlyGovernance {
    eventEmitter = IVaultEventEmitter(_vaultEventEmitter);
    emit VaultEventEmitterSet(_vaultEventEmitter);
  }

  function setProtocolHaltOfDeployment(uint256 _indexBankroll, bool _halt) external onlyGovernance {
    protocolHaltOfDeployment[_indexBankroll] = _halt;
    eventEmitter.emitProtocolHaltOfDeploymentSet(_indexBankroll, _halt);
    emit ProtocolHaltOfDeploymentSet(_indexBankroll, _halt);
  }

  /*==================== Protocol governance functions *====================*/

  function pauseProtocol() external onlyRole(EMERGENCY_ROLE) {
    _pause();
  }

  function unpauseProtocol() external onlyRole(EMERGENCY_ROLE) {
    _unpause();
  }

  function setVaultAdapter(address _vaultAdapterAddress) external override onlyGovernance {
    vaultAdapterAddress = _vaultAdapterAddress;
    emit VaultAdapterSet(_vaultAdapterAddress);
  }

  function setDefaultCooldownDuration(
    uint256 _defaultCooldownDuration
  ) external override onlyGovernance {
    defaultCooldownDuration = _defaultCooldownDuration;
    emit DefaultCooldownDurationSet(_defaultCooldownDuration);
  }

  function withdrawERC20Tokens(
    address _tokenAddress,
    address _to,
    uint256 _amount
  ) external onlyRole(EMERGENCY_ROLE) {
    require(_to != address(0), "BankrollFactory: Invalid address");
    require(_tokenAddress != address(0), "BankrollFactory: Invalid token address");
    require(IERC20(_tokenAddress).transfer(_to, _amount), "BankrollFactory: Transfer failed");
  }

  /*==================== View functions *====================*/

  function isBankrollDeploymentHaltedByProtocol() external view override returns (bool) {
    // check if the complete deployment is halted
    if (paused()) {
      return true;
    }
    uint256 index_ = controllerToIndexBankroll[_msgSender()];
    require(index_ != 0, "BankrollFactory: Not a valid controller address");
    return protocolHaltOfDeployment[index_];
  }

  function isCallerProtocol(address _account) external view override returns (bool isProtocol_) {
    isProtocol_ = hasRole(PROTOCOL_ROLE, _account);
  }

  function isCallerProtocolGovernance(
    address _account
  ) external view override returns (bool isProtocolGovernance_) {
    isProtocolGovernance_ = hasRole(GOVERANCE_ROLE, _account);
  }

  function isProtocolPaused() external view override returns (bool isPaused_) {
    isPaused_ = paused();
  }

  function returnRakeCollectorAddress()
    external
    view
    override
    returns (address rakeCollectorAddress_)
  {
    rakeCollectorAddress_ = address(rakeCollectionContract);
    require(rakeCollectorAddress_ != address(0), "BankrollFactory: Rake collector not set");
  }

  function returnVaultDeploymentInfo(
    uint256 _indexBankroll
  ) external view override returns (VaultDeployment memory) {
    return vaults[_indexBankroll];
  }

  function returnRatioForProtocolNextEpoch(
    uint256 _indexBankroll
  ) public view override returns (uint256 rakeRatio_) {
    rakeRatio_ = rakeCollectionContract.returnRatioForProtocolNextEpoch(_indexBankroll);
    if (rakeRatio_ == 0) {
      rakeRatio_ = rakeRatioForProtocolFallback;
    }
    return rakeRatio_;
  }

  function returnEpochInformation(
    uint256 _indexBankroll
  ) external view override returns (uint32 epochCounter_, uint256 epochEndTimeStamp_) {
    address vaultAddress_ = vaults[_indexBankroll].vault;
    IBankrollVault vault_ = IBankrollVault(vaultAddress_);
    epochCounter_ = uint32(vault_.epochCounter());
    epochEndTimeStamp_ = vault_.currentEpochEnd();
    return (epochCounter_, epochEndTimeStamp_);
  }

  function returnRakeLiquidityManagerBankrollToken(
    address _shareToken
  ) external view returns (address rakeLiquidityManager, address bankrollToken) {
    address controllerAddress = vaults[shareTokenToVaultIndex[_shareToken]].controller;
    require(controllerAddress != address(0), "BankrollFactory: Controller address is zero");
    rakeLiquidityManager = IBankrollController(controllerAddress)
      .liquidityManagerForRakeCollection();
    require(rakeLiquidityManager != address(0), "BankrollFactory: Rake liquidity manager is zero");
    bankrollToken = vaults[shareTokenToVaultIndex[_shareToken]].bankrollToken;
    return (rakeLiquidityManager, bankrollToken);
  }

  function setTimeOfEndOfEpoch(uint256 _startOfTheNewEpoch) external onlyGovernance {
    require(_startOfTheNewEpoch != 0, "BankrollFactory: Invalid _startOfTheNewEpoch value");
    require(
      _startOfTheNewEpoch <= block.timestamp,
      "BankrollFactory: _startOfTheNewEpoch is in the past"
    );
    timestampOfEpochStart = _startOfTheNewEpoch;
    emit EndOfEpochTimeSet(_startOfTheNewEpoch);
  }

  function returnAllVaultAddressesDeployed()
    external
    view
    returns (address[] memory vaultAddresses_)
  {
    vaultAddresses_ = new address[](bankrollIndexCounter);
    for (uint256 i = 1; i <= bankrollIndexCounter; i++) {
      vaultAddresses_[i = 1] = vaults[i].vault;
    }
    return vaultAddresses_;
  }

  function returnShareTokenAddressesDeployed()
    external
    view
    returns (address[] memory shareAddreses_)
  {
    shareAddreses_ = new address[](bankrollIndexCounter);
    for (uint256 i = 1; i <= bankrollIndexCounter; i++) {
      shareAddreses_[i = 1] = vaults[i].shareToken;
    }
    return shareAddreses_;
  }

  function returnFulLDeploymentInfo()
    external
    view
    returns (VaultDeployment[] memory deployments_)
  {
    deployments_ = new VaultDeployment[](bankrollIndexCounter);
    for (uint256 i = 1; i <= bankrollIndexCounter; i++) {
      deployments_[i = 1] = vaults[i];
    }
    return deployments_;
  }

  function calculateStartOfCurrentEpoch() public view returns (uint256 startOfEpoch_) {
    uint256 diff_;

    if (timestampOfEpochStart >= block.timestamp) {
      return timestampOfEpochStart;
    } else {
      diff_ = block.timestamp - timestampOfEpochStart;
    }

    // calculate the full weeks the factory has been running
    uint256 amountWeekDiff_ = (diff_ / epochDurationStandard);
    // we round down as we want every new vault to end its epoch at the same time
    startOfEpoch_ = (amountWeekDiff_ * epochDurationStandard) + timestampOfEpochStart;
    return startOfEpoch_;
  }

  function revokeDeployerGovernanceRole() external {
    require(msg.sender == deployerAddress_, "BankrollFactory: Not the deployer address");
    _revokeRole(GOVERANCE_ROLE, deployerAddress_);
  }

  function setPaymasterAddress(address _paymasterAddress) external onlyGovernance {
    paymasterAddress = _paymasterAddress;
    emit PaymasterAddressSet(_paymasterAddress);
  }
}

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

import "./AccessControlBase.sol";
import "./interfaces/IBankrollLiquidityManager.sol";

/**
 * @title BankrollLiquidityManager
 * @author balding-ghost
 * @dev Contract that manages the liquidity of the bankroll. A single vault can have multiple
 * BankrollLiquidityManagers with different configurations.
 */
contract BankrollLiquidityManager is AccessControlBase, IBankrollLiquidityManager {
    /*==================== Constants *====================*/
    uint256 internal constant LP_TOKEN_PRECISION = 1e18;
    // to prevent that the admin can set the cooldown to a too high value
    uint32 internal constant MAX_COOLDOWN_MULTIPLIER = 3;
    // maximum fee that can be set for burning WLP tokens (when removing liquidity)
    uint256 public constant MAX_LP_REMOVE_FEE = 1e3; // 10%
    // maximum fee that can be set for minting WLP tokens (when adding liquidity)
    uint256 public constant MAX_LP_ADD_FEE = 1e3; // 10%
    /*==================== State Variabes Operations *====================*/
    // bool indicating if only whitelisted addresses are allowed to add liquidity  (removing
    bool public inOnlyWhitelistedWLPMode;
    // if inOnlyWhitelistedWLPMode is enabled this mapping enforces who can add lp
    mapping(address => bool) public whitelistedWLPAddresses;
    // max amount of tokens that can be added to the vault
    uint256 public maxVaultAssetAmount;
    // percentage that people that withdraw from the vault need to pay
    uint256 public override removeLiquidityFeeBasisPoints;
    // percentage that people that deposit to the vault need to pay
    uint256 public override addLiquidityFeeBasisPoints;
    // amount of seconds after new LPs need to wait before they can transact with their token
    uint256 public cooldownDuration;
    // max amount of seconds the cooldownDuration can be configured to
    uint256 public maxCoolDownDuration;
    // minimal amount of WLP tokens that must be minted
    uint256 public minimalLpTokenAmount;

    constructor() {
        _disableInitializers();
    }

    function __initializeWLPManager(
        IConfigStruct.AddressConfiguration memory _initConfig,
        uint256 _removeLiquidityFeeBasisPoints,
        uint256 _addLiquidityFeeBasisPoints,
        uint256 _cooldownDuration,
        uint256 _minimalLpTokenAmount,
        bool _isPrivateMode
    )
        external
        initializer
    {
        AccessControlBase.__AccessControlBase_init(_initConfig);
        vaultV2 = IBankrollVault(_initConfig.bankrollVaultAddress);
        liquidityShareToken = IMintableBankrollShareToken(_initConfig.liquidityShareTokenAddress);
        removeLiquidityFeeBasisPoints = _removeLiquidityFeeBasisPoints;
        addLiquidityFeeBasisPoints = _addLiquidityFeeBasisPoints;
        cooldownDuration = _cooldownDuration;
        maxCoolDownDuration = _cooldownDuration * MAX_COOLDOWN_MULTIPLIER;
        minimalLpTokenAmount = _minimalLpTokenAmount;
        inOnlyWhitelistedWLPMode = _isPrivateMode;
    }

    /*==================== Operational functions WINR/JB *====================*/

    /**
     * @dev Adds liquidity to the vaultV2
     * @param _token address of the token that will be deposited
     * @param _amount amount of tokens that will be deposited
     * @param _minLpTokens minimum amount of WLP tokens that must be minted
     * @return lpTokenAmount_ amount of WLP tokens minted
     */
    function addLiquidity(
        address _token,
        uint256 _amount,
        uint256 _minLpTokens
    )
        external
        override
        nonReentrant
        returns (uint256 lpTokenAmount_)
    {
        // check if the token is the bankroll token
        _isBankrollToken(_token);
        _checkAddingLiquidityEnabled();
        if (inOnlyWhitelistedWLPMode) {
            _checkWhitelistedWLPAddresses(_msgSender());
        }
        lpTokenAmount_ = _addLiquidity(_msgSender(), _amount, _minLpTokens);
        uint256 amountOfAssetsInVault_ = vaultV2.returnAssetsOfBankroll();
        _checkMaxVaultAssetAmount(amountOfAssetsInVault_);
    }

    bool internal isEntered__;

    modifier customReentrancyGuard(address _checkAddress) {
        if (_checkAddress == _returnRakeCollectorAddress()) {
            return;
        }
        if (isEntered__) {
            revert("ReantrancyGuardCustom");
        }
        isEntered__ = true;
        _;
        isEntered__ = false;
    }

    /**
     * @dev Removes liquidity from the vaultV2
     *  @dev it will always be possible to remove liquidity, even if the caller is not whitelisted
     * @param _tokenOut address of the token that will be received
     * @param _lpTokenAmount amount of lp tokens that will be removed/redemed
     * @param _minOut minimum amount of tokens that must be received
     * @return tokenOutAmount_ amount of bankrolltokens received
     */
    function removeLiquidity(
        address _tokenOut,
        uint256 _lpTokenAmount,
        uint256 _minOut
    )
        external
        override
        customReentrancyGuard(_msgSender())
        returns (uint256 tokenOutAmount_)
    {
        _isBankrollToken(_tokenOut);
        require(
            controller.checkIfRemovingLPIsHaltedByProtocol(),
            "BankrollLiquidityManager: removing LPs is not allowed"
        );
        tokenOutAmount_ = _removeLiquidity(_msgSender(), _tokenOut, _lpTokenAmount, _minOut);
        return tokenOutAmount_;
    }

    /*==================== Internal functions WINR/JB *====================*/

    /**
     * @dev Adds liquidity to the vaultV2
     * @param _fundingAccount address of the account that will fund the vaultV2
     * @param _amountDeposit amount of tokens that will be deposited
     * @param _minLpTokens minimum amount of WLP tokens that must be minted
     * @return mintAmountWLP_ amount of WLP tokens minted
     */
    function _addLiquidity(
        address _fundingAccount,
        uint256 _amountDeposit,
        uint256 _minLpTokens
    )
        internal
        returns (uint256 mintAmountWLP_)
    {
        if (vaultV2.returnIsEpochEnded()) {
            vaultV2.processEndOfEpochByLiquidityManager();
        }

        _isNotZero(_amountDeposit);
        // get the total supply of WLP tokens
        uint256 lpTokenSupply_ = liquidityShareToken.totalSupply();
        // fetch how much WLP tokens will be minted, the vault contract will calculate the adequate
        // amount of wlp
        (uint256 amountLPToMint_, uint256 addLiquidityFee_) = vaultV2
            .returnAddLiquidityBankrollAmount(
            lpTokenSupply_, _amountDeposit, addLiquidityFeeBasisPoints
        );
        bool firstMint_;
        if (lpTokenSupply_ == 0) {
            firstMint_ = true;
            // first mint must issue more than 10 WLP to ensure WLP pricing precision
            require(
                (amountLPToMint_ >= minimalLpTokenAmount),
                "BankrollLiquidityManager: too low WLP amount for first mint"
            );
        }

        // transfer the tokens to the vaultV2, requires an approval by the _fundingAccount
        SafeERC20.safeTransferFrom(bankrollToken, _fundingAccount, address(vaultV2), _amountDeposit);

        vaultV2.deposit(addLiquidityFeeBasisPoints);

        if (firstMint_) {
            require(
                amountLPToMint_ > minimalLpTokenAmount,
                "BankrollLiquidityManager: first LP holder must receive more than minimalLpTokenAmount"
            );

            amountLPToMint_ -= minimalLpTokenAmount;

            // mint 1 WLP to the factory to prevent any attack possible
            liquidityShareToken.mintLiquidityToken(address(factory), minimalLpTokenAmount);

            // the bankroll admin needs to be the first LP holder
            // this to ensure that the minimalLpTokenAmount is a fair amount to burn
            address admin_ = controller.returnBankrollAdmin();

            require(
                _msgSender() == admin_,
                "BankrollLiquidityManager: only bankroll admin can mint first LP"
            );
            require(
                amountLPToMint_ >= minimalLpTokenAmount * 1000,
                "BankrollLiquidityManager: first LP holder must receive more than minimalLpTokenAmount"
            );
        }

        require(
            amountLPToMint_ >= _minLpTokens, "BankrollLiquidityManager: insufficient WLP output"
        );

        liquidityShareToken.mintLiquidityToken(_fundingAccount, amountLPToMint_);

        liquidityShareToken.setTimeOfCooldown(_fundingAccount, block.timestamp + cooldownDuration);

        eventEmitter.emitAddLiquidityToVault(
            address(bankrollToken),
            _amountDeposit,
            addLiquidityFee_,
            _fundingAccount,
            amountLPToMint_
        );

        emit AddLiquidity(
            _fundingAccount,
            address(bankrollToken),
            _amountDeposit,
            addLiquidityFee_,
            amountLPToMint_
        );

        return amountLPToMint_;
    }

    function _removeLiquidity(
        address _account,
        address _tokenOut,
        uint256 _lpTokenAmount,
        uint256 _minOut
    )
        internal
        returns (uint256 amountOutToken_)
    {
        if (vaultV2.returnIsEpochEnded()) {
            vaultV2.processEndOfEpochByLiquidityManager();
        }

        _isNotZero(_lpTokenAmount);

        require(
            liquidityShareToken.isLPTokenAllowedToBeTransferred(_account),
            "BankrollLiquidityManager: LP token not allowed to be transferred"
        );
        // fetch how much WLP tokens are minted/outstanding
        uint256 lpTokenSupply_ = liquidityShareToken.totalSupply();
        uint256 removeLiquidityFee_;
        // fetch how much tokens will be received
        (amountOutToken_, removeLiquidityFee_) = vaultV2.returnRemoveBankrollAmount(
            lpTokenSupply_, _lpTokenAmount, removeLiquidityFeeBasisPoints
        );

        vaultV2.withdraw(
            _account, amountOutToken_ + removeLiquidityFee_, removeLiquidityFeeBasisPoints
        );

        liquidityShareToken.burnLiquidityToken(_account, _lpTokenAmount);

        // check if the amount of tokenOut the vaultV2 has returend fits the requirements of the
        // caller
        require(amountOutToken_ >= _minOut, "BankrollLiquidityManager: insufficient output");
        eventEmitter.emitRemoveLiquidityFromVault(
            address(bankrollToken), _lpTokenAmount, amountOutToken_, removeLiquidityFee_, _account
        );
        emit RemoveLiquidity(
            _account, _tokenOut, _lpTokenAmount, amountOutToken_, removeLiquidityFee_
        );
        return amountOutToken_;
    }

    function _returnAssetToLPRatio() internal view returns (uint256 lpTokenRatio_) {
        uint256 registeredTokens_ = vaultV2.returnAssetsOfBankroll();
        uint256 lpTokenSupply_ = liquidityShareToken.totalSupply();
        lpTokenRatio_ = registeredTokens_ == 0
            ? LP_TOKEN_PRECISION
            : (registeredTokens_ * LP_TOKEN_PRECISION) / lpTokenSupply_;
    }

    function _returnLPToAssetRatio() internal view returns (uint256 lpTokenRatio_) {
        uint256 registeredTokens_ = vaultV2.returnAssetsOfBankroll();
        uint256 lpTokenSupply_ = liquidityShareToken.totalSupply();
        lpTokenRatio_ = registeredTokens_ == 0
            ? LP_TOKEN_PRECISION
            : (lpTokenSupply_ * LP_TOKEN_PRECISION) / registeredTokens_;
    }

    function _checkWhitelistedWLPAddresses(address _checkAddress) internal view {
        require(
            whitelistedWLPAddresses[_checkAddress],
            "BankrollLiquidityManager: caller not whitelisted as vwlp"
        );
    }

    function _checkMaxVaultAssetAmount(uint256 _amount) internal view {
        if (maxVaultAssetAmount == 0) {
            return;
        } else {
            require(
                _amount <= maxVaultAssetAmount,
                "BankrollLiquidityManager: amount exceeds maxVaultAssetAmount"
            );
        }
    }

    function _checkAddingLiquidityEnabled() internal view {
        require(
            controller.returnIfAddingLPIsOpen(),
            "BankrollLiquidityManager: Liquidity action not allowed yet"
        );
    }

    function _isNotZero(uint256 _amount) internal pure {
        require(_amount != 0, "BankrollLiquidityManager: amount is 0");
    }

    function _isBankrollToken(address _token) internal view {
        require(_token == address(bankrollToken), "BankrollLiquidityManager: not bankroll token");
    }

    // Configuration functions / Setters

    function setMaxAssetAmount(uint256 _maxWLPAmount) external override onlyVaultAdmin {
        maxVaultAssetAmount = _maxWLPAmount;
        eventEmitter.emitMaxAssetAmountSet(_maxWLPAmount);
        emit MaxWLPAmountSet(_maxWLPAmount);
    }

    function setWhitelistedWLPAddresses(
        address _lpAddress,
        bool _isWhitelisted
    )
        external
        override
        onlyVaultAdmin
    {
        whitelistedWLPAddresses[_lpAddress] = _isWhitelisted;
        eventEmitter.emitWhitelistedWLPAddressSet(_lpAddress, _isWhitelisted);
        emit WhitelistedWLPAddressSet(_lpAddress, _isWhitelisted);
    }

    /*==================== Configuration functions *====================*/

    function setInPrivateMode(bool _inPrivateMode) external override onlyVaultAdmin {
        inOnlyWhitelistedWLPMode = _inPrivateMode;
        eventEmitter.emitInPrivateModeSet(_inPrivateMode);
        emit InPrivateModeSet(_inPrivateMode);
    }

    function setAddLiquidityFeeBasisPoints(uint256 _addLiquidityFeeBasisPoints)
        external
        override
        onlyVaultAdmin
    {
        require(
            _addLiquidityFeeBasisPoints <= MAX_LP_REMOVE_FEE,
            "BankrollLiquidityManager: fee too high"
        );
        addLiquidityFeeBasisPoints = _addLiquidityFeeBasisPoints;
        eventEmitter.emitAddLiquidityFeeBasis(_addLiquidityFeeBasisPoints);
        emit AddLiquidityBasisPointsSet(_addLiquidityFeeBasisPoints);
    }

    function setRemoveLiquidityFeeBasisPoints(uint256 _removeLiquidityFeeBasisPoints)
        external
        override
        onlyVaultAdmin
    {
        // check if the burn fee is not too high
        require(
            _removeLiquidityFeeBasisPoints <= MAX_LP_REMOVE_FEE,
            "BankrollLiquidityManager: fee too high"
        );
        removeLiquidityFeeBasisPoints = _removeLiquidityFeeBasisPoints;
        eventEmitter.emitRemoveLiquidityFeeSet(_removeLiquidityFeeBasisPoints);
        emit RemoveLiquidityFeeSet(_removeLiquidityFeeBasisPoints);
    }

    function setCooldownDuration(uint256 _cooldownDuration) external override onlyVaultAdmin {
        require(
            _cooldownDuration <= maxCoolDownDuration,
            "BankrollLiquidityManager: cooldown duration too high"
        );
        cooldownDuration = _cooldownDuration;
        eventEmitter.emitCooldownDurationSet(_cooldownDuration);
        emit CooldownDurationSet(_cooldownDuration);
    }

    /*==================== View functions WINR/JB *====================*/

    function isVaultHalted() external view override returns (bool isHalted_) {
        isHalted_ = vaultV2.isHalted();
    }

    function getTUM() external view override returns (uint256) {
        return vaultV2.returnAssetsOfBankroll();
    }

    function getLiquidityTokenSupply() external view override returns (uint256) {
        return liquidityShareToken.totalSupply();
    }

    function getRatioLPToken() external view override returns (uint256 lpTokenRatio_) {
        lpTokenRatio_ = _returnAssetToLPRatio();
    }

    function getRatioAssetToken() external view override returns (uint256 assetTokenRatio_) {
        assetTokenRatio_ = _returnLPToAssetRatio();
    }

    function returnWhitelistedWLPAddresses(address _address)
        external
        view
        override
        returns (bool)
    {
        return whitelistedWLPAddresses[_address];
    }

    function isLPTokenAllowedToBeTransferred(address _address)
        external
        view
        override
        returns (bool)
    {
        return liquidityShareToken.returnTimestampOfTransferrability(_address) < block.timestamp;
    }
}

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

import "./AccessControlBase.sol";
import "./interfaces/IBankrollVault.sol";
import "./interfaces/IBankrollLiquidityManager.sol";

/**
 * @title BankrollVault
 * @author balding-ghost
 * @dev The BankrollVault contract is the main contract for the vault. The vault is the contract
 * that holds the bankroll tokens and is responsible for the payouts to the players. The vault will
 * also take a rake on the profit that the vault makes. The rake will be taken by the protocol and
 * will be used for the protocol's treasury.
 */
contract BankrollVault is IBankrollVault, AccessControlBase {
    using SafeERC20 for IERC20;
    /*==================== Constants *====================*/

    uint32 public constant BASIS_POINTS_DIVISOR = 1e4;
    /*==================== State Variables *====================*/
    // payouts are halted if the vault has defaulted
    bool public payoutsHalted;
    // epoch counter
    uint256 public epochCounter;
    // the amount of the bankroll token that is registered to the contract
    uint256 public override contractBalanceAccountedFor;
    // amount of tokens that the vault has paid out in the active epoch
    uint256 public totalPaidOutInActiveEpochRaked;
    // amount of tokens that the vault has paid out in the active epoch without rake
    uint256 public totalPaidOutInActiveEpochNoRake;
    // amount of tokens that the vault has paid in in the active epoch
    uint256 public totalPaidInActiveEpochRaked;
    // amount of tokens that the vault has paid in in the active epoch without rake
    uint256 public totalPaidInActiveEpochNoRake;
    // amount of tokens that the vault has received in mint and burn fees in the active epoch
    uint256 public epochMintAndBurnAmount;
    // timestamp when the current epoch ends
    uint256 public override currentEpochEnd;
    // amount of the profit that the protocol will take as a rake if an epoch ends
    uint256 public ratioProfitForProtocol; // scaled 1e4
    // indicator if the vault has defaulted
    bool public vaultDefaulted;
    // the amount of tokens that the vault is short
    uint256 public vaultShortfallDebt;
    // the address that is the debtor of the vault
    address public shortFallRecipient;
    // duration in seconds of an epoch
    uint256 public override epochDuration;
    // mapping storing all the epoch info
    mapping(uint256 => Epoch) public epochInfo;

    uint256 public totalPaidInAllTime;
    uint256 public totalPaidOutAllTime;
    uint256 public totalAllTimeMintAndBurnAmount;
    uint256 public totalWLPMintedAsRakeAllTime;
    uint256 public totalTokensForRakeAllTime;
    bool public vaultShutdownPermanently;

    constructor() {
        _disableInitializers();
    }

    function __initializeVault(
        IConfigStruct.AddressConfiguration memory _config,
        uint256 _epochDuration,
        uint256 _ratioProfitForProtocol,
        uint256 _epochStart
    )
        external
        initializer
    {
        __AccessControlBase_init(_config);
        epochDuration = _epochDuration;
        if (_ratioProfitForProtocol == 0) {
            revert("BankrollVault: Rake ratio is 0");
        }
        ratioProfitForProtocol = _ratioProfitForProtocol;
        currentEpochEnd = _epochStart + _epochDuration;
        epochCounter++;
        epochInfo[epochCounter].epochStart = uint32(_epochStart);
        epochInfo[epochCounter].epochEnd = uint32(currentEpochEnd);
        vaultV2 = IBankrollVault(address(this));
        liquidityShareToken = IMintableBankrollShareToken(_config.liquidityShareTokenAddress);
    }

    /*==================== Operational functions *====================*/

    /**
     * The vault can pay out tokens to a player. The vault can pay out tokens from the escrow
     * contract or from the vault itself. If the vault pays out tokens from the escrow contract, the
     * vault will need to withdraw the tokens from the escrow contract first.
     *
     * @param _wagerAsset the token that the player wagered
     * @param _escrowAmount the amount of tokens that the player has bet, these tokens are paid into
     * the vault as it the wager of the bet
     * @param _recipient the address of the player that will receive the tokens
     * @param _totalAmountPayout the total amount of tokens that the player will receive
     */
    function payoutInVault(
        address _wagerAsset,
        uint256 _escrowAmount,
        address _recipient,
        uint256 _totalAmountPayout
    )
        external
        override
        nonReentrant
        onlyVaultAdapter
    {
        if (_totalAmountPayout == 0) {
            // the player has not won anything
            _payin(_wagerAsset, _escrowAmount, false);
        } else {
            // the escrowed tokens will be withdrawn and paid in
            _payout(
                _wagerAsset,
                _escrowAmount,
                _recipient,
                _totalAmountPayout,
                true, // fromEscrow
                false // noRake
            );
        }
    }

    function payoutInVault(
        address _wagerAsset,
        uint256 _escrowAmount,
        address _recipient,
        uint256 _totalAmountPayout,
        bool _noRake
    )
        external
        override
        nonReentrant
        onlyVaultAdapter
    {
        if (_totalAmountPayout == 0) {
            // the player has not won anything
            _payin(_wagerAsset, _escrowAmount, _noRake);
        } else {
            // the player has won a certain amount, the vault will pay out the tokens to the player.
            // the escrowed tokens will be withdrawn and paid in
            _payout(
                _wagerAsset,
                _escrowAmount,
                _recipient,
                _totalAmountPayout,
                true, // fromEscrow
                _noRake
            );
        }
    }

    function payoutNoEscrowInVault(
        address _wagerAsset,
        address _recipient,
        uint256 _totalAmount
    )
        external
        override
        nonReentrant
        onlyVaultAdapter
    {
        _payout(_wagerAsset, 0, _recipient, _totalAmount, false, false);
    }

    /**
     * Internal function for payoutInVault. This function is used by the payoutInVault and
     * payoutNoEscrowInVault
     * functions. The payoutInVault function is used by the cashier contract to payoutInVault tokens
     * to a player.
     * The payoutNoEscrowInVault function is used by the vault admin to payoutInVault tokens to a
     * player.
     *
     *  @dev the idea of the _noRake is to support edge cases where no rake is paid, this will not
     * be the main path/usage of the contract
     *
     * @param _wagerAsset the token that the player wagered
     * @param _escrowAmount the amount of tokens that the player has bet, these tokens are paid into
     * the vault as it the wager of the bet
     * @param _recipient the address of the player that will receive the tokens
     * @param _totalPayoutAmount the total amount of tokens that the player will receive
     * @param _fromEscrow indicates if the tokens are being paid out from the escrow contract
     * @param _noRake indicates if the vault should take a rake on the profit
     */
    function _payout(
        address _wagerAsset,
        uint256 _escrowAmount,
        address _recipient,
        uint256 _totalPayoutAmount,
        bool _fromEscrow,
        bool _noRake
    )
        internal
    {
        _checkPayoutsHalted();
        _checkEpoch();
        _isNotZero(_totalPayoutAmount);
        // check if the token is a bankroll token, this is a semi redundant check since the
        // cashier should only be able to call this function with the bankroll token
        _isBankrollToken(_wagerAsset);
        // pull the bet/wager from the cashier contract
        if (_fromEscrow) {
            _isNotZero(_escrowAmount);
        }

        // calculate the net difference between the escrowed amount and the total amount that the
        // player will receive
        uint256 _amountNetDifference;
        if (_escrowAmount <= _totalPayoutAmount) {
            // calculate how much the vault lost on net
            _amountNetDifference = (_totalPayoutAmount - _escrowAmount);
            if (_amountNetDifference >= contractBalanceAccountedFor) {
                // the vault cannot payout more than it has in the contract, so we default the vault
                // we need to calculate the shortfall and store it in the contract so it can be
                // resolved manually by the protocol and vault admin
                uint256 diffShortFall_ = _amountNetDifference - contractBalanceAccountedFor;

                vaultShortfallDebt = diffShortFall_;

                shortFallRecipient = _recipient;

                vaultDefaulted = true;
                payoutsHalted = true;

                eventEmitter.emitVaultDefaulted(
                    address(bankrollToken), _totalPayoutAmount, _recipient, vaultShortfallDebt
                );

                contractBalanceAccountedFor = bankrollToken.balanceOf(address(this));

                // the vault is going to default but we need to account for the payin/payout in the
                // active epoch so the accounting is consistent
                if (_noRake) {
                    totalPaidInActiveEpochNoRake += _escrowAmount;
                    // note: technically speaking nothing is paid out yet, but we register it as a
                    // payout as either of the 2 outcomes (payout to admin or payout to recipient)
                    // result in a payout so we register it as a payout as for the WLPs it is a
                    // payout
                    totalPaidOutInActiveEpochNoRake += contractBalanceAccountedFor;
                } else {
                    totalPaidInActiveEpochRaked += _escrowAmount;
                    // note same as above
                    totalPaidOutInActiveEpochRaked += contractBalanceAccountedFor;
                }

                // close the books forever
                _closeTheBooksForeverOnDefault();

                return;
            }
        }

        if (_noRake) {
            totalPaidInActiveEpochNoRake += _escrowAmount;
            totalPaidOutInActiveEpochNoRake += _totalPayoutAmount;
        } else {
            totalPaidInActiveEpochRaked += _escrowAmount;
            totalPaidOutInActiveEpochRaked += _totalPayoutAmount;
        }

        eventEmitter.emitPayoutFromVault(
            _wagerAsset, _totalPayoutAmount, _recipient, _escrowAmount, _noRake
        );

        _payoutPlayer(_totalPayoutAmount, _recipient);
    }

    function _closeTheBooksForeverOnDefault() internal {
        // finalize the epoch forever accounting wise
        totalAllTimeMintAndBurnAmount += epochMintAndBurnAmount;
        totalPaidOutAllTime += totalPaidOutInActiveEpochRaked + totalPaidOutInActiveEpochNoRake;
        totalPaidInAllTime += totalPaidInActiveEpochRaked + totalPaidInActiveEpochNoRake;
        currentEpochEnd = 0;

        // clear the accounting variables as the vault defaulted and the epoch cycles close forever
        totalPaidOutInActiveEpochRaked = 0;
        totalPaidOutInActiveEpochNoRake = 0;
        totalPaidInActiveEpochRaked = 0;
        totalPaidInActiveEpochNoRake = 0;
        epochMintAndBurnAmount = 0;

        emit VaultBooksClosedForever(
            totalPaidOutAllTime, totalPaidInAllTime, totalAllTimeMintAndBurnAmount
        );
    }

    function _payin(address _inputToken, uint256 _escrowAmount, bool _noRake) internal {
        _isBankrollToken(_inputToken);
        _isNotZero(_escrowAmount);
        _checkIsDefaulted();
        _checkEpoch();
        // pull the ecrowed tokens to the vault from the cashier contract
        _updateTokenBalanceCheck(_escrowAmount);
        if (_noRake) {
            totalPaidInActiveEpochNoRake += _escrowAmount;
        } else {
            totalPaidInActiveEpochRaked += _escrowAmount;
        }
        eventEmitter.emitPayinToVault(_inputToken, _escrowAmount);
        emit PayinWLP(address(bankrollToken), _escrowAmount);
    }

    /*==================== Operational functions  *====================*/

    function directPoolDeposit(
        bool _noRake,
        address _tokenIn
    )
        external
        override
        onlyRegisteredEntity
        nonReentrant
    {
        _checkIsDefaulted();
        _checkEpoch();
        _isBankrollToken(_tokenIn);
        uint256 tokenAmount_ = _transferIn();
        _isNotZero(tokenAmount_);
        if (_noRake) {
            totalPaidInActiveEpochNoRake += tokenAmount_;
        } else {
            totalPaidInActiveEpochRaked += tokenAmount_;
        }
        eventEmitter.emitVaultDirectPoolDeposit(address(bankrollToken), tokenAmount_, _noRake);
        emit PayinWLP(address(bankrollToken), tokenAmount_);
    }

    function deposit(uint256 _addLiquidityFeeBasisPoints)
        external
        override
        onlyBankrollManager
        returns (uint256 amountAfterFees_, uint256 addLiquidityFee_)
    {
        // if vault is defaulted, the vault cannot deposit tokens
        _checkIsDefaulted();
        uint256 tokenAmount_ = _transferIn();
        _isNotZero(tokenAmount_);
        addLiquidityFee_ = (tokenAmount_ * _addLiquidityFeeBasisPoints) / BASIS_POINTS_DIVISOR;
        epochMintAndBurnAmount += addLiquidityFee_;
        amountAfterFees_ = tokenAmount_ - addLiquidityFee_;
        emit DepositAssetToVault(address(bankrollToken), amountAfterFees_);
        return (amountAfterFees_, addLiquidityFee_);
    }

    function withdraw(
        address _receiverTokenOut,
        uint256 _tokenAmount,
        uint256 _removeLiquidityFeeBasisPoints
    )
        external
        override
        onlyBankrollManager
        returns (uint256 amountOutAfterFees_, uint256 removeLiquidityFee_)
    {
        // if vault is defaulted, the vault cannot withdraw tokens
        _checkIsDefaulted();
        _isNotZero(_tokenAmount);
        removeLiquidityFee_ = (_tokenAmount * _removeLiquidityFeeBasisPoints) / BASIS_POINTS_DIVISOR;
        epochMintAndBurnAmount += removeLiquidityFee_;
        amountOutAfterFees_ = _tokenAmount - removeLiquidityFee_;
        _transferOut(amountOutAfterFees_, _receiverTokenOut);
        emit WithdrawBankrollFromVault(_receiverTokenOut, amountOutAfterFees_);
        return (amountOutAfterFees_, removeLiquidityFee_);
    }

    // Internal funcitons

    function _checkIsDefaulted() internal view {
        require(!vaultDefaulted, "BankrollVault: vault is defaulted");
    }

    function _checkPayoutsHalted() internal view {
        require(!payoutsHalted, "BankrollVault: payouts halted");
    }

    function _isBankrollToken(address _token) internal view {
        require(_token == address(bankrollToken), "BankrollVault: not bankroll token");
    }

    function _isNotZero(uint256 _amount) internal pure {
        require(_amount != 0, "BankrollVault: amount is 0");
    }

    function _payoutPlayer(uint256 _toPayOnNet, address _recipient) internal {
        _transferOut(_toPayOnNet, _recipient);
        emit PlayerPayout(_recipient, _toPayOnNet); // todo potentially unnessary
    }

    function _transferIn() internal returns (uint256 amountTokenIn_) {
        uint256 prevBalance_ = contractBalanceAccountedFor;
        uint256 nextBalance_ = bankrollToken.balanceOf(address(this));
        contractBalanceAccountedFor = nextBalance_;
        amountTokenIn_ = (nextBalance_ - prevBalance_);
    }

    function _transferOut(uint256 _amountOut, address _receiver) internal {
        bankrollToken.safeTransfer(_receiver, _amountOut);
        contractBalanceAccountedFor = bankrollToken.balanceOf(address(this));
    }

    function _updateTokenBalance() internal {
        contractBalanceAccountedFor = bankrollToken.balanceOf(address(this));
    }

    function _updateTokenBalanceCheck(uint256 _incrementBy) internal {
        uint256 prevBalance_ = contractBalanceAccountedFor;
        contractBalanceAccountedFor = bankrollToken.balanceOf(address(this));
        require(
            contractBalanceAccountedFor >= prevBalance_ + _incrementBy,
            "BankrollVault: Invalid increment of tranfser in"
        );
    }

    function updateTokenBalance() external override {
        _updateTokenBalance();
    }

    function returnIsEpochEnded() external view returns (bool) {
        if (block.timestamp > currentEpochEnd) {
            return true;
        }
        return false;
    }

    function processEndOfEpochByLiquidityManager() external onlyBankrollManager {
        // cannot be called if vault is in defaulted state
        _checkIsDefaulted();
        _processEndOfEpoch();
    }

    function _checkEpoch() internal {
        if (block.timestamp > currentEpochEnd) {
            _processEndOfEpoch();
        }
    }

    function _processEndOfEpoch() internal {
        uint256 totalPaidOutInActiveEpochRaked_ = totalPaidOutInActiveEpochRaked;
        uint256 totalPaidInActiveEpochRaked_ = totalPaidInActiveEpochRaked;
        uint256 totalPaidInActiveEpochNoRake_ = totalPaidInActiveEpochNoRake;
        uint256 totalPaidOutInActiveEpochNoRake_ = totalPaidOutInActiveEpochNoRake;
        uint256 epochCounter_ = epochCounter;
        uint256 totalPaidOut_ = totalPaidOutInActiveEpochRaked_ + totalPaidOutInActiveEpochNoRake_;
        uint256 totalPaidIn_ = totalPaidInActiveEpochRaked_ + totalPaidInActiveEpochNoRake_;

        Epoch storage epoch_ = epochInfo[epochCounter_];
        epoch_.paidOutRakedActive = totalPaidOutInActiveEpochRaked_;
        epoch_.paidInRakedActive = totalPaidInActiveEpochRaked_;
        epoch_.paidOutNoRakeActive = totalPaidOutInActiveEpochNoRake_;
        epoch_.paidInNoRakeActive = totalPaidInActiveEpochNoRake_;
        epoch_.timestampWhenEpochWasFinalized = uint32(block.timestamp);
        epoch_.lpSupplyEndOfEpoch = liquidityShareToken.totalSupply();

        totalPaidOutAllTime += totalPaidOut_;
        totalPaidInAllTime += totalPaidIn_;

        // the next epoch starts in epochDuration seconds from now
        currentEpochEnd = epochInfo[epochCounter_].epochEnd + epochDuration;

        totalAllTimeMintAndBurnAmount += epochMintAndBurnAmount;

        // amount that will be paid to the protocol rake collector
        uint256 totalProfitRake_;
        uint256 totalProfitOrLoss_;
        uint256 profitOrLossForWLPS_;

        if (totalPaidOutInActiveEpochRaked_ >= totalPaidInActiveEpochRaked_) {
            // vault has made a loss, so the rake is 0
            totalProfitRake_ = 0;
            totalProfitOrLoss_ = totalPaidOutInActiveEpochRaked_ - totalPaidInActiveEpochRaked_;
            profitOrLossForWLPS_ = totalProfitOrLoss_;
        } else {
            totalProfitOrLoss_ = totalPaidInActiveEpochRaked_ - totalPaidOutInActiveEpochRaked_;

            totalProfitRake_ =
                ((totalProfitOrLoss_ * ratioProfitForProtocol)) / BASIS_POINTS_DIVISOR;

            profitOrLossForWLPS_ = totalProfitOrLoss_ - totalProfitRake_;
            epoch_.wasRakeApplied = true;
            epoch_.rakeFeeChargedEndOfEpoch = totalProfitRake_;
        }

        if (totalProfitRake_ > 0) {
            _mintWLPForRake(totalProfitRake_);
        }

        // clear the accounting variables for the next epoch
        totalPaidOutInActiveEpochRaked = 0;
        totalPaidOutInActiveEpochNoRake = 0;
        totalPaidInActiveEpochRaked = 0;
        totalPaidInActiveEpochNoRake = 0;
        epochMintAndBurnAmount = 0;

        ratioProfitForProtocol = factory.returnRatioForProtocolNextEpoch(bankrollIndex);

        eventEmitter.emitEpochFinalized(
            epochCounter_,
            address(bankrollToken),
            totalPaidOutInActiveEpochRaked_,
            totalPaidInActiveEpochRaked_,
            currentEpochEnd,
            totalProfitRake_,
            totalProfitOrLoss_,
            profitOrLossForWLPS_
        );

        emit EpochFinalized(
            epochCounter_,
            address(bankrollToken),
            totalPaidOutInActiveEpochRaked_,
            totalPaidInActiveEpochRaked_,
            currentEpochEnd,
            totalProfitRake_,
            totalProfitOrLoss_,
            profitOrLossForWLPS_
        );

        epochCounter++;

        // the next epoch starts now
        epochInfo[epochCounter].epochStart = uint32(currentEpochEnd - epochDuration);
        epochInfo[epochCounter].epochEnd = uint32(currentEpochEnd);
    }

    function _mintWLPForRake(uint256 _tokenAmountToDistribute) internal {
        uint256 lpTokenSupply_ = liquidityShareToken.totalSupply();
        (uint256 amountLPToMint_,) =
            returnAddLiquidityBankrollAmount(lpTokenSupply_, _tokenAmountToDistribute, 0);

        address rakeCollector_ = _returnRakeCollectorAddress();

        eventEmitter.emitWLPMintedForRake(rakeCollector_, _tokenAmountToDistribute, amountLPToMint_);

        totalTokensForRakeAllTime += _tokenAmountToDistribute;
        totalWLPMintedAsRakeAllTime += amountLPToMint_;

        liquidityShareToken.mintLiquidityTokenByVault(rakeCollector_, amountLPToMint_);

        factory.distributeEpochRakeRewards();
    }

    // View functions

    /**
     * The vault will check if the payouts are halted. The payouts are halted if the vault has
     * defaulted. If the vault has defaulted the vault will not be able to pay out any more tokens.
     *   note this function will be called upstream to check if the bankroll deployment is able to
     *  payin/payoutInVault
     */
    function isHalted() external view override returns (bool isHalted_) {
        isHalted_ = vaultDefaulted || payoutsHalted;
    }

    function isPayoutsHalted() external view override returns (bool) {
        return payoutsHalted;
    }

    function isDefaulted() external view override returns (bool) {
        return vaultDefaulted;
    }

    function isPoolInProfitInActiveEpochRaked() public view override returns (bool) {
        return totalPaidInActiveEpochRaked > totalPaidOutInActiveEpochRaked;
    }

    function isPoolInProfitInActiveEpochNoRake() public view override returns (bool) {
        return totalPaidInActiveEpochNoRake > totalPaidOutInActiveEpochNoRake;
    }

    function isPoolInProfitInActiveEpoch() public view override returns (bool) {
        uint256 totalPaidIn_ = totalPaidInActiveEpochRaked + totalPaidInActiveEpochNoRake;
        uint256 totalPaidOut_ = totalPaidOutInActiveEpochRaked + totalPaidOutInActiveEpochNoRake;
        return totalPaidIn_ > totalPaidOut_;
    }

    /**
     * The vault will return the last _amountOfEpochsToReturn epochs - including the active epoch
     * if the active epoch is not yet finalized, it will return the active epoch as well
     *
     * @param _amountOfEpochsToReturn the amount of epochs to return
     * @return firstEpochIndex_ the index of the first epoch to return, so this is the index of
     * the
     * most recent epoch in the array
     * @return epochs_ the epochs to return
     */
    function returnLastEpochInfo(uint256 _amountOfEpochsToReturn)
        public
        view
        returns (uint256 firstEpochIndex_, Epoch[] memory epochs_)
    {
        if (_amountOfEpochsToReturn >= epochCounter) {
            firstEpochIndex_ = 1;
            _amountOfEpochsToReturn = epochCounter;
        } else {
            firstEpochIndex_ = epochCounter - _amountOfEpochsToReturn + 1;
        }
        epochs_ = new Epoch[](_amountOfEpochsToReturn);

        for (uint256 i = 0; i < _amountOfEpochsToReturn; i++) {
            epochs_[i] = _returnEpochInfo(epochCounter - i);
        }
        return (firstEpochIndex_, epochs_);
    }

    /**
     * The vault will return all epochs that the vault has.
     *  @dev there is a risk that this overflows/is not possible if there are many epochs
     *
     * @return firstEpochIndex_ the index of the first epoch to return, so this is the index of the
     * most recent epoch in the array
     * @return epochs_ the epochs to return
     */
    function returnAllEpochInfo()
        external
        view
        returns (uint256 firstEpochIndex_, Epoch[] memory)
    {
        return returnLastEpochInfo(epochCounter);
    }

    function returnEpochInfoOfIndex(
        uint256 _epochStart,
        uint256 _epochEnd
    )
        external
        view
        override
        returns (Epoch[] memory epochs_)
    {
        uint256 length_ = _epochEnd - _epochStart;
        uint256 count_ = 0;
        epochs_ = new Epoch[](length_);
        for (uint256 i = _epochStart; i <= _epochEnd; i++) {
            epochs_[count_] = _returnEpochInfo(i);
            count_++;
        }
        return epochs_;
    }

    function _returnEpochInfo(uint256 _epoch) internal view returns (Epoch memory epoch_) {
        if (_epoch == epochCounter) {
            // return the active epoch info (epochCounter is the current epoch)
            epoch_ = Epoch({
                wasRakeApplied: false, // epoch not finalized yet
                epochStart: epochInfo[_epoch].epochStart,
                epochEnd: uint32(currentEpochEnd),
                timestampWhenEpochWasFinalized: 0,
                mintAndBurnFeesActive: epochMintAndBurnAmount,
                paidOutRakedActive: totalPaidOutInActiveEpochRaked,
                paidInRakedActive: totalPaidInActiveEpochRaked,
                paidOutNoRakeActive: totalPaidOutInActiveEpochNoRake,
                paidInNoRakeActive: totalPaidInActiveEpochNoRake,
                lpSupplyEndOfEpoch: liquidityShareToken.totalSupply(),
                rakeFeeChargedEndOfEpoch: 0
            });
            return epoch_;
        } else if (_epoch > epochCounter) {
            return epoch_;
        } else {
            return epochInfo[_epoch];
        }
    }

    function returnEpochInfo(uint256 _epoch) external view override returns (Epoch memory) {
        return epochInfo[_epoch];
    }

    function returnCurrentEpochInfo() external view override returns (Epoch memory) {
        return epochInfo[epochCounter];
    }

    function returnRegisteredTokens() external view override returns (uint256) {
        return contractBalanceAccountedFor;
    }

    /**
     * The vault will return the net profit or loss of the vault in the active epoch.
     *
     * @return isProfit_ true if the vault is in profit, false if the vault is in loss
     * @return amountDelta_ the net profit or loss of the vault in the active epoch
     */
    function returnNetProfitOrLossInActiveEpoch()
        public
        view
        override
        returns (bool isProfit_, uint256 amountDelta_)
    {
        uint256 totalPaidIn_ = totalPaidInActiveEpochRaked + totalPaidInActiveEpochNoRake;
        uint256 totalPaidOut_ = totalPaidOutInActiveEpochRaked + totalPaidOutInActiveEpochNoRake;
        if (totalPaidIn_ > totalPaidOut_) {
            isProfit_ = true;
            amountDelta_ = totalPaidIn_ - totalPaidOut_;
        } else {
            isProfit_ = false;
            amountDelta_ = totalPaidOut_ - totalPaidIn_;
        }
    }

    /**
     * The vault will return the net profit or loss of the vault in the active epoch.
     *
     * @return isProfit_ true if the vault is in profit, false if the vault is in loss
     * @return amountDelta_ the net profit or loss of the vault in the active epoch
     */
    function returnNetProfitOrLossRaked()
        public
        view
        override
        returns (bool isProfit_, uint256 amountDelta_)
    {
        if (totalPaidInActiveEpochRaked > totalPaidOutInActiveEpochRaked) {
            isProfit_ = true;
            amountDelta_ = totalPaidInActiveEpochRaked - totalPaidOutInActiveEpochRaked;
        } else {
            isProfit_ = false;
            amountDelta_ = totalPaidOutInActiveEpochRaked - totalPaidInActiveEpochRaked;
        }
    }

    /**
     * The vault will return the rake amount in the active epoch.
     *
     * @dev rake will only be paid if the vault is in profit
     *
     * @return amount_ the rake amount in the active epoch in tokens
     */
    function returnRakeAmountInActiveEpoch() public view returns (uint256) {
        bool isProfit_;
        uint256 amountDelta_;
        (isProfit_, amountDelta_) = returnNetProfitOrLossRaked();
        if (isProfit_) {
            return (amountDelta_ * ratioProfitForProtocol) / BASIS_POINTS_DIVISOR;
        }
        return 0;
    }

    /**
     * The vault will return the active epoch result.
     *
     * @return totalPaidInNoRake_ the total paid in tokens no rake
     * @return totalPaidInRaked_ the total paid in tokens raked
     * @return totalPaidOutNoRake_ the total paid out tokens no rake
     * @return totalPaidOutRaked_ the total paid out tokens raked
     * @return totalPaidInAllTime_ the total paid in tokens all time
     * @return totalPaidOutAllTime_ the total paid out tokens all time
     * @return secondsLeftInEpoch_ the seconds left in epoch, if 0, the epoch is over
     */
    function returnActiveEpochResult()
        external
        view
        returns (
            uint256 totalPaidInNoRake_,
            uint256 totalPaidInRaked_,
            uint256 totalPaidOutNoRake_,
            uint256 totalPaidOutRaked_,
            uint256 totalPaidInAllTime_,
            uint256 totalPaidOutAllTime_,
            uint256 secondsLeftInEpoch_
        )
    {
        if (block.timestamp < currentEpochEnd) {
            secondsLeftInEpoch_ = currentEpochEnd - block.timestamp;
        } else {
            secondsLeftInEpoch_ = 0;
        }
        return (
            totalPaidInActiveEpochNoRake,
            totalPaidInActiveEpochRaked,
            totalPaidOutInActiveEpochNoRake,
            totalPaidOutInActiveEpochRaked,
            totalPaidInAllTime,
            totalPaidOutAllTime,
            secondsLeftInEpoch_
        );
    }

    /**
     * The vault will return the net profit or loss of the vault in a certain epoch.
     *
     * @param _epoch the epoch to check
     * @return isProfit_ true if the vault is in profit, false if the vault is in loss
     * @return amountDelta_ the net profit or loss of the vault in the epoch
     */
    function returnNetProfitLossOfEpoch(uint256 _epoch)
        external
        view
        override
        returns (bool isProfit_, uint256 amountDelta_)
    {
        if (_epoch > epochCounter) {
            return (false, 0);
        }

        uint256 totalPaidIn_ =
            epochInfo[_epoch].paidInRakedActive + epochInfo[_epoch].paidInNoRakeActive;
        uint256 totalPaidOut_ =
            epochInfo[_epoch].paidOutRakedActive + epochInfo[_epoch].paidOutNoRakeActive;

        if (_epoch == epochCounter) {
            return returnNetProfitOrLossInActiveEpoch();
        } else if (totalPaidIn_ > totalPaidOut_) {
            isProfit_ = true;
            amountDelta_ = totalPaidIn_ - totalPaidOut_;
        } else {
            isProfit_ = false;
            amountDelta_ = totalPaidOut_ - totalPaidIn_;
        }

        return (isProfit_, amountDelta_);
    }

    /**
     * The vault will return the net profit or loss of the vault in all time.
     *
     * @return isProfit_ true if the vault is in profit, false if the vault is in loss
     * @return amountDelta_ the net profit or loss of the vault in all time
     */
    function returnAllTimeProfitOrLoss()
        public
        view
        override
        returns (bool isProfit_, uint256 amountDelta_)
    {
        if (totalPaidInAllTime > totalPaidOutAllTime) {
            isProfit_ = true;
            amountDelta_ = totalPaidInAllTime - totalPaidOutAllTime;
        } else {
            isProfit_ = false;
            amountDelta_ = totalPaidOutAllTime - totalPaidInAllTime;
        }
    }

    function returnAllTimeProfitLossIncludingActiveEpoch()
        external
        view
        returns (bool isProfit_, uint256 amountDelta_)
    {
        (isProfit_, amountDelta_) = returnAllTimeProfitOrLoss();
        (bool isProfitActive_, uint256 amountDeltaActive_) = returnNetProfitOrLossInActiveEpoch();
        if (isProfit_ && isProfitActive_) {
            amountDelta_ += amountDeltaActive_;
            return (isProfit_, amountDelta_);
        } else if (!isProfit_ && !isProfitActive_) {
            amountDelta_ += amountDeltaActive_;
            return (isProfit_, amountDelta_);
        } else if (isProfit_ && !isProfitActive_) {
            if (amountDelta_ > amountDeltaActive_) {
                amountDelta_ -= amountDeltaActive_;
                // profit remains postive
                return (isProfit_, amountDelta_);
            } else {
                amountDelta_ = amountDeltaActive_ - amountDelta_;
                // profit becomes negative
                isProfit_ = false;
                return (isProfit_, amountDelta_);
            }
        } else {
            // meaning that vault all time is at a loss, but current epoch is at a profits
            if (amountDelta_ > amountDeltaActive_) {
                amountDelta_ -= amountDeltaActive_;
                return (isProfit_, amountDelta_);
            } else {
                amountDelta_ = amountDeltaActive_ - amountDelta_;
                // profit becomes positive
                isProfit_ = true;
                return (isProfit_, amountDelta_);
            }
        }
    }

    /**
     * The vault will return the amount of tokens that will be received when a certain amount of
     * LP tokens are removed from the vault. The amount of tokens that will be received is based on
     * the amount of tokens that the LPs own and the amount of LP tokens that are removed.
     *
     * @param _totalSupplyWLP the total supply of LP tokens
     * @param _amountWLP the amount of LP tokens that will be removed
     * @param _removeLiquidityFeeBasisPoints the fee that will be deducted from the amountWLP
     * @return tokenAmount_ the amount of tokens that will be received
     * @return removeLiquidityFee_ the fee that will be deducted from the amountWLP
     */
    function returnRemoveBankrollAmount(
        uint256 _totalSupplyWLP,
        uint256 _amountWLP,
        uint256 _removeLiquidityFeeBasisPoints
    )
        public
        view
        override
        returns (uint256 tokenAmount_, uint256 removeLiquidityFee_)
    {
        _checkIsDefaulted();
        // get the total amount of tokens that the LPs own
        uint256 totalTokensWLP_ = _returnTokensOwnedByLPMinusRake();
        // calculate how much tokens the _amountWLP is worth
        uint256 amountTokens_ = (_amountWLP * totalTokensWLP_) / _totalSupplyWLP;
        // calculate how much of the add liquidty amount will be paid to wlps
        removeLiquidityFee_ =
            (amountTokens_ * _removeLiquidityFeeBasisPoints) / BASIS_POINTS_DIVISOR;

        tokenAmount_ = amountTokens_ - removeLiquidityFee_;

        return (tokenAmount_, removeLiquidityFee_);
    }

    /**
     * The vault will return the amount of LP tokens that will be minted for a certain amount of
     * tokens that are deposited into the vault. The amount of LP tokens that will be minted is
     * based on the amount of tokens that the LPs own and the amount of tokens that are deposited
     * into the vault.
     *
     * @param _totalSupplyWLP the total supply of LP tokens
     * @param _tokenAmount the amount of tokens that are deposited into the vault
     * @param _addLiquidityFeeBasisPoints the fee that will be deducted from the tokenAmount (fee
     * for adding liquidity)
     * @return amountLPTokens_ the amount of LP tokens that will be minted
     * @return addLiquidityFee_ the fee that will be deducted from the tokenAmount
     */
    function returnAddLiquidityBankrollAmount(
        uint256 _totalSupplyWLP,
        uint256 _tokenAmount,
        uint256 _addLiquidityFeeBasisPoints
    )
        public
        view
        override
        returns (uint256 amountLPTokens_, uint256 addLiquidityFee_)
    {
        _checkIsDefaulted();
        // calculate the mint fee that will be deducted from the tokenAmount
        addLiquidityFee_ = (_tokenAmount * _addLiquidityFeeBasisPoints) / BASIS_POINTS_DIVISOR;
        uint256 depositAmount_ = _tokenAmount - addLiquidityFee_;
        // note that we add addLiquidityFee as to realize the fee to the old LPs, meaning that the
        // old LPs receive the add liquidity fee as we calculate the wlp price as if the fee is
        // issued to them.
        uint256 amountTokensWLP_ = _returnTokensOwnedByLPMinusRake() + addLiquidityFee_;

        uint256 ratio_;
        if (_totalSupplyWLP == 0) {
            // this is the first deposit, so the ratio is 1
            ratio_ = 1e18;
        } else {
            // calc version 1 - calculate how much tokens 1 LP is at the moment
            ratio_ = (amountTokensWLP_ * 1e18) / _totalSupplyWLP;
        }
        // calculate how much LP tokens will be minted for this effective deposit amount
        amountLPTokens_ = (depositAmount_ * 1e18) / ratio_;
        return (amountLPTokens_, addLiquidityFee_);
    }

    function returnAssetsOfBankroll() external view override returns (uint256 tokensOwnedByWLPs_) {
        return _returnTokensOwnedByLPMinusRake();
    }

    function returnBankrollTokenAddress() external view override returns (address) {
        return address(bankrollToken);
    }

    function returnTotalOutAndInActivePeriod()
        external
        view
        override
        returns (uint256 totalOutActiveEpoch_, uint256 totalInActiveEpoch_)
    {
        totalOutActiveEpoch_ = totalPaidOutInActiveEpochRaked;
        totalInActiveEpoch_ = totalPaidInActiveEpochRaked;
    }

    function getAllWhitelistedTokens() external view override returns (address[] memory address_) {
        address_ = new address[](1);
        address_[0] = address(bankrollToken);
        return address_;
    }

    // Internal view functions

    function _returnTokensOwnedByLPMinusRake() internal view returns (uint256 tokensOwnedByWLPs_) {
        // if the vault has defaulted, then return 0
        if (vaultDefaulted) {
            return 0;
        } else if (totalPaidOutInActiveEpochRaked >= totalPaidInActiveEpochRaked) {
            // in the current epoch the vault has not made a profit, so the LP token is worth the
            // same as the regitered contract balance
            tokensOwnedByWLPs_ = contractBalanceAccountedFor;
        } else {
            // the vault has made a profit, so we need to subtract the rake from the profit
            uint256 profit_ = totalPaidInActiveEpochRaked - totalPaidOutInActiveEpochRaked;
            uint256 profitForRake_ = (profit_ * ratioProfitForProtocol) / BASIS_POINTS_DIVISOR;
            tokensOwnedByWLPs_ = contractBalanceAccountedFor - profitForRake_;
        }
    }

    /*====================  Configuration functions *====================*/

    function setPayoutHaltedByProtocol(bool _setting) external override onlyProtocolContract {
        // if the vault has defaulted, then this cannot be called
        _checkIsDefaulted();
        payoutsHalted = _setting;
        eventEmitter.emitPayoutsHaltedByProtocol(_setting);
        emit PayoutsHaltedByProtocol(_setting);
    }

    function setPayoutHaltedByVaultAdmin(bool _setting) external override onlyVaultAdmin {
        _checkIsDefaulted();
        payoutsHalted = _setting;
        eventEmitter.emitPayoutsHaltedByVaultAdmin(_setting);
        emit PayoutsHaltedByVaultAdmin(_setting);
    }

    /**
     * @dev Sets the epoch duration in seconds
     * @param _epochDuration The new epoch duration.
     */
    function setEpochDuration(uint256 _epochDuration) external override onlyProtocolContract {
        _isNotZero(_epochDuration);
        epochDuration = _epochDuration;
        eventEmitter.emitEpochDurationSet(_epochDuration);
        emit EpochDurationSet(_epochDuration);
    }

    /**
     * @dev Resets the current epoch
     */
    function resetEpoch() external override onlyProtocolContract {
        _checkIsDefaulted();
        uint256 epochStart_ = factory.calculateStartOfCurrentEpoch();
        epochDuration = factory.timestampOfEpochStart();
        currentEpochEnd = epochStart_ + epochDuration;
        epochInfo[epochCounter].epochStart = uint32(epochStart_);
        epochInfo[epochCounter].epochEnd = uint32(currentEpochEnd);
        emit EpochReset(epochCounter);
    }

    function mutateRakeOfActiveEpoch(uint256 _amount) external override onlyProtocolAdministrator {
        // check if the vault is defaulted
        _checkIsDefaulted();
        // subtracting from totalPaidInActiveEpochRaked
        require(totalPaidInActiveEpochRaked >= _amount, "BankrollVault: not enough funds");
        totalPaidInActiveEpochRaked -= _amount;
        emit RakeOfActiveEpochMutated(_amount);
    }

    function setEpochEndOverride(uint256 _epochEndNew) external onlyProtocolAdministrator {
        _checkIsDefaulted();
        require(_epochEndNew > block.timestamp, "BankrollVault: epoch end is in the past");
        currentEpochEnd = _epochEndNew;
        emit EpochEndOverride(_epochEndNew);
    }

    function completeEpochManually() external override onlyProtocolContract {
        _checkIsDefaulted();
        _processEndOfEpoch();
    }

    function payoutDefaultToCounterparty() external override onlyProtocolAdministrator {
        _updateTokenBalance();
        require(vaultDefaulted, "BankrollVault: vault is not defaulted");
        require(!vaultShutdownPermanently, "BankrollVault: vault is shutdown");
        _transferOut(contractBalanceAccountedFor, shortFallRecipient);
        vaultShutdownPermanently = true;
        emit DefaultedVaultPayout(shortFallRecipient, contractBalanceAccountedFor);
        _updateTokenBalance();
    }

    function payoutDefaultToAdmin() external onlyProtocolAdministrator {
        _updateTokenBalance();
        require(vaultDefaulted, "BankrollVault: vault is not defaulted");
        require(!vaultShutdownPermanently, "BankrollVault: vault is shutdown");
        address admin_ = controller.returnBankrollAdmin();
        _transferOut(contractBalanceAccountedFor, admin_);
        vaultShutdownPermanently = true;
        emit DefaultedVaultPayout(admin_, contractBalanceAccountedFor);
        _updateTokenBalance();
    }
}

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

import "@openzeppelin/contracts/access/AccessControl.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/Pausable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "./interfaces/IBridge.sol";
import "./interfaces/IBridgeRouter.sol";

contract BridgeRouter is IBridgeRouter, AccessControl, ReentrancyGuard, Pausable {
    using SafeERC20 for IERC20;

    uint256 public gasLimit;
    bytes32 public constant OPERATOR_ROLE = keccak256("OPERATOR_ROLE");
    mapping(address token => BridgeData bridge) private _bridgeAddresses;

    constructor(address admin) {
        _grantRole(DEFAULT_ADMIN_ROLE, admin);
        _grantRole(OPERATOR_ROLE, admin);
    }

    function setBridge(
        address _token,
        BridgeData calldata _bridge
    )
        external
        onlyRole(OPERATOR_ROLE)
    {
        _bridgeAddresses[_token] = _bridge;
        emit SetBridge(_token, _bridge.bridge, _bridge.connector);
    }

    function setBridgeBatch(
        address[] calldata _tokens,
        BridgeData[] calldata _bridges
    )
        external
        onlyRole(OPERATOR_ROLE)
    {
        if (_tokens.length != _bridges.length) {
            revert LengthsMismatch();
        }
        for (uint256 i = 0; i < _tokens.length; i++) {
            _bridgeAddresses[_tokens[i]] = _bridges[i];
            emit SetBridge(_tokens[i], _bridges[i].bridge, _bridges[i].connector);
        }
    }

    function setGasLimit(uint256 _gasLimit) external onlyRole(OPERATOR_ROLE) {
        gasLimit = _gasLimit;
        emit SetGasLimit(_gasLimit);
    }

    function bridge(
        address token,
        uint256 amount,
        address receiver
    )
        external
        nonReentrant
        whenNotPaused
    {
        address bridgeAddress = _bridgeAddresses[token].bridge;
        address connectorAddress = _bridgeAddresses[token].connector;

        if (bridgeAddress == address(0) || connectorAddress == address(0)) {
            revert BridgeNotFound(token);
        }

        IERC20(token).safeTransferFrom(msg.sender, address(this), amount);
        IERC20(token).forceApprove(bridgeAddress, amount);
        IBridge bridgeContract = IBridge(bridgeAddress);

        uint256 totalFees = bridgeContract.getMinFees(connectorAddress, gasLimit, 0);

        if (address(this).balance < totalFees) {
            revert InsufficientFunds(totalFees, address(this).balance);
        }

        bridgeContract.bridge{ value: totalFees }(
            receiver, amount, gasLimit, connectorAddress, bytes(""), bytes("")
        );

        emit Bridge(msg.sender, token, amount, receiver);
    }

    function deposit(uint256 amount) external payable nonReentrant whenNotPaused {
        if (msg.value != amount) {
            revert InvalidDepositAmount(amount, msg.value);
        }
        emit Deposit(msg.sender, amount);
    }

    function withdraw(
        address to,
        uint256 amount
    )
        external
        nonReentrant
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        (bool success,) = to.call{ value: amount }("");
        if (!success) {
            revert TransferFailed();
        }
        emit Withdraw(to, amount);
    }

    function getBridge(address token) external view returns (BridgeData memory) {
        return _bridgeAddresses[token];
    }
}

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

interface IBridge {
    function bridge(
        address receiver_,
        uint256 amount_,
        uint256 msgGasLimit_,
        address connector_,
        bytes calldata extraData_,
        bytes calldata options_
    )
        external
        payable;

    function getMinFees(
        address connector_,
        uint256 msgGasLimit_,
        uint256 payloadSize_
    )
        external
        view
        returns (uint256 totalFees);
}

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

interface IBridgeRouter {
    struct BridgeData {
        address bridge;
        address connector;
    }

    event SetBridge(address indexed token, address indexed bridge, address connector);
    event SetGasLimit(uint256 gasLimit);
    event Bridge(address indexed user, address indexed token, uint256 amount, address receiver);
    event Deposit(address indexed user, uint256 amount);
    event Withdraw(address indexed user, uint256 amount);

    error LengthsMismatch();
    error BridgeNotFound(address token);
    error InvalidDepositAmount(uint256 amount, uint256 msgValue);
    error TransferFailed();
    error InsufficientFunds(uint256 amount, uint256 balance);
}

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

import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
import { IMintableERC20 } from "./IMintableERC20.sol";

contract BridgedToken is IMintableERC20, ERC20, AccessControl {
  bytes32 public constant BRIDGE_ROLE = keccak256("BRIDGE_ROLE");
  uint8 private _decimals;

  constructor(
    string memory name,
    string memory symbol,
    uint8 decimal,
    address owner
  ) ERC20(name, symbol) {
    _grantRole(DEFAULT_ADMIN_ROLE, owner);
    _grantRole(BRIDGE_ROLE, owner);

    _decimals = decimal;
  }

  function decimals() public view override returns (uint8) {
    return _decimals;
  }

  function mint(address recipient, uint256 quantity) external override onlyRole(BRIDGE_ROLE) {
    _mint(recipient, quantity);
  }

  function burn(address burner, uint256 quantity) external override onlyRole(BRIDGE_ROLE) {
    _burn(burner, quantity);
  }
}

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


interface IMintableERC20 {
    function mint(address recipient_, uint256 quantity_) external;
    function burn(address burner_, uint256 quantity_) external;
}

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

import "./IConfigStruct.sol";

interface IBankrollController {
    function __initializeBankrollController(
        IConfigStruct.AddressConfiguration memory _initConfig,
        address _vaultAdapter,
        bool _isAddingLPOpen
    )
        external;

    function isBankroll(address _address) external view returns (bool);

    function isRegisteredAdapter(address _address) external view returns (bool);

    function isBankrollAdmin(address _address) external view returns (bool);

    function isBankrollManager(address _address) external view returns (bool);

    function isCallerRegisteredEntity(address _address) external view returns (bool);

    function isWINRProtocolContract(address _address) external view returns (bool);

    function liquidityManagerForRakeCollection() external view returns (address);

    function isWINRProtocolAdminstrator(address _address) external view returns (bool);

    function returnIfAddingLPIsOpen() external view returns (bool isAddingLpOpen_);

    function returnRakeCollectorAddress() external view returns (address rakeCollectorAddress_);

    function checkIfRemovingLPIsHaltedByProtocol() external view returns (bool isAllowed_);

    function returnBankrollAdmin() external view returns (address);

    function setLiquidityManagerForRakeCollection(address _newLiquidityManagerForRakeCollection)
        external;

    function registerVaultAdapter(address _address, bool _isRegistered) external;

    function setManagerOfBankroll(address _managerOfBankroll, bool _isRegistered) external;

    function registerEnity(address _address, bool _isRegistered) external;

    function setAddingLiquidityOpen(bool _setting) external;

    event LiquidityManagerForRakeCollectionChanged(address _newLiquidityManagerForRakeCollection);

    event ManagerOfBankrollChanged(address _managerOfBankroll);

    event BankrollPaused(bool isPaused, address requester, bool byAdmin);

    event EntityRegistered(address _address, bool _isRegistered);

    event VaultAdapterRegistered(address indexed _address, bool _isRegistered);

    event AddingLPOpenChanged(bool _setting);
}

// SPDX-License-Identifier: MIT

pragma solidity ^0.8.23;

import "./IConfigStruct.sol";

interface IBankrollFactory {
    struct CreateVaultConfig {
        address bankrollToken;
        address vaultAdmin;
        uint256 addLiquidityFeeBasisPoints;
        uint256 removeLiquidityFeeBasisPoints;
        uint256 maxAssetAmount;
        uint256 minimalLpTokenAmount;
        bool isPrivateVault;
        string label;
        string shareTokenName;
        string shareTokenSymbol;
        bool isAddingLpOpen;
    }

    struct VaultDeployment {
        string label;
        address adminAddressInitial;
        address vault;
        address vaultManagerInitial;
        address controller;
        address shareToken;
        address bankrollToken;
    }

    function createVault(CreateVaultConfig memory _config)
        external
        returns (uint256 vaultIndex_, VaultDeployment memory vaultDeployment_);

    function distributeEpochRakeRewards() external;

    function pauseProtocol() external;

    function unpauseProtocol() external;

    function setDefaultCooldownDuration(uint256 _defaultCooldownDuration) external;

    function setVaultAdapter(address _vaultAdapterAddress) external;

    function setVaultV2Implementation(address _vaultV2Implementation) external;

    function setLiquidityManagerImplementation(address _wlpV2Implementation) external;

    function setShareTokenImplementation(address _shareTokenImplementation) external;

    function setRakeCollectionContract(address _rakeCollectionContract) external;

    function setControllerImplementation(address _controllerImplementation) external;

    function setEpochDuration(uint256 _epochDuration) external;

    function setVaultEventEmitter(address _vaultEventEmitter) external;

    function setRakeRatioForProtocolInitial(uint256 _rakeRatioForProtocolInitial) external;

    function withdrawERC20Tokens(address _tokenAddress, address _to, uint256 _amount) external;

    function setProtocolHaltOfDeployment(uint256 _indexBankroll, bool _halt) external;

    function calculateStartOfCurrentEpoch() external view returns (uint256);

    function timestampOfEpochStart() external view returns (uint256);

    function returnFulLDeploymentInfo()
        external
        view
        returns (VaultDeployment[] memory deployments_);

    function returnShareTokenAddressesDeployed()
        external
        view
        returns (address[] memory shareAddreses_);

    function returnAllVaultAddressesDeployed()
        external
        view
        returns (address[] memory vaultAddresses_);

    function returnEpochInformation(uint256 _indexBankroll)
        external
        view
        returns (uint32 epochCounter_, uint256 epochEndTimeStamp_);

    function isCallerProtocol(address _account) external view returns (bool);

    function isProtocolPaused() external view returns (bool);

    function isCallerProtocolGovernance(address _account) external view returns (bool);

    function returnRakeCollectorAddress() external view returns (address);

    function isBankrollDeploymentHaltedByProtocol() external view returns (bool);

    function returnVaultDeploymentInfo(uint256 _indexBankroll)
        external
        view
        returns (VaultDeployment memory);

    function returnRatioForProtocolNextEpoch(uint256 _indexBankroll)
        external
        view
        returns (uint256 rakeRatio_);

    function returnRakeLiquidityManagerBankrollToken(address _shareToken)
        external
        view
        returns (address rakeLiquidityManager, address bankrollToken);

    event DefaultCooldownDurationSet(uint256 cooldownDuration);

    event EndOfEpochTimeSet(uint256 _endOfEpochTime);

    event VaultV2ImplementationSet(address indexed vaultV2Implementation);

    event LiquidityManagerImplementationSet(address indexed liquidityManagerImplementation);

    event ShareTokenImplementationSet(address indexed shareTokenImplementation);

    event RakeCollectionContractSet(address indexed rakeCollectionContract);

    event VaultEventEmitterSet(address indexed _vaultEventEmitter);

    event ControllerImplementationSet(address indexed controllerImplementation);

    event RakeRewardsDistributed(uint256 index);

    event ProtocolHaltOfDeploymentSet(uint256 indexed indexBankroll, bool halt);

    event RakeRatioForProtocolInitialSet(uint256 _rakeRatioForProtocolInitial);

    event VaultDeployed(
        uint256 indexBankroll, address vault, address controller, address shareToken
    );

    event EpochDurationSet(uint256 _epochDuration);

    event VaultAdapterSet(address indexed vaultAdapterAddress);

    event WinrLockSet(address indexed winrLock);

    event PaymasterAddressSet(address indexed paymasterAddress);
}

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

import "./IConfigStruct.sol";

interface IBankrollLiquidityManager {
    function __initializeWLPManager(
        IConfigStruct.AddressConfiguration memory _initConfig,
        uint256 _removeLiquidityFeeBasisPoints,
        uint256 _addLiquidityFeeBasisPoints,
        uint256 _cooldownDuration,
        uint256 _minimalLpTokenAmount,
        bool _isPrivateMode
    )
        external;

    function setInPrivateMode(bool _inPrivateMode) external;

    function addLiquidity(
        address _token,
        uint256 _amount,
        uint256 _minWlp
    )
        external
        returns (uint256 lpTokenAmount_);

    function removeLiquidity(
        address _tokenOut,
        uint256 _lpTokenAmount,
        uint256 _minOut
    )
        external
        returns (uint256 tokenOutAmount_);

    function returnWhitelistedWLPAddresses(address _address) external view returns (bool);

    function setWhitelistedWLPAddresses(address _lpAddress, bool _isWhitelisted) external;

    function setMaxAssetAmount(uint256 _maxWLPAmount) external;

    function setRemoveLiquidityFeeBasisPoints(uint256 _removeLiquidityFeeBasisPoints) external;

    function setAddLiquidityFeeBasisPoints(uint256 _addLiquidityFeeBasisPoints) external;

    function setCooldownDuration(uint256 _cooldownDuration) external;

    // Events

    event BankrollAdminChanged(address _newBankrollAdmin);

    event WhitelistedWLPAddressSet(address indexed lpAddress, bool isWhitelisted);

    event AddLiquidity(
        address indexed fundingAccount,
        address indexed token,
        uint256 amount,
        uint256 addLiquidityFee,
        uint256 amountWLP
    );

    event RemoveLiquidity(
        address indexed account,
        address indexed tokenOut,
        uint256 wlpAmount,
        uint256 amountOut,
        uint256 burnFee
    );

    event MaxWLPAmountSet(uint256 _maxWLPAmount);

    event InPrivateModeSet(bool _inPrivateMode);

    event RemoveLiquidityFeeSet(uint256 _removeLiquidityFeeBasisPoints);

    event AddLiquidityBasisPointsSet(uint256 _addLiquidityFeeBasisPoints);

    event CooldownDurationSet(uint256 _cooldownDuration);

    /**
     * @dev Returns true if the vault is halted, false otherwise.
     */
    function isVaultHalted() external view returns (bool isHalted_);

    /**
     * @dev Returns the total amount of bankroll tokens in the vault/bankroll
     */
    function getTUM() external view returns (uint256);

    function getLiquidityTokenSupply() external view returns (uint256);

    function getRatioLPToken() external view returns (uint256 lpTokenRatio_);

    function isLPTokenAllowedToBeTransferred(address _address) external view returns (bool);

    function removeLiquidityFeeBasisPoints() external view returns (uint256);

    function addLiquidityFeeBasisPoints() external view returns (uint256);

    function getRatioAssetToken() external view returns (uint256 assetTokenRatio_);
}

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

import "./IConfigStruct.sol";

interface IBankrollVault {
    struct Epoch {
        bool wasRakeApplied; // bool indicating if a rake was applied in the epoch
        uint32 epochStart; // time the epoch started
        uint32 epochEnd; // time the epoch is completed completed
        uint32 timestampWhenEpochWasFinalized; // time the epoch was actually finalized (higher or
            // same as epochEnd)
        uint256 mintAndBurnFeesActive; // amount of mint/burn fees in the epoch
        uint256 paidOutRakedActive; // amount of payouts raked in the epoch
        uint256 paidInRakedActive; // amount of payins raked in the epoch
        uint256 paidOutNoRakeActive; // amount of payouts in the epoch without rake
        uint256 paidInNoRakeActive; // amount of payins in the epoch without rake
        uint256 lpSupplyEndOfEpoch; // total supply of the LP token at the end of the epoch
        uint256 rakeFeeChargedEndOfEpoch; // amount of rake fees charged in the epoch
    }

    function currentEpochEnd() external view returns (uint256);

    function epochDuration() external view returns (uint256);

    function isPayoutsHalted() external view returns (bool);

    function ratioProfitForProtocol() external view returns (uint256);

    function contractBalanceAccountedFor() external view returns (uint256);

    function getAllWhitelistedTokens() external view returns (address[] memory address_);

    function returnNetProfitOrLossRaked()
        external
        view
        returns (bool isProfit_, uint256 amountDelta_);

    function returnActiveEpochResult()
        external
        view
        returns (
            uint256 totalPaidInNoRake_,
            uint256 totalPaidInRaked_,
            uint256 totalPaidOutNoRake_,
            uint256 totalPaidOutRaked_,
            uint256 totalPaidInAllTime_,
            uint256 totalPaidOutAllTime_,
            uint256 secondsLeftInEpoch_
        );

    function isPoolInProfitInActiveEpoch() external view returns (bool);

    function isPoolInProfitInActiveEpochNoRake() external view returns (bool);

    /*==================== Configuration unctions *====================*/

    function __initializeVault(
        IConfigStruct.AddressConfiguration memory _initConfig,
        uint256 _epochDuration,
        uint256 _ratioProfitForProtocol,
        uint256 _startTimestamp
    )
        external;

    function updateTokenBalance() external;

    function setEpochDuration(uint256 _epochDuration) external;

    function setPayoutHaltedByVaultAdmin(bool _setting) external;

    function setPayoutHaltedByProtocol(bool _setting) external;

    function directPoolDeposit(bool _noRake, address _tokenIn) external;

    function returnIsEpochEnded() external view returns (bool);

    function processEndOfEpochByLiquidityManager() external;

    /*==================== Operational Functions *====================*/

    function deposit(uint256 _addLiquidityFeeBasisPoints)
        external
        returns (uint256 amountAfterFees, uint256 addLiquidityFee);

    function withdraw(
        address _receiverTokenOut,
        uint256 _tokenAmount,
        uint256 _removeLiquidityFeeBasisPoints
    )
        external
        returns (uint256 amountAfterFees, uint256 burnFee);

    function payoutDefaultToCounterparty() external;

    function payoutNoEscrowInVault(
        address _wagerAsset,
        address _recipient,
        uint256 _totalAmount
    )
        external;

    function payoutInVault(
        address _wagerAsset,
        uint256 _escrowAmount,
        address _recipient,
        uint256 _totalAmountPayout
    )
        external;

    function payoutInVault(
        address _wagerAsset,
        uint256 _escrowAmount,
        address _recipient,
        uint256 _totalAmountPayout,
        bool _noRake
    )
        external;

    function resetEpoch() external;

    function completeEpochManually() external;

    /*==================== Events *====================*/

    event VaultBooksClosedForever(
        uint256 totalPaidOutAllTime,
        uint256 totalPaidInAllTime,
        uint256 totalAllTimeMintAndBurnAmount
    );

    event DepositAssetToVault(address indexed tokenIn, uint256 amountIn);

    event PlayerPayout(address indexed recipient, uint256 amount);

    event EpochDurationSet(uint256 epochDuration);

    event DirectPoolDeposit(address token, uint256 amount);

    event WithdrawBankrollFromVault(address indexed receiverTokenOut, uint256 amountOutAfterFees);

    // address of the token sent into the vault
    event PayinWLP(
        address tokenInAddress,
        // amount payed in (was in escrow)
        uint256 amountPayin
    );

    event EpochFinalized(
        uint256 indexed epochId,
        address indexed token,
        uint256 totalPaidIn,
        uint256 totalPaidOut,
        uint256 currentEpochEnd,
        uint256 profitToRake,
        uint256 netProfitOrLoss,
        uint256 profitOrLossForWLPS
    );

    event BankrollManagerSet(address indexed manager, bool isManager);

    event PayoutsHaltedByProtocol(bool payoutsHalted);

    event PayoutsHaltedByVaultAdmin(bool payoutsHalted);

    event RatioProfitForProtocolSet(uint256 ratioProfitForProtocol);

    event RakeOfActiveEpochMutated(uint256 amount);

    event EpochEndOverride(uint256 _epochEndNew);

    event EpochReset(uint256 indexed epoch);

    event DefaultedVaultPayout(address indexed recipient, uint256 _amount);

    // View functions

    function returnEpochInfoOfIndex(
        uint256 _epochStart,
        uint256 _epochEnd
    )
        external
        view
        returns (Epoch[] memory epochs_);

    function returnNetProfitLossOfEpoch(uint256 _epoch)
        external
        view
        returns (bool isProfit_, uint256 amountDelta_);

    function returnAllTimeProfitOrLoss()
        external
        view
        returns (bool isProfit_, uint256 amountDelta_);

    function returnRemoveBankrollAmount(
        uint256 _totalSupplyWLP,
        uint256 _amountWLP,
        uint256 _removeLiquidityFee
    )
        external
        view
        returns (uint256 tokenAmount_, uint256 removeLiquidityFee_);

    function returnAllTimeProfitLossIncludingActiveEpoch()
        external
        view
        returns (bool isProfit_, uint256 amountDelta_);

    function returnAddLiquidityBankrollAmount(
        uint256 _totalSupplyWLP,
        uint256 _tokenAmount,
        uint256 _addLiquidityFee
    )
        external
        view
        returns (uint256 amountWLP, uint256 addLiquidityFee);

    function isHalted() external view returns (bool);

    function isDefaulted() external view returns (bool);

    function returnAssetsOfBankroll() external view returns (uint256 tokensOwnedByWLPs);

    function returnTotalOutAndInActivePeriod()
        external
        view
        returns (uint256 totalOutActiveEpoch_, uint256 totalInActiveEpoch_);

    function returnBankrollTokenAddress() external view returns (address);

    function returnNetProfitOrLossInActiveEpoch()
        external
        view
        returns (bool isProfit_, uint256 amountDelta_);

    function returnRegisteredTokens() external view returns (uint256);

    function epochCounter() external view returns (uint256);

    function returnCurrentEpochInfo() external view returns (Epoch memory);

    function returnEpochInfo(uint256 _epoch) external view returns (Epoch memory);

    function isPoolInProfitInActiveEpochRaked() external view returns (bool);

    function mutateRakeOfActiveEpoch(uint256 _amount) external;
}

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

interface ICashier {
    function transferIn(address token, address sender, uint128 amount) external;

    function transferOut(address token, address recipient, uint256 amount) external;

    function getEscrowedTokens(
        address wagerAddress,
        address vaultAddress,
        uint256 amountToken
    )
        external;
}

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

interface IConfigStruct {
    struct AddressConfiguration {
        uint256 bankrollIndex;
        address bankrollTokenAddress;
        address bankrollManagerAddress;
        address eventEmitterAddress;
        address controllerAddress;
        address liquidityShareTokenAddress;
        address bankrollVaultAddress;
        address adminInitial;
    }
}

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

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

interface IMintableBankrollShareToken is IERC20 {
    function __initializeShareToken(
        IConfigStruct.AddressConfiguration memory _initConfig,
        string memory _name,
        string memory _symbol
    )
        external;

    event SetInfo(string name, string symbol);

    event WithdrawStuckToken(address tokenAddress, address receiver, uint256 amount);

    event BankrollManagerSet(address managerOfBankroll);

    function mintLiquidityToken(address _account, uint256 _amount) external;

    function burnLiquidityToken(address _account, uint256 _amount) external;

    function mintLiquidityTokenByVault(address _account, uint256 _amount) external;

    function setInfo(string memory _name, string memory _symbol) external;

    function setTimeOfCooldown(address _address, uint256 _time) external;

    /**
     * @notice function to service users who accidentally send their tokens to this contract
     * @dev since this function could technically steal users assets we added a timelock modifier
     * @param _token address of the token to be recoved
     * @param _account address the recovered tokens will be sent to
     * @param _amount amount of token to be recoverd
     */
    function withdrawStuckToken(address _token, address _account, uint256 _amount) external;

    function returnTimestampOfTransferrability(address _address) external view returns (uint256);

    function isLPTokenAllowedToBeTransferred(address _address) external view returns (bool);
}

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

interface IOperatorMiddleware {
    function share(address bankroll, uint32 epoch, uint128 amount, address token) external;
}

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

interface IRakeCollectorContract {
    struct FeeSplit {
        uint256 ratioProfitForProtocol; // ratio that stays in the pool
        bool isConfigured;
        bool[4] lpTokenPayment; // [0 operators, 1 token holders, 2 front end, 3 pool depositors]
        address[4] recipients; // [0 operators, 1 token holders, 2 front end, 3 pool depositors]
        uint32[4] basisPoints; // [0 operators, 1 token holders, 2 front end, 3 pool depositors]
    }

    function setFeeSplitConfurationToFalse(uint256 _indexBankroll) external;

    function setBankrollFactory(address _bankrollFactory) external;

    function setRatioProfitForProtocol(
        uint256 _indexBankroll,
        uint256 _ratioProfitForProtocol
    )
        external;

    function setOperatorMiddleware(address _operator) external;

    function registerVaultInRakeCollector(
        uint256 _indexBankroll,
        address _shareTokenAddress
    )
        external;

    function setDistributor(address _distributor) external;

    function distributeRewards(uint256 _indexBankroll) external;

    function setFeeSplitForVault(uint256 _indexBankroll, FeeSplit calldata _feeSplit) external;

    function withdrawToken(address _tokenAddress, uint256 _amount) external;

    function returnRatioForProtocolNextEpoch(uint256 _indexBankroll)
        external
        view
        returns (uint256);

    function getLpPrice(address lpToken) external view returns (uint256);

    function setPriceFeed(address _priceFeed) external;

    event OperatorShareCollectedInLpToken(uint256 indexBankroll, bool collectLpToken);

    event BankrollFactorySet(address _bankrollFactory);

    event VaultRegistered(uint256 _indexBankroll, address _tokenAddress, address _vaultAddress);

    event RewardDistributed(
        uint256 bankrollIndex,
        address _recipient,
        uint256 _amount,
        uint256 _amountUSD,
        address _tokenDistributed
    );

    event FeeSplitSet(uint256 _indexBankroll, FeeSplit feeSplit);

    event FeeSplitNotConfigured(uint256 _indexBankroll);

    event TokenWithdrawn(address indexed tokenAddress, uint256 amount);

    event RakeRatioSet(uint256 indexBankroll, uint256 ratioProfitForProtocol);

    event DistributorSet(address _distributor);

    event PriceFeedSet(address _priceFeed);
}

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

interface IVaultAdapter {
    enum TokenType {
        NONE,
        BANKROLL,
        LP
    }

    struct TokenInfo {
        TokenType tokenType;
        address tokenAddress;
        string name;
        string symbol;
        uint8 decimals;
        uint256 totalAmount; // for LP token this is totalSupply, for bankroll token this is balance
            // of the vault
        uint256 priceInUSD;
        uint256 assetRatio; // for LP tokens this is the ratio on how much bankroll tokens it
            // represents (ignoring fees),
            // for bankroll tokens this is the inverse of the ratio (again ignoring fees)
        uint256 totalAmountInUsd; // for LP tokens this is totalSupply * priceInUSD, for bankroll
            // tokens this is balance of the vault * priceInUSD
    }

    struct EpochResultInToken {
        uint256 paidInNoRakeActive;
        uint256 paidInRakedActive;
        uint256 paidOutNoRakeActive;
        uint256 paidOutRakedActive;
        uint256 totalPaidInAllTime;
        uint256 totalPaidOutAllTime;
        uint256 secondsLeftInEpoch;
    }

    struct EpochResultInUSD {
        uint256 totalPaidInNoRakeUSD;
        uint256 totalPaidInRakedUSD;
        uint256 totalPaidOutNoRakeUSD;
        uint256 totalPaidOutRakedUSD;
        uint256 totalPaidInAllTimeUSD;
        uint256 totalPaidOutAllTimeUSD;
        uint256 secondsLeftInEpoch;
    }

    struct VaultDetails {
        uint256 vaultIndex;
        address bankrollBytesIdentifier;
        address vaultAddress;
        address bankrollTokenAddress;
        address shareTokenAddress;
        address controllerAddress;
        address liquidityManagerAddress;
    }

    struct VaultAmounts {
        uint256 bankrollAmount; // total amount of bankroll tokens in the vault
        uint256 shareTokenAmount; // total amount of share tokens issued by the vault
        uint256 epochAmount; // total amount of epochs in the vault
        uint256 totalAmount;
        uint256 totalAmountExcluding;
        uint64 bankrollTokenPrice; // the price of the bankroll token in USD
        bool isProfitEpcoh; // bool indicating if the current epoch is in profit
        bool isProfitTotal; // bool indicating if the vault is in all time profit
        bool isProfitTotalExcluding; // bool indicating if the vault is in all time profit excluding
            // the current epoch
    }

    struct PaginatedAllData {
        VaultDetails[] vaultDetails;
        VaultAmounts[] vaultAmounts;
        uint256 lastReturnedIndex;
    }

    struct PaginatedUserBalance {
        address[] bankrollIdentifier;
        uint256[] userBalance;
        uint256[] userBalanceInUsd;
        uint256 lastReturnedIndex;
    }

    function registerBankrollDeployment(
        uint256 _bankrollIndex,
        address _vault,
        address _bankrollToken,
        address _shareToken,
        address _controller,
        address _liquidityManager
    )
        external;

    function getVaultAmountsByIndex(uint256 vaultIndex)
        external
        view
        returns (VaultAmounts memory);

    function getVaultDetailsByIndex(uint256 vaultIndex)
        external
        view
        returns (VaultDetails memory);

    function getAllBankrollTokens() external view returns (address[] memory);

    function getLatestPrice(address _bankrollToken) external view returns (uint64, uint8);

    function updatePriceFeed(address _priceFeed) external;

    function getAllWhitelistedTokens() external view returns (address[] memory);

    function returnVaultDetailsAddress(address _bankrollBytesIdentifier)
        external
        view
        returns (VaultDetails memory);

    function getAllData()
        external
        view
        returns (VaultDetails[] memory vaultDetails_, VaultAmounts[] memory vaultAmounts_);

    function getAllLpTokens() external view returns (address[] memory);

    function getLpTokenAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (address lpTokenAddress_);

    function getVaultDetailsByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (VaultDetails memory);

    function getBankrollAsset(address _bankrollIdentifierAddress)
        external
        view
        returns (address bankrollTokenAddress_);

    function getVaultAmountsByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (VaultAmounts memory vaultAmounts_);

    function getLpPrice(uint256 _bankrollIndex) external view returns (uint256);

    function returnLpTokenPriceInUsdByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (uint256);

    function returnBankrollTokenInfoOfVaultByIndex(uint256 _bankrollIndex)
        external
        view
        returns (TokenInfo memory tokenInfo_);

    function returnBankrollTokenInfoByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (TokenInfo memory tokenInfo_);

    function returnLPTokenInfoOfVaultByIndex(uint256 _bankrollIndex)
        external
        view
        returns (TokenInfo memory tokenInfo_);

    function returnLPTokenInfoByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (TokenInfo memory tokenInfo_);

    function getEpochUSDStats(uint256 _bankrollIndex)
        external
        view
        returns (EpochResultInUSD memory epochResult_);

    function returnEpochResultInUsdByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (EpochResultInUSD memory epochResult_);

    function returnEpochResultInActiveEpochByIndex(uint256 _bankrollIndex)
        external
        view
        returns (EpochResultInToken memory epochResult_);

    function returnVaultInfoAllByIndex(uint256 _bankrollIndex)
        external
        view
        returns (
            TokenInfo memory bankrollAssetInfo_,
            TokenInfo memory lpAssetInfo_,
            EpochResultInToken memory epochResultInToken_,
            EpochResultInUSD memory epochResultInUsd_
        );

    function returnVaultInfoAllByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (
            TokenInfo memory bankrollAssetInfo_,
            TokenInfo memory lpAssetInfo_,
            EpochResultInToken memory epochResultInToken_,
            EpochResultInUSD memory epochResultInUsd_
        );

    function returnEpochResultInActiveEpochByAddress(address _bankrollIdentifierAddress)
        external
        view
        returns (EpochResultInToken memory epochResult_);

    function getBankrollOwner(address bankroll) external view returns (address);

    function payout(
        address bankroll,
        uint256 escrow,
        uint256 totalAmount,
        address cashier,
        address receipient
    )
        external;

    function payoutNoEscrow(address bankroll, uint256 totalAmount, address receipient) external;

    // Events

    event FactorySet(address indexed factory, bool isFactory);

    event CashierSet(address indexed cashier, bool isCashier);

    event PriceFeedUpdated(address indexed priceFeed);

    event VaultSet(
        uint256 indexed vaultIndex,
        address indexed bankrollBytesIdentifier,
        address indexed bankrollToken,
        address vault,
        address shareToken,
        address controller,
        address liquidityManager
    );
}

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

import "./IBankrollFactory.sol";
import "./IConfigStruct.sol";

interface IVaultEventEmitter {
    function emitAdminOfBankrollChanged(address _newAdmin) external;

    function emitLiquidityManagerChanged(address _newManager, bool _isRegistered) external;

    function emitCooldownDurationSet(uint256 cooldownDuration) external;

    function emitPayinToVault(address _token, uint256 _amount) external;

    function emitPayoutFromVault(
        address _token,
        uint256 _amount,
        address _recipient,
        uint256 _escrowAccount,
        bool _noRake
    )
        external;

    function emitVaultDirectPoolDeposit(address _token, uint256 _amount, bool _noRake) external;

    function emitAddLiquidityFeeBasis(uint256 _feeBasisPoints) external;

    function emitRemoveLiquidityFeeSet(uint256 _feeBasisPoints) external;

    function emitEpochFinalized(
        uint256 _epochId,
        address _token,
        uint256 _totalPaidIn,
        uint256 _totalPaidOut,
        uint256 _nextEpochStart,
        uint256 _profitToRake,
        uint256 _netProfitOrLoss,
        uint256 _profitOrLossForWLPS
    )
        external;

    function emitVaultDeployed(IConfigStruct.AddressConfiguration memory _initConfig) external;

    function emitAddLiquidityToVault(
        address _token,
        uint256 _amount,
        uint256 _addLiquidityFee,
        address _fundingAccount,
        uint256 _amountWLPToMint
    )
        external;

    function emitRemoveLiquidityFromVault(
        address _token,
        uint256 _lpTokenAmount,
        uint256 _amountOut,
        uint256 _removeLiquidityFee,
        address _account
    )
        external;

    function emitInPrivateModeSet(bool _isPrivate) external;

    function emitPayoutsHaltedByVaultAdmin(bool _isHalted) external;

    function emitWhitelistedWLPAddressSet(address _address, bool _isWhitelisted) external;

    function emitTotalRakeRewardDistributed(
        uint256 _indexBankroll,
        address _token,
        uint256 _amount
    )
        external;

    function emitRakeRewardDistributed(
        uint256 _indexBankroll,
        address _recipient,
        uint256 _amount,
        uint256 _amountUSD,
        address _tokenDistributed
    )
        external;

    function emitVaultDefaulted(
        address _bankrollToken,
        uint256 _totalPayoutAmount,
        address _recipient,
        uint256 _shortFall
    )
        external;

    function emitVaultAdapterRegistered(address _address, bool _isRegistered) external;

    function emitRatioProfitForProtocolSet(uint256 _ratio) external;

    function emitProtocolHaltOfDeploymentSet(uint256 _vaultId, bool _halt) external;

    function emitPayoutsHaltedByProtocol(bool _isHalted) external;

    function emitEpochDurationSet(uint256 _epochDuration) external;

    function emitMaxAssetAmountSet(uint256 _maxAssetAmount) external;

    function emitWLPMintedForRake(
        address _rakeCollector,
        uint256 _tokenAmountToDistribute,
        uint256 _amountWLPToMint
    )
        external;

    function emitAddingLPOpenChanged(bool _setting) external;

    function emitLpBalanceChanged(address user, uint256 currentBalance) external;

    event NewLiquidityManagerDeployed(uint256 indexBankroll, address manager);

    event PayinToVault(uint256 indexed vaultId, address indexed token, uint256 amount);

    event PayoutFromVault(
        uint256 indexed vaultId,
        address indexed token,
        uint256 payOutAmount,
        address recipient,
        uint256 escrowAccount,
        bool noRake
    );

    event VaultDirectPoolDeposit(
        uint256 indexed vaultId, address indexed token, uint256 amount, bool _noRake
    );

    event AddLiquidityBasisPointsSet(uint256 indexed vaultId, uint256 feeBasisPoints);

    event RemoveLiquidityFeeSet(uint256 indexed vaultId, uint256 feeBasisPoints);

    event EpochFinalized(
        uint256 indexed vaultId,
        address indexed token,
        uint256 epochId,
        uint256 totalPaidIn,
        uint256 totalPaidOut,
        uint256 currentEpochEnd,
        uint256 profitToRake,
        uint256 netProfitOrLoss,
        uint256 profitOrLossForWLPS
    );

    event AddLiquidityToVault(
        uint256 indexed vaultId,
        address indexed token,
        uint256 amount,
        uint256 addLiquidityFee,
        address fundingAccount,
        uint256 amountWLPToMint
    );

    event RakeRewardDistributed(
        uint256 vaultIndex, address recipient, uint256 amount, uint256 amountUSD, address token
    );

    event TotalRakeRewardDistributed(uint256 vaultIndex, address token, uint256 amount);

    event WhitelistedWLPAddressSet(uint256 vaultId, address _address, bool isWhitelisted);

    event InPrivateModeSet(uint256 vaultId, bool isPrivate);

    event RegisteredContractSet(address _contract, bool isRegistered);

    event VaultConfigured(
        address indexed vaultAddress, address indexed managerOfBankroll, uint256 vaultId
    );

    event VaultDeployed(IConfigStruct.AddressConfiguration _initConfig);

    event RemoveLiquidityFromVault(
        uint256 indexed vaultId,
        address indexed token,
        uint256 wlpAmount,
        uint256 amountOut,
        uint256 burnFee,
        address account
    );

    event CooldownDurationSet(uint256 indexed vaultId, uint256 indexed cooldownDuration);

    event LiquidityManagerChanged(
        uint256 indexed vaultId, address indexed newManager, bool indexed isRegistered
    );

    event AdminOfBankrollChanged(uint256 indexed vaultId, address indexed newAdmin);

    event VaultDefaulted(
        uint256 vaultId,
        address bankrollToken,
        uint256 totalPayoutAmount,
        address recipient,
        uint256 shortFall
    );

    event CashierRegistered(uint256 vaultId, address indexed cashier, bool isRegistered);

    event RatioProfitForProtocolSet(uint256 indexed vaultId, uint256 ratio);

    event PayoutsHaltedByVaultAdmin(uint256 indexed vaultId, bool isHalted);

    event EpochDurationSet(uint256 indexed indexBankroll, uint256 epochDuration);

    event PayoutsHaltedByProtocol(uint256 indexed indexBankroll, bool halted);

    event ProtocolHaltOfDeploymentSet(uint256 indexed indexBankroll, bool halt);

    event MaxAssetAmountSet(uint256 vaultIndex, uint256 maxAssetAmount);

    event WLPMintedForRake(
        uint256 vaultIndex,
        address indexed rakeCollector,
        uint256 tokenAmountToDistribute,
        uint256 amountWLPToMint
    );

    event AddingLPOpenChanged(uint256 indexed _vaultId, bool _setting);

    event LpBalanceChanged(
        uint256 indexed _vaultId, address indexed shareToken, address indexed user, uint256 balance, uint256 timestamp
    );
}

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

interface IWhitelistPaymaster {
  function setWhitelistContract(address target, bool isAllowed) external;

  function setWhitelistContractBatch(address[] memory targets, bool isAllowed) external;
}

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

interface AggregatorV3Interface {
    function decimals() external view returns (uint8);

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

    function version() external view returns (uint256);

    function getRoundData(uint80 _roundId)
        external
        view
        returns (
            uint80 roundId,
            int256 answer,
            uint256 startedAt,
            uint256 updatedAt,
            uint80 answeredInRound
        );

    function latestRoundData()
        external
        view
        returns (
            uint80 roundId,
            int256 answer,
            uint256 startedAt,
            uint256 updatedAt,
            uint80 answeredInRound
        );
}

// SPDX-License-Identifier: BUSL-1.1

pragma solidity ^0.8.23;

import { AggregatorV3Interface } from "./AggregatorV3Interface.sol";
import { Price } from "./Price.sol";

interface IPriceFeed {
    function setToken(address token, AggregatorV3Interface aggregator) external;
    function getPrice(address token) external view returns (Price.Props memory);
}

// SPDX-License-Identifier: BUSL-1.1

pragma solidity ^0.8.23;

import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";

/**
 * @title Price
 * @dev Helper for price data
 */
library Price {
    using Price for Props;
    using SafeCast for uint256;

    struct Props {
        uint8 decimals;
        uint8 tokenDecimals;
        uint64 value;
    }

    function create(
        uint8 decimals,
        uint8 tokenDecimals,
        uint64 value
    )
        internal
        pure
        returns (Props memory)
    {
        Props memory props;

        props.setDecimals(decimals);
        props.setTokenDecimals(tokenDecimals);
        props.setValue(value);

        return props;
    }

    /**
     * @dev Returns decimals of the token dollar value
     *
     * @return decimals Token decimals
     */
    function getDecimals(Props memory props) internal pure returns (uint8) {
        return props.decimals;
    }

    /**
     * @dev Sets decimals of the token dollar value
     *
     * @param decimals Token decimals
     */
    function setDecimals(Props memory props, uint8 decimals) internal pure {
        props.decimals = decimals;
    }

    /**
     * @dev Returns decimals of token
     *
     * @return tokenDecimals Token decimals
     */
    function getTokenDecimals(Props memory props) internal pure returns (uint8) {
        return props.tokenDecimals;
    }

    /**
     * @dev Sets decimals of the token
     *
     * @param tokenDecimals Token decimals
     */
    function setTokenDecimals(Props memory props, uint8 tokenDecimals) internal pure {
        props.tokenDecimals = tokenDecimals;
    }

    /**
     * @dev Returns price value
     *
     * @return value Token price
     */
    function getValue(Props memory props) internal pure returns (uint256) {
        return props.value;
    }

    /**
     * @dev Sets value of the token
     *
     * @param value Token's dollar value
     */
    function setValue(Props memory props, uint64 value) internal pure {
        props.value = value;
    }

    /**
     * @dev Converts amount to dollar price
     *
     * @param amount The amount to convert
     * @return price Dollar value
     */
    function convert(Props memory props, uint128 amount) internal pure returns (uint80) {
        uint8 power = props.getTokenDecimals();

        if (props.getDecimals() > 8) {
            power += props.getDecimals() - 8;
        } else if (props.getDecimals() < 8) {
            power -= 8 - props.getDecimals();
        }

        return ((amount * props.getValue()) / (10 ** power)).toUint80();
    }
}

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

import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
import "./interfaces/IMintableBankrollShareToken.sol";
import "./AccessControlBase.sol";

/**
 * @title MintableBankrollShareToken
 * @author balding-ghost
 * @notice This contract is the share token for the bankroll vault
 */
contract MintableBankrollShareToken is
    IMintableBankrollShareToken,
    ERC20Upgradeable,
    AccessControlBase
{
    bool internal nameReset;

    // cooldown duration for when liquidity was added last
    mapping(address => uint256) public ownerCanTransferAfter;

    constructor() {
        _disableInitializers();
    }

    function __initializeShareToken(
        IConfigStruct.AddressConfiguration memory _config,
        string memory _name,
        string memory _symbol
    )
        external
        initializer
    {
        __ERC20_init(_name, _symbol);
        __AccessControlBase_init(_config);
        liquidityShareToken = IMintableBankrollShareToken(address(this));
        vaultV2 = IBankrollVault(_config.bankrollVaultAddress);
    }

    // Internal function

    function _isTransferAllowed(address _address) internal view {
        require(
            ownerCanTransferAfter[_address] < block.timestamp,
            "MintableBankrollShareToken: transfer not allowed"
        );
    }

    function _update(address from, address to, uint256 value) internal override(ERC20Upgradeable) {
        if (from != address(0)) {
            _isTransferAllowed(from);
        }
        super._update(from, to, value);
        eventEmitter.emitLpBalanceChanged(from, balanceOf(from));
        eventEmitter.emitLpBalanceChanged(to, balanceOf(to));
    }

    // Operational functions

    function mintLiquidityToken(
        address _account,
        uint256 _amount
    )
        external
        override
        onlyBankrollManager
    {
        super._mint(_account, _amount);
        eventEmitter.emitLpBalanceChanged(_account, balanceOf(_account));
    }

    function mintLiquidityTokenByVault(
        address _account,
        uint256 _amount
    )
        external
        override
        onlyVaultBankroll
    {
        super._mint(_account, _amount);
        eventEmitter.emitLpBalanceChanged(_account, balanceOf(_account));
    }

    function burnLiquidityToken(
        address _account,
        uint256 _amount
    )
        external
        override
        onlyBankrollManager
    {
        super._burn(_account, _amount);
        eventEmitter.emitLpBalanceChanged(_account, balanceOf(_account));
    }

    /**
     * @notice Set the timestamp of transferrability for an address
     * @param _address The address of the LP token
     * @param _time The timestamp of transferrability
     */
    function setTimeOfCooldown(
        address _address,
        uint256 _time
    )
        external
        override
        onlyBankrollManager
    {
        ownerCanTransferAfter[_address] = _time;
    }

    // View funciton

    /**
     * @notice Return the timestamp of transferrability for an address
     * @param _address The address of the LP token
     * @return uint256 The timestamp of transferrability
     */
    function returnTimestampOfTransferrability(address _address)
        external
        view
        override
        returns (uint256)
    {
        return ownerCanTransferAfter[_address];
    }

    /**
     * @notice Check if an LP token is allowed to be transferred
     * @param _address The address of the LP token
     * @return bool Whether the LP token is allowed to be transferred
     */
    function isLPTokenAllowedToBeTransferred(address _address)
        external
        view
        override
        returns (bool)
    {
        return ownerCanTransferAfter[_address] < block.timestamp;
    }

    // Admin functions

    /**
     * @notice Withdraw stuck token
     * @param _token The address of the token
     * @param _account The address of the recipient
     * @param _amount The amount of the token to withdraw
     */
    function withdrawStuckToken(
        address _token,
        address _account,
        uint256 _amount
    )
        external
        override
        onlyVaultAdmin
    {
        IERC20(_token).transfer(_account, _amount);
        emit WithdrawStuckToken(_token, _account, _amount);
    }

    bytes32 private constant ERC20StorageLocation =
        0x52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace00;

    function _getERC20StorageCopy() private pure returns (ERC20Storage storage $) {
        assembly {
            $.slot := ERC20StorageLocation
        }
    }

    function setInfo(string memory name_, string memory symbol_) external override onlyVaultAdmin {
        require(!nameReset, "MintableBankrollShareToken: name and symbol already set");
        nameReset = true;
        ERC20Storage storage $ = _getERC20StorageCopy();
        $._name = name_;
        $._symbol = symbol_;
        emit SetInfo(name_, symbol_);
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.5 <0.9.0;

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/access/Ownable.sol";

contract ERC20Ownable is ERC20, Ownable {
    /*==================================================== EVENTS
    ===========================================================*/

    event Mint(address to, uint256 amount);
    event Burn(address to, uint256 amount);

    uint8 public tokenDecimals;

    constructor(
        string memory name,
        string memory symbol,
        uint256 initialSupply,
        uint8 _decimals
    )
        ERC20(name, symbol)
        Ownable(msg.sender)
    {
        _mint(msg.sender, initialSupply);
        tokenDecimals = _decimals;
    }

    function decimals() public view override returns (uint8) {
        return tokenDecimals;
    }

    function mint(address account, uint256 _amount) public onlyOwner {
        _mint(account, _amount);
    }

    function burn(address account, uint256 _amount) public onlyOwner {
        _burn(account, _amount);
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.5 <0.9.0;

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { console } from "forge-std/src/console.sol";

contract MockERC20Decimal is ERC20 {
    /*==================================================== EVENTS
    ===========================================================*/

    event Mint(address to, uint256 amount);
    event Burn(address to, uint256 amount);

    uint8 public tokenDecimals;

    constructor(
        string memory name,
        string memory symbol,
        uint256 initialSupply,
        uint8 _decimals
    )
        ERC20(name, symbol)
    {
        _mint(msg.sender, initialSupply);
        tokenDecimals = _decimals;
    }

    function decimals() public view override returns (uint8) {
        return tokenDecimals;
    }

    function mint(address account, uint256 _amount) public payable {
        console.log("msg.value has received: ", msg.value);
        _mint(account, _amount);
    }

    function burn(address account, uint256 _amount) public {
        _burn(account, _amount);
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.8.5 <0.9.0;

contract MockLiquidityManager {
    function getRatioLPToken() external pure returns (uint256) {
        return 1e18;
    }
}

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

import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import { IRakeCollectorContract } from "./interfaces/IRakeCollectorContract.sol";
import "./interfaces/IBankrollFactory.sol";
import "./interfaces/IVaultEventEmitter.sol";
import "./interfaces/IOperatorMiddleware.sol";
import "./interfaces/IBankrollLiquidityManager.sol";
import "./winr-lock/interfaces/IWINRLock.sol";
import "./interfaces/price-feed/IPriceFeed.sol";

/**
 * @title RakeCollectionContract
 * @author balding-ghost
 * @notice This contract is responsible for collecting rake from the vaults and distributing it
 * according to the fee split
 */
contract RakeCollectionContract is IRakeCollectorContract, Ownable {
  uint32 public constant BASIS_POINTS_DIVISOR = 1e4;

  using SafeERC20 for IERC20;

  IBankrollFactory public bankrollFactory;

  IVaultEventEmitter public eventEmitter;

  IOperatorMiddleware public operatorMiddleware;

  IPriceFeed public priceFeed;

  mapping(uint256 => address) public indexToLpAddress;

  mapping(address => uint256) public vaultToIndexBankroll;

  mapping(uint256 => FeeSplit) internal feeSplits;

  mapping(address => bool) public distributorMapping;

  constructor(address _eventEmitter, address owner) Ownable(owner) {
    eventEmitter = IVaultEventEmitter(_eventEmitter);
    distributorMapping[msg.sender] = true;
  }

  // Modifiers

  modifier onlyFactory() {
    require(
      _msgSender() == address(bankrollFactory),
      "RakeCollectionContract: caller is not the factory"
    );
    _;
  }

  modifier onlyDistributor() {
    require(
      distributorMapping[_msgSender()],
      "RakeCollectionContract: caller is not a distributor"
    );
    _;
  }

  // Operational functions

  function distributeRewardsManual(uint256 _indexBankroll) external onlyDistributor {
    _distributeRewards(_indexBankroll);
  }

  function distributeRewards(uint256 _indexBankroll) external override onlyFactory {
    _distributeRewards(_indexBankroll);
  }

  // Internal functions

  function _redeemLpTokens(
    address _lpTokenAddress,
    uint256 _amountLpTokens
  ) internal returns (uint256 assetAmountOut_, address tokenDistributed_) {
    (address bankrollLiquidityManager_, address bankrollToken_) = bankrollFactory
      .returnRakeLiquidityManagerBankrollToken(_lpTokenAddress);

    assetAmountOut_ = IBankrollLiquidityManager(bankrollLiquidityManager_).removeLiquidity(
      bankrollToken_,
      _amountLpTokens,
      0
    );

    // tokens now sit in this contract

    return (assetAmountOut_, bankrollToken_);
  }

  function _distributeTokensTo(
    address _recipient,
    address _lpTokenAddress,
    uint256 _amountLpTokens,
    bool _isCollectedInLpToken
  ) internal returns (uint256 tokenAmountTransferred_, address tokenDistributed_) {
    if (_isCollectedInLpToken) {
      IERC20(_lpTokenAddress).safeTransfer(_recipient, _amountLpTokens);
      return (_amountLpTokens, _lpTokenAddress);
    } else {
      (tokenAmountTransferred_, tokenDistributed_) = _redeemLpTokens(
        _lpTokenAddress,
        _amountLpTokens
      );
      // transfer the tokens to the recipient
      IERC20(tokenDistributed_).safeTransfer(_recipient, tokenAmountTransferred_);
      return (tokenAmountTransferred_, tokenDistributed_);
    }
  }

  function indexToAddress(uint256 index) internal pure returns (address) {
    require(index > 0 && index <= type(uint160).max, "Index out of bounds");
    return address(uint160(index));
  }

  function _distributeTokensToStakers(
    address _recipient,
    address _lpTokenAddress,
    uint256 _amountLpTokens,
    bool _isCollectedInLpToken
  ) internal returns (uint256 tokenAmountTransferred_, address tokenDistributed_) {
    if (_isCollectedInLpToken) {
      IERC20(_lpTokenAddress).safeTransfer(_recipient, _amountLpTokens);
      IWINRLock(_recipient).shareRewards(_lpTokenAddress, _amountLpTokens);
      return (_amountLpTokens, _lpTokenAddress);
    } else {
      (tokenAmountTransferred_, tokenDistributed_) = _redeemLpTokens(
        _lpTokenAddress,
        _amountLpTokens
      );
      // transfer the tokens to the recipient
      IERC20(tokenDistributed_).safeTransfer(_recipient, tokenAmountTransferred_);
      IWINRLock(_recipient).shareRewards(tokenDistributed_, tokenAmountTransferred_);
      return (tokenAmountTransferred_, tokenDistributed_);
    }
  }

  function _distributeToOperatorMiddleware(
    uint256 _bankrollIndex,
    address _lpTokenAddress,
    uint256 _amountLpTokens,
    bool _isCollectedInLpToken
  ) internal returns (uint256 tokenAmountTransferred_, address tokenDistributed_) {
    address bankrollAddressIndentifier_ = indexToAddress(_bankrollIndex);
    (uint32 epochCounter_, ) = bankrollFactory.returnEpochInformation(_bankrollIndex);

    if (_isCollectedInLpToken) {
      IERC20(_lpTokenAddress).approve(address(operatorMiddleware), _amountLpTokens);
      operatorMiddleware.share(
        bankrollAddressIndentifier_,
        epochCounter_,
        uint128(_amountLpTokens),
        _lpTokenAddress
      );
      return (_amountLpTokens, _lpTokenAddress);
    } else {
      (tokenAmountTransferred_, tokenDistributed_) = _redeemLpTokens(
        _lpTokenAddress,
        _amountLpTokens
      );
      IERC20(tokenDistributed_).approve(address(operatorMiddleware), tokenAmountTransferred_);
      operatorMiddleware.share(
        bankrollAddressIndentifier_,
        epochCounter_,
        uint128(tokenAmountTransferred_),
        tokenDistributed_
      );
      return (tokenAmountTransferred_, tokenDistributed_);
    }
  }

  function _distributeRewards(uint256 _indexBankroll) internal {
    address shareTokenAddress_ = indexToLpAddress[_indexBankroll];
    require(shareTokenAddress_ != address(0), "RakeCollectionContract: vault does not exist");

    // fetch the amount of lp tokens that is earned
    uint256 balanceOf_ = IERC20(shareTokenAddress_).balanceOf(address(this));

    eventEmitter.emitTotalRakeRewardDistributed(_indexBankroll, shareTokenAddress_, balanceOf_);

    FeeSplit memory feeSplit_ = feeSplits[_indexBankroll];

    // if the fee split is empty, then return early
    if (!feeSplit_.isConfigured) {
      emit FeeSplitNotConfigured(_indexBankroll);
      return;
    }

    for (uint256 i = 0; i < 4; i++) {
      if (balanceOf_ == 0) {
        emit RewardDistributed(_indexBankroll, feeSplit_.recipients[i], 0, 0, shareTokenAddress_);
        eventEmitter.emitRakeRewardDistributed(
          _indexBankroll,
          feeSplit_.recipients[i],
          0,
          0,
          shareTokenAddress_
        );
        continue;
      }

      uint256 amountLpTokens_ = (balanceOf_ * feeSplit_.basisPoints[i]) / BASIS_POINTS_DIVISOR;

      uint256 amountTokensDistributed_;
      address tokenDistributed_;

      if (i == 0) {
        // call special function to call share with operator and call the function
        (amountTokensDistributed_, tokenDistributed_) = _distributeToOperatorMiddleware(
          _indexBankroll,
          shareTokenAddress_,
          amountLpTokens_,
          feeSplit_.lpTokenPayment[0]
        );
      } else if (i == 1) {
        _distributeTokensToStakers(
          feeSplit_.recipients[1],
          shareTokenAddress_,
          amountLpTokens_,
          feeSplit_.lpTokenPayment[1]
        );
      } else {
        (amountTokensDistributed_, tokenDistributed_) = _distributeTokensTo(
          feeSplit_.recipients[i],
          shareTokenAddress_,
          amountLpTokens_,
          feeSplit_.lpTokenPayment[i]
        );
      }

      uint256 distributedUSDValue_ = (getLpPrice(shareTokenAddress_) * amountTokensDistributed_) /
        1e18;

      eventEmitter.emitRakeRewardDistributed(
        _indexBankroll,
        feeSplit_.recipients[i],
        amountTokensDistributed_,
        distributedUSDValue_,
        tokenDistributed_
      );

      emit RewardDistributed(
        _indexBankroll,
        feeSplit_.recipients[i],
        amountTokensDistributed_,
        distributedUSDValue_,
        tokenDistributed_
      );
    }
  }

  function getLpPrice(address lpToken) public view override returns (uint256) {
    (address bankrollLiquidityManager_, address bankrollToken_) = bankrollFactory
      .returnRakeLiquidityManagerBankrollToken(lpToken);

    IBankrollLiquidityManager _liquidityManager = IBankrollLiquidityManager(
      bankrollLiquidityManager_
    );

    (uint64 latestPrice_, uint8 priceFeedDecimals) = getLatestPrice(bankrollToken_);
    uint256 ratioLPToken_ = _liquidityManager.getRatioLPToken();

    uint256 bankrollTokenPriceInLpToken_ = (latestPrice_ * ratioLPToken_) / 10 ** priceFeedDecimals;
    return bankrollTokenPriceInLpToken_;
  }

  function getLatestPrice(address _bankrollToken) public view returns (uint64, uint8) {
    Price.Props memory price = priceFeed.getPrice(_bankrollToken);
    return (price.value, price.decimals);
  }

  function _checkIfBasisPointSumTo(uint32[4] memory _basisPoints) internal pure {
    uint256 sum = 0;
    for (uint256 i = 0; i < _basisPoints.length; i++) {
      sum += _basisPoints[i];
    }
    require(
      sum == BASIS_POINTS_DIVISOR,
      "RakeCollectionContract: basis points do not sum to BASIS_POINTS_DIVISOR"
    );
  }

  // Configuration functions

  function setEventEmitter(address _eventEmitter) external onlyOwner {
    eventEmitter = IVaultEventEmitter(_eventEmitter);
  }

  function setBankrollFactory(address _bankrollFactory) external override onlyOwner {
    bankrollFactory = IBankrollFactory(_bankrollFactory);
    emit BankrollFactorySet(_bankrollFactory);
  }

  function setDistributor(address _distributor) external override onlyOwner {
    distributorMapping[_distributor] = true;
    emit DistributorSet(_distributor);
  }

  function registerVaultInRakeCollector(
    uint256 _indexBankroll,
    address _shareTokenAddress
  ) external override onlyFactory {
    indexToLpAddress[_indexBankroll] = _shareTokenAddress;
    vaultToIndexBankroll[_shareTokenAddress] = _indexBankroll;
    emit VaultRegistered(_indexBankroll, _shareTokenAddress, _shareTokenAddress);
  }

  function setRatioProfitForProtocol(
    uint256 _indexBankroll,
    uint256 _ratioProfitForProtocol
  ) external override onlyOwner {
    require(
      _ratioProfitForProtocol != 0,
      "RakeCollectionContract: ratio profit for protocol is zero"
    );
    require(
      _ratioProfitForProtocol <= BASIS_POINTS_DIVISOR,
      "RakeCollectionContract: ratio profit for protocol is greater than BASIS_POINTS_DIVISOR"
    );
    // check if indexBankroll is registered
    require(
      indexToLpAddress[_indexBankroll] != address(0),
      "RakeCollectionContract: vault does not exist"
    );

    feeSplits[_indexBankroll].ratioProfitForProtocol = _ratioProfitForProtocol;

    emit RakeRatioSet(_indexBankroll, _ratioProfitForProtocol);
  }

  function setFeeSplitForVault(
    uint256 _indexBankroll,
    FeeSplit memory _feeSplit
  ) external override onlyOwner {
    require(
      _feeSplit.ratioProfitForProtocol <= BASIS_POINTS_DIVISOR,
      "RakeCollectionContract: ratio profit for protocol is greater than BASIS_POINTS_DIVISOR"
    );
    require(
      _feeSplit.basisPoints.length == _feeSplit.recipients.length,
      "RakeCollectionContract: recipients basisPoints must have same length"
    );
    require(
      _feeSplit.ratioProfitForProtocol != 0,
      "RakeCollectionContract: ratio profit for protocol is zero"
    );
    // check if basis points sum to BASIS_POINTS_DIVISOR
    _checkIfBasisPointSumTo(_feeSplit.basisPoints);
    feeSplits[_indexBankroll].isConfigured = true;
    feeSplits[_indexBankroll] = _feeSplit;
    emit FeeSplitSet(_indexBankroll, _feeSplit);
  }

  function setFeeSplitConfurationToFalse(uint256 _indexBankroll) external override onlyOwner {
    feeSplits[_indexBankroll].isConfigured = false;
    emit FeeSplitSet(_indexBankroll, feeSplits[_indexBankroll]);
  }

  function withdrawToken(address _tokenAddress, uint256 _amount) external override onlyOwner {
    IERC20(_tokenAddress).safeTransfer(_msgSender(), _amount);
    emit TokenWithdrawn(_tokenAddress, _amount);
  }

  function setOperatorMiddleware(address _operator) external override onlyOwner {
    operatorMiddleware = IOperatorMiddleware(_operator);
    emit OperatorConfigured(_operator);
  }

  function setPriceFeed(address _priceFeed) external override onlyOwner {
    priceFeed = IPriceFeed(_priceFeed);
    emit PriceFeedSet(_priceFeed);
  }

  event OperatorConfigured(address operatorAddress);

  // View functions

  function returnFeeSplitWithIndex(
    uint256 _indexBankroll
  ) external view returns (FeeSplit memory feeSplit_) {
    return feeSplits[_indexBankroll];
  }

  function returnRatioForProtocolNextEpoch(
    uint256 _indexBankroll
  ) external view returns (uint256 ratioProfitForProtocol_) {
    require(_indexBankroll != 0, "RakeCollectionContract: indexBankroll is zero");
    ratioProfitForProtocol_ = feeSplits[_indexBankroll].ratioProfitForProtocol;
    return ratioProfitForProtocol_;
  }
}

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

import "./interfaces/IVaultAdapter.sol";
import "./interfaces/IBankrollVault.sol";
import "./interfaces/IBankrollController.sol";
import "./interfaces/IBankrollFactory.sol";
import "./interfaces/IBankrollLiquidityManager.sol";
import "./interfaces/price-feed/IPriceFeed.sol";
import "./interfaces/IRakeCollectorContract.sol";
import "./interfaces/ICashier.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";

/**
 * @title VaultAdapter
 * @author balding-ghost
 * @notice This contract sits in the middle between Cashier and the bankrolls, it manages what
 * vaults are being used for a given bankroll token and what operator is managing the payouts
 * for a given bankroll token.
 */
contract VaultAdapter is IVaultAdapter, Ownable {
  using EnumerableSet for EnumerableSet.AddressSet;

  // storage of all bankroll tokens and lp tokens
  EnumerableSet.AddressSet private bankrollTokens;
  EnumerableSet.AddressSet private lpTokens;

  // bankrollIndex => vaultDetails
  mapping(uint256 => VaultDetails) public vaults;

  mapping(address => uint256) public bankrollBytesIdentifierToVaultIndex;

  mapping(address => address) public bankrollBytesIdentifierToVaulAddress;

  mapping(address => address) public bankrollBytesIdentifierToWagerAsset;

  // vaultIndex => vaultAddress
  mapping(uint256 => address) public indexToVault;

  mapping(address => bool) public cashierMapping;

  mapping(address => bool) public factoryMapping;

  // latest vault index registered
  uint256 public vaultIndexLatest;

  IPriceFeed public priceFeed;

  // address public factory;

  constructor(address _factory, address owner) Ownable(owner) {
    factoryMapping[_factory] = true;
  }

  // Modifiers

  modifier onlyCashier() {
    require(cashierMapping[_msgSender()], "VaultAdapter: caller is not a cashier");
    _;
  }

  modifier onlyFactory() {
    require(factoryMapping[_msgSender()], "VaultAdapter: caller is not the factory");
    _;
  }

  /**
   * @notice Set the _vault details for a bankroll token.
   * @dev this function is only callable by the factory contract when a new bankroll protocol is
   * deployed
   * @param _bankrollIndex The index of the vault.
   * @param _vault The address of the _vault.
   * @param _bankrollToken The address of the bankroll token.
   * @param _shareToken The address of the share token.
   * @param _controller The address of the _controller.
   * @param _liquidityManager The address of the liquidity manager.
   */
  function registerBankrollDeployment(
    uint256 _bankrollIndex,
    address _vault,
    address _bankrollToken,
    address _shareToken,
    address _controller,
    address _liquidityManager
  ) external override onlyFactory {
    address bankrollBytesIdentifier_ = indexToAddress(_bankrollIndex);

    VaultDetails memory vaultDetails_ = VaultDetails({
      vaultIndex: _bankrollIndex,
      bankrollBytesIdentifier: bankrollBytesIdentifier_,
      vaultAddress: _vault,
      bankrollTokenAddress: _bankrollToken,
      shareTokenAddress: _shareToken,
      controllerAddress: _controller,
      liquidityManagerAddress: _liquidityManager
    });

    vaults[_bankrollIndex] = vaultDetails_;

    bankrollBytesIdentifierToVaultIndex[bankrollBytesIdentifier_] = _bankrollIndex;

    bankrollBytesIdentifierToVaulAddress[bankrollBytesIdentifier_] = _vault;

    bankrollBytesIdentifierToWagerAsset[bankrollBytesIdentifier_] = _bankrollToken;

    indexToVault[_bankrollIndex] = _vault;

    bankrollTokens.add(_bankrollToken);
    lpTokens.add(_shareToken);

    vaultIndexLatest = _bankrollIndex;

    emit VaultSet(
      _bankrollIndex,
      bankrollBytesIdentifier_,
      _bankrollToken,
      _vault,
      _shareToken,
      _controller,
      _liquidityManager
    );
  }

  function _returnVaultIndex(
    address _bankrollBytesIdentifier
  ) private view returns (uint256 vaultIndex_) {
    vaultIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollBytesIdentifier];
    require(vaultIndex_ != 0, "VaultAdapter: bankroll bytes identifier not registered");
  }

  function _returnVaultAddress(
    address _bankrollBytesIdentifier
  ) private view returns (address vaultAddress_) {
    vaultAddress_ = bankrollBytesIdentifierToVaulAddress[_bankrollBytesIdentifier];
    require(vaultAddress_ != address(0), "VaultAdapter: bankroll bytes identifier not registered");
  }

  // Payout functions

  function payoutNoEscrow(
    address _bankrollBytesIdentifier,
    uint256 _totalAmountPayout,
    address _recipient
  ) external override onlyCashier {
    IBankrollVault _vault = IBankrollVault(_returnVaultAddress(_bankrollBytesIdentifier));
    _vault.payoutNoEscrowInVault(
      bankrollBytesIdentifierToWagerAsset[_bankrollBytesIdentifier],
      _recipient,
      _totalAmountPayout
    );
  }

  function payout(
    address _bankrollBytesIdentifier,
    uint256 _escrowAmount,
    uint256 _totalAmountPayout,
    address _cashier,
    address _recipient
  ) external override onlyCashier {
    IBankrollVault _vault = IBankrollVault(_returnVaultAddress(_bankrollBytesIdentifier));

    address wagerAsset_ = bankrollBytesIdentifierToWagerAsset[_bankrollBytesIdentifier];

    if (_escrowAmount > 0) {
      ICashier(_cashier).getEscrowedTokens(wagerAsset_, address(_vault), _escrowAmount);
    }
    _vault.payoutInVault(wagerAsset_, _escrowAmount, _recipient, _totalAmountPayout);
  }

  // View functions

  function returnVaultInfoAllByAddress(
    address _bankrollIdentifierAddress
  )
    public
    view
    override
    returns (
      TokenInfo memory bankrollAssetInfo_,
      TokenInfo memory lpAssetInfo_,
      EpochResultInToken memory epochResultInToken_,
      EpochResultInUSD memory epochResultInUsd_
    )
  {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return returnVaultInfoAllByIndex(bankrollIndex_);
  }

  function returnVaultInfoAllByIndex(
    uint256 _bankrollIndex
  )
    public
    view
    override
    returns (
      TokenInfo memory bankrollAssetInfo_,
      TokenInfo memory lpAssetInfo_,
      EpochResultInToken memory epochResultInToken_,
      EpochResultInUSD memory epochResultInUsd_
    )
  {
    bankrollAssetInfo_ = returnBankrollTokenInfoOfVaultByIndex(_bankrollIndex);
    lpAssetInfo_ = returnLPTokenInfoOfVaultByIndex(_bankrollIndex);
    epochResultInToken_ = returnEpochResultInActiveEpochByIndex(_bankrollIndex);
    epochResultInUsd_ = getEpochUSDStats(_bankrollIndex);
  }

  function returnEpochResultInActiveEpochByAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (EpochResultInToken memory epochResult_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return returnEpochResultInActiveEpochByIndex(bankrollIndex_);
  }

  function returnEpochResultInActiveEpochByIndex(
    uint256 _bankrollIndex
  ) public view override returns (EpochResultInToken memory epochResult_) {
    if (_bankrollIndex > vaultIndexLatest) {
      revert("VaultAdapter: bankroll index does not exist");
    }
    (
      epochResult_.paidInNoRakeActive,
      epochResult_.paidInRakedActive,
      epochResult_.paidOutNoRakeActive,
      epochResult_.paidOutRakedActive,
      epochResult_.totalPaidInAllTime,
      epochResult_.totalPaidOutAllTime,
      epochResult_.secondsLeftInEpoch
    ) = IBankrollVault(vaults[_bankrollIndex].vaultAddress).returnActiveEpochResult();
    return epochResult_;
  }

  function returnEpochResultInUsdByAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (EpochResultInUSD memory epochResult_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return getEpochUSDStats(bankrollIndex_);
  }

  function getEpochUSDStats(
    uint256 _bankrollIndex
  ) public view override returns (EpochResultInUSD memory epochResult_) {
    _checkIfIndexExists(_bankrollIndex);
    (uint256 bankrollTokenPrice_, uint8 priceFeedDecimals_) = getLatestPrice(
      vaults[_bankrollIndex].bankrollTokenAddress
    );
    (
      epochResult_.totalPaidInNoRakeUSD,
      epochResult_.totalPaidInRakedUSD,
      epochResult_.totalPaidOutNoRakeUSD,
      epochResult_.totalPaidOutRakedUSD,
      epochResult_.totalPaidInAllTimeUSD,
      epochResult_.totalPaidOutAllTimeUSD,
      epochResult_.secondsLeftInEpoch
    ) = IBankrollVault(vaults[_bankrollIndex].vaultAddress).returnActiveEpochResult();

    // we need to mutate the values to be in USD, also devide by decimals of bankrollToken
    uint256 decimals_ = IERC20Metadata(vaults[_bankrollIndex].bankrollTokenAddress).decimals();
    epochResult_.totalPaidInNoRakeUSD =
      (epochResult_.totalPaidInNoRakeUSD * bankrollTokenPrice_) /
      10 ** (decimals_ + priceFeedDecimals_);
    epochResult_.totalPaidInRakedUSD =
      (epochResult_.totalPaidInRakedUSD * bankrollTokenPrice_) /
      10 ** (decimals_ + priceFeedDecimals_);
    epochResult_.totalPaidOutNoRakeUSD =
      (epochResult_.totalPaidOutNoRakeUSD * bankrollTokenPrice_) /
      10 ** (decimals_ + priceFeedDecimals_);
    epochResult_.totalPaidOutRakedUSD =
      (epochResult_.totalPaidOutRakedUSD * bankrollTokenPrice_) /
      10 ** (decimals_ + priceFeedDecimals_);
    epochResult_.totalPaidInAllTimeUSD =
      (epochResult_.totalPaidInAllTimeUSD * bankrollTokenPrice_) /
      10 ** (decimals_ + priceFeedDecimals_);
    epochResult_.totalPaidOutAllTimeUSD =
      (epochResult_.totalPaidOutAllTimeUSD * bankrollTokenPrice_) /
      10 ** (decimals_ + priceFeedDecimals_);

    return epochResult_;
  }

  function returnLPTokenInfoByAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (TokenInfo memory tokenInfo_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return returnLPTokenInfoOfVaultByIndex(bankrollIndex_);
  }

  function returnLPTokenInfoOfVaultByIndex(
    uint256 _bankrollIndex
  ) public view override returns (TokenInfo memory tokenInfo_) {
    _checkIfIndexExists(_bankrollIndex);
    VaultDetails memory details = vaults[_bankrollIndex];
    IBankrollLiquidityManager _liquidityManager = IBankrollLiquidityManager(
      details.liquidityManagerAddress
    );
    tokenInfo_.tokenType = TokenType.LP;
    tokenInfo_.tokenAddress = details.shareTokenAddress;
    tokenInfo_.name = IERC20Metadata(details.shareTokenAddress).name();
    tokenInfo_.symbol = IERC20Metadata(details.shareTokenAddress).symbol();
    tokenInfo_.decimals = IERC20Metadata(details.shareTokenAddress).decimals();
    tokenInfo_.totalAmount = _liquidityManager.getLiquidityTokenSupply();
    tokenInfo_.assetRatio = _liquidityManager.getRatioLPToken();
    tokenInfo_.priceInUSD = getLpPrice(_bankrollIndex);
    tokenInfo_.totalAmountInUsd = tokenInfo_.totalAmount * tokenInfo_.priceInUSD;
  }

  function returnBankrollTokenInfoByAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (TokenInfo memory tokenInfo_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return returnBankrollTokenInfoOfVaultByIndex(bankrollIndex_);
  }

  function returnBankrollTokenInfoOfVaultByIndex(
    uint256 _bankrollIndex
  ) public view override returns (TokenInfo memory tokenInfo_) {
    _checkIfIndexExists(_bankrollIndex);
    VaultDetails memory details = vaults[_bankrollIndex];
    IBankrollLiquidityManager _liquidityManager = IBankrollLiquidityManager(
      details.liquidityManagerAddress
    );
    tokenInfo_.tokenType = TokenType.BANKROLL;
    tokenInfo_.tokenAddress = details.bankrollTokenAddress;
    tokenInfo_.name = IERC20Metadata(details.bankrollTokenAddress).name();
    tokenInfo_.symbol = IERC20Metadata(details.bankrollTokenAddress).symbol();
    tokenInfo_.decimals = IERC20Metadata(details.bankrollTokenAddress).decimals();
    tokenInfo_.totalAmount = IERC20(details.bankrollTokenAddress).balanceOf(details.vaultAddress);
    (tokenInfo_.priceInUSD, ) = getLatestPrice(details.bankrollTokenAddress);
    tokenInfo_.totalAmountInUsd = tokenInfo_.totalAmount * tokenInfo_.priceInUSD;
    tokenInfo_.assetRatio = _liquidityManager.getRatioAssetToken();
  }

  function returnLpTokenPriceInUsdByAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (uint256) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return getLpPrice(bankrollIndex_);
  }

  function getLpPrice(uint256 _bankrollIndex) public view override returns (uint256) {
    _checkIfIndexExists(_bankrollIndex);
    VaultDetails memory details = vaults[_bankrollIndex];
    IBankrollLiquidityManager _liquidityManager = IBankrollLiquidityManager(
      details.liquidityManagerAddress
    );

    address bankRollToken_ = details.bankrollTokenAddress;
    (uint64 latestPrice_, uint8 priceFeedDecimals) = getLatestPrice(bankRollToken_);
    uint256 ratioLPToken_ = _liquidityManager.getRatioLPToken();

    uint256 bankrollTokenPriceInLpToken_ = (latestPrice_ * ratioLPToken_) / 10 ** priceFeedDecimals;
    return bankrollTokenPriceInLpToken_;
  }

  function indexToAddress(uint256 index) internal pure returns (address) {
    require(index > 0 && index <= type(uint160).max, "Index out of bounds");
    return address(uint160(index));
  }

  function getAllWhitelistedTokens() public view override returns (address[] memory) {
    return bankrollTokens.values();
  }

  function getVaultAmountsByAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (VaultAmounts memory vaultAmounts_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return getVaultAmountsByIndex(bankrollIndex_);
  }

  function getVaultAmountsByIndex(
    uint256 _bankrollIndex
  ) public view override returns (VaultAmounts memory vaultAmounts_) {
    _checkIfIndexExists(_bankrollIndex);

    VaultDetails memory details_ = vaults[_bankrollIndex];
    address bankrollToken_ = details_.bankrollTokenAddress;

    IBankrollVault vaultContract_ = IBankrollVault(details_.vaultAddress);

    IBankrollLiquidityManager liquidityManager_ = IBankrollLiquidityManager(
      details_.liquidityManagerAddress
    );

    (bool isProfitEpoch_, uint256 epochAmount_) = vaultContract_
      .returnNetProfitOrLossInActiveEpoch();

    (uint256 tokenPrice_, uint8 priceFeedDecimals_) = getLatestPrice(bankrollToken_);

    // calculate the amount of epochs in USD
    uint256 epochAmountInUsd = (epochAmount_ * tokenPrice_) / (10 ** priceFeedDecimals_);

    (bool isProfitTotal_, uint256 totalAmount_) = vaultContract_
      .returnAllTimeProfitLossIncludingActiveEpoch();
    uint256 totalAmountInUsd = (totalAmount_ * tokenPrice_) / (10 ** priceFeedDecimals_);

    (bool isProfitTotalExcluding_, uint256 totalAmountExcluding_) = vaultContract_
      .returnAllTimeProfitOrLoss();
    uint256 totalAmountExcludingInUsd = (totalAmountExcluding_ * tokenPrice_) /
      (10 ** priceFeedDecimals_);

    vaultAmounts_ = VaultAmounts({
      bankrollAmount: vaultContract_.contractBalanceAccountedFor(),
      shareTokenAmount: liquidityManager_.getLiquidityTokenSupply(),
      epochAmount: epochAmountInUsd,
      totalAmount: totalAmountInUsd,
      totalAmountExcluding: totalAmountExcludingInUsd,
      bankrollTokenPrice: uint64(tokenPrice_),
      isProfitEpcoh: isProfitEpoch_,
      isProfitTotal: isProfitTotal_,
      isProfitTotalExcluding: isProfitTotalExcluding_
    });

    return vaultAmounts_;
  }

  // View functions

  function getBankrollOwner(address bankroll) external view returns (address controller_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[bankroll];
    _checkIfIndexExists(bankrollIndex_);
    controller_ = IBankrollController(vaults[bankrollIndex_].controllerAddress)
      .returnBankrollAdmin();
    return controller_;
  }

  function getBankrollAsset(
    address _bankrollIdentifierAddress
  ) public view override returns (address bankrollTokenAddress_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    _checkIfIndexExists(bankrollIndex_);
    return vaults[bankrollIndex_].bankrollTokenAddress;
  }

  function getLpTokenAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (address lpTokenAddress_) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    _checkIfIndexExists(bankrollIndex_);
    return vaults[bankrollIndex_].shareTokenAddress;
  }

  function _checkIfIndexExists(uint256 _bankrollIndex) internal view {
    if (_bankrollIndex > vaultIndexLatest || _bankrollIndex == 0) {
      revert("VaultAdapter: bankroll index does not exist");
    }
  }

  function getVaultDetailsByAddress(
    address _bankrollIdentifierAddress
  ) public view override returns (VaultDetails memory) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollIdentifierAddress];
    return getVaultDetailsByIndex(bankrollIndex_);
  }

  function getVaultDetailsByIndex(
    uint256 _bankrollIndex
  ) public view override returns (VaultDetails memory) {
    _checkIfIndexExists(_bankrollIndex);
    return vaults[_bankrollIndex];
  }

  function getAllBankrollTokens() public view override returns (address[] memory) {
    return bankrollTokens.values();
  }

  function getAllLpTokens() public view returns (address[] memory) {
    return lpTokens.values();
  }

  /**
   * @notice Get all the data of the vaults.
   * @return vaultDetails_ The details of the contracts that are managing the bankroll of the
   * vault
   * @return vaultAmounts_ The amounts in the vaults.
   */
  function getAllData()
    external
    view
    override
    returns (VaultDetails[] memory vaultDetails_, VaultAmounts[] memory vaultAmounts_)
  {
    vaultDetails_ = new VaultDetails[](vaultIndexLatest);
    vaultAmounts_ = new VaultAmounts[](vaultIndexLatest);

    for (uint256 i = 1; i <= vaultIndexLatest; i++) {
      vaultDetails_[i - 1] = getVaultDetailsByIndex(i);
      vaultAmounts_[i - 1] = getVaultAmountsByIndex(i);
    }
  }

  function getAllDataBatch(
    address[] memory bankrollIndexes
  )
    external
    view
    returns (VaultDetails[] memory vaultDetails_, VaultAmounts[] memory vaultAmounts_)
  {
    vaultDetails_ = new VaultDetails[](bankrollIndexes.length);
    vaultAmounts_ = new VaultAmounts[](bankrollIndexes.length);

    for (uint256 i = 0; i < bankrollIndexes.length; i++) {
      uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[bankrollIndexes[i]];
      _checkIfIndexExists(bankrollIndex_);
      vaultDetails_[i] = getVaultDetailsByIndex(bankrollIndex_);
      vaultAmounts_[i] = getVaultAmountsByIndex(bankrollIndex_);
    }
  }

  function getPaginatedData(
    uint256 fromIndex,
    uint256 limit
  ) external view returns (PaginatedAllData memory) {
    if (fromIndex > vaultIndexLatest) {
      fromIndex = vaultIndexLatest;
    }

    if (limit > fromIndex) {
      limit = fromIndex;
    }

    VaultDetails[] memory vaultDetailsArray = new VaultDetails[](limit);
    VaultAmounts[] memory vaultAmountsArray = new VaultAmounts[](limit);

    for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
      if (i == 0) {
        break;
      }
      vaultDetailsArray[fromIndex - i] = getVaultDetailsByIndex(i);
      vaultAmountsArray[fromIndex - i] = getVaultAmountsByIndex(i);
    }

    return
      PaginatedAllData({
        vaultDetails: vaultDetailsArray,
        vaultAmounts: vaultAmountsArray,
        lastReturnedIndex: fromIndex - limit
      });
  }

  /**
   * @notice Get the user balance of the vault OF THE LP TOKEN
   * @param user The address of the user
   * @param fromIndex The index of the first vault to return
   * @param limit The number of vaults to return
   */
  function getUserBalancePaginated(
    address user,
    uint256 fromIndex,
    uint256 limit
  ) external view returns (PaginatedUserBalance memory) {
    if (fromIndex > vaultIndexLatest) {
      fromIndex = vaultIndexLatest;
    }

    if (limit > fromIndex) {
      limit = fromIndex;
    }

    address[] memory bankrollIdentifier = new address[](limit);
    uint256[] memory userBalance = new uint256[](limit);
    uint256[] memory userBalanceInUsd = new uint256[](limit);

    for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
      userBalance[fromIndex - i] = IERC20(vaults[i].shareTokenAddress).balanceOf(user);
      bankrollIdentifier[fromIndex - i] = vaults[i].bankrollBytesIdentifier;
      userBalanceInUsd[fromIndex - i] = (userBalance[fromIndex - i] * getLpPrice(i)) / 1e18;
    }

    return
      PaginatedUserBalance({
        bankrollIdentifier: bankrollIdentifier,
        userBalance: userBalance,
        userBalanceInUsd: userBalanceInUsd,
        lastReturnedIndex: fromIndex - limit
      });
  }

  /**
   * @notice Get the user balance of the vault OF THE LP TOKEN
   * @param user The address of the user
   * @param bankrollIndexes The addresses of the bankrolls
   * @return balances The balance of the LP tokens the user owns
   * @return balancesInUsd The value of the LP tokens the user owns in USD
   */
  function getUserBalanceBatch(
    address user,
    address[] memory bankrollIndexes
  ) external view returns (uint256[] memory, uint256[] memory) {
    uint256[] memory balances = new uint256[](bankrollIndexes.length);
    uint256[] memory balancesInUsd = new uint256[](bankrollIndexes.length);

    for (uint256 i = 0; i < bankrollIndexes.length; i++) {
      uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[bankrollIndexes[i]];
      _checkIfIndexExists(bankrollIndex_);
      balances[i] = IERC20(vaults[bankrollIndex_].shareTokenAddress).balanceOf(user);
      balancesInUsd[i] = (balances[i] * getLpPrice(bankrollIndex_)) / 1e18;
    }

    return (balances, balancesInUsd);
  }

  /**
   * @notice Get the user balance of the vault OF THE LP TOKEN
   * @param user The address of the user
   * @param bankroll The address of the bankroll
   * @return balance The balance of the LP tokens the user owns
   * @return balanceInUsd The value of the LP tokens the user owns in USD
   */
  function getUserBalance(address user, address bankroll) external view returns (uint256, uint256) {
    uint256 bankrollIndex_ = bankrollBytesIdentifierToVaultIndex[bankroll];
    _checkIfIndexExists(bankrollIndex_);
    uint256 balance = IERC20(vaults[bankrollIndex_].shareTokenAddress).balanceOf(user);
    uint256 balanceInUsd = (balance * getLpPrice(bankrollIndex_)) / 1e18;

    return (balance, balanceInUsd);
  }

  /**
   * @notice Get the latest price of the bankroll token
   * @param _bankrollToken The address of the bankroll token
   * @return price The price of the bankroll token
   * @return decimals The decimals of the bankroll token
   */
  function getLatestPrice(address _bankrollToken) public view returns (uint64, uint8) {
    Price.Props memory price = priceFeed.getPrice(_bankrollToken);
    return (price.value, price.decimals);
  }

  function returnVaultDetailsAddress(
    address _bankrollBytesIdentifier
  ) public view override returns (VaultDetails memory) {
    uint256 vaultIndex_ = bankrollBytesIdentifierToVaultIndex[_bankrollBytesIdentifier];
    require(vaultIndex_ != 0, "VaultAdapter: bankroll bytes identifier not registered");
    return vaults[vaultIndex_];
  }

  // Configuration functions

  function updatePriceFeed(address _priceFeed) external override onlyOwner {
    priceFeed = IPriceFeed(_priceFeed);
    emit PriceFeedUpdated(_priceFeed);
  }

  function setCashier(address _cashier, bool _isCashier) external onlyOwner {
    cashierMapping[_cashier] = _isCashier;
    emit CashierSet(_cashier, _isCashier);
  }

  function setFactory(address _factory, bool _isFactory) external onlyOwner {
    factoryMapping[_factory] = _isFactory;
    emit FactorySet(_factory, _isFactory);
  }
}

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

import "./interfaces/IVaultEventEmitter.sol";
import "@openzeppelin/contracts/access/Ownable.sol";

/**
 * @title VaultEventEmitter
 * @author balding-ghost
 * @notice This contract is responsible for emitting events for the vaults
 */
contract VaultEventEmitter is IVaultEventEmitter, Ownable {
    mapping(address => uint256) public addressToIndexBankroll;

    mapping(address => bool) public isFactory;

    mapping(address => bool) public isRegisteredContract;

    constructor(address owner) Ownable(owner) { }

    // Modifiers

    modifier onlyFactory() {
        require(isFactory[_msgSender()], "Forbidden: Only Factory");
        _;
    }

    modifier onlyRegisteredContract() {
        require(isRegisteredContract[_msgSender()], "Forbidden: Only Registered Contract");
        _;
    }

    // Configuration functions

    function setRegisteredContract(address _contract, bool _isRegistered) external onlyOwner {
        isRegisteredContract[_contract] = _isRegistered;
        emit RegisteredContractSet(_contract, _isRegistered);
    }

    function setFactory(address _factory, bool _isFactory) external onlyOwner {
        isFactory[_factory] = _isFactory;
    }

    // Internal functions

    function _returnIndexBankroll(address _contract) internal view returns (uint256 vaultId_) {
        vaultId_ = addressToIndexBankroll[_contract];
        require(vaultId_ != 0, "VaultEventEmitter: Contract not registered");
        return vaultId_;
    }

    // Operational functions

    function emitPayinToVault(address _token, uint256 _amount) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit PayinToVault(vaultId_, _token, _amount);
    }

    function emitPayoutFromVault(
        address _token,
        uint256 _payOutAmount,
        address _recipient,
        uint256 _escrowAmount,
        bool _noRake
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit PayoutFromVault(vaultId_, _token, _payOutAmount, _recipient, _escrowAmount, _noRake);
    }

    function emitVaultDirectPoolDeposit(
        address _token,
        uint256 _amount,
        bool _noRake
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit VaultDirectPoolDeposit(vaultId_, _token, _amount, _noRake);
    }

    function emitAddLiquidityFeeBasis(uint256 _feeBasisPoints) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit AddLiquidityBasisPointsSet(vaultId_, _feeBasisPoints);
    }

    function emitRemoveLiquidityFeeSet(uint256 _feeBasisPoints) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit RemoveLiquidityFeeSet(vaultId_, _feeBasisPoints);
    }

    function emitAddLiquidityToVault(
        address _token,
        uint256 _amount,
        uint256 _addLiquidityFee,
        address _fundingAccount,
        uint256 _amountWLPToMint
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());

        emit AddLiquidityToVault(
            vaultId_, _token, _amount, _addLiquidityFee, _fundingAccount, _amountWLPToMint
        );
    }

    function emitAdminOfBankrollChanged(address _newAdmin) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit AdminOfBankrollChanged(vaultId_, _newAdmin);
    }

    function emitLiquidityManagerChanged(
        address _newManager,
        bool _isRegistered
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit LiquidityManagerChanged(vaultId_, _newManager, _isRegistered);
    }

    function emitCooldownDurationSet(uint256 _cooldownDuration) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit CooldownDurationSet(vaultId_, _cooldownDuration);
    }

    function emitRemoveLiquidityFromVault(
        address _token,
        uint256 _lpTokenAmount,
        uint256 _amountOut,
        uint256 _removeLiquidityFee,
        address _account
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit RemoveLiquidityFromVault(
            vaultId_, _token, _lpTokenAmount, _amountOut, _removeLiquidityFee, _account
        );
    }

    function emitEpochFinalized(
        uint256 _epochId,
        address _token,
        uint256 _totalPaidIn,
        uint256 _totalPaidOut,
        uint256 _nextEpochStart,
        uint256 _profitToRake,
        uint256 _netProfitOrLoss,
        uint256 _profitOrLossForWLPS
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit EpochFinalized(
            vaultId_,
            _token,
            _epochId,
            _totalPaidIn,
            _totalPaidOut,
            _nextEpochStart,
            _profitToRake,
            _netProfitOrLoss,
            _profitOrLossForWLPS
        );
    }

    function emitVaultDeployed(IConfigStruct.AddressConfiguration memory _initConfig)
        external
        override
        onlyFactory
    {
        addressToIndexBankroll[_initConfig.bankrollVaultAddress] = _initConfig.bankrollIndex;
        addressToIndexBankroll[_initConfig.bankrollManagerAddress] = _initConfig.bankrollIndex;
        addressToIndexBankroll[_initConfig.controllerAddress] = _initConfig.bankrollIndex;
        addressToIndexBankroll[_initConfig.liquidityShareTokenAddress] = _initConfig.bankrollIndex;

        isRegisteredContract[_initConfig.bankrollVaultAddress] = true;
        isRegisteredContract[_initConfig.bankrollManagerAddress] = true;
        isRegisteredContract[_initConfig.controllerAddress] = true;
        isRegisteredContract[_initConfig.liquidityShareTokenAddress] = true;

        emit VaultConfigured(
            _initConfig.bankrollVaultAddress,
            _initConfig.bankrollManagerAddress,
            _initConfig.bankrollIndex
        );

        emit VaultDeployed(_initConfig);
    }

    function emitInPrivateModeSet(bool _isPrivate) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit InPrivateModeSet(vaultId_, _isPrivate);
    }

    function emitWhitelistedWLPAddressSet(
        address _address,
        bool _isWhitelisted
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit WhitelistedWLPAddressSet(vaultId_, _address, _isWhitelisted);
    }

    function emitTotalRakeRewardDistributed(
        uint256 _indexBankroll,
        address _token,
        uint256 _amount
    )
        external
        override
        onlyRegisteredContract
    {
        emit TotalRakeRewardDistributed(_indexBankroll, _token, _amount);
    }

    function emitRakeRewardDistributed(
        uint256 _indexBankroll,
        address _recipient,
        uint256 _amount,
        uint256 _amountUSD,
        address _token
    )
        external
        override
        onlyRegisteredContract
    {
        emit RakeRewardDistributed(_indexBankroll, _recipient, _amount, _amountUSD, _token);
    }

    function emitVaultDefaulted(
        address _bankrollToken,
        uint256 _totalPayoutAmount,
        address _recipient,
        uint256 _shortFall
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit VaultDefaulted(vaultId_, _bankrollToken, _totalPayoutAmount, _recipient, _shortFall);
    }

    function emitVaultAdapterRegistered(address _address, bool _isRegistered) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit CashierRegistered(vaultId_, _address, _isRegistered);
    }

    function emitPayoutsHaltedByVaultAdmin(bool _isHalted) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit PayoutsHaltedByVaultAdmin(vaultId_, _isHalted);
    }

    function emitRatioProfitForProtocolSet(uint256 _ratio) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit RatioProfitForProtocolSet(vaultId_, _ratio);
    }

    function emitProtocolHaltOfDeploymentSet(
        uint256 _vaultId,
        bool _halt
    )
        external
        override
        onlyFactory
    {
        emit ProtocolHaltOfDeploymentSet(_vaultId, _halt);
    }

    function emitPayoutsHaltedByProtocol(bool _isHalted) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit PayoutsHaltedByProtocol(vaultId_, _isHalted);
    }

    function emitEpochDurationSet(uint256 _epochDuration) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit EpochDurationSet(vaultId_, _epochDuration);
    }

    function emitMaxAssetAmountSet(uint256 _maxAssetAmount) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit MaxAssetAmountSet(vaultId_, _maxAssetAmount);
    }

    function emitWLPMintedForRake(
        address _rakeCollector,
        uint256 _tokenAmountToDistribute,
        uint256 _amountWLPToMint
    )
        external
        override
    {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit WLPMintedForRake(vaultId_, _rakeCollector, _tokenAmountToDistribute, _amountWLPToMint);
    }

    function emitAddingLPOpenChanged(bool _setting) external override {
        uint256 vaultId_ = _returnIndexBankroll(_msgSender());
        emit AddingLPOpenChanged(vaultId_, _setting);
    }

    function emitLpBalanceChanged(address user, uint256 currentBalance) external override {
        uint256 vaultId_ = _returnIndexBankroll(msg.sender);
        emit LpBalanceChanged(vaultId_, msg.sender, user, currentBalance, block.timestamp);
    }
}

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

import { IWINR } from "../interfaces/IWINR.sol";
import { ReentrancyGuard } from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import { Pausable } from "@openzeppelin/contracts/utils/Pausable.sol";
import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";

contract Converter is AccessControl, ReentrancyGuard, Pausable {
    using SafeERC20 for IWINR;

    event Converted(address indexed user, uint256 amount);

    IWINR public immutable convertibleWinr;
    IWINR public immutable winr;
    address public immutable burnAddress;

    constructor(address _convertibleWinr, address _winr, address _burnAddress) {
        convertibleWinr = IWINR(_convertibleWinr);
        winr = IWINR(_winr);
        burnAddress = _burnAddress;
        _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
    }

    /**
     * @notice Converts convertibleWinr to winr
     * @param amount The amount of convertibleWinr to convert
     * @dev This contract will be deployed to the Arbitrum chain, so WINR is mintable here
     * @dev The user must approve this contract to spend convertibleWinr
     * @notice Convertible WINR is the proxy token that will be given to users in WINR chain
     * resulting from the vested WINR locks
     */
    function convert(uint256 amount) public whenNotPaused nonReentrant {
        convertibleWinr.safeTransferFrom(msg.sender, burnAddress, amount);

        winr.mint(msg.sender, amount);
        emit Converted(msg.sender, amount);
    }

    /**
     * @notice Converts all convertibleWinr to winr
     */
    function convertAll() public {
        uint256 amount = convertibleWinr.balanceOf(msg.sender);
        convert(amount);
    }

    function pause() external onlyRole(DEFAULT_ADMIN_ROLE) {
        _pause();
    }

    function unpause() external onlyRole(DEFAULT_ADMIN_ROLE) {
        _unpause();
    }
}

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

interface ILockRewardDistributor {
    function shareRewards(address lpToken, uint256 amount) external;
    function distributeRewards(address lpToken) external;

    struct Reward {
        uint128 amount;
        uint128 distributeAfter;
        bool distributed;
    }

    event RewardsTaken(address indexed lpToken, uint128 indexed forEpoch, uint128 amount);
    event RewardsDistributed(address indexed lpToken, uint128 indexed forEpoch, uint128 amount);

    error NotTimeToDistribute(uint128 distributeAfter, uint256 currentTimestamp);
    error RewardsAlreadyDistributed(address lpToken, uint128 epoch);
    error ZeroReward(address lpToken);
}

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

interface IMintableERC20 {
    function mint(address receiver_, uint256 amount_) external;

    function burn(address burner_, uint256 amount_) external;
}

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

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

interface IWINR is IERC20 {
    function mint(address account, uint256 amount) external returns (uint256, uint256);

    function burn(uint256 amount) external;
}

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

interface IWINRLock {
    function registerRakeDistributor(address _rakeDistributor, bool _setting) external;

    function shareRewards(address lpToken, uint256 amount) external;

    function getUserActiveLocksLength(address user) external view returns (uint256);

    function getLock(address user, uint128 index) external view returns (LockData memory);

    function registerLpToken(
        address _lpToken,
        address _bankrollToken,
        address _liquidityManager
    )
        external;

    function updateLpTokens(
        address[] calldata tokens,
        LpTokenDetail[] calldata tokenDetails
    )
        external;

    function getRank(address user) external view returns (Rank memory);

    // Structs
    /**
     * @notice Duration configuration for locks
     * @param minimum Minimum duration for a lock
     * @param maximum Maximum duration for a lock
     */
    struct Durations {
        uint16 minimum;
        uint16 maximum;
    }

    /**
     * @notice Lock data structure
     * @param amount Amount of WINR locked
     * @param fullyAmount Fully amount of WINR locked (user can be migrated from arbitrum contract
     * during their stake period)
     * @param weight Weight of the lock (fullyAmount * duration)
     * @param startTime Start time of the lock
     * @param endTime End time of the lock
     * @param vesting Vesting status of the lock (true if the lock is vWINR, false if the lock is
     * WINR)
     * @param withdrawn Withdrawn status of the lock
     */
    struct LockData {
        uint64 index;
        uint128 amount;
        uint128 fullyAmount;
        uint128 weight;
        uint128 startTime;
        uint128 endTime;
        uint128 lastClaimedEpoch;
        bool vesting;
        bool withdrawn;
    }

    struct PaginatedLockData {
        LockData[] lockData;
        uint256 lastReturnedIndex;
    }

    struct PaginatedPendingReward {
        address[] lpTokens;
        uint256[] rewards;
        uint256 lastReturnedIndex;
    }

    struct ActiveTotalUser {
        uint256 lockedWINR;
        uint256 lockedVested;
    }

    /**
     * @notice Rank data structure
     * @param currentXp Current XP of the user
     * @param nextLevelXp XP required to reach the next level
     * @param level Level of the user
     */
    struct Rank {
        uint256 currentXp;
        uint256 nextLevelXp;
        int64 extraPercent;
        uint8 level;
    }

    struct Level {
        uint256 nextLevelXp;
        int64 extraPercent;
    }

    struct LpTokenDetail {
        address bankrollToken;
        address liquidityManager;
    }

    // Custom error messages
    error InvalidValue(uint128 givenValue);
    error InvalidDuration(uint16 givenDuration);
    error Unauthorized(bytes32 role, address account);
    error AlreadyWithdrawn(uint128 index);
    error EndTimeNotReached(uint128 endTime, uint128 currentTime);
    error InvalidIndex(uint128 index);
    error UnknownRewardDistributor(address distributor);
    error InvalidLpToken(address lpToken);

    // events
    event RakeDistributorConfigured(address rakeDistrubor, bool setting);
    event Locked(
        address indexed user,
        uint128 amount,
        uint16 duration,
        bool vesting,
        uint128 index,
        uint128 globalIndex
    );

    event Locked(
        address indexed user, uint128 amount, uint16 duration, bool vesting, uint128 globalIndex
    );
    event Unlocked(address indexed user, uint128 index, uint128 globalIndex);
    event ClaimRewards(
        address indexed user, uint128 index, uint128 globalIndex, address lpToken, uint256 amount
    );
    event ShareRewards(
        address indexed lpToken,
        uint128 indexed epoch,
        uint256 amount,
        uint256 totalValue,
        uint256 totalStakedvWINR,
        uint256 totalStakedWINR,
        uint256 amountInUSD
    );
    event Migrate(address indexed user, uint128 amount, uint16 duration, bool vesting);
    event UpdateDurations(uint16 minimum, uint16 maximum);
    event UpdateLpTokens(address[] tokens);
    event UpdateLevels(uint256 level, Level levelData);
    event RankUpdated(address indexed user, uint8 level);
    event UpdatePriceFeed(address priceFeed);
    event RegisterLpToken(address indexed lpToken, LpTokenDetail lpTokenDetail);
    event SetFactory(address indexed factory, bool isFactory);
    event RemoveLpToken(address indexed lpToken);
    event AddLpToken(address indexed lpToken);
    event WithdrawTokenFromContract(address indexed token, uint256 amount);
    event EmergencyUnlock(address indexed user, uint128 index, uint128 globalIndex);
}

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

import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
import { IMintableERC20 } from "../interfaces/IMintableERC20.sol";

contract ConvertibleWINR is ERC20, AccessControl {
  bytes32 constant CONTROLLER_ROLE = keccak256("CONTROLLER_ROLE");

  constructor(address owner) ERC20("Convertible WINR", "cWINR") {
    _grantRole(DEFAULT_ADMIN_ROLE, owner);
  }

  function burn(address user_, uint256 amount_) external onlyRole(CONTROLLER_ROLE) {
    _burn(user_, amount_);
  }

  function mint(address receiver_, uint256 amount_) external onlyRole(CONTROLLER_ROLE) {
    _mint(receiver_, amount_);
  }
}

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

import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { Pausable } from "@openzeppelin/contracts/utils/Pausable.sol";
import { IMintableERC20 } from "../interfaces/IMintableERC20.sol";
import { IWINR, IERC20 } from "../interfaces/IWINR.sol";
import { IWINRLock } from "../interfaces/IWINRLock.sol";
import "../../interfaces/price-feed/IPriceFeed.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import { IBankrollLiquidityManager } from "../../interfaces/IBankrollLiquidityManager.sol";

/**
 * @title Lock
 * @notice This contract is the lock contract for WINR and vWINR. Shares protocol rewards with
 * users.
 * @notice lock duration must be between 7 and 180 days for WINR and 180 days for vWINR
 * @notice can not withdraw before the end time of the lock
 * @notice lockers have ranks based on the amount of WINR locked(XP)
 */
contract Lock is IWINRLock, AccessControl, Pausable {
    using SafeERC20 for IERC20;
    using EnumerableSet for EnumerableSet.AddressSet;

    EnumerableSet.AddressSet private _lpTokens;
    // Vested WINR token on this chain
    IERC20 public vWinr;
    // Convertible WINR token, will be minted on WINR chain and can be corverted to WINR on Arbitrum
    IMintableERC20 public convertibleWinr;
    IPriceFeed public priceFeed;
    // Total weight of the locks on the contract
    uint256 public totalWeight;
    // Total dollar earnings of the contract
    uint256 internal _totalEarnings;
    uint256 public totalLockedWINR;
    uint256 public totalLockedvWINR;
    bool public isClaimAfterEndTimeActive = true;
    uint128 public immutable startTime;

    bytes32 public constant KEEPER = keccak256("KEEPER_ROLE");

    // List of levels for ranks
    Level[7] public levels;
    // Duration configuration for locks
    Durations public durationConfig = Durations(7, 180);
    // Lock data mapping
    mapping(address users => LockData[] data) internal locks;
    // User dollar earnings mapping
    mapping(address => uint256) internal userEarnings;
    // Total rewards for each lp token
    mapping(address lpToken => uint256 rewardAmmount) internal totalRewards;

    mapping(uint256 epoch => mapping(address lpToken => ShareData)) internal shareData;
    mapping(address lpToken => uint128 lastRewardedEpoch) internal lastRewardedEpochs;
    mapping(
        address user
            => mapping(uint128 index => mapping(address lpToken => uint128 lastClaimedEpoch))
    ) internal lastClaimedEpochs;

    // Rank of the user
    mapping(address user => Rank) internal ranks;

    mapping(address user => ActiveTotalUser) internal activeLockedAmounts;

    mapping(address user => LockData[]) internal activeLocks;

    mapping(address => bool) public isFactory;

    mapping(address => bool) public isRegisteredRakeDistributor;

    mapping(address => LpTokenDetail) public lpTokenDetails;

    struct ShareData {
        uint256 reward;
        uint256 totalWeight;
    }

    constructor(address owner, uint128 startTime_) {
        startTime = startTime_;
        _grantRole(DEFAULT_ADMIN_ROLE, owner);
    }

    function updateVestedWINR(address _vWinr) external onlyRole(DEFAULT_ADMIN_ROLE) {
        vWinr = IWINR(_vWinr);
    }

    function updatedConvertibleWINR(address _convertibleWinr)
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        convertibleWinr = IMintableERC20(_convertibleWinr);
    }

    /**
     * @notice Update the duration configuration for locks
     * @param minimum Minimum duration for a lock
     * @param maximum Maximum duration for a lock
     */
    function updateDurations(
        uint16 minimum,
        uint16 maximum
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        require(minimum < maximum, "Invalid duration");
        durationConfig.minimum = minimum;
        durationConfig.maximum = maximum;

        emit UpdateDurations(minimum, maximum);
    }

    /**
     * @notice Update the lp tokens
     * @param tokens List of lp tokens
     */
    function updateLpTokens(
        address[] calldata tokens,
        LpTokenDetail[] calldata tokenDetails
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        if (tokens.length != tokenDetails.length) {
            revert("Invalid input");
        }

        for (uint256 i = 0; i < tokens.length; i++) {
            lpTokenDetails[tokens[i]] = tokenDetails[i];
            _lpTokens.add(tokens[i]);
        }

        emit UpdateLpTokens(tokens);
    }

    function pause() external onlyRole(DEFAULT_ADMIN_ROLE) {
        _pause();
    }

    function unPause() external onlyRole(DEFAULT_ADMIN_ROLE) {
        _unpause();
    }

    function registerLpToken(
        address _lpToken,
        address _bankrollToken,
        address _liquidityManager
    )
        external
    {
        require(isFactory[msg.sender], "Only factory can register lp tokens");
        LpTokenDetail memory _lpTokenDetail =
            LpTokenDetail({ bankrollToken: _bankrollToken, liquidityManager: _liquidityManager });

        lpTokenDetails[_lpToken] = _lpTokenDetail;
        _lpTokens.add(_lpToken);
        emit RegisterLpToken(_lpToken, _lpTokenDetail);
    }

    function lpTokens() external view returns (address[] memory) {
        return _lpTokens.values();
    }

    function amountLpTokens() external view returns (uint256) {
        return _lpTokens.length();
    }

    function addLpToken(
        address _lpToken,
        address _bankrollToken,
        address _liquidityManager
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        _lpTokens.add(_lpToken);
        lpTokenDetails[_lpToken] =
            LpTokenDetail({ bankrollToken: _bankrollToken, liquidityManager: _liquidityManager });
        emit AddLpToken(_lpToken);
    }

    function removeLpToken(address _lpToken) external onlyRole(DEFAULT_ADMIN_ROLE) {
        _lpTokens.remove(_lpToken);
        delete lpTokenDetails[_lpToken];
        emit RemoveLpToken(_lpToken);
    }

    function updateLevels(
        uint256 level,
        Level memory levelData
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        levels[level] = levelData;

        emit UpdateLevels(level, levelData);
    }

    function updatePriceFeed(address _priceFeed) external onlyRole(DEFAULT_ADMIN_ROLE) {
        priceFeed = IPriceFeed(_priceFeed);

        emit UpdatePriceFeed(_priceFeed);
    }

    function updateClaimAfterEndTimeActive(bool _setting) external onlyRole(DEFAULT_ADMIN_ROLE) {
        isClaimAfterEndTimeActive = _setting;
    }

    function registerRakeDistributor(
        address _rakeDistributor,
        bool _setting
    )
        external
        override
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        isRegisteredRakeDistributor[_rakeDistributor] = _setting;
        emit RakeDistributorConfigured(_rakeDistributor, _setting);
    }

    /**
     * @notice Lock WINR or vWINR
     * @notice Lock duration must be between 7 and 180 days for WINR and 180 days for vWINR
     * @notice Can not withdraw before the end time of the lock
     * @notice WINR is native curreny and must be sent with the transaction as value
     * @param amount Amount of WINR or vWINR to lock
     * @param duration Duration of the lock
     * @param vesting Vesting status of the lock
     */
    function lock(uint128 amount, uint16 duration, bool vesting) external payable whenNotPaused {
        _checkLockDuration(duration, vesting);
        _transferIn(msg.sender, vesting, amount);
        _lock(msg.sender, amount, amount, duration, vesting);
    }

    /**
     * @notice Unlock WINR or vWINR
     * @notice Can not withdraw before the end time of the lock
     * @param index Index of the lock
     * @notice mints convertible WINR for vWINR locks and sends WINR for WINR locks
     * @notice claims rewards for the lock
     */
    function unlock(uint128 index) external {
        address user = msg.sender;

        _unlock(user, index);
    }

    /**
     * @notice Claim rewards for the lock
     * @param index Index of the lock
     */
    function claimRewards(uint128 index, address[] calldata lpTokensList) public {
        address user = msg.sender;

        _claimRewards(user, index, lpTokensList);
    }

    function claimRewardsByKeeper(
        address user,
        uint128 index,
        address[] calldata lpTokensList
    )
        external
        onlyRole(KEEPER)
    {
        _claimRewards(user, index, lpTokensList);
    }

    function unlockByKeeper(address user, uint128 index) external onlyRole(KEEPER) {
        _unlock(user, index);
    }

    /**
     * @notice Share rewards with the lockers
     * @param lpToken LP token address
     * @param amount Amount of rewards to share
     * @notice this function should be called for each lp token
     */
    function shareRewards(address lpToken, uint256 amount) external {
        if (!isRegisteredRakeDistributor[msg.sender]) {
            revert UnknownRewardDistributor(msg.sender);
        }

        if (!_lpTokens.contains(lpToken)) {
            revert InvalidLpToken(lpToken);
        }

        uint256 price = getLpPrice(lpToken);
        uint256 amountInUSD = (amount * price) / 1e18;

        _totalEarnings += amountInUSD;

        totalRewards[lpToken] += amount;

        uint128 currentEpoch = getCurrentEpoch();
        lastRewardedEpochs[lpToken] = currentEpoch;

        shareData[currentEpoch][lpToken] = ShareData({ reward: amount, totalWeight: totalWeight });

        emit ShareRewards(
            lpToken,
            currentEpoch,
            amount,
            _totalEarnings,
            totalLockedvWINR,
            totalLockedWINR,
            amountInUSD
        );
    }

    /**
     * @notice Migrate users from the arbitrum contract
     * @param users List of users
     * @param amounts List of amounts,
     * @param fullyAmounts List of fully amounts
     * @param durations List of durations
     * @param vestings List of vestings
     */
    function migrate(
        address[] calldata users,
        uint128[] calldata amounts,
        uint128[] calldata fullyAmounts,
        uint16[] calldata durations,
        bool[] calldata vestings
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        require(
            users.length == amounts.length && amounts.length == fullyAmounts.length
                && fullyAmounts.length == durations.length && durations.length == vestings.length,
            "Invalid input"
        );

        for (uint256 i = 0; i < users.length; i++) {
            require(users[i] != address(0), "Invalid user");
            require(durations[i] <= durationConfig.maximum, "Invalid duration");
            _lock(users[i], amounts[i], fullyAmounts[i], durations[i], vestings[i]);
            emit Migrate(users[i], amounts[i], durations[i], vestings[i]);
        }
    }

    function getUserLocksLength(address user) external view returns (uint256) {
        return locks[user].length;
    }

    function getUserActiveLocksLength(address user) external view returns (uint256) {
        return activeLocks[user].length;
    }

    /**
     * @notice Get the locks of the user
     * @param user User address
     * @param fromIndex Index to start from
     * @param limit Limit of the locks
     * @return lockData List of lock data
     */
    function getLocks(
        address user,
        uint256 fromIndex,
        uint256 limit
    )
        external
        view
        returns (PaginatedLockData memory)
    {
        uint256 lockDataIndex = locks[user].length;

        if (fromIndex > lockDataIndex) {
            fromIndex = lockDataIndex;
        }

        if (limit > fromIndex) {
            limit = fromIndex;
        }

        LockData[] memory lockData = new LockData[](limit);

        for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
            if (i == 0) {
                break;
            }
            lockData[fromIndex - i] = locks[user][i - 1];
        }

        return PaginatedLockData({ lockData: lockData, lastReturnedIndex: fromIndex - limit });
    }

    function getLock(address user, uint128 index) external view returns (LockData memory) {
        return locks[user][index];
    }

    function getActiveLocks(
        address user,
        uint256 fromIndex,
        uint256 limit
    )
        external
        view
        returns (PaginatedLockData memory)
    {
        uint256 lockDataIndex = activeLocks[user].length;

        if (fromIndex > lockDataIndex) {
            fromIndex = lockDataIndex;
        }

        if (limit > fromIndex) {
            limit = fromIndex;
        }

        LockData[] memory lockData = new LockData[](limit);

        for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
            if (i == 0) {
                break;
            }
            lockData[fromIndex - i] = activeLocks[user][i - 1];
        }

        return PaginatedLockData({ lockData: lockData, lastReturnedIndex: fromIndex - limit });
    }

    function getCurrentEpoch() public view returns (uint128) {
        return uint128(block.timestamp - startTime) / 7 days;
    }

    /**
     * @notice Get the rank of the user
     */
    function getRank(address user) external view returns (Rank memory) {
        return ranks[user];
    }

    function getActiveLockedAmounts(address user) external view returns (ActiveTotalUser memory) {
        return activeLockedAmounts[user];
    }

    function getStats()
        external
        view
        returns (uint256 totalEarnings, uint256 totalWINRLocked, uint256 totalvWINRLocked)
    {
        return (_totalEarnings, totalLockedWINR, totalLockedvWINR);
    }

    function getUserTotalClaimed(address user) external view returns (uint256) {
        return userEarnings[user];
    }

    /**
     * @notice Get the pending rewards for the user
     * @param user User address
     * @param index Index of the lock
     * @return rewards List of pending rewards
     */
    function getPendingRewards(
        address user,
        uint128 index,
        uint256 fromIndex,
        uint256 limit
    )
        external
        view
        returns (PaginatedPendingReward memory)
    {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }

        uint256 globalIndex = activeLocks[user][index].index;
        LockData memory lockData = locks[user][globalIndex];

        uint256 lpTokensLength = _lpTokens.length();

        if (fromIndex > lpTokensLength) {
            fromIndex = lpTokensLength;
        }

        if (limit > fromIndex) {
            limit = fromIndex;
        }

        address[] memory lpTokensList = new address[](limit);
        uint256[] memory rewards = new uint256[](limit);

        for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
            if (i == 0) {
                break;
            }
            address lpToken = _lpTokens.values()[i - 1];
            uint256 reward = _calculateRewards(user, lpToken, lockData);
            lpTokensList[fromIndex - i] = lpToken;
            rewards[fromIndex - i] = reward;
        }

        return PaginatedPendingReward({
            rewards: rewards,
            lpTokens: lpTokensList,
            lastReturnedIndex: fromIndex - limit
        });
    }

    /**
     * @notice internal function to transfer in vWINR and checks if the msg.value is equal to the
     * amount
     */
    function _transferIn(address from, bool vesting, uint128 amount) internal {
        if (vesting) {
            vWinr.safeTransferFrom(from, address(this), amount);
            if (msg.value != 0) {
                revert InvalidValue(uint128(msg.value));
            }
        } else {
            if (msg.value != amount) {
                revert InvalidValue(uint128(msg.value));
            }
        }
    }

    /**
     * @notice internal function to transfer out unlocks
     * @notice mints convertible WINR for vWINR locks and sends WINR for WINR locks
     */
    function _transferOut(bool vesting, address to, uint256 amount) internal {
        if (vesting) {
            convertibleWinr.mint(to, amount);
        } else {
            require(payable(to).send(amount), "Transfer failed");
        }
    }

    /**
     * @notice internal function to transfer rewards
     * @param lpToken LP token address
     * @param to Receiver address
     * @param amount Amount of rewards to transfer
     */
    function _transferReward(address lpToken, address to, uint256 amount) internal {
        IERC20(lpToken).safeTransfer(to, amount);
    }

    /**
     * @notice internal function to check the lock duration
     */
    function _checkLockDuration(uint16 duration, bool vesting) internal view {
        if (duration < durationConfig.minimum || duration > durationConfig.maximum) {
            revert InvalidDuration(duration);
        }

        if (vesting && duration < durationConfig.maximum) {
            revert InvalidDuration(duration);
        }
    }

    /**
     * @notice internal function to lock WINR or vWINR
     * @notice this function calculates the reward debt of the user for each lp token
     * @notice this function updates the rank of the user
     * @param amount Amount of WINR or vWINR to lock
     * @param fullyAmount Fully amount of tokens locked
     * @param duration Duration of the
     * @param vesting Vesting status of the lock
     */
    function _lock(
        address user,
        uint128 amount,
        uint128 fullyAmount,
        uint16 duration,
        bool vesting
    )
        internal
    {
        uint128 weight = (fullyAmount * duration) / 1e18;
        LockData memory lockData = LockData({
            index: uint64(locks[user].length),
            amount: amount,
            fullyAmount: fullyAmount,
            weight: weight,
            startTime: uint128(block.timestamp),
            endTime: uint128(block.timestamp + duration * 1 days),
            lastClaimedEpoch: getCurrentEpoch(),
            vesting: vesting,
            withdrawn: false
        });

        if (vesting) {
            totalLockedvWINR += fullyAmount;
            activeLockedAmounts[user].lockedVested += fullyAmount;
        } else {
            totalLockedWINR += fullyAmount;
            activeLockedAmounts[user].lockedWINR += fullyAmount;
        }

        totalWeight += ((fullyAmount * duration) / 1e18);
        locks[user].push(lockData);
        activeLocks[user].push(lockData);

        _updateRank(user, fullyAmount, true);

        emit Locked(
            user,
            amount,
            duration,
            vesting,
            uint128(activeLocks[user].length - 1),
            uint128(locks[user].length - 1)
        );
    }

    function _unlock(address user, uint128 index) internal {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }

        uint128 globalIndex = activeLocks[user][index].index;
        LockData storage lockData = locks[user][globalIndex];

        if (lockData.withdrawn) {
            revert AlreadyWithdrawn(index);
        }
        if (block.timestamp < lockData.endTime) {
            revert EndTimeNotReached(lockData.endTime, uint128(block.timestamp));
        }

        lockData.withdrawn = true;
        totalWeight -= lockData.weight;

        if (lockData.vesting) {
            totalLockedvWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedVested -= lockData.fullyAmount;
        } else {
            totalLockedWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedWINR -= lockData.fullyAmount;
        }

        removeActiveLock(user, index);
        _updateRank(user, lockData.fullyAmount, false);
        _transferOut(lockData.vesting, user, lockData.amount);

        emit Unlocked(user, index, globalIndex);
    }

    /**
     * @notice internal function to update the rank of the user
     */
    function _updateRank(address user, uint256 xp, bool isLock) internal {
        Rank storage rank = ranks[user];
        if (isLock) {
            rank.currentXp += xp;
        } else {
            rank.currentXp -= xp;
        }

        uint256 currentXp = rank.currentXp;
        uint8 levelWillBe = _checkRank(currentXp);

        rank.level = levelWillBe;
        rank.nextLevelXp = levels[levelWillBe].nextLevelXp;
        rank.extraPercent = levels[levelWillBe].extraPercent;

        emit RankUpdated(user, levelWillBe);
    }

    /**
     * @notice internal function to check the rank of the user
     */
    function _checkRank(uint256 currentXp) internal view returns (uint8) {
        for (uint256 i = 0; i < levels.length; i++) {
            if (currentXp < levels[i].nextLevelXp) {
                return uint8(i);
            }
        }
        return uint8(levels.length - 1);
    }

    /**
     * @notice internal function to claim rewards for the lock
     */
    function _claimRewards(address user, uint128 index, address[] calldata lpTokensList) internal {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }
        uint128 globalIndex = activeLocks[user][index].index;
        LockData memory lockData = locks[user][globalIndex];

        if (lockData.withdrawn) {
            revert AlreadyWithdrawn(index);
        }
        for (uint256 i = 0; i < lpTokensList.length; i++) {
            uint256 rewards = _calculateRewards(user, lpTokensList[i], lockData);
            lastClaimedEpochs[user][globalIndex][lpTokensList[i]] = getCurrentEpoch() + 1;
            if (rewards > 0) {
                // update  userEarnings

                uint256 price = getLpPrice(lpTokensList[i]);
                userEarnings[user] += (rewards * price) / 1e18;

                _transferReward(lpTokensList[i], user, rewards);

                emit ClaimRewards(user, index, globalIndex, lpTokensList[i], rewards);
            }
        }
    }

    /**
     * @notice internal function to calculate the rewards of the user for the lp token
     */
    function _calculateRewards(
        address user,
        address lpToken,
        LockData memory lockData
    )
        internal
        view
        returns (uint256)
    {
        uint128 globalIndex = lockData.index;

        uint128 startEpoch = lastClaimedEpochs[user][globalIndex][lpToken] == 0
            ? lockData.lastClaimedEpoch + 1
            : lastClaimedEpochs[user][globalIndex][lpToken];
        uint128 lastRewardedEpoch = lastRewardedEpochs[lpToken];
        if (!isClaimAfterEndTimeActive) {
            if (block.timestamp > lockData.endTime) {
                lastRewardedEpoch = lockData.endTime / 7 days;
            }
        }

        if (startEpoch > lastRewardedEpoch) {
            return 0;
        }

        if (lastRewardedEpoch == 0) {
            return 0;
        }

        uint256 accumulatedRewards = 0;
        for (uint256 i = startEpoch; i <= lastRewardedEpoch; i++) {
            ShareData memory data = shareData[i][lpToken];
            if (data.reward == 0 || data.totalWeight == 0) {
                continue;
            }
            accumulatedRewards += (data.reward * lockData.weight) / data.totalWeight;
        }
        return accumulatedRewards;
    }

    function removeActiveLock(address user, uint128 index) internal {
        for (uint256 i = index; i < activeLocks[user].length - 1; i++) {
            activeLocks[user][i] = activeLocks[user][i + 1];
        }
        activeLocks[user].pop();
    }

    function getLatestPrice(address _bankrollToken) public view returns (uint64, uint8) {
        Price.Props memory price = priceFeed.getPrice(_bankrollToken);
        return (price.value, price.decimals);
    }

    function getLpPrice(address lpToken) public view returns (uint256) {
        LpTokenDetail memory tokenDetails = lpTokenDetails[lpToken];

        IBankrollLiquidityManager liquidityManager =
            IBankrollLiquidityManager(tokenDetails.liquidityManager);

        (uint64 latestPrice, uint8 priceFeedDecimals) = getLatestPrice(tokenDetails.bankrollToken);
        uint256 ratioLPToken = liquidityManager.getRatioLPToken();
        uint256 bankrollTokenPriceInLpToken = (latestPrice * ratioLPToken) / 10 ** priceFeedDecimals;
        return bankrollTokenPriceInLpToken;
    }

    function setFactory(address _factory, bool _isFactory) external onlyRole(DEFAULT_ADMIN_ROLE) {
        isFactory[_factory] = _isFactory;
        emit SetFactory(_factory, _isFactory);
    }

    // Backup functions

    function withdrawTokenFromContract(
        address token,
        uint256 amount
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
        whenPaused
    {
        IERC20(token).safeTransfer(msg.sender, amount);
        emit WithdrawTokenFromContract(token, amount);
    }

    function withdrawNativeFromContract(uint256 amount)
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
        whenPaused
    {
        require(address(this).balance >= amount, "Insufficient balance");
        payable(msg.sender).transfer(amount);
    }

    function emergencyUnlock(
        address user,
        uint128 index
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
        whenPaused
    {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }

        uint128 globalIndex = activeLocks[user][index].index;
        LockData storage lockData = locks[user][globalIndex];

        if (lockData.withdrawn) {
            revert AlreadyWithdrawn(index);
        }

        lockData.withdrawn = true;
        totalWeight -= lockData.weight;

        if (lockData.vesting) {
            totalLockedvWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedVested -= lockData.fullyAmount;
        } else {
            totalLockedWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedWINR -= lockData.fullyAmount;
        }

        removeActiveLock(user, index);

        _transferOut(lockData.vesting, user, lockData.amount);

        emit EmergencyUnlock(user, index, globalIndex);
    }

    receive() external payable { }
}

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

import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { ReentrancyGuard } from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { Lock } from "./Lock.sol";
import { ILockRewardDistributor } from "../interfaces/ILockRewardDistributor.sol";

contract LockRewardDistributor is ILockRewardDistributor, AccessControl, ReentrancyGuard {
    using SafeERC20 for IERC20;

    bytes32 public constant RAKE_COLLECTION_ROLE = keccak256("RAKE_COLLECTION_ROLE");
    bytes32 public constant RAKE_DISTRIBUTION_ROLE = keccak256("RAKE_DISTRIBUTION_ROLE");

    Lock public lockContract;
    uint128 public lockContractStartTime;
    mapping(address lpToken => mapping(uint128 epoch => Reward)) public rewards;

    constructor(address _admin, address _rakeCollectionContract, address payable _lockContract) {
        _grantRole(DEFAULT_ADMIN_ROLE, _admin);
        _grantRole(RAKE_COLLECTION_ROLE, _rakeCollectionContract);
        _grantRole(RAKE_DISTRIBUTION_ROLE, _admin);
        lockContract = Lock(_lockContract);
        lockContractStartTime = lockContract.startTime();
    }

    function shareRewards(
        address lpToken,
        uint256 amount
    )
        external
        onlyRole(RAKE_COLLECTION_ROLE)
        nonReentrant
    {
        uint128 currentEpoch = lockContract.getCurrentEpoch();
        uint128 nextEpochStartTime = lockContractStartTime + ((currentEpoch + 1) * 7 days);
        rewards[lpToken][currentEpoch + 1] = Reward({
            amount: uint128(amount),
            distributeAfter: nextEpochStartTime,
            distributed: false
        });

        emit RewardsTaken(lpToken, currentEpoch + 1, uint128(amount));
    }

    function distributeRewards(address lpToken)
        external
        onlyRole(RAKE_DISTRIBUTION_ROLE)
        nonReentrant
    {
        uint128 currentEpoch = lockContract.getCurrentEpoch();
        Reward memory reward = rewards[lpToken][currentEpoch];

        if (reward.distributeAfter > block.timestamp) {
            revert NotTimeToDistribute(reward.distributeAfter, block.timestamp);
        }

        if (reward.distributed) {
            revert RewardsAlreadyDistributed(lpToken, currentEpoch);
        }

        if (reward.amount == 0) {
            revert ZeroReward(lpToken);
        }

        reward.distributed = true;
        rewards[lpToken][currentEpoch] = reward;

        IERC20(lpToken).safeTransfer(address(lockContract), reward.amount);
        lockContract.shareRewards(lpToken, reward.amount);

        emit RewardsDistributed(lpToken, currentEpoch, reward.amount);
    }
}

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

import { AccessControl } from "@openzeppelin/contracts/access/AccessControl.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { Pausable } from "@openzeppelin/contracts/utils/Pausable.sol";
import { IMintableERC20 } from "../interfaces/IMintableERC20.sol";
import { IWINR, IERC20 } from "../interfaces/IWINR.sol";
import { IWINRLock } from "../interfaces/IWINRLock.sol";
import "../../interfaces/price-feed/IPriceFeed.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import { IBankrollLiquidityManager } from "../../interfaces/IBankrollLiquidityManager.sol";

/**
 * @title Lock
 * @notice This contract is the lock contract for WINR and vWINR. Shares protocol rewards with
 * users.
 * @notice lock duration must be between 7 and 180 days for WINR and 180 days for vWINR
 * @notice can not withdraw before the end time of the lock
 * @notice lockers have ranks based on the amount of WINR locked(XP)
 */
contract LockV2 is IWINRLock, AccessControl, Pausable {
    using SafeERC20 for IERC20;
    using EnumerableSet for EnumerableSet.AddressSet;

    EnumerableSet.AddressSet private _lpTokens;
    // Vested WINR token on this chain
    IERC20 public vWinr;
    // Convertible WINR token, will be minted on WINR chain and can be corverted to WINR on Arbitrum
    IMintableERC20 public convertibleWinr;
    IPriceFeed public priceFeed;

    IWINRLock public lockV1;
    // Total weight of the locks on the contract
    uint256 public totalWeight;
    // Total dollar earnings of the contract
    uint256 internal _totalEarnings;
    uint256 public totalLockedWINR;
    uint256 public totalLockedvWINR;
    bool public isClaimAfterEndTimeActive = true;
    uint128 public startTime;

    bytes32 public constant KEEPER = keccak256("KEEPER_ROLE");

    // List of levels for ranks
    Level[7] public levels;
    // Duration configuration for locks
    Durations public durationConfig = Durations(7, 180);
    // Lock data mapping
    mapping(address users => LockData[] data) internal locks;
    // User dollar earnings mapping
    mapping(address => uint256) internal userEarnings;
    // Total rewards for each lp token
    mapping(address lpToken => uint256 rewardAmmount) internal totalRewards;

    mapping(uint256 epoch => mapping(address lpToken => ShareData)) internal shareData;
    mapping(address lpToken => uint128 lastRewardedEpoch) internal lastRewardedEpochs;
    mapping(
        address user
            => mapping(uint128 index => mapping(address lpToken => uint128 lastClaimedEpoch))
    ) internal lastClaimedEpochs;

    // Rank of the user
    mapping(address user => Rank) internal ranks;

    mapping(address user => ActiveTotalUser) internal activeLockedAmounts;

    mapping(address user => LockData[]) internal activeLocks;

    mapping(address => bool) public isFactory;

    mapping(address => bool) public isRegisteredRakeDistributor;

    mapping(address => LpTokenDetail) public lpTokenDetails;

    mapping(address => bool) internal isMigratedV1;

    struct ShareData {
        uint256 reward;
        uint256 totalWeight;
    }

    constructor(address owner, uint128 startTime_, IWINRLock _lockV1) {
        startTime = startTime_;
        _grantRole(DEFAULT_ADMIN_ROLE, owner);
        lockV1 = _lockV1;
    }

    function setStartTime(uint128 _startTime) external onlyRole(DEFAULT_ADMIN_ROLE) {
        startTime = _startTime;
    }

    function updateVestedWINR(address _vWinr) external onlyRole(DEFAULT_ADMIN_ROLE) {
        vWinr = IWINR(_vWinr);
    }

    function updatedPriceFeed(address _priceFeed) external onlyRole(DEFAULT_ADMIN_ROLE) {
        priceFeed = IPriceFeed(_priceFeed);
    }

    function updatedConvertibleWINR(address _convertibleWinr)
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        convertibleWinr = IMintableERC20(_convertibleWinr);
    }

    /**
     * @notice Update the duration configuration for locks
     * @param minimum Minimum duration for a lock
     * @param maximum Maximum duration for a lock
     */
    function updateDurations(
        uint16 minimum,
        uint16 maximum
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        require(minimum < maximum, "Invalid duration");
        durationConfig.minimum = minimum;
        durationConfig.maximum = maximum;

        emit UpdateDurations(minimum, maximum);
    }

    /**
     * @notice Update the lp tokens
     * @param tokens List of lp tokens
     */
    function updateLpTokens(
        address[] calldata tokens,
        LpTokenDetail[] calldata tokenDetails
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        if (tokens.length != tokenDetails.length) {
            revert("Invalid input");
        }

        for (uint256 i = 0; i < tokens.length; i++) {
            lpTokenDetails[tokens[i]] = tokenDetails[i];
            _lpTokens.add(tokens[i]);
        }

        emit UpdateLpTokens(tokens);
    }

    function pause() external onlyRole(DEFAULT_ADMIN_ROLE) {
        _pause();
    }

    function unPause() external onlyRole(DEFAULT_ADMIN_ROLE) {
        _unpause();
    }

    function registerLpToken(
        address _lpToken,
        address _bankrollToken,
        address _liquidityManager
    )
        external
    {
        require(isFactory[msg.sender], "Only factory can register lp tokens");
        LpTokenDetail memory _lpTokenDetail =
            LpTokenDetail({ bankrollToken: _bankrollToken, liquidityManager: _liquidityManager });

        lpTokenDetails[_lpToken] = _lpTokenDetail;
        _lpTokens.add(_lpToken);
        emit RegisterLpToken(_lpToken, _lpTokenDetail);
    }

    function lpTokens() external view returns (address[] memory) {
        return _lpTokens.values();
    }

    function amountLpTokens() external view returns (uint256) {
        return _lpTokens.length();
    }

    function addLpToken(
        address _lpToken,
        address _bankrollToken,
        address _liquidityManager
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        _lpTokens.add(_lpToken);
        lpTokenDetails[_lpToken] =
            LpTokenDetail({ bankrollToken: _bankrollToken, liquidityManager: _liquidityManager });
        emit AddLpToken(_lpToken);
    }

    function removeLpToken(address _lpToken) external onlyRole(DEFAULT_ADMIN_ROLE) {
        _lpTokens.remove(_lpToken);
        delete lpTokenDetails[_lpToken];
        emit RemoveLpToken(_lpToken);
    }

    function updateLevels(
        uint256 level,
        Level memory levelData
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        levels[level] = levelData;

        emit UpdateLevels(level, levelData);
    }

    function updatePriceFeed(address _priceFeed) external onlyRole(DEFAULT_ADMIN_ROLE) {
        priceFeed = IPriceFeed(_priceFeed);

        emit UpdatePriceFeed(_priceFeed);
    }

    function updateClaimAfterEndTimeActive(bool _setting) external onlyRole(DEFAULT_ADMIN_ROLE) {
        isClaimAfterEndTimeActive = _setting;
    }

    function registerRakeDistributor(
        address _rakeDistributor,
        bool _setting
    )
        external
        override
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        isRegisteredRakeDistributor[_rakeDistributor] = _setting;
        emit RakeDistributorConfigured(_rakeDistributor, _setting);
    }

    /**
     * @notice Lock WINR or vWINR
     * @notice Lock duration must be between 7 and 180 days for WINR and 180 days for vWINR
     * @notice Can not withdraw before the end time of the lock
     * @notice WINR is native curreny and must be sent with the transaction as value
     * @param amount Amount of WINR or vWINR to lock
     * @param duration Duration of the lock
     * @param vesting Vesting status of the lock
     */
    function lock(uint128 amount, uint16 duration, bool vesting) external payable whenNotPaused {
        _checkLockDuration(duration, vesting);
        _transferIn(msg.sender, vesting, amount);
        _lock(
            msg.sender,
            amount,
            amount,
            uint128(block.timestamp),
            duration,
            vesting,
            getCurrentEpoch()
        );
    }

    /**
     * @notice Unlock WINR or vWINR
     * @notice Can not withdraw before the end time of the lock
     * @param index Index of the lock
     * @notice mints convertible WINR for vWINR locks and sends WINR for WINR locks
     * @notice claims rewards for the lock
     */
    function unlock(uint128 index) external {
        address user = msg.sender;

        _unlock(user, index);
    }

    /**
     * @notice Claim rewards for the lock
     * @param index Index of the lock
     */
    function claimRewards(uint128 index, address[] calldata lpTokensList) public {
        address user = msg.sender;

        _claimRewards(user, index, lpTokensList);
    }

    function claimRewardsByKeeper(
        address user,
        uint128 index,
        address[] calldata lpTokensList
    )
        external
        onlyRole(KEEPER)
    {
        _claimRewards(user, index, lpTokensList);
    }

    function unlockByKeeper(address user, uint128 index) external onlyRole(KEEPER) {
        _unlock(user, index);
    }

    /**
     * @notice Share rewards with the lockers
     * @param lpToken LP token address
     * @param amount Amount of rewards to share
     * @notice this function should be called for each lp token
     */
    function shareRewards(address lpToken, uint256 amount) external {
        if (!isRegisteredRakeDistributor[msg.sender]) {
            revert UnknownRewardDistributor(msg.sender);
        }

        if (!_lpTokens.contains(lpToken)) {
            revert InvalidLpToken(lpToken);
        }

        uint256 price = getLpPrice(lpToken);
        uint256 amountInUSD = (amount * price) / 1e18;

        _totalEarnings += amountInUSD;

        totalRewards[lpToken] += amount;

        uint128 currentEpoch = getCurrentEpoch();
        lastRewardedEpochs[lpToken] = currentEpoch;

        uint256 rewardAmount = shareData[currentEpoch][lpToken].reward + amount;

        shareData[currentEpoch][lpToken] =
            ShareData({ reward: rewardAmount, totalWeight: totalWeight });

        emit ShareRewards(
            lpToken,
            currentEpoch,
            amount,
            _totalEarnings,
            totalLockedvWINR,
            totalLockedWINR,
            amountInUSD
        );
    }

    /**
     * @notice Migrate users from the arbitrum contract
     * @param users List of users
     * @param amounts List of amounts,
     * @param fullyAmounts List of fully amounts
     * @param durations List of durations
     * @param vestings List of vestings
     */
    function migrate(
        address[] calldata users,
        uint128[] calldata amounts,
        uint128[] calldata fullyAmounts,
        uint16[] calldata durations,
        bool[] calldata vestings
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
    {
        require(
            users.length == amounts.length && amounts.length == fullyAmounts.length
                && fullyAmounts.length == durations.length && durations.length == vestings.length,
            "Invalid input"
        );

        for (uint256 i = 0; i < users.length; i++) {
            require(users[i] != address(0), "Invalid user");
            require(durations[i] <= durationConfig.maximum, "Invalid duration");
            _lock(
                users[i],
                amounts[i],
                fullyAmounts[i],
                uint128(block.timestamp),
                durations[i],
                vestings[i],
                getCurrentEpoch()
            );
            emit Migrate(users[i], amounts[i], durations[i], vestings[i]);
        }
    }

    function migrateFromV1(address[] calldata users) external onlyRole(DEFAULT_ADMIN_ROLE) {
        for (uint256 i = 0; i < users.length; i++) {
            if (isMigratedV1[users[i]]) {
                continue;
            }
            uint256 lockCount = lockV1.getUserActiveLocksLength(users[i]);
            for (uint128 j = 0; j < lockCount; j++) {
                LockData memory lockData = lockV1.getLock(users[i], j);
                if (lockData.withdrawn) {
                    continue;
                }
                _lock(
                    users[i],
                    lockData.amount,
                    lockData.fullyAmount,
                    lockData.startTime,
                    uint16((lockData.endTime - lockData.startTime) / 1 days),
                    lockData.vesting,
                    lockData.lastClaimedEpoch - 2
                );
            }
        }
    }

    function getUserLocksLength(address user) external view returns (uint256) {
        return locks[user].length;
    }

    function getUserActiveLocksLength(address user) external view returns (uint256) {
        return activeLocks[user].length;
    }

    /**
     * @notice Get the locks of the user
     * @param user User address
     * @param fromIndex Index to start from
     * @param limit Limit of the locks
     * @return lockData List of lock data
     */
    function getLocks(
        address user,
        uint256 fromIndex,
        uint256 limit
    )
        external
        view
        returns (PaginatedLockData memory)
    {
        uint256 lockDataIndex = locks[user].length;

        if (fromIndex > lockDataIndex) {
            fromIndex = lockDataIndex;
        }

        if (limit > fromIndex) {
            limit = fromIndex;
        }

        LockData[] memory lockData = new LockData[](limit);

        for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
            lockData[fromIndex - i] = locks[user][i - 1];
        }

        return PaginatedLockData({ lockData: lockData, lastReturnedIndex: fromIndex - limit });
    }

    function getLock(address user, uint128 index) external view returns (LockData memory) {
        return locks[user][index];
    }

    function getActiveLocks(
        address user,
        uint256 fromIndex,
        uint256 limit
    )
        external
        view
        returns (PaginatedLockData memory)
    {
        uint256 lockDataIndex = activeLocks[user].length;

        if (fromIndex > lockDataIndex) {
            fromIndex = lockDataIndex;
        }

        if (limit > fromIndex) {
            limit = fromIndex;
        }

        LockData[] memory lockData = new LockData[](limit);

        for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
            lockData[fromIndex - i] = activeLocks[user][i - 1];
        }

        return PaginatedLockData({ lockData: lockData, lastReturnedIndex: fromIndex - limit });
    }

    function getCurrentEpoch() public view returns (uint128) {
        return uint128(block.timestamp - startTime) / 7 days;
    }

    /**
     * @notice Get the rank of the user
     */
    function getRank(address user) external view returns (Rank memory) {
        return ranks[user];
    }

    function getActiveLockedAmounts(address user) external view returns (ActiveTotalUser memory) {
        return activeLockedAmounts[user];
    }

    function getStats()
        external
        view
        returns (uint256 totalEarnings, uint256 totalWINRLocked, uint256 totalvWINRLocked)
    {
        return (_totalEarnings, totalLockedWINR, totalLockedvWINR);
    }

    function getUserTotalClaimed(address user) external view returns (uint256) {
        return userEarnings[user];
    }

    /**
     * @notice Get the pending rewards for the user
     * @param user User address
     * @param index Index of the lock
     * @return rewards List of pending rewards
     */
    function getPendingRewards(
        address user,
        uint128 index,
        uint256 fromIndex,
        uint256 limit
    )
        external
        view
        returns (PaginatedPendingReward memory)
    {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }

        uint256 globalIndex = activeLocks[user][index].index;
        LockData memory lockData = locks[user][globalIndex];

        uint256 lpTokensLength = _lpTokens.length();

        if (fromIndex > lpTokensLength) {
            fromIndex = lpTokensLength;
        }

        if (limit > fromIndex) {
            limit = fromIndex;
        }

        address[] memory lpTokensList = new address[](limit);
        uint256[] memory rewards = new uint256[](limit);

        for (uint256 i = fromIndex; i > fromIndex - limit; i--) {
            address lpToken = _lpTokens.values()[i - 1];
            uint256 reward = _calculateRewards(user, lpToken, lockData);
            lpTokensList[fromIndex - i] = lpToken;
            rewards[fromIndex - i] = reward;
        }

        return PaginatedPendingReward({
            rewards: rewards,
            lpTokens: lpTokensList,
            lastReturnedIndex: fromIndex - limit
        });
    }

    /**
     * @notice internal function to transfer in vWINR and checks if the msg.value is equal to the
     * amount
     */
    function _transferIn(address from, bool vesting, uint128 amount) internal {
        if (vesting) {
            vWinr.safeTransferFrom(from, address(this), amount);
            if (msg.value != 0) {
                revert InvalidValue(uint128(msg.value));
            }
        } else {
            if (msg.value != amount) {
                revert InvalidValue(uint128(msg.value));
            }
        }
    }

    /**
     * @notice internal function to transfer out unlocks
     * @notice mints convertible WINR for vWINR locks and sends WINR for WINR locks
     */
    function _transferOut(bool vesting, address to, uint256 amount) internal {
        if (vesting) {
            convertibleWinr.mint(to, amount);
        } else {
            require(payable(to).send(amount), "Transfer failed");
        }
    }

    /**
     * @notice internal function to transfer rewards
     * @param lpToken LP token address
     * @param to Receiver address
     * @param amount Amount of rewards to transfer
     */
    function _transferReward(address lpToken, address to, uint256 amount) internal {
        IERC20(lpToken).safeTransfer(to, amount);
    }

    /**
     * @notice internal function to check the lock duration
     */
    function _checkLockDuration(uint16 duration, bool vesting) internal view {
        if (duration < durationConfig.minimum || duration > durationConfig.maximum) {
            revert InvalidDuration(duration);
        }

        if (vesting && duration < durationConfig.maximum) {
            revert InvalidDuration(duration);
        }
    }

    /**
     * @notice internal function to lock WINR or vWINR
     * @notice this function calculates the reward debt of the user for each lp token
     * @notice this function updates the rank of the user
     * @param amount Amount of WINR or vWINR to lock
     * @param fullyAmount Fully amount of tokens locked
     * @param duration Duration of the
     * @param vesting Vesting status of the lock
     */
    function _lock(
        address user,
        uint128 amount,
        uint128 fullyAmount,
        uint128 lockStartTime,
        uint16 duration,
        bool vesting,
        uint128 lastClaimedEpoch
    )
        internal
    {
        LockData memory lockData = LockData({
            index: uint64(locks[user].length),
            amount: amount,
            fullyAmount: fullyAmount,
            weight: (fullyAmount * duration) / 1e18,
            startTime: lockStartTime,
            endTime: uint128(lockStartTime + duration * 1 days),
            lastClaimedEpoch: lastClaimedEpoch,
            vesting: vesting,
            withdrawn: false
        });

        if (vesting) {
            totalLockedvWINR += fullyAmount;
            activeLockedAmounts[user].lockedVested += fullyAmount;
        } else {
            totalLockedWINR += fullyAmount;
            activeLockedAmounts[user].lockedWINR += fullyAmount;
        }

        totalWeight += ((fullyAmount * duration) / 1e18);
        locks[user].push(lockData);
        activeLocks[user].push(lockData);

        _updateRank(user, fullyAmount, true);

        emit Locked(
            user,
            amount,
            duration,
            vesting,
            uint128(locks[user].length - 1)
        );
    }

    function _unlock(address user, uint128 index) internal {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }

        uint128 globalIndex = activeLocks[user][index].index;
        LockData storage lockData = locks[user][globalIndex];

        if (lockData.withdrawn) {
            revert AlreadyWithdrawn(index);
        }
        if (block.timestamp < lockData.endTime) {
            revert EndTimeNotReached(lockData.endTime, uint128(block.timestamp));
        }

        lockData.withdrawn = true;
        totalWeight -= lockData.weight;

        if (lockData.vesting) {
            totalLockedvWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedVested -= lockData.fullyAmount;
        } else {
            totalLockedWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedWINR -= lockData.fullyAmount;
        }

        removeActiveLock(user, index);
        _updateRank(user, lockData.fullyAmount, false);
        _transferOut(lockData.vesting, user, lockData.amount);

        emit Unlocked(user, index, globalIndex);
    }

    /**
     * @notice internal function to update the rank of the user
     */
    function _updateRank(address user, uint256 xp, bool isLock) internal {
        Rank storage rank = ranks[user];
        if (isLock) {
            rank.currentXp += xp;
        } else {
            rank.currentXp -= xp;
        }

        uint256 currentXp = rank.currentXp;
        uint8 levelWillBe = _checkRank(currentXp);

        rank.level = levelWillBe;
        rank.nextLevelXp = levels[levelWillBe].nextLevelXp;
        rank.extraPercent = levels[levelWillBe].extraPercent;

        emit RankUpdated(user, levelWillBe);
    }

    /**
     * @notice internal function to check the rank of the user
     */
    function _checkRank(uint256 currentXp) internal view returns (uint8) {
        for (uint256 i = 0; i < levels.length; i++) {
            if (currentXp < levels[i].nextLevelXp) {
                return uint8(i);
            }
        }
        return uint8(levels.length - 1);
    }

    /**
     * @notice internal function to claim rewards for the lock
     */
    function _claimRewards(address user, uint128 index, address[] calldata lpTokensList) internal {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }
        uint128 globalIndex = activeLocks[user][index].index;
        LockData memory lockData = locks[user][globalIndex];

        if (lockData.withdrawn) {
            revert AlreadyWithdrawn(index);
        }
        for (uint256 i = 0; i < lpTokensList.length; i++) {
            uint256 rewards = _calculateRewards(user, lpTokensList[i], lockData);
            lastClaimedEpochs[user][globalIndex][lpTokensList[i]] = getCurrentEpoch() + 1;
            if (rewards > 0) {
                // update  userEarnings

                uint256 price = getLpPrice(lpTokensList[i]);
                userEarnings[user] += (rewards * price) / 1e18;

                _transferReward(lpTokensList[i], user, rewards);

                emit ClaimRewards(user, index, globalIndex, lpTokensList[i], rewards);
            }
        }
    }

    /**
     * @notice internal function to calculate the rewards of the user for the lp token
     */
    function _calculateRewards(
        address user,
        address lpToken,
        LockData memory lockData
    )
        internal
        view
        returns (uint256)
    {
        uint128 globalIndex = lockData.index;

        uint128 startEpoch = lastClaimedEpochs[user][globalIndex][lpToken] == 0
            ? lockData.lastClaimedEpoch + 1
            : lastClaimedEpochs[user][globalIndex][lpToken];
        uint128 lastRewardedEpoch = lastRewardedEpochs[lpToken];
        if (!isClaimAfterEndTimeActive) {
            if (block.timestamp > lockData.endTime) {
                lastRewardedEpoch = lockData.endTime / 7 days;
            }
        }

        if (startEpoch > lastRewardedEpoch) {
            return 0;
        }

        if (lastRewardedEpoch == 0) {
            return 0;
        }

        uint256 accumulatedRewards = 0;
        for (uint256 i = startEpoch; i <= lastRewardedEpoch; i++) {
            ShareData memory data = shareData[i][lpToken];
            if (data.reward == 0 || data.totalWeight == 0) {
                continue;
            }
            accumulatedRewards += (data.reward * lockData.weight) / data.totalWeight;
        }
        return accumulatedRewards;
    }

    function removeActiveLock(address user, uint128 index) internal {
        for (uint256 i = index; i < activeLocks[user].length - 1; i++) {
            activeLocks[user][i] = activeLocks[user][i + 1];
        }
        activeLocks[user].pop();
    }

    function getLatestPrice(address _bankrollToken) public view returns (uint64, uint8) {
        Price.Props memory price = priceFeed.getPrice(_bankrollToken);
        return (price.value, price.decimals);
    }

    function getLpPrice(address lpToken) public view returns (uint256) {
        LpTokenDetail memory tokenDetails = lpTokenDetails[lpToken];

        IBankrollLiquidityManager liquidityManager =
            IBankrollLiquidityManager(tokenDetails.liquidityManager);

        (uint64 latestPrice, uint8 priceFeedDecimals) = getLatestPrice(tokenDetails.bankrollToken);
        uint256 ratioLPToken = liquidityManager.getRatioLPToken();
        uint256 bankrollTokenPriceInLpToken = (latestPrice * ratioLPToken) / 10 ** priceFeedDecimals;
        return bankrollTokenPriceInLpToken;
    }

    function getShareData(
        uint256 epoch,
        address lpToken
    )
        external
        view
        returns (ShareData memory)
    {
        return shareData[epoch][lpToken];
    }

    function setFactory(address _factory, bool _isFactory) external onlyRole(DEFAULT_ADMIN_ROLE) {
        isFactory[_factory] = _isFactory;
        emit SetFactory(_factory, _isFactory);
    }

    // Backup functions

    function withdrawTokenFromContract(
        address token,
        uint256 amount
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
        whenPaused
    {
        IERC20(token).safeTransfer(msg.sender, amount);
        emit WithdrawTokenFromContract(token, amount);
    }

    function withdrawNativeFromContract(uint256 amount)
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
        whenPaused
    {
        require(address(this).balance >= amount, "Insufficient balance");
        payable(msg.sender).transfer(amount);
    }

    function emergencyUnlock(
        address user,
        uint128 index
    )
        external
        onlyRole(DEFAULT_ADMIN_ROLE)
        whenPaused
    {
        if (index >= activeLocks[user].length) {
            revert InvalidIndex(index);
        }

        uint128 globalIndex = activeLocks[user][index].index;
        LockData storage lockData = locks[user][globalIndex];

        if (lockData.withdrawn) {
            revert AlreadyWithdrawn(index);
        }

        lockData.withdrawn = true;
        totalWeight -= lockData.weight;

        if (lockData.vesting) {
            totalLockedvWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedVested -= lockData.fullyAmount;
        } else {
            totalLockedWINR -= lockData.fullyAmount;
            activeLockedAmounts[user].lockedWINR -= lockData.fullyAmount;
        }

        removeActiveLock(user, index);

        _transferOut(lockData.vesting, user, lockData.amount);

        emit EmergencyUnlock(user, index, globalIndex);
    }

    receive() external payable { }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.4.22 <0.9.0;

library console {
    address constant CONSOLE_ADDRESS = address(0x000000000000000000636F6e736F6c652e6c6f67);

    function _sendLogPayload(bytes memory payload) private view {
        uint256 payloadLength = payload.length;
        address consoleAddress = CONSOLE_ADDRESS;
        /// @solidity memory-safe-assembly
        assembly {
            let payloadStart := add(payload, 32)
            let r := staticcall(gas(), consoleAddress, payloadStart, payloadLength, 0, 0)
        }
    }

    function log() internal view {
        _sendLogPayload(abi.encodeWithSignature("log()"));
    }

    function logInt(int p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(int)", p0));
    }

    function logUint(uint p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint)", p0));
    }

    function logString(string memory p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string)", p0));
    }

    function logBool(bool p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool)", p0));
    }

    function logAddress(address p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address)", p0));
    }

    function logBytes(bytes memory p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes)", p0));
    }

    function logBytes1(bytes1 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes1)", p0));
    }

    function logBytes2(bytes2 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes2)", p0));
    }

    function logBytes3(bytes3 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes3)", p0));
    }

    function logBytes4(bytes4 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes4)", p0));
    }

    function logBytes5(bytes5 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes5)", p0));
    }

    function logBytes6(bytes6 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes6)", p0));
    }

    function logBytes7(bytes7 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes7)", p0));
    }

    function logBytes8(bytes8 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes8)", p0));
    }

    function logBytes9(bytes9 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes9)", p0));
    }

    function logBytes10(bytes10 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes10)", p0));
    }

    function logBytes11(bytes11 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes11)", p0));
    }

    function logBytes12(bytes12 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes12)", p0));
    }

    function logBytes13(bytes13 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes13)", p0));
    }

    function logBytes14(bytes14 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes14)", p0));
    }

    function logBytes15(bytes15 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes15)", p0));
    }

    function logBytes16(bytes16 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes16)", p0));
    }

    function logBytes17(bytes17 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes17)", p0));
    }

    function logBytes18(bytes18 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes18)", p0));
    }

    function logBytes19(bytes19 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes19)", p0));
    }

    function logBytes20(bytes20 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes20)", p0));
    }

    function logBytes21(bytes21 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes21)", p0));
    }

    function logBytes22(bytes22 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes22)", p0));
    }

    function logBytes23(bytes23 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes23)", p0));
    }

    function logBytes24(bytes24 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes24)", p0));
    }

    function logBytes25(bytes25 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes25)", p0));
    }

    function logBytes26(bytes26 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes26)", p0));
    }

    function logBytes27(bytes27 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes27)", p0));
    }

    function logBytes28(bytes28 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes28)", p0));
    }

    function logBytes29(bytes29 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes29)", p0));
    }

    function logBytes30(bytes30 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes30)", p0));
    }

    function logBytes31(bytes31 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes31)", p0));
    }

    function logBytes32(bytes32 p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bytes32)", p0));
    }

    function log(uint p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint)", p0));
    }

    function log(string memory p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string)", p0));
    }

    function log(bool p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool)", p0));
    }

    function log(address p0) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address)", p0));
    }

    function log(uint p0, uint p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint)", p0, p1));
    }

    function log(uint p0, string memory p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string)", p0, p1));
    }

    function log(uint p0, bool p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool)", p0, p1));
    }

    function log(uint p0, address p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address)", p0, p1));
    }

    function log(string memory p0, uint p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint)", p0, p1));
    }

    function log(string memory p0, string memory p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string)", p0, p1));
    }

    function log(string memory p0, bool p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool)", p0, p1));
    }

    function log(string memory p0, address p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address)", p0, p1));
    }

    function log(bool p0, uint p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint)", p0, p1));
    }

    function log(bool p0, string memory p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string)", p0, p1));
    }

    function log(bool p0, bool p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool)", p0, p1));
    }

    function log(bool p0, address p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address)", p0, p1));
    }

    function log(address p0, uint p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint)", p0, p1));
    }

    function log(address p0, string memory p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string)", p0, p1));
    }

    function log(address p0, bool p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool)", p0, p1));
    }

    function log(address p0, address p1) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address)", p0, p1));
    }

    function log(uint p0, uint p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint)", p0, p1, p2));
    }

    function log(uint p0, uint p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string)", p0, p1, p2));
    }

    function log(uint p0, uint p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool)", p0, p1, p2));
    }

    function log(uint p0, uint p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address)", p0, p1, p2));
    }

    function log(uint p0, string memory p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint)", p0, p1, p2));
    }

    function log(uint p0, string memory p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,string)", p0, p1, p2));
    }

    function log(uint p0, string memory p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool)", p0, p1, p2));
    }

    function log(uint p0, string memory p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,address)", p0, p1, p2));
    }

    function log(uint p0, bool p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint)", p0, p1, p2));
    }

    function log(uint p0, bool p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string)", p0, p1, p2));
    }

    function log(uint p0, bool p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool)", p0, p1, p2));
    }

    function log(uint p0, bool p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address)", p0, p1, p2));
    }

    function log(uint p0, address p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint)", p0, p1, p2));
    }

    function log(uint p0, address p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,string)", p0, p1, p2));
    }

    function log(uint p0, address p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool)", p0, p1, p2));
    }

    function log(uint p0, address p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,address)", p0, p1, p2));
    }

    function log(string memory p0, uint p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint)", p0, p1, p2));
    }

    function log(string memory p0, uint p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,string)", p0, p1, p2));
    }

    function log(string memory p0, uint p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool)", p0, p1, p2));
    }

    function log(string memory p0, uint p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,address)", p0, p1, p2));
    }

    function log(string memory p0, string memory p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,uint)", p0, p1, p2));
    }

    function log(string memory p0, string memory p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,string)", p0, p1, p2));
    }

    function log(string memory p0, string memory p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,bool)", p0, p1, p2));
    }

    function log(string memory p0, string memory p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,address)", p0, p1, p2));
    }

    function log(string memory p0, bool p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint)", p0, p1, p2));
    }

    function log(string memory p0, bool p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,string)", p0, p1, p2));
    }

    function log(string memory p0, bool p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool)", p0, p1, p2));
    }

    function log(string memory p0, bool p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,address)", p0, p1, p2));
    }

    function log(string memory p0, address p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,uint)", p0, p1, p2));
    }

    function log(string memory p0, address p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,string)", p0, p1, p2));
    }

    function log(string memory p0, address p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,bool)", p0, p1, p2));
    }

    function log(string memory p0, address p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,address)", p0, p1, p2));
    }

    function log(bool p0, uint p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint)", p0, p1, p2));
    }

    function log(bool p0, uint p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string)", p0, p1, p2));
    }

    function log(bool p0, uint p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool)", p0, p1, p2));
    }

    function log(bool p0, uint p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address)", p0, p1, p2));
    }

    function log(bool p0, string memory p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint)", p0, p1, p2));
    }

    function log(bool p0, string memory p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,string)", p0, p1, p2));
    }

    function log(bool p0, string memory p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool)", p0, p1, p2));
    }

    function log(bool p0, string memory p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,address)", p0, p1, p2));
    }

    function log(bool p0, bool p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint)", p0, p1, p2));
    }

    function log(bool p0, bool p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string)", p0, p1, p2));
    }

    function log(bool p0, bool p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool)", p0, p1, p2));
    }

    function log(bool p0, bool p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address)", p0, p1, p2));
    }

    function log(bool p0, address p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint)", p0, p1, p2));
    }

    function log(bool p0, address p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,string)", p0, p1, p2));
    }

    function log(bool p0, address p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool)", p0, p1, p2));
    }

    function log(bool p0, address p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,address)", p0, p1, p2));
    }

    function log(address p0, uint p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint)", p0, p1, p2));
    }

    function log(address p0, uint p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,string)", p0, p1, p2));
    }

    function log(address p0, uint p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool)", p0, p1, p2));
    }

    function log(address p0, uint p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,address)", p0, p1, p2));
    }

    function log(address p0, string memory p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,uint)", p0, p1, p2));
    }

    function log(address p0, string memory p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,string)", p0, p1, p2));
    }

    function log(address p0, string memory p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,bool)", p0, p1, p2));
    }

    function log(address p0, string memory p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,address)", p0, p1, p2));
    }

    function log(address p0, bool p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint)", p0, p1, p2));
    }

    function log(address p0, bool p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,string)", p0, p1, p2));
    }

    function log(address p0, bool p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool)", p0, p1, p2));
    }

    function log(address p0, bool p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,address)", p0, p1, p2));
    }

    function log(address p0, address p1, uint p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,uint)", p0, p1, p2));
    }

    function log(address p0, address p1, string memory p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,string)", p0, p1, p2));
    }

    function log(address p0, address p1, bool p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,bool)", p0, p1, p2));
    }

    function log(address p0, address p1, address p2) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,address)", p0, p1, p2));
    }

    function log(uint p0, uint p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,string)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,address)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,string)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,address)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,string)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,address)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,string)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, uint p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,address)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,string)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,address)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,string)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,address)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,string)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,address)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,string)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, string memory p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,address)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,string)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,address)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,string)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,address)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,string)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,address)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,string)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, bool p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,address)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,string)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,address)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,string)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,address)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,string)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,address)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,uint)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,string)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,bool)", p0, p1, p2, p3));
    }

    function log(uint p0, address p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, uint p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,string,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,string,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,string,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,string,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,address,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,address,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,address,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, string memory p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,string,address,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, bool p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,string,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,string,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,string,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,string,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,address)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,address,uint)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,address,string)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,address,bool)", p0, p1, p2, p3));
    }

    function log(string memory p0, address p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(string,address,address,address)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,string)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,address)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,string)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,address)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,string)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,address)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,string)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, uint p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,address)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,string)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,address)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,string)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,address)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,string)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,address)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,string)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, string memory p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,address)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,string)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,address)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,string)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,address)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,string)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,address)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,string)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, bool p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,address)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,string)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,address)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,string)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,address)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,string)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,address)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,uint)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,string)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,bool)", p0, p1, p2, p3));
    }

    function log(bool p0, address p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,address)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,uint)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,string)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,bool)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,address)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,uint)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,string)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,bool)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,address)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,uint)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,string)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,bool)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,address)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,uint)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,string)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,bool)", p0, p1, p2, p3));
    }

    function log(address p0, uint p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,address)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,uint)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,string)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,bool)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,address)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,string,uint)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,string,string)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,string,bool)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,string,address)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,uint)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,string)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,bool)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,address)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,address,uint)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,address,string)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,address,bool)", p0, p1, p2, p3));
    }

    function log(address p0, string memory p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,string,address,address)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,uint)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,string)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,bool)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,address)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,uint)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,string)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,bool)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,address)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,uint)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,string)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,bool)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,address)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,uint)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,string)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,bool)", p0, p1, p2, p3));
    }

    function log(address p0, bool p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,address)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, uint p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,uint)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, uint p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,string)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, uint p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,bool)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, uint p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,address)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, string memory p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,string,uint)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, string memory p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,string,string)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, string memory p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,string,bool)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, string memory p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,string,address)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, bool p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,uint)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, bool p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,string)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, bool p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,bool)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, bool p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,address)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, address p2, uint p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,address,uint)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, address p2, string memory p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,address,string)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, address p2, bool p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,address,bool)", p0, p1, p2, p3));
    }

    function log(address p0, address p1, address p2, address p3) internal view {
        _sendLogPayload(abi.encodeWithSignature("log(address,address,address,address)", p0, p1, p2, p3));
    }

}

{
  "optimizer": {
    "enabled": true,
    "runs": 200
  },
  "evmVersion": "paris",
  "outputSelection": {
    "*": {
      "*": [
        "evm.bytecode",
        "evm.deployedBytecode",
        "devdoc",
        "userdoc",
        "metadata",
        "abi"
      ]
    }
  }
}

• No Contract Security Audit Submitted- Submit Audit Here

[{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"NativeTokenWithdrawn","type":"event"},{"inputs":[{"internalType":"address payable","name":"to","type":"address"}],"name":"withdrawNativeToken","outputs":[],"stateMutability":"payable","type":"function"},{"stateMutability":"payable","type":"receive"}]

608060405234801561001057600080fd5b50610118806100206000396000f3fe60806040526004361060205760003560e01c8063e9fe787214602b57600080fd5b36602657005b600080fd5b603a603636600460b4565b603c565b005b6040516001600160a01b038216903480156108fc02916000818181858888f193505050501580156070573d6000803e3d6000fd5b506040513481526001600160a01b0382169033907fc31c07d3d0aa96dfe35beac3846c2a6f1e00aa573fc7ebb1748fdb20bb4a657c9060200160405180910390a350565b60006020828403121560c557600080fd5b81356001600160a01b038116811460db57600080fd5b939250505056fea2646970667358221220ace7dff7e318286a5dc3c8d1f7d499ddc5d35861bd8470fde5eb2bc2c6322d2b64736f6c63430008170033

0x60806040526004361060205760003560e01c8063e9fe787214602b57600080fd5b36602657005b600080fd5b603a603636600460b4565b603c565b005b6040516001600160a01b038216903480156108fc02916000818181858888f193505050501580156070573d6000803e3d6000fd5b506040513481526001600160a01b0382169033907fc31c07d3d0aa96dfe35beac3846c2a6f1e00aa573fc7ebb1748fdb20bb4a657c9060200160405180910390a350565b60006020828403121560c557600080fd5b81356001600160a01b038116811460db57600080fd5b939250505056fea2646970667358221220ace7dff7e318286a5dc3c8d1f7d499ddc5d35861bd8470fde5eb2bc2c6322d2b64736f6c63430008170033