Struct KrakenCredential 

pub struct KrakenCredential { /* private fields */ }

API credentials for Kraken authentication.

Implementations

impl KrakenCredential

pub fn new(api_key: impl Into<String>, api_secret: impl Into<String>) -> Self

Creates a new credential with the given API key and secret.

pub fn from_env_spot() -> Option<Self>

Load credentials from environment variables for Kraken Spot.

Looks for KRAKEN_SPOT_API_KEY and KRAKEN_SPOT_API_SECRET.

Note: Kraken Spot does not have a testnet environment.

Returns None if either key or secret is not set.

pub fn from_env_futures(demo: bool) -> Option<Self>

Load credentials from environment variables for Kraken Futures.

Looks for KRAKEN_FUTURES_API_KEY and KRAKEN_FUTURES_API_SECRET (mainnet) or KRAKEN_FUTURES_DEMO_API_KEY and KRAKEN_FUTURES_DEMO_API_SECRET (demo).

Returns None if either key or secret is not set.

pub fn resolve_spot( api_key: Option<String>, api_secret: Option<String>, ) -> Option<Self>

Resolves credentials from provided values or environment for Spot.

If both api_key and api_secret are provided, uses those. Otherwise falls back to loading from environment variables.

pub fn resolve_futures( api_key: Option<String>, api_secret: Option<String>, demo: bool, ) -> Option<Self>

Resolves credentials from provided values or environment for Futures.

If both api_key and api_secret are provided, uses those. Otherwise falls back to loading from environment variables.

pub fn api_key(&self) -> &str

Returns the API key.

pub fn into_parts(&self) -> (String, String)

Returns the API key and secret as cloned strings.

pub fn sign_spot( &self, path: &str, nonce: u64, params: &HashMap<String, String>, ) -> Result<(String, String)>

Sign a request for Kraken Spot REST API.

Kraken Spot uses HMAC-SHA512 with the following message:

• path + SHA256(nonce + POST data)
• The secret is base64 decoded before signing

Note: “nonce + POST data” means the nonce value string is prepended to the URL-encoded POST body, e.g., “1234567890nonce=1234567890&param=value”.

pub fn sign_spot_json( &self, path: &str, nonce: u64, json_body: &str, ) -> Result<String>

Sign a JSON request for Kraken Spot API (used for CancelOrderBatch, AddOrderBatch).

These endpoints use JSON body instead of form-encoded. Signature: HMAC-SHA512(path + SHA256(nonce + json_body))

pub fn sign_futures( &self, path: &str, post_data: &str, nonce: u64, ) -> Result<String>

Sign a request for Kraken Futures API v3.

Kraken Futures authentication steps:

1. Strip “/derivatives” prefix from endpoint path
2. Concatenate: postData + nonce + endpointPath
3. SHA-256 hash the concatenation
4. Base64 decode the API secret
5. HMAC-SHA-512 of the SHA-256 hash using decoded secret
6. Base64 encode the result

References

• https://docs.kraken.com/api/docs/guides/futures-rest/

pub fn sign_ws_challenge(&self, challenge: &str) -> Result<String>

Sign a WebSocket challenge for Kraken Futures private feeds.

The signing process is similar to REST API authentication:

1. SHA-256 hash the challenge string
2. HMAC-SHA-512 of the hash using decoded API secret
3. Base64 encode the result

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 KrakenCredential

fn clone(&self) -> KrakenCredential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KrakenCredential

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

Formats the value using the given formatter.

impl Drop for KrakenCredential

fn drop(&mut self)

Executes the destructor for this type.

impl Zeroize for KrakenCredential

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.