@rabby-wallet/hyperliquid-sdk 1.1.2-beta.2 → 1.1.2-beta.4

package/README.md

@@ -1,140 +1,140 @@
-# Hyperliquid Perpetuals SDK
-
-一个简化的 Hyperliquid 永续合约交易 SDK，专为前端应用设计。
-
-## 特性
-
-- ✅ 仅核心API：最重要的交易与查询能力
-- ✅ 永续合约专用：不包含现货功能
-- ✅ TypeScript：完善的类型定义
-- ✅ WebSocket：实时数据订阅
-- ✅ 前端友好：基于 fetch API 的轻量实现
-
-## 安装
-
-```bash
-yarn add @debank/hyperliquid-perp-sdk
-# or
-npm i @debank/hyperliquid-perp-sdk
-```
-
-## 快速开始
-
-### 仅查询（无需私钥）
-```ts
-import { HyperliquidSDK } from '@debank/hyperliquid-perp-sdk';
-
-const sdk = new HyperliquidSDK({
-  masterAddress: '0xYourEOA',
-  isTestnet: true,
-});
-
-// 获取所有中间价
-const prices = await sdk.info.getAllMids();
-
-// 获取市场元数据与资产上下文 
-const canUseCache = true; //默认使用缓存，多次请求并发去重 ，需要刷新传false
-const [meta, assetCtxs] = await sdk.info.metaAndAssetCtxs(canUseCache);
-
-
-// 获取账户综合状态
-const account = await sdk.info.getClearingHouseState();
-```
-
-### 交易（需要提供代理私钥、公钥、名称）
-```ts
-const sdk = new HyperliquidSDK({
-  masterAddress: '0xYourEOA',
-  agentPrivateKey: '0xYourAgentPrivKey',
-  agentPublicKey: '0xYourAgentPubKey',
-  agentName: 'MyAgent',
-  isTestnet: true,
-});
-
-// 限价下单
-await sdk.exchange!.placeOrder({
-  coin: 'BTC',
-  isBuy: true,
-  sz: '0.1',
-  limitPx: '45000',
-  orderType: { limit: { tif: 'Gtc' } },
-});
-
-// 批量下单
-await sdk.exchange!.multiOrder({
-  orders: [
-    { coin: 'ETH', isBuy: true,  sz: '1',   limitPx: '3000', orderType: { limit: { tif: 'Ioc' } } },
-    { coin: 'SOL', isBuy: false, sz: '10',  limitPx: '150',  orderType: { limit: { tif: 'Ioc' } } },
-  ],
-});
-
-// 市价开仓（带可选的 TP/SL 触发单）
-await sdk.exchange!.marketOrderOpen({
-  coin: 'BTC',
-  isBuy: true,
-  size: '0.05',
-  midPx: '45200',
-  tpTriggerPx: '47000',
-  slTriggerPx: '44000',
-  // slippage 默认 0.08
-});
-
-// 市价平仓
-await sdk.exchange!.marketOrderClose({
-  coin: 'BTC',
-  isBuy: false,
-  size: '0.05',
-  midPx: '45000',
-});
-
-// 绑定 TP/SL 到已有持仓（按位置绑定）
-await sdk.exchange!.bindTpslByOrderId({
-  coin: 'BTC',
-  isBuy: true, // 持仓方向
-  tpTriggerPx: '47000',
-  slTriggerPx: '44000',
-});
-
-// 更新杠杆
-await sdk.exchange!.updateLeverage({
-  coin: 'BTC',
-  leverage: 5,
-  isCross: true,
-});
-
-// 撤单（可批量）
-await sdk.exchange!.cancelOrder([
-  { coin: 'BTC', oid: 12345 },
-  { coin: 'ETH', oid: 67890 },
-]);
-```
-
-### 授权持久化代理（主钱包签名）
-```ts
-// 准备主钱包签名的 EIP-712 数据（Approve Agent）
-const approve = sdk.exchange!.prepareApproveAgent();
-// 业务方使用主钱包签名（示例）
-const signature = await mainWallet.signTypedData(approve.domain, approve.types, approve.message);
-// 发送请求
-await sdk.exchange!.sendApproveAgent({ action: approve.message, nonce: approve.nonce, signature });
-
-// 准备并签名 Builder 费用
-const builderFee = sdk.exchange!.prepareApproveBuilderFee({ builder: '0xBuilder', maxFee: '0.1%' });
-const sig2 = await mainWallet.signTypedData(builderFee.domain, builderFee.types, builderFee.message);
-await sdk.exchange!.sendApproveBuilderFee({ action: builderFee.message, nonce: builderFee.nonce, signature: sig2 });
-```
-
-### WebSocket 实时数据
-```ts
-await sdk.connectWebSocket();
-
-// 订阅价格
-sdk.ws.subscribeToAllMids((prices) => {
-  console.log('价格更新:', prices);
-});
-
-// 订阅用户综合数据
-sdk.ws.subscribeToWebData2('0xYourEOA', (webData2) => {
-  console.log('用户数据:', webData2);
-});
+# Hyperliquid Perpetuals SDK
+
+一个简化的 Hyperliquid 永续合约交易 SDK，专为前端应用设计。
+
+## 特性
+
+- ✅ 仅核心API：最重要的交易与查询能力
+- ✅ 永续合约专用：不包含现货功能
+- ✅ TypeScript：完善的类型定义
+- ✅ WebSocket：实时数据订阅
+- ✅ 前端友好：基于 fetch API 的轻量实现
+
+## 安装
+
+```bash
+yarn add @debank/hyperliquid-perp-sdk
+# or
+npm i @debank/hyperliquid-perp-sdk
+```
+
+## 快速开始
+
+### 仅查询（无需私钥）
+```ts
+import { HyperliquidSDK } from '@debank/hyperliquid-perp-sdk';
+
+const sdk = new HyperliquidSDK({
+  masterAddress: '0xYourEOA',
+  isTestnet: true,
+});
+
+// 获取所有中间价
+const prices = await sdk.info.getAllMids();
+
+// 获取市场元数据与资产上下文 
+const canUseCache = true; //默认使用缓存，多次请求并发去重 ，需要刷新传false
+const [meta, assetCtxs] = await sdk.info.metaAndAssetCtxs(canUseCache);
+
+
+// 获取账户综合状态
+const account = await sdk.info.getClearingHouseState();
+```
+
+### 交易（需要提供代理私钥、公钥、名称）
+```ts
+const sdk = new HyperliquidSDK({
+  masterAddress: '0xYourEOA',
+  agentPrivateKey: '0xYourAgentPrivKey',
+  agentPublicKey: '0xYourAgentPubKey',
+  agentName: 'MyAgent',
+  isTestnet: true,
+});
+
+// 限价下单
+await sdk.exchange!.placeOrder({
+  coin: 'BTC',
+  isBuy: true,
+  sz: '0.1',
+  limitPx: '45000',
+  orderType: { limit: { tif: 'Gtc' } },
+});
+
+// 批量下单
+await sdk.exchange!.multiOrder({
+  orders: [
+    { coin: 'ETH', isBuy: true,  sz: '1',   limitPx: '3000', orderType: { limit: { tif: 'Ioc' } } },
+    { coin: 'SOL', isBuy: false, sz: '10',  limitPx: '150',  orderType: { limit: { tif: 'Ioc' } } },
+  ],
+});
+
+// 市价开仓（带可选的 TP/SL 触发单）
+await sdk.exchange!.marketOrderOpen({
+  coin: 'BTC',
+  isBuy: true,
+  size: '0.05',
+  midPx: '45200',
+  tpTriggerPx: '47000',
+  slTriggerPx: '44000',
+  // slippage 默认 0.08
+});
+
+// 市价平仓
+await sdk.exchange!.marketOrderClose({
+  coin: 'BTC',
+  isBuy: false,
+  size: '0.05',
+  midPx: '45000',
+});
+
+// 绑定 TP/SL 到已有持仓（按位置绑定）
+await sdk.exchange!.bindTpslByOrderId({
+  coin: 'BTC',
+  isBuy: true, // 持仓方向
+  tpTriggerPx: '47000',
+  slTriggerPx: '44000',
+});
+
+// 更新杠杆
+await sdk.exchange!.updateLeverage({
+  coin: 'BTC',
+  leverage: 5,
+  isCross: true,
+});
+
+// 撤单（可批量）
+await sdk.exchange!.cancelOrder([
+  { coin: 'BTC', oid: 12345 },
+  { coin: 'ETH', oid: 67890 },
+]);
+```
+
+### 授权持久化代理（主钱包签名）
+```ts
+// 准备主钱包签名的 EIP-712 数据（Approve Agent）
+const approve = sdk.exchange!.prepareApproveAgent();
+// 业务方使用主钱包签名（示例）
+const signature = await mainWallet.signTypedData(approve.domain, approve.types, approve.message);
+// 发送请求
+await sdk.exchange!.sendApproveAgent({ action: approve.message, nonce: approve.nonce, signature });
+
+// 准备并签名 Builder 费用
+const builderFee = sdk.exchange!.prepareApproveBuilderFee({ builder: '0xBuilder', maxFee: '0.1%' });
+const sig2 = await mainWallet.signTypedData(builderFee.domain, builderFee.types, builderFee.message);
+await sdk.exchange!.sendApproveBuilderFee({ action: builderFee.message, nonce: builderFee.nonce, signature: sig2 });
+```
+
+### WebSocket 实时数据
+```ts
+await sdk.connectWebSocket();
+
+// 订阅价格
+sdk.ws.subscribeToAllMids((prices) => {
+  console.log('价格更新:', prices);
+});
+
+// 订阅用户综合数据
+sdk.ws.subscribeToWebData2('0xYourEOA', (webData2) => {
+  console.log('用户数据:', webData2);
+});
 ```

package/dist/client/exchange-client.d.ts

@@ -1,5 +1,5 @@
 import { ExchangeType } from '../types/constants';
-import type { OrderResponse, CancelResponse, ExchangeClientConfig, PlaceOrderParams, MultiOrderParams, CancelOrderParams, ModifyOrderParams, WithdrawParams, ApproveBuilderFeeParams, PrepareApproveBuilderFeeResult, SendApproveParams, MarketOrderParams, UpdateLeverageParams, BindTpslByOrderIdParams, UpdateIsolatedMarginParams, TwapOrderParams, TwapCancelParams, TwapOrderResponse } from '../types';
+import type { OrderResponse, CancelResponse, ExchangeClientConfig, PlaceOrderParams, MultiOrderParams, CancelOrderParams, ModifyOrderParams, WithdrawParams, ApproveBuilderFeeParams, PrepareApproveBuilderFeeResult, SendApproveParams, MarketOrderParams, UpdateLeverageParams, BindTpslByOrderIdParams, UpdateIsolatedMarginParams, TwapOrderParams, TwapCancelParams, TwapOrderResponse, PlaceTPSlMarketOrderParams, PlaceTPSlLimitOrderParams } from '../types';
 /**
  * Client for executing trades on Hyperliquid (perpetuals only)
  * Only includes essential trading APIs as specified
@@ -59,6 +59,16 @@ export declare class ExchangeClient {
      */
     marketOrderOpen(params: MarketOrderParams): Promise<OrderResponse>;
     marketOrderClose(params: Omit<MarketOrderParams, 'tpTriggerPx' | 'slTriggerPx'>): Promise<OrderResponse>;
+    /**
+     * Place a take profit or stop loss market order
+     * default slippage is 0.08
+     */
+    placeTPSlMarketOrder(params: PlaceTPSlMarketOrderParams): Promise<OrderResponse>;
+    /**
+ * Place a take profit or stop loss limit order
+ * default slippage is 0.08
+ */
+    placeTPSlLimitOrder(params: PlaceTPSlLimitOrderParams): Promise<OrderResponse>;
     /**
      * Place multiple orders at once
      */

package/dist/client/exchange-client.js

@@ -230,7 +230,7 @@ class ExchangeClient {
                         isBuy: params.isBuy,
                         sz: (0, number_1.removeTrailingZeros)(params.size),
                         limitPx: px,
-                        reduceOnly: false,
+                        reduceOnly: params.reduceOnly || false,
                         orderType: { limit: { tif: 'Ioc' } },
                     }];
                 if (params.tpTriggerPx) {
@@ -303,6 +303,73 @@ class ExchangeClient {
             }
         });
     }
+    /**
+     * Place a take profit or stop loss market order
+     * default slippage is 0.08
+     */
+    placeTPSlMarketOrder(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const slippage = params.slippage || constants_1.SLIPPAGE;
+                const szDecimals = yield this.symbolConversion.getAssetSzDecimals(params.coin);
+                const px = this.getSlippagePx((0, number_1.removeTrailingZeros)(params.triggerPx), slippage, params.isBuy, szDecimals);
+                const orders = [{
+                        coin: params.coin,
+                        isBuy: params.isBuy,
+                        sz: (0, number_1.removeTrailingZeros)(params.size),
+                        limitPx: px,
+                        reduceOnly: params.reduceOnly || false,
+                        orderType: {
+                            trigger: {
+                                isMarket: true,
+                                triggerPx: (0, number_1.removeTrailingZeros)(params.triggerPx),
+                                tpsl: params.tpsl,
+                            },
+                        },
+                    }];
+                const res = yield this.multiOrder({
+                    orders,
+                    builder: params.builder,
+                });
+                return res;
+            }
+            catch (error) {
+                throw error;
+            }
+        });
+    }
+    /**
+ * Place a take profit or stop loss limit order
+ * default slippage is 0.08
+ */
+    placeTPSlLimitOrder(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const orders = [{
+                        coin: params.coin,
+                        isBuy: params.isBuy,
+                        sz: (0, number_1.removeTrailingZeros)(params.size),
+                        limitPx: (0, number_1.removeTrailingZeros)(params.limitPx),
+                        reduceOnly: params.reduceOnly || false,
+                        orderType: {
+                            trigger: {
+                                isMarket: false,
+                                triggerPx: (0, number_1.removeTrailingZeros)(params.triggerPx),
+                                tpsl: params.tpsl,
+                            },
+                        },
+                    }];
+                const res = yield this.multiOrder({
+                    orders,
+                    builder: params.builder,
+                });
+                return res;
+            }
+            catch (error) {
+                throw error;
+            }
+        });
+    }
     /**
      * Place multiple orders at once
      */

package/dist/types/index.d.ts

@@ -46,6 +46,7 @@ export interface OpenOrder {
     orderType: 'Take Profit Market' | 'Stop Market';
     origSz: '0.0';
     tif: null;
+    children?: OpenOrder[];
 }
 export interface OrderRequest {
     asset: AssetId;
@@ -201,6 +202,7 @@ export interface MarketOrderParams {
     isBuy: boolean;
     size: string;
     midPx: string;
+    reduceOnly?: boolean;
     tpTriggerPx?: string;
     slTriggerPx?: string;
     slippage?: number;
@@ -314,6 +316,32 @@ export interface WsActiveAssetData {
     maxTradeSzs: [string, string];
     user: string;
 }
+export interface PlaceTPSlMarketOrderParams {
+    coin: string;
+    isBuy: boolean;
+    size: string;
+    triggerPx: string;
+    tpsl: 'tp' | 'sl';
+    slippage?: number;
+    reduceOnly?: boolean;
+    builder?: {
+        address: string;
+        fee: number;
+    };
+}
+export interface PlaceTPSlLimitOrderParams {
+    coin: string;
+    isBuy: boolean;
+    size: string;
+    triggerPx: string;
+    limitPx: string;
+    tpsl: 'tp' | 'sl';
+    reduceOnly?: boolean;
+    builder?: {
+        address: string;
+        fee: number;
+    };
+}
 export interface WsTrade {
     coin: string;
     hash: string;
@@ -583,12 +611,17 @@ export interface FundingHistoryItem {
     premium: string;
     time: number;
 }
-export interface UserFunding {
-    time: number;
+export interface UserFundingDelta {
     coin: string;
-    usdc: string;
-    szi: string;
     fundingRate: string;
+    szi: string;
+    type: 'funding';
+    usdc: string;
+}
+export interface UserFunding {
+    delta: UserFundingDelta;
+    hash: string;
+    time: number;
 }
 export interface Notification {
     notification: string;

package/dist/types/index.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-;

package/package.json

@@ -1,38 +1,37 @@
-{
-  "name": "@rabby-wallet/hyperliquid-sdk",
-  "version": "1.1.2-beta.2",
-  "description": "Simplified Hyperliquid Perpetuals Trading SDK for Frontend Applications",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "publishConfig": {
-
-    "access": "public"
-  },
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "preversion": "npm run build",
-    "prepublishOnly": "npm run build"
-  },
-  "author": "",
-  "license": "UNLICENSED",
-  "dependencies": {
-    "@ethereumjs/util": "9.0.0",
-    "@metamask/eth-sig-util": "5.1.0",
-    "@msgpack/msgpack": "3.1.2",
-    "@noble/hashes": "1.8.0",
-    "ethereum-cryptography": "2.2.1"
-  },
-  "devDependencies": {
-    "@types/node": "24.3.1",
-    "prettier": "2.7.1",
-    "rimraf": "6.0.0",
-    "typescript": "5.9.2"
-  },
-  "engines": {
-    "node": ">=16.0.0"
-  },
-  "packageManager": "yarn@1.22.22"
-}
+{
+  "name": "@rabby-wallet/hyperliquid-sdk",
+  "version": "1.1.2-beta.4",
+  "description": "Simplified Hyperliquid Perpetuals Trading SDK for Frontend Applications",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "preversion": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "author": "",
+  "license": "UNLICENSED",
+  "dependencies": {
+    "@ethereumjs/util": "9.0.0",
+    "@metamask/eth-sig-util": "5.1.0",
+    "@msgpack/msgpack": "3.1.2",
+    "@noble/hashes": "1.8.0",
+    "ethereum-cryptography": "2.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "24.3.1",
+    "prettier": "2.7.1",
+    "rimraf": "6.0.0",
+    "typescript": "5.9.2"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "packageManager": "yarn@1.22.22"
+}