rhyperliquid 0.2.0

Rust SDK and client for the Hyperliquid exchange API
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use crate::cli::OrderRequest;
use crate::types::exchange::order::OrderSide;
use crate::types::exchange::{
    Builder, CancelRequest, Grouping, LimitOrder, Tif, Tpsl, TriggerOrder,
};
#[allow(unused_imports)]
use clap::{Args, Command, Parser, ValueEnum};
use serde::{Deserialize, Serialize};

/// CLI specific order type argument for order request.
#[derive(ValueEnum, Clone, Serialize, Deserialize)]
pub enum OrderTypeArg {
    #[serde(rename = "limit")]
    Limit,
    #[serde(rename = "trigger")]
    Trigger,
}

/// Command for placing an order
#[derive(Args)]
pub struct OrderCmd {
    coin: String,
    #[arg(value_enum)]
    side: OrderSide,
    size: String,

    // Order type (limit vs trigger)
    #[arg(long, default_value = "limit")]
    #[arg(value_enum)]
    order_type: OrderTypeArg,

    // Limit order fields
    #[arg(long, required_if_eq("order_type", "limit"))]
    price: Option<String>,

    #[arg(long, default_value = "gtc")]
    #[arg(value_enum)]
    tif: Tif,

    // Trigger order fields
    #[arg(long, required_if_eq("order_type", "trigger"))]
    trigger_price: Option<String>,

    #[arg(long, requires = "trigger_price")]
    #[arg(value_enum)]
    tpsl: Option<Tpsl>,

    #[arg(long)]
    trigger_market: bool,

    // Optional flags
    #[arg(long)]
    reduce_only: bool,

    #[arg(long)]
    cloid: Option<String>,

    // Function params
    #[arg(long, default_value = "na")]
    #[arg(value_enum)]
    grouping: Grouping,

    #[arg(long)]
    vault_address: Option<String>,

    #[arg(long)]
    expires_after: Option<u64>,

    // Builder fee
    #[arg(long)]
    builder_address: Option<String>,

    #[arg(long, requires = "builder_address")]
    builder_fee: Option<u32>,
}

impl OrderCmd {
    /// Builds the order request using the `asset_idx` and
    /// the command line arguments.
    pub fn build(
        self,
        asset_idx: u32,
    ) -> (
        OrderRequest,
        Grouping,
        Option<Builder>,
        Option<String>,
        Option<u64>,
    ) {
        use crate::types::exchange::{OrderRequest, OrderType};

        let order_type = match self.order_type {
            OrderTypeArg::Limit => OrderType::Limit(LimitOrder { tif: self.tif }),
            OrderTypeArg::Trigger => OrderType::Trigger(TriggerOrder {
                is_market: self.trigger_market,
                trigger_px: self
                    .trigger_price
                    .clone()
                    .expect("--trigger price required for trigger orders"),
                tpsl: self.tpsl.expect("--tpsl required for trigger orders"),
            }),
        };

        let builder = self.builder_address.map(|b| Builder {
            b,
            f: self.builder_fee.expect(""),
        });

        let price = match self.order_type {
            OrderTypeArg::Limit => self.price.ok_or("--price required for limit orders"),
            OrderTypeArg::Trigger => Ok(self.trigger_price.clone().unwrap_or_default()),
        };

        let order = OrderRequest {
            a: asset_idx,
            b: matches!(self.side, OrderSide::Buy),
            p: price.expect("--price required for limit orders"),
            s: self.size,
            r: self.reduce_only,
            t: order_type,
            c: self.cloid,
        };

        (
            order,
            self.grouping,
            builder,
            self.vault_address,
            self.expires_after,
        )
    }

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

/// Cmd arguments for a cancel order request
#[derive(Args)]
pub struct CancelOrderByOidCmd {
    /// Name of coin
    coin: String,

    /// Order id
    o: u64,

    /// Asset index
    #[arg(long)]
    a: Option<u32>,

    #[arg(long)]
    vault_address: Option<String>,

    #[arg(long)]
    expires_after: Option<u64>,
}

impl CancelOrderByOidCmd {
    /// Builds the order request using the `asset_idx` and
    /// the command line arguments.
    pub fn build(self, asset_idx: u32) -> (CancelRequest, Option<String>, Option<u64>) {
        let cancel_req = CancelRequest {
            a: self.a.unwrap_or(asset_idx),
            o: self.o,
        };

        (cancel_req, self.vault_address, self.expires_after)
    }

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