Port get_all_offers to @marshal

Author: Quexington

chia/_tests/cmds/wallet/test_wallet.py

@@ -56,6 +56,8 @@
     ExtendDerivationIndex,
     ExtendDerivationIndexResponse,
     FungibleAsset,
+    GetAllOffers,
+    GetAllOffersResponse,
     GetCurrentDerivationIndexResponse,
     GetHeightInfoResponse,
     GetNextAddress,
@@ -948,32 +950,22 @@ def test_get_offers(capsys: object, get_test_cli_clients: tuple[TestRpcClients,
 
     # set RPC Client
     class GetOffersRpcClient(TestWalletRpcClient):
-        async def get_all_offers(
-            self,
-            start: int = 0,
-            end: int = 50,
-            sort_key: Optional[str] = None,
-            reverse: bool = False,
-            file_contents: bool = False,
-            exclude_my_offers: bool = False,
-            exclude_taken_offers: bool = False,
-            include_completed: bool = False,
-        ) -> list[TradeRecord]:
+        async def get_all_offers(self, request: GetAllOffers) -> GetAllOffersResponse:
             self.add_to_log(
                 "get_all_offers",
                 (
-                    start,
-                    end,
-                    sort_key,
-                    reverse,
-                    file_contents,
-                    exclude_my_offers,
-                    exclude_taken_offers,
-                    include_completed,
+                    request.start,
+                    request.end,
+                    request.sort_key,
+                    request.reverse,
+                    request.file_contents,
+                    request.exclude_my_offers,
+                    request.exclude_taken_offers,
+                    request.include_completed,
                 ),
             )
             records: list[TradeRecord] = []
-            for i in reversed(range(start, end - 1)):  # reversed to match the sort order
+            for i in reversed(range(request.start, request.end - 1)):  # reversed to match the sort order
                 trade_offer = TradeRecord(
                     confirmed_at_index=uint32(0),
                     accepted_at_time=None,
@@ -997,7 +989,7 @@ async def get_all_offers(
                     ),
                 )
                 records.append(trade_offer)
-            return records
+            return GetAllOffersResponse([], records)
 
     inst_rpc_client = GetOffersRpcClient()
     test_rpc_clients.wallet_rpc_client = inst_rpc_client

chia/_tests/wallet/rpc/test_wallet_rpc.py

@@ -130,6 +130,7 @@
     DIDTransferDID,
     DIDUpdateMetadata,
     FungibleAsset,
+    GetAllOffers,
     GetCoinRecordsByNames,
     GetNextAddress,
     GetNotifications,
@@ -1555,7 +1556,7 @@ async def test_offer_endpoints(wallet_environments: WalletTestFramework, wallet_
         CreateOfferForIDs(offer={str(1): "-5", cat_asset_id.hex(): "1"}, validate_only=True),
         tx_config=wallet_environments.tx_config,
     )
-    all_offers = await env_1.rpc_client.get_all_offers()
+    all_offers = (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
     assert len(all_offers) == 0
 
     driver_dict = {
@@ -1599,7 +1600,7 @@ async def test_offer_endpoints(wallet_environments: WalletTestFramework, wallet_
     assert offer_validity_response.id == offer.name()
     assert offer_validity_response.valid
 
-    all_offers = await env_1.rpc_client.get_all_offers(file_contents=True)
+    all_offers = (await env_1.rpc_client.get_all_offers(GetAllOffers(file_contents=True))).trade_records
     assert len(all_offers) == 1
     assert TradeStatus(all_offers[0].status) == TradeStatus.PENDING_ACCEPT
     assert all_offers[0].offer == bytes(offer)
@@ -1638,7 +1639,7 @@ async def test_offer_endpoints(wallet_environments: WalletTestFramework, wallet_
         CreateOfferForIDs(offer={str(1): "-5", str(cat_wallet_id): "1"}, fee=uint64(1)),
         tx_config=wallet_environments.tx_config,
     )
-    all_offers = await env_1.rpc_client.get_all_offers()
+    all_offers = (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
     assert len(all_offers) == 2
     offer_count = await env_1.rpc_client.get_offers_count()
     assert offer_count.total == 2
@@ -1728,37 +1729,61 @@ def only_ids(trades: list[TradeRecord]) -> list[bytes32]:
         return [t.trade_id for t in trades]
 
     trade_record = (await env_1.rpc_client.get_offer(GetOffer(offer.name()))).trade_record
-    all_offers = await env_1.rpc_client.get_all_offers(include_completed=True)  # confirmed at index descending
+    all_offers = (  # confirmed at index descending
+        await env_1.rpc_client.get_all_offers(GetAllOffers(include_completed=True))
+    ).trade_records
     assert len(all_offers) == 2
     assert only_ids(all_offers) == only_ids([trade_record, new_trade_record])
-    all_offers = await env_1.rpc_client.get_all_offers(
-        include_completed=True, reverse=True
-    )  # confirmed at index ascending
+    all_offers = (  # confirmed at index ascending
+        await env_1.rpc_client.get_all_offers(GetAllOffers(include_completed=True, reverse=True))
+    ).trade_records
     assert only_ids(all_offers) == only_ids([new_trade_record, trade_record])
-    all_offers = await env_1.rpc_client.get_all_offers(include_completed=True, sort_key="RELEVANCE")  # most relevant
+    all_offers = (  # most relevant
+        await env_1.rpc_client.get_all_offers(GetAllOffers(include_completed=True, sort_key="RELEVANCE"))
+    ).trade_records
     assert only_ids(all_offers) == only_ids([new_trade_record, trade_record])
-    all_offers = await env_1.rpc_client.get_all_offers(
-        include_completed=True, sort_key="RELEVANCE", reverse=True
-    )  # least relevant
+    all_offers = (  # least relevant
+        await env_1.rpc_client.get_all_offers(GetAllOffers(include_completed=True, sort_key="RELEVANCE", reverse=True))
+    ).trade_records
     assert only_ids(all_offers) == only_ids([trade_record, new_trade_record])
     # Test pagination
-    all_offers = await env_1.rpc_client.get_all_offers(include_completed=True, start=0, end=1)
+    all_offers = (
+        await env_1.rpc_client.get_all_offers(GetAllOffers(include_completed=True, start=uint16(0), end=uint16(1)))
+    ).trade_records
     assert len(all_offers) == 1
-    all_offers = await env_1.rpc_client.get_all_offers(include_completed=True, start=50)
+    all_offers = (
+        await env_1.rpc_client.get_all_offers(GetAllOffers(include_completed=True, start=uint16(10)))
+    ).trade_records
     assert len(all_offers) == 0
-    all_offers = await env_1.rpc_client.get_all_offers(include_completed=True, start=0, end=50)
+    all_offers = (
+        await env_1.rpc_client.get_all_offers(GetAllOffers(include_completed=True, start=uint16(0), end=uint16(50)))
+    ).trade_records
     assert len(all_offers) == 2
 
     await env_1.rpc_client.create_offer_for_ids(
         CreateOfferForIDs(offer={str(1): "-5", cat_asset_id.hex(): "1"}, driver_dict=driver_dict),
         tx_config=wallet_environments.tx_config,
     )
     assert (
-        len([o for o in await env_1.rpc_client.get_all_offers() if o.status == TradeStatus.PENDING_ACCEPT.value]) == 2
+        len(
+            [
+                o
+                for o in (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
+                if o.status == TradeStatus.PENDING_ACCEPT.value
+            ]
+        )
+        == 2
     )
     await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, batch_size=1)
     assert (
-        len([o for o in await env_1.rpc_client.get_all_offers() if o.status == TradeStatus.PENDING_ACCEPT.value]) == 0
+        len(
+            [
+                o
+                for o in (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
+                if o.status == TradeStatus.PENDING_ACCEPT.value
+            ]
+        )
+        == 0
     )
     await wallet_environments.process_pending_states(
         [
@@ -1795,11 +1820,25 @@ def only_ids(trades: list[TradeRecord]) -> list[bytes32]:
         tx_config=wallet_environments.tx_config,
     )
     assert (
-        len([o for o in await env_1.rpc_client.get_all_offers() if o.status == TradeStatus.PENDING_ACCEPT.value]) == 2
+        len(
+            [
+                o
+                for o in (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
+                if o.status == TradeStatus.PENDING_ACCEPT.value
+            ]
+        )
+        == 2
     )
     await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, cancel_all=True)
     assert (
-        len([o for o in await env_1.rpc_client.get_all_offers() if o.status == TradeStatus.PENDING_ACCEPT.value]) == 0
+        len(
+            [
+                o
+                for o in (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
+                if o.status == TradeStatus.PENDING_ACCEPT.value
+            ]
+        )
+        == 0
     )
 
     await wallet_environments.process_pending_states(
@@ -1843,15 +1882,36 @@ def only_ids(trades: list[TradeRecord]) -> list[bytes32]:
         tx_config=wallet_environments.tx_config,
     )
     assert (
-        len([o for o in await env_1.rpc_client.get_all_offers() if o.status == TradeStatus.PENDING_ACCEPT.value]) == 1
+        len(
+            [
+                o
+                for o in (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
+                if o.status == TradeStatus.PENDING_ACCEPT.value
+            ]
+        )
+        == 1
     )
     await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, asset_id=bytes32.zeros)
     assert (
-        len([o for o in await env_1.rpc_client.get_all_offers() if o.status == TradeStatus.PENDING_ACCEPT.value]) == 1
+        len(
+            [
+                o
+                for o in (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
+                if o.status == TradeStatus.PENDING_ACCEPT.value
+            ]
+        )
+        == 1
     )
     await env_1.rpc_client.cancel_offers(wallet_environments.tx_config, asset_id=cat_asset_id)
     assert (
-        len([o for o in await env_1.rpc_client.get_all_offers() if o.status == TradeStatus.PENDING_ACCEPT.value]) == 0
+        len(
+            [
+                o
+                for o in (await env_1.rpc_client.get_all_offers(GetAllOffers())).trade_records
+                if o.status == TradeStatus.PENDING_ACCEPT.value
+            ]
+        )
+        == 0
     )
 
     with pytest.raises(ValueError, match="not currently supported"):

chia/cmds/wallet_funcs.py

@@ -64,6 +64,7 @@
     DIDUpdateMetadata,
     ExtendDerivationIndex,
     FungibleAsset,
+    GetAllOffers,
     GetNextAddress,
     GetNotifications,
     GetOffer,
@@ -769,16 +770,20 @@ async def get_offers(
 
             # Traverse offers page by page
             while True:
-                new_records: list[TradeRecord] = await wallet_client.get_all_offers(
-                    start,
-                    end,
-                    sort_key="RELEVANCE" if sort_by_relevance else "CONFIRMED_AT_HEIGHT",
-                    reverse=reverse,
-                    file_contents=file_contents,
-                    exclude_my_offers=exclude_my_offers,
-                    exclude_taken_offers=exclude_taken_offers,
-                    include_completed=include_completed,
-                )
+                new_records: list[TradeRecord] = (
+                    await wallet_client.get_all_offers(
+                        GetAllOffers(
+                            start=uint16(start),
+                            end=uint16(end),
+                            sort_key="RELEVANCE" if sort_by_relevance else "CONFIRMED_AT_HEIGHT",
+                            reverse=reverse,
+                            file_contents=file_contents,
+                            exclude_my_offers=exclude_my_offers,
+                            exclude_taken_offers=exclude_taken_offers,
+                            include_completed=include_completed,
+                        )
+                    )
+                ).trade_records
                 records.extend(new_records)
 
                 # If fewer records were returned than requested, we're done

chia/wallet/wallet_request_types.py

@@ -1982,6 +1982,42 @@ def from_json_dict(cls, json_dict: dict[str, Any]) -> Self:
         )
 
 
+@streamable
+@dataclass(frozen=True)
+class GetAllOffers(Streamable):
+    start: uint16 = uint16(0)
+    end: uint16 = uint16(10)
+    exclude_my_offers: bool = False
+    exclude_taken_offers: bool = False
+    include_completed: bool = False
+    sort_key: Optional[str] = None
+    reverse: bool = False
+    file_contents: bool = False
+
+
+@streamable
+@dataclass(frozen=True)
+class GetAllOffersResponse(Streamable):
+    offers: Optional[list[str]]
+    trade_records: list[TradeRecord]
+
+    def to_json_dict(self) -> dict[str, Any]:
+        return {**super().to_json_dict(), "trade_records": [tr.to_json_dict_convenience() for tr in self.trade_records]}
+
+    @classmethod
+    def from_json_dict(cls, json_dict: dict[str, Any]) -> Self:
+        return cls(
+            offers=json_dict["offers"],
+            trade_records=[
+                TradeRecord.from_json_dict_convenience(
+                    json_tr,
+                    bytes(Offer.from_bech32(json_dict["offers"][i])).hex() if json_dict["offers"] is not None else "",
+                )
+                for i, json_tr in enumerate(json_dict["trade_records"])
+            ],
+        )
+
+
 @streamable
 @dataclass(frozen=True)
 class CancelOfferResponse(TransactionEndpointResponse):

chia/wallet/wallet_rpc_api.py

@@ -187,6 +187,8 @@
     GatherSigningInfo,
     GatherSigningInfoResponse,
     GenerateMnemonicResponse,
+    GetAllOffers,
+    GetAllOffersResponse,
     GetCATListResponse,
     GetCoinRecordsByNames,
     GetCoinRecordsByNamesResponse,
@@ -2369,36 +2371,32 @@ async def get_offer(self, request: GetOffer) -> GetOfferResponse:
             trade_record,
         )
 
-    async def get_all_offers(self, request: dict[str, Any]) -> EndpointResult:
+    @marshal
+    async def get_all_offers(self, request: GetAllOffers) -> GetAllOffersResponse:
         trade_mgr = self.service.wallet_state_manager.trade_manager
 
-        start: int = request.get("start", 0)
-        end: int = request.get("end", 10)
-        exclude_my_offers: bool = request.get("exclude_my_offers", False)
-        exclude_taken_offers: bool = request.get("exclude_taken_offers", False)
-        include_completed: bool = request.get("include_completed", False)
-        sort_key: Optional[str] = request.get("sort_key", None)
-        reverse: bool = request.get("reverse", False)
-        file_contents: bool = request.get("file_contents", False)
-
         all_trades = await trade_mgr.trade_store.get_trades_between(
-            start,
-            end,
-            sort_key=sort_key,
-            reverse=reverse,
-            exclude_my_offers=exclude_my_offers,
-            exclude_taken_offers=exclude_taken_offers,
-            include_completed=include_completed,
+            request.start,
+            request.end,
+            sort_key=request.sort_key,
+            reverse=request.reverse,
+            exclude_my_offers=request.exclude_my_offers,
+            exclude_taken_offers=request.exclude_taken_offers,
+            include_completed=request.include_completed,
         )
         result = []
-        offer_values: Optional[list[str]] = [] if file_contents else None
+        offer_values: Optional[list[str]] = [] if request.file_contents else None
         for trade in all_trades:
-            result.append(trade.to_json_dict_convenience())
-            if file_contents and offer_values is not None:
+            result.append(trade)
+            if request.file_contents:
                 offer_to_return: bytes = trade.offer if trade.taken_offer is None else trade.taken_offer
-                offer_values.append(Offer.from_bytes(offer_to_return).to_bech32())
+                # semantics guarantee this to be not None
+                offer_values.append(Offer.from_bytes(offer_to_return).to_bech32())  # type: ignore[union-attr]
 
-        return {"trade_records": result, "offers": offer_values}
+        return GetAllOffersResponse(
+            trade_records=result,
+            offers=offer_values,
+        )
 
     @marshal
     async def get_offers_count(self, request: Empty) -> GetOffersCountResponse: