// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;
// _____ _____ _____
// /\ \ /\ \ /\ \
// /::\____\ /::\ \ /::\ \
// /:::/ / /::::\ \ /::::\ \
// /:::/ / /::::::\ \ /::::::\ \
// /:::/ / /:::/\:::\ \ /:::/\:::\ \
// /:::/ / /:::/__\:::\ \ /:::/ \:::\ \
// /:::/ / /::::\ \:::\ \ /:::/ \:::\ \
// /:::/ / /::::::\ \:::\ \ /:::/ / \:::\ \
// /:::/ / /:::/\:::\ \:::\ \ /:::/ / \:::\ ___\
// /:::/____/ /:::/ \:::\ \:::\____\ /:::/____/ ___\:::| |
// \:::\ \ \::/ \:::\ /:::/ / \:::\ \ /\ /:::|____|
// \:::\ \ \/____/ \:::\/:::/ / \:::\ /::\ \::/ /
// \:::\ \ \::::::/ / \:::\ \:::\ \/____/
// \:::\ \ \::::/ / \:::\ \:::\____\
// \:::\ \ /:::/ / \:::\ /:::/ /
// \:::\ \ /:::/ / \:::\/:::/ /
// \:::\ \ /:::/ / \::::::/ /
// \:::\____\ /:::/ / \::::/ /
// \::/ / \::/ / \::/ /
// \/____/ \/____/ \/____/
// interface of a custom tokenURI
interface ITokenURICustom {
function constructTokenURI(uint256 tokenId) external view returns (string memory);
}
/// @notice Ownable
/// @author From OpenZeppelin Contracts v4.4.1
abstract contract Ownable {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
constructor() {
_transferOwnership(msg.sender);
}
function owner() public view virtual returns (address) {
return _owner;
}
modifier onlyOwner() {
require(owner() == msg.sender, "Ownable: caller is not the owner");
_;
}
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
/// @notice ERC1155 TML Edtions
/// @author Mauro
/// @author Modified from Solmate (https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC1155.sol)
/// @author Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/tree/master/contracts/token/ERC1155/ERC1155.sol)
contract ERC1155_TML is Ownable {
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/
event TransferSingle(
address indexed operator, address indexed from, address indexed to, uint256 id, uint256 amount
);
event TransferBatch(
address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] amounts
);
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
event URI(string value, uint256 indexed id);
/*//////////////////////////////////////////////////////////////
ERC1155 STORAGE
//////////////////////////////////////////////////////////////*/
address[] public allowedMinters;
mapping(address => mapping(uint256 => uint256)) public balanceOf;
mapping(address => mapping(address => bool)) public isApprovedForAll;
mapping(uint256 => bool) public uriLocked;
mapping(uint256 => bool) public mintIdLocked;
mapping(uint256 => address) public customURI;
mapping(uint256 => string) private _tokenURIs;
// ERC-2981: NFT Royalty Standard
address payable private _royaltyRecipient;
uint256 private _royaltyBps;
mapping(uint256 => uint256) private _royaltyBpsTokenId;
constructor() {
_royaltyRecipient = payable(msg.sender);
_royaltyBps = 1000;
allowedMinters.push(msg.sender);
}
/*//////////////////////////////////////////////////////////////
ERC1155 LOGIC
//////////////////////////////////////////////////////////////*/
function setApprovalForAll(address operator, bool approved) public virtual {
isApprovedForAll[msg.sender][operator] = approved;
emit ApprovalForAll(msg.sender, operator, approved);
}
function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes calldata data)
public
virtual
{
require(msg.sender == from || isApprovedForAll[from][msg.sender], "NOT_AUTHORIZED");
balanceOf[from][id] -= amount;
balanceOf[to][id] += amount;
emit TransferSingle(msg.sender, from, to, id, amount);
require(
to.code.length == 0
? to != address(0)
: ERC1155TokenReceiver(to).onERC1155Received(msg.sender, from, id, amount, data)
== ERC1155TokenReceiver.onERC1155Received.selector,
"UNSAFE_RECIPIENT"
);
}
function safeBatchTransferFrom(
address from,
address to,
uint256[] calldata ids,
uint256[] calldata amounts,
bytes calldata data
) public virtual {
require(ids.length == amounts.length, "LENGTH_MISMATCH");
require(msg.sender == from || isApprovedForAll[from][msg.sender], "NOT_AUTHORIZED");
// Storing these outside the loop saves ~15 gas per iteration.
uint256 id;
uint256 amount;
for (uint256 i = 0; i < ids.length;) {
id = ids[i];
amount = amounts[i];
balanceOf[from][id] -= amount;
balanceOf[to][id] += amount;
// An array can't have a total length
// larger than the max uint256 value.
unchecked {
++i;
}
}
emit TransferBatch(msg.sender, from, to, ids, amounts);
require(
to.code.length == 0
? to != address(0)
: ERC1155TokenReceiver(to).onERC1155BatchReceived(msg.sender, from, ids, amounts, data)
== ERC1155TokenReceiver.onERC1155BatchReceived.selector,
"UNSAFE_RECIPIENT"
);
}
function balanceOfBatch(address[] calldata owners, uint256[] calldata ids)
public
view
virtual
returns (uint256[] memory balances)
{
require(owners.length == ids.length, "LENGTH_MISMATCH");
balances = new uint256[](owners.length);
// Unchecked because the only math done is incrementing
// the array index counter which cannot possibly overflow.
unchecked {
for (uint256 i = 0; i < owners.length; ++i) {
balances[i] = balanceOf[owners[i]][ids[i]];
}
}
}
/*//////////////////////////////////////////////////////////////
ERC165 LOGIC
//////////////////////////////////////////////////////////////*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == 0x01ffc9a7 // ERC165
|| interfaceId == 0xd9b67a26 // ERC1155
|| interfaceId == 0x0e89341c // ERC1155MetadataURI
|| interfaceId == 0x2a55205a; // ERC2981 = 0x2a55205a;
}
/*//////////////////////////////////////////////////////////////
INTERNAL MINT/BURN LOGIC
//////////////////////////////////////////////////////////////*/
function _mint(address to, uint256 id, uint256 amount, bytes memory data) internal virtual {
balanceOf[to][id] += amount;
emit TransferSingle(msg.sender, address(0), to, id, amount);
require(
to.code.length == 0
? to != address(0)
: ERC1155TokenReceiver(to).onERC1155Received(msg.sender, address(0), id, amount, data)
== ERC1155TokenReceiver.onERC1155Received.selector,
"UNSAFE_RECIPIENT"
);
}
function _batchMint(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data)
internal
virtual
{
uint256 idsLength = ids.length; // Saves MLOADs.
require(idsLength == amounts.length, "LENGTH_MISMATCH");
for (uint256 i = 0; i < idsLength;) {
balanceOf[to][ids[i]] += amounts[i];
// An array can't have a total length
// larger than the max uint256 value.
unchecked {
++i;
}
}
emit TransferBatch(msg.sender, address(0), to, ids, amounts);
require(
to.code.length == 0
? to != address(0)
: ERC1155TokenReceiver(to).onERC1155BatchReceived(msg.sender, address(0), ids, amounts, data)
== ERC1155TokenReceiver.onERC1155BatchReceived.selector,
"UNSAFE_RECIPIENT"
);
}
function _batchBurn(address from, uint256[] memory ids, uint256[] memory amounts) internal virtual {
uint256 idsLength = ids.length; // Saves MLOADs.
require(idsLength == amounts.length, "LENGTH_MISMATCH");
for (uint256 i = 0; i < idsLength;) {
balanceOf[from][ids[i]] -= amounts[i];
// An array can't have a total length
// larger than the max uint256 value.
unchecked {
++i;
}
}
emit TransferBatch(msg.sender, from, address(0), ids, amounts);
}
function _burn(address from, uint256 id, uint256 amount) internal virtual {
balanceOf[from][id] -= amount;
emit TransferSingle(msg.sender, from, address(0), id, amount);
}
/*//////////////////////////////////////////////////////////////
MINT/BURN/URI LOGIC
//////////////////////////////////////////////////////////////*/
function addMinter(address minterAddress) external onlyOwner {
allowedMinters.push(minterAddress);
}
function updateMinter(address minterAddress, uint256 minterIdx) external onlyOwner {
allowedMinters[minterIdx] = minterAddress;
}
function setUri(uint256[] calldata tokenId, string[] calldata newUri) external onlyOwner {
require(tokenId.length == newUri.length, "Length mismatch");
unchecked {
for (uint256 i = 0; i < tokenId.length; i++) {
require(!uriLocked[tokenId[i]], "URI locked");
_tokenURIs[tokenId[i]] = newUri[i];
emit URI(newUri[i], tokenId[i]);
}
}
}
function setCustomUri(uint256[] calldata tokenId, address[] calldata newUriContract) external onlyOwner {
require(tokenId.length == newUriContract.length, "Length mismatch");
unchecked {
for (uint256 i = 0; i < tokenId.length; i++) {
require(!uriLocked[tokenId[i]], "URI locked");
customURI[tokenId[i]] = newUriContract[i];
emit URI("Custom URI", tokenId[i]);
}
}
}
function lockUri(uint256[] calldata tokenId) external onlyOwner {
unchecked {
for (uint256 i = 0; i < tokenId.length; i++) {
uriLocked[tokenId[i]] = true;
}
}
}
function lockMintId(uint256[] calldata tokenId) external onlyOwner {
unchecked {
for (uint256 i = 0; i < tokenId.length; i++) {
mintIdLocked[tokenId[i]] = true;
}
}
}
function mint(address to, uint256 id, uint256 amount, bytes calldata data, uint256 minterIdx) external {
require(msg.sender == allowedMinters[minterIdx], "Minter not valid");
require(!mintIdLocked[id], "No more minting allowed");
_mint(to, id, amount, data);
}
function batchMint(
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes calldata data,
uint256 minterIdx
) external {
require(msg.sender == allowedMinters[minterIdx], "Minter not valid");
unchecked {
for (uint256 i = 0; i < ids.length; i++) {
require(!mintIdLocked[ids[i]], "No more minting allowed");
}
}
_batchMint(to, ids, amounts, data);
}
function mintMultipleUsers(
address[] calldata recipients,
uint256 id,
uint256 amount,
bytes calldata data,
uint256 minterIdx
) external {
require(msg.sender == allowedMinters[minterIdx], "Minter not valid");
require(!mintIdLocked[id], "No more minting allowed");
unchecked {
for (uint256 i = 0; i < recipients.length; i++) {
_mint(recipients[i], id, amount, data);
}
}
}
function burn(address from, uint256 id, uint256 amount) external {
require(msg.sender == from || isApprovedForAll[from][msg.sender], "NOT_AUTHORIZED");
_burn(from, id, amount);
}
function batchBurn(address from, uint256[] memory ids, uint256[] memory amounts) external {
require(msg.sender == from || isApprovedForAll[from][msg.sender], "NOT_AUTHORIZED");
_batchBurn(from, ids, amounts);
}
function uri(uint256 id) public view returns (string memory) {
if (customURI[id] != address(0)) {
return ITokenURICustom(customURI[id]).constructTokenURI(id);
} else {
return _tokenURIs[id];
}
}
/*//////////////////////////////////////////////////////////////
EIP-2981 ROYALTY STANDARD
//////////////////////////////////////////////////////////////*/
function setRoyaltyBps(uint256 royaltyPercentageBasisPoints) public onlyOwner {
_royaltyBps = royaltyPercentageBasisPoints;
}
function setRoyaltyBpsForTokenId(uint256 tokenId, uint256 royaltyPercentageBasisPoints) public onlyOwner {
_royaltyBpsTokenId[tokenId] = royaltyPercentageBasisPoints;
}
function setRoyaltyReceipientAddress(address payable royaltyReceipientAddress) public onlyOwner {
_royaltyRecipient = royaltyReceipientAddress;
}
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount)
{
uint256 bps;
if (_royaltyBpsTokenId[tokenId] > 0) {
bps = _royaltyBpsTokenId[tokenId];
} else {
bps = _royaltyBps;
}
uint256 royalty = (salePrice * bps) / 10000;
return (_royaltyRecipient, royalty);
}
}
abstract contract ERC1155TokenReceiver {
function onERC1155Received(address, address, uint256, uint256, bytes calldata) external virtual returns (bytes4) {
return ERC1155TokenReceiver.onERC1155Received.selector;
}
function onERC1155BatchReceived(address, address, uint256[] calldata, uint256[] calldata, bytes calldata)
external
virtual
returns (bytes4)
{
return ERC1155TokenReceiver.onERC1155BatchReceived.selector;
}
}
{
"compilationTarget": {
"src/ERC1155_TML.sol": "ERC1155_TML"
},
"evmVersion": "shanghai",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 20000
},
"remappings": []
}
[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":false,"internalType":"bool","name":"approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256[]","name":"ids","type":"uint256[]"},{"indexed":false,"internalType":"uint256[]","name":"amounts","type":"uint256[]"}],"name":"TransferBatch","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"id","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"TransferSingle","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"string","name":"value","type":"string"},{"indexed":true,"internalType":"uint256","name":"id","type":"uint256"}],"name":"URI","type":"event"},{"inputs":[{"internalType":"address","name":"minterAddress","type":"address"}],"name":"addMinter","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"allowedMinters","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address[]","name":"owners","type":"address[]"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"balanceOfBatch","outputs":[{"internalType":"uint256[]","name":"balances","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"},{"internalType":"uint256[]","name":"amounts","type":"uint256[]"}],"name":"batchBurn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"},{"internalType":"uint256[]","name":"amounts","type":"uint256[]"},{"internalType":"bytes","name":"data","type":"bytes"},{"internalType":"uint256","name":"minterIdx","type":"uint256"}],"name":"batchMint","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"uint256","name":"id","type":"uint256"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"burn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"customURI","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenId","type":"uint256[]"}],"name":"lockMintId","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenId","type":"uint256[]"}],"name":"lockUri","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"id","type":"uint256"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"},{"internalType":"uint256","name":"minterIdx","type":"uint256"}],"name":"mint","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"mintIdLocked","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address[]","name":"recipients","type":"address[]"},{"internalType":"uint256","name":"id","type":"uint256"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"},{"internalType":"uint256","name":"minterIdx","type":"uint256"}],"name":"mintMultipleUsers","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"salePrice","type":"uint256"}],"name":"royaltyInfo","outputs":[{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint256","name":"royaltyAmount","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"},{"internalType":"uint256[]","name":"amounts","type":"uint256[]"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"safeBatchTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"id","type":"uint256"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenId","type":"uint256[]"},{"internalType":"address[]","name":"newUriContract","type":"address[]"}],"name":"setCustomUri","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"royaltyPercentageBasisPoints","type":"uint256"}],"name":"setRoyaltyBps","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"uint256","name":"royaltyPercentageBasisPoints","type":"uint256"}],"name":"setRoyaltyBpsForTokenId","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address payable","name":"royaltyReceipientAddress","type":"address"}],"name":"setRoyaltyReceipientAddress","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenId","type":"uint256[]"},{"internalType":"string[]","name":"newUri","type":"string[]"}],"name":"setUri","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"minterAddress","type":"address"},{"internalType":"uint256","name":"minterIdx","type":"uint256"}],"name":"updateMinter","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"id","type":"uint256"}],"name":"uri","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"uriLocked","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"}]