SDK Updates (#247)

* Add reentrancy guards to ERC721/1155LazyMint.claim()

* transferTokensOnClaim hook, for minting and state updates

* run prettier

Author: kumaryash90

contracts/base/ERC1155LazyMint.sol

@@ -12,6 +12,7 @@ import "../extension/LazyMint.sol";
 import "../extension/interface/IClaimableERC1155.sol";
 
 import "../lib/TWStrings.sol";
+import "../openzeppelin-presets/security/ReentrancyGuard.sol";
 
 /**
  *      BASE:      ERC1155Base
@@ -53,7 +54,8 @@ contract ERC1155LazyMint is
     Multicall,
     BatchMintMetadata,
     LazyMint,
-    IClaimableERC1155
+    IClaimableERC1155,
+    ReentrancyGuard
 {
     using TWStrings for uint256;
 
@@ -110,12 +112,11 @@ contract ERC1155LazyMint is
         address _receiver,
         uint256 _tokenId,
         uint256 _quantity
-    ) public payable virtual {
-        verifyClaim(msg.sender, _tokenId, _quantity); // add your claim verification logic by overriding this function
-
+    ) public payable virtual nonReentrant {
         require(_tokenId < nextTokenIdToMint(), "invalid id");
+        verifyClaim(msg.sender, _tokenId, _quantity); // Add your claim verification logic by overriding this function.
 
-        _mint(_receiver, _tokenId, _quantity, "");
+        transferTokensOnClaim(_receiver, _tokenId, _quantity); // Mints tokens. Apply any state updates by overriding this function.
         emit TokensClaimed(msg.sender, _receiver, _tokenId, _quantity);
     }
 
@@ -205,6 +206,20 @@ contract ERC1155LazyMint is
                         Internal functions
     //////////////////////////////////////////////////////////////*/
 
+    /**
+     *  @notice          Mints tokens to receiver on claim.
+     *                   Can also use this function to apply any state changes before minting.
+     *
+     *  @dev             Override this function to add logic for state updation.
+     */
+    function transferTokensOnClaim(
+        address _receiver,
+        uint256 _tokenId,
+        uint256 _quantity
+    ) internal virtual {
+        _mint(_receiver, _tokenId, _quantity, "");
+    }
+
     /// @dev Returns whether lazy minting can be done in the given execution context.
     function _canLazyMint() internal view virtual override returns (bool) {
         return msg.sender == owner();

contracts/base/ERC721LazyMint.sol

@@ -12,6 +12,7 @@ import "../extension/LazyMint.sol";
 import "../extension/interface/IClaimableERC721.sol";
 
 import "../lib/TWStrings.sol";
+import "../openzeppelin-presets/security/ReentrancyGuard.sol";
 
 /**
  *      BASE:      ERC721A
@@ -47,7 +48,8 @@ contract ERC721LazyMint is
     Royalty,
     BatchMintMetadata,
     LazyMint,
-    IClaimableERC721
+    IClaimableERC721,
+    ReentrancyGuard
 {
     using TWStrings for uint256;
 
@@ -107,11 +109,11 @@ contract ERC721LazyMint is
      *  @param _receiver  The recipient of the NFT to mint.
      *  @param _quantity  The number of NFTs to mint.
      */
-    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;
+    function claim(address _receiver, uint256 _quantity) public payable virtual nonReentrant {
         require(_currentIndex + _quantity <= nextTokenIdToLazyMint, "Not enough lazy minted tokens.");
-        _safeMint(_receiver, _quantity, "");
+        verifyClaim(msg.sender, _quantity); // Add your claim verification logic by overriding this function.
+
+        uint256 startTokenId = transferTokensOnClaim(_receiver, _quantity); // Mints tokens. Apply any state updates by overriding this function.
         emit TokensClaimed(msg.sender, _receiver, startTokenId, _quantity);
     }
 
@@ -150,6 +152,21 @@ contract ERC721LazyMint is
                         Internal functions
     //////////////////////////////////////////////////////////////*/
 
+    /**
+     *  @notice          Mints tokens to receiver on claim.
+     *                   Can also use this function to apply any state changes before minting.
+     *
+     *  @dev             Override this function to add logic for state updation.
+     */
+    function transferTokensOnClaim(address _receiver, uint256 _quantity)
+        internal
+        virtual
+        returns (uint256 startTokenId)
+    {
+        startTokenId = _currentIndex;
+        _safeMint(_receiver, _quantity);
+    }
+
     /// @dev Returns whether lazy minting can be done in the given execution context.
     function _canLazyMint() internal view virtual override returns (bool) {
         return msg.sender == owner();

contracts/openzeppelin-presets/security/ReentrancyGuard.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)
+
+pragma solidity ^0.8.0;
+
+abstract contract ReentrancyGuard {
+    uint256 private constant _NOT_ENTERED = 1;
+    uint256 private constant _ENTERED = 2;
+
+    uint256 private _status;
+
+    constructor() {
+        _status = _NOT_ENTERED;
+    }
+
+    /**
+     * @dev Prevents a contract from calling itself, directly or indirectly.
+     */
+    modifier nonReentrant() {
+        // On the first call to nonReentrant, _notEntered will be true
+        require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
+
+        // Any calls to nonReentrant after this point will fail
+        _status = _ENTERED;
+
+        _;
+
+        // By storing the original value once again, a refund is triggered (see
+        // https://eips.ethereum.org/EIPS/eip-2200)
+        _status = _NOT_ENTERED;
+    }
+}

docs/ReentrancyGuard.md

@@ -0,0 +1,12 @@
+# ReentrancyGuard
+
+
+
+
+
+
+
+
+
+
+