@nktkas/hyperliquid/esm/api/subscription/_methods/spotState.js

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address } from "../../_schemas.js";
/**
 * Subscription to spot state events for a specific user.
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
 */ export const SpotStateRequest = /* @__PURE__ */ (()=>{
  return v.object({
    /** Type of subscription. */ type: v.literal("spotState"),
    /** User address. */ user: Address,
    /** Whether to ignore portfolio margin calculations. */ ignorePortfolioMargin: v.optional(v.boolean())
  });
})();
// ============================================================
// Execution Logic
// ============================================================
import { parse } from "../../../_base.js";
/**
 * Subscribe to spot state updates for a specific user.
 *
 * @param config General configuration for Subscription API subscriptions.
 * @param params Parameters specific to the API subscription.
 * @param listener A callback function to be called when the event is received.
 * @param options Options to control the subscription lifecycle.
 * @return A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
 *
 * @throws {ValidationError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @example
 * ```ts
 * import { WebSocketTransport } from "@nktkas/hyperliquid";
 * import { spotState } from "@nktkas/hyperliquid/api/subscription";
 *
 * const transport = new WebSocketTransport();
 *
 * const sub = await spotState(
 *   { transport },
 *   { user: "0x..." },
 *   (data) => console.log(data),
 * );
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
 */ export function spotState(config, params, listener, options) {
  const payload = parse(SpotStateRequest, {
    type: "spotState",
    ...params
  });
  return config.transport.subscribe(payload.type, payload, (e)=>{
    if (e.detail.user === payload.user) {
      listener(e.detail);
    }
  }, options);
}
//# sourceMappingURL=spotState.js.map