// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import "./interfaces/IIncentiveRewardsDistributor.sol";

contract IncentiveRewardsDistributor is IIncentiveRewardsDistributor, RewardsDistributor {
    /// @notice Initializes the contract by setting the escrow vote and escrow managers.
    /// @param escrowVoteManager_ Address of the escrow vote manager contract.
    /// @param escrowManager_ Address of the escrow manager contract.
    constructor(address escrowVoteManager_, address escrowManager_) RewardsDistributor(escrowVoteManager_, escrowManager_) {}

    /// @inheritdoc IIncentiveRewardsDistributor
    function getReward(
        address owner_, 
        address[] calldata rewardTokens_
    ) 
        external 
        override (RewardsDistributor, IIncentiveRewardsDistributor) 
        nonReentrant
    {
        if (msg.sender != ESCROW_VOTE_MANAGER) {
            revert UnauthorizedAccess();
        }
        _getReward(owner_, rewardTokens_);
    }

    /// @inheritdoc IIncentiveRewardsDistributor
    function notifyRewardAmount(
        address rewardToken_, 
        uint256 rewardAmount_
    ) 
        external 
        override (RewardsDistributor, IIncentiveRewardsDistributor) 
        nonReentrant
    {
        if (!s_isRewardToken[rewardToken_]) {
            if (!IEscrowVoteManagerV1(ESCROW_VOTE_MANAGER).s_isWhitelistedToken(rewardToken_)) {
                revert NotWhitelisted();
            }
            s_isRewardToken[rewardToken_] = true;
            s_rewardTokens.push(rewardToken_);
        } else {
            if (!IEscrowVoteManagerV1(ESCROW_VOTE_MANAGER).s_isWhitelistedToken(rewardToken_)) {
                revert NotWhitelisted();
            }
        }
        _notifyRewardAmount(msg.sender, rewardToken_, rewardAmount_);
    }
}

// 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.1.0) (proxy/utils/UUPSUpgradeable.sol)

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

    function __UUPSUpgradeable_init() internal onlyInitializing {
    }

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

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

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

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

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

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

// SPDX-License-Identifier: MIT
// 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.1.0) (interfaces/draft-IERC1822.sol)

pragma solidity ^0.8.20;

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

pragma solidity ^0.8.20;

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

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

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

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

pragma solidity ^0.8.20;

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

// 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.1.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[ERC-1967], 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 ERC-1967) using
     * the https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
     * `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc`
     */
    function _implementation() internal view virtual override returns (address) {
        return ERC1967Utils.getImplementation();
    }
}

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

pragma solidity ^0.8.21;

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

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

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

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

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

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

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

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

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

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

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

    /**
     * @dev Returns the current admin.
     *
     * TIP: To get this value clients can read directly from the storage slot shown below (specified by ERC-1967) using
     * the https://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 ERC-1967 admin slot.
     */
    function _setAdmin(address newAdmin) private {
        if (newAdmin == address(0)) {
            revert ERC1967InvalidAdmin(address(0));
        }
        StorageSlot.getAddressSlot(ADMIN_SLOT).value = newAdmin;
    }

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

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

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

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

        StorageSlot.getAddressSlot(BEACON_SLOT).value = newBeacon;

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

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

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

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

// SPDX-License-Identifier: MIT
// 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.1.0) (token/ERC20/IERC20.sol)

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

import {IERC721} from "./IERC721.sol";
import {IERC721Metadata} from "./extensions/IERC721Metadata.sol";
import {ERC721Utils} from "./utils/ERC721Utils.sol";
import {Context} from "../../utils/Context.sol";
import {Strings} from "../../utils/Strings.sol";
import {IERC165, ERC165} from "../../utils/introspection/ERC165.sol";
import {IERC721Errors} from "../../interfaces/draft-IERC6093.sol";

/**
 * @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC-721] Non-Fungible Token Standard, including
 * the Metadata extension, but not including the Enumerable extension, which is available separately as
 * {ERC721Enumerable}.
 */
abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Errors {
    using Strings for uint256;

    // Token name
    string private _name;

    // Token symbol
    string private _symbol;

    mapping(uint256 tokenId => address) private _owners;

    mapping(address owner => uint256) private _balances;

    mapping(uint256 tokenId => address) private _tokenApprovals;

    mapping(address owner => mapping(address operator => bool)) private _operatorApprovals;

    /**
     * @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
     */
    constructor(string memory name_, string memory symbol_) {
        _name = name_;
        _symbol = symbol_;
    }

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

    /**
     * @dev See {IERC721-balanceOf}.
     */
    function balanceOf(address owner) public view virtual returns (uint256) {
        if (owner == address(0)) {
            revert ERC721InvalidOwner(address(0));
        }
        return _balances[owner];
    }

    /**
     * @dev See {IERC721-ownerOf}.
     */
    function ownerOf(uint256 tokenId) public view virtual returns (address) {
        return _requireOwned(tokenId);
    }

    /**
     * @dev See {IERC721Metadata-name}.
     */
    function name() public view virtual returns (string memory) {
        return _name;
    }

    /**
     * @dev See {IERC721Metadata-symbol}.
     */
    function symbol() public view virtual returns (string memory) {
        return _symbol;
    }

    /**
     * @dev See {IERC721Metadata-tokenURI}.
     */
    function tokenURI(uint256 tokenId) public view virtual returns (string memory) {
        _requireOwned(tokenId);

        string memory baseURI = _baseURI();
        return bytes(baseURI).length > 0 ? string.concat(baseURI, tokenId.toString()) : "";
    }

    /**
     * @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
     * token will be the concatenation of the `baseURI` and the `tokenId`. Empty
     * by default, can be overridden in child contracts.
     */
    function _baseURI() internal view virtual returns (string memory) {
        return "";
    }

    /**
     * @dev See {IERC721-approve}.
     */
    function approve(address to, uint256 tokenId) public virtual {
        _approve(to, tokenId, _msgSender());
    }

    /**
     * @dev See {IERC721-getApproved}.
     */
    function getApproved(uint256 tokenId) public view virtual returns (address) {
        _requireOwned(tokenId);

        return _getApproved(tokenId);
    }

    /**
     * @dev See {IERC721-setApprovalForAll}.
     */
    function setApprovalForAll(address operator, bool approved) public virtual {
        _setApprovalForAll(_msgSender(), operator, approved);
    }

    /**
     * @dev See {IERC721-isApprovedForAll}.
     */
    function isApprovedForAll(address owner, address operator) public view virtual returns (bool) {
        return _operatorApprovals[owner][operator];
    }

    /**
     * @dev See {IERC721-transferFrom}.
     */
    function transferFrom(address from, address to, uint256 tokenId) public virtual {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        // Setting an "auth" arguments enables the `_isAuthorized` check which verifies that the token exists
        // (from != 0). Therefore, it is not needed to verify that the return value is not 0 here.
        address previousOwner = _update(to, tokenId, _msgSender());
        if (previousOwner != from) {
            revert ERC721IncorrectOwner(from, tokenId, previousOwner);
        }
    }

    /**
     * @dev See {IERC721-safeTransferFrom}.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId) public {
        safeTransferFrom(from, to, tokenId, "");
    }

    /**
     * @dev See {IERC721-safeTransferFrom}.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId, bytes memory data) public virtual {
        transferFrom(from, to, tokenId);
        ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
    }

    /**
     * @dev Returns the owner of the `tokenId`. Does NOT revert if token doesn't exist
     *
     * IMPORTANT: Any overrides to this function that add ownership of tokens not tracked by the
     * core ERC-721 logic MUST be matched with the use of {_increaseBalance} to keep balances
     * consistent with ownership. The invariant to preserve is that for any address `a` the value returned by
     * `balanceOf(a)` must be equal to the number of tokens such that `_ownerOf(tokenId)` is `a`.
     */
    function _ownerOf(uint256 tokenId) internal view virtual returns (address) {
        return _owners[tokenId];
    }

    /**
     * @dev Returns the approved address for `tokenId`. Returns 0 if `tokenId` is not minted.
     */
    function _getApproved(uint256 tokenId) internal view virtual returns (address) {
        return _tokenApprovals[tokenId];
    }

    /**
     * @dev Returns whether `spender` is allowed to manage `owner`'s tokens, or `tokenId` in
     * particular (ignoring whether it is owned by `owner`).
     *
     * WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
     * assumption.
     */
    function _isAuthorized(address owner, address spender, uint256 tokenId) internal view virtual returns (bool) {
        return
            spender != address(0) &&
            (owner == spender || isApprovedForAll(owner, spender) || _getApproved(tokenId) == spender);
    }

    /**
     * @dev Checks if `spender` can operate on `tokenId`, assuming the provided `owner` is the actual owner.
     * Reverts if:
     * - `spender` does not have approval from `owner` for `tokenId`.
     * - `spender` does not have approval to manage all of `owner`'s assets.
     *
     * WARNING: This function assumes that `owner` is the actual owner of `tokenId` and does not verify this
     * assumption.
     */
    function _checkAuthorized(address owner, address spender, uint256 tokenId) internal view virtual {
        if (!_isAuthorized(owner, spender, tokenId)) {
            if (owner == address(0)) {
                revert ERC721NonexistentToken(tokenId);
            } else {
                revert ERC721InsufficientApproval(spender, tokenId);
            }
        }
    }

    /**
     * @dev Unsafe write access to the balances, used by extensions that "mint" tokens using an {ownerOf} override.
     *
     * NOTE: the value is limited to type(uint128).max. This protect against _balance overflow. It is unrealistic that
     * a uint256 would ever overflow from increments when these increments are bounded to uint128 values.
     *
     * WARNING: Increasing an account's balance using this function tends to be paired with an override of the
     * {_ownerOf} function to resolve the ownership of the corresponding tokens so that balances and ownership
     * remain consistent with one another.
     */
    function _increaseBalance(address account, uint128 value) internal virtual {
        unchecked {
            _balances[account] += value;
        }
    }

    /**
     * @dev Transfers `tokenId` from its current owner to `to`, or alternatively mints (or burns) if the current owner
     * (or `to`) is the zero address. Returns the owner of the `tokenId` before the update.
     *
     * The `auth` argument is optional. If the value passed is non 0, then this function will check that
     * `auth` is either the owner of the token, or approved to operate on the token (by the owner).
     *
     * Emits a {Transfer} event.
     *
     * NOTE: If overriding this function in a way that tracks balances, see also {_increaseBalance}.
     */
    function _update(address to, uint256 tokenId, address auth) internal virtual returns (address) {
        address from = _ownerOf(tokenId);

        // Perform (optional) operator check
        if (auth != address(0)) {
            _checkAuthorized(from, auth, tokenId);
        }

        // Execute the update
        if (from != address(0)) {
            // Clear approval. No need to re-authorize or emit the Approval event
            _approve(address(0), tokenId, address(0), false);

            unchecked {
                _balances[from] -= 1;
            }
        }

        if (to != address(0)) {
            unchecked {
                _balances[to] += 1;
            }
        }

        _owners[tokenId] = to;

        emit Transfer(from, to, tokenId);

        return from;
    }

    /**
     * @dev Mints `tokenId` and transfers it to `to`.
     *
     * WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - `to` cannot be the zero address.
     *
     * Emits a {Transfer} event.
     */
    function _mint(address to, uint256 tokenId) internal {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        address previousOwner = _update(to, tokenId, address(0));
        if (previousOwner != address(0)) {
            revert ERC721InvalidSender(address(0));
        }
    }

    /**
     * @dev Mints `tokenId`, transfers it to `to` and checks for `to` acceptance.
     *
     * Requirements:
     *
     * - `tokenId` must not exist.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeMint(address to, uint256 tokenId) internal {
        _safeMint(to, tokenId, "");
    }

    /**
     * @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
     * forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
     */
    function _safeMint(address to, uint256 tokenId, bytes memory data) internal virtual {
        _mint(to, tokenId);
        ERC721Utils.checkOnERC721Received(_msgSender(), address(0), to, tokenId, data);
    }

    /**
     * @dev Destroys `tokenId`.
     * The approval is cleared when the token is burned.
     * This is an internal function that does not check if the sender is authorized to operate on the token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     *
     * Emits a {Transfer} event.
     */
    function _burn(uint256 tokenId) internal {
        address previousOwner = _update(address(0), tokenId, address(0));
        if (previousOwner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        }
    }

    /**
     * @dev Transfers `tokenId` from `from` to `to`.
     *  As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     *
     * Emits a {Transfer} event.
     */
    function _transfer(address from, address to, uint256 tokenId) internal {
        if (to == address(0)) {
            revert ERC721InvalidReceiver(address(0));
        }
        address previousOwner = _update(to, tokenId, address(0));
        if (previousOwner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        } else if (previousOwner != from) {
            revert ERC721IncorrectOwner(from, tokenId, previousOwner);
        }
    }

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking that contract recipients
     * are aware of the ERC-721 standard to prevent tokens from being forever locked.
     *
     * `data` is additional data, it has no specified format and it is sent in call to `to`.
     *
     * This internal function is like {safeTransferFrom} in the sense that it invokes
     * {IERC721Receiver-onERC721Received} on the receiver, and can be used to e.g.
     * implement alternative mechanisms to perform token transfer, such as signature-based.
     *
     * Requirements:
     *
     * - `tokenId` token must exist and be owned by `from`.
     * - `to` cannot be the zero address.
     * - `from` cannot be the zero address.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function _safeTransfer(address from, address to, uint256 tokenId) internal {
        _safeTransfer(from, to, tokenId, "");
    }

    /**
     * @dev Same as {xref-ERC721-_safeTransfer-address-address-uint256-}[`_safeTransfer`], with an additional `data` parameter which is
     * forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
     */
    function _safeTransfer(address from, address to, uint256 tokenId, bytes memory data) internal virtual {
        _transfer(from, to, tokenId);
        ERC721Utils.checkOnERC721Received(_msgSender(), from, to, tokenId, data);
    }

    /**
     * @dev Approve `to` to operate on `tokenId`
     *
     * The `auth` argument is optional. If the value passed is non 0, then this function will check that `auth` is
     * either the owner of the token, or approved to operate on all tokens held by this owner.
     *
     * Emits an {Approval} event.
     *
     * Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
     */
    function _approve(address to, uint256 tokenId, address auth) internal {
        _approve(to, tokenId, auth, true);
    }

    /**
     * @dev Variant of `_approve` with an optional flag to enable or disable the {Approval} event. The event is not
     * emitted in the context of transfers.
     */
    function _approve(address to, uint256 tokenId, address auth, bool emitEvent) internal virtual {
        // Avoid reading the owner unless necessary
        if (emitEvent || auth != address(0)) {
            address owner = _requireOwned(tokenId);

            // We do not use _isAuthorized because single-token approvals should not be able to call approve
            if (auth != address(0) && owner != auth && !isApprovedForAll(owner, auth)) {
                revert ERC721InvalidApprover(auth);
            }

            if (emitEvent) {
                emit Approval(owner, to, tokenId);
            }
        }

        _tokenApprovals[tokenId] = to;
    }

    /**
     * @dev Approve `operator` to operate on all of `owner` tokens
     *
     * Requirements:
     * - operator can't be the address zero.
     *
     * Emits an {ApprovalForAll} event.
     */
    function _setApprovalForAll(address owner, address operator, bool approved) internal virtual {
        if (operator == address(0)) {
            revert ERC721InvalidOperator(operator);
        }
        _operatorApprovals[owner][operator] = approved;
        emit ApprovalForAll(owner, operator, approved);
    }

    /**
     * @dev Reverts if the `tokenId` doesn't have a current owner (it hasn't been minted, or it has been burned).
     * Returns the owner.
     *
     * Overrides to ownership logic should be done to {_ownerOf}.
     */
    function _requireOwned(uint256 tokenId) internal view returns (address) {
        address owner = _ownerOf(tokenId);
        if (owner == address(0)) {
            revert ERC721NonexistentToken(tokenId);
        }
        return owner;
    }
}

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC721/extensions/ERC721Enumerable.sol)

pragma solidity ^0.8.20;

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

/**
 * @dev This implements an optional extension of {ERC721} defined in the ERC that adds enumerability
 * of all the token ids in the contract as well as all token ids owned by each account.
 *
 * CAUTION: {ERC721} extensions that implement custom `balanceOf` logic, such as {ERC721Consecutive},
 * interfere with enumerability and should not be used together with {ERC721Enumerable}.
 */
abstract contract ERC721Enumerable is ERC721, IERC721Enumerable {
    mapping(address owner => mapping(uint256 index => uint256)) private _ownedTokens;
    mapping(uint256 tokenId => uint256) private _ownedTokensIndex;

    uint256[] private _allTokens;
    mapping(uint256 tokenId => uint256) private _allTokensIndex;

    /**
     * @dev An `owner`'s token query was out of bounds for `index`.
     *
     * NOTE: The owner being `address(0)` indicates a global out of bounds index.
     */
    error ERC721OutOfBoundsIndex(address owner, uint256 index);

    /**
     * @dev Batch mint is not allowed.
     */
    error ERC721EnumerableForbiddenBatchMint();

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

    /**
     * @dev See {IERC721Enumerable-tokenOfOwnerByIndex}.
     */
    function tokenOfOwnerByIndex(address owner, uint256 index) public view virtual returns (uint256) {
        if (index >= balanceOf(owner)) {
            revert ERC721OutOfBoundsIndex(owner, index);
        }
        return _ownedTokens[owner][index];
    }

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

    /**
     * @dev See {IERC721Enumerable-tokenByIndex}.
     */
    function tokenByIndex(uint256 index) public view virtual returns (uint256) {
        if (index >= totalSupply()) {
            revert ERC721OutOfBoundsIndex(address(0), index);
        }
        return _allTokens[index];
    }

    /**
     * @dev See {ERC721-_update}.
     */
    function _update(address to, uint256 tokenId, address auth) internal virtual override returns (address) {
        address previousOwner = super._update(to, tokenId, auth);

        if (previousOwner == address(0)) {
            _addTokenToAllTokensEnumeration(tokenId);
        } else if (previousOwner != to) {
            _removeTokenFromOwnerEnumeration(previousOwner, tokenId);
        }
        if (to == address(0)) {
            _removeTokenFromAllTokensEnumeration(tokenId);
        } else if (previousOwner != to) {
            _addTokenToOwnerEnumeration(to, tokenId);
        }

        return previousOwner;
    }

    /**
     * @dev Private function to add a token to this extension's ownership-tracking data structures.
     * @param to address representing the new owner of the given token ID
     * @param tokenId uint256 ID of the token to be added to the tokens list of the given address
     */
    function _addTokenToOwnerEnumeration(address to, uint256 tokenId) private {
        uint256 length = balanceOf(to) - 1;
        _ownedTokens[to][length] = tokenId;
        _ownedTokensIndex[tokenId] = length;
    }

    /**
     * @dev Private function to add a token to this extension's token tracking data structures.
     * @param tokenId uint256 ID of the token to be added to the tokens list
     */
    function _addTokenToAllTokensEnumeration(uint256 tokenId) private {
        _allTokensIndex[tokenId] = _allTokens.length;
        _allTokens.push(tokenId);
    }

    /**
     * @dev Private function to remove a token from this extension's ownership-tracking data structures. Note that
     * while the token is not assigned a new owner, the `_ownedTokensIndex` mapping is _not_ updated: this allows for
     * gas optimizations e.g. when performing a transfer operation (avoiding double writes).
     * This has O(1) time complexity, but alters the order of the _ownedTokens array.
     * @param from address representing the previous owner of the given token ID
     * @param tokenId uint256 ID of the token to be removed from the tokens list of the given address
     */
    function _removeTokenFromOwnerEnumeration(address from, uint256 tokenId) private {
        // To prevent a gap in from's tokens array, we store the last token in the index of the token to delete, and
        // then delete the last slot (swap and pop).

        uint256 lastTokenIndex = balanceOf(from);
        uint256 tokenIndex = _ownedTokensIndex[tokenId];

        mapping(uint256 index => uint256) storage _ownedTokensByOwner = _ownedTokens[from];

        // When the token to delete is the last token, the swap operation is unnecessary
        if (tokenIndex != lastTokenIndex) {
            uint256 lastTokenId = _ownedTokensByOwner[lastTokenIndex];

            _ownedTokensByOwner[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
            _ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
        }

        // This also deletes the contents at the last position of the array
        delete _ownedTokensIndex[tokenId];
        delete _ownedTokensByOwner[lastTokenIndex];
    }

    /**
     * @dev Private function to remove a token from this extension's token tracking data structures.
     * This has O(1) time complexity, but alters the order of the _allTokens array.
     * @param tokenId uint256 ID of the token to be removed from the tokens list
     */
    function _removeTokenFromAllTokensEnumeration(uint256 tokenId) private {
        // To prevent a gap in the tokens array, we store the last token in the index of the token to delete, and
        // then delete the last slot (swap and pop).

        uint256 lastTokenIndex = _allTokens.length - 1;
        uint256 tokenIndex = _allTokensIndex[tokenId];

        // When the token to delete is the last token, the swap operation is unnecessary. However, since this occurs so
        // rarely (when the last minted token is burnt) that we still do the swap here to avoid the gas cost of adding
        // an 'if' statement (like in _removeTokenFromOwnerEnumeration)
        uint256 lastTokenId = _allTokens[lastTokenIndex];

        _allTokens[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
        _allTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index

        // This also deletes the contents at the last position of the array
        delete _allTokensIndex[tokenId];
        _allTokens.pop();
    }

    /**
     * See {ERC721-_increaseBalance}. We need that to account tokens that were minted in batch
     */
    function _increaseBalance(address account, uint128 amount) internal virtual override {
        if (amount > 0) {
            revert ERC721EnumerableForbiddenBatchMint();
        }
        super._increaseBalance(account, amount);
    }
}

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

pragma solidity ^0.8.20;

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

/**
 * @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
 * @dev See https://eips.ethereum.org/EIPS/eip-721
 */
interface IERC721Enumerable is IERC721 {
    /**
     * @dev Returns the total amount of tokens stored by the contract.
     */
    function totalSupply() external view returns (uint256);

    /**
     * @dev Returns a token ID owned by `owner` at a given `index` of its token list.
     * Use along with {balanceOf} to enumerate all of ``owner``'s tokens.
     */
    function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);

    /**
     * @dev Returns a token ID at a given `index` of all the tokens stored by the contract.
     * Use along with {totalSupply} to enumerate all tokens.
     */
    function tokenByIndex(uint256 index) external view returns (uint256);
}

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

pragma solidity ^0.8.20;

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

/**
 * @title ERC-721 Non-Fungible Token Standard, optional metadata extension
 * @dev See https://eips.ethereum.org/EIPS/eip-721
 */
interface IERC721Metadata is IERC721 {
    /**
     * @dev Returns the token collection name.
     */
    function name() external view returns (string memory);

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

    /**
     * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
     */
    function tokenURI(uint256 tokenId) external view returns (string memory);
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Required interface of an ERC-721 compliant contract.
 */
interface IERC721 is IERC165 {
    /**
     * @dev Emitted when `tokenId` token is transferred from `from` to `to`.
     */
    event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
     */
    event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);

    /**
     * @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
     */
    event ApprovalForAll(address indexed owner, address indexed operator, bool approved);

    /**
     * @dev Returns the number of tokens in ``owner``'s account.
     */
    function balanceOf(address owner) external view returns (uint256 balance);

    /**
     * @dev Returns the owner of the `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function ownerOf(uint256 tokenId) external view returns (address owner);

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
     *   a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;

    /**
     * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
     * are aware of the ERC-721 protocol to prevent tokens from being forever locked.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must exist and be owned by `from`.
     * - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
     *   {setApprovalForAll}.
     * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
     *   a safe transfer.
     *
     * Emits a {Transfer} event.
     */
    function safeTransferFrom(address from, address to, uint256 tokenId) external;

    /**
     * @dev Transfers `tokenId` token from `from` to `to`.
     *
     * WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC-721
     * or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
     * understand this adds an external call which potentially creates a reentrancy vulnerability.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `tokenId` token must be owned by `from`.
     * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(address from, address to, uint256 tokenId) external;

    /**
     * @dev Gives permission to `to` to transfer `tokenId` token to another account.
     * The approval is cleared when the token is transferred.
     *
     * Only a single account can be approved at a time, so approving the zero address clears previous approvals.
     *
     * Requirements:
     *
     * - The caller must own the token or be an approved operator.
     * - `tokenId` must exist.
     *
     * Emits an {Approval} event.
     */
    function approve(address to, uint256 tokenId) external;

    /**
     * @dev Approve or remove `operator` as an operator for the caller.
     * Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
     *
     * Requirements:
     *
     * - The `operator` cannot be the address zero.
     *
     * Emits an {ApprovalForAll} event.
     */
    function setApprovalForAll(address operator, bool approved) external;

    /**
     * @dev Returns the account approved for `tokenId` token.
     *
     * Requirements:
     *
     * - `tokenId` must exist.
     */
    function getApproved(uint256 tokenId) external view returns (address operator);

    /**
     * @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
     *
     * See {setApprovalForAll}
     */
    function isApprovedForAll(address owner, address operator) external view returns (bool);
}

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

pragma solidity ^0.8.20;

/**
 * @title ERC-721 token receiver interface
 * @dev Interface for any contract that wants to support safeTransfers
 * from ERC-721 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) (token/ERC721/utils/ERC721Holder.sol)

pragma solidity ^0.8.20;

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

/**
 * @dev Implementation of the {IERC721Receiver} interface.
 *
 * Accepts all token transfers.
 * Make sure the contract is able to use its token with {IERC721-safeTransferFrom}, {IERC721-approve} or
 * {IERC721-setApprovalForAll}.
 */
abstract contract ERC721Holder is IERC721Receiver {
    /**
     * @dev See {IERC721Receiver-onERC721Received}.
     *
     * Always returns `IERC721Receiver.onERC721Received.selector`.
     */
    function onERC721Received(address, address, uint256, bytes memory) public virtual returns (bytes4) {
        return this.onERC721Received.selector;
    }
}

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

pragma solidity ^0.8.20;

import {IERC721Receiver} from "../IERC721Receiver.sol";
import {IERC721Errors} from "../../../interfaces/draft-IERC6093.sol";

/**
 * @dev Library that provide common ERC-721 utility functions.
 *
 * See https://eips.ethereum.org/EIPS/eip-721[ERC-721].
 *
 * _Available since v5.1._
 */
library ERC721Utils {
    /**
     * @dev Performs an acceptance check for the provided `operator` by calling {IERC721-onERC721Received}
     * on the `to` address. The `operator` is generally the address that initiated the token transfer (i.e. `msg.sender`).
     *
     * The acceptance call is not executed and treated as a no-op if the target address doesn't contain code (i.e. an EOA).
     * Otherwise, the recipient must implement {IERC721Receiver-onERC721Received} and return the acceptance magic value to accept
     * the transfer.
     */
    function checkOnERC721Received(
        address operator,
        address from,
        address to,
        uint256 tokenId,
        bytes memory data
    ) internal {
        if (to.code.length > 0) {
            try IERC721Receiver(to).onERC721Received(operator, from, tokenId, data) returns (bytes4 retval) {
                if (retval != IERC721Receiver.onERC721Received.selector) {
                    // Token rejected
                    revert IERC721Errors.ERC721InvalidReceiver(to);
                }
            } catch (bytes memory reason) {
                if (reason.length == 0) {
                    // non-IERC721Receiver implementer
                    revert IERC721Errors.ERC721InvalidReceiver(to);
                } else {
                    assembly ("memory-safe") {
                        revert(add(32, reason), mload(reason))
                    }
                }
            }
        }
    }
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Collection of functions related to the address type
 */
library Address {
    /**
     * @dev There's no code at `target` (it is not a contract).
     */
    error AddressEmptyCode(address target);

    /**
     * @dev Replacement for Solidity's `transfer`: sends `amount` wei to
     * `recipient`, forwarding all available gas and reverting on errors.
     *
     * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
     * of certain opcodes, possibly making contracts go over the 2300 gas limit
     * imposed by `transfer`, making them unable to receive funds via
     * `transfer`. {sendValue} removes this limitation.
     *
     * https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
     *
     * IMPORTANT: because control is transferred to `recipient`, care must be
     * taken to not create reentrancy vulnerabilities. Consider using
     * {ReentrancyGuard} or the
     * https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
     */
    function sendValue(address payable recipient, uint256 amount) internal {
        if (address(this).balance < amount) {
            revert Errors.InsufficientBalance(address(this).balance, amount);
        }

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

    /**
     * @dev Performs a Solidity function call using a low level `call`. A
     * plain `call` is an unsafe replacement for a function call: use this
     * function instead.
     *
     * If `target` reverts with a revert reason or custom error, it is bubbled
     * up by this function (like regular Solidity function calls). However, if
     * the call reverted with no returned reason, this function reverts with a
     * {Errors.FailedCall} error.
     *
     * Returns the raw returned data. To convert to the expected return value,
     * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
     *
     * Requirements:
     *
     * - `target` must be a contract.
     * - calling `target` with `data` must not revert.
     */
    function functionCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionCallWithValue(target, data, 0);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but also transferring `value` wei to `target`.
     *
     * Requirements:
     *
     * - the calling contract must have an ETH balance of at least `value`.
     * - the called Solidity function must be `payable`.
     */
    function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
        if (address(this).balance < value) {
            revert Errors.InsufficientBalance(address(this).balance, value);
        }
        (bool success, 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 {Errors.FailedCall}) 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 {Errors.FailedCall} 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 {Errors.FailedCall}.
     */
    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
            assembly ("memory-safe") {
                let returndata_size := mload(returndata)
                revert(add(32, returndata), returndata_size)
            }
        } else {
            revert Errors.FailedCall();
        }
    }
}

// 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.1.0) (utils/Errors.sol)

pragma solidity ^0.8.20;

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

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.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 ERC-165 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.1.0) (utils/introspection/IERC165.sol)

pragma solidity ^0.8.20;

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

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

pragma solidity ^0.8.20;

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

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

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

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

    /**
     * @dev Returns the multiplication of two unsigned integers, with an success flag (no overflow).
     */
    function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        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 success flag (no division by zero).
     */
    function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
        unchecked {
            if (b == 0) return (false, 0);
            return (true, a / b);
        }
    }

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

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

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

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

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

    /**
     * @dev Returns the ceiling of the division of two numbers.
     *
     * This differs from standard division with `/` in that it rounds towards infinity instead
     * of rounding towards zero.
     */
    function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
        if (b == 0) {
            // Guarantee the same behavior as in a regular Solidity division.
            Panic.panic(Panic.DIVISION_BY_ZERO);
        }

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

    /**
     * @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
     * denominator == 0.
     *
     * Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
     * Uniswap Labs also under MIT license.
     */
    function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
        unchecked {
            // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
            // the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
            // variables such that product = prod1 * 2²⁵⁶ + 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²⁵⁶. Also prevents denominator == 0.
            if (denominator <= prod1) {
                Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
            }

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

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

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

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

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

            // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
            // works in modular arithmetic, doubling the correct bits in each step.
            inverse *= 2 - denominator * inverse; // inverse mod 2⁸
            inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
            inverse *= 2 - denominator * inverse; // inverse mod 2³²
            inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
            inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
            inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        uint256 mLen = m.length;

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

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

    /**
     * @dev Returns whether the provided byte array is zero.
     */
    function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
        for (uint256 i = 0; i < byteArray.length; ++i) {
            if (byteArray[i] != 0) {
                return false;
            }
        }
        return true;
    }

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

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

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

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

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

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

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

    /**
     * @dev Return the log in base 2 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     */
    function log2(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        uint256 exp;
        unchecked {
            exp = 128 * SafeCast.toUint(value > (1 << 128) - 1);
            value >>= exp;
            result += exp;

            exp = 64 * SafeCast.toUint(value > (1 << 64) - 1);
            value >>= exp;
            result += exp;

            exp = 32 * SafeCast.toUint(value > (1 << 32) - 1);
            value >>= exp;
            result += exp;

            exp = 16 * SafeCast.toUint(value > (1 << 16) - 1);
            value >>= exp;
            result += exp;

            exp = 8 * SafeCast.toUint(value > (1 << 8) - 1);
            value >>= exp;
            result += exp;

            exp = 4 * SafeCast.toUint(value > (1 << 4) - 1);
            value >>= exp;
            result += exp;

            exp = 2 * SafeCast.toUint(value > (1 << 2) - 1);
            value >>= exp;
            result += exp;

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

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

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

    /**
     * @dev Return the log in base 256 of a positive value rounded towards zero.
     * Returns 0 if given 0.
     *
     * Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
     */
    function log256(uint256 value) internal pure returns (uint256) {
        uint256 result = 0;
        uint256 isGt;
        unchecked {
            isGt = SafeCast.toUint(value > (1 << 128) - 1);
            value >>= isGt * 128;
            result += isGt * 16;

            isGt = SafeCast.toUint(value > (1 << 64) - 1);
            value >>= isGt * 64;
            result += isGt * 8;

            isGt = SafeCast.toUint(value > (1 << 32) - 1);
            value >>= isGt * 32;
            result += isGt * 4;

            isGt = SafeCast.toUint(value > (1 << 16) - 1);
            value >>= isGt * 16;
            result += isGt * 2;

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

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

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

pragma solidity ^0.8.20;

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

pragma solidity ^0.8.20;

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

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

    uint256 private _status;

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

    constructor() {
        _status = NOT_ENTERED;
    }

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

    struct BooleanSlot {
        bool value;
    }

    struct Bytes32Slot {
        bytes32 value;
    }

    struct Uint256Slot {
        uint256 value;
    }

    struct Int256Slot {
        int256 value;
    }

    struct StringSlot {
        string value;
    }

    struct BytesSlot {
        bytes value;
    }

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

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

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

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

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

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

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.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;
            assembly ("memory-safe") {
                ptr := add(buffer, add(32, length))
            }
            while (true) {
                ptr--;
                assembly ("memory-safe") {
                    mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
                }
                value /= 10;
                if (value == 0) break;
            }
            return buffer;
        }
    }

    /**
     * @dev Converts a `int256` to its ASCII `string` decimal representation.
     */
    function toStringSigned(int256 value) internal pure returns (string memory) {
        return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
     */
    function toHexString(uint256 value) internal pure returns (string memory) {
        unchecked {
            return toHexString(value, Math.log256(value) + 1);
        }
    }

    /**
     * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
     */
    function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
        uint256 localValue = value;
        bytes memory buffer = new bytes(2 * length + 2);
        buffer[0] = "0";
        buffer[1] = "x";
        for (uint256 i = 2 * length + 1; i > 1; --i) {
            buffer[i] = HEX_DIGITS[localValue & 0xf];
            localValue >>= 4;
        }
        if (localValue != 0) {
            revert StringsInsufficientHexLength(value, length);
        }
        return string(buffer);
    }

    /**
     * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
     * representation.
     */
    function toHexString(address addr) internal pure returns (string memory) {
        return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
    }

    /**
     * @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
     * representation, according to EIP-55.
     */
    function toChecksumHexString(address addr) internal pure returns (string memory) {
        bytes memory buffer = bytes(toHexString(addr));

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

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

    /**
     * @dev 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.1.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;

        assembly ("memory-safe") {
            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;

        assembly ("memory-safe") {
            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;

        assembly ("memory-safe") {
            result := store
        }

        return result;
    }
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import "./interfaces/IGaugeV1.sol";

contract GaugeV1 is IGaugeV1, UUPSUpgradeable, OwnableUpgradeable {
    using SafeERC20 for IERC20;

    /// @notice The duration of an epoch in seconds.
    uint256 public constant EPOCH_DURATION = 1 weeks;

    /// @notice The address of the Merkl distribution contract on Arbitrum.
    IDistributionCreator public constant DISTRIBUTION_CREATOR = IDistributionCreator(0x8BB4C975Ff3c250e0ceEA271728547f3802B36Fd);

    /// @notice The address of the escrow vote manager contract responsible for managing votes and gauges.
    address public s_escrowVoteManager;

    /// @notice The EYWA token used for rewards distribution within the gauge.
    address public s_eywa;

    /// @notice The campaign parameters used for reward distribution.
    IDistributionCreator.CampaignParameters public s_campaignParameters;

    /// @custom:oz-upgrades-unsafe-allow constructor
    constructor() {
        _disableInitializers();
    }

    /// @inheritdoc IGaugeV1
    function initialize(
        address owner_,
        address escrowVoteManager_,
        address eywa_,
        IDistributionCreator.CampaignParameters calldata campaignParameters_
    ) 
        external
        initializer
    {
        __UUPSUpgradeable_init();
        __Ownable_init(owner_);
        s_escrowVoteManager = escrowVoteManager_;
        s_eywa = eywa_;
        s_campaignParameters = campaignParameters_;
    }

    /// @inheritdoc IGaugeV1
    function updateCampaignParameters(
        IDistributionCreator.CampaignParameters calldata newCampaignParameters_
    ) 
        external 
        onlyOwner 
    {
        emit CampaignParametersUpdated(address(this), s_campaignParameters, newCampaignParameters_);
        s_campaignParameters = newCampaignParameters_;
    }

    /// @inheritdoc IGaugeV1
    function notifyRewardAmount(uint256 amount_) external {
        if (msg.sender != s_escrowVoteManager) {
            revert UnauthorizedCaller();
        }
        IERC20 m_eywa = IERC20(s_eywa);
        m_eywa.safeTransferFrom(msg.sender, address(this), amount_);
        uint256 m_balance = m_eywa.balanceOf(address(this));
        if (m_balance * 1 hours / EPOCH_DURATION >= DISTRIBUTION_CREATOR.rewardTokenMinAmounts(address(m_eywa))) {
            m_eywa.approve(address(DISTRIBUTION_CREATOR), m_balance);
            IDistributionCreator.CampaignParameters memory m_campaignParameters = s_campaignParameters;
            m_campaignParameters.amount = m_balance;
            m_campaignParameters.startTimestamp = uint32(block.timestamp);
            m_campaignParameters.duration = uint32(EPOCH_DURATION);
            DISTRIBUTION_CREATOR.createCampaign(m_campaignParameters);
        }
        emit RewardNotified(amount_);
    }

    /// @inheritdoc UUPSUpgradeable
    function _authorizeUpgrade(address) internal override onlyOwner {}
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import "@openzeppelin/contracts/token/ERC721/IERC721.sol";

interface ICollection is IERC721 {
    /// @notice Enumeration representing the rarity levels of NFT tokens in the collection.
    /// @dev Defines the rarity category for each token in the NFT collection.
    enum Rarity { 
        NotSet,
        Common,
        Uncommon,
        Rare,
        Legendary,
        Infinity
    }

    /// @notice Unpins the specified vesting wallets from the given token ID.
    /// @dev Allows the owner of the token to unpin associated vesting wallets, detaching them from the NFT.
    /// This function iterates over the provided vesting wallets, ensures they are pinned to the token ID,
    /// calls the `unpin` function on each wallet, and updates the internal `pinnedWallets` mapping to remove the association.
    /// @param tokenId_ The ID of the token from which the wallets will be unpinned.
    /// @param vestingWallets_ An array of addresses of the vesting wallets to unpin.
    function unpinWallets(uint64 tokenId_, address[] memory vestingWallets_) external;

    /// @notice Returns the rarity level of a given NFT token.
    /// @param tokenId_ The identifier of the NFT token.
    /// @return The rarity level of the specified token.
    function rarity(uint256 tokenId_) external view returns (Rarity);

    /// @notice Returns the pinned vesting wallet associated with a token ID and vesting manager.
    /// @dev Fetches the address of the vesting wallet that is pinned to the specified token ID under the given vesting manager.
    /// The `pinnedWallets` mapping stores the association between token IDs, vesting managers, and their corresponding wallets.
    /// @param tokenId_ The ID of the token.
    /// @param vestingManager_ The address of the vesting manager contract.
    /// @return The address of the pinned vesting wallet associated with the token ID and vesting manager.
    function getPinnedWallets(uint64 tokenId_, address vestingManager_) external view returns (address[] memory);

    /// @notice Retrieves the list of known vesting manager addresses.
    /// @dev The contract maintains an array of vesting manager addresses that are recognized and have interacted with the NFT tokens.
    /// This function provides access to that array, allowing callers to obtain the full list of vesting managers.
    /// @return An array containing the addresses of all known vesting managers.
    function getVestingManagers() external view returns (address[] memory);

    /// @notice Returns the total balance of the EYWA token for a specific tokenId across all vesting managers.
    /// @param tokenId_ The ID of the token for which the balance is being retrieved.
    /// @return The total balance of EYWA tokens held by the associated wallets.
    function walletsBalance(uint64 tokenId_) external view returns (uint256);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

interface IDistributionCreator {
    /// @notice Parameters defining a campaign.
    /// @param campaignId ID of the campaign. This can be left as a null bytes32 when creating campaigns on Merkl.
    /// @param creator Address of the campaign creator. If marked as address(0), 
    /// it will be overridden with the address of the `msg.sender` creating the campaign.
    /// @param rewardToken Address of the token used as a reward.
    /// @param amount Total amount of `rewardToken` to distribute across all the epochs. 
    /// The amount distributed per epoch is `amount/numEpoch`.
    /// @param campaignType Type of the campaign. Different campaign types can have specific rules and behaviors.
    /// @param startTimestamp Timestamp indicating when the campaign should start.
    /// @param duration Duration of the campaign in seconds. Must be a multiple of the EPOCH duration, which is 3600 seconds.
    /// @param campaignData Additional data to specify further details of the campaign.
    struct CampaignParameters {
        bytes32 campaignId;
        address creator;
        address rewardToken;
        uint256 amount;
        uint32 campaignType;
        uint32 startTimestamp;
        uint32 duration;
        bytes campaignData;
    }

    /// @notice Creates a new `campaign` to incentivize a specified pool over a certain period.
    /// @dev The campaign must be well-formed; otherwise, it will not be processed by the campaign script, and rewards could be lost.
    /// Reward tokens used in campaigns must be whitelisted beforehand, and the amount sent must exceed the minimum amount set for each token.
    /// This function reverts if the sender has not accepted the terms and conditions.
    /// @param newCampaign_ The parameters of the campaign being created.
    /// @return The unique ID of the newly created campaign.
    function createCampaign(CampaignParameters memory newCampaign_) external returns (bytes32);

    /// @notice Checks whether the `msg.sender`'s `signature` is compatible with the message to sign and stores the signature.
    /// @dev If you signed the message once, and the message has not been modified, then you do not need to sign again.
    function sign(bytes calldata signature_) external;

    /// @notice Sets the minimum amounts per distribution epoch for different reward tokens.
    function setRewardTokenMinAmounts(
        address[] calldata tokens_,
        uint256[] calldata amounts_
    ) 
        external;

    /// @notice Returns the minimum amount for the specified reward token that must be sent per epoch for a valid distribution.
    /// @param rewardToken_ The address of the reward token.
    /// @return The minimum amount of the token required for a valid distribution.
    function rewardTokenMinAmounts(address rewardToken_) external view returns (uint256);

    /// @notice Message that needs to be acknowledged by users creating a campaign.
    function message() external view returns (string memory);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

interface IVestingWallet {
    /// @notice Transfers the beneficiary to a new address.
    /// @dev Only callable by the DAO.
    /// @param beneficiary_ The address of the new beneficiary.
    function transfer(address beneficiary_) external;

    /// @notice Returns the address of the beneficiary.
    /// @return The beneficiary address.
    function beneficiary() external view returns (address);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

interface IWalletFactory {
    /// @notice Checks if the specified address is a valid vesting wallet.
    /// @param vestingWallet_ The vesting wallet address to verify.
    /// @return Returns true if the address is a valid vesting wallet, otherwise false.
    function isValidWallet(address vestingWallet_) external view returns (bool);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";

import {IRebaseRewardsDistributorV1} from "./IRebaseRewardsDistributorV1.sol";
import {IEscrowVoteManagerV1} from "./IEscrowVoteManagerV1.sol";
import {IEscrowManager} from "./IEscrowManager.sol";

interface IEmissionManagerV1 {
    /// @notice Thrown when the caller is not authorized to execute the function.
    error InvalidCallee();

    /// @notice Thrown when the epoch counter is equal to zero.
    error ZeroEpochCounter();

    /// @notice Thrown when the required cooldown period between changes has not yet elapsed.
    error CooldownPeriodNotElapsed();

    /// @notice Thrown when the emission increase exceeds the allowed maximum percentage.
    error ExcessiveEmissionIncrease();

    /// @notice Thrown when the sum of all emission percentages is not equal to 100% (PRECISION).
    error InvalidPercentagesSum();

    /// @notice Emitted when emission distributor addresses are updated.
    /// @param newBondEmissionDistributor Address of the new bond emission distributor.
    /// @param newGrantEmissionDistributor Address of the new grant emission distributor.
    /// @param newIncentiveEmissionDistributor Address of the new incentive emission distributor.
    event EmissionDistributorsUpdated(
        address newBondEmissionDistributor,
        address newGrantEmissionDistributor,
        address newIncentiveEmissionDistributor
    );

    /// @notice Emitted when the weekly emission state is updated.
    /// @param newWeeklyEmission The new weekly emission amount in EYWA tokens.
    /// @param newGaugeEmissionPercentage_ The new percentage allocated for gauge rewards.
    /// @param newBondEmissionPercentage_ The new percentage allocated for bond rewards.
    /// @param newGrantEmissionPercentage_ The new percentage allocated for grants.
    /// @param newIncentiveEmissionPercentage_ The new percentage allocated for incentives.
    event WeeklyEmissionStateUpdated(
        uint256 newWeeklyEmission, 
        uint256 newGaugeEmissionPercentage_,
        uint256 newBondEmissionPercentage_,
        uint256 newGrantEmissionPercentage_,
        uint256 newIncentiveEmissionPercentage_
    );

    /// @notice Emitted when the adjustment factor calculation parameters are updated.
    /// @param lockThreshold The updated threshold of total locked tokens.
    /// @param baseRateBelowThreshold The updated base rate when total locked tokens are below the threshold.
    /// @param rateMultiplierBelowThreshold The updated rate multiplier when total locked tokens are below the threshold.
    /// @param baseRateAboveThreshold The updated base rate when total locked tokens are above the threshold.
    /// @param rateMultiplierAboveThreshold The updated rate multiplier when total locked tokens are above the threshold.
    /// @param initialInflationRate The updated inflation rate used when the total locked tokens are below the threshold.
    /// @param secondaryInflationRate The updated inflation rate used when the total locked tokens are above the threshold.
    event ParametersUpdated(
        uint256 lockThreshold,
        uint256 baseRateBelowThreshold,
        uint256 rateMultiplierBelowThreshold,
        uint256 baseRateAboveThreshold,
        uint256 rateMultiplierAboveThreshold,
        uint256 initialInflationRate,
        uint256 secondaryInflationRate
    );

    /// @notice Emitted when a new epoch is updated and emissions are distributed.
    /// @param epochStartTimestamp The timestamp marking the start of the new epoch.
    /// @param totalEmission The total emission amount for the epoch in EYWA tokens.
    /// @param rebaseEmission The amount of emissions allocated for rebase rewards.
    /// @param gaugeEmission The amount of emissions allocated for gauge rewards.
    /// @param bondEmission The amount of emissions allocated for bond rewards.
    /// @param grantEmission The amount of emissions allocated for grants.
    /// @param incentiveEmission The amount of emissions allocated for incentives.
    event EpochUpdated(
        uint256 epochStartTimestamp,
        uint256 totalEmission,
        uint256 rebaseEmission,
        uint256 gaugeEmission,
        uint256 bondEmission,
        uint256 grantEmission,
        uint256 incentiveEmission
    );

    /// @notice Returns the timestamp marking the start of the current emission epoch.
    /// @return The timestamp of the start of the current emission epoch.
    function s_currentEpochStart() external view returns (uint256);

    /// @notice Returns the address of the treasury from where emissions are distributed.
    /// @return The address of the treasury.
    function s_treasury() external view returns (address);

    /// @notice Initializes the emission manager with the required parameters.
    /// @param owner_ Address of the contract owner.
    /// @param treasury_ Address of the treasury from where emissions will be distributed.
    /// @param rebaseRewardsDistributor_ Address of the distributor for rebase rewards.
    /// @param bondEmissionDistributor_ Address of the distributor for bond emissions.
    /// @param grantEmissionDistributor_ Address of the distributor for grant emissions.
    /// @param incentiveEmissionDistributor_ Address of the distributor for incentive emissions.
    /// @param escrowVoteManager_ Address of the escrow vote manager contract.
    /// @param escrowManager_ Address of the escrow manager contract.
    /// @param eywa_ Address of the EYWA token used for emissions.
    function initialize(
        address owner_,
        address treasury_,
        address rebaseRewardsDistributor_,
        address bondEmissionDistributor_,
        address grantEmissionDistributor_,
        address incentiveEmissionDistributor_,
        IEscrowVoteManagerV1 escrowVoteManager_,
        IEscrowManager escrowManager_,
        IERC20 eywa_
    ) 
        external;
    
    /// @notice Updates the addresses of emission distributors for bonds, grants, and incentives.
    /// @param newBondEmissionDistributor_ The address of the new bond emission distributor.
    /// @param newGrantEmissionDistributor_ The address of the new grant emission distributor.
    /// @param newIncentiveEmissionDistributor_ The address of the new incentive emission distributor.
    function updateEmissionDistributors(
        address newBondEmissionDistributor_,
        address newGrantEmissionDistributor_,
        address newIncentiveEmissionDistributor_
    )
        external;

    /// @notice Updates the state of the weekly emission and the percentage distribution.
    /// @param newWeeklyEmission_ New weekly emission value in EYWA tokens.
    /// @param newGaugeEmissionPercentage_ New percentage of emissions allocated for gauge rewards.
    /// @param newBondEmissionPercentage_ New percentage of emissions allocated for bond rewards.
    /// @param newGrantEmissionPercentage_ New percentage of emissions allocated for grants.
    /// @param newIncentiveEmissionPercentage_ New percentage of emissions allocated for incentives.
    function updateWeeklyEmissionState(
        uint256 newWeeklyEmission_,
        uint256 newGaugeEmissionPercentage_,
        uint256 newBondEmissionPercentage_,
        uint256 newGrantEmissionPercentage_,
        uint256 newIncentiveEmissionPercentage_
    )   
        external;
    
    /// @notice Updates the parameters used in the calculation of the adjustment factor for emissions.
    /// @param lockThreshold_ The new threshold of total locked tokens.
    /// @param baseRateBelowThreshold_ The new base rate when total locked tokens are below the threshold.
    /// @param rateMultiplierBelowThreshold_ The new rate multiplier when total locked tokens are below the threshold.
    /// @param baseRateAboveThreshold_ The new base rate when total locked tokens are above the threshold.
    /// @param rateMultiplierAboveThreshold_ The new rate multiplier when total locked tokens are above the threshold.
    /// @param initialInflationRate_ The new inflation rate used when the total locked tokens are below the threshold.
    /// @param secondaryInflationRate_ The new inflation rate used when the total locked tokens are above the threshold.
    function updateParameters(
        uint256 lockThreshold_,
        uint256 baseRateBelowThreshold_,
        uint256 rateMultiplierBelowThreshold_,
        uint256 baseRateAboveThreshold_,
        uint256 rateMultiplierAboveThreshold_,
        uint256 initialInflationRate_,
        uint256 secondaryInflationRate_
    )
        external;
    
    /// @notice Updates the current epoch, calculates and distributes the weekly emissions.
    /// @dev Emits an `EpochUpdated` event upon completion.
    function updateEpoch() external;

    /// @notice Returns the average weekly emission over the elapsed epochs.
    /// @return The average weekly emission amount in EYWA tokens.
    function averageWeeklyEmissionOverTime() external view returns (uint256);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {ERC721Enumerable, ERC721, IERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
import {ERC721Holder} from "@openzeppelin/contracts/token/ERC721/utils/ERC721Holder.sol";
import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";

import {IVestingWallet} from "./external/IVestingWallet.sol";
import {ICollection} from "./external/ICollection.sol";
import {IWalletFactory} from "./external/IWalletFactory.sol";
import {IEscrowVoteManagerV1} from "./IEscrowVoteManagerV1.sol";
import {IMetadataProviderV1} from "./IMetadataProviderV1.sol";

import {VotingPowerHelper} from "../libraries/VotingPowerHelper.sol";

interface IEscrowManager is IERC721Enumerable {
    /// @notice Enum representing different types of lock modifications that can be applied to a locked position.
    enum LockModificationType {
        CREATION,   /// Indicates the initial creation of a lock.
        CREATION2,  /// Indicates a secondary creation.
        DEPOSIT,    /// Represents depositing additional tokens into an existing lock.
        BOOST,      /// Represents adding a booster NFT to enhance the lock's multiplier.
        DEBOOST,    /// Represents removing a booster NFT from the lock.
        EXTENSION,  /// Represents extending the lock duration.
        MERGE,      /// Represents merging multiple locks into a single lock.
        SPLIT       /// Represents splitting one lock into multiple new locks.
    }

    /// @notice Structure that stores information about a locked position.
    /// @param lockAmount The amount of tokens currently locked.
    /// @param unlockTime The timestamp (in seconds) when the lock will be eligible for unlocking.
    /// @param vestingWallets The array of vesting wallet contract addresses.
    struct LockInfo {
        int128 lockAmount;
        uint256 unlockTime;
        address[] vestingWallets;
    }

    /// @notice Structure that represents a voting power point for a specific epoch or lock state.
    /// @param weight The voting power weight attributed to this lock, which may change over time.
    /// @param rateOfChange The rate at which the voting power is changing over a specific time interval.
    /// @param timestamp The block timestamp when this voting power point was recorded.
    /// @param blockNumber The block number when this voting power point was registered on-chain.
    struct VotingPowerPoint {
        int128 weight;
        int128 rateOfChange;
        uint256 timestamp;
        uint256 blockNumber;
    }

    /// @notice Represents a snapshot of token ownership at a specific point in time.
    /// @param timestamp The timestamp at which the checkpoint was recorded.
    /// @param tokenIds An array of token IDs associated with the checkpoint at the given timestamp.
    struct Checkpoint {
        uint256 timestamp;
        uint256[] tokenIds;
    }

    /// @notice Thrown when the specified beneficiary address is invalid.
    error InvalidBeneficiary();

    /// @notice Thrown when the specified vesting wallet address is invalid.
    error InvalidVestingWallet();

    /// @notice Thrown when the specified lock duration is either too short or exceeds the maximum allowable duration.
    error InvalidLockDuration();
    
    /// @notice Thrown when the lock amount is less than the required minimum or exceeds available balances.
    error InvalidLockAmount();

    /// @notice Thrown when a provided collection token ID does not correspond to a valid or active token.
    /// @param tokenId The ID of the collection token that is considered invalid.
    error InvalidCollectionTokenId(uint256 tokenId);

    /// @notice Thrown when the length of an input array does not meet expected requirements.
    error InvalidArrayLength();

    /// @notice Thrown when a specified rarity value does not match any valid rarity type.
    error InvalidRarity();

    /// @notice Thrown when the specified token ID does not exist.
    error NonExistentToken();

    /// @notice Thrown when attempting to extend the unlock time, but the new time is not greater than the current unlock time.
    error ExtendedUnlockTimeMustBeGreater();

    /// @notice Thrown when the number of attachments (vesting wallets or boosters) exceeds the allowed limit.
    error AttachmentsLimitExceeded();

    /// @notice Thrown when trying to modify or operate on a lock that is still active and cannot be withdrawn.
    error LockStillActive();

    /// @notice Thrown when trying to modify or operate on a lock that is currently participating in a vote.
    error LockCurrentlyVoting();

    /// @notice Thrown when the number of delegates assigned to an address exceeds the allowed maximum.
    error MaximumNumberOfDelegatesExceeded();

    /// @notice Thrown when attempting to modify boosts for a token that has already voted in the current epoch.
    error BoostModificationAfterVoting();

    /// @notice Thrown when the caller is not authorized to perform the action.
    error UnauthorizedCaller();

    /// @notice Thrown when attempting to transfer a token during the cooldown period after a deboost operation.
    error TransferFrozenDueToDeboost();

    /// @notice Emitted when a locked amount is withdrawn by the owner or beneficiary.
    /// @param recipient The address that receives the withdrawn tokens.
    /// @param tokenId The unique identifier of the token representing the locked position.
    /// @param value The amount of tokens that have been withdrawn from the lock.
    event LockWithdrawn(address indexed recipient, uint256 indexed tokenId, uint256 indexed value);

    /// @notice Creates a new lock with the specified amount and duration.
    /// @dev This function locks a specific amount of EYWA tokens for a given duration.
    /// @param lockAmount_ The amount of EYWA tokens to be locked.
    /// @param lockDuration_ The duration for which the tokens will be locked, in seconds.
    /// @param recipient_ The address that will receive the locked position (ownership of the lock).
    function createLock(uint256 lockAmount_, uint256 lockDuration_, address recipient_) external;

    /// @notice Creates a lock with a specified duration for multiple vesting wallets.
    /// @dev This function transfers vesting wallets to the contract and creates a lock for the tokens associated with the vesting wallets. 
    /// The beneficiary of each vesting wallet must be the caller.
    /// @param lockDuration_ The duration for which the tokens will be locked, in seconds.
    /// @param recipient_ The address that will receive the locked position (ownership of the lock).
    /// @param vestingWallets_ An array of vesting wallet addresses that will be transferred and locked.
    function createLock(uint256 lockDuration_, address recipient_, address[] calldata vestingWallets_) external;

    /// @notice Creates a new lock using the specified lock duration and collection token IDs.
    /// @dev This function allows the caller to create a lock by utilizing tokens associated with the provided collection token IDs.
    /// It accumulates the total lock amount from the balances of the specified collection tokens,
    /// collects the associated vesting wallets, and creates a lock with the accumulated amount.
    /// Boosters from the collection tokens are applied to the new lock, enhancing its properties.
    /// After the lock is created, the function unpins the vesting wallets from the collection tokens.
    /// @param lockDuration_ The duration for which the tokens will be locked, in seconds. 
    /// Must be between `MINIMUM_LOCK_DURATION` and `MAXIMUM_LOCK_DURATION`.
    /// @param recipient_ The address that will receive the locked position (ownership of the lock).
    /// @param collectionTokenIds_ An array of collection token IDs whose associated tokens and vesting wallets 
    /// will be used to create the lock.
    function createLock(uint256 lockDuration_, address recipient_, uint256[] calldata collectionTokenIds_) external;

    /// @notice Deposits additional tokens into an existing lock identified by a token ID.
    /// @dev This function adds more EYWA tokens to an existing lock.
    /// It checks that the caller is authorized to make the deposit.
    /// @param tokenId_ The ID of the token representing the lock.
    /// @param lockAmount_ The amount of EYWA tokens to be added to the lock.
    function deposit(uint256 tokenId_, uint256 lockAmount_) external;

    /// @notice Deposits additional tokens into an existing lock on behalf of a recipient.
    /// @dev This function adds more EYWA tokens to an existing lock without checking authorization.
    /// @param tokenId_ The ID of the token representing the lock.
    /// @param lockAmount_ The amount of EYWA tokens to be added to the lock.
    function depositFor(uint256 tokenId_, uint256 lockAmount_) external;

    /// @notice Boosts an existing lock by associating it with additional tokens from the collection.
    /// @dev This function allows the lock owner to boost the lock by adding specified collection tokens.
    /// The caller must be authorized to perform this action.
    /// @param tokenId_ The ID of the token representing the lock.
    /// @param collectionTokenIds_ An array of token IDs from the collection that will be used to boost the lock.
    function boost(uint256 tokenId_, uint256[] calldata collectionTokenIds_) external;

    /// @notice Removes the boost from an existing lock by dissociating it from specified collection tokens.
    /// @dev This function allows the lock owner to deboost the lock by removing specified collection tokens.
    /// The function checks that the tokens being removed were previously associated with the lock.
    /// The caller must be authorized to perform this action.
    /// @param tokenId_ The ID of the token representing the lock.
    /// @param collectionTokenIds_ An array of token IDs from the collection that will be removed from the lock.
    function deboost(uint256 tokenId_, uint256[] calldata collectionTokenIds_) external;

    /// @notice Withdraws tokens from an expired lock and burns the associated token.
    /// @dev This function allows the lock owner to withdraw tokens after the lock period has expired.
    /// It transfers any associated collection tokens back to the caller and burns the lock token.
    /// If the lock was associated with a vesting wallet, the tokens are transferred back to the caller.
    /// The caller must be authorized to perform this action.
    /// @param tokenId_ The ID of the token representing the lock.
    function withdraw(uint256 tokenId_) external;

    /// @notice Extends the lock duration for a specified token.
    /// @dev This function allows the lock owner to extend the lock duration.
    /// The new unlock time must be greater than the current unlock time.
    /// The caller must be authorized to perform this action.
    /// @param tokenId_ The ID of the token representing the lock.
    /// @param lockDuration_ The new duration to extend the lock by.
    function extend(uint256 tokenId_, uint256 lockDuration_) external;

    /// @notice Sets the vote status for a given tokenId.
    /// @dev This function can only be called by the `ESCROW_VOTE_MANAGER`.
    /// @param tokenId_ The ID of the token for which the vote status is being set.
    /// @param status_ A boolean value indicating the vote status (true for voted, false for not voted).
    function setVoteStatus(uint256 tokenId_, bool status_) external;

    /// @notice Marks a token as having voted in the current epoch.
    /// @dev This function can only be called by the `ESCROW_VOTE_MANAGER`.
    /// @param tokenId_ The identifier of the token to mark as voted.
    /// @param status_ A boolean value indicating the vote status (true for voted, false for not voted).
    function registerTokenVote(uint256 tokenId_, bool status_) external;

    /// @notice Moves voting power from one account to another when delegated.
    /// @dev This function is called by the delegation manager to transfer voting power for a specific token ID
    /// from one address to another. Only the delegation manager contract can call this function.
    /// @param tokenId_ The ID of the token whose voting power is being transferred.
    /// @param from_ The address from which the voting power is being transferred.
    /// @param to_ The address to which the voting power is being transferred.
    function moveVotes(uint256 tokenId_, address from_, address to_) external;

    /// @notice Returns the total amount of EYWA tokens currently locked in the contract.
    /// @return The total locked EYWA tokens.
    function s_totalLocked() external view returns (uint256);

    /// @notice Returns the last recorded owner of a token with the specified ID.
    /// @param tokenId_ The ID of the token.
    /// @return The address of the last owner of the token.
    function s_lastOwnerByTokenId(uint256 tokenId_) external view returns (address);

    /// @notice Returns the epoch associated with a specific token ID.
    /// @param tokenId_ The ID of the token.
    /// @return The epoch associated with the given token ID.
    function s_epochByTokenId(uint256 tokenId_) external view returns (uint256);
    
    /// @notice Retrieves the voting power point associated with a specific token ID and epoch.
    /// @param tokenId_ The ID of the token for which the voting power point is requested.
    /// @param epoch_ The epoch number for which the voting power point is requested.
    /// @return weight_ The voting weight of the token at the specified epoch.
    /// @return rateOfChange_ The rate at which the voting weight is changing at the specified epoch.
    /// @return timestamp_ The timestamp when the voting power point was recorded.
    /// @return blockNumber_ The block number when the voting power point was recorded.
    function s_votingPowerPointByTokenIdAndEpoch(
        uint256 tokenId_,
        uint256 epoch_
    ) 
        external 
        view 
        returns (
            int128 weight_,
            int128 rateOfChange_,
            uint256 timestamp_,
            uint256 blockNumber_
        );

    /// @notice Retrieves the lock information associated with a specific token ID.
    /// @param tokenId_ The ID of the token to query.
    /// @return lockAmount_ The amount of tokens locked in the escrow.
    /// @return unlockTime_ The timestamp when the lock expires.
    /// @return vestingWallets_ An array of vesting wallet addresses associated with the lock.
    function getLockInfoByTokenId(
        uint256 tokenId_
    ) 
        external 
        view 
        returns (
            int128 lockAmount_,
            uint256 unlockTime_,
            address[] memory vestingWallets_
        );
    
    /// @notice Calculates the remaining freeze time for a specific lock after a deboost operation.
    /// @dev Returns the remaining time (in seconds) until the lock can be transferred.
    /// If the freeze period has already elapsed, the function returns 0.
    /// @param tokenId_ The ID of the lock to check.
    /// @return The remaining freeze time in seconds. Returns 0 if the freeze period has elapsed.
    function getRemainingFreezeTimeByTokenId(uint256 tokenId_) external view returns (uint256);

    /// @notice Retrieves a specific checkpoint for an account.
    /// @param account_ The address of the account to retrieve the checkpoint for.
    /// @param index_ The index of the checkpoint to retrieve.
    /// @return The checkpoint data at the specified index for the account.
    function getCheckpoint(address account_, uint32 index_) external view returns (Checkpoint memory);

    /// @notice Retrieves the current voting power of an account.
    /// @param account_ The address of the account to check.
    /// @return votes_ The total current voting power of the account.
    function getVotes(address account_) external view returns (uint256 votes_);

    /// @notice Retrieves the voting power of an account at a specified timestamp.
    /// @param account_ The address of the account to check.
    /// @param timestamp_ The specific timestamp to retrieve voting power at.
    /// @return votes_ The voting power of the account at the given timestamp.
    function getPastVotes(address account_, uint256 timestamp_) external view returns (uint256 votes_);

    /// @notice Retrieves the total voting power at the current timestamp.
    /// @dev This function returns the total voting power at the moment of the call.
    /// @return The total voting power at the current timestamp.
    function getTotalSupply() external view returns (uint256);

    /// @notice Retrieves the total supply of voting power at a specific timestamp.
    /// @param timestamp_ The timestamp to check the total supply of voting power.
    /// @return The total voting power at the specified timestamp.
    function getPastTotalSupply(uint256 timestamp_) external view returns (uint256);

    /// @notice Retrieves the voting power associated with a specific token ID at the current timestamp.
    /// @dev This function returns the voting power of a token unless its ownership was transferred in the current block.
    /// If the ownership changed in the current block, the function returns 0.
    /// @param tokenId_ The ID of the token for which to retrieve the voting power.
    /// @return The voting power of the specified token at the current timestamp, or 0 if ownership changed in the current block.
    function getVotesByTokenId(uint256 tokenId_) external view returns (uint256);

    /// @notice Retrieves the voting power associated with a specific token ID at a given timestamp.
    /// @dev This function returns the voting power of a token at a specific timestamp.
    /// @param tokenId_ The ID of the token for which to retrieve the voting power.
    /// @param timestamp_ The timestamp at which to retrieve the voting power.
    /// @return The voting power of the specified token at the given timestamp.
    function getPastVotesByTokenId(uint256 tokenId_, uint256 timestamp_) external view returns (uint256);

    /// @notice Retrieves the booster token IDs associated with a specific token ID.
    /// @dev This function returns an array of booster token IDs associated with the given token ID.
    /// @param tokenId_ The ID of the token for which to retrieve the boosters.
    /// @return boosters_ An array of booster token IDs associated with the specified token.
    function getBoostersByTokenId(uint256 tokenId_) external view returns (uint256[] memory boosters_);

    /// @notice Checks if `spender_` is authorized to manage the token with `tokenId_` owned by `owner_`.
    /// @param owner_ The address of the token owner.
    /// @param spender_ The address being checked for authorization.
    /// @param tokenId_ The ID of the token for which authorization is being checked.
    /// @return Returns `true` if `spender_` is authorized to manage the token, and `false` otherwise.
    function checkAuthorized(address owner_, address spender_, uint256 tokenId_) external view returns (bool);

    /// @notice Checks if a token with the specified ID exists.
    /// @param tokenId_ The ID of the token to check for existence.
    /// @return True if the token exists, false otherwise.
    function exists(uint256 tokenId_) external view returns (bool);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";

import {IEscrowManager} from "./IEscrowManager.sol";
import {IRewardsDistributorFactoryV1} from "./IRewardsDistributorFactoryV1.sol";
import {IGaugeFactoryV1} from "./IGaugeFactoryV1.sol";
import {IGaugeV1} from "./IGaugeV1.sol";
import {IEmissionManagerV1} from "./IEmissionManagerV1.sol";
import {IRewardsDistributor} from "./IRewardsDistributor.sol";
import {IDistributionCreator} from "./external/IDistributionCreator.sol";

interface IEscrowVoteManagerV1 {
    /// @notice Thrown when the specified gauge does not exist.
    error GaugeDoesNotExist();

    /// @notice Thrown when attempting to create a gauge that already exists.
    error GaugeAlreadyExists();

    /// @notice Thrown when the specified gauge is not active.
    error GaugeNotActive();

    /// @notice Thrown when the specified gauge is already active.
    error GaugeAlreadyActive();

    /// @notice Thrown when the caller is not authorized to perform the action.
    error UnauthorizedAccess();

    /// @notice Thrown when the lengths of input arrays do not match.
    error InvalidArrayLengths();

    /// @notice Thrown when an operation results in zero, which is not allowed.
    error ZeroEntry();

    /// @notice Thrown when attempting to vote again without resetting.
    error AlreadyVoted();

    /// @notice Emitted when the transfer freeze period after a deboost is updated.
    /// @param oldDuration The previous cooldown duration in seconds.
    /// @param newDuration The new cooldown duration in seconds.
    event TransferFreezeAfterDeboostUpdated(uint256 indexed oldDuration, uint256 indexed newDuration);

    /// @notice Emitted when a new gauge is created for a pool.
    /// @param pool The address of the pool for which the gauge is created.
    /// @param gauge The address of the newly created gauge.
    /// @param incentiveRewardsDistributor The address of the incentive rewards distributor associated with the gauge.
    event GaugeCreated(
        address indexed pool,
        address indexed gauge,
        address indexed incentiveRewardsDistributor
    );

    /// @notice Emitted when a gauge is killed (deactivated).
    /// @param gauge The address of the gauge that was killed.
    event GaugeKilled(address indexed gauge);

    /// @notice Emitted when a gauge is revived (reactivated).
    /// @param gauge The address of the gauge that was revived.
    event GaugeRevived(address indexed gauge);
    
    /// @notice Emitted when the whitelist status of multiple tokens is updated.
    /// @param operator The address of the caller who updated the whitelist status.
    /// @param tokens The addresses of the tokens whose whitelist status was updated.
    /// @param statuses The new whitelist statuses for the tokens (true to whitelist, false to remove).
    event WhitelistStatusUpdatedForTokens(address indexed operator, address[] tokens, bool[] statuses);

    /// @notice Emitted when a reward amount is notified and distributed.
    /// @param rewardAmount The amount of reward tokens that were distributed.
    event RewardNotified(uint256 indexed rewardAmount);

    /// @notice Emitted when a vote is cast for a specific pool.
    /// @param voter The address of the account that cast the vote.
    /// @param pool The address of the pool for which the vote was cast.
    /// @param tokenId The ID of the token used for voting.
    /// @param votes The number of votes allocated to the pool.
    event VoteCast(address voter, address indexed pool, uint256 indexed tokenId, uint256 indexed votes);

    /// @notice Emitted when votes are abstained (reset) for a specific pool.
    /// @param voter The address of the account that abstained from voting.
    /// @param pool The address of the pool from which the votes were removed.
    /// @param tokenId The ID of the token that was used to abstain.
    /// @param votes The number of votes that were abstained.
    event VotesAbstained(address voter, address indexed pool, uint256 indexed tokenId, uint256 indexed votes);

    /// @notice Emitted when rewards are distributed to a specific gauge.
    /// @param distributor The address that triggered the distribution.
    /// @param gauge The address of the gauge that received the rewards.
    /// @param rewardAmount The amount of rewards distributed to the gauge.
    event RewardsDistributed(address indexed distributor, address indexed gauge, uint256 indexed rewardAmount);

    /// @notice Checks whether a token is whitelisted.
    /// @param rewardToken_ The address of the token.
    /// @return Returns true if the token is whitelisted, otherwise false.
    function s_isWhitelistedToken(address rewardToken_) external view returns (bool);

    /// @notice Returns the address of the escrow manager.
    /// @return The address of the contract implementing the IEscrowManager interface.
    function s_escrowManager() external view returns (IEscrowManager);

    /// @notice Initializes the contract with the specified parameters.
    /// @param owner_ The address of the owner of the contract.
    /// @param emissionManager_ The address of the emission manager contract responsible for distributing rewards.
    /// @param eywa_ The address of the EYWA token contract.
    /// @param escrowManager_ The interface to the escrow manager contract.
    /// @param rewardsDistributorFactory_ The interface to the rewards distributor factory contract.
    /// @param gaugeFactory_ The interface to the gauge factory contract.
    /// @param whitelistedTokens_ The array of token addresses that are initially whitelisted for voting and reward distribution.
    function initialize(
        address owner_, 
        address emissionManager_,
        address eywa_,
        IEscrowManager escrowManager_, 
        IRewardsDistributorFactoryV1 rewardsDistributorFactory_,
        IGaugeFactoryV1 gaugeFactory_,
        address[] calldata whitelistedTokens_
    )
        external;
    
    /// @notice Updates the duration of the transfer freeze period after a deboost operation.
    /// @dev This function allows the owner to change the cooldown duration (in seconds) 
    /// during which token transfers are prohibited after a deboost.
    /// @param transferFreezeAfterDeboost_ The new cooldown duration in seconds.
    function updateTransferFreezeAfterDeboost(uint256 transferFreezeAfterDeboost_) external;

    /// @notice Creates a new gauge.
    /// @dev Only the contract owner or DAO can call this function.
    /// @param pool_ The address of the pool for which the gauge is to be created.
    /// @param campaignParameters_ The campaign parameters used for reward distribution.
    function createGauge(address pool_, IDistributionCreator.CampaignParameters calldata campaignParameters_) external;

    /// @notice Deactivates a gauge, preventing it from receiving future rewards.
    /// @dev Only the contract owner or DAO can call this function. Unclaimed rewards are returned to the emission manager.
    /// @param gauge_ The address of the gauge to deactivate.
    function killGauge(address gauge_) external;

    /// @notice Reactivates a previously deactivated gauge.
    /// @dev Only the contract owner or DAO can call this function. The gauge will start receiving rewards again.
    /// @param gauge_ The address of the gauge to reactivate.
    function reviveGauge(address gauge_) external;

    /// @notice Updates the whitelist status of specified tokens.
    /// @dev Only the contract owner or DAO can call this function.
    /// @param tokens_ The addresses of the tokens to update.
    /// @param statuses_ An array of booleans indicating the new whitelist statuses (true to whitelist, false to remove).
    function setWhitelistStatusForTokens(address[] calldata tokens_, bool[] calldata statuses_) external;

    /// @notice Allows a user to cast votes for multiple token IDs across multiple pools.
    /// @dev This function checks authorization for each token ID and verifies the lengths of input arrays.
    /// Votes are distributed across the specified pools proportionally to the provided weights.
    /// @param tokenIds_ Array of token IDs being used for voting.
    /// @param pools_ Nested array where each sub-array contains the pool addresses a token ID is voting for.
    /// @param weights_ Nested array where each sub-array contains the weights corresponding to the pools for a token ID.
    function vote(
        uint256[] calldata tokenIds_,
        address[][] calldata pools_,
        uint256[][] calldata weights_
    ) 
        external;

    /// @notice Resets votes for the specified token ID.
    /// @dev Removes all existing votes associated with the token ID.
    /// @param tokenId_ The ID of the escrowed token to reset votes for.
    function reset(uint256 tokenId_) external;

    /// @notice Recalculates votes for the specified token ID based on current voting power.
    /// @dev Useful when the voting power has changed due to staking or unstaking.
    /// @param tokenId_ The ID of the escrowed token to recalculate votes for.
    function poke(uint256 tokenId_) external;

    /// @notice Claims incentive rewards for the sender from given rewards distributors.
    /// @dev Checks authorization and claims rewards from each distributor.
    /// @param incentiveRewardsDistributors_ An array of incentive rewards distributor addresses.
    /// @param rewardTokens_ A two-dimensional array of reward token addresses for each distributor.
    function claimIncentives(
        address[] calldata incentiveRewardsDistributors_, 
        address[][] calldata rewardTokens_
    ) 
        external;
    
    /// @notice Notifies the contract of a new reward amount to distribute.
    /// @dev Only callable by the emission manager; updates the distribution index.
    /// @param rewardAmount_ The amount of EYWA tokens to distribute as rewards.
    function notifyRewardAmount(uint256 rewardAmount_) external;

    /// @notice Distributes accumulated rewards to multiple gauges.
    /// @dev Updates the epoch before distributing rewards.
    /// @param gauges_ An array of gauge addresses to distribute rewards to.
    function distributeRewardsForMultipleGauges(address[] calldata gauges_) external;

    /// @notice Distributes accumulated rewards to gauges within a specified range.
    /// @dev Updates the epoch before distributing rewards.
    /// @param start_ The starting index in the `s_pools` array.
    /// @param end_ The ending index in the `s_pools` array (exclusive).
    function distributeRewardsForGaugesInRange(uint256 start_, uint256 end_) external;

    /// @notice Returns the duration of the transfer freeze period after a deboost operation.
    /// @dev This function provides the cooldown duration (in seconds) during which token transfers are prohibited after a deboost.
    /// @return The cooldown period in seconds.
    function s_transferFreezeAfterDeboost() external view returns (uint256);

    /// @notice Returns the total number of pools registered.
    /// @return The number of pools.
    function getPoolsCount() external view returns (uint256);

    /// @notice Returns the timestamp of the next epoch start.
    /// @return The timestamp (in seconds since Unix epoch) when the next epoch will start.
    function currentEpochStart() external view returns (uint256);

    /// @notice Returns the timestamp of the current epoch start.
    /// @return The timestamp (in seconds since Unix epoch) when the current epoch started.
    function nextEpochStart() external view returns (uint256);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";

import {IDistributionCreator} from "./external/IDistributionCreator.sol";

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

interface IGaugeFactoryV1 {
    /// @notice Thrown when the caller is not the escrow vote manager.
    error InvalidCaller();

    /// @notice Emitted when a new gauge is created.
    /// @param gauge The address of the newly created gauge contract.
    /// @param implementation The address of the gauge implementation contract.
    event GaugeCreated(address indexed gauge, address indexed implementation);

    /// @notice Initializes the factory with the specified owner and escrow vote manager addresses.
    /// @dev This function can only be called once during the factory contract deployment.
    /// @param owner_ The address of the contract owner.
    /// @param escrowVoteManager_ The address of the escrow vote manager contract.
    function initialize(address owner_, address escrowVoteManager_) external;

    /// @notice Creates a new gauge contract.
    /// @dev This function can only be called by the escrow vote manager. Returns the address of the newly created gauge.
    /// @param owner_ The owner of the newly created gauge contract.
    /// @param eywa_ The address of the EYWA token to be associated with the gauge.
    /// @param campaignParameters_ The campaign parameters used for reward distribution.
    /// @return gauge_ The address of the newly created gauge contract.
    function createGauge(
        address owner_,
        address eywa_,
        IDistributionCreator.CampaignParameters calldata campaignParameters_
    ) 
        external 
        returns (address);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";

import {IEscrowVoteManagerV1} from "./IEscrowVoteManagerV1.sol";
import {IDistributionCreator} from "./external/IDistributionCreator.sol";

interface IGaugeV1 {
    /// @notice Thrown when the caller is not authorized to perform the action.
    error UnauthorizedCaller();

    /// @notice Emitted when new rewards are added to the gauge.
    /// @param amount The amount of reward tokens added.
    event RewardNotified(uint256 indexed amount);

    /// @notice Emitted when the campaign parameters are updated.
    /// @param gauge The address of the gauge for which the campaign parameters are being updated.
    /// @param oldCampaignParameters The previous campaign parameters before the update.
    /// @param newCampaignParameters The new campaign parameters after the update.
    event CampaignParametersUpdated(
        address indexed gauge, 
        IDistributionCreator.CampaignParameters oldCampaignParameters,
        IDistributionCreator.CampaignParameters newCampaignParameters
    );

    /// @notice Initializes the contract, setting the owner and campaign parameters.
    /// @dev This function can only be called once. It sets up the owner and initializes campaign parameters.
    /// @param owner_ The address of the contract owner.
    /// @param escrowVoteManager_ The address of the escrow vote manager.
    /// @param eywa_ The address of the EYWA token used for rewards.
    /// @param campaignParameters_ The campaign parameters used for reward distribution.
    function initialize(
        address owner_,
        address escrowVoteManager_,
        address eywa_,
        IDistributionCreator.CampaignParameters calldata campaignParameters_
    ) 
        external;

    /// @notice Updates the parameters of the current campaign.
    /// @dev Only the contract owner can call this function. 
    /// The updated parameters replace the existing ones and are stored in `s_campaignParameters`.
    /// @param newCampaignParameters_ The new parameters for the campaign to be updated.
    function updateCampaignParameters(IDistributionCreator.CampaignParameters calldata newCampaignParameters_) external;

    /// @notice Notifies the contract about a new reward amount for distribution.
    /// @dev This function can only be called by the escrow vote manager. It checks if the reward amount
    /// meets the minimum required for distribution and then initiates the reward distribution campaign.
    /// @param amount_ The amount of reward tokens to be distributed.
    function notifyRewardAmount(uint256 amount_) external;
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {RewardsDistributor, IRewardsDistributor, IEscrowVoteManagerV1} from "../super/RewardsDistributor.sol";

interface IIncentiveRewardsDistributor is IRewardsDistributor {
    /// @notice Claims rewards for a specified owner and list of reward tokens.
    /// @dev This function can only be called by the escrow vote manager.
    /// @param owner_ The address of the owner for whom rewards are being claimed.
    /// @param rewardTokens_ The list of reward token addresses to claim.
    function getReward(
        address owner_, 
        address[] calldata rewardTokens_
    ) 
        external;

    /// @notice Notifies the contract of a new reward amount for a specific token.
    /// @dev This function adds the token to the reward list if it is whitelisted and not already added.
    /// @param rewardToken_ The address of the reward token.
    /// @param rewardAmount_ The amount of reward tokens to be distributed.
    function notifyRewardAmount(
        address rewardToken_, 
        uint256 rewardAmount_
    ) 
        external;
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";

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

interface IMetadataProviderV1 {
    /// @notice Initializes the contract and sets the owner.
    /// @dev This function is only callable once during contract deployment.
    /// @param owner_ The address of the owner of the contract.
    /// @param escrowManager_ The interface to the escrow manager contract.
    function initialize(address owner_, IEscrowManager escrowManager_) external;

    /// @notice Retrieves metadata associated with a specific token ID.
    /// @param tokenId_ The unique identifier of the token for which metadata is being retrieved.
    /// @return output_ A string representing the metadata associated with the specified token ID.
    function retrieveMetadata(uint256 tokenId_) external view returns (string memory output_);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";

import {IEscrowManager} from "./IEscrowManager.sol";
import {IEmissionManagerV1} from "./IEmissionManagerV1.sol";

interface IRebaseRewardsDistributorV1 {
    /// @notice Thrown when the caller is not authorized to perform the action.
    error UnauthorizedCaller();

    /// @notice Thrown when the emission period has not been updated by the emission Manager.
    error EmissionPeriodNotUpdated();

    /// @notice Emitted when a new checkpoint is created.
    /// @param timestamp The timestamp when the checkpoint was created.
    /// @param totalReward The total reward amount at the checkpoint.
    event Checkpoint(uint256 indexed timestamp, uint256 indexed totalReward);

    /// @notice Emitted when rewards are claimed for a specific token ID.
    /// @param tokenId The ID of the token for which rewards were claimed.
    /// @param initialWeekCursor The starting week cursor for the rewards calculation.
    /// @param updatedWeekCursor The updated week cursor after the rewards calculation.
    /// @param reward The amount of reward that was claimed.
    event RewardsClaimed(
        uint256 indexed tokenId,
        uint256 indexed initialWeekCursor,
        uint256 indexed updatedWeekCursor,
        uint256 reward
    );

    /// @notice Initializes the contract with the given parameters.
    /// @dev Sets up the initial state and approves the escrow manager to transfer EYWA tokens.
    /// @param owner_ The address of the owner of the contract.
    /// @param eywa_ The EYWA token contract address.
    /// @param escrowManager_ The escrow manager contract address.
    /// @param emissionManager_ The emission manager contract address.
    function initialize(
        address owner_,
        IERC20 eywa_, 
        IEscrowManager escrowManager_, 
        IEmissionManagerV1 emissionManager_
    ) 
        external;
    
    /// @notice Updates the checkpoint, recording the distribution of rewards up to the current time.
    /// @dev This function can only be called by the emission manager contract.
    function checkpoint() external;

    /// @notice Claims the accumulated rewards for a specific token ID.
    /// @dev Transfers rewards to the token owner or deposits into their lock based on the lock status.
    /// @param tokenId_ The veEYWA token ID for which to claim rewards.
    function claim(uint256 tokenId_) external;

    /// @notice Claims the accumulated rewards for multiple token IDs.
    /// @dev Iterates over the provided token IDs and claims rewards for each.
    /// @param tokenIds_ An array of veEYWA token IDs for which to claim rewards.
    function claim(uint256[] calldata tokenIds_) external;

    /// @notice Calculates the amount of rewards earned by a specific token ID.
    /// @dev Computes rewards based on voting power over time.
    /// @param tokenId_ The veEYWA token ID for which to calculate earned rewards.
    /// @return The amount of rewards earned.
    function earned(uint256 tokenId_) external view returns (uint256);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";

import {IEscrowManager} from "./IEscrowManager.sol";
import {IEscrowVoteManagerV1} from "./IEscrowVoteManagerV1.sol";

interface IRewardsDistributor {
    /// @notice Thrown when an invalid reward token is provided.
    error InvalidRewardToken();

    /// @notice Thrown when a caller tries to access a function without the proper authorization.
    error UnauthorizedAccess();

    /// @notice Thrown when a zero amount is provided where a positive value is expected.
    error ZeroAmountProvided();

    /// @notice Thrown when a token is not whitelisted for reward distribution.
    error NotWhitelisted();

    /// @notice Emitted when tokens are deposited into the contract for a specific tokenId.
    /// @param from The address of the user making the deposit.
    /// @param tokenId The ID of the token for which the deposit is being made.
    /// @param amount The amount of tokens deposited.
    event TokensDeposited(address indexed from, uint256 indexed tokenId, uint256 indexed amount);

    /// @notice Emitted when tokens are withdrawn from the contract for a specific tokenId.
    /// @param from The address of the user making the withdrawal.
    /// @param tokenId The ID of the token from which the withdrawal is made.
    /// @param amount The amount of tokens withdrawn.
    event TokensWithdrawn(address indexed from, uint256 indexed tokenId, uint256 indexed amount);

    /// @notice Emitted when a reward is notified to the contract for distribution.
    /// @param from The address notifying the reward.
    /// @param token The address of the reward token.
    /// @param epoch The epoch during which the reward was notified.
    /// @param amount The amount of the reward token being notified.
    event RewardNotified(address indexed from, address indexed token, uint256 indexed epoch, uint256 amount);

    /// @notice Emitted when rewards are claimed for a specific tokenId.
    /// @param from The address claiming the rewards.
    /// @param token The address of the reward token.
    /// @param amount The amount of the reward claimed.
    event RewardsClaimed(address indexed from, address indexed token, uint256 indexed amount);

    /// @notice Claims rewards for a given owner and reward tokens.
    /// @param owner_ The address of the owner claiming rewards.
    /// @param rewardTokens_ The list of reward token addresses to claim.
    function getReward(address owner_, address[] calldata rewardTokens_) external;

    /// @notice Notifies the contract of a new reward amount for a token.
    /// @param rewardToken_ The address of the reward token.
    /// @param rewardAmount_ The amount of reward tokens being notified.
    function notifyRewardAmount(address rewardToken_, uint256 rewardAmount_) external;

    /// @notice Deposits tokens for voting, updating the epoch data.
    /// @dev Only callable by the escrow vote manager contract.
    /// @param amount_ The amount of tokens to deposit.
    /// @param tokenId_ The ID of the token associated with the deposit.
    function deposit(uint256 amount_, uint256 tokenId_) external;

    /// @notice Withdraws tokens from voting, updating the epoch data.
    /// @dev Only callable by the escrow vote manager contract.
    /// @param amount_ The amount of tokens to withdraw.
    /// @param tokenId_ The ID of the token associated with the withdrawal.
    function withdraw(uint256 amount_, uint256 tokenId_) external;

    /// @notice Returns the balance of a specific owner for a given epoch.
    /// @param owner_ The address of the owner whose balance is being queried.
    /// @param epoch_ The epoch timestamp for which the balance is requested.
    /// @return The balance of the owner for the specified epoch.
    function s_balanceByOwnerAndEpoch(address owner_, uint256 epoch_) external view returns (uint256);
 
    /// @notice Returns the count of reward tokens.
    /// @return The length of the `s_rewardTokens` array.
    function getRewardTokensCount() external view returns (uint256);

    /// @notice Calculates the total earned rewards for an owner and reward token.
    /// @param owner_ The address of the owner.
    /// @param rewardToken_ The address of the reward token.
    /// @return The total rewards earned and the last reward claim timestamp.
    function earned(address owner_, address rewardToken_) external view returns (uint256, uint256);

    /// @notice Calculates the earned rewards for an owner by epoch.
    /// @param owner_ The address of the owner.
    /// @param rewardToken_ The address of the reward token.
    /// @param epoch_ The epoch start timestamp.
    /// @return The earned rewards for the owner during the specified epoch.
    function earnedByEpoch(address owner_, address rewardToken_, uint256 epoch_) external view returns (uint256);

    /// @notice Calculates the reward per token for a reward token and epoch.
    /// @param rewardToken_ The address of the reward token.
    /// @param epoch_ The epoch start timestamp.
    /// @return The reward per token for the specified reward token and epoch.
    function rewardPerToken(address rewardToken_, uint256 epoch_) external view returns (uint256);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {IncentiveRewardsDistributor} from "../IncentiveRewardsDistributor.sol";

interface IRewardsDistributorFactoryV1 {
    /// @notice Thrown when a function is called by an unauthorized address that is not the escrow vote manager.
    error InvalidCaller();

    /// @notice Initializes the rewards distributor factory with the contract owner and escrow vote manager.
    /// @param owner_ The address of the contract owner.
    /// @param escrowVoteManager_ The address of the escrow vote manager responsible for managing votes and distributions.
    function initialize(address owner_, address escrowVoteManager_) external;

    /// @notice Creates a new incentive rewards distributor contract.
    /// @dev The function can only be called by the escrow vote manager. Reverts if called by any other address.
    /// @param escrowManager_ The address of the escrow manager that will manage the new rewards distributor.
    /// @return The address of the newly created incentive rewards distributor contract.
    function createRewardsDistributor(address escrowManager_) external returns (address);
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import {IEscrowManager} from "../interfaces/IEscrowManager.sol";

library VotingPowerHelper {
    /// @notice Duration of each emission epoch (1 week).
    uint256 private constant EPOCH_DURATION = 1 weeks;

    /// @notice Gets the index of the checkpoint for the past votes of an account at a specific timestamp.
    /// @dev Uses binary search to find the appropriate checkpoint.
    /// @param s_checkpointsNumberByAccount_ Mapping from account addresses to the number of checkpoints they have.
    /// @param s_checkpoints_ Mapping from account addresses and checkpoint indices to Checkpoint structs.
    /// @param account_ The address of the account whose past votes are being queried.
    /// @param timestamp_ The timestamp at which to get the past votes index.
    /// @return index_ The index of the checkpoint for the past votes.
    function getPastVotesIndex(
        mapping (address => uint32) storage s_checkpointsNumberByAccount_,
        mapping (address => mapping (uint32 => IEscrowManager.Checkpoint)) storage s_checkpoints_,
        address account_, 
        uint256 timestamp_
    ) 
        external 
        view 
        returns (uint32) 
    {
        uint32 m_checkpointsNumber = s_checkpointsNumberByAccount_[account_];
        if (m_checkpointsNumber == 0) {
            return 0;
        }
        if (s_checkpoints_[account_][m_checkpointsNumber - 1].timestamp <= timestamp_) {
            return m_checkpointsNumber - 1;
        }
        if (s_checkpoints_[account_][0].timestamp > timestamp_) {
            return 0;
        }
        uint32 m_start;
        uint32 m_center;
        uint32 m_end = m_checkpointsNumber - 1;
        uint256 m_timestamp;
        while (m_end > m_start) {
            m_center = m_end - (m_end - m_start) / 2;
            m_timestamp = s_checkpoints_[account_][m_center].timestamp;
            if (m_timestamp == timestamp_) {
                return m_center;
            } else if (m_timestamp < timestamp_) {
                m_start = m_center;
            } else {
                m_end = m_center - 1;
            }
        }
        return m_start;
    }

    /// @notice Retrieves the total voting power at a specific timestamp.
    /// @dev Computes the voting power by adjusting for the rate of change over time intervals.
    /// @param s_votingPowerPointByEpoch_ Mapping from epoch numbers to VotingPowerPoint structs.
    /// @param s_rateOfChangeByUnlockTime_ Mapping from unlock times to rate of change of voting power.
    /// @param epoch_ The current epoch number.
    /// @param timestamp_ The timestamp for which the total voting power is calculated.
    /// @return totalVotingPower_ The total voting power at the specified timestamp.
    function getPastTotalSupply(
        mapping (uint256 => IEscrowManager.VotingPowerPoint) storage s_votingPowerPointByEpoch_,
        mapping (uint256 => int128) storage s_rateOfChangeByUnlockTime_,
        uint256 epoch_,
        uint256 timestamp_
    ) 
        external 
        view 
        returns (uint256) 
    {
        uint256 m_epoch = _findGlobalEpoch(s_votingPowerPointByEpoch_, epoch_, timestamp_);
        if (m_epoch == 0) {
            return 0;
        }
        IEscrowManager.VotingPowerPoint memory m_lastVotingPowerPoint = s_votingPowerPointByEpoch_[m_epoch];
        uint256 m_currentTimeInterval = m_lastVotingPowerPoint.timestamp / EPOCH_DURATION * EPOCH_DURATION;
        for (uint256 i = 0; i < 255; ++i) {
            m_currentTimeInterval += EPOCH_DURATION;
            int128 m_rateOfChangeAtTime;
            if (m_currentTimeInterval > timestamp_) {
                m_currentTimeInterval = timestamp_;
            } else {
                m_rateOfChangeAtTime = s_rateOfChangeByUnlockTime_[m_currentTimeInterval];
            }
            m_lastVotingPowerPoint.weight -= 
                m_lastVotingPowerPoint.rateOfChange * int128(int256(m_currentTimeInterval - m_lastVotingPowerPoint.timestamp));
            if (m_currentTimeInterval == timestamp_) {
                break;
            }
            m_lastVotingPowerPoint.rateOfChange += m_rateOfChangeAtTime;
            m_lastVotingPowerPoint.timestamp = m_currentTimeInterval;
        }
        if (m_lastVotingPowerPoint.weight < 0) {
            m_lastVotingPowerPoint.weight = 0;
        }
        return uint256(uint128(m_lastVotingPowerPoint.weight));
    }

    /// @notice Retrieves the voting power for a specific token ID at a given timestamp.
    /// @dev Computes the voting power for a specific token by adjusting for the rate of change.
    /// @param s_epochByTokenId_ Mapping from token IDs to their current epoch numbers.
    /// @param s_votingPowerPointByTokenIdAndEpoch_ Mapping from token IDs and epoch numbers to VotingPowerPoint structs.
    /// @param tokenId_ The ID of the token representing the lock.
    /// @param timestamp_ The timestamp for which the voting power is calculated.
    /// @return votingPower_ The voting power for the specified token ID at the given timestamp.
    function getPastVotesByTokenId(
        mapping (uint256 => uint256) storage s_epochByTokenId_,
        mapping (uint256 => IEscrowManager.VotingPowerPoint[1000000000]) storage s_votingPowerPointByTokenIdAndEpoch_,
        uint256 tokenId_, 
        uint256 timestamp_
    ) 
        external 
        view 
        returns (uint256) 
    {
        uint256 m_epoch = _findEpochByTokenId(s_epochByTokenId_, s_votingPowerPointByTokenIdAndEpoch_, tokenId_, timestamp_);
        if (m_epoch == 0) {
            return 0;
        }
        IEscrowManager.VotingPowerPoint memory m_lastVotingPowerPoint = s_votingPowerPointByTokenIdAndEpoch_[tokenId_][m_epoch];
        m_lastVotingPowerPoint.weight -= 
            m_lastVotingPowerPoint.rateOfChange * int128(int256(timestamp_ - m_lastVotingPowerPoint.timestamp));
        if (m_lastVotingPowerPoint.weight < 0) {
            m_lastVotingPowerPoint.weight = 0;
        }
        return uint256(int256(m_lastVotingPowerPoint.weight));
    }

    /// @notice Finds the global epoch index corresponding to a given timestamp.
    /// @dev Uses binary search to find the appropriate epoch index in the s_votingPowerPointByEpoch_ mapping.
    /// @param s_votingPowerPointByEpoch_ Mapping from epoch numbers to VotingPowerPoint structs.
    /// @param epoch_ The current epoch number.
    /// @param timestamp_ The timestamp for which to find the epoch.
    /// @return epochIndex_ The index of the epoch corresponding to the given timestamp.
    function _findGlobalEpoch(
        mapping (uint256 => IEscrowManager.VotingPowerPoint) storage s_votingPowerPointByEpoch_,
        uint256 epoch_,
        uint256 timestamp_
    )
        private
        view 
        returns (uint256)
    {
        if (epoch_ == 0) {
            return 0;
        }
        if (s_votingPowerPointByEpoch_[epoch_].timestamp <= timestamp_) {
            return epoch_;
        }
        if (s_votingPowerPointByEpoch_[1].timestamp > timestamp_) {
            return 0;
        }
        uint256 m_start;
        uint256 m_center;
        uint256 m_end = epoch_;
        while (m_end > m_start) {
            m_center = m_end - (m_end - m_start) / 2;
            IEscrowManager.VotingPowerPoint storage s_votingPowerPoint = s_votingPowerPointByEpoch_[m_center]; 
            if (s_votingPowerPoint.timestamp == timestamp_) {
                return m_center;
            } else if (s_votingPowerPoint.timestamp < timestamp_) {
                m_start = m_center;
            } else {
                m_end = m_center - 1;
            }
        }
        return m_start;
    }

    /// @notice Finds the epoch index for a given token ID and timestamp.
    /// @dev Uses binary search to find the appropriate epoch index in the s_votingPowerPointByTokenIdAndEpoch_ mapping.
    /// @param s_epochByTokenId_ Mapping from token IDs to their current epoch numbers.
    /// @param s_votingPowerPointByTokenIdAndEpoch_ Mapping from token IDs and epoch numbers to VotingPowerPoint structs.
    /// @param tokenId_ The ID of the token.
    /// @param timestamp_ The timestamp for which to find the epoch.
    /// @return epochIndex_ The index of the epoch for the given token ID corresponding to the given timestamp.
    function _findEpochByTokenId(
        mapping (uint256 => uint256) storage s_epochByTokenId_,
        mapping (uint256 => IEscrowManager.VotingPowerPoint[1000000000]) storage s_votingPowerPointByTokenIdAndEpoch_,
        uint256 tokenId_, 
        uint256 timestamp_
    )
        private
        view
        returns (uint256)
    {
        uint256 m_epoch = s_epochByTokenId_[tokenId_];
        if (m_epoch == 0) {
            return 0;
        }
        if (s_votingPowerPointByTokenIdAndEpoch_[tokenId_][m_epoch].timestamp <= timestamp_) {
            return m_epoch;
        }
        if (s_votingPowerPointByTokenIdAndEpoch_[tokenId_][1].timestamp > timestamp_) {
            return 0;
        }
        uint256 m_start;
        uint256 m_center;
        uint256 m_end = m_epoch;
        while (m_end > m_start) {
            m_center = m_end - (m_end - m_start) / 2;
            IEscrowManager.VotingPowerPoint storage s_votingPowerPoint 
                = s_votingPowerPointByTokenIdAndEpoch_[tokenId_][m_center];
            if (s_votingPowerPoint.timestamp == timestamp_) {
                return m_center;
            } else if (s_votingPowerPoint.timestamp < timestamp_) {
                m_start = m_center;
            } else {
                m_end = m_center - 1;
            }
        }
        return m_start;
    }
}

// SPDX-License-Identifier: UNLICENSED
// Copyright (c) Eywa.Fi, 2021-2024 - all rights reserved
pragma solidity 0.8.26;

import "../interfaces/IRewardsDistributor.sol";

abstract contract RewardsDistributor is IRewardsDistributor, ReentrancyGuard {
    using SafeERC20 for IERC20;

    /// @notice Duration of one epoch in seconds.
    uint256 public constant EPOCH_DURATION = 1 weeks;

    /// @notice Address of the escrow vote manager contract.
    address public immutable ESCROW_VOTE_MANAGER;

    /// @notice Address of the escrow manager contract.
    address public immutable ESCROW_MANAGER;

    /// @notice List of reward tokens used in the contract.
    address[] public s_rewardTokens;

    /// @notice Initial timestamp for incentive distribution.
    uint256 public s_initialIncentiveTimestamp;

    /// @notice Total supply by epoch.
    mapping (uint256 => uint256) public s_totalSupplyByEpoch;

    /// @notice Indicates if an address is a reward token.
    mapping (address => bool) public s_isRewardToken;

    /// @notice Balance of an owner by epoch.
    mapping (address => mapping (uint256 => uint256)) public s_balanceByOwnerAndEpoch;

    /// @notice Reward amount for each token by epoch.
    mapping (address => mapping (uint256 => uint256)) public s_rewardAmountByTokenAndEpoch;

    /// @notice Last reward claim for an owner by reward token.
    mapping (address => mapping (address => uint256)) public s_lastRewardClaimByOwnerAndToken;

    /// @notice Initializes the contract with the addresses of the escrow vote manager and escrow manager.
    /// @param escrowVoteManager_ The address of the escrow vote manager contract.
    /// @param escrowManager_ The address of the escrow manager contract.
    constructor(address escrowVoteManager_, address escrowManager_) {
        ESCROW_VOTE_MANAGER = escrowVoteManager_;
        ESCROW_MANAGER = escrowManager_;
    }

    /// @inheritdoc IRewardsDistributor
    function getReward(address owner_, address[] calldata rewardTokens_) external virtual;

    /// @inheritdoc IRewardsDistributor
    function notifyRewardAmount(address rewardToken_, uint256 rewardAmount_) external virtual;

    /// @inheritdoc IRewardsDistributor
    function deposit(uint256 amount_, uint256 tokenId_) external {
        if (msg.sender != ESCROW_VOTE_MANAGER) {
            revert UnauthorizedAccess();
        }
        uint256 m_currentEpochStart = IEscrowVoteManagerV1(ESCROW_VOTE_MANAGER).currentEpochStart();
        s_totalSupplyByEpoch[m_currentEpochStart] += amount_;
        address m_owner = IEscrowManager(ESCROW_MANAGER).ownerOf(tokenId_);
        s_balanceByOwnerAndEpoch[m_owner][m_currentEpochStart] += amount_;
        emit TokensDeposited(m_owner, tokenId_, amount_);
    }

    /// @inheritdoc IRewardsDistributor
    function withdraw(uint256 amount_, uint256 tokenId_) external {
        if (msg.sender != ESCROW_VOTE_MANAGER) {
            revert UnauthorizedAccess();
        }
        uint256 m_currentEpochStart = IEscrowVoteManagerV1(ESCROW_VOTE_MANAGER).currentEpochStart();
        s_totalSupplyByEpoch[m_currentEpochStart] -= amount_;
        address m_owner = IEscrowManager(ESCROW_MANAGER).ownerOf(tokenId_);
        s_balanceByOwnerAndEpoch[m_owner][m_currentEpochStart] -= amount_;
        emit TokensWithdrawn(m_owner, tokenId_, amount_);
    }

    /// @inheritdoc IRewardsDistributor
    function getRewardTokensCount() external view returns (uint256) {
        return s_rewardTokens.length;
    }

    /// @inheritdoc IRewardsDistributor
    function earned(address owner_, address rewardToken_) public view returns (uint256, uint256) {
        if (!s_isRewardToken[rewardToken_]) {
            return (0, 0);
        }
        uint256 m_lastRewardClaim = s_lastRewardClaimByOwnerAndToken[owner_][rewardToken_];
        if (m_lastRewardClaim < s_initialIncentiveTimestamp) {
            m_lastRewardClaim = s_initialIncentiveTimestamp - EPOCH_DURATION;
        }
        uint256 m_currentEpochStart = IEscrowVoteManagerV1(ESCROW_VOTE_MANAGER).currentEpochStart();
        uint256 m_reward;
        for (uint256 i = 0; i < 52; ++i) {
            if (m_lastRewardClaim == m_currentEpochStart) {
                break;
            }
            m_reward += earnedByEpoch(owner_, rewardToken_, m_lastRewardClaim);
            m_lastRewardClaim += EPOCH_DURATION;
        }
        return (m_reward, m_lastRewardClaim);
    }

    /// @inheritdoc IRewardsDistributor
    function earnedByEpoch(address owner_, address rewardToken_, uint256 epoch_) public view returns (uint256) {
        uint256 m_balance = s_balanceByOwnerAndEpoch[owner_][epoch_];
        if (m_balance == 0) {
            return 0;
        } else {
            return rewardPerToken(rewardToken_, epoch_) * m_balance / 1e18;
        }
    }

    /// @inheritdoc IRewardsDistributor
    function rewardPerToken(address rewardToken_, uint256 epoch_) public view returns (uint256) {
        uint256 m_totalSupply = s_totalSupplyByEpoch[epoch_];
        if (m_totalSupply == 0) {
            return s_rewardAmountByTokenAndEpoch[rewardToken_][epoch_];
        } else {
            return s_rewardAmountByTokenAndEpoch[rewardToken_][epoch_] * 1e18 / m_totalSupply;
        }
    }

    /// @notice Internal function to claim rewards for an owner and reward tokens.
    /// @param owner_ The address of the owner claiming rewards.
    /// @param rewardTokens_ The list of reward token addresses to claim.
    function _getReward(address owner_, address[] calldata rewardTokens_) internal {
        for (uint256 i = 0; i < rewardTokens_.length; ++i) {
            (uint256 m_reward, uint256 m_lastRewardClaim) = earned(owner_, rewardTokens_[i]);
            s_lastRewardClaimByOwnerAndToken[owner_][rewardTokens_[i]] = m_lastRewardClaim;
            if (m_reward > 0) {
                IERC20(rewardTokens_[i]).safeTransfer(owner_, m_reward);
            }
            emit RewardsClaimed(owner_, rewardTokens_[i], m_reward);
        }
    }

    /// @notice Internal function to notify a new reward amount for a token.
    /// @dev Transfers reward tokens to the contract and updates the reward amount.
    /// @param sender_ The address sending the reward tokens.
    /// @param rewardToken_ The address of the reward token.
    /// @param rewardAmount_ The amount of reward tokens being notified.
    function _notifyRewardAmount(address sender_, address rewardToken_, uint256 rewardAmount_) internal {
        if (rewardAmount_ == 0) {
            revert ZeroAmountProvided();
        }
        IERC20 m_rewardToken = IERC20(rewardToken_);
        uint256 m_balanceBefore = m_rewardToken.balanceOf(address(this));
        m_rewardToken.safeTransferFrom(sender_, address(this), rewardAmount_);
        uint256 m_difference = m_rewardToken.balanceOf(address(this)) - m_balanceBefore;
        uint256 m_currentEpochStart = IEscrowVoteManagerV1(ESCROW_VOTE_MANAGER).currentEpochStart();
        if (s_initialIncentiveTimestamp == 0) {
            s_initialIncentiveTimestamp = m_currentEpochStart;
        }
        s_rewardAmountByTokenAndEpoch[rewardToken_][m_currentEpochStart] += m_difference;
        emit RewardNotified(sender_, rewardToken_, m_currentEpochStart, m_difference);
    }
}

{
  "optimizer": {
    "enabled": true,
    "runs": 200
  },
  "evmVersion": "paris",
  "outputSelection": {
    "*": {
      "*": [
        "evm.bytecode",
        "evm.deployedBytecode",
        "devdoc",
        "userdoc",
        "metadata",
        "abi"
      ]
    }
  },
  "libraries": {}
}

• No Contract Security Audit Submitted- Submit Audit Here

[{"inputs":[{"internalType":"address","name":"escrowVoteManager_","type":"address"},{"internalType":"address","name":"escrowManager_","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"InvalidRewardToken","type":"error"},{"inputs":[],"name":"NotWhitelisted","type":"error"},{"inputs":[],"name":"ReentrancyGuardReentrantCall","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[],"name":"UnauthorizedAccess","type":"error"},{"inputs":[],"name":"ZeroAmountProvided","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":true,"internalType":"uint256","name":"epoch","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RewardNotified","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":true,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RewardsClaimed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"TokensDeposited","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"},{"indexed":true,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"TokensWithdrawn","type":"event"},{"inputs":[],"name":"EPOCH_DURATION","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"ESCROW_MANAGER","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"ESCROW_VOTE_MANAGER","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount_","type":"uint256"},{"internalType":"uint256","name":"tokenId_","type":"uint256"}],"name":"deposit","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner_","type":"address"},{"internalType":"address","name":"rewardToken_","type":"address"}],"name":"earned","outputs":[{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner_","type":"address"},{"internalType":"address","name":"rewardToken_","type":"address"},{"internalType":"uint256","name":"epoch_","type":"uint256"}],"name":"earnedByEpoch","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner_","type":"address"},{"internalType":"address[]","name":"rewardTokens_","type":"address[]"}],"name":"getReward","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"getRewardTokensCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"rewardToken_","type":"address"},{"internalType":"uint256","name":"rewardAmount_","type":"uint256"}],"name":"notifyRewardAmount","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"rewardToken_","type":"address"},{"internalType":"uint256","name":"epoch_","type":"uint256"}],"name":"rewardPerToken","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"}],"name":"s_balanceByOwnerAndEpoch","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"s_initialIncentiveTimestamp","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"s_isRewardToken","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"s_lastRewardClaimByOwnerAndToken","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"}],"name":"s_rewardAmountByTokenAndEpoch","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"s_rewardTokens","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"s_totalSupplyByEpoch","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount_","type":"uint256"},{"internalType":"uint256","name":"tokenId_","type":"uint256"}],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"}]

0x60c060405234801561001057600080fd5b5060405161148738038061148783398101604081905261002f91610067565b60016000556001600160a01b039182166080521660a05261009a565b80516001600160a01b038116811461006257600080fd5b919050565b6000806040838503121561007a57600080fd5b6100838361004b565b91506100916020840161004b565b90509250929050565b60805160a05161137b61010c6000396000818161029f0152818161061b0152610b040152600081816102d9015281816103a30152818161048901528181610516015281816105580152818161084501528181610953015281816109ff01528181610a410152610e92015261137b6000f3fe608060405234801561001057600080fd5b50600436106101165760003560e01c806389f43d88116100a2578063c809184811610071578063c80918481461026f578063dd9e65a31461029a578063e2bbb158146102c1578063effce624146102d4578063f398abac146102fb57600080fd5b806389f43d88146102145780639b61fba21461023f578063a70b9f0c14610252578063b66503cf1461025c57600080fd5b8063413b3710116100e9578063413b371014610178578063441a3e70146101a3578063568bebf6146101b657806357bc5614146101d65780638751ff29146101e957600080fd5b8063211dc32d1461011b5780632d9e88e11461014857806331279d3d1461015a57806336ea90561461016f575b600080fd5b61012e6101293660046110da565b61032e565b604080519283526020830191909152015b60405180910390f35b6001545b60405190815260200161013f565b61016d610168366004611113565b610476565b005b61014c60025481565b61018b61018636600461119d565b6104e1565b6040516001600160a01b03909116815260200161013f565b61016d6101b13660046111b6565b61050b565b61014c6101c436600461119d565b60036020526000908152604090205481565b61014c6101e43660046111d8565b610709565b61014c6101f73660046111d8565b600560209081526000928352604080842090915290825290205481565b61014c6102223660046111d8565b600660209081526000928352604080842090915290825290205481565b61014c61024d366004611204565b610796565b61014c62093a8081565b61016d61026a3660046111d8565b6107fe565b61014c61027d3660046110da565b600760209081526000928352604080842090915290825290205481565b61018b7f000000000000000000000000000000000000000000000000000000000000000081565b61016d6102cf3660046111b6565b6109f4565b61018b7f000000000000000000000000000000000000000000000000000000000000000081565b61031e610309366004611245565b60046020526000908152604090205460ff1681565b604051901515815260200161013f565b6001600160a01b038116600090815260046020526040812054819060ff1661035b5750600090508061046f565b6001600160a01b0380851660009081526007602090815260408083209387168352929052205460025481101561039f5762093a8060025461039c9190611278565b90505b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa1580156103ff573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610423919061128b565b90506000805b60348110156104675783831461046757610444888886610796565b61044e90836112a4565b915061045d62093a80856112a4565b9350600101610429565b509350909150505b9250929050565b61047e610bf2565b336001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016146104c757604051631a27eac360e11b815260040160405180910390fd5b6104d2838383610c1c565b6104dc6001600055565b505050565b600181815481106104f157600080fd5b6000918252602090912001546001600160a01b0316905081565b336001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000161461055457604051631a27eac360e11b815260040160405180910390fd5b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa1580156105b4573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105d8919061128b565b9050826003600083815260200190815260200160002060008282546105fd9190611278565b90915550506040516331a9108f60e11b8152600481018390526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690636352211e90602401602060405180830381865afa15801561066a573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061068e91906112b7565b6001600160a01b03811660009081526005602090815260408083208684529091528120805492935086929091906106c6908490611278565b9091555050604051849084906001600160a01b038416907fffe903c0abe6b2dbb2f3474ef43d7a3c1fca49e5a774453423ca8e1952aabffa90600090a450505050565b60008181526003602052604081205480820361074a5750506001600160a01b0382166000908152600660209081526040808320848452909152902054610790565b6001600160a01b0384166000908152600660209081526040808320868452909152902054819061078290670de0b6b3a76400006112d4565b61078c91906112eb565b9150505b92915050565b6001600160a01b03831660009081526005602090815260408083208484529091528120548082036107cb5760009150506107f7565b670de0b6b3a7640000816107df8686610709565b6107e991906112d4565b6107f391906112eb565b9150505b9392505050565b610806610bf2565b6001600160a01b03821660009081526004602052604090205460ff166109345760405163096542eb60e01b81526001600160a01b0383811660048301527f0000000000000000000000000000000000000000000000000000000000000000169063096542eb90602401602060405180830381865afa15801561088c573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906108b0919061130d565b6108cd57604051630b094f2760e31b815260040160405180910390fd5b6001600160a01b0382166000818152600460205260408120805460ff191660019081179091558054808201825591527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf60180546001600160a01b03191690911790556109db565b60405163096542eb60e01b81526001600160a01b0383811660048301527f0000000000000000000000000000000000000000000000000000000000000000169063096542eb90602401602060405180830381865afa15801561099a573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109be919061130d565b6109db57604051630b094f2760e31b815260040160405180910390fd5b6109e6338383610d70565b6109f06001600055565b5050565b336001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001614610a3d57604051631a27eac360e11b815260040160405180910390fd5b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa158015610a9d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ac1919061128b565b905082600360008381526020019081526020016000206000828254610ae691906112a4565b90915550506040516331a9108f60e11b8152600481018390526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690636352211e90602401602060405180830381865afa158015610b53573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610b7791906112b7565b6001600160a01b0381166000908152600560209081526040808320868452909152812080549293508692909190610baf9084906112a4565b9091555050604051849084906001600160a01b038416907ffdfdcf596161b0e81e3161597d46888dcc88bd83b22dcfb341c76377ca3bbc9e90600090a450505050565b600260005403610c1557604051633ee5aeb560e01b815260040160405180910390fd5b6002600055565b60005b81811015610d6a57600080610c5586868686818110610c4057610c4061132f565b90506020020160208101906101299190611245565b6001600160a01b0388166000908152600760205260408120929450909250829190878787818110610c8857610c8861132f565b9050602002016020810190610c9d9190611245565b6001600160a01b031681526020810191909152604001600020558115610cf957610cf98683878787818110610cd457610cd461132f565b9050602002016020810190610ce99190611245565b6001600160a01b03169190610fb5565b81858585818110610d0c57610d0c61132f565b9050602002016020810190610d219190611245565b6001600160a01b0316876001600160a01b03167f9310ccfcb8de723f578a9e4282ea9f521f05ae40dc08f3068dfad528a65ee3c760405160405180910390a45050600101610c1f565b50505050565b80600003610d9157604051638b12710760e01b815260040160405180910390fd5b6040516370a0823160e01b815230600482015282906000906001600160a01b038316906370a0823190602401602060405180830381865afa158015610dda573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610dfe919061128b565b9050610e156001600160a01b038316863086611014565b6040516370a0823160e01b815230600482015260009082906001600160a01b038516906370a0823190602401602060405180830381865afa158015610e5e573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610e82919061128b565b610e8c9190611278565b905060007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa158015610eee573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610f12919061128b565b9050600254600003610f245760028190555b6001600160a01b038616600090815260066020908152604080832084845290915281208054849290610f579084906112a4565b9250508190555080866001600160a01b0316886001600160a01b03167fe45a746d5e5fd63b769b1702e2932033d4f740729d525e0eef09db02d659bc2e85604051610fa491815260200190565b60405180910390a450505050505050565b6040516001600160a01b038381166024830152604482018390526104dc91859182169063a9059cbb906064015b604051602081830303815290604052915060e01b6020820180516001600160e01b03838183161783525050505061104d565b6040516001600160a01b038481166024830152838116604483015260648201839052610d6a9186918216906323b872dd90608401610fe2565b600080602060008451602086016000885af180611070576040513d6000823e3d81fd5b50506000513d91508115611088578060011415611095565b6001600160a01b0384163b155b15610d6a57604051635274afe760e01b81526001600160a01b038516600482015260240160405180910390fd5b6001600160a01b03811681146110d757600080fd5b50565b600080604083850312156110ed57600080fd5b82356110f8816110c2565b91506020830135611108816110c2565b809150509250929050565b60008060006040848603121561112857600080fd5b8335611133816110c2565b9250602084013567ffffffffffffffff81111561114f57600080fd5b8401601f8101861361116057600080fd5b803567ffffffffffffffff81111561117757600080fd5b8660208260051b840101111561118c57600080fd5b939660209190910195509293505050565b6000602082840312156111af57600080fd5b5035919050565b600080604083850312156111c957600080fd5b50508035926020909101359150565b600080604083850312156111eb57600080fd5b82356111f6816110c2565b946020939093013593505050565b60008060006060848603121561121957600080fd5b8335611224816110c2565b92506020840135611234816110c2565b929592945050506040919091013590565b60006020828403121561125757600080fd5b81356107f7816110c2565b634e487b7160e01b600052601160045260246000fd5b8181038181111561079057610790611262565b60006020828403121561129d57600080fd5b5051919050565b8082018082111561079057610790611262565b6000602082840312156112c957600080fd5b81516107f7816110c2565b808202811582820484141761079057610790611262565b60008261130857634e487b7160e01b600052601260045260246000fd5b500490565b60006020828403121561131f57600080fd5b815180151581146107f757600080fd5b634e487b7160e01b600052603260045260246000fdfea2646970667358221220cf194508ee6a6e391f92b287bad0504061b5f4aeff194b0a9748a9b1bb3cef8164736f6c634300081a0033000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef7000000000000000000000000dca5d16ac3708658ecc971d3aee5d5cd6e5e1fad

0x608060405234801561001057600080fd5b50600436106101165760003560e01c806389f43d88116100a2578063c809184811610071578063c80918481461026f578063dd9e65a31461029a578063e2bbb158146102c1578063effce624146102d4578063f398abac146102fb57600080fd5b806389f43d88146102145780639b61fba21461023f578063a70b9f0c14610252578063b66503cf1461025c57600080fd5b8063413b3710116100e9578063413b371014610178578063441a3e70146101a3578063568bebf6146101b657806357bc5614146101d65780638751ff29146101e957600080fd5b8063211dc32d1461011b5780632d9e88e11461014857806331279d3d1461015a57806336ea90561461016f575b600080fd5b61012e6101293660046110da565b61032e565b604080519283526020830191909152015b60405180910390f35b6001545b60405190815260200161013f565b61016d610168366004611113565b610476565b005b61014c60025481565b61018b61018636600461119d565b6104e1565b6040516001600160a01b03909116815260200161013f565b61016d6101b13660046111b6565b61050b565b61014c6101c436600461119d565b60036020526000908152604090205481565b61014c6101e43660046111d8565b610709565b61014c6101f73660046111d8565b600560209081526000928352604080842090915290825290205481565b61014c6102223660046111d8565b600660209081526000928352604080842090915290825290205481565b61014c61024d366004611204565b610796565b61014c62093a8081565b61016d61026a3660046111d8565b6107fe565b61014c61027d3660046110da565b600760209081526000928352604080842090915290825290205481565b61018b7f000000000000000000000000dca5d16ac3708658ecc971d3aee5d5cd6e5e1fad81565b61016d6102cf3660046111b6565b6109f4565b61018b7f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef781565b61031e610309366004611245565b60046020526000908152604090205460ff1681565b604051901515815260200161013f565b6001600160a01b038116600090815260046020526040812054819060ff1661035b5750600090508061046f565b6001600160a01b0380851660009081526007602090815260408083209387168352929052205460025481101561039f5762093a8060025461039c9190611278565b90505b60007f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef76001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa1580156103ff573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610423919061128b565b90506000805b60348110156104675783831461046757610444888886610796565b61044e90836112a4565b915061045d62093a80856112a4565b9350600101610429565b509350909150505b9250929050565b61047e610bf2565b336001600160a01b037f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef716146104c757604051631a27eac360e11b815260040160405180910390fd5b6104d2838383610c1c565b6104dc6001600055565b505050565b600181815481106104f157600080fd5b6000918252602090912001546001600160a01b0316905081565b336001600160a01b037f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef7161461055457604051631a27eac360e11b815260040160405180910390fd5b60007f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef76001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa1580156105b4573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105d8919061128b565b9050826003600083815260200190815260200160002060008282546105fd9190611278565b90915550506040516331a9108f60e11b8152600481018390526000907f000000000000000000000000dca5d16ac3708658ecc971d3aee5d5cd6e5e1fad6001600160a01b031690636352211e90602401602060405180830381865afa15801561066a573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061068e91906112b7565b6001600160a01b03811660009081526005602090815260408083208684529091528120805492935086929091906106c6908490611278565b9091555050604051849084906001600160a01b038416907fffe903c0abe6b2dbb2f3474ef43d7a3c1fca49e5a774453423ca8e1952aabffa90600090a450505050565b60008181526003602052604081205480820361074a5750506001600160a01b0382166000908152600660209081526040808320848452909152902054610790565b6001600160a01b0384166000908152600660209081526040808320868452909152902054819061078290670de0b6b3a76400006112d4565b61078c91906112eb565b9150505b92915050565b6001600160a01b03831660009081526005602090815260408083208484529091528120548082036107cb5760009150506107f7565b670de0b6b3a7640000816107df8686610709565b6107e991906112d4565b6107f391906112eb565b9150505b9392505050565b610806610bf2565b6001600160a01b03821660009081526004602052604090205460ff166109345760405163096542eb60e01b81526001600160a01b0383811660048301527f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef7169063096542eb90602401602060405180830381865afa15801561088c573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906108b0919061130d565b6108cd57604051630b094f2760e31b815260040160405180910390fd5b6001600160a01b0382166000818152600460205260408120805460ff191660019081179091558054808201825591527fb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf60180546001600160a01b03191690911790556109db565b60405163096542eb60e01b81526001600160a01b0383811660048301527f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef7169063096542eb90602401602060405180830381865afa15801561099a573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109be919061130d565b6109db57604051630b094f2760e31b815260040160405180910390fd5b6109e6338383610d70565b6109f06001600055565b5050565b336001600160a01b037f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef71614610a3d57604051631a27eac360e11b815260040160405180910390fd5b60007f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef76001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa158015610a9d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ac1919061128b565b905082600360008381526020019081526020016000206000828254610ae691906112a4565b90915550506040516331a9108f60e11b8152600481018390526000907f000000000000000000000000dca5d16ac3708658ecc971d3aee5d5cd6e5e1fad6001600160a01b031690636352211e90602401602060405180830381865afa158015610b53573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610b7791906112b7565b6001600160a01b0381166000908152600560209081526040808320868452909152812080549293508692909190610baf9084906112a4565b9091555050604051849084906001600160a01b038416907ffdfdcf596161b0e81e3161597d46888dcc88bd83b22dcfb341c76377ca3bbc9e90600090a450505050565b600260005403610c1557604051633ee5aeb560e01b815260040160405180910390fd5b6002600055565b60005b81811015610d6a57600080610c5586868686818110610c4057610c4061132f565b90506020020160208101906101299190611245565b6001600160a01b0388166000908152600760205260408120929450909250829190878787818110610c8857610c8861132f565b9050602002016020810190610c9d9190611245565b6001600160a01b031681526020810191909152604001600020558115610cf957610cf98683878787818110610cd457610cd461132f565b9050602002016020810190610ce99190611245565b6001600160a01b03169190610fb5565b81858585818110610d0c57610d0c61132f565b9050602002016020810190610d219190611245565b6001600160a01b0316876001600160a01b03167f9310ccfcb8de723f578a9e4282ea9f521f05ae40dc08f3068dfad528a65ee3c760405160405180910390a45050600101610c1f565b50505050565b80600003610d9157604051638b12710760e01b815260040160405180910390fd5b6040516370a0823160e01b815230600482015282906000906001600160a01b038316906370a0823190602401602060405180830381865afa158015610dda573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610dfe919061128b565b9050610e156001600160a01b038316863086611014565b6040516370a0823160e01b815230600482015260009082906001600160a01b038516906370a0823190602401602060405180830381865afa158015610e5e573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610e82919061128b565b610e8c9190611278565b905060007f000000000000000000000000bf1669030ae89ea509bf578502002a0238b60ef76001600160a01b03166361a8c8c46040518163ffffffff1660e01b8152600401602060405180830381865afa158015610eee573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610f12919061128b565b9050600254600003610f245760028190555b6001600160a01b038616600090815260066020908152604080832084845290915281208054849290610f579084906112a4565b9250508190555080866001600160a01b0316886001600160a01b03167fe45a746d5e5fd63b769b1702e2932033d4f740729d525e0eef09db02d659bc2e85604051610fa491815260200190565b60405180910390a450505050505050565b6040516001600160a01b038381166024830152604482018390526104dc91859182169063a9059cbb906064015b604051602081830303815290604052915060e01b6020820180516001600160e01b03838183161783525050505061104d565b6040516001600160a01b038481166024830152838116604483015260648201839052610d6a9186918216906323b872dd90608401610fe2565b600080602060008451602086016000885af180611070576040513d6000823e3d81fd5b50506000513d91508115611088578060011415611095565b6001600160a01b0384163b155b15610d6a57604051635274afe760e01b81526001600160a01b038516600482015260240160405180910390fd5b6001600160a01b03811681146110d757600080fd5b50565b600080604083850312156110ed57600080fd5b82356110f8816110c2565b91506020830135611108816110c2565b809150509250929050565b60008060006040848603121561112857600080fd5b8335611133816110c2565b9250602084013567ffffffffffffffff81111561114f57600080fd5b8401601f8101861361116057600080fd5b803567ffffffffffffffff81111561117757600080fd5b8660208260051b840101111561118c57600080fd5b939660209190910195509293505050565b6000602082840312156111af57600080fd5b5035919050565b600080604083850312156111c957600080fd5b50508035926020909101359150565b600080604083850312156111eb57600080fd5b82356111f6816110c2565b946020939093013593505050565b60008060006060848603121561121957600080fd5b8335611224816110c2565b92506020840135611234816110c2565b929592945050506040919091013590565b60006020828403121561125757600080fd5b81356107f7816110c2565b634e487b7160e01b600052601160045260246000fd5b8181038181111561079057610790611262565b60006020828403121561129d57600080fd5b5051919050565b8082018082111561079057610790611262565b6000602082840312156112c957600080fd5b81516107f7816110c2565b808202811582820484141761079057610790611262565b60008261130857634e487b7160e01b600052601260045260246000fd5b500490565b60006020828403121561131f57600080fd5b815180151581146107f757600080fd5b634e487b7160e01b600052603260045260246000fdfea2646970667358221220cf194508ee6a6e391f92b287bad0504061b5f4aeff194b0a9748a9b1bb3cef8164736f6c634300081a0033