Contract Source Code (Solidity Standard Json-Input format)

IDE

• Blockscan IDE
• 🤖 Code ReaderBeta

More Options

• Is this a proxy?
• Similar
• Submit Audit
• Compare

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

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

import {IBrushToken} from "../interfaces/external/IBrushToken.sol";
import {IClans} from "../interfaces/IClans.sol";
import {ITerritories} from "../interfaces/ITerritories.sol";
import {IClanMemberLeftCB} from "../interfaces/IClanMemberLeftCB.sol";
import {IPlayers} from "../interfaces/IPlayers.sol";
import {IBank} from "../interfaces/IBank.sol";
import {ISamWitchVRF} from "../interfaces/ISamWitchVRF.sol";

import {LockedBankVaults} from "./LockedBankVaults.sol";
import {AdminAccess} from "../AdminAccess.sol";
import {ItemNFT} from "../ItemNFT.sol";
import {VRFRequestInfo} from "../VRFRequestInfo.sol";

import {ClanRank, MAX_CLAN_COMBATANTS, CLAN_WARS_GAS_PRICE_WINDOW_SIZE, XP_EMITTED_ELSEWHERE} from "../globals/clans.sol";
import {Item, EquipPosition} from "../globals/players.sol";
import {BoostType, Skill} from "../globals/misc.sol";
import {BattleResultEnum} from "../globals/clans.sol";

import {ClanBattleLibrary} from "./ClanBattleLibrary.sol";
import {EstforLibrary} from "../EstforLibrary.sol";

import {IActivityPoints, IActivityPointsCaller, ActivityType} from "../ActivityPoints/interfaces/IActivityPoints.sol";

contract Territories is UUPSUpgradeable, OwnableUpgradeable, ITerritories, IClanMemberLeftCB, IActivityPointsCaller {
  using SafeCast for uint256;

  event AddTerritories(TerritoryInput[] territories);
  event EditTerritories(TerritoryInput[] territories);
  event RemoveTerritories(uint256[] territoryIds);
  event SetMinimumMMRs(uint256[] territoryIds, uint16[] minimumMMRs);
  event AttackTerritory(
    uint256 clanId,
    uint256 territoryId,
    address from,
    uint256 leaderPlayerId,
    uint256 requestId,
    uint256 pendingAttackId,
    uint256 attackingCooldownTimestamp
  );
  event BattleResult(
    uint256 requestId,
    uint64[] attackingPlayerIds,
    uint64[] defendingPlayerIds,
    uint256[] attackingRolls,
    uint256[] defendingRolls,
    uint8[] battleResults, // BattleResultEnum[]
    uint8[] randomSkills, // Skill[]
    bool didAttackersWin,
    uint256 attackingClanId,
    uint256 defendingClanId,
    uint256[] randomWords,
    uint256 territoryId,
    uint256 clanXPGainedWinner
  );
  event Deposit(uint256 amount);
  event SetComparableSkills(Skill[] skills);
  event ClaimUnoccupiedTerritory(
    uint256 territoryId,
    uint256 clanId,
    address from,
    uint256 leaderPlayerId,
    uint256 requestId
  );
  event AssignCombatants(
    uint256 clanId,
    uint64[] playerIds,
    address from,
    uint256 leaderPlayerId,
    uint256 cooldownTimestamp
  );
  event RemoveCombatant(uint256 playerId, uint256 clanId);
  event Harvest(uint256 territoryId, address from, uint256 playerId, uint256 cooldownTimestamp, uint256 amount);
  event SetExpectedGasLimitFulfill(uint256 expectedGasLimitFulfill);
  event SetMaxClanCombatants(uint256 maxClanCombatants);
  event BlockingAttacks(
    uint256 clanId,
    uint256 itemTokenId,
    address from,
    uint256 leaderPlayerId,
    uint256 blockAttacksTimestamp,
    uint256 blockAttacksCooldownTimestamp
  );
  event SetAttackCooldown(uint256 attackCooldown);

  error InvalidTerritory();
  error InvalidTerritoryId();
  error InvalidEmissionPercentage();
  error TransferFailed();
  error RankNotHighEnough();
  error ClanAttackingCooldown();
  error NotMemberOfClan();
  error InvalidSkill(Skill skill);
  error LengthMismatch();
  error OnlyClans();
  error OnlyCombatantsHelper();
  error NotOwnerOfPlayerAndActive();
  error HarvestingTooSoon();
  error NotAdminAndBeta();
  error NoCombatants();
  error TooManyCombatants();
  error PlayerDefendingLockedVaults();
  error CannotChangeCombatantsDuringAttack();
  error NoEmissionsToHarvest();
  error CannotAttackWhileStillAttacking();
  error AmountTooLow();
  error ClanCombatantsChangeCooldown();
  error InsufficientCost();
  error RequestIdNotKnown();
  error ClanIsBlockingAttacks();
  error NotATerritoryDefenceItem();
  error BlockAttacksCooldown();
  error CannotAttackSelf();
  error CallerNotSamWitchVRF();
  error NotEnoughMMR(uint256 minimumMMR);

  struct TerritoryInput {
    uint16 territoryId;
    uint16 percentageEmissions; // Is multiplied by PERCENTAGE_EMISSION_MUL
  }

  struct Territory {
    uint16 territoryId; // TODO: Could be removed if necessary
    uint16 percentageEmissions; // Is multiplied by PERCENTAGE_EMISSION_MUL
    uint40 clanIdOccupier;
    uint88 unclaimedEmissions;
    uint40 lastClaimTimestamp;
    uint16 minimumMMR;
  }

  struct ClanInfo {
    uint16 ownsTerritoryId;
    uint40 attackingCooldownTimestamp;
    uint40 assignCombatantsCooldownTimestamp;
    bool currentlyAttacking;
    uint40 blockAttacksTimestamp;
    uint8 blockAttacksCooldownHours; // Have many hours after blockAttacksTimestamp there is a cooldown for
    uint64[] playerIds;
  }

  struct PendingAttack {
    address from;
    uint16 territoryId;
    uint32 clanId; // Reduced from uint40 to make this fit in a storage c
    bool attackInProgress;
    uint40 leaderPlayerId;
  }

  uint256 private constant NUM_WORDS = 7;
  uint256 public constant MAX_DAILY_EMISSIONS = 10000 ether;
  uint256 public constant TERRITORY_ATTACKED_COOLDOWN_PLAYER = 24 * 3600;
  uint256 public constant PERCENTAGE_EMISSION_MUL = 10;
  uint256 public constant HARVESTING_COOLDOWN = 8 hours;
  uint40 private constant CLAN_XP_GAINED_ON_TERRITORY_WIN = 10;

  mapping(uint256 pendingAttackId => PendingAttack pendingAttack) private _pendingAttacks;
  mapping(bytes32 requestId => uint256 pendingAttackId) private _requestToPendingAttackIds;
  mapping(uint256 territoryId => Territory territory) private _territories;
  address private _players;
  uint16 private _nextTerritoryId;
  uint24 private _attackingCooldown;
  uint56 private _nextPendingAttackId;
  IClans private _clans;
  AdminAccess private _adminAccess;
  bool private _isBeta;
  LockedBankVaults private _lockedBankVaults;
  ItemNFT private _itemNFT;

  mapping(uint256 clanId => ClanInfo clanInfo) private _clanInfos;
  uint16 private _totalEmissionPercentage; // Multiplied by PERCENTAGE_EMISSION_MUL
  IBrushToken private _brush;

  Skill[] private _comparableSkills;

  address private _combatantsHelper;
  uint8 private _maxClanCombatants;

  address private _oracle;
  VRFRequestInfo private _vrfRequestInfo;
  uint24 private _combatantChangeCooldown;
  ISamWitchVRF private _samWitchVRF;
  uint24 private _expectedGasLimitFulfill;

  IActivityPoints private _activityPoints;

  modifier isOwnerOfPlayerAndActive(uint256 playerId) {
    require(IPlayers(_players).isOwnerOfPlayerAndActive(_msgSender(), playerId), NotOwnerOfPlayerAndActive());
    _;
  }

  modifier isMinimumRank(uint256 clanId, uint256 playerId, ClanRank clanRank) {
    require(_clans.getRank(clanId, playerId) >= clanRank, RankNotHighEnough());
    _;
  }

  modifier isClanMember(uint256 clanId, uint256 playerId) {
    require(_clans.getRank(clanId, playerId) != ClanRank.NONE, NotMemberOfClan());
    _;
  }

  modifier isAdminAndBeta() {
    require(_adminAccess.isAdmin(_msgSender()) && _isBeta, NotAdminAndBeta());
    _;
  }

  modifier onlyClans() {
    require(_msgSender() == address(_clans), OnlyClans());
    _;
  }

  modifier onlyCombatantsHelper() {
    require(_msgSender() == _combatantsHelper, OnlyCombatantsHelper());
    _;
  }

  /// @dev Reverts if the caller is not the SamWitchVRF contract.
  modifier onlySamWitchVRF() {
    require(_msgSender() == address(_samWitchVRF), CallerNotSamWitchVRF());
    _;
  }

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

  function initialize(
    TerritoryInput[] calldata territories,
    address players,
    IClans clans,
    IBrushToken brush,
    LockedBankVaults lockedBankVaults,
    ItemNFT itemNFT,
    address oracle,
    ISamWitchVRF samWitchVRF,
    VRFRequestInfo vrfRequestInfo,
    Skill[] calldata comparableSkills,
    uint8 maxClanCombatants,
    uint24 attackingCooldown,
    AdminAccess adminAccess,
    IActivityPoints activityPoints,
    bool isBeta
  ) external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();

    _players = players;
    _clans = clans;
    _brush = brush;
    _lockedBankVaults = lockedBankVaults;
    _itemNFT = itemNFT;
    _oracle = oracle;
    _samWitchVRF = samWitchVRF;
    _vrfRequestInfo = vrfRequestInfo;

    _activityPoints = activityPoints;

    _nextTerritoryId = 1;
    _nextPendingAttackId = 1;
    _adminAccess = adminAccess;
    _isBeta = isBeta;

    _brush.approve(address(_lockedBankVaults), type(uint256).max);
    _combatantChangeCooldown = isBeta ? 5 minutes : 3 days;

    setAttackCooldown(attackingCooldown);
    setExpectedGasLimitFulfill(3_000_000);
    setComparableSkills(comparableSkills);
    setMaxClanCombatants(maxClanCombatants);
    addTerritories(territories);
  }

  // TODO: remove in prod
  function setActivityPoints(address activityPoints) external override onlyOwner {
    _activityPoints = IActivityPoints(activityPoints);
  }

  function assignCombatants(
    uint256 clanId,
    uint64[] calldata playerIds,
    uint256 combatantCooldownTimestamp,
    uint256 leaderPlayerId
  ) external override onlyCombatantsHelper {
    _checkCanAssignCombatants(clanId, playerIds);

    _clanInfos[clanId].playerIds = playerIds;
    _clanInfos[clanId].assignCombatantsCooldownTimestamp = uint40(block.timestamp + _combatantChangeCooldown);
    emit AssignCombatants(clanId, playerIds, _msgSender(), leaderPlayerId, combatantCooldownTimestamp);
  }

  // This needs to call the oracle VRF on-demand and calls the callback
  function attackTerritory(
    uint256 clanId,
    uint256 territoryId,
    uint256 leaderPlayerId
  ) external payable isOwnerOfPlayerAndActive(leaderPlayerId) isMinimumRank(clanId, leaderPlayerId, ClanRank.COLONEL) {
    uint256 clanIdOccupier = _territories[territoryId].clanIdOccupier;

    _checkCanAttackTerritory(clanId, clanIdOccupier, territoryId);

    // Check they are paying enough
    require(msg.value >= getAttackCost(), InsufficientCost());

    (bool success, ) = _oracle.call{value: msg.value}("");
    require(success, TransferFailed());

    uint56 nextPendingAttackId = _nextPendingAttackId++;
    uint40 attackingCooldownTimestamp = uint40(block.timestamp + _attackingCooldown);
    ClanInfo storage clanInfo = _clanInfos[clanId];
    clanInfo.attackingCooldownTimestamp = attackingCooldownTimestamp;

    clanInfo.currentlyAttacking = true;

    address msgSender = _msgSender();
    _pendingAttacks[nextPendingAttackId] = PendingAttack({
      clanId: clanId.toUint32(),
      territoryId: uint16(territoryId),
      attackInProgress: true,
      leaderPlayerId: uint40(leaderPlayerId),
      from: msgSender
    });
    bytes32 requestId = _requestRandomWords();
    _requestToPendingAttackIds[requestId] = nextPendingAttackId;

    emit AttackTerritory(
      clanId,
      territoryId,
      msgSender,
      leaderPlayerId,
      uint256(requestId),
      nextPendingAttackId,
      attackingCooldownTimestamp
    );

    _activityPoints.rewardBlueTickets(
      ActivityType.territories_evt_attackterritory,
      _clans.getClanBankAddress(clanId),
      IPlayers(_players).isPlayerEvolved(leaderPlayerId),
      1
    );
  }

  /// @notice Called by the SamWitchVRF contract to fulfill the request
  function fulfillRandomWords(bytes32 requestId, uint256[] calldata randomWords) external onlySamWitchVRF {
    require(randomWords.length == NUM_WORDS, LengthMismatch());

    PendingAttack storage pendingAttack = _pendingAttacks[_requestToPendingAttackIds[requestId]];
    require(pendingAttack.attackInProgress, RequestIdNotKnown());

    uint256 attackingClanId = pendingAttack.clanId;
    uint16 territoryId = pendingAttack.territoryId;
    uint256 defendingClanId = _territories[territoryId].clanIdOccupier;

    _vrfRequestInfo.updateAverageGasPrice();
    _clanInfos[attackingClanId].currentlyAttacking = false;
    pendingAttack.attackInProgress = false;

    bool clanUnoccupied = defendingClanId == 0;
    if (clanUnoccupied) {
      _claimTerritory(territoryId, attackingClanId);

      emit ClaimUnoccupiedTerritory(
        territoryId,
        attackingClanId,
        pendingAttack.from,
        pendingAttack.leaderPlayerId,
        uint256(requestId)
      );

      _activityPoints.rewardBlueTickets(
        ActivityType.territories_evt_claimunoccupiedterritory,
        _clans.getClanBankAddress(attackingClanId),
        IPlayers(_players).isPlayerEvolved(pendingAttack.leaderPlayerId),
        1
      );

      return;
    }

    // If the defenders happened to apply a block attacks item before the attack was fulfilled, then the attack is cancelled
    uint64[] memory attackingPlayerIds;
    uint64[] memory defendingPlayerIds;
    uint8[] memory battleResults;
    uint256[] memory attackingRolls;
    uint256[] memory defendingRolls;
    uint8[] memory randomSkills;
    bool didAttackersWin;
    if (_clanInfos[defendingClanId].blockAttacksTimestamp <= block.timestamp) {
      attackingPlayerIds = _clanInfos[attackingClanId].playerIds;
      defendingPlayerIds = _clanInfos[defendingClanId].playerIds;

      randomSkills = new uint8[](Math.max(attackingPlayerIds.length, defendingPlayerIds.length));
      for (uint256 i; i < randomSkills.length; ++i) {
        randomSkills[i] = uint8(
          _comparableSkills[uint8(randomWords[NUM_WORDS - 1] >> (i * 8)) % _comparableSkills.length]
        );
      }

      (battleResults, attackingRolls, defendingRolls, didAttackersWin) = ClanBattleLibrary._determineBattleOutcome(
        _players,
        attackingPlayerIds,
        defendingPlayerIds,
        randomSkills,
        randomWords,
        0,
        0
      );
    }

    uint40 clanXPGainedWinner = didAttackersWin ? CLAN_XP_GAINED_ON_TERRITORY_WIN : 0;

    emit BattleResult(
      uint256(requestId),
      attackingPlayerIds,
      defendingPlayerIds,
      attackingRolls,
      defendingRolls,
      battleResults,
      randomSkills,
      didAttackersWin,
      attackingClanId,
      defendingClanId,
      randomWords,
      territoryId,
      clanXPGainedWinner
    );

    if (didAttackersWin) {
      _claimTerritory(territoryId, attackingClanId);
      // Update old clan
      _clanInfos[defendingClanId].ownsTerritoryId = 0;
      _clans.addXP(attackingClanId, clanXPGainedWinner, XP_EMITTED_ELSEWHERE);
    }
  }

  function harvest(
    uint256 territoryId,
    uint256 playerId
  ) external isOwnerOfPlayerAndActive(playerId) isClanMember(_territories[territoryId].clanIdOccupier, playerId) {
    Territory storage territory = _territories[territoryId];
    uint256 unclaimedEmissions = territory.unclaimedEmissions;

    require(territory.lastClaimTimestamp + HARVESTING_COOLDOWN <= block.timestamp, HarvestingTooSoon());

    territory.lastClaimTimestamp = uint40(block.timestamp);
    territory.unclaimedEmissions = 0;
    require(unclaimedEmissions != 0, NoEmissionsToHarvest());

    _lockedBankVaults.lockFunds(territory.clanIdOccupier, _msgSender(), playerId, unclaimedEmissions);
    emit Harvest(territoryId, _msgSender(), playerId, block.timestamp + HARVESTING_COOLDOWN, unclaimedEmissions);
  }

  function addUnclaimedEmissions(uint256 amount) external {
    require(amount >= _totalEmissionPercentage, AmountTooLow());

    for (uint256 i = 1; i < _nextTerritoryId; ++i) {
      _territories[i].unclaimedEmissions += uint88(
        (amount * _territories[i].percentageEmissions) / _totalEmissionPercentage
      );
    }

    require(_brush.transferFrom(_msgSender(), address(this), amount), TransferFailed());
    emit Deposit(amount);
  }

  function blockAttacks(
    uint256 clanId,
    uint16 itemTokenId,
    uint256 playerId
  ) external isOwnerOfPlayerAndActive(playerId) isClanMember(clanId, playerId) {
    Item memory item = _itemNFT.getItem(itemTokenId);
    require(
      item.equipPosition == EquipPosition.TERRITORY && item.boostType == BoostType.PVP_BLOCK,
      NotATerritoryDefenceItem()
    );

    ClanInfo storage clanInfo = _clanInfos[clanId];
    require(
      (clanInfo.blockAttacksTimestamp + uint256(clanInfo.blockAttacksCooldownHours) * 3600) <= block.timestamp,
      BlockAttacksCooldown()
    );

    uint256 blockAttacksTimestamp = block.timestamp + item.boostDuration;
    clanInfo.blockAttacksTimestamp = uint40(blockAttacksTimestamp);
    clanInfo.blockAttacksCooldownHours = uint8(item.boostValue);

    _itemNFT.burn(_msgSender(), itemTokenId, 1);

    emit BlockingAttacks(
      clanId,
      itemTokenId,
      _msgSender(),
      playerId,
      blockAttacksTimestamp,
      blockAttacksTimestamp + uint256(item.boostValue) * 3600
    );
  }

  function clanMemberLeft(uint256 clanId, uint256 playerId) external override onlyClans {
    // Remove a player combatant if they are currently assigned in this clan
    ClanInfo storage clanInfo = _clanInfos[clanId];
    if (clanInfo.playerIds.length != 0) {
      uint256 searchIndex = EstforLibrary._binarySearch(clanInfo.playerIds, playerId);
      if (searchIndex != type(uint256).max) {
        // Shift the whole array to delete the element
        for (uint256 i = searchIndex; i < clanInfo.playerIds.length - 1; ++i) {
          clanInfo.playerIds[i] = clanInfo.playerIds[i + 1];
        }
        clanInfo.playerIds.pop();
        emit RemoveCombatant(playerId, clanId);
      }
    }
  }

  function _checkCanAssignCombatants(uint256 clanId, uint64[] calldata playerIds) private view {
    require(playerIds.length <= _maxClanCombatants, TooManyCombatants());
    // Can only change combatants every so often
    require(_clanInfos[clanId].assignCombatantsCooldownTimestamp <= block.timestamp, ClanCombatantsChangeCooldown());
  }

  function _checkCanAttackTerritory(uint256 clanId, uint256 defendingClanId, uint256 territoryId) private view {
    require(clanId != defendingClanId, CannotAttackSelf());

    Territory storage territory = _territories[territoryId];
    require(territory.territoryId == territoryId, InvalidTerritory());
    require(territory.minimumMMR <= _clans.getMMR(clanId), NotEnoughMMR(territory.minimumMMR));

    ClanInfo storage clanInfo = _clanInfos[clanId];
    // Must have at least 1 combatant
    require(clanInfo.playerIds.length != 0, NoCombatants());
    require(!clanInfo.currentlyAttacking, CannotAttackWhileStillAttacking());
    require(clanInfo.attackingCooldownTimestamp <= block.timestamp, ClanAttackingCooldown());
    require(_clanInfos[defendingClanId].blockAttacksTimestamp <= block.timestamp, ClanIsBlockingAttacks());
    require(clanInfo.playerIds.length != 0, CannotChangeCombatantsDuringAttack());
  }

  function _requestRandomWords() private returns (bytes32 requestId) {
    requestId = _samWitchVRF.requestRandomWords(NUM_WORDS, _expectedGasLimitFulfill);
  }

  function _claimTerritory(uint256 territoryId, uint256 attackingClanId) private {
    _territories[territoryId].clanIdOccupier = uint32(attackingClanId);

    if (_clanInfos[attackingClanId].ownsTerritoryId != 0) {
      // This clan already owns a territory, so unclaim that one
      _territories[_clanInfos[attackingClanId].ownsTerritoryId].clanIdOccupier = 0;
    }

    _clanInfos[attackingClanId].ownsTerritoryId = uint16(territoryId);
  }

  function _checkTerritory(TerritoryInput calldata territory) private pure {
    require(territory.territoryId != 0 && territory.percentageEmissions != 0, InvalidTerritory());
  }

  function getAttackCost() public view returns (uint256) {
    (uint64 movingAverageGasPrice, uint88 baseRequestCost) = _vrfRequestInfo.get();
    return baseRequestCost + (movingAverageGasPrice * _expectedGasLimitFulfill);
  }

  function getTerrorities() external view returns (Territory[] memory) {
    Territory[] memory territories = new Territory[](_nextTerritoryId - 1);
    for (uint256 i; i < territories.length; ++i) {
      territories[i] = _territories[i + 1];
    }
    return territories;
  }

  function getClanInfo(uint256 clanId) external view returns (ClanInfo memory clanInfo) {
    return _clanInfos[clanId];
  }

  function getPendingAttack(uint256 pendingAttackId) external view returns (PendingAttack memory pendingAttack) {
    return _pendingAttacks[pendingAttackId];
  }

  function getTerritory(uint256 territoryId) external view returns (Territory memory territory) {
    return _territories[territoryId];
  }

  function getExpectedGasLimitFulfill() external view returns (uint88 expectedGasLimitFulfill) {
    return _expectedGasLimitFulfill;
  }

  function getTotalEmissionPercentage() external view returns (uint16 totalEmissionPercentage) {
    return _totalEmissionPercentage;
  }

  function isCombatant(uint256 clanId, uint256 playerId) external view override returns (bool combatant) {
    // Check if this player is in the defenders list and remove them if so
    if (_clanInfos[clanId].playerIds.length != 0) {
      uint256 searchIndex = EstforLibrary._binarySearch(_clanInfos[clanId].playerIds, playerId);
      combatant = searchIndex != type(uint256).max;
    }
  }

  function addTerritories(TerritoryInput[] calldata territories) public onlyOwner {
    uint256 totalEmissionPercentage = _totalEmissionPercentage;
    uint256 nextTerritoryId = _nextTerritoryId;
    for (uint256 i; i < territories.length; ++i) {
      TerritoryInput calldata territoryInput = territories[i];
      _checkTerritory(territories[i]);
      require(i + nextTerritoryId == territoryInput.territoryId, InvalidTerritoryId());

      _territories[territoryInput.territoryId] = Territory({
        territoryId: territoryInput.territoryId,
        clanIdOccupier: 0,
        percentageEmissions: territoryInput.percentageEmissions,
        unclaimedEmissions: 0,
        lastClaimTimestamp: 0,
        minimumMMR: 0
      });
      totalEmissionPercentage += territoryInput.percentageEmissions;
    }

    _nextTerritoryId = uint16(nextTerritoryId + territories.length);

    require(totalEmissionPercentage <= 100 * PERCENTAGE_EMISSION_MUL, InvalidEmissionPercentage());

    _totalEmissionPercentage = uint16(totalEmissionPercentage);
    emit AddTerritories(territories);
  }

  function editTerritories(TerritoryInput[] calldata territories) external onlyOwner {
    uint256 totalEmissionPercentage = _totalEmissionPercentage;
    for (uint256 i; i < territories.length; ++i) {
      _checkTerritory(territories[i]);
      totalEmissionPercentage -= _territories[territories[i].territoryId].percentageEmissions;
      totalEmissionPercentage += territories[i].percentageEmissions;
      _territories[territories[i].territoryId].percentageEmissions = territories[i].percentageEmissions;
    }

    require(totalEmissionPercentage <= 100 * PERCENTAGE_EMISSION_MUL, InvalidEmissionPercentage());
    _totalEmissionPercentage = uint8(totalEmissionPercentage);
    emit EditTerritories(territories);
  }

  function removeTerritories(uint256[] calldata territoryIds) external onlyOwner {
    uint256 totalEmissionPercentage = _totalEmissionPercentage;
    for (uint256 i; i < territoryIds.length; ++i) {
      require(_territories[territoryIds[i]].territoryId != 0, InvalidTerritoryId());

      totalEmissionPercentage -= _territories[territoryIds[i]].percentageEmissions;
      delete _territories[territoryIds[i]];
    }

    _totalEmissionPercentage = uint16(totalEmissionPercentage);
    emit RemoveTerritories(territoryIds);
  }

  function setMinimumMMRs(uint256[] calldata territoryIds, uint16[] calldata minimumMMRs) external onlyOwner {
    require(territoryIds.length == minimumMMRs.length, LengthMismatch());

    for (uint256 i; i < territoryIds.length; ++i) {
      _territories[territoryIds[i]].minimumMMR = minimumMMRs[i];
    }
    emit SetMinimumMMRs(territoryIds, minimumMMRs); // TODO: Currently not used elsewhere
  }

  function setComparableSkills(Skill[] calldata skills) public onlyOwner {
    for (uint256 i = 0; i < skills.length; ++i) {
      require(skills[i] != Skill.NONE && skills[i] != Skill.COMBAT, InvalidSkill(skills[i]));

      _comparableSkills.push(skills[i]);
    }
    emit SetComparableSkills(skills);
  }

  function setCombatantsHelper(address combatantsHelper) external onlyOwner {
    _combatantsHelper = combatantsHelper;
  }

  function setExpectedGasLimitFulfill(uint24 expectedGasLimitFulfill) public onlyOwner {
    _expectedGasLimitFulfill = expectedGasLimitFulfill;
    emit SetExpectedGasLimitFulfill(expectedGasLimitFulfill);
  }

  function setMaxClanCombatants(uint8 maxClanCombatants) public onlyOwner {
    _maxClanCombatants = maxClanCombatants;
    emit SetMaxClanCombatants(maxClanCombatants);
  }

  function setAttackCooldown(uint24 attackCooldown) public onlyOwner {
    _attackingCooldown = attackCooldown;
    emit SetAttackCooldown(attackCooldown);
  }

  function clearCooldowns(uint256 clanId) external isAdminAndBeta {
    ClanInfo storage clanInfo = _clanInfos[clanId];
    clanInfo.attackingCooldownTimestamp = 0;
    clanInfo.assignCombatantsCooldownTimestamp = 0;
    clanInfo.blockAttacksTimestamp = 0;
    clanInfo.blockAttacksCooldownHours = 0;
  }

  // Useful to re-run a battle for testing
  function setAttackInProgress(uint256 requestId) external isAdminAndBeta {
    _pendingAttacks[_requestToPendingAttackIds[bytes32(requestId)]].attackInProgress = true;
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

    function __UUPSUpgradeable_init() internal onlyInitializing {
    }

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
import {IERC1155MetadataURI} from "@openzeppelin/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol";
import {ERC1155Utils} from "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Utils.sol";
import {ContextUpgradeable} from "../../utils/ContextUpgradeable.sol";
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {ERC165Upgradeable} from "../../utils/introspection/ERC165Upgradeable.sol";
import {Arrays} from "@openzeppelin/contracts/utils/Arrays.sol";
import {IERC1155Errors} from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";

/**
 * @dev Implementation of the basic standard multi-token.
 * See https://eips.ethereum.org/EIPS/eip-1155
 * Originally based on code by Enjin: https://github.com/enjin/erc-1155
 */
abstract contract ERC1155Upgradeable is Initializable, ContextUpgradeable, ERC165Upgradeable, IERC1155, IERC1155MetadataURI, IERC1155Errors {
    using Arrays for uint256[];
    using Arrays for address[];

    /// @custom:storage-location erc7201:openzeppelin.storage.ERC1155
    struct ERC1155Storage {
        mapping(uint256 id => mapping(address account => uint256)) _balances;

        mapping(address account => mapping(address operator => bool)) _operatorApprovals;

        // Used as the URI for all token types by relying on ID substitution, e.g. https://token-cdn-domain/{id}.json
        string _uri;
    }

    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC1155")) - 1)) & ~bytes32(uint256(0xff))
    bytes32 private constant ERC1155StorageLocation = 0x88be536d5240c274a3b1d3a1be54482fd9caa294f08c62a7cde569f49a3c4500;

    function _getERC1155Storage() private pure returns (ERC1155Storage storage $) {
        assembly ("memory-safe") {
            $.slot := ERC1155StorageLocation
        }
    }

    /**
     * @dev See {_setURI}.
     */
    function __ERC1155_init(string memory uri_) internal onlyInitializing {
        __ERC1155_init_unchained(uri_);
    }

    function __ERC1155_init_unchained(string memory uri_) internal onlyInitializing {
        _setURI(uri_);
    }

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

    /**
     * @dev See {IERC1155MetadataURI-uri}.
     *
     * This implementation returns the same URI for *all* token types. It relies
     * on the token type ID substitution mechanism
     * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the ERC].
     *
     * Clients calling this function must replace the `\{id\}` substring with the
     * actual token type ID.
     */
    function uri(uint256 /* id */) public view virtual returns (string memory) {
        ERC1155Storage storage $ = _getERC1155Storage();
        return $._uri;
    }

    /**
     * @dev See {IERC1155-balanceOf}.
     */
    function balanceOf(address account, uint256 id) public view virtual returns (uint256) {
        ERC1155Storage storage $ = _getERC1155Storage();
        return $._balances[id][account];
    }

    /**
     * @dev See {IERC1155-balanceOfBatch}.
     *
     * Requirements:
     *
     * - `accounts` and `ids` must have the same length.
     */
    function balanceOfBatch(
        address[] memory accounts,
        uint256[] memory ids
    ) public view virtual returns (uint256[] memory) {
        if (accounts.length != ids.length) {
            revert ERC1155InvalidArrayLength(ids.length, accounts.length);
        }

        uint256[] memory batchBalances = new uint256[](accounts.length);

        for (uint256 i = 0; i < accounts.length; ++i) {
            batchBalances[i] = balanceOf(accounts.unsafeMemoryAccess(i), ids.unsafeMemoryAccess(i));
        }

        return batchBalances;
    }

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

    /**
     * @dev See {IERC1155-isApprovedForAll}.
     */
    function isApprovedForAll(address account, address operator) public view virtual returns (bool) {
        ERC1155Storage storage $ = _getERC1155Storage();
        return $._operatorApprovals[account][operator];
    }

    /**
     * @dev See {IERC1155-safeTransferFrom}.
     */
    function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes memory data) public virtual {
        address sender = _msgSender();
        if (from != sender && !isApprovedForAll(from, sender)) {
            revert ERC1155MissingApprovalForAll(sender, from);
        }
        _safeTransferFrom(from, to, id, value, data);
    }

    /**
     * @dev See {IERC1155-safeBatchTransferFrom}.
     */
    function safeBatchTransferFrom(
        address from,
        address to,
        uint256[] memory ids,
        uint256[] memory values,
        bytes memory data
    ) public virtual {
        address sender = _msgSender();
        if (from != sender && !isApprovedForAll(from, sender)) {
            revert ERC1155MissingApprovalForAll(sender, from);
        }
        _safeBatchTransferFrom(from, to, ids, values, data);
    }

    /**
     * @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`. Will mint (or burn) if `from`
     * (or `to`) is the zero address.
     *
     * Emits a {TransferSingle} event if the arrays contain one element, and {TransferBatch} otherwise.
     *
     * Requirements:
     *
     * - If `to` refers to a smart contract, it must implement either {IERC1155Receiver-onERC1155Received}
     *   or {IERC1155Receiver-onERC1155BatchReceived} and return the acceptance magic value.
     * - `ids` and `values` must have the same length.
     *
     * NOTE: The ERC-1155 acceptance check is not performed in this function. See {_updateWithAcceptanceCheck} instead.
     */
    function _update(address from, address to, uint256[] memory ids, uint256[] memory values) internal virtual {
        ERC1155Storage storage $ = _getERC1155Storage();
        if (ids.length != values.length) {
            revert ERC1155InvalidArrayLength(ids.length, values.length);
        }

        address operator = _msgSender();

        for (uint256 i = 0; i < ids.length; ++i) {
            uint256 id = ids.unsafeMemoryAccess(i);
            uint256 value = values.unsafeMemoryAccess(i);

            if (from != address(0)) {
                uint256 fromBalance = $._balances[id][from];
                if (fromBalance < value) {
                    revert ERC1155InsufficientBalance(from, fromBalance, value, id);
                }
                unchecked {
                    // Overflow not possible: value <= fromBalance
                    $._balances[id][from] = fromBalance - value;
                }
            }

            if (to != address(0)) {
                $._balances[id][to] += value;
            }
        }

        if (ids.length == 1) {
            uint256 id = ids.unsafeMemoryAccess(0);
            uint256 value = values.unsafeMemoryAccess(0);
            emit TransferSingle(operator, from, to, id, value);
        } else {
            emit TransferBatch(operator, from, to, ids, values);
        }
    }

    /**
     * @dev Version of {_update} that performs the token acceptance check by calling
     * {IERC1155Receiver-onERC1155Received} or {IERC1155Receiver-onERC1155BatchReceived} on the receiver address if it
     * contains code (eg. is a smart contract at the moment of execution).
     *
     * IMPORTANT: Overriding this function is discouraged because it poses a reentrancy risk from the receiver. So any
     * update to the contract state after this function would break the check-effect-interaction pattern. Consider
     * overriding {_update} instead.
     */
    function _updateWithAcceptanceCheck(
        address from,
        address to,
        uint256[] memory ids,
        uint256[] memory values,
        bytes memory data
    ) internal virtual {
        _update(from, to, ids, values);
        if (to != address(0)) {
            address operator = _msgSender();
            if (ids.length == 1) {
                uint256 id = ids.unsafeMemoryAccess(0);
                uint256 value = values.unsafeMemoryAccess(0);
                ERC1155Utils.checkOnERC1155Received(operator, from, to, id, value, data);
            } else {
                ERC1155Utils.checkOnERC1155BatchReceived(operator, from, to, ids, values, data);
            }
        }
    }

    /**
     * @dev Transfers a `value` tokens of token type `id` from `from` to `to`.
     *
     * Emits a {TransferSingle} event.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - `from` must have a balance of tokens of type `id` of at least `value` amount.
     * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
     * acceptance magic value.
     */
    function _safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes memory data) internal {
        if (to == address(0)) {
            revert ERC1155InvalidReceiver(address(0));
        }
        if (from == address(0)) {
            revert ERC1155InvalidSender(address(0));
        }
        (uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
        _updateWithAcceptanceCheck(from, to, ids, values, data);
    }

    /**
     * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_safeTransferFrom}.
     *
     * Emits a {TransferBatch} event.
     *
     * Requirements:
     *
     * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
     * acceptance magic value.
     * - `ids` and `values` must have the same length.
     */
    function _safeBatchTransferFrom(
        address from,
        address to,
        uint256[] memory ids,
        uint256[] memory values,
        bytes memory data
    ) internal {
        if (to == address(0)) {
            revert ERC1155InvalidReceiver(address(0));
        }
        if (from == address(0)) {
            revert ERC1155InvalidSender(address(0));
        }
        _updateWithAcceptanceCheck(from, to, ids, values, data);
    }

    /**
     * @dev Sets a new URI for all token types, by relying on the token type ID
     * substitution mechanism
     * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the ERC].
     *
     * By this mechanism, any occurrence of the `\{id\}` substring in either the
     * URI or any of the values in the JSON file at said URI will be replaced by
     * clients with the token type ID.
     *
     * For example, the `https://token-cdn-domain/\{id\}.json` URI would be
     * interpreted by clients as
     * `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
     * for token type ID 0x4cce0.
     *
     * See {uri}.
     *
     * Because these URIs cannot be meaningfully represented by the {URI} event,
     * this function emits no events.
     */
    function _setURI(string memory newuri) internal virtual {
        ERC1155Storage storage $ = _getERC1155Storage();
        $._uri = newuri;
    }

    /**
     * @dev Creates a `value` amount of tokens of type `id`, and assigns them to `to`.
     *
     * Emits a {TransferSingle} event.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
     * acceptance magic value.
     */
    function _mint(address to, uint256 id, uint256 value, bytes memory data) internal {
        if (to == address(0)) {
            revert ERC1155InvalidReceiver(address(0));
        }
        (uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
        _updateWithAcceptanceCheck(address(0), to, ids, values, data);
    }

    /**
     * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
     *
     * Emits a {TransferBatch} event.
     *
     * Requirements:
     *
     * - `ids` and `values` must have the same length.
     * - `to` cannot be the zero address.
     * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
     * acceptance magic value.
     */
    function _mintBatch(address to, uint256[] memory ids, uint256[] memory values, bytes memory data) internal {
        if (to == address(0)) {
            revert ERC1155InvalidReceiver(address(0));
        }
        _updateWithAcceptanceCheck(address(0), to, ids, values, data);
    }

    /**
     * @dev Destroys a `value` amount of tokens of type `id` from `from`
     *
     * Emits a {TransferSingle} event.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `from` must have at least `value` amount of tokens of type `id`.
     */
    function _burn(address from, uint256 id, uint256 value) internal {
        if (from == address(0)) {
            revert ERC1155InvalidSender(address(0));
        }
        (uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
        _updateWithAcceptanceCheck(from, address(0), ids, values, "");
    }

    /**
     * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
     *
     * Emits a {TransferBatch} event.
     *
     * Requirements:
     *
     * - `from` cannot be the zero address.
     * - `from` must have at least `value` amount of tokens of type `id`.
     * - `ids` and `values` must have the same length.
     */
    function _burnBatch(address from, uint256[] memory ids, uint256[] memory values) internal {
        if (from == address(0)) {
            revert ERC1155InvalidSender(address(0));
        }
        _updateWithAcceptanceCheck(from, address(0), ids, values, "");
    }

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

    /**
     * @dev Creates an array in memory with only one value for each of the elements provided.
     */
    function _asSingletonArrays(
        uint256 element1,
        uint256 element2
    ) private pure returns (uint256[] memory array1, uint256[] memory array2) {
        assembly ("memory-safe") {
            // Load the free memory pointer
            array1 := mload(0x40)
            // Set array length to 1
            mstore(array1, 1)
            // Store the single element at the next word after the length (where content starts)
            mstore(add(array1, 0x20), element1)

            // Repeat for next array locating it right after the first array
            array2 := add(array1, 0x40)
            mstore(array2, 1)
            mstore(add(array2, 0x20), element2)

            // Update the free memory pointer by pointing after the second array
            mstore(0x40, add(array2, 0x40))
        }
    }
}

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

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

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

    function __Context_init_unchained() internal onlyInitializing {
    }
    function _msgSender() internal view virtual returns (address) {
        return msg.sender;
    }

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

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

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

pragma solidity ^0.8.20;

import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";

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

    function __ERC165_init_unchained() internal onlyInitializing {
    }
    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
        return interfaceId == type(IERC165).interfaceId;
    }
}

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

pragma solidity ^0.8.24;

import {TransientSlot} from "@openzeppelin/contracts/utils/TransientSlot.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";

/**
 * @dev Variant of {ReentrancyGuard} that uses transient storage.
 *
 * NOTE: This variant only works on networks where EIP-1153 is available.
 *
 * _Available since v5.1._
 */
abstract contract ReentrancyGuardTransientUpgradeable is Initializable {
    using TransientSlot for *;

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

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

    /**
     * @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 __ReentrancyGuardTransient_init() internal onlyInitializing {
    }

    function __ReentrancyGuardTransient_init_unchained() internal onlyInitializing {
    }
    function _nonReentrantBefore() private {
        // On the first call to nonReentrant, _status will be NOT_ENTERED
        if (_reentrancyGuardEntered()) {
            revert ReentrancyGuardReentrantCall();
        }

        // Any calls to nonReentrant after this point will fail
        REENTRANCY_GUARD_STORAGE.asBoolean().tstore(true);
    }

    function _nonReentrantAfter() private {
        REENTRANCY_GUARD_STORAGE.asBoolean().tstore(false);
    }

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

pragma solidity ^0.8.20;

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

/**
 * @dev Interface for the NFT Royalty Standard.
 *
 * A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
 * support for royalty payments across all NFT marketplaces and ecosystem participants.
 */
interface IERC2981 is IERC165 {
    /**
     * @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
     * exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
     *
     * NOTE: ERC-2981 allows setting the royalty to 100% of the price. In that case all the price would be sent to the
     * royalty receiver and 0 tokens to the seller. Contracts dealing with royalty should consider empty transfers.
     */
    function royaltyInfo(
        uint256 tokenId,
        uint256 salePrice
    ) external view returns (address receiver, uint256 royaltyAmount);
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev This contract implements a proxy that gets the implementation address for each call from an {UpgradeableBeacon}.
 *
 * The beacon address can only be set once during construction, and cannot be changed afterwards. It is stored in an
 * immutable variable to avoid unnecessary storage reads, and also in the beacon storage slot specified by
 * https://eips.ethereum.org/EIPS/eip-1967[ERC-1967] so that it can be accessed externally.
 *
 * CAUTION: Since the beacon address can never be changed, you must ensure that you either control the beacon, or trust
 * the beacon to not upgrade the implementation maliciously.
 *
 * IMPORTANT: Do not use the implementation logic to modify the beacon storage slot. Doing so would leave the proxy in
 * an inconsistent state where the beacon storage slot does not match the beacon address.
 */
contract BeaconProxy is Proxy {
    // An immutable address for the beacon to avoid unnecessary SLOADs before each delegate call.
    address private immutable _beacon;

    /**
     * @dev Initializes the proxy with `beacon`.
     *
     * If `data` is nonempty, it's used as data in a delegate call to the implementation returned by the beacon. This
     * will typically be an encoded function call, and allows initializing the storage of the proxy like a Solidity
     * constructor.
     *
     * Requirements:
     *
     * - `beacon` must be a contract with the interface {IBeacon}.
     * - If `data` is empty, `msg.value` must be zero.
     */
    constructor(address beacon, bytes memory data) payable {
        ERC1967Utils.upgradeBeaconToAndCall(beacon, data);
        _beacon = beacon;
    }

    /**
     * @dev Returns the current implementation address of the associated beacon.
     */
    function _implementation() internal view virtual override returns (address) {
        return IBeacon(_getBeacon()).implementation();
    }

    /**
     * @dev Returns the beacon.
     */
    function _getBeacon() internal view virtual returns (address) {
        return _beacon;
    }
}

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

pragma solidity ^0.8.20;

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

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

pragma solidity ^0.8.21;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        StorageSlot.getAddressSlot(BEACON_SLOT).value = newBeacon;

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

/**
 * @dev Interface of the optional ERC1155MetadataExtension interface, as defined
 * in the https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[ERC].
 */
interface IERC1155MetadataURI is IERC1155 {
    /**
     * @dev Returns the URI for token type `id`.
     *
     * If the `\{id\}` substring is present in the URI, it must be replaced by
     * clients with the actual token type ID.
     */
    function uri(uint256 id) external view returns (string memory);
}

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

pragma solidity ^0.8.20;

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

/**
 * @dev Required interface of an ERC-1155 compliant contract, as defined in the
 * https://eips.ethereum.org/EIPS/eip-1155[ERC].
 */
interface IERC1155 is IERC165 {
    /**
     * @dev Emitted when `value` amount of tokens of type `id` are transferred from `from` to `to` by `operator`.
     */
    event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);

    /**
     * @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
     * transfers.
     */
    event TransferBatch(
        address indexed operator,
        address indexed from,
        address indexed to,
        uint256[] ids,
        uint256[] values
    );

    /**
     * @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
     * `approved`.
     */
    event ApprovalForAll(address indexed account, address indexed operator, bool approved);

    /**
     * @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
     *
     * If an {URI} event was emitted for `id`, the standard
     * https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
     * returned by {IERC1155MetadataURI-uri}.
     */
    event URI(string value, uint256 indexed id);

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

    /**
     * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
     *
     * Requirements:
     *
     * - `accounts` and `ids` must have the same length.
     */
    function balanceOfBatch(
        address[] calldata accounts,
        uint256[] calldata ids
    ) external view returns (uint256[] memory);

    /**
     * @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
     *
     * Emits an {ApprovalForAll} event.
     *
     * Requirements:
     *
     * - `operator` cannot be the zero address.
     */
    function setApprovalForAll(address operator, bool approved) external;

    /**
     * @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
     *
     * See {setApprovalForAll}.
     */
    function isApprovedForAll(address account, address operator) external view returns (bool);

    /**
     * @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`.
     *
     * WARNING: This function can potentially allow a reentrancy attack when transferring tokens
     * to an untrusted contract, when invoking {onERC1155Received} on the receiver.
     * Ensure to follow the checks-effects-interactions pattern and consider employing
     * reentrancy guards when interacting with untrusted contracts.
     *
     * Emits a {TransferSingle} event.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
     * - `from` must have a balance of tokens of type `id` of at least `value` amount.
     * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
     * acceptance magic value.
     */
    function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes calldata data) external;

    /**
     * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
     *
     * WARNING: This function can potentially allow a reentrancy attack when transferring tokens
     * to an untrusted contract, when invoking {onERC1155BatchReceived} on the receiver.
     * Ensure to follow the checks-effects-interactions pattern and consider employing
     * reentrancy guards when interacting with untrusted contracts.
     *
     * Emits either a {TransferSingle} or a {TransferBatch} event, depending on the length of the array arguments.
     *
     * Requirements:
     *
     * - `ids` and `values` must have the same length.
     * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
     * acceptance magic value.
     */
    function safeBatchTransferFrom(
        address from,
        address to,
        uint256[] calldata ids,
        uint256[] calldata values,
        bytes calldata data
    ) external;
}

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

pragma solidity ^0.8.20;

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

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

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

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

pragma solidity ^0.8.20;

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

/**
 * @dev Simple implementation of `IERC1155Receiver` that will allow a contract to hold ERC-1155 tokens.
 *
 * IMPORTANT: When inheriting this contract, you must include a way to use the received tokens, otherwise they will be
 * stuck.
 */
abstract contract ERC1155Holder is ERC165, IERC1155Receiver {
    /**
     * @dev See {IERC165-supportsInterface}.
     */
    function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
        return interfaceId == type(IERC1155Receiver).interfaceId || super.supportsInterface(interfaceId);
    }

    function onERC1155Received(
        address,
        address,
        uint256,
        uint256,
        bytes memory
    ) public virtual override returns (bytes4) {
        return this.onERC1155Received.selector;
    }

    function onERC1155BatchReceived(
        address,
        address,
        uint256[] memory,
        uint256[] memory,
        bytes memory
    ) public virtual override returns (bytes4) {
        return this.onERC1155BatchReceived.selector;
    }
}

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

pragma solidity ^0.8.20;

import {IERC1155Receiver} from "../IERC1155Receiver.sol";
import {IERC1155Errors} from "../../../interfaces/draft-IERC6093.sol";

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

    /**
     * @dev Performs a batch acceptance check for the provided `operator` by calling {IERC1155-onERC1155BatchReceived}
     * on the `to` address. The `operator` is generally the address that initiated the token transfer (i.e. `msg.sender`).
     *
     * The acceptance call is not executed and treated as a no-op if the target address doesn't contain code (i.e. an EOA).
     * Otherwise, the recipient must implement {IERC1155Receiver-onERC1155Received} and return the acceptance magic value to accept
     * the transfer.
     */
    function checkOnERC1155BatchReceived(
        address operator,
        address from,
        address to,
        uint256[] memory ids,
        uint256[] memory values,
        bytes memory data
    ) internal {
        if (to.code.length > 0) {
            try IERC1155Receiver(to).onERC1155BatchReceived(operator, from, ids, values, data) returns (
                bytes4 response
            ) {
                if (response != IERC1155Receiver.onERC1155BatchReceived.selector) {
                    // Tokens rejected
                    revert IERC1155Errors.ERC1155InvalidReceiver(to);
                }
            } catch (bytes memory reason) {
                if (reason.length == 0) {
                    // non-IERC1155Receiver implementer
                    revert IERC1155Errors.ERC1155InvalidReceiver(to);
                } else {
                    assembly ("memory-safe") {
                        revert(add(32, reason), mload(reason))
                    }
                }
            }
        }
    }
}

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

    /**
     * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
     * but also transferring `value` wei to `target`.
     *
     * Requirements:
     *
     * - the calling contract must have an ETH balance of at least `value`.
     * - the called Solidity function must be `payable`.
     */
    function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
        if (address(this).balance < value) {
            revert Errors.InsufficientBalance(address(this).balance, value);
        }
        (bool success, bytes memory returndata) = target.call{value: value}(data);
        return verifyCallResultFromTarget(target, success, returndata);
    }

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

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

    /**
     * @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
     * was not a contract or bubbling up the revert reason (falling back to {Errors.FailedCall}) in case
     * of an unsuccessful call.
     */
    function verifyCallResultFromTarget(
        address target,
        bool success,
        bytes memory returndata
    ) internal view returns (bytes memory) {
        if (!success) {
            _revert(returndata);
        } else {
            // only check if target is a contract if the call was successful and the return data is empty
            // otherwise we already know that it was a contract
            if (returndata.length == 0 && target.code.length == 0) {
                revert AddressEmptyCode(target);
            }
            return returndata;
        }
    }

    /**
     * @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
     * revert reason or with a default {Errors.FailedCall} error.
     */
    function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
        if (!success) {
            _revert(returndata);
        } else {
            return returndata;
        }
    }

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

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

pragma solidity ^0.8.20;

import {Comparators} from "./Comparators.sol";
import {SlotDerivation} from "./SlotDerivation.sol";
import {StorageSlot} from "./StorageSlot.sol";
import {Math} from "./math/Math.sol";

/**
 * @dev Collection of functions related to array types.
 */
library Arrays {
    using SlotDerivation for bytes32;
    using StorageSlot for bytes32;

    /**
     * @dev Sort an array of uint256 (in memory) following the provided comparator function.
     *
     * This function does the sorting "in place", meaning that it overrides the input. The object is returned for
     * convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
     *
     * NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
     * array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
     * when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
     * consume more gas than is available in a block, leading to potential DoS.
     *
     * IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
     */
    function sort(
        uint256[] memory array,
        function(uint256, uint256) pure returns (bool) comp
    ) internal pure returns (uint256[] memory) {
        _quickSort(_begin(array), _end(array), comp);
        return array;
    }

    /**
     * @dev Variant of {sort} that sorts an array of uint256 in increasing order.
     */
    function sort(uint256[] memory array) internal pure returns (uint256[] memory) {
        sort(array, Comparators.lt);
        return array;
    }

    /**
     * @dev Sort an array of address (in memory) following the provided comparator function.
     *
     * This function does the sorting "in place", meaning that it overrides the input. The object is returned for
     * convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
     *
     * NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
     * array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
     * when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
     * consume more gas than is available in a block, leading to potential DoS.
     *
     * IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
     */
    function sort(
        address[] memory array,
        function(address, address) pure returns (bool) comp
    ) internal pure returns (address[] memory) {
        sort(_castToUint256Array(array), _castToUint256Comp(comp));
        return array;
    }

    /**
     * @dev Variant of {sort} that sorts an array of address in increasing order.
     */
    function sort(address[] memory array) internal pure returns (address[] memory) {
        sort(_castToUint256Array(array), Comparators.lt);
        return array;
    }

    /**
     * @dev Sort an array of bytes32 (in memory) following the provided comparator function.
     *
     * This function does the sorting "in place", meaning that it overrides the input. The object is returned for
     * convenience, but that returned value can be discarded safely if the caller has a memory pointer to the array.
     *
     * NOTE: this function's cost is `O(n · log(n))` in average and `O(n²)` in the worst case, with n the length of the
     * array. Using it in view functions that are executed through `eth_call` is safe, but one should be very careful
     * when executing this as part of a transaction. If the array being sorted is too large, the sort operation may
     * consume more gas than is available in a block, leading to potential DoS.
     *
     * IMPORTANT: Consider memory side-effects when using custom comparator functions that access memory in an unsafe way.
     */
    function sort(
        bytes32[] memory array,
        function(bytes32, bytes32) pure returns (bool) comp
    ) internal pure returns (bytes32[] memory) {
        sort(_castToUint256Array(array), _castToUint256Comp(comp));
        return array;
    }

    /**
     * @dev Variant of {sort} that sorts an array of bytes32 in increasing order.
     */
    function sort(bytes32[] memory array) internal pure returns (bytes32[] memory) {
        sort(_castToUint256Array(array), Comparators.lt);
        return array;
    }

    /**
     * @dev Performs a quick sort of a segment of memory. The segment sorted starts at `begin` (inclusive), and stops
     * at end (exclusive). Sorting follows the `comp` comparator.
     *
     * Invariant: `begin <= end`. This is the case when initially called by {sort} and is preserved in subcalls.
     *
     * IMPORTANT: Memory locations between `begin` and `end` are not validated/zeroed. This function should
     * be used only if the limits are within a memory array.
     */
    function _quickSort(uint256 begin, uint256 end, function(uint256, uint256) pure returns (bool) comp) private pure {
        unchecked {
            if (end - begin < 0x40) return;

            // Use first element as pivot
            uint256 pivot = _mload(begin);
            // Position where the pivot should be at the end of the loop
            uint256 pos = begin;

            for (uint256 it = begin + 0x20; it < end; it += 0x20) {
                if (comp(_mload(it), pivot)) {
                    // If the value stored at the iterator's position comes before the pivot, we increment the
                    // position of the pivot and move the value there.
                    pos += 0x20;
                    _swap(pos, it);
                }
            }

            _swap(begin, pos); // Swap pivot into place
            _quickSort(begin, pos, comp); // Sort the left side of the pivot
            _quickSort(pos + 0x20, end, comp); // Sort the right side of the pivot
        }
    }

    /**
     * @dev Pointer to the memory location of the first element of `array`.
     */
    function _begin(uint256[] memory array) private pure returns (uint256 ptr) {
        assembly ("memory-safe") {
            ptr := add(array, 0x20)
        }
    }

    /**
     * @dev Pointer to the memory location of the first memory word (32bytes) after `array`. This is the memory word
     * that comes just after the last element of the array.
     */
    function _end(uint256[] memory array) private pure returns (uint256 ptr) {
        unchecked {
            return _begin(array) + array.length * 0x20;
        }
    }

    /**
     * @dev Load memory word (as a uint256) at location `ptr`.
     */
    function _mload(uint256 ptr) private pure returns (uint256 value) {
        assembly ("memory-safe") {
            value := mload(ptr)
        }
    }

    /**
     * @dev Swaps the elements memory location `ptr1` and `ptr2`.
     */
    function _swap(uint256 ptr1, uint256 ptr2) private pure {
        assembly ("memory-safe") {
            let value1 := mload(ptr1)
            let value2 := mload(ptr2)
            mstore(ptr1, value2)
            mstore(ptr2, value1)
        }
    }

    /// @dev Helper: low level cast address memory array to uint256 memory array
    function _castToUint256Array(address[] memory input) private pure returns (uint256[] memory output) {
        assembly ("memory-safe") {
            output := input
        }
    }

    /// @dev Helper: low level cast bytes32 memory array to uint256 memory array
    function _castToUint256Array(bytes32[] memory input) private pure returns (uint256[] memory output) {
        assembly ("memory-safe") {
            output := input
        }
    }

    /// @dev Helper: low level cast address comp function to uint256 comp function
    function _castToUint256Comp(
        function(address, address) pure returns (bool) input
    ) private pure returns (function(uint256, uint256) pure returns (bool) output) {
        assembly ("memory-safe") {
            output := input
        }
    }

    /// @dev Helper: low level cast bytes32 comp function to uint256 comp function
    function _castToUint256Comp(
        function(bytes32, bytes32) pure returns (bool) input
    ) private pure returns (function(uint256, uint256) pure returns (bool) output) {
        assembly ("memory-safe") {
            output := input
        }
    }

    /**
     * @dev Searches a sorted `array` and returns the first index that contains
     * a value greater or equal to `element`. If no such index exists (i.e. all
     * values in the array are strictly less than `element`), the array length is
     * returned. Time complexity O(log n).
     *
     * NOTE: The `array` is expected to be sorted in ascending order, and to
     * contain no repeated elements.
     *
     * IMPORTANT: Deprecated. This implementation behaves as {lowerBound} but lacks
     * support for repeated elements in the array. The {lowerBound} function should
     * be used instead.
     */
    function findUpperBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
        uint256 low = 0;
        uint256 high = array.length;

        if (high == 0) {
            return 0;
        }

        while (low < high) {
            uint256 mid = Math.average(low, high);

            // Note that mid will always be strictly less than high (i.e. it will be a valid array index)
            // because Math.average rounds towards zero (it does integer division with truncation).
            if (unsafeAccess(array, mid).value > element) {
                high = mid;
            } else {
                low = mid + 1;
            }
        }

        // At this point `low` is the exclusive upper bound. We will return the inclusive upper bound.
        if (low > 0 && unsafeAccess(array, low - 1).value == element) {
            return low - 1;
        } else {
            return low;
        }
    }

    /**
     * @dev Searches an `array` sorted in ascending order and returns the first
     * index that contains a value greater or equal than `element`. If no such index
     * exists (i.e. all values in the array are strictly less than `element`), the array
     * length is returned. Time complexity O(log n).
     *
     * See C++'s https://en.cppreference.com/w/cpp/algorithm/lower_bound[lower_bound].
     */
    function lowerBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
        uint256 low = 0;
        uint256 high = array.length;

        if (high == 0) {
            return 0;
        }

        while (low < high) {
            uint256 mid = Math.average(low, high);

            // Note that mid will always be strictly less than high (i.e. it will be a valid array index)
            // because Math.average rounds towards zero (it does integer division with truncation).
            if (unsafeAccess(array, mid).value < element) {
                // this cannot overflow because mid < high
                unchecked {
                    low = mid + 1;
                }
            } else {
                high = mid;
            }
        }

        return low;
    }

    /**
     * @dev Searches an `array` sorted in ascending order and returns the first
     * index that contains a value strictly greater than `element`. If no such index
     * exists (i.e. all values in the array are strictly less than `element`), the array
     * length is returned. Time complexity O(log n).
     *
     * See C++'s https://en.cppreference.com/w/cpp/algorithm/upper_bound[upper_bound].
     */
    function upperBound(uint256[] storage array, uint256 element) internal view returns (uint256) {
        uint256 low = 0;
        uint256 high = array.length;

        if (high == 0) {
            return 0;
        }

        while (low < high) {
            uint256 mid = Math.average(low, high);

            // Note that mid will always be strictly less than high (i.e. it will be a valid array index)
            // because Math.average rounds towards zero (it does integer division with truncation).
            if (unsafeAccess(array, mid).value > element) {
                high = mid;
            } else {
                // this cannot overflow because mid < high
                unchecked {
                    low = mid + 1;
                }
            }
        }

        return low;
    }

    /**
     * @dev Same as {lowerBound}, but with an array in memory.
     */
    function lowerBoundMemory(uint256[] memory array, uint256 element) internal pure returns (uint256) {
        uint256 low = 0;
        uint256 high = array.length;

        if (high == 0) {
            return 0;
        }

        while (low < high) {
            uint256 mid = Math.average(low, high);

            // Note that mid will always be strictly less than high (i.e. it will be a valid array index)
            // because Math.average rounds towards zero (it does integer division with truncation).
            if (unsafeMemoryAccess(array, mid) < element) {
                // this cannot overflow because mid < high
                unchecked {
                    low = mid + 1;
                }
            } else {
                high = mid;
            }
        }

        return low;
    }

    /**
     * @dev Same as {upperBound}, but with an array in memory.
     */
    function upperBoundMemory(uint256[] memory array, uint256 element) internal pure returns (uint256) {
        uint256 low = 0;
        uint256 high = array.length;

        if (high == 0) {
            return 0;
        }

        while (low < high) {
            uint256 mid = Math.average(low, high);

            // Note that mid will always be strictly less than high (i.e. it will be a valid array index)
            // because Math.average rounds towards zero (it does integer division with truncation).
            if (unsafeMemoryAccess(array, mid) > element) {
                high = mid;
            } else {
                // this cannot overflow because mid < high
                unchecked {
                    low = mid + 1;
                }
            }
        }

        return low;
    }

    /**
     * @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
     *
     * WARNING: Only use if you are certain `pos` is lower than the array length.
     */
    function unsafeAccess(address[] storage arr, uint256 pos) internal pure returns (StorageSlot.AddressSlot storage) {
        bytes32 slot;
        assembly ("memory-safe") {
            slot := arr.slot
        }
        return slot.deriveArray().offset(pos).getAddressSlot();
    }

    /**
     * @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
     *
     * WARNING: Only use if you are certain `pos` is lower than the array length.
     */
    function unsafeAccess(bytes32[] storage arr, uint256 pos) internal pure returns (StorageSlot.Bytes32Slot storage) {
        bytes32 slot;
        assembly ("memory-safe") {
            slot := arr.slot
        }
        return slot.deriveArray().offset(pos).getBytes32Slot();
    }

    /**
     * @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
     *
     * WARNING: Only use if you are certain `pos` is lower than the array length.
     */
    function unsafeAccess(uint256[] storage arr, uint256 pos) internal pure returns (StorageSlot.Uint256Slot storage) {
        bytes32 slot;
        assembly ("memory-safe") {
            slot := arr.slot
        }
        return slot.deriveArray().offset(pos).getUint256Slot();
    }

    /**
     * @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
     *
     * WARNING: Only use if you are certain `pos` is lower than the array length.
     */
    function unsafeMemoryAccess(address[] memory arr, uint256 pos) internal pure returns (address res) {
        assembly ("memory-safe") {
            res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
        }
    }

    /**
     * @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
     *
     * WARNING: Only use if you are certain `pos` is lower than the array length.
     */
    function unsafeMemoryAccess(bytes32[] memory arr, uint256 pos) internal pure returns (bytes32 res) {
        assembly ("memory-safe") {
            res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
        }
    }

    /**
     * @dev Access an array in an "unsafe" way. Skips solidity "index-out-of-range" check.
     *
     * WARNING: Only use if you are certain `pos` is lower than the array length.
     */
    function unsafeMemoryAccess(uint256[] memory arr, uint256 pos) internal pure returns (uint256 res) {
        assembly ("memory-safe") {
            res := mload(add(add(arr, 0x20), mul(pos, 0x20)))
        }
    }

    /**
     * @dev Helper to set the length of an dynamic array. Directly writing to `.length` is forbidden.
     *
     * WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
     */
    function unsafeSetLength(address[] storage array, uint256 len) internal {
        assembly ("memory-safe") {
            sstore(array.slot, len)
        }
    }

    /**
     * @dev Helper to set the length of an dynamic array. Directly writing to `.length` is forbidden.
     *
     * WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
     */
    function unsafeSetLength(bytes32[] storage array, uint256 len) internal {
        assembly ("memory-safe") {
            sstore(array.slot, len)
        }
    }

    /**
     * @dev Helper to set the length of an dynamic array. Directly writing to `.length` is forbidden.
     *
     * WARNING: this does not clear elements if length is reduced, of initialize elements if length is increased.
     */
    function unsafeSetLength(uint256[] storage array, uint256 len) internal {
        assembly ("memory-safe") {
            sstore(array.slot, len)
        }
    }
}

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

pragma solidity ^0.8.20;

/**
 * @dev Provides a set of functions to compare values.
 *
 * _Available since v5.1._
 */
library Comparators {
    function lt(uint256 a, uint256 b) internal pure returns (bool) {
        return a < b;
    }

    function gt(uint256 a, uint256 b) internal pure returns (bool) {
        return a > b;
    }
}

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

pragma solidity ^0.8.20;

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

pragma solidity ^0.8.20;

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        uint256 mLen = m.length;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            result += SafeCast.toUint(value > 1);
        }
        return result;
    }

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

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

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

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

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

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

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

            result += SafeCast.toUint(value > (1 << 8) - 1);
        }
        return result;
    }

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

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

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

pragma solidity ^0.8.20;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pragma solidity ^0.8.20;

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

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

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

pragma solidity ^0.8.20;

/**
 * @dev Library for computing storage (and transient storage) locations from namespaces and deriving slots
 * corresponding to standard patterns. The derivation method for array and mapping matches the storage layout used by
 * the solidity language / compiler.
 *
 * See https://docs.soliditylang.org/en/v0.8.20/internals/layout_in_storage.html#mappings-and-dynamic-arrays[Solidity docs for mappings and dynamic arrays.].
 *
 * Example usage:
 * ```solidity
 * contract Example {
 *     // Add the library methods
 *     using StorageSlot for bytes32;
 *     using SlotDerivation for bytes32;
 *
 *     // Declare a namespace
 *     string private constant _NAMESPACE = "<namespace>" // eg. OpenZeppelin.Slot
 *
 *     function setValueInNamespace(uint256 key, address newValue) internal {
 *         _NAMESPACE.erc7201Slot().deriveMapping(key).getAddressSlot().value = newValue;
 *     }
 *
 *     function getValueInNamespace(uint256 key) internal view returns (address) {
 *         return _NAMESPACE.erc7201Slot().deriveMapping(key).getAddressSlot().value;
 *     }
 * }
 * ```
 *
 * TIP: Consider using this library along with {StorageSlot}.
 *
 * NOTE: This library provides a way to manipulate storage locations in a non-standard way. Tooling for checking
 * upgrade safety will ignore the slots accessed through this library.
 *
 * _Available since v5.1._
 */
library SlotDerivation {
    /**
     * @dev Derive an ERC-7201 slot from a string (namespace).
     */
    function erc7201Slot(string memory namespace) internal pure returns (bytes32 slot) {
        assembly ("memory-safe") {
            mstore(0x00, sub(keccak256(add(namespace, 0x20), mload(namespace)), 1))
            slot := and(keccak256(0x00, 0x20), not(0xff))
        }
    }

    /**
     * @dev Add an offset to a slot to get the n-th element of a structure or an array.
     */
    function offset(bytes32 slot, uint256 pos) internal pure returns (bytes32 result) {
        unchecked {
            return bytes32(uint256(slot) + pos);
        }
    }

    /**
     * @dev Derive the location of the first element in an array from the slot where the length is stored.
     */
    function deriveArray(bytes32 slot) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            mstore(0x00, slot)
            result := keccak256(0x00, 0x20)
        }
    }

    /**
     * @dev Derive the location of a mapping element from the key.
     */
    function deriveMapping(bytes32 slot, address key) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            mstore(0x00, and(key, shr(96, not(0))))
            mstore(0x20, slot)
            result := keccak256(0x00, 0x40)
        }
    }

    /**
     * @dev Derive the location of a mapping element from the key.
     */
    function deriveMapping(bytes32 slot, bool key) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            mstore(0x00, iszero(iszero(key)))
            mstore(0x20, slot)
            result := keccak256(0x00, 0x40)
        }
    }

    /**
     * @dev Derive the location of a mapping element from the key.
     */
    function deriveMapping(bytes32 slot, bytes32 key) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            mstore(0x00, key)
            mstore(0x20, slot)
            result := keccak256(0x00, 0x40)
        }
    }

    /**
     * @dev Derive the location of a mapping element from the key.
     */
    function deriveMapping(bytes32 slot, uint256 key) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            mstore(0x00, key)
            mstore(0x20, slot)
            result := keccak256(0x00, 0x40)
        }
    }

    /**
     * @dev Derive the location of a mapping element from the key.
     */
    function deriveMapping(bytes32 slot, int256 key) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            mstore(0x00, key)
            mstore(0x20, slot)
            result := keccak256(0x00, 0x40)
        }
    }

    /**
     * @dev Derive the location of a mapping element from the key.
     */
    function deriveMapping(bytes32 slot, string memory key) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            let length := mload(key)
            let begin := add(key, 0x20)
            let end := add(begin, length)
            let cache := mload(end)
            mstore(end, slot)
            result := keccak256(begin, add(length, 0x20))
            mstore(end, cache)
        }
    }

    /**
     * @dev Derive the location of a mapping element from the key.
     */
    function deriveMapping(bytes32 slot, bytes memory key) internal pure returns (bytes32 result) {
        assembly ("memory-safe") {
            let length := mload(key)
            let begin := add(key, 0x20)
            let end := add(begin, length)
            let cache := mload(end)
            mstore(end, slot)
            result := keccak256(begin, add(length, 0x20))
            mstore(end, cache)
        }
    }
}

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

pragma solidity ^0.8.20;

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

    struct BooleanSlot {
        bool value;
    }

    struct Bytes32Slot {
        bytes32 value;
    }

    struct Uint256Slot {
        uint256 value;
    }

    struct Int256Slot {
        int256 value;
    }

    struct StringSlot {
        string value;
    }

    struct BytesSlot {
        bytes value;
    }

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

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

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

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

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

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

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

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

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

// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/structs/BitMaps.sol)
pragma solidity ^0.8.20;

/**
 * @dev Library for managing uint256 to bool mapping in a compact and efficient way, provided the keys are sequential.
 * Largely inspired by Uniswap's https://github.com/Uniswap/merkle-distributor/blob/master/contracts/MerkleDistributor.sol[merkle-distributor].
 *
 * BitMaps pack 256 booleans across each bit of a single 256-bit slot of `uint256` type.
 * Hence booleans corresponding to 256 _sequential_ indices would only consume a single slot,
 * unlike the regular `bool` which would consume an entire slot for a single value.
 *
 * This results in gas savings in two ways:
 *
 * - Setting a zero value to non-zero only once every 256 times
 * - Accessing the same warm slot for every 256 _sequential_ indices
 */
library BitMaps {
    struct BitMap {
        mapping(uint256 bucket => uint256) _data;
    }

    /**
     * @dev Returns whether the bit at `index` is set.
     */
    function get(BitMap storage bitmap, uint256 index) internal view returns (bool) {
        uint256 bucket = index >> 8;
        uint256 mask = 1 << (index & 0xff);
        return bitmap._data[bucket] & mask != 0;
    }

    /**
     * @dev Sets the bit at `index` to the boolean `value`.
     */
    function setTo(BitMap storage bitmap, uint256 index, bool value) internal {
        if (value) {
            set(bitmap, index);
        } else {
            unset(bitmap, index);
        }
    }

    /**
     * @dev Sets the bit at `index`.
     */
    function set(BitMap storage bitmap, uint256 index) internal {
        uint256 bucket = index >> 8;
        uint256 mask = 1 << (index & 0xff);
        bitmap._data[bucket] |= mask;
    }

    /**
     * @dev Unsets the bit at `index`.
     */
    function unset(BitMap storage bitmap, uint256 index) internal {
        uint256 bucket = index >> 8;
        uint256 mask = 1 << (index & 0xff);
        bitmap._data[bucket] &= ~mask;
    }
}

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

pragma solidity ^0.8.24;

/**
 * @dev Library for reading and writing value-types to specific transient storage slots.
 *
 * Transient slots are often used to store temporary values that are removed after the current transaction.
 * This library helps with reading and writing to such slots without the need for inline assembly.
 *
 *  * Example reading and writing values using transient storage:
 * ```solidity
 * contract Lock {
 *     using TransientSlot for *;
 *
 *     // Define the slot. Alternatively, use the SlotDerivation library to derive the slot.
 *     bytes32 internal constant _LOCK_SLOT = 0xf4678858b2b588224636b8522b729e7722d32fc491da849ed75b3fdf3c84f542;
 *
 *     modifier locked() {
 *         require(!_LOCK_SLOT.asBoolean().tload());
 *
 *         _LOCK_SLOT.asBoolean().tstore(true);
 *         _;
 *         _LOCK_SLOT.asBoolean().tstore(false);
 *     }
 * }
 * ```
 *
 * TIP: Consider using this library along with {SlotDerivation}.
 */
library TransientSlot {
    /**
     * @dev UDVT that represent a slot holding a address.
     */
    type AddressSlot is bytes32;

    /**
     * @dev Cast an arbitrary slot to a AddressSlot.
     */
    function asAddress(bytes32 slot) internal pure returns (AddressSlot) {
        return AddressSlot.wrap(slot);
    }

    /**
     * @dev UDVT that represent a slot holding a bool.
     */
    type BooleanSlot is bytes32;

    /**
     * @dev Cast an arbitrary slot to a BooleanSlot.
     */
    function asBoolean(bytes32 slot) internal pure returns (BooleanSlot) {
        return BooleanSlot.wrap(slot);
    }

    /**
     * @dev UDVT that represent a slot holding a bytes32.
     */
    type Bytes32Slot is bytes32;

    /**
     * @dev Cast an arbitrary slot to a Bytes32Slot.
     */
    function asBytes32(bytes32 slot) internal pure returns (Bytes32Slot) {
        return Bytes32Slot.wrap(slot);
    }

    /**
     * @dev UDVT that represent a slot holding a uint256.
     */
    type Uint256Slot is bytes32;

    /**
     * @dev Cast an arbitrary slot to a Uint256Slot.
     */
    function asUint256(bytes32 slot) internal pure returns (Uint256Slot) {
        return Uint256Slot.wrap(slot);
    }

    /**
     * @dev UDVT that represent a slot holding a int256.
     */
    type Int256Slot is bytes32;

    /**
     * @dev Cast an arbitrary slot to a Int256Slot.
     */
    function asInt256(bytes32 slot) internal pure returns (Int256Slot) {
        return Int256Slot.wrap(slot);
    }

    /**
     * @dev Load the value held at location `slot` in transient storage.
     */
    function tload(AddressSlot slot) internal view returns (address value) {
        assembly ("memory-safe") {
            value := tload(slot)
        }
    }

    /**
     * @dev Store `value` at location `slot` in transient storage.
     */
    function tstore(AddressSlot slot, address value) internal {
        assembly ("memory-safe") {
            tstore(slot, value)
        }
    }

    /**
     * @dev Load the value held at location `slot` in transient storage.
     */
    function tload(BooleanSlot slot) internal view returns (bool value) {
        assembly ("memory-safe") {
            value := tload(slot)
        }
    }

    /**
     * @dev Store `value` at location `slot` in transient storage.
     */
    function tstore(BooleanSlot slot, bool value) internal {
        assembly ("memory-safe") {
            tstore(slot, value)
        }
    }

    /**
     * @dev Load the value held at location `slot` in transient storage.
     */
    function tload(Bytes32Slot slot) internal view returns (bytes32 value) {
        assembly ("memory-safe") {
            value := tload(slot)
        }
    }

    /**
     * @dev Store `value` at location `slot` in transient storage.
     */
    function tstore(Bytes32Slot slot, bytes32 value) internal {
        assembly ("memory-safe") {
            tstore(slot, value)
        }
    }

    /**
     * @dev Load the value held at location `slot` in transient storage.
     */
    function tload(Uint256Slot slot) internal view returns (uint256 value) {
        assembly ("memory-safe") {
            value := tload(slot)
        }
    }

    /**
     * @dev Store `value` at location `slot` in transient storage.
     */
    function tstore(Uint256Slot slot, uint256 value) internal {
        assembly ("memory-safe") {
            tstore(slot, value)
        }
    }

    /**
     * @dev Load the value held at location `slot` in transient storage.
     */
    function tload(Int256Slot slot) internal view returns (int256 value) {
        assembly ("memory-safe") {
            value := tload(slot)
        }
    }

    /**
     * @dev Store `value` at location `slot` in transient storage.
     */
    function tstore(Int256Slot slot, int256 value) internal {
        assembly ("memory-safe") {
            tstore(slot, value)
        }
    }
}

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

enum ActivityType {
  NONE,
  //
  // BLUE TICKETS
  //
  instantactions_evt_doinstantactions,
  instantvrfactions_evt_doinstantvrfactions,
  passiveactions_evt_claimpassiveaction,
  quests_evt_questcompleted,
  shop_evt_buy, // + shop_evt_buybatch,
  shop_evt_sell, // + shop_evt_sellbatch,
  wishingwell_evt_donate,
  wishingwell_evt_donatetoclan,
  orderbook_evt_ordersmatched,
  orderbook_evt_claimedtokens,
  orderbook_evt_claimednfts,
  // players
  players_evt_actionfinished,
  players_evt_addxp,
  players_evt_levelup,
  players_evt_boostfinished,
  players_evt_dailyreward,
  players_evt_weeklyreward,
  players_evt_claimedxpthresholdrewards,
  // clans
  clans_evt_clancreated, // _isClanActivityType
  lockedbankvaults_evt_attackvaults, // _isClanActivityType
  territories_evt_attackterritory, // _isClanActivityType
  territories_evt_claimunoccupiedterritory, // _isClanActivityType
  //
  // GREEN TICKETS
  //
  players_dailyreward, // = 8
  wishingwell_luckofthedraw, // = 3
  wishingwell_luckypotion // = 50
}

interface IActivityPointsCaller {
  function setActivityPoints(address activityPoints) external;
}

interface IActivityPoints {
  event ActivityPointsEarned(
    ActivityType indexed activityType,
    uint256 value,
    address indexed from,
    uint16 indexed tokenId,
    uint256 points
  );

  function rewardGreenTickets(
    ActivityType activityType,
    address recipient,
    bool isEvolved
  ) external returns (uint256 tickets);

  function rewardBlueTickets(
    ActivityType activityType,
    address from,
    bool isEvolvedOrNA,
    uint256 value
  ) external returns (uint256 points);
}

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

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

contract AdminAccess is UUPSUpgradeable, OwnableUpgradeable {
  mapping(address admin => bool isAdmin) private _admins;
  mapping(address admin => bool isAdmin) private _promotionalAdmins;

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

  function initialize(address[] calldata admins, address[] calldata promotionalAdmins) public initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();

    _updateAdmins(admins, true);
    _updatePromotionalAdmins(promotionalAdmins, true);
  }

  function _updateAdmins(address[] calldata admins, bool hasAdmin) internal {
    uint256 bounds = admins.length;
    for (uint256 i; i < bounds; ++i) {
      _admins[admins[i]] = hasAdmin;
    }
  }

  function _updatePromotionalAdmins(address[] calldata promotionalAdmins, bool hasAdmin) internal {
    uint256 bounds = promotionalAdmins.length;
    for (uint256 i; i < bounds; ++i) {
      _promotionalAdmins[promotionalAdmins[i]] = hasAdmin;
    }
  }

  function isAdmin(address admin) external view returns (bool) {
    return _admins[admin];
  }

  function addAdmins(address[] calldata admins) external onlyOwner {
    _updateAdmins(admins, true);
  }

  function removeAdmins(address[] calldata admins) external onlyOwner {
    _updateAdmins(admins, false);
  }

  function isPromotionalAdmin(address admin) external view returns (bool) {
    return _promotionalAdmins[admin];
  }

  function addPromotionalAdmins(address[] calldata admins) external onlyOwner {
    _updatePromotionalAdmins(admins, true);
  }

  function removePromotionalAdmins(address[] calldata admins) external onlyOwner {
    _updatePromotionalAdmins(admins, false);
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {ERC1155Holder} from "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {ContextUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol";
import {ReentrancyGuardTransientUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardTransientUpgradeable.sol";
import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol";
import {BitMaps} from "@openzeppelin/contracts/utils/structs/BitMaps.sol";
import {TransientSlot} from "@openzeppelin/contracts/utils/TransientSlot.sol";

import {IPlayers} from "../interfaces/IPlayers.sol";
import {IClans} from "../interfaces/IClans.sol";
import {IBank} from "../interfaces/IBank.sol";
import {ItemNFT} from "../ItemNFT.sol";
import {BankRegistry} from "./BankRegistry.sol";
import {BulkTransferInfo} from "../globals/items.sol";

contract Bank is ERC1155Holder, ReentrancyGuardTransientUpgradeable, ContextUpgradeable, IBank {
  using SafeCast for uint256;
  using BitMaps for BitMaps.BitMap;
  using TransientSlot for *;

  event DepositItems(address from, uint256 playerId, uint256[] ids, uint256[] values);
  event DepositItem(address from, uint256 playerId, uint256 id, uint256 value);
  event WithdrawItems(address from, address to, uint256 playerId, uint256[] ids, uint256[] values);
  event WithdrawItemsBulk(address from, BulkTransferInfo[] nftTransferInfos, uint256 playerId);
  event DepositFTM(address from, uint256 playerId, uint256 amount);
  event WithdrawFTM(address from, address to, uint256 playerId, uint256 amount);
  event DepositToken(address from, uint256 playerId, address token, uint256 amount);
  event WithdrawToken(address from, uint256 playerId, address to, uint256 toPlayerId, address token, uint256 amount);
  event WithdrawTokens(
    address from,
    uint256 playerId,
    address[] tos,
    uint256[] toPlayerIds,
    address token,
    uint256[] amounts
  );
  event WithdrawNFT(
    address from,
    uint256 playerId,
    address to,
    uint256 toPlayerId,
    address nft,
    uint256 tokenId,
    uint256 amount
  );

  error OnlyBankRelay();
  error MaxBankCapacityReached();
  error NotClanAdmin();
  error NotOwnerOfPlayer();
  error DepositFailed();
  error WithdrawFailed();
  error LengthMismatch();
  error ToIsNotOwnerOfPlayer();
  error UseWithdrawItemsForNFT();
  error NFTTypeNotSupported();
  error NotForceItemDepositor();
  error AlreadyInitialized();

  // keccak256(abi.encode(uint256(keccak256("estfor.storage.BANK_FORCE_ITEM_DEPOSIT")) - 1)) & ~bytes32(uint256(0xff))
  bytes32 private constant ALLOW_BREACH_DEPOSIT_STORAGE =
    0xe1cc2a79077b9b85fa7b7090722bc6046bc96060f22c019f0577708488ee8400;

  uint40 private _clanId;
  BankRegistry private _bankRegistry;
  address private _bankRelay;
  IERC1155 private _playerNFT;
  ItemNFT private _itemNFT;
  uint16 private _uniqueItemCount;
  IClans private _clans;
  IPlayers private _players;
  address private _lockedBankVaults;
  address private _raids;
  bool private notused_allowBreachedCapacity; // moved to transient storage
  bool private _initialized;

  BitMaps.BitMap private _uniqueItems; // itemTokenId => bool hasAny

  modifier onlyBankRelay() {
    require(_msgSender() == _bankRelay, OnlyBankRelay());
    _;
  }

  modifier notInitialized() {
    require(!_initialized, AlreadyInitialized());
    _;
  }

  modifier isOwnerOfPlayer(address sender, uint256 playerId) {
    require(_playerNFT.balanceOf(sender, playerId) == 1, NotOwnerOfPlayer());
    _;
  }

  modifier canWithdraw(uint256 playerId) {
    require(_clans.canWithdraw(_clanId, playerId), NotClanAdmin());
    _;
  }

  modifier onlyForceItemDepositor() {
    require(_isForceItemDepositor(_msgSender()), NotForceItemDepositor());
    _;
  }

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

  function initialize() external override initializer {
    __ReentrancyGuardTransient_init();
  }

  function initializeAddresses(
    uint256 clanId,
    address bankRegistry,
    address bankRelay,
    address playerNFT,
    address itemNFT,
    address clans,
    address players,
    address lockedBankVaults,
    address raids
  ) external notInitialized {
    _initialized = true;
    _clanId = clanId.toUint40();
    _bankRegistry = BankRegistry(bankRegistry);
    _bankRelay = bankRelay;
    _playerNFT = IERC1155(playerNFT);
    _itemNFT = ItemNFT(itemNFT);
    _clans = IClans(clans);
    _players = IPlayers(players);
    _lockedBankVaults = lockedBankVaults;
    _raids = raids;
  }

  function depositItems(
    address sender,
    uint256 playerId,
    uint256[] calldata ids,
    uint256[] calldata values
  ) external onlyBankRelay isOwnerOfPlayer(sender, playerId) {
    uint256 maxCapacity = _clans.maxBankCapacity(_clanId);
    uint256 bounds = ids.length;
    uint16 newUniqueItemCount = _uniqueItemCount;
    bool isForceItemDepositor = false;
    for (uint256 i; i < bounds; ++i) {
      (newUniqueItemCount, isForceItemDepositor) = _receivedItemUpdateUniqueItems(
        ids[i],
        maxCapacity,
        newUniqueItemCount,
        isForceItemDepositor
      );
    }
    _uniqueItemCount = newUniqueItemCount;
    _itemNFT.safeBatchTransferFrom(sender, address(this), ids, values, "");
    emit DepositItems(sender, playerId, ids, values);
  }

  function getUniqueItemCount() external view returns (uint16) {
    return _uniqueItemCount;
  }

  function _withdraw(uint256[] calldata ids) private returns (uint256 uniqueItemsToRemove) {
    for (uint256 i; i < ids.length; ++i) {
      uint256 id = ids[i];
      if (_uniqueItems.get(id) && _itemNFT.balanceOf(address(this), id) == 0) {
        ++uniqueItemsToRemove;
        _uniqueItems.unset(id);
      }
    }
  }

  function withdrawItems(
    address sender,
    address to,
    uint256 playerId,
    uint256[] calldata ids,
    uint256[] calldata amounts
  ) external onlyBankRelay isOwnerOfPlayer(sender, playerId) canWithdraw(playerId) nonReentrant {
    _itemNFT.safeBatchTransferFrom(address(this), to, ids, amounts, "");

    // Update uniqueItemCount after transferring the items
    uint256 uniqueItemsToRemove = _withdraw(ids);
    _uniqueItemCount -= uint16(uniqueItemsToRemove);

    emit WithdrawItems(sender, to, playerId, ids, amounts);
  }

  function withdrawItemsBulk(
    address sender,
    BulkTransferInfo[] calldata nftsInfo,
    uint256 playerId
  ) external onlyBankRelay isOwnerOfPlayer(sender, playerId) canWithdraw(playerId) nonReentrant {
    _itemNFT.safeBulkTransfer(nftsInfo);

    // Update uniqueItemCount after transferring the items
    uint256 uniqueItemsToRemove;
    for (uint256 i; i < nftsInfo.length; ++i) {
      uniqueItemsToRemove += _withdraw(nftsInfo[i].tokenIds);
    }
    _uniqueItemCount -= uint16(uniqueItemsToRemove);
    emit WithdrawItemsBulk(sender, nftsInfo, playerId);
  }

  function depositFTM(
    address sender,
    uint256 playerId
  ) external payable onlyBankRelay isOwnerOfPlayer(sender, playerId) {
    if (msg.value != 0) {
      emit DepositFTM(sender, playerId, msg.value);
    }
  }

  // Untested
  function withdrawFTM(
    address sender,
    address to,
    uint256 playerId,
    uint256 amount
  ) external onlyBankRelay isOwnerOfPlayer(sender, playerId) canWithdraw(playerId) {
    (bool success, ) = sender.call{value: amount}("");
    require(success, WithdrawFailed());
    emit WithdrawFTM(sender, to, playerId, amount);
  }

  function depositToken(
    address sender, // either Player owner or LockedBankVaults
    address playerOwner,
    uint256 playerId,
    address token,
    uint256 amount
  ) external onlyBankRelay isOwnerOfPlayer(playerOwner, playerId) {
    require(playerOwner == sender || sender == _lockedBankVaults, NotOwnerOfPlayer());
    bool success = IERC20(token).transferFrom(sender, address(this), amount);
    require(success, DepositFailed());
    emit DepositToken(playerOwner, playerId, token, amount);
  }

  function withdrawToken(
    address sender,
    uint256 playerId,
    address to,
    uint256 toPlayerId,
    address token,
    uint256 amount
  ) external onlyBankRelay isOwnerOfPlayer(sender, playerId) canWithdraw(playerId) {
    require(_playerNFT.balanceOf(to, toPlayerId) == 1, ToIsNotOwnerOfPlayer());
    bool success = IERC20(token).transfer(to, amount);
    require(success, WithdrawFailed());
    emit WithdrawToken(sender, playerId, to, toPlayerId, token, amount);
  }

  function withdrawTokenToMany(
    address sender,
    uint256 playerId,
    address[] calldata tos,
    uint256[] calldata toPlayerIds,
    address token,
    uint256[] calldata _amounts
  ) external onlyBankRelay isOwnerOfPlayer(sender, playerId) canWithdraw(playerId) {
    require(toPlayerIds.length == _amounts.length && toPlayerIds.length == tos.length, LengthMismatch());

    IERC1155 playerNFT = _playerNFT;
    for (uint256 i = 0; i < toPlayerIds.length; ++i) {
      require(playerNFT.balanceOf(tos[i], toPlayerIds[i]) == 1, ToIsNotOwnerOfPlayer());
      bool success = IERC20(token).transfer(tos[i], _amounts[i]);
      require(success, WithdrawFailed());
    }

    emit WithdrawTokens(sender, playerId, tos, toPlayerIds, token, _amounts);
  }

  function withdrawNFT(
    address sender,
    uint256 playerId,
    address to,
    uint256 toPlayerId,
    address nft,
    uint256 tokenId,
    uint256 amount
  ) external onlyBankRelay isOwnerOfPlayer(sender, playerId) canWithdraw(playerId) {
    require(nft != address(_itemNFT), UseWithdrawItemsForNFT());
    require(_playerNFT.balanceOf(to, toPlayerId) == 1, ToIsNotOwnerOfPlayer());
    require(IERC165(nft).supportsInterface(type(IERC1155).interfaceId), NFTTypeNotSupported());

    IERC1155(nft).safeTransferFrom(address(this), to, tokenId, amount, "");
    emit WithdrawNFT(sender, playerId, to, toPlayerId, nft, tokenId, amount);
  }

  function onERC1155Received(
    address operator,
    address from,
    uint256 id,
    uint256 value,
    bytes memory data
  ) public override returns (bytes4) {
    // Only care about itemNFTs sent from outside the bank here
    if (_msgSender() == address(_itemNFT) && operator != address(this)) {
      uint256 maxCapacity = _clans.maxBankCapacity(_clanId);
      bool dummyIsForceItemDepositor = false;
      (uint16 newUniqueItemCount, ) = _receivedItemUpdateUniqueItems(
        id,
        maxCapacity,
        _uniqueItemCount,
        dummyIsForceItemDepositor
      );
      _uniqueItemCount = newUniqueItemCount;
      uint256 activePlayerId = _players.getActivePlayer(from);
      emit DepositItem(from, activePlayerId, id, value);
    }
    return super.onERC1155Received(operator, from, id, value, data);
  }

  function onERC1155BatchReceived(
    address operator,
    address from,
    uint256[] memory ids,
    uint256[] memory values,
    bytes memory data
  ) public override returns (bytes4) {
    // Only care about itemNFTs sent from outside the bank here
    if (_msgSender() == address(_itemNFT) && operator != address(this)) {
      uint256 maxCapacity = _clans.maxBankCapacity(_clanId);
      uint256 bounds = ids.length;
      uint16 newUniqueItemCount = _uniqueItemCount;
      bool isForceItemDepositor = false;
      for (uint256 i; i < bounds; ++i) {
        (newUniqueItemCount, isForceItemDepositor) = _receivedItemUpdateUniqueItems(
          ids[i],
          maxCapacity,
          newUniqueItemCount,
          isForceItemDepositor
        );
      }
      _uniqueItemCount = newUniqueItemCount;
      uint256 activePlayerId = _players.getActivePlayer(from);
      emit DepositItems(from, activePlayerId, ids, values);
    }
    return super.onERC1155BatchReceived(operator, from, ids, values, data);
  }

  function _receivedItemUpdateUniqueItems(
    uint256 id,
    uint256 maxCapacity,
    uint16 uniqueItemCount,
    bool isForceItemDepositor
  ) private returns (uint16 newUniqueItemCount, bool isForceItemDepositor_) {
    bool isNewItem = !_uniqueItems.get(id);
    isForceItemDepositor_ = isForceItemDepositor;
    if (isNewItem) {
      if (uniqueItemCount >= maxCapacity && !isForceItemDepositor) {
        // Only a force depositor is able to extend the bank capacity, stuff like raid loot
        require(_getAllowBreachedCapacity(), MaxBankCapacityReached());
        isForceItemDepositor_ = true;
      }
      _uniqueItems.set(id);
      newUniqueItemCount = uniqueItemCount + 1;
    } else {
      newUniqueItemCount = uniqueItemCount;
    }
  }

  function _isForceItemDepositor(address account) private view returns (bool allowed) {
    return _bankRegistry.isForceItemDepositor(account);
  }

  function setAllowBreachedCapacity(bool allow) external override onlyForceItemDepositor {
    ALLOW_BREACH_DEPOSIT_STORAGE.asBoolean().tstore(allow);
  }

  function _getAllowBreachedCapacity() private view returns (bool) {
    return ALLOW_BREACH_DEPOSIT_STORAGE.asBoolean().tload();
  }

  // Untested
  receive() external payable {
    // Accept FTM
    uint256 activePlayerId = _players.getActivePlayer(_msgSender());
    emit DepositFTM(_msgSender(), activePlayerId, msg.value);
  }
}

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

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

import {IBankFactory} from "../interfaces/IBankFactory.sol";
import {IBank} from "../interfaces/IBank.sol";
import {IClans} from "../interfaces/IClans.sol";

contract BankFactory is UUPSUpgradeable, OwnableUpgradeable, IBankFactory {
  event BankContractCreated(address creator, uint256 clanId, address newContract);

  error OnlyClans();
  error BankAlreadyCreated();
  error BankRelayAlreadySet();

  mapping(uint256 clanId => address bank) private _bankAddress;
  // Keeps track of which vault addresses have been created here
  mapping(address => bool) private _createdHere;
  /// @custom:oz-renamed-from bankUpgradeableProxy
  address private _bankBeacon;
  address private _bankRegistry;
  address private _bankRelay;
  address private _playerNFT;
  address private _itemNFT;
  address private _clans;
  address private _players;
  address private _lockedBankVaults;
  address private _raids;

  modifier onlyClans() {
    require(address(_clans) == _msgSender(), OnlyClans());
    _;
  }

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

  function initialize(
    address bankBeacon,
    address bankRegistry,
    address bankRelay,
    address playerNFT,
    address itemNFT,
    address clans,
    address players,
    address lockedBankVaults,
    address raids
  ) external initializer {
    __UUPSUpgradeable_init();
    __Ownable_init(_msgSender());

    _bankBeacon = bankBeacon;
    _bankRegistry = bankRegistry;
    _bankRelay = bankRelay;
    _playerNFT = playerNFT;
    _itemNFT = itemNFT;
    _clans = clans;
    _players = players;
    _lockedBankVaults = lockedBankVaults;
    _raids = raids;
  }

  function getBankAddress(uint256 clanId) external view override returns (address) {
    return _bankAddress[clanId];
  }

  function getCreatedHere(address bank) external view override returns (bool) {
    return _createdHere[bank];
  }

  function createBank(address from, uint256 clanId) external onlyClans returns (address) {
    require(_bankAddress[clanId] == address(0), BankAlreadyCreated());

    // Create new Bank contract with EIP 1167 beacon proxy
    address proxy = address(
      new BeaconProxy{salt: bytes32(clanId)}(_bankBeacon, abi.encodeWithSelector(IBank.initialize.selector))
    );

    // Cannot just update this after deployment as other banks won't have the extra things set, need to use the bankRegistry.
    IBank(proxy).initializeAddresses(
      clanId,
      _bankRegistry,
      _bankRelay,
      _playerNFT,
      _itemNFT,
      _clans,
      _players,
      _lockedBankVaults,
      _raids
    );

    _createdHere[proxy] = true;
    _bankAddress[clanId] = proxy;
    emit BankContractCreated(from, clanId, proxy);
    return proxy;
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

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

contract BankRegistry is UUPSUpgradeable, OwnableUpgradeable {
  error LengthMismatch();

  mapping(address depositor => bool allowed) private _forceItemDepositors;

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

  function initialize() external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();
  }

  function setForceItemDepositors(address[] calldata depositors, bool[] calldata allowed) external onlyOwner {
    require(depositors.length == allowed.length, LengthMismatch());
    for (uint256 i = 0; i < depositors.length; i++) {
      _forceItemDepositors[depositors[i]] = allowed[i];
    }
  }

  function isForceItemDepositor(address depositor) external view returns (bool) {
    return _forceItemDepositors[depositor];
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

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

import {BankFactory} from "./BankFactory.sol";
import {Bank} from "./Bank.sol";
import {Clans} from "./Clans.sol";

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

import {BulkTransferInfo} from "../globals/items.sol";

contract BankRelay is UUPSUpgradeable, OwnableUpgradeable {
  error PlayerNotInClan();

  Clans private _clans;
  BankFactory private _bankFactory;
  PlayerNFT private _playerNFT;

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

  function initialize(address clans) external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();

    _clans = Clans(clans);
  }

  /**
   * @notice Deposits items to the clan bank. The bank address is derived from the player's clan id.
   * @param playerId The ID of the player depositing items.
   * @param ids The array of item IDs to deposit.
   * @param amounts The array of item quantities to deposit.
   */
  function depositItems(uint256 playerId, uint256[] calldata ids, uint256[] calldata amounts) external {
    depositItemsAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), playerId, ids, amounts);
  }

  /**
   * @notice Deposits items to a specified clan bank address.
   * @param clanBankAddress The address of the clan bank.
   * @param playerId The ID of the player depositing items.
   * @param ids The array of item IDs to deposit.
   * @param amounts The array of item quantities to deposit.
   */
  function depositItemsAtBank(
    address payable clanBankAddress,
    uint256 playerId,
    uint256[] calldata ids,
    uint256[] calldata amounts
  ) public {
    Bank(clanBankAddress).depositItems(_msgSender(), playerId, ids, amounts);
  }

  /**
   * @notice Withdraws items from the clan bank in bulk. Looks up the bank address from the player's clan id.
   * @param to The address to receive the items.
   * @param playerId The ID of the player withdrawing items.
   * @param ids The array of item IDs to withdraw.
   * @param amounts The array of item quantities to withdraw.
   */
  function withdrawItems(address to, uint256 playerId, uint256[] calldata ids, uint256[] calldata amounts) external {
    withdrawItemsAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), to, playerId, ids, amounts);
  }

  /**
   * @notice Withdraws items from a specified clan bank address in bulk.
   * @param clanBankAddress The address of the clan bank.
   * @param to The address to receive the items.
   * @param playerId The ID of the player withdrawing items.
   * @param ids The array of item IDs to withdraw.
   * @param amounts The array of item quantities to withdraw.
   */
  function withdrawItemsAtBank(
    address payable clanBankAddress,
    address to,
    uint256 playerId,
    uint256[] calldata ids,
    uint256[] calldata amounts
  ) public {
    Bank(clanBankAddress).withdrawItems(_msgSender(), to, playerId, ids, amounts);
  }

  /**
   * @notice Withdraws multiple items from the bank in bulk for a player. Bank address is derived from the player's clan id.
   * @param nftsInfo The items to withdraw in bulk.
   * @param playerId The ID of the player withdrawing items.
   */
  function withdrawItemsBulk(BulkTransferInfo[] calldata nftsInfo, uint256 playerId) external {
    withdrawItemsBulkAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), nftsInfo, playerId);
  }

  /**
   * @notice Withdraws multiple items from a specified bank in bulk for a player.
   * @param clanBankAddress The address of the clan bank.
   * @param nftsInfo The items to withdraw in bulk.
   * @param playerId The ID of the player withdrawing items.
   */
  function withdrawItemsBulkAtBank(
    address payable clanBankAddress,
    BulkTransferInfo[] calldata nftsInfo,
    uint256 playerId
  ) public {
    Bank(clanBankAddress).withdrawItemsBulk(_msgSender(), nftsInfo, playerId);
  }

  /**
   * @notice Deposits FTM to the clan bank. The bank address is derived from the player's clan id.
   * @param playerId The ID of the player depositing FTM.
   */
  function depositFTM(uint256 playerId) external payable {
    depositFTMAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), playerId);
  }

  /**
   * @notice Deposits FTM to a specified clan bank address.
   * @param clanBankAddress The address of the clan bank.
   * @param playerId The ID of the player depositing FTM.
   */
  function depositFTMAtBank(address payable clanBankAddress, uint256 playerId) public payable {
    Bank(clanBankAddress).depositFTM{value: msg.value}(_msgSender(), playerId);
  }

  /**
   * @notice Deposits a specified amount of tokens to the clan bank for a player. Looks up the bank address from the player's clan id.
   * @param playerId The ID of the player depositing tokens.
   * @param token The address of the token being deposited.
   * @param amount The amount of tokens to deposit.
   */
  function depositToken(uint256 playerId, address token, uint256 amount) external {
    depositTokenAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), playerId, token, amount);
  }

  /**
   * @notice Deposits a specified amount of tokens to a specified clan bank address for a player.
   * @param clanBankAddress The address of the clan bank.
   * @param playerId The ID of the player depositing tokens.
   * @param token The address of the token being deposited.
   * @param amount The amount of tokens to deposit.
   */
  function depositTokenAtBank(address payable clanBankAddress, uint256 playerId, address token, uint256 amount) public {
    Bank(clanBankAddress).depositToken(_msgSender(), _msgSender(), playerId, token, amount);
  }

  /**
   * @notice Deposit an amount of a token to the clan bank for a player. Looks up the bank address from the player's clan id.
   * @param playerOwner The player owner address
   * @param playerId The player id
   * @param token The token address
   * @param amount The amount to deposit
   */
  function depositTokenFor(address playerOwner, uint256 playerId, address token, uint256 amount) external {
    depositTokenForAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), playerOwner, playerId, token, amount);
  }

  /**
   * @notice Deposit an amount of a token to the clan bank for a player.
   * @param clanBankAddress The bank address
   * @param playerOwner The player owner address
   * @param playerId The player id
   * @param token The token address
   * @param amount The amount to deposit
   */
  function depositTokenForAtBank(
    address payable clanBankAddress,
    address playerOwner,
    uint256 playerId,
    address token,
    uint256 amount
  ) public {
    Bank(clanBankAddress).depositToken(_msgSender(), playerOwner, playerId, token, amount);
  }

  /**
   * @notice Withdraw an amount of a token from the clan bank. Looks up the bank address from the player's clan id.
   * @param playerId The player id
   * @param to The address to withdraw to
   * @param toPlayerId The player id to withdraw to
   * @param token The token address
   * @param amount The amount to withdraw
   */
  function withdrawToken(uint256 playerId, address to, uint256 toPlayerId, address token, uint256 amount) external {
    withdrawTokenAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), playerId, to, toPlayerId, token, amount);
  }

  /**
   * @notice Withdraw an amount of a token from the clan bank.
   * @param clanBankAddress The bank address
   * @param playerId The player id
   * @param to The address to withdraw to
   * @param toPlayerId The player id to withdraw to
   * @param token The token address
   * @param amount The amount to withdraw
   */
  function withdrawTokenAtBank(
    address payable clanBankAddress,
    uint256 playerId,
    address to,
    uint256 toPlayerId,
    address token,
    uint256 amount
  ) public {
    Bank(clanBankAddress).withdrawToken(_msgSender(), playerId, to, toPlayerId, token, amount);
  }

  /**
   * @notice Withdraws an amount of tokens from the clan bank for a player, transferring to many other players.
   * Looks up the bank address from the player's clan id.
   * @param playerId The ID of the player withdrawing tokens.
   * @param tos Array of addresses to receive the tokens.
   * @param toPlayerIds Array of player IDs to receive tokens.
   * @param token The address of the token being withdrawn.
   * @param amounts Array of token amounts to withdraw.
   */
  function withdrawTokenToMany(
    uint256 playerId,
    address[] calldata tos,
    uint256[] calldata toPlayerIds,
    address token,
    uint256[] calldata amounts
  ) external {
    withdrawTokenToManyAtBank(
      _getBankAddress(_getClanIdFromPlayer(playerId)),
      playerId,
      tos,
      toPlayerIds,
      token,
      amounts
    );
  }

  /**
   * @notice Withdraw an amount of a token from the clan bank for a player to many other players.
   * @param clanBankAddress The bank address
   * @param playerId The player id
   * @param tos The addresses to withdraw to
   * @param toPlayerIds The player ids to withdraw to
   * @param token The token address
   * @param amounts The amounts to withdraw
   */
  function withdrawTokenToManyAtBank(
    address payable clanBankAddress,
    uint256 playerId,
    address[] calldata tos,
    uint256[] calldata toPlayerIds,
    address token,
    uint256[] calldata amounts
  ) public {
    Bank(clanBankAddress).withdrawTokenToMany(_msgSender(), playerId, tos, toPlayerIds, token, amounts);
  }

  /**
   * @notice Withdraws an NFT from the clan bank for a player. Looks up the bank address from the player's clan id.
   * @param playerId The ID of the player withdrawing the NFT.
   * @param to The address to receive the NFT.
   * @param toPlayerId The player ID to receive the NFT.
   * @param nft The address of the NFT contract.
   * @param tokenId The ID of the NFT token.
   * @param amount The quantity of the NFT to withdraw.
   */
  function withdrawNFT(
    uint256 playerId,
    address to,
    uint256 toPlayerId,
    address nft,
    uint256 tokenId,
    uint256 amount
  ) external {
    withdrawNFTAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), playerId, to, toPlayerId, nft, tokenId, amount);
  }

  /**
   * @notice Withdraws an NFT from a specified clan bank for a player.
   * @param clanBankAddress The address of the clan bank.
   * @param playerId The ID of the player withdrawing the NFT.
   * @param to The address to receive the NFT.
   * @param toPlayerId The player ID to receive the NFT.
   * @param nft The address of the NFT contract.
   * @param tokenId The ID of the NFT token.
   * @param amount The quantity of the NFT to withdraw.
   */
  function withdrawNFTAtBank(
    address payable clanBankAddress,
    uint256 playerId,
    address to,
    uint256 toPlayerId,
    address nft,
    uint256 tokenId,
    uint256 amount
  ) public {
    Bank(clanBankAddress).withdrawNFT(_msgSender(), playerId, to, toPlayerId, nft, tokenId, amount);
  }

  /**
   * @notice Withdraw an amount of FTM from the clan bank. Looks up the bank address from the player's clan id.
   * @param to The address to withdraw to
   * @param playerId The player id
   * @param amount The amount to withdraw
   */
  function withdrawFTM(address to, uint256 playerId, uint256 amount) external {
    withdrawFTMAtBank(_getBankAddress(_getClanIdFromPlayer(playerId)), to, playerId, amount);
  }

  /**
   * @notice Withdraw an amount of FTM from the clan bank.
   * @param clanBankAddress The bank address
   * @param to The address to withdraw to
   * @param playerId The player id
   * @param amount The amount to withdraw
   */
  function withdrawFTMAtBank(address payable clanBankAddress, address to, uint256 playerId, uint256 amount) public {
    Bank(clanBankAddress).withdrawFTM(_msgSender(), to, playerId, amount);
  }

  function _getBankAddress(uint256 clanId) private view returns (address payable) {
    return payable(_bankFactory.getBankAddress(clanId));
  }

  function _getClanIdFromPlayer(uint256 playerId) private view returns (uint256) {
    uint256 clanId = _clans.getClanIdFromPlayer(playerId);
    require(clanId != 0, PlayerNotInClan());
    return clanId;
  }

  /**
   * @notice Gets the unique item count for a player. Looks up the bank address from the player's clan id.
   * @param playerId The ID of the player.
   * @return The unique item count.
   */
  function getUniqueItemCountForPlayer(uint256 playerId) external view returns (uint256) {
    return Bank(_getBankAddress(_getClanIdFromPlayer(playerId))).getUniqueItemCount();
  }

  /**
   * @notice Get the unique item count for a clan. Looks up the bank address from the clan id.
   * @param clanId The clan id
   * @return The unique item count
   */
  function getUniqueItemCountForClan(uint256 clanId) external view returns (uint256) {
    return Bank(_getBankAddress(clanId)).getUniqueItemCount();
  }

  /**
   * @notice Get the unique item count for a bank.
   * @param bankAddress The bank address
   * @return The unique item count
   */
  function getUniqueItemCountAtBank(address payable bankAddress) external view returns (uint256) {
    return Bank(bankAddress).getUniqueItemCount();
  }

  function setBankFactory(address bankFactory) external onlyOwner {
    _bankFactory = BankFactory(bankFactory);
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";

import {PlayersLibrary} from "../Players/PlayersLibrary.sol";
import {EstforLibrary} from "../EstforLibrary.sol";

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

// solhint-disable-next-line no-global-import
import "../globals/all.sol";

library ClanBattleLibrary {
  error TooManyAttackers();
  error TooManyDefenders();
  error NotEnoughRandomWords();

  function determineBattleOutcome(
    address players,
    uint64[] memory clanMembersA,
    uint64[] memory clanMembersB,
    uint8[] memory skills,
    uint256[] memory randomWords, // 0 is for shuffling attacker, 1 & 2 for the dice rolls, 3 is for shuffling the defenders, 4 & 5 for the dice rolls
    uint256 extraRollsA,
    uint256 extraRollsB
  )
    external
    view
    returns (
      uint8[] memory battleResults,
      uint256[] memory rollsA,
      uint256[] memory rollsB,
      bool didAWin,
      uint64[] memory shuffledClanMembersA,
      uint64[] memory shuffledClanMembersB
    )
  {
    (battleResults, rollsA, rollsB, didAWin) = _determineBattleOutcome(
      players,
      clanMembersA,
      clanMembersB,
      skills,
      randomWords,
      extraRollsA,
      extraRollsB
    );
    // These have now been shuffled, so return them to the caller
    shuffledClanMembersA = clanMembersA;
    shuffledClanMembersB = clanMembersB;
  }

  function _determineBattleOutcome(
    address players,
    uint64[] memory clanMembersA, // [In/Out] gets shuffled
    uint64[] memory clanMembersB, // [In/Out] gets shuffled
    uint8[] memory skills,
    uint256[] memory randomWords,
    uint256 extraRollsA,
    uint256 extraRollsB
  )
    internal
    view
    returns (uint8[] memory battleResults, uint256[] memory rollsA, uint256[] memory rollsB, bool didAWin)
  {
    require(clanMembersA.length <= 32, TooManyAttackers());
    require(clanMembersB.length <= 32, TooManyDefenders());
    require(randomWords.length >= 6, NotEnoughRandomWords());

    EstforLibrary._shuffleArray(clanMembersA, randomWords[0]);
    EstforLibrary._shuffleArray(clanMembersB, randomWords[3]);

    uint256 baseClanMembersCount = clanMembersA.length > clanMembersB.length
      ? clanMembersB.length
      : clanMembersA.length;

    battleResults = new uint8[](Math.max(clanMembersA.length, clanMembersB.length));
    rollsA = new uint256[](Math.max(clanMembersA.length, clanMembersB.length));
    rollsB = new uint256[](Math.max(clanMembersA.length, clanMembersB.length));

    uint256 numWinnersA;
    uint256 numWinnersB;
    {
      for (uint256 i; i < baseClanMembersCount; ++i) {
        // It's possible that there are empty entries if they left the clan
        if (clanMembersA[i] == 0 || clanMembersB[i] == 0) {
          rollsA[i] = clanMembersA[i] == 0 ? 0 : 1;
          rollsB[i] = clanMembersB[i] == 0 ? 0 : 1;
        } else {
          uint256 levelA = PlayersLibrary._getLevel(IPlayers(players).getPlayerXP(clanMembersA[i], Skill(skills[i])));
          uint256 levelB = PlayersLibrary._getLevel(IPlayers(players).getPlayerXP(clanMembersB[i], Skill(skills[i])));
          if (levelA > 20 * 13 || levelB > 20 * 13) {
            assert(false); // Unsupported
          }

          // Get two consecutive bytes for each player's rolls
          bytes2 bytesA;
          bytes2 bytesB;

          // Handle up to 32 players:
          // Players 0-15 from randomWords[1]
          // Players 16-31 from randomWords[2]
          if (i < 16) {
            // Shift right to get the bytes we want and mask to get 2 bytes
            // For i=0, we want bytes 31,30
            // For i=1, we want bytes 29,28
            // etc.
            bytesA = bytes2(uint16(randomWords[1] >> (i * 16)));
            bytesB = bytes2(uint16(randomWords[4] >> (i * 16)));
          } else {
            // For players 16-31, use the second word of each pair
            uint256 j = i - 16;
            bytesA = bytes2(uint16(randomWords[2] >> (j * 16)));
            bytesB = bytes2(uint16(randomWords[5] >> (j * 16)));
          }

          uint256 numRollsA = (levelA / 20) + 1 + extraRollsA;

          // Check how many bits are set based on the number of rolls
          for (uint256 j; j < numRollsA; ++j) {
            rollsA[i] += uint16(bytesA >> j) & 1;
          }
          uint256 numRollsB = (levelB / 20) + 1 + extraRollsB;

          for (uint256 j; j < numRollsB; ++j) {
            rollsB[i] += uint16(bytesB >> j) & 1;
          }
        }
        if (rollsA[i] > rollsB[i]) {
          ++numWinnersA;
          battleResults[i] = uint8(BattleResultEnum.WIN);
        } else if (rollsB[i] > rollsA[i]) {
          ++numWinnersB;
          battleResults[i] = uint8(BattleResultEnum.LOSE);
        } else {
          battleResults[i] = uint8(BattleResultEnum.DRAW);
        }
      }
    }

    if (clanMembersB.length > clanMembersA.length) {
      numWinnersB += clanMembersB.length - clanMembersA.length;
      for (uint256 i = baseClanMembersCount; i < clanMembersB.length; ++i) {
        battleResults[i] = uint8(BattleResultEnum.LOSE);
      }
    } else if (clanMembersA.length > clanMembersB.length) {
      numWinnersA += clanMembersA.length - clanMembersB.length;
      for (uint256 i = baseClanMembersCount; i < clanMembersA.length; ++i) {
        battleResults[i] = uint8(BattleResultEnum.WIN);
      }
    }

    didAWin = numWinnersA >= numWinnersB;
  }
}

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

import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";

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

import {IBrushToken} from "../interfaces/external/IBrushToken.sol";
import {IPlayers} from "../interfaces/IPlayers.sol";
import {IClans} from "../interfaces/IClans.sol";
import {IBankFactory} from "../interfaces/IBankFactory.sol";
import {IBank} from "../interfaces/IBank.sol";
import {IMarketplaceWhitelist} from "../interfaces/external/IMarketplaceWhitelist.sol";
import {IClanMemberLeftCB} from "../interfaces/IClanMemberLeftCB.sol";
import {EstforLibrary} from "../EstforLibrary.sol";

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

import {ClanRank} from "../globals/clans.sol";

import {IActivityPoints, IActivityPointsCaller, ActivityType} from "../ActivityPoints/interfaces/IActivityPoints.sol";

contract Clans is UUPSUpgradeable, OwnableUpgradeable, IClans, IActivityPointsCaller {
  using BloomFilter for BloomFilter.Filter;

  event ClanCreated(
    uint256 clanId,
    uint256 playerId,
    string[] clanInfo,
    uint256 imageId,
    uint256 tierId,
    uint256 createdTimestamp
  );
  event SetClanRank(uint256 clanId, uint256 playerId, ClanRank clan);
  event InviteSent(uint256 clanId, uint256 playerId, uint256 fromPlayerId);
  event InvitesSent(uint256 clanId, uint256[] playerIds, uint256 fromPlayerId);
  event InviteAccepted(uint256 clanId, uint256 playerId);
  event MemberLeft(uint256 clanId, uint256 playerId, uint256 removedByPlayerId);
  event JoinRequestSent(uint256 clanId, uint256 playerId);
  event JoinRequestAccepted(uint256 clanId, uint256 playerId, uint256 acceptedByPlayerId);
  event JoinRequestsAccepted(uint256 clanId, uint256[] playerIds, uint256 acceptedByPlayerId);
  event JoinRequestRemoved(uint256 clanId, uint256 playerId);
  event ClanOwnershipTransferred(uint256 clanId, uint256 playerId);
  event AddTiers(Tier[] tiers);
  event EditTiers(Tier[] tiers);
  event ClanOwnerLeft(uint256 clanId, uint256 playerId);
  event ClanEdited(uint256 clanId, uint256 playerId, string[] clanInfo, uint256 imageId);
  event ClanUpgraded(uint256 clanId, uint256 playerId, uint256 tierId);
  event ClanDestroyed(uint256 clanId);
  event PlayerRankUpdated(uint256 clanId, uint256 memberId, ClanRank rank, uint256 playerId);
  event InvitesDeletedByPlayer(uint256[] clanIds, uint256 playerId);
  event InvitesDeletedByClan(uint256 clanId, uint256[] invitedPlayerIds, uint256 deletedInvitesPlayerId);
  event JoinRequestsRemovedByClan(uint256 clanId, uint256[] joinRequestPlayerIds, uint256 removingJoinRequestsPlayerId);
  event EditNameCost(uint256 newCost);
  event JoinRequestsEnabled(uint256 clanId, bool joinRequestsEnabled, uint256 playerId);
  event GateKeepNFTs(uint256 clanId, address[] nfts, uint256 playerId);
  event PinMessage(uint256 clanId, string message, uint256 playerId);
  event SetInitialMMR(uint256 mmr);
  event SetBrushDistributionPercentages(
    uint256 brushBurntPercentage,
    uint256 brushTreasuryPercentage,
    uint256 brushDevPercentage
  );
  event AddXP(uint256 clanId, uint256 xp, bool xpEmittedElsewhere);
  event SetMMR(uint256 clanId, uint256 mmr); // Only used by bridge currently

  error AlreadyInClan();
  error NotOwnerOfPlayer();
  error NotOwnerOfPlayerAndActive();
  error NotMemberOfClan();
  error ClanIsFull();
  error OwnerExists();
  error InvalidImageId();
  error NameTooShort();
  error NameTooLong();
  error NameInvalidCharacters();
  error DiscordTooLong();
  error DiscordTooShort();
  error DiscordInvalidCharacters();
  error TelegramTooLong();
  error TelegramInvalidCharacters();
  error TwitterTooLong();
  error TwitterInvalidCharacters();
  error ClanDoesNotExist();
  error TierDoesNotExist();
  error CannotDowngradeTier();
  error TierAlreadyExists();
  error NameAlreadyExists();
  error ClanDestroyFailedHasMembers();
  error PriceTooLow();
  error MemberCapacityTooLow();
  error BankCapacityTooLow();
  error ImageIdTooLow();
  error AlreadySentInvite();
  error AlreadySentJoinRequest();
  error NoJoinRequest();
  error RankMustBeLowerRenounce();
  error RankNotHighEnough();
  error CannotSetSameRank();
  error ChangingRankEqualOrHigherThanSelf();
  error ChangingRankOfPlayerHigherThanSelf();
  error ChangingRankOfPlayerEqualOrHigherThanSelf();
  error CannotRenounceToSelf();
  error InviteDoesNotExist();
  error NoInvitesToDelete();
  error NoJoinRequestsToDelete();
  error JoinRequestsDisabled();
  error TooManyNFTs();
  error InvalidNFTType();
  error NoGateKeptNFTFound();
  error NFTNotWhitelistedOnMarketplace();
  error UnsupportedNFTType();
  error MessageTooLong();
  error NotMMRSetter();
  error PercentNotTotal100();
  error PlayersAlreadySet();
  error BankFactoryAlreadySet();
  error ClanNameIsReserved(string name);
  error NotXPModifier();
  error NotBridge();

  struct Clan {
    uint64 ownerPlayerId;
    uint16 imageId;
    uint16 memberCount;
    uint40 createdTimestamp;
    uint8 tierId;
    bool disableJoinRequests;
    uint16 mmr;
    uint40 xp;
    string name;
    mapping(uint256 playerId => bool invited) inviteRequests;
    NFTInfo[] gateKeptNFTs;
  }

  struct PlayerInfo {
    uint40 clanId; // What clan they are in
    ClanRank rank; // Current clan rank
    uint40 requestedClanId; // What clan they have requested to join
  }

  struct Tier {
    uint8 id;
    uint16 maxMemberCapacity;
    uint16 maxBankCapacity;
    uint24 maxImageId;
    uint40 minimumAge; // How old the clan must be before it can be upgraded to this tier
    uint80 price;
  }

  struct NFTInfo {
    address nft;
    uint80 nftType; // e.g erc721 or erc1155
  }

  IBrushToken private _brush;
  IPlayers private _players;
  IBankFactory private _bankFactory;
  IERC1155 private _playerNFT;
  uint40 private _nextClanId;
  uint16 private _initialMMR;
  address private _treasury;
  uint80 private _editNameCost;
  address private _dev;
  uint8 private _brushBurntPercentage;
  uint8 private _brushTreasuryPercentage;
  uint8 private _brushDevPercentage;
  address private _paintswapMarketplaceWhitelist;
  IClanMemberLeftCB private _territories;
  IClanMemberLeftCB private _lockedBankVaults;
  IClanMemberLeftCB private _raids;
  mapping(uint256 clanId => Clan clan) private _clans;
  mapping(uint256 playerId => PlayerInfo) private _playerInfo;
  mapping(uint256 id => Tier tier) private _tiers;
  mapping(string name => bool exists) private _lowercaseNames;
  mapping(uint256 clanId => uint40 timestampLeft) private _ownerlessClanTimestamps; // timestamp
  mapping(address account => bool isModifier) private _xpModifiers;
  BloomFilter.Filter private _reservedClanNames; // TODO: remove 90 days after launch
  address private _bridge; // TODO: Bridge Can remove later if no longer need the bridge
  IActivityPoints private _activityPoints;

  modifier isOwnerOfPlayer(uint256 playerId) {
    require(_playerNFT.balanceOf(_msgSender(), playerId) != 0, NotOwnerOfPlayer());
    _;
  }

  modifier isOwnerOfPlayerAndActive(uint256 playerId) {
    require(_players.isOwnerOfPlayerAndActive(_msgSender(), playerId), NotOwnerOfPlayerAndActive());
    _;
  }

  modifier isMinimumRank(uint256 clanId, uint256 playerId, ClanRank rank) {
    PlayerInfo storage player = _playerInfo[playerId];
    require(player.clanId == clanId, NotMemberOfClan());
    require(_playerInfo[playerId].rank >= rank, RankNotHighEnough());
    _;
  }

  modifier isMemberOfClan(uint256 clanId, uint256 playerId) {
    require(_playerInfo[playerId].clanId == clanId, NotMemberOfClan());
    _;
  }

  modifier isXPModifier() {
    require(_xpModifiers[_msgSender()], NotXPModifier());
    _;
  }

  modifier onlyMMRSetter() {
    require(_msgSender() == address(_lockedBankVaults), NotMMRSetter());
    _;
  }

  modifier onlyBridge() {
    require(_msgSender() == _bridge, NotBridge());
    _;
  }

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

  function initialize(
    IBrushToken brush,
    IERC1155 playerNFT,
    address treasury,
    address dev,
    uint80 editNameCost,
    address paintswapMarketplaceWhitelist,
    uint16 initialMMR,
    uint40 startClanId,
    address bridge,
    IActivityPoints activityPoints
  ) external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();

    _brush = brush;
    _playerNFT = playerNFT;
    _treasury = treasury;
    _dev = dev;
    _nextClanId = startClanId;
    _paintswapMarketplaceWhitelist = paintswapMarketplaceWhitelist;
    setEditNameCost(editNameCost);
    setInitialMMR(initialMMR);
    _reservedClanNames._initialize(4, 420000);
    _bridge = bridge;
    _activityPoints = activityPoints;
  }

  // TODO: remove in prod
  function setActivityPoints(address activityPoints) external override onlyOwner {
    _activityPoints = IActivityPoints(activityPoints);
  }

  function createClan(
    uint256 playerId,
    string calldata name,
    string calldata discord,
    string calldata telegram,
    string calldata twitter,
    uint16 imageId,
    uint8 tierId
  ) external isOwnerOfPlayerAndActive(playerId) {
    require(!isMemberOfAnyClan(playerId), AlreadyInClan());

    Tier storage tier = _tiers[tierId];
    _checkTierExists(tierId);
    _checkClanImage(imageId, tier.maxImageId);

    uint256 clanId = _nextClanId++;
    Clan storage clan = _clans[clanId];
    clan.ownerPlayerId = uint64(playerId);
    clan.tierId = tierId;
    clan.imageId = imageId;
    clan.memberCount = 1;
    clan.createdTimestamp = uint40(block.timestamp);
    clan.mmr = _initialMMR;

    PlayerInfo storage player = _playerInfo[playerId];
    player.clanId = uint32(clanId);
    player.rank = ClanRank.OWNER;
    if (player.requestedClanId != 0) {
      removeJoinRequest(player.requestedClanId, playerId);
    }

    address msgSender = _msgSender();
    (string memory trimmedName, ) = _setName(clanId, name);
    _checkSocials(discord, telegram, twitter);
    string[] memory clanInfo = _createClanInfo(trimmedName, discord, telegram, twitter);
    emit ClanCreated(clanId, playerId, clanInfo, imageId, tierId, block.timestamp);
    _pay(tier.price);

    _activityPoints.rewardBlueTickets(
      ActivityType.clans_evt_clancreated,
      _bankFactory.createBank(msgSender, clanId),
      _players.isPlayerEvolved(playerId),
      1
    );
  }

  function createClanBridge(
    address from,
    uint256 playerId,
    uint256 clanId,
    string calldata name,
    string calldata discord,
    string calldata telegram,
    string calldata twitter,
    uint256 imageId,
    uint256 createdTimestamp,
    uint256 tierId,
    uint256 mmr,
    bool disableJoinRequests
  ) external onlyBridge {
    Clan storage clan = _clans[clanId];
    clan.ownerPlayerId = uint64(playerId);
    clan.tierId = uint8(tierId);
    clan.imageId = uint16(imageId);
    clan.memberCount = 1;
    clan.createdTimestamp = uint40(createdTimestamp);
    clan.mmr = uint16(mmr);

    PlayerInfo storage player = _playerInfo[playerId];
    player.clanId = uint32(clanId);
    player.rank = ClanRank.OWNER;

    // don't call _setName to avoid name reservation check
    clan.name = name;
    _lowercaseNames[EstforLibrary.toLower(name)] = true; // already trimmed

    string[] memory clanInfo = _createClanInfo(name, discord, telegram, twitter);
    emit ClanCreated(clanId, playerId, clanInfo, imageId, tierId, createdTimestamp);
    if (disableJoinRequests) {
      clan.disableJoinRequests = disableJoinRequests;
      emit JoinRequestsEnabled(clanId, !disableJoinRequests, playerId);
    }
    emit SetMMR(clanId, mmr);
    _bankFactory.createBank(from, clanId);
  }

  function editClan(
    uint256 clanId,
    string calldata name,
    string calldata discord,
    string calldata telegram,
    string calldata twitter,
    uint256 imageId,
    uint256 playerId
  ) external isOwnerOfPlayerAndActive(playerId) isMinimumRank(clanId, playerId, ClanRank.LEADER) {
    Clan storage clan = _clans[clanId];
    Tier storage tier = _tiers[clan.tierId];
    _checkClanImage(imageId, tier.maxImageId);
    (string memory trimmedName, bool nameChanged) = _setName(clanId, name);
    if (nameChanged) {
      _pay(_editNameCost);
    }

    _checkSocials(discord, telegram, twitter);
    string[] memory clanInfo = _createClanInfo(trimmedName, discord, telegram, twitter);
    emit ClanEdited(clanId, playerId, clanInfo, imageId);
  }

  function deleteInvitesAsPlayer(uint256[] calldata clanIds, uint256 playerId) external isOwnerOfPlayer(playerId) {
    require(clanIds.length != 0, NoInvitesToDelete());

    for (uint256 i = 0; i < clanIds.length; ++i) {
      uint256 clanId = clanIds[i];
      require(_clans[clanId].inviteRequests[playerId], InviteDoesNotExist());
      delete _clans[clanId].inviteRequests[playerId];
    }
    emit InvitesDeletedByPlayer(clanIds, playerId);
  }

  function deleteInvitesAsClan(
    uint256 clanId,
    uint256[] calldata invitedPlayerIds,
    uint256 playerId
  ) external isOwnerOfPlayer(playerId) isMinimumRank(clanId, playerId, ClanRank.SCOUT) {
    Clan storage clan = _clans[clanId];
    require(invitedPlayerIds.length != 0, NoInvitesToDelete());

    for (uint256 i = 0; i < invitedPlayerIds.length; ++i) {
      uint256 invitedPlayerId = invitedPlayerIds[i];
      require(clan.inviteRequests[invitedPlayerId], InviteDoesNotExist());
      clan.inviteRequests[invitedPlayerId] = false;
    }

    emit InvitesDeletedByClan(clanId, invitedPlayerIds, playerId);
  }

  function inviteMembers(
    uint256 clanId,
    uint256[] calldata memberPlayerIds,
    uint256 playerId
  ) external isOwnerOfPlayer(playerId) isMinimumRank(clanId, playerId, ClanRank.SCOUT) {
    Clan storage clan = _clans[clanId];
    Tier storage tier = _tiers[clan.tierId];
    require(clan.memberCount + memberPlayerIds.length <= tier.maxMemberCapacity, ClanIsFull());

    for (uint256 i = 0; i < memberPlayerIds.length; ++i) {
      _inviteMember(clanId, memberPlayerIds[i]);
    }
    emit InvitesSent(clanId, memberPlayerIds, playerId);
  }

  function _acceptInvite(uint256 clanId, uint256 playerId, uint256 gateKeepTokenId) private {
    Clan storage clan = _clans[clanId];

    require(clan.inviteRequests[playerId], InviteDoesNotExist());
    require(!isMemberOfAnyClan(playerId), AlreadyInClan());

    _checkGateKeeping(clanId, gateKeepTokenId);

    Tier storage tier = _tiers[clan.tierId];
    require(clan.memberCount < tier.maxMemberCapacity, ClanIsFull());

    clan.inviteRequests[playerId] = false;
    clan.memberCount++;

    PlayerInfo storage player = _playerInfo[playerId];
    player.clanId = uint32(clanId);
    player.rank = ClanRank.COMMONER;
    player.requestedClanId = 0;

    emit InviteAccepted(clanId, playerId);
  }

  function acceptInvite(
    uint256 clanId,
    uint256 playerId,
    uint256 gateKeepTokenId
  ) external isOwnerOfPlayerAndActive(playerId) {
    _acceptInvite(clanId, playerId, gateKeepTokenId);
  }

  function requestToJoin(
    uint256 clanId,
    uint256 playerId,
    uint256 gateKeepTokenId
  ) external isOwnerOfPlayerAndActive(playerId) {
    _requestToJoin(clanId, playerId, gateKeepTokenId);
  }

  function removeJoinRequest(uint256 clanId, uint256 playerId) public isOwnerOfPlayer(playerId) {
    _playerInfo[playerId].requestedClanId = 0;
    emit JoinRequestRemoved(clanId, playerId);
  }

  function removeJoinRequestsAsClan(
    uint256 clanId,
    uint256[] calldata joinRequestPlayerIds,
    uint256 playerId
  ) external isOwnerOfPlayer(playerId) isMinimumRank(clanId, playerId, ClanRank.SCOUT) {
    require(joinRequestPlayerIds.length != 0, NoJoinRequestsToDelete());

    for (uint256 i = 0; i < joinRequestPlayerIds.length; ++i) {
      uint256 joinRequestPlayerId = joinRequestPlayerIds[i];
      PlayerInfo storage playerInfo = _playerInfo[joinRequestPlayerId];
      require(playerInfo.requestedClanId == clanId, NoJoinRequest());
      playerInfo.requestedClanId = 0;
    }

    emit JoinRequestsRemovedByClan(clanId, joinRequestPlayerIds, playerId);
  }

  function acceptJoinRequests(
    uint256 clanId,
    uint256[] calldata newMemberPlayerIds,
    uint256 playerId
  ) public isOwnerOfPlayerAndActive(playerId) isMinimumRank(clanId, playerId, ClanRank.SCOUT) {
    Clan storage clan = _clans[clanId];
    Tier storage tier = _tiers[clan.tierId];
    require(clan.memberCount + newMemberPlayerIds.length <= tier.maxMemberCapacity, ClanIsFull());

    for (uint256 i = 0; i < newMemberPlayerIds.length; ++i) {
      _acceptJoinRequest(clanId, newMemberPlayerIds[i]);
    }

    emit JoinRequestsAccepted(clanId, newMemberPlayerIds, playerId);
  }

  function changeRank(
    uint256 clanId,
    uint256 memberId,
    ClanRank rank,
    uint256 playerId
  ) public isOwnerOfPlayer(playerId) isMemberOfClan(clanId, memberId) {
    ClanRank currentMemberRank = _playerInfo[memberId].rank;
    ClanRank callerRank = _playerInfo[playerId].rank;
    bool changingSelf = memberId == playerId;

    require(callerRank > rank, ChangingRankEqualOrHigherThanSelf());

    // Cannot change Rank of someone higher or equal yourself
    if (changingSelf) {
      require(callerRank >= currentMemberRank, ChangingRankOfPlayerHigherThanSelf());
    } else {
      require(callerRank > currentMemberRank, ChangingRankOfPlayerEqualOrHigherThanSelf());
    }

    require(currentMemberRank != rank, CannotSetSameRank());

    bool isDemoting = currentMemberRank > rank;
    if (isDemoting) {
      // Are they leaving?
      if (rank == ClanRank.NONE) {
        _removeFromClan(clanId, memberId, playerId);
      } else {
        // If owner is leaving their post then we need to update the owned state
        if (currentMemberRank == ClanRank.OWNER) {
          _ownerCleared(clanId);
        }
        _updateRank(clanId, memberId, rank, playerId);
      }
    } else {
      // Promoting
      _updateRank(clanId, memberId, rank, playerId);
    }
  }

  function changeRanks(
    uint256 clanId,
    uint256[] calldata memberIds,
    ClanRank[] calldata ranks,
    uint256 playerId
  ) external isOwnerOfPlayer(playerId) {
    for (uint256 i = 0; i < memberIds.length; ++i) {
      changeRank(clanId, memberIds[i], ranks[i], playerId);
    }
  }

  function renounceOwnershipTo(
    uint256 clanId,
    uint256 newOwnerPlayerId,
    ClanRank newRank
  ) external isOwnerOfPlayer(_clans[clanId].ownerPlayerId) isMemberOfClan(clanId, newOwnerPlayerId) {
    Clan storage clan = _clans[clanId];
    uint256 oldOwnerPlayerId = clan.ownerPlayerId;

    require(newOwnerPlayerId != oldOwnerPlayerId, CannotRenounceToSelf());

    if (newRank != ClanRank.NONE) {
      require(newRank < ClanRank.OWNER, RankMustBeLowerRenounce());
      // Change old owner to new rank
      _updateRank(clanId, oldOwnerPlayerId, newRank, oldOwnerPlayerId);
    } else {
      _removeFromClan(clanId, oldOwnerPlayerId, oldOwnerPlayerId);
    }
    _claimOwnership(clanId, newOwnerPlayerId);
  }

  // Can claim a clan if there is no owner
  function claimOwnership(
    uint256 clanId,
    uint256 playerId
  ) external isOwnerOfPlayer(playerId) isMemberOfClan(clanId, playerId) {
    Clan storage clan = _clans[clanId];
    require(clan.ownerPlayerId == 0, OwnerExists());

    _claimOwnership(clanId, playerId);
  }

  function setJoinRequestsEnabled(
    uint256 clanId,
    bool joinRequestsEnabled,
    uint256 playerId
  ) external isOwnerOfPlayer(playerId) isMinimumRank(clanId, playerId, ClanRank.SCOUT) {
    Clan storage clan = _clans[clanId];
    clan.disableJoinRequests = !joinRequestsEnabled;
    emit JoinRequestsEnabled(clanId, joinRequestsEnabled, playerId);
  }

  function upgradeClan(uint256 clanId, uint256 playerId, uint8 newTierId) public isOwnerOfPlayer(playerId) {
    _upgradeClan(clanId, playerId, newTierId);
  }

  function pinMessage(
    uint256 clanId,
    string calldata message,
    uint256 playerId
  ) external isOwnerOfPlayerAndActive(playerId) isMinimumRank(clanId, playerId, ClanRank.LEADER) {
    require(bytes(message).length <= 200, MessageTooLong());
    emit PinMessage(clanId, message, playerId);
  }

  function gateKeep(
    uint256 clanId,
    NFTInfo[] calldata nftInfos,
    uint256 playerId
  ) external isOwnerOfPlayerAndActive(playerId) isMinimumRank(clanId, playerId, ClanRank.LEADER) {
    require(nftInfos.length <= 5, TooManyNFTs());

    address[] memory nfts = new address[](nftInfos.length);
    IMarketplaceWhitelist paintswapMarketplaceWhitelist = IMarketplaceWhitelist(_paintswapMarketplaceWhitelist);
    for (uint256 i; i < nftInfos.length; ++i) {
      // This must be whitelisted by the PaintSwapMarketplace marketplace
      address nft = nftInfos[i].nft;
      require(paintswapMarketplaceWhitelist.isWhitelisted(nft), NFTNotWhitelistedOnMarketplace());
      // Must be a supported NFT standard
      uint256 nftType = nftInfos[i].nftType;

      // Checks supportsInterface is correct
      if (nftType == 721) {
        require(IERC721(nft).supportsInterface(type(IERC721).interfaceId), InvalidNFTType());
      } else if (nftType == 1155) {
        require(IERC1155(nft).supportsInterface(type(IERC1155).interfaceId), InvalidNFTType());
      } else {
        revert UnsupportedNFTType();
      }

      nfts[i] = nft;
    }

    _clans[clanId].gateKeptNFTs = nftInfos;
    emit GateKeepNFTs(clanId, nfts, playerId);
  }

  // The flag is for cases where XP is added in the future and not part of those events
  function addXP(uint256 clanId, uint40 xp, bool xpEmittedElsewhere) external isXPModifier {
    _clans[clanId].xp += xp;
    emit AddXP(clanId, xp, xpEmittedElsewhere);
  }

  function setMMR(uint256 clanId, uint16 mmr) external onlyMMRSetter {
    _clans[clanId].mmr = mmr;
  }

  function _checkClanImage(uint256 imageId, uint256 maxImageId) private pure {
    require(imageId != 0 && imageId <= maxImageId, InvalidImageId());
  }

  function _setName(
    uint256 clanId,
    string calldata name
  ) private returns (string memory trimmedName, bool nameChanged) {
    // Trimmed name cannot be empty
    trimmedName = EstforLibrary.trim(name);
    require(bytes(trimmedName).length >= 3, NameTooShort());
    require(bytes(trimmedName).length <= 20, NameTooLong());
    require(EstforLibrary.containsValidNameCharacters(trimmedName), NameInvalidCharacters());

    string memory trimmedAndLowercaseName = EstforLibrary.toLower(trimmedName);
    Clan storage clan = _clans[clanId];
    string memory oldName = EstforLibrary.toLower(clan.name);
    nameChanged = keccak256(abi.encodePacked(oldName)) != keccak256(abi.encodePacked(trimmedAndLowercaseName));
    if (nameChanged) {
      require(
        !_reservedClanNames._probablyContainsString(trimmedAndLowercaseName),
        ClanNameIsReserved(trimmedAndLowercaseName)
      );
      require(!_lowercaseNames[trimmedAndLowercaseName], NameAlreadyExists());
      if (bytes(oldName).length != 0) {
        delete _lowercaseNames[oldName];
      }
      _lowercaseNames[trimmedAndLowercaseName] = true;
      clan.name = trimmedName;
    }
  }

  function _checkSocials(string calldata discord, string calldata telegram, string calldata twitter) private pure {
    uint256 discordLength = bytes(discord).length;
    require(discordLength <= 25, DiscordTooLong());
    require(discordLength == 0 || discordLength >= 4, DiscordTooShort());
    require(EstforLibrary.containsBaselineSocialNameCharacters(discord), DiscordInvalidCharacters());

    uint256 telegramLength = bytes(telegram).length;
    require(telegramLength <= 25, TelegramTooLong());
    require(EstforLibrary.containsBaselineSocialNameCharacters(telegram), TelegramInvalidCharacters());

    uint256 twitterLength = bytes(twitter).length;
    require(twitterLength <= 25, TwitterTooLong());
    require(EstforLibrary.containsBaselineSocialNameCharacters(twitter), TwitterInvalidCharacters());
  }

  function _createClanInfo(
    string memory trimmedName,
    string calldata discord,
    string calldata telegram,
    string calldata twitter
  ) private pure returns (string[] memory clanInfo) {
    clanInfo = new string[](4);
    clanInfo[0] = trimmedName;
    clanInfo[1] = discord;
    clanInfo[2] = telegram;
    clanInfo[3] = twitter;
  }

  function _checkGateKeeping(uint256 clanId, uint256 gateKeepTokenId) private view {
    NFTInfo[] memory nftInfo = _clans[clanId].gateKeptNFTs;
    if (nftInfo.length != 0) {
      bool foundNFT;
      // Check the player owns one of these NFTs
      address sender = _msgSender();
      for (uint256 i = 0; i < nftInfo.length; ++i) {
        if (nftInfo[i].nftType == 1155) {
          foundNFT = foundNFT || IERC1155(nftInfo[i].nft).balanceOf(sender, gateKeepTokenId) != 0;
        } else if (nftInfo[i].nftType == 721) {
          foundNFT = foundNFT || IERC721(nftInfo[i].nft).ownerOf(gateKeepTokenId) == sender;
        }
      }

      require(foundNFT, NoGateKeptNFTFound());
    }
  }

  function _ownerCleared(uint256 clanId) private {
    Clan storage clan = _clans[clanId];
    uint256 oldOwnerPlayerId = clan.ownerPlayerId;
    clan.ownerPlayerId = 0;
    _ownerlessClanTimestamps[clanId] = uint40(block.timestamp);
    emit ClanOwnerLeft(clanId, oldOwnerPlayerId);
  }

  function _updateRank(uint256 clanId, uint256 memberId, ClanRank rank, uint256 playerId) private {
    PlayerInfo storage player = _playerInfo[memberId];
    player.rank = rank;
    emit PlayerRankUpdated(clanId, memberId, rank, playerId);
  }

  function _destroyClan(uint256 clanId) private {
    // Defensive check
    Clan storage clan = _clans[clanId];
    require(clan.memberCount == 0, ClanDestroyFailedHasMembers());
    _lowercaseNames[EstforLibrary.toLower(clan.name)] = false; // Name can be used again
    delete _clans[clanId]; // Delete the clan
    emit ClanDestroyed(clanId);
  }

  function _removeFromClan(uint256 clanId, uint256 playerId, uint256 removingPlayerId) private {
    Clan storage clan = _clans[clanId];

    if (clan.ownerPlayerId == playerId) {
      _ownerCleared(clanId);
    }

    clan.memberCount--;
    if (clan.memberCount == 0) {
      _destroyClan(clanId);
    } else {
      emit MemberLeft(clanId, playerId, removingPlayerId);
    }
    PlayerInfo storage player = _playerInfo[playerId];
    player.clanId = 0;
    player.rank = ClanRank.NONE;

    _territories.clanMemberLeft(clanId, playerId);
    _lockedBankVaults.clanMemberLeft(clanId, playerId);
    _raids.clanMemberLeft(clanId, playerId);
  }

  function _claimOwnership(uint256 clanId, uint256 playerId) private {
    Clan storage clan = _clans[clanId];
    clan.ownerPlayerId = uint64(playerId);
    delete _ownerlessClanTimestamps[clanId];
    _playerInfo[playerId].rank = ClanRank.OWNER;
    emit ClanOwnershipTransferred(clanId, playerId);
  }

  function _pay(uint256 tokenCost) private {
    IBrushToken brush = _brush;
    address sender = _msgSender();
    brush.burnFrom(sender, (tokenCost * _brushBurntPercentage) / 100);
    brush.transferFrom(sender, _treasury, (tokenCost * _brushTreasuryPercentage) / 100);
    brush.transferFrom(sender, _dev, (tokenCost * _brushDevPercentage) / 100);
  }

  function _upgradeClan(uint256 clanId, uint256 playerId, uint8 newTierId) private {
    Tier storage oldTier = _tiers[_clans[clanId].tierId];
    require(oldTier.id != 0, ClanDoesNotExist());
    require(newTierId > oldTier.id, CannotDowngradeTier());

    // require(_playerInfo[playerId].clanId == clanId, NotMemberOfClan());

    _checkTierExists(newTierId);

    Tier storage newTier = _tiers[newTierId];
    uint256 priceDifference = newTier.price - oldTier.price;
    _pay(priceDifference);

    _clans[clanId].tierId = newTierId; // Increase the tier
    emit ClanUpgraded(clanId, playerId, newTierId);
  }

  function _setTier(Tier calldata tier) private {
    uint256 tierId = tier.id;
    // TODO: Some other checks

    // Price should be higher than the one prior
    if (tierId > 1) {
      Tier memory priorTier = _tiers[tierId - 1];
      require(tier.price >= priorTier.price, PriceTooLow());
      require(tier.maxMemberCapacity >= priorTier.maxMemberCapacity, MemberCapacityTooLow());
      require(tier.maxBankCapacity >= priorTier.maxBankCapacity, BankCapacityTooLow());
      require(tier.maxImageId >= priorTier.maxImageId, ImageIdTooLow());
    }
    _tiers[tierId] = tier;
  }

  function _checkTierExists(uint256 tierId) private view {
    Tier storage tier = _tiers[tierId];
    require(tier.id != 0, TierDoesNotExist());
  }

  function _inviteMember(uint256 clanId, uint256 member) private {
    Clan storage clan = _clans[clanId];
    require(!clan.inviteRequests[member], AlreadySentInvite());

    clan.inviteRequests[member] = true;
  }

  function _requestToJoin(uint256 clanId, uint256 playerId, uint256 gateKeepTokenId) private {
    Clan storage clan = _clans[clanId];
    require(clan.createdTimestamp != 0, ClanDoesNotExist());
    require(!clan.disableJoinRequests, JoinRequestsDisabled());

    _checkGateKeeping(clanId, gateKeepTokenId);

    PlayerInfo storage player = _playerInfo[playerId];

    require(!isMemberOfAnyClan(playerId), AlreadyInClan());

    uint256 playerRequestedClanId = player.requestedClanId;
    if (playerRequestedClanId != 0) {
      require(playerRequestedClanId != clanId, AlreadySentJoinRequest());
      emit JoinRequestRemoved(playerRequestedClanId, playerId);
    }

    player.requestedClanId = uint32(clanId);

    emit JoinRequestSent(clanId, playerId);
  }

  function _acceptJoinRequest(uint256 clanId, uint256 newMemberPlayerId) private {
    Clan storage clan = _clans[clanId];
    clan.inviteRequests[newMemberPlayerId] = false;
    clan.memberCount++;

    PlayerInfo storage player = _playerInfo[newMemberPlayerId];
    require(player.requestedClanId == clanId, NoJoinRequest());
    player.clanId = uint32(clanId);
    player.requestedClanId = 0;
    player.rank = ClanRank.COMMONER;
  }

  function getClanIdFromPlayer(uint256 playerId) external view returns (uint256) {
    return _playerInfo[playerId].clanId;
  }

  function getClanNameOfPlayer(uint256 playerId) external view returns (string memory) {
    uint256 clanId = _playerInfo[playerId].clanId;
    return _clans[clanId].name;
  }

  function canWithdraw(uint256 clanId, uint256 playerId) external view override returns (bool) {
    return _playerInfo[playerId].clanId == clanId && _playerInfo[playerId].rank >= ClanRank.TREASURER;
  }

  function isClanMember(uint256 clanId, uint256 playerId) external view returns (bool) {
    return _playerInfo[playerId].clanId == clanId;
  }

  function isMemberOfAnyClan(uint256 playerId) public view returns (bool) {
    return _playerInfo[playerId].clanId != 0;
  }

  function getClanTierMembership(uint256 playerId) external view returns (uint8) {
    return _clans[_playerInfo[playerId].clanId].tierId;
  }

  function getClanId(uint256 playerId) external view returns (uint256) {
    return _playerInfo[playerId].clanId;
  }

  function getMMR(uint256 clanId) external view returns (uint16 mmr) {
    mmr = _clans[clanId].mmr;
  }

  function hasInviteRequest(uint256 clanId, uint256 playerId) external view returns (bool) {
    return _clans[clanId].inviteRequests[playerId];
  }

  function maxBankCapacity(uint256 clanId) external view override returns (uint16) {
    Tier storage tier = _tiers[_clans[clanId].tierId];
    return tier.maxBankCapacity;
  }

  function maxMemberCapacity(uint256 clanId) external view override returns (uint16) {
    Tier storage tier = _tiers[_clans[clanId].tierId];
    return tier.maxMemberCapacity;
  }

  function getRank(uint256 clanId, uint256 playerId) external view returns (ClanRank rank) {
    if (_playerInfo[playerId].clanId == clanId) {
      return _playerInfo[playerId].rank;
    }
    return ClanRank.NONE;
  }

  function getEditNameCost() external view returns (uint80) {
    return _editNameCost;
  }

  function getPlayerInfo(uint256 playerId) external view returns (PlayerInfo memory) {
    return _playerInfo[playerId];
  }

  function getLowercaseNames(string calldata name) external view returns (bool) {
    return _lowercaseNames[name];
  }

  function getTier(uint256 tierId) external view returns (Tier memory) {
    return _tiers[tierId];
  }

  function getClan(
    uint256 clanId
  )
    external
    view
    returns (
      uint64 ownerPlayerId,
      uint16 imageId,
      uint16 memberCount,
      uint40 createdTimestamp,
      uint8 tierId,
      bool disableJoinRequests,
      uint16 mmr,
      string memory name,
      NFTInfo[] memory gateKeptNFTs
    )
  {
    Clan storage clan = _clans[clanId];
    return (
      clan.ownerPlayerId,
      clan.imageId,
      clan.memberCount,
      clan.createdTimestamp,
      clan.tierId,
      clan.disableJoinRequests,
      clan.mmr,
      clan.name,
      clan.gateKeptNFTs
    );
  }

  /// @dev used by Territories to get Clan Bank for Activity Points
  function getClanBankAddress(uint256 clanId) external view override returns (address bankAddress) {
    return _bankFactory.getBankAddress(clanId);
  }

  /// @dev used to check bloom filter for reserved names from Fantom
  function isClanNameReserved(string calldata clanName) public view returns (bool) {
    return _reservedClanNames._probablyContainsString(EstforLibrary.toLower(clanName));
  }

  function addTiers(Tier[] calldata tiers) external onlyOwner {
    for (uint256 i; i < tiers.length; ++i) {
      require(tiers[i].id != 0 && _tiers[tiers[i].id].id == 0, TierAlreadyExists());
      _setTier(tiers[i]);
    }
    emit AddTiers(tiers);
  }

  function editTiers(Tier[] calldata tiers) external onlyOwner {
    for (uint256 i; i < tiers.length; ++i) {
      _checkTierExists(tiers[i].id);
      _setTier(tiers[i]);
    }
    emit EditTiers(tiers);
  }

  function initializeAddresses(
    IPlayers players,
    IBankFactory bankFactory,
    IClanMemberLeftCB territories,
    IClanMemberLeftCB lockedBankVaults,
    IClanMemberLeftCB raids
  ) external onlyOwner {
    require(address(_bankFactory) == address(0) || _bankFactory == bankFactory, BankFactoryAlreadySet());

    _players = players;
    _bankFactory = bankFactory;
    _territories = territories;
    _lockedBankVaults = lockedBankVaults;
    _raids = raids;
  }

  function setXPModifiers(address[] calldata accounts, bool isModifier) external onlyOwner {
    for (uint256 i; i < accounts.length; ++i) {
      _xpModifiers[accounts[i]] = isModifier;
    }
  }

  function setEditNameCost(uint80 editNameCost) public onlyOwner {
    _editNameCost = editNameCost;
    emit EditNameCost(editNameCost);
  }

  function setInitialMMR(uint16 mmr) public onlyOwner {
    _initialMMR = mmr;
    emit SetInitialMMR(mmr);
  }

  function setBrushDistributionPercentages(
    uint8 brushBurntPercentage,
    uint8 brushTreasuryPercentage,
    uint8 brushDevPercentage
  ) external onlyOwner {
    require(brushBurntPercentage + brushTreasuryPercentage + brushDevPercentage == 100, PercentNotTotal100());

    _brushBurntPercentage = brushBurntPercentage;
    _brushTreasuryPercentage = brushTreasuryPercentage;
    _brushDevPercentage = brushDevPercentage;
    emit SetBrushDistributionPercentages(brushBurntPercentage, brushTreasuryPercentage, brushDevPercentage);
  }

  function setReservedNameBits(uint256[] calldata positions) external onlyOwner {
    _reservedClanNames._addPositions(positions);
  }

  function addReservedClanNames(string[] calldata names) external onlyOwner {
    for (uint256 i = 0; i < names.length; ++i) {
      _reservedClanNames._addString(EstforLibrary.toLower(names[i]));
    }
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

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

import {IClans} from "../interfaces/IClans.sol";
import {IPlayers} from "../interfaces/IPlayers.sol";
import {IBrushToken} from "../interfaces/external/IBrushToken.sol";
import {IBank} from "../interfaces/IBank.sol";
import {ITerritories} from "../interfaces/ITerritories.sol";
import {ILockedBankVaults} from "../interfaces/ILockedBankVaults.sol";
import {IBankFactory} from "../interfaces/IBankFactory.sol";
import {IClanMemberLeftCB} from "../interfaces/IClanMemberLeftCB.sol";
import {ISamWitchVRF} from "../interfaces/ISamWitchVRF.sol";

import {AdminAccess} from "../AdminAccess.sol";
import {ItemNFT} from "../ItemNFT.sol";
import {VRFRequestInfo} from "../VRFRequestInfo.sol";

import {BattleResultEnum, ClanRank, CLAN_WARS_GAS_PRICE_WINDOW_SIZE, VaultClanInfo, Vault, ClanBattleInfo, XP_EMITTED_ELSEWHERE} from "../globals/clans.sol";
import {Item, EquipPosition} from "../globals/players.sol";
import {BoostType, Skill} from "../globals/misc.sol";
import {NONE} from "../globals/items.sol";

import {ClanBattleLibrary} from "./ClanBattleLibrary.sol";
import {EstforLibrary} from "../EstforLibrary.sol";
import {LockedBankVaultsLibrary} from "./LockedBankVaultsLibrary.sol";
import {BankRelay} from "./BankRelay.sol";

import {IActivityPoints, IActivityPointsCaller, ActivityType} from "../ActivityPoints/interfaces/IActivityPoints.sol";

contract LockedBankVaults is
  UUPSUpgradeable,
  OwnableUpgradeable,
  ILockedBankVaults,
  IClanMemberLeftCB,
  IActivityPointsCaller
{
  event AttackVaults(
    uint256 clanId,
    uint256 defendingClanId,
    address from,
    uint256 leaderPlayerId,
    uint256 requestId,
    uint256 pendingAttackId,
    uint256 attackingCooldownTimestamp,
    uint256 reattackingCooldownTimestamp,
    uint256 itemTokenId
  );
  event SetComparableSkills(Skill[] skills);
  event BattleResult(
    uint256 requestId,
    uint64[] attackingPlayerIds,
    uint64[] defendingPlayerIds,
    uint256[] attackingRolls,
    uint256[] defendingRolls,
    uint8[] battleResults, // BattleResultEnum
    uint8[] randomSkills, // Skill
    bool didAttackersWin,
    uint256 attackingClanId,
    uint256 defendingClanId,
    uint256[] randomWords,
    uint256 percentageToTake,
    uint256 brushLost,
    int256 attackingMMRDiff,
    int256 defendingMMRDiff,
    uint256 clanXPGainedWinner
  );

  event AssignCombatants(
    uint256 clanId,
    uint64[] playerIds,
    address from,
    uint256 leaderPlayerId,
    uint256 cooldownTimestamp
  );
  event RemoveCombatant(uint256 playerId, uint256 clanId);
  event ClaimFunds(uint256 clanId, address from, uint256 playerId, uint256 amount, uint256 numLocksClaimed);
  event LockFunds(uint256 clanId, address from, uint256 playerId, uint256 amount, uint256 lockingTimestamp);
  event SetExpectedGasLimitFulfill(uint256 expectedGasLimitFulfill);
  event SetMaxLockedVaults(uint256 maxLockedVaults);
  event SetMaxClanCombatants(uint256 maxClanCombatants);
  event BlockingAttacks(
    uint256 clanId,
    uint256 itemTokenId,
    address from,
    uint256 leaderPlayerId,
    uint256 blockAttacksTimestamp,
    uint256 blockAttacksCooldownTimestamp
  );
  event SuperAttackCooldown(uint256 clanId, uint256 cooldownTimestamp);
  event SetMMRAttackDistance(uint256 mmrAttackDistance);
  event ForceMMRUpdate(uint256[] clanIdsToDelete);
  event SetMMRs(uint256[] clanIds, uint16[] mmrs);
  event SetKValues(uint256 Ka, uint256 Kd);
  event SetBrushDistributionPercentages(
    uint256 brushBurntPercentage,
    uint256 brushTreasuryPercentage,
    uint256 brushDevPercentage
  );
  event SetPreventAttacks(bool preventAttacks);

  error PlayerOnTerritory();
  error TooManyCombatants();
  error NotOwnerOfPlayerAndActive();
  error RankNotHighEnough();
  error InvalidSkill(Skill skill);
  error NotMemberOfClan();
  error LengthMismatch();
  error OnlyClans();
  error OnlyTerritories();
  error OnlyCombatantsHelper();
  error TransferFailed();
  error CannotChangeCombatantsDuringAttack();
  error NotAdminAndBeta();
  error InsufficientCost();
  error RequestIdNotKnown();
  error CallerNotSamWitchVRF();
  error AttacksPrevented();
  error PercentNotTotal100();

  struct PendingAttack {
    uint40 clanId;
    uint40 defendingClanId;
    bool attackInProgress;
    uint8 extraRollsAttacker;
    uint8 extraRollsDefender;
  }

  uint256 private constant NUM_WORDS = 7;
  uint256 private constant NUM_PACKED_VAULTS = 2;
  uint40 private constant CLAN_XP_GAINED_WIN = 10;

  Skill[] private _comparableSkills;
  uint64 private _nextPendingAttackId;
  bool private _preventAttacks;
  mapping(uint256 clanId => VaultClanInfo clanInfo) private _clanInfos;
  mapping(uint256 pendingAttackId => PendingAttack pendingAttack) private _pendingAttacks;
  mapping(bytes32 requestId => uint256 pendingAttackId) private _requestToPendingAttackIds;
  mapping(uint256 clanId => mapping(uint256 otherClanId => ClanBattleInfo battleInfo)) private _lastClanBattles; // Always ordered from lowest clanId to highest
  IClans private _clans;
  IPlayers private _players;
  IBrushToken private _brush;
  ITerritories private _territories;
  ItemNFT private _itemNFT;
  AdminAccess private _adminAccess;
  bool private _isBeta;
  IBankFactory private _bankFactory;
  BankRelay private _bankRelay;
  address private _combatantsHelper;
  uint24 private _combatantChangeCooldown;
  uint8 private _maxClanCombatants;
  address private _treasury;
  address private _dev;
  uint8 private _brushBurntPercentage;
  uint8 private _brushTreasuryPercentage;
  uint8 private _brushDevPercentage;

  VRFRequestInfo _vrfRequestInfo;
  address private _oracle;
  uint16 private _mmrAttackDistance;
  uint24 private _expectedGasLimitFulfill;
  uint24 private _attackingCooldown;
  uint24 private _reattackingCooldown;
  uint8 private _maxLockedVaults;
  ISamWitchVRF private _samWitchVRF;
  uint8 private _kA; // attacker K-factor
  uint8 private _kD; // defender K-factor
  uint24 private _lockFundsPeriod;
  // Clans are sorted as follows:
  // 1 - From lower MMR to higher MMR
  // 2 - If there are multiple clans with the same MMR, they are sorted by:
  //   2.1 - Whoever was there first gets a higher rank (higher index)
  //   2.2 - The attacker is always ranked higher than the defender whether they win or lose as they are placed in the array first
  uint48[] private _sortedClansByMMR; // Packed uint32 clanId | uint16 MMR
  IActivityPoints private _activityPoints;

  modifier isOwnerOfPlayerAndActive(uint256 playerId) {
    require(_players.isOwnerOfPlayerAndActive(_msgSender(), playerId), NotOwnerOfPlayerAndActive());
    _;
  }

  modifier isMinimumRank(uint256 clanId, uint256 playerId, ClanRank clanRank) {
    require(_clans.getRank(clanId, playerId) >= clanRank, RankNotHighEnough());
    _;
  }

  modifier isClanMember(uint256 clanId, uint256 playerId) {
    require(_clans.getRank(clanId, playerId) != ClanRank.NONE, NotMemberOfClan());
    _;
  }

  modifier onlyClans() {
    require(_msgSender() == address(_clans), OnlyClans());
    _;
  }

  modifier onlyTerritories() {
    require(_msgSender() == address(_territories), OnlyTerritories());
    _;
  }

  modifier isAdminAndBeta() {
    require(_adminAccess.isAdmin(_msgSender()) && _isBeta, NotAdminAndBeta());
    _;
  }

  modifier onlyCombatantsHelper() {
    require(_msgSender() == _combatantsHelper, OnlyCombatantsHelper());
    _;
  }

  /// @dev Reverts if the caller is not the SamWitchVRF contract.
  modifier onlySamWitchVRF() {
    require(_msgSender() == address(_samWitchVRF), CallerNotSamWitchVRF());
    _;
  }

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

  function initialize(
    IPlayers players,
    IClans clans,
    IBrushToken brush,
    address bankRelay,
    ItemNFT itemNFT,
    address treasury,
    address dev,
    address oracle,
    ISamWitchVRF samWitchVRF,
    VRFRequestInfo vrfRequestInfo,
    Skill[] calldata comparableSkills,
    uint16 mmrAttackDistance,
    uint24 lockFundsPeriod,
    uint8 maxClanCombatants,
    uint8 maxLockedVaults,
    AdminAccess adminAccess,
    IActivityPoints activityPoints,
    bool isBeta
  ) external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();

    _players = players;
    _clans = clans;
    _brush = brush;
    _bankRelay = BankRelay(bankRelay);
    _itemNFT = itemNFT;
    _treasury = treasury;
    _dev = dev;
    _oracle = oracle;
    _samWitchVRF = samWitchVRF;
    _lockFundsPeriod = lockFundsPeriod;
    _adminAccess = adminAccess;
    _isBeta = isBeta;
    _attackingCooldown = isBeta ? 1 minutes + 30 seconds : 4 hours;
    _reattackingCooldown = isBeta ? 6 minutes : 1 days;
    _vrfRequestInfo = vrfRequestInfo;
    _combatantChangeCooldown = isBeta ? 5 minutes : 3 days;

    _activityPoints = activityPoints;

    setExpectedGasLimitFulfill(3_500_000);
    setKValues(32, 32);
    setMaxClanCombatants(maxClanCombatants);
    setComparableSkills(comparableSkills);
    setMMRAttackDistance(mmrAttackDistance);
    setMaxLockedVaults(maxLockedVaults);
    _nextPendingAttackId = 1;
  }

  // TODO: remove in prod
  function setActivityPoints(address activityPoints) external override onlyOwner {
    _activityPoints = IActivityPoints(activityPoints);
  }

  function assignCombatants(
    uint256 clanId,
    uint64[] calldata playerIds,
    uint256 combatantCooldownTimestamp,
    uint256 leaderPlayerId
  ) external override onlyCombatantsHelper {
    VaultClanInfo storage clanInfo = _clanInfos[clanId];
    LockedBankVaultsLibrary.checkCanAssignCombatants(clanInfo, playerIds, _maxClanCombatants);
    clanInfo.playerIds = playerIds;
    clanInfo.assignCombatantsCooldownTimestamp = uint40(block.timestamp + _combatantChangeCooldown);
    emit AssignCombatants(clanId, playerIds, _msgSender(), leaderPlayerId, combatantCooldownTimestamp);
  }

  // Some vaults may no longer be attackable if they don't have any funds, so force the MMR arrays to be re-calculated.
  function forceMMRUpdate(uint256[] calldata clanIds) external {
    uint256[] memory clanIdsToDelete = LockedBankVaultsLibrary.forceMMRUpdate(
      _sortedClansByMMR,
      _clans,
      _clanInfos,
      clanIds
    );
    if (clanIdsToDelete.length != 0) {
      emit ForceMMRUpdate(clanIdsToDelete);
    }
  }

  function getIdleClans() external view returns (uint256[] memory clanIds) {
    return LockedBankVaultsLibrary.getIdleClans(_sortedClansByMMR, _clanInfos, _clans);
  }

  // This needs to call the oracle VRF on-demand and calls the callback
  function attackVaults(
    uint256 clanId,
    uint256 defendingClanId,
    uint16 itemTokenId,
    uint256 leaderPlayerId
  ) external payable isOwnerOfPlayerAndActive(leaderPlayerId) isMinimumRank(clanId, leaderPlayerId, ClanRank.COLONEL) {
    require(!_preventAttacks, AttacksPrevented());
    // Check they are paying enough
    require(msg.value >= getAttackCost(), InsufficientCost());

    (bool success, ) = _oracle.call{value: msg.value}("");
    require(success, TransferFailed());

    (bool isReattacking, bool isUsingSuperAttack, uint256 superAttackCooldownTimestamp) = LockedBankVaultsLibrary
      .checkCanAttackVaults(
        clanId,
        defendingClanId,
        itemTokenId,
        _maxLockedVaults,
        NUM_PACKED_VAULTS,
        _itemNFT,
        _clanInfos,
        _lastClanBattles
      );
    if ((isReattacking || isUsingSuperAttack) && itemTokenId != NONE) {
      _itemNFT.burn(_msgSender(), itemTokenId, 1);
    }

    // Check MMRs are within the list, X ranks above and below. However at the extremes add it to the other end
    LockedBankVaultsLibrary.checkWithinRange(_sortedClansByMMR, clanId, defendingClanId, _clans, _mmrAttackDistance);

    VaultClanInfo storage clanInfo = _clanInfos[clanId];
    clanInfo.currentlyAttacking = true;

    uint64 nextPendingAttackId = _nextPendingAttackId++;

    uint40 attackingCooldownTimestamp = uint40(block.timestamp + _attackingCooldown);
    clanInfo.attackingCooldownTimestamp = attackingCooldownTimestamp;
    if (isUsingSuperAttack) {
      clanInfo.superAttackCooldownTimestamp = uint40(superAttackCooldownTimestamp);
    }

    // Don't change the attacking timestamp if re-attacking
    uint40 reattackingCooldownTimestamp = uint40(block.timestamp + _reattackingCooldown);
    uint256 lowerClanId = clanId < defendingClanId ? clanId : defendingClanId;
    uint256 higherClanId = clanId < defendingClanId ? defendingClanId : clanId;
    ClanBattleInfo storage battleInfo = _lastClanBattles[lowerClanId][higherClanId];
    if (lowerClanId == clanId) {
      if (isReattacking) {
        reattackingCooldownTimestamp = battleInfo.lastClanIdAttackOtherClanIdCooldownTimestamp;
        ++battleInfo.numReattacks;
      } else {
        battleInfo.lastClanIdAttackOtherClanIdCooldownTimestamp = reattackingCooldownTimestamp;
        battleInfo.numReattacks = 0;
      }
    } else {
      if (isReattacking) {
        reattackingCooldownTimestamp = battleInfo.lastOtherClanIdAttackClanIdCooldownTimestamp;
        ++battleInfo.numReattacksOtherClan;
      } else {
        battleInfo.lastOtherClanIdAttackClanIdCooldownTimestamp = reattackingCooldownTimestamp;
        battleInfo.numReattacksOtherClan = 0;
      }
    }

    _pendingAttacks[nextPendingAttackId] = PendingAttack({
      clanId: uint40(clanId),
      defendingClanId: uint40(defendingClanId),
      attackInProgress: true,
      extraRollsAttacker: isUsingSuperAttack ? 1 : 0,
      extraRollsDefender: 0
    });
    bytes32 requestId = _requestRandomWords();
    _requestToPendingAttackIds[requestId] = nextPendingAttackId;

    emit AttackVaults(
      clanId,
      defendingClanId,
      _msgSender(),
      leaderPlayerId,
      uint256(requestId),
      nextPendingAttackId,
      attackingCooldownTimestamp,
      reattackingCooldownTimestamp,
      itemTokenId
    );

    // issue activity points
    _activityPoints.rewardBlueTickets(
      ActivityType.lockedbankvaults_evt_attackvaults,
      _bankFactory.getBankAddress(clanId),
      true,
      1
    );

    if (isUsingSuperAttack) {
      emit SuperAttackCooldown(clanId, superAttackCooldownTimestamp);
    }
  }

  /// @notice Called by the SamWitchVRF oracle contract to fulfill the request
  function fulfillRandomWords(bytes32 requestId, uint256[] calldata randomWords) external onlySamWitchVRF {
    require(randomWords.length == NUM_WORDS, LengthMismatch());

    PendingAttack storage pendingAttack = _pendingAttacks[_requestToPendingAttackIds[requestId]];
    require(pendingAttack.attackInProgress, RequestIdNotKnown());

    (uint40 attackingClanId, uint256 defendingClanId) = (pendingAttack.clanId, pendingAttack.defendingClanId);
    uint64[] memory attackingPlayerIds = _clanInfos[attackingClanId].playerIds;
    uint64[] memory defendingPlayerIds = _clanInfos[defendingClanId].playerIds;

    uint8[] memory randomSkills = new uint8[](Math.max(attackingPlayerIds.length, defendingPlayerIds.length));
    for (uint256 i; i < randomSkills.length; ++i) {
      randomSkills[i] = uint8(
        _comparableSkills[uint8(randomWords[NUM_WORDS - 1] >> (i * 8)) % _comparableSkills.length]
      );
    }

    (
      uint8[] memory battleResults,
      uint256[] memory attackingRolls,
      uint256[] memory defendingRolls,
      bool didAttackersWin,
      uint64[] memory shuffledPlayerIdsA,
      uint64[] memory shuffledPlayerPlayerIdsB
    ) = ClanBattleLibrary.determineBattleOutcome(
        address(_players),
        attackingPlayerIds,
        defendingPlayerIds,
        randomSkills,
        randomWords,
        pendingAttack.extraRollsAttacker,
        pendingAttack.extraRollsDefender
      );

    attackingPlayerIds = shuffledPlayerIdsA;
    defendingPlayerIds = shuffledPlayerPlayerIdsB;

    pendingAttack.attackInProgress = false;
    _clanInfos[attackingClanId].currentlyAttacking = false;

    uint256 losingClanId = didAttackersWin ? defendingClanId : attackingClanId;
    uint256 percentageToTake = didAttackersWin ? 10 : 5;

    // Go through all the defendingVaults of who ever lost and take a percentage from them
    uint256 totalWon;
    uint256 vaultOffset = _clanInfos[losingClanId].defendingVaultsOffset;
    uint256 length = _clanInfos[losingClanId].defendingVaults.length;
    for (uint256 i = vaultOffset; i < length; ++i) {
      Vault storage losersVault = _clanInfos[losingClanId].defendingVaults[i];
      totalWon += _stealFromVault(losersVault, losingClanId, percentageToTake);
    }

    _vrfRequestInfo.updateAverageGasPrice();

    (int256 attackingMMRDiff, int256 defendingMMRDiff) = LockedBankVaultsLibrary.fulfillUpdateMMR(
      _kA,
      _kD,
      _sortedClansByMMR,
      _clans,
      attackingClanId,
      defendingClanId,
      didAttackersWin,
      _clanInfos
    );

    uint256 brushLost;
    if (!didAttackersWin && totalWon != 0) {
      // Lost so take a percentage from the loser's vaults and distribute it
      uint256 amountToTreasure = (totalWon * _brushTreasuryPercentage) / 100;
      uint256 amountToDao = (totalWon * _brushDevPercentage) / 100;
      uint256 brushBurnt = (totalWon * _brushBurntPercentage) / 100;

      _brush.transfer(_treasury, amountToTreasure);
      _brush.transfer(_dev, amountToDao);
      _brush.burn(brushBurnt);

      brushLost = totalWon;
    }

    uint40 clanXPGainedWinner = didAttackersWin ? CLAN_XP_GAINED_WIN : 0;

    emit BattleResult(
      uint256(requestId),
      attackingPlayerIds,
      defendingPlayerIds,
      attackingRolls,
      defendingRolls,
      battleResults,
      randomSkills,
      didAttackersWin,
      attackingClanId,
      defendingClanId,
      randomWords,
      percentageToTake,
      brushLost,
      attackingMMRDiff,
      defendingMMRDiff,
      clanXPGainedWinner
    );

    if (didAttackersWin) {
      _clans.addXP(attackingClanId, clanXPGainedWinner, XP_EMITTED_ELSEWHERE);
      _lockFunds(attackingClanId, address(0), 0, totalWon);
    }
  }

  function claimFunds(uint256 clanId, uint256 playerId) external isOwnerOfPlayerAndActive(playerId) {
    VaultClanInfo storage clanInfo = _clanInfos[clanId];

    address bankAddress = address(_clanInfos[clanId].bank);
    if (bankAddress == address(0)) {
      bankAddress = _bankFactory.getBankAddress(clanId);
      _brush.approve(bankAddress, type(uint256).max);
      clanInfo.bank = IBank(bankAddress);
    }

    (uint256 total, uint256 numLocksClaimed) = LockedBankVaultsLibrary.claimFunds(_sortedClansByMMR, clanInfo, clanId);
    address sender = _msgSender();
    emit ClaimFunds(clanId, sender, playerId, total, numLocksClaimed);
    _bankRelay.depositTokenForAtBank(payable(address(clanInfo.bank)), sender, playerId, address(_brush), total);
  }

  function blockAttacks(
    uint256 clanId,
    uint16 itemTokenId,
    uint256 playerId
  ) external isOwnerOfPlayerAndActive(playerId) isClanMember(clanId, playerId) {
    uint256 blockAttacksTimestamp = LockedBankVaultsLibrary.blockAttacks(_itemNFT, itemTokenId, _clanInfos[clanId]);
    // TODO: Add blockAttacksCooldownHours to a BlockingAttacks
    emit BlockingAttacks(clanId, itemTokenId, _msgSender(), playerId, blockAttacksTimestamp, block.timestamp);
  }

  function lockFunds(uint256 clanId, address from, uint256 playerId, uint256 amount) external onlyTerritories {
    _lockFunds(clanId, from, playerId, amount);
    VaultClanInfo storage clanInfo = _clanInfos[clanId];
    if (!clanInfo.isInMMRArray) {
      LockedBankVaultsLibrary.insertMMRArray(_sortedClansByMMR, _clans.getMMR(clanId), uint32(clanId));
      clanInfo.isInMMRArray = true;
    }
    require(amount == 0 || _brush.transferFrom(_msgSender(), address(this), amount), TransferFailed());
  }

  function clanMemberLeft(uint256 clanId, uint256 playerId) external override onlyClans {
    // Remove a player combatant if they are currently assigned in this clan
    VaultClanInfo storage clanInfo = _clanInfos[clanId];
    if (clanInfo.playerIds.length != 0) {
      uint256 searchIndex = EstforLibrary.binarySearch(clanInfo.playerIds, playerId);
      if (searchIndex != type(uint256).max) {
        // Shift the whole array to delete the element
        for (uint256 i = searchIndex; i < clanInfo.playerIds.length - 1; ++i) {
          clanInfo.playerIds[i] = clanInfo.playerIds[i + 1];
        }
        clanInfo.playerIds.pop();
        emit RemoveCombatant(playerId, clanId);
      }
    }
  }

  function _stealFromVault(
    Vault storage losersVault,
    uint256 clanId,
    uint256 percentageToTake
  ) private returns (uint256 amountWon) {
    if (losersVault.timestamp > block.timestamp) {
      uint256 amount = losersVault.amount;
      uint256 stealAmount = (amount * percentageToTake) / 100;
      losersVault.amount = uint80(amount - stealAmount);
      _clanInfos[clanId].totalBrushLocked -= uint96(stealAmount);
      amountWon += stealAmount;
    }

    if (losersVault.timestamp1 > block.timestamp) {
      uint256 amount1 = losersVault.amount1;
      uint256 stealAmount1 = (amount1 * percentageToTake) / 100;
      losersVault.amount1 = uint80(amount1 - stealAmount1);
      _clanInfos[clanId].totalBrushLocked -= uint96(stealAmount1);
      amountWon += stealAmount1;
    }
  }

  function _lockFunds(uint256 clanId, address from, uint256 playerId, uint256 amount) private {
    if (amount == 0) {
      return;
    }
    VaultClanInfo storage clanInfo = _clanInfos[clanId];
    uint256 totalBrushLocked = clanInfo.totalBrushLocked;
    clanInfo.totalBrushLocked = uint96(totalBrushLocked + amount);
    uint40 lockingTimestamp = uint40(block.timestamp + _lockFundsPeriod);
    uint256 length = clanInfo.defendingVaults.length;
    if (length == 0 || (clanInfo.defendingVaults[length - 1].timestamp1 != 0)) {
      // Start a new one
      clanInfo.defendingVaults.push(
        Vault({claimed: false, timestamp: lockingTimestamp, amount: uint80(amount), timestamp1: 0, amount1: 0})
      );
    } else {
      // Update existing storage slot
      clanInfo.defendingVaults[length - 1].timestamp1 = lockingTimestamp;
      clanInfo.defendingVaults[length - 1].amount1 = uint80(amount);
    }

    emit LockFunds(clanId, from, playerId, amount, lockingTimestamp);
  }

  function _requestRandomWords() private returns (bytes32 requestId) {
    requestId = _samWitchVRF.requestRandomWords(NUM_WORDS, _expectedGasLimitFulfill);
  }

  function getAttackCost() public view returns (uint256) {
    (uint64 movingAverageGasPrice, uint88 baseRequestCost) = _vrfRequestInfo.get();
    return baseRequestCost + (movingAverageGasPrice * _expectedGasLimitFulfill);
  }

  function getClanInfo(uint256 clanId) external view returns (VaultClanInfo memory) {
    return _clanInfos[clanId];
  }

  function isCombatant(uint256 clanId, uint256 playerId) external view override returns (bool) {
    uint64[] storage playerIds = _clanInfos[clanId].playerIds;
    if (playerIds.length == 0) {
      return false;
    }

    uint256 searchIndex = EstforLibrary.binarySearch(playerIds, playerId);
    return searchIndex != type(uint256).max;
  }

  function getSortedClanIdsByMMR() external view returns (uint32[] memory) {
    return LockedBankVaultsLibrary.getSortedClanIdsByMMR(_sortedClansByMMR);
  }

  function getSortedMMR() external view returns (uint16[] memory) {
    return LockedBankVaultsLibrary.getSortedMMR(_sortedClansByMMR);
  }

  function getLastClanBattles(uint256 clanId, uint256 otherClanId) external view returns (ClanBattleInfo memory) {
    return _lastClanBattles[clanId][otherClanId];
  }

  function setComparableSkills(Skill[] calldata skills) public onlyOwner {
    for (uint256 i = 0; i < skills.length; ++i) {
      require(skills[i] != Skill.NONE && skills[i] != Skill.COMBAT, InvalidSkill(skills[i]));

      _comparableSkills.push(skills[i]);
    }
    emit SetComparableSkills(skills);
  }

  function setKValues(uint8 kA, uint8 kD) public onlyOwner {
    _kA = kA;
    _kD = kD;
    emit SetKValues(kA, kD);
  }

  function setMMRAttackDistance(uint16 mmrAttackDistance) public onlyOwner {
    _mmrAttackDistance = mmrAttackDistance;
    emit SetMMRAttackDistance(mmrAttackDistance);
  }

  function setMaxLockedVaults(uint8 maxLockedVaults) public onlyOwner {
    _maxLockedVaults = maxLockedVaults;
    emit SetMaxLockedVaults(maxLockedVaults);
  }

  function setExpectedGasLimitFulfill(uint24 expectedGasLimitFulfill) public onlyOwner {
    _expectedGasLimitFulfill = expectedGasLimitFulfill;
    emit SetExpectedGasLimitFulfill(expectedGasLimitFulfill);
  }

  function setBrushDistributionPercentages(
    uint8 brushBurntPercentage,
    uint8 brushTreasuryPercentage,
    uint8 brushDevPercentage
  ) external onlyOwner {
    require(brushBurntPercentage + brushTreasuryPercentage + brushDevPercentage == 100, PercentNotTotal100());

    _brushBurntPercentage = brushBurntPercentage;
    _brushTreasuryPercentage = brushTreasuryPercentage;
    _brushDevPercentage = brushDevPercentage;
    emit SetBrushDistributionPercentages(brushBurntPercentage, brushTreasuryPercentage, brushDevPercentage);
  }

  function setMaxClanCombatants(uint8 maxClanCombatants) public onlyOwner {
    _maxClanCombatants = maxClanCombatants;
    emit SetMaxClanCombatants(maxClanCombatants);
  }

  // TODO: Can delete if necessary
  function setPreventAttacks(bool preventAttacks) external onlyOwner {
    _preventAttacks = preventAttacks;
    emit SetPreventAttacks(preventAttacks);
  }

  // TODO Can delete after setting initial MMR
  function initializeMMR(uint256[] calldata clanIds, uint16[] calldata mmrs, bool clear) external onlyOwner {
    // First clean up any in it
    if (clear) {
      delete _sortedClansByMMR;
    }
    LockedBankVaultsLibrary.initializeMMR(_sortedClansByMMR, _clans, _clanInfos, clanIds, mmrs);
    emit SetMMRs(clanIds, mmrs);
  }

  function initializeAddresses(
    ITerritories territories,
    address combatantsHelper,
    IBankFactory bankFactory
  ) external onlyOwner {
    _territories = territories;
    _combatantsHelper = combatantsHelper;
    _bankFactory = bankFactory;
  }

  function clearCooldowns(uint256 clanId, uint256[] calldata otherClanIds) external isAdminAndBeta {
    LockedBankVaultsLibrary.clearCooldowns(clanId, otherClanIds, _clanInfos[clanId], _lastClanBattles);
  }

  // Useful to re-run a battle for testing
  function setAttackInProgress(uint256 requestId) external isAdminAndBeta {
    _pendingAttacks[_requestToPendingAttackIds[bytes32(requestId)]].attackInProgress = true;
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";

import {VaultClanInfo, ClanBattleInfo, Vault} from "../globals/clans.sol";
import {Item, EquipPosition, BoostType} from "../globals/players.sol";
import {IItemNFT} from "../interfaces/IItemNFT.sol";
import {IClans} from "../interfaces/IClans.sol";

library LockedBankVaultsLibrary {
  error LengthMismatch();
  error CannotChangeCombatantsDuringAttack();
  error TooManyCombatants();
  error ClanCombatantsChangeCooldown();
  error NoCombatants();
  error CannotAttackSelf();
  error NoBrushToAttack();
  error ClanIsBlockingAttacks();
  error ClanAttackingCooldown();
  error CannotAttackWhileStillAttacking();
  error MaxLockedVaultsReached();
  error NotALockedVaultAttackItem();
  error SpecifyingItemWhenNotReattackingOrSuperAttacking();
  error ClanSuperAttackingCooldown();
  error ClanAttackingSameClanCooldown();
  error CannotReattackAndSuperAttackSameTime();
  error OutsideMMRRange();
  error NothingToClaim();
  error NotALockedVaultDefenceItem();
  error BlockAttacksCooldown();
  error ClanDoesntExist(uint256 clanId);

  function initializeMMR(
    uint48[] storage sortedClansByMMR,
    IClans clans,
    mapping(uint256 clanId => VaultClanInfo clanInfo) storage clanInfos,
    uint256[] calldata clanIds,
    uint16[] calldata mmrs
  ) external {
    require(clanIds.length == mmrs.length, LengthMismatch());

    for (uint256 i = 0; i < clanIds.length; ++i) {
      clans.setMMR(clanIds[i], mmrs[i]);
      _insertMMRArray(sortedClansByMMR, mmrs[i], uint32(clanIds[i]));
      clanInfos[clanIds[i]].isInMMRArray = true;
    }
  }

  function forceMMRUpdate(
    uint48[] storage sortedClansByMMR,
    IClans clans,
    mapping(uint256 clanId => VaultClanInfo clanInfo) storage clanInfos,
    uint256[] calldata clanIds
  ) external returns (uint256[] memory clanIdsToDelete) {
    // Create an array to mark elements for deletion
    uint256 length = sortedClansByMMR.length;
    bool[] memory toDelete = new bool[](length);
    clanIdsToDelete = new uint256[](clanIds.length);
    uint256 clanIdsToDeletelength;

    // Mark elements for deletion
    for (uint256 i = 0; i < clanIds.length; ++i) {
      uint256 index = type(uint256).max;
      for (uint256 j = 0; j < length; ++j) {
        if (_getClanId(sortedClansByMMR[j]) == clanIds[i]) {
          index = j;
          break;
        }
      }

      if (
        index != type(uint256).max &&
        (!_hasLockedFunds(clanInfos[clanIds[i]]) || clans.maxMemberCapacity(clanIds[i]) == 0)
      ) {
        toDelete[index] = true;
        clanInfos[clanIds[i]].isInMMRArray = false;
        clanIdsToDelete[clanIdsToDeletelength++] = clanIds[i];
      }
    }

    // Perform a single shift operation at the end
    uint256 shiftCount = 0;
    for (uint256 i = 0; i < length; ++i) {
      if (toDelete[i]) {
        ++shiftCount;
      } else if (shiftCount != 0) {
        sortedClansByMMR[i - shiftCount] = sortedClansByMMR[i];
      }
    }

    // Reduce the length of the array
    assembly ("memory-safe") {
      sstore(sortedClansByMMR.slot, sub(length, shiftCount))
      mstore(clanIdsToDelete, clanIdsToDeletelength)
    }
  }

  function claimFunds(
    uint48[] storage sortedClansByMMR,
    VaultClanInfo storage clanInfo,
    uint256 clanId
  ) external returns (uint256 total, uint256 numLocksClaimed) {
    uint256 defendingVaultsOffset = clanInfo.defendingVaultsOffset;
    // There a few cases to consider here:
    // 1. The first one is not expired, so we can't claim anything
    // 2. The first one is expired, but the second one is not, so we can claim the first one
    // 3. The first one is expired, and the second one is expired, so we can claim both
    // We don't need to set claimed = true unless we know the second one is not expired yet
    for (uint256 i = defendingVaultsOffset; i < clanInfo.defendingVaults.length; ++i) {
      Vault storage defendingVault = clanInfo.defendingVaults[i];
      if (defendingVault.timestamp > block.timestamp) {
        // Has not expired yet
        break;
      }

      if (defendingVault.timestamp != 0 && !defendingVault.claimed) {
        total += defendingVault.amount;
        ++numLocksClaimed;
      }

      if (defendingVault.timestamp1 > block.timestamp) {
        // Has not expired yet
        defendingVault.amount = 0; // Clear the first one so that we don't try to use it again
        defendingVault.timestamp = 0;
        defendingVault.claimed = true; // First one is claimed at least
        break;
      }

      if (defendingVault.timestamp1 != 0) {
        total += defendingVault.amount1;
        ++numLocksClaimed;
        ++defendingVaultsOffset;
      } else {
        // First one is claimed, second one is not set yet, so need to make sure we don't try and claim it again
        defendingVault.claimed = true;
      }
    }

    require(total != 0, NothingToClaim());

    uint256 totalBrushLocked = clanInfo.totalBrushLocked;
    clanInfo.totalBrushLocked = uint96(totalBrushLocked - total);
    bool hasRemainingLockedBrush = totalBrushLocked - total != 0;
    if (!hasRemainingLockedBrush) {
      uint256 length = sortedClansByMMR.length;
      for (uint256 i = 0; i < length; ++i) {
        bool foundClan = _getClanId(sortedClansByMMR[i]) == clanId;
        if (foundClan) {
          // Shift everything to the left and pop
          for (uint256 j = i; j < length - 1; ++j) {
            sortedClansByMMR[j] = sortedClansByMMR[j + 1];
          }
          sortedClansByMMR.pop();
          clanInfo.isInMMRArray = false;
          break;
        }
      }
    }
    clanInfo.defendingVaultsOffset = uint24(defendingVaultsOffset);
  }

  function checkWithinRange(
    uint48[] storage sortedClansByMMR,
    uint256 clanId,
    uint256 defendingClanId,
    IClans clans,
    uint256 mmrAttackDistance
  ) external view {
    (uint256 clanIndex, uint256 defendingClanIndex) = _getClanIndices(sortedClansByMMR, clanId, defendingClanId);
    uint48[] memory modifiedSortedClansByMMR;
    if (clanIndex == type(uint256).max) {
      (modifiedSortedClansByMMR, clanIndex) = _insertMMRArrayInMemory(
        sortedClansByMMR,
        clans.getMMR(clanId),
        uint32(clanId)
      );
      if (clanIndex <= defendingClanIndex) {
        ++defendingClanIndex;
      }
    } else {
      modifiedSortedClansByMMR = sortedClansByMMR;
    }

    require(
      _isWithinRange(modifiedSortedClansByMMR, clanIndex, defendingClanIndex, mmrAttackDistance),
      OutsideMMRRange()
    );
  }

  function _hasLockedFunds(VaultClanInfo storage clanInfo) internal view returns (bool) {
    uint256 length = clanInfo.defendingVaults.length;
    if (length == 0) {
      return false;
    }
    // 1 value has not expired yet
    return
      (clanInfo.defendingVaults[length - 1].timestamp > block.timestamp) ||
      (clanInfo.defendingVaults[length - 1].timestamp1 > block.timestamp);
  }

  function _getClanIndicesMemory(
    uint48[] memory sortedClansByMMR,
    uint256 clanId,
    uint256 defendingClanId
  ) private pure returns (uint256 clanIndex, uint256 defendingIndex) {
    uint256 numFound;
    clanIndex = type(uint256).max;
    defendingIndex = type(uint256).max;
    for (uint256 i = 0; i < sortedClansByMMR.length; ++i) {
      if (_getClanId(sortedClansByMMR[i]) == clanId) {
        clanIndex = i;
        ++numFound;
      }

      if (_getClanId(sortedClansByMMR[i]) == defendingClanId) {
        defendingIndex = i;
        ++numFound;
      }

      if (numFound == 2) {
        break;
      }
    }
  }

  function _getClanIndices(
    uint48[] storage sortedClansByMMR,
    uint256 clanId,
    uint256 defendingClanId
  ) private view returns (uint256 clanIndex, uint256 defendingIndex) {
    uint256 numFound;
    clanIndex = type(uint256).max;
    defendingIndex = type(uint256).max;
    for (uint256 i = 0; i < sortedClansByMMR.length; ++i) {
      if (_getClanId(sortedClansByMMR[i]) == clanId) {
        clanIndex = i;
        ++numFound;
      }

      if (_getClanId(sortedClansByMMR[i]) == defendingClanId) {
        defendingIndex = i;
        ++numFound;
      }

      if (numFound == 2) {
        break;
      }
    }
  }

  // Useful for testing
  function isWithinRange(
    uint32[] calldata clanIds,
    uint16[] calldata mmrs,
    uint256 clanId,
    uint256 defendingClanId,
    uint256 mmrAttackDistance
  ) external pure returns (bool) {
    uint48[] memory sortedClansByMMR = new uint48[](clanIds.length);
    for (uint256 i = 0; i < clanIds.length; ++i) {
      sortedClansByMMR[i] = (uint32(clanIds[i]) << 16) | mmrs[i];
    }
    (uint256 clanIndex, uint256 defendingClanIndex) = _getClanIndicesMemory(sortedClansByMMR, clanId, defendingClanId);

    require(clanIndex != type(uint256).max, ClanDoesntExist(clanId));
    require(defendingClanIndex != type(uint256).max, ClanDoesntExist(defendingClanId));

    return _isWithinRange(sortedClansByMMR, clanIndex, defendingClanIndex, mmrAttackDistance);
  }

  // Range is not taken into account for the attacker with the same MMR as surrounding clans.
  // So with this array [400, 500, 500, 500, 600] with a range of 1, any attacker at 500 can attack the defender at 400 and 600
  // If there are any duplicates at the edge of the range, then the attacker can attack any with that MMR
  // So with the above array the 400 MMR clan can attack any 500 MMR clans with a range of 1
  function _isWithinRange(
    uint48[] memory sortedClansByMMR,
    uint256 clanIdIndex,
    uint256 defendingClanIdIndex,
    uint256 mmrAttackDistance
  ) private pure returns (bool) {
    // If they are within range then just return
    uint256 directDistance = (clanIdIndex > defendingClanIdIndex)
      ? clanIdIndex - defendingClanIdIndex
      : defendingClanIdIndex - clanIdIndex;
    if (mmrAttackDistance >= directDistance) {
      return true;
    }

    // Have the same MMR
    uint256 defenderMMR = _getMMR(sortedClansByMMR[defendingClanIdIndex]);
    uint256 attackerMMR = _getMMR(sortedClansByMMR[clanIdIndex]);
    if (defenderMMR == attackerMMR) {
      return true;
    }

    // Find the lower and upper bounds of clans with the same MMR as the attacking clan so that
    uint256 attackerLowerBound = clanIdIndex;
    uint256 attackerUpperBound = clanIdIndex;

    while (
      attackerLowerBound != 0 &&
      _getMMR(sortedClansByMMR[attackerLowerBound - 1]) == _getMMR(sortedClansByMMR[clanIdIndex])
    ) {
      --attackerLowerBound;
    }

    while (
      attackerUpperBound < sortedClansByMMR.length - 1 &&
      _getMMR(sortedClansByMMR[attackerUpperBound + 1]) == _getMMR(sortedClansByMMR[clanIdIndex])
    ) {
      ++attackerUpperBound;
    }

    uint256 boundDistance = defendingClanIdIndex > clanIdIndex
      ? defendingClanIdIndex - attackerUpperBound
      : attackerLowerBound - defendingClanIdIndex;
    if (mmrAttackDistance >= boundDistance) {
      return true;
    }

    // If outside range, check if MMR is the same as the MMR as that at the edge of the range
    int256 rangeEdgeIndex = int256(
      defendingClanIdIndex > clanIdIndex
        ? attackerUpperBound + mmrAttackDistance
        : attackerLowerBound - mmrAttackDistance
    );

    if (rangeEdgeIndex < 0) {
      rangeEdgeIndex = 0;
    } else if (rangeEdgeIndex >= int256(sortedClansByMMR.length)) {
      rangeEdgeIndex = int256(sortedClansByMMR.length - 1);
    }

    return defenderMMR == _getMMR(sortedClansByMMR[uint256(rangeEdgeIndex)]);
  }

  function blockAttacks(
    IItemNFT itemNFT,
    uint16 itemTokenId,
    VaultClanInfo storage clanInfo
  ) external returns (uint256 blockAttacksTimestamp) {
    Item memory item = itemNFT.getItem(itemTokenId);
    require(
      item.equipPosition == EquipPosition.LOCKED_VAULT && item.boostType == BoostType.PVP_BLOCK,
      NotALockedVaultDefenceItem()
    );

    require(
      (clanInfo.blockAttacksTimestamp + uint256(clanInfo.blockAttacksCooldownHours) * 3600) <= block.timestamp,
      BlockAttacksCooldown()
    );

    blockAttacksTimestamp = block.timestamp + item.boostDuration;
    clanInfo.blockAttacksTimestamp = uint40(blockAttacksTimestamp);
    clanInfo.blockAttacksCooldownHours = uint8(item.boostValue);

    itemNFT.burn(msg.sender, itemTokenId, 1);
  }

  function fulfillUpdateMMR(
    uint256 kA,
    uint256 kD,
    uint48[] storage sortedClansByMMR,
    IClans clans,
    uint256 attackingClanId,
    uint256 defendingClanId,
    bool didAttackersWin,
    mapping(uint256 clanId => VaultClanInfo clanInfo) storage clanInfos
  ) external returns (int256 attackingMMRDiff, int256 defendingMMRDiff) {
    (uint256 clanIndex, uint256 defendingClanIndex) = _getClanIndices(
      sortedClansByMMR,
      attackingClanId,
      defendingClanId
    );
    bool clanInArray = clanIndex != type(uint256).max;
    uint256 attackingMMR = clanInArray ? _getMMR(sortedClansByMMR[clanIndex]) : clans.getMMR(attackingClanId);

    uint256 defendingMMR = defendingClanIndex != type(uint256).max
      ? _getMMR(sortedClansByMMR[defendingClanIndex])
      : clans.getMMR(defendingClanId);

    (uint256 newAttackingMMR, uint256 newDefendingMMR) = getNewMMRs(
      kA,
      kD,
      uint16(attackingMMR),
      uint16(defendingMMR),
      didAttackersWin
    );

    attackingMMRDiff = int256(newAttackingMMR) - int256(attackingMMR);
    defendingMMRDiff = int256(newDefendingMMR) - int256(defendingMMR);

    // Tried to use a struct but got "Could not create stack layout after 1000 iterations" error
    uint256[] memory indices = new uint256[](2);
    uint16[] memory newMMRs = new uint16[](2);
    uint32[] memory clanIds = new uint32[](2);
    bool[] memory upwardFlags = new bool[](2);
    uint256 length;

    if (attackingMMRDiff != 0) {
      clans.setMMR(attackingClanId, uint16(newAttackingMMR));

      if (clanInArray) {
        // Attacking a clan while you have locked funds
        indices[length] = clanIndex;
        newMMRs[length] = uint16(newAttackingMMR);
        clanIds[length] = uint32(attackingClanId);
        upwardFlags[length++] = didAttackersWin;
      } else if (didAttackersWin) {
        // Attacking a clan while you have no locked funds and win
        clanIndex = _insertMMRArray(sortedClansByMMR, uint16(newAttackingMMR), uint32(attackingClanId));
        clanInfos[attackingClanId].isInMMRArray = true;
        if (clanIndex <= defendingClanIndex && defendingClanIndex != type(uint256).max) {
          ++defendingClanIndex;
        }
      }
    }

    if (defendingMMRDiff != 0) {
      clans.setMMR(defendingClanId, uint16(newDefendingMMR));

      bool defendingClanInArray = defendingClanIndex != type(uint256).max;
      if (defendingClanInArray) {
        // Attacking a clan while they have locked funds
        indices[length] = defendingClanIndex;
        newMMRs[length] = uint16(newDefendingMMR);
        clanIds[length] = uint32(defendingClanId);
        upwardFlags[length++] = !didAttackersWin;
      }
    }

    assembly ("memory-safe") {
      mstore(indices, length)
      mstore(newMMRs, length)
      mstore(clanIds, length)
      mstore(upwardFlags, length)
    }
    if (length != 0) {
      _updateMMRArrays(sortedClansByMMR, indices, newMMRs, clanIds, upwardFlags);
    }
  }

  function checkCanAttackVaults(
    uint256 clanId,
    uint256 defendingClanId,
    uint16 itemTokenId,
    uint256 maxLockedVaults,
    uint256 numPackedVaults,
    IItemNFT itemNFT,
    mapping(uint256 clanId => VaultClanInfo clanInfo) storage clanInfos,
    mapping(uint256 clanId => mapping(uint256 otherClanId => ClanBattleInfo battleInfo)) storage lastClanBattles
  ) external view returns (bool isReattacking, bool isUsingSuperAttack, uint256 superAttackCooldownTimestamp) {
    // Must have at least 1 combatant
    VaultClanInfo storage clanInfo = clanInfos[clanId];
    require(clanInfo.playerIds.length != 0, NoCombatants());
    require(clanId != defendingClanId, CannotAttackSelf());

    // Does this clan have any brush to even attack?
    VaultClanInfo storage defendingClanInfo = clanInfos[defendingClanId];
    require(defendingClanInfo.totalBrushLocked != 0, NoBrushToAttack());
    require(defendingClanInfo.blockAttacksTimestamp <= block.timestamp, ClanIsBlockingAttacks());
    require(clanInfo.attackingCooldownTimestamp <= block.timestamp, ClanAttackingCooldown());
    require(!clanInfo.currentlyAttacking, CannotAttackWhileStillAttacking());

    uint256 length = clanInfo.defendingVaults.length;
    uint256 defendingVaultsOffset = clanInfo.defendingVaultsOffset;
    require(length - defendingVaultsOffset <= maxLockedVaults / numPackedVaults, MaxLockedVaultsReached());

    uint256 numReattacks;
    (isReattacking, numReattacks) = _checkCanReattackVaults(clanId, defendingClanId, lastClanBattles);

    bool canReattack;
    if (itemTokenId != 0) {
      Item memory item = itemNFT.getItem(itemTokenId);
      bool isValidItem = item.equipPosition == EquipPosition.LOCKED_VAULT;
      require(isValidItem, NotALockedVaultAttackItem());

      if (isReattacking) {
        require(item.boostType == BoostType.PVP_REATTACK, NotALockedVaultAttackItem());
        canReattack = item.boostValue > numReattacks;
      } else {
        isUsingSuperAttack = item.boostType == BoostType.PVP_SUPER_ATTACK;
        require(isUsingSuperAttack, SpecifyingItemWhenNotReattackingOrSuperAttacking());
        require(clanInfo.superAttackCooldownTimestamp <= block.timestamp, ClanSuperAttackingCooldown());
        superAttackCooldownTimestamp = block.timestamp + item.boostDuration;
      }
    }

    require(!(isReattacking && !canReattack), ClanAttackingSameClanCooldown());
    require(!(isReattacking && isUsingSuperAttack), CannotReattackAndSuperAttackSameTime());
  }

  function getNewMMRs(
    uint256 kA,
    uint256 kD,
    uint16 attackingMMR,
    uint16 defendingMMR,
    bool didAttackersWin
  ) public pure returns (uint16 newAttackerMMR, uint16 newDefenderMMR) {
    uint256 Sa = didAttackersWin ? 100 : 0; // attacker score variable scaled up
    uint256 Sd = didAttackersWin ? 0 : 100; // defender score variable scaled up

    (uint256 changeA, bool negativeA) = _ratingChange(attackingMMR, defendingMMR, Sa, kA);
    (uint256 changeD, bool negativeD) = _ratingChange(defendingMMR, attackingMMR, Sd, kD);

    int _newAttackerMMR = int24(uint24(attackingMMR)) + (negativeA ? -int(changeA) : int(changeA));
    int _newDefenderMMR = int24(uint24(defendingMMR)) + (negativeD ? -int(changeD) : int(changeD));

    if (_newAttackerMMR < 0) {
      _newAttackerMMR = 0;
    }

    if (_newDefenderMMR < 0) {
      _newDefenderMMR = 0;
    }

    newAttackerMMR = uint16(uint24(int24(_newAttackerMMR)));
    newDefenderMMR = uint16(uint24(int24(_newDefenderMMR)));
  }

  function getSortedClanIdsByMMR(uint48[] storage sortedClansByMMR) external view returns (uint32[] memory clanIds) {
    uint256 length = sortedClansByMMR.length;
    clanIds = new uint32[](length);
    for (uint256 i; i < length; ++i) {
      clanIds[i] = uint32(_getClanId(sortedClansByMMR[i]));
    }
  }

  function getSortedMMR(uint48[] storage sortedClansByMMR) external view returns (uint16[] memory mmrs) {
    uint256 length = sortedClansByMMR.length;
    mmrs = new uint16[](length);
    for (uint256 i; i < length; ++i) {
      mmrs[i] = uint16(_getMMR(sortedClansByMMR[i]));
    }
  }

  function getIdleClans(
    uint48[] storage sortedClansByMMR,
    mapping(uint256 clanId => VaultClanInfo clanInfo) storage clanInfos,
    IClans clans
  ) external view returns (uint256[] memory clanIds) {
    uint256 origLength = sortedClansByMMR.length;
    clanIds = new uint256[](origLength);
    uint256 length;

    for (uint256 i; i < origLength; ++i) {
      uint256 clanId = _getClanId(sortedClansByMMR[i]);
      if (!_hasLockedFunds(clanInfos[clanId]) || clans.maxMemberCapacity(clanId) == 0) {
        clanIds[length++] = uint32(clanId);
      }
    }

    assembly ("memory-safe") {
      mstore(clanIds, length)
    }
  }

  function _lowerBound(uint48[] storage sortedClansByMMR, uint256 targetMMR) internal view returns (uint256) {
    if (sortedClansByMMR.length == 0) {
      return 0;
    }

    uint256 low = 0;
    uint256 high = sortedClansByMMR.length;

    while (low < high) {
      uint256 mid = (low + high) / 2;
      uint256 clanMMR = _getMMR(sortedClansByMMR[mid]);
      if (clanMMR < targetMMR) {
        low = mid + 1;
      } else {
        high = mid;
      }
    }

    return low;
  }

  function checkCanAssignCombatants(
    VaultClanInfo storage clanInfo,
    uint64[] calldata playerIds,
    uint8 maxClanCombatants
  ) external view {
    require(!clanInfo.currentlyAttacking, CannotChangeCombatantsDuringAttack());
    require(playerIds.length <= maxClanCombatants, TooManyCombatants());
    // Can only change combatants every so often
    require(clanInfo.assignCombatantsCooldownTimestamp <= block.timestamp, ClanCombatantsChangeCooldown());
  }

  function clearCooldowns(
    uint256 clanId,
    uint256[] calldata otherClanIds,
    VaultClanInfo storage clanInfo,
    mapping(uint256 clanId => mapping(uint256 otherClanId => ClanBattleInfo battleInfo)) storage lastClanBattles
  ) external {
    clanInfo.attackingCooldownTimestamp = 0;
    clanInfo.assignCombatantsCooldownTimestamp = 0;
    clanInfo.currentlyAttacking = false;
    clanInfo.superAttackCooldownTimestamp = 0;
    clanInfo.blockAttacksTimestamp = 0;
    clanInfo.blockAttacksCooldownHours = 0;

    for (uint256 i; i < otherClanIds.length; ++i) {
      uint256 lowerClanId = clanId < otherClanIds[i] ? clanId : otherClanIds[i];
      uint256 higherClanId = clanId < otherClanIds[i] ? otherClanIds[i] : clanId;
      delete lastClanBattles[lowerClanId][higherClanId];
    }
  }

  function _updateMMRArrays(
    uint48[] storage sortedClansByMMR,
    uint256[] memory indices,
    uint16[] memory newMMRs,
    uint32[] memory clanIds,
    bool[] memory upwardFlags
  ) private {
    // Adjust each index, update one by one
    for (uint256 i = 0; i < indices.length; ++i) {
      uint256 currentIndex = indices[i];
      uint16 newMMR = newMMRs[i];
      uint32 clanId = clanIds[i];
      bool upward = upwardFlags[i];

      uint256 newIndex = _updateSingleMMR(sortedClansByMMR, currentIndex, newMMR, clanId, upward);
      // Adjust subsequent indices if needed
      for (uint256 j = i + 1; j < indices.length; ++j) {
        if (upward && indices[j] >= currentIndex && indices[j] <= newIndex) {
          --indices[j]; // Adjust index if it falls within the shifted range
        } else if (!upward && indices[j] <= currentIndex && indices[j] >= newIndex) {
          ++indices[j]; // Adjust index if it falls within the shifted range
        }
      }
    }
  }

  function _updateSingleMMR(
    uint48[] storage sortedClansByMMR,
    uint256 currentIndex,
    uint16 newMMR,
    uint32 clanId,
    bool upward
  ) internal returns (uint256) {
    uint256 i = currentIndex;
    // Check if the new position would be different
    bool shouldMove = false;
    if (upward && i < sortedClansByMMR.length - 1) {
      shouldMove = _getMMR(sortedClansByMMR[i + 1]) < newMMR;
    } else if (!upward && i != 0) {
      shouldMove = _getMMR(sortedClansByMMR[i - 1]) >= newMMR;
    }

    if (!shouldMove) {
      // If position doesn't change, just update the MMR and return
      _setPackedClanIdAndMMR(sortedClansByMMR, i, clanId, newMMR);
      return i;
    }

    if (upward) {
      // Shift elements left if newMMR is higher
      while (i < sortedClansByMMR.length - 1 && _getMMR(sortedClansByMMR[i + 1]) < newMMR) {
        sortedClansByMMR[i] = sortedClansByMMR[i + 1];
        ++i;
      }
    } else {
      // Shift elements right if newMMR is lower
      while (i != 0 && _getMMR(sortedClansByMMR[i - 1]) >= newMMR) {
        sortedClansByMMR[i] = sortedClansByMMR[i - 1];
        --i;
      }
    }

    _setPackedClanIdAndMMR(sortedClansByMMR, i, clanId, newMMR);
    return i;
  }

  function insertMMRArray(uint48[] storage sortedClansByMMR, uint16 mmr, uint32 clanId) external {
    _insertMMRArray(sortedClansByMMR, mmr, clanId);
  }

  function _insertMMRArray(
    uint48[] storage sortedClansByMMR,
    uint16 mmr,
    uint32 clanId
  ) private returns (uint256 index) {
    // Find where to insert it into the array
    index = _lowerBound(sortedClansByMMR, mmr);
    sortedClansByMMR.push(); // expand array
    // Shift array to the right
    for (uint256 i = sortedClansByMMR.length - 1; i > index; --i) {
      sortedClansByMMR[i] = sortedClansByMMR[i - 1];
    }
    _setPackedClanIdAndMMR(sortedClansByMMR, index, clanId, mmr);
  }

  function _insertMMRArrayInMemory(
    uint48[] storage sortedClansByMMR,
    uint16 mmr,
    uint32 clanId
  ) private view returns (uint48[] memory newSortedClansByMMR, uint256 index) {
    // Find where to insert it into the array
    index = _lowerBound(sortedClansByMMR, mmr);

    // Copy to memory and shift any after the index to the right
    newSortedClansByMMR = new uint48[](sortedClansByMMR.length + 1);
    for (uint256 i = 0; i < newSortedClansByMMR.length; ++i) {
      if (i < index) {
        newSortedClansByMMR[i] = sortedClansByMMR[i];
      } else if (i == index) {
        newSortedClansByMMR[i] = (uint32(clanId) << 16) | mmr;
      } else {
        newSortedClansByMMR[i] = sortedClansByMMR[i - 1];
      }
    }
  }

  function _setPackedClanIdAndMMR(uint48[] storage sortedClansByMMR, uint256 index, uint32 clanId, uint16 mmr) private {
    sortedClansByMMR[index] = (uint32(clanId) << 16) | mmr;
  }

  function _getUnpackedClanIdAndMMR(
    uint48[] storage sortedClansByMMR,
    uint256 index
  ) private view returns (uint32 clanId, uint16 mmr) {
    uint48 packed = sortedClansByMMR[index];
    clanId = uint32(packed >> 16);
    mmr = uint16(packed);
  }

  function _checkCanReattackVaults(
    uint256 clanId,
    uint256 defendingClanId,
    mapping(uint256 clanId => mapping(uint256 otherClanId => ClanBattleInfo battleInfo)) storage lastClanBattles
  ) private view returns (bool isReattacking, uint256 numReattacks) {
    // Check if they are re-attacking this clan and allowed to
    uint256 lowerClanId = clanId < defendingClanId ? clanId : defendingClanId;
    uint256 higherClanId = clanId < defendingClanId ? defendingClanId : clanId;
    ClanBattleInfo storage battleInfo = lastClanBattles[lowerClanId][higherClanId];
    if (lowerClanId == clanId) {
      if (battleInfo.lastClanIdAttackOtherClanIdCooldownTimestamp > block.timestamp) {
        numReattacks = battleInfo.numReattacks;
        isReattacking = true;
      }
    } else {
      if (battleInfo.lastOtherClanIdAttackClanIdCooldownTimestamp > block.timestamp) {
        numReattacks = battleInfo.numReattacksOtherClan;
        isReattacking = true;
      }
    }
  }

  function _getMMR(uint48 packed) private pure returns (uint256) {
    return uint16(packed);
  }

  function _getClanId(uint48 packed) private pure returns (uint256) {
    return uint32(packed >> 16);
  }

  // This function is adapted from the solidity ELO library
  /// @notice Get the 16th root of a number, used in MMR calculations
  /// @dev MMR calculations require the 400th root (10 ^ (x / 400)), however this can be simplified to the 16th root (10 ^ ((x / 25) / 16))
  function _sixteenthRoot(uint256 x) internal pure returns (uint256) {
    return Math.sqrt(Math.sqrt(Math.sqrt(Math.sqrt(x))));
  }

  // This function is adapted from the solidity ELO library
  /// @notice Calculates the change in MMR rating, after a given outcome.
  /// @param ratingA the MMR rating of the clan A
  /// @param ratingD the MMR rating of the clan D
  /// @param score the _score of the clan A, scaled by 100. 100 = win, 0 = loss
  /// @param kFactor the k-factor or development multiplier used to calculate the change in MMR rating. 20 is the typical value
  /// @return change the change in MMR rating of clan D
  /// @return isNegative the directional change of clan A's MMR. Opposite sign for clan D
  function _ratingChange(
    uint256 ratingA,
    uint256 ratingD,
    uint256 score,
    uint256 kFactor
  ) internal pure returns (uint256 change, bool isNegative) {
    uint256 kFactorScaled; // scaled up `kFactor` by 100
    bool negative = ratingD < ratingA;
    uint256 ratingDiff; // absolute value difference between `_ratingA` and `_ratingD`

    unchecked {
      // scale up the inputs by a factor of 100
      // since our MMR math is scaled up by 100 (to avoid low precision integer division)
      kFactorScaled = kFactor * 10_000;
      ratingDiff = negative ? ratingA - ratingD : ratingD - ratingA;
    }

    // checks against overflow/underflow, discovered via fuzzing
    // large rating diffs leads to 10^ratingDiff being too large to fit in a uint256
    if (ratingDiff >= 800) {
      ratingDiff = 799;
    }

    // ----------------------------------------------------------------------
    // Below, we'll be running simplified versions of the following formulas:
    // expected _score = 1 / (1 + 10 ^ (ratingDiff / 400))
    // MMR change = _kFactor * (_score - expectedScore)

    uint256 n; // numerator of the power, with scaling, (numerator of `ratingDiff / 400`)
    uint256 powered; // the value of 10 ^ numerator
    uint256 poweredRoot; // the value of 16th root of 10 ^ numerator (fully resolved 10 ^ (ratingDiff / 400))
    uint256 kExpectedScore; // the expected _score with K factor distributed
    uint256 kScore; // the actual _score with K factor distributed

    unchecked {
      // Apply offset of 800 to scale the result by 100
      n = negative ? 800 - ratingDiff : 800 + ratingDiff;

      // (x / 400) is the same as ((x / 25) / 16))
      powered = 10 ** (n / 25); // divide by 25 to avoid reach uint256 max
      poweredRoot = _sixteenthRoot(powered); // x ^ (1 / 16) is the same as 16th root of x

      // given `change = _kFactor * (_score - expectedScore)` we can distribute _kFactor to both terms
      kExpectedScore = kFactorScaled / (100 + poweredRoot); // both numerator and denominator scaled up by 100
      kScore = kFactor * score; // input _score is already scaled up by 100

      // determines the sign of the MMR change
      isNegative = kScore < kExpectedScore;
      change = (isNegative ? kExpectedScore - kScore : kScore - kExpectedScore) / 100;
    }
  }
}

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

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

// solhint-disable-next-line no-global-import
import "./globals/all.sol";

// This file contains methods for interacting with generic functions like trimming strings, lowercase etc.
// Also has some shared functions for rewards
library EstforLibrary {
  error RandomRewardsMustBeInOrder(uint16 chance1, uint16 chance2);
  error RandomRewardNoDuplicates();
  error GuaranteedRewardsNoDuplicates();
  error TooManyGuaranteedRewards();
  error TooManyRandomRewards();

  function isWhitespace(bytes1 _char) internal pure returns (bool) {
    return
      _char == 0x20 || // Space
      _char == 0x09 || // Tab
      _char == 0x0a || // Line feed
      _char == 0x0D || // Carriage return
      _char == 0x0B || // Vertical tab
      _char == 0x00; // empty byte
  }

  function leftTrim(string memory str) internal pure returns (string memory) {
    bytes memory b = bytes(str);
    uint256 strLen = b.length;
    uint256 start = type(uint256).max;
    // Find the index of the first non-whitespace character
    for (uint256 i = 0; i < strLen; ++i) {
      bytes1 char = b[i];
      if (!isWhitespace(char)) {
        start = i;
        break;
      }
    }

    if (start == type(uint256).max) {
      return "";
    }
    // Copy the remainder to a new string
    bytes memory trimmedBytes = new bytes(strLen - start);
    for (uint256 i = start; i < strLen; ++i) {
      trimmedBytes[i - start] = b[i];
    }
    return string(trimmedBytes);
  }

  function rightTrim(string calldata str) internal pure returns (string memory) {
    bytes memory b = bytes(str);
    uint256 strLen = b.length;
    if (strLen == 0) {
      return "";
    }
    int end = -1;
    // Find the index of the last non-whitespace character
    for (int i = int(strLen) - 1; i >= 0; --i) {
      bytes1 char = b[uint256(i)];
      if (!isWhitespace(char)) {
        end = i;
        break;
      }
    }

    if (end == -1) {
      return "";
    }

    bytes memory trimmedBytes = new bytes(uint256(end) + 1);
    for (uint256 i = 0; i <= uint256(end); ++i) {
      trimmedBytes[i] = b[i];
    }
    return string(trimmedBytes);
  }

  function trim(string calldata str) external pure returns (string memory) {
    return leftTrim(rightTrim(str));
  }

  // Assumes the string is already trimmed
  function containsValidNameCharacters(string calldata name) external pure returns (bool) {
    bytes memory b = bytes(name);
    bool lastCharIsWhitespace;
    for (uint256 i = 0; i < b.length; ++i) {
      bytes1 char = b[i];

      bool isUpperCaseLetter = (char >= 0x41) && (char <= 0x5A); // A-Z
      bool isLowerCaseLetter = (char >= 0x61) && (char <= 0x7A); // a-z
      bool isDigit = (char >= 0x30) && (char <= 0x39); // 0-9
      bool isSpecialCharacter = (char == 0x2D) || (char == 0x5F) || (char == 0x2E) || (char == 0x20); // "-", "_", ".", and " "
      bool _isWhitespace = isWhitespace(char);
      bool hasMultipleWhitespaceInRow = lastCharIsWhitespace && _isWhitespace;
      lastCharIsWhitespace = _isWhitespace;
      if ((!isUpperCaseLetter && !isLowerCaseLetter && !isDigit && !isSpecialCharacter) || hasMultipleWhitespaceInRow) {
        return false;
      }
    }
    return true;
  }

  function containsValidDiscordCharacters(string calldata discord) external pure returns (bool) {
    bytes memory discordBytes = bytes(discord);
    for (uint256 i = 0; i < discordBytes.length; ++i) {
      bytes1 char = discordBytes[i];

      bool isUpperCaseLetter = (char >= 0x41) && (char <= 0x5A); // A-Z
      bool isLowerCaseLetter = (char >= 0x61) && (char <= 0x7A); // a-z
      bool isDigit = (char >= 0x30) && (char <= 0x39); // 0-9
      if (!isUpperCaseLetter && !isLowerCaseLetter && !isDigit) {
        return false;
      }
    }

    return true;
  }

  function containsValidTelegramCharacters(string calldata telegram) external pure returns (bool) {
    bytes memory telegramBytes = bytes(telegram);
    for (uint256 i = 0; i < telegramBytes.length; ++i) {
      bytes1 char = telegramBytes[i];

      bool isUpperCaseLetter = (char >= 0x41) && (char <= 0x5A); // A-Z
      bool isLowerCaseLetter = (char >= 0x61) && (char <= 0x7A); // a-z
      bool isDigit = (char >= 0x30) && (char <= 0x39); // 0-9
      bool isPlus = char == 0x2B; // "+"
      if (!isUpperCaseLetter && !isLowerCaseLetter && !isDigit && !isPlus) {
        return false;
      }
    }

    return true;
  }

  function containsValidTwitterCharacters(string calldata twitter) external pure returns (bool) {
    bytes memory twitterBytes = bytes(twitter);
    for (uint256 i = 0; i < twitterBytes.length; ++i) {
      bytes1 char = twitterBytes[i];

      bool isUpperCaseLetter = (char >= 0x41) && (char <= 0x5A); // A-Z
      bool isLowerCaseLetter = (char >= 0x61) && (char <= 0x7A); // a-z
      bool isDigit = (char >= 0x30) && (char <= 0x39); // 0-9
      if (!isUpperCaseLetter && !isLowerCaseLetter && !isDigit) {
        return false;
      }
    }

    return true;
  }

  function containsBaselineSocialNameCharacters(string calldata socialMediaName) external pure returns (bool) {
    bytes memory socialMediaNameBytes = bytes(socialMediaName);
    for (uint256 i = 0; i < socialMediaNameBytes.length; ++i) {
      bytes1 char = socialMediaNameBytes[i];

      bool isUpperCaseLetter = (char >= 0x41) && (char <= 0x5A); // A-Z
      bool isLowerCaseLetter = (char >= 0x61) && (char <= 0x7A); // a-z
      bool isDigit = (char >= 0x30) && (char <= 0x39); // 0-9
      bool isUnderscore = char == 0x5F; // "_"
      bool isPeriod = char == 0x2E; // "."
      bool isPlus = char == 0x2B; // "+"
      if (!isUpperCaseLetter && !isLowerCaseLetter && !isDigit && !isUnderscore && !isPeriod && !isPlus) {
        return false;
      }
    }

    return true;
  }

  function toLower(string memory str) internal pure returns (string memory) {
    bytes memory lowerStr = abi.encodePacked(str);
    for (uint256 i = 0; i < lowerStr.length; ++i) {
      bytes1 char = lowerStr[i];
      if ((char >= 0x41) && (char <= 0x5A)) {
        // So we add 32 to make it lowercase
        lowerStr[i] = bytes1(uint8(char) + 32);
      }
    }
    return string(lowerStr);
  }

  // This should match the one below, useful when a calldata array is needed and for external testing
  function _binarySearchMemory(uint64[] calldata array, uint256 target) internal pure returns (uint256) {
    uint256 low = 0;
    uint256 high = array.length - 1;

    while (low <= high) {
      uint256 mid = low + (high - low) / 2;

      if (array[mid] == target) {
        return mid; // Element found
      } else if (array[mid] < target) {
        low = mid + 1;
      } else {
        // Check to prevent underflow
        if (mid != 0) {
          high = mid - 1;
        } else {
          // If mid is 0 and _arr[mid] is not the target, the element is not in the array
          break;
        }
      }
    }

    return type(uint256).max; // Element not found
  }

  function binarySearchMemory(uint64[] calldata array, uint256 target) external pure returns (uint256) {
    return _binarySearchMemory(array, target);
  }

  // This should match the one above
  function _binarySearch(uint64[] storage array, uint256 target) internal view returns (uint256) {
    uint256 low = 0;
    uint256 high = array.length - 1;

    while (low <= high) {
      uint256 mid = low + (high - low) / 2;

      if (array[mid] == target) {
        return mid; // Element found
      } else if (array[mid] < target) {
        low = mid + 1;
      } else {
        // Check to prevent underflow
        if (mid != 0) {
          high = mid - 1;
        } else {
          // If mid is 0 and _arr[mid] is not the target, the element is not in the array
          break;
        }
      }
    }

    return type(uint256).max; // Element not found
  }

  function binarySearch(uint64[] storage array, uint256 target) external view returns (uint256) {
    return _binarySearch(array, target);
  }

  function _shuffleArray(uint64[] memory array, uint256 randomNumber) internal pure returns (uint64[] memory output) {
    for (uint256 i; i < array.length; ++i) {
      uint256 n = i + (randomNumber % (array.length - i));
      if (i != n) {
        uint64 temp = array[n];
        array[n] = array[i];
        array[i] = temp;
      }
    }
    return array;
  }

  function _getRandomInRange16(
    uint256 randomWord,
    uint256 shift,
    int16 minValue,
    int16 maxValue
  ) internal pure returns (int16) {
    return int16(minValue + (int16(int256((randomWord >> shift) & 0xFFFF) % (maxValue - minValue + 1))));
  }

  function _getRandomFromArray16(
    uint256 randomWord,
    uint256 shift,
    uint16[] storage arr,
    uint256 arrLength
  ) internal view returns (uint16) {
    return arr[_getRandomIndexFromArray16(randomWord, shift, arrLength)];
  }

  function _getRandomFrom3ElementArray16(
    uint256 randomWord,
    uint256 shift,
    uint16[3] memory arr
  ) internal pure returns (uint16) {
    return arr[_getRandomIndexFromArray16(randomWord, shift, arr.length)];
  }

  function _getRandomIndexFromArray16(
    uint256 randomWord,
    uint256 shift,
    uint256 arrLength
  ) internal pure returns (uint16) {
    return uint16(((randomWord >> shift) & 0xFFFF) % arrLength);
  }

  function setActionGuaranteedRewards(
    GuaranteedReward[] calldata guaranteedRewards,
    ActionRewards storage actionRewards
  ) external {
    _setActionGuaranteedRewards(guaranteedRewards, actionRewards);
  }

  function setActionRandomRewards(RandomReward[] calldata randomRewards, ActionRewards storage actionRewards) external {
    _setActionRandomRewards(randomRewards, actionRewards);
  }

  function _setActionGuaranteedRewards(
    GuaranteedReward[] calldata guaranteedRewards,
    ActionRewards storage actionRewards
  ) internal {
    uint256 guaranteedRewardsLength = guaranteedRewards.length;
    if (guaranteedRewardsLength != 0) {
      actionRewards.guaranteedRewardTokenId1 = guaranteedRewards[0].itemTokenId;
      actionRewards.guaranteedRewardRate1 = guaranteedRewards[0].rate;
    }
    if (guaranteedRewardsLength > 1) {
      actionRewards.guaranteedRewardTokenId2 = guaranteedRewards[1].itemTokenId;
      actionRewards.guaranteedRewardRate2 = guaranteedRewards[1].rate;
      require(
        actionRewards.guaranteedRewardTokenId1 != actionRewards.guaranteedRewardTokenId2,
        GuaranteedRewardsNoDuplicates()
      );
    }
    if (guaranteedRewardsLength > 2) {
      actionRewards.guaranteedRewardTokenId3 = guaranteedRewards[2].itemTokenId;
      actionRewards.guaranteedRewardRate3 = guaranteedRewards[2].rate;

      uint256 bounds = guaranteedRewardsLength - 1;
      for (uint256 i; i < bounds; ++i) {
        require(
          guaranteedRewards[i].itemTokenId != guaranteedRewards[guaranteedRewardsLength - 1].itemTokenId,
          GuaranteedRewardsNoDuplicates()
        );
      }
    }
    require(guaranteedRewardsLength <= 3, TooManyGuaranteedRewards());
  }

  // Random rewards have most common one first
  function _setActionRandomRewards(
    RandomReward[] calldata randomRewards,
    ActionRewards storage actionRewards
  ) internal {
    uint256 randomRewardsLength = randomRewards.length;
    if (randomRewardsLength != 0) {
      actionRewards.randomRewardTokenId1 = randomRewards[0].itemTokenId;
      actionRewards.randomRewardChance1 = randomRewards[0].chance;
      actionRewards.randomRewardAmount1 = randomRewards[0].amount;
    }
    if (randomRewardsLength > 1) {
      actionRewards.randomRewardTokenId2 = randomRewards[1].itemTokenId;
      actionRewards.randomRewardChance2 = randomRewards[1].chance;
      actionRewards.randomRewardAmount2 = randomRewards[1].amount;

      require(
        actionRewards.randomRewardChance2 <= actionRewards.randomRewardChance1,
        RandomRewardsMustBeInOrder(randomRewards[0].chance, randomRewards[1].chance)
      );
      require(actionRewards.randomRewardTokenId1 != actionRewards.randomRewardTokenId2, RandomRewardNoDuplicates());
    }
    if (randomRewardsLength > 2) {
      actionRewards.randomRewardTokenId3 = randomRewards[2].itemTokenId;
      actionRewards.randomRewardChance3 = randomRewards[2].chance;
      actionRewards.randomRewardAmount3 = randomRewards[2].amount;

      require(
        actionRewards.randomRewardChance3 <= actionRewards.randomRewardChance2,
        RandomRewardsMustBeInOrder(randomRewards[1].chance, randomRewards[2].chance)
      );

      uint256 bounds = randomRewardsLength - 1;
      for (uint256 i; i < bounds; ++i) {
        require(
          randomRewards[i].itemTokenId != randomRewards[randomRewardsLength - 1].itemTokenId,
          RandomRewardNoDuplicates()
        );
      }
    }
    if (randomRewards.length > 3) {
      actionRewards.randomRewardTokenId4 = randomRewards[3].itemTokenId;
      actionRewards.randomRewardChance4 = randomRewards[3].chance;
      actionRewards.randomRewardAmount4 = randomRewards[3].amount;
      require(
        actionRewards.randomRewardChance4 <= actionRewards.randomRewardChance3,
        RandomRewardsMustBeInOrder(randomRewards[2].chance, randomRewards[3].chance)
      );
      uint256 bounds = randomRewards.length - 1;
      for (uint256 i; i < bounds; ++i) {
        require(
          randomRewards[i].itemTokenId != randomRewards[randomRewards.length - 1].itemTokenId,
          RandomRewardNoDuplicates()
        );
      }
    }

    require(randomRewards.length <= 4, TooManyRandomRewards());
  }

  function _get16bitSlice(bytes memory b, uint256 index) internal pure returns (uint16) {
    uint256 key = index * 2;
    return uint16(b[key] | (bytes2(b[key + 1]) >> 8));
  }

  // Helper function to get random value between min and max (inclusive) for uint8
  function _getRandomInRange8(uint8 minValue, uint8 maxValue, uint8 randomness) internal pure returns (uint8) {
    if (maxValue <= minValue) {
      return minValue;
    }

    uint8 range = maxValue - minValue + 1;
    // Use modulo to get value in range and add minValue
    return uint8((uint16(randomness) % uint16(range)) + uint16(minValue));
  }
}

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

import {Skill, Attire, CombatStyle, CombatStats} from "./misc.sol";
import {GuaranteedReward, RandomReward} from "./rewards.sol";

enum ActionQueueStrategy {
  OVERWRITE,
  APPEND,
  KEEP_LAST_IN_PROGRESS
}

struct QueuedActionInput {
  Attire attire;
  uint16 actionId;
  uint16 regenerateId; // Food (combat), maybe something for non-combat later
  uint16 choiceId; // Melee/Ranged/Magic (combat), logs, ore (non-combat)
  uint16 rightHandEquipmentTokenId; // Axe/Sword/bow, can be empty
  uint16 leftHandEquipmentTokenId; // Shield, can be empty
  uint24 timespan; // How long to queue the action for
  uint8 combatStyle; // CombatStyle specific style of combat
  uint40 petId; // id of the pet (can be empty)
}

struct QueuedAction {
  uint16 actionId;
  uint16 regenerateId; // Food (combat), maybe something for non-combat later
  uint16 choiceId; // Melee/Ranged/Magic (combat), logs, ore (non-combat)
  uint16 rightHandEquipmentTokenId; // Axe/Sword/bow, can be empty
  uint16 leftHandEquipmentTokenId; // Shield, can be empty
  uint24 timespan; // How long to queue the action for
  uint24 prevProcessedTime; // How long the action has been processed for previously
  uint24 prevProcessedXPTime; // How much XP has been gained for this action so far
  uint64 queueId; // id of this queued action
  bytes1 packed; // 1st bit is isValid (not used yet), 2nd bit is for hasPet (decides if the 2nd storage slot is read)
  uint8 combatStyle;
  uint24 reserved;
  // Next storage slot
  uint40 petId; // id of the pet (can be empty)
}

// This is only used as an input arg (and events)
struct ActionInput {
  uint16 actionId;
  ActionInfo info;
  GuaranteedReward[] guaranteedRewards;
  RandomReward[] randomRewards;
  CombatStats combatStats;
}

struct ActionInfo {
  uint8 skill;
  bool actionChoiceRequired; // If true, then the user must choose an action choice
  uint24 xpPerHour;
  uint32 minXP;
  uint24 numSpawned; // Mostly for combat, capped respawn rate for xp/drops. Per hour, base 10000
  uint16 handItemTokenIdRangeMin; // Inclusive
  uint16 handItemTokenIdRangeMax; // Inclusive
  uint8 successPercent; // 0-100
  uint8 worldLocation; // 0 is the main starting world
  bool isFullModeOnly;
  bool isAvailable;
  uint16 questPrerequisiteId;
}

uint16 constant ACTIONCHOICE_MELEE_BASIC_SWORD = 1500;
uint16 constant ACTIONCHOICE_MAGIC_SHADOW_BLAST = 2000;
uint16 constant ACTIONCHOICE_RANGED_BASIC_BOW = 3000;

// Allows for 2, 4 or 8 hour respawn time
uint256 constant SPAWN_MUL = 1000;
uint256 constant RATE_MUL = 1000;
uint256 constant GUAR_MUL = 10; // Guaranteeded reward multiplier (1 decimal, allows for 2 hour action times)

uint256 constant MAX_QUEUEABLE_ACTIONS = 3; // Available slots to queue actions

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

import "./actions.sol";
import "./items.sol";
import "./misc.sol";
import "./players.sol";
import "./rewards.sol";
import "./quests.sol";
import "./promotions.sol";
import "./clans.sol";
import "./pets.sol";

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

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

enum ClanRank {
  NONE, // Not in a clan
  COMMONER, // Member of the clan
  SCOUT, // Invite and kick commoners
  COLONEL, // Can launch attacks and assign combatants
  TREASURER, // Can withdraw from bank
  LEADER, // Can edit clan details
  OWNER // Can do everything and transfer ownership
}

enum BattleResultEnum {
  DRAW,
  WIN,
  LOSE
}

struct ClanBattleInfo {
  uint40 lastClanIdAttackOtherClanIdCooldownTimestamp;
  uint8 numReattacks;
  uint40 lastOtherClanIdAttackClanIdCooldownTimestamp;
  uint8 numReattacksOtherClan;
}

// Packed for gas efficiency
struct Vault {
  bool claimed; // Only applies to the first one, if it's claimed without the second one being claimed
  uint40 timestamp;
  uint80 amount;
  uint40 timestamp1;
  uint80 amount1;
}

struct VaultClanInfo {
  IBank bank;
  uint96 totalBrushLocked;
  // New storage slot
  uint40 attackingCooldownTimestamp;
  uint40 assignCombatantsCooldownTimestamp;
  bool currentlyAttacking;
  uint24 defendingVaultsOffset;
  uint40 blockAttacksTimestamp;
  uint8 blockAttacksCooldownHours;
  bool isInMMRArray;
  uint40 superAttackCooldownTimestamp;
  uint64[] playerIds;
  Vault[] defendingVaults; // Append only, and use defendingVaultsOffset to decide where the real start is
}

uint256 constant MAX_CLAN_COMBATANTS = 20;
uint256 constant CLAN_WARS_GAS_PRICE_WINDOW_SIZE = 4;

bool constant XP_EMITTED_ELSEWHERE = true;

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

uint16 constant NONE = 0;

uint16 constant COMBAT_BASE = 2048;
// Melee
uint16 constant SWORD_BASE = COMBAT_BASE;
uint16 constant BRONZE_SWORD = SWORD_BASE;

// Woodcutting (2816 - 3071)
uint16 constant WOODCUTTING_BASE = 2816;
uint16 constant BRONZE_AXE = WOODCUTTING_BASE;

// Firemaking (3328 - 3583)
uint16 constant FIRE_BASE = 3328;
uint16 constant MAGIC_FIRE_STARTER = FIRE_BASE;
uint16 constant FIRE_MAX = FIRE_BASE + 255;

// Fishing (3072 - 3327)
uint16 constant FISHING_BASE = 3072;
uint16 constant NET_STICK = FISHING_BASE;

// Mining (2560 - 2815)
uint16 constant MINING_BASE = 2560;
uint16 constant BRONZE_PICKAXE = MINING_BASE;

// Magic
uint16 constant STAFF_BASE = COMBAT_BASE + 50;
uint16 constant TOTEM_STAFF = STAFF_BASE;

// Ranged
uint16 constant BOW_BASE = COMBAT_BASE + 100;
uint16 constant BASIC_BOW = BOW_BASE;

// Cooked fish
uint16 constant COOKED_FISH_BASE = 11008;
uint16 constant COOKED_FEOLA = COOKED_FISH_BASE + 3;

// Scrolls
uint16 constant SCROLL_BASE = 12032;
uint16 constant SHADOW_SCROLL = SCROLL_BASE;

// Eggs
uint16 constant EGG_BASE = 12544;
uint16 constant SECRET_EGG_1_TIER1 = EGG_BASE;
uint16 constant SECRET_EGG_2_TIER1 = EGG_BASE + 1;
uint16 constant EGG_MAX = 12799;

// Boosts
uint16 constant BOOST_BASE = 12800;
uint16 constant COMBAT_BOOST = BOOST_BASE;
uint16 constant XP_BOOST = BOOST_BASE + 1;
uint16 constant GATHERING_BOOST = BOOST_BASE + 2;
uint16 constant SKILL_BOOST = BOOST_BASE + 3;
uint16 constant ABSENCE_BOOST = BOOST_BASE + 4;
uint16 constant LUCKY_POTION = BOOST_BASE + 5;
uint16 constant LUCK_OF_THE_DRAW = BOOST_BASE + 6;
uint16 constant PRAY_TO_THE_BEARDIE = BOOST_BASE + 7;
uint16 constant PRAY_TO_THE_BEARDIE_2 = BOOST_BASE + 8;
uint16 constant PRAY_TO_THE_BEARDIE_3 = BOOST_BASE + 9;
uint16 constant BOOST_RESERVED_1 = BOOST_BASE + 10;
uint16 constant BOOST_RESERVED_2 = BOOST_BASE + 11;
uint16 constant BOOST_RESERVED_3 = BOOST_BASE + 12;
uint16 constant GO_OUTSIDE = BOOST_BASE + 13;
uint16 constant RAINING_RARES = BOOST_BASE + 14;
uint16 constant CLAN_BOOSTER = BOOST_BASE + 15;
uint16 constant CLAN_BOOSTER_2 = BOOST_BASE + 16;
uint16 constant CLAN_BOOSTER_3 = BOOST_BASE + 17;
uint16 constant BOOST_RESERVED_4 = BOOST_BASE + 18;
uint16 constant BOOST_RESERVED_5 = BOOST_BASE + 19;
uint16 constant BOOST_RESERVED_6 = BOOST_BASE + 20;
uint16 constant BOOST_MAX = 13055;

uint16 constant SPECIAL_BASE = 13312;
uint16 constant SPECIAL_MAX = 13567;

// Miscs
uint16 constant MISC_BASE = 65535;
uint16 constant RAID_PASS = MISC_BASE - 1;

struct BulkTransferInfo {
  uint256[] tokenIds;
  uint256[] amounts;
  address to;
}

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

enum BoostType {
  NONE,
  ANY_XP,
  COMBAT_XP,
  NON_COMBAT_XP,
  GATHERING,
  ABSENCE,
  PASSIVE_SKIP_CHANCE,
  // Clan wars
  PVP_BLOCK,
  PVP_REATTACK,
  PVP_SUPER_ATTACK,
  // Combat stats
  COMBAT_FIXED
}

struct Equipment {
  uint16 itemTokenId;
  uint24 amount;
}

enum Skill {
  NONE,
  COMBAT, // This is a helper which incorporates all combat skills, attack <-> magic, defence, health etc
  MELEE,
  RANGED,
  MAGIC,
  DEFENCE,
  HEALTH,
  RESERVED_COMBAT,
  MINING,
  WOODCUTTING,
  FISHING,
  SMITHING,
  THIEVING,
  CRAFTING,
  COOKING,
  FIREMAKING,
  FARMING,
  ALCHEMY,
  FLETCHING,
  FORGING,
  RESERVED2,
  RESERVED3,
  RESERVED4,
  RESERVED5,
  RESERVED6,
  RESERVED7,
  RESERVED8,
  RESERVED9,
  RESERVED10,
  RESERVED11,
  RESERVED12,
  RESERVED13,
  RESERVED14,
  RESERVED15,
  RESERVED16,
  RESERVED17,
  RESERVED18,
  RESERVED19,
  RESERVED20,
  TRAVELING // Helper Skill for travelling
}

struct Attire {
  uint16 head;
  uint16 neck;
  uint16 body;
  uint16 arms;
  uint16 legs;
  uint16 feet;
  uint16 ring;
  uint16 reserved1;
}

struct CombatStats {
  // From skill points
  int16 meleeAttack;
  int16 magicAttack;
  int16 rangedAttack;
  int16 health;
  // These include equipment
  int16 meleeDefence;
  int16 magicDefence;
  int16 rangedDefence;
}

enum CombatStyle {
  NONE,
  ATTACK,
  DEFENCE
}

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

import {Skill} from "./misc.sol";

enum PetSkin {
  NONE,
  DEFAULT,
  OG,
  ONEKIN,
  FROST,
  CRYSTAL,
  ANNIV1,
  KRAGSTYR
}

enum PetEnhancementType {
  NONE,
  MELEE,
  MAGIC,
  RANGED,
  DEFENCE,
  HEALTH,
  MELEE_AND_DEFENCE,
  MAGIC_AND_DEFENCE,
  RANGED_AND_DEFENCE
}

struct Pet {
  Skill skillEnhancement1;
  uint8 skillFixedEnhancement1;
  uint8 skillPercentageEnhancement1;
  Skill skillEnhancement2;
  uint8 skillFixedEnhancement2;
  uint8 skillPercentageEnhancement2;
  uint40 lastAssignmentTimestamp;
  address owner; // Will be used as an optimization to avoid having to look up the owner of the pet in another storage slot
  bool isTransferable;
  // New storage slot
  uint24 baseId;
  // These are used when training a pet
  uint40 lastTrainedTimestamp;
  uint8 skillFixedEnhancementMax1; // The maximum possible value for skillFixedEnhancement1 when training
  uint8 skillFixedEnhancementMax2;
  uint8 skillPercentageEnhancementMax1;
  uint8 skillPercentageEnhancementMax2;
  uint64 xp;
}

struct BasePetMetadata {
  string description;
  uint8 tier;
  PetSkin skin;
  PetEnhancementType enhancementType;
  Skill skillEnhancement1;
  uint8 skillFixedMin1;
  uint8 skillFixedMax1;
  uint8 skillFixedIncrement1;
  uint8 skillPercentageMin1;
  uint8 skillPercentageMax1;
  uint8 skillPercentageIncrement1;
  uint8 skillMinLevel1;
  Skill skillEnhancement2;
  uint8 skillFixedMin2;
  uint8 skillFixedMax2;
  uint8 skillFixedIncrement2;
  uint8 skillPercentageMin2;
  uint8 skillPercentageMax2;
  uint8 skillPercentageIncrement2;
  uint8 skillMinLevel2;
  uint16 fixedStarThreshold;
  uint16 percentageStarThreshold;
  bool isTransferable;
}

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

import {QueuedAction} from "./actions.sol";
import {Skill, BoostType, CombatStats, Equipment} from "./misc.sol";
import {PlayerQuest} from "./quests.sol";

// 4 bytes for each level. 0x00000000 is the first level, 0x00000054 is the second, etc.
bytes constant XP_BYTES = hex"0000000000000054000000AE0000010E00000176000001E60000025E000002DE00000368000003FD0000049B00000546000005FC000006C000000792000008730000096400000A6600000B7B00000CA400000DE100000F36000010A200001229000013CB0000158B0000176B0000196E00001B9400001DE20000205A000022FF000025D5000028DD00002C1E00002F99000033540000375200003B9A000040300000451900004A5C00004FFF0000560900005C810000637000006ADD000072D100007B570000847900008E42000098BE0000A3F90000B0020000BCE70000CAB80000D9860000E9630000FA6200010C990001201D0001350600014B6F0001637300017D2E000198C10001B64E0001D5F80001F7E600021C430002433B00026CFD000299BE0002C9B30002FD180003342B00036F320003AE730003F23D00043AE3000488BE0004DC2F0005359B000595700005FC2400066A360006E02D00075E990007E6160008774C000912EB0009B9B4000A6C74000B2C06000BF956000CD561000DC134000EBDF3000FCCD40010EF2400122648001373BF0014D9230016582C0017F2B00019AAA9001B8234001D7B95001F99390021DDBC00244BE60026E6B60029B15F002CAF51002FE43A0033540D00370303003AF5A4003F30CC0043B9B0004895E3004DCB600053609100595C53005FC6030066A585006E034D0075E86C007E5E980087703B0091287D009B935300A6BD8F00B2B4EE00BF882800CD470500DC026F00EBCC8500FCB8B7010EDBD5";
uint256 constant MAX_LEVEL = 140; // Original max level
uint256 constant MAX_LEVEL_1 = 160; // TODO: Update later
uint256 constant MAX_LEVEL_2 = 190; // TODO: Update later

enum EquipPosition {
  NONE,
  HEAD,
  NECK,
  BODY,
  ARMS,
  LEGS,
  FEET,
  RING,
  SPARE2,
  LEFT_HAND,
  RIGHT_HAND,
  BOTH_HANDS,
  QUIVER,
  MAGIC_BAG,
  FOOD,
  AUX, // wood, seeds  etc..
  BOOST_VIAL,
  EXTRA_BOOST_VIAL,
  GLOBAL_BOOST_VIAL,
  CLAN_BOOST_VIAL,
  PASSIVE_BOOST_VIAL,
  LOCKED_VAULT,
  TERRITORY
}

struct Player {
  uint40 currentActionStartTimestamp; // The in-progress start time of the first queued action
  Skill currentActionProcessedSkill1; // The skill that the queued action has already gained XP in
  uint24 currentActionProcessedXPGained1; // The amount of XP that the queued action has already gained
  Skill currentActionProcessedSkill2;
  uint24 currentActionProcessedXPGained2;
  Skill currentActionProcessedSkill3;
  uint24 currentActionProcessedXPGained3;
  uint16 currentActionProcessedFoodConsumed;
  uint16 currentActionProcessedBaseInputItemsConsumedNum; // e.g scrolls, crafting materials etc
  Skill skillBoosted1; // The first skill that is boosted
  Skill skillBoosted2; // The second skill that is boosted (if applicable)
  uint48 totalXP;
  uint16 totalLevel; // Doesn't not automatically add new skills to it
  bytes1 packedData; // Contains worldLocation in first 6 bits (0 is the main starting randomnessBeacon), and full mode unlocked in the upper most bit
  // TODO: Can be up to 7
  QueuedAction[] actionQueue;
  string name; // Raw name
}

struct Item {
  EquipPosition equipPosition;
  bytes1 packedData; // 0x1 exists, upper most bit is full mode
  uint16 questPrerequisiteId;
  // Can it be transferred?
  bool isTransferable; // TODO: Move into packedData
  // Food
  uint16 healthRestored;
  // Boost vial
  BoostType boostType;
  uint16 boostValue; // Varies, could be the % increase
  uint24 boostDuration; // How long the effect of the boost last
  // Combat stats
  int16 meleeAttack;
  int16 magicAttack;
  int16 rangedAttack;
  int16 meleeDefence;
  int16 magicDefence;
  int16 rangedDefence;
  int16 health;
  // Minimum requirements in this skill to use this item (can be NONE)
  Skill skill;
  uint32 minXP;
}

// Used for events and also things like extra boost info
struct BoostInfo {
  uint40 startTime;
  uint24 duration;
  uint16 value;
  uint16 itemTokenId; // Get the effect of it
  BoostType boostType;
}

struct StandardBoostInfo {
  uint40 startTime;
  uint24 duration;
  uint16 value;
  uint16 itemTokenId; // Get the effect of it
  BoostType boostType;
  // Another boost slot for storing the last boost someone had active
  uint40 lastStartTime;
  uint24 lastDuration;
  uint16 lastValue;
  uint16 lastItemTokenId;
  BoostType lastBoostType;
  uint40 cooldown; // Just put here for packing
}

struct ExtendedBoostInfo {
  uint40 startTime;
  uint24 duration;
  uint16 value;
  uint16 itemTokenId; // Get the effect of it
  BoostType boostType;
  // Last boost
  uint40 lastStartTime;
  uint24 lastDuration;
  uint16 lastValue;
  uint16 lastItemTokenId;
  BoostType lastBoostType;
  // Others
  uint40 cooldown; // Just put here for packing
  bytes1 packedData; // 1st bit is hasExtraBoost. This is typically for a wish boost. Gas optimization to read this first
  // New storage slot for another boost (only wish boost for heroes currently)
  uint40 extraStartTime;
  uint24 extraDuration;
  uint16 extraValue;
  uint16 extraItemTokenId;
  BoostType extraBoostType;
  // Last extra boost
  uint40 lastExtraStartTime;
  uint24 lastExtraDuration;
  uint16 lastExtraValue;
  uint16 lastExtraItemTokenId;
  BoostType lastExtraBoostType;
}

// This is effectively a ratio to produce 1 of outputTokenId.
// Available choices that can be undertaken for an action
struct ActionChoiceInput {
  uint8 skill; // Skill that this action choice is related to
  uint24 rate; // Rate of output produced per hour (base 1000) 3 decimals
  uint24 xpPerHour;
  uint16[] inputTokenIds;
  uint24[] inputAmounts;
  uint16 outputTokenId;
  uint8 outputAmount;
  uint8 successPercent; // 0-100
  uint16 handItemTokenIdRangeMin; // Inclusive
  uint16 handItemTokenIdRangeMax; // Inclusive
  bool isFullModeOnly;
  bool isAvailable;
  uint16 questPrerequisiteId;
  uint8[] skills; // Skills required to do this action choice
  uint32[] skillMinXPs; // Min XP in the corresponding skills to be able to do this action choice
  int16[] skillDiffs; // How much the skill is increased/decreased by this action choice
}

struct ActionChoice {
  uint8 skill; // Skill that this action choice is related to
  uint24 rate; // Rate of output produced per hour (base 1000) 3 decimals
  uint24 xpPerHour;
  uint16 inputTokenId1;
  uint24 inputAmount1;
  uint16 inputTokenId2;
  uint24 inputAmount2;
  uint16 inputTokenId3;
  uint24 inputAmount3;
  uint16 outputTokenId;
  uint8 outputAmount;
  uint8 successPercent; // 0-100
  uint8 skill1; // Skills required to do this action choice, commonly the same as skill
  uint32 skillMinXP1; // Min XP in the skill to be able to do this action choice
  int16 skillDiff1; // How much the skill is increased/decreased by this action choice
  uint8 skill2;
  uint32 skillMinXP2;
  int16 skillDiff2;
  uint8 skill3;
  uint32 skillMinXP3;
  int16 skillDiff3;
  uint16 handItemTokenIdRangeMin; // Inclusive
  uint16 handItemTokenIdRangeMax; // Inclusive
  uint16 questPrerequisiteId;
  // FullMode is last bit, first 6 bits is worldLocation,
  // 2nd last bit is if there are other skills in next storage slot to check,
  // 3rd last bit if the input amounts should be used
  bytes1 packedData;
}

// Must be in the same order as Skill enum
struct PackedXP {
  uint40 melee;
  uint40 ranged;
  uint40 magic;
  uint40 defence;
  uint40 health;
  uint40 reservedCombat;
  bytes2 packedDataIsMaxed; // 2 bits per skill to indicate whether the maxed skill is reached. I think this was added in case we added a new max level which a user had already passed so old & new levels are the same and it would not trigger a level up event.
  // Next slot
  uint40 mining;
  uint40 woodcutting;
  uint40 fishing;
  uint40 smithing;
  uint40 thieving;
  uint40 crafting;
  bytes2 packedDataIsMaxed1; // 2 bits per skill to indicate whether the maxed skill is reached
  // Next slot
  uint40 cooking;
  uint40 firemaking;
  uint40 farming;
  uint40 alchemy;
  uint40 fletching;
  uint40 forging;
  bytes2 packedDataIsMaxed2; // 2 bits per skill to indicate whether the maxed skill is reached
}

struct AvatarInfo {
  string name;
  string description;
  string imageURI;
  Skill[2] startSkills; // Can be NONE
}

struct PastRandomRewardInfo {
  uint16 itemTokenId;
  uint24 amount;
  uint64 queueId;
}

struct PendingQueuedActionEquipmentState {
  uint256[] consumedItemTokenIds;
  uint256[] consumedAmounts;
  uint256[] producedItemTokenIds;
  uint256[] producedAmounts;
}

struct PendingQueuedActionMetadata {
  uint32 xpGained; // total xp gained
  uint32 rolls;
  bool died;
  uint16 actionId;
  uint64 queueId;
  uint24 elapsedTime;
  uint24 xpElapsedTime;
  uint8 checkpoint;
}

struct PendingQueuedActionData {
  // The amount of XP that the queued action has already gained
  Skill skill1;
  uint24 xpGained1;
  Skill skill2; // Most likely health
  uint24 xpGained2;
  Skill skill3; // Could come
  uint24 xpGained3;
  // How much food is consumed in the current action so far
  uint16 foodConsumed;
  // How many base consumables are consumed in the current action so far
  uint16 baseInputItemsConsumedNum;
}

struct PendingQueuedActionProcessed {
  // XP gained during this session
  Skill[] skills;
  uint32[] xpGainedSkills;
  // Data for the current action which has been previously processed, this is used to store on the Player
  PendingQueuedActionData currentAction;
}

struct QuestState {
  uint256[] consumedItemTokenIds;
  uint256[] consumedAmounts;
  uint256[] rewardItemTokenIds;
  uint256[] rewardAmounts;
  PlayerQuest[] activeQuestInfo;
  uint256[] questsCompleted;
  Skill[] skills; // Skills gained XP in
  uint32[] xpGainedSkills; // XP gained in these skills
}

struct LotteryWinnerInfo {
  uint16 lotteryId;
  uint24 raffleId;
  uint16 itemTokenId;
  uint16 amount;
  bool instantConsume;
  uint64 playerId;
}

struct PendingQueuedActionState {
  // These 2 are in sync. Separated to reduce gas/deployment costs as these are passed down many layers.
  PendingQueuedActionEquipmentState[] equipmentStates;
  PendingQueuedActionMetadata[] actionMetadatas;
  QueuedAction[] remainingQueuedActions;
  PastRandomRewardInfo[] producedPastRandomRewards;
  uint256[] xpRewardItemTokenIds;
  uint256[] xpRewardAmounts;
  uint256[] dailyRewardItemTokenIds;
  uint256[] dailyRewardAmounts;
  PendingQueuedActionProcessed processedData;
  bytes32 dailyRewardMask;
  QuestState quests;
  uint256 numPastRandomRewardInstancesToRemove;
  uint8 worldLocation;
  LotteryWinnerInfo lotteryWinner;
}

struct FullAttireBonusInput {
  Skill skill;
  uint8 bonusXPPercent;
  uint8 bonusRewardsPercent; // 3 = 3%
  uint16[5] itemTokenIds; // 0 = head, 1 = body, 2 arms, 3 body, 4 = feet
}

// Contains everything you need to create an item
struct ItemInput {
  CombatStats combatStats;
  uint16 tokenId;
  EquipPosition equipPosition;
  bool isTransferable;
  bool isFullModeOnly;
  bool isAvailable;
  uint16 questPrerequisiteId;
  // Minimum requirements in this skill
  Skill skill;
  uint32 minXP;
  // Food
  uint16 healthRestored;
  // Boost
  BoostType boostType;
  uint16 boostValue; // Varies, could be the % increase
  uint24 boostDuration; // How long the effect of the boost vial last
  // uri
  string metadataURI;
  string name;
}

/* Order head, neck, body, arms, legs, feet, ring, reserved1,
   leftHandEquipment, rightHandEquipment,
   Not used yet: input1, input2,input3, regenerate, reserved2, reserved3 */
struct CheckpointEquipments {
  uint16[16] itemTokenIds;
  uint16[16] balances;
}

struct ActivePlayerInfo {
  uint64 playerId;
  uint40 checkpoint;
  uint24 timespan;
  uint24 timespan1;
  uint24 timespan2;
}

uint8 constant START_LEVEL = 17; // Needs updating when there is a new skill. Only useful for new heroes.

uint256 constant MAX_UNIQUE_TICKETS = 64;
// Used in a bunch of places
uint256 constant IS_FULL_MODE_BIT = 7;

// Passive/Instant/InstantVRF/Actions/ActionChoices/Item action
uint256 constant IS_AVAILABLE_BIT = 6;

// Passive actions
uint256 constant HAS_RANDOM_REWARDS_BIT = 5;

// The rest use world location for first 4 bits

// Queued action
uint256 constant HAS_PET_BIT = 2;
uint256 constant IS_VALID_BIT = 1;

// Player Boost
uint256 constant HAS_EXTRA_BOOST_BIT = 1;
uint256 constant BOOST_VERSION_BIT = 0;

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

enum Promotion {
  NONE,
  STARTER,
  HALLOWEEN_2023,
  XMAS_2023,
  HALLOWEEN_2024,
  HOLIDAY4, // Just have placeholders for now
  HOLIDAY5,
  HOLIDAY6,
  HOLIDAY7,
  HOLIDAY8,
  HOLIDAY9,
  HOLIDAY10
}

enum PromotionMintStatus {
  NONE,
  SUCCESS,
  PROMOTION_ALREADY_CLAIMED,
  ORACLE_NOT_CALLED,
  MINTING_OUTSIDE_AVAILABLE_DATE,
  PLAYER_DOES_NOT_QUALIFY,
  PLAYER_NOT_HIT_ENOUGH_CLAIMS_FOR_STREAK_BONUS,
  DEPENDENT_QUEST_NOT_COMPLETED
}

struct PromotionInfoInput {
  Promotion promotion;
  uint40 startTime;
  uint40 endTime; // Exclusive
  uint8 numDailyRandomItemsToPick; // Number of items to pick
  uint40 minTotalXP; // Minimum xp required to claim
  uint256 tokenCost; // Cost in brush to start the promotion, max 16mil
  // Special promotion specific (like 1kin)
  uint8 redeemCodeLength; // Length of the redeem code
  bool adminOnly; // Only admins can mint the promotion, like for 1kin (Not used yet)
  bool promotionTiedToUser; // If the promotion is tied to a user
  bool promotionTiedToPlayer; // If the promotion is tied to the player
  bool promotionMustOwnPlayer; // Must own the player to get the promotion
  // Evolution specific
  bool evolvedHeroOnly; // Only allow evolved heroes to claim
  // Multiday specific
  bool isMultiday; // The promotion is multi-day
  uint256 brushCostMissedDay; // Cost in brush to mint the promotion if they miss a day (in ether), max 25.6 (base 100)
  uint8 numDaysHitNeededForStreakBonus; // How many days to hit for the streak bonus
  uint8 numDaysClaimablePeriodStreakBonus; // If there is a streak bonus, how many days to claim it after the promotion ends. If no final day bonus, set to 0
  uint8 numRandomStreakBonusItemsToPick1; // Number of items to pick for the streak bonus
  uint8 numRandomStreakBonusItemsToPick2; // Number of random items to pick for the streak bonus
  uint16[] randomStreakBonusItemTokenIds1;
  uint32[] randomStreakBonusAmounts1;
  uint16[] randomStreakBonusItemTokenIds2;
  uint32[] randomStreakBonusAmounts2;
  uint16[] guaranteedStreakBonusItemTokenIds;
  uint16[] guaranteedStreakBonusAmounts;
  // Single and multiday
  uint16[] guaranteedItemTokenIds; // Guaranteed items for the promotions each day, if empty then they are handled in a specific way for the promotion like daily rewards
  uint32[] guaranteedAmounts; // Corresponding amounts to the itemTokenIds
  uint16[] randomItemTokenIds; // Possible items for the promotions each day, if empty then they are handled in a specific way for the promotion like daily rewards
  uint32[] randomAmounts; // Corresponding amounts to the randomItemTokenIds
  // Quests
  uint16 questPrerequisiteId;
}

struct PromotionInfo {
  Promotion promotion;
  uint40 startTime;
  uint8 numDays;
  uint8 numDailyRandomItemsToPick; // Number of items to pick
  uint40 minTotalXP; // Minimum xp required to claim
  uint24 tokenCost; // Cost in brush to mint the promotion (in ether), max 16mil
  // Quests
  uint16 questPrerequisiteId;
  // Special promotion specific (like 1kin), could pack these these later
  uint8 redeemCodeLength; // Length of the redeem code
  bool adminOnly; // Only admins can mint the promotion, like for 1kin
  bool promotionTiedToUser; // If the promotion is tied to a user
  bool promotionTiedToPlayer; // If the promotion is tied to the player
  bool promotionMustOwnPlayer; // Must own the player to get the promotion
  // Evolution specific
  bool evolvedHeroOnly; // Only allow evolved heroes to claim
  // Multiday specific
  bool isMultiday; // The promotion is multi-day
  uint8 brushCostMissedDay; // Cost in brush to mint the promotion if they miss a day (in ether), max 25.5, base 100
  uint8 numDaysHitNeededForStreakBonus; // How many days to hit for the streak bonus
  uint8 numDaysClaimablePeriodStreakBonus; // If there is a streak bonus, how many days to claim it after the promotion ends. If no final day bonus, set to 0
  uint8 numRandomStreakBonusItemsToPick1; // Number of items to pick for the streak bonus
  uint8 numRandomStreakBonusItemsToPick2; // Number of random items to pick for the streak bonus
  // Misc
  uint16[] randomStreakBonusItemTokenIds1;
  uint32[] randomStreakBonusAmounts1;
  uint16[] randomStreakBonusItemTokenIds2; // Not used yet
  uint32[] randomStreakBonusAmounts2; // Not used yet
  uint16[] guaranteedStreakBonusItemTokenIds; // Not used yet
  uint16[] guaranteedStreakBonusAmounts; // Not used yet
  // Single and multiday
  uint16[] guaranteedItemTokenIds; // Guaranteed items for the promotions each day, if empty then they are handled in a specific way for the promotion like daily rewards
  uint32[] guaranteedAmounts; // Corresponding amounts to the itemTokenIds
  uint16[] randomItemTokenIds; // Possible items for the promotions each day, if empty then they are handled in a specific way for the promotion like daily rewards
  uint32[] randomAmounts; // Corresponding amounts to the randomItemTokenIds
}

uint256 constant BRUSH_COST_MISSED_DAY_MUL = 10;

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

import {Skill} from "./misc.sol";

struct QuestInput {
  uint16 dependentQuestId; // The quest that must be completed before this one can be started
  uint16 actionId1; // action to do
  uint16 actionNum1; // how many (up to 65535)
  uint16 actionId2; // another action to do
  uint16 actionNum2; // how many (up to 65535)
  uint16 actionChoiceId; // actionChoice to perform
  uint16 actionChoiceNum; // how many to do (base number), (up to 65535)
  Skill skillReward; // The skill to reward XP to
  uint24 skillXPGained; // The amount of XP to give (up to 65535)
  uint16 rewardItemTokenId1; // Reward an item
  uint16 rewardAmount1; // amount of the reward (up to 65535)
  uint16 rewardItemTokenId2; // Reward another item
  uint16 rewardAmount2; // amount of the reward (up to 65535)
  uint16 burnItemTokenId; // Burn an item
  uint16 burnAmount; // amount of the burn (up to 65535)
  uint16 questId; // Unique id for this quest
  bool isFullModeOnly; // If true this quest requires the user be evolved
  uint8 worldLocation; // 0 is the main starting world
}

struct Quest {
  uint16 dependentQuestId; // The quest that must be completed before this one can be started
  uint16 actionId1; // action to do
  uint16 actionNum1; // how many (up to 65535)
  uint16 actionId2; // another action to do
  uint16 actionNum2; // how many (up to 65535)
  uint16 actionChoiceId; // actionChoice to perform
  uint16 actionChoiceNum; // how many to do (base number), (up to 65535)
  Skill skillReward; // The skill to reward XP to
  uint24 skillXPGained; // The amount of XP to give (up to 65535)
  uint16 rewardItemTokenId1; // Reward an item
  uint16 rewardAmount1; // amount of the reward (up to 65535)
  uint16 rewardItemTokenId2; // Reward another item
  uint16 rewardAmount2; // amount of the reward (up to 65535)
  uint16 burnItemTokenId; // Burn an item
  uint16 burnAmount; // amount of the burn (up to 65535)
  uint16 reserved; // Reserved for future use (previously was questId and cleared)
  bytes1 packedData; // FullMode is last bit, first 6 bits is worldLocation
}

struct PlayerQuest {
  uint32 questId;
  uint16 actionCompletedNum1;
  uint16 actionCompletedNum2;
  uint16 actionChoiceCompletedNum;
  uint16 burnCompletedAmount;
}

uint256 constant QUEST_PURSE_STRINGS = 5; // MAKE SURE THIS MATCHES definitions

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

import {BoostType, Equipment} from "./misc.sol";

struct GuaranteedReward {
  uint16 itemTokenId;
  uint16 rate; // num per hour (base 10, 1 decimal) for actions and num per duration for passive actions
}

struct RandomReward {
  uint16 itemTokenId;
  uint16 chance; // out of 65535
  uint8 amount; // out of 255
}

struct PendingRandomReward {
  uint16 actionId;
  uint40 startTime;
  uint24 xpElapsedTime;
  uint16 boostItemTokenId;
  uint24 elapsedTime;
  uint40 boostStartTime; // When the boost was started
  uint24 sentinelElapsedTime;
  // Full equipment at the time this was generated
  uint8 fullAttireBonusRewardsPercent;
  uint64 queueId; // TODO: Could reduce this if more stuff is needed
}

struct ActionRewards {
  uint16 guaranteedRewardTokenId1;
  uint16 guaranteedRewardRate1; // Num per hour base 10 (1 decimal) for actions (Max 6553.5 per hour), num per duration for passive actions
  uint16 guaranteedRewardTokenId2;
  uint16 guaranteedRewardRate2;
  uint16 guaranteedRewardTokenId3;
  uint16 guaranteedRewardRate3;
  // Random chance rewards
  uint16 randomRewardTokenId1;
  uint16 randomRewardChance1; // out of 65535
  uint8 randomRewardAmount1; // out of 255
  uint16 randomRewardTokenId2;
  uint16 randomRewardChance2;
  uint8 randomRewardAmount2;
  uint16 randomRewardTokenId3;
  uint16 randomRewardChance3;
  uint8 randomRewardAmount3;
  uint16 randomRewardTokenId4;
  uint16 randomRewardChance4;
  uint8 randomRewardAmount4;
  // No more room in this storage slot!
}

struct XPThresholdReward {
  uint32 xpThreshold;
  Equipment[] rewards;
}

enum InstantVRFActionType {
  NONE,
  GENERIC,
  FORGING,
  EGG
}

struct InstantVRFActionInput {
  uint16 actionId;
  uint16[] inputTokenIds;
  uint24[] inputAmounts;
  bytes data;
  InstantVRFActionType actionType;
  bool isFullModeOnly;
  bool isAvailable;
  uint16 questPrerequisiteId;
}

struct InstantVRFRandomReward {
  uint16 itemTokenId;
  uint16 chance; // out of 65535
  uint16 amount; // out of 65535
}

uint256 constant MAX_GUARANTEED_REWARDS_PER_ACTION = 3;
uint256 constant MAX_RANDOM_REWARDS_PER_ACTION = 4;
uint256 constant MAX_REWARDS_PER_ACTION = MAX_GUARANTEED_REWARDS_PER_ACTION + MAX_RANDOM_REWARDS_PER_ACTION;
uint256 constant MAX_CONSUMED_PER_ACTION = 3;
uint256 constant MAX_QUEST_REWARDS = 2;

uint256 constant TIER_1_DAILY_REWARD_START_XP = 0;
uint256 constant TIER_2_DAILY_REWARD_START_XP = 7_650;
uint256 constant TIER_3_DAILY_REWARD_START_XP = 33_913;
uint256 constant TIER_4_DAILY_REWARD_START_XP = 195_864;
uint256 constant TIER_5_DAILY_REWARD_START_XP = 784_726;
uint256 constant TIER_6_DAILY_REWARD_START_XP = 2_219_451;

// 4 bytes for each threshold, starts at 500 xp in decimal
bytes constant XP_THRESHOLD_REWARDS = hex"00000000000001F4000003E8000009C40000138800002710000075300000C350000186A00001D4C0000493E0000557300007A120000927C0000B71B0000DBBA0000F424000124F800016E360001B7740001E8480002625A0002932E0002DC6C0003567E0003D0900004C4B40005B8D80006ACFC0007A1200008954400098968000A7D8C000B71B0000C65D4000D59F8000E4E1C0";

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

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

interface IBrushToken is IERC20 {
  function burn(uint256 amount) external;

  function burnFrom(address account, uint256 amount) external;

  function transferFromBulk(address from, address[] calldata tos, uint256[] calldata amounts) external;

  function transferOwnership(address newOwner) external;
}

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

interface IMarketplaceWhitelist {
  function isWhitelisted(address nft) external view returns (bool);
}

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

interface IBank {
  function initialize() external;

  function initializeAddresses(
    uint256 clanId,
    address bankRegistry,
    address bankRelay,
    address playerNFT,
    address itemNFT,
    address clans,
    address players,
    address lockedBankVaults,
    address raids
  ) external;

  function depositToken(address sender, address from, uint256 playerId, address token, uint256 amount) external;

  function setAllowBreachedCapacity(bool allow) external;
}

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

interface IBankFactory {
  function getBankAddress(uint256 clanId) external view returns (address);

  function getCreatedHere(address bank) external view returns (bool);

  function createBank(address from, uint256 clanId) external returns (address);
}

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

interface IClanMemberLeftCB {
  function clanMemberLeft(uint256 clanId, uint256 playerId) external;
}

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

import {ClanRank} from "../globals/clans.sol";

interface IClans {
  function canWithdraw(uint256 clanId, uint256 playerId) external view returns (bool);

  function isClanMember(uint256 clanId, uint256 playerId) external view returns (bool);

  function maxBankCapacity(uint256 clanId) external view returns (uint16);

  function maxMemberCapacity(uint256 clanId) external view returns (uint16);

  function getRank(uint256 clanId, uint256 playerId) external view returns (ClanRank);

  function setMMR(uint256 clanId, uint16 mmr) external;

  function getMMR(uint256 clanId) external view returns (uint16);

  function addXP(uint256 clanId, uint40 xp, bool xpEmittedElsewhere) external;

  function getClanBankAddress(uint256 clanId) external view returns (address);
}

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

interface ICombatants {
  function isCombatant(uint256 clanId, uint256 playerId) external view returns (bool);

  function assignCombatants(
    uint256 clanId,
    uint64[] calldata playerIds,
    uint256 combatantCooldownTimestamp,
    uint256 leaderPlayerId
  ) external;
}

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

import {Item} from "../globals/players.sol";

interface IItemNFT {
  function balanceOfs(address account, uint16[] memory ids) external view returns (uint256[] memory);

  function balanceOfs10(address account, uint16[10] memory ids) external view returns (uint256[] memory);

  function balanceOf(address account, uint256 id) external view returns (uint256);

  function getItem(uint16 tokenId) external view returns (Item memory);

  function getItems(uint16[] calldata tokenIds) external view returns (Item[] memory);

  function totalSupply(uint256 id) external view returns (uint256); // ERC1155Supply

  function totalSupply() external view returns (uint256); // ERC1155Supply

  function mint(address to, uint256 id, uint256 quantity) external;

  function mintBatch(address to, uint256[] calldata ids, uint256[] calldata quantities) external;

  function burn(address account, uint256 id, uint256 value) external;

  function burnBatch(address account, uint256[] calldata ids, uint256[] calldata values) external;

  function getTimestampFirstMint(uint256 id) external view returns (uint256);

  function exists(uint256 id) external view returns (bool);
}

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

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

interface ILockedBankVaults is ICombatants {}

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

import "../globals/misc.sol";
import "../globals/players.sol";

interface IPlayers {
  function clearEverythingBeforeTokenTransfer(address from, uint256 tokenId) external;

  function beforeTokenTransferTo(address to, uint256 tokenId) external;

  function getURI(
    uint256 playerId,
    string calldata name,
    string calldata avatarName,
    string calldata avatarDescription,
    string calldata imageURI
  ) external view returns (string memory);

  function mintedPlayer(
    address from,
    uint256 playerId,
    Skill[2] calldata startSkills,
    bool makeActive,
    uint256[] calldata startingItemTokenIds,
    uint256[] calldata startingAmounts
  ) external;

  function upgradePlayer(uint256 playerId) external;

  function isPlayerEvolved(uint256 playerId) external view returns (bool);

  function isOwnerOfPlayerAndActive(address from, uint256 playerId) external view returns (bool);

  function getAlphaCombatParams() external view returns (uint8 alphaCombat, uint8 betaCombat, uint8 alphaCombatHealing);

  function getActivePlayer(address owner) external view returns (uint256 playerId);

  function getPlayerXP(uint256 playerId, Skill skill) external view returns (uint256 xp);

  function getLevel(uint256 playerId, Skill skill) external view returns (uint256 level);

  function getTotalXP(uint256 playerId) external view returns (uint256 totalXP);

  function getTotalLevel(uint256 playerId) external view returns (uint256 totalLevel);

  function getActiveBoost(uint256 playerId) external view returns (ExtendedBoostInfo memory);

  function modifyXP(address from, uint256 playerId, Skill skill, uint56 xp, bool skipEffects) external;

  function beforeItemNFTTransfer(address from, address to, uint256[] calldata ids, uint256[] calldata amounts) external;
}

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

interface ISamWitchVRF {
  function requestRandomWords(uint256 numWords, uint256 callbackGasLimit) external returns (bytes32 requestId);

  function fulfillRandomWords(
    bytes32 requestId,
    address oracle,
    address fulfillAddress,
    uint256 callbackGasLimit,
    uint256 numWords,
    uint256[2] calldata publicKey,
    uint256[4] calldata proof,
    uint256[2] calldata uPoint,
    uint256[4] calldata vComponents
  ) external returns (bool callSuccess);
}

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

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

interface ITerritories is ICombatants {
  function addUnclaimedEmissions(uint256 amount) external;
}

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

import {CombatStats, Skill} from "../globals/misc.sol";
import {ActionChoice} from "../globals/players.sol";
import {ActionRewards} from "../globals/rewards.sol";
import {ActionInfo} from "../globals/actions.sol";

interface IWorldActions {
  function getXPPerHour(uint16 actionId, uint16 actionChoiceId) external view returns (uint24 xpPerHour);

  function getNumSpawn(uint16 actionId) external view returns (uint256 numSpawned);

  function getActionSuccessPercentAndMinXP(uint16 actionId) external view returns (uint8 successPercent, uint32 minXP);

  function getCombatStats(uint16 actionId) external view returns (CombatStats memory stats);

  function getActionChoice(uint16 actionId, uint16 choiceId) external view returns (ActionChoice memory choice);

  function getRewardsHelper(
    uint16 actionId
  ) external view returns (ActionRewards memory, Skill skill, uint256 numSpawned); // , uint8 worldLocation);

  function getSkill(uint256 actionId) external view returns (Skill skill);

  function getActionRewards(uint256 actionId) external view returns (ActionRewards memory);

  function getActionInfo(uint256 actionId) external view returns (ActionInfo memory info);
}

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

import {ERC1155Upgradeable} from "@openzeppelin/contracts-upgradeable/token/ERC1155/ERC1155Upgradeable.sol";

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

import {IItemNFT} from "./interfaces/IItemNFT.sol";
import {IPlayers} from "./interfaces/IPlayers.sol";
import {ItemNFTLibrary} from "./ItemNFTLibrary.sol";
import {IBankFactory} from "./interfaces/IBankFactory.sol";
import {AdminAccess} from "./AdminAccess.sol";

import {BoostType, BulkTransferInfo, CombatStats, EquipPosition, Item, ItemInput, Skill, IS_FULL_MODE_BIT, IS_AVAILABLE_BIT} from "./globals/all.sol";

// The NFT contract contains data related to the items and who owns them
contract ItemNFT is UUPSUpgradeable, OwnableUpgradeable, ERC1155Upgradeable, IERC2981, IItemNFT {
  event AddItems(ItemInput[] items);
  event EditItems(ItemInput[] items);
  event RemoveItems(uint16[] tokenIds);

  error IdTooHigh();
  error ItemNotTransferable();
  error InvalidTokenId();
  error ItemAlreadyExists();
  error ItemDoesNotExist(uint16);
  error EquipmentPositionShouldNotChange();
  error NotMinter(address minter);
  error NotBurner();
  error LengthMismatch();

  struct ItemInfo {
    uint40 timestampFirstMint;
    uint216 balance; // can be smaller if we want to pack more data
  }

  uint16 private _totalSupplyAll;
  string private _baseURI;

  AdminAccess private _adminAccess;
  bool private _isBeta;
  IBankFactory private _bankFactory;
  IPlayers private _players;

  // Royalties
  address private _royaltyReceiver;
  uint8 private _royaltyFee; // base 1000, highest is 25.5

  mapping(uint256 itemId => ItemInfo itemInfo) private _itemInfos; // (timestampFirstMint, balance)
  mapping(uint256 itemId => string tokenURI) private _tokenURIs;
  mapping(uint256 itemId => CombatStats combatStats) private _combatStats;
  mapping(uint256 itemId => Item item) private _items;
  mapping(address account => bool isApproved) private _approvals;

  modifier onlyMinters() {
    address sender = _msgSender();
    require(_isApproved(sender) || (_adminAccess.isAdmin(sender) && _isBeta), NotMinter(sender));
    _;
  }

  modifier onlyBurners(address from) {
    address sender = _msgSender();
    require(sender == from || isApprovedForAll(from, sender), NotBurner());
    _;
  }

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

  function initialize(
    address royaltyReceiver,
    string calldata baseURI,
    AdminAccess adminAccess,
    bool isBeta
  ) external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();
    __ERC1155_init("");

    _baseURI = baseURI;
    _royaltyFee = 30; // 3%
    _royaltyReceiver = royaltyReceiver;
    _adminAccess = adminAccess;
    _isBeta = isBeta;
  }

  function mint(address to, uint256 tokenId, uint256 amount) external override onlyMinters {
    _mintItem(to, tokenId, amount);
  }

  function mintBatch(address to, uint256[] calldata ids, uint256[] calldata amounts) external override onlyMinters {
    _mintBatchItems(to, ids, amounts);
  }

  function burnBatch(
    address from,
    uint256[] calldata tokenIds,
    uint256[] calldata amounts
  ) external override onlyBurners(from) {
    _burnBatch(from, tokenIds, amounts);
  }

  function burn(address from, uint256 tokenId, uint256 amount) external override onlyBurners(from) {
    _burn(from, tokenId, amount);
  }

  function _getMinRequirement(uint16 tokenId) private view returns (Skill, uint32, bool isFullModeOnly) {
    Item memory item = _items[tokenId];
    return (item.skill, item.minXP, _isItemFullMode(tokenId));
  }

  function _isItemFullMode(uint256 tokenId) private view returns (bool) {
    return uint8(_items[tokenId].packedData >> IS_FULL_MODE_BIT) & 1 == 1;
  }

  // TODO: Not used yet
  function _isItemAvailable(uint16 tokenId) private view returns (bool) {
    return uint8(_items[tokenId].packedData >> IS_AVAILABLE_BIT) & 1 == 1;
  }

  function _premint(uint256 tokenId, uint256 amount) private returns (uint256 numNewUniqueItems) {
    require(tokenId < type(uint16).max, IdTooHigh());
    uint256 existingBalance = _itemInfos[tokenId].balance;
    if (existingBalance == 0) {
      // Brand new item
      _itemInfos[tokenId].timestampFirstMint = uint40(block.timestamp);
      numNewUniqueItems++;
    }
    _itemInfos[tokenId].balance = uint216(existingBalance + amount);
  }

  function _mintItem(address to, uint256 tokenId, uint256 amount) internal {
    uint256 newlyMintedItems = _premint(tokenId, amount);
    if (newlyMintedItems != 0) {
      ++_totalSupplyAll;
    }
    _mint(to, uint256(tokenId), amount, "");
  }

  function _mintBatchItems(address to, uint256[] memory tokenIds, uint256[] memory amounts) internal {
    uint256 numNewItems;
    uint256 tokenIdsLength = tokenIds.length;
    for (uint256 i; i < tokenIdsLength; ++i) {
      numNewItems = numNewItems + _premint(tokenIds[i], amounts[i]);
    }
    if (numNewItems != 0) {
      _totalSupplyAll += uint16(numNewItems);
    }
    _mintBatch(to, tokenIds, amounts, "");
  }

  function safeBulkTransfer(BulkTransferInfo[] calldata nftsInfo) external {
    if (nftsInfo.length == 0) {
      return;
    }
    for (uint256 i = 0; i < nftsInfo.length; ++i) {
      BulkTransferInfo memory nftInfo = nftsInfo[i];
      address to = nftInfo.to;
      if (nftInfo.tokenIds.length == 1) {
        safeTransferFrom(_msgSender(), to, nftInfo.tokenIds[0], nftInfo.amounts[0], "");
      } else {
        safeBatchTransferFrom(_msgSender(), to, nftInfo.tokenIds, nftInfo.amounts, "");
      }
    }
  }

  function _getItem(uint16 tokenId) private view returns (Item storage) {
    require(exists(tokenId), ItemDoesNotExist(tokenId));
    return _items[tokenId];
  }

  // If an item is burnt, remove it from the total
  function _removeAnyBurntFromTotal(uint256[] memory ids, uint256[] memory amounts) private {
    uint256 totalSupplyDelta;
    for (uint256 i = 0; i < ids.length; ++i) {
      uint256 newBalance = _itemInfos[ids[i]].balance - amounts[i];
      if (newBalance == 0) {
        ++totalSupplyDelta;
      }
      _itemInfos[ids[i]].balance = uint216(newBalance);
    }
    _totalSupplyAll -= uint16(totalSupplyDelta);
  }

  function _checkIsTransferable(address from, uint256[] memory ids) private view {
    bool anyNonTransferable;
    for (uint256 i = 0; i < ids.length; ++i) {
      if (exists(ids[i]) && !_items[ids[i]].isTransferable) {
        anyNonTransferable = true;
        break;
      }
    }

    // Check if this is from a bank, that's the only place it's allowed to transfer non-transferable items
    require(!anyNonTransferable || _bankFactory.getCreatedHere(from), ItemNotTransferable());
  }

  function _update(address from, address to, uint256[] memory ids, uint256[] memory amounts) internal virtual override {
    if (amounts.length != 0 && from != to) {
      bool isBurnt = to == address(0) || to == address(0xdEaD);
      bool isMinted = from == address(0);
      if (isBurnt) {
        _removeAnyBurntFromTotal(ids, amounts);
      } else if (!isMinted) {
        _checkIsTransferable(from, ids);
      }
      _players.beforeItemNFTTransfer(from, to, ids, amounts);
    }
    super._update(from, to, ids, amounts);
  }

  function _setItem(ItemInput calldata input) private {
    require(input.tokenId != 0, InvalidTokenId());
    ItemNFTLibrary.setItem(input, _items[input.tokenId]);
    _tokenURIs[input.tokenId] = input.metadataURI;
  }

  function _editItem(ItemInput calldata inputItem) private {
    require(exists(inputItem.tokenId), ItemDoesNotExist(inputItem.tokenId));
    EquipPosition oldPosition = _items[inputItem.tokenId].equipPosition;
    EquipPosition newPosition = inputItem.equipPosition;

    bool isRightHandPositionSwapWithBothHands = (oldPosition == EquipPosition.RIGHT_HAND &&
      newPosition == EquipPosition.BOTH_HANDS) ||
      (oldPosition == EquipPosition.BOTH_HANDS && newPosition == EquipPosition.RIGHT_HAND);

    // Allowed to go from BOTH_HANDS to RIGHT_HAND or RIGHT_HAND to BOTH_HANDS
    require(
      oldPosition == newPosition || oldPosition == EquipPosition.NONE || isRightHandPositionSwapWithBothHands,
      EquipmentPositionShouldNotChange()
    );
    _setItem(inputItem);
  }

  function _isApproved(address account) private view returns (bool) {
    return _approvals[account];
  }

  function uri(uint256 tokenId) public view virtual override returns (string memory) {
    require(exists(tokenId), ItemDoesNotExist(uint16(tokenId)));
    return string(abi.encodePacked(_baseURI, _tokenURIs[tokenId]));
  }

  function exists(uint256 tokenId) public view override returns (bool) {
    return _items[tokenId].packedData != 0;
  }

  function totalSupply(uint256 tokenId) external view override returns (uint256) {
    return _itemInfos[tokenId].balance;
  }

  function totalSupply() external view override returns (uint256) {
    return _totalSupplyAll;
  }

  function getItem(uint16 tokenId) external view override returns (Item memory) {
    return _getItem(tokenId);
  }

  function getItems(uint16[] calldata tokenIds) external view override returns (Item[] memory items) {
    uint256 tokenIdsLength = tokenIds.length;
    items = new Item[](tokenIdsLength);
    for (uint256 i; i < tokenIdsLength; ++i) {
      items[i] = _getItem(tokenIds[i]);
    }
  }

  function getTimestampFirstMint(uint256 tokenId) external view override returns (uint256) {
    return _itemInfos[tokenId].timestampFirstMint;
  }

  function getEquipPositionAndMinRequirement(
    uint16 item
  ) external view returns (Skill skill, uint32 minXP, EquipPosition equipPosition, bool isFullModeOnly) {
    (skill, minXP, isFullModeOnly) = _getMinRequirement(item);
    equipPosition = getEquipPosition(item);
  }

  function getMinRequirements(
    uint16[] calldata tokenIds
  ) external view returns (Skill[] memory skills, uint32[] memory minXPs, bool[] memory isFullModeOnly) {
    skills = new Skill[](tokenIds.length);
    minXPs = new uint32[](tokenIds.length);
    isFullModeOnly = new bool[](tokenIds.length);
    uint256 tokenIdsLength = tokenIds.length;
    for (uint256 i; i < tokenIdsLength; ++i) {
      (skills[i], minXPs[i], isFullModeOnly[i]) = _getMinRequirement(tokenIds[i]);
    }
  }

  function getEquipPositions(uint16[] calldata tokenIds) external view returns (EquipPosition[] memory equipPositions) {
    uint256 tokenIdsLength = tokenIds.length;
    equipPositions = new EquipPosition[](tokenIdsLength);
    for (uint256 i; i < tokenIdsLength; ++i) {
      equipPositions[i] = getEquipPosition(tokenIds[i]);
    }
  }

  function getEquipPosition(uint16 tokenId) public view returns (EquipPosition) {
    require(exists(tokenId), ItemDoesNotExist(uint16(tokenId)));
    return _items[tokenId].equipPosition;
  }

  /**
   * @dev See {IERC1155-balanceOfBatch}. This implementation is not standard ERC1155, it's optimized for the single account case
   */
  function balanceOfs(
    address account,
    uint16[] memory ids
  ) external view override returns (uint256[] memory batchBalances) {
    batchBalances = new uint256[](ids.length);
    for (uint256 i = 0; i < ids.length; ++i) {
      batchBalances[i] = balanceOf(account, ids[i]);
    }
  }

  function balanceOfs10(
    address account,
    uint16[10] memory ids
  ) external view override returns (uint256[] memory batchBalances) {
    batchBalances = new uint256[](ids.length);
    for (uint256 i = 0; i < ids.length; ++i) {
      batchBalances[i] = balanceOf(account, ids[i]);
    }
  }

  function balanceOf(address account, uint256 id) public view override(IItemNFT, ERC1155Upgradeable) returns (uint256) {
    return ERC1155Upgradeable.balanceOf(account, id);
  }

  function royaltyInfo(
    uint256 /*tokenId*/,
    uint256 salePrice
  ) external view override returns (address receiver, uint256 royaltyAmount) {
    uint256 amount = (salePrice * _royaltyFee) / 1000;
    return (_royaltyReceiver, amount);
  }

  function getBoostInfo(
    uint16 tokenId
  ) external view returns (BoostType boostType, uint16 boostValue, uint24 boostDuration) {
    Item storage item = _getItem(tokenId);
    return (item.boostType, item.boostValue, item.boostDuration);
  }

  /**
   * @dev See {IERC1155-isApprovedForAll}.
   */
  function isApprovedForAll(address account, address operator) public view virtual override returns (bool) {
    return super.isApprovedForAll(account, operator) || _approvals[operator];
  }

  function supportsInterface(bytes4 interfaceId) public view override(IERC165, ERC1155Upgradeable) returns (bool) {
    return interfaceId == type(IERC2981).interfaceId || super.supportsInterface(interfaceId);
  }

  function name() external view returns (string memory) {
    return string(abi.encodePacked("Estfor Items", _isBeta ? " (Beta)" : ""));
  }

  function symbol() external view returns (string memory) {
    return string(abi.encodePacked("EK_I", _isBeta ? "B" : ""));
  }

  function addItems(ItemInput[] calldata inputItems) external onlyOwner {
    uint256 length = inputItems.length;
    for (uint256 i; i < length; ++i) {
      require(!exists(inputItems[i].tokenId), ItemAlreadyExists());
      _setItem(inputItems[i]);
    }

    emit AddItems(inputItems);
  }

  function editItems(ItemInput[] calldata inputItems) external onlyOwner {
    for (uint256 i = 0; i < inputItems.length; ++i) {
      _editItem(inputItems[i]);
    }

    emit EditItems(inputItems);
  }

  // This should be only used when an item is not in active use
  // because it could mess up queued actions potentially
  function removeItems(uint16[] calldata itemTokenIds) external onlyOwner {
    for (uint256 i = 0; i < itemTokenIds.length; ++i) {
      require(exists(itemTokenIds[i]), ItemDoesNotExist(itemTokenIds[i]));
      delete _items[itemTokenIds[i]];
      delete _tokenURIs[itemTokenIds[i]];
    }

    emit RemoveItems(itemTokenIds);
  }

  function initializeAddresses(IBankFactory bankFactory, IPlayers players) external onlyOwner {
    _bankFactory = bankFactory;
    _players = players;
  }

  function setApproved(address[] calldata accounts, bool isApproved) external onlyOwner {
    for (uint256 i = 0; i < accounts.length; ++i) {
      _approvals[accounts[i]] = isApproved;
    }
  }

  function setBaseURI(string calldata baseURI) external onlyOwner {
    _baseURI = baseURI;
  }

  function airdrop(address[] calldata tos, uint256 tokenId, uint256[] calldata amounts) external onlyOwner {
    require(tos.length == amounts.length, LengthMismatch());
    for (uint256 i = 0; i < tos.length; ++i) {
      _mintItem(tos[i], tokenId, amounts[i]);
    }
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

// solhint-disable-next-line no-global-import
import "./globals/players.sol";

// This file contains methods for interacting with the item NFT, used to decrease implementation deployment bytecode code.
library ItemNFTLibrary {
  function setItem(ItemInput calldata inputItem, Item storage item) external {
    bool hasCombat;
    CombatStats calldata combatStats = inputItem.combatStats;
    assembly ("memory-safe") {
      hasCombat := not(iszero(combatStats))
    }
    item.equipPosition = inputItem.equipPosition;
    item.isTransferable = inputItem.isTransferable;

    bytes1 packedData = bytes1(uint8(0x1)); // Exists
    packedData = packedData | bytes1(uint8(inputItem.isFullModeOnly ? 1 << IS_FULL_MODE_BIT : 0));
    if (inputItem.isAvailable) {
      packedData |= bytes1(uint8(1 << IS_AVAILABLE_BIT));
    }

    item.packedData = packedData;

    item.questPrerequisiteId = inputItem.questPrerequisiteId;

    if (hasCombat) {
      // Combat stats
      item.meleeAttack = inputItem.combatStats.meleeAttack;
      item.rangedAttack = inputItem.combatStats.rangedAttack;
      item.magicAttack = inputItem.combatStats.magicAttack;
      item.meleeDefence = inputItem.combatStats.meleeDefence;
      item.rangedDefence = inputItem.combatStats.rangedDefence;
      item.magicDefence = inputItem.combatStats.magicDefence;
      item.health = inputItem.combatStats.health;
    }

    if (inputItem.healthRestored != 0) {
      item.healthRestored = inputItem.healthRestored;
    }

    if (inputItem.boostType != BoostType.NONE) {
      item.boostType = inputItem.boostType;
      item.boostValue = inputItem.boostValue;
      item.boostDuration = inputItem.boostDuration;
    }

    item.minXP = inputItem.minXP;
    item.skill = inputItem.skill;
  }
}

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

import "@openzeppelin/contracts/utils/structs/BitMaps.sol";

library BloomFilter {
  using BitMaps for BitMaps.BitMap;

  struct Filter {
    uint8 hashCount; // Number of hash functions to use
    uint64 bitCount; // Number of bits in the bitmap
    BitMaps.BitMap bitmap; // Bitmap using OpenZeppelin’s BitMaps library to support up to 65,536 bits
  }

  error ZeroHashCount();

  /**
   * @notice Calculates the optimal number of hash functions based on the expected number of items.
   * @param expectedItems Expected number of items to be added to the filter.
   * @param bitCount Number of bits in the bitmap.
   * @return hashCount The number of hash functions to be used.
   */
  function _getOptimalHashCount(uint256 expectedItems, uint64 bitCount) internal pure returns (uint8 hashCount) {
    uint256 calculatedHashCount = (bitCount * 144) / (expectedItems * 100) + 1;
    hashCount = calculatedHashCount < 256 ? uint8(calculatedHashCount) : 255;
  }

  /**
   * @notice Adds a `bytes32` item to the filter by setting bits in the bitmap.
   * @param filter The Bloom filter to update.
   * @param item Hash value of the item to add.
   */
  function _add(Filter storage filter, bytes32 item) internal {
    require(filter.hashCount != 0, ZeroHashCount());
    uint64 bitCount = filter.bitCount;
    for (uint8 i = 0; i < filter.hashCount; ++i) {
      uint256 position = uint256(keccak256(abi.encodePacked(item, i))) % bitCount;
      filter.bitmap.set(position); // Set the bit in the bitmap at the calculated position
    }
  }

  /**
   * @notice Adds a string to the filter by hashing it and setting bits in the bitmap.
   * @param filter The Bloom filter to update.
   * @param item String to add to the filter.
   */
  function _addString(Filter storage filter, string memory item) internal {
    bytes32 itemHash = keccak256(abi.encodePacked(item));
    _add(filter, itemHash);
  }

  /**
   * @notice Removes a `bytes32` item from the filter by clearing bits in the bitmap.
   * @param filter The Bloom filter to update.
   * @param item Hash value of the item to remove.
   */
  function _remove(Filter storage filter, bytes32 item) internal {
    require(filter.hashCount != 0, ZeroHashCount());
    uint64 bitCount = filter.bitCount;
    for (uint8 i = 0; i < filter.hashCount; ++i) {
      uint256 position = uint256(keccak256(abi.encodePacked(item, i))) % bitCount;
      filter.bitmap.unset(position); // Clear the bit in the bitmap at the calculated position
    }
  }

  /**
   * @notice Removes a string from the filter by hashing it and clearing bits in the bitmap.
   * @param filter The Bloom filter to update.
   * @param item String to remove from the filter.
   */
  function _removeString(Filter storage filter, string memory item) internal {
    bytes32 itemHash = keccak256(abi.encodePacked(item));
    _remove(filter, itemHash);
  }

  /**
   * @notice Checks if a `bytes32` item is probably present in the filter or definitely not present.
   * @param filter The Bloom filter to check.
   * @param item Hash value of the item to check.
   * @return probablyPresent True if the item may exist, false if it definitely does not exist.
   */
  function _probablyContains(Filter storage filter, bytes32 item) internal view returns (bool probablyPresent) {
    if (filter.hashCount == 0) revert ZeroHashCount();
    uint64 bitCount = filter.bitCount;
    for (uint8 i = 0; i < filter.hashCount; ++i) {
      uint256 position = uint256(keccak256(abi.encodePacked(item, i))) % bitCount;
      if (!filter.bitmap.get(position)) return false; // If any bit is not set, item is not present
    }
    return true;
  }

  /**
   * @notice Checks if a string is probably present in the filter or definitely not present.
   * @param filter The Bloom filter to check.
   * @param item String to check in the filter.
   * @return probablyPresent True if the item may exist, false if it definitely does not exist.
   */
  function _probablyContainsString(
    Filter storage filter,
    string memory item
  ) internal view returns (bool probablyPresent) {
    bytes32 itemHash = keccak256(abi.encodePacked(item));
    return _probablyContains(filter, itemHash);
  }

  function _defaults(Filter storage filter) internal {
    filter.hashCount = 8; // The number of hash functions to use.
    filter.bitCount = 1024 * 32; // Default number of bits
    delete filter.bitmap; // Clear the bitmap
  }

  /**
   * @notice Initializes a Bloom filter with a specified hash count.
   * @param filter The Bloom filter to initialize.
   */
  function _initialize(Filter storage filter) internal {
    _defaults(filter);
  }

  /**
   * @notice Initializes a Bloom filter with a specified hash count.
   * @param filter The Bloom filter to initialize.
   * @param hashCount The number of hash functions to use.
   */
  function _initialize(Filter storage filter, uint8 hashCount) internal {
    _defaults(filter);
    filter.hashCount = hashCount;
  }

  /**
   * @notice Initializes a Bloom filter with a specified hash count.
   * @param filter The Bloom filter to initialize.
   * @param hashCount The number of hash functions to use.
   * @param bitCount The number of bits in the bitmap.
   */
  function _initialize(Filter storage filter, uint8 hashCount, uint64 bitCount) internal {
    _defaults(filter);
    filter.bitCount = bitCount;
    filter.hashCount = hashCount;
  }

  /**
   * @notice Initializes a Bloom filter with a specified hash count and clears the bitmap.
   * @param filter The Bloom filter to initialize.
   * @param hashCount The times to hash each item.
   * @param positions Array of positions to set in the bitmap.
   */
  function _initialize(Filter storage filter, uint8 hashCount, uint256[] calldata positions) internal {
    _initialize(filter, hashCount);
    _addPositions(filter, positions);
  }

  /**
   * @notice Initializes a Bloom filter with a specified hash count and clears the bitmap.
   * @param filter The Bloom filter to initialize.
   * @param hashCount The number of hash functions to use.
   * @param bitCount The number of bits in the bitmap.
   * @param positions Array of positions to set in the bitmap.
   */
  function _initialize(Filter storage filter, uint8 hashCount, uint64 bitCount, uint256[] calldata positions) internal {
    _initialize(filter, hashCount, bitCount);
    _addPositions(filter, positions);
  }

  /**
   * @notice Adds an array of positions to the filter by setting bits in the bitmap.
   * @param filter The Bloom filter to update.
   * @param positions Array of positions to set in the bitmap.
   */
  function _addPositions(Filter storage filter, uint256[] calldata positions) internal {
    for (uint256 i = 0; i < positions.length; ++i) {
      filter.bitmap.set(positions[i]);
    }
  }
}

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

import {CombatStyle} from "../globals/misc.sol";

library CombatStyleLibrary {
  error InvalidCombatStyleId(uint8 combatStyle);

  function _asCombatStyle(uint8 combatStyle) internal pure returns (CombatStyle) {
    require(
      combatStyle >= uint8(type(CombatStyle).min) && combatStyle <= uint8(type(CombatStyle).max),
      InvalidCombatStyleId(combatStyle)
    );
    return CombatStyle(combatStyle);
  }

  function _isCombatStyle(CombatStyle combatStyle) internal pure returns (bool) {
    return combatStyle != CombatStyle.NONE;
  }

  function _isCombatStyle(uint8 combatStyle) internal pure returns (bool) {
    return _isCombatStyle(_asCombatStyle(combatStyle));
  }
}

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

import {Skill} from "../globals/misc.sol";

library SkillLibrary {
  error InvalidSkillId(uint8 skill);

  function _asSkill(uint8 skill) internal pure returns (Skill) {
    require(skill >= uint8(type(Skill).min) && skill <= uint8(type(Skill).max), InvalidSkillId(skill));
    return Skill(skill);
  }

  function _isSkill(uint8 skill) internal pure returns (bool) {
    return _isSkill(_asSkill(skill));
  }

  function _isSkill(uint8 skill, Skill check) internal pure returns (bool) {
    return _isSkill(_asSkill(skill), check);
  }

  function _isSkillCombat(uint8 skill) internal pure returns (bool) {
    return _isSkillCombat(_asSkill(skill));
  }

  function _isSkillNone(uint8 skill) internal pure returns (bool) {
    return _isSkillNone(_asSkill(skill));
  }

  function _asUint8(Skill skill) internal pure returns (uint8) {
    return uint8(skill);
  }

  function _isSkill(Skill skill) internal pure returns (bool) {
    return !_isSkill(skill, Skill.NONE);
  }

  function _isSkill(Skill skill, Skill check) internal pure returns (bool) {
    return skill == check;
  }

  function _isSkillCombat(Skill skill) internal pure returns (bool) {
    return _isSkill(skill, Skill.COMBAT);
  }

  function _isSkillNone(Skill skill) internal pure returns (bool) {
    return _isSkill(skill, Skill.NONE);
  }
}

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

import {SamWitchERC1155UpgradeableSinglePerToken} from "./SamWitchERC1155UpgradeableSinglePerToken.sol";
import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {IERC2981, IERC165} from "@openzeppelin/contracts/interfaces/IERC2981.sol";

import {EstforLibrary} from "./EstforLibrary.sol";
import {IBrushToken} from "./interfaces/external/IBrushToken.sol";
import {IPlayers} from "./interfaces/IPlayers.sol";
import {AdminAccess} from "./AdminAccess.sol";

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

// solhint-disable-next-line no-global-import
import "./globals/all.sol";

// Each NFT represents a player. This contract deals with the NFTs, and the Players contract deals with the player data
contract PlayerNFT is UUPSUpgradeable, OwnableUpgradeable, SamWitchERC1155UpgradeableSinglePerToken, IERC2981 {
  using BloomFilter for BloomFilter.Filter;

  event NewPlayer(
    uint256 playerId,
    uint256 avatarId,
    string name,
    address from,
    string discord,
    string twitter,
    string telegram,
    bool upgrade
  );
  event EditPlayer(
    uint256 playerId,
    address from,
    string newName,
    uint256 paid,
    string discord,
    string twitter,
    string telegram,
    bool upgrade
  );
  event EditNameCost(uint256 newCost);
  event UpgradePlayerCost(uint256 newCost);
  event SetAvatars(uint256[] avatarIds, AvatarInfo[] avatarInfos);
  event UpgradePlayerAvatar(uint256 playerId, uint256 newAvatarId, uint256 tokenCost);
  event SetBrushDistributionPercentages(
    uint256 brushBurntPercentage,
    uint256 brushTreasuryPercentage,
    uint256 brushDevPercentage
  );

  error NotOwnerOfPlayer();
  error NotPlayers();
  error BaseAvatarNotExists();
  error NameTooShort();
  error NameTooLong();
  error NameAlreadyExists();
  error NameInvalidCharacters();
  error MintedMoreThanAllowed();
  error NotInWhitelist();
  error ERC1155Metadata_URIQueryForNonexistentToken();
  error ERC1155BurnForbidden();
  error DiscordTooLong();
  error DiscordInvalidCharacters();
  error TelegramTooLong();
  error TelegramInvalidCharacters();
  error TwitterTooLong();
  error TwitterInvalidCharacters();
  error LengthMismatch();
  error PercentNotTotal100();
  error HeroNameIsReserved(string reservedName);
  error NotBridge();

  struct PlayerInfo {
    uint24 avatarId;
    uint24 originalAvatarId; // The base avatar id that you were born with
    uint40 mintedTimestamp;
    uint40 upgradedTimestamp; // What time you upgraded your avatar
  }

  uint256 private constant EVOLVED_OFFSET = 10000;
  uint256 public constant NUM_BASE_AVATARS = 8;

  IBrushToken private _brush;
  IPlayers private _players;
  uint64 private _nextPlayerId;
  address private _treasury;
  address private _royaltyReceiver;
  uint8 private _royaltyFee; // base 1000, highest is 25.5
  uint72 private _editNameCost; // Max is 4700 BRUSH
  address private _dev;
  uint72 private _upgradePlayerCost; // Max is 4700 BRUSH
  uint8 private _brushBurntPercentage;
  uint8 private _brushTreasuryPercentage;
  uint8 private _brushDevPercentage;
  bytes32 private _merkleRoot; // Unused now (was for alpha/beta whitelisting)
  bool private _isBeta; // Not need to pack this
  AdminAccess private _adminAccess; // Unused but is set
  uint32 private _numBurned;
  string private _imageBaseUri;
  mapping(uint256 avatarId => AvatarInfo avatarInfo) private _avatars;
  mapping(uint256 playerId => PlayerInfo playerInfo) private _playerInfos;
  mapping(uint256 playerId => string name) private _names;
  mapping(string name => bool exists) private _lowercaseNames;
  BloomFilter.Filter private _reservedHeroNames; // TODO: remove 90 days after launch
  address private _bridge; // TODO: Bridge Can remove later

  modifier isOwnerOfPlayer(uint256 playerId) {
    require(balanceOf(_msgSender(), playerId) == 1, NotOwnerOfPlayer());
    _;
  }

  modifier onlyPlayers() {
    require(_msgSender() == address(_players), NotPlayers());
    _;
  }

  modifier onlyBridge() {
    require(_msgSender() == address(_bridge), NotBridge());
    _;
  }

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

  function initialize(
    IBrushToken brush,
    address treasury,
    address dev,
    address royaltyReceiver,
    uint72 editNameCost,
    uint72 upgradePlayerCost,
    string calldata imageBaseUri,
    uint64 startPlayerId,
    bool isBeta,
    address bridge
  ) external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();
    __SamWitchERC1155UpgradeableSinglePerToken_init("");

    _brush = brush;
    _nextPlayerId = startPlayerId;
    _imageBaseUri = imageBaseUri;
    _treasury = treasury;
    _dev = dev;
    _upgradePlayerCost = upgradePlayerCost;
    setEditNameCost(editNameCost);
    setUpgradeCost(upgradePlayerCost);
    _royaltyFee = 30; // 3%
    _royaltyReceiver = royaltyReceiver;
    _isBeta = isBeta;
    _bridge = bridge;

    _reservedHeroNames._initialize(4, 2000000);
  }

  function mint(
    uint256 avatarId,
    string calldata heroName,
    string calldata discord,
    string calldata twitter,
    string calldata telegram,
    bool upgrade,
    bool makeActive
  ) external {
    address from = _msgSender();
    uint256 playerId = _nextPlayerId++;
    (string memory trimmedName, ) = _setName(playerId, heroName);

    _checkSocials(discord, twitter, telegram);
    emit NewPlayer(playerId, avatarId, trimmedName, from, discord, twitter, telegram, upgrade);
    _checkMintingAvatar(avatarId);
    PlayerInfo storage playerInfo = _playerInfos[playerId];
    playerInfo.originalAvatarId = uint24(avatarId);
    playerInfo.mintedTimestamp = uint40(block.timestamp);
    _mint(from, playerId, 1, "");
    _mintStartingItems(from, playerId, avatarId, makeActive);
    if (upgrade) {
      uint24 evolvedAvatarId = uint24(EVOLVED_OFFSET + avatarId);
      _upgradePlayer(playerId, evolvedAvatarId);
    } else {
      _playerInfos[playerId].avatarId = uint24(avatarId);
    }
  }

  function mintBridge(
    address from,
    uint256 playerId,
    uint256 avatarId,
    string calldata heroName,
    string calldata discord,
    string calldata twitter,
    string calldata telegram,
    bool isUpgrade
  ) external onlyBridge {
    _lowercaseNames[EstforLibrary.toLower(heroName)] = true;
    _names[playerId] = heroName;
    emit NewPlayer(playerId, avatarId, heroName, from, discord, twitter, telegram, isUpgrade);

    PlayerInfo storage playerInfo = _playerInfos[playerId];
    playerInfo.originalAvatarId = uint24(avatarId);
    playerInfo.mintedTimestamp = uint40(block.timestamp);
    _mint(from, playerId, 1, "");
    uint256[] memory startingItemTokenIds;
    uint256[] memory startingAmounts;

    // Only make active if the account has no active player
    bool makeActive = _players.getActivePlayer(from) == 0;
    _players.mintedPlayer(
      from,
      playerId,
      _avatars[avatarId].startSkills,
      makeActive,
      startingItemTokenIds,
      startingAmounts
    );
    if (isUpgrade) {
      uint24 evolvedAvatarId = uint24(EVOLVED_OFFSET + avatarId);
      // _upgradePlayer equivalent
      playerInfo.avatarId = evolvedAvatarId;
      playerInfo.upgradedTimestamp = uint40(block.timestamp);
      _players.upgradePlayer(playerId);
      uint256 tokenCost = 0; // Free when bridging
      emit UpgradePlayerAvatar(playerId, evolvedAvatarId, tokenCost);
      // end _upgradePlayer equivalent
    } else {
      _playerInfos[playerId].avatarId = uint24(avatarId);
    }
  }

  function burn(address from, uint256 playerId) external {
    require(from == _msgSender() || isApprovedForAll(from, _msgSender()), ERC1155BurnForbidden());
    _burn(from, playerId, 1);
  }

  function _upgradePlayer(uint256 playerId, uint24 newAvatarId) private {
    PlayerInfo storage playerInfo = _playerInfos[playerId];
    playerInfo.avatarId = newAvatarId;
    playerInfo.upgradedTimestamp = uint40(block.timestamp);
    _players.upgradePlayer(playerId);
    uint256 tokenCost = _upgradePlayerCost;
    _pay(tokenCost);
    emit UpgradePlayerAvatar(playerId, newAvatarId, tokenCost);
  }

  function editPlayer(
    uint256 playerId,
    string calldata playerName,
    string calldata discord,
    string calldata twitter,
    string calldata telegram,
    bool upgrade
  ) external isOwnerOfPlayer(playerId) {
    _checkSocials(discord, twitter, telegram);

    // Only charge brush if changing the name
    (string memory trimmedName, bool nameChanged) = _setName(playerId, playerName);
    uint256 amountPaid;
    if (nameChanged) {
      amountPaid = _editNameCost;
      _pay(_editNameCost);
    }

    if (upgrade) {
      _playerInfos[playerId].originalAvatarId = _playerInfos[playerId].avatarId;
      uint24 evolvedAvatarId = uint24(EVOLVED_OFFSET + _playerInfos[playerId].avatarId);
      _upgradePlayer(playerId, evolvedAvatarId);
    }

    emit EditPlayer(playerId, _msgSender(), trimmedName, amountPaid, discord, twitter, telegram, upgrade);
  }

  function _pay(uint256 tokenCost) private {
    address sender = _msgSender();
    _brush.transferFrom(sender, _treasury, (tokenCost * _brushTreasuryPercentage) / 100);
    _brush.transferFrom(sender, _dev, (tokenCost * _brushDevPercentage) / 100);
    _brush.burnFrom(sender, (tokenCost * _brushBurntPercentage) / 100);
  }

  function _mintStartingItems(address from, uint256 playerId, uint256 avatarId, bool makeActive) private {
    // Give the player some starting items
    uint256[] memory itemTokenIds = new uint256[](7);
    itemTokenIds[0] = BRONZE_SWORD;
    itemTokenIds[1] = BRONZE_AXE;
    itemTokenIds[2] = MAGIC_FIRE_STARTER;
    itemTokenIds[3] = NET_STICK;
    itemTokenIds[4] = BRONZE_PICKAXE;
    itemTokenIds[5] = TOTEM_STAFF;
    itemTokenIds[6] = BASIC_BOW;

    uint256[] memory amounts = new uint256[](7);
    amounts[0] = 1;
    amounts[1] = 1;
    amounts[2] = 1;
    amounts[3] = 1;
    amounts[4] = 1;
    amounts[5] = 1;
    amounts[6] = 1;
    _players.mintedPlayer(from, playerId, _avatars[avatarId].startSkills, makeActive, itemTokenIds, amounts);
  }

  function _setName(
    uint256 playerId,
    string calldata playerName
  ) private returns (string memory trimmedName, bool nameChanged) {
    // Trimmed name cannot be empty
    trimmedName = EstforLibrary.trim(playerName);
    require(bytes(trimmedName).length >= 3, NameTooShort());
    require(bytes(trimmedName).length <= 20, NameTooLong());
    require(EstforLibrary.containsValidNameCharacters(trimmedName), NameInvalidCharacters());

    string memory trimmedAndLowercaseName = EstforLibrary.toLower(trimmedName);
    string memory oldName = EstforLibrary.toLower(_names[playerId]);
    nameChanged = keccak256(abi.encodePacked(oldName)) != keccak256(abi.encodePacked(trimmedAndLowercaseName));
    if (nameChanged) {
      require(!_reservedHeroNames._probablyContainsString(trimmedAndLowercaseName), HeroNameIsReserved(playerName));
      require(!_lowercaseNames[trimmedAndLowercaseName], NameAlreadyExists());
      if (bytes(oldName).length != 0) {
        delete _lowercaseNames[oldName];
      }
      _lowercaseNames[trimmedAndLowercaseName] = true;
      _names[playerId] = trimmedName;
    }
  }

  function _checkMintingAvatar(uint256 avatarId) private view {
    require(bytes(_avatars[avatarId].description).length != 0 && avatarId <= NUM_BASE_AVATARS, BaseAvatarNotExists());
  }

  function _checkSocials(string calldata discord, string calldata twitter, string calldata telegram) private pure {
    require(bytes(discord).length <= 32, DiscordTooLong());
    require(EstforLibrary.containsBaselineSocialNameCharacters(discord), DiscordInvalidCharacters());

    require(bytes(twitter).length <= 32, TwitterTooLong());
    require(EstforLibrary.containsBaselineSocialNameCharacters(twitter), TwitterInvalidCharacters());

    require(bytes(telegram).length <= 32, TelegramTooLong());
    require(EstforLibrary.containsBaselineSocialNameCharacters(telegram), TelegramInvalidCharacters());
  }

  function _update(address from, address to, uint256[] memory ids, uint256[] memory amounts) internal virtual override {
    if (from != address(0) && amounts.length != 0 && from != to) {
      uint32 burned;
      IPlayers players = _players;
      for (uint256 i = 0; i < ids.length; ++i) {
        uint256 playerId = ids[i];
        players.clearEverythingBeforeTokenTransfer(from, playerId);
        if (to == address(0)) {
          // Burning
          string memory oldName = EstforLibrary.toLower(_names[playerId]);
          delete _lowercaseNames[oldName];
          ++burned;
        } else if (from != address(0)) {
          // Not minting
          players.beforeTokenTransferTo(to, playerId);
        }
      }
      if (burned != 0) {
        _numBurned += burned;
      }
    }
    super._update(from, to, ids, amounts);
  }

  function uri(uint256 playerId) public view virtual override returns (string memory) {
    require(exists(playerId), ERC1155Metadata_URIQueryForNonexistentToken());
    AvatarInfo storage avatarInfo = _avatars[_playerInfos[playerId].avatarId];
    string memory imageURI = string(abi.encodePacked(_imageBaseUri, avatarInfo.imageURI));
    return _players.getURI(playerId, _names[playerId], avatarInfo.name, avatarInfo.description, imageURI);
  }

  /**
   * @dev Returns whether `tokenId` exists.
   * Tokens can be managed by their owner or approved accounts via {setApprovalForAll}.
   */
  function exists(uint256 tokenId) public view returns (bool) {
    return _playerInfos[tokenId].avatarId != 0;
  }

  /**
   * @dev See {IERC1155-balanceOfBatch}. This implementation is not standard ERC1155, it's optimized for the single account case
   */
  function balanceOfs(address account, uint16[] memory ids) external view returns (uint256[] memory batchBalances) {
    uint256 length = ids.length;
    batchBalances = new uint256[](length);
    for (uint256 i; i < length; ++i) {
      batchBalances[i] = balanceOf(account, ids[i]);
    }
  }

  function royaltyInfo(
    uint256 /*tokenId*/,
    uint256 salePrice
  ) external view override returns (address receiver, uint256 royaltyAmount) {
    uint256 amount = (salePrice * _royaltyFee) / 1000;
    return (_royaltyReceiver, amount);
  }

  function supportsInterface(
    bytes4 interfaceId
  ) public view override(IERC165, SamWitchERC1155UpgradeableSinglePerToken) returns (bool) {
    return interfaceId == type(IERC2981).interfaceId || super.supportsInterface(interfaceId);
  }

  function name() external view returns (string memory) {
    return string(abi.encodePacked("Estfor Players", _isBeta ? " (Beta)" : ""));
  }

  function symbol() external view returns (string memory) {
    return string(abi.encodePacked("EK_P", _isBeta ? "B" : ""));
  }

  function getPlayerInfo(uint256 playerId) external view returns (PlayerInfo memory) {
    return _playerInfos[playerId];
  }

  function hasLowercaseName(string calldata lowercaseName) external view returns (bool lowercaseNameExists) {
    return _lowercaseNames[lowercaseName];
  }

  function getName(uint256 playerId) external view returns (string memory) {
    return _names[playerId];
  }

  function setAvatars(uint256[] calldata avatarIds, AvatarInfo[] calldata avatarInfos) external onlyOwner {
    require(avatarIds.length == avatarInfos.length, LengthMismatch());
    for (uint256 i; i < avatarIds.length; ++i) {
      _avatars[avatarIds[i]] = avatarInfos[i];
    }
    emit SetAvatars(avatarIds, avatarInfos);
  }

  function setImageBaseUri(string calldata imageBaseUri) external onlyOwner {
    _imageBaseUri = imageBaseUri;
  }

  function setPlayers(IPlayers players) external onlyOwner {
    _players = players;
  }

  function setEditNameCost(uint72 editNameCost) public onlyOwner {
    _editNameCost = editNameCost;
    emit EditNameCost(editNameCost);
  }

  function setUpgradeCost(uint72 upgradePlayerCost) public onlyOwner {
    _upgradePlayerCost = upgradePlayerCost;
    emit UpgradePlayerCost(upgradePlayerCost);
  }

  function setReservedNameBits(uint256[] calldata positions) external onlyOwner {
    _reservedHeroNames._addPositions(positions);
  }

  function isHeroNameReserved(string calldata heroName) public view returns (bool) {
    return _reservedHeroNames._probablyContainsString(EstforLibrary.toLower(heroName));
  }

  function addReservedHeroNames(string[] calldata names) external onlyOwner {
    for (uint256 i = 0; i < names.length; ++i) {
      _reservedHeroNames._addString(EstforLibrary.toLower(names[i]));
    }
  }

  function setBrushDistributionPercentages(
    uint8 brushBurntPercentage,
    uint8 brushTreasuryPercentage,
    uint8 brushDevPercentage
  ) external onlyOwner {
    require(brushBurntPercentage + brushTreasuryPercentage + brushDevPercentage == 100, PercentNotTotal100());

    _brushBurntPercentage = brushBurntPercentage;
    _brushTreasuryPercentage = brushTreasuryPercentage;
    _brushDevPercentage = brushDevPercentage;
    emit SetBrushDistributionPercentages(brushBurntPercentage, brushTreasuryPercentage, brushDevPercentage);
  }

  function tempSetHeroAndUpgradedTimestamps(
    uint256[] calldata playerIds,
    uint40[] calldata mintedTimestamps,
    uint40[] calldata upgradedTimestamps
  ) external onlyOwner {
    require(
      playerIds.length == mintedTimestamps.length && playerIds.length == upgradedTimestamps.length,
      LengthMismatch()
    );
    for (uint256 i; i < playerIds.length; ++i) {
      _playerInfos[playerIds[i]].mintedTimestamp = mintedTimestamps[i];
      _playerInfos[playerIds[i]].upgradedTimestamp = upgradedTimestamps[i];
    }
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

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

import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";

import {IItemNFT} from "../interfaces/IItemNFT.sol";
import {IWorldActions} from "../interfaces/IWorldActions.sol";

import {CombatStyleLibrary} from "../libraries/CombatStyleLibrary.sol";
import {SkillLibrary} from "../libraries/SkillLibrary.sol";

import {Skill, CombatStats, CombatStyle, BoostType, Attire} from "../globals/misc.sol";
import {PendingQueuedActionEquipmentState, QueuedAction, ActionChoice, StandardBoostInfo, ExtendedBoostInfo, PackedXP, PendingQueuedActionProcessed, Item, Player, Player, XP_BYTES, IS_FULL_MODE_BIT, HAS_EXTRA_BOOST_BIT, CheckpointEquipments} from "../globals/players.sol";
import {ActionRewards} from "../globals/rewards.sol";
import {NONE} from "../globals/items.sol";
import {RATE_MUL, SPAWN_MUL, GUAR_MUL} from "../globals/actions.sol";

// This file contains methods for interacting with the player that is used to decrease implementation deployment bytecode code.
library PlayersLibrary {
  using CombatStyleLibrary for uint8;
  using SkillLibrary for uint8;
  using SkillLibrary for Skill;

  error InvalidXPSkill();
  error InvalidAction();
  error SkillForPetNotHandledYet();

  // This is to prevent some precision loss in the healing calculations
  uint256 constant HEALING_SCALE = 1_000_000;

  function _getLevel(uint256 xp) internal pure returns (uint16) {
    uint256 low;
    uint256 high = XP_BYTES.length / 4;

    while (low < high) {
      uint256 mid = (low + high) / 2;

      // Note that mid will always be strictly less than high (i.e. it will be a valid array index)
      if (_getXP(mid) > xp) {
        high = mid;
      } else {
        low = mid + 1;
      }
    }

    if (low != 0) {
      return uint16(low);
    } else {
      return 1;
    }
  }

  function getLevel(uint256 xp) external pure returns (uint16) {
    return _getLevel(xp);
  }

  function _getXP(uint256 index) private pure returns (uint32) {
    uint256 key = index * 4;
    return
      uint32(
        XP_BYTES[key] |
          (bytes4(XP_BYTES[key + 1]) >> 8) |
          (bytes4(XP_BYTES[key + 2]) >> 16) |
          (bytes4(XP_BYTES[key + 3]) >> 24)
      );
  }

  function _getRealBalance(
    uint256 originalBalance,
    uint256 itemId,
    PendingQueuedActionEquipmentState[] memory pendingQueuedActionEquipmentStates
  ) private pure returns (uint256 balance) {
    balance = originalBalance;
    for (uint256 i; i < pendingQueuedActionEquipmentStates.length; ++i) {
      PendingQueuedActionEquipmentState memory pendingQueuedActionEquipmentState = pendingQueuedActionEquipmentStates[
        i
      ];
      for (uint256 j; j < pendingQueuedActionEquipmentState.producedItemTokenIds.length; ++j) {
        if (pendingQueuedActionEquipmentState.producedItemTokenIds[j] == itemId) {
          balance += pendingQueuedActionEquipmentState.producedAmounts[j];
        }
      }
      for (uint256 j; j < pendingQueuedActionEquipmentState.consumedItemTokenIds.length; ++j) {
        if (pendingQueuedActionEquipmentState.consumedItemTokenIds[j] == itemId) {
          if (balance >= pendingQueuedActionEquipmentState.consumedAmounts[j]) {
            balance -= pendingQueuedActionEquipmentState.consumedAmounts[j];
          } else {
            balance = 0;
          }
        }
      }
    }
  }

  function getBalanceUsingCheckpoint(
    uint256 itemId,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    CheckpointEquipments calldata checkpointEquipments
  ) private pure returns (uint256 balance) {
    for (uint256 i; i < checkpointEquipments.itemTokenIds.length; ++i) {
      if (checkpointEquipments.itemTokenIds[i] == itemId) {
        return _getRealBalance(checkpointEquipments.balances[i], itemId, pendingQueuedActionEquipmentStates);
      }
    }
  }

  function getBalancesUsingCheckpoint(
    uint16[] memory itemIds,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    CheckpointEquipments calldata checkpointEquipments
  ) private pure returns (uint256[] memory balances) {
    balances = new uint256[](itemIds.length);

    for (uint256 i; i < checkpointEquipments.itemTokenIds.length; ++i) {
      uint256 itemTokenId = checkpointEquipments.itemTokenIds[i];
      uint256 checkpointBalance = checkpointEquipments.balances[i];
      for (uint256 j; j < itemIds.length; ++j) {
        if (itemIds[j] == itemTokenId) {
          balances[j] = _getRealBalance(checkpointBalance, itemIds[j], pendingQueuedActionEquipmentStates);
          break;
        }
      }
    }
  }

  // This takes into account any intermediate changes from previous actions from view functions
  // as those cannot affect the blockchain state with balanceOf
  function getBalanceUsingCurrentBalance(
    address from,
    uint256 itemId,
    address itemNFT,
    PendingQueuedActionEquipmentState[] memory pendingQueuedActionEquipmentStates
  ) public view returns (uint256 balance) {
    balance = _getRealBalance(IItemNFT(itemNFT).balanceOf(from, itemId), itemId, pendingQueuedActionEquipmentStates);
  }

  function getBalanceUsingCurrentBalances(
    address from,
    uint16[] memory itemIds,
    address itemNFT,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates
  ) public view returns (uint256[] memory balances) {
    balances = IItemNFT(itemNFT).balanceOfs(from, itemIds);
    uint256 bounds = balances.length;
    for (uint256 i; i < bounds; ++i) {
      balances[i] = _getRealBalance(balances[i], itemIds[i], pendingQueuedActionEquipmentStates);
    }
  }

  function _getMaxRequiredRatio(
    address from,
    ActionChoice memory actionChoice,
    uint16 baseInputItemsConsumedNum,
    IItemNFT itemNFT,
    PendingQueuedActionEquipmentState[] memory pendingQueuedActionEquipmentStates
  ) private view returns (uint256 maxRequiredRatio) {
    maxRequiredRatio = baseInputItemsConsumedNum;

    if (baseInputItemsConsumedNum != 0) {
      if (actionChoice.inputTokenId1 != 0) {
        maxRequiredRatio = _getMaxRequiredRatioPartial(
          from,
          actionChoice.inputTokenId1,
          actionChoice.inputAmount1,
          maxRequiredRatio,
          itemNFT,
          pendingQueuedActionEquipmentStates
        );
      }
      if (actionChoice.inputTokenId2 != 0) {
        maxRequiredRatio = _getMaxRequiredRatioPartial(
          from,
          actionChoice.inputTokenId2,
          actionChoice.inputAmount2,
          maxRequiredRatio,
          itemNFT,
          pendingQueuedActionEquipmentStates
        );
      }
      if (actionChoice.inputTokenId3 != 0) {
        maxRequiredRatio = _getMaxRequiredRatioPartial(
          from,
          actionChoice.inputTokenId3,
          actionChoice.inputAmount3,
          maxRequiredRatio,
          itemNFT,
          pendingQueuedActionEquipmentStates
        );
      }
    }
  }

  function _getMaxRequiredRatioPartial(
    address from,
    uint16 inputTokenId,
    uint256 inputAmount,
    uint256 prevConsumeMaxRatio,
    IItemNFT itemNFT,
    PendingQueuedActionEquipmentState[] memory pendingQueuedActionEquipmentStates
  ) private view returns (uint256 maxRequiredRatio) {
    uint256 balance = getBalanceUsingCurrentBalance(
      from,
      inputTokenId,
      address(itemNFT),
      pendingQueuedActionEquipmentStates
    );
    uint256 tempMaxRequiredRatio = balance / inputAmount;
    if (tempMaxRequiredRatio < prevConsumeMaxRatio) {
      maxRequiredRatio = tempMaxRequiredRatio;
    } else {
      maxRequiredRatio = prevConsumeMaxRatio;
    }
  }

  function _max(int a, int b) private pure returns (int) {
    return a > b ? a : b;
  }

  function _dmgPerMinute(int attack, int defence, uint8 alphaCombat, uint8 betaCombat) private pure returns (uint256) {
    if (attack == 0) {
      return 0;
    }
    // Negative defence is capped at the negative of the attack value.
    // So an attack of 10 and defence of -15 is the same as attack -10.
    defence = _max(-attack, defence);
    return uint256(_max(1, int128(attack) * int8(alphaCombat) + (attack * 2 - defence) * int8(betaCombat)));
  }

  function dmg(
    int attack,
    int defence,
    uint8 alphaCombat,
    uint8 betaCombat,
    uint256 elapsedTime
  ) public pure returns (uint32) {
    return uint32((_dmgPerMinute(attack, defence, alphaCombat, betaCombat) * elapsedTime) / 60);
  }

  function _fullDmg(
    CombatStats memory combatStats,
    CombatStats memory enemyCombatStats,
    uint8 alphaCombat,
    uint8 betaCombat,
    uint256 elapsedTime
  ) private pure returns (uint32 fullDmg) {
    fullDmg = dmg(combatStats.meleeAttack, enemyCombatStats.meleeDefence, alphaCombat, betaCombat, elapsedTime);
    fullDmg += dmg(combatStats.rangedAttack, enemyCombatStats.rangedDefence, alphaCombat, betaCombat, elapsedTime);
    fullDmg += dmg(combatStats.magicAttack, enemyCombatStats.magicDefence, alphaCombat, betaCombat, elapsedTime);
  }

  function _timeToKill(
    int attack,
    int defence,
    uint8 alphaCombat,
    uint8 betaCombat,
    int16 enemyHealth
  ) private pure returns (uint256) {
    // Formula is max(1, a(atk) + b(2 * atk - def))
    // Always do at least 1 damage per minute
    uint256 dmgPerMinute = _dmgPerMinute(attack, defence, alphaCombat, betaCombat);
    return Math.ceilDiv(uint256(uint16(enemyHealth)) * 60, dmgPerMinute);
  }

  function _timeToKillPlayer(
    CombatStats memory combatStats,
    CombatStats memory enemyCombatStats,
    uint8 alphaCombat,
    uint8 betaCombat,
    int health
  ) private pure returns (uint256) {
    uint256 dmgPerMinute = _dmgPerMinute(
      enemyCombatStats.meleeAttack,
      combatStats.meleeDefence,
      alphaCombat,
      betaCombat
    );
    dmgPerMinute += _dmgPerMinute(enemyCombatStats.rangedAttack, combatStats.rangedDefence, alphaCombat, betaCombat);
    dmgPerMinute += _dmgPerMinute(enemyCombatStats.magicAttack, combatStats.magicDefence, alphaCombat, betaCombat);
    return Math.ceilDiv(uint256(health) * 60, dmgPerMinute);
  }

  function _getTimeToKill(
    Skill skill,
    CombatStats memory combatStats,
    CombatStats memory enemyCombatStats,
    uint8 alphaCombat,
    uint8 betaCombat,
    int16 enemyHealth
  ) private pure returns (uint256 timeToKill) {
    int16 attack;
    int16 defence;
    if (skill == Skill.MELEE) {
      attack = combatStats.meleeAttack;
      defence = enemyCombatStats.meleeDefence;
    } else if (skill == Skill.RANGED) {
      attack = combatStats.rangedAttack;
      defence = enemyCombatStats.rangedDefence;
    } else if (skill == Skill.MAGIC) {
      attack = combatStats.magicAttack;
      defence = enemyCombatStats.magicDefence;
    } else {
      assert(false);
    }

    timeToKill = _timeToKill(attack, defence, alphaCombat, betaCombat, enemyHealth);
  }

  function _getDmgDealtByPlayer(
    ActionChoice memory actionChoice,
    CombatStats memory combatStats,
    CombatStats memory enemyCombatStats,
    uint8 alphaCombat,
    uint8 betaCombat,
    uint256 elapsedTime
  ) private pure returns (uint32 dmgDealt) {
    Skill skill = actionChoice.skill._asSkill();
    if (skill == Skill.MELEE) {
      dmgDealt = dmg(combatStats.meleeAttack, enemyCombatStats.meleeDefence, alphaCombat, betaCombat, elapsedTime);
    } else if (skill == Skill.RANGED) {
      dmgDealt = dmg(combatStats.rangedAttack, enemyCombatStats.rangedDefence, alphaCombat, betaCombat, elapsedTime);
    } else if (skill == Skill.MAGIC) {
      // Assumes this is a magic action
      dmgDealt = dmg(combatStats.magicAttack, enemyCombatStats.magicDefence, alphaCombat, betaCombat, elapsedTime);
    } else {
      assert(false);
    }
  }

  function determineBattleOutcome(
    address from,
    address itemNFT,
    uint256 elapsedTime,
    ActionChoice calldata actionChoice,
    uint16 regenerateId,
    uint256 numSpawnedPerHour,
    CombatStats memory combatStats,
    CombatStats calldata enemyCombatStats,
    uint8 alphaCombat,
    uint8 betaCombat,
    uint8 alphaCombatHealing,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates
  )
    external
    view
    returns (
      uint256 xpElapsedTime,
      uint256 combatElapsedTime,
      uint16 baseInputItemsConsumedNum,
      uint16 foodConsumed,
      bool died
    )
  {
    return
      _determineBattleOutcome(
        from,
        itemNFT,
        elapsedTime,
        actionChoice,
        regenerateId,
        numSpawnedPerHour,
        combatStats,
        enemyCombatStats,
        alphaCombat,
        betaCombat,
        alphaCombatHealing,
        pendingQueuedActionEquipmentStates
      );
  }

  function _determineBattleOutcome(
    address from,
    address itemNFT,
    uint256 elapsedTime,
    ActionChoice memory actionChoice,
    uint16 regenerateId,
    uint256 numSpawnedPerHour,
    CombatStats memory combatStats,
    CombatStats memory enemyCombatStats,
    uint8 alphaCombat,
    uint8 betaCombat,
    uint8 alphaCombatHealing,
    PendingQueuedActionEquipmentState[] memory pendingQueuedActionEquipmentStates
  )
    internal
    view
    returns (
      uint256 xpElapsedTime,
      uint256 combatElapsedTime,
      uint16 baseInputItemsConsumedNum,
      uint16 foodConsumed,
      bool died
    )
  {
    uint256 respawnTime = (3600 * SPAWN_MUL) / numSpawnedPerHour;
    uint32 dmgDealt = _getDmgDealtByPlayer(
      actionChoice,
      combatStats,
      enemyCombatStats,
      alphaCombat,
      betaCombat,
      respawnTime
    );

    uint256 combatTimePerKill = _getTimeToKill(
      actionChoice.skill._asSkill(),
      combatStats,
      enemyCombatStats,
      alphaCombat,
      betaCombat,
      enemyCombatStats.health
    );

    // Steps for this:
    // 1 - Work out best case scenario for how many we can kill in the elapsed time assuming we have enough food and consumables
    // 2 - Now work out how many we can kill in the combat time based on how many consumables we actually have
    // 3 - Now work out how many we can kill in the elapsed time based on how much food we actually have and adjust combat time
    // 3.5 - If not enough food (i.e died) then backtrack the scrolls.

    // Time spent in comabt with the enemies that were killed, needed in case foodConsumed gets maxed out
    uint256 combatElapsedTimeKilling;
    uint256 numKilled;
    bool canKillAll = dmgDealt > uint16(enemyCombatStats.health);
    if (canKillAll) {
      // But how many can we kill in the time that has elapsed?
      numKilled = (elapsedTime * numSpawnedPerHour) / (3600 * SPAWN_MUL);
      uint256 combatTimePerEnemy = Math.ceilDiv(uint16(enemyCombatStats.health) * respawnTime, dmgDealt);
      combatElapsedTime = combatTimePerEnemy * numKilled;
      combatElapsedTimeKilling = combatElapsedTime;
      // Add remainder combat time to current monster you are fighting
      combatElapsedTime += Math.min(combatTimePerEnemy, elapsedTime - respawnTime * numKilled);
    } else {
      numKilled = elapsedTime / combatTimePerKill;
      combatElapsedTimeKilling = combatTimePerKill * numKilled;
      combatElapsedTime = elapsedTime;
    }

    xpElapsedTime = respawnTime * numKilled;

    // Step 2 - Work out how many consumables are used
    // Check how many to consume, and also adjust xpElapsedTime if they don't have enough consumables
    uint256 maxRequiredBaseInputItemsConsumedRatio = baseInputItemsConsumedNum;
    if (actionChoice.rate != 0) {
      baseInputItemsConsumedNum = uint16(
        Math.max(numKilled, Math.ceilDiv(combatElapsedTime * actionChoice.rate, 3600 * RATE_MUL))
      );

      // This checks the balances
      maxRequiredBaseInputItemsConsumedRatio = _getMaxRequiredRatio(
        from,
        actionChoice,
        baseInputItemsConsumedNum,
        IItemNFT(itemNFT),
        pendingQueuedActionEquipmentStates
      );

      if (baseInputItemsConsumedNum == 0) {
        // Requires input items but we don't have any. In combat the entire time getting rekt
        xpElapsedTime = 0;
        combatElapsedTime = elapsedTime;
      } else if (baseInputItemsConsumedNum > maxRequiredBaseInputItemsConsumedRatio) {
        numKilled = (numKilled * maxRequiredBaseInputItemsConsumedRatio) / baseInputItemsConsumedNum;
        xpElapsedTime = respawnTime * numKilled;
        baseInputItemsConsumedNum = uint16(maxRequiredBaseInputItemsConsumedRatio);

        if (canKillAll) {
          uint256 combatTimePerEnemy = Math.ceilDiv(uint16(enemyCombatStats.health) * respawnTime, dmgDealt);
          combatElapsedTime = combatTimePerEnemy * numKilled;
          combatElapsedTimeKilling = combatElapsedTime;
          combatElapsedTime += elapsedTime - (respawnTime * numKilled);
        } else {
          // In combat the entire time
          combatElapsedTime = elapsedTime;
          combatElapsedTimeKilling = combatTimePerKill * numKilled;
        }
      }
    }

    // Calculate combat damage
    // Step 3 - Calculate raw damage taken
    int32 totalHealthLost = int32(_fullDmg(enemyCombatStats, combatStats, alphaCombat, betaCombat, combatElapsedTime));

    // Take away our health points from the total dealt to us
    totalHealthLost -= combatStats.health;

    int32 totalHealthLostOnlyKilled = int32(
      _fullDmg(enemyCombatStats, combatStats, alphaCombat, betaCombat, combatElapsedTimeKilling)
    );

    totalHealthLostOnlyKilled -= combatStats.health;

    int32 playerHealth = combatStats.health;
    uint256 totalFoodRequiredKilling;
    (foodConsumed, totalFoodRequiredKilling, died) = _getFoodConsumed(
      from,
      regenerateId,
      totalHealthLost > 0 ? uint32(totalHealthLost) : 0,
      totalHealthLostOnlyKilled > 0 ? uint32(totalHealthLostOnlyKilled) : 0,
      playerHealth,
      alphaCombatHealing,
      itemNFT,
      pendingQueuedActionEquipmentStates
    );

    // Didn't have enough food to survive the best case combat scenario
    if (died) {
      uint256 healthRestored;
      if (regenerateId != NONE) {
        Item memory item = IItemNFT(itemNFT).getItem(regenerateId);
        healthRestored = item.healthRestored;
      }

      // Calculate total health using raw values
      int256 totalHealth = playerHealth + int256(uint256(foodConsumed * healthRestored));
      // How much combat time is required to kill the player
      uint256 killPlayerTime = _timeToKillPlayer(combatStats, enemyCombatStats, alphaCombat, betaCombat, totalHealth);

      combatElapsedTime = Math.min(combatElapsedTime, killPlayerTime); // Needed?
      if (healthRestored == 0 || totalHealthLost <= 0) {
        // No food attached or didn't lose any health

        if (canKillAll) {
          uint256 combatTimePerEnemy = Math.ceilDiv(uint16(enemyCombatStats.health) * respawnTime, dmgDealt);
          numKilled = combatElapsedTime / combatTimePerEnemy;
        } else {
          // In combat the entire time
          numKilled = combatElapsedTime / combatTimePerKill;
        }
      } else {
        // How many can we kill with the food we did consume
        if (totalFoodRequiredKilling != 0) {
          if (foodConsumed < totalFoodRequiredKilling) {
            numKilled = (numKilled * foodConsumed) / totalFoodRequiredKilling;
          }
        } else {
          numKilled = 0;
        }
      }
      xpElapsedTime = respawnTime * numKilled;

      // Step 3.5 - Wasn't enough food, so work out how many consumables we actually used.
      if (actionChoice.rate != 0) {
        // Make sure we use at least 1 per kill
        baseInputItemsConsumedNum = uint16(
          Math.max(numKilled, Math.ceilDiv(combatElapsedTime * actionChoice.rate, 3600 * RATE_MUL))
        );

        // Make sure we don't go above the maximum amount of consumables (scrolls/arrows) that we actually have
        if (baseInputItemsConsumedNum > maxRequiredBaseInputItemsConsumedRatio) {
          uint256 newMaxRequiredBaseInputItemsConsumedRatio = _getMaxRequiredRatio(
            from,
            actionChoice,
            baseInputItemsConsumedNum,
            IItemNFT(itemNFT),
            pendingQueuedActionEquipmentStates
          );

          baseInputItemsConsumedNum = uint16(
            Math.min(baseInputItemsConsumedNum, newMaxRequiredBaseInputItemsConsumedRatio)
          );
        }
      }
    }
  }

  function _calculateHealingDoneFromHealth(
    uint256 health,
    uint256 alphaCombatHealing
  ) private pure returns (uint256 healingDoneFromHealth) {
    // healing fraction = 1 + (alphaCombatHealing * health / 100)
    uint256 scaledHealth = ((HEALING_SCALE * alphaCombatHealing) / 100) * health;
    uint256 divisor = 100;
    healingDoneFromHealth = HEALING_SCALE + scaledHealth / divisor;
  }

  function _calculateTotalFoodRequired(
    uint256 totalHealthLost,
    uint256 healthRestoredFromItem,
    uint256 healingDoneFromHealth
  ) private pure returns (uint256 totalFoodRequired) {
    uint256 numerator = totalHealthLost * HEALING_SCALE;
    uint256 denominator = healthRestoredFromItem * healingDoneFromHealth;
    totalFoodRequired = Math.ceilDiv(numerator, denominator);
  }

  function _getFoodConsumed(
    address from,
    uint16 regenerateId,
    uint32 totalHealthLost,
    uint32 totalHealthLostKilling,
    int32 totalHealthPlayer,
    uint256 alphaCombatHealing,
    address itemNFT,
    PendingQueuedActionEquipmentState[] memory pendingQueuedActionEquipmentStates
  ) private view returns (uint16 foodConsumed, uint256 totalFoodRequiredKilling, bool died) {
    uint256 healthRestoredFromItem;
    if (regenerateId != NONE) {
      Item memory item = IItemNFT(itemNFT).getItem(regenerateId);
      healthRestoredFromItem = item.healthRestored;
    }

    if (healthRestoredFromItem == 0 || totalHealthLost <= 0) {
      // No food attached or didn't lose any health
      died = totalHealthLost != 0;
    } else {
      // Only use positive values for healing bonus
      uint256 effectiveHealth = totalHealthPlayer > 0 ? uint32(totalHealthPlayer) : 0;
      uint256 healingDoneFromHealth = _calculateHealingDoneFromHealth(effectiveHealth, alphaCombatHealing);
      uint256 totalFoodRequired = _calculateTotalFoodRequired(
        totalHealthLost,
        healthRestoredFromItem,
        healingDoneFromHealth
      );
      totalFoodRequiredKilling = _calculateTotalFoodRequired(
        totalHealthLostKilling,
        healthRestoredFromItem,
        healingDoneFromHealth
      );

      uint256 balance = getBalanceUsingCurrentBalance(from, regenerateId, itemNFT, pendingQueuedActionEquipmentStates);

      // Can only consume a maximum of 65535 food
      if (totalFoodRequired > type(uint16).max) {
        died = true;
      } else {
        died = totalFoodRequired > balance;
      }

      if (died) {
        foodConsumed = uint16(balance > type(uint16).max ? type(uint16).max : balance);
      } else {
        foodConsumed = uint16(totalFoodRequired);
      }
    }
  }

  function getNonCombatAdjustedElapsedTime(
    address from,
    address itemNFT,
    uint256 elapsedTime,
    ActionChoice calldata actionChoice,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates
  ) external view returns (uint256 xpElapsedTime, uint16 baseInputItemsConsumedNum) {
    // Check the max that can be used
    baseInputItemsConsumedNum = uint16((elapsedTime * actionChoice.rate) / (3600 * RATE_MUL));

    if (baseInputItemsConsumedNum != 0) {
      // This checks the balances
      uint256 maxRequiredRatio = _getMaxRequiredRatio(
        from,
        actionChoice,
        baseInputItemsConsumedNum,
        IItemNFT(itemNFT),
        pendingQueuedActionEquipmentStates
      );
      bool hadEnoughConsumables = baseInputItemsConsumedNum <= maxRequiredRatio;
      if (!hadEnoughConsumables) {
        baseInputItemsConsumedNum = uint16(maxRequiredRatio);
      }
    }

    // Work out what the actual elapsedTime should be had all those been made
    xpElapsedTime = (uint256(baseInputItemsConsumedNum) * 3600 * RATE_MUL) / actionChoice.rate;
  }

  function _getBoostedTime(
    uint256 actionStartTime,
    uint256 elapsedTime,
    uint40 boostStartTime,
    uint24 boostDuration
  ) internal pure returns (uint24 boostedTime) {
    // Calculate time overlap between action and boost periods
    uint256 actionEndTime = actionStartTime + elapsedTime;
    uint256 boostEndTime = boostStartTime + boostDuration;

    // If there's no overlap or no elapsed time, boosted time is 0
    if (actionStartTime >= boostEndTime || actionEndTime <= boostStartTime || elapsedTime == 0) {
      boostedTime = 0;
    } else {
      // Calculate overlap using max of start times and min of end times
      uint256 overlapStart = actionStartTime > boostStartTime ? actionStartTime : boostStartTime;
      uint256 overlapEnd = actionEndTime < boostEndTime ? actionEndTime : boostEndTime;
      boostedTime = uint24(overlapEnd - overlapStart);
    }
  }

  function getBoostedTime(
    uint256 actionStartTime,
    uint256 elapsedTime,
    uint40 boostStartTime,
    uint24 boostDuration
  ) external pure returns (uint24) {
    return _getBoostedTime(actionStartTime, elapsedTime, boostStartTime, boostDuration);
  }

  function _getXPFromBoostImpl(
    bool isCombatSkill,
    uint256 actionStartTime,
    uint256 xpElapsedTime,
    uint24 xpPerHour,
    BoostType boostType,
    uint40 boostStartTime,
    uint24 boostDuration,
    uint16 boostValue
  ) private pure returns (uint32 boostPointsAccrued) {
    if (
      boostType == BoostType.ANY_XP ||
      (isCombatSkill && boostType == BoostType.COMBAT_XP) ||
      (!isCombatSkill && boostType == BoostType.NON_COMBAT_XP)
    ) {
      uint256 boostedTime = _getBoostedTime(actionStartTime, xpElapsedTime, boostStartTime, boostDuration);
      boostPointsAccrued = uint32((boostedTime * xpPerHour * boostValue) / (3600 * 100));
    }
  }

  function _getXPFromBoost(
    bool isCombatSkill,
    uint256 actionStartTime,
    uint256 xpElapsedTime,
    uint24 xpPerHour,
    BoostType boostType,
    uint40 boostStartTime,
    uint24 boostDuration,
    uint16 boostValue
  ) private pure returns (uint32 boostPointsAccrued) {
    return
      _getXPFromBoostImpl(
        isCombatSkill,
        actionStartTime,
        xpElapsedTime,
        xpPerHour,
        boostType,
        boostStartTime,
        boostDuration,
        boostValue
      );
  }

  function _extraBoostFromFullAttire(
    uint16[] memory itemTokenIds,
    uint256[] memory balances,
    uint16[5] calldata expectedItemTokenIds
  ) private pure returns (bool matches) {
    // Check if they have the full equipment required
    if (itemTokenIds.length == 5) {
      for (uint256 i; i < 5; ++i) {
        if (itemTokenIds[i] != expectedItemTokenIds[i] || balances[i] == 0) {
          return false;
        }
      }
      return true;
    }
  }

  function subtractMatchingRewards(
    uint256[] calldata newIds,
    uint256[] calldata newAmounts,
    uint256[] calldata prevNewIds,
    uint256[] calldata prevNewAmounts
  ) external pure returns (uint256[] memory ids, uint256[] memory amounts) {
    // Subtract previous rewards. If amount is zero after, replace with end and reduce the array size
    ids = newIds;
    amounts = newAmounts;
    uint256 prevNewIdsLength = prevNewIds.length;
    for (uint256 i; i < prevNewIdsLength; ++i) {
      uint16 prevNewId = uint16(prevNewIds[i]);
      uint24 prevNewAmount = uint24(prevNewAmounts[i]);
      uint256 length = ids.length;
      for (uint256 j = 0; j < length; ++j) {
        if (ids[j] == prevNewId) {
          amounts[j] -= prevNewAmount;
          if (amounts[j] == 0) {
            ids[j] = ids[ids.length - 1];
            amounts[j] = amounts[amounts.length - 1];

            assembly ("memory-safe") {
              mstore(ids, length)
              mstore(amounts, length)
            }
            --length;
          }
          break;
        }
      }
    }
  }

  function _readXP(Skill skill, PackedXP storage packedXP) internal view returns (uint256) {
    require(!skill._isSkillCombat() && !skill._isSkill(Skill.TRAVELING), InvalidXPSkill());
    if (skill._isSkillNone()) {
      return 0;
    }
    uint256 offset = 2; // Accounts for NONE & COMBAT meta-skills
    uint256 val = uint8(skill) - offset;
    uint256 slotNum = val / 6;
    uint256 relativePos = val % 6;

    uint256 slotVal;
    assembly ("memory-safe") {
      slotVal := sload(add(packedXP.slot, slotNum))
    }

    return uint40(slotVal >> (relativePos * 40));
  }

  function readXP(Skill skill, PackedXP storage packedXP) external view returns (uint256) {
    return _readXP(skill, packedXP);
  }

  function getCombatStatsFromHero(
    PendingQueuedActionProcessed calldata pendingQueuedActionProcessed,
    PackedXP storage packedXP
  ) external view returns (CombatStats memory combatStats) {
    combatStats.meleeAttack = int16(
      _getLevel(_getAbsoluteActionStartXP(Skill.MELEE, pendingQueuedActionProcessed, packedXP))
    );
    combatStats.rangedAttack = int16(
      _getLevel(_getAbsoluteActionStartXP(Skill.RANGED, pendingQueuedActionProcessed, packedXP))
    );
    combatStats.magicAttack = int16(
      _getLevel(_getAbsoluteActionStartXP(Skill.MAGIC, pendingQueuedActionProcessed, packedXP))
    );
    combatStats.health = int16(
      _getLevel(_getAbsoluteActionStartXP(Skill.HEALTH, pendingQueuedActionProcessed, packedXP))
    );
    uint16 defenceLevel = _getLevel(_getAbsoluteActionStartXP(Skill.DEFENCE, pendingQueuedActionProcessed, packedXP));
    combatStats.meleeDefence = int16(defenceLevel);
    combatStats.rangedDefence = int16(defenceLevel);
    combatStats.magicDefence = int16(defenceLevel);
  }

  function updateCombatStatsFromAttire(
    CombatStats memory combatStats,
    address itemNFT,
    Attire storage attire,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    CheckpointEquipments calldata checkpointEquipments
  ) external view returns (CombatStats memory statsOut) {
    statsOut = combatStats;
    bool skipNonFullAttire;
    (uint16[] memory itemTokenIds, uint256[] memory balances) = getAttireWithBalance(
      attire,
      skipNonFullAttire,
      pendingQueuedActionEquipmentStates,
      checkpointEquipments
    );
    if (itemTokenIds.length != 0) {
      Item[] memory items = IItemNFT(itemNFT).getItems(itemTokenIds);
      for (uint256 i = 0; i < items.length; ++i) {
        if (balances[i] != 0) {
          _updateCombatStatsFromItem(statsOut, items[i]);
        }
      }
    }
  }

  // none of the combat stats are allowed to be negative at this point
  function updateCombatStatsFromPet(
    CombatStats memory combatStats,
    uint8 skillEnhancement1,
    uint8 skillFixedEnhancement1,
    uint8 skillPercentageEnhancement1,
    uint8 skillEnhancement2,
    uint8 skillFixedEnhancement2,
    uint8 skillPercentageEnhancement2
  ) external pure returns (CombatStats memory statsOut) {
    statsOut = combatStats;
    Skill skill1 = skillEnhancement1._asSkill();
    if (skill1 == Skill.HEALTH) {
      statsOut.health += int16(skillFixedEnhancement1 + (uint16(statsOut.health) * skillPercentageEnhancement1) / 100);
    } else if (skill1 == Skill.MELEE) {
      statsOut.meleeAttack += int16(
        skillFixedEnhancement1 + (uint16(statsOut.meleeAttack) * skillPercentageEnhancement1) / 100
      );
    } else if (skill1 == Skill.RANGED) {
      statsOut.rangedAttack += int16(
        skillFixedEnhancement1 + (uint16(statsOut.rangedAttack) * skillPercentageEnhancement1) / 100
      );
    } else if (skill1 == Skill.MAGIC) {
      statsOut.magicAttack += int16(
        skillFixedEnhancement1 + (uint16(statsOut.magicAttack) * skillPercentageEnhancement1) / 100
      );
    } else if (skill1 == Skill.DEFENCE) {
      statsOut.meleeDefence += int16(
        skillFixedEnhancement1 + (uint16(statsOut.meleeDefence) * skillPercentageEnhancement1) / 100
      );
      statsOut.rangedDefence += int16(
        skillFixedEnhancement1 + (uint16(statsOut.rangedDefence) * skillPercentageEnhancement1) / 100
      );
      statsOut.magicDefence += int16(
        skillFixedEnhancement1 + (uint16(statsOut.magicDefence) * skillPercentageEnhancement1) / 100
      );
    } else {
      revert SkillForPetNotHandledYet();
    }

    Skill skill2 = skillEnhancement2._asSkill();
    if (skill2 != Skill.NONE) {
      if (skill2 == Skill.DEFENCE) {
        statsOut.meleeDefence += int16(
          skillFixedEnhancement2 + (uint16(statsOut.meleeDefence) * skillPercentageEnhancement2) / 100
        );
        statsOut.rangedDefence += int16(
          skillFixedEnhancement2 + (uint16(statsOut.rangedDefence) * skillPercentageEnhancement2) / 100
        );
        statsOut.magicDefence += int16(
          skillFixedEnhancement2 + (uint16(statsOut.magicDefence) * skillPercentageEnhancement2) / 100
        );
      } else {
        revert SkillForPetNotHandledYet();
      }
    }
  }

  // 2 versions of getAttireWithBalance exist, 1 has storage attire and the other has calldata attire. This is to
  // allow more versions of versions to accept storage attire.
  function getAttireWithBalance(
    Attire calldata attire,
    bool skipNonFullAttire,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    CheckpointEquipments calldata checkpointEquipments
  ) public pure returns (uint16[] memory itemTokenIds, uint256[] memory balances) {
    uint256 attireLength;
    itemTokenIds = new uint16[](7);
    if (attire.head != NONE) {
      itemTokenIds[attireLength++] = attire.head;
    }
    if (attire.neck != NONE && !skipNonFullAttire) {
      itemTokenIds[attireLength++] = attire.neck;
    }
    if (attire.body != NONE) {
      itemTokenIds[attireLength++] = attire.body;
    }
    if (attire.arms != NONE) {
      itemTokenIds[attireLength++] = attire.arms;
    }
    if (attire.legs != NONE) {
      itemTokenIds[attireLength++] = attire.legs;
    }
    if (attire.feet != NONE) {
      itemTokenIds[attireLength++] = attire.feet;
    }
    if (attire.ring != NONE && !skipNonFullAttire) {
      itemTokenIds[attireLength++] = attire.ring;
    }

    assembly ("memory-safe") {
      mstore(itemTokenIds, attireLength)
    }

    if (attireLength != 0) {
      balances = getBalancesUsingCheckpoint(itemTokenIds, pendingQueuedActionEquipmentStates, checkpointEquipments);
    }
  }

  function getAttireTokenIds(
    Attire memory attire,
    bool skipNonFullAttire
  ) public pure returns (uint16[] memory itemTokenIds) {
    uint256 attireLength;
    itemTokenIds = new uint16[](7);
    if (attire.head != NONE) {
      itemTokenIds[attireLength++] = attire.head;
    }
    if (attire.neck != NONE && !skipNonFullAttire) {
      itemTokenIds[attireLength++] = attire.neck;
    }
    if (attire.body != NONE) {
      itemTokenIds[attireLength++] = attire.body;
    }
    if (attire.arms != NONE) {
      itemTokenIds[attireLength++] = attire.arms;
    }
    if (attire.legs != NONE) {
      itemTokenIds[attireLength++] = attire.legs;
    }
    if (attire.feet != NONE) {
      itemTokenIds[attireLength++] = attire.feet;
    }
    if (attire.ring != NONE && !skipNonFullAttire) {
      itemTokenIds[attireLength++] = attire.ring;
    }
    assembly ("memory-safe") {
      mstore(itemTokenIds, attireLength)
    }
  }

  function getAttireWithCurrentBalance(
    address from,
    Attire memory attire,
    address itemNFT,
    bool skipNonFullAttire
  ) external view returns (uint16[] memory itemTokenIds, uint256[] memory balances) {
    itemTokenIds = getAttireTokenIds(attire, skipNonFullAttire);
    if (itemTokenIds.length != 0) {
      balances = IItemNFT(itemNFT).balanceOfs(from, itemTokenIds);
    }
  }

  function getAttireWithBalance(
    Attire storage attire,
    bool skipNonFullAttire,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    CheckpointEquipments calldata checkpointEquipments
  ) public pure returns (uint16[] memory itemTokenIds, uint256[] memory balances) {
    itemTokenIds = getAttireTokenIds(attire, skipNonFullAttire);
    if (itemTokenIds.length != 0) {
      balances = getBalancesUsingCheckpoint(itemTokenIds, pendingQueuedActionEquipmentStates, checkpointEquipments);
    }
  }

  // Subtract any existing xp gained from the first in-progress actions and add the new xp gained
  function getAbsoluteActionStartXP(
    uint8 skillId,
    PendingQueuedActionProcessed calldata pendingQueuedActionProcessed,
    PackedXP storage packedXP
  ) public view returns (uint256) {
    return _getAbsoluteActionStartXP(skillId._asSkill(), pendingQueuedActionProcessed, packedXP);
  }

  // Subtract any existing xp gained from the first in-progress actions and add the new xp gained
  function _getAbsoluteActionStartXP(
    Skill skill,
    PendingQueuedActionProcessed calldata pendingQueuedActionProcessed,
    PackedXP storage packedXP
  ) internal view returns (uint256) {
    uint256 xp = _readXP(skill, packedXP);
    if (pendingQueuedActionProcessed.currentAction.skill1 == skill) {
      xp -= pendingQueuedActionProcessed.currentAction.xpGained1;
    } else if (pendingQueuedActionProcessed.currentAction.skill2 == skill) {
      xp -= pendingQueuedActionProcessed.currentAction.xpGained2;
    } else if (pendingQueuedActionProcessed.currentAction.skill3 == skill) {
      xp -= pendingQueuedActionProcessed.currentAction.xpGained3;
    }

    // Add any new xp gained from previous actions now completed that haven't been pushed to the blockchain yet. For instance
    // battling monsters may increase your level so you are stronger for a later queued action.
    for (uint256 i; i < pendingQueuedActionProcessed.skills.length; ++i) {
      if (pendingQueuedActionProcessed.skills[i] == skill) {
        xp += pendingQueuedActionProcessed.xpGainedSkills[i];
      }
    }

    return xp;
  }

  function updateStatsFromHandEquipment(
    address itemNFT,
    uint16[2] calldata handEquipmentTokenIds,
    CombatStats calldata combatStats,
    bool isCombat,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    uint16 handItemTokenIdRangeMin,
    CheckpointEquipments calldata checkpointEquipments
  ) external view returns (bool missingRequiredHandEquipment, CombatStats memory statsOut) {
    statsOut = combatStats;
    for (uint256 i = 0; i < handEquipmentTokenIds.length; ++i) {
      uint16 handEquipmentTokenId = handEquipmentTokenIds[i];
      if (handEquipmentTokenId != NONE) {
        uint256 balance = getBalanceUsingCheckpoint(
          handEquipmentTokenId,
          pendingQueuedActionEquipmentStates,
          checkpointEquipments
        );
        if (balance == 0) {
          // Assume that if the player doesn't have the non-combat item that this action cannot be done or if the action choice required it (e.g range bows)
          if (!isCombat || handItemTokenIdRangeMin != NONE) {
            missingRequiredHandEquipment = true;
          }
        } else if (isCombat) {
          // Update the combat stats
          Item memory item = IItemNFT(itemNFT).getItem(handEquipmentTokenId);
          _updateCombatStatsFromItem(statsOut, item);
        }
      }
    }
  }

  function _updateCombatStatsFromItem(CombatStats memory combatStats, Item memory item) internal pure {
    combatStats.meleeAttack += item.meleeAttack;
    combatStats.rangedAttack += item.rangedAttack;
    combatStats.magicAttack += item.magicAttack;
    combatStats.meleeDefence += item.meleeDefence;
    combatStats.rangedDefence += item.rangedDefence;
    combatStats.magicDefence += item.magicDefence;
    combatStats.health += item.health;
  }

  function getBonusAvatarXPPercent(Player storage player, uint8 skillId) public view returns (uint8 bonusPercent) {
    return _getBonusAvatarXPPercent(player, skillId._asSkill());
  }

  function _getBonusAvatarXPPercent(Player storage player, Skill skill) internal view returns (uint8 bonusPercent) {
    bool hasBonusSkill = player.skillBoosted1 == skill || player.skillBoosted2 == skill;
    if (!hasBonusSkill) {
      return 0;
    }
    bool bothSet = player.skillBoosted1 != Skill.NONE && player.skillBoosted2 != Skill.NONE;
    bonusPercent = bothSet ? 5 : 10;
    // Upgraded characters get double base bonus stats
    bool isUpgraded = uint8(player.packedData >> IS_FULL_MODE_BIT) & 1 == 1;
    bonusPercent = isUpgraded ? bonusPercent * 2 : bonusPercent;
  }

  function _extraFromAvatar(
    Player storage player,
    Skill skill,
    uint256 elapsedTime,
    uint24 xpPerHour
  ) internal view returns (uint32 extraPointsAccrued) {
    uint8 bonusPercent = _getBonusAvatarXPPercent(player, skill);
    extraPointsAccrued = uint32((elapsedTime * xpPerHour * bonusPercent) / (3600 * 100));
  }

  function getPointsAccrued(
    Player storage player,
    QueuedAction storage queuedAction,
    uint256 startTime,
    uint8 skillId,
    uint256 xpElapsedTime,
    Attire storage attire,
    ExtendedBoostInfo storage playerBoost,
    StandardBoostInfo storage globalBoost,
    StandardBoostInfo storage clanBoost,
    address worldActions,
    uint8 bonusAttirePercent,
    uint16[5] calldata expectedItemTokenIds,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    CheckpointEquipments calldata checkpointEquipments
  ) external view returns (uint32 pointsAccrued, uint32 pointsAccruedExclBaseBoost) {
    Skill skill = skillId._asSkill();
    bool isCombatSkill = queuedAction.combatStyle._isCombatStyle();
    uint24 xpPerHour = IWorldActions(worldActions).getXPPerHour(
      queuedAction.actionId,
      isCombatSkill ? NONE : queuedAction.choiceId
    );
    // Add logs right after base XP calculation
    pointsAccrued = uint32((xpElapsedTime * xpPerHour) / 3600);
    // Normal Player specific boosts
    pointsAccrued += _getXPFromBoost(
      isCombatSkill,
      startTime,
      xpElapsedTime,
      xpPerHour,
      playerBoost.boostType,
      playerBoost.startTime,
      playerBoost.duration,
      playerBoost.value
    );
    pointsAccrued += _getXPFromBoost(
      isCombatSkill,
      startTime,
      xpElapsedTime,
      xpPerHour,
      playerBoost.lastBoostType,
      playerBoost.lastStartTime,
      playerBoost.lastDuration,
      playerBoost.lastValue
    );
    // Any extra boosts like wish or lucky boosts. Only needed if bit is set (TODO)
    if (((uint8(playerBoost.packedData) >> HAS_EXTRA_BOOST_BIT) & 1) == 1) {
      pointsAccrued += _getXPFromBoost(
        isCombatSkill,
        startTime,
        xpElapsedTime,
        xpPerHour,
        playerBoost.extraBoostType,
        playerBoost.extraStartTime,
        playerBoost.extraDuration,
        playerBoost.extraValue
      );
      pointsAccrued += _getXPFromBoost(
        isCombatSkill,
        startTime,
        xpElapsedTime,
        xpPerHour,
        playerBoost.lastExtraBoostType,
        playerBoost.lastExtraStartTime,
        playerBoost.lastExtraDuration,
        playerBoost.lastExtraValue
      );
    }
    // Global boost
    StandardBoostInfo memory globalBoost_ = globalBoost;
    pointsAccrued += _getXPFromBoost(
      isCombatSkill,
      startTime,
      xpElapsedTime,
      xpPerHour,
      globalBoost_.boostType,
      globalBoost_.startTime,
      globalBoost_.duration,
      globalBoost_.value
    );
    pointsAccrued += _getXPFromBoost(
      isCombatSkill,
      startTime,
      xpElapsedTime,
      xpPerHour,
      globalBoost_.lastBoostType,
      globalBoost_.lastStartTime,
      globalBoost_.lastDuration,
      globalBoost_.lastValue
    );
    StandardBoostInfo memory clanBoost_ = clanBoost;
    // Clan boost
    pointsAccrued += _getXPFromBoost(
      isCombatSkill,
      startTime,
      xpElapsedTime,
      xpPerHour,
      clanBoost_.boostType,
      clanBoost_.startTime,
      clanBoost_.duration,
      clanBoost_.value
    );
    pointsAccrued += _getXPFromBoost(
      isCombatSkill,
      startTime,
      xpElapsedTime,
      xpPerHour,
      clanBoost_.lastBoostType,
      clanBoost_.lastStartTime,
      clanBoost_.lastDuration,
      clanBoost_.lastValue
    );

    pointsAccrued += _extraXPFromFullAttire(
      attire,
      xpElapsedTime,
      xpPerHour,
      bonusAttirePercent,
      expectedItemTokenIds,
      pendingQueuedActionEquipmentStates,
      checkpointEquipments
    );
    pointsAccruedExclBaseBoost = pointsAccrued;
    pointsAccrued += _extraFromAvatar(player, skill, xpElapsedTime, xpPerHour);
  }

  function _extraXPFromFullAttire(
    Attire storage attire,
    uint256 elapsedTime,
    uint24 xpPerHour,
    uint8 bonusPercent,
    uint16[5] calldata expectedItemTokenIds,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    CheckpointEquipments calldata checkpointEquipments
  ) internal pure returns (uint32 extraPointsAccrued) {
    if (bonusPercent == 0) {
      return 0;
    }
    // Check if they have the full equipment set, if so they can get some bonus
    bool skipNonFullAttire = true;
    (uint16[] memory itemTokenIds, uint256[] memory balances) = getAttireWithBalance(
      attire,
      skipNonFullAttire,
      pendingQueuedActionEquipmentStates,
      checkpointEquipments
    );
    bool hasFullAttire = _extraBoostFromFullAttire(itemTokenIds, balances, expectedItemTokenIds);
    if (hasFullAttire) {
      extraPointsAccrued = uint32((elapsedTime * xpPerHour * bonusPercent) / (3600 * 100));
    }
  }

  function getSuccessPercent(
    uint16 actionId,
    uint8 actionSkillId,
    bool isCombat,
    PendingQueuedActionProcessed calldata pendingQueuedActionProcessed,
    address worldActions,
    uint256 maxSuccessPercentChange,
    PackedXP storage packedXP
  ) external view returns (uint8 successPercent) {
    successPercent = 100;
    (uint8 actionSuccessPercent, uint32 minXP) = IWorldActions(worldActions).getActionSuccessPercentAndMinXP(actionId);
    if (actionSuccessPercent != 100) {
      require(!isCombat, InvalidAction());

      uint256 minLevel = _getLevel(minXP);
      uint256 skillLevel = _getLevel(
        _getAbsoluteActionStartXP(actionSkillId._asSkill(), pendingQueuedActionProcessed, packedXP)
      );
      uint256 extraBoost = skillLevel - minLevel;

      successPercent = uint8(Math.min(maxSuccessPercentChange, actionSuccessPercent + extraBoost));
    }
  }

  function getFullAttireBonusRewardsPercent(
    Attire storage attire,
    PendingQueuedActionEquipmentState[] calldata pendingQueuedActionEquipmentStates,
    uint8 bonusRewardsPercent,
    uint16[5] calldata fullAttireBonusItemTokenIds,
    CheckpointEquipments calldata checkpointEquipments
  ) external pure returns (uint8 fullAttireBonusRewardsPercent) {
    if (bonusRewardsPercent == 0) {
      return 0;
    }

    // Check if they have the full equipment set, if so they can get some bonus
    bool skipNonFullAttire = true;
    (uint16[] memory itemTokenIds, uint256[] memory balances) = getAttireWithBalance(
      attire,
      skipNonFullAttire,
      pendingQueuedActionEquipmentStates,
      checkpointEquipments
    );
    bool hasFullAttire = _extraBoostFromFullAttire(itemTokenIds, balances, fullAttireBonusItemTokenIds);

    if (hasFullAttire) {
      fullAttireBonusRewardsPercent = bonusRewardsPercent;
    }
  }

  function _appendGuaranteedRewards(
    uint256[] memory ids,
    uint256[] memory amounts,
    uint256 elapsedTime,
    ActionRewards memory actionRewards,
    uint16 monstersKilled,
    bool isCombat,
    uint8 successPercent
  ) internal pure returns (uint256 length) {
    length = _appendGuaranteedReward(
      ids,
      amounts,
      elapsedTime,
      actionRewards.guaranteedRewardTokenId1,
      actionRewards.guaranteedRewardRate1,
      length,
      monstersKilled,
      isCombat,
      successPercent
    );
    length = _appendGuaranteedReward(
      ids,
      amounts,
      elapsedTime,
      actionRewards.guaranteedRewardTokenId2,
      actionRewards.guaranteedRewardRate2,
      length,
      monstersKilled,
      isCombat,
      successPercent
    );
    length = _appendGuaranteedReward(
      ids,
      amounts,
      elapsedTime,
      actionRewards.guaranteedRewardTokenId3,
      actionRewards.guaranteedRewardRate3,
      length,
      monstersKilled,
      isCombat,
      successPercent
    );
  }

  function _appendGuaranteedReward(
    uint256[] memory ids,
    uint256[] memory amounts,
    uint256 elapsedTime,
    uint16 rewardTokenId,
    uint24 rewardRate,
    uint256 oldLength,
    uint16 monstersKilled,
    bool isCombat,
    uint8 successPercent
  ) internal pure returns (uint256 length) {
    length = oldLength;
    if (rewardTokenId != NONE) {
      uint256 numRewards;
      if (isCombat) {
        numRewards = (monstersKilled * rewardRate) / GUAR_MUL; // rate is per kill
      } else {
        numRewards = (elapsedTime * rewardRate * successPercent) / (3600 * GUAR_MUL * 100);
      }

      if (numRewards != 0) {
        ids[length] = rewardTokenId;
        amounts[length] = numRewards;
        length++;
      }
    }
  }
}

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

import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
import {IERC1155Receiver} from "@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol";
import {IERC1155MetadataURI} from "@openzeppelin/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol";
import {ContextUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ContextUpgradeable.sol";
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {ERC165Upgradeable} from "@openzeppelin/contracts-upgradeable/utils/introspection/ERC165Upgradeable.sol";
import {Arrays} from "@openzeppelin/contracts/utils/Arrays.sol";
import {IERC1155Errors} from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";

/**
 * @dev Implementation of the basic standard multi-token.
 * See https://eips.ethereum.org/EIPS/eip-1155
 * Originally based on code by OpenZeppelin v5.0.0
 */
abstract contract SamWitchERC1155UpgradeableSinglePerToken is
  Initializable,
  ContextUpgradeable,
  ERC165Upgradeable,
  IERC1155,
  IERC1155MetadataURI,
  IERC1155Errors
{
  using Arrays for uint256[];
  using Arrays for address[];

  error ERC1155MintingMoreThanOneSameNFT();

  // Mapping from token ID to account balances
  mapping(uint256 tokenId => address owner) private _owner; // This is just the default, can be overriden

  // Mapping from account to operator approvals
  mapping(address => mapping(address => bool)) private _operatorApprovals;

  // Used as the URI for all token types by relying on ID substitution, e.g. https://token-cdn-domain/{id}.json
  string private _uri;

  uint40 internal _totalSupplyAll;

  /**
   * @dev See {_setURI}.
   */
  function __SamWitchERC1155UpgradeableSinglePerToken_init(string memory uri_) internal onlyInitializing {
    __SamWitchERC1155UpgradeableSinglePerToken_init_unchained(uri_);
  }

  function __SamWitchERC1155UpgradeableSinglePerToken_init_unchained(string memory uri_) internal onlyInitializing {
    _setURI(uri_);
  }

  function totalSupply(uint256 tokenId) public view returns (uint256) {
    return _exists(tokenId) ? 1 : 0;
  }

  function totalSupply() external view returns (uint256) {
    return _totalSupplyAll;
  }

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

  /**
   * @dev See {IERC1155MetadataURI-uri}.
   *
   * This implementation returns the same URI for *all* token types. It relies
   * on the token type ID substitution mechanism
   * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
   *
   * Clients calling this function must replace the `\{id\}` substring with the
   * actual token type ID.
   */
  function uri(uint256 /* id */) public view virtual returns (string memory) {
    return _uri;
  }

  /**
   * Override this function to return the owner of the token if you have a better packed implementation
   */
  function ownerOf(uint256 id) public view virtual returns (address) {
    return _owner[id];
  }

  /**
   * @dev See {IERC1155-balanceOf}.
   */
  function balanceOf(address account, uint256 id) public view virtual returns (uint256) {
    return ownerOf(id) == account ? 1 : 0;
  }

  /**
   * @dev See {IERC1155-balanceOfBatch}.
   *
   * Requirements:
   *
   * - `accounts` and `ids` must have the same length.
   */
  function balanceOfBatch(
    address[] memory accounts,
    uint256[] memory ids
  ) public view virtual returns (uint256[] memory) {
    if (accounts.length != ids.length) {
      revert ERC1155InvalidArrayLength(ids.length, accounts.length);
    }

    uint256[] memory batchBalances = new uint256[](accounts.length);

    for (uint256 i = 0; i < accounts.length; ++i) {
      batchBalances[i] = balanceOf(accounts.unsafeMemoryAccess(i), ids.unsafeMemoryAccess(i));
    }

    return batchBalances;
  }

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

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

  /**
   * @dev See {IERC1155-safeTransferFrom}.
   */
  function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes memory data) public virtual {
    address sender = _msgSender();
    if (from != sender && !isApprovedForAll(from, sender)) {
      revert ERC1155MissingApprovalForAll(sender, from);
    }
    _safeTransferFrom(from, to, id, value, data);
  }

  /**
   * @dev See {IERC1155-safeBatchTransferFrom}.
   */
  function safeBatchTransferFrom(
    address from,
    address to,
    uint256[] memory ids,
    uint256[] memory values,
    bytes memory data
  ) public virtual {
    address sender = _msgSender();
    if (from != sender && !isApprovedForAll(from, sender)) {
      revert ERC1155MissingApprovalForAll(sender, from);
    }
    _safeBatchTransferFrom(from, to, ids, values, data);
  }

  /**
   * @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`. Will mint (or burn) if `from`
   * (or `to`) is the zero address.
   *
   * Emits a {TransferSingle} event if the arrays contain one element, and {TransferBatch} otherwise.
   *
   * Requirements:
   *
   * - If `to` refers to a smart contract, it must implement either {IERC1155Receiver-onERC1155Received}
   *   or {IERC1155Receiver-onERC1155BatchReceived} and return the acceptance magic value.
   * - `ids` and `values` must have the same length.
   *
   * NOTE: The ERC-1155 acceptance check is not performed in this function. See {_updateWithAcceptanceCheck} instead.
   */
  function _update(address from, address to, uint256[] memory ids, uint256[] memory values) internal virtual {
    if (ids.length != values.length) {
      revert ERC1155InvalidArrayLength(ids.length, values.length);
    }

    address operator = _msgSender();

    bool isBurnt = to == address(0);
    bool isMinted = from == address(0);

    for (uint256 i = 0; i < ids.length; ++i) {
      uint256 id = ids.unsafeMemoryAccess(i);
      uint256 value = values.unsafeMemoryAccess(i);

      if (!isMinted) {
        uint256 fromBalance = ownerOf(id) == from ? 1 : 0;
        if (fromBalance < value) {
          revert ERC1155InsufficientBalance(from, fromBalance, value, id);
        }
      } else {
        if (value > 1 || totalSupply(id) != 0) {
          revert ERC1155MintingMoreThanOneSameNFT();
        }
      }

      if (isBurnt) {
        _updateOwner(id, from, address(0));
      } else if (from != to) {
        _updateOwner(id, from, to);
      }
    }

    if (ids.length == 1) {
      uint256 id = ids.unsafeMemoryAccess(0);
      uint256 value = values.unsafeMemoryAccess(0);
      emit TransferSingle(operator, from, to, id, value);

      if (isBurnt) {
        unchecked {
          --_totalSupplyAll;
        }
      } else if (isMinted) {
        unchecked {
          ++_totalSupplyAll;
        }
      }
    } else {
      if (isBurnt) {
        unchecked {
          _totalSupplyAll = uint40(_totalSupplyAll - ids.length);
        }
      } else if (isMinted) {
        unchecked {
          _totalSupplyAll = uint40(_totalSupplyAll + ids.length);
        }
      }

      emit TransferBatch(operator, from, to, ids, values);
    }
  }

  /**
   * @dev Version of {_update} that performs the token acceptance check by calling
   * {IERC1155Receiver-onERC1155Received} or {IERC1155Receiver-onERC1155BatchReceived} on the receiver address if it
   * contains code (eg. is a smart contract at the moment of execution).
   *
   * IMPORTANT: Overriding this function is discouraged because it poses a reentrancy risk from the receiver. So any
   * update to the contract state after this function would break the check-effect-interaction pattern. Consider
   * overriding {_update} instead.
   */
  function _updateWithAcceptanceCheck(
    address from,
    address to,
    uint256[] memory ids,
    uint256[] memory values,
    bytes memory data
  ) internal virtual {
    _update(from, to, ids, values);
    if (to != address(0)) {
      address operator = _msgSender();
      if (ids.length == 1) {
        uint256 id = ids.unsafeMemoryAccess(0);
        uint256 value = values.unsafeMemoryAccess(0);
        _doSafeTransferAcceptanceCheck(operator, from, to, id, value, data);
      } else {
        _doSafeBatchTransferAcceptanceCheck(operator, from, to, ids, values, data);
      }
    }
  }

  /**
   * @dev Transfers a `value` tokens of token type `id` from `from` to `to`.
   *
   * Emits a {TransferSingle} event.
   *
   * Requirements:
   *
   * - `to` cannot be the zero address.
   * - `from` must have a balance of tokens of type `id` of at least `value` amount.
   * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
   * acceptance magic value.
   */
  function _safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes memory data) internal {
    if (to == address(0)) {
      revert ERC1155InvalidReceiver(address(0));
    }
    if (from == address(0)) {
      revert ERC1155InvalidSender(address(0));
    }
    (uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
    _updateWithAcceptanceCheck(from, to, ids, values, data);
  }

  /**
   * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_safeTransferFrom}.
   *
   * Emits a {TransferBatch} event.
   *
   * Requirements:
   *
   * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
   * acceptance magic value.
   * - `ids` and `values` must have the same length.
   */
  function _safeBatchTransferFrom(
    address from,
    address to,
    uint256[] memory ids,
    uint256[] memory values,
    bytes memory data
  ) internal {
    if (to == address(0)) {
      revert ERC1155InvalidReceiver(address(0));
    }
    if (from == address(0)) {
      revert ERC1155InvalidSender(address(0));
    }
    _updateWithAcceptanceCheck(from, to, ids, values, data);
  }

  /**
   * @dev Sets a new URI for all token types, by relying on the token type ID
   * substitution mechanism
   * https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
   *
   * By this mechanism, any occurrence of the `\{id\}` substring in either the
   * URI or any of the values in the JSON file at said URI will be replaced by
   * clients with the token type ID.
   *
   * For example, the `https://token-cdn-domain/\{id\}.json` URI would be
   * interpreted by clients as
   * `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
   * for token type ID 0x4cce0.
   *
   * See {uri}.
   *
   * Because these URIs cannot be meaningfully represented by the {URI} event,
   * this function emits no events.
   */
  function _setURI(string memory newuri) internal virtual {
    _uri = newuri;
  }

  /**
   * @dev Creates a `value` amount of tokens of type `id`, and assigns them to `to`.
   *
   * Emits a {TransferSingle} event.
   *
   * Requirements:
   *
   * - `to` cannot be the zero address.
   * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
   * acceptance magic value.
   */
  function _mint(address to, uint256 id, uint256 value, bytes memory data) internal {
    if (to == address(0)) {
      revert ERC1155InvalidReceiver(address(0));
    }
    (uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
    _updateWithAcceptanceCheck(address(0), to, ids, values, data);
  }

  /**
   * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
   *
   * Emits a {TransferBatch} event.
   *
   * Requirements:
   *
   * - `ids` and `values` must have the same length.
   * - `to` cannot be the zero address.
   * - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
   * acceptance magic value.
   */
  function _mintBatch(address to, uint256[] memory ids, uint256[] memory values, bytes memory data) internal {
    if (to == address(0)) {
      revert ERC1155InvalidReceiver(address(0));
    }
    _updateWithAcceptanceCheck(address(0), to, ids, values, data);
  }

  /**
   * @dev Destroys a `value` amount of tokens of type `id` from `from`
   *
   * Emits a {TransferSingle} event.
   *
   * Requirements:
   *
   * - `from` cannot be the zero address.
   * - `from` must have at least `value` amount of tokens of type `id`.
   */
  function _burn(address from, uint256 id, uint256 value) internal {
    if (from == address(0)) {
      revert ERC1155InvalidSender(address(0));
    }
    (uint256[] memory ids, uint256[] memory values) = _asSingletonArrays(id, value);
    _updateWithAcceptanceCheck(from, address(0), ids, values, "");
  }

  /**
   * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
   *
   * Emits a {TransferBatch} event.
   *
   * Requirements:
   *
   * - `from` cannot be the zero address.
   * - `from` must have at least `value` amount of tokens of type `id`.
   * - `ids` and `values` must have the same length.
   */
  function _burnBatch(address from, uint256[] memory ids) internal {
    if (from == address(0)) {
      revert ERC1155InvalidSender(address(0));
    }
    uint256[] memory amounts = new uint256[](ids.length);
    for (uint256 i = 0; i < ids.length; ++i) {
      amounts[i] = 1;
    }
    _updateWithAcceptanceCheck(from, address(0), ids, amounts, "");
  }

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

  /**
   * @dev Performs an acceptance check by calling {IERC1155-onERC1155Received} on the `to` address
   * if it contains code at the moment of execution.
   */
  function _doSafeTransferAcceptanceCheck(
    address operator,
    address from,
    address to,
    uint256 id,
    uint256 value,
    bytes memory data
  ) private {
    if (to.code.length > 0) {
      try IERC1155Receiver(to).onERC1155Received(operator, from, id, value, data) returns (bytes4 response) {
        if (response != IERC1155Receiver.onERC1155Received.selector) {
          // Tokens rejected
          revert ERC1155InvalidReceiver(to);
        }
      } catch (bytes memory reason) {
        if (reason.length == 0) {
          // non-ERC1155Receiver implementer
          revert ERC1155InvalidReceiver(to);
        } else {
          assembly ("memory-safe") {
            revert(add(32, reason), mload(reason))
          }
        }
      }
    }
  }

  /**
   * @dev Performs a batch acceptance check by calling {IERC1155-onERC1155BatchReceived} on the `to` address
   * if it contains code at the moment of execution.
   */
  function _doSafeBatchTransferAcceptanceCheck(
    address operator,
    address from,
    address to,
    uint256[] memory ids,
    uint256[] memory values,
    bytes memory data
  ) private {
    if (to.code.length > 0) {
      try IERC1155Receiver(to).onERC1155BatchReceived(operator, from, ids, values, data) returns (bytes4 response) {
        if (response != IERC1155Receiver.onERC1155BatchReceived.selector) {
          // Tokens rejected
          revert ERC1155InvalidReceiver(to);
        }
      } catch (bytes memory reason) {
        if (reason.length == 0) {
          // non-ERC1155Receiver implementer
          revert ERC1155InvalidReceiver(to);
        } else {
          assembly ("memory-safe") {
            revert(add(32, reason), mload(reason))
          }
        }
      }
    }
  }

  /**
   * @dev Creates an array in memory with only one value for each of the elements provided.
   */
  function _asSingletonArrays(
    uint256 element1,
    uint256 element2
  ) private pure returns (uint256[] memory array1, uint256[] memory array2) {
    assembly ("memory-safe") {
      // Load the free memory pointer
      array1 := mload(0x40)
      // Set array length to 1
      mstore(array1, 1)
      // Store the single element at the next word after the length (where content starts)
      mstore(add(array1, 0x20), element1)

      // Repeat for next array locating it right after the first array
      array2 := add(array1, 0x40)
      mstore(array2, 1)
      mstore(add(array2, 0x20), element2)

      // Update the free memory pointer by pointing after the second array
      mstore(0x40, add(array2, 0x40))
    }
  }

  // Override this function if _updateOwner is overriden
  function _exists(uint256 tokenId) internal view virtual returns (bool) {
    return _owner[tokenId] != address(0);
  }

  function _updateOwner(uint256 id, address /*from */, address to) internal virtual {
    _owner[id] = to;
  }
}

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

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

/// @notice This contract is used to store the gas price required to maintain VRF oracle balance used for VRF callbacks
contract VRFRequestInfo is UUPSUpgradeable, OwnableUpgradeable {
  event UpdateMovingAverageGasPrice(uint256 movingAverageGasPrice);
  event SetBaseRequestCost(uint256 baseRequestCost);

  error NotUpdater();

  uint256 constant GAS_PRICE_WINDOW_SIZE = 4;

  uint8 private _indexGasPrice;
  uint64 private _movingAverageGasPrice;
  uint88 private _baseRequestCost;
  uint64[GAS_PRICE_WINDOW_SIZE] private _prices;
  mapping(address account => bool isUpdater) private _updaters;

  modifier onlyUpdater() {
    require(_updaters[_msgSender()], NotUpdater());
    _;
  }

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

  function initialize() external initializer {
    __Ownable_init(_msgSender());
    __UUPSUpgradeable_init();

    setBaseAttackCost(0.01 ether);
    _updateMovingAverageGasPrice(uint64(tx.gasprice));
    for (uint256 i; i < GAS_PRICE_WINDOW_SIZE; ++i) {
      _prices[i] = uint64(tx.gasprice);
    }
  }

  function updateAverageGasPrice() external onlyUpdater {
    uint256 _sum = 0;
    _prices[_indexGasPrice] = uint64(tx.gasprice);
    _indexGasPrice = uint8((_indexGasPrice + 1) % GAS_PRICE_WINDOW_SIZE);

    for (uint256 i = 0; i < GAS_PRICE_WINDOW_SIZE; ++i) {
      _sum += _prices[i];
    }

    _updateMovingAverageGasPrice(uint64(_sum / GAS_PRICE_WINDOW_SIZE));
  }

  function _updateMovingAverageGasPrice(uint64 movingAverageGasPrice) private {
    _movingAverageGasPrice = movingAverageGasPrice;
    emit UpdateMovingAverageGasPrice(movingAverageGasPrice);
  }

  function get() external view returns (uint64, uint88) {
    return (_movingAverageGasPrice, _baseRequestCost);
  }

  function getMovingAverageGasPrice() external view returns (uint64) {
    return _movingAverageGasPrice;
  }

  function getBaseRequestCost() external view returns (uint88) {
    return _baseRequestCost;
  }

  function setBaseAttackCost(uint88 baseRequestCost) public onlyOwner {
    _baseRequestCost = baseRequestCost;
    emit SetBaseRequestCost(baseRequestCost);
  }

  function setUpdaters(address[] calldata updaters, bool isUpdater) external onlyOwner {
    for (uint256 i; i < updaters.length; ++i) {
      _updaters[updaters[i]] = isUpdater;
    }
  }

  // solhint-disable-next-line no-empty-blocks
  function _authorizeUpgrade(address newImplementation) internal override onlyOwner {}
}

{
  "evmVersion": "cancun",
  "optimizer": {
    "enabled": true,
    "runs": 1000,
    "details": {
      "yul": true
    }
  },
  "viaIR": true,
  "outputSelection": {
    "*": {
      "*": [
        "evm.bytecode",
        "evm.deployedBytecode",
        "devdoc",
        "userdoc",
        "metadata",
        "abi"
      ]
    }
  },
  "metadata": {
    "useLiteralContent": true
  },
  "libraries": {}
}

• No Contract Security Audit Submitted- Submit Audit Here

[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"target","type":"address"}],"name":"AddressEmptyCode","type":"error"},{"inputs":[],"name":"AmountTooLow","type":"error"},{"inputs":[],"name":"BlockAttacksCooldown","type":"error"},{"inputs":[],"name":"CallerNotSamWitchVRF","type":"error"},{"inputs":[],"name":"CannotAttackSelf","type":"error"},{"inputs":[],"name":"CannotAttackWhileStillAttacking","type":"error"},{"inputs":[],"name":"CannotChangeCombatantsDuringAttack","type":"error"},{"inputs":[],"name":"ClanAttackingCooldown","type":"error"},{"inputs":[],"name":"ClanCombatantsChangeCooldown","type":"error"},{"inputs":[],"name":"ClanIsBlockingAttacks","type":"error"},{"inputs":[{"internalType":"address","name":"implementation","type":"address"}],"name":"ERC1967InvalidImplementation","type":"error"},{"inputs":[],"name":"ERC1967NonPayable","type":"error"},{"inputs":[],"name":"FailedCall","type":"error"},{"inputs":[],"name":"HarvestingTooSoon","type":"error"},{"inputs":[],"name":"InsufficientCost","type":"error"},{"inputs":[],"name":"InvalidEmissionPercentage","type":"error"},{"inputs":[],"name":"InvalidInitialization","type":"error"},{"inputs":[{"internalType":"enum Skill","name":"skill","type":"uint8"}],"name":"InvalidSkill","type":"error"},{"inputs":[],"name":"InvalidTerritory","type":"error"},{"inputs":[],"name":"InvalidTerritoryId","type":"error"},{"inputs":[],"name":"LengthMismatch","type":"error"},{"inputs":[],"name":"NoCombatants","type":"error"},{"inputs":[],"name":"NoEmissionsToHarvest","type":"error"},{"inputs":[],"name":"NotATerritoryDefenceItem","type":"error"},{"inputs":[],"name":"NotAdminAndBeta","type":"error"},{"inputs":[{"internalType":"uint256","name":"minimumMMR","type":"uint256"}],"name":"NotEnoughMMR","type":"error"},{"inputs":[],"name":"NotEnoughRandomWords","type":"error"},{"inputs":[],"name":"NotInitializing","type":"error"},{"inputs":[],"name":"NotMemberOfClan","type":"error"},{"inputs":[],"name":"NotOwnerOfPlayerAndActive","type":"error"},{"inputs":[],"name":"OnlyClans","type":"error"},{"inputs":[],"name":"OnlyCombatantsHelper","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","type":"error"},{"inputs":[],"name":"PlayerDefendingLockedVaults","type":"error"},{"inputs":[],"name":"RankNotHighEnough","type":"error"},{"inputs":[],"name":"RequestIdNotKnown","type":"error"},{"inputs":[{"internalType":"uint8","name":"bits","type":"uint8"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"SafeCastOverflowedUintDowncast","type":"error"},{"inputs":[],"name":"TooManyAttackers","type":"error"},{"inputs":[],"name":"TooManyCombatants","type":"error"},{"inputs":[],"name":"TooManyDefenders","type":"error"},{"inputs":[],"name":"TransferFailed","type":"error"},{"inputs":[],"name":"UUPSUnauthorizedCallContext","type":"error"},{"inputs":[{"internalType":"bytes32","name":"slot","type":"bytes32"}],"name":"UUPSUnsupportedProxiableUUID","type":"error"},{"anonymous":false,"inputs":[{"components":[{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint16","name":"percentageEmissions","type":"uint16"}],"indexed":false,"internalType":"struct Territories.TerritoryInput[]","name":"territories","type":"tuple[]"}],"name":"AddTerritories","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"clanId","type":"uint256"},{"indexed":false,"internalType":"uint64[]","name":"playerIds","type":"uint64[]"},{"indexed":false,"internalType":"address","name":"from","type":"address"},{"indexed":false,"internalType":"uint256","name":"leaderPlayerId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"cooldownTimestamp","type":"uint256"}],"name":"AssignCombatants","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"clanId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"territoryId","type":"uint256"},{"indexed":false,"internalType":"address","name":"from","type":"address"},{"indexed":false,"internalType":"uint256","name":"leaderPlayerId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"requestId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"pendingAttackId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"attackingCooldownTimestamp","type":"uint256"}],"name":"AttackTerritory","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"requestId","type":"uint256"},{"indexed":false,"internalType":"uint64[]","name":"attackingPlayerIds","type":"uint64[]"},{"indexed":false,"internalType":"uint64[]","name":"defendingPlayerIds","type":"uint64[]"},{"indexed":false,"internalType":"uint256[]","name":"attackingRolls","type":"uint256[]"},{"indexed":false,"internalType":"uint256[]","name":"defendingRolls","type":"uint256[]"},{"indexed":false,"internalType":"uint8[]","name":"battleResults","type":"uint8[]"},{"indexed":false,"internalType":"uint8[]","name":"randomSkills","type":"uint8[]"},{"indexed":false,"internalType":"bool","name":"didAttackersWin","type":"bool"},{"indexed":false,"internalType":"uint256","name":"attackingClanId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"defendingClanId","type":"uint256"},{"indexed":false,"internalType":"uint256[]","name":"randomWords","type":"uint256[]"},{"indexed":false,"internalType":"uint256","name":"territoryId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"clanXPGainedWinner","type":"uint256"}],"name":"BattleResult","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"clanId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"itemTokenId","type":"uint256"},{"indexed":false,"internalType":"address","name":"from","type":"address"},{"indexed":false,"internalType":"uint256","name":"leaderPlayerId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"blockAttacksTimestamp","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"blockAttacksCooldownTimestamp","type":"uint256"}],"name":"BlockingAttacks","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"territoryId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"clanId","type":"uint256"},{"indexed":false,"internalType":"address","name":"from","type":"address"},{"indexed":false,"internalType":"uint256","name":"leaderPlayerId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"requestId","type":"uint256"}],"name":"ClaimUnoccupiedTerritory","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Deposit","type":"event"},{"anonymous":false,"inputs":[{"components":[{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint16","name":"percentageEmissions","type":"uint16"}],"indexed":false,"internalType":"struct Territories.TerritoryInput[]","name":"territories","type":"tuple[]"}],"name":"EditTerritories","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"territoryId","type":"uint256"},{"indexed":false,"internalType":"address","name":"from","type":"address"},{"indexed":false,"internalType":"uint256","name":"playerId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"cooldownTimestamp","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Harvest","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint64","name":"version","type":"uint64"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"playerId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"clanId","type":"uint256"}],"name":"RemoveCombatant","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256[]","name":"territoryIds","type":"uint256[]"}],"name":"RemoveTerritories","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"attackCooldown","type":"uint256"}],"name":"SetAttackCooldown","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"enum Skill[]","name":"skills","type":"uint8[]"}],"name":"SetComparableSkills","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"expectedGasLimitFulfill","type":"uint256"}],"name":"SetExpectedGasLimitFulfill","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"maxClanCombatants","type":"uint256"}],"name":"SetMaxClanCombatants","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256[]","name":"territoryIds","type":"uint256[]"},{"indexed":false,"internalType":"uint16[]","name":"minimumMMRs","type":"uint16[]"}],"name":"SetMinimumMMRs","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"implementation","type":"address"}],"name":"Upgraded","type":"event"},{"inputs":[],"name":"HARVESTING_COOLDOWN","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_DAILY_EMISSIONS","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"PERCENTAGE_EMISSION_MUL","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"TERRITORY_ATTACKED_COOLDOWN_PLAYER","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"UPGRADE_INTERFACE_VERSION","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint16","name":"percentageEmissions","type":"uint16"}],"internalType":"struct Territories.TerritoryInput[]","name":"territories","type":"tuple[]"}],"name":"addTerritories","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"addUnclaimedEmissions","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"clanId","type":"uint256"},{"internalType":"uint64[]","name":"playerIds","type":"uint64[]"},{"internalType":"uint256","name":"combatantCooldownTimestamp","type":"uint256"},{"internalType":"uint256","name":"leaderPlayerId","type":"uint256"}],"name":"assignCombatants","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"clanId","type":"uint256"},{"internalType":"uint256","name":"territoryId","type":"uint256"},{"internalType":"uint256","name":"leaderPlayerId","type":"uint256"}],"name":"attackTerritory","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"uint256","name":"clanId","type":"uint256"},{"internalType":"uint16","name":"itemTokenId","type":"uint16"},{"internalType":"uint256","name":"playerId","type":"uint256"}],"name":"blockAttacks","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"clanId","type":"uint256"},{"internalType":"uint256","name":"playerId","type":"uint256"}],"name":"clanMemberLeft","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"clanId","type":"uint256"}],"name":"clearCooldowns","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint16","name":"percentageEmissions","type":"uint16"}],"internalType":"struct Territories.TerritoryInput[]","name":"territories","type":"tuple[]"}],"name":"editTerritories","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"requestId","type":"bytes32"},{"internalType":"uint256[]","name":"randomWords","type":"uint256[]"}],"name":"fulfillRandomWords","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"getAttackCost","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"clanId","type":"uint256"}],"name":"getClanInfo","outputs":[{"components":[{"internalType":"uint16","name":"ownsTerritoryId","type":"uint16"},{"internalType":"uint40","name":"attackingCooldownTimestamp","type":"uint40"},{"internalType":"uint40","name":"assignCombatantsCooldownTimestamp","type":"uint40"},{"internalType":"bool","name":"currentlyAttacking","type":"bool"},{"internalType":"uint40","name":"blockAttacksTimestamp","type":"uint40"},{"internalType":"uint8","name":"blockAttacksCooldownHours","type":"uint8"},{"internalType":"uint64[]","name":"playerIds","type":"uint64[]"}],"internalType":"struct Territories.ClanInfo","name":"clanInfo","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getExpectedGasLimitFulfill","outputs":[{"internalType":"uint88","name":"expectedGasLimitFulfill","type":"uint88"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"pendingAttackId","type":"uint256"}],"name":"getPendingAttack","outputs":[{"components":[{"internalType":"address","name":"from","type":"address"},{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint32","name":"clanId","type":"uint32"},{"internalType":"bool","name":"attackInProgress","type":"bool"},{"internalType":"uint40","name":"leaderPlayerId","type":"uint40"}],"internalType":"struct Territories.PendingAttack","name":"pendingAttack","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"territoryId","type":"uint256"}],"name":"getTerritory","outputs":[{"components":[{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint16","name":"percentageEmissions","type":"uint16"},{"internalType":"uint40","name":"clanIdOccupier","type":"uint40"},{"internalType":"uint88","name":"unclaimedEmissions","type":"uint88"},{"internalType":"uint40","name":"lastClaimTimestamp","type":"uint40"},{"internalType":"uint16","name":"minimumMMR","type":"uint16"}],"internalType":"struct Territories.Territory","name":"territory","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getTerrorities","outputs":[{"components":[{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint16","name":"percentageEmissions","type":"uint16"},{"internalType":"uint40","name":"clanIdOccupier","type":"uint40"},{"internalType":"uint88","name":"unclaimedEmissions","type":"uint88"},{"internalType":"uint40","name":"lastClaimTimestamp","type":"uint40"},{"internalType":"uint16","name":"minimumMMR","type":"uint16"}],"internalType":"struct Territories.Territory[]","name":"","type":"tuple[]"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getTotalEmissionPercentage","outputs":[{"internalType":"uint16","name":"totalEmissionPercentage","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"territoryId","type":"uint256"},{"internalType":"uint256","name":"playerId","type":"uint256"}],"name":"harvest","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint16","name":"territoryId","type":"uint16"},{"internalType":"uint16","name":"percentageEmissions","type":"uint16"}],"internalType":"struct Territories.TerritoryInput[]","name":"territories","type":"tuple[]"},{"internalType":"address","name":"players","type":"address"},{"internalType":"contract IClans","name":"clans","type":"address"},{"internalType":"contract IBrushToken","name":"brush","type":"address"},{"internalType":"contract LockedBankVaults","name":"lockedBankVaults","type":"address"},{"internalType":"contract ItemNFT","name":"itemNFT","type":"address"},{"internalType":"address","name":"oracle","type":"address"},{"internalType":"contract ISamWitchVRF","name":"samWitchVRF","type":"address"},{"internalType":"contract VRFRequestInfo","name":"vrfRequestInfo","type":"address"},{"internalType":"enum Skill[]","name":"comparableSkills","type":"uint8[]"},{"internalType":"uint8","name":"maxClanCombatants","type":"uint8"},{"internalType":"uint24","name":"attackingCooldown","type":"uint24"},{"internalType":"contract AdminAccess","name":"adminAccess","type":"address"},{"internalType":"contract IActivityPoints","name":"activityPoints","type":"address"},{"internalType":"bool","name":"isBeta","type":"bool"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"clanId","type":"uint256"},{"internalType":"uint256","name":"playerId","type":"uint256"}],"name":"isCombatant","outputs":[{"internalType":"bool","name":"combatant","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"proxiableUUID","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"territoryIds","type":"uint256[]"}],"name":"removeTerritories","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"activityPoints","type":"address"}],"name":"setActivityPoints","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"attackCooldown","type":"uint24"}],"name":"setAttackCooldown","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"requestId","type":"uint256"}],"name":"setAttackInProgress","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"combatantsHelper","type":"address"}],"name":"setCombatantsHelper","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"enum Skill[]","name":"skills","type":"uint8[]"}],"name":"setComparableSkills","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint24","name":"expectedGasLimitFulfill","type":"uint24"}],"name":"setExpectedGasLimitFulfill","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint8","name":"maxClanCombatants","type":"uint8"}],"name":"setMaxClanCombatants","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"territoryIds","type":"uint256[]"},{"internalType":"uint16[]","name":"minimumMMRs","type":"uint16[]"}],"name":"setMinimumMMRs","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newImplementation","type":"address"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"upgradeToAndCall","outputs":[],"stateMutability":"payable","type":"function"}]

60a080604052346100c257306080525f516020615a745f395f51905f525460ff8160401c166100b3576002600160401b03196001600160401b03821601610060575b6040516159ad90816100c7823960805181818161297f0152612ac90152f35b6001600160401b0319166001600160401b039081175f516020615a745f395f51905f525581527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d290602090a15f80610041565b63f92ee8a960e01b5f5260045ffd5b5f80fdfe610200806040526004361015610013575f80fd5b5f60a0525f3560e01c9081630a30542d14613a13575080630d16f20a146131de5780630d65c036146131ba5780631cedf5231461314b5780631f4eb0d61461305d578063246fb519146130405780632fc150ea14612fd157806335d3659a14612fb65780633faf0ff514612e5c5780634e70a3b614612cfb5780634f1ef28614612a4d57806350309b05146129f757806352d1902d14612965578063593500e41461294957806361c9fd2a1461261e578063649357c3146125af5780636b3de4391461200357806370f246d414611e3e578063715018a614611d9a578063766d8e0114611b7f57806388ce1d781461192c5780638da5cb5b146118e55780638dcec2e6146118a2578063a526596a14611732578063a61cce251461170f578063acfda69e146116cc578063ad3cb1cc14611652578063ba660b8a14611575578063bcc16cad14610ac0578063be52e34f14610a45578063db3e281c1461096d578063dbc0687f1461084d578063e4a4b7b11461051f578063e987f790146103d4578063ef242ace14610243578063f2fde38b14610214578063f76e782a146101f05763fc587ba8146101c3575f80fd5b346101ea5760a0513660031901126101ea57602062ffffff600e5460a01c16604051908152f35b60a05180fd5b346101ea5760a0513660031901126101ea57602061020c61509c565b604051908152f35b346101ea5760203660031901126101ea5761023d610230613bd2565b61023861518b565b614fe1565b60a05180f35b346101ea5761025136613c7a565b6001600160a01b036004541633036103a8578160a0515260086020526001604060a05120019182546102835760a05180f35b61028d8284615222565b6001810161029c575b5061023d565b83545f19810190811161030d5781101561032557600181019081811161030d5767ffffffffffffffff6102d160019387614fc0565b90549060031b1c166103056102e68388614fc0565b819391549067ffffffffffffffff809160031b9316831b921b19161790565b90550161029c565b634e487b7160e01b60a051526011600452602460a051fd5b50908254918215610390577f1edc2b7b43df588e9e4c216a340d4aad41c9a47bd341383338a2175056beab95936040935f1901906103638282614fc0565b67ffffffffffffffff82549160a0515060031b1b191690555582519182526020820152a180808080610296565b634e487b7160e01b60a051526031600452602460a051fd5b7f74099c740000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea5760203660031901126101ea5760043567ffffffffffffffff81116101ea57610405903690600401613b70565b9061040e61518b565b61ffff6009541660a0515060a0515b83811061047857509161ffff7ff7fa072be30d392a00cbc048901c45f3ba250bb961dea1a0cfc06e9b0a350e3a931661ffff19600954161760095561046f604051928392602084526020840191613e9e565b0390a160a05180f35b90610484828585613e6b565b3560a05152600260205261ffff604060a051205416156104f3576104cd6001916104af848787613e6b565b3560a05152600260205261ffff604060a051205460101c1690613eeb565b916104d9818686613e6b565b3560a05152600260205260a051604060a05120550161041d565b7f04b8bd1f0000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea5761052d36613c7a565b60035460405163e743862960e01b81523360048201526024810183905290602090829060449082906001600160a01b03165afa9081156107415760a05191610813575b5015610800578160a05152600260205264ffffffffff604060a051205460201c1660206001600160a01b036004541691604460405180948193632bf0856760e11b835260048301528660248301525afa9081156107415760a051916107d1575b5060078110156107b957156107a6578160a051526002602052604060a051209182549264ffffffffff6affffffffffffffffffffff8560481c169460a01c16617080810180911161030d57421061077a5780547fffffffffffffff00000000000000000000000000000000ffffffffffffffffff1664ffffffffff60a01b4260a01b16178155831561074e5764ffffffffff6001600160a01b0360065416915460201c1690803b156101ea57604051917f9a30f86e00000000000000000000000000000000000000000000000000000000835260048301523360248301528360448301528460648301528160848160a0519360a051905af1801561074157610728575b5061708042019283421161030d577f14a992338172c40df4462447b550ac77ef75340cb0caa286624f9ac44a7cdc239360a093604051938452336020850152604084015260608301526080820152a160a05180f35b60a05161073491613c3c565b60a0516101ea57836106d3565b6040513d60a051823e3d90fd5b7f67a3a3500000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b7f176cc82c0000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b6325d7e13960e11b60a05152600460a051fd5b634e487b7160e01b60a051526021600452602460a051fd5b6107f3915060203d6020116107f9575b6107eb8183613c3c565b810190613db9565b836105d0565b503d6107e1565b630a71f87f60e31b60a05152600460a051fd5b90506020813d602011610845575b8161082e60209383613c3c565b810103126101ea5761083f90613dac565b83610570565b3d9150610821565b346101ea5760203660031901126101ea5760055460405190630935e01b60e21b82523360048301526020826024816001600160a01b0385165afa9182156107415760a05192610931575b5081610923575b50156108f75760043560a051526001602052604060a051205460a0515260a051602052604060a051207a01000000000000000000000000000000000000000000000000000060ff60d01b1982541617905560a05160a051f35b7facc0304c0000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b60ff915060a01c168161089e565b9091506020813d602011610965575b8161094d60209383613c3c565b810103126101ea5761095e90613dac565b9082610897565b3d9150610940565b346101ea5760203660031901126101ea5760405161098a81613c04565b60a051815260a051602082015260a051604082015260a0516060820152608060a05191015260043560a0515260a05160205260a0604081512064ffffffffff604051916109d683613c04565b546001600160a01b0381169283815263ffffffff6020820161ffff84881c16815261ffff6040840191838660b01c1683526080606086019560ff8860d01c1615158752019560d81c86526040519788525116602087015251166040850152511515606084015251166080820152f35b346101ea5760403660031901126101ea5760243567ffffffffffffffff81116101ea57610a76903690600401613b70565b6001600160a01b03600e54163303610a945761023d91600435614121565b7f580ae4250000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea576101e03660031901126101ea5760043567ffffffffffffffff81116101ea57610af2903690600401613ba1565b6024356001600160a01b03811681036101ea576044356001600160a01b03811681036101ea576001600160a01b0360643516606435036101ea57608435916001600160a01b03831683036101ea5760a4356001600160a01b03811681036101ea5760c435936001600160a01b03851685036101ea5760e435916001600160a01b03831683036101ea5761010435926001600160a01b03841684036101ea576101243567ffffffffffffffff81116101ea57610bb1903690600401613b70565b6101443598909791969060ff8a168a036101ea57610164359662ffffff881688036101ea5761018435946001600160a01b03861686036101ea576101a435926001600160a01b03841684036101ea576101c43515156101c435036101ea577ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005460805267ffffffffffffffff608051161580611565575b600167ffffffffffffffff6080511614908161155b575b159081611552575b506115265760805167ffffffffffffffff1981166001177ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005560401c60ff16156114e5575b610cb46153d9565b610cbc6153d9565b610cc533614fe1565b610ccd6153d9565b600354956001600160a01b03166004546001600160a01b0319161760045560095460643560101b75ffffffffffffffffffffffffffffffffffffffff000016907fffffffffffffffffffff0000000000000000000000000000000000000000ffff161797886009556001600160a01b038a166006546001600160a01b031916176006556001600160a01b03166007546001600160a01b031916176007556001600160a01b0316600c546001600160a01b03191617600c556001600160a01b0316600e546001600160a01b03191617600e556001600160a01b0316600d546001600160a01b03191617600d556001600160a01b0316600f546001600160a01b03191617600f556001600160a01b0316907fffffffffffffffffffff000000000000000000000000000000000000000000001617740100000000000000000000000000000000000000001778ffffffffffffffffffffffffffffffffffffffffffffffffff16790100000000000000000000000000000000000000000000000000176003556005546101c435151560a01b60ff60a01b16916001600160a01b0316907fffffffffffffffffffffff000000000000000000000000000000000000000000161717600555604051917f095ea7b30000000000000000000000000000000000000000000000000000000083526001600160a01b031660048301525f1960248301528160a0519160101c6001600160a01b0316815a93604492602095f1801561074157611487575b507fda633cde6ca79d54327cac43e6005ce4972dd2f17ccde49c42e7eee1284135dd906020906101c4351561147e5761012c5b62ffffff60a01b1962ffffff60a01b600d549260a01b16911617600d55610f4e61518b565b60035462ffffff60b01b1962ffffff60b01b8360b01b1691161760035562ffffff60405191168152a1610f7f61518b565b762dc6c0000000000000000000000000000000000000000062ffffff60a01b19600e541617600e557f49b98b5066c079ce5d03fa1b58f85e07295e2baf54b78dc4da95bb1d4aa60b4c6020604051622dc6c08152a1610fdc61518b565b60a0515b82811061137c5750604051918060208401602085525260408301919060a051905b80821061135257505050917fbbc349ca0d0701b306c6c0053cbdf135aa36755f4dfb3b8f7c3ae39b5df7684d826020937f4f54a0bb0df8a35f3887bec08b0faa868f57b6052aaa6842765663cb6a6d5d69950390a161105e61518b565b600b5460ff60a01b1960ff60a01b8360a01b16911617600b5560ff60405191168152a161108961518b565b61ffff600954169161ffff60035460a01c1660a0515060a0515b8381106111c45750826110b591613e00565b61ffff60a01b1961ffff60a01b6003549260a01b169116176003556103e883116111b15761ffff7f471be53ca5fc7faa446595196a5f57088788425e071be9f0ff0c7cd9f3cabe2e931661ffff19600954161760095561111a60405192839283613ef8565b0390a160ff60805160401c16156111315760a05180f35b68ff0000000000000000197ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a0054167ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00557fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2602060405160018152a161023d565b630b1a83c360e31b60a05152600460a051fd5b936111d0858585613edb565b6111e36111de878787613edb565b6151ea565b6111ed8387613e00565b61ffff6111f983613e8f565b16036104f35761120881613e8f565b602082019161121683613e8f565b6040519261122384613c20565b61ffff168352602083019061ffff1681526040830160a0518152606084019060a0518252608085019260a051845260a086019460a051865261126490613e8f565b60a0805161ffff92831690526002602052516040902096518754925163ffffffff1990931691161760109190911b63ffff00001617855551845468ffffffffff00000000191660209190911b68ffffffffff000000001617845551835473ffffffffffffffffffffff000000000000000000191660489190911b73ffffffffffffffffffffff0000000000000000001617835551825464ffffffffff60a01b191660a09190911b64ffffffffff60a01b1617825551815461ffff60c81b191660c89190911b61ffff60c81b1617905561133c90613e8f565b61ffff1661134991613e00565b936001016110a3565b90919283359060288210156101ea576020816113718293600195613fe1565b019401920190611001565b611387818484613e6b565b3560288110156101ea5715158061145f575b6113a4828585613e6b565b359060288210156101ea571561142a57506113c0818484613e6b565b359060288210156101ea57600a549168010000000000000000831015611412576113f1836001809501600a55613fee565b60a0929192515060ff8084549260031b9316831b921b191617905501610fe0565b634e487b7160e01b60a051526041600452602460a051fd5b611458907f7a566b2f0000000000000000000000000000000000000000000000000000000060a05152613fd3565b602460a051fd5b5061146b818484613e6b565b3560288110156101ea5760011415611399565b6203f480610f29565b6020813d6020116114dd575b816114a060209383613c3c565b810103126101ea577fda633cde6ca79d54327cac43e6005ce4972dd2f17ccde49c42e7eee1284135dd916114d5602092613dac565b509150610ef6565b3d9150611493565b60805168ffffffffffffffffff191668010000000000000001177ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a0055610cac565b7ff92ee8a90000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b9050155f610c67565b303b159150610c5f565b5060ff60805160401c1615610c48565b346101ea5760203660031901126101ea5760055460405190630935e01b60e21b82523360048301526020826024816001600160a01b0385165afa9182156107415760a05192611616575b5081611608575b50156108f75760a0805160043590526008602052516040812080547fffffffffffffffffffffffffff000000000000ff00000000000000000000ffff16905580f35b60ff915060a01c16816115c6565b9091506020813d60201161164a575b8161163260209383613c3c565b810103126101ea5761164390613dac565b90826115bf565b3d9150611625565b346101ea5760a0513660031901126101ea5760408051906116738183613c3c565b6005825260208201917f352e302e3000000000000000000000000000000000000000000000000000000083528151928391602083525180918160208501528484015e60a051828201840152601f01601f19168101030190f35b346101ea5760203660031901126101ea576001600160a01b036116ed613bd2565b6116f561518b565b166001600160a01b0319600f541617600f5560a05160a051f35b346101ea5760a0513660031901126101ea57602061ffff60095416604051908152f35b346101ea5760203660031901126101ea5760043567ffffffffffffffff81116101ea57611763903690600401613b70565b61176b61518b565b60a0515b8181106117ed5750604051908060208301602084525260408201929060a051905b8082106117c3577fbbc349ca0d0701b306c6c0053cbdf135aa36755f4dfb3b8f7c3ae39b5df7684d84860385a160a05180f35b90919384359060288210156101ea576020816117e28293600195613fe1565b019501920190611790565b6117f8818385613e6b565b3560288110156101ea57151580611883575b611815828486613e6b565b359060288210156101ea571561142a5750611831818385613e6b565b359060288210156101ea57600a54916801000000000000000083101561141257611862836001809501600a55613fee565b60a0929192515060ff8084549260031b9316831b921b19161790550161176f565b5061188f818385613e6b565b3560288110156101ea576001141561180a565b346101ea5760203660031901126101ea576001600160a01b036118c3613bd2565b6118cb61518b565b166001600160a01b0319600b541617600b5560a05160a051f35b346101ea5760a0513660031901126101ea5760206001600160a01b037f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c1993005416604051908152f35b346101ea5760203660031901126101ea5760043567ffffffffffffffff81116101ea5761195d903690600401613ba1565b61196561518b565b61ffff600954169161ffff60035460a01c1660a0515060a0515b8381106119f657508261199191613e00565b61ffff60a01b1961ffff60a01b6003549260a01b169116176003556103e883116111b15761ffff7f471be53ca5fc7faa446595196a5f57088788425e071be9f0ff0c7cd9f3cabe2e931661ffff19600954161760095561046f60405192839283613ef8565b93611a02858585613edb565b611a106111de878787613edb565b611a1a8387613e00565b61ffff611a2683613e8f565b16036104f357611a3581613e8f565b6020820191611a4383613e8f565b60405192611a5084613c20565b61ffff168352602083019061ffff1681526040830160a0518152606084019060a0518252608085019260a051845260a086019460a0518652611a9190613e8f565b60a0805161ffff92831690526002602052516040902096518754925163ffffffff1990931691161760109190911b63ffff00001617855551845468ffffffffff00000000191660209190911b68ffffffffff000000001617845551835473ffffffffffffffffffffff000000000000000000191660489190911b73ffffffffffffffffffffff0000000000000000001617835551825464ffffffffff60a01b191660a09190911b64ffffffffff60a01b1617825551815461ffff60c81b191660c89190911b61ffff60c81b16179055611b6990613e8f565b61ffff16611b7691613e00565b9360010161197f565b346101ea5760203660031901126101ea5760043561ffff600954168110611d6e57801560015b61ffff60035460a01c16811015611c845760a08051829052600260205251604090205460101c61ffff1683810291908483041483171561030d5760095461ffff16918215611c6c57600192611c6691048260a051526002602052611c2d6affffffffffffffffffffff604060a0512092166affffffffffffffffffffff835460481c16613fab565b73ffffffffffffffffffffff0000000000000000001973ffffffffffffffffffffff00000000000000000083549260481b169116179055565b01611ba5565b634e487b7160e01b60a051526012600452602460a051fd5b82606460206001600160a01b0360095460101c16604051928380927f23b872dd00000000000000000000000000000000000000000000000000000000825233600483015230602483015286604483015260a051905af19081156107415760a05191611d34575b5015611d215760207f4d6ce1e535dbade1c23defba91e23b8f791ce5edc0cc320257a2b364e4e3842691604051908152a160a05180f35b6312171d8360e31b60a05152600460a051fd5b90506020813d602011611d66575b81611d4f60209383613c3c565b810103126101ea57611d6090613dac565b82611cea565b3d9150611d42565b7f1fbaba350000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea5760a0513660031901126101ea57611db461518b565b7f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300546001600160a01b031981167f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300556001600160a01b0360a05191167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060a05160a051a360a05180f35b346101ea5760a0513660031901126101ea575f1961ffff60035460a01c160161ffff811161030d5761ffff16611e7381613f7f565b90611e816040519283613c3c565b808252611e90601f1991613f7f565b0160a0515b818110611fec5760a05183905b8151811015611f4557600181019081811161030d5760019160a051526002602052604060a0512061ffff60405191611ed983613c20565b548181168352818160101c16602084015264ffffffffff8160201c1660408401526affffffffffffffffffffff8160481c16606084015264ffffffffff8160a01c16608084015260c81c1660a0820152611f338285613f97565b52611f3e8184613f97565b5001611ea2565b5060405180916020820160208352815180915260206040840192019060a0515b818110611f73575050500390f35b91935091602060c082611fde600194885161ffff60a0809282815116855282602082015116602086015264ffffffffff60408201511660408601526affffffffffffffffffffff606082015116606086015264ffffffffff6080820151166080860152015116910152565b019401910191849392611f65565b602090611ff7613e3b565b82828601015201611e95565b346122dd5760603660031901126122dd5760043560243561ffff81168091036122dd5760035460405163e743862960e01b815233600482015260448035602483018190529492602091839182906001600160a01b03165afa9081156122d2575f91612575575b501561256657604460206001600160a01b036004541660405192838092632bf0856760e11b82528660048301528860248301525afa9081156122d2575f91612547575b50600781101561235c5715612538576024916102206001600160a01b0360075416604051948580927f810de9de0000000000000000000000000000000000000000000000000000000082528560048301525afa9283156122d2575f93612370575b508251601781101561235c5760161480612345575b1561231d57815f52600860205260405f20805460ff8160901c16610e10810290808204610e1014901517156123095764ffffffffff6121649260681c16613e00565b42106122e15760c061217f62ffffff60e08701511642613e00565b82549190950180517fffffffffffffffffffffffffff000000000000ffffffffffffffffffffffffff909216606887901b71ffffffffff00000000000000000000000000161760909290921b72ff00000000000000000000000000000000000016919091179091556007546001600160a01b031690813b156122dd575f80926064604051809581937ff5298aca000000000000000000000000000000000000000000000000000000008352336004840152886024840152600160448401525af19182156122d25761ffff926122be575b50511692610e10840293808504610e10149015171561030d577f17ad3a74f4ecd94ee25ff386b332b9d4a45bf780b3d2e525b0354cb9d73c9dee9461229660c09583613e00565b9260405194855260208501523360408501526060840152608083015260a0820152a160a05180f35b5f6122c891613c3c565b5f60a0528661224f565b6040513d5f823e3d90fd5b5f80fd5b7f12a13be7000000000000000000000000000000000000000000000000000000005f5260045ffd5b634e487b7160e01b5f52601160045260245ffd5b7fc57521de000000000000000000000000000000000000000000000000000000005f5260045ffd5b5060a0830151600b81101561235c57600714612122565b634e487b7160e01b5f52602160045260245ffd5b909250610220813d8211612530575b8161238d6102209383613c3c565b810103126122dd5760405190610220820182811067ffffffffffffffff82111761251c57604052805160178110156122dd57825260208101517fff00000000000000000000000000000000000000000000000000000000000000811681036122dd57602083015261240060408201613f62565b604083015261241160608201613dac565b606083015261242260808201613f62565b608083015260a0810151600b8110156122dd5760a083015261244660c08201613f62565b60c083015260e081015162ffffff811681036122dd5760e083015261246e6101008201613f71565b6101008301526124816101208201613f71565b6101208301526124946101408201613f71565b6101408301526124a76101608201613f71565b6101608301526124ba6101808201613f71565b6101808301526124cd6101a08201613f71565b6101a08301526124e06101c08201613f71565b6101c08301526101e08101519060288210156122dd57610200916101e0840152015163ffffffff811681036122dd57610200820152918461210d565b634e487b7160e01b5f52604160045260245ffd5b3d915061237f565b6325d7e13960e11b5f5260045ffd5b612560915060203d6020116107f9576107eb8183613c3c565b846120ac565b630a71f87f60e31b5f5260045ffd5b90506020813d6020116125a7575b8161259060209383613c3c565b810103126122dd576125a190613dac565b84612069565b3d9150612583565b346122dd5760203660031901126122dd5760043560ff8116908181036122dd577f4f54a0bb0df8a35f3887bec08b0faa868f57b6052aaa6842765663cb6a6d5d69916020916125fc61518b565b60ff60a01b1960ff60a01b600b549260a01b16911617600b55604051908152a1005b346122dd5760803660031901126122dd5760043560243567ffffffffffffffff81116122dd57612652903690600401613b70565b600b929192546001600160a01b03811633036129215760a01c60ff1681116128f957815f52600860205264ffffffffff60405f205460381c1642106128d157815f526008602052600160405f200167ffffffffffffffff821161251c5768010000000000000000821161251c578054828255808310612877575b5083905f5260205f208260021c905f5b828110612824575060031984168403806127cd575b5050505061270962ffffff600d5460a01c1642613e00565b825f52600860205260405f20906bffffffffff000000000000008083549260381b1616906bffffffffff000000000000001916179055806040519260a0840190845260a060208501525260c0820192905f905b8082106127a157336040850152606435606085015260443560808501527f1a275904484710dcd12bdb55c20cfdc8c34f9cf7bdd594c5ff66317be2572b7884860385a1005b90919384359067ffffffffffffffff82168092036122dd5760208160019382935201950192019061275c565b925f935f5b8181106127e7575050500155838080806126f1565b909194602061281a6001926127fb89613f4d565b908560031b67ffffffffffffffff809160031b9316831b921b19161790565b96019291016127d2565b5f5f5b6004811061283c5750828201556001016126dc565b9490602061286e60019261284f85613f4d565b908960031b67ffffffffffffffff809160031b9316831b921b19161790565b92019501612827565b815f5260205f20600380850160021c8201920160021c019060188460031b16806128b6575b505b8181106128ab57506126cc565b5f815560010161289e565b5f198201908154905f199060200360031b1c1690558661289c565b7f848514ed000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f1275f701000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fa07272dc000000000000000000000000000000000000000000000000000000005f5260045ffd5b346122dd575f3660031901126122dd5760206040516170808152f35b346122dd575f3660031901126122dd576001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001630036129cf5760206040517f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc8152f35b7fe07c8dba000000000000000000000000000000000000000000000000000000005f5260045ffd5b346122dd576020612a0736613c7a565b5f91805f5260088452600160405f200154612a29575b50506040519015158152f35b9091505f5260088252612a445f1991600160405f2001615222565b14158280612a1d565b60403660031901126122dd57612a61613bd2565b6024359067ffffffffffffffff82116122dd57366023830112156122dd57816004013590612a8e82613c5e565b91612a9c6040519384613c3c565b808352602083019336602483830101116122dd57815f926024602093018737840101526001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016803014908115612cc6575b506129cf57612b0161518b565b6001600160a01b038116926040517f52d1902d000000000000000000000000000000000000000000000000000000008152602081600481885afa5f9181612c92575b50612b5b5784634c9c8ce360e01b5f5260045260245ffd5b807f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc869203612c675750823b15612c5557806001600160a01b03197f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc5416177f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc557fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b5f80a2825115612c23575f8091612c21945190845af4612c1b613dd1565b916158eb565b005b50505034612c2d57005b7fb398979f000000000000000000000000000000000000000000000000000000005f5260045ffd5b634c9c8ce360e01b5f5260045260245ffd5b7faa1d49a4000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b9091506020813d602011612cbe575b81612cae60209383613c3c565b810103126122dd57519086612b43565b3d9150612ca1565b90506001600160a01b037f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc5416141584612af4565b346122dd5760203660031901126122dd5760043567ffffffffffffffff81116122dd57612d2c903690600401613ba1565b612d3461518b565b61ffff60095416915f5b828110612da357506103e88311612d945760ff7f73558c078e436ec3ee705ef31c70f6e7770a885f681d3b0445ded3093a5eb389931661ffff196009541617600955612d8f60405192839283613ef8565b0390a1005b630b1a83c360e31b5f5260045ffd5b92612e0b612deb600192612dbb6111de888888613edb565b61ffff612dd1612dcc898989613edb565b613e8f565b165f52600260205261ffff60405f205460101c1690613eeb565b61ffff612e046020612dfe898989613edb565b01613e8f565b1690613e00565b93612e56612e1f6020612dfe848888613edb565b61ffff612e30612dcc858989613edb565b165f52600260205260405f209063ffff000082549160101b169063ffff00001916179055565b01612d3e565b346122dd5760403660031901126122dd5760043567ffffffffffffffff81116122dd57612e8d903690600401613b70565b60243567ffffffffffffffff81116122dd57612ead903690600401613b70565b9092612eb761518b565b818303612f8e575f5b838110612f415750612ee060209160405194604086526040860191613e9e565b838103828501528281520192905f5b818110612f1e577fa25843fbd9296105e9c4872a482bd5bd12c4c22d18faa29a1b3cb04dcf5cc0b784860385a1005b90919360208060019261ffff612f3389613c90565b168152019501929101612eef565b80612f88612f55612dcc600194878a613e6b565b612f60838887613e6b565b355f52600260205260405f209061ffff60c81b1961ffff60c81b83549260c81b169116179055565b01612ec0565b7fff633a38000000000000000000000000000000000000000000000000000000005f5260045ffd5b346122dd575f3660031901126122dd576020604051600a8152f35b346122dd5760203660031901126122dd577f49b98b5066c079ce5d03fa1b58f85e07295e2baf54b78dc4da95bb1d4aa60b4c602061300d613b5e565b61301561518b565b600e5462ffffff60a01b1962ffffff60a01b8360a01b16911617600e5562ffffff60405191168152a1005b346122dd575f3660031901126122dd576020604051620151808152f35b346122dd5760203660031901126122dd57613076613e3b565b506004355f52600260205260c060405f2061ffff6040519161309783613c20565b548181168352818160101c16602084015264ffffffffff8160201c1660408401526affffffffffffffffffffff8160481c16606084015264ffffffffff8160a01c16608084015260c81c1660a0820152613149604051809261ffff60a0809282815116855282602082015116602086015264ffffffffff60408201511660408601526affffffffffffffffffffff606082015116606086015264ffffffffff6080820151166080860152015116910152565bf35b346122dd5760203660031901126122dd577fda633cde6ca79d54327cac43e6005ce4972dd2f17ccde49c42e7eee1284135dd6020613187613b5e565b61318f61518b565b60035462ffffff60b01b1962ffffff60b01b8360b01b1691161760035562ffffff60405191168152a1005b346122dd575f3660031901126122dd57602060405169021e19e0c9bab24000008152f35b60603660031901126122dd57600435602435604435906001600160a01b03600354166020604051809263e743862960e01b82528180613237883360048401602090939291936001600160a01b0360408201951681520152565b03915afa9081156122d2575f916139d9575b5015612566576001600160a01b0360045416604051632bf0856760e11b8152846004820152836024820152602081604481855afa9081156122d2575f916139ba575b50600781101561235c5760031161399257815f52600260205264ffffffffff60405f205460201c169081851461396a57825f52600260205260405f20548361ffff82160361394257602061ffff60249260c81c1692604051928380927fb4e4568c0000000000000000000000000000000000000000000000000000000082528a60048301525afa80156122d2575f90613907575b61ffff91501681116138dc5750835f52600860205260405f206001810154156138b4575460ff8160601c1661388c5764ffffffffff429160101c1611613864575f5260086020524264ffffffffff60405f205460681c161161383c5761338361509c565b3410613814575f808080346001600160a01b03600c54165af16133a4613dd1565b501561380557600354908160c81c9166ffffffffffffff83146123095762ffffff61341d9178ffffffffffffffffffffffffffffffffffffffffffffffffff7fffffffffffffff000000000000000000000000000000000000000000000000006001870160c81b169116178060035560b01c1642613e00565b5f85815260086020526040902080546cff0000000000ffffffffff00001916601083901b66ffffffffff000016176c010000000000000000000000001790559163ffffffff85116137d45760405161347481613c04565b33815261ffff8316602080830191825263ffffffff8816604080850191825260016060860190815264ffffffffff8a16608087019081525f8881528086528381209751965194519251915160a095861b61ffff60a01b166001600160a01b039889161760b09490941b79ffffffff00000000000000000000000000000000000000000000169390931791151560d01b7aff0000000000000000000000000000000000000000000000000000169190911760d89290921b7fffffffffff0000000000000000000000000000000000000000000000000000001691909117909555600e5490517f1b739ef1000000000000000000000000000000000000000000000000000000008152600760048201529181901c62ffffff1660248301529093919284926044928492165af19081156122d2575f9161377c575b507f1a21db71798c9ad0e440893262de304983ce8427c19dfd3ae9a365d06a2db16f9360e093928264ffffffffff935f5260016020528160405f2055604051948986526020860152336040860152876060860152608085015260a08401521660c0820152a16001600160a01b03600f54169160206001600160a01b036004541691602460405180948193630ef7959160e21b835260048301525afa9081156122d2575f9161374d575b5060206001600160a01b03600354169260246040518095819363231b667d60e21b835260048301525afa9182156122d2575f92613701575b5060846001600160a01b03915f60209495604051968795869463ec01f01960e01b86526015600487015216602485015215156044840152600160648401525af180156122d2576136d957005b612c219060203d6020116136fa575b6136f28183613c3c565b810190613e2c565b503d6136e8565b91506020823d602011613745575b8161371c60209383613c3c565b810103126122dd5760846001600160a01b03915f61373b602095613dac565b945050915061368d565b3d915061370f565b61376f915060203d602011613775575b6137678183613c3c565b810190613e0d565b83613655565b503d61375d565b90506020929192813d6020116137cc575b8161379a60209383613c3c565b810103126122dd57519091907f1a21db71798c9ad0e440893262de304983ce8427c19dfd3ae9a365d06a2db16f6135ac565b3d915061378d565b847f6dfcc650000000000000000000000000000000000000000000000000000000005f52602060045260245260445ffd5b6312171d8360e31b5f5260045ffd5b7f77e47bb9000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f0cdab084000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fdbd8f29e000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f2c3a0bbf000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f4d55013d000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f1aa03325000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b506020813d60201161393a575b8161392160209383613c3c565b810103126122dd5761393561ffff91613f62565b61331f565b3d9150613914565b7fad7147b6000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fdf04091b000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fd52ab5d1000000000000000000000000000000000000000000000000000000005f5260045ffd5b6139d3915060203d6020116107f9576107eb8183613c3c565b8561328b565b90506020813d602011613a0b575b816139f460209383613c3c565b810103126122dd57613a0590613dac565b84613249565b3d91506139e7565b346122dd5760203660031901126122dd5760c081613a32606093613be8565b5f81525f60208201525f60408201525f838201525f60808201525f60a082015201526004355f52600860205264ffffffffff60405f20604051613a7481613be8565b81549161ffff8316825260ff6020830193858160101c168552856040850193818360381c16855260608601848460601c161515815282613ace600160808a0194838860681c1686528860a08c019860901c16885201613c9f565b9660c089019788526040519a8b9a60208c5261ffff6101008d019b511660208d0152511660408b0152511660608901525115156080880152511660a0860152511660c0840152519060e0808401528151809152602061012084019201905f5b818110613b3b575050500390f35b825167ffffffffffffffff16845285945060209384019390920191600101613b2d565b6004359062ffffff821682036122dd57565b9181601f840112156122dd5782359167ffffffffffffffff83116122dd576020808501948460051b0101116122dd57565b9181601f840112156122dd5782359167ffffffffffffffff83116122dd576020808501948460061b0101116122dd57565b600435906001600160a01b03821682036122dd57565b60e0810190811067ffffffffffffffff82111761251c57604052565b60a0810190811067ffffffffffffffff82111761251c57604052565b60c0810190811067ffffffffffffffff82111761251c57604052565b90601f8019910116810190811067ffffffffffffffff82111761251c57604052565b67ffffffffffffffff811161251c57601f01601f191660200190565b60409060031901126122dd576004359060243590565b359061ffff821682036122dd57565b90604051918281549182825260208201905f5260205f20925f905b806003830110613d5757613cf0945491818110613d3c575b818110613d1e575b818110613d00575b10613cf2575b500383613c3c565b565b60c01c81526020015f613ce8565b92602060019167ffffffffffffffff8560801c168152019301613ce2565b92602060019167ffffffffffffffff8560401c168152019301613cda565b92602060019167ffffffffffffffff85168152019301613cd2565b9160049193506080600191865467ffffffffffffffff8116825267ffffffffffffffff8160401c16602083015267ffffffffffffffff81841c16604083015260c01c6060820152019401920185929391613cba565b519081151582036122dd57565b908160209103126122dd575160078110156122dd5790565b3d15613dfb573d90613de282613c5e565b91613df06040519384613c3c565b82523d5f602084013e565b606090565b9190820180921161230957565b908160209103126122dd57516001600160a01b03811681036122dd5790565b908160209103126122dd575190565b60405190613e4882613c20565b5f60a0838281528260208201528260408201528260608201528260808201520152565b9190811015613e7b5760051b0190565b634e487b7160e01b5f52603260045260245ffd5b3561ffff811681036122dd5790565b90918281527f07ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff83116122dd5760209260051b809284830137010190565b9190811015613e7b5760061b0190565b9190820391821161230957565b60208082528101839052604001915f5b818110613f155750505090565b90919260408060019261ffff613f2a88613c90565b16815261ffff613f3c60208901613c90565b166020820152019401929101613f08565b3567ffffffffffffffff811681036122dd5790565b519061ffff821682036122dd57565b51908160010b82036122dd57565b67ffffffffffffffff811161251c5760051b60200190565b8051821015613e7b5760209160051b010190565b906affffffffffffffffffffff809116911601906affffffffffffffffffffff821161230957565b602881101561235c57600452565b90602882101561235c5752565b90600a54821015613e7b57600a5f52600582901c7fc65a7bb8d6351c1cf70c95a316cc6a92839c986682d98bc35f958f4883f9d2a80191601f1690565b9061403582613f7f565b6140426040519182613c3c565b8281528092614053601f1991613f7f565b0190602036910137565b8115614067570690565b634e487b7160e01b5f52601260045260245ffd5b90602080835192838152019201905f5b8181106140985750505090565b825167ffffffffffffffff1684526020938401939092019160010161408b565b90602080835192838152019201905f5b8181106140d55750505090565b82518452602093840193909201916001016140c8565b90602080835192838152019201905f5b8181106141085750505090565b825160ff168452602093840193909201916001016140fb565b60078303612f8e575f6101a052805f52600160205260405f20545f525f60205260405f2080546101605260ff6101605160d01c1615614f985761ffff6101605160a01c165f52600260205264ffffffffff60405f205460201c16610120526001600160a01b03600d5416803b156122dd575f80916004604051809481937fb3a364580000000000000000000000000000000000000000000000000000000083525af180156122d257614f83575b5063ffffffff6101605160b01c166101a05152600860205260406101a051206cff00000000000000000000000019815416905560ff60d01b1981541681556101205115614d8357506101a08051606060c0819052610180819052610120518252600860205291516040902054919490939185908190819060681c64ffffffffff16421015614457575b937fa0da6e411f3c8e3036b990be806f22429fb3fca5c80e18403e2d8308da13c79d959361431264ffffffffff94614304614346956142f660209a6101a051508d5f1461444a576142e8600a9f5b6101a06040519e8f9e8f90815201526142da8d6142c86101a0820160c05161407b565b9060408183039101526101805161407b565b8d810360608f0152906140b8565b908b820360808d01526140b8565b9089820360a08b01526140eb565b9087820360c08901526140eb565b9188151560e087015263ffffffff6101605160b01c1661010087015261012051610120870152858303610140870152613e9e565b9561ffff6101605160a01c166101608401521694856101808301520390a161436b5750565b61438b63ffffffff6101605160b01c1661ffff6101605160a01c166152fb565b610120516101a05152600860205260406101a0512061ffff1981541690556001600160a01b0360045416803b1561443557604051917f13bebb8200000000000000000000000000000000000000000000000000000000835263ffffffff6101605160b01c166004840152602483015260016044830152816064816101a051936101a051905af1801561443c5761441e5750565b6101a05161442b91613c3c565b6101a05161443557565b6101a05180fd5b6040513d6101a051823e3d90fd5b6142e86101a0519f6142a5565b50505094925090925063ffffffff6101605160b01c166101a051526008602052614489600160406101a0512001613c9f565b60c052610120516101a0515260086020526144ac600160406101a0512001613c9f565b610180526144ca60c05151610180515190818082119118021861402b565b6101a051600a5491959193905b865181101561458d5760068311156145735760c084018160031b82810460081483151715614559576145148760ff61451993819535901c1661405d565b613fee565b90549060031b1c1690602882101561453f57600191614538828a613f97565b52016144d7565b634e487b7160e01b6101a05152602160045260246101a051fd5b634e487b7160e01b6101a05152601160045260246101a051fd5b634e487b7160e01b6101a05152603260045260246101a051fd5b5094919250926001600160a01b0360035416926145bc6145ac86613f7f565b6040516101e0526101e051613c3c565b6101e0805186905251602001600586901b8201813682116144355783905b828210614d7357505050602060c0515111614d45576020610180515111614d175760066101e0515110614ce9576101e0515115614573575160c05161461f9190615430565b506101e05151600310156145735761464160806101e051015161018051615430565b5060c05151610180515190959061466a9080881115614ce35780975b818082119118021861402b565b6101005261468860c05151610180515190818082119118021861402b565b946146a360c05151610180515190818082119118021861402b565b60e0526101a0516101c0819052610140819052905b87610140511061480c5750610180515160c05151808211156147765750506146f2906146ec610180515160c0515190613eeb565b90613e00565b955b61018051518110156147195780600261471260019361010051613f97565b52016146f4565b506143466020939264ffffffffff926143127fa0da6e411f3c8e3036b990be806f22429fb3fca5c80e18403e2d8308da13c79d9798995b6101c05110159861430460e0516142f66101005197505094985050945050939550614257565b8181999399116147be575b5050506143466020939264ffffffffff926143127fa0da6e411f3c8e3036b990be806f22429fb3fca5c80e18403e2d8308da13c79d979899614750565b6147d4916147cb91613eeb565b6101c051613e00565b6101c0525b60c051518110156147fc578060016147f5819361010051613f97565b52016147d9565b506143468264ffffffffff614781565b67ffffffffffffffff6148246101405160c051613f97565b5116158015614cc1575b156149655767ffffffffffffffff61484b6101405160c051613f97565b511661495c5760ff6101a0515b166148666101405189613f97565b5267ffffffffffffffff6148806101405161018051613f97565b51166149535760ff6101a0515b1661489d6101405160e051613f97565b525b6148ac6101405188613f97565b516148bc6101405160e051613f97565b5110156148f7576148cf6101c0516153cb565b6101c05260016148e56101405161010051613f97565b525b60016101405101610140526146b8565b906149076101405160e051613f97565b516149156101405189613f97565b51101561493e57614925906153cb565b9060026149386101405161010051613f97565b526148e7565b906101a0516149386101405161010051613f97565b60ff600161488d565b60ff6001614858565b6149d2602067ffffffffffffffff6149826101405160c051613f97565b511661499d60ff614996610140518c613f97565b511661539b565b9060405193849283927f6bb0aa38000000000000000000000000000000000000000000000000000000008452600484016153aa565b0381855afa90811561443c576101a05191614c8e575b506149f561ffff9161576a565b16614a28602067ffffffffffffffff614a146101405161018051613f97565b511661499d60ff614996610140518d613f97565b0381865afa90811561443c576101a05191614c5b575b50614a4b61ffff9161576a565b1661010482118015614c50575b614c36576101405160101115614ba2576101e05151600110156145735760406101e0510151610140516101405160041b0460101461014051151715614559576001600160f01b0319906101405160041b1c60f01b166101a051506101e0515160041015614573576101e05160a001516101405160041b1c60f01b6001600160f01b031916926014905b04600181018111614559576101a0515b600182018110614b67575050506014900490600182018211614559576101a0515b600183018110614b245750505061489f565b600190614b51826001600160f01b03198516831c60f01c16614b4b6101405160e051613f97565b51613e00565b614b606101405160e051613f97565b5201614b12565b6001908c614b9b614b90846001600160f01b03198816851c60f01c16614b4b6101405185613f97565b916101405190613f97565b5201614af1565b61014051600f19810111614559576101e0515160021015614573576101e0516060015161014051600f1901600481901b81900460101490151715614559576001600160f01b031990600f19610140510160041b1c60f01b166101a051506101e0515160051015614573576101e05160c0015161014051600f190160041b1c60f01b6001600160f01b03191692601490614ae1565b634e487b7160e01b6101a05152600160045260246101a051fd5b506101048111614a58565b90506020813d8211614c86575b81614c7560209383613c3c565b810103126122dd5751614a4b614a3e565b3d9150614c68565b90506020813d8211614cb9575b81614ca860209383613c3c565b810103126122dd57516149f56149e8565b3d9150614c9b565b5067ffffffffffffffff614cdb6101405161018051613f97565b51161561482e565b8761465d565b7fcd7d38ef000000000000000000000000000000000000000000000000000000006101a0515260046101a051fd5b7f0ee80e93000000000000000000000000000000000000000000000000000000006101a0515260046101a051fd5b7f01a164d4000000000000000000000000000000000000000000000000000000006101a0515260046101a051fd5b81358152602091820191016145da565b60a09193507fe2e4c268dfec6acc7d65736af81e978a3d91773ba4bd1812a44035a863bc15359250614dca63ffffffff6101605160b01c1661ffff61016051851c166152fb565b548060d81c936001600160a01b036040519261ffff61016051861c16845263ffffffff6101605160b01c1660208501521660408301528460608301526080820152a16001600160a01b03600f541690602460206001600160a01b036004541660405192838092630ef7959160e21b825263ffffffff6101605160b01c1660048301525afa90811561443c576101a05191614f64575b5060206001600160a01b03600354169260246040518095819363231b667d60e21b835260048301525afa91821561443c576101a05192614f1a575b5060405163ec01f01960e01b8152601660048201526001600160a01b039190911660248201529015156044820152600160648201526101a0519091602091839160849183915af1801561443c57614eee5750565b6020813d602011614f12575b81614f0760209383613c3c565b810103126122dd5750565b3d9150614efa565b91506020823d602011614f5c575b81614f3560209383613c3c565b810103126144355760846001600160a01b0391614f53602094613dac565b93509150614e9a565b3d9150614f28565b614f7d915060203d602011613775576137678183613c3c565b5f614e5f565b5f614f8d91613c3c565b5f6101a0525f6141ce565b7fbc2206b9000000000000000000000000000000000000000000000000000000005f5260045ffd5b9190918054831015613e7b575f52601860205f208360021c019260031b1690565b6001600160a01b03168015615070576001600160a01b037f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c19930054826001600160a01b03198216177f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c19930055167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e05f80a3565b7f1e4fbdf7000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b600460406001600160a01b03600d54168151928380927f6d4ce63c0000000000000000000000000000000000000000000000000000000082525afa9081156122d2575f905f9261512c575b5067ffffffffffffffff62ffffff600e5460a01c169116029067ffffffffffffffff8216918203612309576affffffffffffffffffffff9161512891613fab565b1690565b9150506040813d604011615183575b8161514860409383613c3c565b810103126122dd5780519067ffffffffffffffff821682036122dd5760200151906affffffffffffffffffffff821682036122dd575f6150e7565b3d915061513b565b6001600160a01b037f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300541633036151be57565b7f118cdaa7000000000000000000000000000000000000000000000000000000005f523360045260245ffd5b61ffff6151f682613e8f565b1615159081615208575b501561394257565b61ffff915060206152199101613e8f565b1615155f615200565b91905f83545f1981019081116123095793919092935b8084111561524a575b505050505f1990565b6152606152578583613eeb565b60011c85613e00565b938267ffffffffffffffff6152758787614fc0565b90549060031b1c16145f1461528b575050505090565b8267ffffffffffffffff6152a487879998959697614fc0565b90549060031b1c16105f146152cb57506001810180911161230957905b9391909293615238565b915080156152f3575f198101908111156152c157634e487b7160e01b5f52601160045260245ffd5b839450615241565b90815f52600260205261533663ffffffff821660405f209068ffffffffff0000000082549160201b169068ffffffffff000000001916179055565b805f52600860205261ffff60405f20541661536a575b5f52600860205261ffff8060405f2092161661ffff19825416179055565b805f52600860205261ffff60405f2054165f52600260205260405f2068ffffffffff0000000019815416905561534c565b60ff16602881101561235c5790565b916020613cf092949367ffffffffffffffff60408201961681520190613fe1565b5f1981146123095760010190565b60ff7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005460401c161561540857565b7fd7e6bcf8000000000000000000000000000000000000000000000000000000005f5260045ffd5b9190915f5b8151808210156154b4579061545e61545861545283600195613eeb565b8761405d565b82613e00565b80820361546d575b5001615435565b67ffffffffffffffff6154808286613f97565b5116906154a267ffffffffffffffff6154998588613f97565b51169186613f97565b526154ad8285613f97565b525f615466565b5090925050565b604051906154cb61026083613c3c565b61023082527edc026f00ebcc8500fcb8b7010edbd500000000000000000000000000000000610240837854000000ae0000010e00000176000001e60000025e000002de60208201527d0368000003fd0000049b00000546000005fc000006c0000007920000087360408201527d096400000a6600000b7b00000ca400000de100000f36000010a20000122960608201527d13cb0000158b0000176b0000196e00001b9400001de20000205a000022ff60808201527d25d5000028dd00002c1e00002f99000033540000375200003b9a0000403060a08201527d451900004a5c00004fff0000560900005c810000637000006add000072d160c08201527d7b570000847900008e42000098be0000a3f90000b0020000bce70000cab860e08201527dd9860000e9630000fa6200010c990001201d0001350600014b6f000163736101008201527e017d2e000198c10001b64e0001d5f80001f7e600021c430002433b00026cfd6101208201527e0299be0002c9b30002fd180003342b00036f320003ae730003f23d00043ae36101408201527e0488be0004dc2f0005359b000595700005fc2400066a360006e02d00075e996101608201527e07e6160008774c000912eb0009b9b4000a6c74000b2c06000bf956000cd5616101808201527e0dc134000ebdf3000fccd40010ef2400122648001373bf0014d9230016582c6101a08201527e17f2b00019aaa9001b8234001d7b95001f99390021ddbc00244be60026e6b66101c08201527e29b15f002caf51002fe43a0033540d00370303003af5a4003f30cc0043b9b06101e08201527e4895e3004dcb600053609100595c53005fc6030066a585006e034d0075e86c6102008201527e7e5e980087703b0091287d009b935300a6bd8f00b2b4ee00bf882800cd47056102208201520152565b5f906157746154bb565b5160021c5b808310615795575050801561578f5761ffff1690565b50600190565b61579f8184613e00565b600181811c9291901b6003191682156004848304141715612309577fff000000000000000000000000000000000000000000000000000000000000006157ec826157e76154bb565b6158da565b51166157f66154bb565b6001830190818411612309577eff0000000000000000000000000000000000000000000000000000000000009161582c916158da565b5160081c161761583a6154bb565b6002830190818411612309577dff00000000000000000000000000000000000000000000000000000000009161586f916158da565b5160101c161761587d6154bb565b9160038101809111612309576158b27cff000000000000000000000000000000000000000000000000000000009187946158da565b5160181c161760e01c11156158c75750615779565b9250600181018091116123095791615779565b908151811015613e7b570160200190565b90615928575080511561590057805190602001fd5b7fd6bda275000000000000000000000000000000000000000000000000000000005f5260045ffd5b8151158061596e575b615939575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b1561593156fea2646970667358221220f3bdfc3b2ffa56cbce3a8c50f8e2c4c585b2c2592a03c52b9339dadef3f6be8364736f6c634300081c0033f0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00

0x610200806040526004361015610013575f80fd5b5f60a0525f3560e01c9081630a30542d14613a13575080630d16f20a146131de5780630d65c036146131ba5780631cedf5231461314b5780631f4eb0d61461305d578063246fb519146130405780632fc150ea14612fd157806335d3659a14612fb65780633faf0ff514612e5c5780634e70a3b614612cfb5780634f1ef28614612a4d57806350309b05146129f757806352d1902d14612965578063593500e41461294957806361c9fd2a1461261e578063649357c3146125af5780636b3de4391461200357806370f246d414611e3e578063715018a614611d9a578063766d8e0114611b7f57806388ce1d781461192c5780638da5cb5b146118e55780638dcec2e6146118a2578063a526596a14611732578063a61cce251461170f578063acfda69e146116cc578063ad3cb1cc14611652578063ba660b8a14611575578063bcc16cad14610ac0578063be52e34f14610a45578063db3e281c1461096d578063dbc0687f1461084d578063e4a4b7b11461051f578063e987f790146103d4578063ef242ace14610243578063f2fde38b14610214578063f76e782a146101f05763fc587ba8146101c3575f80fd5b346101ea5760a0513660031901126101ea57602062ffffff600e5460a01c16604051908152f35b60a05180fd5b346101ea5760a0513660031901126101ea57602061020c61509c565b604051908152f35b346101ea5760203660031901126101ea5761023d610230613bd2565b61023861518b565b614fe1565b60a05180f35b346101ea5761025136613c7a565b6001600160a01b036004541633036103a8578160a0515260086020526001604060a05120019182546102835760a05180f35b61028d8284615222565b6001810161029c575b5061023d565b83545f19810190811161030d5781101561032557600181019081811161030d5767ffffffffffffffff6102d160019387614fc0565b90549060031b1c166103056102e68388614fc0565b819391549067ffffffffffffffff809160031b9316831b921b19161790565b90550161029c565b634e487b7160e01b60a051526011600452602460a051fd5b50908254918215610390577f1edc2b7b43df588e9e4c216a340d4aad41c9a47bd341383338a2175056beab95936040935f1901906103638282614fc0565b67ffffffffffffffff82549160a0515060031b1b191690555582519182526020820152a180808080610296565b634e487b7160e01b60a051526031600452602460a051fd5b7f74099c740000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea5760203660031901126101ea5760043567ffffffffffffffff81116101ea57610405903690600401613b70565b9061040e61518b565b61ffff6009541660a0515060a0515b83811061047857509161ffff7ff7fa072be30d392a00cbc048901c45f3ba250bb961dea1a0cfc06e9b0a350e3a931661ffff19600954161760095561046f604051928392602084526020840191613e9e565b0390a160a05180f35b90610484828585613e6b565b3560a05152600260205261ffff604060a051205416156104f3576104cd6001916104af848787613e6b565b3560a05152600260205261ffff604060a051205460101c1690613eeb565b916104d9818686613e6b565b3560a05152600260205260a051604060a05120550161041d565b7f04b8bd1f0000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea5761052d36613c7a565b60035460405163e743862960e01b81523360048201526024810183905290602090829060449082906001600160a01b03165afa9081156107415760a05191610813575b5015610800578160a05152600260205264ffffffffff604060a051205460201c1660206001600160a01b036004541691604460405180948193632bf0856760e11b835260048301528660248301525afa9081156107415760a051916107d1575b5060078110156107b957156107a6578160a051526002602052604060a051209182549264ffffffffff6affffffffffffffffffffff8560481c169460a01c16617080810180911161030d57421061077a5780547fffffffffffffff00000000000000000000000000000000ffffffffffffffffff1664ffffffffff60a01b4260a01b16178155831561074e5764ffffffffff6001600160a01b0360065416915460201c1690803b156101ea57604051917f9a30f86e00000000000000000000000000000000000000000000000000000000835260048301523360248301528360448301528460648301528160848160a0519360a051905af1801561074157610728575b5061708042019283421161030d577f14a992338172c40df4462447b550ac77ef75340cb0caa286624f9ac44a7cdc239360a093604051938452336020850152604084015260608301526080820152a160a05180f35b60a05161073491613c3c565b60a0516101ea57836106d3565b6040513d60a051823e3d90fd5b7f67a3a3500000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b7f176cc82c0000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b6325d7e13960e11b60a05152600460a051fd5b634e487b7160e01b60a051526021600452602460a051fd5b6107f3915060203d6020116107f9575b6107eb8183613c3c565b810190613db9565b836105d0565b503d6107e1565b630a71f87f60e31b60a05152600460a051fd5b90506020813d602011610845575b8161082e60209383613c3c565b810103126101ea5761083f90613dac565b83610570565b3d9150610821565b346101ea5760203660031901126101ea5760055460405190630935e01b60e21b82523360048301526020826024816001600160a01b0385165afa9182156107415760a05192610931575b5081610923575b50156108f75760043560a051526001602052604060a051205460a0515260a051602052604060a051207a01000000000000000000000000000000000000000000000000000060ff60d01b1982541617905560a05160a051f35b7facc0304c0000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b60ff915060a01c168161089e565b9091506020813d602011610965575b8161094d60209383613c3c565b810103126101ea5761095e90613dac565b9082610897565b3d9150610940565b346101ea5760203660031901126101ea5760405161098a81613c04565b60a051815260a051602082015260a051604082015260a0516060820152608060a05191015260043560a0515260a05160205260a0604081512064ffffffffff604051916109d683613c04565b546001600160a01b0381169283815263ffffffff6020820161ffff84881c16815261ffff6040840191838660b01c1683526080606086019560ff8860d01c1615158752019560d81c86526040519788525116602087015251166040850152511515606084015251166080820152f35b346101ea5760403660031901126101ea5760243567ffffffffffffffff81116101ea57610a76903690600401613b70565b6001600160a01b03600e54163303610a945761023d91600435614121565b7f580ae4250000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea576101e03660031901126101ea5760043567ffffffffffffffff81116101ea57610af2903690600401613ba1565b6024356001600160a01b03811681036101ea576044356001600160a01b03811681036101ea576001600160a01b0360643516606435036101ea57608435916001600160a01b03831683036101ea5760a4356001600160a01b03811681036101ea5760c435936001600160a01b03851685036101ea5760e435916001600160a01b03831683036101ea5761010435926001600160a01b03841684036101ea576101243567ffffffffffffffff81116101ea57610bb1903690600401613b70565b6101443598909791969060ff8a168a036101ea57610164359662ffffff881688036101ea5761018435946001600160a01b03861686036101ea576101a435926001600160a01b03841684036101ea576101c43515156101c435036101ea577ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005460805267ffffffffffffffff608051161580611565575b600167ffffffffffffffff6080511614908161155b575b159081611552575b506115265760805167ffffffffffffffff1981166001177ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005560401c60ff16156114e5575b610cb46153d9565b610cbc6153d9565b610cc533614fe1565b610ccd6153d9565b600354956001600160a01b03166004546001600160a01b0319161760045560095460643560101b75ffffffffffffffffffffffffffffffffffffffff000016907fffffffffffffffffffff0000000000000000000000000000000000000000ffff161797886009556001600160a01b038a166006546001600160a01b031916176006556001600160a01b03166007546001600160a01b031916176007556001600160a01b0316600c546001600160a01b03191617600c556001600160a01b0316600e546001600160a01b03191617600e556001600160a01b0316600d546001600160a01b03191617600d556001600160a01b0316600f546001600160a01b03191617600f556001600160a01b0316907fffffffffffffffffffff000000000000000000000000000000000000000000001617740100000000000000000000000000000000000000001778ffffffffffffffffffffffffffffffffffffffffffffffffff16790100000000000000000000000000000000000000000000000000176003556005546101c435151560a01b60ff60a01b16916001600160a01b0316907fffffffffffffffffffffff000000000000000000000000000000000000000000161717600555604051917f095ea7b30000000000000000000000000000000000000000000000000000000083526001600160a01b031660048301525f1960248301528160a0519160101c6001600160a01b0316815a93604492602095f1801561074157611487575b507fda633cde6ca79d54327cac43e6005ce4972dd2f17ccde49c42e7eee1284135dd906020906101c4351561147e5761012c5b62ffffff60a01b1962ffffff60a01b600d549260a01b16911617600d55610f4e61518b565b60035462ffffff60b01b1962ffffff60b01b8360b01b1691161760035562ffffff60405191168152a1610f7f61518b565b762dc6c0000000000000000000000000000000000000000062ffffff60a01b19600e541617600e557f49b98b5066c079ce5d03fa1b58f85e07295e2baf54b78dc4da95bb1d4aa60b4c6020604051622dc6c08152a1610fdc61518b565b60a0515b82811061137c5750604051918060208401602085525260408301919060a051905b80821061135257505050917fbbc349ca0d0701b306c6c0053cbdf135aa36755f4dfb3b8f7c3ae39b5df7684d826020937f4f54a0bb0df8a35f3887bec08b0faa868f57b6052aaa6842765663cb6a6d5d69950390a161105e61518b565b600b5460ff60a01b1960ff60a01b8360a01b16911617600b5560ff60405191168152a161108961518b565b61ffff600954169161ffff60035460a01c1660a0515060a0515b8381106111c45750826110b591613e00565b61ffff60a01b1961ffff60a01b6003549260a01b169116176003556103e883116111b15761ffff7f471be53ca5fc7faa446595196a5f57088788425e071be9f0ff0c7cd9f3cabe2e931661ffff19600954161760095561111a60405192839283613ef8565b0390a160ff60805160401c16156111315760a05180f35b68ff0000000000000000197ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a0054167ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00557fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2602060405160018152a161023d565b630b1a83c360e31b60a05152600460a051fd5b936111d0858585613edb565b6111e36111de878787613edb565b6151ea565b6111ed8387613e00565b61ffff6111f983613e8f565b16036104f35761120881613e8f565b602082019161121683613e8f565b6040519261122384613c20565b61ffff168352602083019061ffff1681526040830160a0518152606084019060a0518252608085019260a051845260a086019460a051865261126490613e8f565b60a0805161ffff92831690526002602052516040902096518754925163ffffffff1990931691161760109190911b63ffff00001617855551845468ffffffffff00000000191660209190911b68ffffffffff000000001617845551835473ffffffffffffffffffffff000000000000000000191660489190911b73ffffffffffffffffffffff0000000000000000001617835551825464ffffffffff60a01b191660a09190911b64ffffffffff60a01b1617825551815461ffff60c81b191660c89190911b61ffff60c81b1617905561133c90613e8f565b61ffff1661134991613e00565b936001016110a3565b90919283359060288210156101ea576020816113718293600195613fe1565b019401920190611001565b611387818484613e6b565b3560288110156101ea5715158061145f575b6113a4828585613e6b565b359060288210156101ea571561142a57506113c0818484613e6b565b359060288210156101ea57600a549168010000000000000000831015611412576113f1836001809501600a55613fee565b60a0929192515060ff8084549260031b9316831b921b191617905501610fe0565b634e487b7160e01b60a051526041600452602460a051fd5b611458907f7a566b2f0000000000000000000000000000000000000000000000000000000060a05152613fd3565b602460a051fd5b5061146b818484613e6b565b3560288110156101ea5760011415611399565b6203f480610f29565b6020813d6020116114dd575b816114a060209383613c3c565b810103126101ea577fda633cde6ca79d54327cac43e6005ce4972dd2f17ccde49c42e7eee1284135dd916114d5602092613dac565b509150610ef6565b3d9150611493565b60805168ffffffffffffffffff191668010000000000000001177ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a0055610cac565b7ff92ee8a90000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b9050155f610c67565b303b159150610c5f565b5060ff60805160401c1615610c48565b346101ea5760203660031901126101ea5760055460405190630935e01b60e21b82523360048301526020826024816001600160a01b0385165afa9182156107415760a05192611616575b5081611608575b50156108f75760a0805160043590526008602052516040812080547fffffffffffffffffffffffffff000000000000ff00000000000000000000ffff16905580f35b60ff915060a01c16816115c6565b9091506020813d60201161164a575b8161163260209383613c3c565b810103126101ea5761164390613dac565b90826115bf565b3d9150611625565b346101ea5760a0513660031901126101ea5760408051906116738183613c3c565b6005825260208201917f352e302e3000000000000000000000000000000000000000000000000000000083528151928391602083525180918160208501528484015e60a051828201840152601f01601f19168101030190f35b346101ea5760203660031901126101ea576001600160a01b036116ed613bd2565b6116f561518b565b166001600160a01b0319600f541617600f5560a05160a051f35b346101ea5760a0513660031901126101ea57602061ffff60095416604051908152f35b346101ea5760203660031901126101ea5760043567ffffffffffffffff81116101ea57611763903690600401613b70565b61176b61518b565b60a0515b8181106117ed5750604051908060208301602084525260408201929060a051905b8082106117c3577fbbc349ca0d0701b306c6c0053cbdf135aa36755f4dfb3b8f7c3ae39b5df7684d84860385a160a05180f35b90919384359060288210156101ea576020816117e28293600195613fe1565b019501920190611790565b6117f8818385613e6b565b3560288110156101ea57151580611883575b611815828486613e6b565b359060288210156101ea571561142a5750611831818385613e6b565b359060288210156101ea57600a54916801000000000000000083101561141257611862836001809501600a55613fee565b60a0929192515060ff8084549260031b9316831b921b19161790550161176f565b5061188f818385613e6b565b3560288110156101ea576001141561180a565b346101ea5760203660031901126101ea576001600160a01b036118c3613bd2565b6118cb61518b565b166001600160a01b0319600b541617600b5560a05160a051f35b346101ea5760a0513660031901126101ea5760206001600160a01b037f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c1993005416604051908152f35b346101ea5760203660031901126101ea5760043567ffffffffffffffff81116101ea5761195d903690600401613ba1565b61196561518b565b61ffff600954169161ffff60035460a01c1660a0515060a0515b8381106119f657508261199191613e00565b61ffff60a01b1961ffff60a01b6003549260a01b169116176003556103e883116111b15761ffff7f471be53ca5fc7faa446595196a5f57088788425e071be9f0ff0c7cd9f3cabe2e931661ffff19600954161760095561046f60405192839283613ef8565b93611a02858585613edb565b611a106111de878787613edb565b611a1a8387613e00565b61ffff611a2683613e8f565b16036104f357611a3581613e8f565b6020820191611a4383613e8f565b60405192611a5084613c20565b61ffff168352602083019061ffff1681526040830160a0518152606084019060a0518252608085019260a051845260a086019460a0518652611a9190613e8f565b60a0805161ffff92831690526002602052516040902096518754925163ffffffff1990931691161760109190911b63ffff00001617855551845468ffffffffff00000000191660209190911b68ffffffffff000000001617845551835473ffffffffffffffffffffff000000000000000000191660489190911b73ffffffffffffffffffffff0000000000000000001617835551825464ffffffffff60a01b191660a09190911b64ffffffffff60a01b1617825551815461ffff60c81b191660c89190911b61ffff60c81b16179055611b6990613e8f565b61ffff16611b7691613e00565b9360010161197f565b346101ea5760203660031901126101ea5760043561ffff600954168110611d6e57801560015b61ffff60035460a01c16811015611c845760a08051829052600260205251604090205460101c61ffff1683810291908483041483171561030d5760095461ffff16918215611c6c57600192611c6691048260a051526002602052611c2d6affffffffffffffffffffff604060a0512092166affffffffffffffffffffff835460481c16613fab565b73ffffffffffffffffffffff0000000000000000001973ffffffffffffffffffffff00000000000000000083549260481b169116179055565b01611ba5565b634e487b7160e01b60a051526012600452602460a051fd5b82606460206001600160a01b0360095460101c16604051928380927f23b872dd00000000000000000000000000000000000000000000000000000000825233600483015230602483015286604483015260a051905af19081156107415760a05191611d34575b5015611d215760207f4d6ce1e535dbade1c23defba91e23b8f791ce5edc0cc320257a2b364e4e3842691604051908152a160a05180f35b6312171d8360e31b60a05152600460a051fd5b90506020813d602011611d66575b81611d4f60209383613c3c565b810103126101ea57611d6090613dac565b82611cea565b3d9150611d42565b7f1fbaba350000000000000000000000000000000000000000000000000000000060a05152600460a051fd5b346101ea5760a0513660031901126101ea57611db461518b565b7f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300546001600160a01b031981167f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300556001600160a01b0360a05191167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e060a05160a051a360a05180f35b346101ea5760a0513660031901126101ea575f1961ffff60035460a01c160161ffff811161030d5761ffff16611e7381613f7f565b90611e816040519283613c3c565b808252611e90601f1991613f7f565b0160a0515b818110611fec5760a05183905b8151811015611f4557600181019081811161030d5760019160a051526002602052604060a0512061ffff60405191611ed983613c20565b548181168352818160101c16602084015264ffffffffff8160201c1660408401526affffffffffffffffffffff8160481c16606084015264ffffffffff8160a01c16608084015260c81c1660a0820152611f338285613f97565b52611f3e8184613f97565b5001611ea2565b5060405180916020820160208352815180915260206040840192019060a0515b818110611f73575050500390f35b91935091602060c082611fde600194885161ffff60a0809282815116855282602082015116602086015264ffffffffff60408201511660408601526affffffffffffffffffffff606082015116606086015264ffffffffff6080820151166080860152015116910152565b019401910191849392611f65565b602090611ff7613e3b565b82828601015201611e95565b346122dd5760603660031901126122dd5760043560243561ffff81168091036122dd5760035460405163e743862960e01b815233600482015260448035602483018190529492602091839182906001600160a01b03165afa9081156122d2575f91612575575b501561256657604460206001600160a01b036004541660405192838092632bf0856760e11b82528660048301528860248301525afa9081156122d2575f91612547575b50600781101561235c5715612538576024916102206001600160a01b0360075416604051948580927f810de9de0000000000000000000000000000000000000000000000000000000082528560048301525afa9283156122d2575f93612370575b508251601781101561235c5760161480612345575b1561231d57815f52600860205260405f20805460ff8160901c16610e10810290808204610e1014901517156123095764ffffffffff6121649260681c16613e00565b42106122e15760c061217f62ffffff60e08701511642613e00565b82549190950180517fffffffffffffffffffffffffff000000000000ffffffffffffffffffffffffff909216606887901b71ffffffffff00000000000000000000000000161760909290921b72ff00000000000000000000000000000000000016919091179091556007546001600160a01b031690813b156122dd575f80926064604051809581937ff5298aca000000000000000000000000000000000000000000000000000000008352336004840152886024840152600160448401525af19182156122d25761ffff926122be575b50511692610e10840293808504610e10149015171561030d577f17ad3a74f4ecd94ee25ff386b332b9d4a45bf780b3d2e525b0354cb9d73c9dee9461229660c09583613e00565b9260405194855260208501523360408501526060840152608083015260a0820152a160a05180f35b5f6122c891613c3c565b5f60a0528661224f565b6040513d5f823e3d90fd5b5f80fd5b7f12a13be7000000000000000000000000000000000000000000000000000000005f5260045ffd5b634e487b7160e01b5f52601160045260245ffd5b7fc57521de000000000000000000000000000000000000000000000000000000005f5260045ffd5b5060a0830151600b81101561235c57600714612122565b634e487b7160e01b5f52602160045260245ffd5b909250610220813d8211612530575b8161238d6102209383613c3c565b810103126122dd5760405190610220820182811067ffffffffffffffff82111761251c57604052805160178110156122dd57825260208101517fff00000000000000000000000000000000000000000000000000000000000000811681036122dd57602083015261240060408201613f62565b604083015261241160608201613dac565b606083015261242260808201613f62565b608083015260a0810151600b8110156122dd5760a083015261244660c08201613f62565b60c083015260e081015162ffffff811681036122dd5760e083015261246e6101008201613f71565b6101008301526124816101208201613f71565b6101208301526124946101408201613f71565b6101408301526124a76101608201613f71565b6101608301526124ba6101808201613f71565b6101808301526124cd6101a08201613f71565b6101a08301526124e06101c08201613f71565b6101c08301526101e08101519060288210156122dd57610200916101e0840152015163ffffffff811681036122dd57610200820152918461210d565b634e487b7160e01b5f52604160045260245ffd5b3d915061237f565b6325d7e13960e11b5f5260045ffd5b612560915060203d6020116107f9576107eb8183613c3c565b846120ac565b630a71f87f60e31b5f5260045ffd5b90506020813d6020116125a7575b8161259060209383613c3c565b810103126122dd576125a190613dac565b84612069565b3d9150612583565b346122dd5760203660031901126122dd5760043560ff8116908181036122dd577f4f54a0bb0df8a35f3887bec08b0faa868f57b6052aaa6842765663cb6a6d5d69916020916125fc61518b565b60ff60a01b1960ff60a01b600b549260a01b16911617600b55604051908152a1005b346122dd5760803660031901126122dd5760043560243567ffffffffffffffff81116122dd57612652903690600401613b70565b600b929192546001600160a01b03811633036129215760a01c60ff1681116128f957815f52600860205264ffffffffff60405f205460381c1642106128d157815f526008602052600160405f200167ffffffffffffffff821161251c5768010000000000000000821161251c578054828255808310612877575b5083905f5260205f208260021c905f5b828110612824575060031984168403806127cd575b5050505061270962ffffff600d5460a01c1642613e00565b825f52600860205260405f20906bffffffffff000000000000008083549260381b1616906bffffffffff000000000000001916179055806040519260a0840190845260a060208501525260c0820192905f905b8082106127a157336040850152606435606085015260443560808501527f1a275904484710dcd12bdb55c20cfdc8c34f9cf7bdd594c5ff66317be2572b7884860385a1005b90919384359067ffffffffffffffff82168092036122dd5760208160019382935201950192019061275c565b925f935f5b8181106127e7575050500155838080806126f1565b909194602061281a6001926127fb89613f4d565b908560031b67ffffffffffffffff809160031b9316831b921b19161790565b96019291016127d2565b5f5f5b6004811061283c5750828201556001016126dc565b9490602061286e60019261284f85613f4d565b908960031b67ffffffffffffffff809160031b9316831b921b19161790565b92019501612827565b815f5260205f20600380850160021c8201920160021c019060188460031b16806128b6575b505b8181106128ab57506126cc565b5f815560010161289e565b5f198201908154905f199060200360031b1c1690558661289c565b7f848514ed000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f1275f701000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fa07272dc000000000000000000000000000000000000000000000000000000005f5260045ffd5b346122dd575f3660031901126122dd5760206040516170808152f35b346122dd575f3660031901126122dd576001600160a01b037f000000000000000000000000f7d90fe4334004949e93415d8778c94d19de0a2d1630036129cf5760206040517f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc8152f35b7fe07c8dba000000000000000000000000000000000000000000000000000000005f5260045ffd5b346122dd576020612a0736613c7a565b5f91805f5260088452600160405f200154612a29575b50506040519015158152f35b9091505f5260088252612a445f1991600160405f2001615222565b14158280612a1d565b60403660031901126122dd57612a61613bd2565b6024359067ffffffffffffffff82116122dd57366023830112156122dd57816004013590612a8e82613c5e565b91612a9c6040519384613c3c565b808352602083019336602483830101116122dd57815f926024602093018737840101526001600160a01b037f000000000000000000000000f7d90fe4334004949e93415d8778c94d19de0a2d16803014908115612cc6575b506129cf57612b0161518b565b6001600160a01b038116926040517f52d1902d000000000000000000000000000000000000000000000000000000008152602081600481885afa5f9181612c92575b50612b5b5784634c9c8ce360e01b5f5260045260245ffd5b807f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc869203612c675750823b15612c5557806001600160a01b03197f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc5416177f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc557fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b5f80a2825115612c23575f8091612c21945190845af4612c1b613dd1565b916158eb565b005b50505034612c2d57005b7fb398979f000000000000000000000000000000000000000000000000000000005f5260045ffd5b634c9c8ce360e01b5f5260045260245ffd5b7faa1d49a4000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b9091506020813d602011612cbe575b81612cae60209383613c3c565b810103126122dd57519086612b43565b3d9150612ca1565b90506001600160a01b037f360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc5416141584612af4565b346122dd5760203660031901126122dd5760043567ffffffffffffffff81116122dd57612d2c903690600401613ba1565b612d3461518b565b61ffff60095416915f5b828110612da357506103e88311612d945760ff7f73558c078e436ec3ee705ef31c70f6e7770a885f681d3b0445ded3093a5eb389931661ffff196009541617600955612d8f60405192839283613ef8565b0390a1005b630b1a83c360e31b5f5260045ffd5b92612e0b612deb600192612dbb6111de888888613edb565b61ffff612dd1612dcc898989613edb565b613e8f565b165f52600260205261ffff60405f205460101c1690613eeb565b61ffff612e046020612dfe898989613edb565b01613e8f565b1690613e00565b93612e56612e1f6020612dfe848888613edb565b61ffff612e30612dcc858989613edb565b165f52600260205260405f209063ffff000082549160101b169063ffff00001916179055565b01612d3e565b346122dd5760403660031901126122dd5760043567ffffffffffffffff81116122dd57612e8d903690600401613b70565b60243567ffffffffffffffff81116122dd57612ead903690600401613b70565b9092612eb761518b565b818303612f8e575f5b838110612f415750612ee060209160405194604086526040860191613e9e565b838103828501528281520192905f5b818110612f1e577fa25843fbd9296105e9c4872a482bd5bd12c4c22d18faa29a1b3cb04dcf5cc0b784860385a1005b90919360208060019261ffff612f3389613c90565b168152019501929101612eef565b80612f88612f55612dcc600194878a613e6b565b612f60838887613e6b565b355f52600260205260405f209061ffff60c81b1961ffff60c81b83549260c81b169116179055565b01612ec0565b7fff633a38000000000000000000000000000000000000000000000000000000005f5260045ffd5b346122dd575f3660031901126122dd576020604051600a8152f35b346122dd5760203660031901126122dd577f49b98b5066c079ce5d03fa1b58f85e07295e2baf54b78dc4da95bb1d4aa60b4c602061300d613b5e565b61301561518b565b600e5462ffffff60a01b1962ffffff60a01b8360a01b16911617600e5562ffffff60405191168152a1005b346122dd575f3660031901126122dd576020604051620151808152f35b346122dd5760203660031901126122dd57613076613e3b565b506004355f52600260205260c060405f2061ffff6040519161309783613c20565b548181168352818160101c16602084015264ffffffffff8160201c1660408401526affffffffffffffffffffff8160481c16606084015264ffffffffff8160a01c16608084015260c81c1660a0820152613149604051809261ffff60a0809282815116855282602082015116602086015264ffffffffff60408201511660408601526affffffffffffffffffffff606082015116606086015264ffffffffff6080820151166080860152015116910152565bf35b346122dd5760203660031901126122dd577fda633cde6ca79d54327cac43e6005ce4972dd2f17ccde49c42e7eee1284135dd6020613187613b5e565b61318f61518b565b60035462ffffff60b01b1962ffffff60b01b8360b01b1691161760035562ffffff60405191168152a1005b346122dd575f3660031901126122dd57602060405169021e19e0c9bab24000008152f35b60603660031901126122dd57600435602435604435906001600160a01b03600354166020604051809263e743862960e01b82528180613237883360048401602090939291936001600160a01b0360408201951681520152565b03915afa9081156122d2575f916139d9575b5015612566576001600160a01b0360045416604051632bf0856760e11b8152846004820152836024820152602081604481855afa9081156122d2575f916139ba575b50600781101561235c5760031161399257815f52600260205264ffffffffff60405f205460201c169081851461396a57825f52600260205260405f20548361ffff82160361394257602061ffff60249260c81c1692604051928380927fb4e4568c0000000000000000000000000000000000000000000000000000000082528a60048301525afa80156122d2575f90613907575b61ffff91501681116138dc5750835f52600860205260405f206001810154156138b4575460ff8160601c1661388c5764ffffffffff429160101c1611613864575f5260086020524264ffffffffff60405f205460681c161161383c5761338361509c565b3410613814575f808080346001600160a01b03600c54165af16133a4613dd1565b501561380557600354908160c81c9166ffffffffffffff83146123095762ffffff61341d9178ffffffffffffffffffffffffffffffffffffffffffffffffff7fffffffffffffff000000000000000000000000000000000000000000000000006001870160c81b169116178060035560b01c1642613e00565b5f85815260086020526040902080546cff0000000000ffffffffff00001916601083901b66ffffffffff000016176c010000000000000000000000001790559163ffffffff85116137d45760405161347481613c04565b33815261ffff8316602080830191825263ffffffff8816604080850191825260016060860190815264ffffffffff8a16608087019081525f8881528086528381209751965194519251915160a095861b61ffff60a01b166001600160a01b039889161760b09490941b79ffffffff00000000000000000000000000000000000000000000169390931791151560d01b7aff0000000000000000000000000000000000000000000000000000169190911760d89290921b7fffffffffff0000000000000000000000000000000000000000000000000000001691909117909555600e5490517f1b739ef1000000000000000000000000000000000000000000000000000000008152600760048201529181901c62ffffff1660248301529093919284926044928492165af19081156122d2575f9161377c575b507f1a21db71798c9ad0e440893262de304983ce8427c19dfd3ae9a365d06a2db16f9360e093928264ffffffffff935f5260016020528160405f2055604051948986526020860152336040860152876060860152608085015260a08401521660c0820152a16001600160a01b03600f54169160206001600160a01b036004541691602460405180948193630ef7959160e21b835260048301525afa9081156122d2575f9161374d575b5060206001600160a01b03600354169260246040518095819363231b667d60e21b835260048301525afa9182156122d2575f92613701575b5060846001600160a01b03915f60209495604051968795869463ec01f01960e01b86526015600487015216602485015215156044840152600160648401525af180156122d2576136d957005b612c219060203d6020116136fa575b6136f28183613c3c565b810190613e2c565b503d6136e8565b91506020823d602011613745575b8161371c60209383613c3c565b810103126122dd5760846001600160a01b03915f61373b602095613dac565b945050915061368d565b3d915061370f565b61376f915060203d602011613775575b6137678183613c3c565b810190613e0d565b83613655565b503d61375d565b90506020929192813d6020116137cc575b8161379a60209383613c3c565b810103126122dd57519091907f1a21db71798c9ad0e440893262de304983ce8427c19dfd3ae9a365d06a2db16f6135ac565b3d915061378d565b847f6dfcc650000000000000000000000000000000000000000000000000000000005f52602060045260245260445ffd5b6312171d8360e31b5f5260045ffd5b7f77e47bb9000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f0cdab084000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fdbd8f29e000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f2c3a0bbf000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f4d55013d000000000000000000000000000000000000000000000000000000005f5260045ffd5b7f1aa03325000000000000000000000000000000000000000000000000000000005f5260045260245ffd5b506020813d60201161393a575b8161392160209383613c3c565b810103126122dd5761393561ffff91613f62565b61331f565b3d9150613914565b7fad7147b6000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fdf04091b000000000000000000000000000000000000000000000000000000005f5260045ffd5b7fd52ab5d1000000000000000000000000000000000000000000000000000000005f5260045ffd5b6139d3915060203d6020116107f9576107eb8183613c3c565b8561328b565b90506020813d602011613a0b575b816139f460209383613c3c565b810103126122dd57613a0590613dac565b84613249565b3d91506139e7565b346122dd5760203660031901126122dd5760c081613a32606093613be8565b5f81525f60208201525f60408201525f838201525f60808201525f60a082015201526004355f52600860205264ffffffffff60405f20604051613a7481613be8565b81549161ffff8316825260ff6020830193858160101c168552856040850193818360381c16855260608601848460601c161515815282613ace600160808a0194838860681c1686528860a08c019860901c16885201613c9f565b9660c089019788526040519a8b9a60208c5261ffff6101008d019b511660208d0152511660408b0152511660608901525115156080880152511660a0860152511660c0840152519060e0808401528151809152602061012084019201905f5b818110613b3b575050500390f35b825167ffffffffffffffff16845285945060209384019390920191600101613b2d565b6004359062ffffff821682036122dd57565b9181601f840112156122dd5782359167ffffffffffffffff83116122dd576020808501948460051b0101116122dd57565b9181601f840112156122dd5782359167ffffffffffffffff83116122dd576020808501948460061b0101116122dd57565b600435906001600160a01b03821682036122dd57565b60e0810190811067ffffffffffffffff82111761251c57604052565b60a0810190811067ffffffffffffffff82111761251c57604052565b60c0810190811067ffffffffffffffff82111761251c57604052565b90601f8019910116810190811067ffffffffffffffff82111761251c57604052565b67ffffffffffffffff811161251c57601f01601f191660200190565b60409060031901126122dd576004359060243590565b359061ffff821682036122dd57565b90604051918281549182825260208201905f5260205f20925f905b806003830110613d5757613cf0945491818110613d3c575b818110613d1e575b818110613d00575b10613cf2575b500383613c3c565b565b60c01c81526020015f613ce8565b92602060019167ffffffffffffffff8560801c168152019301613ce2565b92602060019167ffffffffffffffff8560401c168152019301613cda565b92602060019167ffffffffffffffff85168152019301613cd2565b9160049193506080600191865467ffffffffffffffff8116825267ffffffffffffffff8160401c16602083015267ffffffffffffffff81841c16604083015260c01c6060820152019401920185929391613cba565b519081151582036122dd57565b908160209103126122dd575160078110156122dd5790565b3d15613dfb573d90613de282613c5e565b91613df06040519384613c3c565b82523d5f602084013e565b606090565b9190820180921161230957565b908160209103126122dd57516001600160a01b03811681036122dd5790565b908160209103126122dd575190565b60405190613e4882613c20565b5f60a0838281528260208201528260408201528260608201528260808201520152565b9190811015613e7b5760051b0190565b634e487b7160e01b5f52603260045260245ffd5b3561ffff811681036122dd5790565b90918281527f07ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff83116122dd5760209260051b809284830137010190565b9190811015613e7b5760061b0190565b9190820391821161230957565b60208082528101839052604001915f5b818110613f155750505090565b90919260408060019261ffff613f2a88613c90565b16815261ffff613f3c60208901613c90565b166020820152019401929101613f08565b3567ffffffffffffffff811681036122dd5790565b519061ffff821682036122dd57565b51908160010b82036122dd57565b67ffffffffffffffff811161251c5760051b60200190565b8051821015613e7b5760209160051b010190565b906affffffffffffffffffffff809116911601906affffffffffffffffffffff821161230957565b602881101561235c57600452565b90602882101561235c5752565b90600a54821015613e7b57600a5f52600582901c7fc65a7bb8d6351c1cf70c95a316cc6a92839c986682d98bc35f958f4883f9d2a80191601f1690565b9061403582613f7f565b6140426040519182613c3c565b8281528092614053601f1991613f7f565b0190602036910137565b8115614067570690565b634e487b7160e01b5f52601260045260245ffd5b90602080835192838152019201905f5b8181106140985750505090565b825167ffffffffffffffff1684526020938401939092019160010161408b565b90602080835192838152019201905f5b8181106140d55750505090565b82518452602093840193909201916001016140c8565b90602080835192838152019201905f5b8181106141085750505090565b825160ff168452602093840193909201916001016140fb565b60078303612f8e575f6101a052805f52600160205260405f20545f525f60205260405f2080546101605260ff6101605160d01c1615614f985761ffff6101605160a01c165f52600260205264ffffffffff60405f205460201c16610120526001600160a01b03600d5416803b156122dd575f80916004604051809481937fb3a364580000000000000000000000000000000000000000000000000000000083525af180156122d257614f83575b5063ffffffff6101605160b01c166101a05152600860205260406101a051206cff00000000000000000000000019815416905560ff60d01b1981541681556101205115614d8357506101a08051606060c0819052610180819052610120518252600860205291516040902054919490939185908190819060681c64ffffffffff16421015614457575b937fa0da6e411f3c8e3036b990be806f22429fb3fca5c80e18403e2d8308da13c79d959361431264ffffffffff94614304614346956142f660209a6101a051508d5f1461444a576142e8600a9f5b6101a06040519e8f9e8f90815201526142da8d6142c86101a0820160c05161407b565b9060408183039101526101805161407b565b8d810360608f0152906140b8565b908b820360808d01526140b8565b9089820360a08b01526140eb565b9087820360c08901526140eb565b9188151560e087015263ffffffff6101605160b01c1661010087015261012051610120870152858303610140870152613e9e565b9561ffff6101605160a01c166101608401521694856101808301520390a161436b5750565b61438b63ffffffff6101605160b01c1661ffff6101605160a01c166152fb565b610120516101a05152600860205260406101a0512061ffff1981541690556001600160a01b0360045416803b1561443557604051917f13bebb8200000000000000000000000000000000000000000000000000000000835263ffffffff6101605160b01c166004840152602483015260016044830152816064816101a051936101a051905af1801561443c5761441e5750565b6101a05161442b91613c3c565b6101a05161443557565b6101a05180fd5b6040513d6101a051823e3d90fd5b6142e86101a0519f6142a5565b50505094925090925063ffffffff6101605160b01c166101a051526008602052614489600160406101a0512001613c9f565b60c052610120516101a0515260086020526144ac600160406101a0512001613c9f565b610180526144ca60c05151610180515190818082119118021861402b565b6101a051600a5491959193905b865181101561458d5760068311156145735760c084018160031b82810460081483151715614559576145148760ff61451993819535901c1661405d565b613fee565b90549060031b1c1690602882101561453f57600191614538828a613f97565b52016144d7565b634e487b7160e01b6101a05152602160045260246101a051fd5b634e487b7160e01b6101a05152601160045260246101a051fd5b634e487b7160e01b6101a05152603260045260246101a051fd5b5094919250926001600160a01b0360035416926145bc6145ac86613f7f565b6040516101e0526101e051613c3c565b6101e0805186905251602001600586901b8201813682116144355783905b828210614d7357505050602060c0515111614d45576020610180515111614d175760066101e0515110614ce9576101e0515115614573575160c05161461f9190615430565b506101e05151600310156145735761464160806101e051015161018051615430565b5060c05151610180515190959061466a9080881115614ce35780975b818082119118021861402b565b6101005261468860c05151610180515190818082119118021861402b565b946146a360c05151610180515190818082119118021861402b565b60e0526101a0516101c0819052610140819052905b87610140511061480c5750610180515160c05151808211156147765750506146f2906146ec610180515160c0515190613eeb565b90613e00565b955b61018051518110156147195780600261471260019361010051613f97565b52016146f4565b506143466020939264ffffffffff926143127fa0da6e411f3c8e3036b990be806f22429fb3fca5c80e18403e2d8308da13c79d9798995b6101c05110159861430460e0516142f66101005197505094985050945050939550614257565b8181999399116147be575b5050506143466020939264ffffffffff926143127fa0da6e411f3c8e3036b990be806f22429fb3fca5c80e18403e2d8308da13c79d979899614750565b6147d4916147cb91613eeb565b6101c051613e00565b6101c0525b60c051518110156147fc578060016147f5819361010051613f97565b52016147d9565b506143468264ffffffffff614781565b67ffffffffffffffff6148246101405160c051613f97565b5116158015614cc1575b156149655767ffffffffffffffff61484b6101405160c051613f97565b511661495c5760ff6101a0515b166148666101405189613f97565b5267ffffffffffffffff6148806101405161018051613f97565b51166149535760ff6101a0515b1661489d6101405160e051613f97565b525b6148ac6101405188613f97565b516148bc6101405160e051613f97565b5110156148f7576148cf6101c0516153cb565b6101c05260016148e56101405161010051613f97565b525b60016101405101610140526146b8565b906149076101405160e051613f97565b516149156101405189613f97565b51101561493e57614925906153cb565b9060026149386101405161010051613f97565b526148e7565b906101a0516149386101405161010051613f97565b60ff600161488d565b60ff6001614858565b6149d2602067ffffffffffffffff6149826101405160c051613f97565b511661499d60ff614996610140518c613f97565b511661539b565b9060405193849283927f6bb0aa38000000000000000000000000000000000000000000000000000000008452600484016153aa565b0381855afa90811561443c576101a05191614c8e575b506149f561ffff9161576a565b16614a28602067ffffffffffffffff614a146101405161018051613f97565b511661499d60ff614996610140518d613f97565b0381865afa90811561443c576101a05191614c5b575b50614a4b61ffff9161576a565b1661010482118015614c50575b614c36576101405160101115614ba2576101e05151600110156145735760406101e0510151610140516101405160041b0460101461014051151715614559576001600160f01b0319906101405160041b1c60f01b166101a051506101e0515160041015614573576101e05160a001516101405160041b1c60f01b6001600160f01b031916926014905b04600181018111614559576101a0515b600182018110614b67575050506014900490600182018211614559576101a0515b600183018110614b245750505061489f565b600190614b51826001600160f01b03198516831c60f01c16614b4b6101405160e051613f97565b51613e00565b614b606101405160e051613f97565b5201614b12565b6001908c614b9b614b90846001600160f01b03198816851c60f01c16614b4b6101405185613f97565b916101405190613f97565b5201614af1565b61014051600f19810111614559576101e0515160021015614573576101e0516060015161014051600f1901600481901b81900460101490151715614559576001600160f01b031990600f19610140510160041b1c60f01b166101a051506101e0515160051015614573576101e05160c0015161014051600f190160041b1c60f01b6001600160f01b03191692601490614ae1565b634e487b7160e01b6101a05152600160045260246101a051fd5b506101048111614a58565b90506020813d8211614c86575b81614c7560209383613c3c565b810103126122dd5751614a4b614a3e565b3d9150614c68565b90506020813d8211614cb9575b81614ca860209383613c3c565b810103126122dd57516149f56149e8565b3d9150614c9b565b5067ffffffffffffffff614cdb6101405161018051613f97565b51161561482e565b8761465d565b7fcd7d38ef000000000000000000000000000000000000000000000000000000006101a0515260046101a051fd5b7f0ee80e93000000000000000000000000000000000000000000000000000000006101a0515260046101a051fd5b7f01a164d4000000000000000000000000000000000000000000000000000000006101a0515260046101a051fd5b81358152602091820191016145da565b60a09193507fe2e4c268dfec6acc7d65736af81e978a3d91773ba4bd1812a44035a863bc15359250614dca63ffffffff6101605160b01c1661ffff61016051851c166152fb565b548060d81c936001600160a01b036040519261ffff61016051861c16845263ffffffff6101605160b01c1660208501521660408301528460608301526080820152a16001600160a01b03600f541690602460206001600160a01b036004541660405192838092630ef7959160e21b825263ffffffff6101605160b01c1660048301525afa90811561443c576101a05191614f64575b5060206001600160a01b03600354169260246040518095819363231b667d60e21b835260048301525afa91821561443c576101a05192614f1a575b5060405163ec01f01960e01b8152601660048201526001600160a01b039190911660248201529015156044820152600160648201526101a0519091602091839160849183915af1801561443c57614eee5750565b6020813d602011614f12575b81614f0760209383613c3c565b810103126122dd5750565b3d9150614efa565b91506020823d602011614f5c575b81614f3560209383613c3c565b810103126144355760846001600160a01b0391614f53602094613dac565b93509150614e9a565b3d9150614f28565b614f7d915060203d602011613775576137678183613c3c565b5f614e5f565b5f614f8d91613c3c565b5f6101a0525f6141ce565b7fbc2206b9000000000000000000000000000000000000000000000000000000005f5260045ffd5b9190918054831015613e7b575f52601860205f208360021c019260031b1690565b6001600160a01b03168015615070576001600160a01b037f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c19930054826001600160a01b03198216177f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c19930055167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e05f80a3565b7f1e4fbdf7000000000000000000000000000000000000000000000000000000005f525f60045260245ffd5b600460406001600160a01b03600d54168151928380927f6d4ce63c0000000000000000000000000000000000000000000000000000000082525afa9081156122d2575f905f9261512c575b5067ffffffffffffffff62ffffff600e5460a01c169116029067ffffffffffffffff8216918203612309576affffffffffffffffffffff9161512891613fab565b1690565b9150506040813d604011615183575b8161514860409383613c3c565b810103126122dd5780519067ffffffffffffffff821682036122dd5760200151906affffffffffffffffffffff821682036122dd575f6150e7565b3d915061513b565b6001600160a01b037f9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300541633036151be57565b7f118cdaa7000000000000000000000000000000000000000000000000000000005f523360045260245ffd5b61ffff6151f682613e8f565b1615159081615208575b501561394257565b61ffff915060206152199101613e8f565b1615155f615200565b91905f83545f1981019081116123095793919092935b8084111561524a575b505050505f1990565b6152606152578583613eeb565b60011c85613e00565b938267ffffffffffffffff6152758787614fc0565b90549060031b1c16145f1461528b575050505090565b8267ffffffffffffffff6152a487879998959697614fc0565b90549060031b1c16105f146152cb57506001810180911161230957905b9391909293615238565b915080156152f3575f198101908111156152c157634e487b7160e01b5f52601160045260245ffd5b839450615241565b90815f52600260205261533663ffffffff821660405f209068ffffffffff0000000082549160201b169068ffffffffff000000001916179055565b805f52600860205261ffff60405f20541661536a575b5f52600860205261ffff8060405f2092161661ffff19825416179055565b805f52600860205261ffff60405f2054165f52600260205260405f2068ffffffffff0000000019815416905561534c565b60ff16602881101561235c5790565b916020613cf092949367ffffffffffffffff60408201961681520190613fe1565b5f1981146123095760010190565b60ff7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005460401c161561540857565b7fd7e6bcf8000000000000000000000000000000000000000000000000000000005f5260045ffd5b9190915f5b8151808210156154b4579061545e61545861545283600195613eeb565b8761405d565b82613e00565b80820361546d575b5001615435565b67ffffffffffffffff6154808286613f97565b5116906154a267ffffffffffffffff6154998588613f97565b51169186613f97565b526154ad8285613f97565b525f615466565b5090925050565b604051906154cb61026083613c3c565b61023082527edc026f00ebcc8500fcb8b7010edbd500000000000000000000000000000000610240837854000000ae0000010e00000176000001e60000025e000002de60208201527d0368000003fd0000049b00000546000005fc000006c0000007920000087360408201527d096400000a6600000b7b00000ca400000de100000f36000010a20000122960608201527d13cb0000158b0000176b0000196e00001b9400001de20000205a000022ff60808201527d25d5000028dd00002c1e00002f99000033540000375200003b9a0000403060a08201527d451900004a5c00004fff0000560900005c810000637000006add000072d160c08201527d7b570000847900008e42000098be0000a3f90000b0020000bce70000cab860e08201527dd9860000e9630000fa6200010c990001201d0001350600014b6f000163736101008201527e017d2e000198c10001b64e0001d5f80001f7e600021c430002433b00026cfd6101208201527e0299be0002c9b30002fd180003342b00036f320003ae730003f23d00043ae36101408201527e0488be0004dc2f0005359b000595700005fc2400066a360006e02d00075e996101608201527e07e6160008774c000912eb0009b9b4000a6c74000b2c06000bf956000cd5616101808201527e0dc134000ebdf3000fccd40010ef2400122648001373bf0014d9230016582c6101a08201527e17f2b00019aaa9001b8234001d7b95001f99390021ddbc00244be60026e6b66101c08201527e29b15f002caf51002fe43a0033540d00370303003af5a4003f30cc0043b9b06101e08201527e4895e3004dcb600053609100595c53005fc6030066a585006e034d0075e86c6102008201527e7e5e980087703b0091287d009b935300a6bd8f00b2b4ee00bf882800cd47056102208201520152565b5f906157746154bb565b5160021c5b808310615795575050801561578f5761ffff1690565b50600190565b61579f8184613e00565b600181811c9291901b6003191682156004848304141715612309577fff000000000000000000000000000000000000000000000000000000000000006157ec826157e76154bb565b6158da565b51166157f66154bb565b6001830190818411612309577eff0000000000000000000000000000000000000000000000000000000000009161582c916158da565b5160081c161761583a6154bb565b6002830190818411612309577dff00000000000000000000000000000000000000000000000000000000009161586f916158da565b5160101c161761587d6154bb565b9160038101809111612309576158b27cff000000000000000000000000000000000000000000000000000000009187946158da565b5160181c161760e01c11156158c75750615779565b9250600181018091116123095791615779565b908151811015613e7b570160200190565b90615928575080511561590057805190602001fd5b7fd6bda275000000000000000000000000000000000000000000000000000000005f5260045ffd5b8151158061596e575b615939575090565b6001600160a01b03907f9996b315000000000000000000000000000000000000000000000000000000005f521660045260245ffd5b50803b1561593156fea2646970667358221220f3bdfc3b2ffa56cbce3a8c50f8e2c4c585b2c2592a03c52b9339dadef3f6be8364736f6c634300081c0033