Contract Name:
SxTCommunity
Contract Source Code:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
import "./interfaces/ISxTCommunity.sol";
contract SxTCommunity is ISxTCommunity, SxTCommunityStorage, ERC1155, Ownable, ReentrancyGuard, Pausable {
using Counters for Counters.Counter;
// Counter for maintaining TokenIDs
Counters.Counter public currentTokenIndex;
/// @dev This is the constructor function to initialize the contract.
/// @param tokenName Name of the ERC1155 token
/// @param tokenSymbol Symbol of the ERC1155 token
constructor(string memory tokenName, string memory tokenSymbol) ERC1155("") {
require(!compareStrings(tokenName, ""), "SxTCommunity: Token name cannot be an empty string");
require(!compareStrings(tokenSymbol, ""), "SxTCommunity: Token symbol cannot be an empty string");
name = tokenName;
symbol = tokenSymbol;
}
/// @dev This is the function to get the URI for an NFT token
/// @param id ID of NFT token for which URI needs to be fetched
/// @return tokenUri URI of the NFT with required id
function uri(uint id) public view override returns (string memory) {
require(!compareStrings(tokenDetails[id].tokenUri, ""), "SxTCommunity: URI nonexistent token");
return tokenDetails[id].tokenUri;
}
/// @dev This is the function to get the list of available or sold-out NFTs in a paginated JSON string response
/// @param pageNumber Page number of the response required
/// @param pageSize Size of each page of response required
/// @param isAvailable Category of NFTs to get, true for available to mint NFTs, and false for sold out NFTs
/// @return nftsResponseJSON Stringified JSON response having the list of NFT details according to page number, page size, isAvailable( Available for mint or sold-out)
/// @return allAcceptableNFTsCount Count of all available or sold-out ( depending on isAvailable param passed) NFTs that the contract has
function retrieveNFTs(uint256 pageNumber, uint256 pageSize, bool isAvailable) external override view returns(string memory, uint256) {
string memory nftsResponseJSON = "[]";
uint256 allAcceptableNFTsCount = 0;
Token [] memory resultTokens = new Token[](pageSize);
Token [] memory allAcceptableTokens = new Token[](currentTokenIndex.current());
for ( uint256 i = currentTokenIndex.current(); i > 0; i--){
if(isAvailable != checkMaxSupplyReached(i)){
Token storage tokenTemp = tokenDetails[i];
allAcceptableTokens[allAcceptableNFTsCount] = tokenTemp;
allAcceptableNFTsCount++;
}
}
if(pageNumber == 0 || pageSize == 0 ){
return (nftsResponseJSON, allAcceptableNFTsCount);
}
uint256 startIndex = ((pageNumber - 1) * pageSize);
uint256 endIndex = startIndex + pageSize;
if(startIndex >= currentTokenIndex.current()){
return (nftsResponseJSON, allAcceptableNFTsCount);
}
if(endIndex > currentTokenIndex.current()){
endIndex = currentTokenIndex.current();
}
for ( uint256 j = startIndex; j < endIndex; j++){
resultTokens[j - startIndex] = allAcceptableTokens[j];
}
nftsResponseJSON = getJSONResponse(resultTokens);
return (nftsResponseJSON, allAcceptableNFTsCount);
}
/// @dev This is the function to set the price in ethers for an NFT token
/// @dev Only the owner can call this function
/// @param id ID of NFT token for which token price needs to be updated
/// @param newTokenEthPrice New price in ethers for the NFT token
function setTokenEthPrice(uint256 id, uint256 newTokenEthPrice) external override onlyOwner {
require(!compareStrings(tokenDetails[id].tokenUri, ""), "SxTCommunity: URI nonexistent token");
require(tokenDetails[id].ethPrice != newTokenEthPrice, "SxTCommunity: New price same as old price");
require(newTokenEthPrice > 0, "SxTCommunity: New price cannot be zero");
Token storage token = tokenDetails[id];
token.hasPrice = true;
token.ethPrice= newTokenEthPrice;
emit TokenEthPriceSet(id, token.ethPrice);
}
/// @dev This is the function to set the price in ERC20 tokens for an NFT token
/// @dev Only the owner can call this function
/// @param id ID of NFT token for which token price needs to be updated
/// @param newTokenERC20Price New price in ERC20 tokens for the NFT token
function setTokenERC20Price(uint256 id, uint256 newTokenERC20Price) external override onlyOwner {
require(!compareStrings(tokenDetails[id].tokenUri, ""), "SxTCommunity: URI nonexistent token");
require(tokenDetails[id].erc20Price != newTokenERC20Price, "SxTCommunity: New price same as old price");
require(newTokenERC20Price > 0, "SxTCommunity: New price cannot be zero");
Token storage token = tokenDetails[id];
token.hasPrice = true;
token.erc20Price= newTokenERC20Price;
emit TokenERC20PriceSet(id, token.erc20Price);
}
/// @dev This is the function to reset the prices for an NFT token
/// @dev Only the owner can call this function
/// @param id ID of NFT token for which token prices need to be updated
function resetTokenPrices(uint256 id) external override onlyOwner {
require(!compareStrings(tokenDetails[id].tokenUri, ""), "SxTCommunity: URI nonexistent token");
require(tokenDetails[id].hasPrice, "SxTCommunity: This token is already available for free");
Token storage token = tokenDetails[id];
token.hasPrice = false;
token.erc20Price = 0;
token.ethPrice = 0;
emit TokenPriceReset(id);
}
/// @dev This is the function to set the ERC20 token for accepting price of NFTs
/// @dev Only the owner can call this function
/// @param newSxtToken Address of the particular ERC20 token, for accepting price of NFTs in ERC20 tokens
function setERC20Token(IERC20 newSxtToken) external override onlyOwner {
require(address(newSxtToken) != ZERO_ADDRESS, "SxTCommunity: Address Cannot be Zero Address");
require(keccak256(abi.encodePacked(newSxtToken)) != keccak256(abi.encodePacked(sxtToken)), "SxTCommunity: Current token is already what you have selected");
sxtToken = newSxtToken;
emit Erc20TokenSet(newSxtToken);
}
/// @dev This is the function to mint a new NFT token which is available free of cost
/// @dev Only called when contract is unpaused
/// @param id ID of NFT token to be bought
/// @param to Address to which NFT token should be minted to
function mintNFT(uint256 id, address to) external override whenNotPaused nonReentrant{
require(!compareStrings(tokenDetails[id].tokenUri, ""), "SxTCommunity: URI nonexistent token");
require(!tokenDetails[id].hasPrice, "SxTCommunity: This token is not free");
require(!checkMaxSupplyReached(id), "SxTCommunity: Total supply exceeded maximum supply");
require(!isPreviouslyMintedFrom[id][to], "SxTCommunity: Already minted this NFT once to this account");
isPreviouslyMintedFrom[id][to] = true;
Token storage currentToken = tokenDetails[id];
currentToken.currentTokenSupply += 1;
_mint(to, id, AMOUNT_BUYABLE, "");
emit NftMinted(id, to);
}
/// @dev This is the function to mint a new NFT token by depositing Ethers
/// @dev Only called when contract is unpaused
/// @dev If Token is buyable with Ether and ethPrice > 0, function will accept ethers
/// @param id ID of NFT token to be bought
/// @param to Address to which NFT token should be minted to
function mintNFTUsingEth(uint256 id, address to) external override payable whenNotPaused nonReentrant{
require(!compareStrings(tokenDetails[id].tokenUri, ""), "SxTCommunity: URI nonexistent token");
require(tokenDetails[id].hasPrice && tokenDetails[id].ethPrice > 0, "SxTCommunity: Token Eth Price not yet set");
require(!checkMaxSupplyReached(id), "SxTCommunity: Total supply exceeded maximum supply");
require(!isPreviouslyMintedFrom[id][to], "SxTCommunity: Already minted this NFT once to this account");
require(msg.value >= tokenDetails[id].ethPrice, "SxTCommunity: Insufficient Ethers sent");
isPreviouslyMintedFrom[id][to] = true;
Token storage currentToken = tokenDetails[id];
currentToken.currentTokenSupply += 1;
_mint(to, id, AMOUNT_BUYABLE, "");
emit NftMintedUsingEth(id, to, tokenDetails[id].ethPrice );
}
/// @dev This is the function to mint a new NFT token by depositing ERC20 Token
/// @dev Only called when contract is unpaused
/// @dev If Token is buyable with ERC20 token and erc20Price > 0, function will transfer ERC20 tokens to contract
/// @param id ID of NFT token to be bought
/// @param to Address to which NFT token should be minted to
function mintNFTUsingERC20(uint256 id, address to) external override whenNotPaused nonReentrant{
require(address(sxtToken) != ZERO_ADDRESS, "SxTCommunity: ERC20 Token not yet set by owner");
require(!compareStrings(tokenDetails[id].tokenUri, ""), "SxTCommunity: URI nonexistent token");
require(tokenDetails[id].hasPrice && tokenDetails[id].erc20Price > 0, "SxTCommunity: Token ERC20 Price not yet set");
require(!checkMaxSupplyReached(id), "SxTCommunity: Total supply exceeded maximum supply");
require(!isPreviouslyMintedFrom[id][to], "SxTCommunity: Already minted this NFT once to this account");
require(sxtToken.balanceOf(msg.sender) >= tokenDetails[id].erc20Price, "SxTCommunity: Insufficient ERC20 token balance");
isPreviouslyMintedFrom[id][to] = true;
bool sent = sxtToken.transferFrom(msg.sender, address(this), tokenDetails[id].erc20Price);
require(sent, "SxTCommunity: Failed to send ERC20Token");
Token storage currentToken = tokenDetails[id];
currentToken.currentTokenSupply += 1;
_mint(to, id, AMOUNT_BUYABLE, "");
emit NftMintedUsingERC20(id, to, tokenDetails[id].erc20Price);
}
/// @dev This is the function to add new NFT tokens in the contract
/// @dev Only the owner can call this function
/// @param newTokenURIs Array of URIs for NFTs to be added
/// @param hasPrices Array of boolean flags representing whether the NFT token has any price or not
/// @param newEthPrices Array of prices in Ethers for NFTs to be added
/// @param newERC20Prices Array of prices in ERC20 Tokens for NFTs to be added
/// @param maxNewTokenSupplies Array of maximum possible supplies for NFTs to be added
function addNewNFTs(string [] memory newTokenURIs, bool [] memory hasPrices, uint256 [] memory newEthPrices, uint256 [] memory newERC20Prices, uint256 [] memory maxNewTokenSupplies) external override onlyOwner {
require(newTokenURIs.length == maxNewTokenSupplies.length && maxNewTokenSupplies.length == hasPrices.length && hasPrices.length == newEthPrices.length && newEthPrices.length == newERC20Prices.length, "SxTCommunity: Array lengths should be same");
for(uint256 index = 0; index < maxNewTokenSupplies.length; index++){
Token memory newToken;
require(maxNewTokenSupplies[index] > 0, "SxTCommunity: Maximum supply cannot be 0");
require(!compareStrings(newTokenURIs[index], ""), "SxTCommunity: URI cannot be empty string");
currentTokenIndex.increment();
uint256 newTokenIndex = currentTokenIndex.current();
newToken.id = newTokenIndex;
newToken.tokenUri = newTokenURIs[index];
newToken.maxTokenSupply = maxNewTokenSupplies[index];
newToken.hasPrice = hasPrices[index];
if(hasPrices[index]) {
require(newEthPrices[index] > 0 || newERC20Prices[index] > 0, "SxTCommunity: Both prices cannot be 0 since NFT hasPrice is true");
newToken.ethPrice = newEthPrices[index];
newToken.erc20Price = newERC20Prices[index];
}
tokenDetails[newTokenIndex] = newToken;
emit NewNFTAdded(newTokenIndex);
}
}
/// @dev This is the internal function to check if maximum supply reached for an NFT
/// @dev This is called inside mintNFT, mintNFTUsingEth, mintNFTUsingERC20 functions
/// @param id ID of NFT token to be checked
function checkMaxSupplyReached(uint256 id) view internal returns(bool){
if(tokenDetails[id].currentTokenSupply < tokenDetails[id].maxTokenSupply)
return false;
return true;
}
/// @dev This is the internal function to compare 2 strings
/// @param s1 First string for comparing value
/// @param s2 Second string for comparing value
function compareStrings(string memory s1, string memory s2) internal pure returns (bool) {
return (keccak256(abi.encodePacked(s1)) == keccak256(abi.encodePacked(s2)));
}
/// @dev This is the function to withdraw ethers from contract
/// @dev Only the owner can call this function
function withdrawEth() external override onlyOwner nonReentrant {
uint256 amount = address(this).balance;
address payable to = payable(msg.sender);
require(amount > 0, "SxTCommunity: Zero ether balance");
to.transfer(amount);
emit EtherWithdrawn( amount, to);
}
/// @dev This is the function to withdraw ERC20 Tokens from contract
/// @dev Only the owner can call this function
function withdrawERC20() external override onlyOwner nonReentrant {
uint256 amount = sxtToken.balanceOf(address(this));
address to = msg.sender;
require(amount > 0, "SxTCommunity: Zero ERC20 token balance");
bool sent = sxtToken.transfer(to, amount);
require(sent, "Failed to send ERC20Token");
emit Erc20TokenWithdrawn(amount, to);
}
/// @dev This is the function to pause the contract
function pause() external override onlyOwner {
_pause();
}
/// @dev This is the function to unpause the contract
function unpause() external override onlyOwner {
_unpause();
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
import "../SxTCommunityStorage.sol";
interface ISxTCommunity {
/// @dev This is the event to notify that price in ethers of an NFT is set
/// @param id ID of NFT token for which token price is updated
/// @param newTokenEthPrice New price in ethers set for the NFT token
event TokenEthPriceSet(uint256 id, uint256 newTokenEthPrice);
/// @dev This is the event to notify that price in ERC20 tokens of an NFT is set
/// @param id ID of NFT token for which token price is updated
/// @param newTokenERC20Price New price in ERC20 tokens set for the NFT token
event TokenERC20PriceSet(uint256 id, uint256 newTokenERC20Price);
/// @dev This is the event to notify that prices of an NFT are reset to zero
/// @param id ID of NFT token for which token pricse are updated
event TokenPriceReset(uint256 id);
/// @dev This is the event to notify that an ERC20 token for buying NFTs is set.
/// @param sXtToken Address of the ERC20 token set
event Erc20TokenSet(IERC20 sXtToken);
/// @dev This is the event to notify that an NFT token is bought free of cost.
/// @param id ID of NFT token bought
/// @param to Address of the NFT buyer
event NftMinted(uint256 id, address to);
/// @dev This is the event to notify that an NFT token is bought using ethers.
/// @param id ID of NFT token bought
/// @param to Address of the NFT buyer
/// @param tokenPrice Price for the NFT token bought
event NftMintedUsingEth(uint256 id, address to, uint256 tokenPrice);
/// @dev This is the event to notify that an NFT token is bought using ERC20 tokens.
/// @param id ID of NFT token bought
/// @param to Address of the NFT buyer
/// @param tokenPrice Price for the NFT token bought
event NftMintedUsingERC20(uint256 id, address to, uint256 tokenPrice);
/// @dev This is the event to notify that a new NFT token has been added in contract
/// @param id ID of NFT token added
event NewNFTAdded(uint256 id);
/// @dev This is the event to notify that all ethers are withdrawn from contract by owner.
/// @param amount Amount of ethers withdrawn
/// @param to Address of the owner to which ethers are sent
event EtherWithdrawn(uint256 amount, address payable to);
/// @dev This is the event to notify that all ERC20 tokens are withdrawn from contract by owner.
/// @param amount Amount of tokens withdrawn
/// @param to Address of the owner to which ERC20 tokens are transferred
event Erc20TokenWithdrawn(uint256 amount, address to);
/// @dev This is the function to get the list of available or sold-out NFTs in a paginated JSON string response
/// @param pageNumber Page number of the response required
/// @param pageSize Size of each page of response required
/// @param isAvailable Category of NFTs to get, true for available to mint NFTs, and false for sold out NFTs
/// @return nftsResponseJSON Stringified JSON response having the list of NFT details according to page number, page size, isAvailable( Available for mint or sold-out)
/// @return allAcceptableNFTsCount Count of all available or sold-out ( depending on isAvailable param passed) NFTs that the contract has
function retrieveNFTs(uint256 pageNumber, uint256 pageSize, bool isAvailable) external view returns(string memory nftsResponseJSON, uint256 allAcceptableNFTsCount);
/// @dev This is the function to set the price in ethers for an NFT token
/// @dev Only the owner can call this function
/// @param id ID of NFT token for which token price needs to be updated
/// @param newTokenEthPrice New price in ethers for the NFT token
function setTokenEthPrice(uint256 id, uint256 newTokenEthPrice) external;
/// @dev This is the function to set the price in ERC20 tokens for an NFT token
/// @dev Only the owner can call this function
/// @param id ID of NFT token for which token price needs to be updated
/// @param newTokenERC20Price New price in ERC20 tokens for the NFT token
function setTokenERC20Price(uint256 id, uint256 newTokenERC20Price) external;
/// @dev This is the function to reset the prices for an NFT token
/// @dev Only the owner can call this function
/// @param id ID of NFT token for which token prices need to be updated
function resetTokenPrices(uint256 id) external;
/// @dev This is the function to set the ERC20 token for accepting price of NFTs
/// @dev Only the owner can call this function
/// @param newSxtToken Address of the particular ERC20 token, for accepting price of NFTs in ERC20 tokens
function setERC20Token(IERC20 newSxtToken) external;
/// @dev This is the function to buy a new NFT token which is available free of cost
/// @dev Only called when contract is unpaused
/// @param id ID of NFT token to be bought
/// @param to Address to which NFT token should be minted to
function mintNFT(uint256 id, address to) external;
/// @dev This is the function to buy a new NFT token using Ethers
/// @dev Only called when contract is unpaused
/// @dev If Token is buyable with Ether and ethPrice > 0, function will accept ethers
/// @param id ID of NFT token to be bought
/// @param to Address to which NFT token should be minted to
function mintNFTUsingEth(uint256 id, address to) external payable;
/// @dev This is the function to buy a new NFT token using ERC20 Token
/// @dev Only called when contract is unpaused
/// @dev If Token is buyable with ERC20 token and erc20Price > 0, function will transfer ERC20 tokens to contract
/// @param id ID of NFT token to be bought
/// @param to Address to which NFT token should be minted to
function mintNFTUsingERC20(uint256 id, address to) external;
/// @dev This is the function to add new NFT tokens in the contract
/// @dev Only the owner can call this function
/// @param newTokenURIs Array of URIs for NFTs to be added
/// @param maxNewTokenSupplies Array of maximum possible supplies for NFTs to be added
/// @param hasPrices Array of boolean flags representing whether the NFT token has any price or not
/// @param newEthPrices Array of prices in Ethers for NFTs to be added
/// @param newERC20Prices Array of prices in ERC20 Tokens for NFTs to be added
function addNewNFTs(string [] memory newTokenURIs, bool [] memory hasPrices, uint256 [] memory newEthPrices, uint256 [] memory newERC20Prices, uint256 [] memory maxNewTokenSupplies) external;
/// @dev This is the function to withdraw ethers from contract
/// @dev Only the owner can call this function
function withdrawEth() external;
/// @dev This is the function to withdraw ERC20 Tokens from contract
/// @dev Only the owner can call this function
function withdrawERC20() external;
/// @dev This is the function to pause the contract
function pause() external;
/// @dev This is the function to unpause the contract
function unpause() external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;
import "@openzeppelin/contracts/token/ERC1155/ERC1155.sol";
import "@openzeppelin/contracts/utils/Counters.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/security/Pausable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/utils/Strings.sol";
contract SxTCommunityStorage {
using Strings for uint256;
// Constant denoting zero address
address constant ZERO_ADDRESS = address(0);
// Amount of tokens that can be bought at a time
uint8 constant AMOUNT_BUYABLE = 1;
// Name of ERC1155 token
string public name;
// Symbol of ERC1155 token
string public symbol;
// IERC20 token instance for accepting NFT token's price in ERC20 tokens
IERC20 public sxtToken;
// Structure of NFT token
struct Token {
string tokenUri;
bool hasPrice;
uint256 id;
uint256 ethPrice;
uint256 erc20Price;
uint256 maxTokenSupply;
uint256 currentTokenSupply;
}
/// @dev This function returns stringified JSON form of a struct
/// @param nftToken Detailed structure instance of an NFT
/// @return nftJSONString Stringified JSON response generated from struct
function getJSONfromStruct(Token memory nftToken) internal pure returns (string memory) {
string memory hasPrice = nftToken.hasPrice ? "true": "false";
string memory nftJSONString = string(abi.encodePacked(
"{\"tokenUri\":\"",nftToken.tokenUri,
"\",\"hasPrice\":\"",hasPrice,
"\",\"id\":\"",nftToken.id.toString(),
"\",\"erc20Price\":\"",nftToken.erc20Price.toString(),
"\",\"ethPrice\":\"",nftToken.ethPrice.toString(),
"\",\"maxTokenSupply\":\"",nftToken.maxTokenSupply.toString(),
"\",\"currentTokenSupply\":\"",nftToken.currentTokenSupply.toString(),
"\"}"
));
return string(abi.encodePacked(
bytes(nftJSONString)
));
}
/// @dev This function returns stringified JSON form of an array of structs
/// @param nftTokens Array of structs of NFTs
/// @return nftsJSONString Stringified JSON response generated from struct array
function getJSONResponse(Token [] memory nftTokens) internal pure returns (string memory) {
string memory nftsJSONString;
for (uint256 index = 0; index < nftTokens.length; index++){
if(keccak256(abi.encodePacked(nftTokens[index].tokenUri)) != keccak256(abi.encodePacked("")))
{
string memory nftJSONString = getJSONfromStruct(nftTokens[index]);
if(index != 0 )
nftsJSONString = string(abi.encodePacked( nftsJSONString, ","));
nftsJSONString = string(abi.encodePacked(nftsJSONString, nftJSONString));
}
else
{
break;
}
}
nftsJSONString = string(abi.encodePacked("[", nftsJSONString, "]"));
return nftsJSONString;
}
// Mapping for maintaining NFT token ID
mapping(uint256 => Token) public tokenDetails;
// Mapping for maintaing whether an address had minted a particular NFT from the contract previously
mapping(uint256 => mapping(address => bool)) public isPreviouslyMintedFrom;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @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);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
}
// 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: 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.7.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
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// 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 v4.4.1 (token/ERC1155/extensions/IERC1155MetadataURI.sol)
pragma solidity ^0.8.0;
import "../IERC1155.sol";
/**
* @dev Interface of the optional ERC1155MetadataExtension interface, as defined
* in the https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[EIP].
*
* _Available since v3.1._
*/
interface IERC1155MetadataURI is IERC1155 {
/**
* @dev Returns the URI for token type `id`.
*
* If the `\{id\}` substring is present in the URI, it must be replaced by
* clients with the actual token type ID.
*/
function uri(uint256 id) external view returns (string memory);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC1155/IERC1155Receiver.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev _Available since v3.1._
*/
interface IERC1155Receiver is IERC165 {
/**
* @dev Handles the receipt of a single ERC1155 token type. This function is
* called at the end of a `safeTransferFrom` after the balance has been updated.
*
* NOTE: To accept the transfer, this must return
* `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
* (i.e. 0xf23a6e61, or its own function selector).
*
* @param operator The address which initiated the transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param id The ID of the token being transferred
* @param value The amount of tokens being transferred
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
*/
function onERC1155Received(
address operator,
address from,
uint256 id,
uint256 value,
bytes calldata data
) external returns (bytes4);
/**
* @dev Handles the receipt of a multiple ERC1155 token types. This function
* is called at the end of a `safeBatchTransferFrom` after the balances have
* been updated.
*
* NOTE: To accept the transfer(s), this must return
* `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
* (i.e. 0xbc197c81, or its own function selector).
*
* @param operator The address which initiated the batch transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param ids An array containing ids of each token being transferred (order and length must match values array)
* @param values An array containing amounts of each token being transferred (order and length must match ids array)
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
*/
function onERC1155BatchReceived(
address operator,
address from,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external returns (bytes4);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC1155/IERC1155.sol)
pragma solidity ^0.8.0;
import "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC1155 compliant contract, as defined in the
* https://eips.ethereum.org/EIPS/eip-1155[EIP].
*
* _Available since v3.1._
*/
interface IERC1155 is IERC165 {
/**
* @dev Emitted when `value` tokens of token type `id` are transferred from `from` to `to` by `operator`.
*/
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
/**
* @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
* transfers.
*/
event TransferBatch(
address indexed operator,
address indexed from,
address indexed to,
uint256[] ids,
uint256[] values
);
/**
* @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
* `approved`.
*/
event ApprovalForAll(address indexed account, address indexed operator, bool approved);
/**
* @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
*
* If an {URI} event was emitted for `id`, the standard
* https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
* returned by {IERC1155MetadataURI-uri}.
*/
event URI(string value, uint256 indexed id);
/**
* @dev Returns the amount of tokens of token type `id` owned by `account`.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function balanceOf(address account, uint256 id) external view returns (uint256);
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(address[] calldata accounts, uint256[] calldata ids)
external
view
returns (uint256[] memory);
/**
* @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
*
* Emits an {ApprovalForAll} event.
*
* Requirements:
*
* - `operator` cannot be the caller.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
*
* See {setApprovalForAll}.
*/
function isApprovedForAll(address account, address operator) external view returns (bool);
/**
* @dev Transfers `amount` tokens of token type `id` from `from` to `to`.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
* - `from` must have a balance of tokens of type `id` of at least `amount`.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function safeTransferFrom(
address from,
address to,
uint256 id,
uint256 amount,
bytes calldata data
) external;
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - `ids` and `amounts` must have the same length.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] calldata ids,
uint256[] calldata amounts,
bytes calldata data
) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC1155/ERC1155.sol)
pragma solidity ^0.8.0;
import "./IERC1155.sol";
import "./IERC1155Receiver.sol";
import "./extensions/IERC1155MetadataURI.sol";
import "../../utils/Address.sol";
import "../../utils/Context.sol";
import "../../utils/introspection/ERC165.sol";
/**
* @dev Implementation of the basic standard multi-token.
* See https://eips.ethereum.org/EIPS/eip-1155
* Originally based on code by Enjin: https://github.com/enjin/erc-1155
*
* _Available since v3.1._
*/
contract ERC1155 is Context, ERC165, IERC1155, IERC1155MetadataURI {
using Address for address;
// Mapping from token ID to account balances
mapping(uint256 => mapping(address => uint256)) private _balances;
// Mapping from account to operator approvals
mapping(address => mapping(address => bool)) private _operatorApprovals;
// Used as the URI for all token types by relying on ID substitution, e.g. https://token-cdn-domain/{id}.json
string private _uri;
/**
* @dev See {_setURI}.
*/
constructor(string memory uri_) {
_setURI(uri_);
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165, IERC165) returns (bool) {
return
interfaceId == type(IERC1155).interfaceId ||
interfaceId == type(IERC1155MetadataURI).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC1155MetadataURI-uri}.
*
* This implementation returns the same URI for *all* token types. It relies
* on the token type ID substitution mechanism
* https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
*
* Clients calling this function must replace the `\{id\}` substring with the
* actual token type ID.
*/
function uri(uint256) public view virtual override returns (string memory) {
return _uri;
}
/**
* @dev See {IERC1155-balanceOf}.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function balanceOf(address account, uint256 id) public view virtual override returns (uint256) {
require(account != address(0), "ERC1155: address zero is not a valid owner");
return _balances[id][account];
}
/**
* @dev See {IERC1155-balanceOfBatch}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(address[] memory accounts, uint256[] memory ids)
public
view
virtual
override
returns (uint256[] memory)
{
require(accounts.length == ids.length, "ERC1155: accounts and ids length mismatch");
uint256[] memory batchBalances = new uint256[](accounts.length);
for (uint256 i = 0; i < accounts.length; ++i) {
batchBalances[i] = balanceOf(accounts[i], ids[i]);
}
return batchBalances;
}
/**
* @dev See {IERC1155-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved) public virtual override {
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC1155-isApprovedForAll}.
*/
function isApprovedForAll(address account, address operator) public view virtual override returns (bool) {
return _operatorApprovals[account][operator];
}
/**
* @dev See {IERC1155-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 id,
uint256 amount,
bytes memory data
) public virtual override {
require(
from == _msgSender() || isApprovedForAll(from, _msgSender()),
"ERC1155: caller is not token owner nor approved"
);
_safeTransferFrom(from, to, id, amount, data);
}
/**
* @dev See {IERC1155-safeBatchTransferFrom}.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes memory data
) public virtual override {
require(
from == _msgSender() || isApprovedForAll(from, _msgSender()),
"ERC1155: caller is not token owner nor approved"
);
_safeBatchTransferFrom(from, to, ids, amounts, data);
}
/**
* @dev Transfers `amount` tokens of token type `id` from `from` to `to`.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `from` must have a balance of tokens of type `id` of at least `amount`.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function _safeTransferFrom(
address from,
address to,
uint256 id,
uint256 amount,
bytes memory data
) internal virtual {
require(to != address(0), "ERC1155: transfer to the zero address");
address operator = _msgSender();
uint256[] memory ids = _asSingletonArray(id);
uint256[] memory amounts = _asSingletonArray(amount);
_beforeTokenTransfer(operator, from, to, ids, amounts, data);
uint256 fromBalance = _balances[id][from];
require(fromBalance >= amount, "ERC1155: insufficient balance for transfer");
unchecked {
_balances[id][from] = fromBalance - amount;
}
_balances[id][to] += amount;
emit TransferSingle(operator, from, to, id, amount);
_afterTokenTransfer(operator, from, to, ids, amounts, data);
_doSafeTransferAcceptanceCheck(operator, from, to, id, amount, data);
}
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_safeTransferFrom}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function _safeBatchTransferFrom(
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes memory data
) internal virtual {
require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
require(to != address(0), "ERC1155: transfer to the zero address");
address operator = _msgSender();
_beforeTokenTransfer(operator, from, to, ids, amounts, data);
for (uint256 i = 0; i < ids.length; ++i) {
uint256 id = ids[i];
uint256 amount = amounts[i];
uint256 fromBalance = _balances[id][from];
require(fromBalance >= amount, "ERC1155: insufficient balance for transfer");
unchecked {
_balances[id][from] = fromBalance - amount;
}
_balances[id][to] += amount;
}
emit TransferBatch(operator, from, to, ids, amounts);
_afterTokenTransfer(operator, from, to, ids, amounts, data);
_doSafeBatchTransferAcceptanceCheck(operator, from, to, ids, amounts, data);
}
/**
* @dev Sets a new URI for all token types, by relying on the token type ID
* substitution mechanism
* https://eips.ethereum.org/EIPS/eip-1155#metadata[defined in the EIP].
*
* By this mechanism, any occurrence of the `\{id\}` substring in either the
* URI or any of the amounts in the JSON file at said URI will be replaced by
* clients with the token type ID.
*
* For example, the `https://token-cdn-domain/\{id\}.json` URI would be
* interpreted by clients as
* `https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json`
* for token type ID 0x4cce0.
*
* See {uri}.
*
* Because these URIs cannot be meaningfully represented by the {URI} event,
* this function emits no events.
*/
function _setURI(string memory newuri) internal virtual {
_uri = newuri;
}
/**
* @dev Creates `amount` tokens of token type `id`, and assigns them to `to`.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function _mint(
address to,
uint256 id,
uint256 amount,
bytes memory data
) internal virtual {
require(to != address(0), "ERC1155: mint to the zero address");
address operator = _msgSender();
uint256[] memory ids = _asSingletonArray(id);
uint256[] memory amounts = _asSingletonArray(amount);
_beforeTokenTransfer(operator, address(0), to, ids, amounts, data);
_balances[id][to] += amount;
emit TransferSingle(operator, address(0), to, id, amount);
_afterTokenTransfer(operator, address(0), to, ids, amounts, data);
_doSafeTransferAcceptanceCheck(operator, address(0), to, id, amount, data);
}
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - `ids` and `amounts` must have the same length.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function _mintBatch(
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes memory data
) internal virtual {
require(to != address(0), "ERC1155: mint to the zero address");
require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
address operator = _msgSender();
_beforeTokenTransfer(operator, address(0), to, ids, amounts, data);
for (uint256 i = 0; i < ids.length; i++) {
_balances[ids[i]][to] += amounts[i];
}
emit TransferBatch(operator, address(0), to, ids, amounts);
_afterTokenTransfer(operator, address(0), to, ids, amounts, data);
_doSafeBatchTransferAcceptanceCheck(operator, address(0), to, ids, amounts, data);
}
/**
* @dev Destroys `amount` tokens of token type `id` from `from`
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `from` must have at least `amount` tokens of token type `id`.
*/
function _burn(
address from,
uint256 id,
uint256 amount
) internal virtual {
require(from != address(0), "ERC1155: burn from the zero address");
address operator = _msgSender();
uint256[] memory ids = _asSingletonArray(id);
uint256[] memory amounts = _asSingletonArray(amount);
_beforeTokenTransfer(operator, from, address(0), ids, amounts, "");
uint256 fromBalance = _balances[id][from];
require(fromBalance >= amount, "ERC1155: burn amount exceeds balance");
unchecked {
_balances[id][from] = fromBalance - amount;
}
emit TransferSingle(operator, from, address(0), id, amount);
_afterTokenTransfer(operator, from, address(0), ids, amounts, "");
}
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
*
* Emits a {TransferBatch} event.
*
* Requirements:
*
* - `ids` and `amounts` must have the same length.
*/
function _burnBatch(
address from,
uint256[] memory ids,
uint256[] memory amounts
) internal virtual {
require(from != address(0), "ERC1155: burn from the zero address");
require(ids.length == amounts.length, "ERC1155: ids and amounts length mismatch");
address operator = _msgSender();
_beforeTokenTransfer(operator, from, address(0), ids, amounts, "");
for (uint256 i = 0; i < ids.length; i++) {
uint256 id = ids[i];
uint256 amount = amounts[i];
uint256 fromBalance = _balances[id][from];
require(fromBalance >= amount, "ERC1155: burn amount exceeds balance");
unchecked {
_balances[id][from] = fromBalance - amount;
}
}
emit TransferBatch(operator, from, address(0), ids, amounts);
_afterTokenTransfer(operator, from, address(0), ids, amounts, "");
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits an {ApprovalForAll} event.
*/
function _setApprovalForAll(
address owner,
address operator,
bool approved
) internal virtual {
require(owner != operator, "ERC1155: setting approval status for self");
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Hook that is called before any token transfer. This includes minting
* and burning, as well as batched variants.
*
* The same hook is called on both single and batched variants. For single
* transfers, the length of the `ids` and `amounts` arrays will be 1.
*
* Calling conditions (for each `id` and `amount` pair):
*
* - When `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* of token type `id` will be transferred to `to`.
* - When `from` is zero, `amount` tokens of token type `id` will be minted
* for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens of token type `id`
* will be burned.
* - `from` and `to` are never both zero.
* - `ids` and `amounts` have the same, non-zero length.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address operator,
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes memory data
) internal virtual {}
/**
* @dev Hook that is called after any token transfer. This includes minting
* and burning, as well as batched variants.
*
* The same hook is called on both single and batched variants. For single
* transfers, the length of the `id` and `amount` arrays will be 1.
*
* Calling conditions (for each `id` and `amount` pair):
*
* - When `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* of token type `id` will be transferred to `to`.
* - When `from` is zero, `amount` tokens of token type `id` will be minted
* for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens of token type `id`
* will be burned.
* - `from` and `to` are never both zero.
* - `ids` and `amounts` have the same, non-zero length.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(
address operator,
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes memory data
) internal virtual {}
function _doSafeTransferAcceptanceCheck(
address operator,
address from,
address to,
uint256 id,
uint256 amount,
bytes memory data
) private {
if (to.isContract()) {
try IERC1155Receiver(to).onERC1155Received(operator, from, id, amount, data) returns (bytes4 response) {
if (response != IERC1155Receiver.onERC1155Received.selector) {
revert("ERC1155: ERC1155Receiver rejected tokens");
}
} catch Error(string memory reason) {
revert(reason);
} catch {
revert("ERC1155: transfer to non ERC1155Receiver implementer");
}
}
}
function _doSafeBatchTransferAcceptanceCheck(
address operator,
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes memory data
) private {
if (to.isContract()) {
try IERC1155Receiver(to).onERC1155BatchReceived(operator, from, ids, amounts, data) returns (
bytes4 response
) {
if (response != IERC1155Receiver.onERC1155BatchReceived.selector) {
revert("ERC1155: ERC1155Receiver rejected tokens");
}
} catch Error(string memory reason) {
revert(reason);
} catch {
revert("ERC1155: transfer to non ERC1155Receiver implementer");
}
}
}
function _asSingletonArray(uint256 element) private pure returns (uint256[] memory) {
uint256[] memory array = new uint256[](1);
array[0] = element;
return array;
}
}
// 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.7.0) (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 Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
require(!paused(), "Pausable: paused");
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
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.7.0) (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 Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
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);
}
}