@nktkas/hyperliquid 0.24.0 → 0.24.2

package/README.md

@@ -53,16 +53,11 @@ deno add jsr:@nktkas/hyperliquid
 <summary>For React Native, you need to import polyfills before importing the SDK:</summary>
 
 ```js
-// React Native 0.76.3 / Expo v52
+// React Native v0.79 / Expo v53
 // Issues:
 // - signing: does not support private keys directly, use `viem` or `ethers`
 
-import { Event, EventTarget } from "event-target-shim";
-
-if (!globalThis.EventTarget || !globalThis.Event) {
-    globalThis.EventTarget = EventTarget;
-    globalThis.Event = Event;
-}
+import "event-target-polyfill";
 
 if (!globalThis.CustomEvent) {
     globalThis.CustomEvent = function (type, params) {
@@ -103,7 +98,7 @@ if (!Promise.withResolvers) {
 // 1. Import module
 import * as hl from "@nktkas/hyperliquid";
 
-// 1. Set up client with transport
+// 2. Set up client with transport
 const infoClient = new hl.InfoClient({
     transport: new hl.HttpTransport(), // or `WebSocketTransport`
 });
@@ -166,7 +161,7 @@ await sub.unsubscribe();
 // 1. Import module
 import * as hl from "@nktkas/hyperliquid";
 
-// 2. Set up client with
+// 2. Set up client with transport, multi-sign address, and signers
 const multiSignClient = new hl.MultiSignClient({
     transport: new hl.HttpTransport(), // or `WebSocketTransport`
     multiSignAddress: "0x...",
@@ -175,8 +170,8 @@ const multiSignClient = new hl.MultiSignClient({
     ],
 });
 
-// 3. Execute an action
-const data = await multiSignClient.approveAgent({ agentAddress: "0x..." });
+// 3. Execute an action (same as `ExchangeClient`)
+await multiSignClient.approveAgent({ agentAddress: "0x..." });
 ```
 
 ## Usage
@@ -221,20 +216,20 @@ const transport = new hl.HttpTransport(); // or `WebSocketTransport`
 
 // 1. Using private key directly
 const privateKey = "0x...";
-const exchClient_privateKey = new hl.ExchangeClient({ wallet: privateKey, transport });
+const exchClient = new hl.ExchangeClient({ wallet: privateKey, transport });
 
 // 2. Using Viem
 const viemAccount = privateKeyToAccount("0x...");
-const exchClient_viem = new hl.ExchangeClient({ wallet: viemAccount, transport });
+const exchClient = new hl.ExchangeClient({ wallet: viemAccount, transport });
 
 // 3. Using Ethers (V5 or V6)
 const ethersWallet = new ethers.Wallet("0x...");
-const exchClient_ethers = new hl.ExchangeClient({ wallet: ethersWallet, transport });
+const exchClient = new hl.ExchangeClient({ wallet: ethersWallet, transport });
 
 // 4. Using external wallet (e.g. MetaMask) via Viem
-const [account] = await window.ethereum.request({ method: "eth_requestAccounts" });
+const [account] = await window.ethereum.request({ method: "eth_requestAccounts" }) as `0x${string}`[];
 const externalWallet = createWalletClient({ account, transport: custom(window.ethereum) });
-const exchClient_viemMetamask = new hl.ExchangeClient({ wallet: externalWallet, transport });
+const exchClient = new hl.ExchangeClient({ wallet: externalWallet, transport });
 ```
 
 #### Create [SubscriptionClient](#subscriptionclient)
@@ -266,7 +261,7 @@ const multiSignClient = new hl.MultiSignClient({
                     name: string;
                     version: string;
                     chainId: number;
-                    verifyingContract: `0x${string}`;
+                    verifyingContract: Hex;
                 };
                 types: {
                     [key: string]: {
@@ -276,12 +271,13 @@ const multiSignClient = new hl.MultiSignClient({
                 };
                 primaryType: string;
                 message: Record<string, unknown>;
-            }): Promise<`0x${string}`> {
+            }): Promise<Hex> {
                 // Custom signer logic
                 return "0x..."; // return hex signature
             },
         },
         "0x...", // private key directly
+        // ... more signers
     ],
 });
 ```
@@ -300,12 +296,12 @@ const infoClient = new hl.InfoClient({
 });
 
 // L2 Book
-const l2Book = await infoClient.l2Book({ coin: "BTC" });
+const l2Book = await infoClient.l2Book({ coin: "ETH" });
 
-// Account clearinghouse state
+// User clearinghouse state
 const clearinghouseState = await infoClient.clearinghouseState({ user: "0x..." });
 
-// Open orders
+// User open orders
 const openOrders = await infoClient.openOrders({ user: "0x..." });
 ```
 
@@ -353,7 +349,7 @@ const subsClient = new hl.SubscriptionClient({
 });
 
 // L2 Book updates
-await subsClient.l2Book({ coin: "BTC" }, (data) => {
+await subsClient.l2Book({ coin: "ETH" }, (data) => {
     console.log(data);
 });
 
@@ -363,7 +359,7 @@ await subsClient.userFills({ user: "0x..." }, (data) => {
 });
 
 // Candle updates
-await subsClient.candle({ coin: "BTC", interval: "1h" }, (data) => {
+await subsClient.candle({ coin: "ETH", interval: "1h" }, (data) => {
     console.log(data);
 });
 ```
@@ -378,6 +374,7 @@ const multiSignClient = new hl.MultiSignClient({
     multiSignAddress: "0x...",
     signers: [
         "0x...", // `viem`, `ethers`, or private key directly
+        // ... more signers
     ],
 });
 
@@ -415,9 +412,11 @@ class InfoClient {
     spotDeployState(args: SpotDeployStateParameters): Promise<SpotDeployState>;
     spotMeta(): Promise<SpotMeta>;
     spotMetaAndAssetCtxs(): Promise<SpotMetaAndAssetCtxs>;
+    spotPairDeployAuctionStatus(): Promise<DeployAuctionStatus>;
     tokenDetails(args: TokenDetailsParameters): Promise<TokenDetails>;
 
     // Account
+    activeAssetData(args: ActiveAssetDataParameters): Promise<ActiveAssetData>;
     clearinghouseState(args: ClearinghouseStateParameters): Promise<PerpsClearinghouseState>;
     extraAgents(args: ExtraAgentsParameters): Promise<ExtraAgent[]>;
     isVip(args: IsVipParameters): Promise<boolean>;
@@ -478,8 +477,8 @@ class ExchangeClient {
         transport: HttpTransport | WebSocketTransport;
         wallet: AbstractWallet; // `viem`, `ethers` (v5 or v6), or private key directly
         isTestnet?: boolean; // Whether to use testnet (default: false)
-        defaultVaultAddress?: `0x${string}`; // Vault address used by default if not provided in method call
-        signatureChainId?: `0x${string}` | (() => MaybePromise<`0x${string}`>); // Chain ID used for signing (default: get chain id from wallet otherwise `0x1`)
+        defaultVaultAddress?: Hex; // Vault address used by default if not provided in method call
+        signatureChainId?: Hex | (() => MaybePromise<Hex>); // Chain ID used for signing (default: get chain id from wallet otherwise `0x1`)
         nonceManager?: () => MaybePromise<number>; // Function to get the next nonce (default: monotonically incrementing `Date.now()`)
     });
 
@@ -501,6 +500,7 @@ class ExchangeClient {
     claimRewards(): Promise<SuccessResponse>;
     createSubAccount(args: CreateSubAccountParameters): Promise<CreateSubAccountResponse>;
     evmUserModify(args: EvmUserModifyParameters): Promise<SuccessResponse>;
+    noop(): Promise<SuccessResponse>;
     registerReferrer(args: RegisterReferrerParameters): Promise<SuccessResponse>;
     reserveRequestWeight(args: ReserveRequestWeightParameters): Promise<SuccessResponse>;
     setDisplayName(args: SetDisplayNameParameters): Promise<SuccessResponse>;
@@ -509,6 +509,7 @@ class ExchangeClient {
     spotUser(args: SpotUserParameters): Promise<SuccessResponse>;
 
     // Transfer
+    sendAsset(args: SendAssetParameters): Promise<SuccessResponse>;
     spotSend(args: SpotSendParameters): Promise<SuccessResponse>;
     subAccountSpotTransfer(args: SubAccountSpotTransferParameters): Promise<SuccessResponse>;
     subAccountTransfer(args: SubAccountTransferParameters): Promise<SuccessResponse>;
@@ -552,7 +553,6 @@ class SubscriptionClient {
 
     // Market
     activeAssetCtx(args: EventActiveAssetCtxParameters, listener: (data: WsActiveAssetCtx | WsActiveSpotAssetCtx) => void): Promise<Subscription>;
-    activeAssetData(args: EventActiveAssetDataParameters, listener: (data: ActiveAssetData) => void): Promise<Subscription>;
     allMids(listener: (data: WsAllMids) => void): Promise<Subscription>;
     bbo(args: EventBboParameters, listener: (data: WsBbo) => void): Promise<Subscription>;
     candle(args: EventCandleParameters, listener: (data: Candle) => void): Promise<Subscription>;
@@ -560,6 +560,7 @@ class SubscriptionClient {
     trades(args: EventTradesParameters, listener: (data: WsTrade[]) => void): Promise<Subscription>;
 
     // Account
+    activeAssetData(args: EventActiveAssetDataParameters, listener: (data: ActiveAssetData) => void): Promise<Subscription>;
     notification(args: EventNotificationParameters, listener: (data: WsNotification) => void): Promise<Subscription>;
     userEvents(args: EventUserEventsParameters, listener: (data: WsUserEvent) => void): Promise<Subscription>;
     userFundings(args: EventUserFundingsParameters, listener: (data: WsUserFundings) => void): Promise<Subscription>;
@@ -587,8 +588,11 @@ class MultiSignClient extends ExchangeClient {
         args:
             & Omit<ExchangeClientParameters, "wallet"> // instead of `wallet`, you should specify the following parameters:
             & {
-                multiSignAddress: `0x${string}`;
-                signers: [AbstractWallet, ...AbstractWallet[]];
+                multiSignAddress: Hex;
+                signers: [
+                    AbstractWallet, // first is leader for multi-sign transaction (signs transaction 2 times)
+                    ...AbstractWallet[], // may be additional signers
+                ];
             },
     );
 
@@ -668,22 +672,17 @@ class WebSocketTransport {
 
 ### `/types`
 
-The import point gives access to all Hyperliquid-related types, including the base types on which class methods are
-based.
+The import point gives access to all request/response types associated with Hyperliquid API.
 
 ### `/signing`
 
-The import point gives access to functions that generate signatures for Hyperliquid transactions.
-
-### Examples
+The import point gives access to functions that generate signatures for Hyperliquid API actions.
 
-#### Cancel order yourself
+#### L1 Action
 
 ```ts
 import { actionSorter, signL1Action } from "@nktkas/hyperliquid/signing";
 
-const privateKey = "0x..."; // `viem`, `ethers`, or private key directly
-
 const action = actionSorter.cancel({
     type: "cancel",
     cancels: [
@@ -692,7 +691,11 @@ const action = actionSorter.cancel({
 });
 const nonce = Date.now();
 
-const signature = await signL1Action({ wallet: privateKey, action, nonce });
+const signature = await signL1Action({
+    wallet: "0x...", // `viem`, `ethers`, or private key directly
+    action,
+    nonce,
+});
 
 // Send the signed action to the Hyperliquid API
 const response = await fetch("https://api.hyperliquid.xyz/exchange", {
@@ -703,13 +706,11 @@ const response = await fetch("https://api.hyperliquid.xyz/exchange", {
 const body = await response.json();
 ```
 
-#### Approve agent yourself
+#### User Signed Action
 
 ```ts
 import { actionSorter, signUserSignedAction, userSignedActionEip712Types } from "@nktkas/hyperliquid/signing";
 
-const privateKey = "0x..."; // `viem`, `ethers`, or private key directly
-
 const action = actionSorter.approveAgent({
     type: "approveAgent",
     signatureChainId: "0x66eee",
@@ -720,7 +721,7 @@ const action = actionSorter.approveAgent({
 });
 
 const signature = await signUserSignedAction({
-    wallet: privateKey,
+    wallet: "0x...", // `viem`, `ethers`, or private key directly
     action,
     types: userSignedActionEip712Types[action.type],
 });
@@ -738,13 +739,12 @@ const body = await response.json();
 
 ### How to execute an L1 action via an external wallet (e.g. MetaMask)?
 
-Hyperliquid requires chain `1337` for L1 actions (open order, change leverage, etc.). There are two ways to execute an
-L1 action through an external wallet:
+Hyperliquid requires chain `1337` for L1 action signatures. To handle this with external wallets:
 
 - (recommended) Create an
   [Agent Wallet](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/nonces-and-api-wallets#api-wallets)
   and execute all L1 actions through it
-- Change the user's chain to `1337`, however, the user will sign unreadable data
+- Change a user's chain to `1337`, however, the user will sign unreadable data
 
 ### How to create a market order?
 

package/esm/mod.d.ts

@@ -7,6 +7,7 @@ export * from "./src/clients/multiSign.js";
 export * from "./src/clients/subscription.js";
 export * from "./src/transports/http/http_transport.js";
 export * from "./src/transports/websocket/websocket_transport.js";
+export type { OrderParams, Signature } from "./src/types/exchange/requests.js";
 export type * from "./src/types/exchange/responses.js";
 export type * from "./src/types/explorer/responses.js";
 export type * from "./src/types/info/accounts.js";

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AAGzC,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAG3D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAG9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,mDAAmD,CAAC;AAGlE,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,gCAAgC,CAAC;AACpD,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,wCAAwC,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AAGzC,YAAY,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAG3D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAG9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,mDAAmD,CAAC;AAGlE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC/E,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,gCAAgC,CAAC;AACpD,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,wCAAwC,CAAC"}