// File: src/Controller.sol



//██████╗  █████╗ ██╗      █████╗ ██████╗ ██╗███╗   ██╗
//██╔══██╗██╔══██╗██║     ██╔══██╗██╔══██╗██║████╗  ██║
//██████╔╝███████║██║     ███████║██║  ██║██║██╔██╗ ██║
//██╔═══╝ ██╔══██║██║     ██╔══██║██║  ██║██║██║╚██╗██║
//██║     ██║  ██║███████╗██║  ██║██████╔╝██║██║ ╚████║
//╚═╝     ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝╚═╝  ╚═══╝

pragma solidity 0.8.16;
//SPDX-License-Identifier: BUSL-1.1

import {Owner} from "utils/Owner.sol";
import {IERC20} from "openzeppelin/token/ERC20/IERC20.sol";
import {SafeERC20} from "openzeppelin/token/ERC20/utils/SafeERC20.sol";
import {Pausable} from "openzeppelin/security/Pausable.sol";
import {ReentrancyGuard} from "openzeppelin/security/ReentrancyGuard.sol";
import {Errors} from "utils/Errors.sol";
import {IHarvestable} from "interfaces/IHarvestable.sol";
import {IMinter} from "interfaces/IMinter.sol";
import {IStaker} from "interfaces/IStaker.sol";
import {IFarmer} from "interfaces/IFarmer.sol";
import {IIncentivizedLocker} from "interfaces/IIncentivizedLocker.sol";
import "interfaces/external/incentives/IIncentivesDistributors.sol";

/**
 * @title Warlord Controller contract
 * @author Paladin
 * @notice Controller to harvest from Locker & Farmer and process the rewards for distribution
 */
contract WarController is ReentrancyGuard, Pausable, Owner {
  using SafeERC20 for IERC20;

  // Constants

  /**
   * @notice 1e18 scale
   */
  uint256 public constant UNIT = 1e18;
  /**
   * @notice Max BPS value (100%)
   */
  uint256 public constant MAX_BPS = 10_000;

  // Storage

  /**
   * @notice Address of the WAR token
   */
  address public immutable war;
  /**
   * @notice Address of the Minter contract
   */
  IMinter public minter;
  /**
   * @notice Address of the Staker contract
   */
  IStaker public staker;
  /**
   * @notice Address of the Swap manager
   */
  address public swapper;
  /**
   * @notice Address of the Incentives Claimer
   */
  address public incentivesClaimer;
  /**
   * @notice Ratio of fees taken on harvested rewards
   */
  uint256 public feeRatio = 500;
  /**
   * @notice Address to receive the fees
   */
  address public feeReceiver;
  /**
   * @notice List of Lockers contract
   */
  address[] public lockers;
  /**
   * @notice List of Farmers contract
   */
  address[] public farmers;

  /**
   * @notice Address of the Locker for a token
   */
  mapping(address => address) public tokenLockers;
  /**
   * @notice Address of the Farmer for a token
   */
  mapping(address => address) public tokenFarmers;
  /**
   * @notice Tokens set for pure distribution (and that does not have a Locker or a Farmer contract)
   */
  mapping(address => bool) public distributionTokens;
  /**
   * @notice Amounts of tokens available for swaps to WETH
   */
  mapping(address => uint256) public swapperAmounts;
  /**
   * @notice Contracts that the controller can harvest
   */
  mapping(address => bool) public harvestable;

  // Events

  /**
   * @notice Event emitted when tokens are pulled
   */
  event PullTokens(address indexed swapper, address indexed token, uint256 amount);
  /**
   * @notice Event emitted when the Minter address is set
   */
  event SetMinter(address oldMinter, address newMinter);
  /**
   * @notice Event emitted when the Staker address is set
   */
  event SetStaker(address oldStaker, address newStaker);
  /**
   * @notice Event emitted when the Swapper address is updated
   */
  event SetSwapper(address oldSwapper, address newSwapper);
  /**
   * @notice Event emitted when the Fee Receiver address is updated
   */
  event SetFeeReceiver(address oldFeeReceiver, address newFeeReceiver);
  /**
   * @notice Event emitted when the Incentives Claimer address is updated
   */
  event SetIncentivesClaimer(address oldIncentivesClaimer, address newIncentivesClaimer);
  /**
   * @notice Event emitted when the Fee Ratio is updated
   */
  event SetFeeRatio(uint256 oldFeeRatio, uint256 newFeeRatio);
  /**
   * @notice Event emitted when a Locker is set
   */
  event SetLocker(address indexed token, address locker);
  /**
   * @notice Event emitted when a Farmer is set
   */
  event SetFarmer(address indexed token, address famer);
  /**
   * @notice Event emitted when a token is set for distribution
   */
  event SetDistributionToken(address indexed token, bool distribution);
  /**
   * @notice Event emitted when a contract harvestability is updated
   */
  event SetHarvestable(address harvestable, bool enabled);

  // Modifiers

  /**
   * @notice Checks the caller is the Swapper address
   */
  modifier onlySwapper() {
    if (msg.sender != swapper) revert Errors.CallerNotAllowed();
    _;
  }

  /**
   * @notice Checks the address is the Incentives Claimer address
   */
  modifier onlyIncentivesClaimer() {
    if (msg.sender != incentivesClaimer) revert Errors.CallerNotAllowed();
    _;
  }

  // Constructor

  constructor(
    address _war,
    address _minter,
    address _staker,
    address _swapper,
    address _incentivesClaimer,
    address _feeReceiver
  ) {
    if (
      _war == address(0) || _minter == address(0) || _staker == address(0) || _swapper == address(0)
        || _incentivesClaimer == address(0) || _feeReceiver == address(0)
    ) revert Errors.ZeroAddress();

    war = _war;
    swapper = _swapper;
    minter = IMinter(_minter);
    staker = IStaker(_staker);
    incentivesClaimer = _incentivesClaimer;
    feeReceiver = _feeReceiver;
  }

  // State changing functions
  function _harvest(address target) internal {
    if (!harvestable[target]) revert Errors.HarvestNotAllowed();
    IHarvestable(target).harvest();
  }

  /**
   * @notice Harvests rewards from a given Harvestable contract
   * @param target Address of the contract to harvest from
   */
  function harvest(address target) external nonReentrant whenNotPaused {
    _harvest(target);
  }

  /**
   * @notice Harvests rewards from Harvestable contracts
   * @param targets List of contracts to harvest from
   */
  function harvestMultiple(address[] calldata targets) external nonReentrant whenNotPaused {
    uint256 length = targets.length;
    if (length == 0) revert Errors.EmptyArray();

    for (uint256 i; i < length;) {
      _harvest(targets[i]);

      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Harvest from all listed Harvestable contracts (Locker & Farmers)
   */
  function harvestAll() external nonReentrant whenNotPaused {
    address[] memory _lockers = lockers;
    address[] memory _farmers = farmers;
    uint256 lockersLength = _lockers.length;
    uint256 farmersLength = _farmers.length;

    // Harvest from all listed Lockers
    for (uint256 i; i < lockersLength;) {
      _harvest(_lockers[i]);

      unchecked {
        i++;
      }
    }

    // Harvest from all listed Farmers
    for (uint256 i; i < farmersLength;) {
      _harvest(_farmers[i]);

      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Processes a token held in this contract
   * @param token Address of the token to process
   */
  function process(address token) external nonReentrant whenNotPaused {
    _processReward(token);
  }

  /**
   * @notice Processes tokens held in this contract
   * @param tokens List of tokens to process
   */
  function processMultiple(address[] calldata tokens) external nonReentrant whenNotPaused {
    _processMultiple(tokens);
  }

  /**
   * @notice Harvests rewards from a given Harvestable contract & process the received rewards
   * @param target Address of the contract to harvest from
   */
  function harvestAndProcess(address target) external nonReentrant whenNotPaused {
    IHarvestable(target).harvest();

    _processMultiple(IHarvestable(target).rewardTokens());
  }

  /**
   * @notice Harvest from all listed Harvestable contracts (Locker & Farmers) & process the received rewards
   */
  function harvestAllAndProcessAll() external nonReentrant whenNotPaused {
    address[] memory _lockers = lockers;
    address[] memory _farmers = farmers;
    uint256 lockersLength = _lockers.length;
    uint256 farmersLength = _farmers.length;

    // Harvest & process for each Locker
    for (uint256 i; i < lockersLength;) {
      IHarvestable(_lockers[i]).harvest();

      _processMultiple(IHarvestable(_lockers[i]).rewardTokens());

      unchecked {
        i++;
      }
    }

    // Harvest & process for each Farmer
    for (uint256 i; i < farmersLength;) {
      IHarvestable(_farmers[i]).harvest();

      _processMultiple(IHarvestable(_farmers[i]).rewardTokens());

      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Pulls a token to be swapped to WETH
   * @param token Address of the token to pull
   */
  function pullToken(address token) external nonReentrant whenNotPaused onlySwapper {
    _pullToken(token);
  }

  /**
   * @notice Pulls tokens to be swapped to WETH
   * @param tokens List of tokens to pull
   */
  function pullMultipleTokens(address[] calldata tokens) external nonReentrant whenNotPaused onlySwapper {
    uint256 length = tokens.length;
    if (length == 0) revert Errors.EmptyArray();

    for (uint256 i; i < length;) {
      _pullToken(tokens[i]);

      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Claims voting rewards from Quest for the given Locker
   * @param locker Address of the Locker having pending rewards
   * @param distributor Address of the contract distributing the rewards
   * @param claimParams Parameters to claim the rewards
   */
  function claimQuestRewards(address locker, address distributor, IQuestDistributor.ClaimParams[] calldata claimParams)
    external
    nonReentrant
    whenNotPaused
    onlyIncentivesClaimer
  {
    if (locker == address(0) || distributor == address(0)) revert Errors.ZeroAddress();

    uint256 length = claimParams.length;
    if (length == 0) revert Errors.EmptyArray();

    for (uint256 i; i < length;) {
      IIncentivizedLocker(locker).claimQuestRewards(
        distributor,
        claimParams[i].questID,
        claimParams[i].period,
        claimParams[i].index,
        locker,
        claimParams[i].amount,
        claimParams[i].merkleProof
      );

      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Claims voting rewards for the given Locker from the Paladin Delegation address
   * @param locker Address of the Locker having pending rewards
   * @param distributor Address of the contract distributing the rewards
   * @param claimParams Parameters to claim the rewards
   */
  function claimDelegationRewards(
    address locker,
    address distributor,
    IDelegationDistributor.ClaimParams[] calldata claimParams
  ) external nonReentrant whenNotPaused onlyIncentivesClaimer {
    if (locker == address(0) || distributor == address(0)) revert Errors.ZeroAddress();

    uint256 length = claimParams.length;
    if (length == 0) revert Errors.EmptyArray();

    for (uint256 i; i < length;) {
      IIncentivizedLocker(locker).claimDelegationRewards(
        distributor,
        claimParams[i].token,
        claimParams[i].index,
        locker,
        claimParams[i].amount,
        claimParams[i].merkleProof
      );

      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Claims voting rewards from Votium for the given Locker
   * @param locker Address of the Locker having pending rewards
   * @param distributor Address of the contract distributing the rewards
   * @param claimParams Parameters to claim the rewards
   */
  function claimVotiumRewards(address locker, address distributor, IVotiumDistributor.claimParam[] calldata claimParams)
    external
    nonReentrant
    whenNotPaused
    onlyIncentivesClaimer
  {
    if (locker == address(0) || distributor == address(0)) revert Errors.ZeroAddress();

    uint256 length = claimParams.length;
    if (length == 0) revert Errors.EmptyArray();

    for (uint256 i; i < length;) {
      IIncentivizedLocker(locker).claimVotiumRewards(
        distributor,
        claimParams[i].token,
        claimParams[i].index,
        locker,
        claimParams[i].amount,
        claimParams[i].merkleProof
      );

      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Claims voting rewards from HiddenHand for the given Locker
   * @param locker Address of the Locker having pending rewards
   * @param distributor Address of the contract distributing the rewards
   * @param claimParams Parameters to claim the rewards
   */
  function claimHiddenHandRewards(
    address locker,
    address distributor,
    IHiddenHandDistributor.Claim[] memory claimParams
  ) external nonReentrant whenNotPaused onlyIncentivesClaimer {
    if (locker == address(0) || distributor == address(0)) revert Errors.ZeroAddress();

    uint256 length = claimParams.length;
    if (length == 0) revert Errors.EmptyArray();

    for (uint256 i; i < length;) {
      IHiddenHandDistributor.Claim[] memory claim = new IHiddenHandDistributor.Claim[](1);
      claim[0] = claimParams[i];
      IIncentivizedLocker(locker).claimHiddenHandRewards(distributor, claim);

      unchecked {
        i++;
      }
    }
  }

  // Internal functions

  /**
   * @dev Processes a token based on their distribution/associated contract & take a fee on the amount processed
   * @param token Address of the token to process
   */
  function _processReward(address token) internal {
    // If the token address is the zero address, skip
    if (token == address(0)) return;

    // Load the token & get the amount to process
    IERC20 _token = IERC20(token);
    uint256 currentBalance = _token.balanceOf(address(this));

    // If the controller doesn't have any, skip
    if (currentBalance == 0) return;

    // Calculate the amount of fees to take
    uint256 feeAmount = (currentBalance * feeRatio) / MAX_BPS;
    uint256 processAmount = currentBalance - feeAmount;

    // Send the fees
    _sendFees(token, feeAmount);

    // Storing tokenFarmer to save on gas
    address tokenFarmer = tokenFarmers[token];

    if (tokenLockers[token] != address(0)) {
      // If the token is associated to a Locker:
      // 1 . Mint WAR with the token
      if (_token.allowance(address(this), address(minter)) != 0) _token.safeApprove(address(minter), 0);
      _token.safeIncreaseAllowance(address(minter), processAmount);
      minter.mint(token, processAmount);

      // 2 . Send the WAR to be distributed via the Staker
      IERC20 _war = IERC20(war);
      uint256 warBalance = _war.balanceOf(address(this));
      _war.safeTransfer(address(staker), warBalance);
      staker.queueRewards(war, warBalance);
    } else if (tokenFarmer != address(0)) {
      // If the token is associated to a Farmer:
      // Send the token in the Farmer
      if (_token.allowance(address(this), tokenFarmer) != 0) _token.safeApprove(tokenFarmer, 0);
      _token.safeIncreaseAllowance(tokenFarmer, processAmount);
      IFarmer(tokenFarmer).stake(token, processAmount);
    } else if (distributionTokens[token]) {
      // If the token is set for direct distribution:
      // Send the token to be distributed via the Staker
      _token.safeTransfer(address(staker), processAmount);
      staker.queueRewards(token, processAmount);
    } else {
      // Otherwise, set the token to be swapped for WETH by the Swapper
      swapperAmounts[token] += processAmount;
    }
  }

  /**
   * @dev Processes multiple tokens
   * @param tokens List of tokens to process
   */
  function _processMultiple(address[] memory tokens) internal {
    uint256 length = tokens.length;

    for (uint256 i; i < length;) {
      _processReward(tokens[i]);

      unchecked {
        i++;
      }
    }
  }

  /**
   * @dev Sends the given token to the Swapper
   * @param token Address of the token to send
   */
  function _pullToken(address token) internal {
    uint256 amount = swapperAmounts[token];
    swapperAmounts[token] = 0;

    IERC20(token).safeTransfer(swapper, amount);

    emit PullTokens(msg.sender, token, amount);
  }

  /**
   * @dev Sends the given amount of fees to the Fee Receiver
   * @param token Address of the token
   * @param amount Amount of fees to send
   */
  function _sendFees(address token, uint256 amount) internal {
    IERC20(token).safeTransfer(feeReceiver, amount);
  }

  // Admin functions

  /**
   * @notice Pause the contract
   */
  function pause() external onlyOwner {
    _pause();
  }

  /**
   * @notice Unpause the contract
   */
  function unpause() external onlyOwner {
    _unpause();
  }

  /**
   * @notice Updates the Minter contract address
   * @param newMinter Address of the Minter
   */
  function setMinter(address newMinter) external onlyOwner {
    address oldMinter = address(minter);

    if (newMinter == address(0)) revert Errors.ZeroAddress();
    if (newMinter == oldMinter) revert Errors.AlreadySet();

    minter = IMinter(newMinter);

    emit SetMinter(oldMinter, newMinter);
  }

  /**
   * @notice Updates the Staker contract address
   * @param newStaker Address of the new Staker
   */
  function setStaker(address newStaker) external onlyOwner {
    if (newStaker == address(0)) revert Errors.ZeroAddress();
    if (newStaker == address(staker)) revert Errors.AlreadySet();

    address oldStaker = address(staker);
    staker = IStaker(newStaker);

    emit SetStaker(oldStaker, newStaker);
  }

  /**
   * @notice Updates the Swapper address
   * @param newSwapper Address of the new Swapper
   */
  function setSwapper(address newSwapper) external onlyOwner {
    if (newSwapper == address(0)) revert Errors.ZeroAddress();
    if (newSwapper == swapper) revert Errors.AlreadySet();

    address oldSwapper = swapper;
    swapper = newSwapper;

    emit SetSwapper(oldSwapper, newSwapper);
  }

  /**
   * @notice Updates the Incentives Claimer address
   * @param newIncentivesClaimer Address of the new Incentives Claimer
   */
  function setIncentivesClaimer(address newIncentivesClaimer) external onlyOwner {
    if (newIncentivesClaimer == address(0)) revert Errors.ZeroAddress();
    if (newIncentivesClaimer == incentivesClaimer) revert Errors.AlreadySet();

    address oldIncentivesClaimer = incentivesClaimer;
    incentivesClaimer = newIncentivesClaimer;

    emit SetIncentivesClaimer(oldIncentivesClaimer, newIncentivesClaimer);
  }

  /**
   * @notice Updates the Fee Receiver address
   * @param newFeeReceiver Address of the new Fee Receiver
   */
  function setFeeReceiver(address newFeeReceiver) external onlyOwner {
    if (newFeeReceiver == address(0)) revert Errors.ZeroAddress();
    if (newFeeReceiver == feeReceiver) revert Errors.AlreadySet();

    address oldFeeReceiver = feeReceiver;
    feeReceiver = newFeeReceiver;

    emit SetFeeReceiver(oldFeeReceiver, newFeeReceiver);
  }

  /**
   * @notice Updates the Fee ratio
   * @param newFeeRatio Value (BPS) of the new fee ratio
   */
  function setFeeRatio(uint256 newFeeRatio) external onlyOwner {
    if (newFeeRatio > 1000) revert Errors.InvalidFeeRatio();
    if (newFeeRatio == feeRatio) revert Errors.AlreadySet();

    uint256 oldFeeRatio = feeRatio;
    feeRatio = newFeeRatio;

    emit SetFeeRatio(oldFeeRatio, newFeeRatio);
  }

  /**
   * @notice Sets a Locker contract for a token
   * @param token Address of the token
   * @param locker Address of the Locker contract
   */
  function setLocker(address token, address locker) external onlyOwner {
    if (token == address(0) || locker == address(0)) revert Errors.ZeroAddress();
    if (tokenFarmers[token] != address(0)) revert Errors.ListedFarmer();

    if (tokenLockers[token] != address(0)) {
      // if the token has already been assigned to another locker
      // remove the old locker without leaving holes in the array
      address oldLocker = tokenLockers[token];
      // disable the previously harvestable locker
      harvestable[oldLocker] = false;
      address[] memory _lockers = lockers;
      uint256 length = _lockers.length;
      uint256 lastIndex = length - 1;
      for (uint256 i; i < length;) {
        if (_lockers[i] == oldLocker) {
          if (i != lastIndex) {
            lockers[i] = _lockers[lastIndex];
          }

          lockers.pop();

          break;
        }

        unchecked {
          ++i;
        }
      }
    }

    // append the new locker to the list
    lockers.push(locker);
    // link the token to the associated locker
    tokenLockers[token] = locker;
    // whitelist the locker so that the controller can harvest it
    harvestable[locker] = true;

    emit SetLocker(token, locker);
  }

  /**
   * @notice Sets a Farmer contract for a token
   * @param token Address of the token
   * @param farmer Address of the Farmer contract
   */
  function setFarmer(address token, address farmer) external onlyOwner {
    if (token == address(0) || farmer == address(0)) revert Errors.ZeroAddress();
    if (tokenLockers[token] != address(0)) revert Errors.ListedLocker();

    if (tokenFarmers[token] != address(0)) {
      // if the token has already been assigned to another farmer
      // remove the old farmer without leaving holes in the array
      address oldFarmer = tokenFarmers[token];
      // disable the previously harvestable farmer
      harvestable[oldFarmer] = false;
      address[] memory _farmers = farmers;
      uint256 length = _farmers.length;
      uint256 lastIndex = length - 1;
      for (uint256 i; i < length;) {
        if (_farmers[i] == oldFarmer) {
          if (i != lastIndex) {
            farmers[i] = _farmers[lastIndex];
          }

          farmers.pop();

          break;
        }

        unchecked {
          ++i;
        }
      }
    }
    // append the new farmer to the list
    farmers.push(farmer);
    // link the token to the associated farmer
    tokenFarmers[token] = farmer;
    // whitelist the farmer so that the controller can harvest it
    harvestable[farmer] = true;

    emit SetFarmer(token, farmer);
  }

  /**
   * @notice Sets a token for direct distribution
   * @param token Address of the token
   * @param distribution True if the token is for direct distribution
   */
  function setDistributionToken(address token, bool distribution) external onlyOwner {
    if (token == address(0)) revert Errors.ZeroAddress();
    if (tokenLockers[token] != address(0)) revert Errors.ListedLocker();
    if (tokenFarmers[token] != address(0)) revert Errors.ListedFarmer();

    distributionTokens[token] = distribution;

    emit SetDistributionToken(token, distribution);
  }

  /**
   * @notice Enable/disable the harvest function to be called on the token
   * @param target Address of the IHarvestable contract
   * @param enabled True if the contract should be harvested
   */
  function setHarvestableToken(address target, bool enabled) external onlyOwner {
    if (target == address(0)) revert Errors.ZeroAddress();

    harvestable[target] = enabled;

    emit SetHarvestable(target, enabled);
  }
}

// File: src/utils/Owner.sol



// SPDX-License-Identifier: MIT
pragma solidity 0.8.16;

import "openzeppelin/access/Ownable.sol";

/**
 * @title Extend OZ Ownable contract
 */
/// @author Paladin

contract Owner is Ownable {
  address public pendingOwner;

  event NewPendingOwner(address indexed previousPendingOwner, address indexed newPendingOwner);

  error CannotBeOwner();
  error CallerNotPendingOwner();
  error OwnerAddressZero();

  function transferOwnership(address newOwner) public virtual override onlyOwner {
    if (newOwner == address(0)) revert OwnerAddressZero();
    if (newOwner == owner()) revert CannotBeOwner();
    address oldPendingOwner = pendingOwner;

    pendingOwner = newOwner;

    emit NewPendingOwner(oldPendingOwner, newOwner);
  }

  function acceptOwnership() public virtual {
    if (msg.sender != pendingOwner) revert CallerNotPendingOwner();
    address newOwner = pendingOwner;
    _transferOwnership(pendingOwner);
    pendingOwner = address(0);

    emit NewPendingOwner(newOwner, address(0));
  }
}

// File: lib/openzeppelin-contracts/contracts/token/ERC20/IERC20.sol



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

pragma solidity ^0.8.0;

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

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

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

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

    /**
     * @dev Moves `amount` 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 amount) 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 `amount` 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 amount) external returns (bool);

    /**
     * @dev Moves `amount` tokens from `from` to `to` using the
     * allowance mechanism. `amount` 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 amount
    ) external returns (bool);
}

// File: lib/openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol



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

pragma solidity ^0.8.0;

import "../IERC20.sol";
import "../extensions/draft-IERC20Permit.sol";
import "../../../utils/Address.sol";

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

    function safeTransfer(
        IERC20 token,
        address to,
        uint256 value
    ) internal {
        _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
    }

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

    /**
     * @dev Deprecated. This function has issues similar to the ones found in
     * {IERC20-approve}, and its usage is discouraged.
     *
     * Whenever possible, use {safeIncreaseAllowance} and
     * {safeDecreaseAllowance} instead.
     */
    function safeApprove(
        IERC20 token,
        address spender,
        uint256 value
    ) internal {
        // safeApprove should only be called when setting an initial allowance,
        // or when resetting it to zero. To increase and decrease it, use
        // 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
        require(
            (value == 0) || (token.allowance(address(this), spender) == 0),
            "SafeERC20: approve from non-zero to non-zero allowance"
        );
        _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
    }

    function safeIncreaseAllowance(
        IERC20 token,
        address spender,
        uint256 value
    ) internal {
        uint256 newAllowance = token.allowance(address(this), spender) + value;
        _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
    }

    function safeDecreaseAllowance(
        IERC20 token,
        address spender,
        uint256 value
    ) internal {
        unchecked {
            uint256 oldAllowance = token.allowance(address(this), spender);
            require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
            uint256 newAllowance = oldAllowance - value;
            _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
        }
    }

    function safePermit(
        IERC20Permit token,
        address owner,
        address spender,
        uint256 value,
        uint256 deadline,
        uint8 v,
        bytes32 r,
        bytes32 s
    ) internal {
        uint256 nonceBefore = token.nonces(owner);
        token.permit(owner, spender, value, deadline, v, r, s);
        uint256 nonceAfter = token.nonces(owner);
        require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
    }

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

        bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
        if (returndata.length > 0) {
            // Return data is optional
            require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
        }
    }
}

// File: lib/openzeppelin-contracts/contracts/security/Pausable.sol



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

pragma solidity ^0.8.0;

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

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

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

    bool private _paused;

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

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

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

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

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

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

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

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

// File: lib/openzeppelin-contracts/contracts/security/ReentrancyGuard.sol



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

pragma solidity ^0.8.0;

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

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

    uint256 private _status;

    constructor() {
        _status = _NOT_ENTERED;
    }

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

    function _nonReentrantBefore() private {
        // On the first call to nonReentrant, _status will be _NOT_ENTERED
        require(_status != _ENTERED, "ReentrancyGuard: reentrant call");

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

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

// File: src/utils/Errors.sol



pragma solidity 0.8.16;
//SPDX-License-Identifier: Unlicensed

library Errors {
  // Argument validation
  error ZeroAddress();
  error ZeroValue();
  error DifferentSizeArrays(uint256 size1, uint256 size2);
  error EmptyArray();
  error AlreadySet();
  error SameAddress();
  error InvalidParameter();

  // Ownership
  error CannotBeOwner();
  error CallerNotPendingOwner();
  error CallerNotAllowed();

  // Token
  error AllowanceUnderflow();

  // Controller
  error ListedLocker();
  error ListedFarmer();
  error InvalidFeeRatio();
  error HarvestNotAllowed();

  // Locker
  error NoWarLocker(); // _locker[token] == 0x0
  error LockerShutdown();
  error MismatchingLocker(address expected, address actual);

  // Minter
  error MintAmountBiggerThanSupply();

  // Redeemer
  error NotListedLocker();
  error InvalidIndex();
  error CannotRedeemYet();
  error AlreadyRedeemed();
  error InvalidWeightSum();

  // Staker
  error AlreadyListedDepositor();
  error NotListedDepositor();
  error MismatchingFarmer();

  // MintRatio
  error ZeroMintAmount();
  error SupplyAlreadySet();
  error RatioAlreadySet();

  // Harvestable
  error NotRewardToken();

  // IFarmer
  error IncorrectToken();
  error UnstakingMoreThanBalance();

  // Maths
  error NumberExceed128Bits();

  // AuraBalFarmer
  error SlippageTooHigh();

  // Admin
  error RecoverForbidden();

  // AuraLocker
  error DelegationRequiresLock();
}

// File: src/interfaces/IHarvestable.sol



// SPDX-License-Identifier: Unlicensed
pragma solidity 0.8.16;

interface IHarvestable {
  function harvest() external;
  function rewardTokens() external view returns (address[] memory);
}

// File: src/interfaces/IMinter.sol



// SPDX-License-Identifier: Unlicensed
pragma solidity 0.8.16;

interface IMinter {
  function mint(address vlToken, uint256 amount) external;
  function mintMultiple(address[] calldata vlTokens, uint256[] calldata amounts) external;
}

// File: src/interfaces/IStaker.sol



// SPDX-License-Identifier: Unlicensed
pragma solidity 0.8.16;

interface IStaker {
  function queueRewards(address rewardToken, uint256 amount) external returns (bool);

  function stake(uint256 amount, address receiver) external returns (uint256);
}

// File: src/interfaces/IFarmer.sol



// SPDX-License-Identifier: Unlicensed
pragma solidity 0.8.16;

interface IFarmer {
  // the index stored by the farmer represents all the recevied tokens
  function getCurrentIndex() external view returns (uint256);
  function sendTokens(address receiver, uint256 amount) external;
  function stake(address token, uint256 amount) external;
  function token() external view returns (address);
}

// File: src/interfaces/IIncentivizedLocker.sol



// SPDX-License-Identifier: Unlicensed
pragma solidity 0.8.16;

import {IHiddenHandDistributor} from "interfaces/external/incentives/IIncentivesDistributors.sol";

interface IIncentivizedLocker {
  function claimQuestRewards(
    address distributor,
    uint256 questID,
    uint256 period,
    uint256 index,
    address account,
    uint256 amount,
    bytes32[] calldata merkleProof
  ) external;

  function claimDelegationRewards(
    address distributor,
    address token,
    uint256 index,
    address account,
    uint256 amount,
    bytes32[] calldata merkleProof
  ) external;

  function claimVotiumRewards(
    address distributor,
    address token,
    uint256 index,
    address account,
    uint256 amount,
    bytes32[] calldata merkleProof
  ) external;

  function claimHiddenHandRewards(address distributor, IHiddenHandDistributor.Claim[] calldata claimParams) external;
}

// File: src/interfaces/external/incentives/IIncentivesDistributors.sol



// SPDX-License-Identifier: Unlicensed
pragma solidity 0.8.16;

interface IQuestDistributor {
  function questRewardToken(uint256 questID) external view returns (address);

  //Struct ClaimParams
  struct ClaimParams {
    uint256 questID;
    uint256 period;
    uint256 index;
    uint256 amount;
    bytes32[] merkleProof;
  }

  function claim(
    uint256 questID,
    uint256 period,
    uint256 index,
    address account,
    uint256 amount,
    bytes32[] calldata merkleProof
  ) external;
}

interface IDelegationDistributor {
  //Struct ClaimParams
  struct ClaimParams {
    address token;
    uint256 index;
    uint256 amount;
    bytes32[] merkleProof;
  }

  function claim(address token, uint256 index, address account, uint256 amount, bytes32[] calldata merkleProof)
    external;
}

interface IVotiumDistributor {
  struct claimParam {
    address token;
    uint256 index;
    uint256 amount;
    bytes32[] merkleProof;
  }

  function claim(address token, uint256 index, address account, uint256 amount, bytes32[] calldata merkleProof)
    external;
}

interface IHiddenHandDistributor {
  struct Reward {
    address token;
    bytes32 merkleRoot;
    bytes32 proof;
    uint256 updateCount;
  }

  function rewards(bytes32 indentifier) external view returns (Reward memory);

  struct Claim {
    bytes32 identifier;
    address account;
    uint256 amount;
    bytes32[] merkleProof;
  }

  function claim(Claim[] calldata _claims) external;
}

// File: lib/openzeppelin-contracts/contracts/access/Ownable.sol



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

pragma solidity ^0.8.0;

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

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

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

    /**
     * @dev Initializes the contract setting the deployer as the initial owner.
     */
    constructor() {
        _transferOwnership(_msgSender());
    }

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

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

    /**
     * @dev Throws if the sender is not the owner.
     */
    function _checkOwner() internal view virtual {
        require(owner() == _msgSender(), "Ownable: caller is not the owner");
    }

    /**
     * @dev Leaves the contract without owner. It will not be possible to call
     * `onlyOwner` functions anymore. Can only be called by the current owner.
     *
     * NOTE: Renouncing ownership will leave the contract without an owner,
     * thereby removing 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 {
        require(newOwner != address(0), "Ownable: new owner is the zero address");
        _transferOwnership(newOwner);
    }

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

// File: lib/openzeppelin-contracts/contracts/token/ERC20/extensions/draft-IERC20Permit.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)

pragma solidity ^0.8.0;

/**
 * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
 * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
 *
 * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
 * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
 * need to send a transaction, and thus is not required to hold Ether at all.
 */
interface IERC20Permit {
    /**
     * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
     * given ``owner``'s signed approval.
     *
     * IMPORTANT: The same issues {IERC20-approve} has related to transaction
     * ordering also apply here.
     *
     * Emits an {Approval} event.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     * - `deadline` must be a timestamp in the future.
     * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
     * over the EIP712-formatted function arguments.
     * - the signature must use ``owner``'s current nonce (see {nonces}).
     *
     * For more information on the signature format, see the
     * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
     * section].
     */
    function permit(
        address owner,
        address spender,
        uint256 value,
        uint256 deadline,
        uint8 v,
        bytes32 r,
        bytes32 s
    ) external;

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

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

// File: lib/openzeppelin-contracts/contracts/utils/Address.sol



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

pragma solidity ^0.8.1;

/**
 * @dev Collection of functions related to the address type
 */
library Address {
    /**
     * @dev Returns true if `account` is a contract.
     *
     * [IMPORTANT]
     * ====
     * It is unsafe to assume that an address for which this function returns
     * false is an externally-owned account (EOA) and not a contract.
     *
     * Among others, `isContract` will return false for the following
     * types of addresses:
     *
     *  - an externally-owned account
     *  - a contract in construction
     *  - an address where a contract will be created
     *  - an address where a contract lived, but was destroyed
     * ====
     *
     * [IMPORTANT]
     * ====
     * You shouldn't rely on `isContract` to protect against flash loan attacks!
     *
     * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
     * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
     * constructor.
     * ====
     */
    function isContract(address account) internal view returns (bool) {
        // This method relies on extcodesize/address.code.length, which returns 0
        // for contracts in construction, since the code is only stored at the end
        // of the constructor execution.

        return account.code.length > 0;
    }

    /**
     * @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://diligence.consensys.net/posts/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.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
     */
    function sendValue(address payable recipient, uint256 amount) internal {
        require(address(this).balance >= amount, "Address: insufficient balance");

        (bool success, ) = recipient.call{value: amount}("");
        require(success, "Address: unable to send value, recipient may have reverted");
    }

    /**
     * @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, it is bubbled up by this
     * function (like regular Solidity function calls).
     *
     * 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.
     *
     * _Available since v3.1._
     */
    function functionCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionCallWithValue(target, data, 0, "Address: low-level call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
     * `errorMessage` as a fallback revert reason when `target` reverts.
     *
     * _Available since v3.1._
     */
    function functionCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal returns (bytes memory) {
        return functionCallWithValue(target, data, 0, errorMessage);
    }

    /**
     * @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`.
     *
     * _Available since v3.1._
     */
    function functionCallWithValue(
        address target,
        bytes memory data,
        uint256 value
    ) internal returns (bytes memory) {
        return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
    }

    /**
     * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
     * with `errorMessage` as a fallback revert reason when `target` reverts.
     *
     * _Available since v3.1._
     */
    function functionCallWithValue(
        address target,
        bytes memory data,
        uint256 value,
        string memory errorMessage
    ) internal returns (bytes memory) {
        require(address(this).balance >= value, "Address: insufficient balance for call");
        (bool success, bytes memory returndata) = target.call{value: value}(data);
        return verifyCallResultFromTarget(target, success, returndata, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a static call.
     *
     * _Available since v3.3._
     */
    function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
        return functionStaticCall(target, data, "Address: low-level static call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a static call.
     *
     * _Available since v3.3._
     */
    function functionStaticCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal view returns (bytes memory) {
        (bool success, bytes memory returndata) = target.staticcall(data);
        return verifyCallResultFromTarget(target, success, returndata, errorMessage);
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but performing a delegate call.
     *
     * _Available since v3.4._
     */
    function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
        return functionDelegateCall(target, data, "Address: low-level delegate call failed");
    }

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
     * but performing a delegate call.
     *
     * _Available since v3.4._
     */
    function functionDelegateCall(
        address target,
        bytes memory data,
        string memory errorMessage
    ) internal returns (bytes memory) {
        (bool success, bytes memory returndata) = target.delegatecall(data);
        return verifyCallResultFromTarget(target, success, returndata, errorMessage);
    }

    /**
     * @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
     * the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
     *
     * _Available since v4.8._
     */
    function verifyCallResultFromTarget(
        address target,
        bool success,
        bytes memory returndata,
        string memory errorMessage
    ) internal view returns (bytes memory) {
        if (success) {
            if (returndata.length == 0) {
                // only check isContract if the call was successful and the return data is empty
                // otherwise we already know that it was a contract
                require(isContract(target), "Address: call to non-contract");
            }
            return returndata;
        } else {
            _revert(returndata, errorMessage);
        }
    }

    /**
     * @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
     * revert reason or using the provided one.
     *
     * _Available since v4.3._
     */
    function verifyCallResult(
        bool success,
        bytes memory returndata,
        string memory errorMessage
    ) internal pure returns (bytes memory) {
        if (success) {
            return returndata;
        } else {
            _revert(returndata, errorMessage);
        }
    }

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

// File: lib/openzeppelin-contracts/contracts/utils/Context.sol



// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)

pragma solidity ^0.8.0;

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

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