@nktkas/hyperliquid/esm/src/api/subscription/_methods/allDexsAssetCtxs.js

Hyperliquid API SDK for all major JS runtimes, written in TypeScript.

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { PerpAssetCtxSchema } from "../../info/_methods/_base/commonSchemas.js";
/** Subscription to asset context events for all DEXs. */
export const AllDexsAssetCtxsRequest = /* @__PURE__ */ (() => {
    return v.pipe(v.object({
        /** Type of subscription. */
        type: v.pipe(v.literal("allDexsAssetCtxs"), v.description("Type of subscription.")),
    }), v.description("Subscription to asset context events for all DEXs."));
})();
/** Event of asset contexts for all DEXs. */
export const AllDexsAssetCtxsEvent = /* @__PURE__ */ (() => {
    return v.pipe(v.object({
        /** Array of tuples of dex names and contexts for each perpetual asset. */
        ctxs: v.pipe(v.array(v.tuple([
            v.string(),
            v.array(PerpAssetCtxSchema),
        ])), v.description("Array of tuples of dex names and contexts for each perpetual asset.")),
    }), v.description("Event of asset contexts for all DEXs."));
})();
/**
 * Subscribe to asset contexts for all DEXs.
 *
 * @param config - General configuration for Subscription API subscriptions.
 * @param listener - A callback function to be called when the event is received.
 *
 * @returns A request-promise that resolves with a {@link ISubscription} object to manage the subscription lifecycle.
 *
 * @throws {ValiError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @example
 * ```ts
 * import { WebSocketTransport } from "@nktkas/hyperliquid";
 * import { allDexsAssetCtxs } from "@nktkas/hyperliquid/api/subscription";
 *
 * const transport = new WebSocketTransport(); // only `WebSocketTransport`
 *
 * const sub = await allDexsAssetCtxs(
 *   { transport },
 *   (data) => console.log(data),
 * );
 * ```
 *
 * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
 */
export function allDexsAssetCtxs(config, listener) {
    const payload = v.parse(AllDexsAssetCtxsRequest, {
        type: "allDexsAssetCtxs",
    });
    return config.transport.subscribe(payload.type, payload, (e) => {
        listener(e.detail);
    });
}
//# sourceMappingURL=allDexsAssetCtxs.js.map