// File: contracts/EGGToken.sol



// SPDX-License-Identifier: MIT

/*

&_--~- ,_                     /""\      ,
{        ",       THE       <>^  L____/|
(  )_ ,{ ,_@       FARM	     `) /`   , /
 |/  {|\{           GAME       \ `---' /
 ""   " "                       `'";\)`
W: https://thefarm.game           _/_Y
T: @The_Farm_Game

 * Howdy folks! Thanks for glancing over our contracts
 * If you're interested in working with us, you can email us at farmhand@thefarm.game
 * Found a broken egg in our contracts? We have a bug bounty program bugs@thefarm.game
 * Y'all have a nice day

*/

pragma solidity ^0.8.17;

import '@openzeppelin/contracts/access/Ownable.sol';
import '@openzeppelin/contracts/token/ERC20/ERC20.sol';
import './interfaces/IEGGToken.sol';
import './interfaces/IEGGTaxCalc.sol';
import './interfaces/IRandomizer.sol';
import './external/UniSwapV2/IUniswapV2Factory.sol';
import './external/UniSwapV2/IUniswapV2Router02.sol';

contract EGGToken is Context, ERC20, Ownable {
  // Events
  event SwapAndLiquifyEnabledUpdated(bool enabled);
  event SwapAndLiquify(uint256 tokensSwapped, uint256 ethReceived, uint256 tokensIntoLiqudity);
  event InitializedContract(address thisContract);

  struct TaxFeeStructure {
    address recipientAddress; // address to send fee to
    bool sendToContract; // This enables sending to above contract or not
    uint256 fee; // Percentage of tax fee
    uint256 previousFee; // Previous fee
    bool swapForEth; // if true then run swapTokensForEth
  }

  /**
   * 0 => Liquidity Fee Tax structure
   * 1 => Auto Burn Fee Tax structure
   * 2 => Dev Fee Tax structure
   * 3 => HenHouse Contract Fee Tax structure
   * 4 => DAO Fee Tax structure
   */

  TaxFeeStructure[] public taxFeeStructures;

  mapping(address => bool) private controllers; // address => allowedToCallFunctions

  mapping(address => bool) private _isExcludedFee; // Address list to exculde the tax fee when EGG transfer
  mapping(address => bool) private _isExcludedReward; // Address list to exculde the reflection reward
  address[] private _excluded; // Address array excluded from reflection

  // References
  IRandomizer public randomizer; // Reference to Randomizer
  IEGGTaxCalc public eggTaxCalc; // Reference to EGGTaxCalc
  IUniswapV2Router02 public immutable uniswapV2Router; // Ref to Router

  uint256 public totalMinted = 0; // Track the total minted amount

  uint256 public totalBurned = 0; // Track the total burned amount

  uint256 public _maxTxAmount = 4000000000 * 10**18; // Max amount avaialble for a single tx
  uint256 private numTokensSellToAddToLiquidity = 500000 * 10**18; // Minimum amount to add EGG to liquidity pool
  uint256 private globalMutiplier = 4;

  uint256 private accruedSwapTax = 0;
  address public immutable uniswapV2Pair;

  address public liquidityTokenRecipient; // Recipient Address to get liquidityToken while swapping

  // Dev wallet
  uint256 public emissionPercent = 909; // Rate for the dev emission => 9.09%. 10000 = 100%, 500 = 5%
  address public emissionsAddress; // Dev emission address to receive 9.09% of mint $EGG

  bool inSwapAndLiquify;
  bool public swapAndLiquifyEnabled = false;

  /**
   * @dev Modifer to require the swap and liquify is alloed or not
   */

  modifier lockTheSwap() {
    inSwapAndLiquify = true;
    _;
    inSwapAndLiquify = false;
  }

  /**
   * @dev Modifer to require _msgSender() to be a controller
   */
  modifier onlyController() {
    _isController();
    _;
  }

  // Optimize for bytecode size
  function _isController() internal view {
    require(controllers[_msgSender()], 'Only controllers');
  }

  // Tracks the last block that a caller has written to state.
  // Disallow some access to functions if they occur while a change is being written.
  mapping(address => uint256) private lastWrite;

  uint256 taxDivisor = 10; // Tax rate
  address public burnAddress = 0x000000000000000000000000000000000000dEaD;

  constructor(
    IRandomizer _randomizer,
    address sushiswapRouter,
    IEGGTaxCalc _eggTaxCalc
  ) ERC20('TFG: EGG Token', 'EGG') {
    controllers[_msgSender()] = true;
    randomizer = _randomizer;
    eggTaxCalc = _eggTaxCalc;
    emissionsAddress = _msgSender();

    IUniswapV2Router02 _uniswapV2Router = IUniswapV2Router02(sushiswapRouter);
    // Set the rest of the contract variables
    uniswapV2Router = _uniswapV2Router;

    // Create a sushiswap pair for this new token
    uniswapV2Pair = IUniswapV2Factory(uniswapV2Router.factory()).createPair(address(this), uniswapV2Router.WETH());

    // Exclude owner and this contract from fee
    _isExcludedFee[owner()] = true;
    _isExcludedFee[address(this)] = true;
    controllers[_msgSender()] = true;

    emit InitializedContract(address(this));
  }

  /**
   * @notice Mints EGG to a recipient.
   * @param to the recipient of the EGG
   * @param amount Amount of EGG to mint
   */

  function mint(address to, uint256 amount) external onlyController {
    uint256 tDevEmissionFee = calculateDevEmission(amount);
    _mint(to, amount);

    _mint(emissionsAddress, tDevEmissionFee);

    totalMinted = totalMinted + (amount + tDevEmissionFee);
  }

  /**
   * @notice Burn the EGG tokens from the address
   * @param _from Receipt address to mint the tokens
   * @param _amount The amount of tokens to burn
   */

  function burn(address _from, uint256 _amount) public onlyController {
    _burn(_from, _amount);
    totalBurned = totalBurned + _amount;
  }

  function transfer(address to, uint256 amount) public override returns (bool) {
    require(amount > 0, 'Transfer amount must be greater than zero');

    uint256 balanceSender = balanceOf(msg.sender);
    require(balanceSender >= amount, 'ERC20: Not enought balance for transfer');
    if (msg.sender != owner() && to != owner()) require(amount <= _maxTxAmount, 'Transfer amount exceeds maxTxAmount');

    // Is the token balance of this contract address over the min number of
    // tokens that we need to initiate a swap + liquidity lock?
    // also, don't get caught in a circular liquidity event.
    // also, don't swap & liquify if sender is uniswap pair.
    uint256 contractTokenBalance = balanceOf(address(this));
    contractTokenBalance = contractTokenBalance - accruedSwapTax;

    if (contractTokenBalance >= _maxTxAmount) {
      contractTokenBalance = _maxTxAmount;
    }

    bool overMinTokenBalance = contractTokenBalance >= numTokensSellToAddToLiquidity;

    if (overMinTokenBalance && !inSwapAndLiquify && msg.sender != uniswapV2Pair && swapAndLiquifyEnabled) {
      contractTokenBalance = numTokensSellToAddToLiquidity;
      // Add liquidity
      swapAndLiquify(contractTokenBalance);
    }

    // Indicates if fee should be deducted from transfer

    uint256 transferAmount = amount;
    uint256 taxAmount = 0;
    // If any account belongs to _isExcludedFromFee account then remove the fee
    if (_isExcludedFee[msg.sender] || _isExcludedFee[to]) {
      _transfer(msg.sender, to, transferAmount);
    } else {
      // Transfer Tax is applied by 50% chance
      (uint256 randomTaxRate, uint256 taxChance) = eggTaxCalc.getTaxRate(msg.sender);

      uint256 randomChance = randomizer.random() % 10000;

      if (randomChance > taxChance) {
        _transfer(msg.sender, to, transferAmount);
      } else {
        taxAmount = (amount * randomTaxRate) / 10**globalMutiplier;

        transferAmount = transferAmount - taxAmount;
        _transfer(msg.sender, to, transferAmount);
        uint256[] memory _taxFees = calculateTaxFees(taxAmount);
        distributeTax(_taxFees);
      }
    }

    // _transfer(msg.sender, burnAddress, taxAmount);

    return true;
  }

  /**
   * ██ ███    ██ ████████
   * ██ ████   ██    ██
   * ██ ██ ██  ██    ██
   * ██ ██  ██ ██    ██
   * ██ ██   ████    ██
   * This section has internal only functions
   */

  /**
   * @notice Internal call to enable an address to call controller only functions
   * @param _address the address to enable
   */
  function _addController(address _address) internal {
    controllers[_address] = true;
  }

  /**
   * @notice Exclude the account from the tax fee
   * @dev Only callable by an existing controller
   * @param account Address to exclude the tax fee
   */

  function _excludeFromFee(address account) internal {
    require(!_isExcludedFee[account], 'Account already excluded');
    _isExcludedFee[account] = true;
  }

  /**
   * ██████  ██████  ██ ██    ██  █████  ████████ ███████
   * ██   ██ ██   ██ ██ ██    ██ ██   ██    ██    ██
   * ██████  ██████  ██ ██    ██ ███████    ██    █████
   * ██      ██   ██ ██  ██  ██  ██   ██    ██    ██
   * ██      ██   ██ ██   ████   ██   ██    ██    ███████
   * This section is for private fucntions
   */

  /**
   * @notice Calculate the dev emission fee when the tokens mint
   * @param _amount EGG token tax amount
   */

  function calculateDevEmission(uint256 _amount) private view returns (uint256) {
    uint256 emission = (_amount * emissionPercent) / 10**globalMutiplier;
    return emission;
  }

  /**
   * @notice Calculate the all taxFees (liquidity, autoburn, dev, henhouse, dao)
   * @param _amount EGG token tax amount
   */

  function calculateTaxFees(uint256 _amount) private view returns (uint256[] memory) {
    uint256[] memory _taxFees = new uint256[](taxFeeStructures.length);
    uint256 max = taxFeeStructures.length;
    for (uint8 i = 0; i < max; ) {
      TaxFeeStructure memory taxFeeStructure = taxFeeStructures[i];
      uint256 taxFeeCalc = (_amount * taxFeeStructure.fee) / 10**globalMutiplier;
      _taxFees[i] = taxFeeCalc;
      unchecked {
        i++;
      }
    }
    return _taxFees;
  }

  /**
   * @notice Transfer all tax fees to specific address regarding TaxFeeStructure data
   * @param _tAmounts Array of tax fees (0 => liquidity, 1 => autoburn, 2 => dev, 3 => henhouse, 4 => dao)
   */

  function distributeTax(uint256[] memory _tAmounts) private {
    uint256 max = _tAmounts.length;
    for (uint8 i = 0; i < max; ) {
      if (_tAmounts[i] == 0) continue;
      TaxFeeStructure memory taxFeeStructure = taxFeeStructures[i];

      address recipientAddress = taxFeeStructure.recipientAddress;

      require(address(recipientAddress) != address(0), "Recipient address isn't set yet!");

      uint256 tAmount = _tAmounts[i];

      if (taxFeeStructure.swapForEth) {
        if (swapAndLiquifyEnabled) {
          // 1. Transfer full EGG amount from msg.sender to this contract
          // 2. Add any accrued taxes to tAmount
          // 3. Divide EGG amount in half
          // 4. swapTokensForEth half EGG amount to ETH & transfer to recipient
          // 5. Transfer EGg to recpient
          _transfer(msg.sender, address(this), tAmount);
          accruedSwapTax += tAmount;

          accruedSwapTax = accruedSwapTax / 2;

          swapTokensForEth(accruedSwapTax, recipientAddress);

          _transfer(address(this), recipientAddress, accruedSwapTax);
          accruedSwapTax = 0;
        } else {
          accruedSwapTax += tAmount;

          _transfer(msg.sender, address(this), tAmount);
        }
      } else {
        _transfer(msg.sender, recipientAddress, tAmount);
      }
      unchecked {
        i++;
      }
    }
  }

  /**
   * @notice Swap the half amount of contract balance to WETH and add to liquidity pool
   * @param _amount Amount of the EggToken to swap
   */

  function swapAndLiquify(uint256 _amount) private lockTheSwap {
    // Split the contract token balance into halves
    uint256 half = _amount / 2;
    uint256 otherHalf = _amount - half;

    // Capture the contract's current ETH balance.
    // This is so that we can capture exactly the amount of ETH that the
    // swap creates, and not make the liquidity event include any ETH that
    // has been manually sent to the contract
    uint256 initialBalance = address(this).balance - accruedSwapTax;

    // Swap tokens for ETH
    swapTokensForEth(half, address(this)); // <- this breaks the ETH -> HATE swap when swap+liquify is triggered

    // Calculate how much ETH was just swapped into this contract
    uint256 newBalance = address(this).balance - initialBalance;

    // Add liquidity to sushiswap
    addLiquidity(otherHalf, newBalance);

    emit SwapAndLiquify(half, newBalance, otherHalf);
  }

  /**
   * @notice Swap the EGG amount to WETH
   * @dev This is used to convert EGG to ETH. The ETH is added this contract, which then gets used by swapAndLiquify to add LP
   * @param tokenAmount EGG token amount to swap ETH
   *
   */

  function swapTokensForEth(uint256 tokenAmount, address recipient) private {
    // Generate the sushiswap pair path of token -> weth
    address[] memory path = new address[](2);
    path[0] = address(this);
    path[1] = uniswapV2Router.WETH();
    _approve(address(this), address(uniswapV2Router), tokenAmount);

    // Make the swap
    uniswapV2Router.swapExactTokensForETHSupportingFeeOnTransferTokens(
      tokenAmount,
      0, // Accept any amount of ETH
      path,
      recipient,
      block.timestamp
    );
  }

  /**
   * @notice Swap the EGG amount to WETH
   * @param tokenAmount EGG token amount to add liquidity pool
   * @param ethAmount ETH amount to add liquidity pool
   */

  function addLiquidity(uint256 tokenAmount, uint256 ethAmount) private {
    // Approve token transfer to cover all possible scenarios
    _approve(address(this), address(uniswapV2Router), tokenAmount);
    _approve(address(this), address(uniswapV2Pair), tokenAmount);

    // Add the liquidity
    uniswapV2Router.addLiquidityETH{ value: ethAmount }(
      address(this),
      tokenAmount,
      0, // Slippage is unavoidable
      0, // Slippage is unavoidable
      liquidityTokenRecipient,
      block.timestamp
    );
  }

  /**
   * @notice Swap the EGG amount to WETH
   * @param tokenAmount EGG token amount to add liquidity pool
   * @param _ethAmount ETH amount to add liquidity pool
   */

  function addLiquidityETH(uint256 tokenAmount, uint256 _ethAmount)
    external
    payable
    onlyController
    returns (
      uint256 _amountToken,
      uint256 _amountETH,
      uint256 _liquidity
    )
  {
    _mint(address(this), tokenAmount);

    // Approve token transfer to cover all possible scenarios
    _approve(address(this), address(uniswapV2Router), tokenAmount);
    uint256 allowanceNow = allowance(address(this), address(uniswapV2Router));

    _approve(_msgSender(), address(uniswapV2Router), tokenAmount);
    allowanceNow = allowance(_msgSender(), address(uniswapV2Router));

    // Add the liquidity
    (uint256 amountToken, uint256 amountETH, uint256 liquidity) = uniswapV2Router.addLiquidityETH{ value: _ethAmount }(
      address(this),
      tokenAmount,
      0, // Slippage is unavoidable
      0, // Slippage is unavoidable
      liquidityTokenRecipient,
      block.timestamp
    );
    return (amountToken, amountETH, liquidity);
  }

  /**
   * ███████ ██   ██ ████████
   * ██       ██ ██     ██
   * █████     ███      ██
   * ██       ██ ██     ██
   * ███████ ██   ██    ██
   * This section has external functions
   */

  /**
   * @dev See {IERC20-transferFrom}.
   *
   * Emits an {Approval} event indicating the updated allowance. This is not
   * required by the EIP. See the note at the beginning of {ERC20}.
   *
   * Requirements:
   *
   * - `sender` and `recipient` cannot be the zero address.
   * - `sender` must have a balance of at least `amount`.
   * - the caller must have allowance for ``sender``'s tokens of at least
   * `amount`.
   */
  function transferFrom(
    address sender,
    address recipient,
    uint256 amount
  ) public virtual override(ERC20) disallowIfStateIsChanging returns (bool) {
    require(controllers[_msgSender()] || lastWrite[sender] < block.number, 'Not allowed');
    // If the entity invoking this transfer is an admin (i.e. the gameContract)
    // allow the transfer without approval. This saves gas and a transaction.
    // The sender address will still need to actually have the amount being attempted to send.
    if (controllers[_msgSender()]) {
      // NOTE: This will omit any events from being written. This saves additional gas,
      // and the event emission is not a requirement by the EIP
      // (read this function summary / ERC20 summary for more details)
      _transfer(sender, recipient, amount);
      return true;
    }

    // If it's not an admin entity (game contract, tower, etc)
    // The entity will need to be given permission to transfer these funds
    return super.transferFrom(sender, recipient, amount);
  }

  /** SECURITEEEEEEEEEEEEEEEEE */

  modifier disallowIfStateIsChanging() {
    // frens can always call whenever they want :)
    require(controllers[_msgSender()] || lastWrite[tx.origin] < block.number, 'Not allowed');
    _;
  }

  /**
   *  ██████  ██████  ███    ██ ████████ ██████   ██████  ██      ██      ███████ ██████
   * ██      ██    ██ ████   ██    ██    ██   ██ ██    ██ ██      ██      ██      ██   ██
   * ██      ██    ██ ██ ██  ██    ██    ██████  ██    ██ ██      ██      █████   ██████
   * ██      ██    ██ ██  ██ ██    ██    ██   ██ ██    ██ ██      ██      ██      ██   ██
   *  ██████  ██████  ██   ████    ██    ██   ██  ██████  ███████ ███████ ███████ ██   ██
   * This section if for controllers (possibly Owner) only functions
   */

  /**
   * @notice enables multiple addresses to call controller only functions
   * @dev Only callable by an existing controller
   * @param _addresses array of the address to enable
   */
  function addManyControllers(address[] memory _addresses) external onlyController {
    for (uint256 i = 0; i < _addresses.length; i++) {
      _addController(_addresses[i]);
    }
  }

  /**
   * @notice removes an address from controller list and ability to call controller only functions
   * @dev Only callable by an existing controller
   * @param _address the address to disable
   */
  function removeController(address _address) external onlyController {
    controllers[_address] = false;
  }

  /**
   * @notice Add the tax data into TaxFeeStructure
   * @param _recipientAddress Recipient address to get EGG tokens
   * @param _sendToContract If _recipientAddress is Deployed contract address, _sendToContract => true. If no, _sendToContract => false
   * @param _fee Tax Fee value of this TaxFeeStructure 10000 = 100%, 1010 = 10.10%
   * @param _previousFee Previous Tax Fee value of this TaxFeeStructure
   * @param _swapForEth If true then run swapTokensForEth
   */

  function addTaxFeeStructure(
    address _recipientAddress,
    bool _sendToContract,
    uint256 _fee,
    uint256 _previousFee,
    bool _swapForEth
  ) external onlyController {
    require(_recipientAddress != address(0), 'Recipient zero address.');
    taxFeeStructures.push(
      TaxFeeStructure({
        recipientAddress: _recipientAddress,
        sendToContract: _sendToContract,
        fee: _fee,
        previousFee: _previousFee,
        swapForEth: _swapForEth
      })
    );
  }

  /**
   * @notice Update the TaxFeeStructure regarding TaxFeeStructure id
   * @dev Only callable by an existing controller
   * @param _recipientAddress Recipient address to get EGG tokens
   * @param _sendToContract If _recipientAddress is Deployed contract address, _sendToContract => true. If no, _sendToContract => false
   * @param _fee Tax Fee value of this TaxFeeStructure. 10000 = 100%, 1010 = 10.10%
   * @param _previousFee Previous Tax Fee value of this TaxFeeStructure
   * @param _swapForEth If true then run swapTokensForEth
   */

  function setTaxFeeStructure(
    uint16 id,
    address _recipientAddress,
    bool _sendToContract,
    uint256 _fee,
    uint256 _previousFee,
    bool _swapForEth
  ) external onlyController {
    require(id < taxFeeStructures.length, "TaxFeeStructrue doesn't exist");
    require(_recipientAddress != address(0), 'Recipient zero address');
    taxFeeStructures[id] = TaxFeeStructure(_recipientAddress, _sendToContract, _fee, _previousFee, _swapForEth);
  }

  /**
   * @notice Remove the TaxFeeStructure regarding TaxFeeStructure id
   * @dev Only callable by an existing controller
   * @param id TaxFeeStructure id to remove the tax fee data from TaxFeeStructure
   */

  function removeTaxFeeStructure(uint16 id) external onlyController {
    require(id < taxFeeStructures.length, "TaxFeeStructrue doesn't exist");
    TaxFeeStructure memory lastTaxFeeStructure = taxFeeStructures[taxFeeStructures.length - 1];
    taxFeeStructures[id] = lastTaxFeeStructure; //  Shuffle last taxFeeStructures to current position
    taxFeeStructures.pop();
  }

  /**
   @notice Get the Tax Fee Structure Info by structure id
   @param id Structure id to get the tax fee structure info
   */

  function getTaxFeeStructure(uint8 id) public view returns (TaxFeeStructure memory) {
    require(id < taxFeeStructures.length, "TaxFeeStructure data isn't exist");
    return taxFeeStructures[id];
  }

  /**
   * @notice Exclude multiple addresses from being taxed fees
   * @dev Only callable by controllers
   * @param _addresses array of the address to exclude
   */
  function excludeManyFromFee(address[] memory _addresses) external onlyController {
    for (uint256 i = 0; i < _addresses.length; i++) {
      _excludeFromFee(_addresses[i]);
    }
  }

  /**
   * @notice Include the account from the tax fee
   * @dev Only callable by an existing controller
   * @param account Address to include the tax fee
   */

  function includeInFee(address account) public onlyController {
    _isExcludedFee[account] = false;
  }

  /**
   * @notice Remove the account from the rewardExculed
   * @dev Only callable by an existing controller
   * @param account Address to include from the reward
   */

  function includeInReward(address account) external onlyController {
    require(_isExcludedReward[account], 'Account already included');
    for (uint256 i = 0; i < _excluded.length; i++) {
      if (_excluded[i] == account) {
        _excluded[i] = _excluded[_excluded.length - 1];
        _isExcludedReward[account] = false;
        _excluded.pop();
        break;
      }
    }
  }

  /**
   * @notice Set the dev emission rate to mint the EGG token to the dev wallet
   * @dev Only callable by an existing controller
   * @param devEmission Rate of dev emission // 909 = 9.09%
   */

  function setDevEmission(uint256 devEmission) external onlyController {
    emissionPercent = devEmission;
  }

  /**
   * @notice Set the dev emission address to send the emission tokens when EGG Tokens mint
   * @dev Only callable by an existing controller
   * @param _emissionAddress Emission address to get the emission EGG Tokens when EGG tokens mint
   */

  function setDevEmissionAddress(address _emissionAddress) external onlyController {
    emissionsAddress = _emissionAddress;
  }

  function setGlobalMutiplier(uint256 _number) external onlyController {
    globalMutiplier = _number;
  }

  /**
   * @notice Set enable state of the swapAndLqiuidityPool
   * @dev Only callable by an existing controller
   * @param _enabled Enable state of the swapAndLiquidityPool
   */

  function setSwapAndLiquifyEnabled(bool _enabled) external onlyController {
    swapAndLiquifyEnabled = _enabled;
    emit SwapAndLiquifyEnabledUpdated(_enabled);
  }

  /**
   * @notice Set the liquidity Token Recipient Address
   * @dev Only callable by an existing controller
   * @param _recipient Recipient Address
   */

  function setLiquidityTokenRecipient(address _recipient) public onlyController {
    liquidityTokenRecipient = _recipient;
  }
}

// File: contracts/interfaces/IEGGTaxCalc.sol



// SPDX-License-Identifier: GPL-3.0

/// @title Interface for EGGTaxCalc

/*
&_--~- ,_                     /""\      ,
{        ",       THE       <>^  L____/|
(  )_ ,{ ,_@       FARM	     `) /`   , /
 |/  {|\{           GAME       \ `---' /
 ""   " "                       `'";\)`
W: https://thefarm.game           _/_Y
T: @The_Farm_Game

 * Howdy folks! Thanks for glancing over our contracts
 * If you're interested in working with us, you can email us at farmhand@thefarm.game
 * Found a broken egg in our contracts? We have a bug bounty program bugs@thefarm.game
 * Y'all have a nice day
*/

pragma solidity ^0.8.17;

interface IEGGTaxCalc {
  function getTaxRate(address sender) external view returns (uint256, uint256);
}

// File: contracts/interfaces/IEGGToken.sol



// SPDX-License-Identifier: MIT

/*

&_--~- ,_                     /""\      ,
{        ",       THE       <>^  L____/|
(  )_ ,{ ,_@       FARM	     `) /`   , /
 |/  {|\{           GAME       \ `---' /
 ""   " "                       `'";\)`
W: https://thefarm.game           _/_Y
T: @The_Farm_Game

 * Howdy folks! Thanks for glancing over our contracts
 * If you're interested in working with us, you can email us at farmhand@thefarm.game
 * Found a broken egg in our contracts? We have a bug bounty program bugs@thefarm.game
 * Y'all have a nice day

*/

pragma solidity ^0.8.17;

interface IEGGToken {
  function balanceOf(address account) external view returns (uint256);

  function mint(address to, uint256 amount) external;

  function burn(address from, uint256 amount) external;

  function transferFrom(
    address sender,
    address recipient,
    uint256 amount
  ) external returns (bool);

  function addLiquidityETH(uint256 tokenAmount, uint256 ethAmount)
    external
    payable
    returns (
      uint256 amountToken,
      uint256 amountETH,
      uint256 liquidity
    );
}

// File: contracts/interfaces/IRandomizer.sol



// SPDX-License-Identifier: MIT

/*

&_--~- ,_                     /""\      ,
{        ",       THE       <>^  L____/|
(  )_ ,{ ,_@       FARM	     `) /`   , /
 |/  {|\{           GAME       \ `---' /
 ""   " "                       `'";\)`
W: https://thefarm.game           _/_Y
T: @The_Farm_Game

 * Howdy folks! Thanks for glancing over our contracts
 * If you're interested in working with us, you can email us at farmhand@thefarm.game
 * Found a broken egg in our contracts? We have a bug bounty program bugs@thefarm.game
 * Y'all have a nice day

*/

pragma solidity ^0.8.17;

interface IRandomizer {
  function random() external view returns (uint256);

  function randomToken(uint256 _tokenId) external view returns (uint256);
}

// File: contracts/external/UniSwapV2/IUniswapV2Router02.sol



// SPDX-License-Identifier: GPL-3.0

pragma solidity >=0.6.2;

import './IUniswapV2Router01.sol';

interface IUniswapV2Router02 is IUniswapV2Router01 {
  function removeLiquidityETHSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
  ) external returns (uint256 amountETH);

  function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
  ) external returns (uint256 amountETH);

  function swapExactTokensForTokensSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external;

  function swapExactETHForTokensSupportingFeeOnTransferTokens(
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external payable;

  function swapExactTokensForETHSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external;
}

// File: contracts/external/UniSwapV2/IUniswapV2Factory.sol



// SPDX-License-Identifier: MIT

pragma solidity >=0.5.0;

interface IUniswapV2Factory {
  event PairCreated(address indexed token0, address indexed token1, address pair, uint256);

  function feeTo() external view returns (address);

  function feeToSetter() external view returns (address);

  function migrator() external view returns (address);

  function getPair(address tokenA, address tokenB) external view returns (address pair);

  function allPairs(uint256) external view returns (address pair);

  function allPairsLength() external view returns (uint256);

  function createPair(address tokenA, address tokenB) external returns (address pair);

  function setFeeTo(address) external;

  function setFeeToSetter(address) external;

  function setMigrator(address) external;
}

// File: @openzeppelin/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: @openzeppelin/contracts/token/ERC20/ERC20.sol



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

pragma solidity ^0.8.0;

import "./IERC20.sol";
import "./extensions/IERC20Metadata.sol";
import "../../utils/Context.sol";

/**
 * @dev Implementation of the {IERC20} interface.
 *
 * This implementation is agnostic to the way tokens are created. This means
 * that a supply mechanism has to be added in a derived contract using {_mint}.
 * For a generic mechanism see {ERC20PresetMinterPauser}.
 *
 * TIP: For a detailed writeup see our guide
 * https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How
 * to implement supply mechanisms].
 *
 * We have followed general OpenZeppelin Contracts guidelines: functions revert
 * instead returning `false` on failure. This behavior is nonetheless
 * conventional and does not conflict with the expectations of ERC20
 * applications.
 *
 * Additionally, an {Approval} event is emitted on calls to {transferFrom}.
 * This allows applications to reconstruct the allowance for all accounts just
 * by listening to said events. Other implementations of the EIP may not emit
 * these events, as it isn't required by the specification.
 *
 * Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
 * functions have been added to mitigate the well-known issues around setting
 * allowances. See {IERC20-approve}.
 */
contract ERC20 is Context, IERC20, IERC20Metadata {
    mapping(address => uint256) private _balances;

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

    uint256 private _totalSupply;

    string private _name;
    string private _symbol;

    /**
     * @dev Sets the values for {name} and {symbol}.
     *
     * The default value of {decimals} is 18. To select a different value for
     * {decimals} you should overload it.
     *
     * All two of these values are immutable: they can only be set once during
     * construction.
     */
    constructor(string memory name_, string memory symbol_) {
        _name = name_;
        _symbol = symbol_;
    }

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

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

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

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

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

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

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

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

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

    /**
     * @dev Atomically increases the allowance granted to `spender` by the caller.
     *
     * This is an alternative to {approve} that can be used as a mitigation for
     * problems described in {IERC20-approve}.
     *
     * Emits an {Approval} event indicating the updated allowance.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     */
    function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
        address owner = _msgSender();
        _approve(owner, spender, allowance(owner, spender) + addedValue);
        return true;
    }

    /**
     * @dev Atomically decreases the allowance granted to `spender` by the caller.
     *
     * This is an alternative to {approve} that can be used as a mitigation for
     * problems described in {IERC20-approve}.
     *
     * Emits an {Approval} event indicating the updated allowance.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     * - `spender` must have allowance for the caller of at least
     * `subtractedValue`.
     */
    function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
        address owner = _msgSender();
        uint256 currentAllowance = allowance(owner, spender);
        require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
        unchecked {
            _approve(owner, spender, currentAllowance - subtractedValue);
        }

        return true;
    }

    /**
     * @dev Moves `amount` of tokens from `from` to `to`.
     *
     * This internal function is equivalent to {transfer}, and can be used to
     * e.g. implement automatic token fees, slashing mechanisms, etc.
     *
     * Emits a {Transfer} event.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `to` cannot be the zero address.
     * - `from` must have a balance of at least `amount`.
     */
    function _transfer(
        address from,
        address to,
        uint256 amount
    ) internal virtual {
        require(from != address(0), "ERC20: transfer from the zero address");
        require(to != address(0), "ERC20: transfer to the zero address");

        _beforeTokenTransfer(from, to, amount);

        uint256 fromBalance = _balances[from];
        require(fromBalance >= amount, "ERC20: transfer amount exceeds balance");
        unchecked {
            _balances[from] = fromBalance - amount;
        }
        _balances[to] += amount;

        emit Transfer(from, to, amount);

        _afterTokenTransfer(from, to, amount);
    }

    /** @dev Creates `amount` tokens and assigns them to `account`, increasing
     * the total supply.
     *
     * Emits a {Transfer} event with `from` set to the zero address.
     *
     * Requirements:
     *
     * - `account` cannot be the zero address.
     */
    function _mint(address account, uint256 amount) internal virtual {
        require(account != address(0), "ERC20: mint to the zero address");

        _beforeTokenTransfer(address(0), account, amount);

        _totalSupply += amount;
        _balances[account] += amount;
        emit Transfer(address(0), account, amount);

        _afterTokenTransfer(address(0), account, amount);
    }

    /**
     * @dev Destroys `amount` tokens from `account`, reducing the
     * total supply.
     *
     * Emits a {Transfer} event with `to` set to the zero address.
     *
     * Requirements:
     *
     * - `account` cannot be the zero address.
     * - `account` must have at least `amount` tokens.
     */
    function _burn(address account, uint256 amount) internal virtual {
        require(account != address(0), "ERC20: burn from the zero address");

        _beforeTokenTransfer(account, address(0), amount);

        uint256 accountBalance = _balances[account];
        require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
        unchecked {
            _balances[account] = accountBalance - amount;
        }
        _totalSupply -= amount;

        emit Transfer(account, address(0), amount);

        _afterTokenTransfer(account, address(0), amount);
    }

    /**
     * @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
     *
     * This internal function is equivalent to `approve`, and can be used to
     * e.g. set automatic allowances for certain subsystems, etc.
     *
     * Emits an {Approval} event.
     *
     * Requirements:
     *
     * - `owner` cannot be the zero address.
     * - `spender` cannot be the zero address.
     */
    function _approve(
        address owner,
        address spender,
        uint256 amount
    ) internal virtual {
        require(owner != address(0), "ERC20: approve from the zero address");
        require(spender != address(0), "ERC20: approve to the zero address");

        _allowances[owner][spender] = amount;
        emit Approval(owner, spender, amount);
    }

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

    /**
     * @dev Hook that is called before any transfer of tokens. This includes
     * minting and burning.
     *
     * Calling conditions:
     *
     * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
     * will be transferred to `to`.
     * - when `from` is zero, `amount` tokens will be minted for `to`.
     * - when `to` is zero, `amount` of ``from``'s tokens will be burned.
     * - `from` and `to` are never both zero.
     *
     * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
     */
    function _beforeTokenTransfer(
        address from,
        address to,
        uint256 amount
    ) internal virtual {}

    /**
     * @dev Hook that is called after any transfer of tokens. This includes
     * minting and burning.
     *
     * Calling conditions:
     *
     * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
     * has been transferred to `to`.
     * - when `from` is zero, `amount` tokens have been minted for `to`.
     * - when `to` is zero, `amount` of ``from``'s tokens have been burned.
     * - `from` and `to` are never both zero.
     *
     * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
     */
    function _afterTokenTransfer(
        address from,
        address to,
        uint256 amount
    ) internal virtual {}
}

// File: contracts/external/UniSwapV2/IUniswapV2Router01.sol



// SPDX-License-Identifier: MIT

pragma solidity >=0.6.2;

interface IUniswapV2Router01 {
  function factory() external pure returns (address);

  function WETH() external pure returns (address);

  function addLiquidity(
    address tokenA,
    address tokenB,
    uint256 amountADesired,
    uint256 amountBDesired,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
  )
    external
    returns (
      uint256 amountA,
      uint256 amountB,
      uint256 liquidity
    );

  function addLiquidityETH(
    address token,
    uint256 amountTokenDesired,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
  )
    external
    payable
    returns (
      uint256 amountToken,
      uint256 amountETH,
      uint256 liquidity
    );

  function removeLiquidity(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
  ) external returns (uint256 amountA, uint256 amountB);

  function removeLiquidityETH(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
  ) external returns (uint256 amountToken, uint256 amountETH);

  function removeLiquidityWithPermit(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
  ) external returns (uint256 amountA, uint256 amountB);

  function removeLiquidityETHWithPermit(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
  ) external returns (uint256 amountToken, uint256 amountETH);

  function swapExactTokensForTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external returns (uint256[] memory amounts);

  function swapTokensForExactTokens(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external returns (uint256[] memory amounts);

  function swapExactETHForTokens(
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external payable returns (uint256[] memory amounts);

  function swapTokensForExactETH(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external returns (uint256[] memory amounts);

  function swapExactTokensForETH(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external returns (uint256[] memory amounts);

  function swapETHForExactTokens(
    uint256 amountOut,
    address[] calldata path,
    address to,
    uint256 deadline
  ) external payable returns (uint256[] memory amounts);

  function quote(
    uint256 amountA,
    uint256 reserveA,
    uint256 reserveB
  ) external pure returns (uint256 amountB);

  function getAmountOut(
    uint256 amountIn,
    uint256 reserveIn,
    uint256 reserveOut
  ) external pure returns (uint256 amountOut);

  function getAmountIn(
    uint256 amountOut,
    uint256 reserveIn,
    uint256 reserveOut
  ) external pure returns (uint256 amountIn);

  function getAmountsOut(uint256 amountIn, address[] calldata path) external view returns (uint256[] memory amounts);

  function getAmountsIn(uint256 amountOut, address[] calldata path) external view returns (uint256[] memory amounts);
}

// File: @openzeppelin/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;
    }
}

// File: @openzeppelin/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: @openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol



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

pragma solidity ^0.8.0;

import "../IERC20.sol";

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

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

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