feat(Group): add add_ips_to_group and remove_ips_from_group

- GroupingModule client: add removeIp and build_removeIp_transaction
- Group: add add_ips_to_group(group_ip_id, ip_ids, max_allowed_reward_share_percentage=100, tx_options)
- Group: add remove_ips_from_group(group_ip_id, ip_ids, tx_options)
- Unit tests for both methods (invalid args, success, default/zero reward share, tx failure)
- Integration tests: add_ips_to_group, remove_ips_from_group, add then remove

Author: chao-peng-story

src/story_protocol_python_sdk/abi/GroupingModule/GroupingModule_client.py

@@ -43,6 +43,14 @@ def build_addIp_transaction(
             groupIpId, ipIds, maxAllowedRewardShare
         ).build_transaction(tx_params)
 
+    def removeIp(self, groupIpId, ipIds):
+        return self.contract.functions.removeIp(groupIpId, ipIds).transact()
+
+    def build_removeIp_transaction(self, groupIpId, ipIds, tx_params):
+        return self.contract.functions.removeIp(
+            groupIpId, ipIds
+        ).build_transaction(tx_params)
+
     def claimReward(self, groupId, token, ipIds):
         return self.contract.functions.claimReward(groupId, token, ipIds).transact()
 

src/story_protocol_python_sdk/resources/Group.py

@@ -453,6 +453,86 @@ def register_group_and_attach_license_and_add_ips(
                 f"Failed to register group and attach license and add IPs: {str(e)}"
             )
 
+    def add_ips_to_group(
+        self,
+        group_ip_id: str,
+        ip_ids: list,
+        max_allowed_reward_share_percentage: int = 100,
+        tx_options: dict | None = None,
+    ) -> dict:
+        """
+        Add IPs to an existing group IP.
+
+        :param group_ip_id str: The ID of the group IP.
+        :param ip_ids list: List of IP IDs to add to the group.
+        :param max_allowed_reward_share_percentage int: [Optional] Maximum allowed reward share percentage (0-100). Default is 100.
+        :param tx_options dict: [Optional] The transaction options.
+        :return dict: A dictionary with the transaction hash.
+        """
+        try:
+            if not self.web3.is_address(group_ip_id):
+                raise ValueError(f'Group IP ID "{group_ip_id}" is invalid.')
+
+            for ip_id in ip_ids:
+                if not self.web3.is_address(ip_id):
+                    raise ValueError(f'IP ID "{ip_id}" is invalid.')
+
+            max_allowed_reward_share = get_revenue_share(
+                max_allowed_reward_share_percentage,
+                type=RevShareType.MAX_ALLOWED_REWARD_SHARE,
+            )
+
+            response = build_and_send_transaction(
+                self.web3,
+                self.account,
+                self.grouping_module_client.build_addIp_transaction,
+                group_ip_id,
+                ip_ids,
+                max_allowed_reward_share,
+                tx_options=tx_options,
+            )
+
+            return {"tx_hash": response["tx_hash"]}
+
+        except Exception as e:
+            raise ValueError(f"Failed to add IP to group: {str(e)}")
+
+    def remove_ips_from_group(
+        self,
+        group_ip_id: str,
+        ip_ids: list,
+        tx_options: dict | None = None,
+    ) -> dict:
+        """
+        Remove IPs from a group IP.
+
+        :param group_ip_id str: The ID of the group IP.
+        :param ip_ids list: List of IP IDs to remove from the group.
+        :param tx_options dict: [Optional] The transaction options.
+        :return dict: A dictionary with the transaction hash.
+        """
+        try:
+            if not self.web3.is_address(group_ip_id):
+                raise ValueError(f'Group IP ID "{group_ip_id}" is invalid.')
+
+            for ip_id in ip_ids:
+                if not self.web3.is_address(ip_id):
+                    raise ValueError(f'IP ID "{ip_id}" is invalid.')
+
+            response = build_and_send_transaction(
+                self.web3,
+                self.account,
+                self.grouping_module_client.build_removeIp_transaction,
+                group_ip_id,
+                ip_ids,
+                tx_options=tx_options,
+            )
+
+            return {"tx_hash": response["tx_hash"]}
+
+        except Exception as e:
+            raise ValueError(f"Failed to remove IPs from group: {str(e)}")
+
     def collect_and_distribute_group_royalties(
         self,
         group_ip_id: str,

tests/integration/test_integration_group.py

@@ -366,3 +366,133 @@ def test_get_claimable_reward(
         assert len(claimable_rewards) == 2
         assert claimable_rewards[0] == 10
         assert claimable_rewards[1] == 10
+
+
+class TestAddIpsToGroupAndRemoveIpsFromGroup:
+    """Integration tests for add_ips_to_group and remove_ips_from_group."""
+
+    def test_add_ips_to_group(
+        self, story_client: StoryClient, nft_collection: Address
+    ):
+        """Test adding IPs to an existing group."""
+        # Register two IPs with PIL terms
+        result1 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        result2 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        ip_id1 = result1["ip_id"]
+        ip_id2 = result2["ip_id"]
+        license_terms_id = result1["license_terms_id"]
+
+        # Register group with only the first IP
+        group_ip_id = GroupTestHelper.register_group_and_attach_license(
+            story_client, license_terms_id, [ip_id1]
+        )
+
+        # Add the second IP to the group
+        result = story_client.Group.add_ips_to_group(
+            group_ip_id=group_ip_id,
+            ip_ids=[ip_id2],
+        )
+
+        assert "tx_hash" in result
+        assert isinstance(result["tx_hash"], str)
+        assert len(result["tx_hash"]) > 0
+
+    def test_add_ips_to_group_with_max_reward_share(
+        self, story_client: StoryClient, nft_collection: Address
+    ):
+        """Test adding IPs to group with custom max_allowed_reward_share_percentage."""
+        result1 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        result2 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        ip_id1 = result1["ip_id"]
+        ip_id2 = result2["ip_id"]
+        license_terms_id = result1["license_terms_id"]
+
+        group_ip_id = GroupTestHelper.register_group_and_attach_license(
+            story_client, license_terms_id, [ip_id1]
+        )
+
+        result = story_client.Group.add_ips_to_group(
+            group_ip_id=group_ip_id,
+            ip_ids=[ip_id2],
+            max_allowed_reward_share_percentage=50,
+        )
+
+        assert "tx_hash" in result
+        assert isinstance(result["tx_hash"], str)
+
+    def test_remove_ips_from_group(
+        self, story_client: StoryClient, nft_collection: Address
+    ):
+        """Test removing IPs from a group."""
+        # Register two IPs with PIL terms
+        result1 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        result2 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        ip_id1 = result1["ip_id"]
+        ip_id2 = result2["ip_id"]
+        license_terms_id = result1["license_terms_id"]
+
+        # Register group with both IPs
+        group_ip_id = GroupTestHelper.register_group_and_attach_license(
+            story_client, license_terms_id, [ip_id1, ip_id2]
+        )
+
+        # Remove the second IP from the group
+        result = story_client.Group.remove_ips_from_group(
+            group_ip_id=group_ip_id,
+            ip_ids=[ip_id2],
+        )
+
+        assert "tx_hash" in result
+        assert isinstance(result["tx_hash"], str)
+        assert len(result["tx_hash"]) > 0
+
+    def test_add_then_remove_ips_from_group(
+        self, story_client: StoryClient, nft_collection: Address
+    ):
+        """Test add_ips_to_group then remove_ips_from_group in sequence."""
+        result1 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        result2 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        result3 = GroupTestHelper.mint_and_register_ip_asset_with_pil_terms(
+            story_client, nft_collection
+        )
+        ip_id1 = result1["ip_id"]
+        ip_id2 = result2["ip_id"]
+        ip_id3 = result3["ip_id"]
+        license_terms_id = result1["license_terms_id"]
+
+        # Register group with first IP only
+        group_ip_id = GroupTestHelper.register_group_and_attach_license(
+            story_client, license_terms_id, [ip_id1]
+        )
+
+        # Add ip_id2 and ip_id3
+        add_result = story_client.Group.add_ips_to_group(
+            group_ip_id=group_ip_id,
+            ip_ids=[ip_id2, ip_id3],
+        )
+        assert "tx_hash" in add_result
+        assert isinstance(add_result["tx_hash"], str)
+
+        # Remove ip_id2
+        remove_result = story_client.Group.remove_ips_from_group(
+            group_ip_id=group_ip_id,
+            ip_ids=[ip_id2],
+        )
+        assert "tx_hash" in remove_result
+        assert isinstance(remove_result["tx_hash"], str)