@pear-protocol/hyperliquid-sdk 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,404 @@
+/**
+ * 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
+ */
+export interface ApiResponse<T> {
+    data: 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;
+}
+/**
+ * Take profit and stop loss data structure
+ */
+export interface TpSlDto {
+    takeProfit?: number;
+    stopLoss?: number;
+}
+/**
+ * Position side data structure for open positions
+ */
+export 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
+ */
+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;
+    };
+}
+/**
+ * WebSocket connection states
+ */
+export type WebSocketConnectionState = 'connecting' | 'connected' | 'disconnected' | 'error';
+/**
+ * WebSocket channels
+ */
+export type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary';
+/**
+ * WebSocket subscription message
+ */
+export interface WebSocketSubscribeMessage {
+    action?: 'subscribe' | 'unsubscribe';
+    address: string;
+}
+/**
+ * WebSocket response message
+ */
+export interface WebSocketResponse {
+    success?: boolean;
+    message?: string;
+    error?: string;
+}
+/**
+ * WebSocket data message
+ */
+export interface WebSocketDataMessage<T = unknown> {
+    channel: WebSocketChannel;
+    data: T;
+}
+/**
+ * Trade history asset data
+ */
+export interface TradeHistoryAssetDataDto {
+    coin: string;
+    entryPrice: number;
+    limitPrice: number;
+    size: number;
+    externalFeePaid: number;
+    builderFeePaid: number;
+    realizedPnl: number;
+}
+/**
+ * Trade history data structure
+ */
+export 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
+ */
+export interface PaginatedTradeHistoryResponseDto {
+    data: TradeHistoryDataDto[];
+    hasMore: boolean;
+    nextCursor?: string;
+    count: number;
+}
+/**
+ * Cumulative funding information
+ */
+export interface CumFundingDto {
+    allTime: number;
+    sinceChange: number;
+    sinceOpen: number;
+}
+/**
+ * Position asset detail
+ */
+export 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
+ */
+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;
+    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
+ */
+export interface OrderAssetDto {
+    asset: string;
+    weight: number;
+}
+/**
+ * Order status
+ */
+export type OrderStatus = 'OPEN' | 'PARTIALLY_FILLED' | 'PROCESSING';
+/**
+ * Open limit order data structure
+ */
+export 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
+ */
+export interface CrossMarginSummaryDto {
+    accountValue: string;
+    totalMarginUsed: string;
+    totalNtlPos: string;
+    totalRawUsd: string;
+}
+/**
+ * Margin summary
+ */
+export interface MarginSummaryDto {
+    accountValue: string;
+    totalMarginUsed: string;
+    totalNtlPos: string;
+    totalRawUsd: string;
+}
+/**
+ * Balance summary
+ */
+export interface BalanceSummaryDto {
+    crossMaintenanceMarginUsed: string;
+    crossMarginSummary: CrossMarginSummaryDto;
+    marginSummary: MarginSummaryDto;
+    time: number;
+    withdrawable: string;
+}
+/**
+ * Agent wallet information
+ */
+export interface AgentWalletDto {
+    address: string;
+    status: string;
+}
+/**
+ * Account balance response (renamed to AccountSummaryResponseDto for consistency)
+ */
+export interface AccountSummaryResponseDto {
+    balanceSummary: BalanceSummaryDto;
+    agentWallet: AgentWalletDto;
+}
+/**
+ * Address management state
+ */
+export interface AddressState {
+    currentAddress: string | null;
+    isLoggedIn: boolean;
+    autoConnect: boolean;
+    previousAddresses: string[];
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@pear-protocol/hyperliquid-sdk",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "React SDK for Pear Protocol Hyperliquid API integration",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "type-check": "tsc --noEmit",
+    "clean": "rimraf dist"
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "react-use-websocket": "^4.8.1"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "@types/react": "^18.0.0",
+    "react": "^18.0.0",
+    "rimraf": "^5.0.0",
+    "rollup": "^3.0.0",
+    "rollup-plugin-dts": "^6.0.0",
+    "tslib": "^2.6.0",
+    "typescript": "^5.0.0"
+  },
+  "keywords": ["pear", "hyperliquid", "sdk", "react", "trading", "api"],
+  "author": "Pear Protocol",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pear-protocol/hyperliquid.git",
+    "directory": "pear-hyperliquid-sdk"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "private": false
+}