hyperliquid 0.2.4

A Rust library for the Hyperliquid 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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
use std::{sync::Arc, time::SystemTime};

use ethers::{
    signers::{LocalWallet, Signer},
    types::{Address, Signature, H256},
    utils::to_checksum,
};

use crate::{
    client::Client,
    error::Result,
    types::{
        agent::l1,
        exchange::{
            request::{
                Action, ApproveAgent, CancelByCloidRequest, CancelRequest, Grouping, ModifyRequest,
                OrderRequest, Request, TwapRequest, UsdSend, Withdraw3,
            },
            response::Response,
        },
        Chain, HyperliquidChain, API,
    },
    Error,
};

/// Endpoint to interact with and trade on the Hyperliquid chain.
pub struct Exchange {
    pub client: Client,
    pub chain: Chain,
}

impl Exchange {
    /// Place an order
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `orders` - The orders to place
    /// * `vault_address` - If trading on behalf of a vault, its onchain address in 42-character hexadecimal format
    ///  e.g. `0x0000000000000000000000000000000000000000`
    ///
    ///  # Note
    /// * `cloid` in argument `order` is an optional 128 bit hex string, e.g. `0x1234567890abcdef1234567890abcdef`
    pub async fn place_order(
        &self,
        wallet: Arc<LocalWallet>,
        orders: Vec<OrderRequest>,
        vault_address: Option<Address>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::Order {
            grouping: Grouping::Na,
            orders,
        };

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Place a normal order with tpsl order
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `orders` - The orders to place
    /// * `vault_address` - If trading on behalf of a vault, its onchain address in 42-character hexadecimal format
    /// e.g. `0x0000000000000000000000000000000000000000`
    ///
    /// # Note
    /// * `cloid` in argument `order` is an optional 128 bit hex string, e.g. `0x1234567890abcdef1234567890abcdef`
    pub async fn normal_tpsl(
        &self,
        wallet: Arc<LocalWallet>,
        orders: Vec<OrderRequest>,
        vault_address: Option<Address>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::Order {
            grouping: Grouping::NormalTpsl,
            orders,
        };

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Cancel an order
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `cancels` - The orders to cancel
    /// * `vault_address` - If trading on behalf of a vault, its onchain address in 42-character hexadecimal format
    /// e.g. `0x0000000000000000000000000000000000000000`
    pub async fn cancel_order(
        &self,
        wallet: Arc<LocalWallet>,
        cancels: Vec<CancelRequest>,
        vault_address: Option<Address>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::Cancel { cancels };

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Cancel order(s) by client order id (cloid)
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `cancels` - The client orders to cancel
    /// * `vault_address` - If trading on behalf of a vault, its onchain address in 42-character hexadecimal format
    /// e.g. `0x0000000000000000000000000000000000000000`
    ///
    /// Note: `cloid` in argument `cancel` is a 128 bit hex string, e.g. `0x1234567890abcdef1234567890abcdef`
    pub async fn cancel_order_by_cloid(
        &self,
        wallet: Arc<LocalWallet>,
        cancels: Vec<CancelByCloidRequest>,
        vault_address: Option<Address>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::CancelByCloid { cancels };

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Modify an order
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `order` - The orders to modify
    /// * `vault_address` - If trading on behalf of a vault, its onchain address in 42-character hexadecimal format
    /// e.g. `0x0000000000000000000000000000000000000000`
    ///
    /// Note: `cloid` in argument `order` is an optional 128 bit hex string, e.g. `0x1234567890abcdef1234567890abcdef`
    pub async fn modify_order(
        &self,
        wallet: Arc<LocalWallet>,
        order: ModifyRequest,
        vault_address: Option<Address>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::Modify(order);

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Batch modify orders
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `orders` - The orders to modify
    /// * `vault_address` - If trading on behalf of a vault, its onchain address in 42-character hexadecimal format
    /// e.g. `0x0000000000000000000000000000000000000000`
    pub async fn batch_modify_orders(
        &self,
        wallet: Arc<LocalWallet>,
        orders: Vec<ModifyRequest>,
        vault_address: Option<Address>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::BatchModify { modifies: orders };

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Update cross or isolated leverage on a coin
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `leverage` - The new leverage to set
    /// * `asset` - The asset to set the leverage for
    /// * `is_cross` - true if cross leverage, false if isolated leverage
    pub async fn update_leverage(
        &self,
        wallet: Arc<LocalWallet>,
        leverage: u32,
        asset: u32,
        is_cross: bool,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::UpdateLeverage {
            asset,
            is_cross,
            leverage,
        };

        let vault_address = None;

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Add or remove margin from isolated position
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `asset` - The asset to set the margin for
    /// * `is_buy` - true if adding margin, false if removing margin
    /// * `ntli` - The new margin to set
    pub async fn update_isolated_margin(
        &self,
        wallet: Arc<LocalWallet>,
        asset: u32,
        is_buy: bool,
        ntli: i64,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::UpdateIsolatedMargin {
            asset,
            is_buy,
            ntli,
        };

        let vault_address = None;

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Place a TWAP order
    /// # Arguments
    /// * `wallet` - The wallet to sign the order with
    /// * `twap` - The twap order to place
    /// * `vault_address` - If trading on behalf of a vault, its onchain address in 42-character hexadecimal format
    /// e.g. `0x0000000000000000000000000000000000000000`
    pub async fn twap_order(
        &self,
        wallet: Arc<LocalWallet>,
        twap: TwapRequest,
        vault_address: Option<Address>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::TwapOrder { twap };

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Send usd to another address. This transfer does not touch the EVM bridge. The signature
    /// format is human readable for wallet interfaces.
    ///
    /// # Arguments
    /// * `from` - The wallet to sign the transfer with
    /// * `destination` - The address to send the usd to
    /// * `amount` - The amount of usd to send
    pub async fn usdc_transfer(
        &self,
        from: Arc<LocalWallet>,
        destination: Address,
        amount: String,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let hyperliquid_chain = match self.chain {
            Chain::Arbitrum => HyperliquidChain::Mainnet,
            Chain::ArbitrumTestnet => HyperliquidChain::Testnet,
            _ => return Err(Error::ChainNotSupported(self.chain.to_string())),
        };

        let payload = UsdSend {
            signature_chain_id: 421614.into(),
            hyperliquid_chain,
            amount,
            destination: to_checksum(&destination, None),
            time: nonce,
        };

        let signature = from.sign_typed_data(&payload).await?;

        let action = Action::UsdSend(payload);

        let request = Request {
            action,
            nonce,
            signature,
            vault_address: None,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Withdraw from bridge
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the withdrawal with
    /// * `destination` - The address to send the usd to
    /// * `amount` - The amount of usd to send
    pub async fn withdraw_from_bridge(
        &self,
        wallet: Arc<LocalWallet>,
        destination: Address,
        amount: String,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let hyperliquid_chain = match self.chain {
            Chain::Arbitrum => HyperliquidChain::Mainnet,
            Chain::ArbitrumTestnet => HyperliquidChain::Testnet,
            _ => return Err(Error::ChainNotSupported(self.chain.to_string())),
        };

        let payload = Withdraw3 {
            hyperliquid_chain,
            signature_chain_id: 421614.into(),
            amount,
            destination: to_checksum(&destination, None),
            time: nonce,
        };

        let signature = wallet.sign_typed_data(&payload).await?;

        let action = Action::Withdraw3(payload);

        let request = Request {
            action,
            nonce,
            signature,
            vault_address: None,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Approve an agent to trade on behalf of the user
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the approval with
    /// * `agent_address` - The address of the agent to approve
    /// * `agent_name` - An optional name for the agent
    pub async fn approve_agent(
        &self,
        wallet: Arc<LocalWallet>,
        agent_address: Address,
        agent_name: Option<String>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let hyperliquid_chain = match self.chain {
            Chain::Arbitrum => HyperliquidChain::Mainnet,
            Chain::ArbitrumTestnet => HyperliquidChain::Testnet,
            _ => return Err(Error::ChainNotSupported(self.chain.to_string())),
        };

        let agent = ApproveAgent {
            hyperliquid_chain,
            signature_chain_id: 421614.into(),
            agent_address,
            nonce,
            agent_name,
        };

        let signature = wallet.sign_typed_data(&agent).await?;

        let action = Action::ApproveAgent(agent);

        let request = Request {
            action,
            nonce,
            signature,
            vault_address: None,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Create subaccount for the user
    ///
    /// # Arguments
    /// * `wallet` - The wallet to create the subaccount with
    /// * `name` - The name of the subaccount
    pub async fn create_sub_account(
        &self,
        wallet: Arc<LocalWallet>,
        name: String,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::CreateSubAccount { name };

        let vault_address = None;

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Rename subaccount
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the rename with
    /// * `name` - The new name of the subaccount
    /// * `sub_account_user` - The address of the subaccount to rename
    pub async fn sub_account_modify(
        &self,
        wallet: Arc<LocalWallet>,
        name: String,
        sub_account_user: Address,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::SubAccountModify {
            name,
            sub_account_user,
        };

        let vault_address = None;

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Transfer funds between subaccounts
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the transfer with
    /// * `from` - The subaccount to transfer from
    pub async fn sub_account_transfer(
        &self,
        wallet: Arc<LocalWallet>,
        is_deposit: bool,
        sub_account_user: Address,
        usd: u64,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::SubAccountTransfer {
            is_deposit,
            sub_account_user,
            usd,
        };

        let vault_address = None;

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Set referrer for the user
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the transfer with
    /// * `code` - The referrer code
    pub async fn set_referrer(&self, wallet: Arc<LocalWallet>, code: String) -> Result<Response> {
        let nonce = self.nonce()?;

        let action = Action::SetReferrer { code };

        let vault_address = None;

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    /// Schedule a time in (UTC ms) to cancel all open orders
    ///
    /// # Arguments
    /// * `wallet` - The wallet to sign the transaction with
    /// * `time` - Optional time in milliseconds to cancel all open orders
    ///
    /// # Note
    /// * If `time` is `None`, then unsets any cancel time in the future.
    /// `time` must be atleast 5 seconds after the current time
    /// * Once the time is reached, all open orders will be cancelled and trigger count will be incremented.
    /// The max number of triggers is 10 per day. Trigger count resets at 00:00 UTC
    pub async fn schedule_cancel(
        &self,
        wallet: Arc<LocalWallet>,
        time: Option<u64>,
    ) -> Result<Response> {
        let nonce = self.nonce()?;

        let time = time.unwrap_or_else(|| nonce + 5000);

        let action = Action::ScheduleCancel { time };

        let vault_address = None;

        let connection_id = action.connection_id(vault_address, nonce)?;

        let signature = self.sign_l1_action(wallet, connection_id).await?;

        let request = Request {
            action,
            nonce,
            signature,
            vault_address,
        };

        self.client.post(&API::Exchange, &request).await
    }

    async fn sign_l1_action(
        &self,
        wallet: Arc<LocalWallet>,
        connection_id: H256,
    ) -> Result<Signature> {
        let source = match self.chain {
            Chain::Arbitrum => "a".to_string(),
            Chain::ArbitrumTestnet => "b".to_string(),
            _ => return Err(Error::ChainNotSupported(self.chain.to_string())),
        };

        let payload = l1::Agent {
            source,
            connection_id,
        };

        Ok(wallet.sign_typed_data(&payload).await?)
    }

    /// get the next nonce to use
    fn nonce(&self) -> Result<u64> {
        let now = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?;

        Ok(now.as_millis() as u64)
    }
}