@pear-protocol/hyperliquid-sdk 0.0.45 → 0.0.47-alpha

package/dist/clients/portfolio.d.ts

@@ -0,0 +1,39 @@
+import type { ApiResponse } from '../types';
+export type PortfolioInterval = '1d' | '1w' | '1m' | '1y' | 'all';
+export interface PortfolioBucketDto {
+    periodStart: string;
+    periodEnd: string;
+    volume: number;
+    openInterest: number;
+    winningTradesCount: number;
+    winningTradesUsd: number;
+    losingTradesCount: number;
+    losingTradesUsd: number;
+}
+export interface PortfolioOverallDto {
+    totalWinningTradesCount: number;
+    totalLosingTradesCount: number;
+    totalWinningUsd: number;
+    totalLosingUsd: number;
+    currentOpenInterest: number;
+    currentTotalVolume: number;
+    unrealizedPnl: number;
+    totalTrades: number;
+}
+export interface PortfolioIntervalsDto {
+    oneDay: PortfolioBucketDto[];
+    oneWeek: PortfolioBucketDto[];
+    oneMonth: PortfolioBucketDto[];
+    oneYear: PortfolioBucketDto[];
+    all: PortfolioBucketDto[];
+}
+export interface PortfolioResponseDto {
+    intervals: PortfolioIntervalsDto;
+    overall: PortfolioOverallDto;
+}
+/**
+ * Get portfolio summary buckets and overall metrics
+ * Returns bucketed volume, open interest snapshot, win/loss trade counts, and overall metrics filtered to PEAR fills (cloid LIKE 0x50454152%)
+ * Caller should supply an accessToken from localStorage.getItem('accessToken')
+ */
+export declare function getPortfolio(baseUrl: string, accessToken: string): Promise<ApiResponse<PortfolioResponseDto>>;

package/dist/clients/positions.d.ts

@@ -27,6 +27,7 @@ export interface CreatePositionRequestInput {
     twapDuration?: number;
     twapIntervalSeconds?: number;
     randomizeExecution?: boolean;
+    referralCode?: string;
     ladderConfig?: LadderConfigInput;
     takeProfit?: TpSlThresholdInput | null;
     stopLoss?: TpSlThresholdInput | null;
@@ -73,6 +74,7 @@ export interface ClosePositionRequestInput {
     twapDuration?: number;
     twapIntervalSeconds?: number;
     randomizeExecution?: boolean;
+    referralCode?: string;
 }
 export interface ClosePositionResponseDto {
     orderId: string;
@@ -97,6 +99,7 @@ export interface AdjustPositionRequestInput {
     adjustmentSize: number;
     executionType: AdjustExecutionType;
     limitRatio?: number;
+    referralCode?: string;
 }
 export interface AdjustPositionResponseDto {
     orderId: string;

package/dist/hooks/index.d.ts

@@ -6,7 +6,6 @@ export * from './useTokenSelectionMetadata';
 export * from './useHistoricalPriceData';
 export * from './useBasketCandles';
 export * from './usePerformanceOverlays';
-export * from './useAuth';
 export * from './useAgentWallet';
 export * from './useAutoSyncFills';
 export * from './usePosition';
@@ -15,3 +14,4 @@ export * from './useTwap';
 export * from './useNotifications';
 export * from './useMarketData';
 export * from './useWatchlist';
+export * from './usePortfolio';

package/dist/hooks/usePortfolio.d.ts

@@ -0,0 +1,13 @@
+import { type PortfolioResponseDto } from '../clients/portfolio';
+export interface UsePortfolioResult {
+    data: PortfolioResponseDto | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Hook to fetch and manage portfolio data
+ * Returns bucketed volume, open interest snapshot, win/loss trade counts,
+ * and overall metrics filtered to PEAR fills (cloid LIKE 0x50454152%)
+ */
+export declare function usePortfolio(): UsePortfolioResult;

package/dist/hooks/useWebData.d.ts

@@ -7,6 +7,5 @@ export declare const useWebData: () => {
     perpsAtOpenInterestCap: string[] | undefined;
     marketDataBySymbol: Record<string, AssetMarketData>;
     isConnected: boolean;
-    connectionStatus: import("react-use-websocket").ReadyState;
     error: string | null;
 };

package/dist/hyperliquid-websocket.d.ts

@@ -1,10 +1,8 @@
-import { ReadyState } from 'react-use-websocket';
 export interface UseHyperliquidNativeWebSocketProps {
     address: string | null;
     tokens?: string[];
 }
 export interface UseHyperliquidNativeWebSocketReturn {
-    connectionStatus: ReadyState;
     isConnected: boolean;
     lastError: string | null;
 }

package/dist/index.d.ts

@@ -1,6 +1,4 @@
 import React, { ReactNode } from 'react';
-import * as react_use_websocket from 'react-use-websocket';
-import { ReadyState } from 'react-use-websocket';
 
 interface ApiErrorResponse {
     statusCode: number;
@@ -589,10 +587,8 @@ interface PearHyperliquidContextType {
     wsUrl: string;
     address: string | null;
     setAddress: (address: string | null) => void;
-    connectionStatus: ReadyState;
     isConnected: boolean;
     lastError: string | null;
-    nativeConnectionStatus: ReadyState;
     nativeIsConnected: boolean;
     nativeLastError: string | null;
     authStatus: AuthStatus;
@@ -719,7 +715,6 @@ declare const useWebData: () => {
     perpsAtOpenInterestCap: string[] | undefined;
     marketDataBySymbol: Record<string, AssetMarketData>;
     isConnected: boolean;
-    connectionStatus: react_use_websocket.ReadyState;
     error: string | null;
 };
 
@@ -804,19 +799,6 @@ interface UsePerformanceOverlaysReturn {
 }
 declare const usePerformanceOverlays: () => UsePerformanceOverlaysReturn;
 
-declare function useAuth(): {
-    readonly status: AuthStatus;
-    readonly isAuthenticated: boolean;
-    readonly accessToken: string | null;
-    readonly user: UserProfile | null;
-    readonly error: string | null;
-    readonly getEip712: (address: string) => Promise<any>;
-    readonly loginWithSignedMessage: (address: string, signature: string, timestamp: number) => Promise<void>;
-    readonly loginWithPrivyToken: (address: string, appId: string, accessToken: string) => Promise<void>;
-    readonly refreshTokens: () => Promise<any>;
-    readonly logout: () => Promise<void>;
-};
-
 declare function useAgentWallet({ baseUrl }: UseAgentWalletOptions): {
     readonly agentWallet: AgentWalletState;
     readonly isReady: boolean;
@@ -899,6 +881,7 @@ interface CreatePositionRequestInput {
     twapDuration?: number;
     twapIntervalSeconds?: number;
     randomizeExecution?: boolean;
+    referralCode?: string;
     ladderConfig?: LadderConfigInput;
     takeProfit?: TpSlThresholdInput | null;
     stopLoss?: TpSlThresholdInput | null;
@@ -945,6 +928,7 @@ interface ClosePositionRequestInput {
     twapDuration?: number;
     twapIntervalSeconds?: number;
     randomizeExecution?: boolean;
+    referralCode?: string;
 }
 interface ClosePositionResponseDto {
     orderId: string;
@@ -969,6 +953,7 @@ interface AdjustPositionRequestInput {
     adjustmentSize: number;
     executionType: AdjustExecutionType;
     limitRatio?: number;
+    referralCode?: string;
 }
 interface AdjustPositionResponseDto {
     orderId: string;
@@ -1034,12 +1019,63 @@ declare function useWatchlist(): {
     readonly toggle: (longAssets: WatchlistAssetDto[], shortAssets: WatchlistAssetDto[]) => Promise<ApiResponse<ToggleWatchlistResponseDto>>;
 };
 
+type PortfolioInterval = '1d' | '1w' | '1m' | '1y' | 'all';
+interface PortfolioBucketDto {
+    periodStart: string;
+    periodEnd: string;
+    volume: number;
+    openInterest: number;
+    winningTradesCount: number;
+    winningTradesUsd: number;
+    losingTradesCount: number;
+    losingTradesUsd: number;
+}
+interface PortfolioOverallDto {
+    totalWinningTradesCount: number;
+    totalLosingTradesCount: number;
+    totalWinningUsd: number;
+    totalLosingUsd: number;
+    currentOpenInterest: number;
+    currentTotalVolume: number;
+    unrealizedPnl: number;
+    totalTrades: number;
+}
+interface PortfolioIntervalsDto {
+    oneDay: PortfolioBucketDto[];
+    oneWeek: PortfolioBucketDto[];
+    oneMonth: PortfolioBucketDto[];
+    oneYear: PortfolioBucketDto[];
+    all: PortfolioBucketDto[];
+}
+interface PortfolioResponseDto {
+    intervals: PortfolioIntervalsDto;
+    overall: PortfolioOverallDto;
+}
+/**
+ * Get portfolio summary buckets and overall metrics
+ * Returns bucketed volume, open interest snapshot, win/loss trade counts, and overall metrics filtered to PEAR fills (cloid LIKE 0x50454152%)
+ * Caller should supply an accessToken from localStorage.getItem('accessToken')
+ */
+declare function getPortfolio(baseUrl: string, accessToken: string): Promise<ApiResponse<PortfolioResponseDto>>;
+
+interface UsePortfolioResult {
+    data: PortfolioResponseDto | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Hook to fetch and manage portfolio data
+ * Returns bucketed volume, open interest snapshot, win/loss trade counts,
+ * and overall metrics filtered to PEAR fills (cloid LIKE 0x50454152%)
+ */
+declare function usePortfolio(): UsePortfolioResult;
+
 interface UseHyperliquidWebSocketProps {
     wsUrl: string;
     address: string | null;
 }
 declare const useHyperliquidWebSocket: ({ wsUrl, address }: UseHyperliquidWebSocketProps) => {
-    connectionStatus: ReadyState;
     isConnected: boolean;
     lastError: string | null;
 };
@@ -1049,7 +1085,6 @@ interface UseHyperliquidNativeWebSocketProps {
     tokens?: string[];
 }
 interface UseHyperliquidNativeWebSocketReturn {
-    connectionStatus: ReadyState;
     isConnected: boolean;
     lastError: string | null;
 }
@@ -1215,5 +1250,5 @@ declare function validatePositionSize(usdValue: number, longAssets?: PairAssetIn
 
 declare const useMarketData: any;
 
-export { AccountSummaryCalculator, AuthStatus, ConflictDetector, MINIMUM_ASSET_USD_VALUE, MinimumPositionSizeError, PearHyperliquidProvider, TokenMetadataExtractor, adjustOrder, adjustPosition, calculateMinimumPositionValue, calculateWeightedRatio, cancelOrder, cancelTwap, cancelTwapOrder, closeAllPositions, closePosition, computeBasketCandles, createCandleLookups, createPosition, getCompleteTimestamps, mapCandleIntervalToTradingViewInterval, mapTradingViewIntervalToCandleInterval, markNotificationReadById, markNotificationsRead, toggleWatchlist, updateRiskParameters, useAccountSummary, useActiveBaskets, useAddress, useAgentWallet, useAuth, useAutoSyncFills, useBasketCandles, useFindBasket, useHighlightedBaskets, useHistoricalPriceData, useHistoricalPriceDataStore, useHyperliquidNativeWebSocket, useHyperliquidWebSocket, useMarketData, useMarketDataPayload, useNotifications, useOpenOrders, useOrders, usePearAgentWallet, usePearAuth, usePearHyperliquid, usePerformanceOverlays, usePosition, useTokenSelectionMetadata, useTopGainers, useTopLosers, useTradeHistories, useTwap, useUserSelection, useWatchlist, useWatchlistBaskets, useWebData, validateMinimumAssetSize, validatePositionSize };
-export type { AccountSummaryResponseDto, ActiveAssetGroupItem, ActiveAssetsResponse, AdjustExecutionType, AdjustOrderRequestInput, AdjustOrderResponseDto, AdjustPositionRequestInput, AdjustPositionResponseDto, AgentWalletDto, AgentWalletState, ApiErrorResponse, ApiResponse, AssetCtx, AssetInformationDetail, AssetMarketData, AssetPosition, AutoSyncFillsOptions, AutoSyncFillsState, BalanceSummaryDto, CancelOrderResponseDto, CancelTwapResponseDto, CandleChartData, CandleData, CandleInterval, CandleSnapshotRequest, ClearinghouseState, CloseAllPositionsResponseDto, CloseAllPositionsResultDto, CloseExecutionType, ClosePositionRequestInput, ClosePositionResponseDto, CreatePositionRequestInput, CreatePositionResponseDto, CrossMarginSummaryDto, CumFundingDto, ExecutionType, HLWebSocketResponse, HistoricalRange, LadderConfigInput, MarginSummaryDto, NotificationCategory, NotificationDto, OpenLimitOrderDto, OpenPositionDto, OrderAssetDto, OrderStatus, PairAssetDto, PairAssetInput, PerformanceOverlay, PositionAdjustmentType, PositionAssetDetailDto, PositionAssetSummaryDto, PositionResponseStatus, RealtimeBar, RealtimeBarsCallback, ToggleWatchlistResponseDto, TokenConflict, TokenHistoricalPriceData, TokenMetadata, TokenSelection, TpSlThresholdInput, TpSlThresholdType, TradeHistoryAssetDataDto, TradeHistoryDataDto, TwapChunkStatusDto, TwapMonitoringDto, UniverseAsset, UpdateRiskParametersRequestInput, UpdateRiskParametersResponseDto, UseAgentWalletOptions, UseAuthOptions, UseBasketCandlesReturn, UseHistoricalPriceDataReturn, UseNotificationsResult, UsePerformanceOverlaysReturn, UseTokenSelectionMetadataReturn, UserProfile, UserSelectionState, WatchlistItemDto, WebData2Response, WebSocketAckResponse, WebSocketChannel, WebSocketConnectionState, WebSocketDataMessage, WebSocketMessage, WebSocketSubscribeMessage, WsAllMidsData };
+export { AccountSummaryCalculator, AuthStatus, ConflictDetector, MINIMUM_ASSET_USD_VALUE, MinimumPositionSizeError, PearHyperliquidProvider, TokenMetadataExtractor, adjustOrder, adjustPosition, calculateMinimumPositionValue, calculateWeightedRatio, cancelOrder, cancelTwap, cancelTwapOrder, closeAllPositions, closePosition, computeBasketCandles, createCandleLookups, createPosition, getCompleteTimestamps, getPortfolio, mapCandleIntervalToTradingViewInterval, mapTradingViewIntervalToCandleInterval, markNotificationReadById, markNotificationsRead, toggleWatchlist, updateRiskParameters, useAccountSummary, useActiveBaskets, useAddress, useAgentWallet, useAutoSyncFills, useBasketCandles, useFindBasket, useHighlightedBaskets, useHistoricalPriceData, useHistoricalPriceDataStore, useHyperliquidNativeWebSocket, useHyperliquidWebSocket, useMarketData, useMarketDataPayload, useNotifications, useOpenOrders, useOrders, usePearAgentWallet, usePearAuth, usePearHyperliquid, usePerformanceOverlays, usePortfolio, usePosition, useTokenSelectionMetadata, useTopGainers, useTopLosers, useTradeHistories, useTwap, useUserSelection, useWatchlist, useWatchlistBaskets, useWebData, validateMinimumAssetSize, validatePositionSize };
+export type { AccountSummaryResponseDto, ActiveAssetGroupItem, ActiveAssetsResponse, AdjustExecutionType, AdjustOrderRequestInput, AdjustOrderResponseDto, AdjustPositionRequestInput, AdjustPositionResponseDto, AgentWalletDto, AgentWalletState, ApiErrorResponse, ApiResponse, AssetCtx, AssetInformationDetail, AssetMarketData, AssetPosition, AutoSyncFillsOptions, AutoSyncFillsState, BalanceSummaryDto, CancelOrderResponseDto, CancelTwapResponseDto, CandleChartData, CandleData, CandleInterval, CandleSnapshotRequest, ClearinghouseState, CloseAllPositionsResponseDto, CloseAllPositionsResultDto, CloseExecutionType, ClosePositionRequestInput, ClosePositionResponseDto, CreatePositionRequestInput, CreatePositionResponseDto, CrossMarginSummaryDto, CumFundingDto, ExecutionType, HLWebSocketResponse, HistoricalRange, LadderConfigInput, MarginSummaryDto, NotificationCategory, NotificationDto, OpenLimitOrderDto, OpenPositionDto, OrderAssetDto, OrderStatus, PairAssetDto, PairAssetInput, PerformanceOverlay, PortfolioBucketDto, PortfolioInterval, PortfolioIntervalsDto, PortfolioOverallDto, PortfolioResponseDto, PositionAdjustmentType, PositionAssetDetailDto, PositionAssetSummaryDto, PositionResponseStatus, RealtimeBar, RealtimeBarsCallback, ToggleWatchlistResponseDto, TokenConflict, TokenHistoricalPriceData, TokenMetadata, TokenSelection, TpSlThresholdInput, TpSlThresholdType, TradeHistoryAssetDataDto, TradeHistoryDataDto, TwapChunkStatusDto, TwapMonitoringDto, UniverseAsset, UpdateRiskParametersRequestInput, UpdateRiskParametersResponseDto, UseAgentWalletOptions, UseAuthOptions, UseBasketCandlesReturn, UseHistoricalPriceDataReturn, UseNotificationsResult, UsePerformanceOverlaysReturn, UsePortfolioResult, UseTokenSelectionMetadataReturn, UserProfile, UserSelectionState, WatchlistItemDto, WebData2Response, WebSocketAckResponse, WebSocketChannel, WebSocketConnectionState, WebSocketDataMessage, WebSocketMessage, WebSocketSubscribeMessage, WsAllMidsData };