// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (utils/Base64.sol)pragmasolidity ^0.8.20;/**
* @dev Provides a set of functions to operate with Base64 strings.
*/libraryBase64{
/**
* @dev Base64 Encoding/Decoding Table
*/stringinternalconstant _TABLE ="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
/**
* @dev Converts a `bytes` to its Bytes64 `string` representation.
*/functionencode(bytesmemory data) internalpurereturns (stringmemory) {
/**
* Inspired by Brecht Devos (Brechtpd) implementation - MIT licence
* https://github.com/Brechtpd/base64/blob/e78d9fd951e7b0977ddca77d92dc85183770daf4/base64.sol
*/if (data.length==0) return"";
// Loads the table into memorystringmemory table = _TABLE;
// Encoding takes 3 bytes chunks of binary data from `bytes` data parameter// and split into 4 numbers of 6 bits.// The final Base64 length should be `bytes` data length multiplied by 4/3 rounded up// - `data.length + 2` -> Round up// - `/ 3` -> Number of 3-bytes chunks// - `4 *` -> 4 characters for each chunkstringmemory result =newstring(4* ((data.length+2) /3));
/// @solidity memory-safe-assemblyassembly {
// Prepare the lookup table (skip the first "length" byte)let tablePtr :=add(table, 1)
// Prepare result pointer, jump over lengthlet resultPtr :=add(result, 32)
// Run over the input, 3 bytes at a timefor {
let dataPtr := data
let endPtr :=add(data, mload(data))
} lt(dataPtr, endPtr) {
} {
// Advance 3 bytes
dataPtr :=add(dataPtr, 3)
let input :=mload(dataPtr)
// To write each character, shift the 3 bytes (18 bits) chunk// 4 times in blocks of 6 bits for each character (18, 12, 6, 0)// and apply logical AND with 0x3F which is the number of// the previous character in the ASCII table prior to the Base64 Table// The result is then added to the table to get the character to write,// and finally write it in the result pointer but with a left shift// of 256 (1 byte) - 8 (1 ASCII char) = 248 bitsmstore8(resultPtr, mload(add(tablePtr, and(shr(18, input), 0x3F))))
resultPtr :=add(resultPtr, 1) // Advancemstore8(resultPtr, mload(add(tablePtr, and(shr(12, input), 0x3F))))
resultPtr :=add(resultPtr, 1) // Advancemstore8(resultPtr, mload(add(tablePtr, and(shr(6, input), 0x3F))))
resultPtr :=add(resultPtr, 1) // Advancemstore8(resultPtr, mload(add(tablePtr, and(input, 0x3F))))
resultPtr :=add(resultPtr, 1) // Advance
}
// When data `bytes` is not exactly 3 bytes long// it is padded with `=` characters at the endswitchmod(mload(data), 3)
case1 {
mstore8(sub(resultPtr, 1), 0x3d)
mstore8(sub(resultPtr, 2), 0x3d)
}
case2 {
mstore8(sub(resultPtr, 1), 0x3d)
}
}
return result;
}
}
Contract Source Code
File 3 of 16: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)pragmasolidity ^0.8.20;/**
* @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;
}
function_contextSuffixLength() internalviewvirtualreturns (uint256) {
return0;
}
}
Contract Source Code
File 4 of 16: ERC721A.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.2.3// Creator: Chiru Labspragmasolidity ^0.8.4;import'./IERC721A.sol';
/**
* @dev Interface of ERC721 token receiver.
*/interfaceERC721A__IERC721Receiver{
functiononERC721Received(address operator,
addressfrom,
uint256 tokenId,
bytescalldata data
) externalreturns (bytes4);
}
/**
* @title ERC721A
*
* @dev Implementation of the [ERC721](https://eips.ethereum.org/EIPS/eip-721)
* Non-Fungible Token Standard, including the Metadata extension.
* Optimized for lower gas during batch mints.
*
* Token IDs are minted in sequential order (e.g. 0, 1, 2, 3, ...)
* starting from `_startTokenId()`.
*
* Assumptions:
*
* - An owner cannot have more than 2**64 - 1 (max value of uint64) of supply.
* - The maximum token ID cannot exceed 2**256 - 1 (max value of uint256).
*/contractERC721AisIERC721A{
// Bypass for a `--via-ir` bug (https://github.com/chiru-labs/ERC721A/pull/364).structTokenApprovalRef {
address value;
}
// =============================================================// CONSTANTS// =============================================================// 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 bit position of `extraData` in packed ownership.uint256privateconstant _BITPOS_EXTRA_DATA =232;
// Mask of all 256 bits in a packed ownership except the 24 bits for `extraData`.uint256privateconstant _BITMASK_EXTRA_DATA_COMPLEMENT = (1<<232) -1;
// The mask of the lower 160 bits for addresses.uint256privateconstant _BITMASK_ADDRESS = (1<<160) -1;
// The maximum `quantity` that can be minted with {_mintERC2309}.// This limit is to prevent overflows on the address data entries.// For a limit of 5000, a total of 3.689e15 calls to {_mintERC2309}// is required to cause an overflow, which is unrealistic.uint256privateconstant _MAX_MINT_ERC2309_QUANTITY_LIMIT =5000;
// The `Transfer` event signature is given by:// `keccak256(bytes("Transfer(address,address,uint256)"))`.bytes32privateconstant _TRANSFER_EVENT_SIGNATURE =0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef;
// =============================================================// STORAGE// =============================================================// The next token ID 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`// - [232..255] `extraData`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=> TokenApprovalRef) private _tokenApprovals;
// Mapping from owner to operator approvalsmapping(address=>mapping(address=>bool)) private _operatorApprovals;
// =============================================================// CONSTRUCTOR// =============================================================constructor(stringmemory name_, stringmemory symbol_) {
_name = name_;
_symbol = symbol_;
_currentIndex = _startTokenId();
}
// =============================================================// TOKEN COUNTING OPERATIONS// =============================================================/**
* @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() internalviewvirtualreturns (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() publicviewvirtualoverridereturns (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() internalviewvirtualreturns (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() internalviewvirtualreturns (uint256) {
return _burnCounter;
}
// =============================================================// ADDRESS DATA OPERATIONS// =============================================================/**
* @dev Returns the number of tokens in `owner`'s account.
*/functionbalanceOf(address owner) publicviewvirtualoverridereturns (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 auxiliary data for `owner`. (e.g. number of whitelist mint slots used).
*/function_getAux(address owner) internalviewreturns (uint64) {
returnuint64(_packedAddressData[owner] >> _BITPOS_AUX);
}
/**
* Sets the auxiliary 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) internalvirtual{
uint256 packed = _packedAddressData[owner];
uint256 auxCasted;
// Cast `aux` with assembly to avoid redundant masking.assembly {
auxCasted := aux
}
packed = (packed & _BITMASK_AUX_COMPLEMENT) | (auxCasted << _BITPOS_AUX);
_packedAddressData[owner] = packed;
}
// =============================================================// IERC165// =============================================================/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* [EIP section](https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified)
* to learn more about how these ids are created.
*
* This function call must use less than 30000 gas.
*/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: [ERC165](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.
}
// =============================================================// IERC721Metadata// =============================================================/**
* @dev Returns the token collection name.
*/functionname() publicviewvirtualoverridereturns (stringmemory) {
return _name;
}
/**
* @dev Returns the token collection symbol.
*/functionsymbol() publicviewvirtualoverridereturns (stringmemory) {
return _symbol;
}
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/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, it can be overridden in child contracts.
*/function_baseURI() internalviewvirtualreturns (stringmemory) {
return'';
}
// =============================================================// OWNERSHIPS OPERATIONS// =============================================================/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functionownerOf(uint256 tokenId) publicviewvirtualoverridereturns (address) {
returnaddress(uint160(_packedOwnershipOf(tokenId)));
}
/**
* @dev Gas spent here starts off proportional to the maximum mint batch size.
* It gradually moves to O(1) as tokens get transferred around over time.
*/function_ownershipOf(uint256 tokenId) internalviewvirtualreturns (TokenOwnership memory) {
return _unpackedOwnership(_packedOwnershipOf(tokenId));
}
/**
* @dev Returns the unpacked `TokenOwnership` struct at `index`.
*/function_ownershipAt(uint256 index) internalviewvirtualreturns (TokenOwnership memory) {
return _unpackedOwnership(_packedOwnerships[index]);
}
/**
* @dev Initializes the ownership slot minted at `index` for efficiency purposes.
*/function_initializeOwnershipAt(uint256 index) internalvirtual{
if (_packedOwnerships[index] ==0) {
_packedOwnerships[index] = _packedOwnershipOf(index);
}
}
/**
* 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 initialized ownership slot// (i.e. `ownership.addr != address(0) && ownership.burned == false`)// before an unintialized ownership slot// (i.e. `ownership.addr == address(0) && ownership.burned == false`)// Hence, `curr` will not underflow.//// We can directly compare the packed value.// If the address is zero, packed will be zero.while (packed ==0) {
packed = _packedOwnerships[--curr];
}
return packed;
}
}
}
revert OwnerQueryForNonexistentToken();
}
/**
* @dev 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;
ownership.extraData =uint24(packed >> _BITPOS_EXTRA_DATA);
}
/**
* @dev Packs ownership data into a single uint256.
*/function_packOwnershipData(address owner, uint256 flags) privateviewreturns (uint256 result) {
assembly {
// Mask `owner` to the lower 160 bits, in case the upper bits somehow aren't clean.
owner :=and(owner, _BITMASK_ADDRESS)
// `owner | (block.timestamp << _BITPOS_START_TIMESTAMP) | flags`.
result :=or(owner, or(shl(_BITPOS_START_TIMESTAMP, timestamp()), flags))
}
}
/**
* @dev Returns the `nextInitialized` flag set if `quantity` equals 1.
*/function_nextInitializedFlag(uint256 quantity) privatepurereturns (uint256 result) {
// For branchless setting of the `nextInitialized` flag.assembly {
// `(quantity == 1) << _BITPOS_NEXT_INITIALIZED`.
result :=shl(_BITPOS_NEXT_INITIALIZED, eq(quantity, 1))
}
}
// =============================================================// APPROVAL OPERATIONS// =============================================================/**
* @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) publicpayablevirtualoverride{
address owner = ownerOf(tokenId);
if (_msgSenderERC721A() != owner)
if (!isApprovedForAll(owner, _msgSenderERC721A())) {
revert ApprovalCallerNotOwnerNorApproved();
}
_tokenApprovals[tokenId].value= to;
emit Approval(owner, to, tokenId);
}
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functiongetApproved(uint256 tokenId) publicviewvirtualoverridereturns (address) {
if (!_exists(tokenId)) revert ApprovalQueryForNonexistentToken();
return _tokenApprovals[tokenId].value;
}
/**
* @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) publicvirtualoverride{
_operatorApprovals[_msgSenderERC721A()][operator] = approved;
emit ApprovalForAll(_msgSenderERC721A(), operator, approved);
}
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}.
*/functionisApprovedForAll(address owner, address operator) publicviewvirtualoverridereturns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @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. See {_mint}.
*/function_exists(uint256 tokenId) internalviewvirtualreturns (bool) {
return
_startTokenId() <= tokenId &&
tokenId < _currentIndex &&// If within bounds,
_packedOwnerships[tokenId] & _BITMASK_BURNED ==0; // and not burned.
}
/**
* @dev Returns whether `msgSender` is equal to `approvedAddress` or `owner`.
*/function_isSenderApprovedOrOwner(address approvedAddress,
address owner,
address msgSender
) privatepurereturns (bool result) {
assembly {
// Mask `owner` to the lower 160 bits, in case the upper bits somehow aren't clean.
owner :=and(owner, _BITMASK_ADDRESS)
// Mask `msgSender` to the lower 160 bits, in case the upper bits somehow aren't clean.
msgSender :=and(msgSender, _BITMASK_ADDRESS)
// `msgSender == owner || msgSender == approvedAddress`.
result :=or(eq(msgSender, owner), eq(msgSender, approvedAddress))
}
}
/**
* @dev Returns the storage slot and value for the approved address of `tokenId`.
*/function_getApprovedSlotAndAddress(uint256 tokenId)
privateviewreturns (uint256 approvedAddressSlot, address approvedAddress)
{
TokenApprovalRef storage tokenApproval = _tokenApprovals[tokenId];
// The following is equivalent to `approvedAddress = _tokenApprovals[tokenId].value`.assembly {
approvedAddressSlot := tokenApproval.slot
approvedAddress :=sload(approvedAddressSlot)
}
}
// =============================================================// TRANSFER OPERATIONS// =============================================================/**
* @dev Transfers `tokenId` from `from` to `to`.
*
* 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
) publicpayablevirtualoverride{
uint256 prevOwnershipPacked = _packedOwnershipOf(tokenId);
if (address(uint160(prevOwnershipPacked)) !=from) revert TransferFromIncorrectOwner();
(uint256 approvedAddressSlot, address approvedAddress) = _getApprovedSlotAndAddress(tokenId);
// The nested ifs save around 20+ gas over a compound boolean condition.if (!_isSenderApprovedOrOwner(approvedAddress, from, _msgSenderERC721A()))
if (!isApprovedForAll(from, _msgSenderERC721A())) revert TransferCallerNotOwnerNorApproved();
if (to ==address(0)) revert TransferToZeroAddress();
_beforeTokenTransfers(from, to, tokenId, 1);
// Clear approvals from the previous owner.assembly {
if approvedAddress {
// This is equivalent to `delete _tokenApprovals[tokenId]`.sstore(approvedAddressSlot, 0)
}
}
// 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] = _packOwnershipData(
to,
_BITMASK_NEXT_INITIALIZED | _nextExtraData(from, to, prevOwnershipPacked)
);
// 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 `safeTransferFrom(from, to, tokenId, '')`.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId
) publicpayablevirtualoverride{
safeTransferFrom(from, to, tokenId, '');
}
/**
* @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,
bytesmemory _data
) publicpayablevirtualoverride{
transferFrom(from, to, tokenId);
if (to.code.length!=0)
if (!_checkContractOnERC721Received(from, to, tokenId, _data)) {
revert TransferToNonERC721ReceiverImplementer();
}
}
/**
* @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 Private function to invoke {IERC721Receiver-onERC721Received} on a target contract.
*
* `from` - Previous owner of the given token ID.
* `to` - Target address that will receive the token.
* `tokenId` - Token ID to be transferred.
* `_data` - Optional data to send along with the call.
*
* Returns 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))
}
}
}
}
// =============================================================// MINT OPERATIONS// =============================================================/**
* @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 for each mint.
*/function_mint(address to, uint256 quantity) internalvirtual{
uint256 startTokenId = _currentIndex;
if (quantity ==0) revert MintZeroQuantity();
_beforeTokenTransfers(address(0), to, startTokenId, quantity);
// Overflows are incredibly unrealistic.// `balance` and `numberMinted` have a maximum limit of 2**64.// `tokenId` has a maximum limit of 2**256.unchecked {
// Updates:// - `balance += quantity`.// - `numberMinted += quantity`.//// We can directly add to the `balance` and `numberMinted`.
_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] = _packOwnershipData(
to,
_nextInitializedFlag(quantity) | _nextExtraData(address(0), to, 0)
);
uint256 toMasked;
uint256 end = startTokenId + quantity;
// Use assembly to loop and emit the `Transfer` event for gas savings.// The duplicated `log4` removes an extra check and reduces stack juggling.// The assembly, together with the surrounding Solidity code, have been// delicately arranged to nudge the compiler into producing optimized opcodes.assembly {
// Mask `to` to the lower 160 bits, in case the upper bits somehow aren't clean.
toMasked :=and(to, _BITMASK_ADDRESS)
// Emit the `Transfer` event.log4(
0, // Start of data (0, since no data).0, // End of data (0, since no data).
_TRANSFER_EVENT_SIGNATURE, // Signature.0, // `address(0)`.
toMasked, // `to`.
startTokenId // `tokenId`.
)
// The `iszero(eq(,))` check ensures that large values of `quantity`// that overflows uint256 will make the loop run out of gas.// The compiler will optimize the `iszero` away for performance.for {
let tokenId :=add(startTokenId, 1)
} iszero(eq(tokenId, end)) {
tokenId :=add(tokenId, 1)
} {
// Emit the `Transfer` event. Similar to above.log4(0, 0, _TRANSFER_EVENT_SIGNATURE, 0, toMasked, tokenId)
}
}
if (toMasked ==0) revert MintToZeroAddress();
_currentIndex = end;
}
_afterTokenTransfers(address(0), to, startTokenId, quantity);
}
/**
* @dev Mints `quantity` tokens and transfers them to `to`.
*
* This function is intended for efficient minting only during contract creation.
*
* It emits only one {ConsecutiveTransfer} as defined in
* [ERC2309](https://eips.ethereum.org/EIPS/eip-2309),
* instead of a sequence of {Transfer} event(s).
*
* Calling this function outside of contract creation WILL make your contract
* non-compliant with the ERC721 standard.
* For full ERC721 compliance, substituting ERC721 {Transfer} event(s) with the ERC2309
* {ConsecutiveTransfer} event is only permissible during contract creation.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `quantity` must be greater than 0.
*
* Emits a {ConsecutiveTransfer} event.
*/function_mintERC2309(address to, uint256 quantity) internalvirtual{
uint256 startTokenId = _currentIndex;
if (to ==address(0)) revert MintToZeroAddress();
if (quantity ==0) revert MintZeroQuantity();
if (quantity > _MAX_MINT_ERC2309_QUANTITY_LIMIT) revert MintERC2309QuantityExceedsLimit();
_beforeTokenTransfers(address(0), to, startTokenId, quantity);
// Overflows are unrealistic due to the above check for `quantity` to be below the limit.unchecked {
// Updates:// - `balance += quantity`.// - `numberMinted += quantity`.//// We can directly add to the `balance` and `numberMinted`.
_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] = _packOwnershipData(
to,
_nextInitializedFlag(quantity) | _nextExtraData(address(0), to, 0)
);
emit ConsecutiveTransfer(startTokenId, startTokenId + quantity -1, address(0), to);
_currentIndex = startTokenId + quantity;
}
_afterTokenTransfers(address(0), to, startTokenId, 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.
*
* See {_mint}.
*
* Emits a {Transfer} event for each mint.
*/function_safeMint(address to,
uint256 quantity,
bytesmemory _data
) internalvirtual{
_mint(to, quantity);
unchecked {
if (to.code.length!=0) {
uint256 end = _currentIndex;
uint256 index = end - quantity;
do {
if (!_checkContractOnERC721Received(address(0), to, index++, _data)) {
revert TransferToNonERC721ReceiverImplementer();
}
} while (index < end);
// Reentrancy protection.if (_currentIndex != end) revert();
}
}
}
/**
* @dev Equivalent to `_safeMint(to, quantity, '')`.
*/function_safeMint(address to, uint256 quantity) internalvirtual{
_safeMint(to, quantity, '');
}
// =============================================================// BURN OPERATIONS// =============================================================/**
* @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));
(uint256 approvedAddressSlot, address approvedAddress) = _getApprovedSlotAndAddress(tokenId);
if (approvalCheck) {
// The nested ifs save around 20+ gas over a compound boolean condition.if (!_isSenderApprovedOrOwner(approvedAddress, from, _msgSenderERC721A()))
if (!isApprovedForAll(from, _msgSenderERC721A())) revert TransferCallerNotOwnerNorApproved();
}
_beforeTokenTransfers(from, address(0), tokenId, 1);
// Clear approvals from the previous owner.assembly {
if approvedAddress {
// This is equivalent to `delete _tokenApprovals[tokenId]`.sstore(approvedAddressSlot, 0)
}
}
// 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] = _packOwnershipData(
from,
(_BITMASK_BURNED | _BITMASK_NEXT_INITIALIZED) | _nextExtraData(from, address(0), prevOwnershipPacked)
);
// 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++;
}
}
// =============================================================// EXTRA DATA OPERATIONS// =============================================================/**
* @dev Directly sets the extra data for the ownership data `index`.
*/function_setExtraDataAt(uint256 index, uint24 extraData) internalvirtual{
uint256 packed = _packedOwnerships[index];
if (packed ==0) revert OwnershipNotInitializedForExtraData();
uint256 extraDataCasted;
// Cast `extraData` with assembly to avoid redundant masking.assembly {
extraDataCasted := extraData
}
packed = (packed & _BITMASK_EXTRA_DATA_COMPLEMENT) | (extraDataCasted << _BITPOS_EXTRA_DATA);
_packedOwnerships[index] = packed;
}
/**
* @dev Called during each token transfer to set the 24bit `extraData` field.
* Intended to be overridden by the cosumer contract.
*
* `previousExtraData` - the value of `extraData` before transfer.
*
* 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_extraData(addressfrom,
address to,
uint24 previousExtraData
) internalviewvirtualreturns (uint24) {}
/**
* @dev Returns the next extra data for the packed ownership data.
* The returned result is shifted into position.
*/function_nextExtraData(addressfrom,
address to,
uint256 prevOwnershipPacked
) privateviewreturns (uint256) {
uint24 extraData =uint24(prevOwnershipPacked >> _BITPOS_EXTRA_DATA);
returnuint256(_extraData(from, to, extraData)) << _BITPOS_EXTRA_DATA;
}
// =============================================================// OTHER OPERATIONS// =============================================================/**
* @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) internalpurevirtualreturns (stringmemory str) {
assembly {
// The maximum value of a uint256 contains 78 digits (1 byte per digit), but// we allocate 0xa0 bytes to keep the free memory pointer 32-byte word aligned.// We will need 1 word for the trailing zeros padding, 1 word for the length,// and 3 words for a maximum of 78 digits. Total: 5 * 0x20 = 0xa0.let m :=add(mload(0x40), 0xa0)
// Update the free memory pointer to allocate.mstore(0x40, m)
// Assign the `str` to the end.
str :=sub(m, 0x20)
// Zeroize the slot after the string.mstore(str, 0)
// Cache the end of the memory to calculate the length later.let end := str
// We write the string from rightmost digit to leftmost digit.// The following is essentially a do-while loop that also handles the zero case.// prettier-ignorefor { let temp := value } 1 {} {
str :=sub(str, 1)
// Write the character to the pointer.// The ASCII index of the '0' character is 48.mstore8(str, add(48, mod(temp, 10)))
// Keep dividing `temp` until zero.
temp :=div(temp, 10)
// prettier-ignoreifiszero(temp) { break }
}
let length :=sub(end, str)
// Move the pointer 32 bytes leftwards to make room for the length.
str :=sub(str, 0x20)
// Store the length.mstore(str, length)
}
}
}
Contract Source Code
File 5 of 16: ERC721ABurnable.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.2.3// Creator: Chiru Labspragmasolidity ^0.8.4;import'./IERC721ABurnable.sol';
import'../ERC721A.sol';
/**
* @title ERC721ABurnable.
*
* @dev ERC721A token that can be irreversibly burned (destroyed).
*/abstractcontractERC721ABurnableisERC721A, IERC721ABurnable{
/**
* @dev Burns `tokenId`. See {ERC721A-_burn}.
*
* Requirements:
*
* - The caller must own `tokenId` or be an approved operator.
*/functionburn(uint256 tokenId) publicvirtualoverride{
_burn(tokenId, true);
}
}
Contract Source Code
File 6 of 16: ERC721AQueryable.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.2.3// Creator: Chiru Labspragmasolidity ^0.8.4;import'./IERC721AQueryable.sol';
import'../ERC721A.sol';
/**
* @title ERC721AQueryable.
*
* @dev ERC721A subclass with convenience query functions.
*/abstractcontractERC721AQueryableisERC721A, IERC721AQueryable{
/**
* @dev Returns the `TokenOwnership` struct at `tokenId` without reverting.
*
* If the `tokenId` is out of bounds:
*
* - `addr = address(0)`
* - `startTimestamp = 0`
* - `burned = false`
* - `extraData = 0`
*
* If the `tokenId` is burned:
*
* - `addr = <Address of owner before token was burned>`
* - `startTimestamp = <Timestamp when token was burned>`
* - `burned = true`
* - `extraData = <Extra data when token was burned>`
*
* Otherwise:
*
* - `addr = <Address of owner>`
* - `startTimestamp = <Timestamp of start of ownership>`
* - `burned = false`
* - `extraData = <Extra data at start of ownership>`
*/functionexplicitOwnershipOf(uint256 tokenId) publicviewvirtualoverridereturns (TokenOwnership memory) {
TokenOwnership memory ownership;
if (tokenId < _startTokenId() || tokenId >= _nextTokenId()) {
return ownership;
}
ownership = _ownershipAt(tokenId);
if (ownership.burned) {
return ownership;
}
return _ownershipOf(tokenId);
}
/**
* @dev Returns an array of `TokenOwnership` structs at `tokenIds` in order.
* See {ERC721AQueryable-explicitOwnershipOf}
*/functionexplicitOwnershipsOf(uint256[] calldata tokenIds)
externalviewvirtualoverridereturns (TokenOwnership[] memory)
{
unchecked {
uint256 tokenIdsLength = tokenIds.length;
TokenOwnership[] memory ownerships =new TokenOwnership[](tokenIdsLength);
for (uint256 i; i != tokenIdsLength; ++i) {
ownerships[i] = explicitOwnershipOf(tokenIds[i]);
}
return ownerships;
}
}
/**
* @dev Returns an array of token IDs owned by `owner`,
* in the range [`start`, `stop`)
* (i.e. `start <= tokenId < stop`).
*
* This function allows for tokens to be queried if the collection
* grows too big for a single call of {ERC721AQueryable-tokensOfOwner}.
*
* Requirements:
*
* - `start < stop`
*/functiontokensOfOwnerIn(address owner,
uint256 start,
uint256 stop
) externalviewvirtualoverridereturns (uint256[] memory) {
unchecked {
if (start >= stop) revert InvalidQueryRange();
uint256 tokenIdsIdx;
uint256 stopLimit = _nextTokenId();
// Set `start = max(start, _startTokenId())`.if (start < _startTokenId()) {
start = _startTokenId();
}
// Set `stop = min(stop, stopLimit)`.if (stop > stopLimit) {
stop = stopLimit;
}
uint256 tokenIdsMaxLength = balanceOf(owner);
// Set `tokenIdsMaxLength = min(balanceOf(owner), stop - start)`,// to cater for cases where `balanceOf(owner)` is too big.if (start < stop) {
uint256 rangeLength = stop - start;
if (rangeLength < tokenIdsMaxLength) {
tokenIdsMaxLength = rangeLength;
}
} else {
tokenIdsMaxLength =0;
}
uint256[] memory tokenIds =newuint256[](tokenIdsMaxLength);
if (tokenIdsMaxLength ==0) {
return tokenIds;
}
// We need to call `explicitOwnershipOf(start)`,// because the slot at `start` may not be initialized.
TokenOwnership memory ownership = explicitOwnershipOf(start);
address currOwnershipAddr;
// If the starting slot exists (i.e. not burned), initialize `currOwnershipAddr`.// `ownership.address` will not be zero, as `start` is clamped to the valid token ID range.if (!ownership.burned) {
currOwnershipAddr = ownership.addr;
}
for (uint256 i = start; i != stop && tokenIdsIdx != tokenIdsMaxLength; ++i) {
ownership = _ownershipAt(i);
if (ownership.burned) {
continue;
}
if (ownership.addr !=address(0)) {
currOwnershipAddr = ownership.addr;
}
if (currOwnershipAddr == owner) {
tokenIds[tokenIdsIdx++] = i;
}
}
// Downsize the array to fit.assembly {
mstore(tokenIds, tokenIdsIdx)
}
return tokenIds;
}
}
/**
* @dev Returns an array of token IDs owned by `owner`.
*
* This function scans the ownership mapping and is O(`totalSupply`) in complexity.
* It is meant to be called off-chain.
*
* See {ERC721AQueryable-tokensOfOwnerIn} for splitting the scan into
* multiple smaller scans if the collection is large enough to cause
* an out-of-gas error (10K collections should be fine).
*/functiontokensOfOwner(address owner) externalviewvirtualoverridereturns (uint256[] memory) {
unchecked {
uint256 tokenIdsIdx;
address currOwnershipAddr;
uint256 tokenIdsLength = balanceOf(owner);
uint256[] memory tokenIds =newuint256[](tokenIdsLength);
TokenOwnership memory ownership;
for (uint256 i = _startTokenId(); tokenIdsIdx != tokenIdsLength; ++i) {
ownership = _ownershipAt(i);
if (ownership.burned) {
continue;
}
if (ownership.addr !=address(0)) {
currOwnershipAddr = ownership.addr;
}
if (currOwnershipAddr == owner) {
tokenIds[tokenIdsIdx++] = i;
}
}
return tokenIds;
}
}
}
Contract Source Code
File 7 of 16: IERC165.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol)pragmasolidity ^0.8.20;/**
* @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}.
*/interfaceIERC165{
/**
* @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);
}
Contract Source Code
File 8 of 16: IERC4906.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.23;/// @title EIP-721 Metadata Update ExtensioninterfaceIERC4906{
/// @dev This event emits when the metadata of a token is changed./// So that the third-party platforms such as NFT market could/// timely update the images and related attributes of the NFT.eventMetadataUpdate(uint256 _tokenId);
/// @dev This event emits when the metadata of a range of tokens is changed./// So that the third-party platforms such as NFT market could/// timely update the images and related attributes of the NFTs. eventBatchMetadataUpdate(uint256 _fromTokenId, uint256 _toTokenId);
}
Contract Source Code
File 9 of 16: IERC721.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC721/IERC721.sol)pragmasolidity ^0.8.20;import {IERC165} from"../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/interfaceIERC721isIERC165{
/**
* @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 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: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* 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 address zero.
*
* 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);
}
Contract Source Code
File 10 of 16: IERC721A.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.2.3// Creator: Chiru Labspragmasolidity ^0.8.4;/**
* @dev Interface of ERC721A.
*/interfaceIERC721A{
/**
* The caller must own the token or be an approved operator.
*/errorApprovalCallerNotOwnerNorApproved();
/**
* The token does not exist.
*/errorApprovalQueryForNonexistentToken();
/**
* 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();
/**
* The `quantity` minted with ERC2309 exceeds the safety limit.
*/errorMintERC2309QuantityExceedsLimit();
/**
* The `extraData` cannot be set on an unintialized ownership slot.
*/errorOwnershipNotInitializedForExtraData();
// =============================================================// STRUCTS// =============================================================structTokenOwnership {
// The address of the owner.address addr;
// Stores the start time of ownership with minimal overhead for tokenomics.uint64 startTimestamp;
// Whether the token has been burned.bool burned;
// Arbitrary data similar to `startTimestamp` that can be set via {_extraData}.uint24 extraData;
}
// =============================================================// TOKEN COUNTERS// =============================================================/**
* @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() externalviewreturns (uint256);
// =============================================================// IERC165// =============================================================/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* [EIP section](https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified)
* to learn more about how these ids are created.
*
* This function call must use less than 30000 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`,
* 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,
bytescalldata data
) externalpayable;
/**
* @dev Equivalent to `safeTransferFrom(from, to, tokenId, '')`.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId
) externalpayable;
/**
* @dev Transfers `tokenId` 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
) externalpayable;
/**
* @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) externalpayable;
/**
* @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);
// =============================================================// IERC2309// =============================================================/**
* @dev Emitted when tokens in `fromTokenId` to `toTokenId`
* (inclusive) is transferred from `from` to `to`, as defined in the
* [ERC2309](https://eips.ethereum.org/EIPS/eip-2309) standard.
*
* See {_mintERC2309} for more details.
*/eventConsecutiveTransfer(uint256indexed fromTokenId, uint256 toTokenId, addressindexedfrom, addressindexed to);
}
Contract Source Code
File 11 of 16: IERC721ABurnable.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.2.3// Creator: Chiru Labspragmasolidity ^0.8.4;import'../IERC721A.sol';
/**
* @dev Interface of ERC721ABurnable.
*/interfaceIERC721ABurnableisIERC721A{
/**
* @dev Burns `tokenId`. See {ERC721A-_burn}.
*
* Requirements:
*
* - The caller must own `tokenId` or be an approved operator.
*/functionburn(uint256 tokenId) external;
}
Contract Source Code
File 12 of 16: IERC721AQueryable.sol
// SPDX-License-Identifier: MIT// ERC721A Contracts v4.2.3// Creator: Chiru Labspragmasolidity ^0.8.4;import'../IERC721A.sol';
/**
* @dev Interface of ERC721AQueryable.
*/interfaceIERC721AQueryableisIERC721A{
/**
* Invalid query range (`start` >= `stop`).
*/errorInvalidQueryRange();
/**
* @dev Returns the `TokenOwnership` struct at `tokenId` without reverting.
*
* If the `tokenId` is out of bounds:
*
* - `addr = address(0)`
* - `startTimestamp = 0`
* - `burned = false`
* - `extraData = 0`
*
* If the `tokenId` is burned:
*
* - `addr = <Address of owner before token was burned>`
* - `startTimestamp = <Timestamp when token was burned>`
* - `burned = true`
* - `extraData = <Extra data when token was burned>`
*
* Otherwise:
*
* - `addr = <Address of owner>`
* - `startTimestamp = <Timestamp of start of ownership>`
* - `burned = false`
* - `extraData = <Extra data at start of ownership>`
*/functionexplicitOwnershipOf(uint256 tokenId) externalviewreturns (TokenOwnership memory);
/**
* @dev Returns an array of `TokenOwnership` structs at `tokenIds` in order.
* See {ERC721AQueryable-explicitOwnershipOf}
*/functionexplicitOwnershipsOf(uint256[] memory tokenIds) externalviewreturns (TokenOwnership[] memory);
/**
* @dev Returns an array of token IDs owned by `owner`,
* in the range [`start`, `stop`)
* (i.e. `start <= tokenId < stop`).
*
* This function allows for tokens to be queried if the collection
* grows too big for a single call of {ERC721AQueryable-tokensOfOwner}.
*
* Requirements:
*
* - `start < stop`
*/functiontokensOfOwnerIn(address owner,
uint256 start,
uint256 stop
) externalviewreturns (uint256[] memory);
/**
* @dev Returns an array of token IDs owned by `owner`.
*
* This function scans the ownership mapping and is O(`totalSupply`) in complexity.
* It is meant to be called off-chain.
*
* See {ERC721AQueryable-tokensOfOwnerIn} for splitting the scan into
* multiple smaller scans if the collection is large enough to cause
* an out-of-gas error (10K collections should be fine).
*/functiontokensOfOwner(address owner) externalviewreturns (uint256[] memory);
}
Contract Source Code
File 13 of 16: Metadatea.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.23;/*
@@@@@@@@@@@@
@@@@@@@@@@@@
@@@@@@@@@@@@
@@@@@@@@@@@@
@@@@@@@@@@@@
@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
*/import"erc721a/contracts/ERC721A.sol";
import"erc721a/contracts/extensions/ERC721AQueryable.sol";
import"erc721a/contracts/extensions/ERC721ABurnable.sol";
import"@openzeppelin/contracts/access/Ownable.sol";
import"@openzeppelin/contracts/token/ERC721/IERC721.sol";
import"./IERC4906.sol";
import"./Structs.sol";
import"./Art.sol";
import"./Utils.sol";
/// @title an ERC721A contract named Metadate/a/// @author parker thompson/// @notice NFTs with fully on-chain art generation/// @dev implements ERC4906 to notify marketplaces of metadata updatescontractMetadateaisERC721A,
ERC721AQueryable,
ERC721ABurnable,
Ownable,
IERC4906{
/// @notice variable to store an instance of the Art contract
Art private _art;
/// @notice deploys the Metadate/a contract and an instance of the Art contractconstructor() ERC721A("Metadate/a", "MD") Ownable(msg.sender) {
_art =new Art();
// mint the first token to the deployer address
_mint(msg.sender, 1);
_mintArt(1, 0);
}
/// @notice get the start timestamp for collector claiming/// @dev 1705932000 == 9AM EST 1/22/24uint256privateconstant _collectorsStart =1705932000;
/// @notice get the price to mint a token in wei/// @dev 5000000000000000 wei is 0.005 eth, ~$12.50 USD at time of deploymentuint256privateconstant _mintPrice =5000000000000000;
/// @notice get the status of super rare distribution/// @dev can only be updated by calling the distributeSuperRares functionboolprivate _superRaresDistributed =false;
/// @notice get the timestamp when minting closes/// @return mintCloseTime timestamp/// @dev will be updated when totalSupply is greater than _blanksToMintuint256public mintCloseTime =55555555555;
/// @notice get the number of blanks that can be minteduint256privateconstant _blanksToMint =1000;
/// @notice get the number of seconds to add to mintCloseTime after all blanks are minted/// @dev 259200 seconds == 72 hoursuint256privateconstant _mintSecondsTimerAfterBlanks =259200;
/// @notice get the count of token edits that have been made/// @return totalEdits count/// @dev stored as a public variable for accuracy and convenienceuint256public totalEdits =0;
/// @notice initialize an instance of the Abstract Glitch contract
IERC721 privateconstant _abstractGlitch =
IERC721(0xF9f27AA7718dCcF4b4306e0321c2Ce85215fA902);
/// @notice map token IDs to a token struct to store metadatamapping(uint256=> Structs.Token) public tokens;
/// @notice map wallet addresses that have claimed free tokensmapping(uint256=>bool) public claimedAbstractGlitchTokens;
/// @notice map wallet addresses to the allow listmapping(address=>bool) public allowListWallets;
/// @notice check the active mint progression/// @dev use to qualify other contract functionsfunctioncheckMintProgression() publicviewreturns (uint256) {
if (block.timestamp< _collectorsStart) {
return0; // minting hasn't started
} elseif (block.timestamp< _collectorsStart +3hours) {
return1; // abstract glitch holders claim
} elseif (block.timestamp< _collectorsStart +7hours) {
return2; // allow list mint
} elseif (block.timestamp< mintCloseTime) {
return3; // public mint
} else {
return4; // mint ended
}
}
/// @notice mint Metadate/a (MD) tokens/// @param quantity of tokens to mint/// @dev when _blanksToMint is reached, the minting window is updatedfunctionmint(uint256 quantity) publicpayable{
uint256 mintProgression = checkMintProgression();
if (msg.value< quantity * _mintPrice) {
revert Utils.NotEnoughEth();
}
if (mintProgression ==2) {
if (
allowListWallets[msg.sender] ||
_abstractGlitch.balanceOf(msg.sender) >0
) {
_handleMint(quantity);
} else {
revert Utils.NotAllowed();
}
} elseif (mintProgression ==3) {
_handleMint(quantity);
} else {
revert Utils.NotAllowed();
}
}
/// @notice claim free Metadate/a (MD) tokens/// @param abstractGlitchId owned by message senderfunctionclaim(uint256 abstractGlitchId) public{
if (
_abstractGlitch.ownerOf(abstractGlitchId) ==msg.sender&&!claimedAbstractGlitchTokens[abstractGlitchId] &&
checkMintProgression() >0&&
checkMintProgression() <4
) {
_handleMint(1);
claimedAbstractGlitchTokens[abstractGlitchId] =true;
} else {
revert Utils.ClaimNotAvailable();
}
}
/// @notice internal function to mint Metadate/a (MD) tokens/// @param quantity of tokens to mintfunction_handleMint(uint256 quantity) internal{
for (uint256 i =0; i < quantity; i++) {
uint256 index = _nextTokenId() + i;
if (index > _blanksToMint) {
_mintArt(
index,
uint8(Utils.random(index +block.timestamp, 1, 6))
);
} else {
if (index == _blanksToMint) {
mintCloseTime =block.timestamp+
_mintSecondsTimerAfterBlanks;
}
_mintArt(index, 0);
}
}
if (quantity <=10) {
_mint(msg.sender, quantity);
} else {
for (uint256 i =0; i < quantity /10; i++) {
_mint(msg.sender, 10);
}
if (quantity %10>0) {
_mint(msg.sender, quantity %10);
}
}
}
/// @notice saves the initial art of the token minted/// @dev uses the index of the _defaults mapping in the Art contract/// @dev only time the originalArtIndex is updatedfunction_mintArt(uint256 id, uint256 originalArtIndex) internal{
tokens[id].originalArtIndex = originalArtIndex;
tokens[id].currentArtIndex = originalArtIndex;
}
/// @notice get the base64 encoded token URI/// @param tokenId of the token/// @return base64 encoded token URIfunctiontokenURI(uint256 tokenId)
publicviewvirtualoverride(ERC721A, IERC721A)
returns (stringmemory)
{
return _art.getTokenURI(tokenId, tokens[tokenId]);
}
/// @notice get the SVG art for a token/// @param tokenId of the token/// @return SVG artfunctiongetSvg(uint256 tokenId) publicviewreturns (stringmemory) {
return _art.renderSvg(tokens[tokenId]);
}
/// @notice edit a Metadate/a (MD) token/// @notice blank tokens can be edited once without burning any tokens/// @notice super rare tokens can be edited infinitely without burning any tokens/// @notice common tokens can be edited once by burning 4 other common tokens/// @notice only text, metadata, and text size can be edited for super rare tokens/// @param tokenIds array of token IDs to burn, including the token to keep as the FIRST token in the array/// @param artRules struct of art to update/// @param meta string of metadata to updatefunctionedit(uint256[] calldata tokenIds,
Structs.ArtRules memory artRules,
stringmemory meta
) public{
uint256 tokenIdToKeep = tokenIds[0];
if (!_ownsAllTokens(tokenIds, msg.sender)) {
revert Utils.NotAllTokensOwned();
}
// checks to see if the token needs to be a blank or a super rareif (tokenIds.length==1) {
// checks to see if the token is a super rareif (
tokens[tokenIdToKeep].currentArtIndex >7&&
tokens[tokenIdToKeep].currentArtIndex <11
) {
if (
!Utils.validateTextSize(
artRules.labelText,
artRules.textSize
)
) {
revert Utils.InvalidText();
}
if (Utils.countCharacters(meta) >100) {
revert Utils.MetaTooLong();
}
tokens[tokenIdToKeep].artRules.labelText = artRules.labelText;
tokens[tokenIdToKeep].artRules.textSize = artRules.textSize;
tokens[tokenIdToKeep].meta = meta;
if (!tokens[tokenIdToKeep].edited) {
tokens[tokenIdToKeep].edited =true;
}
} else {
if (
tokenIdToKeep > _blanksToMint ||
tokens[tokenIdToKeep].edited
) {
revert Utils.InvalidToken();
}
_updateArt(tokenIdToKeep, artRules, meta);
}
emit MetadataUpdate(tokenIdToKeep);
} elseif (tokenIds.length==5) {
if (tokens[tokenIdToKeep].edited) {
revert Utils.InvalidToken();
}
for (uint256 i =0; i <5; i++) {
if (
Utils.isSuperRareOrBlank(
tokens[tokenIds[i]].currentArtIndex
)
) {
revert Utils.InvalidToken();
}
if (tokenIds[i] == tokenIdToKeep) {
_updateArt(tokenIdToKeep, artRules, meta);
emit MetadataUpdate(tokenIdToKeep);
} else {
burn(tokenIds[i]);
emit MetadataUpdate(tokenIds[i]);
}
}
} else {
revert Utils.InvalidQuantity();
}
totalEdits++;
}
/// @notice updates the metadata of a token/// @dev checks for art validity, but not if a token should be edited/// @dev the edit function checks if a token should be edited/// @dev this function is skipped for super rare tokensfunction_updateArt(uint256 tokenId,
Structs.ArtRules memory artRules,
stringmemory meta
) internal{
if (artRules.spectrumIndex >15) {
revert Utils.InvalidSpectrum();
}
if (artRules.labelIndex >7) {
revert Utils.InvalidLabel();
}
if (!Utils.validateTextSize(artRules.labelText, artRules.textSize)) {
revert Utils.InvalidText();
}
if (Utils.countCharacters(meta) >100) {
revert Utils.MetaTooLong();
}
tokens[tokenId].meta = meta;
tokens[tokenId].artRules = Structs.ArtRules({
stroke: artRules.stroke,
vertical: artRules.vertical,
spectrumIndex: artRules.spectrumIndex,
labelIndex: artRules.labelIndex,
labelText: artRules.labelText,
textSize: artRules.textSize,
whiteText: artRules.whiteText
});
// only update these if token has not been edited yetif (!tokens[tokenId].edited) {
tokens[tokenId].edited =true;
tokens[tokenId].currentArtIndex =11;
}
}
/// @notice check if all tokens in an array are owned by the same addressfunction_ownsAllTokens(uint256[] calldata ids, address addy)
internalviewreturns (bool)
{
for (uint256 i =0; i < ids.length; i++) {
if (ownerOf(ids[i]) != addy) {
returnfalse;
}
}
returntrue;
}
/// @notice get the total number of tokens burned/// @return totalBurned count/// @dev will not include tokens manually sent to a 'burn' or 0x addressfunctiontotalBurned() publicviewreturns (uint256) {
return _totalBurned();
}
/// @notice starts the token ID at 1 instead of 0function_startTokenId() internalviewvirtualoverridereturns (uint256) {
return1;
}
/// @notice updates artwork for tokens that are burnedfunction_beforeTokenTransfers(addressfrom,
address to,
uint256 startTokenId,
uint256 quantity
) internalvirtualoverride{
super._beforeTokenTransfers(from, to, startTokenId, quantity);
if (to ==address(0)) {
tokens[startTokenId].currentArtIndex =7;
}
}
/// @notice add wallets to the allow list/// @param wallets to addfunctionaddAllowlistWallets(address[] calldata wallets) publiconlyOwner{
if (checkMintProgression() >0) {
revert Utils.NotAllowed();
}
for (uint256 i =0; i < wallets.length; i++) {
allowListWallets[wallets[i]] =true;
}
}
/*
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@
*//// @notice distributes super rare tokens/// @dev can only be called once after mint is closedfunctiondistributeSuperRares() publiconlyOwner{
if (checkMintProgression() <4|| _superRaresDistributed) {
revert Utils.NotAllowed();
}
for (uint256 i =0; i <200; i++) {
// checks 200 common tokens for upgradability// edited and burned tokens will be skipped// it is likely that less than 200 super rares will existuint256 random = Utils.random(i +2024, _blanksToMint +1, _totalMinted());
if (!tokens[random].edited && tokens[random].currentArtIndex !=7) {
tokens[random].currentArtIndex = Utils.random(i, 8, 10);
}
}
_superRaresDistributed =true;
emit BatchMetadataUpdate(_blanksToMint, _totalMinted());
}
/// @notice withdraw 50% of contract funds to each of two addressesfunctionwithdraw() externalonlyOwner{
uint256 bal =address(this).balance;
if (bal ==0) {
revert Utils.ZeroBalance();
}
uint256 amt1 = bal /2;
uint256 amt2 = bal - amt1;
require(
payable(0x9390333197446eC19B1B4Dc7dC7fc5ae4957ebBa).send(amt1) &&payable(0x38f0dBbA41258639ba0b2cdDC753E46157CE14d0).send(amt2)
);
}
}
Contract Source Code
File 14 of 16: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)pragmasolidity ^0.8.20;import {Context} from"../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.
*
* The initial owner is set to the address provided by the deployer. 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;
/**
* @dev The caller account is not authorized to perform an operation.
*/errorOwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/errorOwnableInvalidOwner(address owner);
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/constructor(address initialOwner) {
if (initialOwner ==address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/function_checkOwner() internalviewvirtual{
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling 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{
if (newOwner ==address(0)) {
revert OwnableInvalidOwner(address(0));
}
_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);
}
}
// SPDX-License-Identifier: MITpragmasolidity ^0.8.23;libraryUtils{
/// @notice get a pseudo random number/// @param input to use as a randomness seed/// @param min value that can be returned/// @param max value that can be returned/// @return number that is randomized based on the params/// @dev the same input will always return the same output/// @dev min and max are inclusive values and can be returnedfunctionrandom(uint256 input,
uint256 min,
uint256 max
) internalpurereturns (uint256) {
uint256 randRange = max - min +1;
return min + (uint256(keccak256(abi.encodePacked(input))) % randRange);
}
/// @notice convert a number to a string/// @param number number to convert/// @return result string from the converted numberfunctionuint2string(uint256 number
) internalpurereturns (stringmemory result) {
if (number ==0) {
return"0";
}
uint256 x = number;
uint256 length;
while (x !=0) {
length++;
x /=10;
}
bytesmemory conversion =newbytes(length);
uint256 y = length;
while (number !=0) {
y = y -1;
uint8 temp = (48+uint8(number - (number /10) *10));
bytes1 b1 =bytes1(temp);
conversion[y] = b1;
number /=10;
}
returnstring(conversion);
}
/// @notice convert a number to a hex formatted color/// @param color number to convert/// @return hex formatted color stringfunctionuint2hex(uint24 color) internalpurereturns (stringmemory) {
uint8 red =uint8(color >>16);
uint8 green =uint8(color >>8);
uint8 blue =uint8(color);
returnstring(
abi.encodePacked(
"#",
uint2string(red),
uint2string(green),
uint2string(blue)
)
);
}
/// @notice count the characters in a string/// @param input string to count/// @return number of characters in the string/// @dev counts the number of characters in a string/// @dev some complex characters (like emojis) may count as more than onefunctioncountCharacters(stringmemory input
) internalpurereturns (uint256) {
uint256 length =0;
uint256 i =0;
while (i <bytes(input).length) {
if ((uint8(bytes(input)[i]) &0xC0) !=0x80) {
length++;
}
i++;
}
return length;
}
/// @notice validate text size for artwork/// @param textString string value of the text/// @param textSize number size of the text/// @return whether or not the text and size combo are validfunctionvalidateTextSize(stringmemory textString,
uint256 textSize
) internalpurereturns (bool) {
if (textSize <6|| textSize >29) {
returnfalse;
} else {
uint256 length = countCharacters(textString);
uint256 max;
if (length <=7) {
max =29;
} elseif (length <=16) {
max =11;
} elseif (length <=22) {
max =9;
} else {
revert("invalid length");
}
return (textSize <= max);
}
}
/// @notice formats characters in a string for SVG code/// @param content string to format/// @return formatted string/// @dev checks for known characters that need to be converted for SVG (<, >, &)functionformatCharacters(stringmemory content
) internalpurereturns (stringmemory) {
bytesmemory contentBytes =bytes(content);
bytesmemory result =newbytes(contentBytes.length*5);
uint256 j =0;
for (uint256 i =0; i < contentBytes.length; i++) {
if (contentBytes[i] =="&") {
result[j++] =bytes("&")[0];
result[j++] =bytes("a")[0];
result[j++] =bytes("m")[0];
result[j++] =bytes("p")[0];
result[j++] =bytes(";")[0];
} elseif (contentBytes[i] =="<") {
result[j++] =bytes("&")[0];
result[j++] =bytes("l")[0];
result[j++] =bytes("t")[0];
result[j++] =bytes(";")[0];
} elseif (contentBytes[i] ==">") {
result[j++] =bytes("&")[0];
result[j++] =bytes("g")[0];
result[j++] =bytes("t")[0];
result[j++] =bytes(";")[0];
} else {
result[j++] = contentBytes[i];
}
}
bytesmemory trimmedResult =newbytes(j);
for (uint256 k =0; k < j; k++) {
trimmedResult[k] = result[k];
}
returnstring(trimmedResult);
}
/// @notice check if a token is a super rare or blank/// @param index of the current token art/// @return whether or not the token is a super rare or blankfunctionisSuperRareOrBlank(uint256 index) internalpurereturns (bool) {
if (index ==0) {
returntrue;
} elseif (index >7&& index <11) {
returntrue;
} else {
returnfalse;
}
}
errorNotEnoughEth();
errorMintEnded();
errorNotTime();
errorClaimNotAvailable();
errorNotAllTokensOwned();
errorTokenIdMismatch();
errorInvalidToken();
errorInvalidText();
errorInvalidSpectrum();
errorInvalidLabel();
errorMetaTooLong();
errorInvalidQuantity();
errorNotAllowed();
errorZeroBalance();
errorAlreadyCalled();
}
