@rabby-wallet/hyperliquid-sdk 1.1.5 → 1.1.6-beta.1

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, PlaceTPSlMarketOrderParams, PlaceTPSlLimitOrderParams, ClearinghouseState, UpdateTpslByOrderIdParams, LimitOrderParams, Abstraction } from '../types';
+import type { OrderResponse, CancelResponse, ExchangeClientConfig, PlaceOrderParams, MultiOrderParams, CancelOrderParams, ModifyOrderParams, WithdrawParams, SendAssetParams, ApproveBuilderFeeParams, PrepareApproveBuilderFeeResult, SendApproveParams, MarketOrderParams, UpdateLeverageParams, BindTpslByOrderIdParams, UpdateIsolatedMarginParams, TwapOrderParams, TwapCancelParams, TwapOrderResponse, PlaceTPSlMarketOrderParams, PlaceTPSlLimitOrderParams, ClearinghouseState, UpdateTpslByOrderIdParams, LimitOrderParams, Abstraction } from '../types';
 /**
  * Client for executing trades on Hyperliquid (perpetuals only)
  * Only includes essential trading APIs as specified
@@ -156,6 +156,12 @@ export declare class ExchangeClient {
      */
     prepareWithdraw(params: WithdrawParams): PrepareApproveBuilderFeeResult;
     sendWithdraw(params: SendApproveParams): Promise<any>;
+    /**
+     * Send asset between dexes or to HyperEVM via system address
+     * Need use master wallet
+     */
+    prepareSendAsset(params: SendAssetParams): PrepareApproveBuilderFeeResult;
+    sendSendAsset(params: SendApproveParams): Promise<any>;
     /**
      * Place a TWAP order
      * TWAP orders split a large order into smaller slices over time

package/dist/client/exchange-client.js

@@ -956,6 +956,55 @@ class ExchangeClient {
             signature: splitSignature,
         });
     }
+    /**
+     * Send asset between dexes or to HyperEVM via system address
+     * Need use master wallet
+     */
+    prepareSendAsset(params) {
+        const nonce = Date.now();
+        const action = {
+            type: constants_1.ExchangeType.SEND_ASSET,
+            hyperliquidChain: this.isTestnet ? 'Testnet' : 'Mainnet',
+            signatureChainId: this.isTestnet ? '0x66eee' : '0xa4b1',
+            destination: params.destination,
+            sourceDex: params.sourceDex || '',
+            destinationDex: params.destinationDex || '',
+            token: params.token,
+            amount: params.amount,
+            fromSubAccount: params.fromSubAccount || '',
+            nonce,
+        };
+        const { domain, types, primaryType, message } = (0, signer_1.prepareMasterSignData)({
+            action,
+            payloadTypes: [
+                { name: 'hyperliquidChain', type: 'string' },
+                { name: 'destination', type: 'string' },
+                { name: 'sourceDex', type: 'string' },
+                { name: 'destinationDex', type: 'string' },
+                { name: 'token', type: 'string' },
+                { name: 'amount', type: 'string' },
+                { name: 'fromSubAccount', type: 'string' },
+                { name: 'nonce', type: 'uint64' },
+            ],
+            primaryType: 'HyperliquidTransaction:SendAsset',
+            isMainnet: !this.isTestnet,
+        });
+        return {
+            domain,
+            types,
+            primaryType,
+            message,
+            nonce,
+        };
+    }
+    sendSendAsset(params) {
+        const splitSignature = (0, signer_1.splitSig)(params.signature);
+        return this.httpClient.exchange({
+            action: params.action,
+            nonce: params.nonce,
+            signature: splitSignature,
+        });
+    }
     /**
      * Place a TWAP order
      * TWAP orders split a large order into smaller slices over time

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

@@ -1,4 +1,4 @@
-import type { Meta, AssetCtx, ClearinghouseState, CandleSnapshot, AllMids, ExtraAgent, OpenOrder, FeeResponse, UserNonFundingLedgerUpdates, UserHistoricalOrders, ReferralResponse, L2BookSnapshot, UserTwapSliceFill, FundingHistoryItem, UserFunding, WsFill, PerpDexsResponse, UserAbstractionResp, SpotClearinghouseState } from '../types';
+import type { Meta, AssetCtx, ClearinghouseState, CandleSnapshot, AllMids, ExtraAgent, OpenOrder, FeeResponse, UserNonFundingLedgerUpdates, UserHistoricalOrders, ReferralResponse, L2BookSnapshot, UserTwapSliceFill, FundingHistoryItem, UserFunding, WsFill, PerpDexsResponse, UserAbstractionResp, SpotClearinghouseState, PreTransferCheckResp } from '../types';
 export interface InfoClientConfig {
     isTestnet?: boolean;
     timeout?: number;
@@ -20,6 +20,7 @@ export declare class InfoClient {
      */
     getAllMids(dex?: string): Promise<AllMids>;
     getDexAbstraction(address?: string): Promise<boolean>;
+    getPreTransferCheck(user: string, source: string): Promise<PreTransferCheckResp>;
     getUserAbstraction(address?: string): Promise<UserAbstractionResp>;
     initMasterAddress(masterAddress: string): void;
     /**

package/dist/client/info-client.js

@@ -50,6 +50,18 @@ class InfoClient {
             });
         });
     }
+    /*
+    * Pre-transfer check to verify if a user need fee
+    */
+    getPreTransferCheck(user, source) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.httpClient.info({
+                type: constants_1.InfoType.PRE_TRANSFER_CHECK,
+                source,
+                user,
+            });
+        });
+    }
     getUserAbstraction(address) {
         return __awaiter(this, void 0, void 0, function* () {
             const user = address || this.masterAddress;

package/dist/types/constants.d.ts

@@ -20,6 +20,7 @@ export declare enum ExchangeType {
     UPDATE_ISOLATED_MARGIN = "updateIsolatedMargin",
     USD_SEND = "usdSend",
     WITHDRAW = "withdraw3",
+    SEND_ASSET = "sendAsset",
     APPROVE_AGENT = "approveAgent",
     APPROVE_BUILDER_FEE = "approveBuilderFee",
     SUB_ACCOUNT_TRANSFER = "subAccountTransfer",
@@ -59,7 +60,8 @@ export declare enum InfoType {
     EXTRA_AGENTS = "extraAgents",
     USER_DEX_ABSTRACTION = "userDexAbstraction",
     USER_ABSTRACTION = "userAbstraction",
-    REFERRAL = "referral"
+    REFERRAL = "referral",
+    PRE_TRANSFER_CHECK = "preTransferCheck"
 }
 export declare enum OrderType {
     LIMIT = "limit",

package/dist/types/constants.js

@@ -26,6 +26,7 @@ var ExchangeType;
     ExchangeType["UPDATE_ISOLATED_MARGIN"] = "updateIsolatedMargin";
     ExchangeType["USD_SEND"] = "usdSend";
     ExchangeType["WITHDRAW"] = "withdraw3";
+    ExchangeType["SEND_ASSET"] = "sendAsset";
     ExchangeType["APPROVE_AGENT"] = "approveAgent";
     ExchangeType["APPROVE_BUILDER_FEE"] = "approveBuilderFee";
     ExchangeType["SUB_ACCOUNT_TRANSFER"] = "subAccountTransfer";
@@ -68,6 +69,7 @@ var InfoType;
     InfoType["USER_DEX_ABSTRACTION"] = "userDexAbstraction";
     InfoType["USER_ABSTRACTION"] = "userAbstraction";
     InfoType["REFERRAL"] = "referral";
+    InfoType["PRE_TRANSFER_CHECK"] = "preTransferCheck";
 })(InfoType || (exports.InfoType = InfoType = {}));
 // Order types
 var OrderType;

package/dist/types/index.d.ts

@@ -29,6 +29,12 @@ export interface PerpDex {
 }
 /** Raw response of perp dexes API: first element may be null */
 export type PerpDexsResponse = (null | PerpDex)[];
+export interface PreTransferCheckResp {
+    fee: string;
+    isSanctioned: boolean;
+    userExists: boolean;
+    userHasSentTx: boolean;
+}
 export interface UserHistoricalOrders {
     order: {
         coin: string;
@@ -578,6 +584,14 @@ export interface WithdrawParams {
     destination: string;
     amount: string;
 }
+export interface SendAssetParams {
+    destination: string;
+    amount: string;
+    token: string;
+    sourceDex?: string;
+    destinationDex?: string;
+    fromSubAccount?: string;
+}
 export interface DepositParams {
     amount: string;
 }

package/package.json

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