Contract Name:
ERC20LockableToken
Contract Source Code:
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/math/SafeMath.sol";
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
interface ERC721AutoIdMinterExtensionInterface {
function setMaxSupply(uint256 newValue) external;
function freezeMaxSupply() external;
function totalSupply() external view returns (uint256);
}
/**
* @dev Extension to add minting capability with an auto incremented ID for each token and a maximum supply setting.
*/
abstract contract ERC721AutoIdMinterExtension is
Ownable,
ERC165Storage,
ERC721,
ERC721AutoIdMinterExtensionInterface
{
using SafeMath for uint256;
uint256 public maxSupply;
bool internal _maxSupplyFrozen;
uint256 internal _currentTokenId = 0;
constructor(uint256 _maxSupply) {
maxSupply = _maxSupply;
_registerInterface(
type(ERC721AutoIdMinterExtensionInterface).interfaceId
);
_registerInterface(type(IERC721).interfaceId);
}
// ADMIN
function setMaxSupply(uint256 newValue) external onlyOwner {
require(!_maxSupplyFrozen, "BASE_URI_FROZEN");
maxSupply = newValue;
}
function freezeMaxSupply() external onlyOwner {
_maxSupplyFrozen = true;
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function totalSupply() public view returns (uint256) {
return _currentTokenId;
}
// INTERNAL
function _mintTo(address to, uint256 count) internal {
require(totalSupply() + count <= maxSupply, "EXCEEDS_MAX_SUPPLY");
for (uint256 i = 0; i < count; i++) {
uint256 newTokenId = _getNextTokenId();
_safeMint(to, newTokenId);
_incrementTokenId();
}
}
/**
* Calculates the next token ID based on value of _currentTokenId
* @return uint256 for the next token ID
*/
function _getNextTokenId() internal view returns (uint256) {
return _currentTokenId.add(1);
}
/**
* Increments the value of _currentTokenId
*/
function _incrementTokenId() internal {
_currentTokenId++;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (utils/math/SafeMath.sol)
pragma solidity ^0.8.0;
// CAUTION
// This version of SafeMath should only be used with Solidity 0.8 or later,
// because it relies on the compiler's built in overflow checks.
/**
* @dev Wrappers over Solidity's arithmetic operations.
*
* NOTE: `SafeMath` is generally not needed starting with Solidity 0.8, since the compiler
* now has built in overflow checking.
*/
library SafeMath {
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
// 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 (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @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) {
return a + b;
}
/**
* @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 a - b;
}
/**
* @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) {
return a * b;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator.
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting 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 a % b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {trySub}.
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(
uint256 a,
uint256 b,
string memory errorMessage
) internal pure returns (uint256) {
unchecked {
require(b <= a, errorMessage);
return a - b;
}
}
/**
* @dev Returns the integer division of two unsigned integers, reverting 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) {
unchecked {
require(b > 0, errorMessage);
return a / b;
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting with custom message when dividing by zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryMod}.
*
* 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) {
unchecked {
require(b > 0, errorMessage);
return a % b;
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.0;
import "./IERC721.sol";
import "./IERC721Receiver.sol";
import "./extensions/IERC721Metadata.sol";
import "../../utils/Address.sol";
import "../../utils/Context.sol";
import "../../utils/Strings.sol";
import "../../utils/introspection/ERC165.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension, but not including the Enumerable extension, which is available separately as
* {ERC721Enumerable}.
*/
contract ERC721 is Context, ERC165, IERC721, IERC721Metadata {
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;
/**
* @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 ||
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 overridden 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 = ERC721.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 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 = ERC721.ownerOf(tokenId);
return (spender == owner || isApprovedForAll(owner, spender) || getApproved(tokenId) == 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 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;
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, 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 = ERC721.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);
}
/**
* @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(ERC721.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner");
require(to != address(0), "ERC721: 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(ERC721.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/ERC165Storage.sol)
pragma solidity ^0.8.0;
import "./ERC165.sol";
/**
* @dev Storage based implementation of the {IERC165} interface.
*
* Contracts may inherit from this and call {_registerInterface} to declare
* their support of an interface.
*/
abstract contract ERC165Storage is ERC165 {
/**
* @dev Mapping of interface ids to whether or not it's supported.
*/
mapping(bytes4 => bool) private _supportedInterfaces;
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return super.supportsInterface(interfaceId) || _supportedInterfaces[interfaceId];
}
/**
* @dev Registers the contract as an implementer of the interface defined by
* `interfaceId`. Support of the actual ERC165 interface is automatic and
* registering its interface id is not required.
*
* See {IERC165-supportsInterface}.
*
* Requirements:
*
* - `interfaceId` cannot be the ERC165 invalid interface (`0xffffffff`).
*/
function _registerInterface(bytes4 interfaceId) internal virtual {
require(interfaceId != 0xffffffff, "ERC165: invalid interface id");
_supportedInterfaces[interfaceId] = true;
}
}
// 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 (last updated v4.6.0) (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`.
*
* 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;
/**
* @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 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 the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @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);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (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 `IERC721Receiver.onERC721Received.selector`.
*/
function onERC721Received(
address operator,
address from,
uint256 tokenId,
bytes calldata data
) external returns (bytes4);
}
// 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 (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/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
// 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 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: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "../../../common/meta-transactions/ERC2771ContextOwnable.sol";
import "../extensions/ERC721CollectionMetadataExtension.sol";
import "../extensions/ERC721PerTokenMetadataExtension.sol";
import "../extensions/ERC721OneOfOneMintExtension.sol";
import "../extensions/ERC721AutoIdMinterExtension.sol";
import "../extensions/ERC721OwnerMintExtension.sol";
import "../extensions/ERC721RoyaltyExtension.sol";
import "../extensions/ERC721OpenSeaNoGasExtension.sol";
contract ERC721OneOfOneCollection is
Ownable,
ERC165Storage,
ERC2771ContextOwnable,
ERC721,
ERC721AutoIdMinterExtension,
ERC721CollectionMetadataExtension,
ERC721OwnerMintExtension,
ERC721PerTokenMetadataExtension,
ERC721OneOfOneMintExtension,
ERC721RoyaltyExtension,
ERC721OpenSeaNoGasExtension
{
struct Config {
string name;
string symbol;
string contractURI;
uint256 maxSupply;
address defaultRoyaltyAddress;
uint16 defaultRoyaltyBps;
address openSeaProxyRegistryAddress;
address openSeaExchangeAddress;
address trustedForwarder;
}
constructor(Config memory config)
ERC721(config.name, config.symbol)
ERC721CollectionMetadataExtension(config.contractURI)
ERC721PerTokenMetadataExtension()
ERC721OneOfOneMintExtension()
ERC721AutoIdMinterExtension(config.maxSupply)
ERC721RoyaltyExtension(
config.defaultRoyaltyAddress,
config.defaultRoyaltyBps
)
ERC721OpenSeaNoGasExtension(
config.openSeaProxyRegistryAddress,
config.openSeaExchangeAddress
)
ERC2771ContextOwnable(config.trustedForwarder)
{
_setupRole(DEFAULT_ADMIN_ROLE, _msgSender());
_setupRole(MINTER_ROLE, _msgSender());
}
function _burn(uint256 tokenId)
internal
virtual
override(ERC721, ERC721OneOfOneMintExtension, ERC721URIStorage)
{
return ERC721OneOfOneMintExtension._burn(tokenId);
}
function _msgSender()
internal
view
virtual
override(ERC2771ContextOwnable, Context)
returns (address sender)
{
return super._msgSender();
}
function _msgData()
internal
view
virtual
override(ERC2771ContextOwnable, Context)
returns (bytes calldata)
{
return super._msgData();
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(
ERC165Storage,
ERC721,
ERC721AutoIdMinterExtension,
ERC721CollectionMetadataExtension,
ERC721OwnerMintExtension,
ERC721OneOfOneMintExtension,
ERC721PerTokenMetadataExtension,
ERC721RoyaltyExtension,
ERC721OpenSeaNoGasExtension
)
returns (bool)
{
return
ERC721.supportsInterface(interfaceId) ||
ERC165Storage.supportsInterface(interfaceId);
}
/**
* Override isApprovedForAll to whitelist user's OpenSea proxy accounts to enable gas-less listings.
*/
function isApprovedForAll(address owner, address operator)
public
view
override(ERC721, ERC721OpenSeaNoGasExtension)
returns (bool)
{
return super.isApprovedForAll(owner, operator);
}
function tokenURI(uint256 _tokenId)
public
view
virtual
override(ERC721, ERC721OneOfOneMintExtension, ERC721URIStorage)
returns (string memory)
{
return ERC721OneOfOneMintExtension.tokenURI(_tokenId);
}
function getInfo()
external
view
returns (
uint256 _maxSupply,
uint256 _totalSupply,
uint256 _senderBalance
)
{
uint256 balance = 0;
if (_msgSender() != address(0)) {
balance = this.balanceOf(_msgSender());
}
return (maxSupply, this.totalSupply(), balance);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/utils/Context.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
/**
* @dev Context variant with ERC2771 support.
*/
abstract contract ERC2771ContextOwnable is Context, Ownable {
address public _trustedForwarder;
/// @custom:oz-upgrades-unsafe-allow constructor
constructor(address trustedForwarder) {
_trustedForwarder = trustedForwarder;
}
function setTrustedForwarder(address trustedForwarder) public onlyOwner {
_trustedForwarder = trustedForwarder;
}
function isTrustedForwarder(address forwarder)
public
view
virtual
returns (bool)
{
return forwarder == _trustedForwarder;
}
function _msgSender()
internal
view
virtual
override
returns (address sender)
{
if (isTrustedForwarder(msg.sender)) {
// The assembly code is more direct than the Solidity version using `abi.decode`.
assembly {
sender := shr(96, calldataload(sub(calldatasize(), 20)))
}
} else {
return super._msgSender();
}
}
function _msgData()
internal
view
virtual
override
returns (bytes calldata)
{
if (isTrustedForwarder(msg.sender)) {
return msg.data[:msg.data.length - 20];
} else {
return super._msgData();
}
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol";
interface ERC721CollectionMetadataExtensionInterface {
function setContractURI(string memory newValue) external;
function contractURI() external view returns (string memory);
}
/**
* @dev Extension to allow configuring contract-level collection metadata URI.
*/
abstract contract ERC721CollectionMetadataExtension is
Ownable,
ERC165Storage,
ERC721CollectionMetadataExtensionInterface
{
string private _contractURI;
constructor(string memory contractURI_) {
_contractURI = contractURI_;
_registerInterface(
type(ERC721CollectionMetadataExtensionInterface).interfaceId
);
_registerInterface(type(IERC721Metadata).interfaceId);
}
// ADMIN
function setContractURI(string memory newValue) external onlyOwner {
_contractURI = newValue;
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function contractURI() public view returns (string memory) {
return _contractURI;
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
import "@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
interface ERC721PerTokenMetadataExtensionInterface {
function freezeTokenURIs(uint256 _lastFrozenTokenId) external;
function setTokenURI(uint256 tokenId, string memory tokenURI) external;
}
/**
* @dev Extension to allow configuring collection and tokens metadata URI.
* In this extension each token will have a different independent token URI set by contract owner.
* To enable true self-custody for token owners, an admin can freeze URIs using a token ID pointer that can only be increased.
*/
abstract contract ERC721PerTokenMetadataExtension is
Ownable,
ERC165Storage,
ERC721URIStorage,
ERC721PerTokenMetadataExtensionInterface
{
uint256 public lastFrozenTokenId;
constructor() {
_registerInterface(
type(ERC721PerTokenMetadataExtensionInterface).interfaceId
);
}
// ADMIN
function freezeTokenURIs(uint256 _lastFrozenTokenId) external onlyOwner {
require(_lastFrozenTokenId > lastFrozenTokenId, "CANNOT_UNFREEZE");
lastFrozenTokenId = _lastFrozenTokenId;
}
function setTokenURI(uint256 tokenId, string memory tokenURI)
external
onlyOwner
{
require(tokenId > lastFrozenTokenId, "FROZEN_TOKEN");
_setTokenURI(tokenId, tokenURI);
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/access/AccessControl.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "./ERC721AutoIdMinterExtension.sol";
import "./ERC721PerTokenMetadataExtension.sol";
interface ERC721OneOfOneMintExtensionInterface {
function mintWithTokenURIsByOwner(
address to,
uint256 count,
string[] memory tokenURIs
) external;
function mintWithTokenURIsByRole(
address to,
uint256 count,
string[] memory tokenURIs
) external;
function tokenURI(uint256 tokenId) external view returns (string memory);
}
/**
* @dev Extension to allow owner to mint 1-of-1 NFTs by providing dedicated metadata URI for each token.
*/
abstract contract ERC721OneOfOneMintExtension is
Ownable,
ERC165Storage,
AccessControl,
ERC721AutoIdMinterExtension,
ERC721PerTokenMetadataExtension,
ERC721OneOfOneMintExtensionInterface
{
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
constructor() {
_registerInterface(
type(ERC721OneOfOneMintExtensionInterface).interfaceId
);
}
// ADMIN
function mintWithTokenURIsByOwner(
address to,
uint256 count,
string[] memory tokenURIs
) external onlyOwner {
uint256 startingTokenId = _getNextTokenId();
_mintTo(to, count);
for (uint256 i = 0; i < count; i++) {
_setTokenURI(startingTokenId + i, tokenURIs[i]);
}
}
function mintWithTokenURIsByRole(
address to,
uint256 count,
string[] memory tokenURIs
) external {
require(hasRole(MINTER_ROLE, _msgSender()), "NOT_MINTER_ROLE");
uint256 startingTokenId = _getNextTokenId();
_mintTo(to, count);
for (uint256 i = 0; i < count; i++) {
_setTokenURI(startingTokenId + i, tokenURIs[i]);
}
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(
ERC165Storage,
AccessControl,
ERC721AutoIdMinterExtension,
ERC721PerTokenMetadataExtension
)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function tokenURI(uint256 tokenId)
public
view
virtual
override(ERC721, ERC721URIStorage, ERC721OneOfOneMintExtensionInterface)
returns (string memory)
{
return ERC721URIStorage.tokenURI(tokenId);
}
function _burn(uint256 tokenId)
internal
virtual
override(ERC721, ERC721URIStorage)
{
return ERC721URIStorage._burn(tokenId);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "./ERC721AutoIdMinterExtension.sol";
interface ERC721OwnerMintExtensionInterface {
function mintByOwner(address to, uint256 count) external;
}
/**
* @dev Extension to allow owner to mint directly without paying.
*/
abstract contract ERC721OwnerMintExtension is
Ownable,
ERC165Storage,
ERC721AutoIdMinterExtension,
ERC721OwnerMintExtensionInterface
{
constructor() {
_registerInterface(type(ERC721OwnerMintExtensionInterface).interfaceId);
}
// ADMIN
function mintByOwner(address to, uint256 count) external onlyOwner {
_mintTo(to, count);
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721AutoIdMinterExtension)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@manifoldxyz/royalty-registry-solidity/contracts/overrides/IRoyaltyOverride.sol";
import "@manifoldxyz/royalty-registry-solidity/contracts/overrides/RoyaltyOverrideCore.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "../../../misc/rarible/IRoyalties.sol";
import "../../../misc/rarible/LibPart.sol";
import "../../../misc/rarible/LibRoyaltiesV2.sol";
interface ERC721RoyaltyExtensionInterface {
function setTokenRoyalties(
IEIP2981RoyaltyOverride.TokenRoyaltyConfig[] calldata royaltyConfigs
) external;
function setDefaultRoyalty(
IEIP2981RoyaltyOverride.TokenRoyalty calldata royalty
) external;
function getRaribleV2Royalties(uint256 id)
external
view
returns (LibPart.Part[] memory result);
}
/**
* @dev Extension to signal configured royalty to famous marketplaces as well as ERC2981.
*
* This extension currently supports Standard ERC2981, Rarible.
* Note that OpenSea is supported via Flair metadata feature.
*/
abstract contract ERC721RoyaltyExtension is
Ownable,
ERC165Storage,
EIP2981RoyaltyOverrideCore,
IRoyalties,
ERC721RoyaltyExtensionInterface
{
constructor(address defaultRoyaltyReceiver, uint16 defaultRoyaltyBps) {
TokenRoyalty memory royalty = TokenRoyalty(
defaultRoyaltyReceiver,
defaultRoyaltyBps
);
_setDefaultRoyalty(royalty);
_registerInterface(type(ERC721RoyaltyExtensionInterface).interfaceId);
_registerInterface(type(IEIP2981).interfaceId);
_registerInterface(type(IEIP2981RoyaltyOverride).interfaceId);
_registerInterface(LibRoyaltiesV2._INTERFACE_ID_ROYALTIES);
}
function setTokenRoyalties(TokenRoyaltyConfig[] calldata royaltyConfigs)
external
override(IEIP2981RoyaltyOverride, ERC721RoyaltyExtensionInterface)
onlyOwner
{
_setTokenRoyalties(royaltyConfigs);
}
function setDefaultRoyalty(TokenRoyalty calldata royalty)
external
override(IEIP2981RoyaltyOverride, ERC721RoyaltyExtensionInterface)
onlyOwner
{
_setDefaultRoyalty(royalty);
}
function getRaribleV2Royalties(uint256 id)
external
view
override(IRoyalties, ERC721RoyaltyExtensionInterface)
returns (LibPart.Part[] memory result)
{
result = new LibPart.Part[](1);
result[0].account = payable(defaultRoyalty.recipient);
result[0].value = defaultRoyalty.bps;
id;
// avoid unused param warning
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, EIP2981RoyaltyOverrideCore)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "../../../misc/opensea/ProxyRegistry.sol";
interface ERC721OpenSeaNoGasExtensionInterface {
function setOpenSeaProxyRegistryAddress(address addr) external;
function setOpenSeaExchangeAddress(address addr) external;
function isApprovedForAll(address owner, address operator)
external
view
returns (bool);
}
/**
* @dev Extension that automatically approves OpenSea to avoid having users to "Approve" your collection before trading.
*/
abstract contract ERC721OpenSeaNoGasExtension is
Ownable,
ERC165Storage,
ERC721,
ERC721OpenSeaNoGasExtensionInterface
{
address internal _openSeaProxyRegistryAddress;
address private _openSeaExchangeAddress;
constructor(
address openSeaProxyRegistryAddress,
address openSeaExchangeAddress
) {
_openSeaProxyRegistryAddress = openSeaProxyRegistryAddress;
_openSeaExchangeAddress = openSeaExchangeAddress;
_registerInterface(
type(ERC721OpenSeaNoGasExtensionInterface).interfaceId
);
}
// ADMIN
function setOpenSeaProxyRegistryAddress(address addr) external onlyOwner {
_openSeaProxyRegistryAddress = addr;
}
function setOpenSeaExchangeAddress(address addr) external onlyOwner {
_openSeaExchangeAddress = addr;
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
/**
* Override isApprovedForAll to whitelist user's OpenSea proxy accounts to enable gas-less listings.
*/
function isApprovedForAll(address owner, address operator)
public
view
virtual
override(ERC721, ERC721OpenSeaNoGasExtensionInterface)
returns (bool)
{
if (_openSeaProxyRegistryAddress != address(0)) {
// Whitelist OpenSea proxy contract for easy trading.
ProxyRegistry proxyRegistry = ProxyRegistry(
_openSeaProxyRegistryAddress
);
if (address(proxyRegistry.proxies(owner)) == operator) {
return true;
}
}
if (_openSeaExchangeAddress != address(0)) {
// If OpenSea's ERC721 exchange address is detected, auto-approve
if (operator == address(_openSeaExchangeAddress)) {
return true;
}
}
return super.isApprovedForAll(owner, operator);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/ERC721URIStorage.sol)
pragma solidity ^0.8.0;
import "../ERC721.sol";
/**
* @dev ERC721 token with storage based token URI management.
*/
abstract contract ERC721URIStorage is ERC721 {
using Strings for uint256;
// Optional mapping for token URIs
mapping(uint256 => string) private _tokenURIs;
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId) public view virtual override returns (string memory) {
require(_exists(tokenId), "ERC721URIStorage: URI query for nonexistent token");
string memory _tokenURI = _tokenURIs[tokenId];
string memory base = _baseURI();
// If there is no base URI, return the token URI.
if (bytes(base).length == 0) {
return _tokenURI;
}
// If both are set, concatenate the baseURI and tokenURI (via abi.encodePacked).
if (bytes(_tokenURI).length > 0) {
return string(abi.encodePacked(base, _tokenURI));
}
return super.tokenURI(tokenId);
}
/**
* @dev Sets `_tokenURI` as the tokenURI of `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function _setTokenURI(uint256 tokenId, string memory _tokenURI) internal virtual {
require(_exists(tokenId), "ERC721URIStorage: URI set of nonexistent token");
_tokenURIs[tokenId] = _tokenURI;
}
/**
* @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 override {
super._burn(tokenId);
if (bytes(_tokenURIs[tokenId]).length != 0) {
delete _tokenURIs[tokenId];
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (access/AccessControl.sol)
pragma solidity ^0.8.0;
import "./IAccessControl.sol";
import "../utils/Context.sol";
import "../utils/Strings.sol";
import "../utils/introspection/ERC165.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it.
*/
abstract contract AccessControl is Context, IAccessControl, ERC165 {
struct RoleData {
mapping(address => bool) members;
bytes32 adminRole;
}
mapping(bytes32 => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @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);
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual override returns (bool) {
return _roles[role].members[account];
}
/**
* @dev Revert with a standard message if `_msgSender()` is missing `role`.
* Overriding this function changes the behavior of the {onlyRole} modifier.
*
* Format of the revert message is described in {_checkRole}.
*
* _Available since v4.6._
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @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) internal 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 Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @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) public virtual override onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @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) public virtual override onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @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) public virtual override {
require(account == _msgSender(), "AccessControl: can only renounce roles for self");
_revokeRole(role, account);
}
/**
* @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());
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
pragma solidity ^0.8.0;
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControl {
/**
* @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 Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_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 granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @author: manifold.xyz
import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
/**
* Simple EIP2981 reference override implementation
*/
interface IEIP2981RoyaltyOverride is IERC165 {
event TokenRoyaltyRemoved(uint256 tokenId);
event TokenRoyaltySet(uint256 tokenId, address recipient, uint16 bps);
event DefaultRoyaltySet(address recipient, uint16 bps);
struct TokenRoyalty {
address recipient;
uint16 bps;
}
struct TokenRoyaltyConfig {
uint256 tokenId;
address recipient;
uint16 bps;
}
/**
* @dev Set per token royalties. Passing a recipient of address(0) will delete any existing configuration
*/
function setTokenRoyalties(TokenRoyaltyConfig[] calldata royalties) external;
/**
* @dev Get the number of token specific overrides. Used to enumerate over all configurations
*/
function getTokenRoyaltiesCount() external view returns(uint256);
/**
* @dev Get a token royalty configuration by index. Use in conjunction with getTokenRoyaltiesCount to get all per token configurations
*/
function getTokenRoyaltyByIndex(uint256 index) external view returns(TokenRoyaltyConfig memory);
/**
* @dev Set a default royalty configuration. Will be used if no token specific configuration is set
*/
function setDefaultRoyalty(TokenRoyalty calldata royalty) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/// @author: manifold.xyz
import "@openzeppelin/contracts/utils/introspection/ERC165.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import "./IRoyaltyOverride.sol";
import "../specs/IEIP2981.sol";
/**
* Simple EIP2981 reference override implementation
*/
abstract contract EIP2981RoyaltyOverrideCore is IEIP2981, IEIP2981RoyaltyOverride, ERC165 {
using EnumerableSet for EnumerableSet.UintSet;
TokenRoyalty public defaultRoyalty;
mapping(uint256 => TokenRoyalty) private _tokenRoyalties;
EnumerableSet.UintSet private _tokensWithRoyalties;
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
return interfaceId == type(IEIP2981).interfaceId || interfaceId == type(IEIP2981RoyaltyOverride).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Sets token royalties. When you override this in the implementation contract
* ensure that you access restrict it to the contract owner or admin
*/
function _setTokenRoyalties(TokenRoyaltyConfig[] memory royaltyConfigs) internal {
for (uint i = 0; i < royaltyConfigs.length; i++) {
TokenRoyaltyConfig memory royaltyConfig = royaltyConfigs[i];
require(royaltyConfig.bps < 10000, "Invalid bps");
if (royaltyConfig.recipient == address(0)) {
delete _tokenRoyalties[royaltyConfig.tokenId];
_tokensWithRoyalties.remove(royaltyConfig.tokenId);
emit TokenRoyaltyRemoved(royaltyConfig.tokenId);
} else {
_tokenRoyalties[royaltyConfig.tokenId] = TokenRoyalty(royaltyConfig.recipient, royaltyConfig.bps);
_tokensWithRoyalties.add(royaltyConfig.tokenId);
emit TokenRoyaltySet(royaltyConfig.tokenId, royaltyConfig.recipient, royaltyConfig.bps);
}
}
}
/**
* @dev Sets default royalty. When you override this in the implementation contract
* ensure that you access restrict it to the contract owner or admin
*/
function _setDefaultRoyalty(TokenRoyalty memory royalty) internal {
require(royalty.bps < 10000, "Invalid bps");
defaultRoyalty = TokenRoyalty(royalty.recipient, royalty.bps);
emit DefaultRoyaltySet(royalty.recipient, royalty.bps);
}
/**
* @dev See {IEIP2981RoyaltyOverride-getTokenRoyaltiesCount}.
*/
function getTokenRoyaltiesCount() external override view returns(uint256) {
return _tokensWithRoyalties.length();
}
/**
* @dev See {IEIP2981RoyaltyOverride-getTokenRoyaltyByIndex}.
*/
function getTokenRoyaltyByIndex(uint256 index) external override view returns(TokenRoyaltyConfig memory) {
uint256 tokenId = _tokensWithRoyalties.at(index);
TokenRoyalty memory royalty = _tokenRoyalties[tokenId];
return TokenRoyaltyConfig(tokenId, royalty.recipient, royalty.bps);
}
/**
* @dev See {IEIP2981RoyaltyOverride-royaltyInfo}.
*/
function royaltyInfo(uint256 tokenId, uint256 value) public override view returns (address, uint256) {
if (_tokenRoyalties[tokenId].recipient != address(0)) {
return (_tokenRoyalties[tokenId].recipient, value*_tokenRoyalties[tokenId].bps/10000);
}
if (defaultRoyalty.recipient != address(0) && defaultRoyalty.bps != 0) {
return (defaultRoyalty.recipient, value*defaultRoyalty.bps/10000);
}
return (address(0), 0);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.9;
pragma abicoder v2;
import "./LibPart.sol";
interface IRoyalties {
function getRaribleV2Royalties(uint256 id)
external
view
returns (LibPart.Part[] memory);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.9;
library LibPart {
bytes32 public constant TYPE_HASH =
keccak256("Part(address account,uint96 value)");
struct Part {
address payable account;
uint96 value;
}
function hash(Part memory part) internal pure returns (bytes32) {
return keccak256(abi.encode(TYPE_HASH, part.account, part.value));
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.9;
library LibRoyaltiesV2 {
/*
* bytes4(keccak256('getRaribleV2Royalties(uint256)')) == 0xcad96cca
*/
bytes4 constant _INTERFACE_ID_ROYALTIES = 0xcad96cca;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (utils/structs/EnumerableSet.sol)
pragma solidity ^0.8.0;
/**
* @dev Library for managing
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
* types.
*
* Sets have the following properties:
*
* - Elements are added, removed, and checked for existence in constant time
* (O(1)).
* - Elements are enumerated in O(n). No guarantees are made on the ordering.
*
* ```
* contract Example {
* // Add the library methods
* using EnumerableSet for EnumerableSet.AddressSet;
*
* // Declare a set state variable
* EnumerableSet.AddressSet private mySet;
* }
* ```
*
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
* and `uint256` (`UintSet`) are supported.
*/
library EnumerableSet {
// To implement this library for multiple types with as little code
// repetition as possible, we write it in terms of a generic Set type with
// bytes32 values.
// The Set implementation uses private functions, and user-facing
// implementations (such as AddressSet) are just wrappers around the
// underlying Set.
// This means that we can only create new EnumerableSets for types that fit
// in bytes32.
struct Set {
// Storage of set values
bytes32[] _values;
// Position of the value in the `values` array, plus 1 because index 0
// means a value is not in the set.
mapping(bytes32 => uint256) _indexes;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function _add(Set storage set, bytes32 value) private returns (bool) {
if (!_contains(set, value)) {
set._values.push(value);
// The value is stored at length-1, but we add 1 to all indexes
// and use 0 as a sentinel value
set._indexes[value] = set._values.length;
return true;
} else {
return false;
}
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function _remove(Set storage set, bytes32 value) private returns (bool) {
// We read and store the value's index to prevent multiple reads from the same storage slot
uint256 valueIndex = set._indexes[value];
if (valueIndex != 0) {
// Equivalent to contains(set, value)
// To delete an element from the _values array in O(1), we swap the element to delete with the last one in
// the array, and then remove the last element (sometimes called as 'swap and pop').
// This modifies the order of the array, as noted in {at}.
uint256 toDeleteIndex = valueIndex - 1;
uint256 lastIndex = set._values.length - 1;
if (lastIndex != toDeleteIndex) {
bytes32 lastValue = set._values[lastIndex];
// Move the last value to the index where the value to delete is
set._values[toDeleteIndex] = lastValue;
// Update the index for the moved value
set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
}
// Delete the slot where the moved value was stored
set._values.pop();
// Delete the index for the deleted slot
delete set._indexes[value];
return true;
} else {
return false;
}
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function _contains(Set storage set, bytes32 value) private view returns (bool) {
return set._indexes[value] != 0;
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function _length(Set storage set) private view returns (uint256) {
return set._values.length;
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function _at(Set storage set, uint256 index) private view returns (bytes32) {
return set._values[index];
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function _values(Set storage set) private view returns (bytes32[] memory) {
return set._values;
}
// Bytes32Set
struct Bytes32Set {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _add(set._inner, value);
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _remove(set._inner, value);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
return _contains(set._inner, value);
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(Bytes32Set storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
return _at(set._inner, index);
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
return _values(set._inner);
}
// AddressSet
struct AddressSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(AddressSet storage set, address value) internal returns (bool) {
return _add(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(AddressSet storage set, address value) internal returns (bool) {
return _remove(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(AddressSet storage set, address value) internal view returns (bool) {
return _contains(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(AddressSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(AddressSet storage set, uint256 index) internal view returns (address) {
return address(uint160(uint256(_at(set._inner, index))));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(AddressSet storage set) internal view returns (address[] memory) {
bytes32[] memory store = _values(set._inner);
address[] memory result;
assembly {
result := store
}
return result;
}
// UintSet
struct UintSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(UintSet storage set, uint256 value) internal returns (bool) {
return _add(set._inner, bytes32(value));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(UintSet storage set, uint256 value) internal returns (bool) {
return _remove(set._inner, bytes32(value));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(UintSet storage set, uint256 value) internal view returns (bool) {
return _contains(set._inner, bytes32(value));
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function length(UintSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(UintSet storage set, uint256 index) internal view returns (uint256) {
return uint256(_at(set._inner, index));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(UintSet storage set) internal view returns (uint256[] memory) {
bytes32[] memory store = _values(set._inner);
uint256[] memory result;
assembly {
result := store
}
return result;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* EIP-2981
*/
interface IEIP2981 {
/**
* bytes4(keccak256("royaltyInfo(uint256,uint256)")) == 0x2a55205a
*
* => 0x2a55205a = 0x2a55205a
*/
function royaltyInfo(uint256 tokenId, uint256 value) external view returns (address, uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.9;
contract OwnableDelegateProxy {}
contract ProxyRegistry {
mapping(address => OwnableDelegateProxy) public proxies;
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "../../../common/meta-transactions/ERC2771ContextOwnable.sol";
import "../extensions/ERC721CollectionMetadataExtension.sol";
import "../extensions/ERC721PrefixedMetadataExtension.sol";
import "../extensions/ERC721AutoIdMinterExtension.sol";
import "../extensions/ERC721OwnerMintExtension.sol";
import "../extensions/ERC721PreSaleExtension.sol";
import "../extensions/ERC721PublicSaleExtension.sol";
import "../extensions/ERC721SimpleProceedsExtension.sol";
import "../extensions/ERC721RoleBasedMintExtension.sol";
import "../extensions/ERC721RoyaltyExtension.sol";
import "../extensions/ERC721BulkifyExtension.sol";
import "../extensions/ERC721OpenSeaNoGasExtension.sol";
contract ERC721FullFeaturedCollection is
Ownable,
ERC165Storage,
ERC721,
ERC2771ContextOwnable,
ERC721CollectionMetadataExtension,
ERC721PrefixedMetadataExtension,
ERC721AutoIdMinterExtension,
ERC721OwnerMintExtension,
ERC721PreSaleExtension,
ERC721PublicSaleExtension,
ERC721SimpleProceedsExtension,
ERC721RoleBasedMintExtension,
ERC721RoyaltyExtension,
ERC721OpenSeaNoGasExtension,
ERC721BulkifyExtension
{
struct Config {
string name;
string symbol;
string contractURI;
string placeholderURI;
uint256 maxSupply;
uint256 preSalePrice;
uint256 preSaleMaxMintPerWallet;
uint256 publicSalePrice;
uint256 publicSaleMaxMintPerTx;
address defaultRoyaltyAddress;
uint16 defaultRoyaltyBps;
address openSeaProxyRegistryAddress;
address openSeaExchangeAddress;
address trustedForwarder;
}
constructor(Config memory config)
ERC721(config.name, config.symbol)
ERC721CollectionMetadataExtension(config.contractURI)
ERC721PrefixedMetadataExtension(config.placeholderURI)
ERC721AutoIdMinterExtension(config.maxSupply)
ERC721PreSaleExtension(
config.preSalePrice,
config.preSaleMaxMintPerWallet
)
ERC721PublicSaleExtension(
config.publicSalePrice,
config.publicSaleMaxMintPerTx
)
ERC721RoyaltyExtension(
config.defaultRoyaltyAddress,
config.defaultRoyaltyBps
)
ERC721OpenSeaNoGasExtension(
config.openSeaProxyRegistryAddress,
config.openSeaExchangeAddress
)
ERC2771ContextOwnable(config.trustedForwarder)
{
_setupRole(DEFAULT_ADMIN_ROLE, _msgSender());
_setupRole(MINTER_ROLE, _msgSender());
}
function _msgSender()
internal
view
virtual
override(ERC2771ContextOwnable, Context)
returns (address sender)
{
return super._msgSender();
}
function _msgData()
internal
view
virtual
override(ERC2771ContextOwnable, Context)
returns (bytes calldata)
{
return super._msgData();
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(
ERC165Storage,
ERC721,
ERC721CollectionMetadataExtension,
ERC721PrefixedMetadataExtension,
ERC721AutoIdMinterExtension,
ERC721PreSaleExtension,
ERC721PublicSaleExtension,
ERC721SimpleProceedsExtension,
ERC721OwnerMintExtension,
ERC721RoleBasedMintExtension,
ERC721RoyaltyExtension,
ERC721OpenSeaNoGasExtension,
ERC721BulkifyExtension
)
returns (bool)
{
return
ERC721.supportsInterface(interfaceId) ||
ERC165Storage.supportsInterface(interfaceId);
}
/**
* Override isApprovedForAll to whitelist user's OpenSea proxy accounts to enable gas-less listings.
*/
function isApprovedForAll(address owner, address operator)
public
view
override(ERC721, ERC721OpenSeaNoGasExtension)
returns (bool)
{
return super.isApprovedForAll(owner, operator);
}
function tokenURI(uint256 _tokenId)
public
view
virtual
override(ERC721, ERC721PrefixedMetadataExtension)
returns (string memory)
{
return ERC721PrefixedMetadataExtension.tokenURI(_tokenId);
}
function getInfo()
external
view
returns (
uint256 _maxSupply,
uint256 _totalSupply,
uint256 _senderBalance,
uint256 _preSalePrice,
uint256 _preSaleMaxMintPerWallet,
uint256 _preSaleAlreadyClaimed,
bool _preSaleActive,
uint256 _publicSalePrice,
uint256 _publicSaleMaxMintPerTx,
bool _publicSaleActive
)
{
uint256 balance = 0;
if (_msgSender() != address(0)) {
balance = this.balanceOf(_msgSender());
}
return (
maxSupply,
this.totalSupply(),
balance,
preSalePrice,
preSaleMaxMintPerWallet,
preSaleAllowlistClaimed[_msgSender()],
preSaleStatus,
publicSalePrice,
publicSaleMaxMintPerTx,
publicSaleStatus
);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
interface ERC721PrefixedMetadataExtensionInterface {
function setPlaceholderURI(string memory newValue) external;
function setBaseURI(string memory newValue) external;
function freezeBaseURI() external;
function baseTokenURI() external view returns (string memory);
function placeholderURI() external view returns (string memory);
function tokenURI(uint256 _tokenId) external view returns (string memory);
}
/**
* @dev Extension to allow configuring tokens metadata URI.
* In this extension tokens will have a shared token URI prefix,
* therefore on tokenURI() token's ID will be appended to the base URI.
* It also allows configuring a fallback "placeholder" URI when prefix is not set yet.
*/
abstract contract ERC721PrefixedMetadataExtension is
Ownable,
ERC165Storage,
ERC721,
ERC721PrefixedMetadataExtensionInterface
{
string internal _placeholderURI;
string internal _baseTokenURI;
bool public baseURIFrozen;
constructor(string memory placeholderURI_) {
_placeholderURI = placeholderURI_;
_registerInterface(
type(ERC721PrefixedMetadataExtensionInterface).interfaceId
);
}
// ADMIN
function setPlaceholderURI(string memory newValue) external onlyOwner {
_placeholderURI = newValue;
}
function setBaseURI(string memory newValue) external onlyOwner {
require(!baseURIFrozen, "BASE_URI_FROZEN");
_baseTokenURI = newValue;
}
function freezeBaseURI() external onlyOwner {
baseURIFrozen = true;
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function baseTokenURI() public view returns (string memory) {
return _baseTokenURI;
}
function placeholderURI() public view returns (string memory) {
return _placeholderURI;
}
function tokenURI(uint256 _tokenId)
public
view
virtual
override(ERC721, ERC721PrefixedMetadataExtensionInterface)
returns (string memory)
{
return
bytes(_baseTokenURI).length > 0
? string(
abi.encodePacked(_baseTokenURI, Strings.toString(_tokenId))
)
: _placeholderURI;
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/cryptography/MerkleProof.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "./ERC721AutoIdMinterExtension.sol";
interface ERC721PreSaleExtensionInterface {
function setPreSalePrice(uint256 newValue) external;
function setPreSaleMaxMintPerWallet(uint256 newValue) external;
function setAllowlistMerkleRoot(bytes32 newRoot) external;
function togglePreSaleStatus(bool isActive) external;
function onPreSaleAllowList(address minter, bytes32[] calldata proof)
external
view
returns (bool);
function mintPreSale(uint256 count, bytes32[] calldata proof)
external
payable;
}
/**
* @dev Extension to provide pre-sale capabilities for certain collectors to mint for a specific price.
*/
abstract contract ERC721PreSaleExtension is
ERC165Storage,
ERC721AutoIdMinterExtension,
ReentrancyGuard,
ERC721PreSaleExtensionInterface
{
uint256 public preSalePrice;
uint256 public preSaleMaxMintPerWallet;
bytes32 public preSaleAllowlistMerkleRoot;
bool public preSaleStatus;
mapping(address => uint256) internal preSaleAllowlistClaimed;
constructor(uint256 _preSalePrice, uint256 _preSaleMaxMintPerWallet) {
preSalePrice = _preSalePrice;
preSaleMaxMintPerWallet = _preSaleMaxMintPerWallet;
_registerInterface(type(ERC721PreSaleExtensionInterface).interfaceId);
}
// ADMIN
function setPreSalePrice(uint256 newValue) external onlyOwner {
preSalePrice = newValue;
}
function setPreSaleMaxMintPerWallet(uint256 newValue) external onlyOwner {
preSaleMaxMintPerWallet = newValue;
}
function setAllowlistMerkleRoot(bytes32 newRoot) external onlyOwner {
preSaleAllowlistMerkleRoot = newRoot;
}
function togglePreSaleStatus(bool isActive) external onlyOwner {
preSaleStatus = isActive;
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721AutoIdMinterExtension)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function onPreSaleAllowList(address minter, bytes32[] calldata proof)
external
view
returns (bool)
{
return
MerkleProof.verify(
proof,
preSaleAllowlistMerkleRoot,
_generateMerkleLeaf(minter)
);
}
function mintPreSale(uint256 count, bytes32[] calldata proof)
external
payable
nonReentrant
{
require(preSaleStatus, "PRE_SALE_NOT_ACTIVE");
address to = _msgSender();
require(
MerkleProof.verify(
proof,
preSaleAllowlistMerkleRoot,
_generateMerkleLeaf(to)
),
"PRE_SALE_WRONG_PROOF"
);
require(
preSaleAllowlistClaimed[to] + count <= preSaleMaxMintPerWallet,
"PRE_SALE_LIMIT"
);
require(preSalePrice * count <= msg.value, "INSUFFICIENT_AMOUNT");
preSaleAllowlistClaimed[to] += count;
_mintTo(to, count);
}
// INTERNAL
function _generateMerkleLeaf(address account)
internal
pure
returns (bytes32)
{
return keccak256(abi.encodePacked(account));
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "./ERC721AutoIdMinterExtension.sol";
interface ERC721PublicSaleExtensionInterface {
function setPublicSalePrice(uint256 newValue) external;
function setPublicSaleMaxMintPerTx(uint256 newValue) external;
function togglePublicSaleStatus(bool isActive) external;
function mintPublicSale(address to, uint256 count) external payable;
}
/**
* @dev Extension to provide pre-sale and public-sale capabilities for collectors to mint for a specific price.
*/
abstract contract ERC721PublicSaleExtension is
Ownable,
ERC165Storage,
ERC721AutoIdMinterExtension,
ReentrancyGuard,
ERC721PublicSaleExtensionInterface
{
uint256 public publicSalePrice;
uint256 public publicSaleMaxMintPerTx;
bool public publicSaleStatus;
constructor(uint256 _publicSalePrice, uint256 _publicSaleMaxMintPerTx) {
publicSalePrice = _publicSalePrice;
publicSaleMaxMintPerTx = _publicSaleMaxMintPerTx;
_registerInterface(
type(ERC721PublicSaleExtensionInterface).interfaceId
);
}
// ADMIN
function setPublicSalePrice(uint256 newValue) external onlyOwner {
publicSalePrice = newValue;
}
function setPublicSaleMaxMintPerTx(uint256 newValue) external onlyOwner {
publicSaleMaxMintPerTx = newValue;
}
function togglePublicSaleStatus(bool isActive) external onlyOwner {
publicSaleStatus = isActive;
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721AutoIdMinterExtension)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function mintPublicSale(address to, uint256 count)
external
payable
nonReentrant
{
require(publicSaleStatus, "PUBLIC_SALE_NOT_ACTIVE");
require(count <= publicSaleMaxMintPerTx, "PUBLIC_SALE_LIMIT");
require(publicSalePrice * count <= msg.value, "INSUFFICIENT_AMOUNT");
_mintTo(to, count);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
interface ERC721SimpleProceedsExtensionInterface {
function setProceedsRecipient(address _proceedsRecipient) external;
function lockProceedsRecipient() external;
function withdraw() external;
}
/**
* @dev Extension to allow contract owner to withdraw all the funds directly.
*/
abstract contract ERC721SimpleProceedsExtension is
Ownable,
ERC165Storage,
ERC721SimpleProceedsExtensionInterface
{
address public proceedsRecipient;
bool public proceedsRecipientLocked;
constructor() {
_registerInterface(
type(ERC721SimpleProceedsExtensionInterface).interfaceId
);
proceedsRecipient = _msgSender();
}
// ADMIN
function setProceedsRecipient(address _proceedsRecipient)
external
onlyOwner
{
require(!proceedsRecipientLocked, "ERC721/RECIPIENT_LOCKED");
proceedsRecipient = _proceedsRecipient;
}
function lockProceedsRecipient() external onlyOwner {
require(!proceedsRecipientLocked, "ERC721/RECIPIENT_LOCKED");
proceedsRecipientLocked = true;
}
function withdraw() external {
require(proceedsRecipient != address(0), "ERC721/NO_RECIPIENT");
uint256 balance = address(this).balance;
payable(proceedsRecipient).transfer(balance);
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/AccessControl.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "./ERC721AutoIdMinterExtension.sol";
interface ERC721RoleBasedMintExtensionInterface {
function mintByRole(address to, uint256 count) external;
}
/**
* @dev Extension to allow holders of a OpenZepplin-based role to mint directly.
*/
abstract contract ERC721RoleBasedMintExtension is
ERC165Storage,
ERC721AutoIdMinterExtension,
AccessControl,
ERC721RoleBasedMintExtensionInterface
{
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
constructor() {
_registerInterface(
type(ERC721RoleBasedMintExtensionInterface).interfaceId
);
}
// ADMIN
function mintByRole(address to, uint256 count) external {
require(hasRole(MINTER_ROLE, _msgSender()), "NOT_MINTER_ROLE");
_mintTo(to, count);
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, AccessControl, ERC721AutoIdMinterExtension)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
interface ERC721BulkifyExtensionInterface {
function transferFromBulk(
address from,
address to,
uint256[] memory tokenIds
) external;
function transferFromBulk(
address[] memory from,
address[] memory to,
uint256[] memory tokenIds
) external;
}
/**
* @dev Extension to add bulk operations to a standard ERC721 contract.
*/
abstract contract ERC721BulkifyExtension is
Context,
ERC165Storage,
ERC721,
ERC721BulkifyExtensionInterface
{
constructor() {
_registerInterface(type(ERC721BulkifyExtensionInterface).interfaceId);
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
/**
* Useful for when user wants to return tokens to get a refund,
* or when they want to transfer lots of tokens by paying gas fee only once.
*/
function transferFromBulk(
address from,
address to,
uint256[] memory tokenIds
) public virtual {
for (uint256 i = 0; i < tokenIds.length; i++) {
require(_isApprovedOrOwner(_msgSender(), tokenIds[i]), "NOT_OWNER");
_transfer(from, to, tokenIds[i]);
}
}
/**
* Useful for transferring multiple tokens from/to multiple addresses.
*/
function transferFromBulk(
address[] memory from,
address[] memory to,
uint256[] memory tokenIds
) public virtual {
require(from.length == to.length, "FROM_TO_LENGTH_MISMATCH");
require(from.length == tokenIds.length, "FROM_TOKEN_LENGTH_MISMATCH");
for (uint256 i = 0; i < tokenIds.length; i++) {
require(_isApprovedOrOwner(_msgSender(), tokenIds[i]), "NOT_OWNER");
_transfer(from[i], to[i], tokenIds[i]);
}
}
}
// 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 (last updated v4.6.0) (utils/cryptography/MerkleProof.sol)
pragma solidity ^0.8.0;
/**
* @dev These functions deal with verification of Merkle Trees proofs.
*
* The proofs can be generated using the JavaScript library
* https://github.com/miguelmota/merkletreejs[merkletreejs].
* Note: the hashing algorithm should be keccak256 and pair sorting should be enabled.
*
* See `test/utils/cryptography/MerkleProof.test.js` for some examples.
*
* WARNING: You should avoid using leaf values that are 64 bytes long prior to
* hashing, or use a hash function other than keccak256 for hashing leaves.
* This is because the concatenation of a sorted pair of internal nodes in
* the merkle tree could be reinterpreted as a leaf value.
*/
library MerkleProof {
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*/
function verify(
bytes32[] memory proof,
bytes32 root,
bytes32 leaf
) internal pure returns (bool) {
return processProof(proof, leaf) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leafs & pre-images are assumed to be sorted.
*
* _Available since v4.4._
*/
function processProof(bytes32[] memory proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
bytes32 proofElement = proof[i];
if (computedHash <= proofElement) {
// Hash(current computed hash + current element of the proof)
computedHash = _efficientHash(computedHash, proofElement);
} else {
// Hash(current element of the proof + current computed hash)
computedHash = _efficientHash(proofElement, computedHash);
}
}
return computedHash;
}
function _efficientHash(bytes32 a, bytes32 b) private pure returns (bytes32 value) {
assembly {
mstore(0x00, a)
mstore(0x20, b)
value := keccak256(0x00, 0x40)
}
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/proxy/utils/Initializable.sol";
import "../../../common/meta-transactions/ERC2771ContextOwnable.sol";
import "../extensions/ERC721CollectionMetadataExtension.sol";
import "../extensions/ERC721PrefixedMetadataExtension.sol";
import "../extensions/ERC721AutoIdMinterExtension.sol";
import "../extensions/ERC721OwnerMintExtension.sol";
import "../extensions/ERC721OwnerManagedExtension.sol";
import "../extensions/ERC721BulkifyExtension.sol";
contract ERC721ManagedPrefixedCollection is
Initializable,
Ownable,
ERC165Storage,
ERC2771ContextOwnable,
ERC721CollectionMetadataExtension,
ERC721PrefixedMetadataExtension,
ERC721AutoIdMinterExtension,
ERC721OwnerMintExtension,
ERC721OwnerManagedExtension,
ERC721BulkifyExtension
{
struct Config {
string name;
string symbol;
string contractURI;
string baseURI;
string placeholderURI;
address[] initialHolders;
uint256[] initialAmounts;
uint256 maxSupply;
address trustedForwarder;
}
constructor(Config memory config)
ERC721(config.name, config.symbol)
ERC721CollectionMetadataExtension(config.contractURI)
ERC721PrefixedMetadataExtension(config.placeholderURI)
ERC721AutoIdMinterExtension(maxSupply)
ERC2771ContextOwnable(config.trustedForwarder)
{
initialize(config);
}
function initialize(Config memory config) public initializer {
require(
config.initialHolders.length == config.initialAmounts.length,
"ERC721/INVALID_INITIAL_ARGS"
);
maxSupply = config.maxSupply;
for (uint256 i = 0; i < config.initialHolders.length; i++) {
_mintTo(config.initialHolders[i], config.initialAmounts[i]);
}
_baseTokenURI = config.baseURI;
}
function _msgSender()
internal
view
virtual
override(ERC2771ContextOwnable, Context)
returns (address sender)
{
return super._msgSender();
}
function _msgData()
internal
view
virtual
override(ERC2771ContextOwnable, Context)
returns (bytes calldata)
{
return super._msgData();
}
// PUBLIC
function isApprovedForAll(address owner, address operator)
public
view
virtual
override(ERC721, ERC721OwnerManagedExtension)
returns (bool)
{
return ERC721OwnerManagedExtension.isApprovedForAll(owner, operator);
}
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(
ERC165Storage,
ERC721AutoIdMinterExtension,
ERC721CollectionMetadataExtension,
ERC721OwnerMintExtension,
ERC721OwnerManagedExtension,
ERC721PrefixedMetadataExtension,
ERC721BulkifyExtension
)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function tokenURI(uint256 _tokenId)
public
view
virtual
override(ERC721, ERC721PrefixedMetadataExtension)
returns (string memory)
{
return ERC721PrefixedMetadataExtension.tokenURI(_tokenId);
}
function getInfo()
external
view
returns (
uint256 _maxSupply,
uint256 _totalSupply,
uint256 _senderBalance
)
{
uint256 balance = 0;
if (_msgSender() != address(0)) {
balance = this.balanceOf(_msgSender());
}
return (maxSupply, this.totalSupply(), balance);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/Address.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts. Equivalent to `reinitializer(1)`.
*/
modifier initializer() {
bool isTopLevelCall = _setInitializedVersion(1);
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* `initializer` is equivalent to `reinitializer(1)`, so a reinitializer may be used after the original
* initialization step. This is essential to configure modules that are added through upgrades and that require
* initialization.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*/
modifier reinitializer(uint8 version) {
bool isTopLevelCall = _setInitializedVersion(version);
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(version);
}
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*/
function _disableInitializers() internal virtual {
_setInitializedVersion(type(uint8).max);
}
function _setInitializedVersion(uint8 version) private returns (bool) {
// If the contract is initializing we ignore whether _initialized is set in order to support multiple
// inheritance patterns, but we only do this in the context of a constructor, and for the lowest level
// of initializers, because in other contexts the contract may have been reentered.
if (_initializing) {
require(
version == 1 && !Address.isContract(address(this)),
"Initializable: contract is already initialized"
);
return false;
} else {
require(_initialized < version, "Initializable: contract is already initialized");
_initialized = version;
return true;
}
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "./ERC721AutoIdMinterExtension.sol";
interface ERC721OwnerManagedExtensionInterface {
function revokeManagementPower() external;
}
/**
* @dev Extension to allow owner to transfer tokens on behalf of owners. Only useful for certain use-cases.
*/
abstract contract ERC721OwnerManagedExtension is
Ownable,
ERC165Storage,
ERC721AutoIdMinterExtension,
ERC721OwnerManagedExtensionInterface
{
bool public managementPowerRevoked;
constructor() {
_registerInterface(
type(ERC721OwnerManagedExtensionInterface).interfaceId
);
}
// ADMIN
function revokeManagementPower() external onlyOwner {
managementPowerRevoked = true;
}
// PUBLIC
/**
* Override isApprovedForAll to allow owner to transfer tokens.
*/
function isApprovedForAll(address owner, address operator)
public
view
virtual
override(ERC721)
returns (bool)
{
if (!managementPowerRevoked) {
if (operator == super.owner()) {
return true;
}
}
return super.isApprovedForAll(owner, operator);
}
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721AutoIdMinterExtension)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/AccessControl.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "@openzeppelin/contracts/security/Pausable.sol";
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
import "../extensions/ERC20RoleBasedLockingExtension.sol";
contract ERC20LockableToken is
ERC165Storage,
AccessControl,
ERC20,
ERC20Burnable,
Pausable,
ERC20RoleBasedLockingExtension
{
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
struct Config {
string name;
string symbol;
}
constructor(Config memory config) ERC20(config.name, config.symbol) {
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(PAUSER_ROLE, msg.sender);
_grantRole(MINTER_ROLE, msg.sender);
}
// ADMIN
function pause() public onlyRole(PAUSER_ROLE) {
_pause();
}
function unpause() public onlyRole(PAUSER_ROLE) {
_unpause();
}
function mint(address to, uint256 amount) public onlyRole(MINTER_ROLE) {
_mint(to, amount);
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, AccessControl, ERC20RoleBasedLockingExtension)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
)
internal
virtual
override(ERC20, ERC20RoleBasedLockingExtension)
whenNotPaused
{
ERC20RoleBasedLockingExtension._beforeTokenTransfer(from, to, amount);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (security/Pausable.sol)
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract Pausable is Context {
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
bool private _paused;
/**
* @dev Initializes the contract in unpaused state.
*/
constructor() {
_paused = false;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
require(!paused(), "Pausable: paused");
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
require(paused(), "Pausable: not paused");
_;
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.0;
import "./IERC20.sol";
import "./extensions/IERC20Metadata.sol";
import "../../utils/Context.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC20
* applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
* functions have been added to mitigate the well-known issues around setting
* allowances. See {IERC20-approve}.
*/
contract ERC20 is Context, IERC20, IERC20Metadata {
mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* The default value of {decimals} is 18. To select a different value for
* {decimals} you should overload it.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the value {ERC20} uses, unless this function is
* overridden;
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual override returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual override returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address to, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_transfer(owner, to, amount);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual override returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_approve(owner, spender, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
* - the caller must have allowance for ``from``'s tokens of at least
* `amount`.
*/
function transferFrom(
address from,
address to,
uint256 amount
) public virtual override returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, amount);
_transfer(from, to, amount);
return true;
}
/**
* @dev Atomically increases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, allowance(owner, spender) + addedValue);
return true;
}
/**
* @dev Atomically decreases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `spender` must have allowance for the caller of at least
* `subtractedValue`.
*/
function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
address owner = _msgSender();
uint256 currentAllowance = allowance(owner, spender);
require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
unchecked {
_approve(owner, spender, currentAllowance - subtractedValue);
}
return true;
}
/**
* @dev Moves `amount` of tokens from `sender` to `recipient`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
*/
function _transfer(
address from,
address to,
uint256 amount
) internal virtual {
require(from != address(0), "ERC20: transfer from the zero address");
require(to != address(0), "ERC20: transfer to the zero address");
_beforeTokenTransfer(from, to, amount);
uint256 fromBalance = _balances[from];
require(fromBalance >= amount, "ERC20: transfer amount exceeds balance");
unchecked {
_balances[from] = fromBalance - amount;
}
_balances[to] += amount;
emit Transfer(from, to, amount);
_afterTokenTransfer(from, to, amount);
}
/** @dev Creates `amount` tokens and assigns them to `account`, increasing
* the total supply.
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function _mint(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: mint to the zero address");
_beforeTokenTransfer(address(0), account, amount);
_totalSupply += amount;
_balances[account] += amount;
emit Transfer(address(0), account, amount);
_afterTokenTransfer(address(0), account, amount);
}
/**
* @dev Destroys `amount` tokens from `account`, reducing the
* total supply.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
* - `account` must have at least `amount` tokens.
*/
function _burn(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: burn from the zero address");
_beforeTokenTransfer(account, address(0), amount);
uint256 accountBalance = _balances[account];
require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
unchecked {
_balances[account] = accountBalance - amount;
}
_totalSupply -= amount;
emit Transfer(account, address(0), amount);
_afterTokenTransfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(
address owner,
address spender,
uint256 amount
) internal virtual {
require(owner != address(0), "ERC20: approve from the zero address");
require(spender != address(0), "ERC20: approve to the zero address");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `amount`.
*
* Does not update the allowance amount in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Might emit an {Approval} event.
*/
function _spendAllowance(
address owner,
address spender,
uint256 amount
) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
require(currentAllowance >= amount, "ERC20: insufficient allowance");
unchecked {
_approve(owner, spender, currentAllowance - amount);
}
}
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens 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 amount
) 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, `amount` of ``from``'s tokens
* has been transferred to `to`.
* - when `from` is zero, `amount` tokens have been minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens have been 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 _afterTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @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 Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, 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 `from` to `to` 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 from,
address to,
uint256 amount
) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC20/extensions/ERC20Burnable.sol)
pragma solidity ^0.8.0;
import "../ERC20.sol";
import "../../../utils/Context.sol";
/**
* @dev Extension of {ERC20} that allows token holders to destroy both their own
* tokens and those that they have an allowance for, in a way that can be
* recognized off-chain (via event analysis).
*/
abstract contract ERC20Burnable is Context, ERC20 {
/**
* @dev Destroys `amount` tokens from the caller.
*
* See {ERC20-_burn}.
*/
function burn(uint256 amount) public virtual {
_burn(_msgSender(), amount);
}
/**
* @dev Destroys `amount` tokens from `account`, deducting from the caller's
* allowance.
*
* See {ERC20-_burn} and {ERC20-allowance}.
*
* Requirements:
*
* - the caller must have allowance for ``accounts``'s tokens of at least
* `amount`.
*/
function burnFrom(address account, uint256 amount) public virtual {
_spendAllowance(account, _msgSender(), amount);
_burn(account, amount);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/AccessControl.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
interface ERC20RoleBasedLockingExtensionInterface {
function lockForAll() external;
function unlockForAll() external;
function canTransfer(address) external view returns (bool);
}
/**
* @dev Extension to allow locking transfers and only allow certain addresses do to transfers.
*/
abstract contract ERC20RoleBasedLockingExtension is
ERC165Storage,
AccessControl,
ERC20,
ERC20RoleBasedLockingExtensionInterface
{
bytes32 public constant TRANSFER_ROLE = keccak256("TRANSFER_ROLE");
constructor() {
_registerInterface(
type(ERC20RoleBasedLockingExtensionInterface).interfaceId
);
_grantRole(TRANSFER_ROLE, msg.sender);
}
// ADMIN
function lockForAll() external {
require(hasRole(DEFAULT_ADMIN_ROLE, _msgSender()), "NOT_ADMIN");
_revokeRole(TRANSFER_ROLE, address(0));
}
function unlockForAll() external {
require(hasRole(DEFAULT_ADMIN_ROLE, _msgSender()), "NOT_ADMIN");
_grantRole(TRANSFER_ROLE, address(0));
}
// PUBLIC
function canTransfer(address operator)
external
view
override
returns (bool)
{
return hasRole(TRANSFER_ROLE, operator);
}
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, AccessControl)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual override {
require(
hasRole(TRANSFER_ROLE, address(0)) ||
hasRole(TRANSFER_ROLE, _msgSender()),
"TRANSFER_LOCKED"
);
super._beforeTokenTransfer(from, to, amount);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
import "@openzeppelin/contracts/security/Pausable.sol";
import "@openzeppelin/contracts/access/AccessControl.sol";
contract ERC20BasicToken is ERC20, ERC20Burnable, Pausable, AccessControl {
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
struct Config {
string name;
string symbol;
}
constructor(Config memory config) ERC20(config.name, config.symbol) {
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(PAUSER_ROLE, msg.sender);
_grantRole(MINTER_ROLE, msg.sender);
}
function pause() public onlyRole(PAUSER_ROLE) {
_pause();
}
function unpause() public onlyRole(PAUSER_ROLE) {
_unpause();
}
function mint(address to, uint256 amount) public onlyRole(MINTER_ROLE) {
_mint(to, amount);
}
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
) internal override whenNotPaused {
super._beforeTokenTransfer(from, to, amount);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC721/extensions/IERC721Enumerable.sol)
pragma solidity ^0.8.0;
import "../IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Enumerable is IERC721 {
/**
* @dev Returns the total amount of tokens stored by the contract.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns a token ID owned by `owner` at a given `index` of its token list.
* Use along with {balanceOf} to enumerate all of ``owner``'s tokens.
*/
function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);
/**
* @dev Returns a token ID at a given `index` of all the tokens stored by the contract.
* Use along with {totalSupply} to enumerate all tokens.
*/
function tokenByIndex(uint256 index) external view returns (uint256);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/ERC721Enumerable.sol)
pragma solidity ^0.8.0;
import "../ERC721.sol";
import "./IERC721Enumerable.sol";
/**
* @dev This implements an optional extension of {ERC721} defined in the EIP that adds
* enumerability of all the token ids in the contract as well as all token ids owned by each
* account.
*/
abstract contract ERC721Enumerable is ERC721, IERC721Enumerable {
// Mapping from owner to list of owned token IDs
mapping(address => mapping(uint256 => uint256)) private _ownedTokens;
// Mapping from token ID to index of the owner tokens list
mapping(uint256 => uint256) private _ownedTokensIndex;
// Array with all token ids, used for enumeration
uint256[] private _allTokens;
// Mapping from token id to position in the allTokens array
mapping(uint256 => uint256) private _allTokensIndex;
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC721) returns (bool) {
return interfaceId == type(IERC721Enumerable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721Enumerable-tokenOfOwnerByIndex}.
*/
function tokenOfOwnerByIndex(address owner, uint256 index) public view virtual override returns (uint256) {
require(index < ERC721.balanceOf(owner), "ERC721Enumerable: owner index out of bounds");
return _ownedTokens[owner][index];
}
/**
* @dev See {IERC721Enumerable-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _allTokens.length;
}
/**
* @dev See {IERC721Enumerable-tokenByIndex}.
*/
function tokenByIndex(uint256 index) public view virtual override returns (uint256) {
require(index < ERC721Enumerable.totalSupply(), "ERC721Enumerable: global index out of bounds");
return _allTokens[index];
}
/**
* @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` cannot be the zero address.
* - `to` cannot be the zero address.
*
* 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 override {
super._beforeTokenTransfer(from, to, tokenId);
if (from == address(0)) {
_addTokenToAllTokensEnumeration(tokenId);
} else if (from != to) {
_removeTokenFromOwnerEnumeration(from, tokenId);
}
if (to == address(0)) {
_removeTokenFromAllTokensEnumeration(tokenId);
} else if (to != from) {
_addTokenToOwnerEnumeration(to, tokenId);
}
}
/**
* @dev Private function to add a token to this extension's ownership-tracking data structures.
* @param to address representing the new owner of the given token ID
* @param tokenId uint256 ID of the token to be added to the tokens list of the given address
*/
function _addTokenToOwnerEnumeration(address to, uint256 tokenId) private {
uint256 length = ERC721.balanceOf(to);
_ownedTokens[to][length] = tokenId;
_ownedTokensIndex[tokenId] = length;
}
/**
* @dev Private function to add a token to this extension's token tracking data structures.
* @param tokenId uint256 ID of the token to be added to the tokens list
*/
function _addTokenToAllTokensEnumeration(uint256 tokenId) private {
_allTokensIndex[tokenId] = _allTokens.length;
_allTokens.push(tokenId);
}
/**
* @dev Private function to remove a token from this extension's ownership-tracking data structures. Note that
* while the token is not assigned a new owner, the `_ownedTokensIndex` mapping is _not_ updated: this allows for
* gas optimizations e.g. when performing a transfer operation (avoiding double writes).
* This has O(1) time complexity, but alters the order of the _ownedTokens array.
* @param from address representing the previous owner of the given token ID
* @param tokenId uint256 ID of the token to be removed from the tokens list of the given address
*/
function _removeTokenFromOwnerEnumeration(address from, uint256 tokenId) private {
// To prevent a gap in from's tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = ERC721.balanceOf(from) - 1;
uint256 tokenIndex = _ownedTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary
if (tokenIndex != lastTokenIndex) {
uint256 lastTokenId = _ownedTokens[from][lastTokenIndex];
_ownedTokens[from][tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
}
// This also deletes the contents at the last position of the array
delete _ownedTokensIndex[tokenId];
delete _ownedTokens[from][lastTokenIndex];
}
/**
* @dev Private function to remove a token from this extension's token tracking data structures.
* This has O(1) time complexity, but alters the order of the _allTokens array.
* @param tokenId uint256 ID of the token to be removed from the tokens list
*/
function _removeTokenFromAllTokensEnumeration(uint256 tokenId) private {
// To prevent a gap in the tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = _allTokens.length - 1;
uint256 tokenIndex = _allTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary. However, since this occurs so
// rarely (when the last minted token is burnt) that we still do the swap here to avoid the gas cost of adding
// an 'if' statement (like in _removeTokenFromOwnerEnumeration)
uint256 lastTokenId = _allTokens[lastTokenIndex];
_allTokens[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_allTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
// This also deletes the contents at the last position of the array
delete _allTokensIndex[tokenId];
_allTokens.pop();
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
contract TestERC721 is ERC721("FlairTest", "FTS"), ERC721Enumerable {
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC721, ERC721Enumerable)
returns (bool)
{
return super.supportsInterface(interfaceId);
}
function _beforeTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual override(ERC721, ERC721Enumerable) {
return super._beforeTokenTransfer(from, to, tokenId);
}
function mintExact(address to, uint256 tokenId) public returns (bool) {
_mint(to, tokenId);
return true;
}
function mintBulk(address to, uint256 total) public returns (bool) {
for (uint256 i = 0; i < total; i++) {
_mint(to, totalSupply());
}
return true;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (utils/cryptography/ECDSA.sol)
pragma solidity ^0.8.0;
import "../Strings.sol";
/**
* @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
*
* These functions can be used to verify that a message was signed by the holder
* of the private keys of a given address.
*/
library ECDSA {
enum RecoverError {
NoError,
InvalidSignature,
InvalidSignatureLength,
InvalidSignatureS,
InvalidSignatureV
}
function _throwError(RecoverError error) private pure {
if (error == RecoverError.NoError) {
return; // no error: do nothing
} else if (error == RecoverError.InvalidSignature) {
revert("ECDSA: invalid signature");
} else if (error == RecoverError.InvalidSignatureLength) {
revert("ECDSA: invalid signature length");
} else if (error == RecoverError.InvalidSignatureS) {
revert("ECDSA: invalid signature 's' value");
} else if (error == RecoverError.InvalidSignatureV) {
revert("ECDSA: invalid signature 'v' value");
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature` or error string. This address can then be used for verification purposes.
*
* The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {toEthSignedMessageHash} on it.
*
* Documentation for signature generation:
* - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
* - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
*
* _Available since v4.3._
*/
function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError) {
// Check the signature length
// - case 65: r,s,v signature (standard)
// - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098) _Available since v4.1._
if (signature.length == 65) {
bytes32 r;
bytes32 s;
uint8 v;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
assembly {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
return tryRecover(hash, v, r, s);
} else if (signature.length == 64) {
bytes32 r;
bytes32 vs;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
assembly {
r := mload(add(signature, 0x20))
vs := mload(add(signature, 0x40))
}
return tryRecover(hash, r, vs);
} else {
return (address(0), RecoverError.InvalidSignatureLength);
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature`. This address can then be used for verification purposes.
*
* The `ecrecover` EVM opcode allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {toEthSignedMessageHash} on it.
*/
function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
(address recovered, RecoverError error) = tryRecover(hash, signature);
_throwError(error);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
*
* See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures]
*
* _Available since v4.3._
*/
function tryRecover(
bytes32 hash,
bytes32 r,
bytes32 vs
) internal pure returns (address, RecoverError) {
bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
uint8 v = uint8((uint256(vs) >> 255) + 27);
return tryRecover(hash, v, r, s);
}
/**
* @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
*
* _Available since v4.2._
*/
function recover(
bytes32 hash,
bytes32 r,
bytes32 vs
) internal pure returns (address) {
(address recovered, RecoverError error) = tryRecover(hash, r, vs);
_throwError(error);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `v`,
* `r` and `s` signature fields separately.
*
* _Available since v4.3._
*/
function tryRecover(
bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) internal pure returns (address, RecoverError) {
// EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
// unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
// the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
// signatures from current libraries generate a unique signature with an s-value in the lower half order.
//
// If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
// with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
// vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
// these malleable signatures as well.
if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
return (address(0), RecoverError.InvalidSignatureS);
}
if (v != 27 && v != 28) {
return (address(0), RecoverError.InvalidSignatureV);
}
// If the signature is valid (and not malleable), return the signer address
address signer = ecrecover(hash, v, r, s);
if (signer == address(0)) {
return (address(0), RecoverError.InvalidSignature);
}
return (signer, RecoverError.NoError);
}
/**
* @dev Overload of {ECDSA-recover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function recover(
bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) internal pure returns (address) {
(address recovered, RecoverError error) = tryRecover(hash, v, r, s);
_throwError(error);
return recovered;
}
/**
* @dev Returns an Ethereum Signed Message, created from a `hash`. This
* produces hash corresponding to the one signed with the
* https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
* JSON-RPC method as part of EIP-191.
*
* See {recover}.
*/
function toEthSignedMessageHash(bytes32 hash) internal pure returns (bytes32) {
// 32 is the length in bytes of hash,
// enforced by the type signature above
return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n32", hash));
}
/**
* @dev Returns an Ethereum Signed Message, created from `s`. This
* produces hash corresponding to the one signed with the
* https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`]
* JSON-RPC method as part of EIP-191.
*
* See {recover}.
*/
function toEthSignedMessageHash(bytes memory s) internal pure returns (bytes32) {
return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n", Strings.toString(s.length), s));
}
/**
* @dev Returns an Ethereum Signed Typed Data, created from a
* `domainSeparator` and a `structHash`. This produces hash corresponding
* to the one signed with the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`]
* JSON-RPC method as part of EIP-712.
*
* See {recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32) {
return keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash));
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/cryptography/draft-EIP712.sol)
pragma solidity ^0.8.0;
import "./ECDSA.sol";
/**
* @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data.
*
* The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible,
* thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding
* they need in their contracts using a combination of `abi.encode` and `keccak256`.
*
* This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
* scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
* ({_hashTypedDataV4}).
*
* The implementation of the domain separator was designed to be as efficient as possible while still properly updating
* the chain id to protect against replay attacks on an eventual fork of the chain.
*
* NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
* https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
*
* _Available since v3.4._
*/
abstract contract EIP712 {
/* solhint-disable var-name-mixedcase */
// Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
// invalidate the cached domain separator if the chain id changes.
bytes32 private immutable _CACHED_DOMAIN_SEPARATOR;
uint256 private immutable _CACHED_CHAIN_ID;
address private immutable _CACHED_THIS;
bytes32 private immutable _HASHED_NAME;
bytes32 private immutable _HASHED_VERSION;
bytes32 private immutable _TYPE_HASH;
/* solhint-enable var-name-mixedcase */
/**
* @dev Initializes the domain separator and parameter caches.
*
* The meaning of `name` and `version` is specified in
* https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]:
*
* - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
* - `version`: the current major version of the signing domain.
*
* NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
* contract upgrade].
*/
constructor(string memory name, string memory version) {
bytes32 hashedName = keccak256(bytes(name));
bytes32 hashedVersion = keccak256(bytes(version));
bytes32 typeHash = keccak256(
"EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"
);
_HASHED_NAME = hashedName;
_HASHED_VERSION = hashedVersion;
_CACHED_CHAIN_ID = block.chainid;
_CACHED_DOMAIN_SEPARATOR = _buildDomainSeparator(typeHash, hashedName, hashedVersion);
_CACHED_THIS = address(this);
_TYPE_HASH = typeHash;
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
if (address(this) == _CACHED_THIS && block.chainid == _CACHED_CHAIN_ID) {
return _CACHED_DOMAIN_SEPARATOR;
} else {
return _buildDomainSeparator(_TYPE_HASH, _HASHED_NAME, _HASHED_VERSION);
}
}
function _buildDomainSeparator(
bytes32 typeHash,
bytes32 nameHash,
bytes32 versionHash
) private view returns (bytes32) {
return keccak256(abi.encode(typeHash, nameHash, versionHash, block.chainid, address(this)));
}
/**
* @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
* function returns the hash of the fully encoded EIP712 message for this domain.
*
* This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
*
* ```solidity
* bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
* keccak256("Mail(address to,string contents)"),
* mailTo,
* keccak256(bytes(mailContents))
* )));
* address signer = ECDSA.recover(digest, signature);
* ```
*/
function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
return ECDSA.toTypedDataHash(_domainSeparatorV4(), structHash);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.9;
import {SafeMath} from "@openzeppelin/contracts/utils/math/SafeMath.sol";
import "@openzeppelin/contracts/utils/cryptography/draft-EIP712.sol";
import "@openzeppelin/contracts/utils/Context.sol";
abstract contract NativeMetaTransaction is Context, EIP712 {
using SafeMath for uint256;
bytes32 private constant META_TRANSACTION_TYPEHASH =
keccak256(
bytes(
"MetaTransaction(uint256 nonce,address from,bytes functionSignature)"
)
);
event MetaTransactionExecuted(
address userAddress,
address payable relayerAddress,
bytes functionSignature
);
mapping(address => uint256) nonces;
/*
* Meta transaction structure.
* No point of including value field here as if user is doing value transfer then he has the funds to pay for gas
* He should call the desired function directly in that case.
*/
struct MetaTransaction {
uint256 nonce;
address from;
bytes functionSignature;
}
function _msgSender() internal view override returns (address sender) {
if (msg.sender == address(this)) {
bytes memory array = msg.data;
uint256 index = msg.data.length;
assembly {
// Load the 32 bytes word from memory with the address on the lower 20 bytes, and mask those.
sender := and(
mload(add(array, index)),
0xffffffffffffffffffffffffffffffffffffffff
)
}
} else {
sender = msg.sender;
}
return sender;
}
function executeMetaTransaction(
address userAddress,
bytes memory functionSignature,
bytes32 sigR,
bytes32 sigS,
uint8 sigV
) public payable returns (bytes memory) {
MetaTransaction memory metaTx = MetaTransaction({
nonce: nonces[userAddress],
from: userAddress,
functionSignature: functionSignature
});
require(
verify(userAddress, metaTx, sigR, sigS, sigV),
"Signer and signature do not match"
);
// increase nonce for user (to avoid re-use)
nonces[userAddress] = nonces[userAddress].add(1);
emit MetaTransactionExecuted(
userAddress,
payable(msg.sender),
functionSignature
);
// Append userAddress and relayer address at the end to extract it from calling context
(bool success, bytes memory returnData) = address(this).call(
abi.encodePacked(functionSignature, userAddress)
);
require(success, "Function call not successful");
return returnData;
}
function hashMetaTransaction(MetaTransaction memory metaTx)
internal
pure
returns (bytes32)
{
return
keccak256(
abi.encode(
META_TRANSACTION_TYPEHASH,
metaTx.nonce,
metaTx.from,
keccak256(metaTx.functionSignature)
)
);
}
function getNonce(address user) public view returns (uint256 nonce) {
nonce = nonces[user];
}
function verify(
address signer,
MetaTransaction memory metaTx,
bytes32 sigR,
bytes32 sigS,
uint8 sigV
) internal view returns (bool) {
require(signer != address(0), "NativeMetaTransaction: INVALID_SIGNER");
return
signer ==
ecrecover(
_hashTypedDataV4(hashMetaTransaction(metaTx)),
sigV,
sigR,
sigS
);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/utils/Context.sol";
import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
import "@openzeppelin/contracts/utils/cryptography/draft-EIP712.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
contract UnorderedForwarder is EIP712, ReentrancyGuard {
using ECDSA for bytes32;
struct MetaTransaction {
address from;
address to;
uint256 value;
uint256 minGasPrice;
uint256 maxGasPrice;
uint256 expiresAt;
uint256 nonce;
bytes data;
}
bytes32 private constant _TYPEHASH =
keccak256(
"MetaTransaction(address from,address to,uint256 value,uint256 minGasPrice,uint256 maxGasPrice,uint256 expiresAt,uint256 nonce,bytes data)"
);
mapping(bytes32 => uint256) mtxHashToExecutedBlockNumber;
constructor() EIP712("UnorderedForwarder", "0.0.1") {}
/// @dev Refunds up to `msg.value` leftover ETH at the end of the call.
modifier refundsAttachedEth() {
_;
uint256 remainingBalance = msg.value > address(this).balance
? address(this).balance
: msg.value;
if (remainingBalance > 0) {
payable(msg.sender).transfer(remainingBalance);
}
}
/// @dev Ensures that the ETH balance of `this` does not go below the
/// initial ETH balance before the call (excluding ETH attached to the call).
modifier doesNotReduceEthBalance() {
uint256 initialBalance = address(this).balance - msg.value;
_;
require(initialBalance <= address(this).balance, "FWD_ETH_LEAK");
}
function verify(MetaTransaction calldata mtx, bytes calldata signature)
public
view
returns (bytes32 mtxHash)
{
mtxHash = _hashTypedDataV4(
keccak256(
abi.encode(
_TYPEHASH,
mtx.from,
mtx.to,
mtx.value,
mtx.minGasPrice,
mtx.maxGasPrice,
mtx.expiresAt,
mtx.nonce,
keccak256(mtx.data)
)
)
);
// Must not be expired.
require(mtx.expiresAt > block.timestamp, "FWD_EXPIRED");
// Must be signed by the signer.
require(
mtxHash.recover(signature) == mtx.from,
"FWD_INVALID_SIGNATURE"
);
// Transaction must not have been already executed.
require(mtxHashToExecutedBlockNumber[mtxHash] == 0, "FWD_REPLAYED");
return mtxHash;
}
function execute(MetaTransaction calldata mtx, bytes calldata signature)
public
payable
nonReentrant
doesNotReduceEthBalance
refundsAttachedEth
returns (bytes memory)
{
return _execute(mtx, signature);
}
function batchExecute(
MetaTransaction[] calldata mtxs,
bytes[] calldata signatures
)
public
payable
nonReentrant
doesNotReduceEthBalance
refundsAttachedEth
returns (bytes[] memory returnResults)
{
require(mtxs.length == signatures.length, "FWD_MISMATCH_SIGNATURES");
returnResults = new bytes[](mtxs.length);
for (uint256 i = 0; i < mtxs.length; ++i) {
returnResults[i] = _execute(mtxs[i], signatures[i]);
}
}
function _execute(MetaTransaction calldata mtx, bytes calldata signature)
internal
returns (bytes memory)
{
// Must have a valid gas price.
require(
mtx.minGasPrice <= tx.gasprice && tx.gasprice <= mtx.maxGasPrice,
"FWD_INVALID_GAS"
);
// Must have enough ETH.
require(mtx.value <= address(this).balance, "FWD_INVALID_VALUE");
bytes32 mtxHash = verify(mtx, signature);
mtxHashToExecutedBlockNumber[mtxHash] = block.number;
(bool success, bytes memory returndata) = mtx.to.call{value: mtx.value}(
abi.encodePacked(mtx.data, mtx.from)
);
require(success, "FWD_CALL_FAILED");
return returndata;
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@openzeppelin/contracts/utils/Counters.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "../core/ERC721MultiTokenDistributor.sol";
contract ERC721ShareholderDistributor is
Initializable,
OwnableUpgradeable,
ERC721MultiTokenDistributor
{
event SharesUpdated(uint256 tokenId, uint256 prevShares, uint256 newShares);
using Address for address;
using Address for address payable;
string public constant name = "ERC721 Shareholder Distributor";
string public constant version = "0.1";
struct Config {
address ticketToken;
uint256[] tokenIds;
uint256[] shares;
uint256 lockedUntilTimestamp;
}
// Sum of all the share units ever configured
uint256 public totalShares;
// Map of ticket token ID -> share of the stream
mapping(uint256 => uint256) public shares;
// Locks changing the shareholder table until this timestamp is reached
uint256 lockedUntilTimestamp;
/* INTERNAL */
constructor(Config memory config) {
initialize(config);
}
function initialize(Config memory config) public initializer {
__Context_init();
__Ownable_init();
__ERC721MultiTokenDistributor_init(config.ticketToken);
setShares(config.tokenIds, config.shares);
lockedUntilTimestamp = config.lockedUntilTimestamp;
}
// ADMIN
function lockUntil(uint256 newValue) public onlyOwner {
require(newValue > lockedUntilTimestamp, "DISTRIBUTOR/CANNOT_REWIND");
lockedUntilTimestamp = newValue;
}
function setShares(uint256[] memory _tokenIds, uint256[] memory _shares)
public
onlyOwner
{
require(
_shares.length == _tokenIds.length,
"DISTRIBUTOR/ARGS_MISMATCH"
);
require(
lockedUntilTimestamp < block.timestamp,
"DISTRIBUTOR/CONFIG_LOCKED"
);
for (uint256 i = 0; i < _shares.length; i++) {
_updateShares(_tokenIds[i], _shares[i]);
}
}
// PUBLIC
function calculateClaimableAmount(uint256 ticketTokenId)
public
view
returns (uint256)
{
return calculateClaimableAmount(ticketTokenId, address(0));
}
function calculateClaimableAmount(uint256 ticketTokenId, address claimToken)
public
view
override
returns (uint256 claimableAmount)
{
claimableAmount =
(streamTotalSupply(claimToken) * shares[ticketTokenId]) /
totalShares -
entitlements[ticketTokenId][claimToken].totalClaimed;
}
// INTERNAL
function _updateShares(uint256 tokenId, uint256 newShares) private {
uint256 prevShares = shares[tokenId];
shares[tokenId] = newShares;
totalShares = totalShares + newShares - prevShares;
require(totalShares >= 0, "DISTRIBUTOR/NEGATIVE_SHARES");
emit SharesUpdated(tokenId, prevShares, newShares);
}
function _beforeClaim(uint256 ticketTokenId, address claimToken)
internal
view
override
{
claimToken;
require(shares[ticketTokenId] > 0, "DISTRIBUTOR/NO_SHARES");
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts. Equivalent to `reinitializer(1)`.
*/
modifier initializer() {
bool isTopLevelCall = _setInitializedVersion(1);
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* `initializer` is equivalent to `reinitializer(1)`, so a reinitializer may be used after the original
* initialization step. This is essential to configure modules that are added through upgrades and that require
* initialization.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*/
modifier reinitializer(uint8 version) {
bool isTopLevelCall = _setInitializedVersion(version);
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(version);
}
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*/
function _disableInitializers() internal virtual {
_setInitializedVersion(type(uint8).max);
}
function _setInitializedVersion(uint8 version) private returns (bool) {
// If the contract is initializing we ignore whether _initialized is set in order to support multiple
// inheritance patterns, but we only do this in the context of a constructor, and for the lowest level
// of initializers, because in other contexts the contract may have been reentered.
if (_initializing) {
require(
version == 1 && !AddressUpgradeable.isContract(address(this)),
"Initializable: contract is already initialized"
);
return false;
} else {
require(_initialized < version, "Initializable: contract is already initialized");
_initialized = version;
return true;
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../utils/ContextUpgradeable.sol";
import "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
function __Ownable_init() internal onlyInitializing {
__Ownable_init_unchained();
}
function __Ownable_init_unchained() internal onlyInitializing {
_transferOwnership(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Counters.sol)
pragma solidity ^0.8.0;
/**
* @title Counters
* @author Matt Condon (@shrugs)
* @dev Provides counters that can only be incremented, decremented or reset. This can be used e.g. to track the number
* of elements in a mapping, issuing ERC721 ids, or counting request ids.
*
* Include with `using Counters for Counters.Counter;`
*/
library Counters {
struct Counter {
// This variable should never be directly accessed by users of the library: interactions must be restricted to
// the library's function. As of Solidity v0.5.2, this cannot be enforced, though there is a proposal to add
// this feature: see https://github.com/ethereum/solidity/issues/4637
uint256 _value; // default: 0
}
function current(Counter storage counter) internal view returns (uint256) {
return counter._value;
}
function increment(Counter storage counter) internal {
unchecked {
counter._value += 1;
}
}
function decrement(Counter storage counter) internal {
uint256 value = counter._value;
require(value > 0, "Counter: decrement overflow");
unchecked {
counter._value = value - 1;
}
}
function reset(Counter storage counter) internal {
counter._value = 0;
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@openzeppelin/contracts/utils/Counters.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
interface ERC721MultiTokenDistributorInterface {
function claim(uint256 ticketTokenId) external;
function claim(uint256 ticketTokenId, address claimToken) external;
function claimBulk(uint256[] calldata ticketTokenIds) external;
function claimBulk(uint256[] calldata ticketTokenIds, address claimToken)
external;
function streamTotalSupply() external view returns (uint256);
function streamTotalSupply(address claimToken)
external
view
returns (uint256);
function getTotalClaimedBulk(uint256[] calldata ticketTokenIds)
external
view
returns (uint256);
function getTotalClaimedBulk(
uint256[] calldata ticketTokenIds,
address claimToken
) external view returns (uint256);
function calculateClaimableAmount(uint256 ticketTokenId, address claimToken)
external
view
returns (uint256 claimableAmount);
}
abstract contract ERC721MultiTokenDistributor is
Initializable,
OwnableUpgradeable,
ReentrancyGuard,
ERC721MultiTokenDistributorInterface
{
using Address for address;
using Address for address payable;
struct Entitlement {
uint256 totalClaimed;
uint256 lastClaimedAt;
}
// Config
address public ticketToken;
// Map of ticket token ID -> claim token address -> entitlement
mapping(uint256 => mapping(address => Entitlement)) public entitlements;
// Map of claim token address -> Total amount claimed by all holders
mapping(address => uint256) public streamTotalClaimed;
/* EVENTS */
event Claim(
address claimer,
uint256 ticketTokenId,
address claimToken,
uint256 releasedAmount
);
event ClaimBulk(
address claimer,
uint256[] ticketTokenIds,
address claimToken,
uint256 releasedAmount
);
function __ERC721MultiTokenDistributor_init(address _ticketToken)
internal
onlyInitializing
{
__Context_init();
__ERC721MultiTokenDistributor_init_unchained(_ticketToken);
}
function __ERC721MultiTokenDistributor_init_unchained(address _ticketToken)
internal
onlyInitializing
{
ticketToken = _ticketToken;
}
/* PUBLIC */
receive() external payable {
require(msg.value > 0);
}
function claim(uint256 ticketTokenId) public {
claim(ticketTokenId, address(0));
}
function claim(uint256 ticketTokenId, address claimToken)
public
nonReentrant
{
/* CHECKS */
_beforeClaim(ticketTokenId, claimToken);
require(
IERC721(ticketToken).ownerOf(ticketTokenId) == _msgSender(),
"DISTRIBUTOR/NOT_NFT_OWNER"
);
uint256 claimableAmount = calculateClaimableAmount(
ticketTokenId,
claimToken
);
require(claimableAmount > 0, "DISTRIBUTOR/NOTHING_TO_CLAIM");
/* EFFECTS */
entitlements[ticketTokenId][claimToken].totalClaimed += claimableAmount;
entitlements[ticketTokenId][claimToken].lastClaimedAt = block.timestamp;
streamTotalClaimed[claimToken] += claimableAmount;
/* INTERACTIONS */
if (claimToken == address(0)) {
payable(address(_msgSender())).sendValue(claimableAmount);
} else {
IERC20(claimToken).transfer(_msgSender(), claimableAmount);
}
/* LOGS */
emit Claim(_msgSender(), ticketTokenId, claimToken, claimableAmount);
}
function claimBulk(uint256[] calldata ticketTokenIds) public nonReentrant {
claimBulk(ticketTokenIds, address(0));
}
function claimBulk(uint256[] calldata ticketTokenIds, address claimToken)
public
nonReentrant
{
uint256 totalClaimableAmount;
for (uint256 i = 0; i < ticketTokenIds.length; i++) {
_beforeClaim(ticketTokenIds[i], claimToken);
/* CHECKS */
require(
IERC721(ticketToken).ownerOf(ticketTokenIds[i]) == _msgSender(),
"DISTRIBUTOR/NOT_NFT_OWNER"
);
/* EFFECTS */
uint256 claimableAmount = calculateClaimableAmount(
ticketTokenIds[i],
claimToken
);
if (claimableAmount > 0) {
entitlements[ticketTokenIds[i]][claimToken]
.totalClaimed += claimableAmount;
entitlements[ticketTokenIds[i]][claimToken]
.lastClaimedAt = block.timestamp;
totalClaimableAmount += claimableAmount;
}
}
streamTotalClaimed[claimToken] += totalClaimableAmount;
/* INTERACTIONS */
if (claimToken == address(0)) {
payable(address(_msgSender())).sendValue(totalClaimableAmount);
} else {
IERC20(claimToken).transfer(_msgSender(), totalClaimableAmount);
}
/* LOGS */
emit ClaimBulk(
_msgSender(),
ticketTokenIds,
claimToken,
totalClaimableAmount
);
}
/* READ ONLY */
function streamTotalSupply() public view returns (uint256) {
return streamTotalSupply(address(0));
}
function streamTotalSupply(address claimToken)
public
view
returns (uint256)
{
if (claimToken == address(0)) {
return streamTotalClaimed[claimToken] + address(this).balance;
}
return
streamTotalClaimed[claimToken] +
IERC20(claimToken).balanceOf(address(this));
}
function getTotalClaimedBulk(uint256[] calldata ticketTokenIds)
public
view
returns (uint256)
{
return getTotalClaimedBulk(ticketTokenIds, address(0));
}
function getTotalClaimedBulk(
uint256[] calldata ticketTokenIds,
address claimToken
) public view returns (uint256) {
uint256 totalClaimed = 0;
for (uint256 i = 0; i < ticketTokenIds.length; i++) {
totalClaimed += entitlements[ticketTokenIds[i]][claimToken]
.totalClaimed;
}
return totalClaimed;
}
function getTotalClaimableBulk(
uint256[] calldata ticketTokenIds,
address claimToken
) public view returns (uint256) {
uint256 totalClaimable = 0;
for (uint256 i = 0; i < ticketTokenIds.length; i++) {
totalClaimable += calculateClaimableAmount(
ticketTokenIds[i],
claimToken
);
}
return totalClaimable;
}
function calculateClaimableAmount(uint256 ticketTokenId, address claimToken)
public
view
virtual
returns (uint256 claimableAmount);
// INTERNAL
function _beforeClaim(uint256 ticketTokenId, address claimToken)
internal
virtual;
}
// 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 AddressUpgradeable {
/**
* @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 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;
import "../proxy/utils/Initializable.sol";
/**
* @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 ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/utils/Address.sol";
import "@openzeppelin/contracts/utils/Counters.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "../core/ERC721SingleTokenDistributor.sol";
contract ERC721HolderVestedDistributor is
Initializable,
OwnableUpgradeable,
ERC721SingleTokenDistributor
{
using Address for address;
using Address for address payable;
string public constant name = "ERC721 Vested Distributor";
string public constant version = "0.1";
struct Config {
address claimToken;
address ticketToken;
uint256 vestingRate;
uint256 vestingTimeUnit;
uint256 claimStart;
uint256 claimEnd;
}
uint256 public vestingRate;
uint256 public vestingTimeUnit;
uint256 public claimStart;
uint256 public claimEnd;
/* INTERNAL */
constructor(Config memory config) {
initialize(config);
}
// To enable factory cloning
function initialize(Config memory config) public initializer {
__Context_init();
__Ownable_init();
__ERC721SingleTokenDistributor_init(
config.claimToken,
config.ticketToken
);
vestingRate = config.vestingRate;
vestingTimeUnit = config.vestingTimeUnit;
claimStart = config.claimStart;
claimEnd = config.claimEnd;
}
/* PUBLIC */
function setVestingRate(uint256 newValue) public onlyOwner {
vestingRate = newValue;
}
function setVestingTimeUnit(uint256 newValue) public onlyOwner {
vestingTimeUnit = newValue;
}
function setClaimStart(uint256 newValue) public onlyOwner {
claimStart = newValue;
}
function setClaimEnd(uint256 newValue) public onlyOwner {
claimEnd = newValue;
}
function _beforeClaim(uint256 ticketTokenId) internal view override {
require(claimStart < block.timestamp, "DISTRIBUTOR/NOT_STARTED");
require(
entitlements[ticketTokenId].lastClaimedAt <
block.timestamp - vestingTimeUnit,
"DISTRIBUTOR/TOO_EARLY"
);
}
function getTotalReleasedBulk(uint256[] calldata ticketTokenIds)
public
view
returns (uint256)
{
uint256 totalReleased = 0;
for (uint256 i = 0; i < ticketTokenIds.length; i++) {
totalReleased += calculateReleasedAmount(ticketTokenIds[i]);
}
return totalReleased;
}
function calculateClaimableAmount(uint256 ticketTokenId)
public
view
override
returns (uint256 claimableAmount)
{
claimableAmount =
calculateClaimableAmountUntil(
claimEnd > 0 && block.timestamp > claimEnd
? claimEnd
: block.timestamp
) -
entitlements[ticketTokenId].totalClaimed;
}
function calculateClaimableAmountUntil(uint256 calcUntil)
public
view
returns (uint256)
{
if (calcUntil < claimStart) {
return 0;
}
return
vestingRate *
// Intentionally rounded down:
((calcUntil - claimStart) / vestingTimeUnit);
}
function calculateReleasedAmount(uint256 ticketTokenId)
public
view
returns (uint256 releasedAmount)
{
releasedAmount =
calculateReleasedAmountUntil(
claimEnd > 0 && block.timestamp > claimEnd
? claimEnd
: block.timestamp
) -
entitlements[ticketTokenId].totalClaimed;
}
function calculateReleasedAmountUntil(uint256 calcUntil)
public
view
returns (uint256)
{
return ((calcUntil - claimStart) * vestingRate) / vestingTimeUnit;
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@openzeppelin/contracts/utils/Counters.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
interface ERC721SingleTokenDistributorInterface {
function claim(uint256 ticketTokenId) external;
function claimBulk(uint256[] calldata ticketTokenIds) external;
function streamTotalSupply() external view returns (uint256);
function getTotalClaimedBulk(uint256[] calldata ticketTokenIds)
external
view
returns (uint256);
function calculateClaimableAmount(uint256 ticketTokenId)
external
view
returns (uint256 claimableAmount);
}
abstract contract ERC721SingleTokenDistributor is
OwnableUpgradeable,
ReentrancyGuard,
ERC721SingleTokenDistributorInterface
{
using Address for address;
using Address for address payable;
struct Entitlement {
uint256 totalClaimed;
uint256 lastClaimedAt;
}
// Config
address public claimToken;
address public ticketToken;
// Map of ticket token ID -> entitlement
mapping(uint256 => Entitlement) public entitlements;
// Total amount claimed by all holders
uint256 public streamTotalClaimed;
/* EVENTS */
event Claim(address claimer, uint256 ticketTokenId, uint256 releasedAmount);
event ClaimBulk(
address claimer,
uint256[] ticketTokenIds,
uint256 releasedAmount
);
function __ERC721SingleTokenDistributor_init(
address _claimToken,
address _ticketToken
) internal onlyInitializing {
__Context_init();
__Ownable_init();
__ERC721SingleTokenDistributor_init_unchained(
_claimToken,
_ticketToken
);
}
function __ERC721SingleTokenDistributor_init_unchained(
address _claimToken,
address _ticketToken
) internal onlyInitializing {
claimToken = _claimToken;
ticketToken = _ticketToken;
}
/* PUBLIC */
receive() external payable {
require(msg.value > 0);
require(claimToken == address(0));
}
function claim(uint256 ticketTokenId) public nonReentrant {
/* CHECKS */
_beforeClaim(ticketTokenId);
require(
IERC721(ticketToken).ownerOf(ticketTokenId) == _msgSender(),
"DISTRIBUTOR/NOT_NFT_OWNER"
);
uint256 claimableAmount = calculateClaimableAmount(ticketTokenId);
require(claimableAmount > 0, "DISTRIBUTOR/NOTHING_TO_CLAIM");
/* EFFECTS */
entitlements[ticketTokenId].totalClaimed += claimableAmount;
entitlements[ticketTokenId].lastClaimedAt = block.timestamp;
streamTotalClaimed += claimableAmount;
/* INTERACTIONS */
if (claimToken == address(0)) {
payable(address(_msgSender())).sendValue(claimableAmount);
} else {
IERC20(claimToken).transfer(_msgSender(), claimableAmount);
}
/* LOGS */
emit Claim(_msgSender(), ticketTokenId, claimableAmount);
}
function claimBulk(uint256[] calldata ticketTokenIds) public nonReentrant {
uint256 totalClaimableAmount;
for (uint256 i = 0; i < ticketTokenIds.length; i++) {
_beforeClaim(ticketTokenIds[i]);
/* CHECKS */
require(
IERC721(ticketToken).ownerOf(ticketTokenIds[i]) == _msgSender(),
"DISTRIBUTOR/NOT_NFT_OWNER"
);
/* EFFECTS */
uint256 claimableAmount = calculateClaimableAmount(
ticketTokenIds[i]
);
if (claimableAmount > 0) {
entitlements[ticketTokenIds[i]].totalClaimed += claimableAmount;
entitlements[ticketTokenIds[i]].lastClaimedAt = block.timestamp;
totalClaimableAmount += claimableAmount;
}
}
streamTotalClaimed += totalClaimableAmount;
/* INTERACTIONS */
if (claimToken == address(0)) {
payable(address(_msgSender())).sendValue(totalClaimableAmount);
} else {
IERC20(claimToken).transfer(_msgSender(), totalClaimableAmount);
}
/* LOGS */
emit ClaimBulk(_msgSender(), ticketTokenIds, totalClaimableAmount);
}
/* READ ONLY */
function streamTotalSupply() public view returns (uint256) {
return streamTotalClaimed + IERC20(claimToken).balanceOf(address(this));
}
function getTotalClaimedBulk(uint256[] calldata ticketTokenIds)
public
view
returns (uint256)
{
uint256 totalClaimed = 0;
for (uint256 i = 0; i < ticketTokenIds.length; i++) {
totalClaimed += entitlements[ticketTokenIds[i]].totalClaimed;
}
return totalClaimed;
}
function getTotalClaimableBulk(uint256[] calldata ticketTokenIds)
public
view
returns (uint256)
{
uint256 totalClaimable = 0;
for (uint256 i = 0; i < ticketTokenIds.length; i++) {
totalClaimable += calculateClaimableAmount(ticketTokenIds[i]);
}
return totalClaimable;
}
function calculateClaimableAmount(uint256 ticketTokenId)
public
view
virtual
returns (uint256 claimableAmount);
// INTERNAL
function _beforeClaim(uint256 ticketTokenId) internal virtual;
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Storage.sol";
import "./ERC721AutoIdMinterExtension.sol";
interface ERC721FreeMintExtensionInterface {
function mintFree(address to, uint256 count) external;
}
/**
* @dev Extension to allow anyone to mint directly without paying.
*/
abstract contract ERC721FreeMintExtension is
ERC165Storage,
ERC721AutoIdMinterExtension,
ERC721FreeMintExtensionInterface
{
constructor() {
_registerInterface(type(ERC721FreeMintExtensionInterface).interfaceId);
}
// PUBLIC
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165Storage, ERC721AutoIdMinterExtension)
returns (bool)
{
return ERC165Storage.supportsInterface(interfaceId);
}
function mintFree(address to, uint256 count) external {
_mintTo(to, count);
}
}
// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
contract TestERC20 is ERC20("FlairTest", "FTS") {
function mint(address to, uint256 amount) public {
_mint(to, amount);
}
}