lightcone-sdk 0.1.9

Rust SDK for the Lightcone Protcol
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
//! Message handlers for WebSocket events.
//!
//! Routes incoming messages to appropriate handlers and emits events.

use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::RwLock;

use crate::websocket::error::WebSocketError;
use crate::websocket::state::{LocalOrderbook, PriceHistory, UserState};
use crate::websocket::state::price::PriceHistoryKey;
use crate::websocket::types::{
    BookUpdateData, ErrorData, MarketEventData, MessageType, PriceHistoryData, RawWsMessage,
    TradeData, UserEventData, WsEvent,
};

/// Handles incoming WebSocket messages
#[derive(Debug)]
pub struct MessageHandler {
    /// Local orderbook state
    orderbooks: Arc<RwLock<HashMap<String, LocalOrderbook>>>,
    /// Local user state
    user_states: Arc<RwLock<HashMap<String, UserState>>>,
    /// Price history state
    price_histories: Arc<RwLock<HashMap<PriceHistoryKey, PriceHistory>>>,
    /// Currently subscribed user (single user per connection)
    subscribed_user: Arc<RwLock<Option<String>>>,
}

impl MessageHandler {
    /// Create a new message handler with shared state
    pub fn new(
        orderbooks: Arc<RwLock<HashMap<String, LocalOrderbook>>>,
        user_states: Arc<RwLock<HashMap<String, UserState>>>,
        price_histories: Arc<RwLock<HashMap<PriceHistoryKey, PriceHistory>>>,
        subscribed_user: Arc<RwLock<Option<String>>>,
    ) -> Self {
        Self {
            orderbooks,
            user_states,
            price_histories,
            subscribed_user,
        }
    }

    /// Handle an incoming message and return events
    pub async fn handle_message(&self, text: &str) -> Vec<WsEvent> {
        // Parse the raw message first
        let raw_msg: RawWsMessage = match serde_json::from_str(text) {
            Ok(msg) => msg,
            Err(e) => {
                tracing::warn!("Failed to parse WebSocket message: {}", e);
                return vec![WsEvent::Error {
                    error: WebSocketError::MessageParseError(e.to_string()),
                }];
            }
        };

        // Route by message type
        let msg_type = MessageType::from(raw_msg.type_.as_str());
        match msg_type {
            MessageType::BookUpdate => self.handle_book_update(&raw_msg).await,
            MessageType::Trades => self.handle_trade(&raw_msg).await,
            MessageType::User => self.handle_user_event(&raw_msg).await,
            MessageType::PriceHistory => self.handle_price_history(&raw_msg).await,
            MessageType::Market => self.handle_market_event(&raw_msg).await,
            MessageType::Error => self.handle_error(&raw_msg).await,
            MessageType::Pong => vec![WsEvent::Pong],
            MessageType::Unknown => {
                tracing::warn!("Unknown message type: {}", raw_msg.type_);
                vec![]
            }
        }
    }

    /// Handle book update message
    async fn handle_book_update(&self, raw_msg: &RawWsMessage) -> Vec<WsEvent> {
        let data: BookUpdateData = match serde_json::from_value(raw_msg.data.clone()) {
            Ok(data) => data,
            Err(e) => {
                tracing::warn!("Failed to parse book update: {}", e);
                return vec![WsEvent::Error {
                    error: WebSocketError::MessageParseError(e.to_string()),
                }];
            }
        };

        // Check for resync signal
        if data.resync {
            tracing::info!("Resync required for orderbook: {}", data.orderbook_id);
            return vec![WsEvent::ResyncRequired {
                orderbook_id: data.orderbook_id.clone(),
            }];
        }

        let orderbook_id = data.orderbook_id.clone();
        let is_snapshot = data.is_snapshot;

        // Update local state
        let mut orderbooks = self.orderbooks.write().await;
        let book = orderbooks
            .entry(orderbook_id.clone())
            .or_insert_with(|| LocalOrderbook::new(orderbook_id.clone()));

        match book.apply_update(&data) {
            Ok(()) => {
                vec![WsEvent::BookUpdate {
                    orderbook_id,
                    is_snapshot,
                }]
            }
            Err(WebSocketError::SequenceGap { expected, received }) => {
                tracing::warn!(
                    "Sequence gap in orderbook {}: expected {}, received {}",
                    orderbook_id,
                    expected,
                    received
                );
                // Clear the orderbook state on sequence gap
                book.clear();
                vec![WsEvent::ResyncRequired { orderbook_id }]
            }
            Err(e) => {
                vec![WsEvent::Error { error: e }]
            }
        }
    }

    /// Handle trade message
    async fn handle_trade(&self, raw_msg: &RawWsMessage) -> Vec<WsEvent> {
        let data: TradeData = match serde_json::from_value(raw_msg.data.clone()) {
            Ok(data) => data,
            Err(e) => {
                tracing::warn!("Failed to parse trade: {}", e);
                return vec![WsEvent::Error {
                    error: WebSocketError::MessageParseError(e.to_string()),
                }];
            }
        };

        vec![WsEvent::Trade {
            orderbook_id: data.orderbook_id.clone(),
            trade: data,
        }]
    }

    /// Handle user event message
    async fn handle_user_event(&self, raw_msg: &RawWsMessage) -> Vec<WsEvent> {
        let data: UserEventData = match serde_json::from_value(raw_msg.data.clone()) {
            Ok(data) => data,
            Err(e) => {
                tracing::warn!("Failed to parse user event: {}", e);
                return vec![WsEvent::Error {
                    error: WebSocketError::MessageParseError(e.to_string()),
                }];
            }
        };

        let event_type = data.event_type.clone();

        // Use the tracked subscribed user (single user per connection)
        let user = {
            let subscribed_user = self.subscribed_user.read().await;
            subscribed_user
                .clone()
                .unwrap_or_else(|| "unknown".to_string())
        };

        // Check if user state exists (read lock, released quickly)
        let needs_warning = {
            let user_states = self.user_states.read().await;
            !user_states.contains_key(&user)
        };

        // Update local state for the subscribed user (write lock only if needed)
        if !needs_warning {
            let mut user_states = self.user_states.write().await;
            if let Some(state) = user_states.get_mut(&user) {
                state.apply_event(&data);
            }
        }

        // Log AFTER releasing lock to avoid holding lock during I/O
        if needs_warning {
            tracing::warn!(
                "Received user event '{}' for user '{}' but no subscription exists. \
                 Call subscribe_user() before receiving events to avoid data loss.",
                event_type,
                user
            );
        }

        vec![WsEvent::UserUpdate { event_type, user }]
    }

    /// Handle price history message
    async fn handle_price_history(&self, raw_msg: &RawWsMessage) -> Vec<WsEvent> {
        let data: PriceHistoryData = match serde_json::from_value(raw_msg.data.clone()) {
            Ok(data) => data,
            Err(e) => {
                tracing::warn!("Failed to parse price history: {}", e);
                return vec![WsEvent::Error {
                    error: WebSocketError::MessageParseError(e.to_string()),
                }];
            }
        };

        // Heartbeats don't have orderbook_id
        if data.event_type == "heartbeat" {
            // Update all price histories with heartbeat
            let mut histories = self.price_histories.write().await;
            for history in histories.values_mut() {
                history.apply_heartbeat(&data);
            }
            return vec![];
        }

        let orderbook_id = match &data.orderbook_id {
            Some(id) => id.clone(),
            None => {
                tracing::warn!("Price history message missing orderbook_id");
                return vec![];
            }
        };

        let resolution = data.resolution.clone().unwrap_or_else(|| "1m".to_string());

        // Update local state
        let mut histories = self.price_histories.write().await;
        let key = PriceHistoryKey::new(orderbook_id.clone(), resolution.clone());

        if let Some(history) = histories.get_mut(&key) {
            history.apply_event(&data);
        } else {
            // Create new history if this is a snapshot
            if data.event_type == "snapshot" {
                let mut history = PriceHistory::new(
                    orderbook_id.clone(),
                    resolution.clone(),
                    data.include_ohlcv.unwrap_or(false),
                );
                history.apply_event(&data);
                histories.insert(key, history);
            } else {
                tracing::warn!(
                    "Received price history event '{}' for orderbook '{}' resolution '{}' \
                     but no subscription exists. Event dropped.",
                    data.event_type,
                    orderbook_id,
                    resolution
                );
            }
        }

        vec![WsEvent::PriceUpdate {
            orderbook_id,
            resolution,
        }]
    }

    /// Handle market event message
    async fn handle_market_event(&self, raw_msg: &RawWsMessage) -> Vec<WsEvent> {
        let data: MarketEventData = match serde_json::from_value(raw_msg.data.clone()) {
            Ok(data) => data,
            Err(e) => {
                tracing::warn!("Failed to parse market event: {}", e);
                return vec![WsEvent::Error {
                    error: WebSocketError::MessageParseError(e.to_string()),
                }];
            }
        };

        vec![WsEvent::MarketEvent {
            event_type: data.event_type,
            market_pubkey: data.market_pubkey,
        }]
    }

    /// Handle error message from server
    async fn handle_error(&self, raw_msg: &RawWsMessage) -> Vec<WsEvent> {
        let data: ErrorData = match serde_json::from_value(raw_msg.data.clone()) {
            Ok(data) => data,
            Err(e) => {
                tracing::warn!("Failed to parse error: {}", e);
                return vec![WsEvent::Error {
                    error: WebSocketError::MessageParseError(e.to_string()),
                }];
            }
        };

        tracing::error!("Server error: {} (code: {})", data.error, data.code);

        vec![WsEvent::Error {
            error: WebSocketError::ServerError {
                code: data.code,
                message: data.error,
            },
        }]
    }

    /// Initialize orderbook state for a subscription.
    ///
    /// This must be called before subscribing to orderbook updates to ensure
    /// the local state exists when the first snapshot arrives. If not called,
    /// the handler will create the state on first message, but there may be
    /// a brief window where `get_orderbook()` returns `None`.
    ///
    /// Uses atomic entry API to avoid race conditions with message handlers.
    /// Thread-safe: multiple concurrent calls are safe due to interior write lock.
    pub async fn init_orderbook(&self, orderbook_id: &str) {
        let mut orderbooks = self.orderbooks.write().await;
        orderbooks
            .entry(orderbook_id.to_string())
            .or_insert_with(|| LocalOrderbook::new(orderbook_id.to_string()));
    }

    /// Initialize user state for a subscription.
    ///
    /// This must be called before subscribing to user events to ensure state
    /// is ready when the first event arrives. Also sets the tracked user for
    /// this connection (single user per connection model).
    ///
    /// Thread-safe: uses interior write locks for both the subscribed user
    /// tracking and the user state map. Multiple concurrent calls are safe
    /// but will serialize on lock acquisition. State mutations from incoming
    /// events are applied atomically via the same lock.
    pub async fn init_user_state(&self, user: &str) {
        // Track the subscribed user
        *self.subscribed_user.write().await = Some(user.to_string());

        let mut user_states = self.user_states.write().await;
        user_states
            .entry(user.to_string())
            .or_insert_with(|| UserState::new(user.to_string()));
    }

    /// Clear the subscribed user
    pub async fn clear_subscribed_user(&self, user: &str) {
        let mut subscribed = self.subscribed_user.write().await;
        if subscribed.as_deref() == Some(user) {
            *subscribed = None;
        }
    }

    /// Initialize price history state for a subscription.
    ///
    /// Creates an empty price history container for the given orderbook and
    /// resolution. The actual price data will be populated when the snapshot
    /// message arrives from the server.
    ///
    /// # Arguments
    ///
    /// * `orderbook_id` - The orderbook identifier (e.g., "BTC-USD:main")
    /// * `resolution` - The candle resolution (e.g., "1m", "5m", "1h", "1d")
    /// * `include_ohlcv` - Whether OHLCV candle data should be tracked
    ///
    /// # Example
    ///
    /// ```ignore
    /// handler.init_price_history("BTC-USD:main", "1m", true).await;
    /// ```
    pub async fn init_price_history(
        &self,
        orderbook_id: &str,
        resolution: &str,
        include_ohlcv: bool,
    ) {
        let key = PriceHistoryKey::new(orderbook_id.to_string(), resolution.to_string());
        let mut histories = self.price_histories.write().await;
        histories.entry(key).or_insert_with(|| {
            PriceHistory::new(orderbook_id.to_string(), resolution.to_string(), include_ohlcv)
        });
    }

    /// Clear orderbook state
    pub async fn clear_orderbook(&self, orderbook_id: &str) {
        let mut orderbooks = self.orderbooks.write().await;
        if let Some(book) = orderbooks.get_mut(orderbook_id) {
            book.clear();
        }
    }

    /// Clear user state
    pub async fn clear_user_state(&self, user: &str) {
        let mut user_states = self.user_states.write().await;
        if let Some(state) = user_states.get_mut(user) {
            state.clear();
        }
    }

    /// Clear price history state
    pub async fn clear_price_history(&self, orderbook_id: &str, resolution: &str) {
        let key = PriceHistoryKey::new(orderbook_id.to_string(), resolution.to_string());
        let mut histories = self.price_histories.write().await;
        if let Some(history) = histories.get_mut(&key) {
            history.clear();
        }
    }

    /// Clear all state
    pub async fn clear_all(&self) {
        self.orderbooks.write().await.clear();
        self.user_states.write().await.clear();
        self.price_histories.write().await.clear();
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    async fn create_handler() -> MessageHandler {
        MessageHandler::new(
            Arc::new(RwLock::new(HashMap::new())),
            Arc::new(RwLock::new(HashMap::new())),
            Arc::new(RwLock::new(HashMap::new())),
            Arc::new(RwLock::new(None)),
        )
    }

    #[tokio::test]
    async fn test_handle_book_update_snapshot() {
        let handler = create_handler().await;

        let msg = r#"{
            "type": "book_update",
            "version": 0.1,
            "data": {
                "orderbook_id": "ob1",
                "timestamp": "2024-01-01T00:00:00.000Z",
                "sequence": 0,
                "bids": [{"side": "bid", "price": "0.500000", "size": "0.001000"}],
                "asks": [{"side": "ask", "price": "0.510000", "size": "0.000500"}],
                "is_snapshot": true
            }
        }"#;

        let events = handler.handle_message(msg).await;
        assert_eq!(events.len(), 1);

        match &events[0] {
            WsEvent::BookUpdate { orderbook_id, is_snapshot } => {
                assert_eq!(orderbook_id, "ob1");
                assert!(*is_snapshot);
            }
            _ => panic!("Expected BookUpdate event"),
        }
    }

    #[tokio::test]
    async fn test_handle_resync() {
        let handler = create_handler().await;

        let msg = r#"{
            "type": "book_update",
            "version": 0.1,
            "data": {
                "orderbook_id": "ob1",
                "resync": true,
                "message": "Please re-subscribe to get fresh snapshot"
            }
        }"#;

        let events = handler.handle_message(msg).await;
        assert_eq!(events.len(), 1);

        match &events[0] {
            WsEvent::ResyncRequired { orderbook_id } => {
                assert_eq!(orderbook_id, "ob1");
            }
            _ => panic!("Expected ResyncRequired event"),
        }
    }

    #[tokio::test]
    async fn test_handle_trade() {
        let handler = create_handler().await;

        let msg = r#"{
            "type": "trades",
            "version": 0.1,
            "data": {
                "orderbook_id": "ob1",
                "price": "0.505000",
                "size": "0.000250",
                "side": "bid",
                "timestamp": "2024-01-01T00:00:00.000Z",
                "trade_id": "trade123",
                "sequence": 1
            }
        }"#;

        let events = handler.handle_message(msg).await;
        assert_eq!(events.len(), 1);

        match &events[0] {
            WsEvent::Trade { orderbook_id, trade } => {
                assert_eq!(orderbook_id, "ob1");
                assert_eq!(trade.price, "0.505000");
                assert_eq!(trade.size, "0.000250");
            }
            _ => panic!("Expected Trade event"),
        }
    }

    #[tokio::test]
    async fn test_handle_pong() {
        let handler = create_handler().await;

        let msg = r#"{
            "type": "pong",
            "version": 0.1,
            "data": {}
        }"#;

        let events = handler.handle_message(msg).await;
        assert_eq!(events.len(), 1);
        assert!(matches!(events[0], WsEvent::Pong));
    }

    #[tokio::test]
    async fn test_handle_error() {
        let handler = create_handler().await;

        let msg = r#"{
            "type": "error",
            "version": 0.1,
            "data": {
                "error": "Engine unavailable",
                "code": "ENGINE_UNAVAILABLE"
            }
        }"#;

        let events = handler.handle_message(msg).await;
        assert_eq!(events.len(), 1);

        match &events[0] {
            WsEvent::Error { error } => {
                match error {
                    WebSocketError::ServerError { code, message } => {
                        assert_eq!(code, "ENGINE_UNAVAILABLE");
                        assert_eq!(message, "Engine unavailable");
                    }
                    _ => panic!("Expected ServerError"),
                }
            }
            _ => panic!("Expected Error event"),
        }
    }

    #[tokio::test]
    async fn test_handle_invalid_json() {
        let handler = create_handler().await;

        let msg = "not valid json";

        let events = handler.handle_message(msg).await;
        assert_eq!(events.len(), 1);
        assert!(matches!(events[0], WsEvent::Error { .. }));
    }
}