Contract Source Code:
File 1 of 1 : FAMCO
//SPDX-License-Identifier: MIT
pragma solidity 0.8.14;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}
/**
* @dev Required interface of an ERC721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be have been allowed to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId
) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the caller.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool _approved) external;
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes calldata data
) external;
}
/**
* @title ERC721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC721 asset contracts.
*/
interface IERC721Receiver {
/**
* @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
* by `operator` from `from`, this function is called.
*
* It must return its Solidity selector to confirm the token transfer.
* If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted.
*
* The selector can be obtained in Solidity with `IERC721.onERC721Received.selector`.
*/
function onERC721Received(
address operator,
address from,
uint256 tokenId,
bytes calldata data
) external returns (bytes4);
}
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Metadata is IERC721 {
/**
* @dev Returns the token collection name.
*/
function name() external view returns (string memory);
/**
* @dev Returns the token collection symbol.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}
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) {
// According to EIP-1052, 0x0 is the value returned for not-yet created accounts
// and 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470 is returned
// for accounts without code, i.e. `keccak256('')`
bytes32 codehash;
bytes32 accountHash = 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470;
// solhint-disable-next-line no-inline-assembly
assembly { codehash := extcodehash(account) }
return (codehash != accountHash && codehash != 0x0);
}
/**
* @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");
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value
(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");
return _functionCallWithValue(target, data, value, errorMessage);
}
function _functionCallWithValue(address target, bytes memory data, uint256 weiValue, string memory errorMessage) private returns (bytes memory) {
require(isContract(target), "Address: call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.call{ value: weiValue }(data);
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
// solhint-disable-next-line no-inline-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
interface IERC20 {
function totalSupply() external view returns (uint256);
function symbol() external view returns(string memory);
function name() external view returns(string memory);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Returns the number of decimal places
*/
function decimals() external view returns (uint8);
/**
* @dev Moves `amount` tokens from the caller's account to `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `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.
*/
function transferFrom(address sender, address recipient, uint256 amount) external returns (bool);
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
}
/**
* @dev 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;
}
}
abstract contract ReentrancyGuard {
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor () {
_status = _NOT_ENTERED;
}
modifier nonReentrant() {
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
_status = _ENTERED;
_;
_status = _NOT_ENTERED;
}
}
library SafeMath {
/**
* @dev Returns the addition of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
*
* - Addition cannot overflow.
*/
function add(uint256 a, uint256 b) internal pure returns (uint256) {
uint256 c = a + b;
require(c >= a, "SafeMath: addition overflow");
return c;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b) internal pure returns (uint256) {
return sub(a, b, "SafeMath: subtraction overflow");
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b <= a, errorMessage);
uint256 c = a - b;
return c;
}
/**
* @dev Returns the multiplication of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
*
* - Multiplication cannot overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) {
return 0;
}
uint256 c = a * b;
require(c / a == b, "SafeMath: multiplication overflow");
return c;
}
/**
* @dev Returns the integer division of two unsigned integers. Reverts on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
return div(a, b, "SafeMath: division by zero");
}
/**
* @dev Returns the integer division of two unsigned integers. Reverts with custom message on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b > 0, errorMessage);
uint256 c = a / b;
// assert(a == b * c + a % b); // There is no case in which this doesn't hold
return c;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* Reverts when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b) internal pure returns (uint256) {
return mod(a, b, "SafeMath: modulo by zero");
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* Reverts with custom message when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b != 0, errorMessage);
return a % b;
}
}
contract Ownable {
address private owner;
// event for EVM logging
event OwnerSet(address indexed oldOwner, address indexed newOwner);
// modifier to check if caller is owner
modifier onlyOwner() {
// If the first argument of 'require' evaluates to 'false', execution terminates and all
// changes to the state and to Ether balances are reverted.
// This used to consume all gas in old EVM versions, but not anymore.
// It is often a good idea to use 'require' to check if functions are called correctly.
// As a second argument, you can also provide an explanation about what went wrong.
require(msg.sender == owner, "Caller is not owner");
_;
}
/**
* @dev Set contract deployer as owner
*/
constructor() {
owner = msg.sender; // 'msg.sender' is sender of current call, contract deployer for a constructor
emit OwnerSet(address(0), owner);
}
/**
* @dev Change owner
* @param newOwner address of new owner
*/
function changeOwner(address newOwner) public onlyOwner {
emit OwnerSet(owner, newOwner);
owner = newOwner;
}
/**
* @dev Return owner address
* @return address of owner
*/
function getOwner() external view returns (address) {
return owner;
}
}
contract FAMCO is Context, ERC165, IERC721, IERC721Metadata, ReentrancyGuard, Ownable {
using Address for address;
using SafeMath for uint256;
// Token name
string private constant _name = "FAMCO";
// Token symbol
string private constant _symbol = "FAMCO";
// total number of NFTs Minted
uint256 private _totalSupply;
// current tokenID to mint at
uint256 public currentSupplyIndex;
// Total Number Of Reward Shares (accounts for differing rarities)
uint256 public totalShares;
// Mapping from token ID to owner address
mapping(uint256 => address) private _owners;
// Mapping owner address to token count
mapping(address => uint256) private _balances;
// Mapping from token ID to approved address
mapping(uint256 => address) private _tokenApprovals;
// Mapping from owner to operator approvals
mapping(address => mapping(address => bool)) private _operatorApprovals;
// Mapping from address to permission to deposit rewards
mapping ( address => bool ) public canGiveRewards;
// Maps a TokenID to a rarity
mapping ( uint256 => uint8 ) public tokenIDToRarity;
// owner rewards structure
struct OwnerRewards {
uint256 share; // accounts for rarity of different NFTs
uint256 totalExcluded; // aka reward debt
}
// Mapping from owner to excluded rewards
mapping(address => OwnerRewards) public ownerRewards;
// total dividends for tracking
uint256 private dividendsPerShare;
// total rewards received
uint256 public totalRewards;
// precision factor
uint256 private PRECISION = 10**9;
// base URI
string private baseURI = "";
string private ending = ".json";
// Token Rarity Structure
struct TokenRarity {
uint256 cost;
uint8 multiplier;
}
// cost for minting NFT
mapping ( uint8 => TokenRarity ) public tokenRarity;
// Enable Trading
bool public tradingEnabled = false;
// Toggle URI based on rarity vs tokenID
bool public UriByRarity = true;
// Mint Token
address public mintToken = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48;
address public rewardToken = 0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599;
address public mintRecipient;
////////////////////////////////////////////////
/////////// OWNER FUNCTIONS ///////////
////////////////////////////////////////////////
function __init__(address mintRecipient_) external onlyOwner {
require(
mintRecipient_ != address(0),
'Zero Addr'
);
tokenRarity[0].cost = 500 * 10**6;
tokenRarity[1].cost = 1000 * 10**6;
tokenRarity[2].cost = 2000 * 10**6;
tokenRarity[3].cost = 5000 * 10**6;
tokenRarity[0].multiplier = 1;
tokenRarity[1].multiplier = 2;
tokenRarity[2].multiplier = 4;
tokenRarity[3].multiplier = 10;
mintRecipient = mintRecipient_;
canGiveRewards[mintRecipient_] = true;
}
function resumeTrading() external onlyOwner {
tradingEnabled = true;
}
function pauseTrading() external onlyOwner {
tradingEnabled = false;
}
function withdraw() external onlyOwner {
(bool s,) = payable(msg.sender).call{value: address(this).balance}("");
require(s);
}
function withdrawToken(address token_) external onlyOwner {
require(token_ != address(0), 'Zero Address');
IERC20(token_).transfer(msg.sender, IERC20(token_).balanceOf(address(this)));
}
function setBaseURI(string calldata newURI) external onlyOwner {
baseURI = newURI;
}
function setURIExtention(string calldata newExtention) external onlyOwner {
ending = newExtention;
}
function setMintToken(address newMintToken) external onlyOwner {
mintToken = newMintToken;
}
function setMintRecipient(address mintRecipient_) external onlyOwner {
mintRecipient = mintRecipient_;
}
function setRewardToken(address rewardToken_) external onlyOwner {
rewardToken = rewardToken_;
}
function setRarityCost(uint8 rarity, uint256 cost) external onlyOwner {
require(tokenRarity[rarity].multiplier > 0, 'Multiplier Not Set');
tokenRarity[rarity].cost = cost;
}
function setRarityMultiplier(uint8 rarity, uint8 multiplier) external onlyOwner {
require(tokenRarity[rarity].multiplier == 0, 'Multiplier Already Set');
tokenRarity[rarity].multiplier = multiplier;
}
function setCanGiveRewards(address account, bool canGive) external onlyOwner {
canGiveRewards[account] = canGive;
}
function setURIByRarity(bool isUriBasedOnRarity) external onlyOwner {
UriByRarity = isUriBasedOnRarity;
}
/**
Example:
[ 0x123...abc, 0x456...def ]
[ 5, 10 ]
[ 3, 0 ]
Gives the result:
0x123...abc gets 5 Platinum NFTs
0x456...def gets 10 Bronze NFTs
*/
function ownerMint(address[] calldata tos, uint256[] calldata nums, uint8[] calldata raritys) external onlyOwner {
uint addrLen = tos.length;
require(addrLen == nums.length && nums.length == raritys.length, 'Invalid Lengths');
for (uint i = 0; i < addrLen;) {
for (uint j = 0; j < nums[i];) {
_safeMint(tos[i], currentSupplyIndex, raritys[i]);
unchecked { ++j; }
}
unchecked { ++i; }
}
}
////////////////////////////////////////////////
/////////// PUBLIC FUNCTIONS ///////////
////////////////////////////////////////////////
/**
* Mints `numberOfMints` NFTs To Caller
*/
function mint(address to, uint256 num, uint8 rarity) external {
require(
tradingEnabled,
'Trading Not Enabled'
);
require(
num > 0,
'Invalid Number'
);
require(
tokenRarity[rarity].cost > 0 && tokenRarity[rarity].multiplier > 0,
'Invalid Rarity'
);
// determine cost in USDC
uint256 cost = tokenRarity[rarity].cost * num;
// ensure user has balance and approval of this amount
require(
IERC20(mintToken).balanceOf(msg.sender) >= cost,
'Insufficient USDC Balance'
);
require(
IERC20(mintToken).allowance(msg.sender, address(this)) >= cost,
'Insufficient Allowance'
);
require(
IERC20(mintToken).transferFrom(msg.sender, mintRecipient, cost),
'Error Transfer From'
);
for (uint i = 0; i < num;) {
_safeMint(to, currentSupplyIndex, rarity);
unchecked { ++i; }
}
}
function claimRewards() external nonReentrant {
require(
_balances[msg.sender] > 0,
'Zero Balance'
);
_claimRewards(msg.sender);
}
function burn(uint256 tokenID) external nonReentrant {
require(_isApprovedOrOwner(_msgSender(), tokenID), "caller not owner nor approved");
_claimRewards(_owners[tokenID]);
_burn(tokenID);
}
function giveRewards(uint256 amount) external nonReentrant {
require(
IERC20(rewardToken).balanceOf(msg.sender) >= amount,
'Insufficient Balance'
);
require(
IERC20(rewardToken).allowance(msg.sender, address(this)) >= amount,
'Insufficient BTC Allowance'
);
require(
IERC20(rewardToken).transferFrom(msg.sender, address(this), amount),
'Failure Transfer From'
);
// give rewards
unchecked {
dividendsPerShare += ( amount * PRECISION ) / totalShares;
totalRewards += amount;
}
}
receive() external payable {}
/**
* @dev See {IERC721-approve}.
*/
function approve(address to, uint256 tokenId) public override {
address wpowner = ownerOf(tokenId);
require(to != wpowner, "ERC721: approval to current owner");
require(
_msgSender() == wpowner || isApprovedForAll(wpowner, _msgSender()),
"ERC721: not approved or owner"
);
_approve(to, tokenId);
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address _operator, bool approved) public override {
_setApprovalForAll(_msgSender(), _operator, approved);
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) public override {
require(_isApprovedOrOwner(_msgSender(), tokenId), "caller not owner nor approved");
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId
) public override {
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes memory _data
) public override {
require(_isApprovedOrOwner(_msgSender(), tokenId), "caller not owner nor approved");
_safeTransfer(from, to, tokenId, _data);
}
////////////////////////////////////////////////
/////////// INTERNAL FUNCTIONS ///////////
////////////////////////////////////////////////
/**
* @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeMint(
address to,
uint256 tokenId,
uint8 rarity
) internal {
_mint(to, tokenId, rarity);
require(
_checkOnERC721Received(address(0), to, tokenId, ""),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @dev Mints `tokenId` and transfers it to `to`.
*
* WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
*
* Requirements:
*
* - `tokenId` must not exist.
* - `to` cannot be the zero address.
*
* Emits a {Transfer} event.
*/
function _mint(address to, uint256 tokenId, uint8 rarity) internal {
require(!_exists(tokenId), "ERC721: token already minted");
_owners[tokenId] = to;
tokenIDToRarity[tokenId] = rarity;
unchecked {
currentSupplyIndex++;
_totalSupply++;
_balances[to]++;
totalShares += tokenRarity[rarity].multiplier;
ownerRewards[to].share += tokenRarity[rarity].multiplier;
}
ownerRewards[to].totalExcluded = getCumulativeDividends(ownerRewards[to].share);
emit Transfer(address(0), to, tokenId);
}
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* `_data` is additional data, it has no specified format and it is sent in call to `to`.
*
* This internal function is equivalent to {safeTransferFrom}, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeTransfer(
address from,
address to,
uint256 tokenId,
bytes memory _data
) internal {
_transfer(from, to, tokenId);
require(_checkOnERC721Received(from, to, tokenId, _data), "ERC721: non ERC721Receiver implementer");
}
/**
* @dev Transfers `tokenId` from `from` to `to`.
* As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
*
* Emits a {Transfer} event.
*/
function _transfer(
address from,
address to,
uint256 tokenId
) internal nonReentrant {
require(ownerOf(tokenId) == from, "Incorrect owner");
require(to != address(0), "zero address");
require(balanceOf(from) > 0, 'Zero Balance');
// Clear approvals from the previous owner
_approve(address(0), tokenId);
// claim rewards for from
_claimRewards(from);
// if to has balance claim rewards for to
if (_balances[to] > 0) {
_claimRewards(to);
}
// Allocate balances
_balances[from] = _balances[from].sub(1);
_balances[to] += 1;
_owners[tokenId] = to;
// fetch multiplier based on rarity
uint8 multiplier = tokenRarity[tokenIDToRarity[tokenId]].multiplier;
// Allocate reward shares based on rarity
ownerRewards[from].share -= multiplier;
ownerRewards[to].share += multiplier;
// reset reward allocations
ownerRewards[from].totalExcluded = getCumulativeDividends(ownerRewards[from].share);
ownerRewards[to].totalExcluded = getCumulativeDividends(ownerRewards[to].share);
// emit transfer
emit Transfer(from, to, tokenId);
}
/**
Claims BNB Reward For User
*/
function _claimRewards(address user) internal {
// return if zero balance
if (_balances[user] == 0) {
return;
}
// fetch pending rewards
uint pending = pendingRewards(user);
uint rewardBalance = IERC20(rewardToken).balanceOf(address(this));
if (pending > rewardBalance) {
pending = rewardBalance;
}
// return if no rewards
if (pending == 0) {
return;
}
// reset total rewards
ownerRewards[user].totalExcluded = getCumulativeDividends(ownerRewards[user].share);
// transfer reward to user
IERC20(rewardToken).transfer(user, pending);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/
function _burn(uint256 tokenId) internal {
require(_exists(tokenId), 'Token Does Not Exist');
// owner of token
address owner_ = ownerOf(tokenId);
// Clear approvals
_approve(address(0), tokenId);
// decrement balance
_balances[owner_] -= 1;
delete _owners[tokenId];
// decrement total supply
_totalSupply -= 1;
// decrement multiplier from total shares
uint256 multiplier = tokenRarity[tokenIDToRarity[tokenId]].multiplier;
totalShares -= multiplier;
ownerRewards[owner_].share -= multiplier;
ownerRewards[owner_].totalExcluded = getCumulativeDividends(ownerRewards[owner_].share);
// emit transfer
emit Transfer(owner_, address(0), tokenId);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits a {Approval} event.
*/
function _approve(address to, uint256 tokenId) internal {
_tokenApprovals[tokenId] = to;
emit Approval(ownerOf(tokenId), to, tokenId);
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits a {ApprovalForAll} event.
*/
function _setApprovalForAll(
address wpowner,
address _operator,
bool approved
) internal {
require(wpowner != _operator, "ERC721: approve to caller");
_operatorApprovals[wpowner][_operator] = approved;
emit ApprovalForAll(wpowner, _operator, approved);
}
////////////////////////////////////////////////
/////////// READ FUNCTIONS ///////////
////////////////////////////////////////////////
function checkClaimEligibility(address _to, uint256 _quantity) external view returns (string memory) {
if (tradingEnabled && _to != address(0) && _quantity > 0) {
return "";
}
return "Sale is not live";
}
function totalSupply() external view returns (uint256) {
return _totalSupply;
}
function getIDsByOwner(address owner_) external view returns (uint256[] memory) {
uint256[] memory ids = new uint256[](balanceOf(owner_));
if (balanceOf(owner_) == 0) return ids;
uint256 count = 0;
for (uint i = 0; i < currentSupplyIndex;) {
if (_owners[i] == owner_) {
ids[count] = i;
unchecked { count++; }
}
unchecked { ++i; }
}
return ids;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view override(ERC165, IERC165) returns (bool) {
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/
function balanceOf(address wpowner) public view override returns (uint256) {
require(wpowner != address(0), "query for the zero address");
return _balances[wpowner];
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId) public view override returns (address) {
address wpowner = _owners[tokenId];
require(wpowner != address(0), "query for nonexistent token");
return wpowner;
}
/**
* @dev See {IERC721Metadata-name}.
*/
function name() public pure override returns (string memory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/
function symbol() public pure override returns (string memory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId) public view override returns (string memory) {
require(_exists(tokenId), "nonexistent token");
string memory idstr = UriByRarity ? uint2str(uint256(tokenIDToRarity[tokenId])) : uint2str(tokenId);
string memory fHalf = string.concat(baseURI, idstr);
return string.concat(fHalf, ending);
}
/**
Converts A Uint Into a String
*/
function uint2str(uint _i) internal pure returns (string memory _uintAsString) {
if (_i == 0) {
return "0";
}
uint j = _i;
uint len;
while (j != 0) {
len++;
j /= 10;
}
bytes memory bstr = new bytes(len);
uint k = len;
while (_i != 0) {
k = k-1;
uint8 temp = (48 + uint8(_i - _i / 10 * 10));
bytes1 b1 = bytes1(temp);
bstr[k] = b1;
_i /= 10;
}
return string(bstr);
}
function owner() external view returns (address) {
return this.getOwner();
}
/**
* @dev See {IERC721-getApproved}.
*/
function getApproved(uint256 tokenId) public view override returns (address) {
require(_exists(tokenId), "ERC721: query for nonexistent token");
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address wpowner, address _operator) public view override returns (bool) {
return _operatorApprovals[wpowner][_operator];
}
/**
Pending BNB Rewards For `account`
*/
function pendingRewards(address account) public view returns (uint256) {
if(_balances[account] == 0){ return 0; }
uint256 accountTotalDividends = getCumulativeDividends(ownerRewards[account].share);
uint256 accountTotalExcluded = ownerRewards[account].totalExcluded;
if(accountTotalDividends <= accountTotalExcluded){ return 0; }
return accountTotalDividends - accountTotalExcluded;
}
/**
Cumulative Dividends For A Number Of Tokens
*/
function getCumulativeDividends(uint256 share) internal view returns (uint256) {
return share.mul(dividendsPerShare).div(PRECISION);
}
/**
* @dev Returns whether `tokenId` exists.
*
* Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}.
*
* Tokens start existing when they are minted
*/
function _exists(uint256 tokenId) internal view returns (bool) {
return _owners[tokenId] != address(0);
}
/**
* @dev Returns whether `spender` is allowed to manage `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function _isApprovedOrOwner(address spender, uint256 tokenId) internal view returns (bool) {
require(_exists(tokenId), "ERC721: nonexistent token");
address wpowner = ownerOf(tokenId);
return (spender == wpowner || getApproved(tokenId) == spender || isApprovedForAll(wpowner, spender));
}
function onReceivedRetval() public pure returns (bytes4) {
return IERC721Receiver.onERC721Received.selector;
}
/**
* @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address.
* The call is not executed if the target address is not a contract.
*
* @param from address representing the previous owner of the given token ID
* @param to target address that will receive the tokens
* @param tokenId uint256 ID of the token to be transferred
* @param _data bytes optional data to send along with the call
* @return bool whether the call correctly returned the expected magic value
*/
function _checkOnERC721Received(
address from,
address to,
uint256 tokenId,
bytes memory _data
) private returns (bool) {
if (to.isContract()) {
try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, _data) returns (bytes4 retval) {
return retval == IERC721Receiver.onERC721Received.selector;
} catch (bytes memory reason) {
if (reason.length == 0) {
revert("ERC721: non ERC721Receiver implementer");
} else {
assembly {
revert(add(32, reason), mload(reason))
}
}
}
} else {
return true;
}
}
}