Enum HyperliquidMarket 

pub enum HyperliquidMarket {
    Perp {
        base: String,
        quote: String,
        index: u32,
        instrument_meta: Option<InstrumentMetaConfig>,
    },
    Spot {
        base: String,
        quote: String,
        index: u32,
        instrument_meta: Option<InstrumentMetaConfig>,
    },
    Hip3 {
        base: String,
        quote: String,
        dex: String,
        dex_index: u32,
        asset_index: u32,
        instrument_meta: Option<InstrumentMetaConfig>,
    },
    Outcome {
        name: String,
        outcome_id: u32,
        side: u8,
        instrument_meta: Option<InstrumentMetaConfig>,
    },
}

Hyperliquid market types — Perp, Spot, HIP-3, or Outcome.

Variants

Perp

Standard perpetual contract on main Hyperliquid.

Fields

base: String

Base asset (e.g., “BTC”, “ETH”)

quote: String

Quote asset (always “USDC” for main perps)

index: u32

Asset index on Hyperliquid (e.g., 0 for BTC)

instrument_meta: Option<InstrumentMetaConfig>

Instrument metadata (tick/lot sizes)

Spot

Spot market on Hyperliquid.

Fields

base: String

Base asset (e.g., “HYPE”, “PURR”)

quote: String

Quote asset (e.g., “USDC”)

index: u32

Spot market index (e.g., 10107 for HYPE/USDC)

instrument_meta: Option<InstrumentMetaConfig>

Instrument metadata (tick/lot sizes)

Hip3

HIP-3 builder-deployed perpetual DEX.

Fields

base: String

Base asset (e.g., “BTC”, “HFUN”)

quote: String

Quote currency (e.g., “USDC”, “USDE”, “USDH”)

dex: String

DEX name (e.g., “hyna”, “hypurrfun”)

dex_index: u32

DEX index in perpDexs() array (starts at 1)

asset_index: u32

Asset index within this DEX’s meta.universe

instrument_meta: Option<InstrumentMetaConfig>

Instrument metadata (tick/lot sizes)

Outcome

Prediction market outcome.

Outcomes trade like spot but use asset ID = 100_000_000 + encoding, where encoding = 10 * outcome_id + side. Live outcome books quote in USDH.

Fields

name: String

Human-readable name (e.g., “BTC > 69070”)

outcome_id: u32

Outcome ID from outcomeMeta (e.g., 516)

side: u8

Side: 0 = Yes, 1 = No

instrument_meta: Option<InstrumentMetaConfig>

Instrument metadata (tick/lot sizes)

Implementations

impl HyperliquidMarket

pub fn outcome_encoding(outcome_id: u32, side: u8) -> u32

Calculate the encoding for an outcome: 10 * outcome_id + side.

pub fn instrument_id(&self) -> InstrumentId

Get the canonical instrument ID.

pub fn market_index(&self) -> MarketIndex

Get the market index.

pub fn is_spot(&self) -> bool

Check if this is a spot market.

pub fn is_spot_like(&self) -> bool

Check if this market settles like spot with no margin/leverage.

pub fn is_outcome(&self) -> bool

Check if this is a prediction market outcome.

pub fn base(&self) -> &str

Get the base asset.

pub fn quote(&self) -> &str

Get the quote asset.

pub fn effective_asset_id(&self) -> u32

Get the effective asset ID for order placement.

• Perp: returns the index directly
• Spot: returns the index directly (e.g., 10107)
• Hip3: calculates 110000 + ((dex_index-1) * 10000) + asset_index
• Outcome: returns 100_000_000 + encoding

pub fn coin_name(&self) -> Option<String>

Get the coin name used in allMids/fills lookups.

• Outcome: #<encoding> (e.g., #5160)
• Spot: base coin name (e.g., HYPE)
• Others: None (uses standard name)

pub fn spot_coin(&self) -> Option<String>

Get the spot coin name for @tokenId alias resolution.

pub fn spot_market_index(&self) -> Option<u32>

Get the spot market index for price lookups.

pub fn hip3_config(&self) -> Option<Hip3MarketConfig>

Get HIP-3 configuration if applicable.

pub fn uses_alternate_collateral(&self) -> bool

Check if this HIP-3 market uses non-USDC collateral.

pub fn dex_name(&self) -> Option<&str>

Get the DEX name for API calls (None for non-HIP3).

pub fn instrument_meta(&self) -> Option<&InstrumentMetaConfig>

Get instrument metadata if configured.

pub fn price_bounds(&self) -> Option<(Decimal, Decimal)>

Optional exclusive price bounds for markets with bounded price domains.

pub fn validation_errors(&self) -> Vec<String>

Validate Hyperliquid market-specific invariants.

Trait Implementations

impl Clone for HyperliquidMarket

fn clone(&self) -> HyperliquidMarket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperliquidMarket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HyperliquidMarket

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HyperliquidMarket

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for HyperliquidMarket

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

where __S: Serializer,

Serialize this value into the given Serde serializer.