BybitAuth

Struct BybitAuth 

Source
pub struct BybitAuth { /* private fields */ }
Expand description

Bybit API authenticator.

Handles request signing using HMAC-SHA256 and header construction for authenticated API requests.

Credentials are automatically zeroed from memory when dropped.

Implementations§

Source§

impl BybitAuth

Source

pub fn new(api_key: String, secret: String) -> Self

Creates a new BybitAuth instance.

§Arguments
  • api_key - The API key from Bybit.
  • secret - The secret key from Bybit.
§Security

Credentials are automatically zeroed from memory when the authenticator is dropped.

§Example
use ccxt_exchanges::bybit::BybitAuth;

let auth = BybitAuth::new(
    "your-api-key".to_string(),
    "your-secret".to_string(),
);
Source

pub fn api_key(&self) -> &str

Returns the API key.

Source

pub fn build_sign_string( &self, timestamp: &str, recv_window: u64, params: &str, ) -> String

Builds the signature string for HMAC signing.

The signature string format is: timestamp + api_key + recv_window + params

§Arguments
  • timestamp - Unix timestamp in milliseconds as string.
  • recv_window - Receive window in milliseconds.
  • params - Query string (for GET) or request body (for POST).
§Returns

The concatenated string to be signed.

Source

pub fn sign(&self, timestamp: &str, recv_window: u64, params: &str) -> String

Signs a request using HMAC-SHA256.

§Arguments
  • timestamp - Unix timestamp in milliseconds as string.
  • recv_window - Receive window in milliseconds.
  • params - Query string (for GET) or request body (for POST).
§Returns

Hex-encoded HMAC-SHA256 signature.

§Example
use ccxt_exchanges::bybit::BybitAuth;

let auth = BybitAuth::new(
    "api-key".to_string(),
    "secret".to_string(),
);

let signature = auth.sign("1234567890000", 5000, "symbol=BTCUSDT");
assert!(!signature.is_empty());
Source

pub fn add_auth_headers( &self, headers: &mut HeaderMap, timestamp: &str, sign: &str, recv_window: u64, )

Adds authentication headers to a HeaderMap.

Adds the following headers:

  • X-BAPI-API-KEY: API key
  • X-BAPI-SIGN: HMAC-SHA256 signature (hex encoded)
  • X-BAPI-TIMESTAMP: Unix timestamp
  • X-BAPI-RECV-WINDOW: Receive window
§Arguments
  • headers - Mutable reference to HeaderMap to add headers to.
  • timestamp - Unix timestamp in milliseconds as string.
  • sign - Pre-computed signature from sign() method.
  • recv_window - Receive window in milliseconds.
§Example
use ccxt_exchanges::bybit::BybitAuth;
use reqwest::header::HeaderMap;

let auth = BybitAuth::new(
    "api-key".to_string(),
    "secret".to_string(),
);

let mut headers = HeaderMap::new();
let timestamp = "1234567890000";
let recv_window = 5000u64;
let signature = auth.sign(timestamp, recv_window, "symbol=BTCUSDT");
auth.add_auth_headers(&mut headers, timestamp, &signature, recv_window);

assert!(headers.contains_key("X-BAPI-API-KEY"));
assert!(headers.contains_key("X-BAPI-SIGN"));
assert!(headers.contains_key("X-BAPI-TIMESTAMP"));
assert!(headers.contains_key("X-BAPI-RECV-WINDOW"));
Source

pub fn create_auth_headers( &self, timestamp: &str, recv_window: u64, params: &str, ) -> HeaderMap

Creates authentication headers for a request.

This is a convenience method that combines sign() and add_auth_headers().

§Arguments
  • timestamp - Unix timestamp in milliseconds as string.
  • recv_window - Receive window in milliseconds.
  • params - Query string (for GET) or request body (for POST).
§Returns

A HeaderMap containing all authentication headers.

Trait Implementations§

Source§

impl Clone for BybitAuth

Source§

fn clone(&self) -> BybitAuth

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BybitAuth

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more