Expose IClaimable interfaces from ERCXLazyMint bases (#245)

Author: joaquim-verges

contracts/base/ERC1155LazyMint.sol

@@ -9,6 +9,7 @@ import "../extension/Ownable.sol";
 import "../extension/Royalty.sol";
 import "../extension/BatchMintMetadata.sol";
 import "../extension/LazyMint.sol";
+import "../extension/interface/IClaimableERC1155.sol";
 
 import "../lib/TWStrings.sol";
 
@@ -44,7 +45,16 @@ import "../lib/TWStrings.sol";
  *
  */
 
-contract ERC1155LazyMint is ERC1155, ContractMetadata, Ownable, Royalty, Multicall, BatchMintMetadata, LazyMint {
+contract ERC1155LazyMint is
+    ERC1155,
+    ContractMetadata,
+    Ownable,
+    Royalty,
+    Multicall,
+    BatchMintMetadata,
+    LazyMint,
+    IClaimableERC1155
+{
     using TWStrings for uint256;
 
     /*//////////////////////////////////////////////////////////////
@@ -106,6 +116,7 @@ contract ERC1155LazyMint is ERC1155, ContractMetadata, Ownable, Royalty, Multica
         require(_tokenId < nextTokenIdToMint(), "invalid id");
 
         _mint(_receiver, _tokenId, _quantity, "");
+        emit TokensClaimed(msg.sender, _receiver, _tokenId, _quantity);
     }
 
     /**

contracts/base/ERC721LazyMint.sol

@@ -9,6 +9,7 @@ import "../extension/Ownable.sol";
 import "../extension/Royalty.sol";
 import "../extension/BatchMintMetadata.sol";
 import "../extension/LazyMint.sol";
+import "../extension/interface/IClaimableERC721.sol";
 
 import "../lib/TWStrings.sol";
 
@@ -38,7 +39,16 @@ import "../lib/TWStrings.sol";
  *  without paying the gas cost for actually minting the NFTs.
  */
 
-contract ERC721LazyMint is ERC721A, ContractMetadata, Multicall, Ownable, Royalty, BatchMintMetadata, LazyMint {
+contract ERC721LazyMint is
+    ERC721A,
+    ContractMetadata,
+    Multicall,
+    Ownable,
+    Royalty,
+    BatchMintMetadata,
+    LazyMint,
+    IClaimableERC721
+{
     using TWStrings for uint256;
 
     /*//////////////////////////////////////////////////////////////
@@ -99,9 +109,10 @@ contract ERC721LazyMint is ERC721A, ContractMetadata, Multicall, Ownable, Royalt
      */
     function claim(address _receiver, uint256 _quantity) public payable virtual {
         verifyClaim(msg.sender, _quantity); // add your claim verification logic by overriding this function
-
+        uint256 startTokenId = _currentIndex;
         require(_currentIndex + _quantity <= nextTokenIdToLazyMint, "Not enough lazy minted tokens.");
         _safeMint(_receiver, _quantity, "");
+        emit TokensClaimed(msg.sender, _receiver, startTokenId, _quantity);
     }
 
     /**

contracts/extension/interface/IClaimableERC1155.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+interface IClaimableERC1155 {
+    /// @dev Emitted when tokens are claimed
+    event TokensClaimed(
+        address indexed claimer,
+        address indexed receiver,
+        uint256 indexed tokenId,
+        uint256 quantityClaimed
+    );
+
+    /**
+     *  @notice          Lets an address claim multiple lazy minted NFTs at once to a recipient.
+     *                   Contract creators should override this function to create custom logic for claiming,
+     *                   for e.g. price collection, allowlist, max quantity, etc.
+     *
+     *  @dev             The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.
+     *
+     *  @param _receiver  The recipient of the tokens to mint.
+     *  @param _tokenId   The tokenId of the lazy minted NFT to mint.
+     *  @param _quantity  The number of tokens to mint.
+     */
+    function claim(
+        address _receiver,
+        uint256 _tokenId,
+        uint256 _quantity
+    ) external payable;
+
+    /**
+     *  @notice          Override this function to add logic for claim verification, based on conditions
+     *                   such as allowlist, price, max quantity etc.
+     *
+     *  @dev             Checks a request to claim NFTs against a custom condition.
+     *
+     *  @param _claimer   Caller of the claim function.
+     *  @param _tokenId   The tokenId of the lazy minted NFT to mint.
+     *  @param _quantity  The number of NFTs being claimed.
+     */
+    function verifyClaim(
+        address _claimer,
+        uint256 _tokenId,
+        uint256 _quantity
+    ) external view;
+}

contracts/extension/interface/IClaimableERC721.sol

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+interface IClaimableERC721 {
+    /// @dev Emitted when tokens are claimed
+    event TokensClaimed(
+        address indexed claimer,
+        address indexed receiver,
+        uint256 indexed startTokenId,
+        uint256 quantityClaimed
+    );
+
+    /**
+     *  @notice          Lets an address claim multiple lazy minted NFTs at once to a recipient.
+     *                   Contract creators should override this function to create custom logic for claiming,
+     *                   for e.g. price collection, allowlist, max quantity, etc.
+     *
+     *  @dev             The logic in the `verifyClaim` function determines whether the caller is authorized to mint NFTs.
+     *
+     *  @param _receiver  The recipient of the NFT to mint.
+     *  @param _quantity  The number of NFTs to mint.
+     */
+    function claim(address _receiver, uint256 _quantity) external payable;
+
+    /**
+     *  @notice          Override this function to add logic for claim verification, based on conditions
+     *                   such as allowlist, price, max quantity etc.
+     *
+     *  @dev             Checks a request to claim NFTs against a custom condition.
+     *
+     *  @param _claimer   Caller of the claim function.
+     *  @param _quantity  The number of NFTs being claimed.
+     */
+    function verifyClaim(address _claimer, uint256 _quantity) external view;
+}