docs: improve documentation clarity in Royalty class and update error message in unit tests

Author: bonnie57

src/story_protocol_python_sdk/resources/Royalty.py

@@ -158,15 +158,15 @@ def claim_all_revenue(
         tx_options: dict | None = None,
     ) -> dict:
         """
-        Claims all revenue from the child IPs of an ancestor IP, then transfer all claimed tokens to the wallet if the wallet owns the IP or is the claimer. If claimed token is WIP, it will also be converted back to native tokens.
+        Claims all revenue from the child IPs of an ancestor IP, then transfer all claimed tokens to the wallet if the wallet owns the IP or is the claimer. If claimed token is `WIP(Wrapped IP)`, it will also be converted back to native tokens.
 
         Even if there are no child IPs, you must still populate `currency_tokens` with the token addresses you wish to claim. This is required for the claim operation to know which token balances to process.
              :param ancestor_ip_id str: The IP ID of the ancestor.
              :param claimer str: The address of the claimer.
              :param child_ip_ids list: List of child IP IDs.
              :param royalty_policies list: List of royalty policy addresses.
              :param currency_tokens list: List of currency token addresses.
-             :param claim_options dict: [Optional] Options for auto_transfer_all_claimed_tokens_from_ip and auto_unwrap_ip_tokens. Default values are True.
+             :param claim_options dict: [Optional] Options for `auto_transfer_all_claimed_tokens_from_ip` and `auto_unwrap_ip_tokens`. Default values are True.
              :param tx_options dict: [Optional] The transaction options.
              :return dict: A dictionary with transaction details and claimed tokens.
         """
@@ -359,13 +359,7 @@ def _parse_tx_revenue_token_claimed_event(self, tx_receipt: dict) -> list:
                 )[
                     "args"
                 ]
-                claimed_tokens.append(
-                    {
-                        "claimer": event_result["claimer"],
-                        "token": event_result["token"],
-                        "amount": event_result["amount"],
-                    }
-                )
+                claimed_tokens.append(event_result)
 
         return claimed_tokens
 

tests/unit/resources/test_royalty.py

@@ -278,7 +278,6 @@ def test_claim_all_revenue_success_with_default_claim_options_and_is_claimer_ip_
                 assert len(response["claimed_tokens"]) == 1
                 assert response["claimed_tokens"][0]["amount"] == 120
 
-    # Need to change it
     def test_claim_all_revenue_with_default_claim_options_and_claimer_is_ip_and_owns_claimer_and_token_is_not_wip(
         self,
         royalty_client: Royalty,
@@ -355,7 +354,8 @@ def test_claim_all_revenue_with_default_claim_options_and_claimer_is_ip_and_own_
                 ],
             ):
                 with pytest.raises(
-                    ValueError, match="Multiple WIP tokens found in the claimed tokens."
+                    ValueError,
+                    match="Failed to claim all revenue: Multiple WIP tokens found in the claimed tokens.",
                 ):
                     royalty_client.claim_all_revenue(
                         ancestor_ip_id="0xA34611b0E11Bba2b11c69864f7D36aC83D862A9c",