DropERC1155_V2
Methods
DEFAULT_ADMIN_ROLE
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
Returns
| Name | Type | Description |
|---|
| _0 | bytes32 | undefined |
balanceOf
function balanceOf(address account, uint256 id) external view returns (uint256)
See {IERC1155-balanceOf}. Requirements: - account cannot be the zero address.
Parameters
| Name | Type | Description |
|---|
| account | address | undefined |
| id | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
balanceOfBatch
function balanceOfBatch(address[] accounts, uint256[] ids) external view returns (uint256[])
See {IERC1155-balanceOfBatch}. Requirements: - accounts and ids must have the same length.
Parameters
| Name | Type | Description |
|---|
| accounts | address[] | undefined |
| ids | uint256[] | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256[] | undefined |
burn
function burn(address account, uint256 id, uint256 value) external nonpayable
Lets a token owner burn the tokens they own (i.e. destroy for good)
Parameters
| Name | Type | Description |
|---|
| account | address | undefined |
| id | uint256 | undefined |
| value | uint256 | undefined |
burnBatch
function burnBatch(address account, uint256[] ids, uint256[] values) external nonpayable
Lets a token owner burn multiple tokens they own at once (i.e. destroy for good)
Parameters
| Name | Type | Description |
|---|
| account | address | undefined |
| ids | uint256[] | undefined |
| values | uint256[] | undefined |
claim
function claim(address _receiver, uint256 _tokenId, uint256 _quantity, address _currency, uint256 _pricePerToken, bytes32[] _proofs, uint256 _proofMaxQuantityPerTransaction) external payable
Lets an account claim a given quantity of NFTs, of a single tokenId.
Parameters
| Name | Type | Description |
|---|
| _receiver | address | undefined |
| _tokenId | uint256 | undefined |
| _quantity | uint256 | undefined |
| _currency | address | undefined |
| _pricePerToken | uint256 | undefined |
| _proofs | bytes32[] | undefined |
| _proofMaxQuantityPerTransaction | uint256 | undefined |
claimCondition
function claimCondition(uint256) external view returns (uint256 currentStartId, uint256 count)
Mapping from token ID => the set of all claim conditions, at any given moment, for tokens of the token ID.
Parameters
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| currentStartId | uint256 | undefined |
| count | uint256 | undefined |
contractType
function contractType() external pure returns (bytes32)
Returns the type of the contract.
Returns
| Name | Type | Description |
|---|
| _0 | bytes32 | undefined |
contractURI
function contractURI() external view returns (string)
Contract level metadata.
Returns
| Name | Type | Description |
|---|
| _0 | string | undefined |
contractVersion
function contractVersion() external pure returns (uint8)
Returns the version of the contract.
Returns
| Name | Type | Description |
|---|
| _0 | uint8 | undefined |
getActiveClaimConditionId
function getActiveClaimConditionId(uint256 _tokenId) external view returns (uint256)
At any given moment, returns the uid for the active claim condition, for a given tokenId.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
getClaimConditionById
function getClaimConditionById(uint256 _tokenId, uint256 _conditionId) external view returns (struct IDropClaimCondition_V2.ClaimCondition condition)
Returns the claim condition at the given uid.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _conditionId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| condition | IDropClaimCondition_V2.ClaimCondition | undefined |
getClaimTimestamp
function getClaimTimestamp(uint256 _tokenId, uint256 _conditionId, address _claimer) external view returns (uint256 lastClaimTimestamp, uint256 nextValidClaimTimestamp)
Returns the timestamp for when a claimer is eligible for claiming NFTs again.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _conditionId | uint256 | undefined |
| _claimer | address | undefined |
Returns
| Name | Type | Description |
|---|
| lastClaimTimestamp | uint256 | undefined |
| nextValidClaimTimestamp | uint256 | undefined |
getDefaultRoyaltyInfo
function getDefaultRoyaltyInfo() external view returns (address, uint16)
Returns the default royalty recipient and bps.
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
| _1 | uint16 | undefined |
function getPlatformFeeInfo() external view returns (address, uint16)
Returns the platform fee recipient and bps.
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
| _1 | uint16 | undefined |
getRoleAdmin
function getRoleAdmin(bytes32 role) external view returns (bytes32)
Returns the admin role that controls role. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.
Parameters
| Name | Type | Description |
|---|
| role | bytes32 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bytes32 | undefined |
getRoleMember
function getRoleMember(bytes32 role, uint256 index) external view returns (address)
Returns one of the accounts that have role. index must be a value between 0 and {getRoleMemberCount}, non-inclusive. Role bearers are not sorted in any particular way, and their ordering may change at any point. WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296 for more information.
Parameters
| Name | Type | Description |
|---|
| role | bytes32 | undefined |
| index | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
getRoleMemberCount
function getRoleMemberCount(bytes32 role) external view returns (uint256)
Returns the number of accounts that have role. Can be used together with {getRoleMember} to enumerate all bearers of a role.
Parameters
| Name | Type | Description |
|---|
| role | bytes32 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
getRoyaltyInfoForToken
function getRoyaltyInfoForToken(uint256 _tokenId) external view returns (address, uint16)
Returns the royalty recipient and bps for a particular token Id.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
| _1 | uint16 | undefined |
grantRole
function grantRole(bytes32 role, address account) external nonpayable
Grants role to account. If account had not been already granted role, emits a {RoleGranted} event. Requirements: - the caller must have role's admin role. May emit a {RoleGranted} event.
Parameters
| Name | Type | Description |
|---|
| role | bytes32 | undefined |
| account | address | undefined |
hasRole
function hasRole(bytes32 role, address account) external view returns (bool)
Returns true if account has been granted role.
Parameters
| Name | Type | Description |
|---|
| role | bytes32 | undefined |
| account | address | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
initialize
function initialize(address _defaultAdmin, string _name, string _symbol, string _contractURI, address[] _trustedForwarders, address _saleRecipient, address _royaltyRecipient, uint128 _royaltyBps, uint128 _platformFeeBps, address _platformFeeRecipient) external nonpayable
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
function isApprovedForAll(address account, address operator) external view returns (bool)
See {IERC1155-isApprovedForAll}.
Parameters
| Name | Type | Description |
|---|
| account | address | undefined |
| operator | address | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
isTrustedForwarder
function isTrustedForwarder(address forwarder) external view returns (bool)
Parameters
| Name | Type | Description |
|---|
| forwarder | address | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
lazyMint
function lazyMint(uint256 _amount, string _baseURIForTokens) external nonpayable
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 |
maxTotalSupply
function maxTotalSupply(uint256) external view returns (uint256)
Mapping from token ID => maximum possible total circulating supply of tokens with that ID.
Parameters
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
maxWalletClaimCount
function maxWalletClaimCount(uint256) external view returns (uint256)
Mapping from token ID => the max number of NFTs of the token ID a wallet can claim.
Parameters
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
multicall
function multicall(bytes[] data) external nonpayable returns (bytes[] results)
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
function name() external view returns (string)
Returns
| Name | Type | Description |
|---|
| _0 | string | undefined |
nextTokenIdToMint
function nextTokenIdToMint() external view returns (uint256)
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
owner
function owner() external view returns (address)
Returns the address of the current owner.
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
primarySaleRecipient
function primarySaleRecipient() external view returns (address)
The address that receives all primary sales value.
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
renounceRole
function renounceRole(bytes32 role, address account) external nonpayable
Revokes role from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked role, emits a {RoleRevoked} event. Requirements: - the caller must be account. May emit a {RoleRevoked} event.
Parameters
| Name | Type | Description |
|---|
| role | bytes32 | undefined |
| account | address | undefined |
revokeRole
function revokeRole(bytes32 role, address account) external nonpayable
Revokes role from account. If account had been granted role, emits a {RoleRevoked} event. Requirements: - the caller must have role's admin role. May emit a {RoleRevoked} event.
Parameters
| Name | Type | Description |
|---|
| role | bytes32 | undefined |
| account | address | undefined |
royaltyInfo
function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount)
Returns the royalty recipient and amount, given a tokenId and sale price.
Parameters
| Name | Type | Description |
|---|
| tokenId | uint256 | undefined |
| salePrice | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| receiver | address | undefined |
| royaltyAmount | uint256 | undefined |
safeBatchTransferFrom
function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayable
See {IERC1155-safeBatchTransferFrom}.
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
See {IERC1155-safeTransferFrom}.
Parameters
| Name | Type | Description |
|---|
| from | address | undefined |
| to | address | undefined |
| id | uint256 | undefined |
| amount | uint256 | undefined |
| data | bytes | undefined |
saleRecipient
function saleRecipient(uint256) external view returns (address)
Mapping from token ID => the address of the recipient of primary sales.
Parameters
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
setApprovalForAll
function setApprovalForAll(address operator, bool approved) external nonpayable
See {IERC1155-setApprovalForAll}.
Parameters
| Name | Type | Description |
|---|
| operator | address | undefined |
| approved | bool | undefined |
setClaimConditions
function setClaimConditions(uint256 _tokenId, IDropClaimCondition_V2.ClaimCondition[] _phases, bool _resetClaimEligibility) external nonpayable
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _phases | IDropClaimCondition_V2.ClaimCondition[] | undefined |
| _resetClaimEligibility | bool | undefined |
setContractURI
function setContractURI(string _uri) external nonpayable
Lets a contract admin set the URI for contract-level metadata.
Parameters
| Name | Type | Description |
|---|
| _uri | string | undefined |
setDefaultRoyaltyInfo
function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external nonpayable
Lets a contract admin update the default royalty recipient and bps.
Parameters
| Name | Type | Description |
|---|
| _royaltyRecipient | address | undefined |
| _royaltyBps | uint256 | undefined |
setMaxTotalSupply
function setMaxTotalSupply(uint256 _tokenId, uint256 _maxTotalSupply) external nonpayable
Lets a module admin set a max total supply for token.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _maxTotalSupply | uint256 | undefined |
setMaxWalletClaimCount
function setMaxWalletClaimCount(uint256 _tokenId, uint256 _count) external nonpayable
Lets a contract admin set a maximum number of NFTs of a tokenId that can be claimed by any wallet.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _count | uint256 | undefined |
setOwner
function setOwner(address _newOwner) external nonpayable
Lets a contract admin set a new owner for the contract. The new owner must be a contract admin.
Parameters
| Name | Type | Description |
|---|
| _newOwner | address | undefined |
function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayable
Lets a contract admin update the platform fee recipient and bps
Parameters
| Name | Type | Description |
|---|
| _platformFeeRecipient | address | undefined |
| _platformFeeBps | uint256 | undefined |
setPrimarySaleRecipient
function setPrimarySaleRecipient(address _saleRecipient) external nonpayable
Lets a contract admin set the recipient for all primary sales.
Parameters
| Name | Type | Description |
|---|
| _saleRecipient | address | undefined |
setRoyaltyInfoForToken
function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint256 _bps) external nonpayable
Lets a contract admin set the royalty recipient and bps for a particular token Id.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _recipient | address | undefined |
| _bps | uint256 | undefined |
setSaleRecipientForToken
function setSaleRecipientForToken(uint256 _tokenId, address _saleRecipient) external nonpayable
Lets a contract admin set the recipient for all primary sales.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _saleRecipient | address | undefined |
setWalletClaimCount
function setWalletClaimCount(uint256 _tokenId, address _claimer, uint256 _count) external nonpayable
Lets a contract admin set a claim count for a wallet.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
| _claimer | address | undefined |
| _count | uint256 | undefined |
supportsInterface
function supportsInterface(bytes4 interfaceId) external view returns (bool)
See ERC 165
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)
Mapping from token ID => total circulating supply of tokens with that ID.
Parameters
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
uri
function uri(uint256 _tokenId) external view returns (string _tokenURI)
Returns the URI for a given tokenId.
Parameters
| Name | Type | Description |
|---|
| _tokenId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _tokenURI | string | undefined |
verifyClaim
function verifyClaim(uint256 _conditionId, address _claimer, uint256 _tokenId, 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 |
|---|
| _conditionId | uint256 | undefined |
| _claimer | address | undefined |
| _tokenId | uint256 | undefined |
| _quantity | uint256 | undefined |
| _currency | address | undefined |
| _pricePerToken | uint256 | undefined |
| verifyMaxQuantityPerTransaction | bool | undefined |
verifyClaimMerkleProof
function verifyClaimMerkleProof(uint256 _conditionId, address _claimer, uint256 _tokenId, uint256 _quantity, bytes32[] _proofs, uint256 _proofMaxQuantityPerTransaction) external view returns (bool validMerkleProof, uint256 merkleProofIndex)
Checks whether a claimer meets the claim condition's allowlist criteria.
Parameters
| Name | Type | Description |
|---|
| _conditionId | uint256 | undefined |
| _claimer | address | undefined |
| _tokenId | uint256 | undefined |
| _quantity | uint256 | undefined |
| _proofs | bytes32[] | undefined |
| _proofMaxQuantityPerTransaction | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| validMerkleProof | bool | undefined |
| merkleProofIndex | uint256 | undefined |
walletClaimCount
function walletClaimCount(uint256, address) external view returns (uint256)
Mapping from token ID => claimer wallet address => total number of NFTs of the token ID a wallet has claimed.
Parameters
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
| _1 | address | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
Events
ApprovalForAll
event ApprovalForAll(address indexed account, address indexed operator, bool approved)
Parameters
| Name | Type | Description |
|---|
account indexed | address | undefined |
operator indexed | address | undefined |
| approved | bool | undefined |
ClaimConditionsUpdated
event ClaimConditionsUpdated(uint256 indexed tokenId, IDropClaimCondition_V2.ClaimCondition[] claimConditions)
Parameters
| Name | Type | Description |
|---|
tokenId indexed | uint256 | undefined |
| claimConditions | IDropClaimCondition_V2.ClaimCondition[] | undefined |
DefaultRoyalty
event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)
Parameters
| Name | Type | Description |
|---|
newRoyaltyRecipient indexed | address | undefined |
| newRoyaltyBps | uint256 | undefined |
Initialized
event Initialized(uint8 version)
Parameters
| Name | Type | Description |
|---|
| version | uint8 | undefined |
MaxTotalSupplyUpdated
event MaxTotalSupplyUpdated(uint256 tokenId, uint256 maxTotalSupply)
Parameters
| Name | Type | Description |
|---|
| tokenId | uint256 | undefined |
| maxTotalSupply | uint256 | undefined |
MaxWalletClaimCountUpdated
event MaxWalletClaimCountUpdated(uint256 tokenId, uint256 count)
Parameters
| Name | Type | Description |
|---|
| tokenId | uint256 | undefined |
| count | uint256 | undefined |
OwnerUpdated
event OwnerUpdated(address indexed prevOwner, address indexed newOwner)
Parameters
| Name | Type | Description |
|---|
prevOwner indexed | address | undefined |
newOwner indexed | address | undefined |
event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps)
Parameters
| Name | Type | Description |
|---|
platformFeeRecipient indexed | address | undefined |
| platformFeeBps | uint256 | undefined |
PrimarySaleRecipientUpdated
event PrimarySaleRecipientUpdated(address indexed recipient)
Parameters
| Name | Type | Description |
|---|
recipient indexed | address | undefined |
RoleAdminChanged
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)
Parameters
| Name | Type | Description |
|---|
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
| Name | Type | Description |
|---|
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
| Name | Type | Description |
|---|
role indexed | bytes32 | undefined |
account indexed | address | undefined |
sender 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 |
SaleRecipientForTokenUpdated
event SaleRecipientForTokenUpdated(uint256 indexed tokenId, address saleRecipient)
Parameters
| Name | Type | Description |
|---|
tokenId indexed | uint256 | undefined |
| saleRecipient | address | undefined |
TokensClaimed
event TokensClaimed(uint256 indexed claimConditionIndex, uint256 indexed tokenId, address indexed claimer, address receiver, uint256 quantityClaimed)
Parameters
| Name | Type | Description |
|---|
claimConditionIndex indexed | uint256 | undefined |
tokenId indexed | uint256 | undefined |
claimer indexed | address | undefined |
| receiver | address | undefined |
| quantityClaimed | uint256 | undefined |
TokensLazyMinted
event TokensLazyMinted(uint256 startTokenId, uint256 endTokenId, string baseURI)
Parameters
| Name | Type | Description |
|---|
| startTokenId | uint256 | undefined |
| endTokenId | uint256 | undefined |
| baseURI | string | 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 |
WalletClaimCountUpdated
event WalletClaimCountUpdated(uint256 tokenId, address indexed wallet, uint256 count)
Parameters
| Name | Type | Description |
|---|
| tokenId | uint256 | undefined |
wallet indexed | address | undefined |
| count | uint256 | undefined |