Struct OrderWire 

#[non_exhaustive]
pub struct OrderWire {
    pub asset: u32,
    pub is_buy: bool,
    pub limit_px: String,
    pub sz: String,
    pub reduce_only: bool,
    pub order_type: OrderTypeWire,
    pub cloid: Option<String>,
}

Wire format for an order sent to the Hyperliquid exchange.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

asset: u32

Asset index (perp index or spot index with offset).

is_buy: bool

Whether this is a buy order.

limit_px: String

Limit price as a decimal string.

sz: String

Size as a decimal string.

reduce_only: bool

Whether the order is reduce-only.

order_type: OrderTypeWire

Order type wire format.

cloid: Option<String>

Optional client order ID.

Implementations

impl OrderWire

pub fn limit_buy(asset: u32, limit_px: Decimal, sz: Decimal) -> OrderWireBuilder

Start building a limit buy order.

Defaults to Tif::Gtc, reduce_only = false, no cloid.

Example

use hl_types::{OrderWire, Tif};
use rust_decimal::Decimal;
use std::str::FromStr;

let order = OrderWire::limit_buy(0, Decimal::from(90000), Decimal::from_str("0.001").unwrap())
    .tif(Tif::Gtc)
    .cloid("my-order-1")
    .build()
    .unwrap();

assert!(order.is_buy);
assert_eq!(order.limit_px, "90000");

pub fn limit_sell( asset: u32, limit_px: Decimal, sz: Decimal, ) -> OrderWireBuilder

Start building a limit sell order.

Defaults to Tif::Gtc, reduce_only = false, no cloid.

pub fn trigger_buy( asset: u32, trigger_px: Decimal, sz: Decimal, tpsl: Tpsl, ) -> OrderWireBuilder

Start building a trigger buy order (e.g. stop-loss or take-profit).

Trigger orders fire as market orders when the trigger price is hit. Defaults to reduce_only = true, no cloid.

pub fn trigger_sell( asset: u32, trigger_px: Decimal, sz: Decimal, tpsl: Tpsl, ) -> OrderWireBuilder

Start building a trigger sell order (e.g. stop-loss or take-profit).

Trigger orders fire as market orders when the trigger price is hit. Defaults to reduce_only = true, no cloid.

Trait Implementations

impl Clone for OrderWire

fn clone(&self) -> OrderWire

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderWire

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderWire

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderWire

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OrderWire

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OrderWire

impl StructuralPartialEq for OrderWire