@rabby-wallet/hyperliquid-sdk 1.1.2-beta.15 → 1.1.2-beta.16

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 } from '../types';
+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 } from '../types';
 /**
  * Client for executing trades on Hyperliquid (perpetuals only)
  * Only includes essential trading APIs as specified
@@ -10,11 +10,19 @@ export declare class ExchangeClient {
     private agentPublicKey?;
     private agentName?;
     private readonly isTestnet;
+    slippage: number;
     private masterAddress;
     private builder?;
     private readonly symbolConversion;
     constructor(config: ExchangeClientConfig);
     initAccount(masterAddress: string, agentPrivateKey?: string, agentPublicKey?: string, agentName?: string): void;
+    /**
+     * Set the slippage for the exchange client
+     * default is 0.08
+     * 0 - 0.1
+     * @param slippage - The slippage to set
+     */
+    setSlippage(slippage?: number): void;
     initOrUpdateAgent(agentPrivateKey: string, agentPublicKey: string, agentName?: string): void;
     /**
      * Check if agent is set
@@ -47,7 +55,7 @@ export declare class ExchangeClient {
      * @param isBuy - True for buy orders, false for sell orders
      * @param szDecimals - Size decimals from meta endpoint (default 0)
      */
-    private getSlippagePx;
+    getSlippagePx(midPx: string, slippage: number, isBuy: boolean, szDecimals?: number): string;
     /**
      * Round a number to specified decimal places
      */
@@ -59,6 +67,12 @@ export declare class ExchangeClient {
      */
     marketOrderOpen(params: MarketOrderParams): Promise<OrderResponse>;
     marketOrderClose(params: Omit<MarketOrderParams, 'tpTriggerPx' | 'slTriggerPx'>): Promise<OrderResponse>;
+    /**
+     * Place a market order
+     * default slippage is 0.08
+     * need to update leverage before place order
+     */
+    limitOrderOpen(params: LimitOrderParams): Promise<OrderResponse>;
     closeAllPositions(clearinghouseState: ClearinghouseState, slippage?: number, builder?: {
         address: string;
         fee: number;
@@ -70,7 +84,6 @@ export declare class ExchangeClient {
     placeTPSlMarketOrder(params: PlaceTPSlMarketOrderParams): Promise<OrderResponse>;
     /**
  * Place a take profit or stop loss limit order
- * default slippage is 0.08
  */
     placeTPSlLimitOrder(params: PlaceTPSlLimitOrderParams): Promise<OrderResponse>;
     /**

package/dist/client/exchange-client.js

@@ -55,6 +55,7 @@ const number_1 = require("../utils/number");
  */
 class ExchangeClient {
     constructor(config) {
+        this.slippage = constants_1.SLIPPAGE;
         this.masterAddress = config.masterAddress;
         this.httpClient = new http_client_1.HttpClient({
             isTestnet: config.isTestnet,
@@ -93,6 +94,21 @@ class ExchangeClient {
             this.agentName = undefined;
         }
     }
+    /**
+     * Set the slippage for the exchange client
+     * default is 0.08
+     * 0 - 0.1
+     * @param slippage - The slippage to set
+     */
+    setSlippage(slippage = constants_1.SLIPPAGE) {
+        if (Number.isNaN(slippage)) {
+            throw new Error('Slippage must be a number');
+        }
+        if (slippage < 0 || slippage > 0.1) {
+            throw new Error('Slippage must be between 0 and 0.1');
+        }
+        this.slippage = slippage;
+    }
     initOrUpdateAgent(agentPrivateKey, agentPublicKey, agentName) {
         this.agentPrivateKey = agentPrivateKey.startsWith('0x') ? agentPrivateKey : ethUtil.addHexPrefix(agentPrivateKey);
         this.agentPublicKey = agentPublicKey.startsWith('0x') ? agentPublicKey : ethUtil.addHexPrefix(agentPublicKey);
@@ -222,7 +238,7 @@ class ExchangeClient {
     marketOrderOpen(params) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const slippage = params.slippage || constants_1.SLIPPAGE;
+                const slippage = params.slippage || this.slippage;
                 const szDecimals = yield this.symbolConversion.getAssetSzDecimals(params.coin);
                 const px = this.getSlippagePx((0, number_1.removeTrailingZeros)(params.midPx), slippage, params.isBuy, szDecimals);
                 const orders = [{
@@ -238,7 +254,7 @@ class ExchangeClient {
                         coin: params.coin,
                         isBuy: !params.isBuy,
                         sz: (0, number_1.removeTrailingZeros)(params.size),
-                        limitPx: (0, number_1.removeTrailingZeros)(params.tpTriggerPx),
+                        limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.tpTriggerPx), slippage, !params.isBuy, szDecimals),
                         reduceOnly: true,
                         orderType: {
                             trigger: {
@@ -255,7 +271,7 @@ class ExchangeClient {
                         coin: params.coin,
                         isBuy: !params.isBuy,
                         sz: (0, number_1.removeTrailingZeros)(params.size),
-                        limitPx: (0, number_1.removeTrailingZeros)(params.slTriggerPx),
+                        limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.slTriggerPx), slippage, !params.isBuy, szDecimals),
                         reduceOnly: true,
                         orderType: {
                             trigger: {
@@ -282,7 +298,7 @@ class ExchangeClient {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             try {
-                const slippage = params.slippage || constants_1.SLIPPAGE;
+                const slippage = params.slippage || this.slippage;
                 const szDecimals = yield this.symbolConversion.getAssetSzDecimals(params.coin);
                 const px = this.getSlippagePx(params.midPx, slippage, params.isBuy, szDecimals);
                 const orders = [{
@@ -304,6 +320,70 @@ class ExchangeClient {
             }
         });
     }
+    /**
+     * Place a market order
+     * default slippage is 0.08
+     * need to update leverage before place order
+     */
+    limitOrderOpen(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const slippage = params.slippage || this.slippage;
+                const szDecimals = yield this.symbolConversion.getAssetSzDecimals(params.coin);
+                // const px = this.getSlippagePx(removeTrailingZeros(params.limitPx), slippage, params.isBuy, szDecimals);
+                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: { limit: { tif: 'Gtc' } },
+                    }];
+                if (params.tpTriggerPx) {
+                    const tpOrder = {
+                        coin: params.coin,
+                        isBuy: !params.isBuy,
+                        sz: (0, number_1.removeTrailingZeros)(params.size),
+                        limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.tpTriggerPx), slippage, !params.isBuy, szDecimals),
+                        reduceOnly: true,
+                        orderType: {
+                            trigger: {
+                                isMarket: true,
+                                triggerPx: (0, number_1.removeTrailingZeros)(params.tpTriggerPx),
+                                tpsl: 'tp',
+                            }
+                        }
+                    };
+                    orders.push(tpOrder);
+                }
+                if (params.slTriggerPx) {
+                    const slOrder = {
+                        coin: params.coin,
+                        isBuy: !params.isBuy,
+                        sz: (0, number_1.removeTrailingZeros)(params.size),
+                        limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.slTriggerPx), slippage, !params.isBuy, szDecimals),
+                        reduceOnly: true,
+                        orderType: {
+                            trigger: {
+                                isMarket: true,
+                                triggerPx: (0, number_1.removeTrailingZeros)(params.slTriggerPx),
+                                tpsl: 'sl',
+                            }
+                        }
+                    };
+                    orders.push(slOrder);
+                }
+                const res = yield this.multiOrder({
+                    orders,
+                    builder: params.builder,
+                });
+                return res;
+            }
+            catch (error) {
+                throw error;
+            }
+        });
+    }
     closeAllPositions(clearinghouseState_1) {
         return __awaiter(this, arguments, void 0, function* (clearinghouseState, slippage = constants_1.SLIPPAGE, builder) {
             try {
@@ -344,7 +424,7 @@ class ExchangeClient {
     placeTPSlMarketOrder(params) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const slippage = params.slippage || constants_1.SLIPPAGE;
+                const slippage = params.slippage || this.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 = [{
@@ -374,7 +454,6 @@ class ExchangeClient {
     }
     /**
  * Place a take profit or stop loss limit order
- * default slippage is 0.08
  */
     placeTPSlLimitOrder(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -455,13 +534,14 @@ class ExchangeClient {
     bindTpslByOrderId(params) {
         return __awaiter(this, void 0, void 0, function* () {
             let orders = [];
+            const slippage = params.slippage || this.slippage;
             const szDecimals = yield this.symbolConversion.getAssetSzDecimals(params.coin);
             if (params.tpTriggerPx) {
                 orders.push({
                     coin: params.coin,
                     isBuy: !params.isBuy,
                     sz: '0',
-                    limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.tpTriggerPx), constants_1.SLIPPAGE, !params.isBuy, szDecimals),
+                    limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.tpTriggerPx), slippage, !params.isBuy, szDecimals),
                     reduceOnly: true,
                     orderType: {
                         trigger: {
@@ -477,7 +557,7 @@ class ExchangeClient {
                     coin: params.coin,
                     isBuy: !params.isBuy,
                     sz: '0',
-                    limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.slTriggerPx), constants_1.SLIPPAGE, !params.isBuy, szDecimals),
+                    limitPx: this.getSlippagePx((0, number_1.removeTrailingZeros)(params.slTriggerPx), slippage, !params.isBuy, szDecimals),
                     reduceOnly: true,
                     orderType: {
                         trigger: {
@@ -503,8 +583,9 @@ class ExchangeClient {
             let orders = [];
             const szDecimals = yield this.symbolConversion.getAssetSzDecimals(params.coin);
             const isBuy = !params.isBuy;
+            const slippage = params.slippage || this.slippage;
             if (params.tp) {
-                const limitPx = params.tp.limitPx || this.getSlippagePx((0, number_1.removeTrailingZeros)(params.tp.triggerPx), constants_1.SLIPPAGE, isBuy, szDecimals);
+                const limitPx = params.tp.limitPx || this.getSlippagePx((0, number_1.removeTrailingZeros)(params.tp.triggerPx), slippage, isBuy, szDecimals);
                 orders.push({
                     oid: params.tp.oid,
                     coin: params.coin,
@@ -522,7 +603,7 @@ class ExchangeClient {
                 });
             }
             if (params.sl) {
-                const limitPx = params.sl.limitPx || this.getSlippagePx((0, number_1.removeTrailingZeros)(params.sl.triggerPx), constants_1.SLIPPAGE, isBuy, szDecimals);
+                const limitPx = params.sl.limitPx || this.getSlippagePx((0, number_1.removeTrailingZeros)(params.sl.triggerPx), slippage, isBuy, szDecimals);
                 orders.push({
                     oid: params.sl.oid,
                     coin: params.coin,

package/dist/types/index.d.ts

@@ -209,6 +209,20 @@ export interface OrderResponse {
         };
     };
 }
+export interface LimitOrderParams {
+    coin: string;
+    isBuy: boolean;
+    size: string;
+    limitPx: string;
+    reduceOnly?: boolean;
+    tpTriggerPx?: string;
+    slTriggerPx?: string;
+    slippage?: number;
+    builder?: {
+        address: string;
+        fee: number;
+    };
+}
 export interface MarketOrderParams {
     coin: string;
     isBuy: boolean;
@@ -452,6 +466,7 @@ export interface BindTpslByOrderIdParams {
     slTriggerPx?: string;
     coin: string;
     isBuy: boolean;
+    slippage?: number;
     builder?: {
         address: string;
         fee: number;
@@ -470,6 +485,7 @@ export interface UpdateTpslByOrderIdParams {
     };
     coin: string;
     isBuy: boolean;
+    slippage?: number;
 }
 export interface MultiOrderParams {
     orders: PlaceOrderParams[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rabby-wallet/hyperliquid-sdk",
-  "version": "1.1.2-beta.15",
+  "version": "1.1.2-beta.16",
   "description": "Simplified Hyperliquid Perpetuals Trading SDK for Frontend Applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",