@pear-protocol/hyperliquid-sdk 0.0.4 → 0.0.7-2.1

package/dist/types.d.ts

@@ -1,71 +1,8 @@
-/**
- * Raw value data for trade history positions
- */
-export interface RawValueDto {
-    coin: string;
-    size: string;
-    leverage: number;
-    openPx: string;
-    closePx: string;
-    marginUsed: string;
-    positionValue: string;
-}
-/**
- * Trade history data structure from V1 API
- */
-export interface TradeHistoryV1Dto {
-    pearId: string;
-    openedDate: string;
-    closedDate: string;
-    time: string;
-    pair: string;
-    direction: Record<string, string>;
-    closedPrice: number;
-    openedPrice: number;
-    size: string;
-    longPositionValue: number;
-    shortPositionValue: number;
-    positionValue: number;
-    fee: number;
-    builderFee: number;
-    closedPNL: number;
-    closedPnlPercentage: number;
-    leverage: number;
-    rawLongValue: RawValueDto;
-    rawShortValue: RawValueDto;
-}
-/**
- * Request payload for syncing trade history
- */
-export interface SyncTradeHistoryDto {
-    address: string;
-    data: TradeHistoryV1Dto[];
-}
-/**
- * Response from sync trade history endpoint
- */
-export interface SyncTradeHistoryResponseDto {
-    success: boolean;
-    positionId: string;
-    tradeHistoryId: string;
-    message: string;
-}
-/**
- * Base API error response
- */
 export interface ApiErrorResponse {
     statusCode: number;
     message: string;
     error?: string;
 }
-/**
- * Configuration options for the SDK
- */
-export interface PearHyperliquidConfig {
-    baseUrl: string;
-    timeout?: number;
-    headers?: Record<string, string>;
-}
 /**
  * HTTP client response wrapper
  */
@@ -74,145 +11,58 @@ export interface ApiResponse<T> {
     status: number;
     headers: Record<string, string>;
 }
-/**
- * Hook state interface for migration operations
- */
-export interface MigrationHookState<T> {
-    loading: boolean;
-    error: ApiErrorResponse | null;
-    data: T | null;
-}
-/**
- * PnL data structure for open positions
- */
-export interface PnlDto {
-    value: number;
-    percentage: number;
+export interface ExternalLiquidationDto {
+    liquidatedUser: string;
+    markPx: string;
+    method: string;
 }
-/**
- * Take profit and stop loss data structure
- */
-export interface TpSlDto {
-    takeProfit?: number;
-    stopLoss?: number;
-}
-/**
- * Position side data structure for open positions
- */
-export interface PositionSideDto {
+export interface ExternalFillDto {
     coin: string;
-    size: string;
-    leverage: number;
-    entryPx: string;
-    marginUsed: string;
-    liquidationPx: string | undefined;
-    unrealizedPnl: string;
-    roe: string;
-    positionValue: string;
-    funding: string;
-}
-/**
- * Open position data structure from V1 API
- */
-export interface OpenPositionV1Dto {
-    pair: string;
-    leverage: number;
-    size: number;
-    longPositionValue?: number;
-    shortPositionValue?: number;
-    positionValue: number;
-    entryPrice: number;
-    markPrice: number;
-    pnl: PnlDto;
-    liqPrice: string | number;
-    margin: number;
-    funding: number;
-    pearId: string;
-    openedDate: string;
-    tpsl: TpSlDto;
-    long: PositionSideDto;
-    short: PositionSideDto;
-}
-/**
- * Request payload for syncing open positions
- */
-export interface SyncOpenPositionDto {
-    address: string;
-    data: OpenPositionV1Dto[];
-}
-/**
- * Response from sync open positions endpoint
- */
-export interface SyncOpenPositionResponseDto {
-    success: boolean;
-    positionIds: string[];
-    count: number;
-    message: string;
-}
-/**
- * Open order data structure from V1 API
- */
-export interface OpenOrderV1Dto {
-    id: string;
-    time: string;
-    pair: string;
-    type: string;
-    orderValue: number;
-    price: number;
-    triggerConditions: string;
-    status: string;
-    leverage?: string;
-}
-/**
- * Request payload for syncing open orders
- */
-export interface SyncOpenOrderDto {
-    address: string;
-    data: OpenOrderV1Dto[];
-}
-/**
- * Response from sync open orders endpoint
- */
-export interface SyncOpenOrderResponseDto {
-    success: boolean;
-    orderIds: string[];
-    count: number;
-    message: string;
-}
-/**
- * Migration hooks interface
- */
-export interface MigrationHooks {
-    tradeHistory: {
-        sync: (payload: SyncTradeHistoryDto) => Promise<ApiResponse<SyncTradeHistoryResponseDto>>;
-        loading: boolean;
-        error: ApiErrorResponse | null;
-        data: SyncTradeHistoryResponseDto | null;
-        reset: () => void;
-    };
-    openPositions: {
-        sync: (payload: SyncOpenPositionDto) => Promise<ApiResponse<SyncOpenPositionResponseDto>>;
-        loading: boolean;
-        error: ApiErrorResponse | null;
-        data: SyncOpenPositionResponseDto | null;
-        reset: () => void;
-    };
-    openOrders: {
-        sync: (payload: SyncOpenOrderDto) => Promise<ApiResponse<SyncOpenOrderResponseDto>>;
-        loading: boolean;
-        error: ApiErrorResponse | null;
-        data: SyncOpenOrderResponseDto | null;
-        reset: () => void;
-    };
+    px: string;
+    sz: string;
+    side: 'B' | 'A';
+    time: number;
+    dir: string;
+    fee: string;
+    builderFee?: string;
+    oid?: string | number;
+    tid?: string | number;
+    cloid?: string | null;
+    hash?: string | null;
+    feeToken?: string | null;
+    liquidation?: ExternalLiquidationDto | null;
+}
+export interface SyncFillsRequestDto {
+    user: string;
+    fills: ExternalFillDto[];
+    assetPositions?: AssetPosition[];
+}
+export interface SyncFillsResponseDto {
+    insertedFills: number;
+    skippedDuplicates: number;
+    createdOrders: number;
+    updatedPositions: number;
+    createdPositions: number;
+    closedPositions: number;
+}
+export interface TwapSliceFillResponseItem {
+    fill: ExternalFillDto;
+    twapId: number;
 }
 /**
  * WebSocket connection states
  */
 export type WebSocketConnectionState = 'connecting' | 'connected' | 'disconnected' | 'error';
+export declare enum ReadyState {
+    CONNECTING = 0,
+    OPEN = 1,
+    CLOSING = 2,
+    CLOSED = 3
+}
 /**
  * WebSocket channels
  */
-export type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary';
+export type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary' | 'twap-details' | 'notifications' | 'market-data' | 'market-data-all' | 'webData3' | 'allMids' | 'activeAssetData';
 /**
  * WebSocket subscription message
  */
@@ -223,7 +73,7 @@ export interface WebSocketSubscribeMessage {
 /**
  * WebSocket response message
  */
-export interface WebSocketResponse {
+export interface WebSocketAckResponse {
     success?: boolean;
     message?: string;
     error?: string;
@@ -235,17 +85,85 @@ export interface WebSocketDataMessage<T = unknown> {
     channel: WebSocketChannel;
     data: T;
 }
+export interface WatchlistAssetDto {
+    asset: string;
+    weight: number;
+}
+export interface WatchlistItemDto {
+    id: string;
+    longAssets: WatchlistAssetDto[];
+    shortAssets: WatchlistAssetDto[];
+}
+export interface ToggleWatchlistResponseDto {
+    items: WatchlistItemDto[];
+}
+export type NotificationCategory = 'TRADE_OPENED_OUTSIDE_PEAR' | 'TRADE_CLOSED_OUTSIDE_PEAR' | 'POSITION_LIQUIDATED' | 'LIMIT_ORDER_FILLED' | 'LIMIT_ORDER_FAILED' | 'TP_ORDER_FILLED' | 'TP_ORDER_FAILED' | 'SL_ORDER_FILLED' | 'SL_ORDER_FAILED';
+export interface NotificationDto {
+    id: string;
+    address: string;
+    category: NotificationCategory;
+    parameters: Record<string, any>;
+    is_read: boolean;
+    created_at: string;
+    updated_at: string;
+}
+export interface ChunkFillDto {
+    fillId: string;
+    assetName: string;
+    price: number;
+    size: number;
+    executedAt: string;
+}
+export type TwapChunkStatus = 'PENDING' | 'SCHEDULED' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
+export interface TwapChunkStatusDto {
+    chunkId: string;
+    chunkIndex: number;
+    scheduledTime: string;
+    executedTime?: string;
+    status: TwapChunkStatus;
+    chunkSize: number;
+    fills: ChunkFillDto[];
+    errorMessage?: string;
+}
+export type TwapOrderOverallStatus = 'OPEN' | 'EXECUTING' | 'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'CANCELLED';
+export interface TwapMonitoringDto {
+    orderId: string;
+    positionId?: string;
+    address: string;
+    orderType: string;
+    status: TwapOrderOverallStatus;
+    totalUsdValue: number;
+    filledUsdValue: number;
+    remainingUsdValue: number;
+    twapDuration: string;
+    twapIntervalSeconds?: number | null;
+    twapChunkUsdValue?: number | null;
+    randomizeExecution: boolean;
+    reduceOnly: boolean;
+    chunks: TwapChunkStatusDto[];
+    estimatedCompletionTime?: string;
+    actualCompletionTime?: string;
+    remainingChunks: number;
+    longAssets: OrderAssetDto[];
+    shortAssets: OrderAssetDto[];
+    createdAt: string;
+    updatedAt: string;
+}
 /**
  * Trade history asset data
  */
 export interface TradeHistoryAssetDataDto {
     coin: string;
+    entryWeight: number;
     entryPrice: number;
     limitPrice: number;
+    leverage: number;
     size: number;
     externalFeePaid: number;
     builderFeePaid: number;
     realizedPnl: number;
+    marketPrefix?: string | null;
+    collateralToken?: CollateralToken;
 }
 /**
  * Trade history data structure
@@ -257,23 +175,19 @@ export interface TradeHistoryDataDto {
     externalFeePaid: number;
     builderFeePaid: number;
     realizedPnl: number;
+    realizedPnlPercentage: number;
+    totalEntryValue: number;
     totalValue: number;
     entryRatio: number;
     exitRatio: number;
-    leverage: number;
-    longAssets: TradeHistoryAssetDataDto[];
-    shortAssets: TradeHistoryAssetDataDto[];
+    entryPriceRatio?: number;
+    exitpPriceRatio?: number;
+    closedLongAssets: TradeHistoryAssetDataDto[];
+    closedShortAssets: TradeHistoryAssetDataDto[];
+    positionLongAssets?: string[];
+    positionShortAssets?: string[];
     createdAt: string;
 }
-/**
- * Paginated trade history response
- */
-export interface PaginatedTradeHistoryResponseDto {
-    data: TradeHistoryDataDto[];
-    hasMore: boolean;
-    nextCursor?: string;
-    count: number;
-}
 /**
  * Cumulative funding information
  */
@@ -290,36 +204,40 @@ export interface PositionAssetDetailDto {
     entryPrice: number;
     platformSize: number;
     actualSize: number;
-    cumFunding: CumFundingDto;
+    leverage: number;
     marginUsed: number;
+    entryPositionValue: number;
     positionValue: number;
     unrealizedPnl: number;
     liquidationPrice: number;
-    isExternallyModified: boolean;
+    initialWeight: number;
+    fundingPaid?: number;
+    marketPrefix?: string | null;
+    collateralToken?: CollateralToken;
+}
+export interface TpSlThreshold {
+    type: 'PERCENTAGE' | 'DOLLAR' | 'POSITION_VALUE';
+    value: number;
 }
-/**
- * Position sync status
- */
-export type PositionSyncStatus = 'SYNCED' | 'EXTERNALLY_MODIFIED' | 'EXTERNALLY_CLOSED' | 'PAIR_BROKEN';
 /**
  * Open position data structure
  */
 export interface OpenPositionDto {
     positionId: string;
     address: string;
-    leverage: number;
-    stopLoss: number | null;
-    takeProfit: number | null;
+    stopLoss: TpSlThreshold | null;
+    takeProfit: TpSlThreshold | null;
     entryRatio: number;
     markRatio: number;
-    netFunding: number;
+    entryPriceRatio?: number;
+    markPriceRatio?: number;
+    entryPositionValue: number;
     positionValue: number;
     marginUsed: number;
     unrealizedPnl: number;
+    unrealizedPnlPercentage: number;
     longAssets: PositionAssetDetailDto[];
     shortAssets: PositionAssetDetailDto[];
-    syncStatus: PositionSyncStatus;
-    lastSyncAt: string;
     createdAt: string;
     updatedAt: string;
 }
@@ -329,23 +247,40 @@ export interface OpenPositionDto {
 export interface OrderAssetDto {
     asset: string;
     weight: number;
+    marketPrefix?: string | null;
+    collateralToken?: CollateralToken;
 }
 /**
  * Order status
  */
 export type OrderStatus = 'OPEN' | 'PARTIALLY_FILLED' | 'PROCESSING';
+/**
+ * Order type
+ */
+export type OrderType = 'TP' | 'SL' | 'LIMIT' | 'MARKET' | 'LIMIT_BTCDOM' | 'TWAP';
+/**
+ * TP/SL trigger type
+ */
+export type TpSlTriggerType = 'PERCENTAGE' | 'DOLLAR' | 'POSITION_VALUE';
+export type OrderDirection = 'MORE_THAN' | 'LESS_THAN' | null;
 /**
  * Open limit order data structure
  */
 export interface OpenLimitOrderDto {
     orderId: string;
     address: string;
+    clientId: string | null;
+    positionId?: string | null;
     leverage: number;
     usdValue: number;
-    limitRatio: number;
-    stopLoss: number | null;
-    takeProfit: number | null;
+    triggerValue?: number | null;
+    twapDuration?: string | null;
+    tpSlTriggerType?: TpSlTriggerType | null;
+    randomizeFlag: boolean;
+    reduceOnlyFlag: boolean;
     status: OrderStatus;
+    orderType: OrderType;
+    direction?: OrderDirection | null;
     longAssets: OrderAssetDto[];
     shortAssets: OrderAssetDto[];
     createdAt: string;
@@ -383,15 +318,23 @@ export interface BalanceSummaryDto {
  * Agent wallet information
  */
 export interface AgentWalletDto {
-    address: string;
+    address?: string;
     status: string;
 }
+export interface PlatformAccountSummaryResponseDto {
+    agentWalletAddress: string | null;
+    totalClosedTrades: number;
+    totalLimitOrderUsdValue?: number;
+    totalTwapChunkUsdValue?: number;
+    lastSyncedAt?: number;
+}
 /**
  * Account balance response (renamed to AccountSummaryResponseDto for consistency)
  */
 export interface AccountSummaryResponseDto {
     balanceSummary: BalanceSummaryDto;
-    agentWallet: AgentWalletDto;
+    platformAccountSummary: PlatformAccountSummaryResponseDto | null;
+    agentWallet?: AgentWalletDto;
 }
 /**
  * Address management state
@@ -402,3 +345,455 @@ export interface AddressState {
     autoConnect: boolean;
     previousAddresses: string[];
 }
+export interface UseAuthOptions {
+    baseUrl: string;
+    clientId: string;
+}
+export interface UserProfile {
+    userId: string;
+    address: string;
+    appId: string;
+}
+export interface EIP712AuthDetails {
+    primaryType: string;
+    domain: {
+        name: string;
+        version: string;
+        chainId: number;
+        verifyingContract: `0x${string}`;
+    };
+    types: Record<string, Array<{
+        name: string;
+        type: string;
+    }>>;
+    message: Record<string, unknown>;
+    timestamp: number;
+}
+export interface GetEIP712MessageResponse extends EIP712AuthDetails {
+}
+export interface PrivyAuthDetails {
+    appId: string;
+    accessToken: string;
+}
+export interface AuthenticateRequest {
+    method: 'eip712' | 'api_key' | 'privy_access_token';
+    address: string;
+    clientId: string;
+    details: {
+        signature: string;
+        timestamp: number;
+    } | {
+        apiKey: string;
+    } | PrivyAuthDetails;
+}
+export interface AuthenticateResponse {
+    accessToken: string;
+    refreshToken: string;
+    tokenType: string;
+    expiresIn: number;
+    address: string;
+    clientId: string;
+}
+export interface RefreshTokenRequest {
+    refreshToken: string;
+}
+export interface RefreshTokenResponse {
+    accessToken: string;
+    refreshToken: string;
+    tokenType: string;
+    expiresIn: number;
+}
+export interface LogoutRequest {
+    refreshToken: string;
+}
+export interface LogoutResponse {
+    message: string;
+}
+export type AgentWalletStatus = 'ACTIVE' | 'EXPIRED' | 'NOT_FOUND';
+export interface GetAgentWalletResponseDto {
+    agentWalletAddress?: string;
+    agentName: string;
+    status: AgentWalletStatus;
+}
+export interface CreateAgentWalletResponseDto {
+    agentWalletAddress: string;
+    message: string;
+}
+export interface ExtraAgent {
+    name: string;
+    address: string;
+    validUntil: number;
+}
+export interface AgentWalletState {
+    address: string | null;
+    name: string | null;
+    status: AgentWalletStatus | 'PENDING' | null;
+    isActive: boolean;
+}
+/**
+ * WebSocket message from HyperLiquid native API
+ */
+export interface WebSocketMessage {
+    method: 'subscribe' | 'unsubscribe';
+    subscription: {
+        type: string;
+        dex?: string;
+        coin?: string;
+        interval?: string;
+        user?: string;
+        aggregateByTime?: boolean;
+    };
+}
+/**
+ * WebSocket response from HyperLiquid native API
+ */
+export type HLChannel = 'webData3' | 'allMids' | 'activeAssetData' | 'candle' | 'spotState' | 'allDexsClearinghouseState' | 'allDexsAssetCtxs';
+export interface HLChannelDataMap {
+    webData3: WebData3Response;
+    allMids: WsAllMidsData;
+    activeAssetData: ActiveAssetData;
+    candle: CandleData;
+    spotState: {
+        user: string;
+        spotState: SpotState;
+    };
+    allDexsClearinghouseState: AllDexsClearinghouseStateData;
+    allDexsAssetCtxs: AllDexsAssetCtxsData;
+}
+export interface WebData3UserState {
+    agentAddress?: string;
+    agentValidUntil?: number;
+    cumLedger: string;
+    serverTime: number;
+    isVault: boolean;
+    user: string;
+    dexAbstractionEnabled?: boolean;
+}
+export interface WebData3AssetCtx {
+    funding: string;
+    openInterest: string;
+    prevDayPx: string;
+    dayNtlVlm: string;
+    premium: string | null;
+    oraclePx: string;
+    markPx: string;
+    midPx: string | null;
+    impactPxs: string[] | null;
+    dayBaseVlm: string;
+}
+export interface WebData3PerpDexState {
+    clearinghouseState: ClearinghouseState;
+    totalVaultEquity: string;
+    assetCtxs: WebData3AssetCtx[];
+    perpsAtOpenInterestCap: string[];
+}
+export interface WebData3Response {
+    userState: WebData3UserState;
+    perpDexStates: WebData3PerpDexState[];
+}
+export interface AllDexsClearinghouseStateData {
+    user: string;
+    clearinghouseStates: [string, ClearinghouseState][];
+}
+export interface AllDexsAssetCtxsData {
+    ctxs: [string, WebData3AssetCtx[]][];
+}
+export interface HLWebSocketResponse<T extends HLChannel = HLChannel> {
+    channel: T;
+    data: HLChannelDataMap[T];
+}
+/**
+ * All mids data structure
+ */
+export interface WsAllMidsData {
+    mids: Record<string, string>;
+}
+/**
+ * Asset context data
+ */
+export interface AssetCtx {
+    funding: string;
+    openInterest: string;
+    prevDayPx: string;
+    dayNtlVlm: string;
+    markPx: string;
+    midPx?: string;
+    impactPxs?: string[];
+    oraclePx: string;
+}
+/**
+ * Collateral token type
+ * 0 = USDC
+ * 360 = USDH
+ */
+export type CollateralToken = 'USDC' | 'USDH';
+/**
+ * Universe asset metadata
+ */
+export interface UniverseAsset {
+    name: string;
+    szDecimals: number;
+    maxLeverage: number;
+    onlyIsolated?: boolean;
+    isDelisted?: boolean;
+    marketPrefix?: string;
+    collateralToken?: CollateralToken;
+}
+export interface PerpMetaAsset extends UniverseAsset {
+    marginTableId: number;
+}
+export interface MarginTier {
+    lowerBound: string;
+    maxLeverage: number;
+}
+export interface MarginTableDef {
+    description: string;
+    marginTiers: MarginTier[];
+}
+export type MarginTablesEntry = [number, MarginTableDef];
+export interface AllPerpMetasItem {
+    universe: PerpMetaAsset[];
+    marginTables: MarginTablesEntry[];
+    collateralToken: number;
+}
+export type AllPerpMetasResponse = AllPerpMetasItem[];
+export interface ClearinghouseState {
+    assetPositions: AssetPosition[];
+    crossMaintenanceMarginUsed: string;
+    crossMarginSummary: {
+        accountValue: string;
+        totalMarginUsed: string;
+        totalNtlPos: string;
+        totalRawUsd: string;
+    };
+    marginSummary: {
+        accountValue: string;
+        totalMarginUsed: string;
+        totalNtlPos: string;
+        totalRawUsd: string;
+    };
+    time: number;
+    withdrawable: string;
+}
+/**
+ * Asset position data
+ */
+export interface AssetPosition {
+    position: {
+        coin: string;
+        entryPx?: string;
+        leverage: {
+            type: string;
+            value: number;
+        };
+        liquidationPx?: string;
+        marginUsed: string;
+        maxLeverage: number;
+        positionValue: string;
+        returnOnEquity: string;
+        szi: string;
+        unrealizedPnl: string;
+        cumFunding: {
+            allTime: string;
+            sinceChange: string;
+            sinceOpen: string;
+        };
+    };
+    type: string;
+}
+/**
+ * Asset information detail
+ */
+export interface AssetInformationDetail {
+    name: string;
+    funding: string;
+    openInterest: string;
+    prevDayPx: string;
+    dayNtlVlm: string;
+    oraclePx: string;
+    markPx: string;
+    midPx?: string;
+    dayBaseVlm: string;
+    priceChange: number;
+    assetIndex: number;
+}
+/**
+ * Raw asset data from open-positions channel
+ */
+export interface RawAssetDto {
+    coin: string;
+    entryPrice: number;
+    size: number;
+    side: string;
+    fundingPaid?: number;
+    marketPrefix?: string | null;
+    collateralToken?: CollateralToken;
+    leverage: number;
+}
+/**
+ * Raw position data from open-positions channel
+ */
+export interface RawPositionDto {
+    positionId: string;
+    address: string;
+    stopLoss: number | null;
+    takeProfit: number | null;
+    status: string;
+    createdAt: string;
+    updatedAt: string;
+    longAssets: RawAssetDto[];
+    shortAssets: RawAssetDto[];
+}
+/**
+ * Leverage information from activeAssetData
+ */
+export interface LeverageInfo {
+    type: string;
+    value: number;
+}
+/**
+ * Active asset data from WebSocket
+ */
+export interface ActiveAssetData {
+    user: string;
+    coin: string;
+    leverage: LeverageInfo;
+    maxTradeSzs: [string, string];
+    availableToTrade: [string, string];
+    markPx: string;
+}
+export interface TokenMetadata {
+    currentPrice: number;
+    prevDayPrice: number;
+    priceChange24h: number;
+    priceChange24hPercent: number;
+    netFunding: number;
+    maxLeverage: number;
+    markPrice: number;
+    oraclePrice: number;
+    openInterest: string;
+    dayVolume: string;
+    leverage?: LeverageInfo;
+    maxTradeSzs?: [string, string];
+    availableToTrade?: [string, string];
+    collateralToken?: CollateralToken;
+}
+/**
+ * Enhanced token selection with weight and metadata for basket trading
+ */
+export interface TokenSelection {
+    symbol: string;
+    weight: number;
+}
+/**
+ * Token conflict information for position conflicts
+ */
+export interface TokenConflict {
+    symbol: string;
+    conflictType: 'long' | 'short';
+    conflictMessage: string;
+}
+export interface AssetMarketData {
+    asset: WebData3AssetCtx | AssetCtx;
+    universe: UniverseAsset;
+}
+/**
+ * Nested market data structure for multi-market assets.
+ * Each symbol maps to its market variants (keyed by prefix).
+ * For non-HIP3 assets, use "default" as the key.
+ *
+ * @example
+ * ```ts
+ * {
+ *   "TSLA": {
+ *     "xyz": { asset: {...}, universe: { collateralToken: "USDC", ... } },
+ *     "flx": { asset: {...}, universe: { collateralToken: "USDH", ... } }
+ *   },
+ *   "BTC": {
+ *     "default": { asset: {...}, universe: {...} }
+ *   }
+ * }
+ * ```
+ */
+export type MarketDataBySymbol = Record<string, Record<string, AssetMarketData>>;
+export interface PairAssetDto {
+    asset: string;
+    weight: number;
+    collateralToken: CollateralToken;
+    marketPrefix: string | null;
+}
+export interface ActiveAssetGroupItem {
+    longAssets: PairAssetDto[];
+    shortAssets: PairAssetDto[];
+    openInterest: string;
+    volume: string;
+    netFunding?: string;
+    ratio?: string;
+    prevRatio?: string;
+    change24h?: string;
+    weightedRatio?: string;
+    weightedPrevRatio?: string;
+    weightedChange24h?: string;
+    collateralType: 'USDC' | 'USDH' | 'MIXED';
+}
+export interface ActiveAssetsResponse {
+    active: ActiveAssetGroupItem[];
+    topGainers: ActiveAssetGroupItem[];
+    topLosers: ActiveAssetGroupItem[];
+    highlighted: ActiveAssetGroupItem[];
+    watchlist: ActiveAssetGroupItem[];
+}
+export interface ActiveAssetsAllResponse {
+    active: ActiveAssetGroupItem[];
+    all: ActiveAssetGroupItem[];
+    highlighted: ActiveAssetGroupItem[];
+    watchlist: ActiveAssetGroupItem[];
+}
+/**
+ * Candle interval options
+ */
+export type CandleInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M';
+/**
+ * Candle data structure from WebSocket
+ */
+export interface CandleData {
+    s?: string;
+    t: number;
+    T: number;
+    o: number;
+    c: number;
+    h: number;
+    l: number;
+}
+/**
+ * Candle chart data organized by symbol only
+ * Since new candles always have latest timestamp, no need to store per interval
+ */
+export type CandleChartData = Map<string, CandleData>;
+/**
+ * Historical candle data request
+ */
+export interface CandleSnapshotRequest {
+    req: {
+        coin: string;
+        startTime: number;
+        endTime: number;
+        interval: CandleInterval;
+    };
+    type: 'candleSnapshot';
+}
+export interface TokenSelectorConfig {
+    isLong: boolean;
+    index: number;
+}
+export interface SpotBalance {
+    coin: string;
+    token: number;
+    total: string;
+    hold: string;
+    entryNtl: string;
+}
+export interface SpotState {
+    user: string;
+    balances: SpotBalance[];
+}