@hyperix/hooks 0.1.20 → 0.1.21

package/README.md

@@ -6,6 +6,40 @@ React hooks for the local workspace.
 
 This package is intended for source-first usage inside the monorepo. Consumers should reference it with `"workspace:*"` and let the app bundler resolve the TypeScript source.
 
+## Demo
+
+```tsx
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import { usePortfolio } from "@hyperix/hooks";
+
+const queryClient = new QueryClient();
+
+function PortfolioDemo() {
+  const { data, isPending, error } = usePortfolio("0x1234567890abcdef1234567890abcdef12345678");
+
+  if (isPending) {
+    return <div>Loading portfolio...</div>;
+  }
+
+  if (error) {
+    return <div>Failed to load portfolio: {error.message}</div>;
+  }
+
+  const perpDay = data?.find(([period]) => period === "perpDay")?.[1];
+  const latestPnl = Number(perpDay?.pnlHistory.at(-1)?.[1] ?? 0);
+
+  return <pre>{JSON.stringify({ latestPnl, periods: data?.map(([period]) => period) }, null, 2)}</pre>;
+}
+
+export function App() {
+  return (
+    <QueryClientProvider client={queryClient}>
+      <PortfolioDemo />
+    </QueryClientProvider>
+  );
+}
+```
+
 ## Tests
 
 ```bash

package/dist/index.d.ts

@@ -13,6 +13,7 @@ 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-portfolio.js";
 export * from "./use-positions.js";
 export * from "./use-spot-meta.js";
 export * from "./use-symbol-converter.js";

package/dist/index.js

@@ -13,6 +13,7 @@ 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-portfolio.js";
 export * from "./use-positions.js";
 export * from "./use-spot-meta.js";
 export * from "./use-symbol-converter.js";

package/dist/use-portfolio.d.ts

@@ -0,0 +1,5 @@
+import { type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
+import type { PortfolioResponse } from "@nktkas/hyperliquid/api/info";
+export type PortfolioData = PortfolioResponse;
+export type UsePortfolioOptions = Omit<UseQueryOptions<PortfolioData, Error, PortfolioData, ["portfolio", `0x${string}`]>, "queryKey" | "queryFn">;
+export declare function usePortfolio(user: `0x${string}`, options?: UsePortfolioOptions): UseQueryResult<PortfolioData, Error>;

package/dist/use-portfolio.js

@@ -0,0 +1,11 @@
+import { useQuery } from "@tanstack/react-query";
+import { infoClient } from "./config/hl.js";
+export function usePortfolio(user, options = {}) {
+    const enabled = options.enabled ?? Boolean(user);
+    return useQuery({
+        queryKey: ["portfolio", user],
+        queryFn: () => infoClient.portfolio({ user }),
+        ...options,
+        enabled,
+    });
+}

package/package.json

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