@pear-protocol/hyperliquid-sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,536 @@
+import React, { ReactNode } from 'react';
+
+/**
+ * Raw value data for trade history positions
+ */
+interface RawValueDto {
+    coin: string;
+    size: string;
+    leverage: number;
+    openPx: string;
+    closePx: string;
+    marginUsed: string;
+    positionValue: string;
+}
+/**
+ * Trade history data structure from V1 API
+ */
+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
+ */
+interface SyncTradeHistoryDto {
+    address: string;
+    data: TradeHistoryV1Dto[];
+}
+/**
+ * Response from sync trade history endpoint
+ */
+interface SyncTradeHistoryResponseDto {
+    success: boolean;
+    positionId: string;
+    tradeHistoryId: string;
+    message: string;
+}
+/**
+ * Base API error response
+ */
+interface ApiErrorResponse {
+    statusCode: number;
+    message: string;
+    error?: string;
+}
+/**
+ * Configuration options for the SDK
+ */
+interface PearHyperliquidConfig {
+    baseUrl: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+/**
+ * HTTP client response wrapper
+ */
+interface ApiResponse<T> {
+    data: T;
+    status: number;
+    headers: Record<string, string>;
+}
+/**
+ * Hook state interface for migration operations
+ */
+interface MigrationHookState<T> {
+    loading: boolean;
+    error: ApiErrorResponse | null;
+    data: T | null;
+}
+/**
+ * PnL data structure for open positions
+ */
+interface PnlDto {
+    value: number;
+    percentage: number;
+}
+/**
+ * Take profit and stop loss data structure
+ */
+interface TpSlDto {
+    takeProfit?: number;
+    stopLoss?: number;
+}
+/**
+ * Position side data structure for open positions
+ */
+interface PositionSideDto {
+    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
+ */
+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
+ */
+interface SyncOpenPositionDto {
+    address: string;
+    data: OpenPositionV1Dto[];
+}
+/**
+ * Response from sync open positions endpoint
+ */
+interface SyncOpenPositionResponseDto {
+    success: boolean;
+    positionIds: string[];
+    count: number;
+    message: string;
+}
+/**
+ * Open order data structure from V1 API
+ */
+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
+ */
+interface SyncOpenOrderDto {
+    address: string;
+    data: OpenOrderV1Dto[];
+}
+/**
+ * Response from sync open orders endpoint
+ */
+interface SyncOpenOrderResponseDto {
+    success: boolean;
+    orderIds: string[];
+    count: number;
+    message: string;
+}
+/**
+ * Migration hooks interface
+ */
+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;
+    };
+}
+/**
+ * WebSocket connection states
+ */
+type WebSocketConnectionState = 'connecting' | 'connected' | 'disconnected' | 'error';
+/**
+ * WebSocket channels
+ */
+type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary';
+/**
+ * WebSocket subscription message
+ */
+interface WebSocketSubscribeMessage {
+    action?: 'subscribe' | 'unsubscribe';
+    address: string;
+}
+/**
+ * WebSocket response message
+ */
+interface WebSocketResponse {
+    success?: boolean;
+    message?: string;
+    error?: string;
+}
+/**
+ * WebSocket data message
+ */
+interface WebSocketDataMessage<T = unknown> {
+    channel: WebSocketChannel;
+    data: T;
+}
+/**
+ * Trade history asset data
+ */
+interface TradeHistoryAssetDataDto {
+    coin: string;
+    entryPrice: number;
+    limitPrice: number;
+    size: number;
+    externalFeePaid: number;
+    builderFeePaid: number;
+    realizedPnl: number;
+}
+/**
+ * Trade history data structure
+ */
+interface TradeHistoryDataDto {
+    tradeHistoryId: string;
+    positionId: string;
+    address: string;
+    externalFeePaid: number;
+    builderFeePaid: number;
+    realizedPnl: number;
+    totalValue: number;
+    entryRatio: number;
+    exitRatio: number;
+    leverage: number;
+    longAssets: TradeHistoryAssetDataDto[];
+    shortAssets: TradeHistoryAssetDataDto[];
+    createdAt: string;
+}
+/**
+ * Paginated trade history response
+ */
+interface PaginatedTradeHistoryResponseDto {
+    data: TradeHistoryDataDto[];
+    hasMore: boolean;
+    nextCursor?: string;
+    count: number;
+}
+/**
+ * Cumulative funding information
+ */
+interface CumFundingDto {
+    allTime: number;
+    sinceChange: number;
+    sinceOpen: number;
+}
+/**
+ * Position asset detail
+ */
+interface PositionAssetDetailDto {
+    coin: string;
+    entryPrice: number;
+    platformSize: number;
+    actualSize: number;
+    cumFunding: CumFundingDto;
+    marginUsed: number;
+    positionValue: number;
+    unrealizedPnl: number;
+    liquidationPrice: number;
+    isExternallyModified: boolean;
+}
+/**
+ * Position sync status
+ */
+type PositionSyncStatus = 'SYNCED' | 'EXTERNALLY_MODIFIED' | 'EXTERNALLY_CLOSED' | 'PAIR_BROKEN';
+/**
+ * Open position data structure
+ */
+interface OpenPositionDto {
+    positionId: string;
+    address: string;
+    leverage: number;
+    stopLoss: number | null;
+    takeProfit: number | null;
+    entryRatio: number;
+    markRatio: number;
+    netFunding: number;
+    positionValue: number;
+    marginUsed: number;
+    unrealizedPnl: number;
+    longAssets: PositionAssetDetailDto[];
+    shortAssets: PositionAssetDetailDto[];
+    syncStatus: PositionSyncStatus;
+    lastSyncAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Order asset data
+ */
+interface OrderAssetDto {
+    asset: string;
+    weight: number;
+}
+/**
+ * Order status
+ */
+type OrderStatus = 'OPEN' | 'PARTIALLY_FILLED' | 'PROCESSING';
+/**
+ * Open limit order data structure
+ */
+interface OpenLimitOrderDto {
+    orderId: string;
+    address: string;
+    leverage: number;
+    usdValue: number;
+    limitRatio: number;
+    stopLoss: number | null;
+    takeProfit: number | null;
+    status: OrderStatus;
+    longAssets: OrderAssetDto[];
+    shortAssets: OrderAssetDto[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Cross margin summary
+ */
+interface CrossMarginSummaryDto {
+    accountValue: string;
+    totalMarginUsed: string;
+    totalNtlPos: string;
+    totalRawUsd: string;
+}
+/**
+ * Margin summary
+ */
+interface MarginSummaryDto {
+    accountValue: string;
+    totalMarginUsed: string;
+    totalNtlPos: string;
+    totalRawUsd: string;
+}
+/**
+ * Balance summary
+ */
+interface BalanceSummaryDto {
+    crossMaintenanceMarginUsed: string;
+    crossMarginSummary: CrossMarginSummaryDto;
+    marginSummary: MarginSummaryDto;
+    time: number;
+    withdrawable: string;
+}
+/**
+ * Agent wallet information
+ */
+interface AgentWalletDto {
+    address: string;
+    status: string;
+}
+/**
+ * Account balance response (renamed to AccountSummaryResponseDto for consistency)
+ */
+interface AccountSummaryResponseDto {
+    balanceSummary: BalanceSummaryDto;
+    agentWallet: AgentWalletDto;
+}
+
+/**
+ * Main SDK client for Pear Protocol Hyperliquid API integration
+ */
+declare class PearHyperliquidClient {
+    private httpClient;
+    private baseUrl;
+    constructor(config: PearHyperliquidConfig);
+    /**
+     * Get the configured base URL
+     */
+    getBaseUrl(): string;
+    /**
+     * Update request headers
+     */
+    setHeaders(headers: Record<string, string>): void;
+    /**
+     * Set authorization header
+     */
+    setAuthToken(token: string): void;
+    /**
+     * Make a generic HTTP request
+     */
+    private makeRequest;
+    /**
+     * Sync trade history data from old database structure to new database format
+     * @param payload - Trade history data with user address
+     * @returns Promise with sync result
+     */
+    syncTradeHistory(payload: SyncTradeHistoryDto): Promise<ApiResponse<SyncTradeHistoryResponseDto>>;
+    /**
+     * Sync open positions data from old database structure to new database format
+     * @param payload - Open positions data with user address
+     * @returns Promise with sync result
+     */
+    syncOpenPositions(payload: SyncOpenPositionDto): Promise<ApiResponse<SyncOpenPositionResponseDto>>;
+    /**
+     * Sync open orders data from old database structure to new database format
+     * @param payload - Open orders data with user address
+     * @returns Promise with sync result
+     */
+    syncOpenOrders(payload: SyncOpenOrderDto): Promise<ApiResponse<SyncOpenOrderResponseDto>>;
+}
+
+/**
+ * Main Migration SDK Class - Simple request/response pattern
+ */
+declare class PearMigrationSDK {
+    private client;
+    private isSyncRunning;
+    constructor(client: PearHyperliquidClient);
+    /**
+     * Sync trade history data - can only run one at a time
+     * If called while already running, returns immediately without making request
+     */
+    syncTradeHistory(payload: SyncTradeHistoryDto): Promise<ApiResponse<SyncTradeHistoryResponseDto> | null>;
+    /**
+     * Sync open positions data - can only run one at a time
+     * If called while already running, returns immediately without making request
+     */
+    syncOpenPositions(payload: SyncOpenPositionDto): Promise<ApiResponse<SyncOpenPositionResponseDto> | null>;
+    /**
+     * Sync open orders data - can only run one at a time
+     * If called while already running, returns immediately without making request
+     */
+    syncOpenOrders(payload: SyncOpenOrderDto): Promise<ApiResponse<SyncOpenOrderResponseDto> | null>;
+    /**
+     * Check if sync is currently running
+     */
+    isSyncInProgress(): boolean;
+    /**
+     * Get the underlying client instance
+     */
+    getClient(): PearHyperliquidClient;
+    /**
+     * Set authorization token on the client
+     */
+    setAuthToken(token: string): void;
+    /**
+     * Set custom headers on the client
+     */
+    setHeaders(headers: Record<string, string>): void;
+    /**
+     * Get base URL from client
+     */
+    getBaseUrl(): string;
+}
+
+interface PearHyperliquidProviderProps {
+    config: PearHyperliquidConfig;
+    /**
+     * WebSocket server URL
+     * @default 'wss://hl-v2.pearprotocol.io/ws'
+     */
+    wsUrl?: string;
+    children: ReactNode;
+}
+/**
+ * React Provider for PearHyperliquidClient
+ */
+declare const PearHyperliquidProvider: React.FC<PearHyperliquidProviderProps>;
+/**
+ * Hook to use PearHyperliquidClient from context
+ */
+declare const usePearHyperliquidClient: () => PearHyperliquidClient;
+/**
+ * Hook to use migration SDK from context
+ */
+declare const useMigrationSDK: () => PearMigrationSDK;
+
+/**
+ * Hook to manage address (login/logout functionality)
+ */
+declare const useAddress: () => {
+    address: string | null;
+    setAddress: (address: string | null) => void;
+    clearAddress: () => void;
+    isLoggedIn: boolean;
+};
+
+/**
+ * Hook to access trade histories
+ */
+declare const useTradeHistories: () => PaginatedTradeHistoryResponseDto | null;
+/**
+ * Hook to access open positions
+ */
+declare const useOpenPositions: () => OpenPositionDto[] | null;
+/**
+ * Hook to access open orders
+ */
+declare const useOpenOrders: () => OpenLimitOrderDto[] | null;
+/**
+ * Hook to access account summary
+ */
+declare const useAccountSummary: () => AccountSummaryResponseDto | null;
+
+export { PearHyperliquidClient, PearHyperliquidProvider, PearMigrationSDK, PearHyperliquidClient as default, useAccountSummary, useAddress, useMigrationSDK, useOpenOrders, useOpenPositions, usePearHyperliquidClient, useTradeHistories };
+export type { AccountSummaryResponseDto, AgentWalletDto, ApiErrorResponse, ApiResponse, BalanceSummaryDto, CrossMarginSummaryDto, CumFundingDto, MarginSummaryDto, MigrationHookState, MigrationHooks, OpenLimitOrderDto, OpenOrderV1Dto, OpenPositionDto, OpenPositionV1Dto, OrderAssetDto, OrderStatus, PaginatedTradeHistoryResponseDto, PearHyperliquidConfig, PnlDto, PositionAssetDetailDto, PositionSideDto, PositionSyncStatus, RawValueDto, SyncOpenOrderDto, SyncOpenOrderResponseDto, SyncOpenPositionDto, SyncOpenPositionResponseDto, SyncTradeHistoryDto, SyncTradeHistoryResponseDto, TpSlDto, TradeHistoryAssetDataDto, TradeHistoryDataDto, TradeHistoryV1Dto, WebSocketChannel, WebSocketConnectionState, WebSocketDataMessage, WebSocketResponse, WebSocketSubscribeMessage };