@agg-build/hooks 4.0.1 → 4.5.0

package/README.md

@@ -31,7 +31,7 @@ npm install @agg-build/sdk @agg-build/hooks
 ## Quick start
 
 ```tsx
-import { AggProvider } from "@agg-build/hooks";
+import { AggProvider, QueryClient, QueryClientProvider } from "@agg-build/hooks";
 import { createAggClient } from "@agg-build/sdk";
 
 const client = createAggClient({
@@ -39,18 +39,21 @@ const client = createAggClient({
   appId: "your-app-id",
   wsUrl: "wss://ws.agg.market",
 });
+const queryClient = new QueryClient();
 
 export function App() {
   return (
-    <AggProvider
-      client={client}
-      config={{
-        general: { locale: "en-US", theme: "dark" },
-        features: { enableAnimations: true, enableLiveUpdates: true },
-      }}
-    >
-      <YourApp />
-    </AggProvider>
+    <QueryClientProvider client={queryClient}>
+      <AggProvider
+        client={client}
+        config={{
+          general: { locale: "en-US", theme: "dark" },
+          features: { enableAnimations: true, enableLiveUpdates: true },
+        }}
+      >
+        <YourApp />
+      </AggProvider>
+    </QueryClientProvider>
   );
 }
 ```
@@ -59,9 +62,9 @@ export function App() {
 prefer to compose them yourself, the individual providers (`AggSdkProvider`, `AggUiProvider`,
 `AggBalanceProvider`) are exported too.
 
-> `AggProvider` creates its own internal `QueryClientProvider` if one is not already in the tree,
-> so you don't need to install or configure TanStack Query to get started. Drop in your own
-> `<QueryClientProvider>` if you want to share a cache with the rest of your app.
+`AggProvider` uses TanStack Query for shared request and live-data caches, so a
+`QueryClientProvider` ancestor is required. The package re-exports `QueryClient` and
+`QueryClientProvider` for hooks-only consumers.
 
 ### Signing in with a wallet
 
@@ -289,6 +292,20 @@ function LinkPartnerAccount({
 To quote and fill, take the quote from `useSmartRoute` and pass its `quoteId` to
 `useExecuteManaged`.
 
+```tsx
+const buyRoute = useSmartRoute({
+  venueMarketOutcomeId,
+  tradeSide: "buy",
+  maxSpend: 50,
+});
+
+const sellRoute = useSmartRoute({
+  venueMarketOutcomeId,
+  tradeSide: "sell",
+  sellShares: 10,
+});
+```
+
 > **Removed in v4.** `useQuoteManaged` was deleted — it wrapped
 > `client.quoteManaged()`, whose endpoint (`POST /execution/quote`) does not
 > exist on the API, so the call only ever returned 404.

package/dist/{chunk-AZYAQIZB.mjs → chunk-IHMZHA2W.mjs}

@@ -11,7 +11,7 @@ import {
   useOnWithdrawalLifecycle,
   useSyncBalances,
   useWithdrawManaged
-} from "./chunk-SC6X5TL4.mjs";
+} from "./chunk-LVOL27OZ.mjs";
 
 // src/withdraw/use-withdraw-flow.ts
 import { useCallback, useEffect, useMemo, useState } from "react";