@nktkas/hyperliquid 0.25.8 → 0.26.0

package/script/src/api/subscription/explorerTxs.d.ts

@@ -1,83 +0,0 @@
-import * as v from "valibot";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-/** Subscription to explorer transaction events (RPC endpoint). */
-export declare const ExplorerTxsRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-    /** Type of subscription. */
-    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"explorerTxs", undefined>, v.DescriptionAction<"explorerTxs", "Type of subscription.">]>;
-}, undefined>, v.DescriptionAction<{
-    type: "explorerTxs";
-}, "Subscription to explorer transaction events.">]>;
-export type ExplorerTxsRequest = v.InferOutput<typeof ExplorerTxsRequest>;
-/** Event of array of transaction details. */
-export declare const ExplorerTxsEvent: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-    /** Action performed in transaction. */
-    readonly action: v.SchemaWithPipe<readonly [v.LooseObjectSchema<{
-        /** Action type. */
-        readonly type: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Action type.">]>;
-    }, undefined>, v.DescriptionAction<{
-        type: string;
-    } & {
-        [key: string]: unknown;
-    }, "Action performed in transaction.">]>;
-    /** Block number where transaction was included. */
-    readonly block: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Block number where transaction was included.">]>;
-    /** Error message if transaction failed. */
-    readonly error: v.SchemaWithPipe<readonly [v.NullableSchema<v.StringSchema<undefined>, undefined>, v.DescriptionAction<string | null, "Error message if transaction failed.">]>;
-    /** Transaction hash. */
-    readonly hash: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 66, undefined>]>, v.DescriptionAction<`0x${string}`, "Transaction hash.">]>;
-    /** Transaction creation timestamp. */
-    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Transaction creation timestamp.">]>;
-    /** Creator's address. */
-    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "Creator's address.">]>;
-}, undefined>, v.DescriptionAction<{
-    action: {
-        type: string;
-    } & {
-        [key: string]: unknown;
-    };
-    block: number;
-    error: string | null;
-    hash: `0x${string}`;
-    time: number;
-    user: `0x${string}`;
-}, "Transaction details.">]>, undefined>, v.DescriptionAction<{
-    action: {
-        type: string;
-    } & {
-        [key: string]: unknown;
-    };
-    block: number;
-    error: string | null;
-    hash: `0x${string}`;
-    time: number;
-    user: `0x${string}`;
-}[], "Event of array of transaction details.">]>;
-export type ExplorerTxsEvent = v.InferOutput<typeof ExplorerTxsEvent>;
-/** Request parameters for the {@linkcode explorerTxs} function. */
-export type ExplorerTxsParameters = Omit<v.InferInput<typeof ExplorerTxsRequest>, "type">;
-/**
- * Subscribe to explorer transaction updates.
- * @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 Subscription} object to manage the subscription lifecycle.
- * @note Make sure the endpoint in the {@link transport} supports this method.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see null
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { explorerTxs } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport({ url: "wss://rpc.hyperliquid.xyz/ws" }); // RPC endpoint
- *
- * const sub = await explorerTxs(
- *   { transport },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export declare function explorerTxs(config: SubscriptionRequestConfig, listener: (data: ExplorerTxsEvent) => void): Promise<Subscription>;
-//# sourceMappingURL=explorerTxs.d.ts.map

package/script/src/api/subscription/explorerTxs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"explorerTxs.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/explorerTxs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAE7B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,kEAAkE;AAClE,eAAO,MAAM,kBAAkB;IAGzB,4BAA4B;;;;oDAQ9B,CAAC;AACL,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1E,6CAA6C;AAC7C,eAAO,MAAM,gBAAgB;IAMnB,uCAAuC;;QAGnC,mBAAmB;;;;;;;IAQvB,mDAAmD;;IAKnD,2CAA2C;;IAK3C,wBAAwB;;IAKxB,sCAAsC;;IAKtC,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;gDAW/B,CAAC;AACL,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAItE,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE1F;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,yBAAyB,EACjC,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,GACzC,OAAO,CAAC,YAAY,CAAC,CAKvB"}

package/script/src/api/subscription/explorerTxs.js

@@ -1,99 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExplorerTxsEvent = exports.ExplorerTxsRequest = void 0;
-exports.explorerTxs = explorerTxs;
-const v = __importStar(require("valibot"));
-const _base_js_1 = require("../_base.js");
-// -------------------- Schemas --------------------
-/** Subscription to explorer transaction events (RPC endpoint). */
-exports.ExplorerTxsRequest = (() => {
-    return v.pipe(v.object({
-        /** Type of subscription. */
-        type: v.pipe(v.literal("explorerTxs"), v.description("Type of subscription.")),
-    }), v.description("Subscription to explorer transaction events."));
-})();
-/** Event of array of transaction details. */
-exports.ExplorerTxsEvent = (() => {
-    return v.pipe(v.array(
-    /** Transaction details. */
-    v.pipe(v.object({
-        /** Action performed in transaction. */
-        action: v.pipe(v.looseObject({
-            /** Action type. */
-            type: v.pipe(v.string(), v.description("Action type.")),
-        }), v.description("Action performed in transaction.")),
-        /** Block number where transaction was included. */
-        block: v.pipe(_base_js_1.UnsignedInteger, v.description("Block number where transaction was included.")),
-        /** Error message if transaction failed. */
-        error: v.pipe(v.nullable(v.string()), v.description("Error message if transaction failed.")),
-        /** Transaction hash. */
-        hash: v.pipe(v.pipe(_base_js_1.Hex, v.length(66)), v.description("Transaction hash.")),
-        /** Transaction creation timestamp. */
-        time: v.pipe(_base_js_1.UnsignedInteger, v.description("Transaction creation timestamp.")),
-        /** Creator's address. */
-        user: v.pipe(_base_js_1.Address, v.description("Creator's address.")),
-    }), v.description("Transaction details."))), v.description("Event of array of transaction details."));
-})();
-/**
- * Subscribe to explorer transaction updates.
- * @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 Subscription} object to manage the subscription lifecycle.
- * @note Make sure the endpoint in the {@link transport} supports this method.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see null
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { explorerTxs } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport({ url: "wss://rpc.hyperliquid.xyz/ws" }); // RPC endpoint
- *
- * const sub = await explorerTxs(
- *   { transport },
- *   (data) => console.log(data),
- * );
- * ```
- */
-function explorerTxs(config, listener) {
-    const payload = (0, _base_js_1.parser)(exports.ExplorerTxsRequest)({ type: "explorerTxs" });
-    return config.transport.subscribe("_explorerTxs", payload, (e) => {
-        listener(e.detail);
-    });
-}
-//# sourceMappingURL=explorerTxs.js.map

package/script/src/api/subscription/explorerTxs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"explorerTxs.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/explorerTxs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsGA,kCAQC;AA9GD,2CAA6B;AAC7B,0CAAoE;AAIpE,oDAAoD;AAEpD,kEAAkE;AACrD,QAAA,kBAAkB,GAAmB,CAAC,GAAG,EAAE;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EACxB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,6CAA6C;AAChC,QAAA,gBAAgB,GAAmB,CAAC,GAAG,EAAE;IACpD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,KAAK;IACL,2BAA2B;IAC3B,CAAC,CAAC,IAAI,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,uCAAuC;QACvC,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,WAAW,CAAC;YACZ,mBAAmB;YACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAC9B;SACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAClD;QACD,mDAAmD;QACnD,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAC9D;QACD,2CAA2C;QAC3C,KAAK,EAAE,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EACtB,CAAC,CAAC,WAAW,CAAC,sCAAsC,CAAC,CACtD;QACD,wBAAwB;QACxB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,IAAI,CAAC,cAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAC,CACnC;QACD,sCAAsC;QACtC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,iCAAiC,CAAC,CACjD;QACD,yBAAyB;QACzB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC,CACpC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,sBAAsB,CAAC,CACtC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,wCAAwC,CAAC,CACxD,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,WAAW,CACzB,MAAiC,EACjC,QAA0C;IAE1C,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,0BAAkB,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAmB,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QACjF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/script/src/api/subscription/l2Book.d.ts

@@ -1,95 +0,0 @@
-import * as v from "valibot";
-import { type DeepImmutable } from "../_base.js";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-/** Subscription to L2 order book events for a specific asset. */
-export declare const L2BookRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-    /** Type of subscription. */
-    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"l2Book", undefined>, v.DescriptionAction<"l2Book", "Type of subscription.">]>;
-    /** Asset symbol (e.g., BTC). */
-    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol (e.g., BTC).">]>;
-    /** Number of significant figures. */
-    readonly nSigFigs: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>]>, v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<3, undefined>, v.LiteralSchema<4, undefined>, v.LiteralSchema<5, undefined>], undefined>]>, undefined>, v.DescriptionAction<2 | 5 | 4 | 3 | null | undefined, "Number of significant figures.">]>;
-    /** Mantissa for aggregation (if `nSigFigs` is 5). */
-    readonly mantissa: v.SchemaWithPipe<readonly [v.NullishSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>]>, v.UnionSchema<[v.LiteralSchema<2, undefined>, v.LiteralSchema<5, undefined>], undefined>]>, undefined>, v.DescriptionAction<2 | 5 | null | undefined, "Mantissa for aggregation (if `nSigFigs` is 5).">]>;
-}, undefined>, v.DescriptionAction<{
-    type: "l2Book";
-    coin: string;
-    nSigFigs?: 2 | 5 | 4 | 3 | null | undefined;
-    mantissa?: 2 | 5 | null | undefined;
-}, "Subscription to L2 order book events for a specific asset.">]>;
-export type L2BookRequest = v.InferOutput<typeof L2BookRequest>;
-/** Event of L2 order book snapshot. */
-export declare const L2BookEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-    /** Asset symbol. */
-    readonly coin: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Asset symbol.">]>;
-    /** Timestamp of the snapshot (in ms since epoch). */
-    readonly time: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Timestamp of the snapshot (in ms since epoch).">]>;
-    /** Bid and ask levels (index 0 = bids, index 1 = asks). */
-    readonly levels: v.SchemaWithPipe<readonly [v.TupleSchema<[v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Price.">]>;
-        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total size.">]>;
-        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
-    }, undefined>, v.DescriptionAction<{
-        px: string;
-        sz: string;
-        n: number;
-    }, "L2 order book level.">]>, undefined>, v.ArraySchema<v.SchemaWithPipe<readonly [v.ObjectSchema<{
-        readonly px: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Price.">]>;
-        readonly sz: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, string>, v.TrimAction, v.RegexAction<string, undefined>, v.TransformAction<string, string>]>, v.DescriptionAction<string, "Total size.">]>;
-        readonly n: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<any, number>, v.SafeIntegerAction<number, undefined>, v.MinValueAction<number, 0, undefined>]>, v.DescriptionAction<number, "Number of individual orders.">]>;
-    }, undefined>, v.DescriptionAction<{
-        px: string;
-        sz: string;
-        n: number;
-    }, "L2 order book level.">]>, undefined>], undefined>, v.DescriptionAction<[{
-        px: string;
-        sz: string;
-        n: number;
-    }[], {
-        px: string;
-        sz: string;
-        n: number;
-    }[]], "Bid and ask levels (index 0 = bids, index 1 = asks).">]>;
-}, undefined>, v.DescriptionAction<{
-    coin: string;
-    time: number;
-    levels: [{
-        px: string;
-        sz: string;
-        n: number;
-    }[], {
-        px: string;
-        sz: string;
-        n: number;
-    }[]];
-}, "L2 order book snapshot.">]>;
-export type L2BookEvent = v.InferOutput<typeof L2BookEvent>;
-/** Request parameters for the {@linkcode l2Book} function. */
-export type L2BookParameters = Omit<v.InferInput<typeof L2BookRequest>, "type">;
-/**
- * Subscribe to L2 order book updates for a specific asset.
- * @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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { l2Book } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await l2Book(
- *   { transport },
- *   { coin: "ETH" },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export declare function l2Book(config: SubscriptionRequestConfig, params: DeepImmutable<L2BookParameters>, listener: (data: L2BookEvent) => void): Promise<Subscription>;
-//# sourceMappingURL=l2Book.d.ts.map

package/script/src/api/subscription/l2Book.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"l2Book.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/l2Book.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,KAAK,aAAa,EAAoC,MAAM,aAAa,CAAC;AACnF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAM5D,iEAAiE;AACjE,eAAO,MAAM,aAAa;IAGpB,4BAA4B;;IAK5B,gCAAgC;;IAKhC,qCAAqC;;IAUrC,qDAAqD;;;;;;;kEAavD,CAAC;AACL,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,aAAa,CAAC,CAAC;AAEhE,uCAAuC;AACvC,eAAO,MAAM,WAAW;IAGlB,oBAAoB;;IAKpB,qDAAqD;;IAKrD,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAQ7D,CAAC;AACL,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,WAAW,CAAC,CAAC;AAI5D,8DAA8D;AAC9D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,gBAAgB,CAAC,EACvC,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GACpC,OAAO,CAAC,YAAY,CAAC,CAYvB"}

package/script/src/api/subscription/l2Book.js

@@ -1,103 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.L2BookEvent = exports.L2BookRequest = void 0;
-exports.l2Book = l2Book;
-const v = __importStar(require("valibot"));
-const _base_js_1 = require("../_base.js");
-const _common_schemas_js_1 = require("../_common_schemas.js");
-// -------------------- Schemas --------------------
-/** Subscription to L2 order book events for a specific asset. */
-exports.L2BookRequest = (() => {
-    return v.pipe(v.object({
-        /** Type of subscription. */
-        type: v.pipe(v.literal("l2Book"), v.description("Type of subscription.")),
-        /** Asset symbol (e.g., BTC). */
-        coin: v.pipe(v.string(), v.description("Asset symbol (e.g., BTC).")),
-        /** Number of significant figures. */
-        nSigFigs: v.pipe(v.nullish(v.pipe(_base_js_1.Integer, v.union([v.literal(2), v.literal(3), v.literal(4), v.literal(5)]))), v.description("Number of significant figures.")),
-        /** Mantissa for aggregation (if `nSigFigs` is 5). */
-        mantissa: v.pipe(v.nullish(v.pipe(_base_js_1.Integer, v.union([v.literal(2), v.literal(5)]))), v.description("Mantissa for aggregation (if `nSigFigs` is 5).")),
-    }), v.description("Subscription to L2 order book events for a specific asset."));
-})();
-/** Event of L2 order book snapshot. */
-exports.L2BookEvent = (() => {
-    return v.pipe(v.object({
-        /** Asset symbol. */
-        coin: v.pipe(v.string(), v.description("Asset symbol.")),
-        /** Timestamp of the snapshot (in ms since epoch). */
-        time: v.pipe(_base_js_1.UnsignedInteger, v.description("Timestamp of the snapshot (in ms since epoch).")),
-        /** Bid and ask levels (index 0 = bids, index 1 = asks). */
-        levels: v.pipe(v.tuple([v.array(_common_schemas_js_1.L2BookLevelSchema), v.array(_common_schemas_js_1.L2BookLevelSchema)]), v.description("Bid and ask levels (index 0 = bids, index 1 = asks).")),
-    }), v.description("L2 order book snapshot."));
-})();
-/**
- * Subscribe to L2 order book updates for a specific asset.
- * @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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { l2Book } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await l2Book(
- *   { transport },
- *   { coin: "ETH" },
- *   (data) => console.log(data),
- * );
- * ```
- */
-function l2Book(config, params, listener) {
-    const payload = (0, _base_js_1.parser)(exports.L2BookRequest)({
-        type: "l2Book",
-        ...params,
-        nSigFigs: params.nSigFigs ?? null,
-        mantissa: params.mantissa ?? null,
-    });
-    return config.transport.subscribe(payload.type, payload, (e) => {
-        if (e.detail.coin === payload.coin) {
-            listener(e.detail);
-        }
-    });
-}
-//# sourceMappingURL=l2Book.js.map

package/script/src/api/subscription/l2Book.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"l2Book.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/l2Book.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuGA,wBAgBC;AAvHD,2CAA6B;AAC7B,0CAAmF;AAInF,8DAA0D;AAE1D,oDAAoD;AAEpD,iEAAiE;AACpD,QAAA,aAAa,GAAmB,CAAC,GAAG,EAAE;IACjD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EACnB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,gCAAgC;QAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAC3C;QACD,qCAAqC;QACrC,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,OAAO,CACP,CAAC,CAAC,IAAI,CACJ,kBAAO,EACP,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAClE,CACF,EACD,CAAC,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAChD;QACD,qDAAqD;QACrD,QAAQ,EAAE,CAAC,CAAC,IAAI,CACd,CAAC,CAAC,OAAO,CACP,CAAC,CAAC,IAAI,CACJ,kBAAO,EACP,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CACtC,CACF,EACD,CAAC,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAChE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,4DAA4D,CAAC,CAC5E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,uCAAuC;AAC1B,QAAA,WAAW,GAAmB,CAAC,GAAG,EAAE;IAC/C,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;QACD,qDAAqD;QACrD,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,0BAAe,EACf,CAAC,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAChE;QACD,2DAA2D;QAC3D,MAAM,EAAE,CAAC,CAAC,IAAI,CACZ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,sCAAiB,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,sCAAiB,CAAC,CAAC,CAAC,EACjE,CAAC,CAAC,WAAW,CAAC,sDAAsD,CAAC,CACtE;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,yBAAyB,CAAC,CACzC,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,MAAM,CACpB,MAAiC,EACjC,MAAuC,EACvC,QAAqC;IAErC,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,qBAAa,CAAC,CAAC;QACpC,IAAI,EAAE,QAAQ;QACd,GAAG,MAAM;QACT,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,IAAI;QACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,IAAI;KAClC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAc,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1E,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC;YACnC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/script/src/api/subscription/notification.d.ts

@@ -1,51 +0,0 @@
-import * as v from "valibot";
-import { type DeepImmutable } from "../_base.js";
-import type { SubscriptionRequestConfig } from "./_types.js";
-import type { Subscription } from "../../transport/base.js";
-/** Subscription to notification events for a specific user. */
-export declare const NotificationRequest: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-    /** Type of subscription. */
-    readonly type: v.SchemaWithPipe<readonly [v.LiteralSchema<"notification", undefined>, v.DescriptionAction<"notification", "Type of subscription.">]>;
-    /** User address. */
-    readonly user: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.RegexAction<string, undefined>, v.TransformAction<string, `0x${string}`>]>, v.LengthAction<`0x${string}`, 42, undefined>]>, v.DescriptionAction<`0x${string}`, "User address.">]>;
-}, undefined>, v.DescriptionAction<{
-    type: "notification";
-    user: `0x${string}`;
-}, "Subscription to notification events for a specific user.">]>;
-export type NotificationRequest = v.InferOutput<typeof NotificationRequest>;
-/** Event of user notification. */
-export declare const NotificationEvent: v.SchemaWithPipe<readonly [v.ObjectSchema<{
-    /** Notification content. */
-    readonly notification: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.DescriptionAction<string, "Notification content.">]>;
-}, undefined>, v.DescriptionAction<{
-    notification: string;
-}, "Event of user notification.">]>;
-export type NotificationEvent = v.InferOutput<typeof NotificationEvent>;
-/** Request parameters for the {@linkcode notification} function. */
-export type NotificationParameters = Omit<v.InferInput<typeof NotificationRequest>, "type">;
-/**
- * Subscribe to notification updates for a specific user.
- * @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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { notification } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await notification(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- */
-export declare function notification(config: SubscriptionRequestConfig, params: DeepImmutable<NotificationParameters>, listener: (data: NotificationEvent) => void): Promise<Subscription>;
-//# sourceMappingURL=notification.d.ts.map

package/script/src/api/subscription/notification.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../../../src/src/api/subscription/notification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAW,KAAK,aAAa,EAAU,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAI5D,+DAA+D;AAC/D,eAAO,MAAM,mBAAmB;IAG1B,4BAA4B;;IAK5B,oBAAoB;;;;;gEAQtB,CAAC;AACL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE5E,kCAAkC;AAClC,eAAO,MAAM,iBAAiB;IAGxB,4BAA4B;;;;mCAQ9B,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIxE,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,mBAAmB,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,yBAAyB,EACjC,MAAM,EAAE,aAAa,CAAC,sBAAsB,CAAC,EAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAC1C,OAAO,CAAC,YAAY,CAAC,CAKvB"}

package/script/src/api/subscription/notification.js

@@ -1,87 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationEvent = exports.NotificationRequest = void 0;
-exports.notification = notification;
-const v = __importStar(require("valibot"));
-const _base_js_1 = require("../_base.js");
-// -------------------- Schemas --------------------
-/** Subscription to notification events for a specific user. */
-exports.NotificationRequest = (() => {
-    return v.pipe(v.object({
-        /** Type of subscription. */
-        type: v.pipe(v.literal("notification"), v.description("Type of subscription.")),
-        /** User address. */
-        user: v.pipe(_base_js_1.Address, v.description("User address.")),
-    }), v.description("Subscription to notification events for a specific user."));
-})();
-/** Event of user notification. */
-exports.NotificationEvent = (() => {
-    return v.pipe(v.object({
-        /** Notification content. */
-        notification: v.pipe(v.string(), v.description("Notification content.")),
-    }), v.description("Event of user notification."));
-})();
-/**
- * Subscribe to notification updates for a specific user.
- * @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 Subscription} object to manage the subscription lifecycle.
- *
- * @throws {TransportError} When the transport layer throws an error.
- *
- * @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions
- * @example
- * ```ts
- * import { WebSocketTransport } from "@nktkas/hyperliquid";
- * import { notification } from "@nktkas/hyperliquid/api/subscription";
- *
- * const transport = new WebSocketTransport();
- *
- * const sub = await notification(
- *   { transport },
- *   { user: "0x..." },
- *   (data) => console.log(data),
- * );
- * ```
- */
-function notification(config, params, listener) {
-    const payload = (0, _base_js_1.parser)(exports.NotificationRequest)({ type: "notification", ...params });
-    return config.transport.subscribe(payload.type, payload, (e) => {
-        listener(e.detail);
-    });
-}
-//# sourceMappingURL=notification.js.map

package/script/src/api/subscription/notification.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../../src/src/api/subscription/notification.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,oCASC;AAhFD,2CAA6B;AAC7B,0CAAkE;AAIlE,oDAAoD;AAEpD,+DAA+D;AAClD,QAAA,mBAAmB,GAAmB,CAAC,GAAG,EAAE;IACvD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EACzB,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;QACD,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,IAAI,CACV,kBAAO,EACP,CAAC,CAAC,WAAW,CAAC,eAAe,CAAC,CAC/B;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,0DAA0D,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAGL,kCAAkC;AACrB,QAAA,iBAAiB,GAAmB,CAAC,GAAG,EAAE;IACrD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,CAAC;QACP,4BAA4B;QAC5B,YAAY,EAAE,CAAC,CAAC,IAAI,CAClB,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC,CACvC;KACF,CAAC,EACF,CAAC,CAAC,WAAW,CAAC,6BAA6B,CAAC,CAC7C,CAAC;AACJ,CAAC,CAAC,EAAE,CAAC;AAQL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,YAAY,CAC1B,MAAiC,EACjC,MAA6C,EAC7C,QAA2C;IAE3C,MAAM,OAAO,GAAG,IAAA,iBAAM,EAAC,2BAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACjF,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAoB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAChF,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC"}