@hyperix/hooks 0.1.17 → 0.1.19

package/dist/config/hl.d.ts

@@ -1,5 +1,8 @@
-import { HttpTransport, SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";
+import { HttpTransport, InfoClient, SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";
 export declare const transport: HttpTransport;
+export declare const infoClient: InfoClient<{
+    transport: HttpTransport;
+}>;
 export declare const wsTransport: WebSocketTransport;
 export declare const wsClient: SubscriptionClient<{
     transport: WebSocketTransport;

package/dist/config/hl.js

@@ -1,4 +1,5 @@
-import { HttpTransport, SubscriptionClient, WebSocketTransport } from "@nktkas/hyperliquid";
+import { HttpTransport, InfoClient, SubscriptionClient, WebSocketTransport, } from "@nktkas/hyperliquid";
 export const transport = new HttpTransport();
+export const infoClient = new InfoClient({ transport: transport });
 export const wsTransport = new WebSocketTransport();
 export const wsClient = new SubscriptionClient({ transport: wsTransport });

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./use-all-mids.js";
+export * from "./use-all-perp-metas.js";
 export * from "./use-active-asset-data.js";
 export * from "./use-all-dexs-asset-ctxs.js";
 export * from "./use-l2-book.js";
@@ -9,7 +10,11 @@ export * from "./use-open-orders.js";
 export * from "./use-trade-history.js";
 export * from "./use-trades.js";
 export * from "./use-order-history.js";
+export * from "./use-perp-market.js";
+export * from "./use-perp-markets.js";
+export * from "./use-perp-meta.js";
 export * from "./use-positions.js";
+export * from "./use-spot-meta.js";
 export * from "./use-symbol-converter.js";
 export * from "./use-user-fundings.js";
 export * from "./use-user-fills.js";

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from "./use-all-mids.js";
+export * from "./use-all-perp-metas.js";
 export * from "./use-active-asset-data.js";
 export * from "./use-all-dexs-asset-ctxs.js";
 export * from "./use-l2-book.js";
@@ -9,7 +10,11 @@ export * from "./use-open-orders.js";
 export * from "./use-trade-history.js";
 export * from "./use-trades.js";
 export * from "./use-order-history.js";
+export * from "./use-perp-market.js";
+export * from "./use-perp-markets.js";
+export * from "./use-perp-meta.js";
 export * from "./use-positions.js";
+export * from "./use-spot-meta.js";
 export * from "./use-symbol-converter.js";
 export * from "./use-user-fundings.js";
 export * from "./use-user-fills.js";

package/dist/use-all-perp-metas.d.ts

@@ -0,0 +1,5 @@
+import { type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
+import type { AllPerpMetasResponse } from "@nktkas/hyperliquid/api/info";
+export type AllPerpMetasData = AllPerpMetasResponse;
+export type UseAllPerpMetasOptions = Omit<UseQueryOptions<AllPerpMetasData, Error, AllPerpMetasData, ["all-perp-metas"]>, "queryKey" | "queryFn">;
+export declare function useAllPerpMetas(options?: UseAllPerpMetasOptions): UseQueryResult<AllPerpMetasData, Error>;

package/dist/use-all-perp-metas.js

@@ -0,0 +1,9 @@
+import { useQuery } from "@tanstack/react-query";
+import { infoClient } from "./config/hl.js";
+export function useAllPerpMetas(options = {}) {
+    return useQuery({
+        queryKey: ["all-perp-metas"],
+        queryFn: () => infoClient.allPerpMetas(),
+        ...options,
+    });
+}

package/dist/use-perp-market.d.ts

@@ -0,0 +1,8 @@
+import type { PerpMarket } from "./use-perp-markets.js";
+import { type UsePerpMarketsOptions } from "./use-perp-markets.js";
+export declare function usePerpMarket(coin: string, options?: UsePerpMarketsOptions): {
+    data: PerpMarket | undefined;
+    loading: boolean;
+    ready: boolean;
+    error: string | undefined;
+};

package/dist/use-perp-market.js

@@ -0,0 +1,12 @@
+import { useMemo } from "react";
+import { usePerpMarkets } from "./use-perp-markets.js";
+export function usePerpMarket(coin, options = {}) {
+    const marketsState = usePerpMarkets(options);
+    const data = useMemo(() => {
+        return marketsState.data.find((market) => market.symbol === coin || market.coin === coin);
+    }, [coin, marketsState.data]);
+    return {
+        ...marketsState,
+        data,
+    };
+}

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

@@ -0,0 +1,29 @@
+export type PerpMarket = {
+    symbol: string;
+    coin: string;
+    dex: string;
+    universeIndex: number;
+    collateralToken: string;
+    maxLeverage: number;
+    szDecimals: number;
+    onlyIsolated: boolean;
+    isDelisted: boolean;
+    markPrice: number;
+    midPrice: number | null;
+    oraclePrice: number;
+    premium: number | null;
+    fundingRate: number;
+    openInterest: number;
+    volume24h: number;
+    prevDayPrice: number;
+};
+export type UsePerpMarketsOptions = {
+    enabled?: boolean;
+    includeDelisted?: boolean;
+};
+export declare function usePerpMarkets(options?: UsePerpMarketsOptions): {
+    data: PerpMarket[];
+    loading: boolean;
+    ready: boolean;
+    error: string | undefined;
+};

package/dist/use-perp-markets.js

@@ -0,0 +1,74 @@
+import { useMemo } from "react";
+import { useAllDexsAssetCtxs } from "./use-all-dexs-asset-ctxs.js";
+import { useAllPerpMetas } from "./use-all-perp-metas.js";
+import { useSpotMeta } from "./use-spot-meta.js";
+function getDexName(symbol) {
+    return symbol.includes(":") ? (symbol.split(":")[0] ?? "") : "";
+}
+function getCoinName(symbol) {
+    return symbol.includes(":") ? (symbol.split(":")[1] ?? symbol) : symbol;
+}
+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?.ctxs ?? []);
+}
+export function usePerpMarkets(options = {}) {
+    const { enabled = true, includeDelisted = false } = options;
+    const allPerpMetasState = useAllPerpMetas({ enabled });
+    const spotMetaState = useSpotMeta({ enabled });
+    const assetCtxsState = useAllDexsAssetCtxs({ enabled });
+    const markets = useMemo(() => {
+        const allPerpMetas = allPerpMetasState.data;
+        const spotMeta = spotMetaState.data;
+        const assetCtxsByDex = buildCtxMap(assetCtxsState.data);
+        if (!allPerpMetas || !spotMeta) {
+            return [];
+        }
+        const tokenByIndex = new Map(spotMeta.tokens.map((token) => [token.index, token]));
+        return allPerpMetas
+            .flatMap((dexMetadata) => {
+            const dex = getDexName(dexMetadata.universe[0]?.name ?? "");
+            const collateralToken = tokenByIndex.get(dexMetadata.collateralToken)?.name ?? "USDC";
+            const ctxs = assetCtxsByDex.get(dex) ?? [];
+            return dexMetadata.universe.map((meta, universeIndex) => {
+                const ctx = ctxs[universeIndex];
+                return {
+                    symbol: meta.name,
+                    coin: getCoinName(meta.name),
+                    dex,
+                    universeIndex,
+                    collateralToken,
+                    maxLeverage: meta.maxLeverage,
+                    szDecimals: meta.szDecimals,
+                    onlyIsolated: meta.onlyIsolated ?? false,
+                    isDelisted: meta.isDelisted ?? false,
+                    markPrice: toNumber(ctx?.markPx),
+                    midPrice: toOptionalNumber(ctx?.midPx),
+                    oraclePrice: toNumber(ctx?.oraclePx),
+                    premium: toOptionalNumber(ctx?.premium),
+                    fundingRate: toNumber(ctx?.funding),
+                    openInterest: toNumber(ctx?.openInterest),
+                    volume24h: toNumber(ctx?.dayNtlVlm),
+                    prevDayPrice: toNumber(ctx?.prevDayPx),
+                };
+            });
+        })
+            .filter((market) => includeDelisted || !market.isDelisted);
+    }, [allPerpMetasState.data, spotMetaState.data, assetCtxsState.data, includeDelisted]);
+    return {
+        data: markets,
+        loading: allPerpMetasState.isLoading || spotMetaState.isLoading || assetCtxsState.loading,
+        ready: allPerpMetasState.isSuccess && spotMetaState.isSuccess && assetCtxsState.ready,
+        error: allPerpMetasState.error?.message ?? spotMetaState.error?.message ?? assetCtxsState.error,
+    };
+}

package/dist/use-perp-meta.d.ts

@@ -0,0 +1,17 @@
+import type { AllPerpMetasData } from "./use-all-perp-metas.js";
+import { type UseAllPerpMetasOptions } from "./use-all-perp-metas.js";
+export type PerpMeta = AllPerpMetasData[number]["universe"][number];
+export declare function usePerpMeta(coin: string, options?: UseAllPerpMetasOptions): {
+    isPending: boolean;
+    meta: {
+        szDecimals: number;
+        name: string;
+        maxLeverage: number;
+        marginTableId: number;
+        onlyIsolated?: true;
+        isDelisted?: true;
+        marginMode?: "strictIsolated" | "noCross";
+        growthMode?: "enabled";
+        lastGrowthModeChangeTime?: string;
+    } | undefined;
+};

package/dist/use-perp-meta.js

@@ -0,0 +1,13 @@
+import { useMemo } from "react";
+import { useAllPerpMetas, } from "./use-all-perp-metas.js";
+export function usePerpMeta(coin, options = {}) {
+    const allPerpMetasState = useAllPerpMetas(options);
+    const meta = useMemo(() => {
+        const universes = allPerpMetasState.data?.flatMap((perpMeta) => perpMeta.universe) ?? [];
+        return universes.find((universe) => universe.name === coin);
+    }, [coin, allPerpMetasState.data]);
+    return {
+        isPending: allPerpMetasState.isPending,
+        meta,
+    };
+}

package/dist/use-positions.js

@@ -4,8 +4,7 @@ export function usePositions(user, options = {}) {
     const positionsState = useAllDexsClearingHouseState(user, options);
     const data = useMemo(() => {
         return positionsState.data?.clearinghouseStates
-            .map(([, state]) => state.assetPositions)
-            .flatMap((positions) => positions)
+            .flatMap(([, state]) => state.assetPositions)
             .sort((left, right) => Number(left.position.positionValue) < Number(right.position.positionValue) ? 1 : -1);
     }, [positionsState.data]);
     return {

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

@@ -0,0 +1,5 @@
+import { type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
+import type { SpotMetaResponse } from "@nktkas/hyperliquid";
+export type SpotMetaData = SpotMetaResponse;
+export type UseSpotMetaOptions = Omit<UseQueryOptions<SpotMetaData, Error, SpotMetaData, ["spot-meta"]>, "queryKey" | "queryFn">;
+export declare function useSpotMeta(options?: UseSpotMetaOptions): UseQueryResult<SpotMetaData, Error>;

package/dist/use-spot-meta.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperix/hooks",
-  "version": "0.1.17",
+  "version": "0.1.19",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,6 +14,7 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
+    "@tanstack/react-query": "^5.90.2",
     "@nktkas/hyperliquid": "^0.32.1",
     "@outofgas/react-stream": "^0.1.4",
     "react": "^19.1.1"