bybit-api 0.1.0

A Rust SDK for the Bybit V5 API - async, type-safe, zero-panic
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

//! WebSocket message models.

use serde::{Deserialize, Serialize};

/// WebSocket operation request.
#[derive(Debug, Clone, Serialize)]
pub struct WsRequest {
    /// Request ID
    pub req_id: String,
    /// Operation type
    pub op: String,
    /// Arguments
    pub args: Vec<String>,
}

/// WebSocket authentication request.
#[derive(Debug, Clone, Serialize)]
pub struct WsAuthRequest {
    /// Request ID
    pub req_id: String,
    /// Operation type
    pub op: String,
    /// Arguments [api_key, expires, signature]
    pub args: Vec<serde_json::Value>,
}

/// WebSocket response.
#[derive(Debug, Clone, Deserialize)]
pub struct WsResponse {
    /// Success flag
    #[serde(default)]
    pub success: Option<bool>,
    /// Return message
    #[serde(default)]
    pub ret_msg: Option<String>,
    /// Connection ID
    #[serde(default)]
    pub conn_id: Option<String>,
    /// Request ID
    #[serde(default)]
    pub req_id: Option<String>,
    /// Operation type
    #[serde(default)]
    pub op: Option<String>,
}

/// WebSocket message (data push).
#[derive(Debug, Clone, Deserialize)]
pub struct WsMessage {
    /// Topic name
    pub topic: String,
    /// Message type (snapshot, delta)
    #[serde(rename = "type")]
    pub msg_type: Option<String>,
    /// Timestamp
    pub ts: Option<u64>,
    /// Data payload
    pub data: serde_json::Value,
}

/// WebSocket ping request.
#[derive(Debug, Clone, Serialize)]
pub struct WsPing {
    /// Request ID
    pub req_id: String,
    /// Operation type
    pub op: String,
}

impl WsPing {
    /// Create a new ping message.
    pub fn new() -> Self {
        Self {
            req_id: uuid::Uuid::new_v4().to_string(),
            op: "ping".to_string(),
        }
    }
}

impl Default for WsPing {
    fn default() -> Self {
        Self::new()
    }
}

/// WebSocket pong response.
#[derive(Debug, Clone, Deserialize)]
pub struct WsPong {
    /// Success flag
    #[serde(default)]
    pub success: Option<bool>,
    /// Return message
    #[serde(default)]
    pub ret_msg: Option<String>,
    /// Connection ID
    #[serde(default)]
    pub conn_id: Option<String>,
    /// Request ID
    #[serde(default)]
    pub req_id: Option<String>,
    /// Operation type
    #[serde(default)]
    pub op: Option<String>,
}

/// Check if message is a pong response.
pub fn is_pong(msg: &serde_json::Value) -> bool {
    if let Some(op) = msg.get("op").and_then(|v| v.as_str()) {
        return op == "pong";
    }
    if let Some(ret_msg) = msg.get("ret_msg").and_then(|v| v.as_str()) {
        return ret_msg == "pong";
    }
    false
}

/// Check if message is an auth response.
pub fn is_auth_response(msg: &serde_json::Value) -> bool {
    msg.get("op")
        .and_then(|v| v.as_str())
        .map(|op| op == "auth")
        .unwrap_or(false)
}

/// Check if message is a subscription response.
pub fn is_subscription_response(msg: &serde_json::Value) -> bool {
    msg.get("op")
        .and_then(|v| v.as_str())
        .map(|op| op == "subscribe")
        .unwrap_or(false)
}

/// Check if message is a data message.
pub fn is_data_message(msg: &serde_json::Value) -> bool {
    msg.get("topic").is_some()
}