Comparer le texte

Encuentra la diferencia entre dos archivos de texto

Real-time diff

Unified diff

Collapse lines

Highlight change

Syntax highlighting

Outils

Comparing sensitive data, confidential files or internal emails?

Most legal and privacy policies prohibit uploading sensitive data online. Diffchecker Desktop ensures your confidential information never leaves your computer. Work offline and compare documents securely.

Download Diffchecker Desktop Learn more

Magic Dragon Dao Update

Created 2 years agoDiff never expires

42 removals

666 lines

31 additions

652 lines

// SPDX-License-Identifier: MIT

pragma solidity ^0.8.10;

import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";

import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";

import "@openzeppelin/contracts-upgradeable/token/ERC1155/IERC1155Upgradeable.sol";

import "@openzeppelin/contracts-upgradeable/token/ERC1155/utils/ERC1155HolderUpgradeable.sol";

import "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol";

import "@openzeppelin/contracts-upgradeable/token/ERC721/utils/ERC721HolderUpgradeable.sol";

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";

import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";

import "@openzeppelin/contracts-upgradeable/utils/math/SafeCastUpgradeable.sol";

import "@openzeppelin/contracts-upgradeable/utils/structs/EnumerableSetUpgradeable.sol";

import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";

import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";

import "treasure-staking/contracts/AtlasMine.sol";

import "./interfaces/IAtlasMineStaker.sol";

/**

* @title AtlasMineStaker

* @author kvk0x

* Dragon of the Magic Dragon DAO - A Tempting Offer.

* Staking pool contract for the Bridgeworld Atlas Mine.

* Wraps existing staking with a defined 'lock time' per contract.

* Better than solo staking since a designated 'hoard' can also

* deposit Treasures and Legions for staking boosts. Anyone can

* enjoy the power of the guild's hoard and maximize their

* Atlas Mine yield.

contract AtlasMineStakerUpgradeable is

IAtlasMineStaker,

Initializable,

OwnableUpgradeable,

ERC1155HolderUpgradeable,

ERC721HolderUpgradeable,

ReentrancyGuardUpgradeable

{

using SafeERC20Upgradeable for IERC20Upgradeable;

using AddressUpgradeable for address;

using SafeCastUpgradeable for uint256;

using SafeCastUpgradeable for int256;

using EnumerableSetUpgradeable for EnumerableSetUpgradeable.UintSet;

// ============================================ STATE ==============================================

// ============= Global Immutable State ==============

/// @notice MAGIC token

/// @dev functionally immutable

IERC20Upgradeable public magic;

/// @notice The AtlasMine

/// @dev functionally immutable

AtlasMine public mine;

/// @notice The defined lock cycle for the contract

/// @dev functionally immutable

AtlasMine.Lock public lock;

/// @notice The defined lock time for the contract

/// @dev functionally immutable

uint256 public locktime;

// ============= Global Staking State ==============

uint256 public constant ONE = 1e30;

/// @notice Whether new stakes will get staked on the contract as scheduled. For emergencies

bool public schedulePaused;

/// @notice Deposited, but unstaked tokens, keyed by the day number since epoch

/// @notice DEPRECATED ON UPGRADE

mapping(uint256 => uint256) public pendingStakes;

/// @notice Last time pending stakes were deposited

uint256 public lastStakeTimestamp;

/// @notice The minimum amount of time between atlas mine stakes

uint256 public minimumStakingWait;

/// @notice The total amount of staked token

uint256 public totalStaked;

/// @notice All stakes currently active

Stake[] public stakes;

/// @notice Deposit ID of last stake. Also tracked in atlas mine

uint256 public lastDepositId;

/// @notice Total MAGIC rewards earned by staking.

uint256 public override totalRewardsEarned;

/// @notice Rewards accumulated per share

uint256 public accRewardsPerShare;

// ============= User Staking State ==============

/// @notice Each user stake, keyed by user address => deposit ID

mapping(address => mapping(uint256 => UserStake)) public userStake;

/// @notice All deposit IDs for a user, enumerated

mapping(address => EnumerableSetUpgradeable.UintSet) private allUserDepositIds;

/// @notice The current ID of the user's last deposited stake

mapping(address => uint256) public currentId;

// ============= NFT Boosting State ==============

/// @notice Holder of treasures and legions

mapping(address => bool) private hoards;

/// @notice Legions staked by hoard users

mapping(uint256 => address) public legionsStaked;

/// @notice Treasures staked by hoard users

mapping(uint256 => mapping(address => uint256)) public treasuresStaked;

// ============= Operator State ==============

/// @notice Fee to contract operator. Only assessed on rewards.

uint256 public fee;

/// @notice Amount of fees reserved for withdrawal by the operator.

uint256 public feeReserve;

/// @notice Max fee the owner can ever take - 30%

uint256 public constant MAX_FEE = 30_00;

uint256 public constant FEE_DENOMINATOR = 10_000;

// ===========================================

// ============== Post Upgrade ===============

// ===========================================

/// @notice deposited but unstaked

uint256 public unstakedDeposits;

/// @notice Intra-tx buffer for pending payouts

uint256 public tokenBuffer;

/// @notice Whether the deposit accounting reset has been called (upgrade #2)

bool private _resetCalled;

/// @notice The next stake index with an active deposit

uint256 public nextActiveStake;

/// @notice The defined accrual windows in terms of UTC hours.

/// Must be an even-length array of increasing order

uint256[] public accrualWindows;

// ========================================== INITIALIZER ===========================================

/**

* @dev Prevents malicious initializations of base implementation by

* setting contract to initialized on deployment.

/// @custom:oz-upgrades-unsafe-allow constructor

constructor() initializer {}

/**

* @param _magic The MAGIC token address.

* @param _mine The AtlasMine contract.

* @param _lock The locking strategy of the staking pool.

* Maps to a timelock for AtlasMine deposits.

function initialize(

IERC20Upgradeable _magic,

AtlasMine _mine,

AtlasMine.Lock _lock

) external initializer {

require(address(_magic) != address(0), "Invalid magic token address");

require(address(_mine) != address(0), "Invalid mine contract address");

__ERC1155Holder_init();

__ERC721Holder_init();

__Ownable_init();

__ReentrancyGuard_init();

magic = _magic;

mine = _mine;

/// @notice each staker cycles its locks for a predefined amount. New

/// lock cycle, new contract.

lock = _lock;

(, uint256 _locktime) = mine.getLockBoost(lock);

locktime = _locktime;

lastStakeTimestamp = block.timestamp;

minimumStakingWait = 12 hours;

// Approve the mine

magic.approve(address(mine), type(uint256).max);

_approveNFTs();

}

// ======================================== USER OPERATIONS ========================================

/**

* @notice Make a new deposit into the Staker. The Staker will collect

* the tokens, to be later staked in atlas mine by the owner,

* according to the stake/unlock schedule.

* @dev Specified amount of token must be approved by the caller.

* @param _amount The amount of tokens to deposit.

function deposit(uint256 _amount) public virtual override nonReentrant {

function deposit(uint256 _amount) public virtual override nonReentrant whenNotAccruing {

require(!schedulePaused, "new staking paused");

require(_amount > 0, "Deposit amount 0");

_updateRewards();

// Add user stake

uint256 newDepositId = ++currentId[msg.sender];

allUserDepositIds[msg.sender].add(newDepositId);

UserStake storage s = userStake[msg.sender][newDepositId];

s.amount = _amount;

s.unlockAt = block.timestamp + locktime + 1 days;

s.rewardDebt = ((_amount * accRewardsPerShare) / ONE).toInt256();

s.rewardDebt = _accumulatedRewards(s.amount);

// Update global accounting

totalStaked += _amount;

unstakedDeposits += _amount;

// Collect tokens

magic.safeTransferFrom(msg.sender, address(this), _amount);

// MAGIC tokens sit in contract. Added to pending stakes

emit UserDeposit(msg.sender, _amount);

}

/**

* @notice Withdraw a deposit from the Staker contract. Calculates

* pro rata share of accumulated MAGIC and distributes any

* earned rewards in addition to original deposit.

* There must be enough unlocked tokens to withdraw.

* @param depositId The ID of the deposit to withdraw from.

* @param _amount The amount to withdraw.

function withdraw(uint256 depositId, uint256 _amount) public virtual override nonReentrant {

function withdraw(uint256 depositId, uint256 _amount) public virtual override whenNotAccruing {

UserStake storage s = userStake[msg.sender][depositId];

require(s.amount > 0, "No deposit");

require(block.timestamp >= s.unlockAt, "Deposit locked");

// Distribute tokens

_updateRewards();

magic.safeTransfer(msg.sender, _withdraw(s, depositId, _amount));

}

/**

* @notice Withdraw all eligible deposits from the staker contract.

* Will skip any deposits not yet unlocked. Will also

* distribute rewards for all stakes via 'withdraw'.

function withdrawAll() public virtual nonReentrant usesBuffer {

function withdrawAll() public virtual nonReentrant whenNotAccruing usesBuffer {

// Distribute tokens

_updateRewards();

uint256[] memory depositIds = allUserDepositIds[msg.sender].values();

for (uint256 i = 0; i < depositIds.length; i++) {

UserStake storage s = userStake[msg.sender][depositIds[i]];

if (s.amount > 0 && s.unlockAt > 0 && s.unlockAt <= block.timestamp) {

tokenBuffer += _withdraw(s, depositIds[i], type(uint256).max);

}

uint256 payout = tokenBuffer;

tokenBuffer = 0;

magic.safeTransfer(msg.sender, payout);

}

/**

* @dev Logic for withdrawing a deposit. Calculates pro rata share of

* accumulated MAGIC and distributes any earned rewards in addition

* to original deposit.

* @dev An _amount argument larger than the total deposit amount will

* withdraw the entire deposit.

* @param s The UserStake struct to withdraw from.

* @param depositId The ID of the deposit to withdraw from (for event).

* @param _amount The amount to withdraw.

function _withdraw(

UserStake storage s,

uint256 depositId,

uint256 _amount

) internal returns (uint256 payout) {

require(_amount > 0, "Withdraw amount 0");

if (_amount > s.amount) {

_amount = s.amount;

}

// Update user accounting

int256 accumulatedRewards = ((s.amount * accRewardsPerShare) / ONE).toInt256();

int256 accumulatedRewards = _accumulatedRewards(s.amount);

uint256 reward;

if (s.rewardDebt < accumulatedRewards) {

reward = (accumulatedRewards - s.rewardDebt).toUint256();

// Reduce by 1 wei to work around off-by-one error in atlas mine

reward = (accumulatedRewards - s.rewardDebt - 1).toUint256();

}

payout = _amount + reward;

s.amount -= _amount;

s.rewardDebt = ((s.amount * accRewardsPerShare) / ONE).toInt256();

s.rewardDebt = _accumulatedRewards(s.amount);

// Update global accounting

totalStaked -= _amount;

// If we need to unstake, unstake until we have enough

uint256 totalUsableMagic = _totalUsableMagic();

if (payout > totalUsableMagic) {

_unstakeToTarget(payout - totalUsableMagic);

}

// Decrement unstakedDeposits based on how much we are withdrawing

// If we are withdrawing more than is currently unstaked, set it to 0

if (_amount >= unstakedDeposits) {

unstakedDeposits = 0;

} else {

unstakedDeposits -= _amount;

}

emit UserWithdraw(msg.sender, depositId, _amount, reward);

}

/**

* @notice Claim rewards, unstaking if necessary. Will fail if there

* are not enough tokens in the contract to claim rewards.

* @dev Reverts if deposit amount is 0, since rewards are auto-harvested

* on withdrawal, there should be no unclaimed rewards on fully

* withdrawn deposits.

* @param depositId The ID of the deposit to claim rewards from.

function claim(uint256 depositId) public virtual override nonReentrant {

// Distribute tokens

_updateRewards();

UserStake storage s = userStake[msg.sender][depositId];

require(s.amount > 0, "No deposit");

magic.safeTransfer(msg.sender, _claim(s, depositId));

}

/**

* @notice Claim all possible rewards from the staker contract.

* Will apply to both locked and unlocked deposits.

function claimAll() public virtual nonReentrant usesBuffer {

// Distribute tokens

_updateRewards();

uint256[] memory depositIds = allUserDepositIds[msg.sender].values();

for (uint256 i = 0; i < depositIds.length; i++) {

UserStake storage s = userStake[msg.sender][depositIds[i]];

if (s.amount > 0) {

tokenBuffer += _claim(s, depositIds[i]);

}

uint256 reward = tokenBuffer;

tokenBuffer = 0;

magic.safeTransfer(msg.sender, reward);

}

/**

* @dev Logic for claiming rewards on a deposit. Calculates pro rata share of

* accumulated MAGIC and distributed any earned rewards in addition

* to original deposit.

* @param s The UserStake struct to claim from.

* @param depositId The ID of the deposit to claim from (for event).

function _claim(UserStake storage s, uint256 depositId) internal returns (uint256 reward) {

// Update accounting

int256 accumulatedRewards = ((s.amount * accRewardsPerShare) / ONE).toInt256();

int256 accumulatedRewards = _accumulatedRewards(s.amount);

if (s.rewardDebt < accumulatedRewards) {

reward = (accumulatedRewards - s.rewardDebt).toUint256();

// Reduce by 1 wei to work around off-by-one error in atlas mine

reward = (accumulatedRewards - s.rewardDebt - 1).toUint256();

}

s.rewardDebt = accumulatedRewards;

// Unstake if we need to to ensure we can withdraw

uint256 totalUsableMagic = _totalUsableMagic();

if (reward > totalUsableMagic) {

_unstakeToTarget(reward - totalUsableMagic);

}

require(reward <= _totalUsableMagic(), "Not enough rewards to claim");

emit UserClaim(msg.sender, depositId, reward);

}

/**

* @notice Works similarly to withdraw, but does not attempt to claim rewards.

* Used in case there is an issue with rewards calculation either here or

* in the Atlas Mine. emergencyUnstakeAllFromMine should be called before this,

* since it does not attempt to unstake.

function withdrawEmergency() public virtual override nonReentrant {

require(schedulePaused, "Not in emergency state");

uint256 totalStake;

uint256[] memory depositIds = allUserDepositIds[msg.sender].values();

for (uint256 i = 0; i < depositIds.length; i++) {

UserStake storage s = userStake[msg.sender][depositIds[i]];

totalStake += s.amount;

s.amount = 0;

}

require(totalStake <= _totalUsableMagic(), "Not enough unstaked");

totalStaked -= totalStake;

magic.safeTransfer(msg.sender, totalStake);

emit UserWithdraw(msg.sender, 0, totalStake, 0);

}

/**

* @notice Stake any pending stakes before the current day. Callable

* by anybody. Any pending stakes will unlock according

* to the time this method is called, and the contract's defined

* lock time.

function stakeScheduled() public virtual override {

require(!schedulePaused, "new staking paused");

require(block.timestamp - lastStakeTimestamp >= minimumStakingWait, "not enough time since last stake");

lastStakeTimestamp = block.timestamp;

uint256 unlockAt = block.timestamp + locktime;

uint256 amountToStake = unstakedDeposits;

unstakedDeposits = 0;

_stakeInMine(amountToStake);

emit MineStake(amountToStake, unlockAt);

}

/**

* @notice Harvest rewards for a subset of deposit IDs, and accrue harvested

* rewards to users. The contract keeps track of the offset to ensure

* that only chunk size needs to be specified and rewards are not redundantly

* harvested during the same accrual period.

* @param depositIds The deposit IDs to harvest rewards from.

function accrue(uint256[] calldata depositIds) public virtual override whenAccruing {

require(depositIds.length != 0, "Must accrue nonzero deposits");

_updateRewards(depositIds);

}

// ======================================= HOARD OPERATIONS ========================================

/**

* @notice Stake a Treasure owned by the hoard into the Atlas Mine.

* Staked treasures will boost all user deposits.

* @dev Any treasure must be approved for withdrawal by the caller.

* @param _tokenId The tokenId of the specified treasure.

* @param _amount The amount of treasures to stake.

function stakeTreasure(uint256 _tokenId, uint256 _amount) external override onlyHoard {

address treasureAddr = mine.treasure();

require(IERC1155Upgradeable(treasureAddr).balanceOf(msg.sender, _tokenId) >= _amount, "Not enough treasures");

treasuresStaked[_tokenId][msg.sender] += _amount;

// First withdraw and approve

IERC1155Upgradeable(treasureAddr).safeTransferFrom(msg.sender, address(this), _tokenId, _amount, bytes(""));

mine.stakeTreasure(_tokenId, _amount);

uint256 boost = mine.boosts(address(this));

emit StakeNFT(msg.sender, treasureAddr, _tokenId, _amount, boost);

}

/**

* @notice Unstake a Treasure from the Atlas Mine and return it to the hoard.

* @param _tokenId The tokenId of the specified treasure.

* @param _amount The amount of treasures to stake.

function unstakeTreasure(uint256 _tokenId, uint256 _amount) external override onlyHoard {

require(treasuresStaked[_tokenId][msg.sender] >= _amount, "Not enough treasures");

treasuresStaked[_tokenId][msg.sender] -= _amount;

address treasureAddr = mine.treasure();

mine.unstakeTreasure(_tokenId, _amount);

uint256 boost = mine.boosts(address(this));

// Distribute to hoard

IERC1155Upgradeable(treasureAddr).safeTransferFrom(address(this), msg.sender, _tokenId, _amount, bytes(""));

emit UnstakeNFT(msg.sender, treasureAddr, _tokenId, _amount, boost);

}

/**

* @notice Stake a Legion owned by the hoard into the Atlas Mine.

* Staked legions will boost all user deposits.

* @dev Any legion be approved for withdrawal by the caller.

* @param _tokenId The tokenId of the specified legion.

function stakeLegion(uint256 _tokenId) external override onlyHoard {

address legionAddr = mine.legion();

require(IERC721Upgradeable(legionAddr).ownerOf(_tokenId) == msg.sender, "Not owner of legion");

legionsStaked[_tokenId] = msg.sender;

IERC721Upgradeable(legionAddr).safeTransferFrom(msg.sender, address(this), _tokenId);

mine.stakeLegion(_tokenId);

uint256 boost = mine.boosts(address(this));

emit StakeNFT(msg.sender, legionAddr, _tokenId, 1, boost);

}

/**

* @notice Unstake a Legion from the Atlas Mine and return it to the hoard.

* @param _tokenId The tokenId of the specified legion.

function unstakeLegion(uint256 _tokenId) external override onlyHoard {

require(legionsStaked[_tokenId] == msg.sender, "Not staker of legion");

address legionAddr = mine.legion();

delete legionsStaked[_tokenId];

mine.unstakeLegion(_tokenId);

uint256 boost = mine.boosts(address(this));

// Distribute to hoard

IERC721Upgradeable(legionAddr).safeTransferFrom(address(this), msg.sender, _tokenId);

emit UnstakeNFT(msg.sender, legionAddr, _tokenId, 1, boost);

}

// ======================================= OWNER OPERATIONS =======================================

/**

* @notice Unstake everything eligible for unstaking from Atlas Mine.

* Callable by owner. Should only be used in case of emergency

* or migration to a new contract, or if there is a need to service

* an unexpectedly large amount of withdrawals.

* If unlockAll is set to true in the Atlas Mine, this can withdraw

* all stake.

function unstakeAllFromMine() external override onlyOwner {

// Unstake everything eligible

_updateRewards();

uint256 totalStakes = stakes.length;

for (uint256 i = nextActiveStake; i < totalStakes; i++) {

Stake memory s = stakes[i];

if (s.unlockAt > block.timestamp) {

// This stake is not unlocked - stop looking

break;

}

// Withdraw position - auto-harvest

mine.withdrawPosition(s.depositId, s.amount);

}

// Only check for removal after, so we don't mutate while looping

_removeZeroStakes();

}

/**

* @notice Let owner unstake a specified amount as needed to make sure the contract is funded.

* Can be used to facilitate expected future withdrawals.

* @param target The amount of tokens to reclaim from the mine.

function unstakeToTarget(uint256 target) external override onlyOwner {

_updateRewards();

_unstakeToTarget(target);

}

/**

* @notice Works similarly to unstakeAllFromMine, but does not harvest

* rewards. Used for getting out original stake emergencies.

* Requires emergency flag - schedulePaused to be set. Does NOT

* take a fee on rewards.

* Requires that everything gets withdrawn to make sure it is only

* used in emergency. If not the case, reverts.

function emergencyUnstakeAllFromMine() external override onlyOwner {

require(schedulePaused, "Not in emergency state");

// Unstake everything eligible

mine.withdrawAll();

_removeZeroStakes();

}

/**

* @notice Change the fee taken by the operator. Can never be more than

* MAX_FEE. Fees only assessed on rewards.

* @param _fee The fee, expressed in bps.

function setFee(uint256 _fee) external override onlyOwner {

require(_fee <= MAX_FEE, "Invalid fee");

fee = _fee;

emit SetFee(fee);

}

/**

* @notice Change the designated hoard, the address where treasures and

* legions are held. Staked NFTs can only be

* withdrawn to the current hoard address, regardless of which

* address the hoard was set to when it was staked.

* @param _hoard The new hoard address.

* @param isSet Whether to enable or disable the hoard address.

function setHoard(address _hoard, bool isSet) external override onlyOwner {

require(_hoard != address(0), "Invalid hoard");

hoards[_hoard] = isSet;

}

/**

* @notice Approve treasures and legions for withdrawal from the atlas mine.

* Called on startup, and should be called again in case contract

* addresses for treasures and legions ever change.

function approveNFTs() public override onlyOwner {

_approveNFTs();

}

/**

* @notice Revokes approvals for the Atlas Mine. Should only be used

* in case of emergency, blocking further staking, or an Atlas

* Mine exploit.

function revokeNFTApprovals() public override onlyOwner {

address treasureAddr = mine.treasure();

IERC1155Upgradeable(treasureAddr).setApprovalForAll(address(mine), false);

address legionAddr = mine.legion();

IERC721Upgradeable(legionAddr).setApprovalForAll(address(mine), false);

}

/**

* @notice Withdraw any accumulated reward fees to the contract owner.

function withdrawFees() external virtual override onlyOwner {

uint256 amount = feeReserve;

feeReserve = 0;

magic.safeTransfer(msg.sender, amount);

}

/**

* @notice Set the minimum amount of time needed to wait between stakes.

* Default 12 hours. Can be adjusted to be longer (if incremental

* Default 12 hours. Ca

* stakes are too small or we are staking too often) or shorter

* if too much unstaked deposit is building up.

* @param wait The minimum amount of time to wait in between stakes.

function setMinimumStakingWait(uint256 wait) external override onlyOwner {

require(wait >= 3 hours, "Minimum interval 3 hours");

minimumStakingWait = wait;

emit SetMinimumStakingWait(wait);

}

/**

* @notice EMERGENCY ONLY - toggl

Les différences enregistrées

Texte d'origine

Open file

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

import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC1155/IERC1155Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC1155/utils/ERC1155HolderUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC721/utils/ERC721HolderUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/math/SafeCastUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/structs/EnumerableSetUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";

import "treasure-staking/contracts/AtlasMine.sol";
import "./interfaces/IAtlasMineStaker.sol";

/**
 * @title AtlasMineStaker
 * @author kvk0x
 *
 * Dragon of the Magic Dragon DAO - A Tempting Offer.
 *
 * Staking pool contract for the Bridgeworld Atlas Mine.
 * Wraps existing staking with a defined 'lock time' per contract.
 *
 * Better than solo staking since a designated 'hoard' can also
 * deposit Treasures and Legions for staking boosts. Anyone can
 * enjoy the power of the guild's hoard and maximize their
 * Atlas Mine yield.
 *
 */
contract AtlasMineStakerUpgradeable is
    IAtlasMineStaker,
    Initializable,
    OwnableUpgradeable,
    ERC1155HolderUpgradeable,
    ERC721HolderUpgradeable,
    ReentrancyGuardUpgradeable
{
    using SafeERC20Upgradeable for IERC20Upgradeable;
    using AddressUpgradeable for address;
    using SafeCastUpgradeable for uint256;
    using SafeCastUpgradeable for int256;
    using EnumerableSetUpgradeable for EnumerableSetUpgradeable.UintSet;

// ============================================ STATE ==============================================

// ============= Global Immutable State ==============

/// @notice MAGIC token
    /// @dev functionally immutable
    IERC20Upgradeable public magic;
    /// @notice The AtlasMine
    /// @dev functionally immutable
    AtlasMine public mine;
    /// @notice The defined lock cycle for the contract
    /// @dev functionally immutable
    AtlasMine.Lock public lock;
    /// @notice The defined lock time for the contract
    /// @dev functionally immutable
    uint256 public locktime;

// ============= Global Staking State ==============

uint256 public constant ONE = 1e30;

/// @notice Whether new stakes will get staked on the contract as scheduled. For emergencies
    bool public schedulePaused;
    /// @notice Deposited, but unstaked tokens, keyed by the day number since epoch
    /// @notice DEPRECATED ON UPGRADE
    mapping(uint256 => uint256) public pendingStakes;
    /// @notice Last time pending stakes were deposited
    uint256 public lastStakeTimestamp;
    /// @notice The minimum amount of time between atlas mine stakes
    uint256 public minimumStakingWait;
    /// @notice The total amount of staked token
    uint256 public totalStaked;
    /// @notice All stakes currently active
    Stake[] public stakes;
    /// @notice Deposit ID of last stake. Also tracked in atlas mine
    uint256 public lastDepositId;
    /// @notice Total MAGIC rewards earned by staking.
    uint256 public override totalRewardsEarned;
    /// @notice Rewards accumulated per share
    uint256 public accRewardsPerShare;

// ============= User Staking State ==============

/// @notice Each user stake, keyed by user address => deposit ID
    mapping(address => mapping(uint256 => UserStake)) public userStake;
    /// @notice All deposit IDs for a user, enumerated
    mapping(address => EnumerableSetUpgradeable.UintSet) private allUserDepositIds;
    /// @notice The current ID of the user's last deposited stake
    mapping(address => uint256) public currentId;

// ============= NFT Boosting State ==============

/// @notice Holder of treasures and legions
    mapping(address => bool) private hoards;
    /// @notice Legions staked by hoard users
    mapping(uint256 => address) public legionsStaked;
    /// @notice Treasures staked by hoard users
    mapping(uint256 => mapping(address => uint256)) public treasuresStaked;

// ============= Operator State ==============

/// @notice Fee to contract operator. Only assessed on rewards.
    uint256 public fee;
    /// @notice Amount of fees reserved for withdrawal by the operator.
    uint256 public feeReserve;
    /// @notice Max fee the owner can ever take - 30%
    uint256 public constant MAX_FEE = 30_00;

uint256 public constant FEE_DENOMINATOR = 10_000;

// ===========================================
    // ============== Post Upgrade ===============
    // ===========================================

// ========================================== INITIALIZER ===========================================

/**
     * @dev Prevents malicious initializations of base implementation by
     *      setting contract to initialized on deployment.
     */
    /// @custom:oz-upgrades-unsafe-allow constructor
    constructor() initializer {}

/**
     * @param _magic                The MAGIC token address.
     * @param _mine                 The AtlasMine contract.
     * @param _lock                 The locking strategy of the staking pool.
     *                              Maps to a timelock for AtlasMine deposits.
     */
    function initialize(
        IERC20Upgradeable _magic,
        AtlasMine _mine,
        AtlasMine.Lock _lock
    ) external initializer {
        require(address(_magic) != address(0), "Invalid magic token address");
        require(address(_mine) != address(0), "Invalid mine contract address");

__ERC1155Holder_init();
        __ERC721Holder_init();
        __Ownable_init();
        __ReentrancyGuard_init();

magic = _magic;
        mine = _mine;

/// @notice each staker cycles its locks for a predefined amount. New
        ///         lock cycle, new contract.
        lock = _lock;
        (, uint256 _locktime) = mine.getLockBoost(lock);
        locktime = _locktime;

lastStakeTimestamp = block.timestamp;
        minimumStakingWait = 12 hours;

// Approve the mine
        magic.approve(address(mine), type(uint256).max);
        _approveNFTs();
    }

// ======================================== USER OPERATIONS ========================================

/**
     * @notice Make a new deposit into the Staker. The Staker will collect
     *         the tokens, to be later staked in atlas mine by the owner,
     *         according to the stake/unlock schedule.
     * @dev    Specified amount of token must be approved by the caller.
     *
     * @param _amount               The amount of tokens to deposit.
     */
    function deposit(uint256 _amount) public virtual override nonReentrant {
        require(!schedulePaused, "new staking paused");
        require(_amount > 0, "Deposit amount 0");

_updateRewards();

// Add user stake
        uint256 newDepositId = ++currentId[msg.sender];
        allUserDepositIds[msg.sender].add(newDepositId);
        UserStake storage s = userStake[msg.sender][newDepositId];

s.amount = _amount;
        s.unlockAt = block.timestamp + locktime + 1 days;
        s.rewardDebt = ((_amount * accRewardsPerShare) / ONE).toInt256();

// Update global accounting
        totalStaked += _amount;
        unstakedDeposits += _amount;

// Collect tokens
        magic.safeTransferFrom(msg.sender, address(this), _amount);

// MAGIC tokens sit in contract. Added to pending stakes
        emit UserDeposit(msg.sender, _amount);
    }

/**
     * @notice Withdraw a deposit from the Staker contract. Calculates
     *         pro rata share of accumulated MAGIC and distributes any
     *         earned rewards in addition to original deposit.
     *         There must be enough unlocked tokens to withdraw.
     *
     * @param depositId             The ID of the deposit to withdraw from.
     * @param _amount               The amount to withdraw.
     *
     */
    function withdraw(uint256 depositId, uint256 _amount) public virtual override nonReentrant {
        UserStake storage s = userStake[msg.sender][depositId];
        require(s.amount > 0, "No deposit");
        require(block.timestamp >= s.unlockAt, "Deposit locked");

// Distribute tokens
        _updateRewards();

magic.safeTransfer(msg.sender, _withdraw(s, depositId, _amount));
    }

uint256[] memory depositIds = allUserDepositIds[msg.sender].values();
        for (uint256 i = 0; i < depositIds.length; i++) {
            UserStake storage s = userStake[msg.sender][depositIds[i]];

if (s.amount > 0 && s.unlockAt > 0 && s.unlockAt <= block.timestamp) {
                tokenBuffer += _withdraw(s, depositIds[i], type(uint256).max);
            }
        }

uint256 payout = tokenBuffer;
        tokenBuffer = 0;
        magic.safeTransfer(msg.sender, payout);
    }

/**
     * @dev Logic for withdrawing a deposit. Calculates pro rata share of
     *      accumulated MAGIC and distributes any earned rewards in addition
     *      to original deposit.
     *
     * @dev An _amount argument larger than the total deposit amount will
     *      withdraw the entire deposit.
     *
     * @param s                     The UserStake struct to withdraw from.
     * @param depositId             The ID of the deposit to withdraw from (for event).
     * @param _amount               The amount to withdraw.
     */
    function _withdraw(
        UserStake storage s,
        uint256 depositId,
        uint256 _amount
    ) internal returns (uint256 payout) {
        require(_amount > 0, "Withdraw amount 0");

if (_amount > s.amount) {
            _amount = s.amount;
        }

// Update user accounting
        int256 accumulatedRewards = ((s.amount * accRewardsPerShare) / ONE).toInt256();
        uint256 reward;

if (s.rewardDebt < accumulatedRewards) {
            reward = (accumulatedRewards - s.rewardDebt).toUint256();
        }

payout = _amount + reward;

s.amount -= _amount;
        s.rewardDebt = ((s.amount * accRewardsPerShare) / ONE).toInt256();

// Update global accounting
        totalStaked -= _amount;

// If we need to unstake, unstake until we have enough
        uint256 totalUsableMagic = _totalUsableMagic();
        if (payout > totalUsableMagic) {
            _unstakeToTarget(payout - totalUsableMagic);
        }

// Decrement unstakedDeposits based on how much we are withdrawing
        // If we are withdrawing more than is currently unstaked, set it to 0
        if (_amount >= unstakedDeposits) {
            unstakedDeposits = 0;
        } else {
            unstakedDeposits -= _amount;
        }

emit UserWithdraw(msg.sender, depositId, _amount, reward);
    }

/**
     * @notice Claim rewards, unstaking if necessary. Will fail if there
     *         are not enough tokens in the contract to claim rewards.
     * @dev    Reverts if deposit amount is 0, since rewards are auto-harvested
     *         on withdrawal, there should be no unclaimed rewards on fully
     *         withdrawn deposits.
     *
     * @param depositId             The ID of the deposit to claim rewards from.
     *
     */
    function claim(uint256 depositId) public virtual override nonReentrant {
        // Distribute tokens
        _updateRewards();

UserStake storage s = userStake[msg.sender][depositId];

require(s.amount > 0, "No deposit");

magic.safeTransfer(msg.sender, _claim(s, depositId));
    }

uint256[] memory depositIds = allUserDepositIds[msg.sender].values();
        for (uint256 i = 0; i < depositIds.length; i++) {
            UserStake storage s = userStake[msg.sender][depositIds[i]];

if (s.amount > 0) {
                tokenBuffer += _claim(s, depositIds[i]);
            }
        }

uint256 reward = tokenBuffer;
        tokenBuffer = 0;
        magic.safeTransfer(msg.sender, reward);
    }

/**
     * @dev Logic for claiming rewards on a deposit. Calculates pro rata share of
     *      accumulated MAGIC and distributed any earned rewards in addition
     *      to original deposit.
     *
     * @param s                     The UserStake struct to claim from.
     * @param depositId             The ID of the deposit to claim from (for event).
     */
    function _claim(UserStake storage s, uint256 depositId) internal returns (uint256 reward) {
        // Update accounting
        int256 accumulatedRewards = ((s.amount * accRewardsPerShare) / ONE).toInt256();

if (s.rewardDebt < accumulatedRewards) {
            reward = (accumulatedRewards - s.rewardDebt).toUint256();
        }

s.rewardDebt = accumulatedRewards;

// Unstake if we need to to ensure we can withdraw
        uint256 totalUsableMagic = _totalUsableMagic();
        if (reward > totalUsableMagic) {
            _unstakeToTarget(reward - totalUsableMagic);
        }

require(reward <= _totalUsableMagic(), "Not enough rewards to claim");

emit UserClaim(msg.sender, depositId, reward);
    }

/**
     * @notice Works similarly to withdraw, but does not attempt to claim rewards.
     *         Used in case there is an issue with rewards calculation either here or
     *         in the Atlas Mine. emergencyUnstakeAllFromMine should be called before this,
     *         since it does not attempt to unstake.
     *
     */
    function withdrawEmergency() public virtual override nonReentrant {
        require(schedulePaused, "Not in emergency state");

uint256 totalStake;

uint256[] memory depositIds = allUserDepositIds[msg.sender].values();
        for (uint256 i = 0; i < depositIds.length; i++) {
            UserStake storage s = userStake[msg.sender][depositIds[i]];

totalStake += s.amount;
            s.amount = 0;
        }

require(totalStake <= _totalUsableMagic(), "Not enough unstaked");

totalStaked -= totalStake;

magic.safeTransfer(msg.sender, totalStake);

emit UserWithdraw(msg.sender, 0, totalStake, 0);
    }

/**
     * @notice Stake any pending stakes before the current day. Callable
     *         by anybody. Any pending stakes will unlock according
     *         to the time this method is called, and the contract's defined
     *         lock time.
     */
    function stakeScheduled() public virtual override {
        require(!schedulePaused, "new staking paused");
        require(block.timestamp - lastStakeTimestamp >= minimumStakingWait, "not enough time since last stake");

lastStakeTimestamp = block.timestamp;

uint256 unlockAt = block.timestamp + locktime;

uint256 amountToStake = unstakedDeposits;
        unstakedDeposits = 0;

_stakeInMine(amountToStake);
        emit MineStake(amountToStake, unlockAt);
    }

// ======================================= HOARD OPERATIONS ========================================

/**
     * @notice Stake a Treasure owned by the hoard into the Atlas Mine.
     *         Staked treasures will boost all user deposits.
     * @dev    Any treasure must be approved for withdrawal by the caller.
     *
     * @param _tokenId              The tokenId of the specified treasure.
     * @param _amount               The amount of treasures to stake.
     */
    function stakeTreasure(uint256 _tokenId, uint256 _amount) external override onlyHoard {
        address treasureAddr = mine.treasure();
        require(IERC1155Upgradeable(treasureAddr).balanceOf(msg.sender, _tokenId) >= _amount, "Not enough treasures");

treasuresStaked[_tokenId][msg.sender] += _amount;

// First withdraw and approve
        IERC1155Upgradeable(treasureAddr).safeTransferFrom(msg.sender, address(this), _tokenId, _amount, bytes(""));

mine.stakeTreasure(_tokenId, _amount);
        uint256 boost = mine.boosts(address(this));

emit StakeNFT(msg.sender, treasureAddr, _tokenId, _amount, boost);
    }

/**
     * @notice Unstake a Treasure from the Atlas Mine and return it to the hoard.
     *
     * @param _tokenId              The tokenId of the specified treasure.
     * @param _amount               The amount of treasures to stake.
     */
    function unstakeTreasure(uint256 _tokenId, uint256 _amount) external override onlyHoard {
        require(treasuresStaked[_tokenId][msg.sender] >= _amount, "Not enough treasures");
        treasuresStaked[_tokenId][msg.sender] -= _amount;

address treasureAddr = mine.treasure();

mine.unstakeTreasure(_tokenId, _amount);
        uint256 boost = mine.boosts(address(this));

// Distribute to hoard
        IERC1155Upgradeable(treasureAddr).safeTransferFrom(address(this), msg.sender, _tokenId, _amount, bytes(""));

emit UnstakeNFT(msg.sender, treasureAddr, _tokenId, _amount, boost);
    }

/**
     * @notice Stake a Legion owned by the hoard into the Atlas Mine.
     *         Staked legions will boost all user deposits.
     * @dev    Any legion be approved for withdrawal by the caller.
     *
     * @param _tokenId              The tokenId of the specified legion.
     */
    function stakeLegion(uint256 _tokenId) external override onlyHoard {
        address legionAddr = mine.legion();
        require(IERC721Upgradeable(legionAddr).ownerOf(_tokenId) == msg.sender, "Not owner of legion");

legionsStaked[_tokenId] = msg.sender;

IERC721Upgradeable(legionAddr).safeTransferFrom(msg.sender, address(this), _tokenId);

mine.stakeLegion(_tokenId);

uint256 boost = mine.boosts(address(this));

emit StakeNFT(msg.sender, legionAddr, _tokenId, 1, boost);
    }

/**
     * @notice Unstake a Legion from the Atlas Mine and return it to the hoard.
     *
     * @param _tokenId              The tokenId of the specified legion.
     */
    function unstakeLegion(uint256 _tokenId) external override onlyHoard {
        require(legionsStaked[_tokenId] == msg.sender, "Not staker of legion");
        address legionAddr = mine.legion();

delete legionsStaked[_tokenId];

mine.unstakeLegion(_tokenId);
        uint256 boost = mine.boosts(address(this));

// Distribute to hoard
        IERC721Upgradeable(legionAddr).safeTransferFrom(address(this), msg.sender, _tokenId);

emit UnstakeNFT(msg.sender, legionAddr, _tokenId, 1, boost);
    }

// ======================================= OWNER OPERATIONS =======================================

/**
     * @notice Unstake everything eligible for unstaking from Atlas Mine.
     *         Callable by owner. Should only be used in case of emergency
     *         or migration to a new contract, or if there is a need to service
     *         an unexpectedly large amount of withdrawals.
     *
     *         If unlockAll is set to true in the Atlas Mine, this can withdraw
     *         all stake.
     */
    function unstakeAllFromMine() external override onlyOwner {
        // Unstake everything eligible
        _updateRewards();

uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            Stake memory s = stakes[i];

if (s.unlockAt > block.timestamp) {
                // This stake is not unlocked - stop looking
                break;
            }

// Withdraw position - auto-harvest
            mine.withdrawPosition(s.depositId, s.amount);
        }

// Only check for removal after, so we don't mutate while looping
        _removeZeroStakes();
    }

/**
     * @notice Let owner unstake a specified amount as needed to make sure the contract is funded.
     *         Can be used to facilitate expected future withdrawals.
     *
     * @param target                The amount of tokens to reclaim from the mine.
     */
    function unstakeToTarget(uint256 target) external override onlyOwner {
        _updateRewards();
        _unstakeToTarget(target);
    }

/**
     * @notice Works similarly to unstakeAllFromMine, but does not harvest
     *         rewards. Used for getting out original stake emergencies.
     *         Requires emergency flag - schedulePaused to be set. Does NOT
     *         take a fee on rewards.
     *
     *         Requires that everything gets withdrawn to make sure it is only
     *         used in emergency. If not the case, reverts.
     */
    function emergencyUnstakeAllFromMine() external override onlyOwner {
        require(schedulePaused, "Not in emergency state");

// Unstake everything eligible
        mine.withdrawAll();
        _removeZeroStakes();
    }

/**
     * @notice Change the fee taken by the operator. Can never be more than
     *         MAX_FEE. Fees only assessed on rewards.
     *
     * @param _fee                  The fee, expressed in bps.
     */
    function setFee(uint256 _fee) external override onlyOwner {
        require(_fee <= MAX_FEE, "Invalid fee");

fee = _fee;

emit SetFee(fee);
    }

/**
     * @notice Change the designated hoard, the address where treasures and
     *         legions are held. Staked NFTs can only be
     *         withdrawn to the current hoard address, regardless of which
     *         address the hoard was set to when it was staked.
     *
     * @param _hoard                The new hoard address.
     * @param isSet                 Whether to enable or disable the hoard address.
     */
    function setHoard(address _hoard, bool isSet) external override onlyOwner {
        require(_hoard != address(0), "Invalid hoard");

hoards[_hoard] = isSet;
    }

/**
     * @notice Approve treasures and legions for withdrawal from the atlas mine.
     *         Called on startup, and should be called again in case contract
     *         addresses for treasures and legions ever change.
     *
     */
    function approveNFTs() public override onlyOwner {
        _approveNFTs();
    }

/**
     * @notice Revokes approvals for the Atlas Mine. Should only be used
     *         in case of emergency, blocking further staking, or an Atlas
     *         Mine exploit.
     *
     */
    function revokeNFTApprovals() public override onlyOwner {
        address treasureAddr = mine.treasure();
        IERC1155Upgradeable(treasureAddr).setApprovalForAll(address(mine), false);

address legionAddr = mine.legion();

IERC721Upgradeable(legionAddr).setApprovalForAll(address(mine), false);
    }

/**
     * @notice Withdraw any accumulated reward fees to the contract owner.
     */
    function withdrawFees() external virtual override onlyOwner {
        uint256 amount = feeReserve;
        feeReserve = 0;

magic.safeTransfer(msg.sender, amount);
    }

/**
     * @notice Set the minimum amount of time needed to wait between stakes.
     *         Default 12 hours. Can be adjusted to be longer (if incremental
     *         stakes are too small or we are staking too often) or shorter
     *         if too much unstaked deposit is building up.
     *
     * @param  wait                 The minimum amount of time to wait in between stakes.
     */
    function setMinimumStakingWait(uint256 wait) external override onlyOwner {
        require(wait >= 3 hours, "Minimum interval 3 hours");

minimumStakingWait = wait;

emit SetMinimumStakingWait(wait);
    }

/**
     * @notice EMERGENCY ONLY - toggle pausing new scheduled stakes.
     *         If on, users can deposit, but stakes won't go to Atlas Mine.
     *         Can be used in case of Atlas Mine issues or forced migration
     *         to new contract.
     */
    function toggleSchedulePause(bool paused) external virtual override onlyOwner {
        schedulePaused = paused;

emit StakingPauseToggle(paused);
    }

/**
     * @notice Must be used when migrating to a new contract that changes the accounting
     *         logic of unstaked deposits. Can be used to reset value to one that would
     *         be in place in the cast that newly-introduced logic was always in place.
     *
     * @dev    Cannot be used in normal operation, will only be called once as part of
     *         an "upgradeAndCall" contract upgrade.
     *
     * @param _unstakedDeposits    The new value of unstakedDeposits to set.
     */
    function resetUnstakedAndStake(uint256 _unstakedDeposits) external {
        require(!_resetCalled, "reset already called");
        _resetCalled = true;

unstakedDeposits = _unstakedDeposits;

stakeScheduled();
    }

// ======================================== VIEW FUNCTIONS =========================================

/**
     * @notice Returns all magic either unstaked, staked, or pending rewards in Atlas Mine.
     *         Best proxy for TVL.
     *
     * @return total               The total amount of MAGIC in the staker.
     */
    function totalMagic() external view override returns (uint256) {
        return _totalControlledMagic() + mine.pendingRewardsAll(address(this));
    }

/**
     * @notice Returns all magic that has been deposited, but not staked, and is eligible
     *         to be staked (deposit time < current day).
     *
     * @return total               The total amount of MAGIC available to stake.
     */
    function totalPendingStake() external view override returns (uint256) {
        return unstakedDeposits;
    }

/**
     * @notice Returns all magic that has been deposited, but not staked, and is eligible
     *         to be staked (deposit time < current day).
     *
     * @return total               The total amount of MAGIC that can be withdrawn.
     */
    function totalWithdrawableMagic() external view override returns (uint256) {
        uint256 totalPendingRewards;

// AtlasMine attempts to divide by 0 if there are no deposits
        try mine.pendingRewardsAll(address(this)) returns (uint256 _pending) {
            totalPendingRewards = _pending;
        } catch Panic(uint256) {
            totalPendingRewards = 0;
        }

uint256 vestedPrincipal;
        uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            vestedPrincipal += mine.calcualteVestedPrincipal(address(this), stakes[i].depositId);
        }

return _totalUsableMagic() + totalPendingRewards + vestedPrincipal;
    }

/**
     * @notice Returns the details of a user stake.
     *
     * @return userStake           The details of a user stake.
     */
    function getUserStake(address user, uint256 depositId) external view override returns (UserStake memory) {
        return userStake[user][depositId];
    }

/**
     * @notice Returns the total amount staked by a user.
     *
     * @return totalStake           The total amount of MAGIC staked by a user.
     */
    function userTotalStake(address user) external view override returns (uint256 totalStake) {
        uint256[] memory depositIds = allUserDepositIds[user].values();
        for (uint256 i = 0; i < depositIds.length; i++) {
            UserStake storage s = userStake[user][depositIds[i]];
            totalStake += s.amount;
        }
    }

/**
     * @notice Returns the pending, claimable rewards for a deposit.
     * @dev    This does not update rewards, so out of date if rewards not recently updated.
     *         Needed to maintain 'view' function type.
     *
     * @param user              The user to check rewards for.
     * @param depositId         The specific deposit to check rewards for.
     *
     * @return reward           The total amount of MAGIC reward pending.
     */
    function pendingRewards(address user, uint256 depositId) public view override returns (uint256 reward) {
        UserStake storage s = userStake[user][depositId];

int256 accumulatedRewards = ((s.amount * accRewardsPerShare) / ONE).toInt256();
        reward = (accumulatedRewards - s.rewardDebt).toUint256();
    }

/**
     * @notice Returns the pending, claimable rewards for all of a user's deposits.
     * @dev    This does not update rewards, so out of date if rewards not recently updated.
     *         Needed to maintain 'view' function type.
     *
     * @param user              The user to check rewards for.
     *
     * @return reward           The total amount of MAGIC reward pending.
     */
    function pendingRewardsAll(address user) external view override returns (uint256 reward) {
        uint256[] memory depositIds = allUserDepositIds[user].values();

for (uint256 i = 0; i < depositIds.length; i++) {
            reward += pendingRewards(user, depositIds[i]);
        }
    }

// ============================================ HELPERS ============================================

/**
     * @dev Approve treasures and legions for withdrawal from the atlas mine.
     */
    function _approveNFTs() internal {
        address treasureAddr = mine.treasure();
        IERC1155Upgradeable(treasureAddr).setApprovalForAll(address(mine), true);

address legionAddr = mine.legion();
        IERC721Upgradeable(legionAddr).setApprovalForAll(address(mine), true);
    }

/**
     * @dev Stake tokens held by staker in the Atlas Mine, according to
     *      the predefined lock value. Schedules for staking will be managed by a queue.
     *
     * @param _amount               Number of tokens to stake
     */
    function _stakeInMine(uint256 _amount) internal {
        require(_amount <= _totalUsableMagic(), "Not enough funds");

uint256 depositId = ++lastDepositId;

uint256 unlockAt = block.timestamp + locktime;

stakes.push(Stake({ amount: _amount, unlockAt: unlockAt, depositId: depositId }));

mine.deposit(_amount, lock);
    }

/**
     * @dev Unstakes until we have enough unstaked tokens to meet a specific target.
     *      Used to make sure we can service withdrawals.
     *
     * @param target                The amount of tokens we want to have unstaked.
     */
    function _unstakeToTarget(uint256 target) internal {
        uint256 unstaked = 0;

uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            Stake memory s = stakes[i];

if (s.unlockAt > block.timestamp && !mine.unlockAll()) {
                // This stake is not unlocked - stop looking
                break;
            }

// Withdraw position - auto-harvest
            uint256 preclaimBalance = _totalUsableMagic();
            uint256 targetLeft = target - unstaked;
            uint256 amount = targetLeft > s.amount ? s.amount : targetLeft;

// Do not harvest rewards - if this is running, we've already
            // harvested in the same fn call
            mine.withdrawPosition(s.depositId, amount);
            uint256 postclaimBalance = _totalUsableMagic();

// Increment amount unstaked
            unstaked += postclaimBalance - preclaimBalance;

if (unstaked >= target) {
                // We unstaked enough
                break;
            }
        }

require(unstaked >= target, "Cannot unstake enough");
        require(_totalUsableMagic() >= target, "Not enough in contract after unstaking");

// Only check for removal after, so we don't mutate while looping
        _removeZeroStakes();
    }

/**
     * @dev Harvest rewards from the AtlasMine and send them back to
     *      this contract.
     *
     * @return earned               The amount of rewards earned for depositors, minus the fee.
     * @return feeEearned           The amount of fees earned for the contract operator.
     */
    function _harvestMine() internal returns (uint256, uint256) {
        uint256 preclaimBalance = magic.balanceOf(address(this));

try mine.harvestAll() {
            uint256 postclaimBalance = magic.balanceOf(address(this));

uint256 earned = postclaimBalance - preclaimBalance;

// Reserve the 'fee' amount of what is earned
            uint256 feeEarned = (earned * fee) / FEE_DENOMINATOR;
            feeReserve += feeEarned;

emit MineHarvest(earned - feeEarned, feeEarned);

return (earned - feeEarned, feeEarned);
        } catch {
            // Failed because of reward debt calculation - should be 0
            return (0, 0);
        }
    }

/**
     * @dev Harvest rewards from the mine so that stakers can claim.
     *      Recalculate how many rewards are distributed to each share.
     */
    function _updateRewards() internal {
        if (totalStaked == 0) return;

(uint256 newRewards, ) = _harvestMine();
        totalRewardsEarned += newRewards;

accRewardsPerShare += (newRewards * ONE) / totalStaked;
    }

/**
     * @dev After mutating a stake (by withdrawing fully or partially),
     *      get updated data from the staking contract, and update the stake amounts
     *
     * @param stakeIndex           The index of the stake in the Stakes storage array.
     *
     * @return amount              The current, updated amount of the stake.
     */
    function _updateStakeDepositAmount(uint256 stakeIndex) internal returns (uint256) {
        Stake storage s = stakes[stakeIndex];

(, uint256 depositAmount, , , , , ) = mine.userInfo(address(this), s.depositId);
        s.amount = depositAmount;

return s.amount;
    }

/**
     * @dev Find stakes with zero deposit amount and remove them from tracking.
     *      Starts from the last fully withdrawn stake, and keeps counting until
     *      we find a non-zero stake.
     *
     */
    function _removeZeroStakes() internal {
        uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            _updateStakeDepositAmount(i);

Stake memory s = stakes[i];

if (s.amount != 0) {
                // No more zero stakes - can break
                nextActiveStake = i;
                break;
            }
        }
    }

/**
     * @dev Calculate total amount of MAGIC usable by the contract.
     *      'Usable' means available for either withdrawal or re-staking.
     *      Counts unstaked magic less fee reserve.
     *
     * @return amount               The amount of usable MAGIC.
     */
    function _totalUsableMagic() internal view returns (uint256) {
        // Current magic held in contract
        uint256 unstaked = magic.balanceOf(address(this));

return unstaked - feeReserve - tokenBuffer;
    }

/**
     * @dev Calculate total amount of MAGIC under control of the contract.
     *      Counts staked and unstaked MAGIC. Does _not_ count accumulated
     *      but unclaimed rewards.
     *
     * @return amount               The total amount of MAGIC under control of the contract.
     */
    function _totalControlledMagic() internal view returns (uint256) {
        // Current magic staked in mine
        uint256 staked = 0;

uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            staked += stakes[i].amount;
        }

return staked + _totalUsableMagic();
    }

/**
     * @dev For methods only callable by the hoard - Treasure staking/unstaking.
     */
    modifier onlyHoard() {
        require(hoards[msg.sender], "Not hoard");

_;
    }

/**
     * @dev For methods that access the token buffer - make sure it is cleared.
     */
    modifier usesBuffer() {
        _;

require(tokenBuffer == 0, "Buffer not clear");
    }
}

Texte modifié

Open file

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

import "treasure-staking/contracts/AtlasMine.sol";
import "./interfaces/IAtlasMineStaker.sol";

// ============================================ STATE ==============================================

// ============= Global Immutable State ==============

// ============= Global Staking State ==============

uint256 public constant ONE = 1e30;

// ============= User Staking State ==============

// ============= NFT Boosting State ==============

// ============= Operator State ==============

uint256 public constant FEE_DENOMINATOR = 10_000;

// ===========================================
    // ============== Post Upgrade ===============
    // ===========================================

/// @notice deposited but unstaked
    uint256 public unstakedDeposits;
    /// @notice Intra-tx buffer for pending payouts
    uint256 public tokenBuffer;
    /// @notice Whether the deposit accounting reset has been called (upgrade #2)
    bool private _resetCalled;
    /// @notice The next stake index with an active deposit
    uint256 public nextActiveStake;
    /// @notice The defined accrual windows in terms of UTC hours.
    ///         Must be an even-length array of increasing order
    uint256[] public accrualWindows;

// ========================================== INITIALIZER ===========================================

__ERC1155Holder_init();
        __ERC721Holder_init();
        __Ownable_init();
        __ReentrancyGuard_init();

magic = _magic;
        mine = _mine;

lastStakeTimestamp = block.timestamp;
        minimumStakingWait = 12 hours;

// Approve the mine
        magic.approve(address(mine), type(uint256).max);
        _approveNFTs();
    }

// ======================================== USER OPERATIONS ========================================

/**
     * @notice Make a new deposit into the Staker. The Staker will collect
     *         the tokens, to be later staked in atlas mine by the owner,
     *         according to the stake/unlock schedule.
     * @dev    Specified amount of token must be approved by the caller.
     *
     * @param _amount               The amount of tokens to deposit.
     */
    function deposit(uint256 _amount) public virtual override nonReentrant whenNotAccruing {
        require(!schedulePaused, "new staking paused");
        require(_amount > 0, "Deposit amount 0");

// Add user stake
        uint256 newDepositId = ++currentId[msg.sender];
        allUserDepositIds[msg.sender].add(newDepositId);
        UserStake storage s = userStake[msg.sender][newDepositId];

s.amount = _amount;
        s.unlockAt = block.timestamp + locktime + 1 days;
        s.rewardDebt = _accumulatedRewards(s.amount);

// Update global accounting
        totalStaked += _amount;
        unstakedDeposits += _amount;

// Collect tokens
        magic.safeTransferFrom(msg.sender, address(this), _amount);

// MAGIC tokens sit in contract. Added to pending stakes
        emit UserDeposit(msg.sender, _amount);
    }

/**
     * @notice Withdraw a deposit from the Staker contract. Calculates
     *         pro rata share of accumulated MAGIC and distributes any
     *         earned rewards in addition to original deposit.
     *         There must be enough unlocked tokens to withdraw.
     *
     * @param depositId             The ID of the deposit to withdraw from.
     * @param _amount               The amount to withdraw.
     *
     */
    function withdraw(uint256 depositId, uint256 _amount) public virtual override whenNotAccruing {
        UserStake storage s = userStake[msg.sender][depositId];
        require(s.amount > 0, "No deposit");
        require(block.timestamp >= s.unlockAt, "Deposit locked");

magic.safeTransfer(msg.sender, _withdraw(s, depositId, _amount));
    }

/**
     * @notice Withdraw all eligible deposits from the staker contract.
     *         Will skip any deposits not yet unlocked. Will also
     *         distribute rewards for all stakes via 'withdraw'.
     *
     */
    function withdrawAll() public virtual nonReentrant whenNotAccruing usesBuffer {
        uint256[] memory depositIds = allUserDepositIds[msg.sender].values();
        for (uint256 i = 0; i < depositIds.length; i++) {
            UserStake storage s = userStake[msg.sender][depositIds[i]];

if (s.amount > 0 && s.unlockAt > 0 && s.unlockAt <= block.timestamp) {
                tokenBuffer += _withdraw(s, depositIds[i], type(uint256).max);
            }
        }

uint256 payout = tokenBuffer;
        tokenBuffer = 0;
        magic.safeTransfer(msg.sender, payout);
    }

if (_amount > s.amount) {
            _amount = s.amount;
        }

// Update user accounting
        int256 accumulatedRewards = _accumulatedRewards(s.amount);
        uint256 reward;

if (s.rewardDebt < accumulatedRewards) {
            // Reduce by 1 wei to work around off-by-one error in atlas mine
            reward = (accumulatedRewards - s.rewardDebt - 1).toUint256();
        }

payout = _amount + reward;

s.amount -= _amount;
        s.rewardDebt = _accumulatedRewards(s.amount);

// Update global accounting
        totalStaked -= _amount;

emit UserWithdraw(msg.sender, depositId, _amount, reward);
    }

require(s.amount > 0, "No deposit");

magic.safeTransfer(msg.sender, _claim(s, depositId));
    }

/**
     * @notice Claim all possible rewards from the staker contract.
     *         Will apply to both locked and unlocked deposits.
     *
     */
    function claimAll() public virtual nonReentrant usesBuffer {
        uint256[] memory depositIds = allUserDepositIds[msg.sender].values();
        for (uint256 i = 0; i < depositIds.length; i++) {
            UserStake storage s = userStake[msg.sender][depositIds[i]];

if (s.amount > 0) {
                tokenBuffer += _claim(s, depositIds[i]);
            }
        }

uint256 reward = tokenBuffer;
        tokenBuffer = 0;
        magic.safeTransfer(msg.sender, reward);
    }

s.rewardDebt = accumulatedRewards;

require(reward <= _totalUsableMagic(), "Not enough rewards to claim");

emit UserClaim(msg.sender, depositId, reward);
    }

uint256 totalStake;

uint256[] memory depositIds = allUserDepositIds[msg.sender].values();
        for (uint256 i = 0; i < depositIds.length; i++) {
            UserStake storage s = userStake[msg.sender][depositIds[i]];

totalStake += s.amount;
            s.amount = 0;
        }

require(totalStake <= _totalUsableMagic(), "Not enough unstaked");

totalStaked -= totalStake;

magic.safeTransfer(msg.sender, totalStake);

emit UserWithdraw(msg.sender, 0, totalStake, 0);
    }

lastStakeTimestamp = block.timestamp;

uint256 unlockAt = block.timestamp + locktime;

uint256 amountToStake = unstakedDeposits;
        unstakedDeposits = 0;

_stakeInMine(amountToStake);
        emit MineStake(amountToStake, unlockAt);
    }

/**
     * @notice Harvest rewards for a subset of deposit IDs, and accrue harvested
     *         rewards to users. The contract keeps track of the offset to ensure
     *         that only chunk size needs to be specified and rewards are not redundantly
     *         harvested during the same accrual period.
     *
     * @param depositIds           The deposit IDs to harvest rewards from.
     */
    function accrue(uint256[] calldata depositIds) public virtual override whenAccruing {
        require(depositIds.length != 0, "Must accrue nonzero deposits");

_updateRewards(depositIds);
    }

// ======================================= HOARD OPERATIONS ========================================

treasuresStaked[_tokenId][msg.sender] += _amount;

// First withdraw and approve
        IERC1155Upgradeable(treasureAddr).safeTransferFrom(msg.sender, address(this), _tokenId, _amount, bytes(""));

mine.stakeTreasure(_tokenId, _amount);
        uint256 boost = mine.boosts(address(this));

emit StakeNFT(msg.sender, treasureAddr, _tokenId, _amount, boost);
    }

address treasureAddr = mine.treasure();

mine.unstakeTreasure(_tokenId, _amount);
        uint256 boost = mine.boosts(address(this));

// Distribute to hoard
        IERC1155Upgradeable(treasureAddr).safeTransferFrom(address(this), msg.sender, _tokenId, _amount, bytes(""));

emit UnstakeNFT(msg.sender, treasureAddr, _tokenId, _amount, boost);
    }

legionsStaked[_tokenId] = msg.sender;

IERC721Upgradeable(legionAddr).safeTransferFrom(msg.sender, address(this), _tokenId);

mine.stakeLegion(_tokenId);

uint256 boost = mine.boosts(address(this));

emit StakeNFT(msg.sender, legionAddr, _tokenId, 1, boost);
    }

delete legionsStaked[_tokenId];

mine.unstakeLegion(_tokenId);
        uint256 boost = mine.boosts(address(this));

// Distribute to hoard
        IERC721Upgradeable(legionAddr).safeTransferFrom(address(this), msg.sender, _tokenId);

emit UnstakeNFT(msg.sender, legionAddr, _tokenId, 1, boost);
    }

// ======================================= OWNER OPERATIONS =======================================

/**
     * @notice Unstake everything eligible for unstaking from Atlas Mine.
     *         Callable by owner. Should only be used in case of emergency
     *         or migration to a new contract, or if there is a need to service
     *         an unexpectedly large amount of withdrawals.
     *
     *         If unlockAll is set to true in the Atlas Mine, this can withdraw
     *         all stake.
     */
    function unstakeAllFromMine() external override onlyOwner {
        uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            Stake memory s = stakes[i];

if (s.unlockAt > block.timestamp) {
                // This stake is not unlocked - stop looking
                break;
            }

// Withdraw position - auto-harvest
            mine.withdrawPosition(s.depositId, s.amount);
        }

// Only check for removal after, so we don't mutate while looping
        _removeZeroStakes();
    }

// Unstake everything eligible
        mine.withdrawAll();
        _removeZeroStakes();
    }

fee = _fee;

emit SetFee(fee);
    }

hoards[_hoard] = isSet;
    }

address legionAddr = mine.legion();

IERC721Upgradeable(legionAddr).setApprovalForAll(address(mine), false);
    }

magic.safeTransfer(msg.sender, amount);
    }

minimumStakingWait = wait;

emit SetMinimumStakingWait(wait);
    }

emit StakingPauseToggle(paused);
    }

/**
     * @notice Used to set windows during which accrual happens, and new deposits/withdrawls
     *         are paused.
     *
     * @param windows               The list of hourly windows in pairs of tuples, e.g. [0, 1, 12, 13]
     */
    function setAccrualWindows(uint256[] calldata windows) external override onlyOwner {
        require(windows.length % 2 == 0, "Invalid window length");

for (uint256 i = 0; i < windows.length; i++) {
            // Must be 0-23, and monotonically increasing
            if (i < windows.length - 1) {
                require(windows[i] < 24, "Invalid window value");
            } else {
                // Allow 24 as an ending value
                require(windows[i] < 25, "Invalid window value");
            }

if (i > 0) {
                require(windows[i] > windows[i - 1], "Invalid window ordering");
            }
        }

accrualWindows = windows;

emit SetAccrualWindows(windows);
    }

// ======================================== VIEW FUNCTIONS =========================================

return _totalUsableMagic() + totalPendingRewards + vestedPrincipal;
    }

int256 accumulatedRewards = _accumulatedRewards(s.amount);

// Reduce by 1 wei to work around off-by-one error in atlas mine
        reward = (accumulatedRewards - s.rewardDebt - 1).toUint256();
    }

for (uint256 i = 0; i < depositIds.length; i++) {
            reward += pendingRewards(user, depositIds[i]);
        }
    }

// ============================================ HELPERS ============================================

address legionAddr = mine.legion();
        IERC721Upgradeable(legionAddr).setApprovalForAll(address(mine), true);
    }

uint256 depositId = ++lastDepositId;

uint256 unlockAt = block.timestamp + locktime;

stakes.push(Stake({ amount: _amount, unlockAt: unlockAt, depositId: depositId }));

mine.deposit(_amount, lock);
    }

uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            Stake memory s = stakes[i];

if (s.unlockAt > block.timestamp && !mine.unlockAll()) {
                // This stake is not unlocked - stop looking
                break;
            }

// Increment amount unstaked
            unstaked += postclaimBalance - preclaimBalance;

if (unstaked >= target) {
                // We unstaked enough
                break;
            }
        }

require(unstaked >= target, "Cannot unstake enough");
        require(_totalUsableMagic() >= target, "Not enough in contract after unstaking");

// Only check for removal after, so we don't mutate while looping
        _removeZeroStakes();
    }

/**
     * @dev Harvest rewards from the AtlasMine and send them back to
     *      this contract. Cannot harvest entire set of positions due to
     *      gas limits, so positions need to be specified.
     *
     * @param depositIds            The deposits to harvest rewards for.
     *
     * @return earned               The amount of rewards earned for depositors, minus the fee.
     * @return feeEearned           The amount of fees earned for the contract operator.
     */
    function _harvestMine(uint256[] memory depositIds) internal returns (uint256, uint256) {
        uint256 preclaimBalance = magic.balanceOf(address(this));

for (uint256 i = 0; i < depositIds.length; i++) {
            // Might fail because of reward debt calculation
            try mine.harvestPosition(depositIds[i]) {} catch {
                // SafeCast error
            }
        }

uint256 postclaimBalance = magic.balanceOf(address(this));

uint256 earned = postclaimBalance - preclaimBalance;

// Reserve the 'fee' amount of what is earned
        uint256 feeEarned = (earned * fee) / FEE_DENOMINATOR;
        feeReserve += feeEarned;

emit MineHarvest(earned - feeEarned, feeEarned, depositIds);

return (earned - feeEarned, feeEarned);
    }

/**
     * @dev Harvest rewards from the mine so that stakers can claim.
     *      Recalculate how many rewards are distributed to each share.
     *
     * @param depositIds            The deposits to harvest rewards for.
     */
    function _updateRewards(uint256[] memory depositIds) internal {
        if (totalStaked == 0) return;

(uint256 newRewards, ) = _harvestMine(depositIds);
        totalRewardsEarned += newRewards;

accRewardsPerShare += (newRewards * ONE) / totalStaked;
    }

(, uint256 depositAmount, , , , , ) = mine.userInfo(address(this), s.depositId);
        s.amount = depositAmount;

return s.amount;
    }

Stake memory s = stakes[i];

if (s.amount != 0) {
                // No more zero stakes - can break
                nextActiveStake = i;
                break;
            }
        }
    }

return unstaked - feeReserve - tokenBuffer;
    }

uint256 totalStakes = stakes.length;
        for (uint256 i = nextActiveStake; i < totalStakes; i++) {
            staked += stakes[i].amount;
        }

return staked + _totalUsableMagic();
    }

/**
     * @dev Determine if the current block timestamp falls in an accrual window.
     *      During accrual windows deposits/withdraws/claims are enabled, and reward
     *      updating is enabled.
     *
     * @return inWindow             Whether the current time falls in an accrual window.
     */
    function _isAccrualWindow() internal view returns (bool inWindow) {
        require(accrualWindows.length > 0, "Accrual windows not set");
        /// time elapsed in day / hours
        uint256 currentHour = (block.timestamp % 86_400) / 3_600;

for (uint256 i = 0; i < accrualWindows.length - 1; i += 2) {
            if (currentHour >= accrualWindows[i] && currentHour < accrualWindows[i + 1]) {
                inWindow = true;
                break;
            }
        }
    }

/**
     * @dev Calculate the current accumulated rewards for a given amount of stake.
     *      Reduces the awards by 1 wei due to an off-by-one issue in the atlas mine.
     *
     * @param stakeAmount           The amount of stake to accumulate rewards for.
     */
    function _accumulatedRewards(uint256 stakeAmount) internal view returns (int256) {
        return ((stakeAmount * accRewardsPerShare) / ONE).toInt256();
    }

/**
     * @dev For methods only callable by the hoard - Treasure staking/unstaking.
     */
    modifier onlyHoard() {
        require(hoards[msg.sender], "Not hoard");

_;
    }

/**
     * @dev For methods that access the token buffer - make sure it is cleared.
     */
    modifier usesBuffer() {
        _;

require(tokenBuffer == 0, "Buffer not clear");
    }

/**
     * @dev For methods that affect staking, when an accrual window is not active.
     */
    modifier whenNotAccruing() {
        require(!_isAccrualWindow(), "In accrual window");

_;
    }

/**
     * @dev For methods accrue rewards, when staking is not active.
     */
    modifier whenAccruing() {
        require(_isAccrualWindow(), "Not accruing");

_;
    }
}