// SPDX-License-Identifier: MIT // ERC721A Contracts v4.2.2 // Creator: Chiru Labs pragma solidity ^0.8.4; import { IERC721A } from "ERC721A/IERC721A.sol"; import { Initializable } from "openzeppelin-contracts-upgradeable/proxy/utils/Initializable.sol"; /** * @dev Interface of ERC721 token receiver. */ interface ERC721A__IERC721Receiver { function onERC721Received( address operator, address from, uint256 tokenId, bytes calldata data ) external returns (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). */ contract ERC721ACloneable is IERC721A, Initializable { // Bypass for a `--via-ir` bug (https://github.com/chiru-labs/ERC721A/pull/364). struct TokenApprovalRef { address value; } // ============================================================= // CONSTANTS // ============================================================= // 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 `Transfer` event signature is given by: // `keccak256(bytes("Transfer(address,address,uint256)"))`. bytes32 private constant _TRANSFER_EVENT_SIGNATURE = 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef; // ============================================================= // STORAGE // ============================================================= // The next token ID 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 // ============================================================= function __ERC721ACloneable__init( string memory name_, string memory symbol_ ) internal onlyInitializing { _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() 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; } // ============================================================= // ADDRESS DATA OPERATIONS // ============================================================= /** * @dev Returns the number of tokens in `owner`'s account. */ 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 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 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 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; } // ============================================================= // 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. */ 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: [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. */ function name() public view virtual override returns (string memory) { return _name; } /** * @dev Returns the token collection symbol. */ function symbol() public view virtual override returns (string memory) { return _symbol; } /** * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token. */ 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 ""; } // ============================================================= // OWNERSHIPS OPERATIONS // ============================================================= /** * @dev Returns the owner of the `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function ownerOf(uint256 tokenId) public view virtual override returns (address) { return address(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) internal view virtual returns (TokenOwnership memory) { return _unpackedOwnership(_packedOwnershipOf(tokenId)); } /** * @dev 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); } } /** * 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 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) 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); } /** * @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 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)) } } // ============================================================= // 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. */ 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 Returns the account approved for `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function getApproved(uint256 tokenId) public view virtual override returns (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. */ function setApprovalForAll(address operator, bool approved) public virtual override { _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}. */ function isApprovedForAll(address owner, address operator) public view virtual override returns (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) internal view virtual returns (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 ) private pure returns (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) private view returns (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. */ 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 ) = _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, '')`. */ function safeTransferFrom( address from, address to, uint256 tokenId ) public virtual override { 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. */ 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 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 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( 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)) } } } } // ============================================================= // 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) internal virtual { 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) 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 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 Equivalent to `_safeMint(to, quantity, '')`. */ function _safeMint(address to, uint256 quantity) internal virtual { _safeMint(to, quantity, ""); } // ============================================================= // BURN OPERATIONS // ============================================================= /** * @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 ) = _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) 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 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 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; } // ============================================================= // 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() 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 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-ignore for { 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-ignore if iszero(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) } } } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; import { ERC721ContractMetadataCloneable, ISeaDropTokenContractMetadata } from "./ERC721ContractMetadataCloneable.sol"; import { INonFungibleSeaDropToken } from "../interfaces/INonFungibleSeaDropToken.sol"; import { ISeaDrop } from "../interfaces/ISeaDrop.sol"; import { AllowListData, PublicDrop, TokenGatedDropStage, SignedMintValidationParams } from "../lib/SeaDropStructs.sol"; import { ERC721SeaDropStructsErrorsAndEvents } from "../lib/ERC721SeaDropStructsErrorsAndEvents.sol"; import { ERC721ACloneable } from "./ERC721ACloneable.sol"; import { ReentrancyGuardUpgradeable } from "openzeppelin-contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol"; import { IERC165 } from "openzeppelin-contracts/utils/introspection/IERC165.sol"; /** * @title ERC721SeaDrop * @author James Wenzel (emo.eth) * @author Ryan Ghods (ralxz.eth) * @author Stephan Min (stephanm.eth) * @author Michael Cohen (notmichael.eth) * @custom:contributor Limit Break (@limitbreak) * @notice ERC721SeaDrop is a token contract that contains methods * to properly interact with SeaDrop. * Implements Limit Break's Creator Token Standards transfer * validation for royalty enforcement. */ contract ERC721SeaDropCloneable is ERC721ContractMetadataCloneable, INonFungibleSeaDropToken, ERC721SeaDropStructsErrorsAndEvents, ReentrancyGuardUpgradeable { /// @notice Track the allowed SeaDrop addresses. mapping(address => bool) internal _allowedSeaDrop; /// @notice Track the enumerated allowed SeaDrop addresses. address[] internal _enumeratedAllowedSeaDrop; /** * @dev Reverts if not an allowed SeaDrop contract. * This function is inlined instead of being a modifier * to save contract space from being inlined N times. * * @param seaDrop The SeaDrop address to check if allowed. */ function _onlyAllowedSeaDrop(address seaDrop) internal view { if (_allowedSeaDrop[seaDrop] != true) { revert OnlyAllowedSeaDrop(); } } /** * @notice Deploy the token contract with its name, symbol, * and allowed SeaDrop addresses. */ function initialize( string calldata __name, string calldata __symbol, address[] calldata allowedSeaDrop, address initialOwner ) public initializer { __ERC721ACloneable__init(__name, __symbol); __ReentrancyGuard_init(); _updateAllowedSeaDrop(allowedSeaDrop); _transferOwnership(initialOwner); emit SeaDropTokenDeployed(); } /** * @notice Update the allowed SeaDrop contracts. * Only the owner can use this function. * * @param allowedSeaDrop The allowed SeaDrop addresses. */ function updateAllowedSeaDrop(address[] calldata allowedSeaDrop) external virtual override onlyOwner { _updateAllowedSeaDrop(allowedSeaDrop); } /** * @notice Internal function to update the allowed SeaDrop contracts. * * @param allowedSeaDrop The allowed SeaDrop addresses. */ function _updateAllowedSeaDrop(address[] calldata allowedSeaDrop) internal { // Put the length on the stack for more efficient access. uint256 enumeratedAllowedSeaDropLength = _enumeratedAllowedSeaDrop .length; uint256 allowedSeaDropLength = allowedSeaDrop.length; // Reset the old mapping. for (uint256 i = 0; i < enumeratedAllowedSeaDropLength; ) { _allowedSeaDrop[_enumeratedAllowedSeaDrop[i]] = false; unchecked { ++i; } } // Set the new mapping for allowed SeaDrop contracts. for (uint256 i = 0; i < allowedSeaDropLength; ) { _allowedSeaDrop[allowedSeaDrop[i]] = true; unchecked { ++i; } } // Set the enumeration. _enumeratedAllowedSeaDrop = allowedSeaDrop; // Emit an event for the update. emit AllowedSeaDropUpdated(allowedSeaDrop); } /** * @notice Burns `tokenId`. The caller must own `tokenId` or be an * approved operator. * * @param tokenId The token id to burn. */ // solhint-disable-next-line comprehensive-interface function burn(uint256 tokenId) external { _burn(tokenId, true); } /** * @dev Overrides the `_startTokenId` function from ERC721A * to start at token id `1`. * * This is to avoid future possible problems since `0` is usually * used to signal values that have not been set or have been removed. */ function _startTokenId() internal view virtual override returns (uint256) { return 1; } /** * @dev Overrides the `tokenURI()` function from ERC721A * to return just the base URI if it is implied to not be a directory. * * This is to help with ERC721 contracts in which the same token URI * is desired for each token, such as when the tokenURI is 'unrevealed'. */ function tokenURI(uint256 tokenId) public view virtual override returns (string memory) { if (!_exists(tokenId)) revert URIQueryForNonexistentToken(); string memory baseURI = _baseURI(); // Exit early if the baseURI is empty. if (bytes(baseURI).length == 0) { return ""; } // Check if the last character in baseURI is a slash. if (bytes(baseURI)[bytes(baseURI).length - 1] != bytes("/")[0]) { return baseURI; } return string(abi.encodePacked(baseURI, _toString(tokenId))); } /** * @notice Mint tokens, restricted to the SeaDrop contract. * * @dev NOTE: If a token registers itself with multiple SeaDrop * contracts, the implementation of this function should guard * against reentrancy. If the implementing token uses * _safeMint(), or a feeRecipient with a malicious receive() hook * is specified, the token or fee recipients may be able to execute * another mint in the same transaction via a separate SeaDrop * contract. * This is dangerous if an implementing token does not correctly * update the minterNumMinted and currentTotalSupply values before * transferring minted tokens, as SeaDrop references these values * to enforce token limits on a per-wallet and per-stage basis. * * ERC721A tracks these values automatically, but this note and * nonReentrant modifier are left here to encourage best-practices * when referencing this contract. * * @param minter The address to mint to. * @param quantity The number of tokens to mint. */ function mintSeaDrop(address minter, uint256 quantity) external virtual override nonReentrant { // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(msg.sender); // Extra safety check to ensure the max supply is not exceeded. if (_totalMinted() + quantity > maxSupply()) { revert MintQuantityExceedsMaxSupply( _totalMinted() + quantity, maxSupply() ); } // Mint the quantity of tokens to the minter. _safeMint(minter, quantity); } /** * @notice Update the public drop data for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param publicDrop The public drop data. */ function updatePublicDrop( address seaDropImpl, PublicDrop calldata publicDrop ) external virtual override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the public drop data on SeaDrop. ISeaDrop(seaDropImpl).updatePublicDrop(publicDrop); } /** * @notice Update the allow list data for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param allowListData The allow list data. */ function updateAllowList( address seaDropImpl, AllowListData calldata allowListData ) external virtual override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the allow list on SeaDrop. ISeaDrop(seaDropImpl).updateAllowList(allowListData); } /** * @notice Update the token gated drop stage data for this nft contract * on SeaDrop. * Only the owner can use this function. * * Note: If two INonFungibleSeaDropToken tokens are doing * simultaneous token gated drop promotions for each other, * they can be minted by the same actor until * `maxTokenSupplyForStage` is reached. Please ensure the * `allowedNftToken` is not running an active drop during the * `dropStage` time period. * * @param seaDropImpl The allowed SeaDrop contract. * @param allowedNftToken The allowed nft token. * @param dropStage The token gated drop stage data. */ function updateTokenGatedDrop( address seaDropImpl, address allowedNftToken, TokenGatedDropStage calldata dropStage ) external virtual override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the token gated drop stage. ISeaDrop(seaDropImpl).updateTokenGatedDrop(allowedNftToken, dropStage); } /** * @notice Update the drop URI for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param dropURI The new drop URI. */ function updateDropURI(address seaDropImpl, string calldata dropURI) external virtual override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the drop URI. ISeaDrop(seaDropImpl).updateDropURI(dropURI); } /** * @notice Update the creator payout address for this nft contract on * SeaDrop. * Only the owner can set the creator payout address. * * @param seaDropImpl The allowed SeaDrop contract. * @param payoutAddress The new payout address. */ function updateCreatorPayoutAddress( address seaDropImpl, address payoutAddress ) external { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the creator payout address. ISeaDrop(seaDropImpl).updateCreatorPayoutAddress(payoutAddress); } /** * @notice Update the allowed fee recipient for this nft contract * on SeaDrop. * Only the owner can set the allowed fee recipient. * * @param seaDropImpl The allowed SeaDrop contract. * @param feeRecipient The new fee recipient. * @param allowed If the fee recipient is allowed. */ function updateAllowedFeeRecipient( address seaDropImpl, address feeRecipient, bool allowed ) external virtual { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the allowed fee recipient. ISeaDrop(seaDropImpl).updateAllowedFeeRecipient(feeRecipient, allowed); } /** * @notice Update the server-side signers for this nft contract * on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param signer The signer to update. * @param signedMintValidationParams Minimum and maximum parameters to * enforce for signed mints. */ function updateSignedMintValidationParams( address seaDropImpl, address signer, SignedMintValidationParams memory signedMintValidationParams ) external virtual override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the signer. ISeaDrop(seaDropImpl).updateSignedMintValidationParams( signer, signedMintValidationParams ); } /** * @notice Update the allowed payers for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param payer The payer to update. * @param allowed Whether the payer is allowed. */ function updatePayer( address seaDropImpl, address payer, bool allowed ) external virtual override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the SeaDrop is allowed. _onlyAllowedSeaDrop(seaDropImpl); // Update the payer. ISeaDrop(seaDropImpl).updatePayer(payer, allowed); } /** * @notice Returns a set of mint stats for the address. * This assists SeaDrop in enforcing maxSupply, * maxTotalMintableByWallet, and maxTokenSupplyForStage checks. * * @dev NOTE: Implementing contracts should always update these numbers * before transferring any tokens with _safeMint() to mitigate * consequences of malicious onERC721Received() hooks. * * @param minter The minter address. */ function getMintStats(address minter) external view override returns ( uint256 minterNumMinted, uint256 currentTotalSupply, uint256 maxSupply ) { minterNumMinted = _numberMinted(minter); currentTotalSupply = _totalMinted(); maxSupply = _maxSupply; } /** * @notice Returns whether the interface is supported. * * @param interfaceId The interface id to check against. */ function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC721ContractMetadataCloneable) returns (bool) { return interfaceId == type(INonFungibleSeaDropToken).interfaceId || interfaceId == type(ISeaDropTokenContractMetadata).interfaceId || // ERC721ContractMetadata returns supportsInterface true for // EIP-2981 // ERC721A returns supportsInterface true for // ERC165, ERC721, ERC721Metadata super.supportsInterface(interfaceId); } /** * @notice Configure multiple properties at a time. * * Note: The individual configure methods should be used * to unset or reset any properties to zero, as this method * will ignore zero-value properties in the config struct. * * @param config The configuration struct. */ function multiConfigure(MultiConfigureStruct calldata config) external onlyOwner { if (config.maxSupply > 0) { this.setMaxSupply(config.maxSupply); } if (bytes(config.baseURI).length != 0) { this.setBaseURI(config.baseURI); } if (bytes(config.contractURI).length != 0) { this.setContractURI(config.contractURI); } if ( _cast(config.publicDrop.startTime != 0) | _cast(config.publicDrop.endTime != 0) == 1 ) { this.updatePublicDrop(config.seaDropImpl, config.publicDrop); } if (bytes(config.dropURI).length != 0) { this.updateDropURI(config.seaDropImpl, config.dropURI); } if (config.allowListData.merkleRoot != bytes32(0)) { this.updateAllowList(config.seaDropImpl, config.allowListData); } if (config.creatorPayoutAddress != address(0)) { this.updateCreatorPayoutAddress( config.seaDropImpl, config.creatorPayoutAddress ); } if (config.provenanceHash != bytes32(0)) { this.setProvenanceHash(config.provenanceHash); } if (config.allowedFeeRecipients.length > 0) { for (uint256 i = 0; i < config.allowedFeeRecipients.length; ) { this.updateAllowedFeeRecipient( config.seaDropImpl, config.allowedFeeRecipients[i], true ); unchecked { ++i; } } } if (config.disallowedFeeRecipients.length > 0) { for (uint256 i = 0; i < config.disallowedFeeRecipients.length; ) { this.updateAllowedFeeRecipient( config.seaDropImpl, config.disallowedFeeRecipients[i], false ); unchecked { ++i; } } } if (config.allowedPayers.length > 0) { for (uint256 i = 0; i < config.allowedPayers.length; ) { this.updatePayer( config.seaDropImpl, config.allowedPayers[i], true ); unchecked { ++i; } } } if (config.disallowedPayers.length > 0) { for (uint256 i = 0; i < config.disallowedPayers.length; ) { this.updatePayer( config.seaDropImpl, config.disallowedPayers[i], false ); unchecked { ++i; } } } if (config.tokenGatedDropStages.length > 0) { if ( config.tokenGatedDropStages.length != config.tokenGatedAllowedNftTokens.length ) { revert TokenGatedMismatch(); } for (uint256 i = 0; i < config.tokenGatedDropStages.length; ) { this.updateTokenGatedDrop( config.seaDropImpl, config.tokenGatedAllowedNftTokens[i], config.tokenGatedDropStages[i] ); unchecked { ++i; } } } if (config.disallowedTokenGatedAllowedNftTokens.length > 0) { for ( uint256 i = 0; i < config.disallowedTokenGatedAllowedNftTokens.length; ) { TokenGatedDropStage memory emptyStage; this.updateTokenGatedDrop( config.seaDropImpl, config.disallowedTokenGatedAllowedNftTokens[i], emptyStage ); unchecked { ++i; } } } if (config.signedMintValidationParams.length > 0) { if ( config.signedMintValidationParams.length != config.signers.length ) { revert SignersMismatch(); } for ( uint256 i = 0; i < config.signedMintValidationParams.length; ) { this.updateSignedMintValidationParams( config.seaDropImpl, config.signers[i], config.signedMintValidationParams[i] ); unchecked { ++i; } } } if (config.disallowedSigners.length > 0) { for (uint256 i = 0; i < config.disallowedSigners.length; ) { SignedMintValidationParams memory emptyParams; this.updateSignedMintValidationParams( config.seaDropImpl, config.disallowedSigners[i], emptyParams ); unchecked { ++i; } } } } } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; import { AllowListData, MintParams, PublicDrop, TokenGatedDropStage, TokenGatedMintParams, SignedMintValidationParams } from "../lib/SeaDropStructs.sol"; import { SeaDropErrorsAndEvents } from "../lib/SeaDropErrorsAndEvents.sol"; interface ISeaDrop is SeaDropErrorsAndEvents { /** * @notice Mint a public drop. * * @param nftContract The nft contract to mint. * @param feeRecipient The fee recipient. * @param minterIfNotPayer The mint recipient if different than the payer. * @param quantity The number of tokens to mint. */ function mintPublic( address nftContract, address feeRecipient, address minterIfNotPayer, uint256 quantity ) external payable; /** * @notice Mint from an allow list. * * @param nftContract The nft contract to mint. * @param feeRecipient The fee recipient. * @param minterIfNotPayer The mint recipient if different than the payer. * @param quantity The number of tokens to mint. * @param mintParams The mint parameters. * @param proof The proof for the leaf of the allow list. */ function mintAllowList( address nftContract, address feeRecipient, address minterIfNotPayer, uint256 quantity, MintParams calldata mintParams, bytes32[] calldata proof ) external payable; /** * @notice Mint with a server-side signature. * Note that a signature can only be used once. * * @param nftContract The nft contract to mint. * @param feeRecipient The fee recipient. * @param minterIfNotPayer The mint recipient if different than the payer. * @param quantity The number of tokens to mint. * @param mintParams The mint parameters. * @param salt The sale for the signed mint. * @param signature The server-side signature, must be an allowed * signer. */ function mintSigned( address nftContract, address feeRecipient, address minterIfNotPayer, uint256 quantity, MintParams calldata mintParams, uint256 salt, bytes calldata signature ) external payable; /** * @notice Mint as an allowed token holder. * This will mark the token id as redeemed and will revert if the * same token id is attempted to be redeemed twice. * * @param nftContract The nft contract to mint. * @param feeRecipient The fee recipient. * @param minterIfNotPayer The mint recipient if different than the payer. * @param mintParams The token gated mint params. */ function mintAllowedTokenHolder( address nftContract, address feeRecipient, address minterIfNotPayer, TokenGatedMintParams calldata mintParams ) external payable; /** * @notice Emits an event to notify update of the drop URI. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * @param dropURI The new drop URI. */ function updateDropURI(string calldata dropURI) external; /** * @notice Updates the public drop data for the nft contract * and emits an event. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * @param publicDrop The public drop data. */ function updatePublicDrop(PublicDrop calldata publicDrop) external; /** * @notice Updates the allow list merkle root for the nft contract * and emits an event. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * @param allowListData The allow list data. */ function updateAllowList(AllowListData calldata allowListData) external; /** * @notice Updates the token gated drop stage for the nft contract * and emits an event. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * Note: If two INonFungibleSeaDropToken tokens are doing * simultaneous token gated drop promotions for each other, * they can be minted by the same actor until * `maxTokenSupplyForStage` is reached. Please ensure the * `allowedNftToken` is not running an active drop during * the `dropStage` time period. * * @param allowedNftToken The token gated nft token. * @param dropStage The token gated drop stage data. */ function updateTokenGatedDrop( address allowedNftToken, TokenGatedDropStage calldata dropStage ) external; /** * @notice Updates the creator payout address and emits an event. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * @param payoutAddress The creator payout address. */ function updateCreatorPayoutAddress(address payoutAddress) external; /** * @notice Updates the allowed fee recipient and emits an event. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * @param feeRecipient The fee recipient. * @param allowed If the fee recipient is allowed. */ function updateAllowedFeeRecipient(address feeRecipient, bool allowed) external; /** * @notice Updates the allowed server-side signers and emits an event. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * @param signer The signer to update. * @param signedMintValidationParams Minimum and maximum parameters * to enforce for signed mints. */ function updateSignedMintValidationParams( address signer, SignedMintValidationParams calldata signedMintValidationParams ) external; /** * @notice Updates the allowed payer and emits an event. * * This method assume msg.sender is an nft contract and its * ERC165 interface id matches INonFungibleSeaDropToken. * * Note: Be sure only authorized users can call this from * token contracts that implement INonFungibleSeaDropToken. * * @param payer The payer to add or remove. * @param allowed Whether to add or remove the payer. */ function updatePayer(address payer, bool allowed) external; /** * @notice Returns the public drop data for the nft contract. * * @param nftContract The nft contract. */ function getPublicDrop(address nftContract) external view returns (PublicDrop memory); /** * @notice Returns the creator payout address for the nft contract. * * @param nftContract The nft contract. */ function getCreatorPayoutAddress(address nftContract) external view returns (address); /** * @notice Returns the allow list merkle root for the nft contract. * * @param nftContract The nft contract. */ function getAllowListMerkleRoot(address nftContract) external view returns (bytes32); /** * @notice Returns if the specified fee recipient is allowed * for the nft contract. * * @param nftContract The nft contract. * @param feeRecipient The fee recipient. */ function getFeeRecipientIsAllowed(address nftContract, address feeRecipient) external view returns (bool); /** * @notice Returns an enumeration of allowed fee recipients for an * nft contract when fee recipients are enforced * * @param nftContract The nft contract. */ function getAllowedFeeRecipients(address nftContract) external view returns (address[] memory); /** * @notice Returns the server-side signers for the nft contract. * * @param nftContract The nft contract. */ function getSigners(address nftContract) external view returns (address[] memory); /** * @notice Returns the struct of SignedMintValidationParams for a signer. * * @param nftContract The nft contract. * @param signer The signer. */ function getSignedMintValidationParams(address nftContract, address signer) external view returns (SignedMintValidationParams memory); /** * @notice Returns the payers for the nft contract. * * @param nftContract The nft contract. */ function getPayers(address nftContract) external view returns (address[] memory); /** * @notice Returns if the specified payer is allowed * for the nft contract. * * @param nftContract The nft contract. * @param payer The payer. */ function getPayerIsAllowed(address nftContract, address payer) external view returns (bool); /** * @notice Returns the allowed token gated drop tokens for the nft contract. * * @param nftContract The nft contract. */ function getTokenGatedAllowedTokens(address nftContract) external view returns (address[] memory); /** * @notice Returns the token gated drop data for the nft contract * and token gated nft. * * @param nftContract The nft contract. * @param allowedNftToken The token gated nft token. */ function getTokenGatedDrop(address nftContract, address allowedNftToken) external view returns (TokenGatedDropStage memory); /** * @notice Returns whether the token id for a token gated drop has been * redeemed. * * @param nftContract The nft contract. * @param allowedNftToken The token gated nft token. * @param allowedNftTokenId The token gated nft token id to check. */ function getAllowedNftTokenIdIsRedeemed( address nftContract, address allowedNftToken, uint256 allowedNftTokenId ) external view returns (bool); } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; import { ISeaDropTokenContractMetadata } from "../interfaces/ISeaDropTokenContractMetadata.sol"; import { ERC721AConduitPreapprovedCloneable } from "./ERC721AConduitPreapprovedCloneable.sol"; import { ERC721ACloneable } from "./ERC721ACloneable.sol"; import { ERC721TransferValidator } from "../lib/ERC721TransferValidator.sol"; import { ICreatorToken, ILegacyCreatorToken } from "../interfaces/ICreatorToken.sol"; import { ITransferValidator721 } from "../interfaces/ITransferValidator.sol"; import { TwoStepOwnable } from "utility-contracts/TwoStepOwnable.sol"; import { IERC2981 } from "openzeppelin-contracts/interfaces/IERC2981.sol"; import { IERC165 } from "openzeppelin-contracts/utils/introspection/IERC165.sol"; /** * @title ERC721ContractMetadataCloneable * @author James Wenzel (emo.eth) * @author Ryan Ghods (ralxz.eth) * @author Stephan Min (stephanm.eth) * @notice ERC721ContractMetadata is a token contract that extends ERC721A * with additional metadata and ownership capabilities. */ contract ERC721ContractMetadataCloneable is ERC721AConduitPreapprovedCloneable, ERC721TransferValidator, TwoStepOwnable, ISeaDropTokenContractMetadata { /// @notice Track the max supply. uint256 _maxSupply; /// @notice Track the base URI for token metadata. string _tokenBaseURI; /// @notice Track the contract URI for contract metadata. string _contractURI; /// @notice Track the provenance hash for guaranteeing metadata order /// for random reveals. bytes32 _provenanceHash; /// @notice Track the royalty info: address to receive royalties, and /// royalty basis points. RoyaltyInfo _royaltyInfo; /** * @dev Reverts if the sender is not the owner or the contract itself. * This function is inlined instead of being a modifier * to save contract space from being inlined N times. */ function _onlyOwnerOrSelf() internal view { if ( _cast(msg.sender == owner()) | _cast(msg.sender == address(this)) == 0 ) { revert OnlyOwner(); } } /** * @notice Sets the base URI for the token metadata and emits an event. * * @param newBaseURI The new base URI to set. */ function setBaseURI(string calldata newBaseURI) external override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Set the new base URI. _tokenBaseURI = newBaseURI; // Emit an event with the update. if (totalSupply() != 0) { emit BatchMetadataUpdate(1, _nextTokenId() - 1); } } /** * @notice Sets the contract URI for contract metadata. * * @param newContractURI The new contract URI. */ function setContractURI(string calldata newContractURI) external override { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Set the new contract URI. _contractURI = newContractURI; // Emit an event with the update. emit ContractURIUpdated(newContractURI); } /** * @notice Emit an event notifying metadata updates for * a range of token ids, according to EIP-4906. * * @param fromTokenId The start token id. * @param toTokenId The end token id. */ function emitBatchMetadataUpdate(uint256 fromTokenId, uint256 toTokenId) external { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Emit an event with the update. emit BatchMetadataUpdate(fromTokenId, toTokenId); } /** * @notice Sets the max token supply and emits an event. * * @param newMaxSupply The new max supply to set. */ function setMaxSupply(uint256 newMaxSupply) external { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Ensure the max supply does not exceed the maximum value of uint64. if (newMaxSupply > 2**64 - 1) { revert CannotExceedMaxSupplyOfUint64(newMaxSupply); } // Set the new max supply. _maxSupply = newMaxSupply; // Emit an event with the update. emit MaxSupplyUpdated(newMaxSupply); } /** * @notice Sets the provenance hash and emits an event. * * The provenance hash is used for random reveals, which * is a hash of the ordered metadata to show it has not been * modified after mint started. * * This function will revert after the first item has been minted. * * @param newProvenanceHash The new provenance hash to set. */ function setProvenanceHash(bytes32 newProvenanceHash) external { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Revert if any items have been minted. if (_totalMinted() > 0) { revert ProvenanceHashCannotBeSetAfterMintStarted(); } // Keep track of the old provenance hash for emitting with the event. bytes32 oldProvenanceHash = _provenanceHash; // Set the new provenance hash. _provenanceHash = newProvenanceHash; // Emit an event with the update. emit ProvenanceHashUpdated(oldProvenanceHash, newProvenanceHash); } /** * @notice Sets the address and basis points for royalties. * * @param newInfo The struct to configure royalties. */ function setRoyaltyInfo(RoyaltyInfo calldata newInfo) external { // Ensure the sender is only the owner or contract itself. _onlyOwnerOrSelf(); // Revert if the new royalty address is the zero address. if (newInfo.royaltyAddress == address(0)) { revert RoyaltyAddressCannotBeZeroAddress(); } // Revert if the new basis points is greater than 10_000. if (newInfo.royaltyBps > 10_000) { revert InvalidRoyaltyBasisPoints(newInfo.royaltyBps); } // Set the new royalty info. _royaltyInfo = newInfo; // Emit an event with the updated params. emit RoyaltyInfoUpdated(newInfo.royaltyAddress, newInfo.royaltyBps); } /** * @notice Returns the base URI for token metadata. */ function baseURI() external view override returns (string memory) { return _baseURI(); } /** * @notice Returns the base URI for the contract, which ERC721A uses * to return tokenURI. */ function _baseURI() internal view virtual override returns (string memory) { return _tokenBaseURI; } /** * @notice Returns the contract URI for contract metadata. */ function contractURI() external view override returns (string memory) { return _contractURI; } /** * @notice Returns the max token supply. */ function maxSupply() public view returns (uint256) { return _maxSupply; } /** * @notice Returns the provenance hash. * The provenance hash is used for random reveals, which * is a hash of the ordered metadata to show it is unmodified * after mint has started. */ function provenanceHash() external view override returns (bytes32) { return _provenanceHash; } /** * @notice Returns the address that receives royalties. */ function royaltyAddress() external view returns (address) { return _royaltyInfo.royaltyAddress; } /** * @notice Returns the royalty basis points out of 10_000. */ function royaltyBasisPoints() external view returns (uint256) { return _royaltyInfo.royaltyBps; } /** * @notice Called with the sale price to determine how much royalty * is owed and to whom. * * @ param _tokenId The NFT asset queried for royalty information. * @param _salePrice The sale price of the NFT asset specified by * _tokenId. * * @return receiver Address of who should be sent the royalty payment. * @return royaltyAmount The royalty payment amount for _salePrice. */ function royaltyInfo( uint256, /* _tokenId */ uint256 _salePrice ) external view returns (address receiver, uint256 royaltyAmount) { // Put the royalty info on the stack for more efficient access. RoyaltyInfo storage info = _royaltyInfo; // Set the royalty amount to the sale price times the royalty basis // points divided by 10_000. royaltyAmount = (_salePrice * info.royaltyBps) / 10_000; // Set the receiver of the royalty. receiver = info.royaltyAddress; } /** * @notice Returns the transfer validation function used. */ function getTransferValidationFunction() external pure returns (bytes4 functionSignature, bool isViewFunction) { functionSignature = ITransferValidator721.validateTransfer.selector; isViewFunction = false; } /** * @notice Set the transfer validator. Only callable by the token owner. */ function setTransferValidator(address newValidator) external onlyOwner { // Set the new transfer validator. _setTransferValidator(newValidator); } /** * @dev Hook that is called before any token transfer. * This includes minting and burning. */ function _beforeTokenTransfers( address from, address to, uint256 startTokenId, uint256 /* quantity */ ) internal virtual override { if (from != address(0) && to != address(0)) { // Call the transfer validator if one is set. address transferValidator = _transferValidator; if (transferValidator != address(0)) { ITransferValidator721(transferValidator).validateTransfer( msg.sender, from, to, startTokenId ); } } } /** * @notice Returns whether the interface is supported. * * @param interfaceId The interface id to check against. */ function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC721ACloneable) returns (bool) { return interfaceId == type(IERC2981).interfaceId || interfaceId == type(ICreatorToken).interfaceId || interfaceId == type(ILegacyCreatorToken).interfaceId || interfaceId == 0x49064906 || // ERC-4906 super.supportsInterface(interfaceId); } /** * @dev Internal pure function to cast a `bool` value to a `uint256` value. * * @param b The `bool` value to cast. * * @return u The `uint256` value. */ function _cast(bool b) internal pure returns (uint256 u) { assembly { u := b } } } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; import { ISeaDropTokenContractMetadata } from "./ISeaDropTokenContractMetadata.sol"; import { AllowListData, PublicDrop, TokenGatedDropStage, SignedMintValidationParams } from "../lib/SeaDropStructs.sol"; interface INonFungibleSeaDropToken is ISeaDropTokenContractMetadata { /** * @dev Revert with an error if a contract is not an allowed * SeaDrop address. */ error OnlyAllowedSeaDrop(); /** * @dev Emit an event when allowed SeaDrop contracts are updated. */ event AllowedSeaDropUpdated(address[] allowedSeaDrop); /** * @notice Update the allowed SeaDrop contracts. * Only the owner can use this function. * * @param allowedSeaDrop The allowed SeaDrop addresses. */ function updateAllowedSeaDrop(address[] calldata allowedSeaDrop) external; /** * @notice Mint tokens, restricted to the SeaDrop contract. * * @dev NOTE: If a token registers itself with multiple SeaDrop * contracts, the implementation of this function should guard * against reentrancy. If the implementing token uses * _safeMint(), or a feeRecipient with a malicious receive() hook * is specified, the token or fee recipients may be able to execute * another mint in the same transaction via a separate SeaDrop * contract. * This is dangerous if an implementing token does not correctly * update the minterNumMinted and currentTotalSupply values before * transferring minted tokens, as SeaDrop references these values * to enforce token limits on a per-wallet and per-stage basis. * * @param minter The address to mint to. * @param quantity The number of tokens to mint. */ function mintSeaDrop(address minter, uint256 quantity) external; /** * @notice Returns a set of mint stats for the address. * This assists SeaDrop in enforcing maxSupply, * maxTotalMintableByWallet, and maxTokenSupplyForStage checks. * * @dev NOTE: Implementing contracts should always update these numbers * before transferring any tokens with _safeMint() to mitigate * consequences of malicious onERC721Received() hooks. * * @param minter The minter address. */ function getMintStats(address minter) external view returns ( uint256 minterNumMinted, uint256 currentTotalSupply, uint256 maxSupply ); /** * @notice Update the public drop data for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param publicDrop The public drop data. */ function updatePublicDrop( address seaDropImpl, PublicDrop calldata publicDrop ) external; /** * @notice Update the allow list data for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param allowListData The allow list data. */ function updateAllowList( address seaDropImpl, AllowListData calldata allowListData ) external; /** * @notice Update the token gated drop stage data for this nft contract * on SeaDrop. * Only the owner can use this function. * * Note: If two INonFungibleSeaDropToken tokens are doing * simultaneous token gated drop promotions for each other, * they can be minted by the same actor until * `maxTokenSupplyForStage` is reached. Please ensure the * `allowedNftToken` is not running an active drop during the * `dropStage` time period. * * * @param seaDropImpl The allowed SeaDrop contract. * @param allowedNftToken The allowed nft token. * @param dropStage The token gated drop stage data. */ function updateTokenGatedDrop( address seaDropImpl, address allowedNftToken, TokenGatedDropStage calldata dropStage ) external; /** * @notice Update the drop URI for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param dropURI The new drop URI. */ function updateDropURI(address seaDropImpl, string calldata dropURI) external; /** * @notice Update the creator payout address for this nft contract on * SeaDrop. * Only the owner can set the creator payout address. * * @param seaDropImpl The allowed SeaDrop contract. * @param payoutAddress The new payout address. */ function updateCreatorPayoutAddress( address seaDropImpl, address payoutAddress ) external; /** * @notice Update the allowed fee recipient for this nft contract * on SeaDrop. * * @param seaDropImpl The allowed SeaDrop contract. * @param feeRecipient The new fee recipient. */ function updateAllowedFeeRecipient( address seaDropImpl, address feeRecipient, bool allowed ) external; /** * @notice Update the server-side signers for this nft contract * on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param signer The signer to update. * @param signedMintValidationParams Minimum and maximum parameters * to enforce for signed mints. */ function updateSignedMintValidationParams( address seaDropImpl, address signer, SignedMintValidationParams memory signedMintValidationParams ) external; /** * @notice Update the allowed payers for this nft contract on SeaDrop. * Only the owner can use this function. * * @param seaDropImpl The allowed SeaDrop contract. * @param payer The payer to update. * @param allowed Whether the payer is allowed. */ function updatePayer( address seaDropImpl, address payer, bool allowed ) external; } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; import { IERC2981 } from "openzeppelin-contracts/interfaces/IERC2981.sol"; interface ISeaDropTokenContractMetadata is IERC2981 { /** * @notice Throw if the max supply exceeds uint64, a limit * due to the storage of bit-packed variables in ERC721A. */ error CannotExceedMaxSupplyOfUint64(uint256 newMaxSupply); /** * @dev Revert with an error when attempting to set the provenance * hash after the mint has started. */ error ProvenanceHashCannotBeSetAfterMintStarted(); /** * @dev Revert if the royalty basis points is greater than 10_000. */ error InvalidRoyaltyBasisPoints(uint256 basisPoints); /** * @dev Revert if the royalty address is being set to the zero address. */ error RoyaltyAddressCannotBeZeroAddress(); /** * @dev Emit an event for token metadata reveals/updates, * according to EIP-4906. * * @param _fromTokenId The start token id. * @param _toTokenId The end token id. */ event BatchMetadataUpdate(uint256 _fromTokenId, uint256 _toTokenId); /** * @dev Emit an event when the URI for the collection-level metadata * is updated. */ event ContractURIUpdated(string newContractURI); /** * @dev Emit an event when the max token supply is updated. */ event MaxSupplyUpdated(uint256 newMaxSupply); /** * @dev Emit an event with the previous and new provenance hash after * being updated. */ event ProvenanceHashUpdated(bytes32 previousHash, bytes32 newHash); /** * @dev Emit an event when the royalties info is updated. */ event RoyaltyInfoUpdated(address receiver, uint256 bps); /** * @notice A struct defining royalty info for the contract. */ struct RoyaltyInfo { address royaltyAddress; uint96 royaltyBps; } /** * @notice Sets the base URI for the token metadata and emits an event. * * @param tokenURI The new base URI to set. */ function setBaseURI(string calldata tokenURI) external; /** * @notice Sets the contract URI for contract metadata. * * @param newContractURI The new contract URI. */ function setContractURI(string calldata newContractURI) external; /** * @notice Sets the max supply and emits an event. * * @param newMaxSupply The new max supply to set. */ function setMaxSupply(uint256 newMaxSupply) external; /** * @notice Sets the provenance hash and emits an event. * * The provenance hash is used for random reveals, which * is a hash of the ordered metadata to show it has not been * modified after mint started. * * This function will revert after the first item has been minted. * * @param newProvenanceHash The new provenance hash to set. */ function setProvenanceHash(bytes32 newProvenanceHash) external; /** * @notice Sets the address and basis points for royalties. * * @param newInfo The struct to configure royalties. */ function setRoyaltyInfo(RoyaltyInfo calldata newInfo) external; /** * @notice Returns the base URI for token metadata. */ function baseURI() external view returns (string memory); /** * @notice Returns the contract URI. */ function contractURI() external view returns (string memory); /** * @notice Returns the max token supply. */ function maxSupply() external view returns (uint256); /** * @notice Returns the provenance hash. * The provenance hash is used for random reveals, which * is a hash of the ordered metadata to show it is unmodified * after mint has started. */ function provenanceHash() external view returns (bytes32); /** * @notice Returns the address that receives royalties. */ function royaltyAddress() external view returns (address); /** * @notice Returns the royalty basis points out of 10_000. */ function royaltyBasisPoints() external view returns (uint256); } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; import { ERC721SeaDropCloneable } from "./ERC721SeaDropCloneable.sol"; import { Clones } from "openzeppelin-contracts/proxy/Clones.sol"; contract ERC721SeaDropCloneFactory { address public immutable seaDropCloneableUpgradeableImplementation; address public constant DEFAULT_SEADROP = 0x00005EA00Ac477B1030CE78506496e8C2dE24bf5; constructor() { ERC721SeaDropCloneable impl = new ERC721SeaDropCloneable(); impl.initialize("", "", new address[](0), address(this)); seaDropCloneableUpgradeableImplementation = address(impl); } function createClone( string memory name, string memory symbol, bytes32 salt ) external returns (address) { // Derive a pseudo-random salt, so clone addresses don't collide // across chains. bytes32 cloneSalt = keccak256( abi.encodePacked(salt, blockhash(block.number)) ); address instance = Clones.cloneDeterministic( seaDropCloneableUpgradeableImplementation, cloneSalt ); address[] memory allowedSeaDrop = new address[](1); allowedSeaDrop[0] = DEFAULT_SEADROP; ERC721SeaDropCloneable(instance).initialize( name, symbol, allowedSeaDrop, msg.sender ); return instance; } } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; import { ERC721ACloneable } from "./ERC721ACloneable.sol"; /** * @title ERC721AConduitPreapprovedCloneable * @notice ERC721A with the OpenSea conduit preapproved. */ abstract contract ERC721AConduitPreapprovedCloneable is ERC721ACloneable { /// @dev The canonical OpenSea conduit. address internal constant _CONDUIT = 0x1E0049783F008A0085193E00003D00cd54003c71; /** * @dev Returns if the `operator` is allowed to manage all of the * assets of `owner`. Always returns true for the conduit. */ function isApprovedForAll(address owner, address operator) public view virtual override returns (bool) { if (operator == _CONDUIT) { return true; } return ERC721ACloneable.isApprovedForAll(owner, operator); } } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; interface ICreatorToken { event TransferValidatorUpdated(address oldValidator, address newValidator); function getTransferValidator() external view returns (address validator); function getTransferValidationFunction() external view returns (bytes4 functionSignature, bool isViewFunction); function setTransferValidator(address validator) external; } interface ILegacyCreatorToken { event TransferValidatorUpdated(address oldValidator, address newValidator); function getTransferValidator() external view returns (address validator); function setTransferValidator(address validator) external; } // SPDX-License-Identifier: MIT pragma solidity 0.8.17; interface ITransferValidator721 { /// @notice Ensure that a transfer has been authorized for a specific tokenId function validateTransfer( address caller, address from, address to, uint256 tokenId ) external view; } interface ITransferValidator1155 { /// @notice Ensure that a transfer has been authorized for a specific amount of a specific tokenId, and reduce the transferable amount remaining function validateTransfer( address caller, address from, address to, uint256 tokenId, uint256 amount ) external; }

Visual Contract Explorer

Contract Activity

Build smart contracts visually