df-hyperliquid-core 0.0.8-beta

Hyperliquid SDK for Rust: markets, account, trading, transfers, earn and deploy, with exact decimals and signing. Native and wasm.
Documentation 
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

//! Asset contexts: what a market is doing now. [`PerpCtx`] for a perp on any dex, [`SpotCtx`] for a
//! spot pair or an outcome side, each the same shape from `/info` and from the socket.

use serde::Deserialize;

use crate::utils::dec::{Dec, Round};

/// What a perp is doing now. The venue writes `midPx`, `premium` and `impactPxs` as null on a
/// market with no book.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PerpCtx {
    pub mark_px: Dec,
    #[serde(default)]
    pub mid_px: Option<Dec>,
    pub oracle_px: Dec,
    pub prev_day_px: Dec,
    /// Hourly, as a fraction of the position's value.
    pub funding: Dec,
    /// In the base asset.
    pub open_interest: Dec,
    /// Quote volume over the last day.
    pub day_ntl_vlm: Dec,
    /// Base volume over the last day.
    #[serde(default)]
    pub day_base_vlm: Option<Dec>,
    #[serde(default)]
    pub premium: Option<Dec>,
    #[serde(default)]
    pub impact_pxs: Option<Vec<Dec>>,
}

impl PerpCtx {
    /// The price a market order is bounded from: the mid, else the mark.
    #[must_use]
    pub fn reference(&self) -> Dec {
        self.mid_px.unwrap_or(self.mark_px)
    }

    /// The mark's change over the day in percent, to two places. `None` without a previous day's
    /// price.
    #[must_use]
    pub fn day_change(&self) -> Option<Dec> {
        let then = Some(self.prev_day_px).filter(|then| then.is_positive())?;
        self.mark_px.checked_sub(then)?.checked_mul(Dec::from_int(100))?.checked_div(then, 2, Round::Nearest)
    }

    /// The open interest at the mark, in the quote.
    #[must_use]
    pub fn open_interest_value(&self) -> Option<Dec> {
        self.open_interest.checked_mul(self.mark_px)
    }
}

/// What a spot pair or an outcome side (`#<encoding>`) is doing now. An outcome side's open
/// interest is its circulating supply.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SpotCtx {
    /// The book name: `PURR/USDC`, `@107` or `#14730`.
    pub coin: String,
    pub mark_px: Dec,
    #[serde(default)]
    pub mid_px: Option<Dec>,
    pub prev_day_px: Dec,
    /// Quote volume over the last day.
    pub day_ntl_vlm: Dec,
    /// Base volume over the last day.
    #[serde(default)]
    pub day_base_vlm: Option<Dec>,
    pub circulating_supply: Dec,
    #[serde(default)]
    pub total_supply: Option<Dec>,
}

impl SpotCtx {
    /// The price a market order is bounded from: the mid, else the mark.
    #[must_use]
    pub fn reference(&self) -> Dec {
        self.mid_px.unwrap_or(self.mark_px)
    }
}

#[cfg(test)]
#[path = "tests/context.rs"]
mod tests;