refactor: deprecate supply royalty (#267)

before margin: 0.117 kb
~available margin: 0.839 kb~
available margin: 0.576 kb

.changeset/great-camels-impress.md

@@ -0,0 +1,5 @@
+---
+"@zoralabs/zora-1155-contracts": minor
+---
+
+Supply royalties are no longer supported

packages/1155-contracts/src/nft/ZoraCreator1155Impl.sol

@@ -388,6 +388,7 @@ contract ZoraCreator1155Impl is
                 _requireAdminOrRole(msg.sender, tokenIds[i], PERMISSION_BIT_MINTER);
             }
         }
+
         _mintBatch(recipient, tokenIds, quantities, data);
     }
 
@@ -553,61 +554,36 @@ contract ZoraCreator1155Impl is
         return super.supportsInterface(interfaceId) || interfaceId == type(IZoraCreator1155).interfaceId || ERC1155Upgradeable.supportsInterface(interfaceId);
     }
 
-    function _handleSupplyRoyalty(uint256 tokenId, uint256 mintAmount, bytes memory data) internal returns (uint256 totalRoyaltyMints) {
-        uint256 royaltyMintSchedule = royalties[tokenId].royaltyMintSchedule;
-        if (royaltyMintSchedule == 0) {
-            royaltyMintSchedule = royalties[CONTRACT_BASE_ID].royaltyMintSchedule;
-        }
-        if (royaltyMintSchedule == 0) {
-            // If we still have no schedule, return 0 supply royalty.
-            return 0;
-        }
-        uint256 maxSupply = tokens[tokenId].maxSupply;
-        uint256 totalMinted = tokens[tokenId].totalMinted;
-
-        totalRoyaltyMints = (mintAmount + (totalMinted % royaltyMintSchedule)) / (royaltyMintSchedule - 1);
-        totalRoyaltyMints = MathUpgradeable.min(totalRoyaltyMints, maxSupply - (mintAmount + totalMinted));
-        if (totalRoyaltyMints > 0) {
-            address royaltyRecipient = royalties[tokenId].royaltyRecipient;
-            if (royaltyRecipient == address(0)) {
-                royaltyRecipient = royalties[CONTRACT_BASE_ID].royaltyRecipient;
-            }
-            // If we have no recipient set, return 0 supply royalty.
-            if (royaltyRecipient == address(0)) {
-                return 0;
-            }
-            super._mint(royaltyRecipient, tokenId, totalRoyaltyMints, data);
-        }
-    }
-
     /// Generic 1155 function overrides ///
 
-    /// @notice Mint function that 1) checks quantity and 2) handles supply royalty 3) keeps track of allowed tokens
+    /// @notice Mint function that 1) checks quantity 2) keeps track of allowed tokens
     /// @param to to mint to
     /// @param id token id to mint
     /// @param amount of tokens to mint
     /// @param data as specified by 1155 standard
     function _mint(address to, uint256 id, uint256 amount, bytes memory data) internal virtual override {
-        uint256 supplyRoyaltyMints = _handleSupplyRoyalty(id, amount, data);
-        _requireCanMintQuantity(id, amount + supplyRoyaltyMints);
+        _requireCanMintQuantity(id, amount);
+
+        tokens[id].totalMinted += amount;
 
         super._mint(to, id, amount, data);
-        tokens[id].totalMinted += amount + supplyRoyaltyMints;
     }
 
-    /// @notice Mint batch function that 1) checks quantity and 2) handles supply royalty 3) keeps track of allowed tokens
+    /// @notice Mint batch function that 1) checks quantity and 2) keeps track of allowed tokens
     /// @param to to mint to
     /// @param ids token ids to mint
     /// @param amounts of tokens to mint
     /// @param data as specified by 1155 standard
     function _mintBatch(address to, uint256[] memory ids, uint256[] memory amounts, bytes memory data) internal virtual override {
-        super._mintBatch(to, ids, amounts, data);
+        uint256 numTokens = ids.length;
 
-        for (uint256 i = 0; i < ids.length; ++i) {
-            uint256 supplyRoyaltyMints = _handleSupplyRoyalty(ids[i], amounts[i], data);
-            _requireCanMintQuantity(ids[i], amounts[i] + supplyRoyaltyMints);
-            tokens[ids[i]].totalMinted += amounts[i] + supplyRoyaltyMints;
+        for (uint256 i; i < numTokens; ++i) {
+            _requireCanMintQuantity(ids[i], amounts[i]);
+
+            tokens[ids[i]].totalMinted += amounts[i];
         }
+
+        super._mintBatch(to, ids, amounts, data);
     }
 
     /// @notice Burns a batch of tokens

packages/1155-contracts/src/royalties/CreatorRoyaltiesControl.sol

@@ -33,8 +33,8 @@ abstract contract CreatorRoyaltiesControl is CreatorRoyaltiesStorageV1, SharedBa
     }
 
     function _updateRoyalties(uint256 tokenId, RoyaltyConfiguration memory configuration) internal {
-        // Don't allow 100% supply royalties
-        if (configuration.royaltyMintSchedule == 1) {
+        // Deprecate supply royalty support
+        if (configuration.royaltyMintSchedule != 0) {
             revert InvalidMintSchedule();
         }
         // Don't allow setting royalties to burn address

packages/1155-contracts/test/factory/ZoraCreator1155Factory.t.sol

@@ -77,38 +77,26 @@ contract ZoraCreator1155FactoryTest is Test {
         assertEq(address(minters[2]), address(3));
     }
 
-    function test_createContract(
-        string memory contractURI,
-        string memory name,
-        uint32 royaltyBPS,
-        uint32 royaltyMintSchedule,
-        address royaltyRecipient,
-        address payable admin
-    ) external {
+    function test_createContract(string memory contractURI, string memory name, uint32 royaltyBPS, address royaltyRecipient, address payable admin) external {
         // If the factory is the admin, the admin flag is cleared
         // during multicall breaking a further test assumption.
         // Additionally, this case makes no sense from a user perspective.
         vm.assume(admin != payable(address(factory)));
-        vm.assume(royaltyMintSchedule != 1);
         // Assume royalty recipient is not 0
         vm.assume(royaltyRecipient != payable(address(0)));
         bytes[] memory initSetup = new bytes[](1);
         initSetup[0] = abi.encodeWithSelector(IZoraCreator1155.setupNewToken.selector, "ipfs://asdfadsf", 100);
         address deployedAddress = factory.createContract(
             contractURI,
             name,
-            ICreatorRoyaltiesControl.RoyaltyConfiguration({
-                royaltyBPS: royaltyBPS,
-                royaltyRecipient: royaltyRecipient,
-                royaltyMintSchedule: royaltyMintSchedule
-            }),
+            ICreatorRoyaltiesControl.RoyaltyConfiguration({royaltyBPS: royaltyBPS, royaltyRecipient: royaltyRecipient, royaltyMintSchedule: 0}),
             admin,
             initSetup
         );
         ZoraCreator1155Impl target = ZoraCreator1155Impl(deployedAddress);
 
         ICreatorRoyaltiesControl.RoyaltyConfiguration memory config = target.getRoyalties(0);
-        assertEq(config.royaltyMintSchedule, royaltyMintSchedule);
+        assertEq(config.royaltyMintSchedule, 0);
         assertEq(config.royaltyBPS, royaltyBPS);
         assertEq(config.royaltyRecipient, royaltyRecipient);
         assertEq(target.permissions(0, admin), target.PERMISSION_BIT_ADMIN());
@@ -170,7 +158,7 @@ contract ZoraCreator1155FactoryTest is Test {
         ICreatorRoyaltiesControl.RoyaltyConfiguration memory royaltyConfig = ICreatorRoyaltiesControl.RoyaltyConfiguration({
             royaltyBPS: 10,
             royaltyRecipient: vm.addr(5),
-            royaltyMintSchedule: 100
+            royaltyMintSchedule: 0
         });
         bytes[] memory initSetup = new bytes[](1);
         initSetup[0] = abi.encodeWithSelector(IZoraCreator1155.setupNewToken.selector, "ipfs://asdfadsf", 100);
@@ -220,7 +208,7 @@ contract ZoraCreator1155FactoryTest is Test {
         ICreatorRoyaltiesControl.RoyaltyConfiguration memory royaltyConfig = ICreatorRoyaltiesControl.RoyaltyConfiguration({
             royaltyBPS: 10,
             royaltyRecipient: vm.addr(5),
-            royaltyMintSchedule: 100
+            royaltyMintSchedule: 0
         });
         bytes[] memory initSetup = new bytes[](1);
         initSetup[0] = abi.encodeWithSelector(IZoraCreator1155.setupNewToken.selector, "ipfs://asdfadsf", 100);
@@ -241,7 +229,7 @@ contract ZoraCreator1155FactoryTest is Test {
         ICreatorRoyaltiesControl.RoyaltyConfiguration memory royaltyConfig = ICreatorRoyaltiesControl.RoyaltyConfiguration({
             royaltyBPS: 10,
             royaltyRecipient: vm.addr(5),
-            royaltyMintSchedule: 100
+            royaltyMintSchedule: 0
         });
         bytes[] memory initSetup = new bytes[](1);
         initSetup[0] = abi.encodeWithSelector(IZoraCreator1155.setupNewToken.selector, "ipfs://asdfadsf", 100);

packages/1155-contracts/test/fixtures/Zora1155PremintFixtures.sol

@@ -18,7 +18,7 @@ library Zora1155PremintFixtures {
     }
 
     function defaultRoyaltyConfig(address royaltyRecipient) internal pure returns (ICreatorRoyaltiesControl.RoyaltyConfiguration memory) {
-        return ICreatorRoyaltiesControl.RoyaltyConfiguration({royaltyBPS: 10, royaltyRecipient: royaltyRecipient, royaltyMintSchedule: 100});
+        return ICreatorRoyaltiesControl.RoyaltyConfiguration({royaltyBPS: 10, royaltyRecipient: royaltyRecipient, royaltyMintSchedule: 0});
     }
 
     function makeDefaultTokenCreationConfig(IMinter1155 fixedPriceMinter, address royaltyRecipient) internal pure returns (TokenCreationConfig memory) {