polymarket-us 0.4.0

Unofficial Rust SDK for the Polymarket US Retail API
Documentation
use crate::error::PolymarketUsError;
use base64::Engine as _;
use ed25519_dalek::{Signer, SigningKey};

pub const ENV_KEY_ID: &str = "POLYMARKET_US_KEY_ID";
pub const ENV_SECRET_KEY: &str = "POLYMARKET_US_SECRET_KEY";

pub const HEADER_ACCESS_KEY: &str = "X-PM-Access-Key";
pub const HEADER_TIMESTAMP: &str = "X-PM-Timestamp";
pub const HEADER_SIGNATURE: &str = "X-PM-Signature";

/// Milliseconds since the Unix epoch.
///
/// Clocks set before 1970 clamp to `0` rather than panicking; the server will
/// reject the resulting signature as stale, which is the correct outcome.
pub(crate) fn unix_timestamp_millis() -> i64 {
    std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .map(|d| d.as_millis() as i64)
        .unwrap_or(0)
}

#[derive(Clone)]
pub struct UsAuth {
    key_id: String,
    signing_key: SigningKey,
}

impl UsAuth {
    /// Load credentials from the [`ENV_KEY_ID`] and [`ENV_SECRET_KEY`]
    /// environment variables.
    pub fn from_env() -> Result<Self, PolymarketUsError> {
        let key_id = std::env::var(ENV_KEY_ID)
            .map_err(|_| PolymarketUsError::InvalidCredentials(format!("{ENV_KEY_ID} not set")))?;
        let secret_b64 = std::env::var(ENV_SECRET_KEY).map_err(|_| {
            PolymarketUsError::InvalidCredentials(format!("{ENV_SECRET_KEY} not set"))
        })?;
        Self::from_parts(key_id, &secret_b64)
    }

    /// Build credentials from a key ID and a Base64-encoded Ed25519 secret.
    ///
    /// The secret must decode to either 64 bytes (keypair — the first 32 are
    /// used as the signing seed) or 32 bytes (a raw seed).
    pub fn from_parts(key_id: String, secret_b64: &str) -> Result<Self, PolymarketUsError> {
        let secret = base64::engine::general_purpose::STANDARD
            .decode(secret_b64.trim())
            .map_err(|err| {
                PolymarketUsError::InvalidCredentials(format!(
                    "{ENV_SECRET_KEY} is not valid Base64: {err}"
                ))
            })?;

        let seed: [u8; 32] = match secret.len() {
            64 => secret[..32].try_into().expect("first 32 of 64 bytes"),
            32 => secret.as_slice().try_into().expect("len checked == 32"),
            n => {
                return Err(PolymarketUsError::InvalidCredentials(format!(
                    "{ENV_SECRET_KEY} must decode to 64 bytes (keypair) or 32 bytes (seed), got {n}"
                )))
            }
        };

        Ok(Self {
            key_id,
            signing_key: SigningKey::from_bytes(&seed),
        })
    }

    pub fn key_id(&self) -> &str {
        &self.key_id
    }

    fn signing_payload(timestamp_ms: i64, method: &str, path: &str) -> String {
        format!("{}{}{}", timestamp_ms, method.to_uppercase(), path)
    }

    pub fn sign(&self, method: &str, path: &str) -> (i64, String) {
        let ts = unix_timestamp_millis();
        let payload = Self::signing_payload(ts, method, path);
        let sig_bytes = self.signing_key.sign(payload.as_bytes()).to_bytes();
        let signature = base64::engine::general_purpose::STANDARD.encode(sig_bytes);
        (ts, signature)
    }

    pub fn signed_headers(&self, method: &str, path: &str) -> [(&'static str, String); 3] {
        let (ts, sig) = self.sign(method, path);
        [
            (HEADER_ACCESS_KEY, self.key_id.clone()),
            (HEADER_TIMESTAMP, ts.to_string()),
            (HEADER_SIGNATURE, sig),
        ]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use ed25519_dalek::{Verifier, VerifyingKey};

    const SAMPLE_SECRET: &str =
        "lxcsopNhvp+FyZMtVPnHPeHAGihFMPEZcUg6TrJX6kCfwSEXu8v8vmyi3wJbMFUs3a9Fe7mkyRIwfZZkd/5kPg==";

    #[test]
    fn loads_64_byte_keypair_and_signs_verifiably() {
        let auth = UsAuth::from_parts("483074f3-key".into(), SAMPLE_SECRET).unwrap();

        let (ts, sig_b64) = auth.sign("GET", "/v1/account/balance");
        let sig_bytes = base64::engine::general_purpose::STANDARD
            .decode(sig_b64)
            .unwrap();
        let sig = ed25519_dalek::Signature::from_slice(&sig_bytes).unwrap();

        let raw = base64::engine::general_purpose::STANDARD
            .decode(SAMPLE_SECRET)
            .unwrap();
        let pub_bytes: [u8; 32] = raw[32..64].try_into().unwrap();
        let vk = VerifyingKey::from_bytes(&pub_bytes).unwrap();
        let payload = format!("{}GET/v1/account/balance", ts);
        assert!(vk.verify(payload.as_bytes(), &sig).is_ok());
    }
}