ERC1155Drop

BASE: ERC1155Base EXTENSION: SignatureMintERC1155, DropSinglePhase1155 The ERC1155Drop contract uses the ERC1155Base contract, along with the SignatureMintERC1155 and DropSinglePhase1155 extension. The 'signature minting' mechanism in the SignatureMintERC1155 extension is a way for a contract admin to authorize an external party's request to mint tokens on the admin's contract. At a high level, this means you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party. The drop mechanism in the DropSinglePhase1155 extension is a distribution mechanism for lazy minted tokens. It lets you set restrictions such as a price to charge, an allowlist etc. when an address atttempts to mint lazy minted tokens. The ERC721Drop contract lets you lazy mint tokens, and distribute those lazy minted tokens via signature minting, or via the drop mechanism.

Methods

balanceOf

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

Get the balance of an account's Tokens.

Parameters

Name	Type	Description
_0	address	undefined
_1	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

balanceOfBatch

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

Parameters

Name	Type	Description
accounts	address[]	undefined
ids	uint256[]	undefined

Returns

Name	Type	Description
_0	uint256[]	undefined

batchMintTo

function batchMintTo(address _to, uint256[] _tokenIds, uint256[] _amounts, string _baseURI) external nonpayable

Lets an authorized address mint multiple NEW NFTs at once to a recipient.

The logic in the _canMint function determines whether the caller is authorized to mint NFTs. If _tokenIds[i] == type(uint256).max a new NFT at tokenId nextTokenIdToMint is minted. If the given tokenIds[i] < nextTokenIdToMint, then additional supply of an existing NFT is minted. The metadata for each new NFT is stored at baseURI/{tokenID of NFT}

Parameters

Name	Type	Description
_to	address	The recipient of the NFT to mint.
_tokenIds	uint256[]	The tokenIds of the NFTs to mint.
_amounts	uint256[]	The amounts of each NFT to mint.
_baseURI	string	The baseURI for the n number of NFTs minted. The metadata for each NFT is baseURI/tokenId

burn

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

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

Parameters

Name	Type	Description
_owner	address	The owner of the NFT to burn.
_tokenId	uint256	The tokenId of the NFT to burn.
_amount	uint256	The 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

Name	Type	Description
_owner	address	The owner of the NFTs to burn.
_tokenIds	uint256[]	The tokenIds of the NFTs to burn.
_amounts	uint256[]	The amounts of the NFTs to burn.

claim

function claim(address _receiver, uint256 _tokenId, uint256 _quantity, address _currency, uint256 _pricePerToken, IDropSinglePhase1155.AllowlistProof _allowlistProof, bytes _data) external payable

Parameters

Name	Type	Description
_receiver	address	undefined
_tokenId	uint256	undefined
_quantity	uint256	undefined
_currency	address	undefined
_pricePerToken	uint256	undefined
_allowlistProof	IDropSinglePhase1155.AllowlistProof	undefined
_data	bytes	undefined

claimCondition

function claimCondition(uint256) external view returns (uint256 startTimestamp, uint256 maxClaimableSupply, uint256 supplyClaimed, uint256 quantityLimitPerTransaction, uint256 waitTimeInSecondsBetweenClaims, bytes32 merkleRoot, uint256 pricePerToken, address currency)

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
startTimestamp	uint256	undefined
maxClaimableSupply	uint256	undefined
supplyClaimed	uint256	undefined
quantityLimitPerTransaction	uint256	undefined
waitTimeInSecondsBetweenClaims	uint256	undefined
merkleRoot	bytes32	undefined
pricePerToken	uint256	undefined
currency	address	undefined

contractURI

function contractURI() external view returns (string)

Returns the contract metadata URI.

Returns

Name	Type	Description
_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

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

function encryptedData(uint256) external view returns (bytes)

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	bytes	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

Name	Type	Description
_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

Name	Type	Description
_index	uint256	ID of a token.

Returns

Name	Type	Description
_0	uint256	undefined

getClaimTimestamp

function getClaimTimestamp(uint256 _tokenId, address _claimer) external view returns (uint256 lastClaimedAt, uint256 nextValidClaimTimestamp)

Returns the timestamp for when a claimer is eligible for claiming NFTs again.

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_claimer	address	undefined

Returns

Name	Type	Description
lastClaimedAt	uint256	undefined
nextValidClaimTimestamp	uint256	undefined

getDefaultRoyaltyInfo

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

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

Returns

Name	Type	Description
_0	address	undefined
_1	uint16	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

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.

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

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

isApprovedForAll

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

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

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined

Returns

Name	Type	Description
_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

Name	Type	Description
_batchId	uint256	ID of a batch of NFTs.

Returns

Name	Type	Description
_0	bool	undefined

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

Name	Type	Description
_amount	uint256	The number of NFTs to lazy mint.
_baseURIForTokens	string	The placeholder base URI for the 'n' number of NFTs being lazy minted, where the metadata for each of those NFTs is ${baseURIForTokens}/${tokenId}.
_data	bytes	The encrypted base URI + provenance hash for the batch of NFTs being lazy minted.

Returns

Name	Type	Description
batchId	uint256	A unique integer identifier for the batch of NFTs lazy minted together.

mintTo

function mintTo(address _to, uint256 _tokenId, string _tokenURI, uint256 _amount) external nonpayable

Lets an authorized address mint NFTs to a recipient.

- The logic in the _canMint function determines whether the caller is authorized to mint NFTs. - If _tokenId == type(uint256).max a new NFT at tokenId nextTokenIdToMint is minted. If the given tokenId < nextTokenIdToMint, then additional supply of an existing NFT is being minted.

Parameters

Name	Type	Description
_to	address	The recipient of the NFTs to mint.
_tokenId	uint256	The tokenId of the NFT to mint.
_tokenURI	string	The full metadata URI for the NFTs minted (if a new NFT is being minted).
_amount	uint256	The amount of the same NFT to mint.

mintWithSignature

function mintWithSignature(ISignatureMintERC1155.MintRequest _req, bytes _signature) external payable returns (address signer)

Parameters

Name	Type	Description
_req	ISignatureMintERC1155.MintRequest	undefined
_signature	bytes	undefined

Returns

Name	Type	Description
signer	address	undefined

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

Name	Type	Description
data	bytes[]	The bytes data that makes up the batch of function calls to execute.

Returns

Name	Type	Description
results	bytes[]	The bytes data that makes up the result of the batch of function calls executed.

name

function name() external view returns (string)

Returns

Name	Type	Description
_0	string	undefined

nextTokenIdToMint

function nextTokenIdToMint() external view returns (uint256)

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

Returns

Name	Type	Description
_0	uint256	undefined

owner

function owner() external view returns (address)

Returns the owner of the contract.

Returns

Name	Type	Description
_0	address	undefined

primarySaleRecipient

function primarySaleRecipient() external view returns (address)

Returns primary sale recipient address.

Returns

Name	Type	Description
_0	address	undefined

reveal

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

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

Parameters

Name	Type	Description
_index	uint256	The ID for the batch of delayed-reveal NFTs to reveal.
_key	bytes	The key with which the base URI for the relevant batch of NFTs was encrypted.

Returns

Name	Type	Description
revealedURI	string	undefined

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

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.

safeBatchTransferFrom

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

Parameters

Name	Type	Description
from	address	undefined
to	address	undefined
ids	uint256[]	undefined
amounts	uint256[]	undefined
data	bytes	undefined

safeTransferFrom

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

Parameters

Name	Type	Description
from	address	undefined
to	address	undefined
id	uint256	undefined
amount	uint256	undefined
data	bytes	undefined

setApprovalForAll

function setApprovalForAll(address operator, bool approved) external nonpayable

Parameters

Name	Type	Description
operator	address	undefined
approved	bool	undefined

setClaimConditions

function setClaimConditions(uint256 _tokenId, IClaimCondition.ClaimCondition _condition, bool _resetClaimEligibility) external nonpayable

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_condition	IClaimCondition.ClaimCondition	undefined
_resetClaimEligibility	bool	undefined

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

Name	Type	Description
_uri	string	keccak256 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

Name	Type	Description
_royaltyRecipient	address	Address to be set as default royalty recipient.
_royaltyBps	uint256	Updated royalty bps.

setOwner

function setOwner(address _newOwner) external nonpayable

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.

setPrimarySaleRecipient

function setPrimarySaleRecipient(address _saleRecipient) external nonpayable

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

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

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

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

Returns whether this contract supports the given interface.

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

symbol

function symbol() external view returns (string)

Returns

Name	Type	Description
_0	string	undefined

totalSupply

function totalSupply(uint256) external view returns (uint256)

Returns the total supply of NFTs of a given tokenId

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

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

Name	Type	Description
_tokenId	uint256	The tokenId of an NFT.

Returns

Name	Type	Description
_0	string	undefined

verify

function verify(ISignatureMintERC1155.MintRequest _req, bytes _signature) external view returns (bool success, address signer)

Parameters

Name	Type	Description
_req	ISignatureMintERC1155.MintRequest	undefined
_signature	bytes	undefined

Returns

Name	Type	Description
success	bool	undefined
signer	address	undefined

verifyClaim

function verifyClaim(uint256 _tokenId, address _claimer, uint256 _quantity, address _currency, uint256 _pricePerToken, bool verifyMaxQuantityPerTransaction) external view

Checks a request to claim NFTs against the active claim condition's criteria.

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_claimer	address	undefined
_quantity	uint256	undefined
_currency	address	undefined
_pricePerToken	uint256	undefined
verifyMaxQuantityPerTransaction	bool	undefined

verifyClaimMerkleProof

function verifyClaimMerkleProof(uint256 _tokenId, address _claimer, uint256 _quantity, IDropSinglePhase1155.AllowlistProof _allowlistProof) external view returns (bool validMerkleProof, uint256 merkleProofIndex)

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_claimer	address	undefined
_quantity	uint256	undefined
_allowlistProof	IDropSinglePhase1155.AllowlistProof	undefined

Returns

Name	Type	Description
validMerkleProof	bool	undefined
merkleProofIndex	uint256	undefined

Events

ApprovalForAll

event ApprovalForAll(address indexed _owner, address indexed _operator, bool _approved)

Parameters

Name	Type	Description
_owner indexed	address	undefined
_operator indexed	address	undefined
_approved	bool	undefined

ClaimConditionUpdated

event ClaimConditionUpdated(uint256 indexed tokenId, IClaimCondition.ClaimCondition condition, bool resetEligibility)

Parameters

Name	Type	Description
tokenId indexed	uint256	undefined
condition	IClaimCondition.ClaimCondition	undefined
resetEligibility	bool	undefined

ContractURIUpdated

event ContractURIUpdated(string prevURI, string newURI)

Parameters

Name	Type	Description
prevURI	string	undefined
newURI	string	undefined

DefaultRoyalty

event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)

Parameters

Name	Type	Description
newRoyaltyRecipient indexed	address	undefined
newRoyaltyBps	uint256	undefined

OwnerUpdated

event OwnerUpdated(address indexed prevOwner, address indexed newOwner)

Parameters

Name	Type	Description
prevOwner indexed	address	undefined
newOwner indexed	address	undefined

PrimarySaleRecipientUpdated

event PrimarySaleRecipientUpdated(address indexed recipient)

Parameters

Name	Type	Description
recipient indexed	address	undefined

RoyaltyForToken

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

Parameters

Name	Type	Description
tokenId indexed	uint256	undefined
royaltyRecipient indexed	address	undefined
royaltyBps	uint256	undefined

TokenURIRevealed

event TokenURIRevealed(uint256 indexed index, string revealedURI)

Parameters

Name	Type	Description
index indexed	uint256	undefined
revealedURI	string	undefined

TokensClaimed

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

Parameters

Name	Type	Description
claimer indexed	address	undefined
receiver indexed	address	undefined
tokenId indexed	uint256	undefined
quantityClaimed	uint256	undefined

TokensLazyMinted

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

Parameters

Name	Type	Description
startTokenId indexed	uint256	undefined
endTokenId	uint256	undefined
baseURI	string	undefined
encryptedBaseURI	bytes	undefined

TokensMintedWithSignature

event TokensMintedWithSignature(address indexed signer, address indexed mintedTo, uint256 indexed tokenIdMinted, ISignatureMintERC1155.MintRequest mintRequest)

Parameters

Name	Type	Description
signer indexed	address	undefined
mintedTo indexed	address	undefined
tokenIdMinted indexed	uint256	undefined
mintRequest	ISignatureMintERC1155.MintRequest	undefined

TransferBatch

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

Parameters

Name	Type	Description
_operator indexed	address	undefined
_from indexed	address	undefined
_to indexed	address	undefined
_ids	uint256[]	undefined
_values	uint256[]	undefined

TransferSingle

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

Parameters

Name	Type	Description
_operator indexed	address	undefined
_from indexed	address	undefined
_to indexed	address	undefined
_id	uint256	undefined
_value	uint256	undefined

URI

event URI(string _value, uint256 indexed _id)

Parameters

Name	Type	Description
_value	string	undefined
_id indexed	uint256	undefined