add error NewMaxSupplyCannotBeLessThenTotalSupply

ProjectOpenSea · Apr 4, 2024 · fe0d47a · fe0d47a
1 parent f8b8f16
commit fe0d47a
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 4 deletions.
diff --git a/src/clones/ERC1155ContractMetadataCloneable.sol b/src/clones/ERC1155ContractMetadataCloneable.sol
@@ -177,11 +177,19 @@ contract ERC1155ContractMetadataCloneable is
         _onlyOwnerOrConfigurer();
 
         // Ensure the max supply does not exceed the maximum value of uint64,
-        // a limit due to the storage of bit-packed variables in TokenSupply,
+        // a limit due to the storage of bit-packed variables in TokenSupply.
         if (newMaxSupply > 2 ** 64 - 1) {
             revert CannotExceedMaxSupplyOfUint64(newMaxSupply);
         }
 
+        // Ensure the max supply does not exceed the total supply.
+        if (newMaxSupply < _tokenSupply[tokenId].totalSupply) {
+            revert NewMaxSupplyCannotBeLessThenTotalSupply(
+                newMaxSupply,
+                _tokenSupply[tokenId].totalSupply
+            );
+        }
+
         // Set the new max supply.
         _tokenSupply[tokenId].maxSupply = uint64(newMaxSupply);
 
@@ -337,7 +345,13 @@ contract ERC1155ContractMetadataCloneable is
     }
 
     /// @dev Override this function to return true if `_beforeTokenTransfer` is used.
-    function _useBeforeTokenTransfer() internal view virtual override returns (bool) {
+    function _useBeforeTokenTransfer()
+        internal
+        view
+        virtual
+        override
+        returns (bool)
+    {
         return true;
     }
 

diff --git a/src/interfaces/ISeaDropTokenContractMetadata.sol b/src/interfaces/ISeaDropTokenContractMetadata.sol
@@ -34,6 +34,14 @@ interface ISeaDropTokenContractMetadata {
      */
     error CannotExceedMaxSupplyOfUint64(uint256 got);
 
+    /**
+     * @notice Throw if the max supply exceeds the total supply.
+     */
+    error NewMaxSupplyCannotBeLessThenTotalSupply(
+        uint256 got,
+        uint256 totalSupply
+    );
+
     /**
      * @dev Revert with an error when attempting to set the provenance
      *      hash after the mint has started.

diff --git a/src/lib/ERC1155ContractMetadata.sol b/src/lib/ERC1155ContractMetadata.sol
@@ -175,11 +175,19 @@ contract ERC1155ContractMetadata is
         _onlyOwnerOrConfigurer();
 
         // Ensure the max supply does not exceed the maximum value of uint64,
-        // a limit due to the storage of bit-packed variables in TokenSupply,
+        // a limit due to the storage of bit-packed variables in TokenSupply.
         if (newMaxSupply > 2 ** 64 - 1) {
             revert CannotExceedMaxSupplyOfUint64(newMaxSupply);
         }
 
+        // Ensure the max supply does not exceed the total supply.
+        if (newMaxSupply < _tokenSupply[tokenId].totalSupply) {
+            revert NewMaxSupplyCannotBeLessThenTotalSupply(
+                newMaxSupply,
+                _tokenSupply[tokenId].totalSupply
+            );
+        }
+
         // Set the new max supply.
         _tokenSupply[tokenId].maxSupply = uint64(newMaxSupply);
 
@@ -335,7 +343,13 @@ contract ERC1155ContractMetadata is
     }
 
     /// @dev Override this function to return true if `_beforeTokenTransfer` is used.
-    function _useBeforeTokenTransfer() internal view virtual override returns (bool) {
+    function _useBeforeTokenTransfer()
+        internal
+        view
+        virtual
+        override
+        returns (bool)
+    {
         return true;
     }
 

diff --git a/src/lib/ERC721ContractMetadata.sol b/src/lib/ERC721ContractMetadata.sol
@@ -155,6 +155,14 @@ contract ERC721ContractMetadata is
             revert CannotExceedMaxSupplyOfUint64(newMaxSupply);
         }
 
+        // Ensure the max supply does not exceed the total minted.
+        if (newMaxSupply < totalSupply()) {
+            revert NewMaxSupplyCannotBeLessThenTotalSupply(
+                newMaxSupply,
+                totalSupply()
+            );
+        }
+
         // Set the new max supply.
         _maxSupply = newMaxSupply;
 

diff --git a/test/ERC1155ContractMetadata.spec.ts b/test/ERC1155ContractMetadata.spec.ts
@@ -122,6 +122,26 @@ describe(`ERC1155ContractMetadata (v${VERSION})`, function () {
       .withArgs(BigNumber.from(2).pow(70));
   });
 
+  it("Should not let the owner set the max supply over the totalSupply", async () => {
+    await token.setMaxSupply(1, 3);
+    await mintTokens({
+      marketplaceContract,
+      token,
+      tokenSeaDropInterface,
+      minter: owner,
+      tokenId: 1,
+      quantity: 3,
+    });
+    expect(await token.totalSupply(1)).to.equal(3);
+
+    await expect(token.setMaxSupply(1, 2))
+      .to.be.revertedWithCustomError(
+        token,
+        "NewMaxSupplyCannotBeLessThenTotalSupply"
+      )
+      .withArgs(2, 3);
+  });
+
   it("Should only let the owner notify update of batch token URIs", async () => {
     await expect(
       token.connect(bob).emitBatchMetadataUpdate(5, 10)

diff --git a/test/ERC721ContractMetadata.spec.ts b/test/ERC721ContractMetadata.spec.ts
@@ -120,6 +120,25 @@ describe(`ERC721ContractMetadata (v${VERSION})`, function () {
       .withArgs(BigNumber.from(2).pow(70));
   });
 
+  it("Should not let the owner set the max supply over the totalSupply", async () => {
+    await token.setMaxSupply(3);
+    await mintTokens({
+      marketplaceContract,
+      token,
+      tokenSeaDropInterface,
+      minter: owner,
+      quantity: 3,
+    });
+    expect(await token.totalSupply()).to.equal(3);
+
+    await expect(token.setMaxSupply(2))
+      .to.be.revertedWithCustomError(
+        token,
+        "NewMaxSupplyCannotBeLessThenTotalSupply"
+      )
+      .withArgs(2, 3);
+  });
+
   it("Should only let the owner notify update of batch token URIs", async () => {
     await expect(
       token.connect(bob).emitBatchMetadataUpdate(5, 10)