df-hyperliquid-core 0.0.9-beta

Hyperliquid SDK for Rust: markets, account, trading, transfers, earn and deploy, with exact decimals and signing. Native and wasm.
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

//! `vaultTransfer`: `{type, vaultAddress, isDeposit, usd}`, keys in that order, `usd` in
//! millionths. HLP's address and a vault's lockup differ between the networks.

use crate::account::{ActionKind, Signers};
use crate::client::Network;
use crate::utils::sign::{L1Action, Map};
use crate::utils::{Address, BadUnits, Dec, USDC_DECIMALS, exact_units};

const fn address(text: &str) -> Address {
    match Address::parse_const(text) {
        Some(address) => address,
        None => Address::ZERO,
    }
}

/// The protocol vault on mainnet, which any account can deposit into.
pub const MAINNET_HLP: Address = address("0xdfc24b077bc1425ad1dea75bcb6f8158e10df303");

/// Testnet's protocol vault, not in the docs; its `vaultDetails` names it
/// "Hyperliquidity Provider (HLP)".
pub const TESTNET_HLP: Address = address("0xa15099a30bbf2e68942d6f4c43d70d04faeab0a0");

/// How long a deposit into HLP is locked, on both networks: four days, as
/// every single-deposit follower of either shows.
pub const HLP_LOCKUP_MS: u64 = 4 * 86_400_000;

/// How long a deposit into any other vault on mainnet is locked: a day.
pub const MAINNET_VAULT_LOCKUP_MS: u64 = 86_400_000;

/// Testnet's lockup for any other vault: twenty seconds, as the single-deposit
/// followers of its user vaults show.
pub const TESTNET_VAULT_LOCKUP_MS: u64 = 20_000;

/// The network's HLP.
#[must_use]
pub const fn hlp(network: Network) -> Address {
    match network {
        Network::Mainnet => MAINNET_HLP,
        Network::Testnet => TESTNET_HLP,
    }
}

/// The lockup a deposit into `vault` on `network` starts.
#[must_use]
pub fn lockup_ms(network: Network, vault: Address) -> u64 {
    match (vault == hlp(network), network) {
        (true, _) => HLP_LOCKUP_MS,
        (false, Network::Mainnet) => MAINNET_VAULT_LOCKUP_MS,
        (false, Network::Testnet) => TESTNET_VAULT_LOCKUP_MS,
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct VaultTransfer {
    vault: Address,
    is_deposit: bool,
    usd: u64,
}

impl VaultTransfer {
    /// L1: an agent may sign it for its master.
    pub const KEY: Signers = ActionKind::VaultTransfer.signers();

    /// USDC from the perp balance into `vault`, at most six places: refused
    /// rather than rounded when finer.
    pub fn deposit(vault: Address, usdc: Dec) -> Result<VaultTransfer, BadUnits> {
        Ok(VaultTransfer { vault, is_deposit: true, usd: exact_units(usdc, USDC_DECIMALS)? })
    }

    /// USDC out of `vault` once its lockup has passed. A whole equity runs
    /// past six places; cut it first (`crate::utils::cut_units`) or take
    /// `maxWithdrawable` from [`crate::earn::vaults::vault_details`].
    pub fn withdraw(vault: Address, usdc: Dec) -> Result<VaultTransfer, BadUnits> {
        Ok(VaultTransfer { vault, is_deposit: false, usd: exact_units(usdc, USDC_DECIMALS)? })
    }

    /// From a count of millionths already made.
    #[must_use]
    pub const fn from_micros(vault: Address, is_deposit: bool, usd: u64) -> VaultTransfer {
        VaultTransfer { vault, is_deposit, usd }
    }

    #[must_use]
    pub const fn usd(&self) -> u64 {
        self.usd
    }

    #[must_use]
    pub const fn vault(&self) -> Address {
        self.vault
    }
}

impl L1Action for VaultTransfer {
    fn action(&self) -> Map {
        Map::new()
            .put("type", "vaultTransfer")
            .put("vaultAddress", self.vault.to_hex())
            .put("isDeposit", self.is_deposit)
            .put("usd", self.usd)
    }
}