hl-types 0.1.0

Hyperliquid domain types — orders, signatures, candles, accounts, errors
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

use rust_decimal::Decimal;
use serde::{Deserialize, Serialize};

/// An OHLCV candlestick bar from Hyperliquid.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct HlCandle {
    /// Candle open time in milliseconds since the UNIX epoch.
    pub timestamp: u64,
    /// Opening price.
    pub open: Decimal,
    /// Highest price during the interval.
    pub high: Decimal,
    /// Lowest price during the interval.
    pub low: Decimal,
    /// Closing price.
    pub close: Decimal,
    /// Trade volume during the interval.
    pub volume: Decimal,
}

impl HlCandle {
    /// Creates a new `HlCandle`.
    pub fn new(
        timestamp: u64,
        open: Decimal,
        high: Decimal,
        low: Decimal,
        close: Decimal,
        volume: Decimal,
    ) -> Self {
        Self {
            timestamp,
            open,
            high,
            low,
            close,
            volume,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::str::FromStr;

    #[test]
    fn candle_serde_roundtrip() {
        let candle = HlCandle {
            timestamp: 1700000000000,
            open: Decimal::from_str("50000.0").unwrap(),
            high: Decimal::from_str("51000.0").unwrap(),
            low: Decimal::from_str("49500.0").unwrap(),
            close: Decimal::from_str("50500.0").unwrap(),
            volume: Decimal::from_str("1234.56").unwrap(),
        };
        let json = serde_json::to_string(&candle).unwrap();
        let parsed: HlCandle = serde_json::from_str(&json).unwrap();
        assert_eq!(parsed.timestamp, 1700000000000);
        assert_eq!(parsed.open, Decimal::from_str("50000.0").unwrap());
        assert_eq!(parsed.high, Decimal::from_str("51000.0").unwrap());
        assert_eq!(parsed.low, Decimal::from_str("49500.0").unwrap());
        assert_eq!(parsed.close, Decimal::from_str("50500.0").unwrap());
        assert_eq!(parsed.volume, Decimal::from_str("1234.56").unwrap());
    }
}