// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @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
* ====
*
* [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.
* ====
*/
function isContract(address account) internal view returns (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].
*/
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
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @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;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC721VF/ERC721VF.sol)
pragma solidity ^0.8.0;
import "./IERC721VF.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
import "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@openzeppelin/contracts/utils/Context.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension, and a queryable extenstion defined in {IERC721VF}.
*/
contract ERC721VF is Context, ERC165, IERC721, IERC721Metadata, IERC721VF {
using Address for address;
using Strings for uint256;
// Token name
string private _name;
// Token symbol
string private _symbol;
// 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;
// The number of tokens minted
uint256 private _mintCounter;
// The number of tokens burned
uint256 private _burnCounter;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165, IERC165)
returns (bool)
{
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
interfaceId == type(IERC721VF).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/
function balanceOf(address owner)
public
view
virtual
override
returns (uint256)
{
require(
owner != address(0),
"ERC721: balance query for the zero address"
);
return _balances[owner];
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId)
public
view
virtual
override
returns (address)
{
address owner = _owners[tokenId];
require(
owner != address(0),
"ERC721: owner query for nonexistent token"
);
return owner;
}
/**
* @dev See {IERC721Metadata-name}.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId)
public
view
virtual
override
returns (string memory)
{
require(
_exists(tokenId),
"ERC721Metadata: URI query for nonexistent token"
);
string memory baseURI = _baseURI();
return
bytes(baseURI).length > 0
? string(abi.encodePacked(baseURI, tokenId.toString()))
: "";
}
/**
* @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
* token will be the concatenation of the `baseURI` and the `tokenId`. Empty
* by default, can be overriden in child contracts.
*/
function _baseURI() internal view virtual returns (string memory) {
return "";
}
/**
* @dev See {IERC721-approve}.
*/
function approve(address to, uint256 tokenId) public virtual override {
address owner = ERC721VF.ownerOf(tokenId);
require(to != owner, "ERC721: approval to current owner");
require(
_msgSender() == owner || isApprovedForAll(owner, _msgSender()),
"ERC721: approve caller is not owner nor approved for all"
);
_approve(to, tokenId);
}
/**
* @dev See {IERC721-getApproved}.
*/
function getApproved(uint256 tokenId)
public
view
virtual
override
returns (address)
{
require(
_exists(tokenId),
"ERC721: approved query for nonexistent token"
);
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved)
public
virtual
override
{
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address owner, address operator)
public
view
virtual
override
returns (bool)
{
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) public virtual override {
//solhint-disable-next-line max-line-length
require(
_isApprovedOrOwner(_msgSender(), tokenId),
"ERC721: transfer caller is not owner nor approved"
);
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId
) public virtual override {
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes memory _data
) public virtual override {
require(
_isApprovedOrOwner(_msgSender(), tokenId),
"ERC721: transfer caller is not owner nor approved"
);
_safeTransfer(from, to, tokenId, _data);
}
/**
* @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 virtual {
_transfer(from, to, tokenId);
require(
_checkOnERC721Received(from, to, tokenId, _data),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @dev See {IERC721VF-totalSupply}.
*/
function totalSupply() public view returns (uint256) {
unchecked {
return _mintCounter - _burnCounter;
}
}
/**
* @dev See {IERC721VF-totalMinted}.
*/
function totalMinted() public view returns (uint256) {
unchecked {
return _mintCounter;
}
}
/**
* @dev See {IERC721VF-totalBurned}.
*/
function totalBurned() public view returns (uint256) {
unchecked {
return _burnCounter;
}
}
/**
* @dev See {IERC721VF-tokensOfOwner}.
*/
function tokensOfOwner(address owner)
public
view
returns (uint256[] memory ownerTokens)
{
address currentOwnerAddress;
uint256 tokenCount = balanceOf(owner);
if (tokenCount == 0) {
return new uint256[](0);
} else {
uint256[] memory result = new uint256[](tokenCount);
uint256 resultIndex = 0;
uint256 index;
for (index = 0; resultIndex != tokenCount; index++) {
currentOwnerAddress = _owners[index];
if (currentOwnerAddress == owner) {
result[resultIndex++] = index;
}
}
return result;
}
}
/**
* @dev See {IERC721VF-tokensOfOwnerIn}.
*/
function tokensOfOwnerIn(
address owner,
uint256 startIndex,
uint256 endIndex
) public view returns (uint256[] memory ownerTokens) {
address currentOwnerAddress;
uint256 tokenCount = balanceOf(owner);
if (tokenCount == 0) {
return new uint256[](0);
} else {
uint256[] memory result = new uint256[](tokenCount);
uint256 resultIndex = 0;
uint256 index = startIndex;
for (index; index <= endIndex; index++) {
currentOwnerAddress = _owners[index];
if (currentOwnerAddress == owner) {
result[resultIndex++] = index;
}
}
// Downsize the array to fit.
assembly {
mstore(result, resultIndex)
}
return result;
}
}
/**
* @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 (`_mint`),
* and stop existing when they are burned (`_burn`).
*/
function _exists(uint256 tokenId) internal view virtual 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
virtual
returns (bool)
{
require(
_exists(tokenId),
"ERC721: operator query for nonexistent token"
);
address owner = ERC721VF.ownerOf(tokenId);
return (spender == owner ||
getApproved(tokenId) == spender ||
isApprovedForAll(owner, spender));
}
/**
* @dev Safely mints `tokenId` and transfers it to `to`.
*
* Requirements:
*
* - `tokenId` must not exist.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeMint(address to, uint256 tokenId) internal virtual {
_safeMint(to, tokenId, "");
}
/**
* @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,
bytes memory _data
) internal virtual {
_mint(to, tokenId);
require(
_checkOnERC721Received(address(0), to, tokenId, _data),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @dev Safely batch mints tokens starting at `startTokenId` until `quantity` is met and transfers them to `to`.
*
* Requirements:
*
* - `tokenId` must not exist.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
* - Transfer to only ERC721Reciever implementers
*
* Emits a {Transfer} event.
*/
function _safeMintBatch(
address to,
uint256 quantity,
uint256 startTokenId
) internal returns (uint256 endToken) {
uint256 tokenId = startTokenId;
for (uint256 i; i < quantity; i++) {
require(to != address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId);
_balances[to] += 1;
_owners[tokenId] = to;
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, tokenId);
require(
_checkOnERC721Received(address(0), to, tokenId, ""),
"ERC721: transfer to non ERC721Receiver implementer"
);
tokenId++;
}
unchecked {
_mintCounter += quantity;
}
return tokenId;
}
/**
* @dev Batch mints tokens starting at `startTokenId` until `quantity` is met and transfers them to `to`.
*
* Requirements:
*
* - `tokenId` must not exist.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _mintBatch(
address to,
uint256 quantity,
uint256 startTokenId
) internal returns (uint256 endToken) {
uint256 tokenId = startTokenId;
for (uint256 i; i < quantity; i++) {
require(to != address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId);
_owners[tokenId] = to;
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, tokenId);
tokenId++;
}
unchecked {
_balances[to] += quantity;
_mintCounter += quantity;
}
return tokenId;
}
/**
* @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) internal virtual {
require(to != address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId);
_balances[to] += 1;
_owners[tokenId] = to;
unchecked {
_mintCounter++;
}
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, tokenId);
}
function _burn(address from, uint256 tokenId) internal virtual {
require(
_isApprovedOrOwner(from, tokenId),
"ERC721: transfer caller is not owner nor approved"
);
_burn(tokenId);
}
/**
* @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 virtual {
address owner = ERC721VF.ownerOf(tokenId);
_beforeTokenTransfer(owner, address(0), tokenId);
// Clear approvals
_approve(address(0), tokenId);
_balances[owner] -= 1;
delete _owners[tokenId];
emit Transfer(owner, address(0), tokenId);
_afterTokenTransfer(owner, address(0), tokenId);
unchecked {
_burnCounter++;
}
}
/**
* @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 virtual {
require(
ERC721VF.ownerOf(tokenId) == from,
"ERC721VF: transfer from incorrect owner"
);
require(to != address(0), "ERC721VF: transfer to the zero address");
_beforeTokenTransfer(from, to, tokenId);
// Clear approvals from the previous owner
_approve(address(0), tokenId);
_balances[from] -= 1;
_balances[to] += 1;
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
_afterTokenTransfer(from, to, tokenId);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits a {Approval} event.
*/
function _approve(address to, uint256 tokenId) internal virtual {
_tokenApprovals[tokenId] = to;
emit Approval(ERC721VF.ownerOf(tokenId), to, tokenId);
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits a {ApprovalForAll} event.
*/
function _setApprovalForAll(
address owner,
address operator,
bool approved
) internal virtual {
require(owner != operator, "ERC721: approve to caller");
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @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: transfer to non ERC721Receiver implementer"
);
} else {
assembly {
revert(add(32, reason), mload(reason))
}
}
}
} else {
return true;
}
}
/**
* @dev Hook that is called before any token transfer. This includes minting
* and burning.
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be
* transferred to `to`.
* - When `from` is zero, `tokenId` will be minted for `to`.
* - When `to` is zero, ``from``'s `tokenId` will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual {}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual {}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @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);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (interfaces/IERC2981.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Interface for the NFT Royalty Standard.
*
* A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
* support for royalty payments across all NFT marketplaces and ecosystem participants.
*
* _Available since v4.5._
*/
interface IERC2981 is IERC165 {
/**
* @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
* exchange. The royalty amount is denominated and should be payed in that same unit of exchange.
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @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;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC721.sol";
/**
* @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);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721Receiver.sol)
pragma solidity ^0.8.0;
/**
* @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);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
interface IERC721VF {
/**
* @dev Burned tokens are calculated here, use totalMinted() if you want to count just minted tokens.
*/
function totalSupply() external view returns (uint256);
/**
* Returns the total amount of tokens minted in the contract.
*/
function totalMinted() external view returns (uint256);
/**
* Returns the total amount of tokens burned in the contract.
*/
function totalBurned() external view returns (uint256);
/**
* @dev Returns an array of token IDs owned by `owner`.
*
* This function scans the ownership mapping and is O(totalSupply) in complexity.
* It is meant to be called off-chain.
*
* See {ERC721AQueryable-tokensOfOwnerIn} for splitting the scan into
* multiple smaller scans if the collection is large enough to cause
* an out-of-gas error (10K pfp collections should be fine).
*/
function tokensOfOwner(address owner)
external
view
returns (uint256[] memory ownerTokens);
/**
* @dev Returns an array of token IDs owned by `owner`,
* in the range [`start`, `stop`)
* (i.e. `start <= tokenId < stop`).
*
* This function allows for tokens to be queried if the collection
* grows too big for a single call of {ERC721AQueryable-tokensOfOwner}.
*
* Requirements:
*
* - `start` < `stop`
*/
function tokensOfOwnerIn(
address owner,
uint256 startIndex,
uint256 endIndex
) external view returns (uint256[] memory ownerTokens);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
interface IVFAccessControl {
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(
bytes32 indexed role,
bytes32 indexed previousAdminRole,
bytes32 indexed newAdminRole
);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {AccessControl-_setupRole}.
*/
event RoleGranted(
bytes32 indexed role,
address indexed account,
address indexed sender
);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(
bytes32 indexed role,
address indexed account,
address indexed sender
);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account)
external
view
returns (bool);
/**
* @dev Revert with a standard message if `account` is missing `role`.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*/
function checkRole(bytes32 role, address account) external view;
/**
* @dev Returns bytes of default admin role
*/
function getAdminRole() external view returns (bytes32);
/**
* @dev Returns bytes of token contract role
*/
function getTokenContractRole() external view returns (bytes32);
/**
* @dev Returns bytes of sales contract role
*/
function getSalesContractRole() external view returns (bytes32);
/**
* @dev Returns bytes of burner role
*/
function getBurnerRole() external view returns (bytes32);
/**
* @dev Returns bytes of minter role
*/
function getMinterRole() external view returns (bytes32);
/**
* @dev Returns a bytes array of roles that can be minters
*/
function getMinterRoles() external view returns (bytes32[] memory);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) external;
/**
* @dev Selects the next minter from the minters array using the current minter index.
* The current minter index should be incremented after each selection. If the
* current minter index + 1 is equal to the minters array length then the current
* minter index should be set back to 0
*
* Requirements:
*
* - the caller must be an admin role
*/
function selectNextMinter() external returns (address payable);
/**
* @dev Grants `minter` minter role and adds `minter` to minters array
*
* Requirements:
*
* - the caller must be an admin role
*/
function grantMinterRole(address minter) external;
/**
* @dev Revokes minter role from `minter` and removes `minter` from minters array
*
* Requirements:
*
* - the caller must be an admin role
*/
function revokeMinterRole(address minter) external;
/**
* @dev Distributes ETH evenly to all addresses in minters array
*/
function fundMinters() external payable;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
interface IVFRoyalties {
/**
* @dev Update the access control contract
*
* Requirements:
*
* - the caller must be an admin role
* - `controlContractAddress` must support the IVFAccesControl interface
*/
function setControlContract(address controlContractAddress) external;
/**
* @dev Get royalty information for a contract based on the `salePrice` of a token
*/
function royaltyInfo(
uint256,
address contractAddress,
uint256 salePrice
) external view returns (address receiver, uint256 royaltyAmount);
/**
* @dev Sets the royalty information that all ids in this contract will default to.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/
function setDefaultRoyalty(address receiver, uint96 feeNumerator) external;
/**
* @dev Removes default royalty information.
*/
function deleteDefaultRoyalty() external;
/**
* @dev Sets the royalty information for `contractAddress`.
*
* Requirements:
*
* - `receiver` cannot be the zero address.
* - `feeNumerator` cannot be greater than the fee denominator.
*/
function setContractRoyalties(
address contractAddress,
address receiver,
uint96 feeNumerator
) external;
/**
* @dev Removes royalty information for `contractAddress`.
*/
function resetContractRoyalty(address contractAddress) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)
pragma solidity ^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].
*/
abstract contract ReentrancyGuard {
// 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.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _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.
*/
modifier nonReentrant() {
// On the first call to nonReentrant, _notEntered will be true
require(_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;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Strings.sol)
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
// Inspired by OraclizeAPI's implementation - MIT licence
// https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
if (value == 0) {
return "0";
}
uint256 temp = value;
uint256 digits;
while (temp != 0) {
digits++;
temp /= 10;
}
bytes memory buffer = new bytes(digits);
while (value != 0) {
digits -= 1;
buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
value /= 10;
}
return string(buffer);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
if (value == 0) {
return "0x00";
}
uint256 temp = value;
uint256 length = 0;
while (temp != 0) {
length++;
temp >>= 8;
}
return toHexString(value, length);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _HEX_SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
import "./IVFAccessControl.sol";
import "@openzeppelin/contracts/utils/Context.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
contract VFAccessControl is IVFAccessControl, Context, ERC165, ReentrancyGuard {
//Struct for maintaining role information
struct RoleData {
mapping(address => bool) members;
bytes32 adminRole;
}
//Role information
mapping(bytes32 => RoleData) private _roles;
//Admin role
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
//Token contract role
bytes32 public constant TOKEN_CONTRACT_ROLE =
keccak256("TOKEN_CONTRACT_ROLE");
//Sales contract role
bytes32 public constant SALES_CONTRACT_ROLE =
keccak256("SALES_CONTRACT_ROLE");
//Burner role
bytes32 public constant BURNER_ROLE = keccak256("BURNER_ROLE");
//Minter role
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
//Array of addresses that can mint
address[] public minterAddresses;
//Index of next minter in minterAddresses
uint8 private _currentMinterIndex = 0;
//Array of roles that can mint
bytes32[] public minterRoles;
/**
* @dev Initializes the contract by assigning the msg sender the admin, minter,
* and burner role. Along with adding the minter role and sales contract role
* to the minter roles array.
*/
constructor() {
_grantRole(DEFAULT_ADMIN_ROLE, _msgSender());
_grantRole(MINTER_ROLE, _msgSender());
_grantRole(BURNER_ROLE, _msgSender());
minterRoles.push(MINTER_ROLE);
minterRoles.push(SALES_CONTRACT_ROLE);
}
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with a standardized message including the required role.
*
* The format of the revert reason is given by the following regular expression:
*
* /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
*
* _Available since v4.1._
*/
modifier onlyRole(bytes32 role) {
checkRole(role, _msgSender());
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165)
returns (bool)
{
return
interfaceId == type(IVFAccessControl).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IVFAccessControl-hasRole}.
*/
function hasRole(bytes32 role, address account)
public
view
virtual
returns (bool)
{
return _roles[role].members[account];
}
/**
* @dev See {IVFAccessControl-checkRole}.
*/
function checkRole(bytes32 role, address account) public view virtual {
if (!hasRole(role, account)) {
revert(
string(
abi.encodePacked(
"AccessControl: account ",
Strings.toHexString(uint160(account), 20),
" is missing role ",
Strings.toHexString(uint256(role), 32)
)
)
);
}
}
/**
* @dev See {IVFAccessControl-getAdminRole}.
*/
function getAdminRole() external view virtual returns (bytes32) {
return DEFAULT_ADMIN_ROLE;
}
/**
* @dev See {IVFAccessControl-getTokenContractRole}.
*/
function getTokenContractRole() external view virtual returns (bytes32) {
return TOKEN_CONTRACT_ROLE;
}
/**
* @dev See {IVFAccessControl-getSalesContractRole}.
*/
function getSalesContractRole() external view virtual returns (bytes32) {
return SALES_CONTRACT_ROLE;
}
/**
* @dev See {IVFAccessControl-getBurnerRole}.
*/
function getBurnerRole() external view virtual returns (bytes32) {
return BURNER_ROLE;
}
/**
* @dev See {IVFAccessControl-getMinterRole}.
*/
function getMinterRole() external view virtual returns (bytes32) {
return MINTER_ROLE;
}
/**
* @dev See {IVFAccessControl-getMinterRoles}.
*/
function getMinterRoles() external view virtual returns (bytes32[] memory) {
return minterRoles;
}
/**
* @dev See {IVFAccessControl-getRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev See {IVFAccessControl-grantRole}.
*/
function grantRole(bytes32 role, address account)
public
virtual
onlyRole(getRoleAdmin(role))
{
_grantRole(role, account);
}
/**
* @dev See {IVFAccessControl-revokeRole}.
*/
function revokeRole(bytes32 role, address account)
external
virtual
onlyRole(getRoleAdmin(role))
{
_revokeRole(role, account);
}
/**
* @dev See {IVFAccessControl-renounceRole}.
*/
function renounceRole(bytes32 role, address account) external virtual {
require(
account == _msgSender(),
"AccessControl: can only renounce roles for self"
);
_revokeRole(role, account);
}
/**
* @dev See {IVFAccessControl-selectNextMinter}.
*/
function selectNextMinter()
external
onlyRole(SALES_CONTRACT_ROLE)
returns (address payable)
{
address nextMinter = minterAddresses[_currentMinterIndex];
if (_currentMinterIndex + 1 < minterAddresses.length) {
_currentMinterIndex++;
} else {
_currentMinterIndex = 0;
}
return payable(nextMinter);
}
/**
* @dev See {IVFAccessControl-grantMinterRole}.
*/
function grantMinterRole(address minter)
external
onlyRole(DEFAULT_ADMIN_ROLE)
{
_grantRole(MINTER_ROLE, minter);
minterAddresses.push(minter);
_currentMinterIndex = 0;
}
/**
* @dev See {IVFAccessControl-revokeMinterRole}.
*/
function revokeMinterRole(address minter)
external
onlyRole(DEFAULT_ADMIN_ROLE)
{
_revokeRole(MINTER_ROLE, minter);
uint256 index;
for (index = 0; index < minterAddresses.length; index++) {
if (minter == minterAddresses[index]) {
minterAddresses[index] = minterAddresses[
minterAddresses.length - 1
];
break;
}
}
minterAddresses.pop();
_currentMinterIndex = 0;
}
/**
* @dev See {IVFAccessControl-fundMinters}.
*/
function fundMinters() external payable nonReentrant {
uint256 totalMinters = minterAddresses.length;
uint256 amount = msg.value / totalMinters;
for (uint256 index = 0; index < totalMinters; index++) {
payable(minterAddresses[index]).transfer(amount);
}
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event. Note that unlike {grantRole}, this function doesn't perform any
* checks on the calling account.
*
* [WARNING]
* ====
* This function should only be called from the constructor when setting
* up the initial roles for the system.
*
* Using this function in any other way is effectively circumventing the admin
* system imposed by {AccessControl}.
* ====
*
* NOTE: This function is deprecated in favor of {_grantRole}.
*/
function _setupRole(bytes32 role, address account) internal virtual {
_grantRole(role, account);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
bytes32 previousAdminRole = getRoleAdmin(role);
_roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Grants `role` to `account`.
*
* Internal function without access restriction.
*/
function _grantRole(bytes32 role, address account) internal virtual {
if (!hasRole(role, account)) {
_roles[role].members[account] = true;
emit RoleGranted(role, account, _msgSender());
}
}
/**
* @dev Revokes `role` from `account`.
*
* Internal function without access restriction.
*/
function _revokeRole(bytes32 role, address account) internal virtual {
if (hasRole(role, account)) {
_roles[role].members[account] = false;
emit RoleRevoked(role, account, _msgSender());
}
}
/**
* @dev Widthraw balance on contact to msg sender
*
* Requirements:
*
* - the caller must be an admin role
*/
function withdrawMoney() external onlyRole(DEFAULT_ADMIN_ROLE) {
address payable to = payable(_msgSender());
to.transfer(address(this).balance);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
import "./IVFRoyalties.sol";
import "./VFAccessControl.sol";
import "@openzeppelin/contracts/utils/Context.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165.sol";
contract VFRoyalties is IVFRoyalties, Context, ERC165 {
//Struct for maintaining royalty information
struct RoyaltyInfo {
address receiver;
uint96 royaltyFraction;
}
//Default royalty informations
RoyaltyInfo private _defaultRoyaltyInfo;
//Contract address to royalty information map
mapping(address => RoyaltyInfo) private _contractRoyalInfo;
//Contract for function access control
VFAccessControl private _controlContract;
/**
* @dev Initializes the contract by setting a `controlContractAddress`, `defaultReceiver`,
* and `defaultFeeNumerator` for the royalties contract.
*/
constructor(
address controlContractAddress,
address defaultReceiver,
uint96 defaultFeeNumerator
) {
_controlContract = VFAccessControl(controlContractAddress);
setDefaultRoyalty(defaultReceiver, defaultFeeNumerator);
}
modifier onlyRole(bytes32 role) {
_controlContract.checkRole(role, _msgSender());
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165)
returns (bool)
{
return
interfaceId == type(IVFRoyalties).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IVFRoyalties-setControlContract}.
*/
function setControlContract(address controlContractAddress)
external
onlyRole(_controlContract.getAdminRole())
{
require(
IERC165(controlContractAddress).supportsInterface(
type(IVFAccessControl).interfaceId
),
"Contract does not support required interface"
);
_controlContract = VFAccessControl(controlContractAddress);
}
/**
* @dev See {IVFRoyalties-royaltyInfo}.
*/
function royaltyInfo(
uint256,
address contractAddress,
uint256 salePrice
) external view returns (address receiver, uint256 royaltyAmount) {
RoyaltyInfo memory contractRoyaltyInfo = _contractRoyalInfo[
contractAddress
];
if (contractRoyaltyInfo.receiver == address(0)) {
contractRoyaltyInfo = _defaultRoyaltyInfo;
}
royaltyAmount =
(salePrice * contractRoyaltyInfo.royaltyFraction) /
_feeDenominator();
return (contractRoyaltyInfo.receiver, royaltyAmount);
}
/**
* @dev See {IVFRoyalties-setDefaultRoyalty}.
*/
function setDefaultRoyalty(address receiver, uint96 feeNumerator)
public
virtual
onlyRole(_controlContract.getAdminRole())
{
require(
feeNumerator <= _feeDenominator(),
"ERC2981: royalty fee will exceed salePrice"
);
require(receiver != address(0), "ERC2981: invalid receiver");
_defaultRoyaltyInfo = RoyaltyInfo(receiver, feeNumerator);
}
/**
* @dev See {IVFRoyalties-deleteDefaultRoyalty}.
*/
function deleteDefaultRoyalty()
external
virtual
onlyRole(_controlContract.getAdminRole())
{
delete _defaultRoyaltyInfo;
}
/**
* @dev See {IVFRoyalties-setContractRoyalties}.
*/
function setContractRoyalties(
address contractAddress,
address receiver,
uint96 feeNumerator
) external onlyRole(_controlContract.getAdminRole()) {
require(
feeNumerator <= _feeDenominator(),
"ERC2981: royalty fee will exceed salePrice"
);
require(receiver != address(0), "ERC2981: invalid receiver");
_contractRoyalInfo[contractAddress] = RoyaltyInfo(
receiver,
feeNumerator
);
}
/**
* @dev See {IVFRoyalties-resetContractRoyalty}.
*/
function resetContractRoyalty(address contractAddress)
external
virtual
onlyRole(_controlContract.getAdminRole())
{
delete _contractRoyalInfo[contractAddress];
}
/**
* @dev Get the fee denominator
*/
function _feeDenominator() internal pure virtual returns (uint96) {
return 10000;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
import "./erc721vf/contracts/ERC721VF.sol";
import "./VFAccessControl.sol";
import "./IVFAccessControl.sol";
import "./VFRoyalties.sol";
import "./IVFRoyalties.sol";
import "@openzeppelin/contracts/utils/Context.sol";
import "@openzeppelin/contracts/interfaces/IERC2981.sol";
contract VFToken is ERC721VF, IERC2981 {
//Token base URI
string private _baseUri;
//Flag to permanently lock minting
bool public mintingPermanentlyLocked = false;
//Flag to activate or disable minting
bool public isMintActive = false;
//Flag to activate or disable burning
bool public isBurnActive = false;
//Contract for function access control
VFAccessControl private _controlContract;
//Contract for royalties
VFRoyalties private _royaltiesContract;
/**
* @dev Initializes the contract by setting a `initialBaseUri`, `name`, `symbol`,
* and a `controlContractAddress` to the token collection.
*/
constructor(
string memory initialBaseUri,
string memory name,
string memory symbol,
address controlContractAddress
) ERC721VF(name, symbol) {
_controlContract = VFAccessControl(controlContractAddress);
setBaseURI(initialBaseUri);
}
modifier onlyRole(bytes32 role) {
_controlContract.checkRole(role, _msgSender());
_;
}
modifier onlyRoles(bytes32[] memory roles) {
bool hasRequiredRole = false;
for (uint256 i; i < roles.length; i++) {
bytes32 role = roles[i];
if (_controlContract.hasRole(role, _msgSender())) {
hasRequiredRole = true;
break;
}
}
require(hasRequiredRole, "Missing required role");
_;
}
modifier notLocked() {
require(!mintingPermanentlyLocked, "Minting permanently locked");
_;
}
modifier mintActive() {
require(isMintActive, "Mint is not active");
_;
}
modifier burnActive() {
require(isBurnActive, "Burn is not active");
_;
}
/**
* @dev Get the base token URI
*/
function _baseURI() internal view virtual override returns (string memory) {
return _baseUri;
}
/**
* @dev Update the base token URI
*
* Requirements:
*
* - the caller must be an admin role
*/
function setBaseURI(string memory baseUri)
public
onlyRole(_controlContract.getAdminRole())
{
_baseUri = baseUri;
}
/**
* @dev Update the access control contract
*
* Requirements:
*
* - the caller must be an admin role
* - `controlContractAddress` must support the IVFAccesControl interface
*/
function setControlContract(address controlContractAddress)
external
onlyRole(_controlContract.getAdminRole())
{
require(
IERC165(controlContractAddress).supportsInterface(
type(IVFAccessControl).interfaceId
),
"Contract does not support required interface"
);
_controlContract = VFAccessControl(controlContractAddress);
}
/**
* @dev Update the royalties contract
*
* Requirements:
*
* - the caller must be an admin role
* - `royaltiesContractAddress` must support the IVFRoyalties interface
*/
function setRoyaltiesContract(address royaltiesContractAddress)
external
onlyRole(_controlContract.getAdminRole())
{
require(
IERC165(royaltiesContractAddress).supportsInterface(
type(IVFRoyalties).interfaceId
),
"Contract does not support required interface"
);
_royaltiesContract = VFRoyalties(royaltiesContractAddress);
}
/**
* @dev Permanently lock minting
*
* Requirements:
*
* - the caller must be an admin role
*/
function lockMintingPermanently()
external
onlyRole(_controlContract.getAdminRole())
{
mintingPermanentlyLocked = true;
}
/**
* @dev Set the active/inactive state of minting
*
* Requirements:
*
* - the caller must be an admin role
*/
function toggleMintActive()
external
onlyRole(_controlContract.getAdminRole())
{
isMintActive = !isMintActive;
}
/**
* @dev Set the active/inactive state of burning
*
* Requirements:
*
* - the caller must be an admin role
*/
function toggleBurnActive()
external
onlyRole(_controlContract.getAdminRole())
{
isBurnActive = !isBurnActive;
}
/**
* @dev Airdrop `addresses` for `quantity` starting at `startTokenId`
*
* Requirements:
*
* - the caller must be a minter role
* - minting must not be locked and must be active
* - `addresses` and `quantities` must have the same length
*/
function airdrop(
address[] memory addresses,
uint16[] memory quantities,
uint256 startTokenId
)
external
onlyRoles(_controlContract.getMinterRoles())
notLocked
mintActive
{
require(
addresses.length == quantities.length,
"Address and quantities need to be equal length"
);
for (uint256 i; i < addresses.length; i++) {
startTokenId = _mintBatch(
addresses[i],
quantities[i],
startTokenId
);
}
}
/**
* @dev Airdrop `addresses` for `quantity` starting at `startTokenId`
*
* Requirements:
*
* - the caller must be a minter role
* - minting must not be locked and must be active
* - `addresses` and `quantities` must have the same length
*/
function safeAirdrop(
address[] memory addresses,
uint16[] memory quantities,
uint256 startTokenId
)
external
onlyRoles(_controlContract.getMinterRoles())
notLocked
mintActive
{
require(
addresses.length == quantities.length,
"Address and quantities need to be equal length"
);
for (uint256 i; i < addresses.length; i++) {
startTokenId = _safeMintBatch(
addresses[i],
quantities[i],
startTokenId
);
}
}
/**
* @dev mint batch `to` for `quantity` starting at `startTokenId`
*
* Requirements:
*
* - the caller must be a minter role
* - minting must not be locked and must be active
*/
function mintBatch(
address to,
uint8 quantity,
uint256 startTokenId
)
external
onlyRoles(_controlContract.getMinterRoles())
notLocked
mintActive
{
_mintBatch(to, quantity, startTokenId);
}
/**
* @dev mint batch `to` for `quantity` starting at `startTokenId`
*
* Requirements:
*
* - the caller must be a minter role
* - minting must not be locked and must be active
*/
function safeMintBatch(
address to,
uint8 quantity,
uint256 startTokenId
)
external
onlyRoles(_controlContract.getMinterRoles())
notLocked
mintActive
{
_safeMintBatch(to, quantity, startTokenId);
}
/**
* @dev mint `to` token `tokenId`
*
* Requirements:
*
* - the caller must be a minter role
* - minting must not be locked and must be active
*/
function mint(address to, uint256 tokenId)
external
onlyRoles(_controlContract.getMinterRoles())
notLocked
mintActive
{
_mint(to, tokenId);
}
/**
* @dev mint `to` token `tokenId`
*
* Requirements:
*
* - the caller must be a minter role
* - minting must not be locked and must be active
*/
function safeMint(address to, uint256 tokenId)
external
onlyRoles(_controlContract.getMinterRoles())
notLocked
mintActive
{
_safeMint(to, tokenId);
}
/**
* @dev burn `from` token `tokenId`
*
* Requirements:
*
* - the caller must be a burner role
* - burning must be active
*/
function burn(address from, uint256 tokenId)
external
onlyRole(_controlContract.getBurnerRole())
burnActive
{
_burn(from, tokenId);
}
/**
* @dev Get royalty information for a token based on the `salePrice`
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount)
{
return
_royaltiesContract.royaltyInfo(tokenId, address(this), salePrice);
}
/**
* @dev Widthraw balance on contact to msg sender
*
* Requirements:
*
* - the caller must be an admin role
*/
function withdrawMoney()
external
onlyRole(_controlContract.getAdminRole())
{
address payable to = payable(_msgSender());
to.transfer(address(this).balance);
}
}
{
"compilationTarget": {
"contracts/VFToken.sol": "VFToken"
},
"evmVersion": "london",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": false,
"runs": 200
},
"remappings": []
}
[{"inputs":[{"internalType":"string","name":"initialBaseUri","type":"string"},{"internalType":"string","name":"name","type":"string"},{"internalType":"string","name":"symbol","type":"string"},{"internalType":"address","name":"controlContractAddress","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"approved","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":false,"internalType":"bool","name":"approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[{"internalType":"address[]","name":"addresses","type":"address[]"},{"internalType":"uint16[]","name":"quantities","type":"uint16[]"},{"internalType":"uint256","name":"startTokenId","type":"uint256"}],"name":"airdrop","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"approve","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"burn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getApproved","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"isBurnActive","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"isMintActive","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"lockMintingPermanently","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"mint","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint8","name":"quantity","type":"uint8"},{"internalType":"uint256","name":"startTokenId","type":"uint256"}],"name":"mintBatch","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"mintingPermanentlyLocked","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"ownerOf","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"salePrice","type":"uint256"}],"name":"royaltyInfo","outputs":[{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint256","name":"royaltyAmount","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address[]","name":"addresses","type":"address[]"},{"internalType":"uint16[]","name":"quantities","type":"uint16[]"},{"internalType":"uint256","name":"startTokenId","type":"uint256"}],"name":"safeAirdrop","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"safeMint","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint8","name":"quantity","type":"uint8"},{"internalType":"uint256","name":"startTokenId","type":"uint256"}],"name":"safeMintBatch","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"string","name":"baseUri","type":"string"}],"name":"setBaseURI","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"controlContractAddress","type":"address"}],"name":"setControlContract","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"royaltiesContractAddress","type":"address"}],"name":"setRoyaltiesContract","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"toggleBurnActive","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"toggleMintActive","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"tokenURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"tokensOfOwner","outputs":[{"internalType":"uint256[]","name":"ownerTokens","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"startIndex","type":"uint256"},{"internalType":"uint256","name":"endIndex","type":"uint256"}],"name":"tokensOfOwnerIn","outputs":[{"internalType":"uint256[]","name":"ownerTokens","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalBurned","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalMinted","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"transferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"withdrawMoney","outputs":[],"stateMutability":"nonpayable","type":"function"}]