@pear-protocol/symmio-client 0.2.14 → 0.2.15

package/dist/react/index.d.mts

@@ -21,6 +21,9 @@ type SymmContextValue = {
 };
 declare function useSymmContext(): SymmContextValue;
 
+/**
+ * Use case: Access the configured SYMM core client from context.
+ */
 declare function useSymmCoreClient(): SymmSDK | null;
 
 type UseSymmAuthParams = {
@@ -29,6 +32,9 @@ type UseSymmAuthParams = {
     walletClient?: WalletClient;
     siweDomain?: string;
 };
+/**
+ * Use case: Manage SYMM auth token lifecycle (read, refresh, clear) for an address and chain.
+ */
 declare function useSymmAuth(params?: UseSymmAuthParams): {
     accessToken: string | null;
     authToken: string | null;
@@ -88,6 +94,9 @@ type SymmDelegationState = {
     openAccess?: boolean;
     closeAccess?: boolean;
 };
+/**
+ * Use case: Read delegation access state for trading selectors and target account.
+ */
 declare function useSymmDelegation(params?: UseSymmDelegationParams): _tanstack_react_query.UseQueryResult<SymmDelegationState, Error>;
 
 type SymmInstantTradeActionArgs = {
@@ -8192,6 +8201,9 @@ declare function ensureInstantTradeReady(deps: ReturnType<typeof useInstantTrade
     target: `0x${string}`;
     selectors: readonly `0x${string}`[];
 }>;
+/**
+ * Use case: Ensure instant-trade prerequisites (auth + delegation) are satisfied.
+ */
 declare function useSymmInstantTradeEnsureReadyMutation(params: UseSymmInstantTradeParams, options?: {
     mutation?: SymmMutationConfig<Awaited<ReturnType<typeof ensureInstantTradeReady>>, Error, EnsureReadyRequest | undefined>;
 }): _tanstack_react_query.UseMutationResult<{
@@ -8200,6 +8212,9 @@ declare function useSymmInstantTradeEnsureReadyMutation(params: UseSymmInstantTr
     target: `0x${string}`;
     selectors: readonly `0x${string}`[];
 }, Error, EnsureReadyRequest | undefined, unknown>;
+/**
+ * Use case: Execute an instant-trade action after readiness checks.
+ */
 declare function useSymmInstantTradeExecuteMutation(params: UseSymmInstantTradeParams, options?: {
     mutation?: SymmMutationConfig<unknown, Error, SymmInstantTradeRequest>;
 }): _tanstack_react_query.UseMutationResult<unknown, Error, SymmInstantTradeRequest, unknown>;
@@ -8214,9 +8229,15 @@ type UseSymmAccountsClients = {
     publicClient?: PublicClient;
     walletClient?: WalletClient;
 };
+/**
+ * Use case: Read on-chain subaccounts for a wallet via the MultiAccount contract.
+ */
 declare function useSymmAccountsQuery(params?: UseSymmAccountsClients, options?: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<Account[], Error>;
+/**
+ * Use case: Create a new on-chain subaccount.
+ */
 declare function useSymmCreateAccountMutation(params?: UseSymmAccountsClients, options?: {
     mutation?: SymmMutationConfig<Hex, Error, {
         name: string;
@@ -8224,6 +8245,9 @@ declare function useSymmCreateAccountMutation(params?: UseSymmAccountsClients, o
 }): _tanstack_react_query.UseMutationResult<`0x${string}`, Error, {
     name: string;
 }, unknown>;
+/**
+ * Use case: Rename an existing on-chain subaccount.
+ */
 declare function useSymmEditAccountNameMutation(params?: UseSymmAccountsClients, options?: {
     mutation?: SymmMutationConfig<Hex, Error, {
         accountAddress: Address;
@@ -8234,18 +8258,27 @@ declare function useSymmEditAccountNameMutation(params?: UseSymmAccountsClients,
     name: string;
 }, unknown>;
 
+/**
+ * Use case: Fetch paginated accounts from the SYMM core API for a user.
+ */
 declare function useSymmAccountsApi(params: {
     userAddress?: Address;
     chainId?: number;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<node_modules__pear_protocol_symm_core_dist_types.AccountsListResponse, Error>;
 
+/**
+ * Use case: Fetch the total number of SYMM accounts owned by a user.
+ */
 declare function useSymmAccountsLength(params: {
     userAddress?: Address;
     chainId?: number;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<node_modules__pear_protocol_symm_core_dist_types.AccountsLengthResponse, Error>;
 
+/**
+ * Use case: Fetch only accounts that currently have positions.
+ */
 declare function useSymmAccountsWithPositions(params: {
     userAddress?: Address;
     chainId?: number;
@@ -8268,15 +8301,24 @@ type UseSymmApprovalParams = {
     collateralToken?: Address;
     query?: SymmQueryConfig;
 };
+/**
+ * Use case: Read allowance/balance and compute approval state for a collateral token amount.
+ */
 declare function useSymmApprovalQuery(params: UseSymmApprovalParams): _tanstack_react_query.UseQueryResult<{
     state: ApprovalState;
     allowance: bigint;
     balance: bigint;
 }, Error>;
+/**
+ * Use case: Submit ERC-20 approval for SYMM trading collateral.
+ */
 declare function useSymmApproveMutation(params: UseSymmApprovalParams, options?: {
     mutation?: SymmMutationConfig<Hex, Error, bigint>;
 }): _tanstack_react_query.UseMutationResult<`0x${string}`, Error, bigint, unknown>;
 
+/**
+ * Use case: Cancel a pending close request that requires auth token validation.
+ */
 declare function useSymmCancelClose(options?: {
     mutation?: SymmMutationConfig<unknown, Error, {
         quoteId: string;
@@ -8291,6 +8333,9 @@ declare function useSymmCancelClose(options?: {
     overrideChainId?: number;
 }, unknown>;
 
+/**
+ * Use case: Close an order using API auth token from request or shared auth store.
+ */
 declare function useSymmCloseOrder(options?: {
     mutation?: SymmMutationConfig<unknown, Error, CloseOrderRequest>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_core.CloseOrderResponse, Error, CloseOrderRequest, unknown>;
@@ -8299,6 +8344,9 @@ type UseSymmDepositParams = {
     publicClient?: PublicClient;
     walletClient?: WalletClient;
 };
+/**
+ * Use case: Deposit collateral into a SYMM subaccount.
+ */
 declare function useSymmDepositMutation(params?: UseSymmDepositParams, options?: {
     mutation?: SymmMutationConfig<Hex, Error, {
         account: Address;
@@ -8308,6 +8356,9 @@ declare function useSymmDepositMutation(params?: UseSymmDepositParams, options?:
     account: Address;
     amount: bigint;
 }, unknown>;
+/**
+ * Use case: Deposit and immediately allocate collateral in one transaction.
+ */
 declare function useSymmDepositAndAllocateMutation(params?: UseSymmDepositParams, options?: {
     mutation?: SymmMutationConfig<Hex, Error, {
         account: Address;
@@ -8318,6 +8369,9 @@ declare function useSymmDepositAndAllocateMutation(params?: UseSymmDepositParams
     amount: bigint;
 }, unknown>;
 
+/**
+ * Use case: Withdraw collateral from a SYMM subaccount.
+ */
 declare function useSymmWithdraw(params?: {
     publicClient?: PublicClient;
     walletClient?: WalletClient;
@@ -8340,6 +8394,9 @@ type UseSymmCollateralParams = {
     publicClient?: PublicClient;
     walletClient?: WalletClient;
 };
+/**
+ * Use case: Allocate collateral from wallet balance into a SYMM subaccount.
+ */
 declare function useSymmAllocateCollateralMutation(params?: UseSymmCollateralParams, options?: {
     mutation?: SymmMutationConfig<Hex, Error, {
         subAccount: Address;
@@ -8349,6 +8406,9 @@ declare function useSymmAllocateCollateralMutation(params?: UseSymmCollateralPar
     subAccount: Address;
     amount: bigint;
 }, unknown>;
+/**
+ * Use case: Deallocate collateral back from a SYMM subaccount using Muon signature.
+ */
 declare function useSymmDeallocateCollateralMutation(params?: UseSymmCollateralParams, options?: {
     mutation?: SymmMutationConfig<Hex, Error, {
         subAccount: Address;
@@ -8358,6 +8418,9 @@ declare function useSymmDeallocateCollateralMutation(params?: UseSymmCollateralP
     subAccount: Address;
     amount: bigint;
 }, unknown>;
+/**
+ * Use case: Transfer collateral internally between SYMM subaccounts.
+ */
 declare function useSymmInternalTransferCollateralMutation(params?: UseSymmCollateralParams, options?: {
     mutation?: SymmMutationConfig<Hex, Error, {
         subAccount: Address;
@@ -8373,13 +8436,22 @@ type UseSymmSignatureParams = {
     publicClient?: PublicClient;
     walletClient?: WalletClient;
 };
+/**
+ * Use case: Check whether the user has signed the current terms version.
+ */
 declare function useSymmSignatureQuery(params?: UseSymmSignatureParams, options?: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<boolean, Error>;
+/**
+ * Use case: Sign and store the latest terms signature on-chain.
+ */
 declare function useSymmSignTermsMutation(params?: UseSymmSignatureParams, options?: {
     mutation?: SymmMutationConfig<void, Error, void>;
 }): _tanstack_react_query.UseMutationResult<void, Error, void, unknown>;
 
+/**
+ * Use case: Compute available margin from party-A stats with optional uPnL override.
+ */
 declare function useSymmAvailableMargin(params: {
     accountAddress?: Address;
     publicClient?: PublicClient;
@@ -8403,12 +8475,18 @@ declare function useSymmAvailableMargin(params: {
     nonces: number;
 }, Error>;
 
+/**
+ * Use case: Fetch aggregated account summary metrics for a user address.
+ */
 declare function useSymmAccountSummary(params: {
     userAddress?: Address;
     chainId?: number;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<node_modules__pear_protocol_symm_core_dist_types.AccountSummaryResponse, Error>;
 
+/**
+ * Use case: Fetch account-level SYMM data (including optional uPnL context) for a specific address.
+ */
 declare function useSymmAccountData(params: {
     address?: Address;
     upnl?: string;
@@ -8416,6 +8494,9 @@ declare function useSymmAccountData(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<node_modules__pear_protocol_symm_core_dist_types.AccountDataResponse, Error>;
 
+/**
+ * Use case: Fetch SYMM account balance information for a user.
+ */
 declare function useSymmBalances(params: {
     userAddress?: Address;
     chainId?: number;
@@ -8423,20 +8504,35 @@ declare function useSymmBalances(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<node_modules__pear_protocol_symm_core_dist_types.BalanceInfoResponse, Error>;
 
+/**
+ * Use case: Open a basket position through SYMM core API.
+ */
 declare function useSymmOpenBasketMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, OpenBasketPositionRequest>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_core.BasketOpenResponse | _pear_protocol_symm_core.OpenBasketCommandResult, Error, OpenBasketPositionRequest, unknown>;
+/**
+ * Use case: Close a position with automatic auth-token resolution.
+ */
 declare function useSymmClosePositionMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, ClosePositionRequest>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_core.ClosePositionResponse | _pear_protocol_symm_core.CloseCommandResult, Error, ClosePositionRequest, unknown>;
+/**
+ * Use case: Close all open positions for the provided request scope.
+ */
 declare function useSymmCloseAllPositionsMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, Parameters<NonNullable<ReturnType<typeof useSymmContext>['symmCoreClient']>['positions']['closeAll']>[0]>;
 }): _tanstack_react_query.UseMutationResult<node_modules__pear_protocol_symm_core_dist_types.CloseAllPositionsResponse, Error, Omit<node_modules__pear_protocol_symm_core_dist_types.CloseAllPositionsRequest, "chainId"> & {
     chainId?: number;
 }, unknown>;
+/**
+ * Use case: Cancel a pending open order/quote.
+ */
 declare function useSymmCancelOpenMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, CancelOpenRequest>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_shared.ApiResponse<unknown>, Error, CancelOpenRequest, unknown>;
+/**
+ * Use case: Update position settings with automatic auth-token resolution.
+ */
 declare function useSymmUpdatePositionMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, {
         positionId: string;
@@ -8447,6 +8543,9 @@ declare function useSymmUpdatePositionMutation(options?: {
     request: UpdatePositionRequest;
 }, unknown>;
 
+/**
+ * Use case: Fetch open positions for an account or address.
+ */
 declare function useSymmPositions(params: {
     accountAddress?: Address;
     address?: Address;
@@ -8454,6 +8553,9 @@ declare function useSymmPositions(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.OpenPositionsListResponse, Error>;
 
+/**
+ * Use case: Fetch open orders for an account or address.
+ */
 declare function useSymmOpenOrders(params: {
     accountAddress?: Address;
     address?: Address;
@@ -8461,6 +8563,9 @@ declare function useSymmOpenOrders(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.UnifiedOrdersListResponse, Error>;
 
+/**
+ * Use case: Fetch historical trades for an account or address.
+ */
 declare function useSymmTradeHistory(params: {
     accountAddress?: Address;
     address?: Address;
@@ -8468,9 +8573,15 @@ declare function useSymmTradeHistory(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.PositionsListResponse, Error>;
 
+/**
+ * Use case: Create or update TP/SL configuration for a position/order.
+ */
 declare function useSymmSetTpslMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, SetTpslRequest>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_core.TpslUpdateResponse, Error, SetTpslRequest, unknown>;
+/**
+ * Use case: Cancel an existing TP/SL order.
+ */
 declare function useSymmCancelTpslMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, CancelTpslRequest>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_shared.ApiResponse<unknown>, Error, CancelTpslRequest, unknown>;
@@ -8484,6 +8595,9 @@ type UseSymmTpslOrdersParams = {
     chainId?: number;
     query?: SymmQueryConfig;
 };
+/**
+ * Use case: Fetch TP/SL orders with optional account, position, and status filters.
+ */
 declare function useSymmTpslOrders(params: UseSymmTpslOrdersParams): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.TpslListResponse, Error>;
 
 type UseSymmTwapParams = {
@@ -8492,7 +8606,13 @@ type UseSymmTwapParams = {
     chainId?: number;
     query?: SymmQueryConfig;
 };
+/**
+ * Use case: Fetch TWAP orders for an account/address.
+ */
 declare function useSymmTwapOrdersQuery(params: UseSymmTwapParams): _tanstack_react_query.UseQueryResult<node_modules__pear_protocol_symm_core_dist_types.TwapOrdersListResponse, Error>;
+/**
+ * Use case: Cancel a TWAP order by id.
+ */
 declare function useSymmCancelTwapOrderMutation(options?: {
     mutation?: SymmMutationConfig<unknown, Error, string>;
 }): _tanstack_react_query.UseMutationResult<node_modules__pear_protocol_symm_core_dist_types.TwapOrderResponse, Error, string, unknown>;
@@ -8501,14 +8621,26 @@ type UseSymmTriggerConfigParams = {
     orderId?: string;
     query?: SymmQueryConfig;
 };
+/**
+ * Use case: Fetch trigger configuration for an order.
+ */
 declare function useSymmTriggerConfigQuery(params: UseSymmTriggerConfigParams): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.GetTriggerConfigResponse, Error>;
+/**
+ * Use case: Upsert trigger configuration for an order.
+ */
 declare function useSymmSetTriggerConfigMutation(params: UseSymmTriggerConfigParams, options?: {
     mutation?: SymmMutationConfig<unknown, Error, UpsertTriggerConfigRequest>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_core.GetTriggerConfigResponse, Error, UpsertTriggerConfigRequest, unknown>;
+/**
+ * Use case: Clear trigger configuration for an order.
+ */
 declare function useSymmClearTriggerConfigMutation(params: UseSymmTriggerConfigParams, options?: {
     mutation?: SymmMutationConfig<unknown, Error, void>;
 }): _tanstack_react_query.UseMutationResult<_pear_protocol_symm_core.GetTriggerConfigResponse, Error, void, unknown>;
 
+/**
+ * Use case: Fetch trigger orders with account and pagination filters.
+ */
 declare function useSymmTriggerOrders(params: {
     accountAddress?: Address;
     address?: Address;
@@ -8519,6 +8651,9 @@ declare function useSymmTriggerOrders(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.TriggerOrdersListResponse, Error>;
 
+/**
+ * Use case: List/search SYMM markets for the active chain.
+ */
 declare function useSymmMarkets(params?: {
     chainId?: number;
     searchText?: string;
@@ -8527,18 +8662,27 @@ declare function useSymmMarkets(params?: {
     markets?: unknown[];
 }, Error>;
 
+/**
+ * Use case: Fetch hedger market details by numeric market id.
+ */
 declare function useSymmHedgerMarketById(params: {
     id?: number;
     chainId?: number;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.HedgerMarketsListResponse, Error>;
 
+/**
+ * Use case: Fetch hedger market details by market symbol.
+ */
 declare function useSymmHedgerMarketBySymbol(params: {
     symbol?: string;
     chainId?: number;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.HedgerMarketsListResponse, Error>;
 
+/**
+ * Use case: Fetch locked params (e.g. margins/requirements) for market + leverage.
+ */
 declare function useSymmLockedParams(params: {
     marketName?: string;
     leverage?: number;
@@ -8551,13 +8695,22 @@ type UseSymmHedgerMarketsParams = GetSymmHedgerMarketsRequest & {
     enabled?: boolean;
     query?: SymmQueryConfig;
 };
+/**
+ * Use case: List hedger markets with optional search and filters.
+ */
 declare function useSymmHedgerMarkets(params?: UseSymmHedgerMarketsParams): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.SymmHedgerMarketsResult, Error>;
 
+/**
+ * Use case: Fetch current funding rate snapshots from SYMM core.
+ */
 declare function useSymmFunding(params?: {
     chainId?: number;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.FundingRatesResponse, Error>;
 
+/**
+ * Use case: Fetch historical funding rates for a symbol basket strategy.
+ */
 declare function useSymmFundingHistory(params: {
     period: '7d' | '30d' | '90d' | '180d';
     longSymbols?: string;
@@ -8569,6 +8722,9 @@ declare function useSymmFundingHistory(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.FundingHistoryResponse, Error>;
 
+/**
+ * Use case: Fetch realized funding payment entries by address or position.
+ */
 declare function useSymmFundingPayments(params: {
     address?: Address;
     positionId?: string;
@@ -8578,6 +8734,9 @@ declare function useSymmFundingPayments(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.FundingPaymentsResponse, Error>;
 
+/**
+ * Use case: Fetch portfolio metrics for an account or address.
+ */
 declare function useSymmPortfolio(params: {
     accountAddress?: Address;
     address?: Address;
@@ -8590,8 +8749,17 @@ type UseSymmNotificationsParams = {
     chainId?: number;
     query?: SymmQueryConfig;
 };
+/**
+ * Use case: Fetch user notifications feed from SYMM core.
+ */
 declare function useSymmNotificationsQuery(params: UseSymmNotificationsParams): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.NotificationsResponse, Error>;
+/**
+ * Use case: Fetch unread notifications count for a user.
+ */
 declare function useSymmUnreadCountQuery(params: UseSymmNotificationsParams): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.UnreadCountResponse, Error>;
+/**
+ * Use case: Mark notifications as read by id or timestamp.
+ */
 declare function useSymmMarkReadNotificationMutation(params: UseSymmNotificationsParams, options?: {
     mutation?: SymmMutationConfig<unknown, Error, {
         id?: string;
@@ -8602,12 +8770,18 @@ declare function useSymmMarkReadNotificationMutation(params: UseSymmNotification
     timestamp?: number;
 }, unknown>;
 
+/**
+ * Use case: Fetch pending quote/order ids for an account.
+ */
 declare function useSymmPendingIds(params: {
     accountAddress?: Address;
     chainId?: number;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.PendingIdsResponse, Error>;
 
+/**
+ * Use case: Fetch pending instant-open items that require auth token.
+ */
 declare function useSymmPendingInstantOpens(params: {
     accountAddress?: Address;
     authToken?: string;
@@ -8615,11 +8789,17 @@ declare function useSymmPendingInstantOpens(params: {
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<_pear_protocol_symm_core.PendingInstantOpensResponse, Error>;
 
+/**
+ * Use case: Fetch a single TWAP order by id.
+ */
 declare function useSymmTwapOrder(params: {
     orderId?: string;
     query?: SymmQueryConfig;
 }): _tanstack_react_query.UseQueryResult<node_modules__pear_protocol_symm_core_dist_types.TwapOrderResponse, Error>;
 
+/**
+ * Use case: Connect and manage SYMM WebSocket subscriptions for realtime updates.
+ */
 declare function useSymmWs(params?: {
     symmCoreClient?: SymmSDK | null;
     accountAddress?: Address;
@@ -8650,8 +8830,8 @@ interface SymmChartSelection {
     selectedSymbols: string[];
 }
 /**
- * SYMM chart selection hook. Accepts selection input as parameters
- * rather than importing app store state, keeping the SDK app-agnostic.
+ * Use case: Build normalized chart token selection state from user-provided long/short inputs.
+ * Keeps selection derivation SDK-local without coupling to app store state.
  */
 declare function useSymmChartSelection(input: SymmChartSelectionInput): SymmChartSelection;
 
@@ -8682,8 +8862,8 @@ interface UseSymmTokenSelectionMetadataOptions {
     enabled?: boolean;
 }
 /**
- * Fetches Binance market data for selected SYMM chart tokens and derives
- * chart header metrics (price ratio, weighted ratio, etc.).
+ * Use case: Fetch token market snapshots and derive chart header metrics
+ * (price ratio, weighted ratio, funding sum) for selected SYMM tokens.
  */
 declare function useSymmTokenSelectionMetadata(selection: SymmChartSelection, options?: UseSymmTokenSelectionMetadataOptions): UseSymmTokenSelectionMetadataReturn;
 
@@ -8724,8 +8904,8 @@ interface UseSymmChartCandlesReturn {
     unavailableReason: string | null;
 }
 /**
- * SYMM chart candles hook backed by Binance mark-price klines.
- * Returns the same interface as the Hyperliquid useBasketCandles hook.
+ * Use case: Provide chart candles for SYMM token baskets using Binance mark-price klines.
+ * Returns the same interface as the Hyperliquid `useBasketCandles` hook.
  *
  * Realtime updates are provided via Binance kline WebSocket streams.
  * When listeners are registered, the hook subscribes to kline streams
@@ -8743,8 +8923,8 @@ interface SymmPerformanceOverlay {
     weight?: number;
 }
 /**
- * SYMM performance overlay hook. Generates overlay definitions
- * for each selected SYMM leg, matching the Hyperliquid overlay contract.
+ * Use case: Generate performance overlay definitions for each selected SYMM leg.
+ * Overlay output matches the existing chart overlay contract expected by consumers.
  */
 declare function useSymmPerformanceOverlays(selection: SymmChartSelection): {
     overlays: SymmPerformanceOverlay[];