DropERC721

Methods

DEFAULT_ADMIN_ROLE

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

Name
Type
Description

_0

bytes32

undefined

approve

function approve(address operator, uint256 tokenId) external nonpayable

See {ERC721-approve}.

Parameters

Name
Type
Description

operator

address

undefined

tokenId

uint256

undefined

balanceOf

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

See {IERC721-balanceOf}.

Parameters

Name
Type
Description

owner

address

undefined

Returns

Name
Type
Description

_0

uint256

undefined

burn

Burns tokenId. See {ERC721-_burn}.

Parameters

Name
Type
Description

tokenId

uint256

undefined

claim

Parameters

Name
Type
Description

_receiver

address

undefined

_quantity

uint256

undefined

_currency

address

undefined

_pricePerToken

uint256

undefined

_allowlistProof

IDrop.AllowlistProof

undefined

_data

bytes

undefined

claimCondition

Returns

Name
Type
Description

currentStartId

uint256

undefined

count

uint256

undefined

contractType

Returns

Name
Type
Description

_0

bytes32

undefined

contractURI

Returns the contract metadata URI.

Returns

Name
Type
Description

_0

string

undefined

contractVersion

Returns

Name
Type
Description

_0

uint8

undefined

encryptDecrypt

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

Name
Type
Description

data

bytes

Bytes of data to encrypt/decrypt.

key

bytes

Secure key used by caller for encryption/decryption.

Returns

Name
Type
Description

result

bytes

Output after encryption/decryption of given data.

encryptedData

Parameters

Name
Type
Description

_0

uint256

undefined

Returns

Name
Type
Description

_0

bytes

undefined

getActiveClaimConditionId

At any given moment, returns the uid for the active claim condition.

Returns

Name
Type
Description

_0

uint256

undefined

getApproved

See {IERC721-getApproved}.

Parameters

Name
Type
Description

tokenId

uint256

undefined

Returns

Name
Type
Description

_0

address

undefined

getBaseURICount

Returns the count of batches of NFTs.

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

Returns

Name
Type
Description

_0

uint256

undefined

getBatchIdAtIndex

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

See {getBaseURICount}.

Parameters

Name
Type
Description

_index

uint256

ID of a token.

Returns

Name
Type
Description

_0

uint256

undefined

getClaimConditionById

Returns the claim condition at the given uid.

Parameters

Name
Type
Description

_conditionId

uint256

undefined

Returns

Name
Type
Description

condition

IClaimCondition.ClaimCondition

undefined

getDefaultRoyaltyInfo

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

Returns

Name
Type
Description

_0

address

undefined

_1

uint16

undefined

getPlatformFeeInfo

Returns the platform fee recipient and bps.

Returns

Name
Type
Description

_0

address

undefined

_1

uint16

undefined

getRevealURI

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

Name
Type
Description

_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

Name
Type
Description

revealedURI

string

Decrypted base URI.

getRoleAdmin

Returns the admin role that controls the specified role.

See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.

Parameters

Name
Type
Description

role

bytes32

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

Returns

Name
Type
Description

_0

bytes32

undefined

getRoleMember

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

Name
Type
Description

role

bytes32

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

index

uint256

Index in list of current members for the role.

Returns

Name
Type
Description

member

address

Address of account that has role

getRoleMemberCount

Returns total number of accounts that have a role.

Returns count of accounts that have role. See struct {RoleMembers}, and mapping {roleMembers}

Parameters

Name
Type
Description

role

bytes32

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

Returns

Name
Type
Description

count

uint256

Total number of accounts that have role

getRoyaltyInfoForToken

View royalty info for a given token.

Returns royalty recipient and bps for _tokenId.

Parameters

Name
Type
Description

_tokenId

uint256

The tokenID of the NFT for which to query royalty info.

Returns

Name
Type
Description

_0

address

undefined

_1

uint16

undefined

getSupplyClaimedByWallet

Returns the supply claimed by claimer for a given conditionId.

Parameters

Name
Type
Description

_conditionId

uint256

undefined

_claimer

address

undefined

Returns

Name
Type
Description

supplyClaimedByWallet

uint256

undefined

grantRole

Grants a role to an account, if not previously granted.

Caller must have admin role for the role. Emits {RoleGranted Event}.

Parameters

Name
Type
Description

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

Checks whether an account has a particular role.

Returns true if account has been granted role.

Parameters

Name
Type
Description

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

Name
Type
Description

_0

bool

undefined

hasRoleWithSwitch

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

Name
Type
Description

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

Name
Type
Description

_0

bool

undefined

initialize

Initiliazes the contract, like a constructor.

Parameters

Name
Type
Description

_defaultAdmin

address

undefined

_name

string

undefined

_symbol

string

undefined

_contractURI

string

undefined

_trustedForwarders

address[]

undefined

_saleRecipient

address

undefined

_royaltyRecipient

address

undefined

_royaltyBps

uint128

undefined

_platformFeeBps

uint128

undefined

_platformFeeRecipient

address

undefined

isApprovedForAll

See {IERC721-isApprovedForAll}.

Parameters

Name
Type
Description

owner

address

undefined

operator

address

undefined

Returns

Name
Type
Description

_0

bool

undefined

isEncryptedBatch

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

Returns true if _batchId's base URI is encrypted.

Parameters

Name
Type
Description

_batchId

uint256

ID of a batch of NFTs.

Returns

Name
Type
Description

_0

bool

undefined

isTrustedForwarder

Parameters

Name
Type
Description

forwarder

address

undefined

Returns

Name
Type
Description

_0

bool

undefined

lazyMint

Lets an account with MINTER_ROLE lazy mint 'n' NFTs. The URIs for each token is the provided _baseURIForTokens + {tokenId}.

Parameters

Name
Type
Description

_amount

uint256

undefined

_baseURIForTokens

string

undefined

_data

bytes

undefined

Returns

Name
Type
Description

batchId

uint256

undefined

maxTotalSupply

Global max total supply of NFTs.

Returns

Name
Type
Description

_0

uint256

undefined

multicall

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

Parameters

Name
Type
Description

data

bytes[]

undefined

Returns

Name
Type
Description

results

bytes[]

undefined

name

See {IERC721Metadata-name}.

Returns

Name
Type
Description

_0

string

undefined

nextTokenIdToClaim

The next token ID of the NFT that can be claimed.

Returns

Name
Type
Description

_0

uint256

undefined

nextTokenIdToMint

The tokenId of the next NFT that will be minted / lazy minted.

Returns

Name
Type
Description

_0

uint256

undefined

operatorRestriction

Returns

Name
Type
Description

_0

bool

undefined

owner

Returns the owner of the contract.

Returns

Name
Type
Description

_0

address

undefined

ownerOf

See {IERC721-ownerOf}.

Parameters

Name
Type
Description

tokenId

uint256

undefined

Returns

Name
Type
Description

_0

address

undefined

primarySaleRecipient

Returns primary sale recipient address.

Returns

Name
Type
Description

_0

address

undefined

renounceRole

Revokes role from the account.

Caller must have the role, with caller being the same as account. Emits {RoleRevoked Event}.

Parameters

Name
Type
Description

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

Lets an account with MINTER_ROLE reveal the URI for a batch of 'delayed-reveal' NFTs.

Parameters

Name
Type
Description

_index

uint256

undefined

_key

bytes

undefined

Returns

Name
Type
Description

revealedURI

string

undefined

revokeRole

Revokes role from an account.

Caller must have admin role for the role. Emits {RoleRevoked Event}.

Parameters

Name
Type
Description

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

View royalty info for a given token and sale price.

Returns royalty amount and recipient for tokenId and salePrice.

Parameters

Name
Type
Description

tokenId

uint256

The tokenID of the NFT for which to query royalty info.

salePrice

uint256

Sale price of the token.

Returns

Name
Type
Description

receiver

address

Address of royalty recipient account.

royaltyAmount

uint256

Royalty amount calculated at current royaltyBps value.

safeTransferFrom

See {ERC721-_safeTransferFrom}.

Parameters

Name
Type
Description

from

address

undefined

to

address

undefined

tokenId

uint256

undefined

safeTransferFrom

See {ERC721-_safeTransferFrom}.

Parameters

Name
Type
Description

from

address

undefined

to

address

undefined

tokenId

uint256

undefined

data

bytes

undefined

setApprovalForAll

See {ERC721-setApprovalForAll}.

Parameters

Name
Type
Description

operator

address

undefined

approved

bool

undefined

setClaimConditions

Parameters

Name
Type
Description

_conditions

IClaimCondition.ClaimCondition[]

undefined

_resetClaimEligibility

bool

undefined

setContractURI

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

Name
Type
Description

_uri

string

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

setDefaultRoyaltyInfo

Updates default royalty recipient and bps.

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

Parameters

Name
Type
Description

_royaltyRecipient

address

Address to be set as default royalty recipient.

_royaltyBps

uint256

Updated royalty bps.

setMaxTotalSupply

Lets a contract admin set the global maximum supply for collection's NFTs.

Parameters

Name
Type
Description

_maxTotalSupply

uint256

undefined

setOperatorRestriction

Parameters

Name
Type
Description

_restriction

bool

undefined

setOwner

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

Parameters

Name
Type
Description

_newOwner

address

The address to set as the new owner of the contract.

setPlatformFeeInfo

Updates the platform fee recipient and bps.

Caller should be authorized to set platform fee info. See {_canSetPlatformFeeInfo}. Emits {PlatformFeeInfoUpdated Event}; See {_setupPlatformFeeInfo}.

Parameters

Name
Type
Description

_platformFeeRecipient

address

Address to be set as new platformFeeRecipient.

_platformFeeBps

uint256

Updated platformFeeBps.

setPrimarySaleRecipient

Updates primary sale recipient.

Caller should be authorized to set primary sales info. See {_canSetPrimarySaleRecipient}. Emits {PrimarySaleRecipientUpdated Event}; See {_setupPrimarySaleRecipient}.

Parameters

Name
Type
Description

_saleRecipient

address

Address to be set as new recipient of primary sales.

setRoyaltyInfoForToken

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

Name
Type
Description

_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

See ERC 165

Parameters

Name
Type
Description

interfaceId

bytes4

undefined

Returns

Name
Type
Description

_0

bool

undefined

symbol

See {IERC721Metadata-symbol}.

Returns

Name
Type
Description

_0

string

undefined

tokenURI

Returns the URI for a given tokenId.

Parameters

Name
Type
Description

_tokenId

uint256

undefined

Returns

Name
Type
Description

_0

string

undefined

totalMinted

Returns the total amount of tokens minted in the contract.

Returns

Name
Type
Description

_0

uint256

undefined

totalSupply

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

Returns

Name
Type
Description

_0

uint256

undefined

transferFrom

See {ERC721-_transferFrom}.

Parameters

Name
Type
Description

from

address

undefined

to

address

undefined

tokenId

uint256

undefined

verifyClaim

Parameters

Name
Type
Description

_conditionId

uint256

undefined

_claimer

address

undefined

_quantity

uint256

undefined

_currency

address

undefined

_pricePerToken

uint256

undefined

_allowlistProof

IDrop.AllowlistProof

undefined

Returns

Name
Type
Description

isOverride

bool

undefined

Events

Approval

Parameters

Name
Type
Description

owner indexed

address

undefined

approved indexed

address

undefined

tokenId indexed

uint256

undefined

ApprovalForAll

Parameters

Name
Type
Description

owner indexed

address

undefined

operator indexed

address

undefined

approved

bool

undefined

ClaimConditionsUpdated

Emitted when the contract's claim conditions are updated.

Parameters

Name
Type
Description

claimConditions

IClaimCondition.ClaimCondition[]

undefined

resetEligibility

bool

undefined

ContractURIUpdated

Parameters

Name
Type
Description

prevURI

string

undefined

newURI

string

undefined

DefaultRoyalty

Parameters

Name
Type
Description

newRoyaltyRecipient indexed

address

undefined

newRoyaltyBps

uint256

undefined

Initialized

Parameters

Name
Type
Description

version

uint8

undefined

MaxTotalSupplyUpdated

Emitted when the global max supply of tokens is updated.

Parameters

Name
Type
Description

maxTotalSupply

uint256

undefined

OperatorRestriction

Parameters

Name
Type
Description

restriction

bool

undefined

OwnerUpdated

Parameters

Name
Type
Description

prevOwner indexed

address

undefined

newOwner indexed

address

undefined

PlatformFeeInfoUpdated

Parameters

Name
Type
Description

platformFeeRecipient indexed

address

undefined

platformFeeBps

uint256

undefined

PrimarySaleRecipientUpdated

Parameters

Name
Type
Description

recipient indexed

address

undefined

RoleAdminChanged

Parameters

Name
Type
Description

role indexed

bytes32

undefined

previousAdminRole indexed

bytes32

undefined

newAdminRole indexed

bytes32

undefined

RoleGranted

Parameters

Name
Type
Description

role indexed

bytes32

undefined

account indexed

address

undefined

sender indexed

address

undefined

RoleRevoked

Parameters

Name
Type
Description

role indexed

bytes32

undefined

account indexed

address

undefined

sender indexed

address

undefined

RoyaltyForToken

Parameters

Name
Type
Description

tokenId indexed

uint256

undefined

royaltyRecipient indexed

address

undefined

royaltyBps

uint256

undefined

TokenURIRevealed

Parameters

Name
Type
Description

index indexed

uint256

undefined

revealedURI

string

undefined

TokensClaimed

Emitted when tokens are claimed via claim.

Parameters

Name
Type
Description

claimConditionIndex indexed

uint256

undefined

claimer indexed

address

undefined

receiver indexed

address

undefined

startTokenId

uint256

undefined

quantityClaimed

uint256

undefined

TokensLazyMinted

Parameters

Name
Type
Description

startTokenId indexed

uint256

undefined

endTokenId

uint256

undefined

baseURI

string

undefined

encryptedBaseURI

bytes

undefined

Transfer

Parameters

Name
Type
Description

from indexed

address

undefined

to indexed

address

undefined

tokenId indexed

uint256

undefined

Errors

ApprovalCallerNotOwnerNorApproved

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

ApprovalQueryForNonexistentToken

The token does not exist.

ApprovalToCurrentOwner

The caller cannot approve to the current owner.

ApproveToCaller

The caller cannot approve to their own address.

BalanceQueryForZeroAddress

Cannot query the balance for the zero address.

MintToZeroAddress

Cannot mint to the zero address.

MintZeroQuantity

The quantity of tokens minted must be more than zero.

OperatorNotAllowed

Parameters

Name
Type
Description

operator

address

undefined

OwnerQueryForNonexistentToken

The token does not exist.

TransferCallerNotOwnerNorApproved

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

TransferFromIncorrectOwner

The token must be owned by from.

TransferToNonERC721ReceiverImplementer

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

TransferToZeroAddress

Cannot transfer to the zero address.

URIQueryForNonexistentToken

The token does not exist.

Last updated