@pear-protocol/hyperliquid-sdk 0.0.29 → 0.0.30

package/dist/clients/positions.d.ts

@@ -1,4 +1,5 @@
 import type { ApiResponse } from '../types';
+import type { CancelTwapResponseDto } from './orders';
 export type ExecutionType = 'MARKET' | 'LIMIT' | 'TWAP' | 'LADDER' | 'LIMIT_BTCDOM';
 export type TpSlThresholdType = 'PERCENTAGE' | 'DOLLAR' | 'POSITION_VALUE';
 export interface PairAssetInput {
@@ -9,6 +10,11 @@ export interface TpSlThresholdInput {
     type: TpSlThresholdType;
     value: number;
 }
+export interface LadderConfigInput {
+    ratioStart: number;
+    ratioEnd: number;
+    numberOfLevels: number;
+}
 export interface CreatePositionRequestInput {
     slippage: number;
     executionType: ExecutionType;
@@ -20,6 +26,7 @@ export interface CreatePositionRequestInput {
     direction?: 'MORE_THAN' | 'LESS_THAN';
     twapDuration?: number;
     randomizeExecution?: boolean;
+    ladderConfig?: LadderConfigInput;
     takeProfit?: TpSlThresholdInput | null;
     stopLoss?: TpSlThresholdInput | null;
 }
@@ -87,3 +94,4 @@ export interface AdjustPositionResponseDto {
     executedAt: string;
 }
 export declare function adjustPosition(baseUrl: string, accessToken: string, positionId: string, payload: AdjustPositionRequestInput): Promise<ApiResponse<AdjustPositionResponseDto>>;
+export declare function cancelTwap(baseUrl: string, accessToken: string, orderId: string): Promise<ApiResponse<CancelTwapResponseDto>>;

package/dist/hooks/index.d.ts

@@ -11,3 +11,4 @@ export * from './useAgentWallet';
 export * from './useAutoSyncFills';
 export * from './usePosition';
 export * from './useOrders';
+export * from './useTwap';

package/dist/hooks/useTwap.d.ts

@@ -0,0 +1,6 @@
+import type { ApiResponse } from '../types';
+import type { CancelTwapResponseDto } from '../clients/orders';
+export declare function useTwap(): {
+    readonly orders: any;
+    readonly cancelTwap: (orderId: string) => Promise<ApiResponse<CancelTwapResponseDto>>;
+};

package/dist/index.d.ts

@@ -30,7 +30,7 @@ type WebSocketConnectionState = 'connecting' | 'connected' | 'disconnected' | 'e
 /**
  * WebSocket channels
  */
-type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary' | 'webData2' | 'allMids' | 'activeAssetData';
+type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary' | 'twap-details' | 'webData2' | 'allMids' | 'activeAssetData';
 /**
  * WebSocket subscription message
  */
@@ -755,6 +755,30 @@ interface AutoSyncFillsState {
  */
 declare function useAutoSyncFills(options: AutoSyncFillsOptions): AutoSyncFillsState;
 
+interface AdjustOrderRequestInput {
+    limitRatio?: number;
+    usdValue?: number;
+}
+interface AdjustOrderResponseDto {
+    orderId: string;
+    limitRatio: number;
+    usdValue: number;
+    updatedAt: string;
+}
+declare function adjustOrder(baseUrl: string, accessToken: string, orderId: string, payload: AdjustOrderRequestInput): Promise<ApiResponse<AdjustOrderResponseDto>>;
+interface CancelOrderResponseDto {
+    orderId: string;
+    status: string;
+    cancelledAt: string;
+}
+declare function cancelOrder(baseUrl: string, accessToken: string, orderId: string): Promise<ApiResponse<CancelOrderResponseDto>>;
+interface CancelTwapResponseDto {
+    orderId: string;
+    status: string;
+    cancelledAt: string;
+}
+declare function cancelTwapOrder(baseUrl: string, accessToken: string, orderId: string): Promise<ApiResponse<CancelTwapResponseDto>>;
+
 type ExecutionType = 'MARKET' | 'LIMIT' | 'TWAP' | 'LADDER' | 'LIMIT_BTCDOM';
 type TpSlThresholdType = 'PERCENTAGE' | 'DOLLAR' | 'POSITION_VALUE';
 interface PairAssetInput {
@@ -765,6 +789,11 @@ interface TpSlThresholdInput {
     type: TpSlThresholdType;
     value: number;
 }
+interface LadderConfigInput {
+    ratioStart: number;
+    ratioEnd: number;
+    numberOfLevels: number;
+}
 interface CreatePositionRequestInput {
     slippage: number;
     executionType: ExecutionType;
@@ -776,6 +805,7 @@ interface CreatePositionRequestInput {
     direction?: 'MORE_THAN' | 'LESS_THAN';
     twapDuration?: number;
     randomizeExecution?: boolean;
+    ladderConfig?: LadderConfigInput;
     takeProfit?: TpSlThresholdInput | null;
     stopLoss?: TpSlThresholdInput | null;
 }
@@ -843,6 +873,7 @@ interface AdjustPositionResponseDto {
     executedAt: string;
 }
 declare function adjustPosition(baseUrl: string, accessToken: string, positionId: string, payload: AdjustPositionRequestInput): Promise<ApiResponse<AdjustPositionResponseDto>>;
+declare function cancelTwap(baseUrl: string, accessToken: string, orderId: string): Promise<ApiResponse<CancelTwapResponseDto>>;
 
 declare function usePosition(): {
     readonly createPosition: (payload: CreatePositionRequestInput) => Promise<ApiResponse<CreatePositionResponseDto>>;
@@ -853,30 +884,6 @@ declare function usePosition(): {
     readonly isLoading: boolean;
 };
 
-interface AdjustOrderRequestInput {
-    limitRatio?: number;
-    usdValue?: number;
-}
-interface AdjustOrderResponseDto {
-    orderId: string;
-    limitRatio: number;
-    usdValue: number;
-    updatedAt: string;
-}
-declare function adjustOrder(baseUrl: string, accessToken: string, orderId: string, payload: AdjustOrderRequestInput): Promise<ApiResponse<AdjustOrderResponseDto>>;
-interface CancelOrderResponseDto {
-    orderId: string;
-    status: string;
-    cancelledAt: string;
-}
-declare function cancelOrder(baseUrl: string, accessToken: string, orderId: string): Promise<ApiResponse<CancelOrderResponseDto>>;
-interface CancelTwapResponseDto {
-    orderId: string;
-    status: string;
-    cancelledAt: string;
-}
-declare function cancelTwapOrder(baseUrl: string, accessToken: string, orderId: string): Promise<ApiResponse<CancelTwapResponseDto>>;
-
 declare function useOrders(): {
     readonly adjustOrder: (orderId: string, payload: AdjustOrderRequestInput) => Promise<ApiResponse<AdjustOrderResponseDto>>;
     readonly cancelOrder: (orderId: string) => Promise<ApiResponse<CancelOrderResponseDto>>;
@@ -885,6 +892,11 @@ declare function useOrders(): {
     readonly isLoading: boolean;
 };
 
+declare function useTwap(): {
+    readonly orders: any;
+    readonly cancelTwap: (orderId: string) => Promise<ApiResponse<CancelTwapResponseDto>>;
+};
+
 interface UseHyperliquidWebSocketProps {
     wsUrl: string;
     address: string | null;
@@ -1008,5 +1020,5 @@ declare function mapTradingViewIntervalToCandleInterval(interval: string): Candl
  */
 declare function mapCandleIntervalToTradingViewInterval(interval: CandleInterval): string;
 
-export { AccountSummaryCalculator, AuthStatus, ConflictDetector, PearHyperliquidProvider, TokenMetadataExtractor, adjustOrder, adjustPosition, calculateWeightedRatio, cancelOrder, cancelTwapOrder, closePosition, computeBasketCandles, createCandleLookups, createPosition, getCompleteTimestamps, mapCandleIntervalToTradingViewInterval, mapTradingViewIntervalToCandleInterval, updateRiskParameters, useAccountSummary, useAddress, useAgentWallet, useAuth, useAutoSyncFills, useBasketCandles, useHistoricalPriceData, useHistoricalPriceDataStore, useHyperliquidNativeWebSocket, useHyperliquidWebSocket, useOpenOrders, useOrders, usePearAgentWallet, usePearAuth, usePearHyperliquid, usePerformanceOverlays, usePosition, useTokenSelectionMetadata, useTradeHistories, useUserSelection, useWebData };
-export type { AccountSummaryResponseDto, AdjustExecutionType, AdjustOrderRequestInput, AdjustOrderResponseDto, AdjustPositionRequestInput, AdjustPositionResponseDto, AgentWalletDto, AgentWalletState, ApiErrorResponse, ApiResponse, AssetCtx, AssetInformationDetail, AssetMarketData, AssetPosition, AutoSyncFillsOptions, AutoSyncFillsState, BalanceSummaryDto, CancelOrderResponseDto, CancelTwapResponseDto, CandleChartData, CandleData, CandleInterval, CandleSnapshotRequest, ClearinghouseState, CloseExecutionType, ClosePositionRequestInput, ClosePositionResponseDto, CreatePositionRequestInput, CreatePositionResponseDto, CrossMarginSummaryDto, CumFundingDto, ExecutionType, HLWebSocketResponse, HistoricalRange, MarginSummaryDto, OpenLimitOrderDto, OpenPositionDto, OrderAssetDto, OrderStatus, PairAssetInput, PerformanceOverlay, PositionAdjustmentType, PositionAssetDetailDto, PositionAssetSummaryDto, PositionResponseStatus, RealtimeBar, RealtimeBarsCallback, TokenConflict, TokenHistoricalPriceData, TokenMetadata, TokenSelection, TpSlThresholdInput, TpSlThresholdType, TradeHistoryAssetDataDto, TradeHistoryDataDto, UniverseAsset, UpdateRiskParametersRequestInput, UpdateRiskParametersResponseDto, UseAgentWalletOptions, UseAuthOptions, UseBasketCandlesReturn, UseHistoricalPriceDataReturn, UsePerformanceOverlaysReturn, UseTokenSelectionMetadataReturn, UserProfile, UserSelectionState, WebData2Response, WebSocketAckResponse, WebSocketChannel, WebSocketConnectionState, WebSocketDataMessage, WebSocketMessage, WebSocketSubscribeMessage, WsAllMidsData };
+export { AccountSummaryCalculator, AuthStatus, ConflictDetector, PearHyperliquidProvider, TokenMetadataExtractor, adjustOrder, adjustPosition, calculateWeightedRatio, cancelOrder, cancelTwap, cancelTwapOrder, closePosition, computeBasketCandles, createCandleLookups, createPosition, getCompleteTimestamps, mapCandleIntervalToTradingViewInterval, mapTradingViewIntervalToCandleInterval, updateRiskParameters, useAccountSummary, useAddress, useAgentWallet, useAuth, useAutoSyncFills, useBasketCandles, useHistoricalPriceData, useHistoricalPriceDataStore, useHyperliquidNativeWebSocket, useHyperliquidWebSocket, useOpenOrders, useOrders, usePearAgentWallet, usePearAuth, usePearHyperliquid, usePerformanceOverlays, usePosition, useTokenSelectionMetadata, useTradeHistories, useTwap, useUserSelection, useWebData };
+export type { AccountSummaryResponseDto, AdjustExecutionType, AdjustOrderRequestInput, AdjustOrderResponseDto, AdjustPositionRequestInput, AdjustPositionResponseDto, AgentWalletDto, AgentWalletState, ApiErrorResponse, ApiResponse, AssetCtx, AssetInformationDetail, AssetMarketData, AssetPosition, AutoSyncFillsOptions, AutoSyncFillsState, BalanceSummaryDto, CancelOrderResponseDto, CancelTwapResponseDto, CandleChartData, CandleData, CandleInterval, CandleSnapshotRequest, ClearinghouseState, CloseExecutionType, ClosePositionRequestInput, ClosePositionResponseDto, CreatePositionRequestInput, CreatePositionResponseDto, CrossMarginSummaryDto, CumFundingDto, ExecutionType, HLWebSocketResponse, HistoricalRange, LadderConfigInput, MarginSummaryDto, OpenLimitOrderDto, OpenPositionDto, OrderAssetDto, OrderStatus, PairAssetInput, PerformanceOverlay, PositionAdjustmentType, PositionAssetDetailDto, PositionAssetSummaryDto, PositionResponseStatus, RealtimeBar, RealtimeBarsCallback, TokenConflict, TokenHistoricalPriceData, TokenMetadata, TokenSelection, TpSlThresholdInput, TpSlThresholdType, TradeHistoryAssetDataDto, TradeHistoryDataDto, UniverseAsset, UpdateRiskParametersRequestInput, UpdateRiskParametersResponseDto, UseAgentWalletOptions, UseAuthOptions, UseBasketCandlesReturn, UseHistoricalPriceDataReturn, UsePerformanceOverlaysReturn, UseTokenSelectionMetadataReturn, UserProfile, UserSelectionState, WebData2Response, WebSocketAckResponse, WebSocketChannel, WebSocketConnectionState, WebSocketDataMessage, WebSocketMessage, WebSocketSubscribeMessage, WsAllMidsData };

package/dist/index.js

@@ -2433,20 +2433,23 @@ const useUserData = create((set) => ({
     rawOpenPositions: null,
     openOrders: null,
     accountSummary: null,
+    twapDetails: null,
     setTradeHistories: (value) => set({ tradeHistories: value }),
     setRawOpenPositions: (value) => set({ rawOpenPositions: value }),
     setOpenOrders: (value) => set({ openOrders: value }),
     setAccountSummary: (value) => set({ accountSummary: value }),
+    setTwapDetails: (value) => set({ twapDetails: value }),
     clean: () => set({
         tradeHistories: null,
         rawOpenPositions: null,
         openOrders: null,
         accountSummary: null,
+        twapDetails: null,
     }),
 }));
 
 const useHyperliquidWebSocket = ({ wsUrl, address }) => {
-    const { setTradeHistories, setRawOpenPositions, setOpenOrders, setAccountSummary, clean } = useUserData();
+    const { setTradeHistories, setRawOpenPositions, setOpenOrders, setAccountSummary, setTwapDetails, clean } = useUserData();
     const [lastError, setLastError] = useState(null);
     const [lastSubscribedAddress, setLastSubscribedAddress] = useState(null);
     // WebSocket connection
@@ -2487,6 +2490,10 @@ const useHyperliquidWebSocket = ({ wsUrl, address }) => {
                         case 'account-summary':
                             setAccountSummary(dataMessage.data);
                             break;
+                        case 'twap-details':
+                            // @ts-ignore: setTwapDetails exists in store
+                            setTwapDetails && setTwapDetails(dataMessage.data);
+                            break;
                     }
                 }
             }
@@ -8291,6 +8298,18 @@ async function adjustPosition(baseUrl, accessToken, positionId, payload) {
         throw toApiError(error);
     }
 }
+// ---------------- Cancel TWAP (by orderId) ----------------
+// Convenience API colocated with position operations
+async function cancelTwap(baseUrl, accessToken, orderId) {
+    const url = joinUrl(baseUrl, `/orders/${orderId}/twap/cancel`);
+    try {
+        const resp = await axios$1.post(url, {}, { headers: { 'Content-Type': 'application/json', Authorization: `Bearer ${accessToken}` }, timeout: 60000 });
+        return { data: resp.data, status: resp.status, headers: resp.headers };
+    }
+    catch (error) {
+        throw toApiError(error);
+    }
+}
 
 const calculatePositionAsset = (asset, currentPrice, totalInitialPositionSize, leverage, cumFunding, isLong = true) => {
     const initialPositionValue = asset.entryPrice * asset.size;
@@ -8502,6 +8521,21 @@ function useOrders() {
     return { adjustOrder: adjustOrder$1, cancelOrder: cancelOrder$1, cancelTwapOrder: cancelTwapOrder$1, openOrders: enrichedOpenOrders, isLoading };
 }
 
+function useTwap() {
+    const twapDetails = useUserData(state => state.twapDetails);
+    const context = useContext(PearHyperliquidContext);
+    if (!context)
+        throw new Error('useTwap must be used within a PearHyperliquidProvider');
+    const { apiBaseUrl, accessToken } = context;
+    const orders = useMemo(() => twapDetails !== null && twapDetails !== void 0 ? twapDetails : [], [twapDetails]);
+    const cancelTwap$1 = async (orderId) => {
+        if (!accessToken)
+            throw new Error('Not authenticated');
+        return cancelTwap(apiBaseUrl, accessToken, orderId);
+    };
+    return { orders, cancelTwap: cancelTwap$1 };
+}
+
 const PearHyperliquidContext = createContext(undefined);
 /**
  * React Provider for PearHyperliquidClient
@@ -8800,4 +8834,4 @@ function mapCandleIntervalToTradingViewInterval(interval) {
     }
 }
 
-export { AccountSummaryCalculator, AuthStatus, ConflictDetector, PearHyperliquidProvider, TokenMetadataExtractor, adjustOrder, adjustPosition, calculateWeightedRatio, cancelOrder, cancelTwapOrder, closePosition, computeBasketCandles, createCandleLookups, createPosition, getCompleteTimestamps, mapCandleIntervalToTradingViewInterval, mapTradingViewIntervalToCandleInterval, updateRiskParameters, useAccountSummary, useAddress, useAgentWallet, useAuth, useAutoSyncFills, useBasketCandles, useHistoricalPriceData, useHistoricalPriceDataStore, useHyperliquidNativeWebSocket, useHyperliquidWebSocket, useOpenOrders, useOrders, usePearAgentWallet, usePearAuth, usePearHyperliquid, usePerformanceOverlays, usePosition, useTokenSelectionMetadata, useTradeHistories, useUserSelection, useWebData };
+export { AccountSummaryCalculator, AuthStatus, ConflictDetector, PearHyperliquidProvider, TokenMetadataExtractor, adjustOrder, adjustPosition, calculateWeightedRatio, cancelOrder, cancelTwap, cancelTwapOrder, closePosition, computeBasketCandles, createCandleLookups, createPosition, getCompleteTimestamps, mapCandleIntervalToTradingViewInterval, mapTradingViewIntervalToCandleInterval, updateRiskParameters, useAccountSummary, useAddress, useAgentWallet, useAuth, useAutoSyncFills, useBasketCandles, useHistoricalPriceData, useHistoricalPriceDataStore, useHyperliquidNativeWebSocket, useHyperliquidWebSocket, useOpenOrders, useOrders, usePearAgentWallet, usePearAuth, usePearHyperliquid, usePerformanceOverlays, usePosition, useTokenSelectionMetadata, useTradeHistories, useTwap, useUserSelection, useWebData };

package/dist/types.d.ts

@@ -51,7 +51,7 @@ export type WebSocketConnectionState = 'connecting' | 'connected' | 'disconnecte
 /**
  * WebSocket channels
  */
-export type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary' | 'webData2' | 'allMids' | 'activeAssetData';
+export type WebSocketChannel = 'trade-histories' | 'open-positions' | 'open-orders' | 'account-summary' | 'twap-details' | 'webData2' | 'allMids' | 'activeAssetData';
 /**
  * WebSocket subscription message
  */
@@ -74,6 +74,44 @@ export interface WebSocketDataMessage<T = unknown> {
     channel: WebSocketChannel;
     data: T;
 }
+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;
+    randomizeExecution: boolean;
+    reduceOnly: boolean;
+    chunks: TwapChunkStatusDto[];
+    estimatedCompletionTime?: string;
+    actualCompletionTime?: string;
+    remainingChunks: number;
+    createdAt: string;
+    updatedAt: string;
+}
 /**
  * Trade history asset data
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/hyperliquid-sdk",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "description": "React SDK for Pear Protocol Hyperliquid API integration",
   "type": "module",
   "main": "dist/index.js",