add deprecate func (#94)

Author: nikki-kiga

packages/manifold/contracts/gachaclaims/ERC1155GachaLazyClaim.sol

@@ -47,6 +47,9 @@ contract ERC1155GachaLazyClaim is IERC165, IERC1155GachaLazyClaim, ICreatorExten
     uint256 instanceId,
     ClaimParameters calldata claimParameters
   ) external payable override creatorAdminRequired(creatorContractAddress) {
+    if (deprecated) {
+      revert ContractDeprecated();
+    }
     if (instanceId == 0 || instanceId > MAX_UINT_56) revert IGachaLazyClaim.InvalidInstance();
     if (_claims[creatorContractAddress][instanceId].storageProtocol != StorageProtocol.INVALID)
       revert IGachaLazyClaim.ClaimAlreadyInitialized();
@@ -98,6 +101,9 @@ contract ERC1155GachaLazyClaim is IERC165, IERC1155GachaLazyClaim, ICreatorExten
     uint256 instanceId,
     UpdateClaimParameters memory updateClaimParameters
   ) external override creatorAdminRequired(creatorContractAddress) {
+    if (deprecated) {
+      revert ContractDeprecated();
+    }
     Claim memory claim = _getClaim(creatorContractAddress, instanceId);
     if (instanceId == 0 || instanceId > MAX_UINT_56) revert IGachaLazyClaim.InvalidInstance();
     if (updateClaimParameters.endDate != 0 && updateClaimParameters.startDate >= updateClaimParameters.endDate)
@@ -107,7 +113,6 @@ contract ERC1155GachaLazyClaim is IERC165, IERC1155GachaLazyClaim, ICreatorExten
     if (updateClaimParameters.storageProtocol == StorageProtocol.INVALID) revert IGachaLazyClaim.InvalidStorageProtocol();
     if (updateClaimParameters.cost > MAX_UINT_96) revert IGachaLazyClaim.InvalidInput();
 
-
     // Overwrite the existing values
     _claims[creatorContractAddress][instanceId] = Claim({
       storageProtocol: updateClaimParameters.storageProtocol,
@@ -156,7 +161,8 @@ contract ERC1155GachaLazyClaim is IERC165, IERC1155GachaLazyClaim, ICreatorExten
     Claim storage claim = _getClaim(creatorContractAddress, instanceId);
     // Checks for reserving
     if (mintCount == 0 || mintCount >= MAX_UINT_32) revert IGachaLazyClaim.InvalidMintCount();
-    if (claim.startDate > block.timestamp || (claim.endDate > 0 && claim.endDate < block.timestamp)) revert IGachaLazyClaim.ClaimInactive();
+    if (claim.startDate > block.timestamp || (claim.endDate > 0 && claim.endDate < block.timestamp))
+      revert IGachaLazyClaim.ClaimInactive();
     if (claim.totalMax != 0 && claim.total == claim.totalMax) revert IGachaLazyClaim.ClaimSoldOut();
     if (claim.total == MAX_UINT_32) revert IGachaLazyClaim.TooManyRequested();
     if (msg.value != (claim.cost + MINT_FEE) * mintCount) revert IGachaLazyClaim.InvalidPayment();

packages/manifold/contracts/gachaclaims/GachaLazyClaim.sol

@@ -27,6 +27,8 @@ abstract contract GachaLazyClaim is IGachaLazyClaim, AdminControl {
 
   uint256 public constant MINT_FEE = 500000000000000;
 
+  bool public deprecated;
+
   // { contractAddress => { instanceId => { walletAddress => UserMintDetails } } }
   mapping(address => mapping(uint256 => mapping(address => UserMintDetails))) internal _mintDetailsPerWallet;
 
@@ -45,6 +47,13 @@ abstract contract GachaLazyClaim is IGachaLazyClaim, AdminControl {
     _transferOwnership(initialOwner);
   }
 
+  /**
+   * Admin function to deprecate the contract
+   */
+  function deprecate(bool _deprecated) external adminRequired {
+    deprecated = _deprecated;
+  }
+
   /**
    * See {IGachaLazyClaim-withdraw}.
    */

packages/manifold/contracts/gachaclaims/IGachaLazyClaim.sol

@@ -28,6 +28,7 @@ interface IGachaLazyClaim {
   error ClaimNotInitialized();
   error ClaimInactive();
   error ClaimSoldOut();
+  error ContractDeprecated();
   error TokenDNE();
   error FailedToTransfer();
   error TooManyRequested();

packages/manifold/test/gacha/ERC1155GachaLazyClaim.t.sol

@@ -125,6 +125,30 @@ contract ERC1155GachaLazyClaimTest is Test {
     claimP.endDate = 0;
     example.initializeClaim(address(creatorCore1), 1, claimP);
     vm.stopPrank();
+
+    vm.startPrank(owner);
+    example.deprecate(true);
+    vm.stopPrank();
+
+    vm.startPrank(creator);
+    // can't initialize if deprecated
+    vm.expectRevert(IGachaLazyClaim.ContractDeprecated.selector);
+    example.initializeClaim(address(creatorCore1), 2, claimP);
+    vm.stopPrank();
+
+    vm.startPrank(owner);
+    example.deprecate(false);
+    vm.stopPrank();
+
+    vm.startPrank(creator);
+    example.initializeClaim(address(creatorCore1), 2, claimP);
+    vm.stopPrank();
+
+    // Cannot deprecate if not an admin
+    vm.startPrank(other);
+    vm.expectRevert(bytes("AdminControl: Must be owner or admin"));
+    example.deprecate(true);
+    vm.stopPrank();
   }
 
   function testUpdateClaimSanitization() public {
@@ -205,7 +229,25 @@ contract ERC1155GachaLazyClaimTest is Test {
     claim = example.getClaim(address(creatorCore1), 1);
     assertEq(claim.startDate, nowC);
     assertEq(claim.endDate, 0);
+        vm.stopPrank();
+
+    vm.startPrank(owner);
+    example.deprecate(true);
+    vm.stopPrank();
 
+    // can't update if deprecated
+    vm.startPrank(creator);
+    claimU.startDate = nowC + 2000;
+    vm.expectRevert(IGachaLazyClaim.ContractDeprecated.selector);
+    example.updateClaim(address(creatorCore1), 1, claimU);
+    vm.stopPrank();
+
+    vm.startPrank(owner);
+    example.deprecate(false);
+    vm.stopPrank();
+
+    vm.startPrank(creator);
+    example.updateClaim(address(creatorCore1), 1, claimU);
     vm.stopPrank();
   }