@nktkas/hyperliquid 0.13.0 → 0.13.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024-2025 nktkas
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2024-2025 nktkas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -2,6 +2,7 @@
 
 [![JSR](https://jsr.io/badges/@nktkas/hyperliquid)](https://jsr.io/@nktkas/hyperliquid)
 [![JSR Score](https://jsr.io/badges/@nktkas/hyperliquid/score)](https://jsr.io/@nktkas/hyperliquid)
+[![bundlephobia](https://badgen.net/bundlephobia/minzip/@nktkas/hyperliquid)](https://bundlephobia.com/package/@nktkas/hyperliquid)
 
 Unofficial [Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api) SDK for all major JS
 runtimes, written in TypeScript and provided with tests.
@@ -22,16 +23,16 @@ runtimes, written in TypeScript and provided with tests.
 
 ```bash
 # npm
-npx jsr add @nktkas/hyperliquid
+npm i @nktkas/hyperliquid
 
 # yarn 
-yarn dlx jsr add @nktkas/hyperliquid
+yarn add @nktkas/hyperliquid
 
 # pnpm
-pnpm dlx jsr add @nktkas/hyperliquid
+pnpm add @nktkas/hyperliquid
 
 # bun
-bunx jsr add @nktkas/hyperliquid
+bun i @nktkas/hyperliquid
 
 # deno
 deno add jsr:@nktkas/hyperliquid
@@ -80,7 +81,6 @@ const client = new hl.PublicClient({ transport });
 ```typescript
 import * as hl from "@nktkas/hyperliquid";
 import { createWalletClient, custom } from "viem";
-import { arbitrum } from "viem/chains";
 import { privateKeyToAccount } from "viem/accounts";
 import { ethers } from "ethers";
 
@@ -96,14 +96,19 @@ const ethersClient = new hl.WalletClient({ wallet: ethersWallet, transport });
 
 // 3. Using external wallet (e.g. MetaMask) via Viem
 const [account] = await window.ethereum.request({ method: "eth_requestAccounts" });
-const externalWallet = createWalletClient({
-    account,
-    chain: arbitrum,
-    transport: custom(window.ethereum),
-});
+const externalWallet = createWalletClient({ account, transport: custom(window.ethereum) });
 const metamaskClient = new hl.WalletClient({ wallet: externalWallet, transport });
 ```
 
+#### Create EventClient
+
+```typescript
+import * as hl from "@nktkas/hyperliquid";
+
+const transport = new hl.WebSocketTransport();
+const client = new hl.EventClient({ transport });
+```
+
 ## API Reference
 
 ### Clients
@@ -135,6 +140,7 @@ class PublicClient<T extends IRESTTransport> {
     l2Book(args: L2BookParameters): Promise<L2Book>;
     meta(): Promise<Meta>;
     metaAndAssetCtxs(): Promise<MetaAndAssetCtxs>;
+    perpsAtOpenInterestCap(): Promise<string[]>;
     predictedFundings(): Promise<PredictedFunding[]>;
     spotDeployState(args: SpotDeployStateParameters): Promise<SpotDeployState>;
     spotMeta(): Promise<SpotMeta>;
@@ -145,6 +151,7 @@ class PublicClient<T extends IRESTTransport> {
     clearinghouseState(args: ClearinghouseStateParameters): Promise<ClearinghouseState>;
     extraAgents(args: ExtraAgentsParameters): Promise<ExtraAgent[]>;
     maxBuilderFee(args: MaxBuilderFeeParameters): Promise<number>;
+    portfolio(args: PortfolioParameters): Promise<PortfolioPeriods>;
     referral(args: ReferralParameters): Promise<Referral>;
     spotClearinghouseState(args: SpotClearinghouseStateParameters): Promise<SpotClearinghouseState>;
     subAccounts(args: SubAccountsParameters): Promise<SubAccount[]>;
@@ -152,6 +159,7 @@ class PublicClient<T extends IRESTTransport> {
     userFunding(args: UserFundingParameters): Promise<UserFunding[]>;
     userNonFundingLedgerUpdates(args: UserNonFundingLedgerUpdatesParameters): Promise<UserNonFundingLedgerUpdates[]>;
     userRateLimit(args: UserRateLimitParameters): Promise<UserRateLimit>;
+    userRole(args: UserRoleParameters): Promise<UserRole>;
 
     // Order
     frontendOpenOrders(args: FrontendOpenOrdersParameters): Promise<FrontendOpenOrder[]>;
@@ -163,14 +171,22 @@ class PublicClient<T extends IRESTTransport> {
     userFillsByTime(args: UserFillsByTimeParameters): Promise<UserFill[]>;
     userTwapSliceFills(args: UserTwapSliceFillsParameters): Promise<UserTwapSliceFill[]>;
 
+    // Staking
+    delegations(args: DelegationsParameters): Promise<Delegation[]>;
+    delegatorHistory(args: DelegatorHistoryParameters): Promise<DelegatorUpdate[]>;
+    delegatorRewards(args: DelegatorRewardsParameters): Promise<DelegatorReward[]>;
+    delegatorSummary(args: DelegatorSummaryParameters): Promise<DelegatorSummary>;
+    validatorSummaries(): Promise<ValidatorSummary[]>;
+
     // Vault
     userVaultEquities(args: UserVaultEquitiesParameters): Promise<UserVaultEquity[]>;
     vaultDetails(args: VaultDetailsParameters): Promise<VaultDetails | null>;
     vaultSummaries(): Promise<VaultSummary[]>;
 
-    // Blockchain
+    // Explorer
     blockDetails(args: BlockDetailsParameters): Promise<BlockDetailsResponse>;
     txDetails(args: TxDetailsParameters): Promise<TxDetailsResponse>;
+    userDetails(args: UserDetailsParameters): Promise<UserDetailsResponse>;
 }
 ```
 
@@ -201,7 +217,7 @@ class WalletClient<
 > {
     constructor(args: WalletClientParameters<T, W>);
 
-    // Order Management
+    // Order
     batchModify(args: BatchModifyParameters): Promise<OrderResponseSuccess>;
     cancel(args: CancelParameters): Promise<CancelResponseSuccess>;
     cancelByCloid(args: CancelByCloidParameters): Promise<CancelResponseSuccess>;
@@ -213,7 +229,7 @@ class WalletClient<
     updateIsolatedMargin(args: UpdateIsolatedMarginParameters): Promise<SuccessResponse>;
     updateLeverage(args: UpdateLeverageParameters): Promise<SuccessResponse>;
 
-    // Account Management
+    // Account
     approveAgent(args: ApproveAgentParameters): Promise<SuccessResponse>;
     approveBuilderFee(args: ApproveBuilderFeeParameters): Promise<SuccessResponse>;
     createSubAccount(args: CreateSubAccountParameters): Promise<CreateSubAccountResponse>;
@@ -226,6 +242,11 @@ class WalletClient<
     usdSend(args: UsdSendParameters): Promise<SuccessResponse>;
     vaultTransfer(args: VaultTransferParameters): Promise<SuccessResponse>;
     withdraw3(args: Withdraw3Parameters): Promise<SuccessResponse>;
+
+    // Staking
+    cDeposit(args: CDepositParameters): Promise<SuccessResponse>;
+    cWithdraw(args: CWithdrawParameters): Promise<SuccessResponse>;
+    tokenDelegate(args: TokenDelegateParameters): Promise<SuccessResponse>;
 }
 ```
 
@@ -246,7 +267,7 @@ interface EventClientParameters<T extends ISubscriptionTransport> {
 class EventClient<T extends ISubscriptionTransport> {
     constructor(args: EventClientParameters<T>);
 
-    // Market Data
+    // Market
     activeAssetCtx(args: EventActiveAssetCtxParameters, listener: (data: WsActiveAssetCtx | WsActiveSpotAssetCtx) => void): Promise<Subscription>;
     activeAssetData(args: EventActiveAssetDataParameters, listener: (data: WsActiveAssetData) => void): Promise<Subscription>;
     allMids(listener: (data: WsAllMids) => void): Promise<Subscription>;
@@ -254,18 +275,22 @@ class EventClient<T extends ISubscriptionTransport> {
     l2Book(args: EventL2BookParameters, listener: (data: Book) => void): Promise<Subscription>;
     trades(args: EventTradesParameters, listener: (data: WsTrade[]) => void): Promise<Subscription>;
 
-    // Account/User Data
+    // Account
     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>;
     userNonFundingLedgerUpdates(args: EventUserNonFundingLedgerUpdatesParameters, listener: (data: WsUserNonFundingLedgerUpdates) => void): Promise<Subscription>;
     webData2(args: EventWebData2Parameters, listener: (data: WsWebData2) => void): Promise<Subscription>;
 
-    // Order Management
-    orderUpdates(args: EventOrderUpdatesParameters, listener: (data: OrderStatus) => void): Promise<Subscription>;
+    // Order
+    orderUpdates(args: EventOrderUpdatesParameters, listener: (data: OrderStatus<Order>[]) => void): Promise<Subscription>;
     userFills(args: EventUserFillsParameters, listener: (data: WsUserFills) => void): Promise<Subscription>;
     userTwapHistory(args: EventUserTwapHistory, listener: (data: WsUserTwapHistory) => void): Promise<Subscription>;
     userTwapSliceFills(args: EventUserTwapSliceFills, listener: (data: WsUserTwapSliceFills) => void): Promise<Subscription>;
+
+    // Explorer
+    explorerBlock(listener: (data: WsBlockDetails[]) => void): Promise<Subscription>;
+    explorerTx(listener: (data: TxDetails[]) => void): Promise<Subscription>;
 }
 ```
 <!-- deno-fmt-ignore-end -->

package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Proxy type of {@code Uint8Array<ArrayBuffer} or {@code Uint8Array} in TypeScript 5.7 or below respectively.
+ *
+ * This type is internal utility type and should not be used directly.
+ *
+ * @internal @private
+ */
+export type Uint8Array_ = ReturnType<Uint8Array["slice"]>;
+//# sourceMappingURL=_types.d.ts.map

package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/bytes/1.0.5/_types.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/esm/deps/jsr.io/@std/bytes/1.0.5/_types.js

@@ -0,0 +1,2 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+export {};

package/esm/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.d.ts

@@ -1,3 +1,5 @@
+import type { Uint8Array_ } from "./_types.js";
+export type { Uint8Array_ };
 /**
  * Concatenate an array of byte slices into a single slice.
  *
@@ -15,5 +17,5 @@
  * assertEquals(concat([a, b]), new Uint8Array([0, 1, 2, 3, 4, 5]));
  * ```
  */
-export declare function concat(buffers: Uint8Array[]): Uint8Array;
+export declare function concat(buffers: Uint8Array[]): Uint8Array_;
 //# sourceMappingURL=concat.d.ts.map

package/esm/deps/jsr.io/@std/bytes/1.0.5/concat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"concat.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/bytes/1.0.5/concat.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,WAAW,CAazD"}

package/esm/deps/jsr.io/@std/bytes/{1.0.4 → 1.0.5}/concat.js

@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 // This module is browser compatible.
 /**
  * Concatenate an array of byte slices into a single slice.

package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Proxy type of {@code Uint8Array<ArrayBuffer} or {@code Uint8Array} in TypeScript 5.7 or below respectively.
+ *
+ * This type is internal utility type and should not be used directly.
+ *
+ * @internal @private
+ */
+export type Uint8Array_ = ReturnType<Uint8Array["slice"]>;
+//# sourceMappingURL=_types.d.ts.map

package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/encoding/1.0.7/_types.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/esm/deps/jsr.io/@std/encoding/1.0.7/_types.js

@@ -0,0 +1,2 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+export {};

package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"_validate_binary_like.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/encoding/1.0.6/_validate_binary_like.ts"],"names":[],"mappings":"AAeA,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAa9D"}
+{"version":3,"file":"_validate_binary_like.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/encoding/1.0.7/_validate_binary_like.ts"],"names":[],"mappings":"AAeA,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAa9D"}

package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/_validate_binary_like.js

@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 const encoder = new TextEncoder();
 function getTypeName(value) {
     const type = typeof value;

package/{script/deps/jsr.io/@std/encoding/1.0.6 → esm/deps/jsr.io/@std/encoding/1.0.7}/hex.d.ts

@@ -1,3 +1,5 @@
+import type { Uint8Array_ } from "./_types.js";
+export type { Uint8Array_ };
 /**
  * Converts data into a hex-encoded string.
  *
@@ -33,5 +35,5 @@ export declare function encodeHex(src: string | Uint8Array | ArrayBuffer): strin
  * );
  * ```
  */
-export declare function decodeHex(src: string): Uint8Array;
+export declare function decodeHex(src: string): Uint8Array_;
 //# sourceMappingURL=hex.d.ts.map

package/esm/deps/jsr.io/@std/encoding/1.0.7/hex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hex.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/encoding/1.0.7/hex.ts"],"names":[],"mappings":"AA6BA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,WAAW,EAAE,CAAC;AA4B5B;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,MAAM,CAUxE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAiBlD"}

package/esm/deps/jsr.io/@std/encoding/{1.0.6 → 1.0.7}/hex.js

@@ -1,6 +1,6 @@
 // Copyright 2009 The Go Authors. All rights reserved.
 // https://github.com/golang/go/blob/master/LICENSE
-// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 // This module is browser compatible.
 /**
  * Port of the Go

package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Proxy type of {@code Uint8Array<ArrayBuffer} or {@code Uint8Array} in TypeScript 5.7 or below respectively.
+ *
+ * This type is internal utility type and should not be used directly.
+ *
+ * @internal @private
+ */
+export type Uint8Array_ = ReturnType<Uint8Array["slice"]>;
+//# sourceMappingURL=_types.d.ts.map

package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/msgpack/1.0.3/_types.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC"}

package/esm/deps/jsr.io/@std/msgpack/1.0.3/_types.js

@@ -0,0 +1,2 @@
+// Copyright 2018-2025 the Deno authors. MIT license.
+export {};

package/esm/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.d.ts

@@ -1,3 +1,5 @@
+import type { Uint8Array_ } from "./_types.js";
+export type { Uint8Array_ };
 /**
  * Value types that can be encoded to MessagePack.
  */
@@ -33,5 +35,5 @@ export interface ValueMap {
  * @param object Value to encode to MessagePack binary format.
  * @returns Encoded MessagePack binary data.
  */
-export declare function encode(object: ValueType): Uint8Array;
+export declare function encode(object: ValueType): Uint8Array_;
 //# sourceMappingURL=encode.d.ts.map

package/esm/deps/jsr.io/@std/msgpack/1.0.3/encode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/msgpack/1.0.3/encode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,UAAU,GACV,SAAS,SAAS,EAAE,GACpB,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,sBAAsB;IACtB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACrC;AAeD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,WAAW,CAIrD"}

package/esm/deps/jsr.io/@std/msgpack/{1.0.2 → 1.0.3}/encode.js

@@ -1,6 +1,6 @@
-// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 // This module is browser compatible.
-import { concat } from "../../bytes/1.0.4/concat.js";
+import { concat } from "../../bytes/1.0.5/concat.js";
 const FOUR_BITS = 16;
 const FIVE_BITS = 32;
 const SEVEN_BITS = 128;

package/esm/mod.d.ts

@@ -6,19 +6,20 @@ export * from "./src/transports/http/http_transport.js";
 export * from "./src/transports/websocket/websocket_transport.js";
 export type { MessageBufferStrategy, ReconnectingWebSocketOptions, } from "./src/transports/websocket/reconnecting_websocket.js";
 export { WebSocketRequestError } from "./src/transports/websocket/websocket_request_dispatcher.js";
-export type * from "./src/types/common";
-export type * from "./src/types/exchange/common";
-export type * from "./src/types/exchange/requests";
-export type * from "./src/types/exchange/responses";
-export type * from "./src/types/explorer/common";
-export type * from "./src/types/explorer/requests";
-export type * from "./src/types/explorer/responses";
-export type * from "./src/types/info/accounts";
-export type * from "./src/types/info/assets";
-export type * from "./src/types/info/orders";
-export type * from "./src/types/info/requests";
-export type * from "./src/types/info/vaults";
-export type * from "./src/types/subscriptions/common";
-export type * from "./src/types/subscriptions/requests";
+export type * from "./src/types/common.js";
+export type * from "./src/types/exchange/common.js";
+export type * from "./src/types/exchange/requests.js";
+export type * from "./src/types/exchange/responses.js";
+export type * from "./src/types/explorer/common.js";
+export type * from "./src/types/explorer/requests.js";
+export type * from "./src/types/explorer/responses.js";
+export type * from "./src/types/info/accounts.js";
+export type * from "./src/types/info/assets.js";
+export type * from "./src/types/info/delegations.js";
+export type * from "./src/types/info/orders.js";
+export type * from "./src/types/info/requests.js";
+export type * from "./src/types/info/vaults.js";
+export type * from "./src/types/subscriptions/common.js";
+export type * from "./src/types/subscriptions/requests.js";
 export type { AbstractEthersSigner, AbstractEthersV5Signer, AbstractViemWalletClient } from "./src/utils/signing.js";
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AAGxC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,yCAAyC,CAAC;AAExD,cAAc,mDAAmD,CAAC;AAClE,YAAY,EACR,qBAAqB,EACrB,4BAA4B,GAC/B,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4DAA4D,CAAC;AAGnG,mBAAmB,oBAAoB,CAAC;AAExC,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,gCAAgC,CAAC;AAEpD,mBAAmB,6BAA6B,CAAC;AACjD,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,gCAAgC,CAAC;AAEpD,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,yBAAyB,CAAC;AAE7C,mBAAmB,kCAAkC,CAAC;AACtD,mBAAmB,oCAAoC,CAAC;AAGxD,YAAY,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AAGxC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,yCAAyC,CAAC;AAExD,cAAc,mDAAmD,CAAC;AAClE,YAAY,EACR,qBAAqB,EACrB,4BAA4B,GAC/B,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4DAA4D,CAAC;AAGnG,mBAAmB,uBAAuB,CAAC;AAE3C,mBAAmB,gCAAgC,CAAC;AACpD,mBAAmB,kCAAkC,CAAC;AACtD,mBAAmB,mCAAmC,CAAC;AAEvD,mBAAmB,gCAAgC,CAAC;AACpD,mBAAmB,kCAAkC,CAAC;AACtD,mBAAmB,mCAAmC,CAAC;AAEvD,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,8BAA8B,CAAC;AAClD,mBAAmB,4BAA4B,CAAC;AAEhD,mBAAmB,qCAAqC,CAAC;AACzD,mBAAmB,uCAAuC,CAAC;AAG3D,YAAY,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC"}

package/esm/src/clients/event.d.ts

@@ -1,8 +1,9 @@
 import type { ISubscriptionTransport, Subscription } from "../transports/base.js";
-import type { WsActiveAssetCtxRequest, WsActiveAssetDataRequest, WsCandleRequest, WsL2BookRequest, WsNotificationRequest, WsOrderUpdatesRequest, WsTradesRequest, WsUserEventsRequest, WsUserFillsRequest, WsUserFundingsRequest, WsUserNonFundingLedgerUpdatesRequest, WsUserTwapHistoryRequest, WsUserTwapSliceFillsRequest, WsWebData2Request } from "../types/subscriptions/requests";
-import type { WsActiveAssetCtx, WsActiveAssetData, WsActiveSpotAssetCtx, WsAllMids, WsNotification, WsTrade, WsUserEvent, WsUserFills, WsUserFundings, WsUserNonFundingLedgerUpdates, WsUserTwapHistory, WsUserTwapSliceFills, WsWebData2 } from "../types/subscriptions/common";
-import type { Candle } from "../types/info/assets";
-import type { Book, Order, OrderStatus } from "../types/info/orders";
+import type { WsActiveAssetCtxRequest, WsActiveAssetDataRequest, WsCandleRequest, WsL2BookRequest, WsNotificationRequest, WsOrderUpdatesRequest, WsTradesRequest, WsUserEventsRequest, WsUserFillsRequest, WsUserFundingsRequest, WsUserNonFundingLedgerUpdatesRequest, WsUserTwapHistoryRequest, WsUserTwapSliceFillsRequest, WsWebData2Request } from "../types/subscriptions/requests.js";
+import type { WsActiveAssetCtx, WsActiveAssetData, WsActiveSpotAssetCtx, WsAllMids, WsBlockDetails, WsNotification, WsTrade, WsUserEvent, WsUserFills, WsUserFundings, WsUserNonFundingLedgerUpdates, WsUserTwapHistory, WsUserTwapSliceFills, WsWebData2 } from "../types/subscriptions/common.js";
+import type { Candle } from "../types/info/assets.js";
+import type { Book, Order, OrderStatus } from "../types/info/orders.js";
+import type { TxDetails } from "../types/explorer/common.js";
 /** Parameters for the {@linkcode EventClient} constructor. */
 export interface EventClientParameters<T extends ISubscriptionTransport = ISubscriptionTransport> {
     /** The transport used to connect to the Hyperliquid API. */
@@ -63,7 +64,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -84,7 +85,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -104,7 +105,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -125,7 +126,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -139,6 +140,46 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * ```
      */
     candle(args: EventCandleParameters, listener: (data: Candle) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to explorer block updates.
+     * @param listener - The callback function to be called when the event is received.
+     * @param signal - An optional abort signal for canceling the subscription request.
+     * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.explorerBlock((data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    explorerBlock(listener: (data: WsBlockDetails[]) => void, signal?: AbortSignal): Promise<Subscription>;
+    /**
+     * Subscribe to explorer transaction updates.
+     * @param listener - The callback function to be called when the event is received.
+     * @param signal - An optional abort signal for canceling the subscription request.
+     * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
+     *
+     * @see null - no documentation
+     * @example
+     * ```ts
+     * import * as hl from "@nktkas/hyperliquid";
+     *
+     * const transport = new hl.WebSocketTransport();
+     * const client = new hl.EventClient({ transport });
+     *
+     * const sub = await client.explorerTxs((data) => {
+     *   console.log(data);
+     * });
+     * ```
+     */
+    explorerTxs(listener: (data: TxDetails[]) => void, signal?: AbortSignal): Promise<Subscription>;
     /**
      * Subscribe to L2 order book updates for a specific asset.
      * @param args - The parameters for the subscription.
@@ -146,7 +187,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -161,13 +202,13 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      */
     l2Book(args: EventL2BookParameters, listener: (data: Book) => void, signal?: AbortSignal): Promise<Subscription>;
     /**
-     * Subscribe to user notification.
+     * Subscribe to notification updates for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -188,7 +229,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -209,7 +250,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -224,13 +265,15 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      */
     trades(args: EventTradesParameters, listener: (data: WsTrade[]) => void, signal?: AbortSignal): Promise<Subscription>;
     /**
-     * Subscribe to all events for a specific user.
+     * Subscribe to non-order events for a specific user.
      * @param args - The parameters for the subscription.
      * @param listener - The callback function to be called when the event is received.
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @note Different subscriptions cannot be distinguished from each other.
+     *
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -251,7 +294,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -272,7 +315,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -293,7 +336,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -314,7 +357,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -335,7 +378,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";
@@ -356,7 +399,7 @@ export declare class EventClient<T extends ISubscriptionTransport = ISubscriptio
      * @param signal - An optional abort signal for canceling the subscription request.
      * @returns A promise that resolves with a {@link Subscription} object to manage the subscription lifecycle.
      *
-     * @see {@link https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions | Hyperliquid GitBook}
+     * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
      * @example
      * ```ts
      * import * as hl from "@nktkas/hyperliquid";