DropERC20
Methods
DEFAULT_ADMIN_ROLE
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)Returns
_0
bytes32
undefined
DOMAIN_SEPARATOR
function DOMAIN_SEPARATOR() external view returns (bytes32)See {IERC20Permit-DOMAIN_SEPARATOR}.
Returns
_0
bytes32
undefined
allowance
function allowance(address owner, address spender) external view returns (uint256)See {IERC20-allowance}.
Parameters
owner
address
undefined
spender
address
undefined
Returns
_0
uint256
undefined
approve
function approve(address spender, uint256 amount) external nonpayable returns (bool)See {IERC20-approve}. NOTE: If amount is the maximum uint256, the allowance is not updated on transferFrom. This is semantically equivalent to an infinite approval. Requirements: - spender cannot be the zero address.
Parameters
spender
address
undefined
amount
uint256
undefined
Returns
_0
bool
undefined
balanceOf
function balanceOf(address account) external view returns (uint256)See {IERC20-balanceOf}.
Parameters
account
address
undefined
Returns
_0
uint256
undefined
burn
function burn(uint256 amount) external nonpayableDestroys amount tokens from the caller. See {ERC20-_burn}.
Parameters
amount
uint256
undefined
burnFrom
function burnFrom(address account, uint256 amount) external nonpayableDestroys amount tokens from account, deducting from the caller's allowance. See {ERC20-_burn} and {ERC20-allowance}. Requirements: - the caller must have allowance for accounts's tokens of at least amount.
Parameters
account
address
undefined
amount
uint256
undefined
checkpoints
function checkpoints(address account, uint32 pos) external view returns (struct ERC20VotesUpgradeable.Checkpoint)Get the pos-th checkpoint for account.
Parameters
account
address
undefined
pos
uint32
undefined
Returns
_0
ERC20VotesUpgradeable.Checkpoint
undefined
claim
function claim(address _receiver, uint256 _quantity, address _currency, uint256 _pricePerToken, IDrop.AllowlistProof _allowlistProof, bytes _data) external payableParameters
_receiver
address
undefined
_quantity
uint256
undefined
_currency
address
undefined
_pricePerToken
uint256
undefined
_allowlistProof
IDrop.AllowlistProof
undefined
_data
bytes
undefined
claimCondition
function claimCondition() external view returns (uint256 currentStartId, uint256 count)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
decimals
function decimals() external view returns (uint8)Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
Returns
_0
uint8
undefined
decreaseAllowance
function decreaseAllowance(address spender, uint256 subtractedValue) external nonpayable returns (bool)Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.
Parameters
spender
address
undefined
subtractedValue
uint256
undefined
Returns
_0
bool
undefined
delegate
function delegate(address delegatee) external nonpayableDelegate votes from the sender to delegatee.
Parameters
delegatee
address
undefined
delegateBySig
function delegateBySig(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s) external nonpayableDelegates votes from signer to delegatee
Parameters
delegatee
address
undefined
nonce
uint256
undefined
expiry
uint256
undefined
v
uint8
undefined
r
bytes32
undefined
s
bytes32
undefined
delegates
function delegates(address account) external view returns (address)Get the address account is currently delegating to.
Parameters
account
address
undefined
Returns
_0
address
undefined
getActiveClaimConditionId
function getActiveClaimConditionId() external view returns (uint256)At any given moment, returns the uid for the active claim condition.
Returns
_0
uint256
undefined
getClaimConditionById
function getClaimConditionById(uint256 _conditionId) external view returns (struct IClaimCondition.ClaimCondition condition)Returns the claim condition at the given uid.
Parameters
_conditionId
uint256
undefined
Returns
condition
IClaimCondition.ClaimCondition
undefined
getPastTotalSupply
function getPastTotalSupply(uint256 blockNumber) external view returns (uint256)Retrieve the totalSupply at the end of blockNumber. Note, this value is the sum of all balances. It is but NOT the sum of all the delegated votes! Requirements: - blockNumber must have been already mined
Parameters
blockNumber
uint256
undefined
Returns
_0
uint256
undefined
getPastVotes
function getPastVotes(address account, uint256 blockNumber) external view returns (uint256)Retrieve the number of votes for account at the end of blockNumber. Requirements: - blockNumber must have been already mined
Parameters
account
address
undefined
blockNumber
uint256
undefined
Returns
_0
uint256
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
getSupplyClaimedByWallet
function getSupplyClaimedByWallet(uint256 _conditionId, address _claimer) external view returns (uint256 supplyClaimedByWallet)Returns the supply claimed by claimer for a given conditionId.
Parameters
_conditionId
uint256
undefined
_claimer
address
undefined
Returns
supplyClaimedByWallet
uint256
undefined
getVotes
function getVotes(address account) external view returns (uint256)Gets the current votes balance for account
Parameters
account
address
undefined
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
increaseAllowance
function increaseAllowance(address spender, uint256 addedValue) external nonpayable returns (bool)Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.
Parameters
spender
address
undefined
addedValue
uint256
undefined
Returns
_0
bool
undefined
initialize
function initialize(address _defaultAdmin, string _name, string _symbol, string _contractURI, address[] _trustedForwarders, address _saleRecipient, address _platformFeeRecipient, uint128 _platformFeeBps) 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
_platformFeeRecipient
address
undefined
_platformFeeBps
uint128
undefined
isTrustedForwarder
function isTrustedForwarder(address forwarder) external view returns (bool)Parameters
forwarder
address
undefined
Returns
_0
bool
undefined
maxTotalSupply
function maxTotalSupply() external view returns (uint256)Global max total supply of tokens.
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 the name of the token.
Returns
_0
string
undefined
nonces
function nonces(address owner) external view returns (uint256)See {IERC20Permit-nonces}.
Parameters
owner
address
undefined
Returns
_0
uint256
undefined
numCheckpoints
function numCheckpoints(address account) external view returns (uint32)Get number of checkpoints for account.
Parameters
account
address
undefined
Returns
_0
uint32
undefined
permit
function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external nonpayableSee {IERC20Permit-permit}.
Parameters
owner
address
undefined
spender
address
undefined
value
uint256
undefined
deadline
uint256
undefined
v
uint8
undefined
r
bytes32
undefined
s
bytes32
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.
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.
setClaimConditions
function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _resetClaimEligibility) external nonpayableParameters
_conditions
IClaimCondition.ClaimCondition[]
undefined
_resetClaimEligibility
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")
setMaxTotalSupply
function setMaxTotalSupply(uint256 _maxTotalSupply) external nonpayableLets a contract admin set the global maximum supply for collection's NFTs.
Parameters
_maxTotalSupply
uint256
undefined
setPlatformFeeInfo
function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayableUpdates 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 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.
symbol
function symbol() external view returns (string)Returns the symbol of the token, usually a shorter version of the name.
Returns
_0
string
undefined
totalSupply
function totalSupply() external view returns (uint256)See {IERC20-totalSupply}.
Returns
_0
uint256
undefined
transfer
function transfer(address to, uint256 amount) external nonpayable returns (bool)See {IERC20-transfer}. Requirements: - to cannot be the zero address. - the caller must have a balance of at least amount.
Parameters
to
address
undefined
amount
uint256
undefined
Returns
_0
bool
undefined
transferFrom
function transferFrom(address from, address to, uint256 amount) external nonpayable returns (bool)See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. NOTE: Does not update the allowance if the current allowance is the maximum uint256. Requirements: - from and to cannot be the zero address. - from must have a balance of at least amount. - the caller must have allowance for from's tokens of at least amount.
Parameters
from
address
undefined
to
address
undefined
amount
uint256
undefined
Returns
_0
bool
undefined
verifyClaim
function verifyClaim(uint256 _conditionId, address _claimer, uint256 _quantity, address _currency, uint256 _pricePerToken, IDrop.AllowlistProof _allowlistProof) external view returns (bool isOverride)Parameters
_conditionId
uint256
undefined
_claimer
address
undefined
_quantity
uint256
undefined
_currency
address
undefined
_pricePerToken
uint256
undefined
_allowlistProof
IDrop.AllowlistProof
undefined
Returns
isOverride
bool
undefined
Events
Approval
event Approval(address indexed owner, address indexed spender, uint256 value)Parameters
owner indexed
address
undefined
spender indexed
address
undefined
value
uint256
undefined
ClaimConditionsUpdated
event ClaimConditionsUpdated(IClaimCondition.ClaimCondition[] claimConditions, bool resetEligibility)Emitted when the contract's claim conditions are updated.
Parameters
claimConditions
IClaimCondition.ClaimCondition[]
undefined
resetEligibility
bool
undefined
ContractURIUpdated
event ContractURIUpdated(string prevURI, string newURI)Parameters
prevURI
string
undefined
newURI
string
undefined
DelegateChanged
event DelegateChanged(address indexed delegator, address indexed fromDelegate, address indexed toDelegate)Parameters
delegator indexed
address
undefined
fromDelegate indexed
address
undefined
toDelegate indexed
address
undefined
DelegateVotesChanged
event DelegateVotesChanged(address indexed delegate, uint256 previousBalance, uint256 newBalance)Parameters
delegate indexed
address
undefined
previousBalance
uint256
undefined
newBalance
uint256
undefined
Initialized
event Initialized(uint8 version)Parameters
version
uint8
undefined
MaxTotalSupplyUpdated
event MaxTotalSupplyUpdated(uint256 maxTotalSupply)Emitted when the global max supply of tokens is updated.
Parameters
maxTotalSupply
uint256
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
TokensClaimed
event TokensClaimed(uint256 indexed claimConditionIndex, address indexed claimer, address indexed receiver, uint256 startTokenId, uint256 quantityClaimed)Emitted when tokens are claimed via claim.
Parameters
claimConditionIndex indexed
uint256
undefined
claimer indexed
address
undefined
receiver indexed
address
undefined
startTokenId
uint256
undefined
quantityClaimed
uint256
undefined
Transfer
event Transfer(address indexed from, address indexed to, uint256 value)Parameters
from indexed
address
undefined
to indexed
address
undefined
value
uint256
undefined
Last updated