Skip to main content

ERC721LazyMint

BASE: ERC721A EXTENSION: LazyMint The ERC721LazyMint smart contract implements the ERC721 NFT standard, along with the ERC721A optimization to the standard. It includes the following additions to standard ERC721 logic: - Lazy minting - Contract metadata for royalty support on platforms such as OpenSea that use off-chain information to distribute royalties. - Ownership of the contract, with the ability to restrict certain functions to only be called by the contract's owner. - Multicall capability to perform multiple actions atomically - EIP 2981 compliance for royalty support on NFT marketplaces. 'Lazy minting' means defining the metadata of NFTs without minting it to an address. Regular 'minting' of NFTs means actually assigning an owner to an NFT. As a contract admin, this lets you prepare the metadata for NFTs that will be minted by an external party, without paying the gas cost for actually minting the NFTs.

Methods

OPERATOR_FILTER_REGISTRY

function OPERATOR_FILTER_REGISTRY() external view returns (contract IOperatorFilterRegistry)

Returns

NameTypeDescription
_0contract IOperatorFilterRegistryundefined

approve

function approve(address operator, uint256 tokenId) external nonpayable

See {ERC721-approve}.

Parameters

NameTypeDescription
operatoraddressundefined
tokenIduint256undefined

balanceOf

function balanceOf(address owner) external view returns (uint256)

See {IERC721-balanceOf}.

Parameters

NameTypeDescription
owneraddressundefined

Returns

NameTypeDescription
_0uint256undefined

burn

function burn(uint256 _tokenId) external nonpayable

Lets an owner or approved operator burn the NFT of the given tokenId.

ERC721A's _burn(uint256,bool) internally checks for token approvals.

Parameters

NameTypeDescription
_tokenIduint256The tokenId of the NFT to burn.

claim

function claim(address _receiver, uint256 _quantity) external payable

Lets an address claim multiple lazy minted NFTs at once to a recipient. This function prevents any reentrant calls, and is not allowed to be overridden. Contract creators should override verifyClaim and transferTokensOnClaim functions to create custom logic for verification and claiming, for e.g. price collection, allowlist, max quantity, etc.

The logic in verifyClaim determines whether the caller is authorized to mint NFTs. The logic in transferTokensOnClaim does actual minting of tokens, can also be used to apply other state changes.

Parameters

NameTypeDescription
_receiveraddressThe recipient of the NFT to mint.
_quantityuint256The number of NFTs to mint.

contractURI

function contractURI() external view returns (string)

Returns the contract metadata URI.

Returns

NameTypeDescription
_0stringundefined

getApproved

function getApproved(uint256 tokenId) external view returns (address)

See {IERC721-getApproved}.

Parameters

NameTypeDescription
tokenIduint256undefined

Returns

NameTypeDescription
_0addressundefined

getBaseURICount

function getBaseURICount() external view returns (uint256)

Returns the count of batches of NFTs.

Each batch of tokens has an in ID and an associated baseURI. See {batchIds}.

Returns

NameTypeDescription
_0uint256undefined

getBatchIdAtIndex

function getBatchIdAtIndex(uint256 _index) external view returns (uint256)

Returns the ID for the batch of tokens the given tokenId belongs to.

See {getBaseURICount}.

Parameters

NameTypeDescription
_indexuint256ID of a token.

Returns

NameTypeDescription
_0uint256undefined

getDefaultRoyaltyInfo

function getDefaultRoyaltyInfo() external view returns (address, uint16)

Returns the default royalty recipient and BPS for this contract's NFTs.

Returns

NameTypeDescription
_0addressundefined
_1uint16undefined

getRoyaltyInfoForToken

function getRoyaltyInfoForToken(uint256 _tokenId) external view returns (address, uint16)

View royalty info for a given token.

Returns royalty recipient and bps for _tokenId.

Parameters

NameTypeDescription
_tokenIduint256The tokenID of the NFT for which to query royalty info.

Returns

NameTypeDescription
_0addressundefined
_1uint16undefined

isApprovedForAll

function isApprovedForAll(address owner, address operator) external view returns (bool)

See {IERC721-isApprovedForAll}.

Parameters

NameTypeDescription
owneraddressundefined
operatoraddressundefined

Returns

NameTypeDescription
_0boolundefined

lazyMint

function lazyMint(uint256 _amount, string _baseURIForTokens, bytes _data) external nonpayable returns (uint256 batchId)

Lets an authorized address lazy mint a given amount of NFTs.

Parameters

NameTypeDescription
_amountuint256The number of NFTs to lazy mint.
_baseURIForTokensstringThe base URI for the 'n' number of NFTs being lazy minted, where the metadata for each of those NFTs is ${baseURIForTokens}/${tokenId}.
_databytesAdditional bytes data to be used at the discretion of the consumer of the contract.

Returns

NameTypeDescription
batchIduint256A unique integer identifier for the batch of NFTs lazy minted together.

multicall

function multicall(bytes[] data) external nonpayable returns (bytes[] results)

Receives and executes a batch of function calls on this contract.

Receives and executes a batch of function calls on this contract.

Parameters

NameTypeDescription
databytes[]The bytes data that makes up the batch of function calls to execute.

Returns

NameTypeDescription
resultsbytes[]The bytes data that makes up the result of the batch of function calls executed.

name

function name() external view returns (string)

See {IERC721Metadata-name}.

Returns

NameTypeDescription
_0stringundefined

nextTokenIdToClaim

function nextTokenIdToClaim() external view returns (uint256)

The tokenId assigned to the next new NFT to be claimed.

Returns

NameTypeDescription
_0uint256undefined

nextTokenIdToMint

function nextTokenIdToMint() external view returns (uint256)

The tokenId assigned to the next new NFT to be lazy minted.

Returns

NameTypeDescription
_0uint256undefined

operatorRestriction

function operatorRestriction() external view returns (bool)

Returns

NameTypeDescription
_0boolundefined

owner

function owner() external view returns (address)

Returns the owner of the contract.

Returns

NameTypeDescription
_0addressundefined

ownerOf

function ownerOf(uint256 tokenId) external view returns (address)

See {IERC721-ownerOf}.

Parameters

NameTypeDescription
tokenIduint256undefined

Returns

NameTypeDescription
_0addressundefined

royaltyInfo

function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount)

View royalty info for a given token and sale price.

Returns royalty amount and recipient for tokenId and salePrice.

Parameters

NameTypeDescription
tokenIduint256The tokenID of the NFT for which to query royalty info.
salePriceuint256Sale price of the token.

Returns

NameTypeDescription
receiveraddressAddress of royalty recipient account.
royaltyAmountuint256Royalty amount calculated at current royaltyBps value.

safeTransferFrom

function safeTransferFrom(address from, address to, uint256 tokenId) external nonpayable

See {ERC721-_safeTransferFrom}.

Parameters

NameTypeDescription
fromaddressundefined
toaddressundefined
tokenIduint256undefined

safeTransferFrom

function safeTransferFrom(address from, address to, uint256 tokenId, bytes data) external nonpayable

See {ERC721-_safeTransferFrom}.

Parameters

NameTypeDescription
fromaddressundefined
toaddressundefined
tokenIduint256undefined
databytesundefined

setApprovalForAll

function setApprovalForAll(address operator, bool approved) external nonpayable

See {ERC721-setApprovalForAll}.

Parameters

NameTypeDescription
operatoraddressundefined
approvedboolundefined

setContractURI

function setContractURI(string _uri) external nonpayable

Lets a contract admin set the URI for contract-level metadata.

Caller should be authorized to setup contractURI, e.g. contract admin. See {_canSetContractURI}. Emits {ContractURIUpdated Event}.

Parameters

NameTypeDescription
_uristringkeccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")

setDefaultRoyaltyInfo

function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external nonpayable

Updates default royalty recipient and bps.

Caller should be authorized to set royalty info. See {_canSetRoyaltyInfo}. Emits {DefaultRoyalty Event}; See {_setupDefaultRoyaltyInfo}.

Parameters

NameTypeDescription
_royaltyRecipientaddressAddress to be set as default royalty recipient.
_royaltyBpsuint256Updated royalty bps.

setOperatorRestriction

function setOperatorRestriction(bool _restriction) external nonpayable

Parameters

NameTypeDescription
_restrictionboolundefined

setOwner

function setOwner(address _newOwner) external nonpayable

Lets an authorized wallet set a new owner for the contract.

Parameters

NameTypeDescription
_newOwneraddressThe address to set as the new owner of the contract.

setRoyaltyInfoForToken

function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint256 _bps) external nonpayable

Updates default royalty recipient and bps for a particular token.

Sets royalty info for _tokenId. Caller should be authorized to set royalty info. See {_canSetRoyaltyInfo}. Emits {RoyaltyForToken Event}; See {_setupRoyaltyInfoForToken}.

Parameters

NameTypeDescription
_tokenIduint256undefined
_recipientaddressAddress to be set as royalty recipient for given token Id.
_bpsuint256Updated royalty bps for the token Id.

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

See ERC165: https://eips.ethereum.org/EIPS/eip-165

Parameters

NameTypeDescription
interfaceIdbytes4undefined

Returns

NameTypeDescription
_0boolundefined

symbol

function symbol() external view returns (string)

See {IERC721Metadata-symbol}.

Returns

NameTypeDescription
_0stringundefined

tokenURI

function tokenURI(uint256 _tokenId) external view returns (string)

Returns the metadata URI for an NFT.

See BatchMintMetadata for handling of metadata in this contract.

Parameters

NameTypeDescription
_tokenIduint256The tokenId of an NFT.

Returns

NameTypeDescription
_0stringundefined

totalSupply

function totalSupply() external view returns (uint256)

Burned tokens are calculated here, use _totalMinted() if you want to count just minted tokens.

Returns

NameTypeDescription
_0uint256undefined

transferFrom

function transferFrom(address from, address to, uint256 tokenId) external nonpayable

See {ERC721-_transferFrom}.

Parameters

NameTypeDescription
fromaddressundefined
toaddressundefined
tokenIduint256undefined

verifyClaim

function verifyClaim(address _claimer, uint256 _quantity) external view

Override this function to add logic for claim verification, based on conditions such as allowlist, price, max quantity etc.

Checks a request to claim NFTs against a custom condition.

Parameters

NameTypeDescription
_claimeraddressCaller of the claim function.
_quantityuint256The number of NFTs being claimed.

Events

Approval

event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId)

Parameters

NameTypeDescription
owner indexedaddressundefined
approved indexedaddressundefined
tokenId indexeduint256undefined

ApprovalForAll

event ApprovalForAll(address indexed owner, address indexed operator, bool approved)

Parameters

NameTypeDescription
owner indexedaddressundefined
operator indexedaddressundefined
approvedboolundefined

ContractURIUpdated

event ContractURIUpdated(string prevURI, string newURI)

Parameters

NameTypeDescription
prevURIstringundefined
newURIstringundefined

DefaultRoyalty

event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)

Parameters

NameTypeDescription
newRoyaltyRecipient indexedaddressundefined
newRoyaltyBpsuint256undefined

OperatorRestriction

event OperatorRestriction(bool restriction)

Parameters

NameTypeDescription
restrictionboolundefined

OwnerUpdated

event OwnerUpdated(address indexed prevOwner, address indexed newOwner)

Parameters

NameTypeDescription
prevOwner indexedaddressundefined
newOwner indexedaddressundefined

RoyaltyForToken

event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient, uint256 royaltyBps)

Parameters

NameTypeDescription
tokenId indexeduint256undefined
royaltyRecipient indexedaddressundefined
royaltyBpsuint256undefined

TokensClaimed

event TokensClaimed(address indexed claimer, address indexed receiver, uint256 indexed startTokenId, uint256 quantityClaimed)

Parameters

NameTypeDescription
claimer indexedaddressundefined
receiver indexedaddressundefined
startTokenId indexeduint256undefined
quantityClaimeduint256undefined

TokensLazyMinted

event TokensLazyMinted(uint256 indexed startTokenId, uint256 endTokenId, string baseURI, bytes encryptedBaseURI)

Parameters

NameTypeDescription
startTokenId indexeduint256undefined
endTokenIduint256undefined
baseURIstringundefined
encryptedBaseURIbytesundefined

Transfer

event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)

Parameters

NameTypeDescription
from indexedaddressundefined
to indexedaddressundefined
tokenId indexeduint256undefined

Errors

ApprovalCallerNotOwnerNorApproved

error ApprovalCallerNotOwnerNorApproved()

The caller must own the token or be an approved operator.

ApprovalQueryForNonexistentToken

error ApprovalQueryForNonexistentToken()

The token does not exist.

ApprovalToCurrentOwner

error ApprovalToCurrentOwner()

The caller cannot approve to the current owner.

ApproveToCaller

error ApproveToCaller()

The caller cannot approve to their own address.

BalanceQueryForZeroAddress

error BalanceQueryForZeroAddress()

Cannot query the balance for the zero address.

MintToZeroAddress

error MintToZeroAddress()

Cannot mint to the zero address.

MintZeroQuantity

error MintZeroQuantity()

The quantity of tokens minted must be more than zero.

OperatorNotAllowed

error OperatorNotAllowed(address operator)

Parameters

NameTypeDescription
operatoraddressundefined

OwnerQueryForNonexistentToken

error OwnerQueryForNonexistentToken()

The token does not exist.

TransferCallerNotOwnerNorApproved

error TransferCallerNotOwnerNorApproved()

The caller must own the token or be an approved operator.

TransferFromIncorrectOwner

error TransferFromIncorrectOwner()

The token must be owned by from.

TransferToNonERC721ReceiverImplementer

error TransferToNonERC721ReceiverImplementer()

Cannot safely transfer to a contract that does not implement the ERC721Receiver interface.

TransferToZeroAddress

error TransferToZeroAddress()

Cannot transfer to the zero address.

URIQueryForNonexistentToken

error URIQueryForNonexistentToken()

The token does not exist.