@rabby-wallet/hyperliquid-sdk 1.0.7 → 1.0.8-beta3

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

@@ -20,13 +20,34 @@ export declare class ExchangeClient {
     get address(): string;
     updateExchangeAgent(agentPrivateKey: string, agentPublicKey: string, agentName?: string): void;
     private getAgentPrivateKey;
+    /**
+     * @deprecated This method is deprecated. Use the new builder configuration in constructor instead.
+     */
     updateBuilder(address: string, fee: number): Promise<any>;
     updateLeverage(params: UpdateLeverageParams): Promise<any>;
     /**
      * Place a single order
      */
     placeOrder(params: PlaceOrderParams): Promise<OrderResponse>;
+    /**
+     * Calculate slippage price for market orders following Hyperliquid price rules
+     * Based on official Python SDK logic
+     *
+     * Rules:
+     * - Round to 5 significant figures
+     * - Round to (6 - szDecimals) decimal places for perps
+     *
+     * @param midPx - Middle price as string
+     * @param slippage - Slippage rate (e.g., 0.08 for 8%)
+     * @param isBuy - True for buy orders, false for sell orders
+     * @param szDecimals - Size decimals from meta endpoint (default 0)
+     * @param isSpot - Whether this is a spot asset (default false for perps)
+     */
     private getSlippagePx;
+    /**
+     * Round a number to specified decimal places
+     */
+    private roundToDecimals;
     /**
      * Place a market order
      * default slippage is 0.08

package/dist/client/exchange-client.js

@@ -103,7 +103,9 @@ class ExchangeClient {
         }
         return this.agentPrivateKey;
     }
-    // 50 = '0.05%'
+    /**
+     * @deprecated This method is deprecated. Use the new builder configuration in constructor instead.
+     */
     updateBuilder(address, fee) {
         return __awaiter(this, void 0, void 0, function* () {
             if (fee < 0 || fee > 100) {
@@ -151,10 +153,10 @@ class ExchangeClient {
                 orders: [orderWire],
                 grouping: 'na',
             };
-            if (this.builder) {
+            if (params.builder) {
                 action.builder = {
-                    b: this.builder.address,
-                    f: this.builder.fee,
+                    b: params.builder.address,
+                    f: params.builder.fee,
                 };
             }
             const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
@@ -165,12 +167,40 @@ class ExchangeClient {
             });
         });
     }
-    getSlippagePx(midPx, slippage, isBuy) {
-        var _a;
-        const decimals = ((_a = midPx.toString().split('.')[1]) === null || _a === void 0 ? void 0 : _a.length) || 0;
-        const prepDecimals = Math.max(0, decimals - 1);
-        const px = isBuy ? (Number(midPx) * (1 + slippage)).toFixed(prepDecimals) : (Number(midPx) * (1 - slippage)).toFixed(prepDecimals);
-        return (0, number_1.removeTrailingZeros)(px);
+    /**
+     * Calculate slippage price for market orders following Hyperliquid price rules
+     * Based on official Python SDK logic
+     *
+     * Rules:
+     * - Round to 5 significant figures
+     * - Round to (6 - szDecimals) decimal places for perps
+     *
+     * @param midPx - Middle price as string
+     * @param slippage - Slippage rate (e.g., 0.08 for 8%)
+     * @param isBuy - True for buy orders, false for sell orders
+     * @param szDecimals - Size decimals from meta endpoint (default 0)
+     * @param isSpot - Whether this is a spot asset (default false for perps)
+     */
+    getSlippagePx(midPx, slippage, isBuy, szDecimals = 0) {
+        let px = parseFloat(midPx);
+        if (isNaN(px) || px <= 0) {
+            throw new Error('Invalid midPx: must be a positive number');
+        }
+        // Calculate slippage price
+        px *= isBuy ? (1 + slippage) : (1 - slippage);
+        // Round to 5 significant figures
+        const sigFigRounded = parseFloat(px.toPrecision(5));
+        // Round to (6 - szDecimals) decimals for perps
+        const maxDecimals = 6 - szDecimals;
+        const decimalRounded = this.roundToDecimals(sigFigRounded, maxDecimals);
+        return (0, number_1.removeTrailingZeros)(decimalRounded.toFixed(maxDecimals));
+    }
+    /**
+     * Round a number to specified decimal places
+     */
+    roundToDecimals(value, decimals) {
+        const multiplier = Math.pow(10, decimals);
+        return Math.round(value * multiplier) / multiplier;
     }
     /**
      * Place a market order
@@ -226,6 +256,7 @@ class ExchangeClient {
                 }
                 const res = yield this.multiOrder({
                     orders,
+                    builder: params.builder,
                 });
                 return res;
             }
@@ -249,6 +280,7 @@ class ExchangeClient {
                     }];
                 const res = yield this.multiOrder({
                     orders,
+                    builder: params.builder,
                 });
                 return res;
             }
@@ -284,10 +316,10 @@ class ExchangeClient {
                 orders: orderWires,
                 grouping: params.grouping || 'na',
             };
-            if (this.builder) {
+            if (params.builder) {
                 action.builder = {
-                    b: this.builder.address,
-                    f: this.builder.fee,
+                    b: params.builder.address,
+                    f: params.builder.fee,
                 };
             }
             const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
@@ -338,7 +370,8 @@ class ExchangeClient {
             }
             return this.multiOrder({
                 orders,
-                grouping: 'positionTpsl'
+                grouping: 'positionTpsl',
+                builder: params.builder,
             });
         });
     }

package/dist/client/symbolConversion.d.ts

@@ -2,6 +2,7 @@ import { HttpClientConfig } from "./http-client";
 import { InfoClient } from "./info-client";
 export declare class SymbolConversion {
     private assetToIndexMap;
+    private assetSzDecimalsMap;
     private httpClient;
     private initialized;
     private infoClient?;
@@ -10,6 +11,7 @@ export declare class SymbolConversion {
     private ensureInitialized;
     private refreshAssetMaps;
     getAssetIndex(assetSymbol: string): Promise<number>;
+    getAssetSzDecimals(assetSymbol: string): Promise<number>;
     getAllAssets(): Promise<{
         perp: string[];
     }>;

package/dist/client/symbolConversion.js

@@ -15,6 +15,7 @@ const http_client_1 = require("./http-client");
 class SymbolConversion {
     constructor(config, infoClient) {
         this.assetToIndexMap = new Map();
+        this.assetSzDecimalsMap = new Map();
         this.initialized = false;
         this.infoClient = infoClient;
         this.httpClient = new http_client_1.HttpClient({
@@ -64,9 +65,11 @@ class SymbolConversion {
                     throw new Error('Invalid perpetual metadata response');
                 }
                 this.assetToIndexMap.clear();
+                this.assetSzDecimalsMap.clear();
                 // Handle perpetual assets
                 perpMeta[0].universe.forEach((asset, index) => {
                     this.assetToIndexMap.set(asset.name, index);
+                    this.assetSzDecimalsMap.set(asset.name, asset.szDecimals);
                 });
             }
             catch (error) {
@@ -84,6 +87,16 @@ class SymbolConversion {
             return index;
         });
     }
+    getAssetSzDecimals(assetSymbol) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.ensureInitialized();
+            const szDecimals = this.assetSzDecimalsMap.get(assetSymbol);
+            if (szDecimals === undefined) {
+                throw new Error(`Unknown asset index: ${assetSymbol}`);
+            }
+            return szDecimals;
+        });
+    }
     getAllAssets() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.ensureInitialized();

package/dist/types/index.d.ts

@@ -194,6 +194,10 @@ export interface MarketOrderParams {
     tpTriggerPx?: string;
     slTriggerPx?: string;
     slippage?: number;
+    builder?: {
+        address: string;
+        fee: number;
+    };
 }
 export interface CancelResponse {
     status: 'ok';
@@ -357,6 +361,10 @@ export interface PlaceOrderParams {
     limitPx: string;
     reduceOnly?: boolean;
     orderType?: any;
+    builder?: {
+        address: string;
+        fee: number;
+    };
 }
 export interface UpdateLeverageParams {
     coin: string;
@@ -368,10 +376,18 @@ export interface BindTpslByOrderIdParams {
     slTriggerPx?: string;
     coin: string;
     isBuy: boolean;
+    builder?: {
+        address: string;
+        fee: number;
+    };
 }
 export interface MultiOrderParams {
     orders: PlaceOrderParams[];
     grouping?: string;
+    builder?: {
+        address: string;
+        fee: number;
+    };
 }
 export interface CancelOrderParams {
     coin: string;

package/package.json

@@ -1,37 +1,37 @@
-{
-  "name": "@rabby-wallet/hyperliquid-sdk",
-  "version": "1.0.7",
-  "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.0.8-beta3",
+  "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"
+}