@nktkas/hyperliquid
Version:
Hyperliquid API SDK for all major JS runtimes, written in TypeScript.
88 lines • 4.74 kB
JavaScript
import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
import { LeadingVaultsResponse } from "../../info/_methods/leadingVaults.js";
import { PerpsAtOpenInterestCapResponse } from "../../info/_methods/perpsAtOpenInterestCap.js";
/** Subscription to comprehensive user and market data events. */
export const WebData3Request = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** Type of subscription. */
type: v.pipe(v.literal("webData3"), v.description("Type of subscription.")),
/** User address. */
user: v.pipe(Address, v.description("User address.")),
}), v.description("Subscription to comprehensive user and market data events."));
})();
/** Event of comprehensive user and market data. */
export const WebData3Event = /* @__PURE__ */ (() => {
return v.pipe(v.object({
/** User state information. */
userState: v.pipe(v.object({
/** Agent address if one exists. */
agentAddress: v.pipe(v.nullable(Address), v.description("Agent address if one exists.")),
/** Timestamp until which the agent is valid. */
agentValidUntil: v.pipe(v.nullable(UnsignedInteger), v.description("Timestamp until which the agent is valid.")),
/** Cumulative ledger value. */
cumLedger: v.pipe(UnsignedDecimal, v.description("Cumulative ledger value.")),
/** Server timestamp (in ms since epoch). */
serverTime: v.pipe(UnsignedInteger, v.description("Server timestamp (in ms since epoch).")),
/** Whether this account is a vault. */
isVault: v.pipe(v.boolean(), v.description("Whether this account is a vault.")),
/** User address. */
user: v.pipe(Address, v.description("User address.")),
/** Whether the user has opted out of spot dusting. */
optOutOfSpotDusting: v.pipe(v.optional(v.literal(true)), v.description("Whether the user has opted out of spot dusting.")),
/** Whether DEX abstraction is enabled. */
dexAbstractionEnabled: v.pipe(v.optional(v.boolean()), v.description("Whether DEX abstraction is enabled.")),
/** Abstraction mode for the user account. */
abstraction: v.pipe(v.optional(v.picklist(["dexAbstraction", "disabled"])), v.description("Abstraction mode for the user account.")),
}), v.description("User state information.")),
/** Array of perpetual DEX states. */
perpDexStates: v.pipe(v.array(v.object({
/** Total equity in vaults. */
totalVaultEquity: v.pipe(UnsignedDecimal, v.description("Total equity in vaults.")),
/** Assets currently at their open interest cap. */
perpsAtOpenInterestCap: v.pipe(v.optional(PerpsAtOpenInterestCapResponse), v.description("Assets currently at their open interest cap.")),
/** Array of leading vaults. */
leadingVaults: v.pipe(v.optional(LeadingVaultsResponse), v.description("Array of leading vaults.")),
})), v.description("Array of perpetual DEX states.")),
}), v.description("Event of comprehensive user and market data."));
})();
/**
* Subscribe to comprehensive user and market data updates.
*
* @param config - General configuration for Subscription API subscriptions.
* @param params - Parameters specific to the API subscription.
* @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 { webData3 } from "@nktkas/hyperliquid/api/subscription";
*
* const transport = new WebSocketTransport(); // only `WebSocketTransport`
*
* const sub = await webData3(
* { transport },
* { user: "0x..." },
* (data) => console.log(data),
* );
* ```
*
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
*/
export function webData3(config, params, listener) {
const payload = v.parse(WebData3Request, { type: "webData3", ...params });
return config.transport.subscribe(payload.type, payload, (e) => {
if (e.detail.userState.user === payload.user) {
listener(e.detail);
}
});
}
//# sourceMappingURL=webData3.js.map