TieredDrop
Methods
DEFAULT_ADMIN_ROLE
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)Returns
_0
bytes32
undefined
approve
function approve(address to, uint256 tokenId) external nonpayableSee {IERC721-approve}.
Parameters
to
address
undefined
tokenId
uint256
undefined
balanceOf
function balanceOf(address owner) external view returns (uint256)See {IERC721-balanceOf}.
Parameters
owner
address
undefined
Returns
_0
uint256
undefined
burn
function burn(uint256 tokenId) external nonpayableBurns tokenId. See {ERC721-_burn}.
Parameters
tokenId
uint256
undefined
claimWithSignature
function claimWithSignature(ISignatureAction.GenericRequest _req, bytes _signature) external payable returns (address signer)Parameters
_req
ISignatureAction.GenericRequest
undefined
_signature
bytes
undefined
Returns
signer
address
undefined
contractURI
function contractURI() external view returns (string)Returns the contract metadata URI.
Returns
_0
string
undefined
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
data
bytes
Bytes of data to encrypt/decrypt.
key
bytes
Secure key used by caller for encryption/decryption.
Returns
result
bytes
Output after encryption/decryption of given data.
encryptedData
function encryptedData(uint256) external view returns (bytes)Parameters
_0
uint256
undefined
Returns
_0
bytes
undefined
getApproved
function getApproved(uint256 tokenId) external view returns (address)See {IERC721-getApproved}.
Parameters
tokenId
uint256
undefined
Returns
_0
address
undefined
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
_0
uint256
undefined
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
_index
uint256
ID of a token.
Returns
_0
uint256
undefined
getDefaultRoyaltyInfo
function getDefaultRoyaltyInfo() external view returns (address, uint16)Returns the defualt royalty recipient and BPS for this contract's NFTs.
Returns
_0
address
undefined
_1
uint16
undefined
getMetadataForAllTiers
function getMetadataForAllTiers() external view returns (struct LazyMintWithTier.TierMetadata[] metadataForAllTiers)Returns all metadata for all tiers created on the contract.
Returns
metadataForAllTiers
LazyMintWithTier.TierMetadata[]
undefined
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
_batchId
uint256
ID of the batch for which URI is being revealed.
_key
bytes
Secure key used by caller/admin for encryption of baseURI.
Returns
revealedURI
string
Decrypted base URI.
getRoleAdmin
function getRoleAdmin(bytes32 role) external view returns (bytes32)Returns the admin role that controls the specified role.
See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
Returns
_0
bytes32
undefined
getRoleMember
function getRoleMember(bytes32 role, uint256 index) external view returns (address member)Returns the role-member from a list of members for a role, at a given index.
Returns member who has role, at index of role-members list. See struct {RoleMembers}, and mapping {roleMembers}
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
index
uint256
Index in list of current members for the role.
Returns
member
address
Address of account that has role
getRoleMemberCount
function getRoleMemberCount(bytes32 role) external view returns (uint256 count)Returns total number of accounts that have a role.
Returns count of accounts that have role. See struct {RoleMembers}, and mapping {roleMembers}
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
Returns
count
uint256
Total number of accounts that have role
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
_tokenId
uint256
The tokenID of the NFT for which to query royalty info.
Returns
_0
address
undefined
_1
uint16
undefined
getTierForToken
function getTierForToken(uint256 _tokenId) external view returns (string)Returns the tier that the given token is associated with.
Parameters
_tokenId
uint256
undefined
Returns
_0
string
undefined
getTokensInTier
function getTokensInTier(string _tier, uint256 _startIdx, uint256 _endIdx) external view returns (struct LazyMintWithTier.TokenRange[] ranges)Returns all tokenIds that belong to the given tier.
Parameters
_tier
string
undefined
_startIdx
uint256
undefined
_endIdx
uint256
undefined
Returns
ranges
LazyMintWithTier.TokenRange[]
undefined
getTokensInTierLen
function getTokensInTierLen() external view returns (uint256)Returns the max endIndex that can be used with getTokensInTier.
Returns
_0
uint256
undefined
grantRole
function grantRole(bytes32 role, address account) external nonpayableGrants a role to an account, if not previously granted.
Caller must have admin role for the role. Emits {RoleGranted Event}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account to which the role is being granted.
hasRole
function hasRole(bytes32 role, address account) external view returns (bool)Checks whether an account has a particular role.
Returns true if account has been granted role.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account for which the role is being checked.
Returns
_0
bool
undefined
hasRoleWithSwitch
function hasRoleWithSwitch(bytes32 role, address account) external view returns (bool)Checks whether an account has a particular role; role restrictions can be swtiched on and off.
Returns true if account has been granted role. Role restrictions can be swtiched on and off: - If address(0) has ROLE, then the ROLE restrictions don't apply. - If address(0) does not have ROLE, then the ROLE restrictions will apply.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account for which the role is being checked.
Returns
_0
bool
undefined
initialize
function initialize(address _defaultAdmin, string _name, string _symbol, string _contractURI, address[] _trustedForwarders, address _saleRecipient, address _royaltyRecipient, uint16 _royaltyBps) external nonpayableInitiliazes the contract, like a constructor.
Parameters
_defaultAdmin
address
undefined
_name
string
undefined
_symbol
string
undefined
_contractURI
string
undefined
_trustedForwarders
address[]
undefined
_saleRecipient
address
undefined
_royaltyRecipient
address
undefined
_royaltyBps
uint16
undefined
isApprovedForAll
function isApprovedForAll(address owner, address operator) external view returns (bool)See {IERC721-isApprovedForAll}.
Parameters
owner
address
undefined
operator
address
undefined
Returns
_0
bool
undefined
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
_batchId
uint256
ID of a batch of NFTs.
Returns
_0
bool
undefined
isTrustedForwarder
function isTrustedForwarder(address forwarder) external view returns (bool)Parameters
forwarder
address
undefined
Returns
_0
bool
undefined
lazyMint
function lazyMint(uint256 _amount, string _baseURIForTokens, string _tier, bytes _data) external nonpayable returns (uint256 batchId)Lets an authorized address lazy mint a given amount of NFTs.
Parameters
_amount
uint256
The number of NFTs to lazy mint.
_baseURIForTokens
string
The base URI for the 'n' number of NFTs being lazy minted, where the metadata for each of those NFTs is ${baseURIForTokens}/${tokenId}.
_tier
string
undefined
_data
bytes
Additional bytes data to be used at the discretion of the consumer of the contract.
Returns
batchId
uint256
A 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.
Parameters
data
bytes[]
undefined
Returns
results
bytes[]
undefined
name
function name() external view returns (string)See {IERC721Metadata-name}.
Returns
_0
string
undefined
nextTokenIdToMint
function nextTokenIdToMint() external view returns (uint256)The tokenId of the next NFT that will be minted / lazy minted.
Returns
_0
uint256
undefined
owner
function owner() external view returns (address)Returns the owner of the contract.
Returns
_0
address
undefined
ownerOf
function ownerOf(uint256 tokenId) external view returns (address)See {IERC721-ownerOf}.
Parameters
tokenId
uint256
undefined
Returns
_0
address
undefined
primarySaleRecipient
function primarySaleRecipient() external view returns (address)Returns primary sale recipient address.
Returns
_0
address
undefined
renounceRole
function renounceRole(bytes32 role, address account) external nonpayableRevokes role from the account.
Caller must have the role, with caller being the same as account. Emits {RoleRevoked Event}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account from which the role is being revoked.
reveal
function reveal(uint256 _index, bytes _key) external nonpayable returns (string revealedURI)Lets an account with MINTER_ROLE reveal the URI for a batch of 'delayed-reveal' NFTs.
Parameters
_index
uint256
undefined
_key
bytes
undefined
Returns
revealedURI
string
undefined
revokeRole
function revokeRole(bytes32 role, address account) external nonpayableRevokes role from an account.
Caller must have admin role for the role. Emits {RoleRevoked Event}.
Parameters
role
bytes32
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
account
address
Address of the account from which the role is being revoked.
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
tokenId
uint256
The tokenID of the NFT for which to query royalty info.
salePrice
uint256
Sale price of the token.
Returns
receiver
address
Address of royalty recipient account.
royaltyAmount
uint256
Royalty amount calculated at current royaltyBps value.
safeTransferFrom
function safeTransferFrom(address from, address to, uint256 tokenId) external nonpayableSee {IERC721-safeTransferFrom}.
Parameters
from
address
undefined
to
address
undefined
tokenId
uint256
undefined
safeTransferFrom
function safeTransferFrom(address from, address to, uint256 tokenId, bytes _data) external nonpayableSee {IERC721-safeTransferFrom}.
Parameters
from
address
undefined
to
address
undefined
tokenId
uint256
undefined
_data
bytes
undefined
setApprovalForAll
function setApprovalForAll(address operator, bool approved) external nonpayableSee {IERC721-setApprovalForAll}.
Parameters
operator
address
undefined
approved
bool
undefined
setContractURI
function setContractURI(string _uri) external nonpayableLets 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
_uri
string
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
setDefaultRoyaltyInfo
function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external nonpayableUpdates default royalty recipient and bps.
Caller should be authorized to set royalty info. See {_canSetRoyaltyInfo}. Emits {DefaultRoyalty Event}; See {_setupDefaultRoyaltyInfo}.
Parameters
_royaltyRecipient
address
Address to be set as default royalty recipient.
_royaltyBps
uint256
Updated royalty bps.
setOwner
function setOwner(address _newOwner) external nonpayableLets an authorized wallet set a new owner for the contract.
Parameters
_newOwner
address
The address to set as the new owner of the contract.
setPrimarySaleRecipient
function setPrimarySaleRecipient(address _saleRecipient) external nonpayableUpdates primary sale recipient.
Caller should be authorized to set primary sales info. See {_canSetPrimarySaleRecipient}. Emits {PrimarySaleRecipientUpdated Event}; See {_setupPrimarySaleRecipient}.
Parameters
_saleRecipient
address
Address to be set as new recipient of primary sales.
setRoyaltyInfoForToken
function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint256 _bps) external nonpayableUpdates 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
_tokenId
uint256
undefined
_recipient
address
Address to be set as royalty recipient for given token Id.
_bps
uint256
Updated royalty bps for the token Id.
supportsInterface
function supportsInterface(bytes4 interfaceId) external view returns (bool)See ERC 165
Parameters
interfaceId
bytes4
undefined
Returns
_0
bool
undefined
symbol
function symbol() external view returns (string)See {IERC721Metadata-symbol}.
Returns
_0
string
undefined
tokenURI
function tokenURI(uint256 _tokenId) external view returns (string)Returns the URI for a given tokenId.
Parameters
_tokenId
uint256
undefined
Returns
_0
string
undefined
totalMinted
function totalMinted() external view returns (uint256)Returns the total amount of tokens minted in the contract.
Returns
_0
uint256
undefined
totalMintedInTier
function totalMintedInTier(string _tier) external view returns (uint256)Returns the total number of tokens minted from the given tier.
Parameters
_tier
string
undefined
Returns
_0
uint256
undefined
totalSupply
function totalSupply() external view returns (uint256)Burned tokens are calculated here, use _totalMinted() if you want to count just minted tokens.
Returns
_0
uint256
undefined
transferFrom
function transferFrom(address from, address to, uint256 tokenId) external nonpayableSee {IERC721-transferFrom}.
Parameters
from
address
undefined
to
address
undefined
tokenId
uint256
undefined
verify
function verify(ISignatureAction.GenericRequest _req, bytes _signature) external view returns (bool success, address signer)Parameters
_req
ISignatureAction.GenericRequest
undefined
_signature
bytes
undefined
Returns
success
bool
undefined
signer
address
undefined
Events
Approval
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId)Parameters
owner indexed
address
undefined
approved indexed
address
undefined
tokenId indexed
uint256
undefined
ApprovalForAll
event ApprovalForAll(address indexed owner, address indexed operator, bool approved)Parameters
owner indexed
address
undefined
operator indexed
address
undefined
approved
bool
undefined
ContractURIUpdated
event ContractURIUpdated(string prevURI, string newURI)Parameters
prevURI
string
undefined
newURI
string
undefined
DefaultRoyalty
event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)Parameters
newRoyaltyRecipient indexed
address
undefined
newRoyaltyBps
uint256
undefined
Initialized
event Initialized(uint8 version)Parameters
version
uint8
undefined
OwnerUpdated
event OwnerUpdated(address indexed prevOwner, address indexed newOwner)Parameters
prevOwner indexed
address
undefined
newOwner indexed
address
undefined
PrimarySaleRecipientUpdated
event PrimarySaleRecipientUpdated(address indexed recipient)Parameters
recipient indexed
address
undefined
RequestExecuted
event RequestExecuted(address indexed user, address indexed signer, ISignatureAction.GenericRequest _req)Emitted when a payload is verified and executed.
Parameters
user indexed
address
undefined
signer indexed
address
undefined
_req
ISignatureAction.GenericRequest
undefined
RoleAdminChanged
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)Parameters
role indexed
bytes32
undefined
previousAdminRole indexed
bytes32
undefined
newAdminRole indexed
bytes32
undefined
RoleGranted
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)Parameters
role indexed
bytes32
undefined
account indexed
address
undefined
sender indexed
address
undefined
RoleRevoked
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)Parameters
role indexed
bytes32
undefined
account indexed
address
undefined
sender indexed
address
undefined
RoyaltyForToken
event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient, uint256 royaltyBps)Parameters
tokenId indexed
uint256
undefined
royaltyRecipient indexed
address
undefined
royaltyBps
uint256
undefined
TokenURIRevealed
event TokenURIRevealed(uint256 indexed index, string revealedURI)Parameters
index indexed
uint256
undefined
revealedURI
string
undefined
TokensClaimed
event TokensClaimed(address indexed claimer, address indexed receiver, uint256 startTokenId, uint256 quantityClaimed, string[] tiersInPriority)Emitted when tokens are claimed via claimWithSignature.
Parameters
claimer indexed
address
undefined
receiver indexed
address
undefined
startTokenId
uint256
undefined
quantityClaimed
uint256
undefined
tiersInPriority
string[]
undefined
TokensLazyMinted
event TokensLazyMinted(string indexed tier, uint256 indexed startTokenId, uint256 endTokenId, string baseURI, bytes encryptedBaseURI)Parameters
tier indexed
string
undefined
startTokenId indexed
uint256
undefined
endTokenId
uint256
undefined
baseURI
string
undefined
encryptedBaseURI
bytes
undefined
Transfer
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)Parameters
from indexed
address
undefined
to indexed
address
undefined
tokenId indexed
uint256
undefined
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.
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.
Last updated