@hyperix/hooks 0.1.23 → 0.1.24

package/dist/index.d.ts

@@ -17,7 +17,10 @@ export * from "./use-perp-meta.js";
 export * from "./use-portfolio.js";
 export * from "./use-positions.js";
 export * from "./use-spot-asset-ctxs.js";
+export * from "./use-spot-markets.js";
+export * from "./use-spot-meta-and-asset-ctxs.js";
 export * from "./use-spot-meta.js";
+export * from "./use-spot-state.js";
 export * from "./use-symbol-converter.js";
 export * from "./use-twap-states.js";
 export * from "./use-user-fundings.js";

package/dist/index.js

@@ -17,7 +17,10 @@ export * from "./use-perp-meta.js";
 export * from "./use-portfolio.js";
 export * from "./use-positions.js";
 export * from "./use-spot-asset-ctxs.js";
+export * from "./use-spot-markets.js";
+export * from "./use-spot-meta-and-asset-ctxs.js";
 export * from "./use-spot-meta.js";
+export * from "./use-spot-state.js";
 export * from "./use-symbol-converter.js";
 export * from "./use-twap-states.js";
 export * from "./use-user-fundings.js";

package/dist/use-spot-markets.d.ts

@@ -0,0 +1,29 @@
+export type SpotMarket = {
+    symbol: string;
+    pairId: string;
+    baseToken: string;
+    quoteToken: string;
+    baseTokenFullName: string | null;
+    quoteTokenFullName: string | null;
+    universeIndex: number;
+    szDecimals: number;
+    weiDecimals: number;
+    tokenId: string;
+    isCanonical: boolean;
+    markPrice: number;
+    midPrice: number | null;
+    prevDayPrice: number;
+    volume24h: number;
+    baseVolume24h: number;
+    circulatingSupply: number;
+    totalSupply: number;
+};
+export type UseSpotMarketsOptions = {
+    enabled?: boolean;
+};
+export declare function useSpotMarkets(options?: UseSpotMarketsOptions): {
+    data: SpotMarket[];
+    loading: boolean;
+    ready: boolean;
+    error: string | undefined;
+};

package/dist/use-spot-markets.js

@@ -0,0 +1,61 @@
+import { useMemo } from "react";
+import { useSpotAssetCtxs } from "./use-spot-asset-ctxs.js";
+import { useSpotMeta } from "./use-spot-meta.js";
+function toNumber(value) {
+    const numericValue = Number(value);
+    return Number.isFinite(numericValue) ? numericValue : 0;
+}
+function toOptionalNumber(value) {
+    if (value === null || value === undefined) {
+        return null;
+    }
+    const numericValue = Number(value);
+    return Number.isFinite(numericValue) ? numericValue : null;
+}
+function buildCtxMap(data) {
+    return new Map((data ?? []).map((ctx) => [ctx.coin, ctx]));
+}
+export function useSpotMarkets(options = {}) {
+    const { enabled = true } = options;
+    const spotMetaState = useSpotMeta({ enabled });
+    const assetCtxsState = useSpotAssetCtxs({ enabled });
+    const markets = useMemo(() => {
+        const spotMeta = spotMetaState.data;
+        const assetCtxsByPairId = buildCtxMap(assetCtxsState.data);
+        if (!spotMeta) {
+            return [];
+        }
+        const tokenByIndex = new Map(spotMeta.tokens.map((token) => [token.index, token]));
+        return spotMeta.universe.map((market) => {
+            const baseToken = tokenByIndex.get(market.tokens[0]);
+            const quoteToken = tokenByIndex.get(market.tokens[1]);
+            const ctx = assetCtxsByPairId.get(market.name);
+            return {
+                symbol: baseToken && quoteToken ? `${baseToken.name}/${quoteToken.name}` : market.name,
+                pairId: market.name,
+                baseToken: baseToken?.name ?? "",
+                quoteToken: quoteToken?.name ?? "",
+                baseTokenFullName: baseToken?.fullName ?? null,
+                quoteTokenFullName: quoteToken?.fullName ?? null,
+                universeIndex: market.index,
+                szDecimals: baseToken?.szDecimals ?? 0,
+                weiDecimals: baseToken?.weiDecimals ?? 0,
+                tokenId: baseToken?.tokenId ?? "",
+                isCanonical: market.isCanonical ?? false,
+                markPrice: toNumber(ctx?.markPx),
+                midPrice: toOptionalNumber(ctx?.midPx),
+                prevDayPrice: toNumber(ctx?.prevDayPx),
+                volume24h: toNumber(ctx?.dayNtlVlm),
+                baseVolume24h: toNumber(ctx?.dayBaseVlm),
+                circulatingSupply: toNumber(ctx?.circulatingSupply),
+                totalSupply: toNumber(ctx?.totalSupply),
+            };
+        });
+    }, [assetCtxsState.data, spotMetaState.data]);
+    return {
+        data: markets,
+        loading: spotMetaState.isLoading || assetCtxsState.loading,
+        ready: spotMetaState.isSuccess && assetCtxsState.ready,
+        error: spotMetaState.error?.message ?? assetCtxsState.error,
+    };
+}

package/dist/use-spot-meta-and-asset-ctxs.d.ts

@@ -0,0 +1,5 @@
+import { type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
+import type { SpotMetaAndAssetCtxsResponse } from "@nktkas/hyperliquid/api/info";
+export type SpotMetaAndAssetCtxsData = SpotMetaAndAssetCtxsResponse;
+export type UseSpotMetaAndAssetCtxsOptions = Omit<UseQueryOptions<SpotMetaAndAssetCtxsData, Error, SpotMetaAndAssetCtxsData, ["spot-meta-and-asset-ctxs"]>, "queryKey" | "queryFn">;
+export declare function useSpotMetaAndAssetCtxs(options?: UseSpotMetaAndAssetCtxsOptions): UseQueryResult<SpotMetaAndAssetCtxsData, Error>;

package/dist/use-spot-meta-and-asset-ctxs.js

@@ -0,0 +1,9 @@
+import { useQuery } from "@tanstack/react-query";
+import { infoClient } from "./config/hl.js";
+export function useSpotMetaAndAssetCtxs(options = {}) {
+    return useQuery({
+        queryKey: ["spot-meta-and-asset-ctxs"],
+        queryFn: () => infoClient.spotMetaAndAssetCtxs(),
+        ...options,
+    });
+}

package/dist/use-spot-state.d.ts

@@ -0,0 +1,13 @@
+import { type UseSubscribeState } from "@outofgas/react-stream";
+import type { SpotStateEvent } from "@nktkas/hyperliquid/api/subscription";
+export type SpotBalance = SpotStateEvent["spotState"]["balances"][number];
+export type SpotEscrow = NonNullable<SpotStateEvent["spotState"]["evmEscrows"]>[number];
+export type SpotStateData = SpotStateEvent["spotState"] & {
+    user: `0x${string}`;
+};
+export type UseSpotStateOptions = {
+    enabled?: boolean;
+    ignorePortfolioMargin?: boolean;
+    onUpdate?: (event: SpotStateEvent) => void;
+};
+export declare function useSpotState(user: `0x${string}`, options?: UseSpotStateOptions): UseSubscribeState<SpotStateData>;

package/dist/use-spot-state.js

@@ -0,0 +1,27 @@
+import { useSubscribe } from "@outofgas/react-stream";
+import { wsClient } from "./config/hl.js";
+export function useSpotState(user, options = {}) {
+    const { enabled: enabledOverride, ignorePortfolioMargin, onUpdate } = options;
+    const enabled = enabledOverride ?? Boolean(user);
+    return useSubscribe({
+        key: ["spot-state", user, ignorePortfolioMargin ? "ignore-pm" : "default"],
+        enabled,
+        subscribe: async ({ onData, onError }) => {
+            const subscription = await wsClient.spotState({ user, ignorePortfolioMargin }, (event) => {
+                try {
+                    onUpdate?.(event);
+                    onData({
+                        user: event.user,
+                        ...event.spotState,
+                    });
+                }
+                catch (error) {
+                    onError(error instanceof Error ? error : new Error("Failed to process spot state event"));
+                }
+            });
+            return {
+                unsubscribe: () => subscription.unsubscribe(),
+            };
+        },
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperix/hooks",
-  "version": "0.1.23",
+  "version": "0.1.24",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",