Contract Name:
HyperMintERC1155_2_2_0
Contract Source Code:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.2;
import '@openzeppelin/contracts/interfaces/IERC2981.sol';
import '@openzeppelin/contracts/interfaces/IERC20.sol';
import '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Burnable.sol';
import '@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol';
import '@openzeppelin/contracts/utils/cryptography/ECDSA.sol';
import './Ownable_1_0_0.sol';
contract HyperMintERC1155_2_0_0 is ERC1155Burnable, Ownable {
using SafeERC20 for IERC20;
/* ================= CUSTOM ERRORS ================= */
error NewSupplyTooLow();
error ArrayLengthMismatch();
error MaxSupplyExceeded();
error SignatureExpired();
error NotAuthorised();
error BuyDisabled();
error InsufficientPaymentValue();
error PublicSaleClosed();
error SaleClosed();
error MaxPerTransactionsExceeded();
error ContractCallBlocked();
error ImmutableRecoveryAddress();
/* ================= STATE VARIABLES ================= */
// ============== Structs ==============
struct Addresses {
address recoveryAddress;
address collectionOwnerAddress;
address authorisationAddress;
address purchaseTokenAddress;
address managerPrimaryRoyaltyAddress;
address customerPrimaryRoyaltyAddress;
address secondaryRoyaltyAddress;
}
struct TokenInfo {
uint256[] prices;
uint256[] supplies;
uint256[] totalSupplies;
uint256[] maxPerTransactions;
}
// ========= Immutable Storage =========
uint256 internal constant BASIS_POINTS = 10000;
// ========== Mutable Storage ==========
string public constant version = '2.0.0';
/// @dev token info
string public name;
string public symbol;
uint256[] public prices;
uint256[] public supplies;
uint256[] public totalSupplies;
uint256[] public maxPerTransactions;
/// @dev metadata info
string public contractURI;
/// @dev toggle for api mints
bool public allowBuy;
/// @dev sale dates
uint256 public publicSaleDate;
uint256 public saleCloseDate;
/// @dev royalty fees
uint256 public primaryRoyaltyFee;
uint256 public secondaryRoyaltyFee;
Addresses public addresses;
/* =================== CONSTRUCTOR =================== */
/// @notice Creates a new NFT contract
/// @param _name token name
/// @param _symbol token symbol
/// @param _contractMetadataURI contract metadata uri
/// @param _allowBuy toggle to enable/disable buying
/// @param _addresses a collection of addresses
constructor(
string memory _name,
string memory _symbol,
string memory _contractMetadataURI,
string memory _tokenMetadataURI,
bool _allowBuy,
Addresses memory _addresses
) ERC1155('') {
_transferOwnership(_addresses.collectionOwnerAddress);
name = _name;
symbol = _symbol;
allowBuy = _allowBuy;
_setURI(_tokenMetadataURI);
contractURI = _contractMetadataURI;
addresses = _addresses;
}
/* ====================== Views ====================== */
function getTokenInfo() external view returns (TokenInfo memory tokenInfo) {
tokenInfo = TokenInfo(
prices,
supplies,
totalSupplies,
maxPerTransactions
);
}
function totalSupply(uint256 _tokenId)
public
view
returns (uint256 _totalSupply)
{
_totalSupply = totalSupplies[_tokenId];
}
function royaltyInfo(uint256 _tokenId, uint256 _salePrice)
external
view
returns (address royaltyAddress, uint256 royaltyAmount)
{
/// @dev secondary royalty to be paid out by the marketplace
/// to the splitter contract
royaltyAddress = addresses.secondaryRoyaltyAddress;
royaltyAmount = (_salePrice * secondaryRoyaltyFee) / BASIS_POINTS;
}
function supportsInterface(bytes4 _interfaceId)
public
view
virtual
override(ERC1155)
returns (bool result)
{
result = (_interfaceId == type(IERC2981).interfaceId ||
super.supportsInterface(_interfaceId));
}
/* ================ MUTATIVE FUNCTIONS ================ */
// ============ Restricted =============
function setNameAndSymbol(
string calldata _newName,
string calldata _newSymbol
) external onlyContractManager {
name = _newName;
symbol = _newSymbol;
}
function setMetadataURIs(
string calldata _contractURI,
string calldata _tokenURI
) external onlyContractManager {
contractURI = _contractURI;
_setURI(_tokenURI);
}
function setDates(uint256 _publicSale, uint256 _saleClosed)
external
onlyContractManager
{
publicSaleDate = _publicSale;
saleCloseDate = _saleClosed;
}
function setTokenData(
uint256 _id,
uint256 _price,
uint256 _supply,
uint256 _maxPerAddress
) external onlyContractManager {
if (supplies[_id] > _supply) revert NewSupplyTooLow();
prices[_id] = _price;
totalSupplies[_id] = _supply;
maxPerTransactions[_id] = _maxPerAddress;
}
function setAddresses(Addresses calldata _addresses)
external
onlyContractManager
{
if (_addresses.recoveryAddress != addresses.recoveryAddress)
revert ImmutableRecoveryAddress();
if (
addresses.collectionOwnerAddress !=
_addresses.collectionOwnerAddress
) {
_transferOwnership(_addresses.collectionOwnerAddress);
}
addresses = _addresses;
}
function setAllowBuy(bool _allowBuy) external onlyContractManager {
allowBuy = _allowBuy;
}
function addTokens(
uint256[] calldata _newSupplies,
uint256[] calldata _newPrices,
uint256[] calldata _maxPerTransactions
) external onlyContractManager arrayLengthMatch(_newSupplies, _newPrices) {
uint256 suppliesLength = _newSupplies.length;
if (suppliesLength != _newPrices.length) revert ArrayLengthMismatch();
for (uint256 i = 0; i < suppliesLength; ) {
totalSupplies.push(_newSupplies[i]);
supplies.push(0);
prices.push(_newPrices[i]);
maxPerTransactions.push(_maxPerTransactions[i]);
unchecked {
++i;
}
}
}
function setRoyalty(uint256 _primaryFee, uint256 _secondaryFee)
external
onlyContractManager
{
primaryRoyaltyFee = _primaryFee;
secondaryRoyaltyFee = _secondaryFee;
}
// ============== Minting ==============
function mintBatch(
address[] calldata _to,
uint256[][] calldata _ids,
uint256[][] calldata _amounts
) external onlyContractManager nonContract {
uint256 toLength = _to.length;
for (uint256 i = 0; i < toLength; ) {
uint256 idsLength = _ids[i].length;
for (uint256 j = 0; j < idsLength; ) {
uint256 _supply = supplies[_ids[i][j]];
if (_supply + _amounts[i][j] > totalSupplies[_ids[i][j]])
revert MaxSupplyExceeded();
/// @dev remove overflow protection enabled by default
/// as supplies is already capped by totalSupplies
unchecked {
_supply += _amounts[i][j];
}
/// @dev write back to storage
supplies[_ids[i][j]] = _supply;
unchecked {
++j;
}
}
_mintBatch(_to[i], _ids[i], _amounts[i], '0x');
unchecked {
++i;
}
}
}
// ================ Buy ================
function buyAuthorised(
uint256 _id,
uint256 _amount,
uint256 _totalPrice,
uint256 _maxPerAddress,
uint256 _expires,
bytes calldata _signature
) external payable buyAllowed nonContract {
if (block.timestamp >= _expires) revert SignatureExpired();
bytes32 hash = keccak256(
abi.encodePacked(
address(this),
msg.sender,
_amount,
_totalPrice,
_maxPerAddress,
_expires,
_id
)
);
bytes32 message = ECDSA.toEthSignedMessageHash(hash);
if (
ECDSA.recover(message, _signature) != addresses.authorisationAddress
) revert NotAuthorised();
_buy(_id, _amount, _totalPrice);
}
function buy(uint256 _id, uint256 _amount)
external
payable
buyAllowed
nonContract
{
if (publicSaleDate == 0 || block.timestamp < publicSaleDate) revert PublicSaleClosed();
uint256 totalPrice = prices[_id] * _amount;
_buy(_id, _amount, totalPrice);
}
function _buy(
uint256 _id,
uint256 _amount,
uint256 _totalPrice
) internal {
uint256 _supply = supplies[_id];
if (saleCloseDate != 0) {
if (block.timestamp >= saleCloseDate) revert SaleClosed();
}
if (_supply + _amount > totalSupplies[_id]) revert MaxSupplyExceeded();
if (maxPerTransactions[_id] != 0) {
if (_amount > maxPerTransactions[_id])
revert MaxPerTransactionsExceeded();
}
uint256 royaltyAmount = (_totalPrice * primaryRoyaltyFee) /
BASIS_POINTS;
if (addresses.purchaseTokenAddress != address(0)) {
IERC20 token = IERC20(addresses.purchaseTokenAddress);
/// @dev primary royalty cut for Hypermint
token.safeTransferFrom(
msg.sender,
addresses.managerPrimaryRoyaltyAddress,
royaltyAmount
);
/// @dev primary sale (i.e. minting revenue) for customer (or its payees)
token.safeTransferFrom(
msg.sender,
addresses.customerPrimaryRoyaltyAddress,
_totalPrice - royaltyAmount
);
} else {
if (msg.value < _totalPrice) revert InsufficientPaymentValue();
/// @dev primary royalty cut for Hypermint
payable(addresses.managerPrimaryRoyaltyAddress).transfer(
royaltyAmount
);
/// @dev primary sale (i.e. minting revenue) for customer (or its payees)
payable(addresses.customerPrimaryRoyaltyAddress).transfer(
_totalPrice - royaltyAmount
);
}
/// @dev remove overflow protection enabled by default
/// as supply is already capped by totalSupply
unchecked {
_supply += _amount;
}
/// @dev write back to storage
supplies[_id] = _supply;
_mint(msg.sender, _id, _amount, '0x');
}
// ============= Ownership=============
function recoverContract() external {
if (msg.sender != addresses.recoveryAddress) revert NotAuthorised();
_transferContractManager(addresses.recoveryAddress);
}
/* ==================== MODIFIERS ===================== */
modifier buyAllowed() {
if (!allowBuy) revert BuyDisabled();
_;
}
modifier arrayLengthMatch(
uint256[] calldata arr1,
uint256[] calldata arr2
) {
if (arr1.length != arr2.length) revert ArrayLengthMismatch();
_;
}
/// @dev this eliminates the possibility of being called
/// from a contract
modifier nonContract() {
if (tx.origin != msg.sender) revert ContractCallBlocked();
_;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (interfaces/IERC2981.sol)
pragma solidity ^0.8.0;
import "../utils/introspection/IERC165.sol";
/**
* @dev Interface for the NFT Royalty Standard.
*
* A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
* support for royalty payments across all NFT marketplaces and ecosystem participants.
*
* _Available since v4.5._
*/
interface IERC2981 is IERC165 {
/**
* @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
* exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
*/
function royaltyInfo(uint256 tokenId, uint256 salePrice)
external
view
returns (address receiver, uint256 royaltyAmount);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (interfaces/IERC20.sol)
pragma solidity ^0.8.0;
import "../token/ERC20/IERC20.sol";
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC1155/extensions/ERC1155Burnable.sol)
pragma solidity ^0.8.0;
import "../ERC1155.sol";
/**
* @dev Extension of {ERC1155} that allows token holders to destroy both their
* own tokens and those that they have been approved to use.
*
* _Available since v3.1._
*/
abstract contract ERC1155Burnable is ERC1155 {
function burn(
address account,
uint256 id,
uint256 value
) public virtual {
require(
account == _msgSender() || isApprovedForAll(account, _msgSender()),
"ERC1155: caller is not owner nor approved"
);
_burn(account, id, value);
}
function burnBatch(
address account,
uint256[] memory ids,
uint256[] memory values
) public virtual {
require(
account == _msgSender() || isApprovedForAll(account, _msgSender()),
"ERC1155: caller is not owner nor approved"
);
_burnBatch(account, ids, values);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(
IERC20 token,
address spender,
uint256 value
) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// 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 (access/Ownable.sol)
pragma solidity ^0.8.4;
import '@openzeppelin/contracts/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;
address private _contractManager;
event ContractManagerTransferred(
address indexed previousContractManager,
address indexed newContractManager
);
event OwnershipTransferred(
address indexed previousOwner,
address indexed newOwner
);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferContractManager(msg.sender);
}
/**
* @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 Returns the manager of the contract
*/
function contractManager() public view virtual returns (address) {
return _contractManager;
}
/**
* @dev Throws if called by any account other than the Contract Manager.
*/
modifier onlyContractManager() {
require(
_msgSender() == _contractManager,
'Ownable: caller is not the contract manager'
);
_;
}
/**
* @dev Transfers manager of the contract to a new account (`newContractManager`).
* Can only be called by the current _contractManager.
*/
function transferContractManager(address newContractManager)
public
virtual
onlyContractManager
{
require(
newContractManager != address(0),
'Ownable: new contract owner is the zero address'
);
_transferContractManager(newContractManager);
}
/**
* @dev Transfers management of the contract to a new account (`newContractManager`).
* Internal function without access restriction.
*/
function _transferContractManager(address newContractManager)
internal
virtual
{
address oldContractManager = _contractManager;
_contractManager = newContractManager;
emit ContractManagerTransferred(oldContractManager, newContractManager);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.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.6.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: balance query for the zero address");
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 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: transfer caller is not 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}.
*
* 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`
*
* 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}.
*
* 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 a {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 `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 _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 (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 be 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.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 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) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Strings.sol)
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
// Inspired by OraclizeAPI's implementation - MIT licence
// https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
if (value == 0) {
return "0";
}
uint256 temp = value;
uint256 digits;
while (temp != 0) {
digits++;
temp /= 10;
}
bytes memory buffer = new bytes(digits);
while (value != 0) {
digits -= 1;
buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
value /= 10;
}
return string(buffer);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
if (value == 0) {
return "0x00";
}
uint256 temp = value;
uint256 length = 0;
while (temp != 0) {
length++;
temp >>= 8;
}
return toHexString(value, length);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _HEX_SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
import {IOperatorFilterRegistry} from './IOperatorFilterRegistry.sol';
abstract contract OperatorFilterer {
error OperatorNotAllowed(address operator);
IOperatorFilterRegistry constant operatorFilterRegistry =
IOperatorFilterRegistry(0x000000000000AAeB6D7670E522A718067333cd4E);
constructor(address subscriptionOrRegistrantToCopy, bool subscribe) {
// If an inheriting token contract is deployed to a network without the registry deployed, the modifier
// will not revert, but the contract will need to be registered with the registry once it is deployed in
// order for the modifier to filter addresses.
if (address(operatorFilterRegistry).code.length > 0) {
if (subscribe) {
operatorFilterRegistry.registerAndSubscribe(
address(this),
subscriptionOrRegistrantToCopy
);
} else {
if (subscriptionOrRegistrantToCopy != address(0)) {
operatorFilterRegistry.registerAndCopyEntries(
address(this),
subscriptionOrRegistrantToCopy
);
} else {
operatorFilterRegistry.register(address(this));
}
}
}
}
modifier onlyAllowedOperator(address from, bool switchedOn) virtual {
// return back out if toggle is off
if (!switchedOn) {
_;
return;
}
// Check registry code length to facilitate testing in environments without a deployed registry.
if (address(operatorFilterRegistry).code.length > 0) {
// Allow spending tokens from addresses with balance
// Note that this still allows listings and marketplaces with escrow to transfer tokens if transferred
// from an EOA.
if (from == msg.sender) {
_;
return;
}
if (
!(operatorFilterRegistry.isOperatorAllowed(
address(this),
msg.sender
) &&
operatorFilterRegistry.isOperatorAllowed(
address(this),
from
))
) {
revert OperatorNotAllowed(msg.sender);
}
}
_;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (interfaces/IERC165.sol)
pragma solidity ^0.8.0;
import "../utils/introspection/IERC165.sol";
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
interface IOperatorFilterRegistry {
function isOperatorAllowed(address registrant, address operator)
external
view
returns (bool);
function register(address registrant) external;
function registerAndSubscribe(address registrant, address subscription)
external;
function registerAndCopyEntries(
address registrant,
address registrantToCopy
) external;
function updateOperator(
address registrant,
address operator,
bool filtered
) external;
function updateOperators(
address registrant,
address[] calldata operators,
bool filtered
) external;
function updateCodeHash(
address registrant,
bytes32 codehash,
bool filtered
) external;
function updateCodeHashes(
address registrant,
bytes32[] calldata codeHashes,
bool filtered
) external;
function subscribe(address registrant, address registrantToSubscribe)
external;
function unsubscribe(address registrant, bool copyExistingEntries) external;
function subscriptionOf(address addr) external returns (address registrant);
function subscribers(address registrant)
external
returns (address[] memory);
function subscriberAt(address registrant, uint256 index)
external
returns (address);
function copyEntriesOf(address registrant, address registrantToCopy)
external;
function isOperatorFiltered(address registrant, address operator)
external
returns (bool);
function isCodeHashOfFiltered(address registrant, address operatorWithCode)
external
returns (bool);
function isCodeHashFiltered(address registrant, bytes32 codeHash)
external
returns (bool);
function filteredOperators(address addr)
external
returns (address[] memory);
function filteredCodeHashes(address addr)
external
returns (bytes32[] memory);
function filteredOperatorAt(address registrant, uint256 index)
external
returns (address);
function filteredCodeHashAt(address registrant, uint256 index)
external
returns (bytes32);
function isRegistered(address addr) external returns (bool);
function codeHashOf(address addr) external returns (bytes32);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.10;
import '@openzeppelin/contracts/interfaces/IERC2981.sol';
import '@openzeppelin/contracts/interfaces/IERC20.sol';
import '@openzeppelin/contracts/token/ERC1155/extensions/ERC1155Burnable.sol';
import '@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol';
import '@openzeppelin/contracts/utils/cryptography/ECDSA.sol';
import './opensea-operator-filter/OperatorFilterer.sol';
import './Ownable_1_0_0.sol';
import './Interfaces/IHyperMintERC1155_2_2_0.sol';
contract HyperMintERC1155_2_2_0 is
IHyperMintERC1155_2_2_0,
ERC1155Burnable,
Ownable,
OperatorFilterer
{
using SafeERC20 for IERC20;
/* ================= STATE VARIABLES ================= */
// ========= Immutable Storage =========
uint256 internal constant BASIS_POINTS = 10000;
// ========== Mutable Storage ==========
string public constant version = '2.2.0';
GeneralConfig public generalConfig;
TokenConfig[] public tokenConfigs;
Addresses public addresses;
uint256[] public supplies;
/* =================== CONSTRUCTOR =================== */
/// @param _generalConfig settings for the contract
/// @param _addresses a collection of addresses
constructor(
GeneralConfig memory _generalConfig,
Addresses memory _addresses
)
ERC1155('')
OperatorFilterer(
address(0x3cc6CddA760b79bAfa08dF41ECFA224f810dCeB6), // default filter by OS
true // subscribe to the filter list
)
{
_transferOwnership(_addresses.collectionOwnerAddress);
generalConfig = _generalConfig;
addresses = _addresses;
_setURI(generalConfig.tokenMetadataUrl);
}
/* ====================== Views ====================== */
function getTokenConfigs()
external
view
returns (TokenConfig[] memory configs)
{
configs = tokenConfigs;
}
function getSupplies()
external
view
returns (uint256[] memory tokenSupplies)
{
tokenSupplies = supplies;
}
function name() public view returns (string memory collectionName) {
collectionName = generalConfig.name;
}
function symbol() public view returns (string memory collectionSymbol) {
collectionSymbol = generalConfig.symbol;
}
function contractURI() public view virtual returns (string memory uri) {
uri = generalConfig.contractMetadataUrl;
}
function royaltyInfo(
uint256 _tokenId,
uint256 _salePrice
) external view returns (address royaltyAddress, uint256 royaltyAmount) {
/// @dev secondary royalty to be paid out by the marketplace
/// to the splitter contract
royaltyAddress = addresses.secondaryRoyaltyAddress;
royaltyAmount =
(_salePrice * generalConfig.secondaryRoyaltyFee) /
BASIS_POINTS;
}
function supportsInterface(
bytes4 _interfaceId
)
public
view
virtual
override(ERC1155, IHyperMintERC1155_2_2_0)
returns (bool result)
{
result = (_interfaceId == type(IERC2981).interfaceId ||
super.supportsInterface(_interfaceId));
}
/* ================ MUTATIVE FUNCTIONS ================ */
// ============ Restricted =============
function setNameAndSymbol(
string calldata _newName,
string calldata _newSymbol
) external onlyContractManager {
generalConfig.name = _newName;
generalConfig.symbol = _newSymbol;
}
function setMetadataURIs(
string calldata _contractURI,
string calldata _tokenURI
) external onlyContractManager {
generalConfig.contractMetadataUrl = _contractURI;
generalConfig.tokenMetadataUrl = _tokenURI;
_setURI(_tokenURI);
}
function setDates(
uint256 _publicSale,
uint256 _saleClosed
) external onlyContractManager {
generalConfig.publicSaleDate = _publicSale;
generalConfig.saleCloseDate = _saleClosed;
}
function setTokenConfig(
uint256 _id,
uint256 _price,
uint256 _maxSupply,
uint256 _maxPerTransaction
) external onlyContractManager {
if (supplies[_id] > _maxSupply) revert NewSupplyTooLow();
tokenConfigs[_id].price = _price;
tokenConfigs[_id].maxSupply = _maxSupply;
tokenConfigs[_id].maxPerTransaction = _maxPerTransaction;
}
function setAddresses(
Addresses calldata _addresses
) external onlyContractManager {
if (_addresses.recoveryAddress != addresses.recoveryAddress)
revert ImmutableRecoveryAddress();
if (
addresses.collectionOwnerAddress !=
_addresses.collectionOwnerAddress
) {
_transferOwnership(_addresses.collectionOwnerAddress);
}
addresses = _addresses;
}
function setAllowBuy(bool _allowBuy) external onlyContractManager {
generalConfig.allowBuy = _allowBuy;
}
function setAllowPublicTransfer(
bool _allowPublicTransfer
) external onlyContractManager {
generalConfig.allowPublicTransfer = _allowPublicTransfer;
}
function setEnableOpenSeaOperatorFilterRegistry(
bool _enable
) external onlyContractManager {
generalConfig.enableOpenSeaOperatorFilterRegistry = _enable;
}
function setRoyalty(
uint256 _primaryFee,
uint256 _secondaryFee
) external onlyContractManager {
generalConfig.primaryRoyaltyFee = _primaryFee;
generalConfig.secondaryRoyaltyFee = _secondaryFee;
}
function addTokens(
TokenConfig[] calldata _tokens
) external onlyContractManager {
for (uint256 i = 0; i < _tokens.length; ) {
supplies.push(0);
tokenConfigs.push(_tokens[i]);
unchecked {
++i;
}
}
}
// ============== Minting ==============
function mintBatch(
address[] calldata _to,
uint256[][] calldata _ids,
uint256[][] calldata _amounts
) external onlyContractManager nonContract {
uint256 toLength = _to.length;
for (uint256 i = 0; i < toLength; ) {
uint256 idsLength = _ids[i].length;
for (uint256 j = 0; j < idsLength; ) {
uint256 _supply = supplies[_ids[i][j]];
if (
_supply + _amounts[i][j] >
tokenConfigs[_ids[i][j]].maxSupply
) revert MaxSupplyExceeded();
/// @dev remove overflow protection enabled by default
/// as supplies is already capped by totalSupplies
unchecked {
_supply += _amounts[i][j];
}
/// @dev write back to storage
supplies[_ids[i][j]] = _supply;
unchecked {
++j;
}
}
_mintBatch(_to[i], _ids[i], _amounts[i], '0x');
unchecked {
++i;
}
}
}
// ================ Buy ================
function buyAuthorised(
uint256 _id,
uint256 _amount,
uint256 _totalPrice,
uint256 _maxPerAddress,
uint256 _expires,
bytes calldata _signature
) external payable buyAllowed nonContract {
if (block.timestamp >= _expires) revert SignatureExpired();
bytes32 hash = keccak256(
abi.encodePacked(
address(this),
msg.sender,
_amount,
_totalPrice,
_maxPerAddress,
_expires,
_id
)
);
bytes32 message = ECDSA.toEthSignedMessageHash(hash);
if (
ECDSA.recover(message, _signature) != addresses.authorisationAddress
) revert NotAuthorised();
_buy(_id, _amount, _totalPrice);
}
function buy(
uint256 _id,
uint256 _amount
) external payable buyAllowed nonContract {
if (
generalConfig.publicSaleDate == 0 ||
block.timestamp < generalConfig.publicSaleDate
) revert PublicSaleClosed();
uint256 totalPrice = tokenConfigs[_id].price * _amount;
_buy(_id, _amount, totalPrice);
}
function _buy(uint256 _id, uint256 _amount, uint256 _totalPrice) internal {
if (generalConfig.saleCloseDate != 0) {
if (block.timestamp >= generalConfig.saleCloseDate)
revert SaleClosed();
}
uint256 _supply = supplies[_id];
uint256 _maxSupply = tokenConfigs[_id].maxSupply;
if (_supply + _amount > _maxSupply) revert MaxSupplyExceeded();
uint256 _maxPerTransaction = tokenConfigs[_id].maxPerTransaction;
if (_maxPerTransaction != 0) {
if (_amount > _maxPerTransaction)
revert MaxPerTransactionsExceeded();
}
uint256 royaltyAmount = (_totalPrice *
generalConfig.primaryRoyaltyFee) / BASIS_POINTS;
if (addresses.purchaseTokenAddress != address(0)) {
IERC20 token = IERC20(addresses.purchaseTokenAddress);
/// @dev primary royalty cut for Hypermint
token.safeTransferFrom(
msg.sender,
addresses.managerPrimaryRoyaltyAddress,
royaltyAmount
);
/// @dev primary sale (i.e. minting revenue) for customer (or its payees)
token.safeTransferFrom(
msg.sender,
addresses.customerPrimaryRoyaltyAddress,
_totalPrice - royaltyAmount
);
} else {
if (msg.value < _totalPrice) revert InsufficientPaymentValue();
/// @dev primary royalty cut for Hypermint
payable(addresses.managerPrimaryRoyaltyAddress).transfer(
royaltyAmount
);
/// @dev primary sale (i.e. minting revenue) for customer (or its payees)
payable(addresses.customerPrimaryRoyaltyAddress).transfer(
_totalPrice - royaltyAmount
);
}
/// @dev remove overflow protection enabled by default
/// as supply is already capped by totalSupply
unchecked {
_supply += _amount;
}
/// @dev write back to storage
supplies[_id] = _supply;
_mint(msg.sender, _id, _amount, '0x');
}
// ================ Transfers ================
function _beforeTokenTransfer(
address operator,
address from,
address to,
uint256[] memory ids,
uint256[] memory amounts,
bytes memory data
)
internal
override(ERC1155)
transferAllowed(from, to)
onlyAllowedOperator(
from,
generalConfig.enableOpenSeaOperatorFilterRegistry
)
{
super._beforeTokenTransfer(operator, from, to, ids, amounts, data);
}
function transferAuthorised(
address _from,
address _to,
uint256 _tokenId,
uint256 _amount,
uint256 _expires,
bytes calldata _signature
) external nonContract {
if (block.timestamp >= _expires) revert SignatureExpired();
bytes32 hash = keccak256(
abi.encodePacked(
address(this),
msg.sender,
_from,
_to,
_tokenId,
_amount,
_expires
)
);
bytes32 message = ECDSA.toEthSignedMessageHash(hash);
if (
ECDSA.recover(message, _signature) != addresses.authorisationAddress
) revert NotAuthorised();
super.safeTransferFrom(_from, _to, _tokenId, _amount, '0x');
}
// ============= Ownership=============
function recoverContract() external {
if (msg.sender != addresses.recoveryAddress) revert NotAuthorised();
_transferContractManager(addresses.recoveryAddress);
}
/* ==================== MODIFIERS ===================== */
modifier buyAllowed() {
if (!generalConfig.allowBuy) revert BuyDisabled();
_;
}
/// @dev this eliminates the possibility of being called
/// from a contract
modifier nonContract() {
if (tx.origin != msg.sender) revert ContractCallBlocked();
_;
}
modifier transferAllowed(address from, address to) {
bool isMinting = from == address(0);
bool isBurning = to == address(0);
bool isContractManager = from == this.contractManager();
bool isTransferAuthorised = msg.sig == this.transferAuthorised.selector;
if (
!isMinting &&
!isContractManager &&
!isBurning &&
!isTransferAuthorised
) {
if (!generalConfig.allowPublicTransfer) revert TransfersDisabled();
}
_;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.10;
// ============== Structs ==============
struct GeneralConfig {
string name;
string symbol;
string contractMetadataUrl;
string tokenMetadataUrl;
bool allowBuy;
bool allowPublicTransfer;
bool enableOpenSeaOperatorFilterRegistry;
uint256 publicSaleDate;
uint256 saleCloseDate;
uint256 primaryRoyaltyFee;
uint256 secondaryRoyaltyFee;
}
struct TokenConfig {
uint256 price;
uint256 maxSupply;
uint256 maxPerTransaction;
}
struct Addresses {
address recoveryAddress;
address collectionOwnerAddress;
address authorisationAddress;
address purchaseTokenAddress;
address managerPrimaryRoyaltyAddress;
address customerPrimaryRoyaltyAddress;
address secondaryRoyaltyAddress;
}
interface IHyperMintERC1155_2_2_0 {
/* ================= CUSTOM ERRORS ================= */
error NewSupplyTooLow();
error ArrayLengthMismatch();
error MaxSupplyExceeded();
error SignatureExpired();
error NotAuthorised();
error BuyDisabled();
error InsufficientPaymentValue();
error PublicSaleClosed();
error SaleClosed();
error MaxPerTransactionsExceeded();
error ContractCallBlocked();
error ImmutableRecoveryAddress();
error TransfersDisabled();
/* ====================== Views ====================== */
function name() external view returns (string memory collectionName);
function symbol() external view returns (string memory collectionSymbol);
function getTokenConfigs()
external
view
returns (TokenConfig[] memory configs);
function getSupplies()
external
view
returns (uint256[] memory tokenSupplies);
function contractURI() external view returns (string memory uri);
function royaltyInfo(
uint256 _tokenId,
uint256 _salePrice
) external view returns (address royaltyAddress, uint256 royaltyAmount);
function supportsInterface(
bytes4 _interfaceId
) external view returns (bool result);
/* ================ MUTATIVE FUNCTIONS ================ */
// ============ Restricted =============
function setNameAndSymbol(
string calldata _name,
string calldata _symbol
) external;
function setMetadataURIs(
string calldata _contractUri,
string calldata _tokenUri
) external;
function setDates(uint256 _publicSale, uint256 _saleClosed) external;
function setTokenConfig(
uint256 _id,
uint256 _price,
uint256 _maxSupply,
uint256 _maxPerTransaction
) external;
function setAddresses(Addresses calldata _addresses) external;
function setAllowBuy(bool allowBuy) external;
function setAllowPublicTransfer(bool _allowPublicTransfer) external;
function setEnableOpenSeaOperatorFilterRegistry(bool _enable) external;
function setRoyalty(uint256 primaryFee, uint256 secondaryFee) external;
function addTokens(TokenConfig[] calldata _tokens) external;
// ============== Minting ==============
function mintBatch(
address[] calldata _to,
uint256[][] calldata _ids,
uint256[][] calldata _amounts
) external;
// ================ Buy ================
function buyAuthorised(
uint256 _id,
uint256 _amount,
uint256 _totalPrice,
uint256 _maxPerAddress,
uint256 _expires,
bytes calldata _signature
) external payable;
function buy(uint256 _id, uint256 _amount) external payable;
// ================ Transfers ================
function transferAuthorised(
address _from,
address _to,
uint256 _tokenId,
uint256 _amount,
uint256 _expires,
bytes calldata _signature
) external;
}
// 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);
}
}