// This contract is part of Zellic’s smart contract dataset, which is a collection of publicly available contract code gathered as of March 2023. | |
// File contracts/external/erc721a/contracts/IERC721A.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
/** | |
* @dev Interface of an ERC721A compliant contract. | |
*/ | |
interface IERC721A { | |
/** | |
* The caller must own the token or be an approved operator. | |
*/ | |
error ApprovalCallerNotOwnerNorApproved(); | |
/** | |
* The token does not exist. | |
*/ | |
error ApprovalQueryForNonexistentToken(); | |
/** | |
* The caller cannot approve to their own address. | |
*/ | |
error ApproveToCaller(); | |
/** | |
* Cannot query the balance for the zero address. | |
*/ | |
error BalanceQueryForZeroAddress(); | |
/** | |
* Cannot mint to the zero address. | |
*/ | |
error MintToZeroAddress(); | |
/** | |
* The quantity of tokens minted must be more than zero. | |
*/ | |
error MintZeroQuantity(); | |
/** | |
* The token does not exist. | |
*/ | |
error OwnerQueryForNonexistentToken(); | |
/** | |
* The caller must own the token or be an approved operator. | |
*/ | |
error TransferCallerNotOwnerNorApproved(); | |
/** | |
* The token must be owned by `from`. | |
*/ | |
error TransferFromIncorrectOwner(); | |
/** | |
* Cannot safely transfer to a contract that does not implement the ERC721Receiver interface. | |
*/ | |
error TransferToNonERC721ReceiverImplementer(); | |
/** | |
* Cannot transfer to the zero address. | |
*/ | |
error TransferToZeroAddress(); | |
/** | |
* The token does not exist. | |
*/ | |
error URIQueryForNonexistentToken(); | |
/** | |
* The `quantity` minted with ERC2309 exceeds the safety limit. | |
*/ | |
error MintERC2309QuantityExceedsLimit(); | |
/** | |
* The `extraData` cannot be set on an unintialized ownership slot. | |
*/ | |
error OwnershipNotInitializedForExtraData(); | |
struct TokenOwnership { | |
// 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; | |
// Arbitrary data similar to `startTimestamp` that can be set through `_extraData`. | |
uint24 extraData; | |
} | |
/** | |
* @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. | |
*/ | |
function totalSupply() external view returns (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. | |
*/ | |
function supportsInterface(bytes4 interfaceId) external view returns (bool); | |
// ============================== | |
// IERC721 | |
// ============================== | |
/** | |
* @dev Emitted when `tokenId` token is transferred from `from` to `to`. | |
*/ | |
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId); | |
/** | |
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token. | |
*/ | |
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId); | |
/** | |
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets. | |
*/ | |
event ApprovalForAll(address indexed owner, address indexed operator, bool approved); | |
/** | |
* @dev Returns the number of tokens in ``owner``'s account. | |
*/ | |
function balanceOf(address owner) external view returns (uint256 balance); | |
/** | |
* @dev Returns the owner of the `tokenId` token. | |
* | |
* Requirements: | |
* | |
* - `tokenId` must exist. | |
*/ | |
function ownerOf(uint256 tokenId) external view returns (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. | |
*/ | |
function safeTransferFrom( | |
address from, | |
address to, | |
uint256 tokenId, | |
bytes calldata 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. | |
*/ | |
function safeTransferFrom( | |
address from, | |
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. | |
*/ | |
function transferFrom( | |
address from, | |
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. | |
*/ | |
function approve(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. | |
*/ | |
function setApprovalForAll(address operator, bool _approved) external; | |
/** | |
* @dev Returns the account approved for `tokenId` token. | |
* | |
* Requirements: | |
* | |
* - `tokenId` must exist. | |
*/ | |
function getApproved(uint256 tokenId) external view returns (address operator); | |
/** | |
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`. | |
* | |
* See {setApprovalForAll} | |
*/ | |
function isApprovedForAll(address owner, address operator) external view returns (bool); | |
// ============================== | |
// IERC721Metadata | |
// ============================== | |
/** | |
* @dev Returns the token collection name. | |
*/ | |
function name() external view returns (string memory); | |
/** | |
* @dev Returns the token collection symbol. | |
*/ | |
function symbol() external view returns (string memory); | |
/** | |
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token. | |
*/ | |
function tokenURI(uint256 tokenId) external view returns (string memory); | |
// ============================== | |
// IERC2309 | |
// ============================== | |
/** | |
* @dev Emitted when tokens in `fromTokenId` to `toTokenId` (inclusive) is transferred from `from` to `to`, | |
* as defined in the ERC2309 standard. See `_mintERC2309` for more details. | |
*/ | |
event ConsecutiveTransfer(uint256 indexed fromTokenId, uint256 toTokenId, address indexed from, address indexed to); | |
} | |
// File contracts/external/erc721a/contracts/ERC721A.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
/** | |
* @dev ERC721 token receiver interface. | |
*/ | |
interface ERC721A__IERC721Receiver { | |
function onERC721Received( | |
address operator, | |
address from, | |
uint256 tokenId, | |
bytes calldata data | |
) external returns (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). | |
*/ | |
contract ERC721A is IERC721A { | |
// Reference type for token approval. | |
struct TokenApprovalRef { | |
address value; | |
} | |
// Mask of an entry in packed address data. | |
uint256 private constant BITMASK_ADDRESS_DATA_ENTRY = (1 << 64) - 1; | |
// The bit position of `numberMinted` in packed address data. | |
uint256 private constant BITPOS_NUMBER_MINTED = 64; | |
// The bit position of `numberBurned` in packed address data. | |
uint256 private constant BITPOS_NUMBER_BURNED = 128; | |
// The bit position of `aux` in packed address data. | |
uint256 private constant BITPOS_AUX = 192; | |
// Mask of all 256 bits in packed address data except the 64 bits for `aux`. | |
uint256 private constant BITMASK_AUX_COMPLEMENT = (1 << 192) - 1; | |
// The bit position of `startTimestamp` in packed ownership. | |
uint256 private constant BITPOS_START_TIMESTAMP = 160; | |
// The bit mask of the `burned` bit in packed ownership. | |
uint256 private constant BITMASK_BURNED = 1 << 224; | |
// The bit position of the `nextInitialized` bit in packed ownership. | |
uint256 private constant BITPOS_NEXT_INITIALIZED = 225; | |
// The bit mask of the `nextInitialized` bit in packed ownership. | |
uint256 private constant BITMASK_NEXT_INITIALIZED = 1 << 225; | |
// The bit position of `extraData` in packed ownership. | |
uint256 private constant BITPOS_EXTRA_DATA = 232; | |
// Mask of all 256 bits in a packed ownership except the 24 bits for `extraData`. | |
uint256 private constant BITMASK_EXTRA_DATA_COMPLEMENT = (1 << 232) - 1; | |
// The mask of the lower 160 bits for addresses. | |
uint256 private constant 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. | |
uint256 private constant MAX_MINT_ERC2309_QUANTITY_LIMIT = 5000; | |
// The tokenId of the next token to be minted. | |
uint256 private _currentIndex; | |
// The number of tokens burned. | |
uint256 private _burnCounter; | |
// Token name | |
string private _name; | |
// Token symbol | |
string private _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 approvals | |
mapping(address => mapping(address => bool)) private _operatorApprovals; | |
constructor(string memory name_, string memory 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() internal view virtual returns (uint256) { | |
return 0; | |
} | |
/** | |
* @dev Returns the next token ID to be minted. | |
*/ | |
function _nextTokenId() internal view virtual returns (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`. | |
*/ | |
function totalSupply() public view virtual override returns (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() internal view virtual returns (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() internal view virtual returns (uint256) { | |
return _burnCounter; | |
} | |
/** | |
* @dev See {IERC165-supportsInterface}. | |
*/ | |
function supportsInterface(bytes4 interfaceId) public view virtual override returns (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}. | |
*/ | |
function balanceOf(address owner) public view virtual override returns (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) internal view virtual returns (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) internal view virtual returns (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) internal view virtual returns (uint64) { | |
return uint64(_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) internal virtual { | |
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; | |
} | |
/** | |
* Returns the packed ownership data of `tokenId`. | |
*/ | |
function _packedOwnershipOf(uint256 tokenId) private view returns (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) private pure returns (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); | |
} | |
/** | |
* Returns the unpacked `TokenOwnership` struct at `index`. | |
*/ | |
function _ownershipAt(uint256 index) internal view virtual returns (TokenOwnership memory) { | |
return _unpackedOwnership(_packedOwnerships[index]); | |
} | |
/** | |
* @dev Initializes the ownership slot minted at `index` for efficiency purposes. | |
*/ | |
function _initializeOwnershipAt(uint256 index) internal virtual { | |
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) internal view virtual returns (TokenOwnership memory) { | |
return _unpackedOwnership(_packedOwnershipOf(tokenId)); | |
} | |
/** | |
* @dev Packs ownership data into a single uint256. | |
*/ | |
function _packOwnershipData(address owner, uint256 flags) private view returns (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 See {IERC721-ownerOf}. | |
*/ | |
function ownerOf(uint256 tokenId) public view virtual override returns (address) { | |
return address(uint160(_packedOwnershipOf(tokenId))); | |
} | |
/** | |
* @dev See {IERC721Metadata-name}. | |
*/ | |
function name() public view virtual override returns (string memory) { | |
return _name; | |
} | |
/** | |
* @dev See {IERC721Metadata-symbol}. | |
*/ | |
function symbol() public view virtual override returns (string memory) { | |
return _symbol; | |
} | |
/** | |
* @dev See {IERC721Metadata-tokenURI}. | |
*/ | |
function tokenURI(uint256 tokenId) public view virtual override returns (string memory) { | |
if (!_exists(tokenId)) revert URIQueryForNonexistentToken(); | |
string memory baseURI = _baseURI(); | |
return bytes(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() internal view virtual returns (string memory) { | |
return ''; | |
} | |
/** | |
* @dev Returns the `nextInitialized` flag set if `quantity` equals 1. | |
*/ | |
function _nextInitializedFlag(uint256 quantity) private pure returns (uint256 result) { | |
// For branchless setting of the `nextInitialized` flag. | |
assembly { | |
// `(quantity == 1) << BITPOS_NEXT_INITIALIZED`. | |
result := shl(BITPOS_NEXT_INITIALIZED, eq(quantity, 1)) | |
} | |
} | |
/** | |
* @dev See {IERC721-approve}. | |
*/ | |
function approve(address to, uint256 tokenId) public virtual override { | |
address owner = ownerOf(tokenId); | |
if (_msgSenderERC721A() != owner) | |
if (!isApprovedForAll(owner, _msgSenderERC721A())) { | |
revert ApprovalCallerNotOwnerNorApproved(); | |
} | |
_tokenApprovals[tokenId].value = to; | |
emit Approval(owner, to, tokenId); | |
} | |
/** | |
* @dev See {IERC721-getApproved}. | |
*/ | |
function getApproved(uint256 tokenId) public view virtual override returns (address) { | |
if (!_exists(tokenId)) revert ApprovalQueryForNonexistentToken(); | |
return _tokenApprovals[tokenId].value; | |
} | |
/** | |
* @dev See {IERC721-setApprovalForAll}. | |
*/ | |
function setApprovalForAll(address operator, bool approved) public virtual override { | |
if (operator == _msgSenderERC721A()) revert ApproveToCaller(); | |
_operatorApprovals[_msgSenderERC721A()][operator] = approved; | |
emit ApprovalForAll(_msgSenderERC721A(), operator, approved); | |
} | |
/** | |
* @dev See {IERC721-isApprovedForAll}. | |
*/ | |
function isApprovedForAll(address owner, address operator) public view virtual override returns (bool) { | |
return _operatorApprovals[owner][operator]; | |
} | |
/** | |
* @dev See {IERC721-safeTransferFrom}. | |
*/ | |
function safeTransferFrom( | |
address from, | |
address to, | |
uint256 tokenId | |
) public virtual override { | |
safeTransferFrom(from, to, tokenId, ''); | |
} | |
/** | |
* @dev See {IERC721-safeTransferFrom}. | |
*/ | |
function safeTransferFrom( | |
address from, | |
address to, | |
uint256 tokenId, | |
bytes memory _data | |
) public virtual override { | |
transferFrom(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) internal view virtual returns (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 virtual { | |
_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. | |
* | |
* See {_mint}. | |
* | |
* Emits a {Transfer} event for each mint. | |
*/ | |
function _safeMint( | |
address to, | |
uint256 quantity, | |
bytes memory _data | |
) internal virtual { | |
_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 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) internal virtual { | |
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` 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 tokenId = startTokenId; | |
uint256 end = startTokenId + quantity; | |
do { | |
emit Transfer(address(0), to, tokenId++); | |
} while (tokenId < end); | |
_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) internal virtual { | |
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 Returns the storage slot and value for the approved address of `tokenId`. | |
*/ | |
function _getApprovedAddress(uint256 tokenId) | |
private | |
view | |
returns (uint256 approvedAddressSlot, address approvedAddress) | |
{ | |
TokenApprovalRef storage tokenApproval = _tokenApprovals[tokenId]; | |
// The following is equivalent to `approvedAddress = _tokenApprovals[tokenId]`. | |
assembly { | |
approvedAddressSlot := tokenApproval.slot | |
approvedAddress := sload(approvedAddressSlot) | |
} | |
} | |
/** | |
* @dev Returns whether the `approvedAddress` is equals to `from` or `msgSender`. | |
*/ | |
function _isOwnerOrApproved( | |
address approvedAddress, | |
address from, | |
address msgSender | |
) private pure returns (bool result) { | |
assembly { | |
// Mask `from` to the lower 160 bits, in case the upper bits somehow aren't clean. | |
from := and(from, BITMASK_ADDRESS) | |
// Mask `msgSender` to the lower 160 bits, in case the upper bits somehow aren't clean. | |
msgSender := and(msgSender, BITMASK_ADDRESS) | |
// `msgSender == from || msgSender == approvedAddress`. | |
result := or(eq(msgSender, from), eq(msgSender, approvedAddress)) | |
} | |
} | |
/** | |
* @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 transferFrom( | |
address from, | |
address to, | |
uint256 tokenId | |
) public virtual override { | |
uint256 prevOwnershipPacked = _packedOwnershipOf(tokenId); | |
if (address(uint160(prevOwnershipPacked)) != from) revert TransferFromIncorrectOwner(); | |
(uint256 approvedAddressSlot, address approvedAddress) = _getApprovedAddress(tokenId); | |
// The nested ifs save around 20+ gas over a compound boolean condition. | |
if (!_isOwnerOrApproved(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 `_burn(tokenId, false)`. | |
*/ | |
function _burn(uint256 tokenId) internal virtual { | |
_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) internal virtual { | |
uint256 prevOwnershipPacked = _packedOwnershipOf(tokenId); | |
address from = address(uint160(prevOwnershipPacked)); | |
(uint256 approvedAddressSlot, address approvedAddress) = _getApprovedAddress(tokenId); | |
if (approvalCheck) { | |
// The nested ifs save around 20+ gas over a compound boolean condition. | |
if (!_isOwnerOrApproved(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++; | |
} | |
} | |
/** | |
* @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( | |
address from, | |
address to, | |
uint256 tokenId, | |
bytes memory _data | |
) private returns (bool) { | |
try ERC721A__IERC721Receiver(to).onERC721Received(_msgSenderERC721A(), from, tokenId, _data) returns ( | |
bytes4 retval | |
) { | |
return retval == ERC721A__IERC721Receiver(to).onERC721Received.selector; | |
} catch (bytes memory reason) { | |
if (reason.length == 0) { | |
revert TransferToNonERC721ReceiverImplementer(); | |
} else { | |
assembly { | |
revert(add(32, reason), mload(reason)) | |
} | |
} | |
} | |
} | |
/** | |
* @dev Directly sets the extra data for the ownership data `index`. | |
*/ | |
function _setExtraDataAt(uint256 index, uint24 extraData) internal virtual { | |
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 Returns the next extra data for the packed ownership data. | |
* The returned result is shifted into position. | |
*/ | |
function _nextExtraData( | |
address from, | |
address to, | |
uint256 prevOwnershipPacked | |
) private view returns (uint256) { | |
uint24 extraData = uint24(prevOwnershipPacked >> BITPOS_EXTRA_DATA); | |
return uint256(_extraData(from, to, extraData)) << BITPOS_EXTRA_DATA; | |
} | |
/** | |
* @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( | |
address from, | |
address to, | |
uint24 previousExtraData | |
) internal view virtual returns (uint24) {} | |
/** | |
* @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( | |
address from, | |
address to, | |
uint256 startTokenId, | |
uint256 quantity | |
) internal virtual {} | |
/** | |
* @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( | |
address from, | |
address to, | |
uint256 startTokenId, | |
uint256 quantity | |
) internal virtual {} | |
/** | |
* @dev Returns the message sender (defaults to `msg.sender`). | |
* | |
* If you are writing GSN compatible contracts, you need to override this function. | |
*/ | |
function _msgSenderERC721A() internal view virtual returns (address) { | |
return msg.sender; | |
} | |
/** | |
* @dev Converts a `uint256` to its ASCII `string` decimal representation. | |
*/ | |
function _toString(uint256 value) internal pure virtual returns (string memory 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) | |
} | |
} | |
} | |
// File contracts/external/erc721a/contracts/extensions/IERC721ABurnable.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
/** | |
* @dev Interface of an ERC721ABurnable compliant contract. | |
*/ | |
interface IERC721ABurnable is IERC721A { | |
/** | |
* @dev Burns `tokenId`. See {ERC721A-_burn}. | |
* | |
* Requirements: | |
* | |
* - The caller must own `tokenId` or be an approved operator. | |
*/ | |
function burn(uint256 tokenId) external; | |
} | |
// File contracts/external/erc721a/contracts/extensions/ERC721ABurnable.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
/** | |
* @title ERC721A Burnable Token | |
* @dev ERC721A Token that can be irreversibly burned (destroyed). | |
*/ | |
abstract contract ERC721ABurnable is ERC721A, IERC721ABurnable { | |
/** | |
* @dev Burns `tokenId`. See {ERC721A-_burn}. | |
* | |
* Requirements: | |
* | |
* - The caller must own `tokenId` or be an approved operator. | |
*/ | |
function burn(uint256 tokenId) public virtual override { | |
_burn(tokenId, true); | |
} | |
} | |
// File contracts/external/erc721a/contracts/extensions/IERC721AQueryable.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
/** | |
* @dev Interface of an ERC721AQueryable compliant contract. | |
*/ | |
interface IERC721AQueryable is IERC721A { | |
/** | |
* Invalid query range (`start` >= `stop`). | |
*/ | |
error InvalidQueryRange(); | |
/** | |
* @dev Returns the `TokenOwnership` struct at `tokenId` without reverting. | |
* | |
* If the `tokenId` is out of bounds: | |
* - `addr` = `address(0)` | |
* - `startTimestamp` = `0` | |
* - `burned` = `false` | |
* | |
* If the `tokenId` is burned: | |
* - `addr` = `<Address of owner before token was burned>` | |
* - `startTimestamp` = `<Timestamp when token was burned>` | |
* - `burned = `true` | |
* | |
* Otherwise: | |
* - `addr` = `<Address of owner>` | |
* - `startTimestamp` = `<Timestamp of start of ownership>` | |
* - `burned = `false` | |
*/ | |
function explicitOwnershipOf(uint256 tokenId) external view returns (TokenOwnership memory); | |
/** | |
* @dev Returns an array of `TokenOwnership` structs at `tokenIds` in order. | |
* See {ERC721AQueryable-explicitOwnershipOf} | |
*/ | |
function explicitOwnershipsOf(uint256[] memory tokenIds) external view returns (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` | |
*/ | |
function tokensOfOwnerIn( | |
address owner, | |
uint256 start, | |
uint256 stop | |
) external view returns (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 pfp collections should be fine). | |
*/ | |
function tokensOfOwner(address owner) external view returns (uint256[] memory); | |
} | |
// File contracts/external/erc721a/contracts/extensions/ERC721AQueryable.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
/** | |
* @title ERC721A Queryable | |
* @dev ERC721A subclass with convenience query functions. | |
*/ | |
abstract contract ERC721AQueryable is ERC721A, 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>` | |
*/ | |
function explicitOwnershipOf(uint256 tokenId) public view virtual override returns (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} | |
*/ | |
function explicitOwnershipsOf(uint256[] calldata tokenIds) | |
external | |
view | |
virtual | |
override | |
returns (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` | |
*/ | |
function tokensOfOwnerIn( | |
address owner, | |
uint256 start, | |
uint256 stop | |
) external view virtual override returns (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 = new uint256[](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 pfp collections should be fine). | |
*/ | |
function tokensOfOwner(address owner) external view virtual override returns (uint256[] memory) { | |
unchecked { | |
uint256 tokenIdsIdx; | |
address currOwnershipAddr; | |
uint256 tokenIdsLength = balanceOf(owner); | |
uint256[] memory tokenIds = new uint256[](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; | |
} | |
} | |
} | |
// File contracts/external/erc721a/contracts/interfaces/IERC721A.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
// File contracts/external/erc721a/contracts/interfaces/IERC721ABurnable.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
// File contracts/external/erc721a/contracts/interfaces/IERC721AQueryable.sol | |
// ERC721A Contracts v4.1.0 | |
// Creator: Chiru Labs | |
pragma solidity ^0.8.4; | |
// File contracts/external/erc721a/contracts/mocks/ERC721ABurnableMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721ABurnableMock is ERC721A, ERC721ABurnable { | |
constructor(string memory name_, string memory symbol_) ERC721A(name_, symbol_) {} | |
function exists(uint256 tokenId) public view returns (bool) { | |
return _exists(tokenId); | |
} | |
function safeMint(address to, uint256 quantity) public { | |
_safeMint(to, quantity); | |
} | |
function getOwnershipAt(uint256 index) public view returns (TokenOwnership memory) { | |
return _ownershipAt(index); | |
} | |
function totalMinted() public view returns (uint256) { | |
return _totalMinted(); | |
} | |
function totalBurned() public view returns (uint256) { | |
return _totalBurned(); | |
} | |
function numberBurned(address owner) public view returns (uint256) { | |
return _numberBurned(owner); | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/StartTokenIdHelper.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
/** | |
* This Helper is used to return a dynamic value in the overridden _startTokenId() function. | |
* Extending this Helper before the ERC721A contract give us access to the herein set `startTokenId` | |
* to be returned by the overridden `_startTokenId()` function of ERC721A in the ERC721AStartTokenId mocks. | |
*/ | |
contract StartTokenIdHelper { | |
uint256 public startTokenId; | |
constructor(uint256 startTokenId_) { | |
startTokenId = startTokenId_; | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721ABurnableStartTokenIdMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721ABurnableStartTokenIdMock is StartTokenIdHelper, ERC721ABurnableMock { | |
constructor( | |
string memory name_, | |
string memory symbol_, | |
uint256 startTokenId_ | |
) StartTokenIdHelper(startTokenId_) ERC721ABurnableMock(name_, symbol_) {} | |
function _startTokenId() internal view override returns (uint256) { | |
return startTokenId; | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721AGasReporterMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721AGasReporterMock is ERC721A { | |
constructor(string memory name_, string memory symbol_) ERC721A(name_, symbol_) {} | |
function safeMintOne(address to) public { | |
_safeMint(to, 1); | |
} | |
function mintOne(address to) public { | |
_mint(to, 1); | |
} | |
function safeMintTen(address to) public { | |
_safeMint(to, 10); | |
} | |
function mintTen(address to) public { | |
_mint(to, 10); | |
} | |
function transferTenAsc(address to) public { | |
unchecked { | |
transferFrom(msg.sender, to, 0); | |
transferFrom(msg.sender, to, 1); | |
transferFrom(msg.sender, to, 2); | |
transferFrom(msg.sender, to, 3); | |
transferFrom(msg.sender, to, 4); | |
transferFrom(msg.sender, to, 5); | |
transferFrom(msg.sender, to, 6); | |
transferFrom(msg.sender, to, 7); | |
transferFrom(msg.sender, to, 8); | |
transferFrom(msg.sender, to, 9); | |
} | |
} | |
function transferTenDesc(address to) public { | |
unchecked { | |
transferFrom(msg.sender, to, 9); | |
transferFrom(msg.sender, to, 8); | |
transferFrom(msg.sender, to, 7); | |
transferFrom(msg.sender, to, 6); | |
transferFrom(msg.sender, to, 5); | |
transferFrom(msg.sender, to, 4); | |
transferFrom(msg.sender, to, 3); | |
transferFrom(msg.sender, to, 2); | |
transferFrom(msg.sender, to, 1); | |
transferFrom(msg.sender, to, 0); | |
} | |
} | |
function transferTenAvg(address to) public { | |
unchecked { | |
transferFrom(msg.sender, to, 4); | |
transferFrom(msg.sender, to, 5); | |
transferFrom(msg.sender, to, 3); | |
transferFrom(msg.sender, to, 6); | |
transferFrom(msg.sender, to, 2); | |
transferFrom(msg.sender, to, 7); | |
transferFrom(msg.sender, to, 1); | |
transferFrom(msg.sender, to, 8); | |
transferFrom(msg.sender, to, 0); | |
transferFrom(msg.sender, to, 9); | |
} | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721AMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721AMock is ERC721A { | |
constructor(string memory name_, string memory symbol_) ERC721A(name_, symbol_) {} | |
function numberMinted(address owner) public view returns (uint256) { | |
return _numberMinted(owner); | |
} | |
function totalMinted() public view returns (uint256) { | |
return _totalMinted(); | |
} | |
function totalBurned() public view returns (uint256) { | |
return _totalBurned(); | |
} | |
function nextTokenId() public view returns (uint256) { | |
return _nextTokenId(); | |
} | |
function getAux(address owner) public view returns (uint64) { | |
return _getAux(owner); | |
} | |
function setAux(address owner, uint64 aux) public { | |
_setAux(owner, aux); | |
} | |
function baseURI() public view returns (string memory) { | |
return _baseURI(); | |
} | |
function exists(uint256 tokenId) public view returns (bool) { | |
return _exists(tokenId); | |
} | |
function safeMint(address to, uint256 quantity) public { | |
_safeMint(to, quantity); | |
} | |
function safeMint( | |
address to, | |
uint256 quantity, | |
bytes memory _data | |
) public { | |
_safeMint(to, quantity, _data); | |
} | |
function mint(address to, uint256 quantity) public { | |
_mint(to, quantity); | |
} | |
function burn(uint256 tokenId) public { | |
_burn(tokenId); | |
} | |
function burn(uint256 tokenId, bool approvalCheck) public { | |
_burn(tokenId, approvalCheck); | |
} | |
function toString(uint256 x) public pure returns (string memory) { | |
return _toString(x); | |
} | |
function getOwnershipAt(uint256 index) public view returns (TokenOwnership memory) { | |
return _ownershipAt(index); | |
} | |
function getOwnershipOf(uint256 index) public view returns (TokenOwnership memory) { | |
return _ownershipOf(index); | |
} | |
function initializeOwnershipAt(uint256 index) public { | |
_initializeOwnershipAt(index); | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721AQueryableMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721AQueryableMock is ERC721AQueryable, ERC721ABurnable { | |
constructor(string memory name_, string memory symbol_) ERC721A(name_, symbol_) {} | |
function safeMint(address to, uint256 quantity) public { | |
_safeMint(to, quantity); | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721AQueryableStartTokenIdMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721AQueryableStartTokenIdMock is StartTokenIdHelper, ERC721AQueryableMock { | |
constructor( | |
string memory name_, | |
string memory symbol_, | |
uint256 startTokenId_ | |
) StartTokenIdHelper(startTokenId_) ERC721AQueryableMock(name_, symbol_) {} | |
function _startTokenId() internal view override returns (uint256) { | |
return startTokenId; | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721AStartTokenIdMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721AStartTokenIdMock is StartTokenIdHelper, ERC721AMock { | |
constructor( | |
string memory name_, | |
string memory symbol_, | |
uint256 startTokenId_ | |
) StartTokenIdHelper(startTokenId_) ERC721AMock(name_, symbol_) {} | |
function _startTokenId() internal view override returns (uint256) { | |
return startTokenId; | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721ATransferCounterMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721ATransferCounterMock is ERC721AMock { | |
constructor(string memory name_, string memory symbol_) ERC721AMock(name_, symbol_) {} | |
function _extraData( | |
address from, | |
address to, | |
uint24 previousExtraData | |
) internal view virtual override returns (uint24) { | |
if (from == address(0)) { | |
return 42; | |
} | |
if (to == address(0)) { | |
return 1337; | |
} | |
return previousExtraData + 1; | |
} | |
function setExtraDataAt(uint256 index, uint24 extraData) public { | |
_setExtraDataAt(index, extraData); | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721AWithERC2309Mock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
contract ERC721AWithERC2309Mock is ERC721A { | |
constructor( | |
string memory name_, | |
string memory symbol_, | |
address to, | |
uint256 quantity, | |
bool mintInConstructor | |
) ERC721A(name_, symbol_) { | |
if (mintInConstructor) { | |
_mintERC2309(to, quantity); | |
} | |
} | |
/** | |
* @dev This function is only for gas comparison purposes. | |
* Calling `_mintERC3201` outside of contract creation is non-compliant | |
* with the ERC721 standard. | |
*/ | |
function mintOneERC2309(address to) public { | |
_mintERC2309(to, 1); | |
} | |
/** | |
* @dev This function is only for gas comparison purposes. | |
* Calling `_mintERC3201` outside of contract creation is non-compliant | |
* with the ERC721 standard. | |
*/ | |
function mintTenERC2309(address to) public { | |
_mintERC2309(to, 10); | |
} | |
} | |
// File contracts/external/erc721a/contracts/mocks/ERC721ReceiverMock.sol | |
// ERC721A Contracts v4.1.0 | |
// Creators: Chiru Labs | |
pragma solidity ^0.8.4; | |
interface IERC721AMock { | |
function safeMint(address to, uint256 quantity) external; | |
} | |
contract ERC721ReceiverMock is ERC721A__IERC721Receiver { | |
enum Error { | |
None, | |
RevertWithMessage, | |
RevertWithoutMessage, | |
Panic | |
} | |
bytes4 private immutable _retval; | |
address private immutable _erc721aMock; | |
event Received(address operator, address from, uint256 tokenId, bytes data, uint256 gas); | |
constructor(bytes4 retval, address erc721aMock) { | |
_retval = retval; | |
_erc721aMock = erc721aMock; | |
} | |
function onERC721Received( | |
address operator, | |
address from, | |
uint256 tokenId, | |
bytes memory data | |
) public override returns (bytes4) { | |
uint256 dataValue = data.length == 0 ? 0 : uint256(uint8(data[0])); | |
// For testing reverts with a message from the receiver contract. | |
if (dataValue == 0x01) { | |
revert('reverted in the receiver contract!'); | |
} | |
// For testing with the returned wrong value from the receiver contract. | |
if (dataValue == 0x02) { | |
return 0x0; | |
} | |
// For testing the reentrancy protection. | |
if (dataValue == 0x03) { | |
IERC721AMock(_erc721aMock).safeMint(address(this), 1); | |
} | |
emit Received(operator, from, tokenId, data, 20000); | |
return _retval; | |
} | |
} | |
// File @openzeppelin/contracts/utils/Context.sol@v4.7.0 | |
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol) | |
pragma solidity ^0.8.0; | |
/** | |
* @dev Provides information about the current execution context, including the | |
* sender of the transaction and its data. While these are generally available | |
* via msg.sender and msg.data, they should not be accessed in such a direct | |
* manner, since when dealing with meta-transactions the account sending and | |
* paying for execution may not be the actual sender (as far as an application | |
* is concerned). | |
* | |
* This contract is only required for intermediate, library-like contracts. | |
*/ | |
abstract contract Context { | |
function _msgSender() internal view virtual returns (address) { | |
return msg.sender; | |
} | |
function _msgData() internal view virtual returns (bytes calldata) { | |
return msg.data; | |
} | |
} | |
// File @openzeppelin/contracts/access/Ownable.sol@v4.7.0 | |
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol) | |
pragma solidity ^0.8.0; | |
/** | |
* @dev Contract module which provides a basic access control mechanism, where | |
* there is an account (an owner) that can be granted exclusive access to | |
* specific functions. | |
* | |
* By default, the owner account will be the one that deploys the contract. This | |
* can later be changed with {transferOwnership}. | |
* | |
* This module is used through inheritance. It will make available the modifier | |
* `onlyOwner`, which can be applied to your functions to restrict their use to | |
* the owner. | |
*/ | |
abstract contract Ownable is Context { | |
address private _owner; | |
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); | |
/** | |
* @dev Initializes the contract setting the deployer as the initial owner. | |
*/ | |
constructor() { | |
_transferOwnership(_msgSender()); | |
} | |
/** | |
* @dev Throws if called by any account other than the owner. | |
*/ | |
modifier onlyOwner() { | |
_checkOwner(); | |
_; | |
} | |
/** | |
* @dev Returns the address of the current owner. | |
*/ | |
function owner() public view virtual returns (address) { | |
return _owner; | |
} | |
/** | |
* @dev Throws if the sender is not the owner. | |
*/ | |
function _checkOwner() internal view virtual { | |
require(owner() == _msgSender(), "Ownable: caller is not the owner"); | |
} | |
/** | |
* @dev Leaves the contract without owner. It will not be possible to call | |
* `onlyOwner` functions anymore. Can only be called by the current owner. | |
* | |
* NOTE: Renouncing ownership will leave the contract without an owner, | |
* thereby removing any functionality that is only available to the owner. | |
*/ | |
function renounceOwnership() public virtual onlyOwner { | |
_transferOwnership(address(0)); | |
} | |
/** | |
* @dev Transfers ownership of the contract to a new account (`newOwner`). | |
* Can only be called by the current owner. | |
*/ | |
function transferOwnership(address newOwner) public virtual onlyOwner { | |
require(newOwner != address(0), "Ownable: new owner is the zero address"); | |
_transferOwnership(newOwner); | |
} | |
/** | |
* @dev Transfers ownership of the contract to a new account (`newOwner`). | |
* Internal function without access restriction. | |
*/ | |
function _transferOwnership(address newOwner) internal virtual { | |
address oldOwner = _owner; | |
_owner = newOwner; | |
emit OwnershipTransferred(oldOwner, newOwner); | |
} | |
} | |
// File @openzeppelin/contracts/utils/cryptography/MerkleProof.sol@v4.7.0 | |
// OpenZeppelin Contracts (last updated v4.7.0) (utils/cryptography/MerkleProof.sol) | |
pragma solidity ^0.8.0; | |
/** | |
* @dev These functions deal with verification of Merkle Tree proofs. | |
* | |
* The proofs can be generated using the JavaScript library | |
* https://github.com/miguelmota/merkletreejs[merkletreejs]. | |
* Note: the hashing algorithm should be keccak256 and pair sorting should be enabled. | |
* | |
* See `test/utils/cryptography/MerkleProof.test.js` for some examples. | |
* | |
* WARNING: You should avoid using leaf values that are 64 bytes long prior to | |
* hashing, or use a hash function other than keccak256 for hashing leaves. | |
* This is because the concatenation of a sorted pair of internal nodes in | |
* the merkle tree could be reinterpreted as a leaf value. | |
*/ | |
library MerkleProof { | |
/** | |
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree | |
* defined by `root`. For this, a `proof` must be provided, containing | |
* sibling hashes on the branch from the leaf to the root of the tree. Each | |
* pair of leaves and each pair of pre-images are assumed to be sorted. | |
*/ | |
function verify( | |
bytes32[] memory proof, | |
bytes32 root, | |
bytes32 leaf | |
) internal pure returns (bool) { | |
return processProof(proof, leaf) == root; | |
} | |
/** | |
* @dev Calldata version of {verify} | |
* | |
* _Available since v4.7._ | |
*/ | |
function verifyCalldata( | |
bytes32[] calldata proof, | |
bytes32 root, | |
bytes32 leaf | |
) internal pure returns (bool) { | |
return processProofCalldata(proof, leaf) == root; | |
} | |
/** | |
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up | |
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt | |
* hash matches the root of the tree. When processing the proof, the pairs | |
* of leafs & pre-images are assumed to be sorted. | |
* | |
* _Available since v4.4._ | |
*/ | |
function processProof(bytes32[] memory proof, bytes32 leaf) internal pure returns (bytes32) { | |
bytes32 computedHash = leaf; | |
for (uint256 i = 0; i < proof.length; i++) { | |
computedHash = _hashPair(computedHash, proof[i]); | |
} | |
return computedHash; | |
} | |
/** | |
* @dev Calldata version of {processProof} | |
* | |
* _Available since v4.7._ | |
*/ | |
function processProofCalldata(bytes32[] calldata proof, bytes32 leaf) internal pure returns (bytes32) { | |
bytes32 computedHash = leaf; | |
for (uint256 i = 0; i < proof.length; i++) { | |
computedHash = _hashPair(computedHash, proof[i]); | |
} | |
return computedHash; | |
} | |
/** | |
* @dev Returns true if the `leaves` can be proved to be a part of a Merkle tree defined by | |
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}. | |
* | |
* _Available since v4.7._ | |
*/ | |
function multiProofVerify( | |
bytes32[] memory proof, | |
bool[] memory proofFlags, | |
bytes32 root, | |
bytes32[] memory leaves | |
) internal pure returns (bool) { | |
return processMultiProof(proof, proofFlags, leaves) == root; | |
} | |
/** | |
* @dev Calldata version of {multiProofVerify} | |
* | |
* _Available since v4.7._ | |
*/ | |
function multiProofVerifyCalldata( | |
bytes32[] calldata proof, | |
bool[] calldata proofFlags, | |
bytes32 root, | |
bytes32[] memory leaves | |
) internal pure returns (bool) { | |
return processMultiProofCalldata(proof, proofFlags, leaves) == root; | |
} | |
/** | |
* @dev Returns the root of a tree reconstructed from `leaves` and the sibling nodes in `proof`, | |
* consuming from one or the other at each step according to the instructions given by | |
* `proofFlags`. | |
* | |
* _Available since v4.7._ | |
*/ | |
function processMultiProof( | |
bytes32[] memory proof, | |
bool[] memory proofFlags, | |
bytes32[] memory leaves | |
) internal pure returns (bytes32 merkleRoot) { | |
// This function rebuild the root hash by traversing the tree up from the leaves. The root is rebuilt by | |
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the | |
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of | |
// the merkle tree. | |
uint256 leavesLen = leaves.length; | |
uint256 totalHashes = proofFlags.length; | |
// Check proof validity. | |
require(leavesLen + proof.length - 1 == totalHashes, "MerkleProof: invalid multiproof"); | |
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using | |
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop". | |
bytes32[] memory hashes = new bytes32[](totalHashes); | |
uint256 leafPos = 0; | |
uint256 hashPos = 0; | |
uint256 proofPos = 0; | |
// At each step, we compute the next hash using two values: | |
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we | |
// get the next hash. | |
// - depending on the flag, either another value for the "main queue" (merging branches) or an element from the | |
// `proof` array. | |
for (uint256 i = 0; i < totalHashes; i++) { | |
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++]; | |
bytes32 b = proofFlags[i] ? leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++] : proof[proofPos++]; | |
hashes[i] = _hashPair(a, b); | |
} | |
if (totalHashes > 0) { | |
return hashes[totalHashes - 1]; | |
} else if (leavesLen > 0) { | |
return leaves[0]; | |
} else { | |
return proof[0]; | |
} | |
} | |
/** | |
* @dev Calldata version of {processMultiProof} | |
* | |
* _Available since v4.7._ | |
*/ | |
function processMultiProofCalldata( | |
bytes32[] calldata proof, | |
bool[] calldata proofFlags, | |
bytes32[] memory leaves | |
) internal pure returns (bytes32 merkleRoot) { | |
// This function rebuild the root hash by traversing the tree up from the leaves. The root is rebuilt by | |
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the | |
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of | |
// the merkle tree. | |
uint256 leavesLen = leaves.length; | |
uint256 totalHashes = proofFlags.length; | |
// Check proof validity. | |
require(leavesLen + proof.length - 1 == totalHashes, "MerkleProof: invalid multiproof"); | |
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using | |
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop". | |
bytes32[] memory hashes = new bytes32[](totalHashes); | |
uint256 leafPos = 0; | |
uint256 hashPos = 0; | |
uint256 proofPos = 0; | |
// At each step, we compute the next hash using two values: | |
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we | |
// get the next hash. | |
// - depending on the flag, either another value for the "main queue" (merging branches) or an element from the | |
// `proof` array. | |
for (uint256 i = 0; i < totalHashes; i++) { | |
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++]; | |
bytes32 b = proofFlags[i] ? leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++] : proof[proofPos++]; | |
hashes[i] = _hashPair(a, b); | |
} | |
if (totalHashes > 0) { | |
return hashes[totalHashes - 1]; | |
} else if (leavesLen > 0) { | |
return leaves[0]; | |
} else { | |
return proof[0]; | |
} | |
} | |
function _hashPair(bytes32 a, bytes32 b) private pure returns (bytes32) { | |
return a < b ? _efficientHash(a, b) : _efficientHash(b, a); | |
} | |
function _efficientHash(bytes32 a, bytes32 b) private pure returns (bytes32 value) { | |
/// @solidity memory-safe-assembly | |
assembly { | |
mstore(0x00, a) | |
mstore(0x20, b) | |
value := keccak256(0x00, 0x40) | |
} | |
} | |
} | |
// File contracts/SmartGenerative.sol | |
// SPDX-License-Identifier: MIT | |
// Copyright (c) 2022 masataka.eth | |
/* | |
Permission is hereby granted, free of charge, to any person obtaining a copy | |
of this software and associated documentation files (the "Software"), to deal | |
in the Software without restriction, including without limitation the rights | |
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
copies of the Software, and to permit persons to whom the Software is | |
furnished to do so, subject to the following conditions: | |
The above copyright notice and this permission notice shall be included in all | |
copies or substantial portions of the Software. | |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
SOFTWARE. | |
*/ | |
pragma solidity >=0.7.0 <0.9.0; | |
//import "hardhat/console.sol"; // Hardhat console log | |
/** | |
* @title SmartGenerative | |
* @notice Mint Generative NFT (add RRC721A and WL's MerkleProof) | |
*/ | |
contract TORIIPROJECT is ERC721A, Ownable { | |
string baseURI; | |
string public baseExtension = ".json"; | |
uint256 public cost = 0.25 ether; | |
uint256 public maxSupply = 4; | |
uint256 public maxMintAmount = 5; | |
bool public paused = true; | |
constructor( | |
) ERC721A('TORII PROJECT', 'TORII') { | |
setBaseURI('https://bafybeiem74soagsy4tel5f4oie5bkjbckbzjszmwp7whtp7gtvsu5xk2la.ipfs.nftstorage.link/'); | |
} | |
// internal | |
function _baseURI() internal view virtual override returns (string memory) { | |
return baseURI; | |
} | |
/** | |
* @notice Mint from mint site | |
*/ | |
function mint() public payable { | |
require(!paused, "the contract is paused"); | |
uint256 supply = totalSupply(); | |
require(supply + 1 <= maxSupply, "max NFT limit exceeded"); | |
// Owner also can mint. | |
if (msg.sender != owner()) { | |
require(msg.value >= cost , "insufficient funds"); | |
} | |
_safeMint(msg.sender, 1); | |
} | |
/** | |
* @notice Mint from mint site | |
*/ | |
function mint2nd3rd(uint256 _amount) public payable { | |
require(!paused, "the contract is paused"); | |
uint256 supply = totalSupply(); | |
require(supply + _amount <= maxSupply, "max NFT limit exceeded"); | |
require(maxMintAmount >= _amount, "Please mint number below 5"); | |
require(_amount >= 0, "Please set the mint count from 1 to 5"); | |
// Owner also can mint. | |
if (msg.sender != owner()) { | |
require(msg.value >= cost * _amount, "insufficient funds"); | |
} | |
_safeMint(msg.sender, _amount); | |
} | |
/** | |
* @notice Use for airdrop | |
* @param _airdropAddresses Airdrop address array | |
* @param _UserMintAmount Airdrop amount of mint array | |
* @dev onlyOwner | |
*/ | |
function airdropMint(address[] calldata _airdropAddresses , uint256[] memory _UserMintAmount) public onlyOwner{ | |
uint256 supply = totalSupply(); | |
uint256 _mintAmount = 0; | |
for (uint256 i = 0; i < _UserMintAmount.length; i++) { | |
_mintAmount += _UserMintAmount[i]; | |
} | |
require(_mintAmount > 0, "need to mint at least 1 NFT"); | |
require(supply + _mintAmount <= maxSupply, "max NFT limit exceeded"); | |
for (uint256 i = 0; i < _UserMintAmount.length; i++) { | |
_safeMint(_airdropAddresses[i], _UserMintAmount[i] ); | |
} | |
} | |
function tokenURI(uint256 tokenId) public view virtual override returns (string memory){ | |
return string(abi.encodePacked(ERC721A.tokenURI(tokenId), baseExtension)); | |
} | |
function is_paused() public view returns(bool){ | |
return paused; | |
} | |
//only owner | |
function setCost(uint256 _newCost) public onlyOwner { | |
cost = _newCost; | |
} | |
function getMaxSupply() public view onlyOwner returns(uint256){ | |
return maxSupply; | |
} | |
function setmaxMintAmount(uint256 _newmaxMintAmount) public onlyOwner { | |
maxMintAmount = _newmaxMintAmount; | |
} | |
function setBaseURI(string memory _newBaseURI) public onlyOwner { | |
baseURI = _newBaseURI; | |
} | |
function setBaseExtension(string memory _newBaseExtension) public onlyOwner { | |
baseExtension = _newBaseExtension; | |
} | |
function pause(bool _state) public onlyOwner { | |
paused = _state; | |
} | |
function setMaxSupply(uint256 _amount) public onlyOwner { | |
maxSupply = _amount; | |
} | |
function withdraw() public payable onlyOwner { | |
(bool os, ) = payable(owner()).call{value: address(this).balance}(""); | |
require(os); | |
} | |
/** | |
* @notice ERC721A override | |
* @return uint256 Return index at 1 | |
* @dev Changed because ERC721A returns index 0 | |
*/ | |
function _startTokenId() internal view virtual override returns (uint256) { | |
return 1; | |
} | |
} |