Skip to main content

nautilus_polymarket/websocket/
messages.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! WebSocket message types for the Polymarket CLOB API.
17
18use nautilus_core::{
19    serialization::deserialize_empty_string_as_none, string::secret::SecretString,
20};
21use rust_decimal::Decimal;
22use serde::{
23    Deserialize, Deserializer, Serialize, Serializer,
24    de::{
25        DeserializeSeed, MapAccess, Visitor,
26        value::{BorrowedStrDeserializer, MapAccessDeserializer},
27    },
28};
29use serde_json::value::RawValue;
30use ustr::Ustr;
31use zeroize::Zeroize;
32
33use crate::common::{
34    enums::{
35        PolymarketEventType, PolymarketLiquiditySide, PolymarketOrderSide, PolymarketOrderStatus,
36        PolymarketOrderType, PolymarketOutcome, PolymarketTradeStatus,
37    },
38    models::PolymarketMakerOrder,
39    parse::{
40        deserialize_decimal_from_str, deserialize_optional_decimal_from_str,
41        serialize_decimal_as_str, serialize_optional_decimal_as_str,
42    },
43};
44
45/// A user-channel order status and its optional venue reason suffix.
46#[derive(Clone, Debug, PartialEq, Eq)]
47pub struct PolymarketUserOrderStatus {
48    pub status: PolymarketOrderStatus,
49    pub reason: Option<String>,
50}
51
52impl PolymarketUserOrderStatus {
53    pub(crate) fn new(status: PolymarketOrderStatus, reason: Option<&str>) -> Self {
54        Self {
55            status,
56            reason: reason
57                .filter(|reason| !reason.trim().is_empty())
58                .map(str::to_string),
59        }
60    }
61}
62
63impl From<PolymarketOrderStatus> for PolymarketUserOrderStatus {
64    fn from(status: PolymarketOrderStatus) -> Self {
65        Self::new(status, None)
66    }
67}
68
69impl<'de> Deserialize<'de> for PolymarketUserOrderStatus {
70    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
71    where
72        D: Deserializer<'de>,
73    {
74        let raw = String::deserialize(deserializer)?;
75
76        PolymarketOrderStatus::parse_wire(&raw)
77            .map(|(status, reason)| Self::new(status, reason))
78            .ok_or_else(|| {
79                serde::de::Error::custom(format!("Unknown PolymarketOrderStatus: {raw}"))
80            })
81    }
82}
83
84impl Serialize for PolymarketUserOrderStatus {
85    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
86    where
87        S: Serializer,
88    {
89        match self.reason.as_deref() {
90            Some(reason) => serializer.serialize_str(&format!("{}_{reason}", self.status)),
91            None => self.status.serialize(serializer),
92        }
93    }
94}
95
96/// A user order status update from the WebSocket user channel.
97///
98/// References: <https://docs.polymarket.com/developers/CLOB/websocket/user-channel#order-message>
99#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
100pub struct PolymarketUserOrder {
101    pub asset_id: Ustr,
102    pub associate_trades: Option<Vec<String>>,
103    pub created_at: Option<String>,
104    pub expiration: Option<String>,
105    pub id: String,
106    pub maker_address: Option<Ustr>,
107    pub market: Ustr,
108    pub order_owner: Option<Ustr>,
109    pub order_type: Option<PolymarketOrderType>,
110    pub original_size: String,
111    pub outcome: Option<PolymarketOutcome>,
112    pub owner: Ustr,
113    pub price: String,
114    pub side: PolymarketOrderSide,
115    pub size_matched: String,
116    pub status: Option<PolymarketUserOrderStatus>,
117    pub timestamp: String,
118    #[serde(rename = "type")]
119    pub event_type: PolymarketEventType,
120}
121
122/// A user trade update from the WebSocket user channel.
123///
124/// References: <https://docs.polymarket.com/developers/CLOB/websocket/user-channel>
125#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
126pub struct PolymarketUserTrade {
127    pub asset_id: Ustr,
128    pub bucket_index: u64,
129    pub fee_rate_bps: String,
130    pub id: String,
131    pub last_update: String,
132    pub maker_address: Ustr,
133    pub maker_orders: Vec<PolymarketMakerOrder>,
134    pub market: Ustr,
135    pub match_time: String,
136    pub outcome: PolymarketOutcome,
137    pub owner: Ustr,
138    pub price: String,
139    pub side: PolymarketOrderSide,
140    pub size: String,
141    pub status: PolymarketTradeStatus,
142    pub taker_order_id: String,
143    pub timestamp: String,
144    pub trade_owner: Ustr,
145    #[serde(
146        default,
147        deserialize_with = "deserialize_empty_string_as_none",
148        skip_serializing_if = "Option::is_none"
149    )]
150    pub transaction_hash: Option<String>,
151    pub trader_side: PolymarketLiquiditySide,
152    #[serde(rename = "type")]
153    pub event_type: PolymarketEventType,
154}
155
156/// A single price level in an order book snapshot.
157#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
158pub struct PolymarketBookLevel {
159    pub price: String,
160    pub size: String,
161}
162
163/// An order book snapshot from the WebSocket market channel.
164#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
165pub struct PolymarketBookSnapshot {
166    pub market: Ustr,
167    pub asset_id: Ustr,
168    pub bids: Vec<PolymarketBookLevel>,
169    pub asks: Vec<PolymarketBookLevel>,
170    pub timestamp: String,
171    #[serde(default)]
172    pub hash: Option<String>,
173    #[serde(default)]
174    pub min_order_size: Option<String>,
175    #[serde(default)]
176    pub tick_size: Option<String>,
177    #[serde(default)]
178    pub neg_risk: Option<bool>,
179    #[serde(default)]
180    pub last_trade_price: Option<String>,
181    #[serde(default, skip_serializing_if = "Option::is_none")]
182    pub version: Option<String>,
183}
184
185/// A single price change entry within a quotes message.
186#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
187pub struct PolymarketQuote {
188    pub asset_id: Ustr,
189    pub price: String,
190    pub side: PolymarketOrderSide,
191    pub size: String,
192    pub hash: String,
193    #[serde(default)]
194    pub best_bid: Option<String>,
195    #[serde(default)]
196    pub best_ask: Option<String>,
197}
198
199/// A price change (quotes) message from the WebSocket market channel.
200#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
201pub struct PolymarketQuotes {
202    pub market: Ustr,
203    pub price_changes: Vec<PolymarketQuote>,
204    pub timestamp: String,
205}
206
207/// A last trade price message from the WebSocket market channel.
208#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
209pub struct PolymarketTrade {
210    pub market: Ustr,
211    pub asset_id: Ustr,
212    pub fee_rate_bps: String,
213    pub price: String,
214    pub side: PolymarketOrderSide,
215    pub size: String,
216    pub timestamp: String,
217    #[serde(default)]
218    pub transaction_hash: Option<String>,
219}
220
221/// A tick size change notification from the WebSocket market channel.
222#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
223pub struct PolymarketTickSizeChange {
224    pub market: Ustr,
225    pub asset_id: Ustr,
226    pub new_tick_size: String,
227    pub old_tick_size: String,
228    pub timestamp: String,
229}
230
231/// Event metadata embedded in a new market notification.
232#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
233pub struct PolymarketNewMarketEvent {
234    pub id: String,
235    pub ticker: String,
236    pub slug: String,
237    pub title: String,
238    pub description: String,
239}
240
241/// Fee configuration observed in a new market notification.
242#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
243pub struct PolymarketNewMarketFeeSchedule {
244    #[serde(
245        serialize_with = "serialize_decimal_as_str",
246        deserialize_with = "deserialize_decimal_from_str"
247    )]
248    pub exponent: Decimal,
249    #[serde(
250        serialize_with = "serialize_decimal_as_str",
251        deserialize_with = "deserialize_decimal_from_str"
252    )]
253    pub rate: Decimal,
254    pub taker_only: bool,
255    #[serde(
256        serialize_with = "serialize_decimal_as_str",
257        deserialize_with = "deserialize_decimal_from_str"
258    )]
259    pub rebate_rate: Decimal,
260}
261
262/// A new market notification from the WebSocket market channel.
263///
264/// Only received when `subscribe_new_markets` is enabled.
265#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
266pub struct PolymarketNewMarket {
267    pub id: String,
268    pub question: String,
269    pub market: Ustr,
270    pub slug: String,
271    pub description: String,
272    pub assets_ids: Vec<String>,
273    pub outcomes: Vec<String>,
274    pub timestamp: String,
275    pub tags: Vec<String>,
276    pub condition_id: String,
277    pub active: bool,
278    pub clob_token_ids: Vec<String>,
279    #[serde(default)]
280    pub order_price_min_tick_size: Option<String>,
281    #[serde(default)]
282    pub group_item_title: Option<String>,
283    #[serde(default)]
284    pub event_message: Option<PolymarketNewMarketEvent>,
285    #[serde(default)]
286    pub sports_market_type: Option<String>,
287    #[serde(default)]
288    pub line: Option<String>,
289    #[serde(default)]
290    pub game_start_time: Option<String>,
291    #[serde(
292        default,
293        skip_serializing_if = "Option::is_none",
294        serialize_with = "serialize_optional_decimal_as_str",
295        deserialize_with = "deserialize_optional_decimal_from_str"
296    )]
297    pub taker_base_fee: Option<Decimal>,
298    #[serde(default)]
299    pub fees_enabled: Option<bool>,
300    #[serde(default)]
301    pub fee_schedule: Option<PolymarketNewMarketFeeSchedule>,
302}
303
304/// A market resolved notification from the WebSocket market channel.
305///
306/// Only received when `subscribe_new_markets` is enabled.
307#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
308pub struct PolymarketMarketResolved {
309    pub id: String,
310    pub market: Ustr,
311    pub assets_ids: Vec<String>,
312    pub winning_asset_id: String,
313    pub winning_outcome: String,
314    pub timestamp: String,
315    pub tags: Vec<String>,
316}
317
318/// A best bid/ask notification from the WebSocket market channel.
319///
320/// Only received when `subscribe_new_markets` is enabled.
321/// The data adapter emits these events as quote ticks for active quote subscriptions.
322#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
323pub struct PolymarketBestBidAsk {
324    pub market: Ustr,
325    pub asset_id: Ustr,
326    pub best_bid: String,
327    pub best_ask: String,
328    pub spread: String,
329    pub timestamp: String,
330}
331
332/// An envelope for tagged WebSocket market channel messages.
333#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
334#[serde(tag = "event_type")]
335pub enum MarketWsMessage {
336    #[serde(rename = "book")]
337    Book(PolymarketBookSnapshot),
338    #[serde(rename = "price_change")]
339    PriceChange(PolymarketQuotes),
340    #[serde(rename = "last_trade_price")]
341    LastTradePrice(PolymarketTrade),
342    #[serde(rename = "tick_size_change")]
343    TickSizeChange(PolymarketTickSizeChange),
344    #[serde(rename = "new_market")]
345    NewMarket(Box<PolymarketNewMarket>),
346    #[serde(rename = "market_resolved")]
347    MarketResolved(PolymarketMarketResolved),
348    #[serde(rename = "best_bid_ask")]
349    BestBidAsk(PolymarketBestBidAsk),
350}
351
352struct PayloadMapAccess<A> {
353    inner: A,
354}
355
356impl<A> PayloadMapAccess<A> {
357    const fn new(inner: A) -> Self {
358        Self { inner }
359    }
360}
361
362impl<'de, A> MapAccess<'de> for PayloadMapAccess<A>
363where
364    A: MapAccess<'de>,
365{
366    type Error = A::Error;
367
368    fn next_key_seed<K>(&mut self, seed: K) -> Result<Option<K::Value>, Self::Error>
369    where
370        K: DeserializeSeed<'de>,
371    {
372        let Some(key) = self.inner.next_key::<&'de str>()? else {
373            return Ok(None);
374        };
375
376        if key == "event_type" {
377            return Err(serde::de::Error::duplicate_field("event_type"));
378        }
379
380        seed.deserialize(BorrowedStrDeserializer::new(key))
381            .map(Some)
382    }
383
384    fn next_value_seed<V>(&mut self, seed: V) -> Result<V::Value, Self::Error>
385    where
386        V: DeserializeSeed<'de>,
387    {
388        self.inner.next_value_seed(seed)
389    }
390
391    fn size_hint(&self) -> Option<usize> {
392        self.inner.size_hint()
393    }
394}
395
396struct MarketWsMessageVisitor;
397
398impl<'de> Visitor<'de> for MarketWsMessageVisitor {
399    type Value = MarketWsMessage;
400
401    fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
402        formatter.write_str("a Polymarket market-channel message with event_type first")
403    }
404
405    fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
406    where
407        A: MapAccess<'de>,
408    {
409        let Some(key) = map.next_key::<&str>()? else {
410            return Err(serde::de::Error::custom("expected event_type field"));
411        };
412
413        if key != "event_type" {
414            return Err(serde::de::Error::custom(
415                "event_type was not the first field",
416            ));
417        }
418
419        let event_type = map.next_value::<&str>()?;
420        let remaining = MapAccessDeserializer::new(PayloadMapAccess::new(map));
421        match event_type {
422            "book" => PolymarketBookSnapshot::deserialize(remaining).map(Self::Value::Book),
423            "price_change" => {
424                PolymarketQuotes::deserialize(remaining).map(Self::Value::PriceChange)
425            }
426            "last_trade_price" => {
427                PolymarketTrade::deserialize(remaining).map(Self::Value::LastTradePrice)
428            }
429            "tick_size_change" => {
430                PolymarketTickSizeChange::deserialize(remaining).map(Self::Value::TickSizeChange)
431            }
432            "new_market" => PolymarketNewMarket::deserialize(remaining)
433                .map(Box::new)
434                .map(Self::Value::NewMarket),
435            "market_resolved" => {
436                PolymarketMarketResolved::deserialize(remaining).map(Self::Value::MarketResolved)
437            }
438            "best_bid_ask" => {
439                PolymarketBestBidAsk::deserialize(remaining).map(Self::Value::BestBidAsk)
440            }
441            other => Err(serde::de::Error::unknown_variant(
442                other,
443                &[
444                    "book",
445                    "price_change",
446                    "last_trade_price",
447                    "tick_size_change",
448                    "new_market",
449                    "market_resolved",
450                    "best_bid_ask",
451                ],
452            )),
453        }
454    }
455}
456
457impl MarketWsMessage {
458    /// Parses a market-channel JSON message.
459    ///
460    /// # Errors
461    ///
462    /// Returns an error if `text` is not a valid market message.
463    pub fn parse(text: &str) -> serde_json::Result<Self> {
464        let mut deserializer = serde_json::Deserializer::from_str(text);
465        serde::Deserializer::deserialize_map(&mut deserializer, MarketWsMessageVisitor)
466            .and_then(|message| {
467                deserializer.end()?;
468                Ok(message)
469            })
470            .or_else(|_| Self::parse_reordered(text))
471            .or_else(|_| serde_json::from_str(text))
472    }
473
474    fn parse_reordered(text: &str) -> serde_json::Result<Self> {
475        let tag = serde_json::from_str::<MarketWsTag>(text)?;
476        match tag.event_type {
477            MarketWsEventTag::Book => serde_json::from_str(text).map(Self::Book),
478            MarketWsEventTag::PriceChange => serde_json::from_str(text).map(Self::PriceChange),
479            MarketWsEventTag::LastTradePrice => {
480                serde_json::from_str(text).map(Self::LastTradePrice)
481            }
482            MarketWsEventTag::TickSizeChange => {
483                serde_json::from_str(text).map(Self::TickSizeChange)
484            }
485            MarketWsEventTag::NewMarket => serde_json::from_str(text)
486                .map(Box::new)
487                .map(Self::NewMarket),
488            MarketWsEventTag::MarketResolved => {
489                serde_json::from_str(text).map(Self::MarketResolved)
490            }
491            MarketWsEventTag::BestBidAsk => serde_json::from_str(text).map(Self::BestBidAsk),
492        }
493    }
494}
495
496#[derive(Deserialize)]
497#[serde(rename_all = "snake_case")]
498enum MarketWsEventTag {
499    Book,
500    PriceChange,
501    LastTradePrice,
502    TickSizeChange,
503    NewMarket,
504    MarketResolved,
505    BestBidAsk,
506}
507
508#[derive(Deserialize)]
509struct MarketWsTag {
510    event_type: MarketWsEventTag,
511}
512
513/// An envelope for tagged WebSocket user channel messages.
514#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
515#[serde(tag = "event_type")]
516pub enum UserWsMessage {
517    #[serde(rename = "order")]
518    Order(PolymarketUserOrder),
519    #[serde(rename = "trade")]
520    Trade(PolymarketUserTrade),
521}
522
523struct UserWsMessageVisitor;
524
525impl<'de> Visitor<'de> for UserWsMessageVisitor {
526    type Value = UserWsMessage;
527
528    fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
529        formatter.write_str("a Polymarket user-channel message with event_type first")
530    }
531
532    fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
533    where
534        A: MapAccess<'de>,
535    {
536        let Some(key) = map.next_key::<&str>()? else {
537            return Err(serde::de::Error::custom("expected event_type field"));
538        };
539
540        if key != "event_type" {
541            return Err(serde::de::Error::custom(
542                "event_type was not the first field",
543            ));
544        }
545
546        let event_type = map.next_value::<&str>()?;
547        let remaining = MapAccessDeserializer::new(PayloadMapAccess::new(map));
548        match event_type {
549            "order" => PolymarketUserOrder::deserialize(remaining).map(Self::Value::Order),
550            "trade" => PolymarketUserTrade::deserialize(remaining).map(Self::Value::Trade),
551            other => Err(serde::de::Error::unknown_variant(
552                other,
553                &["order", "trade"],
554            )),
555        }
556    }
557}
558
559impl UserWsMessage {
560    /// Parses a user-channel JSON message.
561    ///
562    /// # Errors
563    ///
564    /// Returns an error if `text` is not a valid user message.
565    pub fn parse(text: &str) -> serde_json::Result<Self> {
566        let mut deserializer = serde_json::Deserializer::from_str(text);
567        serde::Deserializer::deserialize_map(&mut deserializer, UserWsMessageVisitor)
568            .and_then(|message| {
569                deserializer.end()?;
570                Ok(message)
571            })
572            .or_else(|_| Self::parse_reordered(text))
573            .or_else(|_| serde_json::from_str(text))
574    }
575
576    /// Parses a batch of user-channel JSON messages.
577    ///
578    /// Elements carrying an unrecognized `event_type` are skipped so that a single unknown
579    /// message cannot discard the valid `order` and `trade` messages batched alongside it.
580    ///
581    /// # Errors
582    ///
583    /// Returns an error if `text` is not a valid user-message batch.
584    pub fn parse_batch(text: &str) -> serde_json::Result<Vec<Self>> {
585        // Elements stay raw so the derived impl parses each one and rejects a duplicated
586        // `event_type`; `serde_json::Value` would silently keep the last occurrence.
587        let elements: Vec<&RawValue> = serde_json::from_str(text)?;
588        let mut messages = Vec::with_capacity(elements.len());
589        let mut skipped = 0usize;
590
591        for element in elements {
592            if Self::has_unrecognized_event_type(element.get()) {
593                skipped += 1;
594            } else {
595                messages.push(serde_json::from_str(element.get())?);
596            }
597        }
598
599        if skipped > 0 {
600            log::debug!("Skipped {skipped} user WS message(s) with an unrecognized event_type");
601        }
602
603        Ok(messages)
604    }
605
606    pub(crate) fn has_unrecognized_event_type(text: &str) -> bool {
607        /// Reads only the tag, to classify a message before deserializing it.
608        #[derive(Deserialize)]
609        struct EventTypeTag {
610            event_type: Option<String>,
611        }
612
613        serde_json::from_str::<EventTypeTag>(text).is_ok_and(|tag| {
614            tag.event_type
615                .is_some_and(|event_type| !matches!(event_type.as_str(), "order" | "trade"))
616        })
617    }
618
619    fn parse_reordered(text: &str) -> serde_json::Result<Self> {
620        let tag = serde_json::from_str::<UserWsTag>(text)?;
621        match tag.event_type {
622            UserWsEventTag::Order => serde_json::from_str(text).map(Self::Order),
623            UserWsEventTag::Trade => serde_json::from_str(text).map(Self::Trade),
624        }
625    }
626}
627
628#[derive(Deserialize)]
629#[serde(rename_all = "snake_case")]
630enum UserWsEventTag {
631    Order,
632    Trade,
633}
634
635#[derive(Deserialize)]
636struct UserWsTag {
637    event_type: UserWsEventTag,
638}
639
640/// Output message type from the Polymarket WebSocket handler.
641#[derive(Debug)]
642pub enum PolymarketWsMessage {
643    Market(MarketWsMessage),
644    User(UserWsMessage),
645    /// Emitted when the underlying WebSocket reconnects.
646    ///
647    /// `shard_id` identifies the market pool shard that reconnected. Direct
648    /// clients without pool routing emit `None`.
649    Reconnected {
650        shard_id: Option<usize>,
651    },
652}
653
654/// Auth payload embedded in user-channel subscribe messages.
655#[derive(Debug, Serialize, Zeroize)]
656pub struct PolymarketWsAuth {
657    #[serde(rename = "apiKey")]
658    pub api_key: SecretString,
659    pub secret: SecretString,
660    pub passphrase: SecretString,
661}
662
663/// Initial market-channel subscribe request sent for a fresh WebSocket session.
664///
665/// Wire format: `{"assets_ids": [...], "type": "market", "initial_dump": true}`
666/// When `custom_feature_enabled` is true, enables new-market, market-resolved, and best-bid/ask
667/// events.
668#[derive(Debug, Serialize)]
669pub struct MarketInitialSubscribeRequest {
670    pub assets_ids: Vec<String>,
671    #[serde(rename = "type")]
672    pub msg_type: &'static str,
673    pub initial_dump: bool,
674    #[serde(skip_serializing_if = "std::ops::Not::not")]
675    pub custom_feature_enabled: bool,
676}
677
678/// Incremental market-channel subscribe request sent after the initial session subscribe.
679///
680/// Wire format: `{"assets_ids": [...], "operation": "subscribe", "initial_dump": true}`
681/// When `custom_feature_enabled` is true, enables new-market, market-resolved, and best-bid/ask
682/// events.
683#[derive(Debug, Serialize)]
684pub struct MarketSubscribeRequest {
685    pub assets_ids: Vec<String>,
686    pub operation: &'static str,
687    pub initial_dump: bool,
688    #[serde(skip_serializing_if = "std::ops::Not::not")]
689    pub custom_feature_enabled: bool,
690}
691
692/// Market-channel dynamic unsubscribe request sent during an active session.
693///
694/// Wire format: `{"assets_ids": [...], "operation": "unsubscribe"}`
695#[derive(Debug, Serialize)]
696pub struct MarketUnsubscribeRequest {
697    pub assets_ids: Vec<String>,
698    pub operation: &'static str,
699}
700
701/// User-channel subscribe request sent on connect.
702///
703/// Wire format: `{"auth": {...}, "type": "user"}`
704#[derive(Debug, Serialize, Zeroize)]
705pub struct UserSubscribeRequest {
706    pub auth: PolymarketWsAuth,
707    #[serde(rename = "type")]
708    #[zeroize(skip)]
709    pub msg_type: &'static str,
710}
711
712#[cfg(test)]
713mod tests {
714    use rstest::rstest;
715
716    use super::*;
717    use crate::common::enums::{
718        PolymarketEventType, PolymarketLiquiditySide, PolymarketOrderSide, PolymarketOrderStatus,
719        PolymarketOrderType, PolymarketOutcome, PolymarketTradeStatus,
720    };
721
722    #[rstest]
723    fn user_subscribe_request_matches_all_markets_wire_format() {
724        let request = UserSubscribeRequest {
725            auth: PolymarketWsAuth {
726                api_key: SecretString::from("fixture-key"),
727                secret: SecretString::from("fixture-secret"),
728                passphrase: SecretString::from("fixture-passphrase"),
729            },
730            msg_type: "user",
731        };
732
733        assert_eq!(
734            serde_json::to_value(request).unwrap(),
735            serde_json::json!({
736                "auth": {
737                    "apiKey": "fixture-key",
738                    "secret": "fixture-secret",
739                    "passphrase": "fixture-passphrase",
740                },
741                "type": "user",
742            }),
743        );
744    }
745
746    fn load<T: serde::de::DeserializeOwned>(filename: &str) -> T {
747        let path = format!("test_data/{filename}");
748        let content = std::fs::read_to_string(path).expect("Failed to read test data");
749        serde_json::from_str(&content).expect("Failed to parse test data")
750    }
751
752    fn load_text(filename: &str) -> String {
753        let path = format!("test_data/{filename}");
754        std::fs::read_to_string(path).expect("Failed to read test data")
755    }
756
757    /// An `auto_redeem` user-channel event as observed from the venue, which is undocumented and
758    /// not modeled by [`UserWsMessage`].
759    fn auto_redeem_element() -> serde_json::Value {
760        serde_json::json!({
761            "event_type": "auto_redeem",
762            "proxy_wallet": "0x0000000000000000000000000000000000000000",
763            "txn_hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
764            "amount": "70",
765            "condition_id": "0xb88862256916cb0c82e72667bd43f3e6cfe94cd7d5cda0bf763ec82394021e07",
766            "question": "Bitcoin Up or Down - August 17, 9:35AM-9:40AM ET",
767            "slug": "btc-updown-5m-1786973700",
768            "neg_risk": false,
769            "timestamp": "1786974414920",
770            "position_id": "",
771            "outcome_index": 0,
772            "legs": 0,
773            "owner": "00000000-0000-0000-0000-000000000000",
774        })
775    }
776
777    #[rstest]
778    fn test_book_snapshot() {
779        let snap: PolymarketBookSnapshot = load("ws_book_snapshot.json");
780
781        assert_eq!(
782            snap.asset_id,
783            "71321045679252212594626385532706912750332728571942532289631379312455583992563"
784        );
785        assert_eq!(snap.bids.len(), 3);
786        assert_eq!(snap.asks.len(), 3);
787        assert_eq!(snap.bids[0].price, "0.48");
788        assert_eq!(snap.bids[0].size, "500.0");
789        assert_eq!(snap.asks[0].price, "0.53");
790        assert_eq!(snap.timestamp, "1703875200000");
791        assert!(snap.hash.is_none());
792        assert!(snap.min_order_size.is_none());
793        assert!(snap.tick_size.is_none());
794        assert!(snap.neg_risk.is_none());
795        assert!(snap.last_trade_price.is_none());
796    }
797
798    #[rstest]
799    fn test_book_snapshot_roundtrip() {
800        let snap: PolymarketBookSnapshot = load("ws_book_snapshot.json");
801        let json = serde_json::to_string(&snap).unwrap();
802        let snap2: PolymarketBookSnapshot = serde_json::from_str(&json).unwrap();
803        assert_eq!(snap, snap2);
804    }
805
806    #[rstest]
807    fn test_quotes() {
808        let quotes: PolymarketQuotes = load("ws_quotes.json");
809
810        assert_eq!(quotes.price_changes.len(), 2);
811        assert_eq!(quotes.price_changes[0].side, PolymarketOrderSide::Buy);
812        assert_eq!(quotes.price_changes[0].price, "0.51");
813        assert_eq!(quotes.price_changes[0].best_bid.as_deref(), Some("0.51"));
814        assert_eq!(quotes.price_changes[0].best_ask.as_deref(), Some("0.52"));
815        assert_eq!(quotes.price_changes[1].side, PolymarketOrderSide::Sell);
816        assert_eq!(quotes.timestamp, "1703875201000");
817    }
818
819    #[rstest]
820    fn test_last_trade() {
821        let trade: PolymarketTrade = load("ws_last_trade.json");
822
823        assert_eq!(trade.price, "0.51");
824        assert_eq!(trade.size, "25.0");
825        assert_eq!(trade.side, PolymarketOrderSide::Buy);
826        assert_eq!(trade.fee_rate_bps, "0");
827        assert_eq!(trade.timestamp, "1703875202000");
828        assert_eq!(
829            trade.transaction_hash.as_deref(),
830            Some("0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab")
831        );
832    }
833
834    #[rstest]
835    fn test_optional_market_hash_fields_default() {
836        let snap: PolymarketBookSnapshot = load("ws_book_snapshot_missing_hash.json");
837        let trade: PolymarketTrade = load("ws_last_trade_missing_transaction_hash.json");
838
839        assert!(snap.hash.is_none());
840        assert!(snap.min_order_size.is_none());
841        assert!(snap.tick_size.is_none());
842        assert!(snap.neg_risk.is_none());
843        assert!(snap.last_trade_price.is_none());
844        assert!(trade.transaction_hash.is_none());
845    }
846
847    #[rstest]
848    fn test_tick_size_change() {
849        let msg: PolymarketTickSizeChange = load("ws_tick_size_change.json");
850
851        assert_eq!(msg.new_tick_size, "0.01");
852        assert_eq!(msg.old_tick_size, "0.1");
853        assert_eq!(msg.timestamp, "1703875210000");
854    }
855
856    #[rstest]
857    fn test_user_order_placement() {
858        let order: PolymarketUserOrder = load("ws_user_order_placement.json");
859
860        assert_eq!(order.event_type, PolymarketEventType::Placement);
861        assert_eq!(
862            order.status.as_ref().map(|status| status.status),
863            Some(PolymarketOrderStatus::Live)
864        );
865        assert_eq!(order.side, PolymarketOrderSide::Buy);
866        assert_eq!(order.order_type, Some(PolymarketOrderType::GTC));
867        assert_eq!(order.outcome, Some(PolymarketOutcome::yes()));
868        assert_eq!(order.original_size, "100.0");
869        assert_eq!(order.size_matched, "0.0");
870        assert!(order.associate_trades.is_none());
871        assert!(order.expiration.is_none());
872    }
873
874    #[rstest]
875    fn test_user_order_update() {
876        let order: PolymarketUserOrder = load("ws_user_order_update.json");
877
878        assert_eq!(order.event_type, PolymarketEventType::Update);
879        assert_eq!(order.size_matched, "25.0");
880        assert_eq!(
881            order.associate_trades.as_deref(),
882            Some(&["trade-0xabcdef1234".to_string()][..])
883        );
884    }
885
886    #[rstest]
887    fn test_user_order_cancellation() {
888        let order: PolymarketUserOrder = load("ws_user_order_cancellation.json");
889
890        assert_eq!(order.event_type, PolymarketEventType::Cancellation);
891        assert_eq!(
892            order.status.as_ref().map(|status| status.status),
893            Some(PolymarketOrderStatus::Canceled)
894        );
895        assert_eq!(order.size_matched, "0.0");
896    }
897
898    #[rstest]
899    fn test_user_order_status_preserves_rejection_reason() {
900        let raw = "UNMATCHED_invalid post-only order: order crosses book";
901        let status: PolymarketUserOrderStatus =
902            serde_json::from_str(&format!("\"{raw}\"")).unwrap();
903
904        assert_eq!(status.status, PolymarketOrderStatus::Unmatched);
905        assert_eq!(
906            status.reason.as_deref(),
907            Some("invalid post-only order: order crosses book")
908        );
909        assert_eq!(
910            serde_json::to_string(&status).unwrap(),
911            format!("\"{raw}\"")
912        );
913    }
914
915    /// Repro for issue #3987: venue cancels a FOK order with a status field
916    /// containing a trailing reason ("CANCELED_<reason>") and empty fields
917    /// on `size_matched`, `outcome`, and `created_at`.
918    #[rstest]
919    fn test_user_order_fok_killed() {
920        let msg: UserWsMessage = load("ws_user_order_fok_killed.json");
921
922        let UserWsMessage::Order(order) = msg else {
923            panic!("Expected UserWsMessage::Order");
924        };
925        assert_eq!(order.event_type, PolymarketEventType::Cancellation);
926        assert_eq!(
927            order.status.as_ref().map(|status| status.status),
928            Some(PolymarketOrderStatus::Canceled)
929        );
930        assert_eq!(
931            order
932                .status
933                .as_ref()
934                .and_then(|status| status.reason.as_deref()),
935            Some("order couldn't be fully filled. FOK orders are fully filled or killed.")
936        );
937        assert_eq!(order.order_type, Some(PolymarketOrderType::FOK));
938        assert_eq!(order.size_matched, "");
939        assert_eq!(order.created_at.as_deref(), Some(""));
940        assert_eq!(
941            order.outcome.as_ref().map(PolymarketOutcome::as_str),
942            Some("")
943        );
944    }
945
946    #[rstest]
947    fn test_user_trade() {
948        let trade: PolymarketUserTrade = load("ws_user_trade.json");
949
950        assert_eq!(trade.event_type, PolymarketEventType::Trade);
951        assert_eq!(trade.status, PolymarketTradeStatus::Confirmed);
952        assert_eq!(trade.side, PolymarketOrderSide::Buy);
953        assert_eq!(trade.trader_side, PolymarketLiquiditySide::Taker);
954        assert_eq!(trade.price, "0.5");
955        assert_eq!(trade.size, "25.0");
956        assert_eq!(trade.fee_rate_bps, "0");
957        assert_eq!(trade.bucket_index, 1);
958        assert_eq!(trade.maker_orders.len(), 1);
959        assert_eq!(
960            trade.transaction_hash.as_deref(),
961            Some("0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab")
962        );
963        assert_eq!(
964            trade.taker_order_id,
965            "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef12"
966        );
967    }
968
969    #[rstest]
970    fn test_user_trade_missing_transaction_hash() {
971        let mut value: serde_json::Value = load("ws_user_trade.json");
972        value
973            .as_object_mut()
974            .expect("trade fixture should be an object")
975            .remove("transaction_hash");
976
977        let trade: PolymarketUserTrade =
978            serde_json::from_value(value).expect("trade fixture should deserialize");
979
980        assert!(trade.transaction_hash.is_none());
981    }
982
983    #[rstest]
984    fn test_market_ws_message_book() {
985        let msg: MarketWsMessage = load("ws_market_book_msg.json");
986
987        assert!(matches!(msg, MarketWsMessage::Book(_)));
988        if let MarketWsMessage::Book(snap) = msg {
989            assert_eq!(snap.bids.len(), 2);
990            assert_eq!(snap.asks.len(), 2);
991            assert_eq!(snap.timestamp, "1703875200000");
992        }
993    }
994
995    #[rstest]
996    #[case("ws_market_book_msg.json")]
997    #[case("ws_market_price_change_msg.json")]
998    #[case("ws_market_last_trade_msg.json")]
999    #[case("ws_market_tick_size_msg.json")]
1000    #[case("ws_market_new_market_msg.json")]
1001    #[case("ws_market_resolved_msg.json")]
1002    #[case("ws_market_best_bid_ask_msg.json")]
1003    fn test_market_ws_message_parse(#[case] filename: &str) {
1004        let text = load_text(filename);
1005        let expected: MarketWsMessage =
1006            serde_json::from_str(&text).expect("market fixture should deserialize");
1007
1008        let actual = MarketWsMessage::parse(&text).expect("market fixture should parse");
1009
1010        assert_eq!(actual, expected);
1011    }
1012
1013    #[rstest]
1014    fn test_market_ws_message_parse_with_reordered_event_type() {
1015        let expected: MarketWsMessage = load("ws_market_book_msg.json");
1016        let mut value: serde_json::Value = load("ws_market_book_msg.json");
1017        let object = value
1018            .as_object_mut()
1019            .expect("market fixture should be an object");
1020        let event_type = object
1021            .remove("event_type")
1022            .expect("market fixture should contain event_type");
1023        object.insert("event_type".to_string(), event_type);
1024        let text = serde_json::to_string(&value).expect("market fixture should serialize");
1025
1026        assert!(!text.starts_with(r#"{"event_type":"#));
1027        assert_eq!(
1028            MarketWsMessage::parse(&text).expect("reordered market fixture should parse"),
1029            expected
1030        );
1031    }
1032
1033    #[rstest]
1034    fn test_market_ws_message_parse_rejects_duplicate_event_type() {
1035        let text = load_text("ws_market_book_msg.json").replacen(
1036            r#""event_type": "book","#,
1037            r#""event_type": "book", "event_type": "book","#,
1038            1,
1039        );
1040        let expected = serde_json::from_str::<MarketWsMessage>(&text)
1041            .expect_err("derived parser should reject a duplicate event_type");
1042        let actual = MarketWsMessage::parse(&text)
1043            .expect_err("optimized parser should reject a duplicate event_type");
1044
1045        assert_eq!(actual.to_string(), expected.to_string());
1046    }
1047
1048    #[rstest]
1049    fn test_market_ws_message_price_change() {
1050        let msg: MarketWsMessage = load("ws_market_price_change_msg.json");
1051
1052        assert!(matches!(msg, MarketWsMessage::PriceChange(_)));
1053        if let MarketWsMessage::PriceChange(quotes) = msg {
1054            assert_eq!(quotes.price_changes.len(), 1);
1055        }
1056    }
1057
1058    #[rstest]
1059    fn test_market_ws_message_last_trade_price() {
1060        let msg: MarketWsMessage = load("ws_market_last_trade_msg.json");
1061
1062        assert!(matches!(msg, MarketWsMessage::LastTradePrice(_)));
1063        if let MarketWsMessage::LastTradePrice(trade) = msg {
1064            assert_eq!(trade.price, "0.51");
1065        }
1066    }
1067
1068    #[rstest]
1069    fn test_market_ws_message_tick_size_change() {
1070        let msg: MarketWsMessage = load("ws_market_tick_size_msg.json");
1071
1072        assert!(matches!(msg, MarketWsMessage::TickSizeChange(_)));
1073        if let MarketWsMessage::TickSizeChange(change) = msg {
1074            assert_eq!(change.new_tick_size, "0.01");
1075            assert_eq!(change.old_tick_size, "0.1");
1076        }
1077    }
1078
1079    #[rstest]
1080    fn test_user_ws_message_order() {
1081        let msg: UserWsMessage = load("ws_user_order_msg.json");
1082
1083        let UserWsMessage::Order(order) = msg else {
1084            panic!("expected order message");
1085        };
1086        assert_eq!(
1087            order.asset_id,
1088            "10000000000000000000000000000000000000000000000000000000000000000000000000001"
1089        );
1090        assert_eq!(order.associate_trades, Some(Vec::new()));
1091        assert_eq!(order.created_at.as_deref(), Some(""));
1092        assert_eq!(order.expiration.as_deref(), Some("0"));
1093        assert_eq!(
1094            order.id,
1095            "0x1111111111111111111111111111111111111111111111111111111111111111"
1096        );
1097        assert_eq!(
1098            order.maker_address.as_ref().map(Ustr::as_str),
1099            Some("0x1111111111111111111111111111111111111111")
1100        );
1101        assert_eq!(
1102            order.market,
1103            "0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
1104        );
1105        assert_eq!(
1106            order.order_owner.as_ref().map(Ustr::as_str),
1107            Some("11111111-2222-3333-4444-555555555555")
1108        );
1109        assert_eq!(order.order_type, Some(PolymarketOrderType::FOK));
1110        assert_eq!(order.original_size, "1");
1111        assert_eq!(
1112            order.outcome.as_ref().map(PolymarketOutcome::as_str),
1113            Some("")
1114        );
1115        assert_eq!(order.owner, "11111111-2222-3333-4444-555555555555");
1116        assert_eq!(order.price, "0.01");
1117        assert_eq!(order.side, PolymarketOrderSide::Buy);
1118        assert_eq!(order.size_matched, "");
1119        assert_eq!(
1120            order.status.as_ref().map(|status| status.status),
1121            Some(PolymarketOrderStatus::Canceled)
1122        );
1123        assert_eq!(order.timestamp, "1786179547007");
1124        assert_eq!(order.event_type, PolymarketEventType::Cancellation);
1125    }
1126
1127    #[rstest]
1128    fn test_user_ws_message_order_optional_fields_absent() {
1129        // Constructed from the documented required field set
1130        let json = r#"{
1131            "event_type":"order",
1132            "id":"order-1",
1133            "owner":"owner-1",
1134            "market":"market-1",
1135            "asset_id":"asset-1",
1136            "side":"SELL",
1137            "original_size":"2",
1138            "size_matched":"0",
1139            "price":"0.5",
1140            "type":"PLACEMENT",
1141            "timestamp":"1786179547008"
1142        }"#;
1143        let UserWsMessage::Order(order) = serde_json::from_str(json).unwrap() else {
1144            panic!("expected order message");
1145        };
1146
1147        assert_eq!(order.asset_id, "asset-1");
1148        assert!(order.associate_trades.is_none());
1149        assert!(order.created_at.is_none());
1150        assert!(order.expiration.is_none());
1151        assert_eq!(order.id, "order-1");
1152        assert!(order.maker_address.is_none());
1153        assert_eq!(order.market, "market-1");
1154        assert!(order.order_owner.is_none());
1155        assert!(order.order_type.is_none());
1156        assert_eq!(order.original_size, "2");
1157        assert!(order.outcome.is_none());
1158        assert_eq!(order.owner, "owner-1");
1159        assert_eq!(order.price, "0.5");
1160        assert_eq!(order.side, PolymarketOrderSide::Sell);
1161        assert_eq!(order.size_matched, "0");
1162        assert!(order.status.is_none());
1163        assert_eq!(order.timestamp, "1786179547008");
1164        assert_eq!(order.event_type, PolymarketEventType::Placement);
1165    }
1166
1167    #[rstest]
1168    fn test_user_ws_message_trade() {
1169        let msg: UserWsMessage = load("ws_user_trade_msg.json");
1170
1171        assert!(matches!(msg, UserWsMessage::Trade(_)));
1172        if let UserWsMessage::Trade(trade) = msg {
1173            assert_eq!(trade.event_type, PolymarketEventType::Trade);
1174            assert_eq!(trade.status, PolymarketTradeStatus::Confirmed);
1175            assert!(trade.transaction_hash.is_none());
1176        }
1177    }
1178
1179    #[rstest]
1180    #[case("ws_user_order_msg.json")]
1181    #[case("ws_user_order_fok_killed.json")]
1182    #[case("ws_user_trade_msg.json")]
1183    fn test_user_ws_message_parse(#[case] filename: &str) {
1184        let text = load_text(filename);
1185        let expected: UserWsMessage =
1186            serde_json::from_str(&text).expect("user fixture should deserialize");
1187
1188        let actual = UserWsMessage::parse(&text).expect("user fixture should parse");
1189
1190        assert_eq!(actual, expected);
1191    }
1192
1193    #[rstest]
1194    fn test_user_ws_message_parse_with_reordered_event_type() {
1195        let expected: UserWsMessage = load("ws_user_trade_msg.json");
1196        let mut value: serde_json::Value = load("ws_user_trade_msg.json");
1197        let object = value
1198            .as_object_mut()
1199            .expect("user fixture should be an object");
1200        let event_type = object
1201            .remove("event_type")
1202            .expect("user fixture should contain event_type");
1203        object.insert("event_type".to_string(), event_type);
1204        let text = serde_json::to_string(&value).expect("user fixture should serialize");
1205
1206        assert!(!text.starts_with(r#"{"event_type":"#));
1207        assert_eq!(
1208            UserWsMessage::parse(&text).expect("reordered user fixture should parse"),
1209            expected
1210        );
1211    }
1212
1213    #[rstest]
1214    fn test_user_ws_message_parse_rejects_duplicate_event_type() {
1215        let text = load_text("ws_user_order_msg.json").replacen(
1216            r#""event_type": "order""#,
1217            r#""event_type": "order", "event_type": "order""#,
1218            1,
1219        );
1220        let expected = serde_json::from_str::<UserWsMessage>(&text)
1221            .expect_err("derived parser should reject a duplicate event_type");
1222        let actual = UserWsMessage::parse(&text)
1223            .expect_err("optimized parser should reject a duplicate event_type");
1224
1225        assert_eq!(actual.to_string(), expected.to_string());
1226    }
1227
1228    #[rstest]
1229    fn test_user_ws_message_parse_batch() {
1230        let text = load_text("ws_user_batch_msg.json");
1231        let expected: Vec<UserWsMessage> =
1232            serde_json::from_str(&text).expect("user batch fixture should deserialize");
1233
1234        let actual = UserWsMessage::parse_batch(&text).expect("user batch fixture should parse");
1235
1236        assert_eq!(actual, expected);
1237    }
1238
1239    #[rstest]
1240    fn test_user_ws_message_parse_batch_with_reordered_event_type() {
1241        let expected: Vec<UserWsMessage> = load("ws_user_batch_msg.json");
1242        let mut value: serde_json::Value = load("ws_user_batch_msg.json");
1243        let first = value
1244            .as_array_mut()
1245            .expect("user batch fixture should be an array")[0]
1246            .as_object_mut()
1247            .expect("user batch element should be an object");
1248        let event_type = first
1249            .remove("event_type")
1250            .expect("user batch element should contain event_type");
1251        first.insert("event_type".to_string(), event_type);
1252        let text = serde_json::to_string(&value).expect("user batch fixture should serialize");
1253
1254        assert_eq!(
1255            UserWsMessage::parse_batch(&text).expect("reordered user batch should parse"),
1256            expected
1257        );
1258    }
1259
1260    #[rstest]
1261    fn test_user_ws_message_parse_batch_rejects_invalid_element() {
1262        let mut value: serde_json::Value = load("ws_user_batch_msg.json");
1263        value
1264            .as_array_mut()
1265            .expect("user batch fixture should be an array")[1]
1266            .as_object_mut()
1267            .expect("user batch element should be an object")
1268            .remove("event_type");
1269        let text = serde_json::to_string(&value).expect("user batch fixture should serialize");
1270
1271        assert!(UserWsMessage::parse_batch(&text).is_err());
1272    }
1273
1274    /// A duplicated `event_type` is malformed and must be rejected, matching
1275    /// [`UserWsMessage::parse`].
1276    #[rstest]
1277    fn test_user_ws_message_parse_batch_rejects_duplicate_event_type() {
1278        let element = load_text("ws_user_order_msg.json").replacen(
1279            r#""event_type": "order""#,
1280            r#""event_type": "order", "event_type": "order""#,
1281            1,
1282        );
1283        let text = format!("[{element}]");
1284
1285        assert!(UserWsMessage::parse_batch(&text).is_err());
1286    }
1287
1288    /// Polymarket emits undocumented user-channel events such as `auto_redeem`, which must not
1289    /// discard the `order` and `trade` messages batched alongside them.
1290    #[rstest]
1291    fn test_user_ws_message_parse_batch_skips_unknown_event_type() {
1292        let expected: Vec<UserWsMessage> = load("ws_user_batch_msg.json");
1293        let mut value: serde_json::Value = load("ws_user_batch_msg.json");
1294        let elements = value
1295            .as_array_mut()
1296            .expect("user batch fixture should be an array");
1297        elements.insert(1, auto_redeem_element());
1298        let text = serde_json::to_string(&value).expect("user batch fixture should serialize");
1299
1300        let actual =
1301            UserWsMessage::parse_batch(&text).expect("batch with unknown event_type should parse");
1302
1303        assert_eq!(actual, expected);
1304    }
1305
1306    #[rstest]
1307    fn test_user_ws_message_parse_batch_all_unknown_event_types() {
1308        let text = serde_json::to_string(&serde_json::Value::Array(vec![
1309            auto_redeem_element(),
1310            auto_redeem_element(),
1311        ]))
1312        .expect("unknown batch should serialize");
1313
1314        let actual =
1315            UserWsMessage::parse_batch(&text).expect("batch of unknown event types should parse");
1316
1317        assert!(actual.is_empty());
1318    }
1319
1320    #[rstest]
1321    #[case::auto_redeem(auto_redeem_element().to_string(), true)]
1322    #[case::order(load_text("ws_user_order_msg.json"), false)]
1323    #[case::trade(load_text("ws_user_trade_msg.json"), false)]
1324    #[case::missing_event_type(serde_json::json!({"type": "order"}).to_string(), false)]
1325    #[case::not_an_object(serde_json::json!([]).to_string(), false)]
1326    fn test_user_ws_message_has_unrecognized_event_type(
1327        #[case] text: String,
1328        #[case] expected: bool,
1329    ) {
1330        assert_eq!(UserWsMessage::has_unrecognized_event_type(&text), expected);
1331    }
1332
1333    #[rstest]
1334    fn test_market_ws_message_new_market() {
1335        let msg: MarketWsMessage = load("ws_market_new_market_msg.json");
1336        let raw: serde_json::Value = load("ws_market_new_market_msg.json");
1337
1338        let MarketWsMessage::NewMarket(nm) = msg else {
1339            panic!("expected new market message");
1340        };
1341        assert_eq!(nm.id, "market-001");
1342        assert_eq!(
1343            nm.question,
1344            "Map 1 Rounds Handicap: Sangal (-6.5) vs zeste (+6.5)"
1345        );
1346        assert_eq!(
1347            nm.market,
1348            "0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
1349        );
1350        assert_eq!(nm.slug, "sanitized-new-market");
1351        assert_eq!(nm.description, raw["description"].as_str().unwrap());
1352        assert_eq!(
1353            nm.assets_ids,
1354            vec![
1355                "10000000000000000000000000000000000000000000000000000000000000000000000000001",
1356                "10000000000000000000000000000000000000000000000000000000000000000000000000002",
1357            ]
1358        );
1359        assert_eq!(nm.outcomes, vec!["Sangal", "zeste"]);
1360        assert_eq!(nm.timestamp, "1786179115414");
1361        assert!(nm.tags.is_empty());
1362        assert_eq!(
1363            nm.condition_id,
1364            "0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
1365        );
1366        assert!(!nm.active);
1367        assert_eq!(nm.clob_token_ids, nm.assets_ids);
1368        assert_eq!(nm.order_price_min_tick_size.as_deref(), Some("0.01"));
1369        assert_eq!(
1370            nm.group_item_title.as_deref(),
1371            Some("Map 1 Rounds Handicap: Sangal (-6.5) vs zeste (+6.5)")
1372        );
1373        assert_eq!(
1374            nm.sports_market_type.as_deref(),
1375            Some("round_handicap_game_1")
1376        );
1377        assert_eq!(nm.line.as_deref(), Some("-6.5"));
1378        assert_eq!(
1379            nm.game_start_time.as_deref(),
1380            Some("2026-08-08 09:00:00+00")
1381        );
1382        assert_eq!(nm.taker_base_fee, Some(Decimal::from(1000)));
1383        assert_eq!(nm.fees_enabled, Some(true));
1384        let schedule = nm.fee_schedule.as_ref().expect("captured fee schedule");
1385        assert_eq!(schedule.exponent, Decimal::ONE);
1386        assert_eq!(schedule.rate, Decimal::new(5, 2));
1387        assert!(schedule.taker_only);
1388        assert_eq!(schedule.rebate_rate, Decimal::new(15, 2));
1389        let event = nm.event_message.as_ref().expect("captured event metadata");
1390        assert_eq!(event.id, "event-001");
1391        assert_eq!(event.ticker, "sanitized-event");
1392        assert_eq!(event.slug, "sanitized-event");
1393        assert_eq!(
1394            event.title,
1395            "Counter-Strike: Sangal vs zeste (BO3) - Esports World Cup Open Qualifier Group 16"
1396        );
1397        assert_eq!(
1398            event.description,
1399            raw["event_message"]["description"].as_str().unwrap()
1400        );
1401    }
1402
1403    #[rstest]
1404    fn test_market_ws_message_resolved() {
1405        let msg: MarketWsMessage = load("ws_market_resolved_msg.json");
1406
1407        assert!(matches!(msg, MarketWsMessage::MarketResolved(_)));
1408        if let MarketWsMessage::MarketResolved(mr) = msg {
1409            assert_eq!(mr.id, "1031769");
1410            assert_eq!(mr.winning_outcome, "Yes");
1411            assert_eq!(mr.assets_ids.len(), 2);
1412            assert_eq!(
1413                mr.winning_asset_id,
1414                "76043073756653678226373981964075571318267289248134717369284518995922789326425"
1415            );
1416        }
1417    }
1418
1419    #[rstest]
1420    fn test_market_ws_message_best_bid_ask() {
1421        let msg: MarketWsMessage = load("ws_market_best_bid_ask_msg.json");
1422
1423        assert!(matches!(msg, MarketWsMessage::BestBidAsk(_)));
1424        if let MarketWsMessage::BestBidAsk(bba) = msg {
1425            assert_eq!(bba.best_bid, "0.73");
1426            assert_eq!(bba.best_ask, "0.77");
1427            assert_eq!(bba.spread, "0.04");
1428        }
1429    }
1430}