@nktkas/hyperliquid/esm/src/api/info/_methods/twapHistory.js

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

import * as v from "valibot";
// ============================================================
// API Schemas
// ============================================================
import { Address, UnsignedDecimal, UnsignedInteger } from "../../_schemas.js";
/**
 * Request twap history of a user.
 */
export const TwapHistoryRequest = /* @__PURE__ */ (() => {
    return v.pipe(v.object({
        /** Type of request. */
        type: v.pipe(v.literal("twapHistory"), v.description("Type of request.")),
        /** User address. */
        user: v.pipe(Address, v.description("User address.")),
    }), v.description("Request twap history of a user."));
})();
/**
 * Array of user's TWAP history.
 */
export const TwapHistoryResponse = /* @__PURE__ */ (() => {
    return v.pipe(v.array(
    /** TWAP history record. */
    v.pipe(v.object({
        /** Creation time of the history record (in seconds since epoch). */
        time: v.pipe(UnsignedInteger, v.description("Creation time of the history record (in seconds since epoch).")),
        /** State of the TWAP order. */
        state: v.pipe(v.object({
            /** Asset symbol. */
            coin: v.pipe(v.string(), v.description("Asset symbol.")),
            /** Executed notional value. */
            executedNtl: v.pipe(UnsignedDecimal, v.description("Executed notional value.")),
            /** Executed size. */
            executedSz: v.pipe(UnsignedDecimal, v.description("Executed size.")),
            /** Duration in minutes. */
            minutes: v.pipe(UnsignedInteger, v.description("Duration in minutes.")),
            /** Indicates if the TWAP randomizes execution. */
            randomize: v.pipe(v.boolean(), v.description("Indicates if the TWAP randomizes execution.")),
            /** Indicates if the order is reduce-only. */
            reduceOnly: v.pipe(v.boolean(), v.description("Indicates if the order is reduce-only.")),
            /** Order side ("B" = Bid/Buy, "A" = Ask/Sell). */
            side: v.pipe(v.picklist(["B", "A"]), v.description('Order side ("B" = Bid/Buy, "A" = Ask/Sell).')),
            /** Order size. */
            sz: v.pipe(UnsignedDecimal, v.description("Order size.")),
            /** Start time of the TWAP order (in ms since epoch). */
            timestamp: v.pipe(UnsignedInteger, v.description("Start time of the TWAP order (in ms since epoch).")),
            /** User address. */
            user: v.pipe(Address, v.description("User address.")),
        }), v.description("State of the TWAP order.")),
        /**
         * Current status of the TWAP order.
         * - `"finished"`: Fully executed.
         * - `"activated"`: Active and executing.
         * - `"terminated"`: Terminated.
         * - `"error"`: An error occurred.
         */
        status: v.pipe(v.variant("status", [
            v.object({
                /** Status of the TWAP order. */
                status: v.pipe(v.picklist(["finished", "activated", "terminated"]), v.description("Status of the TWAP order.")),
            }),
            v.object({
                /** Status of the TWAP order. */
                status: v.pipe(v.literal("error"), v.description("Status of the TWAP order.")),
                /** Error message. */
                description: v.pipe(v.string(), v.description("Error message.")),
            }),
        ]), v.description("Current status of the TWAP order." +
            '\n- `"finished"`: Fully executed.' +
            '\n- `"activated"`: Active and executing.' +
            '\n- `"terminated"`: Terminated.' +
            '\n- `"error"`: An error occurred.')),
        /** ID of the TWAP. */
        twapId: v.pipe(v.optional(UnsignedInteger), v.description("ID of the TWAP.")),
    }), v.description("TWAP history record."))), v.description("Array of user's TWAP history."));
})();
/**
 * Request twap history of a user.
 *
 * @param config - General configuration for Info API requests.
 * @param params - Parameters specific to the API request.
 * @param signal - [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to cancel the request.
 *
 * @returns Array of user's TWAP history.
 *
 * @throws {ValiError} When the request parameters fail validation (before sending).
 * @throws {TransportError} When the transport layer throws an error.
 *
 * @example
 * ```ts
 * import { HttpTransport } from "@nktkas/hyperliquid";
 * import { twapHistory } from "@nktkas/hyperliquid/api/info";
 *
 * const transport = new HttpTransport(); // or `WebSocketTransport`
 *
 * const data = await twapHistory(
 *   { transport },
 *   { user: "0x..." },
 * );
 * ```
 */
export function twapHistory(config, params, signal) {
    const request = v.parse(TwapHistoryRequest, {
        type: "twapHistory",
        ...params,
    });
    return config.transport.request("info", request, signal);
}
//# sourceMappingURL=twapHistory.js.map