Struct OrderPrecision 

pub struct OrderPrecision { /* private fields */ }

Hyperliquid’s precision rules for one market’s orders. See the module docs.

Read it from HyperliquidClient::order_precision or HyperliquidSpotClient::order_precision, or build it from metadata with perp or spot.

The clients refuse an order whose quantity, price or trigger price breaks these rules with OrderError::InvalidPrecision, and never round it themselves. Round with round_quantity and round_price first, in the direction your strategy needs.

Implementations

impl OrderPrecision

pub const MAX_SIGNIFICANT_FIGURES: u32 = 5

The most significant figures a price that is not an integer may have.

pub const fn perp(sz_decimals: u32) -> Self

The rules for a perpetual whose szDecimals is sz_decimals.

pub const fn spot(base_sz_decimals: u32) -> Self

The rules for a spot pair whose base token’s szDecimals is base_sz_decimals.

pub const fn quantity_decimals(&self) -> u32

The most decimal places a quantity may have: the asset’s szDecimals.

pub const fn price_decimals(&self) -> u32

The most decimal places a price may have: MAX_DECIMALS - szDecimals, and never fewer than zero.

pub fn check_quantity( &self, quantity: Decimal, ) -> Result<(), PrecisionViolation>

Check that quantity is positive, meets the rules, and can be sent exactly.

Errors

The rule quantity breaks, as a PrecisionViolation naming OrderField::Quantity.

pub fn check_price(&self, price: Decimal) -> Result<(), PrecisionViolation>

Check that the limit price price is positive, meets the rules, and can be sent exactly.

Errors

The rule price breaks, as a PrecisionViolation naming OrderField::Price.

pub fn check_trigger_price( &self, trigger_price: Decimal, ) -> Result<(), PrecisionViolation>

Check a stop or take-profit order’s trigger_price as check_price checks a limit price: it follows the same rules.

Errors

The rule trigger_price breaks, as a PrecisionViolation naming OrderField::TriggerPrice.

pub fn round_quantity( &self, quantity: Decimal, strategy: RoundingStrategy, ) -> Decimal

quantity rounded to the decimal places the rules allow, by strategy.

A quantity smaller than the smallest step can round to zero, which check_quantity refuses.

pub fn round_price(&self, price: Decimal, strategy: RoundingStrategy) -> Decimal

price rounded by strategy to the decimal places and significant figures the rules allow. An integer price is returned unchanged.

A price smaller than the smallest step the decimal places allow can round to zero, which check_price refuses.

Trait Implementations

impl Clone for OrderPrecision

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for OrderPrecision

impl Debug for OrderPrecision

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for OrderPrecision

impl Hash for OrderPrecision

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OrderPrecision

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OrderPrecision