Port cancel_offers to @marshal

Author: Quexington

chia/_tests/wallet/rpc/test_wallet_rpc.py

@@ -107,6 +107,7 @@
 from chia.wallet.wallet_request_types import (
     AddKey,
     CancelOffer,
+    CancelOffers,
     CATAssetIDToName,
     CATGetAssetID,
     CATGetName,
@@ -1783,7 +1784,9 @@ def only_ids(trades: list[TradeRecord]) -> list[bytes32]:
         )
         == 2
     )
-    await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, batch_size=1)
+    await env_1.rpc_client.cancel_offers(
+        CancelOffers(secure=True, batch_size=uint16(1)), tx_config=wallet_environments.tx_config
+    )
     assert (
         len(
             [
@@ -1838,7 +1841,9 @@ def only_ids(trades: list[TradeRecord]) -> list[bytes32]:
         )
         == 2
     )
-    await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, cancel_all=True)
+    await env_1.rpc_client.cancel_offers(
+        CancelOffers(secure=True, cancel_all=True), tx_config=wallet_environments.tx_config
+    )
     assert (
         len(
             [
@@ -1900,7 +1905,9 @@ def only_ids(trades: list[TradeRecord]) -> list[bytes32]:
         )
         == 1
     )
-    await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, asset_id=bytes32.zeros)
+    await env_1.rpc_client.cancel_offers(
+        CancelOffers(secure=True, asset_id=bytes32.zeros.hex()), tx_config=wallet_environments.tx_config
+    )
     assert (
         len(
             [
@@ -1911,7 +1918,9 @@ def only_ids(trades: list[TradeRecord]) -> list[bytes32]:
         )
         == 1
     )
-    await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, asset_id=cat_asset_id)
+    await env_1.rpc_client.cancel_offers(
+        CancelOffers(secure=True, asset_id=cat_asset_id.hex()), tx_config=wallet_environments.tx_config
+    )
     assert (
         len(
             [

chia/wallet/wallet_request_types.py

@@ -2031,6 +2031,16 @@ class CancelOfferResponse(TransactionEndpointResponse):
     pass
 
 
+@streamable
+@dataclass(frozen=True)
+class CancelOffers(TransactionEndpointRequest):
+    secure: bool = field(default_factory=default_raise)
+    batch_fee: uint64 = uint64(0)
+    batch_size: uint16 = uint16(5)
+    cancel_all: bool = False
+    asset_id: str = "xch"
+
+
 @streamable
 @dataclass(frozen=True)
 class CancelOffersResponse(TransactionEndpointResponse):

chia/wallet/wallet_rpc_api.py

@@ -114,6 +114,8 @@
     BalanceResponse,
     CancelOffer,
     CancelOfferResponse,
+    CancelOffers,
+    CancelOffersResponse,
     CATAssetIDToName,
     CATAssetIDToNameResponse,
     CATGetAssetID,
@@ -2431,23 +2433,20 @@ async def cancel_offer(
         return CancelOfferResponse([], [])  # tx_endpoint will fill in default values here
 
     @tx_endpoint(push=True, merge_spends=False)
+    @marshal
     async def cancel_offers(
         self,
-        request: dict[str, Any],
+        request: CancelOffers,
         action_scope: WalletActionScope,
         extra_conditions: tuple[Condition, ...] = tuple(),
-    ) -> EndpointResult:
-        secure = request["secure"]
-        batch_fee: uint64 = uint64(request.get("batch_fee", 0))
-        batch_size = request.get("batch_size", 5)
-        cancel_all = request.get("cancel_all", False)
-        if cancel_all:
-            asset_id = None
+    ) -> CancelOffersResponse:
+        if request.cancel_all:
+            asset_id: Optional[str] = None
         else:
-            asset_id = request.get("asset_id", "xch")
+            asset_id = request.asset_id
 
         start: int = 0
-        end: int = start + batch_size
+        end: int = start + request.batch_size
         trade_mgr = self.service.wallet_state_manager.trade_manager
         log.info(f"Start cancelling offers for  {'asset_id: ' + asset_id if asset_id is not None else 'all'} ...")
         # Traverse offers page by page
@@ -2465,7 +2464,7 @@ async def cancel_offers(
                 include_completed=False,
             )
             for trade in trades:
-                if cancel_all:
+                if request.cancel_all:
                     records[trade.trade_id] = trade
                     continue
                 if trade.offer and trade.offer != b"":
@@ -2481,20 +2480,20 @@ async def cancel_offers(
                 await trade_mgr.cancel_pending_offers(
                     list(records.keys()),
                     action_scope,
-                    batch_fee,
-                    secure,
+                    request.batch_fee,
+                    request.secure,
                     records,
                     extra_conditions=extra_conditions,
                 )
 
             log.info(f"Cancelled offers {start} to {end} ...")
             # If fewer records were returned than requested, we're done
-            if len(trades) < batch_size:
+            if len(trades) < request.batch_size:
                 break
             start = end
-            end += batch_size
+            end += request.batch_size
 
-        return {"transactions": None}  # tx_endpoint wrapper will take care of this
+        return CancelOffersResponse([], [])  # tx_endpoint wrapper will take care of this
 
     ##########################################################################################
     # Distributed Identities

chia/wallet/wallet_rpc_client.py

@@ -21,6 +21,7 @@
     ApplySignaturesResponse,
     CancelOffer,
     CancelOfferResponse,
+    CancelOffers,
     CancelOffersResponse,
     CATAssetIDToName,
     CATAssetIDToNameResponse,
@@ -729,33 +730,17 @@ async def cancel_offer(
 
     async def cancel_offers(
         self,
+        request: CancelOffers,
         tx_config: TXConfig,
-        batch_fee: int = 0,
-        secure: bool = True,
-        batch_size: int = 5,
-        cancel_all: bool = False,
-        asset_id: Optional[bytes32] = None,
         extra_conditions: tuple[Condition, ...] = tuple(),
         timelock_info: ConditionValidTimes = ConditionValidTimes(),
-        push: bool = True,
     ) -> CancelOffersResponse:
-        res = await self.fetch(
-            "cancel_offers",
-            {
-                "secure": secure,
-                "batch_fee": batch_fee,
-                "batch_size": batch_size,
-                "cancel_all": cancel_all,
-                "asset_id": None if asset_id is None else asset_id.hex(),
-                "extra_conditions": conditions_to_json_dicts(extra_conditions),
-                "push": push,
-                **tx_config.to_json_dict(),
-                **timelock_info.to_json_dict(),
-            },
+        return CancelOffersResponse.from_json_dict(
+            await self.fetch(
+                "cancel_offers", request.json_serialize_for_transport(tx_config, extra_conditions, timelock_info)
+            )
         )
 
-        return json_deserialize_with_clvm_streamable(res, CancelOffersResponse)
-
     async def get_cat_list(self) -> GetCATListResponse:
         return GetCATListResponse.from_json_dict(await self.fetch("get_cat_list", {}))