// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^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.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 2 of 8: ERC721A.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.0.0// Creator: Chiru Labspragmasolidity ^0.8.4;import'./IERC721A.sol';
/**
* @dev ERC721 token receiver interface.
*/interfaceERC721A__IERC721Receiver{
functiononERC721Received(address operator,
addressfrom,
uint256 tokenId,
bytescalldata data
) externalreturns (bytes4);
}
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension. Built to optimize for lower gas during batch mints.
*
* Assumes serials are sequentially minted starting at _startTokenId() (defaults to 0, e.g. 0, 1, 2, 3..).
*
* Assumes that an owner cannot have more than 2**64 - 1 (max value of uint64) of supply.
*
* Assumes that the maximum token id cannot exceed 2**256 - 1 (max value of uint256).
*/contractERC721AisIERC721A{
// Mask of an entry in packed address data.uint256privateconstant BITMASK_ADDRESS_DATA_ENTRY = (1<<64) -1;
// The bit position of `numberMinted` in packed address data.uint256privateconstant BITPOS_NUMBER_MINTED =64;
// The bit position of `numberBurned` in packed address data.uint256privateconstant BITPOS_NUMBER_BURNED =128;
// The bit position of `aux` in packed address data.uint256privateconstant BITPOS_AUX =192;
// Mask of all 256 bits in packed address data except the 64 bits for `aux`.uint256privateconstant BITMASK_AUX_COMPLEMENT = (1<<192) -1;
// The bit position of `startTimestamp` in packed ownership.uint256privateconstant BITPOS_START_TIMESTAMP =160;
// The bit mask of the `burned` bit in packed ownership.uint256privateconstant BITMASK_BURNED =1<<224;
// The bit position of the `nextInitialized` bit in packed ownership.uint256privateconstant BITPOS_NEXT_INITIALIZED =225;
// The bit mask of the `nextInitialized` bit in packed ownership.uint256privateconstant BITMASK_NEXT_INITIALIZED =1<<225;
// The tokenId of the next token to be minted.uint256private _currentIndex;
// The number of tokens burned.uint256private _burnCounter;
// Token namestringprivate _name;
// Token symbolstringprivate _symbol;
// Mapping from token ID to ownership details// An empty struct value does not necessarily mean the token is unowned.// See `_packedOwnershipOf` implementation for details.//// Bits Layout:// - [0..159] `addr`// - [160..223] `startTimestamp`// - [224] `burned`// - [225] `nextInitialized`mapping(uint256=>uint256) private _packedOwnerships;
// Mapping owner address to address data.//// Bits Layout:// - [0..63] `balance`// - [64..127] `numberMinted`// - [128..191] `numberBurned`// - [192..255] `aux`mapping(address=>uint256) private _packedAddressData;
// Mapping from token ID to approved address.mapping(uint256=>address) private _tokenApprovals;
// Mapping from owner to operator approvalsmapping(address=>mapping(address=>bool)) private _operatorApprovals;
constructor(stringmemory name_, stringmemory symbol_) {
_name = name_;
_symbol = symbol_;
_currentIndex = _startTokenId();
}
/**
* @dev Returns the starting token ID.
* To change the starting token ID, please override this function.
*/function_startTokenId() internalviewvirtualreturns (uint256) {
return0;
}
/**
* @dev Returns the next token ID to be minted.
*/function_nextTokenId() internalviewreturns (uint256) {
return _currentIndex;
}
/**
* @dev Returns the total number of tokens in existence.
* Burned tokens will reduce the count.
* To get the total number of tokens minted, please see `_totalMinted`.
*/functiontotalSupply() publicviewoverridereturns (uint256) {
// Counter underflow is impossible as _burnCounter cannot be incremented// more than `_currentIndex - _startTokenId()` times.unchecked {
return _currentIndex - _burnCounter - _startTokenId();
}
}
/**
* @dev Returns the total amount of tokens minted in the contract.
*/function_totalMinted() internalviewreturns (uint256) {
// Counter underflow is impossible as _currentIndex does not decrement,// and it is initialized to `_startTokenId()`unchecked {
return _currentIndex - _startTokenId();
}
}
/**
* @dev Returns the total number of tokens burned.
*/function_totalBurned() internalviewreturns (uint256) {
return _burnCounter;
}
/**
* @dev See {IERC165-supportsInterface}.
*/functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverridereturns (bool) {
// The interface IDs are constants representing the first 4 bytes of the XOR of// all function selectors in the interface. See: https://eips.ethereum.org/EIPS/eip-165// e.g. `bytes4(i.functionA.selector ^ i.functionB.selector ^ ...)`return
interfaceId ==0x01ffc9a7||// ERC165 interface ID for ERC165.
interfaceId ==0x80ac58cd||// ERC165 interface ID for ERC721.
interfaceId ==0x5b5e139f; // ERC165 interface ID for ERC721Metadata.
}
/**
* @dev See {IERC721-balanceOf}.
*/functionbalanceOf(address owner) publicviewoverridereturns (uint256) {
if (owner ==address(0)) revert BalanceQueryForZeroAddress();
return _packedAddressData[owner] & BITMASK_ADDRESS_DATA_ENTRY;
}
/**
* Returns the number of tokens minted by `owner`.
*/function_numberMinted(address owner) internalviewreturns (uint256) {
return (_packedAddressData[owner] >> BITPOS_NUMBER_MINTED) & BITMASK_ADDRESS_DATA_ENTRY;
}
/**
* Returns the number of tokens burned by or on behalf of `owner`.
*/function_numberBurned(address owner) internalviewreturns (uint256) {
return (_packedAddressData[owner] >> BITPOS_NUMBER_BURNED) & BITMASK_ADDRESS_DATA_ENTRY;
}
/**
* Returns the auxillary data for `owner`. (e.g. number of whitelist mint slots used).
*/function_getAux(address owner) internalviewreturns (uint64) {
returnuint64(_packedAddressData[owner] >> BITPOS_AUX);
}
/**
* Sets the auxillary data for `owner`. (e.g. number of whitelist mint slots used).
* If there are multiple variables, please pack them into a uint64.
*/function_setAux(address owner, uint64 aux) internal{
uint256 packed = _packedAddressData[owner];
uint256 auxCasted;
assembly { // Cast aux without masking.
auxCasted := aux
}
packed = (packed & BITMASK_AUX_COMPLEMENT) | (auxCasted << BITPOS_AUX);
_packedAddressData[owner] = packed;
}
/**
* Returns the packed ownership data of `tokenId`.
*/function_packedOwnershipOf(uint256 tokenId) privateviewreturns (uint256) {
uint256 curr = tokenId;
unchecked {
if (_startTokenId() <= curr)
if (curr < _currentIndex) {
uint256 packed = _packedOwnerships[curr];
// If not burned.if (packed & BITMASK_BURNED ==0) {
// Invariant:// There will always be an ownership that has an address and is not burned// before an ownership that does not have an address and is not burned.// Hence, curr will not underflow.//// We can directly compare the packed value.// If the address is zero, packed is zero.while (packed ==0) {
packed = _packedOwnerships[--curr];
}
return packed;
}
}
}
revert OwnerQueryForNonexistentToken();
}
/**
* Returns the unpacked `TokenOwnership` struct from `packed`.
*/function_unpackedOwnership(uint256 packed) privatepurereturns (TokenOwnership memory ownership) {
ownership.addr =address(uint160(packed));
ownership.startTimestamp =uint64(packed >> BITPOS_START_TIMESTAMP);
ownership.burned = packed & BITMASK_BURNED !=0;
}
/**
* Returns the unpacked `TokenOwnership` struct at `index`.
*/function_ownershipAt(uint256 index) internalviewreturns (TokenOwnership memory) {
return _unpackedOwnership(_packedOwnerships[index]);
}
/**
* @dev Initializes the ownership slot minted at `index` for efficiency purposes.
*/function_initializeOwnershipAt(uint256 index) internal{
if (_packedOwnerships[index] ==0) {
_packedOwnerships[index] = _packedOwnershipOf(index);
}
}
/**
* Gas spent here starts off proportional to the maximum mint batch size.
* It gradually moves to O(1) as tokens get transferred around in the collection over time.
*/function_ownershipOf(uint256 tokenId) internalviewreturns (TokenOwnership memory) {
return _unpackedOwnership(_packedOwnershipOf(tokenId));
}
/**
* @dev See {IERC721-ownerOf}.
*/functionownerOf(uint256 tokenId) publicviewoverridereturns (address) {
returnaddress(uint160(_packedOwnershipOf(tokenId)));
}
/**
* @dev See {IERC721Metadata-name}.
*/functionname() publicviewvirtualoverridereturns (stringmemory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/functionsymbol() publicviewvirtualoverridereturns (stringmemory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/functiontokenURI(uint256 tokenId) publicviewvirtualoverridereturns (stringmemory) {
if (!_exists(tokenId)) revert URIQueryForNonexistentToken();
stringmemory baseURI = _baseURI();
returnbytes(baseURI).length!=0 ? string(abi.encodePacked(baseURI, _toString(tokenId))) : '';
}
/**
* @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
* token will be the concatenation of the `baseURI` and the `tokenId`. Empty
* by default, can be overriden in child contracts.
*/function_baseURI() internalviewvirtualreturns (stringmemory) {
return'';
}
/**
* @dev Casts the address to uint256 without masking.
*/function_addressToUint256(address value) privatepurereturns (uint256 result) {
assembly {
result := value
}
}
/**
* @dev Casts the boolean to uint256 without branching.
*/function_boolToUint256(bool value) privatepurereturns (uint256 result) {
assembly {
result := value
}
}
/**
* @dev See {IERC721-approve}.
*/functionapprove(address to, uint256 tokenId) publicoverride{
address owner =address(uint160(_packedOwnershipOf(tokenId)));
if (to == owner) revert ApprovalToCurrentOwner();
if (_msgSenderERC721A() != owner)
if (!isApprovedForAll(owner, _msgSenderERC721A())) {
revert ApprovalCallerNotOwnerNorApproved();
}
_tokenApprovals[tokenId] = to;
emit Approval(owner, to, tokenId);
}
/**
* @dev See {IERC721-getApproved}.
*/functiongetApproved(uint256 tokenId) publicviewoverridereturns (address) {
if (!_exists(tokenId)) revert ApprovalQueryForNonexistentToken();
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/functionsetApprovalForAll(address operator, bool approved) publicvirtualoverride{
if (operator == _msgSenderERC721A()) revert ApproveToCaller();
_operatorApprovals[_msgSenderERC721A()][operator] = approved;
emit ApprovalForAll(_msgSenderERC721A(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/functionisApprovedForAll(address owner, address operator) publicviewvirtualoverridereturns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/functiontransferFrom(addressfrom,
address to,
uint256 tokenId
) publicvirtualoverride{
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId
) publicvirtualoverride{
safeTransferFrom(from, to, tokenId, '');
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId,
bytesmemory _data
) publicvirtualoverride{
_transfer(from, to, tokenId);
if (to.code.length!=0)
if (!_checkContractOnERC721Received(from, to, tokenId, _data)) {
revert TransferToNonERC721ReceiverImplementer();
}
}
/**
* @dev Returns whether `tokenId` exists.
*
* Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}.
*
* Tokens start existing when they are minted (`_mint`),
*/function_exists(uint256 tokenId) internalviewreturns (bool) {
return
_startTokenId() <= tokenId &&
tokenId < _currentIndex &&// If within bounds,
_packedOwnerships[tokenId] & BITMASK_BURNED ==0; // and not burned.
}
/**
* @dev Equivalent to `_safeMint(to, quantity, '')`.
*/function_safeMint(address to, uint256 quantity) internal{
_safeMint(to, quantity, '');
}
/**
* @dev Safely mints `quantity` tokens and transfers them to `to`.
*
* Requirements:
*
* - If `to` refers to a smart contract, it must implement
* {IERC721Receiver-onERC721Received}, which is called for each safe transfer.
* - `quantity` must be greater than 0.
*
* Emits a {Transfer} event.
*/function_safeMint(address to,
uint256 quantity,
bytesmemory _data
) internal{
uint256 startTokenId = _currentIndex;
if (to ==address(0)) revert MintToZeroAddress();
if (quantity ==0) revert MintZeroQuantity();
_beforeTokenTransfers(address(0), to, startTokenId, quantity);
// Overflows are incredibly unrealistic.// balance or numberMinted overflow if current value of either + quantity > 1.8e19 (2**64) - 1// updatedIndex overflows if _currentIndex + quantity > 1.2e77 (2**256) - 1unchecked {
// Updates:// - `balance += quantity`.// - `numberMinted += quantity`.//// We can directly add to the balance and number minted.
_packedAddressData[to] += quantity * ((1<< BITPOS_NUMBER_MINTED) |1);
// Updates:// - `address` to the owner.// - `startTimestamp` to the timestamp of minting.// - `burned` to `false`.// - `nextInitialized` to `quantity == 1`.
_packedOwnerships[startTokenId] =
_addressToUint256(to) |
(block.timestamp<< BITPOS_START_TIMESTAMP) |
(_boolToUint256(quantity ==1) << BITPOS_NEXT_INITIALIZED);
uint256 updatedIndex = startTokenId;
uint256 end = updatedIndex + quantity;
if (to.code.length!=0) {
do {
emit Transfer(address(0), to, updatedIndex);
if (!_checkContractOnERC721Received(address(0), to, updatedIndex++, _data)) {
revert TransferToNonERC721ReceiverImplementer();
}
} while (updatedIndex < end);
// Reentrancy protectionif (_currentIndex != startTokenId) revert();
} else {
do {
emit Transfer(address(0), to, updatedIndex++);
} while (updatedIndex < end);
}
_currentIndex = updatedIndex;
}
_afterTokenTransfers(address(0), to, startTokenId, quantity);
}
/**
* @dev Mints `quantity` tokens and transfers them to `to`.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `quantity` must be greater than 0.
*
* Emits a {Transfer} event.
*/function_mint(address to, uint256 quantity) internal{
uint256 startTokenId = _currentIndex;
if (to ==address(0)) revert MintToZeroAddress();
if (quantity ==0) revert MintZeroQuantity();
_beforeTokenTransfers(address(0), to, startTokenId, quantity);
// Overflows are incredibly unrealistic.// balance or numberMinted overflow if current value of either + quantity > 1.8e19 (2**64) - 1// updatedIndex overflows if _currentIndex + quantity > 1.2e77 (2**256) - 1unchecked {
// Updates:// - `balance += quantity`.// - `numberMinted += quantity`.//// We can directly add to the balance and number minted.
_packedAddressData[to] += quantity * ((1<< BITPOS_NUMBER_MINTED) |1);
// Updates:// - `address` to the owner.// - `startTimestamp` to the timestamp of minting.// - `burned` to `false`.// - `nextInitialized` to `quantity == 1`.
_packedOwnerships[startTokenId] =
_addressToUint256(to) |
(block.timestamp<< BITPOS_START_TIMESTAMP) |
(_boolToUint256(quantity ==1) << BITPOS_NEXT_INITIALIZED);
uint256 updatedIndex = startTokenId;
uint256 end = updatedIndex + quantity;
do {
emit Transfer(address(0), to, updatedIndex++);
} while (updatedIndex < end);
_currentIndex = updatedIndex;
}
_afterTokenTransfers(address(0), to, startTokenId, quantity);
}
/**
* @dev Transfers `tokenId` from `from` to `to`.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
*
* Emits a {Transfer} event.
*/function_transfer(addressfrom,
address to,
uint256 tokenId
) private{
uint256 prevOwnershipPacked = _packedOwnershipOf(tokenId);
if (address(uint160(prevOwnershipPacked)) !=from) revert TransferFromIncorrectOwner();
bool isApprovedOrOwner = (_msgSenderERC721A() ==from||
isApprovedForAll(from, _msgSenderERC721A()) ||
getApproved(tokenId) == _msgSenderERC721A());
if (!isApprovedOrOwner) revert TransferCallerNotOwnerNorApproved();
if (to ==address(0)) revert TransferToZeroAddress();
_beforeTokenTransfers(from, to, tokenId, 1);
// Clear approvals from the previous owner.delete _tokenApprovals[tokenId];
// Underflow of the sender's balance is impossible because we check for// ownership above and the recipient's balance can't realistically overflow.// Counter overflow is incredibly unrealistic as tokenId would have to be 2**256.unchecked {
// We can directly increment and decrement the balances.--_packedAddressData[from]; // Updates: `balance -= 1`.++_packedAddressData[to]; // Updates: `balance += 1`.// Updates:// - `address` to the next owner.// - `startTimestamp` to the timestamp of transfering.// - `burned` to `false`.// - `nextInitialized` to `true`.
_packedOwnerships[tokenId] =
_addressToUint256(to) |
(block.timestamp<< BITPOS_START_TIMESTAMP) |
BITMASK_NEXT_INITIALIZED;
// If the next slot may not have been initialized (i.e. `nextInitialized == false`) .if (prevOwnershipPacked & BITMASK_NEXT_INITIALIZED ==0) {
uint256 nextTokenId = tokenId +1;
// If the next slot's address is zero and not burned (i.e. packed value is zero).if (_packedOwnerships[nextTokenId] ==0) {
// If the next slot is within bounds.if (nextTokenId != _currentIndex) {
// Initialize the next slot to maintain correctness for `ownerOf(tokenId + 1)`.
_packedOwnerships[nextTokenId] = prevOwnershipPacked;
}
}
}
}
emit Transfer(from, to, tokenId);
_afterTokenTransfers(from, to, tokenId, 1);
}
/**
* @dev Equivalent to `_burn(tokenId, false)`.
*/function_burn(uint256 tokenId) internalvirtual{
_burn(tokenId, false);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/function_burn(uint256 tokenId, bool approvalCheck) internalvirtual{
uint256 prevOwnershipPacked = _packedOwnershipOf(tokenId);
addressfrom=address(uint160(prevOwnershipPacked));
if (approvalCheck) {
bool isApprovedOrOwner = (_msgSenderERC721A() ==from||
isApprovedForAll(from, _msgSenderERC721A()) ||
getApproved(tokenId) == _msgSenderERC721A());
if (!isApprovedOrOwner) revert TransferCallerNotOwnerNorApproved();
}
_beforeTokenTransfers(from, address(0), tokenId, 1);
// Clear approvals from the previous owner.delete _tokenApprovals[tokenId];
// Underflow of the sender's balance is impossible because we check for// ownership above and the recipient's balance can't realistically overflow.// Counter overflow is incredibly unrealistic as tokenId would have to be 2**256.unchecked {
// Updates:// - `balance -= 1`.// - `numberBurned += 1`.//// We can directly decrement the balance, and increment the number burned.// This is equivalent to `packed -= 1; packed += 1 << BITPOS_NUMBER_BURNED;`.
_packedAddressData[from] += (1<< BITPOS_NUMBER_BURNED) -1;
// Updates:// - `address` to the last owner.// - `startTimestamp` to the timestamp of burning.// - `burned` to `true`.// - `nextInitialized` to `true`.
_packedOwnerships[tokenId] =
_addressToUint256(from) |
(block.timestamp<< BITPOS_START_TIMESTAMP) |
BITMASK_BURNED |
BITMASK_NEXT_INITIALIZED;
// If the next slot may not have been initialized (i.e. `nextInitialized == false`) .if (prevOwnershipPacked & BITMASK_NEXT_INITIALIZED ==0) {
uint256 nextTokenId = tokenId +1;
// If the next slot's address is zero and not burned (i.e. packed value is zero).if (_packedOwnerships[nextTokenId] ==0) {
// If the next slot is within bounds.if (nextTokenId != _currentIndex) {
// Initialize the next slot to maintain correctness for `ownerOf(tokenId + 1)`.
_packedOwnerships[nextTokenId] = prevOwnershipPacked;
}
}
}
}
emit Transfer(from, address(0), tokenId);
_afterTokenTransfers(from, address(0), tokenId, 1);
// Overflow not possible, as _burnCounter cannot be exceed _currentIndex times.unchecked {
_burnCounter++;
}
}
/**
* @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target contract.
*
* @param from address representing the previous owner of the given token ID
* @param to target address that will receive the tokens
* @param tokenId uint256 ID of the token to be transferred
* @param _data bytes optional data to send along with the call
* @return bool whether the call correctly returned the expected magic value
*/function_checkContractOnERC721Received(addressfrom,
address to,
uint256 tokenId,
bytesmemory _data
) privatereturns (bool) {
try ERC721A__IERC721Receiver(to).onERC721Received(_msgSenderERC721A(), from, tokenId, _data) returns (
bytes4 retval
) {
return retval == ERC721A__IERC721Receiver(to).onERC721Received.selector;
} catch (bytesmemory reason) {
if (reason.length==0) {
revert TransferToNonERC721ReceiverImplementer();
} else {
assembly {
revert(add(32, reason), mload(reason))
}
}
}
}
/**
* @dev Hook that is called before a set of serially-ordered token ids are about to be transferred. This includes minting.
* And also called before burning one token.
*
* startTokenId - the first token id to be transferred
* quantity - the amount to be transferred
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, `from`'s `tokenId` will be
* transferred to `to`.
* - When `from` is zero, `tokenId` will be minted for `to`.
* - When `to` is zero, `tokenId` will be burned by `from`.
* - `from` and `to` are never both zero.
*/function_beforeTokenTransfers(addressfrom,
address to,
uint256 startTokenId,
uint256 quantity
) internalvirtual{}
/**
* @dev Hook that is called after a set of serially-ordered token ids have been transferred. This includes
* minting.
* And also called after one token has been burned.
*
* startTokenId - the first token id to be transferred
* quantity - the amount to be transferred
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, `from`'s `tokenId` has been
* transferred to `to`.
* - When `from` is zero, `tokenId` has been minted for `to`.
* - When `to` is zero, `tokenId` has been burned by `from`.
* - `from` and `to` are never both zero.
*/function_afterTokenTransfers(addressfrom,
address to,
uint256 startTokenId,
uint256 quantity
) internalvirtual{}
/**
* @dev Returns the message sender (defaults to `msg.sender`).
*
* If you are writing GSN compatible contracts, you need to override this function.
*/function_msgSenderERC721A() internalviewvirtualreturns (address) {
returnmsg.sender;
}
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/function_toString(uint256 value) internalpurereturns (stringmemory ptr) {
assembly {
// The maximum value of a uint256 contains 78 digits (1 byte per digit), // but we allocate 128 bytes to keep the free memory pointer 32-byte word aliged.// We will need 1 32-byte word to store the length, // and 3 32-byte words to store a maximum of 78 digits. Total: 32 + 3 * 32 = 128.
ptr :=add(mload(0x40), 128)
// Update the free memory pointer to allocate.mstore(0x40, ptr)
// Cache the end of the memory to calculate the length later.let end := ptr
// We write the string from the rightmost digit to the leftmost digit.// The following is essentially a do-while loop that also handles the zero case.// Costs a bit more than early returning for the zero case,// but cheaper in terms of deployment and overall runtime costs.for {
// Initialize and perform the first pass without check.let temp := value
// Move the pointer 1 byte leftwards to point to an empty character slot.
ptr :=sub(ptr, 1)
// Write the character to the pointer. 48 is the ASCII index of '0'.mstore8(ptr, add(48, mod(temp, 10)))
temp :=div(temp, 10)
} temp {
// Keep dividing `temp` until zero.
temp :=div(temp, 10)
} { // Body of the for loop.
ptr :=sub(ptr, 1)
mstore8(ptr, add(48, mod(temp, 10)))
}
let length :=sub(end, ptr)
// Move the pointer 32 bytes leftwards to make room for the length.
ptr :=sub(ptr, 32)
// Store the length.mstore(ptr, length)
}
}
}
Contract Source Code
File 3 of 8: HyewonNft.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.4;import"erc721a/contracts/ERC721A.sol";
import"@openzeppelin/contracts/access/Ownable.sol";
import"@openzeppelin/contracts/security/ReentrancyGuard.sol";
import"@openzeppelin/contracts/security/Pausable.sol";
import"./IHyewonNft.sol";
contractHyewonNftisIHyewonNft, ERC721A, Ownable, ReentrancyGuard, Pausable{
/**
* Maximum number of supply
*/uint256public maximumSupply;
/**
* To make token uri immutable permanently
*/boolpublic permanent;
/**
* Minting rounds
*/mapping(uint16=> Round) rounds;
uint256public revealBlockOffset =3000;
/**
* Record how many tokens claimed for each whitelist
*/mapping(uint16=>mapping(address=>uint16)) whitelists;
/**
* Current round number
*/uint16public currentRoundNumber;
addressprivate _receiver;
addressprivate _signer;
/**
* Base uri for token uri
*/stringpublic baseURI;
/**
* Default unrevealed uri
*/stringprivate defaultUnrevealedURI;
/**
* Modifier for onlyOwnerAndAdmin
* Each round could have different admin
*/modifieronlyOwnerOrAdmin(uint16 roundNumber) {
Round memory r = rounds[roundNumber];
address admin = rounds[roundNumber].admin;
if (admin ==address(0)) {
revert BadRequest("Not allowed address");
}
if (msg.sender!= owner() &&msg.sender!= admin) {
revert NotOwnerNorAdmin(msg.sender);
}
_;
}
constructor(address receiver,
uint256 maxSupply,
stringmemory _baseUri,
stringmemory _defaultUnrevealedURI
)
ERC721A("Hyewon's Album of Genre Paintings", "HyewonPaintings")
Ownable()
Pausable()
{
_receiver = receiver;
maximumSupply = maxSupply;
baseURI = _baseUri;
defaultUnrevealedURI = _defaultUnrevealedURI;
}
/**
* Get the STATE of the contract
*/functiongetState() publicviewreturns (State) {
if (currentRoundNumber ==0) {
return State.DEPLOYED;
}
Round memory currentRound = rounds[currentRoundNumber];
uint256 startTime = currentRound.startTime;
uint256 endTime = currentRound.endTime;
uint256 currentTime =block.timestamp;
State currentState;
if (currentTime < startTime) {
currentState = State.PREPARE_MINTING;
} elseif (currentTime < endTime) {
if (currentRound.maxMintingId > totalSupply()) {
currentState = State.ON_MINTING;
} else {
currentState = State.END_MINTING;
}
} else {
currentState = State.END_MINTING;
}
return currentState;
}
/**
* Normal account minting
*/functionmint(uint256 quantity)
externalpayablenonReentrantwhenNotPaused{
Round memory currentRound = getRound(currentRoundNumber);
// check if whitelist only roundif (currentRound.whitelisted) {
revert WhitelistOnlyRound();
}
_sanityCheckForMinting(currentRound, quantity);
require(safeMint(msg.sender, quantity));
}
/**
* Minting for whitelisted accounts only
*/functionwhitelistMint(uint8 v,
bytes32 r,
bytes32 s,
uint16 quantity
) externalpayablenonReentrantwhenNotPaused{
Round memory currentRound = getRound(currentRoundNumber);
// check if whitelist only roundif (!currentRound.whitelisted) {
revert NotWhitelistOnlyRound();
}
_sanityCheckForMinting(currentRound, quantity);
// check if the address has enough allowanceuint16 claimed = whitelists[currentRoundNumber][_msgSender()];
uint16 maxAllowedQuantity = currentRound.maxAllowedMintingQuantity;
if (claimed + quantity > maxAllowedQuantity) {
revert ExceedAllowedQuantity(maxAllowedQuantity);
}
_updateWhitelistUsed(currentRoundNumber, quantity, v, r, s);
require(safeMint(msg.sender, quantity));
}
functionsafeMint(address receiver, uint256 quantity)
privatereturns (bool)
{
_safeMint(receiver, quantity);
returntrue;
}
/**
* Minting for admin account
*/functionadminMint(uint256 quantity)
externalonlyOwnerOrAdmin(currentRoundNumber)
nonReentrant{
Round memory currentRound = rounds[currentRoundNumber];
// check if minting does not exceed the maximum tokens for the rounduint256 maxMintingId = currentRound.maxMintingId;
if (!_isTokenAvailable(quantity, maxMintingId)) {
revert ExceedMaximumForTheRound();
}
require(safeMint(msg.sender, quantity));
}
/**
* Minting and transfer tokens
* Only for owner
*/functionadminMintTo(address[] calldata tos, uint256[] calldata quantities)
externalpayableonlyOwner{
uint256 length = tos.length;
if (length != quantities.length) {
revert BadRequest("Input size not match");
}
uint256 totalQuantity =0;
for (uint256 i =0; i < tos.length; i++) {
totalQuantity += quantities[i];
}
Round memory currentRound = rounds[currentRoundNumber];
// check if minting does not exceed the maximum tokens for the rounduint256 maxMintingId = currentRound.maxMintingId;
if (!_isTokenAvailable(totalQuantity, maxMintingId)) {
revert ExceedMaximumForTheRound();
}
for (uint256 i =0; i < length; i++) {
require(safeMint(tos[i], quantities[i]));
}
}
/**
* Transfer multiple tokens to an account
*/functiontransferBatch(uint256[] calldata tokenIds, address to)
externalnonReentrant{
for (uint256 i =0; i < tokenIds.length; i++) {
safeTransferFrom(_msgSender(), to, tokenIds[i]);
}
}
/**
* Get token uri
*/functiontokenURI(uint256 tokenId)
publicviewoverridereturns (stringmemory)
{
Round memory round = _getRoundByTokenId(tokenId);
if (
round.revealed &&keccak256(abi.encodePacked(round.tokenURIPrefix)) !=keccak256(abi.encodePacked(""))
) {
returnstring(
abi.encodePacked(
baseURI,
round.tokenURIPrefix,
"/",
_toString(tokenId),
".json"
)
);
} else {
returnstring(
abi.encodePacked(
defaultUnrevealedURI,
_toString(tokenId),
".json"
)
);
}
}
/**
* Create a new minting round
* For owner only
*/functionnewRound(uint256 maxMintingId, // largest minting id for the rounduint256 mintingFee, // minting feeuint16 maxAllowedMintingQuantity, // maximum number of minting quantity per accountbool whitelisted, // use whitelist or notbool revealed, // reveal image or notuint256 startTime, // round starting timeuint256 endTime, // round ending timebool onlyAdminRound, // only owner and admin can mintaddress admin // admin for the round) externalonlyOwner{
// wrap-up the existing roundif (currentRoundNumber >0) {
endRound();
}
// the maxMintingId of new round can NOT exceed the maximumSupplyif (maxMintingId > maximumSupply) {
revert BadRequest("maxMintingId exceed the maximumSupply");
}
if (startTime >= endTime) {
revert BadRequest("endTime should be bigger");
}
uint16 newRoundNumber =++currentRoundNumber;
rounds[newRoundNumber] = Round({
roundNumber: newRoundNumber,
maxMintingId: maxMintingId,
startId: _nextTokenId(),
lastMintedId: 0,
tokenURIPrefix: "",
mintingFee: mintingFee,
maxAllowedMintingQuantity: maxAllowedMintingQuantity,
whitelisted: whitelisted,
revealed: revealed,
revealBlockNumber: 0,
randomSelection: 0,
startTime: startTime,
endTime: endTime,
onlyAdminRound: onlyAdminRound,
admin: admin
});
emit NewRoundCreated();
}
/**
* End the current round
* For owner and admin
*/functionendRound() publiconlyOwnerOrAdmin(currentRoundNumber) {
Round storage currentRound = rounds[currentRoundNumber];
currentRound.lastMintedId = _nextTokenId() -1;
currentRound.endTime =block.timestamp;
}
/**
* Get round detail
*/functiongetRound(uint16 roundNumber) publicviewreturns (Round memory) {
return rounds[roundNumber];
}
/**
* Get the detail of the current round
*/functiongetCurrentRound() publicviewreturns (Round memory) {
return getRound(currentRoundNumber);
}
/**
* Set the maximum minting id for the current round
* For owner and admin
*/functionsetMaxMintingId(uint256 maxId) external{
setMaxMintingId(currentRoundNumber, maxId);
}
/**
* Set the maximum minting id for the specified round
* For owner and admin
*/functionsetMaxMintingId(uint16 roundNumber, uint256 maxId)
publiconlyOwnerOrAdmin(roundNumber)
{
if (maxId < _nextTokenId()) {
revert MaxMintingIdLowerThanCurrentId();
}
if (maxId > maximumSupply) {
revert ExceedMaximumSupply();
}
Round storage round = rounds[roundNumber];
round.maxMintingId = maxId;
emit MaxMintingIdUpdated(roundNumber, maxId);
}
/**
* Set the token uri prefix for the current round
* For owner and admin
*/functionsetTokenURIPrefix(stringmemory prefix) external{
setTokenURIPrefix(currentRoundNumber, prefix);
}
/**
* Set the token uri prefix for the specified round
* For owner and admin
*/functionsetTokenURIPrefix(uint16 roundNumber, stringmemory prefix)
publiconlyOwnerOrAdmin(roundNumber)
{
if (permanent) {
revert ImmutableState();
}
Round storage round = rounds[roundNumber];
round.tokenURIPrefix = prefix;
emit TokenURIPrefixUpdated(roundNumber, prefix);
}
/**
* Set the minting for the current round
* OnlyOwner functions
*/functionsetMintingFee(uint256 fee) external{
setMintingFee(currentRoundNumber, fee);
}
/**
* Set the minting for the specified round
* OnlyOwner functions
*/functionsetMintingFee(uint16 roundNumber, uint256 fee)
publiconlyOwnerOrAdmin(roundNumber)
{
Round storage round = rounds[roundNumber];
round.mintingFee = fee;
emit MintingFeeUpdated(roundNumber, fee);
}
/**
* Set maximum minting quantity for an account
* For owner and admin
*/functionsetMaxAllowedMintingQuantity(uint16 quantity) external{
setMaxAllowedMintingQuantity(currentRoundNumber, quantity);
}
/**
* Set maximum minting quantity for an account
* For owner and admin
*/functionsetMaxAllowedMintingQuantity(uint16 roundNumber, uint16 quantity)
publiconlyOwnerOrAdmin(roundNumber)
{
Round storage round = rounds[roundNumber];
round.maxAllowedMintingQuantity = quantity;
emit MaxAllowedMintingCountUpdated(roundNumber, quantity);
}
/**
* On/off the whitelisted for the current round
* For owner and admin
*/functionsetWhitelisted(bool whitelisted) external{
setWhitelisted(currentRoundNumber, whitelisted);
}
/**
* On/off the whitelisted for the specified round
* For owner and admin
*/functionsetWhitelisted(uint16 roundNumber, bool whitelisted)
publiconlyOwnerOrAdmin(roundNumber)
{
Round storage round = rounds[roundNumber];
round.whitelisted = whitelisted;
emit WhitelistRequiredChanged(roundNumber, whitelisted);
}
/**
* Trigger reveal process for the current round
* For owner and admin
*/functionsetRevealBlock() external{
setRevealBlock(currentRoundNumber);
}
/**
* Trigger reveal process for the specified round
* For owner and admin
*/functionsetRevealBlock(uint16 roundNumber)
publiconlyOwnerOrAdmin(roundNumber)
{
Round storage round = rounds[roundNumber];
if (round.lastMintedId ==0) {
revert BadRequest("Round should be closed");
}
round.revealBlockNumber =block.number+ revealBlockOffset;
emit SetRevealBlock(round.revealBlockNumber);
}
/**
* Set random selection number based on entropy
* It set the reveal on
*/functionsetRandomSelection(uint16 roundNumber) public{
Round storage round = rounds[roundNumber];
if (round.revealed) {
revert AlreadyRevealed();
}
uint256 revealBlockNumber = round.revealBlockNumber;
if (revealBlockNumber >block.number) {
revert BadRequest("Random selection is not ready");
}
bytes32 entropy;
if (blockhash(revealBlockNumber -1) !=0) {
entropy =keccak256(
abi.encodePacked(
blockhash(revealBlockNumber),
blockhash(revealBlockNumber -1),
block.timestamp
)
);
} else {
entropy =keccak256(
abi.encodePacked(
blockhash(block.number-1),
blockhash(block.number-2),
block.timestamp
)
);
}
round.revealed =true;
uint256 selected = _getRandomInRange(
entropy,
round.startId,
round.lastMintedId
);
round.randomSelection = selected;
emit Revealed(roundNumber);
}
/**
* Set revealed
* For owner and admin
*/functionsetRevealed() external{
setRevealed(currentRoundNumber);
}
functionsetRevealed(uint16 roundNumber)
publiconlyOwnerOrAdmin(roundNumber)
{
Round storage round = rounds[roundNumber];
if (round.lastMintedId ==0) {
revert BadRequest("Round is still open");
}
round.revealed =true;
emit Revealed(roundNumber);
}
/**
* Set minting start time for the current round
* Only for owner and admin
*/functionsetStartTime(uint256 time) external{
setStartTime(currentRoundNumber, time);
}
/**
* Set minting start time for the specified round
* Only for owner and admin
*/functionsetStartTime(uint16 roundNumber, uint256 time)
publiconlyOwnerOrAdmin(roundNumber)
{
Round storage round = rounds[roundNumber];
round.startTime = time;
emit StartTimeUpdated(roundNumber, time);
}
/**
* Set minting end time for the current round
* Only for owner and admin
*/functionsetEndTime(uint256 time) external{
setEndTime(currentRoundNumber, time);
}
/**
* Set minting end time for the specified round
* Only for owner and admin
*/functionsetEndTime(uint16 roundNumber, uint256 time)
publiconlyOwnerOrAdmin(roundNumber)
{
Round storage round = rounds[roundNumber];
round.endTime = time;
emit EndTimeUpdated(roundNumber, time);
}
/**
* On/off admin only round for the current round
* OnlyOwner
*/functionsetOnlyAdminRound(bool onlyAdmin) external{
setOnlyAdminRound(currentRoundNumber, onlyAdmin);
}
/**
* On/off admin only round for the specified round
* OnlyOwner
*/functionsetOnlyAdminRound(uint16 roundNumber, bool onlyAdmin)
publiconlyOwner{
Round storage round = rounds[roundNumber];
round.onlyAdminRound = onlyAdmin;
emit OnlyAdminRoundChanged(roundNumber, onlyAdmin);
}
/**
* Set the admin for the current round
* OnlyOwner
*/functionsetAdmin(address admin) external{
setAdmin(currentRoundNumber, admin);
}
/**
* Set the admin for the specified round
* OnlyOwner
*/functionsetAdmin(uint16 roundNumber, address admin) publiconlyOwner{
Round storage round = rounds[roundNumber];
round.admin = admin;
emit AdminUpdated(roundNumber, admin);
}
/**
* Internal function to override the ERC721A _baseURI()
*/function_baseURI() internalviewoverridereturns (stringmemory) {
return baseURI;
}
/**
* Get the base uri
*/functiongetBaseURI() externalviewreturns (stringmemory) {
return _baseURI();
}
/**
* Set the base uri
* Only for the owner
*/functionsetBaseURI(stringmemory _newBaseURI) externalonlyOwner{
if (permanent) {
revert ImmutableState();
}
baseURI = _newBaseURI;
emit BaseURIUpdated(_newBaseURI);
}
/**
* Set the default unrevealed uri
* Only for the owner
*/functionsetDefaultUnrevealedURI(stringmemory _defaultUnrevealedURI)
externalonlyOwner{
defaultUnrevealedURI = _defaultUnrevealedURI;
emit DefaultUnrevealedURIUpdated(_defaultUnrevealedURI);
}
/**
* Paused the contract
* Only for the owner
*/functionpause() externalonlyOwner{
_pause();
}
/**
* Unpause the contract
* Only for the owner
*/functionunpause() externalonlyOwner{
_unpause();
}
/**
* Set the receiver
* Only for the owner
*/functionsetReceiver(address receiver) externalonlyOwner{
_receiver = receiver;
}
/**
* Withdraw the balance in the contract
*/functionwithdraw() externalpayableonlyOwner{
uint256 amount =address(this).balance;
(bool success, ) = _receiver.call{value: amount}("");
if (!success) {
revert FailedToSendBalance();
}
emit Withdraw(_receiver, amount);
}
/**
* Fallback function
*/fallback() externalpayable{
emit Received(_msgSender(), msg.value);
}
/**
* Fallback function
*/receive() externalpayable{
emit Received(_msgSender(), msg.value);
}
/**
* Set the 'perment' to true to prevent token uri change
*/functionsetPermanent() externalonlyOwner{
permanent =true;
}
/**
* Update signer
* For only owner
*/functionupdateSigner(address newSigner) externalonlyOwner{
_signer = newSigner;
}
functionupdateRevealBlockOffset(uint256 newOffset) externalonlyOwner{
revealBlockOffset = newOffset;
}
/**
* Sanity check before transfer tokens
*/function_sanityCheckForMinting(Round memory currentRound, uint256 quantity)
private{
// check if onlyAdminRoundif (currentRound.onlyAdminRound) {
revert AdminOnlyRound();
}
State currentState = getState();
if (currentState != State.ON_MINTING) {
revert MintingNotAllowed();
}
// check if not exceeding the maxAllowedMintingQuantityif (
currentRound.maxAllowedMintingQuantity !=0&&
currentRound.maxAllowedMintingQuantity < quantity
) {
revert ExceedAllowedQuantity(
currentRound.maxAllowedMintingQuantity
);
}
// check if minting does not exceed the maximum tokens for the roundif (!_isTokenAvailable(quantity, currentRound.maxMintingId)) {
revert ExceedMaximumForTheRound();
}
// check if proper fee is receiveduint256 neededFee = currentRound.mintingFee * quantity;
if (neededFee !=msg.value) revert NoMatchingFee();
}
/**
* Check the availability of tokens mintable for the round
*/function_isTokenAvailable(uint256 quantity, uint256 maxId)
privateviewreturns (bool)
{
// check if minting does not exceed the maximum tokens for the roundif (_nextTokenId() + quantity > (maxId +1)) {
returnfalse;
}
returntrue;
}
/**
* Private function to get the round number with token id
*/function_getRoundByTokenId(uint256 tokenId)
privateviewreturns (Round memory r)
{
if (!_exists(tokenId)) revert NonExistingToken(tokenId);
uint16 roundNumber =1;
while (roundNumber <= currentRoundNumber) {
r = rounds[roundNumber];
uint256 roundMax = r.lastMintedId !=0
? r.lastMintedId
: r.maxMintingId;
if (tokenId > roundMax) {
roundNumber++;
continue;
}
return r;
}
}
function_updateWhitelistUsed(uint16 round,
uint16 quantity,
uint8 v,
bytes32 r,
bytes32 s
) private{
// verify the signaturebytes32 hash = _getHash(round, _msgSender(), "whitelistClaim");
if (!_verifySig(hash, v, r, s)) {
revert SignatureNotMatch();
}
// add the claimed quantity
whitelists[round][_msgSender()] += quantity;
}
function_getHash(uint16 round,
address sender,
stringmemory message
) privateviewreturns (bytes32) {
returnkeccak256(abi.encodePacked(address(this), round, sender, message));
}
function_verifySig(bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) privateviewreturns (bool) {
returnecrecover(hash, v, r, s) == _signer;
}
function_getRandomInRange(bytes32 hash,
uint256 begin,
uint256 end
) privatepurereturns (uint256) {
uint256 diff = end - begin +1;
return (uint256(hash) % diff) + begin;
}
}
Contract Source Code
File 4 of 8: IERC721A.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.0.0// Creator: Chiru Labspragmasolidity ^0.8.4;/**
* @dev Interface of an ERC721A compliant contract.
*/interfaceIERC721A{
/**
* The caller must own the token or be an approved operator.
*/errorApprovalCallerNotOwnerNorApproved();
/**
* The token does not exist.
*/errorApprovalQueryForNonexistentToken();
/**
* The caller cannot approve to their own address.
*/errorApproveToCaller();
/**
* The caller cannot approve to the current owner.
*/errorApprovalToCurrentOwner();
/**
* Cannot query the balance for the zero address.
*/errorBalanceQueryForZeroAddress();
/**
* Cannot mint to the zero address.
*/errorMintToZeroAddress();
/**
* The quantity of tokens minted must be more than zero.
*/errorMintZeroQuantity();
/**
* The token does not exist.
*/errorOwnerQueryForNonexistentToken();
/**
* The caller must own the token or be an approved operator.
*/errorTransferCallerNotOwnerNorApproved();
/**
* The token must be owned by `from`.
*/errorTransferFromIncorrectOwner();
/**
* Cannot safely transfer to a contract that does not implement the ERC721Receiver interface.
*/errorTransferToNonERC721ReceiverImplementer();
/**
* Cannot transfer to the zero address.
*/errorTransferToZeroAddress();
/**
* The token does not exist.
*/errorURIQueryForNonexistentToken();
structTokenOwnership {
// The address of the owner.address addr;
// Keeps track of the start time of ownership with minimal overhead for tokenomics.uint64 startTimestamp;
// Whether the token has been burned.bool burned;
}
/**
* @dev Returns the total amount of tokens stored by the contract.
*
* Burned tokens are calculated here, use `_totalMinted()` if you want to count just minted tokens.
*/functiontotalSupply() externalviewreturns (uint256);
// ==============================// 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.
*/functionsupportsInterface(bytes4 interfaceId) externalviewreturns (bool);
// ==============================// IERC721// ==============================/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/eventTransfer(addressindexedfrom, addressindexed to, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/eventApproval(addressindexed owner, addressindexed approved, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/eventApprovalForAll(addressindexed owner, addressindexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/functionbalanceOf(address owner) externalviewreturns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functionownerOf(uint256 tokenId) externalviewreturns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId,
bytescalldata data
) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be have been allowed to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId
) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/functiontransferFrom(addressfrom,
address to,
uint256 tokenId
) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/functionapprove(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the caller.
*
* Emits an {ApprovalForAll} event.
*/functionsetApprovalForAll(address operator, bool _approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functiongetApproved(uint256 tokenId) externalviewreturns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/functionisApprovedForAll(address owner, address operator) externalviewreturns (bool);
// ==============================// IERC721Metadata// ==============================/**
* @dev Returns the token collection name.
*/functionname() externalviewreturns (stringmemory);
/**
* @dev Returns the token collection symbol.
*/functionsymbol() externalviewreturns (stringmemory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/functiontokenURI(uint256 tokenId) externalviewreturns (stringmemory);
}
Contract Source Code
File 5 of 8: IHyewonNft.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.4;interfaceIHyewonNft{
errorMintingNotStarted(uint256 startTime);
errorMintingEnded(uint256 endTime);
errorMintingNotAllowed();
errorExceedMaximumForTheRound();
errorExceedMaximumSupply();
errorExceedAllowedQuantity(uint16 maximumAllowedQuantity);
errorMaxMintingIdLowerThanCurrentId();
errorNoMatchingFee();
errorNonExistingToken(uint256 tokenId);
errorAddressNotWhitelisted(address candidate);
errorNotEnoughAllowanceLeft(uint16 remainingAllowance);
errorFailedToSendBalance();
errorNotOwnerNorAdmin(address account);
errorAdminOnlyRound();
errorBadRequest(string reason);
errorWhitelistOnlyRound();
errorNotWhitelistOnlyRound();
errorSignatureNotMatch();
errorAlreadyRevealed();
errorImmutableState();
enumState {
DEPLOYED,
PREPARE_MINTING,
ON_MINTING,
END_MINTING,
ALL_MINTING_DONE
}
structRound {
uint16 roundNumber; // round numberuint256 maxMintingId; // maximum token id for this rounduint256 startId; // beginning of the tokenId for the rounduint256 lastMintedId; // last token id actually minted before the next round startsstring tokenURIPrefix; // directory hash value for token uriuint256 mintingFee; // minting for the rounduint16 maxAllowedMintingQuantity; // max number of tokens for an account (if zero, no limit)bool whitelisted; // use whitelist or notbool revealed; // released token is revealed or notuint256 revealBlockNumber; // blocknubmer which entropy will calculateduint256 randomSelection;
uint256 startTime; // round start timeuint256 endTime; // round end time (if zero, no end time)bool onlyAdminRound; // only admin can mint tokensaddress admin; // additional admin account
}
eventNewRoundCreated();
eventMaxMintingIdUpdated(uint16 roundNumber, uint256 maxId);
eventTokenURIPrefixUpdated(uint16 roundNumber, string prefix);
eventMintingFeeUpdated(uint16 roundNumber, uint256 fee);
eventMaxAllowedMintingCountUpdated(uint16 roundNumber, uint16 count);
eventWhitelistRequiredChanged(uint16 roundNumber, bool whitelisted);
eventSetRevealBlock(uint256 revealBlockNumber);
eventRevealed(uint16 roundNumber);
eventUnrevealedURIUpdated(uint16 roundNumber, string uri);
eventStartTimeUpdated(uint16 roundNumber, uint256 time);
eventEndTimeUpdated(uint16 roundNumber, uint256 time);
eventOnlyAdminRoundChanged(uint16 roundNumber, bool onlyAdmin);
eventAdminUpdated(uint16 roundNumber, address admin);
eventBaseURIUpdated(string baseURI);
eventDefaultUnrevealedURIUpdated(string defaultUnrevealedURI);
eventMintingFeeChanged(uint256 newFee);
eventMaxPublicIdChanged(uint16 newMaxPubId);
eventReceived(address called, uint256 amount);
eventWithdraw(address receiver, uint256 amount);
}
Contract Source Code
File 6 of 8: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (access/Ownable.sol)pragmasolidity ^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.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
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.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
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) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Contract Source Code
File 7 of 8: Pausable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (security/Pausable.sol)pragmasolidity ^0.8.0;import"../utils/Context.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/abstractcontractPausableisContext{
/**
* @dev Emitted when the pause is triggered by `account`.
*/eventPaused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/eventUnpaused(address account);
boolprivate _paused;
/**
* @dev Initializes the contract in unpaused state.
*/constructor() {
_paused =false;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/functionpaused() publicviewvirtualreturns (bool) {
return _paused;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/modifierwhenNotPaused() {
require(!paused(), "Pausable: paused");
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/modifierwhenPaused() {
require(paused(), "Pausable: not paused");
_;
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/function_pause() internalvirtualwhenNotPaused{
_paused =true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/function_unpause() internalvirtualwhenPaused{
_paused =false;
emit Unpaused(_msgSender());
}
}
Contract Source Code
File 8 of 8: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)pragmasolidity ^0.8.0;/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/abstractcontractReentrancyGuard{
// Booleans are more expensive than uint256 or any type that takes up a full// word because each write operation emits an extra SLOAD to first read the// slot's contents, replace the bits taken up by the boolean, and then write// back. This is the compiler's defense against contract upgrades and// pointer aliasing, and it cannot be disabled.// The values being non-zero value makes deployment a bit more expensive,// but in exchange the refund on every call to nonReentrant will be lower in// amount. Since refunds are capped to a percentage of the total// transaction's gas, it is best to keep them low in cases like this one, to// increase the likelihood of the full refund coming into effect.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/modifiernonReentrant() {
// On the first call to nonReentrant, _notEntered will be truerequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}