@nktkas/hyperliquid 0.13.1 → 0.14.0

package/esm/src/clients/event.js

@@ -1,7 +1,7 @@
-// ———————————————Client———————————————
+// ——————————————— Client ———————————————
 /**
  * Event client for subscribing to various Hyperliquid events.
- * @typeParam T - The type of transport used to connect to the Hyperliquid Websocket API.
+ * @typeParam T The type of transport used to connect to the Hyperliquid Websocket API.
  */
 export class EventClient {
     /**
@@ -33,7 +33,7 @@ export class EventClient {
      * @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";
@@ -65,7 +65,7 @@ export class EventClient {
      * @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";
@@ -96,7 +96,7 @@ export class EventClient {
      * @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";
@@ -124,7 +124,7 @@ export class EventClient {
      * @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";
@@ -149,6 +149,62 @@ export class EventClient {
             }
         }, signal);
     }
+    /**
+     * 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, signal) {
+        const payload = {
+            type: "explorerBlock",
+        };
+        return this.transport.subscribe("_explorerBlock", // Internal channel as it does not have its own channel
+        payload, (event) => {
+            listener(event.detail);
+        }, signal);
+    }
+    /**
+     * 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, signal) {
+        const payload = {
+            type: "explorerTxs",
+        };
+        return this.transport.subscribe("_explorerTxs", // Internal channel as it does not have its own channel
+        payload, (event) => {
+            listener(event.detail);
+        }, signal);
+    }
     /**
      * Subscribe to L2 order book updates for a specific asset.
      * @param args - The parameters for the subscription.
@@ -156,7 +212,7 @@ export class EventClient {
      * @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";
@@ -189,7 +245,7 @@ export class EventClient {
      * @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";
@@ -218,7 +274,7 @@ export class EventClient {
      * @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";
@@ -247,7 +303,7 @@ export class EventClient {
      * @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";
@@ -280,7 +336,7 @@ export class EventClient {
      *
      * @note Different subscriptions cannot be distinguished from each other.
      *
-     * @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";
@@ -298,7 +354,7 @@ export class EventClient {
             type: "userEvents",
             user: args.user,
         };
-        return this.transport.subscribe(payload.type, payload, (event) => {
+        return this.transport.subscribe("user", payload, (event) => {
             listener(event.detail);
         }, signal);
     }
@@ -309,7 +365,7 @@ export class EventClient {
      * @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";
@@ -341,7 +397,7 @@ export class EventClient {
      * @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";
@@ -372,7 +428,7 @@ export class EventClient {
      * @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";
@@ -403,7 +459,7 @@ export class EventClient {
      * @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";
@@ -434,7 +490,7 @@ export class EventClient {
      * @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";
@@ -465,7 +521,7 @@ export class EventClient {
      * @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";