guilder-client-hyperliquid 0.6.1

Hyperliquid client for the guilder multi-exchange crypto trading library
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

/// Outbound WebSocket messages sent to Hyperliquid.
///
/// Covers all client → server message types. Each variant maps to a
/// concrete Hyperliquid wire format via `to_json()`.
use serde::Serialize;

/// Cancel action for batch cancel orders via WS.
#[derive(Serialize, Clone, Debug)]
pub(crate) struct CancelAction {
    pub(crate) a: usize,
    pub(crate) o: i64,
}

/// One variant per client → server message type.
#[derive(Clone, Debug)]
pub(crate) enum HyperliquidWsOutboundMessage {
    /// Subscribe to an l2Book channel for a specific coin.
    SubscribeL2Book { coin: String },
    /// Subscribe to the trades channel for a specific coin.
    SubscribeTrades { coin: String },
    /// Subscribe to the activeAssetCtx channel for a specific coin.
    SubscribeActiveAssetCtx { coin: String },
    /// Subscribe to the user events channel for a specific address.
    SubscribeUserEvents { user_addr: String },
    /// Subscribe to the orderUpdates channel for a specific address.
    SubscribeOrderUpdates { user_addr: String },
    /// Subscribe to the userNonFundingLedgerUpdates channel for a specific address.
    SubcribeNonFundingLedger { user_addr: String },
    /// Unsubscribe from any channel (channel + subscription JSON).
    Unsubscribe {
        subscription: serde_json::Value,
    },
    /// Keepalive ping.
    Ping,
    /// Place an order via WS (uses the same signed action payload as REST).
    #[allow(dead_code)]
    PlaceOrder { payload: serde_json::Value },
    /// Cancel orders via WS.
    #[allow(dead_code)]
    CancelOrder { cancels: Vec<CancelAction> },
}

impl HyperliquidWsOutboundMessage {
    /// Serialize to the JSON text format expected by Hyperliquid's WS endpoint.
    pub fn to_json(&self) -> String {
        match self {
            HyperliquidWsOutboundMessage::SubscribeL2Book { coin } => serde_json::json!({
                "method": "subscribe",
                "subscription": {
                    "type": "l2Book",
                    "coin": coin,
                }
            })
            .to_string(),
            HyperliquidWsOutboundMessage::SubscribeTrades { coin } => serde_json::json!({
                "method": "subscribe",
                "subscription": {
                    "type": "trades",
                    "coin": coin,
                }
            })
            .to_string(),
            HyperliquidWsOutboundMessage::SubscribeActiveAssetCtx { coin } => serde_json::json!({
                "method": "subscribe",
                "subscription": {
                    "type": "activeAssetCtx",
                    "coin": coin,
                }
            })
            .to_string(),
            HyperliquidWsOutboundMessage::SubscribeUserEvents { user_addr } => serde_json::json!({
                "method": "subscribe",
                "subscription": {
                    "type": "user",
                    "user": user_addr,
                }
            })
            .to_string(),
            HyperliquidWsOutboundMessage::SubscribeOrderUpdates { user_addr } => serde_json::json!({
                "method": "subscribe",
                "subscription": {
                    "type": "orderUpdates",
                    "user": user_addr,
                }
            })
            .to_string(),
            HyperliquidWsOutboundMessage::SubcribeNonFundingLedger { user_addr } => serde_json::json!({
                "method": "subscribe",
                "subscription": {
                    "type": "userNonFundingLedgerUpdates",
                    "user": user_addr,
                }
            })
            .to_string(),
            HyperliquidWsOutboundMessage::Unsubscribe { subscription } => serde_json::json!({
                "method": "unsubscribe",
                "subscription": subscription
            })
            .to_string(),
            HyperliquidWsOutboundMessage::Ping => r#"{"method":"ping"}"#.to_string(),
            HyperliquidWsOutboundMessage::PlaceOrder { payload } => payload.to_string(),
            HyperliquidWsOutboundMessage::CancelOrder { cancels } => serde_json::json!({
                "type": "cancel",
                "cancels": cancels
            })
            .to_string(),
        }
    }
}