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

use crate::account::state::{Abstraction, PerpState, SpotState};
use crate::utils::Dec;

/// An account's USDC as one figure. A standard account keeps USDC in two places, spot and the
/// perp balance; a pooled one keeps it all in spot, and its perp figures are not counted.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Dollars {
    /// Spot USDC `total`, which includes what is on hold.
    pub spot_total: Dec,
    /// Spot USDC `total - hold`.
    pub spot_available: Dec,
    /// Perp `withdrawable`; zero on a pooled account.
    pub perp_withdrawable: Dec,
    /// `spot_total + perp_withdrawable`.
    pub total: Dec,
    /// `spot_available + perp_withdrawable`.
    pub available: Dec,
}

impl Dollars {
    /// `None` only past what a `Dec` counts.
    #[must_use]
    pub fn new(abstraction: &Abstraction, spot: &SpotState, perp: &PerpState) -> Option<Dollars> {
        let (spot_total, spot_available) = match spot.usdc() {
            Some(usdc) => (usdc.total, usdc.available()?),
            None => (Dec::ZERO, Dec::ZERO),
        };
        let perp_withdrawable = match abstraction.is_pooled() {
            true => Dec::ZERO,
            false => perp.withdrawable,
        };
        Some(Dollars {
            spot_total,
            spot_available,
            perp_withdrawable,
            total: spot_total.checked_add(perp_withdrawable)?,
            available: spot_available.checked_add(perp_withdrawable)?,
        })
    }
}