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
use std::borrow::Cow;
use tokio::net::TcpStream;
use crate::api::{WebsocketAPI, API};
use crate::errors::{BybitContentError, BybitError};
use crate::util::{generate_random_uid, get_timestamp};
use hex::encode as hex_encode;
use hmac::{Hmac, Mac};
use reqwest::{
header::{HeaderMap, HeaderName, HeaderValue, CONTENT_TYPE, USER_AGENT},
Client as ReqwestClient, Response as ReqwestResponse, StatusCode,
};
use futures::sink::SinkExt;
use serde::de::DeserializeOwned;
use serde_json::json;
use sha2::Sha256;
use tokio_tungstenite::WebSocketStream;
use tokio_tungstenite::{connect_async, tungstenite::Message as WsMessage, MaybeTlsStream};
use url::Url as WsUrl;
/// The main client struct that wraps the reqwest client.
///
/// It stores the API key, secret key, and host to make requests to the Bybit API.
#[derive(Clone)]
pub struct Client<'a> {
/// The API key for the Bybit account.
pub api_key: Cow<'a, str>,
/// The secret key for the Bybit account.
pub secret_key: Cow<'a, str>,
/// The host to make requests to.
pub host: String,
/// The reqwest client that makes the HTTP requests.
pub inner_client: ReqwestClient,
}
impl<'a> Client<'_> {
/// Create a new instance of `Client`.
///
/// # Arguments
///
/// * `api_key` - The API key for the Bybit account. It can be `None` if the client is not for authenticated requests.
/// * `secret_key` - The secret key for the Bybit account. It can be `None` if the client is not for authenticated requests.
/// * `host` - The host to make requests to.
///
/// # Returns
///
/// A new instance of `Client`.
pub fn new(
api_key: Option<Cow<'_, str>>,
secret_key: Option<Cow<'_, str>>,
host: String,
) -> Self {
// Create a new instance of the reqwest client.
let inner_client = ReqwestClient::builder()
.build()
.expect("Failed to build reqwest client");
// Create a new instance of `Client` with the provided arguments.
Client {
// Set the API key. If `api_key` is `None`, set it to an empty string.
api_key: match api_key {
Some(api_key) => api_key.into_owned().into(),
None => "".into(),
},
// Set the secret key. If `secret_key` is `None`, set it to an empty string.
secret_key: match secret_key {
Some(secret_key) => secret_key.into_owned().into(),
None => "".into(),
},
// Set the host.
host,
// Set the reqwest client.
inner_client,
}
}
/// Makes an unsigned HTTP GET request to the specified endpoint.
///
/// # Arguments
///
/// * `endpoint` - The endpoint to make the request to.
/// * `request` - The query string to append to the URL.
///
/// # Returns
///
/// A `Result` containing the response deserialized to the specified type `T`.
pub async fn get<T: DeserializeOwned + Send + 'static>(
&self,
endpoint: API,
request: Option<String>,
) -> Result<T, BybitError> {
// Construct the full URL
let mut url = format!("{}/{}", self.host, endpoint.as_ref());
// If there is a query string, append it to the URL
if let Some(request) = request {
if !request.is_empty() {
url.push_str("?");
url.push_str(&request);
}
}
// Make the request using the reqwest client
let response = self.inner_client.get(url).send().await?;
// Handle the response using the `handler` method
self.handler(response).await
}
/// Makes a signed HTTP GET request to the specified endpoint.
///
/// # Arguments
///
/// * `endpoint` - The endpoint to make the request to.
/// * `recv_window` - The receive window for the request in milliseconds.
/// * `request` - The query string to append to the URL.
///
/// # Returns
///
/// A `Result` containing the response deserialized to the specified type `T`.
pub async fn get_signed<T: DeserializeOwned + Send + 'static>(
&self,
endpoint: API,
recv_window: u16,
request: Option<String>,
) -> Result<T, BybitError> {
// Construct the full URL
let mut url: String = format!("{}/{}", self.host, endpoint.as_ref());
// If there is a query string, append it to the URL
let query_string = request.unwrap_or_default();
if !query_string.is_empty() {
url.push_str(format!("?{}", query_string).as_str());
}
// Sign the request, passing the query string for signature
// The request is signed with the API secret key and requires
// the `recv_window` for the request to be within the specified timeframe.
let headers = self.build_signed_headers(false, true, recv_window, Some(query_string))?;
// Make the signed HTTP GET request
let client = &self.inner_client;
let response = client.get(url.as_str()).headers(headers).send().await?;
// Handle the response
self.handler(response).await
}
/// Makes an unsigned HTTP POST request to the specified endpoint.
///
/// # Arguments
///
/// * `endpoint` - The endpoint to make the request to.
/// * `request` - The query string to append to the URL. Only used if provided.
///
/// # Returns
///
/// A `Result` containing the response deserialized to the specified type `T`.
pub async fn post<T: DeserializeOwned + Send + 'static>(
&self,
endpoint: API,
request: Option<String>,
) -> Result<T, BybitError> {
// Construct the URL by appending the base host and endpoint to it
let mut url: String = format!("{}/{}", self.host, endpoint.as_ref());
// If a request is provided, append it to the URL as a query string
if let Some(request) = request {
if !request.is_empty() {
url.push_str(format!("?{}", request).as_str());
}
}
// Get a reference to the inner client
let client = &self.inner_client;
// Send the POST request to the constructed URL
let response = client.post(url.as_str()).send().await?;
// Handle the response by passing it to the handler method
self.handler(response).await
}
/// Makes a signed HTTP POST request to the specified endpoint.
///
/// # Arguments
///
/// * `endpoint` - The endpoint to make the request to.
/// * `recv_window` - The receive window for the request in milliseconds.
/// * `raw_request_body` - The raw request body to sign. Only used if provided.
///
/// # Returns
///
/// A `Result` containing the response deserialized to the specified type `T`.
pub async fn post_signed<T: DeserializeOwned + Send + 'static>(
&self,
endpoint: API,
recv_window: u16,
raw_request_body: Option<String>,
) -> Result<T, BybitError> {
// Construct the full URL
let url = format!("{}{}", self.host, endpoint.as_ref());
// Sign the request, passing the raw request body for signature
// The request is signed with the API secret key and requires
// the `recv_window` for the request to be within the specified timeframe.
let headers =
self.build_signed_headers(true, true, recv_window, raw_request_body.clone())?;
// Make the signed HTTP POST request
let client = &self.inner_client;
let response = client
.post(url)
.headers(headers)
.body(raw_request_body.unwrap_or_default())
.send()
.await?;
// Handle the response
self.handler(response).await
}
/// Builds the signed headers for an HTTP request.
///
/// # Arguments
///
/// * `content_type` - Whether to include the `Content-Type` header.
/// * `signed` - Whether to include the signature in the headers.
/// * `recv_window` - The receive window for the request in milliseconds.
/// * `request` - The request body to sign.
///
/// # Returns
///
/// A `Result` containing the signed headers.
fn build_signed_headers<'str>(
&self,
content_type: bool,
signed: bool,
recv_window: u16,
request: Option<String>,
) -> Result<HeaderMap, BybitError> {
// Initialize the custom headers map
let mut custom_headers = HeaderMap::new();
// Set the User-Agent header
custom_headers.insert(USER_AGENT, HeaderValue::from_static("bybit-rs"));
// Get the current timestamp
let timestamp = get_timestamp().to_string();
// Get the receive window
let window = recv_window.to_string();
// Sign the request
let signature = self.sign_message(×tamp, &window, request);
// Set the headers
let signature_header = HeaderName::from_static("x-bapi-sign");
let api_key_header = HeaderName::from_static("x-bapi-api-key");
let timestamp_header = HeaderName::from_static("x-bapi-timestamp");
let recv_window_header = HeaderName::from_static("x-bapi-recv-window");
if signed {
// Insert the signature header
custom_headers.insert(
signature_header,
HeaderValue::from_str(&signature.to_owned())?,
);
// Insert the API key header
custom_headers.insert(
api_key_header,
HeaderValue::from_str(&self.api_key.to_owned())?,
);
}
// Insert the timestamp header
custom_headers.insert(
timestamp_header,
HeaderValue::from_str(×tamp.to_owned())?,
);
// Insert the receive window header
custom_headers.insert(
recv_window_header,
HeaderValue::from_str(&window.to_owned())?,
);
// Insert the Content-Type header if required
if content_type {
custom_headers.insert(CONTENT_TYPE, HeaderValue::from_static("application/json"));
}
// Return the signed headers
Ok(custom_headers).map_err(|e| BybitError::ReqError(e))
}
/// Signs a POST request message.
///
/// # Arguments
///
/// * `timestamp` - The timestamp of the request.
/// * `recv_window` - The receive window of the request.
/// * `request` - The request body as an optional string.
///
/// # Returns
///
/// The signed message as a hex-encoded string.
///
/// # Description
///
/// This function takes the timestamp, receive window, and an optional request body as input.
/// It creates a string by concatenating the timestamp, API key, and receive window.
/// If a request body is provided, it appends it to the sign message.
/// The function then uses the HMAC-SHA256 algorithm to sign the message.
/// The result is hex-encoded and returned as a string.
fn sign_message(&self, timestamp: &str, recv_window: &str, request: Option<String>) -> String {
// Create a new HMAC SHA256 instance with the secret key
let mut mac = Hmac::<Sha256>::new_from_slice(self.secret_key.as_bytes()).unwrap();
// Create the sign message by concatenating the timestamp, API key, and receive window
let mut sign_message = format!("{}{}{}", timestamp, self.api_key, recv_window);
// If a request body is provided, append it to the sign message
if let Some(req) = request {
sign_message.push_str(&req);
}
// Update the MAC with the sign message
mac.update(sign_message.as_bytes());
// Finalize the MAC and encode the result as a hex string
let hex_signature = hex_encode(mac.finalize().into_bytes());
hex_signature
}
/// Internal function to sign a POST request message.
///
/// # Arguments
///
/// * `timestamp` - The timestamp of the request.
/// * `recv_window` - The receive window of the request.
/// * `request` - The request body as an optional string.
///
/// # Returns
///
/// The signed message as a hex-encoded string.
fn _sign_post_message(
&self,
timestamp: &str,
recv_window: &str,
request: Option<String>,
) -> String {
// Create a new HMAC SHA256 instance with the secret key
let mut mac = Hmac::<Sha256>::new_from_slice(self.secret_key.as_bytes()).unwrap();
// Update the MAC with the timestamp
mac.update(timestamp.as_bytes());
// Update the MAC with the API key
mac.update(self.api_key.as_bytes());
// Update the MAC with the receive window
mac.update(recv_window.as_bytes());
// Update the MAC with the request body, if provided
if let Some(req) = request {
mac.update(req.as_bytes());
}
// Finalize the MAC and encode the result as a hex string
let hex_signature = hex_encode(mac.finalize().into_bytes());
hex_signature
}
/// Internal function to handle the response from a HTTP request.
///
/// # Arguments
///
/// * `response` - The HTTP response from the request.
///
/// # Returns
///
/// The result of deserializing the response body into a specific type.
/// Returns `Ok(T)` if the response status is `StatusCode::OK`,
/// returns `Err(BybitError::BybitError(BybitContentError))` if the response
/// status is `StatusCode::BAD_REQUEST`, returns `Err(BybitError::InternalServerError)`
/// if the response status is `StatusCode::INTERNAL_SERVER_ERROR`,
/// returns `Err(BybitError::ServiceUnavailable)` if the response status is
/// `StatusCode::SERVICE_UNAVAILABLE`, returns `Err(BybitError::Unauthorized)`
/// if the response status is `StatusCode::UNAUTHORIZED`, and returns
/// `Err(BybitError::StatusCode(status))` if the response status is any other
/// value.
async fn handler<T: DeserializeOwned + Send + 'static>(
&self,
response: ReqwestResponse,
) -> Result<T, BybitError> {
// Match the status code of the response
match response.status() {
// If the status code is OK, deserialize the response body into T and return it
StatusCode::OK => {
let response = response.json::<T>().await?;
Ok(response)
}
// If the status code is BAD_REQUEST, deserialize the response body into BybitContentError and
// wrap it in BybitError and return it
StatusCode::BAD_REQUEST => {
let error: BybitContentError = response.json().await.map_err(BybitError::from)?;
Err(BybitError::BybitError(error).into())
}
// If the status code is INTERNAL_SERVER_ERROR, return BybitError::InternalServerError
StatusCode::INTERNAL_SERVER_ERROR => Err(BybitError::InternalServerError),
// If the status code is SERVICE_UNAVAILABLE, return BybitError::ServiceUnavailable
StatusCode::SERVICE_UNAVAILABLE => Err(BybitError::ServiceUnavailable),
// If the status code is UNAUTHORIZED, return BybitError::Unauthorized
StatusCode::UNAUTHORIZED => Err(BybitError::Unauthorized),
// If the status code is any other value, wrap it in BybitError::StatusCode and return it
status => Err(BybitError::StatusCode(status.as_u16())),
}
}
/// Connects to the Bybit WebSocket endpoint and sends an authentication message.
///
/// # Arguments
///
/// * `endpoint` - The WebSocket endpoint to connect to.
/// * `request_body` - An optional request body to send after authenticating.
/// * `private` - A boolean indicating whether to send the authentication message.
/// * `alive_dur` - An optional duration in seconds to set the `alive` field of the
/// authentication message to.
///
/// # Returns
///
/// Returns a `Result` containing a `WebSocketStream` if the connection and authentication
/// are successful, or a `BybitError` if an error occurs.
pub async fn wss_connect(
&self,
endpoint: WebsocketAPI,
request_body: Option<String>,
private: bool,
alive_dur: Option<u16>,
) -> Result<WebSocketStream<MaybeTlsStream<TcpStream>>, BybitError> {
// Construct the WebSocket URL
let unparsed_url = format!("{}{}", self.host, endpoint.as_ref()).to_string();
let url = WsUrl::parse(unparsed_url.as_str())?;
// Calculate the expiration time for the authentication message
let expiry_time = alive_dur.unwrap_or(9) as u64 * 1000 * 60;
let expires = get_timestamp() + expiry_time as u64;
// Calculate the signature for the authentication message
let mut mac = Hmac::<Sha256>::new_from_slice(self.secret_key.as_bytes()).unwrap();
mac.update(format!("GET/realtime{expires}").as_bytes());
let signature = hex_encode(mac.finalize().into_bytes());
// Generate a random UUID for the request ID
let uuid = generate_random_uid(5);
// Connect to the WebSocket endpoint
match connect_async(url).await {
// If the connection is successful, send the authentication message
Ok((mut ws_stream, _)) => {
let auth_msg = json!({
"req_id": uuid,
"op": "auth",
"args": [self.api_key, expires, signature]
});
if private {
// Send the authentication message if `private` is true
ws_stream
.send(WsMessage::Text(auth_msg.to_string()))
.await?;
}
// Send the request body if it is not empty
let request = request_body.unwrap_or_else(String::new);
if !request.is_empty() {
ws_stream.send(WsMessage::Text(request)).await?;
}
Ok(ws_stream)
}
// If the connection fails, return a BybitError
Err(err) => Err(BybitError::Tungstenite(err)),
}
}
}