nautilus_hyperliquid/http/

client.rs

// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

//! Provides the HTTP client integration for the [Hyperliquid](https://hyperliquid.xyz/) REST API.
//!
//! This module defines and implements a [`HyperliquidHttpClient`] for sending requests to various
//! Hyperliquid endpoints. It handles request signing (when credentials are provided), constructs
//! valid HTTP requests using the [`HttpClient`], and parses the responses back into structured
//! data or an [`Error`].

use std::{
    collections::HashMap,
    env,
    num::NonZeroU32,
    sync::{Arc, LazyLock},
    time::Duration,
};

use ahash::AHashMap;
use anyhow::Context;
use nautilus_core::{
    AtomicMap, UUID4, UnixNanos,
    consts::NAUTILUS_USER_AGENT,
    time::{AtomicTime, get_atomic_clock_realtime},
};
use nautilus_model::{
    data::{Bar, BarType},
    enums::{
        AccountType, BarAggregation, CurrencyType, OrderSide, OrderStatus, OrderType, TimeInForce,
        TriggerType,
    },
    events::AccountState,
    identifiers::{AccountId, ClientOrderId, InstrumentId, Symbol, VenueOrderId},
    instruments::{CurrencyPair, Instrument, InstrumentAny},
    orders::{Order, OrderAny},
    reports::{FillReport, OrderStatusReport, PositionStatusReport},
    types::{AccountBalance, Currency, Price, Quantity},
};
use nautilus_network::{
    http::{HttpClient, HttpClientError, HttpResponse, Method, USER_AGENT},
    ratelimiter::quota::Quota,
};
use rust_decimal::Decimal;
use serde_json::Value;
use ustr::Ustr;

use crate::{
    common::{
        consts::{HYPERLIQUID_VENUE, NAUTILUS_BUILDER_ADDRESS, exchange_url, info_url},
        credential::{Secrets, VaultAddress},
        enums::{
            HyperliquidBarInterval, HyperliquidEnvironment,
            HyperliquidOrderStatus as HyperliquidOrderStatusEnum, HyperliquidProductType,
        },
        parse::{
            bar_type_to_interval, clamp_price_to_precision, derive_limit_from_trigger,
            determine_order_list_grouping, extract_inner_error, normalize_price,
            order_to_hyperliquid_request_with_asset, parse_combined_account_balances_and_margins,
            parse_spot_account_balances, round_to_sig_figs, time_in_force_to_hyperliquid_tif,
        },
    },
    data::candle_to_bar,
    http::{
        error::{Error, Result},
        models::{
            ClearinghouseState, Cloid, HyperliquidCandleSnapshot, HyperliquidExchangeRequest,
            HyperliquidExchangeResponse, HyperliquidExecAction, HyperliquidExecBuilderFee,
            HyperliquidExecCancelByCloidRequest, HyperliquidExecCancelOrderRequest,
            HyperliquidExecGrouping, HyperliquidExecLimitParams, HyperliquidExecMergeOutcomeParams,
            HyperliquidExecMergeQuestionParams, HyperliquidExecModifyOrderRequest,
            HyperliquidExecNegateOutcomeParams, HyperliquidExecOrderKind,
            HyperliquidExecOrderResponseData, HyperliquidExecOrderStatus,
            HyperliquidExecPlaceOrderRequest, HyperliquidExecSplitOutcomeParams,
            HyperliquidExecTif, HyperliquidExecTpSl, HyperliquidExecTriggerParams,
            HyperliquidExecUserOutcomeOp, HyperliquidFills, HyperliquidFundingHistoryEntry,
            HyperliquidL2Book, HyperliquidMeta, HyperliquidOrderStatus, OutcomeMeta, PerpMeta,
            PerpMetaAndCtxs, RESPONSE_STATUS_OK, SpotClearinghouseState, SpotMeta, SpotMetaAndCtxs,
        },
        parse::{
            HyperliquidInstrumentDef, instruments_from_defs_owned, parse_fill_report,
            parse_order_status_report_from_basic, parse_outcome_instruments,
            parse_perp_instruments, parse_position_status_report, parse_spot_instruments,
            parse_spot_position_status_report,
        },
        query::{ExchangeAction, InfoRequest},
        rate_limits::{
            RateLimitSnapshot, WeightedLimiter, backoff_full_jitter, exchange_weight,
            info_base_weight, info_extra_weight,
        },
    },
    signing::{
        HyperliquidActionType, HyperliquidEip712Signer, NonceManager, SignRequest, types::SignerId,
    },
    websocket::messages::WsBasicOrderData,
};

// https://hyperliquid.xyz/docs/api#rate-limits
pub static HYPERLIQUID_REST_QUOTA: LazyLock<Quota> =
    LazyLock::new(|| Quota::per_minute(NonZeroU32::new(1200).unwrap()));

/// Provides a raw HTTP client for low-level Hyperliquid REST API operations.
///
/// This client handles HTTP infrastructure, request signing, and raw API calls
/// that closely match Hyperliquid endpoint specifications.
#[derive(Debug, Clone)]
#[cfg_attr(
    feature = "python",
    pyo3::pyclass(
        module = "nautilus_trader.core.nautilus_pyo3.hyperliquid",
        from_py_object
    )
)]
#[cfg_attr(
    feature = "python",
    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.hyperliquid")
)]
pub struct HyperliquidRawHttpClient {
    client: HttpClient,
    environment: HyperliquidEnvironment,
    base_info: String,
    base_exchange: String,
    signer: Option<HyperliquidEip712Signer>,
    nonce_manager: Option<Arc<NonceManager>>,
    vault_address: Option<VaultAddress>,
    rest_limiter: Arc<WeightedLimiter>,
    rate_limit_backoff_base: Duration,
    rate_limit_backoff_cap: Duration,
    rate_limit_max_attempts_info: u32,
}

impl HyperliquidRawHttpClient {
    /// Creates a new [`HyperliquidRawHttpClient`] for public endpoints only.
    ///
    /// # Errors
    ///
    /// Returns an error if the HTTP client cannot be created.
    pub fn new(
        environment: HyperliquidEnvironment,
        timeout_secs: u64,
        proxy_url: Option<String>,
    ) -> std::result::Result<Self, HttpClientError> {
        Ok(Self {
            client: HttpClient::new(
                Self::default_headers(),
                vec![],
                vec![],
                Some(*HYPERLIQUID_REST_QUOTA),
                Some(timeout_secs),
                proxy_url,
            )?,
            environment,
            base_info: info_url(environment).to_string(),
            base_exchange: exchange_url(environment).to_string(),
            signer: None,
            nonce_manager: None,
            vault_address: None,
            rest_limiter: Arc::new(WeightedLimiter::per_minute(1200)),
            rate_limit_backoff_base: Duration::from_millis(125),
            rate_limit_backoff_cap: Duration::from_secs(5),
            rate_limit_max_attempts_info: 3,
        })
    }

    /// Creates a new [`HyperliquidRawHttpClient`] configured with credentials
    /// for authenticated requests.
    ///
    /// # Errors
    ///
    /// Returns an error if the HTTP client cannot be created.
    pub fn with_credentials(
        secrets: &Secrets,
        timeout_secs: u64,
        proxy_url: Option<String>,
    ) -> std::result::Result<Self, HttpClientError> {
        let signer = HyperliquidEip712Signer::new(&secrets.private_key)
            .map_err(|e| HttpClientError::from(e.to_string()))?;
        let nonce_manager = Arc::new(NonceManager::new());

        Ok(Self {
            client: HttpClient::new(
                Self::default_headers(),
                vec![],
                vec![],
                Some(*HYPERLIQUID_REST_QUOTA),
                Some(timeout_secs),
                proxy_url,
            )?,
            environment: secrets.environment,
            base_info: info_url(secrets.environment).to_string(),
            base_exchange: exchange_url(secrets.environment).to_string(),
            signer: Some(signer),
            nonce_manager: Some(nonce_manager),
            vault_address: secrets.vault_address,
            rest_limiter: Arc::new(WeightedLimiter::per_minute(1200)),
            rate_limit_backoff_base: Duration::from_millis(125),
            rate_limit_backoff_cap: Duration::from_secs(5),
            rate_limit_max_attempts_info: 3,
        })
    }

    /// Overrides the base info URL (for testing with mock servers).
    pub fn set_base_info_url(&mut self, url: String) {
        self.base_info = url;
    }

    /// Overrides the base exchange URL (for testing with mock servers).
    pub fn set_base_exchange_url(&mut self, url: String) {
        self.base_exchange = url;
    }

    /// Creates an authenticated client from environment variables for the specified network.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if required environment variables are not set.
    pub fn from_env(environment: HyperliquidEnvironment) -> Result<Self> {
        let secrets = Secrets::from_env(environment)
            .map_err(|e| Error::auth(format!("missing credentials in environment: {e}")))?;
        Self::with_credentials(&secrets, 60, None)
            .map_err(|e| Error::auth(format!("Failed to create HTTP client: {e}")))
    }

    /// Creates a new [`HyperliquidRawHttpClient`] configured with explicit credentials.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if the private key is invalid or cannot be parsed.
    pub fn from_credentials(
        private_key: &str,
        vault_address: Option<&str>,
        environment: HyperliquidEnvironment,
        timeout_secs: u64,
        proxy_url: Option<String>,
    ) -> Result<Self> {
        let secrets = Secrets::from_private_key(private_key, vault_address, environment)
            .map_err(|e| Error::auth(format!("invalid credentials: {e}")))?;
        Self::with_credentials(&secrets, timeout_secs, proxy_url)
            .map_err(|e| Error::auth(format!("Failed to create HTTP client: {e}")))
    }

    /// Configure rate limiting parameters (chainable).
    #[must_use]
    pub fn with_rate_limits(mut self) -> Self {
        self.rest_limiter = Arc::new(WeightedLimiter::per_minute(1200));
        self.rate_limit_backoff_base = Duration::from_millis(125);
        self.rate_limit_backoff_cap = Duration::from_secs(5);
        self.rate_limit_max_attempts_info = 3;
        self
    }

    /// Returns the configured environment.
    #[must_use]
    pub fn environment(&self) -> HyperliquidEnvironment {
        self.environment
    }

    /// Returns whether this client is configured for testnet.
    #[must_use]
    pub fn is_testnet(&self) -> bool {
        self.environment == HyperliquidEnvironment::Testnet
    }

    /// Gets the user address derived from the private key (if client has credentials).
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if the client has no signer configured.
    pub fn get_user_address(&self) -> Result<String> {
        self.signer
            .as_ref()
            .ok_or_else(|| Error::auth("No signer configured"))?
            .address()
    }

    /// Returns `true` if a vault address is configured.
    #[must_use]
    pub fn has_vault_address(&self) -> bool {
        self.vault_address.is_some()
    }

    /// Gets the account address for queries: vault address if configured,
    /// otherwise the user (EOA) address.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if the client has no signer configured.
    pub fn get_account_address(&self) -> Result<String> {
        if let Some(vault) = &self.vault_address {
            Ok(vault.to_hex())
        } else {
            self.get_user_address()
        }
    }

    fn default_headers() -> HashMap<String, String> {
        HashMap::from([
            (USER_AGENT.to_string(), NAUTILUS_USER_AGENT.to_string()),
            ("Content-Type".to_string(), "application/json".to_string()),
        ])
    }

    fn signer_id(&self) -> SignerId {
        SignerId("hyperliquid:default".into())
    }

    fn parse_retry_after_simple(&self, headers: &HashMap<String, String>) -> Option<u64> {
        let retry_after = headers.get("retry-after")?;
        retry_after.parse::<u64>().ok().map(|s| s * 1000) // convert seconds to ms
    }

    /// Get metadata about available markets.
    pub async fn info_meta(&self) -> Result<HyperliquidMeta> {
        let request = InfoRequest::meta();
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get complete spot metadata (tokens and pairs).
    pub async fn get_spot_meta(&self) -> Result<SpotMeta> {
        let request = InfoRequest::spot_meta();
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get perpetuals metadata with asset contexts (for price precision refinement).
    pub async fn get_perp_meta_and_ctxs(&self) -> Result<PerpMetaAndCtxs> {
        let request = InfoRequest::meta_and_asset_ctxs();
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get spot metadata with asset contexts (for price precision refinement).
    pub async fn get_spot_meta_and_ctxs(&self) -> Result<SpotMetaAndCtxs> {
        let request = InfoRequest::spot_meta_and_asset_ctxs();
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get outcome metadata.
    pub async fn get_outcome_meta(&self) -> Result<OutcomeMeta> {
        let request = InfoRequest::outcome_meta();
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    pub(crate) async fn load_perp_meta(&self) -> Result<PerpMeta> {
        let request = InfoRequest::meta();
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get metadata for all perp dexes (standard + HIP-3).
    pub(crate) async fn load_all_perp_metas(&self) -> Result<Vec<PerpMeta>> {
        let request = InfoRequest::all_perp_metas();
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get L2 order book for a coin.
    pub async fn info_l2_book(&self, coin: &str) -> Result<HyperliquidL2Book> {
        let request = InfoRequest::l2_book(coin);
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get user fills (trading history).
    pub async fn info_user_fills(&self, user: &str) -> Result<HyperliquidFills> {
        let request = InfoRequest::user_fills(user);
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get order status for a user.
    pub async fn info_order_status(&self, user: &str, oid: u64) -> Result<HyperliquidOrderStatus> {
        let request = InfoRequest::order_status(user, oid);
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get all open orders for a user.
    pub async fn info_open_orders(&self, user: &str) -> Result<Value> {
        let request = InfoRequest::open_orders(user);
        self.send_info_request(&request).await
    }

    /// Get frontend open orders (includes more detail) for a user.
    pub async fn info_frontend_open_orders(&self, user: &str) -> Result<Value> {
        let request = InfoRequest::frontend_open_orders(user);
        self.send_info_request(&request).await
    }

    /// Get clearinghouse state (balances, positions, margin) for a user.
    pub async fn info_clearinghouse_state(&self, user: &str) -> Result<Value> {
        let request = InfoRequest::clearinghouse_state(user);
        self.send_info_request(&request).await
    }

    /// Get spot clearinghouse state (per-token spot balances) for a user.
    pub async fn info_spot_clearinghouse_state(&self, user: &str) -> Result<Value> {
        let request = InfoRequest::spot_clearinghouse_state(user);
        self.send_info_request(&request).await
    }

    /// Get user fee schedule and effective rates.
    pub async fn info_user_fees(&self, user: &str) -> Result<Value> {
        let request = InfoRequest::user_fees(user);
        self.send_info_request(&request).await
    }

    /// Get candle/bar data for a coin.
    pub async fn info_candle_snapshot(
        &self,
        coin: &str,
        interval: HyperliquidBarInterval,
        start_time: u64,
        end_time: u64,
    ) -> Result<HyperliquidCandleSnapshot> {
        let request = InfoRequest::candle_snapshot(coin, interval, start_time, end_time);
        let response = self.send_info_request(&request).await?;

        log::trace!(
            "Candle snapshot raw response (len={}): {:?}",
            response.as_array().map_or(0, |a| a.len()),
            response
        );

        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Get historical funding rates for a coin.
    ///
    /// `start_time` and `end_time` are Unix milliseconds. `end_time` is optional;
    /// if omitted, the venue returns entries up to the most recent funding.
    pub async fn info_funding_history(
        &self,
        coin: &str,
        start_time: u64,
        end_time: Option<u64>,
    ) -> Result<Vec<HyperliquidFundingHistoryEntry>> {
        let request = InfoRequest::funding_history(coin, start_time, end_time);
        let response = self.send_info_request(&request).await?;
        serde_json::from_value(response).map_err(Error::Serde)
    }

    /// Generic info request method that returns raw JSON (useful for new endpoints and testing).
    pub async fn send_info_request_raw(&self, request: &InfoRequest) -> Result<Value> {
        self.send_info_request(request).await
    }

    async fn send_info_request(&self, request: &InfoRequest) -> Result<Value> {
        let base_w = info_base_weight(request);
        self.rest_limiter.acquire(base_w).await;

        let mut attempt = 0u32;

        loop {
            let response = self.http_roundtrip_info(request).await?;

            if response.status.is_success() {
                // decode once to count items, then materialize T
                let val: Value = serde_json::from_slice(&response.body).map_err(Error::Serde)?;
                let extra = info_extra_weight(request, &val);
                if extra > 0 {
                    self.rest_limiter.debit_extra(extra).await;
                    log::debug!(
                        "Info debited extra weight: endpoint={request:?}, base_w={base_w}, extra={extra}"
                    );
                }
                return Ok(val);
            }

            // 429 → respect Retry-After; else jittered backoff. Retry Info only.
            if response.status.as_u16() == 429 {
                if attempt >= self.rate_limit_max_attempts_info {
                    let ra = self.parse_retry_after_simple(&response.headers);
                    return Err(Error::rate_limit("info", base_w, ra));
                }
                let delay = self
                    .parse_retry_after_simple(&response.headers)
                    .map_or_else(
                        || {
                            backoff_full_jitter(
                                attempt,
                                self.rate_limit_backoff_base,
                                self.rate_limit_backoff_cap,
                            )
                        },
                        Duration::from_millis,
                    );
                log::warn!(
                    "429 Too Many Requests; backing off: endpoint={request:?}, attempt={attempt}, wait_ms={:?}",
                    delay.as_millis()
                );
                attempt += 1;
                tokio::time::sleep(delay).await;
                // tiny re-acquire to avoid stampede exactly on minute boundary
                self.rest_limiter.acquire(1).await;
                continue;
            }

            // transient 5xx: treat like retryable Info (bounded)
            if (response.status.is_server_error() || response.status.as_u16() == 408)
                && attempt < self.rate_limit_max_attempts_info
            {
                let delay = backoff_full_jitter(
                    attempt,
                    self.rate_limit_backoff_base,
                    self.rate_limit_backoff_cap,
                );
                log::warn!(
                    "Transient error; retrying: endpoint={request:?}, attempt={attempt}, status={:?}, wait_ms={:?}",
                    response.status.as_u16(),
                    delay.as_millis()
                );
                attempt += 1;
                tokio::time::sleep(delay).await;
                continue;
            }

            // non-retryable or exhausted
            let error_body = String::from_utf8_lossy(&response.body);
            return Err(Error::http(
                response.status.as_u16(),
                error_body.to_string(),
            ));
        }
    }

    async fn http_roundtrip_info(&self, request: &InfoRequest) -> Result<HttpResponse> {
        let url = &self.base_info;
        let body = serde_json::to_value(request).map_err(Error::Serde)?;
        let body_bytes = serde_json::to_string(&body)
            .map_err(Error::Serde)?
            .into_bytes();

        self.client
            .request(
                Method::POST,
                url.clone(),
                None,
                None,
                Some(body_bytes),
                None,
                None,
            )
            .await
            .map_err(Error::from_http_client)
    }

    /// Send a signed action to the exchange.
    pub async fn post_action(
        &self,
        action: &ExchangeAction,
    ) -> Result<HyperliquidExchangeResponse> {
        let w = exchange_weight(action);
        self.rest_limiter.acquire(w).await;

        let signer = self
            .signer
            .as_ref()
            .ok_or_else(|| Error::auth("credentials required for exchange operations"))?;

        let nonce_manager = self
            .nonce_manager
            .as_ref()
            .ok_or_else(|| Error::auth("nonce manager missing"))?;

        let signer_id = self.signer_id();
        let time_nonce = nonce_manager.next(signer_id)?;

        let action_value = serde_json::to_value(action)
            .context("serialize exchange action")
            .map_err(|e| Error::bad_request(e.to_string()))?;

        // Serialize the original action struct with MessagePack for L1 signing
        let action_bytes = rmp_serde::to_vec_named(action)
            .context("serialize action with MessagePack")
            .map_err(|e| Error::bad_request(e.to_string()))?;

        let sign_request = SignRequest {
            action: action_value,
            action_bytes: Some(action_bytes),
            time_nonce,
            action_type: HyperliquidActionType::L1,
            is_testnet: self.is_testnet(),
            vault_address: self.vault_address.as_ref().map(|v| v.to_hex()),
        };

        let sig = signer.sign(&sign_request)?.signature;

        let nonce_u64 = time_nonce.as_millis() as u64;

        let request = if let Some(vault) = self.vault_address {
            HyperliquidExchangeRequest::with_vault(
                action.clone(),
                nonce_u64,
                sig,
                vault.to_string(),
            )
        } else {
            HyperliquidExchangeRequest::new(action.clone(), nonce_u64, sig)
        };

        let response = self.http_roundtrip_exchange(&request).await?;

        if response.status.is_success() {
            let parsed_response: HyperliquidExchangeResponse =
                serde_json::from_slice(&response.body).map_err(Error::Serde)?;

            // Check if the response contains an error status
            match &parsed_response {
                HyperliquidExchangeResponse::Status {
                    status,
                    response: response_data,
                } if status == "err" => {
                    let error_msg = response_data
                        .as_str()
                        .map_or_else(|| response_data.to_string(), |s| s.to_string());
                    log::error!("Hyperliquid API returned error: {error_msg}");
                    Err(Error::bad_request(format!("API error: {error_msg}")))
                }
                HyperliquidExchangeResponse::Error { error } => {
                    log::error!("Hyperliquid API returned error: {error}");
                    Err(Error::bad_request(format!("API error: {error}")))
                }
                _ => Ok(parsed_response),
            }
        } else if response.status.as_u16() == 429 {
            let ra = self.parse_retry_after_simple(&response.headers);
            Err(Error::rate_limit("exchange", w, ra))
        } else {
            let error_body = String::from_utf8_lossy(&response.body);
            log::error!(
                "Exchange API error (status {}): {}",
                response.status.as_u16(),
                error_body
            );
            Err(Error::http(
                response.status.as_u16(),
                error_body.to_string(),
            ))
        }
    }

    /// Send a signed action to the exchange using the typed HyperliquidExecAction enum.
    ///
    /// This is the preferred method for placing orders as it uses properly typed
    /// structures that match Hyperliquid's API expectations exactly.
    pub async fn post_action_exec(
        &self,
        action: &HyperliquidExecAction,
    ) -> Result<HyperliquidExchangeResponse> {
        let w = match action {
            HyperliquidExecAction::Order { orders, .. } => 1 + (orders.len() as u32 / 40),
            HyperliquidExecAction::Cancel { cancels } => 1 + (cancels.len() as u32 / 40),
            HyperliquidExecAction::CancelByCloid { cancels } => 1 + (cancels.len() as u32 / 40),
            HyperliquidExecAction::BatchModify { modifies } => 1 + (modifies.len() as u32 / 40),
            _ => 1,
        };
        self.rest_limiter.acquire(w).await;

        let signer = self
            .signer
            .as_ref()
            .ok_or_else(|| Error::auth("credentials required for exchange operations"))?;

        let nonce_manager = self
            .nonce_manager
            .as_ref()
            .ok_or_else(|| Error::auth("nonce manager missing"))?;

        let signer_id = self.signer_id();
        let time_nonce = nonce_manager.next(signer_id)?;
        // No need to validate - next() guarantees a valid, unused nonce

        let action_value = serde_json::to_value(action)
            .context("serialize exchange action")
            .map_err(|e| Error::bad_request(e.to_string()))?;

        // Serialize the original action struct with MessagePack for L1 signing
        let action_bytes = rmp_serde::to_vec_named(action)
            .context("serialize action with MessagePack")
            .map_err(|e| Error::bad_request(e.to_string()))?;

        let sig = signer
            .sign(&SignRequest {
                action: action_value,
                action_bytes: Some(action_bytes),
                time_nonce,
                action_type: HyperliquidActionType::L1,
                is_testnet: self.is_testnet(),
                vault_address: self.vault_address.as_ref().map(|v| v.to_hex()),
            })?
            .signature;

        let request = if let Some(vault) = self.vault_address {
            HyperliquidExchangeRequest::with_vault(
                action.clone(),
                time_nonce.as_millis() as u64,
                sig,
                vault.to_string(),
            )
        } else {
            HyperliquidExchangeRequest::new(action.clone(), time_nonce.as_millis() as u64, sig)
        };

        let response = self.http_roundtrip_exchange(&request).await?;

        if response.status.is_success() {
            let parsed_response: HyperliquidExchangeResponse =
                serde_json::from_slice(&response.body).map_err(Error::Serde)?;

            // Check if the response contains an error status
            match &parsed_response {
                HyperliquidExchangeResponse::Status {
                    status,
                    response: response_data,
                } if status == "err" => {
                    let error_msg = response_data
                        .as_str()
                        .map_or_else(|| response_data.to_string(), |s| s.to_string());
                    log::error!("Hyperliquid API returned error: {error_msg}");
                    Err(Error::bad_request(format!("API error: {error_msg}")))
                }
                HyperliquidExchangeResponse::Error { error } => {
                    log::error!("Hyperliquid API returned error: {error}");
                    Err(Error::bad_request(format!("API error: {error}")))
                }
                _ => Ok(parsed_response),
            }
        } else if response.status.as_u16() == 429 {
            let ra = self.parse_retry_after_simple(&response.headers);
            Err(Error::rate_limit("exchange", w, ra))
        } else {
            let error_body = String::from_utf8_lossy(&response.body);
            Err(Error::http(
                response.status.as_u16(),
                error_body.to_string(),
            ))
        }
    }

    /// Submit a single order to the Hyperliquid exchange.
    ///
    pub async fn rest_limiter_snapshot(&self) -> RateLimitSnapshot {
        self.rest_limiter.snapshot().await
    }
    async fn http_roundtrip_exchange<T>(
        &self,
        request: &HyperliquidExchangeRequest<T>,
    ) -> Result<HttpResponse>
    where
        T: serde::Serialize,
    {
        let url = &self.base_exchange;
        let body = serde_json::to_string(&request).map_err(Error::Serde)?;
        let body_bytes = body.into_bytes();

        let response = self
            .client
            .request(
                Method::POST,
                url.clone(),
                None,
                None,
                Some(body_bytes),
                None,
                None,
            )
            .await
            .map_err(Error::from_http_client)?;

        Ok(response)
    }
}

/// Provides a high-level HTTP client for the [Hyperliquid](https://hyperliquid.xyz/) REST API.
///
/// This domain client wraps [`HyperliquidRawHttpClient`] and provides methods that work
/// with Nautilus domain types. It maintains an instrument cache and handles conversions
/// between Hyperliquid API responses and Nautilus domain models.
#[derive(Debug, Clone)]
#[cfg_attr(
    feature = "python",
    pyo3::pyclass(
        module = "nautilus_trader.core.nautilus_pyo3.hyperliquid",
        from_py_object
    )
)]
#[cfg_attr(
    feature = "python",
    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.hyperliquid")
)]
pub struct HyperliquidHttpClient {
    pub(crate) inner: Arc<HyperliquidRawHttpClient>,
    clock: &'static AtomicTime,
    instruments: Arc<AtomicMap<Ustr, InstrumentAny>>,
    instruments_by_coin: Arc<AtomicMap<(Ustr, HyperliquidProductType), InstrumentAny>>,
    /// Mapping from symbol to asset index for order submission.
    asset_indices: Arc<AtomicMap<Ustr, u32>>,
    /// Mapping from spot fill coin (`@{pair_index}`) to instrument symbol.
    spot_fill_coins: Arc<AtomicMap<Ustr, Ustr>>,
    account_id: Option<AccountId>,
    /// Optional override address for queries (agent wallet / API sub-key support).
    /// When set, used for balance queries, position reports, and WS subscriptions
    /// instead of the address derived from the private key.
    account_address: Option<String>,
    normalize_prices: bool,
    market_order_slippage_bps: u32,
}

impl Default for HyperliquidHttpClient {
    fn default() -> Self {
        Self::new(HyperliquidEnvironment::Mainnet, 60, None)
            .expect("Failed to create default Hyperliquid HTTP client")
    }
}

impl HyperliquidHttpClient {
    /// Creates a new [`HyperliquidHttpClient`] for public endpoints only.
    ///
    /// # Errors
    ///
    /// Returns an error if the HTTP client cannot be created.
    pub fn new(
        environment: HyperliquidEnvironment,
        timeout_secs: u64,
        proxy_url: Option<String>,
    ) -> std::result::Result<Self, HttpClientError> {
        let raw_client = HyperliquidRawHttpClient::new(environment, timeout_secs, proxy_url)?;
        Ok(Self::from_raw(raw_client))
    }

    /// Creates a new [`HyperliquidHttpClient`] configured with a [`Secrets`] struct.
    ///
    /// # Errors
    ///
    /// Returns an error if the HTTP client cannot be created.
    pub fn with_secrets(
        secrets: &Secrets,
        timeout_secs: u64,
        proxy_url: Option<String>,
    ) -> std::result::Result<Self, HttpClientError> {
        let raw_client =
            HyperliquidRawHttpClient::with_credentials(secrets, timeout_secs, proxy_url)?;
        Ok(Self::from_raw(raw_client))
    }

    fn from_raw(raw_client: HyperliquidRawHttpClient) -> Self {
        Self {
            inner: Arc::new(raw_client),
            clock: get_atomic_clock_realtime(),
            instruments: Arc::new(AtomicMap::new()),
            instruments_by_coin: Arc::new(AtomicMap::new()),
            asset_indices: Arc::new(AtomicMap::new()),
            spot_fill_coins: Arc::new(AtomicMap::new()),
            account_id: None,
            account_address: None,
            normalize_prices: true,
            market_order_slippage_bps: crate::common::parse::DEFAULT_MARKET_SLIPPAGE_BPS,
        }
    }

    /// Overrides the base info URL (for testing with mock servers).
    ///
    /// # Panics
    ///
    /// Panics if the inner `Arc` has multiple references.
    pub fn set_base_info_url(&mut self, url: String) {
        Arc::get_mut(&mut self.inner)
            .expect("cannot override URL: Arc has multiple references")
            .set_base_info_url(url);
    }

    /// Overrides the base exchange URL (for testing with mock servers).
    ///
    /// # Panics
    ///
    /// Panics if the inner `Arc` has multiple references.
    pub fn set_base_exchange_url(&mut self, url: String) {
        Arc::get_mut(&mut self.inner)
            .expect("cannot override URL: Arc has multiple references")
            .set_base_exchange_url(url);
    }

    /// Creates an authenticated client from environment variables for the specified network.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if required environment variables are not set.
    pub fn from_env(environment: HyperliquidEnvironment) -> Result<Self> {
        let raw_client = HyperliquidRawHttpClient::from_env(environment)?;
        Ok(Self {
            inner: Arc::new(raw_client),
            clock: get_atomic_clock_realtime(),
            instruments: Arc::new(AtomicMap::new()),
            instruments_by_coin: Arc::new(AtomicMap::new()),
            asset_indices: Arc::new(AtomicMap::new()),
            spot_fill_coins: Arc::new(AtomicMap::new()),
            account_id: None,
            account_address: None,
            normalize_prices: true,
            market_order_slippage_bps: crate::common::parse::DEFAULT_MARKET_SLIPPAGE_BPS,
        })
    }

    /// Creates a new [`HyperliquidHttpClient`] configured with credentials.
    ///
    /// If credentials are not provided, falls back to environment variables:
    /// - Testnet: `HYPERLIQUID_TESTNET_PK`, `HYPERLIQUID_TESTNET_VAULT`
    /// - Mainnet: `HYPERLIQUID_PK`, `HYPERLIQUID_VAULT`
    ///
    /// If no credentials are provided and no environment variables are set,
    /// creates an unauthenticated client for public endpoints only.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if credentials are invalid.
    pub fn with_credentials(
        private_key: Option<String>,
        vault_address: Option<String>,
        account_address: Option<String>,
        environment: HyperliquidEnvironment,
        timeout_secs: u64,
        proxy_url: Option<String>,
    ) -> Result<Self> {
        let (pk_env_var, vault_env_var) =
            crate::common::credential::credential_env_vars(environment);

        // Resolve private key: explicit value -> env var -> None (unauthenticated)
        let resolved_pk = match private_key {
            Some(pk) => Some(pk),
            None => env::var(pk_env_var).ok(),
        };

        // Resolve vault address: explicit value -> env var -> None
        let resolved_vault = match vault_address {
            Some(vault) => Some(vault),
            None => env::var(vault_env_var).ok(),
        };

        // Resolve account address: explicit value -> env var -> None
        let resolved_account_address = match account_address {
            Some(addr) => Some(addr),
            None => env::var("HYPERLIQUID_ACCOUNT_ADDRESS").ok(),
        };

        match resolved_pk {
            Some(pk) => {
                let raw_client = HyperliquidRawHttpClient::from_credentials(
                    &pk,
                    resolved_vault.as_deref(),
                    environment,
                    timeout_secs,
                    proxy_url,
                )?;
                Ok(Self {
                    inner: Arc::new(raw_client),
                    clock: get_atomic_clock_realtime(),
                    instruments: Arc::new(AtomicMap::new()),
                    instruments_by_coin: Arc::new(AtomicMap::new()),
                    asset_indices: Arc::new(AtomicMap::new()),
                    spot_fill_coins: Arc::new(AtomicMap::new()),
                    account_id: None,
                    account_address: resolved_account_address,
                    normalize_prices: true,
                    market_order_slippage_bps: crate::common::parse::DEFAULT_MARKET_SLIPPAGE_BPS,
                })
            }
            None => {
                // No credentials available, create unauthenticated client
                Self::new(environment, timeout_secs, proxy_url)
                    .map_err(|e| Error::auth(format!("Failed to create HTTP client: {e}")))
            }
        }
    }

    /// Creates a new [`HyperliquidHttpClient`] configured with explicit credentials.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if the private key is invalid or cannot be parsed.
    pub fn from_credentials(
        private_key: &str,
        vault_address: Option<&str>,
        environment: HyperliquidEnvironment,
        timeout_secs: u64,
        proxy_url: Option<String>,
    ) -> Result<Self> {
        let raw_client = HyperliquidRawHttpClient::from_credentials(
            private_key,
            vault_address,
            environment,
            timeout_secs,
            proxy_url,
        )?;
        Ok(Self {
            inner: Arc::new(raw_client),
            clock: get_atomic_clock_realtime(),
            instruments: Arc::new(AtomicMap::new()),
            instruments_by_coin: Arc::new(AtomicMap::new()),
            asset_indices: Arc::new(AtomicMap::new()),
            spot_fill_coins: Arc::new(AtomicMap::new()),
            account_id: None,
            account_address: None,
            normalize_prices: true,
            market_order_slippage_bps: crate::common::parse::DEFAULT_MARKET_SLIPPAGE_BPS,
        })
    }

    /// Returns whether this client is configured for testnet.
    #[must_use]
    pub fn is_testnet(&self) -> bool {
        self.inner.is_testnet()
    }

    /// Returns whether order price normalization is enabled.
    #[must_use]
    pub fn normalize_prices(&self) -> bool {
        self.normalize_prices
    }

    /// Sets whether to normalize order prices to 5 significant figures.
    pub fn set_normalize_prices(&mut self, value: bool) {
        self.normalize_prices = value;
    }

    /// Returns the MARKET-order slippage buffer in basis points.
    #[must_use]
    pub fn market_order_slippage_bps(&self) -> u32 {
        self.market_order_slippage_bps
    }

    /// Sets the MARKET-order slippage buffer in basis points.
    pub fn set_market_order_slippage_bps(&mut self, value: u32) {
        self.market_order_slippage_bps = value;
    }

    /// Gets the user address derived from the private key (if client has credentials).
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if the client has no signer configured.
    pub fn get_user_address(&self) -> Result<String> {
        self.inner.get_user_address()
    }

    /// Returns `true` if a vault address is configured.
    #[must_use]
    pub fn has_vault_address(&self) -> bool {
        self.inner.has_vault_address()
    }

    /// Returns the builder-attribution fee to attach to outgoing orders, or
    /// `None` when attribution must be omitted (vault orders and testnet).
    #[must_use]
    pub fn builder_attribution(&self) -> Option<HyperliquidExecBuilderFee> {
        if self.has_vault_address() || self.is_testnet() {
            None
        } else {
            Some(HyperliquidExecBuilderFee {
                address: NAUTILUS_BUILDER_ADDRESS.to_string(),
                fee_tenths_bp: 0,
            })
        }
    }

    /// Gets the account address for queries: account_address if configured
    /// (agent wallet), then vault address, otherwise the user (EOA) address.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Auth`] if the client has no signer configured and
    /// no account_address override is set.
    pub fn get_account_address(&self) -> Result<String> {
        if let Some(addr) = &self.account_address {
            return Ok(addr.clone());
        }
        self.inner.get_account_address()
    }

    /// Sets the account address override for queries (agent wallet support).
    pub fn set_account_address(&mut self, address: Option<String>) {
        self.account_address = address;
    }

    /// Caches a single instrument.
    ///
    /// This is required for parsing orders, fills, and positions into reports.
    /// Any existing instrument with the same symbol will be replaced.
    pub fn cache_instrument(&self, instrument: &InstrumentAny) {
        let full_symbol = instrument.symbol().inner();
        let coin = instrument.raw_symbol().inner();

        self.instruments.rcu(|m| {
            m.insert(full_symbol, instrument.clone());
            // HTTP responses only include coins, external code may lookup by coin
            m.insert(coin, instrument.clone());
        });

        // Composite key allows disambiguating same coin across PERP and SPOT
        if let Ok(product_type) = HyperliquidProductType::from_symbol(full_symbol.as_str()) {
            self.instruments_by_coin.rcu(|m| {
                m.insert((coin, product_type), instrument.clone());

                // Index the leading symbol component (the part before the first
                // `-`) as a secondary key for two distinct callers:
                //
                // * Spot raw_symbols are either `@{pair_index}` or slash format
                //   (e.g., "PURR/USDC"); spot balance/position reconciliation
                //   maps the venue token name (e.g., "PURR") to instruments via
                //   this alias.
                // * Order submission paths split `instrument_id.symbol` on `-`
                //   to derive a coin key. For HIP-3 perps with wildcard-bearing
                //   venue names, the sanitized base in `instrument_id.symbol`
                //   (e.g., "dex:STREAMABCDxxxx") differs from `raw_symbol` /
                //   `coin` (e.g., "dex:STREAMABCD****"), so an alias on the
                //   sanitized base lets that lookup resolve.
                //
                // First-write-wins guards against non-canonical spot pairs that
                // share a base token overwriting the canonical instrument; the
                // spot loader sorts canonical pairs first so the alias resolves
                // to the canonical one. For standard perps `base == coin`, so
                // the alias is a no-op.
                if let Some(base) = full_symbol.as_str().split('-').next() {
                    let base_ustr = Ustr::from(base);
                    let key = (base_ustr, product_type);
                    if base_ustr != coin && !m.contains_key(&key) {
                        m.insert(key, instrument.clone());
                    }
                }
            });
        } else {
            log::warn!("Unable to determine product type for symbol: {full_symbol}");
        }
    }

    fn get_or_create_instrument(
        &self,
        coin: &Ustr,
        product_type: Option<HyperliquidProductType>,
    ) -> Option<InstrumentAny> {
        if let Some(pt) = product_type
            && let Some(instrument) = self.instruments_by_coin.load().get(&(*coin, pt))
        {
            return Some(instrument.clone());
        }

        // HTTP responses lack product type context. HIP-4 outcome coins
        // (`#E`/`+E`) are checked first because they never collide with
        // perp or spot symbols, then perp, then spot.
        if product_type.is_none() {
            let guard = self.instruments_by_coin.load();

            if let Some(instrument) = guard.get(&(*coin, HyperliquidProductType::Outcome)) {
                return Some(instrument.clone());
            }

            if let Some(instrument) = guard.get(&(*coin, HyperliquidProductType::Perp)) {
                return Some(instrument.clone());
            }

            if let Some(instrument) = guard.get(&(*coin, HyperliquidProductType::Spot)) {
                return Some(instrument.clone());
            }
        }

        // Spot fills use @{pair_index} format, translate to full symbol and look up
        if coin.as_str().starts_with('@')
            && let Some(symbol) = self.spot_fill_coins.load().get(coin)
        {
            // Look up by full symbol in instruments map (not instruments_by_coin
            // which uses raw_symbol)
            if let Some(instrument) = self.instruments.load().get(symbol) {
                return Some(instrument.clone());
            }
        }

        // Vault tokens aren't in standard API, create synthetic instruments
        if coin.as_str().starts_with("vntls:") {
            log::info!("Creating synthetic instrument for vault token: {coin}");

            let ts_event = self.clock.get_time_ns();

            // Create synthetic vault token instrument
            let symbol_str = format!("{coin}-USDC-SPOT");
            let symbol = Symbol::new(&symbol_str);
            let venue = *HYPERLIQUID_VENUE;
            let instrument_id = InstrumentId::new(symbol, venue);

            // Create currencies
            let base_currency = Currency::new(
                coin.as_str(),
                8, // precision
                0, // ISO code (not applicable)
                coin.as_str(),
                CurrencyType::Crypto,
            );

            let quote_currency = Currency::new(
                "USDC",
                6, // USDC standard precision
                0,
                "USDC",
                CurrencyType::Crypto,
            );

            let price_increment = Price::from("0.00000001");
            let size_increment = Quantity::from("0.00000001");

            let instrument = InstrumentAny::CurrencyPair(CurrencyPair::new(
                instrument_id,
                symbol,
                base_currency,
                quote_currency,
                8, // price_precision
                8, // size_precision
                price_increment,
                size_increment,
                None, // multiplier
                None, // lot_size
                None, // max_quantity
                None, // min_quantity
                None, // max_notional
                None, // min_notional
                None, // max_price
                None, // min_price
                None, // margin_init
                None, // margin_maint
                None, // maker_fee
                None, // taker_fee
                None, // info
                ts_event,
                ts_event,
            ));

            self.cache_instrument(&instrument);

            Some(instrument)
        } else {
            // For non-vault tokens, log warning and return None
            log::warn!("Instrument not found in cache: {coin}");
            None
        }
    }

    /// Set the account ID for this client.
    ///
    /// This is required for generating reports with the correct account ID.
    pub fn set_account_id(&mut self, account_id: AccountId) {
        self.account_id = Some(account_id);
    }

    /// Fetch and parse all instrument definitions, populating the asset indices cache.
    pub async fn request_instrument_defs(&self) -> Result<Vec<HyperliquidInstrumentDef>> {
        let mut defs: Vec<HyperliquidInstrumentDef> = Vec::new();

        // Load all perp dexes: index 0 = standard, index 1+ = HIP-3
        match self.inner.load_all_perp_metas().await {
            Ok(all_metas) => {
                for (dex_index, meta) in all_metas.iter().enumerate() {
                    let base = perp_dex_asset_index_base(dex_index);

                    match parse_perp_instruments(meta, base) {
                        Ok(perp_defs) => {
                            log::debug!(
                                "Loaded Hyperliquid perp defs: dex_index={dex_index}, count={}",
                                perp_defs.len(),
                            );
                            defs.extend(perp_defs);
                        }
                        Err(e) => {
                            log::warn!("Failed to parse perp instruments for dex {dex_index}: {e}");
                        }
                    }
                }
            }
            Err(e) => {
                log::warn!("Failed to load allPerpMetas, falling back to meta: {e}");

                match self.inner.load_perp_meta().await {
                    Ok(perp_meta) => match parse_perp_instruments(&perp_meta, 0) {
                        Ok(perp_defs) => {
                            log::debug!(
                                "Loaded Hyperliquid perp defs via fallback: count={}",
                                perp_defs.len(),
                            );
                            defs.extend(perp_defs);
                        }
                        Err(e) => {
                            log::warn!("Failed to parse perp instruments: {e}");
                        }
                    },
                    Err(e) => {
                        log::warn!("Failed to load Hyperliquid perp metadata: {e}");
                    }
                }
            }
        }

        match self.inner.get_spot_meta().await {
            Ok(spot_meta) => match parse_spot_instruments(&spot_meta) {
                Ok(spot_defs) => {
                    log::debug!(
                        "Loaded Hyperliquid spot definitions: count={}",
                        spot_defs.len(),
                    );
                    defs.extend(spot_defs);
                }
                Err(e) => {
                    log::warn!("Failed to parse Hyperliquid spot instruments: {e}");
                }
            },
            Err(e) => {
                log::warn!("Failed to load Hyperliquid spot metadata: {e}");
            }
        }

        // HIP-4 outcome metadata is best-effort: the venue may not expose it
        // and the response shape is still firming up. Treat any error as a
        // soft skip so missing outcomes do not break perp/spot loading.
        match self.inner.get_outcome_meta().await {
            Ok(outcome_meta) => match parse_outcome_instruments(&outcome_meta) {
                Ok(outcome_defs) => {
                    log::debug!(
                        "Loaded Hyperliquid outcome definitions: count={}",
                        outcome_defs.len(),
                    );
                    defs.extend(outcome_defs);
                }
                Err(e) => {
                    log::warn!("Failed to parse Hyperliquid outcome instruments: {e}");
                }
            },
            Err(e) => {
                log::debug!("Skipping Hyperliquid outcome metadata: {e}");
            }
        }

        // Drop defs whose Nautilus-internal symbol collides with one already
        // accepted. This guards the HIP-3 case where two distinct venue names
        // (e.g. `dex:FOO*` and `dex:FOO?`) sanitize onto the same internal
        // symbol; without this filter the second def would silently overwrite
        // the first in `asset_indices`, which would route orders to the wrong
        // asset. First-write-wins matches the spot canonical-pair ordering.
        let mut seen_symbols = ahash::AHashSet::with_capacity(defs.len());
        let mut deduped: Vec<HyperliquidInstrumentDef> = Vec::with_capacity(defs.len());
        for def in defs {
            if seen_symbols.insert(def.symbol) {
                deduped.push(def);
            } else {
                log::warn!(
                    "Dropping Hyperliquid instrument: sanitized symbol '{}' collides with an earlier def (raw_symbol='{}')",
                    def.symbol,
                    def.raw_symbol,
                );
            }
        }
        let defs = deduped;

        // Populate asset indices for all instruments (including filtered HIP-3)
        self.asset_indices.rcu(|m| {
            for def in &defs {
                m.insert(def.symbol, def.asset_index);
            }
        });
        log::debug!(
            "Populated asset indices map (count={})",
            self.asset_indices.len()
        );

        Ok(defs)
    }

    /// Converts instrument definitions into Nautilus instruments.
    pub fn convert_defs(&self, defs: Vec<HyperliquidInstrumentDef>) -> Vec<InstrumentAny> {
        let ts_init = self.clock.get_time_ns();
        instruments_from_defs_owned(defs, ts_init)
    }

    /// Fetch and parse all available instrument definitions from Hyperliquid.
    pub async fn request_instruments(&self) -> Result<Vec<InstrumentAny>> {
        let defs = self.request_instrument_defs().await?;
        Ok(self.convert_defs(defs))
    }

    /// Get asset index for a symbol from the cached map.
    ///
    /// For perps: index in meta.universe (0, 1, 2, ...).
    /// For spot: 10_000 + index in spotMeta.universe.
    /// For HIP-3: 100_000 + dex_index * 10_000 + index in dex meta.universe.
    ///
    /// Returns `None` if the symbol is not found in the map.
    pub fn get_asset_index(&self, symbol: &str) -> Option<u32> {
        self.asset_indices.load().get(&Ustr::from(symbol)).copied()
    }

    /// Get the price precision for a cached instrument by symbol.
    pub fn get_price_precision(&self, symbol: &str) -> Option<u8> {
        self.instruments
            .load()
            .get(&Ustr::from(symbol))
            .map(|inst| inst.price_precision())
    }

    /// Get mapping from spot fill coin identifiers to instrument symbols.
    ///
    /// Hyperliquid WebSocket fills for spot use `@{pair_index}` format (e.g., `@107`),
    /// while instruments are identified by full symbols (e.g., `HYPE-USDC-SPOT`).
    /// This mapping allows looking up the instrument from a spot fill.
    ///
    /// This method also caches the mapping internally for use by fill parsing methods.
    #[must_use]
    pub fn get_spot_fill_coin_mapping(&self) -> AHashMap<Ustr, Ustr> {
        const SPOT_INDEX_OFFSET: u32 = 10_000;
        const BUILDER_PERP_OFFSET: u32 = 100_000;

        let guard = self.asset_indices.load();

        let mut mapping = AHashMap::new();

        for (symbol, &asset_index) in guard.iter() {
            // Spot instruments: asset_index in [10_000, 100_000)
            if (SPOT_INDEX_OFFSET..BUILDER_PERP_OFFSET).contains(&asset_index) {
                let pair_index = asset_index - SPOT_INDEX_OFFSET;
                let fill_coin = Ustr::from(&format!("@{pair_index}"));
                mapping.insert(fill_coin, *symbol);
            }
        }

        // Cache the mapping internally for fill parsing
        self.spot_fill_coins.store(mapping.clone());

        mapping
    }

    /// Get perpetuals metadata (internal helper).
    #[allow(dead_code)]
    pub(crate) async fn load_perp_meta(&self) -> Result<PerpMeta> {
        self.inner.load_perp_meta().await
    }

    /// Get metadata for all perp dexes (standard + HIP-3).
    #[allow(dead_code)]
    pub(crate) async fn load_all_perp_metas(&self) -> Result<Vec<PerpMeta>> {
        self.inner.load_all_perp_metas().await
    }

    /// Get spot metadata (internal helper).
    #[allow(dead_code)]
    pub(crate) async fn get_spot_meta(&self) -> Result<SpotMeta> {
        self.inner.get_spot_meta().await
    }

    /// Get outcome metadata (internal helper).
    pub(crate) async fn get_outcome_meta(&self) -> Result<OutcomeMeta> {
        self.inner.get_outcome_meta().await
    }

    /// Get L2 order book for a coin.
    pub async fn info_l2_book(&self, coin: &str) -> Result<HyperliquidL2Book> {
        self.inner.info_l2_book(coin).await
    }

    /// Get user fills (trading history).
    pub async fn info_user_fills(&self, user: &str) -> Result<HyperliquidFills> {
        self.inner.info_user_fills(user).await
    }

    /// Get order status for a user.
    pub async fn info_order_status(&self, user: &str, oid: u64) -> Result<HyperliquidOrderStatus> {
        self.inner.info_order_status(user, oid).await
    }

    /// Get all open orders for a user.
    pub async fn info_open_orders(&self, user: &str) -> Result<Value> {
        self.inner.info_open_orders(user).await
    }

    /// Get frontend open orders (includes more detail) for a user.
    pub async fn info_frontend_open_orders(&self, user: &str) -> Result<Value> {
        self.inner.info_frontend_open_orders(user).await
    }

    /// Get clearinghouse state (balances, positions, margin) for a user.
    pub async fn info_clearinghouse_state(&self, user: &str) -> Result<Value> {
        self.inner.info_clearinghouse_state(user).await
    }

    /// Get spot clearinghouse state (per-token spot balances) for a user.
    pub async fn info_spot_clearinghouse_state(&self, user: &str) -> Result<Value> {
        self.inner.info_spot_clearinghouse_state(user).await
    }

    /// Get user fee schedule and effective rates.
    pub async fn info_user_fees(&self, user: &str) -> Result<Value> {
        self.inner.info_user_fees(user).await
    }

    /// Get candle/bar data for a coin.
    pub async fn info_candle_snapshot(
        &self,
        coin: &str,
        interval: HyperliquidBarInterval,
        start_time: u64,
        end_time: u64,
    ) -> Result<HyperliquidCandleSnapshot> {
        self.inner
            .info_candle_snapshot(coin, interval, start_time, end_time)
            .await
    }

    /// Get historical funding rates for a coin.
    pub async fn info_funding_history(
        &self,
        coin: &str,
        start_time: u64,
        end_time: Option<u64>,
    ) -> Result<Vec<HyperliquidFundingHistoryEntry>> {
        self.inner
            .info_funding_history(coin, start_time, end_time)
            .await
    }

    /// Post an action to the exchange endpoint (low-level delegation).
    pub async fn post_action(
        &self,
        action: &ExchangeAction,
    ) -> Result<HyperliquidExchangeResponse> {
        self.inner.post_action(action).await
    }

    /// Post an execution action (low-level delegation).
    pub async fn post_action_exec(
        &self,
        action: &HyperliquidExecAction,
    ) -> Result<HyperliquidExchangeResponse> {
        self.inner.post_action_exec(action).await
    }

    /// Get metadata about available markets (low-level delegation).
    pub async fn info_meta(&self) -> Result<HyperliquidMeta> {
        self.inner.info_meta().await
    }

    /// Cancel an order on the Hyperliquid exchange.
    ///
    /// Can cancel either by venue order ID or client order ID.
    /// At least one ID must be provided.
    ///
    /// # Errors
    ///
    /// Returns an error if credentials are missing, no order ID is provided,
    /// or the API returns an error.
    pub async fn cancel_order(
        &self,
        instrument_id: InstrumentId,
        client_order_id: Option<ClientOrderId>,
        venue_order_id: Option<VenueOrderId>,
    ) -> Result<()> {
        // Get asset ID from cached indices map
        let symbol = instrument_id.symbol.as_str();
        let asset_id = self.get_asset_index(symbol).ok_or_else(|| {
            Error::bad_request(format!(
                "Asset index not found for symbol: {symbol}. Ensure instruments are loaded."
            ))
        })?;

        // Create cancel action based on which ID we have
        let action = if let Some(cloid) = client_order_id {
            // Hash the client order ID to CLOID (same as order submission)
            let cloid_hash = Cloid::from_client_order_id(cloid);
            let cancel_req = HyperliquidExecCancelByCloidRequest {
                asset: asset_id,
                cloid: cloid_hash,
            };
            HyperliquidExecAction::CancelByCloid {
                cancels: vec![cancel_req],
            }
        } else if let Some(oid) = venue_order_id {
            let oid_u64 = oid
                .as_str()
                .parse::<u64>()
                .map_err(|_| Error::bad_request("Invalid venue order ID format"))?;
            let cancel_req = HyperliquidExecCancelOrderRequest {
                asset: asset_id,
                oid: oid_u64,
            };
            HyperliquidExecAction::Cancel {
                cancels: vec![cancel_req],
            }
        } else {
            return Err(Error::bad_request(
                "Either client_order_id or venue_order_id must be provided",
            ));
        };

        // Submit cancellation
        let response = self.inner.post_action_exec(&action).await?;

        // Check response - only check for error status
        match response {
            ref r @ HyperliquidExchangeResponse::Status { .. } if r.is_ok() => Ok(()),
            HyperliquidExchangeResponse::Status {
                status,
                response: error_data,
            } => Err(Error::bad_request(format!(
                "Cancel order failed: status={status}, error={error_data}"
            ))),
            HyperliquidExchangeResponse::Error { error } => {
                Err(Error::bad_request(format!("Cancel order error: {error}")))
            }
        }
    }

    /// Modify an order on the Hyperliquid exchange.
    ///
    /// The HL modify API requires a full replacement order spec plus the
    /// venue order ID. The caller must provide all order fields.
    ///
    /// # Errors
    ///
    /// Returns an error if the asset index is not found, the venue order ID
    /// is invalid, or the API returns an error.
    #[expect(clippy::too_many_arguments)]
    pub async fn modify_order(
        &self,
        instrument_id: InstrumentId,
        venue_order_id: VenueOrderId,
        order_side: OrderSide,
        order_type: OrderType,
        price: Price,
        quantity: Quantity,
        trigger_price: Option<Price>,
        reduce_only: bool,
        post_only: bool,
        time_in_force: TimeInForce,
        client_order_id: Option<ClientOrderId>,
    ) -> Result<()> {
        let symbol = instrument_id.symbol.as_str();
        let asset_id = self.get_asset_index(symbol).ok_or_else(|| {
            Error::bad_request(format!(
                "Asset index not found for symbol: {symbol}. Ensure instruments are loaded."
            ))
        })?;

        let oid: u64 = venue_order_id
            .as_str()
            .parse()
            .map_err(|_| Error::bad_request("Invalid venue order ID format"))?;

        let is_buy = matches!(order_side, OrderSide::Buy);
        let decimals = self.get_price_precision(symbol).unwrap_or(2);

        let normalized_price = if self.normalize_prices {
            normalize_price(price.as_decimal(), decimals).normalize()
        } else {
            price.as_decimal().normalize()
        };

        let size = quantity.as_decimal().normalize();
        let cloid = client_order_id.map(Cloid::from_client_order_id);

        let kind = match order_type {
            OrderType::Market => HyperliquidExecOrderKind::Limit {
                limit: HyperliquidExecLimitParams {
                    tif: HyperliquidExecTif::Ioc,
                },
            },
            OrderType::Limit => {
                let tif = time_in_force_to_hyperliquid_tif(time_in_force, post_only)
                    .map_err(|e| Error::bad_request(format!("{e}")))?;
                HyperliquidExecOrderKind::Limit {
                    limit: HyperliquidExecLimitParams { tif },
                }
            }
            OrderType::StopMarket
            | OrderType::StopLimit
            | OrderType::MarketIfTouched
            | OrderType::LimitIfTouched => {
                if let Some(trig_px) = trigger_price {
                    let trigger_price_decimal = if self.normalize_prices {
                        normalize_price(trig_px.as_decimal(), decimals).normalize()
                    } else {
                        trig_px.as_decimal().normalize()
                    };
                    let tpsl = match order_type {
                        OrderType::StopMarket | OrderType::StopLimit => HyperliquidExecTpSl::Sl,
                        _ => HyperliquidExecTpSl::Tp,
                    };
                    let is_market = matches!(
                        order_type,
                        OrderType::StopMarket | OrderType::MarketIfTouched
                    );
                    HyperliquidExecOrderKind::Trigger {
                        trigger: HyperliquidExecTriggerParams {
                            is_market,
                            trigger_px: trigger_price_decimal,
                            tpsl,
                        },
                    }
                } else {
                    return Err(Error::bad_request("Trigger orders require a trigger price"));
                }
            }
            _ => {
                return Err(Error::bad_request(format!(
                    "Order type {order_type:?} not supported for modify"
                )));
            }
        };

        let order = HyperliquidExecPlaceOrderRequest {
            asset: asset_id,
            is_buy,
            price: normalized_price,
            size,
            reduce_only,
            kind,
            cloid,
        };

        let action = HyperliquidExecAction::Modify {
            modify: HyperliquidExecModifyOrderRequest { oid, order },
        };

        let response = self.inner.post_action_exec(&action).await?;

        match response {
            ref r @ HyperliquidExchangeResponse::Status { .. } if r.is_ok() => {
                if let Some(inner_error) = extract_inner_error(&response) {
                    Err(Error::bad_request(format!(
                        "Modify order rejected: {inner_error}",
                    )))
                } else {
                    Ok(())
                }
            }
            HyperliquidExchangeResponse::Status {
                status,
                response: error_data,
            } => Err(Error::bad_request(format!(
                "Modify order failed: status={status}, error={error_data}"
            ))),
            HyperliquidExchangeResponse::Error { error } => {
                Err(Error::bad_request(format!("Modify order error: {error}")))
            }
        }
    }

    /// Split an HIP-4 outcome's quote tokens into matched Yes and No side tokens.
    ///
    /// Submits a `userOutcome` exchange action with the `splitOutcome` operation:
    /// debits `amount` quote tokens (USDH) and credits `amount` Yes plus `amount`
    /// No side tokens for the given `outcome` index. Ordinary directional
    /// buys and sells on outcome instruments go through the standard order path
    /// without calling this; the action is for dual-side market making and
    /// inventory creation.
    ///
    /// # Errors
    ///
    /// Returns an error if credentials are missing, the venue rejects the
    /// action, or the response cannot be parsed.
    pub async fn submit_split_outcome(
        &self,
        outcome: u32,
        amount: Decimal,
    ) -> Result<HyperliquidExchangeResponse> {
        let action = HyperliquidExecAction::UserOutcome {
            op: HyperliquidExecUserOutcomeOp::SplitOutcome(HyperliquidExecSplitOutcomeParams {
                outcome,
                amount,
            }),
        };
        self.inner.post_action_exec(&action).await
    }

    /// Merge matched Yes + No side-token pairs of an HIP-4 outcome back into quote tokens.
    ///
    /// Submits a `userOutcome` action with the `mergeOutcome` operation. Pass
    /// `amount = None` to merge the maximum mergeable balance (venue-side
    /// `null`).
    ///
    /// # Errors
    ///
    /// Returns an error if credentials are missing, the venue rejects the
    /// action, or the response cannot be parsed.
    pub async fn submit_merge_outcome(
        &self,
        outcome: u32,
        amount: Option<Decimal>,
    ) -> Result<HyperliquidExchangeResponse> {
        let action = HyperliquidExecAction::UserOutcome {
            op: HyperliquidExecUserOutcomeOp::MergeOutcome(HyperliquidExecMergeOutcomeParams {
                outcome,
                amount,
            }),
        };
        self.inner.post_action_exec(&action).await
    }

    /// Merge `Yes` shares of every outcome in a multi-outcome question into quote tokens.
    ///
    /// Submits a `userOutcome` action with the `mergeQuestion` operation. Pass
    /// `amount = None` to merge the maximum balance.
    ///
    /// # Errors
    ///
    /// Returns an error if credentials are missing, the venue rejects the
    /// action, or the response cannot be parsed.
    pub async fn submit_merge_question(
        &self,
        question: u32,
        amount: Option<Decimal>,
    ) -> Result<HyperliquidExchangeResponse> {
        let action = HyperliquidExecAction::UserOutcome {
            op: HyperliquidExecUserOutcomeOp::MergeQuestion(HyperliquidExecMergeQuestionParams {
                question,
                amount,
            }),
        };
        self.inner.post_action_exec(&action).await
    }

    /// Swap `No` shares of one outcome into `Yes` shares of every other outcome.
    ///
    /// Submits a `userOutcome` action with the `negateOutcome` operation. Both
    /// outcomes must belong to the same multi-outcome `question`.
    ///
    /// # Errors
    ///
    /// Returns an error if credentials are missing, the venue rejects the
    /// action, or the response cannot be parsed.
    pub async fn submit_negate_outcome(
        &self,
        question: u32,
        outcome: u32,
        amount: Decimal,
    ) -> Result<HyperliquidExchangeResponse> {
        let action = HyperliquidExecAction::UserOutcome {
            op: HyperliquidExecUserOutcomeOp::NegateOutcome(HyperliquidExecNegateOutcomeParams {
                question,
                outcome,
                amount,
            }),
        };
        self.inner.post_action_exec(&action).await
    }

    /// Request order status reports for a user.
    ///
    /// Fetches open orders via `info_frontend_open_orders` and parses them into OrderStatusReports.
    /// This method requires instruments to be added to the client cache via `cache_instrument()`.
    ///
    /// For vault tokens (starting with "vntls:") that are not in the cache, synthetic instruments
    /// will be created automatically.
    ///
    /// # Errors
    ///
    /// Returns an error if the API request fails or parsing fails.
    pub async fn request_order_status_reports(
        &self,
        user: &str,
        instrument_id: Option<InstrumentId>,
    ) -> Result<Vec<OrderStatusReport>> {
        let account_id = self
            .account_id
            .ok_or_else(|| Error::bad_request("Account ID not set"))?;
        let response = self.info_frontend_open_orders(user).await?;

        // Parse the JSON response into a vector of orders
        let orders: Vec<serde_json::Value> = serde_json::from_value(response)
            .map_err(|e| Error::bad_request(format!("Failed to parse orders: {e}")))?;

        let mut reports = Vec::new();
        let ts_init = self.clock.get_time_ns();

        for order_value in orders {
            // Parse the order data
            let order: WsBasicOrderData = match serde_json::from_value(order_value.clone()) {
                Ok(o) => o,
                Err(e) => {
                    log::warn!("Failed to parse order: {e}");
                    continue;
                }
            };

            // Get instrument from cache or create synthetic for vault tokens
            let instrument = match self.get_or_create_instrument(&order.coin, None) {
                Some(inst) => inst,
                None => continue, // Skip if instrument not found
            };

            // Filter by instrument_id if specified
            if let Some(filter_id) = instrument_id
                && instrument.id() != filter_id
            {
                continue;
            }

            // Determine status from order data - orders from frontend_open_orders are open
            let status = HyperliquidOrderStatusEnum::Open;

            // Parse to OrderStatusReport
            match parse_order_status_report_from_basic(
                &order,
                &status,
                &instrument,
                account_id,
                ts_init,
            ) {
                Ok(report) => reports.push(report),
                Err(e) => log::error!("Failed to parse order status report: {e}"),
            }
        }

        Ok(reports)
    }

    /// Request a single order status report by venue order ID.
    ///
    /// Queries `info_frontend_open_orders` and filters for the given oid so the
    /// result includes trigger metadata (trigger_px, tpsl, trailing_stop, etc.).
    /// Falls back to `info_order_status` when the order is no longer open.
    ///
    /// # Errors
    ///
    /// Returns an error if the API request fails or parsing fails.
    pub async fn request_order_status_report(
        &self,
        user: &str,
        oid: u64,
    ) -> Result<Option<OrderStatusReport>> {
        let account_id = self
            .account_id
            .ok_or_else(|| Error::bad_request("Account ID not set"))?;

        let ts_init = self.clock.get_time_ns();

        // Try open orders first (returns full WsBasicOrderData with trigger fields).
        // A transport error here must not abort the call: the oid fallback to
        // info_order_status below still covers closed orders, so a transient
        // frontendOpenOrders outage is downgraded to a warning.
        let orders: Vec<WsBasicOrderData> = match self.info_frontend_open_orders(user).await {
            Ok(response) => match serde_json::from_value(response) {
                Ok(v) => v,
                Err(e) => {
                    log::warn!("Failed to parse frontend open orders response: {e}");
                    Vec::new()
                }
            },
            Err(e) => {
                log::warn!(
                    "Failed to fetch frontendOpenOrders for oid {oid}: {e}; falling back to orderStatus"
                );
                Vec::new()
            }
        };

        if let Some(order) = orders.into_iter().find(|o| o.oid == oid) {
            let instrument = match self.get_or_create_instrument(&order.coin, None) {
                Some(inst) => inst,
                None => return Ok(None),
            };

            let status = if order.trigger_activated == Some(true) {
                HyperliquidOrderStatusEnum::Triggered
            } else {
                HyperliquidOrderStatusEnum::Open
            };

            return match parse_order_status_report_from_basic(
                &order,
                &status,
                &instrument,
                account_id,
                ts_init,
            ) {
                Ok(report) => Ok(Some(report)),
                Err(e) => {
                    log::error!("Failed to parse order status report for oid {oid}: {e}");
                    Ok(None)
                }
            };
        }

        // Order not in open set: query by oid (returns limited HyperliquidOrderInfo)
        let response = self.info_order_status(user, oid).await?;
        let entry = match response.into_order() {
            Some(e) => e,
            None => return Ok(None),
        };

        let instrument = match self.get_or_create_instrument(&entry.order.coin, None) {
            Some(inst) => inst,
            None => return Ok(None),
        };

        // The info_order_status endpoint returns limited HyperliquidOrderInfo
        // without trigger fields (trigger_px, tpsl, is_market, trailing_stop).
        // Closed trigger orders will report as Limit type. This is an exchange
        // API limitation: trigger metadata is only available on open orders.
        let basic = WsBasicOrderData {
            coin: entry.order.coin,
            side: entry.order.side,
            limit_px: entry.order.limit_px,
            sz: entry.order.sz,
            oid: entry.order.oid,
            timestamp: entry.order.timestamp,
            orig_sz: entry.order.orig_sz,
            cloid: entry.order.cloid,
            trigger_px: None,
            is_market: None,
            tpsl: None,
            trigger_activated: None,
            trailing_stop: None,
        };

        match parse_order_status_report_from_basic(
            &basic,
            &entry.status,
            &instrument,
            account_id,
            ts_init,
        ) {
            Ok(mut report) => {
                // Use status_timestamp for ts_last when available (more accurate
                // than the order creation timestamp for filled/canceled orders)
                if entry.status_timestamp > 0 {
                    report.ts_last = UnixNanos::from(entry.status_timestamp * 1_000_000);
                }
                Ok(Some(report))
            }
            Err(e) => {
                log::error!("Failed to parse order status report for oid {oid}: {e}");
                Ok(None)
            }
        }
    }

    /// Request a single order status report by client order ID.
    ///
    /// Searches `info_frontend_open_orders` for an order whose cloid matches the
    /// keccak256 hash of the given client order ID. Only finds open orders.
    ///
    /// # Errors
    ///
    /// Returns an error if the API request fails or parsing fails.
    pub async fn request_order_status_report_by_client_order_id(
        &self,
        user: &str,
        client_order_id: &ClientOrderId,
    ) -> Result<Option<OrderStatusReport>> {
        let account_id = self
            .account_id
            .ok_or_else(|| Error::bad_request("Account ID not set"))?;

        let ts_init = self.clock.get_time_ns();

        let cloid_hex = Cloid::from_client_order_id(*client_order_id).to_hex();

        let response = self.info_frontend_open_orders(user).await?;
        let orders: Vec<WsBasicOrderData> = match serde_json::from_value(response) {
            Ok(v) => v,
            Err(e) => {
                log::warn!("Failed to parse frontend open orders response: {e}");
                return Ok(None);
            }
        };

        let order = match orders
            .into_iter()
            .find(|o| o.cloid.as_ref().is_some_and(|c| c == &cloid_hex))
        {
            Some(o) => o,
            None => return Ok(None),
        };

        let instrument = match self.get_or_create_instrument(&order.coin, None) {
            Some(inst) => inst,
            None => return Ok(None),
        };

        let status = if order.trigger_activated == Some(true) {
            HyperliquidOrderStatusEnum::Triggered
        } else {
            HyperliquidOrderStatusEnum::Open
        };

        match parse_order_status_report_from_basic(
            &order,
            &status,
            &instrument,
            account_id,
            ts_init,
        ) {
            Ok(mut report) => {
                report.client_order_id = Some(*client_order_id);
                Ok(Some(report))
            }
            Err(e) => {
                log::error!("Failed to parse order status report for cloid {cloid_hex}: {e}");
                Ok(None)
            }
        }
    }

    /// Request fill reports for a user.
    ///
    /// Fetches user fills via `info_user_fills` and parses them into FillReports.
    /// This method requires instruments to be added to the client cache via `cache_instrument()`.
    ///
    /// For vault tokens (starting with "vntls:") that are not in the cache, synthetic instruments
    /// will be created automatically.
    ///
    /// # Errors
    ///
    /// Returns an error if the API request fails or parsing fails.
    ///
    /// Returns an error if `account_id` is not set on the client.
    pub async fn request_fill_reports(
        &self,
        user: &str,
        instrument_id: Option<InstrumentId>,
    ) -> Result<Vec<FillReport>> {
        let account_id = self
            .account_id
            .ok_or_else(|| Error::bad_request("Account ID not set"))?;
        let fills_response = self.info_user_fills(user).await?;

        let mut reports = Vec::new();
        let ts_init = self.clock.get_time_ns();

        for fill in fills_response {
            // Get instrument from cache or create synthetic for vault tokens
            let instrument = match self.get_or_create_instrument(&fill.coin, None) {
                Some(inst) => inst,
                None => continue, // Skip if instrument not found
            };

            // Filter by instrument_id if specified
            if let Some(filter_id) = instrument_id
                && instrument.id() != filter_id
            {
                continue;
            }

            // Parse to FillReport
            match parse_fill_report(&fill, &instrument, account_id, ts_init) {
                Ok(report) => reports.push(report),
                Err(e) => log::error!("Failed to parse fill report: {e}"),
            }
        }

        Ok(reports)
    }

    /// Request position status reports for a user.
    ///
    /// Fetches perp clearinghouse state and spot clearinghouse state, then returns
    /// the union of perp asset positions (short/long with PnL) and spot holdings
    /// (long only). This method requires instruments to be added to the client
    /// cache via `cache_instrument()`.
    ///
    /// When `instrument_id` resolves to a specific product type, the opposite
    /// product's endpoint is skipped to avoid wasted round trips and make
    /// filtered queries independent of the unused endpoint's availability.
    /// HIP-4 outcomes live in `spotClearinghouseState`, so an outcome filter
    /// is routed like a spot filter (perp leg skipped).
    ///
    /// For vault tokens (starting with "vntls:") that are not in the cache,
    /// synthetic instruments will be created automatically. Spot balances whose
    /// base token has no cached instrument are skipped with a debug log.
    ///
    /// # Errors
    ///
    /// Returns an error if either clearinghouse request fails (when that
    /// product is in scope) or parsing fails.
    ///
    /// Returns an error if `account_id` has not been set on the client.
    pub async fn request_position_status_reports(
        &self,
        user: &str,
        instrument_id: Option<InstrumentId>,
    ) -> Result<Vec<PositionStatusReport>> {
        let account_id = self
            .account_id
            .ok_or_else(|| Error::bad_request("Account ID not set"))?;

        let filter_product = instrument_id
            .and_then(|id| HyperliquidProductType::from_symbol(id.symbol.as_str()).ok());

        let fetch_perp = !matches!(
            filter_product,
            Some(HyperliquidProductType::Spot | HyperliquidProductType::Outcome)
        );
        let fetch_spot = filter_product != Some(HyperliquidProductType::Perp);

        let mut reports = Vec::new();
        let ts_init = self.clock.get_time_ns();

        if !fetch_perp {
            let spot_reports = self
                .request_spot_position_status_reports(user, instrument_id)
                .await?;
            reports.extend(spot_reports);
            return Ok(reports);
        }

        let state_response = self.info_clearinghouse_state(user).await?;

        // Extract asset positions from the clearinghouse state
        let asset_positions: Vec<serde_json::Value> = state_response
            .get("assetPositions")
            .and_then(|v| v.as_array())
            .ok_or_else(|| Error::bad_request("assetPositions not found in clearinghouse state"))?
            .clone();

        for position_value in asset_positions {
            // Extract coin from position data
            let coin = position_value
                .get("position")
                .and_then(|p| p.get("coin"))
                .and_then(|c| c.as_str())
                .ok_or_else(|| Error::bad_request("coin not found in position"))?;

            // Get instrument from cache - convert &str to Ustr for lookup
            let coin_ustr = Ustr::from(coin);
            let instrument = match self.get_or_create_instrument(&coin_ustr, None) {
                Some(inst) => inst,
                None => continue, // Skip if instrument not found
            };

            // Filter by instrument_id if specified
            if let Some(filter_id) = instrument_id
                && instrument.id() != filter_id
            {
                continue;
            }

            // Parse to PositionStatusReport
            match parse_position_status_report(&position_value, &instrument, account_id, ts_init) {
                Ok(report) => reports.push(report),
                Err(e) => log::error!("Failed to parse position status report: {e}"),
            }
        }

        // Spot positions are part of the report truth; propagate fetch errors
        // rather than silently omitting spot holdings from reconciliation.
        if fetch_spot {
            let spot_reports = self
                .request_spot_position_status_reports(user, instrument_id)
                .await?;
            reports.extend(spot_reports);
        }

        Ok(reports)
    }

    /// Request account state (balances and margins) for a user.
    ///
    /// Fetches perp and spot clearinghouse state from Hyperliquid and merges them
    /// into a single [`AccountState`]. USDC is taken from the perp margin summary
    /// when present (to avoid double-counting combined `withdrawable`); non-USDC
    /// tokens are appended from the spot balances.
    ///
    /// # Errors
    ///
    /// Returns an error if `account_id` is not set, or if either the perp or
    /// spot clearinghouse request fails. Spot failures are propagated so the
    /// caller sees real API errors instead of a silently truncated snapshot.
    pub async fn request_account_state(&self, user: &str) -> Result<AccountState> {
        let account_id = self
            .account_id
            .ok_or_else(|| Error::bad_request("Account ID not set"))?;
        let state_response = self.info_clearinghouse_state(user).await?;
        let ts_init = self.clock.get_time_ns();

        log::trace!("Clearinghouse state response: {state_response}");

        let perp_state: ClearinghouseState = serde_json::from_value(state_response.clone())
            .map_err(|e| {
                log::error!("Failed to parse clearinghouse state: {e}");
                log::debug!("Raw response: {state_response}");
                Error::bad_request(format!("Failed to parse clearinghouse state: {e}"))
            })?;

        // Spot must not be silently dropped: a 429 or parse error would
        // otherwise make non-USDC holdings look like they vanished.
        let spot_response = self.info_spot_clearinghouse_state(user).await?;
        let spot_state: SpotClearinghouseState = serde_json::from_value(spot_response.clone())
            .map_err(|e| {
                log::error!("Failed to parse spot clearinghouse state: {e}");
                log::debug!("Raw spot response: {spot_response}");
                Error::bad_request(format!("Failed to parse spot clearinghouse state: {e}"))
            })?;

        let (balances, margins) =
            parse_combined_account_balances_and_margins(&perp_state, &spot_state)
                .map_err(|e| Error::decode(e.to_string()))?;

        Ok(AccountState::new(
            account_id,
            AccountType::Margin,
            balances,
            margins,
            true, // reported
            UUID4::new(),
            ts_init,
            ts_init,
            None,
        ))
    }

    /// Request spot token balances for a user.
    ///
    /// Fetches `spotClearinghouseState` and returns one [`AccountBalance`] per
    /// non-zero token. USDC is included as a separate balance entry when present;
    /// callers that also report perp margin state must dedupe currencies before
    /// emitting an [`AccountState`].
    ///
    /// # Errors
    ///
    /// Returns an error if the API request fails or the response cannot be parsed.
    pub async fn request_spot_balances(&self, user: &str) -> Result<Vec<AccountBalance>> {
        let response = self.info_spot_clearinghouse_state(user).await?;

        log::trace!("Spot clearinghouse state response: {response}");

        let state: SpotClearinghouseState =
            serde_json::from_value(response.clone()).map_err(|e| {
                log::error!("Failed to parse spot clearinghouse state: {e}");
                log::debug!("Raw response: {response}");
                Error::bad_request(format!("Failed to parse spot clearinghouse state: {e}"))
            })?;

        parse_spot_account_balances(&state).map_err(|e| Error::decode(e.to_string()))
    }

    /// Request spot position status reports for a user.
    ///
    /// Each non-zero spot balance is reported as a Long position against its
    /// `{BASE}-{QUOTE}-SPOT` instrument. HIP-4 outcome side tokens arrive on
    /// this same endpoint with `coin` set to the `+<encoding>` token form;
    /// those balances are resolved against the matching Outcome instrument so
    /// outcome holdings surface as positions through the standard reconcile
    /// path. Balances whose base token has no matching instrument in the
    /// cache are skipped with a debug log (callers should ensure
    /// [`request_instruments`](Self::request_instruments) has run first).
    ///
    /// # Errors
    ///
    /// Returns an error if `account_id` has not been set or the API request fails.
    pub async fn request_spot_position_status_reports(
        &self,
        user: &str,
        instrument_id: Option<InstrumentId>,
    ) -> Result<Vec<PositionStatusReport>> {
        let account_id = self
            .account_id
            .ok_or_else(|| Error::bad_request("Account ID not set"))?;
        let response = self.info_spot_clearinghouse_state(user).await?;

        let state: SpotClearinghouseState = serde_json::from_value(response).map_err(|e| {
            log::error!("Failed to parse spot clearinghouse state: {e}");
            Error::bad_request(format!("Failed to parse spot clearinghouse state: {e}"))
        })?;

        let ts_init = self.clock.get_time_ns();
        let mut reports = Vec::with_capacity(state.balances.len());

        for balance in &state.balances {
            if balance.total.is_zero() {
                continue;
            }

            // USDC is the universal quote for Hyperliquid spot: it funds every
            // pair and has no `USDC-*-SPOT` instrument. Skip it so the loop
            // does not trigger a misleading cache-miss WARN. Revisit if
            // Hyperliquid ever introduces a USDC-base spot pair.
            if balance.coin.as_str() == "USDC" {
                continue;
            }

            let product_type = match HyperliquidProductType::from_symbol(balance.coin.as_str()) {
                Ok(HyperliquidProductType::Outcome) => HyperliquidProductType::Outcome,
                _ => HyperliquidProductType::Spot,
            };

            let instrument = match self.get_or_create_instrument(&balance.coin, Some(product_type))
            {
                Some(inst) => inst,
                None => continue,
            };

            if let Some(filter_id) = instrument_id
                && instrument.id() != filter_id
            {
                continue;
            }

            match parse_spot_position_status_report(balance, &instrument, account_id, ts_init) {
                Ok(report) => reports.push(report),
                Err(e) => log::error!(
                    "Failed to parse spot position status report for {}: {e}",
                    balance.coin,
                ),
            }
        }

        Ok(reports)
    }

    /// Request historical bars for an instrument.
    ///
    /// Fetches candle data from the Hyperliquid API and converts it to Nautilus bars.
    /// Incomplete bars (where end_timestamp >= current time) are filtered out.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - The instrument is not found in cache.
    /// - The bar aggregation is unsupported by Hyperliquid.
    /// - The API request fails.
    /// - Parsing fails.
    ///
    /// # References
    ///
    /// <https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#candles-snapshot>
    pub async fn request_bars(
        &self,
        bar_type: BarType,
        start: Option<chrono::DateTime<chrono::Utc>>,
        end: Option<chrono::DateTime<chrono::Utc>>,
        limit: Option<u32>,
    ) -> Result<Vec<Bar>> {
        let instrument_id = bar_type.instrument_id();
        let symbol = instrument_id.symbol;

        let product_type = HyperliquidProductType::from_symbol(symbol.as_str()).ok();

        // Extract base currency for lookup, then use raw_symbol for the API call
        let base = Ustr::from(
            symbol
                .as_str()
                .split('-')
                .next()
                .ok_or_else(|| Error::bad_request("Invalid instrument symbol"))?,
        );

        let instrument = self
            .get_or_create_instrument(&base, product_type)
            .ok_or_else(|| {
                Error::bad_request(format!("Instrument not found in cache: {instrument_id}"))
            })?;

        // Use raw_symbol which has the correct Hyperliquid API format:
        // - Perps: base currency (e.g., "BTC")
        // - Spot PURR: slash format (e.g., "PURR/USDC")
        // - Spot others: @{index} format (e.g., "@107")
        let coin = instrument.raw_symbol().inner();

        let price_precision = instrument.price_precision();
        let size_precision = instrument.size_precision();

        let interval =
            bar_type_to_interval(&bar_type).map_err(|e| Error::bad_request(e.to_string()))?;

        // Hyperliquid uses millisecond timestamps
        let now = chrono::Utc::now();
        let end_time = end.unwrap_or(now).timestamp_millis() as u64;
        let start_time = if let Some(start) = start {
            start.timestamp_millis() as u64
        } else {
            // Default to 1000 bars before end_time
            let spec = bar_type.spec();
            let step_ms = match spec.aggregation {
                BarAggregation::Minute => spec.step.get() as u64 * 60_000,
                BarAggregation::Hour => spec.step.get() as u64 * 3_600_000,
                BarAggregation::Day => spec.step.get() as u64 * 86_400_000,
                BarAggregation::Week => spec.step.get() as u64 * 604_800_000,
                BarAggregation::Month => spec.step.get() as u64 * 2_592_000_000,
                _ => 60_000,
            };
            end_time.saturating_sub(1000 * step_ms)
        };

        let candles = self
            .info_candle_snapshot(coin.as_str(), interval, start_time, end_time)
            .await?;

        // Filter out incomplete bars where end_timestamp >= current time
        let now_ms = now.timestamp_millis() as u64;

        let mut bars: Vec<Bar> = candles
            .iter()
            .filter(|candle| candle.end_timestamp < now_ms)
            .enumerate()
            .filter_map(|(i, candle)| {
                candle_to_bar(candle, bar_type, price_precision, size_precision)
                    .map_err(|e| {
                        log::error!("Failed to convert candle {i} to bar: {candle:?} error: {e}");
                        e
                    })
                    .ok()
            })
            .collect();

        // 0 means no limit
        if let Some(limit) = limit
            && limit > 0
            && bars.len() > limit as usize
        {
            bars.truncate(limit as usize);
        }

        log::debug!(
            "Received {} bars for {} (filtered {} incomplete)",
            bars.len(),
            bar_type,
            candles.len() - bars.len()
        );
        Ok(bars)
    }

    /// Submits an order to the exchange.
    ///
    /// # Errors
    ///
    /// Returns an error if credentials are missing, order validation fails, serialization fails,
    /// or the API returns an error.
    #[expect(clippy::too_many_arguments)]
    pub async fn submit_order(
        &self,
        instrument_id: InstrumentId,
        client_order_id: ClientOrderId,
        order_side: OrderSide,
        order_type: OrderType,
        quantity: Quantity,
        time_in_force: TimeInForce,
        price: Option<Price>,
        trigger_price: Option<Price>,
        post_only: bool,
        reduce_only: bool,
    ) -> Result<OrderStatusReport> {
        let symbol = instrument_id.symbol.as_str();
        let asset = self.get_asset_index(symbol).ok_or_else(|| {
            Error::bad_request(format!(
                "Asset index not found for symbol: {symbol}. Ensure instruments are loaded."
            ))
        })?;

        let is_buy = matches!(order_side, OrderSide::Buy);
        let price_precision = self.get_price_precision(symbol).unwrap_or(2);

        let price_decimal = match price {
            Some(px) if self.normalize_prices => {
                normalize_price(px.as_decimal(), price_precision).normalize()
            }
            Some(px) => px.as_decimal().normalize(),
            None if matches!(order_type, OrderType::Market) => Decimal::ZERO,
            None if matches!(
                order_type,
                OrderType::StopMarket | OrderType::MarketIfTouched
            ) =>
            {
                match trigger_price {
                    Some(tp) => {
                        let derived = derive_limit_from_trigger(
                            tp.as_decimal().normalize(),
                            is_buy,
                            self.market_order_slippage_bps,
                        );
                        let sig_rounded = round_to_sig_figs(derived, 5);
                        clamp_price_to_precision(sig_rounded, price_precision, is_buy).normalize()
                    }
                    None => Decimal::ZERO,
                }
            }
            None => return Err(Error::bad_request("Limit orders require a price")),
        };

        let size_decimal = quantity.as_decimal().normalize();

        let kind = match order_type {
            OrderType::Market => HyperliquidExecOrderKind::Limit {
                limit: HyperliquidExecLimitParams {
                    tif: HyperliquidExecTif::Ioc,
                },
            },
            OrderType::Limit => {
                let tif = if post_only {
                    HyperliquidExecTif::Alo
                } else {
                    match time_in_force {
                        TimeInForce::Gtc => HyperliquidExecTif::Gtc,
                        TimeInForce::Ioc => HyperliquidExecTif::Ioc,
                        TimeInForce::Fok
                        | TimeInForce::Day
                        | TimeInForce::Gtd
                        | TimeInForce::AtTheOpen
                        | TimeInForce::AtTheClose => {
                            return Err(Error::bad_request(format!(
                                "Time in force {time_in_force:?} not supported"
                            )));
                        }
                    }
                };
                HyperliquidExecOrderKind::Limit {
                    limit: HyperliquidExecLimitParams { tif },
                }
            }
            OrderType::StopMarket
            | OrderType::StopLimit
            | OrderType::MarketIfTouched
            | OrderType::LimitIfTouched => {
                if let Some(trig_px) = trigger_price {
                    let trigger_price_decimal = if self.normalize_prices {
                        normalize_price(trig_px.as_decimal(), price_precision).normalize()
                    } else {
                        trig_px.as_decimal().normalize()
                    };

                    // Determine TP/SL type based on order type
                    // StopMarket/StopLimit are always Sl (protective stops)
                    // MarketIfTouched/LimitIfTouched are always Tp (profit-taking/entry)
                    let tpsl = match order_type {
                        OrderType::StopMarket | OrderType::StopLimit => HyperliquidExecTpSl::Sl,
                        OrderType::MarketIfTouched | OrderType::LimitIfTouched => {
                            HyperliquidExecTpSl::Tp
                        }
                        _ => unreachable!(),
                    };

                    let is_market = matches!(
                        order_type,
                        OrderType::StopMarket | OrderType::MarketIfTouched
                    );

                    HyperliquidExecOrderKind::Trigger {
                        trigger: HyperliquidExecTriggerParams {
                            is_market,
                            trigger_px: trigger_price_decimal,
                            tpsl,
                        },
                    }
                } else {
                    return Err(Error::bad_request("Trigger orders require a trigger price"));
                }
            }
            _ => {
                return Err(Error::bad_request(format!(
                    "Order type {order_type:?} not supported"
                )));
            }
        };

        let hyperliquid_order = HyperliquidExecPlaceOrderRequest {
            asset,
            is_buy,
            price: price_decimal,
            size: size_decimal,
            reduce_only,
            kind,
            cloid: Some(Cloid::from_client_order_id(client_order_id)),
        };

        let builder = self.builder_attribution();

        let action = HyperliquidExecAction::Order {
            orders: vec![hyperliquid_order],
            grouping: HyperliquidExecGrouping::Na,
            builder,
        };

        let response = self.inner.post_action_exec(&action).await?;

        match response {
            HyperliquidExchangeResponse::Status {
                status,
                response: response_data,
            } if status == RESPONSE_STATUS_OK => {
                let data_value = if let Some(data) = response_data.get("data") {
                    data.clone()
                } else {
                    response_data
                };

                let order_response: HyperliquidExecOrderResponseData =
                    serde_json::from_value(data_value).map_err(|e| {
                        Error::bad_request(format!("Failed to parse order response: {e}"))
                    })?;

                let order_status = order_response
                    .statuses
                    .first()
                    .ok_or_else(|| Error::bad_request("No order status in response"))?;

                let symbol_str = instrument_id.symbol.as_str();
                let product_type = HyperliquidProductType::from_symbol(symbol_str).ok();

                // Extract base coin from symbol (first segment before '-')
                let asset_str = symbol_str.split('-').next().unwrap_or(symbol_str);
                let instrument = self
                    .get_or_create_instrument(&Ustr::from(asset_str), product_type)
                    .ok_or_else(|| {
                        Error::bad_request(format!("Instrument not found for {asset_str}"))
                    })?;

                let account_id = self
                    .account_id
                    .ok_or_else(|| Error::bad_request("Account ID not set"))?;
                let ts_init = self.clock.get_time_ns();

                match order_status {
                    HyperliquidExecOrderStatus::Resting { resting } => Ok(self
                        .create_order_status_report(
                            instrument_id,
                            Some(client_order_id),
                            VenueOrderId::new(resting.oid.to_string()),
                            order_side,
                            order_type,
                            quantity,
                            time_in_force,
                            price,
                            trigger_price,
                            OrderStatus::Accepted,
                            Quantity::new(0.0, instrument.size_precision()),
                            &instrument,
                            account_id,
                            ts_init,
                        )),
                    HyperliquidExecOrderStatus::Filled { filled } => {
                        let filled_qty = Quantity::new(
                            filled.total_sz.to_string().parse::<f64>().unwrap_or(0.0),
                            instrument.size_precision(),
                        );
                        Ok(self.create_order_status_report(
                            instrument_id,
                            Some(client_order_id),
                            VenueOrderId::new(filled.oid.to_string()),
                            order_side,
                            order_type,
                            quantity,
                            time_in_force,
                            price,
                            trigger_price,
                            OrderStatus::Filled,
                            filled_qty,
                            &instrument,
                            account_id,
                            ts_init,
                        ))
                    }
                    HyperliquidExecOrderStatus::Error { error } => {
                        Err(Error::bad_request(format!("Order rejected: {error}")))
                    }
                }
            }
            HyperliquidExchangeResponse::Error { error } => Err(Error::bad_request(format!(
                "Order submission failed: {error}"
            ))),
            _ => Err(Error::bad_request("Unexpected response format")),
        }
    }

    /// Submit an order using an OrderAny object.
    ///
    /// This is a convenience method that wraps submit_order.
    pub async fn submit_order_from_order_any(&self, order: &OrderAny) -> Result<OrderStatusReport> {
        self.submit_order(
            order.instrument_id(),
            order.client_order_id(),
            order.order_side(),
            order.order_type(),
            order.quantity(),
            order.time_in_force(),
            order.price(),
            order.trigger_price(),
            order.is_post_only(),
            order.is_reduce_only(),
        )
        .await
    }

    #[expect(clippy::too_many_arguments)]
    fn create_order_status_report(
        &self,
        instrument_id: InstrumentId,
        client_order_id: Option<ClientOrderId>,
        venue_order_id: VenueOrderId,
        order_side: OrderSide,
        order_type: OrderType,
        quantity: Quantity,
        time_in_force: TimeInForce,
        price: Option<Price>,
        trigger_price: Option<Price>,
        order_status: OrderStatus,
        filled_qty: Quantity,
        _instrument: &InstrumentAny,
        account_id: AccountId,
        ts_init: UnixNanos,
    ) -> OrderStatusReport {
        let ts_accepted = self.clock.get_time_ns();
        let ts_last = ts_accepted;
        let report_id = UUID4::new();

        let mut report = OrderStatusReport::new(
            account_id,
            instrument_id,
            client_order_id,
            venue_order_id,
            order_side,
            order_type,
            time_in_force,
            order_status,
            quantity,
            filled_qty,
            ts_accepted,
            ts_last,
            ts_init,
            Some(report_id),
        );

        if let Some(px) = price {
            report = report.with_price(px);
        }

        if let Some(trig_px) = trigger_price {
            report = report
                .with_trigger_price(trig_px)
                .with_trigger_type(TriggerType::Default);
        }

        report
    }

    /// Submit multiple orders to the Hyperliquid exchange in a single request.
    ///
    /// # Errors
    ///
    /// Returns an error if credentials are missing, order validation fails, serialization fails,
    /// or the API returns an error.
    pub async fn submit_orders(&self, orders: &[&OrderAny]) -> Result<Vec<OrderStatusReport>> {
        // Convert orders using asset indices from the cached map
        let mut hyperliquid_orders = Vec::with_capacity(orders.len());

        for order in orders {
            let instrument_id = order.instrument_id();
            let symbol = instrument_id.symbol.as_str();
            let asset = self.get_asset_index(symbol).ok_or_else(|| {
                Error::bad_request(format!(
                    "Asset index not found for symbol: {symbol}. Ensure instruments are loaded."
                ))
            })?;
            let price_decimals = self.get_price_precision(symbol).unwrap_or(2);
            let request = order_to_hyperliquid_request_with_asset(
                order,
                asset,
                price_decimals,
                self.normalize_prices,
                self.market_order_slippage_bps,
            )
            .map_err(|e| Error::bad_request(format!("Failed to convert order: {e}")))?;
            hyperliquid_orders.push(request);
        }

        let builder = self.builder_attribution();

        let grouping =
            determine_order_list_grouping(&orders.iter().copied().cloned().collect::<Vec<_>>());

        let action = HyperliquidExecAction::Order {
            orders: hyperliquid_orders,
            grouping,
            builder,
        };

        // Submit to exchange using the typed exec endpoint
        let response = self.inner.post_action_exec(&action).await?;

        // Parse the response to extract order statuses
        match response {
            HyperliquidExchangeResponse::Status {
                status,
                response: response_data,
            } if status == RESPONSE_STATUS_OK => {
                // Extract the 'data' field from the response if it exists (new format)
                // Otherwise use response_data directly (old format)
                let data_value = if let Some(data) = response_data.get("data") {
                    data.clone()
                } else {
                    response_data
                };

                // Parse the response data to extract order statuses
                let order_response: HyperliquidExecOrderResponseData =
                    serde_json::from_value(data_value).map_err(|e| {
                        Error::bad_request(format!("Failed to parse order response: {e}"))
                    })?;

                let account_id = self
                    .account_id
                    .ok_or_else(|| Error::bad_request("Account ID not set"))?;
                let ts_init = self.clock.get_time_ns();

                // For grouped orders (NormalTpsl/PositionTpsl), the exchange
                // returns a single status for the whole group. Only enforce
                // 1:1 matching for ungrouped (Na) submissions.
                if grouping == HyperliquidExecGrouping::Na
                    && order_response.statuses.len() != orders.len()
                {
                    return Err(Error::bad_request(format!(
                        "Mismatch between submitted orders ({}) and response statuses ({})",
                        orders.len(),
                        order_response.statuses.len()
                    )));
                }

                let mut reports = Vec::new();

                // Create OrderStatusReport for each order with a matching
                // status. For grouped submissions the exchange may return
                // fewer statuses; remaining orders are confirmed via WS.
                for (order, order_status) in orders.iter().zip(order_response.statuses.iter()) {
                    // Extract asset from instrument symbol
                    let instrument_id = order.instrument_id();
                    let symbol = instrument_id.symbol.as_str();
                    let product_type = HyperliquidProductType::from_symbol(symbol).ok();

                    // Extract base coin from symbol (first segment before '-')
                    let asset = symbol.split('-').next().unwrap_or(symbol);
                    let instrument = self
                        .get_or_create_instrument(&Ustr::from(asset), product_type)
                        .ok_or_else(|| {
                            Error::bad_request(format!("Instrument not found for {asset}"))
                        })?;

                    // Create OrderStatusReport based on the order status
                    let report = match order_status {
                        HyperliquidExecOrderStatus::Resting { resting } => {
                            // Order is resting on the order book
                            self.create_order_status_report(
                                order.instrument_id(),
                                Some(order.client_order_id()),
                                VenueOrderId::new(resting.oid.to_string()),
                                order.order_side(),
                                order.order_type(),
                                order.quantity(),
                                order.time_in_force(),
                                order.price(),
                                order.trigger_price(),
                                OrderStatus::Accepted,
                                Quantity::new(0.0, instrument.size_precision()),
                                &instrument,
                                account_id,
                                ts_init,
                            )
                        }
                        HyperliquidExecOrderStatus::Filled { filled } => {
                            // Order was filled immediately
                            let filled_qty = Quantity::new(
                                filled.total_sz.to_string().parse::<f64>().unwrap_or(0.0),
                                instrument.size_precision(),
                            );
                            self.create_order_status_report(
                                order.instrument_id(),
                                Some(order.client_order_id()),
                                VenueOrderId::new(filled.oid.to_string()),
                                order.order_side(),
                                order.order_type(),
                                order.quantity(),
                                order.time_in_force(),
                                order.price(),
                                order.trigger_price(),
                                OrderStatus::Filled,
                                filled_qty,
                                &instrument,
                                account_id,
                                ts_init,
                            )
                        }
                        HyperliquidExecOrderStatus::Error { error } => {
                            return Err(Error::bad_request(format!(
                                "Order {} rejected: {error}",
                                order.client_order_id()
                            )));
                        }
                    };

                    reports.push(report);
                }

                Ok(reports)
            }
            HyperliquidExchangeResponse::Error { error } => Err(Error::bad_request(format!(
                "Order submission failed: {error}"
            ))),
            _ => Err(Error::bad_request("Unexpected response format")),
        }
    }
}

/// Returns the asset index base for a perp dex.
///
/// Standard perps (dex 0) start at 0. HIP-3 dexes start at
/// 100_000 + dex_index * 10_000.
fn perp_dex_asset_index_base(dex_index: usize) -> u32 {
    if dex_index == 0 {
        0
    } else {
        100_000 + dex_index as u32 * 10_000
    }
}

#[cfg(test)]
mod tests {
    use std::{net::SocketAddr, sync::Arc};

    use axum::{
        Router,
        extract::State,
        http::StatusCode,
        response::{IntoResponse, Json, Response},
        routing::post,
    };
    use nautilus_core::{MUTEX_POISONED, time::get_atomic_clock_realtime};
    use nautilus_model::{
        currencies::CURRENCY_MAP,
        enums::CurrencyType,
        identifiers::{InstrumentId, Symbol},
        instruments::{CryptoPerpetual, CurrencyPair, Instrument, InstrumentAny},
        types::{Currency, Price, Quantity},
    };
    use rstest::rstest;
    use serde_json::{Value, json};
    use ustr::Ustr;

    use super::HyperliquidHttpClient;
    use crate::{
        common::{
            consts::HYPERLIQUID_VENUE,
            enums::{HyperliquidEnvironment, HyperliquidProductType},
        },
        http::query::InfoRequest,
    };

    #[derive(Clone, Default)]
    struct OutcomeMetaServerState {
        last_request_body: Arc<tokio::sync::Mutex<Option<Value>>>,
    }

    async fn handle_outcome_meta_info(
        State(state): State<OutcomeMetaServerState>,
        body: axum::body::Bytes,
    ) -> Response {
        let Ok(request_body): Result<Value, _> = serde_json::from_slice(&body) else {
            return (
                StatusCode::BAD_REQUEST,
                Json(json!({"error": "Invalid JSON body"})),
            )
                .into_response();
        };

        *state.last_request_body.lock().await = Some(request_body.clone());

        if request_body.get("type").and_then(|value| value.as_str()) != Some("outcomeMeta") {
            return (
                StatusCode::BAD_REQUEST,
                Json(json!({"error": "Expected outcomeMeta request"})),
            )
                .into_response();
        }

        Json(json!({
            "outcomes": [
                {
                    "outcome": 123,
                    "name": "Recurring",
                    "description": "class:priceBinary|underlying:HYPE|expiry:20260310-1100|targetPrice:34.5|period:3m",
                    "sideSpecs": [
                        {"name": "Yes"},
                        {"name": "No"}
                    ]
                }
            ]
        }))
        .into_response()
    }

    async fn start_outcome_meta_server(state: OutcomeMetaServerState) -> SocketAddr {
        let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
        let addr = listener.local_addr().unwrap();
        let router = Router::new()
            .route("/info", post(handle_outcome_meta_info))
            .with_state(state);

        tokio::spawn(async move {
            axum::serve(listener, router).await.unwrap();
        });

        addr
    }

    #[rstest]
    fn stable_json_roundtrips() {
        let v = serde_json::json!({"type":"l2Book","coin":"BTC"});
        let s = serde_json::to_string(&v).unwrap();
        // Parse back to ensure JSON structure is correct, regardless of field order
        let parsed: serde_json::Value = serde_json::from_str(&s).unwrap();
        assert_eq!(parsed["type"], "l2Book");
        assert_eq!(parsed["coin"], "BTC");
        assert_eq!(parsed, v);
    }

    #[rstest]
    fn info_pretty_shape() {
        let r = InfoRequest::l2_book("BTC");
        let val = serde_json::to_value(&r).unwrap();
        let pretty = serde_json::to_string_pretty(&val).unwrap();
        assert!(pretty.contains("\"type\": \"l2Book\""));
        assert!(pretty.contains("\"coin\": \"BTC\""));
    }

    #[rstest]
    #[tokio::test]
    async fn test_production_client_get_outcome_meta_uses_outcome_meta_request() {
        let state = OutcomeMetaServerState::default();
        let addr = start_outcome_meta_server(state.clone()).await;
        let mut client =
            HyperliquidHttpClient::new(HyperliquidEnvironment::Mainnet, 60, None).unwrap();
        client.set_base_info_url(format!("http://{addr}/info"));

        let meta = client.get_outcome_meta().await.unwrap();
        let request_body = state.last_request_body.lock().await.clone().unwrap();

        assert_eq!(request_body, json!({"type": "outcomeMeta"}));
        assert_eq!(meta.outcomes.len(), 1);
        assert_eq!(meta.outcomes[0].outcome, 123);
        assert_eq!(meta.outcomes[0].name, "Recurring");
        assert_eq!(meta.outcomes[0].side_specs.len(), 2);
        assert_eq!(meta.outcomes[0].side_specs[0].name, "Yes");
        assert_eq!(meta.outcomes[0].side_specs[1].name, "No");
    }

    #[rstest]
    fn test_cache_instrument_by_raw_symbol() {
        let client = HyperliquidHttpClient::new(HyperliquidEnvironment::Mainnet, 60, None).unwrap();

        // Create a test instrument with base currency "vntls:vCURSOR"
        let base_code = "vntls:vCURSOR";
        let quote_code = "USDC";

        // Register the custom currency
        {
            let mut currency_map = CURRENCY_MAP.lock().expect(MUTEX_POISONED);
            if !currency_map.contains_key(base_code) {
                currency_map.insert(
                    base_code.to_string(),
                    Currency::new(base_code, 8, 0, base_code, CurrencyType::Crypto),
                );
            }
        }

        let base_currency = Currency::new(base_code, 8, 0, base_code, CurrencyType::Crypto);
        let quote_currency = Currency::new(quote_code, 6, 0, quote_code, CurrencyType::Crypto);

        // Nautilus symbol is "vntls:vCURSOR-USDC-SPOT"
        let symbol = Symbol::new("vntls:vCURSOR-USDC-SPOT");
        let venue = *HYPERLIQUID_VENUE;
        let instrument_id = InstrumentId::new(symbol, venue);

        // raw_symbol is set to the base currency "vntls:vCURSOR" (see parse.rs)
        let raw_symbol = Symbol::new(base_code);

        let clock = get_atomic_clock_realtime();
        let ts = clock.get_time_ns();

        let instrument = InstrumentAny::CurrencyPair(CurrencyPair::new(
            instrument_id,
            raw_symbol,
            base_currency,
            quote_currency,
            8,
            8,
            Price::from("0.00000001"),
            Quantity::from("0.00000001"),
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None, // taker_fee
            None, // info
            ts,
            ts,
        ));

        // Cache the instrument
        client.cache_instrument(&instrument);

        // Verify it can be looked up by full symbol
        let instruments = client.instruments.load();
        let by_full_symbol = instruments.get(&Ustr::from("vntls:vCURSOR-USDC-SPOT"));
        assert!(
            by_full_symbol.is_some(),
            "Instrument should be accessible by full symbol"
        );
        assert_eq!(by_full_symbol.unwrap().id(), instrument.id());

        // Verify it can be looked up by raw_symbol (coin) - backward compatibility
        let by_raw_symbol = instruments.get(&Ustr::from("vntls:vCURSOR"));
        assert!(
            by_raw_symbol.is_some(),
            "Instrument should be accessible by raw_symbol (Hyperliquid coin identifier)"
        );
        assert_eq!(by_raw_symbol.unwrap().id(), instrument.id());
        drop(instruments);

        // Verify it can be looked up by composite key (coin, product_type)
        let instruments_by_coin = client.instruments_by_coin.load();
        let by_coin =
            instruments_by_coin.get(&(Ustr::from("vntls:vCURSOR"), HyperliquidProductType::Spot));
        assert!(
            by_coin.is_some(),
            "Instrument should be accessible by coin and product type"
        );
        assert_eq!(by_coin.unwrap().id(), instrument.id());
        drop(instruments_by_coin);

        // Verify get_or_create_instrument works with product type
        let retrieved_with_type = client.get_or_create_instrument(
            &Ustr::from("vntls:vCURSOR"),
            Some(HyperliquidProductType::Spot),
        );
        assert!(retrieved_with_type.is_some());
        assert_eq!(retrieved_with_type.unwrap().id(), instrument.id());

        // Verify get_or_create_instrument works without product type (fallback)
        let retrieved_without_type =
            client.get_or_create_instrument(&Ustr::from("vntls:vCURSOR"), None);
        assert!(retrieved_without_type.is_some());
        assert_eq!(retrieved_without_type.unwrap().id(), instrument.id());
    }

    #[rstest]
    fn test_get_or_create_instrument_outcome_fallback_no_product_type() {
        // HTTP fill payloads for HIP-4 outcomes arrive with `coin = "#E"` and
        // no product-type context, so the no-product fallback in
        // `get_or_create_instrument` must check the Outcome bucket. Without
        // this, venue Settlement and userOutcome fills are silently dropped
        // from request_fill_reports / request_order_status_reports.
        use nautilus_core::time::get_atomic_clock_realtime;
        use nautilus_model::{
            enums::AssetClass,
            identifiers::{InstrumentId, Symbol},
            instruments::{BinaryOption, InstrumentAny},
            types::{Currency, Price, Quantity},
        };

        let client = HyperliquidHttpClient::new(HyperliquidEnvironment::Mainnet, 60, None).unwrap();
        let coin = "#500";
        let token = "+500";

        let usdh = Currency::new("USDH", 8, 0, "Hyperliquid USD", CurrencyType::Crypto);
        let symbol = Symbol::new(token);
        let raw_symbol = Symbol::new(coin);
        let venue = *HYPERLIQUID_VENUE;
        let instrument_id = InstrumentId::new(symbol, venue);

        let clock = get_atomic_clock_realtime();
        let ts = clock.get_time_ns();

        let binary = InstrumentAny::BinaryOption(BinaryOption::new(
            instrument_id,
            raw_symbol,
            AssetClass::Alternative,
            usdh,
            Default::default(),
            Default::default(),
            4,
            2,
            Price::from("0.0001"),
            Quantity::from("0.01"),
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            ts,
            ts,
        ));

        client.cache_instrument(&binary);

        let with_type = client
            .get_or_create_instrument(&Ustr::from(coin), Some(HyperliquidProductType::Outcome));
        assert!(with_type.is_some());
        assert_eq!(with_type.unwrap().id(), instrument_id);

        let no_type = client.get_or_create_instrument(&Ustr::from(coin), None);
        assert!(
            no_type.is_some(),
            "Outcome coin must resolve through the no-product fallback",
        );
        assert_eq!(no_type.unwrap().id(), instrument_id);

        let missing = client.get_or_create_instrument(&Ustr::from("#9999"), None);
        assert!(missing.is_none());
    }

    #[rstest]
    fn test_cache_instrument_base_alias_first_write_wins_for_spot() {
        // Two spot pairs share the base token "HYPE": the canonical pair is
        // cached first; a subsequent non-canonical pair must not overwrite the
        // base-token alias so lookups by "HYPE" keep resolving to the canonical
        // instrument.
        let client = HyperliquidHttpClient::new(HyperliquidEnvironment::Mainnet, 60, None).unwrap();

        let hype = Currency::new("HYPE", 8, 0, "HYPE", CurrencyType::Crypto);
        let usdc = Currency::new("USDC", 6, 0, "USDC", CurrencyType::Crypto);
        let clock = get_atomic_clock_realtime();
        let ts = clock.get_time_ns();

        let canonical = InstrumentAny::CurrencyPair(CurrencyPair::new(
            InstrumentId::new(Symbol::new("HYPE-USDC-SPOT"), *HYPERLIQUID_VENUE),
            Symbol::new("@107"),
            hype,
            usdc,
            5,
            2,
            Price::from("0.00001"),
            Quantity::from("0.01"),
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            ts,
            ts,
        ));

        let non_canonical = InstrumentAny::CurrencyPair(CurrencyPair::new(
            InstrumentId::new(Symbol::new("HYPE-USDC-SPOT"), *HYPERLIQUID_VENUE),
            Symbol::new("@999"),
            hype,
            usdc,
            5,
            2,
            Price::from("0.00001"),
            Quantity::from("0.01"),
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            ts,
            ts,
        ));

        client.cache_instrument(&canonical);
        client.cache_instrument(&non_canonical);

        let instruments_by_coin = client.instruments_by_coin.load();
        let by_base = instruments_by_coin
            .get(&(Ustr::from("HYPE"), HyperliquidProductType::Spot))
            .expect("base alias must resolve");
        assert_eq!(
            by_base.raw_symbol().inner().as_str(),
            "@107",
            "base alias must point to the canonical pair, not the one cached later",
        );
    }

    #[rstest]
    fn test_cache_instrument_perp_aliases_sanitized_base() {
        // HIP-3 perp with wildcard-bearing venue name: `instrument_id.symbol`
        // is sanitized but order paths derive a coin key by splitting that
        // sanitized symbol on `-`. The cache must alias on the sanitized base
        // so those lookups resolve to the same instrument cached under
        // `raw_symbol` (the venue-official name).
        let client = HyperliquidHttpClient::new(HyperliquidEnvironment::Mainnet, 60, None).unwrap();

        let base_currency = Currency::new(
            "dex:STREAMABCD****",
            8,
            0,
            "dex:STREAMABCD****",
            CurrencyType::Crypto,
        );
        let usd = Currency::new("USD", 8, 0, "USD", CurrencyType::Crypto);
        let usdc = Currency::new("USDC", 6, 0, "USDC", CurrencyType::Crypto);
        let clock = get_atomic_clock_realtime();
        let ts = clock.get_time_ns();

        let hip3 = InstrumentAny::CryptoPerpetual(CryptoPerpetual::new(
            InstrumentId::new(
                Symbol::new("dex:STREAMABCDxxxx-USD-PERP"),
                *HYPERLIQUID_VENUE,
            ),
            Symbol::new("dex:STREAMABCD****"),
            base_currency,
            usd,
            usdc,
            false,
            6,
            3,
            Price::from("0.000001"),
            Quantity::from("0.001"),
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            None,
            ts,
            ts,
        ));

        client.cache_instrument(&hip3);

        let instruments_by_coin = client.instruments_by_coin.load();
        let by_raw = instruments_by_coin
            .get(&(
                Ustr::from("dex:STREAMABCD****"),
                HyperliquidProductType::Perp,
            ))
            .expect("venue coin lookup must resolve");
        assert_eq!(by_raw.id(), hip3.id());

        let by_sanitized = instruments_by_coin
            .get(&(
                Ustr::from("dex:STREAMABCDxxxx"),
                HyperliquidProductType::Perp,
            ))
            .expect("sanitized base lookup must resolve");
        assert_eq!(by_sanitized.id(), hip3.id());
        drop(instruments_by_coin);

        // Confirm the order-submission lookup path resolves through the alias.
        let resolved = client
            .get_or_create_instrument(
                &Ustr::from("dex:STREAMABCDxxxx"),
                Some(HyperliquidProductType::Perp),
            )
            .expect("get_or_create_instrument must resolve sanitized base for HIP-3");
        assert_eq!(resolved.id(), hip3.id());
    }
}