// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Address.sol)pragmasolidity ^0.8.1;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/functionisContract(address account) internalviewreturns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0// for contracts in construction, since the code is only stored at the end// of the constructor execution.return account.code.length>0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/functionsendValue(addresspayable recipient, uint256 amount) internal{
require(address(this).balance>= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value
) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(address(this).balance>= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytesmemory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalviewreturns (bytesmemory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytesmemory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytesmemory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/functionverifyCallResult(bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalpurereturns (bytesmemory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
Contract Source Code
File 2 of 10: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^0.8.0;/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (token/ERC20/IERC20.sol)pragmasolidity ^0.8.0;/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/interfaceIERC20{
/**
* @dev Returns the amount of tokens in existence.
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/functionbalanceOf(address account) externalviewreturns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/functiontransfer(address recipient, uint256 amount) externalreturns (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.
*/functionallowance(address owner, address spender) externalviewreturns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/functionapprove(address spender, uint256 amount) externalreturns (bool);
/**
* @dev Moves `amount` tokens from `sender` to `recipient` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/functiontransferFrom(address sender,
address recipient,
uint256 amount
) externalreturns (bool);
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/eventTransfer(addressindexedfrom, addressindexed 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.
*/eventApproval(addressindexed owner, addressindexed spender, uint256 value);
}
Contract Source Code
File 5 of 10: MerkleProof.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/cryptography/MerkleProof.sol)pragmasolidity ^0.8.0;/**
* @dev These functions deal with verification of Merkle Trees proofs.
*
* The proofs can be generated using the JavaScript library
* https://github.com/miguelmota/merkletreejs[merkletreejs].
* Note: the hashing algorithm should be keccak256 and pair sorting should be enabled.
*
* See `test/utils/cryptography/MerkleProof.test.js` for some examples.
*/libraryMerkleProof{
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*/functionverify(bytes32[] memory proof,
bytes32 root,
bytes32 leaf
) internalpurereturns (bool) {
return processProof(proof, leaf) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merklee tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leafs & pre-images are assumed to be sorted.
*
* _Available since v4.4._
*/functionprocessProof(bytes32[] memory proof, bytes32 leaf) internalpurereturns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i =0; i < proof.length; i++) {
bytes32 proofElement = proof[i];
if (computedHash <= proofElement) {
// Hash(current computed hash + current element of the proof)
computedHash = _efficientHash(computedHash, proofElement);
} else {
// Hash(current element of the proof + current computed hash)
computedHash = _efficientHash(proofElement, computedHash);
}
}
return computedHash;
}
function_efficientHash(bytes32 a, bytes32 b) privatepurereturns (bytes32 value) {
assembly {
mstore(0x00, a)
mstore(0x20, b)
value :=keccak256(0x00, 0x40)
}
}
}
Contract Source Code
File 6 of 10: MultiMerkleDistributor.sol
//██████╗ █████╗ ██╗ █████╗ ██████╗ ██╗███╗ ██╗//██╔══██╗██╔══██╗██║ ██╔══██╗██╔══██╗██║████╗ ██║//██████╔╝███████║██║ ███████║██║ ██║██║██╔██╗ ██║//██╔═══╝ ██╔══██║██║ ██╔══██║██║ ██║██║██║╚██╗██║//██║ ██║ ██║███████╗██║ ██║██████╔╝██║██║ ╚████║//╚═╝ ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝╚═╝ ╚═══╝// SPDX-License-Identifier: MITpragmasolidity 0.8.10;import"./oz/interfaces/IERC20.sol";
import"./oz/libraries/SafeERC20.sol";
import"./oz/utils/MerkleProof.sol";
import"./utils/Owner.sol";
import"./oz/utils/ReentrancyGuard.sol";
import"./utils/Errors.sol";
/** @title Warden Quest Multi Merkle Distributor *//// @author Paladin/*
Contract holds ERC20 rewards from Quests
Can handle multiple MerkleRoots
*/contractMultiMerkleDistributorisOwner, ReentrancyGuard{
usingSafeERC20forIERC20;
/** @notice Seconds in a Week */uint256privateconstant WEEK =604800;
/** @notice Mapping listing the reward token associated to each Quest ID */// QuestID => reward tokenmapping(uint256=>address) public questRewardToken;
/** @notice Mapping of tokens this contract is or was distributing */// token address => booleanmapping(address=>bool) public rewardTokens;
//Periods: timestamp => start of a week, used as a voting period //in the Curve GaugeController though the timestamp / WEEK * WEEK logic.//Handled through the QuestManager contract.//Those can be fetched through this contract when they are closed, or through the QuestManager contract./** @notice List of Closed QuestPeriods by Quest ID */// QuestID => array of periodsmapping(uint256=>uint256[]) public questClosedPeriods;
/** @notice Merkle Root for each period of a Quest (indexed by Quest ID) */// QuestID => period => merkleRootmapping(uint256=>mapping(uint256=>bytes32)) public questMerkleRootPerPeriod;
/** @notice Amount of rewards for each period of a Quest (indexed by Quest ID) */// QuestID => period => totalRewardsAmountmapping(uint256=>mapping(uint256=>uint256)) public questRewardsPerPeriod;
/** @notice BitMap of claims for each period of a Quest */// QuestID => period => claimedBitMap// This is a packed array of booleans.mapping(uint256=>mapping(uint256=>mapping(uint256=>uint256))) private questPeriodClaimedBitMap;
/** @notice Address of the QuestBoard contract */addresspublicimmutable questBoard;
// Events/** @notice Event emitted when an user Claims */eventClaimed(uint256indexed questID,
uint256indexed period,
uint256 index,
uint256 amount,
address rewardToken,
addressindexed account
);
/** @notice Event emitted when a New Quest is added */eventNewQuest(uint256indexed questID, address rewardToken);
/** @notice Event emitted when a Period of a Quest is updated (when the Merkle Root is added) */eventQuestPeriodUpdated(uint256indexed questID, uint256indexed period, bytes32 merkleRoot);
// Modifier/** @notice Check the caller is either the admin or the QuestBoard contract */modifieronlyAllowed(){
if(msg.sender!= questBoard &&msg.sender!= owner()) revert Errors.CallerNotAllowed();
_;
}
// Constructorconstructor(address _questBoard){
if(_questBoard ==address(0)) revert Errors.ZeroAddress();
questBoard = _questBoard;
}
// Functions/**
* @notice Checks if the rewards were claimed for an user on a given period
* @dev Checks if the rewards were claimed for an user (based on the index) on a given period
* @param questID ID of the Quest
* @param period Amount of underlying to borrow
* @param index Index of the claim
* @return bool : true if already claimed
*/functionisClaimed(uint256 questID, uint256 period, uint256 index) publicviewreturns (bool) {
uint256 claimedWordIndex = index >>8;
uint256 claimedBitIndex = index &0xff;
uint256 claimedWord = questPeriodClaimedBitMap[questID][period][claimedWordIndex];
uint256 mask = (1<< claimedBitIndex);
return claimedWord & mask !=0;
}
/**
* @dev Sets the rewards as claimed for the index on the given period
* @param questID ID of the Quest
* @param period Timestamp of the period
* @param index Index of the claim
*/function_setClaimed(uint256 questID, uint256 period, uint256 index) private{
uint256 claimedWordIndex = index >>8;
uint256 claimedBitIndex = index &0xff;
questPeriodClaimedBitMap[questID][period][claimedWordIndex] |= (1<< claimedBitIndex);
}
//Basic Claim /**
* @notice Claims the reward for an user for a given period of a Quest
* @dev Claims the reward for an user for a given period of a Quest if the correct proof was given
* @param questID ID of the Quest
* @param period Timestamp of the period
* @param index Index in the Merkle Tree
* @param account Address of the user claiming the rewards
* @param amount Amount of rewards to claim
* @param merkleProof Proof to claim the rewards
*/functionclaim(uint256 questID, uint256 period, uint256 index, address account, uint256 amount, bytes32[] calldata merkleProof) publicnonReentrant{
if(account ==address(0)) revert Errors.ZeroAddress();
if(questMerkleRootPerPeriod[questID][period] ==0) revert Errors.MerkleRootNotUpdated();
if(isClaimed(questID, period, index)) revert Errors.AlreadyClaimed();
// Check that the given parameters match the given Proofbytes32 node =keccak256(abi.encodePacked(questID, period, index, account, amount));
if(!MerkleProof.verify(merkleProof, questMerkleRootPerPeriod[questID][period], node)) revert Errors.InvalidProof();
// Set the rewards as claimed for that period// And transfer the rewards to the useraddress rewardToken = questRewardToken[questID];
_setClaimed(questID, period, index);
questRewardsPerPeriod[questID][period] -= amount;
IERC20(rewardToken).safeTransfer(account, amount);
emit Claimed(questID, period, index, amount, rewardToken, account);
}
//Struct ClaimParamsstructClaimParams {
uint256 questID;
uint256 period;
uint256 index;
uint256 amount;
bytes32[] merkleProof;
}
//Multi Claim /**
* @notice Claims multiple rewards for a given list
* @dev Calls the claim() method for each entry in the claims array
* @param account Address of the user claiming the rewards
* @param claims List of ClaimParams struct data to claim
*/functionmultiClaim(address account, ClaimParams[] calldata claims) external{
uint256 length = claims.length;
if(length ==0) revert Errors.EmptyParameters();
for(uint256 i; i < length;){
claim(claims[i].questID, claims[i].period, claims[i].index, account, claims[i].amount, claims[i].merkleProof);
unchecked{ ++i; }
}
}
//FullQuest Claim (form of Multi Claim but for only one Quest => only one ERC20 transfer)//Only works for the given periods (in ClaimParams) for the Quest. Any omitted period will be skipped /**
* @notice Claims the reward for all the given periods of a Quest, and transfer all the rewards at once
* @dev Sums up all the rewards for given periods of a Quest, and executes only one transfer
* @param account Address of the user claiming the rewards
* @param questID ID of the Quest
* @param claims List of ClaimParams struct data to claim
*/functionclaimQuest(address account, uint256 questID, ClaimParams[] calldata claims) externalnonReentrant{
if(account ==address(0)) revert Errors.ZeroAddress();
uint256 length = claims.length;
if(length ==0) revert Errors.EmptyParameters();
// Total amount claimable, to transfer at onceuint256 totalClaimAmount;
address rewardToken = questRewardToken[questID];
for(uint256 i; i < length;){
if(claims[i].questID != questID) revert Errors.IncorrectQuestID();
if(questMerkleRootPerPeriod[questID][claims[i].period] ==0) revert Errors.MerkleRootNotUpdated();
if(isClaimed(questID, claims[i].period, claims[i].index)) revert Errors.AlreadyClaimed();
// For each period given, if the proof matches the given parameters, // set as claimed and add to the to total to transferbytes32 node =keccak256(abi.encodePacked(questID, claims[i].period, claims[i].index, account, claims[i].amount));
if(!MerkleProof.verify(claims[i].merkleProof, questMerkleRootPerPeriod[questID][claims[i].period], node)) revert Errors.InvalidProof();
_setClaimed(questID, claims[i].period, claims[i].index);
questRewardsPerPeriod[questID][claims[i].period] -= claims[i].amount;
totalClaimAmount += claims[i].amount;
emit Claimed(questID, claims[i].period, claims[i].index, claims[i].amount, rewardToken, account);
unchecked{ ++i; }
}
// Transfer the total claimed amount
IERC20(rewardToken).safeTransfer(account, totalClaimAmount);
}
/**
* @notice Returns all current Closed periods for the given Quest ID
* @dev Returns all current Closed periods for the given Quest ID
* @param questID ID of the Quest
* @return uint256[] : List of closed periods
*/functiongetClosedPeriodsByQuests(uint256 questID) externalviewreturns (uint256[] memory) {
return questClosedPeriods[questID];
}
// Manager functions/**
* @notice Adds a new Quest to the listing
* @dev Adds a new Quest ID and the associated reward token
* @param questID ID of the Quest
* @param token Address of the ERC20 reward token
* @return bool : success
*/functionaddQuest(uint256 questID, address token) externalreturns(bool) {
if(msg.sender!= questBoard) revert Errors.CallerNotAllowed();
if(questRewardToken[questID] !=address(0)) revert Errors.QuestAlreadyListed();
if(token ==address(0)) revert Errors.TokenNotWhitelisted();
// Add a new Quest using the QuestID, and list the reward token for that Quest
questRewardToken[questID] = token;
if(!rewardTokens[token]) rewardTokens[token] =true;
emit NewQuest(questID, token);
returntrue;
}
/**
* @notice Adds a new period & the rewards of this period for a Quest
* @dev Adds a new period & the rewards of this period for a Quest
* @param questID ID of the Quest
* @param period Timestamp of the period
* @param totalRewardAmount Total amount of rewards to distribute for the period
* @return bool : success
*/functionaddQuestPeriod(uint256 questID, uint256 period, uint256 totalRewardAmount) externalreturns(bool) {
period = (period / WEEK) * WEEK;
if(msg.sender!= questBoard) revert Errors.CallerNotAllowed();
if(questRewardToken[questID] ==address(0)) revert Errors.QuestNotListed();
if(questRewardsPerPeriod[questID][period] !=0) revert Errors.PeriodAlreadyUpdated();
if(period ==0) revert Errors.IncorrectPeriod();
if(totalRewardAmount ==0) revert Errors.NullAmount();
questRewardsPerPeriod[questID][period] = totalRewardAmount;
returntrue;
}
/**
* @notice Updates the period of a Quest by adding the Merkle Root
* @dev Add the Merkle Root for the eriod of the given Quest
* @param questID ID of the Quest
* @param period timestamp of the period
* @param totalAmount sum of all rewards for the Merkle Tree
* @param merkleRoot MerkleRoot to add
* @return bool: success
*/functionupdateQuestPeriod(uint256 questID, uint256 period, uint256 totalAmount, bytes32 merkleRoot) externalonlyAllowedreturns(bool) {
period = (period / WEEK) * WEEK;
if(questRewardToken[questID] ==address(0)) revert Errors.QuestNotListed();
if(period ==0) revert Errors.IncorrectPeriod();
if(questRewardsPerPeriod[questID][period] ==0) revert Errors.PeriodNotListed();
if(questMerkleRootPerPeriod[questID][period] !=0) revert Errors.PeriodAlreadyUpdated();
if(merkleRoot ==0) revert Errors.EmptyMerkleRoot();
// Add a new Closed Period for the Quest
questClosedPeriods[questID].push(period);
if(totalAmount != questRewardsPerPeriod[questID][period]) revert Errors.IncorrectRewardAmount();
// Add the new MerkleRoot for that Closed Period
questMerkleRootPerPeriod[questID][period] = merkleRoot;
emit QuestPeriodUpdated(questID, period, merkleRoot);
returntrue;
}
// Admin functions/**
* @notice Recovers ERC2O tokens sent by mistake to the contract
* @dev Recovers ERC2O tokens sent by mistake to the contract
* @param token Address tof the EC2O token
* @return bool: success
*/functionrecoverERC20(address token) externalonlyOwnernonReentrantreturns(bool) {
if(rewardTokens[token]) revert Errors.CannotRecoverToken();
uint256 amount = IERC20(token).balanceOf(address(this));
if(amount ==0) revert Errors.NullAmount();
IERC20(token).safeTransfer(owner(), amount);
returntrue;
}
// /**
* @notice Allows to update the MerkleRoot for a given period of a Quest if the current Root is incorrect
* @dev Updates the MerkleRoot for the period of the Quest
* @param questID ID of the Quest
* @param period Timestamp of the period
* @param merkleRoot New MerkleRoot to add
* @return bool : success
*/functionemergencyUpdateQuestPeriod(uint256 questID, uint256 period, uint256 addedRewardAmount, bytes32 merkleRoot) externalonlyOwnerreturns(bool) {
// In case the given MerkleRoot was incorrect:// Process:// 1 - block claims for the Quest period by using this method to set an incorrect MerkleRoot, where no proof matches the root// 2 - prepare a new Merkle Tree, taking in account user previous claims on that period, and missing/overpaid rewards// a - for all new claims to be added, set them after the last index of the previous Merkle Tree// b - for users that did not claim, keep the same index, and adjust the amount to claim if needed// c - for indexes that were claimed, place an empty node in the Merkle Tree (with an amount at 0 & the address 0xdead as the account)// 3 - update the Quest period with the correct MerkleRoot// (no need to change the Bitmap, as the new MerkleTree will account for the indexes already claimed)
period = (period / WEEK) * WEEK;
if(questRewardToken[questID] ==address(0)) revert Errors.QuestNotListed();
if(period ==0) revert Errors.IncorrectPeriod();
if(questMerkleRootPerPeriod[questID][period] ==0) revert Errors.PeriodNotClosed();
if(merkleRoot ==0) revert Errors.EmptyMerkleRoot();
questMerkleRootPerPeriod[questID][period] = merkleRoot;
questRewardsPerPeriod[questID][period] += addedRewardAmount;
emit QuestPeriodUpdated(questID, period, merkleRoot);
returntrue;
}
}
Contract Source Code
File 7 of 10: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (access/Ownable.sol)pragmasolidity ^0.8.0;import"./Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
require(newOwner !=address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)pragmasolidity ^0.8.0;/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/abstractcontractReentrancyGuard{
// Booleans are more expensive than uint256 or any type that takes up a full// word because each write operation emits an extra SLOAD to first read the// slot's contents, replace the bits taken up by the boolean, and then write// back. This is the compiler's defense against contract upgrades and// pointer aliasing, and it cannot be disabled.// The values being non-zero value makes deployment a bit more expensive,// but in exchange the refund on every call to nonReentrant will be lower in// amount. Since refunds are capped to a percentage of the total// transaction's gas, it is best to keep them low in cases like this one, to// increase the likelihood of the full refund coming into effect.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/modifiernonReentrant() {
// On the first call to nonReentrant, _notEntered will be truerequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
Contract Source Code
File 10 of 10: SafeERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (token/ERC20/utils/SafeERC20.sol)pragmasolidity ^0.8.0;import"../interfaces/IERC20.sol";
import"../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/librarySafeERC20{
usingAddressforaddress;
functionsafeTransfer(
IERC20 token,
address to,
uint256 value
) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
functionsafeTransferFrom(
IERC20 token,
addressfrom,
address to,
uint256 value
) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/functionsafeApprove(
IERC20 token,
address spender,
uint256 value
) internal{
// safeApprove should only be called when setting an initial allowance,// or when resetting it to zero. To increase and decrease it, use// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'require(
(value ==0) || (token.allowance(address(this), spender) ==0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
functionsafeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal{
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
functionsafeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal{
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/function_callOptionalReturn(IERC20 token, bytesmemory data) private{
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since// we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that// the target address contains contract code and also asserts for success in the low-level call.bytesmemory returndata =address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length>0) {
// Return data is optionalrequire(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}