@pear-protocol/symmio-client 0.2.49 → 0.3.1

package/dist/react/index.d.mts

@@ -8849,7 +8849,8 @@ declare function useSymmPortfolio(params: {
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.PortfolioResponse, Error>;
 
 type UseSymmNotificationsParams = {
-    userAddress?: Address;
+    accountAddress?: Address;
+    address?: Address;
     chainId?: number;
     query?: SymmQueryConfig;
 };
@@ -9153,8 +9154,24 @@ declare const symmKeys: {
         address?: Address;
         chainId?: number;
     } | undefined];
-    notifications: (address?: Address, chainId?: number) => readonly ["symm", "notifications", `0x${string}` | undefined, number | undefined];
-    unreadCount: (address?: Address, chainId?: number) => readonly ["symm", "unreadCount", `0x${string}` | undefined, number | undefined];
+    notifications: (params?: {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    }) => readonly ["symm", "notifications", {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    } | undefined];
+    unreadCount: (params?: {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    }) => readonly ["symm", "unreadCount", {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    } | undefined];
     availableMargin: (address?: Address, chainId?: number) => readonly ["symm", "availableMargin", `0x${string}` | undefined, number | undefined];
     pendingIds: (address?: Address, chainId?: number) => readonly ["symm", "pendingIds", `0x${string}` | undefined, number | undefined];
     pendingInstantOpens: (accountAddress?: Address, chainId?: number) => readonly ["symm", "pendingInstantOpens", `0x${string}` | undefined, number | undefined];

package/dist/react/index.d.ts

@@ -8849,7 +8849,8 @@ declare function useSymmPortfolio(params: {
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.PortfolioResponse, Error>;
 
 type UseSymmNotificationsParams = {
-    userAddress?: Address;
+    accountAddress?: Address;
+    address?: Address;
     chainId?: number;
     query?: SymmQueryConfig;
 };
@@ -9153,8 +9154,24 @@ declare const symmKeys: {
         address?: Address;
         chainId?: number;
     } | undefined];
-    notifications: (address?: Address, chainId?: number) => readonly ["symm", "notifications", `0x${string}` | undefined, number | undefined];
-    unreadCount: (address?: Address, chainId?: number) => readonly ["symm", "unreadCount", `0x${string}` | undefined, number | undefined];
+    notifications: (params?: {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    }) => readonly ["symm", "notifications", {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    } | undefined];
+    unreadCount: (params?: {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    }) => readonly ["symm", "unreadCount", {
+        accountAddress?: Address;
+        address?: Address;
+        chainId?: number;
+    } | undefined];
     availableMargin: (address?: Address, chainId?: number) => readonly ["symm", "availableMargin", `0x${string}` | undefined, number | undefined];
     pendingIds: (address?: Address, chainId?: number) => readonly ["symm", "pendingIds", `0x${string}` | undefined, number | undefined];
     pendingInstantOpens: (accountAddress?: Address, chainId?: number) => readonly ["symm", "pendingInstantOpens", `0x${string}` | undefined, number | undefined];

package/dist/react/index.js

@@ -4,8 +4,8 @@
 var react = require('react');
 var symmCore = require('@pear-protocol/symm-core');
 var zustand = require('zustand');
-var jsxRuntime = require('react/jsx-runtime');
 var reactQuery = require('@tanstack/react-query');
+var jsxRuntime = require('react/jsx-runtime');
 var siwe = require('siwe');
 var viem = require('viem');
 
@@ -490,6 +490,280 @@ function useBinanceWs(params) {
     };
   }, [symmCoreClient, chainId, subscribeSymbol, unsubscribeSymbol]);
 }
+
+// src/react/query-keys.ts
+var symmKeys = {
+  all: ["symm"],
+  balancesRoot: ["symm", "balances"],
+  accountSummaryRoot: ["symm", "accountSummary"],
+  accountDataRoot: ["symm", "accountData"],
+  approvalRoot: ["symm", "approval"],
+  positionsRoot: ["symm", "positions"],
+  openOrdersRoot: ["symm", "openOrders"],
+  tradeHistoryRoot: ["symm", "tradeHistory"],
+  portfolioRoot: ["symm", "portfolio"],
+  tpslOrdersRoot: ["symm", "tpslOrders"],
+  twapOrdersRoot: ["symm", "twapOrders"],
+  triggerOrdersRoot: ["symm", "triggerOrders"],
+  accounts: (address, chainId) => ["symm", "accounts", address, chainId],
+  accountsApi: (address, chainId) => ["symm", "accountsApi", address, chainId],
+  accountsLength: (address, chainId) => ["symm", "accountsLength", address, chainId],
+  accountsWithPositions: (address, chainId) => ["symm", "accountsWithPositions", address, chainId],
+  accountSummary: (address, chainId) => ["symm", "accountSummary", address, chainId],
+  accountData: (address, chainId, upnl) => ["symm", "accountData", address, chainId, upnl],
+  signature: (address, chainId) => ["symm", "signature", address, chainId],
+  auth: (accountAddress, chainId, signerAddress) => ["symm", "auth", accountAddress, chainId, signerAddress],
+  approval: (owner, spender, chainId, token) => ["symm", "approval", owner, spender, chainId, token],
+  balances: (address, chainId) => ["symm", "balances", address, chainId],
+  positions: (params) => ["symm", "positions", params],
+  openOrders: (params) => ["symm", "openOrders", params],
+  tradeHistory: (params) => ["symm", "tradeHistory", params],
+  tpslOrders: (address, chainId) => ["symm", "tpslOrders", address, chainId],
+  tpslOrdersList: (params) => ["symm", "tpslOrders", params],
+  twapOrders: (address, chainId) => ["symm", "twapOrders", address, chainId],
+  triggerOrders: (params) => ["symm", "triggerOrders", params],
+  triggerConfig: (orderId) => ["symm", "triggerConfig", orderId],
+  markets: (chainId, search, pageSize) => ["symm", "markets", chainId, search, pageSize],
+  hedgerMarketById: (id, chainId) => ["symm", "hedgerMarketById", id, chainId],
+  hedgerMarketBySymbol: (symbol, chainId) => ["symm", "hedgerMarketBySymbol", symbol, chainId],
+  lockedParams: (marketName, leverage, chainId) => ["symm", "lockedParams", marketName, leverage, chainId],
+  hedgerMarkets: (request) => ["symm", "hedgerMarkets", request],
+  fundingRates: (chainId) => ["symm", "fundingRates", chainId],
+  fundingPayments: (params) => ["symm", "fundingPayments", params],
+  fundingHistory: (params) => ["symm", "fundingHistory", params],
+  portfolio: (params) => ["symm", "portfolio", params],
+  notifications: (params) => ["symm", "notifications", params],
+  unreadCount: (params) => ["symm", "unreadCount", params],
+  availableMargin: (address, chainId) => ["symm", "availableMargin", address, chainId],
+  pendingIds: (address, chainId) => ["symm", "pendingIds", address, chainId],
+  pendingInstantOpens: (accountAddress, chainId) => ["symm", "pendingInstantOpens", accountAddress, chainId],
+  twapOrder: (orderId) => ["symm", "twapOrder", orderId],
+  delegation: (account, target, selectors, chainId) => ["symm", "delegation", account, target, selectors, chainId],
+  chartMetadata: (symbolsKey, positionKey) => ["symm", "chartMetadata", symbolsKey, positionKey]
+};
+var useSymmWsStore = zustand.create((set) => ({
+  isConnected: false,
+  setConnected: (isConnected) => set({ isConnected })
+}));
+
+// src/react/hooks/use-symm-ws.ts
+function asUnsubscribeFn(value) {
+  return typeof value === "function" ? value : null;
+}
+function logSymmWs(event, details) {
+  if (typeof window === "undefined") {
+    return;
+  }
+  console.debug("[symm-ws]", event, details ?? {});
+}
+function useSymmWs(params = {}) {
+  const ctx = react.useContext(SymmContext);
+  const queryClient = reactQuery.useQueryClient();
+  const isConnected = useSymmWsStore((state) => state.isConnected);
+  const setConnected = useSymmWsStore((state) => state.setConnected);
+  const symmCoreClient = params.symmCoreClient ?? ctx?.symmCoreClient ?? null;
+  const accountAddress = params.accountAddress ?? ctx?.address;
+  const chainId = params.chainId ?? ctx?.chainId ?? 42161;
+  react.useEffect(() => {
+    if (!symmCoreClient || !accountAddress) {
+      logSymmWs("setup:skip", {
+        hasClient: !!symmCoreClient,
+        accountAddress,
+        chainId
+      });
+      setConnected(false);
+      return;
+    }
+    const ws = symmCoreClient.ws;
+    const addr = accountAddress;
+    const unsubscribers = [];
+    let cancelled = false;
+    logSymmWs("setup:start", {
+      accountAddress: addr,
+      chainId,
+      alreadyConnected: typeof ws.isConnected === "function" ? ws.isConnected() : void 0
+    });
+    const removeOnConnect = ws.onConnect(() => {
+      logSymmWs("connection:connected", {
+        accountAddress: addr,
+        chainId
+      });
+      setConnected(true);
+    });
+    const removeOnDisconnect = ws.onDisconnect(() => {
+      logSymmWs("connection:disconnected", {
+        accountAddress: addr,
+        chainId
+      });
+      setConnected(false);
+    });
+    const removeOnError = asUnsubscribeFn(
+      ws.onError?.((error) => {
+        logSymmWs("connection:error", {
+          accountAddress: addr,
+          chainId,
+          error: error instanceof Error ? error.message : String(error)
+        });
+      })
+    );
+    const removeOnWelcome = asUnsubscribeFn(
+      ws.onWelcome?.((message) => {
+        logSymmWs("connection:welcome", {
+          accountAddress: addr,
+          chainId,
+          message
+        });
+      })
+    );
+    unsubscribers.push(removeOnConnect, removeOnDisconnect);
+    if (removeOnError) unsubscribers.push(removeOnError);
+    if (removeOnWelcome) unsubscribers.push(removeOnWelcome);
+    const positionsUnsub = asUnsubscribeFn(
+      ws.subscribeToPositions(addr, chainId, () => {
+        logSymmWs("message:positions", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.positionsRoot
+        });
+      })
+    );
+    if (positionsUnsub) unsubscribers.push(positionsUnsub);
+    const openOrdersUnsub = asUnsubscribeFn(
+      ws.subscribeToOpenOrders(addr, chainId, () => {
+        logSymmWs("message:open-orders", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.openOrdersRoot
+        });
+      })
+    );
+    if (openOrdersUnsub) unsubscribers.push(openOrdersUnsub);
+    const tradesUnsub = asUnsubscribeFn(
+      ws.subscribeToTrades(addr, chainId, () => {
+        logSymmWs("message:trades", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.tradeHistoryRoot
+        });
+      })
+    );
+    if (tradesUnsub) unsubscribers.push(tradesUnsub);
+    const accountSummaryUnsub = asUnsubscribeFn(
+      ws.subscribeToAccountSummary(addr, chainId, () => {
+        logSymmWs("message:account-summary", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.balances(accountAddress, chainId)
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.accountSummary(accountAddress, chainId)
+        });
+      })
+    );
+    if (accountSummaryUnsub) unsubscribers.push(accountSummaryUnsub);
+    const notificationsUnsub = asUnsubscribeFn(
+      ws.subscribeToNotifications(addr, chainId, () => {
+        logSymmWs("message:notifications", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.notifications({ accountAddress, chainId })
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.unreadCount({ accountAddress, chainId })
+        });
+      })
+    );
+    if (notificationsUnsub) unsubscribers.push(notificationsUnsub);
+    const tpslUnsub = asUnsubscribeFn(
+      ws.subscribeToTpsl(addr, chainId, () => {
+        logSymmWs("message:tpsl", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({ queryKey: symmKeys.tpslOrdersRoot });
+        queryClient.invalidateQueries({ queryKey: symmKeys.openOrdersRoot });
+      })
+    );
+    if (tpslUnsub) unsubscribers.push(tpslUnsub);
+    const twapUnsub = asUnsubscribeFn(
+      ws.subscribeToTwapOrders(addr, chainId, () => {
+        logSymmWs("message:twap-orders", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({ queryKey: symmKeys.twapOrdersRoot });
+        queryClient.invalidateQueries({ queryKey: symmKeys.openOrdersRoot });
+      })
+    );
+    if (twapUnsub) unsubscribers.push(twapUnsub);
+    const triggerOrdersUnsub = asUnsubscribeFn(
+      ws.subscribeToTriggerOrders(addr, chainId, () => {
+        logSymmWs("message:trigger-orders", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({ queryKey: symmKeys.triggerOrdersRoot });
+        queryClient.invalidateQueries({ queryKey: symmKeys.openOrdersRoot });
+      })
+    );
+    if (triggerOrdersUnsub) unsubscribers.push(triggerOrdersUnsub);
+    const executionsUnsub = asUnsubscribeFn(
+      ws.subscribeToExecutions(addr, chainId, () => {
+        logSymmWs("message:executions", {
+          accountAddress: addr,
+          chainId
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.positionsRoot
+        });
+        queryClient.invalidateQueries({
+          queryKey: symmKeys.portfolioRoot
+        });
+      })
+    );
+    if (executionsUnsub) unsubscribers.push(executionsUnsub);
+    void ws.connect().then(() => {
+      if (cancelled) {
+        return;
+      }
+      logSymmWs("connection:connect-called", {
+        accountAddress: addr,
+        chainId
+      });
+    }).catch((error) => {
+      if (cancelled) {
+        return;
+      }
+      logSymmWs("connection:connect-failed", {
+        accountAddress: addr,
+        chainId,
+        error: error instanceof Error ? error.message : String(error)
+      });
+      setConnected(false);
+    });
+    return () => {
+      cancelled = true;
+      logSymmWs("cleanup:start", {
+        accountAddress: addr,
+        chainId
+      });
+      unsubscribers.forEach((unsubscribe) => unsubscribe());
+      ws.disconnect();
+      setConnected(false);
+    };
+  }, [symmCoreClient, accountAddress, chainId, queryClient, setConnected]);
+  return { isConnected };
+}
 function SymmProvider({
   chainId = 42161,
   address,
@@ -522,6 +796,11 @@ function SymmProvider({
     symmCoreClient,
     chainId
   });
+  useSymmWs({
+    symmCoreClient,
+    accountAddress: address,
+    chainId
+  });
   return /* @__PURE__ */ jsxRuntime.jsx(SymmContext.Provider, { value, children });
 }
 
@@ -704,57 +983,6 @@ async function fetchAccessTokenEntry(walletClient, signerAddress, accountAddress
   return cachedToken;
 }
 
-// src/react/query-keys.ts
-var symmKeys = {
-  all: ["symm"],
-  balancesRoot: ["symm", "balances"],
-  accountSummaryRoot: ["symm", "accountSummary"],
-  accountDataRoot: ["symm", "accountData"],
-  approvalRoot: ["symm", "approval"],
-  positionsRoot: ["symm", "positions"],
-  openOrdersRoot: ["symm", "openOrders"],
-  tradeHistoryRoot: ["symm", "tradeHistory"],
-  portfolioRoot: ["symm", "portfolio"],
-  tpslOrdersRoot: ["symm", "tpslOrders"],
-  twapOrdersRoot: ["symm", "twapOrders"],
-  triggerOrdersRoot: ["symm", "triggerOrders"],
-  accounts: (address, chainId) => ["symm", "accounts", address, chainId],
-  accountsApi: (address, chainId) => ["symm", "accountsApi", address, chainId],
-  accountsLength: (address, chainId) => ["symm", "accountsLength", address, chainId],
-  accountsWithPositions: (address, chainId) => ["symm", "accountsWithPositions", address, chainId],
-  accountSummary: (address, chainId) => ["symm", "accountSummary", address, chainId],
-  accountData: (address, chainId, upnl) => ["symm", "accountData", address, chainId, upnl],
-  signature: (address, chainId) => ["symm", "signature", address, chainId],
-  auth: (accountAddress, chainId, signerAddress) => ["symm", "auth", accountAddress, chainId, signerAddress],
-  approval: (owner, spender, chainId, token) => ["symm", "approval", owner, spender, chainId, token],
-  balances: (address, chainId) => ["symm", "balances", address, chainId],
-  positions: (params) => ["symm", "positions", params],
-  openOrders: (params) => ["symm", "openOrders", params],
-  tradeHistory: (params) => ["symm", "tradeHistory", params],
-  tpslOrders: (address, chainId) => ["symm", "tpslOrders", address, chainId],
-  tpslOrdersList: (params) => ["symm", "tpslOrders", params],
-  twapOrders: (address, chainId) => ["symm", "twapOrders", address, chainId],
-  triggerOrders: (params) => ["symm", "triggerOrders", params],
-  triggerConfig: (orderId) => ["symm", "triggerConfig", orderId],
-  markets: (chainId, search, pageSize) => ["symm", "markets", chainId, search, pageSize],
-  hedgerMarketById: (id, chainId) => ["symm", "hedgerMarketById", id, chainId],
-  hedgerMarketBySymbol: (symbol, chainId) => ["symm", "hedgerMarketBySymbol", symbol, chainId],
-  lockedParams: (marketName, leverage, chainId) => ["symm", "lockedParams", marketName, leverage, chainId],
-  hedgerMarkets: (request) => ["symm", "hedgerMarkets", request],
-  fundingRates: (chainId) => ["symm", "fundingRates", chainId],
-  fundingPayments: (params) => ["symm", "fundingPayments", params],
-  fundingHistory: (params) => ["symm", "fundingHistory", params],
-  portfolio: (params) => ["symm", "portfolio", params],
-  notifications: (address, chainId) => ["symm", "notifications", address, chainId],
-  unreadCount: (address, chainId) => ["symm", "unreadCount", address, chainId],
-  availableMargin: (address, chainId) => ["symm", "availableMargin", address, chainId],
-  pendingIds: (address, chainId) => ["symm", "pendingIds", address, chainId],
-  pendingInstantOpens: (accountAddress, chainId) => ["symm", "pendingInstantOpens", accountAddress, chainId],
-  twapOrder: (orderId) => ["symm", "twapOrder", orderId],
-  delegation: (account, target, selectors, chainId) => ["symm", "delegation", account, target, selectors, chainId],
-  chartMetadata: (symbolsKey, positionKey) => ["symm", "chartMetadata", symbolsKey, positionKey]
-};
-
 // src/react/auth-cache.ts
 function getAuthQueryData(queryClient, accountAddress, chainId, signerAddress) {
   return queryClient.getQueryData(
@@ -25476,13 +25704,14 @@ function useSymmUpdatePositionMutation(paramsOrOptions, maybeOptions) {
         typedRequest.authToken,
         typedRequest.accountAddress
       );
-      if (!authToken) {
-        throw new Error("auth token is required to update a position");
-      }
-      return symmCoreClient.positions.update(positionId, {
+      const requestWithOptionalAuth = authToken ? {
         ...request,
         authToken
-      });
+      } : request;
+      return symmCoreClient.positions.update(
+        positionId,
+        requestWithOptionalAuth
+      );
     }
   });
 }
@@ -26040,61 +26269,81 @@ function useSymmPortfolio(params) {
 function useResolvedNotificationsParams(params) {
   const { symmCoreClient, chainId: ctxChainId } = useSymmContext();
   const chainId = params.chainId ?? ctxChainId;
+  const accountAddress = params.accountAddress;
+  const address = accountAddress ? void 0 : params.address;
   return {
     symmCoreClient,
     chainId,
-    userAddress: params.userAddress,
+    accountAddress,
+    address,
     query: params.query
   };
 }
 function useSymmNotificationsQuery(params) {
-  const { symmCoreClient, chainId, userAddress, query } = useResolvedNotificationsParams(params);
-  const internalEnabled = !!symmCoreClient && !!userAddress;
+  const { symmCoreClient, chainId, accountAddress, address, query } = useResolvedNotificationsParams(params);
+  const internalEnabled = !!symmCoreClient && !!(accountAddress || address);
+  const queryParams = {
+    accountAddress,
+    address,
+    chainId
+  };
   return reactQuery.useQuery({
     ...query,
-    queryKey: symmKeys.notifications(userAddress, chainId),
+    queryKey: symmKeys.notifications(queryParams),
     queryFn: () => symmCoreClient.notifications.list({
-      userAddress,
+      accountAddress,
+      address,
       chainId
     }),
     enabled: internalEnabled && (query?.enabled ?? true)
   });
 }
 function useSymmUnreadCountQuery(params) {
-  const { symmCoreClient, chainId, userAddress, query } = useResolvedNotificationsParams(params);
-  const internalEnabled = !!symmCoreClient && !!userAddress;
+  const { symmCoreClient, chainId, accountAddress, address, query } = useResolvedNotificationsParams(params);
+  const internalEnabled = !!symmCoreClient && !!(accountAddress || address);
+  const queryParams = {
+    accountAddress,
+    address,
+    chainId
+  };
   return reactQuery.useQuery({
     ...query,
-    queryKey: symmKeys.unreadCount(userAddress, chainId),
+    queryKey: symmKeys.unreadCount(queryParams),
     queryFn: () => symmCoreClient.notifications.getUnreadCount({
-      userAddress,
+      accountAddress,
+      address,
       chainId
     }),
     enabled: internalEnabled && (query?.enabled ?? true)
   });
 }
 function useSymmMarkReadNotificationMutation(params, options) {
-  const { symmCoreClient, chainId, userAddress } = useResolvedNotificationsParams(params);
+  const { symmCoreClient, chainId, accountAddress, address } = useResolvedNotificationsParams(params);
   const queryClient = reactQuery.useQueryClient();
+  const queryParams = {
+    accountAddress,
+    address,
+    chainId
+  };
   return reactQuery.useMutation({
     ...withSymmMutationConfig(options?.mutation, {
       onSuccess: () => {
         queryClient.invalidateQueries({
-          queryKey: symmKeys.notifications(userAddress, chainId)
+          queryKey: symmKeys.notifications(queryParams)
         });
         queryClient.invalidateQueries({
-          queryKey: symmKeys.unreadCount(userAddress, chainId)
+          queryKey: symmKeys.unreadCount(queryParams)
         });
       }
     }),
     mutationFn: async ({ id, timestamp }) => {
-      if (!symmCoreClient || !userAddress) {
+      if (!symmCoreClient || !accountAddress) {
         throw new Error("symm-core client not available");
       }
       return symmCoreClient.notifications.markRead({
         id,
         timestamp,
-        userAddress,
+        accountAddress,
         chainId
       });
     }
@@ -26900,10 +27149,6 @@ function getSymmErrorMessage(error) {
   if (error instanceof Error) return error.message;
   return "An unexpected error occurred.";
 }
-var useSymmWsStore = zustand.create((set) => ({
-  isConnected: false,
-  setConnected: (isConnected) => set({ isConnected })
-}));
 
 exports.SymmProvider = SymmProvider;
 exports.getSymmErrorMessage = getSymmErrorMessage;