@rabby-wallet/hyperliquid-sdk 1.1.8 → 1.1.9

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, SendAssetParams, ApproveBuilderFeeParams, PrepareApproveBuilderFeeResult, SendApproveParams, MarketOrderParams, UpdateLeverageParams, BindTpslByOrderIdParams, UpdateIsolatedMarginParams, TwapOrderParams, TwapCancelParams, TwapOrderResponse, PlaceTPSlMarketOrderParams, PlaceTPSlLimitOrderParams, ClearinghouseState, UpdateTpslByOrderIdParams, LimitOrderParams, Abstraction, UserSetAbstractionParams, Tif } 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, UserSetAbstractionParams, Tif, ExternalSign } from '../types';
 /**
  * Client for executing trades on Hyperliquid (perpetuals only)
  * Only includes essential trading APIs as specified
@@ -9,6 +9,7 @@ export declare class ExchangeClient {
     private agentPrivateKey?;
     private agentPublicKey?;
     private agentName?;
+    private externalSign?;
     private readonly isTestnet;
     slippage: number;
     private masterAddress;
@@ -24,6 +25,11 @@ export declare class ExchangeClient {
      */
     setSlippage(slippage?: number): void;
     initOrUpdateAgent(agentPrivateKey: string, agentPublicKey: string, agentName?: string): void;
+    /**
+     * Install (or clear with undefined) an external async signer. When present,
+     * L1 actions are signed through it instead of the built-in agent key.
+     */
+    setExternalSign(externalSign?: ExternalSign): void;
     /**
      * Check if agent is set
      */
@@ -33,6 +39,11 @@ export declare class ExchangeClient {
      */
     get address(): string;
     private getAgentPrivateKey;
+    /**
+     * Sign an L1 agent action. Prefers the external signer (async, master-wallet
+     * keyring) when set; otherwise falls back to the built-in agent private key.
+     */
+    private signL1Action;
     /**
      * @deprecated This method is deprecated. Use the new builder configuration in constructor instead.
      */

package/dist/client/exchange-client.js

@@ -79,6 +79,9 @@ class ExchangeClient {
         if (config.agentName) {
             this.agentName = config.agentName;
         }
+        if (config.externalSign) {
+            this.externalSign = config.externalSign;
+        }
         this.isTestnet = config.isTestnet || false;
     }
     initAccount(masterAddress, agentPrivateKey, agentPublicKey, agentName) {
@@ -114,11 +117,18 @@ class ExchangeClient {
         this.agentPublicKey = agentPublicKey.startsWith('0x') ? agentPublicKey : ethUtil.addHexPrefix(agentPublicKey);
         this.agentName = agentName || '';
     }
+    /**
+     * Install (or clear with undefined) an external async signer. When present,
+     * L1 actions are signed through it instead of the built-in agent key.
+     */
+    setExternalSign(externalSign) {
+        this.externalSign = externalSign;
+    }
     /**
      * Check if agent is set
      */
     get isHaveAgent() {
-        return !!this.agentPrivateKey && !!this.agentPublicKey;
+        return (!!this.agentPrivateKey && !!this.agentPublicKey) || !!this.externalSign;
     }
     /**
      * Get the wallet address
@@ -132,6 +142,24 @@ class ExchangeClient {
         }
         return this.agentPrivateKey;
     }
+    /**
+     * Sign an L1 agent action. Prefers the external signer (async, master-wallet
+     * keyring) when set; otherwise falls back to the built-in agent private key.
+     */
+    signL1Action(action, nonce) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.externalSign) {
+                const typedData = (0, signer_1.prepareL1ActionTypedData)({
+                    action: action,
+                    isTestnet: this.isTestnet,
+                    nonce,
+                });
+                const hexSig = yield this.externalSign(typedData);
+                return (0, signer_1.splitSig)(hexSig);
+            }
+            return (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+        });
+    }
     /**
      * @deprecated This method is deprecated. Use the new builder configuration in constructor instead.
      */
@@ -155,7 +183,7 @@ class ExchangeClient {
                 isCross: params.isCross || false,
                 leverage: params.leverage,
             };
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -188,7 +216,7 @@ class ExchangeClient {
                     f: params.builder.fee,
                 };
             }
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -521,7 +549,7 @@ class ExchangeClient {
                     f: params.builder.fee,
                 };
             }
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             const res = yield this.httpClient.exchange({
                 action,
                 nonce,
@@ -647,7 +675,7 @@ class ExchangeClient {
                 type: constants_1.ExchangeType.CANCEL,
                 cancels: cancels,
             };
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -673,7 +701,7 @@ class ExchangeClient {
                     t: params.orderType || { limit: { tif: 'Gtc' } },
                 },
             };
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -707,7 +735,7 @@ class ExchangeClient {
                 type: constants_1.ExchangeType.BATCH_MODIFY,
                 modifies,
             };
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -725,7 +753,7 @@ class ExchangeClient {
                 isBuy: true,
                 ntli: (0, number_1.floatToInt)(params.value, 6), // 6 decimals
             };
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -740,7 +768,7 @@ class ExchangeClient {
                 type: constants_1.ExchangeType.SET_REFERRER,
                 code,
             };
-            const typedData = (0, signer_1.prepareSetReferrerTypedData)({ action, isTestnet: this.isTestnet, nonce });
+            const typedData = (0, signer_1.prepareL1ActionTypedData)({ action, isTestnet: this.isTestnet, nonce });
             return { typedData, action, nonce };
         }
         catch (error) {
@@ -766,7 +794,7 @@ class ExchangeClient {
                     type: constants_1.ExchangeType.SET_REFERRER,
                     code,
                 };
-                const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+                const signature = yield this.signL1Action(action, nonce);
                 return this.httpClient.exchange({
                     action,
                     nonce,
@@ -785,7 +813,7 @@ class ExchangeClient {
                 const action = {
                     type: constants_1.ExchangeType.AGENT_ENABLE_DEX_ABSTRACTION,
                 };
-                const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+                const signature = yield this.signL1Action(action, nonce);
                 return this.httpClient.exchange({
                     action,
                     nonce,
@@ -851,7 +879,7 @@ class ExchangeClient {
                     type: constants_1.ExchangeType.AGENT_SET_ABSTRACTION,
                     abstraction: abstraction,
                 };
-                const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+                const signature = yield this.signL1Action(action, nonce);
                 return this.httpClient.exchange({
                     action,
                     nonce,
@@ -1075,7 +1103,7 @@ class ExchangeClient {
                     f: params.builder.fee,
                 };
             }
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -1095,7 +1123,7 @@ class ExchangeClient {
                 a,
                 t: params.twapId,
             };
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,
@@ -1138,7 +1166,7 @@ class ExchangeClient {
                 orders: [orderRequest],
                 grouping: 'na',
             };
-            const signature = (0, signer_1.signL1AgentAction)(this.getAgentPrivateKey(), action, this.isTestnet, nonce);
+            const signature = yield this.signL1Action(action, nonce);
             return this.httpClient.exchange({
                 action,
                 nonce,

package/dist/hyperliquid-sdk.d.ts

@@ -1,6 +1,6 @@
 import { InfoClient } from './client/info-client';
 import { ExchangeClient } from './client/exchange-client';
-import type { ClearinghouseState } from './types';
+import type { ClearinghouseState, ExternalSign } from './types';
 import { WebSocketClient, WebSocketClientConfig } from './client/websocket-client';
 import { SymbolConversion } from './client/symbolConversion';
 export interface HyperliquidSDKConfig {
@@ -11,6 +11,7 @@ export interface HyperliquidSDKConfig {
     isTestnet?: boolean;
     timeout?: number;
     wsConfig?: WebSocketClientConfig;
+    externalSign?: ExternalSign;
 }
 /**
  * Main Hyperliquid SDK class for perpetuals trading
@@ -35,6 +36,11 @@ export declare class HyperliquidSDK {
      */
     get isHaveAgent(): boolean;
     initOrUpdateAgent(agentPrivateKey: string, agentPublicKey: string, agentName?: string): void;
+    /**
+     * Install (or clear with undefined) the external async signer on the exchange
+     * client. Call after initAccount when using master-wallet self-signing.
+     */
+    setExternalSign(externalSign?: ExternalSign): void;
     /**
      * Connect to WebSocket for real-time data
      */

package/dist/hyperliquid-sdk.js

@@ -39,6 +39,7 @@ class HyperliquidSDK {
                 agentPrivateKey: config.agentPrivateKey,
                 agentPublicKey: config.agentPublicKey,
                 agentName: config.agentName,
+                externalSign: config.externalSign,
                 isTestnet: config.isTestnet,
                 timeout: config.timeout,
                 symbolConversion: this.symbolConversion,
@@ -66,6 +67,7 @@ class HyperliquidSDK {
                 agentPrivateKey,
                 agentPublicKey,
                 agentName,
+                externalSign: this.configParams.externalSign,
                 isTestnet: this.configParams.isTestnet,
                 timeout: this.configParams.timeout,
             });
@@ -86,6 +88,15 @@ class HyperliquidSDK {
             this.exchange.initOrUpdateAgent(agentPrivateKey, agentPublicKey, agentName);
         }
     }
+    /**
+     * Install (or clear with undefined) the external async signer on the exchange
+     * client. Call after initAccount when using master-wallet self-signing.
+     */
+    setExternalSign(externalSign) {
+        if (this.exchange) {
+            this.exchange.setExternalSign(externalSign);
+        }
+    }
     /**
      * Connect to WebSocket for real-time data
      */

package/dist/types/index.d.ts

@@ -1,4 +1,16 @@
 import { SymbolConversion } from '../client/symbolConversion';
+import type { TypedMessage, MessageTypes } from '@metamask/eth-sig-util';
+/**
+ * EIP-712 typed data handed to an external signer (shape of
+ * prepareL1ActionTypedData's return value).
+ */
+export type ExternalSignTypedData = TypedMessage<MessageTypes>;
+/**
+ * External async signer for L1 actions. Receives EIP-712 typed data and returns
+ * a 0x-prefixed 65-byte hex signature. When set, the SDK uses it instead of the
+ * built-in agent private key, so the master wallet can sign orders itself.
+ */
+export type ExternalSign = (typedData: ExternalSignTypedData) => Promise<string>;
 export type Tif = 'Alo' | 'Ioc' | 'Gtc';
 export type TriggerType = 'tp' | 'sl';
 export type Side = 'A' | 'B';
@@ -526,6 +538,7 @@ export interface ExchangeClientConfig {
     isTestnet?: boolean;
     timeout?: number;
     symbolConversion?: SymbolConversion;
+    externalSign?: ExternalSign;
 }
 export interface PlaceOrderParams {
     coin: string;

package/dist/utils/signer.d.ts

@@ -23,7 +23,7 @@ export declare const signTypedDataV4: ({ privateKey, domain, primaryType, payloa
     message: Record<string, unknown>;
 }) => Signature;
 export declare const signL1AgentAction: (privateKey: string, action: unknown, isTestnet: boolean, nonce: number) => Signature;
-export declare const prepareSetReferrerTypedData: ({ action, isTestnet, nonce, }: {
+export declare const prepareL1ActionTypedData: ({ action, isTestnet, nonce, }: {
     action: Record<string, unknown>;
     isTestnet: boolean;
     nonce: number;

package/dist/utils/signer.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareMasterSignData = exports.prepareSetReferrerTypedData = exports.signL1AgentAction = exports.signTypedDataV4 = exports.splitSig = exports.EIP712_DOMAIN_TYPES = void 0;
+exports.prepareMasterSignData = exports.prepareL1ActionTypedData = exports.signL1AgentAction = exports.signTypedDataV4 = exports.splitSig = exports.EIP712_DOMAIN_TYPES = void 0;
 const ethUtil = __importStar(require("@ethereumjs/util"));
 const sigUtil = __importStar(require("@metamask/eth-sig-util"));
 const keccak_1 = require("ethereum-cryptography/keccak");
@@ -109,7 +109,7 @@ const signL1AgentAction = (privateKey, action, isTestnet, nonce) => {
     return (0, exports.signTypedDataV4)({ privateKey, domain, primaryType: 'Agent', payloadTypes, message });
 };
 exports.signL1AgentAction = signL1AgentAction;
-const prepareSetReferrerTypedData = ({ action, isTestnet, nonce, }) => {
+const prepareL1ActionTypedData = ({ action, isTestnet, nonce, }) => {
     const domain = {
         name: 'Exchange',
         version: '1',
@@ -136,7 +136,7 @@ const prepareSetReferrerTypedData = ({ action, isTestnet, nonce, }) => {
     };
     return typedData;
 };
-exports.prepareSetReferrerTypedData = prepareSetReferrerTypedData;
+exports.prepareL1ActionTypedData = prepareL1ActionTypedData;
 /**
     * Prepare some action sign must by master wallet so we need to prepare the typed data
     * Returns typed data that needs to be signed by the main wallet

package/package.json

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