hyperliquid-sdk-rs 0.1.2

High-performance Rust SDK for Hyperliquid Protocol
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use serde::{Deserialize, Serialize};
use uuid::Uuid;

// ==================== Order Types ====================

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OrderRequest {
    #[serde(rename = "a")]
    pub asset: u32,
    #[serde(rename = "b")]
    pub is_buy: bool,
    #[serde(rename = "p")]
    pub limit_px: String,
    #[serde(rename = "s")]
    pub sz: String,
    #[serde(rename = "r", default)]
    pub reduce_only: bool,
    #[serde(rename = "t")]
    pub order_type: OrderType,
    #[serde(rename = "c", skip_serializing_if = "Option::is_none")]
    pub cloid: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum OrderType {
    Limit(Limit),
    Trigger(Trigger),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Limit {
    pub tif: String, // "Alo", "Ioc", "Gtc"
}

/// Trigger order type for stop-loss and take-profit orders.
///
/// **Important**: Field order matters for MessagePack serialization!
/// The order must match the Hyperliquid Python SDK: isMarket, triggerPx, tpsl
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Trigger {
    #[serde(rename = "isMarket")]
    pub is_market: bool,
    #[serde(rename = "triggerPx")]
    pub trigger_px: String,
    pub tpsl: String, // "tp" or "sl"
}

// ==================== Cancel Types ====================

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CancelRequest {
    #[serde(rename = "a")]
    pub asset: u32,
    #[serde(rename = "o")]
    pub oid: u64,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CancelRequestCloid {
    pub asset: u32,
    pub cloid: String,
}

// ==================== Modify Types ====================

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ModifyRequest {
    pub oid: u64,
    pub order: OrderRequest,
}

// ==================== Builder Types ====================

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BuilderInfo {
    #[serde(rename = "b")]
    pub builder: String,
    #[serde(rename = "f")]
    pub fee: u64,
}

// ==================== Convenience Methods ====================

impl OrderRequest {
    /// Create a limit order
    pub fn limit(
        asset: u32,
        is_buy: bool,
        limit_px: impl Into<String>,
        sz: impl Into<String>,
        tif: impl Into<String>,
    ) -> Self {
        Self {
            asset,
            is_buy,
            limit_px: limit_px.into(),
            sz: sz.into(),
            reduce_only: false,
            order_type: OrderType::Limit(Limit { tif: tif.into() }),
            cloid: None,
        }
    }

    /// Create a trigger order (stop loss or take profit)
    pub fn trigger(
        asset: u32,
        is_buy: bool,
        trigger_px: impl Into<String>,
        sz: impl Into<String>,
        tpsl: impl Into<String>,
        is_market: bool,
    ) -> Self {
        Self {
            asset,
            is_buy,
            limit_px: "0".to_string(), // Triggers don't use limit_px
            sz: sz.into(),
            reduce_only: false,
            order_type: OrderType::Trigger(Trigger {
                is_market,
                trigger_px: trigger_px.into(),
                tpsl: tpsl.into(),
            }),
            cloid: None,
        }
    }

    /// Set client order ID
    pub fn with_cloid(mut self, cloid: Option<Uuid>) -> Self {
        self.cloid = cloid.map(|id| format!("{:032x}", id.as_u128()));
        self
    }

    /// Set reduce only
    pub fn reduce_only(mut self, reduce_only: bool) -> Self {
        self.reduce_only = reduce_only;
        self
    }
}

// Convenience constructors for Cancel types
impl CancelRequest {
    pub fn new(asset: u32, oid: u64) -> Self {
        Self { asset, oid }
    }
}

impl CancelRequestCloid {
    pub fn new(asset: u32, cloid: Uuid) -> Self {
        Self {
            asset,
            cloid: format!("{:032x}", cloid.as_u128()),
        }
    }
}