Struct HyperliquidAssetId 

pub struct HyperliquidAssetId(pub u32);

Represents an asset ID for Hyperliquid.

Asset IDs follow Hyperliquid’s convention:

• Perps: raw index into meta.universe (0..10_000)
• Spot: 10_000 + index in spotMeta.universe (10_000..100_000)
• Builder perps: 100_000 + dex_index * 10_000 + meta_index (100_000..100_000_000)
• Outcomes (HIP-4): 100_000_000 + 10 * outcome + side where side is 0 or 1

Tuple Fields

0: u32

Implementations

impl HyperliquidAssetId

pub fn perp(index: u32) -> Self

Creates a perpetual asset ID from raw index.

pub fn spot(index: u32) -> Self

Creates a spot asset ID (10_000 + index).

pub fn builder_perp(dex_index: u32, meta_index: u32) -> Self

Creates a builder perpetual asset ID.

pub fn outcome(outcome: u32, side: u8) -> Self

Creates an outcome (HIP-4) asset ID from outcome and side.

Encoding: 100_000_000 + 10 * outcome + side. Only sides 0 and 1 are valid for binary outcomes.

Panics

Panics if side is not 0 or 1.

pub fn from_outcome_encoding(encoding: u32) -> Option<Self>

Creates an outcome (HIP-4) asset ID from an encoded 10 * outcome + side value.

pub fn is_perp(self) -> bool

Checks if this is a perp asset (raw index, < 10_000).

pub fn is_spot(self) -> bool

Checks if this is a spot asset (10_000..100_000).

pub fn is_builder_perp(self) -> bool

Checks if this is a builder perp (100_000..100_000_000).

pub fn is_outcome(self) -> bool

Checks if this is a valid outcome (HIP-4) asset.

Requires the id to be in the outcome range and have a valid side digit (0 or 1). Ids in the range with side digits 2..=9 are not valid HIP-4 outcomes per the protocol.

pub fn base_index(self) -> u32

Gets the base index for the asset.

• Perp: raw index.
• Spot: asset_id - 10_000.
• Builder perp: meta index within the dex.
• Outcome: encoding 10 * outcome + side.

pub fn outcome_index(self) -> Option<u32>

Returns the outcome number for an outcome asset, otherwise None.

pub fn outcome_side(self) -> Option<u8>

Returns the outcome side (0 or 1) for an outcome asset, otherwise None.

pub fn outcome_encoding(self) -> Option<u32>

Returns the outcome encoding (10 * outcome + side) for an outcome asset.

pub fn to_raw(self) -> u32

Gets the raw asset ID value.

Trait Implementations

impl Clone for HyperliquidAssetId

fn clone(&self) -> HyperliquidAssetId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperliquidAssetId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HyperliquidAssetId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HyperliquidAssetId

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

Formats the value using the given formatter.

impl Hash for HyperliquidAssetId

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 HyperliquidAssetId

fn eq(&self, other: &HyperliquidAssetId) -> 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 HyperliquidAssetId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for HyperliquidAssetId

impl Eq for HyperliquidAssetId

impl StructuralPartialEq for HyperliquidAssetId