@@ -8,11 +8,12 @@ import "../IThirdwebPrimarySale.sol";
88import "./IDropClaimCondition.sol " ;
99
1010/**
11- * `LazyMintERC20` is an ERC 20 contract.
11+ * Thirdweb's 'Drop' contracts are distribution mechanisms for tokens. The
12+ * `DropERC20` contract is a distribution mechanism for ERC20 tokens.
1213 *
13- * The module admin can create claim conditions with non-overlapping time windows,
14- * and accounts can claim the tokens, in a given time window, according to restrictions
15- * defined in that time window's claim conditions .
14+ * A contract admin (i.e. holder of `DEFAULT_ADMIN_ROLE`) can create claim conditions
15+ * with non-overlapping time windows, and accounts can claim the tokens according to
16+ * restrictions defined in the claim condition that is active at the time of the transaction .
1617 */
1718
1819interface IDropERC20 is
@@ -33,46 +34,50 @@ interface IDropERC20 is
3334 /// @dev Emitted when new claim conditions are set.
3435 event ClaimConditionsUpdated (ClaimCondition[] claimConditions );
3536
36- /// @dev Emitted when a new sale recipient is set.
37+ /// @dev Emitted when a new primary sale recipient is set.
3738 event PrimarySaleRecipientUpdated (address indexed recipient );
3839
39- /// @dev Emitted when fee on primary sales is updated.
40+ /// @dev Emitted when fee platform fee recipient or bps is updated.
4041 event PlatformFeeInfoUpdated (address platformFeeRecipient , uint256 platformFeeBps );
4142
42- /// @dev Emitted when a max total supply is set for a token .
43+ /// @dev Emitted when the global max supply of tokens is updated .
4344 event MaxTotalSupplyUpdated (uint256 maxTotalSupply );
4445
45- /// @dev Emitted when a wallet claim count is updated.
46+ /// @dev Emitted when the wallet claim count for an address is updated.
4647 event WalletClaimCountUpdated (address indexed wallet , uint256 count );
4748
48- /// @dev Emitted when the max wallet claim count is updated.
49+ /// @dev Emitted when the global max wallet claim count is updated.
4950 event MaxWalletClaimCountUpdated (uint256 count );
5051
5152 /**
5253 * @notice Lets an account claim a given quantity of tokens.
5354 *
54- * @param _receiver The receiver of the NFTs to claim.
55- * @param _quantity The quantity of tokens to claim.
56- * @param _currency The currency in which to pay for the claim.
57- * @param _pricePerToken The price per token to pay for the claim.
58- * @param _proofs The proof required to prove the account's inclusion in the merkle root whitelist
59- * of the mint conditions that apply.
60- * @param _proofMaxQuantityPerTransaction The maximum claim quantity per transactions that included in the merkle proof.
55+ * @param receiver The receiver of the tokens to claim.
56+ * @param quantity The quantity of tokens to claim.
57+ * @param currency The currency in which to pay for the claim.
58+ * @param pricePerToken The price per token (i.e. price per 1 ether unit of the token)
59+ * to pay for the claim.
60+ * @param proofs The proof of the claimer's inclusion in the merkle root allowlist
61+ * of the claim conditions that apply.
62+ * @param proofMaxQuantityPerTransaction (Optional) The maximum number of tokens an address included in an
63+ * allowlist can claim.
6164 */
6265 function claim (
63- address _receiver ,
64- uint256 _quantity ,
65- address _currency ,
66- uint256 _pricePerToken ,
67- bytes32 [] calldata _proofs ,
68- uint256 _proofMaxQuantityPerTransaction
66+ address receiver ,
67+ uint256 quantity ,
68+ address currency ,
69+ uint256 pricePerToken ,
70+ bytes32 [] calldata proofs ,
71+ uint256 proofMaxQuantityPerTransaction
6972 ) external payable ;
7073
7174 /**
72- * @notice Lets a module admin (account with `DEFAULT_ADMIN_ROLE`) set claim conditions.
75+ * @notice Lets a contract admin (account with `DEFAULT_ADMIN_ROLE`) set claim conditions.
7376 *
74- * @param _phases Mint conditions in ascending order by `startTimestamp`.
75- * @param _resetLimitRestriction To reset claim phases limit restriction.
77+ * @param phases Claim conditions in ascending order by `startTimestamp`.
78+ * @param resetClaimEligibility Whether to reset `limitLastClaimTimestamp` and
79+ * `limitMerkleProofClaim` values when setting new
80+ * claim conditions.
7681 */
77- function setClaimConditions (ClaimCondition[] calldata _phases , bool _resetLimitRestriction ) external ;
82+ function setClaimConditions (ClaimCondition[] calldata phases , bool resetClaimEligibility ) external ;
7883}
0 commit comments