Struct Credential 

pub struct Credential {
    pub api_key: Ustr,
    pub api_passphrase: String,
    /* private fields */
}

OKX API credentials for signing requests.

Uses HMAC SHA256 for request signing as per OKX API specifications. Secrets are automatically zeroized on drop for security.

Fields

api_key: Ustr

api_passphrase: String

Implementations

impl Credential

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

Creates a new Credential instance.

pub fn sign( &self, timestamp: &str, method: &str, endpoint: &str, body: &str, ) -> String

Signs a request message according to the OKX authentication scheme.

This string-based variant is preserved for compatibility with callers that already have a UTF-8 body string. Prefer Self::sign_bytes when you have the original body bytes to avoid any possibility of encoding drift.

pub fn sign_bytes( &self, timestamp: &str, method: &str, endpoint: &str, body: Option<&[u8]>, ) -> String

Signs a request message using raw body bytes to avoid any UTF-8 conversion or re-serialization differences between the signed content and the bytes sent.

pub fn api_key_masked(&self) -> String

Returns a masked version of the API key for logging purposes.

Shows first 4 and last 4 characters with ellipsis in between. For keys shorter than 8 characters, shows asterisks only.

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl Drop for Credential

fn drop(&mut self)

Executes the destructor for this type.