Skip to main content

ERC1155DelayedReveal

BASE: ERC1155LazyMint EXTENSION: DelayedReveal The ERC1155DelayedReveal contract uses the DelayedReveal extension. '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. 'Delayed reveal' is a mechanism by which you can distribute NFTs to your audience and reveal the metadata of the distributed NFTs, after the fact. You can read more about how the DelayedReveal extension works, here: https://blog.thirdweb.com/delayed-reveal-nfts

Methods

balanceOf

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

Get the balance of an account's Tokens.

Parameters

NameTypeDescription
_0addressundefined
_1uint256undefined

Returns

NameTypeDescription
_0uint256undefined

balanceOfBatch

function balanceOfBatch(address[] accounts, uint256[] ids) external view returns (uint256[])

Parameters

NameTypeDescription
accountsaddress[]undefined
idsuint256[]undefined

Returns

NameTypeDescription
_0uint256[]undefined

burn

function burn(address _owner, uint256 _tokenId, uint256 _amount) external nonpayable

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

Parameters

NameTypeDescription
_owneraddressThe owner of the NFT to burn.
_tokenIduint256The tokenId of the NFT to burn.
_amountuint256The amount of the NFT to burn.

burnBatch

function burnBatch(address _owner, uint256[] _tokenIds, uint256[] _amounts) external nonpayable

Lets an owner or approved operator burn NFTs of the given tokenIds.

Parameters

NameTypeDescription
_owneraddressThe owner of the NFTs to burn.
_tokenIdsuint256[]The tokenIds of the NFTs to burn.
_amountsuint256[]The amounts of the NFTs to burn.

claim

function claim(address _receiver, uint256 _tokenId, 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 tokens to mint.
_tokenIduint256The tokenId of the lazy minted NFT to mint.
_quantityuint256The number of tokens to mint.

contractURI

function contractURI() external view returns (string)

Returns the contract metadata URI.

Returns

NameTypeDescription
_0stringundefined

encryptDecrypt

function encryptDecrypt(bytes data, bytes key) external pure returns (bytes result)

Encrypt/decrypt data on chain.

Encrypt/decrypt given data with key. Uses inline assembly. See: https://ethereum.stackexchange.com/questions/69825/decrypt-message-on-chain

Parameters

NameTypeDescription
databytesBytes of data to encrypt/decrypt.
keybytesSecure key used by caller for encryption/decryption.

Returns

NameTypeDescription
resultbytesOutput after encryption/decryption of given data.

encryptedData

function encryptedData(uint256) external view returns (bytes)

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0bytesundefined

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 defualt royalty recipient and BPS for this contract's NFTs.

Returns

NameTypeDescription
_0addressundefined
_1uint16undefined

getRevealURI

function getRevealURI(uint256 _batchId, bytes _key) external view returns (string revealedURI)

Returns revealed URI for a batch of NFTs.

Reveal encrypted base URI for _batchId with caller/admin's _key used for encryption. Reverts if there's no encrypted URI for _batchId. See {encryptDecrypt}.

Parameters

NameTypeDescription
_batchIduint256ID of the batch for which URI is being revealed.
_keybytesSecure key used by caller/admin for encryption of baseURI.

Returns

NameTypeDescription
revealedURIstringDecrypted base URI.

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, address) external view returns (bool)

Queries the approval status of an operator for a given owner.

Parameters

NameTypeDescription
_0addressundefined
_1addressundefined

Returns

NameTypeDescription
_0boolundefined

isEncryptedBatch

function isEncryptedBatch(uint256 _batchId) external view returns (bool)

Returns whether the relvant batch of NFTs is subject to a delayed reveal.

Returns true if _batchId's base URI is encrypted.

Parameters

NameTypeDescription
_batchIduint256ID of a batch of NFTs.

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 placeholder base URI for the 'n' number of NFTs being lazy minted, where the metadata for each of those NFTs is ${baseURIForTokens}/${tokenId}.
_databytesThe encrypted base URI + provenance hash for the batch of NFTs being lazy minted.

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)

Returns

NameTypeDescription
_0stringundefined

nextTokenIdToMint

function nextTokenIdToMint() external view returns (uint256)

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

Returns

NameTypeDescription
_0uint256undefined

owner

function owner() external view returns (address)

Returns the owner of the contract.

Returns

NameTypeDescription
_0addressundefined

reveal

function reveal(uint256 _index, bytes _key) external nonpayable returns (string revealedURI)

Lets an authorized address reveal a batch of delayed reveal NFTs.

Parameters

NameTypeDescription
_indexuint256The ID for the batch of delayed-reveal NFTs to reveal.
_keybytesThe key with which the base URI for the relevant batch of NFTs was encrypted.

Returns

NameTypeDescription
revealedURIstringundefined

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.

safeBatchTransferFrom

function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayable

Parameters

NameTypeDescription
fromaddressundefined
toaddressundefined
idsuint256[]undefined
amountsuint256[]undefined
databytesundefined

safeTransferFrom

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

Parameters

NameTypeDescription
fromaddressundefined
toaddressundefined
iduint256undefined
amountuint256undefined
databytesundefined

setApprovalForAll

function setApprovalForAll(address operator, bool approved) external nonpayable

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.

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)

Returns whether this contract supports the given interface.

Parameters

NameTypeDescription
interfaceIdbytes4undefined

Returns

NameTypeDescription
_0boolundefined

symbol

function symbol() external view returns (string)

Returns

NameTypeDescription
_0stringundefined

totalSupply

function totalSupply(uint256) external view returns (uint256)

Returns the total supply of NFTs of a given tokenId

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0uint256undefined

uri

function uri(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

verifyClaim

function verifyClaim(address _claimer, uint256 _tokenId, 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.
_tokenIduint256The tokenId of the lazy minted NFT to mint.
_quantityuint256The number of NFTs being claimed.

Events

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

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

TokenURIRevealed

event TokenURIRevealed(uint256 indexed index, string revealedURI)

Parameters

NameTypeDescription
index indexeduint256undefined
revealedURIstringundefined

TokensClaimed

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

Parameters

NameTypeDescription
claimer indexedaddressundefined
receiver indexedaddressundefined
tokenId indexeduint256undefined
quantityClaimeduint256undefined

TokensLazyMinted

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

Parameters

NameTypeDescription
startTokenId indexeduint256undefined
endTokenIduint256undefined
baseURIstringundefined
encryptedBaseURIbytesundefined

TransferBatch

event TransferBatch(address indexed _operator, address indexed _from, address indexed _to, uint256[] _ids, uint256[] _values)

Parameters

NameTypeDescription
_operator indexedaddressundefined
_from indexedaddressundefined
_to indexedaddressundefined
_idsuint256[]undefined
_valuesuint256[]undefined

TransferSingle

event TransferSingle(address indexed _operator, address indexed _from, address indexed _to, uint256 _id, uint256 _value)

Parameters

NameTypeDescription
_operator indexedaddressundefined
_from indexedaddressundefined
_to indexedaddressundefined
_iduint256undefined
_valueuint256undefined

URI

event URI(string _value, uint256 indexed _id)

Parameters

NameTypeDescription
_valuestringundefined
_id indexeduint256undefined