Contract Name:
FrogFrensRewards
Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Address.sol)
pragma solidity ^0.8.0;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in
// construction, since the code is only stored at the end of the
// constructor execution.
uint256 size;
assembly {
size := extcodesize(account)
}
return size > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return 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._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory 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._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory 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._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytes memory 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._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
/**
* ______ ______ ______ _
* | ___| | ___| | ___ \ | |
* | |_ _ __ ___ __ _| |_ _ __ ___ _ __ ___ | |_/ /_____ ____ _ _ __ __| |___
* | _| '__/ _ \ / _` | _| '__/ _ \ '_ \/ __|| // _ \ \ /\ / / _` | '__/ _` / __|
* | | | | | (_) | (_| | | | | | __/ | | \__ \| |\ \ __/\ V V / (_| | | | (_| \__ \
* \_| |_| \___/ \__, \_| |_| \___|_| |_|___/\_| \_\___| \_/\_/ \__,_|_| \__,_|___/
* __/ |
* |___/
*/
import "./Context.sol";
import "./Ownable.sol";
import "./Address.sol";
pragma solidity 0.8.3;
interface ERC20 {
function balanceOf(address account) external view returns (uint256);
function transfer(address account, uint256 amount) external;
function deposit() external payable;
function withdraw(uint256) external;
}
interface ERC721 {
function ownerOf(uint256 tokenId) external returns (address);
}
interface StakingInterface {
function nftDepositor(uint256 tokenId) external returns (address);
}
/// @title Rewards for Non-Fungible Tokens
/// @dev Contract for the split between community rewards and dev rewards
///
contract FrogFrensRewards is Ownable {
uint256 public communityClaimed = 0;
uint256 public creatorClaimed = 0;
uint256 public creatorRoyalties = 0; // percentage from total NFT price
uint256 public communityRoyalties = 100; // percentage from total NFT price
uint256 public collectionSize = 5555;
address public wavaxTokenFeesAddress; // WAVAX token address
address public creatorAddress; // the creator address
address public collectionAddress; // the collection address
address public stakingAddress = address(0); // the staking contract address
bool public claimActive = true;
mapping(uint256 => uint256) private communityClaims;
mapping(address => uint256) private addressClaims;
event CommunityClaimed(address owner, uint256 amount, uint256 tokenID);
event CreatorClaimed(uint256 amount);
event RewardsCreated(address collectionAddress);
constructor(
address _wavaxTokenFeesAddress,
address _creatorAddress,
address _collectionAddress,
uint256 _collectionSize
) {
wavaxTokenFeesAddress = _wavaxTokenFeesAddress;
creatorAddress = _creatorAddress;
collectionAddress = _collectionAddress;
collectionSize = _collectionSize;
emit RewardsCreated(collectionAddress);
}
/// @dev set rewards address (wavax)
function setWavaxTokenFeesAddress(address _wavaxTokenFeesAddress) external onlyOwner {
wavaxTokenFeesAddress = _wavaxTokenFeesAddress;
}
/// @dev set creator address, can be another contract
function setCreatorAddress(address _creatorAddress) external onlyOwner {
creatorAddress = _creatorAddress;
}
/// @dev set new collection size. Only smaller collection size, can't increase size
function setCollectionSize(uint256 _collectionSize) external onlyOwner {
require(_collectionSize < collectionSize, 'Cannot increase collection size');
collectionSize = _collectionSize;
}
/// @dev set creator rewards
function setCreatorRewards(uint256 _creatorRewards) external onlyOwner {
creatorRoyalties = _creatorRewards;
}
/// @dev set creator rewards
function setCommunityRewards(uint256 _communityRewards) external onlyOwner {
communityRoyalties = _communityRewards;
}
/// @dev set staking address
function setStakingAddress(address _stakingAddress) external onlyOwner {
stakingAddress = _stakingAddress;
}
/// @dev set claim active
function setClaimActive(bool value) public onlyOwner {
claimActive = value;
}
/// @dev get total rewards
/// @return total rewards
function getTotalRewards() public view returns (uint256) {
return creatorRoyalties + communityRoyalties;
}
/// @dev get rewards split
/// @return creator rewards
/// @return community rewards
function getRoyalties() public view returns (uint256, uint256) {
return (creatorRoyalties, communityRoyalties);
}
/// @dev get total collected
/// @return total collected
function getTotalCollected() public view returns (uint256) {
uint256 balance = ERC20(wavaxTokenFeesAddress).balanceOf(address(this));
return balance + creatorClaimed + communityClaimed;
}
/// @dev get creator balance
/// @return creator total balance
function getCreatorBalance() public view returns (uint256) {
uint256 _creatorRewards = (creatorRoyalties * 100) / getTotalRewards();
return (getTotalCollected() * _creatorRewards) / 100 - creatorClaimed;
}
/// @dev get single token total rewards
/// @return single token rewards
function getTokenTotalRewards() public view returns (uint256) {
uint256 _communityRewards = (communityRoyalties * 100) / getTotalRewards();
return ((getTotalCollected() * _communityRewards) / 100) / collectionSize;
}
/// @dev get single token balance
/// @return single token balance
function getTokenBalance(uint256 tokenID) public view returns (uint256) {
return getTokenTotalRewards() - communityClaims[tokenID];
}
/// @dev get token balances for each token from an array of tokenIDs
function getTokensBalance(uint256[] memory tokenIDs) public view returns (uint256) {
uint256 totalBalance = 0;
for (uint256 i = 0; i<tokenIDs.length; i++) {
uint256 balance = getTokenBalance(tokenIDs[i]);
totalBalance = (totalBalance + balance);
}
return totalBalance;
}
/// @dev get address tot claims
/// @return address total claims
function getAddressClaims(address account) public view returns (uint256) {
return addressClaims[account];
}
/// @dev claim community rewards per token id
function claimCommunity(uint256 tokenID) public {
if (claimActive == true) {
uint256 balance = getTokenBalance(tokenID);
if (balance > 0) {
address owner = ERC721(collectionAddress).ownerOf(tokenID);
if (stakingAddress != address(0)) {
address staker = StakingInterface(stakingAddress).nftDepositor(tokenID);
if (staker != address(0)) {
ERC20(wavaxTokenFeesAddress).transfer(staker, balance);
communityClaims[tokenID] = communityClaims[tokenID] + balance;
addressClaims[staker] = addressClaims[staker] + balance;
communityClaimed = communityClaimed + balance;
emit CommunityClaimed(staker, balance, tokenID);
} else if (owner != address(0)) {
ERC20(wavaxTokenFeesAddress).transfer(owner, balance);
communityClaims[tokenID] = communityClaims[tokenID] + balance;
addressClaims[owner] = addressClaims[owner] + balance;
communityClaimed = communityClaimed + balance;
emit CommunityClaimed(owner, balance, tokenID);
}
} else if (owner != address(0)) {
ERC20(wavaxTokenFeesAddress).transfer(owner, balance);
communityClaims[tokenID] = communityClaims[tokenID] + balance;
addressClaims[owner] = addressClaims[owner] + balance;
communityClaimed = communityClaimed + balance;
emit CommunityClaimed(owner, balance, tokenID);
}
}
}
}
/// @dev claim community from an array of tokenIDs
function claimCommunityBatch(uint256[] calldata tokenIDs) external {
for (uint256 i=0; i<tokenIDs.length; i++) {
claimCommunity(tokenIDs[i]);
}
}
/// @dev claim creator rewards
function claimCreator() external {
require(msg.sender == creatorAddress, "Only creator can claim");
uint256 balance = getCreatorBalance();
require(balance > 0, "No balance to claim");
ERC20(wavaxTokenFeesAddress).transfer(creatorAddress, balance);
creatorClaimed = creatorClaimed + balance;
emit CreatorClaimed(balance);
}
/// @dev transfer a ERC20 token to address
function withdrawToken(ERC20 token, address recipient, uint256 amount) public onlyOwner {
token.transfer(recipient, amount);
}
/// @dev function to receive AVAX. msg.data must be empty
receive() external payable {
uint256 contractBalance = address(this).balance;
ERC20(wavaxTokenFeesAddress).deposit{ value: contractBalance }();
}
/// @dev fallback function is called when msg.data is not empty
fallback() external payable {}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/Ownable.sol)
pragma solidity ^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.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}