df-hyperliquid-core 0.0.8-beta.1

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

//! `tokenDetails`: one token's supply, prices and deployment, asked by its token id (`0x` and 32
//! hex digits, as `spotMeta` writes it).

use crate::client::{ApiError, Transport, info, info_request};
use crate::utils::{Address, Dec, Json};
use serde::Deserialize;

/// `{"type":"tokenDetails","tokenId":..}`.
#[must_use]
pub fn token_details_request(token_id: &str) -> String {
    info_request("tokenDetails", &[("tokenId", Json::String(token_id.to_owned()))])
}

/// HYPE's answer carries every genesis balance, near 100,000 of them: megabytes.
pub async fn token_details(transport: &impl Transport, token_id: &str) -> Result<TokenDetails, ApiError> {
    info(transport, token_details_request(token_id)).await
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TokenDetails {
    pub name: String,
    pub max_supply: Dec,
    pub total_supply: Dec,
    pub circulating_supply: Dec,
    pub sz_decimals: u32,
    pub wei_decimals: u32,
    /// Prices on its pair with USDC; left out without one.
    #[serde(default)]
    pub mid_px: Option<Dec>,
    #[serde(default)]
    pub mark_px: Option<Dec>,
    #[serde(default)]
    pub prev_day_px: Option<Dec>,
    /// `null` once a deployment has finished with none left to read.
    #[serde(default)]
    pub genesis: Option<Genesis>,
    /// `null` for a token the venue itself deployed (HYPE, USDC).
    #[serde(default)]
    pub deployer: Option<Address>,
    /// What the deployer paid at the auction, in HYPE.
    #[serde(default)]
    pub deploy_gas: Option<Dec>,
    /// As the venue writes it: `2024-11-29T06:45:52.532`, UTC, no zone.
    #[serde(default)]
    pub deploy_time: Option<String>,
    /// The USDC the deployer seeded its order book's bids with.
    pub seeded_usdc: Dec,
    /// Balances not counted as circulating.
    #[serde(default)]
    pub non_circulating_user_balances: Vec<(Address, Dec)>,
    pub future_emissions: Dec,
}

/// What a token was deployed with.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Genesis {
    pub user_balances: Vec<(Address, Dec)>,
    /// Shares handed to the holders of other tokens, by token index.
    #[serde(default)]
    pub existing_token_balances: Vec<(u32, Dec)>,
    #[serde(default)]
    pub blacklist_users: Vec<Address>,
}