webull-rs 0.1.0

A Rust client for the Webull trading API
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
use crate::auth::{AuthManager, AccessToken};
use crate::error::{WebullError, WebullResult};
use crate::streaming::events::{Event, EventType, ConnectionState, ConnectionStatus, ErrorEvent, HeartbeatEvent};
use crate::streaming::subscription::{SubscriptionRequest, UnsubscriptionRequest};
use crate::utils::serialization::{from_json, to_json};
use futures_util::{SinkExt, StreamExt};
use reqwest::header::{HeaderMap, HeaderValue, AUTHORIZATION};
use serde_json::json;
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};
use tokio::net::TcpStream;
use tokio::sync::mpsc::{self, Receiver, Sender};
use tokio::time::sleep;
use tokio_tungstenite::{connect_async, tungstenite::protocol::Message, MaybeTlsStream, WebSocketStream};
use url::Url;
use uuid::Uuid;

/// WebSocket client for streaming data from Webull.
pub struct WebSocketClient {
    /// Base URL for WebSocket connections
    base_url: String,

    /// Authentication manager
    auth_manager: Arc<AuthManager>,

    /// Connection state
    connection_state: Arc<Mutex<ConnectionState>>,

    /// Event sender
    event_sender: Option<Sender<Event>>,

    /// Last heartbeat time
    last_heartbeat: Arc<Mutex<Instant>>,

    /// Heartbeat interval in seconds
    heartbeat_interval: u64,

    /// Reconnect attempts
    reconnect_attempts: Arc<Mutex<u32>>,

    /// Maximum reconnect attempts
    max_reconnect_attempts: u32,

    /// Reconnect delay in seconds
    reconnect_delay: u64,
}

impl WebSocketClient {
    /// Create a new WebSocket client.
    pub fn new(base_url: String, auth_manager: Arc<AuthManager>) -> Self {
        Self {
            base_url,
            auth_manager,
            connection_state: Arc::new(Mutex::new(ConnectionState::Disconnected)),
            event_sender: None,
            last_heartbeat: Arc::new(Mutex::new(Instant::now())),
            heartbeat_interval: 30,
            reconnect_attempts: Arc::new(Mutex::new(0)),
            max_reconnect_attempts: 5,
            reconnect_delay: 5,
        }
    }

    /// Connect to the WebSocket server.
    pub async fn connect(&mut self) -> WebullResult<Receiver<Event>> {
        // Create a channel for events
        let (tx, rx) = mpsc::channel(100);
        self.event_sender = Some(tx.clone());

        // Set the connection state to reconnecting
        *self.connection_state.lock().unwrap() = ConnectionState::Reconnecting;

        // Reset reconnect attempts
        *self.reconnect_attempts.lock().unwrap() = 0;

        // Start the connection task
        let base_url = self.base_url.clone();
        let auth_manager = self.auth_manager.clone();
        let connection_state = self.connection_state.clone();
        let last_heartbeat = self.last_heartbeat.clone();
        let heartbeat_interval = self.heartbeat_interval;
        let reconnect_attempts = self.reconnect_attempts.clone();
        let max_reconnect_attempts = self.max_reconnect_attempts;
        let reconnect_delay = self.reconnect_delay;

        tokio::spawn(async move {
            loop {
                // Check if we've exceeded the maximum reconnect attempts
                let attempts = *reconnect_attempts.lock().unwrap();
                if attempts > max_reconnect_attempts {
                    // Send a connection failed event
                    let event = Event {
                        event_type: EventType::Connection,
                        timestamp: chrono::Utc::now(),
                        data: crate::streaming::events::EventData::Connection(ConnectionStatus {
                            status: ConnectionState::Failed,
                            connection_id: None,
                            message: Some("Maximum reconnect attempts exceeded".to_string()),
                        }),
                    };

                    let _ = tx.send(event).await;

                    // Set the connection state to failed
                    *connection_state.lock().unwrap() = ConnectionState::Failed;

                    break;
                }

                // Increment reconnect attempts
                *reconnect_attempts.lock().unwrap() = attempts + 1;

                // Get the authentication token
                let token = match auth_manager.get_token().await {
                    Ok(token) => token,
                    Err(e) => {
                        // Send an error event
                        let event = Event {
                            event_type: EventType::Error,
                            timestamp: chrono::Utc::now(),
                            data: crate::streaming::events::EventData::Error(ErrorEvent {
                                code: "AUTH_ERROR".to_string(),
                                message: format!("Authentication error: {}", e),
                            }),
                        };

                        let _ = tx.send(event).await;

                        // Wait before retrying
                        sleep(Duration::from_secs(reconnect_delay)).await;
                        continue;
                    }
                };

                // Connect to the WebSocket server
                match Self::connect_websocket(&base_url, &token).await {
                    Ok(ws_stream) => {
                        // Set the connection state to connected
                        *connection_state.lock().unwrap() = ConnectionState::Connected;

                        // Reset reconnect attempts
                        *reconnect_attempts.lock().unwrap() = 0;

                        // Send a connection established event
                        let connection_id = Uuid::new_v4().to_string();
                        let event = Event {
                            event_type: EventType::Connection,
                            timestamp: chrono::Utc::now(),
                            data: crate::streaming::events::EventData::Connection(ConnectionStatus {
                                status: ConnectionState::Connected,
                                connection_id: Some(connection_id.clone()),
                                message: Some("Connection established".to_string()),
                            }),
                        };

                        let _ = tx.send(event).await;

                        // Handle the WebSocket connection
                        if let Err(e) = Self::handle_websocket(ws_stream, tx.clone(), last_heartbeat.clone(), heartbeat_interval).await {
                            // Send an error event
                            let event = Event {
                                event_type: EventType::Error,
                                timestamp: chrono::Utc::now(),
                                data: crate::streaming::events::EventData::Error(ErrorEvent {
                                    code: "WS_ERROR".to_string(),
                                    message: format!("WebSocket error: {}", e),
                                }),
                            };

                            let _ = tx.send(event).await;
                        }

                        // Set the connection state to disconnected
                        *connection_state.lock().unwrap() = ConnectionState::Disconnected;

                        // Send a disconnection event
                        let event = Event {
                            event_type: EventType::Connection,
                            timestamp: chrono::Utc::now(),
                            data: crate::streaming::events::EventData::Connection(ConnectionStatus {
                                status: ConnectionState::Disconnected,
                                connection_id: Some(connection_id),
                                message: Some("Connection closed".to_string()),
                            }),
                        };

                        let _ = tx.send(event).await;
                    }
                    Err(e) => {
                        // Send an error event
                        let event = Event {
                            event_type: EventType::Error,
                            timestamp: chrono::Utc::now(),
                            data: crate::streaming::events::EventData::Error(ErrorEvent {
                                code: "WS_CONNECT_ERROR".to_string(),
                                message: format!("WebSocket connection error: {}", e),
                            }),
                        };

                        let _ = tx.send(event).await;
                    }
                }

                // Wait before reconnecting
                sleep(Duration::from_secs(reconnect_delay)).await;

                // Set the connection state to reconnecting
                *connection_state.lock().unwrap() = ConnectionState::Reconnecting;

                // Send a reconnecting event
                let event = Event {
                    event_type: EventType::Connection,
                    timestamp: chrono::Utc::now(),
                    data: crate::streaming::events::EventData::Connection(ConnectionStatus {
                        status: ConnectionState::Reconnecting,
                        connection_id: None,
                        message: Some("Reconnecting...".to_string()),
                    }),
                };

                let _ = tx.send(event).await;
            }
        });

        Ok(rx)
    }

    /// Disconnect from the WebSocket server.
    pub async fn disconnect(&mut self) -> WebullResult<()> {
        // Set the connection state to disconnected
        *self.connection_state.lock().unwrap() = ConnectionState::Disconnected;

        // Reset reconnect attempts
        *self.reconnect_attempts.lock().unwrap() = self.max_reconnect_attempts + 1;

        Ok(())
    }

    /// Subscribe to a topic.
    pub async fn subscribe(&self, request: SubscriptionRequest) -> WebullResult<()> {
        // Check if we're connected
        if *self.connection_state.lock().unwrap() != ConnectionState::Connected {
            return Err(WebullError::InvalidRequest("Not connected to WebSocket server".to_string()));
        }

        // Send the subscription request
        let message = json!({
            "action": "SUBSCRIBE",
            "request": request,
        });

        // Send the message
        if let Some(tx) = &self.event_sender {
            let _message_str = to_json(&message)?;

            // Create a heartbeat event
            let event = Event {
                event_type: EventType::Heartbeat,
                timestamp: chrono::Utc::now(),
                data: crate::streaming::events::EventData::Heartbeat(HeartbeatEvent {
                    id: Uuid::new_v4().to_string(),
                }),
            };

            tx.send(event).await.map_err(|e| WebullError::InvalidRequest(format!("Failed to send message: {}", e)))?;
        }

        Ok(())
    }

    /// Unsubscribe from a topic.
    pub async fn unsubscribe(&self, request: UnsubscriptionRequest) -> WebullResult<()> {
        // Check if we're connected
        if *self.connection_state.lock().unwrap() != ConnectionState::Connected {
            return Err(WebullError::InvalidRequest("Not connected to WebSocket server".to_string()));
        }

        // Send the unsubscription request
        let message = json!({
            "action": "UNSUBSCRIBE",
            "request": request,
        });

        // Send the message
        if let Some(tx) = &self.event_sender {
            let _message_str = to_json(&message)?;

            // Create a heartbeat event
            let event = Event {
                event_type: EventType::Heartbeat,
                timestamp: chrono::Utc::now(),
                data: crate::streaming::events::EventData::Heartbeat(HeartbeatEvent {
                    id: Uuid::new_v4().to_string(),
                }),
            };

            tx.send(event).await.map_err(|e| WebullError::InvalidRequest(format!("Failed to send message: {}", e)))?;
        }

        Ok(())
    }

    /// Connect to the WebSocket server.
    async fn connect_websocket(base_url: &str, token: &AccessToken) -> WebullResult<WebSocketStream<MaybeTlsStream<TcpStream>>> {
        // Create the WebSocket URL
        let ws_url = format!("{}/ws", base_url.replace("http", "ws"));
        let url = Url::parse(&ws_url).map_err(|e| WebullError::InvalidRequest(format!("Invalid WebSocket URL: {}", e)))?;

        // Create the request headers
        let mut headers = HeaderMap::new();
        headers.insert(AUTHORIZATION, HeaderValue::from_str(&format!("Bearer {}", token.token)).unwrap());

        // Connect to the WebSocket server
        let (ws_stream, _) = connect_async(url).await.map_err(|e| WebullError::InvalidRequest(format!("WebSocket connection error: {}", e)))?;

        Ok(ws_stream)
    }

    /// Handle the WebSocket connection.
    async fn handle_websocket(
        mut ws_stream: WebSocketStream<MaybeTlsStream<TcpStream>>,
        tx: Sender<Event>,
        last_heartbeat: Arc<Mutex<Instant>>,
        heartbeat_interval: u64,
    ) -> WebullResult<()> {
        // Start the heartbeat task
        let tx_clone = tx.clone();
        let last_heartbeat_clone = last_heartbeat.clone();

        tokio::spawn(async move {
            loop {
                // Sleep for the heartbeat interval
                sleep(Duration::from_secs(heartbeat_interval)).await;

                // Check if we need to send a heartbeat
                let now = Instant::now();
                let last = *last_heartbeat_clone.lock().unwrap();

                if now.duration_since(last).as_secs() >= heartbeat_interval {
                    // Create a heartbeat message
                    let heartbeat = json!({
                        "type": "HEARTBEAT",
                        "id": Uuid::new_v4().to_string(),
                    });

                    // Send the heartbeat message
                    let _message = Message::Text(to_json(&heartbeat).unwrap());

                    // Create a heartbeat event
                    let event = Event {
                        event_type: EventType::Heartbeat,
                        timestamp: chrono::Utc::now(),
                        data: crate::streaming::events::EventData::Heartbeat(HeartbeatEvent {
                            id: Uuid::new_v4().to_string(),
                        }),
                    };

                    // Send the heartbeat event
                    if tx_clone.send(event).await.is_err() {
                        // Channel closed, exit the task
                        break;
                    }

                    // Update the last heartbeat time
                    *last_heartbeat_clone.lock().unwrap() = now;
                }
            }
        });

        // Handle incoming messages
        while let Some(message) = ws_stream.next().await {
            match message {
                Ok(Message::Text(text)) => {
                    // Parse the message
                    match from_json::<Event>(&text) {
                        Ok(event) => {
                            // Send the event
                            if tx.send(event).await.is_err() {
                                // Channel closed, exit the loop
                                break;
                            }
                        }
                        Err(e) => {
                            // Send an error event
                            let event = Event {
                                event_type: EventType::Error,
                                timestamp: chrono::Utc::now(),
                                data: crate::streaming::events::EventData::Error(ErrorEvent {
                                    code: "PARSE_ERROR".to_string(),
                                    message: format!("Failed to parse message: {}", e),
                                }),
                            };

                            if tx.send(event).await.is_err() {
                                // Channel closed, exit the loop
                                break;
                            }
                        }
                    }
                }
                Ok(Message::Binary(_)) => {
                    // Ignore binary messages
                }
                Ok(Message::Ping(data)) => {
                    // Respond with a pong
                    if let Err(e) = ws_stream.send(Message::Pong(data)).await {
                        // Send an error event
                        let event = Event {
                            event_type: EventType::Error,
                            timestamp: chrono::Utc::now(),
                            data: crate::streaming::events::EventData::Error(ErrorEvent {
                                code: "PONG_ERROR".to_string(),
                                message: format!("Failed to send pong: {}", e),
                            }),
                        };

                        if tx.send(event).await.is_err() {
                            // Channel closed, exit the loop
                            break;
                        }
                    }

                    // Update the last heartbeat time
                    *last_heartbeat.lock().unwrap() = Instant::now();
                }
                Ok(Message::Pong(_)) => {
                    // Update the last heartbeat time
                    *last_heartbeat.lock().unwrap() = Instant::now();
                }
                Ok(Message::Close(_)) => {
                    // Connection closed
                    break;
                },
                Ok(Message::Frame(_)) => {
                    // Ignore frame messages
                }
                Err(e) => {
                    // Send an error event
                    let event = Event {
                        event_type: EventType::Error,
                        timestamp: chrono::Utc::now(),
                        data: crate::streaming::events::EventData::Error(ErrorEvent {
                            code: "WS_ERROR".to_string(),
                            message: format!("WebSocket error: {}", e),
                        }),
                    };

                    if tx.send(event).await.is_err() {
                        // Channel closed, exit the loop
                        break;
                    }

                    // Exit the loop on error
                    break;
                }
            }
        }

        Ok(())
    }
}