DropERC1155
Methods
DEFAULT_ADMIN_ROLE
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
Returns
_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
account
address
undefined
id
uint256
undefined
Returns
_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
accounts
address[]
undefined
ids
uint256[]
undefined
Returns
_0
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
account
address
undefined
ids
uint256[]
undefined
values
uint256[]
undefined
claim
function claim(address _receiver, uint256 _tokenId, uint256 _quantity, address _currency, uint256 _pricePerToken, IDrop1155.AllowlistProof _allowlistProof, bytes _data) external payable
Parameters
_receiver
address
undefined
_tokenId
uint256
undefined
_quantity
uint256
undefined
_currency
address
undefined
_pricePerToken
uint256
undefined
_allowlistProof
IDrop1155.AllowlistProof
undefined
_data
bytes
undefined
claimCondition
function claimCondition(uint256) external view returns (uint256 currentStartId, uint256 count)
Parameters
_0
uint256
undefined
Returns
currentStartId
uint256
undefined
count
uint256
undefined
contractType
function contractType() external pure returns (bytes32)
Returns
_0
bytes32
undefined
contractURI
function contractURI() external view returns (string)
Returns the contract metadata URI.
Returns
_0
string
undefined
contractVersion
function contractVersion() external pure returns (uint8)
Returns
_0
uint8
undefined
getActiveClaimConditionId
function getActiveClaimConditionId(uint256 _tokenId) external view returns (uint256)
At any given moment, returns the uid for the active claim condition.
Parameters
_tokenId
uint256
undefined
Returns
_0
uint256
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
getClaimConditionById
function getClaimConditionById(uint256 _tokenId, uint256 _conditionId) external view returns (struct IClaimCondition.ClaimCondition condition)
Returns the claim condition at the given uid.
Parameters
_tokenId
uint256
undefined
_conditionId
uint256
undefined
Returns
condition
IClaimCondition.ClaimCondition
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
getPlatformFeeInfo
function getPlatformFeeInfo() external view returns (address, uint16)
Returns the platform fee recipient and bps.
Returns
_0
address
undefined
_1
uint16
undefined
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
getSupplyClaimedByWallet
function getSupplyClaimedByWallet(uint256 _tokenId, uint256 _conditionId, address _claimer) external view returns (uint256 supplyClaimedByWallet)
Returns the supply claimed by claimer for a given conditionId.
Parameters
_tokenId
uint256
undefined
_conditionId
uint256
undefined
_claimer
address
undefined
Returns
supplyClaimedByWallet
uint256
undefined
grantRole
function grantRole(bytes32 role, address account) external nonpayable
Grants 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, uint128 _royaltyBps, uint128 _platformFeeBps, address _platformFeeRecipient) external nonpayable
Initiliazes 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
uint128
undefined
_platformFeeBps
uint128
undefined
_platformFeeRecipient
address
undefined
isApprovedForAll
function isApprovedForAll(address account, address operator) external view returns (bool)
See {IERC1155-isApprovedForAll}.
Parameters
account
address
undefined
operator
address
undefined
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, 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}
.
_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.
maxTotalSupply
function maxTotalSupply(uint256) external view returns (uint256)
Mapping from token ID => maximum possible total circulating supply of tokens with that ID.
Parameters
_0
uint256
undefined
Returns
_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
data
bytes[]
undefined
Returns
results
bytes[]
undefined
name
function name() external view returns (string)
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
operatorRestriction
function operatorRestriction() external view returns (bool)
Returns
_0
bool
undefined
owner
function owner() external view returns (address)
Returns the owner of the contract.
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 nonpayable
Revokes 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.
revokeRole
function revokeRole(bytes32 role, address account) external nonpayable
Revokes 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.
safeBatchTransferFrom
function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayable
See {IERC1155-safeBatchTransferFrom}.
Parameters
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
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
_0
uint256
undefined
Returns
_0
address
undefined
setApprovalForAll
function setApprovalForAll(address operator, bool approved) external nonpayable
See {ERC1155-setApprovalForAll}
Parameters
operator
address
undefined
approved
bool
undefined
setClaimConditions
function setClaimConditions(uint256 _tokenId, IClaimCondition.ClaimCondition[] _conditions, bool _resetClaimEligibility) external nonpayable
Parameters
_tokenId
uint256
undefined
_conditions
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
_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
_royaltyRecipient
address
Address to be set as default royalty recipient.
_royaltyBps
uint256
Updated royalty bps.
setMaxTotalSupply
function setMaxTotalSupply(uint256 _tokenId, uint256 _maxTotalSupply) external nonpayable
Lets a module admin set a max total supply for token.
Parameters
_tokenId
uint256
undefined
_maxTotalSupply
uint256
undefined
setOperatorRestriction
function setOperatorRestriction(bool _restriction) external nonpayable
Parameters
_restriction
bool
undefined
setOwner
function setOwner(address _newOwner) external nonpayable
Lets an authorized wallet set a new owner for the contract.
Parameters
_newOwner
address
The address to set as the new owner of the contract.
setPlatformFeeInfo
function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayable
Updates the platform fee recipient and bps.
Caller should be authorized to set platform fee info. See {_canSetPlatformFeeInfo}. Emits {PlatformFeeInfoUpdated Event}; See {_setupPlatformFeeInfo}.
Parameters
_platformFeeRecipient
address
Address to be set as new platformFeeRecipient.
_platformFeeBps
uint256
Updated platformFeeBps.
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
_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
_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.
setSaleRecipientForToken
function setSaleRecipientForToken(uint256 _tokenId, address _saleRecipient) external nonpayable
Lets a contract admin set the recipient for all primary sales.
Parameters
_tokenId
uint256
undefined
_saleRecipient
address
undefined
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)
Returns
_0
string
undefined
totalSupply
function totalSupply(uint256) external view returns (uint256)
Mapping from token ID => total circulating supply of tokens with that ID.
Parameters
_0
uint256
undefined
Returns
_0
uint256
undefined
uri
function uri(uint256 _tokenId) external view returns (string)
Returns the uri for a given tokenId.
Parameters
_tokenId
uint256
undefined
Returns
_0
string
undefined
verifyClaim
function verifyClaim(uint256 _conditionId, address _claimer, uint256 _tokenId, uint256 _quantity, address _currency, uint256 _pricePerToken, IDrop1155.AllowlistProof _allowlistProof) external view returns (bool isOverride)
Parameters
_conditionId
uint256
undefined
_claimer
address
undefined
_tokenId
uint256
undefined
_quantity
uint256
undefined
_currency
address
undefined
_pricePerToken
uint256
undefined
_allowlistProof
IDrop1155.AllowlistProof
undefined
Returns
isOverride
bool
undefined
Events
ApprovalForAll
event ApprovalForAll(address indexed account, address indexed operator, bool approved)
Parameters
account indexed
address
undefined
operator indexed
address
undefined
approved
bool
undefined
ClaimConditionsUpdated
event ClaimConditionsUpdated(uint256 indexed tokenId, IClaimCondition.ClaimCondition[] claimConditions, bool resetEligibility)
Emitted when the contract's claim conditions are updated.
Parameters
tokenId indexed
uint256
undefined
claimConditions
IClaimCondition.ClaimCondition[]
undefined
resetEligibility
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
MaxTotalSupplyUpdated
event MaxTotalSupplyUpdated(uint256 tokenId, uint256 maxTotalSupply)
Emitted when the global max supply of a token is updated.
Parameters
tokenId
uint256
undefined
maxTotalSupply
uint256
undefined
OperatorRestriction
event OperatorRestriction(bool restriction)
Parameters
restriction
bool
undefined
OwnerUpdated
event OwnerUpdated(address indexed prevOwner, address indexed newOwner)
Parameters
prevOwner indexed
address
undefined
newOwner indexed
address
undefined
PlatformFeeInfoUpdated
event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps)
Parameters
platformFeeRecipient indexed
address
undefined
platformFeeBps
uint256
undefined
PrimarySaleRecipientUpdated
event PrimarySaleRecipientUpdated(address indexed recipient)
Parameters
recipient indexed
address
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
SaleRecipientForTokenUpdated
event SaleRecipientForTokenUpdated(uint256 indexed tokenId, address saleRecipient)
Emitted when the sale recipient for a particular tokenId is updated.
Parameters
tokenId indexed
uint256
undefined
saleRecipient
address
undefined
TokensClaimed
event TokensClaimed(uint256 indexed claimConditionIndex, address indexed claimer, address indexed receiver, uint256 tokenId, uint256 quantityClaimed)
Emitted when tokens are claimed.
Parameters
claimConditionIndex indexed
uint256
undefined
claimer indexed
address
undefined
receiver indexed
address
undefined
tokenId
uint256
undefined
quantityClaimed
uint256
undefined
TokensLazyMinted
event TokensLazyMinted(uint256 indexed startTokenId, uint256 endTokenId, string baseURI, bytes encryptedBaseURI)
Parameters
startTokenId indexed
uint256
undefined
endTokenId
uint256
undefined
baseURI
string
undefined
encryptedBaseURI
bytes
undefined
TransferBatch
event TransferBatch(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values)
Parameters
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
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
value
string
undefined
id indexed
uint256
undefined
Errors
OperatorNotAllowed
error OperatorNotAllowed(address operator)
Parameters
operator
address
undefined
Last updated